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-internal.h>
45 #include <babeltrace/align-internal.h>
46 #include <babeltrace/endian-internal.h>
51 void bt_ctf_stream_class_destroy(struct bt_object
*obj
);
53 int init_event_header(struct bt_ctf_stream_class
*stream_class
);
55 int init_packet_context(struct bt_ctf_stream_class
*stream_class
);
57 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
60 struct bt_ctf_stream_class
*stream_class
= NULL
;
62 if (name
&& bt_ctf_validate_identifier(name
)) {
66 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
71 stream_class
->name
= g_string_new(name
);
72 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
73 (GDestroyNotify
) bt_object_release
);
74 if (!stream_class
->event_classes
) {
78 stream_class
->event_classes_ht
= g_hash_table_new_full(g_int64_hash
,
79 g_int64_equal
, g_free
, NULL
);
81 ret
= init_event_header(stream_class
);
86 ret
= init_packet_context(stream_class
);
91 bt_object_init(stream_class
, bt_ctf_stream_class_destroy
);
99 struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
100 struct bt_ctf_stream_class
*stream_class
)
102 return stream_class
?
103 bt_get(bt_ctf_stream_class_borrow_trace(stream_class
)) :
107 const char *bt_ctf_stream_class_get_name(
108 struct bt_ctf_stream_class
*stream_class
)
110 const char *name
= NULL
;
116 name
= stream_class
->name
->str
;
121 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class
*stream_class
,
126 if (!stream_class
|| stream_class
->frozen
) {
131 g_string_assign(stream_class
->name
, name
);
136 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
137 struct bt_ctf_stream_class
*stream_class
)
139 struct bt_ctf_clock
*clock
= NULL
;
141 if (!stream_class
|| !stream_class
->clock
) {
145 clock
= bt_get(stream_class
->clock
);
150 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
151 struct bt_ctf_clock
*clock
)
154 struct bt_ctf_field_type
*timestamp_field
= NULL
;
156 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
162 * Look for a "timestamp" integer field type in the stream
163 * class's event header field type and map the stream class's
164 * clock's class to that field type if there's no current
167 timestamp_field
= bt_ctf_field_type_structure_get_field_type_by_name(
168 stream_class
->event_header_type
, "timestamp");
169 if (timestamp_field
) {
170 struct bt_ctf_clock_class
*mapped_clock_class
=
171 bt_ctf_field_type_integer_get_mapped_clock_class(
174 if (!mapped_clock_class
) {
175 ret
= bt_ctf_field_type_integer_set_mapped_clock_class(
176 timestamp_field
, clock
->clock_class
);
182 BT_PUT(mapped_clock_class
);
185 /* Replace the current clock of this stream class. */
186 bt_put(stream_class
->clock
);
187 stream_class
->clock
= bt_get(clock
);
190 bt_put(timestamp_field
);
194 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
198 if (!stream_class
|| !stream_class
->id_set
) {
203 ret
= stream_class
->id
;
209 int _bt_ctf_stream_class_set_id(
210 struct bt_ctf_stream_class
*stream_class
, int64_t id
)
212 stream_class
->id
= id
;
213 stream_class
->id_set
= 1;
217 struct event_class_set_stream_class_id_data
{
218 int64_t stream_class_id
;
223 void event_class_set_stream_id(gpointer event_class
, gpointer data
)
225 struct event_class_set_stream_class_id_data
*typed_data
= data
;
227 typed_data
->ret
|= bt_ctf_event_class_set_stream_id(event_class
,
228 typed_data
->stream_class_id
);
232 int bt_ctf_stream_class_set_id_no_check(
233 struct bt_ctf_stream_class
*stream_class
, int64_t id
)
236 struct event_class_set_stream_class_id_data data
=
237 { .stream_class_id
= id
, .ret
= 0 };
240 * Make sure all event classes have their "stream_id" attribute
243 g_ptr_array_foreach(stream_class
->event_classes
,
244 event_class_set_stream_id
, &data
);
250 ret
= _bt_ctf_stream_class_set_id(stream_class
, id
);
258 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
262 int64_t id
= (int64_t) id_param
;
264 if (!stream_class
|| stream_class
->frozen
|| id
< 0) {
269 ret
= bt_ctf_stream_class_set_id_no_check(stream_class
, id
);
275 void event_class_exists(gpointer element
, gpointer query
)
277 struct bt_ctf_event_class
*event_class_a
= element
;
278 struct search_query
*search_query
= query
;
279 struct bt_ctf_event_class
*event_class_b
= search_query
->value
;
282 if (search_query
->value
== element
) {
283 search_query
->found
= 1;
288 * Two event classes cannot share the same ID in a given
291 id_a
= bt_ctf_event_class_get_id(event_class_a
);
292 id_b
= bt_ctf_event_class_get_id(event_class_b
);
294 if (id_a
< 0 || id_b
< 0) {
295 /* at least one ID is not set: will be automatically set later */
300 search_query
->found
= 1;
308 int bt_ctf_stream_class_add_event_class(
309 struct bt_ctf_stream_class
*stream_class
,
310 struct bt_ctf_event_class
*event_class
)
313 int64_t *event_id
= NULL
;
314 struct bt_ctf_trace
*trace
= NULL
;
315 struct bt_ctf_stream_class
*old_stream_class
= NULL
;
316 struct bt_ctf_validation_output validation_output
= { 0 };
317 struct bt_ctf_field_type
*packet_header_type
= NULL
;
318 struct bt_ctf_field_type
*packet_context_type
= NULL
;
319 struct bt_ctf_field_type
*event_header_type
= NULL
;
320 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
321 struct bt_ctf_field_type
*event_context_type
= NULL
;
322 struct bt_ctf_field_type
*event_payload_type
= NULL
;
323 const enum bt_ctf_validation_flag validation_flags
=
324 BT_CTF_VALIDATION_FLAG_EVENT
;
326 if (!stream_class
|| !event_class
) {
331 trace
= bt_ctf_stream_class_get_trace(stream_class
);
332 if (trace
&& trace
->is_static
) {
337 event_id
= g_new(int64_t, 1);
343 /* Check for duplicate event classes */
344 struct search_query query
= { .value
= event_class
, .found
= 0 };
345 g_ptr_array_foreach(stream_class
->event_classes
, event_class_exists
,
352 old_stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
353 if (old_stream_class
) {
354 /* Event class is already associated to a stream class. */
361 * If the stream class is associated with a trace, then
362 * both those objects are frozen. Also, this event class
363 * is about to be frozen.
365 * Therefore the event class must be validated here.
366 * The trace and stream class should be valid at this
369 assert(trace
->valid
);
370 assert(stream_class
->valid
);
372 bt_ctf_trace_get_packet_header_type(trace
);
373 packet_context_type
=
374 bt_ctf_stream_class_get_packet_context_type(
377 bt_ctf_stream_class_get_event_header_type(stream_class
);
378 stream_event_ctx_type
=
379 bt_ctf_stream_class_get_event_context_type(
382 bt_ctf_event_class_get_context_type(event_class
);
384 bt_ctf_event_class_get_payload_type(event_class
);
385 ret
= bt_ctf_validate_class_types(
386 trace
->environment
, packet_header_type
,
387 packet_context_type
, event_header_type
,
388 stream_event_ctx_type
, event_context_type
,
389 event_payload_type
, trace
->valid
,
390 stream_class
->valid
, event_class
->valid
,
391 &validation_output
, validation_flags
);
392 BT_PUT(packet_header_type
);
393 BT_PUT(packet_context_type
);
394 BT_PUT(event_header_type
);
395 BT_PUT(stream_event_ctx_type
);
396 BT_PUT(event_context_type
);
397 BT_PUT(event_payload_type
);
401 * This means something went wrong during the
402 * validation process, not that the objects are
408 if ((validation_output
.valid_flags
& validation_flags
) !=
410 /* Invalid event class */
416 /* Only set an event ID if none was explicitly set before */
417 *event_id
= bt_ctf_event_class_get_id(event_class
);
419 if (bt_ctf_event_class_set_id(event_class
,
420 stream_class
->next_event_id
++)) {
424 *event_id
= stream_class
->next_event_id
;
427 ret
= bt_ctf_event_class_set_stream_id(event_class
, stream_class
->id
);
432 bt_object_set_parent(event_class
, stream_class
);
436 * At this point we know that the function will be
437 * successful. Therefore we can replace the event
438 * class's field types with what's in the validation
439 * output structure and mark this event class as valid.
441 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
442 &validation_output
, validation_flags
);
443 event_class
->valid
= 1;
446 * Put what was not moved in
447 * bt_ctf_validation_replace_types().
449 bt_ctf_validation_output_put_types(&validation_output
);
452 /* Add to the event classes of the stream class */
453 g_ptr_array_add(stream_class
->event_classes
, event_class
);
454 g_hash_table_insert(stream_class
->event_classes_ht
, event_id
,
458 /* Freeze the event class */
459 bt_ctf_event_class_freeze(event_class
);
461 /* Notifiy listeners of the trace's schema modification. */
463 struct bt_ctf_object obj
= { .object
= event_class
,
464 .type
= BT_CTF_OBJECT_TYPE_EVENT_CLASS
};
466 (void) bt_ctf_trace_object_modification(&obj
, trace
);
470 BT_PUT(old_stream_class
);
471 bt_ctf_validation_output_put_types(&validation_output
);
472 assert(!packet_header_type
);
473 assert(!packet_context_type
);
474 assert(!event_header_type
);
475 assert(!stream_event_ctx_type
);
476 assert(!event_context_type
);
477 assert(!event_payload_type
);
483 int64_t bt_ctf_stream_class_get_event_class_count(
484 struct bt_ctf_stream_class
*stream_class
)
493 ret
= (int64_t) stream_class
->event_classes
->len
;
498 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_index(
499 struct bt_ctf_stream_class
*stream_class
, uint64_t index
)
501 struct bt_ctf_event_class
*event_class
= NULL
;
503 if (!stream_class
|| index
>= stream_class
->event_classes
->len
) {
507 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
513 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
514 struct bt_ctf_stream_class
*stream_class
, uint64_t id
)
516 int64_t id_key
= (int64_t) id
;
517 struct bt_ctf_event_class
*event_class
= NULL
;
519 if (!stream_class
|| id_key
< 0) {
523 event_class
= g_hash_table_lookup(stream_class
->event_classes_ht
,
530 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
531 struct bt_ctf_stream_class
*stream_class
)
533 struct bt_ctf_field_type
*ret
= NULL
;
539 bt_get(stream_class
->packet_context_type
);
540 ret
= stream_class
->packet_context_type
;
545 int bt_ctf_stream_class_set_packet_context_type(
546 struct bt_ctf_stream_class
*stream_class
,
547 struct bt_ctf_field_type
*packet_context_type
)
551 if (!stream_class
|| stream_class
->frozen
) {
556 if (packet_context_type
&&
557 bt_ctf_field_type_get_type_id(packet_context_type
) !=
558 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
559 /* A packet context must be a structure. */
564 bt_put(stream_class
->packet_context_type
);
565 bt_get(packet_context_type
);
566 stream_class
->packet_context_type
= packet_context_type
;
571 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_header_type(
572 struct bt_ctf_stream_class
*stream_class
)
574 struct bt_ctf_field_type
*ret
= NULL
;
576 if (!stream_class
|| !stream_class
->event_header_type
) {
580 bt_get(stream_class
->event_header_type
);
581 ret
= stream_class
->event_header_type
;
586 int bt_ctf_stream_class_set_event_header_type(
587 struct bt_ctf_stream_class
*stream_class
,
588 struct bt_ctf_field_type
*event_header_type
)
592 if (!stream_class
|| stream_class
->frozen
) {
597 if (event_header_type
&&
598 bt_ctf_field_type_get_type_id(event_header_type
) !=
599 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
600 /* An event header must be a structure. */
605 bt_put(stream_class
->event_header_type
);
606 stream_class
->event_header_type
= bt_get(event_header_type
);
611 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
612 struct bt_ctf_stream_class
*stream_class
)
614 struct bt_ctf_field_type
*ret
= NULL
;
616 if (!stream_class
|| !stream_class
->event_context_type
) {
620 bt_get(stream_class
->event_context_type
);
621 ret
= stream_class
->event_context_type
;
626 int bt_ctf_stream_class_set_event_context_type(
627 struct bt_ctf_stream_class
*stream_class
,
628 struct bt_ctf_field_type
*event_context_type
)
632 if (!stream_class
|| stream_class
->frozen
) {
637 if (event_context_type
&&
638 bt_ctf_field_type_get_type_id(event_context_type
) !=
639 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
640 /* A packet context must be a structure. */
645 bt_put(stream_class
->event_context_type
);
646 stream_class
->event_context_type
= bt_get(event_context_type
);
651 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
653 bt_get(stream_class
);
656 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
658 bt_put(stream_class
);
662 int64_t get_event_class_count(void *element
)
664 return bt_ctf_stream_class_get_event_class_count(
665 (struct bt_ctf_stream_class
*) element
);
669 void *get_event_class(void *element
, int i
)
671 return bt_ctf_stream_class_get_event_class_by_index(
672 (struct bt_ctf_stream_class
*) element
, i
);
676 int visit_event_class(void *object
, bt_ctf_visitor visitor
,void *data
)
678 struct bt_ctf_object obj
=
680 .type
= BT_CTF_OBJECT_TYPE_EVENT_CLASS
};
682 return visitor(&obj
, data
);
685 int bt_ctf_stream_class_visit(struct bt_ctf_stream_class
*stream_class
,
686 bt_ctf_visitor visitor
, void *data
)
689 struct bt_ctf_object obj
=
690 { .object
= stream_class
,
691 .type
= BT_CTF_OBJECT_TYPE_STREAM_CLASS
};
693 if (!stream_class
|| !visitor
) {
698 ret
= visitor_helper(&obj
, get_event_class_count
,
700 visit_event_class
, visitor
, data
);
706 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
712 stream_class
->frozen
= 1;
713 bt_ctf_field_type_freeze(stream_class
->event_header_type
);
714 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
715 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
717 if (stream_class
->clock
) {
718 bt_ctf_clock_class_freeze(stream_class
->clock
->clock_class
);
723 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
724 struct metadata_context
*context
)
729 g_string_assign(context
->field_name
, "");
730 context
->current_indentation_level
= 1;
731 if (!stream_class
->id_set
) {
736 g_string_append_printf(context
->string
,
737 "stream {\n\tid = %" PRId64
";\n\tevent.header := ",
739 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
745 if (stream_class
->packet_context_type
) {
746 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
747 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
754 if (stream_class
->event_context_type
) {
755 g_string_append(context
->string
, ";\n\n\tevent.context := ");
756 ret
= bt_ctf_field_type_serialize(
757 stream_class
->event_context_type
, context
);
763 g_string_append(context
->string
, ";\n};\n\n");
764 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
765 struct bt_ctf_event_class
*event_class
=
766 stream_class
->event_classes
->pdata
[i
];
768 ret
= bt_ctf_event_class_serialize(event_class
, context
);
774 context
->current_indentation_level
= 0;
779 void bt_ctf_stream_class_destroy(struct bt_object
*obj
)
781 struct bt_ctf_stream_class
*stream_class
;
783 stream_class
= container_of(obj
, struct bt_ctf_stream_class
, base
);
784 bt_put(stream_class
->clock
);
786 if (stream_class
->event_classes_ht
) {
787 g_hash_table_destroy(stream_class
->event_classes_ht
);
789 if (stream_class
->event_classes
) {
790 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
793 if (stream_class
->name
) {
794 g_string_free(stream_class
->name
, TRUE
);
797 bt_put(stream_class
->event_header_type
);
798 bt_put(stream_class
->packet_context_type
);
799 bt_put(stream_class
->event_context_type
);
800 g_free(stream_class
);
804 int init_event_header(struct bt_ctf_stream_class
*stream_class
)
807 struct bt_ctf_field_type
*event_header_type
=
808 bt_ctf_field_type_structure_create();
809 struct bt_ctf_field_type
*_uint32_t
=
810 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
811 struct bt_ctf_field_type
*_uint64_t
=
812 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
814 if (!event_header_type
) {
819 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
825 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
826 _uint64_t
, "timestamp");
831 if (stream_class
->event_header_type
) {
832 bt_put(stream_class
->event_header_type
);
834 stream_class
->event_header_type
= event_header_type
;
837 bt_put(event_header_type
);
846 int init_packet_context(struct bt_ctf_stream_class
*stream_class
)
849 struct bt_ctf_field_type
*packet_context_type
=
850 bt_ctf_field_type_structure_create();
851 struct bt_ctf_field_type
*_uint64_t
=
852 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
854 if (!packet_context_type
) {
860 * We create a stream packet context as proposed in the CTF
863 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
864 _uint64_t
, "timestamp_begin");
869 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
870 _uint64_t
, "timestamp_end");
875 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
876 _uint64_t
, "content_size");
881 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
882 _uint64_t
, "packet_size");
887 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
888 _uint64_t
, "events_discarded");
893 bt_put(stream_class
->packet_context_type
);
894 stream_class
->packet_context_type
= packet_context_type
;
897 bt_put(packet_context_type
);