[babeltrace.git] / include / babeltrace / trace-ir / event-internal.h

#ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
#define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H

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

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
# error Please define include <babeltrace/lib-logging-internal.h> before including this file.
#endif

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/value.h>
#include <babeltrace/trace-ir/clock-value-internal.h>
#include <babeltrace/trace-ir/stream-class.h>
#include <babeltrace/trace-ir/stream.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/field.h>
#include <babeltrace/trace-ir/field-internal.h>
#include <babeltrace/trace-ir/event-class-internal.h>
#include <babeltrace/trace-ir/field-wrapper-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/assert-internal.h>
#include <glib.h>

#define BT_ASSERT_PRE_EVENT_HOT(_event) \
	BT_ASSERT_PRE_HOT(((const struct bt_event *) (_event)), 	\
		"Event", ": %!+e", (_event))

struct bt_event {
	struct bt_object base;

	/* Owned by this */
	struct bt_event_class *class;

	/* Owned by this */
	struct bt_packet *packet;

	struct bt_field_wrapper *header_field;
	struct bt_field *common_context_field;
	struct bt_field *specific_context_field;
	struct bt_field *payload_field;
	struct bt_clock_value *default_cv;
	bool frozen;
};

BT_HIDDEN
void bt_event_destroy(struct bt_event *event);

BT_HIDDEN
struct bt_event *bt_event_new(struct bt_event_class *event_class);

BT_HIDDEN
void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen);

#ifdef BT_DEV_MODE
# define bt_event_set_is_frozen		_bt_event_set_is_frozen
#else
# define bt_event_set_is_frozen(_event, _is_frozen)
#endif

BT_UNUSED
static inline
void _bt_event_reset_dev_mode(struct bt_event *event)
{
	BT_ASSERT(event);

	if (event->header_field) {
		bt_field_set_is_frozen(
			event->header_field->field, false);
		bt_field_reset(
			event->header_field->field);
	}

	if (event->common_context_field) {
		bt_field_set_is_frozen(
			event->common_context_field, false);
		bt_field_reset(
			event->common_context_field);
	}

	if (event->specific_context_field) {
		bt_field_set_is_frozen(
			event->specific_context_field, false);
		bt_field_reset(event->specific_context_field);
	}

	if (event->payload_field) {
		bt_field_set_is_frozen(
			event->payload_field, false);
		bt_field_reset(event->payload_field);
	}
}

#ifdef BT_DEV_MODE
# define bt_event_reset_dev_mode	_bt_event_reset_dev_mode
#else
# define bt_event_reset_dev_mode(_x)
#endif

static inline
void bt_event_reset(struct bt_event *event)
{
	BT_ASSERT(event);
	BT_LIB_LOGD("Resetting event: %!+e", event);
	bt_event_set_is_frozen(event, false);

	if (event->default_cv) {
		bt_clock_value_reset(event->default_cv);
	}

	bt_object_put_no_null_check(&event->packet->base);
	event->packet = NULL;
}

static inline
void bt_event_recycle(struct bt_event *event)
{
	struct bt_event_class *event_class;

	BT_ASSERT(event);
	BT_LIB_LOGD("Recycling event: %!+e", event);

	/*
	 * Those are the important ordered steps:
	 *
	 * 1. Reset the event object (put any permanent reference it
	 *    has, unfreeze it and its fields in developer mode, etc.),
	 *    but do NOT put its class's reference. This event class
	 *    contains the pool to which we're about to recycle this
	 *    event object, so we must guarantee its existence thanks
	 *    to this existing reference.
	 *
	 * 2. Move the event class reference to our `event_class`
	 *    variable so that we can set the event's class member
	 *    to NULL before recycling it. We CANNOT do this after
	 *    we put the event class reference because this bt_object_put_ref()
	 *    could destroy the event class, also destroying its
	 *    event pool, thus also destroying our event object (this
	 *    would result in an invalid write access).
	 *
	 * 3. Recycle the event object.
	 *
	 * 4. Put our event class reference.
	 */
	bt_event_reset(event);
	event_class = event->class;
	BT_ASSERT(event_class);
	event->class = NULL;
	bt_object_pool_recycle_object(&event_class->event_pool, event);
	bt_object_put_no_null_check(&event_class->base);
}

static inline
void bt_event_set_packet(struct bt_event *event, struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(event, "Event");
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	BT_ASSERT_PRE_EVENT_HOT(event);
	BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
		event->class) == packet->stream->class,
		"Packet's stream class and event's stream class differ: "
		"%![event-]+e, %![packet-]+a", event, packet);

	BT_ASSERT(!event->packet);
	event->packet = packet;
	bt_object_get_no_null_check_no_parent_check(&event->packet->base);
	BT_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a",
		event, packet);
}

static inline
struct bt_event *bt_event_create(struct bt_event_class *event_class,
		struct bt_packet *packet)
{
	struct bt_event *event = NULL;

	BT_ASSERT(event_class);
	event = bt_object_pool_create_object(&event_class->event_pool);
	if (unlikely(!event)) {
		BT_LIB_LOGE("Cannot allocate one event from event class's event pool: "
			"%![ec-]+E", event_class);
		goto end;
	}

	if (likely(!event->class)) {
		event->class = event_class;
		bt_object_get_no_null_check(&event_class->base);
	}

	BT_ASSERT(packet);
	bt_event_set_packet(event, packet);
	goto end;

end:
	return event;
}

#endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */
Commit	Line	Data
56e18c4c PP	1	#ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
56e18c4c PP	2	#define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
de9dd397	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be	7	*
273b65be JG	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
44c440bc PP	27	/* Protection: this file uses BT_LIB_LOG() macros directly /
	28	#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
	29	# error Please define include <babeltrace/lib-logging-internal.h> before including this file.
	30	#endif
	31
3dca2276	32	#include <babeltrace/assert-pre-internal.h>
273b65be	33	#include <babeltrace/babeltrace-internal.h>
c6bd8523	34	#include <babeltrace/value.h>
56e18c4c PP	35	#include <babeltrace/trace-ir/clock-value-internal.h>
	36	#include <babeltrace/trace-ir/stream-class.h>
	37	#include <babeltrace/trace-ir/stream.h>
	38	#include <babeltrace/trace-ir/stream-internal.h>
	39	#include <babeltrace/trace-ir/packet.h>
	40	#include <babeltrace/trace-ir/packet-internal.h>
c6bd8523 PP	41	#include <babeltrace/trace-ir/field.h>
c6bd8523 PP	42	#include <babeltrace/trace-ir/field-internal.h>
56e18c4c PP	43	#include <babeltrace/trace-ir/event-class-internal.h>
56e18c4c PP	44	#include <babeltrace/trace-ir/field-wrapper-internal.h>
83509119	45	#include <babeltrace/object-internal.h>
f6ccaed9	46	#include <babeltrace/assert-internal.h>
273b65be JG	47	#include <glib.h>
273b65be JG	48
44c440bc	49	#define BT_ASSERT_PRE_EVENT_HOT(_event) \
40f4ba76 PP	50	BT_ASSERT_PRE_HOT(((const struct bt_event *) (_event)), \
40f4ba76 PP	51	"Event", ": %!+e", (_event))
dc3fffef	52
cb6f1f7d	53	struct bt_event {
83509119	54	struct bt_object base;
862ca4ed PP	55
862ca4ed PP	56	/* Owned by this */
cb6f1f7d	57	struct bt_event_class *class;
862ca4ed PP	58
862ca4ed PP	59	/* Owned by this */
44c440bc	60	struct bt_packet *packet;
862ca4ed	61
312c056a	62	struct bt_field_wrapper *header_field;
44c440bc PP	63	struct bt_field *common_context_field;
44c440bc PP	64	struct bt_field *specific_context_field;
cb6f1f7d	65	struct bt_field *payload_field;
44c440bc PP	66	struct bt_clock_value *default_cv;
44c440bc PP	67	bool frozen;
273b65be JG	68	};
273b65be JG	69
273b65be	70	BT_HIDDEN
cb6f1f7d	71	void bt_event_destroy(struct bt_event *event);
273b65be	72
4ce9f9d0	73	BT_HIDDEN
cb6f1f7d	74	struct bt_event bt_event_new(struct bt_event_class event_class);
4ce9f9d0	75
f6ccaed9	76	BT_HIDDEN
40f4ba76	77	void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen);
f6ccaed9 PP	78
f6ccaed9 PP	79	#ifdef BT_DEV_MODE
6c677fb5	80	# define bt_event_set_is_frozen _bt_event_set_is_frozen
f6ccaed9	81	#else
6c677fb5	82	# define bt_event_set_is_frozen(_event, _is_frozen)
f6ccaed9 PP	83	#endif
f6ccaed9 PP	84
cb6f1f7d	85	BT_UNUSED
3dca2276	86	static inline
cb6f1f7d	87	void _bt_event_reset_dev_mode(struct bt_event *event)
3dca2276	88	{
cb6f1f7d	89	BT_ASSERT(event);
312c056a PP	90
312c056a PP	91	if (event->header_field) {
44c440bc	92	bt_field_set_is_frozen(
cb6f1f7d	93	event->header_field->field, false);
44c440bc	94	bt_field_reset(
cb6f1f7d	95	event->header_field->field);
312c056a PP	96	}
312c056a PP	97
44c440bc PP	98	if (event->common_context_field) {
	99	bt_field_set_is_frozen(
	100	event->common_context_field, false);
	101	bt_field_reset(
	102	event->common_context_field);
312c056a PP	103	}
312c056a PP	104
44c440bc PP	105	if (event->specific_context_field) {
	106	bt_field_set_is_frozen(
	107	event->specific_context_field, false);
	108	bt_field_reset(event->specific_context_field);
312c056a PP	109	}
	110
	111	if (event->payload_field) {
44c440bc	112	bt_field_set_is_frozen(
cb6f1f7d	113	event->payload_field, false);
44c440bc	114	bt_field_reset(event->payload_field);
6c677fb5	115	}
6c677fb5 PP	116	}
	117
	118	#ifdef BT_DEV_MODE
	119	# define bt_event_reset_dev_mode _bt_event_reset_dev_mode
	120	#else
	121	# define bt_event_reset_dev_mode(_x)
	122	#endif
312c056a	123
6c677fb5 PP	124	static inline
	125	void bt_event_reset(struct bt_event *event)
	126	{
	127	BT_ASSERT(event);
44c440bc	128	BT_LIB_LOGD("Resetting event: %!+e", event);
6c677fb5	129	bt_event_set_is_frozen(event, false);
44c440bc PP	130
	131	if (event->default_cv) {
	132	bt_clock_value_reset(event->default_cv);
	133	}
	134
6c677fb5 PP	135	bt_object_put_no_null_check(&event->packet->base);
	136	event->packet = NULL;
	137	}
	138
	139	static inline
	140	void bt_event_recycle(struct bt_event *event)
	141	{
	142	struct bt_event_class *event_class;
	143
	144	BT_ASSERT(event);
	145	BT_LIB_LOGD("Recycling event: %!+e", event);
	146
	147	/*
	148	* Those are the important ordered steps:
	149	*
	150	* 1. Reset the event object (put any permanent reference it
	151	* has, unfreeze it and its fields in developer mode, etc.),
	152	* but do NOT put its class's reference. This event class
	153	* contains the pool to which we're about to recycle this
	154	* event object, so we must guarantee its existence thanks
	155	* to this existing reference.
	156	*
	157	* 2. Move the event class reference to our `event_class`
	158	* variable so that we can set the event's class member
	159	* to NULL before recycling it. We CANNOT do this after
65300d60	160	* we put the event class reference because this bt_object_put_ref()
6c677fb5 PP	161	* could destroy the event class, also destroying its
	162	* event pool, thus also destroying our event object (this
	163	* would result in an invalid write access).
	164	*
	165	* 3. Recycle the event object.
	166	*
	167	* 4. Put our event class reference.
	168	*/
	169	bt_event_reset(event);
cb6f1f7d	170	event_class = event->class;
6c677fb5	171	BT_ASSERT(event_class);
cb6f1f7d	172	event->class = NULL;
6c677fb5	173	bt_object_pool_recycle_object(&event_class->event_pool, event);
cb6f1f7d	174	bt_object_put_no_null_check(&event_class->base);
6c677fb5 PP	175	}
	176
	177	static inline
	178	void bt_event_set_packet(struct bt_event event, struct bt_packet packet)
	179	{
	180	BT_ASSERT_PRE_NON_NULL(event, "Event");
	181	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
44c440bc	182	BT_ASSERT_PRE_EVENT_HOT(event);
26e21a82	183	BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
44c440bc	184	event->class) == packet->stream->class,
26e21a82	185	"Packet's stream class and event's stream class differ: "
44c440bc	186	"%![event-]+e, %![packet-]+a", event, packet);
26e21a82	187
6c677fb5 PP	188	BT_ASSERT(!event->packet);
	189	event->packet = packet;
	190	bt_object_get_no_null_check_no_parent_check(&event->packet->base);
44c440bc PP	191	BT_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a",
44c440bc PP	192	event, packet);
6c677fb5 PP	193	}
	194
	195	static inline
	196	struct bt_event bt_event_create(struct bt_event_class event_class,
	197	struct bt_packet *packet)
	198	{
	199	struct bt_event *event = NULL;
	200
	201	BT_ASSERT(event_class);
	202	event = bt_object_pool_create_object(&event_class->event_pool);
	203	if (unlikely(!event)) {
	204	BT_LIB_LOGE("Cannot allocate one event from event class's event pool: "
44c440bc	205	"%![ec-]+E", event_class);
6c677fb5 PP	206	goto end;
	207	}
	208
44c440bc	209	if (likely(!event->class)) {
cb6f1f7d PP	210	event->class = event_class;
cb6f1f7d PP	211	bt_object_get_no_null_check(&event_class->base);
6c677fb5 PP	212	}
	213
	214	BT_ASSERT(packet);
	215	bt_event_set_packet(event, packet);
	216	goto end;
	217
	218	end:
	219	return event;
	220	}
	221
56e18c4c	222	#endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */