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 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
75 int_ret
= bt_ctf_clock_class_set_description(writer_clock_class
,
78 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
83 u64_ret
= bt_ctf_clock_class_get_frequency(clock_class
);
84 if (u64_ret
== -1ULL) {
85 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
89 int_ret
= bt_ctf_clock_class_set_frequency(writer_clock_class
, u64_ret
);
91 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
96 u64_ret
= bt_ctf_clock_class_get_precision(clock_class
);
97 if (u64_ret
== -1ULL) {
98 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
102 int_ret
= bt_ctf_clock_class_set_precision(writer_clock_class
,
105 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
110 int_ret
= bt_ctf_clock_class_get_offset_s(clock_class
, &offset_s
);
112 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
117 int_ret
= bt_ctf_clock_class_set_offset_s(writer_clock_class
, offset_s
);
119 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
124 int_ret
= bt_ctf_clock_class_get_offset_cycles(clock_class
, &offset
);
126 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
131 int_ret
= bt_ctf_clock_class_set_offset_cycles(writer_clock_class
, offset
);
133 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
138 int_ret
= bt_ctf_clock_class_is_absolute(clock_class
);
140 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
145 int_ret
= bt_ctf_clock_class_set_is_absolute(writer_clock_class
, int_ret
);
147 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
155 BT_PUT(writer_clock_class
);
157 return writer_clock_class
;
161 enum bt_component_status
ctf_copy_clock_classes(FILE *err
,
162 struct bt_ctf_trace
*writer_trace
,
163 struct bt_ctf_stream_class
*writer_stream_class
,
164 struct bt_ctf_trace
*trace
)
166 enum bt_component_status ret
;
167 int int_ret
, clock_class_count
, i
;
169 clock_class_count
= bt_ctf_trace_get_clock_class_count(trace
);
171 for (i
= 0; i
< clock_class_count
; i
++) {
172 struct bt_ctf_clock_class
*writer_clock_class
;
173 struct bt_ctf_clock_class
*clock_class
=
174 bt_ctf_trace_get_clock_class_by_index(trace
, i
);
177 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
179 ret
= BT_COMPONENT_STATUS_ERROR
;
183 writer_clock_class
= ctf_copy_clock_class(err
, clock_class
);
185 if (!writer_clock_class
) {
186 fprintf(err
, "Failed to copy clock class");
187 ret
= BT_COMPONENT_STATUS_ERROR
;
191 int_ret
= bt_ctf_trace_add_clock_class(writer_trace
, writer_clock_class
);
193 BT_PUT(writer_clock_class
);
194 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
196 ret
= BT_COMPONENT_STATUS_ERROR
;
201 * Ownership transferred to the trace.
203 bt_put(writer_clock_class
);
206 ret
= BT_COMPONENT_STATUS_OK
;
213 struct bt_ctf_event_class
*ctf_copy_event_class(FILE *err
,
214 struct bt_ctf_event_class
*event_class
)
216 struct bt_ctf_event_class
*writer_event_class
= NULL
;
217 struct bt_ctf_field_type
*context
;
221 name
= bt_ctf_event_class_get_name(event_class
);
223 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
228 writer_event_class
= bt_ctf_event_class_create(name
);
229 if (!writer_event_class
) {
230 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
235 count
= bt_ctf_event_class_get_attribute_count(event_class
);
236 for (i
= 0; i
< count
; i
++) {
237 const char *attr_name
;
238 struct bt_value
*attr_value
;
241 attr_name
= bt_ctf_event_class_get_attribute_name_by_index(
244 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
248 attr_value
= bt_ctf_event_class_get_attribute_value_by_index(
251 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
256 ret
= bt_ctf_event_class_set_attribute(writer_event_class
,
257 attr_name
, attr_value
);
260 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
266 count
= bt_ctf_event_class_get_payload_type_field_count(event_class
);
267 for (i
= 0; i
< count
; i
++) {
268 const char *field_name
;
269 struct bt_ctf_field_type
*field_type
;
272 ret
= bt_ctf_event_class_get_payload_type_field_by_index(
273 event_class
, &field_name
, &field_type
, i
);
275 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
279 ret
= bt_ctf_event_class_add_field(writer_event_class
, field_type
,
283 fprintf(err
, "[error] Cannot add field %s\n", field_name
);
284 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
289 context
= bt_ctf_event_class_get_context_type(event_class
);
291 ret
= bt_ctf_event_class_set_context_type(
292 writer_event_class
, context
);
295 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
304 BT_PUT(writer_event_class
);
306 return writer_event_class
;
310 enum bt_component_status
ctf_copy_event_classes(FILE *err
,
311 struct bt_ctf_stream_class
*stream_class
,
312 struct bt_ctf_stream_class
*writer_stream_class
)
314 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
315 struct bt_ctf_event_class
*event_class
= NULL
, *writer_event_class
= NULL
;
318 count
= bt_ctf_stream_class_get_event_class_count(stream_class
);
320 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
325 for (i
= 0; i
< count
; i
++) {
328 event_class
= bt_ctf_stream_class_get_event_class_by_index(
331 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
333 ret
= BT_COMPONENT_STATUS_ERROR
;
336 writer_event_class
= ctf_copy_event_class(err
, event_class
);
337 if (!writer_event_class
) {
338 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
340 ret
= BT_COMPONENT_STATUS_ERROR
;
344 int_ret
= bt_ctf_stream_class_add_event_class(writer_stream_class
,
347 fprintf(err
, "[error] Failed to add event class\n");
348 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
350 ret
= BT_COMPONENT_STATUS_ERROR
;
353 BT_PUT(writer_event_class
);
361 bt_put(writer_event_class
);
367 struct bt_ctf_stream_class
*ctf_copy_stream_class(FILE *err
,
368 struct bt_ctf_stream_class
*stream_class
,
369 struct bt_ctf_trace
*writer_trace
,
372 struct bt_ctf_field_type
*type
= NULL
;
373 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
375 const char *name
= bt_ctf_stream_class_get_name(stream_class
);
377 if (strlen(name
) == 0) {
381 writer_stream_class
= bt_ctf_stream_class_create(name
);
382 if (!writer_stream_class
) {
383 fprintf(err
, "[error] %s in %s:%d\n",
384 __func__
, __FILE__
, __LINE__
);
388 type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
390 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
395 ret_int
= bt_ctf_stream_class_set_packet_context_type(
396 writer_stream_class
, type
);
398 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
404 type
= bt_ctf_stream_class_get_event_header_type(stream_class
);
406 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
412 struct bt_ctf_field_type
*new_event_header_type
;
414 new_event_header_type
= override_header_type(err
, type
,
416 if (!new_event_header_type
) {
417 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
421 ret_int
= bt_ctf_stream_class_set_event_header_type(
422 writer_stream_class
, new_event_header_type
);
423 BT_PUT(new_event_header_type
);
425 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
, type
);
433 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
440 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
442 ret_int
= bt_ctf_stream_class_set_event_context_type(
443 writer_stream_class
, type
);
445 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
455 BT_PUT(writer_stream_class
);
458 return writer_stream_class
;
462 enum bt_component_status
ctf_copy_packet_context_field(FILE *err
,
463 struct bt_ctf_field
*field
, const char *field_name
,
464 struct bt_ctf_field
*writer_packet_context
,
465 struct bt_ctf_field_type
*writer_packet_context_type
)
467 enum bt_component_status ret
;
468 struct bt_ctf_field
*writer_field
= NULL
;
469 struct bt_ctf_field_type
*field_type
= NULL
;
473 field_type
= bt_ctf_field_get_type(field
);
475 ret
= BT_COMPONENT_STATUS_ERROR
;
476 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
481 * Only support for integers for now.
483 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
484 fprintf(err
, "[error] Unsupported packet context field type\n");
485 ret
= BT_COMPONENT_STATUS_ERROR
;
490 writer_field
= bt_ctf_field_structure_get_field_by_name(
491 writer_packet_context
, field_name
);
493 ret
= BT_COMPONENT_STATUS_ERROR
;
494 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
499 int_ret
= bt_ctf_field_unsigned_integer_get_value(field
, &value
);
501 fprintf(err
, "[error] Wrong packet_context field type\n");
502 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
504 ret
= BT_COMPONENT_STATUS_ERROR
;
508 int_ret
= bt_ctf_field_unsigned_integer_set_value(writer_field
, value
);
510 ret
= BT_COMPONENT_STATUS_ERROR
;
511 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
516 ret
= BT_COMPONENT_STATUS_OK
;
523 bt_put(writer_field
);
528 struct bt_ctf_field
*ctf_copy_packet_context(FILE *err
,
529 struct bt_ctf_packet
*packet
,
530 struct bt_ctf_stream
*writer_stream
,
531 int skip_content_size
)
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__
,
593 if (skip_content_size
&&
594 (!strncmp(field_name
, "content_size", strlen("content_size")) ||
595 !strncmp(field_name
, "packet_size", strlen("packet_size")))) {
601 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
602 fprintf(err
, "[error] Unexpected packet context field type\n");
606 ret
= ctf_copy_packet_context_field(err
, field
, field_name
,
607 writer_packet_context
, writer_packet_context_type
);
610 if (ret
!= BT_COMPONENT_STATUS_OK
) {
611 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
620 BT_PUT(writer_packet_context
);
625 bt_put(writer_packet_context_type
);
626 bt_put(writer_stream_class
);
627 bt_put(packet_context
);
628 return writer_packet_context
;
632 int ctf_copy_event_header(FILE *err
, struct bt_ctf_event
*event
,
633 struct bt_ctf_event_class
*writer_event_class
,
634 struct bt_ctf_event
*writer_event
,
635 struct bt_ctf_field
*event_header
)
637 struct bt_ctf_clock_class
*clock_class
= NULL
, *writer_clock_class
= NULL
;
638 struct bt_ctf_clock_value
*clock_value
= NULL
, *writer_clock_value
= NULL
;
641 struct bt_ctf_field
*writer_event_header
= NULL
;
644 clock_class
= event_get_clock_class(err
, event
);
646 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
651 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
654 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
659 ret
= bt_ctf_clock_value_get_value(clock_value
, &value
);
662 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
667 writer_clock_class
= event_get_clock_class(err
, writer_event
);
668 if (!writer_clock_class
) {
669 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
674 writer_clock_value
= bt_ctf_clock_value_create(writer_clock_class
, value
);
675 BT_PUT(writer_clock_class
);
676 if (!writer_clock_value
) {
677 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
682 ret
= bt_ctf_event_set_clock_value(writer_event
, writer_clock_value
);
683 BT_PUT(writer_clock_value
);
685 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
690 writer_event_header
= bt_ctf_field_copy(event_header
);
691 if (!writer_event_header
) {
692 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
697 ret
= bt_ctf_event_set_header(writer_event
, writer_event_header
);
698 BT_PUT(writer_event_header
);
700 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
716 struct bt_ctf_event
*ctf_copy_event(FILE *err
, struct bt_ctf_event
*event
,
717 struct bt_ctf_event_class
*writer_event_class
,
720 struct bt_ctf_event
*writer_event
= NULL
;
721 struct bt_ctf_field
*field
= NULL
, *copy_field
= NULL
;
724 writer_event
= bt_ctf_event_create(writer_event_class
);
726 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
731 field
= bt_ctf_event_get_header(event
);
733 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
739 * If override_ts64, we override all integer fields mapped to a clock
740 * to a uint64_t field type, otherwise, we just copy it as is.
743 copy_field
= bt_ctf_event_get_header(writer_event
);
745 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
750 ret
= copy_override_field(err
, event
, writer_event
, field
,
753 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
759 ret
= ctf_copy_event_header(err
, event
, writer_event_class
,
760 writer_event
, field
);
762 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
769 /* Optional field, so it can fail silently. */
770 field
= bt_ctf_event_get_stream_event_context(event
);
771 copy_field
= bt_ctf_field_copy(field
);
773 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
776 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
784 /* Optional field, so it can fail silently. */
785 field
= bt_ctf_event_get_event_context(event
);
786 copy_field
= bt_ctf_field_copy(field
);
788 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
790 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
798 field
= bt_ctf_event_get_event_payload(event
);
800 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
804 copy_field
= bt_ctf_field_copy(field
);
806 ret
= bt_ctf_event_set_event_payload(writer_event
, copy_field
);
808 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
819 BT_PUT(writer_event
);
827 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
828 struct bt_ctf_trace
*writer_trace
)
830 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
831 int field_count
, i
, int_ret
;
832 struct bt_ctf_field_type
*header_type
= NULL
;
833 enum bt_ctf_byte_order order
;
835 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
836 for (i
= 0; i
< field_count
; i
++) {
839 struct bt_value
*value
= NULL
;
841 name
= bt_ctf_trace_get_environment_field_name_by_index(
844 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
846 ret
= BT_COMPONENT_STATUS_ERROR
;
849 value
= bt_ctf_trace_get_environment_field_value_by_index(
852 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
854 ret
= BT_COMPONENT_STATUS_ERROR
;
858 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
862 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
864 fprintf(err
, "[error] Unable to set environment field %s\n",
866 ret
= BT_COMPONENT_STATUS_ERROR
;
871 order
= bt_ctf_trace_get_native_byte_order(trace
);
872 if (order
== BT_CTF_BYTE_ORDER_UNKNOWN
) {
873 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
874 ret
= BT_COMPONENT_STATUS_ERROR
;
879 * Only explicitly set the writer trace's native byte order if
880 * the original trace has a specific one. Otherwise leave what
881 * the CTF writer object chooses, which is the machine's native
884 if (order
!= BT_CTF_BYTE_ORDER_NONE
) {
885 ret
= bt_ctf_trace_set_native_byte_order(writer_trace
, order
);
887 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
888 ret
= BT_COMPONENT_STATUS_ERROR
;
893 header_type
= bt_ctf_trace_get_packet_header_type(writer_trace
);
895 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
898 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
899 ret
= BT_COMPONENT_STATUS_ERROR
;