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>
49 #include "common/common.h"
57 * An address printed in hex is at most 20 bytes (16 for 64-bits +
58 * leading 0x + optional leading '+' if addr is an offset + null
61 #define ADDR_STR_LEN 20
62 #define BUILD_ID_NOTE_NAME "GNU"
65 int bin_info_init(bt_logging_level log_level
, bt_self_component
*self_comp
)
69 if (elf_version(EV_CURRENT
) == EV_NONE
) {
70 BT_COMP_LOG_CUR_LVL(BT_LOG_INFO
, log_level
, self_comp
,
71 "ELF library initialization failed: %s.",
80 struct bin_info
*bin_info_create(struct bt_fd_cache
*fdc
, const char *path
,
81 uint64_t low_addr
, uint64_t memsz
, bool is_pic
,
82 const char *debug_info_dir
, const char *target_prefix
,
83 bt_logging_level log_level
, bt_self_component
*self_comp
)
85 struct bin_info
*bin
= NULL
;
93 bin
= g_new0(struct bin_info
, 1);
98 bin
->log_level
= log_level
;
99 bin
->self_comp
= self_comp
;
101 bin
->elf_path
= g_build_filename(target_prefix
, path
, NULL
);
103 bin
->elf_path
= g_strdup(path
);
106 if (!bin
->elf_path
) {
110 if (debug_info_dir
) {
111 bin
->debug_info_dir
= g_strdup(debug_info_dir
);
112 if (!bin
->debug_info_dir
) {
117 bin
->is_pic
= is_pic
;
119 bin
->low_addr
= low_addr
;
120 bin
->high_addr
= bin
->low_addr
+ bin
->memsz
;
121 bin
->build_id
= NULL
;
122 bin
->build_id_len
= 0;
123 bin
->file_build_id_matches
= false;
129 bin_info_destroy(bin
);
134 void bin_info_destroy(struct bin_info
*bin
)
140 dwarf_end(bin
->dwarf_info
);
142 g_free(bin
->debug_info_dir
);
143 g_free(bin
->elf_path
);
144 g_free(bin
->dwarf_path
);
145 g_free(bin
->build_id
);
146 g_free(bin
->dbg_link_filename
);
148 elf_end(bin
->elf_file
);
150 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->elf_handle
);
151 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->dwarf_handle
);
157 * Initialize the ELF file for a given executable.
159 * @param bin bin_info instance
160 * @returns 0 on success, negative value on error.
163 int bin_info_set_elf_file(struct bin_info
*bin
)
165 struct bt_fd_cache_handle
*elf_handle
= NULL
;
166 Elf
*elf_file
= NULL
;
171 elf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, bin
->elf_path
);
173 BT_COMP_LOGI("Failed to open %s", bin
->elf_path
);
176 bin
->elf_handle
= elf_handle
;
178 elf_file
= elf_begin(bt_fd_cache_handle_get_fd(bin
->elf_handle
),
181 BT_COMP_LOGE_APPEND_CAUSE(bin
->self_comp
,
182 "elf_begin failed: %s", elf_errmsg(-1));
186 bin
->elf_file
= elf_file
;
188 if (elf_kind(elf_file
) != ELF_K_ELF
) {
189 BT_COMP_LOGE_APPEND_CAUSE(bin
->self_comp
,
190 "Error: %s is not an ELF object", bin
->elf_path
);
199 bt_fd_cache_put_handle(bin
->fd_cache
, elf_handle
);
208 * From a note section data struct, check if it is a build id note.
210 * @param note_data Pointer to a note section
212 * @returns 1 on match, 0 if `buf` does not contain a
213 * valid build id note
216 int is_build_id_note_section(Elf_Data
*note_data
)
218 size_t name_offset
, desc_offset
;
219 GElf_Nhdr note_header
;
223 * Discard the return value as it contains the size of the note section
224 * and we don't need it.
226 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
230 * Check the note name length. The name_sz field includes the
231 * terminating null byte.
233 if (note_header
.n_namesz
!= sizeof(BUILD_ID_NOTE_NAME
)) {
237 /* Check the note type. */
238 if (note_header
.n_type
!= NT_GNU_BUILD_ID
) {
242 /* Check the note name. */
243 if (memcmp(note_data
->d_buf
+ name_offset
, BUILD_ID_NOTE_NAME
,
244 note_header
.n_namesz
) != 0) {
255 * From a build id note section data struct, check if the build id it contains
256 * is identical to the build id passed as parameter.
258 * @param note_data Pointer to the file build id note section.
259 * @param build_id Pointer to a build id to compare to.
260 * @param build_id_len length of the build id.
262 * @returns 1 on match, 0 otherwise.
265 int is_build_id_note_section_matching(Elf_Data
*note_data
,
266 uint8_t *build_id
, size_t build_id_len
)
268 size_t name_offset
, desc_offset
;
269 GElf_Nhdr note_header
;
271 if (build_id_len
<= 0) {
276 * Discard the return value as it contains the size of the note section
277 * and we don't need it.
279 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
283 * Compare the binary build id with the supplied build id.
285 if (memcmp(build_id
, note_data
->d_buf
+ desc_offset
,
286 build_id_len
) == 0) {
294 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
295 * id of the ondisk file (bin->elf_file).
297 * @param bin bin_info instance
298 * @param build_id build id to compare ot the on disk file
299 * @param build_id_len length of the build id
301 * @returns 1 on if the build id of stored in `bin` matches
302 * the build id of the ondisk file.
303 * 0 on if they are different or an error occured.
306 int is_build_id_matching(struct bin_info
*bin
)
308 int ret
, is_build_id
, is_matching
= 0;
309 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
310 GElf_Shdr curr_section_hdr
;
312 if (!bin
->build_id
) {
316 /* Set ELF file if it hasn't been accessed yet. */
317 if (!bin
->elf_file
) {
318 ret
= bin_info_set_elf_file(bin
);
320 /* Failed to set ELF file. */
325 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
330 while (next_section
) {
331 Elf_Data
*note_data
= NULL
;
333 curr_section
= next_section
;
334 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
336 if (!gelf_getshdr(curr_section
, &curr_section_hdr
)) {
340 if (curr_section_hdr
.sh_type
!= SHT_NOTE
) {
345 * elf_getdata() translates the data to native byte order.
347 note_data
= elf_getdata(curr_section
, NULL
);
352 /* Check if the note is of the build-id type. */
353 is_build_id
= is_build_id_note_section(note_data
);
359 * Compare the build id of the on-disk file and
360 * the build id recorded in the trace.
362 is_matching
= is_build_id_note_section_matching(
363 note_data
, bin
->build_id
, bin
->build_id_len
);
373 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
376 if (!bin
|| !build_id
) {
380 /* Set the build id. */
381 bin
->build_id
= g_new0(uint8_t, build_id_len
);
382 if (!bin
->build_id
) {
386 memcpy(bin
->build_id
, build_id
, build_id_len
);
387 bin
->build_id_len
= build_id_len
;
390 * Check if the file found on the file system has the same build id
391 * that what was recorded in the trace.
393 bin
->file_build_id_matches
= is_build_id_matching(bin
);
394 if (!bin
->file_build_id_matches
) {
395 BT_COMP_LOGI_STR("Supplied Build ID does not match Build ID of the "
396 "binary or library found on the file system.");
401 * Reset the is_elf_only flag in case it had been set
402 * previously, because we might find separate debug info using
403 * the new build id information.
405 bin
->is_elf_only
= false;
414 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
417 if (!bin
|| !filename
) {
421 bin
->dbg_link_filename
= g_strdup(filename
);
422 if (!bin
->dbg_link_filename
) {
426 bin
->dbg_link_crc
= crc
;
429 * Reset the is_elf_only flag in case it had been set
430 * previously, because we might find separate debug info using
431 * the new build id information.
433 bin
->is_elf_only
= false;
443 * Tries to read DWARF info from the location given by path, and
444 * attach it to the given bin_info instance if it exists.
446 * @param bin bin_info instance for which to set DWARF info
447 * @param path Presumed location of the DWARF info
448 * @returns 0 on success, negative value on failure
451 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
454 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
455 struct bt_dwarf_cu
*cu
= NULL
;
456 Dwarf
*dwarf_info
= NULL
;
462 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
467 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
474 * Check if the dwarf info has any CU. If not, the
475 * executable's object file contains no DWARF info.
477 cu
= bt_dwarf_cu_create(dwarf_info
);
482 ret
= bt_dwarf_cu_next(cu
);
487 bin
->dwarf_handle
= dwarf_handle
;
488 bin
->dwarf_path
= g_strdup(path
);
489 if (!bin
->dwarf_path
) {
492 bin
->dwarf_info
= dwarf_info
;
499 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
501 dwarf_end(dwarf_info
);
509 * Try to set the dwarf_info for a given bin_info instance via the
512 * @param bin bin_info instance for which to retrieve the
513 * DWARF info via build ID
514 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
517 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
520 char *path
= NULL
, *build_id_prefix_dir
= NULL
, *build_id_file
= NULL
;
521 const char *dbg_dir
= NULL
;
522 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
524 if (!bin
|| !bin
->build_id
) {
528 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
531 * The prefix dir is the first byte of the build id, represented in
532 * lowercase hex as two characters per byte, +1 for '\0'.
534 build_id_prefix_dir
= g_new0(gchar
, BUILD_ID_PREFIX_DIR_LEN
+ 1);
535 if (!build_id_prefix_dir
) {
538 g_snprintf(build_id_prefix_dir
, BUILD_ID_PREFIX_DIR_LEN
+ 1, "%02x", bin
->build_id
[0]);
541 * The build id file is the remaining bytes of the build id,
542 * represented in lowercase hex, as two characters per byte.
544 build_id_char_len
= (2 * (bin
->build_id_len
- 1));
546 /* To which the build id suffix is added, +1 for '\0'. */
547 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
550 * The resulting filename string is the concatenation of the
551 * hex build id and the suffix.
553 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
554 build_id_file
= g_new0(gchar
, build_id_file_len
);
555 if (!build_id_file
) {
560 * For each byte, starting at offset 1, append two characters
563 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
564 int path_idx
= 2 * (i
- 1);
566 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
568 /* Append the suffix to the generated string, including the '\0'. */
569 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
572 path
= g_build_filename(dbg_dir
, BUILD_ID_SUBDIR
, build_id_prefix_dir
, build_id_file
, NULL
);
577 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
587 g_free(build_id_prefix_dir
);
588 g_free(build_id_file
);
595 * Tests whether the file located at path exists and has the expected
598 * This predicate is used when looking up separate debug info via the
599 * GNU debuglink method. The expected crc can be found .gnu_debuglink
600 * section in the original ELF file, along with the filename for the
601 * file containing the debug info.
603 * @param path Full path at which to look for the debug file
604 * @param crc Expected checksum for the debug file
605 * @returns 1 if the file exists and has the correct checksum,
609 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
612 struct bt_fd_cache_handle
*debug_handle
= NULL
;
619 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
624 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
633 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
638 * Try to set the dwarf_info for a given bin_info instance via the
641 * @param bin bin_info instance for which to retrieve the
642 * DWARF info via debug link
643 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
646 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
649 const gchar
*dbg_dir
= NULL
;
650 gchar
*bin_dir
= NULL
, *path
= NULL
;
652 if (!bin
|| !bin
->dbg_link_filename
) {
656 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
657 bin_dir
= g_path_get_dirname(bin
->elf_path
);
659 /* First look in the executable's dir */
660 path
= g_build_filename(bin_dir
, bin
->dbg_link_filename
, NULL
);
662 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
666 /* If not found, look in .debug subdir */
668 path
= g_build_filename(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
670 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
674 /* Lastly, look under the global debug directory */
677 path
= g_build_filename(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
678 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
691 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
700 * Initialize the DWARF info for a given executable.
702 * @param bin bin_info instance
703 * @returns 0 on success, negative value on failure
706 int bin_info_set_dwarf_info(struct bin_info
*bin
)
715 /* First try to set the DWARF info from the ELF file */
716 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
722 * If that fails, try to find separate debug info via build ID
725 ret
= bin_info_set_dwarf_info_build_id(bin
);
730 ret
= bin_info_set_dwarf_info_debug_link(bin
);
740 void source_location_destroy(struct source_location
*src_loc
)
746 free(src_loc
->filename
);
751 * Append a string representation of an address offset to an existing
754 * On success, the out parameter `result` will contain the base string
755 * followed by the offset string of the form "+0x1234". On failure,
756 * `result` remains unchanged.
758 * @param base_str The string to which to append an offset string
759 * @param low_addr The lower virtual memory address, the base from
760 * which the offset is computed
761 * @param high_addr The higher virtual memory address
762 * @param result Out parameter, the base string followed by the
764 * @returns 0 on success, -1 on failure
767 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
768 uint64_t high_addr
, char **result
)
771 char *_result
= NULL
;
773 if (!base_str
|| !result
) {
777 offset
= high_addr
- low_addr
;
779 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
793 * Try to find the symbol closest to an address within a given ELF
796 * Only function symbols are taken into account. The symbol's address
797 * must precede `addr`. A symbol with a closer address might exist
798 * after `addr` but is irrelevant because it cannot encompass `addr`.
800 * On success, if found, the out parameters `sym` and `shdr` are
801 * set. On failure or if none are found, they remain unchanged.
803 * @param scn ELF section in which to look for the address
804 * @param addr Virtual memory address for which to find the
805 * nearest function symbol
806 * @param sym Out parameter, the nearest function symbol
807 * @param shdr Out parameter, the section header for scn
808 * @returns 0 on success, -1 on failure
811 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
812 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
816 Elf_Data
*data
= NULL
;
817 GElf_Shdr
*_shdr
= NULL
;
818 GElf_Sym
*nearest_sym
= NULL
;
820 if (!scn
|| !sym
|| !shdr
) {
824 _shdr
= g_new0(GElf_Shdr
, 1);
829 _shdr
= gelf_getshdr(scn
, _shdr
);
834 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
836 * We are only interested in symbol table (symtab)
837 * sections, skip this one.
842 data
= elf_getdata(scn
, NULL
);
847 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
849 for (i
= 0; i
< symbol_count
; ++i
) {
850 GElf_Sym
*cur_sym
= NULL
;
852 cur_sym
= g_new0(GElf_Sym
, 1);
856 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
860 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
861 /* We're only interested in the functions. */
866 if (cur_sym
->st_value
<= addr
&&
868 cur_sym
->st_value
> nearest_sym
->st_value
)) {
870 nearest_sym
= cur_sym
;
893 * Get the name of the function containing a given address within an
894 * executable using ELF symbols.
896 * The function name is in fact the name of the nearest ELF symbol,
897 * followed by the offset in bytes between the address and the symbol
898 * (in hex), separated by a '+' character.
900 * If found, the out parameter `func_name` is set on success. On failure,
901 * it remains unchanged.
903 * @param bin bin_info instance for the executable containing
905 * @param addr Virtual memory address for which to find the
907 * @param func_name Out parameter, the function name
908 * @returns 0 on success, -1 on failure
911 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
915 * TODO (possible optimisation): if an ELF has no symtab
916 * section, it has been stripped. Therefore, it would be wise
917 * to store a flag indicating the stripped status after the
918 * first iteration to prevent subsequent ones.
922 GElf_Sym
*sym
= NULL
;
923 GElf_Shdr
*shdr
= NULL
;
924 char *sym_name
= NULL
;
926 /* Set ELF file if it hasn't been accessed yet. */
927 if (!bin
->elf_file
) {
928 ret
= bin_info_set_elf_file(bin
);
930 /* Failed to set ELF file. */
935 scn
= elf_nextscn(bin
->elf_file
, scn
);
940 while (scn
&& !sym
) {
941 ret
= bin_info_get_nearest_symbol_from_section(
942 scn
, addr
, &sym
, &shdr
);
947 scn
= elf_nextscn(bin
->elf_file
, scn
);
951 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
957 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
975 * Get the name of the function containing a given address within a
976 * given compile unit (CU).
978 * If found, the out parameter `func_name` is set on success. On
979 * failure, it remains unchanged.
981 * @param cu bt_dwarf_cu instance which may contain the address
982 * @param addr Virtual memory address for which to find the
984 * @param func_name Out parameter, the function name
985 * @returns 0 on success, -1 on failure
988 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
993 struct bt_dwarf_die
*die
= NULL
;
995 if (!cu
|| !func_name
) {
999 die
= bt_dwarf_die_create(cu
);
1004 while (bt_dwarf_die_next(die
) == 0) {
1007 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1012 if (tag
== DW_TAG_subprogram
) {
1013 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1025 uint64_t low_addr
= 0;
1026 char *die_name
= NULL
;
1028 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1033 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1039 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1047 bt_dwarf_die_destroy(die
);
1051 bt_dwarf_die_destroy(die
);
1056 * Get the name of the function containing a given address within an
1057 * executable using DWARF debug info.
1059 * If found, the out parameter `func_name` is set on success. On
1060 * failure, it remains unchanged.
1062 * @param bin bin_info instance for the executable containing
1064 * @param addr Virtual memory address for which to find the
1066 * @param func_name Out parameter, the function name
1067 * @returns 0 on success, -1 on failure
1070 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1074 char *_func_name
= NULL
;
1075 struct bt_dwarf_cu
*cu
= NULL
;
1077 if (!bin
|| !func_name
) {
1081 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1086 while (bt_dwarf_cu_next(cu
) == 0) {
1087 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1098 *func_name
= _func_name
;
1103 bt_dwarf_cu_destroy(cu
);
1107 bt_dwarf_cu_destroy(cu
);
1112 int bin_info_lookup_function_name(struct bin_info
*bin
,
1113 uint64_t addr
, char **func_name
)
1116 char *_func_name
= NULL
;
1118 if (!bin
|| !func_name
) {
1123 * If the bin_info has a build id but it does not match the build id
1124 * that was found on the file system, return an error.
1126 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1130 /* Set DWARF info if it hasn't been accessed yet. */
1131 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1132 ret
= bin_info_set_dwarf_info(bin
);
1134 BT_COMP_LOGI_STR("Failed to set bin dwarf info, falling "
1135 "back to ELF lookup.");
1136 /* Failed to set DWARF info, fallback to ELF. */
1137 bin
->is_elf_only
= true;
1141 if (!bin_info_has_address(bin
, addr
)) {
1146 * Addresses in ELF and DWARF are relative to base address for
1147 * PIC, so make the address argument relative too if needed.
1150 addr
-= bin
->low_addr
;
1153 if (bin
->is_elf_only
) {
1154 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1157 BT_COMP_LOGI("Failed to lookup function name (ELF): "
1161 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1164 BT_COMP_LOGI("Failed to lookup function name (DWARF): "
1169 *func_name
= _func_name
;
1177 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1179 gchar
*_bin_loc
= NULL
;
1181 if (!bin
|| !bin_loc
) {
1186 * If the bin_info has a build id but it does not match the build id
1187 * that was found on the file system, return an error.
1189 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1194 addr
-= bin
->low_addr
;
1195 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1197 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1204 *bin_loc
= _bin_loc
;
1212 * Predicate used to determine whether the children of a given DIE
1213 * contain a specific address.
1215 * More specifically, the parameter `die` is expected to be a
1216 * subprogram (function) DIE, and this predicate tells whether any
1217 * subroutines are inlined within this function and would contain
1220 * On success, the out parameter `contains` is set with the boolean
1221 * value indicating whether the DIE's range covers `addr`. On failure,
1222 * it remains unchanged.
1224 * Do note that this function advances the position of `die`. If the
1225 * address is found within one of its children, `die` will be pointing
1226 * to that child upon returning from the function, allowing to extract
1227 * the information deemed necessary.
1229 * @param die The parent DIE in whose children the address will be
1231 * @param addr The address for which to look for in the DIEs
1232 * @param contains Out parameter, true if addr is contained,
1234 * @returns Returns 0 on success, -1 on failure
1237 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1240 bool _contains
= false;
1246 ret
= bt_dwarf_die_child(die
);
1252 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1259 * The address is within the range of the current DIE
1264 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1269 if (tag
== DW_TAG_inlined_subroutine
) {
1270 /* Found the tracepoint. */
1274 if (bt_dwarf_die_has_children(die
)) {
1276 * Look for the address in the children DIEs.
1278 ret
= bt_dwarf_die_child(die
);
1284 } while (bt_dwarf_die_next(die
) == 0);
1287 *contains
= _contains
;
1295 * Lookup the source location for a given address within a CU, making
1296 * the assumption that it is contained within an inline routine in a
1299 * @param cu bt_dwarf_cu instance in which to look for the address
1300 * @param addr The address for which to look for
1301 * @param src_loc Out parameter, the source location (filename and
1302 * line number) for the address
1303 * @returns 0 on success, -1 on failure
1306 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1307 struct source_location
**src_loc
)
1311 struct bt_dwarf_die
*die
= NULL
;
1312 struct source_location
*_src_loc
= NULL
;
1314 if (!cu
|| !src_loc
) {
1318 die
= bt_dwarf_die_create(cu
);
1323 while (bt_dwarf_die_next(die
) == 0) {
1326 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1331 if (tag
== DW_TAG_subprogram
) {
1332 bool contains
= false;
1334 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1341 * Try to find an inlined subroutine
1342 * child of this DIE containing addr.
1344 ret
= bin_info_child_die_has_address(die
, addr
,
1357 char *filename
= NULL
;
1360 _src_loc
= g_new0(struct source_location
, 1);
1365 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1369 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1375 _src_loc
->filename
= filename
;
1376 _src_loc
->line_no
= line_no
;
1377 *src_loc
= _src_loc
;
1380 bt_dwarf_die_destroy(die
);
1384 source_location_destroy(_src_loc
);
1385 bt_dwarf_die_destroy(die
);
1390 * Lookup the source location for a given address within a CU,
1391 * assuming that it is contained within an inlined function.
1393 * A source location can be found regardless of inlining status for
1394 * this method, but in the case of an inlined function, the returned
1395 * source location will point not to the callsite but rather to the
1396 * definition site of the inline function.
1398 * @param cu bt_dwarf_cu instance in which to look for the address
1399 * @param addr The address for which to look for
1400 * @param src_loc Out parameter, the source location (filename and
1401 * line number) for the address. Set only if the address
1402 * is found and resolved successfully
1404 * @returns 0 on success, -1 on failure
1407 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1408 struct source_location
**src_loc
)
1410 struct source_location
*_src_loc
= NULL
;
1411 struct bt_dwarf_die
*die
= NULL
;
1412 const char *filename
= NULL
;
1413 Dwarf_Line
*line
= NULL
;
1414 Dwarf_Addr line_addr
;
1415 int ret
= 0, line_no
;
1417 if (!cu
|| !src_loc
) {
1421 die
= bt_dwarf_die_create(cu
);
1426 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1428 /* This is not an error. The caller needs to keep looking. */
1432 ret
= dwarf_lineaddr(line
, &line_addr
);
1437 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1442 if (addr
== line_addr
) {
1443 _src_loc
= g_new0(struct source_location
, 1);
1448 ret
= dwarf_lineno(line
, &line_no
);
1453 _src_loc
->line_no
= line_no
;
1454 _src_loc
->filename
= g_strdup(filename
);
1458 *src_loc
= _src_loc
;
1464 source_location_destroy(_src_loc
);
1467 bt_dwarf_die_destroy(die
);
1472 * Get the source location (file name and line number) for a given
1473 * address within a compile unit (CU).
1475 * On success, the out parameter `src_loc` is set if found. On
1476 * failure, it remains unchanged.
1478 * @param cu bt_dwarf_cu instance for the compile unit which
1479 * may contain the address
1480 * @param addr Virtual memory address for which to find the
1482 * @param src_loc Out parameter, the source location
1483 * @returns 0 on success, -1 on failure
1486 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1487 struct source_location
**src_loc
)
1490 struct source_location
*_src_loc
= NULL
;
1492 if (!cu
|| !src_loc
) {
1496 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1505 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1516 *src_loc
= _src_loc
;
1522 source_location_destroy(_src_loc
);
1527 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1528 struct source_location
**src_loc
)
1530 struct bt_dwarf_cu
*cu
= NULL
;
1531 struct source_location
*_src_loc
= NULL
;
1533 if (!bin
|| !src_loc
) {
1538 * If the bin_info has a build id but it does not match the build id
1539 * that was found on the file system, return an error.
1541 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1545 /* Set DWARF info if it hasn't been accessed yet. */
1546 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1547 if (bin_info_set_dwarf_info(bin
)) {
1548 /* Failed to set DWARF info. */
1549 bin
->is_elf_only
= true;
1553 if (bin
->is_elf_only
) {
1554 /* We cannot lookup source location without DWARF info. */
1558 if (!bin_info_has_address(bin
, addr
)) {
1563 * Addresses in ELF and DWARF are relative to base address for
1564 * PIC, so make the address argument relative too if needed.
1567 addr
-= bin
->low_addr
;
1570 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1575 while (bt_dwarf_cu_next(cu
) == 0) {
1578 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1588 bt_dwarf_cu_destroy(cu
);
1590 *src_loc
= _src_loc
;
1596 source_location_destroy(_src_loc
);
1597 bt_dwarf_cu_destroy(cu
);