2 * SPDX-License-Identifier: MIT
4 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
7 * BabelTrace - CTF on File System Component
10 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
11 #define BABELTRACE_PLUGIN_CTF_FS_H
15 #include <babeltrace2/babeltrace.h>
17 #include "metadata.hpp"
19 extern bool ctf_fs_debug;
23 bt_logging_level log_level;
26 bt_self_component *self_comp;
37 struct ctf_fs_metadata
40 struct ctf_metadata_decoder *decoder;
43 bt_trace_class *trace_class;
45 /* Weak (owned by `decoder` above) */
46 struct ctf_trace_class *tc;
54 struct ctf_fs_component
56 bt_logging_level log_level;
58 /* Array of struct ctf_fs_port_data *, owned by this */
62 struct ctf_fs_trace *trace;
64 struct ctf_fs_metadata_config metadata_config;
69 bt_logging_level log_level;
72 * Weak. These are mostly used to generate log messages or to append
73 * error causes. They are mutually exclusive, only one of them must be
76 bt_self_component *self_comp;
77 bt_self_component_class *self_comp_class;
80 struct ctf_fs_metadata *metadata;
85 /* Array of struct ctf_fs_ds_file_group *, owned by this */
86 GPtrArray *ds_file_groups;
91 /* Next automatic stream ID when not provided by packet header */
92 uint64_t next_stream_id;
95 struct ctf_fs_ds_index_entry
97 /* Weak, belongs to ctf_fs_ds_file_info. */
100 /* Position, in bytes, of the packet from the beginning of the file. */
103 /* Size of the packet, in bytes. */
104 uint64_t packet_size;
107 * Extracted from the packet context, relative to the respective fields'
108 * mapped clock classes (in cycles).
110 uint64_t timestamp_begin, timestamp_end;
113 * Converted from the packet context, relative to the trace's EPOCH
114 * (in ns since EPOCH).
116 int64_t timestamp_begin_ns, timestamp_end_ns;
119 * Packet sequence number, or UINT64_MAX if not present in the index.
121 uint64_t packet_seq_num;
124 struct ctf_fs_ds_index
126 /* Array of pointer to struct ctf_fs_ds_index_entry. */
130 struct ctf_fs_ds_file_group
133 * Array of struct ctf_fs_ds_file_info, owned by this.
135 * This is an _ordered_ array of data stream file infos which
136 * belong to this group (a single stream instance).
138 * You can call ctf_fs_ds_file_create() with one of those paths
139 * and the trace IR stream below.
141 GPtrArray *ds_file_infos;
144 struct ctf_stream_class *sc;
149 /* Stream (instance) ID; -1ULL means none */
152 /* Weak, belongs to component */
153 struct ctf_fs_trace *ctf_fs_trace;
158 struct ctf_fs_ds_index *index;
161 struct ctf_fs_port_data
163 /* Weak, belongs to ctf_fs_trace */
164 struct ctf_fs_ds_file_group *ds_file_group;
167 struct ctf_fs_component *ctf_fs;
170 struct ctf_fs_msg_iter_data
172 bt_logging_level log_level;
175 bt_self_component *self_comp;
178 bt_self_message_iterator *self_msg_iter;
180 /* Weak, belongs to ctf_fs_trace */
181 struct ctf_fs_ds_file_group *ds_file_group;
184 struct ctf_msg_iter *msg_iter;
187 * Saved error. If we hit an error in the _next method, but have some
188 * messages ready to return, we save the error here and return it on
189 * the next _next call.
191 bt_message_iterator_class_next_method_status next_saved_status;
192 const struct bt_error *next_saved_error;
194 struct ctf_fs_ds_group_medops_data *msg_iter_medops_data;
197 bt_component_class_initialize_method_status
198 ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config,
199 const bt_value *params, void *init_method_data);
201 void ctf_fs_finalize(bt_self_component_source *component);
203 bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class,
204 bt_private_query_executor *priv_query_exec,
205 const char *object, const bt_value *params,
206 void *method_data, const bt_value **result);
208 bt_message_iterator_class_initialize_method_status
209 ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter,
210 bt_self_message_iterator_configuration *config,
211 bt_self_component_port_output *self_port);
213 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
215 bt_message_iterator_class_next_method_status
216 ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
217 uint64_t capacity, uint64_t *count);
219 bt_message_iterator_class_seek_beginning_method_status
220 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
222 /* Create and initialize a new, empty ctf_fs_component. */
224 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level);
227 * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
230 * `paths_value` must be an array of strings,
232 * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
234 * `self_comp` and `self_comp_class` are used for logging, only one of them
238 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
239 const bt_value *paths_value,
240 const bt_value *trace_name_value,
241 bt_self_component *self_comp,
242 bt_self_component_class *self_comp_class);
244 /* Free `ctf_fs` and everything it owns. */
246 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
249 * Read and validate parameters taken by the src.ctf.fs plugin.
251 * - The mandatory `paths` parameter is returned in `*paths`.
252 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
253 * present, are recorded in the `ctf_fs` structure.
254 * - The optional `trace-name` parameter is returned in `*trace_name` if
255 * present, else `*trace_name` is set to NULL.
257 * `self_comp` and `self_comp_class` are used for logging, only one of them
260 * Return true on success, false if any parameter didn't pass validation.
263 bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
264 const bt_value **trace_name, struct ctf_fs_component *ctf_fs,
265 bt_self_component *self_comp, bt_self_component_class *self_comp_class);
268 * Generate the port name to be used for a given data stream file group.
270 * The result must be freed using g_free by the caller.
273 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
275 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */