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 /* Array of struct ctf_fs_port_data *, owned by this */
79 struct ctf_fs_trace
*trace
;
81 struct ctf_fs_metadata_config metadata_config
;
85 bt_logging_level log_level
;
88 * Weak. These are mostly used to generate log messages or to append
89 * error causes. They are mutually exclusive, only one of them must is
92 bt_self_component
*self_comp
;
93 bt_self_component_class
*self_comp_class
;
96 struct ctf_fs_metadata
*metadata
;
101 /* Array of struct ctf_fs_ds_file_group *, owned by this */
102 GPtrArray
*ds_file_groups
;
107 /* Next automatic stream ID when not provided by packet header */
108 uint64_t next_stream_id
;
111 struct ctf_fs_ds_index_entry
{
112 /* Weak, belongs to ctf_fs_ds_file_info. */
115 /* Position, in bytes, of the packet from the beginning of the file. */
118 /* Size of the packet, in bytes. */
119 uint64_t packet_size
;
122 * Extracted from the packet context, relative to the respective fields'
123 * mapped clock classes (in cycles).
125 uint64_t timestamp_begin
, timestamp_end
;
128 * Converted from the packet context, relative to the trace's EPOCH
129 * (in ns since EPOCH).
131 int64_t timestamp_begin_ns
, timestamp_end_ns
;
134 struct ctf_fs_ds_index
{
135 /* Array of pointer to struct ctf_fs_fd_index_entry. */
139 struct ctf_fs_ds_file_group
{
141 * Array of struct ctf_fs_ds_file_info, owned by this.
143 * This is an _ordered_ array of data stream file infos which
144 * belong to this group (a single stream instance).
146 * You can call ctf_fs_ds_file_create() with one of those paths
147 * and the trace IR stream below.
149 GPtrArray
*ds_file_infos
;
152 struct ctf_stream_class
*sc
;
157 /* Stream (instance) ID; -1ULL means none */
160 /* Weak, belongs to component */
161 struct ctf_fs_trace
*ctf_fs_trace
;
164 * Owned by this. May be NULL.
166 * A stream cannot be assumed to be indexed as the indexing might have
167 * been skipped. Moreover, the index's fields may not all be available
168 * depending on the producer (e.g. timestamp_begin/end are not
171 struct ctf_fs_ds_index
*index
;
174 struct ctf_fs_port_data
{
175 /* Weak, belongs to ctf_fs_trace */
176 struct ctf_fs_ds_file_group
*ds_file_group
;
179 struct ctf_fs_component
*ctf_fs
;
182 struct ctf_fs_msg_iter_data
{
183 bt_logging_level log_level
;
186 bt_self_component
*self_comp
;
189 bt_self_message_iterator
*pc_msg_iter
;
191 /* Weak, belongs to ctf_fs_trace */
192 struct ctf_fs_ds_file_group
*ds_file_group
;
195 struct ctf_fs_ds_file
*ds_file
;
197 /* Which file the iterator is _currently_ operating on */
198 size_t ds_file_info_index
;
201 struct bt_msg_iter
*msg_iter
;
205 bt_component_class_initialize_method_status
ctf_fs_init(
206 bt_self_component_source
*source
,
207 bt_self_component_source_configuration
*config
,
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 void *method_data
, const bt_value
**result
);
221 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
222 bt_self_message_iterator
*self_msg_iter
,
223 bt_self_message_iterator_configuration
*config
,
224 bt_self_component_source
*self_comp
,
225 bt_self_component_port_output
*self_port
);
228 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
);
231 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
232 bt_self_message_iterator
*iterator
,
233 bt_message_array_const msgs
, uint64_t capacity
,
237 bt_component_class_message_iterator_seek_beginning_method_status
ctf_fs_iterator_seek_beginning(
238 bt_self_message_iterator
*message_iterator
);
240 /* Create and initialize a new, empty ctf_fs_component. */
243 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
244 bt_self_component
*self_comp
);
247 * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
250 * `paths_value` must be an array of strings,
252 * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
254 * `self_comp` and `self_comp_class` are used for logging, only one of them
259 int ctf_fs_component_create_ctf_fs_trace(
260 struct ctf_fs_component
*ctf_fs
,
261 const bt_value
*paths_value
,
262 const bt_value
*trace_name_value
,
263 bt_self_component
*self_comp
,
264 bt_self_component_class
*self_comp_class
);
266 /* Free `ctf_fs` and everything it owns. */
269 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
);
272 * Read and validate parameters taken by the src.ctf.fs plugin.
274 * - The mandatory `paths` parameter is returned in `*paths`.
275 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
276 * present, are recorded in the `ctf_fs` structure.
277 * - The optional `trace-name` parameter is returned in `*trace_name` if
278 * present, else `*trace_name` is set to NULL.
280 * `self_comp` and `self_comp_class` are used for logging, only one of them
283 * Return true on success, false if any parameter didn't pass validation.
287 bool read_src_fs_parameters(const bt_value
*params
,
288 const bt_value
**paths
,
289 const bt_value
**trace_name
,
290 struct ctf_fs_component
*ctf_fs
,
291 bt_self_component
*self_comp
,
292 bt_self_component_class
*self_comp_class
);
295 * Generate the port name to be used for a given data stream file group.
297 * The result must be freed using g_free by the caller.
301 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
);
303 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */