lib: replace trace is_static with destruction listeners
[babeltrace.git] / 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 #include <babeltrace/common-internal.h>
29 #include <babeltrace/babeltrace.h>
30 #include <plugins-common.h>
31 #include <glib.h>
32 #include <babeltrace/assert-internal.h>
33 #include <inttypes.h>
34 #include <stdbool.h>
35 #include "fs.h"
36 #include "metadata.h"
37 #include "data-stream-file.h"
38 #include "file.h"
39 #include "../common/metadata/decoder.h"
40 #include "../common/msg-iter/msg-iter.h"
41 #include "../common/utils/utils.h"
42 #include "query.h"
43
44 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC"
45 #include "logging.h"
46
47 static
48 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data)
49 {
50 struct ctf_fs_ds_file_info *ds_file_info;
51 int ret = 0;
52
53 BT_ASSERT(msg_iter_data->ds_file_info_index <
54 msg_iter_data->ds_file_group->ds_file_infos->len);
55 ds_file_info = g_ptr_array_index(
56 msg_iter_data->ds_file_group->ds_file_infos,
57 msg_iter_data->ds_file_info_index);
58
59 ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
60 msg_iter_data->ds_file = ctf_fs_ds_file_create(
61 msg_iter_data->ds_file_group->ctf_fs_trace,
62 msg_iter_data->pc_msg_iter,
63 msg_iter_data->msg_iter,
64 msg_iter_data->ds_file_group->stream,
65 ds_file_info->path->str);
66 if (!msg_iter_data->ds_file) {
67 ret = -1;
68 }
69
70 return ret;
71 }
72
73 static
74 void ctf_fs_msg_iter_data_destroy(
75 struct ctf_fs_msg_iter_data *msg_iter_data)
76 {
77 if (!msg_iter_data) {
78 return;
79 }
80
81 ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
82
83 if (msg_iter_data->msg_iter) {
84 bt_msg_iter_destroy(msg_iter_data->msg_iter);
85 }
86
87 g_free(msg_iter_data);
88 }
89
90 static
91 void set_msg_iter_emits_stream_beginning_end_messages(
92 struct ctf_fs_msg_iter_data *msg_iter_data)
93 {
94 bt_msg_iter_set_emit_stream_beginning_message(
95 msg_iter_data->ds_file->msg_iter,
96 msg_iter_data->ds_file_info_index == 0);
97 bt_msg_iter_set_emit_stream_end_message(
98 msg_iter_data->ds_file->msg_iter,
99 msg_iter_data->ds_file_info_index ==
100 msg_iter_data->ds_file_group->ds_file_infos->len - 1);
101 }
102
103 static
104 bt_self_message_iterator_status ctf_fs_iterator_next_one(
105 struct ctf_fs_msg_iter_data *msg_iter_data,
106 const bt_message **out_msg)
107 {
108 bt_self_message_iterator_status status;
109
110 BT_ASSERT(msg_iter_data->ds_file);
111
112 while (true) {
113 bt_message *msg;
114
115 status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg);
116 switch (status) {
117 case BT_SELF_MESSAGE_ITERATOR_STATUS_OK:
118 *out_msg = msg;
119 msg = NULL;
120 goto end;
121 case BT_SELF_MESSAGE_ITERATOR_STATUS_END:
122 {
123 int ret;
124
125 if (msg_iter_data->ds_file_info_index ==
126 msg_iter_data->ds_file_group->ds_file_infos->len - 1) {
127 /* End of all group's stream files */
128 goto end;
129 }
130
131 msg_iter_data->ds_file_info_index++;
132 bt_msg_iter_reset_for_next_stream_file(
133 msg_iter_data->msg_iter);
134 set_msg_iter_emits_stream_beginning_end_messages(
135 msg_iter_data);
136
137 /*
138 * Open and start reading the next stream file
139 * within our stream file group.
140 */
141 ret = msg_iter_data_set_current_ds_file(msg_iter_data);
142 if (ret) {
143 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
144 goto end;
145 }
146
147 /* Continue the loop to get the next message */
148 break;
149 }
150 default:
151 goto end;
152 }
153 }
154
155 end:
156 return status;
157 }
158
159 BT_HIDDEN
160 bt_self_message_iterator_status ctf_fs_iterator_next(
161 bt_self_message_iterator *iterator,
162 bt_message_array_const msgs, uint64_t capacity,
163 uint64_t *count)
164 {
165 bt_self_message_iterator_status status =
166 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
167 struct ctf_fs_msg_iter_data *msg_iter_data =
168 bt_self_message_iterator_get_data(iterator);
169 uint64_t i = 0;
170
171 while (i < capacity && status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
172 status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]);
173 if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
174 i++;
175 }
176 }
177
178 if (i > 0) {
179 /*
180 * Even if ctf_fs_iterator_next_one() returned something
181 * else than BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
182 * accumulated message objects in the output
183 * message array, so we need to return
184 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they are
185 * transfered to downstream. This other status occurs
186 * again the next time muxer_msg_iter_do_next() is
187 * called, possibly without any accumulated
188 * message, in which case we'll return it.
189 */
190 *count = i;
191 status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
192 }
193
194 return status;
195 }
196
197 static
198 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data)
199 {
200 int ret;
201
202 msg_iter_data->ds_file_info_index = 0;
203 ret = msg_iter_data_set_current_ds_file(msg_iter_data);
204 if (ret) {
205 goto end;
206 }
207
208 bt_msg_iter_reset(msg_iter_data->msg_iter);
209 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data);
210
211 end:
212 return ret;
213 }
214
215 BT_HIDDEN
216 bt_self_message_iterator_status ctf_fs_iterator_seek_beginning(
217 bt_self_message_iterator *it)
218 {
219 struct ctf_fs_msg_iter_data *msg_iter_data =
220 bt_self_message_iterator_get_data(it);
221 bt_self_message_iterator_status status =
222 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
223
224 BT_ASSERT(msg_iter_data);
225 if (ctf_fs_iterator_reset(msg_iter_data)) {
226 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
227 }
228
229 return status;
230 }
231
232 BT_HIDDEN
233 void ctf_fs_iterator_finalize(bt_self_message_iterator *it)
234 {
235 ctf_fs_msg_iter_data_destroy(
236 bt_self_message_iterator_get_data(it));
237 }
238
239 BT_HIDDEN
240 bt_self_message_iterator_status ctf_fs_iterator_init(
241 bt_self_message_iterator *self_msg_iter,
242 bt_self_component_source *self_comp,
243 bt_self_component_port_output *self_port)
244 {
245 struct ctf_fs_port_data *port_data;
246 struct ctf_fs_msg_iter_data *msg_iter_data = NULL;
247 bt_self_message_iterator_status ret =
248 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
249
250 port_data = bt_self_component_port_get_data(
251 bt_self_component_port_output_as_self_component_port(
252 self_port));
253 BT_ASSERT(port_data);
254 msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1);
255 if (!msg_iter_data) {
256 ret = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM;
257 goto error;
258 }
259
260 msg_iter_data->pc_msg_iter = self_msg_iter;
261 msg_iter_data->msg_iter = bt_msg_iter_create(
262 port_data->ds_file_group->ctf_fs_trace->metadata->tc,
263 bt_common_get_page_size() * 8,
264 ctf_fs_ds_file_medops, NULL);
265 if (!msg_iter_data->msg_iter) {
266 BT_LOGE_STR("Cannot create a CTF message iterator.");
267 ret = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM;
268 goto error;
269 }
270
271 msg_iter_data->ds_file_group = port_data->ds_file_group;
272 if (ctf_fs_iterator_reset(msg_iter_data)) {
273 ret = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
274 goto error;
275 }
276
277 bt_self_message_iterator_set_data(self_msg_iter,
278 msg_iter_data);
279 if (ret != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
280 goto error;
281 }
282
283 msg_iter_data = NULL;
284 goto end;
285
286 error:
287 bt_self_message_iterator_set_data(self_msg_iter, NULL);
288
289 end:
290 ctf_fs_msg_iter_data_destroy(msg_iter_data);
291 return ret;
292 }
293
294 static
295 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs)
296 {
297 if (!ctf_fs) {
298 return;
299 }
300
301 if (ctf_fs->traces) {
302 g_ptr_array_free(ctf_fs->traces, TRUE);
303 }
304
305 if (ctf_fs->port_data) {
306 g_ptr_array_free(ctf_fs->port_data, TRUE);
307 }
308
309 g_free(ctf_fs);
310 }
311
312 BT_HIDDEN
313 void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace)
314 {
315 if (!ctf_fs_trace) {
316 return;
317 }
318
319 if (ctf_fs_trace->ds_file_groups) {
320 g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE);
321 }
322
323 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace);
324
325 if (ctf_fs_trace->path) {
326 g_string_free(ctf_fs_trace->path, TRUE);
327 }
328
329 if (ctf_fs_trace->name) {
330 g_string_free(ctf_fs_trace->name, TRUE);
331 }
332
333 if (ctf_fs_trace->metadata) {
334 ctf_fs_metadata_fini(ctf_fs_trace->metadata);
335 g_free(ctf_fs_trace->metadata);
336 }
337
338 g_free(ctf_fs_trace);
339 }
340
341 static
342 void ctf_fs_trace_destroy_notifier(void *data)
343 {
344 struct ctf_fs_trace *trace = data;
345 ctf_fs_trace_destroy(trace);
346 }
347
348 void ctf_fs_finalize(bt_self_component_source *component)
349 {
350 ctf_fs_destroy(bt_self_component_get_data(
351 bt_self_component_source_as_self_component(component)));
352 }
353
354 static
355 void port_data_destroy(void *data) {
356 struct ctf_fs_port_data *port_data = data;
357
358 if (!port_data) {
359 return;
360 }
361
362 g_free(port_data);
363 }
364
365 static
366 GString *get_stream_instance_unique_name(
367 struct ctf_fs_ds_file_group *ds_file_group)
368 {
369 GString *name;
370 struct ctf_fs_ds_file_info *ds_file_info;
371
372 name = g_string_new(NULL);
373 if (!name) {
374 goto end;
375 }
376
377 /*
378 * If there's more than one stream file in the stream file
379 * group, the first (earliest) stream file's path is used as
380 * the stream's unique name.
381 */
382 BT_ASSERT(ds_file_group->ds_file_infos->len > 0);
383 ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0);
384 g_string_assign(name, ds_file_info->path->str);
385
386 end:
387 return name;
388 }
389
390 static
391 int create_one_port_for_trace(struct ctf_fs_component *ctf_fs,
392 struct ctf_fs_trace *ctf_fs_trace,
393 struct ctf_fs_ds_file_group *ds_file_group)
394 {
395 int ret = 0;
396 struct ctf_fs_port_data *port_data = NULL;
397 GString *port_name = NULL;
398
399 port_name = get_stream_instance_unique_name(ds_file_group);
400 if (!port_name) {
401 goto error;
402 }
403
404 BT_LOGD("Creating one port named `%s`", port_name->str);
405
406 /* Create output port for this file */
407 port_data = g_new0(struct ctf_fs_port_data, 1);
408 if (!port_data) {
409 goto error;
410 }
411
412 port_data->ctf_fs = ctf_fs;
413 port_data->ds_file_group = ds_file_group;
414 ret = bt_self_component_source_add_output_port(
415 ctf_fs->self_comp, port_name->str, port_data, NULL);
416 if (ret) {
417 goto error;
418 }
419
420 g_ptr_array_add(ctf_fs->port_data, port_data);
421 port_data = NULL;
422 goto end;
423
424 error:
425 ret = -1;
426
427 end:
428 if (port_name) {
429 g_string_free(port_name, TRUE);
430 }
431
432 port_data_destroy(port_data);
433 return ret;
434 }
435
436 static
437 int create_ports_for_trace(struct ctf_fs_component *ctf_fs,
438 struct ctf_fs_trace *ctf_fs_trace)
439 {
440 int ret = 0;
441 size_t i;
442
443 /* Create one output port for each stream file group */
444 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
445 struct ctf_fs_ds_file_group *ds_file_group =
446 g_ptr_array_index(ctf_fs_trace->ds_file_groups, i);
447
448 ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace,
449 ds_file_group);
450 if (ret) {
451 BT_LOGE("Cannot create output port.");
452 goto end;
453 }
454 }
455
456 end:
457 return ret;
458 }
459
460 static
461 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info)
462 {
463 if (!ds_file_info) {
464 return;
465 }
466
467 if (ds_file_info->path) {
468 g_string_free(ds_file_info->path, TRUE);
469 }
470
471 ctf_fs_ds_index_destroy(ds_file_info->index);
472 g_free(ds_file_info);
473 }
474
475 static
476 struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path,
477 int64_t begin_ns, struct ctf_fs_ds_index *index)
478 {
479 struct ctf_fs_ds_file_info *ds_file_info;
480
481 ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1);
482 if (!ds_file_info) {
483 goto end;
484 }
485
486 ds_file_info->path = g_string_new(path);
487 if (!ds_file_info->path) {
488 ctf_fs_ds_file_info_destroy(ds_file_info);
489 ds_file_info = NULL;
490 goto end;
491 }
492
493 ds_file_info->begin_ns = begin_ns;
494 ds_file_info->index = index;
495 index = NULL;
496
497 end:
498 ctf_fs_ds_index_destroy(index);
499 return ds_file_info;
500 }
501
502 static
503 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group)
504 {
505 if (!ds_file_group) {
506 return;
507 }
508
509 if (ds_file_group->ds_file_infos) {
510 g_ptr_array_free(ds_file_group->ds_file_infos, TRUE);
511 }
512
513 bt_stream_put_ref(ds_file_group->stream);
514 bt_stream_class_put_ref(ds_file_group->stream_class);
515 g_free(ds_file_group);
516 }
517
518 static
519 struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create(
520 struct ctf_fs_trace *ctf_fs_trace,
521 bt_stream_class *stream_class,
522 uint64_t stream_instance_id)
523 {
524 struct ctf_fs_ds_file_group *ds_file_group;
525
526 ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1);
527 if (!ds_file_group) {
528 goto error;
529 }
530
531 ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func(
532 (GDestroyNotify) ctf_fs_ds_file_info_destroy);
533 if (!ds_file_group->ds_file_infos) {
534 goto error;
535 }
536
537 ds_file_group->stream_id = stream_instance_id;
538 BT_ASSERT(stream_class);
539 ds_file_group->stream_class = stream_class;
540 bt_stream_class_get_ref(ds_file_group->stream_class);
541 ds_file_group->ctf_fs_trace = ctf_fs_trace;
542 goto end;
543
544 error:
545 ctf_fs_ds_file_group_destroy(ds_file_group);
546 ds_file_group = NULL;
547
548 end:
549 return ds_file_group;
550 }
551
552 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
553 static
554 void array_insert(GPtrArray *array, gpointer element, size_t pos)
555 {
556 size_t original_array_len = array->len;
557
558 /* Allocate an unused element at the end of the array. */
559 g_ptr_array_add(array, NULL);
560
561 /* If we are not inserting at the end, move the elements by one. */
562 if (pos < original_array_len) {
563 memmove(&(array->pdata[pos + 1]),
564 &(array->pdata[pos]),
565 (original_array_len - pos) * sizeof(gpointer));
566 }
567
568 /* Insert the value and bump the array len */
569 array->pdata[pos] = element;
570 }
571
572 static
573 int ctf_fs_ds_file_group_add_ds_file_info(
574 struct ctf_fs_ds_file_group *ds_file_group,
575 const char *path, int64_t begin_ns,
576 struct ctf_fs_ds_index *index)
577 {
578 struct ctf_fs_ds_file_info *ds_file_info;
579 gint i = 0;
580 int ret = 0;
581
582 /* Onwership of index is transferred. */
583 ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns, index);
584 index = NULL;
585 if (!ds_file_info) {
586 goto error;
587 }
588
589 /* Find a spot to insert this one */
590 for (i = 0; i < ds_file_group->ds_file_infos->len; i++) {
591 struct ctf_fs_ds_file_info *other_ds_file_info =
592 g_ptr_array_index(ds_file_group->ds_file_infos, i);
593
594 if (begin_ns < other_ds_file_info->begin_ns) {
595 break;
596 }
597 }
598
599 array_insert(ds_file_group->ds_file_infos, ds_file_info, i);
600 ds_file_info = NULL;
601 goto end;
602
603 error:
604 ctf_fs_ds_file_info_destroy(ds_file_info);
605 ctf_fs_ds_index_destroy(index);
606 ret = -1;
607 end:
608 return ret;
609 }
610
611 static
612 int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace,
613 const char *path)
614 {
615 bt_stream_class *stream_class = NULL;
616 int64_t stream_instance_id = -1;
617 int64_t begin_ns = -1;
618 struct ctf_fs_ds_file_group *ds_file_group = NULL;
619 bool add_group = false;
620 int ret;
621 size_t i;
622 struct ctf_fs_ds_file *ds_file = NULL;
623 struct ctf_fs_ds_index *index = NULL;
624 struct bt_msg_iter *msg_iter = NULL;
625 struct ctf_stream_class *sc = NULL;
626 struct bt_msg_iter_packet_properties props;
627
628 msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc,
629 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops, NULL);
630 if (!msg_iter) {
631 BT_LOGE_STR("Cannot create a CTF message iterator.");
632 goto error;
633 }
634
635 ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
636 NULL, path);
637 if (!ds_file) {
638 goto error;
639 }
640
641 ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
642 if (ret) {
643 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
644 path);
645 goto error;
646 }
647
648 sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
649 props.stream_class_id);
650 BT_ASSERT(sc);
651 stream_class = sc->ir_sc;
652 BT_ASSERT(stream_class);
653 stream_instance_id = props.data_stream_id;
654
655 if (props.snapshots.beginning_clock != UINT64_C(-1)) {
656 BT_ASSERT(sc->default_clock_class);
657 ret = bt_util_clock_cycles_to_ns_from_origin(
658 props.snapshots.beginning_clock,
659 sc->default_clock_class->frequency,
660 sc->default_clock_class->offset_seconds,
661 sc->default_clock_class->offset_cycles, &begin_ns);
662 if (ret) {
663 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
664 path);
665 goto error;
666 }
667 }
668
669 index = ctf_fs_ds_file_build_index(ds_file);
670 if (!index) {
671 BT_LOGW("Failed to index CTF stream file \'%s\'",
672 ds_file->file->path->str);
673 }
674
675 if (begin_ns == -1) {
676 /*
677 * No beggining timestamp to sort the stream files
678 * within a stream file group, so consider that this
679 * file must be the only one within its group.
680 */
681 stream_instance_id = -1;
682 }
683
684 if (stream_instance_id == -1) {
685 /*
686 * No stream instance ID or no beginning timestamp:
687 * create a unique stream file group for this stream
688 * file because, even if there's a stream instance ID,
689 * there's no timestamp to order the file within its
690 * group.
691 */
692 ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
693 stream_class, stream_instance_id);
694 if (!ds_file_group) {
695 goto error;
696 }
697
698 ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group,
699 path, begin_ns, index);
700 /* Ownership of index is transferred. */
701 index = NULL;
702 if (ret) {
703 goto error;
704 }
705
706 add_group = true;
707 goto end;
708 }
709
710 BT_ASSERT(stream_instance_id != -1);
711 BT_ASSERT(begin_ns != -1);
712
713 /* Find an existing stream file group with this ID */
714 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
715 ds_file_group = g_ptr_array_index(
716 ctf_fs_trace->ds_file_groups, i);
717
718 if (ds_file_group->stream_class == stream_class &&
719 ds_file_group->stream_id ==
720 stream_instance_id) {
721 break;
722 }
723
724 ds_file_group = NULL;
725 }
726
727 if (!ds_file_group) {
728 ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
729 stream_class, stream_instance_id);
730 if (!ds_file_group) {
731 goto error;
732 }
733
734 add_group = true;
735 }
736
737 ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, path,
738 begin_ns, index);
739 index = NULL;
740 if (ret) {
741 goto error;
742 }
743
744 goto end;
745
746 error:
747 ctf_fs_ds_file_group_destroy(ds_file_group);
748 ret = -1;
749
750 end:
751 if (add_group && ds_file_group) {
752 g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group);
753 }
754
755 ctf_fs_ds_file_destroy(ds_file);
756
757 if (msg_iter) {
758 bt_msg_iter_destroy(msg_iter);
759 }
760
761 ctf_fs_ds_index_destroy(index);
762 return ret;
763 }
764
765 static
766 int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
767 {
768 int ret = 0;
769 const char *basename;
770 GError *error = NULL;
771 GDir *dir = NULL;
772 size_t i;
773
774 /* Check each file in the path directory, except specific ones */
775 dir = g_dir_open(ctf_fs_trace->path->str, 0, &error);
776 if (!dir) {
777 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
778 ctf_fs_trace->path->str, error->message,
779 error->code);
780 goto error;
781 }
782
783 while ((basename = g_dir_read_name(dir))) {
784 struct ctf_fs_file *file;
785
786 if (!strcmp(basename, CTF_FS_METADATA_FILENAME)) {
787 /* Ignore the metadata stream. */
788 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`",
789 ctf_fs_trace->path->str, basename);
790 continue;
791 }
792
793 if (basename[0] == '.') {
794 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`",
795 ctf_fs_trace->path->str, basename);
796 continue;
797 }
798
799 /* Create the file. */
800 file = ctf_fs_file_create();
801 if (!file) {
802 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`",
803 ctf_fs_trace->path->str, basename);
804 goto error;
805 }
806
807 /* Create full path string. */
808 g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s",
809 ctf_fs_trace->path->str, basename);
810 if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) {
811 BT_LOGD("Ignoring non-regular file `%s`",
812 file->path->str);
813 ctf_fs_file_destroy(file);
814 file = NULL;
815 continue;
816 }
817
818 ret = ctf_fs_file_open(file, "rb");
819 if (ret) {
820 BT_LOGE("Cannot open stream file `%s`", file->path->str);
821 goto error;
822 }
823
824 if (file->size == 0) {
825 /* Skip empty stream. */
826 BT_LOGD("Ignoring empty file `%s`", file->path->str);
827 ctf_fs_file_destroy(file);
828 continue;
829 }
830
831 ret = add_ds_file_to_ds_file_group(ctf_fs_trace,
832 file->path->str);
833 if (ret) {
834 BT_LOGE("Cannot add stream file `%s` to stream file group",
835 file->path->str);
836 ctf_fs_file_destroy(file);
837 goto error;
838 }
839
840 ctf_fs_file_destroy(file);
841 }
842
843 if (!ctf_fs_trace->trace) {
844 goto end;
845 }
846
847 /*
848 * At this point, DS file groupes are created, but their
849 * associated stream objects do not exist yet. This is because
850 * we need to name the created stream object with the data
851 * stream file's path. We have everything we need here to do
852 * this.
853 */
854 for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
855 struct ctf_fs_ds_file_group *ds_file_group =
856 g_ptr_array_index(ctf_fs_trace->ds_file_groups, i);
857 GString *name = get_stream_instance_unique_name(ds_file_group);
858
859 if (!name) {
860 goto error;
861 }
862
863 if (ds_file_group->stream_id == UINT64_C(-1)) {
864 /* No stream ID: use 0 */
865 ds_file_group->stream = bt_stream_create_with_id(
866 ds_file_group->stream_class,
867 ctf_fs_trace->trace,
868 ctf_fs_trace->next_stream_id);
869 ctf_fs_trace->next_stream_id++;
870 } else {
871 /* Specific stream ID */
872 ds_file_group->stream = bt_stream_create_with_id(
873 ds_file_group->stream_class,
874 ctf_fs_trace->trace,
875 (uint64_t) ds_file_group->stream_id);
876 }
877
878 if (!ds_file_group->stream) {
879 BT_LOGE("Cannot create stream for DS file group: "
880 "addr=%p, stream-name=\"%s\"",
881 ds_file_group, name->str);
882 g_string_free(name, TRUE);
883 goto error;
884 }
885
886 ret = bt_stream_set_name(ds_file_group->stream,
887 name->str);
888 if (ret) {
889 BT_LOGE("Cannot set stream's name: "
890 "addr=%p, stream-name=\"%s\"",
891 ds_file_group->stream, name->str);
892 g_string_free(name, TRUE);
893 goto error;
894 }
895
896 g_string_free(name, TRUE);
897 }
898
899 goto end;
900
901 error:
902 ret = -1;
903
904 end:
905 if (dir) {
906 g_dir_close(dir);
907 dir = NULL;
908 }
909
910 if (error) {
911 g_error_free(error);
912 }
913
914 return ret;
915 }
916
917 static
918 int set_trace_name(bt_trace *trace, const char *name_suffix)
919 {
920 int ret = 0;
921 const bt_trace_class *tc = bt_trace_borrow_class_const(trace);
922 const bt_value *val;
923 GString *name;
924
925 name = g_string_new(NULL);
926 if (!name) {
927 BT_LOGE_STR("Failed to allocate a GString.");
928 ret = -1;
929 goto end;
930 }
931
932 /*
933 * Check if we have a trace environment string value named `hostname`.
934 * If so, use it as the trace name's prefix.
935 */
936 val = bt_trace_class_borrow_environment_entry_value_by_name_const(
937 tc, "hostname");
938 if (val && bt_value_is_string(val)) {
939 g_string_append(name, bt_value_string_get(val));
940
941 if (name_suffix) {
942 g_string_append_c(name, G_DIR_SEPARATOR);
943 }
944 }
945
946 if (name_suffix) {
947 g_string_append(name, name_suffix);
948 }
949
950 ret = bt_trace_set_name(trace, name->str);
951 if (ret) {
952 goto end;
953 }
954
955 goto end;
956
957 end:
958 if (name) {
959 g_string_free(name, TRUE);
960 }
961
962 return ret;
963 }
964
965 BT_HIDDEN
966 struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component_source *self_comp,
967 const char *path, const char *name,
968 struct ctf_fs_metadata_config *metadata_config)
969 {
970 struct ctf_fs_trace *ctf_fs_trace;
971 int ret;
972
973 ctf_fs_trace = g_new0(struct ctf_fs_trace, 1);
974 if (!ctf_fs_trace) {
975 goto end;
976 }
977
978 ctf_fs_trace->path = g_string_new(path);
979 if (!ctf_fs_trace->path) {
980 goto error;
981 }
982
983 ctf_fs_trace->name = g_string_new(name);
984 if (!ctf_fs_trace->name) {
985 goto error;
986 }
987
988 ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1);
989 if (!ctf_fs_trace->metadata) {
990 goto error;
991 }
992
993 ctf_fs_metadata_init(ctf_fs_trace->metadata);
994 ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func(
995 (GDestroyNotify) ctf_fs_ds_file_group_destroy);
996 if (!ctf_fs_trace->ds_file_groups) {
997 goto error;
998 }
999
1000 ret = ctf_fs_metadata_set_trace_class(self_comp,
1001 ctf_fs_trace, metadata_config);
1002 if (ret) {
1003 goto error;
1004 }
1005
1006 if (ctf_fs_trace->metadata->trace_class) {
1007 ctf_fs_trace->trace =
1008 bt_trace_create(ctf_fs_trace->metadata->trace_class);
1009 if (!ctf_fs_trace->trace) {
1010 goto error;
1011 }
1012 }
1013
1014 if (ctf_fs_trace->trace) {
1015 ret = set_trace_name(ctf_fs_trace->trace, name);
1016 if (ret) {
1017 goto error;
1018 }
1019 }
1020
1021 ret = create_ds_file_groups(ctf_fs_trace);
1022 if (ret) {
1023 goto error;
1024 }
1025
1026 goto end;
1027
1028 error:
1029 ctf_fs_trace_destroy(ctf_fs_trace);
1030 ctf_fs_trace = NULL;
1031
1032 end:
1033 return ctf_fs_trace;
1034 }
1035
1036 static
1037 int path_is_ctf_trace(const char *path)
1038 {
1039 GString *metadata_path = g_string_new(NULL);
1040 int ret = 0;
1041
1042 if (!metadata_path) {
1043 ret = -1;
1044 goto end;
1045 }
1046
1047 g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME);
1048
1049 if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) {
1050 ret = 1;
1051 goto end;
1052 }
1053
1054 end:
1055 g_string_free(metadata_path, TRUE);
1056 return ret;
1057 }
1058
1059 static
1060 int add_trace_path(GList **trace_paths, const char *path)
1061 {
1062 GString *norm_path = NULL;
1063 int ret = 0;
1064
1065 norm_path = bt_common_normalize_path(path, NULL);
1066 if (!norm_path) {
1067 BT_LOGE("Failed to normalize path `%s`.", path);
1068 ret = -1;
1069 goto end;
1070 }
1071
1072 // FIXME: Remove or ifdef for __MINGW32__
1073 if (strcmp(norm_path->str, "/") == 0) {
1074 BT_LOGE("Opening a trace in `/` is not supported.");
1075 ret = -1;
1076 goto end;
1077 }
1078
1079 *trace_paths = g_list_prepend(*trace_paths, norm_path);
1080 BT_ASSERT(*trace_paths);
1081 norm_path = NULL;
1082
1083 end:
1084 if (norm_path) {
1085 g_string_free(norm_path, TRUE);
1086 }
1087
1088 return ret;
1089 }
1090
1091 BT_HIDDEN
1092 int ctf_fs_find_traces(GList **trace_paths, const char *start_path)
1093 {
1094 int ret;
1095 GError *error = NULL;
1096 GDir *dir = NULL;
1097 const char *basename = NULL;
1098
1099 /* Check if the starting path is a CTF trace itself */
1100 ret = path_is_ctf_trace(start_path);
1101 if (ret < 0) {
1102 goto end;
1103 }
1104
1105 if (ret) {
1106 /*
1107 * Stop recursion: a CTF trace cannot contain another
1108 * CTF trace.
1109 */
1110 ret = add_trace_path(trace_paths, start_path);
1111 goto end;
1112 }
1113
1114 /* Look for subdirectories */
1115 if (!g_file_test(start_path, G_FILE_TEST_IS_DIR)) {
1116 /* Starting path is not a directory: end of recursion */
1117 goto end;
1118 }
1119
1120 dir = g_dir_open(start_path, 0, &error);
1121 if (!dir) {
1122 if (error->code == G_FILE_ERROR_ACCES) {
1123 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1124 start_path, error->message, error->code);
1125 goto end;
1126 }
1127
1128 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1129 start_path, error->message, error->code);
1130 ret = -1;
1131 goto end;
1132 }
1133
1134 while ((basename = g_dir_read_name(dir))) {
1135 GString *sub_path = g_string_new(NULL);
1136
1137 if (!sub_path) {
1138 ret = -1;
1139 goto end;
1140 }
1141
1142 g_string_printf(sub_path, "%s" G_DIR_SEPARATOR_S "%s", start_path, basename);
1143 ret = ctf_fs_find_traces(trace_paths, sub_path->str);
1144 g_string_free(sub_path, TRUE);
1145 if (ret) {
1146 goto end;
1147 }
1148 }
1149
1150 end:
1151 if (dir) {
1152 g_dir_close(dir);
1153 }
1154
1155 if (error) {
1156 g_error_free(error);
1157 }
1158
1159 return ret;
1160 }
1161
1162 BT_HIDDEN
1163 GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path) {
1164 GList *trace_names = NULL;
1165 GList *node;
1166 const char *last_sep;
1167 size_t base_dist;
1168
1169 /*
1170 * At this point we know that all the trace paths are
1171 * normalized, and so is the base path. This means that
1172 * they are absolute and they don't end with a separator.
1173 * We can simply find the location of the last separator
1174 * in the base path, which gives us the name of the actual
1175 * directory to look into, and use this location as the
1176 * start of each trace name within each trace path.
1177 *
1178 * For example:
1179 *
1180 * Base path: /home/user/my-traces/some-trace
1181 * Trace paths:
1182 * - /home/user/my-traces/some-trace/host1/trace1
1183 * - /home/user/my-traces/some-trace/host1/trace2
1184 * - /home/user/my-traces/some-trace/host2/trace
1185 * - /home/user/my-traces/some-trace/other-trace
1186 *
1187 * In this case the trace names are:
1188 *
1189 * - some-trace/host1/trace1
1190 * - some-trace/host1/trace2
1191 * - some-trace/host2/trace
1192 * - some-trace/other-trace
1193 */
1194 last_sep = strrchr(base_path, G_DIR_SEPARATOR);
1195
1196 /* We know there's at least one separator */
1197 BT_ASSERT(last_sep);
1198
1199 /* Distance to base */
1200 base_dist = last_sep - base_path + 1;
1201
1202 /* Create the trace names */
1203 for (node = trace_paths; node; node = g_list_next(node)) {
1204 GString *trace_name = g_string_new(NULL);
1205 GString *trace_path = node->data;
1206
1207 BT_ASSERT(trace_name);
1208 g_string_assign(trace_name, &trace_path->str[base_dist]);
1209 trace_names = g_list_append(trace_names, trace_name);
1210 }
1211
1212 return trace_names;
1213 }
1214
1215 static
1216 int create_ctf_fs_traces(bt_self_component_source *self_comp,
1217 struct ctf_fs_component *ctf_fs,
1218 const char *path_param)
1219 {
1220 struct ctf_fs_trace *ctf_fs_trace = NULL;
1221 int ret = 0;
1222 GString *norm_path = NULL;
1223 GList *trace_paths = NULL;
1224 GList *trace_names = NULL;
1225 GList *tp_node;
1226 GList *tn_node;
1227
1228 norm_path = bt_common_normalize_path(path_param, NULL);
1229 if (!norm_path) {
1230 BT_LOGE("Failed to normalize path: `%s`.",
1231 path_param);
1232 goto error;
1233 }
1234
1235 ret = ctf_fs_find_traces(&trace_paths, norm_path->str);
1236 if (ret) {
1237 goto error;
1238 }
1239
1240 if (!trace_paths) {
1241 BT_LOGE("No CTF traces recursively found in `%s`.",
1242 path_param);
1243 goto error;
1244 }
1245
1246 trace_names = ctf_fs_create_trace_names(trace_paths, norm_path->str);
1247 if (!trace_names) {
1248 BT_LOGE("Cannot create trace names from trace paths.");
1249 goto error;
1250 }
1251
1252 for (tp_node = trace_paths, tn_node = trace_names; tp_node;
1253 tp_node = g_list_next(tp_node),
1254 tn_node = g_list_next(tn_node)) {
1255 GString *trace_path = tp_node->data;
1256 GString *trace_name = tn_node->data;
1257
1258 ctf_fs_trace = ctf_fs_trace_create(self_comp,
1259 trace_path->str, trace_name->str,
1260 &ctf_fs->metadata_config);
1261 if (!ctf_fs_trace) {
1262 BT_LOGE("Cannot create trace for `%s`.",
1263 trace_path->str);
1264 goto error;
1265 }
1266
1267 ret = create_ports_for_trace(ctf_fs, ctf_fs_trace);
1268 if (ret) {
1269 goto error;
1270 }
1271
1272 g_ptr_array_add(ctf_fs->traces, ctf_fs_trace);
1273 ctf_fs_trace = NULL;
1274 }
1275
1276 goto end;
1277
1278 error:
1279 ret = -1;
1280 ctf_fs_trace_destroy(ctf_fs_trace);
1281
1282 end:
1283 for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
1284 if (tp_node->data) {
1285 g_string_free(tp_node->data, TRUE);
1286 }
1287 }
1288
1289 for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
1290 if (tn_node->data) {
1291 g_string_free(tn_node->data, TRUE);
1292 }
1293 }
1294
1295 if (trace_paths) {
1296 g_list_free(trace_paths);
1297 }
1298
1299 if (trace_names) {
1300 g_list_free(trace_names);
1301 }
1302
1303 if (norm_path) {
1304 g_string_free(norm_path, TRUE);
1305 }
1306
1307 return ret;
1308 }
1309
1310 static
1311 struct ctf_fs_component *ctf_fs_create(
1312 bt_self_component_source *self_comp,
1313 const bt_value *params)
1314 {
1315 struct ctf_fs_component *ctf_fs;
1316 const bt_value *value = NULL;
1317 const char *path_param;
1318
1319 ctf_fs = g_new0(struct ctf_fs_component, 1);
1320 if (!ctf_fs) {
1321 goto end;
1322 }
1323
1324 bt_self_component_set_data(
1325 bt_self_component_source_as_self_component(self_comp),
1326 ctf_fs);
1327
1328 /*
1329 * We don't need to get a new reference here because as long as
1330 * our private ctf_fs_component object exists, the containing
1331 * private component should also exist.
1332 */
1333 ctf_fs->self_comp = self_comp;
1334 value = bt_value_map_borrow_entry_value_const(params, "path");
1335 if (value && !bt_value_is_string(value)) {
1336 goto error;
1337 }
1338
1339 path_param = bt_value_string_get(value);
1340 value = bt_value_map_borrow_entry_value_const(params,
1341 "clock-class-offset-s");
1342 if (value) {
1343 if (!bt_value_is_integer(value)) {
1344 BT_LOGE("clock-class-offset-s should be an integer");
1345 goto error;
1346 }
1347 ctf_fs->metadata_config.clock_class_offset_s = bt_value_integer_get(value);
1348 }
1349
1350 value = bt_value_map_borrow_entry_value_const(params,
1351 "clock-class-offset-ns");
1352 if (value) {
1353 if (!bt_value_is_integer(value)) {
1354 BT_LOGE("clock-class-offset-ns should be an integer");
1355 goto error;
1356 }
1357 ctf_fs->metadata_config.clock_class_offset_ns = bt_value_integer_get(value);
1358 }
1359
1360 ctf_fs->port_data = g_ptr_array_new_with_free_func(port_data_destroy);
1361 if (!ctf_fs->port_data) {
1362 goto error;
1363 }
1364
1365 ctf_fs->traces = g_ptr_array_new_with_free_func(
1366 ctf_fs_trace_destroy_notifier);
1367 if (!ctf_fs->traces) {
1368 goto error;
1369 }
1370
1371 if (create_ctf_fs_traces(self_comp, ctf_fs, path_param)) {
1372 goto error;
1373 }
1374
1375 goto end;
1376
1377 error:
1378 ctf_fs_destroy(ctf_fs);
1379 ctf_fs = NULL;
1380 bt_self_component_set_data(
1381 bt_self_component_source_as_self_component(self_comp),
1382 NULL);
1383
1384 end:
1385 return ctf_fs;
1386 }
1387
1388 BT_HIDDEN
1389 bt_self_component_status ctf_fs_init(
1390 bt_self_component_source *self_comp,
1391 const bt_value *params, UNUSED_VAR void *init_method_data)
1392 {
1393 struct ctf_fs_component *ctf_fs;
1394 bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
1395
1396 ctf_fs = ctf_fs_create(self_comp, params);
1397 if (!ctf_fs) {
1398 ret = BT_SELF_COMPONENT_STATUS_ERROR;
1399 }
1400
1401 return ret;
1402 }
1403
1404 BT_HIDDEN
1405 bt_query_status ctf_fs_query(
1406 bt_self_component_class_source *comp_class,
1407 const bt_query_executor *query_exec,
1408 const char *object, const bt_value *params,
1409 const bt_value **result)
1410 {
1411 bt_query_status status = BT_QUERY_STATUS_OK;
1412
1413 if (!strcmp(object, "metadata-info")) {
1414 status = metadata_info_query(comp_class, params, result);
1415 } else if (!strcmp(object, "trace-info")) {
1416 status = trace_info_query(comp_class, params, result);
1417 } else {
1418 BT_LOGE("Unknown query object `%s`", object);
1419 status = BT_QUERY_STATUS_INVALID_OBJECT;
1420 goto end;
1421 }
1422 end:
1423 return status;
1424 }
This page took 0.063404 seconds and 4 git commands to generate.