timespec.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 1989-2009.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_SCORE_TIMESPEC_H
#define _RTEMS_SCORE_TIMESPEC_H

#include <stdbool.h> /* bool */
#include <stdint.h> /* uint32_t */
#include <time.h> /* struct timespec */

#ifdef __cplusplus
extern "C" {
#endif

#define _Timespec_Set( _time, _seconds, _nanoseconds ) \
    do { \
       (_time)->tv_sec = (_seconds); \
       (_time)->tv_nsec = (_nanoseconds); \
    } while (0)

#define _Timespec_Set_to_zero( _time ) \
    do { \
       (_time)->tv_sec = 0; \
       (_time)->tv_nsec = 0; \
    } while (0)

#define _Timespec_Get_seconds( _time ) \
    ((_time)->tv_sec)

#define _Timespec_Get_nanoseconds( _time ) \
    ((_time)->tv_nsec)

uint64_t _Timespec_Get_as_nanoseconds(
  const struct timespec *time
);

bool _Timespec_Is_valid(
  const struct timespec *time
);

bool _Timespec_Less_than(
  const struct timespec *lhs,
  const struct timespec *rhs
);

#define _Timespec_Greater_than( _lhs, _rhs ) \
  _Timespec_Less_than( _rhs, _lhs )

#define _Timespec_Equal_to( lhs, rhs ) \
  ( ((lhs)->tv_sec  == (rhs)->tv_sec) &&   \
    ((lhs)->tv_nsec == (rhs)->tv_nsec)     \
  )

uint32_t _Timespec_Add_to(
  struct timespec       *time,
  const struct timespec *add
);

uint32_t _Timespec_To_ticks(
  const struct timespec *time
);

void _Timespec_From_ticks(
  uint32_t         ticks,
  struct timespec *time
);

void _Timespec_Subtract(
  const struct timespec *start,
  const struct timespec *end,
  struct timespec       *result
);

void _Timespec_Divide_by_integer(
  const struct timespec *time,
  uint32_t               iterations,
  struct timespec       *result
);

void _Timespec_Divide(
  const struct timespec *lhs,
  const struct timespec *rhs,
  uint32_t              *ival_percentage,
  uint32_t              *fval_percentage
);

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */