2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "EVENT"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/trace-ir/field-internal.h>
29 #include <babeltrace/trace-ir/field-class-internal.h>
30 #include <babeltrace/trace-ir/clock-class.h>
31 #include <babeltrace/trace-ir/clock-snapshot-const.h>
32 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
33 #include <babeltrace/trace-ir/clock-class-internal.h>
34 #include <babeltrace/trace-ir/event-const.h>
35 #include <babeltrace/trace-ir/event-internal.h>
36 #include <babeltrace/trace-ir/event-class.h>
37 #include <babeltrace/trace-ir/event-class-internal.h>
38 #include <babeltrace/trace-ir/stream-class.h>
39 #include <babeltrace/trace-ir/stream-class-const.h>
40 #include <babeltrace/trace-ir/stream-class-internal.h>
41 #include <babeltrace/trace-ir/stream-internal.h>
42 #include <babeltrace/trace-ir/packet.h>
43 #include <babeltrace/trace-ir/packet-internal.h>
44 #include <babeltrace/trace-ir/trace.h>
45 #include <babeltrace/trace-ir/trace-internal.h>
46 #include <babeltrace/trace-ir/packet-internal.h>
47 #include <babeltrace/trace-ir/attributes-internal.h>
48 #include <babeltrace/assert-internal.h>
49 #include <babeltrace/compiler-internal.h>
53 void _bt_event_set_is_frozen(const struct bt_event
*event
, bool is_frozen
)
56 BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
59 if (event
->header_field
) {
60 BT_LOGD_STR("Setting event's header field's frozen state.");
61 bt_field_set_is_frozen(
62 event
->header_field
->field
, is_frozen
);
65 if (event
->common_context_field
) {
66 BT_LOGD_STR("Setting event's common context field's frozen state.");
67 bt_field_set_is_frozen(
68 event
->common_context_field
, is_frozen
);
71 if (event
->specific_context_field
) {
72 BT_LOGD_STR("Setting event's specific context field's frozen state.");
73 bt_field_set_is_frozen(event
->specific_context_field
,
77 if (event
->payload_field
) {
78 BT_LOGD_STR("Setting event's payload field's frozen state.");
79 bt_field_set_is_frozen(event
->payload_field
,
83 ((struct bt_event
*) event
)->frozen
= is_frozen
;
84 BT_LOGD_STR("Setting event's packet's frozen state.");
85 bt_packet_set_is_frozen(event
->packet
, is_frozen
);
89 void recycle_event_header_field(struct bt_field_wrapper
*field_wrapper
,
90 struct bt_stream_class
*stream_class
)
92 BT_ASSERT(field_wrapper
);
93 BT_LIB_LOGD("Recycling event header field: "
94 "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper
,
95 stream_class
, field_wrapper
->field
);
96 bt_object_pool_recycle_object(
97 &stream_class
->event_header_field_pool
,
102 struct bt_field_wrapper
*create_event_header_field(
103 struct bt_stream_class
*stream_class
)
105 struct bt_field_wrapper
*field_wrapper
= NULL
;
107 field_wrapper
= bt_field_wrapper_create(
108 &stream_class
->event_header_field_pool
,
109 stream_class
->event_header_fc
);
110 if (!field_wrapper
) {
118 recycle_event_header_field(field_wrapper
, stream_class
);
119 field_wrapper
= NULL
;
123 return field_wrapper
;
127 struct bt_event
*bt_event_new(struct bt_event_class
*event_class
)
129 struct bt_event
*event
= NULL
;
130 struct bt_stream_class
*stream_class
;
131 struct bt_field_class
*fc
;
133 BT_ASSERT(event_class
);
134 event
= g_new0(struct bt_event
, 1);
136 BT_LOGE_STR("Failed to allocate one event.");
140 bt_object_init_unique(&event
->base
);
141 stream_class
= bt_event_class_borrow_stream_class(event_class
);
142 BT_ASSERT(stream_class
);
144 if (stream_class
->event_header_fc
) {
145 event
->header_field
= create_event_header_field(stream_class
);
146 if (!event
->header_field
) {
147 BT_LOGE_STR("Cannot create event header field.");
152 fc
= stream_class
->event_common_context_fc
;
154 event
->common_context_field
= bt_field_create(fc
);
155 if (!event
->common_context_field
) {
156 /* bt_field_create() logs errors */
161 fc
= event_class
->specific_context_fc
;
163 event
->specific_context_field
= bt_field_create(fc
);
164 if (!event
->specific_context_field
) {
165 /* bt_field_create() logs errors */
170 fc
= event_class
->payload_fc
;
172 event
->payload_field
= bt_field_create(fc
);
173 if (!event
->payload_field
) {
174 /* bt_field_create() logs errors */
179 if (stream_class
->default_clock_class
) {
180 event
->default_cs
= bt_clock_snapshot_create(
181 stream_class
->default_clock_class
);
182 if (!event
->default_cs
) {
183 /* bt_clock_snapshot_create() logs errors */
192 bt_event_destroy(event
);
200 struct bt_event_class
*bt_event_borrow_class(struct bt_event
*event
)
202 BT_ASSERT_PRE_NON_NULL(event
, "Event");
206 const struct bt_event_class
*bt_event_borrow_class_const(
207 const struct bt_event
*event
)
209 return bt_event_borrow_class((void *) event
);
212 struct bt_stream
*bt_event_borrow_stream(struct bt_event
*event
)
214 BT_ASSERT_PRE_NON_NULL(event
, "Event");
215 return event
->packet
? event
->packet
->stream
: NULL
;
218 const struct bt_stream
*bt_event_borrow_stream_const(
219 const struct bt_event
*event
)
221 return bt_event_borrow_stream((void *) event
);
224 struct bt_field
*bt_event_borrow_header_field(struct bt_event
*event
)
226 BT_ASSERT_PRE_NON_NULL(event
, "Event");
227 return event
->header_field
? event
->header_field
->field
: NULL
;
230 const struct bt_field
*bt_event_borrow_header_field_const(
231 const struct bt_event
*event
)
233 BT_ASSERT_PRE_NON_NULL(event
, "Event");
234 return event
->header_field
? event
->header_field
->field
: NULL
;
237 struct bt_field
*bt_event_borrow_common_context_field(struct bt_event
*event
)
239 BT_ASSERT_PRE_NON_NULL(event
, "Event");
240 return event
->common_context_field
;
243 const struct bt_field
*bt_event_borrow_common_context_field_const(
244 const struct bt_event
*event
)
246 BT_ASSERT_PRE_NON_NULL(event
, "Event");
247 return event
->common_context_field
;
250 struct bt_field
*bt_event_borrow_specific_context_field(struct bt_event
*event
)
252 BT_ASSERT_PRE_NON_NULL(event
, "Event");
253 return event
->specific_context_field
;
256 const struct bt_field
*bt_event_borrow_specific_context_field_const(
257 const struct bt_event
*event
)
259 BT_ASSERT_PRE_NON_NULL(event
, "Event");
260 return event
->specific_context_field
;
263 struct bt_field
*bt_event_borrow_payload_field(struct bt_event
*event
)
265 BT_ASSERT_PRE_NON_NULL(event
, "Event");
266 return event
->payload_field
;
269 const struct bt_field
*bt_event_borrow_payload_field_const(
270 const struct bt_event
*event
)
272 BT_ASSERT_PRE_NON_NULL(event
, "Event");
273 return event
->payload_field
;
277 void release_event_header_field(struct bt_field_wrapper
*field_wrapper
,
278 struct bt_event
*event
)
281 bt_field_wrapper_destroy(field_wrapper
);
283 struct bt_stream_class
*stream_class
=
284 bt_event_class_borrow_stream_class(event
->class);
286 BT_ASSERT(stream_class
);
287 recycle_event_header_field(field_wrapper
, stream_class
);
292 void bt_event_destroy(struct bt_event
*event
)
295 BT_LIB_LOGD("Destroying event: %!+e", event
);
297 if (event
->header_field
) {
298 BT_LOGD_STR("Releasing event's header field.");
299 release_event_header_field(event
->header_field
, event
);
300 event
->header_field
= NULL
;
303 if (event
->common_context_field
) {
304 BT_LOGD_STR("Destroying event's stream event context field.");
305 bt_field_destroy(event
->common_context_field
);
306 event
->common_context_field
= NULL
;
309 if (event
->specific_context_field
) {
310 BT_LOGD_STR("Destroying event's context field.");
311 bt_field_destroy(event
->specific_context_field
);
312 event
->specific_context_field
= NULL
;
315 if (event
->payload_field
) {
316 BT_LOGD_STR("Destroying event's payload field.");
317 bt_field_destroy(event
->payload_field
);
318 event
->payload_field
= NULL
;
321 BT_LOGD_STR("Putting event's class.");
322 bt_object_put_ref(event
->class);
324 if (event
->default_cs
) {
325 bt_clock_snapshot_recycle(event
->default_cs
);
326 event
->default_cs
= NULL
;
329 BT_LOGD_STR("Putting event's packet.");
330 BT_OBJECT_PUT_REF_AND_RESET(event
->packet
);
334 void bt_event_set_default_clock_snapshot(struct bt_event
*event
,
335 uint64_t value_cycles
)
337 struct bt_stream_class
*sc
;
339 BT_ASSERT_PRE_NON_NULL(event
, "Event");
340 BT_ASSERT_PRE_EVENT_HOT(event
);
341 sc
= bt_event_class_borrow_stream_class_inline(event
->class);
343 BT_ASSERT_PRE(sc
->default_clock_class
,
344 "Event's stream class has no default clock class: "
345 "%![ev-]+e, %![sc-]+S", event
, sc
);
346 BT_ASSERT(event
->default_cs
);
347 bt_clock_snapshot_set_value_inline(event
->default_cs
, value_cycles
);
348 BT_LIB_LOGV("Set event's default clock snapshot: %![event-]+e, "
349 "value=%" PRIu64
, event
, value_cycles
);
352 enum bt_clock_snapshot_state
bt_event_borrow_default_clock_snapshot_const(
353 const struct bt_event
*event
,
354 const struct bt_clock_snapshot
**clock_snapshot
)
356 BT_ASSERT_PRE_NON_NULL(event
, "Event");
357 BT_ASSERT_PRE_NON_NULL(clock_snapshot
, "Clock snapshot (output)");
358 *clock_snapshot
= event
->default_cs
;
359 return BT_CLOCK_SNAPSHOT_STATE_KNOWN
;
362 struct bt_packet
*bt_event_borrow_packet(struct bt_event
*event
)
364 BT_ASSERT_PRE_NON_NULL(event
, "Event");
365 return event
->packet
;
368 const struct bt_packet
*bt_event_borrow_packet_const(
369 const struct bt_event
*event
)
371 return bt_event_borrow_packet((void *) event
);
374 int bt_event_move_header_field(struct bt_event
*event
,
375 struct bt_event_header_field
*header_field
)
377 struct bt_stream_class
*stream_class
;
378 struct bt_field_wrapper
*field_wrapper
= (void *) header_field
;
380 BT_ASSERT_PRE_NON_NULL(event
, "Event");
381 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Header field");
382 BT_ASSERT_PRE_EVENT_HOT(event
);
383 stream_class
= bt_event_class_borrow_stream_class_inline(event
->class);
384 BT_ASSERT_PRE(stream_class
->event_header_fc
,
385 "Stream class has no event header field class: %!+S",
388 /* Recycle current header field: always exists */
389 BT_ASSERT(event
->header_field
);
390 recycle_event_header_field(event
->header_field
, stream_class
);
393 event
->header_field
= field_wrapper
;