[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-value-const.h>
#include <babeltrace/trace-ir/clock-value-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/object.h>
#include <babeltrace/trace-ir/attributes-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/assert-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_cv = bt_clock_value_create(
			stream_class->default_clock_class);
		if (!event->default_cv) {
			/* bt_clock_value_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_cv) {
		bt_clock_value_recycle(event->default_cv);
		event->default_cv = 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_value(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_cv);
	bt_clock_value_set_value_inline(event->default_cv, value_cycles);
	BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
		"value=%" PRIu64, event, value_cycles);
}

enum bt_clock_value_status bt_event_borrow_default_clock_value_const(
		const struct bt_event *event,
		const struct bt_clock_value **clock_value)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
	*clock_value = event->default_cv;
	return BT_CLOCK_VALUE_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	/*
e2f7325d	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
3dca2276	27	#include <babeltrace/assert-pre-internal.h>
c6bd8523 PP	28	#include <babeltrace/trace-ir/field-internal.h>
c6bd8523 PP	29	#include <babeltrace/trace-ir/field-class-internal.h>
56e18c4c	30	#include <babeltrace/trace-ir/clock-class.h>
40f4ba76	31	#include <babeltrace/trace-ir/clock-value-const.h>
56e18c4c PP	32	#include <babeltrace/trace-ir/clock-value-internal.h>
56e18c4c PP	33	#include <babeltrace/trace-ir/clock-class-internal.h>
40f4ba76	34	#include <babeltrace/trace-ir/event-const.h>
56e18c4c 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>
40f4ba76	39	#include <babeltrace/trace-ir/stream-class-const.h>
56e18c4c 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>
65300d60	47	#include <babeltrace/object.h>
56e18c4c	48	#include <babeltrace/trace-ir/attributes-internal.h>
3d9990ac	49	#include <babeltrace/compiler-internal.h>
f6ccaed9	50	#include <babeltrace/assert-internal.h>
7b010242	51	#include <inttypes.h>
273b65be	52
3dca2276	53	BT_HIDDEN
40f4ba76	54	void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
3dca2276	55	{
3dca2276	56	BT_ASSERT(event);
44c440bc PP	57	BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
44c440bc PP	58	event, is_frozen);
312c056a PP	59
312c056a PP	60	if (event->header_field) {
44c440bc PP	61	BT_LOGD_STR("Setting event's header field's frozen state.");
44c440bc PP	62	bt_field_set_is_frozen(
6c677fb5	63	event->header_field->field, is_frozen);
312c056a PP	64	}
312c056a PP	65
44c440bc PP	66	if (event->common_context_field) {
	67	BT_LOGD_STR("Setting event's common context field's frozen state.");
	68	bt_field_set_is_frozen(
	69	event->common_context_field, is_frozen);
312c056a PP	70	}
312c056a PP	71
44c440bc PP	72	if (event->specific_context_field) {
	73	BT_LOGD_STR("Setting event's specific context field's frozen state.");
	74	bt_field_set_is_frozen(event->specific_context_field,
6c677fb5	75	is_frozen);
312c056a PP	76	}
	77
	78	if (event->payload_field) {
44c440bc PP	79	BT_LOGD_STR("Setting event's payload field's frozen state.");
44c440bc PP	80	bt_field_set_is_frozen(event->payload_field,
6c677fb5	81	is_frozen);
312c056a PP	82	}
312c056a PP	83
40f4ba76	84	((struct bt_event *) event)->frozen = is_frozen;
44c440bc	85	BT_LOGD_STR("Setting event's packet's frozen state.");
cb6f1f7d	86	bt_packet_set_is_frozen(event->packet, is_frozen);
3dca2276 PP	87	}
3dca2276 PP	88
312c056a	89	static
44c440bc	90	void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
312c056a PP	91	struct bt_stream_class *stream_class)
	92	{
	93	BT_ASSERT(field_wrapper);
	94	BT_LIB_LOGD("Recycling event header field: "
	95	"addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
	96	stream_class, field_wrapper->field);
	97	bt_object_pool_recycle_object(
	98	&stream_class->event_header_field_pool,
	99	field_wrapper);
	100	}
	101
44c440bc	102	static inline
312c056a	103	struct bt_field_wrapper *create_event_header_field(
44c440bc	104	struct bt_stream_class *stream_class)
312c056a PP	105	{
	106	struct bt_field_wrapper *field_wrapper = NULL;
	107
	108	field_wrapper = bt_field_wrapper_create(
44c440bc	109	&stream_class->event_header_field_pool,
40f4ba76	110	stream_class->event_header_fc);
312c056a PP	111	if (!field_wrapper) {
	112	goto error;
	113	}
	114
	115	goto end;
	116
	117	error:
	118	if (field_wrapper) {
44c440bc	119	recycle_event_header_field(field_wrapper, stream_class);
312c056a PP	120	field_wrapper = NULL;
	121	}
	122
	123	end:
	124	return field_wrapper;
	125	}
	126
	127	BT_HIDDEN
	128	struct bt_event bt_event_new(struct bt_event_class event_class)
3dca2276	129	{
3dca2276	130	struct bt_event *event = NULL;
312c056a	131	struct bt_stream_class *stream_class;
5cd6d0e5	132	struct bt_field_class *fc;
3dca2276	133
44c440bc	134	BT_ASSERT(event_class);
3dca2276 PP	135	event = g_new0(struct bt_event, 1);
	136	if (!event) {
	137	BT_LOGE_STR("Failed to allocate one event.");
	138	goto error;
	139	}
	140
44c440bc	141	bt_object_init_unique(&event->base);
312c056a PP	142	stream_class = bt_event_class_borrow_stream_class(event_class);
312c056a PP	143	BT_ASSERT(stream_class);
44c440bc	144
40f4ba76	145	if (stream_class->event_header_fc) {
44c440bc PP	146	event->header_field = create_event_header_field(stream_class);
	147	if (!event->header_field) {
	148	BT_LOGE_STR("Cannot create event header field.");
	149	goto error;
	150	}
	151	}
	152
40f4ba76	153	fc = stream_class->event_common_context_fc;
5cd6d0e5 PP	154	if (fc) {
5cd6d0e5 PP	155	event->common_context_field = bt_field_create(fc);
44c440bc PP	156	if (!event->common_context_field) {
	157	/* bt_field_create() logs errors */
	158	goto error;
	159	}
	160	}
	161
40f4ba76	162	fc = event_class->specific_context_fc;
5cd6d0e5 PP	163	if (fc) {
5cd6d0e5 PP	164	event->specific_context_field = bt_field_create(fc);
44c440bc PP	165	if (!event->specific_context_field) {
	166	/* bt_field_create() logs errors */
	167	goto error;
	168	}
	169	}
	170
40f4ba76	171	fc = event_class->payload_fc;
5cd6d0e5 PP	172	if (fc) {
5cd6d0e5 PP	173	event->payload_field = bt_field_create(fc);
44c440bc PP	174	if (!event->payload_field) {
	175	/* bt_field_create() logs errors */
	176	goto error;
	177	}
	178	}
	179
	180	if (stream_class->default_clock_class) {
	181	event->default_cv = bt_clock_value_create(
	182	stream_class->default_clock_class);
	183	if (!event->default_cv) {
	184	/* bt_clock_value_create() logs errors */
	185	goto error;
	186	}
312c056a PP	187	}
312c056a PP	188
3dca2276 PP	189	goto end;
	190
	191	error:
312c056a PP	192	if (event) {
	193	bt_event_destroy(event);
	194	event = NULL;
	195	}
	196
	197	end:
	198	return event;
	199	}
	200
094ff7c0	201	struct bt_event_class bt_event_borrow_class(struct bt_event event)
2f100782	202	{
f6ccaed9	203	BT_ASSERT_PRE_NON_NULL(event, "Event");
cb6f1f7d	204	return event->class;
2f100782 JG	205	}
2f100782 JG	206
40f4ba76 PP	207	const struct bt_event_class *bt_event_borrow_class_const(
	208	const struct bt_event *event)
	209	{
	210	return bt_event_borrow_class((void *) event);
	211	}
	212
f6ccaed9	213	struct bt_stream bt_event_borrow_stream(struct bt_event event)
f6ccaed9 PP	214	{
f6ccaed9 PP	215	BT_ASSERT_PRE_NON_NULL(event, "Event");
094ff7c0	216	return event->packet ? event->packet->stream : NULL;
f6ccaed9 PP	217	}
f6ccaed9 PP	218
40f4ba76 PP	219	const struct bt_stream *bt_event_borrow_stream_const(
	220	const struct bt_event *event)
	221	{
	222	return bt_event_borrow_stream((void *) event);
	223	}
	224
44c440bc	225	struct bt_field bt_event_borrow_header_field(struct bt_event event)
e5e6eb3a	226	{
cb6f1f7d	227	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc	228	return event->header_field ? event->header_field->field : NULL;
e5e6eb3a JG	229	}
e5e6eb3a JG	230
40f4ba76 PP	231	const struct bt_field *bt_event_borrow_header_field_const(
40f4ba76 PP	232	const struct bt_event *event)
e5be10ef	233	{
40f4ba76 PP	234	BT_ASSERT_PRE_NON_NULL(event, "Event");
40f4ba76 PP	235	return event->header_field ? event->header_field->field : NULL;
e5be10ef PP	236	}
e5be10ef PP	237
44c440bc	238	struct bt_field bt_event_borrow_common_context_field(struct bt_event event)
662e778c	239	{
cb6f1f7d	240	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc	241	return event->common_context_field;
662e778c JG	242	}
662e778c JG	243
40f4ba76 PP	244	const struct bt_field *bt_event_borrow_common_context_field_const(
40f4ba76 PP	245	const struct bt_event *event)
e5be10ef	246	{
40f4ba76 PP	247	BT_ASSERT_PRE_NON_NULL(event, "Event");
40f4ba76 PP	248	return event->common_context_field;
e5be10ef PP	249	}
e5be10ef PP	250
44c440bc	251	struct bt_field bt_event_borrow_specific_context_field(struct bt_event event)
f655a84d	252	{
cb6f1f7d	253	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc	254	return event->specific_context_field;
f655a84d JG	255	}
f655a84d JG	256
40f4ba76 PP	257	const struct bt_field *bt_event_borrow_specific_context_field_const(
40f4ba76 PP	258	const struct bt_event *event)
e5be10ef	259	{
40f4ba76 PP	260	BT_ASSERT_PRE_NON_NULL(event, "Event");
40f4ba76 PP	261	return event->specific_context_field;
e5be10ef PP	262	}
e5be10ef PP	263
44c440bc	264	struct bt_field bt_event_borrow_payload_field(struct bt_event event)
5fd2e9fd	265	{
cb6f1f7d	266	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc	267	return event->payload_field;
5fd2e9fd PP	268	}
5fd2e9fd PP	269
40f4ba76 PP	270	const struct bt_field *bt_event_borrow_payload_field_const(
40f4ba76 PP	271	const struct bt_event *event)
e5be10ef	272	{
40f4ba76 PP	273	BT_ASSERT_PRE_NON_NULL(event, "Event");
40f4ba76 PP	274	return event->payload_field;
e5be10ef PP	275	}
e5be10ef PP	276
312c056a PP	277	static
312c056a PP	278	void release_event_header_field(struct bt_field_wrapper *field_wrapper,
cb6f1f7d	279	struct bt_event *event)
273b65be	280	{
44c440bc	281	if (!event->class) {
312c056a PP	282	bt_field_wrapper_destroy(field_wrapper);
	283	} else {
	284	struct bt_stream_class *stream_class =
44c440bc	285	bt_event_class_borrow_stream_class(event->class);
312c056a PP	286
312c056a PP	287	BT_ASSERT(stream_class);
44c440bc	288	recycle_event_header_field(field_wrapper, stream_class);
312c056a	289	}
273b65be JG	290	}
273b65be JG	291
44c440bc PP	292	BT_HIDDEN
44c440bc PP	293	void bt_event_destroy(struct bt_event *event)
cb6f1f7d	294	{
44c440bc PP	295	BT_ASSERT(event);
44c440bc PP	296	BT_LIB_LOGD("Destroying event: %!+e", event);
cb6f1f7d PP	297
	298	if (event->header_field) {
	299	BT_LOGD_STR("Releasing event's header field.");
44c440bc	300	release_event_header_field(event->header_field, event);
238b7404	301	event->header_field = NULL;
cb6f1f7d PP	302	}
cb6f1f7d PP	303
44c440bc PP	304	if (event->common_context_field) {
	305	BT_LOGD_STR("Destroying event's stream event context field.");
	306	bt_field_destroy(event->common_context_field);
238b7404	307	event->common_context_field = NULL;
cb6f1f7d PP	308	}
cb6f1f7d PP	309
44c440bc PP	310	if (event->specific_context_field) {
	311	BT_LOGD_STR("Destroying event's context field.");
	312	bt_field_destroy(event->specific_context_field);
238b7404	313	event->specific_context_field = NULL;
cb6f1f7d PP	314	}
	315
	316	if (event->payload_field) {
44c440bc PP	317	BT_LOGD_STR("Destroying event's payload field.");
44c440bc PP	318	bt_field_destroy(event->payload_field);
238b7404	319	event->payload_field = NULL;
cb6f1f7d PP	320	}
cb6f1f7d PP	321
44c440bc	322	BT_LOGD_STR("Putting event's class.");
65300d60	323	bt_object_put_ref(event->class);
44c440bc PP	324
	325	if (event->default_cv) {
	326	bt_clock_value_recycle(event->default_cv);
238b7404	327	event->default_cv = NULL;
cb6f1f7d	328	}
cb6f1f7d	329
03039f21	330	BT_LOGD_STR("Putting event's packet.");
238b7404	331	BT_OBJECT_PUT_REF_AND_RESET(event->packet);
273b65be JG	332	g_free(event);
	333	}
	334
