bird/sysdep/unix/timer.h

/*
 *	BIRD -- Unix Timers
 *
 *	(c) 1998 Martin Mares <mj@ucw.cz>
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_TIMER_H_
#define _BIRD_TIMER_H_

#include <time.h>

#include "lib/resource.h"

typedef time_t bird_clock_t;		/* Use instead of time_t */

typedef struct timer {
  resource r;
  void (*hook)(struct timer *);
  void *data;
  uint randomize;			/* Amount of randomization */
  uint recurrent;			/* Timer recurrence */
  node n;				/* Internal link */
  bird_clock_t expires;			/* 0=inactive */
} timer;

timer *tm_new(pool *);
void tm_start(timer *, uint after);
void tm_stop(timer *);
void tm_dump_all(void);

extern bird_clock_t now; 		/* Relative, monotonic time in seconds */
extern bird_clock_t now_real;		/* Time in seconds since fixed known epoch */
extern bird_clock_t boot_time;

static inline int
tm_active(timer *t)
{
  return t->expires != 0;
}

static inline bird_clock_t
tm_remains(timer *t)
{
  return t->expires ? t->expires - now : 0;
}

static inline void
tm_start_max(timer *t, bird_clock_t after)
{
  bird_clock_t rem = tm_remains(t);
  tm_start(t, (rem > after) ? rem : after);
}

static inline timer *
tm_new_set(pool *p, void (*hook)(struct timer *), void *data, uint rand, uint rec)
{
  timer *t = tm_new(p);
  t->hook = hook;
  t->data = data;
  t->randomize = rand;
  t->recurrent = rec;
  return t;
}


struct timeformat {
  char *fmt1, *fmt2;
  bird_clock_t limit;
};

bird_clock_t tm_parse_date(char *);	/* Convert date to bird_clock_t */
bird_clock_t tm_parse_datetime(char *);	/* Convert date to bird_clock_t */

#define TM_DATETIME_BUFFER_SIZE 32	/* Buffer size required by tm_format_datetime */

void tm_format_datetime(char *x, struct timeformat *fmt_spec, bird_clock_t t);
int tm_format_real_time(char *x, size_t max, const char *fmt, bird_clock_t t);

#define TIME_T_IS_64BIT (sizeof(time_t) == 8)
#define TIME_T_IS_SIGNED ((time_t) -1 < 0)

#define TIME_INFINITY							\
  ((time_t) (TIME_T_IS_SIGNED ?						\
	     (TIME_T_IS_64BIT ? 0x7fffffffffffffff : 0x7fffffff):	\
	     (TIME_T_IS_64BIT ? 0xffffffffffffffff : 0xffffffff)))

#endif