src/basic/time-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <inttypes.h>
   5 #include <stdbool.h>
   6 #include <stddef.h>
   7 #include <stdint.h>
   8 #include <stdio.h>
   9 #include <time.h>
  10
  11 typedef uint64_t usec_t;
  12 typedef uint64_t nsec_t;
  13
  14 #define PRI_NSEC PRIu64
  15 #define PRI_USEC PRIu64
  16 #define NSEC_FMT "%" PRI_NSEC
  17 #define USEC_FMT "%" PRI_USEC
  18
  19 #include "macro.h"
  20
  21 typedef struct dual_timestamp {
  22         usec_t realtime;
  23         usec_t monotonic;
  24 } dual_timestamp;
  25
  26 typedef struct triple_timestamp {
  27         usec_t realtime;
  28         usec_t monotonic;
  29         usec_t boottime;
  30 } triple_timestamp;
  31
  32 #define USEC_INFINITY ((usec_t) UINT64_MAX)
  33 #define NSEC_INFINITY ((nsec_t) UINT64_MAX)
  34
  35 #define MSEC_PER_SEC  1000ULL
  36 #define USEC_PER_SEC  ((usec_t) 1000000ULL)
  37 #define USEC_PER_MSEC ((usec_t) 1000ULL)
  38 #define NSEC_PER_SEC  ((nsec_t) 1000000000ULL)
  39 #define NSEC_PER_MSEC ((nsec_t) 1000000ULL)
  40 #define NSEC_PER_USEC ((nsec_t) 1000ULL)
  41
  42 #define USEC_PER_MINUTE ((usec_t) (60ULL*USEC_PER_SEC))
  43 #define NSEC_PER_MINUTE ((nsec_t) (60ULL*NSEC_PER_SEC))
  44 #define USEC_PER_HOUR ((usec_t) (60ULL*USEC_PER_MINUTE))
  45 #define NSEC_PER_HOUR ((nsec_t) (60ULL*NSEC_PER_MINUTE))
  46 #define USEC_PER_DAY ((usec_t) (24ULL*USEC_PER_HOUR))
  47 #define NSEC_PER_DAY ((nsec_t) (24ULL*NSEC_PER_HOUR))
  48 #define USEC_PER_WEEK ((usec_t) (7ULL*USEC_PER_DAY))
  49 #define NSEC_PER_WEEK ((nsec_t) (7ULL*NSEC_PER_DAY))
  50 #define USEC_PER_MONTH ((usec_t) (2629800ULL*USEC_PER_SEC))
  51 #define NSEC_PER_MONTH ((nsec_t) (2629800ULL*NSEC_PER_SEC))
  52 #define USEC_PER_YEAR ((usec_t) (31557600ULL*USEC_PER_SEC))
  53 #define NSEC_PER_YEAR ((nsec_t) (31557600ULL*NSEC_PER_SEC))
  54
  55 /* We assume a maximum timezone length of 6. TZNAME_MAX is not defined on Linux, but glibc internally initializes this
  56  * to 6. Let's rely on that. */
  57 #define FORMAT_TIMESTAMP_MAX (3+1+10+1+8+1+6+1+6+1)
  58 #define FORMAT_TIMESTAMP_WIDTH 28 /* when outputting, assume this width */
  59 #define FORMAT_TIMESTAMP_RELATIVE_MAX 256
  60 #define FORMAT_TIMESPAN_MAX 64
  61
  62 #define TIME_T_MAX (time_t)((UINTMAX_C(1) << ((sizeof(time_t) << 3) - 1)) - 1)
  63
  64 #define DUAL_TIMESTAMP_NULL ((struct dual_timestamp) {})
  65 #define TRIPLE_TIMESTAMP_NULL ((struct triple_timestamp) {})
  66
  67 usec_t now(clockid_t clock);
  68 nsec_t now_nsec(clockid_t clock);
  69
  70 usec_t map_clock_usec(usec_t from, clockid_t from_clock, clockid_t to_clock);
  71
  72 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
  73 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
  74 dual_timestamp* dual_timestamp_from_monotonic(dual_timestamp *ts, usec_t u);
  75 dual_timestamp* dual_timestamp_from_boottime_or_monotonic(dual_timestamp *ts, usec_t u);
  76
  77 triple_timestamp* triple_timestamp_get(triple_timestamp *ts);
  78 triple_timestamp* triple_timestamp_from_realtime(triple_timestamp *ts, usec_t u);
  79
  80 #define DUAL_TIMESTAMP_HAS_CLOCK(clock)                               \
  81         IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC)
  82
  83 #define TRIPLE_TIMESTAMP_HAS_CLOCK(clock)                               \
  84         IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC, CLOCK_BOOTTIME, CLOCK_BOOTTIME_ALARM)
  85
  86 static inline bool timestamp_is_set(usec_t timestamp) {
  87         return timestamp > 0 && timestamp != USEC_INFINITY;
  88 }
  89
  90 static inline bool dual_timestamp_is_set(const dual_timestamp *ts) {
  91         return timestamp_is_set(ts->realtime) ||
  92                timestamp_is_set(ts->monotonic);
  93 }
  94
  95 static inline bool triple_timestamp_is_set(const triple_timestamp *ts) {
  96         return timestamp_is_set(ts->realtime) ||
  97                timestamp_is_set(ts->monotonic) ||
  98                timestamp_is_set(ts->boottime);
  99 }
 100
 101 usec_t triple_timestamp_by_clock(triple_timestamp *ts, clockid_t clock);
 102
 103 usec_t timespec_load(const struct timespec *ts) _pure_;
 104 nsec_t timespec_load_nsec(const struct timespec *ts) _pure_;
 105 struct timespec *timespec_store(struct timespec *ts, usec_t u);
 106
 107 usec_t timeval_load(const struct timeval *tv) _pure_;
 108 struct timeval *timeval_store(struct timeval *tv, usec_t u);
 109
 110 char *format_timestamp(char *buf, size_t l, usec_t t);
 111 char *format_timestamp_utc(char *buf, size_t l, usec_t t);
 112 char *format_timestamp_us(char *buf, size_t l, usec_t t);
 113 char *format_timestamp_us_utc(char *buf, size_t l, usec_t t);
 114 char *format_timestamp_relative(char *buf, size_t l, usec_t t);
 115 char *format_timespan(char *buf, size_t l, usec_t t, usec_t accuracy);
 116
 117 int parse_timestamp(const char *t, usec_t *usec);
 118
 119 int parse_sec(const char *t, usec_t *usec);
 120 int parse_sec_fix_0(const char *t, usec_t *usec);
 121 int parse_sec_def_infinity(const char *t, usec_t *usec);
 122 int parse_time(const char *t, usec_t *usec, usec_t default_unit);
 123 int parse_nsec(const char *t, nsec_t *nsec);
 124
 125 bool ntp_synced(void);
 126
 127 int get_timezones(char ***l);
 128 bool timezone_is_valid(const char *name, int log_level);
 129
 130 bool clock_boottime_supported(void);
 131 bool clock_supported(clockid_t clock);
 132 clockid_t clock_boottime_or_monotonic(void);
 133
 134 usec_t usec_shift_clock(usec_t, clockid_t from, clockid_t to);
 135
 136 int get_timezone(char **timezone);
 137
 138 time_t mktime_or_timegm(struct tm *tm, bool utc);
 139 struct tm *localtime_or_gmtime_r(const time_t *t, struct tm *tm, bool utc);
 140
 141 uint32_t usec_to_jiffies(usec_t usec);
 142 usec_t jiffies_to_usec(uint32_t jiffies);
 143
 144 bool in_utc_timezone(void);
 145
 146 static inline usec_t usec_add(usec_t a, usec_t b) {
 147         usec_t c;
 148
 149         /* Adds two time values, and makes sure USEC_INFINITY as input results as USEC_INFINITY in output, and doesn't
 150          * overflow. */
 151
 152         c = a + b;
 153         if (c < a || c < b) /* overflow check */
 154                 return USEC_INFINITY;
 155
 156         return c;
 157 }
 158
 159 static inline usec_t usec_sub_unsigned(usec_t timestamp, usec_t delta) {
 160
 161         if (timestamp == USEC_INFINITY) /* Make sure infinity doesn't degrade */
 162                 return USEC_INFINITY;
 163         if (timestamp < delta)
 164                 return 0;
 165
 166         return timestamp - delta;
 167 }
 168
 169 static inline usec_t usec_sub_signed(usec_t timestamp, int64_t delta) {
 170         if (delta < 0)
 171                 return usec_add(timestamp, (usec_t) (-delta));
 172         else
 173                 return usec_sub_unsigned(timestamp, (usec_t) delta);
 174 }
 175
 176 #if SIZEOF_TIME_T == 8
 177 /* The last second we can format is 31. Dec 9999, 1s before midnight, because otherwise we'd enter 5 digit year
 178  * territory. However, since we want to stay away from this in all timezones we take one day off. */
 179 #define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 253402214399000000)
 180 #elif SIZEOF_TIME_T == 4
 181 /* With a 32bit time_t we can't go beyond 2038... */
 182 #define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 2147483647000000)
 183 #else
 184 #error "Yuck, time_t is neither 4 nor 8 bytes wide?"
 185 #endif
 186
 187 int time_change_fd(void);