[babeltrace.git] / src / lib / trace-ir / event-class.h

#ifndef BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H
#define BABELTRACE_TRACE_IR_EVENT_CLASS_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.
 */

#include "lib/assert-pre.h"
#include <babeltrace2/trace-ir/field-class.h>
#include <babeltrace2/trace-ir/field.h>
#include "common/macros.h"
#include <babeltrace2/value.h>
#include <babeltrace2/trace-ir/stream-class.h>
#include <babeltrace2/trace-ir/stream.h>
#include <babeltrace2/trace-ir/event-class.h>
#include "lib/object.h"
#include "common/assert.h"
#include "lib/object-pool.h"
#include "lib/property.h"
#include <glib.h>
#include <stdbool.h>

#include "trace.h"

struct bt_event_class {
	struct bt_object base;
	struct bt_field_class *specific_context_fc;
	struct bt_field_class *payload_fc;

	/* Owned by this */
	struct bt_value *user_attributes;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} name;

	uint64_t id;
	struct bt_property_uint log_level;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} emf_uri;

	/* Pool of `struct bt_event *` */
	struct bt_object_pool event_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_event_class_freeze(const struct bt_event_class *event_class);

#ifdef BT_DEV_MODE
# define bt_event_class_freeze		_bt_event_class_freeze
#else
# define bt_event_class_freeze(_ec)
#endif

static inline
struct bt_stream_class *bt_event_class_borrow_stream_class_inline(
		const struct bt_event_class *event_class)
{
	BT_ASSERT_DBG(event_class);
	return (void *) bt_object_borrow_parent(&event_class->base);
}

#endif /* BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H */
Commit	Line	Data
108b91d0 PP	1	#ifndef BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H
108b91d0 PP	2	#define BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H
272df73e PP	3
272df73e PP	4	/*
f2b0325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
272df73e PP	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
272df73e PP	7	*
272df73e PP	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
57952005	27	#include "lib/assert-pre.h"
71c5da58 MJ	28	#include <babeltrace2/trace-ir/field-class.h>
71c5da58 MJ	29	#include <babeltrace2/trace-ir/field.h>
85e7137b	30	#include "common/macros.h"
71c5da58	31	#include <babeltrace2/value.h>
71c5da58 MJ	32	#include <babeltrace2/trace-ir/stream-class.h>
	33	#include <babeltrace2/trace-ir/stream.h>
	34	#include <babeltrace2/trace-ir/event-class.h>
57952005 MJ	35	#include "lib/object.h"
	36	#include "common/assert.h"
	37	#include "lib/object-pool.h"
	38	#include "lib/property.h"
272df73e	39	#include <glib.h>
7b33a0e0	40	#include <stdbool.h>
272df73e	41
57952005 MJ	42	#include "trace.h"
57952005 MJ	43
18acc6f8	44	struct bt_event_class {
272df73e	45	struct bt_object base;
939190b3 PP	46	struct bt_field_class *specific_context_fc;
939190b3 PP	47	struct bt_field_class *payload_fc;
272df73e	48
af90138b PP	49	/* Owned by this */
	50	struct bt_value *user_attributes;
	51
7b33a0e0 PP	52	struct {
7b33a0e0 PP	53	GString *str;
5990dd44	54
7b33a0e0 PP	55	/* NULL or `str->str` above */
	56	const char *value;
	57	} name;
	58
	59	uint64_t id;
	60	struct bt_property_uint log_level;
	61
	62	struct {
	63	GString *str;
	64
	65	/* NULL or `str->str` above */
	66	const char *value;
	67	} emf_uri;
a6918753 PP	68
	69	/* Pool of `struct bt_event ` /
	70	struct bt_object_pool event_pool;
7b33a0e0 PP	71
7b33a0e0 PP	72	bool frozen;
8deee039 PP	73	};
8deee039 PP	74
272df73e	75	BT_HIDDEN
78cf9df6	76	void _bt_event_class_freeze(const struct bt_event_class *event_class);
272df73e	77
7b33a0e0 PP	78	#ifdef BT_DEV_MODE
	79	# define bt_event_class_freeze _bt_event_class_freeze
	80	#else
	81	# define bt_event_class_freeze(_ec)
	82	#endif
8deee039	83
7b33a0e0 PP	84	static inline
7b33a0e0 PP	85	struct bt_stream_class *bt_event_class_borrow_stream_class_inline(
78cf9df6	86	const struct bt_event_class *event_class)
7b33a0e0	87	{
ec4a3354	88	BT_ASSERT_DBG(event_class);
7b33a0e0 PP	89	return (void *) bt_object_borrow_parent(&event_class->base);
7b33a0e0 PP	90	}
8deee039	91
108b91d0	92	#endif /* BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H */