[babeltrace.git] / include / babeltrace / graph / notification-internal.h

#ifndef BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
#define BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H

/*
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/graph/graph.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/trace-ir/stream.h>
#include <babeltrace/object-pool-internal.h>
#include <babeltrace/types.h>

typedef struct bt_stream *(*get_stream_func)(
		struct bt_notification *notification);

struct bt_notification {
	struct bt_object base;
	enum bt_notification_type type;
	uint64_t seq_num;
	bt_bool frozen;

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

#define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type)			\
	BT_ASSERT_PRE((_notif)->type == (_type),			\
		"Notification has the wrong type: expected-type=%s, "	\
		"%![notif-]+n", bt_notification_type_string(_type),	\
		(_notif))

BT_HIDDEN
void bt_notification_init(struct bt_notification *notification,
		enum bt_notification_type type,
		bt_object_release_func release,
		struct bt_graph *graph);

static inline
void bt_notification_reset(struct bt_notification *notification)
{
	BT_ASSERT(notification);

#ifdef BT_DEV_MODE
	notification->frozen = BT_FALSE;
	notification->seq_num = UINT64_C(-1);
#endif
}

static inline
struct bt_notification *bt_notification_create_from_pool(
		struct bt_object_pool *pool, struct bt_graph *graph)
{
	struct bt_notification *notif = bt_object_pool_create_object(pool);

	if (unlikely(!notif)) {
#ifdef BT_LIB_LOGE
		BT_LIB_LOGE("Cannot allocate one notification from notification pool: "
			"%![pool-]+o, %![graph-]+g", pool, graph);
#endif
		goto error;
	}

	if (likely(!notif->graph)) {
		notif->graph = graph;
	}

	goto end;

error:
	BT_ASSERT(!notif);

end:
	return notif;
}

static inline void _bt_notification_freeze(struct bt_notification *notification)
{
	notification->frozen = BT_TRUE;
}

BT_HIDDEN
void bt_notification_unlink_graph(struct bt_notification *notif);

#ifdef BT_DEV_MODE
# define bt_notification_freeze		_bt_notification_freeze
#else
# define bt_notification_freeze(_x)
#endif /* BT_DEV_MODE */

static inline
const char *bt_notification_type_string(enum bt_notification_type type)
{
	switch (type) {
	case BT_NOTIFICATION_TYPE_UNKNOWN:
		return "BT_NOTIFICATION_TYPE_UNKNOWN";
	case BT_NOTIFICATION_TYPE_EVENT:
		return "BT_NOTIFICATION_TYPE_EVENT";
	case BT_NOTIFICATION_TYPE_INACTIVITY:
		return "BT_NOTIFICATION_TYPE_INACTIVITY";
	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
		return "BT_NOTIFICATION_TYPE_STREAM_BEGIN";
	case BT_NOTIFICATION_TYPE_STREAM_END:
		return "BT_NOTIFICATION_TYPE_STREAM_END";
	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
		return "BT_NOTIFICATION_TYPE_PACKET_BEGIN";
	case BT_NOTIFICATION_TYPE_PACKET_END:
		return "BT_NOTIFICATION_TYPE_PACKET_END";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H */
Commit	Line	Data
6ac74c0c PP	1	#ifndef BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
6ac74c0c PP	2	#define BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
62ed7c30 JG	3
62ed7c30 JG	4	/*
62ed7c30 JG	5	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*
	7	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
62ed7c30	28	#include <babeltrace/babeltrace-internal.h>
b8a06801	29	#include <babeltrace/object-internal.h>
6c677fb5	30	#include <babeltrace/assert-internal.h>
5c563278	31	#include <babeltrace/graph/graph.h>
b2e0c907	32	#include <babeltrace/graph/notification.h>
56e18c4c	33	#include <babeltrace/trace-ir/stream.h>
5c563278	34	#include <babeltrace/object-pool-internal.h>
c55a9f58	35	#include <babeltrace/types.h>
62ed7c30	36
50842bdc	37	typedef struct bt_stream (get_stream_func)(
cc5236c9 JG	38	struct bt_notification *notification);
cc5236c9 JG	39
f7665a2e	40	struct bt_notification {
b8a06801	41	struct bt_object base;
f7665a2e	42	enum bt_notification_type type;
f42867e2	43	uint64_t seq_num;
c55a9f58	44	bt_bool frozen;
5c563278 PP	45
	46	/* Owned by this; keeps the graph alive while the notif. is alive */
	47	struct bt_graph *graph;
62ed7c30 JG	48	};
62ed7c30 JG	49
f6ccaed9 PP	50	#define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type) \
	51	BT_ASSERT_PRE((_notif)->type == (_type), \
	52	"Notification has the wrong type: expected-type=%s, " \
	53	"%![notif-]+n", bt_notification_type_string(_type), \
	54	(_notif))
	55
78586d8a JG	56	BT_HIDDEN
	57	void bt_notification_init(struct bt_notification *notification,
	58	enum bt_notification_type type,
5c563278 PP	59	bt_object_release_func release,
	60	struct bt_graph *graph);
	61
	62	static inline
	63	void bt_notification_reset(struct bt_notification *notification)
	64	{
	65	BT_ASSERT(notification);
	66
	67	#ifdef BT_DEV_MODE
	68	notification->frozen = BT_FALSE;
	69	notification->seq_num = UINT64_C(-1);
	70	#endif
	71	}
	72
	73	static inline
	74	struct bt_notification *bt_notification_create_from_pool(
	75	struct bt_object_pool pool, struct bt_graph graph)
	76	{
	77	struct bt_notification *notif = bt_object_pool_create_object(pool);
	78
6c677fb5	79	if (unlikely(!notif)) {
5c563278 PP	80	#ifdef BT_LIB_LOGE
	81	BT_LIB_LOGE("Cannot allocate one notification from notification pool: "
	82	"%![pool-]+o, %![graph-]+g", pool, graph);
	83	#endif
	84	goto error;
	85	}
	86
6c677fb5	87	if (likely(!notif->graph)) {
5c563278 PP	88	notif->graph = graph;
	89	}
	90
	91	goto end;
	92
	93	error:
6c677fb5	94	BT_ASSERT(!notif);
78586d8a	95
5c563278 PP	96	end:
	97	return notif;
	98	}
	99
	100	static inline void _bt_notification_freeze(struct bt_notification *notification)
e7fa96c3	101	{
c55a9f58	102	notification->frozen = BT_TRUE;
e7fa96c3 PP	103	}
e7fa96c3 PP	104
5c563278 PP	105	BT_HIDDEN
	106	void bt_notification_unlink_graph(struct bt_notification *notif);
	107
	108	#ifdef BT_DEV_MODE
	109	# define bt_notification_freeze _bt_notification_freeze
	110	#else
	111	# define bt_notification_freeze(_x)
	112	#endif /* BT_DEV_MODE */
	113
5af447e5 PP	114	static inline
	115	const char *bt_notification_type_string(enum bt_notification_type type)
	116	{
	117	switch (type) {
5af447e5 PP	118	case BT_NOTIFICATION_TYPE_UNKNOWN:
5af447e5 PP	119	return "BT_NOTIFICATION_TYPE_UNKNOWN";
5af447e5 PP	120	case BT_NOTIFICATION_TYPE_EVENT:
	121	return "BT_NOTIFICATION_TYPE_EVENT";
	122	case BT_NOTIFICATION_TYPE_INACTIVITY:
	123	return "BT_NOTIFICATION_TYPE_INACTIVITY";
	124	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
	125	return "BT_NOTIFICATION_TYPE_STREAM_BEGIN";
	126	case BT_NOTIFICATION_TYPE_STREAM_END:
	127	return "BT_NOTIFICATION_TYPE_STREAM_END";
	128	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	129	return "BT_NOTIFICATION_TYPE_PACKET_BEGIN";
	130	case BT_NOTIFICATION_TYPE_PACKET_END:
	131	return "BT_NOTIFICATION_TYPE_PACKET_END";
	132	default:
	133	return "(unknown)";
	134	}
62ed7c30	135	}
62ed7c30	136
6ac74c0c	137	#endif /* BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H */