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-internal.h>
33 #include <babeltrace/ctf-ir/event-types-internal.h>
34 #include <babeltrace/ctf-ir/event-fields-internal.h>
35 #include <babeltrace/ctf-writer/stream.h>
36 #include <babeltrace/ctf-ir/stream-class-internal.h>
37 #include <babeltrace/ctf-writer/functor-internal.h>
38 #include <babeltrace/ctf-ir/utils.h>
39 #include <babeltrace/compiler.h>
40 #include <babeltrace/align.h>
43 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
);
45 int init_event_header(struct bt_ctf_stream_class
*stream_class
);
47 int init_packet_context(struct bt_ctf_stream_class
*stream_class
);
49 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
52 struct bt_ctf_stream_class
*stream_class
= NULL
;
54 if (name
&& bt_ctf_validate_identifier(name
)) {
58 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
63 stream_class
->name
= g_string_new(name
);
64 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
65 (GDestroyNotify
)bt_ctf_event_class_put
);
66 if (!stream_class
->event_classes
) {
70 ret
= init_event_header(stream_class
);
75 ret
= init_packet_context(stream_class
);
80 bt_ctf_ref_init(&stream_class
->ref_count
);
84 bt_ctf_stream_class_destroy(&stream_class
->ref_count
);
90 struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
91 struct bt_ctf_stream_class
*stream_class
)
93 struct bt_ctf_trace
*trace
= NULL
;
99 trace
= stream_class
->trace
;
101 bt_ctf_trace_get(trace
);
107 const char *bt_ctf_stream_class_get_name(
108 struct bt_ctf_stream_class
*stream_class
)
110 const char *name
= NULL
;
116 name
= stream_class
->name
->str
;
121 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
126 if (!stream_class
|| stream_class
->frozen
) {
131 g_string_assign(stream_class
->name
, name
);
136 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
137 struct bt_ctf_stream_class
*stream_class
)
139 struct bt_ctf_clock
*clock
= NULL
;
141 if (!stream_class
|| !stream_class
->clock
) {
145 clock
= stream_class
->clock
;
146 bt_ctf_clock_get(clock
);
151 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
152 struct bt_ctf_clock
*clock
)
155 struct bt_ctf_field_type
*timestamp_field
= NULL
;
157 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
163 * Look for a "timestamp" field in the stream class' event header type
164 * and map the stream's clock to that field if no current mapping is
167 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
168 stream_class
->event_header_type
, "timestamp");
169 if (timestamp_field
) {
170 struct bt_ctf_clock
*mapped_clock
;
172 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
175 bt_ctf_clock_put(mapped_clock
);
179 ret
= bt_ctf_field_type_integer_set_mapped_clock(
180 timestamp_field
, clock
);
186 if (stream_class
->clock
) {
187 bt_ctf_clock_put(stream_class
->clock
);
190 stream_class
->clock
= clock
;
191 bt_ctf_clock_get(clock
);
193 if (timestamp_field
) {
194 bt_ctf_field_type_put(timestamp_field
);
199 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
203 if (!stream_class
|| !stream_class
->id_set
) {
208 ret
= (int64_t) stream_class
->id
;
214 int _bt_ctf_stream_class_set_id(
215 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
217 stream_class
->id
= id
;
218 stream_class
->id_set
= 1;
222 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
227 if (!stream_class
|| stream_class
->frozen
) {
232 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
241 void event_class_exists(gpointer element
, gpointer query
)
243 struct bt_ctf_event_class
*event_class_a
= element
;
244 struct search_query
*search_query
= query
;
245 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
248 if (search_query
->value
== element
) {
249 search_query
->found
= 1;
254 * Two event classes cannot share the same name in a given
257 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
258 bt_ctf_event_class_get_name(event_class_b
))) {
259 search_query
->found
= 1;
264 * Two event classes cannot share the same ID in a given
267 id_a
= bt_ctf_event_class_get_id(event_class_a
);
268 id_b
= bt_ctf_event_class_get_id(event_class_b
);
270 if (id_a
< 0 || id_b
< 0) {
271 /* at least one ID is not set: will be automatically set later */
276 search_query
->found
= 1;
284 int bt_ctf_stream_class_add_event_class(
285 struct bt_ctf_stream_class
*stream_class
,
286 struct bt_ctf_event_class
*event_class
)
291 if (!stream_class
|| !event_class
) {
296 /* Check for duplicate event classes */
297 struct search_query query
= { .value
= event_class
, .found
= 0 };
298 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
305 /* Only set an event id if none was explicitly set before */
306 event_id
= bt_ctf_event_class_get_id(event_class
);
308 if (bt_ctf_event_class_set_id(event_class
,
309 stream_class
->next_event_id
++)) {
315 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
320 bt_ctf_event_class_get(event_class
);
321 g_ptr_array_add(stream_class
->event_classes
, event_class
);
322 bt_ctf_event_class_freeze(event_class
);
324 if (stream_class
->byte_order
) {
326 * Only set native byte order if it has been initialized
327 * when the stream class was added to a trace.
329 * If not set here, this will be set when the stream
330 * classe will be added to a trace.
332 bt_ctf_event_class_set_native_byte_order(event_class
,
333 stream_class
->byte_order
);
339 int bt_ctf_stream_class_get_event_class_count(
340 struct bt_ctf_stream_class
*stream_class
)
349 ret
= (int) stream_class
->event_classes
->len
;
354 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
355 struct bt_ctf_stream_class
*stream_class
, int index
)
357 struct bt_ctf_event_class
*event_class
= NULL
;
359 if (!stream_class
|| index
< 0 ||
360 index
>= stream_class
->event_classes
->len
) {
364 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
365 bt_ctf_event_class_get(event_class
);
370 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
371 struct bt_ctf_stream_class
*stream_class
, const char *name
)
374 struct bt_ctf_event_class
*event_class
= NULL
;
376 if (!stream_class
|| !name
) {
380 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
381 struct bt_ctf_event_class
*cur_event_class
=
382 g_ptr_array_index(stream_class
->event_classes
, i
);
383 const char *cur_event_class_name
=
384 bt_ctf_event_class_get_name(cur_event_class
);
386 if (!strcmp(name
, cur_event_class_name
)) {
387 event_class
= cur_event_class
;
388 bt_ctf_event_class_get(event_class
);
396 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
397 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
400 struct bt_ctf_event_class
*event_class
= NULL
;
406 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
407 struct bt_ctf_event_class
*current_event_class
=
408 g_ptr_array_index(stream_class
->event_classes
, i
);
410 if (bt_ctf_event_class_get_id(current_event_class
) == id
) {
411 event_class
= current_event_class
;
412 bt_ctf_event_class_get(event_class
);
420 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
421 struct bt_ctf_stream_class
*stream_class
)
423 struct bt_ctf_field_type
*ret
= NULL
;
429 assert(stream_class
->packet_context_type
);
430 bt_ctf_field_type_get(stream_class
->packet_context_type
);
431 ret
= stream_class
->packet_context_type
;
436 int bt_ctf_stream_class_set_packet_context_type(
437 struct bt_ctf_stream_class
*stream_class
,
438 struct bt_ctf_field_type
*packet_context_type
)
442 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
447 assert(stream_class
->packet_context_type
);
448 if (stream_class
->packet_context_type
== packet_context_type
) {
451 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
453 /* A packet context must be a structure */
458 bt_ctf_field_type_put(stream_class
->packet_context_type
);
459 bt_ctf_field_type_get(packet_context_type
);
460 stream_class
->packet_context_type
= packet_context_type
;
465 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
466 struct bt_ctf_stream_class
*stream_class
)
468 struct bt_ctf_field_type
*ret
= NULL
;
470 if (!stream_class
|| !stream_class
->event_header_type
) {
474 assert(stream_class
->event_header_type
);
475 bt_ctf_field_type_get(stream_class
->event_header_type
);
476 ret
= stream_class
->event_header_type
;
481 int bt_ctf_stream_class_set_event_header_type(
482 struct bt_ctf_stream_class
*stream_class
,
483 struct bt_ctf_field_type
*event_header_type
)
487 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
492 assert(stream_class
->event_header_type
);
493 if (stream_class
->event_header_type
== event_header_type
) {
496 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
498 /* An event header must be a structure */
503 bt_ctf_field_type_put(stream_class
->event_header_type
);
504 bt_ctf_field_type_get(event_header_type
);
505 stream_class
->event_header_type
= event_header_type
;
510 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
511 struct bt_ctf_stream_class
*stream_class
)
513 struct bt_ctf_field_type
*ret
= NULL
;
515 if (!stream_class
|| !stream_class
->event_context_type
) {
519 assert(stream_class
->event_context_type
);
520 bt_ctf_field_type_get(stream_class
->event_context_type
);
521 ret
= stream_class
->event_context_type
;
526 int bt_ctf_stream_class_set_event_context_type(
527 struct bt_ctf_stream_class
*stream_class
,
528 struct bt_ctf_field_type
*event_context_type
)
532 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
537 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
539 /* A packet context must be a structure */
544 bt_ctf_field_type_put(stream_class
->event_context_type
);
545 bt_ctf_field_type_get(event_context_type
);
546 stream_class
->event_context_type
= event_context_type
;
551 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
557 bt_ctf_ref_get(&stream_class
->ref_count
);
560 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
566 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
570 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
576 stream_class
->frozen
= 1;
577 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
578 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
579 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
580 bt_ctf_clock_freeze(stream_class
->clock
);
584 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
585 enum bt_ctf_byte_order byte_order
)
588 int internal_byte_order
;
590 /* Note that "NATIVE" means the trace's endianness, not the host's. */
591 if (!stream_class
|| byte_order
<= BT_CTF_BYTE_ORDER_UNKNOWN
||
592 byte_order
> BT_CTF_BYTE_ORDER_NETWORK
) {
597 switch (byte_order
) {
598 case BT_CTF_BYTE_ORDER_NETWORK
:
599 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
600 internal_byte_order
= BIG_ENDIAN
;
602 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
603 internal_byte_order
= LITTLE_ENDIAN
;
610 stream_class
->byte_order
= internal_byte_order
;
612 /* Set native byte order to little or big endian */
613 bt_ctf_field_type_set_native_byte_order(
614 stream_class
->event_header_type
, stream_class
->byte_order
);
615 bt_ctf_field_type_set_native_byte_order(
616 stream_class
->packet_context_type
, stream_class
->byte_order
);
617 bt_ctf_field_type_set_native_byte_order(
618 stream_class
->event_context_type
, stream_class
->byte_order
);
620 /* Set all events' native byte order */
621 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
622 bt_ctf_event_class_set_native_byte_order(
623 g_ptr_array_index(stream_class
->event_classes
, i
),
624 stream_class
->byte_order
);
625 bt_ctf_event_class_freeze(
626 g_ptr_array_index(stream_class
->event_classes
, i
));
633 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
634 struct metadata_context
*context
)
639 g_string_assign(context
->field_name
, "");
640 context
->current_indentation_level
= 1;
641 if (!stream_class
->id_set
) {
646 g_string_append_printf(context
->string
,
647 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
649 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
655 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
656 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
662 if (stream_class
->event_context_type
) {
663 g_string_append(context
->string
, ";\n\n\tevent.context := ");
664 ret
= bt_ctf_field_type_serialize(
665 stream_class
->event_context_type
, context
);
671 g_string_append(context
->string
, ";\n};\n\n");
672 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
673 struct bt_ctf_event_class
*event_class
=
674 stream_class
->event_classes
->pdata
[i
];
676 ret
= bt_ctf_event_class_serialize(event_class
, context
);
682 context
->current_indentation_level
= 0;
687 int bt_ctf_stream_class_set_trace(struct bt_ctf_stream_class
*stream_class
,
688 struct bt_ctf_trace
*trace
)
697 if (stream_class
->trace
&& trace
) {
698 /* Already attached to a trace */
703 stream_class
->trace
= trace
;
709 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
711 struct bt_ctf_stream_class
*stream_class
;
717 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
718 bt_ctf_clock_put(stream_class
->clock
);
720 if (stream_class
->event_classes
) {
723 /* Unregister this stream class from the event classes */
724 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
725 struct bt_ctf_event_class
*event_class
=
726 g_ptr_array_index(stream_class
->event_classes
,
729 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
732 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
735 if (stream_class
->name
) {
736 g_string_free(stream_class
->name
, TRUE
);
739 bt_ctf_field_type_put(stream_class
->event_header_type
);
740 bt_ctf_field_type_put(stream_class
->packet_context_type
);
741 if (stream_class
->event_context_type
) {
742 bt_ctf_field_type_put(stream_class
->event_context_type
);
744 g_free(stream_class
);
748 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
751 struct bt_ctf_field_type
*event_header_type
=
752 bt_ctf_field_type_structure_create();
753 struct bt_ctf_field_type
*_uint32_t
=
754 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
755 struct bt_ctf_field_type
*_uint64_t
=
756 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
758 if (!event_header_type
) {
763 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
769 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
770 _uint64_t
, "timestamp");
775 if (stream_class
->event_header_type
) {
776 bt_ctf_field_type_put(stream_class
->event_header_type
);
778 stream_class
->event_header_type
= event_header_type
;
781 bt_ctf_field_type_put(event_header_type
);
784 bt_ctf_field_type_put(_uint32_t
);
785 bt_ctf_field_type_put(_uint64_t
);
790 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
793 struct bt_ctf_field_type
*packet_context_type
=
794 bt_ctf_field_type_structure_create();
795 struct bt_ctf_field_type
*_uint64_t
=
796 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
798 if (!packet_context_type
) {
804 * We create a stream packet context as proposed in the CTF
807 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
808 _uint64_t
, "timestamp_begin");
813 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
814 _uint64_t
, "timestamp_end");
819 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
820 _uint64_t
, "content_size");
825 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
826 _uint64_t
, "packet_size");
831 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
832 _uint64_t
, "events_discarded");
837 if (stream_class
->packet_context_type
) {
838 bt_ctf_field_type_put(stream_class
->packet_context_type
);
840 stream_class
->packet_context_type
= packet_context_type
;
843 bt_ctf_field_type_put(packet_context_type
);
847 bt_ctf_field_type_put(_uint64_t
);