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