]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
9a98c7a1 LP |
2 | #pragma once |
3 | ||
cb0dac05 | 4 | #include <inttypes.h> |
11c3a366 TA |
5 | #include <stdbool.h> |
6 | #include <stddef.h> | |
7 | #include <stdint.h> | |
7c67c79c HV |
8 | #include <stdio.h> |
9 | #include <time.h> | |
9a98c7a1 LP |
10 | |
11 | typedef uint64_t usec_t; | |
12 | typedef uint64_t nsec_t; | |
13 | ||
70887c5f ZJS |
14 | #define PRI_NSEC PRIu64 |
15 | #define PRI_USEC PRIu64 | |
16 | #define NSEC_FMT "%" PRI_NSEC | |
17 | #define USEC_FMT "%" PRI_USEC | |
ccd06097 | 18 | |
9a98c7a1 LP |
19 | #include "macro.h" |
20 | ||
21 | typedef struct dual_timestamp { | |
22 | usec_t realtime; | |
23 | usec_t monotonic; | |
24 | } dual_timestamp; | |
25 | ||
fe624c4c LP |
26 | typedef struct triple_timestamp { |
27 | usec_t realtime; | |
28 | usec_t monotonic; | |
29 | usec_t boottime; | |
30 | } triple_timestamp; | |
31 | ||
7b3eb5c9 LB |
32 | typedef enum TimestampStyle { |
33 | TIMESTAMP_PRETTY, | |
34 | TIMESTAMP_US, | |
35 | TIMESTAMP_UTC, | |
36 | TIMESTAMP_US_UTC, | |
ed4a5b43 | 37 | TIMESTAMP_UNIX, |
64f3419e | 38 | TIMESTAMP_DATE, |
7b3eb5c9 | 39 | _TIMESTAMP_STYLE_MAX, |
2d93c20e | 40 | _TIMESTAMP_STYLE_INVALID = -EINVAL, |
7b3eb5c9 LB |
41 | } TimestampStyle; |
42 | ||
7c0eb30e LP |
43 | #define USEC_INFINITY ((usec_t) UINT64_MAX) |
44 | #define NSEC_INFINITY ((nsec_t) UINT64_MAX) | |
3a43da28 KS |
45 | |
46 | #define MSEC_PER_SEC 1000ULL | |
609e002e LP |
47 | #define USEC_PER_SEC ((usec_t) 1000000ULL) |
48 | #define USEC_PER_MSEC ((usec_t) 1000ULL) | |
3a43da28 KS |
49 | #define NSEC_PER_SEC ((nsec_t) 1000000000ULL) |
50 | #define NSEC_PER_MSEC ((nsec_t) 1000000ULL) | |
51 | #define NSEC_PER_USEC ((nsec_t) 1000ULL) | |
609e002e LP |
52 | |
53 | #define USEC_PER_MINUTE ((usec_t) (60ULL*USEC_PER_SEC)) | |
3a43da28 | 54 | #define NSEC_PER_MINUTE ((nsec_t) (60ULL*NSEC_PER_SEC)) |
609e002e | 55 | #define USEC_PER_HOUR ((usec_t) (60ULL*USEC_PER_MINUTE)) |
3a43da28 | 56 | #define NSEC_PER_HOUR ((nsec_t) (60ULL*NSEC_PER_MINUTE)) |
609e002e | 57 | #define USEC_PER_DAY ((usec_t) (24ULL*USEC_PER_HOUR)) |
3a43da28 | 58 | #define NSEC_PER_DAY ((nsec_t) (24ULL*NSEC_PER_HOUR)) |
609e002e | 59 | #define USEC_PER_WEEK ((usec_t) (7ULL*USEC_PER_DAY)) |
3a43da28 | 60 | #define NSEC_PER_WEEK ((nsec_t) (7ULL*NSEC_PER_DAY)) |
609e002e | 61 | #define USEC_PER_MONTH ((usec_t) (2629800ULL*USEC_PER_SEC)) |
3a43da28 | 62 | #define NSEC_PER_MONTH ((nsec_t) (2629800ULL*NSEC_PER_SEC)) |
609e002e | 63 | #define USEC_PER_YEAR ((usec_t) (31557600ULL*USEC_PER_SEC)) |
3a43da28 | 64 | #define NSEC_PER_YEAR ((nsec_t) (31557600ULL*NSEC_PER_SEC)) |
9a98c7a1 | 65 | |
21b3a0fc LP |
66 | /* We assume a maximum timezone length of 6. TZNAME_MAX is not defined on Linux, but glibc internally initializes this |
67 | * to 6. Let's rely on that. */ | |
67bd5620 | 68 | #define FORMAT_TIMESTAMP_MAX (3U+1U+10U+1U+8U+1U+6U+1U+6U+1U) |
67bd5620 LP |
69 | #define FORMAT_TIMESTAMP_RELATIVE_MAX 256U |
70 | #define FORMAT_TIMESPAN_MAX 64U | |
9a98c7a1 | 71 | |
2d60169d | 72 | #define TIME_T_MAX (time_t)((UINTMAX_C(1) << ((sizeof(time_t) << 3) - 1)) - 1) |
e4746b57 | 73 | |
fe624c4c LP |
74 | #define DUAL_TIMESTAMP_NULL ((struct dual_timestamp) {}) |
75 | #define TRIPLE_TIMESTAMP_NULL ((struct triple_timestamp) {}) | |
842129f5 | 76 | |
9a98c7a1 | 77 | usec_t now(clockid_t clock); |
45d7a8bb | 78 | nsec_t now_nsec(clockid_t clock); |
9a98c7a1 | 79 | |
7c0eb30e LP |
80 | usec_t map_clock_usec(usec_t from, clockid_t from_clock, clockid_t to_clock); |
81 | ||
9a98c7a1 LP |
82 | dual_timestamp* dual_timestamp_get(dual_timestamp *ts); |
83 | dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u); | |
cae0c5e0 | 84 | dual_timestamp* dual_timestamp_from_monotonic(dual_timestamp *ts, usec_t u); |
ba4e0427 | 85 | dual_timestamp* dual_timestamp_from_boottime(dual_timestamp *ts, usec_t u); |
9a98c7a1 | 86 | |
fe624c4c LP |
87 | triple_timestamp* triple_timestamp_get(triple_timestamp *ts); |
88 | triple_timestamp* triple_timestamp_from_realtime(triple_timestamp *ts, usec_t u); | |
89 | ||
90 | #define DUAL_TIMESTAMP_HAS_CLOCK(clock) \ | |
91 | IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC) | |
92 | ||
93 | #define TRIPLE_TIMESTAMP_HAS_CLOCK(clock) \ | |
94 | IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC, CLOCK_BOOTTIME, CLOCK_BOOTTIME_ALARM) | |
95 | ||
1f65fd49 ZJS |
96 | static inline bool timestamp_is_set(usec_t timestamp) { |
97 | return timestamp > 0 && timestamp != USEC_INFINITY; | |
98 | } | |
99 | ||
34cf6c43 | 100 | static inline bool dual_timestamp_is_set(const dual_timestamp *ts) { |
1f65fd49 ZJS |
101 | return timestamp_is_set(ts->realtime) || |
102 | timestamp_is_set(ts->monotonic); | |
966204e0 | 103 | } |
9a98c7a1 | 104 | |
34cf6c43 | 105 | static inline bool triple_timestamp_is_set(const triple_timestamp *ts) { |
1f65fd49 ZJS |
106 | return timestamp_is_set(ts->realtime) || |
107 | timestamp_is_set(ts->monotonic) || | |
108 | timestamp_is_set(ts->boottime); | |
fe624c4c LP |
109 | } |
110 | ||
111 | usec_t triple_timestamp_by_clock(triple_timestamp *ts, clockid_t clock); | |
112 | ||
44a6b1b6 | 113 | usec_t timespec_load(const struct timespec *ts) _pure_; |
3a730176 | 114 | nsec_t timespec_load_nsec(const struct timespec *ts) _pure_; |
ae7c644c ZJS |
115 | struct timespec* timespec_store(struct timespec *ts, usec_t u); |
116 | struct timespec* timespec_store_nsec(struct timespec *ts, nsec_t n); | |
9a98c7a1 | 117 | |
52bb308c LP |
118 | #define TIMESPEC_STORE(u) timespec_store(&(struct timespec) {}, (u)) |
119 | ||
44a6b1b6 | 120 | usec_t timeval_load(const struct timeval *tv) _pure_; |
ae7c644c | 121 | struct timeval* timeval_store(struct timeval *tv, usec_t u); |
9a98c7a1 | 122 | |
52bb308c LP |
123 | #define TIMEVAL_STORE(u) timeval_store(&(struct timeval) {}, (u)) |
124 | ||
6c6368e9 | 125 | char* format_timestamp_style(char *buf, size_t l, usec_t t, TimestampStyle style) _warn_unused_result_; |
d5e6f36c | 126 | char* format_timestamp_relative_full(char *buf, size_t l, usec_t t, bool implicit_left) _warn_unused_result_; |
6c6368e9 | 127 | char* format_timespan(char *buf, size_t l, usec_t t, usec_t accuracy) _warn_unused_result_; |
9a98c7a1 | 128 | |
d5e6f36c ZJS |
129 | _warn_unused_result_ |
130 | static inline char* format_timestamp_relative(char *buf, size_t l, usec_t t) { | |
131 | return format_timestamp_relative_full(buf, l, t, false); | |
132 | } | |
133 | ||
6c6368e9 | 134 | _warn_unused_result_ |
ae7c644c | 135 | static inline char* format_timestamp(char *buf, size_t l, usec_t t) { |
7b3eb5c9 LB |
136 | return format_timestamp_style(buf, l, t, TIMESTAMP_PRETTY); |
137 | } | |
138 | ||
ae7c644c ZJS |
139 | /* Note: the lifetime of the compound literal is the immediately surrounding block, |
140 | * see C11 §6.5.2.5, and | |
141 | * https://stackoverflow.com/questions/34880638/compound-literal-lifetime-and-if-blocks */ | |
142 | #define FORMAT_TIMESTAMP(t) format_timestamp((char[FORMAT_TIMESTAMP_MAX]){}, FORMAT_TIMESTAMP_MAX, t) | |
32fc5c47 ZJS |
143 | #define FORMAT_TIMESTAMP_RELATIVE(t) \ |
144 | format_timestamp_relative((char[FORMAT_TIMESTAMP_RELATIVE_MAX]){}, FORMAT_TIMESTAMP_RELATIVE_MAX, t) | |
5291f26d | 145 | #define FORMAT_TIMESPAN(t, accuracy) format_timespan((char[FORMAT_TIMESPAN_MAX]){}, FORMAT_TIMESPAN_MAX, t, accuracy) |
0086ef19 ZJS |
146 | #define FORMAT_TIMESTAMP_STYLE(t, style) \ |
147 | format_timestamp_style((char[FORMAT_TIMESTAMP_MAX]){}, FORMAT_TIMESTAMP_MAX, t, style) | |
32fc5c47 | 148 | |
9a98c7a1 LP |
149 | int parse_timestamp(const char *t, usec_t *usec); |
150 | ||
7f602784 | 151 | int parse_sec(const char *t, usec_t *usec); |
0004f698 | 152 | int parse_sec_fix_0(const char *t, usec_t *usec); |
7b61ce3c | 153 | int parse_sec_def_infinity(const char *t, usec_t *usec); |
519cffec | 154 | int parse_time(const char *t, usec_t *usec, usec_t default_unit); |
9a98c7a1 | 155 | int parse_nsec(const char *t, nsec_t *nsec); |
03cc26dd | 156 | |
75683450 | 157 | int get_timezones(char ***l); |
bdaeafea ZJS |
158 | int verify_timezone(const char *name, int log_level); |
159 | static inline bool timezone_is_valid(const char *name, int log_level) { | |
160 | return verify_timezone(name, log_level) >= 0; | |
161 | } | |
77ff2de9 | 162 | |
fe624c4c | 163 | bool clock_supported(clockid_t clock); |
babc21fd | 164 | |
1007ec60 LP |
165 | usec_t usec_shift_clock(usec_t, clockid_t from, clockid_t to); |
166 | ||
5c904ba5 | 167 | int get_timezone(char **timezone); |
7c67c79c HV |
168 | |
169 | time_t mktime_or_timegm(struct tm *tm, bool utc); | |
170 | struct tm *localtime_or_gmtime_r(const time_t *t, struct tm *tm, bool utc); | |
87b8ce69 | 171 | |
77372afb YW |
172 | uint32_t usec_to_jiffies(usec_t usec); |
173 | usec_t jiffies_to_usec(uint32_t jiffies); | |
53f555b6 | 174 | |
9a9a4f10 LP |
175 | bool in_utc_timezone(void); |
176 | ||
53f555b6 | 177 | static inline usec_t usec_add(usec_t a, usec_t b) { |
cb3e854f ZJS |
178 | /* Adds two time values, and makes sure USEC_INFINITY as input results as USEC_INFINITY in output, |
179 | * and doesn't overflow. */ | |
53f555b6 | 180 | |
ab05bee1 | 181 | if (a > USEC_INFINITY - b) /* overflow check */ |
53f555b6 LP |
182 | return USEC_INFINITY; |
183 | ||
ab05bee1 | 184 | return a + b; |
53f555b6 | 185 | } |
5d634ca8 | 186 | |
54d8ef14 | 187 | static inline usec_t usec_sub_unsigned(usec_t timestamp, usec_t delta) { |
04a1d84c LP |
188 | if (timestamp == USEC_INFINITY) /* Make sure infinity doesn't degrade */ |
189 | return USEC_INFINITY; | |
54d8ef14 | 190 | if (timestamp < delta) |
04a1d84c LP |
191 | return 0; |
192 | ||
193 | return timestamp - delta; | |
5d634ca8 | 194 | } |
1bb4b028 | 195 | |
54d8ef14 | 196 | static inline usec_t usec_sub_signed(usec_t timestamp, int64_t delta) { |
782c6e5c LP |
197 | if (delta == INT64_MIN) { /* prevent overflow */ |
198 | assert_cc(-(INT64_MIN + 1) == INT64_MAX); | |
199 | assert_cc(USEC_INFINITY > INT64_MAX); | |
200 | return usec_add(timestamp, (usec_t) INT64_MAX + 1); | |
201 | } | |
54d8ef14 LP |
202 | if (delta < 0) |
203 | return usec_add(timestamp, (usec_t) (-delta)); | |
782c6e5c LP |
204 | |
205 | return usec_sub_unsigned(timestamp, (usec_t) delta); | |
54d8ef14 LP |
206 | } |
207 | ||
1bb4b028 | 208 | #if SIZEOF_TIME_T == 8 |
cb3e854f ZJS |
209 | /* The last second we can format is 31. Dec 9999, 1s before midnight, because otherwise we'd enter 5 digit |
210 | * year territory. However, since we want to stay away from this in all timezones we take one day off. */ | |
211 | # define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 253402214399000000) | |
1bb4b028 LP |
212 | #elif SIZEOF_TIME_T == 4 |
213 | /* With a 32bit time_t we can't go beyond 2038... */ | |
cb3e854f | 214 | # define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 2147483647000000) |
1bb4b028 | 215 | #else |
cb3e854f | 216 | # error "Yuck, time_t is neither 4 nor 8 bytes wide?" |
1bb4b028 | 217 | #endif |
4f811d27 LP |
218 | |
219 | int time_change_fd(void); | |
7b3eb5c9 LB |
220 | |
221 | const char* timestamp_style_to_string(TimestampStyle t) _const_; | |
222 | TimestampStyle timestamp_style_from_string(const char *s) _pure_; |