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/plugin/plugin-system.h>
30 #include <babeltrace/plugin/notification/iterator.h>
36 #include "data-stream.h"
39 #define PRINT_ERR_STREAM ctf_fs->error_fp
40 #define PRINT_PREFIX "ctf-fs"
43 static bool ctf_fs_debug
;
46 struct bt_notification
*ctf_fs_iterator_get(
47 struct bt_notification_iterator
*iterator
)
49 struct bt_notification
*notification
= NULL
;
50 struct ctf_fs_component
*ctf_fs
;
51 struct bt_component
*component
= bt_notification_iterator_get_component(
58 ctf_fs
= bt_component_get_private_data(component
);
63 notification
= bt_get(ctf_fs
->current_notification
);
70 enum bt_notification_iterator_status
ctf_fs_iterator_next(
71 struct bt_notification_iterator
*iterator
)
73 enum bt_notification_iterator_status ret
;
74 struct bt_notification
*notification
= NULL
;
75 struct ctf_fs_component
*ctf_fs
;
76 struct bt_component
*component
= bt_notification_iterator_get_component(
80 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
84 ctf_fs
= bt_component_get_private_data(component
);
87 ret
= ctf_fs_data_stream_get_next_notification(ctf_fs
, ¬ification
);
88 if (ret
|| !notification
) {
92 bt_put(ctf_fs
->current_notification
);
93 ctf_fs
->current_notification
= notification
;
100 void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator
*ctf_it
)
106 void ctf_fs_iterator_destroy(struct bt_notification_iterator
*it
)
108 void *data
= bt_notification_iterator_get_private_data(it
);
110 ctf_fs_iterator_destroy_data(data
);
114 enum bt_component_status
ctf_fs_iterator_init(struct bt_component
*source
,
115 struct bt_notification_iterator
*it
)
117 struct ctf_fs_iterator
*ctf_it
;
118 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
120 assert(source
&& it
);
121 ctf_it
= g_new0(struct ctf_fs_iterator
, 1);
123 ret
= BT_COMPONENT_STATUS_NOMEM
;
127 ret
= bt_notification_iterator_set_get_cb(it
, ctf_fs_iterator_get
);
132 ret
= bt_notification_iterator_set_next_cb(it
, ctf_fs_iterator_next
);
137 ret
= bt_notification_iterator_set_destroy_cb(it
,
138 ctf_fs_iterator_destroy
);
143 ret
= bt_notification_iterator_set_private_data(it
, ctf_it
);
150 (void) bt_notification_iterator_set_private_data(it
, NULL
);
151 ctf_fs_iterator_destroy_data(ctf_it
);
156 void ctf_fs_destroy_data(struct ctf_fs_component
*component
)
158 if (component
->trace_path
) {
159 g_string_free(component
->trace_path
, TRUE
);
162 ctf_fs_metadata_fini(&component
->metadata
);
163 BT_PUT(component
->current_notification
);
164 if (component
->streams
) {
165 g_ptr_array_free(component
->streams
, TRUE
);
171 void ctf_fs_destroy(struct bt_component
*component
)
173 void *data
= bt_component_get_private_data(component
);
175 ctf_fs_destroy_data(data
);
179 int open_trace_streams(struct ctf_fs_component
*ctf_fs
)
183 GError
*error
= NULL
;
184 GDir
*dir
= g_dir_open(ctf_fs
->trace_path
->str
, 0, &error
);
187 PERR("Cannot open directory \"%s\": %s (code %d)\n",
188 ctf_fs
->trace_path
->str
, error
->message
,
193 while ((name
= g_dir_read_name(dir
))) {
194 struct ctf_fs_file
*file
= NULL
;
195 struct ctf_fs_stream
*stream
= NULL
;
197 if (!strcmp(name
, CTF_FS_METADATA_FILENAME
)) {
198 /* Ignore the metadata stream. */
199 PDBG("Ignoring metadata file \"%s\"\n",
204 if (name
[0] == '.') {
205 PDBG("Ignoring hidden file \"%s\"\n",
210 /* Create the file. */
211 file
= ctf_fs_file_create(ctf_fs
);
213 PERR("Cannot create stream file object\n");
217 /* Create full path string. */
218 g_string_append_printf(file
->path
, "%s/%s",
219 ctf_fs
->trace_path
->str
, name
);
220 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
221 PDBG("Ignoring non-regular file \"%s\"\n", name
);
222 ctf_fs_file_destroy(file
);
227 if (ctf_fs_file_open(ctf_fs
, file
, "rb")) {
228 ctf_fs_file_destroy(file
);
232 /* Create a private stream; file ownership is passed to it. */
233 stream
= ctf_fs_stream_create(ctf_fs
, file
);
235 ctf_fs_file_destroy(file
);
239 g_ptr_array_add(ctf_fs
->streams
, stream
);
257 void stream_destroy(void *stream
)
259 ctf_fs_stream_destroy((struct ctf_fs_stream
*) stream
);
263 struct ctf_fs_component
*ctf_fs_create(struct bt_value
*params
)
265 struct ctf_fs_component
*ctf_fs
;
266 struct bt_value
*value
= NULL
;
268 enum bt_value_status ret
;
270 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
275 /* FIXME: should probably look for a source URI */
276 value
= bt_value_map_get(params
, "path");
277 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
281 ret
= bt_value_string_get(value
, &path
);
282 if (ret
!= BT_VALUE_STATUS_OK
) {
286 ctf_fs
->trace_path
= g_string_new(path
);
287 if (!ctf_fs
->trace_path
) {
291 ctf_fs
->streams
= g_ptr_array_new_with_free_func(stream_destroy
);
292 ctf_fs
->error_fp
= stderr
;
293 ctf_fs
->page_size
= (size_t) getpagesize();
295 // FIXME: check error.
296 ctf_fs_metadata_set_trace(ctf_fs
);
298 ret
= open_trace_streams(ctf_fs
);
305 ctf_fs_destroy_data(ctf_fs
);
313 enum bt_component_status
ctf_fs_init(struct bt_component
*source
,
314 struct bt_value
*params
)
316 struct ctf_fs_component
*ctf_fs
;
317 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
320 ctf_fs_debug
= g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
321 ctf_fs
= ctf_fs_create(params
);
323 ret
= BT_COMPONENT_STATUS_NOMEM
;
327 ret
= bt_component_set_destroy_cb(source
, ctf_fs_destroy
);
328 if (ret
!= BT_COMPONENT_STATUS_OK
) {
332 ret
= bt_component_set_private_data(source
, ctf_fs
);
333 if (ret
!= BT_COMPONENT_STATUS_OK
) {
337 ret
= bt_component_source_set_iterator_init_cb(source
,
338 ctf_fs_iterator_init
);
339 if (ret
!= BT_COMPONENT_STATUS_OK
) {
345 (void) bt_component_set_private_data(source
, NULL
);
346 ctf_fs_destroy_data(ctf_fs
);