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-writer/clock-internal.h>
31 #include <babeltrace/ctf-ir/clock-class-internal.h>
32 #include <babeltrace/ctf-writer/event.h>
33 #include <babeltrace/ctf-ir/event-class-internal.h>
34 #include <babeltrace/ctf-ir/event-internal.h>
35 #include <babeltrace/ctf-ir/field-types-internal.h>
36 #include <babeltrace/ctf-ir/fields-internal.h>
37 #include <babeltrace/ctf-writer/stream.h>
38 #include <babeltrace/ctf-ir/stream-class-internal.h>
39 #include <babeltrace/ctf-ir/validation-internal.h>
40 #include <babeltrace/ctf-ir/visitor-internal.h>
41 #include <babeltrace/ctf-writer/functor-internal.h>
42 #include <babeltrace/ctf-ir/utils.h>
43 #include <babeltrace/ref.h>
44 #include <babeltrace/compiler.h>
45 #include <babeltrace/align.h>
46 #include <babeltrace/endian.h>
50 void bt_ctf_stream_class_destroy(struct bt_object
*obj
);
52 int init_event_header(struct bt_ctf_stream_class
*stream_class
);
54 int init_packet_context(struct bt_ctf_stream_class
*stream_class
);
56 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
59 struct bt_ctf_stream_class
*stream_class
= NULL
;
61 if (name
&& bt_ctf_validate_identifier(name
)) {
65 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
70 stream_class
->name
= g_string_new(name
);
71 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
72 (GDestroyNotify
) bt_object_release
);
73 if (!stream_class
->event_classes
) {
77 stream_class
->event_classes_ht
= g_hash_table_new_full(g_int64_hash
,
78 g_int64_equal
, g_free
, NULL
);
80 ret
= init_event_header(stream_class
);
85 ret
= init_packet_context(stream_class
);
90 bt_object_init(stream_class
, bt_ctf_stream_class_destroy
);
98 struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
99 struct bt_ctf_stream_class
*stream_class
)
101 return stream_class
?
102 bt_get(bt_ctf_stream_class_borrow_trace(stream_class
)) :
106 const char *bt_ctf_stream_class_get_name(
107 struct bt_ctf_stream_class
*stream_class
)
109 const char *name
= NULL
;
115 name
= stream_class
->name
->str
;
120 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
125 if (!stream_class
|| stream_class
->frozen
) {
130 g_string_assign(stream_class
->name
, name
);
135 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
136 struct bt_ctf_stream_class
*stream_class
)
138 struct bt_ctf_clock
*clock
= NULL
;
140 if (!stream_class
|| !stream_class
->clock
) {
144 clock
= bt_get(stream_class
->clock
);
149 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
150 struct bt_ctf_clock
*clock
)
153 struct bt_ctf_field_type
*timestamp_field
= NULL
;
155 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
161 * Look for a "timestamp" integer field type in the stream
162 * class's event header field type and map the stream class's
163 * clock's class to that field type if there's no current
166 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
167 stream_class
->event_header_type
, "timestamp");
168 if (timestamp_field
) {
169 struct bt_ctf_clock_class
*mapped_clock_class
=
170 bt_ctf_field_type_integer_get_mapped_clock_class(
173 if (!mapped_clock_class
) {
174 ret
= bt_ctf_field_type_integer_set_mapped_clock_class(
175 timestamp_field
, clock
->clock_class
);
181 BT_PUT(mapped_clock_class
);
184 /* Replace the current clock of this stream class. */
185 bt_put(stream_class
->clock
);
186 stream_class
->clock
= bt_get(clock
);
189 bt_put(timestamp_field
);
193 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
197 if (!stream_class
|| !stream_class
->id_set
) {
202 ret
= (int64_t) stream_class
->id
;
208 int _bt_ctf_stream_class_set_id(
209 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
211 stream_class
->id
= id
;
212 stream_class
->id_set
= 1;
216 struct event_class_set_stream_id_data
{
222 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
224 struct event_class_set_stream_id_data
*typed_data
= data
;
226 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
227 typed_data
->stream_id
);
231 int bt_ctf_stream_class_set_id_no_check(
232 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
235 struct event_class_set_stream_id_data data
=
236 { .stream_id
= id
, .ret
= 0 };
239 * Make sure all event classes have their "stream_id" attribute
242 g_ptr_array_foreach(stream_class
->event_classes
,
243 event_class_set_stream_id
, &data
);
249 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
257 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
262 if (!stream_class
|| stream_class
->frozen
) {
267 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
273 void event_class_exists(gpointer element
, gpointer query
)
275 struct bt_ctf_event_class
*event_class_a
= element
;
276 struct search_query
*search_query
= query
;
277 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
280 if (search_query
->value
== element
) {
281 search_query
->found
= 1;
286 * Two event classes cannot share the same name in a given
289 if (!strcmp(bt_ctf_event_class_get_name(event_class_a
),
290 bt_ctf_event_class_get_name(event_class_b
))) {
291 search_query
->found
= 1;
296 * Two event classes cannot share the same ID in a given
299 id_a
= bt_ctf_event_class_get_id(event_class_a
);
300 id_b
= bt_ctf_event_class_get_id(event_class_b
);
302 if (id_a
< 0 || id_b
< 0) {
303 /* at least one ID is not set: will be automatically set later */
308 search_query
->found
= 1;
316 int bt_ctf_stream_class_add_event_class(
317 struct bt_ctf_stream_class
*stream_class
,
318 struct bt_ctf_event_class
*event_class
)
321 int64_t *event_id
= NULL
;
322 struct bt_ctf_trace
*trace
= NULL
;
323 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
324 struct bt_ctf_validation_output validation_output
= { 0 };
325 struct bt_ctf_field_type
*packet_header_type
= NULL
;
326 struct bt_ctf_field_type
*packet_context_type
= NULL
;
327 struct bt_ctf_field_type
*event_header_type
= NULL
;
328 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
329 struct bt_ctf_field_type
*event_context_type
= NULL
;
330 struct bt_ctf_field_type
*event_payload_type
= NULL
;
331 const enum bt_ctf_validation_flag validation_flags
=
332 BT_CTF_VALIDATION_FLAG_EVENT
;
334 if (!stream_class
|| !event_class
) {
339 event_id
= g_new(int64_t, 1);
345 /* Check for duplicate event classes */
346 struct search_query query
= { .value
= event_class
, .found
= 0 };
347 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
354 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
355 if (old_stream_class
) {
356 /* Event class is already associated to a stream class. */
361 trace
= bt_ctf_stream_class_get_trace(stream_class
);
364 * If the stream class is associated with a trace, then
365 * both those objects are frozen. Also, this event class
366 * is about to be frozen.
368 * Therefore the event class must be validated here.
369 * The trace and stream class should be valid at this
372 assert(trace
->valid
);
373 assert(stream_class
->valid
);
375 bt_ctf_trace_get_packet_header_type(trace
);
376 packet_context_type
=
377 bt_ctf_stream_class_get_packet_context_type(
380 bt_ctf_stream_class_get_event_header_type(stream_class
);
381 stream_event_ctx_type
=
382 bt_ctf_stream_class_get_event_context_type(
385 bt_ctf_event_class_get_context_type(event_class
);
387 bt_ctf_event_class_get_payload_type(event_class
);
388 ret
= bt_ctf_validate_class_types(
389 trace
->environment
, packet_header_type
,
390 packet_context_type
, event_header_type
,
391 stream_event_ctx_type
, event_context_type
,
392 event_payload_type
, trace
->valid
,
393 stream_class
->valid
, event_class
->valid
,
394 &validation_output
, validation_flags
);
395 BT_PUT(packet_header_type
);
396 BT_PUT(packet_context_type
);
397 BT_PUT(event_header_type
);
398 BT_PUT(stream_event_ctx_type
);
399 BT_PUT(event_context_type
);
400 BT_PUT(event_payload_type
);
404 * This means something went wrong during the
405 * validation process, not that the objects are
411 if ((validation_output
.valid_flags
& validation_flags
) !=
413 /* Invalid event class */
419 /* Only set an event ID if none was explicitly set before */
420 *event_id
= bt_ctf_event_class_get_id(event_class
);
422 if (bt_ctf_event_class_set_id(event_class
,
423 stream_class
->next_event_id
++)) {
427 *event_id
= stream_class
->next_event_id
;
430 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
435 bt_object_set_parent(event_class
, stream_class
);
439 * At this point we know that the function will be
440 * successful. Therefore we can replace the event
441 * class's field types with what's in the validation
442 * output structure and mark this event class as valid.
444 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
445 &validation_output
, validation_flags
);
446 event_class
->valid
= 1;
449 * Put what was not moved in
450 * bt_ctf_validation_replace_types().
452 bt_ctf_validation_output_put_types(&validation_output
);
455 /* Add to the event classes of the stream class */
456 g_ptr_array_add(stream_class
->event_classes
, event_class
);
457 g_hash_table_insert(stream_class
->event_classes_ht
, event_id
,
461 /* Freeze the event class */
462 bt_ctf_event_class_freeze(event_class
);
464 /* Notifiy listeners of the trace's schema modification. */
466 struct bt_ctf_object obj
= { .object
= event_class
,
467 .type
= BT_CTF_OBJECT_TYPE_EVENT_CLASS
};
469 (void) bt_ctf_trace_object_modification(&obj
, trace
);
473 BT_PUT(old_stream_class
);
474 bt_ctf_validation_output_put_types(&validation_output
);
475 assert(!packet_header_type
);
476 assert(!packet_context_type
);
477 assert(!event_header_type
);
478 assert(!stream_event_ctx_type
);
479 assert(!event_context_type
);
480 assert(!event_payload_type
);
486 int bt_ctf_stream_class_get_event_class_count(
487 struct bt_ctf_stream_class
*stream_class
)
496 ret
= (int) stream_class
->event_classes
->len
;
501 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
502 struct bt_ctf_stream_class
*stream_class
, int index
)
504 struct bt_ctf_event_class
*event_class
= NULL
;
506 if (!stream_class
|| index
< 0 ||
507 index
>= stream_class
->event_classes
->len
) {
511 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
517 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
518 struct bt_ctf_stream_class
*stream_class
, const char *name
)
521 struct bt_ctf_event_class
*event_class
= NULL
;
523 if (!stream_class
|| !name
) {
527 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
528 struct bt_ctf_event_class
*cur_event_class
=
529 g_ptr_array_index(stream_class
->event_classes
, i
);
530 const char *cur_event_class_name
=
531 bt_ctf_event_class_get_name(cur_event_class
);
533 if (!strcmp(name
, cur_event_class_name
)) {
534 event_class
= cur_event_class
;
543 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
544 struct bt_ctf_stream_class
*stream_class
, uint32_t id
)
547 struct bt_ctf_event_class
*event_class
= NULL
;
553 event_class
= g_hash_table_lookup(stream_class
->event_classes_ht
,
560 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
561 struct bt_ctf_stream_class
*stream_class
)
563 struct bt_ctf_field_type
*ret
= NULL
;
569 bt_get(stream_class
->packet_context_type
);
570 ret
= stream_class
->packet_context_type
;
575 int bt_ctf_stream_class_set_packet_context_type(
576 struct bt_ctf_stream_class
*stream_class
,
577 struct bt_ctf_field_type
*packet_context_type
)
581 if (!stream_class
|| stream_class
->frozen
) {
586 if (packet_context_type
&&
587 bt_ctf_field_type_get_type_id(packet_context_type
) !=
588 BT_CTF_TYPE_ID_STRUCT
) {
589 /* A packet context must be a structure. */
594 bt_put(stream_class
->packet_context_type
);
595 bt_get(packet_context_type
);
596 stream_class
->packet_context_type
= packet_context_type
;
601 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
602 struct bt_ctf_stream_class
*stream_class
)
604 struct bt_ctf_field_type
*ret
= NULL
;
606 if (!stream_class
|| !stream_class
->event_header_type
) {
610 bt_get(stream_class
->event_header_type
);
611 ret
= stream_class
->event_header_type
;
616 int bt_ctf_stream_class_set_event_header_type(
617 struct bt_ctf_stream_class
*stream_class
,
618 struct bt_ctf_field_type
*event_header_type
)
622 if (!stream_class
|| stream_class
->frozen
) {
627 if (event_header_type
&&
628 bt_ctf_field_type_get_type_id(event_header_type
) !=
629 BT_CTF_TYPE_ID_STRUCT
) {
630 /* An event header must be a structure. */
635 bt_put(stream_class
->event_header_type
);
636 stream_class
->event_header_type
= bt_get(event_header_type
);
641 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
642 struct bt_ctf_stream_class
*stream_class
)
644 struct bt_ctf_field_type
*ret
= NULL
;
646 if (!stream_class
|| !stream_class
->event_context_type
) {
650 bt_get(stream_class
->event_context_type
);
651 ret
= stream_class
->event_context_type
;
656 int bt_ctf_stream_class_set_event_context_type(
657 struct bt_ctf_stream_class
*stream_class
,
658 struct bt_ctf_field_type
*event_context_type
)
662 if (!stream_class
|| stream_class
->frozen
) {
667 if (event_context_type
&&
668 bt_ctf_field_type_get_type_id(event_context_type
) !=
669 BT_CTF_TYPE_ID_STRUCT
) {
670 /* A packet context must be a structure. */
675 bt_put(stream_class
->event_context_type
);
676 stream_class
->event_context_type
= bt_get(event_context_type
);
681 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
683 bt_get(stream_class
);
686 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
688 bt_put(stream_class
);
692 int get_event_class_count(void *element
)
694 return bt_ctf_stream_class_get_event_class_count(
695 (struct bt_ctf_stream_class
*) element
);
699 void *get_event_class(void *element
, int i
)
701 return bt_ctf_stream_class_get_event_class(
702 (struct bt_ctf_stream_class
*) element
, i
);
706 int visit_event_class(void *object
, bt_ctf_visitor visitor
,void *data
)
708 struct bt_ctf_object obj
=
710 .type
= BT_CTF_OBJECT_TYPE_EVENT_CLASS
};
712 return visitor(&obj
, data
);
715 int bt_ctf_stream_class_visit(struct bt_ctf_stream_class
*stream_class
,
716 bt_ctf_visitor visitor
, void *data
)
719 struct bt_ctf_object obj
=
720 { .object
= stream_class
,
721 .type
= BT_CTF_OBJECT_TYPE_STREAM_CLASS
};
723 if (!stream_class
|| !visitor
) {
728 ret
= visitor_helper(&obj
, get_event_class_count
,
730 visit_event_class
, visitor
, data
);
736 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
742 stream_class
->frozen
= 1;
743 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
744 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
745 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
747 if (stream_class
->clock
) {
748 bt_ctf_clock_class_freeze(stream_class
->clock
->clock_class
);
753 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
754 struct metadata_context
*context
)
759 g_string_assign(context
->field_name
, "");
760 context
->current_indentation_level
= 1;
761 if (!stream_class
->id_set
) {
766 g_string_append_printf(context
->string
,
767 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
769 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
775 if (stream_class
->packet_context_type
) {
776 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
777 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
784 if (stream_class
->event_context_type
) {
785 g_string_append(context
->string
, ";\n\n\tevent.context := ");
786 ret
= bt_ctf_field_type_serialize(
787 stream_class
->event_context_type
, context
);
793 g_string_append(context
->string
, ";\n};\n\n");
794 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
795 struct bt_ctf_event_class
*event_class
=
796 stream_class
->event_classes
->pdata
[i
];
798 ret
= bt_ctf_event_class_serialize(event_class
, context
);
804 context
->current_indentation_level
= 0;
809 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
811 struct bt_ctf_stream_class
*stream_class
;
813 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
814 bt_put(stream_class
->clock
);
816 if (stream_class
->event_classes_ht
) {
817 g_hash_table_destroy(stream_class
->event_classes_ht
);
819 if (stream_class
->event_classes
) {
820 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
823 if (stream_class
->name
) {
824 g_string_free(stream_class
->name
, TRUE
);
827 bt_put(stream_class
->event_header_type
);
828 bt_put(stream_class
->packet_context_type
);
829 bt_put(stream_class
->event_context_type
);
830 g_free(stream_class
);
834 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
837 struct bt_ctf_field_type
*event_header_type
=
838 bt_ctf_field_type_structure_create();
839 struct bt_ctf_field_type
*_uint32_t
=
840 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
841 struct bt_ctf_field_type
*_uint64_t
=
842 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
844 if (!event_header_type
) {
849 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
855 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
856 _uint64_t
, "timestamp");
861 if (stream_class
->event_header_type
) {
862 bt_put(stream_class
->event_header_type
);
864 stream_class
->event_header_type
= event_header_type
;
867 bt_put(event_header_type
);
876 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
879 struct bt_ctf_field_type
*packet_context_type
=
880 bt_ctf_field_type_structure_create();
881 struct bt_ctf_field_type
*_uint64_t
=
882 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
884 if (!packet_context_type
) {
890 * We create a stream packet context as proposed in the CTF
893 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
894 _uint64_t
, "timestamp_begin");
899 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
900 _uint64_t
, "timestamp_end");
905 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
906 _uint64_t
, "content_size");
911 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
912 _uint64_t
, "packet_size");
917 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
918 _uint64_t
, "events_discarded");
923 bt_put(stream_class
->packet_context_type
);
924 stream_class
->packet_context_type
= packet_context_type
;
927 bt_put(packet_context_type
);