2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "EVENT"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/trace-ir/fields-internal.h>
30 #include <babeltrace/trace-ir/field-classes-internal.h>
31 #include <babeltrace/trace-ir/clock-class.h>
32 #include <babeltrace/trace-ir/clock-value.h>
33 #include <babeltrace/trace-ir/clock-value-internal.h>
34 #include <babeltrace/trace-ir/clock-class-internal.h>
35 #include <babeltrace/trace-ir/private-event.h>
36 #include <babeltrace/trace-ir/event-internal.h>
37 #include <babeltrace/trace-ir/event-class.h>
38 #include <babeltrace/trace-ir/event-class-internal.h>
39 #include <babeltrace/trace-ir/stream-class.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/object.h>
48 #include <babeltrace/trace-ir/attributes-internal.h>
49 #include <babeltrace/compiler-internal.h>
50 #include <babeltrace/assert-internal.h>
54 void _bt_event_set_is_frozen(struct bt_event
*event
, bool is_frozen
)
57 BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
60 if (event
->header_field
) {
61 BT_LOGD_STR("Setting event's header field's frozen state.");
62 bt_field_set_is_frozen(
63 event
->header_field
->field
, is_frozen
);
66 if (event
->common_context_field
) {
67 BT_LOGD_STR("Setting event's common context field's frozen state.");
68 bt_field_set_is_frozen(
69 event
->common_context_field
, is_frozen
);
72 if (event
->specific_context_field
) {
73 BT_LOGD_STR("Setting event's specific context field's frozen state.");
74 bt_field_set_is_frozen(event
->specific_context_field
,
78 if (event
->payload_field
) {
79 BT_LOGD_STR("Setting event's payload field's frozen state.");
80 bt_field_set_is_frozen(event
->payload_field
,
84 event
->frozen
= is_frozen
;
85 BT_LOGD_STR("Setting event's packet's frozen state.");
86 bt_packet_set_is_frozen(event
->packet
, is_frozen
);
90 void recycle_event_header_field(struct bt_field_wrapper
*field_wrapper
,
91 struct bt_stream_class
*stream_class
)
93 BT_ASSERT(field_wrapper
);
94 BT_LIB_LOGD("Recycling event header field: "
95 "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper
,
96 stream_class
, field_wrapper
->field
);
97 bt_object_pool_recycle_object(
98 &stream_class
->event_header_field_pool
,
103 struct bt_field_wrapper
*create_event_header_field(
104 struct bt_stream_class
*stream_class
)
106 struct bt_field_wrapper
*field_wrapper
= NULL
;
108 field_wrapper
= bt_field_wrapper_create(
109 &stream_class
->event_header_field_pool
,
110 bt_stream_class_borrow_event_header_field_class(stream_class
));
111 if (!field_wrapper
) {
119 recycle_event_header_field(field_wrapper
, stream_class
);
120 field_wrapper
= NULL
;
124 return field_wrapper
;
128 struct bt_event
*bt_event_new(struct bt_event_class
*event_class
)
130 struct bt_event
*event
= NULL
;
131 struct bt_stream_class
*stream_class
;
132 struct bt_field_class
*fc
;
134 BT_ASSERT(event_class
);
135 event
= g_new0(struct bt_event
, 1);
137 BT_LOGE_STR("Failed to allocate one event.");
141 bt_object_init_unique(&event
->base
);
142 stream_class
= bt_event_class_borrow_stream_class(event_class
);
143 BT_ASSERT(stream_class
);
145 if (bt_stream_class_borrow_event_header_field_class(stream_class
)) {
146 event
->header_field
= create_event_header_field(stream_class
);
147 if (!event
->header_field
) {
148 BT_LOGE_STR("Cannot create event header field.");
153 fc
= bt_stream_class_borrow_event_common_context_field_class(
156 event
->common_context_field
= bt_field_create(fc
);
157 if (!event
->common_context_field
) {
158 /* bt_field_create() logs errors */
163 fc
= bt_event_class_borrow_specific_context_field_class(event_class
);
165 event
->specific_context_field
= bt_field_create(fc
);
166 if (!event
->specific_context_field
) {
167 /* bt_field_create() logs errors */
172 fc
= bt_event_class_borrow_payload_field_class(event_class
);
174 event
->payload_field
= bt_field_create(fc
);
175 if (!event
->payload_field
) {
176 /* bt_field_create() logs errors */
181 if (stream_class
->default_clock_class
) {
182 event
->default_cv
= bt_clock_value_create(
183 stream_class
->default_clock_class
);
184 if (!event
->default_cv
) {
185 /* bt_clock_value_create() logs errors */
194 bt_event_destroy(event
);
202 struct bt_event_class
*bt_event_borrow_class(struct bt_event
*event
)
204 BT_ASSERT_PRE_NON_NULL(event
, "Event");
208 struct bt_stream
*bt_event_borrow_stream(struct bt_event
*event
)
210 BT_ASSERT_PRE_NON_NULL(event
, "Event");
211 return event
->packet
? event
->packet
->stream
: NULL
;
214 struct bt_field
*bt_event_borrow_header_field(struct bt_event
*event
)
216 BT_ASSERT_PRE_NON_NULL(event
, "Event");
217 return event
->header_field
? event
->header_field
->field
: NULL
;
220 struct bt_private_field
*bt_private_event_borrow_header_field(
221 struct bt_private_event
*event
)
223 return (void *) bt_event_borrow_header_field((void *) event
);
226 struct bt_field
*bt_event_borrow_common_context_field(struct bt_event
*event
)
228 BT_ASSERT_PRE_NON_NULL(event
, "Event");
229 return event
->common_context_field
;
232 struct bt_private_field
*bt_private_event_borrow_common_context_field(
233 struct bt_private_event
*event
)
235 return (void *) bt_event_borrow_common_context_field((void *) event
);
238 struct bt_field
*bt_event_borrow_specific_context_field(struct bt_event
*event
)
240 BT_ASSERT_PRE_NON_NULL(event
, "Event");
241 return event
->specific_context_field
;
244 struct bt_private_field
*bt_private_event_borrow_specific_context_field(
245 struct bt_private_event
*event
)
247 return (void *) bt_event_borrow_specific_context_field((void *) event
);
250 struct bt_field
*bt_event_borrow_payload_field(struct bt_event
*event
)
252 BT_ASSERT_PRE_NON_NULL(event
, "Event");
253 return event
->payload_field
;
256 struct bt_private_field
*bt_private_event_borrow_payload_field(
257 struct bt_private_event
*event
)
259 return (void *) bt_event_borrow_payload_field((void *) event
);
263 void release_event_header_field(struct bt_field_wrapper
*field_wrapper
,
264 struct bt_event
*event
)
267 bt_field_wrapper_destroy(field_wrapper
);
269 struct bt_stream_class
*stream_class
=
270 bt_event_class_borrow_stream_class(event
->class);
272 BT_ASSERT(stream_class
);
273 recycle_event_header_field(field_wrapper
, stream_class
);
278 void bt_event_destroy(struct bt_event
*event
)
281 BT_LIB_LOGD("Destroying event: %!+e", event
);
283 if (event
->header_field
) {
284 BT_LOGD_STR("Releasing event's header field.");
285 release_event_header_field(event
->header_field
, event
);
288 if (event
->common_context_field
) {
289 BT_LOGD_STR("Destroying event's stream event context field.");
290 bt_field_destroy(event
->common_context_field
);
293 if (event
->specific_context_field
) {
294 BT_LOGD_STR("Destroying event's context field.");
295 bt_field_destroy(event
->specific_context_field
);
298 if (event
->payload_field
) {
299 BT_LOGD_STR("Destroying event's payload field.");
300 bt_field_destroy(event
->payload_field
);
303 BT_LOGD_STR("Putting event's class.");
304 bt_object_put_ref(event
->class);
306 if (event
->default_cv
) {
307 bt_clock_value_recycle(event
->default_cv
);
310 BT_LOGD_STR("Putting event's packet.");
311 bt_object_put_ref(event
->packet
);
315 void bt_private_event_set_default_clock_value(
316 struct bt_private_event
*priv_event
, uint64_t value_cycles
)
318 struct bt_event
*event
= (void *) priv_event
;
319 struct bt_stream_class
*sc
;
321 BT_ASSERT_PRE_NON_NULL(event
, "Event");
322 BT_ASSERT_PRE_EVENT_HOT(event
);
323 sc
= bt_event_class_borrow_stream_class_inline(event
->class);
325 BT_ASSERT_PRE(sc
->default_clock_class
,
326 "Event's stream class has no default clock class: "
327 "%![ev-]+e, %![sc-]+S", event
, sc
);
328 BT_ASSERT(event
->default_cv
);
329 bt_clock_value_set_value_inline(event
->default_cv
, value_cycles
);
330 BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
331 "value=%" PRIu64
, event
, value_cycles
);
334 enum bt_clock_value_status
bt_event_borrow_default_clock_value(
335 struct bt_event
*event
, struct bt_clock_value
**clock_value
)
337 BT_ASSERT_PRE_NON_NULL(event
, "Event");
338 BT_ASSERT_PRE_NON_NULL(clock_value
, "Clock value (output)");
339 *clock_value
= event
->default_cv
;
340 return BT_CLOCK_VALUE_STATUS_KNOWN
;
343 struct bt_packet
*bt_event_borrow_packet(struct bt_event
*event
)
345 BT_ASSERT_PRE_NON_NULL(event
, "Event");
346 return event
->packet
;
349 struct bt_private_packet
*bt_private_event_borrow_packet(
350 struct bt_private_event
*event
)
352 return (void *) bt_event_borrow_packet((void *) event
);
355 int bt_private_event_move_header_field(
356 struct bt_private_event
*priv_event
,
357 struct bt_private_event_header_field
*priv_header_field
)
359 struct bt_stream_class
*stream_class
;
360 struct bt_event
*event
= (void *) priv_event
;
361 struct bt_event_class
*event_class
= (void *) event_class
;
362 struct bt_field_wrapper
*field_wrapper
= (void *) priv_header_field
;
364 BT_ASSERT_PRE_NON_NULL(event
, "Event");
365 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Header field");
366 BT_ASSERT_PRE_EVENT_HOT(event
);
367 stream_class
= bt_event_class_borrow_stream_class_inline(event
->class);
368 BT_ASSERT_PRE(stream_class
->event_header_fc
,
369 "Stream class has no event header field classe: %!+S",
372 /* Recycle current header field: always exists */
373 BT_ASSERT(event
->header_field
);
374 recycle_event_header_field(event
->header_field
, stream_class
);
377 event
->header_field
= field_wrapper
;