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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 */

#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H
#define BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H

#include "common/assert.h"
#include "common/common.h"
#include <babeltrace2/trace-ir/stream-class.h>
#include "lib/object.h"
#include "lib/object-pool.h"
#include "common/macros.h"
#include <glib.h>
#include <inttypes.h>
#include <stdbool.h>

#include "field-class.h"
#include "utils.h"

struct bt_stream_class {
	struct bt_object base;

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

	struct {
		GString *str;

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

	uint64_t id;
	bool assigns_automatic_event_class_id;
	bool assigns_automatic_stream_id;
	bool supports_packets;
	bool packets_have_beginning_default_clock_snapshot;
	bool packets_have_end_default_clock_snapshot;
	bool supports_discarded_events;
	bool supports_discarded_packets;
	bool discarded_events_have_default_clock_snapshots;
	bool discarded_packets_have_default_clock_snapshots;
	struct bt_field_class *packet_context_fc;
	struct bt_field_class *event_common_context_fc;
	struct bt_clock_class *default_clock_class;

	/* Array of `struct bt_event_class *` */
	GPtrArray *event_classes;

	/* Pool of `struct bt_field_wrapper *` */
	struct bt_object_pool packet_context_field_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_stream_class_freeze(const struct bt_stream_class *stream_class);

#ifdef BT_DEV_MODE
# define bt_stream_class_freeze		_bt_stream_class_freeze
#else
# define bt_stream_class_freeze(_sc)
#endif

static inline
struct bt_trace_class *bt_stream_class_borrow_trace_class_inline(
		const struct bt_stream_class *stream_class)
{
	BT_ASSERT_DBG(stream_class);
	return (void *) bt_object_borrow_parent(&stream_class->base);
}

#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	5	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*/
	7
	8	#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H
	9	#define BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H
	10
	11	#include "common/assert.h"
	12	#include "common/common.h"
	13	#include <babeltrace2/trace-ir/stream-class.h>
	14	#include "lib/object.h"
	15	#include "lib/object-pool.h"
	16	#include "common/macros.h"
	17	#include <glib.h>
	18	#include <inttypes.h>
	19	#include <stdbool.h>
	20
	21	#include "field-class.h"
	22	#include "utils.h"
	23
	24	struct bt_stream_class {
	25	struct bt_object base;
	26
	27	/* Owned by this */
	28	struct bt_value *user_attributes;
	29
	30	struct {
	31	GString *str;
	32
	33	/* NULL or `str->str` above */
	34	const char *value;
	35	} name;
	36
	37	uint64_t id;
	38	bool assigns_automatic_event_class_id;
	39	bool assigns_automatic_stream_id;
	40	bool supports_packets;
	41	bool packets_have_beginning_default_clock_snapshot;
	42	bool packets_have_end_default_clock_snapshot;
	43	bool supports_discarded_events;
	44	bool supports_discarded_packets;
	45	bool discarded_events_have_default_clock_snapshots;
	46	bool discarded_packets_have_default_clock_snapshots;
	47	struct bt_field_class *packet_context_fc;
	48	struct bt_field_class *event_common_context_fc;
	49	struct bt_clock_class *default_clock_class;
	50
	51	/* Array of `struct bt_event_class ` /
	52	GPtrArray *event_classes;
	53
	54	/* Pool of `struct bt_field_wrapper ` /
	55	struct bt_object_pool packet_context_field_pool;
	56
	57	bool frozen;
	58	};
	59
	60	BT_HIDDEN
	61	void _bt_stream_class_freeze(const struct bt_stream_class *stream_class);
	62
	63	#ifdef BT_DEV_MODE
	64	# define bt_stream_class_freeze _bt_stream_class_freeze
	65	#else
	66	# define bt_stream_class_freeze(_sc)
	67	#endif
	68
	69	static inline
	70	struct bt_trace_class *bt_stream_class_borrow_trace_class_inline(
	71	const struct bt_stream_class *stream_class)
	72	{
	73	BT_ASSERT_DBG(stream_class);
	74	return (void *) bt_object_borrow_parent(&stream_class->base);
	75	}
	76
	77	#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_INTERNAL_H */