Blame src/libnm-systemd-shared/src/basic/time-util.h

Packit Service dff8e4
/* SPDX-License-Identifier: LGPL-2.1-or-later */
Packit Service dff8e4
#pragma once
Packit Service dff8e4
Packit Service dff8e4
#include <inttypes.h>
Packit Service dff8e4
#include <stdbool.h>
Packit Service dff8e4
#include <stddef.h>
Packit Service dff8e4
#include <stdint.h>
Packit Service dff8e4
#include <stdio.h>
Packit Service dff8e4
#include <time.h>
Packit Service dff8e4
Packit Service dff8e4
typedef uint64_t usec_t;
Packit Service dff8e4
typedef uint64_t nsec_t;
Packit Service dff8e4
Packit Service dff8e4
#define PRI_NSEC PRIu64
Packit Service dff8e4
#define PRI_USEC PRIu64
Packit Service dff8e4
#define NSEC_FMT "%" PRI_NSEC
Packit Service dff8e4
#define USEC_FMT "%" PRI_USEC
Packit Service dff8e4
Packit Service dff8e4
#include "macro.h"
Packit Service dff8e4
Packit Service dff8e4
typedef struct dual_timestamp {
Packit Service dff8e4
        usec_t realtime;
Packit Service dff8e4
        usec_t monotonic;
Packit Service dff8e4
} dual_timestamp;
Packit Service dff8e4
Packit Service dff8e4
typedef struct triple_timestamp {
Packit Service dff8e4
        usec_t realtime;
Packit Service dff8e4
        usec_t monotonic;
Packit Service dff8e4
        usec_t boottime;
Packit Service dff8e4
} triple_timestamp;
Packit Service dff8e4
Packit Service dff8e4
typedef enum TimestampStyle {
Packit Service dff8e4
        TIMESTAMP_PRETTY,
Packit Service dff8e4
        TIMESTAMP_US,
Packit Service dff8e4
        TIMESTAMP_UTC,
Packit Service dff8e4
        TIMESTAMP_US_UTC,
Packit Service dff8e4
        _TIMESTAMP_STYLE_MAX,
Packit Service dff8e4
        _TIMESTAMP_STYLE_INVALID = -1,
Packit Service dff8e4
} TimestampStyle;
Packit Service dff8e4
Packit Service dff8e4
#define USEC_INFINITY ((usec_t) UINT64_MAX)
Packit Service dff8e4
#define NSEC_INFINITY ((nsec_t) UINT64_MAX)
Packit Service dff8e4
Packit Service dff8e4
#define MSEC_PER_SEC  1000ULL
Packit Service dff8e4
#define USEC_PER_SEC  ((usec_t) 1000000ULL)
Packit Service dff8e4
#define USEC_PER_MSEC ((usec_t) 1000ULL)
Packit Service dff8e4
#define NSEC_PER_SEC  ((nsec_t) 1000000000ULL)
Packit Service dff8e4
#define NSEC_PER_MSEC ((nsec_t) 1000000ULL)
Packit Service dff8e4
#define NSEC_PER_USEC ((nsec_t) 1000ULL)
Packit Service dff8e4
Packit Service dff8e4
#define USEC_PER_MINUTE ((usec_t) (60ULL*USEC_PER_SEC))
Packit Service dff8e4
#define NSEC_PER_MINUTE ((nsec_t) (60ULL*NSEC_PER_SEC))
Packit Service dff8e4
#define USEC_PER_HOUR ((usec_t) (60ULL*USEC_PER_MINUTE))
Packit Service dff8e4
#define NSEC_PER_HOUR ((nsec_t) (60ULL*NSEC_PER_MINUTE))
Packit Service dff8e4
#define USEC_PER_DAY ((usec_t) (24ULL*USEC_PER_HOUR))
Packit Service dff8e4
#define NSEC_PER_DAY ((nsec_t) (24ULL*NSEC_PER_HOUR))
Packit Service dff8e4
#define USEC_PER_WEEK ((usec_t) (7ULL*USEC_PER_DAY))
Packit Service dff8e4
#define NSEC_PER_WEEK ((nsec_t) (7ULL*NSEC_PER_DAY))
Packit Service dff8e4
#define USEC_PER_MONTH ((usec_t) (2629800ULL*USEC_PER_SEC))
Packit Service dff8e4
#define NSEC_PER_MONTH ((nsec_t) (2629800ULL*NSEC_PER_SEC))
Packit Service dff8e4
#define USEC_PER_YEAR ((usec_t) (31557600ULL*USEC_PER_SEC))
Packit Service dff8e4
#define NSEC_PER_YEAR ((nsec_t) (31557600ULL*NSEC_PER_SEC))
Packit Service dff8e4
Packit Service dff8e4
/* We assume a maximum timezone length of 6. TZNAME_MAX is not defined on Linux, but glibc internally initializes this
Packit Service dff8e4
 * to 6. Let's rely on that. */
