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