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-ir/visitor-internal.h>
40 #include <babeltrace/ctf-writer/functor-internal.h>
41 #include <babeltrace/ctf-ir/utils.h>
42 #include <babeltrace/ref.h>
43 #include <babeltrace/compiler.h>
44 #include <babeltrace/align.h>
45 #include <babeltrace/endian.h>
48 void bt_ctf_stream_class_destroy(struct bt_object
*obj
);
50 int init_event_header(struct bt_ctf_stream_class
*stream_class
);
52 int init_packet_context(struct bt_ctf_stream_class
*stream_class
);
54 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
57 struct bt_ctf_stream_class
*stream_class
= NULL
;
59 if (name
&& bt_ctf_validate_identifier(name
)) {
63 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
68 stream_class
->name
= g_string_new(name
);
69 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
70 (GDestroyNotify
) bt_object_release
);
71 if (!stream_class
->event_classes
) {
75 ret
= init_event_header(stream_class
);
80 ret
= init_packet_context(stream_class
);
85 bt_object_init(stream_class
, bt_ctf_stream_class_destroy
);
93 struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
94 struct bt_ctf_stream_class
*stream_class
)
96 return (struct bt_ctf_trace
*) bt_object_get_parent(
100 const char *bt_ctf_stream_class_get_name(
101 struct bt_ctf_stream_class
*stream_class
)
103 const char *name
= NULL
;
109 name
= stream_class
->name
->str
;
114 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
119 if (!stream_class
|| stream_class
->frozen
) {
124 g_string_assign(stream_class
->name
, name
);
129 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
130 struct bt_ctf_stream_class
*stream_class
)
132 struct bt_ctf_clock
*clock
= NULL
;
134 if (!stream_class
|| !stream_class
->clock
) {
138 clock
= stream_class
->clock
;
144 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
145 struct bt_ctf_clock
*clock
)
148 struct bt_ctf_field_type
*timestamp_field
= NULL
;
150 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
156 * Look for a "timestamp" field in the stream class' event header type
157 * and map the stream's clock to that field if no current mapping is
160 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
161 stream_class
->event_header_type
, "timestamp");
162 if (timestamp_field
) {
163 struct bt_ctf_clock
*mapped_clock
;
165 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
168 bt_put(mapped_clock
);
172 ret
= bt_ctf_field_type_integer_set_mapped_clock(
173 timestamp_field
, clock
);
179 if (stream_class
->clock
) {
180 bt_put(stream_class
->clock
);
183 stream_class
->clock
= clock
;
186 if (timestamp_field
) {
187 bt_put(timestamp_field
);
192 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
196 if (!stream_class
|| !stream_class
->id_set
) {
201 ret
= (int64_t) stream_class
->id
;
207 int _bt_ctf_stream_class_set_id(
208 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
210 stream_class
->id
= id
;
211 stream_class
->id_set
= 1;
215 struct event_class_set_stream_id_data
{
221 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
223 struct event_class_set_stream_id_data
*typed_data
= data
;
225 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
226 typed_data
->stream_id
);
230 int bt_ctf_stream_class_set_id_no_check(
231 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
234 struct event_class_set_stream_id_data data
=
235 { .stream_id
= id
, .ret
= 0 };
238 * Make sure all event classes have their "stream_id" attribute
241 g_ptr_array_foreach(stream_class
->event_classes
,
242 event_class_set_stream_id
, &data
);
248 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
256 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
261 if (!stream_class
|| stream_class
->frozen
) {
266 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
272 void event_class_exists(gpointer element
, gpointer query
)
274 struct bt_ctf_event_class
*event_class_a
= element
;
275 struct search_query
*search_query
= query
;
276 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
279 if (search_query
->value
== element
) {
280 search_query
->found
= 1;
285 * Two event classes cannot share the same name in a given
288 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
289 bt_ctf_event_class_get_name(event_class_b
))) {
290 search_query
->found
= 1;
295 * Two event classes cannot share the same ID in a given
298 id_a
= bt_ctf_event_class_get_id(event_class_a
);
299 id_b
= bt_ctf_event_class_get_id(event_class_b
);
301 if (id_a
< 0 || id_b
< 0) {
302 /* at least one ID is not set: will be automatically set later */
307 search_query
->found
= 1;
315 int bt_ctf_stream_class_add_event_class(
316 struct bt_ctf_stream_class
*stream_class
,
317 struct bt_ctf_event_class
*event_class
)
321 struct bt_ctf_trace
*trace
= NULL
;
322 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
323 struct bt_ctf_validation_output validation_output
= { 0 };
324 struct bt_ctf_field_type
*packet_header_type
= NULL
;
325 struct bt_ctf_field_type
*packet_context_type
= NULL
;
326 struct bt_ctf_field_type
*event_header_type
= NULL
;
327 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
328 struct bt_ctf_field_type
*event_context_type
= NULL
;
329 struct bt_ctf_field_type
*event_payload_type
= NULL
;
330 const enum bt_ctf_validation_flag validation_flags
=
331 BT_CTF_VALIDATION_FLAG_EVENT
;
333 if (!stream_class
|| !event_class
) {
338 /* Check for duplicate event classes */
339 struct search_query query
= { .value
= event_class
, .found
= 0 };
340 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
347 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
348 if (old_stream_class
) {
349 /* Event class is already associated to a stream class. */
354 trace
= bt_ctf_stream_class_get_trace(stream_class
);
357 * If the stream class is associated with a trace, then
358 * both those objects are frozen. Also, this event class
359 * is about to be frozen.
361 * Therefore the event class must be validated here.
362 * The trace and stream class should be valid at this
365 assert(trace
->valid
);
366 assert(stream_class
->valid
);
368 bt_ctf_trace_get_packet_header_type(trace
);
369 packet_context_type
=
370 bt_ctf_stream_class_get_packet_context_type(
373 bt_ctf_stream_class_get_event_header_type(stream_class
);
374 stream_event_ctx_type
=
375 bt_ctf_stream_class_get_event_context_type(
378 bt_ctf_event_class_get_context_type(event_class
);
380 bt_ctf_event_class_get_payload_type(event_class
);
381 ret
= bt_ctf_validate_class_types(
382 trace
->environment
, packet_header_type
,
383 packet_context_type
, event_header_type
,
384 stream_event_ctx_type
, event_context_type
,
385 event_payload_type
, trace
->valid
,
386 stream_class
->valid
, event_class
->valid
,
387 &validation_output
, validation_flags
);
388 BT_PUT(packet_header_type
);
389 BT_PUT(packet_context_type
);
390 BT_PUT(event_header_type
);
391 BT_PUT(stream_event_ctx_type
);
392 BT_PUT(event_context_type
);
393 BT_PUT(event_payload_type
);
397 * This means something went wrong during the
398 * validation process, not that the objects are
404 if ((validation_output
.valid_flags
& validation_flags
) !=
406 /* Invalid event class */
412 /* Only set an event ID if none was explicitly set before */
413 event_id
= bt_ctf_event_class_get_id(event_class
);
415 if (bt_ctf_event_class_set_id(event_class
,
416 stream_class
->next_event_id
++)) {
422 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
427 bt_object_set_parent(event_class
, stream_class
);
431 * At this point we know that the function will be
432 * successful. Therefore we can replace the event
433 * class's field types with what's in the validation
434 * output structure and mark this event class as valid.
436 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
437 &validation_output
, validation_flags
);
438 event_class
->valid
= 1;
441 * Put what was not moved in
442 * bt_ctf_validation_replace_types().
444 bt_ctf_validation_output_put_types(&validation_output
);
447 /* Add to the event classes of the stream class */
448 g_ptr_array_add(stream_class
->event_classes
, event_class
);
450 /* Freeze the event class */
451 bt_ctf_event_class_freeze(event_class
);
453 if (stream_class
->byte_order
) {
455 * Only set native byte order if it has been initialized
456 * when the stream class was added to a trace.
458 * If not set here, this will be set when the stream
459 * class is added to a trace.
461 bt_ctf_event_class_set_native_byte_order(event_class
,
462 stream_class
->byte_order
);
467 BT_PUT(old_stream_class
);
468 bt_ctf_validation_output_put_types(&validation_output
);
469 assert(!packet_header_type
);
470 assert(!packet_context_type
);
471 assert(!event_header_type
);
472 assert(!stream_event_ctx_type
);
473 assert(!event_context_type
);
474 assert(!event_payload_type
);
479 int bt_ctf_stream_class_get_event_class_count(
480 struct bt_ctf_stream_class
*stream_class
)
489 ret
= (int) stream_class
->event_classes
->len
;
494 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
495 struct bt_ctf_stream_class
*stream_class
, int index
)
497 struct bt_ctf_event_class
*event_class
= NULL
;
499 if (!stream_class
|| index
< 0 ||
500 index
>= stream_class
->event_classes
->len
) {
504 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
510 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
511 struct bt_ctf_stream_class
*stream_class
, const char *name
)
514 struct bt_ctf_event_class
*event_class
= NULL
;
516 if (!stream_class
|| !name
) {
520 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
521 struct bt_ctf_event_class
*cur_event_class
=
522 g_ptr_array_index(stream_class
->event_classes
, i
);
523 const char *cur_event_class_name
=
524 bt_ctf_event_class_get_name(cur_event_class
);
526 if (!strcmp(name
, cur_event_class_name
)) {
527 event_class
= cur_event_class
;
536 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
537 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
540 struct bt_ctf_event_class
*event_class
= NULL
;
546 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
547 struct bt_ctf_event_class
*current_event_class
=
548 g_ptr_array_index(stream_class
->event_classes
, i
);
550 if (bt_ctf_event_class_get_id(current_event_class
) == id
) {
551 event_class
= current_event_class
;
560 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
561 struct bt_ctf_stream_class
*stream_class
)
563 struct bt_ctf_field_type
*ret
= NULL
;
569 assert(stream_class
->packet_context_type
);
570 bt_get(stream_class
->packet_context_type
);
571 ret
= stream_class
->packet_context_type
;
576 int bt_ctf_stream_class_set_packet_context_type(
577 struct bt_ctf_stream_class
*stream_class
,
578 struct bt_ctf_field_type
*packet_context_type
)
582 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
587 assert(stream_class
->packet_context_type
);
588 if (stream_class
->packet_context_type
== packet_context_type
) {
591 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
592 BT_CTF_TYPE_ID_STRUCT
) {
593 /* A packet context must be a structure */
598 bt_put(stream_class
->packet_context_type
);
599 bt_get(packet_context_type
);
600 stream_class
->packet_context_type
= packet_context_type
;
605 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
606 struct bt_ctf_stream_class
*stream_class
)
608 struct bt_ctf_field_type
*ret
= NULL
;
610 if (!stream_class
|| !stream_class
->event_header_type
) {
614 assert(stream_class
->event_header_type
);
615 bt_get(stream_class
->event_header_type
);
616 ret
= stream_class
->event_header_type
;
621 int bt_ctf_stream_class_set_event_header_type(
622 struct bt_ctf_stream_class
*stream_class
,
623 struct bt_ctf_field_type
*event_header_type
)
627 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
632 assert(stream_class
->event_header_type
);
633 if (stream_class
->event_header_type
== event_header_type
) {
636 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
637 BT_CTF_TYPE_ID_STRUCT
) {
638 /* An event header must be a structure */
643 bt_put(stream_class
->event_header_type
);
644 bt_get(event_header_type
);
645 stream_class
->event_header_type
= event_header_type
;
650 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
651 struct bt_ctf_stream_class
*stream_class
)
653 struct bt_ctf_field_type
*ret
= NULL
;
655 if (!stream_class
|| !stream_class
->event_context_type
) {
659 assert(stream_class
->event_context_type
);
660 bt_get(stream_class
->event_context_type
);
661 ret
= stream_class
->event_context_type
;
666 int bt_ctf_stream_class_set_event_context_type(
667 struct bt_ctf_stream_class
*stream_class
,
668 struct bt_ctf_field_type
*event_context_type
)
672 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
677 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
678 BT_CTF_TYPE_ID_STRUCT
) {
679 /* A packet context must be a structure */
684 bt_put(stream_class
->event_context_type
);
685 bt_get(event_context_type
);
686 stream_class
->event_context_type
= event_context_type
;
691 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
693 bt_get(stream_class
);
696 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
698 bt_put(stream_class
);
702 int get_event_class_count(void *element
)
704 return bt_ctf_stream_class_get_event_class_count(
705 (struct bt_ctf_stream_class
*) element
);
709 void *get_event_class(void *element
, int i
)
711 return bt_ctf_stream_class_get_event_class(
712 (struct bt_ctf_stream_class
*) element
, i
);
716 int visit_event_class(void *element
, bt_ctf_ir_visitor visitor
,void *data
)
718 struct bt_ctf_ir_element ir_element
=
719 { .element
= element
,
720 .type
= BT_CTF_IR_TYPE_EVENT_CLASS
};
722 return visitor(&ir_element
, data
);
725 int bt_ctf_stream_class_visit(struct bt_ctf_stream_class
*stream_class
,
726 bt_ctf_ir_visitor visitor
, void *data
)
729 struct bt_ctf_ir_element element
=
730 { .element
= stream_class
,
731 .type
= BT_CTF_IR_TYPE_STREAM_CLASS
};
733 if (!stream_class
|| !visitor
) {
738 ret
= visitor_helper(&element
, get_event_class_count
,
740 visit_event_class
, visitor
, data
);
746 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
752 stream_class
->frozen
= 1;
753 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
754 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
755 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
756 bt_ctf_clock_freeze(stream_class
->clock
);
760 void bt_ctf_stream_class_set_byte_order(
761 struct bt_ctf_stream_class
*stream_class
, int byte_order
)
765 assert(stream_class
);
766 assert(byte_order
== LITTLE_ENDIAN
|| byte_order
== BIG_ENDIAN
);
767 stream_class
->byte_order
= byte_order
;
769 /* Set native byte order to little or big endian */
770 bt_ctf_field_type_set_native_byte_order(
771 stream_class
->event_header_type
, byte_order
);
772 bt_ctf_field_type_set_native_byte_order(
773 stream_class
->packet_context_type
, byte_order
);
774 bt_ctf_field_type_set_native_byte_order(
775 stream_class
->event_context_type
, byte_order
);
777 /* Set all events' native byte order */
778 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
779 struct bt_ctf_event_class
*event_class
=
780 g_ptr_array_index(stream_class
->event_classes
, i
);
782 bt_ctf_event_class_set_native_byte_order(event_class
,
788 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
789 struct metadata_context
*context
)
794 g_string_assign(context
->field_name
, "");
795 context
->current_indentation_level
= 1;
796 if (!stream_class
->id_set
) {
801 g_string_append_printf(context
->string
,
802 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
804 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
810 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
811 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
817 if (stream_class
->event_context_type
) {
818 g_string_append(context
->string
, ";\n\n\tevent.context := ");
819 ret
= bt_ctf_field_type_serialize(
820 stream_class
->event_context_type
, context
);
826 g_string_append(context
->string
, ";\n};\n\n");
827 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
828 struct bt_ctf_event_class
*event_class
=
829 stream_class
->event_classes
->pdata
[i
];
831 ret
= bt_ctf_event_class_serialize(event_class
, context
);
837 context
->current_indentation_level
= 0;
842 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
844 struct bt_ctf_stream_class
*stream_class
;
846 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
847 bt_put(stream_class
->clock
);
849 if (stream_class
->event_classes
) {
850 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
853 if (stream_class
->name
) {
854 g_string_free(stream_class
->name
, TRUE
);
857 bt_put(stream_class
->event_header_type
);
858 bt_put(stream_class
->packet_context_type
);
859 bt_put(stream_class
->event_context_type
);
860 g_free(stream_class
);
864 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
867 struct bt_ctf_field_type
*event_header_type
=
868 bt_ctf_field_type_structure_create();
869 struct bt_ctf_field_type
*_uint32_t
=
870 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
871 struct bt_ctf_field_type
*_uint64_t
=
872 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
874 if (!event_header_type
) {
879 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
885 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
886 _uint64_t
, "timestamp");
891 if (stream_class
->event_header_type
) {
892 bt_put(stream_class
->event_header_type
);
894 stream_class
->event_header_type
= event_header_type
;
897 bt_put(event_header_type
);
906 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
909 struct bt_ctf_field_type
*packet_context_type
=
910 bt_ctf_field_type_structure_create();
911 struct bt_ctf_field_type
*_uint64_t
=
912 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
914 if (!packet_context_type
) {
920 * We create a stream packet context as proposed in the CTF
923 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
924 _uint64_t
, "timestamp_begin");
929 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
930 _uint64_t
, "timestamp_end");
935 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
936 _uint64_t
, "content_size");
941 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
942 _uint64_t
, "packet_size");
947 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
948 _uint64_t
, "events_discarded");
953 bt_put(stream_class
->packet_context_type
);
954 stream_class
->packet_context_type
= packet_context_type
;
957 bt_put(packet_context_type
);