4 * Babeltrace CTF IR - Stream Class
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 #include <babeltrace/ctf-writer/clock.h>
30 #include <babeltrace/ctf-ir/clock-internal.h>
31 #include <babeltrace/ctf-writer/event.h>
32 #include <babeltrace/ctf-ir/event-class-internal.h>
33 #include <babeltrace/ctf-ir/event-internal.h>
34 #include <babeltrace/ctf-ir/field-types-internal.h>
35 #include <babeltrace/ctf-ir/fields-internal.h>
36 #include <babeltrace/ctf-writer/stream.h>
37 #include <babeltrace/ctf-ir/stream-class-internal.h>
38 #include <babeltrace/ctf-ir/validation-internal.h>
39 #include <babeltrace/ctf-writer/functor-internal.h>
40 #include <babeltrace/ctf-ir/utils.h>
41 #include <babeltrace/ref.h>
42 #include <babeltrace/compiler.h>
43 #include <babeltrace/align.h>
44 #include <babeltrace/endian.h>
47 void bt_ctf_stream_class_destroy(struct bt_object
*obj
);
49 int init_event_header(struct bt_ctf_stream_class
*stream_class
);
51 int init_packet_context(struct bt_ctf_stream_class
*stream_class
);
53 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
56 struct bt_ctf_stream_class
*stream_class
= NULL
;
58 if (name
&& bt_ctf_validate_identifier(name
)) {
62 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
67 stream_class
->name
= g_string_new(name
);
68 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
69 (GDestroyNotify
) bt_object_release
);
70 if (!stream_class
->event_classes
) {
74 ret
= init_event_header(stream_class
);
79 ret
= init_packet_context(stream_class
);
84 bt_object_init(stream_class
, bt_ctf_stream_class_destroy
);
92 struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
93 struct bt_ctf_stream_class
*stream_class
)
95 return (struct bt_ctf_trace
*) bt_object_get_parent(
99 const char *bt_ctf_stream_class_get_name(
100 struct bt_ctf_stream_class
*stream_class
)
102 const char *name
= NULL
;
108 name
= stream_class
->name
->str
;
113 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
118 if (!stream_class
|| stream_class
->frozen
) {
123 g_string_assign(stream_class
->name
, name
);
128 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
129 struct bt_ctf_stream_class
*stream_class
)
131 struct bt_ctf_clock
*clock
= NULL
;
133 if (!stream_class
|| !stream_class
->clock
) {
137 clock
= stream_class
->clock
;
143 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
144 struct bt_ctf_clock
*clock
)
147 struct bt_ctf_field_type
*timestamp_field
= NULL
;
149 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
155 * Look for a "timestamp" field in the stream class' event header type
156 * and map the stream's clock to that field if no current mapping is
159 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
160 stream_class
->event_header_type
, "timestamp");
161 if (timestamp_field
) {
162 struct bt_ctf_clock
*mapped_clock
;
164 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
167 bt_put(mapped_clock
);
171 ret
= bt_ctf_field_type_integer_set_mapped_clock(
172 timestamp_field
, clock
);
178 if (stream_class
->clock
) {
179 bt_put(stream_class
->clock
);
182 stream_class
->clock
= clock
;
185 if (timestamp_field
) {
186 bt_put(timestamp_field
);
191 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
195 if (!stream_class
|| !stream_class
->id_set
) {
200 ret
= (int64_t) stream_class
->id
;
206 int _bt_ctf_stream_class_set_id(
207 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
209 stream_class
->id
= id
;
210 stream_class
->id_set
= 1;
214 struct event_class_set_stream_id_data
{
220 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
222 struct event_class_set_stream_id_data
*typed_data
= data
;
224 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
225 typed_data
->stream_id
);
229 int bt_ctf_stream_class_set_id_no_check(
230 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
233 struct event_class_set_stream_id_data data
=
234 { .stream_id
= id
, .ret
= 0 };
237 * Make sure all event classes have their "stream_id" attribute
240 g_ptr_array_foreach(stream_class
->event_classes
,
241 event_class_set_stream_id
, &data
);
247 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
255 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
260 if (!stream_class
|| stream_class
->frozen
) {
265 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
271 void event_class_exists(gpointer element
, gpointer query
)
273 struct bt_ctf_event_class
*event_class_a
= element
;
274 struct search_query
*search_query
= query
;
275 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
278 if (search_query
->value
== element
) {
279 search_query
->found
= 1;
284 * Two event classes cannot share the same name in a given
287 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
288 bt_ctf_event_class_get_name(event_class_b
))) {
289 search_query
->found
= 1;
294 * Two event classes cannot share the same ID in a given
297 id_a
= bt_ctf_event_class_get_id(event_class_a
);
298 id_b
= bt_ctf_event_class_get_id(event_class_b
);
300 if (id_a
< 0 || id_b
< 0) {
301 /* at least one ID is not set: will be automatically set later */
306 search_query
->found
= 1;
314 int bt_ctf_stream_class_add_event_class(
315 struct bt_ctf_stream_class
*stream_class
,
316 struct bt_ctf_event_class
*event_class
)
320 struct bt_ctf_trace
*trace
= NULL
;
321 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
322 struct bt_ctf_validation_output validation_output
= { 0 };
323 struct bt_ctf_field_type
*packet_header_type
= NULL
;
324 struct bt_ctf_field_type
*packet_context_type
= NULL
;
325 struct bt_ctf_field_type
*event_header_type
= NULL
;
326 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
327 struct bt_ctf_field_type
*event_context_type
= NULL
;
328 struct bt_ctf_field_type
*event_payload_type
= NULL
;
329 const enum bt_ctf_validation_flag validation_flags
=
330 BT_CTF_VALIDATION_FLAG_EVENT
;
332 if (!stream_class
|| !event_class
) {
337 /* Check for duplicate event classes */
338 struct search_query query
= { .value
= event_class
, .found
= 0 };
339 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
346 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
347 if (old_stream_class
) {
348 /* Event class is already associated to a stream class. */
353 trace
= bt_ctf_stream_class_get_trace(stream_class
);
356 * If the stream class is associated with a trace, then
357 * both those objects are frozen. Also, this event class
358 * is about to be frozen.
360 * Therefore the event class must be validated here.
361 * The trace and stream class should be valid at this
364 assert(trace
->valid
);
365 assert(stream_class
->valid
);
367 bt_ctf_trace_get_packet_header_type(trace
);
368 packet_context_type
=
369 bt_ctf_stream_class_get_packet_context_type(
372 bt_ctf_stream_class_get_event_header_type(stream_class
);
373 stream_event_ctx_type
=
374 bt_ctf_stream_class_get_event_context_type(
377 bt_ctf_event_class_get_context_type(event_class
);
379 bt_ctf_event_class_get_payload_type(event_class
);
380 ret
= bt_ctf_validate_class_types(
381 trace
->environment
, packet_header_type
,
382 packet_context_type
, event_header_type
,
383 stream_event_ctx_type
, event_context_type
,
384 event_payload_type
, trace
->valid
,
385 stream_class
->valid
, event_class
->valid
,
386 &validation_output
, validation_flags
);
387 BT_PUT(packet_header_type
);
388 BT_PUT(packet_context_type
);
389 BT_PUT(event_header_type
);
390 BT_PUT(stream_event_ctx_type
);
391 BT_PUT(event_context_type
);
392 BT_PUT(event_payload_type
);
396 * This means something went wrong during the
397 * validation process, not that the objects are
403 if ((validation_output
.valid_flags
& validation_flags
) !=
405 /* Invalid event class */
411 /* Only set an event ID if none was explicitly set before */
412 event_id
= bt_ctf_event_class_get_id(event_class
);
414 if (bt_ctf_event_class_set_id(event_class
,
415 stream_class
->next_event_id
++)) {
421 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
426 bt_object_set_parent(event_class
, stream_class
);
430 * At this point we know that the function will be
431 * successful. Therefore we can replace the event
432 * class's field types with what's in the validation
433 * output structure and mark this event class as valid.
435 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
436 &validation_output
, validation_flags
);
437 event_class
->valid
= 1;
440 * Put what was not moved in
441 * bt_ctf_validation_replace_types().
443 bt_ctf_validation_output_put_types(&validation_output
);
446 /* Add to the event classes of the stream class */
447 g_ptr_array_add(stream_class
->event_classes
, event_class
);
449 /* Freeze the event class */
450 bt_ctf_event_class_freeze(event_class
);
452 if (stream_class
->byte_order
) {
454 * Only set native byte order if it has been initialized
455 * when the stream class was added to a trace.
457 * If not set here, this will be set when the stream
458 * class is added to a trace.
460 bt_ctf_event_class_set_native_byte_order(event_class
,
461 stream_class
->byte_order
);
466 BT_PUT(old_stream_class
);
467 bt_ctf_validation_output_put_types(&validation_output
);
468 assert(!packet_header_type
);
469 assert(!packet_context_type
);
470 assert(!event_header_type
);
471 assert(!stream_event_ctx_type
);
472 assert(!event_context_type
);
473 assert(!event_payload_type
);
478 int bt_ctf_stream_class_get_event_class_count(
479 struct bt_ctf_stream_class
*stream_class
)
488 ret
= (int) stream_class
->event_classes
->len
;
493 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
494 struct bt_ctf_stream_class
*stream_class
, int index
)
496 struct bt_ctf_event_class
*event_class
= NULL
;
498 if (!stream_class
|| index
< 0 ||
499 index
>= stream_class
->event_classes
->len
) {
503 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
509 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
510 struct bt_ctf_stream_class
*stream_class
, const char *name
)
513 struct bt_ctf_event_class
*event_class
= NULL
;
515 if (!stream_class
|| !name
) {
519 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
520 struct bt_ctf_event_class
*cur_event_class
=
521 g_ptr_array_index(stream_class
->event_classes
, i
);
522 const char *cur_event_class_name
=
523 bt_ctf_event_class_get_name(cur_event_class
);
525 if (!strcmp(name
, cur_event_class_name
)) {
526 event_class
= cur_event_class
;
535 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
536 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
539 struct bt_ctf_event_class
*event_class
= NULL
;
545 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
546 struct bt_ctf_event_class
*current_event_class
=
547 g_ptr_array_index(stream_class
->event_classes
, i
);
549 if (bt_ctf_event_class_get_id(current_event_class
) == id
) {
550 event_class
= current_event_class
;
559 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
560 struct bt_ctf_stream_class
*stream_class
)
562 struct bt_ctf_field_type
*ret
= NULL
;
568 assert(stream_class
->packet_context_type
);
569 bt_get(stream_class
->packet_context_type
);
570 ret
= stream_class
->packet_context_type
;
575 int bt_ctf_stream_class_set_packet_context_type(
576 struct bt_ctf_stream_class
*stream_class
,
577 struct bt_ctf_field_type
*packet_context_type
)
581 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
586 assert(stream_class
->packet_context_type
);
587 if (stream_class
->packet_context_type
== packet_context_type
) {
590 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
591 BT_CTF_TYPE_ID_STRUCT
) {
592 /* A packet context must be a structure */
597 bt_put(stream_class
->packet_context_type
);
598 bt_get(packet_context_type
);
599 stream_class
->packet_context_type
= packet_context_type
;
604 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
605 struct bt_ctf_stream_class
*stream_class
)
607 struct bt_ctf_field_type
*ret
= NULL
;
609 if (!stream_class
|| !stream_class
->event_header_type
) {
613 assert(stream_class
->event_header_type
);
614 bt_get(stream_class
->event_header_type
);
615 ret
= stream_class
->event_header_type
;
620 int bt_ctf_stream_class_set_event_header_type(
621 struct bt_ctf_stream_class
*stream_class
,
622 struct bt_ctf_field_type
*event_header_type
)
626 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
631 assert(stream_class
->event_header_type
);
632 if (stream_class
->event_header_type
== event_header_type
) {
635 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
636 BT_CTF_TYPE_ID_STRUCT
) {
637 /* An event header must be a structure */
642 bt_put(stream_class
->event_header_type
);
643 bt_get(event_header_type
);
644 stream_class
->event_header_type
= event_header_type
;
649 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
650 struct bt_ctf_stream_class
*stream_class
)
652 struct bt_ctf_field_type
*ret
= NULL
;
654 if (!stream_class
|| !stream_class
->event_context_type
) {
658 assert(stream_class
->event_context_type
);
659 bt_get(stream_class
->event_context_type
);
660 ret
= stream_class
->event_context_type
;
665 int bt_ctf_stream_class_set_event_context_type(
666 struct bt_ctf_stream_class
*stream_class
,
667 struct bt_ctf_field_type
*event_context_type
)
671 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
676 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
677 BT_CTF_TYPE_ID_STRUCT
) {
678 /* A packet context must be a structure */
683 bt_put(stream_class
->event_context_type
);
684 bt_get(event_context_type
);
685 stream_class
->event_context_type
= event_context_type
;
690 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
692 bt_get(stream_class
);
695 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
697 bt_put(stream_class
);
701 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
707 stream_class
->frozen
= 1;
708 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
709 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
710 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
711 bt_ctf_clock_freeze(stream_class
->clock
);
715 void bt_ctf_stream_class_set_byte_order(
716 struct bt_ctf_stream_class
*stream_class
, int byte_order
)
720 assert(stream_class
);
721 assert(byte_order
== LITTLE_ENDIAN
|| byte_order
== BIG_ENDIAN
);
722 stream_class
->byte_order
= byte_order
;
724 /* Set native byte order to little or big endian */
725 bt_ctf_field_type_set_native_byte_order(
726 stream_class
->event_header_type
, byte_order
);
727 bt_ctf_field_type_set_native_byte_order(
728 stream_class
->packet_context_type
, byte_order
);
729 bt_ctf_field_type_set_native_byte_order(
730 stream_class
->event_context_type
, byte_order
);
732 /* Set all events' native byte order */
733 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
734 struct bt_ctf_event_class
*event_class
=
735 g_ptr_array_index(stream_class
->event_classes
, i
);
737 bt_ctf_event_class_set_native_byte_order(event_class
,
743 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
744 struct metadata_context
*context
)
749 g_string_assign(context
->field_name
, "");
750 context
->current_indentation_level
= 1;
751 if (!stream_class
->id_set
) {
756 g_string_append_printf(context
->string
,
757 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
759 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
765 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
766 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
772 if (stream_class
->event_context_type
) {
773 g_string_append(context
->string
, ";\n\n\tevent.context := ");
774 ret
= bt_ctf_field_type_serialize(
775 stream_class
->event_context_type
, context
);
781 g_string_append(context
->string
, ";\n};\n\n");
782 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
783 struct bt_ctf_event_class
*event_class
=
784 stream_class
->event_classes
->pdata
[i
];
786 ret
= bt_ctf_event_class_serialize(event_class
, context
);
792 context
->current_indentation_level
= 0;
797 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
799 struct bt_ctf_stream_class
*stream_class
;
801 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
802 bt_put(stream_class
->clock
);
804 if (stream_class
->event_classes
) {
805 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
808 if (stream_class
->name
) {
809 g_string_free(stream_class
->name
, TRUE
);
812 bt_put(stream_class
->event_header_type
);
813 bt_put(stream_class
->packet_context_type
);
814 bt_put(stream_class
->event_context_type
);
815 g_free(stream_class
);
819 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
822 struct bt_ctf_field_type
*event_header_type
=
823 bt_ctf_field_type_structure_create();
824 struct bt_ctf_field_type
*_uint32_t
=
825 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
826 struct bt_ctf_field_type
*_uint64_t
=
827 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
829 if (!event_header_type
) {
834 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
840 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
841 _uint64_t
, "timestamp");
846 if (stream_class
->event_header_type
) {
847 bt_put(stream_class
->event_header_type
);
849 stream_class
->event_header_type
= event_header_type
;
852 bt_put(event_header_type
);
861 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
864 struct bt_ctf_field_type
*packet_context_type
=
865 bt_ctf_field_type_structure_create();
866 struct bt_ctf_field_type
*_uint64_t
=
867 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
869 if (!packet_context_type
) {
875 * We create a stream packet context as proposed in the CTF
878 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
879 _uint64_t
, "timestamp_begin");
884 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
885 _uint64_t
, "timestamp_end");
890 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
891 _uint64_t
, "content_size");
896 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
897 _uint64_t
, "packet_size");
902 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
903 _uint64_t
, "events_discarded");
908 bt_put(stream_class
->packet_context_type
);
909 stream_class
->packet_context_type
= packet_context_type
;
912 bt_put(packet_context_type
);