[babeltrace.git] / include / babeltrace / ctf-ir / clock-value-internal.h

#ifndef BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H
#define BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H

/*
 * Copyright 2017 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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/ctf-ir/clock-class-internal.h>
#include <babeltrace/ctf-ir/utils-internal.h>
#include <stdbool.h>
#include <stdint.h>

struct bt_clock_class;

struct bt_clock_value {
	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_value_set(struct bt_clock_value *clock_value)
{
	BT_ASSERT(clock_value);
	clock_value->is_set = true;
}

static inline
void bt_clock_value_reset(struct bt_clock_value *clock_value)
{
	BT_ASSERT(clock_value);
	clock_value->is_set = false;
}

static inline
void set_ns_from_origin(struct bt_clock_value *clock_value)
{
	if (bt_util_ns_from_origin(clock_value->clock_class, clock_value->value_cycles,
			&clock_value->ns_from_origin)) {
		clock_value->ns_from_origin_overflows = true;
	}

}

static inline
void bt_clock_value_set_raw_value(struct bt_clock_value *clock_value,
		uint64_t cycles)
{
	BT_ASSERT(clock_value);
	clock_value->value_cycles = cycles;
	set_ns_from_origin(clock_value);
	bt_clock_value_set(clock_value);
}

static inline
void bt_clock_value_set_value_inline(struct bt_clock_value *clock_value,
		uint64_t raw_value)
{
	bt_clock_value_set_raw_value(clock_value, raw_value);
}

BT_HIDDEN
void bt_clock_value_destroy(struct bt_clock_value *clock_value);

BT_HIDDEN
struct bt_clock_value *bt_clock_value_new(struct bt_clock_class *clock_class);

BT_HIDDEN
struct bt_clock_value *bt_clock_value_create(
		struct bt_clock_class *clock_class);

BT_HIDDEN
void bt_clock_value_recycle(struct bt_clock_value *clock_value);

BT_HIDDEN
void bt_clock_value_set_raw_value(struct bt_clock_value *clock_value,
		uint64_t cycles);

#endif /* BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H */
Commit	Line	Data
c057dea0 PP	1	#ifndef BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H
	2	#define BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
	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
312c056a	26	#include <babeltrace/babeltrace-internal.h>
c057dea0	27	#include <babeltrace/object-internal.h>
e22b45d0	28	#include <babeltrace/ctf-ir/clock-class-internal.h>
44c440bc	29	#include <babeltrace/ctf-ir/utils-internal.h>
c057dea0 PP	30	#include <stdbool.h>
	31	#include <stdint.h>
	32
50842bdc	33	struct bt_clock_class;
c057dea0	34
50842bdc	35	struct bt_clock_value {
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 PP	44	static inline
	45	void bt_clock_value_set(struct bt_clock_value *clock_value)
	46	{
	47	BT_ASSERT(clock_value);
	48	clock_value->is_set = true;
	49	}
	50
	51	static inline
	52	void bt_clock_value_reset(struct bt_clock_value *clock_value)
	53	{
	54	BT_ASSERT(clock_value);
	55	clock_value->is_set = false;
	56	}
	57
312c056a	58	static inline
44c440bc	59	void set_ns_from_origin(struct bt_clock_value *clock_value)
312c056a	60	{
44c440bc PP	61	if (bt_util_ns_from_origin(clock_value->clock_class, clock_value->value_cycles,
	62	&clock_value->ns_from_origin)) {
	63	clock_value->ns_from_origin_overflows = true;
e22b45d0 PP	64	}
e22b45d0 PP	65
e22b45d0 PP	66	}
	67
	68	static inline
	69	void bt_clock_value_set_raw_value(struct bt_clock_value *clock_value,
	70	uint64_t cycles)
	71	{
	72	BT_ASSERT(clock_value);
44c440bc PP	73	clock_value->value_cycles = cycles;
44c440bc PP	74	set_ns_from_origin(clock_value);
e22b45d0 PP	75	bt_clock_value_set(clock_value);
	76	}
	77
	78	static inline
44c440bc	79	void bt_clock_value_set_value_inline(struct bt_clock_value *clock_value,
e22b45d0 PP	80	uint64_t raw_value)
e22b45d0 PP	81	{
e22b45d0	82	bt_clock_value_set_raw_value(clock_value, raw_value);
e22b45d0 PP	83	}
e22b45d0 PP	84
44c440bc PP	85	BT_HIDDEN
	86	void bt_clock_value_destroy(struct bt_clock_value *clock_value);
	87
	88	BT_HIDDEN
	89	struct bt_clock_value bt_clock_value_new(struct bt_clock_class clock_class);
312c056a PP	90
	91	BT_HIDDEN
	92	struct bt_clock_value *bt_clock_value_create(
	93	struct bt_clock_class *clock_class);
	94
	95	BT_HIDDEN
	96	void bt_clock_value_recycle(struct bt_clock_value *clock_value);
	97
	98	BT_HIDDEN
	99	void bt_clock_value_set_raw_value(struct bt_clock_value *clock_value,
	100	uint64_t cycles);
	101
c057dea0	102	#endif /* BABELTRACE_CTF_IR_CLOCK_VALUE_INTERNAL_H */