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
, *payload_type
;
217 enum bt_ctf_event_class_log_level log_level
;
220 name
= bt_ctf_event_class_get_name(event_class
);
222 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
227 writer_event_class
= bt_ctf_event_class_create(name
);
228 if (!writer_event_class
) {
229 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
234 id
= bt_ctf_event_class_get_id(event_class
);
236 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
241 ret
= bt_ctf_event_class_set_id(writer_event_class
, id
);
243 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
248 log_level
= bt_ctf_event_class_get_log_level(event_class
);
250 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
255 ret
= bt_ctf_event_class_set_log_level(writer_event_class
, log_level
);
257 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
262 emf_uri
= bt_ctf_event_class_get_emf_uri(event_class
);
264 ret
= bt_ctf_event_class_set_emf_uri(writer_event_class
,
267 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
273 payload_type
= bt_ctf_event_class_get_payload_type(event_class
);
275 ret
= bt_ctf_event_class_set_payload_type(writer_event_class
,
278 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
282 BT_PUT(payload_type
);
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 if (i
< bt_ctf_stream_class_get_event_class_count(writer_stream_class
)) {
333 writer_event_class
= bt_ctf_stream_class_get_event_class_by_index(
334 writer_stream_class
, i
);
335 if (writer_event_class
) {
337 * If the writer_event_class already exists,
338 * just skip it. It can be used to resync the
339 * event_classes after a trace has become
342 BT_PUT(writer_event_class
);
348 writer_event_class
= ctf_copy_event_class(err
, event_class
);
349 if (!writer_event_class
) {
350 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
352 ret
= BT_COMPONENT_STATUS_ERROR
;
356 int_ret
= bt_ctf_stream_class_add_event_class(writer_stream_class
,
359 fprintf(err
, "[error] Failed to add event class\n");
360 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
362 ret
= BT_COMPONENT_STATUS_ERROR
;
365 BT_PUT(writer_event_class
);
373 bt_put(writer_event_class
);
379 struct bt_ctf_stream_class
*ctf_copy_stream_class(FILE *err
,
380 struct bt_ctf_stream_class
*stream_class
,
381 struct bt_ctf_trace
*writer_trace
,
384 struct bt_ctf_field_type
*type
= NULL
;
385 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
387 const char *name
= bt_ctf_stream_class_get_name(stream_class
);
389 if (strlen(name
) == 0) {
393 writer_stream_class
= bt_ctf_stream_class_create_empty(name
);
394 if (!writer_stream_class
) {
395 fprintf(err
, "[error] %s in %s:%d\n",
396 __func__
, __FILE__
, __LINE__
);
400 type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
402 ret_int
= bt_ctf_stream_class_set_packet_context_type(
403 writer_stream_class
, type
);
405 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
412 type
= bt_ctf_stream_class_get_event_header_type(stream_class
);
414 ret_int
= bt_ctf_trace_get_clock_class_count(writer_trace
);
416 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
420 if (override_ts64
&& ret_int
> 0) {
421 struct bt_ctf_field_type
*new_event_header_type
;
423 new_event_header_type
= override_header_type(err
, type
,
425 if (!new_event_header_type
) {
426 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
430 ret_int
= bt_ctf_stream_class_set_event_header_type(
431 writer_stream_class
, new_event_header_type
);
432 BT_PUT(new_event_header_type
);
434 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
439 ret_int
= bt_ctf_stream_class_set_event_header_type(
440 writer_stream_class
, type
);
442 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
450 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
452 ret_int
= bt_ctf_stream_class_set_event_context_type(
453 writer_stream_class
, type
);
455 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
465 BT_PUT(writer_stream_class
);
468 return writer_stream_class
;
472 int ctf_stream_copy_packet_header(FILE *err
, struct bt_ctf_packet
*packet
,
473 struct bt_ctf_stream
*writer_stream
)
475 struct bt_ctf_field
*packet_header
= NULL
, *writer_packet_header
= NULL
;
478 packet_header
= bt_ctf_packet_get_header(packet
);
479 if (!packet_header
) {
483 writer_packet_header
= bt_ctf_field_copy(packet_header
);
484 if (!writer_packet_header
) {
485 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
490 ret
= bt_ctf_stream_set_packet_header(writer_stream
,
491 writer_packet_header
);
493 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
503 bt_put(writer_packet_header
);
504 bt_put(packet_header
);
509 int ctf_packet_copy_header(FILE *err
, struct bt_ctf_packet
*packet
,
510 struct bt_ctf_packet
*writer_packet
)
512 struct bt_ctf_field
*packet_header
= NULL
, *writer_packet_header
= NULL
;
515 packet_header
= bt_ctf_packet_get_header(packet
);
516 if (!packet_header
) {
520 writer_packet_header
= bt_ctf_field_copy(packet_header
);
521 if (!writer_packet_header
) {
522 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
527 ret
= bt_ctf_packet_set_header(writer_packet
, writer_packet_header
);
529 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
539 bt_put(packet_header
);
540 bt_put(writer_packet_header
);
545 int ctf_stream_copy_packet_context(FILE *err
, struct bt_ctf_packet
*packet
,
546 struct bt_ctf_stream
*writer_stream
)
548 struct bt_ctf_field
*packet_context
= NULL
, *writer_packet_context
= NULL
;
551 packet_context
= bt_ctf_packet_get_context(packet
);
552 if (!packet_context
) {
556 writer_packet_context
= bt_ctf_field_copy(packet_context
);
557 if (!writer_packet_context
) {
558 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
563 ret
= bt_ctf_stream_set_packet_context(writer_stream
,
564 writer_packet_context
);
566 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
576 bt_put(packet_context
);
577 bt_put(writer_packet_context
);
582 int ctf_packet_copy_context(FILE *err
, struct bt_ctf_packet
*packet
,
583 struct bt_ctf_stream
*writer_stream
,
584 struct bt_ctf_packet
*writer_packet
)
586 struct bt_ctf_field
*packet_context
= NULL
, *writer_packet_context
= NULL
;
589 packet_context
= bt_ctf_packet_get_context(packet
);
590 if (!packet_context
) {
594 writer_packet_context
= bt_ctf_field_copy(packet_context
);
595 if (!writer_packet_context
) {
596 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
601 ret
= bt_ctf_packet_set_context(writer_packet
, writer_packet_context
);
603 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
613 bt_put(writer_packet_context
);
614 bt_put(packet_context
);
619 int ctf_copy_event_header(FILE *err
, struct bt_ctf_event
*event
,
620 struct bt_ctf_event_class
*writer_event_class
,
621 struct bt_ctf_event
*writer_event
,
622 struct bt_ctf_field
*event_header
)
624 struct bt_ctf_clock_class
*clock_class
= NULL
, *writer_clock_class
= NULL
;
625 struct bt_ctf_clock_value
*clock_value
= NULL
, *writer_clock_value
= NULL
;
628 struct bt_ctf_field
*writer_event_header
= NULL
;
631 clock_class
= event_get_clock_class(err
, event
);
633 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
638 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
641 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
646 ret
= bt_ctf_clock_value_get_value(clock_value
, &value
);
649 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
654 writer_clock_class
= event_get_clock_class(err
, writer_event
);
655 if (!writer_clock_class
) {
656 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
661 writer_clock_value
= bt_ctf_clock_value_create(writer_clock_class
, value
);
662 BT_PUT(writer_clock_class
);
663 if (!writer_clock_value
) {
664 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
669 ret
= bt_ctf_event_set_clock_value(writer_event
, writer_clock_value
);
670 BT_PUT(writer_clock_value
);
672 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
677 writer_event_header
= bt_ctf_field_copy(event_header
);
678 if (!writer_event_header
) {
679 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
684 ret
= bt_ctf_event_set_header(writer_event
, writer_event_header
);
685 BT_PUT(writer_event_header
);
687 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
703 struct bt_ctf_trace
*event_class_get_trace(FILE *err
,
704 struct bt_ctf_event_class
*event_class
)
706 struct bt_ctf_trace
*trace
= NULL
;
707 struct bt_ctf_stream_class
*stream_class
= NULL
;
709 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
711 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
716 trace
= bt_ctf_stream_class_get_trace(stream_class
);
718 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
728 bt_put(stream_class
);
733 struct bt_ctf_event
*ctf_copy_event(FILE *err
, struct bt_ctf_event
*event
,
734 struct bt_ctf_event_class
*writer_event_class
,
737 struct bt_ctf_event
*writer_event
= NULL
;
738 struct bt_ctf_field
*field
= NULL
, *copy_field
= NULL
;
739 struct bt_ctf_trace
*writer_trace
= NULL
;
742 writer_event
= bt_ctf_event_create(writer_event_class
);
744 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
749 writer_trace
= event_class_get_trace(err
, writer_event_class
);
751 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
756 field
= bt_ctf_event_get_header(event
);
759 * If override_ts64, we override all integer fields mapped to a
760 * clock to a uint64_t field type, otherwise, we just copy it as
763 ret
= bt_ctf_trace_get_clock_class_count(writer_trace
);
765 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
769 if (override_ts64
&& ret
> 0) {
770 copy_field
= bt_ctf_event_get_header(writer_event
);
772 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
777 ret
= copy_override_field(err
, event
, writer_event
, field
,
780 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
786 ret
= ctf_copy_event_header(err
, event
, writer_event_class
,
787 writer_event
, field
);
789 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
797 /* Optional field, so it can fail silently. */
798 field
= bt_ctf_event_get_stream_event_context(event
);
800 copy_field
= bt_ctf_field_copy(field
);
802 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
806 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
809 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
817 /* Optional field, so it can fail silently. */
818 field
= bt_ctf_event_get_event_context(event
);
820 copy_field
= bt_ctf_field_copy(field
);
822 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
826 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
828 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
836 field
= bt_ctf_event_get_event_payload(event
);
838 copy_field
= bt_ctf_field_copy(field
);
840 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
844 ret
= bt_ctf_event_set_event_payload(writer_event
, copy_field
);
846 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
857 BT_PUT(writer_event
);
861 bt_put(writer_trace
);
866 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
867 struct bt_ctf_trace
*writer_trace
)
869 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
870 int field_count
, i
, int_ret
;
871 struct bt_ctf_field_type
*header_type
= NULL
;
872 enum bt_ctf_byte_order order
;
873 const char *trace_name
;
875 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
876 for (i
= 0; i
< field_count
; i
++) {
879 struct bt_value
*value
= NULL
;
881 name
= bt_ctf_trace_get_environment_field_name_by_index(
884 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
886 ret
= BT_COMPONENT_STATUS_ERROR
;
889 value
= bt_ctf_trace_get_environment_field_value_by_index(
892 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
894 ret
= BT_COMPONENT_STATUS_ERROR
;
898 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
902 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
904 fprintf(err
, "[error] Unable to set environment field %s\n",
906 ret
= BT_COMPONENT_STATUS_ERROR
;
911 order
= bt_ctf_trace_get_native_byte_order(trace
);
912 if (order
== BT_CTF_BYTE_ORDER_UNKNOWN
) {
913 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
914 ret
= BT_COMPONENT_STATUS_ERROR
;
919 * Only explicitly set the writer trace's native byte order if
920 * the original trace has a specific one. Otherwise leave what
921 * the CTF writer object chooses, which is the machine's native
924 if (order
!= BT_CTF_BYTE_ORDER_UNSPECIFIED
) {
925 ret
= bt_ctf_trace_set_native_byte_order(writer_trace
, order
);
927 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
928 ret
= BT_COMPONENT_STATUS_ERROR
;
933 header_type
= bt_ctf_trace_get_packet_header_type(trace
);
935 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
938 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
939 ret
= BT_COMPONENT_STATUS_ERROR
;
944 trace_name
= bt_ctf_trace_get_name(trace
);
946 int_ret
= bt_ctf_trace_set_name(writer_trace
, trace_name
);
948 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
949 ret
= BT_COMPONENT_STATUS_ERROR
;