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

#ifndef BABELTRACE_TRACE_IR_TRACE_INTERNAL_H
#define BABELTRACE_TRACE_IR_TRACE_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 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/trace.h>
#include <babeltrace2/trace-ir/field-class.h>
#include <babeltrace2/trace-ir/field.h>
#include "lib/object.h"
#include "lib/object-pool.h"
#include "common/macros.h"
#include <babeltrace2/value.h>
#include <babeltrace2/types.h>
#include <glib.h>
#include <stdbool.h>
#include <sys/types.h>
#include "common/uuid.h"

#include "attributes.h"
#include "clock-class.h"
#include "stream-class.h"
#include "trace-class.h"

struct bt_trace {
	struct bt_object base;

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

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

	struct {
		GString *str;

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

	struct {
		bt_uuid_t uuid;

		/* NULL or `uuid` above */
		bt_uuid value;
	} uuid;

	struct bt_value *environment;

	/* Array of `struct bt_stream *` */
	GPtrArray *streams;

	/*
	 * Stream class (weak, owned by owned trace class) to number of
	 * instantiated streams, used to automatically assign stream IDs
	 * per stream class within this trace.
	 */
	GHashTable *stream_classes_stream_count;

	GArray *destruction_listeners;
	bool frozen;
};

BT_HIDDEN
void _bt_trace_freeze(const struct bt_trace *trace);

#ifdef BT_DEV_MODE
# define bt_trace_freeze		_bt_trace_freeze
#else
# define bt_trace_freeze(_trace)
#endif

BT_HIDDEN
void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream);

BT_HIDDEN
uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
		const struct bt_stream_class *stream_class);

#endif /* BABELTRACE_TRACE_IR_TRACE_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_TRACE_IR_TRACE_INTERNAL_H
	2	#define BABELTRACE_TRACE_IR_TRACE_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 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 "lib/assert-pre.h"
	28	#include <babeltrace2/trace-ir/trace.h>
	29	#include <babeltrace2/trace-ir/field-class.h>
	30	#include <babeltrace2/trace-ir/field.h>
	31	#include "lib/object.h"
	32	#include "lib/object-pool.h"
	33	#include "common/macros.h"
	34	#include <babeltrace2/value.h>
	35	#include <babeltrace2/types.h>
	36	#include <glib.h>
	37	#include <stdbool.h>
	38	#include <sys/types.h>
	39	#include "common/uuid.h"
	40
	41	#include "attributes.h"
	42	#include "clock-class.h"
	43	#include "stream-class.h"
	44	#include "trace-class.h"
	45
	46	struct bt_trace {
	47	struct bt_object base;
	48
	49	/* Owned by this */
	50	struct bt_value *user_attributes;
	51
	52	/* Owned by this */
	53	struct bt_trace_class *class;
	54
	55	struct {
	56	GString *str;
	57
	58	/* NULL or `str->str` above */
	59	const char *value;
	60	} name;
	61
	62	struct {
	63	bt_uuid_t uuid;
	64
	65	/* NULL or `uuid` above */
	66	bt_uuid value;
	67	} uuid;
	68
	69	struct bt_value *environment;
	70
	71	/* Array of `struct bt_stream ` /
	72	GPtrArray *streams;
	73
	74	/*
	75	* Stream class (weak, owned by owned trace class) to number of
	76	* instantiated streams, used to automatically assign stream IDs
	77	* per stream class within this trace.
	78	*/
	79	GHashTable *stream_classes_stream_count;
	80
	81	GArray *destruction_listeners;
	82	bool frozen;
	83	};
	84
	85	BT_HIDDEN
	86	void _bt_trace_freeze(const struct bt_trace *trace);
	87
	88	#ifdef BT_DEV_MODE
	89	# define bt_trace_freeze _bt_trace_freeze
	90	#else
	91	# define bt_trace_freeze(_trace)
	92	#endif
	93
	94	BT_HIDDEN
	95	void bt_trace_add_stream(struct bt_trace trace, struct bt_stream stream);
	96
	97	BT_HIDDEN
	98	uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
	99	const struct bt_stream_class *stream_class);
	100
	101	#endif /* BABELTRACE_TRACE_IR_TRACE_INTERNAL_H */