[babeltrace.git] / src / lib / trace-ir / clock-class.h

#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace2/trace-ir/clock-class.h>
#include "lib/object.h"
#include "common/macros.h"
#include "common/common.h"
#include "lib/object-pool.h"
#include "common/uuid.h"
#include <babeltrace2/types.h>
#include "lib/property.h"
#include "common/assert.h"
#include <stdbool.h>
#include <stdint.h>
#include <glib.h>

#include "lib/func-status.h"

struct bt_clock_class {
	struct bt_object base;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} name;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} description;

	uint64_t frequency;
	uint64_t precision;
	int64_t offset_seconds;
	uint64_t offset_cycles;

	struct {
		bt_uuid_t uuid;

		/* NULL or `uuid` above */
		bt_uuid value;
	} uuid;

	bool origin_is_unix_epoch;

	/*
	 * This is computed every time you call
	 * bt_clock_class_set_frequency() or
	 * bt_clock_class_set_offset(), as well as initially. It is the
	 * base offset in nanoseconds including both `offset_seconds`
	 * and `offset_cycles` above in the result. It is used to
	 * accelerate future calls to
	 * bt_clock_snapshot_get_ns_from_origin() and
	 * bt_clock_class_cycles_to_ns_from_origin().
	 *
	 * `overflows` is true if the base offset cannot be computed
	 * because of an overflow.
	 */
	struct {
		int64_t value_ns;
		bool overflows;
	} base_offset;

	/* Pool of `struct bt_clock_snapshot *` */
	struct bt_object_pool cs_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);

#ifdef BT_DEV_MODE
# define bt_clock_class_freeze		_bt_clock_class_freeze
#else
# define bt_clock_class_freeze(_cc)
#endif

BT_HIDDEN
bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);

static inline
int bt_clock_class_clock_value_from_ns_from_origin(
		struct bt_clock_class *cc, int64_t ns_from_origin,
		uint64_t *raw_value)
{
	BT_ASSERT(cc);

	return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
		cc->offset_cycles, cc->frequency, ns_from_origin,
		raw_value) ? BT_FUNC_STATUS_OVERFLOW : BT_FUNC_STATUS_OK;
}

#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
Commit	Line	Data
108b91d0 PP	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
108b91d0 PP	2	#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
f2b0325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
de9dd397	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be	7	*
273b65be JG	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
71c5da58	27	#include <babeltrace2/trace-ir/clock-class.h>
57952005	28	#include "lib/object.h"
85e7137b	29	#include "common/macros.h"
57952005 MJ	30	#include "common/common.h"
57952005 MJ	31	#include "lib/object-pool.h"
d126826c	32	#include "common/uuid.h"
71c5da58	33	#include <babeltrace2/types.h>
57952005 MJ	34	#include "lib/property.h"
57952005 MJ	35	#include "common/assert.h"
24e770c1 PP	36	#include <stdbool.h>
24e770c1 PP	37	#include <stdint.h>
c55a9f58	38	#include <glib.h>
273b65be	39
fb25b9e3 PP	40	#include "lib/func-status.h"
fb25b9e3 PP	41
839d52a5	42	struct bt_clock_class {
83509119	43	struct bt_object base;
7b33a0e0 PP	44
	45	struct {
	46	GString *str;
	47
	48	/* NULL or `str->str` above */
	49	const char *value;
	50	} name;
	51
	52	struct {
	53	GString *str;
	54
	55	/* NULL or `str->str` above */
	56	const char *value;
	57	} description;
	58
273b65be JG	59	uint64_t frequency;
273b65be JG	60	uint64_t precision;
7b33a0e0 PP	61	int64_t offset_seconds;
	62	uint64_t offset_cycles;
	63
	64	struct {
d126826c	65	bt_uuid_t uuid;
7b33a0e0 PP	66
	67	/* NULL or `uuid` above */
	68	bt_uuid value;
	69	} uuid;
	70
d608d675	71	bool origin_is_unix_epoch;
cfeb617e	72
273b65be	73	/*
7b33a0e0 PP	74	* This is computed every time you call
	75	* bt_clock_class_set_frequency() or
	76	* bt_clock_class_set_offset(), as well as initially. It is the
	77	* base offset in nanoseconds including both `offset_seconds`
	78	* and `offset_cycles` above in the result. It is used to
	79	* accelerate future calls to
ecbb78c0	80	* bt_clock_snapshot_get_ns_from_origin() and
7b33a0e0 PP	81	* bt_clock_class_cycles_to_ns_from_origin().
	82	*
	83	* `overflows` is true if the base offset cannot be computed
	84	* because of an overflow.
273b65be	85	*/
7b33a0e0 PP	86	struct {
	87	int64_t value_ns;
	88	bool overflows;
	89	} base_offset;
a6918753	90
ecbb78c0 PP	91	/* Pool of `struct bt_clock_snapshot ` /
ecbb78c0 PP	92	struct bt_object_pool cs_pool;
7b33a0e0 PP	93
7b33a0e0 PP	94	bool frozen;
273b65be JG	95	};
	96
	97	BT_HIDDEN
78cf9df6	98	void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
273b65be	99
7b33a0e0 PP	100	#ifdef BT_DEV_MODE
	101	# define bt_clock_class_freeze _bt_clock_class_freeze
	102	#else
	103	# define bt_clock_class_freeze(_cc)
	104	#endif
24626e8b	105
db3347ac	106	BT_HIDDEN
7b33a0e0	107	bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
db3347ac	108
3d902f17 PP	109	static inline
	110	int bt_clock_class_clock_value_from_ns_from_origin(
	111	struct bt_clock_class *cc, int64_t ns_from_origin,
	112	uint64_t *raw_value)
	113	{
3d902f17	114	BT_ASSERT(cc);
781751d8 PP	115
	116	return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
	117	cc->offset_cycles, cc->frequency, ns_from_origin,
fb25b9e3	118	raw_value) ? BT_FUNC_STATUS_OVERFLOW : BT_FUNC_STATUS_OK;
3d902f17 PP	119	}
3d902f17 PP	120
108b91d0	121	#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */