4 * Babeltrace library to create a copy of a CTF trace
6 * Copyright 2017 Julien Desfossez <jdesfossez@efficios.com>
8 * Author: Julien Desfossez <jdesfossez@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-ir/event.h>
30 #include <babeltrace/ctf-ir/packet.h>
31 #include <babeltrace/ctf-ir/event-class.h>
32 #include <babeltrace/ctf-ir/stream.h>
33 #include <babeltrace/ctf-ir/stream-class.h>
34 #include <babeltrace/ctf-ir/clock-class.h>
35 #include <babeltrace/ctf-ir/fields.h>
36 #include <babeltrace/ctf-writer/stream.h>
39 #include "ctfcopytrace.h"
40 #include "clock-fields.h"
43 struct bt_ctf_clock_class
*ctf_copy_clock_class(FILE *err
,
44 struct bt_ctf_clock_class
*clock_class
)
46 int64_t offset
, offset_s
;
49 const char *name
, *description
;
50 struct bt_ctf_clock_class
*writer_clock_class
= NULL
;
52 assert(err
&& clock_class
);
54 name
= bt_ctf_clock_class_get_name(clock_class
);
56 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
61 writer_clock_class
= bt_ctf_clock_class_create(name
);
62 if (!writer_clock_class
) {
63 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
68 description
= bt_ctf_clock_class_get_description(clock_class
);
70 int_ret
= bt_ctf_clock_class_set_description(writer_clock_class
,
73 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
79 u64_ret
= bt_ctf_clock_class_get_frequency(clock_class
);
80 if (u64_ret
== -1ULL) {
81 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
85 int_ret
= bt_ctf_clock_class_set_frequency(writer_clock_class
, u64_ret
);
87 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
92 u64_ret
= bt_ctf_clock_class_get_precision(clock_class
);
93 if (u64_ret
== -1ULL) {
94 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
98 int_ret
= bt_ctf_clock_class_set_precision(writer_clock_class
,
101 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
106 int_ret
= bt_ctf_clock_class_get_offset_s(clock_class
, &offset_s
);
108 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
113 int_ret
= bt_ctf_clock_class_set_offset_s(writer_clock_class
, offset_s
);
115 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
120 int_ret
= bt_ctf_clock_class_get_offset_cycles(clock_class
, &offset
);
122 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
127 int_ret
= bt_ctf_clock_class_set_offset_cycles(writer_clock_class
, offset
);
129 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
134 int_ret
= bt_ctf_clock_class_is_absolute(clock_class
);
136 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
141 int_ret
= bt_ctf_clock_class_set_is_absolute(writer_clock_class
, int_ret
);
143 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
151 BT_PUT(writer_clock_class
);
153 return writer_clock_class
;
157 enum bt_component_status
ctf_copy_clock_classes(FILE *err
,
158 struct bt_ctf_trace
*writer_trace
,
159 struct bt_ctf_stream_class
*writer_stream_class
,
160 struct bt_ctf_trace
*trace
)
162 enum bt_component_status ret
;
163 int int_ret
, clock_class_count
, i
;
165 clock_class_count
= bt_ctf_trace_get_clock_class_count(trace
);
167 for (i
= 0; i
< clock_class_count
; i
++) {
168 struct bt_ctf_clock_class
*writer_clock_class
;
169 struct bt_ctf_clock_class
*clock_class
=
170 bt_ctf_trace_get_clock_class_by_index(trace
, i
);
173 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
175 ret
= BT_COMPONENT_STATUS_ERROR
;
179 writer_clock_class
= ctf_copy_clock_class(err
, clock_class
);
181 if (!writer_clock_class
) {
182 fprintf(err
, "Failed to copy clock class");
183 ret
= BT_COMPONENT_STATUS_ERROR
;
187 int_ret
= bt_ctf_trace_add_clock_class(writer_trace
, writer_clock_class
);
189 BT_PUT(writer_clock_class
);
190 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
192 ret
= BT_COMPONENT_STATUS_ERROR
;
197 * Ownership transferred to the trace.
199 bt_put(writer_clock_class
);
202 ret
= BT_COMPONENT_STATUS_OK
;
209 struct bt_ctf_event_class
*ctf_copy_event_class(FILE *err
,
210 struct bt_ctf_event_class
*event_class
)
212 struct bt_ctf_event_class
*writer_event_class
= NULL
;
213 struct bt_ctf_field_type
*context
;
217 name
= bt_ctf_event_class_get_name(event_class
);
219 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
224 writer_event_class
= bt_ctf_event_class_create(name
);
225 if (!writer_event_class
) {
226 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
231 count
= bt_ctf_event_class_get_attribute_count(event_class
);
232 for (i
= 0; i
< count
; i
++) {
233 const char *attr_name
;
234 struct bt_value
*attr_value
;
237 attr_name
= bt_ctf_event_class_get_attribute_name_by_index(
240 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
244 attr_value
= bt_ctf_event_class_get_attribute_value_by_index(
247 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
252 ret
= bt_ctf_event_class_set_attribute(writer_event_class
,
253 attr_name
, attr_value
);
256 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
262 count
= bt_ctf_event_class_get_payload_type_field_count(event_class
);
263 for (i
= 0; i
< count
; i
++) {
264 const char *field_name
;
265 struct bt_ctf_field_type
*field_type
;
268 ret
= bt_ctf_event_class_get_payload_type_field_by_index(
269 event_class
, &field_name
, &field_type
, i
);
271 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
275 ret
= bt_ctf_event_class_add_field(writer_event_class
, field_type
,
279 fprintf(err
, "[error] Cannot add field %s\n", field_name
);
280 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
285 context
= bt_ctf_event_class_get_context_type(event_class
);
287 ret
= bt_ctf_event_class_set_context_type(
288 writer_event_class
, context
);
291 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
300 BT_PUT(writer_event_class
);
302 return writer_event_class
;
306 enum bt_component_status
ctf_copy_event_classes(FILE *err
,
307 struct bt_ctf_stream_class
*stream_class
,
308 struct bt_ctf_stream_class
*writer_stream_class
)
310 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
311 struct bt_ctf_event_class
*event_class
= NULL
, *writer_event_class
= NULL
;
314 count
= bt_ctf_stream_class_get_event_class_count(stream_class
);
316 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
321 for (i
= 0; i
< count
; i
++) {
324 event_class
= bt_ctf_stream_class_get_event_class_by_index(
327 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
329 ret
= BT_COMPONENT_STATUS_ERROR
;
332 writer_event_class
= ctf_copy_event_class(err
, event_class
);
333 if (!writer_event_class
) {
334 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
336 ret
= BT_COMPONENT_STATUS_ERROR
;
340 int_ret
= bt_ctf_stream_class_add_event_class(writer_stream_class
,
343 fprintf(err
, "[error] Failed to add event class\n");
344 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
346 ret
= BT_COMPONENT_STATUS_ERROR
;
349 BT_PUT(writer_event_class
);
357 bt_put(writer_event_class
);
363 struct bt_ctf_stream_class
*ctf_copy_stream_class(FILE *err
,
364 struct bt_ctf_stream_class
*stream_class
,
365 struct bt_ctf_trace
*writer_trace
,
368 struct bt_ctf_field_type
*type
= NULL
;
369 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
371 const char *name
= bt_ctf_stream_class_get_name(stream_class
);
373 if (strlen(name
) == 0) {
377 writer_stream_class
= bt_ctf_stream_class_create(name
);
378 if (!writer_stream_class
) {
379 fprintf(err
, "[error] %s in %s:%d\n",
380 __func__
, __FILE__
, __LINE__
);
384 type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
386 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
391 ret_int
= bt_ctf_stream_class_set_packet_context_type(
392 writer_stream_class
, type
);
394 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
400 type
= bt_ctf_stream_class_get_event_header_type(stream_class
);
402 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
408 struct bt_ctf_field_type
*new_event_header_type
;
410 new_event_header_type
= override_header_type(err
, type
,
412 if (!new_event_header_type
) {
413 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
417 ret_int
= bt_ctf_stream_class_set_event_header_type(
418 writer_stream_class
, new_event_header_type
);
419 BT_PUT(new_event_header_type
);
421 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
426 ret_int
= bt_ctf_stream_class_set_event_header_type(
427 writer_stream_class
, type
);
429 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
436 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
438 ret_int
= bt_ctf_stream_class_set_event_context_type(
439 writer_stream_class
, type
);
441 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
451 BT_PUT(writer_stream_class
);
454 return writer_stream_class
;
458 enum bt_component_status
ctf_copy_packet_context_field(FILE *err
,
459 struct bt_ctf_field
*field
, const char *field_name
,
460 struct bt_ctf_field
*writer_packet_context
,
461 struct bt_ctf_field_type
*writer_packet_context_type
)
463 enum bt_component_status ret
;
464 struct bt_ctf_field
*writer_field
= NULL
;
465 struct bt_ctf_field_type
*field_type
= NULL
;
469 field_type
= bt_ctf_field_get_type(field
);
471 ret
= BT_COMPONENT_STATUS_ERROR
;
472 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
477 * Only support for integers for now.
479 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
480 fprintf(err
, "[error] Unsupported packet context field type\n");
481 ret
= BT_COMPONENT_STATUS_ERROR
;
486 writer_field
= bt_ctf_field_structure_get_field_by_name(
487 writer_packet_context
, field_name
);
489 ret
= BT_COMPONENT_STATUS_ERROR
;
490 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
495 int_ret
= bt_ctf_field_unsigned_integer_get_value(field
, &value
);
497 fprintf(err
, "[error] Wrong packet_context field type\n");
498 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
500 ret
= BT_COMPONENT_STATUS_ERROR
;
504 int_ret
= bt_ctf_field_unsigned_integer_set_value(writer_field
, value
);
506 ret
= BT_COMPONENT_STATUS_ERROR
;
507 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
512 ret
= BT_COMPONENT_STATUS_OK
;
519 bt_put(writer_field
);
524 struct bt_ctf_field
*ctf_copy_packet_context(FILE *err
,
525 struct bt_ctf_packet
*packet
,
526 struct bt_ctf_stream
*writer_stream
,
527 int skip_content_size
)
529 enum bt_component_status ret
;
530 struct bt_ctf_field
*packet_context
= NULL
, *writer_packet_context
= NULL
;
531 struct bt_ctf_field_type
*struct_type
= NULL
, *writer_packet_context_type
= NULL
;
532 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
533 struct bt_ctf_field
*field
= NULL
;
534 struct bt_ctf_field_type
*field_type
= NULL
;
537 packet_context
= bt_ctf_packet_get_context(packet
);
538 if (!packet_context
) {
542 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
543 if (!writer_stream_class
) {
544 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
549 writer_packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
550 writer_stream_class
);
551 BT_PUT(writer_stream_class
);
552 if (!writer_packet_context_type
) {
553 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
558 struct_type
= bt_ctf_field_get_type(packet_context
);
560 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
565 writer_packet_context
= bt_ctf_field_create(writer_packet_context_type
);
566 if (!writer_packet_context
) {
567 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
572 nr_fields
= bt_ctf_field_type_structure_get_field_count(struct_type
);
573 for (i
= 0; i
< nr_fields
; i
++) {
574 const char *field_name
;
576 field
= bt_ctf_field_structure_get_field_by_index(
579 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
583 if (bt_ctf_field_type_structure_get_field_by_index(struct_type
,
584 &field_name
, &field_type
, i
) < 0) {
585 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
589 if (skip_content_size
&&
590 (!strncmp(field_name
, "content_size", strlen("content_size")) ||
591 !strncmp(field_name
, "packet_size", strlen("packet_size")))) {
597 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
598 fprintf(err
, "[error] Unexpected packet context field type\n");
602 ret
= ctf_copy_packet_context_field(err
, field
, field_name
,
603 writer_packet_context
, writer_packet_context_type
);
606 if (ret
!= BT_COMPONENT_STATUS_OK
) {
607 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
616 BT_PUT(writer_packet_context
);
621 bt_put(writer_packet_context_type
);
622 bt_put(writer_stream_class
);
623 bt_put(packet_context
);
624 return writer_packet_context
;
628 int ctf_copy_event_header(FILE *err
, struct bt_ctf_event
*event
,
629 struct bt_ctf_event_class
*writer_event_class
,
630 struct bt_ctf_event
*writer_event
,
631 struct bt_ctf_field
*event_header
)
633 struct bt_ctf_clock_class
*clock_class
= NULL
, *writer_clock_class
= NULL
;
634 struct bt_ctf_clock_value
*clock_value
= NULL
, *writer_clock_value
= NULL
;
637 struct bt_ctf_field
*writer_event_header
= NULL
;
640 clock_class
= event_get_clock_class(err
, event
);
642 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
647 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
650 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
655 ret
= bt_ctf_clock_value_get_value(clock_value
, &value
);
658 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
663 writer_clock_class
= event_get_clock_class(err
, writer_event
);
664 if (!writer_clock_class
) {
665 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
670 writer_clock_value
= bt_ctf_clock_value_create(writer_clock_class
, value
);
671 BT_PUT(writer_clock_class
);
672 if (!writer_clock_value
) {
673 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
678 ret
= bt_ctf_event_set_clock_value(writer_event
, writer_clock_value
);
679 BT_PUT(writer_clock_value
);
681 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
686 writer_event_header
= bt_ctf_field_copy(event_header
);
687 if (!writer_event_header
) {
688 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
693 ret
= bt_ctf_event_set_header(writer_event
, writer_event_header
);
694 BT_PUT(writer_event_header
);
696 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
712 struct bt_ctf_event
*ctf_copy_event(FILE *err
, struct bt_ctf_event
*event
,
713 struct bt_ctf_event_class
*writer_event_class
,
716 struct bt_ctf_event
*writer_event
= NULL
;
717 struct bt_ctf_field
*field
= NULL
, *copy_field
= NULL
;
720 writer_event
= bt_ctf_event_create(writer_event_class
);
722 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
727 field
= bt_ctf_event_get_header(event
);
729 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
735 * If override_ts64, we override all integer fields mapped to a clock
736 * to a uint64_t field type, otherwise, we just copy it as is.
739 copy_field
= bt_ctf_event_get_header(writer_event
);
741 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
746 ret
= copy_override_field(err
, event
, writer_event
, field
,
749 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
755 ret
= ctf_copy_event_header(err
, event
, writer_event_class
,
756 writer_event
, field
);
758 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
765 /* Optional field, so it can fail silently. */
766 field
= bt_ctf_event_get_stream_event_context(event
);
767 copy_field
= bt_ctf_field_copy(field
);
769 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
772 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
780 /* Optional field, so it can fail silently. */
781 field
= bt_ctf_event_get_event_context(event
);
782 copy_field
= bt_ctf_field_copy(field
);
784 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
786 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
794 field
= bt_ctf_event_get_event_payload(event
);
796 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
800 copy_field
= bt_ctf_field_copy(field
);
802 ret
= bt_ctf_event_set_event_payload(writer_event
, copy_field
);
804 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
815 BT_PUT(writer_event
);
823 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
824 struct bt_ctf_trace
*writer_trace
)
826 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
827 int field_count
, i
, int_ret
;
828 struct bt_ctf_field_type
*header_type
= NULL
;
829 enum bt_ctf_byte_order order
;
831 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
832 for (i
= 0; i
< field_count
; i
++) {
835 struct bt_value
*value
= NULL
;
837 name
= bt_ctf_trace_get_environment_field_name_by_index(
840 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
842 ret
= BT_COMPONENT_STATUS_ERROR
;
845 value
= bt_ctf_trace_get_environment_field_value_by_index(
848 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
850 ret
= BT_COMPONENT_STATUS_ERROR
;
854 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
858 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
860 fprintf(err
, "[error] Unable to set environment field %s\n",
862 ret
= BT_COMPONENT_STATUS_ERROR
;
867 order
= bt_ctf_trace_get_native_byte_order(trace
);
868 if (order
== BT_CTF_BYTE_ORDER_UNKNOWN
) {
869 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
870 ret
= BT_COMPONENT_STATUS_ERROR
;
875 * Only explicitly set the writer trace's native byte order if
876 * the original trace has a specific one. Otherwise leave what
877 * the CTF writer object chooses, which is the machine's native
880 if (order
!= BT_CTF_BYTE_ORDER_NONE
) {
881 ret
= bt_ctf_trace_set_native_byte_order(writer_trace
, order
);
883 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
884 ret
= BT_COMPONENT_STATUS_ERROR
;
889 header_type
= bt_ctf_trace_get_packet_header_type(writer_trace
);
891 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
894 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
895 ret
= BT_COMPONENT_STATUS_ERROR
;