4 * Babeltrace trace IR - Event
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #define BT_LOG_TAG "EVENT"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/assert-pre-internal.h>
33 #include <babeltrace/trace-ir/fields-internal.h>
34 #include <babeltrace/trace-ir/field-classes-internal.h>
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>
50 #include <babeltrace/object.h>
51 #include <babeltrace/trace-ir/attributes-internal.h>
52 #include <babeltrace/compiler-internal.h>
53 #include <babeltrace/assert-internal.h>
57 void _bt_event_set_is_frozen(struct bt_event
*event
, bool is_frozen
)
60 BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
63 if (event
->header_field
) {
64 BT_LOGD_STR("Setting event's header field's frozen state.");
65 bt_field_set_is_frozen(
66 event
->header_field
->field
, is_frozen
);
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
);
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
,
81 if (event
->payload_field
) {
82 BT_LOGD_STR("Setting event's payload field's frozen state.");
83 bt_field_set_is_frozen(event
->payload_field
,
87 event
->frozen
= is_frozen
;
88 BT_LOGD_STR("Setting event's packet's frozen state.");
89 bt_packet_set_is_frozen(event
->packet
, is_frozen
);
93 void recycle_event_header_field(struct bt_field_wrapper
*field_wrapper
,
94 struct bt_stream_class
*stream_class
)
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
,
106 struct bt_field_wrapper
*create_event_header_field(
107 struct bt_stream_class
*stream_class
)
109 struct bt_field_wrapper
*field_wrapper
= NULL
;
111 field_wrapper
= bt_field_wrapper_create(
112 &stream_class
->event_header_field_pool
,
113 bt_stream_class_borrow_event_header_field_class(stream_class
));
114 if (!field_wrapper
) {
122 recycle_event_header_field(field_wrapper
, stream_class
);
123 field_wrapper
= NULL
;
127 return field_wrapper
;
131 struct bt_event
*bt_event_new(struct bt_event_class
*event_class
)
133 struct bt_event
*event
= NULL
;
134 struct bt_stream_class
*stream_class
;
135 struct bt_field_class
*fc
;
137 BT_ASSERT(event_class
);
138 event
= g_new0(struct bt_event
, 1);
140 BT_LOGE_STR("Failed to allocate one event.");
144 bt_object_init_unique(&event
->base
);
145 stream_class
= bt_event_class_borrow_stream_class(event_class
);
146 BT_ASSERT(stream_class
);
148 if (bt_stream_class_borrow_event_header_field_class(stream_class
)) {
149 event
->header_field
= create_event_header_field(stream_class
);
150 if (!event
->header_field
) {
151 BT_LOGE_STR("Cannot create event header field.");
156 fc
= bt_stream_class_borrow_event_common_context_field_class(
159 event
->common_context_field
= bt_field_create(fc
);
160 if (!event
->common_context_field
) {
161 /* bt_field_create() logs errors */
166 fc
= bt_event_class_borrow_specific_context_field_class(event_class
);
168 event
->specific_context_field
= bt_field_create(fc
);
169 if (!event
->specific_context_field
) {
170 /* bt_field_create() logs errors */
175 fc
= bt_event_class_borrow_payload_field_class(event_class
);
177 event
->payload_field
= bt_field_create(fc
);
178 if (!event
->payload_field
) {
179 /* bt_field_create() logs errors */
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 */
197 bt_event_destroy(event
);
205 struct bt_event_class
*bt_event_borrow_class(struct bt_event
*event
)
207 BT_ASSERT_PRE_NON_NULL(event
, "Event");
211 struct bt_stream
*bt_event_borrow_stream(struct bt_event
*event
)
213 BT_ASSERT_PRE_NON_NULL(event
, "Event");
214 return event
->packet
? event
->packet
->stream
: NULL
;
217 struct bt_field
*bt_event_borrow_header_field(struct bt_event
*event
)
219 BT_ASSERT_PRE_NON_NULL(event
, "Event");
220 return event
->header_field
? event
->header_field
->field
: NULL
;
223 struct bt_field
*bt_event_borrow_common_context_field(struct bt_event
*event
)
225 BT_ASSERT_PRE_NON_NULL(event
, "Event");
226 return event
->common_context_field
;
229 struct bt_field
*bt_event_borrow_specific_context_field(struct bt_event
*event
)
231 BT_ASSERT_PRE_NON_NULL(event
, "Event");
232 return event
->specific_context_field
;
235 struct bt_field
*bt_event_borrow_payload_field(struct bt_event
*event
)
237 BT_ASSERT_PRE_NON_NULL(event
, "Event");
238 return event
->payload_field
;
242 void release_event_header_field(struct bt_field_wrapper
*field_wrapper
,
243 struct bt_event
*event
)
246 bt_field_wrapper_destroy(field_wrapper
);
248 struct bt_stream_class
*stream_class
=
249 bt_event_class_borrow_stream_class(event
->class);
251 BT_ASSERT(stream_class
);
252 recycle_event_header_field(field_wrapper
, stream_class
);
257 void bt_event_destroy(struct bt_event
*event
)
260 BT_LIB_LOGD("Destroying event: %!+e", event
);
262 if (event
->header_field
) {
263 BT_LOGD_STR("Releasing event's header field.");
264 release_event_header_field(event
->header_field
, event
);
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
);
272 if (event
->specific_context_field
) {
273 BT_LOGD_STR("Destroying event's context field.");
274 bt_field_destroy(event
->specific_context_field
);
277 if (event
->payload_field
) {
278 BT_LOGD_STR("Destroying event's payload field.");
279 bt_field_destroy(event
->payload_field
);
282 BT_LOGD_STR("Putting event's class.");
283 bt_object_put_ref(event
->class);
285 if (event
->default_cv
) {
286 bt_clock_value_recycle(event
->default_cv
);
289 BT_LOGD_STR("Putting event's packet.");
290 bt_object_put_ref(event
->packet
);
294 int bt_event_set_default_clock_value(struct bt_event
*event
,
295 uint64_t value_cycles
)
297 struct bt_stream_class
*sc
;
299 BT_ASSERT_PRE_NON_NULL(event
, "Event");
300 BT_ASSERT_PRE_EVENT_HOT(event
);
301 sc
= bt_event_class_borrow_stream_class_inline(event
->class);
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
);
313 enum bt_clock_value_status
bt_event_borrow_default_clock_value(
314 struct bt_event
*event
, struct bt_clock_value
**clock_value
)
316 BT_ASSERT_PRE_NON_NULL(event
, "Event");
317 BT_ASSERT_PRE_NON_NULL(clock_value
, "Clock value (output)");
318 *clock_value
= event
->default_cv
;
319 return BT_CLOCK_VALUE_STATUS_KNOWN
;
322 struct bt_packet
*bt_event_borrow_packet(struct bt_event
*event
)
324 BT_ASSERT_PRE_NON_NULL(event
, "Event");
325 return event
->packet
;
328 int bt_event_move_header(struct bt_event
*event
,
329 struct bt_event_header_field
*header_field
)
331 struct bt_stream_class
*stream_class
;
332 struct bt_field_wrapper
*field_wrapper
= (void *) header_field
;
334 BT_ASSERT_PRE_NON_NULL(event
, "Event");
335 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Header field");
336 BT_ASSERT_PRE_EVENT_HOT(event
);
337 stream_class
= bt_event_class_borrow_stream_class_inline(event
->class);
338 BT_ASSERT_PRE(stream_class
->event_header_fc
,
339 "Stream class has no event header field classe: %!+S",
342 /* Recycle current header field: always exists */
343 BT_ASSERT(event
->header_field
);
344 recycle_event_header_field(event
->header_field
, stream_class
);
347 event
->header_field
= field_wrapper
;