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

#ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H
#define BABELTRACE_CTF_IR_EVENT_INTERNAL_H

/*
 * Babeltrace - CTF IR: Event internal
 *
 * 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.
 */

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-internal.h>
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/ctf-ir/packet-internal.h>
#include <babeltrace/ctf-ir/fields.h>
#include <babeltrace/ctf-ir/fields-internal.h>
#include <babeltrace/ctf-ir/event-class-internal.h>
#include <babeltrace/ctf-ir/clock-value-set-internal.h>
#include <babeltrace/ctf-ir/field-wrapper-internal.h>
#include <babeltrace/ctf-ir/validation-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/assert-internal.h>
#include <glib.h>

struct bt_stream_pos;

struct bt_event {
	struct bt_object base;
	struct bt_event_class *class;
	struct bt_field_wrapper *header_field;
	struct bt_field *stream_event_context_field;
	struct bt_field *context_field;
	struct bt_field *payload_field;
	struct bt_clock_value_set cv_set;
	struct bt_packet *packet;
	int 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(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

#define BT_ASSERT_PRE_EVENT_HOT(_event, _name)			\
	BT_ASSERT_PRE_HOT((_event), (_name), ": %!+e", (_event))

typedef void *(*create_field_func)(void *);
typedef void (*release_field_func)(void *);
typedef void *(*create_header_field_func)(void *, void *);
typedef void (*release_header_field_func)(void *, void *);

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_recursive(
			event->header_field->field, false);
		bt_field_reset_recursive(
			event->header_field->field);
	}

	if (event->stream_event_context_field) {
		bt_field_set_is_frozen_recursive(
			event->stream_event_context_field, false);
		bt_field_reset_recursive(
			event->stream_event_context_field);
	}

	if (event->context_field) {
		bt_field_set_is_frozen_recursive(
			event->context_field, false);
		bt_field_reset_recursive(event->context_field);
	}

	if (event->payload_field) {
		bt_field_set_is_frozen_recursive(
			event->payload_field, false);
		bt_field_reset_recursive(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_event_set_is_frozen(event, false);
	bt_clock_value_set_reset(&event->cv_set);
	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_put()
	 *    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, "Event");
	BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
		event->class) == packet->stream->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_LOGV("Set event's packet: event-addr=%p, "
		"event-class-name=\"%s\", event-class-id=%" PRId64 ", "
		"packet-addr=%p",
		event, bt_event_class_get_name(event->class),
		bt_event_class_get_id(event->class), 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: "
			"%![event-class-]+E", event_class);
		goto end;
	}

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