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

#ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
#define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H

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