Packit Service dff8e4
#define FORMAT_TIMESTAMP_MAX (3U+1U+10U+1U+8U+1U+6U+1U+6U+1U)
Packit Service dff8e4
#define FORMAT_TIMESTAMP_WIDTH 28U /* when outputting, assume this width */
Packit Service dff8e4
#define FORMAT_TIMESTAMP_RELATIVE_MAX 256U
Packit Service dff8e4
#define FORMAT_TIMESPAN_MAX 64U
Packit Service dff8e4
Packit Service dff8e4
#define TIME_T_MAX (time_t)((UINTMAX_C(1) << ((sizeof(time_t) << 3) - 1)) - 1)
Packit Service dff8e4
Packit Service dff8e4
#define DUAL_TIMESTAMP_NULL ((struct dual_timestamp) {})
Packit Service dff8e4
#define TRIPLE_TIMESTAMP_NULL ((struct triple_timestamp) {})
Packit Service dff8e4
Packit Service dff8e4
usec_t now(clockid_t clock);
Packit Service dff8e4
nsec_t now_nsec(clockid_t clock);
Packit Service dff8e4
Packit Service dff8e4
usec_t map_clock_usec(usec_t from, clockid_t from_clock, clockid_t to_clock);
Packit Service dff8e4
Packit Service dff8e4
dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
Packit Service dff8e4
dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
Packit Service dff8e4
dual_timestamp* dual_timestamp_from_monotonic(dual_timestamp *ts, usec_t u);
Packit Service dff8e4
dual_timestamp* dual_timestamp_from_boottime_or_monotonic(dual_timestamp *ts, usec_t u);
Packit Service dff8e4
Packit Service dff8e4
triple_timestamp* triple_timestamp_get(triple_timestamp *ts);
Packit Service dff8e4
triple_timestamp* triple_timestamp_from_realtime(triple_timestamp *ts, usec_t u);
Packit Service dff8e4
Packit Service dff8e4
#define DUAL_TIMESTAMP_HAS_CLOCK(clock)                               \
Packit Service dff8e4
        IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC)
Packit Service dff8e4
Packit Service dff8e4
#define TRIPLE_TIMESTAMP_HAS_CLOCK(clock)                               \
Packit Service dff8e4
        IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC, CLOCK_BOOTTIME, CLOCK_BOOTTIME_ALARM)
