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 "plugins/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
;
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("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("Error: %s is not an ELF object", bin
->elf_path
);
195 bt_fd_cache_put_handle(bin
->fd_cache
, elf_handle
);
201 * From a note section data struct, check if it is a build id note.
203 * @param note_data Pointer to a note section
205 * @returns 1 on match, 0 if `buf` does not contain a
206 * valid build id note
209 int is_build_id_note_section(Elf_Data
*note_data
)
211 size_t name_offset
, desc_offset
;
212 GElf_Nhdr note_header
;
216 * Discard the return value as it contains the size of the note section
217 * and we don't need it.
219 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
223 * Check the note name length. The name_sz field includes the
224 * terminating null byte.
226 if (note_header
.n_namesz
!= sizeof(BUILD_ID_NOTE_NAME
)) {
230 /* Check the note type. */
231 if (note_header
.n_type
!= NT_GNU_BUILD_ID
) {
235 /* Check the note name. */
236 if (memcmp(note_data
->d_buf
+ name_offset
, BUILD_ID_NOTE_NAME
,
237 note_header
.n_namesz
) != 0) {
248 * From a build id note section data struct, check if the build id it contains
249 * is identical to the build id passed as parameter.
251 * @param note_data Pointer to the file build id note section.
252 * @param build_id Pointer to a build id to compare to.
253 * @param build_id_len length of the build id.
255 * @returns 1 on match, 0 otherwise.
258 int is_build_id_note_section_matching(Elf_Data
*note_data
,
259 uint8_t *build_id
, size_t build_id_len
)
261 size_t name_offset
, desc_offset
;
262 GElf_Nhdr note_header
;
264 if (build_id_len
<= 0) {
269 * Discard the return value as it contains the size of the note section
270 * and we don't need it.
272 (void) gelf_getnote(note_data
, 0, ¬e_header
, &name_offset
,
276 * Compare the binary build id with the supplied build id.
278 if (memcmp(build_id
, note_data
->d_buf
+ desc_offset
,
279 build_id_len
) == 0) {
287 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
288 * id of the ondisk file (bin->elf_file).
290 * @param bin bin_info instance
291 * @param build_id build id to compare ot the on disk file
292 * @param build_id_len length of the build id
294 * @returns 1 on if the build id of stored in `bin` matches
295 * the build id of the ondisk file.
296 * 0 on if they are different or an error occured.
299 int is_build_id_matching(struct bin_info
*bin
)
301 int ret
, is_build_id
, is_matching
= 0;
302 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
303 GElf_Shdr curr_section_hdr
;
305 if (!bin
->build_id
) {
309 /* Set ELF file if it hasn't been accessed yet. */
310 if (!bin
->elf_file
) {
311 ret
= bin_info_set_elf_file(bin
);
313 /* Failed to set ELF file. */
318 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
323 while (next_section
) {
324 Elf_Data
*note_data
= NULL
;
326 curr_section
= next_section
;
327 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
329 if (!gelf_getshdr(curr_section
, &curr_section_hdr
)) {
333 if (curr_section_hdr
.sh_type
!= SHT_NOTE
) {
338 * elf_getdata() translates the data to native byte order.
340 note_data
= elf_getdata(curr_section
, NULL
);
345 /* Check if the note is of the build-id type. */
346 is_build_id
= is_build_id_note_section(note_data
);
352 * Compare the build id of the on-disk file and
353 * the build id recorded in the trace.
355 is_matching
= is_build_id_note_section_matching(
356 note_data
, bin
->build_id
, bin
->build_id_len
);
366 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
369 if (!bin
|| !build_id
) {
373 /* Set the build id. */
374 bin
->build_id
= g_new0(uint8_t, build_id_len
);
375 if (!bin
->build_id
) {
379 memcpy(bin
->build_id
, build_id
, build_id_len
);
380 bin
->build_id_len
= build_id_len
;
383 * Check if the file found on the file system has the same build id
384 * that what was recorded in the trace.
386 bin
->file_build_id_matches
= is_build_id_matching(bin
);
387 if (!bin
->file_build_id_matches
) {
388 BT_COMP_LOGI_STR("Supplied Build ID does not match Build ID of the "
389 "binary or library found on the file system.");
394 * Reset the is_elf_only flag in case it had been set
395 * previously, because we might find separate debug info using
396 * the new build id information.
398 bin
->is_elf_only
= false;
407 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
410 if (!bin
|| !filename
) {
414 bin
->dbg_link_filename
= g_strdup(filename
);
415 if (!bin
->dbg_link_filename
) {
419 bin
->dbg_link_crc
= crc
;
422 * Reset the is_elf_only flag in case it had been set
423 * previously, because we might find separate debug info using
424 * the new build id information.
426 bin
->is_elf_only
= false;
436 * Tries to read DWARF info from the location given by path, and
437 * attach it to the given bin_info instance if it exists.
439 * @param bin bin_info instance for which to set DWARF info
440 * @param path Presumed location of the DWARF info
441 * @returns 0 on success, negative value on failure
444 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
447 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
448 struct bt_dwarf_cu
*cu
= NULL
;
449 Dwarf
*dwarf_info
= NULL
;
455 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
460 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
467 * Check if the dwarf info has any CU. If not, the
468 * executable's object file contains no DWARF info.
470 cu
= bt_dwarf_cu_create(dwarf_info
);
475 ret
= bt_dwarf_cu_next(cu
);
480 bin
->dwarf_handle
= dwarf_handle
;
481 bin
->dwarf_path
= g_strdup(path
);
482 if (!bin
->dwarf_path
) {
485 bin
->dwarf_info
= dwarf_info
;
491 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
492 dwarf_end(dwarf_info
);
500 * Try to set the dwarf_info for a given bin_info instance via the
503 * @param bin bin_info instance for which to retrieve the
504 * DWARF info via build ID
505 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
508 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
511 char *path
= NULL
, *build_id_prefix_dir
= NULL
, *build_id_file
= NULL
;
512 const char *dbg_dir
= NULL
;
513 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
515 if (!bin
|| !bin
->build_id
) {
519 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
522 * The prefix dir is the first byte of the build id, represented in
523 * lowercase hex as two characters per byte, +1 for '\0'.
525 build_id_prefix_dir
= g_new0(gchar
, BUILD_ID_PREFIX_DIR_LEN
+ 1);
526 if (!build_id_prefix_dir
) {
529 g_snprintf(build_id_prefix_dir
, BUILD_ID_PREFIX_DIR_LEN
+ 1, "%02x", bin
->build_id
[0]);
532 * The build id file is the remaining bytes of the build id,
533 * represented in lowercase hex, as two characters per byte.
535 build_id_char_len
= (2 * (bin
->build_id_len
- 1));
537 /* To which the build id suffix is added, +1 for '\0'. */
538 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
541 * The resulting filename string is the concatenation of the
542 * hex build id and the suffix.
544 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
545 build_id_file
= g_new0(gchar
, build_id_file_len
);
546 if (!build_id_file
) {
551 * For each byte, starting at offset 1, append two characters
554 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
555 int path_idx
= 2 * (i
- 1);
557 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
559 /* Append the suffix to the generated string, including the '\0'. */
560 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
563 path
= g_build_filename(dbg_dir
, BUILD_ID_SUBDIR
, build_id_prefix_dir
, build_id_file
, NULL
);
568 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
578 g_free(build_id_prefix_dir
);
579 g_free(build_id_file
);
586 * Tests whether the file located at path exists and has the expected
589 * This predicate is used when looking up separate debug info via the
590 * GNU debuglink method. The expected crc can be found .gnu_debuglink
591 * section in the original ELF file, along with the filename for the
592 * file containing the debug info.
594 * @param path Full path at which to look for the debug file
595 * @param crc Expected checksum for the debug file
596 * @returns 1 if the file exists and has the correct checksum,
600 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
603 struct bt_fd_cache_handle
*debug_handle
= NULL
;
610 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
615 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
624 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
629 * Try to set the dwarf_info for a given bin_info instance via the
632 * @param bin bin_info instance for which to retrieve the
633 * DWARF info via debug link
634 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
637 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
640 const gchar
*dbg_dir
= NULL
;
641 gchar
*bin_dir
= NULL
, *path
= NULL
;
643 if (!bin
|| !bin
->dbg_link_filename
) {
647 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
648 bin_dir
= g_path_get_dirname(bin
->elf_path
);
650 /* First look in the executable's dir */
651 path
= g_build_filename(bin_dir
, bin
->dbg_link_filename
, NULL
);
653 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
657 /* If not found, look in .debug subdir */
659 path
= g_build_filename(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
661 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
665 /* Lastly, look under the global debug directory */
668 path
= g_build_filename(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
669 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
682 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
691 * Initialize the DWARF info for a given executable.
693 * @param bin bin_info instance
694 * @returns 0 on success, negative value on failure
697 int bin_info_set_dwarf_info(struct bin_info
*bin
)
706 /* First try to set the DWARF info from the ELF file */
707 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
713 * If that fails, try to find separate debug info via build ID
716 ret
= bin_info_set_dwarf_info_build_id(bin
);
721 ret
= bin_info_set_dwarf_info_debug_link(bin
);
731 void source_location_destroy(struct source_location
*src_loc
)
737 free(src_loc
->filename
);
742 * Append a string representation of an address offset to an existing
745 * On success, the out parameter `result` will contain the base string
746 * followed by the offset string of the form "+0x1234". On failure,
747 * `result` remains unchanged.
749 * @param base_str The string to which to append an offset string
750 * @param low_addr The lower virtual memory address, the base from
751 * which the offset is computed
752 * @param high_addr The higher virtual memory address
753 * @param result Out parameter, the base string followed by the
755 * @returns 0 on success, -1 on failure
758 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
759 uint64_t high_addr
, char **result
)
762 char *_result
= NULL
;
764 if (!base_str
|| !result
) {
768 offset
= high_addr
- low_addr
;
770 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
784 * Try to find the symbol closest to an address within a given ELF
787 * Only function symbols are taken into account. The symbol's address
788 * must precede `addr`. A symbol with a closer address might exist
789 * after `addr` but is irrelevant because it cannot encompass `addr`.
791 * On success, if found, the out parameters `sym` and `shdr` are
792 * set. On failure or if none are found, they remain unchanged.
794 * @param scn ELF section in which to look for the address
795 * @param addr Virtual memory address for which to find the
796 * nearest function symbol
797 * @param sym Out parameter, the nearest function symbol
798 * @param shdr Out parameter, the section header for scn
799 * @returns 0 on success, -1 on failure
802 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
803 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
807 Elf_Data
*data
= NULL
;
808 GElf_Shdr
*_shdr
= NULL
;
809 GElf_Sym
*nearest_sym
= NULL
;
811 if (!scn
|| !sym
|| !shdr
) {
815 _shdr
= g_new0(GElf_Shdr
, 1);
820 _shdr
= gelf_getshdr(scn
, _shdr
);
825 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
827 * We are only interested in symbol table (symtab)
828 * sections, skip this one.
833 data
= elf_getdata(scn
, NULL
);
838 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
840 for (i
= 0; i
< symbol_count
; ++i
) {
841 GElf_Sym
*cur_sym
= NULL
;
843 cur_sym
= g_new0(GElf_Sym
, 1);
847 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
851 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
852 /* We're only interested in the functions. */
857 if (cur_sym
->st_value
<= addr
&&
859 cur_sym
->st_value
> nearest_sym
->st_value
)) {
861 nearest_sym
= cur_sym
;
884 * Get the name of the function containing a given address within an
885 * executable using ELF symbols.
887 * The function name is in fact the name of the nearest ELF symbol,
888 * followed by the offset in bytes between the address and the symbol
889 * (in hex), separated by a '+' character.
891 * If found, the out parameter `func_name` is set on success. On failure,
892 * it remains unchanged.
894 * @param bin bin_info instance for the executable containing
896 * @param addr Virtual memory address for which to find the
898 * @param func_name Out parameter, the function name
899 * @returns 0 on success, -1 on failure
902 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
906 * TODO (possible optimisation): if an ELF has no symtab
907 * section, it has been stripped. Therefore, it would be wise
908 * to store a flag indicating the stripped status after the
909 * first iteration to prevent subsequent ones.
913 GElf_Sym
*sym
= NULL
;
914 GElf_Shdr
*shdr
= NULL
;
915 char *sym_name
= NULL
;
917 /* Set ELF file if it hasn't been accessed yet. */
918 if (!bin
->elf_file
) {
919 ret
= bin_info_set_elf_file(bin
);
921 /* Failed to set ELF file. */
926 scn
= elf_nextscn(bin
->elf_file
, scn
);
931 while (scn
&& !sym
) {
932 ret
= bin_info_get_nearest_symbol_from_section(
933 scn
, addr
, &sym
, &shdr
);
938 scn
= elf_nextscn(bin
->elf_file
, scn
);
942 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
948 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
966 * Get the name of the function containing a given address within a
967 * given compile unit (CU).
969 * If found, the out parameter `func_name` is set on success. On
970 * failure, it remains unchanged.
972 * @param cu bt_dwarf_cu instance which may contain the address
973 * @param addr Virtual memory address for which to find the
975 * @param func_name Out parameter, the function name
976 * @returns 0 on success, -1 on failure
979 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
984 struct bt_dwarf_die
*die
= NULL
;
986 if (!cu
|| !func_name
) {
990 die
= bt_dwarf_die_create(cu
);
995 while (bt_dwarf_die_next(die
) == 0) {
998 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1003 if (tag
== DW_TAG_subprogram
) {
1004 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1016 uint64_t low_addr
= 0;
1017 char *die_name
= NULL
;
1019 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1024 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1030 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1038 bt_dwarf_die_destroy(die
);
1042 bt_dwarf_die_destroy(die
);
1047 * Get the name of the function containing a given address within an
1048 * executable using DWARF debug info.
1050 * If found, the out parameter `func_name` is set on success. On
1051 * failure, it remains unchanged.
1053 * @param bin bin_info instance for the executable containing
1055 * @param addr Virtual memory address for which to find the
1057 * @param func_name Out parameter, the function name
1058 * @returns 0 on success, -1 on failure
1061 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1065 char *_func_name
= NULL
;
1066 struct bt_dwarf_cu
*cu
= NULL
;
1068 if (!bin
|| !func_name
) {
1072 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1077 while (bt_dwarf_cu_next(cu
) == 0) {
1078 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1089 *func_name
= _func_name
;
1094 bt_dwarf_cu_destroy(cu
);
1098 bt_dwarf_cu_destroy(cu
);
1103 int bin_info_lookup_function_name(struct bin_info
*bin
,
1104 uint64_t addr
, char **func_name
)
1107 char *_func_name
= NULL
;
1109 if (!bin
|| !func_name
) {
1114 * If the bin_info has a build id but it does not match the build id
1115 * that was found on the file system, return an error.
1117 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1121 /* Set DWARF info if it hasn't been accessed yet. */
1122 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1123 ret
= bin_info_set_dwarf_info(bin
);
1125 BT_COMP_LOGI_STR("Failed to set bin dwarf info, falling "
1126 "back to ELF lookup.");
1127 /* Failed to set DWARF info, fallback to ELF. */
1128 bin
->is_elf_only
= true;
1132 if (!bin_info_has_address(bin
, addr
)) {
1137 * Addresses in ELF and DWARF are relative to base address for
1138 * PIC, so make the address argument relative too if needed.
1141 addr
-= bin
->low_addr
;
1144 if (bin
->is_elf_only
) {
1145 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1148 BT_COMP_LOGI("Failed to lookup function name (ELF): "
1152 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1155 BT_COMP_LOGI("Failed to lookup function name (DWARF): "
1160 *func_name
= _func_name
;
1168 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1170 gchar
*_bin_loc
= NULL
;
1172 if (!bin
|| !bin_loc
) {
1177 * If the bin_info has a build id but it does not match the build id
1178 * that was found on the file system, return an error.
1180 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1185 addr
-= bin
->low_addr
;
1186 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1188 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1195 *bin_loc
= _bin_loc
;
1203 * Predicate used to determine whether the children of a given DIE
1204 * contain a specific address.
1206 * More specifically, the parameter `die` is expected to be a
1207 * subprogram (function) DIE, and this predicate tells whether any
1208 * subroutines are inlined within this function and would contain
1211 * On success, the out parameter `contains` is set with the boolean
1212 * value indicating whether the DIE's range covers `addr`. On failure,
1213 * it remains unchanged.
1215 * Do note that this function advances the position of `die`. If the
1216 * address is found within one of its children, `die` will be pointing
1217 * to that child upon returning from the function, allowing to extract
1218 * the information deemed necessary.
1220 * @param die The parent DIE in whose children the address will be
1222 * @param addr The address for which to look for in the DIEs
1223 * @param contains Out parameter, true if addr is contained,
1225 * @returns Returns 0 on success, -1 on failure
1228 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1231 bool _contains
= false;
1237 ret
= bt_dwarf_die_child(die
);
1243 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1250 * The address is within the range of the current DIE
1255 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1260 if (tag
== DW_TAG_inlined_subroutine
) {
1261 /* Found the tracepoint. */
1265 if (bt_dwarf_die_has_children(die
)) {
1267 * Look for the address in the children DIEs.
1269 ret
= bt_dwarf_die_child(die
);
1275 } while (bt_dwarf_die_next(die
) == 0);
1278 *contains
= _contains
;
1286 * Lookup the source location for a given address within a CU, making
1287 * the assumption that it is contained within an inline routine in a
1290 * @param cu bt_dwarf_cu instance in which to look for the address
1291 * @param addr The address for which to look for
1292 * @param src_loc Out parameter, the source location (filename and
1293 * line number) for the address
1294 * @returns 0 on success, -1 on failure
1297 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1298 struct source_location
**src_loc
)
1302 struct bt_dwarf_die
*die
= NULL
;
1303 struct source_location
*_src_loc
= NULL
;
1305 if (!cu
|| !src_loc
) {
1309 die
= bt_dwarf_die_create(cu
);
1314 while (bt_dwarf_die_next(die
) == 0) {
1317 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1322 if (tag
== DW_TAG_subprogram
) {
1323 bool contains
= false;
1325 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1332 * Try to find an inlined subroutine
1333 * child of this DIE containing addr.
1335 ret
= bin_info_child_die_has_address(die
, addr
,
1348 char *filename
= NULL
;
1351 _src_loc
= g_new0(struct source_location
, 1);
1356 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1360 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1366 _src_loc
->filename
= filename
;
1367 _src_loc
->line_no
= line_no
;
1368 *src_loc
= _src_loc
;
1371 bt_dwarf_die_destroy(die
);
1375 source_location_destroy(_src_loc
);
1376 bt_dwarf_die_destroy(die
);
1381 * Lookup the source location for a given address within a CU,
1382 * assuming that it is contained within an inlined function.
1384 * A source location can be found regardless of inlining status for
1385 * this method, but in the case of an inlined function, the returned
1386 * source location will point not to the callsite but rather to the
1387 * definition site of the inline function.
1389 * @param cu bt_dwarf_cu instance in which to look for the address
1390 * @param addr The address for which to look for
1391 * @param src_loc Out parameter, the source location (filename and
1392 * line number) for the address. Set only if the address
1393 * is found and resolved successfully
1395 * @returns 0 on success, -1 on failure
1398 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1399 struct source_location
**src_loc
)
1401 struct source_location
*_src_loc
= NULL
;
1402 struct bt_dwarf_die
*die
= NULL
;
1403 const char *filename
= NULL
;
1404 Dwarf_Line
*line
= NULL
;
1405 Dwarf_Addr line_addr
;
1406 int ret
= 0, line_no
;
1408 if (!cu
|| !src_loc
) {
1412 die
= bt_dwarf_die_create(cu
);
1417 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1419 /* This is not an error. The caller needs to keep looking. */
1423 ret
= dwarf_lineaddr(line
, &line_addr
);
1428 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1433 if (addr
== line_addr
) {
1434 _src_loc
= g_new0(struct source_location
, 1);
1439 ret
= dwarf_lineno(line
, &line_no
);
1444 _src_loc
->line_no
= line_no
;
1445 _src_loc
->filename
= g_strdup(filename
);
1449 *src_loc
= _src_loc
;
1455 source_location_destroy(_src_loc
);
1458 bt_dwarf_die_destroy(die
);
1463 * Get the source location (file name and line number) for a given
1464 * address within a compile unit (CU).
1466 * On success, the out parameter `src_loc` is set if found. On
1467 * failure, it remains unchanged.
1469 * @param cu bt_dwarf_cu instance for the compile unit which
1470 * may contain the address
1471 * @param addr Virtual memory address for which to find the
1473 * @param src_loc Out parameter, the source location
1474 * @returns 0 on success, -1 on failure
1477 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1478 struct source_location
**src_loc
)
1481 struct source_location
*_src_loc
= NULL
;
1483 if (!cu
|| !src_loc
) {
1487 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1496 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1507 *src_loc
= _src_loc
;
1513 source_location_destroy(_src_loc
);
1518 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1519 struct source_location
**src_loc
)
1521 struct bt_dwarf_cu
*cu
= NULL
;
1522 struct source_location
*_src_loc
= NULL
;
1524 if (!bin
|| !src_loc
) {
1529 * If the bin_info has a build id but it does not match the build id
1530 * that was found on the file system, return an error.
1532 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1536 /* Set DWARF info if it hasn't been accessed yet. */
1537 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1538 if (bin_info_set_dwarf_info(bin
)) {
1539 /* Failed to set DWARF info. */
1540 bin
->is_elf_only
= true;
1544 if (bin
->is_elf_only
) {
1545 /* We cannot lookup source location without DWARF info. */
1549 if (!bin_info_has_address(bin
, addr
)) {
1554 * Addresses in ELF and DWARF are relative to base address for
1555 * PIC, so make the address argument relative too if needed.
1558 addr
-= bin
->low_addr
;
1561 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1566 while (bt_dwarf_cu_next(cu
) == 0) {
1569 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1579 bt_dwarf_cu_destroy(cu
);
1581 *src_loc
= _src_loc
;
1587 source_location_destroy(_src_loc
);
1588 bt_dwarf_cu_destroy(cu
);