lib: rename "begin" to "beginning" when used as a noun
[babeltrace.git] / include / babeltrace / graph / notification-internal.h
... / ...
CommitLineData
1#ifndef BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
2#define BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H
3
4/*
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
28#include <babeltrace/babeltrace-internal.h>
29#include <babeltrace/object-internal.h>
30#include <babeltrace/assert-internal.h>
31#include <babeltrace/graph/graph.h>
32#include <babeltrace/graph/notification-const.h>
33#include <babeltrace/trace-ir/stream.h>
34#include <babeltrace/object-pool-internal.h>
35#include <babeltrace/types.h>
36
37typedef struct bt_stream *(*get_stream_func)(
38 struct bt_notification *notification);
39
40struct bt_notification {
41 struct bt_object base;
42 enum bt_notification_type type;
43 uint64_t seq_num;
44 bt_bool frozen;
45
46 /* Owned by this; keeps the graph alive while the notif. is alive */
47 struct bt_graph *graph;
48};
49
50#define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type) \
51 BT_ASSERT_PRE(((struct bt_notification *) (_notif))->type == (_type), \
52 "Notification has the wrong type: expected-type=%s, " \
53 "%![notif-]+n", bt_notification_type_string(_type), \
54 (_notif))
55
56BT_HIDDEN
57void bt_notification_init(struct bt_notification *notification,
58 enum bt_notification_type type,
59 bt_object_release_func release,
60 struct bt_graph *graph);
61
62static inline
63void 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
73static inline
74struct 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
79 if (unlikely(!notif)) {
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
87 if (likely(!notif->graph)) {
88 notif->graph = graph;
89 }
90
91 goto end;
92
93error:
94 BT_ASSERT(!notif);
95
96end:
97 return notif;
98}
99
100static inline void _bt_notification_freeze(struct bt_notification *notification)
101{
102 notification->frozen = BT_TRUE;
103}
104
105BT_HIDDEN
106void 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
114static inline
115const char *bt_notification_type_string(enum bt_notification_type type)
116{
117 switch (type) {
118 case BT_NOTIFICATION_TYPE_EVENT:
119 return "BT_NOTIFICATION_TYPE_EVENT";
120 case BT_NOTIFICATION_TYPE_INACTIVITY:
121 return "BT_NOTIFICATION_TYPE_INACTIVITY";
122 case BT_NOTIFICATION_TYPE_STREAM_BEGINNING:
123 return "BT_NOTIFICATION_TYPE_STREAM_BEGINNING";
124 case BT_NOTIFICATION_TYPE_STREAM_END:
125 return "BT_NOTIFICATION_TYPE_STREAM_END";
126 case BT_NOTIFICATION_TYPE_PACKET_BEGINNING:
127 return "BT_NOTIFICATION_TYPE_PACKET_BEGINNING";
128 case BT_NOTIFICATION_TYPE_PACKET_END:
129 return "BT_NOTIFICATION_TYPE_PACKET_END";
130 default:
131 return "(unknown)";
132 }
133}
134
135#endif /* BABELTRACE_GRAPH_NOTIFICATION_NOTIFICATION_INTERNAL_H */
This page took 0.023516 seconds and 4 git commands to generate.