[babeltrace.git] / src / lib / graph / message / message.h

#ifndef BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
#define BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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.
 */

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BT_LIB_LOG_SUPPORTED
# error Please include "lib/logging.h" before including this file.
#endif

#include "common/macros.h"
#include "lib/object.h"
#include "common/assert.h"
#include <babeltrace2/graph/graph.h>
#include <babeltrace2/graph/message-const.h>
#include <babeltrace2/trace-ir/stream.h>
#include "lib/object-pool.h"
#include <babeltrace2/types.h>

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BT_LIB_LOG_SUPPORTED
# error Please include "lib/logging.h" before including this file.
#endif

typedef struct bt_stream *(*get_stream_func)(
		struct bt_message *message);

struct bt_message {
	struct bt_object base;
	enum bt_message_type type;
	bt_bool frozen;

	/* Owned by this; keeps the graph alive while the msg. is alive */
	struct bt_graph *graph;
};

#define BT_ASSERT_PRE_MSG_IS_TYPE(_msg, _type)			\
	BT_ASSERT_PRE(((struct bt_message *) (_msg))->type == (_type), \
		"Message has the wrong type: expected-type=%s, "	\
		"%![msg-]+n", bt_message_type_string(_type),	\
		(_msg))

BT_HIDDEN
void bt_message_init(struct bt_message *message,
		enum bt_message_type type,
		bt_object_release_func release,
		struct bt_graph *graph);

static inline
void bt_message_reset(struct bt_message *message)
{
	BT_ASSERT(message);

#ifdef BT_DEV_MODE
	message->frozen = BT_FALSE;
#endif
}

static inline
struct bt_message *bt_message_create_from_pool(
		struct bt_object_pool *pool, struct bt_graph *graph)
{
	struct bt_message *msg = bt_object_pool_create_object(pool);

	if (G_UNLIKELY(!msg)) {
		BT_LIB_LOGE_APPEND_CAUSE(
			"Cannot allocate one message from message pool: "
			"%![pool-]+o, %![graph-]+g", pool, graph);
		goto error;
	}

	if (G_LIKELY(!msg->graph)) {
		msg->graph = graph;
	}

	goto end;

error:
	BT_ASSERT(!msg);

end:
	return msg;
}

static inline void _bt_message_freeze(struct bt_message *message)
{
	message->frozen = BT_TRUE;
}

BT_HIDDEN
void bt_message_unlink_graph(struct bt_message *msg);

#ifdef BT_DEV_MODE
# define bt_message_freeze		_bt_message_freeze
#else
# define bt_message_freeze(_x)
#endif /* BT_DEV_MODE */

static inline
const char *bt_message_type_string(enum bt_message_type type)
{
	switch (type) {
	case BT_MESSAGE_TYPE_EVENT:
		return "BT_MESSAGE_TYPE_EVENT";
	case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
		return "BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY";
	case BT_MESSAGE_TYPE_STREAM_BEGINNING:
		return "BT_MESSAGE_TYPE_STREAM_BEGINNING";
	case BT_MESSAGE_TYPE_STREAM_END:
		return "BT_MESSAGE_TYPE_STREAM_END";
	case BT_MESSAGE_TYPE_PACKET_BEGINNING:
		return "BT_MESSAGE_TYPE_PACKET_BEGINNING";
	case BT_MESSAGE_TYPE_PACKET_END:
		return "BT_MESSAGE_TYPE_PACKET_END";
	case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
		return "BT_MESSAGE_TYPE_DISCARDED_EVENTS";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H */
Commit	Line	Data
d6e69534 PP	1	#ifndef BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
	2	#define BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2015 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
870631a2 PP	27	/* Protection: this file uses BT_LIB_LOG() macros directly /
	28	#ifndef BT_LIB_LOG_SUPPORTED
	29	# error Please include "lib/logging.h" before including this file.
	30	#endif
	31
91d81473	32	#include "common/macros.h"
578e048b MJ	33	#include "lib/object.h"
578e048b MJ	34	#include "common/assert.h"
3fadfbc0 MJ	35	#include <babeltrace2/graph/graph.h>
	36	#include <babeltrace2/graph/message-const.h>
	37	#include <babeltrace2/trace-ir/stream.h>
578e048b	38	#include "lib/object-pool.h"
3fadfbc0	39	#include <babeltrace2/types.h>
d6e69534	40
f137d351 PP	41	/* Protection: this file uses BT_LIB_LOG() macros directly /
	42	#ifndef BT_LIB_LOG_SUPPORTED
	43	# error Please include "lib/logging.h" before including this file.
	44	#endif
	45
d6e69534 PP	46	typedef struct bt_stream (get_stream_func)(
	47	struct bt_message *message);
	48
	49	struct bt_message {
	50	struct bt_object base;
	51	enum bt_message_type type;
d6e69534 PP	52	bt_bool frozen;
	53
	54	/* Owned by this; keeps the graph alive while the msg. is alive */
	55	struct bt_graph *graph;
	56	};
	57
	58	#define BT_ASSERT_PRE_MSG_IS_TYPE(_msg, _type) \
	59	BT_ASSERT_PRE(((struct bt_message *) (_msg))->type == (_type), \
	60	"Message has the wrong type: expected-type=%s, " \
	61	"%![msg-]+n", bt_message_type_string(_type), \
	62	(_msg))
	63
	64	BT_HIDDEN
	65	void bt_message_init(struct bt_message *message,
	66	enum bt_message_type type,
	67	bt_object_release_func release,
	68	struct bt_graph *graph);
	69
	70	static inline
	71	void bt_message_reset(struct bt_message *message)
	72	{
	73	BT_ASSERT(message);
	74
	75	#ifdef BT_DEV_MODE
	76	message->frozen = BT_FALSE;
d6e69534 PP	77	#endif
	78	}
	79
	80	static inline
	81	struct bt_message *bt_message_create_from_pool(
	82	struct bt_object_pool pool, struct bt_graph graph)
	83	{
	84	struct bt_message *msg = bt_object_pool_create_object(pool);
	85
91d81473	86	if (G_UNLIKELY(!msg)) {
870631a2 PP	87	BT_LIB_LOGE_APPEND_CAUSE(
870631a2 PP	88	"Cannot allocate one message from message pool: "
d6e69534	89	"%![pool-]+o, %![graph-]+g", pool, graph);
d6e69534 PP	90	goto error;
	91	}
	92
91d81473	93	if (G_LIKELY(!msg->graph)) {
d6e69534 PP	94	msg->graph = graph;
	95	}
	96
	97	goto end;
	98
	99	error:
	100	BT_ASSERT(!msg);
	101
	102	end:
	103	return msg;
	104	}
	105
	106	static inline void _bt_message_freeze(struct bt_message *message)
	107	{
	108	message->frozen = BT_TRUE;
	109	}
	110
	111	BT_HIDDEN
	112	void bt_message_unlink_graph(struct bt_message *msg);
	113
	114	#ifdef BT_DEV_MODE
	115	# define bt_message_freeze _bt_message_freeze
	116	#else
	117	# define bt_message_freeze(_x)
	118	#endif /* BT_DEV_MODE */
	119
	120	static inline
	121	const char *bt_message_type_string(enum bt_message_type type)
	122	{
	123	switch (type) {
	124	case BT_MESSAGE_TYPE_EVENT:
	125	return "BT_MESSAGE_TYPE_EVENT";
b9fd9cbb FD	126	case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
b9fd9cbb FD	127	return "BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY";
d6e69534 PP	128	case BT_MESSAGE_TYPE_STREAM_BEGINNING:
	129	return "BT_MESSAGE_TYPE_STREAM_BEGINNING";
	130	case BT_MESSAGE_TYPE_STREAM_END:
	131	return "BT_MESSAGE_TYPE_STREAM_END";
	132	case BT_MESSAGE_TYPE_PACKET_BEGINNING:
	133	return "BT_MESSAGE_TYPE_PACKET_BEGINNING";
	134	case BT_MESSAGE_TYPE_PACKET_END:
	135	return "BT_MESSAGE_TYPE_PACKET_END";
4c833281 PP	136	case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
4c833281 PP	137	return "BT_MESSAGE_TYPE_DISCARDED_EVENTS";
d6e69534 PP	138	default:
	139	return "(unknown)";
	140	}
	141	}
	142
	143	#endif /* BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H */