4 * Babeltrace - Executable and Shared Object Debug Info Reader
6 * Copyright 2015 Antoine Busque <abusque@efficios.com>
8 * Author: Antoine Busque <abusque@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #define BT_COMP_LOG_SELF_COMP (bin->self_comp)
30 #define BT_LOG_OUTPUT_LEVEL (bin->log_level)
31 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO/BIN-INFO"
32 #include "logging/comp-logging.h"
34 #include <babeltrace2/logging.h>
48 #include "common/common.h"
56 * An address printed in hex is at most 20 bytes (16 for 64-bits +
57 * leading 0x + optional leading '+' if addr is an offset + null
60 #define ADDR_STR_LEN 20
61 #define BUILD_ID_NOTE_NAME "GNU"
64 int bin_info_init(bt_logging_level log_level
, bt_self_component
*self_comp
)
68 if (elf_version(EV_CURRENT
) == EV_NONE
) {
69 BT_COMP_LOG_CUR_LVL(BT_LOG_INFO
, log_level
, self_comp
,
70 "ELF library initialization failed: %s.",
79 struct bin_info
*bin_info_create(struct bt_fd_cache
*fdc
, const char *path
,
80 uint64_t low_addr
, uint64_t memsz
, bool is_pic
,
81 const char *debug_info_dir
, const char *target_prefix
,
82 bt_logging_level log_level
, bt_self_component
*self_comp
)
84 struct bin_info
*bin
= NULL
;
92 bin
= g_new0(struct bin_info
, 1);
97 bin
->log_level
= log_level
;
98 bin
->self_comp
= self_comp
;
100 bin
->elf_path
= g_build_filename(target_prefix
, path
, NULL
);
102 bin
->elf_path
= g_strdup(path
);
105 if (!bin
->elf_path
) {
109 if (debug_info_dir
) {
110 bin
->debug_info_dir
= g_strdup(debug_info_dir
);
111 if (!bin
->debug_info_dir
) {
116 bin
->is_pic
= is_pic
;
118 bin
->low_addr
= low_addr
;
119 bin
->high_addr
= bin
->low_addr
+ bin
->memsz
;
120 bin
->build_id
= NULL
;
121 bin
->build_id_len
= 0;
122 bin
->file_build_id_matches
= false;
128 bin_info_destroy(bin
);
133 void bin_info_destroy(struct bin_info
*bin
)
139 dwarf_end(bin
->dwarf_info
);
141 g_free(bin
->debug_info_dir
);
142 g_free(bin
->elf_path
);
143 g_free(bin
->dwarf_path
);
144 g_free(bin
->build_id
);
145 g_free(bin
->dbg_link_filename
);
147 elf_end(bin
->elf_file
);
149 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->elf_handle
);
150 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->dwarf_handle
);
156 * Initialize the ELF file for a given executable.
158 * @param bin bin_info instance
159 * @returns 0 on success, negative value on error.
162 int bin_info_set_elf_file(struct bin_info
*bin
)
164 struct bt_fd_cache_handle
*elf_handle
= NULL
;
165 Elf
*elf_file
= NULL
;
170 elf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, bin
->elf_path
);
172 BT_COMP_LOGI("Failed to open %s", bin
->elf_path
);
175 bin
->elf_handle
= elf_handle
;
177 elf_file
= elf_begin(bt_fd_cache_handle_get_fd(bin
->elf_handle
),
180 BT_COMP_LOGE_APPEND_CAUSE(bin
->self_comp
,
181 "elf_begin failed: %s", elf_errmsg(-1));
185 bin
->elf_file
= elf_file
;
187 if (elf_kind(elf_file
) != ELF_K_ELF
) {
188 BT_COMP_LOGE_APPEND_CAUSE(bin
->self_comp
,
189 "Error: %s is not an ELF object", bin
->elf_path
);
198 bt_fd_cache_put_handle(bin
->fd_cache
, elf_handle
);
207 * From a note section data struct, check if it is a build id note.
209 * @param note_data Pointer to a note section
211 * @returns 1 on match, 0 if `buf` does not contain a
212 * valid build id note
215 int is_build_id_note_section(Elf_Data
*note_data
)
217 size_t name_offset
, desc_offset
;
218 GElf_Nhdr note_header
;
222 * Discard the return value as it contains the size of the note section
223 * and we don't need it.
225 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
229 * Check the note name length. The name_sz field includes the
230 * terminating null byte.
232 if (note_header
.n_namesz
!= sizeof(BUILD_ID_NOTE_NAME
)) {
236 /* Check the note type. */
237 if (note_header
.n_type
!= NT_GNU_BUILD_ID
) {
241 /* Check the note name. */
242 if (memcmp(note_data
->d_buf
+ name_offset
, BUILD_ID_NOTE_NAME
,
243 note_header
.n_namesz
) != 0) {
254 * From a build id note section data struct, check if the build id it contains
255 * is identical to the build id passed as parameter.
257 * @param note_data Pointer to the file build id note section.
258 * @param build_id Pointer to a build id to compare to.
259 * @param build_id_len length of the build id.
261 * @returns 1 on match, 0 otherwise.
264 int is_build_id_note_section_matching(Elf_Data
*note_data
,
265 uint8_t *build_id
, size_t build_id_len
)
267 size_t name_offset
, desc_offset
;
268 GElf_Nhdr note_header
;
270 if (build_id_len
<= 0) {
275 * Discard the return value as it contains the size of the note section
276 * and we don't need it.
278 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
282 * Compare the binary build id with the supplied build id.
284 if (memcmp(build_id
, note_data
->d_buf
+ desc_offset
,
285 build_id_len
) == 0) {
293 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
294 * id of the ondisk file (bin->elf_file).
296 * @param bin bin_info instance
297 * @param build_id build id to compare ot the on disk file
298 * @param build_id_len length of the build id
300 * @returns 1 on if the build id of stored in `bin` matches
301 * the build id of the ondisk file.
302 * 0 on if they are different or an error occured.
305 int is_build_id_matching(struct bin_info
*bin
)
307 int ret
, is_build_id
, is_matching
= 0;
308 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
309 GElf_Shdr curr_section_hdr
;
311 if (!bin
->build_id
) {
315 /* Set ELF file if it hasn't been accessed yet. */
316 if (!bin
->elf_file
) {
317 ret
= bin_info_set_elf_file(bin
);
319 /* Failed to set ELF file. */
324 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
329 while (next_section
) {
330 Elf_Data
*note_data
= NULL
;
332 curr_section
= next_section
;
333 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
335 if (!gelf_getshdr(curr_section
, &curr_section_hdr
)) {
339 if (curr_section_hdr
.sh_type
!= SHT_NOTE
) {
344 * elf_getdata() translates the data to native byte order.
346 note_data
= elf_getdata(curr_section
, NULL
);
351 /* Check if the note is of the build-id type. */
352 is_build_id
= is_build_id_note_section(note_data
);
358 * Compare the build id of the on-disk file and
359 * the build id recorded in the trace.
361 is_matching
= is_build_id_note_section_matching(
362 note_data
, bin
->build_id
, bin
->build_id_len
);
372 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
375 if (!bin
|| !build_id
) {
379 /* Set the build id. */
380 bin
->build_id
= g_new0(uint8_t, build_id_len
);
381 if (!bin
->build_id
) {
385 memcpy(bin
->build_id
, build_id
, build_id_len
);
386 bin
->build_id_len
= build_id_len
;
389 * Check if the file found on the file system has the same build id
390 * that what was recorded in the trace.
392 bin
->file_build_id_matches
= is_build_id_matching(bin
);
393 if (!bin
->file_build_id_matches
) {
394 BT_COMP_LOGI_STR("Supplied Build ID does not match Build ID of the "
395 "binary or library found on the file system.");
400 * Reset the is_elf_only flag in case it had been set
401 * previously, because we might find separate debug info using
402 * the new build id information.
404 bin
->is_elf_only
= false;
413 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
416 if (!bin
|| !filename
) {
420 bin
->dbg_link_filename
= g_strdup(filename
);
421 if (!bin
->dbg_link_filename
) {
425 bin
->dbg_link_crc
= crc
;
428 * Reset the is_elf_only flag in case it had been set
429 * previously, because we might find separate debug info using
430 * the new build id information.
432 bin
->is_elf_only
= false;
442 * Tries to read DWARF info from the location given by path, and
443 * attach it to the given bin_info instance if it exists.
445 * @param bin bin_info instance for which to set DWARF info
446 * @param path Presumed location of the DWARF info
447 * @returns 0 on success, negative value on failure
450 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
453 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
454 struct bt_dwarf_cu
*cu
= NULL
;
455 Dwarf
*dwarf_info
= NULL
;
461 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
466 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
473 * Check if the dwarf info has any CU. If not, the
474 * executable's object file contains no DWARF info.
476 cu
= bt_dwarf_cu_create(dwarf_info
);
481 ret
= bt_dwarf_cu_next(cu
);
486 bin
->dwarf_handle
= dwarf_handle
;
487 bin
->dwarf_path
= g_strdup(path
);
488 if (!bin
->dwarf_path
) {
491 bin
->dwarf_info
= dwarf_info
;
498 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
500 dwarf_end(dwarf_info
);
508 * Try to set the dwarf_info for a given bin_info instance via the
511 * @param bin bin_info instance for which to retrieve the
512 * DWARF info via build ID
513 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
516 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
519 char *path
= NULL
, *build_id_prefix_dir
= NULL
, *build_id_file
= NULL
;
520 const char *dbg_dir
= NULL
;
521 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
523 if (!bin
|| !bin
->build_id
) {
527 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
530 * The prefix dir is the first byte of the build id, represented in
531 * lowercase hex as two characters per byte, +1 for '\0'.
533 build_id_prefix_dir
= g_new0(gchar
, BUILD_ID_PREFIX_DIR_LEN
+ 1);
534 if (!build_id_prefix_dir
) {
537 g_snprintf(build_id_prefix_dir
, BUILD_ID_PREFIX_DIR_LEN
+ 1, "%02x", bin
->build_id
[0]);
540 * The build id file is the remaining bytes of the build id,
541 * represented in lowercase hex, as two characters per byte.
543 build_id_char_len
= (2 * (bin
->build_id_len
- 1));
545 /* To which the build id suffix is added, +1 for '\0'. */
546 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
549 * The resulting filename string is the concatenation of the
550 * hex build id and the suffix.
552 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
553 build_id_file
= g_new0(gchar
, build_id_file_len
);
554 if (!build_id_file
) {
559 * For each byte, starting at offset 1, append two characters
562 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
563 int path_idx
= 2 * (i
- 1);
565 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
567 /* Append the suffix to the generated string, including the '\0'. */
568 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
571 path
= g_build_filename(dbg_dir
, BUILD_ID_SUBDIR
, build_id_prefix_dir
, build_id_file
, NULL
);
576 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
586 g_free(build_id_prefix_dir
);
587 g_free(build_id_file
);
594 * Tests whether the file located at path exists and has the expected
597 * This predicate is used when looking up separate debug info via the
598 * GNU debuglink method. The expected crc can be found .gnu_debuglink
599 * section in the original ELF file, along with the filename for the
600 * file containing the debug info.
602 * @param path Full path at which to look for the debug file
603 * @param crc Expected checksum for the debug file
604 * @returns 1 if the file exists and has the correct checksum,
608 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
611 struct bt_fd_cache_handle
*debug_handle
= NULL
;
618 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
623 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
632 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
637 * Try to set the dwarf_info for a given bin_info instance via the
640 * @param bin bin_info instance for which to retrieve the
641 * DWARF info via debug link
642 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
645 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
648 const gchar
*dbg_dir
= NULL
;
649 gchar
*bin_dir
= NULL
, *path
= NULL
;
651 if (!bin
|| !bin
->dbg_link_filename
) {
655 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
656 bin_dir
= g_path_get_dirname(bin
->elf_path
);
658 /* First look in the executable's dir */
659 path
= g_build_filename(bin_dir
, bin
->dbg_link_filename
, NULL
);
661 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
665 /* If not found, look in .debug subdir */
667 path
= g_build_filename(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
669 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
673 /* Lastly, look under the global debug directory */
676 path
= g_build_filename(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
677 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
690 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
699 * Initialize the DWARF info for a given executable.
701 * @param bin bin_info instance
702 * @returns 0 on success, negative value on failure
705 int bin_info_set_dwarf_info(struct bin_info
*bin
)
714 /* First try to set the DWARF info from the ELF file */
715 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
721 * If that fails, try to find separate debug info via build ID
724 ret
= bin_info_set_dwarf_info_build_id(bin
);
729 ret
= bin_info_set_dwarf_info_debug_link(bin
);
739 void source_location_destroy(struct source_location
*src_loc
)
745 free(src_loc
->filename
);
750 * Append a string representation of an address offset to an existing
753 * On success, the out parameter `result` will contain the base string
754 * followed by the offset string of the form "+0x1234". On failure,
755 * `result` remains unchanged.
757 * @param base_str The string to which to append an offset string
758 * @param low_addr The lower virtual memory address, the base from
759 * which the offset is computed
760 * @param high_addr The higher virtual memory address
761 * @param result Out parameter, the base string followed by the
763 * @returns 0 on success, -1 on failure
766 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
767 uint64_t high_addr
, char **result
)
770 char *_result
= NULL
;
772 if (!base_str
|| !result
) {
776 offset
= high_addr
- low_addr
;
778 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
792 * Try to find the symbol closest to an address within a given ELF
795 * Only function symbols are taken into account. The symbol's address
796 * must precede `addr`. A symbol with a closer address might exist
797 * after `addr` but is irrelevant because it cannot encompass `addr`.
799 * On success, if found, the out parameters `sym` and `shdr` are
800 * set. On failure or if none are found, they remain unchanged.
802 * @param scn ELF section in which to look for the address
803 * @param addr Virtual memory address for which to find the
804 * nearest function symbol
805 * @param sym Out parameter, the nearest function symbol
806 * @param shdr Out parameter, the section header for scn
807 * @returns 0 on success, -1 on failure
810 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
811 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
815 Elf_Data
*data
= NULL
;
816 GElf_Shdr
*_shdr
= NULL
;
817 GElf_Sym
*nearest_sym
= NULL
;
819 if (!scn
|| !sym
|| !shdr
) {
823 _shdr
= g_new0(GElf_Shdr
, 1);
828 _shdr
= gelf_getshdr(scn
, _shdr
);
833 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
835 * We are only interested in symbol table (symtab)
836 * sections, skip this one.
841 data
= elf_getdata(scn
, NULL
);
846 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
848 for (i
= 0; i
< symbol_count
; ++i
) {
849 GElf_Sym
*cur_sym
= NULL
;
851 cur_sym
= g_new0(GElf_Sym
, 1);
855 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
859 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
860 /* We're only interested in the functions. */
865 if (cur_sym
->st_value
<= addr
&&
867 cur_sym
->st_value
> nearest_sym
->st_value
)) {
869 nearest_sym
= cur_sym
;
892 * Get the name of the function containing a given address within an
893 * executable using ELF symbols.
895 * The function name is in fact the name of the nearest ELF symbol,
896 * followed by the offset in bytes between the address and the symbol
897 * (in hex), separated by a '+' character.
899 * If found, the out parameter `func_name` is set on success. On failure,
900 * it remains unchanged.
902 * @param bin bin_info instance for the executable containing
904 * @param addr Virtual memory address for which to find the
906 * @param func_name Out parameter, the function name
907 * @returns 0 on success, -1 on failure
910 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
914 * TODO (possible optimisation): if an ELF has no symtab
915 * section, it has been stripped. Therefore, it would be wise
916 * to store a flag indicating the stripped status after the
917 * first iteration to prevent subsequent ones.
921 GElf_Sym
*sym
= NULL
;
922 GElf_Shdr
*shdr
= NULL
;
923 char *sym_name
= NULL
;
925 /* Set ELF file if it hasn't been accessed yet. */
926 if (!bin
->elf_file
) {
927 ret
= bin_info_set_elf_file(bin
);
929 /* Failed to set ELF file. */
934 scn
= elf_nextscn(bin
->elf_file
, scn
);
939 while (scn
&& !sym
) {
940 ret
= bin_info_get_nearest_symbol_from_section(
941 scn
, addr
, &sym
, &shdr
);
946 scn
= elf_nextscn(bin
->elf_file
, scn
);
950 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
956 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
974 * Get the name of the function containing a given address within a
975 * given compile unit (CU).
977 * If found, the out parameter `func_name` is set on success. On
978 * failure, it remains unchanged.
980 * @param cu bt_dwarf_cu instance which may contain the address
981 * @param addr Virtual memory address for which to find the
983 * @param func_name Out parameter, the function name
984 * @returns 0 on success, -1 on failure
987 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
992 struct bt_dwarf_die
*die
= NULL
;
994 if (!cu
|| !func_name
) {
998 die
= bt_dwarf_die_create(cu
);
1003 while (bt_dwarf_die_next(die
) == 0) {
1006 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1011 if (tag
== DW_TAG_subprogram
) {
1012 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1024 uint64_t low_addr
= 0;
1025 char *die_name
= NULL
;
1027 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1032 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1038 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1046 bt_dwarf_die_destroy(die
);
1050 bt_dwarf_die_destroy(die
);
1055 * Get the name of the function containing a given address within an
1056 * executable using DWARF debug info.
1058 * If found, the out parameter `func_name` is set on success. On
1059 * failure, it remains unchanged.
1061 * @param bin bin_info instance for the executable containing
1063 * @param addr Virtual memory address for which to find the
1065 * @param func_name Out parameter, the function name
1066 * @returns 0 on success, -1 on failure
1069 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1073 char *_func_name
= NULL
;
1074 struct bt_dwarf_cu
*cu
= NULL
;
1076 if (!bin
|| !func_name
) {
1080 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1085 while (bt_dwarf_cu_next(cu
) == 0) {
1086 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1097 *func_name
= _func_name
;
1102 bt_dwarf_cu_destroy(cu
);
1106 bt_dwarf_cu_destroy(cu
);
1111 int bin_info_lookup_function_name(struct bin_info
*bin
,
1112 uint64_t addr
, char **func_name
)
1115 char *_func_name
= NULL
;
1117 if (!bin
|| !func_name
) {
1122 * If the bin_info has a build id but it does not match the build id
1123 * that was found on the file system, return an error.
1125 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1129 /* Set DWARF info if it hasn't been accessed yet. */
1130 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1131 ret
= bin_info_set_dwarf_info(bin
);
1133 BT_COMP_LOGI_STR("Failed to set bin dwarf info, falling "
1134 "back to ELF lookup.");
1135 /* Failed to set DWARF info, fallback to ELF. */
1136 bin
->is_elf_only
= true;
1140 if (!bin_info_has_address(bin
, addr
)) {
1145 * Addresses in ELF and DWARF are relative to base address for
1146 * PIC, so make the address argument relative too if needed.
1149 addr
-= bin
->low_addr
;
1152 if (bin
->is_elf_only
) {
1153 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1156 BT_COMP_LOGI("Failed to lookup function name (ELF): "
1160 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1163 BT_COMP_LOGI("Failed to lookup function name (DWARF): "
1168 *func_name
= _func_name
;
1176 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1178 gchar
*_bin_loc
= NULL
;
1180 if (!bin
|| !bin_loc
) {
1185 * If the bin_info has a build id but it does not match the build id
1186 * that was found on the file system, return an error.
1188 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1193 addr
-= bin
->low_addr
;
1194 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1196 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1203 *bin_loc
= _bin_loc
;
1211 * Predicate used to determine whether the children of a given DIE
1212 * contain a specific address.
1214 * More specifically, the parameter `die` is expected to be a
1215 * subprogram (function) DIE, and this predicate tells whether any
1216 * subroutines are inlined within this function and would contain
1219 * On success, the out parameter `contains` is set with the boolean
1220 * value indicating whether the DIE's range covers `addr`. On failure,
1221 * it remains unchanged.
1223 * Do note that this function advances the position of `die`. If the
1224 * address is found within one of its children, `die` will be pointing
1225 * to that child upon returning from the function, allowing to extract
1226 * the information deemed necessary.
1228 * @param die The parent DIE in whose children the address will be
1230 * @param addr The address for which to look for in the DIEs
1231 * @param contains Out parameter, true if addr is contained,
1233 * @returns Returns 0 on success, -1 on failure
1236 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1239 bool _contains
= false;
1245 ret
= bt_dwarf_die_child(die
);
1251 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1258 * The address is within the range of the current DIE
1263 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1268 if (tag
== DW_TAG_inlined_subroutine
) {
1269 /* Found the tracepoint. */
1273 if (bt_dwarf_die_has_children(die
)) {
1275 * Look for the address in the children DIEs.
1277 ret
= bt_dwarf_die_child(die
);
1283 } while (bt_dwarf_die_next(die
) == 0);
1286 *contains
= _contains
;
1294 * Lookup the source location for a given address within a CU, making
1295 * the assumption that it is contained within an inline routine in a
1298 * @param cu bt_dwarf_cu instance in which to look for the address
1299 * @param addr The address for which to look for
1300 * @param src_loc Out parameter, the source location (filename and
1301 * line number) for the address
1302 * @returns 0 on success, -1 on failure
1305 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1306 struct source_location
**src_loc
)
1310 struct bt_dwarf_die
*die
= NULL
;
1311 struct source_location
*_src_loc
= NULL
;
1313 if (!cu
|| !src_loc
) {
1317 die
= bt_dwarf_die_create(cu
);
1322 while (bt_dwarf_die_next(die
) == 0) {
1325 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1330 if (tag
== DW_TAG_subprogram
) {
1331 bool contains
= false;
1333 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1340 * Try to find an inlined subroutine
1341 * child of this DIE containing addr.
1343 ret
= bin_info_child_die_has_address(die
, addr
,
1356 char *filename
= NULL
;
1359 _src_loc
= g_new0(struct source_location
, 1);
1364 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1368 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1374 _src_loc
->filename
= filename
;
1375 _src_loc
->line_no
= line_no
;
1376 *src_loc
= _src_loc
;
1379 bt_dwarf_die_destroy(die
);
1383 source_location_destroy(_src_loc
);
1384 bt_dwarf_die_destroy(die
);
1389 * Lookup the source location for a given address within a CU,
1390 * assuming that it is contained within an inlined function.
1392 * A source location can be found regardless of inlining status for
1393 * this method, but in the case of an inlined function, the returned
1394 * source location will point not to the callsite but rather to the
1395 * definition site of the inline function.
1397 * @param cu bt_dwarf_cu instance in which to look for the address
1398 * @param addr The address for which to look for
1399 * @param src_loc Out parameter, the source location (filename and
1400 * line number) for the address. Set only if the address
1401 * is found and resolved successfully
1403 * @returns 0 on success, -1 on failure
1406 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1407 struct source_location
**src_loc
)
1409 struct source_location
*_src_loc
= NULL
;
1410 struct bt_dwarf_die
*die
= NULL
;
1411 const char *filename
= NULL
;
1412 Dwarf_Line
*line
= NULL
;
1413 Dwarf_Addr line_addr
;
1414 int ret
= 0, line_no
;
1416 if (!cu
|| !src_loc
) {
1420 die
= bt_dwarf_die_create(cu
);
1425 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1427 /* This is not an error. The caller needs to keep looking. */
1431 ret
= dwarf_lineaddr(line
, &line_addr
);
1436 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1441 if (addr
== line_addr
) {
1442 _src_loc
= g_new0(struct source_location
, 1);
1447 ret
= dwarf_lineno(line
, &line_no
);
1452 _src_loc
->line_no
= line_no
;
1453 _src_loc
->filename
= g_strdup(filename
);
1457 *src_loc
= _src_loc
;
1463 source_location_destroy(_src_loc
);
1466 bt_dwarf_die_destroy(die
);
1471 * Get the source location (file name and line number) for a given
1472 * address within a compile unit (CU).
1474 * On success, the out parameter `src_loc` is set if found. On
1475 * failure, it remains unchanged.
1477 * @param cu bt_dwarf_cu instance for the compile unit which
1478 * may contain the address
1479 * @param addr Virtual memory address for which to find the
1481 * @param src_loc Out parameter, the source location
1482 * @returns 0 on success, -1 on failure
1485 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1486 struct source_location
**src_loc
)
1489 struct source_location
*_src_loc
= NULL
;
1491 if (!cu
|| !src_loc
) {
1495 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1504 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1515 *src_loc
= _src_loc
;
1521 source_location_destroy(_src_loc
);
1526 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1527 struct source_location
**src_loc
)
1529 struct bt_dwarf_cu
*cu
= NULL
;
1530 struct source_location
*_src_loc
= NULL
;
1532 if (!bin
|| !src_loc
) {
1537 * If the bin_info has a build id but it does not match the build id
1538 * that was found on the file system, return an error.
1540 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1544 /* Set DWARF info if it hasn't been accessed yet. */
1545 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1546 if (bin_info_set_dwarf_info(bin
)) {
1547 /* Failed to set DWARF info. */
1548 bin
->is_elf_only
= true;
1552 if (bin
->is_elf_only
) {
1553 /* We cannot lookup source location without DWARF info. */
1557 if (!bin_info_has_address(bin
, addr
)) {
1562 * Addresses in ELF and DWARF are relative to base address for
1563 * PIC, so make the address argument relative too if needed.
1566 addr
-= bin
->low_addr
;
1569 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1574 while (bt_dwarf_cu_next(cu
) == 0) {
1577 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1587 bt_dwarf_cu_destroy(cu
);
1589 *src_loc
= _src_loc
;
1595 source_location_destroy(_src_loc
);
1596 bt_dwarf_cu_destroy(cu
);