8e10ad360b4cbd9646af1d486e43ed81d9302c0e
[cascardo/ovs.git] / lib / timeval.h
1 /*
2  * Copyright (c) 2008, 2009 Nicira Networks.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 #ifndef TIMEVAL_H
18 #define TIMEVAL_H 1
19
20 #include <time.h>
21 #include "type-props.h"
22 #include "util.h"
23
24 struct pollfd;
25 struct timeval;
26
27 /* POSIX allows floating-point time_t, but we don't support it. */
28 BUILD_ASSERT_DECL(TYPE_IS_INTEGER(time_t));
29
30 /* We do try to cater to unsigned time_t, but I want to know about it if we
31  * ever encounter such a platform. */
32 BUILD_ASSERT_DECL(TYPE_IS_SIGNED(time_t));
33
34 #define TIME_MAX TYPE_MAXIMUM(time_t)
35 #define TIME_MIN TYPE_MINIMUM(time_t)
36
37 /* Interval between updates to the time reported by time_gettimeofday(), in ms.
38  * This should not be adjusted much below 10 ms or so with the current
39  * implementation, or too much time will be wasted in signal handlers and calls
40  * to time(0). */
41 #define TIME_UPDATE_INTERVAL 100
42
43 void time_init(void);
44 void time_refresh(void);
45 time_t time_now(void);
46 long long int time_msec(void);
47 void time_timeval(struct timeval *);
48 void time_alarm(unsigned int secs);
49 int time_poll(struct pollfd *, int n_pollfds, int timeout);
50
51 #endif /* timeval.h */