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
,
46 enum bt_ctf_byte_order byte_order
);
48 int init_packet_context(struct bt_ctf_stream_class
*stream_class
,
49 enum bt_ctf_byte_order byte_order
);
51 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
54 struct bt_ctf_stream_class
*stream_class
= NULL
;
56 if (!name
|| !strlen(name
) || bt_ctf_validate_identifier(name
)) {
60 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
65 stream_class
->name
= g_string_new(name
);
66 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
67 (GDestroyNotify
)bt_ctf_event_class_put
);
68 if (!stream_class
->event_classes
) {
72 ret
= init_packet_context(stream_class
, BT_CTF_BYTE_ORDER_NATIVE
);
77 bt_ctf_ref_init(&stream_class
->ref_count
);
81 bt_ctf_stream_class_destroy(&stream_class
->ref_count
);
87 const char *bt_ctf_stream_class_get_name(
88 struct bt_ctf_stream_class
*stream_class
)
90 const char *name
= NULL
;
96 name
= stream_class
->name
->str
;
101 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
102 struct bt_ctf_stream_class
*stream_class
)
104 struct bt_ctf_clock
*clock
= NULL
;
106 if (!stream_class
|| !stream_class
->clock
) {
110 clock
= stream_class
->clock
;
111 bt_ctf_clock_get(clock
);
116 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
117 struct bt_ctf_clock
*clock
)
121 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
126 if (stream_class
->clock
) {
127 bt_ctf_clock_put(stream_class
->clock
);
130 stream_class
->clock
= clock
;
131 bt_ctf_clock_get(clock
);
136 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
140 if (!stream_class
|| !stream_class
->id_set
) {
145 ret
= (int64_t) stream_class
->id
;
150 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
155 if (!stream_class
|| stream_class
->frozen
) {
160 stream_class
->id
= id
;
161 stream_class
->id_set
= 1;
166 int bt_ctf_stream_class_add_event_class(
167 struct bt_ctf_stream_class
*stream_class
,
168 struct bt_ctf_event_class
*event_class
)
173 if (!stream_class
|| !event_class
) {
178 /* Check for duplicate event classes */
179 struct search_query query
= { .value
= event_class
, .found
= 0 };
180 g_ptr_array_foreach(stream_class
->event_classes
, value_exists
, &query
);
186 /* Only set an event id if none was explicitly set before */
187 event_id
= bt_ctf_event_class_get_id(event_class
);
189 if (bt_ctf_event_class_set_id(event_class
,
190 stream_class
->next_event_id
++)) {
196 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
201 bt_ctf_event_class_get(event_class
);
202 g_ptr_array_add(stream_class
->event_classes
, event_class
);
207 int bt_ctf_stream_class_get_event_class_count(
208 struct bt_ctf_stream_class
*stream_class
)
217 ret
= (int) stream_class
->event_classes
->len
;
222 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
223 struct bt_ctf_stream_class
*stream_class
, int index
)
225 struct bt_ctf_event_class
*event_class
= NULL
;
227 if (!stream_class
|| index
< 0 ||
228 index
>= stream_class
->event_classes
->len
) {
232 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
233 bt_ctf_event_class_get(event_class
);
238 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
239 struct bt_ctf_stream_class
*stream_class
, const char *name
)
243 struct bt_ctf_event_class
*event_class
= NULL
;
245 if (!stream_class
|| !name
) {
249 name_quark
= g_quark_try_string(name
);
254 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
255 struct bt_ctf_event_class
*current_event_class
=
256 g_ptr_array_index(stream_class
->event_classes
, i
);
258 if (name_quark
== current_event_class
->name
) {
259 event_class
= current_event_class
;
260 bt_ctf_event_class_get(event_class
);
268 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
269 struct bt_ctf_stream_class
*stream_class
)
271 struct bt_ctf_field_type
*ret
= NULL
;
277 assert(stream_class
->packet_context_type
);
278 bt_ctf_field_type_get(stream_class
->packet_context_type
);
279 ret
= stream_class
->packet_context_type
;
284 int bt_ctf_stream_class_set_packet_context_type(
285 struct bt_ctf_stream_class
*stream_class
,
286 struct bt_ctf_field_type
*packet_context_type
)
290 if (!stream_class
|| !packet_context_type
|| stream_class
->frozen
) {
295 assert(stream_class
->packet_context_type
);
296 if (bt_ctf_field_type_get_type_id(packet_context_type
) !=
298 /* A packet context must be a structure */
303 bt_ctf_field_type_put(stream_class
->packet_context_type
);
304 bt_ctf_field_type_get(packet_context_type
);
305 stream_class
->packet_context_type
= packet_context_type
;
310 struct bt_ctf_field_type
*bt_ctf_stream_class_get_event_context_type(
311 struct bt_ctf_stream_class
*stream_class
)
313 struct bt_ctf_field_type
*ret
= NULL
;
315 if (!stream_class
|| !stream_class
->event_context_type
) {
319 assert(stream_class
->event_context_type
);
320 bt_ctf_field_type_get(stream_class
->event_context_type
);
321 ret
= stream_class
->event_context_type
;
326 int bt_ctf_stream_class_set_event_context_type(
327 struct bt_ctf_stream_class
*stream_class
,
328 struct bt_ctf_field_type
*event_context_type
)
332 if (!stream_class
|| !event_context_type
|| stream_class
->frozen
) {
337 if (bt_ctf_field_type_get_type_id(event_context_type
) !=
339 /* A packet context must be a structure */
344 bt_ctf_field_type_put(stream_class
->event_context_type
);
345 bt_ctf_field_type_get(event_context_type
);
346 stream_class
->event_context_type
= event_context_type
;
351 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
357 bt_ctf_ref_get(&stream_class
->ref_count
);
360 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
366 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
370 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
376 stream_class
->frozen
= 1;
377 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
378 bt_ctf_field_type_freeze(stream_class
->event_context_type
);
379 bt_ctf_clock_freeze(stream_class
->clock
);
380 g_ptr_array_foreach(stream_class
->event_classes
,
381 (GFunc
)bt_ctf_event_class_freeze
, NULL
);
385 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
386 enum bt_ctf_byte_order byte_order
)
390 ret
= init_event_header(stream_class
, byte_order
);
399 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
400 struct metadata_context
*context
)
405 g_string_assign(context
->field_name
, "");
406 context
->current_indentation_level
= 1;
407 if (!stream_class
->id_set
) {
412 g_string_append_printf(context
->string
,
413 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
415 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
421 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
422 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
428 if (stream_class
->event_context_type
) {
429 g_string_append(context
->string
, ";\n\n\tevent.context := ");
430 ret
= bt_ctf_field_type_serialize(
431 stream_class
->event_context_type
, context
);
437 g_string_append(context
->string
, ";\n};\n\n");
438 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
439 struct bt_ctf_event_class
*event_class
=
440 stream_class
->event_classes
->pdata
[i
];
442 ret
= bt_ctf_event_class_serialize(event_class
, context
);
448 context
->current_indentation_level
= 0;
453 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
455 struct bt_ctf_stream_class
*stream_class
;
461 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
462 bt_ctf_clock_put(stream_class
->clock
);
464 if (stream_class
->event_classes
) {
467 /* Unregister this stream class from the event classes */
468 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
469 struct bt_ctf_event_class
*event_class
=
470 g_ptr_array_index(stream_class
->event_classes
,
473 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
476 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
479 if (stream_class
->name
) {
480 g_string_free(stream_class
->name
, TRUE
);
483 bt_ctf_field_type_put(stream_class
->event_header_type
);
484 bt_ctf_field_put(stream_class
->event_header
);
485 bt_ctf_field_type_put(stream_class
->packet_context_type
);
486 if (stream_class
->event_context_type
) {
487 bt_ctf_field_type_put(stream_class
->event_context_type
);
489 g_free(stream_class
);
493 int init_event_header(struct bt_ctf_stream_class
*stream_class
,
494 enum bt_ctf_byte_order byte_order
)
497 struct bt_ctf_field_type
*event_header_type
=
498 bt_ctf_field_type_structure_create();
499 struct bt_ctf_field_type
*_uint32_t
=
500 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
501 struct bt_ctf_field_type
*_uint64_t
=
502 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
504 if (!event_header_type
) {
509 ret
= bt_ctf_field_type_set_byte_order(_uint32_t
, byte_order
);
514 ret
= bt_ctf_field_type_set_byte_order(_uint64_t
, byte_order
);
519 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
525 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
526 _uint64_t
, "timestamp");
531 stream_class
->event_header_type
= event_header_type
;
532 stream_class
->event_header
= bt_ctf_field_create(
533 stream_class
->event_header_type
);
534 if (!stream_class
->event_header
) {
539 bt_ctf_field_type_put(event_header_type
);
542 bt_ctf_field_type_put(_uint32_t
);
543 bt_ctf_field_type_put(_uint64_t
);
548 int init_packet_context(struct bt_ctf_stream_class
*stream_class
,
549 enum bt_ctf_byte_order byte_order
)
552 struct bt_ctf_field_type
*packet_context_type
=
553 bt_ctf_field_type_structure_create();
554 struct bt_ctf_field_type
*_uint64_t
=
555 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
557 if (!packet_context_type
) {
563 * We create a stream packet context as proposed in the CTF
566 ret
= bt_ctf_field_type_set_byte_order(_uint64_t
, byte_order
);
571 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
572 _uint64_t
, "timestamp_begin");
577 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
578 _uint64_t
, "timestamp_end");
583 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
584 _uint64_t
, "content_size");
589 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
590 _uint64_t
, "packet_size");
595 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
596 _uint64_t
, "events_discarded");
601 stream_class
->packet_context_type
= packet_context_type
;
604 bt_ctf_field_type_put(packet_context_type
);
608 bt_ctf_field_type_put(_uint64_t
);