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

#ifndef BABELTRACE_TRACE_IR_STREAM_INTERNAL_H
#define BABELTRACE_TRACE_IR_STREAM_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/trace-ir/stream.h>
#include "lib/object.h"
#include "lib/object-pool.h"
#include "common/macros.h"
#include <glib.h>

#include "utils.h"

struct bt_stream_class;
struct bt_stream;

struct bt_stream {
	struct bt_object base;

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

	/* Owned by this */
	struct bt_stream_class *class;

	struct {
		GString *str;

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

	uint64_t id;

	/* Pool of `struct bt_packet *` */
	struct bt_object_pool packet_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_stream_freeze(const struct bt_stream *stream);

#ifdef BT_DEV_MODE
# define bt_stream_freeze		_bt_stream_freeze
#else
# define bt_stream_freeze(_stream)
#endif

static inline
struct bt_trace *bt_stream_borrow_trace_inline(const struct bt_stream *stream)
{
	BT_ASSERT_DBG(stream);
	return (void *) bt_object_borrow_parent(&stream->base);
}

#endif /* BABELTRACE_TRACE_IR_STREAM_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_TRACE_IR_STREAM_INTERNAL_H
	2	#define BABELTRACE_TRACE_IR_STREAM_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	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
	27	#include <babeltrace2/trace-ir/stream.h>
	28	#include "lib/object.h"
	29	#include "lib/object-pool.h"
	30	#include "common/macros.h"
	31	#include <glib.h>
	32
	33	#include "utils.h"
	34
	35	struct bt_stream_class;
	36	struct bt_stream;
	37
	38	struct bt_stream {
	39	struct bt_object base;
	40
	41	/* Owned by this */
	42	struct bt_value *user_attributes;
	43
	44	/* Owned by this */
	45	struct bt_stream_class *class;
	46
	47	struct {
	48	GString *str;
	49
	50	/* NULL or `str->str` above */
	51	const char *value;
	52	} name;
	53
	54	uint64_t id;
	55
	56	/* Pool of `struct bt_packet ` /
	57	struct bt_object_pool packet_pool;
	58
	59	bool frozen;
	60	};
	61
	62	BT_HIDDEN
	63	void _bt_stream_freeze(const struct bt_stream *stream);
	64
	65	#ifdef BT_DEV_MODE
	66	# define bt_stream_freeze _bt_stream_freeze
	67	#else
	68	# define bt_stream_freeze(_stream)
	69	#endif
	70
	71	static inline
	72	struct bt_trace bt_stream_borrow_trace_inline(const struct bt_stream stream)
	73	{
	74	BT_ASSERT_DBG(stream);
	75	return (void *) bt_object_borrow_parent(&stream->base);
	76	}
	77
	78	#endif /* BABELTRACE_TRACE_IR_STREAM_INTERNAL_H */