4 * Babeltrace CTF file system Reader Component
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/ctf-ir/packet.h>
30 #include <babeltrace/ctf-ir/clock-class.h>
31 #include <babeltrace/graph/private-port.h>
32 #include <babeltrace/graph/private-component.h>
33 #include <babeltrace/graph/private-component-source.h>
34 #include <babeltrace/graph/private-notification-iterator.h>
35 #include <babeltrace/graph/component.h>
36 #include <babeltrace/graph/notification-iterator.h>
37 #include <babeltrace/graph/clock-class-priority-map.h>
38 #include <plugins-common.h>
45 #include "data-stream.h"
47 #include "../common/metadata/decoder.h"
49 #define PRINT_ERR_STREAM ctf_fs->error_fp
50 #define PRINT_PREFIX "ctf-fs"
52 #define METADATA_TEXT_SIG "/* CTF 1.8"
57 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
58 struct bt_private_notification_iterator
*iterator
)
60 struct ctf_fs_stream
*fs_stream
=
61 bt_private_notification_iterator_get_user_data(iterator
);
63 return ctf_fs_stream_next(fs_stream
);
66 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
)
69 bt_private_notification_iterator_get_user_data(it
);
71 ctf_fs_stream_destroy(ctf_fs_stream
);
74 enum bt_notification_iterator_status
ctf_fs_iterator_init(
75 struct bt_private_notification_iterator
*it
,
76 struct bt_private_port
*port
)
78 struct ctf_fs_stream
*stream
= NULL
;
79 struct ctf_fs_component
*ctf_fs
;
80 struct ctf_fs_port_data
*port_data
;
81 struct bt_private_component
*priv_comp
=
82 bt_private_notification_iterator_get_private_component(it
);
83 enum bt_notification_iterator_status ret
=
84 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
88 ctf_fs
= bt_private_component_get_user_data(priv_comp
);
90 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
94 port_data
= bt_private_port_get_user_data(port
);
96 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
100 stream
= ctf_fs_stream_create(ctf_fs
, port_data
->path
->str
);
105 ret
= bt_private_notification_iterator_set_user_data(it
, stream
);
114 (void) bt_private_notification_iterator_set_user_data(it
, NULL
);
116 if (ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
117 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
121 ctf_fs_stream_destroy(stream
);
127 void ctf_fs_destroy_data(struct ctf_fs_component
*ctf_fs
)
133 if (ctf_fs
->trace_path
) {
134 g_string_free(ctf_fs
->trace_path
, TRUE
);
137 if (ctf_fs
->port_data
) {
138 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
141 if (ctf_fs
->metadata
) {
142 ctf_fs_metadata_fini(ctf_fs
->metadata
);
143 g_free(ctf_fs
->metadata
);
146 bt_put(ctf_fs
->cc_prio_map
);
150 void ctf_fs_finalize(struct bt_private_component
*component
)
152 void *data
= bt_private_component_get_user_data(component
);
154 ctf_fs_destroy_data(data
);
158 void port_data_destroy(void *data
) {
159 struct ctf_fs_port_data
*port_data
= data
;
165 if (port_data
->path
) {
166 g_string_free(port_data
->path
, TRUE
);
173 int create_one_port(struct ctf_fs_component
*ctf_fs
,
174 const char *stream_basename
, const char *stream_path
)
177 struct bt_private_port
*port
= NULL
;
178 struct ctf_fs_port_data
*port_data
= NULL
;
179 GString
*port_name
= NULL
;
181 port_name
= g_string_new(NULL
);
186 /* Assign the name for the new output port */
187 g_string_assign(port_name
, "");
188 g_string_printf(port_name
, "trace0-stream-%s", stream_basename
);
189 PDBG("Creating one port named `%s` associated with path `%s`\n",
190 port_name
->str
, stream_path
);
192 /* Create output port for this file */
193 port_data
= g_new0(struct ctf_fs_port_data
, 1);
198 port_data
->path
= g_string_new(stream_path
);
199 if (!port_data
->path
) {
203 port
= bt_private_component_source_add_output_private_port(
204 ctf_fs
->priv_comp
, port_name
->str
, port_data
);
209 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
218 g_string_free(port_name
, TRUE
);
222 port_data_destroy(port_data
);
227 int create_ports(struct ctf_fs_component
*ctf_fs
)
230 const char *basename
;
231 GError
*error
= NULL
;
233 struct ctf_fs_file
*file
= NULL
;
235 /* Create one output port for each stream file */
236 dir
= g_dir_open(ctf_fs
->trace_path
->str
, 0, &error
);
238 PERR("Cannot open directory `%s`: %s (code %d)\n",
239 ctf_fs
->trace_path
->str
, error
->message
,
244 while ((basename
= g_dir_read_name(dir
))) {
245 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
246 /* Ignore the metadata stream. */
247 PDBG("Ignoring metadata file `%s`\n", basename
);
251 if (basename
[0] == '.') {
252 PDBG("Ignoring hidden file `%s`\n", basename
);
256 /* Create the file. */
257 file
= ctf_fs_file_create(ctf_fs
);
259 PERR("Cannot create stream file object for file `%s`\n",
264 /* Create full path string. */
265 g_string_append_printf(file
->path
, "%s/%s",
266 ctf_fs
->trace_path
->str
, basename
);
267 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
268 PDBG("Ignoring non-regular file `%s`\n", basename
);
269 ctf_fs_file_destroy(file
);
274 ret
= ctf_fs_file_open(ctf_fs
, file
, "rb");
276 PERR("Cannot open stream file `%s`\n", basename
);
280 if (file
->size
== 0) {
281 /* Skip empty stream. */
282 PDBG("Ignoring empty file `%s`\n", basename
);
283 ctf_fs_file_destroy(file
);
288 ret
= create_one_port(ctf_fs
, basename
, file
->path
->str
);
290 PERR("Cannot create output port for file `%s`\n",
295 ctf_fs_file_destroy(file
);
314 ctf_fs_file_destroy(file
);
319 int create_cc_prio_map(struct ctf_fs_component
*ctf_fs
)
326 ctf_fs
->cc_prio_map
= bt_clock_class_priority_map_create();
327 if (!ctf_fs
->cc_prio_map
) {
332 count
= bt_ctf_trace_get_clock_class_count(ctf_fs
->metadata
->trace
);
335 for (i
= 0; i
< count
; i
++) {
336 struct bt_ctf_clock_class
*clock_class
=
337 bt_ctf_trace_get_clock_class_by_index(
338 ctf_fs
->metadata
->trace
, i
);
341 ret
= bt_clock_class_priority_map_add_clock_class(
342 ctf_fs
->cc_prio_map
, clock_class
, 0);
355 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
356 struct bt_value
*params
)
358 struct ctf_fs_component
*ctf_fs
;
359 struct bt_value
*value
= NULL
;
363 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
369 * We don't need to get a new reference here because as long as
370 * our private ctf_fs_component object exists, the containing
371 * private component should also exist.
373 ctf_fs
->priv_comp
= priv_comp
;
375 /* FIXME: should probably look for a source URI */
376 value
= bt_value_map_get(params
, "path");
377 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
381 ret
= bt_value_string_get(value
, &path
);
386 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
387 if (!ctf_fs
->port_data
) {
391 ctf_fs
->trace_path
= g_string_new(path
);
392 if (!ctf_fs
->trace_path
) {
398 value
= bt_value_map_get(params
, "offset-s");
402 if (!bt_value_is_integer(value
)) {
404 "offset-s should be an integer\n");
407 ret
= bt_value_integer_get(value
, &offset
);
408 if (ret
!= BT_VALUE_STATUS_OK
) {
410 "Failed to get offset-s value\n");
413 ctf_fs
->options
.clock_offset
= offset
;
417 value
= bt_value_map_get(params
, "offset-ns");
421 if (!bt_value_is_integer(value
)) {
423 "offset-ns should be an integer\n");
426 ret
= bt_value_integer_get(value
, &offset
);
427 if (ret
!= BT_VALUE_STATUS_OK
) {
429 "Failed to get offset-ns value\n");
432 ctf_fs
->options
.clock_offset_ns
= offset
;
436 ctf_fs
->error_fp
= stderr
;
437 ctf_fs
->page_size
= (size_t) getpagesize();
439 // FIXME: check error.
440 ctf_fs
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
441 if (!ctf_fs
->metadata
) {
445 ret
= ctf_fs_metadata_set_trace(ctf_fs
);
450 ret
= create_cc_prio_map(ctf_fs
);
455 ret
= create_ports(ctf_fs
);
463 ctf_fs_destroy_data(ctf_fs
);
470 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
471 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
473 struct ctf_fs_component
*ctf_fs
;
474 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
477 ctf_fs_debug
= g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
478 ctf_fs
= ctf_fs_create(priv_comp
, params
);
480 ret
= BT_COMPONENT_STATUS_NOMEM
;
484 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
485 if (ret
!= BT_COMPONENT_STATUS_OK
) {
491 (void) bt_private_component_set_user_data(priv_comp
, NULL
);
492 ctf_fs_destroy_data(ctf_fs
);
497 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
498 const char *object
, struct bt_value
*params
)
500 struct bt_value
*results
= NULL
;
501 struct bt_value
*path_value
= NULL
;
502 char *metadata_text
= NULL
;
503 FILE *metadata_fp
= NULL
;
504 GString
*g_metadata_text
= NULL
;
506 if (strcmp(object
, "metadata-info") == 0) {
512 results
= bt_value_map_create();
517 if (!bt_value_is_map(params
)) {
519 "Query parameters is not a map value object\n");
523 path_value
= bt_value_map_get(params
, "path");
524 ret
= bt_value_string_get(path_value
, &path
);
527 "Cannot get `path` string parameter\n");
532 metadata_fp
= ctf_fs_metadata_open_file(path
);
535 "Cannot open trace at path `%s`\n", path
);
539 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
543 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
544 metadata_fp
, &metadata_text
, bo
);
547 "Cannot decode packetized metadata file\n");
553 fseek(metadata_fp
, 0, SEEK_END
);
554 filesize
= ftell(metadata_fp
);
556 metadata_text
= malloc(filesize
+ 1);
557 if (!metadata_text
) {
559 "Cannot allocate buffer for metadata text\n");
563 if (fread(metadata_text
, filesize
, 1, metadata_fp
) !=
566 "Cannot read metadata file\n");
570 metadata_text
[filesize
] = '\0';
573 g_metadata_text
= g_string_new(NULL
);
574 if (!g_metadata_text
) {
578 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
579 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
580 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
581 g_string_append(g_metadata_text
, " */\n\n");
584 g_string_append(g_metadata_text
, metadata_text
);
586 ret
= bt_value_map_insert_string(results
, "text",
587 g_metadata_text
->str
);
589 fprintf(stderr
, "Cannot insert metadata text into results\n");
593 ret
= bt_value_map_insert_bool(results
, "is-packetized",
596 fprintf(stderr
, "Cannot insert is packetized into results\n");
600 fprintf(stderr
, "Unknown query object `%s`\n", object
);
613 if (g_metadata_text
) {
614 g_string_free(g_metadata_text
, TRUE
);