Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
ea0b4b9e | 2 | * fs.c |
7a278c8e | 3 | * |
ea0b4b9e | 4 | * Babeltrace CTF file system Reader Component |
7a278c8e | 5 | * |
1a9f7075 | 6 | * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com> |
f3bc2010 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7a278c8e | 8 | * |
7a278c8e JG |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
f67894f9 | 28 | #define BT_COMP_LOG_SELF_COMP self_comp |
3d731ea9 PP |
29 | #define BT_LOG_OUTPUT_LEVEL log_level |
30 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS" | |
3fa1b6a3 | 31 | #include "logging/comp-logging.h" |
3d731ea9 | 32 | |
57952005 | 33 | #include "common/common.h" |
71c5da58 | 34 | #include <babeltrace2/babeltrace.h> |
d126826c | 35 | #include "common/uuid.h" |
ea0b4b9e | 36 | #include <glib.h> |
57952005 | 37 | #include "common/assert.h" |
94cf822e | 38 | #include <inttypes.h> |
c55a9f58 | 39 | #include <stdbool.h> |
56a1cced | 40 | #include "fs.h" |
413bc2c4 | 41 | #include "metadata.h" |
94cf822e | 42 | #include "data-stream-file.h" |
e7a4393b | 43 | #include "file.h" |
1e649dff | 44 | #include "../common/metadata/decoder.h" |
cd03c43c | 45 | #include "../common/metadata/ctf-meta-configure-ir-trace.h" |
b09a5592 | 46 | #include "../common/msg-iter/msg-iter.h" |
04c0ba87 | 47 | #include "query.h" |
e7a4393b | 48 | |
7b4d28d0 FD |
49 | struct tracer_info { |
50 | const char *name; | |
51 | int64_t major; | |
52 | int64_t minor; | |
53 | int64_t patch; | |
54 | }; | |
55 | ||
94cf822e | 56 | static |
b09a5592 | 57 | int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data) |
94cf822e PP |
58 | { |
59 | struct ctf_fs_ds_file_info *ds_file_info; | |
60 | int ret = 0; | |
61 | ||
b09a5592 PP |
62 | BT_ASSERT(msg_iter_data->ds_file_info_index < |
63 | msg_iter_data->ds_file_group->ds_file_infos->len); | |
94cf822e | 64 | ds_file_info = g_ptr_array_index( |
b09a5592 PP |
65 | msg_iter_data->ds_file_group->ds_file_infos, |
66 | msg_iter_data->ds_file_info_index); | |
67 | ||
68 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); | |
69 | msg_iter_data->ds_file = ctf_fs_ds_file_create( | |
70 | msg_iter_data->ds_file_group->ctf_fs_trace, | |
71 | msg_iter_data->pc_msg_iter, | |
72 | msg_iter_data->msg_iter, | |
73 | msg_iter_data->ds_file_group->stream, | |
3d731ea9 PP |
74 | ds_file_info->path->str, |
75 | msg_iter_data->log_level); | |
b09a5592 | 76 | if (!msg_iter_data->ds_file) { |
94cf822e PP |
77 | ret = -1; |
78 | } | |
79 | ||
80 | return ret; | |
81 | } | |
82 | ||
83 | static | |
b09a5592 PP |
84 | void ctf_fs_msg_iter_data_destroy( |
85 | struct ctf_fs_msg_iter_data *msg_iter_data) | |
94cf822e | 86 | { |
b09a5592 | 87 | if (!msg_iter_data) { |
94cf822e PP |
88 | return; |
89 | } | |
90 | ||
b09a5592 | 91 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); |
55fa6491 | 92 | |
b09a5592 PP |
93 | if (msg_iter_data->msg_iter) { |
94 | bt_msg_iter_destroy(msg_iter_data->msg_iter); | |
55fa6491 PP |
95 | } |
96 | ||
b09a5592 | 97 | g_free(msg_iter_data); |
94cf822e PP |
98 | } |
99 | ||
bbbd35bf PP |
100 | static |
101 | void set_msg_iter_emits_stream_beginning_end_messages( | |
102 | struct ctf_fs_msg_iter_data *msg_iter_data) | |
103 | { | |
104 | bt_msg_iter_set_emit_stream_beginning_message( | |
105 | msg_iter_data->ds_file->msg_iter, | |
106 | msg_iter_data->ds_file_info_index == 0); | |
107 | bt_msg_iter_set_emit_stream_end_message( | |
108 | msg_iter_data->ds_file->msg_iter, | |
109 | msg_iter_data->ds_file_info_index == | |
110 | msg_iter_data->ds_file_group->ds_file_infos->len - 1); | |
111 | } | |
112 | ||
3fd7b79d | 113 | static |
fb25b9e3 | 114 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next_one( |
b09a5592 | 115 | struct ctf_fs_msg_iter_data *msg_iter_data, |
bbbd35bf | 116 | const bt_message **out_msg) |
ea0b4b9e | 117 | { |
fb25b9e3 | 118 | bt_component_class_message_iterator_next_method_status status; |
94cf822e | 119 | |
b09a5592 | 120 | BT_ASSERT(msg_iter_data->ds_file); |
6ff151ad | 121 | |
bbbd35bf PP |
122 | while (true) { |
123 | bt_message *msg; | |
124 | ||
125 | status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg); | |
126 | switch (status) { | |
fb25b9e3 | 127 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK: |
bbbd35bf PP |
128 | *out_msg = msg; |
129 | msg = NULL; | |
6ff151ad | 130 | goto end; |
fb25b9e3 | 131 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END: |
bbbd35bf PP |
132 | { |
133 | int ret; | |
6ff151ad | 134 | |
bbbd35bf PP |
135 | if (msg_iter_data->ds_file_info_index == |
136 | msg_iter_data->ds_file_group->ds_file_infos->len - 1) { | |
137 | /* End of all group's stream files */ | |
138 | goto end; | |
139 | } | |
140 | ||
141 | msg_iter_data->ds_file_info_index++; | |
989925d1 PP |
142 | bt_msg_iter_reset_for_next_stream_file( |
143 | msg_iter_data->msg_iter); | |
bbbd35bf PP |
144 | set_msg_iter_emits_stream_beginning_end_messages( |
145 | msg_iter_data); | |
94cf822e | 146 | |
94cf822e | 147 | /* |
bbbd35bf PP |
148 | * Open and start reading the next stream file |
149 | * within our stream file group. | |
94cf822e | 150 | */ |
bbbd35bf PP |
151 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); |
152 | if (ret) { | |
fb25b9e3 | 153 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
bbbd35bf PP |
154 | goto end; |
155 | } | |
156 | ||
157 | /* Continue the loop to get the next message */ | |
158 | break; | |
94cf822e | 159 | } |
bbbd35bf | 160 | default: |
94cf822e PP |
161 | goto end; |
162 | } | |
94cf822e | 163 | } |
d01e0f33 | 164 | |
94cf822e | 165 | end: |
3fd7b79d PP |
166 | return status; |
167 | } | |
168 | ||
169 | BT_HIDDEN | |
fb25b9e3 | 170 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
b09a5592 PP |
171 | bt_self_message_iterator *iterator, |
172 | bt_message_array_const msgs, uint64_t capacity, | |
3fd7b79d PP |
173 | uint64_t *count) |
174 | { | |
fb25b9e3 PP |
175 | bt_component_class_message_iterator_next_method_status status = |
176 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
b09a5592 PP |
177 | struct ctf_fs_msg_iter_data *msg_iter_data = |
178 | bt_self_message_iterator_get_data(iterator); | |
3fd7b79d PP |
179 | uint64_t i = 0; |
180 | ||
fb25b9e3 PP |
181 | while (i < capacity && |
182 | status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { | |
b09a5592 | 183 | status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]); |
fb25b9e3 | 184 | if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
3fd7b79d PP |
185 | i++; |
186 | } | |
187 | } | |
188 | ||
189 | if (i > 0) { | |
190 | /* | |
191 | * Even if ctf_fs_iterator_next_one() returned something | |
fb25b9e3 | 192 | * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we |
b09a5592 PP |
193 | * accumulated message objects in the output |
194 | * message array, so we need to return | |
fb25b9e3 | 195 | * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are |
3fd7b79d | 196 | * transfered to downstream. This other status occurs |
b09a5592 | 197 | * again the next time muxer_msg_iter_do_next() is |
3fd7b79d | 198 | * called, possibly without any accumulated |
b09a5592 | 199 | * message, in which case we'll return it. |
3fd7b79d PP |
200 | */ |
201 | *count = i; | |
fb25b9e3 | 202 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
3fd7b79d PP |
203 | } |
204 | ||
205 | return status; | |
ea0b4b9e | 206 | } |
bfd20a42 | 207 | |
a02839ae PP |
208 | static |
209 | int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data) | |
210 | { | |
211 | int ret; | |
212 | ||
213 | msg_iter_data->ds_file_info_index = 0; | |
214 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); | |
215 | if (ret) { | |
216 | goto end; | |
217 | } | |
218 | ||
219 | bt_msg_iter_reset(msg_iter_data->msg_iter); | |
220 | set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data); | |
221 | ||
222 | end: | |
223 | return ret; | |
224 | } | |
225 | ||
226 | BT_HIDDEN | |
fb25b9e3 PP |
227 | bt_component_class_message_iterator_seek_beginning_method_status |
228 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it) | |
a02839ae PP |
229 | { |
230 | struct ctf_fs_msg_iter_data *msg_iter_data = | |
231 | bt_self_message_iterator_get_data(it); | |
fb25b9e3 PP |
232 | bt_component_class_message_iterator_seek_beginning_method_status status = |
233 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK; | |
a02839ae PP |
234 | |
235 | BT_ASSERT(msg_iter_data); | |
236 | if (ctf_fs_iterator_reset(msg_iter_data)) { | |
fb25b9e3 | 237 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR; |
a02839ae PP |
238 | } |
239 | ||
240 | return status; | |
241 | } | |
242 | ||
243 | BT_HIDDEN | |
b09a5592 | 244 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it) |
760051fa | 245 | { |
b09a5592 PP |
246 | ctf_fs_msg_iter_data_destroy( |
247 | bt_self_message_iterator_get_data(it)); | |
760051fa JG |
248 | } |
249 | ||
a02839ae | 250 | BT_HIDDEN |
fb25b9e3 | 251 | bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init( |
b09a5592 | 252 | bt_self_message_iterator *self_msg_iter, |
f67894f9 | 253 | bt_self_component_source *self_comp_src, |
8eee8ea2 | 254 | bt_self_component_port_output *self_port) |
4c1456f0 | 255 | { |
4f1f88a6 | 256 | struct ctf_fs_port_data *port_data; |
b09a5592 | 257 | struct ctf_fs_msg_iter_data *msg_iter_data = NULL; |
fb25b9e3 PP |
258 | bt_component_class_message_iterator_init_method_status ret = |
259 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK; | |
3d731ea9 | 260 | bt_logging_level log_level; |
5c3441d8 SM |
261 | bt_self_component *self_comp = |
262 | bt_self_component_source_as_self_component(self_comp_src); | |
760051fa | 263 | |
834e9996 | 264 | port_data = bt_self_component_port_get_data( |
bb61965b | 265 | bt_self_component_port_output_as_self_component_port( |
834e9996 PP |
266 | self_port)); |
267 | BT_ASSERT(port_data); | |
3d731ea9 | 268 | log_level = port_data->ctf_fs->log_level; |
b09a5592 PP |
269 | msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1); |
270 | if (!msg_iter_data) { | |
621b4e7e | 271 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; |
94cf822e PP |
272 | goto error; |
273 | } | |
274 | ||
3d731ea9 | 275 | msg_iter_data->log_level = log_level; |
f67894f9 | 276 | msg_iter_data->self_comp = self_comp; |
b09a5592 PP |
277 | msg_iter_data->pc_msg_iter = self_msg_iter; |
278 | msg_iter_data->msg_iter = bt_msg_iter_create( | |
7b33a0e0 | 279 | port_data->ds_file_group->ctf_fs_trace->metadata->tc, |
3d731ea9 | 280 | bt_common_get_page_size(msg_iter_data->log_level) * 8, |
f67894f9 PP |
281 | ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level, |
282 | self_comp); | |
b09a5592 | 283 | if (!msg_iter_data->msg_iter) { |
5c3441d8 | 284 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create a CTF message iterator."); |
fb25b9e3 | 285 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; |
55fa6491 PP |
286 | goto error; |
287 | } | |
288 | ||
b09a5592 | 289 | msg_iter_data->ds_file_group = port_data->ds_file_group; |
a02839ae | 290 | if (ctf_fs_iterator_reset(msg_iter_data)) { |
fb25b9e3 | 291 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR; |
4f1f88a6 | 292 | goto error; |
760051fa JG |
293 | } |
294 | ||
b09a5592 PP |
295 | bt_self_message_iterator_set_data(self_msg_iter, |
296 | msg_iter_data); | |
fb25b9e3 | 297 | if (ret != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK) { |
4f1f88a6 | 298 | goto error; |
760051fa JG |
299 | } |
300 | ||
b09a5592 | 301 | msg_iter_data = NULL; |
4f1f88a6 | 302 | goto end; |
5b29e799 | 303 | |
4f1f88a6 | 304 | error: |
b09a5592 | 305 | bt_self_message_iterator_set_data(self_msg_iter, NULL); |
4f1f88a6 | 306 | |
760051fa | 307 | end: |
b09a5592 | 308 | ctf_fs_msg_iter_data_destroy(msg_iter_data); |
760051fa JG |
309 | return ret; |
310 | } | |
311 | ||
aab89afc SM |
312 | static |
313 | void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace) | |
314 | { | |
315 | if (!ctf_fs_trace) { | |
316 | return; | |
317 | } | |
318 | ||
319 | if (ctf_fs_trace->ds_file_groups) { | |
320 | g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE); | |
321 | } | |
322 | ||
323 | BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace); | |
324 | ||
325 | if (ctf_fs_trace->path) { | |
326 | g_string_free(ctf_fs_trace->path, TRUE); | |
327 | } | |
328 | ||
329 | if (ctf_fs_trace->metadata) { | |
330 | ctf_fs_metadata_fini(ctf_fs_trace->metadata); | |
331 | g_free(ctf_fs_trace->metadata); | |
332 | } | |
333 | ||
334 | g_free(ctf_fs_trace); | |
335 | } | |
336 | ||
bf5b7748 | 337 | BT_HIDDEN |
1a9f7075 | 338 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs) |
760051fa | 339 | { |
4f1f88a6 | 340 | if (!ctf_fs) { |
8fa760ba JG |
341 | return; |
342 | } | |
4f1f88a6 | 343 | |
aab89afc | 344 | ctf_fs_trace_destroy(ctf_fs->trace); |
4f1f88a6 PP |
345 | |
346 | if (ctf_fs->port_data) { | |
347 | g_ptr_array_free(ctf_fs->port_data, TRUE); | |
c14d7e26 | 348 | } |
760051fa | 349 | |
1a9f7075 PP |
350 | g_free(ctf_fs); |
351 | } | |
352 | ||
bf5b7748 SM |
353 | static |
354 | void port_data_destroy(struct ctf_fs_port_data *port_data) | |
355 | { | |
356 | if (!port_data) { | |
357 | return; | |
358 | } | |
359 | ||
360 | g_free(port_data); | |
361 | } | |
362 | ||
363 | static | |
364 | void port_data_destroy_notifier(void *data) { | |
365 | port_data_destroy(data); | |
366 | } | |
367 | ||
97ade20b | 368 | static |
229f76ed | 369 | void ctf_fs_trace_destroy_notifier(void *data) |
97ade20b JG |
370 | { |
371 | struct ctf_fs_trace *trace = data; | |
372 | ctf_fs_trace_destroy(trace); | |
373 | } | |
374 | ||
f67894f9 PP |
375 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
376 | bt_self_component *self_comp) | |
a4792757 | 377 | { |
bf5b7748 | 378 | struct ctf_fs_component *ctf_fs; |
a4792757 | 379 | |
bf5b7748 SM |
380 | ctf_fs = g_new0(struct ctf_fs_component, 1); |
381 | if (!ctf_fs) { | |
382 | goto error; | |
383 | } | |
4f1f88a6 | 384 | |
3d731ea9 | 385 | ctf_fs->log_level = log_level; |
bf5b7748 SM |
386 | ctf_fs->port_data = |
387 | g_ptr_array_new_with_free_func(port_data_destroy_notifier); | |
388 | if (!ctf_fs->port_data) { | |
389 | goto error; | |
4f1f88a6 PP |
390 | } |
391 | ||
bf5b7748 SM |
392 | goto end; |
393 | ||
394 | error: | |
e1cfefd2 SM |
395 | ctf_fs_destroy(ctf_fs); |
396 | ctf_fs = NULL; | |
bf5b7748 SM |
397 | |
398 | end: | |
399 | return ctf_fs; | |
400 | } | |
401 | ||
402 | void ctf_fs_finalize(bt_self_component_source *component) | |
403 | { | |
404 | ctf_fs_destroy(bt_self_component_get_data( | |
405 | bt_self_component_source_as_self_component(component))); | |
5b29e799 JG |
406 | } |
407 | ||
ddf49b27 | 408 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group) |
d09752f8 | 409 | { |
ddf49b27 | 410 | GString *name = g_string_new(NULL); |
d09752f8 | 411 | |
ddf49b27 SM |
412 | /* |
413 | * The unique port name is generated by concatenating unique identifiers | |
414 | * for: | |
415 | * | |
416 | * - the trace | |
417 | * - the stream class | |
418 | * - the stream | |
419 | */ | |
420 | ||
421 | /* For the trace, use the uuid if present, else the path. */ | |
422 | if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) { | |
d126826c | 423 | char uuid_str[BT_UUID_STR_LEN + 1]; |
ddf49b27 | 424 | |
d126826c | 425 | bt_uuid_to_str(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str); |
ddf49b27 SM |
426 | g_string_assign(name, uuid_str); |
427 | } else { | |
428 | g_string_assign(name, ds_file_group->ctf_fs_trace->path->str); | |
d09752f8 PP |
429 | } |
430 | ||
431 | /* | |
ddf49b27 SM |
432 | * For the stream class, use the id if present. We can omit this field |
433 | * otherwise, as there will only be a single stream class. | |
d09752f8 | 434 | */ |
ddf49b27 SM |
435 | if (ds_file_group->sc->id != UINT64_C(-1)) { |
436 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id); | |
437 | } | |
d09752f8 | 438 | |
ddf49b27 SM |
439 | /* For the stream, use the id if present, else, use the path. */ |
440 | if (ds_file_group->stream_id != UINT64_C(-1)) { | |
441 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id); | |
442 | } else { | |
443 | BT_ASSERT(ds_file_group->ds_file_infos->len == 1); | |
444 | struct ctf_fs_ds_file_info *ds_file_info = | |
445 | g_ptr_array_index(ds_file_group->ds_file_infos, 0); | |
446 | g_string_append_printf(name, " | %s", ds_file_info->path->str); | |
447 | } | |
448 | ||
449 | return g_string_free(name, FALSE); | |
d09752f8 PP |
450 | } |
451 | ||
5b29e799 | 452 | static |
55314f2a JG |
453 | int create_one_port_for_trace(struct ctf_fs_component *ctf_fs, |
454 | struct ctf_fs_trace *ctf_fs_trace, | |
5c3441d8 SM |
455 | struct ctf_fs_ds_file_group *ds_file_group, |
456 | bt_self_component_source *self_comp_src) | |
5b29e799 | 457 | { |
4f1f88a6 | 458 | int ret = 0; |
4f1f88a6 | 459 | struct ctf_fs_port_data *port_data = NULL; |
ddf49b27 | 460 | gchar *port_name; |
3d731ea9 | 461 | bt_logging_level log_level = ctf_fs->log_level; |
5c3441d8 SM |
462 | bt_self_component *self_comp = |
463 | bt_self_component_source_as_self_component(self_comp_src); | |
4f1f88a6 | 464 | |
ddf49b27 | 465 | port_name = ctf_fs_make_port_name(ds_file_group); |
4f1f88a6 PP |
466 | if (!port_name) { |
467 | goto error; | |
468 | } | |
469 | ||
f67894f9 | 470 | BT_COMP_LOGI("Creating one port named `%s`", port_name); |
4f1f88a6 PP |
471 | |
472 | /* Create output port for this file */ | |
4f1f88a6 PP |
473 | port_data = g_new0(struct ctf_fs_port_data, 1); |
474 | if (!port_data) { | |
475 | goto error; | |
476 | } | |
477 | ||
f7c3ac09 | 478 | port_data->ctf_fs = ctf_fs; |
94cf822e | 479 | port_data->ds_file_group = ds_file_group; |
834e9996 | 480 | ret = bt_self_component_source_add_output_port( |
5c3441d8 | 481 | self_comp_src, port_name, port_data, NULL); |
147337a3 | 482 | if (ret) { |
4f1f88a6 PP |
483 | goto error; |
484 | } | |
485 | ||
486 | g_ptr_array_add(ctf_fs->port_data, port_data); | |
487 | port_data = NULL; | |
488 | goto end; | |
489 | ||
490 | error: | |
491 | ret = -1; | |
492 | ||
493 | end: | |
be1b2e7e | 494 | g_free(port_name); |
4f1f88a6 | 495 | |
4f1f88a6 PP |
496 | port_data_destroy(port_data); |
497 | return ret; | |
5b29e799 JG |
498 | } |
499 | ||
500 | static | |
55314f2a | 501 | int create_ports_for_trace(struct ctf_fs_component *ctf_fs, |
5c3441d8 SM |
502 | struct ctf_fs_trace *ctf_fs_trace, |
503 | bt_self_component_source *self_comp_src) | |
94cf822e PP |
504 | { |
505 | int ret = 0; | |
94cf822e | 506 | size_t i; |
3d731ea9 | 507 | bt_logging_level log_level = ctf_fs_trace->log_level; |
5c3441d8 SM |
508 | bt_self_component *self_comp = |
509 | bt_self_component_source_as_self_component(self_comp_src); | |
94cf822e PP |
510 | |
511 | /* Create one output port for each stream file group */ | |
512 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
513 | struct ctf_fs_ds_file_group *ds_file_group = | |
514 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); | |
515 | ||
55314f2a | 516 | ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace, |
5c3441d8 | 517 | ds_file_group, self_comp_src); |
94cf822e | 518 | if (ret) { |
5c3441d8 | 519 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create output port."); |
94cf822e PP |
520 | goto end; |
521 | } | |
522 | } | |
523 | ||
524 | end: | |
525 | return ret; | |
526 | } | |
527 | ||
94cf822e PP |
528 | static |
529 | void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info) | |
530 | { | |
531 | if (!ds_file_info) { | |
532 | return; | |
533 | } | |
534 | ||
535 | if (ds_file_info->path) { | |
536 | g_string_free(ds_file_info->path, TRUE); | |
537 | } | |
538 | ||
539 | g_free(ds_file_info); | |
540 | } | |
541 | ||
542 | static | |
543 | struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path, | |
779f4a23 | 544 | int64_t begin_ns) |
94cf822e PP |
545 | { |
546 | struct ctf_fs_ds_file_info *ds_file_info; | |
547 | ||
548 | ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1); | |
549 | if (!ds_file_info) { | |
550 | goto end; | |
551 | } | |
552 | ||
553 | ds_file_info->path = g_string_new(path); | |
554 | if (!ds_file_info->path) { | |
555 | ctf_fs_ds_file_info_destroy(ds_file_info); | |
556 | ds_file_info = NULL; | |
557 | goto end; | |
558 | } | |
559 | ||
560 | ds_file_info->begin_ns = begin_ns; | |
561 | ||
562 | end: | |
563 | return ds_file_info; | |
564 | } | |
565 | ||
566 | static | |
567 | void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group) | |
568 | { | |
569 | if (!ds_file_group) { | |
570 | return; | |
571 | } | |
572 | ||
573 | if (ds_file_group->ds_file_infos) { | |
574 | g_ptr_array_free(ds_file_group->ds_file_infos, TRUE); | |
575 | } | |
576 | ||
779f4a23 FD |
577 | if (ds_file_group->index) { |
578 | if (ds_file_group->index->entries) { | |
579 | g_ptr_array_free(ds_file_group->index->entries, TRUE); | |
580 | } | |
581 | g_free(ds_file_group->index); | |
582 | } | |
583 | ||
8c6884d9 | 584 | bt_stream_put_ref(ds_file_group->stream); |
94cf822e PP |
585 | g_free(ds_file_group); |
586 | } | |
587 | ||
588 | static | |
589 | struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create( | |
590 | struct ctf_fs_trace *ctf_fs_trace, | |
28faa416 | 591 | struct ctf_stream_class *sc, |
779f4a23 FD |
592 | uint64_t stream_instance_id, |
593 | struct ctf_fs_ds_index *index) | |
94cf822e PP |
594 | { |
595 | struct ctf_fs_ds_file_group *ds_file_group; | |
596 | ||
94cf822e PP |
597 | ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1); |
598 | if (!ds_file_group) { | |
599 | goto error; | |
600 | } | |
601 | ||
602 | ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func( | |
603 | (GDestroyNotify) ctf_fs_ds_file_info_destroy); | |
604 | if (!ds_file_group->ds_file_infos) { | |
605 | goto error; | |
606 | } | |
607 | ||
779f4a23 FD |
608 | ds_file_group->index = index; |
609 | ||
d09752f8 | 610 | ds_file_group->stream_id = stream_instance_id; |
28faa416 PP |
611 | BT_ASSERT(sc); |
612 | ds_file_group->sc = sc; | |
94cf822e | 613 | ds_file_group->ctf_fs_trace = ctf_fs_trace; |
94cf822e PP |
614 | goto end; |
615 | ||
616 | error: | |
617 | ctf_fs_ds_file_group_destroy(ds_file_group); | |
779f4a23 | 618 | ctf_fs_ds_index_destroy(index); |
94cf822e PP |
619 | ds_file_group = NULL; |
620 | ||
621 | end: | |
622 | return ds_file_group; | |
623 | } | |
624 | ||
2b5f969e MJ |
625 | /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */ |
626 | static | |
627 | void array_insert(GPtrArray *array, gpointer element, size_t pos) | |
628 | { | |
629 | size_t original_array_len = array->len; | |
630 | ||
631 | /* Allocate an unused element at the end of the array. */ | |
632 | g_ptr_array_add(array, NULL); | |
633 | ||
634 | /* If we are not inserting at the end, move the elements by one. */ | |
635 | if (pos < original_array_len) { | |
636 | memmove(&(array->pdata[pos + 1]), | |
637 | &(array->pdata[pos]), | |
638 | (original_array_len - pos) * sizeof(gpointer)); | |
639 | } | |
640 | ||
9f197a0c | 641 | /* Insert the value. */ |
2b5f969e MJ |
642 | array->pdata[pos] = element; |
643 | } | |
644 | ||
adb623c2 SM |
645 | /* |
646 | * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right | |
647 | * place to keep it sorted. | |
648 | */ | |
649 | ||
650 | static | |
651 | void ds_file_group_insert_ds_file_info_sorted( | |
652 | struct ctf_fs_ds_file_group *ds_file_group, | |
653 | struct ctf_fs_ds_file_info *ds_file_info) | |
654 | { | |
655 | guint i; | |
656 | ||
657 | /* Find the spot where to insert this ds_file_info. */ | |
658 | for (i = 0; i < ds_file_group->ds_file_infos->len; i++) { | |
659 | struct ctf_fs_ds_file_info *other_ds_file_info = | |
660 | g_ptr_array_index(ds_file_group->ds_file_infos, i); | |
661 | ||
662 | if (ds_file_info->begin_ns < other_ds_file_info->begin_ns) { | |
663 | break; | |
664 | } | |
665 | } | |
666 | ||
667 | array_insert(ds_file_group->ds_file_infos, ds_file_info, i); | |
668 | } | |
669 | ||
779f4a23 FD |
670 | static |
671 | void ds_file_group_insert_ds_index_entry_sorted( | |
672 | struct ctf_fs_ds_file_group *ds_file_group, | |
673 | struct ctf_fs_ds_index_entry *entry) | |
674 | { | |
675 | guint i; | |
676 | ||
677 | /* Find the spot where to insert this index entry. */ | |
678 | for (i = 0; i < ds_file_group->index->entries->len; i++) { | |
679 | struct ctf_fs_ds_index_entry *other_entry = g_ptr_array_index( | |
680 | ds_file_group->index->entries, i); | |
681 | ||
682 | if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) { | |
683 | break; | |
684 | } | |
685 | } | |
686 | ||
687 | array_insert(ds_file_group->index->entries, entry, i); | |
688 | } | |
689 | ||
94cf822e PP |
690 | static |
691 | int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace, | |
9e550e5f | 692 | const char *path) |
94cf822e | 693 | { |
7b33a0e0 PP |
694 | int64_t stream_instance_id = -1; |
695 | int64_t begin_ns = -1; | |
94cf822e PP |
696 | struct ctf_fs_ds_file_group *ds_file_group = NULL; |
697 | bool add_group = false; | |
698 | int ret; | |
699 | size_t i; | |
55fa6491 | 700 | struct ctf_fs_ds_file *ds_file = NULL; |
13772304 | 701 | struct ctf_fs_ds_file_info *ds_file_info = NULL; |
97ade20b | 702 | struct ctf_fs_ds_index *index = NULL; |
b09a5592 | 703 | struct bt_msg_iter *msg_iter = NULL; |
7b33a0e0 | 704 | struct ctf_stream_class *sc = NULL; |
b09a5592 | 705 | struct bt_msg_iter_packet_properties props; |
3d731ea9 | 706 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 707 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
94cf822e | 708 | |
b09a5592 | 709 | msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc, |
3d731ea9 | 710 | bt_common_get_page_size(log_level) * 8, |
f67894f9 | 711 | ctf_fs_ds_file_medops, NULL, log_level, self_comp); |
b09a5592 | 712 | if (!msg_iter) { |
f67894f9 | 713 | BT_COMP_LOGE_STR("Cannot create a CTF message iterator."); |
55fa6491 PP |
714 | goto error; |
715 | } | |
716 | ||
b09a5592 | 717 | ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter, |
3d731ea9 | 718 | NULL, path, log_level); |
97ade20b JG |
719 | if (!ds_file) { |
720 | goto error; | |
721 | } | |
722 | ||
e5e71bf8 | 723 | ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props); |
94cf822e | 724 | if (ret) { |
5c3441d8 SM |
725 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
726 | "Cannot get stream file's first packet's header and context fields (`%s`).", | |
94cf822e PP |
727 | path); |
728 | goto error; | |
729 | } | |
730 | ||
7b33a0e0 PP |
731 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, |
732 | props.stream_class_id); | |
733 | BT_ASSERT(sc); | |
7b33a0e0 PP |
734 | stream_instance_id = props.data_stream_id; |
735 | ||
736 | if (props.snapshots.beginning_clock != UINT64_C(-1)) { | |
737 | BT_ASSERT(sc->default_clock_class); | |
35fa110e PP |
738 | ret = bt_util_clock_cycles_to_ns_from_origin( |
739 | props.snapshots.beginning_clock, | |
740 | sc->default_clock_class->frequency, | |
741 | sc->default_clock_class->offset_seconds, | |
742 | sc->default_clock_class->offset_cycles, &begin_ns); | |
7b33a0e0 | 743 | if (ret) { |
5c3441d8 SM |
744 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
745 | "Cannot convert clock cycles to nanoseconds from origin (`%s`).", | |
7b33a0e0 PP |
746 | path); |
747 | goto error; | |
748 | } | |
94cf822e PP |
749 | } |
750 | ||
13772304 FD |
751 | ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns); |
752 | if (!ds_file_info) { | |
753 | goto error; | |
754 | } | |
755 | ||
756 | index = ctf_fs_ds_file_build_index(ds_file, ds_file_info); | |
97ade20b | 757 | if (!index) { |
f67894f9 | 758 | BT_COMP_LOGW("Failed to index CTF stream file \'%s\'", |
97ade20b JG |
759 | ds_file->file->path->str); |
760 | } | |
761 | ||
7b33a0e0 | 762 | if (begin_ns == -1) { |
94cf822e PP |
763 | /* |
764 | * No beggining timestamp to sort the stream files | |
765 | * within a stream file group, so consider that this | |
766 | * file must be the only one within its group. | |
767 | */ | |
7b33a0e0 | 768 | stream_instance_id = -1; |
94cf822e PP |
769 | } |
770 | ||
7b33a0e0 | 771 | if (stream_instance_id == -1) { |
94cf822e PP |
772 | /* |
773 | * No stream instance ID or no beginning timestamp: | |
774 | * create a unique stream file group for this stream | |
775 | * file because, even if there's a stream instance ID, | |
776 | * there's no timestamp to order the file within its | |
777 | * group. | |
778 | */ | |
94cf822e | 779 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, |
779f4a23 FD |
780 | sc, UINT64_C(-1), index); |
781 | /* Ownership of index is transferred. */ | |
782 | index = NULL; | |
783 | ||
94cf822e PP |
784 | if (!ds_file_group) { |
785 | goto error; | |
786 | } | |
787 | ||
13772304 | 788 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info); |
94cf822e PP |
789 | |
790 | add_group = true; | |
791 | goto end; | |
792 | } | |
793 | ||
7b33a0e0 PP |
794 | BT_ASSERT(stream_instance_id != -1); |
795 | BT_ASSERT(begin_ns != -1); | |
94cf822e PP |
796 | |
797 | /* Find an existing stream file group with this ID */ | |
798 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
94cf822e PP |
799 | ds_file_group = g_ptr_array_index( |
800 | ctf_fs_trace->ds_file_groups, i); | |
94cf822e | 801 | |
28faa416 | 802 | if (ds_file_group->sc == sc && |
d09752f8 PP |
803 | ds_file_group->stream_id == |
804 | stream_instance_id) { | |
94cf822e PP |
805 | break; |
806 | } | |
807 | ||
808 | ds_file_group = NULL; | |
809 | } | |
810 | ||
811 | if (!ds_file_group) { | |
812 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, | |
779f4a23 FD |
813 | sc, stream_instance_id, index); |
814 | /* Ownership of index is transferred. */ | |
815 | index = NULL; | |
94cf822e PP |
816 | if (!ds_file_group) { |
817 | goto error; | |
818 | } | |
819 | ||
820 | add_group = true; | |
821 | } | |
822 | ||
13772304 | 823 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info); |
94cf822e PP |
824 | |
825 | goto end; | |
826 | ||
827 | error: | |
828 | ctf_fs_ds_file_group_destroy(ds_file_group); | |
41d87c7b | 829 | ds_file_group = NULL; |
94cf822e PP |
830 | ret = -1; |
831 | ||
832 | end: | |
833 | if (add_group && ds_file_group) { | |
834 | g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group); | |
835 | } | |
d09752f8 | 836 | |
97ade20b | 837 | ctf_fs_ds_file_destroy(ds_file); |
55fa6491 | 838 | |
b09a5592 PP |
839 | if (msg_iter) { |
840 | bt_msg_iter_destroy(msg_iter); | |
55fa6491 PP |
841 | } |
842 | ||
97ade20b | 843 | ctf_fs_ds_index_destroy(index); |
94cf822e PP |
844 | return ret; |
845 | } | |
846 | ||
847 | static | |
9e550e5f | 848 | int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) |
e7a4393b JG |
849 | { |
850 | int ret = 0; | |
4f1f88a6 | 851 | const char *basename; |
e7a4393b | 852 | GError *error = NULL; |
4f1f88a6 | 853 | GDir *dir = NULL; |
3d731ea9 | 854 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 855 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
e7a4393b | 856 | |
94cf822e | 857 | /* Check each file in the path directory, except specific ones */ |
1a9f7075 | 858 | dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); |
e7a4393b | 859 | if (!dir) { |
5c3441d8 | 860 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open directory `%s`: %s (code %d)", |
1a9f7075 | 861 | ctf_fs_trace->path->str, error->message, |
4f1f88a6 | 862 | error->code); |
e7a4393b JG |
863 | goto error; |
864 | } | |
865 | ||
4f1f88a6 | 866 | while ((basename = g_dir_read_name(dir))) { |
94cf822e PP |
867 | struct ctf_fs_file *file; |
868 | ||
acfa8112 | 869 | if (strcmp(basename, CTF_FS_METADATA_FILENAME) == 0) { |
e7a4393b | 870 | /* Ignore the metadata stream. */ |
f67894f9 | 871 | BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`", |
1a9f7075 | 872 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
873 | continue; |
874 | } | |
875 | ||
4f1f88a6 | 876 | if (basename[0] == '.') { |
f67894f9 | 877 | BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`", |
1a9f7075 | 878 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
879 | continue; |
880 | } | |
881 | ||
882 | /* Create the file. */ | |
f67894f9 | 883 | file = ctf_fs_file_create(log_level, self_comp); |
e7a4393b | 884 | if (!file) { |
5c3441d8 SM |
885 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
886 | "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`", | |
1a9f7075 | 887 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
888 | goto error; |
889 | } | |
890 | ||
891 | /* Create full path string. */ | |
2c7bce29 | 892 | g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s", |
1a9f7075 | 893 | ctf_fs_trace->path->str, basename); |
e7a4393b | 894 | if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) { |
f67894f9 | 895 | BT_COMP_LOGI("Ignoring non-regular file `%s`", |
1a9f7075 | 896 | file->path->str); |
e7a4393b | 897 | ctf_fs_file_destroy(file); |
4f1f88a6 | 898 | file = NULL; |
e7a4393b JG |
899 | continue; |
900 | } | |
901 | ||
55314f2a | 902 | ret = ctf_fs_file_open(file, "rb"); |
4f1f88a6 | 903 | if (ret) { |
5c3441d8 SM |
904 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open stream file `%s`", |
905 | file->path->str); | |
e7a4393b JG |
906 | goto error; |
907 | } | |
908 | ||
9fa0891a JG |
909 | if (file->size == 0) { |
910 | /* Skip empty stream. */ | |
f67894f9 | 911 | BT_COMP_LOGI("Ignoring empty file `%s`", file->path->str); |
9fa0891a JG |
912 | ctf_fs_file_destroy(file); |
913 | continue; | |
914 | } | |
915 | ||
9e550e5f | 916 | ret = add_ds_file_to_ds_file_group(ctf_fs_trace, |
94cf822e | 917 | file->path->str); |
4f1f88a6 | 918 | if (ret) { |
5c3441d8 SM |
919 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
920 | "Cannot add stream file `%s` to stream file group", | |
1a9f7075 | 921 | file->path->str); |
94cf822e | 922 | ctf_fs_file_destroy(file); |
e7a4393b JG |
923 | goto error; |
924 | } | |
925 | ||
4f1f88a6 | 926 | ctf_fs_file_destroy(file); |
e7a4393b JG |
927 | } |
928 | ||
929 | goto end; | |
4f1f88a6 | 930 | |
e7a4393b JG |
931 | error: |
932 | ret = -1; | |
4f1f88a6 | 933 | |
e7a4393b JG |
934 | end: |
935 | if (dir) { | |
936 | g_dir_close(dir); | |
937 | dir = NULL; | |
938 | } | |
4f1f88a6 | 939 | |
e7a4393b JG |
940 | if (error) { |
941 | g_error_free(error); | |
942 | } | |
5b29e799 | 943 | |
91457551 | 944 | return ret; |
5b29e799 JG |
945 | } |
946 | ||
10b7a2e4 | 947 | static |
3d731ea9 | 948 | int set_trace_name(bt_trace *trace, const char *name_suffix, |
f67894f9 | 949 | bt_logging_level log_level, bt_self_component *self_comp) |
10b7a2e4 PP |
950 | { |
951 | int ret = 0; | |
8eee8ea2 | 952 | const bt_value *val; |
10b7a2e4 PP |
953 | GString *name; |
954 | ||
955 | name = g_string_new(NULL); | |
956 | if (!name) { | |
f67894f9 | 957 | BT_COMP_LOGE_STR("Failed to allocate a GString."); |
10b7a2e4 PP |
958 | ret = -1; |
959 | goto end; | |
960 | } | |
961 | ||
962 | /* | |
963 | * Check if we have a trace environment string value named `hostname`. | |
964 | * If so, use it as the trace name's prefix. | |
965 | */ | |
cd03c43c PP |
966 | val = bt_trace_borrow_environment_entry_value_by_name_const( |
967 | trace, "hostname"); | |
10b7a2e4 PP |
968 | if (val && bt_value_is_string(val)) { |
969 | g_string_append(name, bt_value_string_get(val)); | |
970 | ||
971 | if (name_suffix) { | |
972 | g_string_append_c(name, G_DIR_SEPARATOR); | |
973 | } | |
974 | } | |
975 | ||
976 | if (name_suffix) { | |
977 | g_string_append(name, name_suffix); | |
978 | } | |
979 | ||
980 | ret = bt_trace_set_name(trace, name->str); | |
981 | if (ret) { | |
982 | goto end; | |
983 | } | |
984 | ||
985 | goto end; | |
986 | ||
987 | end: | |
988 | if (name) { | |
989 | g_string_free(name, TRUE); | |
990 | } | |
991 | ||
992 | return ret; | |
993 | } | |
994 | ||
bf5b7748 | 995 | static |
f67894f9 | 996 | struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component *self_comp, |
e5e71bf8 | 997 | const char *path, const char *name, |
3d731ea9 PP |
998 | struct ctf_fs_metadata_config *metadata_config, |
999 | bt_logging_level log_level) | |
1a9f7075 PP |
1000 | { |
1001 | struct ctf_fs_trace *ctf_fs_trace; | |
1002 | int ret; | |
1003 | ||
1004 | ctf_fs_trace = g_new0(struct ctf_fs_trace, 1); | |
1005 | if (!ctf_fs_trace) { | |
1006 | goto end; | |
1007 | } | |
1008 | ||
3d731ea9 | 1009 | ctf_fs_trace->log_level = log_level; |
f67894f9 | 1010 | ctf_fs_trace->self_comp = self_comp; |
1a9f7075 PP |
1011 | ctf_fs_trace->path = g_string_new(path); |
1012 | if (!ctf_fs_trace->path) { | |
1013 | goto error; | |
1014 | } | |
1015 | ||
1a9f7075 PP |
1016 | ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1); |
1017 | if (!ctf_fs_trace->metadata) { | |
1018 | goto error; | |
1019 | } | |
1020 | ||
7b33a0e0 | 1021 | ctf_fs_metadata_init(ctf_fs_trace->metadata); |
94cf822e PP |
1022 | ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func( |
1023 | (GDestroyNotify) ctf_fs_ds_file_group_destroy); | |
1024 | if (!ctf_fs_trace->ds_file_groups) { | |
1025 | goto error; | |
1026 | } | |
1027 | ||
f67894f9 PP |
1028 | ret = ctf_fs_metadata_set_trace_class(self_comp, ctf_fs_trace, |
1029 | metadata_config); | |
10b7a2e4 PP |
1030 | if (ret) { |
1031 | goto error; | |
1032 | } | |
1033 | ||
e5e71bf8 PP |
1034 | if (ctf_fs_trace->metadata->trace_class) { |
1035 | ctf_fs_trace->trace = | |
1036 | bt_trace_create(ctf_fs_trace->metadata->trace_class); | |
1037 | if (!ctf_fs_trace->trace) { | |
1038 | goto error; | |
1039 | } | |
10b7a2e4 PP |
1040 | } |
1041 | ||
e5e71bf8 | 1042 | if (ctf_fs_trace->trace) { |
cd03c43c PP |
1043 | ret = ctf_trace_class_configure_ir_trace( |
1044 | ctf_fs_trace->metadata->tc, ctf_fs_trace->trace); | |
1045 | if (ret) { | |
1046 | goto error; | |
1047 | } | |
1048 | ||
f67894f9 PP |
1049 | ret = set_trace_name(ctf_fs_trace->trace, name, log_level, |
1050 | self_comp); | |
e5e71bf8 PP |
1051 | if (ret) { |
1052 | goto error; | |
1053 | } | |
1a9f7075 PP |
1054 | } |
1055 | ||
9e550e5f | 1056 | ret = create_ds_file_groups(ctf_fs_trace); |
94cf822e PP |
1057 | if (ret) { |
1058 | goto error; | |
1059 | } | |
1060 | ||
1a9f7075 PP |
1061 | goto end; |
1062 | ||
1063 | error: | |
1064 | ctf_fs_trace_destroy(ctf_fs_trace); | |
1065 | ctf_fs_trace = NULL; | |
7b33a0e0 | 1066 | |
1a9f7075 PP |
1067 | end: |
1068 | return ctf_fs_trace; | |
1069 | } | |
1070 | ||
1071 | static | |
1072 | int path_is_ctf_trace(const char *path) | |
1073 | { | |
1074 | GString *metadata_path = g_string_new(NULL); | |
1075 | int ret = 0; | |
1076 | ||
1077 | if (!metadata_path) { | |
1078 | ret = -1; | |
1079 | goto end; | |
1080 | } | |
1081 | ||
2c7bce29 | 1082 | g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); |
1a9f7075 PP |
1083 | |
1084 | if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { | |
1085 | ret = 1; | |
1086 | goto end; | |
1087 | } | |
1088 | ||
1089 | end: | |
1090 | g_string_free(metadata_path, TRUE); | |
1091 | return ret; | |
1092 | } | |
1093 | ||
aab89afc | 1094 | /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */ |
bf5b7748 | 1095 | |
1a9f7075 | 1096 | static |
aab89afc | 1097 | int ctf_fs_component_create_ctf_fs_trace_one_path( |
e5e71bf8 | 1098 | struct ctf_fs_component *ctf_fs, |
5c3441d8 | 1099 | const char *path_param, |
aab89afc | 1100 | GPtrArray *traces, |
5c3441d8 SM |
1101 | bt_self_component *self_comp, |
1102 | bt_self_component_class *self_comp_class) | |
1a9f7075 | 1103 | { |
54e1a1aa SM |
1104 | struct ctf_fs_trace *ctf_fs_trace; |
1105 | int ret; | |
1106 | GString *norm_path; | |
3d731ea9 | 1107 | bt_logging_level log_level = ctf_fs->log_level; |
1a9f7075 | 1108 | |
4bd72b60 PP |
1109 | norm_path = bt_common_normalize_path(path_param, NULL); |
1110 | if (!norm_path) { | |
5c3441d8 SM |
1111 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
1112 | "Failed to normalize path: `%s`.", path_param); | |
4bd72b60 PP |
1113 | goto error; |
1114 | } | |
1115 | ||
54e1a1aa SM |
1116 | ret = path_is_ctf_trace(norm_path->str); |
1117 | if (ret < 0) { | |
1118 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
1119 | "Failed to check if path is a CTF trace: path=%s", norm_path->str); | |
1120 | goto error; | |
1121 | } else if (ret == 0) { | |
1122 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
1123 | "Path is not a CTF trace (does not contain a metadata file): `%s`.", norm_path->str); | |
1a9f7075 PP |
1124 | goto error; |
1125 | } | |
1126 | ||
54e1a1aa SM |
1127 | // FIXME: Remove or ifdef for __MINGW32__ |
1128 | if (strcmp(norm_path->str, "/") == 0) { | |
5c3441d8 | 1129 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
54e1a1aa SM |
1130 | "Opening a trace in `/` is not supported."); |
1131 | ret = -1; | |
1132 | goto end; | |
1a9f7075 PP |
1133 | } |
1134 | ||
54e1a1aa SM |
1135 | ctf_fs_trace = ctf_fs_trace_create(self_comp, norm_path->str, |
1136 | norm_path->str, &ctf_fs->metadata_config, log_level); | |
1137 | if (!ctf_fs_trace) { | |
1138 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create trace for `%s`.", | |
1139 | norm_path->str); | |
1a9f7075 PP |
1140 | goto error; |
1141 | } | |
1142 | ||
aab89afc | 1143 | g_ptr_array_add(traces, ctf_fs_trace); |
54e1a1aa | 1144 | ctf_fs_trace = NULL; |
1a9f7075 | 1145 | |
54e1a1aa | 1146 | ret = 0; |
1a9f7075 PP |
1147 | goto end; |
1148 | ||
1149 | error: | |
1150 | ret = -1; | |
1a9f7075 PP |
1151 | |
1152 | end: | |
4bd72b60 PP |
1153 | if (norm_path) { |
1154 | g_string_free(norm_path, TRUE); | |
1155 | } | |
1156 | ||
1a9f7075 PP |
1157 | return ret; |
1158 | } | |
1159 | ||
adb623c2 SM |
1160 | /* |
1161 | * Count the number of stream and event classes defined by this trace's metadata. | |
1162 | * | |
1163 | * This is used to determine which metadata is the "latest", out of multiple | |
1164 | * traces sharing the same UUID. It is assumed that amongst all these metadatas, | |
1165 | * a bigger metadata is a superset of a smaller metadata. Therefore, it is | |
1166 | * enough to just count the classes. | |
1167 | */ | |
1168 | ||
1169 | static | |
1170 | unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace) | |
1171 | { | |
1172 | unsigned int num = trace->metadata->tc->stream_classes->len; | |
1173 | guint i; | |
1174 | ||
1175 | for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) { | |
1176 | struct ctf_stream_class *sc = trace->metadata->tc->stream_classes->pdata[i]; | |
1177 | num += sc->event_classes->len; | |
1178 | } | |
1179 | ||
1180 | return num; | |
1181 | } | |
1182 | ||
1183 | /* | |
1184 | * Merge the src ds_file_group into dest. This consists of merging their | |
1185 | * ds_file_infos, making sure to keep the result sorted. | |
1186 | */ | |
1187 | ||
1188 | static | |
1189 | void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, struct ctf_fs_ds_file_group *src) | |
1190 | { | |
1191 | guint i; | |
1192 | ||
1193 | for (i = 0; i < src->ds_file_infos->len; i++) { | |
1194 | struct ctf_fs_ds_file_info *ds_file_info = | |
1195 | g_ptr_array_index(src->ds_file_infos, i); | |
1196 | ||
1197 | /* Ownership of the ds_file_info is transferred to dest. */ | |
1198 | g_ptr_array_index(src->ds_file_infos, i) = NULL; | |
1199 | ||
1200 | ds_file_group_insert_ds_file_info_sorted(dest, ds_file_info); | |
1201 | } | |
adb623c2 | 1202 | |
779f4a23 FD |
1203 | /* Merge both indexes. */ |
1204 | for (i = 0; i < src->index->entries->len; i++) { | |
1205 | struct ctf_fs_ds_index_entry *entry = g_ptr_array_index( | |
1206 | src->index->entries, i); | |
1207 | ||
1208 | /* | |
1209 | * Ownership of the ctf_fs_ds_index_entry is transferred to | |
1210 | * dest. | |
1211 | */ | |
1212 | g_ptr_array_index(src->index->entries, i) = NULL; | |
1213 | ||
1214 | ds_file_group_insert_ds_index_entry_sorted(dest, entry); | |
1215 | } | |
1216 | } | |
adb623c2 SM |
1217 | /* Merge src_trace's data stream file groups into dest_trace's. */ |
1218 | ||
1219 | static | |
f80e9344 | 1220 | int merge_matching_ctf_fs_ds_file_groups( |
adb623c2 SM |
1221 | struct ctf_fs_trace *dest_trace, |
1222 | struct ctf_fs_trace *src_trace) | |
1223 | { | |
1224 | ||
1225 | GPtrArray *dest = dest_trace->ds_file_groups; | |
1226 | GPtrArray *src = src_trace->ds_file_groups; | |
1227 | guint s_i; | |
f80e9344 | 1228 | int ret = 0; |
adb623c2 SM |
1229 | |
1230 | /* | |
1231 | * Save the initial length of dest: we only want to check against the | |
1232 | * original elements in the inner loop. | |
1233 | */ | |
1234 | const guint dest_len = dest->len; | |
1235 | ||
1236 | for (s_i = 0; s_i < src->len; s_i++) { | |
1237 | struct ctf_fs_ds_file_group *src_group = g_ptr_array_index(src, s_i); | |
1238 | struct ctf_fs_ds_file_group *dest_group = NULL; | |
1239 | ||
1240 | /* A stream instance without ID can't match a stream in the other trace. */ | |
1241 | if (src_group->stream_id != -1) { | |
1242 | guint d_i; | |
1243 | ||
1244 | /* Let's search for a matching ds_file_group in the destination. */ | |
1245 | for (d_i = 0; d_i < dest_len; d_i++) { | |
1246 | struct ctf_fs_ds_file_group *candidate_dest = g_ptr_array_index(dest, d_i); | |
1247 | ||
1248 | /* Can't match a stream instance without ID. */ | |
1249 | if (candidate_dest->stream_id == -1) { | |
1250 | continue; | |
1251 | } | |
1252 | ||
1253 | /* | |
1254 | * If the two groups have the same stream instance id | |
1255 | * and belong to the same stream class (stream instance | |
1256 | * ids are per-stream class), they represent the same | |
1257 | * stream instance. | |
1258 | */ | |
1259 | if (candidate_dest->stream_id != src_group->stream_id || | |
1260 | candidate_dest->sc->id != src_group->sc->id) { | |
1261 | continue; | |
1262 | } | |
1263 | ||
1264 | dest_group = candidate_dest; | |
1265 | break; | |
1266 | } | |
1267 | } | |
1268 | ||
1269 | /* | |
1270 | * Didn't find a friend in dest to merge our src_group into? | |
779f4a23 FD |
1271 | * Create a new empty one. This can happen if a stream was |
1272 | * active in the source trace chunk but not in the destination | |
1273 | * trace chunk. | |
adb623c2 SM |
1274 | */ |
1275 | if (!dest_group) { | |
1276 | struct ctf_stream_class *sc; | |
779f4a23 | 1277 | struct ctf_fs_ds_index *index; |
adb623c2 SM |
1278 | |
1279 | sc = ctf_trace_class_borrow_stream_class_by_id( | |
1280 | dest_trace->metadata->tc, src_group->sc->id); | |
1281 | BT_ASSERT(sc); | |
1282 | ||
f67894f9 PP |
1283 | index = ctf_fs_ds_index_create(dest_trace->log_level, |
1284 | dest_trace->self_comp); | |
779f4a23 FD |
1285 | if (!index) { |
1286 | ret = -1; | |
1287 | goto end; | |
1288 | } | |
1289 | ||
adb623c2 | 1290 | dest_group = ctf_fs_ds_file_group_create(dest_trace, sc, |
779f4a23 FD |
1291 | src_group->stream_id, index); |
1292 | /* Ownership of index is transferred. */ | |
1293 | index = NULL; | |
f80e9344 FD |
1294 | if (!dest_group) { |
1295 | ret = -1; | |
1296 | goto end; | |
1297 | } | |
adb623c2 SM |
1298 | |
1299 | g_ptr_array_add(dest_trace->ds_file_groups, dest_group); | |
1300 | } | |
1301 | ||
1302 | BT_ASSERT(dest_group); | |
1303 | merge_ctf_fs_ds_file_groups(dest_group, src_group); | |
1304 | } | |
f80e9344 FD |
1305 | |
1306 | end: | |
1307 | return ret; | |
adb623c2 SM |
1308 | } |
1309 | ||
1310 | /* | |
1311 | * Collapse the given traces, which must all share the same UUID, in a single | |
1312 | * one. | |
1313 | * | |
1314 | * The trace with the most expansive metadata is chosen and all other traces | |
1315 | * are merged into that one. The array slots of all the traces that get merged | |
1316 | * in the chosen one are set to NULL, so only the slot of the chosen trace | |
1317 | * remains non-NULL. | |
1318 | */ | |
1319 | ||
1320 | static | |
aab89afc SM |
1321 | int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces, |
1322 | struct ctf_fs_trace **out_trace) | |
adb623c2 SM |
1323 | { |
1324 | unsigned int winner_count; | |
1325 | struct ctf_fs_trace *winner; | |
aab89afc | 1326 | guint i, winner_i; |
f80e9344 | 1327 | int ret = 0; |
adb623c2 SM |
1328 | |
1329 | BT_ASSERT(num_traces >= 2); | |
1330 | ||
1331 | winner_count = metadata_count_stream_and_event_classes(traces[0]); | |
1332 | winner = traces[0]; | |
aab89afc | 1333 | winner_i = 0; |
adb623c2 SM |
1334 | |
1335 | /* Find the trace with the largest metadata. */ | |
1336 | for (i = 1; i < num_traces; i++) { | |
1337 | struct ctf_fs_trace *candidate; | |
1338 | unsigned int candidate_count; | |
1339 | ||
1340 | candidate = traces[i]; | |
1341 | ||
1342 | /* A bit of sanity check. */ | |
1343 | BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0); | |
1344 | ||
1345 | candidate_count = metadata_count_stream_and_event_classes(candidate); | |
1346 | ||
1347 | if (candidate_count > winner_count) { | |
1348 | winner_count = candidate_count; | |
1349 | winner = candidate; | |
aab89afc | 1350 | winner_i = i; |
adb623c2 SM |
1351 | } |
1352 | } | |
1353 | ||
1354 | /* Merge all the other traces in the winning trace. */ | |
1355 | for (i = 0; i < num_traces; i++) { | |
1356 | struct ctf_fs_trace *trace = traces[i]; | |
1357 | ||
1358 | /* Don't merge the winner into itself. */ | |
1359 | if (trace == winner) { | |
1360 | continue; | |
1361 | } | |
1362 | ||
1363 | /* Merge trace's data stream file groups into winner's. */ | |
f80e9344 FD |
1364 | ret = merge_matching_ctf_fs_ds_file_groups(winner, trace); |
1365 | if (ret) { | |
1366 | goto end; | |
1367 | } | |
adb623c2 SM |
1368 | } |
1369 | ||
aab89afc SM |
1370 | /* |
1371 | * Move the winner out of the array, into `*out_trace`. | |
1372 | */ | |
1373 | *out_trace = winner; | |
1374 | traces[winner_i] = NULL; | |
f80e9344 FD |
1375 | |
1376 | end: | |
1377 | return ret; | |
adb623c2 SM |
1378 | } |
1379 | ||
df7002e4 FD |
1380 | enum target_event { |
1381 | FIRST_EVENT, | |
1382 | LAST_EVENT, | |
1383 | }; | |
1384 | ||
1385 | static | |
1386 | int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace, | |
1387 | struct ctf_clock_class *default_cc, | |
1388 | struct ctf_fs_ds_index_entry *index_entry, | |
1389 | enum target_event target_event, uint64_t *cs, int64_t *ts_ns) | |
1390 | { | |
1391 | enum bt_msg_iter_status iter_status = BT_MSG_ITER_STATUS_OK; | |
1392 | struct ctf_fs_ds_file *ds_file = NULL; | |
1393 | struct bt_msg_iter *msg_iter = NULL; | |
1394 | bt_logging_level log_level = ctf_fs_trace->log_level; | |
1395 | bt_self_component *self_comp = ctf_fs_trace->self_comp; | |
1396 | int ret = 0; | |
1397 | ||
1398 | BT_ASSERT(ctf_fs_trace); | |
1399 | BT_ASSERT(ctf_fs_trace->metadata); | |
1400 | BT_ASSERT(ctf_fs_trace->metadata->tc); | |
1401 | ||
1402 | msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc, | |
1403 | bt_common_get_page_size(log_level) * 8, ctf_fs_ds_file_medops, | |
1404 | NULL, log_level, self_comp); | |
1405 | if (!msg_iter) { | |
1406 | /* bt_msg_iter_create() logs errors. */ | |
1407 | ret = -1; | |
1408 | goto end; | |
1409 | } | |
1410 | ||
1411 | BT_ASSERT(index_entry); | |
1412 | BT_ASSERT(index_entry->path); | |
1413 | ||
1414 | ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter, | |
1415 | NULL, index_entry->path, log_level); | |
1416 | if (!ds_file) { | |
5c3441d8 | 1417 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create a ctf_fs_ds_file"); |
df7002e4 FD |
1418 | ret = -1; |
1419 | goto end; | |
1420 | } | |
1421 | ||
1422 | /* | |
1423 | * Turn on dry run mode to prevent the creation and usage of Babeltrace | |
1424 | * library objects (bt_field, bt_message_*, etc.). | |
1425 | */ | |
1426 | bt_msg_iter_set_dry_run(msg_iter, true); | |
1427 | ||
1428 | /* Seek to the beginning of the target packet. */ | |
1429 | iter_status = bt_msg_iter_seek(ds_file->msg_iter, index_entry->offset); | |
1430 | if (iter_status) { | |
1431 | /* bt_msg_iter_seek() logs errors. */ | |
1432 | ret = -1; | |
1433 | goto end; | |
1434 | } | |
1435 | ||
1436 | switch (target_event) { | |
1437 | case FIRST_EVENT: | |
1438 | /* | |
1439 | * Start to decode the packet until we reach the end of | |
1440 | * the first event. To extract the first event's clock | |
1441 | * snapshot. | |
1442 | */ | |
1443 | iter_status = bt_msg_iter_curr_packet_first_event_clock_snapshot( | |
1444 | ds_file->msg_iter, cs); | |
1445 | break; | |
1446 | case LAST_EVENT: | |
1447 | /* Decode the packet to extract the last event's clock snapshot. */ | |
1448 | iter_status = bt_msg_iter_curr_packet_last_event_clock_snapshot( | |
1449 | ds_file->msg_iter, cs); | |
1450 | break; | |
1451 | default: | |
1452 | abort(); | |
1453 | } | |
1454 | if (iter_status) { | |
1455 | ret = -1; | |
1456 | goto end; | |
1457 | } | |
1458 | ||
1459 | /* Convert clock snapshot to timestamp. */ | |
1460 | ret = bt_util_clock_cycles_to_ns_from_origin(*cs, | |
1461 | default_cc->frequency, default_cc->offset_seconds, | |
1462 | default_cc->offset_cycles, ts_ns); | |
1463 | if (ret) { | |
5c3441d8 SM |
1464 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1465 | "Failed to convert clock snapshot to timestamp"); | |
df7002e4 FD |
1466 | goto end; |
1467 | } | |
1468 | ||
1469 | end: | |
1470 | if (ds_file) { | |
1471 | ctf_fs_ds_file_destroy(ds_file); | |
1472 | } | |
1473 | if (msg_iter) { | |
1474 | bt_msg_iter_destroy(msg_iter); | |
1475 | } | |
1476 | ||
1477 | return ret; | |
1478 | } | |
1479 | ||
37ea728c FD |
1480 | static |
1481 | int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, | |
1482 | struct ctf_clock_class *default_cc, | |
1483 | struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns) | |
1484 | { | |
1485 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, | |
1486 | index_entry, FIRST_EVENT, cs, ts_ns); | |
1487 | } | |
1488 | ||
df7002e4 FD |
1489 | static |
1490 | int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, | |
1491 | struct ctf_clock_class *default_cc, | |
1492 | struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns) | |
1493 | { | |
1494 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, | |
1495 | index_entry, LAST_EVENT, cs, ts_ns); | |
1496 | } | |
1497 | ||
1498 | /* | |
1499 | * Fix up packet index entries for lttng's "event-after-packet" bug. | |
1500 | * Some buggy lttng tracer versions may emit events with a timestamp that is | |
1501 | * larger (after) than the timestamp_end of the their packets. | |
1502 | * | |
1503 | * To fix up this erroneous data we do the following: | |
1504 | * 1. If it's not the stream file's last packet: set the packet index entry's | |
1505 | * end time to the next packet's beginning time. | |
1506 | * 2. If it's the stream file's last packet, set the packet index entry's end | |
1507 | * time to the packet's last event's time, if any, or to the packet's | |
1508 | * beginning time otherwise. | |
1509 | * | |
1510 | * Known buggy tracer versions: | |
1511 | * - before lttng-ust 2.11.0 | |
1512 | * - before lttng-module 2.11.0 | |
1513 | * - before lttng-module 2.10.10 | |
1514 | * - before lttng-module 2.9.13 | |
1515 | */ | |
1516 | static | |
1517 | int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace) | |
1518 | { | |
1519 | int ret = 0; | |
1520 | guint ds_file_group_i; | |
1521 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1522 | bt_logging_level log_level = trace->log_level; | |
1523 | ||
1524 | for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len; | |
1525 | ds_file_group_i++) { | |
1526 | guint entry_i; | |
1527 | struct ctf_clock_class *default_cc; | |
1528 | struct ctf_fs_ds_index_entry *last_entry; | |
1529 | struct ctf_fs_ds_index *index; | |
1530 | ||
1531 | struct ctf_fs_ds_file_group *ds_file_group = | |
1532 | g_ptr_array_index(ds_file_groups, ds_file_group_i); | |
1533 | ||
1534 | BT_ASSERT(ds_file_group); | |
1535 | index = ds_file_group->index; | |
1536 | ||
1537 | BT_ASSERT(index); | |
1538 | BT_ASSERT(index->entries); | |
1539 | BT_ASSERT(index->entries->len > 0); | |
1540 | ||
1541 | /* | |
1542 | * Iterate over all entries but the last one. The last one is | |
1543 | * fixed differently after. | |
1544 | */ | |
1545 | for (entry_i = 0; entry_i < index->entries->len - 1; | |
1546 | entry_i++) { | |
1547 | struct ctf_fs_ds_index_entry *curr_entry, *next_entry; | |
1548 | ||
1549 | curr_entry = g_ptr_array_index(index->entries, entry_i); | |
1550 | next_entry = g_ptr_array_index(index->entries, entry_i + 1); | |
1551 | ||
1552 | /* | |
1553 | * 1. Set the current index entry `end` timestamp to | |
1554 | * the next index entry `begin` timestamp. | |
1555 | */ | |
1556 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1557 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1558 | } | |
1559 | ||
1560 | /* | |
1561 | * 2. Fix the last entry by decoding the last event of the last | |
1562 | * packet. | |
1563 | */ | |
1564 | last_entry = g_ptr_array_index(index->entries, | |
1565 | index->entries->len - 1); | |
1566 | BT_ASSERT(last_entry); | |
1567 | ||
1568 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1569 | default_cc = ds_file_group->sc->default_clock_class; | |
1570 | ||
1571 | /* | |
1572 | * Decode packet to read the timestamp of the last event of the | |
1573 | * entry. | |
1574 | */ | |
1575 | ret = decode_packet_last_event_timestamp(trace, default_cc, | |
1576 | last_entry, &last_entry->timestamp_end, | |
1577 | &last_entry->timestamp_end_ns); | |
1578 | if (ret) { | |
5c3441d8 SM |
1579 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1580 | "Failed to decode stream's last packet to get its last event's clock snapshot."); | |
df7002e4 FD |
1581 | goto end; |
1582 | } | |
1583 | } | |
1584 | ||
1585 | end: | |
1586 | return ret; | |
1587 | } | |
1588 | ||
37ea728c FD |
1589 | /* |
1590 | * Fix up packet index entries for barectf's "event-before-packet" bug. | |
1591 | * Some buggy barectf tracer versions may emit events with a timestamp that is | |
1592 | * less than the timestamp_begin of the their packets. | |
1593 | * | |
1594 | * To fix up this erroneous data we do the following: | |
1595 | * 1. Starting at the second index entry, set the timestamp_begin of the | |
1596 | * current entry to the timestamp of the first event of the packet. | |
1597 | * 2. Set the previous entry's timestamp_end to the timestamp_begin of the | |
1598 | * current packet. | |
1599 | * | |
1600 | * Known buggy tracer versions: | |
1601 | * - before barectf 2.3.1 | |
1602 | */ | |
1603 | static | |
1604 | int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace) | |
1605 | { | |
1606 | int ret = 0; | |
1607 | guint ds_file_group_i; | |
1608 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1609 | bt_logging_level log_level = trace->log_level; | |
1610 | ||
1611 | for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len; | |
1612 | ds_file_group_i++) { | |
1613 | guint entry_i; | |
1614 | struct ctf_clock_class *default_cc; | |
1615 | struct ctf_fs_ds_file_group *ds_file_group = | |
1616 | g_ptr_array_index(ds_file_groups, ds_file_group_i); | |
1617 | ||
1618 | struct ctf_fs_ds_index *index = ds_file_group->index; | |
1619 | ||
1620 | BT_ASSERT(index); | |
1621 | BT_ASSERT(index->entries); | |
1622 | BT_ASSERT(index->entries->len > 0); | |
1623 | ||
1624 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1625 | default_cc = ds_file_group->sc->default_clock_class; | |
1626 | ||
1627 | /* | |
1628 | * 1. Iterate over the index, starting from the second entry | |
1629 | * (index = 1). | |
1630 | */ | |
1631 | for (entry_i = 1; entry_i < index->entries->len; | |
1632 | entry_i++) { | |
1633 | struct ctf_fs_ds_index_entry *curr_entry, *prev_entry; | |
1634 | prev_entry = g_ptr_array_index(index->entries, entry_i - 1); | |
1635 | curr_entry = g_ptr_array_index(index->entries, entry_i); | |
1636 | /* | |
1637 | * 2. Set the current entry `begin` timestamp to the | |
1638 | * timestamp of the first event of the current packet. | |
1639 | */ | |
1640 | ret = decode_packet_first_event_timestamp(trace, default_cc, | |
1641 | curr_entry, &curr_entry->timestamp_begin, | |
1642 | &curr_entry->timestamp_begin_ns); | |
1643 | if (ret) { | |
5c3441d8 SM |
1644 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1645 | "Failed to decode first event's clock snapshot"); | |
37ea728c FD |
1646 | goto end; |
1647 | } | |
1648 | ||
1649 | /* | |
1650 | * 3. Set the previous entry `end` timestamp to the | |
1651 | * timestamp of the first event of the current packet. | |
1652 | */ | |
1653 | prev_entry->timestamp_end = curr_entry->timestamp_begin; | |
1654 | prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns; | |
1655 | } | |
1656 | } | |
1657 | end: | |
1658 | return ret; | |
1659 | } | |
1660 | ||
7645f10f FD |
1661 | /* |
1662 | * When using the lttng-crash feature it's likely that the last packets of each | |
1663 | * stream have their timestamp_end set to zero. This is caused by the fact that | |
1664 | * the tracer crashed and was not able to properly close the packets. | |
1665 | * | |
1666 | * To fix up this erroneous data we do the following: | |
1667 | * For each index entry, if the entry's timestamp_end is 0 and the | |
1668 | * timestamp_begin is not 0: | |
1669 | * - If it's the stream file's last packet: set the packet index entry's end | |
1670 | * time to the packet's last event's time, if any, or to the packet's | |
1671 | * beginning time otherwise. | |
1672 | * - If it's not the stream file's last packet: set the packet index | |
1673 | * entry's end time to the next packet's beginning time. | |
1674 | * | |
1675 | * Affected versions: | |
1676 | * - All current and future lttng-ust and lttng-modules versions. | |
1677 | */ | |
1678 | static | |
1679 | int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace) | |
1680 | { | |
1681 | int ret = 0; | |
1682 | guint ds_file_group_idx; | |
1683 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1684 | bt_logging_level log_level = trace->log_level; | |
1685 | ||
1686 | for (ds_file_group_idx = 0; ds_file_group_idx < ds_file_groups->len; | |
1687 | ds_file_group_idx++) { | |
1688 | guint entry_idx; | |
1689 | struct ctf_clock_class *default_cc; | |
1690 | struct ctf_fs_ds_index_entry *last_entry; | |
1691 | struct ctf_fs_ds_index *index; | |
1692 | ||
1693 | struct ctf_fs_ds_file_group *ds_file_group = | |
1694 | g_ptr_array_index(ds_file_groups, ds_file_group_idx); | |
1695 | ||
1696 | BT_ASSERT(ds_file_group); | |
1697 | index = ds_file_group->index; | |
1698 | ||
1699 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1700 | default_cc = ds_file_group->sc->default_clock_class; | |
1701 | ||
1702 | BT_ASSERT(index); | |
1703 | BT_ASSERT(index->entries); | |
1704 | BT_ASSERT(index->entries->len > 0); | |
1705 | ||
1706 | last_entry = g_ptr_array_index(index->entries, | |
1707 | index->entries->len - 1); | |
1708 | BT_ASSERT(last_entry); | |
1709 | ||
1710 | ||
1711 | /* 1. Fix the last entry first. */ | |
1712 | if (last_entry->timestamp_end == 0 && | |
1713 | last_entry->timestamp_begin != 0) { | |
1714 | /* | |
1715 | * Decode packet to read the timestamp of the | |
1716 | * last event of the stream file. | |
1717 | */ | |
1718 | ret = decode_packet_last_event_timestamp(trace, | |
1719 | default_cc, last_entry, | |
1720 | &last_entry->timestamp_end, | |
1721 | &last_entry->timestamp_end_ns); | |
1722 | if (ret) { | |
5c3441d8 SM |
1723 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1724 | "Failed to decode last event's clock snapshot"); | |
7645f10f FD |
1725 | goto end; |
1726 | } | |
1727 | } | |
1728 | ||
1729 | /* Iterate over all entries but the last one. */ | |
1730 | for (entry_idx = 0; entry_idx < index->entries->len - 1; | |
1731 | entry_idx++) { | |
1732 | struct ctf_fs_ds_index_entry *curr_entry, *next_entry; | |
1733 | curr_entry = g_ptr_array_index(index->entries, entry_idx); | |
1734 | next_entry = g_ptr_array_index(index->entries, entry_idx + 1); | |
1735 | ||
1736 | if (curr_entry->timestamp_end == 0 && | |
1737 | curr_entry->timestamp_begin != 0) { | |
1738 | /* | |
1739 | * 2. Set the current index entry `end` timestamp to | |
1740 | * the next index entry `begin` timestamp. | |
1741 | */ | |
1742 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1743 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1744 | } | |
1745 | } | |
1746 | } | |
1747 | ||
1748 | end: | |
1749 | return ret; | |
1750 | } | |
1751 | ||
7b4d28d0 FD |
1752 | /* |
1753 | * Extract the tracer information necessary to compare versions. | |
1754 | * Returns 0 on success, and -1 if the extraction is not successful because the | |
1755 | * necessary fields are absents in the trace metadata. | |
1756 | */ | |
1757 | static | |
7b4d28d0 FD |
1758 | int extract_tracer_info(struct ctf_fs_trace *trace, |
1759 | struct tracer_info *current_tracer_info) | |
1760 | { | |
1761 | int ret = 0; | |
1762 | struct ctf_trace_class_env_entry *entry; | |
1763 | ||
1764 | /* Clear the current_tracer_info struct */ | |
1765 | memset(current_tracer_info, 0, sizeof(*current_tracer_info)); | |
1766 | ||
1767 | /* | |
1768 | * To compare 2 tracer versions, at least the tracer name and it's | |
1769 | * major version are needed. If one of these is missing, consider it an | |
1770 | * extraction failure. | |
1771 | */ | |
1772 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1773 | trace->metadata->tc, "tracer_name"); | |
1774 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR) { | |
1775 | goto missing_bare_minimum; | |
1776 | } | |
1777 | ||
1778 | /* Set tracer name. */ | |
1779 | current_tracer_info->name = entry->value.str->str; | |
1780 | ||
1781 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1782 | trace->metadata->tc, "tracer_major"); | |
1783 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1784 | goto missing_bare_minimum; | |
1785 | } | |
1786 | ||
1787 | /* Set major version number. */ | |
1788 | current_tracer_info->major = entry->value.i; | |
1789 | ||
1790 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1791 | trace->metadata->tc, "tracer_minor"); | |
1792 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1793 | goto end; | |
1794 | } | |
1795 | ||
1796 | /* Set minor version number. */ | |
1797 | current_tracer_info->minor = entry->value.i; | |
1798 | ||
1799 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1800 | trace->metadata->tc, "tracer_patch"); | |
1801 | if (!entry) { | |
1802 | /* | |
1803 | * If `tracer_patch` doesn't exist `tracer_patchlevel` might. | |
1804 | * For example, `lttng-modules` uses entry name | |
1805 | * `tracer_patchlevel`. | |
1806 | */ | |
1807 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1808 | trace->metadata->tc, "tracer_patchlevel"); | |
1809 | } | |
1810 | ||
1811 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1812 | goto end; | |
1813 | } | |
1814 | ||
1815 | /* Set patch version number. */ | |
1816 | current_tracer_info->patch = entry->value.i; | |
1817 | ||
1818 | goto end; | |
1819 | ||
1820 | missing_bare_minimum: | |
1821 | ret = -1; | |
1822 | end: | |
1823 | return ret; | |
1824 | } | |
1825 | ||
df7002e4 FD |
1826 | static |
1827 | bool is_tracer_affected_by_lttng_event_after_packet_bug( | |
1828 | struct tracer_info *curr_tracer_info) | |
1829 | { | |
1830 | bool is_affected = false; | |
1831 | ||
1832 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1833 | if (curr_tracer_info->major < 2) { | |
1834 | is_affected = true; | |
1835 | } else if (curr_tracer_info->major == 2) { | |
1836 | /* fixed in lttng-ust 2.11.0 */ | |
1837 | if (curr_tracer_info->minor < 11) { | |
1838 | is_affected = true; | |
1839 | } | |
1840 | } | |
1841 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1842 | if (curr_tracer_info->major < 2) { | |
1843 | is_affected = true; | |
1844 | } else if (curr_tracer_info->major == 2) { | |
1845 | /* fixed in lttng-modules 2.11.0 */ | |
1846 | if (curr_tracer_info->minor == 10) { | |
1847 | /* fixed in lttng-modules 2.10.10 */ | |
1848 | if (curr_tracer_info->patch < 10) { | |
1849 | is_affected = true; | |
1850 | } | |
1851 | } else if (curr_tracer_info->minor == 9) { | |
1852 | /* fixed in lttng-modules 2.9.13 */ | |
1853 | if (curr_tracer_info->patch < 13) { | |
1854 | is_affected = true; | |
1855 | } | |
1856 | } else if (curr_tracer_info->minor < 9) { | |
1857 | is_affected = true; | |
1858 | } | |
1859 | } | |
1860 | } | |
1861 | ||
1862 | return is_affected; | |
1863 | } | |
1864 | ||
37ea728c FD |
1865 | static |
1866 | bool is_tracer_affected_by_barectf_event_before_packet_bug( | |
1867 | struct tracer_info *curr_tracer_info) | |
1868 | { | |
1869 | bool is_affected = false; | |
1870 | ||
1871 | if (strcmp(curr_tracer_info->name, "barectf") == 0) { | |
1872 | if (curr_tracer_info->major < 2) { | |
1873 | is_affected = true; | |
1874 | } else if (curr_tracer_info->major == 2) { | |
1875 | if (curr_tracer_info->minor < 3) { | |
1876 | is_affected = true; | |
1877 | } else if (curr_tracer_info->minor == 3) { | |
1878 | /* fixed in barectf 2.3.1 */ | |
1879 | if (curr_tracer_info->patch < 1) { | |
1880 | is_affected = true; | |
1881 | } | |
1882 | } | |
1883 | } | |
1884 | } | |
1885 | ||
1886 | return is_affected; | |
1887 | } | |
1888 | ||
7645f10f FD |
1889 | static |
1890 | bool is_tracer_affected_by_lttng_crash_quirk( | |
1891 | struct tracer_info *curr_tracer_info) | |
1892 | { | |
1893 | bool is_affected = false; | |
1894 | ||
1895 | /* All LTTng tracer may be affected by this lttng crash quirk. */ | |
1896 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1897 | is_affected = true; | |
1898 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1899 | is_affected = true; | |
1900 | } | |
1901 | ||
1902 | return is_affected; | |
1903 | } | |
1904 | ||
df7002e4 FD |
1905 | /* |
1906 | * Looks for trace produced by known buggy tracers and fix up the index | |
1907 | * produced earlier. | |
1908 | */ | |
1909 | static | |
5c3441d8 SM |
1910 | int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs, |
1911 | bt_self_component *self_comp) | |
df7002e4 FD |
1912 | { |
1913 | int ret = 0; | |
df7002e4 | 1914 | struct tracer_info current_tracer_info; |
df7002e4 FD |
1915 | bt_logging_level log_level = ctf_fs->log_level; |
1916 | ||
aab89afc SM |
1917 | ret = extract_tracer_info(ctf_fs->trace, ¤t_tracer_info); |
1918 | if (ret) { | |
1919 | /* | |
1920 | * A trace may not have all the necessary environment | |
1921 | * entries to do the tracer version comparison. | |
1922 | * At least, the tracer name and major version number | |
1923 | * are needed. Failing to extract these entries is not | |
1924 | * an error. | |
1925 | */ | |
1926 | ret = 0; | |
1927 | BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions."); | |
1928 | goto end;; | |
1929 | } | |
df7002e4 | 1930 | |
aab89afc SM |
1931 | /* Check if the trace may be affected by old tracer bugs. */ |
1932 | if (is_tracer_affected_by_lttng_event_after_packet_bug( | |
1933 | ¤t_tracer_info)) { | |
1934 | BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up."); | |
1935 | ret = fix_index_lttng_event_after_packet_bug(ctf_fs->trace); | |
df7002e4 | 1936 | if (ret) { |
aab89afc SM |
1937 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1938 | "Failed to fix LTTng event-after-packet bug."); | |
1939 | goto end; | |
df7002e4 | 1940 | } |
aab89afc SM |
1941 | ctf_fs->trace->metadata->tc->quirks.lttng_event_after_packet = true; |
1942 | } | |
37ea728c | 1943 | |
aab89afc SM |
1944 | if (is_tracer_affected_by_barectf_event_before_packet_bug( |
1945 | ¤t_tracer_info)) { | |
1946 | BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up."); | |
1947 | ret = fix_index_barectf_event_before_packet_bug(ctf_fs->trace); | |
1948 | if (ret) { | |
1949 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1950 | "Failed to fix barectf event-before-packet bug."); | |
1951 | goto end; | |
37ea728c | 1952 | } |
aab89afc SM |
1953 | ctf_fs->trace->metadata->tc->quirks.barectf_event_before_packet = true; |
1954 | } | |
7645f10f | 1955 | |
aab89afc SM |
1956 | if (is_tracer_affected_by_lttng_crash_quirk( |
1957 | ¤t_tracer_info)) { | |
1958 | ret = fix_index_lttng_crash_quirk(ctf_fs->trace); | |
1959 | if (ret) { | |
1960 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1961 | "Failed to fix lttng-crash timestamp quirks."); | |
1962 | goto end; | |
7645f10f | 1963 | } |
aab89afc | 1964 | ctf_fs->trace->metadata->tc->quirks.lttng_crash = true; |
df7002e4 | 1965 | } |
aab89afc | 1966 | |
df7002e4 FD |
1967 | end: |
1968 | return ret; | |
1969 | } | |
1970 | ||
aab89afc | 1971 | int ctf_fs_component_create_ctf_fs_trace( |
bf5b7748 | 1972 | struct ctf_fs_component *ctf_fs, |
5c3441d8 SM |
1973 | const bt_value *paths_value, |
1974 | bt_self_component *self_comp, | |
1975 | bt_self_component_class *self_comp_class) | |
bf5b7748 SM |
1976 | { |
1977 | int ret = 0; | |
1978 | uint64_t i; | |
df7002e4 | 1979 | bt_logging_level log_level = ctf_fs->log_level; |
aab89afc | 1980 | GPtrArray *traces; |
bf5b7748 | 1981 | |
aab89afc SM |
1982 | BT_ASSERT(bt_value_get_type(paths_value) == BT_VALUE_TYPE_ARRAY); |
1983 | BT_ASSERT(!bt_value_array_is_empty(paths_value)); | |
1984 | ||
1985 | traces = g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier); | |
1986 | if (!traces) { | |
1987 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
1988 | "Failed to allocate a GPtrArray."); | |
1989 | goto error; | |
1990 | } | |
1991 | ||
1992 | /* Start by creating a separate ctf_fs_trace object for each path. */ | |
1270d0e9 | 1993 | for (i = 0; i < bt_value_array_get_length(paths_value); i++) { |
bf5b7748 | 1994 | const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i); |
a1040187 | 1995 | const char *input = bt_value_string_get(path_value); |
bf5b7748 | 1996 | |
aab89afc SM |
1997 | ret = ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs, |
1998 | input, traces, self_comp, self_comp_class); | |
bf5b7748 SM |
1999 | if (ret) { |
2000 | goto end; | |
2001 | } | |
2002 | } | |
2003 | ||
aab89afc SM |
2004 | if (traces->len > 1) { |
2005 | struct ctf_fs_trace *first_trace = (struct ctf_fs_trace *) traces->pdata[0]; | |
2006 | const uint8_t *first_trace_uuid = first_trace->metadata->tc->uuid; | |
2007 | struct ctf_fs_trace *trace; | |
2008 | ||
2009 | /* | |
2010 | * We have more than one trace, they must all share the same | |
2011 | * UUID, verify that. | |
2012 | */ | |
2013 | for (i = 0; i < traces->len; i++) { | |
2014 | struct ctf_fs_trace *this_trace = | |
2015 | (struct ctf_fs_trace *) traces->pdata[i]; | |
2016 | const uint8_t *this_trace_uuid = this_trace->metadata->tc->uuid; | |
2017 | ||
2018 | if (!this_trace->metadata->tc->is_uuid_set) { | |
2019 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2020 | "Multiple traces given, but a trace does not have a UUID: path=%s", | |
2021 | this_trace->path->str); | |
2022 | goto error; | |
2023 | } | |
2024 | ||
2025 | if (bt_uuid_compare(first_trace_uuid, this_trace_uuid) != 0) { | |
2026 | char first_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
2027 | char this_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
2028 | ||
2029 | bt_uuid_to_str(first_trace_uuid, first_trace_uuid_str); | |
2030 | bt_uuid_to_str(this_trace_uuid, this_trace_uuid_str); | |
2031 | ||
2032 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2033 | "Multiple traces given, but UUIDs don't match: " | |
2034 | "first-trace-uuid=%s, first-trace-path=%s, " | |
2035 | "trace-uuid=%s, trace-path=%s", | |
2036 | first_trace_uuid_str, first_trace->path->str, | |
2037 | this_trace_uuid_str, this_trace->path->str); | |
2038 | goto error; | |
2039 | } | |
2040 | } | |
2041 | ||
2042 | ret = merge_ctf_fs_traces((struct ctf_fs_trace **) traces->pdata, | |
2043 | traces->len, &trace); | |
2044 | if (ret) { | |
2045 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2046 | "Failed to merge traces with the same UUID."); | |
2047 | goto error; | |
2048 | } | |
2049 | ||
2050 | ctf_fs->trace = trace; | |
2051 | } else { | |
2052 | /* Just one trace, it may or may not have a UUID, both are fine. */ | |
2053 | ctf_fs->trace = traces->pdata[0]; | |
2054 | traces->pdata[0] = NULL; | |
df7002e4 | 2055 | } |
adb623c2 | 2056 | |
5c3441d8 | 2057 | ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp); |
df7002e4 | 2058 | if (ret) { |
5c3441d8 SM |
2059 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
2060 | "Failed to fix packet index tracer bugs."); | |
df7002e4 | 2061 | } |
aab89afc SM |
2062 | |
2063 | goto end; | |
2064 | error: | |
2065 | ret = -1; | |
2066 | ||
bf5b7748 | 2067 | end: |
aab89afc | 2068 | g_ptr_array_free(traces, TRUE); |
bf5b7748 SM |
2069 | return ret; |
2070 | } | |
2071 | ||
ddf49b27 SM |
2072 | static |
2073 | GString *get_stream_instance_unique_name( | |
2074 | struct ctf_fs_ds_file_group *ds_file_group) | |
2075 | { | |
2076 | GString *name; | |
2077 | struct ctf_fs_ds_file_info *ds_file_info; | |
2078 | ||
2079 | name = g_string_new(NULL); | |
2080 | if (!name) { | |
2081 | goto end; | |
2082 | } | |
2083 | ||
2084 | /* | |
2085 | * If there's more than one stream file in the stream file | |
2086 | * group, the first (earliest) stream file's path is used as | |
2087 | * the stream's unique name. | |
2088 | */ | |
2089 | BT_ASSERT(ds_file_group->ds_file_infos->len > 0); | |
2090 | ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0); | |
2091 | g_string_assign(name, ds_file_info->path->str); | |
2092 | ||
2093 | end: | |
2094 | return name; | |
2095 | } | |
2096 | ||
bf5b7748 SM |
2097 | /* Create the IR stream objects for ctf_fs_trace. */ |
2098 | ||
2099 | static | |
2100 | int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace) | |
2101 | { | |
2102 | int ret; | |
2103 | GString *name = NULL; | |
2104 | guint i; | |
3d731ea9 | 2105 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 2106 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
bf5b7748 SM |
2107 | |
2108 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
2109 | struct ctf_fs_ds_file_group *ds_file_group = | |
2110 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); | |
2111 | name = get_stream_instance_unique_name(ds_file_group); | |
2112 | ||
2113 | if (!name) { | |
2114 | goto error; | |
2115 | } | |
2116 | ||
2117 | if (ds_file_group->sc->ir_sc) { | |
2118 | BT_ASSERT(ctf_fs_trace->trace); | |
2119 | ||
2120 | if (ds_file_group->stream_id == UINT64_C(-1)) { | |
2121 | /* No stream ID: use 0 */ | |
2122 | ds_file_group->stream = bt_stream_create_with_id( | |
2123 | ds_file_group->sc->ir_sc, | |
2124 | ctf_fs_trace->trace, | |
2125 | ctf_fs_trace->next_stream_id); | |
2126 | ctf_fs_trace->next_stream_id++; | |
2127 | } else { | |
2128 | /* Specific stream ID */ | |
2129 | ds_file_group->stream = bt_stream_create_with_id( | |
2130 | ds_file_group->sc->ir_sc, | |
2131 | ctf_fs_trace->trace, | |
2132 | (uint64_t) ds_file_group->stream_id); | |
2133 | } | |
2134 | } else { | |
2135 | ds_file_group->stream = NULL; | |
2136 | } | |
2137 | ||
2138 | if (!ds_file_group->stream) { | |
5c3441d8 SM |
2139 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
2140 | "Cannot create stream for DS file group: " | |
bf5b7748 SM |
2141 | "addr=%p, stream-name=\"%s\"", |
2142 | ds_file_group, name->str); | |
2143 | goto error; | |
2144 | } | |
2145 | ||
2146 | ret = bt_stream_set_name(ds_file_group->stream, | |
2147 | name->str); | |
2148 | if (ret) { | |
5c3441d8 | 2149 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot set stream's name: " |
bf5b7748 SM |
2150 | "addr=%p, stream-name=\"%s\"", |
2151 | ds_file_group->stream, name->str); | |
2152 | goto error; | |
2153 | } | |
2154 | ||
2155 | g_string_free(name, TRUE); | |
2156 | name = NULL; | |
2157 | } | |
2158 | ||
2159 | ret = 0; | |
2160 | goto end; | |
2161 | ||
2162 | error: | |
2163 | ret = -1; | |
2164 | ||
2165 | end: | |
2166 | ||
2167 | if (name) { | |
2168 | g_string_free(name, TRUE); | |
2169 | } | |
2170 | return ret; | |
2171 | } | |
2172 | ||
c80d4c65 SM |
2173 | /* |
2174 | * Validate the "paths" parameter passed to this component. It must be | |
2175 | * present, and it must be an array of strings. | |
2176 | */ | |
2177 | ||
2178 | static | |
a1040187 | 2179 | bool validate_inputs_parameter(struct ctf_fs_component *ctf_fs, |
5c3441d8 SM |
2180 | const bt_value *inputs, bt_self_component *self_comp, |
2181 | bt_self_component_class *self_comp_class) | |
bf5b7748 SM |
2182 | { |
2183 | bool ret; | |
2184 | bt_value_type type; | |
2185 | uint64_t i; | |
3d731ea9 | 2186 | bt_logging_level log_level = ctf_fs->log_level; |
bf5b7748 | 2187 | |
a1040187 | 2188 | if (!inputs) { |
5c3441d8 SM |
2189 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, |
2190 | self_comp_class, "missing \"inputs\" parameter"); | |
bf5b7748 SM |
2191 | goto error; |
2192 | } | |
2193 | ||
a1040187 | 2194 | type = bt_value_get_type(inputs); |
bf5b7748 | 2195 | if (type != BT_VALUE_TYPE_ARRAY) { |
5c3441d8 SM |
2196 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, |
2197 | self_comp_class, "`inputs` parameter: expecting array value: type=%s", | |
bf5b7748 SM |
2198 | bt_common_value_type_string(type)); |
2199 | goto error; | |
2200 | } | |
2201 | ||
aab89afc SM |
2202 | if (bt_value_array_is_empty(inputs)) { |
2203 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, | |
2204 | self_comp_class, "`inputs` parameter must not be empty"); | |
2205 | goto error; | |
2206 | } | |
2207 | ||
1270d0e9 | 2208 | for (i = 0; i < bt_value_array_get_length(inputs); i++) { |
bf5b7748 SM |
2209 | const bt_value *elem; |
2210 | ||
a1040187 | 2211 | elem = bt_value_array_borrow_element_by_index_const(inputs, i); |
bf5b7748 SM |
2212 | type = bt_value_get_type(elem); |
2213 | if (type != BT_VALUE_TYPE_STRING) { | |
5c3441d8 SM |
2214 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
2215 | "`inputs` parameter: expecting string value: index=%" PRIu64 ", type=%s", | |
bf5b7748 SM |
2216 | i, bt_common_value_type_string(type)); |
2217 | goto error; | |
2218 | } | |
2219 | } | |
2220 | ||
2221 | ret = true; | |
2222 | goto end; | |
2223 | ||
2224 | error: | |
2225 | ret = false; | |
2226 | ||
2227 | end: | |
2228 | return ret; | |
2229 | } | |
2230 | ||
c80d4c65 | 2231 | bool read_src_fs_parameters(const bt_value *params, |
5c3441d8 SM |
2232 | const bt_value **inputs, struct ctf_fs_component *ctf_fs, |
2233 | bt_self_component *self_comp, | |
2234 | bt_self_component_class *self_comp_class) { | |
c80d4c65 SM |
2235 | bool ret; |
2236 | const bt_value *value; | |
3d731ea9 | 2237 | bt_logging_level log_level = ctf_fs->log_level; |
c80d4c65 | 2238 | |
a1040187 SM |
2239 | /* inputs parameter */ |
2240 | *inputs = bt_value_map_borrow_entry_value_const(params, "inputs"); | |
5c3441d8 | 2241 | if (!validate_inputs_parameter(ctf_fs, *inputs, self_comp, self_comp_class)) { |
c80d4c65 SM |
2242 | goto error; |
2243 | } | |
2244 | ||
2245 | /* clock-class-offset-s parameter */ | |
2246 | value = bt_value_map_borrow_entry_value_const(params, | |
2247 | "clock-class-offset-s"); | |
2248 | if (value) { | |
68d9d039 | 2249 | if (!bt_value_is_signed_integer(value)) { |
5c3441d8 SM |
2250 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
2251 | "clock-class-offset-s must be an integer"); | |
c80d4c65 SM |
2252 | goto error; |
2253 | } | |
2254 | ctf_fs->metadata_config.clock_class_offset_s = | |
60bbfc7c | 2255 | bt_value_integer_signed_get(value); |
c80d4c65 SM |
2256 | } |
2257 | ||
2258 | /* clock-class-offset-ns parameter */ | |
2259 | value = bt_value_map_borrow_entry_value_const(params, | |
2260 | "clock-class-offset-ns"); | |
2261 | if (value) { | |
68d9d039 | 2262 | if (!bt_value_is_signed_integer(value)) { |
5c3441d8 SM |
2263 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
2264 | "clock-class-offset-ns must be an integer"); | |
c80d4c65 SM |
2265 | goto error; |
2266 | } | |
2267 | ctf_fs->metadata_config.clock_class_offset_ns = | |
60bbfc7c | 2268 | bt_value_integer_signed_get(value); |
c80d4c65 SM |
2269 | } |
2270 | ||
2271 | ||
2272 | ret = true; | |
2273 | goto end; | |
2274 | ||
2275 | error: | |
2276 | ret = false; | |
2277 | ||
2278 | end: | |
2279 | return ret; | |
2280 | } | |
2281 | ||
5b29e799 | 2282 | static |
834e9996 | 2283 | struct ctf_fs_component *ctf_fs_create( |
5c3441d8 SM |
2284 | const bt_value *params, |
2285 | bt_self_component_source *self_comp_src, | |
2286 | bt_self_component_class *self_comp_class) | |
56a1cced | 2287 | { |
bf5b7748 | 2288 | struct ctf_fs_component *ctf_fs = NULL; |
a1040187 | 2289 | const bt_value *inputs_value; |
3d731ea9 PP |
2290 | bt_self_component *self_comp = |
2291 | bt_self_component_source_as_self_component(self_comp_src); | |
56a1cced | 2292 | |
3d731ea9 | 2293 | ctf_fs = ctf_fs_component_create(bt_component_get_logging_level( |
f67894f9 | 2294 | bt_self_component_as_component(self_comp)), self_comp); |
c80d4c65 | 2295 | if (!ctf_fs) { |
bf5b7748 SM |
2296 | goto error; |
2297 | } | |
2298 | ||
5c3441d8 SM |
2299 | if (!read_src_fs_parameters(params, &inputs_value, ctf_fs, |
2300 | self_comp, self_comp_class)) { | |
bf5b7748 | 2301 | goto error; |
56a1cced JG |
2302 | } |
2303 | ||
3d731ea9 | 2304 | bt_self_component_set_data(self_comp, ctf_fs); |
56a1cced | 2305 | |
aab89afc | 2306 | if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value, |
5c3441d8 | 2307 | self_comp, self_comp_class)) { |
4f1f88a6 PP |
2308 | goto error; |
2309 | } | |
2310 | ||
aab89afc SM |
2311 | if (create_streams_for_trace(ctf_fs->trace)) { |
2312 | goto error; | |
2313 | } | |
bf5b7748 | 2314 | |
aab89afc SM |
2315 | if (create_ports_for_trace(ctf_fs, ctf_fs->trace, self_comp_src)) { |
2316 | goto error; | |
4f1f88a6 PP |
2317 | } |
2318 | ||
1ef09eb5 JG |
2319 | goto end; |
2320 | ||
56a1cced | 2321 | error: |
1a9f7075 | 2322 | ctf_fs_destroy(ctf_fs); |
e7a4393b | 2323 | ctf_fs = NULL; |
3d731ea9 | 2324 | bt_self_component_set_data(self_comp, NULL); |
1a9f7075 | 2325 | |
1ef09eb5 | 2326 | end: |
56a1cced JG |
2327 | return ctf_fs; |
2328 | } | |
2329 | ||
ea0b4b9e | 2330 | BT_HIDDEN |
fb25b9e3 | 2331 | bt_component_class_init_method_status ctf_fs_init( |
5c3441d8 | 2332 | bt_self_component_source *self_comp_src, |
f807570c | 2333 | const bt_value *params, __attribute__((unused)) void *init_method_data) |
ea0b4b9e JG |
2334 | { |
2335 | struct ctf_fs_component *ctf_fs; | |
fb25b9e3 PP |
2336 | bt_component_class_init_method_status ret = |
2337 | BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK; | |
ea0b4b9e | 2338 | |
5c3441d8 | 2339 | ctf_fs = ctf_fs_create(params, self_comp_src, NULL); |
ea0b4b9e | 2340 | if (!ctf_fs) { |
fb25b9e3 | 2341 | ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; |
ea0b4b9e | 2342 | } |
4c1456f0 | 2343 | |
ea0b4b9e JG |
2344 | return ret; |
2345 | } | |
33f93973 PP |
2346 | |
2347 | BT_HIDDEN | |
fb25b9e3 | 2348 | bt_component_class_query_method_status ctf_fs_query( |
8eee8ea2 | 2349 | bt_self_component_class_source *comp_class, |
bf403eb2 | 2350 | bt_private_query_executor *priv_query_exec, |
8eee8ea2 | 2351 | const char *object, const bt_value *params, |
f6e305ce | 2352 | __attribute__((unused)) void *method_data, |
8eee8ea2 | 2353 | const bt_value **result) |
33f93973 | 2354 | { |
fb25b9e3 PP |
2355 | bt_component_class_query_method_status status = |
2356 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
bf403eb2 PP |
2357 | bt_logging_level log_level = bt_query_executor_get_logging_level( |
2358 | bt_private_query_executor_as_query_executor_const( | |
2359 | priv_query_exec)); | |
33f93973 | 2360 | |
acfa8112 | 2361 | if (strcmp(object, "metadata-info") == 0) { |
3d731ea9 PP |
2362 | status = metadata_info_query(comp_class, params, log_level, |
2363 | result); | |
9db4399f SM |
2364 | } else if (strcmp(object, "babeltrace.trace-infos") == 0) { |
2365 | status = trace_infos_query(comp_class, params, log_level, | |
3d731ea9 | 2366 | result); |
9e534aae | 2367 | } else if (!strcmp(object, "babeltrace.support-info")) { |
a1040187 | 2368 | status = support_info_query(comp_class, params, log_level, result); |
33f93973 | 2369 | } else { |
55314f2a | 2370 | BT_LOGE("Unknown query object `%s`", object); |
7dd3e712 | 2371 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT; |
04c0ba87 | 2372 | goto end; |
33f93973 | 2373 | } |
33f93973 | 2374 | end: |
834e9996 | 2375 | return status; |
33f93973 | 2376 | } |