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 <plugins-common.h>
43 #include "data-stream.h"
46 #define PRINT_ERR_STREAM ctf_fs->error_fp
47 #define PRINT_PREFIX "ctf-fs"
49 #define METADATA_TEXT_SIG "/* CTF 1.8"
54 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
55 struct bt_private_notification_iterator
*iterator
)
57 struct ctf_fs_stream
*fs_stream
=
58 bt_private_notification_iterator_get_user_data(iterator
);
60 return ctf_fs_stream_next(fs_stream
);
63 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
)
66 bt_private_notification_iterator_get_user_data(it
);
68 ctf_fs_stream_destroy(ctf_fs_stream
);
71 enum bt_notification_iterator_status
ctf_fs_iterator_init(
72 struct bt_private_notification_iterator
*it
,
73 struct bt_private_port
*port
)
75 struct ctf_fs_stream
*stream
= NULL
;
76 struct ctf_fs_component
*ctf_fs
;
77 struct ctf_fs_port_data
*port_data
;
78 struct bt_private_component
*priv_comp
=
79 bt_private_notification_iterator_get_private_component(it
);
80 enum bt_notification_iterator_status ret
=
81 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
85 ctf_fs
= bt_private_component_get_user_data(priv_comp
);
87 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVAL
;
91 port_data
= bt_private_port_get_user_data(port
);
93 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVAL
;
97 stream
= ctf_fs_stream_create(ctf_fs
, port_data
->path
->str
);
102 ret
= bt_private_notification_iterator_set_user_data(it
, stream
);
111 (void) bt_private_notification_iterator_set_user_data(it
, NULL
);
113 if (ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
114 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
118 ctf_fs_stream_destroy(stream
);
124 void ctf_fs_destroy_data(struct ctf_fs_component
*ctf_fs
)
130 if (ctf_fs
->trace_path
) {
131 g_string_free(ctf_fs
->trace_path
, TRUE
);
134 if (ctf_fs
->port_data
) {
135 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
138 if (ctf_fs
->metadata
) {
139 ctf_fs_metadata_fini(ctf_fs
->metadata
);
140 g_free(ctf_fs
->metadata
);
146 void ctf_fs_finalize(struct bt_private_component
*component
)
148 void *data
= bt_private_component_get_user_data(component
);
150 ctf_fs_destroy_data(data
);
154 void port_data_destroy(void *data
) {
155 struct ctf_fs_port_data
*port_data
= data
;
161 if (port_data
->path
) {
162 g_string_free(port_data
->path
, TRUE
);
169 int create_one_port(struct ctf_fs_component
*ctf_fs
,
170 const char *stream_basename
, const char *stream_path
)
173 struct bt_private_port
*port
= NULL
;
174 struct ctf_fs_port_data
*port_data
= NULL
;
175 GString
*port_name
= NULL
;
177 port_name
= g_string_new(NULL
);
182 /* Assign the name for the new output port */
183 g_string_assign(port_name
, "");
184 g_string_printf(port_name
, "trace0-stream-%s", stream_basename
);
185 PDBG("Creating one port named `%s` associated with path `%s`\n",
186 port_name
->str
, stream_path
);
188 /* Create output port for this file */
189 port
= bt_private_component_source_add_output_private_port(
190 ctf_fs
->priv_comp
, port_name
->str
);
195 port_data
= g_new0(struct ctf_fs_port_data
, 1);
200 port_data
->path
= g_string_new(stream_path
);
201 if (!port_data
->path
) {
205 ret
= bt_private_port_set_user_data(port
, port_data
);
210 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
219 g_string_free(port_name
, TRUE
);
223 port_data_destroy(port_data
);
228 int create_ports(struct ctf_fs_component
*ctf_fs
)
231 const char *basename
;
232 GError
*error
= NULL
;
234 struct bt_private_port
*def_port
;
235 struct ctf_fs_file
*file
= NULL
;
237 /* Remove default port if needed */
238 def_port
= bt_private_component_source_get_default_output_private_port(
241 bt_private_port_remove_from_component(def_port
);
245 /* Create one output port for each stream file */
246 dir
= g_dir_open(ctf_fs
->trace_path
->str
, 0, &error
);
248 PERR("Cannot open directory `%s`: %s (code %d)\n",
249 ctf_fs
->trace_path
->str
, error
->message
,
254 while ((basename
= g_dir_read_name(dir
))) {
255 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
256 /* Ignore the metadata stream. */
257 PDBG("Ignoring metadata file `%s`\n", basename
);
261 if (basename
[0] == '.') {
262 PDBG("Ignoring hidden file `%s`\n", basename
);
266 /* Create the file. */
267 file
= ctf_fs_file_create(ctf_fs
);
269 PERR("Cannot create stream file object for file `%s`\n",
274 /* Create full path string. */
275 g_string_append_printf(file
->path
, "%s/%s",
276 ctf_fs
->trace_path
->str
, basename
);
277 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
278 PDBG("Ignoring non-regular file `%s`\n", basename
);
279 ctf_fs_file_destroy(file
);
284 ret
= ctf_fs_file_open(ctf_fs
, file
, "rb");
286 PERR("Cannot open stream file `%s`\n", basename
);
290 if (file
->size
== 0) {
291 /* Skip empty stream. */
292 PDBG("Ignoring empty file `%s`\n", basename
);
293 ctf_fs_file_destroy(file
);
298 ret
= create_one_port(ctf_fs
, basename
, file
->path
->str
);
300 PERR("Cannot create output port for file `%s`\n",
305 ctf_fs_file_destroy(file
);
324 ctf_fs_file_destroy(file
);
329 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
330 struct bt_value
*params
)
332 struct ctf_fs_component
*ctf_fs
;
333 struct bt_value
*value
= NULL
;
337 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
343 * We don't need to get a new reference here because as long as
344 * our private ctf_fs_component object exists, the containing
345 * private component should also exist.
347 ctf_fs
->priv_comp
= priv_comp
;
349 /* FIXME: should probably look for a source URI */
350 value
= bt_value_map_get(params
, "path");
351 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
355 ret
= bt_value_string_get(value
, &path
);
360 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
361 if (!ctf_fs
->port_data
) {
365 ctf_fs
->trace_path
= g_string_new(path
);
366 if (!ctf_fs
->trace_path
) {
369 ctf_fs
->error_fp
= stderr
;
370 ctf_fs
->page_size
= (size_t) getpagesize();
372 // FIXME: check error.
373 ctf_fs
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
374 if (!ctf_fs
->metadata
) {
378 ret
= ctf_fs_metadata_set_trace(ctf_fs
);
383 ret
= create_ports(ctf_fs
);
391 ctf_fs_destroy_data(ctf_fs
);
399 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
400 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
402 struct ctf_fs_component
*ctf_fs
;
403 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
406 ctf_fs_debug
= g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
407 ctf_fs
= ctf_fs_create(priv_comp
, params
);
409 ret
= BT_COMPONENT_STATUS_NOMEM
;
413 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
414 if (ret
!= BT_COMPONENT_STATUS_OK
) {
420 (void) bt_private_component_set_user_data(priv_comp
, NULL
);
421 ctf_fs_destroy_data(ctf_fs
);
426 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
427 const char *object
, struct bt_value
*params
)
429 struct bt_value
*results
= NULL
;
430 struct bt_value
*path_value
= NULL
;
431 char *metadata_text
= NULL
;
432 FILE *metadata_fp
= NULL
;
433 GString
*g_metadata_text
= NULL
;
435 if (strcmp(object
, "metadata-info") == 0) {
441 results
= bt_value_map_create();
446 if (!bt_value_is_map(params
)) {
448 "Query parameters is not a map value object\n");
452 path_value
= bt_value_map_get(params
, "path");
453 ret
= bt_value_string_get(path_value
, &path
);
456 "Cannot get `path` string parameter\n");
461 metadata_fp
= ctf_fs_metadata_open_file(path
);
464 "Cannot open trace at path `%s`\n", path
);
468 is_packetized
= ctf_metadata_is_packetized(metadata_fp
, &bo
);
471 ret
= ctf_metadata_packetized_file_to_buf(NULL
,
472 metadata_fp
, (uint8_t **) &metadata_text
, bo
);
475 "Cannot decode packetized metadata file\n");
481 fseek(metadata_fp
, 0, SEEK_END
);
482 filesize
= ftell(metadata_fp
);
484 metadata_text
= malloc(filesize
+ 1);
485 if (!metadata_text
) {
487 "Cannot allocate buffer for metadata text\n");
491 if (fread(metadata_text
, filesize
, 1, metadata_fp
) !=
494 "Cannot read metadata file\n");
498 metadata_text
[filesize
] = '\0';
501 g_metadata_text
= g_string_new(NULL
);
502 if (!g_metadata_text
) {
506 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
507 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
508 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
509 g_string_append(g_metadata_text
, " */\n\n");
512 g_string_append(g_metadata_text
, metadata_text
);
514 ret
= bt_value_map_insert_string(results
, "text",
515 g_metadata_text
->str
);
517 fprintf(stderr
, "Cannot insert metadata text into results\n");
521 ret
= bt_value_map_insert_bool(results
, "is-packetized",
524 fprintf(stderr
, "Cannot insert is packetized into results\n");
528 fprintf(stderr
, "Unknown query object `%s`\n", object
);
541 if (g_metadata_text
) {
542 g_string_free(g_metadata_text
, TRUE
);