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
|| !strlen(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 const char *bt_ctf_stream_class_get_name(
91 struct bt_ctf_stream_class
*stream_class
)
93 const char *name
= NULL
;
99 name
= stream_class
->name
->str
;
104 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
105 struct bt_ctf_stream_class
*stream_class
)
107 struct bt_ctf_clock
*clock
= NULL
;
109 if (!stream_class
|| !stream_class
->clock
) {
113 clock
= stream_class
->clock
;
114 bt_ctf_clock_get(clock
);
119 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
120 struct bt_ctf_clock
*clock
)
123 struct bt_ctf_field_type
*timestamp_field
= NULL
;
125 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
131 * Look for a "timestamp" field in the stream class' event header type
132 * and map the stream's clock to that field if no current mapping is
135 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
136 stream_class
->event_header_type
, "timestamp");
137 if (timestamp_field
) {
138 struct bt_ctf_clock
*mapped_clock
;
140 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
143 bt_ctf_clock_put(mapped_clock
);
147 ret
= bt_ctf_field_type_integer_set_mapped_clock(
148 timestamp_field
, clock
);
154 if (stream_class
->clock
) {
155 bt_ctf_clock_put(stream_class
->clock
);
158 stream_class
->clock
= clock
;
159 bt_ctf_clock_get(clock
);
161 if (timestamp_field
) {
162 bt_ctf_field_type_put(timestamp_field
);
167 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
171 if (!stream_class
|| !stream_class
->id_set
) {
176 ret
= (int64_t) stream_class
->id
;
181 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
186 if (!stream_class
|| stream_class
->frozen
) {
191 stream_class
->id
= id
;
192 stream_class
->id_set
= 1;
197 int bt_ctf_stream_class_add_event_class(
198 struct bt_ctf_stream_class
*stream_class
,
199 struct bt_ctf_event_class
*event_class
)
204 if (!stream_class
|| !event_class
) {
209 /* Check for duplicate event classes */
210 struct search_query query
= { .value
= event_class
, .found
= 0 };
211 g_ptr_array_foreach(stream_class
->event_classes
, value_exists
, &query
);
217 /* Only set an event id if none was explicitly set before */
218 event_id
= bt_ctf_event_class_get_id(event_class
);
220 if (bt_ctf_event_class_set_id(event_class
,
221 stream_class
->next_event_id
++)) {
227 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
232 bt_ctf_event_class_get(event_class
);
233 g_ptr_array_add(stream_class
->event_classes
, event_class
);
238 int bt_ctf_stream_class_get_event_class_count(
239 struct bt_ctf_stream_class
*stream_class
)
248 ret
= (int) stream_class
->event_classes
->len
;
253 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
254 struct bt_ctf_stream_class
*stream_class
, int index
)
256 struct bt_ctf_event_class
*event_class
= NULL
;
258 if (!stream_class
|| index
< 0 ||
259 index
>= stream_class
->event_classes
->len
) {
263 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
264 bt_ctf_event_class_get(event_class
);
269 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
270 struct bt_ctf_stream_class
*stream_class
, const char *name
)
274 struct bt_ctf_event_class
*event_class
= NULL
;
276 if (!stream_class
|| !name
) {
280 name_quark
= g_quark_try_string(name
);
285 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
286 struct bt_ctf_event_class
*current_event_class
=
287 g_ptr_array_index(stream_class
->event_classes
, i
);
289 if (name_quark
== current_event_class
->name
) {
290 event_class
= current_event_class
;
291 bt_ctf_event_class_get(event_class
);
299 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
300 struct bt_ctf_stream_class
*stream_class
)
302 struct bt_ctf_field_type
*ret
= NULL
;
308 assert(stream_class
->packet_context_type
);
309 bt_ctf_field_type_get(stream_class
->packet_context_type
);
310 ret
= stream_class
->packet_context_type
;
315 int bt_ctf_stream_class_set_packet_context_type(
316 struct bt_ctf_stream_class
*stream_class
,
317 struct bt_ctf_field_type
*packet_context_type
)
321 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
326 assert(stream_class
->packet_context_type
);
327 if (stream_class
->packet_context_type
== packet_context_type
) {
330 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
332 /* A packet context must be a structure */
337 bt_ctf_field_type_put(stream_class
->packet_context_type
);
338 bt_ctf_field_type_get(packet_context_type
);
339 stream_class
->packet_context_type
= packet_context_type
;
344 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
345 struct bt_ctf_stream_class
*stream_class
)
347 struct bt_ctf_field_type
*ret
= NULL
;
349 if (!stream_class
|| !stream_class
->event_header_type
) {
353 assert(stream_class
->event_header_type
);
354 bt_ctf_field_type_get(stream_class
->event_header_type
);
355 ret
= stream_class
->event_header_type
;
360 int bt_ctf_stream_class_set_event_header_type(
361 struct bt_ctf_stream_class
*stream_class
,
362 struct bt_ctf_field_type
*event_header_type
)
366 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
371 assert(stream_class
->event_header_type
);
372 if (stream_class
->event_header_type
== event_header_type
) {
375 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
377 /* An event header must be a structure */
382 bt_ctf_field_type_put(stream_class
->event_header_type
);
383 bt_ctf_field_type_get(event_header_type
);
384 stream_class
->event_header_type
= event_header_type
;
389 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
390 struct bt_ctf_stream_class
*stream_class
)
392 struct bt_ctf_field_type
*ret
= NULL
;
394 if (!stream_class
|| !stream_class
->event_context_type
) {
398 assert(stream_class
->event_context_type
);
399 bt_ctf_field_type_get(stream_class
->event_context_type
);
400 ret
= stream_class
->event_context_type
;
405 int bt_ctf_stream_class_set_event_context_type(
406 struct bt_ctf_stream_class
*stream_class
,
407 struct bt_ctf_field_type
*event_context_type
)
411 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
416 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
418 /* A packet context must be a structure */
423 bt_ctf_field_type_put(stream_class
->event_context_type
);
424 bt_ctf_field_type_get(event_context_type
);
425 stream_class
->event_context_type
= event_context_type
;
430 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
436 bt_ctf_ref_get(&stream_class
->ref_count
);
439 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
445 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
449 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
457 stream_class
->frozen
= 1;
458 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
459 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
460 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
461 bt_ctf_clock_freeze(stream_class
->clock
);
463 bt_ctf_field_type_set_native_byte_order(
464 stream_class
->event_header_type
, stream_class
->byte_order
);
465 bt_ctf_field_type_set_native_byte_order(
466 stream_class
->packet_context_type
, stream_class
->byte_order
);
467 bt_ctf_field_type_set_native_byte_order(
468 stream_class
->event_context_type
, stream_class
->byte_order
);
469 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
470 bt_ctf_event_class_set_native_byte_order(
471 g_ptr_array_index(stream_class
->event_classes
, i
),
472 stream_class
->byte_order
);
473 bt_ctf_event_class_freeze(
474 g_ptr_array_index(stream_class
->event_classes
, i
));
479 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
480 enum bt_ctf_byte_order byte_order
)
483 int internal_byte_order
;
485 /* Note that "NATIVE" means the trace's endianness, not the host's. */
486 if (!stream_class
|| byte_order
<= BT_CTF_BYTE_ORDER_UNKNOWN
||
487 byte_order
> BT_CTF_BYTE_ORDER_NETWORK
||
488 stream_class
->frozen
) {
493 switch (byte_order
) {
494 case BT_CTF_BYTE_ORDER_NETWORK
:
495 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
496 internal_byte_order
= BIG_ENDIAN
;
498 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
499 internal_byte_order
= LITTLE_ENDIAN
;
506 stream_class
->byte_order
= internal_byte_order
;
512 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
513 struct metadata_context
*context
)
518 g_string_assign(context
->field_name
, "");
519 context
->current_indentation_level
= 1;
520 if (!stream_class
->id_set
) {
525 g_string_append_printf(context
->string
,
526 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
528 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
534 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
535 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
541 if (stream_class
->event_context_type
) {
542 g_string_append(context
->string
, ";\n\n\tevent.context := ");
543 ret
= bt_ctf_field_type_serialize(
544 stream_class
->event_context_type
, context
);
550 g_string_append(context
->string
, ";\n};\n\n");
551 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
552 struct bt_ctf_event_class
*event_class
=
553 stream_class
->event_classes
->pdata
[i
];
555 ret
= bt_ctf_event_class_serialize(event_class
, context
);
561 context
->current_indentation_level
= 0;
566 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
568 struct bt_ctf_stream_class
*stream_class
;
574 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
575 bt_ctf_clock_put(stream_class
->clock
);
577 if (stream_class
->event_classes
) {
580 /* Unregister this stream class from the event classes */
581 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
582 struct bt_ctf_event_class
*event_class
=
583 g_ptr_array_index(stream_class
->event_classes
,
586 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
589 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
592 if (stream_class
->name
) {
593 g_string_free(stream_class
->name
, TRUE
);
596 bt_ctf_field_type_put(stream_class
->event_header_type
);
597 bt_ctf_field_type_put(stream_class
->packet_context_type
);
598 if (stream_class
->event_context_type
) {
599 bt_ctf_field_type_put(stream_class
->event_context_type
);
601 g_free(stream_class
);
605 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
608 struct bt_ctf_field_type
*event_header_type
=
609 bt_ctf_field_type_structure_create();
610 struct bt_ctf_field_type
*_uint32_t
=
611 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
612 struct bt_ctf_field_type
*_uint64_t
=
613 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
615 if (!event_header_type
) {
620 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
626 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
627 _uint64_t
, "timestamp");
632 if (stream_class
->event_header_type
) {
633 bt_ctf_field_type_put(stream_class
->event_header_type
);
635 stream_class
->event_header_type
= event_header_type
;
638 bt_ctf_field_type_put(event_header_type
);
641 bt_ctf_field_type_put(_uint32_t
);
642 bt_ctf_field_type_put(_uint64_t
);
647 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
650 struct bt_ctf_field_type
*packet_context_type
=
651 bt_ctf_field_type_structure_create();
652 struct bt_ctf_field_type
*_uint64_t
=
653 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
655 if (!packet_context_type
) {
661 * We create a stream packet context as proposed in the CTF
664 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
665 _uint64_t
, "timestamp_begin");
670 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
671 _uint64_t
, "timestamp_end");
676 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
677 _uint64_t
, "content_size");
682 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
683 _uint64_t
, "packet_size");
688 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
689 _uint64_t
, "events_discarded");
694 if (stream_class
->packet_context_type
) {
695 bt_ctf_field_type_put(stream_class
->packet_context_type
);
697 stream_class
->packet_context_type
= packet_context_type
;
700 bt_ctf_field_type_put(packet_context_type
);
704 bt_ctf_field_type_put(_uint64_t
);