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
|| stream_class
->frozen
||
151 !bt_ctf_clock_is_valid(clock
)) {
157 * Look for a "timestamp" field in the stream class' event header type
158 * and map the stream's clock to that field if no current mapping is
161 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
162 stream_class
->event_header_type
, "timestamp");
163 if (timestamp_field
) {
164 struct bt_ctf_clock
*mapped_clock
;
166 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
169 bt_put(mapped_clock
);
173 ret
= bt_ctf_field_type_integer_set_mapped_clock(
174 timestamp_field
, clock
);
180 if (stream_class
->clock
) {
181 bt_put(stream_class
->clock
);
184 stream_class
->clock
= clock
;
187 if (timestamp_field
) {
188 bt_put(timestamp_field
);
193 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
197 if (!stream_class
|| !stream_class
->id_set
) {
202 ret
= (int64_t) stream_class
->id
;
208 int _bt_ctf_stream_class_set_id(
209 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
211 stream_class
->id
= id
;
212 stream_class
->id_set
= 1;
216 struct event_class_set_stream_id_data
{
222 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
224 struct event_class_set_stream_id_data
*typed_data
= data
;
226 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
227 typed_data
->stream_id
);
231 int bt_ctf_stream_class_set_id_no_check(
232 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
235 struct event_class_set_stream_id_data data
=
236 { .stream_id
= id
, .ret
= 0 };
239 * Make sure all event classes have their "stream_id" attribute
242 g_ptr_array_foreach(stream_class
->event_classes
,
243 event_class_set_stream_id
, &data
);
249 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
257 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
262 if (!stream_class
|| stream_class
->frozen
) {
267 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
273 void event_class_exists(gpointer element
, gpointer query
)
275 struct bt_ctf_event_class
*event_class_a
= element
;
276 struct search_query
*search_query
= query
;
277 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
280 if (search_query
->value
== element
) {
281 search_query
->found
= 1;
286 * Two event classes cannot share the same name in a given
289 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
290 bt_ctf_event_class_get_name(event_class_b
))) {
291 search_query
->found
= 1;
296 * Two event classes cannot share the same ID in a given
299 id_a
= bt_ctf_event_class_get_id(event_class_a
);
300 id_b
= bt_ctf_event_class_get_id(event_class_b
);
302 if (id_a
< 0 || id_b
< 0) {
303 /* at least one ID is not set: will be automatically set later */
308 search_query
->found
= 1;
316 int bt_ctf_stream_class_add_event_class(
317 struct bt_ctf_stream_class
*stream_class
,
318 struct bt_ctf_event_class
*event_class
)
322 struct bt_ctf_trace
*trace
= NULL
;
323 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
324 struct bt_ctf_validation_output validation_output
= { 0 };
325 struct bt_ctf_field_type
*packet_header_type
= NULL
;
326 struct bt_ctf_field_type
*packet_context_type
= NULL
;
327 struct bt_ctf_field_type
*event_header_type
= NULL
;
328 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
329 struct bt_ctf_field_type
*event_context_type
= NULL
;
330 struct bt_ctf_field_type
*event_payload_type
= NULL
;
331 const enum bt_ctf_validation_flag validation_flags
=
332 BT_CTF_VALIDATION_FLAG_EVENT
;
334 if (!stream_class
|| !event_class
) {
339 /* Check for duplicate event classes */
340 struct search_query query
= { .value
= event_class
, .found
= 0 };
341 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
348 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
349 if (old_stream_class
) {
350 /* Event class is already associated to a stream class. */
355 trace
= bt_ctf_stream_class_get_trace(stream_class
);
358 * If the stream class is associated with a trace, then
359 * both those objects are frozen. Also, this event class
360 * is about to be frozen.
362 * Therefore the event class must be validated here.
363 * The trace and stream class should be valid at this
366 assert(trace
->valid
);
367 assert(stream_class
->valid
);
369 bt_ctf_trace_get_packet_header_type(trace
);
370 packet_context_type
=
371 bt_ctf_stream_class_get_packet_context_type(
374 bt_ctf_stream_class_get_event_header_type(stream_class
);
375 stream_event_ctx_type
=
376 bt_ctf_stream_class_get_event_context_type(
379 bt_ctf_event_class_get_context_type(event_class
);
381 bt_ctf_event_class_get_payload_type(event_class
);
382 ret
= bt_ctf_validate_class_types(
383 trace
->environment
, packet_header_type
,
384 packet_context_type
, event_header_type
,
385 stream_event_ctx_type
, event_context_type
,
386 event_payload_type
, trace
->valid
,
387 stream_class
->valid
, event_class
->valid
,
388 &validation_output
, validation_flags
);
389 BT_PUT(packet_header_type
);
390 BT_PUT(packet_context_type
);
391 BT_PUT(event_header_type
);
392 BT_PUT(stream_event_ctx_type
);
393 BT_PUT(event_context_type
);
394 BT_PUT(event_payload_type
);
398 * This means something went wrong during the
399 * validation process, not that the objects are
405 if ((validation_output
.valid_flags
& validation_flags
) !=
407 /* Invalid event class */
413 /* Only set an event ID if none was explicitly set before */
414 event_id
= bt_ctf_event_class_get_id(event_class
);
416 if (bt_ctf_event_class_set_id(event_class
,
417 stream_class
->next_event_id
++)) {
423 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
428 bt_object_set_parent(event_class
, stream_class
);
432 * At this point we know that the function will be
433 * successful. Therefore we can replace the event
434 * class's field types with what's in the validation
435 * output structure and mark this event class as valid.
437 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
438 &validation_output
, validation_flags
);
439 event_class
->valid
= 1;
442 * Put what was not moved in
443 * bt_ctf_validation_replace_types().
445 bt_ctf_validation_output_put_types(&validation_output
);
448 /* Add to the event classes of the stream class */
449 g_ptr_array_add(stream_class
->event_classes
, event_class
);
451 /* Freeze the event class */
452 bt_ctf_event_class_freeze(event_class
);
454 if (stream_class
->byte_order
) {
456 * Only set native byte order if it has been initialized
457 * when the stream class was added to a trace.
459 * If not set here, this will be set when the stream
460 * class is added to a trace.
462 bt_ctf_event_class_set_native_byte_order(event_class
,
463 stream_class
->byte_order
);
466 /* Notifiy listeners of the trace's schema modification. */
468 struct bt_ctf_ir_element element
= { .element
= event_class
,
469 .type
= BT_CTF_IR_TYPE_EVENT_CLASS
};
471 (void) bt_ctf_trace_element_modification(&element
, trace
);
475 BT_PUT(old_stream_class
);
476 bt_ctf_validation_output_put_types(&validation_output
);
477 assert(!packet_header_type
);
478 assert(!packet_context_type
);
479 assert(!event_header_type
);
480 assert(!stream_event_ctx_type
);
481 assert(!event_context_type
);
482 assert(!event_payload_type
);
487 int bt_ctf_stream_class_get_event_class_count(
488 struct bt_ctf_stream_class
*stream_class
)
497 ret
= (int) stream_class
->event_classes
->len
;
502 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
503 struct bt_ctf_stream_class
*stream_class
, int index
)
505 struct bt_ctf_event_class
*event_class
= NULL
;
507 if (!stream_class
|| index
< 0 ||
508 index
>= stream_class
->event_classes
->len
) {
512 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
518 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
519 struct bt_ctf_stream_class
*stream_class
, const char *name
)
522 struct bt_ctf_event_class
*event_class
= NULL
;
524 if (!stream_class
|| !name
) {
528 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
529 struct bt_ctf_event_class
*cur_event_class
=
530 g_ptr_array_index(stream_class
->event_classes
, i
);
531 const char *cur_event_class_name
=
532 bt_ctf_event_class_get_name(cur_event_class
);
534 if (!strcmp(name
, cur_event_class_name
)) {
535 event_class
= cur_event_class
;
544 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
545 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
548 struct bt_ctf_event_class
*event_class
= NULL
;
554 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
555 struct bt_ctf_event_class
*current_event_class
=
556 g_ptr_array_index(stream_class
->event_classes
, i
);
558 if (bt_ctf_event_class_get_id(current_event_class
) == id
) {
559 event_class
= current_event_class
;
568 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
569 struct bt_ctf_stream_class
*stream_class
)
571 struct bt_ctf_field_type
*ret
= NULL
;
577 assert(stream_class
->packet_context_type
);
578 bt_get(stream_class
->packet_context_type
);
579 ret
= stream_class
->packet_context_type
;
584 int bt_ctf_stream_class_set_packet_context_type(
585 struct bt_ctf_stream_class
*stream_class
,
586 struct bt_ctf_field_type
*packet_context_type
)
590 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
595 assert(stream_class
->packet_context_type
);
596 if (stream_class
->packet_context_type
== packet_context_type
) {
599 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
600 BT_CTF_TYPE_ID_STRUCT
) {
601 /* A packet context must be a structure */
606 bt_put(stream_class
->packet_context_type
);
607 bt_get(packet_context_type
);
608 stream_class
->packet_context_type
= packet_context_type
;
613 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
614 struct bt_ctf_stream_class
*stream_class
)
616 struct bt_ctf_field_type
*ret
= NULL
;
618 if (!stream_class
|| !stream_class
->event_header_type
) {
622 assert(stream_class
->event_header_type
);
623 bt_get(stream_class
->event_header_type
);
624 ret
= stream_class
->event_header_type
;
629 int bt_ctf_stream_class_set_event_header_type(
630 struct bt_ctf_stream_class
*stream_class
,
631 struct bt_ctf_field_type
*event_header_type
)
635 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
640 assert(stream_class
->event_header_type
);
641 if (stream_class
->event_header_type
== event_header_type
) {
644 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
645 BT_CTF_TYPE_ID_STRUCT
) {
646 /* An event header must be a structure */
651 bt_put(stream_class
->event_header_type
);
652 bt_get(event_header_type
);
653 stream_class
->event_header_type
= event_header_type
;
658 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
659 struct bt_ctf_stream_class
*stream_class
)
661 struct bt_ctf_field_type
*ret
= NULL
;
663 if (!stream_class
|| !stream_class
->event_context_type
) {
667 assert(stream_class
->event_context_type
);
668 bt_get(stream_class
->event_context_type
);
669 ret
= stream_class
->event_context_type
;
674 int bt_ctf_stream_class_set_event_context_type(
675 struct bt_ctf_stream_class
*stream_class
,
676 struct bt_ctf_field_type
*event_context_type
)
680 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
685 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
686 BT_CTF_TYPE_ID_STRUCT
) {
687 /* A packet context must be a structure */
692 bt_put(stream_class
->event_context_type
);
693 bt_get(event_context_type
);
694 stream_class
->event_context_type
= event_context_type
;
699 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
701 bt_get(stream_class
);
704 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
706 bt_put(stream_class
);
710 int get_event_class_count(void *element
)
712 return bt_ctf_stream_class_get_event_class_count(
713 (struct bt_ctf_stream_class
*) element
);
717 void *get_event_class(void *element
, int i
)
719 return bt_ctf_stream_class_get_event_class(
720 (struct bt_ctf_stream_class
*) element
, i
);
724 int visit_event_class(void *element
, bt_ctf_ir_visitor visitor
,void *data
)
726 struct bt_ctf_ir_element ir_element
=
727 { .element
= element
,
728 .type
= BT_CTF_IR_TYPE_EVENT_CLASS
};
730 return visitor(&ir_element
, data
);
733 int bt_ctf_stream_class_visit(struct bt_ctf_stream_class
*stream_class
,
734 bt_ctf_ir_visitor visitor
, void *data
)
737 struct bt_ctf_ir_element element
=
738 { .element
= stream_class
,
739 .type
= BT_CTF_IR_TYPE_STREAM_CLASS
};
741 if (!stream_class
|| !visitor
) {
746 ret
= visitor_helper(&element
, get_event_class_count
,
748 visit_event_class
, visitor
, data
);
754 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
760 stream_class
->frozen
= 1;
761 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
762 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
763 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
764 bt_ctf_clock_freeze(stream_class
->clock
);
768 void bt_ctf_stream_class_set_byte_order(
769 struct bt_ctf_stream_class
*stream_class
, int byte_order
)
773 assert(stream_class
);
774 assert(byte_order
== LITTLE_ENDIAN
|| byte_order
== BIG_ENDIAN
);
775 stream_class
->byte_order
= byte_order
;
777 /* Set native byte order to little or big endian */
778 bt_ctf_field_type_set_native_byte_order(
779 stream_class
->event_header_type
, byte_order
);
780 bt_ctf_field_type_set_native_byte_order(
781 stream_class
->packet_context_type
, byte_order
);
782 bt_ctf_field_type_set_native_byte_order(
783 stream_class
->event_context_type
, byte_order
);
785 /* Set all events' native byte order */
786 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
787 struct bt_ctf_event_class
*event_class
=
788 g_ptr_array_index(stream_class
->event_classes
, i
);
790 bt_ctf_event_class_set_native_byte_order(event_class
,
796 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
797 struct metadata_context
*context
)
802 g_string_assign(context
->field_name
, "");
803 context
->current_indentation_level
= 1;
804 if (!stream_class
->id_set
) {
809 g_string_append_printf(context
->string
,
810 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
812 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
818 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
819 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
825 if (stream_class
->event_context_type
) {
826 g_string_append(context
->string
, ";\n\n\tevent.context := ");
827 ret
= bt_ctf_field_type_serialize(
828 stream_class
->event_context_type
, context
);
834 g_string_append(context
->string
, ";\n};\n\n");
835 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
836 struct bt_ctf_event_class
*event_class
=
837 stream_class
->event_classes
->pdata
[i
];
839 ret
= bt_ctf_event_class_serialize(event_class
, context
);
845 context
->current_indentation_level
= 0;
850 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
852 struct bt_ctf_stream_class
*stream_class
;
854 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
855 bt_put(stream_class
->clock
);
857 if (stream_class
->event_classes
) {
858 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
861 if (stream_class
->name
) {
862 g_string_free(stream_class
->name
, TRUE
);
865 bt_put(stream_class
->event_header_type
);
866 bt_put(stream_class
->packet_context_type
);
867 bt_put(stream_class
->event_context_type
);
868 g_free(stream_class
);
872 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
875 struct bt_ctf_field_type
*event_header_type
=
876 bt_ctf_field_type_structure_create();
877 struct bt_ctf_field_type
*_uint32_t
=
878 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
879 struct bt_ctf_field_type
*_uint64_t
=
880 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
882 if (!event_header_type
) {
887 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
893 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
894 _uint64_t
, "timestamp");
899 if (stream_class
->event_header_type
) {
900 bt_put(stream_class
->event_header_type
);
902 stream_class
->event_header_type
= event_header_type
;
905 bt_put(event_header_type
);
914 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
917 struct bt_ctf_field_type
*packet_context_type
=
918 bt_ctf_field_type_structure_create();
919 struct bt_ctf_field_type
*_uint64_t
=
920 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
922 if (!packet_context_type
) {
928 * We create a stream packet context as proposed in the CTF
931 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
932 _uint64_t
, "timestamp_begin");
937 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
938 _uint64_t
, "timestamp_end");
943 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
944 _uint64_t
, "content_size");
949 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
950 _uint64_t
, "packet_size");
955 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
956 _uint64_t
, "events_discarded");
961 bt_put(stream_class
->packet_context_type
);
962 stream_class
->packet_context_type
= packet_context_type
;
965 bt_put(packet_context_type
);