Make API CTF-agnostic
[babeltrace.git] / include / babeltrace / graph / notification-internal.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
2#define BABELTRACE_GRAPH_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
62ed7c30 30#include <babeltrace/babeltrace-internal.h>
b8a06801 31#include <babeltrace/object-internal.h>
6c677fb5 32#include <babeltrace/assert-internal.h>
5c563278 33#include <babeltrace/graph/graph.h>
b2e0c907 34#include <babeltrace/graph/notification.h>
cc5236c9 35#include <babeltrace/ctf-ir/stream.h>
5c563278 36#include <babeltrace/object-pool-internal.h>
c55a9f58 37#include <babeltrace/types.h>
62ed7c30 38
50842bdc 39typedef struct bt_stream *(*get_stream_func)(
cc5236c9
JG
40 struct bt_notification *notification);
41
f7665a2e 42struct bt_notification {
b8a06801 43 struct bt_object base;
f7665a2e 44 enum bt_notification_type type;
f42867e2 45 uint64_t seq_num;
c55a9f58 46 bt_bool frozen;
5c563278
PP
47
48 /* Owned by this; keeps the graph alive while the notif. is alive */
49 struct bt_graph *graph;
62ed7c30
JG
50};
51
f6ccaed9
PP
52#define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type) \
53 BT_ASSERT_PRE((_notif)->type == (_type), \
54 "Notification has the wrong type: expected-type=%s, " \
55 "%![notif-]+n", bt_notification_type_string(_type), \
56 (_notif))
57
78586d8a
JG
58BT_HIDDEN
59void bt_notification_init(struct bt_notification *notification,
60 enum bt_notification_type type,
5c563278
PP
61 bt_object_release_func release,
62 struct bt_graph *graph);
63
64static inline
65void bt_notification_reset(struct bt_notification *notification)
66{
67 BT_ASSERT(notification);
68
69#ifdef BT_DEV_MODE
70 notification->frozen = BT_FALSE;
71 notification->seq_num = UINT64_C(-1);
72#endif
73}
74
75static inline
76struct bt_notification *bt_notification_create_from_pool(
77 struct bt_object_pool *pool, struct bt_graph *graph)
78{
79 struct bt_notification *notif = bt_object_pool_create_object(pool);
80
6c677fb5 81 if (unlikely(!notif)) {
5c563278
PP
82#ifdef BT_LIB_LOGE
83 BT_LIB_LOGE("Cannot allocate one notification from notification pool: "
84 "%![pool-]+o, %![graph-]+g", pool, graph);
85#endif
86 goto error;
87 }
88
6c677fb5 89 if (likely(!notif->graph)) {
5c563278
PP
90 notif->graph = graph;
91 }
92
93 goto end;
94
95error:
6c677fb5 96 BT_ASSERT(!notif);
78586d8a 97
5c563278
PP
98end:
99 return notif;
100}
101
102static inline void _bt_notification_freeze(struct bt_notification *notification)
e7fa96c3 103{
c55a9f58 104 notification->frozen = BT_TRUE;
e7fa96c3
PP
105}
106
5c563278
PP
107BT_HIDDEN
108void bt_notification_unlink_graph(struct bt_notification *notif);
109
110#ifdef BT_DEV_MODE
111# define bt_notification_freeze _bt_notification_freeze
112#else
113# define bt_notification_freeze(_x)
114#endif /* BT_DEV_MODE */
115
5af447e5
PP
116static inline
117const char *bt_notification_type_string(enum bt_notification_type type)
118{
119 switch (type) {
5af447e5
PP
120 case BT_NOTIFICATION_TYPE_UNKNOWN:
121 return "BT_NOTIFICATION_TYPE_UNKNOWN";
5af447e5
PP
122 case BT_NOTIFICATION_TYPE_EVENT:
123 return "BT_NOTIFICATION_TYPE_EVENT";
124 case BT_NOTIFICATION_TYPE_INACTIVITY:
125 return "BT_NOTIFICATION_TYPE_INACTIVITY";
126 case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
127 return "BT_NOTIFICATION_TYPE_STREAM_BEGIN";
128 case BT_NOTIFICATION_TYPE_STREAM_END:
129 return "BT_NOTIFICATION_TYPE_STREAM_END";
130 case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
131 return "BT_NOTIFICATION_TYPE_PACKET_BEGIN";
132 case BT_NOTIFICATION_TYPE_PACKET_END:
133 return "BT_NOTIFICATION_TYPE_PACKET_END";
134 default:
135 return "(unknown)";
136 }
62ed7c30 137}
62ed7c30 138
6ac74c0c 139#endif /* BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H */
This page took 0.051062 seconds and 4 git commands to generate.