| 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 | #include <common/compat/time.h> |
| 26 | |
| 27 | #define MSEC_PER_SEC 1000ULL |
| 28 | #define NSEC_PER_SEC 1000000000ULL |
| 29 | #define NSEC_PER_MSEC 1000000ULL |
| 30 | #define NSEC_PER_USEC 1000ULL |
| 31 | #define USEC_PER_SEC 1000000ULL |
| 32 | #define USEC_PER_MSEC 1000ULL |
| 33 | |
| 34 | #define SEC_PER_MINUTE 60ULL |
| 35 | #define MINUTE_PER_HOUR 60ULL |
| 36 | |
| 37 | #define USEC_PER_MINUTE (USEC_PER_SEC * SEC_PER_MINUTE) |
| 38 | #define USEC_PER_HOURS (USEC_PER_MINUTE * MINUTE_PER_HOUR) |
| 39 | |
| 40 | #define ISO8601_STR_LEN sizeof("YYYYmmddTHHMMSS+HHMM") |
| 41 | #define DATETIME_STR_LEN sizeof("YYYYmmdd-HHMMSS") |
| 42 | |
| 43 | LTTNG_HIDDEN |
| 44 | bool locale_supports_utf8(void); |
| 45 | |
| 46 | #define NSEC_UNIT "ns" |
| 47 | #define USEC_UNIT (locale_supports_utf8() ? "µs" : "us") |
| 48 | #define MSEC_UNIT "ms" |
| 49 | #define SEC_UNIT "s" |
| 50 | #define MIN_UNIT "m" |
| 51 | #define HR_UNIT "h" |
| 52 | |
| 53 | /* |
| 54 | * timespec_to_ms: Convert timespec to milliseconds. |
| 55 | * |
| 56 | * Returns 0 on success, else -1 on error. errno is set to EOVERFLOW if |
| 57 | * input would overflow the output in milliseconds. |
| 58 | */ |
| 59 | LTTNG_HIDDEN |
| 60 | int timespec_to_ms(struct timespec ts, unsigned long *ms); |
| 61 | |
| 62 | /* |
| 63 | * timespec_abs_diff: Absolute difference between timespec. |
| 64 | */ |
| 65 | LTTNG_HIDDEN |
| 66 | struct timespec timespec_abs_diff(struct timespec ts_a, struct timespec ts_b); |
| 67 | |
| 68 | /* |
| 69 | * Format a Unix timestamp to an ISO 8601 compatible timestamp of |
| 70 | * the form "YYYYmmddTHHMMSS+HHMM" in local time. `len` must >= to |
| 71 | * ISO8601_STR_LEN. |
| 72 | * |
| 73 | * Returns 0 on success, else -1 on error. |
| 74 | */ |
| 75 | LTTNG_HIDDEN |
| 76 | int time_to_iso8601_str(time_t time, char *str, size_t len); |
| 77 | |
| 78 | LTTNG_HIDDEN |
| 79 | int time_to_datetime_str(time_t time, char *str, size_t len); |
| 80 | |
| 81 | #endif /* LTTNG_TIME_H */ |