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
);
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(
101 const char *bt_ctf_stream_class_get_name(
102 struct bt_ctf_stream_class
*stream_class
)
104 const char *name
= NULL
;
110 name
= stream_class
->name
->str
;
116 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
121 if (!stream_class
|| stream_class
->frozen
) {
126 g_string_assign(stream_class
->name
, name
);
132 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
133 struct bt_ctf_stream_class
*stream_class
)
135 struct bt_ctf_clock
*clock
= NULL
;
137 if (!stream_class
|| !stream_class
->clock
) {
141 clock
= stream_class
->clock
;
147 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
148 struct bt_ctf_clock
*clock
)
151 struct bt_ctf_field_type
*timestamp_field
= NULL
;
153 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
159 * Look for a "timestamp" field in the stream class' event header type
160 * and map the stream's clock to that field if no current mapping is
163 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
164 stream_class
->event_header_type
, "timestamp");
165 if (timestamp_field
) {
166 struct bt_ctf_clock
*mapped_clock
;
168 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
171 bt_put(mapped_clock
);
175 ret
= bt_ctf_field_type_integer_set_mapped_clock(
176 timestamp_field
, clock
);
182 if (stream_class
->clock
) {
183 bt_put(stream_class
->clock
);
186 stream_class
->clock
= clock
;
189 if (timestamp_field
) {
190 bt_put(timestamp_field
);
196 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
200 if (!stream_class
|| !stream_class
->id_set
) {
205 ret
= (int64_t) stream_class
->id
;
211 int _bt_ctf_stream_class_set_id(
212 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
214 stream_class
->id
= id
;
215 stream_class
->id_set
= 1;
219 struct event_class_set_stream_id_data
{
225 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
227 struct event_class_set_stream_id_data
*typed_data
= data
;
229 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
230 typed_data
->stream_id
);
234 int bt_ctf_stream_class_set_id_no_check(
235 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
238 struct event_class_set_stream_id_data data
=
239 { .stream_id
= id
, .ret
= 0 };
242 * Make sure all event classes have their "stream_id" attribute
245 g_ptr_array_foreach(stream_class
->event_classes
,
246 event_class_set_stream_id
, &data
);
252 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
260 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
265 if (!stream_class
|| stream_class
->frozen
) {
270 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
276 void event_class_exists(gpointer element
, gpointer query
)
278 struct bt_ctf_event_class
*event_class_a
= element
;
279 struct search_query
*search_query
= query
;
280 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
283 if (search_query
->value
== element
) {
284 search_query
->found
= 1;
289 * Two event classes cannot share the same name in a given
292 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
293 bt_ctf_event_class_get_name(event_class_b
))) {
294 search_query
->found
= 1;
299 * Two event classes cannot share the same ID in a given
302 id_a
= bt_ctf_event_class_get_id(event_class_a
);
303 id_b
= bt_ctf_event_class_get_id(event_class_b
);
305 if (id_a
< 0 || id_b
< 0) {
306 /* at least one ID is not set: will be automatically set later */
311 search_query
->found
= 1;
319 int bt_ctf_stream_class_add_event_class(
320 struct bt_ctf_stream_class
*stream_class
,
321 struct bt_ctf_event_class
*event_class
)
325 struct bt_ctf_trace
*trace
= NULL
;
326 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
327 struct bt_ctf_validation_output validation_output
= { 0 };
328 struct bt_ctf_field_type
*packet_header_type
= NULL
;
329 struct bt_ctf_field_type
*packet_context_type
= NULL
;
330 struct bt_ctf_field_type
*event_header_type
= NULL
;
331 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
332 struct bt_ctf_field_type
*event_context_type
= NULL
;
333 struct bt_ctf_field_type
*event_payload_type
= NULL
;
334 const enum bt_ctf_validation_flag validation_flags
=
335 BT_CTF_VALIDATION_FLAG_EVENT
;
337 if (!stream_class
|| !event_class
) {
342 /* Check for duplicate event classes */
343 struct search_query query
= { .value
= event_class
, .found
= 0 };
344 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
351 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
352 if (old_stream_class
) {
353 /* Event class is already associated to a stream class. */
358 trace
= bt_ctf_stream_class_get_trace(stream_class
);
361 * If the stream class is associated with a trace, then
362 * both those objects are frozen. Also, this event class
363 * is about to be frozen.
365 * Therefore the event class must be validated here.
366 * The trace and stream class should be valid at this
369 assert(trace
->valid
);
370 assert(stream_class
->valid
);
372 bt_ctf_trace_get_packet_header_type(trace
);
373 packet_context_type
=
374 bt_ctf_stream_class_get_packet_context_type(
377 bt_ctf_stream_class_get_event_header_type(stream_class
);
378 stream_event_ctx_type
=
379 bt_ctf_stream_class_get_event_context_type(
382 bt_ctf_event_class_get_context_type(event_class
);
384 bt_ctf_event_class_get_payload_type(event_class
);
385 ret
= bt_ctf_validate_class_types(
386 trace
->environment
, packet_header_type
,
387 packet_context_type
, event_header_type
,
388 stream_event_ctx_type
, event_context_type
,
389 event_payload_type
, trace
->valid
,
390 stream_class
->valid
, event_class
->valid
,
391 &validation_output
, validation_flags
);
392 BT_PUT(packet_header_type
);
393 BT_PUT(packet_context_type
);
394 BT_PUT(event_header_type
);
395 BT_PUT(stream_event_ctx_type
);
396 BT_PUT(event_context_type
);
397 BT_PUT(event_payload_type
);
401 * This means something went wrong during the
402 * validation process, not that the objects are
408 if ((validation_output
.valid_flags
& validation_flags
) !=
410 /* Invalid event class */
416 /* Only set an event ID if none was explicitly set before */
417 event_id
= bt_ctf_event_class_get_id(event_class
);
419 if (bt_ctf_event_class_set_id(event_class
,
420 stream_class
->next_event_id
++)) {
426 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
431 bt_object_set_parent(event_class
, stream_class
);
435 * At this point we know that the function will be
436 * successful. Therefore we can replace the event
437 * class's field types with what's in the validation
438 * output structure and mark this event class as valid.
440 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
441 &validation_output
, validation_flags
);
442 event_class
->valid
= 1;
445 * Put what was not moved in
446 * bt_ctf_validation_replace_types().
448 bt_ctf_validation_output_put_types(&validation_output
);
451 /* Add to the event classes of the stream class */
452 g_ptr_array_add(stream_class
->event_classes
, event_class
);
454 /* Freeze the event class */
455 bt_ctf_event_class_freeze(event_class
);
457 if (stream_class
->byte_order
) {
459 * Only set native byte order if it has been initialized
460 * when the stream class was added to a trace.
462 * If not set here, this will be set when the stream
463 * class is added to a trace.
465 bt_ctf_event_class_set_native_byte_order(event_class
,
466 stream_class
->byte_order
);
471 BT_PUT(old_stream_class
);
472 bt_ctf_validation_output_put_types(&validation_output
);
473 assert(!packet_header_type
);
474 assert(!packet_context_type
);
475 assert(!event_header_type
);
476 assert(!stream_event_ctx_type
);
477 assert(!event_context_type
);
478 assert(!event_payload_type
);
484 int bt_ctf_stream_class_get_event_class_count(
485 struct bt_ctf_stream_class
*stream_class
)
494 ret
= (int) stream_class
->event_classes
->len
;
500 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
501 struct bt_ctf_stream_class
*stream_class
, int index
)
503 struct bt_ctf_event_class
*event_class
= NULL
;
505 if (!stream_class
|| index
< 0 ||
506 index
>= stream_class
->event_classes
->len
) {
510 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
517 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
518 struct bt_ctf_stream_class
*stream_class
, const char *name
)
521 struct bt_ctf_event_class
*event_class
= NULL
;
523 if (!stream_class
|| !name
) {
527 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
528 struct bt_ctf_event_class
*cur_event_class
=
529 g_ptr_array_index(stream_class
->event_classes
, i
);
530 const char *cur_event_class_name
=
531 bt_ctf_event_class_get_name(cur_event_class
);
533 if (!strcmp(name
, cur_event_class_name
)) {
534 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
;
614 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
615 struct bt_ctf_stream_class
*stream_class
)
617 struct bt_ctf_field_type
*ret
= NULL
;
619 if (!stream_class
|| !stream_class
->event_header_type
) {
623 assert(stream_class
->event_header_type
);
624 bt_get(stream_class
->event_header_type
);
625 ret
= stream_class
->event_header_type
;
631 int bt_ctf_stream_class_set_event_header_type(
632 struct bt_ctf_stream_class
*stream_class
,
633 struct bt_ctf_field_type
*event_header_type
)
637 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
642 assert(stream_class
->event_header_type
);
643 if (stream_class
->event_header_type
== event_header_type
) {
646 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
647 BT_CTF_TYPE_ID_STRUCT
) {
648 /* An event header must be a structure */
653 bt_put(stream_class
->event_header_type
);
654 bt_get(event_header_type
);
655 stream_class
->event_header_type
= event_header_type
;
661 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
662 struct bt_ctf_stream_class
*stream_class
)
664 struct bt_ctf_field_type
*ret
= NULL
;
666 if (!stream_class
|| !stream_class
->event_context_type
) {
670 assert(stream_class
->event_context_type
);
671 bt_get(stream_class
->event_context_type
);
672 ret
= stream_class
->event_context_type
;
678 int bt_ctf_stream_class_set_event_context_type(
679 struct bt_ctf_stream_class
*stream_class
,
680 struct bt_ctf_field_type
*event_context_type
)
684 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
689 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
690 BT_CTF_TYPE_ID_STRUCT
) {
691 /* A packet context must be a structure */
696 bt_put(stream_class
->event_context_type
);
697 bt_get(event_context_type
);
698 stream_class
->event_context_type
= event_context_type
;
703 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
705 bt_get(stream_class
);
708 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
710 bt_put(stream_class
);
714 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
720 stream_class
->frozen
= 1;
721 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
722 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
723 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
724 bt_ctf_clock_freeze(stream_class
->clock
);
728 void bt_ctf_stream_class_set_byte_order(
729 struct bt_ctf_stream_class
*stream_class
, int byte_order
)
733 assert(stream_class
);
734 assert(byte_order
== LITTLE_ENDIAN
|| byte_order
== BIG_ENDIAN
);
735 stream_class
->byte_order
= byte_order
;
737 /* Set native byte order to little or big endian */
738 bt_ctf_field_type_set_native_byte_order(
739 stream_class
->event_header_type
, byte_order
);
740 bt_ctf_field_type_set_native_byte_order(
741 stream_class
->packet_context_type
, byte_order
);
742 bt_ctf_field_type_set_native_byte_order(
743 stream_class
->event_context_type
, byte_order
);
745 /* Set all events' native byte order */
746 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
747 struct bt_ctf_event_class
*event_class
=
748 g_ptr_array_index(stream_class
->event_classes
, i
);
750 bt_ctf_event_class_set_native_byte_order(event_class
,
756 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
757 struct metadata_context
*context
)
762 g_string_assign(context
->field_name
, "");
763 context
->current_indentation_level
= 1;
764 if (!stream_class
->id_set
) {
769 g_string_append_printf(context
->string
,
770 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
772 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
778 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
779 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
785 if (stream_class
->event_context_type
) {
786 g_string_append(context
->string
, ";\n\n\tevent.context := ");
787 ret
= bt_ctf_field_type_serialize(
788 stream_class
->event_context_type
, context
);
794 g_string_append(context
->string
, ";\n};\n\n");
795 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
796 struct bt_ctf_event_class
*event_class
=
797 stream_class
->event_classes
->pdata
[i
];
799 ret
= bt_ctf_event_class_serialize(event_class
, context
);
805 context
->current_indentation_level
= 0;
810 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
812 struct bt_ctf_stream_class
*stream_class
;
814 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
815 bt_put(stream_class
->clock
);
817 if (stream_class
->event_classes
) {
818 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
821 if (stream_class
->name
) {
822 g_string_free(stream_class
->name
, TRUE
);
825 bt_put(stream_class
->event_header_type
);
826 bt_put(stream_class
->packet_context_type
);
827 bt_put(stream_class
->event_context_type
);
828 g_free(stream_class
);
832 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
835 struct bt_ctf_field_type
*event_header_type
=
836 bt_ctf_field_type_structure_create();
837 struct bt_ctf_field_type
*_uint32_t
=
838 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
839 struct bt_ctf_field_type
*_uint64_t
=
840 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
842 if (!event_header_type
) {
847 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
853 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
854 _uint64_t
, "timestamp");
859 if (stream_class
->event_header_type
) {
860 bt_put(stream_class
->event_header_type
);
862 stream_class
->event_header_type
= event_header_type
;
865 bt_put(event_header_type
);
874 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
877 struct bt_ctf_field_type
*packet_context_type
=
878 bt_ctf_field_type_structure_create();
879 struct bt_ctf_field_type
*_uint64_t
=
880 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
882 if (!packet_context_type
) {
888 * We create a stream packet context as proposed in the CTF
891 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
892 _uint64_t
, "timestamp_begin");
897 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
898 _uint64_t
, "timestamp_end");
903 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
904 _uint64_t
, "content_size");
909 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
910 _uint64_t
, "packet_size");
915 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
916 _uint64_t
, "events_discarded");
921 bt_put(stream_class
->packet_context_type
);
922 stream_class
->packet_context_type
= packet_context_type
;
925 bt_put(packet_context_type
);