Commit | Line | Data |
---|---|---|
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> |
85e7137b | 32 | #include "common/macros.h" |
71c5da58 | 33 | #include <babeltrace2/babeltrace.h> |
94cf822e | 34 | #include "data-stream-file.h" |
97ade20b | 35 | #include "metadata.h" |
7b33a0e0 | 36 | #include "../common/metadata/decoder.h" |
490db841 | 37 | |
78bb6992 MD |
38 | BT_HIDDEN |
39 | extern bool ctf_fs_debug; | |
56a1cced JG |
40 | |
41 | struct ctf_fs_file { | |
3d731ea9 PP |
42 | bt_logging_level log_level; |
43 | ||
f67894f9 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 | ||
56 | struct ctf_fs_metadata { | |
7b33a0e0 PP |
57 | /* Owned by this */ |
58 | struct ctf_metadata_decoder *decoder; | |
59 | ||
1a9f7075 | 60 | /* Owned by this */ |
8eee8ea2 | 61 | bt_trace_class *trace_class; |
1a9f7075 | 62 | |
7b33a0e0 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 | 72 | struct ctf_fs_component { |
3d731ea9 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 | ||
aab89afc SM |
78 | /* Owned by this */ |
79 | struct ctf_fs_trace *trace; | |
1a9f7075 | 80 | |
53ac3428 | 81 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
82 | }; |
83 | ||
84 | struct ctf_fs_trace { | |
3d731ea9 PP |
85 | bt_logging_level log_level; |
86 | ||
6699263d SM |
87 | /* |
88 | * Weak. These are mostly used to generate log messages or to append | |
9e362268 | 89 | * error causes. They are mutually exclusive, only one of them must be |
6699263d SM |
90 | * set. |
91 | */ | |
f67894f9 | 92 | bt_self_component *self_comp; |
6699263d | 93 | bt_self_component_class *self_comp_class; |
f67894f9 | 94 | |
1a9f7075 | 95 | /* Owned by this */ |
5b29e799 | 96 | struct ctf_fs_metadata *metadata; |
1a9f7075 | 97 | |
10b7a2e4 | 98 | /* Owned by this */ |
8eee8ea2 | 99 | bt_trace *trace; |
10b7a2e4 | 100 | |
94cf822e PP |
101 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
102 | GPtrArray *ds_file_groups; | |
103 | ||
1a9f7075 PP |
104 | /* Owned by this */ |
105 | GString *path; | |
106 | ||
8deee039 PP |
107 | /* Next automatic stream ID when not provided by packet header */ |
108 | uint64_t next_stream_id; | |
1a9f7075 PP |
109 | }; |
110 | ||
779f4a23 | 111 | struct ctf_fs_ds_index_entry { |
13772304 FD |
112 | /* Weak, belongs to ctf_fs_ds_file_info. */ |
113 | const char *path; | |
114 | ||
779f4a23 FD |
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; | |
408c8c19 SM |
132 | |
133 | /* | |
134 | * Packet sequence number, or UINT64_MAX if not present in the index. | |
135 | */ | |
136 | uint64_t packet_seq_num; | |
779f4a23 FD |
137 | }; |
138 | ||
139 | struct ctf_fs_ds_index { | |
54dbe4d9 | 140 | /* Array of pointer to struct ctf_fs_ds_index_entry. */ |
779f4a23 FD |
141 | GPtrArray *entries; |
142 | }; | |
143 | ||
94cf822e PP |
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 | |
108b91d0 | 152 | * and the trace IR stream below. |
94cf822e PP |
153 | */ |
154 | GPtrArray *ds_file_infos; | |
155 | ||
d09752f8 | 156 | /* Owned by this */ |
28faa416 | 157 | struct ctf_stream_class *sc; |
d09752f8 | 158 | |
1a9f7075 | 159 | /* Owned by this */ |
8eee8ea2 | 160 | bt_stream *stream; |
1a9f7075 | 161 | |
d09752f8 PP |
162 | /* Stream (instance) ID; -1ULL means none */ |
163 | uint64_t stream_id; | |
164 | ||
94cf822e | 165 | /* Weak, belongs to component */ |
1a9f7075 | 166 | struct ctf_fs_trace *ctf_fs_trace; |
779f4a23 FD |
167 | |
168 | /* | |
80022dd5 | 169 | * Owned by this. |
779f4a23 FD |
170 | */ |
171 | struct ctf_fs_ds_index *index; | |
ea0b4b9e JG |
172 | }; |
173 | ||
94cf822e PP |
174 | struct ctf_fs_port_data { |
175 | /* Weak, belongs to ctf_fs_trace */ | |
176 | struct ctf_fs_ds_file_group *ds_file_group; | |
f7c3ac09 PP |
177 | |
178 | /* Weak */ | |
179 | struct ctf_fs_component *ctf_fs; | |
94cf822e PP |
180 | }; |
181 | ||
b09a5592 | 182 | struct ctf_fs_msg_iter_data { |
3d731ea9 PP |
183 | bt_logging_level log_level; |
184 | ||
f67894f9 PP |
185 | /* Weak */ |
186 | bt_self_component *self_comp; | |
187 | ||
f7c3ac09 | 188 | /* Weak */ |
1d744019 | 189 | bt_self_message_iterator *self_msg_iter; |
f7c3ac09 | 190 | |
94cf822e PP |
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_fs_ds_file *ds_file; | |
196 | ||
197 | /* Which file the iterator is _currently_ operating on */ | |
198 | size_t ds_file_info_index; | |
55fa6491 PP |
199 | |
200 | /* Owned by this */ | |
5d452e1f | 201 | struct ctf_msg_iter *msg_iter; |
44381fae SM |
202 | |
203 | /* | |
204 | * Saved error. If we hit an error in the _next method, but have some | |
205 | * messages ready to return, we save the error here and return it on | |
206 | * the next _next call. | |
207 | */ | |
208 | bt_component_class_message_iterator_next_method_status next_saved_status; | |
209 | const struct bt_error *next_saved_error; | |
94cf822e PP |
210 | }; |
211 | ||
f3bc2010 | 212 | BT_HIDDEN |
4175c1d5 | 213 | bt_component_class_initialize_method_status ctf_fs_init( |
8eee8ea2 | 214 | bt_self_component_source *source, |
e3250e61 | 215 | bt_self_component_source_configuration *config, |
8eee8ea2 | 216 | const bt_value *params, void *init_method_data); |
490db841 | 217 | |
d3e4dcd8 | 218 | BT_HIDDEN |
8eee8ea2 | 219 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 220 | |
55314f2a | 221 | BT_HIDDEN |
fb25b9e3 | 222 | bt_component_class_query_method_status ctf_fs_query( |
8eee8ea2 | 223 | bt_self_component_class_source *comp_class, |
bf403eb2 | 224 | bt_private_query_executor *priv_query_exec, |
8eee8ea2 | 225 | const char *object, const bt_value *params, |
f6e305ce | 226 | void *method_data, const bt_value **result); |
55314f2a | 227 | |
97ade20b | 228 | BT_HIDDEN |
4175c1d5 | 229 | bt_component_class_message_iterator_initialize_method_status ctf_fs_iterator_init( |
b09a5592 | 230 | bt_self_message_iterator *self_msg_iter, |
9415de1c | 231 | bt_self_message_iterator_configuration *config, |
8eee8ea2 PP |
232 | bt_self_component_source *self_comp, |
233 | bt_self_component_port_output *self_port); | |
834e9996 | 234 | |
97ade20b | 235 | BT_HIDDEN |
b09a5592 | 236 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 237 | |
97ade20b | 238 | BT_HIDDEN |
fb25b9e3 | 239 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
b09a5592 PP |
240 | bt_self_message_iterator *iterator, |
241 | bt_message_array_const msgs, uint64_t capacity, | |
3fd7b79d | 242 | uint64_t *count); |
d3eb6e8f | 243 | |
a02839ae | 244 | BT_HIDDEN |
fb25b9e3 | 245 | bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning( |
a02839ae PP |
246 | bt_self_message_iterator *message_iterator); |
247 | ||
bf5b7748 SM |
248 | /* Create and initialize a new, empty ctf_fs_component. */ |
249 | ||
250 | BT_HIDDEN | |
f67894f9 PP |
251 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
252 | bt_self_component *self_comp); | |
bf5b7748 SM |
253 | |
254 | /* | |
aab89afc SM |
255 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
256 | * the same UUID. | |
257 | * | |
258 | * `paths_value` must be an array of strings, | |
259 | * | |
260 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. | |
5c3441d8 SM |
261 | * |
262 | * `self_comp` and `self_comp_class` are used for logging, only one of them | |
263 | * should be set. | |
bf5b7748 SM |
264 | */ |
265 | ||
266 | BT_HIDDEN | |
aab89afc | 267 | int ctf_fs_component_create_ctf_fs_trace( |
bf5b7748 | 268 | struct ctf_fs_component *ctf_fs, |
5c3441d8 | 269 | const bt_value *paths_value, |
c77d62f1 | 270 | const bt_value *trace_name_value, |
5c3441d8 SM |
271 | bt_self_component *self_comp, |
272 | bt_self_component_class *self_comp_class); | |
bf5b7748 SM |
273 | |
274 | /* Free `ctf_fs` and everything it owns. */ | |
275 | ||
276 | BT_HIDDEN | |
277 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); | |
278 | ||
c80d4c65 SM |
279 | /* |
280 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
281 | * | |
282 | * - The mandatory `paths` parameter is returned in `*paths`. | |
283 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
284 | * present, are recorded in the `ctf_fs` structure. | |
c77d62f1 SM |
285 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
286 | * present, else `*trace_name` is set to NULL. | |
c80d4c65 | 287 | * |
5c3441d8 SM |
288 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
289 | * should be set. | |
290 | * | |
c80d4c65 SM |
291 | * Return true on success, false if any parameter didn't pass validation. |
292 | */ | |
bf5b7748 SM |
293 | |
294 | BT_HIDDEN | |
c80d4c65 | 295 | bool read_src_fs_parameters(const bt_value *params, |
c77d62f1 SM |
296 | const bt_value **paths, |
297 | const bt_value **trace_name, | |
298 | struct ctf_fs_component *ctf_fs, | |
5c3441d8 SM |
299 | bt_self_component *self_comp, |
300 | bt_self_component_class *self_comp_class); | |
bf5b7748 | 301 | |
ddf49b27 SM |
302 | /* |
303 | * Generate the port name to be used for a given data stream file group. | |
304 | * | |
305 | * The result must be freed using g_free by the caller. | |
306 | */ | |
307 | ||
308 | BT_HIDDEN | |
309 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); | |
310 | ||
541b0a11 | 311 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |