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

#ifndef BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H
#define BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H

/*
 * BabelTrace - Plug-in Notification internal
 *
 * 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/ref-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/ctf-ir/stream.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;
	get_stream_func get_stream;
	uint64_t seq_num;
	bt_bool frozen;
};

#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);

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

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";
	case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
		return "BT_NOTIFICATION_TYPE_DISCARDED_EVENTS";
	case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
		return "BT_NOTIFICATION_TYPE_DISCARDED_PACKETS";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H
62ed7c30 JG	3
	4	/*
	5	* BabelTrace - Plug-in Notification internal
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
6cdbfd7a	30	#include <babeltrace/ref-internal.h>
62ed7c30	31	#include <babeltrace/babeltrace-internal.h>
b8a06801	32	#include <babeltrace/object-internal.h>
b2e0c907	33	#include <babeltrace/graph/notification.h>
cc5236c9	34	#include <babeltrace/ctf-ir/stream.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;
cc5236c9	43	get_stream_func get_stream;
f42867e2	44	uint64_t seq_num;
c55a9f58	45	bt_bool frozen;
62ed7c30 JG	46	};
62ed7c30 JG	47
f6ccaed9 PP	48	#define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type) \
	49	BT_ASSERT_PRE((_notif)->type == (_type), \
	50	"Notification has the wrong type: expected-type=%s, " \
	51	"%![notif-]+n", bt_notification_type_string(_type), \
	52	(_notif))
	53
78586d8a JG	54	BT_HIDDEN
	55	void bt_notification_init(struct bt_notification *notification,
	56	enum bt_notification_type type,
	57	bt_object_release_func release);
	58
e7fa96c3 PP	59	static inline void bt_notification_freeze(struct bt_notification *notification)
e7fa96c3 PP	60	{
c55a9f58	61	notification->frozen = BT_TRUE;
e7fa96c3 PP	62	}
e7fa96c3 PP	63
5af447e5 PP	64	static inline
	65	const char *bt_notification_type_string(enum bt_notification_type type)
	66	{
	67	switch (type) {
5af447e5 PP	68	case BT_NOTIFICATION_TYPE_UNKNOWN:
5af447e5 PP	69	return "BT_NOTIFICATION_TYPE_UNKNOWN";
5af447e5 PP	70	case BT_NOTIFICATION_TYPE_EVENT:
	71	return "BT_NOTIFICATION_TYPE_EVENT";
	72	case BT_NOTIFICATION_TYPE_INACTIVITY:
	73	return "BT_NOTIFICATION_TYPE_INACTIVITY";
	74	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
	75	return "BT_NOTIFICATION_TYPE_STREAM_BEGIN";
	76	case BT_NOTIFICATION_TYPE_STREAM_END:
	77	return "BT_NOTIFICATION_TYPE_STREAM_END";
	78	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	79	return "BT_NOTIFICATION_TYPE_PACKET_BEGIN";
	80	case BT_NOTIFICATION_TYPE_PACKET_END:
	81	return "BT_NOTIFICATION_TYPE_PACKET_END";
2ec84d26 PP	82	case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
	83	return "BT_NOTIFICATION_TYPE_DISCARDED_EVENTS";
	84	case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
	85	return "BT_NOTIFICATION_TYPE_DISCARDED_PACKETS";
5af447e5 PP	86	default:
	87	return "(unknown)";
	88	}
62ed7c30	89	}
62ed7c30	90
33b34c43	91	#endif /* BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H */