ef9cdaa48a88be146c9e4b6beec9e35079958f5c
[babeltrace.git] / src / plugins / ctf / fs-src / fs.h
1 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
2 #define BABELTRACE_PLUGIN_CTF_FS_H
3
4 /*
5 * BabelTrace - CTF on File System Component
6 *
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
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
31 #include <stdbool.h>
32 #include "common/macros.h"
33 #include <babeltrace2/babeltrace.h>
34 #include "data-stream-file.h"
35 #include "metadata.h"
36 #include "../common/metadata/decoder.h"
37
38 BT_HIDDEN
39 extern bool ctf_fs_debug;
40
41 struct ctf_fs_file {
42 bt_logging_level log_level;
43
44 /* Weak */
45 bt_self_component *self_comp;
46
47 /* Owned by this */
48 GString *path;
49
50 /* Owned by this */
51 FILE *fp;
52
53 off_t size;
54 };
55
56 struct ctf_fs_metadata {
57 /* Owned by this */
58 struct ctf_metadata_decoder *decoder;
59
60 /* Owned by this */
61 bt_trace_class *trace_class;
62
63 /* Weak (owned by `decoder` above) */
64 struct ctf_trace_class *tc;
65
66 /* Owned by this */
67 char *text;
68
69 int bo;
70 };
71
72 struct ctf_fs_component {
73 bt_logging_level log_level;
74
75 /* Array of struct ctf_fs_port_data *, owned by this */
76 GPtrArray *port_data;
77
78 /* Owned by this */
79 struct ctf_fs_trace *trace;
80
81 struct ctf_fs_metadata_config metadata_config;
82 };
83
84 struct ctf_fs_trace {
85 bt_logging_level log_level;
86
87 /*
88 * Weak. These are mostly used to generate log messages or to append
89 * error causes. They are mutually exclusive, only one of them must be
90 * set.
91 */
92 bt_self_component *self_comp;
93 bt_self_component_class *self_comp_class;
94
95 /* Owned by this */
96 struct ctf_fs_metadata *metadata;
97
98 /* Owned by this */
99 bt_trace *trace;
100
101 /* Array of struct ctf_fs_ds_file_group *, owned by this */
102 GPtrArray *ds_file_groups;
103
104 /* Owned by this */
105 GString *path;
106
107 /* Next automatic stream ID when not provided by packet header */
108 uint64_t next_stream_id;
109 };
110
111 struct ctf_fs_ds_index_entry {
112 /* Weak, belongs to ctf_fs_ds_file_info. */
113 const char *path;
114
115 /* Position, in bytes, of the packet from the beginning of the file. */
116 uint64_t offset;
117
118 /* Size of the packet, in bytes. */
119 uint64_t packet_size;
120
121 /*
122 * Extracted from the packet context, relative to the respective fields'
123 * mapped clock classes (in cycles).
124 */
125 uint64_t timestamp_begin, timestamp_end;
126
127 /*
128 * Converted from the packet context, relative to the trace's EPOCH
129 * (in ns since EPOCH).
130 */
131 int64_t timestamp_begin_ns, timestamp_end_ns;
132
133 /*
134 * Packet sequence number, or UINT64_MAX if not present in the index.
135 */
136 uint64_t packet_seq_num;
137 };
138
139 struct ctf_fs_ds_index {
140 /* Array of pointer to struct ctf_fs_ds_index_entry. */
141 GPtrArray *entries;
142 };
143
144 struct ctf_fs_ds_file_group {
145 /*
146 * Array of struct ctf_fs_ds_file_info, owned by this.
147 *
148 * This is an _ordered_ array of data stream file infos which
149 * belong to this group (a single stream instance).
150 *
151 * You can call ctf_fs_ds_file_create() with one of those paths
152 * and the trace IR stream below.
153 */
154 GPtrArray *ds_file_infos;
155
156 /* Owned by this */
157 struct ctf_stream_class *sc;
158
159 /* Owned by this */
160 bt_stream *stream;
161
162 /* Stream (instance) ID; -1ULL means none */
163 uint64_t stream_id;
164
165 /* Weak, belongs to component */
166 struct ctf_fs_trace *ctf_fs_trace;
167
168 /*
169 * Owned by this.
170 */
171 struct ctf_fs_ds_index *index;
172 };
173
174 struct ctf_fs_port_data {
175 /* Weak, belongs to ctf_fs_trace */
176 struct ctf_fs_ds_file_group *ds_file_group;
177
178 /* Weak */
179 struct ctf_fs_component *ctf_fs;
180 };
181
182 struct ctf_fs_msg_iter_data {
183 bt_logging_level log_level;
184
185 /* Weak */
186 bt_self_component *self_comp;
187
188 /* Weak */
189 bt_self_message_iterator *self_msg_iter;
190
191 /* Weak, belongs to ctf_fs_trace */
192 struct ctf_fs_ds_file_group *ds_file_group;
193
194 /* Owned by this */
195 struct ctf_msg_iter *msg_iter;
196
197 /*
198 * Saved error. If we hit an error in the _next method, but have some
199 * messages ready to return, we save the error here and return it on
200 * the next _next call.
201 */
202 bt_message_iterator_class_next_method_status next_saved_status;
203 const struct bt_error *next_saved_error;
204
205 struct ctf_fs_ds_group_medops_data *msg_iter_medops_data;
206 };
207
208 BT_HIDDEN
209 bt_component_class_initialize_method_status ctf_fs_init(
210 bt_self_component_source *source,
211 bt_self_component_source_configuration *config,
212 const bt_value *params, void *init_method_data);
213
214 BT_HIDDEN
215 void ctf_fs_finalize(bt_self_component_source *component);
216
217 BT_HIDDEN
218 bt_component_class_query_method_status ctf_fs_query(
219 bt_self_component_class_source *comp_class,
220 bt_private_query_executor *priv_query_exec,
221 const char *object, const bt_value *params,
222 void *method_data, const bt_value **result);
223
224 BT_HIDDEN
225 bt_message_iterator_class_initialize_method_status ctf_fs_iterator_init(
226 bt_self_message_iterator *self_msg_iter,
227 bt_self_message_iterator_configuration *config,
228 bt_self_component_port_output *self_port);
229
230 BT_HIDDEN
231 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
232
233 BT_HIDDEN
234 bt_message_iterator_class_next_method_status ctf_fs_iterator_next(
235 bt_self_message_iterator *iterator,
236 bt_message_array_const msgs, uint64_t capacity,
237 uint64_t *count);
238
239 BT_HIDDEN
240 bt_message_iterator_class_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
241 bt_self_message_iterator *message_iterator);
242
243 /* Create and initialize a new, empty ctf_fs_component. */
244
245 BT_HIDDEN
246 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
247 bt_self_component *self_comp);
248
249 /*
250 * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
251 * the same UUID.
252 *
253 * `paths_value` must be an array of strings,
254 *
255 * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
256 *
257 * `self_comp` and `self_comp_class` are used for logging, only one of them
258 * should be set.
259 */
260
261 BT_HIDDEN
262 int ctf_fs_component_create_ctf_fs_trace(
263 struct ctf_fs_component *ctf_fs,
264 const bt_value *paths_value,
265 const bt_value *trace_name_value,
266 bt_self_component *self_comp,
267 bt_self_component_class *self_comp_class);
268
269 /* Free `ctf_fs` and everything it owns. */
270
271 BT_HIDDEN
272 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
273
274 /*
275 * Read and validate parameters taken by the src.ctf.fs plugin.
276 *
277 * - The mandatory `paths` parameter is returned in `*paths`.
278 * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
279 * present, are recorded in the `ctf_fs` structure.
280 * - The optional `trace-name` parameter is returned in `*trace_name` if
281 * present, else `*trace_name` is set to NULL.
282 *
283 * `self_comp` and `self_comp_class` are used for logging, only one of them
284 * should be set.
285 *
286 * Return true on success, false if any parameter didn't pass validation.
287 */
288
289 BT_HIDDEN
290 bool read_src_fs_parameters(const bt_value *params,
291 const bt_value **paths,
292 const bt_value **trace_name,
293 struct ctf_fs_component *ctf_fs,
294 bt_self_component *self_comp,
295 bt_self_component_class *self_comp_class);
296
297 /*
298 * Generate the port name to be used for a given data stream file group.
299 *
300 * The result must be freed using g_free by the caller.
301 */
302
303 BT_HIDDEN
304 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
305
306 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */
This page took 0.037841 seconds and 3 git commands to generate.