Packit Service dff8e4
Packit Service dff8e4
static inline bool timestamp_is_set(usec_t timestamp) {
Packit Service dff8e4
        return timestamp > 0 && timestamp != USEC_INFINITY;
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
static inline bool dual_timestamp_is_set(const dual_timestamp *ts) {
Packit Service dff8e4
        return timestamp_is_set(ts->realtime) ||
Packit Service dff8e4
               timestamp_is_set(ts->monotonic);
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
static inline bool triple_timestamp_is_set(const triple_timestamp *ts) {
Packit Service dff8e4
        return timestamp_is_set(ts->realtime) ||
Packit Service dff8e4
               timestamp_is_set(ts->monotonic) ||
Packit Service dff8e4
               timestamp_is_set(ts->boottime);
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
usec_t triple_timestamp_by_clock(triple_timestamp *ts, clockid_t clock);
Packit Service dff8e4
Packit Service dff8e4
usec_t timespec_load(const struct timespec *ts) _pure_;
Packit Service dff8e4
nsec_t timespec_load_nsec(const struct timespec *ts) _pure_;
Packit Service dff8e4
struct timespec *timespec_store(struct timespec *ts, usec_t u);
Packit Service dff8e4
struct timespec *timespec_store_nsec(struct timespec *ts, nsec_t n);
Packit Service dff8e4
Packit Service dff8e4
usec_t timeval_load(const struct timeval *tv) _pure_;
Packit Service dff8e4
struct timeval *timeval_store(struct timeval *tv, usec_t u);
Packit Service dff8e4
Packit Service dff8e4
char *format_timestamp_style(char *buf, size_t l, usec_t t, TimestampStyle style);
Packit Service dff8e4
char *format_timestamp_relative(char *buf, size_t l, usec_t t);
Packit Service dff8e4
char *format_timespan(char *buf, size_t l, usec_t t, usec_t accuracy);
Packit Service dff8e4
Packit Service dff8e4
static inline char *format_timestamp(char *buf, size_t l, usec_t t) {
Packit Service dff8e4
        return format_timestamp_style(buf, l, t, TIMESTAMP_PRETTY);
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
int parse_timestamp(const char *t, usec_t *usec);
Packit Service dff8e4
Packit Service dff8e4
int parse_sec(const char *t, usec_t *usec);
Packit Service dff8e4
int parse_sec_fix_0(const char *t, usec_t *usec);
Packit Service dff8e4
int parse_sec_def_infinity(const char *t, usec_t *usec);
Packit Service dff8e4
int parse_time(const char *t, usec_t *usec, usec_t default_unit);
Packit Service dff8e4
int parse_nsec(const char *t, nsec_t *nsec);
Packit Service dff8e4
Packit Service dff8e4
bool ntp_synced(void);
Packit Service dff8e4
Packit Service dff8e4
int get_timezones(char ***l);
Packit Service dff8e4
bool timezone_is_valid(const char *name, int log_level);
Packit Service dff8e4
Packit Service dff8e4
bool clock_boottime_supported(void);
Packit Service dff8e4
bool clock_supported(clockid_t clock);
Packit Service dff8e4
clockid_t clock_boottime_or_monotonic(void);
Packit Service dff8e4
Packit Service dff8e4
usec_t usec_shift_clock(usec_t, clockid_t from, clockid_t to);
Packit Service dff8e4
Packit Service dff8e4
int get_timezone(char **timezone);
Packit Service dff8e4
Packit Service dff8e4
time_t mktime_or_timegm(struct tm *tm, bool utc);
Packit Service dff8e4
struct tm *localtime_or_gmtime_r(const time_t *t, struct tm *tm, bool utc);
Packit Service dff8e4
Packit Service dff8e4
uint32_t usec_to_jiffies(usec_t usec);
Packit Service dff8e4
usec_t jiffies_to_usec(uint32_t jiffies);
Packit Service dff8e4
Packit Service dff8e4
bool in_utc_timezone(void);
Packit Service dff8e4
Packit Service dff8e4
static inline usec_t usec_add(usec_t a, usec_t b) {
Packit Service dff8e4
        usec_t c;
Packit Service dff8e4
Packit Service dff8e4
        /* Adds two time values, and makes sure USEC_INFINITY as input results as USEC_INFINITY in output, and doesn't
Packit Service dff8e4
         * overflow. */
Packit Service dff8e4
Packit Service dff8e4
        c = a + b;
Packit Service dff8e4
        if (c < a || c < b) /* overflow check */
Packit Service dff8e4
                return USEC_INFINITY;
Packit Service dff8e4
Packit Service dff8e4
        return c;
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
static inline usec_t usec_sub_unsigned(usec_t timestamp, usec_t delta) {
Packit Service dff8e4
Packit Service dff8e4
        if (timestamp == USEC_INFINITY) /* Make sure infinity doesn't degrade */
Packit Service dff8e4
                return USEC_INFINITY;
Packit Service dff8e4
        if (timestamp < delta)
Packit Service dff8e4
                return 0;
Packit Service dff8e4
Packit Service dff8e4
        return timestamp - delta;
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
static inline usec_t usec_sub_signed(usec_t timestamp, int64_t delta) {
Packit Service dff8e4
        if (delta < 0)
Packit Service dff8e4
                return usec_add(timestamp, (usec_t) (-delta));
Packit Service dff8e4
        else
Packit Service dff8e4
                return usec_sub_unsigned(timestamp, (usec_t) delta);
Packit Service dff8e4
}
Packit Service dff8e4
Packit Service dff8e4
#if SIZEOF_TIME_T == 8
Packit Service dff8e4
/* The last second we can format is 31. Dec 9999, 1s before midnight, because otherwise we'd enter 5 digit year
Packit Service dff8e4
 * territory. However, since we want to stay away from this in all timezones we take one day off. */
Packit Service dff8e4
#define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 253402214399000000)
Packit Service dff8e4
#elif SIZEOF_TIME_T == 4
Packit Service dff8e4
/* With a 32bit time_t we can't go beyond 2038... */
Packit Service dff8e4
#define USEC_TIMESTAMP_FORMATTABLE_MAX ((usec_t) 2147483647000000)
Packit Service dff8e4
#else
Packit Service dff8e4
#error "Yuck, time_t is neither 4 nor 8 bytes wide?"
Packit Service dff8e4
#endif
Packit Service dff8e4
Packit Service dff8e4
int time_change_fd(void);
Packit Service dff8e4
Packit Service dff8e4
const char* timestamp_style_to_string(TimestampStyle t) _const_;
Packit Service dff8e4
TimestampStyle timestamp_style_from_string(const char *s) _pure_;