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 bt_self_component
*self_comp
;
91 struct ctf_fs_metadata
*metadata
;
96 /* Array of struct ctf_fs_ds_file_group *, owned by this */
97 GPtrArray
*ds_file_groups
;
102 /* Next automatic stream ID when not provided by packet header */
103 uint64_t next_stream_id
;
106 struct ctf_fs_ds_index_entry
{
107 /* Weak, belongs to ctf_fs_ds_file_info. */
110 /* Position, in bytes, of the packet from the beginning of the file. */
113 /* Size of the packet, in bytes. */
114 uint64_t packet_size
;
117 * Extracted from the packet context, relative to the respective fields'
118 * mapped clock classes (in cycles).
120 uint64_t timestamp_begin
, timestamp_end
;
123 * Converted from the packet context, relative to the trace's EPOCH
124 * (in ns since EPOCH).
126 int64_t timestamp_begin_ns
, timestamp_end_ns
;
129 struct ctf_fs_ds_index
{
130 /* Array of pointer to struct ctf_fs_fd_index_entry. */
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 trace IR stream below.
144 GPtrArray
*ds_file_infos
;
147 struct ctf_stream_class
*sc
;
152 /* Stream (instance) ID; -1ULL means none */
155 /* Weak, belongs to component */
156 struct ctf_fs_trace
*ctf_fs_trace
;
159 * Owned by this. May be NULL.
161 * A stream cannot be assumed to be indexed as the indexing might have
162 * been skipped. Moreover, the index's fields may not all be available
163 * depending on the producer (e.g. timestamp_begin/end are not
166 struct ctf_fs_ds_index
*index
;
169 struct ctf_fs_port_data
{
170 /* Weak, belongs to ctf_fs_trace */
171 struct ctf_fs_ds_file_group
*ds_file_group
;
174 struct ctf_fs_component
*ctf_fs
;
177 struct ctf_fs_msg_iter_data
{
178 bt_logging_level log_level
;
181 bt_self_component
*self_comp
;
184 bt_self_message_iterator
*pc_msg_iter
;
186 /* Weak, belongs to ctf_fs_trace */
187 struct ctf_fs_ds_file_group
*ds_file_group
;
190 struct ctf_fs_ds_file
*ds_file
;
192 /* Which file the iterator is _currently_ operating on */
193 size_t ds_file_info_index
;
196 struct bt_msg_iter
*msg_iter
;
200 bt_component_class_initialize_method_status
ctf_fs_init(
201 bt_self_component_source
*source
,
202 bt_self_component_source_configuration
*config
,
203 const bt_value
*params
, void *init_method_data
);
206 void ctf_fs_finalize(bt_self_component_source
*component
);
209 bt_component_class_query_method_status
ctf_fs_query(
210 bt_self_component_class_source
*comp_class
,
211 bt_private_query_executor
*priv_query_exec
,
212 const char *object
, const bt_value
*params
,
213 void *method_data
, const bt_value
**result
);
216 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
217 bt_self_message_iterator
*self_msg_iter
,
218 bt_self_message_iterator_configuration
*config
,
219 bt_self_component_source
*self_comp
,
220 bt_self_component_port_output
*self_port
);
223 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
);
226 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
227 bt_self_message_iterator
*iterator
,
228 bt_message_array_const msgs
, uint64_t capacity
,
232 bt_component_class_message_iterator_seek_beginning_method_status
ctf_fs_iterator_seek_beginning(
233 bt_self_message_iterator
*message_iterator
);
235 /* Create and initialize a new, empty ctf_fs_component. */
238 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
239 bt_self_component
*self_comp
);
242 * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
245 * `paths_value` must be an array of strings,
247 * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
249 * `self_comp` and `self_comp_class` are used for logging, only one of them
254 int ctf_fs_component_create_ctf_fs_trace(
255 struct ctf_fs_component
*ctf_fs
,
256 const bt_value
*paths_value
,
257 const bt_value
*trace_name_value
,
258 bt_self_component
*self_comp
,
259 bt_self_component_class
*self_comp_class
);
261 /* Free `ctf_fs` and everything it owns. */
264 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
);
267 * Read and validate parameters taken by the src.ctf.fs plugin.
269 * - The mandatory `paths` parameter is returned in `*paths`.
270 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
271 * present, are recorded in the `ctf_fs` structure.
272 * - The optional `trace-name` parameter is returned in `*trace_name` if
273 * present, else `*trace_name` is set to NULL.
275 * `self_comp` and `self_comp_class` are used for logging, only one of them
278 * Return true on success, false if any parameter didn't pass validation.
282 bool read_src_fs_parameters(const bt_value
*params
,
283 const bt_value
**paths
,
284 const bt_value
**trace_name
,
285 struct ctf_fs_component
*ctf_fs
,
286 bt_self_component
*self_comp
,
287 bt_self_component_class
*self_comp_class
);
290 * Generate the port name to be used for a given data stream file group.
292 * The result must be freed using g_free by the caller.
296 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
);
298 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */