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. */
63 /* Denotes whether the executable is position independent code. */
66 * Denotes whether the executable only has ELF symbols and no
72 struct source_location
{
78 * Initializes the bin_info framework. Call this before calling
81 * @returns 0 on success, -1 on failure
84 int bin_info_init(void);
87 * Instantiate a structure representing an ELF executable, possibly
88 * with DWARF info, located at the given path.
90 * @param path Path to the ELF file
91 * @param low_addr Base address of the executable
92 * @param memsz In-memory size of the executable
93 * @param is_pic Whether the executable is position independent
95 * @returns Pointer to the new bin_info on success,
99 struct bin_info
*bin_info_create(const char *path
, uint64_t low_addr
,
100 uint64_t memsz
, bool is_pic
);
103 * Destroy the given bin_info instance
105 * @param bin bin_info instance to destroy
108 void bin_info_destroy(struct bin_info
*bin
);
111 * Sets the build ID information for a given bin_info instance.
113 * @param bin The bin_info instance for which to set
115 * @param build_id Array of bytes containing the actual ID
116 * @param build_id_len Length in bytes of the build_id
117 * @returns 0 on success, -1 on failure
120 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
121 size_t build_id_len
);
124 * Sets the debug link information for a given bin_info instance.
126 * @param bin The bin_info instance for which to set
128 * @param filename Name of the separate debug info file
129 * @param crc Checksum for the debug info file
130 * @returns 0 on success, -1 on failure
133 int bin_info_set_debug_link(struct bin_info
*bin
, char *filename
, uint32_t crc
);
136 * Returns whether or not the given bin info \p bin contains the
139 * @param bin bin_info instance
140 * @param addr Address to lookup
141 * @returns 1 if \p bin contains \p addr, 0 if it does not,
145 int bin_info_has_address(struct bin_info
*bin
, uint64_t addr
)
151 return addr
>= bin
->low_addr
&& addr
< bin
->high_addr
;
155 * Get the name of the function containing a given address within an
158 * If no DWARF info is available, the function falls back to ELF
159 * symbols and the "function name" is in fact the name of the closest
160 * symbol, followed by the offset between the symbol and the address.
162 * On success, if found, the out parameter `func_name` is set. The ownership
163 * of `func_name` is passed to the caller. On failure, `func_name` remains
166 * @param bin bin_info instance for the executable containing
168 * @param addr Virtual memory address for which to find the
170 * @param func_name Out parameter, the function name.
171 * @returns 0 on success, -1 on failure
174 int bin_info_lookup_function_name(struct bin_info
*bin
, uint64_t addr
,
178 * Get the source location (file name and line number) for a given
179 * address within an executable.
181 * If no DWARF info is available, the source location cannot be found
182 * and the function will return unsuccessfully.
184 * On success, if found, the out parameter `src_loc` is set. The ownership
185 * of `src_loc` is passed to the caller. On failure, `src_loc` remains
188 * @param bin bin_info instance for the executable containing
190 * @param addr Virtual memory address for which to find the
192 * @param src_loc Out parameter, the source location
193 * @returns 0 on success, -1 on failure
196 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
197 struct source_location
**src_loc
);
199 * Get a string representing the location within the binary of a given
202 * In the case of a PIC binary, the location is relative (+0x1234).
203 * For a non-PIC binary, the location is absolute (@0x1234)
205 * On success, the out parameter `bin_loc` is set. The ownership is
206 * passed to the caller. On failure, `bin_loc` remains unchanged.
208 * @param bin bin_info instance for the executable containing
210 * @param addr Virtual memory address for which to find the
212 * @param bin_loc Out parameter, the binary location
213 * @returns 0 on success, -1 on failure
216 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
);
219 * Destroy the given source_location instance
221 * @param src_loc source_location instance to destroy
224 void source_location_destroy(struct source_location
*src_loc
);
226 #endif /* _BABELTRACE_BIN_INFO_H */
This page took 0.033264 seconds and 4 git commands to generate.