[babeltrace.git] / include / babeltrace2 / trace-ir / event-class-internal.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 <babeltrace2/assert-pre-internal.h>
#include <babeltrace2/trace-ir/field-class.h>
#include <babeltrace2/trace-ir/field.h>
#include <babeltrace2/babeltrace-internal.h>
#include <babeltrace2/value.h>
#include <babeltrace2/trace-ir/trace-internal.h>
#include <babeltrace2/trace-ir/stream-class.h>
#include <babeltrace2/trace-ir/stream.h>
#include <babeltrace2/trace-ir/event-class.h>
#include <babeltrace2/object-internal.h>
#include <babeltrace2/assert-internal.h>
#include <babeltrace2/object-pool-internal.h>
#include <babeltrace2/property-internal.h>
#include <glib.h>
#include <stdbool.h>

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

	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(event_class);
	return (void *) bt_object_borrow_parent(&event_class->base);
}

#endif /* BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H */
Commit	Line	Data
56e18c4c PP	1	#ifndef BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H
56e18c4c PP	2	#define BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H
272df73e PP	3
272df73e PP	4	/*
e2f7325d	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
3fadfbc0 MJ	27	#include <babeltrace2/assert-pre-internal.h>
	28	#include <babeltrace2/trace-ir/field-class.h>
	29	#include <babeltrace2/trace-ir/field.h>
	30	#include <babeltrace2/babeltrace-internal.h>
	31	#include <babeltrace2/value.h>
	32	#include <babeltrace2/trace-ir/trace-internal.h>
	33	#include <babeltrace2/trace-ir/stream-class.h>
	34	#include <babeltrace2/trace-ir/stream.h>
	35	#include <babeltrace2/trace-ir/event-class.h>
	36	#include <babeltrace2/object-internal.h>
	37	#include <babeltrace2/assert-internal.h>
	38	#include <babeltrace2/object-pool-internal.h>
	39	#include <babeltrace2/property-internal.h>
272df73e	40	#include <glib.h>
44c440bc	41	#include <stdbool.h>
272df73e	42
cb6f1f7d	43	struct bt_event_class {
272df73e	44	struct bt_object base;
5cd6d0e5 PP	45	struct bt_field_class *specific_context_fc;
5cd6d0e5 PP	46	struct bt_field_class *payload_fc;
272df73e	47
44c440bc PP	48	struct {
44c440bc PP	49	GString *str;
5990dd44	50
44c440bc PP	51	/* NULL or `str->str` above */
	52	const char *value;
	53	} name;
	54
	55	uint64_t id;
	56	struct bt_property_uint log_level;
	57
	58	struct {
	59	GString *str;
	60
	61	/* NULL or `str->str` above */
	62	const char *value;
	63	} emf_uri;
312c056a PP	64
	65	/* Pool of `struct bt_event ` /
	66	struct bt_object_pool event_pool;
44c440bc PP	67
44c440bc PP	68	bool frozen;
3dca2276 PP	69	};
3dca2276 PP	70
272df73e	71	BT_HIDDEN
40f4ba76	72	void _bt_event_class_freeze(const struct bt_event_class *event_class);
272df73e	73
44c440bc PP	74	#ifdef BT_DEV_MODE
	75	# define bt_event_class_freeze _bt_event_class_freeze
	76	#else
	77	# define bt_event_class_freeze(_ec)
	78	#endif
3dca2276	79
44c440bc PP	80	static inline
44c440bc PP	81	struct bt_stream_class *bt_event_class_borrow_stream_class_inline(
40f4ba76	82	const struct bt_event_class *event_class)
44c440bc PP	83	{
	84	BT_ASSERT(event_class);
	85	return (void *) bt_object_borrow_parent(&event_class->base);
	86	}
3dca2276	87
56e18c4c	88	#endif /* BABELTRACE_TRACE_IR_EVENT_CLASS_INTERNAL_H */