Rename: field type -> field class
[babeltrace.git] / lib / trace-ir / event.c
CommitLineData
273b65be
JG
1/*
2 * event.c
3 *
108b91d0 4 * Babeltrace trace IR - Event
273b65be 5 *
de9dd397 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be
JG
7 *
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
7b010242
PP
29#define BT_LOG_TAG "EVENT"
30#include <babeltrace/lib-logging-internal.h>
31
8deee039 32#include <babeltrace/assert-pre-internal.h>
108b91d0 33#include <babeltrace/trace-ir/fields-internal.h>
939190b3 34#include <babeltrace/trace-ir/field-classes-internal.h>
108b91d0
PP
35#include <babeltrace/trace-ir/clock-class.h>
36#include <babeltrace/trace-ir/clock-value.h>
37#include <babeltrace/trace-ir/clock-value-internal.h>
38#include <babeltrace/trace-ir/clock-class-internal.h>
39#include <babeltrace/trace-ir/event-internal.h>
40#include <babeltrace/trace-ir/event-class.h>
41#include <babeltrace/trace-ir/event-class-internal.h>
42#include <babeltrace/trace-ir/stream-class.h>
43#include <babeltrace/trace-ir/stream-class-internal.h>
44#include <babeltrace/trace-ir/stream-internal.h>
45#include <babeltrace/trace-ir/packet.h>
46#include <babeltrace/trace-ir/packet-internal.h>
47#include <babeltrace/trace-ir/trace.h>
48#include <babeltrace/trace-ir/trace-internal.h>
49#include <babeltrace/trace-ir/packet-internal.h>
83509119 50#include <babeltrace/ref.h>
108b91d0 51#include <babeltrace/trace-ir/attributes-internal.h>
3d9990ac 52#include <babeltrace/compiler-internal.h>
8b45963b 53#include <babeltrace/assert-internal.h>
7b010242 54#include <inttypes.h>
273b65be 55
8deee039 56BT_HIDDEN
7b33a0e0 57void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen)
8deee039 58{
8deee039 59 BT_ASSERT(event);
7b33a0e0
PP
60 BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
61 event, is_frozen);
a6918753
PP
62
63 if (event->header_field) {
7b33a0e0
PP
64 BT_LOGD_STR("Setting event's header field's frozen state.");
65 bt_field_set_is_frozen(
c5a24b0a 66 event->header_field->field, is_frozen);
a6918753
PP
67 }
68
7b33a0e0
PP
69 if (event->common_context_field) {
70 BT_LOGD_STR("Setting event's common context field's frozen state.");
71 bt_field_set_is_frozen(
72 event->common_context_field, is_frozen);
a6918753
PP
73 }
74
7b33a0e0
PP
75 if (event->specific_context_field) {
76 BT_LOGD_STR("Setting event's specific context field's frozen state.");
77 bt_field_set_is_frozen(event->specific_context_field,
c5a24b0a 78 is_frozen);
a6918753
PP
79 }
80
81 if (event->payload_field) {
7b33a0e0
PP
82 BT_LOGD_STR("Setting event's payload field's frozen state.");
83 bt_field_set_is_frozen(event->payload_field,
c5a24b0a 84 is_frozen);
a6918753
PP
85 }
86
c5a24b0a 87 event->frozen = is_frozen;
7b33a0e0 88 BT_LOGD_STR("Setting event's packet's frozen state.");
18acc6f8 89 bt_packet_set_is_frozen(event->packet, is_frozen);
8deee039
PP
90}
91
a6918753 92static
7b33a0e0 93void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
a6918753
PP
94 struct bt_stream_class *stream_class)
95{
96 BT_ASSERT(field_wrapper);
97 BT_LIB_LOGD("Recycling event header field: "
98 "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
99 stream_class, field_wrapper->field);
100 bt_object_pool_recycle_object(
101 &stream_class->event_header_field_pool,
102 field_wrapper);
103}
104
7b33a0e0 105static inline
a6918753 106struct bt_field_wrapper *create_event_header_field(
7b33a0e0 107 struct bt_stream_class *stream_class)
a6918753
PP
108{
109 struct bt_field_wrapper *field_wrapper = NULL;
110
111 field_wrapper = bt_field_wrapper_create(
7b33a0e0 112 &stream_class->event_header_field_pool,
939190b3 113 bt_stream_class_borrow_event_header_field_class(stream_class));
a6918753
PP
114 if (!field_wrapper) {
115 goto error;
116 }
117
118 goto end;
119
120error:
121 if (field_wrapper) {
7b33a0e0 122 recycle_event_header_field(field_wrapper, stream_class);
a6918753
PP
123 field_wrapper = NULL;
124 }
125
126end:
127 return field_wrapper;
128}
129
130BT_HIDDEN
131struct bt_event *bt_event_new(struct bt_event_class *event_class)
8deee039 132{
8deee039 133 struct bt_event *event = NULL;
a6918753 134 struct bt_stream_class *stream_class;
939190b3 135 struct bt_field_class *fc;
8deee039 136
7b33a0e0 137 BT_ASSERT(event_class);
8deee039
PP
138 event = g_new0(struct bt_event, 1);
139 if (!event) {
140 BT_LOGE_STR("Failed to allocate one event.");
141 goto error;
142 }
143
7b33a0e0 144 bt_object_init_unique(&event->base);
a6918753
PP
145 stream_class = bt_event_class_borrow_stream_class(event_class);
146 BT_ASSERT(stream_class);
7b33a0e0 147
939190b3 148 if (bt_stream_class_borrow_event_header_field_class(stream_class)) {
7b33a0e0
PP
149 event->header_field = create_event_header_field(stream_class);
150 if (!event->header_field) {
151 BT_LOGE_STR("Cannot create event header field.");
152 goto error;
153 }
154 }
155
939190b3 156 fc = bt_stream_class_borrow_event_common_context_field_class(
7b33a0e0 157 stream_class);
939190b3
PP
158 if (fc) {
159 event->common_context_field = bt_field_create(fc);
7b33a0e0
PP
160 if (!event->common_context_field) {
161 /* bt_field_create() logs errors */
162 goto error;
163 }
164 }
165
939190b3
PP
166 fc = bt_event_class_borrow_specific_context_field_class(event_class);
167 if (fc) {
168 event->specific_context_field = bt_field_create(fc);
7b33a0e0
PP
169 if (!event->specific_context_field) {
170 /* bt_field_create() logs errors */
171 goto error;
172 }
173 }
174
939190b3
PP
175 fc = bt_event_class_borrow_payload_field_class(event_class);
176 if (fc) {
177 event->payload_field = bt_field_create(fc);
7b33a0e0
PP
178 if (!event->payload_field) {
179 /* bt_field_create() logs errors */
180 goto error;
181 }
182 }
183
184 if (stream_class->default_clock_class) {
185 event->default_cv = bt_clock_value_create(
186 stream_class->default_clock_class);
187 if (!event->default_cv) {
188 /* bt_clock_value_create() logs errors */
189 goto error;
190 }
a6918753
PP
191 }
192
8deee039
PP
193 goto end;
194
195error:
a6918753
PP
196 if (event) {
197 bt_event_destroy(event);
198 event = NULL;
199 }
200
201end:
202 return event;
203}
204
5fe68922 205struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
2f100782 206{
8b45963b 207 BT_ASSERT_PRE_NON_NULL(event, "Event");
18acc6f8 208 return event->class;
2f100782
JG
209}
210
8b45963b 211struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
8b45963b
PP
212{
213 BT_ASSERT_PRE_NON_NULL(event, "Event");
5fe68922 214 return event->packet ? event->packet->stream : NULL;
8b45963b
PP
215}
216
7b33a0e0 217struct bt_field *bt_event_borrow_header_field(struct bt_event *event)
e5e6eb3a 218{
18acc6f8 219 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0 220 return event->header_field ? event->header_field->field : NULL;
e5e6eb3a
JG
221}
222
7b33a0e0 223struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
662e778c 224{
18acc6f8 225 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0 226 return event->common_context_field;
662e778c
JG
227}
228
7b33a0e0 229struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
f655a84d 230{
18acc6f8 231 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0 232 return event->specific_context_field;
f655a84d
JG
233}
234
7b33a0e0 235struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
5fd2e9fd 236{
18acc6f8 237 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0 238 return event->payload_field;
5fd2e9fd
PP
239}
240
a6918753
PP
241static
242void release_event_header_field(struct bt_field_wrapper *field_wrapper,
18acc6f8 243 struct bt_event *event)
273b65be 244{
7b33a0e0 245 if (!event->class) {
a6918753
PP
246 bt_field_wrapper_destroy(field_wrapper);
247 } else {
248 struct bt_stream_class *stream_class =
7b33a0e0 249 bt_event_class_borrow_stream_class(event->class);
a6918753
PP
250
251 BT_ASSERT(stream_class);
7b33a0e0 252 recycle_event_header_field(field_wrapper, stream_class);
a6918753 253 }
273b65be
JG
254}
255
7b33a0e0
PP
256BT_HIDDEN
257void bt_event_destroy(struct bt_event *event)
18acc6f8 258{
7b33a0e0
PP
259 BT_ASSERT(event);
260 BT_LIB_LOGD("Destroying event: %!+e", event);
18acc6f8
PP
261
262 if (event->header_field) {
263 BT_LOGD_STR("Releasing event's header field.");
7b33a0e0 264 release_event_header_field(event->header_field, event);
18acc6f8
PP
265 }
266
7b33a0e0
PP
267 if (event->common_context_field) {
268 BT_LOGD_STR("Destroying event's stream event context field.");
269 bt_field_destroy(event->common_context_field);
18acc6f8
PP
270 }
271
7b33a0e0
PP
272 if (event->specific_context_field) {
273 BT_LOGD_STR("Destroying event's context field.");
274 bt_field_destroy(event->specific_context_field);
18acc6f8
PP
275 }
276
277 if (event->payload_field) {
7b33a0e0
PP
278 BT_LOGD_STR("Destroying event's payload field.");
279 bt_field_destroy(event->payload_field);
18acc6f8
PP
280 }
281
7b33a0e0
PP
282 BT_LOGD_STR("Putting event's class.");
283 bt_put(event->class);
284
285 if (event->default_cv) {
286 bt_clock_value_recycle(event->default_cv);
18acc6f8 287 }
18acc6f8 288
03039f21 289 BT_LOGD_STR("Putting event's packet.");
5c3b707d 290 bt_put(event->packet);
273b65be
JG
291 g_free(event);
292}
293
7b33a0e0
PP
294int bt_event_set_default_clock_value(struct bt_event *event,
295 uint64_t value_cycles)
8fc063a2 296{
7b33a0e0
PP
297 struct bt_stream_class *sc;
298
8fc063a2 299 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0
PP
300 BT_ASSERT_PRE_EVENT_HOT(event);
301 sc = bt_event_class_borrow_stream_class_inline(event->class);
302 BT_ASSERT(sc);
303 BT_ASSERT_PRE(sc->default_clock_class,
304 "Event's stream class has no default clock class: "
305 "%![ev-]+e, %![sc-]+S", event, sc);
306 BT_ASSERT(event->default_cv);
307 bt_clock_value_set_value_inline(event->default_cv, value_cycles);
308 BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
309 "value=%" PRIu64, event, value_cycles);
310 return 0;
8fc063a2
PP
311}
312
7b33a0e0
PP
313enum bt_clock_value_status bt_event_borrow_default_clock_value(
314 struct bt_event *event, struct bt_clock_value **clock_value)
78586d8a 315{
8b45963b 316 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0
PP
317 BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
318 *clock_value = event->default_cv;
319 return BT_CLOCK_VALUE_STATUS_KNOWN;
1556a1af
JG
320}
321
5fe68922 322struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
5c0f40f4 323{
8b45963b 324 BT_ASSERT_PRE_NON_NULL(event, "Event");
7b33a0e0 325 return event->packet;
5c0f40f4
JG
326}
327
a6918753
PP
328int bt_event_move_header(struct bt_event *event,
329 struct bt_event_header_field *header_field)
330{
331 struct bt_stream_class *stream_class;
332 struct bt_field_wrapper *field_wrapper = (void *) header_field;
333
334 BT_ASSERT_PRE_NON_NULL(event, "Event");
335 BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
7b33a0e0
PP
336 BT_ASSERT_PRE_EVENT_HOT(event);
337 stream_class = bt_event_class_borrow_stream_class_inline(event->class);
939190b3
PP
338 BT_ASSERT_PRE(stream_class->event_header_fc,
339 "Stream class has no event header field classe: %!+S",
a6918753
PP
340 stream_class);
341
342 /* Recycle current header field: always exists */
18acc6f8 343 BT_ASSERT(event->header_field);
7b33a0e0 344 recycle_event_header_field(event->header_field, stream_class);
a6918753
PP
345
346 /* Move new field */
7b33a0e0 347 event->header_field = field_wrapper;
a6918753
PP
348 return 0;
349}
This page took 0.067618 seconds and 4 git commands to generate.