[deliverable/babeltrace.git] / lib / trace-ir / event.c

/*
 * 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.
 */

#define BT_LOG_TAG "EVENT"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/trace-ir/field-internal.h>
#include <babeltrace/trace-ir/field-class-internal.h>
#include <babeltrace/trace-ir/clock-class.h>
#include <babeltrace/trace-ir/clock-snapshot-const.h>
#include <babeltrace/trace-ir/clock-snapshot-internal.h>
#include <babeltrace/trace-ir/clock-class-internal.h>
#include <babeltrace/trace-ir/event-const.h>
#include <babeltrace/trace-ir/event-internal.h>
#include <babeltrace/trace-ir/event-class.h>
#include <babeltrace/trace-ir/event-class-internal.h>
#include <babeltrace/trace-ir/stream-class.h>
#include <babeltrace/trace-ir/stream-class-const.h>
#include <babeltrace/trace-ir/stream-class-internal.h>
#include <babeltrace/trace-ir/stream-internal.h>
#include <babeltrace/trace-ir/packet.h>
#include <babeltrace/trace-ir/packet-internal.h>
#include <babeltrace/trace-ir/trace.h>
#include <babeltrace/trace-ir/trace-internal.h>
#include <babeltrace/trace-ir/packet-internal.h>
#include <babeltrace/trace-ir/attributes-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/compiler-internal.h>
#include <inttypes.h>

BT_HIDDEN
void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
{
	BT_ASSERT(event);
	BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
		event, is_frozen);

	if (event->header_field) {
		BT_LOGD_STR("Setting event's header field's frozen state.");
		bt_field_set_is_frozen(
			event->header_field->field, is_frozen);
	}

	if (event->common_context_field) {
		BT_LOGD_STR("Setting event's common context field's frozen state.");
		bt_field_set_is_frozen(
			event->common_context_field, is_frozen);
	}

	if (event->specific_context_field) {
		BT_LOGD_STR("Setting event's specific context field's frozen state.");
		bt_field_set_is_frozen(event->specific_context_field,
			is_frozen);
	}

	if (event->payload_field) {
		BT_LOGD_STR("Setting event's payload field's frozen state.");
		bt_field_set_is_frozen(event->payload_field,
			is_frozen);
	}

	((struct bt_event *) event)->frozen = is_frozen;
	BT_LOGD_STR("Setting event's packet's frozen state.");
	bt_packet_set_is_frozen(event->packet, is_frozen);
}

static
void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
		struct bt_stream_class *stream_class)
{
	BT_ASSERT(field_wrapper);
	BT_LIB_LOGD("Recycling event header field: "
		"addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
		stream_class, field_wrapper->field);
	bt_object_pool_recycle_object(
		&stream_class->event_header_field_pool,
		field_wrapper);
}

static inline
struct bt_field_wrapper *create_event_header_field(
		struct bt_stream_class *stream_class)
{
	struct bt_field_wrapper *field_wrapper = NULL;

	field_wrapper = bt_field_wrapper_create(
		&stream_class->event_header_field_pool,
		stream_class->event_header_fc);
	if (!field_wrapper) {
		goto error;
	}

	goto end;

error:
	if (field_wrapper) {
		recycle_event_header_field(field_wrapper, stream_class);
		field_wrapper = NULL;
	}

end:
	return field_wrapper;
}

BT_HIDDEN
struct bt_event *bt_event_new(struct bt_event_class *event_class)
{
	struct bt_event *event = NULL;
	struct bt_stream_class *stream_class;
	struct bt_field_class *fc;

	BT_ASSERT(event_class);
	event = g_new0(struct bt_event, 1);
	if (!event) {
		BT_LOGE_STR("Failed to allocate one event.");
		goto error;
	}

	bt_object_init_unique(&event->base);
	stream_class = bt_event_class_borrow_stream_class(event_class);
	BT_ASSERT(stream_class);

	if (stream_class->event_header_fc) {
		event->header_field = create_event_header_field(stream_class);
		if (!event->header_field) {
			BT_LOGE_STR("Cannot create event header field.");
			goto error;
		}
	}

	fc = stream_class->event_common_context_fc;
	if (fc) {
		event->common_context_field = bt_field_create(fc);
		if (!event->common_context_field) {
			/* bt_field_create() logs errors */
			goto error;
		}
	}

	fc = event_class->specific_context_fc;
	if (fc) {
		event->specific_context_field = bt_field_create(fc);
		if (!event->specific_context_field) {
			/* bt_field_create() logs errors */
			goto error;
		}
	}

	fc = event_class->payload_fc;
	if (fc) {
		event->payload_field = bt_field_create(fc);
		if (!event->payload_field) {
			/* bt_field_create() logs errors */
			goto error;
		}
	}

	if (stream_class->default_clock_class) {
		event->default_cs = bt_clock_snapshot_create(
			stream_class->default_clock_class);
		if (!event->default_cs) {
			/* bt_clock_snapshot_create() logs errors */
			goto error;
		}
	}

	goto end;

error:
	if (event) {
		bt_event_destroy(event);
		event = NULL;
	}

end:
	return event;
}

struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->class;
}

const struct bt_event_class *bt_event_borrow_class_const(
		const struct bt_event *event)
{
	return bt_event_borrow_class((void *) event);
}

struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->packet ? event->packet->stream : NULL;
}

const struct bt_stream *bt_event_borrow_stream_const(
		const struct bt_event *event)
{
	return bt_event_borrow_stream((void *) event);
}

struct bt_field *bt_event_borrow_header_field(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->header_field ? event->header_field->field : NULL;
}

const struct bt_field *bt_event_borrow_header_field_const(
		const struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->header_field ? event->header_field->field : NULL;
}

struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->common_context_field;
}

const struct bt_field *bt_event_borrow_common_context_field_const(
		const struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->common_context_field;
}

struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->specific_context_field;
}

const struct bt_field *bt_event_borrow_specific_context_field_const(
		const struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->specific_context_field;
}

struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->payload_field;
}

const struct bt_field *bt_event_borrow_payload_field_const(
		const struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->payload_field;
}

static
void release_event_header_field(struct bt_field_wrapper *field_wrapper,
		struct bt_event *event)
{
	if (!event->class) {
		bt_field_wrapper_destroy(field_wrapper);
	} else {
		struct bt_stream_class *stream_class =
			bt_event_class_borrow_stream_class(event->class);

		BT_ASSERT(stream_class);
		recycle_event_header_field(field_wrapper, stream_class);
	}
}

BT_HIDDEN
void bt_event_destroy(struct bt_event *event)
{
	BT_ASSERT(event);
	BT_LIB_LOGD("Destroying event: %!+e", event);

	if (event->header_field) {
		BT_LOGD_STR("Releasing event's header field.");
		release_event_header_field(event->header_field, event);
		event->header_field = NULL;
	}

	if (event->common_context_field) {
		BT_LOGD_STR("Destroying event's stream event context field.");
		bt_field_destroy(event->common_context_field);
		event->common_context_field = NULL;
	}

	if (event->specific_context_field) {
		BT_LOGD_STR("Destroying event's context field.");
		bt_field_destroy(event->specific_context_field);
		event->specific_context_field = NULL;
	}

	if (event->payload_field) {
		BT_LOGD_STR("Destroying event's payload field.");
		bt_field_destroy(event->payload_field);
		event->payload_field = NULL;
	}

	BT_LOGD_STR("Putting event's class.");
	bt_object_put_ref(event->class);

	if (event->default_cs) {
		bt_clock_snapshot_recycle(event->default_cs);
		event->default_cs = NULL;
	}

	BT_LOGD_STR("Putting event's packet.");
	BT_OBJECT_PUT_REF_AND_RESET(event->packet);
	g_free(event);
}

void bt_event_set_default_clock_snapshot(struct bt_event *event,
		uint64_t value_cycles)
{
	struct bt_stream_class *sc;

	BT_ASSERT_PRE_NON_NULL(event, "Event");
	BT_ASSERT_PRE_EVENT_HOT(event);
	sc = bt_event_class_borrow_stream_class_inline(event->class);
	BT_ASSERT(sc);
	BT_ASSERT_PRE(sc->default_clock_class,
		"Event's stream class has no default clock class: "
		"%![ev-]+e, %![sc-]+S", event, sc);
	BT_ASSERT(event->default_cs);
	bt_clock_snapshot_set_value_inline(event->default_cs, value_cycles);
	BT_LIB_LOGV("Set event's default clock snapshot: %![event-]+e, "
		"value=%" PRIu64, event, value_cycles);
}

enum bt_clock_snapshot_status bt_event_borrow_default_clock_snapshot_const(
		const struct bt_event *event,
		const struct bt_clock_snapshot **clock_snapshot)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot (output)");
	*clock_snapshot = event->default_cs;
	return BT_CLOCK_SNAPSHOT_STATUS_KNOWN;
}

struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	return event->packet;
}

const struct bt_packet *bt_event_borrow_packet_const(
		const struct bt_event *event)
{
	return bt_event_borrow_packet((void *) event);
}

int bt_event_move_header_field(struct bt_event *event,
		struct bt_event_header_field *header_field)
{
	struct bt_stream_class *stream_class;
	struct bt_field_wrapper *field_wrapper = (void *) header_field;

	BT_ASSERT_PRE_NON_NULL(event, "Event");
	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
	BT_ASSERT_PRE_EVENT_HOT(event);
	stream_class = bt_event_class_borrow_stream_class_inline(event->class);
	BT_ASSERT_PRE(stream_class->event_header_fc,
		"Stream class has no event header field class: %!+S",
		stream_class);

	/* Recycle current header field: always exists */
	BT_ASSERT(event->header_field);
	recycle_event_header_field(event->header_field, stream_class);

	/* Move new field */
	event->header_field = field_wrapper;
	return 0;
}
Commit	Line	Data
273b65be	1	/*
0d902aea	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
de9dd397	3	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	4	*
	5	* Permission is hereby granted, free of charge, to any person obtaining a copy
	6	* of this software and associated documentation files (the "Software"), to deal
	7	* in the Software without restriction, including without limitation the rights
	8	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	9	* copies of the Software, and to permit persons to whom the Software is
	10	* furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	21	* SOFTWARE.
	22	*/
	23
7b010242 PP	24	#define BT_LOG_TAG "EVENT"
	25	#include <babeltrace/lib-logging-internal.h>
	26
d6b8c7f1	27	#include <babeltrace/assert-pre-internal.h>
a1002510 PP	28	#include <babeltrace/trace-ir/field-internal.h>
a1002510 PP	29	#include <babeltrace/trace-ir/field-class-internal.h>
061831e1	30	#include <babeltrace/trace-ir/clock-class.h>
abcb4caf PP	31	#include <babeltrace/trace-ir/clock-snapshot-const.h>
abcb4caf PP	32	#include <babeltrace/trace-ir/clock-snapshot-internal.h>
061831e1	33	#include <babeltrace/trace-ir/clock-class-internal.h>
33a7705d	34	#include <babeltrace/trace-ir/event-const.h>
061831e1 PP	35	#include <babeltrace/trace-ir/event-internal.h>
	36	#include <babeltrace/trace-ir/event-class.h>
	37	#include <babeltrace/trace-ir/event-class-internal.h>
	38	#include <babeltrace/trace-ir/stream-class.h>
33a7705d	39	#include <babeltrace/trace-ir/stream-class-const.h>
061831e1 PP	40	#include <babeltrace/trace-ir/stream-class-internal.h>
	41	#include <babeltrace/trace-ir/stream-internal.h>
	42	#include <babeltrace/trace-ir/packet.h>
	43	#include <babeltrace/trace-ir/packet-internal.h>
	44	#include <babeltrace/trace-ir/trace.h>
	45	#include <babeltrace/trace-ir/trace-internal.h>
	46	#include <babeltrace/trace-ir/packet-internal.h>
061831e1	47	#include <babeltrace/trace-ir/attributes-internal.h>
1d2f35fd	48	#include <babeltrace/assert-internal.h>
b313ef44	49	#include <babeltrace/compiler-internal.h>
7b010242	50	#include <inttypes.h>
273b65be	51
d6b8c7f1	52	BT_HIDDEN
33a7705d	53	void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
d6b8c7f1	54	{
d6b8c7f1	55	BT_ASSERT(event);
69dc9aaf PP	56	BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
69dc9aaf PP	57	event, is_frozen);
a7252d9c PP	58
a7252d9c PP	59	if (event->header_field) {
69dc9aaf PP	60	BT_LOGD_STR("Setting event's header field's frozen state.");
69dc9aaf PP	61	bt_field_set_is_frozen(
2259462c	62	event->header_field->field, is_frozen);
a7252d9c PP	63	}
a7252d9c PP	64
69dc9aaf PP	65	if (event->common_context_field) {
	66	BT_LOGD_STR("Setting event's common context field's frozen state.");
	67	bt_field_set_is_frozen(
	68	event->common_context_field, is_frozen);
a7252d9c PP	69	}
a7252d9c PP	70
69dc9aaf PP	71	if (event->specific_context_field) {
	72	BT_LOGD_STR("Setting event's specific context field's frozen state.");
	73	bt_field_set_is_frozen(event->specific_context_field,
2259462c	74	is_frozen);
a7252d9c PP	75	}
	76
	77	if (event->payload_field) {
69dc9aaf PP	78	BT_LOGD_STR("Setting event's payload field's frozen state.");
69dc9aaf PP	79	bt_field_set_is_frozen(event->payload_field,
2259462c	80	is_frozen);
a7252d9c PP	81	}
a7252d9c PP	82
33a7705d	83	((struct bt_event *) event)->frozen = is_frozen;
69dc9aaf	84	BT_LOGD_STR("Setting event's packet's frozen state.");
07df63fb	85	bt_packet_set_is_frozen(event->packet, is_frozen);
d6b8c7f1 PP	86	}
d6b8c7f1 PP	87
a7252d9c	88	static
69dc9aaf	89	void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
a7252d9c PP	90	struct bt_stream_class *stream_class)
	91	{
	92	BT_ASSERT(field_wrapper);
	93	BT_LIB_LOGD("Recycling event header field: "
	94	"addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
	95	stream_class, field_wrapper->field);
	96	bt_object_pool_recycle_object(
	97	&stream_class->event_header_field_pool,
	98	field_wrapper);
	99	}
	100
69dc9aaf	101	static inline
a7252d9c	102	struct bt_field_wrapper *create_event_header_field(
69dc9aaf	103	struct bt_stream_class *stream_class)
a7252d9c PP	104	{
	105	struct bt_field_wrapper *field_wrapper = NULL;
	106
	107	field_wrapper = bt_field_wrapper_create(
69dc9aaf	108	&stream_class->event_header_field_pool,
33a7705d	109	stream_class->event_header_fc);
a7252d9c PP	110	if (!field_wrapper) {
	111	goto error;
	112	}
	113
	114	goto end;
	115
	116	error:
	117	if (field_wrapper) {
69dc9aaf	118	recycle_event_header_field(field_wrapper, stream_class);
a7252d9c PP	119	field_wrapper = NULL;
	120	}
	121
	122	end:
	123	return field_wrapper;
	124	}
	125
	126	BT_HIDDEN
	127	struct bt_event bt_event_new(struct bt_event_class event_class)
d6b8c7f1	128	{
d6b8c7f1	129	struct bt_event *event = NULL;
a7252d9c	130	struct bt_stream_class *stream_class;
c6fb8c95	131	struct bt_field_class *fc;
d6b8c7f1	132
69dc9aaf	133	BT_ASSERT(event_class);
d6b8c7f1 PP	134	event = g_new0(struct bt_event, 1);
	135	if (!event) {
	136	BT_LOGE_STR("Failed to allocate one event.");
	137	goto error;
	138	}
	139
69dc9aaf	140	bt_object_init_unique(&event->base);
a7252d9c PP	141	stream_class = bt_event_class_borrow_stream_class(event_class);
a7252d9c PP	142	BT_ASSERT(stream_class);
69dc9aaf	143
33a7705d	144	if (stream_class->event_header_fc) {
69dc9aaf PP	145	event->header_field = create_event_header_field(stream_class);
	146	if (!event->header_field) {
	147	BT_LOGE_STR("Cannot create event header field.");
	148	goto error;
	149	}
	150	}
	151
33a7705d	152	fc = stream_class->event_common_context_fc;
c6fb8c95 PP	153	if (fc) {
c6fb8c95 PP	154	event->common_context_field = bt_field_create(fc);
69dc9aaf PP	155	if (!event->common_context_field) {
	156	/* bt_field_create() logs errors */
	157	goto error;
	158	}
	159	}
	160
33a7705d	161	fc = event_class->specific_context_fc;
c6fb8c95 PP	162	if (fc) {
c6fb8c95 PP	163	event->specific_context_field = bt_field_create(fc);
69dc9aaf PP	164	if (!event->specific_context_field) {
	165	/* bt_field_create() logs errors */
	166	goto error;
	167	}
	168	}
	169
33a7705d	170	fc = event_class->payload_fc;
c6fb8c95 PP	171	if (fc) {
c6fb8c95 PP	172	event->payload_field = bt_field_create(fc);
69dc9aaf PP	173	if (!event->payload_field) {
	174	/* bt_field_create() logs errors */
	175	goto error;
	176	}
	177	}
	178
	179	if (stream_class->default_clock_class) {
abcb4caf	180	event->default_cs = bt_clock_snapshot_create(
69dc9aaf	181	stream_class->default_clock_class);
abcb4caf PP	182	if (!event->default_cs) {
abcb4caf PP	183	/* bt_clock_snapshot_create() logs errors */
69dc9aaf PP	184	goto error;
69dc9aaf PP	185	}
a7252d9c PP	186	}
a7252d9c PP	187
d6b8c7f1 PP	188	goto end;
	189
	190	error:
a7252d9c PP	191	if (event) {
	192	bt_event_destroy(event);
	193	event = NULL;
	194	}
	195
	196	end:
	197	return event;
	198	}
	199
9a844f3c	200	struct bt_event_class bt_event_borrow_class(struct bt_event event)
2f100782	201	{
1d2f35fd	202	BT_ASSERT_PRE_NON_NULL(event, "Event");
07df63fb	203	return event->class;
2f100782 JG	204	}
2f100782 JG	205
33a7705d PP	206	const struct bt_event_class *bt_event_borrow_class_const(
	207	const struct bt_event *event)
	208	{
	209	return bt_event_borrow_class((void *) event);
	210	}
	211
1d2f35fd	212	struct bt_stream bt_event_borrow_stream(struct bt_event event)
1d2f35fd PP	213	{
1d2f35fd PP	214	BT_ASSERT_PRE_NON_NULL(event, "Event");
9a844f3c	215	return event->packet ? event->packet->stream : NULL;
1d2f35fd PP	216	}
1d2f35fd PP	217
33a7705d PP	218	const struct bt_stream *bt_event_borrow_stream_const(
	219	const struct bt_event *event)
	220	{
	221	return bt_event_borrow_stream((void *) event);
	222	}
	223
69dc9aaf	224	struct bt_field bt_event_borrow_header_field(struct bt_event event)
e5e6eb3a	225	{
07df63fb	226	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf	227	return event->header_field ? event->header_field->field : NULL;
e5e6eb3a JG	228	}
e5e6eb3a JG	229
33a7705d PP	230	const struct bt_field *bt_event_borrow_header_field_const(
33a7705d PP	231	const struct bt_event *event)
af5863fc	232	{
33a7705d PP	233	BT_ASSERT_PRE_NON_NULL(event, "Event");
33a7705d PP	234	return event->header_field ? event->header_field->field : NULL;
af5863fc PP	235	}
af5863fc PP	236
69dc9aaf	237	struct bt_field bt_event_borrow_common_context_field(struct bt_event event)
662e778c	238	{
07df63fb	239	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf	240	return event->common_context_field;
662e778c JG	241	}
662e778c JG	242
33a7705d PP	243	const struct bt_field *bt_event_borrow_common_context_field_const(
33a7705d PP	244	const struct bt_event *event)
af5863fc	245	{
33a7705d PP	246	BT_ASSERT_PRE_NON_NULL(event, "Event");
33a7705d PP	247	return event->common_context_field;
af5863fc PP	248	}
af5863fc PP	249
69dc9aaf	250	struct bt_field bt_event_borrow_specific_context_field(struct bt_event event)
f655a84d	251	{
07df63fb	252	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf	253	return event->specific_context_field;
f655a84d JG	254	}
f655a84d JG	255
33a7705d PP	256	const struct bt_field *bt_event_borrow_specific_context_field_const(
33a7705d PP	257	const struct bt_event *event)
af5863fc	258	{
33a7705d PP	259	BT_ASSERT_PRE_NON_NULL(event, "Event");
33a7705d PP	260	return event->specific_context_field;
af5863fc PP	261	}
af5863fc PP	262
69dc9aaf	263	struct bt_field bt_event_borrow_payload_field(struct bt_event event)
5fd2e9fd	264	{
07df63fb	265	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf	266	return event->payload_field;
5fd2e9fd PP	267	}
5fd2e9fd PP	268
33a7705d PP	269	const struct bt_field *bt_event_borrow_payload_field_const(
33a7705d PP	270	const struct bt_event *event)
af5863fc	271	{
33a7705d PP	272	BT_ASSERT_PRE_NON_NULL(event, "Event");
33a7705d PP	273	return event->payload_field;
af5863fc PP	274	}
af5863fc PP	275
a7252d9c PP	276	static
a7252d9c PP	277	void release_event_header_field(struct bt_field_wrapper *field_wrapper,
07df63fb	278	struct bt_event *event)
273b65be	279	{
69dc9aaf	280	if (!event->class) {
a7252d9c PP	281	bt_field_wrapper_destroy(field_wrapper);
	282	} else {
	283	struct bt_stream_class *stream_class =
69dc9aaf	284	bt_event_class_borrow_stream_class(event->class);
a7252d9c PP	285
a7252d9c PP	286	BT_ASSERT(stream_class);
69dc9aaf	287	recycle_event_header_field(field_wrapper, stream_class);
a7252d9c	288	}
273b65be JG	289	}
273b65be JG	290
69dc9aaf PP	291	BT_HIDDEN
69dc9aaf PP	292	void bt_event_destroy(struct bt_event *event)
07df63fb	293	{
69dc9aaf PP	294	BT_ASSERT(event);
69dc9aaf PP	295	BT_LIB_LOGD("Destroying event: %!+e", event);
07df63fb PP	296
	297	if (event->header_field) {
	298	BT_LOGD_STR("Releasing event's header field.");
69dc9aaf	299	release_event_header_field(event->header_field, event);
13106fc1	300	event->header_field = NULL;
07df63fb PP	301	}
07df63fb PP	302
69dc9aaf PP	303	if (event->common_context_field) {
	304	BT_LOGD_STR("Destroying event's stream event context field.");
	305	bt_field_destroy(event->common_context_field);
13106fc1	306	event->common_context_field = NULL;
07df63fb PP	307	}
07df63fb PP	308
69dc9aaf PP	309	if (event->specific_context_field) {
	310	BT_LOGD_STR("Destroying event's context field.");
	311	bt_field_destroy(event->specific_context_field);
13106fc1	312	event->specific_context_field = NULL;
07df63fb PP	313	}
	314
	315	if (event->payload_field) {
69dc9aaf PP	316	BT_LOGD_STR("Destroying event's payload field.");
69dc9aaf PP	317	bt_field_destroy(event->payload_field);
13106fc1	318	event->payload_field = NULL;
07df63fb PP	319	}
07df63fb PP	320
69dc9aaf	321	BT_LOGD_STR("Putting event's class.");
6f998913	322	bt_object_put_ref(event->class);
69dc9aaf	323
abcb4caf PP	324	if (event->default_cs) {
	325	bt_clock_snapshot_recycle(event->default_cs);
	326	event->default_cs = NULL;
07df63fb	327	}
07df63fb	328
03039f21	329	BT_LOGD_STR("Putting event's packet.");
13106fc1	330	BT_OBJECT_PUT_REF_AND_RESET(event->packet);
273b65be JG	331	g_free(event);
	332	}
	333
abcb4caf	334	void bt_event_set_default_clock_snapshot(struct bt_event *event,
33a7705d	335	uint64_t value_cycles)
fb8afeef	336	{
69dc9aaf PP	337	struct bt_stream_class *sc;
69dc9aaf PP	338
fb8afeef	339	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf PP	340	BT_ASSERT_PRE_EVENT_HOT(event);
	341	sc = bt_event_class_borrow_stream_class_inline(event->class);
	342	BT_ASSERT(sc);
	343	BT_ASSERT_PRE(sc->default_clock_class,
	344	"Event's stream class has no default clock class: "
	345	"%![ev-]+e, %![sc-]+S", event, sc);
abcb4caf PP	346	BT_ASSERT(event->default_cs);
	347	bt_clock_snapshot_set_value_inline(event->default_cs, value_cycles);
	348	BT_LIB_LOGV("Set event's default clock snapshot: %![event-]+e, "
69dc9aaf	349	"value=%" PRIu64, event, value_cycles);
fb8afeef PP	350	}
fb8afeef PP	351
abcb4caf	352	enum bt_clock_snapshot_status bt_event_borrow_default_clock_snapshot_const(
33a7705d	353	const struct bt_event *event,
abcb4caf	354	const struct bt_clock_snapshot **clock_snapshot)
78586d8a	355	{
1d2f35fd	356	BT_ASSERT_PRE_NON_NULL(event, "Event");
abcb4caf PP	357	BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot (output)");
	358	*clock_snapshot = event->default_cs;
	359	return BT_CLOCK_SNAPSHOT_STATUS_KNOWN;
1556a1af JG	360	}
1556a1af JG	361
9a844f3c	362	struct bt_packet bt_event_borrow_packet(struct bt_event event)
5c0f40f4	363	{
1d2f35fd	364	BT_ASSERT_PRE_NON_NULL(event, "Event");
69dc9aaf	365	return event->packet;
5c0f40f4 JG	366	}
5c0f40f4 JG	367
33a7705d PP	368	const struct bt_packet *bt_event_borrow_packet_const(
33a7705d PP	369	const struct bt_event *event)
af5863fc	370	{
33a7705d	371	return bt_event_borrow_packet((void *) event);
af5863fc PP	372	}
af5863fc PP	373
33a7705d PP	374	int bt_event_move_header_field(struct bt_event *event,
33a7705d PP	375	struct bt_event_header_field *header_field)
a7252d9c PP	376	{
a7252d9c PP	377	struct bt_stream_class *stream_class;
33a7705d	378	struct bt_field_wrapper field_wrapper = (void ) header_field;
a7252d9c PP	379
	380	BT_ASSERT_PRE_NON_NULL(event, "Event");
	381	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
69dc9aaf PP	382	BT_ASSERT_PRE_EVENT_HOT(event);
69dc9aaf PP	383	stream_class = bt_event_class_borrow_stream_class_inline(event->class);
c6fb8c95	384	BT_ASSERT_PRE(stream_class->event_header_fc,
85655180	385	"Stream class has no event header field class: %!+S",
a7252d9c PP	386	stream_class);
	387
	388	/* Recycle current header field: always exists */
07df63fb	389	BT_ASSERT(event->header_field);
69dc9aaf	390	recycle_event_header_field(event->header_field, stream_class);
a7252d9c PP	391
a7252d9c PP	392	/* Move new field */
69dc9aaf	393	event->header_field = field_wrapper;
a7252d9c PP	394	return 0;
a7252d9c PP	395	}