src/plugins/lttng-utils/debug-info/debug-info.c

   1 /*
   2  * Babeltrace - Debug Information State Tracker
   3  *
   4  * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
   5  * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
   7  * Copyright (c) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #define BT_COMP_LOG_SELF_COMP self_comp
  30 #define BT_LOG_OUTPUT_LEVEL log_level
  31 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO"
  32 #include "plugins/comp-logging.h"
  33
  34 #include <glib.h>
  35
  36 #include "common/assert.h"
  37 #include "common/common.h"
  38 #include "fd-cache/fd-cache.h"
  39
  40 #include "bin-info.h"
  41 #include "debug-info.h"
  42 #include "trace-ir-data-copy.h"
  43 #include "trace-ir-mapping.h"
  44 #include "trace-ir-metadata-copy.h"
  45 #include "utils.h"
  46
  47 #define DEFAULT_DEBUG_INFO_FIELD_NAME   "debug_info"
  48 #define LTTNG_UST_STATEDUMP_PREFIX      "lttng_ust"
  49 #define VPID_FIELD_NAME                 "vpid"
  50 #define IP_FIELD_NAME                   "ip"
  51 #define BADDR_FIELD_NAME                "baddr"
  52 #define CRC32_FIELD_NAME                "crc"
  53 #define BUILD_ID_FIELD_NAME             "build_id"
  54 #define FILENAME_FIELD_NAME             "filename"
  55 #define IS_PIC_FIELD_NAME               "is_pic"
  56 #define MEMSZ_FIELD_NAME                "memsz"
  57 #define PATH_FIELD_NAME                 "path"
  58
  59 struct debug_info_component {
  60         bt_logging_level log_level;
  61         bt_self_component *self_comp;
  62         gchar *arg_debug_dir;
  63         gchar *arg_debug_info_field_name;
  64         gchar *arg_target_prefix;
  65         bt_bool arg_full_path;
  66 };
  67
  68 struct debug_info_msg_iter {
  69         bt_logging_level log_level;
  70         struct debug_info_component *debug_info_component;
  71         bt_self_message_iterator *input_iterator;
  72         bt_self_component *self_comp;
  73         bt_self_component_port_input_message_iterator *msg_iter;
  74
  75         struct trace_ir_maps *ir_maps;
  76         /* in_trace -> debug_info_mapping. */
  77         GHashTable *debug_info_map;
  78
  79         struct bt_fd_cache fd_cache;
  80 };
  81
  82 struct debug_info_source {
  83         /* Strings are owned by debug_info_source. */
  84         gchar *func;
  85         /*
  86          * Store the line number as a string so that the allocation and
  87          * conversion to string is only done once.
  88          */
  89         gchar *line_no;
  90         gchar *src_path;
  91         /* short_src_path points inside src_path, no need to free. */
  92         const gchar *short_src_path;
  93         gchar *bin_path;
  94         /* short_bin_path points inside bin_path, no need to free. */
  95         const gchar *short_bin_path;
  96         /*
  97          * Location within the binary. Either absolute (@0x1234) or
  98          * relative (+0x4321).
  99          */
 100         gchar *bin_loc;
 101 };
 102
 103 struct proc_debug_info_sources {
 104         /*
 105          * Hash table: base address (pointer to uint64_t) to bin info; owned by
 106          * proc_debug_info_sources.
 107          */
 108         GHashTable *baddr_to_bin_info;
 109
 110         /*
 111          * Hash table: IP (pointer to uint64_t) to (struct debug_info_source *);
 112          * owned by proc_debug_info_sources.
 113          */
 114         GHashTable *ip_to_debug_info_src;
 115 };
 116
 117 struct debug_info {
 118         bt_logging_level log_level;
 119         bt_self_component *self_comp;
 120         struct debug_info_component *comp;
 121         const bt_trace *input_trace;
 122         uint64_t destruction_listener_id;
 123
 124         /*
 125          * Hash table of VPIDs (pointer to int64_t) to
 126          * (struct proc_debug_info_sources*); owned by debug_info.
 127          */
 128         GHashTable *vpid_to_proc_dbg_info_src;
 129         GQuark q_statedump_bin_info;
 130         GQuark q_statedump_debug_link;
 131         GQuark q_statedump_build_id;
 132         GQuark q_statedump_start;
 133         GQuark q_dl_open;
 134         GQuark q_lib_load;
 135         GQuark q_lib_unload;
 136         struct bt_fd_cache *fd_cache; /* Weak ref. Owned by the iterator. */
 137 };
 138
 139 static
 140 int debug_info_init(struct debug_info *info)
 141 {
 142         info->q_statedump_bin_info = g_quark_from_string(
 143                         "lttng_ust_statedump:bin_info");
 144         info->q_statedump_debug_link = g_quark_from_string(
 145                         "lttng_ust_statedump:debug_link");
 146         info->q_statedump_build_id = g_quark_from_string(
 147                         "lttng_ust_statedump:build_id");
 148         info->q_statedump_start = g_quark_from_string(
 149                         "lttng_ust_statedump:start");
 150         info->q_dl_open = g_quark_from_string("lttng_ust_dl:dlopen");
 151         info->q_lib_load = g_quark_from_string("lttng_ust_lib:load");
 152         info->q_lib_unload = g_quark_from_string("lttng_ust_lib:unload");
 153
 154         return bin_info_init(info->log_level, info->self_comp);
 155 }
 156
 157 static
 158 void debug_info_source_destroy(struct debug_info_source *debug_info_src)
 159 {
 160         if (!debug_info_src) {
 161                 return;
 162         }
 163
 164         g_free(debug_info_src->func);
 165         g_free(debug_info_src->line_no);
 166         g_free(debug_info_src->src_path);
 167         g_free(debug_info_src->bin_path);
 168         g_free(debug_info_src->bin_loc);
 169         g_free(debug_info_src);
 170 }
 171
 172 static
 173 struct debug_info_source *debug_info_source_create_from_bin(
 174                 struct bin_info *bin, uint64_t ip,
 175                 bt_self_component *self_comp)
 176 {
 177         int ret;
 178         struct debug_info_source *debug_info_src = NULL;
 179         struct source_location *src_loc = NULL;
 180         bt_logging_level log_level = bin->log_level;
 181
 182         debug_info_src = g_new0(struct debug_info_source, 1);
 183
 184         if (!debug_info_src) {
 185                 goto end;
 186         }
 187
 188         /* Lookup function name */
 189         ret = bin_info_lookup_function_name(bin, ip, &debug_info_src->func);
 190         if (ret) {
 191                 goto error;
 192         }
 193
 194         /* Can't retrieve src_loc from ELF, or could not find binary, skip. */
 195         if (!bin->is_elf_only || !debug_info_src->func) {
 196                 /* Lookup source location */
 197                 ret = bin_info_lookup_source_location(bin, ip, &src_loc);
 198                 if (ret) {
 199                         BT_COMP_LOGI("Failed to lookup source location: ret=%d", ret);
 200                 }
 201         }
 202
 203         if (src_loc) {
 204                 debug_info_src->line_no =
 205                         g_strdup_printf("%"PRId64, src_loc->line_no);
 206                 if (!debug_info_src->line_no) {
 207                         BT_COMP_LOGE("Error occured when setting line_no field.");
 208                         goto error;
 209                 }
 210
 211                 if (src_loc->filename) {
 212                         debug_info_src->src_path = g_strdup(src_loc->filename);
 213                         if (!debug_info_src->src_path) {
 214                                 goto error;
 215                         }
 216
 217                         debug_info_src->short_src_path = get_filename_from_path(
 218                                         debug_info_src->src_path);
 219                 }
 220                 source_location_destroy(src_loc);
 221         }
 222
 223         if (bin->elf_path) {
 224                 debug_info_src->bin_path = g_strdup(bin->elf_path);
 225                 if (!debug_info_src->bin_path) {
 226                         goto error;
 227                 }
 228
 229                 debug_info_src->short_bin_path = get_filename_from_path(
 230                                 debug_info_src->bin_path);
 231
 232                 ret = bin_info_get_bin_loc(bin, ip, &(debug_info_src->bin_loc));
 233                 if (ret) {
 234                         goto error;
 235                 }
 236         }
 237
 238 end:
 239         return debug_info_src;
 240
 241 error:
 242         debug_info_source_destroy(debug_info_src);
 243         return NULL;
 244 }
 245
 246 static
 247 void proc_debug_info_sources_destroy(
 248                 struct proc_debug_info_sources *proc_dbg_info_src)
 249 {
 250         if (!proc_dbg_info_src) {
 251                 return;
 252         }
 253
 254         if (proc_dbg_info_src->baddr_to_bin_info) {
 255                 g_hash_table_destroy(proc_dbg_info_src->baddr_to_bin_info);
 256         }
 257
 258         if (proc_dbg_info_src->ip_to_debug_info_src) {
 259                 g_hash_table_destroy(proc_dbg_info_src->ip_to_debug_info_src);
 260         }
 261
 262         g_free(proc_dbg_info_src);
 263 }
 264
 265 static
 266 struct proc_debug_info_sources *proc_debug_info_sources_create(void)
 267 {
 268         struct proc_debug_info_sources *proc_dbg_info_src = NULL;
 269
 270         proc_dbg_info_src = g_new0(struct proc_debug_info_sources, 1);
 271         if (!proc_dbg_info_src) {
 272                 goto end;
 273         }
 274
 275         proc_dbg_info_src->baddr_to_bin_info = g_hash_table_new_full(
 276                         g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
 277                         (GDestroyNotify) bin_info_destroy);
 278         if (!proc_dbg_info_src->baddr_to_bin_info) {
 279                 goto error;
 280         }
 281
 282         proc_dbg_info_src->ip_to_debug_info_src = g_hash_table_new_full(
 283                         g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
 284                         (GDestroyNotify) debug_info_source_destroy);
 285         if (!proc_dbg_info_src->ip_to_debug_info_src) {
 286                 goto error;
 287         }
 288
 289 end:
 290         return proc_dbg_info_src;
 291
 292 error:
 293         proc_debug_info_sources_destroy(proc_dbg_info_src);
 294         return NULL;
 295 }
 296
 297 static
 298 struct proc_debug_info_sources *proc_debug_info_sources_ht_get_entry(
 299                 GHashTable *ht, int64_t vpid)
 300 {
 301         gpointer key = g_new0(int64_t, 1);
 302         struct proc_debug_info_sources *proc_dbg_info_src = NULL;
 303
 304         if (!key) {
 305                 goto end;
 306         }
 307
 308         *((int64_t *) key) = vpid;
 309
 310         /* Exists? Return it */
 311         proc_dbg_info_src = g_hash_table_lookup(ht, key);
 312         if (proc_dbg_info_src) {
 313                 goto end;
 314         }
 315
 316         /* Otherwise, create and return it */
 317         proc_dbg_info_src = proc_debug_info_sources_create();
 318         if (!proc_dbg_info_src) {
 319                 goto end;
 320         }
 321
 322         g_hash_table_insert(ht, key, proc_dbg_info_src);
 323         /* Ownership passed to ht */
 324         key = NULL;
 325 end:
 326         g_free(key);
 327         return proc_dbg_info_src;
 328 }
 329
 330 static inline
 331 const bt_field *event_borrow_payload_field(const bt_event *event,
 332                 const char *field_name)
 333 {
 334         const bt_field *event_payload, *field;
 335
 336         event_payload =  bt_event_borrow_payload_field_const(event);
 337         BT_ASSERT(event_payload);
 338
 339         field = bt_field_structure_borrow_member_field_by_name_const(
 340                         event_payload, field_name);
 341         return field;
 342 }
 343
 344 static inline
 345 const bt_field *event_borrow_common_context_field(const bt_event *event,
 346                 const char *field_name)
 347 {
 348         const bt_field *event_common_ctx, *field = NULL;
 349
 350         event_common_ctx =  bt_event_borrow_common_context_field_const(event);
 351         if (!event_common_ctx) {
 352                 goto end;
 353         }
 354
 355         field = bt_field_structure_borrow_member_field_by_name_const(
 356                         event_common_ctx, field_name);
 357
 358 end:
 359         return field;
 360 }
 361
 362 static inline
 363 void event_get_common_context_signed_integer_field_value(
 364                 const bt_event *event, const char *field_name, int64_t *value)
 365 {
 366         *value = bt_field_signed_integer_get_value(
 367                         event_borrow_common_context_field(event, field_name));
 368 }
 369
 370 static inline
 371 int event_get_payload_build_id_length(const bt_event *event,
 372                 const char *field_name, uint64_t *build_id_len)
 373 {
 374         const bt_field *build_id_field;
 375         const bt_field_class *build_id_field_class;
 376
 377         build_id_field = event_borrow_payload_field(event, field_name);
 378         build_id_field_class = bt_field_borrow_class_const(build_id_field);
 379
 380         BT_ASSERT(bt_field_class_get_type(build_id_field_class) ==
 381                         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
 382         BT_ASSERT(bt_field_class_get_type(
 383                         bt_field_class_array_borrow_element_field_class_const(
 384                                 build_id_field_class)) ==
 385                         BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
 386
 387         *build_id_len = bt_field_array_get_length(build_id_field);
 388
 389         return 0;
 390 }
 391
 392 static inline
 393 int event_get_payload_build_id_value(const bt_event *event,
 394                 const char *field_name, uint8_t *build_id)
 395 {
 396         const bt_field *curr_field, *build_id_field;
 397         const bt_field_class *build_id_field_class;
 398         uint64_t i, build_id_len;
 399         int ret;
 400
 401         ret = 0;
 402
 403         build_id_field = event_borrow_payload_field(event, field_name);
 404         build_id_field_class = bt_field_borrow_class_const(build_id_field);
 405
 406         BT_ASSERT(bt_field_class_get_type(build_id_field_class) ==
 407                         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
 408         BT_ASSERT(bt_field_class_get_type(
 409                         bt_field_class_array_borrow_element_field_class_const(
 410                                 build_id_field_class)) ==
 411                         BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
 412
 413         build_id_len = bt_field_array_get_length(build_id_field);
 414
 415         for (i = 0; i < build_id_len; i++) {
 416                 curr_field =
 417                         bt_field_array_borrow_element_field_by_index_const(
 418                                         build_id_field, i);
 419
 420                 build_id[i] = bt_field_unsigned_integer_get_value(curr_field);
 421         }
 422
 423         return ret;
 424 }
 425
 426 static
 427 void event_get_payload_unsigned_integer_field_value(const bt_event *event,
 428                 const char *field_name, uint64_t *value)
 429 {
 430         *value = bt_field_unsigned_integer_get_value(
 431                         event_borrow_payload_field(event, field_name));
 432 }
 433
 434 static
 435 void event_get_payload_string_field_value(const bt_event *event,
 436                 const char *field_name, const char **value)
 437 {
 438         *value = bt_field_string_get_value(
 439                         event_borrow_payload_field(event, field_name));
 440 }
 441
 442 static inline
 443 bool event_has_payload_field(const bt_event *event,
 444                 const char *field_name)
 445 {
 446         return event_borrow_payload_field(event, field_name) != NULL;
 447 }
 448
 449 static
 450 struct debug_info_source *proc_debug_info_sources_get_entry(
 451                 struct debug_info *debug_info,
 452                 struct proc_debug_info_sources *proc_dbg_info_src, uint64_t ip)
 453 {
 454         struct debug_info_source *debug_info_src = NULL;
 455         gpointer key = g_new0(uint64_t, 1);
 456         GHashTableIter iter;
 457         gpointer baddr, value;
 458
 459         if (!key) {
 460                 goto end;
 461         }
 462
 463         *((uint64_t *) key) = ip;
 464
 465         /* Look in IP to debug infos hash table first. */
 466         debug_info_src = g_hash_table_lookup(
 467                         proc_dbg_info_src->ip_to_debug_info_src,
 468                         key);
 469         if (debug_info_src) {
 470                 goto end;
 471         }
 472
 473         /* Check in all bin_infos. */
 474         g_hash_table_iter_init(&iter, proc_dbg_info_src->baddr_to_bin_info);
 475
 476         while (g_hash_table_iter_next(&iter, &baddr, &value))
 477         {
 478                 struct bin_info *bin = value;
 479
 480                 if (!bin_info_has_address(value, ip)) {
 481                         continue;
 482                 }
 483
 484                 /*
 485                  * Found; add it to cache.
 486                  *
 487                  * FIXME: this should be bounded in size (and implement
 488                  * a caching policy), and entries should be prunned when
 489                  * libraries are unmapped.
 490                  */
 491                 debug_info_src = debug_info_source_create_from_bin(bin, ip,
 492                         debug_info->self_comp);
 493                 if (debug_info_src) {
 494                         g_hash_table_insert(
 495                                         proc_dbg_info_src->ip_to_debug_info_src,
 496                                         key, debug_info_src);
 497                         /* Ownership passed to ht. */
 498                         key = NULL;
 499                 }
 500                 break;
 501         }
 502
 503 end:
 504         free(key);
 505         return debug_info_src;
 506 }
 507
 508 static
 509 struct debug_info_source *debug_info_query(struct debug_info *debug_info,
 510                 int64_t vpid, uint64_t ip)
 511 {
 512         struct debug_info_source *dbg_info_src = NULL;
 513         struct proc_debug_info_sources *proc_dbg_info_src;
 514
 515         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 516                         debug_info->vpid_to_proc_dbg_info_src, vpid);
 517         if (!proc_dbg_info_src) {
 518                 goto end;
 519         }
 520
 521         dbg_info_src = proc_debug_info_sources_get_entry(debug_info,
 522                 proc_dbg_info_src, ip);
 523
 524 end:
 525         return dbg_info_src;
 526 }
 527
 528 static
 529 struct debug_info *debug_info_create(struct debug_info_component *comp,
 530                 const bt_trace *trace, struct bt_fd_cache *fdc)
 531 {
 532         int ret;
 533         struct debug_info *debug_info;
 534
 535         BT_ASSERT(comp);
 536         BT_ASSERT(trace);
 537         BT_ASSERT(fdc);
 538
 539         debug_info = g_new0(struct debug_info, 1);
 540         if (!debug_info) {
 541                 goto end;
 542         }
 543
 544         debug_info->log_level = comp->log_level;
 545         debug_info->self_comp = comp->self_comp;
 546         debug_info->vpid_to_proc_dbg_info_src = g_hash_table_new_full(
 547                         g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
 548                         (GDestroyNotify) proc_debug_info_sources_destroy);
 549         if (!debug_info->vpid_to_proc_dbg_info_src) {
 550                 goto error;
 551         }
 552
 553         debug_info->comp = comp;
 554         ret = debug_info_init(debug_info);
 555         if (ret) {
 556                 goto error;
 557         }
 558
 559         debug_info->input_trace = trace;
 560         debug_info->fd_cache = fdc;
 561
 562 end:
 563         return debug_info;
 564 error:
 565         g_free(debug_info);
 566         return NULL;
 567 }
 568
 569 static
 570 void debug_info_destroy(struct debug_info *debug_info)
 571 {
 572         bt_logging_level log_level;
 573         bt_self_component *self_comp;
 574         bt_trace_remove_listener_status remove_listener_status;
 575         if (!debug_info) {
 576                 goto end;
 577         }
 578
 579         log_level = debug_info->log_level;
 580         self_comp = debug_info->self_comp;
 581
 582         if (debug_info->vpid_to_proc_dbg_info_src) {
 583                 g_hash_table_destroy(debug_info->vpid_to_proc_dbg_info_src);
 584         }
 585
 586         remove_listener_status = bt_trace_remove_destruction_listener(
 587                         debug_info->input_trace,
 588                         debug_info->destruction_listener_id);
 589         if (remove_listener_status != BT_TRACE_REMOVE_LISTENER_STATUS_OK) {
 590                 BT_COMP_LOGE("Trace destruction listener removal failed.");
 591                 bt_current_thread_clear_error();
 592         }
 593
 594         g_free(debug_info);
 595 end:
 596         return;
 597 }
 598
 599 static
 600 void handle_event_statedump_build_id(struct debug_info *debug_info,
 601                 const bt_event *event)
 602 {
 603         struct proc_debug_info_sources *proc_dbg_info_src;
 604         uint64_t build_id_len, baddr;
 605         uint8_t *build_id = NULL;
 606         struct bin_info *bin;
 607         int64_t vpid;
 608         int ret = 0;
 609
 610         event_get_common_context_signed_integer_field_value(event,
 611                         VPID_FIELD_NAME, &vpid);
 612         event_get_payload_unsigned_integer_field_value(event,
 613                         BADDR_FIELD_NAME, &baddr);
 614
 615         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 616                         debug_info->vpid_to_proc_dbg_info_src, vpid);
 617         if (!proc_dbg_info_src) {
 618                 goto end;
 619         }
 620
 621         bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info,
 622                         (gpointer) &baddr);
 623         if (!bin) {
 624                 /*
 625                  * The build_id event comes after the bin has been
 626                  * created. If it isn't found, just ignore this event.
 627                  */
 628                 goto end;
 629         }
 630         ret = event_get_payload_build_id_length(event, BUILD_ID_FIELD_NAME,
 631                         &build_id_len);
 632
 633         build_id = g_new0(uint8_t, build_id_len);
 634         if (!build_id) {
 635                 goto end;
 636         }
 637
 638         ret = event_get_payload_build_id_value(event, BUILD_ID_FIELD_NAME,
 639                         build_id);
 640         if (ret) {
 641                 goto end;
 642         }
 643
 644         ret = bin_info_set_build_id(bin, build_id, build_id_len);
 645         if (ret) {
 646                 goto end;
 647         }
 648
 649         /*
 650          * Reset the is_elf_only flag in case it had been set
 651          * previously, because we might find separate debug info using
 652          * the new build id information.
 653          */
 654         bin->is_elf_only = false;
 655
 656 end:
 657         g_free(build_id);
 658         return;
 659 }
 660
 661 static
 662 void handle_event_statedump_debug_link(struct debug_info *debug_info,
 663                 const bt_event *event)
 664 {
 665         struct proc_debug_info_sources *proc_dbg_info_src;
 666         struct bin_info *bin = NULL;
 667         int64_t vpid;
 668         uint64_t baddr;
 669         const char *filename = NULL;
 670         uint32_t crc32;
 671         uint64_t crc_field_value;
 672
 673         event_get_common_context_signed_integer_field_value(event,
 674                         VPID_FIELD_NAME, &vpid);
 675
 676         event_get_payload_unsigned_integer_field_value(event,
 677                         BADDR_FIELD_NAME, &baddr);
 678
 679         event_get_payload_unsigned_integer_field_value(event,
 680                         CRC32_FIELD_NAME, &crc_field_value);
 681
 682         crc32 = (uint32_t) crc_field_value;
 683
 684         event_get_payload_string_field_value(event,
 685                         FILENAME_FIELD_NAME, &filename);
 686
 687         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 688                         debug_info->vpid_to_proc_dbg_info_src, vpid);
 689         if (!proc_dbg_info_src) {
 690                 goto end;
 691         }
 692
 693         bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info,
 694                         (gpointer) &baddr);
 695         if (!bin) {
 696                 /*
 697                  * The debug_link event comes after the bin has been
 698                  * created. If it isn't found, just ignore this event.
 699                  */
 700                 goto end;
 701         }
 702
 703         bin_info_set_debug_link(bin, filename, crc32);
 704
 705 end:
 706         return;
 707 }
 708
 709 static
 710 void handle_bin_info_event(struct debug_info *debug_info,
 711                 const bt_event *event, bool has_pic_field)
 712 {
 713         struct proc_debug_info_sources *proc_dbg_info_src;
 714         struct bin_info *bin;
 715         uint64_t baddr, memsz;
 716         int64_t vpid;
 717         const char *path;
 718         gpointer key = NULL;
 719         bool is_pic;
 720
 721         event_get_payload_unsigned_integer_field_value(event,
 722                         MEMSZ_FIELD_NAME, &memsz);
 723         if (memsz == 0) {
 724                 /* Ignore VDSO. */
 725                 goto end;
 726         }
 727
 728         event_get_payload_unsigned_integer_field_value(event,
 729                         BADDR_FIELD_NAME, &baddr);
 730
 731         /*
 732          * This field is not produced by the dlopen event emitted before
 733          * lttng-ust 2.9.
 734          */
 735         if (!event_has_payload_field(event, PATH_FIELD_NAME)) {
 736                 goto end;
 737         }
 738         event_get_payload_string_field_value(event, PATH_FIELD_NAME, &path);
 739
 740         if (has_pic_field) {
 741                 uint64_t is_pic_field_value;
 742
 743                 event_get_payload_unsigned_integer_field_value(event,
 744                         IS_PIC_FIELD_NAME, &is_pic_field_value);
 745                 is_pic = is_pic_field_value == 1;
 746         } else {
 747                 /*
 748                  * dlopen has no is_pic field, because the shared
 749                  * object is always PIC.
 750                  */
 751                 is_pic = true;
 752         }
 753
 754         event_get_common_context_signed_integer_field_value(event,
 755                 VPID_FIELD_NAME, &vpid);
 756
 757         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 758                 debug_info->vpid_to_proc_dbg_info_src, vpid);
 759         if (!proc_dbg_info_src) {
 760                 goto end;
 761         }
 762
 763         key = g_new0(uint64_t, 1);
 764         if (!key) {
 765                 goto end;
 766         }
 767
 768         *((uint64_t *) key) = baddr;
 769
 770         bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info, key);
 771         if (bin) {
 772                 goto end;
 773         }
 774
 775         bin = bin_info_create(debug_info->fd_cache, path, baddr, memsz, is_pic,
 776                 debug_info->comp->arg_debug_dir,
 777                 debug_info->comp->arg_target_prefix,
 778                 debug_info->log_level, debug_info->self_comp);
 779         if (!bin) {
 780                 goto end;
 781         }
 782
 783         g_hash_table_insert(proc_dbg_info_src->baddr_to_bin_info, key, bin);
 784         /* Ownership passed to ht. */
 785         key = NULL;
 786
 787 end:
 788         g_free(key);
 789         return;
 790 }
 791
 792 static inline
 793 void handle_event_statedump_bin_info(struct debug_info *debug_info,
 794                 const bt_event *event)
 795 {
 796         handle_bin_info_event(debug_info, event, true);
 797 }
 798
 799 static inline
 800 void handle_event_lib_load(struct debug_info *debug_info,
 801                 const bt_event *event)
 802 {
 803         handle_bin_info_event(debug_info, event, false);
 804 }
 805
 806 static
 807 void handle_event_lib_unload(struct debug_info *debug_info,
 808                 const bt_event *event)
 809 {
 810         gboolean ret;
 811         struct proc_debug_info_sources *proc_dbg_info_src;
 812         uint64_t baddr;
 813         int64_t vpid;
 814
 815         event_get_payload_unsigned_integer_field_value(event, BADDR_FIELD_NAME,
 816                         &baddr);
 817
 818         event_get_common_context_signed_integer_field_value(event,
 819                         VPID_FIELD_NAME, &vpid);
 820
 821         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 822                         debug_info->vpid_to_proc_dbg_info_src, vpid);
 823         if (!proc_dbg_info_src) {
 824                 /*
 825                  * It's an unload event for a library for which no load event
 826                  * was previously received.
 827                  */
 828                 goto end;
 829         }
 830
 831         ret = g_hash_table_remove(proc_dbg_info_src->baddr_to_bin_info,
 832                         (gpointer) &baddr);
 833         BT_ASSERT(ret);
 834 end:
 835         return;
 836 }
 837
 838 static
 839 void handle_event_statedump_start(struct debug_info *debug_info,
 840                 const bt_event *event)
 841 {
 842         struct proc_debug_info_sources *proc_dbg_info_src;
 843         int64_t vpid;
 844
 845         event_get_common_context_signed_integer_field_value(
 846                         event, VPID_FIELD_NAME, &vpid);
 847
 848         proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
 849                         debug_info->vpid_to_proc_dbg_info_src, vpid);
 850         if (!proc_dbg_info_src) {
 851                 goto end;
 852         }
 853
 854         g_hash_table_remove_all(proc_dbg_info_src->baddr_to_bin_info);
 855         g_hash_table_remove_all(proc_dbg_info_src->ip_to_debug_info_src);
 856
 857 end:
 858         return;
 859 }
 860
 861 void trace_debug_info_remove_func(const bt_trace *in_trace, void *data)
 862 {
 863         struct debug_info_msg_iter *debug_it = data;
 864         if (debug_it->debug_info_map) {
 865                 gboolean ret;
 866                 ret = g_hash_table_remove(debug_it->debug_info_map,
 867                                 (gpointer) in_trace);
 868                 BT_ASSERT(ret);
 869         }
 870 }
 871
 872 static
 873 void handle_event_statedump(struct debug_info_msg_iter *debug_it,
 874                 const bt_event *event)
 875 {
 876         const bt_event_class *event_class;
 877         const char *event_name;
 878         GQuark q_event_name;
 879         const bt_trace *trace;
 880         struct debug_info *debug_info;
 881
 882         BT_ASSERT(debug_it);
 883         BT_ASSERT(event);
 884
 885         event_class = bt_event_borrow_class_const(event);
 886
 887         event_name = bt_event_class_get_name(event_class);
 888
 889         trace = bt_stream_borrow_trace_const(
 890                         bt_event_borrow_stream_const(event));
 891
 892         debug_info = g_hash_table_lookup(debug_it->debug_info_map, trace);
 893         if (!debug_info) {
 894                 bt_trace_add_listener_status add_listener_status;
 895
 896                 debug_info = debug_info_create(debug_it->debug_info_component,
 897                                 trace, &debug_it->fd_cache);
 898                 g_hash_table_insert(debug_it->debug_info_map, (gpointer) trace,
 899                                 debug_info);
 900                 add_listener_status = bt_trace_add_destruction_listener(
 901                                 trace, trace_debug_info_remove_func,
 902                                 debug_it,
 903                                 &debug_info->destruction_listener_id);
 904                 BT_ASSERT(add_listener_status == BT_TRACE_ADD_LISTENER_STATUS_OK);
 905         }
 906
 907         q_event_name = g_quark_try_string(event_name);
 908
 909         if (q_event_name == debug_info->q_statedump_bin_info) {
 910                 /* State dump */
 911                 handle_event_statedump_bin_info(debug_info, event);
 912         } else if (q_event_name == debug_info->q_dl_open ||
 913                         q_event_name == debug_info->q_lib_load) {
 914                 /*
 915                  * dl_open and lib_load events are both checked for since
 916                  * only dl_open was produced as of lttng-ust 2.8.
 917                  *
 918                  * lib_load, which is produced from lttng-ust 2.9+, is a lot
 919                  * more reliable since it will be emitted when other functions
 920                  * of the dlopen family are called (e.g. dlmopen) and when
 921                  * library are transitively loaded.
 922                  */
 923                 handle_event_lib_load(debug_info, event);
 924         } else if (q_event_name == debug_info->q_statedump_start) {
 925                 /* Start state dump */
 926                 handle_event_statedump_start(debug_info, event);
 927         } else if (q_event_name == debug_info->q_statedump_debug_link) {
 928                 /* Debug link info */
 929                 handle_event_statedump_debug_link(debug_info, event);
 930         } else if (q_event_name == debug_info->q_statedump_build_id) {
 931                 /* Build ID info */
 932                 handle_event_statedump_build_id(debug_info, event);
 933         } else if (q_event_name == debug_info-> q_lib_unload) {
 934                 handle_event_lib_unload(debug_info, event);
 935         }
 936
 937         return;
 938 }
 939
 940 static
 941 void destroy_debug_info_comp(struct debug_info_component *debug_info)
 942 {
 943         if (!debug_info) {
 944                 return;
 945         }
 946
 947         g_free(debug_info->arg_debug_dir);
 948         g_free(debug_info->arg_debug_info_field_name);
 949         g_free(debug_info->arg_target_prefix);
 950         g_free(debug_info);
 951 }
 952
 953 static
 954 void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src,
 955                 bool full_path, bt_field *curr_field,
 956                 bt_logging_level log_level, bt_self_component *self_comp)
 957 {
 958         bt_field_string_set_value_status set_status;
 959         bt_field_string_append_status append_status;
 960
 961         BT_ASSERT(bt_field_get_class_type(curr_field) ==
 962                         BT_FIELD_CLASS_TYPE_STRING);
 963
 964         if (dbg_info_src) {
 965                 if (full_path) {
 966                         set_status = bt_field_string_set_value(curr_field,
 967                                 dbg_info_src->bin_path);
 968                 } else {
 969                         set_status = bt_field_string_set_value(curr_field,
 970                                 dbg_info_src->short_bin_path);
 971                 }
 972                 if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
 973                         BT_COMP_LOGE("Cannot set path component of \"bin\" "
 974                                 "curr_field field's value: str-fc-addr=%p",
 975                                 curr_field);
 976                         bt_current_thread_clear_error();
 977                 }
 978
 979                 append_status = bt_field_string_append(curr_field,
 980                         dbg_info_src->bin_loc);
 981                 if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) {
 982                         BT_COMP_LOGE("Cannot set bin location component of \"bin\" "
 983                                 "curr_field field's value: str-fc-addr=%p",
 984                                 curr_field);
 985                         bt_current_thread_clear_error();
 986                 }
 987         } else {
 988                 set_status = bt_field_string_set_value(curr_field, "");
 989                 if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
 990                         BT_COMP_LOGE("Cannot set \"bin\" curr_field field's value: "
 991                                 "str-fc-addr=%p", curr_field);
 992                         bt_current_thread_clear_error();
 993                 }
 994         }
 995 }
 996
 997 static
 998 void fill_debug_info_func_field(struct debug_info_source *dbg_info_src,
 999                 bt_field *curr_field, bt_logging_level log_level,
1000                 bt_self_component *self_comp)
1001 {
1002         bt_field_string_set_value_status status;
1003
1004         BT_ASSERT(bt_field_get_class_type(curr_field) ==
1005                         BT_FIELD_CLASS_TYPE_STRING);
1006         if (dbg_info_src && dbg_info_src->func) {
1007                 status = bt_field_string_set_value(curr_field,
1008                         dbg_info_src->func);
1009         } else {
1010                 status = bt_field_string_set_value(curr_field, "");
1011         }
1012         if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1013                 BT_COMP_LOGE("Cannot set \"func\" curr_field field's value: "
1014                         "str-fc-addr=%p", curr_field);
1015                 bt_current_thread_clear_error();
1016         }
1017 }
1018
1019 static
1020 void fill_debug_info_src_field(struct debug_info_source *dbg_info_src,
1021                 bool full_path, bt_field *curr_field,
1022                 bt_logging_level log_level,
1023                 bt_self_component *self_comp)
1024 {
1025         bt_field_string_set_value_status set_status;
1026         bt_field_string_append_status append_status;
1027
1028         BT_ASSERT(bt_field_get_class_type(curr_field) ==
1029                         BT_FIELD_CLASS_TYPE_STRING);
1030
1031         if (dbg_info_src && dbg_info_src->src_path) {
1032                 if (full_path) {
1033                         set_status = bt_field_string_set_value(curr_field,
1034                                         dbg_info_src->src_path);
1035                 } else {
1036                         set_status = bt_field_string_set_value(curr_field,
1037                                         dbg_info_src->short_src_path);
1038                 }
1039                 if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1040                         BT_COMP_LOGE("Cannot set path component of \"src\" "
1041                                 "curr_field field's value: str-fc-addr=%p",
1042                                 curr_field);
1043                         bt_current_thread_clear_error();
1044                 }
1045
1046                 append_status = bt_field_string_append(curr_field, ":");
1047                 if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) {
1048                         BT_COMP_LOGE("Cannot set colon component of \"src\" "
1049                                 "curr_field field's value: str-fc-addr=%p",
1050                                 curr_field);
1051                         bt_current_thread_clear_error();
1052                 }
1053
1054                 append_status = bt_field_string_append(curr_field,
1055                         dbg_info_src->line_no);
1056                 if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) {
1057                         BT_COMP_LOGE("Cannot set line number component of \"src\" "
1058                                 "curr_field field's value: str-fc-addr=%p",
1059                                 curr_field);
1060                         bt_current_thread_clear_error();
1061                 }
1062         } else {
1063                 set_status = bt_field_string_set_value(curr_field, "");
1064                 if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1065                         BT_COMP_LOGE("Cannot set \"src\" curr_field field's value: "
1066                                 "str-fc-addr=%p", curr_field);
1067                         bt_current_thread_clear_error();
1068                 }
1069         }
1070 }
1071
1072 static
1073 void fill_debug_info_field_empty(bt_field *debug_info_field,
1074         bt_logging_level log_level, bt_self_component *self_comp)
1075 {
1076         bt_field_string_set_value_status status;
1077         bt_field *bin_field, *func_field, *src_field;
1078
1079         BT_ASSERT(bt_field_get_class_type(debug_info_field) ==
1080                         BT_FIELD_CLASS_TYPE_STRUCTURE);
1081
1082         bin_field = bt_field_structure_borrow_member_field_by_name(
1083                         debug_info_field, "bin");
1084         func_field = bt_field_structure_borrow_member_field_by_name(
1085                         debug_info_field, "func");
1086         src_field = bt_field_structure_borrow_member_field_by_name(
1087                         debug_info_field, "src");
1088
1089         BT_ASSERT(bt_field_get_class_type(bin_field) ==
1090                         BT_FIELD_CLASS_TYPE_STRING);
1091         BT_ASSERT(bt_field_get_class_type(func_field) ==
1092                         BT_FIELD_CLASS_TYPE_STRING);
1093         BT_ASSERT(bt_field_get_class_type(src_field) ==
1094                         BT_FIELD_CLASS_TYPE_STRING);
1095
1096         status = bt_field_string_set_value(bin_field, "");
1097         if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1098                 BT_COMP_LOGE("Cannot set \"bin\" bin_field field's value: "
1099                         "str-fc-addr=%p", bin_field);
1100                 bt_current_thread_clear_error();
1101         }
1102
1103         status = bt_field_string_set_value(func_field, "");
1104         if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1105                 BT_COMP_LOGE("Cannot set \"func\" func_field field's value: "
1106                         "str-fc-addr=%p", func_field);
1107                 bt_current_thread_clear_error();
1108         }
1109
1110         status = bt_field_string_set_value(src_field, "");
1111         if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
1112                 BT_COMP_LOGE("Cannot set \"src\" src_field field's value: "
1113                         "str-fc-addr=%p", src_field);
1114                 bt_current_thread_clear_error();
1115         }
1116 }
1117 static
1118 void fill_debug_info_field(struct debug_info *debug_info, int64_t vpid,
1119                 uint64_t ip, bt_field *debug_info_field)
1120 {
1121         struct debug_info_source *dbg_info_src;
1122         const bt_field_class *debug_info_fc;
1123
1124         BT_ASSERT(bt_field_get_class_type(debug_info_field) ==
1125                         BT_FIELD_CLASS_TYPE_STRUCTURE);
1126
1127         debug_info_fc = bt_field_borrow_class_const(debug_info_field);
1128
1129         BT_ASSERT(bt_field_class_structure_get_member_count(debug_info_fc) == 3);
1130
1131         dbg_info_src = debug_info_query(debug_info, vpid, ip);
1132
1133         fill_debug_info_bin_field(dbg_info_src,
1134                 debug_info->comp->arg_full_path,
1135                 bt_field_structure_borrow_member_field_by_name(
1136                         debug_info_field, "bin"),
1137                 debug_info->log_level, debug_info->self_comp);
1138         fill_debug_info_func_field(dbg_info_src,
1139                 bt_field_structure_borrow_member_field_by_name(
1140                         debug_info_field, "func"),
1141                 debug_info->log_level, debug_info->self_comp);
1142         fill_debug_info_src_field(dbg_info_src,
1143                 debug_info->comp->arg_full_path,
1144                 bt_field_structure_borrow_member_field_by_name(
1145                         debug_info_field, "src"),
1146                 debug_info->log_level, debug_info->self_comp);
1147 }
1148
1149 static
1150 void fill_debug_info_event_if_needed(struct debug_info_msg_iter *debug_it,
1151                 const bt_event *in_event, bt_event *out_event)
1152 {
1153         bt_field *out_common_ctx_field, *out_debug_info_field;
1154         const bt_field *vpid_field, *ip_field, *in_common_ctx_field;
1155         const bt_field_class *in_common_ctx_fc;
1156         struct debug_info *debug_info;
1157         uint64_t vpid;
1158         int64_t ip;
1159         gchar *debug_info_field_name =
1160                 debug_it->debug_info_component->arg_debug_info_field_name;
1161         bt_logging_level log_level = debug_it->log_level;
1162         bt_self_component *self_comp = debug_it->self_comp;
1163
1164         in_common_ctx_field = bt_event_borrow_common_context_field_const(
1165                         in_event);
1166         if (!in_common_ctx_field) {
1167                 /*
1168                  * There is no event common context so no need to add debug
1169                  * info field.
1170                  */
1171                 goto end;
1172         }
1173
1174         in_common_ctx_fc = bt_field_borrow_class_const(in_common_ctx_field);
1175         if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc,
1176                                 debug_it->ir_maps->debug_info_field_class_name)) {
1177                 /*
1178                  * The input event common context does not have the necessary
1179                  * fields to resolve debug information.
1180                  */
1181                 goto end;
1182         }
1183
1184         /* Borrow the debug-info field. */
1185         out_common_ctx_field = bt_event_borrow_common_context_field(out_event);
1186         if (!out_common_ctx_field) {
1187                 goto end;
1188         }
1189
1190         out_debug_info_field = bt_field_structure_borrow_member_field_by_name(
1191                                 out_common_ctx_field, debug_info_field_name);
1192
1193         vpid_field = bt_field_structure_borrow_member_field_by_name_const(
1194                         out_common_ctx_field, VPID_FIELD_NAME);
1195         ip_field = bt_field_structure_borrow_member_field_by_name_const(
1196                         out_common_ctx_field, IP_FIELD_NAME);
1197
1198         vpid = bt_field_signed_integer_get_value(vpid_field);
1199         ip = bt_field_unsigned_integer_get_value(ip_field);
1200
1201         /*
1202          * Borrow the debug_info structure needed for the source
1203          * resolving.
1204          */
1205         debug_info = g_hash_table_lookup(debug_it->debug_info_map,
1206                         bt_stream_borrow_trace_const(
1207                                 bt_event_borrow_stream_const(in_event)));
1208
1209         if (debug_info) {
1210                 /*
1211                  * Perform the debug-info resolving and set the event fields
1212                  * accordingly.
1213                  */
1214                 fill_debug_info_field(debug_info, vpid, ip, out_debug_info_field);
1215         } else {
1216                 BT_COMP_LOGD("No debug information for this trace. Setting debug "
1217                         "info fields to empty strings.");
1218                 fill_debug_info_field_empty(out_debug_info_field,
1219                         log_level, self_comp);
1220         }
1221 end:
1222         return;
1223 }
1224
1225 static
1226 void update_event_statedump_if_needed(struct debug_info_msg_iter *debug_it,
1227                 const bt_event *in_event)
1228 {
1229         const bt_field *event_common_ctx;
1230         const bt_field_class *event_common_ctx_fc;
1231         const bt_event_class *in_event_class = bt_event_borrow_class_const(in_event);
1232
1233         /*
1234          * If the event is an lttng_ust_statedump event AND has the right event
1235          * common context fields update the debug-info view for this process.
1236          */
1237         event_common_ctx = bt_event_borrow_common_context_field_const(in_event);
1238         if (!event_common_ctx) {
1239                 goto end;
1240         }
1241
1242         event_common_ctx_fc = bt_field_borrow_class_const(event_common_ctx);
1243         if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc,
1244                                 debug_it->ir_maps->debug_info_field_class_name)) {
1245                 /* Checkout if it might be a one of lttng ust statedump events. */
1246                 const char *in_event_name = bt_event_class_get_name(in_event_class);
1247                 if (strncmp(in_event_name, LTTNG_UST_STATEDUMP_PREFIX,
1248                                 strlen(LTTNG_UST_STATEDUMP_PREFIX)) == 0) {
1249                         /* Handle statedump events. */
1250                         handle_event_statedump(debug_it, in_event);
1251                 }
1252         }
1253 end:
1254         return;
1255 }
1256
1257 static
1258 bt_message *handle_event_message(struct debug_info_msg_iter *debug_it,
1259                 const bt_message *in_message)
1260 {
1261         const bt_clock_snapshot *cs;
1262         const bt_clock_class *default_cc;
1263         const bt_packet *in_packet;
1264         bt_event_class *out_event_class;
1265         bt_packet *out_packet;
1266         bt_event *out_event;
1267         bt_logging_level log_level = debug_it->log_level;
1268         bt_self_component *self_comp = debug_it->self_comp;
1269
1270         bt_message *out_message = NULL;
1271
1272         /* Borrow the input event and its event class. */
1273         const bt_event *in_event =
1274                 bt_message_event_borrow_event_const(in_message);
1275         const bt_event_class *in_event_class =
1276                 bt_event_borrow_class_const(in_event);
1277
1278         update_event_statedump_if_needed(debug_it, in_event);
1279
1280         out_event_class = trace_ir_mapping_borrow_mapped_event_class(
1281                         debug_it->ir_maps, in_event_class);
1282         if (!out_event_class) {
1283                 out_event_class = trace_ir_mapping_create_new_mapped_event_class(
1284                                         debug_it->ir_maps, in_event_class);
1285         }
1286         BT_ASSERT(out_event_class);
1287
1288         /* Borrow the input and output packets. */
1289         in_packet = bt_event_borrow_packet_const(in_event);
1290         out_packet = trace_ir_mapping_borrow_mapped_packet(debug_it->ir_maps,
1291                         in_packet);
1292
1293         default_cc = bt_stream_class_borrow_default_clock_class_const(
1294                         bt_event_class_borrow_stream_class_const(in_event_class));
1295         if (default_cc) {
1296                 /* Borrow event clock snapshot. */
1297                 cs = bt_message_event_borrow_default_clock_snapshot_const(
1298                                 in_message);
1299
1300                 /* Create an output event message. */
1301                 out_message = bt_message_event_create_with_default_clock_snapshot(
1302                                         debug_it->input_iterator,
1303                                         out_event_class, out_packet,
1304                                         bt_clock_snapshot_get_value(cs));
1305         } else {
1306                 out_message = bt_message_event_create(debug_it->input_iterator,
1307                                 out_event_class, out_packet);
1308         }
1309
1310         if (!out_message) {
1311                 BT_COMP_LOGE("Error creating output event message.");
1312                 goto error;
1313         }
1314
1315         out_event = bt_message_event_borrow_event(out_message);
1316
1317         /* Copy the original fields to the output event. */
1318         copy_event_content(in_event, out_event, log_level, self_comp);
1319
1320         /*
1321          * Try to set the debug-info fields based on debug information that is
1322          * gathered so far.
1323          */
1324         fill_debug_info_event_if_needed(debug_it, in_event, out_event);
1325
1326 error:
1327         return out_message;
1328 }
1329
1330 static
1331 bt_message *handle_stream_begin_message(struct debug_info_msg_iter *debug_it,
1332                 const bt_message *in_message)
1333 {
1334         const bt_stream *in_stream;
1335         bt_message *out_message;
1336         bt_stream *out_stream;
1337         bt_logging_level log_level = debug_it->log_level;
1338         bt_self_component *self_comp = debug_it->self_comp;
1339
1340         in_stream = bt_message_stream_beginning_borrow_stream_const(in_message);
1341         BT_ASSERT(in_stream);
1342
1343         /* Create a duplicated output stream. */
1344         out_stream = trace_ir_mapping_create_new_mapped_stream(
1345                         debug_it->ir_maps, in_stream);
1346         if (!out_stream) {
1347                 out_message = NULL;
1348                 goto error;
1349         }
1350
1351         /* Create an output stream beginning message. */
1352         out_message = bt_message_stream_beginning_create(
1353                         debug_it->input_iterator, out_stream);
1354         if (!out_message) {
1355                 BT_COMP_LOGE("Error creating output stream beginning message: "
1356                         "out-s-addr=%p", out_stream);
1357         }
1358 error:
1359         return out_message;
1360 }
1361
1362 static
1363 bt_message *handle_stream_end_message(struct debug_info_msg_iter *debug_it,
1364                 const bt_message *in_message)
1365 {
1366         const bt_stream *in_stream;
1367         bt_message *out_message = NULL;
1368         bt_stream *out_stream;
1369         bt_logging_level log_level = debug_it->log_level;
1370         bt_self_component *self_comp = debug_it->self_comp;
1371
1372         in_stream = bt_message_stream_end_borrow_stream_const(in_message);
1373         BT_ASSERT(in_stream);
1374
1375         out_stream = trace_ir_mapping_borrow_mapped_stream(
1376                         debug_it->ir_maps, in_stream);
1377         BT_ASSERT(out_stream);
1378
1379         /* Create an output stream end message. */
1380         out_message = bt_message_stream_end_create(debug_it->input_iterator,
1381                         out_stream);
1382         if (!out_message) {
1383                 BT_COMP_LOGE("Error creating output stream end message: out-s-addr=%p",
1384                                 out_stream);
1385                 goto end;
1386         }
1387
1388         /* Remove stream from trace mapping hashtable. */
1389         trace_ir_mapping_remove_mapped_stream(debug_it->ir_maps, in_stream);
1390
1391 end:
1392         return out_message;
1393 }
1394
1395 static
1396 bt_message *handle_packet_begin_message(struct debug_info_msg_iter *debug_it,
1397                 const bt_message *in_message)
1398 {
1399         bool has_default_clock_snapshot;
1400         const bt_clock_snapshot *cs;
1401         bt_message *out_message = NULL;
1402         bt_packet *out_packet;
1403         bt_logging_level log_level = debug_it->log_level;
1404         bt_self_component *self_comp = debug_it->self_comp;
1405
1406         const bt_packet *in_packet =
1407                 bt_message_packet_beginning_borrow_packet_const(in_message);
1408         BT_ASSERT(in_packet);
1409
1410         /* This packet should not be already mapped. */
1411         BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet(
1412                                 debug_it->ir_maps, in_packet));
1413
1414         out_packet = trace_ir_mapping_create_new_mapped_packet(debug_it->ir_maps,
1415                         in_packet);
1416
1417         BT_ASSERT(out_packet);
1418
1419         has_default_clock_snapshot =
1420                 bt_stream_class_packets_have_beginning_default_clock_snapshot(
1421                         bt_stream_borrow_class_const(
1422                                 bt_packet_borrow_stream_const(in_packet)));
1423         if (has_default_clock_snapshot) {
1424                 /* Borrow clock snapshot. */
1425                 cs = bt_message_packet_beginning_borrow_default_clock_snapshot_const(
1426                                         in_message);
1427
1428                 /* Create an output packet beginning message. */
1429                 out_message = bt_message_packet_beginning_create_with_default_clock_snapshot(
1430                                 debug_it->input_iterator, out_packet,
1431                                 bt_clock_snapshot_get_value(cs));
1432         } else {
1433                 out_message = bt_message_packet_beginning_create(
1434                                 debug_it->input_iterator, out_packet);
1435         }
1436         if (!out_message) {
1437                 BT_COMP_LOGE("Error creating output packet beginning message: "
1438                         "out-p-addr=%p", out_packet);
1439         }
1440
1441         return out_message;
1442 }
1443
1444 static
1445 bt_message *handle_packet_end_message(struct debug_info_msg_iter *debug_it,
1446                 const bt_message *in_message)
1447 {
1448         bool has_default_clock_snapshot;
1449         const bt_clock_snapshot *cs;
1450         const bt_packet *in_packet;
1451         bt_message *out_message = NULL;
1452         bt_packet *out_packet;
1453         bt_logging_level log_level = debug_it->log_level;
1454         bt_self_component *self_comp = debug_it->self_comp;
1455
1456         in_packet = bt_message_packet_end_borrow_packet_const(in_message);
1457         BT_ASSERT(in_packet);
1458
1459         out_packet = trace_ir_mapping_borrow_mapped_packet(debug_it->ir_maps, in_packet);
1460         BT_ASSERT(out_packet);
1461
1462         has_default_clock_snapshot =
1463                 bt_stream_class_packets_have_end_default_clock_snapshot(
1464                         bt_stream_borrow_class_const(
1465                                 bt_packet_borrow_stream_const(in_packet)));
1466         if (has_default_clock_snapshot) {
1467                 /* Borrow clock snapshot. */
1468                 cs = bt_message_packet_end_borrow_default_clock_snapshot_const(
1469                                         in_message);
1470
1471                 /* Create an outpute packet end message. */
1472                 out_message = bt_message_packet_end_create_with_default_clock_snapshot(
1473                                 debug_it->input_iterator, out_packet,
1474                                 bt_clock_snapshot_get_value(cs));
1475         } else {
1476                 out_message = bt_message_packet_end_create(
1477                                 debug_it->input_iterator, out_packet);
1478         }
1479
1480         if (!out_message) {
1481                 BT_COMP_LOGE("Error creating output packet end message: "
1482                         "out-p-addr=%p", out_packet);
1483                 goto end;
1484         }
1485
1486         /* Remove packet from data mapping hashtable. */
1487         trace_ir_mapping_remove_mapped_packet(debug_it->ir_maps, in_packet);
1488
1489 end:
1490         return out_message;
1491 }
1492
1493 static
1494 bt_message *handle_msg_iterator_inactivity(struct debug_info_msg_iter *debug_it,
1495                 const bt_message *in_message)
1496 {
1497         /*
1498          * This message type can be forwarded directly because it does
1499          * not refer to any objects in the trace class.
1500          */
1501         bt_message_get_ref(in_message);
1502         return (bt_message*) in_message;
1503 }
1504
1505 static
1506 bt_message *handle_discarded_events_message(struct debug_info_msg_iter *debug_it,
1507                 const bt_message *in_message)
1508 {
1509         const bt_clock_snapshot *begin_cs, *end_cs;
1510         const bt_stream *in_stream;
1511         bool has_default_clock_snapshots;
1512         uint64_t discarded_events, begin_cs_value, end_cs_value;
1513         bt_property_availability prop_avail;
1514         bt_message *out_message = NULL;
1515         bt_stream *out_stream;
1516         bt_logging_level log_level = debug_it->log_level;
1517         bt_self_component *self_comp = debug_it->self_comp;
1518
1519         in_stream = bt_message_discarded_events_borrow_stream_const(
1520                         in_message);
1521         BT_ASSERT(in_stream);
1522
1523         out_stream = trace_ir_mapping_borrow_mapped_stream(
1524                                 debug_it->ir_maps, in_stream);
1525         BT_ASSERT(out_stream);
1526
1527         has_default_clock_snapshots =
1528                 bt_stream_class_discarded_events_have_default_clock_snapshots(
1529                         bt_stream_borrow_class_const(in_stream));
1530         if (has_default_clock_snapshots) {
1531                 begin_cs =
1532                         bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1533                                 in_message);
1534                 end_cs =
1535                         bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1536                                 in_message);
1537
1538                 begin_cs_value = bt_clock_snapshot_get_value(begin_cs);
1539                 end_cs_value = bt_clock_snapshot_get_value(end_cs);
1540
1541                 out_message =
1542                         bt_message_discarded_events_create_with_default_clock_snapshots(
1543                                         debug_it->input_iterator, out_stream,
1544                                         begin_cs_value, end_cs_value);
1545         } else {
1546                 out_message = bt_message_discarded_events_create(
1547                                 debug_it->input_iterator, out_stream);
1548         }
1549         if (!out_message) {
1550                 BT_COMP_LOGE("Error creating output discarded events message: "
1551                         "out-s-addr=%p", out_stream);
1552                 goto error;
1553         }
1554
1555         prop_avail = bt_message_discarded_events_get_count(in_message,
1556                         &discarded_events);
1557
1558         if (prop_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
1559                 bt_message_discarded_events_set_count(out_message,
1560                                 discarded_events);
1561         }
1562
1563 error:
1564         return out_message;
1565 }
1566
1567 static
1568 bt_message *handle_discarded_packets_message(struct debug_info_msg_iter *debug_it,
1569                 const bt_message *in_message)
1570 {
1571         const bt_clock_snapshot *begin_cs, *end_cs;
1572         bool has_default_clock_snapshots;
1573         const bt_stream *in_stream;
1574         uint64_t discarded_packets, begin_cs_value, end_cs_value;
1575         bt_property_availability prop_avail;
1576         bt_message *out_message = NULL;
1577         bt_stream *out_stream;
1578         bt_logging_level log_level = debug_it->log_level;
1579         bt_self_component *self_comp = debug_it->self_comp;
1580
1581         in_stream = bt_message_discarded_packets_borrow_stream_const(
1582                         in_message);
1583         BT_ASSERT(in_stream);
1584
1585         out_stream = trace_ir_mapping_borrow_mapped_stream(
1586                         debug_it->ir_maps, in_stream);
1587         BT_ASSERT(out_stream);
1588
1589         has_default_clock_snapshots =
1590                 bt_stream_class_discarded_packets_have_default_clock_snapshots(
1591                         bt_stream_borrow_class_const(in_stream));
1592         if (has_default_clock_snapshots) {
1593                 begin_cs =
1594                         bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1595                                 in_message);
1596
1597                 end_cs =
1598                         bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1599                                 in_message);
1600
1601                 begin_cs_value = bt_clock_snapshot_get_value(begin_cs);
1602                 end_cs_value = bt_clock_snapshot_get_value(end_cs);
1603
1604                 out_message = bt_message_discarded_packets_create_with_default_clock_snapshots(
1605                                         debug_it->input_iterator, out_stream,
1606                                         begin_cs_value, end_cs_value);
1607         } else {
1608                 out_message = bt_message_discarded_packets_create(
1609                                 debug_it->input_iterator, out_stream);
1610         }
1611         if (!out_message) {
1612                 BT_COMP_LOGE("Error creating output discarded packet message: "
1613                         "out-s-addr=%p", out_stream);
1614                 goto error;
1615         }
1616
1617         prop_avail = bt_message_discarded_packets_get_count(in_message,
1618                         &discarded_packets);
1619         if (prop_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
1620                 bt_message_discarded_packets_set_count(out_message,
1621                                 discarded_packets);
1622         }
1623
1624 error:
1625         return out_message;
1626 }
1627
1628 static
1629 const bt_message *handle_message(struct debug_info_msg_iter *debug_it,
1630                 const bt_message *in_message)
1631 {
1632         bt_message *out_message = NULL;
1633
1634         switch (bt_message_get_type(in_message)) {
1635         case BT_MESSAGE_TYPE_EVENT:
1636                 out_message = handle_event_message(debug_it,
1637                                 in_message);
1638                 break;
1639         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1640                 out_message = handle_packet_begin_message(debug_it,
1641                                 in_message);
1642                 break;
1643         case BT_MESSAGE_TYPE_PACKET_END:
1644                 out_message = handle_packet_end_message(debug_it,
1645                                 in_message);
1646                 break;
1647         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1648                 out_message = handle_stream_begin_message(debug_it,
1649                                 in_message);
1650                 break;
1651         case BT_MESSAGE_TYPE_STREAM_END:
1652                 out_message = handle_stream_end_message(debug_it,
1653                                 in_message);
1654                 break;
1655         case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
1656                 out_message = handle_msg_iterator_inactivity(debug_it,
1657                                 in_message);
1658                 break;
1659         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1660                 out_message = handle_discarded_events_message(debug_it,
1661                                 in_message);
1662                 break;
1663         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1664                 out_message = handle_discarded_packets_message(debug_it,
1665                                 in_message);
1666                 break;
1667         default:
1668                 abort();
1669                 break;
1670         }
1671
1672         return out_message;
1673 }
1674
1675 static
1676 int init_from_params(struct debug_info_component *debug_info_component,
1677                 const bt_value *params)
1678 {
1679         const bt_value *value = NULL;
1680         int ret = 0;
1681
1682         BT_ASSERT(params);
1683
1684         value = bt_value_map_borrow_entry_value_const(params,
1685                         "debug-info-field-name");
1686         if (value) {
1687                 debug_info_component->arg_debug_info_field_name =
1688                         g_strdup(bt_value_string_get(value));
1689         } else {
1690                 debug_info_component->arg_debug_info_field_name =
1691                         g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME);
1692         }
1693
1694         value = bt_value_map_borrow_entry_value_const(params, "debug-info-dir");
1695         if (value) {
1696                 debug_info_component->arg_debug_dir =
1697                         g_strdup(bt_value_string_get(value));
1698         } else {
1699                 debug_info_component->arg_debug_dir = NULL;
1700         }
1701
1702
1703         value = bt_value_map_borrow_entry_value_const(params, "target-prefix");
1704         if (value) {
1705                 debug_info_component->arg_target_prefix =
1706                         g_strdup(bt_value_string_get(value));
1707         } else {
1708                 debug_info_component->arg_target_prefix = NULL;
1709         }
1710
1711         value = bt_value_map_borrow_entry_value_const(params, "full-path");
1712         if (value) {
1713                 debug_info_component->arg_full_path = bt_value_bool_get(value);
1714         } else {
1715                 debug_info_component->arg_full_path = BT_FALSE;
1716         }
1717
1718         return ret;
1719 }
1720
1721 BT_HIDDEN
1722 bt_component_class_init_method_status debug_info_comp_init(
1723                 bt_self_component_filter *self_comp_flt,
1724                 const bt_value *params, __attribute__((unused)) void *init_method_data)
1725 {
1726         int ret;
1727         struct debug_info_component *debug_info_comp;
1728         bt_component_class_init_method_status status =
1729                 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
1730         bt_self_component_add_port_status add_port_status;
1731         bt_self_component *self_comp =
1732                 bt_self_component_filter_as_self_component(self_comp_flt);
1733         bt_logging_level log_level = bt_component_get_logging_level(
1734                 bt_self_component_as_component(self_comp));
1735
1736
1737         BT_COMP_LOGI("Initializing debug_info component: "
1738                 "comp-addr=%p, params-addr=%p", self_comp, params);
1739
1740         debug_info_comp = g_new0(struct debug_info_component, 1);
1741         if (!debug_info_comp) {
1742                 BT_COMP_LOGE_STR("Failed to allocate one debug_info component.");
1743                 goto error;
1744         }
1745
1746         debug_info_comp->log_level = log_level;
1747         debug_info_comp->self_comp = self_comp;
1748         bt_self_component_set_data(self_comp, debug_info_comp);
1749
1750         add_port_status = bt_self_component_filter_add_input_port(
1751                 self_comp_flt, "in", NULL, NULL);
1752         switch (add_port_status) {
1753         case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
1754                 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
1755                 goto error;
1756         case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
1757                 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
1758                 goto error;
1759         default:
1760                 break;
1761         }
1762
1763         add_port_status = bt_self_component_filter_add_output_port(
1764                         self_comp_flt, "out", NULL, NULL);
1765         switch (add_port_status) {
1766         case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
1767                 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
1768                 goto error;
1769         case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
1770                 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
1771                 goto error;
1772         default:
1773                 break;
1774         }
1775
1776         ret = init_from_params(debug_info_comp, params);
1777         if (ret) {
1778                 BT_COMP_LOGE("Cannot configure debug_info component: "
1779                         "debug_info-comp-addr=%p, params-addr=%p",
1780                         debug_info_comp, params);
1781                 goto error;
1782         }
1783
1784         goto end;
1785
1786 error:
1787         destroy_debug_info_comp(debug_info_comp);
1788         bt_self_component_set_data(self_comp, NULL);
1789
1790         if (status == BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) {
1791                 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
1792         }
1793 end:
1794         return status;
1795 }
1796
1797 BT_HIDDEN
1798 void debug_info_comp_finalize(bt_self_component_filter *self_comp_flt)
1799 {
1800         struct debug_info_component *debug_info =
1801                 bt_self_component_get_data(
1802                                 bt_self_component_filter_as_self_component(
1803                                         self_comp_flt));
1804         bt_logging_level log_level = debug_info->log_level;
1805         bt_self_component *self_comp = debug_info->self_comp;
1806
1807         BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p",
1808                 self_comp);
1809
1810         destroy_debug_info_comp(debug_info);
1811 }
1812
1813 BT_HIDDEN
1814 bt_component_class_message_iterator_next_method_status debug_info_msg_iter_next(
1815                 bt_self_message_iterator *self_msg_iter,
1816                 const bt_message_array_const msgs, uint64_t capacity,
1817                 uint64_t *count)
1818 {
1819         bt_self_component_port_input_message_iterator *upstream_iterator = NULL;
1820         bt_message_iterator_next_status upstream_iterator_ret_status;
1821         struct debug_info_msg_iter *debug_info_msg_iter;
1822         struct debug_info_component *debug_info = NULL;
1823         bt_component_class_message_iterator_next_method_status status;
1824         bt_self_component *self_comp = NULL;
1825         bt_message_array_const input_msgs;
1826         const bt_message *out_message;
1827         uint64_t curr_msg_idx, i;
1828
1829         status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
1830
1831         self_comp = bt_self_message_iterator_borrow_component(self_msg_iter);
1832         BT_ASSERT(self_comp);
1833
1834         debug_info = bt_self_component_get_data(self_comp);
1835         BT_ASSERT(debug_info);
1836
1837         debug_info_msg_iter = bt_self_message_iterator_get_data(self_msg_iter);
1838         BT_ASSERT(debug_info_msg_iter);
1839
1840         upstream_iterator = debug_info_msg_iter->msg_iter;
1841         BT_ASSERT(upstream_iterator);
1842
1843         upstream_iterator_ret_status =
1844                 bt_self_component_port_input_message_iterator_next(
1845                                 upstream_iterator, &input_msgs, count);
1846         if (upstream_iterator_ret_status !=
1847                         BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) {
1848                 /*
1849                  * No messages were returned. Not necessarily an error.
1850                  * Convert the upstream message iterator status to a
1851                  * self status.
1852                  */
1853                 status = (int) upstream_iterator_ret_status;
1854                 goto end;
1855         }
1856
1857         /*
1858          * There should never be more received messages than the capacity we
1859          * provided.
1860          */
1861         BT_ASSERT(*count <= capacity);
1862
1863         for (curr_msg_idx = 0; curr_msg_idx < *count; curr_msg_idx++) {
1864                 out_message = handle_message(debug_info_msg_iter,
1865                         input_msgs[curr_msg_idx]);
1866                 if (!out_message) {
1867                         goto handle_msg_error;
1868                 }
1869
1870                 msgs[curr_msg_idx] = out_message;
1871                 /*
1872                  * Drop our reference of the input message as we are done with
1873                  * it and created a output copy.
1874                  */
1875                 bt_message_put_ref(input_msgs[curr_msg_idx]);
1876         }
1877
1878         goto end;
1879
1880 handle_msg_error:
1881         /*
1882          * Drop references of all the output messages created before the
1883          * failure.
1884          */
1885         for (i = 0; i < curr_msg_idx; i++) {
1886                 bt_message_put_ref(msgs[i]);
1887         }
1888
1889         status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR;
1890
1891 end:
1892         return status;
1893 }
1894
1895 static
1896 void debug_info_msg_iter_destroy(struct debug_info_msg_iter *debug_info_msg_iter)
1897 {
1898         if (!debug_info_msg_iter) {
1899                 goto end;
1900         }
1901
1902         if (debug_info_msg_iter->msg_iter) {
1903                 bt_self_component_port_input_message_iterator_put_ref(
1904                                 debug_info_msg_iter->msg_iter);
1905         }
1906
1907         if (debug_info_msg_iter->ir_maps) {
1908                 trace_ir_maps_destroy(debug_info_msg_iter->ir_maps);
1909         }
1910
1911         if (debug_info_msg_iter->debug_info_map) {
1912                 g_hash_table_destroy(debug_info_msg_iter->debug_info_map);
1913         }
1914
1915         bt_fd_cache_fini(&debug_info_msg_iter->fd_cache);
1916         g_free(debug_info_msg_iter);
1917
1918 end:
1919         return;
1920 }
1921
1922 BT_HIDDEN
1923 bt_component_class_message_iterator_init_method_status debug_info_msg_iter_init(
1924                 bt_self_message_iterator *self_msg_iter,
1925                 bt_self_component_filter *self_comp_flt,
1926                 bt_self_component_port_output *self_port)
1927 {
1928         bt_component_class_message_iterator_init_method_status status =
1929                 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
1930         struct bt_self_component_port_input *input_port = NULL;
1931         bt_self_component_port_input_message_iterator *upstream_iterator = NULL;
1932         struct debug_info_msg_iter *debug_info_msg_iter = NULL;
1933         gchar *debug_info_field_name;
1934         int ret;
1935         bt_self_component *self_comp =
1936                 bt_self_component_filter_as_self_component(self_comp_flt);
1937         bt_logging_level log_level = bt_component_get_logging_level(
1938                 bt_self_component_as_component(self_comp));
1939
1940         /* Borrow the upstream input port. */
1941         input_port = bt_self_component_filter_borrow_input_port_by_name(
1942                 self_comp_flt, "in");
1943         if (!input_port) {
1944                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
1945                 goto error;
1946         }
1947
1948         debug_info_msg_iter = g_new0(struct debug_info_msg_iter, 1);
1949         if (!debug_info_msg_iter) {
1950                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
1951                 goto error;
1952         }
1953
1954         debug_info_msg_iter->log_level = log_level;
1955         debug_info_msg_iter->self_comp = self_comp;
1956
1957         /* Create an iterator on the upstream component. */
1958         upstream_iterator = bt_self_component_port_input_message_iterator_create(
1959                 input_port);
1960         if (!upstream_iterator) {
1961                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
1962                 goto error;
1963         }
1964
1965         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
1966                 debug_info_msg_iter->msg_iter, upstream_iterator);
1967
1968         /* Create hashtable that will contain debug info mapping. */
1969         debug_info_msg_iter->debug_info_map = g_hash_table_new_full(
1970                 g_direct_hash, g_direct_equal, (GDestroyNotify) NULL,
1971                 (GDestroyNotify) debug_info_destroy);
1972         if (!debug_info_msg_iter->debug_info_map) {
1973                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
1974                 goto error;
1975         }
1976
1977         debug_info_msg_iter->debug_info_component =
1978                 bt_self_component_get_data(self_comp);
1979
1980         debug_info_field_name =
1981                 debug_info_msg_iter->debug_info_component->arg_debug_info_field_name;
1982
1983         debug_info_msg_iter->ir_maps = trace_ir_maps_create(self_comp,
1984                 debug_info_field_name, log_level);
1985         if (!debug_info_msg_iter->ir_maps) {
1986                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
1987                 goto error;
1988         }
1989
1990         ret = bt_fd_cache_init(&debug_info_msg_iter->fd_cache, log_level);
1991         if (ret) {
1992                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
1993                 goto error;
1994         }
1995
1996         bt_self_message_iterator_set_data(self_msg_iter, debug_info_msg_iter);
1997         debug_info_msg_iter->input_iterator = self_msg_iter;
1998
1999         goto end;
2000
2001 error:
2002         debug_info_msg_iter_destroy(debug_info_msg_iter);
2003
2004 end:
2005         return status;
2006 }
2007
2008 BT_HIDDEN
2009 bt_bool debug_info_msg_iter_can_seek_beginning(
2010                 bt_self_message_iterator *self_msg_iter)
2011 {
2012         struct debug_info_msg_iter *debug_info_msg_iter =
2013                 bt_self_message_iterator_get_data(self_msg_iter);
2014         BT_ASSERT(debug_info_msg_iter);
2015
2016         return bt_self_component_port_input_message_iterator_can_seek_beginning(
2017                         debug_info_msg_iter->msg_iter);
2018 }
2019
2020 BT_HIDDEN
2021 bt_component_class_message_iterator_seek_beginning_method_status debug_info_msg_iter_seek_beginning(
2022                 bt_self_message_iterator *self_msg_iter)
2023 {
2024         struct debug_info_msg_iter *debug_info_msg_iter =
2025                 bt_self_message_iterator_get_data(self_msg_iter);
2026         bt_component_class_message_iterator_seek_beginning_method_status status =
2027                 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK;
2028         bt_message_iterator_seek_beginning_status seek_beg_status;
2029
2030         BT_ASSERT(debug_info_msg_iter);
2031
2032         /* Ask the upstream component to seek to the beginning. */
2033         seek_beg_status = bt_self_component_port_input_message_iterator_seek_beginning(
2034                 debug_info_msg_iter->msg_iter);
2035         if (seek_beg_status != BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK) {
2036                 status = (int) seek_beg_status;
2037                 goto end;
2038         }
2039
2040         /* Clear this iterator data. */
2041         trace_ir_maps_clear(debug_info_msg_iter->ir_maps);
2042         g_hash_table_remove_all(debug_info_msg_iter->debug_info_map);
2043
2044 end:
2045         return status;
2046 }
2047
2048 BT_HIDDEN
2049 void debug_info_msg_iter_finalize(bt_self_message_iterator *it)
2050 {
2051         struct debug_info_msg_iter *debug_info_msg_iter;
2052
2053         debug_info_msg_iter = bt_self_message_iterator_get_data(it);
2054         BT_ASSERT(debug_info_msg_iter);
2055
2056         debug_info_msg_iter_destroy(debug_info_msg_iter);
2057 }