lib: strictly type function return status enumerations
[babeltrace.git] / src / plugins / ctf / fs-src / fs.h
CommitLineData
541b0a11
JG
1#ifndef BABELTRACE_PLUGIN_CTF_FS_H
2#define BABELTRACE_PLUGIN_CTF_FS_H
490db841
JG
3
4/*
6a29d9fd 5 * BabelTrace - CTF on File System Component
490db841 6 *
f3bc2010 7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
56a1cced 8 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
490db841
JG
9 *
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 *
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:
18 *
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
21 *
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
28 * SOFTWARE.
29 */
30
c55a9f58 31#include <stdbool.h>
91d81473 32#include "common/macros.h"
3fadfbc0 33#include <babeltrace2/babeltrace.h>
94cf822e 34#include "data-stream-file.h"
97ade20b 35#include "metadata.h"
44c440bc 36#include "../common/metadata/decoder.h"
490db841 37
78bb6992
MD
38BT_HIDDEN
39extern bool ctf_fs_debug;
56a1cced
JG
40
41struct ctf_fs_file {
98903a3e
PP
42 bt_logging_level log_level;
43
4c65a157
PP
44 /* Weak */
45 bt_self_component *self_comp;
46
1a9f7075 47 /* Owned by this */
56a1cced 48 GString *path;
1a9f7075
PP
49
50 /* Owned by this */
56a1cced 51 FILE *fp;
1a9f7075 52
56a1cced
JG
53 off_t size;
54};
55
56struct ctf_fs_metadata {
44c440bc
PP
57 /* Owned by this */
58 struct ctf_metadata_decoder *decoder;
59
1a9f7075 60 /* Owned by this */
b19ff26f 61 bt_trace_class *trace_class;
1a9f7075 62
44c440bc
PP
63 /* Weak (owned by `decoder` above) */
64 struct ctf_trace_class *tc;
65
66 /* Owned by this */
67
1a9f7075
PP
68 /* Owned by this */
69 char *text;
70
56a1cced 71 int bo;
56a1cced
JG
72};
73
ea0b4b9e 74struct ctf_fs_component {
98903a3e
PP
75 bt_logging_level log_level;
76
94cf822e 77 /* Weak, guaranteed to exist */
4c65a157
PP
78 bt_self_component_source *self_comp_src;
79
80 /* Weak */
81 bt_self_component *self_comp;
1a9f7075
PP
82
83 /* Array of struct ctf_fs_port_data *, owned by this */
84 GPtrArray *port_data;
85
86 /* Array of struct ctf_fs_trace *, owned by this */
87 GPtrArray *traces;
88
a2a54545 89 struct ctf_fs_metadata_config metadata_config;
1a9f7075
PP
90};
91
92struct ctf_fs_trace {
98903a3e
PP
93 bt_logging_level log_level;
94
4c65a157
PP
95 /* Weak */
96 bt_self_component *self_comp;
97
1a9f7075 98 /* Owned by this */
5b29e799 99 struct ctf_fs_metadata *metadata;
1a9f7075 100
862ca4ed 101 /* Owned by this */
b19ff26f 102 bt_trace *trace;
862ca4ed 103
94cf822e
PP
104 /* Array of struct ctf_fs_ds_file_group *, owned by this */
105 GPtrArray *ds_file_groups;
106
1a9f7075
PP
107 /* Owned by this */
108 GString *path;
109
110 /* Owned by this */
111 GString *name;
3dca2276
PP
112
113 /* Next automatic stream ID when not provided by packet header */
114 uint64_t next_stream_id;
1a9f7075
PP
115};
116
7ed5243a
FD
117struct ctf_fs_ds_index_entry {
118 /* Position, in bytes, of the packet from the beginning of the file. */
119 uint64_t offset;
120
121 /* Size of the packet, in bytes. */
122 uint64_t packet_size;
123
124 /*
125 * Extracted from the packet context, relative to the respective fields'
126 * mapped clock classes (in cycles).
127 */
128 uint64_t timestamp_begin, timestamp_end;
129
130 /*
131 * Converted from the packet context, relative to the trace's EPOCH
132 * (in ns since EPOCH).
133 */
134 int64_t timestamp_begin_ns, timestamp_end_ns;
135};
136
137struct ctf_fs_ds_index {
138 /* Array of pointer to struct ctf_fs_fd_index_entry. */
139 GPtrArray *entries;
140};
141
94cf822e
PP
142struct ctf_fs_ds_file_group {
143 /*
144 * Array of struct ctf_fs_ds_file_info, owned by this.
145 *
146 * This is an _ordered_ array of data stream file infos which
147 * belong to this group (a single stream instance).
148 *
149 * You can call ctf_fs_ds_file_create() with one of those paths
56e18c4c 150 * and the trace IR stream below.
94cf822e
PP
151 */
152 GPtrArray *ds_file_infos;
153
547eacf1 154 /* Owned by this */
60363f2f 155 struct ctf_stream_class *sc;
547eacf1 156
1a9f7075 157 /* Owned by this */
b19ff26f 158 bt_stream *stream;
1a9f7075 159
547eacf1
PP
160 /* Stream (instance) ID; -1ULL means none */
161 uint64_t stream_id;
162
94cf822e 163 /* Weak, belongs to component */
1a9f7075 164 struct ctf_fs_trace *ctf_fs_trace;
7ed5243a
FD
165
166 /*
167 * Owned by this. May be NULL.
168 *
169 * A stream cannot be assumed to be indexed as the indexing might have
170 * been skipped. Moreover, the index's fields may not all be available
171 * depending on the producer (e.g. timestamp_begin/end are not
172 * mandatory).
7ed5243a
FD
173 */
174 struct ctf_fs_ds_index *index;
ea0b4b9e
JG
175};
176
94cf822e
PP
177struct ctf_fs_port_data {
178 /* Weak, belongs to ctf_fs_trace */
179 struct ctf_fs_ds_file_group *ds_file_group;
5c563278
PP
180
181 /* Weak */
182 struct ctf_fs_component *ctf_fs;
94cf822e
PP
183};
184
d6e69534 185struct ctf_fs_msg_iter_data {
98903a3e
PP
186 bt_logging_level log_level;
187
4c65a157
PP
188 /* Weak */
189 bt_self_component *self_comp;
190
5c563278 191 /* Weak */
d6e69534 192 bt_self_message_iterator *pc_msg_iter;
5c563278 193
94cf822e
PP
194 /* Weak, belongs to ctf_fs_trace */
195 struct ctf_fs_ds_file_group *ds_file_group;
196
197 /* Owned by this */
198 struct ctf_fs_ds_file *ds_file;
199
200 /* Which file the iterator is _currently_ operating on */
201 size_t ds_file_info_index;
6de92955
PP
202
203 /* Owned by this */
d6e69534 204 struct bt_msg_iter *msg_iter;
94cf822e
PP
205};
206
f3bc2010 207BT_HIDDEN
d24d5663 208bt_component_class_init_method_status ctf_fs_init(
b19ff26f
PP
209 bt_self_component_source *source,
210 const bt_value *params, void *init_method_data);
490db841 211
d3e4dcd8 212BT_HIDDEN
b19ff26f 213void ctf_fs_finalize(bt_self_component_source *component);
d3e4dcd8 214
55314f2a 215BT_HIDDEN
d24d5663 216bt_component_class_query_method_status ctf_fs_query(
b19ff26f
PP
217 bt_self_component_class_source *comp_class,
218 const bt_query_executor *query_exec,
219 const char *object, const bt_value *params,
f4e38e70 220 bt_logging_level log_level,
b19ff26f 221 const bt_value **result);
55314f2a 222
97ade20b 223BT_HIDDEN
d24d5663 224bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
d6e69534 225 bt_self_message_iterator *self_msg_iter,
b19ff26f
PP
226 bt_self_component_source *self_comp,
227 bt_self_component_port_output *self_port);
d94d92ac 228
97ade20b 229BT_HIDDEN
d6e69534 230void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
d3eb6e8f 231
97ade20b 232BT_HIDDEN
d24d5663 233bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
d6e69534
PP
234 bt_self_message_iterator *iterator,
235 bt_message_array_const msgs, uint64_t capacity,
d4393e08 236 uint64_t *count);
d3eb6e8f 237
6a9bb5e9 238BT_HIDDEN
d24d5663 239bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
6a9bb5e9
PP
240 bt_self_message_iterator *message_iterator);
241
f280892e
SM
242/* Create and initialize a new, empty ctf_fs_component. */
243
244BT_HIDDEN
4c65a157
PP
245struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
246 bt_self_component *self_comp);
f280892e
SM
247
248/*
249 * Search recursively under all paths in `paths_value` (an array of strings),
250 * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
251 * `ctf_fs` representing that trace.
252 */
253
254BT_HIDDEN
255int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
256 struct ctf_fs_component *ctf_fs,
257 const bt_value *paths_value);
258
259/* Free `ctf_fs` and everything it owns. */
260
261BT_HIDDEN
262void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
263
d907165c
SM
264/*
265 * Read and validate parameters taken by the src.ctf.fs plugin.
266 *
267 * - The mandatory `paths` parameter is returned in `*paths`.
268 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
269 * present, are recorded in the `ctf_fs` structure.
270 *
271 * Return true on success, false if any parameter didn't pass validation.
272 */
f280892e
SM
273
274BT_HIDDEN
d907165c
SM
275bool read_src_fs_parameters(const bt_value *params,
276 const bt_value **paths, struct ctf_fs_component *ctf_fs);
f280892e 277
a38d7650
SM
278/*
279 * Generate the port name to be used for a given data stream file group.
280 *
281 * The result must be freed using g_free by the caller.
282 */
283
284BT_HIDDEN
285gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
286
541b0a11 287#endif /* BABELTRACE_PLUGIN_CTF_FS_H */
This page took 0.059408 seconds and 4 git commands to generate.