Fix: hide internal libcommon time utilities
[lttng-tools.git] / src / common / time.h
1 /*
2 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #ifndef LTTNG_TIME_H
20 #define LTTNG_TIME_H
21
22 #include <time.h>
23 #include <stdbool.h>
24 #include <common/macros.h>
25
26 #define MSEC_PER_SEC 1000ULL
27 #define NSEC_PER_SEC 1000000000ULL
28 #define NSEC_PER_MSEC 1000000ULL
29 #define NSEC_PER_USEC 1000ULL
30 #define USEC_PER_SEC 1000000ULL
31 #define USEC_PER_MSEC 1000ULL
32
33 #define SEC_PER_MINUTE 60ULL
34 #define MINUTE_PER_HOUR 60ULL
35
36 #define USEC_PER_MINUTE (USEC_PER_SEC * SEC_PER_MINUTE)
37 #define USEC_PER_HOURS (USEC_PER_MINUTE * MINUTE_PER_HOUR)
38
39 LTTNG_HIDDEN
40 bool locale_supports_utf8(void);
41
42 #define NSEC_UNIT "ns"
43 #define USEC_UNIT (locale_supports_utf8() ? "µs" : "us")
44 #define MSEC_UNIT "ms"
45 #define SEC_UNIT "s"
46 #define MIN_UNIT "m"
47 #define HR_UNIT "h"
48
49 /*
50 * timespec_to_ms: Convert timespec to milliseconds.
51 *
52 * Returns 0 on success, else -1 on error. errno is set to EOVERFLOW if
53 * input would overflow the output in milliseconds.
54 */
55 LTTNG_HIDDEN
56 int timespec_to_ms(struct timespec ts, unsigned long *ms);
57
58 /*
59 * timespec_abs_diff: Absolute difference between timespec.
60 */
61 LTTNG_HIDDEN
62 struct timespec timespec_abs_diff(struct timespec ts_a, struct timespec ts_b);
63
64 #endif /* LTTNG_TIME_H */
This page took 0.042454 seconds and 4 git commands to generate.