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/compiler.h>
39 #include <babeltrace/align.h>
42 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
);
44 int init_event_header(struct bt_ctf_stream_class
*stream_class
,
45 enum bt_ctf_byte_order byte_order
);
47 int init_packet_context(struct bt_ctf_stream_class
*stream_class
,
48 enum bt_ctf_byte_order byte_order
);
50 struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
)
53 struct bt_ctf_stream_class
*stream_class
= NULL
;
55 if (!name
|| !strlen(name
)) {
59 stream_class
= g_new0(struct bt_ctf_stream_class
, 1);
64 stream_class
->name
= g_string_new(name
);
65 stream_class
->event_classes
= g_ptr_array_new_with_free_func(
66 (GDestroyNotify
)bt_ctf_event_class_put
);
67 if (!stream_class
->event_classes
) {
71 ret
= init_packet_context(stream_class
, BT_CTF_BYTE_ORDER_NATIVE
);
76 bt_ctf_ref_init(&stream_class
->ref_count
);
80 bt_ctf_stream_class_destroy(&stream_class
->ref_count
);
86 const char *bt_ctf_stream_class_get_name(
87 struct bt_ctf_stream_class
*stream_class
)
89 const char *name
= NULL
;
95 name
= stream_class
->name
->str
;
100 struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
101 struct bt_ctf_stream_class
*stream_class
)
103 struct bt_ctf_clock
*clock
= NULL
;
105 if (!stream_class
|| !stream_class
->clock
) {
109 clock
= stream_class
->clock
;
110 bt_ctf_clock_get(clock
);
115 int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class
*stream_class
,
116 struct bt_ctf_clock
*clock
)
120 if (!stream_class
|| !clock
|| stream_class
->frozen
) {
125 if (stream_class
->clock
) {
126 bt_ctf_clock_put(stream_class
->clock
);
129 stream_class
->clock
= clock
;
130 bt_ctf_clock_get(clock
);
135 int64_t bt_ctf_stream_class_get_id(struct bt_ctf_stream_class
*stream_class
)
139 if (!stream_class
|| !stream_class
->id_set
) {
144 ret
= (int64_t) stream_class
->id
;
149 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class
*stream_class
,
159 stream_class
->id
= id
;
160 stream_class
->id_set
= 1;
165 int bt_ctf_stream_class_add_event_class(
166 struct bt_ctf_stream_class
*stream_class
,
167 struct bt_ctf_event_class
*event_class
)
172 if (!stream_class
|| !event_class
) {
177 /* Check for duplicate event classes */
178 struct search_query query
= { .value
= event_class
, .found
= 0 };
179 g_ptr_array_foreach(stream_class
->event_classes
, value_exists
, &query
);
185 /* Only set an event id if none was explicitly set before */
186 event_id
= bt_ctf_event_class_get_id(event_class
);
188 if (bt_ctf_event_class_set_id(event_class
,
189 stream_class
->next_event_id
++)) {
195 ret
= bt_ctf_event_class_set_stream_class(event_class
, stream_class
);
200 bt_ctf_event_class_get(event_class
);
201 g_ptr_array_add(stream_class
->event_classes
, event_class
);
206 int64_t bt_ctf_stream_class_get_event_class_count(
207 struct bt_ctf_stream_class
*stream_class
)
216 ret
= (int64_t) stream_class
->event_classes
->len
;
221 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
222 struct bt_ctf_stream_class
*stream_class
, size_t index
)
224 struct bt_ctf_event_class
*event_class
= NULL
;
226 if (!stream_class
|| index
>= stream_class
->event_classes
->len
) {
230 event_class
= g_ptr_array_index(stream_class
->event_classes
, index
);
231 bt_ctf_event_class_get(event_class
);
236 struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
237 struct bt_ctf_stream_class
*stream_class
, const char *name
)
241 struct bt_ctf_event_class
*event_class
= NULL
;
243 if (!stream_class
|| !name
) {
247 name_quark
= g_quark_try_string(name
);
252 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
253 struct bt_ctf_event_class
*current_event_class
=
254 g_ptr_array_index(stream_class
->event_classes
, i
);
256 if (name_quark
== current_event_class
->name
) {
257 event_class
= current_event_class
;
258 bt_ctf_event_class_get(event_class
);
266 struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
267 struct bt_ctf_stream_class
*stream_class
)
269 struct bt_ctf_field_type
*ret
= NULL
;
275 assert(stream_class
->packet_context_type
);
276 bt_ctf_field_type_get(stream_class
->packet_context_type
);
277 ret
= stream_class
->packet_context_type
;
282 int bt_ctf_stream_class_set_packet_context_type(
283 struct bt_ctf_stream_class
*stream_class
,
284 struct bt_ctf_field_type
*packet_context_type
)
288 if (!stream_class
|| !packet_context_type
) {
293 assert(stream_class
->packet_context_type
);
294 if (bt_ctf_field_type_get_type_id(stream_class
->packet_context_type
) !=
296 /* A packet context must be a structure */
301 bt_ctf_field_type_put(stream_class
->packet_context_type
);
302 bt_ctf_field_type_get(packet_context_type
);
303 stream_class
->packet_context_type
= packet_context_type
;
308 void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
)
314 bt_ctf_ref_get(&stream_class
->ref_count
);
317 void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
)
323 bt_ctf_ref_put(&stream_class
->ref_count
, bt_ctf_stream_class_destroy
);
327 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class
*stream_class
)
333 stream_class
->frozen
= 1;
334 bt_ctf_field_type_freeze(stream_class
->packet_context_type
);
335 bt_ctf_clock_freeze(stream_class
->clock
);
336 g_ptr_array_foreach(stream_class
->event_classes
,
337 (GFunc
)bt_ctf_event_class_freeze
, NULL
);
341 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class
*stream_class
,
342 enum bt_ctf_byte_order byte_order
)
346 ret
= init_event_header(stream_class
, byte_order
);
355 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class
*stream_class
,
356 struct metadata_context
*context
)
361 g_string_assign(context
->field_name
, "");
362 context
->current_indentation_level
= 1;
363 if (!stream_class
->id_set
) {
368 g_string_append_printf(context
->string
,
369 "stream {\n\tid = %" PRIu32
";\n\tevent.header := ",
371 ret
= bt_ctf_field_type_serialize(stream_class
->event_header_type
,
377 g_string_append(context
->string
, ";\n\n\tpacket.context := ");
378 ret
= bt_ctf_field_type_serialize(stream_class
->packet_context_type
,
384 if (stream_class
->event_context_type
) {
385 g_string_append(context
->string
, ";\n\n\tevent.context := ");
386 ret
= bt_ctf_field_type_serialize(
387 stream_class
->event_context_type
, context
);
393 g_string_append(context
->string
, ";\n};\n\n");
394 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
395 struct bt_ctf_event_class
*event_class
=
396 stream_class
->event_classes
->pdata
[i
];
398 ret
= bt_ctf_event_class_serialize(event_class
, context
);
404 context
->current_indentation_level
= 0;
409 void bt_ctf_stream_class_destroy(struct bt_ctf_ref
*ref
)
411 struct bt_ctf_stream_class
*stream_class
;
417 stream_class
= container_of(ref
, struct bt_ctf_stream_class
, ref_count
);
418 bt_ctf_clock_put(stream_class
->clock
);
420 if (stream_class
->event_classes
) {
423 /* Unregister this stream class from the event classes */
424 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
425 struct bt_ctf_event_class
*event_class
=
426 g_ptr_array_index(stream_class
->event_classes
,
429 bt_ctf_event_class_set_stream_class(event_class
, NULL
);
432 g_ptr_array_free(stream_class
->event_classes
, TRUE
);
435 if (stream_class
->name
) {
436 g_string_free(stream_class
->name
, TRUE
);
439 bt_ctf_field_type_put(stream_class
->event_header_type
);
440 bt_ctf_field_put(stream_class
->event_header
);
441 bt_ctf_field_type_put(stream_class
->packet_context_type
);
442 bt_ctf_field_type_put(stream_class
->event_context_type
);
443 bt_ctf_field_put(stream_class
->event_context
);
444 g_free(stream_class
);
448 int init_event_header(struct bt_ctf_stream_class
*stream_class
,
449 enum bt_ctf_byte_order byte_order
)
452 struct bt_ctf_field_type
*event_header_type
=
453 bt_ctf_field_type_structure_create();
454 struct bt_ctf_field_type
*_uint32_t
=
455 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
456 struct bt_ctf_field_type
*_uint64_t
=
457 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
459 if (!event_header_type
) {
464 ret
= bt_ctf_field_type_set_byte_order(_uint32_t
, byte_order
);
469 ret
= bt_ctf_field_type_set_byte_order(_uint64_t
, byte_order
);
474 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
480 ret
= bt_ctf_field_type_structure_add_field(event_header_type
,
481 _uint64_t
, "timestamp");
486 stream_class
->event_header_type
= event_header_type
;
487 stream_class
->event_header
= bt_ctf_field_create(
488 stream_class
->event_header_type
);
489 if (!stream_class
->event_header
) {
494 bt_ctf_field_type_put(event_header_type
);
497 bt_ctf_field_type_put(_uint32_t
);
498 bt_ctf_field_type_put(_uint64_t
);
503 int init_packet_context(struct bt_ctf_stream_class
*stream_class
,
504 enum bt_ctf_byte_order byte_order
)
507 struct bt_ctf_field_type
*packet_context_type
=
508 bt_ctf_field_type_structure_create();
509 struct bt_ctf_field_type
*_uint64_t
=
510 get_field_type(FIELD_TYPE_ALIAS_UINT64_T
);
512 if (!packet_context_type
) {
518 * We create a stream packet context as proposed in the CTF
521 ret
= bt_ctf_field_type_set_byte_order(_uint64_t
, byte_order
);
526 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
527 _uint64_t
, "timestamp_begin");
532 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
533 _uint64_t
, "timestamp_end");
538 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
539 _uint64_t
, "content_size");
544 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
545 _uint64_t
, "packet_size");
550 ret
= bt_ctf_field_type_structure_add_field(packet_context_type
,
551 _uint64_t
, "events_discarded");
556 stream_class
->packet_context_type
= packet_context_type
;
559 bt_ctf_field_type_put(packet_context_type
);
563 bt_ctf_field_type_put(_uint64_t
);