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 "common/macros.h"
33 #include <babeltrace2/babeltrace.h>
34 #include "data-stream-file.h"
36 #include "../common/metadata/decoder.h"
39 extern bool ctf_fs_debug
;
42 bt_logging_level log_level
;
45 bt_self_component
*self_comp
;
56 struct ctf_fs_metadata
{
58 struct ctf_metadata_decoder
*decoder
;
61 bt_trace_class
*trace_class
;
63 /* Weak (owned by `decoder` above) */
64 struct ctf_trace_class
*tc
;
72 struct ctf_fs_component
{
73 bt_logging_level log_level
;
75 /* Weak, guaranteed to exist */
76 bt_self_component_source
*self_comp_src
;
79 bt_self_component
*self_comp
;
81 /* Array of struct ctf_fs_port_data *, owned by this */
84 /* Array of struct ctf_fs_trace *, owned by this */
87 struct ctf_fs_metadata_config metadata_config
;
91 bt_logging_level log_level
;
94 bt_self_component
*self_comp
;
97 struct ctf_fs_metadata
*metadata
;
102 /* Array of struct ctf_fs_ds_file_group *, owned by this */
103 GPtrArray
*ds_file_groups
;
111 /* Next automatic stream ID when not provided by packet header */
112 uint64_t next_stream_id
;
115 struct ctf_fs_ds_index_entry
{
116 /* Position, in bytes, of the packet from the beginning of the file. */
119 /* Size of the packet, in bytes. */
120 uint64_t packet_size
;
123 * Extracted from the packet context, relative to the respective fields'
124 * mapped clock classes (in cycles).
126 uint64_t timestamp_begin
, timestamp_end
;
129 * Converted from the packet context, relative to the trace's EPOCH
130 * (in ns since EPOCH).
132 int64_t timestamp_begin_ns
, timestamp_end_ns
;
135 struct ctf_fs_ds_index
{
136 /* Array of pointer to struct ctf_fs_fd_index_entry. */
140 struct ctf_fs_ds_file_group
{
142 * Array of struct ctf_fs_ds_file_info, owned by this.
144 * This is an _ordered_ array of data stream file infos which
145 * belong to this group (a single stream instance).
147 * You can call ctf_fs_ds_file_create() with one of those paths
148 * and the trace IR stream below.
150 GPtrArray
*ds_file_infos
;
153 struct ctf_stream_class
*sc
;
158 /* Stream (instance) ID; -1ULL means none */
161 /* Weak, belongs to component */
162 struct ctf_fs_trace
*ctf_fs_trace
;
165 * Owned by this. May be NULL.
167 * A stream cannot be assumed to be indexed as the indexing might have
168 * been skipped. Moreover, the index's fields may not all be available
169 * depending on the producer (e.g. timestamp_begin/end are not
172 struct ctf_fs_ds_index
*index
;
175 struct ctf_fs_port_data
{
176 /* Weak, belongs to ctf_fs_trace */
177 struct ctf_fs_ds_file_group
*ds_file_group
;
180 struct ctf_fs_component
*ctf_fs
;
183 struct ctf_fs_msg_iter_data
{
184 bt_logging_level log_level
;
187 bt_self_component
*self_comp
;
190 bt_self_message_iterator
*pc_msg_iter
;
192 /* Weak, belongs to ctf_fs_trace */
193 struct ctf_fs_ds_file_group
*ds_file_group
;
196 struct ctf_fs_ds_file
*ds_file
;
198 /* Which file the iterator is _currently_ operating on */
199 size_t ds_file_info_index
;
202 struct bt_msg_iter
*msg_iter
;
206 bt_component_class_init_method_status
ctf_fs_init(
207 bt_self_component_source
*source
,
208 const bt_value
*params
, void *init_method_data
);
211 void ctf_fs_finalize(bt_self_component_source
*component
);
214 bt_component_class_query_method_status
ctf_fs_query(
215 bt_self_component_class_source
*comp_class
,
216 bt_private_query_executor
*priv_query_exec
,
217 const char *object
, const bt_value
*params
,
218 const bt_value
**result
);
221 bt_component_class_message_iterator_init_method_status
ctf_fs_iterator_init(
222 bt_self_message_iterator
*self_msg_iter
,
223 bt_self_component_source
*self_comp
,
224 bt_self_component_port_output
*self_port
);
227 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
);
230 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
231 bt_self_message_iterator
*iterator
,
232 bt_message_array_const msgs
, uint64_t capacity
,
236 bt_component_class_message_iterator_seek_beginning_method_status
ctf_fs_iterator_seek_beginning(
237 bt_self_message_iterator
*message_iterator
);
239 /* Create and initialize a new, empty ctf_fs_component. */
242 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
243 bt_self_component
*self_comp
);
246 * Search recursively under all paths in `paths_value` (an array of strings),
247 * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
248 * `ctf_fs` representing that trace.
252 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source
*self_comp
,
253 struct ctf_fs_component
*ctf_fs
,
254 const bt_value
*paths_value
);
256 /* Free `ctf_fs` and everything it owns. */
259 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
);
262 * Read and validate parameters taken by the src.ctf.fs plugin.
264 * - The mandatory `paths` parameter is returned in `*paths`.
265 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
266 * present, are recorded in the `ctf_fs` structure.
268 * Return true on success, false if any parameter didn't pass validation.
272 bool read_src_fs_parameters(const bt_value
*params
,
273 const bt_value
**paths
, struct ctf_fs_component
*ctf_fs
);
276 * Generate the port name to be used for a given data stream file group.
278 * The result must be freed using g_free by the caller.
282 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
);
284 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */