[babeltrace.git] / include / babeltrace2 / trace-ir / clock-snapshot-internal.h

#ifndef BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H
#define BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@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/babeltrace-internal.h>
#include <babeltrace2/object-internal.h>
#include <babeltrace2/trace-ir/clock-class-internal.h>
#include <babeltrace2/trace-ir/utils-internal.h>
#include <stdbool.h>
#include <stdint.h>

struct bt_clock_class;

struct bt_clock_snapshot {
	struct bt_object base;
	struct bt_clock_class *clock_class;
	uint64_t value_cycles;
	bool ns_from_origin_overflows;
	int64_t ns_from_origin;
	bool is_set;
};

static inline
void bt_clock_snapshot_set(struct bt_clock_snapshot *clock_snapshot)
{
	BT_ASSERT(clock_snapshot);
	clock_snapshot->is_set = true;
}

static inline
void bt_clock_snapshot_reset(struct bt_clock_snapshot *clock_snapshot)
{
	BT_ASSERT(clock_snapshot);
	clock_snapshot->is_set = false;
}

static inline
void set_ns_from_origin(struct bt_clock_snapshot *clock_snapshot)
{
	if (bt_util_ns_from_origin_clock_class(clock_snapshot->clock_class,
			clock_snapshot->value_cycles,
			&clock_snapshot->ns_from_origin)) {
		clock_snapshot->ns_from_origin_overflows = true;
	}
}

static inline
void bt_clock_snapshot_set_raw_value(struct bt_clock_snapshot *clock_snapshot,
		uint64_t cycles)
{
	BT_ASSERT(clock_snapshot);
	clock_snapshot->value_cycles = cycles;
	set_ns_from_origin(clock_snapshot);
	bt_clock_snapshot_set(clock_snapshot);
}

BT_HIDDEN
void bt_clock_snapshot_destroy(struct bt_clock_snapshot *clock_snapshot);

BT_HIDDEN
struct bt_clock_snapshot *bt_clock_snapshot_new(struct bt_clock_class *clock_class);

BT_HIDDEN
struct bt_clock_snapshot *bt_clock_snapshot_create(
		struct bt_clock_class *clock_class);

BT_HIDDEN
void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot);

#endif /* BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H */
Commit	Line	Data
605e1019 PP	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H
605e1019 PP	2	#define BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H
c057dea0 PP	3
c057dea0 PP	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
c057dea0 PP	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
3fadfbc0 MJ	26	#include <babeltrace2/babeltrace-internal.h>
	27	#include <babeltrace2/object-internal.h>
	28	#include <babeltrace2/trace-ir/clock-class-internal.h>
	29	#include <babeltrace2/trace-ir/utils-internal.h>
c057dea0 PP	30	#include <stdbool.h>
	31	#include <stdint.h>
	32
50842bdc	33	struct bt_clock_class;
c057dea0	34
605e1019	35	struct bt_clock_snapshot {
c057dea0	36	struct bt_object base;
50842bdc	37	struct bt_clock_class *clock_class;
44c440bc PP	38	uint64_t value_cycles;
	39	bool ns_from_origin_overflows;
	40	int64_t ns_from_origin;
312c056a	41	bool is_set;
c057dea0 PP	42	};
c057dea0 PP	43
312c056a	44	static inline
605e1019	45	void bt_clock_snapshot_set(struct bt_clock_snapshot *clock_snapshot)
312c056a	46	{
605e1019 PP	47	BT_ASSERT(clock_snapshot);
605e1019 PP	48	clock_snapshot->is_set = true;
312c056a PP	49	}
	50
	51	static inline
605e1019	52	void bt_clock_snapshot_reset(struct bt_clock_snapshot *clock_snapshot)
312c056a	53	{
605e1019 PP	54	BT_ASSERT(clock_snapshot);
605e1019 PP	55	clock_snapshot->is_set = false;
312c056a PP	56	}
312c056a PP	57
312c056a	58	static inline
605e1019	59	void set_ns_from_origin(struct bt_clock_snapshot *clock_snapshot)
312c056a	60	{
0f2d58c9 PP	61	if (bt_util_ns_from_origin_clock_class(clock_snapshot->clock_class,
0f2d58c9 PP	62	clock_snapshot->value_cycles,
605e1019 PP	63	&clock_snapshot->ns_from_origin)) {
605e1019 PP	64	clock_snapshot->ns_from_origin_overflows = true;
e22b45d0	65	}
e22b45d0 PP	66	}
	67
	68	static inline
605e1019	69	void bt_clock_snapshot_set_raw_value(struct bt_clock_snapshot *clock_snapshot,
e22b45d0 PP	70	uint64_t cycles)
e22b45d0 PP	71	{
605e1019 PP	72	BT_ASSERT(clock_snapshot);
	73	clock_snapshot->value_cycles = cycles;
	74	set_ns_from_origin(clock_snapshot);
	75	bt_clock_snapshot_set(clock_snapshot);
e22b45d0 PP	76	}
e22b45d0 PP	77
44c440bc	78	BT_HIDDEN
605e1019	79	void bt_clock_snapshot_destroy(struct bt_clock_snapshot *clock_snapshot);
44c440bc PP	80
44c440bc PP	81	BT_HIDDEN
605e1019	82	struct bt_clock_snapshot bt_clock_snapshot_new(struct bt_clock_class clock_class);
312c056a PP	83
312c056a PP	84	BT_HIDDEN
605e1019	85	struct bt_clock_snapshot *bt_clock_snapshot_create(
312c056a PP	86	struct bt_clock_class *clock_class);
	87
	88	BT_HIDDEN
605e1019	89	void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot);
312c056a	90
605e1019	91	#endif /* BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H */