1 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
2 #define BABELTRACE_PLUGIN_CTF_FS_H
5 * BabelTrace - CTF on File System Component
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/graph/component.h>
34 #include <babeltrace/graph/clock-class-priority-map.h>
35 #include "data-stream-file.h"
39 extern bool ctf_fs_debug
;
51 struct ctf_fs_metadata
{
53 struct bt_ctf_trace
*trace
;
63 struct ctf_fs_component
{
64 /* Weak, guaranteed to exist */
65 struct bt_private_component
*priv_comp
;
67 /* Array of struct ctf_fs_port_data *, owned by this */
70 /* Array of struct ctf_fs_trace *, owned by this */
73 struct ctf_fs_metadata_config metadata_config
;
78 struct ctf_fs_metadata
*metadata
;
81 struct bt_clock_class_priority_map
*cc_prio_map
;
83 /* Array of struct ctf_fs_ds_file_group *, owned by this */
84 GPtrArray
*ds_file_groups
;
93 struct ctf_fs_ds_file_group
{
95 * Array of struct ctf_fs_ds_file_info, owned by this.
97 * This is an _ordered_ array of data stream file infos which
98 * belong to this group (a single stream instance).
100 * You can call ctf_fs_ds_file_create() with one of those paths
101 * and the CTF IR stream below.
103 GPtrArray
*ds_file_infos
;
106 struct bt_ctf_stream_class
*stream_class
;
109 struct bt_ctf_stream
*stream
;
111 /* Stream (instance) ID; -1ULL means none */
114 /* Weak, belongs to component */
115 struct ctf_fs_trace
*ctf_fs_trace
;
118 struct ctf_fs_port_data
{
119 /* Weak, belongs to ctf_fs_trace */
120 struct ctf_fs_ds_file_group
*ds_file_group
;
123 struct ctf_fs_notif_iter_data
{
124 /* Weak, belongs to ctf_fs_trace */
125 struct ctf_fs_ds_file_group
*ds_file_group
;
128 struct ctf_fs_ds_file
*ds_file
;
130 /* Which file the iterator is _currently_ operating on */
131 size_t ds_file_info_index
;
134 struct bt_ctf_notif_iter
*notif_iter
;
138 enum bt_component_status
ctf_fs_init(struct bt_private_component
*source
,
139 struct bt_value
*params
, void *init_method_data
);
142 void ctf_fs_finalize(struct bt_private_component
*component
);
145 struct bt_component_class_query_return
ctf_fs_query(
146 struct bt_component_class
*comp_class
,
147 struct bt_query_executor
*query_exec
,
148 const char *object
, struct bt_value
*params
);
151 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
152 struct ctf_fs_metadata_config
*config
);
155 void ctf_fs_trace_destroy(struct ctf_fs_trace
*trace
);
158 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
);
161 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
);
164 enum bt_notification_iterator_status
ctf_fs_iterator_init(
165 struct bt_private_notification_iterator
*it
,
166 struct bt_private_port
*port
);
168 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
);
171 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
172 struct bt_private_notification_iterator
*iterator
);
174 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */