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
);
249 bt_ctf_event_class_freeze(event_class
);
254 int bt_ctf_stream_class_get_event_class_count(
255 struct bt_ctf_stream_class
*stream_class
)
264 ret
= (int) stream_class
->event_classes
->len
;
269 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
270 struct bt_ctf_stream_class
*stream_class
, int index
)
272 struct bt_ctf_event_class
*event_class
= NULL
;
274 if (!stream_class
|| index
< 0 ||
275 index
>= stream_class
->event_classes
->len
) {
279 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
280 bt_ctf_event_class_get(event_class
);
285 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
286 struct bt_ctf_stream_class
*stream_class
, const char *name
)
290 struct bt_ctf_event_class
*event_class
= NULL
;
292 if (!stream_class
|| !name
) {
296 name_quark
= g_quark_try_string(name
);
301 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
302 struct bt_ctf_event_class
*current_event_class
=
303 g_ptr_array_index(stream_class
->event_classes
, i
);
305 if (name_quark
== current_event_class
->name
) {
306 event_class
= current_event_class
;
307 bt_ctf_event_class_get(event_class
);
315 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
316 struct bt_ctf_stream_class
*stream_class
)
318 struct bt_ctf_field_type
*ret
= NULL
;
324 assert(stream_class
->packet_context_type
);
325 bt_ctf_field_type_get(stream_class
->packet_context_type
);
326 ret
= stream_class
->packet_context_type
;
331 int bt_ctf_stream_class_set_packet_context_type(
332 struct bt_ctf_stream_class
*stream_class
,
333 struct bt_ctf_field_type
*packet_context_type
)
337 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
342 assert(stream_class
->packet_context_type
);
343 if (stream_class
->packet_context_type
== packet_context_type
) {
346 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
348 /* A packet context must be a structure */
353 bt_ctf_field_type_put(stream_class
->packet_context_type
);
354 bt_ctf_field_type_get(packet_context_type
);
355 stream_class
->packet_context_type
= packet_context_type
;
360 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
361 struct bt_ctf_stream_class
*stream_class
)
363 struct bt_ctf_field_type
*ret
= NULL
;
365 if (!stream_class
|| !stream_class
->event_header_type
) {
369 assert(stream_class
->event_header_type
);
370 bt_ctf_field_type_get(stream_class
->event_header_type
);
371 ret
= stream_class
->event_header_type
;
376 int bt_ctf_stream_class_set_event_header_type(
377 struct bt_ctf_stream_class
*stream_class
,
378 struct bt_ctf_field_type
*event_header_type
)
382 if (!stream_class
|| !event_header_type
|| stream_class
->frozen
) {
387 assert(stream_class
->event_header_type
);
388 if (stream_class
->event_header_type
== event_header_type
) {
391 if (bt_ctf_field_type_get_type_id(event_header_type
) !=
393 /* An event header must be a structure */
398 bt_ctf_field_type_put(stream_class
->event_header_type
);
399 bt_ctf_field_type_get(event_header_type
);
400 stream_class
->event_header_type
= event_header_type
;
405 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
406 struct bt_ctf_stream_class
*stream_class
)
408 struct bt_ctf_field_type
*ret
= NULL
;
410 if (!stream_class
|| !stream_class
->event_context_type
) {
414 assert(stream_class
->event_context_type
);
415 bt_ctf_field_type_get(stream_class
->event_context_type
);
416 ret
= stream_class
->event_context_type
;
421 int bt_ctf_stream_class_set_event_context_type(
422 struct bt_ctf_stream_class
*stream_class
,
423 struct bt_ctf_field_type
*event_context_type
)
427 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
432 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
434 /* A packet context must be a structure */
439 bt_ctf_field_type_put(stream_class
->event_context_type
);
440 bt_ctf_field_type_get(event_context_type
);
441 stream_class
->event_context_type
= event_context_type
;
446 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
452 bt_ctf_ref_get(&stream_class
->ref_count
);
455 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
461 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
465 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
473 stream_class
->frozen
= 1;
474 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
475 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
476 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
477 bt_ctf_clock_freeze(stream_class
->clock
);
479 bt_ctf_field_type_set_native_byte_order(
480 stream_class
->event_header_type
, stream_class
->byte_order
);
481 bt_ctf_field_type_set_native_byte_order(
482 stream_class
->packet_context_type
, stream_class
->byte_order
);
483 bt_ctf_field_type_set_native_byte_order(
484 stream_class
->event_context_type
, stream_class
->byte_order
);
485 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
486 bt_ctf_event_class_set_native_byte_order(
487 g_ptr_array_index(stream_class
->event_classes
, i
),
488 stream_class
->byte_order
);
489 bt_ctf_event_class_freeze(
490 g_ptr_array_index(stream_class
->event_classes
, i
));
495 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
496 enum bt_ctf_byte_order byte_order
)
499 int internal_byte_order
;
501 /* Note that "NATIVE" means the trace's endianness, not the host's. */
502 if (!stream_class
|| byte_order
<= BT_CTF_BYTE_ORDER_UNKNOWN
||
503 byte_order
> BT_CTF_BYTE_ORDER_NETWORK
||
504 stream_class
->frozen
) {
509 switch (byte_order
) {
510 case BT_CTF_BYTE_ORDER_NETWORK
:
511 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
512 internal_byte_order
= BIG_ENDIAN
;
514 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
515 internal_byte_order
= LITTLE_ENDIAN
;
522 stream_class
->byte_order
= internal_byte_order
;
528 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
529 struct metadata_context
*context
)
534 g_string_assign(context
->field_name
, "");
535 context
->current_indentation_level
= 1;
536 if (!stream_class
->id_set
) {
541 g_string_append_printf(context
->string
,
542 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
544 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
550 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
551 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
557 if (stream_class
->event_context_type
) {
558 g_string_append(context
->string
, ";\n\n\tevent.context := ");
559 ret
= bt_ctf_field_type_serialize(
560 stream_class
->event_context_type
, context
);
566 g_string_append(context
->string
, ";\n};\n\n");
567 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
568 struct bt_ctf_event_class
*event_class
=
569 stream_class
->event_classes
->pdata
[i
];
571 ret
= bt_ctf_event_class_serialize(event_class
, context
);
577 context
->current_indentation_level
= 0;
582 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
584 struct bt_ctf_stream_class
*stream_class
;
590 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
591 bt_ctf_clock_put(stream_class
->clock
);
593 if (stream_class
->event_classes
) {
596 /* Unregister this stream class from the event classes */
597 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
598 struct bt_ctf_event_class
*event_class
=
599 g_ptr_array_index(stream_class
->event_classes
,
602 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
605 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
608 if (stream_class
->name
) {
609 g_string_free(stream_class
->name
, TRUE
);
612 bt_ctf_field_type_put(stream_class
->event_header_type
);
613 bt_ctf_field_type_put(stream_class
->packet_context_type
);
614 if (stream_class
->event_context_type
) {
615 bt_ctf_field_type_put(stream_class
->event_context_type
);
617 g_free(stream_class
);
621 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
624 struct bt_ctf_field_type
*event_header_type
=
625 bt_ctf_field_type_structure_create();
626 struct bt_ctf_field_type
*_uint32_t
=
627 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
628 struct bt_ctf_field_type
*_uint64_t
=
629 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
631 if (!event_header_type
) {
636 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
642 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
643 _uint64_t
, "timestamp");
648 if (stream_class
->event_header_type
) {
649 bt_ctf_field_type_put(stream_class
->event_header_type
);
651 stream_class
->event_header_type
= event_header_type
;
654 bt_ctf_field_type_put(event_header_type
);
657 bt_ctf_field_type_put(_uint32_t
);
658 bt_ctf_field_type_put(_uint64_t
);
663 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
666 struct bt_ctf_field_type
*packet_context_type
=
667 bt_ctf_field_type_structure_create();
668 struct bt_ctf_field_type
*_uint64_t
=
669 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
671 if (!packet_context_type
) {
677 * We create a stream packet context as proposed in the CTF
680 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
681 _uint64_t
, "timestamp_begin");
686 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
687 _uint64_t
, "timestamp_end");
692 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
693 _uint64_t
, "content_size");
698 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
699 _uint64_t
, "packet_size");
704 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
705 _uint64_t
, "events_discarded");
710 if (stream_class
->packet_context_type
) {
711 bt_ctf_field_type_put(stream_class
->packet_context_type
);
713 stream_class
->packet_context_type
= packet_context_type
;
716 bt_ctf_field_type_put(packet_context_type
);
720 bt_ctf_field_type_put(_uint64_t
);