2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright 2017-2018 Philippe Proulx <pproulx@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 "CTF-WRITER-EVENT"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/ctf-ir/event-internal.h>
28 #include <babeltrace/ctf-writer/clock-internal.h>
29 #include <babeltrace/ctf-writer/event-internal.h>
30 #include <babeltrace/ctf-writer/event.h>
31 #include <babeltrace/ctf-writer/fields-internal.h>
32 #include <babeltrace/ctf-writer/field-types-internal.h>
33 #include <babeltrace/ctf-writer/field-types.h>
34 #include <babeltrace/ctf-writer/fields.h>
35 #include <babeltrace/ctf-writer/stream-class-internal.h>
36 #include <babeltrace/ctf-writer/stream-class.h>
37 #include <babeltrace/ctf-writer/trace-internal.h>
38 #include <babeltrace/ctf-writer/trace.h>
39 #include <babeltrace/ref.h>
40 #include <babeltrace/compiler-internal.h>
41 #include <babeltrace/assert-internal.h>
42 #include <babeltrace/assert-pre-internal.h>
46 void bt_ctf_event_destroy(struct bt_object
*obj
);
49 int map_clock_classes_func(struct bt_stream_class_common
*stream_class
,
50 struct bt_field_type_common
*packet_context_type
,
51 struct bt_field_type_common
*event_header_type
)
53 int ret
= bt_ctf_stream_class_map_clock_class(
54 BT_FROM_COMMON(stream_class
),
55 BT_FROM_COMMON(packet_context_type
),
56 BT_FROM_COMMON(event_header_type
));
59 BT_LOGW_STR("Cannot automatically map selected stream class's field types to stream class's clock's class.");
66 void destroy_event_header_field(struct bt_field_wrapper
*field_wrapper
)
68 BT_ASSERT(field_wrapper
);
69 bt_put(field_wrapper
->field
);
70 bt_field_wrapper_destroy(field_wrapper
);
74 struct bt_field_wrapper
*create_event_header_field(
75 struct bt_stream_class
*stream_class
,
76 struct bt_field_type_common
*ft
)
78 struct bt_field_wrapper
*field_wrapper
= NULL
;
79 struct bt_ctf_field
*field
= bt_ctf_field_create((void *) ft
);
85 field_wrapper
= bt_field_wrapper_new(NULL
);
90 field_wrapper
->field
= (void *) field
;
98 destroy_event_header_field(field_wrapper
);
103 return field_wrapper
;
106 struct bt_ctf_event
*bt_ctf_event_create(struct bt_ctf_event_class
*event_class
)
109 struct bt_ctf_event
*event
= NULL
;
110 struct bt_clock_class
*expected_clock_class
= NULL
;
112 event
= g_new0(struct bt_ctf_event
, 1);
114 BT_LOGE_STR("Failed to allocate one CTF writer event.");
119 struct bt_ctf_stream_class
*stream_class
=
120 BT_FROM_COMMON(bt_event_class_common_borrow_stream_class(
121 BT_TO_COMMON(event_class
)));
123 if (stream_class
&& stream_class
->clock
) {
124 expected_clock_class
= BT_TO_COMMON(
125 stream_class
->clock
->clock_class
);
129 ret
= bt_event_common_initialize(BT_TO_COMMON(event
),
130 BT_TO_COMMON(event_class
), expected_clock_class
,
131 true, bt_ctf_event_destroy
,
132 (bt_validation_flag_copy_field_type_func
)
133 bt_ctf_field_type_copy
,
134 false, map_clock_classes_func
,
135 (create_field_func
) bt_ctf_field_create
,
136 (release_field_func
) bt_put
,
137 (create_header_field_func
) create_event_header_field
,
138 (release_header_field_func
) destroy_event_header_field
);
140 /* bt_event_common_initialize() logs errors */
153 struct bt_ctf_event_class
*bt_ctf_event_get_class(struct bt_ctf_event
*event
)
155 BT_ASSERT_PRE_NON_NULL(event
, "Event");
156 return bt_get(bt_event_common_borrow_class(BT_TO_COMMON(event
)));
160 struct bt_ctf_stream
*bt_ctf_event_borrow_stream(struct bt_ctf_event
*event
)
163 return (struct bt_ctf_stream
*)
164 bt_object_borrow_parent(&BT_TO_COMMON(event
)->base
);
167 struct bt_ctf_stream
*bt_ctf_event_get_stream(struct bt_ctf_event
*event
)
169 BT_ASSERT_PRE_NON_NULL(event
, "Event");
170 return bt_get(bt_ctf_event_borrow_stream(event
));
173 int bt_ctf_event_set_payload(struct bt_ctf_event
*event
, const char *name
,
174 struct bt_ctf_field
*field
)
176 BT_ASSERT_PRE_NON_NULL(event
, "Event");
177 BT_ASSERT_PRE_NON_NULL(field
, "Payload field");
178 BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event
), "Event");
179 return bt_ctf_field_structure_set_field_by_name(
180 (void *) event
->common
.payload_field
, name
, field
);
183 struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
186 struct bt_ctf_field
*field
= NULL
;
188 BT_ASSERT_PRE_NON_NULL(event
, "Event");
191 field
= bt_ctf_field_structure_get_field_by_name(
192 BT_FROM_COMMON(event
->common
.payload_field
), name
);
194 field
= BT_FROM_COMMON(event
->common
.payload_field
);
201 struct bt_ctf_field
*bt_ctf_event_get_payload_field(
202 struct bt_ctf_event
*event
)
204 return bt_get(bt_event_common_borrow_payload(BT_TO_COMMON(event
)));
207 struct bt_ctf_field
*bt_ctf_event_get_header(struct bt_ctf_event
*event
)
209 return bt_get(bt_event_common_borrow_header(BT_TO_COMMON(event
)));
212 struct bt_ctf_field
*bt_ctf_event_get_context(struct bt_ctf_event
*event
)
214 return bt_get(bt_event_common_borrow_context(BT_TO_COMMON(event
)));
217 struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
218 struct bt_ctf_event
*event
)
220 return bt_get(bt_event_common_borrow_stream_event_context(
221 BT_TO_COMMON(event
)));
225 void release_event_header_field(struct bt_field_wrapper
*field_wrapper
,
226 struct bt_event_common
*event_common
)
228 BT_ASSERT(field_wrapper
);
229 BT_PUT(field_wrapper
->field
);
230 bt_field_wrapper_destroy(field_wrapper
);
234 void bt_ctf_event_destroy(struct bt_object
*obj
)
236 bt_event_common_finalize(obj
, (void *) bt_put
,
237 (void *) release_event_header_field
);
242 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
243 struct bt_ctf_stream_pos
*pos
,
244 enum bt_ctf_byte_order native_byte_order
)
251 BT_LOGV_STR("Serializing event's context field.");
252 if (event
->common
.context_field
) {
253 ret
= bt_ctf_field_serialize_recursive(
254 (void *) event
->common
.context_field
, pos
,
257 BT_LOGW("Cannot serialize event's context field: "
258 "event-addr=%p, event-class-name=\"%s\", "
259 "event-class-id=%" PRId64
,
261 bt_event_class_common_get_name(event
->common
.class),
262 bt_event_class_common_get_id(event
->common
.class));
267 BT_LOGV_STR("Serializing event's payload field.");
268 if (event
->common
.payload_field
) {
269 ret
= bt_ctf_field_serialize_recursive(
270 (void *) event
->common
.payload_field
, pos
,
273 BT_LOGW("Cannot serialize event's payload field: "
274 "event-addr=%p, event-class-name=\"%s\", "
275 "event-class-id=%" PRId64
,
277 bt_event_class_common_get_name(event
->common
.class),
278 bt_event_class_common_get_id(event
->common
.class));
288 void _bt_ctf_event_freeze(struct bt_ctf_event
*event
)
290 _bt_event_common_set_is_frozen(BT_TO_COMMON(event
), true);
293 int bt_ctf_event_set_header(struct bt_ctf_event
*event
,
294 struct bt_ctf_field
*header
)
296 BT_ASSERT_PRE_NON_NULL(event
, "Event");
297 BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event
), "Event");
300 * Ensure the provided header's type matches the one registered to the
304 BT_ASSERT_PRE(bt_field_type_common_compare(
305 ((struct bt_field_common
*) header
)->type
,
306 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_header_field_type
) == 0,
307 "Header field's type is different from the "
308 "expected field type: %![event-]+we, %![ft-]+wF, "
309 "%![expected-ft-]+wF",
310 event
, ((struct bt_field_common
*) header
)->type
,
311 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_header_field_type
);
313 BT_ASSERT_PRE(!bt_event_class_common_borrow_stream_class(event
->common
.class)->event_header_field_type
,
314 "Setting no event header field, "
315 "but event header field type is not NULL: ",
316 "%![event-]+we, %![header-ft-]+wF",
318 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_header_field_type
);
321 bt_put(event
->common
.header_field
->field
);
322 event
->common
.header_field
->field
= bt_get(header
);
323 BT_LOGV("Set event's header field: event-addr=%p, "
324 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
325 "header-field-addr=%p",
326 event
, bt_event_class_common_get_name(event
->common
.class),
327 bt_event_class_common_get_id(event
->common
.class), header
);
331 int bt_ctf_event_common_set_payload(struct bt_ctf_event
*event
,
332 struct bt_ctf_field
*payload
)
334 BT_ASSERT_PRE_NON_NULL(event
, "Event");
335 BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event
), "Event");
338 BT_ASSERT_PRE(bt_field_type_common_compare(
339 ((struct bt_field_common
*) payload
)->type
,
340 event
->common
.class->payload_field_type
) == 0,
341 "Payload field's type is different from the "
342 "expected field type: %![event-]+we, %![ft-]+wF, "
343 "%![expected-ft-]+wF",
345 ((struct bt_field_common
*) payload
)->type
,
346 event
->common
.class->payload_field_type
);
348 BT_ASSERT_PRE(!event
->common
.class->payload_field_type
,
349 "Setting no event payload field, "
350 "but event payload field type is not NULL: ",
351 "%![event-]+we, %![payload-ft-]+wF",
352 event
, event
->common
.class->payload_field_type
);
355 bt_put(event
->common
.payload_field
);
356 event
->common
.payload_field
= bt_get(payload
);
357 BT_LOGV("Set event's payload field: event-addr=%p, "
358 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
359 "payload-field-addr=%p",
360 event
, bt_event_class_common_get_name(event
->common
.class),
361 bt_event_class_common_get_id(event
->common
.class), payload
);
365 int bt_ctf_event_set_context(struct bt_ctf_event
*event
,
366 struct bt_ctf_field
*context
)
368 BT_ASSERT_PRE_NON_NULL(event
, "Event");
369 BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event
), "Event");
372 BT_ASSERT_PRE(bt_field_type_common_compare(
373 ((struct bt_field_common
*) context
)->type
,
374 event
->common
.class->context_field_type
) == 0,
375 "Context field's type is different from the "
376 "expected field type: %![event-]+we, %![ft-]+wF, "
377 "%![expected-ft-]+wF",
378 event
, ((struct bt_field_common
*) context
)->type
,
379 event
->common
.class->context_field_type
);
381 BT_ASSERT_PRE(!event
->common
.class->context_field_type
,
382 "Setting no event context field, "
383 "but event context field type is not NULL: ",
384 "%![event-]+we, %![context-ft-]+wF",
385 event
, event
->common
.class->context_field_type
);
388 bt_put(event
->common
.context_field
);
389 event
->common
.context_field
= bt_get(context
);
390 BT_LOGV("Set event's context field: event-addr=%p, "
391 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
392 "context-field-addr=%p",
393 event
, bt_event_class_common_get_name(event
->common
.class),
394 bt_event_class_common_get_id(event
->common
.class), context
);
398 int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
399 struct bt_ctf_field
*stream_event_context
)
401 BT_ASSERT_PRE_NON_NULL(event
, "Event");
402 BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event
), "Event");
404 if (stream_event_context
) {
405 BT_ASSERT_PRE(bt_field_type_common_compare(
406 ((struct bt_field_common
*) stream_event_context
)->type
,
407 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_context_field_type
) == 0,
408 "Stream event context field's type is different from the "
409 "expected field type: %![event-]+we, %![ft-]+wF, "
410 "%![expected-ft-]+wF",
412 ((struct bt_field_common
*) stream_event_context
)->type
,
413 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_context_field_type
);
415 BT_ASSERT_PRE(!bt_event_class_common_borrow_stream_class(event
->common
.class)->event_context_field_type
,
416 "Setting no stream event context field, "
417 "but stream event context field type is not NULL: ",
418 "%![event-]+we, %![context-ft-]+wF",
420 bt_event_class_common_borrow_stream_class(event
->common
.class)->event_context_field_type
);
423 bt_put(event
->common
.stream_event_context_field
);
424 event
->common
.stream_event_context_field
= bt_get(stream_event_context
);
425 BT_LOGV("Set event's stream event context field: event-addr=%p, "
426 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
427 "stream-event-context-field-addr=%p",
428 event
, bt_event_class_common_get_name(event
->common
.class),
429 bt_event_class_common_get_id(event
->common
.class),
430 stream_event_context
);