1 #ifndef _BABELTRACE_BIN_INFO_H
2 #define _BABELTRACE_BIN_INFO_H
5 * Babeltrace - Executable and Shared Object Debug Info Reader
7 * Copyright 2015 Antoine Busque <abusque@efficios.com>
9 * Author: Antoine Busque <abusque@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <babeltrace2/babeltrace.h>
34 #include <elfutils/libdw.h>
35 #include "common/macros.h"
36 #include "fd-cache/fd-cache.h"
38 #define DEFAULT_DEBUG_DIR "/usr/lib/debug"
39 #define DEBUG_SUBDIR ".debug"
40 #define BUILD_ID_SUBDIR ".build-id"
41 #define BUILD_ID_SUFFIX ".debug"
42 #define BUILD_ID_PREFIX_DIR_LEN 2
45 bt_logging_level log_level
;
47 /* Used for logging; can be `NULL` */
48 bt_self_component
*self_comp
;
50 /* Base virtual memory address. */
52 /* Upper bound of exec address space. */
54 /* Size of exec address space. */
56 /* Paths to ELF and DWARF files. */
59 /* libelf and libdw objects representing the files. */
62 /* Optional build ID info. */
66 /* Optional debug link info. */
67 gchar
*dbg_link_filename
;
68 uint32_t dbg_link_crc
;
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
;
73 gchar
*debug_info_dir
;
74 /* Denotes whether the executable is position independent code. */
76 /* Denotes whether the build id in the trace matches to one on disk. */
77 bool file_build_id_matches
:1;
79 * Denotes whether the executable only has ELF symbols and no
83 /* Weak ref. Owned by the iterator. */
84 struct bt_fd_cache
*fd_cache
;
87 struct source_location
{
93 * Initializes the bin_info framework. Call this before calling
96 * @returns 0 on success, -1 on failure
99 int bin_info_init(bt_logging_level log_level
,
100 bt_self_component
*self_comp
);
103 * Instantiate a structure representing an ELF executable, possibly
104 * with DWARF info, located at the given path.
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
109 * @param is_pic Whether the executable is position independent
111 * @param debug_info_dir Directory containing debug info or NULL.
112 * @param target_prefix Path to the root file system of the target
114 * @returns Pointer to the new bin_info on success,
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
,
120 const char *debug_info_dir
, const char *target_prefix
,
121 bt_logging_level log_level
, bt_self_component
*self_comp
);
124 * Destroy the given bin_info instance
126 * @param bin bin_info instance to destroy
129 void bin_info_destroy(struct bin_info
*bin
);
132 * Sets the build ID information for a given bin_info instance.
134 * @param bin The bin_info instance for which to set
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
141 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
142 size_t build_id_len
);
145 * Sets the debug link information for a given bin_info instance.
147 * @param bin The bin_info instance for which to set
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
154 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
158 * Returns whether or not the given bin info \p bin contains the
161 * @param bin bin_info instance
162 * @param addr Address to lookup
163 * @returns 1 if \p bin contains \p addr, 0 if it does not,
167 int bin_info_has_address(struct bin_info
*bin
, uint64_t addr
)
173 return addr
>= bin
->low_addr
&& addr
< bin
->high_addr
;
177 * Get the name of the function containing a given address within an
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.
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
188 * @param bin bin_info instance for the executable containing
190 * @param addr Virtual memory address for which to find the
192 * @param func_name Out parameter, the function name.
193 * @returns 0 on success, -1 on failure
196 int bin_info_lookup_function_name(struct bin_info
*bin
, uint64_t addr
,
200 * Get the source location (file name and line number) for a given
201 * address within an executable.
203 * If no DWARF info is available, the source location cannot be found
204 * and the function will return unsuccessfully.
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
210 * @param bin bin_info instance for the executable containing
212 * @param addr Virtual memory address for which to find the
214 * @param src_loc Out parameter, the source location
215 * @returns 0 on success, -1 on failure
218 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
219 struct source_location
**src_loc
);
221 * Get a string representing the location within the binary of a given
224 * In the case of a PIC binary, the location is relative (+0x1234).
225 * For a non-PIC binary, the location is absolute (@0x1234)
227 * On success, the out parameter `bin_loc` is set. The ownership is
228 * passed to the caller. On failure, `bin_loc` remains unchanged.
230 * @param bin bin_info instance for the executable containing
232 * @param addr Virtual memory address for which to find the
234 * @param bin_loc Out parameter, the binary location
235 * @returns 0 on success, -1 on failure
238 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
);
241 * Destroy the given source_location instance
243 * @param src_loc source_location instance to destroy
246 void source_location_destroy(struct source_location
*src_loc
);
248 #endif /* _BABELTRACE_BIN_INFO_H */