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"
38 extern bool ctf_fs_debug
;
50 struct ctf_fs_metadata
{
52 struct bt_ctf_trace
*trace
;
62 struct ctf_fs_ds_file_info
{
67 struct ctf_fs_ds_file
{
69 struct ctf_fs_file
*file
;
72 struct bt_ctf_stream
*stream
;
75 struct bt_clock_class_priority_map
*cc_prio_map
;
78 struct bt_ctf_notif_iter
*notif_iter
;
80 /* A stream is assumed to be indexed. */
83 /* Max length of chunk to mmap() when updating the current mapping. */
85 /* Length of the current mapping. */
87 /* Length of the current mapping which *exists* in the backing file. */
88 size_t mmap_valid_len
;
89 /* Offset in the file where the current mapping starts. */
92 * Offset, in the current mapping, of the address to return on the next
99 struct ctf_fs_component_options
{
100 int64_t clock_offset
;
101 int64_t clock_offset_ns
;
104 struct ctf_fs_component
{
105 /* Weak, guaranteed to exist */
106 struct bt_private_component
*priv_comp
;
108 /* Array of struct ctf_fs_port_data *, owned by this */
109 GPtrArray
*port_data
;
111 /* Array of struct ctf_fs_trace *, owned by this */
114 struct ctf_fs_component_options options
;
117 struct ctf_fs_trace
{
119 struct ctf_fs_metadata
*metadata
;
122 struct bt_clock_class_priority_map
*cc_prio_map
;
124 /* Array of struct ctf_fs_ds_file_group *, owned by this */
125 GPtrArray
*ds_file_groups
;
134 struct ctf_fs_ds_file_group
{
136 * Array of struct ctf_fs_ds_file_info, owned by this.
138 * This is an _ordered_ array of data stream file infos which
139 * belong to this group (a single stream instance).
141 * You can call ctf_fs_ds_file_create() with one of those paths
142 * and the CTF IR stream below.
144 GPtrArray
*ds_file_infos
;
147 struct bt_ctf_stream
*stream
;
149 /* Weak, belongs to component */
150 struct ctf_fs_trace
*ctf_fs_trace
;
153 struct ctf_fs_port_data
{
154 /* Weak, belongs to ctf_fs_trace */
155 struct ctf_fs_ds_file_group
*ds_file_group
;
158 struct ctf_fs_notif_iter_data
{
159 /* Weak, belongs to ctf_fs_trace */
160 struct ctf_fs_ds_file_group
*ds_file_group
;
163 struct ctf_fs_ds_file
*ds_file
;
165 /* Which file the iterator is _currently_ operating on */
166 size_t ds_file_info_index
;
170 enum bt_component_status
ctf_fs_init(struct bt_private_component
*source
,
171 struct bt_value
*params
, void *init_method_data
);
174 void ctf_fs_finalize(struct bt_private_component
*component
);
177 enum bt_notification_iterator_status
ctf_fs_iterator_init(
178 struct bt_private_notification_iterator
*it
,
179 struct bt_private_port
*port
);
182 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
183 const char *object
, struct bt_value
*params
);
186 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
);
189 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
);
191 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
);
193 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
194 struct bt_private_notification_iterator
*iterator
);
196 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */