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
33 #include <elfutils/libdw.h>
34 #include <babeltrace/babeltrace-internal.h>
36 #define DEFAULT_DEBUG_DIR "/usr/lib/debug"
37 #define DEBUG_SUBDIR ".debug/"
38 #define BUILD_ID_SUBDIR ".build-id/"
39 #define BUILD_ID_SUFFIX ".debug"
42 /* Base virtual memory address. */
44 /* Upper bound of exec address space. */
46 /* Size of exec address space. */
48 /* Paths to ELF and DWARF files. */
51 /* libelf and libdw objects representing the files. */
54 /* Optional build ID info. */
57 /* Optional debug link info. */
58 char *dbg_link_filename
;
59 uint32_t dbg_link_crc
;
60 /* FDs to ELF and DWARF files. */
65 /* Denotes whether the executable is position independent code. */
68 * Denotes whether the executable only has ELF symbols and no
74 struct source_location
{
80 * Initializes the bin_info framework. Call this before calling
83 * @returns 0 on success, -1 on failure
86 int bin_info_init(void);
89 * Instantiate a structure representing an ELF executable, possibly
90 * with DWARF info, located at the given path.
92 * @param path Path to the ELF file
93 * @param low_addr Base address of the executable
94 * @param memsz In-memory size of the executable
95 * @param is_pic Whether the executable is position independent
97 * @param debug_info_dir Directory containing debug info or NULL.
98 * @param target_prefix Path to the root file system of the target
100 * @returns Pointer to the new bin_info on success,
104 struct bin_info
*bin_info_create(const char *path
, uint64_t low_addr
,
105 uint64_t memsz
, bool is_pic
, const char *debug_info_dir
,
106 const char *target_prefix
);
109 * Destroy the given bin_info instance
111 * @param bin bin_info instance to destroy
114 void bin_info_destroy(struct bin_info
*bin
);
117 * Sets the build ID information for a given bin_info instance.
119 * @param bin The bin_info instance for which to set
121 * @param build_id Array of bytes containing the actual ID
122 * @param build_id_len Length in bytes of the build_id
123 * @returns 0 on success, -1 on failure
126 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
127 size_t build_id_len
);
130 * Sets the debug link information for a given bin_info instance.
132 * @param bin The bin_info instance for which to set
134 * @param filename Name of the separate debug info file
135 * @param crc Checksum for the debug info file
136 * @returns 0 on success, -1 on failure
139 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
143 * Returns whether or not the given bin info \p bin contains the
146 * @param bin bin_info instance
147 * @param addr Address to lookup
148 * @returns 1 if \p bin contains \p addr, 0 if it does not,
152 int bin_info_has_address(struct bin_info
*bin
, uint64_t addr
)
158 return addr
>= bin
->low_addr
&& addr
< bin
->high_addr
;
162 * Get the name of the function containing a given address within an
165 * If no DWARF info is available, the function falls back to ELF
166 * symbols and the "function name" is in fact the name of the closest
167 * symbol, followed by the offset between the symbol and the address.
169 * On success, if found, the out parameter `func_name` is set. The ownership
170 * of `func_name` is passed to the caller. On failure, `func_name` remains
173 * @param bin bin_info instance for the executable containing
175 * @param addr Virtual memory address for which to find the
177 * @param func_name Out parameter, the function name.
178 * @returns 0 on success, -1 on failure
181 int bin_info_lookup_function_name(struct bin_info
*bin
, uint64_t addr
,
185 * Get the source location (file name and line number) for a given
186 * address within an executable.
188 * If no DWARF info is available, the source location cannot be found
189 * and the function will return unsuccessfully.
191 * On success, if found, the out parameter `src_loc` is set. The ownership
192 * of `src_loc` is passed to the caller. On failure, `src_loc` remains
195 * @param bin bin_info instance for the executable containing
197 * @param addr Virtual memory address for which to find the
199 * @param src_loc Out parameter, the source location
200 * @returns 0 on success, -1 on failure
203 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
204 struct source_location
**src_loc
);
206 * Get a string representing the location within the binary of a given
209 * In the case of a PIC binary, the location is relative (+0x1234).
210 * For a non-PIC binary, the location is absolute (@0x1234)
212 * On success, the out parameter `bin_loc` is set. The ownership is
213 * passed to the caller. On failure, `bin_loc` remains unchanged.
215 * @param bin bin_info instance for the executable containing
217 * @param addr Virtual memory address for which to find the
219 * @param bin_loc Out parameter, the binary location
220 * @returns 0 on success, -1 on failure
223 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
);
226 * Destroy the given source_location instance
228 * @param src_loc source_location instance to destroy
231 void source_location_destroy(struct source_location
*src_loc
);
233 #endif /* _BABELTRACE_BIN_INFO_H */
This page took 0.034537 seconds and 4 git commands to generate.