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
;
196 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
201 if (!stream_class
|| stream_class
->frozen
) {
206 stream_class
->id
= id
;
207 stream_class
->id_set
= 1;
212 int bt_ctf_stream_class_add_event_class(
213 struct bt_ctf_stream_class
*stream_class
,
214 struct bt_ctf_event_class
*event_class
)
219 if (!stream_class
|| !event_class
) {
224 /* Check for duplicate event classes */
225 struct search_query query
= { .value
= event_class
, .found
= 0 };
226 g_ptr_array_foreach(stream_class
->event_classes
, value_exists
, &query
);
232 /* Only set an event id if none was explicitly set before */
233 event_id
= bt_ctf_event_class_get_id(event_class
);
235 if (bt_ctf_event_class_set_id(event_class
,
236 stream_class
->next_event_id
++)) {
242 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
247 bt_ctf_event_class_get(event_class
);
248 g_ptr_array_add(stream_class
->event_classes
, event_class
);
253 int bt_ctf_stream_class_get_event_class_count(
254 struct bt_ctf_stream_class
*stream_class
)
263 ret
= (int) stream_class
->event_classes
->len
;
268 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
269 struct bt_ctf_stream_class
*stream_class
, int index
)
271 struct bt_ctf_event_class
*event_class
= NULL
;
273 if (!stream_class
|| index
< 0 ||
274 index
>= stream_class
->event_classes
->len
) {
278 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
279 bt_ctf_event_class_get(event_class
);
284 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
285 struct bt_ctf_stream_class
*stream_class
, const char *name
)
289 struct bt_ctf_event_class
*event_class
= NULL
;
291 if (!stream_class
|| !name
) {
295 name_quark
= g_quark_try_string(name
);
300 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
301 struct bt_ctf_event_class
*current_event_class
=
302 g_ptr_array_index(stream_class
->event_classes
, i
);
304 if (name_quark
== current_event_class
->name
) {
305 event_class
= current_event_class
;
306 bt_ctf_event_class_get(event_class
);
314 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
315 struct bt_ctf_stream_class
*stream_class
)
317 struct bt_ctf_field_type
*ret
= NULL
;
323 assert(stream_class
->packet_context_type
);
324 bt_ctf_field_type_get(stream_class
->packet_context_type
);
325 ret
= stream_class
->packet_context_type
;
330 int bt_ctf_stream_class_set_packet_context_type(
331 struct bt_ctf_stream_class
*stream_class
,
332 struct bt_ctf_field_type
*packet_context_type
)
336 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
341 assert(stream_class
->packet_context_type
);
342 if (stream_class
->packet_context_type
== packet_context_type
) {
345 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
347 /* A packet context must be a structure */
352 bt_ctf_field_type_put(stream_class
->packet_context_type
);
353 bt_ctf_field_type_get(packet_context_type
);
354 stream_class
->packet_context_type
= packet_context_type
;
359 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
360 struct bt_ctf_stream_class
*stream_class
)
362 struct bt_ctf_field_type
*ret
= NULL
;
364 if (!stream_class
|| !stream_class
->event_header_type
) {
368 assert(stream_class
->event_header_type
);
369 bt_ctf_field_type_get(stream_class
->event_header_type
);
370 ret
= stream_class
->event_header_type
;
375 int bt_ctf_stream_class_set_event_header_type(
376 struct bt_ctf_stream_class
*stream_class
,
377 struct bt_ctf_field_type
*event_header_type
)
381 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
386 assert(stream_class
->event_header_type
);
387 if (stream_class
->event_header_type
== event_header_type
) {
390 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
392 /* An event header must be a structure */
397 bt_ctf_field_type_put(stream_class
->event_header_type
);
398 bt_ctf_field_type_get(event_header_type
);
399 stream_class
->event_header_type
= event_header_type
;
404 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
405 struct bt_ctf_stream_class
*stream_class
)
407 struct bt_ctf_field_type
*ret
= NULL
;
409 if (!stream_class
|| !stream_class
->event_context_type
) {
413 assert(stream_class
->event_context_type
);
414 bt_ctf_field_type_get(stream_class
->event_context_type
);
415 ret
= stream_class
->event_context_type
;
420 int bt_ctf_stream_class_set_event_context_type(
421 struct bt_ctf_stream_class
*stream_class
,
422 struct bt_ctf_field_type
*event_context_type
)
426 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
431 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
433 /* A packet context must be a structure */
438 bt_ctf_field_type_put(stream_class
->event_context_type
);
439 bt_ctf_field_type_get(event_context_type
);
440 stream_class
->event_context_type
= event_context_type
;
445 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
451 bt_ctf_ref_get(&stream_class
->ref_count
);
454 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
460 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
464 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
472 stream_class
->frozen
= 1;
473 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
474 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
475 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
476 bt_ctf_clock_freeze(stream_class
->clock
);
478 bt_ctf_field_type_set_native_byte_order(
479 stream_class
->event_header_type
, stream_class
->byte_order
);
480 bt_ctf_field_type_set_native_byte_order(
481 stream_class
->packet_context_type
, stream_class
->byte_order
);
482 bt_ctf_field_type_set_native_byte_order(
483 stream_class
->event_context_type
, stream_class
->byte_order
);
484 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
485 bt_ctf_event_class_set_native_byte_order(
486 g_ptr_array_index(stream_class
->event_classes
, i
),
487 stream_class
->byte_order
);
488 bt_ctf_event_class_freeze(
489 g_ptr_array_index(stream_class
->event_classes
, i
));
494 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
495 enum bt_ctf_byte_order byte_order
)
498 int internal_byte_order
;
500 /* Note that "NATIVE" means the trace's endianness, not the host's. */
501 if (!stream_class
|| byte_order
<= BT_CTF_BYTE_ORDER_UNKNOWN
||
502 byte_order
> BT_CTF_BYTE_ORDER_NETWORK
||
503 stream_class
->frozen
) {
508 switch (byte_order
) {
509 case BT_CTF_BYTE_ORDER_NETWORK
:
510 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
511 internal_byte_order
= BIG_ENDIAN
;
513 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
514 internal_byte_order
= LITTLE_ENDIAN
;
521 stream_class
->byte_order
= internal_byte_order
;
527 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
528 struct metadata_context
*context
)
533 g_string_assign(context
->field_name
, "");
534 context
->current_indentation_level
= 1;
535 if (!stream_class
->id_set
) {
540 g_string_append_printf(context
->string
,
541 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
543 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
549 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
550 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
556 if (stream_class
->event_context_type
) {
557 g_string_append(context
->string
, ";\n\n\tevent.context := ");
558 ret
= bt_ctf_field_type_serialize(
559 stream_class
->event_context_type
, context
);
565 g_string_append(context
->string
, ";\n};\n\n");
566 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
567 struct bt_ctf_event_class
*event_class
=
568 stream_class
->event_classes
->pdata
[i
];
570 ret
= bt_ctf_event_class_serialize(event_class
, context
);
576 context
->current_indentation_level
= 0;
581 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
583 struct bt_ctf_stream_class
*stream_class
;
589 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
590 bt_ctf_clock_put(stream_class
->clock
);
592 if (stream_class
->event_classes
) {
595 /* Unregister this stream class from the event classes */
596 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
597 struct bt_ctf_event_class
*event_class
=
598 g_ptr_array_index(stream_class
->event_classes
,
601 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
604 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
607 if (stream_class
->name
) {
608 g_string_free(stream_class
->name
, TRUE
);
611 bt_ctf_field_type_put(stream_class
->event_header_type
);
612 bt_ctf_field_type_put(stream_class
->packet_context_type
);
613 if (stream_class
->event_context_type
) {
614 bt_ctf_field_type_put(stream_class
->event_context_type
);
616 g_free(stream_class
);
620 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
623 struct bt_ctf_field_type
*event_header_type
=
624 bt_ctf_field_type_structure_create();
625 struct bt_ctf_field_type
*_uint32_t
=
626 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
627 struct bt_ctf_field_type
*_uint64_t
=
628 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
630 if (!event_header_type
) {
635 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
641 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
642 _uint64_t
, "timestamp");
647 if (stream_class
->event_header_type
) {
648 bt_ctf_field_type_put(stream_class
->event_header_type
);
650 stream_class
->event_header_type
= event_header_type
;
653 bt_ctf_field_type_put(event_header_type
);
656 bt_ctf_field_type_put(_uint32_t
);
657 bt_ctf_field_type_put(_uint64_t
);
662 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
665 struct bt_ctf_field_type
*packet_context_type
=
666 bt_ctf_field_type_structure_create();
667 struct bt_ctf_field_type
*_uint64_t
=
668 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
670 if (!packet_context_type
) {
676 * We create a stream packet context as proposed in the CTF
679 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
680 _uint64_t
, "timestamp_begin");
685 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
686 _uint64_t
, "timestamp_end");
691 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
692 _uint64_t
, "content_size");
697 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
698 _uint64_t
, "packet_size");
703 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
704 _uint64_t
, "events_discarded");
709 if (stream_class
->packet_context_type
) {
710 bt_ctf_field_type_put(stream_class
->packet_context_type
);
712 stream_class
->packet_context_type
= packet_context_type
;
715 bt_ctf_field_type_put(packet_context_type
);
719 bt_ctf_field_type_put(_uint64_t
);