lib: add discarded packets message
[babeltrace.git] / lib / graph / message / event.c
CommitLineData
d6e69534
PP
1/*
2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24#define BT_LOG_TAG "MSG-EVENT"
25#include <babeltrace/lib-logging-internal.h>
26
27#include <babeltrace/assert-internal.h>
28#include <babeltrace/assert-pre-internal.h>
29#include <babeltrace/compiler-internal.h>
30#include <babeltrace/object-internal.h>
31#include <babeltrace/trace-ir/event.h>
32#include <babeltrace/trace-ir/event-internal.h>
33#include <babeltrace/trace-ir/event-class-internal.h>
34#include <babeltrace/trace-ir/stream-class-internal.h>
35#include <babeltrace/trace-ir/trace.h>
36#include <babeltrace/graph/graph-internal.h>
37#include <babeltrace/graph/message-event-const.h>
38#include <babeltrace/graph/message-event.h>
39#include <babeltrace/graph/message-event-internal.h>
40#include <babeltrace/types.h>
41#include <stdbool.h>
42#include <inttypes.h>
43
44BT_ASSERT_PRE_FUNC
45static inline bool event_class_has_trace(struct bt_event_class *event_class)
46{
47 struct bt_stream_class *stream_class;
48
49 stream_class = bt_event_class_borrow_stream_class(event_class);
50 BT_ASSERT(stream_class);
51 return bt_stream_class_borrow_trace_class(stream_class) != NULL;
52}
53
54BT_HIDDEN
55struct bt_message *bt_message_event_new(
56 struct bt_graph *graph)
57{
58 struct bt_message_event *message = NULL;
59
60 message = g_new0(struct bt_message_event, 1);
61 if (!message) {
62 BT_LOGE_STR("Failed to allocate one event message.");
63 goto error;
64 }
65
66 bt_message_init(&message->parent, BT_MESSAGE_TYPE_EVENT,
67 (bt_object_release_func) bt_message_event_recycle, graph);
68 goto end;
69
70error:
71 BT_OBJECT_PUT_REF_AND_RESET(message);
72
73end:
74 return (void *) message;
75}
76
77struct bt_message *bt_message_event_create(
78 struct bt_self_message_iterator *self_msg_iter,
79 struct bt_event_class *event_class,
80 struct bt_packet *packet)
81{
82 struct bt_self_component_port_input_message_iterator *msg_iter =
83 (void *) self_msg_iter;
84 struct bt_message_event *message = NULL;
85 struct bt_event *event;
86
87 BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
88 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
89 BT_ASSERT_PRE_NON_NULL(packet, "Packet");
90 BT_ASSERT_PRE(event_class_has_trace(event_class),
91 "Event class is not part of a trace: %!+E", event_class);
92 BT_LIB_LOGD("Creating event message object: %![ec-]+E",
93 event_class);
94 event = bt_event_create(event_class, packet);
95 if (unlikely(!event)) {
96 BT_LIB_LOGE("Cannot create event from event class: "
97 "%![ec-]+E", event_class);
98 goto error;
99 }
100
101 /*
102 * Create message from pool _after_ we have everything
103 * (in this case, a valid event object) so that we never have an
104 * error condition with a non-NULL message object.
105 * Otherwise:
106 *
107 * * We cannot recycle the message on error because
108 * bt_message_event_recycle() expects a complete
109 * message (and the event or clock class priority map
110 * object could be unset).
111 *
112 * * We cannot destroy the message because we would need
113 * to notify the graph (pool owner) so that it removes the
114 * message from its message array.
115 */
116 message = (void *) bt_message_create_from_pool(
117 &msg_iter->graph->event_msg_pool, msg_iter->graph);
118 if (unlikely(!message)) {
119 /* bt_message_create_from_pool() logs errors */
120 goto error;
121 }
122
123 BT_ASSERT(!message->event);
124 message->event = event;
125 bt_packet_set_is_frozen(packet, true);
126 bt_event_class_freeze(event_class);
127 BT_LIB_LOGD("Created event message object: "
128 "%![msg-]+n, %![event-]+e", message, event);
129 goto end;
130
131error:
132 BT_ASSERT(!message);
133 bt_event_destroy(event);
134
135end:
136 return (void *) message;
137}
138
139BT_HIDDEN
140void bt_message_event_destroy(struct bt_message *msg)
141{
142 struct bt_message_event *event_msg = (void *) msg;
143
144 BT_LIB_LOGD("Destroying event message: %!+n", msg);
145
146 if (event_msg->event) {
147 BT_LIB_LOGD("Recycling event: %!+e", event_msg->event);
148 bt_event_recycle(event_msg->event);
149 event_msg->event = NULL;
150 }
151
152 g_free(msg);
153}
154
155BT_HIDDEN
156void bt_message_event_recycle(struct bt_message *msg)
157{
158 struct bt_message_event *event_msg = (void *) msg;
159 struct bt_graph *graph;
160
161 BT_ASSERT(event_msg);
162
163 if (unlikely(!msg->graph)) {
164 bt_message_event_destroy(msg);
165 return;
166 }
167
168 BT_LIB_LOGD("Recycling event message: %![msg-]+n, %![event-]+e",
169 msg, event_msg->event);
170 bt_message_reset(msg);
171 BT_ASSERT(event_msg->event);
172 bt_event_recycle(event_msg->event);
173 event_msg->event = NULL;
174 graph = msg->graph;
175 msg->graph = NULL;
176 bt_object_pool_recycle_object(&graph->event_msg_pool, msg);
177}
178
179static inline
180struct bt_event *borrow_event(struct bt_message *message)
181{
182 struct bt_message_event *event_message;
183
184 BT_ASSERT_PRE_NON_NULL(message, "Message");
185 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_EVENT);
186 event_message = container_of(message,
187 struct bt_message_event, parent);
188 return event_message->event;
189}
190
191struct bt_event *bt_message_event_borrow_event(
192 struct bt_message *message)
193{
194 return borrow_event(message);
195}
196
197const struct bt_event *bt_message_event_borrow_event_const(
198 const struct bt_message *message)
199{
200 return borrow_event((void *) message);
201}
This page took 0.030273 seconds and 4 git commands to generate.