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 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 payload_type
= bt_ctf_event_class_get_payload_type(event_class
);
264 ret
= bt_ctf_event_class_set_payload_type(writer_event_class
,
267 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
271 BT_PUT(payload_type
);
274 context
= bt_ctf_event_class_get_context_type(event_class
);
276 ret
= bt_ctf_event_class_set_context_type(
277 writer_event_class
, context
);
280 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
289 BT_PUT(writer_event_class
);
291 return writer_event_class
;
295 enum bt_component_status
ctf_copy_event_classes(FILE *err
,
296 struct bt_ctf_stream_class
*stream_class
,
297 struct bt_ctf_stream_class
*writer_stream_class
)
299 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
300 struct bt_ctf_event_class
*event_class
= NULL
, *writer_event_class
= NULL
;
303 count
= bt_ctf_stream_class_get_event_class_count(stream_class
);
305 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
310 for (i
= 0; i
< count
; i
++) {
313 event_class
= bt_ctf_stream_class_get_event_class_by_index(
316 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
318 ret
= BT_COMPONENT_STATUS_ERROR
;
321 if (i
< bt_ctf_stream_class_get_event_class_count(writer_stream_class
)) {
322 writer_event_class
= bt_ctf_stream_class_get_event_class_by_index(
323 writer_stream_class
, i
);
324 if (writer_event_class
) {
326 * If the writer_event_class already exists,
327 * just skip it. It can be used to resync the
328 * event_classes after a trace has become
331 BT_PUT(writer_event_class
);
337 writer_event_class
= ctf_copy_event_class(err
, event_class
);
338 if (!writer_event_class
) {
339 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
341 ret
= BT_COMPONENT_STATUS_ERROR
;
345 int_ret
= bt_ctf_stream_class_add_event_class(writer_stream_class
,
348 fprintf(err
, "[error] Failed to add event class\n");
349 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
351 ret
= BT_COMPONENT_STATUS_ERROR
;
354 BT_PUT(writer_event_class
);
362 bt_put(writer_event_class
);
368 struct bt_ctf_stream_class
*ctf_copy_stream_class(FILE *err
,
369 struct bt_ctf_stream_class
*stream_class
,
370 struct bt_ctf_trace
*writer_trace
,
373 struct bt_ctf_field_type
*type
= NULL
;
374 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
376 const char *name
= bt_ctf_stream_class_get_name(stream_class
);
378 if (strlen(name
) == 0) {
382 writer_stream_class
= bt_ctf_stream_class_create(name
);
383 if (!writer_stream_class
) {
384 fprintf(err
, "[error] %s in %s:%d\n",
385 __func__
, __FILE__
, __LINE__
);
389 type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
391 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
396 ret_int
= bt_ctf_stream_class_set_packet_context_type(
397 writer_stream_class
, type
);
399 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
405 type
= bt_ctf_stream_class_get_event_header_type(stream_class
);
407 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
413 struct bt_ctf_field_type
*new_event_header_type
;
415 new_event_header_type
= override_header_type(err
, type
,
417 if (!new_event_header_type
) {
418 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
422 ret_int
= bt_ctf_stream_class_set_event_header_type(
423 writer_stream_class
, new_event_header_type
);
424 BT_PUT(new_event_header_type
);
426 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
431 ret_int
= bt_ctf_stream_class_set_event_header_type(
432 writer_stream_class
, type
);
434 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
441 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
443 ret_int
= bt_ctf_stream_class_set_event_context_type(
444 writer_stream_class
, type
);
446 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
456 BT_PUT(writer_stream_class
);
459 return writer_stream_class
;
463 enum bt_component_status
ctf_copy_packet_context_field(FILE *err
,
464 struct bt_ctf_field
*field
, const char *field_name
,
465 struct bt_ctf_field
*writer_packet_context
,
466 struct bt_ctf_field_type
*writer_packet_context_type
)
468 enum bt_component_status ret
;
469 struct bt_ctf_field
*writer_field
= NULL
;
470 struct bt_ctf_field_type
*field_type
= NULL
;
474 field_type
= bt_ctf_field_get_type(field
);
476 ret
= BT_COMPONENT_STATUS_ERROR
;
477 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
482 * Only support for integers for now.
484 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
485 fprintf(err
, "[error] Unsupported packet context field type\n");
486 ret
= BT_COMPONENT_STATUS_ERROR
;
491 writer_field
= bt_ctf_field_structure_get_field_by_name(
492 writer_packet_context
, field_name
);
494 ret
= BT_COMPONENT_STATUS_ERROR
;
495 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
500 int_ret
= bt_ctf_field_unsigned_integer_get_value(field
, &value
);
502 fprintf(err
, "[error] Wrong packet_context field type\n");
503 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
505 ret
= BT_COMPONENT_STATUS_ERROR
;
509 int_ret
= bt_ctf_field_unsigned_integer_set_value(writer_field
, value
);
511 ret
= BT_COMPONENT_STATUS_ERROR
;
512 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
517 ret
= BT_COMPONENT_STATUS_OK
;
524 bt_put(writer_field
);
529 struct bt_ctf_field
*ctf_copy_packet_context(FILE *err
,
530 struct bt_ctf_packet
*packet
,
531 struct bt_ctf_stream
*writer_stream
)
533 enum bt_component_status ret
;
534 struct bt_ctf_field
*packet_context
= NULL
, *writer_packet_context
= NULL
;
535 struct bt_ctf_field_type
*struct_type
= NULL
, *writer_packet_context_type
= NULL
;
536 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
537 struct bt_ctf_field
*field
= NULL
;
538 struct bt_ctf_field_type
*field_type
= NULL
;
541 packet_context
= bt_ctf_packet_get_context(packet
);
542 if (!packet_context
) {
546 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
547 if (!writer_stream_class
) {
548 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
553 writer_packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
554 writer_stream_class
);
555 BT_PUT(writer_stream_class
);
556 if (!writer_packet_context_type
) {
557 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
562 struct_type
= bt_ctf_field_get_type(packet_context
);
564 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
569 writer_packet_context
= bt_ctf_field_create(writer_packet_context_type
);
570 if (!writer_packet_context
) {
571 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
576 nr_fields
= bt_ctf_field_type_structure_get_field_count(struct_type
);
577 for (i
= 0; i
< nr_fields
; i
++) {
578 const char *field_name
;
580 field
= bt_ctf_field_structure_get_field_by_index(
583 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
587 if (bt_ctf_field_type_structure_get_field_by_index(struct_type
,
588 &field_name
, &field_type
, i
) < 0) {
589 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
594 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
595 fprintf(err
, "[error] Unexpected packet context field type\n");
599 ret
= ctf_copy_packet_context_field(err
, field
, field_name
,
600 writer_packet_context
, writer_packet_context_type
);
603 if (ret
!= BT_COMPONENT_STATUS_OK
) {
604 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
613 BT_PUT(writer_packet_context
);
618 bt_put(writer_packet_context_type
);
619 bt_put(writer_stream_class
);
620 bt_put(packet_context
);
621 return writer_packet_context
;
625 int ctf_copy_event_header(FILE *err
, struct bt_ctf_event
*event
,
626 struct bt_ctf_event_class
*writer_event_class
,
627 struct bt_ctf_event
*writer_event
,
628 struct bt_ctf_field
*event_header
)
630 struct bt_ctf_clock_class
*clock_class
= NULL
, *writer_clock_class
= NULL
;
631 struct bt_ctf_clock_value
*clock_value
= NULL
, *writer_clock_value
= NULL
;
634 struct bt_ctf_field
*writer_event_header
= NULL
;
637 clock_class
= event_get_clock_class(err
, event
);
639 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
644 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
647 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
652 ret
= bt_ctf_clock_value_get_value(clock_value
, &value
);
655 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
660 writer_clock_class
= event_get_clock_class(err
, writer_event
);
661 if (!writer_clock_class
) {
662 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
667 writer_clock_value
= bt_ctf_clock_value_create(writer_clock_class
, value
);
668 BT_PUT(writer_clock_class
);
669 if (!writer_clock_value
) {
670 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
675 ret
= bt_ctf_event_set_clock_value(writer_event
, writer_clock_value
);
676 BT_PUT(writer_clock_value
);
678 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
683 writer_event_header
= bt_ctf_field_copy(event_header
);
684 if (!writer_event_header
) {
685 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
690 ret
= bt_ctf_event_set_header(writer_event
, writer_event_header
);
691 BT_PUT(writer_event_header
);
693 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
709 struct bt_ctf_event
*ctf_copy_event(FILE *err
, struct bt_ctf_event
*event
,
710 struct bt_ctf_event_class
*writer_event_class
,
713 struct bt_ctf_event
*writer_event
= NULL
;
714 struct bt_ctf_field
*field
= NULL
, *copy_field
= NULL
;
717 writer_event
= bt_ctf_event_create(writer_event_class
);
719 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
724 field
= bt_ctf_event_get_header(event
);
726 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
732 * If override_ts64, we override all integer fields mapped to a clock
733 * to a uint64_t field type, otherwise, we just copy it as is.
736 copy_field
= bt_ctf_event_get_header(writer_event
);
738 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
743 ret
= copy_override_field(err
, event
, writer_event
, field
,
746 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
752 ret
= ctf_copy_event_header(err
, event
, writer_event_class
,
753 writer_event
, field
);
755 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
762 /* Optional field, so it can fail silently. */
763 field
= bt_ctf_event_get_stream_event_context(event
);
765 copy_field
= bt_ctf_field_copy(field
);
767 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
771 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
774 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
782 /* Optional field, so it can fail silently. */
783 field
= bt_ctf_event_get_event_context(event
);
785 copy_field
= bt_ctf_field_copy(field
);
787 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
791 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
793 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
801 field
= bt_ctf_event_get_event_payload(event
);
803 copy_field
= bt_ctf_field_copy(field
);
805 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
809 ret
= bt_ctf_event_set_event_payload(writer_event
, copy_field
);
811 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
822 BT_PUT(writer_event
);
830 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
831 struct bt_ctf_trace
*writer_trace
)
833 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
834 int field_count
, i
, int_ret
;
835 struct bt_ctf_field_type
*header_type
= NULL
;
836 enum bt_ctf_byte_order order
;
837 const char *trace_name
;
839 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
840 for (i
= 0; i
< field_count
; i
++) {
843 struct bt_value
*value
= NULL
;
845 name
= bt_ctf_trace_get_environment_field_name_by_index(
848 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
850 ret
= BT_COMPONENT_STATUS_ERROR
;
853 value
= bt_ctf_trace_get_environment_field_value_by_index(
856 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
858 ret
= BT_COMPONENT_STATUS_ERROR
;
862 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
866 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
868 fprintf(err
, "[error] Unable to set environment field %s\n",
870 ret
= BT_COMPONENT_STATUS_ERROR
;
875 order
= bt_ctf_trace_get_native_byte_order(trace
);
876 if (order
== BT_CTF_BYTE_ORDER_UNKNOWN
) {
877 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
878 ret
= BT_COMPONENT_STATUS_ERROR
;
883 * Only explicitly set the writer trace's native byte order if
884 * the original trace has a specific one. Otherwise leave what
885 * the CTF writer object chooses, which is the machine's native
888 if (order
!= BT_CTF_BYTE_ORDER_UNSPECIFIED
) {
889 ret
= bt_ctf_trace_set_native_byte_order(writer_trace
, order
);
891 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
892 ret
= BT_COMPONENT_STATUS_ERROR
;
897 header_type
= bt_ctf_trace_get_packet_header_type(writer_trace
);
899 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
902 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
903 ret
= BT_COMPONENT_STATUS_ERROR
;
908 trace_name
= bt_ctf_trace_get_name(trace
);
910 int_ret
= bt_ctf_trace_set_name(writer_trace
, trace_name
);
912 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
913 ret
= BT_COMPONENT_STATUS_ERROR
;