1 /*
2 * SysDB - src/include/core/time.h
3 * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_CORE_TIME_H
29 #define SDB_CORE_TIME_H 1
31 #include <inttypes.h>
32 #include <stdint.h>
33 #include <stddef.h>
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
39 /*
40 * sdb_time_t:
41 * The time, in nano-seconds, since the epoch.
42 */
43 typedef uint64_t sdb_time_t;
44 #define PRIsdbTIME PRIu64
46 #define SECS_TO_SDB_TIME(s) ((sdb_time_t)(s) * (sdb_time_t)1000000000)
47 #define SDB_TIME_TO_SECS(t) ((t) / (sdb_time_t)1000000000)
49 #define NSECS_TO_SDB_TIME(ns) ((sdb_time_t)ns)
51 #define DOUBLE_TO_SDB_TIME(d) ((sdb_time_t)((d) * 1000000000.0))
52 #define SDB_TIME_TO_DOUBLE(t) ((double)(t) / 1000000000.0)
54 #define TIMESPEC_TO_SDB_TIME(ts) (SECS_TO_SDB_TIME((ts).tv_sec) \
55 + NSECS_TO_SDB_TIME((ts).tv_nsec))
57 /*
58 * Interval constants:
59 * Each constant specifies the time interval, in nano-seconds, of the named
60 * time-frame. Year, month, and day are approximations which do not work well
61 * for very large time intervals.
62 */
63 extern const sdb_time_t SDB_INTERVAL_YEAR;
64 extern const sdb_time_t SDB_INTERVAL_MONTH;
65 extern const sdb_time_t SDB_INTERVAL_DAY;
66 extern const sdb_time_t SDB_INTERVAL_HOUR;
67 extern const sdb_time_t SDB_INTERVAL_MINUTE;
68 extern const sdb_time_t SDB_INTERVAL_SECOND;
70 sdb_time_t
71 sdb_gettime(void);
73 int
74 sdb_sleep(sdb_time_t reg, sdb_time_t *rem);
76 size_t
77 sdb_strftime(char *s, size_t len, sdb_time_t);
79 size_t
80 sdb_strfinterval(char *s, size_t len, sdb_time_t interval);
82 /*
83 * sdb_strpunit:
84 * Parse the specified string as a time unit.
85 * "Y" (year), "M" (month), "D" (day), "h" (hour), "m" (minute), "s" (second),
86 * "ms" (milli-second), "us" (micro-second), "ns" (nano-second).
87 *
88 * Returns:
89 * - the time interval corresponding to the specified unit on success
90 * - 0 else
91 */
92 sdb_time_t
93 sdb_strpunit(const char *s);
95 #ifdef __cplusplus
96 } /* extern "C" */
97 #endif
99 #endif /* ! SDB_CORE_TIME_H */
101 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */