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"
42 struct bt_ctf_clock_class
*ctf_copy_clock_class(FILE *err
,
43 struct bt_ctf_clock_class
*clock_class
)
45 int64_t offset
, offset_s
;
48 const char *name
, *description
;
49 struct bt_ctf_clock_class
*writer_clock_class
= NULL
;
51 assert(err
&& clock_class
);
53 name
= bt_ctf_clock_class_get_name(clock_class
);
55 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
60 writer_clock_class
= bt_ctf_clock_class_create(name
);
61 if (!writer_clock_class
) {
62 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
67 description
= bt_ctf_clock_class_get_description(clock_class
);
69 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
74 int_ret
= bt_ctf_clock_class_set_description(writer_clock_class
,
77 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
82 u64_ret
= bt_ctf_clock_class_get_frequency(clock_class
);
83 if (u64_ret
== -1ULL) {
84 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
88 int_ret
= bt_ctf_clock_class_set_frequency(writer_clock_class
, u64_ret
);
90 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
95 u64_ret
= bt_ctf_clock_class_get_precision(clock_class
);
96 if (u64_ret
== -1ULL) {
97 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
101 int_ret
= bt_ctf_clock_class_set_precision(writer_clock_class
,
104 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
109 int_ret
= bt_ctf_clock_class_get_offset_s(clock_class
, &offset_s
);
111 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
116 int_ret
= bt_ctf_clock_class_set_offset_s(writer_clock_class
, offset_s
);
118 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
123 int_ret
= bt_ctf_clock_class_get_offset_cycles(clock_class
, &offset
);
125 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
130 int_ret
= bt_ctf_clock_class_set_offset_cycles(writer_clock_class
, offset
);
132 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
137 int_ret
= bt_ctf_clock_class_get_is_absolute(clock_class
);
139 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
144 int_ret
= bt_ctf_clock_class_set_is_absolute(writer_clock_class
, int_ret
);
146 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
154 BT_PUT(writer_clock_class
);
156 return writer_clock_class
;
159 enum bt_component_status
ctf_copy_clock_classes(FILE *err
,
160 struct bt_ctf_trace
*writer_trace
,
161 struct bt_ctf_stream_class
*writer_stream_class
,
162 struct bt_ctf_trace
*trace
)
164 enum bt_component_status ret
;
165 int int_ret
, clock_class_count
, i
;
167 clock_class_count
= bt_ctf_trace_get_clock_class_count(trace
);
169 for (i
= 0; i
< clock_class_count
; i
++) {
170 struct bt_ctf_clock_class
*writer_clock_class
;
171 struct bt_ctf_clock_class
*clock_class
=
172 bt_ctf_trace_get_clock_class(trace
, i
);
175 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
177 ret
= BT_COMPONENT_STATUS_ERROR
;
181 writer_clock_class
= ctf_copy_clock_class(err
, clock_class
);
183 if (!writer_clock_class
) {
184 fprintf(err
, "Failed to copy clock class");
185 ret
= BT_COMPONENT_STATUS_ERROR
;
189 int_ret
= bt_ctf_trace_add_clock_class(writer_trace
, writer_clock_class
);
191 BT_PUT(writer_clock_class
);
192 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
194 ret
= BT_COMPONENT_STATUS_ERROR
;
199 * Ownership transferred to the trace.
201 bt_put(writer_clock_class
);
204 ret
= BT_COMPONENT_STATUS_OK
;
210 struct bt_ctf_event_class
*ctf_copy_event_class(FILE *err
,
211 struct bt_ctf_event_class
*event_class
)
213 struct bt_ctf_event_class
*writer_event_class
= NULL
;
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(event_class
, i
);
239 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
241 BT_PUT(writer_event_class
);
244 attr_value
= bt_ctf_event_class_get_attribute_value(event_class
, i
);
246 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
248 BT_PUT(writer_event_class
);
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__
,
258 BT_PUT(writer_event_class
);
263 count
= bt_ctf_event_class_get_field_count(event_class
);
264 for (i
= 0; i
< count
; i
++) {
265 const char *field_name
;
266 struct bt_ctf_field_type
*field_type
;
269 ret
= bt_ctf_event_class_get_field(event_class
, &field_name
,
272 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
273 BT_PUT(writer_event_class
);
277 ret
= bt_ctf_event_class_add_field(writer_event_class
, field_type
,
280 fprintf(err
, "[error] Cannot add field %s\n", field_name
);
281 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
283 BT_PUT(writer_event_class
);
290 return writer_event_class
;
293 enum bt_component_status
ctf_copy_event_classes(FILE *err
,
294 struct bt_ctf_stream_class
*stream_class
,
295 struct bt_ctf_stream_class
*writer_stream_class
)
297 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
300 count
= bt_ctf_stream_class_get_event_class_count(stream_class
);
302 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
307 for (i
= 0; i
< count
; i
++) {
308 struct bt_ctf_event_class
*event_class
, *writer_event_class
;
309 struct bt_ctf_field_type
*context
;
312 event_class
= bt_ctf_stream_class_get_event_class(
315 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
317 ret
= BT_COMPONENT_STATUS_ERROR
;
321 writer_event_class
= ctf_copy_event_class(err
, event_class
);
322 if (!writer_event_class
) {
323 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
325 ret
= BT_COMPONENT_STATUS_ERROR
;
330 context
= bt_ctf_event_class_get_context_type(event_class
);
331 ret
= bt_ctf_event_class_set_context_type(writer_event_class
, context
);
334 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
339 int_ret
= bt_ctf_stream_class_add_event_class(writer_stream_class
,
342 fprintf(err
, "[error] Failed to add event class\n");
343 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
345 ret
= BT_COMPONENT_STATUS_ERROR
;
350 bt_put(writer_event_class
);
357 struct bt_ctf_stream_class
*ctf_copy_stream_class(FILE *err
,
358 struct bt_ctf_stream_class
*stream_class
,
359 struct bt_ctf_trace
*writer_trace
,
362 struct bt_ctf_field_type
*type
, *new_event_header_type
;
363 struct bt_ctf_stream_class
*writer_stream_class
;
365 const char *name
= bt_ctf_stream_class_get_name(stream_class
);
367 if (strlen(name
) == 0) {
371 writer_stream_class
= bt_ctf_stream_class_create(name
);
372 if (!writer_stream_class
) {
373 fprintf(err
, "[error] %s in %s:%d\n",
374 __func__
, __FILE__
, __LINE__
);
378 type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
380 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
385 ret_int
= bt_ctf_stream_class_set_packet_context_type(
386 writer_stream_class
, type
);
389 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
394 type
= bt_ctf_stream_class_get_event_header_type(stream_class
);
396 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
402 new_event_header_type
= override_header_type(err
, type
,
405 if (!new_event_header_type
) {
406 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
411 new_event_header_type
= type
;
414 ret_int
= bt_ctf_stream_class_set_event_header_type(
415 writer_stream_class
, new_event_header_type
);
416 bt_put(new_event_header_type
);
418 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
423 type
= bt_ctf_stream_class_get_event_context_type(stream_class
);
425 ret_int
= bt_ctf_stream_class_set_event_context_type(
426 writer_stream_class
, type
);
429 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
438 BT_PUT(writer_stream_class
);
440 return writer_stream_class
;
443 enum bt_component_status
ctf_copy_packet_context_field(FILE *err
,
444 struct bt_ctf_field
*field
, const char *field_name
,
445 struct bt_ctf_field
*writer_packet_context
,
446 struct bt_ctf_field_type
*writer_packet_context_type
)
448 enum bt_component_status ret
;
449 struct bt_ctf_field
*writer_field
;
450 struct bt_ctf_field_type
*field_type
;
454 field_type
= bt_ctf_field_get_type(field
);
456 ret
= BT_COMPONENT_STATUS_ERROR
;
457 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
462 * Only support for integers for now.
464 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_TYPE_ID_INTEGER
) {
465 fprintf(err
, "[error] Unsupported packet context field type\n");
467 ret
= BT_COMPONENT_STATUS_ERROR
;
473 * TODO: handle the special case of the first/last packet that might
474 * be trimmed. In these cases, the timestamp_begin/end need to be
475 * explicitely set to the first/last event timestamps.
477 writer_field
= bt_ctf_field_structure_get_field(writer_packet_context
,
480 ret
= BT_COMPONENT_STATUS_ERROR
;
481 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
487 int_ret
= bt_ctf_field_unsigned_integer_get_value(field
, &value
);
489 fprintf(err
, "[error] Wrong packet_context field type\n");
490 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
492 ret
= BT_COMPONENT_STATUS_ERROR
;
493 goto end_put_writer_field
;
496 int_ret
= bt_ctf_field_unsigned_integer_set_value(writer_field
, value
);
498 ret
= BT_COMPONENT_STATUS_ERROR
;
499 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
501 goto end_put_writer_field
;
504 ret
= BT_COMPONENT_STATUS_OK
;
506 end_put_writer_field
:
507 bt_put(writer_field
);
512 struct bt_ctf_field
*ctf_copy_packet_context(FILE *err
,
513 struct bt_ctf_packet
*packet
,
514 struct bt_ctf_stream
*writer_stream
)
516 enum bt_component_status ret
;
517 struct bt_ctf_field
*packet_context
, *writer_packet_context
= NULL
;
518 struct bt_ctf_field_type
*struct_type
, *writer_packet_context_type
;
519 struct bt_ctf_stream_class
*writer_stream_class
;
522 packet_context
= bt_ctf_packet_get_context(packet
);
523 if (!packet_context
) {
524 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
529 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
530 if (!writer_stream_class
) {
531 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
533 goto end_put_packet_context
;
536 writer_packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
537 writer_stream_class
);
538 if (!writer_packet_context_type
) {
539 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
541 goto end_put_writer_stream_class
;
544 struct_type
= bt_ctf_field_get_type(packet_context
);
546 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
548 goto end_put_writer_packet_context_type
;
551 writer_packet_context
= bt_ctf_field_create(writer_packet_context_type
);
552 if (!writer_packet_context
) {
553 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
555 goto end_put_struct_type
;
558 nr_fields
= bt_ctf_field_type_structure_get_field_count(struct_type
);
559 for (i
= 0; i
< nr_fields
; i
++) {
560 struct bt_ctf_field
*field
;
561 struct bt_ctf_field_type
*field_type
;
562 const char *field_name
;
564 field
= bt_ctf_field_structure_get_field_by_index(
567 BT_PUT(writer_packet_context
);
568 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
570 goto end_put_struct_type
;
572 if (bt_ctf_field_type_structure_get_field(struct_type
,
573 &field_name
, &field_type
, i
) < 0) {
575 BT_PUT(writer_packet_context
);
576 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
578 goto end_put_struct_type
;
580 if (!strncmp(field_name
, "content_size", strlen("content_size")) ||
581 !strncmp(field_name
, "packet_size",
582 strlen("packet_size"))) {
588 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_TYPE_ID_INTEGER
) {
589 fprintf(err
, "[error] Unexpected packet context field type\n");
591 BT_PUT(writer_packet_context
);
592 goto end_put_struct_type
;
595 ret
= ctf_copy_packet_context_field(err
, field
, field_name
,
596 writer_packet_context
, writer_packet_context_type
);
599 if (ret
!= BT_COMPONENT_STATUS_OK
) {
600 BT_PUT(writer_packet_context
);
601 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
603 goto end_put_struct_type
;
609 end_put_writer_packet_context_type
:
610 bt_put(writer_packet_context_type
);
611 end_put_writer_stream_class
:
612 bt_put(writer_stream_class
);
613 end_put_packet_context
:
614 bt_put(packet_context
);
616 return writer_packet_context
;
620 int copy_event_header(FILE *err
, struct bt_ctf_event
*event
,
621 struct bt_ctf_event_class
*writer_event_class
,
622 struct bt_ctf_event
*writer_event
,
623 struct bt_ctf_field
*event_header
)
625 struct bt_ctf_clock_class
*writer_clock_class
;
626 struct bt_ctf_clock_value
*clock_value
;
629 struct bt_ctf_field
*writer_event_header
;
631 writer_event_header
= bt_ctf_field_copy(event_header
);
632 if (!writer_event_header
) {
633 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
639 writer_clock_class
= event_get_clock_class(err
, writer_event
);
640 if (!writer_clock_class
) {
641 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
646 clock_value
= bt_ctf_event_get_clock_value(event
, writer_clock_class
);
647 bt_put(writer_clock_class
);
649 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
654 ret
= bt_ctf_event_set_clock_value(writer_event
, clock_value
);
657 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
662 ret
= bt_ctf_event_set_header(writer_event
, writer_event_header
);
664 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
668 bt_put(writer_event_header
);
675 BT_PUT(writer_event_header
);
681 struct bt_ctf_event
*ctf_copy_event(FILE *err
, struct bt_ctf_event
*event
,
682 struct bt_ctf_event_class
*writer_event_class
,
685 struct bt_ctf_event
*writer_event
;
686 struct bt_ctf_field
*field
, *copy_field
;
689 writer_event
= bt_ctf_event_create(writer_event_class
);
691 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
696 field
= bt_ctf_event_get_header(event
);
698 BT_PUT(writer_event
);
699 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
705 * If override_ts64, we override all integer fields mapped to a clock
706 * to a uint64_t field type, otherwise, we just copy it as is.
709 copy_field
= bt_ctf_event_get_header(writer_event
);
711 BT_PUT(writer_event
);
713 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
718 ret
= copy_override_field(err
, event
, writer_event
, field
,
722 BT_PUT(writer_event
);
724 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
729 ret
= copy_event_header(err
, event
, writer_event_class
,
730 writer_event
, field
);
732 BT_PUT(writer_event
);
733 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
739 /* Optional field, so it can fail silently. */
740 field
= bt_ctf_event_get_stream_event_context(event
);
741 copy_field
= bt_ctf_field_copy(field
);
744 ret
= bt_ctf_event_set_stream_event_context(writer_event
,
748 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
754 /* Optional field, so it can fail silently. */
755 field
= bt_ctf_event_get_event_context(event
);
756 copy_field
= bt_ctf_field_copy(field
);
759 ret
= bt_ctf_event_set_event_context(writer_event
, copy_field
);
762 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
768 field
= bt_ctf_event_get_payload_field(event
);
770 BT_PUT(writer_event
);
771 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
775 copy_field
= bt_ctf_field_copy(field
);
778 ret
= bt_ctf_event_set_payload_field(writer_event
, copy_field
);
781 fprintf(err
, "[error] %s in %s:%d\n", __func__
,
789 BT_PUT(writer_event
);
794 enum bt_component_status
ctf_copy_trace(FILE *err
, struct bt_ctf_trace
*trace
,
795 struct bt_ctf_trace
*writer_trace
)
797 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
798 int field_count
, i
, int_ret
;
799 struct bt_ctf_field_type
*header_type
;
801 field_count
= bt_ctf_trace_get_environment_field_count(trace
);
802 for (i
= 0; i
< field_count
; i
++) {
805 struct bt_value
*value
;
807 name
= bt_ctf_trace_get_environment_field_name(trace
, i
);
809 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
811 ret
= BT_COMPONENT_STATUS_ERROR
;
812 goto end_put_writer_trace
;
814 value
= bt_ctf_trace_get_environment_field_value(trace
, i
);
816 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
818 ret
= BT_COMPONENT_STATUS_ERROR
;
819 goto end_put_writer_trace
;
822 ret_int
= bt_ctf_trace_set_environment_field(writer_trace
,
826 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
,
828 fprintf(err
, "[error] Unable to set environment field %s\n",
830 ret
= BT_COMPONENT_STATUS_ERROR
;
831 goto end_put_writer_trace
;
835 header_type
= bt_ctf_trace_get_packet_header_type(writer_trace
);
837 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
838 ret
= BT_COMPONENT_STATUS_ERROR
;
839 goto end_put_writer_trace
;
842 int_ret
= bt_ctf_trace_set_packet_header_type(writer_trace
, header_type
);
844 fprintf(err
, "[error] %s in %s:%d\n", __func__
, __FILE__
, __LINE__
);
845 ret
= BT_COMPONENT_STATUS_ERROR
;
846 goto end_put_header_type
;
851 end_put_writer_trace
: