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