lib: pass config object to message iterator init method, add can seek forward property
[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
1a9f7075
PP
66 /* Owned by this */
67 char *text;
68
56a1cced 69 int bo;
56a1cced
JG
70};
71
ea0b4b9e 72struct ctf_fs_component {
98903a3e
PP
73 bt_logging_level log_level;
74
1a9f7075
PP
75 /* Array of struct ctf_fs_port_data *, owned by this */
76 GPtrArray *port_data;
77
a0cd55ad
SM
78 /* Owned by this */
79 struct ctf_fs_trace *trace;
1a9f7075 80
a2a54545 81 struct ctf_fs_metadata_config metadata_config;
1a9f7075
PP
82};
83
84struct ctf_fs_trace {
98903a3e
PP
85 bt_logging_level log_level;
86
4c65a157
PP
87 /* Weak */
88 bt_self_component *self_comp;
89
1a9f7075 90 /* Owned by this */
5b29e799 91 struct ctf_fs_metadata *metadata;
1a9f7075 92
862ca4ed 93 /* Owned by this */
b19ff26f 94 bt_trace *trace;
862ca4ed 95
94cf822e
PP
96 /* Array of struct ctf_fs_ds_file_group *, owned by this */
97 GPtrArray *ds_file_groups;
98
1a9f7075
PP
99 /* Owned by this */
100 GString *path;
101
3dca2276
PP
102 /* Next automatic stream ID when not provided by packet header */
103 uint64_t next_stream_id;
1a9f7075
PP
104};
105
7ed5243a 106struct ctf_fs_ds_index_entry {
bf012bde
FD
107 /* Weak, belongs to ctf_fs_ds_file_info. */
108 const char *path;
109
7ed5243a
FD
110 /* Position, in bytes, of the packet from the beginning of the file. */
111 uint64_t offset;
112
113 /* Size of the packet, in bytes. */
114 uint64_t packet_size;
115
116 /*
117 * Extracted from the packet context, relative to the respective fields'
118 * mapped clock classes (in cycles).
119 */
120 uint64_t timestamp_begin, timestamp_end;
121
122 /*
123 * Converted from the packet context, relative to the trace's EPOCH
124 * (in ns since EPOCH).
125 */
126 int64_t timestamp_begin_ns, timestamp_end_ns;
127};
128
129struct ctf_fs_ds_index {
130 /* Array of pointer to struct ctf_fs_fd_index_entry. */
131 GPtrArray *entries;
132};
133
94cf822e
PP
134struct ctf_fs_ds_file_group {
135 /*
136 * Array of struct ctf_fs_ds_file_info, owned by this.
137 *
138 * This is an _ordered_ array of data stream file infos which
139 * belong to this group (a single stream instance).
140 *
141 * You can call ctf_fs_ds_file_create() with one of those paths
56e18c4c 142 * and the trace IR stream below.
94cf822e
PP
143 */
144 GPtrArray *ds_file_infos;
145
547eacf1 146 /* Owned by this */
60363f2f 147 struct ctf_stream_class *sc;
547eacf1 148
1a9f7075 149 /* Owned by this */
b19ff26f 150 bt_stream *stream;
1a9f7075 151
547eacf1
PP
152 /* Stream (instance) ID; -1ULL means none */
153 uint64_t stream_id;
154
94cf822e 155 /* Weak, belongs to component */
1a9f7075 156 struct ctf_fs_trace *ctf_fs_trace;
7ed5243a
FD
157
158 /*
159 * Owned by this. May be NULL.
160 *
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
164 * mandatory).
7ed5243a
FD
165 */
166 struct ctf_fs_ds_index *index;
ea0b4b9e
JG
167};
168
94cf822e
PP
169struct ctf_fs_port_data {
170 /* Weak, belongs to ctf_fs_trace */
171 struct ctf_fs_ds_file_group *ds_file_group;
5c563278
PP
172
173 /* Weak */
174 struct ctf_fs_component *ctf_fs;
94cf822e
PP
175};
176
d6e69534 177struct ctf_fs_msg_iter_data {
98903a3e
PP
178 bt_logging_level log_level;
179
4c65a157
PP
180 /* Weak */
181 bt_self_component *self_comp;
182
5c563278 183 /* Weak */
d6e69534 184 bt_self_message_iterator *pc_msg_iter;
5c563278 185
94cf822e
PP
186 /* Weak, belongs to ctf_fs_trace */
187 struct ctf_fs_ds_file_group *ds_file_group;
188
189 /* Owned by this */
190 struct ctf_fs_ds_file *ds_file;
191
192 /* Which file the iterator is _currently_ operating on */
193 size_t ds_file_info_index;
6de92955
PP
194
195 /* Owned by this */
d6e69534 196 struct bt_msg_iter *msg_iter;
94cf822e
PP
197};
198
f3bc2010 199BT_HIDDEN
d24d5663 200bt_component_class_init_method_status ctf_fs_init(
b19ff26f 201 bt_self_component_source *source,
59225a3e 202 bt_self_component_source_configuration *config,
b19ff26f 203 const bt_value *params, void *init_method_data);
490db841 204
d3e4dcd8 205BT_HIDDEN
b19ff26f 206void ctf_fs_finalize(bt_self_component_source *component);
d3e4dcd8 207
55314f2a 208BT_HIDDEN
d24d5663 209bt_component_class_query_method_status ctf_fs_query(
b19ff26f 210 bt_self_component_class_source *comp_class,
3c729b9a 211 bt_private_query_executor *priv_query_exec,
b19ff26f 212 const char *object, const bt_value *params,
7c14d641 213 void *method_data, const bt_value **result);
55314f2a 214
97ade20b 215BT_HIDDEN
d24d5663 216bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
d6e69534 217 bt_self_message_iterator *self_msg_iter,
8d8b141d 218 bt_self_message_iterator_configuration *config,
b19ff26f
PP
219 bt_self_component_source *self_comp,
220 bt_self_component_port_output *self_port);
d94d92ac 221
97ade20b 222BT_HIDDEN
d6e69534 223void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
d3eb6e8f 224
97ade20b 225BT_HIDDEN
d24d5663 226bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
d6e69534
PP
227 bt_self_message_iterator *iterator,
228 bt_message_array_const msgs, uint64_t capacity,
d4393e08 229 uint64_t *count);
d3eb6e8f 230
6a9bb5e9 231BT_HIDDEN
d24d5663 232bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
6a9bb5e9
PP
233 bt_self_message_iterator *message_iterator);
234
f280892e
SM
235/* Create and initialize a new, empty ctf_fs_component. */
236
237BT_HIDDEN
4c65a157
PP
238struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
239 bt_self_component *self_comp);
f280892e
SM
240
241/*
a0cd55ad
SM
242 * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
243 * the same UUID.
244 *
245 * `paths_value` must be an array of strings,
246 *
247 * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
d23b766e
SM
248 *
249 * `self_comp` and `self_comp_class` are used for logging, only one of them
250 * should be set.
f280892e
SM
251 */
252
253BT_HIDDEN
a0cd55ad 254int ctf_fs_component_create_ctf_fs_trace(
f280892e 255 struct ctf_fs_component *ctf_fs,
d23b766e 256 const bt_value *paths_value,
005d49d6 257 const bt_value *trace_name_value,
d23b766e
SM
258 bt_self_component *self_comp,
259 bt_self_component_class *self_comp_class);
f280892e
SM
260
261/* Free `ctf_fs` and everything it owns. */
262
263BT_HIDDEN
264void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
265
d907165c
SM
266/*
267 * Read and validate parameters taken by the src.ctf.fs plugin.
268 *
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.
005d49d6
SM
272 * - The optional `trace-name` parameter is returned in `*trace_name` if
273 * present, else `*trace_name` is set to NULL.
d907165c 274 *
d23b766e
SM
275 * `self_comp` and `self_comp_class` are used for logging, only one of them
276 * should be set.
277 *
d907165c
SM
278 * Return true on success, false if any parameter didn't pass validation.
279 */
f280892e
SM
280
281BT_HIDDEN
d907165c 282bool read_src_fs_parameters(const bt_value *params,
005d49d6
SM
283 const bt_value **paths,
284 const bt_value **trace_name,
285 struct ctf_fs_component *ctf_fs,
d23b766e
SM
286 bt_self_component *self_comp,
287 bt_self_component_class *self_comp_class);
f280892e 288
a38d7650
SM
289/*
290 * Generate the port name to be used for a given data stream file group.
291 *
292 * The result must be freed using g_free by the caller.
293 */
294
295BT_HIDDEN
296gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
297
541b0a11 298#endif /* BABELTRACE_PLUGIN_CTF_FS_H */
This page took 0.072738 seconds and 4 git commands to generate.