40f4ba76 PP	335	void bt_event_set_default_clock_value(struct bt_event *event,
40f4ba76 PP	336	uint64_t value_cycles)
e22b45d0	337	{
44c440bc PP	338	struct bt_stream_class *sc;
44c440bc PP	339
e22b45d0	340	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc PP	341	BT_ASSERT_PRE_EVENT_HOT(event);
	342	sc = bt_event_class_borrow_stream_class_inline(event->class);
	343	BT_ASSERT(sc);
	344	BT_ASSERT_PRE(sc->default_clock_class,
	345	"Event's stream class has no default clock class: "
	346	"%![ev-]+e, %![sc-]+S", event, sc);
	347	BT_ASSERT(event->default_cv);
	348	bt_clock_value_set_value_inline(event->default_cv, value_cycles);
	349	BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
	350	"value=%" PRIu64, event, value_cycles);
e22b45d0 PP	351	}
e22b45d0 PP	352
40f4ba76 PP	353	enum bt_clock_value_status bt_event_borrow_default_clock_value_const(
	354	const struct bt_event *event,
	355	const struct bt_clock_value **clock_value)
78586d8a	356	{
f6ccaed9	357	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc PP	358	BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
	359	*clock_value = event->default_cv;
	360	return BT_CLOCK_VALUE_STATUS_KNOWN;
1556a1af JG	361	}
1556a1af JG	362
094ff7c0	363	struct bt_packet bt_event_borrow_packet(struct bt_event event)
5c0f40f4	364	{
f6ccaed9	365	BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc	366	return event->packet;
5c0f40f4 JG	367	}
5c0f40f4 JG	368
40f4ba76 PP	369	const struct bt_packet *bt_event_borrow_packet_const(
40f4ba76 PP	370	const struct bt_event *event)
e5be10ef	371	{
40f4ba76	372	return bt_event_borrow_packet((void *) event);
e5be10ef PP	373	}
e5be10ef PP	374
40f4ba76 PP	375	int bt_event_move_header_field(struct bt_event *event,
40f4ba76 PP	376	struct bt_event_header_field *header_field)
312c056a PP	377	{
312c056a PP	378	struct bt_stream_class *stream_class;
40f4ba76	379	struct bt_field_wrapper field_wrapper = (void ) header_field;
312c056a PP	380
	381	BT_ASSERT_PRE_NON_NULL(event, "Event");
	382	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
44c440bc PP	383	BT_ASSERT_PRE_EVENT_HOT(event);
44c440bc PP	384	stream_class = bt_event_class_borrow_stream_class_inline(event->class);
5cd6d0e5	385	BT_ASSERT_PRE(stream_class->event_header_fc,
e6276565	386	"Stream class has no event header field class: %!+S",
312c056a PP	387	stream_class);
	388
	389	/* Recycle current header field: always exists */
cb6f1f7d	390	BT_ASSERT(event->header_field);
44c440bc	391	recycle_event_header_field(event->header_field, stream_class);
312c056a PP	392
312c056a PP	393	/* Move new field */
44c440bc	394	event->header_field = field_wrapper;
312c056a PP	395	return 0;
312c056a PP	396	}