87adf17d75d40af2945ef392bb45129bb777d11b
[lttng-tools.git] / src / common / time.h
1 /*
2 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 */
7
8 #ifndef LTTNG_TIME_H
9 #define LTTNG_TIME_H
10
11 #include <time.h>
12 #include <stdbool.h>
13 #include <common/macros.h>
14 #include <common/compat/time.h>
15
16 #define MSEC_PER_SEC 1000ULL
17 #define NSEC_PER_SEC 1000000000ULL
18 #define NSEC_PER_MSEC 1000000ULL
19 #define NSEC_PER_USEC 1000ULL
20 #define USEC_PER_SEC 1000000ULL
21 #define USEC_PER_MSEC 1000ULL
22
23 #define SEC_PER_MINUTE 60ULL
24 #define MINUTE_PER_HOUR 60ULL
25
26 #define USEC_PER_MINUTE (USEC_PER_SEC * SEC_PER_MINUTE)
27 #define USEC_PER_HOURS (USEC_PER_MINUTE * MINUTE_PER_HOUR)
28
29 #define ISO8601_STR_LEN sizeof("YYYYmmddTHHMMSS+HHMM")
30 #define DATETIME_STR_LEN sizeof("YYYYmmdd-HHMMSS")
31
32 bool locale_supports_utf8(void);
33
34 #define NSEC_UNIT "ns"
35 #define USEC_UNIT (locale_supports_utf8() ? "µs" : "us")
36 #define MSEC_UNIT "ms"
37 #define SEC_UNIT "s"
38 #define MIN_UNIT "m"
39 #define HR_UNIT "h"
40
41 /*
42 * timespec_to_ms: Convert timespec to milliseconds.
43 *
44 * Returns 0 on success, else -1 on error. errno is set to EOVERFLOW if
45 * input would overflow the output in milliseconds.
46 */
47 int timespec_to_ms(struct timespec ts, unsigned long *ms);
48
49 /*
50 * timespec_abs_diff: Absolute difference between timespec.
51 */
52 struct timespec timespec_abs_diff(struct timespec ts_a, struct timespec ts_b);
53
54 /*
55 * Format a Unix timestamp to an ISO 8601 compatible timestamp of
56 * the form "YYYYmmddTHHMMSS+HHMM" in local time. `len` must >= to
57 * ISO8601_STR_LEN.
58 *
59 * Returns 0 on success, else -1 on error.
60 */
61 int time_to_iso8601_str(time_t time, char *str, size_t len);
62
63 int time_to_datetime_str(time_t time, char *str, size_t len);
64
65 #endif /* LTTNG_TIME_H */
This page took 0.029987 seconds and 3 git commands to generate.