[babeltrace.git] / src / ctf-writer / event.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#ifndef BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
#define BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H

#include <stdbool.h>

#include "common/assert.h"
#include "common/macros.h"
#include <babeltrace2-ctf-writer/field-types.h>
#include <babeltrace2-ctf-writer/fields.h>
#include <babeltrace2-ctf-writer/stream-class.h>
#include <babeltrace2-ctf-writer/stream.h>
#include "ctfser/ctfser.h"

#include "assert-pre.h"
#include "event-class.h"
#include "event.h"
#include "fields.h"
#include "field-wrapper.h"
#include "object.h"
#include "stream.h"
#include "validation.h"
#include "values.h"

struct bt_ctf_stream_class;
struct bt_ctf_stream_pos;
struct metadata_context;

struct bt_ctf_event_common {
	struct bt_ctf_object base;
	struct bt_ctf_event_class_common *class;
	struct bt_ctf_field_wrapper *header_field;
	struct bt_ctf_field_common *stream_event_context_field;
	struct bt_ctf_field_common *context_field;
	struct bt_ctf_field_common *payload_field;
	int frozen;
};

BT_HIDDEN
int _bt_ctf_event_common_validate(struct bt_ctf_event_common *event);

BT_HIDDEN
void _bt_ctf_event_common_set_is_frozen(struct bt_ctf_event_common *event,
		bool is_frozen);

#ifdef BT_DEV_MODE
# define bt_ctf_event_common_validate	_bt_ctf_event_common_validate
# define bt_ctf_event_common_set_is_frozen	_bt_ctf_event_common_set_is_frozen
#else
# define bt_ctf_event_common_validate(_event)			0
# define bt_ctf_event_common_set_is_frozen(_event, _is_frozen)
#endif

#define BT_CTF_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name)			\
	BT_CTF_ASSERT_PRE_HOT((_event), (_name), ": event-addr=%p", (_event))

static inline
struct bt_ctf_event_class_common *bt_ctf_event_common_borrow_class(
		struct bt_ctf_event_common *event)
{
	BT_ASSERT_DBG(event);
	return event->class;
}

typedef void *(*create_field_func_type)(void *);
typedef void (*release_field_func_type)(void *);
typedef void *(*create_header_field_func_type)(void *, void *);
typedef void (*release_header_field_func_type)(void *, void *);

BT_HIDDEN
int bt_ctf_event_common_initialize(struct bt_ctf_event_common *event,
		struct bt_ctf_event_class_common *event_class,
		struct bt_ctf_clock_class *init_expected_clock_class,
		bool is_shared_with_parent, bt_ctf_object_release_func release_func,
		bt_ctf_validation_flag_copy_field_type_func field_type_copy_func,
		bool must_be_in_trace,
		int (*map_clock_classes_func)(struct bt_ctf_stream_class_common *stream_class,
			struct bt_ctf_field_type_common *packet_context_field_type,
			struct bt_ctf_field_type_common *event_header_field_type),
		create_field_func_type create_field_func,
		release_field_func_type release_field_func,
		create_header_field_func_type create_header_field_func,
		release_header_field_func_type release_header_field_func);

BT_HIDDEN
int bt_ctf_event_common_set_payload(struct bt_ctf_event *event,
		struct bt_ctf_field *payload);

static inline
struct bt_ctf_field_common *bt_ctf_event_common_borrow_payload(
		struct bt_ctf_event_common *event)
{
	struct bt_ctf_field_common *payload = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");

	if (!event->payload_field) {
		BT_LOGT("Event has no current payload field: addr=%p, "
			"event-class-name=\"%s\", event-class-id=%" PRId64,
			event, bt_ctf_event_class_common_get_name(event->class),
			bt_ctf_event_class_common_get_id(event->class));
		goto end;
	}

	payload = event->payload_field;

end:
	return payload;
}

static inline
struct bt_ctf_field_common *bt_ctf_event_common_borrow_header(
		struct bt_ctf_event_common *event)
{
	struct bt_ctf_field_common *header = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");

	if (!event->header_field) {
		BT_LOGT("Event has no current header field: addr=%p, "
			"event-class-name=\"%s\", event-class-id=%" PRId64,
			event, bt_ctf_event_class_common_get_name(event->class),
			bt_ctf_event_class_common_get_id(event->class));
		goto end;
	}

	header = event->header_field->field;

end:
	return header;
}

static inline
struct bt_ctf_field_common *bt_ctf_event_common_borrow_context(
		struct bt_ctf_event_common *event)
{
	struct bt_ctf_field_common *context = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");

	if (!event->context_field) {
		BT_LOGT("Event has no current context field: addr=%p, "
			"event-class-name=\"%s\", event-class-id=%" PRId64,
			event, bt_ctf_event_class_common_get_name(event->class),
			bt_ctf_event_class_common_get_id(event->class));
		goto end;
	}

	context = event->context_field;

end:
	return context;
}

static inline
struct bt_ctf_field_common *bt_ctf_event_common_borrow_stream_event_context(
		struct bt_ctf_event_common *event)
{
	struct bt_ctf_field_common *stream_event_context = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");

	if (!event->stream_event_context_field) {
		BT_LOGT("Event has no current stream event context field: addr=%p, "
			"event-class-name=\"%s\", event-class-id=%" PRId64,
			event, bt_ctf_event_class_common_get_name(event->class),
			bt_ctf_event_class_common_get_id(event->class));
		goto end;
	}

	stream_event_context = event->stream_event_context_field;

end:
	return stream_event_context;
}

static inline
void bt_ctf_event_common_finalize(struct bt_ctf_object *obj,
		void (*field_release_func)(void *),
		void (*header_field_release_func)(void *, struct bt_ctf_event_common *))
{
	struct bt_ctf_event_common *event = (void *) obj;

	BT_LOGD("Destroying event: addr=%p, "
		"event-class-name=\"%s\", event-class-id=%" PRId64,
		event,
		event->class ? bt_ctf_event_class_common_get_name(event->class) : NULL,
		event->class ? bt_ctf_event_class_common_get_id(event->class) : INT64_C(-1));

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

	if (event->stream_event_context_field) {
		BT_LOGD_STR("Releasing event's stream event context field.");
		field_release_func(event->stream_event_context_field);
	}

	if (event->context_field) {
		BT_LOGD_STR("Releasing event's context field.");
		field_release_func(event->context_field);
	}

	if (event->payload_field) {
		BT_LOGD_STR("Releasing event's payload field.");
		field_release_func(event->payload_field);
	}

	/*
	 * Leave this after calling header_field_release_func() because
	 * this function receives the event object and could need its
	 * class to perform some cleanup.
	 */
	if (!event->base.parent) {
		/*
		 * Event was keeping a reference to its class since it shared no
		 * common ancestor with it to guarantee they would both have the
		 * same lifetime.
		 */
		bt_ctf_object_put_ref(event->class);
	}
}

struct bt_ctf_event {
	struct bt_ctf_event_common common;
};

struct bt_ctf_event_class {
	struct bt_ctf_event_class_common common;
};

BT_HIDDEN
int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
		struct metadata_context *context);

BT_HIDDEN
int bt_ctf_event_serialize(struct bt_ctf_event *event,
		struct bt_ctfser *pos,
		enum bt_ctf_byte_order native_byte_order);

static inline
struct bt_ctf_stream_class *bt_ctf_event_class_borrow_stream_class(
		struct bt_ctf_event_class *event_class)
{
	return BT_CTF_FROM_COMMON(bt_ctf_event_class_common_borrow_stream_class(
		BT_CTF_TO_COMMON(event_class)));
}

#endif /* BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H */
Commit	Line	Data
3dca2276	1	/*
0235b0db	2	* SPDX-License-Identifier: MIT
3dca2276	3	*
0235b0db	4	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3dca2276 PP	5	*
	6	* The Common Trace Format (CTF) Specification is available at
	7	* http://www.efficios.com/ctf
	8	*/
	9
0235b0db MJ	10	#ifndef BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
	11	#define BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
	12
c4f23e30 FD	13	#include <stdbool.h>
c4f23e30 FD	14
578e048b	15	#include "common/assert.h"
91d81473	16	#include "common/macros.h"
217cf9d3 PP	17	#include <babeltrace2-ctf-writer/field-types.h>
	18	#include <babeltrace2-ctf-writer/fields.h>
	19	#include <babeltrace2-ctf-writer/stream-class.h>
	20	#include <babeltrace2-ctf-writer/stream.h>
578e048b MJ	21	#include "ctfser/ctfser.h"
	22
	23	#include "assert-pre.h"
	24	#include "event-class.h"
	25	#include "event.h"
	26	#include "fields.h"
	27	#include "field-wrapper.h"
	28	#include "object.h"
	29	#include "stream.h"
	30	#include "validation.h"
	31	#include "values.h"
3dca2276 PP	32
	33	struct bt_ctf_stream_class;
	34	struct bt_ctf_stream_pos;
	35	struct metadata_context;
	36
16ca5ff0	37	struct bt_ctf_event_common {
e1e02a22	38	struct bt_ctf_object base;
16ca5ff0 PP	39	struct bt_ctf_event_class_common *class;
	40	struct bt_ctf_field_wrapper *header_field;
	41	struct bt_ctf_field_common *stream_event_context_field;
	42	struct bt_ctf_field_common *context_field;
	43	struct bt_ctf_field_common *payload_field;
	44	int frozen;
	45	};
	46
	47	BT_HIDDEN
	48	int _bt_ctf_event_common_validate(struct bt_ctf_event_common *event);
	49
	50	BT_HIDDEN
	51	void _bt_ctf_event_common_set_is_frozen(struct bt_ctf_event_common *event,
	52	bool is_frozen);
	53
	54	#ifdef BT_DEV_MODE
	55	# define bt_ctf_event_common_validate _bt_ctf_event_common_validate
	56	# define bt_ctf_event_common_set_is_frozen _bt_ctf_event_common_set_is_frozen
	57	#else
	58	# define bt_ctf_event_common_validate(_event) 0
	59	# define bt_ctf_event_common_set_is_frozen(_event, _is_frozen)
	60	#endif
	61
67d2ce02 MJ	62	#define BT_CTF_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name) \
67d2ce02 MJ	63	BT_CTF_ASSERT_PRE_HOT((_event), (_name), ": event-addr=%p", (_event))
16ca5ff0 PP	64
	65	static inline
	66	struct bt_ctf_event_class_common *bt_ctf_event_common_borrow_class(
	67	struct bt_ctf_event_common *event)
	68	{
98b15851	69	BT_ASSERT_DBG(event);
16ca5ff0 PP	70	return event->class;
	71	}
	72
51804836 SM	73	typedef void (create_field_func_type)(void *);
	74	typedef void (release_field_func_type)(void );
	75	typedef void (create_header_field_func_type)(void , void );
	76	typedef void (release_header_field_func_type)(void , void *);
16ca5ff0 PP	77
	78	BT_HIDDEN
	79	int bt_ctf_event_common_initialize(struct bt_ctf_event_common *event,
	80	struct bt_ctf_event_class_common *event_class,
	81	struct bt_ctf_clock_class *init_expected_clock_class,
e1e02a22	82	bool is_shared_with_parent, bt_ctf_object_release_func release_func,
16ca5ff0 PP	83	bt_ctf_validation_flag_copy_field_type_func field_type_copy_func,
	84	bool must_be_in_trace,
	85	int (map_clock_classes_func)(struct bt_ctf_stream_class_common stream_class,
	86	struct bt_ctf_field_type_common *packet_context_field_type,
	87	struct bt_ctf_field_type_common *event_header_field_type),
51804836 SM	88	create_field_func_type create_field_func,
	89	release_field_func_type release_field_func,
	90	create_header_field_func_type create_header_field_func,
	91	release_header_field_func_type release_header_field_func);
16ca5ff0	92
7c7301d5 SM	93	BT_HIDDEN
	94	int bt_ctf_event_common_set_payload(struct bt_ctf_event *event,
	95	struct bt_ctf_field *payload);
	96
16ca5ff0 PP	97	static inline
	98	struct bt_ctf_field_common *bt_ctf_event_common_borrow_payload(
	99	struct bt_ctf_event_common *event)
	100	{
	101	struct bt_ctf_field_common *payload = NULL;
	102
67d2ce02	103	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");
16ca5ff0 PP	104
16ca5ff0 PP	105	if (!event->payload_field) {
ef267d12	106	BT_LOGT("Event has no current payload field: addr=%p, "
16ca5ff0 PP	107	"event-class-name=\"%s\", event-class-id=%" PRId64,
	108	event, bt_ctf_event_class_common_get_name(event->class),
	109	bt_ctf_event_class_common_get_id(event->class));
	110	goto end;
	111	}
	112
	113	payload = event->payload_field;
	114
	115	end:
	116	return payload;
	117	}
	118
	119	static inline
	120	struct bt_ctf_field_common *bt_ctf_event_common_borrow_header(
	121	struct bt_ctf_event_common *event)
	122	{
	123	struct bt_ctf_field_common *header = NULL;
	124
67d2ce02	125	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");
16ca5ff0 PP	126
16ca5ff0 PP	127	if (!event->header_field) {
ef267d12	128	BT_LOGT("Event has no current header field: addr=%p, "
16ca5ff0 PP	129	"event-class-name=\"%s\", event-class-id=%" PRId64,
	130	event, bt_ctf_event_class_common_get_name(event->class),
	131	bt_ctf_event_class_common_get_id(event->class));
	132	goto end;
	133	}
	134
	135	header = event->header_field->field;
	136
	137	end:
	138	return header;
	139	}
	140
	141	static inline
	142	struct bt_ctf_field_common *bt_ctf_event_common_borrow_context(
	143	struct bt_ctf_event_common *event)
	144	{
	145	struct bt_ctf_field_common *context = NULL;
	146
67d2ce02	147	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");
16ca5ff0 PP	148
16ca5ff0 PP	149	if (!event->context_field) {
ef267d12	150	BT_LOGT("Event has no current context field: addr=%p, "
16ca5ff0 PP	151	"event-class-name=\"%s\", event-class-id=%" PRId64,
	152	event, bt_ctf_event_class_common_get_name(event->class),
	153	bt_ctf_event_class_common_get_id(event->class));
	154	goto end;
	155	}
	156
	157	context = event->context_field;
	158
	159	end:
	160	return context;
	161	}
	162
	163	static inline
	164	struct bt_ctf_field_common *bt_ctf_event_common_borrow_stream_event_context(
	165	struct bt_ctf_event_common *event)
	166	{
	167	struct bt_ctf_field_common *stream_event_context = NULL;
	168
67d2ce02	169	BT_CTF_ASSERT_PRE_NON_NULL(event, "Event");
16ca5ff0 PP	170
16ca5ff0 PP	171	if (!event->stream_event_context_field) {
ef267d12	172	BT_LOGT("Event has no current stream event context field: addr=%p, "
16ca5ff0 PP	173	"event-class-name=\"%s\", event-class-id=%" PRId64,
	174	event, bt_ctf_event_class_common_get_name(event->class),
	175	bt_ctf_event_class_common_get_id(event->class));
	176	goto end;
	177	}
	178
	179	stream_event_context = event->stream_event_context_field;
	180
	181	end:
	182	return stream_event_context;
	183	}
	184
	185	static inline
e1e02a22	186	void bt_ctf_event_common_finalize(struct bt_ctf_object *obj,
16ca5ff0 PP	187	void (field_release_func)(void ),
	188	void (header_field_release_func)(void , struct bt_ctf_event_common *))
	189	{
	190	struct bt_ctf_event_common event = (void ) obj;
	191
	192	BT_LOGD("Destroying event: addr=%p, "
	193	"event-class-name=\"%s\", event-class-id=%" PRId64,
	194	event,
	195	event->class ? bt_ctf_event_class_common_get_name(event->class) : NULL,
	196	event->class ? bt_ctf_event_class_common_get_id(event->class) : INT64_C(-1));
	197
	198	if (event->header_field) {
	199	BT_LOGD_STR("Releasing event's header field.");
	200	header_field_release_func(event->header_field, event);
	201	}
	202
	203	if (event->stream_event_context_field) {
	204	BT_LOGD_STR("Releasing event's stream event context field.");
	205	field_release_func(event->stream_event_context_field);
	206	}
	207
	208	if (event->context_field) {
	209	BT_LOGD_STR("Releasing event's context field.");
	210	field_release_func(event->context_field);
	211	}
	212
	213	if (event->payload_field) {
	214	BT_LOGD_STR("Releasing event's payload field.");
	215	field_release_func(event->payload_field);
	216	}
	217
	218	/*
	219	* Leave this after calling header_field_release_func() because
	220	* this function receives the event object and could need its
	221	* class to perform some cleanup.
	222	*/
	223	if (!event->base.parent) {
	224	/*
	225	* Event was keeping a reference to its class since it shared no
	226	* common ancestor with it to guarantee they would both have the
	227	* same lifetime.
	228	*/
e1e02a22	229	bt_ctf_object_put_ref(event->class);
16ca5ff0 PP	230	}
	231	}
	232
3dca2276	233	struct bt_ctf_event {
16ca5ff0	234	struct bt_ctf_event_common common;
3dca2276 PP	235	};
	236
	237	struct bt_ctf_event_class {
16ca5ff0	238	struct bt_ctf_event_class_common common;
3dca2276 PP	239	};
	240
	241	BT_HIDDEN
	242	int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
	243	struct metadata_context *context);
	244
	245	BT_HIDDEN
	246	int bt_ctf_event_serialize(struct bt_ctf_event *event,
013f35c6	247	struct bt_ctfser *pos,
3dca2276 PP	248	enum bt_ctf_byte_order native_byte_order);
	249
	250	static inline
	251	struct bt_ctf_stream_class *bt_ctf_event_class_borrow_stream_class(
	252	struct bt_ctf_event_class *event_class)
	253	{
16ca5ff0 PP	254	return BT_CTF_FROM_COMMON(bt_ctf_event_class_common_borrow_stream_class(
16ca5ff0 PP	255	BT_CTF_TO_COMMON(event_class)));
3dca2276 PP	256	}
	257
	258	#endif /* BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H */