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 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
420 struct bt_ctf_field_type
*new_event_header_type
;
422 new_event_header_type
= override_header_type(err
, type
,
424 if (!new_event_header_type
) {
425 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
429 ret_int
= bt_ctf_stream_class_set_event_header_type(
430 writer_stream_class
, new_event_header_type
);
431 BT_PUT(new_event_header_type
);
433 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
438 ret_int
= bt_ctf_stream_class_set_event_header_type(
439 writer_stream_class
, type
);
441 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
448 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
450 ret_int
= bt_ctf_stream_class_set_event_context_type(
451 writer_stream_class
, type
);
453 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
463 BT_PUT(writer_stream_class
);
466 return writer_stream_class
;
470 enum bt_component_status
ctf_copy_packet_context_field(FILE *err
,
471 struct bt_ctf_field
*field
, const char *field_name
,
472 struct bt_ctf_field
*writer_packet_context
,
473 struct bt_ctf_field_type
*writer_packet_context_type
)
475 enum bt_component_status ret
;
476 struct bt_ctf_field
*writer_field
= NULL
;
477 struct bt_ctf_field_type
*field_type
= NULL
;
481 field_type
= bt_ctf_field_get_type(field
);
483 ret
= BT_COMPONENT_STATUS_ERROR
;
484 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
489 * Only support for integers for now.
491 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
492 fprintf(err
, "[error] Unsupported packet context field type\n");
493 ret
= BT_COMPONENT_STATUS_ERROR
;
498 writer_field
= bt_ctf_field_structure_get_field_by_name(
499 writer_packet_context
, field_name
);
501 ret
= BT_COMPONENT_STATUS_ERROR
;
502 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
507 int_ret
= bt_ctf_field_unsigned_integer_get_value(field
, &value
);
509 fprintf(err
, "[error] Wrong packet_context field type\n");
510 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
512 ret
= BT_COMPONENT_STATUS_ERROR
;
516 int_ret
= bt_ctf_field_unsigned_integer_set_value(writer_field
, value
);
518 ret
= BT_COMPONENT_STATUS_ERROR
;
519 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
524 ret
= BT_COMPONENT_STATUS_OK
;
531 bt_put(writer_field
);
536 struct bt_ctf_field
*ctf_copy_packet_context(FILE *err
,
537 struct bt_ctf_packet
*packet
,
538 struct bt_ctf_stream
*writer_stream
)
540 enum bt_component_status ret
;
541 struct bt_ctf_field
*packet_context
= NULL
, *writer_packet_context
= NULL
;
542 struct bt_ctf_field_type
*struct_type
= NULL
, *writer_packet_context_type
= NULL
;
543 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
544 struct bt_ctf_field
*field
= NULL
;
545 struct bt_ctf_field_type
*field_type
= NULL
;
548 packet_context
= bt_ctf_packet_get_context(packet
);
549 if (!packet_context
) {
553 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
554 if (!writer_stream_class
) {
555 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
560 writer_packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
561 writer_stream_class
);
562 BT_PUT(writer_stream_class
);
563 if (!writer_packet_context_type
) {
564 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
569 struct_type
= bt_ctf_field_get_type(packet_context
);
571 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
576 writer_packet_context
= bt_ctf_field_create(writer_packet_context_type
);
577 if (!writer_packet_context
) {
578 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
583 nr_fields
= bt_ctf_field_type_structure_get_field_count(struct_type
);
584 for (i
= 0; i
< nr_fields
; i
++) {
585 const char *field_name
;
587 field
= bt_ctf_field_structure_get_field_by_index(
590 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
594 if (bt_ctf_field_type_structure_get_field_by_index(struct_type
,
595 &field_name
, &field_type
, i
) < 0) {
596 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
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
);
772 copy_field
= bt_ctf_field_copy(field
);
774 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
778 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
781 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
789 /* Optional field, so it can fail silently. */
790 field
= bt_ctf_event_get_event_context(event
);
792 copy_field
= bt_ctf_field_copy(field
);
794 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
798 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
800 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
808 field
= bt_ctf_event_get_event_payload(event
);
810 copy_field
= bt_ctf_field_copy(field
);
812 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
816 ret
= bt_ctf_event_set_event_payload(writer_event
, copy_field
);
818 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
829 BT_PUT(writer_event
);
837 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
838 struct bt_ctf_trace
*writer_trace
)
840 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
841 int field_count
, i
, int_ret
;
842 struct bt_ctf_field_type
*header_type
= NULL
;
843 enum bt_ctf_byte_order order
;
844 const char *trace_name
;
846 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
847 for (i
= 0; i
< field_count
; i
++) {
850 struct bt_value
*value
= NULL
;
852 name
= bt_ctf_trace_get_environment_field_name_by_index(
855 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
857 ret
= BT_COMPONENT_STATUS_ERROR
;
860 value
= bt_ctf_trace_get_environment_field_value_by_index(
863 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
865 ret
= BT_COMPONENT_STATUS_ERROR
;
869 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
873 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
875 fprintf(err
, "[error] Unable to set environment field %s\n",
877 ret
= BT_COMPONENT_STATUS_ERROR
;
882 order
= bt_ctf_trace_get_native_byte_order(trace
);
883 if (order
== BT_CTF_BYTE_ORDER_UNKNOWN
) {
884 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
885 ret
= BT_COMPONENT_STATUS_ERROR
;
890 * Only explicitly set the writer trace's native byte order if
891 * the original trace has a specific one. Otherwise leave what
892 * the CTF writer object chooses, which is the machine's native
895 if (order
!= BT_CTF_BYTE_ORDER_UNSPECIFIED
) {
896 ret
= bt_ctf_trace_set_native_byte_order(writer_trace
, order
);
898 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
899 ret
= BT_COMPONENT_STATUS_ERROR
;
904 header_type
= bt_ctf_trace_get_packet_header_type(writer_trace
);
906 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
909 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
910 ret
= BT_COMPONENT_STATUS_ERROR
;
915 trace_name
= bt_ctf_trace_get_name(trace
);
917 int_ret
= bt_ctf_trace_set_name(writer_trace
, trace_name
);
919 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
920 ret
= BT_COMPONENT_STATUS_ERROR
;