[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;

	/* Owned by this */
	struct bt_value *user_attributes;

	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_DBG(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_ERROR : BT_FUNC_STATUS_OK;
}

#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
Commit	Line	Data
56e18c4c PP	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
56e18c4c PP	2	#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
e2f7325d	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
3fadfbc0	27	#include <babeltrace2/trace-ir/clock-class.h>
578e048b	28	#include "lib/object.h"
91d81473	29	#include "common/macros.h"
578e048b MJ	30	#include "common/common.h"
578e048b MJ	31	#include "lib/object-pool.h"
6162e6b7	32	#include "common/uuid.h"
3fadfbc0	33	#include <babeltrace2/types.h>
578e048b MJ	34	#include "lib/property.h"
578e048b MJ	35	#include "common/assert.h"
036a7cac PP	36	#include <stdbool.h>
036a7cac PP	37	#include <stdint.h>
c55a9f58	38	#include <glib.h>
273b65be	39
d24d5663 PP	40	#include "lib/func-status.h"
d24d5663 PP	41
50842bdc	42	struct bt_clock_class {
83509119	43	struct bt_object base;
44c440bc	44
c6962c96 PP	45	/* Owned by this */
	46	struct bt_value *user_attributes;
	47
44c440bc PP	48	struct {
	49	GString *str;
	50
	51	/* NULL or `str->str` above */
	52	const char *value;
	53	} name;
	54
	55	struct {
	56	GString *str;
	57
	58	/* NULL or `str->str` above */
	59	const char *value;
	60	} description;
	61
273b65be JG	62	uint64_t frequency;
273b65be JG	63	uint64_t precision;
44c440bc PP	64	int64_t offset_seconds;
	65	uint64_t offset_cycles;
	66
	67	struct {
6162e6b7	68	bt_uuid_t uuid;
44c440bc PP	69
	70	/* NULL or `uuid` above */
	71	bt_uuid value;
	72	} uuid;
	73
5552377a	74	bool origin_is_unix_epoch;
cfeb617e	75
273b65be	76	/*
44c440bc PP	77	* This is computed every time you call
	78	* bt_clock_class_set_frequency() or
	79	* bt_clock_class_set_offset(), as well as initially. It is the
	80	* base offset in nanoseconds including both `offset_seconds`
	81	* and `offset_cycles` above in the result. It is used to
	82	* accelerate future calls to
605e1019	83	* bt_clock_snapshot_get_ns_from_origin() and
44c440bc PP	84	* bt_clock_class_cycles_to_ns_from_origin().
	85	*
	86	* `overflows` is true if the base offset cannot be computed
	87	* because of an overflow.
273b65be	88	*/
44c440bc PP	89	struct {
	90	int64_t value_ns;
	91	bool overflows;
	92	} base_offset;
312c056a	93
605e1019 PP	94	/* Pool of `struct bt_clock_snapshot ` /
605e1019 PP	95	struct bt_object_pool cs_pool;
44c440bc PP	96
44c440bc PP	97	bool frozen;
273b65be JG	98	};
	99
	100	BT_HIDDEN
40f4ba76	101	void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
273b65be	102
44c440bc PP	103	#ifdef BT_DEV_MODE
	104	# define bt_clock_class_freeze _bt_clock_class_freeze
	105	#else
	106	# define bt_clock_class_freeze(_cc)
	107	#endif
24626e8b	108
93dda901	109	BT_HIDDEN
44c440bc	110	bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
93dda901	111
5b9e151d PP	112	static inline
	113	int bt_clock_class_clock_value_from_ns_from_origin(
	114	struct bt_clock_class *cc, int64_t ns_from_origin,
	115	uint64_t *raw_value)
	116	{
98b15851	117	BT_ASSERT_DBG(cc);
7de0e49a PP	118	return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
7de0e49a PP	119	cc->offset_cycles, cc->frequency, ns_from_origin,
520cdc82	120	raw_value) ? BT_FUNC_STATUS_OVERFLOW_ERROR : BT_FUNC_STATUS_OK;
5b9e151d PP	121	}
5b9e151d PP	122
56e18c4c	123	#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */