plugins/lttng-utils/debug-info.h

   1 #ifndef BABELTRACE_PLUGIN_DEBUG_INFO_H
   2 #define BABELTRACE_PLUGIN_DEBUG_INFO_H
   3
   4 /*
   5  * Babeltrace - Debug information Plug-in
   6  *
   7  * Copyright (c) 2015 EfficiOS Inc.
   8  * Copyright (c) 2015 Antoine Busque <abusque@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 #include <stdbool.h>
  30 #include <stdint.h>
  31 #include <stddef.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/ctf-ir/event.h>
  34 #include <babeltrace/ctf-ir/trace.h>
  35 #include <babeltrace/ctf-ir/fields.h>
  36 #include <babeltrace/ctf-ir/event-class.h>
  37
  38 struct debug_info_component {
  39         FILE *err;
  40         char *arg_debug_info_field_name;
  41         const char *arg_debug_dir;
  42         bool arg_full_path;
  43         const char *arg_target_prefix;
  44 };
  45
  46 struct debug_info_iterator {
  47         struct debug_info_component *debug_info_component;
  48         /* Map between struct bt_ctf_trace and struct bt_ctf_writer. */
  49         GHashTable *trace_map;
  50         /* Map between reader and writer stream. */
  51         GHashTable *stream_map;
  52         /* Map between reader and writer stream class. */
  53         GHashTable *stream_class_map;
  54         /* Map between reader and writer stream class. */
  55         GHashTable *packet_map;
  56         /* Map between a trace_class and its corresponding debug_info. */
  57         GHashTable *trace_debug_map;
  58         /* Input iterators associated with this output iterator. */
  59         GPtrArray *input_iterator_group;
  60         struct bt_notification *current_notification;
  61         struct bt_notification_iterator *input_iterator;
  62         FILE *err;
  63 };
  64
  65 struct debug_info_source {
  66         /* Strings are owned by debug_info_source. */
  67         char *func;
  68         uint64_t line_no;
  69         char *src_path;
  70         /* short_src_path points inside src_path, no need to free. */
  71         const char *short_src_path;
  72         char *bin_path;
  73         /* short_bin_path points inside bin_path, no need to free. */
  74         const char *short_bin_path;
  75         /*
  76          * Location within the binary. Either absolute (@0x1234) or
  77          * relative (+0x4321).
  78          */
  79         char *bin_loc;
  80 };
  81
  82 BT_HIDDEN
  83 struct debug_info *debug_info_create(struct debug_info_component *comp);
  84
  85 BT_HIDDEN
  86 void debug_info_destroy(struct debug_info *debug_info);
  87
  88 BT_HIDDEN
  89 struct debug_info_source *debug_info_query(struct debug_info *debug_info,
  90                 int64_t vpid, uint64_t ip);
  91
  92 BT_HIDDEN
  93 void debug_info_handle_event(FILE *err, struct bt_ctf_event *event,
  94                 struct debug_info *debug_info);
  95
  96 #endif /* BABELTRACE_PLUGIN_DEBUG_INFO_H */