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