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