[lttng-tools.git] / src / common / time.h

/*
 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef LTTNG_TIME_H
#define LTTNG_TIME_H

#include <time.h>
#include <stdbool.h>
#include <common/macros.h>

#define MSEC_PER_SEC    1000ULL
#define NSEC_PER_SEC    1000000000ULL
#define NSEC_PER_MSEC   1000000ULL
#define NSEC_PER_USEC   1000ULL
#define USEC_PER_SEC    1000000ULL
#define USEC_PER_MSEC   1000ULL

#define SEC_PER_MINUTE  60ULL
#define MINUTE_PER_HOUR 60ULL

#define USEC_PER_MINUTE (USEC_PER_SEC * SEC_PER_MINUTE)
#define USEC_PER_HOURS  (USEC_PER_MINUTE * MINUTE_PER_HOUR)

#define ISO8601_STR_LEN sizeof("YYYYmmddTHHMMSS+HHMM")

LTTNG_HIDDEN
bool locale_supports_utf8(void);

#define NSEC_UNIT       "ns"
#define USEC_UNIT       (locale_supports_utf8() ? "µs" : "us")
#define MSEC_UNIT       "ms"
#define SEC_UNIT        "s"
#define MIN_UNIT        "m"
#define HR_UNIT         "h"

/*
 * timespec_to_ms: Convert timespec to milliseconds.
 *
 * Returns 0 on success, else -1 on error. errno is set to EOVERFLOW if
 * input would overflow the output in milliseconds.
 */
LTTNG_HIDDEN
int timespec_to_ms(struct timespec ts, unsigned long *ms);

/*
 * timespec_abs_diff: Absolute difference between timespec.
 */
LTTNG_HIDDEN
struct timespec timespec_abs_diff(struct timespec ts_a, struct timespec ts_b);

/*
 * Format a Unix timestamp to an ISO 8601 compatible timestamp of
 * the form "YYYYmmddTHHMMSS+HHMM" in local time. `len` must >= to
 * ISO8601_STR_LEN.
 *
 * Returns 0 on success, else -1 on error.
 */
LTTNG_HIDDEN
int time_to_iso8601_str(time_t time, char *str, size_t len);

#endif /* LTTNG_TIME_H */
Commit	Line	Data
395d6b02 JG	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
20a8da1f	22	#include <time.h>
10945cfa	23	#include <stdbool.h>
66532187	24	#include <common/macros.h>
20a8da1f	25
c275dec9 JR	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)
395d6b02	38
b97f43a7 JG	39	#define ISO8601_STR_LEN sizeof("YYYYmmddTHHMMSS+HHMM")
b97f43a7 JG	40
66532187	41	LTTNG_HIDDEN
10945cfa JG	42	bool locale_supports_utf8(void);
	43
	44	#define NSEC_UNIT "ns"
	45	#define USEC_UNIT (locale_supports_utf8() ? "µs" : "us")
	46	#define MSEC_UNIT "ms"
	47	#define SEC_UNIT "s"
	48	#define MIN_UNIT "m"
	49	#define HR_UNIT "h"
	50
20a8da1f MD	51	/*
	52	* timespec_to_ms: Convert timespec to milliseconds.
	53	*
	54	* Returns 0 on success, else -1 on error. errno is set to EOVERFLOW if
	55	* input would overflow the output in milliseconds.
	56	*/
66532187	57	LTTNG_HIDDEN
20a8da1f MD	58	int timespec_to_ms(struct timespec ts, unsigned long *ms);
	59
	60	/*
	61	* timespec_abs_diff: Absolute difference between timespec.
	62	*/
66532187	63	LTTNG_HIDDEN
20a8da1f MD	64	struct timespec timespec_abs_diff(struct timespec ts_a, struct timespec ts_b);
20a8da1f MD	65
b97f43a7 JG	66	/*
	67	* Format a Unix timestamp to an ISO 8601 compatible timestamp of
	68	* the form "YYYYmmddTHHMMSS+HHMM" in local time. `len` must >= to
	69	* ISO8601_STR_LEN.
	70	*
	71	* Returns 0 on success, else -1 on error.
	72	*/
	73	LTTNG_HIDDEN
	74	int time_to_iso8601_str(time_t time, char *str, size_t len);
	75
395d6b02	76	#endif /* LTTNG_TIME_H */