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 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 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
109 if (!stream_class
|| stream_class
->frozen
) {
114 g_string_assign(stream_class
->name
, name
);
119 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
120 struct bt_ctf_stream_class
*stream_class
)
122 struct bt_ctf_clock
*clock
= NULL
;
124 if (!stream_class
|| !stream_class
->clock
) {
128 clock
= stream_class
->clock
;
129 bt_ctf_clock_get(clock
);
134 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
135 struct bt_ctf_clock
*clock
)
138 struct bt_ctf_field_type
*timestamp_field
= NULL
;
140 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
146 * Look for a "timestamp" field in the stream class' event header type
147 * and map the stream's clock to that field if no current mapping is
150 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
151 stream_class
->event_header_type
, "timestamp");
152 if (timestamp_field
) {
153 struct bt_ctf_clock
*mapped_clock
;
155 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
158 bt_ctf_clock_put(mapped_clock
);
162 ret
= bt_ctf_field_type_integer_set_mapped_clock(
163 timestamp_field
, clock
);
169 if (stream_class
->clock
) {
170 bt_ctf_clock_put(stream_class
->clock
);
173 stream_class
->clock
= clock
;
174 bt_ctf_clock_get(clock
);
176 if (timestamp_field
) {
177 bt_ctf_field_type_put(timestamp_field
);
182 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
186 if (!stream_class
|| !stream_class
->id_set
) {
191 ret
= (int64_t) stream_class
->id
;
197 int _bt_ctf_stream_class_set_id(
198 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
200 stream_class
->id
= id
;
201 stream_class
->id_set
= 1;
205 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
210 if (!stream_class
|| stream_class
->frozen
) {
215 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
223 int bt_ctf_stream_class_add_event_class(
224 struct bt_ctf_stream_class
*stream_class
,
225 struct bt_ctf_event_class
*event_class
)
230 if (!stream_class
|| !event_class
) {
235 /* Check for duplicate event classes */
236 struct search_query query
= { .value
= event_class
, .found
= 0 };
237 g_ptr_array_foreach(stream_class
->event_classes
, value_exists
, &query
);
243 /* Only set an event id if none was explicitly set before */
244 event_id
= bt_ctf_event_class_get_id(event_class
);
246 if (bt_ctf_event_class_set_id(event_class
,
247 stream_class
->next_event_id
++)) {
253 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
258 bt_ctf_event_class_get(event_class
);
259 g_ptr_array_add(stream_class
->event_classes
, event_class
);
260 bt_ctf_event_class_freeze(event_class
);
262 if (stream_class
->byte_order
) {
264 * Only set native byte order if it has been initialized
265 * when the stream class was added to a trace.
267 * If not set here, this will be set when the stream
268 * classe will be added to a trace.
270 bt_ctf_event_class_set_native_byte_order(event_class
,
271 stream_class
->byte_order
);
277 int bt_ctf_stream_class_get_event_class_count(
278 struct bt_ctf_stream_class
*stream_class
)
287 ret
= (int) stream_class
->event_classes
->len
;
292 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
293 struct bt_ctf_stream_class
*stream_class
, int index
)
295 struct bt_ctf_event_class
*event_class
= NULL
;
297 if (!stream_class
|| index
< 0 ||
298 index
>= stream_class
->event_classes
->len
) {
302 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
303 bt_ctf_event_class_get(event_class
);
308 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
309 struct bt_ctf_stream_class
*stream_class
, const char *name
)
312 struct bt_ctf_event_class
*event_class
= NULL
;
314 if (!stream_class
|| !name
) {
318 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
319 struct bt_ctf_event_class
*cur_event_class
=
320 g_ptr_array_index(stream_class
->event_classes
, i
);
321 const char *cur_event_class_name
=
322 bt_ctf_event_class_get_name(cur_event_class
);
324 if (!strcmp(name
, cur_event_class_name
)) {
325 event_class
= cur_event_class
;
326 bt_ctf_event_class_get(event_class
);
334 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
335 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
338 struct bt_ctf_event_class
*event_class
= NULL
;
344 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
345 struct bt_ctf_event_class
*current_event_class
=
346 g_ptr_array_index(stream_class
->event_classes
, i
);
348 if (bt_ctf_event_class_get_id(current_event_class
) == id
) {
349 event_class
= current_event_class
;
350 bt_ctf_event_class_get(event_class
);
358 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
359 struct bt_ctf_stream_class
*stream_class
)
361 struct bt_ctf_field_type
*ret
= NULL
;
367 assert(stream_class
->packet_context_type
);
368 bt_ctf_field_type_get(stream_class
->packet_context_type
);
369 ret
= stream_class
->packet_context_type
;
374 int bt_ctf_stream_class_set_packet_context_type(
375 struct bt_ctf_stream_class
*stream_class
,
376 struct bt_ctf_field_type
*packet_context_type
)
380 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
385 assert(stream_class
->packet_context_type
);
386 if (stream_class
->packet_context_type
== packet_context_type
) {
389 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
391 /* A packet context must be a structure */
396 bt_ctf_field_type_put(stream_class
->packet_context_type
);
397 bt_ctf_field_type_get(packet_context_type
);
398 stream_class
->packet_context_type
= packet_context_type
;
403 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
404 struct bt_ctf_stream_class
*stream_class
)
406 struct bt_ctf_field_type
*ret
= NULL
;
408 if (!stream_class
|| !stream_class
->event_header_type
) {
412 assert(stream_class
->event_header_type
);
413 bt_ctf_field_type_get(stream_class
->event_header_type
);
414 ret
= stream_class
->event_header_type
;
419 int bt_ctf_stream_class_set_event_header_type(
420 struct bt_ctf_stream_class
*stream_class
,
421 struct bt_ctf_field_type
*event_header_type
)
425 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
430 assert(stream_class
->event_header_type
);
431 if (stream_class
->event_header_type
== event_header_type
) {
434 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
436 /* An event header must be a structure */
441 bt_ctf_field_type_put(stream_class
->event_header_type
);
442 bt_ctf_field_type_get(event_header_type
);
443 stream_class
->event_header_type
= event_header_type
;
448 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
449 struct bt_ctf_stream_class
*stream_class
)
451 struct bt_ctf_field_type
*ret
= NULL
;
453 if (!stream_class
|| !stream_class
->event_context_type
) {
457 assert(stream_class
->event_context_type
);
458 bt_ctf_field_type_get(stream_class
->event_context_type
);
459 ret
= stream_class
->event_context_type
;
464 int bt_ctf_stream_class_set_event_context_type(
465 struct bt_ctf_stream_class
*stream_class
,
466 struct bt_ctf_field_type
*event_context_type
)
470 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
475 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
477 /* A packet context must be a structure */
482 bt_ctf_field_type_put(stream_class
->event_context_type
);
483 bt_ctf_field_type_get(event_context_type
);
484 stream_class
->event_context_type
= event_context_type
;
489 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
495 bt_ctf_ref_get(&stream_class
->ref_count
);
498 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
504 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
508 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
514 stream_class
->frozen
= 1;
515 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
516 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
517 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
518 bt_ctf_clock_freeze(stream_class
->clock
);
522 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
523 enum bt_ctf_byte_order byte_order
)
526 int internal_byte_order
;
528 /* Note that "NATIVE" means the trace's endianness, not the host's. */
529 if (!stream_class
|| byte_order
<= BT_CTF_BYTE_ORDER_UNKNOWN
||
530 byte_order
> BT_CTF_BYTE_ORDER_NETWORK
) {
535 switch (byte_order
) {
536 case BT_CTF_BYTE_ORDER_NETWORK
:
537 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
538 internal_byte_order
= BIG_ENDIAN
;
540 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
541 internal_byte_order
= LITTLE_ENDIAN
;
548 stream_class
->byte_order
= internal_byte_order
;
550 /* Set native byte order to little or big endian */
551 bt_ctf_field_type_set_native_byte_order(
552 stream_class
->event_header_type
, stream_class
->byte_order
);
553 bt_ctf_field_type_set_native_byte_order(
554 stream_class
->packet_context_type
, stream_class
->byte_order
);
555 bt_ctf_field_type_set_native_byte_order(
556 stream_class
->event_context_type
, stream_class
->byte_order
);
558 /* Set all events' native byte order */
559 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
560 bt_ctf_event_class_set_native_byte_order(
561 g_ptr_array_index(stream_class
->event_classes
, i
),
562 stream_class
->byte_order
);
563 bt_ctf_event_class_freeze(
564 g_ptr_array_index(stream_class
->event_classes
, i
));
571 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
572 struct metadata_context
*context
)
577 g_string_assign(context
->field_name
, "");
578 context
->current_indentation_level
= 1;
579 if (!stream_class
->id_set
) {
584 g_string_append_printf(context
->string
,
585 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
587 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
593 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
594 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
600 if (stream_class
->event_context_type
) {
601 g_string_append(context
->string
, ";\n\n\tevent.context := ");
602 ret
= bt_ctf_field_type_serialize(
603 stream_class
->event_context_type
, context
);
609 g_string_append(context
->string
, ";\n};\n\n");
610 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
611 struct bt_ctf_event_class
*event_class
=
612 stream_class
->event_classes
->pdata
[i
];
614 ret
= bt_ctf_event_class_serialize(event_class
, context
);
620 context
->current_indentation_level
= 0;
625 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
627 struct bt_ctf_stream_class
*stream_class
;
633 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
634 bt_ctf_clock_put(stream_class
->clock
);
636 if (stream_class
->event_classes
) {
639 /* Unregister this stream class from the event classes */
640 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
641 struct bt_ctf_event_class
*event_class
=
642 g_ptr_array_index(stream_class
->event_classes
,
645 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
648 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
651 if (stream_class
->name
) {
652 g_string_free(stream_class
->name
, TRUE
);
655 bt_ctf_field_type_put(stream_class
->event_header_type
);
656 bt_ctf_field_type_put(stream_class
->packet_context_type
);
657 if (stream_class
->event_context_type
) {
658 bt_ctf_field_type_put(stream_class
->event_context_type
);
660 g_free(stream_class
);
664 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
667 struct bt_ctf_field_type
*event_header_type
=
668 bt_ctf_field_type_structure_create();
669 struct bt_ctf_field_type
*_uint32_t
=
670 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
671 struct bt_ctf_field_type
*_uint64_t
=
672 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
674 if (!event_header_type
) {
679 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
685 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
686 _uint64_t
, "timestamp");
691 if (stream_class
->event_header_type
) {
692 bt_ctf_field_type_put(stream_class
->event_header_type
);
694 stream_class
->event_header_type
= event_header_type
;
697 bt_ctf_field_type_put(event_header_type
);
700 bt_ctf_field_type_put(_uint32_t
);
701 bt_ctf_field_type_put(_uint64_t
);
706 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
709 struct bt_ctf_field_type
*packet_context_type
=
710 bt_ctf_field_type_structure_create();
711 struct bt_ctf_field_type
*_uint64_t
=
712 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
714 if (!packet_context_type
) {
720 * We create a stream packet context as proposed in the CTF
723 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
724 _uint64_t
, "timestamp_begin");
729 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
730 _uint64_t
, "timestamp_end");
735 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
736 _uint64_t
, "content_size");
741 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
742 _uint64_t
, "packet_size");
747 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
748 _uint64_t
, "events_discarded");
753 if (stream_class
->packet_context_type
) {
754 bt_ctf_field_type_put(stream_class
->packet_context_type
);
756 stream_class
->packet_context_type
= packet_context_type
;
759 bt_ctf_field_type_put(packet_context_type
);
763 bt_ctf_field_type_put(_uint64_t
);