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
;
51 struct ctf_fs_metadata
{
53 struct ctf_metadata_decoder
*decoder
;
56 bt_trace_class
*trace_class
;
58 /* Weak (owned by `decoder` above) */
59 struct ctf_trace_class
*tc
;
69 struct ctf_fs_component
{
70 /* Weak, guaranteed to exist */
71 bt_self_component_source
*self_comp
;
73 /* Array of struct ctf_fs_port_data *, owned by this */
76 /* Array of struct ctf_fs_trace *, owned by this */
79 struct ctf_fs_metadata_config metadata_config
;
84 struct ctf_fs_metadata
*metadata
;
89 /* Array of struct ctf_fs_ds_file_group *, owned by this */
90 GPtrArray
*ds_file_groups
;
98 /* Next automatic stream ID when not provided by packet header */
99 uint64_t next_stream_id
;
102 struct ctf_fs_ds_index_entry
{
103 /* Position, in bytes, of the packet from the beginning of the file. */
106 /* Size of the packet, in bytes. */
107 uint64_t packet_size
;
110 * Extracted from the packet context, relative to the respective fields'
111 * mapped clock classes (in cycles).
113 uint64_t timestamp_begin
, timestamp_end
;
116 * Converted from the packet context, relative to the trace's EPOCH
117 * (in ns since EPOCH).
119 int64_t timestamp_begin_ns
, timestamp_end_ns
;
122 struct ctf_fs_ds_index
{
123 /* Array of pointer to struct ctf_fs_fd_index_entry. */
127 struct ctf_fs_ds_file_group
{
129 * Array of struct ctf_fs_ds_file_info, owned by this.
131 * This is an _ordered_ array of data stream file infos which
132 * belong to this group (a single stream instance).
134 * You can call ctf_fs_ds_file_create() with one of those paths
135 * and the trace IR stream below.
137 GPtrArray
*ds_file_infos
;
140 struct ctf_stream_class
*sc
;
145 /* Stream (instance) ID; -1ULL means none */
148 /* Weak, belongs to component */
149 struct ctf_fs_trace
*ctf_fs_trace
;
152 * Owned by this. May be NULL.
154 * A stream cannot be assumed to be indexed as the indexing might have
155 * been skipped. Moreover, the index's fields may not all be available
156 * depending on the producer (e.g. timestamp_begin/end are not
159 struct ctf_fs_ds_index
*index
;
162 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_self_message_iterator
*pc_msg_iter
;
174 /* Weak, belongs to ctf_fs_trace */
175 struct ctf_fs_ds_file_group
*ds_file_group
;
178 struct ctf_fs_ds_file
*ds_file
;
180 /* Which file the iterator is _currently_ operating on */
181 size_t ds_file_info_index
;
184 struct bt_msg_iter
*msg_iter
;
188 bt_self_component_status
ctf_fs_init(
189 bt_self_component_source
*source
,
190 const bt_value
*params
, void *init_method_data
);
193 void ctf_fs_finalize(bt_self_component_source
*component
);
196 bt_query_status
ctf_fs_query(
197 bt_self_component_class_source
*comp_class
,
198 const bt_query_executor
*query_exec
,
199 const char *object
, const bt_value
*params
,
200 const bt_value
**result
);
203 bt_self_message_iterator_status
ctf_fs_iterator_init(
204 bt_self_message_iterator
*self_msg_iter
,
205 bt_self_component_source
*self_comp
,
206 bt_self_component_port_output
*self_port
);
209 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
);
212 bt_self_message_iterator_status
ctf_fs_iterator_next(
213 bt_self_message_iterator
*iterator
,
214 bt_message_array_const msgs
, uint64_t capacity
,
218 bt_self_message_iterator_status
ctf_fs_iterator_seek_beginning(
219 bt_self_message_iterator
*message_iterator
);
221 /* Create and initialize a new, empty ctf_fs_component. */
224 struct ctf_fs_component
*ctf_fs_component_create(void);
227 * Search recursively under all paths in `paths_value` (an array of strings),
228 * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
229 * `ctf_fs` representing that trace.
233 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source
*self_comp
,
234 struct ctf_fs_component
*ctf_fs
,
235 const bt_value
*paths_value
);
237 /* Free `ctf_fs` and everything it owns. */
240 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
);
243 * Read and validate parameters taken by the src.ctf.fs plugin.
245 * - The mandatory `paths` parameter is returned in `*paths`.
246 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
247 * present, are recorded in the `ctf_fs` structure.
249 * Return true on success, false if any parameter didn't pass validation.
253 bool read_src_fs_parameters(const bt_value
*params
,
254 const bt_value
**paths
, struct ctf_fs_component
*ctf_fs
);
257 * Generate the port name to be used for a given data stream file group.
259 * The result must be freed using g_free by the caller.
263 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
);
265 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */