projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ctf: make src.ctf.fs not recurse
[babeltrace.git] / src / plugins / ctf / fs-src / fs.c
1 /*
2 * fs.c
3 *
4 * Babeltrace CTF file system Reader Component
5 *
6 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 */
27
28 #define BT_COMP_LOG_SELF_COMP self_comp
29 #define BT_LOG_OUTPUT_LEVEL log_level
30 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
31 #include "logging/comp-logging.h"
32
33 #include "common/common.h"
34 #include <babeltrace2/babeltrace.h>
35 #include "common/uuid.h"
36 #include <glib.h>
37 #include "common/assert.h"
38 #include <inttypes.h>
39 #include <stdbool.h>
40 #include "fs.h"
41 #include "metadata.h"
42 #include "data-stream-file.h"
43 #include "file.h"
44 #include "../common/metadata/decoder.h"
45 #include "../common/metadata/ctf-meta-configure-ir-trace.h"
46 #include "../common/msg-iter/msg-iter.h"
47 #include "query.h"
48
49 struct tracer_info {
50 const char *name;
51 int64_t major;
52 int64_t minor;
53 int64_t patch;
54 };
55
56 static
57 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data)
58 {
59 struct ctf_fs_ds_file_info *ds_file_info;
60 int ret = 0;
61
62 BT_ASSERT(msg_iter_data->ds_file_info_index <
63 msg_iter_data->ds_file_group->ds_file_infos->len);
64 ds_file_info = g_ptr_array_index(
65 msg_iter_data->ds_file_group->ds_file_infos,
66 msg_iter_data->ds_file_info_index);
67
68 ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
69 msg_iter_data->ds_file = ctf_fs_ds_file_create(
70 msg_iter_data->ds_file_group->ctf_fs_trace,
71 msg_iter_data->pc_msg_iter,
72 msg_iter_data->msg_iter,
73 msg_iter_data->ds_file_group->stream,
74 ds_file_info->path->str,
75 msg_iter_data->log_level);
76 if (!msg_iter_data->ds_file) {
77 ret = -1;
78 }
79
80 return ret;
81 }
82
83 static
84 void ctf_fs_msg_iter_data_destroy(
85 struct ctf_fs_msg_iter_data *msg_iter_data)
86 {
87 if (!msg_iter_data) {
88 return;
89 }
90
91 ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
92
93 if (msg_iter_data->msg_iter) {
94 bt_msg_iter_destroy(msg_iter_data->msg_iter);
95 }
96
97 g_free(msg_iter_data);
98 }
99
100 static
101 void set_msg_iter_emits_stream_beginning_end_messages(
102 struct ctf_fs_msg_iter_data *msg_iter_data)
103 {
104 bt_msg_iter_set_emit_stream_beginning_message(
105 msg_iter_data->ds_file->msg_iter,
106 msg_iter_data->ds_file_info_index == 0);
107 bt_msg_iter_set_emit_stream_end_message(
108 msg_iter_data->ds_file->msg_iter,
109 msg_iter_data->ds_file_info_index ==
110 msg_iter_data->ds_file_group->ds_file_infos->len - 1);
111 }
112
113 static
114 bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next_one(
115 struct ctf_fs_msg_iter_data *msg_iter_data,
116 const bt_message **out_msg)
117 {
118 bt_component_class_message_iterator_next_method_status status;
119
120 BT_ASSERT(msg_iter_data->ds_file);
121
122 while (true) {
123 bt_message *msg;
124
125 status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg);
126 switch (status) {
127 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK:
128 *out_msg = msg;
129 msg = NULL;
130 goto end;
131 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END:
132 {
133 int ret;
134
135 if (msg_iter_data->ds_file_info_index ==
136 msg_iter_data->ds_file_group->ds_file_infos->len - 1) {
137 /* End of all group's stream files */
138 goto end;
139 }
140
141 msg_iter_data->ds_file_info_index++;
142 bt_msg_iter_reset_for_next_stream_file(
143 msg_iter_data->msg_iter);
144 set_msg_iter_emits_stream_beginning_end_messages(
145 msg_iter_data);
146
147 /*
148 * Open and start reading the next stream file
149 * within our stream file group.
150 */
151 ret = msg_iter_data_set_current_ds_file(msg_iter_data);
152 if (ret) {
153 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
154 goto end;
155 }
156
157 /* Continue the loop to get the next message */
158 break;
159 }
160 default:
161 goto end;
162 }
163 }
164
165 end:
166 return status;
167 }
168
169 BT_HIDDEN
170 bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
171 bt_self_message_iterator *iterator,
172 bt_message_array_const msgs, uint64_t capacity,
173 uint64_t *count)
174 {
175 bt_component_class_message_iterator_next_method_status status =
176 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
177 struct ctf_fs_msg_iter_data *msg_iter_data =
178 bt_self_message_iterator_get_data(iterator);
179 uint64_t i = 0;
180
181 while (i < capacity &&
182 status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
183 status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]);
184 if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
185 i++;
186 }
187 }
188
189 if (i > 0) {
190 /*
191 * Even if ctf_fs_iterator_next_one() returned something
192 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
193 * accumulated message objects in the output
194 * message array, so we need to return
195 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
196 * transfered to downstream. This other status occurs
197 * again the next time muxer_msg_iter_do_next() is
198 * called, possibly without any accumulated
199 * message, in which case we'll return it.
200 */
201 *count = i;
202 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
203 }
204
205 return status;
206 }
207
208 static
209 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data)
210 {
211 int ret;
212
213 msg_iter_data->ds_file_info_index = 0;
214 ret = msg_iter_data_set_current_ds_file(msg_iter_data);
215 if (ret) {
216 goto end;
217 }
218
219 bt_msg_iter_reset(msg_iter_data->msg_iter);
220 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data);
221
222 end:
223 return ret;
224 }
225
226 BT_HIDDEN
227 bt_component_class_message_iterator_seek_beginning_method_status
228 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it)
229 {
230 struct ctf_fs_msg_iter_data *msg_iter_data =
231 bt_self_message_iterator_get_data(it);
232 bt_component_class_message_iterator_seek_beginning_method_status status =
233 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK;
234
235 BT_ASSERT(msg_iter_data);
236 if (ctf_fs_iterator_reset(msg_iter_data)) {
237 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR;
238 }
239
240 return status;
241 }
242
243 BT_HIDDEN
244 void ctf_fs_iterator_finalize(bt_self_message_iterator *it)
245 {
246 ctf_fs_msg_iter_data_destroy(
247 bt_self_message_iterator_get_data(it));
248 }
249
250 BT_HIDDEN
251 bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
252 bt_self_message_iterator *self_msg_iter,
253 bt_self_component_source *self_comp_src,
254 bt_self_component_port_output *self_port)
255 {
256 struct ctf_fs_port_data *port_data;
257 struct ctf_fs_msg_iter_data *msg_iter_data = NULL;
258 bt_component_class_message_iterator_init_method_status ret =
259 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
260 bt_logging_level log_level;
261 bt_self_component *self_comp =
262 bt_self_component_source_as_self_component(self_comp_src);
263
264 port_data = bt_self_component_port_get_data(
265 bt_self_component_port_output_as_self_component_port(
266 self_port));
267 BT_ASSERT(port_data);
268 log_level = port_data->ctf_fs->log_level;
269 msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1);
270 if (!msg_iter_data) {
271 ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
272 goto error;
273 }
274
275 msg_iter_data->log_level = log_level;
276 msg_iter_data->self_comp = self_comp;
277 msg_iter_data->pc_msg_iter = self_msg_iter;
278 msg_iter_data->msg_iter = bt_msg_iter_create(
279 port_data->ds_file_group->ctf_fs_trace->metadata->tc,
280 bt_common_get_page_size(msg_iter_data->log_level) * 8,
281 ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level,
282 self_comp);
283 if (!msg_iter_data->msg_iter) {
284 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create a CTF message iterator.");
285 ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
286 goto error;
287 }
288
289 msg_iter_data->ds_file_group = port_data->ds_file_group;
290 if (ctf_fs_iterator_reset(msg_iter_data)) {
291 ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
292 goto error;
293 }
294
295 bt_self_message_iterator_set_data(self_msg_iter,
296 msg_iter_data);
297 if (ret != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK) {
298 goto error;
299 }
300
301 msg_iter_data = NULL;
302 goto end;
303
304 error:
305 bt_self_message_iterator_set_data(self_msg_iter, NULL);
306
307 end:
308 ctf_fs_msg_iter_data_destroy(msg_iter_data);
309 return ret;
310 }
311
312 BT_HIDDEN
313 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs)
314 {
315 if (!ctf_fs) {
316 return;
317 }
318
319 if (ctf_fs->traces) {
320 g_ptr_array_free(ctf_fs->traces, TRUE);
321 }
322
323 if (ctf_fs->port_data) {
324 g_ptr_array_free(ctf_fs->port_data, TRUE);
325 }
326
327 g_free(ctf_fs);
328 }
329
330 static
331 void port_data_destroy(struct ctf_fs_port_data *port_data)
332 {
333 if (!port_data) {
334 return;
335 }
336
337 g_free(port_data);
338 }
339
340 static
341 void port_data_destroy_notifier(void *data) {
342 port_data_destroy(data);
343 }
344
345 static
346 void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace)
347 {
348 if (!ctf_fs_trace) {
349 return;
350 }
351
352 if (ctf_fs_trace->ds_file_groups) {
353 g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE);
354 }
355
356 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace);
357
358 if (ctf_fs_trace->path) {
359 g_string_free(ctf_fs_trace->path, TRUE);
360 }
361
362 if (ctf_fs_trace->metadata) {
363 ctf_fs_metadata_fini(ctf_fs_trace->metadata);
364 g_free(ctf_fs_trace->metadata);
365 }
366
367 g_free(ctf_fs_trace);
368 }
369
370 static
371 void ctf_fs_trace_destroy_notifier(void *data)
372 {
373 struct ctf_fs_trace *trace = data;
374 ctf_fs_trace_destroy(trace);
375 }
376
377 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
378 bt_self_component *self_comp)
379 {
380 struct ctf_fs_component *ctf_fs;
381
382 ctf_fs = g_new0(struct ctf_fs_component, 1);
383 if (!ctf_fs) {
384 goto error;
385 }
386
387 ctf_fs->log_level = log_level;
388 ctf_fs->port_data =
389 g_ptr_array_new_with_free_func(port_data_destroy_notifier);
390 if (!ctf_fs->port_data) {
391 goto error;
392 }
393
394 ctf_fs->traces =
395 g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier);
396 if (!ctf_fs->traces) {
397 goto error;
398 }
399
400 goto end;
401
402 error:
403 ctf_fs_destroy(ctf_fs);
404 ctf_fs = NULL;
405
406 end:
407 return ctf_fs;
408 }
409
410 void ctf_fs_finalize(bt_self_component_source *component)
411 {
412 ctf_fs_destroy(bt_self_component_get_data(
413 bt_self_component_source_as_self_component(component)));
414 }
415
416 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group)
417 {
418 GString *name = g_string_new(NULL);
419
420 /*
421 * The unique port name is generated by concatenating unique identifiers
422 * for:
423 *
424 * - the trace
425 * - the stream class
426 * - the stream
427 */
428
429 /* For the trace, use the uuid if present, else the path. */
430 if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) {
431 char uuid_str[BT_UUID_STR_LEN + 1];
432
433 bt_uuid_to_str(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str);
434 g_string_assign(name, uuid_str);
435 } else {
436 g_string_assign(name, ds_file_group->ctf_fs_trace->path->str);
437 }
438
439 /*
440 * For the stream class, use the id if present. We can omit this field
441 * otherwise, as there will only be a single stream class.
442 */
443 if (ds_file_group->sc->id != UINT64_C(-1)) {
444 g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id);
445 }
446
447 /* For the stream, use the id if present, else, use the path. */
448 if (ds_file_group->stream_id != UINT64_C(-1)) {
449 g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id);
450 } else {
451 BT_ASSERT(ds_file_group->ds_file_infos->len == 1);
452 struct ctf_fs_ds_file_info *ds_file_info =
453 g_ptr_array_index(ds_file_group->ds_file_infos, 0);
454 g_string_append_printf(name, " | %s", ds_file_info->path->str);
455 }
456
457 return g_string_free(name, FALSE);
458 }
459
460 static
461 int create_one_port_for_trace(struct ctf_fs_component *ctf_fs,
462 struct ctf_fs_trace *ctf_fs_trace,
463 struct ctf_fs_ds_file_group *ds_file_group,
464 bt_self_component_source *self_comp_src)
465 {
466 int ret = 0;
467 struct ctf_fs_port_data *port_data = NULL;
468 gchar *port_name;
469 bt_logging_level log_level = ctf_fs->log_level;
470 bt_self_component *self_comp =
471 bt_self_component_source_as_self_component(self_comp_src);
472
473 port_name = ctf_fs_make_port_name(ds_file_group);
474 if (!port_name) {
475 goto error;
476 }
477
478 BT_COMP_LOGI("Creating one port named `%s`", port_name);
479
480 /* Create output port for this file */
481 port_data = g_new0(struct ctf_fs_port_data, 1);
482 if (!port_data) {
483 goto error;
484 }
485
486 port_data->ctf_fs = ctf_fs;
487 port_data->ds_file_group = ds_file_group;
488 ret = bt_self_component_source_add_output_port(
489 self_comp_src, port_name, port_data, NULL);
490 if (ret) {
491 goto error;
492 }
493
494 g_ptr_array_add(ctf_fs->port_data, port_data);
495 port_data = NULL;
496 goto end;
497
498 error:
499 ret = -1;
500
501 end:
502 g_free(port_name);
503
504 port_data_destroy(port_data);
505 return ret;
506 }
507
508 static
509 int create_ports_for_trace(struct ctf_fs_component *ctf_fs,
510 struct ctf_fs_trace *ctf_fs_trace,
511 bt_self_component_source *self_comp_src)
512 {
513 int ret = 0;
514 size_t i;
515 bt_logging_level log_level = ctf_fs_trace->log_level;
516 bt_self_component *self_comp =
517 bt_self_component_source_as_self_component(self_comp_src);
518
519 /* Create one output port for each stream file group */
520 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
521 struct ctf_fs_ds_file_group *ds_file_group =
522 g_ptr_array_index(ctf_fs_trace->ds_file_groups, i);
523
524 ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace,
525 ds_file_group, self_comp_src);
526 if (ret) {
527 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create output port.");
528 goto end;
529 }
530 }
531
532 end:
533 return ret;
534 }
535
536 static
537 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info)
538 {
539 if (!ds_file_info) {
540 return;
541 }
542
543 if (ds_file_info->path) {
544 g_string_free(ds_file_info->path, TRUE);
545 }
546
547 g_free(ds_file_info);
548 }
549
550 static
551 struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path,
552 int64_t begin_ns)
553 {
554 struct ctf_fs_ds_file_info *ds_file_info;
555
556 ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1);
557 if (!ds_file_info) {
558 goto end;
559 }
560
561 ds_file_info->path = g_string_new(path);
562 if (!ds_file_info->path) {
563 ctf_fs_ds_file_info_destroy(ds_file_info);
564 ds_file_info = NULL;
565 goto end;
566 }
567
568 ds_file_info->begin_ns = begin_ns;
569
570 end:
571 return ds_file_info;
572 }
573
574 static
575 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group)
576 {
577 if (!ds_file_group) {
578 return;
579 }
580
581 if (ds_file_group->ds_file_infos) {
582 g_ptr_array_free(ds_file_group->ds_file_infos, TRUE);
583 }
584
585 if (ds_file_group->index) {
586 if (ds_file_group->index->entries) {
587 g_ptr_array_free(ds_file_group->index->entries, TRUE);
588 }
589 g_free(ds_file_group->index);
590 }
591
592 bt_stream_put_ref(ds_file_group->stream);
593 g_free(ds_file_group);
594 }
595
596 static
597 struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create(
598 struct ctf_fs_trace *ctf_fs_trace,
599 struct ctf_stream_class *sc,
600 uint64_t stream_instance_id,
601 struct ctf_fs_ds_index *index)
602 {
603 struct ctf_fs_ds_file_group *ds_file_group;
604
605 ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1);
606 if (!ds_file_group) {
607 goto error;
608 }
609
610 ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func(
611 (GDestroyNotify) ctf_fs_ds_file_info_destroy);
612 if (!ds_file_group->ds_file_infos) {
613 goto error;
614 }
615
616 ds_file_group->index = index;
617
618 ds_file_group->stream_id = stream_instance_id;
619 BT_ASSERT(sc);
620 ds_file_group->sc = sc;
621 ds_file_group->ctf_fs_trace = ctf_fs_trace;
622 goto end;
623
624 error:
625 ctf_fs_ds_file_group_destroy(ds_file_group);
626 ctf_fs_ds_index_destroy(index);
627 ds_file_group = NULL;
628
629 end:
630 return ds_file_group;
631 }
632
633 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
634 static
635 void array_insert(GPtrArray *array, gpointer element, size_t pos)
636 {
637 size_t original_array_len = array->len;
638
639 /* Allocate an unused element at the end of the array. */
640 g_ptr_array_add(array, NULL);
641
642 /* If we are not inserting at the end, move the elements by one. */
643 if (pos < original_array_len) {
644 memmove(&(array->pdata[pos + 1]),
645 &(array->pdata[pos]),
646 (original_array_len - pos) * sizeof(gpointer));
647 }
648
649 /* Insert the value. */
650 array->pdata[pos] = element;
651 }
652
653 /*
654 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
655 * place to keep it sorted.
656 */
657
658 static
659 void ds_file_group_insert_ds_file_info_sorted(
660 struct ctf_fs_ds_file_group *ds_file_group,
661 struct ctf_fs_ds_file_info *ds_file_info)
662 {
663 guint i;
664
665 /* Find the spot where to insert this ds_file_info. */
666 for (i = 0; i < ds_file_group->ds_file_infos->len; i++) {
667 struct ctf_fs_ds_file_info *other_ds_file_info =
668 g_ptr_array_index(ds_file_group->ds_file_infos, i);
669
670 if (ds_file_info->begin_ns < other_ds_file_info->begin_ns) {
671 break;
672 }
673 }
674
675 array_insert(ds_file_group->ds_file_infos, ds_file_info, i);
676 }
677
678 static
679 void ds_file_group_insert_ds_index_entry_sorted(
680 struct ctf_fs_ds_file_group *ds_file_group,
681 struct ctf_fs_ds_index_entry *entry)
682 {
683 guint i;
684
685 /* Find the spot where to insert this index entry. */
686 for (i = 0; i < ds_file_group->index->entries->len; i++) {
687 struct ctf_fs_ds_index_entry *other_entry = g_ptr_array_index(
688 ds_file_group->index->entries, i);
689
690 if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) {
691 break;
692 }
693 }
694
695 array_insert(ds_file_group->index->entries, entry, i);
696 }
697
698 static
699 int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace,
700 const char *path)
701 {
702 int64_t stream_instance_id = -1;
703 int64_t begin_ns = -1;
704 struct ctf_fs_ds_file_group *ds_file_group = NULL;
705 bool add_group = false;
706 int ret;
707 size_t i;
708 struct ctf_fs_ds_file *ds_file = NULL;
709 struct ctf_fs_ds_file_info *ds_file_info = NULL;
710 struct ctf_fs_ds_index *index = NULL;
711 struct bt_msg_iter *msg_iter = NULL;
712 struct ctf_stream_class *sc = NULL;
713 struct bt_msg_iter_packet_properties props;
714 bt_logging_level log_level = ctf_fs_trace->log_level;
715 bt_self_component *self_comp = ctf_fs_trace->self_comp;
716
717 msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc,
718 bt_common_get_page_size(log_level) * 8,
719 ctf_fs_ds_file_medops, NULL, log_level, self_comp);
720 if (!msg_iter) {
721 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
722 goto error;
723 }
724
725 ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
726 NULL, path, log_level);
727 if (!ds_file) {
728 goto error;
729 }
730
731 ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
732 if (ret) {
733 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
734 "Cannot get stream file's first packet's header and context fields (`%s`).",
735 path);
736 goto error;
737 }
738
739 sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
740 props.stream_class_id);
741 BT_ASSERT(sc);
742 stream_instance_id = props.data_stream_id;
743
744 if (props.snapshots.beginning_clock != UINT64_C(-1)) {
745 BT_ASSERT(sc->default_clock_class);
746 ret = bt_util_clock_cycles_to_ns_from_origin(
747 props.snapshots.beginning_clock,
748 sc->default_clock_class->frequency,
749 sc->default_clock_class->offset_seconds,
750 sc->default_clock_class->offset_cycles, &begin_ns);
751 if (ret) {
752 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
753 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
754 path);
755 goto error;
756 }
757 }
758
759 ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns);
760 if (!ds_file_info) {
761 goto error;
762 }
763
764 index = ctf_fs_ds_file_build_index(ds_file, ds_file_info);
765 if (!index) {
766 BT_COMP_LOGW("Failed to index CTF stream file \'%s\'",
767 ds_file->file->path->str);
768 }
769
770 if (begin_ns == -1) {
771 /*
772 * No beggining timestamp to sort the stream files
773 * within a stream file group, so consider that this
774 * file must be the only one within its group.
775 */
776 stream_instance_id = -1;
777 }
778
779 if (stream_instance_id == -1) {
780 /*
781 * No stream instance ID or no beginning timestamp:
782 * create a unique stream file group for this stream
783 * file because, even if there's a stream instance ID,
784 * there's no timestamp to order the file within its
785 * group.
786 */
787 ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
788 sc, UINT64_C(-1), index);
789 /* Ownership of index is transferred. */
790 index = NULL;
791
792 if (!ds_file_group) {
793 goto error;
794 }
795
796 ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info);
797
798 add_group = true;
799 goto end;
800 }
801
802 BT_ASSERT(stream_instance_id != -1);
803 BT_ASSERT(begin_ns != -1);
804
805 /* Find an existing stream file group with this ID */
806 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
807 ds_file_group = g_ptr_array_index(
808 ctf_fs_trace->ds_file_groups, i);
809
810 if (ds_file_group->sc == sc &&
811 ds_file_group->stream_id ==
812 stream_instance_id) {
813 break;
814 }
815
816 ds_file_group = NULL;
817 }
818
819 if (!ds_file_group) {
820 ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
821 sc, stream_instance_id, index);
822 /* Ownership of index is transferred. */
823 index = NULL;
824 if (!ds_file_group) {
825 goto error;
826 }
827
828 add_group = true;
829 }
830
831 ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info);
832
833 goto end;
834
835 error:
836 ctf_fs_ds_file_group_destroy(ds_file_group);
837 ds_file_group = NULL;
838 ret = -1;
839
840 end:
841 if (add_group && ds_file_group) {
842 g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group);
843 }
844
845 ctf_fs_ds_file_destroy(ds_file);
846
847 if (msg_iter) {
848 bt_msg_iter_destroy(msg_iter);
849 }
850
851 ctf_fs_ds_index_destroy(index);
852 return ret;
853 }
854
855 static
856 int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
857 {
858 int ret = 0;
859 const char *basename;
860 GError *error = NULL;
861 GDir *dir = NULL;
862 bt_logging_level log_level = ctf_fs_trace->log_level;
863 bt_self_component *self_comp = ctf_fs_trace->self_comp;
864
865 /* Check each file in the path directory, except specific ones */
866 dir = g_dir_open(ctf_fs_trace->path->str, 0, &error);
867 if (!dir) {
868 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open directory `%s`: %s (code %d)",
869 ctf_fs_trace->path->str, error->message,
870 error->code);
871 goto error;
872 }
873
874 while ((basename = g_dir_read_name(dir))) {
875 struct ctf_fs_file *file;
876
877 if (strcmp(basename, CTF_FS_METADATA_FILENAME) == 0) {
878 /* Ignore the metadata stream. */
879 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`",
880 ctf_fs_trace->path->str, basename);
881 continue;
882 }
883
884 if (basename[0] == '.') {
885 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`",
886 ctf_fs_trace->path->str, basename);
887 continue;
888 }
889
890 /* Create the file. */
891 file = ctf_fs_file_create(log_level, self_comp);
892 if (!file) {
893 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
894 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`",
895 ctf_fs_trace->path->str, basename);
896 goto error;
897 }
898
899 /* Create full path string. */
900 g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s",
901 ctf_fs_trace->path->str, basename);
902 if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) {
903 BT_COMP_LOGI("Ignoring non-regular file `%s`",
904 file->path->str);
905 ctf_fs_file_destroy(file);
906 file = NULL;
907 continue;
908 }
909
910 ret = ctf_fs_file_open(file, "rb");
911 if (ret) {
912 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open stream file `%s`",
913 file->path->str);
914 goto error;
915 }
916
917 if (file->size == 0) {
918 /* Skip empty stream. */
919 BT_COMP_LOGI("Ignoring empty file `%s`", file->path->str);
920 ctf_fs_file_destroy(file);
921 continue;
922 }
923
924 ret = add_ds_file_to_ds_file_group(ctf_fs_trace,
925 file->path->str);
926 if (ret) {
927 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
928 "Cannot add stream file `%s` to stream file group",
929 file->path->str);
930 ctf_fs_file_destroy(file);
931 goto error;
932 }
933
934 ctf_fs_file_destroy(file);
935 }
936
937 goto end;
938
939 error:
940 ret = -1;
941
942 end:
943 if (dir) {
944 g_dir_close(dir);
945 dir = NULL;
946 }
947
948 if (error) {
949 g_error_free(error);
950 }
951
952 return ret;
953 }
954
955 static
956 int set_trace_name(bt_trace *trace, const char *name_suffix,
957 bt_logging_level log_level, bt_self_component *self_comp)
958 {
959 int ret = 0;
960 const bt_value *val;
961 GString *name;
962
963 name = g_string_new(NULL);
964 if (!name) {
965 BT_COMP_LOGE_STR("Failed to allocate a GString.");
966 ret = -1;
967 goto end;
968 }
969
970 /*
971 * Check if we have a trace environment string value named `hostname`.
972 * If so, use it as the trace name's prefix.
973 */
974 val = bt_trace_borrow_environment_entry_value_by_name_const(
975 trace, "hostname");
976 if (val && bt_value_is_string(val)) {
977 g_string_append(name, bt_value_string_get(val));
978
979 if (name_suffix) {
980 g_string_append_c(name, G_DIR_SEPARATOR);
981 }
982 }
983
984 if (name_suffix) {
985 g_string_append(name, name_suffix);
986 }
987
988 ret = bt_trace_set_name(trace, name->str);
989 if (ret) {
990 goto end;
991 }
992
993 goto end;
994
995 end:
996 if (name) {
997 g_string_free(name, TRUE);
998 }
999
1000 return ret;
1001 }
1002
1003 static
1004 struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component *self_comp,
1005 const char *path, const char *name,
1006 struct ctf_fs_metadata_config *metadata_config,
1007 bt_logging_level log_level)
1008 {
1009 struct ctf_fs_trace *ctf_fs_trace;
1010 int ret;
1011
1012 ctf_fs_trace = g_new0(struct ctf_fs_trace, 1);
1013 if (!ctf_fs_trace) {
1014 goto end;
1015 }
1016
1017 ctf_fs_trace->log_level = log_level;
1018 ctf_fs_trace->self_comp = self_comp;
1019 ctf_fs_trace->path = g_string_new(path);
1020 if (!ctf_fs_trace->path) {
1021 goto error;
1022 }
1023
1024 ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1);
1025 if (!ctf_fs_trace->metadata) {
1026 goto error;
1027 }
1028
1029 ctf_fs_metadata_init(ctf_fs_trace->metadata);
1030 ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func(
1031 (GDestroyNotify) ctf_fs_ds_file_group_destroy);
1032 if (!ctf_fs_trace->ds_file_groups) {
1033 goto error;
1034 }
1035
1036 ret = ctf_fs_metadata_set_trace_class(self_comp, ctf_fs_trace,
1037 metadata_config);
1038 if (ret) {
1039 goto error;
1040 }
1041
1042 if (ctf_fs_trace->metadata->trace_class) {
1043 ctf_fs_trace->trace =
1044 bt_trace_create(ctf_fs_trace->metadata->trace_class);
1045 if (!ctf_fs_trace->trace) {
1046 goto error;
1047 }
1048 }
1049
1050 if (ctf_fs_trace->trace) {
1051 ret = ctf_trace_class_configure_ir_trace(
1052 ctf_fs_trace->metadata->tc, ctf_fs_trace->trace);
1053 if (ret) {
1054 goto error;
1055 }
1056
1057 ret = set_trace_name(ctf_fs_trace->trace, name, log_level,
1058 self_comp);
1059 if (ret) {
1060 goto error;
1061 }
1062 }
1063
1064 ret = create_ds_file_groups(ctf_fs_trace);
1065 if (ret) {
1066 goto error;
1067 }
1068
1069 goto end;
1070
1071 error:
1072 ctf_fs_trace_destroy(ctf_fs_trace);
1073 ctf_fs_trace = NULL;
1074
1075 end:
1076 return ctf_fs_trace;
1077 }
1078
1079 static
1080 int path_is_ctf_trace(const char *path)
1081 {
1082 GString *metadata_path = g_string_new(NULL);
1083 int ret = 0;
1084
1085 if (!metadata_path) {
1086 ret = -1;
1087 goto end;
1088 }
1089
1090 g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME);
1091
1092 if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) {
1093 ret = 1;
1094 goto end;
1095 }
1096
1097 end:
1098 g_string_free(metadata_path, TRUE);
1099 return ret;
1100 }
1101
1102 /* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path. */
1103
1104 static
1105 int ctf_fs_component_create_ctf_fs_traces_one_path(
1106 struct ctf_fs_component *ctf_fs,
1107 const char *path_param,
1108 bt_self_component *self_comp,
1109 bt_self_component_class *self_comp_class)
1110 {
1111 struct ctf_fs_trace *ctf_fs_trace;
1112 int ret;
1113 GString *norm_path;
1114 bt_logging_level log_level = ctf_fs->log_level;
1115
1116 norm_path = bt_common_normalize_path(path_param, NULL);
1117 if (!norm_path) {
1118 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1119 "Failed to normalize path: `%s`.", path_param);
1120 goto error;
1121 }
1122
1123 ret = path_is_ctf_trace(norm_path->str);
1124 if (ret < 0) {
1125 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1126 "Failed to check if path is a CTF trace: path=%s", norm_path->str);
1127 goto error;
1128 } else if (ret == 0) {
1129 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1130 "Path is not a CTF trace (does not contain a metadata file): `%s`.", norm_path->str);
1131 goto error;
1132 }
1133
1134 // FIXME: Remove or ifdef for __MINGW32__
1135 if (strcmp(norm_path->str, "/") == 0) {
1136 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1137 "Opening a trace in `/` is not supported.");
1138 ret = -1;
1139 goto end;
1140 }
1141
1142 ctf_fs_trace = ctf_fs_trace_create(self_comp, norm_path->str,
1143 norm_path->str, &ctf_fs->metadata_config, log_level);
1144 if (!ctf_fs_trace) {
1145 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create trace for `%s`.",
1146 norm_path->str);
1147 goto error;
1148 }
1149
1150 g_ptr_array_add(ctf_fs->traces, ctf_fs_trace);
1151 ctf_fs_trace = NULL;
1152
1153 ret = 0;
1154 goto end;
1155
1156 error:
1157 ret = -1;
1158
1159 end:
1160 if (norm_path) {
1161 g_string_free(norm_path, TRUE);
1162 }
1163
1164 return ret;
1165 }
1166
1167 /* GCompareFunc to sort traces by UUID. */
1168
1169 static
1170 gint sort_traces_by_uuid(gconstpointer a, gconstpointer b)
1171 {
1172 const struct ctf_fs_trace *trace_a = *((const struct ctf_fs_trace **) a);
1173 const struct ctf_fs_trace *trace_b = *((const struct ctf_fs_trace **) b);
1174
1175 bool trace_a_has_uuid = trace_a->metadata->tc->is_uuid_set;
1176 bool trace_b_has_uuid = trace_b->metadata->tc->is_uuid_set;
1177 gint ret;
1178
1179 /* Order traces without uuid first. */
1180 if (!trace_a_has_uuid && trace_b_has_uuid) {
1181 ret = -1;
1182 } else if (trace_a_has_uuid && !trace_b_has_uuid) {
1183 ret = 1;
1184 } else if (!trace_a_has_uuid && !trace_b_has_uuid) {
1185 ret = 0;
1186 } else {
1187 ret = bt_uuid_compare(trace_a->metadata->tc->uuid, trace_b->metadata->tc->uuid);
1188 }
1189
1190 return ret;
1191 }
1192
1193 /*
1194 * Count the number of stream and event classes defined by this trace's metadata.
1195 *
1196 * This is used to determine which metadata is the "latest", out of multiple
1197 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1198 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1199 * enough to just count the classes.
1200 */
1201
1202 static
1203 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace)
1204 {
1205 unsigned int num = trace->metadata->tc->stream_classes->len;
1206 guint i;
1207
1208 for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) {
1209 struct ctf_stream_class *sc = trace->metadata->tc->stream_classes->pdata[i];
1210 num += sc->event_classes->len;
1211 }
1212
1213 return num;
1214 }
1215
1216 /*
1217 * Merge the src ds_file_group into dest. This consists of merging their
1218 * ds_file_infos, making sure to keep the result sorted.
1219 */
1220
1221 static
1222 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, struct ctf_fs_ds_file_group *src)
1223 {
1224 guint i;
1225
1226 for (i = 0; i < src->ds_file_infos->len; i++) {
1227 struct ctf_fs_ds_file_info *ds_file_info =
1228 g_ptr_array_index(src->ds_file_infos, i);
1229
1230 /* Ownership of the ds_file_info is transferred to dest. */
1231 g_ptr_array_index(src->ds_file_infos, i) = NULL;
1232
1233 ds_file_group_insert_ds_file_info_sorted(dest, ds_file_info);
1234 }
1235
1236 /* Merge both indexes. */
1237 for (i = 0; i < src->index->entries->len; i++) {
1238 struct ctf_fs_ds_index_entry *entry = g_ptr_array_index(
1239 src->index->entries, i);
1240
1241 /*
1242 * Ownership of the ctf_fs_ds_index_entry is transferred to
1243 * dest.
1244 */
1245 g_ptr_array_index(src->index->entries, i) = NULL;
1246
1247 ds_file_group_insert_ds_index_entry_sorted(dest, entry);
1248 }
1249 }
1250 /* Merge src_trace's data stream file groups into dest_trace's. */
1251
1252 static
1253 int merge_matching_ctf_fs_ds_file_groups(
1254 struct ctf_fs_trace *dest_trace,
1255 struct ctf_fs_trace *src_trace)
1256 {
1257
1258 GPtrArray *dest = dest_trace->ds_file_groups;
1259 GPtrArray *src = src_trace->ds_file_groups;
1260 guint s_i;
1261 int ret = 0;
1262
1263 /*
1264 * Save the initial length of dest: we only want to check against the
1265 * original elements in the inner loop.
1266 */
1267 const guint dest_len = dest->len;
1268
1269 for (s_i = 0; s_i < src->len; s_i++) {
1270 struct ctf_fs_ds_file_group *src_group = g_ptr_array_index(src, s_i);
1271 struct ctf_fs_ds_file_group *dest_group = NULL;
1272
1273 /* A stream instance without ID can't match a stream in the other trace. */
1274 if (src_group->stream_id != -1) {
1275 guint d_i;
1276
1277 /* Let's search for a matching ds_file_group in the destination. */
1278 for (d_i = 0; d_i < dest_len; d_i++) {
1279 struct ctf_fs_ds_file_group *candidate_dest = g_ptr_array_index(dest, d_i);
1280
1281 /* Can't match a stream instance without ID. */
1282 if (candidate_dest->stream_id == -1) {
1283 continue;
1284 }
1285
1286 /*
1287 * If the two groups have the same stream instance id
1288 * and belong to the same stream class (stream instance
1289 * ids are per-stream class), they represent the same
1290 * stream instance.
1291 */
1292 if (candidate_dest->stream_id != src_group->stream_id ||
1293 candidate_dest->sc->id != src_group->sc->id) {
1294 continue;
1295 }
1296
1297 dest_group = candidate_dest;
1298 break;
1299 }
1300 }
1301
1302 /*
1303 * Didn't find a friend in dest to merge our src_group into?
1304 * Create a new empty one. This can happen if a stream was
1305 * active in the source trace chunk but not in the destination
1306 * trace chunk.
1307 */
1308 if (!dest_group) {
1309 struct ctf_stream_class *sc;
1310 struct ctf_fs_ds_index *index;
1311
1312 sc = ctf_trace_class_borrow_stream_class_by_id(
1313 dest_trace->metadata->tc, src_group->sc->id);
1314 BT_ASSERT(sc);
1315
1316 index = ctf_fs_ds_index_create(dest_trace->log_level,
1317 dest_trace->self_comp);
1318 if (!index) {
1319 ret = -1;
1320 goto end;
1321 }
1322
1323 dest_group = ctf_fs_ds_file_group_create(dest_trace, sc,
1324 src_group->stream_id, index);
1325 /* Ownership of index is transferred. */
1326 index = NULL;
1327 if (!dest_group) {
1328 ret = -1;
1329 goto end;
1330 }
1331
1332 g_ptr_array_add(dest_trace->ds_file_groups, dest_group);
1333 }
1334
1335 BT_ASSERT(dest_group);
1336 merge_ctf_fs_ds_file_groups(dest_group, src_group);
1337 }
1338
1339 end:
1340 return ret;
1341 }
1342
1343 /*
1344 * Collapse the given traces, which must all share the same UUID, in a single
1345 * one.
1346 *
1347 * The trace with the most expansive metadata is chosen and all other traces
1348 * are merged into that one. The array slots of all the traces that get merged
1349 * in the chosen one are set to NULL, so only the slot of the chosen trace
1350 * remains non-NULL.
1351 */
1352
1353 static
1354 int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces)
1355 {
1356 unsigned int winner_count;
1357 struct ctf_fs_trace *winner;
1358 guint i;
1359 int ret = 0;
1360
1361 BT_ASSERT(num_traces >= 2);
1362
1363 winner_count = metadata_count_stream_and_event_classes(traces[0]);
1364 winner = traces[0];
1365
1366 /* Find the trace with the largest metadata. */
1367 for (i = 1; i < num_traces; i++) {
1368 struct ctf_fs_trace *candidate;
1369 unsigned int candidate_count;
1370
1371 candidate = traces[i];
1372
1373 /* A bit of sanity check. */
1374 BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0);
1375
1376 candidate_count = metadata_count_stream_and_event_classes(candidate);
1377
1378 if (candidate_count > winner_count) {
1379 winner_count = candidate_count;
1380 winner = candidate;
1381 }
1382 }
1383
1384 /* Merge all the other traces in the winning trace. */
1385 for (i = 0; i < num_traces; i++) {
1386 struct ctf_fs_trace *trace = traces[i];
1387
1388 /* Don't merge the winner into itself. */
1389 if (trace == winner) {
1390 continue;
1391 }
1392
1393 /* Merge trace's data stream file groups into winner's. */
1394 ret = merge_matching_ctf_fs_ds_file_groups(winner, trace);
1395 if (ret) {
1396 goto end;
1397 }
1398
1399 /* Free the trace that got merged into winner, clear the slot in the array. */
1400 ctf_fs_trace_destroy(trace);
1401 traces[i] = NULL;
1402 }
1403
1404 end:
1405 return ret;
1406 }
1407
1408 /*
1409 * Merge all traces of `ctf_fs` that share the same UUID in a single trace.
1410 * Traces with no UUID are not merged.
1411 */
1412
1413 static
1414 int merge_traces_with_same_uuid(struct ctf_fs_component *ctf_fs)
1415 {
1416 GPtrArray *traces = ctf_fs->traces;
1417 guint range_start_idx = 0;
1418 unsigned int num_traces = 0;
1419 guint i;
1420 int ret = 0;
1421
1422 /* Sort the traces by uuid, then collapse traces with the same uuid in a single one. */
1423 g_ptr_array_sort(traces, sort_traces_by_uuid);
1424
1425 /* Find ranges of consecutive traces that share the same UUID. */
1426 while (range_start_idx < traces->len) {
1427 guint range_len;
1428 struct ctf_fs_trace *range_start_trace = g_ptr_array_index(traces, range_start_idx);
1429
1430 /* Exclusive end of range. */
1431 guint range_end_exc_idx = range_start_idx + 1;
1432
1433 while (range_end_exc_idx < traces->len) {
1434 struct ctf_fs_trace *this_trace = g_ptr_array_index(traces, range_end_exc_idx);
1435
1436 if (!range_start_trace->metadata->tc->is_uuid_set ||
1437 (bt_uuid_compare(range_start_trace->metadata->tc->uuid, this_trace->metadata->tc->uuid) != 0)) {
1438 break;
1439 }
1440
1441 range_end_exc_idx++;
1442 }
1443
1444 /* If we have two or more traces with matching UUIDs, merge them. */
1445 range_len = range_end_exc_idx - range_start_idx;
1446 if (range_len > 1) {
1447 struct ctf_fs_trace **range_start = (struct ctf_fs_trace **) &traces->pdata[range_start_idx];
1448 ret = merge_ctf_fs_traces(range_start, range_len);
1449 if (ret) {
1450 goto end;
1451 }
1452 }
1453
1454 num_traces++;
1455 range_start_idx = range_end_exc_idx;
1456 }
1457
1458 /* Clear any NULL slot (traces that got merged in another one) in the array. */
1459 for (i = 0; i < traces->len;) {
1460 if (!g_ptr_array_index(traces, i)) {
1461 g_ptr_array_remove_index_fast(traces, i);
1462 } else {
1463 i++;
1464 }
1465 }
1466
1467 BT_ASSERT(num_traces == traces->len);
1468
1469 end:
1470 return ret;
1471 }
1472
1473 enum target_event {
1474 FIRST_EVENT,
1475 LAST_EVENT,
1476 };
1477
1478 static
1479 int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace,
1480 struct ctf_clock_class *default_cc,
1481 struct ctf_fs_ds_index_entry *index_entry,
1482 enum target_event target_event, uint64_t *cs, int64_t *ts_ns)
1483 {
1484 enum bt_msg_iter_status iter_status = BT_MSG_ITER_STATUS_OK;
1485 struct ctf_fs_ds_file *ds_file = NULL;
1486 struct bt_msg_iter *msg_iter = NULL;
1487 bt_logging_level log_level = ctf_fs_trace->log_level;
1488 bt_self_component *self_comp = ctf_fs_trace->self_comp;
1489 int ret = 0;
1490
1491 BT_ASSERT(ctf_fs_trace);
1492 BT_ASSERT(ctf_fs_trace->metadata);
1493 BT_ASSERT(ctf_fs_trace->metadata->tc);
1494
1495 msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc,
1496 bt_common_get_page_size(log_level) * 8, ctf_fs_ds_file_medops,
1497 NULL, log_level, self_comp);
1498 if (!msg_iter) {
1499 /* bt_msg_iter_create() logs errors. */
1500 ret = -1;
1501 goto end;
1502 }
1503
1504 BT_ASSERT(index_entry);
1505 BT_ASSERT(index_entry->path);
1506
1507 ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
1508 NULL, index_entry->path, log_level);
1509 if (!ds_file) {
1510 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create a ctf_fs_ds_file");
1511 ret = -1;
1512 goto end;
1513 }
1514
1515 /*
1516 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1517 * library objects (bt_field, bt_message_*, etc.).
1518 */
1519 bt_msg_iter_set_dry_run(msg_iter, true);
1520
1521 /* Seek to the beginning of the target packet. */
1522 iter_status = bt_msg_iter_seek(ds_file->msg_iter, index_entry->offset);
1523 if (iter_status) {
1524 /* bt_msg_iter_seek() logs errors. */
1525 ret = -1;
1526 goto end;
1527 }
1528
1529 switch (target_event) {
1530 case FIRST_EVENT:
1531 /*
1532 * Start to decode the packet until we reach the end of
1533 * the first event. To extract the first event's clock
1534 * snapshot.
1535 */
1536 iter_status = bt_msg_iter_curr_packet_first_event_clock_snapshot(
1537 ds_file->msg_iter, cs);
1538 break;
1539 case LAST_EVENT:
1540 /* Decode the packet to extract the last event's clock snapshot. */
1541 iter_status = bt_msg_iter_curr_packet_last_event_clock_snapshot(
1542 ds_file->msg_iter, cs);
1543 break;
1544 default:
1545 abort();
1546 }
1547 if (iter_status) {
1548 ret = -1;
1549 goto end;
1550 }
1551
1552 /* Convert clock snapshot to timestamp. */
1553 ret = bt_util_clock_cycles_to_ns_from_origin(*cs,
1554 default_cc->frequency, default_cc->offset_seconds,
1555 default_cc->offset_cycles, ts_ns);
1556 if (ret) {
1557 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1558 "Failed to convert clock snapshot to timestamp");
1559 goto end;
1560 }
1561
1562 end:
1563 if (ds_file) {
1564 ctf_fs_ds_file_destroy(ds_file);
1565 }
1566 if (msg_iter) {
1567 bt_msg_iter_destroy(msg_iter);
1568 }
1569
1570 return ret;
1571 }
1572
1573 static
1574 int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace,
1575 struct ctf_clock_class *default_cc,
1576 struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns)
1577 {
1578 return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc,
1579 index_entry, FIRST_EVENT, cs, ts_ns);
1580 }
1581
1582 static
1583 int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace,
1584 struct ctf_clock_class *default_cc,
1585 struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns)
1586 {
1587 return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc,
1588 index_entry, LAST_EVENT, cs, ts_ns);
1589 }
1590
1591 /*
1592 * Fix up packet index entries for lttng's "event-after-packet" bug.
1593 * Some buggy lttng tracer versions may emit events with a timestamp that is
1594 * larger (after) than the timestamp_end of the their packets.
1595 *
1596 * To fix up this erroneous data we do the following:
1597 * 1. If it's not the stream file's last packet: set the packet index entry's
1598 * end time to the next packet's beginning time.
1599 * 2. If it's the stream file's last packet, set the packet index entry's end
1600 * time to the packet's last event's time, if any, or to the packet's
1601 * beginning time otherwise.
1602 *
1603 * Known buggy tracer versions:
1604 * - before lttng-ust 2.11.0
1605 * - before lttng-module 2.11.0
1606 * - before lttng-module 2.10.10
1607 * - before lttng-module 2.9.13
1608 */
1609 static
1610 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace)
1611 {
1612 int ret = 0;
1613 guint ds_file_group_i;
1614 GPtrArray *ds_file_groups = trace->ds_file_groups;
1615 bt_logging_level log_level = trace->log_level;
1616
1617 for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len;
1618 ds_file_group_i++) {
1619 guint entry_i;
1620 struct ctf_clock_class *default_cc;
1621 struct ctf_fs_ds_index_entry *last_entry;
1622 struct ctf_fs_ds_index *index;
1623
1624 struct ctf_fs_ds_file_group *ds_file_group =
1625 g_ptr_array_index(ds_file_groups, ds_file_group_i);
1626
1627 BT_ASSERT(ds_file_group);
1628 index = ds_file_group->index;
1629
1630 BT_ASSERT(index);
1631 BT_ASSERT(index->entries);
1632 BT_ASSERT(index->entries->len > 0);
1633
1634 /*
1635 * Iterate over all entries but the last one. The last one is
1636 * fixed differently after.
1637 */
1638 for (entry_i = 0; entry_i < index->entries->len - 1;
1639 entry_i++) {
1640 struct ctf_fs_ds_index_entry *curr_entry, *next_entry;
1641
1642 curr_entry = g_ptr_array_index(index->entries, entry_i);
1643 next_entry = g_ptr_array_index(index->entries, entry_i + 1);
1644
1645 /*
1646 * 1. Set the current index entry `end` timestamp to
1647 * the next index entry `begin` timestamp.
1648 */
1649 curr_entry->timestamp_end = next_entry->timestamp_begin;
1650 curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns;
1651 }
1652
1653 /*
1654 * 2. Fix the last entry by decoding the last event of the last
1655 * packet.
1656 */
1657 last_entry = g_ptr_array_index(index->entries,
1658 index->entries->len - 1);
1659 BT_ASSERT(last_entry);
1660
1661 BT_ASSERT(ds_file_group->sc->default_clock_class);
1662 default_cc = ds_file_group->sc->default_clock_class;
1663
1664 /*
1665 * Decode packet to read the timestamp of the last event of the
1666 * entry.
1667 */
1668 ret = decode_packet_last_event_timestamp(trace, default_cc,
1669 last_entry, &last_entry->timestamp_end,
1670 &last_entry->timestamp_end_ns);
1671 if (ret) {
1672 BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
1673 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1674 goto end;
1675 }
1676 }
1677
1678 end:
1679 return ret;
1680 }
1681
1682 /*
1683 * Fix up packet index entries for barectf's "event-before-packet" bug.
1684 * Some buggy barectf tracer versions may emit events with a timestamp that is
1685 * less than the timestamp_begin of the their packets.
1686 *
1687 * To fix up this erroneous data we do the following:
1688 * 1. Starting at the second index entry, set the timestamp_begin of the
1689 * current entry to the timestamp of the first event of the packet.
1690 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1691 * current packet.
1692 *
1693 * Known buggy tracer versions:
1694 * - before barectf 2.3.1
1695 */
1696 static
1697 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace)
1698 {
1699 int ret = 0;
1700 guint ds_file_group_i;
1701 GPtrArray *ds_file_groups = trace->ds_file_groups;
1702 bt_logging_level log_level = trace->log_level;
1703
1704 for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len;
1705 ds_file_group_i++) {
1706 guint entry_i;
1707 struct ctf_clock_class *default_cc;
1708 struct ctf_fs_ds_file_group *ds_file_group =
1709 g_ptr_array_index(ds_file_groups, ds_file_group_i);
1710
1711 struct ctf_fs_ds_index *index = ds_file_group->index;
1712
1713 BT_ASSERT(index);
1714 BT_ASSERT(index->entries);
1715 BT_ASSERT(index->entries->len > 0);
1716
1717 BT_ASSERT(ds_file_group->sc->default_clock_class);
1718 default_cc = ds_file_group->sc->default_clock_class;
1719
1720 /*
1721 * 1. Iterate over the index, starting from the second entry
1722 * (index = 1).
1723 */
1724 for (entry_i = 1; entry_i < index->entries->len;
1725 entry_i++) {
1726 struct ctf_fs_ds_index_entry *curr_entry, *prev_entry;
1727 prev_entry = g_ptr_array_index(index->entries, entry_i - 1);
1728 curr_entry = g_ptr_array_index(index->entries, entry_i);
1729 /*
1730 * 2. Set the current entry `begin` timestamp to the
1731 * timestamp of the first event of the current packet.
1732 */
1733 ret = decode_packet_first_event_timestamp(trace, default_cc,
1734 curr_entry, &curr_entry->timestamp_begin,
1735 &curr_entry->timestamp_begin_ns);
1736 if (ret) {
1737 BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
1738 "Failed to decode first event's clock snapshot");
1739 goto end;
1740 }
1741
1742 /*
1743 * 3. Set the previous entry `end` timestamp to the
1744 * timestamp of the first event of the current packet.
1745 */
1746 prev_entry->timestamp_end = curr_entry->timestamp_begin;
1747 prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns;
1748 }
1749 }
1750 end:
1751 return ret;
1752 }
1753
1754 /*
1755 * When using the lttng-crash feature it's likely that the last packets of each
1756 * stream have their timestamp_end set to zero. This is caused by the fact that
1757 * the tracer crashed and was not able to properly close the packets.
1758 *
1759 * To fix up this erroneous data we do the following:
1760 * For each index entry, if the entry's timestamp_end is 0 and the
1761 * timestamp_begin is not 0:
1762 * - If it's the stream file's last packet: set the packet index entry's end
1763 * time to the packet's last event's time, if any, or to the packet's
1764 * beginning time otherwise.
1765 * - If it's not the stream file's last packet: set the packet index
1766 * entry's end time to the next packet's beginning time.
1767 *
1768 * Affected versions:
1769 * - All current and future lttng-ust and lttng-modules versions.
1770 */
1771 static
1772 int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace)
1773 {
1774 int ret = 0;
1775 guint ds_file_group_idx;
1776 GPtrArray *ds_file_groups = trace->ds_file_groups;
1777 bt_logging_level log_level = trace->log_level;
1778
1779 for (ds_file_group_idx = 0; ds_file_group_idx < ds_file_groups->len;
1780 ds_file_group_idx++) {
1781 guint entry_idx;
1782 struct ctf_clock_class *default_cc;
1783 struct ctf_fs_ds_index_entry *last_entry;
1784 struct ctf_fs_ds_index *index;
1785
1786 struct ctf_fs_ds_file_group *ds_file_group =
1787 g_ptr_array_index(ds_file_groups, ds_file_group_idx);
1788
1789 BT_ASSERT(ds_file_group);
1790 index = ds_file_group->index;
1791
1792 BT_ASSERT(ds_file_group->sc->default_clock_class);
1793 default_cc = ds_file_group->sc->default_clock_class;
1794
1795 BT_ASSERT(index);
1796 BT_ASSERT(index->entries);
1797 BT_ASSERT(index->entries->len > 0);
1798
1799 last_entry = g_ptr_array_index(index->entries,
1800 index->entries->len - 1);
1801 BT_ASSERT(last_entry);
1802
1803
1804 /* 1. Fix the last entry first. */
1805 if (last_entry->timestamp_end == 0 &&
1806 last_entry->timestamp_begin != 0) {
1807 /*
1808 * Decode packet to read the timestamp of the
1809 * last event of the stream file.
1810 */
1811 ret = decode_packet_last_event_timestamp(trace,
1812 default_cc, last_entry,
1813 &last_entry->timestamp_end,
1814 &last_entry->timestamp_end_ns);
1815 if (ret) {
1816 BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
1817 "Failed to decode last event's clock snapshot");
1818 goto end;
1819 }
1820 }
1821
1822 /* Iterate over all entries but the last one. */
1823 for (entry_idx = 0; entry_idx < index->entries->len - 1;
1824 entry_idx++) {
1825 struct ctf_fs_ds_index_entry *curr_entry, *next_entry;
1826 curr_entry = g_ptr_array_index(index->entries, entry_idx);
1827 next_entry = g_ptr_array_index(index->entries, entry_idx + 1);
1828
1829 if (curr_entry->timestamp_end == 0 &&
1830 curr_entry->timestamp_begin != 0) {
1831 /*
1832 * 2. Set the current index entry `end` timestamp to
1833 * the next index entry `begin` timestamp.
1834 */
1835 curr_entry->timestamp_end = next_entry->timestamp_begin;
1836 curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns;
1837 }
1838 }
1839 }
1840
1841 end:
1842 return ret;
1843 }
1844
1845 /*
1846 * Extract the tracer information necessary to compare versions.
1847 * Returns 0 on success, and -1 if the extraction is not successful because the
1848 * necessary fields are absents in the trace metadata.
1849 */
1850 static
1851 int extract_tracer_info(struct ctf_fs_trace *trace,
1852 struct tracer_info *current_tracer_info)
1853 {
1854 int ret = 0;
1855 struct ctf_trace_class_env_entry *entry;
1856
1857 /* Clear the current_tracer_info struct */
1858 memset(current_tracer_info, 0, sizeof(*current_tracer_info));
1859
1860 /*
1861 * To compare 2 tracer versions, at least the tracer name and it's
1862 * major version are needed. If one of these is missing, consider it an
1863 * extraction failure.
1864 */
1865 entry = ctf_trace_class_borrow_env_entry_by_name(
1866 trace->metadata->tc, "tracer_name");
1867 if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR) {
1868 goto missing_bare_minimum;
1869 }
1870
1871 /* Set tracer name. */
1872 current_tracer_info->name = entry->value.str->str;
1873
1874 entry = ctf_trace_class_borrow_env_entry_by_name(
1875 trace->metadata->tc, "tracer_major");
1876 if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) {
1877 goto missing_bare_minimum;
1878 }
1879
1880 /* Set major version number. */
1881 current_tracer_info->major = entry->value.i;
1882
1883 entry = ctf_trace_class_borrow_env_entry_by_name(
1884 trace->metadata->tc, "tracer_minor");
1885 if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) {
1886 goto end;
1887 }
1888
1889 /* Set minor version number. */
1890 current_tracer_info->minor = entry->value.i;
1891
1892 entry = ctf_trace_class_borrow_env_entry_by_name(
1893 trace->metadata->tc, "tracer_patch");
1894 if (!entry) {
1895 /*
1896 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1897 * For example, `lttng-modules` uses entry name
1898 * `tracer_patchlevel`.
1899 */
1900 entry = ctf_trace_class_borrow_env_entry_by_name(
1901 trace->metadata->tc, "tracer_patchlevel");
1902 }
1903
1904 if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) {
1905 goto end;
1906 }
1907
1908 /* Set patch version number. */
1909 current_tracer_info->patch = entry->value.i;
1910
1911 goto end;
1912
1913 missing_bare_minimum:
1914 ret = -1;
1915 end:
1916 return ret;
1917 }
1918
1919 static
1920 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1921 struct tracer_info *curr_tracer_info)
1922 {
1923 bool is_affected = false;
1924
1925 if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) {
1926 if (curr_tracer_info->major < 2) {
1927 is_affected = true;
1928 } else if (curr_tracer_info->major == 2) {
1929 /* fixed in lttng-ust 2.11.0 */
1930 if (curr_tracer_info->minor < 11) {
1931 is_affected = true;
1932 }
1933 }
1934 } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) {
1935 if (curr_tracer_info->major < 2) {
1936 is_affected = true;
1937 } else if (curr_tracer_info->major == 2) {
1938 /* fixed in lttng-modules 2.11.0 */
1939 if (curr_tracer_info->minor == 10) {
1940 /* fixed in lttng-modules 2.10.10 */
1941 if (curr_tracer_info->patch < 10) {
1942 is_affected = true;
1943 }
1944 } else if (curr_tracer_info->minor == 9) {
1945 /* fixed in lttng-modules 2.9.13 */
1946 if (curr_tracer_info->patch < 13) {
1947 is_affected = true;
1948 }
1949 } else if (curr_tracer_info->minor < 9) {
1950 is_affected = true;
1951 }
1952 }
1953 }
1954
1955 return is_affected;
1956 }
1957
1958 static
1959 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1960 struct tracer_info *curr_tracer_info)
1961 {
1962 bool is_affected = false;
1963
1964 if (strcmp(curr_tracer_info->name, "barectf") == 0) {
1965 if (curr_tracer_info->major < 2) {
1966 is_affected = true;
1967 } else if (curr_tracer_info->major == 2) {
1968 if (curr_tracer_info->minor < 3) {
1969 is_affected = true;
1970 } else if (curr_tracer_info->minor == 3) {
1971 /* fixed in barectf 2.3.1 */
1972 if (curr_tracer_info->patch < 1) {
1973 is_affected = true;
1974 }
1975 }
1976 }
1977 }
1978
1979 return is_affected;
1980 }
1981
1982 static
1983 bool is_tracer_affected_by_lttng_crash_quirk(
1984 struct tracer_info *curr_tracer_info)
1985 {
1986 bool is_affected = false;
1987
1988 /* All LTTng tracer may be affected by this lttng crash quirk. */
1989 if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) {
1990 is_affected = true;
1991 } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) {
1992 is_affected = true;
1993 }
1994
1995 return is_affected;
1996 }
1997
1998 /*
1999 * Looks for trace produced by known buggy tracers and fix up the index
2000 * produced earlier.
2001 */
2002 static
2003 int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs,
2004 bt_self_component *self_comp)
2005 {
2006 int ret = 0;
2007 guint trace_i;
2008 struct tracer_info current_tracer_info;
2009 GPtrArray *traces = ctf_fs->traces;
2010 bt_logging_level log_level = ctf_fs->log_level;
2011
2012 /*
2013 * Iterate over all the traces of this component and check for
2014 * possible indexing bugs.
2015 */
2016 for (trace_i = 0; trace_i < traces->len; trace_i++) {
2017 struct ctf_fs_trace *trace = g_ptr_array_index(traces,
2018 trace_i);
2019
2020 ret = extract_tracer_info(trace, &current_tracer_info);
2021 if (ret) {
2022 /*
2023 * A trace may not have all the necessary environment
2024 * entries to do the tracer version comparison.
2025 * At least, the tracer name and major version number
2026 * are needed. Failing to extract these entries is not
2027 * an error.
2028 */
2029 ret = 0;
2030 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
2031 continue;
2032 }
2033
2034 /* Check if the trace may be affected by old tracer bugs. */
2035 if (is_tracer_affected_by_lttng_event_after_packet_bug(
2036 &current_tracer_info)) {
2037 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
2038 ret = fix_index_lttng_event_after_packet_bug(trace);
2039 if (ret) {
2040 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2041 "Failed to fix LTTng event-after-packet bug.");
2042 goto end;
2043 }
2044 trace->metadata->tc->quirks.lttng_event_after_packet = true;
2045 }
2046
2047 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2048 &current_tracer_info)) {
2049 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2050 ret = fix_index_barectf_event_before_packet_bug(trace);
2051 if (ret) {
2052 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2053 "Failed to fix barectf event-before-packet bug.");
2054 goto end;
2055 }
2056 trace->metadata->tc->quirks.barectf_event_before_packet = true;
2057 }
2058
2059 if (is_tracer_affected_by_lttng_crash_quirk(
2060 &current_tracer_info)) {
2061 ret = fix_index_lttng_crash_quirk(trace);
2062 if (ret) {
2063 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2064 "Failed to fix lttng-crash timestamp quirks.");
2065 goto end;
2066 }
2067 trace->metadata->tc->quirks.lttng_crash = true;
2068 }
2069 }
2070 end:
2071 return ret;
2072 }
2073
2074 int ctf_fs_component_create_ctf_fs_traces(
2075 struct ctf_fs_component *ctf_fs,
2076 const bt_value *paths_value,
2077 bt_self_component *self_comp,
2078 bt_self_component_class *self_comp_class)
2079 {
2080 int ret = 0;
2081 uint64_t i;
2082 bt_logging_level log_level = ctf_fs->log_level;
2083
2084 for (i = 0; i < bt_value_array_get_length(paths_value); i++) {
2085 const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i);
2086 const char *input = bt_value_string_get(path_value);
2087
2088 ret = ctf_fs_component_create_ctf_fs_traces_one_path(ctf_fs,
2089 input, self_comp, self_comp_class);
2090 if (ret) {
2091 goto end;
2092 }
2093 }
2094
2095 ret = merge_traces_with_same_uuid(ctf_fs);
2096 if (ret) {
2097 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
2098 "Failed to merge traces with the same UUID.");
2099 }
2100
2101 ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp);
2102 if (ret) {
2103 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
2104 "Failed to fix packet index tracer bugs.");
2105 }
2106 end:
2107 return ret;
2108 }
2109
2110 static
2111 GString *get_stream_instance_unique_name(
2112 struct ctf_fs_ds_file_group *ds_file_group)
2113 {
2114 GString *name;
2115 struct ctf_fs_ds_file_info *ds_file_info;
2116
2117 name = g_string_new(NULL);
2118 if (!name) {
2119 goto end;
2120 }
2121
2122 /*
2123 * If there's more than one stream file in the stream file
2124 * group, the first (earliest) stream file's path is used as
2125 * the stream's unique name.
2126 */
2127 BT_ASSERT(ds_file_group->ds_file_infos->len > 0);
2128 ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0);
2129 g_string_assign(name, ds_file_info->path->str);
2130
2131 end:
2132 return name;
2133 }
2134
2135 /* Create the IR stream objects for ctf_fs_trace. */
2136
2137 static
2138 int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace)
2139 {
2140 int ret;
2141 GString *name = NULL;
2142 guint i;
2143 bt_logging_level log_level = ctf_fs_trace->log_level;
2144 bt_self_component *self_comp = ctf_fs_trace->self_comp;
2145
2146 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
2147 struct ctf_fs_ds_file_group *ds_file_group =
2148 g_ptr_array_index(ctf_fs_trace->ds_file_groups, i);
2149 name = get_stream_instance_unique_name(ds_file_group);
2150
2151 if (!name) {
2152 goto error;
2153 }
2154
2155 if (ds_file_group->sc->ir_sc) {
2156 BT_ASSERT(ctf_fs_trace->trace);
2157
2158 if (ds_file_group->stream_id == UINT64_C(-1)) {
2159 /* No stream ID: use 0 */
2160 ds_file_group->stream = bt_stream_create_with_id(
2161 ds_file_group->sc->ir_sc,
2162 ctf_fs_trace->trace,
2163 ctf_fs_trace->next_stream_id);
2164 ctf_fs_trace->next_stream_id++;
2165 } else {
2166 /* Specific stream ID */
2167 ds_file_group->stream = bt_stream_create_with_id(
2168 ds_file_group->sc->ir_sc,
2169 ctf_fs_trace->trace,
2170 (uint64_t) ds_file_group->stream_id);
2171 }
2172 } else {
2173 ds_file_group->stream = NULL;
2174 }
2175
2176 if (!ds_file_group->stream) {
2177 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2178 "Cannot create stream for DS file group: "
2179 "addr=%p, stream-name=\"%s\"",
2180 ds_file_group, name->str);
2181 goto error;
2182 }
2183
2184 ret = bt_stream_set_name(ds_file_group->stream,
2185 name->str);
2186 if (ret) {
2187 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot set stream's name: "
2188 "addr=%p, stream-name=\"%s\"",
2189 ds_file_group->stream, name->str);
2190 goto error;
2191 }
2192
2193 g_string_free(name, TRUE);
2194 name = NULL;
2195 }
2196
2197 ret = 0;
2198 goto end;
2199
2200 error:
2201 ret = -1;
2202
2203 end:
2204
2205 if (name) {
2206 g_string_free(name, TRUE);
2207 }
2208 return ret;
2209 }
2210
2211 /*
2212 * Validate the "paths" parameter passed to this component. It must be
2213 * present, and it must be an array of strings.
2214 */
2215
2216 static
2217 bool validate_inputs_parameter(struct ctf_fs_component *ctf_fs,
2218 const bt_value *inputs, bt_self_component *self_comp,
2219 bt_self_component_class *self_comp_class)
2220 {
2221 bool ret;
2222 bt_value_type type;
2223 uint64_t i;
2224 bt_logging_level log_level = ctf_fs->log_level;
2225
2226 if (!inputs) {
2227 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp,
2228 self_comp_class, "missing \"inputs\" parameter");
2229 goto error;
2230 }
2231
2232 type = bt_value_get_type(inputs);
2233 if (type != BT_VALUE_TYPE_ARRAY) {
2234 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp,
2235 self_comp_class, "`inputs` parameter: expecting array value: type=%s",
2236 bt_common_value_type_string(type));
2237 goto error;
2238 }
2239
2240 for (i = 0; i < bt_value_array_get_length(inputs); i++) {
2241 const bt_value *elem;
2242
2243 elem = bt_value_array_borrow_element_by_index_const(inputs, i);
2244 type = bt_value_get_type(elem);
2245 if (type != BT_VALUE_TYPE_STRING) {
2246 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
2247 "`inputs` parameter: expecting string value: index=%" PRIu64 ", type=%s",
2248 i, bt_common_value_type_string(type));
2249 goto error;
2250 }
2251 }
2252
2253 ret = true;
2254 goto end;
2255
2256 error:
2257 ret = false;
2258
2259 end:
2260 return ret;
2261 }
2262
2263 bool read_src_fs_parameters(const bt_value *params,
2264 const bt_value **inputs, struct ctf_fs_component *ctf_fs,
2265 bt_self_component *self_comp,
2266 bt_self_component_class *self_comp_class) {
2267 bool ret;
2268 const bt_value *value;
2269 bt_logging_level log_level = ctf_fs->log_level;
2270
2271 /* inputs parameter */
2272 *inputs = bt_value_map_borrow_entry_value_const(params, "inputs");
2273 if (!validate_inputs_parameter(ctf_fs, *inputs, self_comp, self_comp_class)) {
2274 goto error;
2275 }
2276
2277 /* clock-class-offset-s parameter */
2278 value = bt_value_map_borrow_entry_value_const(params,
2279 "clock-class-offset-s");
2280 if (value) {
2281 if (!bt_value_is_signed_integer(value)) {
2282 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
2283 "clock-class-offset-s must be an integer");
2284 goto error;
2285 }
2286 ctf_fs->metadata_config.clock_class_offset_s =
2287 bt_value_integer_signed_get(value);
2288 }
2289
2290 /* clock-class-offset-ns parameter */
2291 value = bt_value_map_borrow_entry_value_const(params,
2292 "clock-class-offset-ns");
2293 if (value) {
2294 if (!bt_value_is_signed_integer(value)) {
2295 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
2296 "clock-class-offset-ns must be an integer");
2297 goto error;
2298 }
2299 ctf_fs->metadata_config.clock_class_offset_ns =
2300 bt_value_integer_signed_get(value);
2301 }
2302
2303
2304 ret = true;
2305 goto end;
2306
2307 error:
2308 ret = false;
2309
2310 end:
2311 return ret;
2312 }
2313
2314 static
2315 struct ctf_fs_component *ctf_fs_create(
2316 const bt_value *params,
2317 bt_self_component_source *self_comp_src,
2318 bt_self_component_class *self_comp_class)
2319 {
2320 struct ctf_fs_component *ctf_fs = NULL;
2321 guint i;
2322 const bt_value *inputs_value;
2323 bt_self_component *self_comp =
2324 bt_self_component_source_as_self_component(self_comp_src);
2325
2326 ctf_fs = ctf_fs_component_create(bt_component_get_logging_level(
2327 bt_self_component_as_component(self_comp)), self_comp);
2328 if (!ctf_fs) {
2329 goto error;
2330 }
2331
2332 if (!read_src_fs_parameters(params, &inputs_value, ctf_fs,
2333 self_comp, self_comp_class)) {
2334 goto error;
2335 }
2336
2337 bt_self_component_set_data(self_comp, ctf_fs);
2338
2339 if (ctf_fs_component_create_ctf_fs_traces(ctf_fs, inputs_value,
2340 self_comp, self_comp_class)) {
2341 goto error;
2342 }
2343
2344 for (i = 0; i < ctf_fs->traces->len; i++) {
2345 struct ctf_fs_trace *trace = g_ptr_array_index(ctf_fs->traces, i);
2346
2347 if (create_streams_for_trace(trace)) {
2348 goto error;
2349 }
2350
2351 if (create_ports_for_trace(ctf_fs, trace, self_comp_src)) {
2352 goto error;
2353 }
2354 }
2355
2356 goto end;
2357
2358 error:
2359 ctf_fs_destroy(ctf_fs);
2360 ctf_fs = NULL;
2361 bt_self_component_set_data(self_comp, NULL);
2362
2363 end:
2364 return ctf_fs;
2365 }
2366
2367 BT_HIDDEN
2368 bt_component_class_init_method_status ctf_fs_init(
2369 bt_self_component_source *self_comp_src,
2370 const bt_value *params, __attribute__((unused)) void *init_method_data)
2371 {
2372 struct ctf_fs_component *ctf_fs;
2373 bt_component_class_init_method_status ret =
2374 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
2375
2376 ctf_fs = ctf_fs_create(params, self_comp_src, NULL);
2377 if (!ctf_fs) {
2378 ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
2379 }
2380
2381 return ret;
2382 }
2383
2384 BT_HIDDEN
2385 bt_component_class_query_method_status ctf_fs_query(
2386 bt_self_component_class_source *comp_class,
2387 bt_private_query_executor *priv_query_exec,
2388 const char *object, const bt_value *params,
2389 __attribute__((unused)) void *method_data,
2390 const bt_value **result)
2391 {
2392 bt_component_class_query_method_status status =
2393 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
2394 bt_logging_level log_level = bt_query_executor_get_logging_level(
2395 bt_private_query_executor_as_query_executor_const(
2396 priv_query_exec));
2397
2398 if (strcmp(object, "metadata-info") == 0) {
2399 status = metadata_info_query(comp_class, params, log_level,
2400 result);
2401 } else if (strcmp(object, "babeltrace.trace-info") == 0) {
2402 status = trace_info_query(comp_class, params, log_level,
2403 result);
2404 } else if (!strcmp(object, "babeltrace.support-info")) {
2405 status = support_info_query(comp_class, params, log_level, result);
2406 } else {
2407 BT_LOGE("Unknown query object `%s`", object);
2408 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT;
2409 goto end;
2410 }
2411 end:
2412 return status;
2413 }
BabelTrace - Trace Format Babel Tower
This page took 0.082273 seconds and 5 git commands to generate.