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