Commit | Line | Data |
---|---|---|
d5ddf820 AB |
1 | #ifndef _BABELTRACE_BIN_INFO_H |
2 | #define _BABELTRACE_BIN_INFO_H | |
c40a57e5 AB |
3 | |
4 | /* | |
5 | * Babeltrace - Executable and Shared Object Debug Info Reader | |
6 | * | |
7 | * Copyright 2015 Antoine Busque <abusque@efficios.com> | |
8 | * | |
9 | * Author: Antoine Busque <abusque@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
91bc8451 | 30 | #include <babeltrace2/babeltrace.h> |
c40a57e5 AB |
31 | #include <stdint.h> |
32 | #include <stdbool.h> | |
33 | #include <gelf.h> | |
34 | #include <elfutils/libdw.h> | |
91d81473 | 35 | #include "common/macros.h" |
578e048b | 36 | #include "fd-cache/fd-cache.h" |
c40a57e5 AB |
37 | |
38 | #define DEFAULT_DEBUG_DIR "/usr/lib/debug" | |
73485cf9 MJ |
39 | #define DEBUG_SUBDIR ".debug" |
40 | #define BUILD_ID_SUBDIR ".build-id" | |
c40a57e5 | 41 | #define BUILD_ID_SUFFIX ".debug" |
73485cf9 | 42 | #define BUILD_ID_PREFIX_DIR_LEN 2 |
c40a57e5 | 43 | |
d5ddf820 | 44 | struct bin_info { |
3a3d15f3 PP |
45 | bt_logging_level log_level; |
46 | ||
91bc8451 PP |
47 | /* Used for logging; can be `NULL` */ |
48 | bt_self_component *self_comp; | |
49 | ||
c40a57e5 AB |
50 | /* Base virtual memory address. */ |
51 | uint64_t low_addr; | |
52 | /* Upper bound of exec address space. */ | |
53 | uint64_t high_addr; | |
54 | /* Size of exec address space. */ | |
55 | uint64_t memsz; | |
56 | /* Paths to ELF and DWARF files. */ | |
06d1cf5d FD |
57 | gchar *elf_path; |
58 | gchar *dwarf_path; | |
c40a57e5 AB |
59 | /* libelf and libdw objects representing the files. */ |
60 | Elf *elf_file; | |
61 | Dwarf *dwarf_info; | |
62 | /* Optional build ID info. */ | |
63 | uint8_t *build_id; | |
64 | size_t build_id_len; | |
ca9f27f3 | 65 | |
c40a57e5 | 66 | /* Optional debug link info. */ |
06d1cf5d | 67 | gchar *dbg_link_filename; |
c40a57e5 | 68 | uint32_t dbg_link_crc; |
1e638f98 FD |
69 | /* fd cache handles to ELF and DWARF files. */ |
70 | struct bt_fd_cache_handle *elf_handle; | |
71 | struct bt_fd_cache_handle *dwarf_handle; | |
9d325e17 | 72 | /* Configuration. */ |
06d1cf5d | 73 | gchar *debug_info_dir; |
c40a57e5 AB |
74 | /* Denotes whether the executable is position independent code. */ |
75 | bool is_pic:1; | |
af54bd18 | 76 | /* Denotes whether the build id in the trace matches to one on disk. */ |
ca9f27f3 | 77 | bool file_build_id_matches:1; |
d5ddf820 AB |
78 | /* |
79 | * Denotes whether the executable only has ELF symbols and no | |
80 | * DWARF info. | |
81 | */ | |
c40a57e5 | 82 | bool is_elf_only:1; |
1e638f98 FD |
83 | /* Weak ref. Owned by the iterator. */ |
84 | struct bt_fd_cache *fd_cache; | |
c40a57e5 AB |
85 | }; |
86 | ||
87 | struct source_location { | |
88 | uint64_t line_no; | |
06d1cf5d | 89 | gchar *filename; |
c40a57e5 AB |
90 | }; |
91 | ||
92 | /** | |
d5ddf820 | 93 | * Initializes the bin_info framework. Call this before calling |
c40a57e5 AB |
94 | * anything else. |
95 | * | |
96 | * @returns 0 on success, -1 on failure | |
97 | */ | |
98 | BT_HIDDEN | |
91bc8451 PP |
99 | int bin_info_init(bt_logging_level log_level, |
100 | bt_self_component *self_comp); | |
c40a57e5 AB |
101 | |
102 | /** | |
103 | * Instantiate a structure representing an ELF executable, possibly | |
104 | * with DWARF info, located at the given path. | |
105 | * | |
106 | * @param path Path to the ELF file | |
107 | * @param low_addr Base address of the executable | |
108 | * @param memsz In-memory size of the executable | |
9f2b13ca AB |
109 | * @param is_pic Whether the executable is position independent |
110 | * code (PIC) | |
9d325e17 PP |
111 | * @param debug_info_dir Directory containing debug info or NULL. |
112 | * @param target_prefix Path to the root file system of the target | |
113 | * or NULL. | |
d5ddf820 | 114 | * @returns Pointer to the new bin_info on success, |
c40a57e5 AB |
115 | * NULL on failure. |
116 | */ | |
117 | BT_HIDDEN | |
1e638f98 FD |
118 | struct bin_info *bin_info_create(struct bt_fd_cache *fdc, const char *path, |
119 | uint64_t low_addr, uint64_t memsz, bool is_pic, | |
3a3d15f3 | 120 | const char *debug_info_dir, const char *target_prefix, |
91bc8451 | 121 | bt_logging_level log_level, bt_self_component *self_comp); |
c40a57e5 AB |
122 | |
123 | /** | |
d5ddf820 | 124 | * Destroy the given bin_info instance |
c40a57e5 | 125 | * |
d5ddf820 | 126 | * @param bin bin_info instance to destroy |
c40a57e5 AB |
127 | */ |
128 | BT_HIDDEN | |
d5ddf820 | 129 | void bin_info_destroy(struct bin_info *bin); |
c40a57e5 AB |
130 | |
131 | /** | |
d5ddf820 | 132 | * Sets the build ID information for a given bin_info instance. |
c40a57e5 | 133 | * |
d5ddf820 | 134 | * @param bin The bin_info instance for which to set |
c40a57e5 AB |
135 | * the build ID |
136 | * @param build_id Array of bytes containing the actual ID | |
137 | * @param build_id_len Length in bytes of the build_id | |
138 | * @returns 0 on success, -1 on failure | |
139 | */ | |
140 | BT_HIDDEN | |
d5ddf820 | 141 | int bin_info_set_build_id(struct bin_info *bin, uint8_t *build_id, |
c40a57e5 AB |
142 | size_t build_id_len); |
143 | ||
144 | /** | |
d5ddf820 | 145 | * Sets the debug link information for a given bin_info instance. |
c40a57e5 | 146 | * |
d5ddf820 | 147 | * @param bin The bin_info instance for which to set |
c40a57e5 AB |
148 | * the debug link |
149 | * @param filename Name of the separate debug info file | |
150 | * @param crc Checksum for the debug info file | |
151 | * @returns 0 on success, -1 on failure | |
152 | */ | |
153 | BT_HIDDEN | |
4f45f9bb JD |
154 | int bin_info_set_debug_link(struct bin_info *bin, const char *filename, |
155 | uint32_t crc); | |
c40a57e5 AB |
156 | |
157 | /** | |
d5ddf820 AB |
158 | * Returns whether or not the given bin info \p bin contains the |
159 | * address \p addr. | |
c40a57e5 | 160 | * |
d5ddf820 | 161 | * @param bin bin_info instance |
c40a57e5 | 162 | * @param addr Address to lookup |
d5ddf820 | 163 | * @returns 1 if \p bin contains \p addr, 0 if it does not, |
c40a57e5 AB |
164 | * -1 on failure |
165 | */ | |
166 | static inline | |
d5ddf820 | 167 | int bin_info_has_address(struct bin_info *bin, uint64_t addr) |
c40a57e5 | 168 | { |
d5ddf820 | 169 | if (!bin) { |
c40a57e5 AB |
170 | return -1; |
171 | } | |
172 | ||
d5ddf820 | 173 | return addr >= bin->low_addr && addr < bin->high_addr; |
c40a57e5 AB |
174 | } |
175 | ||
176 | /** | |
177 | * Get the name of the function containing a given address within an | |
178 | * executable. | |
179 | * | |
180 | * If no DWARF info is available, the function falls back to ELF | |
181 | * symbols and the "function name" is in fact the name of the closest | |
182 | * symbol, followed by the offset between the symbol and the address. | |
183 | * | |
184 | * On success, if found, the out parameter `func_name` is set. The ownership | |
185 | * of `func_name` is passed to the caller. On failure, `func_name` remains | |
186 | * unchanged. | |
187 | * | |
d5ddf820 | 188 | * @param bin bin_info instance for the executable containing |
c40a57e5 AB |
189 | * the address |
190 | * @param addr Virtual memory address for which to find the | |
191 | * function name | |
192 | * @param func_name Out parameter, the function name. | |
193 | * @returns 0 on success, -1 on failure | |
194 | */ | |
195 | BT_HIDDEN | |
d5ddf820 | 196 | int bin_info_lookup_function_name(struct bin_info *bin, uint64_t addr, |
c40a57e5 AB |
197 | char **func_name); |
198 | ||
199 | /** | |
200 | * Get the source location (file name and line number) for a given | |
201 | * address within an executable. | |
202 | * | |
203 | * If no DWARF info is available, the source location cannot be found | |
4caab45b | 204 | * and the function will return unsuccessfully. |
c40a57e5 AB |
205 | * |
206 | * On success, if found, the out parameter `src_loc` is set. The ownership | |
207 | * of `src_loc` is passed to the caller. On failure, `src_loc` remains | |
208 | * unchanged. | |
209 | * | |
d5ddf820 | 210 | * @param bin bin_info instance for the executable containing |
c40a57e5 AB |
211 | * the address |
212 | * @param addr Virtual memory address for which to find the | |
213 | * source location | |
214 | * @param src_loc Out parameter, the source location | |
215 | * @returns 0 on success, -1 on failure | |
216 | */ | |
217 | BT_HIDDEN | |
d5ddf820 | 218 | int bin_info_lookup_source_location(struct bin_info *bin, uint64_t addr, |
c40a57e5 | 219 | struct source_location **src_loc); |
36ae9941 AB |
220 | /** |
221 | * Get a string representing the location within the binary of a given | |
222 | * address. | |
223 | * | |
224 | * In the case of a PIC binary, the location is relative (+0x1234). | |
225 | * For a non-PIC binary, the location is absolute (@0x1234) | |
226 | * | |
227 | * On success, the out parameter `bin_loc` is set. The ownership is | |
228 | * passed to the caller. On failure, `bin_loc` remains unchanged. | |
229 | * | |
d5ddf820 | 230 | * @param bin bin_info instance for the executable containing |
36ae9941 AB |
231 | * the address |
232 | * @param addr Virtual memory address for which to find the | |
233 | * binary location | |
234 | * @param bin_loc Out parameter, the binary location | |
235 | * @returns 0 on success, -1 on failure | |
236 | */ | |
237 | BT_HIDDEN | |
d5ddf820 | 238 | int bin_info_get_bin_loc(struct bin_info *bin, uint64_t addr, char **bin_loc); |
c40a57e5 AB |
239 | |
240 | /** | |
241 | * Destroy the given source_location instance | |
242 | * | |
243 | * @param src_loc source_location instance to destroy | |
244 | */ | |
245 | BT_HIDDEN | |
246 | void source_location_destroy(struct source_location *src_loc); | |
247 | ||
d5ddf820 | 248 | #endif /* _BABELTRACE_BIN_INFO_H */ |