| 1 | /* |
| 2 | * fs.c |
| 3 | * |
| 4 | * Babeltrace CTF file system Reader Component |
| 5 | * |
| 6 | * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com> |
| 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * |
| 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 10 | * of this software and associated documentation files (the "Software"), to deal |
| 11 | * in the Software without restriction, including without limitation the rights |
| 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 13 | * copies of the Software, and to permit persons to whom the Software is |
| 14 | * furnished to do so, subject to the following conditions: |
| 15 | * |
| 16 | * The above copyright notice and this permission notice shall be included in |
| 17 | * all copies or substantial portions of the Software. |
| 18 | * |
| 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 25 | * SOFTWARE. |
| 26 | */ |
| 27 | |
| 28 | #define BT_COMP_LOG_SELF_COMP self_comp |
| 29 | #define BT_LOG_OUTPUT_LEVEL log_level |
| 30 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS" |
| 31 | #include "plugins/comp-logging.h" |
| 32 | |
| 33 | #include "common/common.h" |
| 34 | #include <babeltrace2/babeltrace.h> |
| 35 | #include "compat/uuid.h" |
| 36 | #include <glib.h> |
| 37 | #include "common/assert.h" |
| 38 | #include <inttypes.h> |
| 39 | #include <stdbool.h> |
| 40 | #include "fs.h" |
| 41 | #include "metadata.h" |
| 42 | #include "data-stream-file.h" |
| 43 | #include "file.h" |
| 44 | #include "../common/metadata/decoder.h" |
| 45 | #include "../common/msg-iter/msg-iter.h" |
| 46 | #include "query.h" |
| 47 | |
| 48 | static |
| 49 | int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data) |
| 50 | { |
| 51 | struct ctf_fs_ds_file_info *ds_file_info; |
| 52 | int ret = 0; |
| 53 | |
| 54 | BT_ASSERT(msg_iter_data->ds_file_info_index < |
| 55 | msg_iter_data->ds_file_group->ds_file_infos->len); |
| 56 | ds_file_info = g_ptr_array_index( |
| 57 | msg_iter_data->ds_file_group->ds_file_infos, |
| 58 | msg_iter_data->ds_file_info_index); |
| 59 | |
| 60 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); |
| 61 | msg_iter_data->ds_file = ctf_fs_ds_file_create( |
| 62 | msg_iter_data->ds_file_group->ctf_fs_trace, |
| 63 | msg_iter_data->pc_msg_iter, |
| 64 | msg_iter_data->msg_iter, |
| 65 | msg_iter_data->ds_file_group->stream, |
| 66 | ds_file_info->path->str, |
| 67 | msg_iter_data->log_level); |
| 68 | if (!msg_iter_data->ds_file) { |
| 69 | ret = -1; |
| 70 | } |
| 71 | |
| 72 | return ret; |
| 73 | } |
| 74 | |
| 75 | static |
| 76 | void ctf_fs_msg_iter_data_destroy( |
| 77 | struct ctf_fs_msg_iter_data *msg_iter_data) |
| 78 | { |
| 79 | if (!msg_iter_data) { |
| 80 | return; |
| 81 | } |
| 82 | |
| 83 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); |
| 84 | |
| 85 | if (msg_iter_data->msg_iter) { |
| 86 | bt_msg_iter_destroy(msg_iter_data->msg_iter); |
| 87 | } |
| 88 | |
| 89 | g_free(msg_iter_data); |
| 90 | } |
| 91 | |
| 92 | static |
| 93 | void set_msg_iter_emits_stream_beginning_end_messages( |
| 94 | struct ctf_fs_msg_iter_data *msg_iter_data) |
| 95 | { |
| 96 | bt_msg_iter_set_emit_stream_beginning_message( |
| 97 | msg_iter_data->ds_file->msg_iter, |
| 98 | msg_iter_data->ds_file_info_index == 0); |
| 99 | bt_msg_iter_set_emit_stream_end_message( |
| 100 | msg_iter_data->ds_file->msg_iter, |
| 101 | msg_iter_data->ds_file_info_index == |
| 102 | msg_iter_data->ds_file_group->ds_file_infos->len - 1); |
| 103 | } |
| 104 | |
| 105 | static |
| 106 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next_one( |
| 107 | struct ctf_fs_msg_iter_data *msg_iter_data, |
| 108 | const bt_message **out_msg) |
| 109 | { |
| 110 | bt_component_class_message_iterator_next_method_status status; |
| 111 | |
| 112 | BT_ASSERT(msg_iter_data->ds_file); |
| 113 | |
| 114 | while (true) { |
| 115 | bt_message *msg; |
| 116 | |
| 117 | status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg); |
| 118 | switch (status) { |
| 119 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK: |
| 120 | *out_msg = msg; |
| 121 | msg = NULL; |
| 122 | goto end; |
| 123 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END: |
| 124 | { |
| 125 | int ret; |
| 126 | |
| 127 | if (msg_iter_data->ds_file_info_index == |
| 128 | msg_iter_data->ds_file_group->ds_file_infos->len - 1) { |
| 129 | /* End of all group's stream files */ |
| 130 | goto end; |
| 131 | } |
| 132 | |
| 133 | msg_iter_data->ds_file_info_index++; |
| 134 | bt_msg_iter_reset_for_next_stream_file( |
| 135 | msg_iter_data->msg_iter); |
| 136 | set_msg_iter_emits_stream_beginning_end_messages( |
| 137 | msg_iter_data); |
| 138 | |
| 139 | /* |
| 140 | * Open and start reading the next stream file |
| 141 | * within our stream file group. |
| 142 | */ |
| 143 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); |
| 144 | if (ret) { |
| 145 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
| 146 | goto end; |
| 147 | } |
| 148 | |
| 149 | /* Continue the loop to get the next message */ |
| 150 | break; |
| 151 | } |
| 152 | default: |
| 153 | goto end; |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | end: |
| 158 | return status; |
| 159 | } |
| 160 | |
| 161 | BT_HIDDEN |
| 162 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
| 163 | bt_self_message_iterator *iterator, |
| 164 | bt_message_array_const msgs, uint64_t capacity, |
| 165 | uint64_t *count) |
| 166 | { |
| 167 | bt_component_class_message_iterator_next_method_status status = |
| 168 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
| 169 | struct ctf_fs_msg_iter_data *msg_iter_data = |
| 170 | bt_self_message_iterator_get_data(iterator); |
| 171 | uint64_t i = 0; |
| 172 | |
| 173 | while (i < capacity && |
| 174 | status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
| 175 | status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]); |
| 176 | if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
| 177 | i++; |
| 178 | } |
| 179 | } |
| 180 | |
| 181 | if (i > 0) { |
| 182 | /* |
| 183 | * Even if ctf_fs_iterator_next_one() returned something |
| 184 | * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we |
| 185 | * accumulated message objects in the output |
| 186 | * message array, so we need to return |
| 187 | * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are |
| 188 | * transfered to downstream. This other status occurs |
| 189 | * again the next time muxer_msg_iter_do_next() is |
| 190 | * called, possibly without any accumulated |
| 191 | * message, in which case we'll return it. |
| 192 | */ |
| 193 | *count = i; |
| 194 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
| 195 | } |
| 196 | |
| 197 | return status; |
| 198 | } |
| 199 | |
| 200 | static |
| 201 | int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data) |
| 202 | { |
| 203 | int ret; |
| 204 | |
| 205 | msg_iter_data->ds_file_info_index = 0; |
| 206 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); |
| 207 | if (ret) { |
| 208 | goto end; |
| 209 | } |
| 210 | |
| 211 | bt_msg_iter_reset(msg_iter_data->msg_iter); |
| 212 | set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data); |
| 213 | |
| 214 | end: |
| 215 | return ret; |
| 216 | } |
| 217 | |
| 218 | BT_HIDDEN |
| 219 | bt_component_class_message_iterator_seek_beginning_method_status |
| 220 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it) |
| 221 | { |
| 222 | struct ctf_fs_msg_iter_data *msg_iter_data = |
| 223 | bt_self_message_iterator_get_data(it); |
| 224 | bt_component_class_message_iterator_seek_beginning_method_status status = |
| 225 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK; |
| 226 | |
| 227 | BT_ASSERT(msg_iter_data); |
| 228 | if (ctf_fs_iterator_reset(msg_iter_data)) { |
| 229 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR; |
| 230 | } |
| 231 | |
| 232 | return status; |
| 233 | } |
| 234 | |
| 235 | BT_HIDDEN |
| 236 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it) |
| 237 | { |
| 238 | ctf_fs_msg_iter_data_destroy( |
| 239 | bt_self_message_iterator_get_data(it)); |
| 240 | } |
| 241 | |
| 242 | BT_HIDDEN |
| 243 | bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init( |
| 244 | bt_self_message_iterator *self_msg_iter, |
| 245 | bt_self_component_source *self_comp_src, |
| 246 | bt_self_component_port_output *self_port) |
| 247 | { |
| 248 | struct ctf_fs_port_data *port_data; |
| 249 | struct ctf_fs_msg_iter_data *msg_iter_data = NULL; |
| 250 | bt_component_class_message_iterator_init_method_status ret = |
| 251 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK; |
| 252 | bt_logging_level log_level; |
| 253 | bt_self_component *self_comp; |
| 254 | |
| 255 | port_data = bt_self_component_port_get_data( |
| 256 | bt_self_component_port_output_as_self_component_port( |
| 257 | self_port)); |
| 258 | BT_ASSERT(port_data); |
| 259 | log_level = port_data->ctf_fs->log_level; |
| 260 | self_comp = port_data->ctf_fs->self_comp; |
| 261 | msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1); |
| 262 | if (!msg_iter_data) { |
| 263 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; |
| 264 | goto error; |
| 265 | } |
| 266 | |
| 267 | msg_iter_data->log_level = log_level; |
| 268 | msg_iter_data->self_comp = self_comp; |
| 269 | msg_iter_data->pc_msg_iter = self_msg_iter; |
| 270 | msg_iter_data->msg_iter = bt_msg_iter_create( |
| 271 | port_data->ds_file_group->ctf_fs_trace->metadata->tc, |
| 272 | bt_common_get_page_size(msg_iter_data->log_level) * 8, |
| 273 | ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level, |
| 274 | self_comp); |
| 275 | if (!msg_iter_data->msg_iter) { |
| 276 | BT_COMP_LOGE_STR("Cannot create a CTF message iterator."); |
| 277 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; |
| 278 | goto error; |
| 279 | } |
| 280 | |
| 281 | msg_iter_data->ds_file_group = port_data->ds_file_group; |
| 282 | if (ctf_fs_iterator_reset(msg_iter_data)) { |
| 283 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR; |
| 284 | goto error; |
| 285 | } |
| 286 | |
| 287 | bt_self_message_iterator_set_data(self_msg_iter, |
| 288 | msg_iter_data); |
| 289 | if (ret != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK) { |
| 290 | goto error; |
| 291 | } |
| 292 | |
| 293 | msg_iter_data = NULL; |
| 294 | goto end; |
| 295 | |
| 296 | error: |
| 297 | bt_self_message_iterator_set_data(self_msg_iter, NULL); |
| 298 | |
| 299 | end: |
| 300 | ctf_fs_msg_iter_data_destroy(msg_iter_data); |
| 301 | return ret; |
| 302 | } |
| 303 | |
| 304 | BT_HIDDEN |
| 305 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs) |
| 306 | { |
| 307 | if (!ctf_fs) { |
| 308 | return; |
| 309 | } |
| 310 | |
| 311 | if (ctf_fs->traces) { |
| 312 | g_ptr_array_free(ctf_fs->traces, TRUE); |
| 313 | } |
| 314 | |
| 315 | if (ctf_fs->port_data) { |
| 316 | g_ptr_array_free(ctf_fs->port_data, TRUE); |
| 317 | } |
| 318 | |
| 319 | g_free(ctf_fs); |
| 320 | } |
| 321 | |
| 322 | static |
| 323 | void port_data_destroy(struct ctf_fs_port_data *port_data) |
| 324 | { |
| 325 | if (!port_data) { |
| 326 | return; |
| 327 | } |
| 328 | |
| 329 | g_free(port_data); |
| 330 | } |
| 331 | |
| 332 | static |
| 333 | void port_data_destroy_notifier(void *data) { |
| 334 | port_data_destroy(data); |
| 335 | } |
| 336 | |
| 337 | static |
| 338 | void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace) |
| 339 | { |
| 340 | if (!ctf_fs_trace) { |
| 341 | return; |
| 342 | } |
| 343 | |
| 344 | if (ctf_fs_trace->ds_file_groups) { |
| 345 | g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE); |
| 346 | } |
| 347 | |
| 348 | BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace); |
| 349 | |
| 350 | if (ctf_fs_trace->path) { |
| 351 | g_string_free(ctf_fs_trace->path, TRUE); |
| 352 | } |
| 353 | |
| 354 | if (ctf_fs_trace->name) { |
| 355 | g_string_free(ctf_fs_trace->name, TRUE); |
| 356 | } |
| 357 | |
| 358 | if (ctf_fs_trace->metadata) { |
| 359 | ctf_fs_metadata_fini(ctf_fs_trace->metadata); |
| 360 | g_free(ctf_fs_trace->metadata); |
| 361 | } |
| 362 | |
| 363 | g_free(ctf_fs_trace); |
| 364 | } |
| 365 | |
| 366 | static |
| 367 | void ctf_fs_trace_destroy_notifier(void *data) |
| 368 | { |
| 369 | struct ctf_fs_trace *trace = data; |
| 370 | ctf_fs_trace_destroy(trace); |
| 371 | } |
| 372 | |
| 373 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
| 374 | bt_self_component *self_comp) |
| 375 | { |
| 376 | struct ctf_fs_component *ctf_fs; |
| 377 | |
| 378 | ctf_fs = g_new0(struct ctf_fs_component, 1); |
| 379 | if (!ctf_fs) { |
| 380 | goto error; |
| 381 | } |
| 382 | |
| 383 | ctf_fs->log_level = log_level; |
| 384 | ctf_fs->self_comp = self_comp; |
| 385 | ctf_fs->port_data = |
| 386 | g_ptr_array_new_with_free_func(port_data_destroy_notifier); |
| 387 | if (!ctf_fs->port_data) { |
| 388 | goto error; |
| 389 | } |
| 390 | |
| 391 | ctf_fs->traces = |
| 392 | g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier); |
| 393 | if (!ctf_fs->traces) { |
| 394 | goto error; |
| 395 | } |
| 396 | |
| 397 | goto end; |
| 398 | |
| 399 | error: |
| 400 | if (ctf_fs) { |
| 401 | ctf_fs_destroy(ctf_fs); |
| 402 | } |
| 403 | |
| 404 | end: |
| 405 | return ctf_fs; |
| 406 | } |
| 407 | |
| 408 | void ctf_fs_finalize(bt_self_component_source *component) |
| 409 | { |
| 410 | ctf_fs_destroy(bt_self_component_get_data( |
| 411 | bt_self_component_source_as_self_component(component))); |
| 412 | } |
| 413 | |
| 414 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group) |
| 415 | { |
| 416 | GString *name = g_string_new(NULL); |
| 417 | |
| 418 | /* |
| 419 | * The unique port name is generated by concatenating unique identifiers |
| 420 | * for: |
| 421 | * |
| 422 | * - the trace |
| 423 | * - the stream class |
| 424 | * - the stream |
| 425 | */ |
| 426 | |
| 427 | /* For the trace, use the uuid if present, else the path. */ |
| 428 | if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) { |
| 429 | char uuid_str[BABELTRACE_UUID_STR_LEN]; |
| 430 | |
| 431 | bt_uuid_unparse(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str); |
| 432 | g_string_assign(name, uuid_str); |
| 433 | } else { |
| 434 | g_string_assign(name, ds_file_group->ctf_fs_trace->path->str); |
| 435 | } |
| 436 | |
| 437 | /* |
| 438 | * For the stream class, use the id if present. We can omit this field |
| 439 | * otherwise, as there will only be a single stream class. |
| 440 | */ |
| 441 | if (ds_file_group->sc->id != UINT64_C(-1)) { |
| 442 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id); |
| 443 | } |
| 444 | |
| 445 | /* For the stream, use the id if present, else, use the path. */ |
| 446 | if (ds_file_group->stream_id != UINT64_C(-1)) { |
| 447 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id); |
| 448 | } else { |
| 449 | BT_ASSERT(ds_file_group->ds_file_infos->len == 1); |
| 450 | struct ctf_fs_ds_file_info *ds_file_info = |
| 451 | g_ptr_array_index(ds_file_group->ds_file_infos, 0); |
| 452 | g_string_append_printf(name, " | %s", ds_file_info->path->str); |
| 453 | } |
| 454 | |
| 455 | return g_string_free(name, FALSE); |
| 456 | } |
| 457 | |
| 458 | static |
| 459 | int create_one_port_for_trace(struct ctf_fs_component *ctf_fs, |
| 460 | struct ctf_fs_trace *ctf_fs_trace, |
| 461 | struct ctf_fs_ds_file_group *ds_file_group) |
| 462 | { |
| 463 | int ret = 0; |
| 464 | struct ctf_fs_port_data *port_data = NULL; |
| 465 | gchar *port_name; |
| 466 | bt_logging_level log_level = ctf_fs->log_level; |
| 467 | bt_self_component *self_comp = ctf_fs->self_comp; |
| 468 | |
| 469 | port_name = ctf_fs_make_port_name(ds_file_group); |
| 470 | if (!port_name) { |
| 471 | goto error; |
| 472 | } |
| 473 | |
| 474 | BT_COMP_LOGI("Creating one port named `%s`", port_name); |
| 475 | |
| 476 | /* Create output port for this file */ |
| 477 | port_data = g_new0(struct ctf_fs_port_data, 1); |
| 478 | if (!port_data) { |
| 479 | goto error; |
| 480 | } |
| 481 | |
| 482 | port_data->ctf_fs = ctf_fs; |
| 483 | port_data->ds_file_group = ds_file_group; |
| 484 | ret = bt_self_component_source_add_output_port( |
| 485 | ctf_fs->self_comp_src, port_name, port_data, NULL); |
| 486 | if (ret) { |
| 487 | goto error; |
| 488 | } |
| 489 | |
| 490 | g_ptr_array_add(ctf_fs->port_data, port_data); |
| 491 | port_data = NULL; |
| 492 | goto end; |
| 493 | |
| 494 | error: |
| 495 | ret = -1; |
| 496 | |
| 497 | end: |
| 498 | if (port_name) { |
| 499 | g_free(port_name); |
| 500 | } |
| 501 | |
| 502 | port_data_destroy(port_data); |
| 503 | return ret; |
| 504 | } |
| 505 | |
| 506 | static |
| 507 | int create_ports_for_trace(struct ctf_fs_component *ctf_fs, |
| 508 | struct ctf_fs_trace *ctf_fs_trace) |
| 509 | { |
| 510 | int ret = 0; |
| 511 | size_t i; |
| 512 | bt_logging_level log_level = ctf_fs_trace->log_level; |
| 513 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
| 514 | |
| 515 | /* Create one output port for each stream file group */ |
| 516 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { |
| 517 | struct ctf_fs_ds_file_group *ds_file_group = |
| 518 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); |
| 519 | |
| 520 | ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace, |
| 521 | ds_file_group); |
| 522 | if (ret) { |
| 523 | BT_COMP_LOGE("Cannot create output port."); |
| 524 | goto end; |
| 525 | } |
| 526 | } |
| 527 | |
| 528 | end: |
| 529 | return ret; |
| 530 | } |
| 531 | |
| 532 | static |
| 533 | void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info) |
| 534 | { |
| 535 | if (!ds_file_info) { |
| 536 | return; |
| 537 | } |
| 538 | |
| 539 | if (ds_file_info->path) { |
| 540 | g_string_free(ds_file_info->path, TRUE); |
| 541 | } |
| 542 | |
| 543 | g_free(ds_file_info); |
| 544 | } |
| 545 | |
| 546 | static |
| 547 | struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path, |
| 548 | int64_t begin_ns) |
| 549 | { |
| 550 | struct ctf_fs_ds_file_info *ds_file_info; |
| 551 | |
| 552 | ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1); |
| 553 | if (!ds_file_info) { |
| 554 | goto end; |
| 555 | } |
| 556 | |
| 557 | ds_file_info->path = g_string_new(path); |
| 558 | if (!ds_file_info->path) { |
| 559 | ctf_fs_ds_file_info_destroy(ds_file_info); |
| 560 | ds_file_info = NULL; |
| 561 | goto end; |
| 562 | } |
| 563 | |
| 564 | ds_file_info->begin_ns = begin_ns; |
| 565 | |
| 566 | end: |
| 567 | return ds_file_info; |
| 568 | } |
| 569 | |
| 570 | static |
| 571 | void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group) |
| 572 | { |
| 573 | if (!ds_file_group) { |
| 574 | return; |
| 575 | } |
| 576 | |
| 577 | if (ds_file_group->ds_file_infos) { |
| 578 | g_ptr_array_free(ds_file_group->ds_file_infos, TRUE); |
| 579 | } |
| 580 | |
| 581 | if (ds_file_group->index) { |
| 582 | if (ds_file_group->index->entries) { |
| 583 | g_ptr_array_free(ds_file_group->index->entries, TRUE); |
| 584 | } |
| 585 | g_free(ds_file_group->index); |
| 586 | } |
| 587 | |
| 588 | bt_stream_put_ref(ds_file_group->stream); |
| 589 | g_free(ds_file_group); |
| 590 | } |
| 591 | |
| 592 | static |
| 593 | struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create( |
| 594 | struct ctf_fs_trace *ctf_fs_trace, |
| 595 | struct ctf_stream_class *sc, |
| 596 | uint64_t stream_instance_id, |
| 597 | struct ctf_fs_ds_index *index) |
| 598 | { |
| 599 | struct ctf_fs_ds_file_group *ds_file_group; |
| 600 | |
| 601 | ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1); |
| 602 | if (!ds_file_group) { |
| 603 | goto error; |
| 604 | } |
| 605 | |
| 606 | ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func( |
| 607 | (GDestroyNotify) ctf_fs_ds_file_info_destroy); |
| 608 | if (!ds_file_group->ds_file_infos) { |
| 609 | goto error; |
| 610 | } |
| 611 | |
| 612 | ds_file_group->index = index; |
| 613 | |
| 614 | ds_file_group->stream_id = stream_instance_id; |
| 615 | BT_ASSERT(sc); |
| 616 | ds_file_group->sc = sc; |
| 617 | ds_file_group->ctf_fs_trace = ctf_fs_trace; |
| 618 | goto end; |
| 619 | |
| 620 | error: |
| 621 | ctf_fs_ds_file_group_destroy(ds_file_group); |
| 622 | ctf_fs_ds_index_destroy(index); |
| 623 | ds_file_group = NULL; |
| 624 | |
| 625 | end: |
| 626 | return ds_file_group; |
| 627 | } |
| 628 | |
| 629 | /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */ |
| 630 | static |
| 631 | void array_insert(GPtrArray *array, gpointer element, size_t pos) |
| 632 | { |
| 633 | size_t original_array_len = array->len; |
| 634 | |
| 635 | /* Allocate an unused element at the end of the array. */ |
| 636 | g_ptr_array_add(array, NULL); |
| 637 | |
| 638 | /* If we are not inserting at the end, move the elements by one. */ |
| 639 | if (pos < original_array_len) { |
| 640 | memmove(&(array->pdata[pos + 1]), |
| 641 | &(array->pdata[pos]), |
| 642 | (original_array_len - pos) * sizeof(gpointer)); |
| 643 | } |
| 644 | |
| 645 | /* Insert the value. */ |
| 646 | array->pdata[pos] = element; |
| 647 | } |
| 648 | |
| 649 | /* |
| 650 | * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right |
| 651 | * place to keep it sorted. |
| 652 | */ |
| 653 | |
| 654 | static |
| 655 | void ds_file_group_insert_ds_file_info_sorted( |
| 656 | struct ctf_fs_ds_file_group *ds_file_group, |
| 657 | struct ctf_fs_ds_file_info *ds_file_info) |
| 658 | { |
| 659 | guint i; |
| 660 | |
| 661 | /* Find the spot where to insert this ds_file_info. */ |
| 662 | for (i = 0; i < ds_file_group->ds_file_infos->len; i++) { |
| 663 | struct ctf_fs_ds_file_info *other_ds_file_info = |
| 664 | g_ptr_array_index(ds_file_group->ds_file_infos, i); |
| 665 | |
| 666 | if (ds_file_info->begin_ns < other_ds_file_info->begin_ns) { |
| 667 | break; |
| 668 | } |
| 669 | } |
| 670 | |
| 671 | array_insert(ds_file_group->ds_file_infos, ds_file_info, i); |
| 672 | } |
| 673 | |
| 674 | static |
| 675 | void ds_file_group_insert_ds_index_entry_sorted( |
| 676 | struct ctf_fs_ds_file_group *ds_file_group, |
| 677 | struct ctf_fs_ds_index_entry *entry) |
| 678 | { |
| 679 | guint i; |
| 680 | |
| 681 | /* Find the spot where to insert this index entry. */ |
| 682 | for (i = 0; i < ds_file_group->index->entries->len; i++) { |
| 683 | struct ctf_fs_ds_index_entry *other_entry = g_ptr_array_index( |
| 684 | ds_file_group->index->entries, i); |
| 685 | |
| 686 | if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) { |
| 687 | break; |
| 688 | } |
| 689 | } |
| 690 | |
| 691 | array_insert(ds_file_group->index->entries, entry, i); |
| 692 | } |
| 693 | |
| 694 | /* |
| 695 | * Create a new ds_file_info using the provided path, begin_ns and index, then |
| 696 | * add it to ds_file_group's list of ds_file_infos. |
| 697 | */ |
| 698 | |
| 699 | static |
| 700 | int ctf_fs_ds_file_group_add_ds_file_info( |
| 701 | struct ctf_fs_ds_file_group *ds_file_group, |
| 702 | const char *path, int64_t begin_ns) |
| 703 | { |
| 704 | struct ctf_fs_ds_file_info *ds_file_info; |
| 705 | int ret = 0; |
| 706 | |
| 707 | ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns); |
| 708 | if (!ds_file_info) { |
| 709 | goto error; |
| 710 | } |
| 711 | |
| 712 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info); |
| 713 | |
| 714 | ds_file_info = NULL; |
| 715 | goto end; |
| 716 | |
| 717 | error: |
| 718 | ctf_fs_ds_file_info_destroy(ds_file_info); |
| 719 | ret = -1; |
| 720 | end: |
| 721 | return ret; |
| 722 | } |
| 723 | |
| 724 | static |
| 725 | int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace, |
| 726 | const char *path) |
| 727 | { |
| 728 | int64_t stream_instance_id = -1; |
| 729 | int64_t begin_ns = -1; |
| 730 | struct ctf_fs_ds_file_group *ds_file_group = NULL; |
| 731 | bool add_group = false; |
| 732 | int ret; |
| 733 | size_t i; |
| 734 | struct ctf_fs_ds_file *ds_file = NULL; |
| 735 | struct ctf_fs_ds_index *index = NULL; |
| 736 | struct bt_msg_iter *msg_iter = NULL; |
| 737 | struct ctf_stream_class *sc = NULL; |
| 738 | struct bt_msg_iter_packet_properties props; |
| 739 | bt_logging_level log_level = ctf_fs_trace->log_level; |
| 740 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
| 741 | |
| 742 | msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc, |
| 743 | bt_common_get_page_size(log_level) * 8, |
| 744 | ctf_fs_ds_file_medops, NULL, log_level, self_comp); |
| 745 | if (!msg_iter) { |
| 746 | BT_COMP_LOGE_STR("Cannot create a CTF message iterator."); |
| 747 | goto error; |
| 748 | } |
| 749 | |
| 750 | ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter, |
| 751 | NULL, path, log_level); |
| 752 | if (!ds_file) { |
| 753 | goto error; |
| 754 | } |
| 755 | |
| 756 | ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props); |
| 757 | if (ret) { |
| 758 | BT_COMP_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).", |
| 759 | path); |
| 760 | goto error; |
| 761 | } |
| 762 | |
| 763 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, |
| 764 | props.stream_class_id); |
| 765 | BT_ASSERT(sc); |
| 766 | stream_instance_id = props.data_stream_id; |
| 767 | |
| 768 | if (props.snapshots.beginning_clock != UINT64_C(-1)) { |
| 769 | BT_ASSERT(sc->default_clock_class); |
| 770 | ret = bt_util_clock_cycles_to_ns_from_origin( |
| 771 | props.snapshots.beginning_clock, |
| 772 | sc->default_clock_class->frequency, |
| 773 | sc->default_clock_class->offset_seconds, |
| 774 | sc->default_clock_class->offset_cycles, &begin_ns); |
| 775 | if (ret) { |
| 776 | BT_COMP_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).", |
| 777 | path); |
| 778 | goto error; |
| 779 | } |
| 780 | } |
| 781 | |
| 782 | index = ctf_fs_ds_file_build_index(ds_file); |
| 783 | if (!index) { |
| 784 | BT_COMP_LOGW("Failed to index CTF stream file \'%s\'", |
| 785 | ds_file->file->path->str); |
| 786 | } |
| 787 | |
| 788 | if (begin_ns == -1) { |
| 789 | /* |
| 790 | * No beggining timestamp to sort the stream files |
| 791 | * within a stream file group, so consider that this |
| 792 | * file must be the only one within its group. |
| 793 | */ |
| 794 | stream_instance_id = -1; |
| 795 | } |
| 796 | |
| 797 | if (stream_instance_id == -1) { |
| 798 | /* |
| 799 | * No stream instance ID or no beginning timestamp: |
| 800 | * create a unique stream file group for this stream |
| 801 | * file because, even if there's a stream instance ID, |
| 802 | * there's no timestamp to order the file within its |
| 803 | * group. |
| 804 | */ |
| 805 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, |
| 806 | sc, UINT64_C(-1), index); |
| 807 | /* Ownership of index is transferred. */ |
| 808 | index = NULL; |
| 809 | |
| 810 | if (!ds_file_group) { |
| 811 | goto error; |
| 812 | } |
| 813 | |
| 814 | ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, |
| 815 | path, begin_ns); |
| 816 | if (ret) { |
| 817 | goto error; |
| 818 | } |
| 819 | |
| 820 | add_group = true; |
| 821 | goto end; |
| 822 | } |
| 823 | |
| 824 | BT_ASSERT(stream_instance_id != -1); |
| 825 | BT_ASSERT(begin_ns != -1); |
| 826 | |
| 827 | /* Find an existing stream file group with this ID */ |
| 828 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { |
| 829 | ds_file_group = g_ptr_array_index( |
| 830 | ctf_fs_trace->ds_file_groups, i); |
| 831 | |
| 832 | if (ds_file_group->sc == sc && |
| 833 | ds_file_group->stream_id == |
| 834 | stream_instance_id) { |
| 835 | break; |
| 836 | } |
| 837 | |
| 838 | ds_file_group = NULL; |
| 839 | } |
| 840 | |
| 841 | if (!ds_file_group) { |
| 842 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, |
| 843 | sc, stream_instance_id, index); |
| 844 | /* Ownership of index is transferred. */ |
| 845 | index = NULL; |
| 846 | if (!ds_file_group) { |
| 847 | goto error; |
| 848 | } |
| 849 | |
| 850 | add_group = true; |
| 851 | } |
| 852 | |
| 853 | ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, path, |
| 854 | begin_ns); |
| 855 | if (ret) { |
| 856 | goto error; |
| 857 | } |
| 858 | |
| 859 | goto end; |
| 860 | |
| 861 | error: |
| 862 | ctf_fs_ds_file_group_destroy(ds_file_group); |
| 863 | ds_file_group = NULL; |
| 864 | ret = -1; |
| 865 | |
| 866 | end: |
| 867 | if (add_group && ds_file_group) { |
| 868 | g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group); |
| 869 | } |
| 870 | |
| 871 | ctf_fs_ds_file_destroy(ds_file); |
| 872 | |
| 873 | if (msg_iter) { |
| 874 | bt_msg_iter_destroy(msg_iter); |
| 875 | } |
| 876 | |
| 877 | ctf_fs_ds_index_destroy(index); |
| 878 | return ret; |
| 879 | } |
| 880 | |
| 881 | static |
| 882 | int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) |
| 883 | { |
| 884 | int ret = 0; |
| 885 | const char *basename; |
| 886 | GError *error = NULL; |
| 887 | GDir *dir = NULL; |
| 888 | bt_logging_level log_level = ctf_fs_trace->log_level; |
| 889 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
| 890 | |
| 891 | /* Check each file in the path directory, except specific ones */ |
| 892 | dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); |
| 893 | if (!dir) { |
| 894 | BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)", |
| 895 | ctf_fs_trace->path->str, error->message, |
| 896 | error->code); |
| 897 | goto error; |
| 898 | } |
| 899 | |
| 900 | while ((basename = g_dir_read_name(dir))) { |
| 901 | struct ctf_fs_file *file; |
| 902 | |
| 903 | if (!strcmp(basename, CTF_FS_METADATA_FILENAME)) { |
| 904 | /* Ignore the metadata stream. */ |
| 905 | BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`", |
| 906 | ctf_fs_trace->path->str, basename); |
| 907 | continue; |
| 908 | } |
| 909 | |
| 910 | if (basename[0] == '.') { |
| 911 | BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`", |
| 912 | ctf_fs_trace->path->str, basename); |
| 913 | continue; |
| 914 | } |
| 915 | |
| 916 | /* Create the file. */ |
| 917 | file = ctf_fs_file_create(log_level, self_comp); |
| 918 | if (!file) { |
| 919 | BT_COMP_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`", |
| 920 | ctf_fs_trace->path->str, basename); |
| 921 | goto error; |
| 922 | } |
| 923 | |
| 924 | /* Create full path string. */ |
| 925 | g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s", |
| 926 | ctf_fs_trace->path->str, basename); |
| 927 | if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) { |
| 928 | BT_COMP_LOGI("Ignoring non-regular file `%s`", |
| 929 | file->path->str); |
| 930 | ctf_fs_file_destroy(file); |
| 931 | file = NULL; |
| 932 | continue; |
| 933 | } |
| 934 | |
| 935 | ret = ctf_fs_file_open(file, "rb"); |
| 936 | if (ret) { |
| 937 | BT_COMP_LOGE("Cannot open stream file `%s`", file->path->str); |
| 938 | goto error; |
| 939 | } |
| 940 | |
| 941 | if (file->size == 0) { |
| 942 | /* Skip empty stream. */ |
| 943 | BT_COMP_LOGI("Ignoring empty file `%s`", file->path->str); |
| 944 | ctf_fs_file_destroy(file); |
| 945 | continue; |
| 946 | } |
| 947 | |
| 948 | ret = add_ds_file_to_ds_file_group(ctf_fs_trace, |
| 949 | file->path->str); |
| 950 | if (ret) { |
| 951 | BT_COMP_LOGE("Cannot add stream file `%s` to stream file group", |
| 952 | file->path->str); |
| 953 | ctf_fs_file_destroy(file); |
| 954 | goto error; |
| 955 | } |
| 956 | |
| 957 | ctf_fs_file_destroy(file); |
| 958 | } |
| 959 | |
| 960 | goto end; |
| 961 | |
| 962 | error: |
| 963 | ret = -1; |
| 964 | |
| 965 | end: |
| 966 | if (dir) { |
| 967 | g_dir_close(dir); |
| 968 | dir = NULL; |
| 969 | } |
| 970 | |
| 971 | if (error) { |
| 972 | g_error_free(error); |
| 973 | } |
| 974 | |
| 975 | return ret; |
| 976 | } |
| 977 | |
| 978 | static |
| 979 | int set_trace_name(bt_trace *trace, const char *name_suffix, |
| 980 | bt_logging_level log_level, bt_self_component *self_comp) |
| 981 | { |
| 982 | int ret = 0; |
| 983 | const bt_trace_class *tc = bt_trace_borrow_class_const(trace); |
| 984 | const bt_value *val; |
| 985 | GString *name; |
| 986 | |
| 987 | name = g_string_new(NULL); |
| 988 | if (!name) { |
| 989 | BT_COMP_LOGE_STR("Failed to allocate a GString."); |
| 990 | ret = -1; |
| 991 | goto end; |
| 992 | } |
| 993 | |
| 994 | /* |
| 995 | * Check if we have a trace environment string value named `hostname`. |
| 996 | * If so, use it as the trace name's prefix. |
| 997 | */ |
| 998 | val = bt_trace_class_borrow_environment_entry_value_by_name_const( |
| 999 | tc, "hostname"); |
| 1000 | if (val && bt_value_is_string(val)) { |
| 1001 | g_string_append(name, bt_value_string_get(val)); |
| 1002 | |
| 1003 | if (name_suffix) { |
| 1004 | g_string_append_c(name, G_DIR_SEPARATOR); |
| 1005 | } |
| 1006 | } |
| 1007 | |
| 1008 | if (name_suffix) { |
| 1009 | g_string_append(name, name_suffix); |
| 1010 | } |
| 1011 | |
| 1012 | ret = bt_trace_set_name(trace, name->str); |
| 1013 | if (ret) { |
| 1014 | goto end; |
| 1015 | } |
| 1016 | |
| 1017 | goto end; |
| 1018 | |
| 1019 | end: |
| 1020 | if (name) { |
| 1021 | g_string_free(name, TRUE); |
| 1022 | } |
| 1023 | |
| 1024 | return ret; |
| 1025 | } |
| 1026 | |
| 1027 | static |
| 1028 | struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component *self_comp, |
| 1029 | const char *path, const char *name, |
| 1030 | struct ctf_fs_metadata_config *metadata_config, |
| 1031 | bt_logging_level log_level) |
| 1032 | { |
| 1033 | struct ctf_fs_trace *ctf_fs_trace; |
| 1034 | int ret; |
| 1035 | |
| 1036 | ctf_fs_trace = g_new0(struct ctf_fs_trace, 1); |
| 1037 | if (!ctf_fs_trace) { |
| 1038 | goto end; |
| 1039 | } |
| 1040 | |
| 1041 | ctf_fs_trace->log_level = log_level; |
| 1042 | ctf_fs_trace->self_comp = self_comp; |
| 1043 | ctf_fs_trace->path = g_string_new(path); |
| 1044 | if (!ctf_fs_trace->path) { |
| 1045 | goto error; |
| 1046 | } |
| 1047 | |
| 1048 | ctf_fs_trace->name = g_string_new(name); |
| 1049 | if (!ctf_fs_trace->name) { |
| 1050 | goto error; |
| 1051 | } |
| 1052 | |
| 1053 | ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1); |
| 1054 | if (!ctf_fs_trace->metadata) { |
| 1055 | goto error; |
| 1056 | } |
| 1057 | |
| 1058 | ctf_fs_metadata_init(ctf_fs_trace->metadata); |
| 1059 | ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func( |
| 1060 | (GDestroyNotify) ctf_fs_ds_file_group_destroy); |
| 1061 | if (!ctf_fs_trace->ds_file_groups) { |
| 1062 | goto error; |
| 1063 | } |
| 1064 | |
| 1065 | ret = ctf_fs_metadata_set_trace_class(self_comp, ctf_fs_trace, |
| 1066 | metadata_config); |
| 1067 | if (ret) { |
| 1068 | goto error; |
| 1069 | } |
| 1070 | |
| 1071 | if (ctf_fs_trace->metadata->trace_class) { |
| 1072 | ctf_fs_trace->trace = |
| 1073 | bt_trace_create(ctf_fs_trace->metadata->trace_class); |
| 1074 | if (!ctf_fs_trace->trace) { |
| 1075 | goto error; |
| 1076 | } |
| 1077 | } |
| 1078 | |
| 1079 | if (ctf_fs_trace->trace) { |
| 1080 | ret = set_trace_name(ctf_fs_trace->trace, name, log_level, |
| 1081 | self_comp); |
| 1082 | if (ret) { |
| 1083 | goto error; |
| 1084 | } |
| 1085 | } |
| 1086 | |
| 1087 | ret = create_ds_file_groups(ctf_fs_trace); |
| 1088 | if (ret) { |
| 1089 | goto error; |
| 1090 | } |
| 1091 | |
| 1092 | goto end; |
| 1093 | |
| 1094 | error: |
| 1095 | ctf_fs_trace_destroy(ctf_fs_trace); |
| 1096 | ctf_fs_trace = NULL; |
| 1097 | |
| 1098 | end: |
| 1099 | return ctf_fs_trace; |
| 1100 | } |
| 1101 | |
| 1102 | static |
| 1103 | int path_is_ctf_trace(const char *path) |
| 1104 | { |
| 1105 | GString *metadata_path = g_string_new(NULL); |
| 1106 | int ret = 0; |
| 1107 | |
| 1108 | if (!metadata_path) { |
| 1109 | ret = -1; |
| 1110 | goto end; |
| 1111 | } |
| 1112 | |
| 1113 | g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); |
| 1114 | |
| 1115 | if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { |
| 1116 | ret = 1; |
| 1117 | goto end; |
| 1118 | } |
| 1119 | |
| 1120 | end: |
| 1121 | g_string_free(metadata_path, TRUE); |
| 1122 | return ret; |
| 1123 | } |
| 1124 | |
| 1125 | static |
| 1126 | int add_trace_path(GList **trace_paths, const char *path, |
| 1127 | bt_logging_level log_level, bt_self_component *self_comp) |
| 1128 | { |
| 1129 | GString *norm_path = NULL; |
| 1130 | int ret = 0; |
| 1131 | |
| 1132 | norm_path = bt_common_normalize_path(path, NULL); |
| 1133 | if (!norm_path) { |
| 1134 | BT_COMP_LOGE("Failed to normalize path `%s`.", path); |
| 1135 | ret = -1; |
| 1136 | goto end; |
| 1137 | } |
| 1138 | |
| 1139 | // FIXME: Remove or ifdef for __MINGW32__ |
| 1140 | if (strcmp(norm_path->str, "/") == 0) { |
| 1141 | BT_COMP_LOGE("Opening a trace in `/` is not supported."); |
| 1142 | ret = -1; |
| 1143 | goto end; |
| 1144 | } |
| 1145 | |
| 1146 | *trace_paths = g_list_prepend(*trace_paths, norm_path); |
| 1147 | BT_ASSERT(*trace_paths); |
| 1148 | norm_path = NULL; |
| 1149 | |
| 1150 | end: |
| 1151 | if (norm_path) { |
| 1152 | g_string_free(norm_path, TRUE); |
| 1153 | } |
| 1154 | |
| 1155 | return ret; |
| 1156 | } |
| 1157 | |
| 1158 | static |
| 1159 | int ctf_fs_find_traces(GList **trace_paths, const char *start_path, |
| 1160 | bt_logging_level log_level, bt_self_component *self_comp) |
| 1161 | { |
| 1162 | int ret; |
| 1163 | GError *error = NULL; |
| 1164 | GDir *dir = NULL; |
| 1165 | const char *basename = NULL; |
| 1166 | |
| 1167 | /* Check if the starting path is a CTF trace itself */ |
| 1168 | ret = path_is_ctf_trace(start_path); |
| 1169 | if (ret < 0) { |
| 1170 | goto end; |
| 1171 | } |
| 1172 | |
| 1173 | if (ret) { |
| 1174 | /* |
| 1175 | * Stop recursion: a CTF trace cannot contain another |
| 1176 | * CTF trace. |
| 1177 | */ |
| 1178 | ret = add_trace_path(trace_paths, start_path, log_level, |
| 1179 | self_comp); |
| 1180 | goto end; |
| 1181 | } |
| 1182 | |
| 1183 | /* Look for subdirectories */ |
| 1184 | if (!g_file_test(start_path, G_FILE_TEST_IS_DIR)) { |
| 1185 | /* Starting path is not a directory: end of recursion */ |
| 1186 | goto end; |
| 1187 | } |
| 1188 | |
| 1189 | dir = g_dir_open(start_path, 0, &error); |
| 1190 | if (!dir) { |
| 1191 | if (error->code == G_FILE_ERROR_ACCES) { |
| 1192 | BT_COMP_LOGI("Cannot open directory `%s`: %s (code %d): continuing", |
| 1193 | start_path, error->message, error->code); |
| 1194 | goto end; |
| 1195 | } |
| 1196 | |
| 1197 | BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)", |
| 1198 | start_path, error->message, error->code); |
| 1199 | ret = -1; |
| 1200 | goto end; |
| 1201 | } |
| 1202 | |
| 1203 | while ((basename = g_dir_read_name(dir))) { |
| 1204 | GString *sub_path = g_string_new(NULL); |
| 1205 | |
| 1206 | if (!sub_path) { |
| 1207 | ret = -1; |
| 1208 | goto end; |
| 1209 | } |
| 1210 | |
| 1211 | g_string_printf(sub_path, "%s" G_DIR_SEPARATOR_S "%s", start_path, basename); |
| 1212 | ret = ctf_fs_find_traces(trace_paths, sub_path->str, |
| 1213 | log_level, self_comp); |
| 1214 | g_string_free(sub_path, TRUE); |
| 1215 | if (ret) { |
| 1216 | goto end; |
| 1217 | } |
| 1218 | } |
| 1219 | |
| 1220 | end: |
| 1221 | if (dir) { |
| 1222 | g_dir_close(dir); |
| 1223 | } |
| 1224 | |
| 1225 | if (error) { |
| 1226 | g_error_free(error); |
| 1227 | } |
| 1228 | |
| 1229 | return ret; |
| 1230 | } |
| 1231 | |
| 1232 | static |
| 1233 | GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path) { |
| 1234 | GList *trace_names = NULL; |
| 1235 | GList *node; |
| 1236 | const char *last_sep; |
| 1237 | size_t base_dist; |
| 1238 | |
| 1239 | /* |
| 1240 | * At this point we know that all the trace paths are |
| 1241 | * normalized, and so is the base path. This means that |
| 1242 | * they are absolute and they don't end with a separator. |
| 1243 | * We can simply find the location of the last separator |
| 1244 | * in the base path, which gives us the name of the actual |
| 1245 | * directory to look into, and use this location as the |
| 1246 | * start of each trace name within each trace path. |
| 1247 | * |
| 1248 | * For example: |
| 1249 | * |
| 1250 | * Base path: /home/user/my-traces/some-trace |
| 1251 | * Trace paths: |
| 1252 | * - /home/user/my-traces/some-trace/host1/trace1 |
| 1253 | * - /home/user/my-traces/some-trace/host1/trace2 |
| 1254 | * - /home/user/my-traces/some-trace/host2/trace |
| 1255 | * - /home/user/my-traces/some-trace/other-trace |
| 1256 | * |
| 1257 | * In this case the trace names are: |
| 1258 | * |
| 1259 | * - some-trace/host1/trace1 |
| 1260 | * - some-trace/host1/trace2 |
| 1261 | * - some-trace/host2/trace |
| 1262 | * - some-trace/other-trace |
| 1263 | */ |
| 1264 | last_sep = strrchr(base_path, G_DIR_SEPARATOR); |
| 1265 | |
| 1266 | /* We know there's at least one separator */ |
| 1267 | BT_ASSERT(last_sep); |
| 1268 | |
| 1269 | /* Distance to base */ |
| 1270 | base_dist = last_sep - base_path + 1; |
| 1271 | |
| 1272 | /* Create the trace names */ |
| 1273 | for (node = trace_paths; node; node = g_list_next(node)) { |
| 1274 | GString *trace_name = g_string_new(NULL); |
| 1275 | GString *trace_path = node->data; |
| 1276 | |
| 1277 | BT_ASSERT(trace_name); |
| 1278 | g_string_assign(trace_name, &trace_path->str[base_dist]); |
| 1279 | trace_names = g_list_append(trace_names, trace_name); |
| 1280 | } |
| 1281 | |
| 1282 | return trace_names; |
| 1283 | } |
| 1284 | |
| 1285 | /* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path/root. */ |
| 1286 | |
| 1287 | static |
| 1288 | int ctf_fs_component_create_ctf_fs_traces_one_root( |
| 1289 | struct ctf_fs_component *ctf_fs, |
| 1290 | const char *path_param) |
| 1291 | { |
| 1292 | struct ctf_fs_trace *ctf_fs_trace = NULL; |
| 1293 | int ret = 0; |
| 1294 | GString *norm_path = NULL; |
| 1295 | GList *trace_paths = NULL; |
| 1296 | GList *trace_names = NULL; |
| 1297 | GList *tp_node; |
| 1298 | GList *tn_node; |
| 1299 | bt_logging_level log_level = ctf_fs->log_level; |
| 1300 | bt_self_component *self_comp = ctf_fs->self_comp; |
| 1301 | |
| 1302 | norm_path = bt_common_normalize_path(path_param, NULL); |
| 1303 | if (!norm_path) { |
| 1304 | BT_COMP_LOGE("Failed to normalize path: `%s`.", |
| 1305 | path_param); |
| 1306 | goto error; |
| 1307 | } |
| 1308 | |
| 1309 | ret = ctf_fs_find_traces(&trace_paths, norm_path->str, log_level, |
| 1310 | self_comp); |
| 1311 | if (ret) { |
| 1312 | goto error; |
| 1313 | } |
| 1314 | |
| 1315 | if (!trace_paths) { |
| 1316 | BT_COMP_LOGE("No CTF traces recursively found in `%s`.", |
| 1317 | path_param); |
| 1318 | goto error; |
| 1319 | } |
| 1320 | |
| 1321 | trace_names = ctf_fs_create_trace_names(trace_paths, norm_path->str); |
| 1322 | if (!trace_names) { |
| 1323 | BT_COMP_LOGE("Cannot create trace names from trace paths."); |
| 1324 | goto error; |
| 1325 | } |
| 1326 | |
| 1327 | for (tp_node = trace_paths, tn_node = trace_names; tp_node; |
| 1328 | tp_node = g_list_next(tp_node), |
| 1329 | tn_node = g_list_next(tn_node)) { |
| 1330 | GString *trace_path = tp_node->data; |
| 1331 | GString *trace_name = tn_node->data; |
| 1332 | |
| 1333 | ctf_fs_trace = ctf_fs_trace_create(self_comp, |
| 1334 | trace_path->str, trace_name->str, |
| 1335 | &ctf_fs->metadata_config, |
| 1336 | log_level); |
| 1337 | if (!ctf_fs_trace) { |
| 1338 | BT_COMP_LOGE("Cannot create trace for `%s`.", |
| 1339 | trace_path->str); |
| 1340 | goto error; |
| 1341 | } |
| 1342 | |
| 1343 | g_ptr_array_add(ctf_fs->traces, ctf_fs_trace); |
| 1344 | ctf_fs_trace = NULL; |
| 1345 | } |
| 1346 | |
| 1347 | goto end; |
| 1348 | |
| 1349 | error: |
| 1350 | ret = -1; |
| 1351 | ctf_fs_trace_destroy(ctf_fs_trace); |
| 1352 | |
| 1353 | end: |
| 1354 | for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) { |
| 1355 | if (tp_node->data) { |
| 1356 | g_string_free(tp_node->data, TRUE); |
| 1357 | } |
| 1358 | } |
| 1359 | |
| 1360 | for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) { |
| 1361 | if (tn_node->data) { |
| 1362 | g_string_free(tn_node->data, TRUE); |
| 1363 | } |
| 1364 | } |
| 1365 | |
| 1366 | if (trace_paths) { |
| 1367 | g_list_free(trace_paths); |
| 1368 | } |
| 1369 | |
| 1370 | if (trace_names) { |
| 1371 | g_list_free(trace_names); |
| 1372 | } |
| 1373 | |
| 1374 | if (norm_path) { |
| 1375 | g_string_free(norm_path, TRUE); |
| 1376 | } |
| 1377 | |
| 1378 | return ret; |
| 1379 | } |
| 1380 | |
| 1381 | /* GCompareFunc to sort traces by UUID. */ |
| 1382 | |
| 1383 | static |
| 1384 | gint sort_traces_by_uuid(gconstpointer a, gconstpointer b) |
| 1385 | { |
| 1386 | const struct ctf_fs_trace *trace_a = *((const struct ctf_fs_trace **) a); |
| 1387 | const struct ctf_fs_trace *trace_b = *((const struct ctf_fs_trace **) b); |
| 1388 | |
| 1389 | bool trace_a_has_uuid = trace_a->metadata->tc->is_uuid_set; |
| 1390 | bool trace_b_has_uuid = trace_b->metadata->tc->is_uuid_set; |
| 1391 | gint ret; |
| 1392 | |
| 1393 | /* Order traces without uuid first. */ |
| 1394 | if (!trace_a_has_uuid && trace_b_has_uuid) { |
| 1395 | ret = -1; |
| 1396 | } else if (trace_a_has_uuid && !trace_b_has_uuid) { |
| 1397 | ret = 1; |
| 1398 | } else if (!trace_a_has_uuid && !trace_b_has_uuid) { |
| 1399 | ret = 0; |
| 1400 | } else { |
| 1401 | ret = bt_uuid_compare(trace_a->metadata->tc->uuid, trace_b->metadata->tc->uuid); |
| 1402 | } |
| 1403 | |
| 1404 | return ret; |
| 1405 | } |
| 1406 | |
| 1407 | /* |
| 1408 | * Count the number of stream and event classes defined by this trace's metadata. |
| 1409 | * |
| 1410 | * This is used to determine which metadata is the "latest", out of multiple |
| 1411 | * traces sharing the same UUID. It is assumed that amongst all these metadatas, |
| 1412 | * a bigger metadata is a superset of a smaller metadata. Therefore, it is |
| 1413 | * enough to just count the classes. |
| 1414 | */ |
| 1415 | |
| 1416 | static |
| 1417 | unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace) |
| 1418 | { |
| 1419 | unsigned int num = trace->metadata->tc->stream_classes->len; |
| 1420 | guint i; |
| 1421 | |
| 1422 | for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) { |
| 1423 | struct ctf_stream_class *sc = trace->metadata->tc->stream_classes->pdata[i]; |
| 1424 | num += sc->event_classes->len; |
| 1425 | } |
| 1426 | |
| 1427 | return num; |
| 1428 | } |
| 1429 | |
| 1430 | /* |
| 1431 | * Merge the src ds_file_group into dest. This consists of merging their |
| 1432 | * ds_file_infos, making sure to keep the result sorted. |
| 1433 | */ |
| 1434 | |
| 1435 | static |
| 1436 | void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, struct ctf_fs_ds_file_group *src) |
| 1437 | { |
| 1438 | guint i; |
| 1439 | |
| 1440 | for (i = 0; i < src->ds_file_infos->len; i++) { |
| 1441 | struct ctf_fs_ds_file_info *ds_file_info = |
| 1442 | g_ptr_array_index(src->ds_file_infos, i); |
| 1443 | |
| 1444 | /* Ownership of the ds_file_info is transferred to dest. */ |
| 1445 | g_ptr_array_index(src->ds_file_infos, i) = NULL; |
| 1446 | |
| 1447 | ds_file_group_insert_ds_file_info_sorted(dest, ds_file_info); |
| 1448 | } |
| 1449 | |
| 1450 | /* Merge both indexes. */ |
| 1451 | for (i = 0; i < src->index->entries->len; i++) { |
| 1452 | struct ctf_fs_ds_index_entry *entry = g_ptr_array_index( |
| 1453 | src->index->entries, i); |
| 1454 | |
| 1455 | /* |
| 1456 | * Ownership of the ctf_fs_ds_index_entry is transferred to |
| 1457 | * dest. |
| 1458 | */ |
| 1459 | g_ptr_array_index(src->index->entries, i) = NULL; |
| 1460 | |
| 1461 | ds_file_group_insert_ds_index_entry_sorted(dest, entry); |
| 1462 | } |
| 1463 | } |
| 1464 | /* Merge src_trace's data stream file groups into dest_trace's. */ |
| 1465 | |
| 1466 | static |
| 1467 | int merge_matching_ctf_fs_ds_file_groups( |
| 1468 | struct ctf_fs_trace *dest_trace, |
| 1469 | struct ctf_fs_trace *src_trace) |
| 1470 | { |
| 1471 | |
| 1472 | GPtrArray *dest = dest_trace->ds_file_groups; |
| 1473 | GPtrArray *src = src_trace->ds_file_groups; |
| 1474 | guint s_i; |
| 1475 | int ret = 0; |
| 1476 | |
| 1477 | /* |
| 1478 | * Save the initial length of dest: we only want to check against the |
| 1479 | * original elements in the inner loop. |
| 1480 | */ |
| 1481 | const guint dest_len = dest->len; |
| 1482 | |
| 1483 | for (s_i = 0; s_i < src->len; s_i++) { |
| 1484 | struct ctf_fs_ds_file_group *src_group = g_ptr_array_index(src, s_i); |
| 1485 | struct ctf_fs_ds_file_group *dest_group = NULL; |
| 1486 | |
| 1487 | /* A stream instance without ID can't match a stream in the other trace. */ |
| 1488 | if (src_group->stream_id != -1) { |
| 1489 | guint d_i; |
| 1490 | |
| 1491 | /* Let's search for a matching ds_file_group in the destination. */ |
| 1492 | for (d_i = 0; d_i < dest_len; d_i++) { |
| 1493 | struct ctf_fs_ds_file_group *candidate_dest = g_ptr_array_index(dest, d_i); |
| 1494 | |
| 1495 | /* Can't match a stream instance without ID. */ |
| 1496 | if (candidate_dest->stream_id == -1) { |
| 1497 | continue; |
| 1498 | } |
| 1499 | |
| 1500 | /* |
| 1501 | * If the two groups have the same stream instance id |
| 1502 | * and belong to the same stream class (stream instance |
| 1503 | * ids are per-stream class), they represent the same |
| 1504 | * stream instance. |
| 1505 | */ |
| 1506 | if (candidate_dest->stream_id != src_group->stream_id || |
| 1507 | candidate_dest->sc->id != src_group->sc->id) { |
| 1508 | continue; |
| 1509 | } |
| 1510 | |
| 1511 | dest_group = candidate_dest; |
| 1512 | break; |
| 1513 | } |
| 1514 | } |
| 1515 | |
| 1516 | /* |
| 1517 | * Didn't find a friend in dest to merge our src_group into? |
| 1518 | * Create a new empty one. This can happen if a stream was |
| 1519 | * active in the source trace chunk but not in the destination |
| 1520 | * trace chunk. |
| 1521 | */ |
| 1522 | if (!dest_group) { |
| 1523 | struct ctf_stream_class *sc; |
| 1524 | struct ctf_fs_ds_index *index; |
| 1525 | |
| 1526 | sc = ctf_trace_class_borrow_stream_class_by_id( |
| 1527 | dest_trace->metadata->tc, src_group->sc->id); |
| 1528 | BT_ASSERT(sc); |
| 1529 | |
| 1530 | index = ctf_fs_ds_index_create(dest_trace->log_level, |
| 1531 | dest_trace->self_comp); |
| 1532 | if (!index) { |
| 1533 | ret = -1; |
| 1534 | goto end; |
| 1535 | } |
| 1536 | |
| 1537 | dest_group = ctf_fs_ds_file_group_create(dest_trace, sc, |
| 1538 | src_group->stream_id, index); |
| 1539 | /* Ownership of index is transferred. */ |
| 1540 | index = NULL; |
| 1541 | if (!dest_group) { |
| 1542 | ret = -1; |
| 1543 | goto end; |
| 1544 | } |
| 1545 | |
| 1546 | g_ptr_array_add(dest_trace->ds_file_groups, dest_group); |
| 1547 | } |
| 1548 | |
| 1549 | BT_ASSERT(dest_group); |
| 1550 | merge_ctf_fs_ds_file_groups(dest_group, src_group); |
| 1551 | } |
| 1552 | |
| 1553 | end: |
| 1554 | return ret; |
| 1555 | } |
| 1556 | |
| 1557 | /* |
| 1558 | * Collapse the given traces, which must all share the same UUID, in a single |
| 1559 | * one. |
| 1560 | * |
| 1561 | * The trace with the most expansive metadata is chosen and all other traces |
| 1562 | * are merged into that one. The array slots of all the traces that get merged |
| 1563 | * in the chosen one are set to NULL, so only the slot of the chosen trace |
| 1564 | * remains non-NULL. |
| 1565 | */ |
| 1566 | |
| 1567 | static |
| 1568 | int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces) |
| 1569 | { |
| 1570 | unsigned int winner_count; |
| 1571 | struct ctf_fs_trace *winner; |
| 1572 | guint i; |
| 1573 | int ret = 0; |
| 1574 | char uuid_str[BABELTRACE_UUID_STR_LEN]; |
| 1575 | |
| 1576 | BT_ASSERT(num_traces >= 2); |
| 1577 | |
| 1578 | winner_count = metadata_count_stream_and_event_classes(traces[0]); |
| 1579 | winner = traces[0]; |
| 1580 | |
| 1581 | /* Find the trace with the largest metadata. */ |
| 1582 | for (i = 1; i < num_traces; i++) { |
| 1583 | struct ctf_fs_trace *candidate; |
| 1584 | unsigned int candidate_count; |
| 1585 | |
| 1586 | candidate = traces[i]; |
| 1587 | |
| 1588 | /* A bit of sanity check. */ |
| 1589 | BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0); |
| 1590 | |
| 1591 | candidate_count = metadata_count_stream_and_event_classes(candidate); |
| 1592 | |
| 1593 | if (candidate_count > winner_count) { |
| 1594 | winner_count = candidate_count; |
| 1595 | winner = candidate; |
| 1596 | } |
| 1597 | } |
| 1598 | |
| 1599 | /* Merge all the other traces in the winning trace. */ |
| 1600 | for (i = 0; i < num_traces; i++) { |
| 1601 | struct ctf_fs_trace *trace = traces[i]; |
| 1602 | |
| 1603 | /* Don't merge the winner into itself. */ |
| 1604 | if (trace == winner) { |
| 1605 | continue; |
| 1606 | } |
| 1607 | |
| 1608 | /* Merge trace's data stream file groups into winner's. */ |
| 1609 | ret = merge_matching_ctf_fs_ds_file_groups(winner, trace); |
| 1610 | if (ret) { |
| 1611 | goto end; |
| 1612 | } |
| 1613 | |
| 1614 | /* Free the trace that got merged into winner, clear the slot in the array. */ |
| 1615 | ctf_fs_trace_destroy(trace); |
| 1616 | traces[i] = NULL; |
| 1617 | } |
| 1618 | |
| 1619 | /* Use the string representation of the UUID as the trace name. */ |
| 1620 | bt_uuid_unparse(winner->metadata->tc->uuid, uuid_str); |
| 1621 | g_string_printf(winner->name, "%s", uuid_str); |
| 1622 | |
| 1623 | end: |
| 1624 | return ret; |
| 1625 | } |
| 1626 | |
| 1627 | /* |
| 1628 | * Merge all traces of `ctf_fs` that share the same UUID in a single trace. |
| 1629 | * Traces with no UUID are not merged. |
| 1630 | */ |
| 1631 | |
| 1632 | static |
| 1633 | int merge_traces_with_same_uuid(struct ctf_fs_component *ctf_fs) |
| 1634 | { |
| 1635 | GPtrArray *traces = ctf_fs->traces; |
| 1636 | guint range_start_idx = 0; |
| 1637 | unsigned int num_traces = 0; |
| 1638 | guint i; |
| 1639 | int ret = 0; |
| 1640 | |
| 1641 | /* Sort the traces by uuid, then collapse traces with the same uuid in a single one. */ |
| 1642 | g_ptr_array_sort(traces, sort_traces_by_uuid); |
| 1643 | |
| 1644 | /* Find ranges of consecutive traces that share the same UUID. */ |
| 1645 | while (range_start_idx < traces->len) { |
| 1646 | guint range_len; |
| 1647 | struct ctf_fs_trace *range_start_trace = g_ptr_array_index(traces, range_start_idx); |
| 1648 | |
| 1649 | /* Exclusive end of range. */ |
| 1650 | guint range_end_exc_idx = range_start_idx + 1; |
| 1651 | |
| 1652 | while (range_end_exc_idx < traces->len) { |
| 1653 | struct ctf_fs_trace *this_trace = g_ptr_array_index(traces, range_end_exc_idx); |
| 1654 | |
| 1655 | if (!range_start_trace->metadata->tc->is_uuid_set || |
| 1656 | (bt_uuid_compare(range_start_trace->metadata->tc->uuid, this_trace->metadata->tc->uuid) != 0)) { |
| 1657 | break; |
| 1658 | } |
| 1659 | |
| 1660 | range_end_exc_idx++; |
| 1661 | } |
| 1662 | |
| 1663 | /* If we have two or more traces with matching UUIDs, merge them. */ |
| 1664 | range_len = range_end_exc_idx - range_start_idx; |
| 1665 | if (range_len > 1) { |
| 1666 | struct ctf_fs_trace **range_start = (struct ctf_fs_trace **) &traces->pdata[range_start_idx]; |
| 1667 | ret = merge_ctf_fs_traces(range_start, range_len); |
| 1668 | if (ret) { |
| 1669 | goto end; |
| 1670 | } |
| 1671 | } |
| 1672 | |
| 1673 | num_traces++; |
| 1674 | range_start_idx = range_end_exc_idx; |
| 1675 | } |
| 1676 | |
| 1677 | /* Clear any NULL slot (traces that got merged in another one) in the array. */ |
| 1678 | for (i = 0; i < traces->len;) { |
| 1679 | if (g_ptr_array_index(traces, i) == NULL) { |
| 1680 | g_ptr_array_remove_index_fast(traces, i); |
| 1681 | } else { |
| 1682 | i++; |
| 1683 | } |
| 1684 | } |
| 1685 | |
| 1686 | BT_ASSERT(num_traces == traces->len); |
| 1687 | |
| 1688 | end: |
| 1689 | return ret; |
| 1690 | } |
| 1691 | |
| 1692 | int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp, |
| 1693 | struct ctf_fs_component *ctf_fs, |
| 1694 | const bt_value *paths_value) |
| 1695 | { |
| 1696 | int ret = 0; |
| 1697 | uint64_t i; |
| 1698 | |
| 1699 | for (i = 0; i < bt_value_array_get_size(paths_value); i++) { |
| 1700 | const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i); |
| 1701 | const char *path = bt_value_string_get(path_value); |
| 1702 | |
| 1703 | ret = ctf_fs_component_create_ctf_fs_traces_one_root(ctf_fs, |
| 1704 | path); |
| 1705 | if (ret) { |
| 1706 | goto end; |
| 1707 | } |
| 1708 | } |
| 1709 | |
| 1710 | ret = merge_traces_with_same_uuid(ctf_fs); |
| 1711 | |
| 1712 | end: |
| 1713 | return ret; |
| 1714 | } |
| 1715 | |
| 1716 | static |
| 1717 | GString *get_stream_instance_unique_name( |
| 1718 | struct ctf_fs_ds_file_group *ds_file_group) |
| 1719 | { |
| 1720 | GString *name; |
| 1721 | struct ctf_fs_ds_file_info *ds_file_info; |
| 1722 | |
| 1723 | name = g_string_new(NULL); |
| 1724 | if (!name) { |
| 1725 | goto end; |
| 1726 | } |
| 1727 | |
| 1728 | /* |
| 1729 | * If there's more than one stream file in the stream file |
| 1730 | * group, the first (earliest) stream file's path is used as |
| 1731 | * the stream's unique name. |
| 1732 | */ |
| 1733 | BT_ASSERT(ds_file_group->ds_file_infos->len > 0); |
| 1734 | ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0); |
| 1735 | g_string_assign(name, ds_file_info->path->str); |
| 1736 | |
| 1737 | end: |
| 1738 | return name; |
| 1739 | } |
| 1740 | |
| 1741 | /* Create the IR stream objects for ctf_fs_trace. */ |
| 1742 | |
| 1743 | static |
| 1744 | int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace) |
| 1745 | { |
| 1746 | int ret; |
| 1747 | GString *name = NULL; |
| 1748 | guint i; |
| 1749 | bt_logging_level log_level = ctf_fs_trace->log_level; |
| 1750 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
| 1751 | |
| 1752 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { |
| 1753 | struct ctf_fs_ds_file_group *ds_file_group = |
| 1754 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); |
| 1755 | name = get_stream_instance_unique_name(ds_file_group); |
| 1756 | |
| 1757 | if (!name) { |
| 1758 | goto error; |
| 1759 | } |
| 1760 | |
| 1761 | if (ds_file_group->sc->ir_sc) { |
| 1762 | BT_ASSERT(ctf_fs_trace->trace); |
| 1763 | |
| 1764 | if (ds_file_group->stream_id == UINT64_C(-1)) { |
| 1765 | /* No stream ID: use 0 */ |
| 1766 | ds_file_group->stream = bt_stream_create_with_id( |
| 1767 | ds_file_group->sc->ir_sc, |
| 1768 | ctf_fs_trace->trace, |
| 1769 | ctf_fs_trace->next_stream_id); |
| 1770 | ctf_fs_trace->next_stream_id++; |
| 1771 | } else { |
| 1772 | /* Specific stream ID */ |
| 1773 | ds_file_group->stream = bt_stream_create_with_id( |
| 1774 | ds_file_group->sc->ir_sc, |
| 1775 | ctf_fs_trace->trace, |
| 1776 | (uint64_t) ds_file_group->stream_id); |
| 1777 | } |
| 1778 | } else { |
| 1779 | ds_file_group->stream = NULL; |
| 1780 | } |
| 1781 | |
| 1782 | if (!ds_file_group->stream) { |
| 1783 | BT_COMP_LOGE("Cannot create stream for DS file group: " |
| 1784 | "addr=%p, stream-name=\"%s\"", |
| 1785 | ds_file_group, name->str); |
| 1786 | goto error; |
| 1787 | } |
| 1788 | |
| 1789 | ret = bt_stream_set_name(ds_file_group->stream, |
| 1790 | name->str); |
| 1791 | if (ret) { |
| 1792 | BT_COMP_LOGE("Cannot set stream's name: " |
| 1793 | "addr=%p, stream-name=\"%s\"", |
| 1794 | ds_file_group->stream, name->str); |
| 1795 | goto error; |
| 1796 | } |
| 1797 | |
| 1798 | g_string_free(name, TRUE); |
| 1799 | name = NULL; |
| 1800 | } |
| 1801 | |
| 1802 | ret = 0; |
| 1803 | goto end; |
| 1804 | |
| 1805 | error: |
| 1806 | ret = -1; |
| 1807 | |
| 1808 | end: |
| 1809 | |
| 1810 | if (name) { |
| 1811 | g_string_free(name, TRUE); |
| 1812 | } |
| 1813 | return ret; |
| 1814 | } |
| 1815 | |
| 1816 | /* |
| 1817 | * Validate the "paths" parameter passed to this component. It must be |
| 1818 | * present, and it must be an array of strings. |
| 1819 | */ |
| 1820 | |
| 1821 | static |
| 1822 | bool validate_paths_parameter(struct ctf_fs_component *ctf_fs, |
| 1823 | const bt_value *paths) |
| 1824 | { |
| 1825 | bool ret; |
| 1826 | bt_value_type type; |
| 1827 | uint64_t i; |
| 1828 | bt_logging_level log_level = ctf_fs->log_level; |
| 1829 | bt_self_component *self_comp = ctf_fs->self_comp; |
| 1830 | |
| 1831 | if (!paths) { |
| 1832 | BT_COMP_LOGE("missing \"paths\" parameter"); |
| 1833 | goto error; |
| 1834 | } |
| 1835 | |
| 1836 | type = bt_value_get_type(paths); |
| 1837 | if (type != BT_VALUE_TYPE_ARRAY) { |
| 1838 | BT_COMP_LOGE("`paths` parameter: expecting array value: type=%s", |
| 1839 | bt_common_value_type_string(type)); |
| 1840 | goto error; |
| 1841 | } |
| 1842 | |
| 1843 | for (i = 0; i < bt_value_array_get_size(paths); i++) { |
| 1844 | const bt_value *elem; |
| 1845 | |
| 1846 | elem = bt_value_array_borrow_element_by_index_const(paths, i); |
| 1847 | type = bt_value_get_type(elem); |
| 1848 | if (type != BT_VALUE_TYPE_STRING) { |
| 1849 | BT_COMP_LOGE("`paths` parameter: expecting string value: index=%" PRIu64 ", type=%s", |
| 1850 | i, bt_common_value_type_string(type)); |
| 1851 | goto error; |
| 1852 | } |
| 1853 | } |
| 1854 | |
| 1855 | ret = true; |
| 1856 | goto end; |
| 1857 | |
| 1858 | error: |
| 1859 | ret = false; |
| 1860 | |
| 1861 | end: |
| 1862 | return ret; |
| 1863 | } |
| 1864 | |
| 1865 | bool read_src_fs_parameters(const bt_value *params, |
| 1866 | const bt_value **paths, struct ctf_fs_component *ctf_fs) { |
| 1867 | bool ret; |
| 1868 | const bt_value *value; |
| 1869 | bt_logging_level log_level = ctf_fs->log_level; |
| 1870 | bt_self_component *self_comp = ctf_fs->self_comp; |
| 1871 | |
| 1872 | /* paths parameter */ |
| 1873 | *paths = bt_value_map_borrow_entry_value_const(params, "paths"); |
| 1874 | if (!validate_paths_parameter(ctf_fs, *paths)) { |
| 1875 | goto error; |
| 1876 | } |
| 1877 | |
| 1878 | /* clock-class-offset-s parameter */ |
| 1879 | value = bt_value_map_borrow_entry_value_const(params, |
| 1880 | "clock-class-offset-s"); |
| 1881 | if (value) { |
| 1882 | if (!bt_value_is_signed_integer(value)) { |
| 1883 | BT_COMP_LOGE("clock-class-offset-s must be an integer"); |
| 1884 | goto error; |
| 1885 | } |
| 1886 | ctf_fs->metadata_config.clock_class_offset_s = |
| 1887 | bt_value_signed_integer_get(value); |
| 1888 | } |
| 1889 | |
| 1890 | /* clock-class-offset-ns parameter */ |
| 1891 | value = bt_value_map_borrow_entry_value_const(params, |
| 1892 | "clock-class-offset-ns"); |
| 1893 | if (value) { |
| 1894 | if (!bt_value_is_signed_integer(value)) { |
| 1895 | BT_COMP_LOGE("clock-class-offset-ns must be an integer"); |
| 1896 | goto error; |
| 1897 | } |
| 1898 | ctf_fs->metadata_config.clock_class_offset_ns = |
| 1899 | bt_value_signed_integer_get(value); |
| 1900 | } |
| 1901 | |
| 1902 | |
| 1903 | ret = true; |
| 1904 | goto end; |
| 1905 | |
| 1906 | error: |
| 1907 | ret = false; |
| 1908 | |
| 1909 | end: |
| 1910 | return ret; |
| 1911 | } |
| 1912 | |
| 1913 | static |
| 1914 | struct ctf_fs_component *ctf_fs_create( |
| 1915 | bt_self_component_source *self_comp_src, |
| 1916 | const bt_value *params) |
| 1917 | { |
| 1918 | struct ctf_fs_component *ctf_fs = NULL; |
| 1919 | guint i; |
| 1920 | const bt_value *paths_value; |
| 1921 | bt_self_component *self_comp = |
| 1922 | bt_self_component_source_as_self_component(self_comp_src); |
| 1923 | |
| 1924 | ctf_fs = ctf_fs_component_create(bt_component_get_logging_level( |
| 1925 | bt_self_component_as_component(self_comp)), self_comp); |
| 1926 | if (!ctf_fs) { |
| 1927 | goto error; |
| 1928 | } |
| 1929 | |
| 1930 | if (!read_src_fs_parameters(params, &paths_value, ctf_fs)) { |
| 1931 | goto error; |
| 1932 | } |
| 1933 | |
| 1934 | bt_self_component_set_data(self_comp, ctf_fs); |
| 1935 | ctf_fs->self_comp = self_comp; |
| 1936 | ctf_fs->self_comp_src = self_comp_src; |
| 1937 | |
| 1938 | if (ctf_fs_component_create_ctf_fs_traces(self_comp_src, ctf_fs, paths_value)) { |
| 1939 | goto error; |
| 1940 | } |
| 1941 | |
| 1942 | for (i = 0; i < ctf_fs->traces->len; i++) { |
| 1943 | struct ctf_fs_trace *trace = g_ptr_array_index(ctf_fs->traces, i); |
| 1944 | |
| 1945 | if (create_streams_for_trace(trace)) { |
| 1946 | goto error; |
| 1947 | } |
| 1948 | |
| 1949 | if (create_ports_for_trace(ctf_fs, trace)) { |
| 1950 | goto error; |
| 1951 | } |
| 1952 | } |
| 1953 | |
| 1954 | goto end; |
| 1955 | |
| 1956 | error: |
| 1957 | ctf_fs_destroy(ctf_fs); |
| 1958 | ctf_fs = NULL; |
| 1959 | bt_self_component_set_data(self_comp, NULL); |
| 1960 | |
| 1961 | end: |
| 1962 | return ctf_fs; |
| 1963 | } |
| 1964 | |
| 1965 | BT_HIDDEN |
| 1966 | bt_component_class_init_method_status ctf_fs_init( |
| 1967 | bt_self_component_source *self_comp, |
| 1968 | const bt_value *params, __attribute__((unused)) void *init_method_data) |
| 1969 | { |
| 1970 | struct ctf_fs_component *ctf_fs; |
| 1971 | bt_component_class_init_method_status ret = |
| 1972 | BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK; |
| 1973 | |
| 1974 | ctf_fs = ctf_fs_create(self_comp, params); |
| 1975 | if (!ctf_fs) { |
| 1976 | ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; |
| 1977 | } |
| 1978 | |
| 1979 | return ret; |
| 1980 | } |
| 1981 | |
| 1982 | BT_HIDDEN |
| 1983 | bt_component_class_query_method_status ctf_fs_query( |
| 1984 | bt_self_component_class_source *comp_class, |
| 1985 | const bt_query_executor *query_exec, |
| 1986 | const char *object, const bt_value *params, |
| 1987 | bt_logging_level log_level, |
| 1988 | const bt_value **result) |
| 1989 | { |
| 1990 | bt_component_class_query_method_status status = |
| 1991 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; |
| 1992 | |
| 1993 | if (!strcmp(object, "metadata-info")) { |
| 1994 | status = metadata_info_query(comp_class, params, log_level, |
| 1995 | result); |
| 1996 | } else if (!strcmp(object, "trace-info")) { |
| 1997 | status = trace_info_query(comp_class, params, log_level, |
| 1998 | result); |
| 1999 | } else { |
| 2000 | BT_LOGE("Unknown query object `%s`", object); |
| 2001 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_OBJECT; |
| 2002 | goto end; |
| 2003 | } |
| 2004 | end: |
| 2005 | return status; |
| 2006 | } |