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_LOG_TAG "PLUGIN-CTF-LTTNG-UTILS-DEBUG-INFO-FLT-BIN-INFO"
45 #include <babeltrace/common-internal.h>
53 * An address printed in hex is at most 20 bytes (16 for 64-bits +
54 * leading 0x + optional leading '+' if addr is an offset + null
57 #define ADDR_STR_LEN 20
58 #define BUILD_ID_NOTE_NAME "GNU"
61 int bin_info_init(void)
65 if (elf_version(EV_CURRENT
) == EV_NONE
) {
66 BT_LOGD("ELF library initialization failed: %s.",
75 struct bin_info
*bin_info_create(struct bt_fd_cache
*fdc
, const char *path
,
76 uint64_t low_addr
, uint64_t memsz
, bool is_pic
,
77 const char *debug_info_dir
, const char *target_prefix
)
79 struct bin_info
*bin
= NULL
;
87 bin
= g_new0(struct bin_info
, 1);
93 bin
->elf_path
= g_build_filename(target_prefix
, path
, NULL
);
95 bin
->elf_path
= g_strdup(path
);
102 if (debug_info_dir
) {
103 bin
->debug_info_dir
= g_strdup(debug_info_dir
);
104 if (!bin
->debug_info_dir
) {
109 bin
->is_pic
= is_pic
;
111 bin
->low_addr
= low_addr
;
112 bin
->high_addr
= bin
->low_addr
+ bin
->memsz
;
113 bin
->build_id
= NULL
;
114 bin
->build_id_len
= 0;
115 bin
->file_build_id_matches
= false;
121 bin_info_destroy(bin
);
126 void bin_info_destroy(struct bin_info
*bin
)
132 dwarf_end(bin
->dwarf_info
);
134 g_free(bin
->debug_info_dir
);
135 g_free(bin
->elf_path
);
136 g_free(bin
->dwarf_path
);
137 g_free(bin
->build_id
);
138 g_free(bin
->dbg_link_filename
);
140 elf_end(bin
->elf_file
);
142 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->elf_handle
);
143 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->dwarf_handle
);
149 int bin_info_set_endianness(struct bin_info
*bin
)
152 uint8_t e_ident
[EI_NIDENT
];
154 fd
= bt_fd_cache_handle_get_fd(bin
->elf_handle
);
157 * Read the identification fields of the elf file.
159 if (lseek(fd
, 0, SEEK_SET
) < 0) {
160 BT_LOGE("Error seeking the beginning of ELF file: %s",
166 ret
= bt_common_read(fd
, e_ident
, EI_NIDENT
);
167 if (ret
< EI_NIDENT
) {
168 BT_LOGE_STR("Error reading the ELF identification fields");
174 * Set the endianness.
176 bin
->endianness
= e_ident
[EI_DATA
];
184 * Initialize the ELF file for a given executable.
186 * @param bin bin_info instance
187 * @returns 0 on success, negative value on error.
190 int bin_info_set_elf_file(struct bin_info
*bin
)
192 struct bt_fd_cache_handle
*elf_handle
= NULL
;
193 Elf
*elf_file
= NULL
;
200 elf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, bin
->elf_path
);
202 BT_LOGD("Failed to open %s", bin
->elf_path
);
205 bin
->elf_handle
= elf_handle
;
207 ret
= bin_info_set_endianness(bin
);
212 elf_file
= elf_begin(bt_fd_cache_handle_get_fd(bin
->elf_handle
),
215 BT_LOGE("elf_begin failed: %s", elf_errmsg(-1));
219 bin
->elf_file
= elf_file
;
221 if (elf_kind(elf_file
) != ELF_K_ELF
) {
222 BT_LOGE("Error: %s is not an ELF object", bin
->elf_path
);
229 bt_fd_cache_put_handle(bin
->fd_cache
, elf_handle
);
235 * From a note section data buffer, check if it is a build id note.
237 * @param buf Pointer to a note section
239 * @returns 1 on match, 0 if `buf` does not contain a
240 * valid build id note
243 int is_build_id_note_section(uint8_t *buf
)
246 uint32_t name_sz
, desc_sz
, note_type
;
248 /* The note section header has 3 32bit integer for the following:
249 * - Section name size
253 name_sz
= (uint32_t) *buf
;
256 * Check the note name length. The name_sz field includes the
257 * terminating null byte.
259 if (name_sz
!= sizeof(BUILD_ID_NOTE_NAME
)) {
263 buf
+= sizeof(name_sz
);
265 /* Ignore the note description size. */
266 buf
+= sizeof(desc_sz
);
268 note_type
= (uint32_t) *buf
;
269 buf
+= sizeof(note_type
);
271 /* Check the note type. */
272 if (note_type
!= NT_GNU_BUILD_ID
) {
276 /* Check the note name. */
277 if (memcmp(buf
, BUILD_ID_NOTE_NAME
, name_sz
) != 0) {
288 * From a build id note section data buffer, check if the build id it contains
289 * is identical to the build id passed as parameter.
291 * @param file_build_id_note Pointer to the file build id note section.
292 * @param build_id Pointer to a build id to compare to.
293 * @param build_id_len length of the build id.
295 * @returns 1 on match, 0 otherwise.
298 int is_build_id_note_section_matching(uint8_t *file_build_id_note
,
299 uint8_t *build_id
, size_t build_id_len
)
301 uint32_t name_sz
, desc_sz
, note_type
;
303 if (build_id_len
<= 0) {
307 /* The note section header has 3 32bit integer for the following:
308 * - Section name size
312 name_sz
= (uint32_t) *file_build_id_note
;
313 file_build_id_note
+= sizeof(name_sz
);
314 file_build_id_note
+= sizeof(desc_sz
);
315 file_build_id_note
+= sizeof(note_type
);
318 * Move the pointer pass the name char array. This corresponds to the
319 * beginning of the description section. The description is the build
320 * id in the case of a build id note.
322 file_build_id_note
+= name_sz
;
325 * Compare the binary build id with the supplied build id.
327 if (memcmp(build_id
, file_build_id_note
, build_id_len
) == 0) {
335 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
336 * id of the ondisk file (bin->elf_file).
338 * @param bin bin_info instance
339 * @param build_id build id to compare ot the on disk file
340 * @param build_id_len length of the build id
342 * @returns 1 on if the build id of stored in `bin` matches
343 * the build id of the ondisk file.
344 * 0 on if they are different or an error occured.
347 int is_build_id_matching(struct bin_info
*bin
)
349 int ret
, is_build_id
, is_matching
= 0;
350 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
351 GElf_Shdr curr_section_hdr
;
353 if (!bin
->build_id
) {
357 /* Set ELF file if it hasn't been accessed yet. */
358 if (!bin
->elf_file
) {
359 ret
= bin_info_set_elf_file(bin
);
361 /* Failed to set ELF file. */
366 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
371 while (next_section
) {
372 Elf_Data
*file_note_data
= NULL
;
373 Elf_Data native_note_data
;
375 curr_section
= next_section
;
376 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
378 if (!gelf_getshdr(curr_section
, &curr_section_hdr
)) {
382 if (curr_section_hdr
.sh_type
!= SHT_NOTE
) {
386 file_note_data
= elf_getdata(curr_section
, NULL
);
387 if (!file_note_data
) {
392 * Prepare the destination buffer to receive the natively
393 * ordered note. The `d_buf`, `d_size`, and `d_version` fields
394 * of the destination structure must be set before invoking the
395 * `gelf_xlatetom()` function.
397 native_note_data
.d_buf
= g_new0(uint8_t, file_note_data
->d_size
);
398 BT_ASSERT(native_note_data
.d_buf
);
400 native_note_data
.d_size
= file_note_data
->d_size
;
401 native_note_data
.d_version
= file_note_data
->d_version
;
403 /* Translate the note data buffer to the host endianness. */
404 gelf_xlatetom(bin
->elf_file
, &native_note_data
, file_note_data
,
407 /* Check if the note is of the build-id type. */
408 is_build_id
= is_build_id_note_section(native_note_data
.d_buf
);
410 g_free(native_note_data
.d_buf
);
415 * Compare the build id of the on-disk file and
416 * the build id recorded in the trace.
418 is_matching
= is_build_id_note_section_matching(
419 native_note_data
.d_buf
, bin
->build_id
,
421 g_free(native_note_data
.d_buf
);
431 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
434 if (!bin
|| !build_id
) {
438 /* Set the build id. */
439 bin
->build_id
= g_new0(uint8_t, build_id_len
);
440 if (!bin
->build_id
) {
444 memcpy(bin
->build_id
, build_id
, build_id_len
);
445 bin
->build_id_len
= build_id_len
;
448 * Check if the file found on the file system has the same build id
449 * that what was recorded in the trace.
451 bin
->file_build_id_matches
= is_build_id_matching(bin
);
452 if (!bin
->file_build_id_matches
) {
453 BT_LOGD_STR("Supplied Build ID does not match Build ID of the "
454 "binary or library found on the file system.");
459 * Reset the is_elf_only flag in case it had been set
460 * previously, because we might find separate debug info using
461 * the new build id information.
463 bin
->is_elf_only
= false;
472 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
475 if (!bin
|| !filename
) {
479 bin
->dbg_link_filename
= g_strdup(filename
);
480 if (!bin
->dbg_link_filename
) {
484 bin
->dbg_link_crc
= crc
;
487 * Reset the is_elf_only flag in case it had been set
488 * previously, because we might find separate debug info using
489 * the new build id information.
491 bin
->is_elf_only
= false;
501 * Tries to read DWARF info from the location given by path, and
502 * attach it to the given bin_info instance if it exists.
504 * @param bin bin_info instance for which to set DWARF info
505 * @param path Presumed location of the DWARF info
506 * @returns 0 on success, negative value on failure
509 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
512 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
513 struct bt_dwarf_cu
*cu
= NULL
;
514 Dwarf
*dwarf_info
= NULL
;
520 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
525 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
532 * Check if the dwarf info has any CU. If not, the
533 * executable's object file contains no DWARF info.
535 cu
= bt_dwarf_cu_create(dwarf_info
);
540 ret
= bt_dwarf_cu_next(cu
);
545 bin
->dwarf_handle
= dwarf_handle
;
546 bin
->dwarf_path
= g_strdup(path
);
547 if (!bin
->dwarf_path
) {
550 bin
->dwarf_info
= dwarf_info
;
556 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
557 dwarf_end(dwarf_info
);
565 * Try to set the dwarf_info for a given bin_info instance via the
568 * @param bin bin_info instance for which to retrieve the
569 * DWARF info via build ID
570 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
573 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
576 char *path
= NULL
, *build_id_file
= NULL
;
577 const char *dbg_dir
= NULL
;
578 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
580 if (!bin
|| !bin
->build_id
) {
584 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
586 /* 2 characters per byte printed in hex, +1 for '/' and +1 for '\0' */
587 build_id_char_len
= (2 * bin
->build_id_len
) + 1;
588 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
589 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
590 build_id_file
= g_new0(gchar
, build_id_file_len
);
591 if (!build_id_file
) {
595 g_snprintf(build_id_file
, 4, "%02x/", bin
->build_id
[0]);
596 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
597 int path_idx
= 3 + 2 * (i
- 1);
599 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
601 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
604 path
= g_build_filename(dbg_dir
, BUILD_ID_SUBDIR
, build_id_file
, NULL
);
609 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
626 * Tests whether the file located at path exists and has the expected
629 * This predicate is used when looking up separate debug info via the
630 * GNU debuglink method. The expected crc can be found .gnu_debuglink
631 * section in the original ELF file, along with the filename for the
632 * file containing the debug info.
634 * @param path Full path at which to look for the debug file
635 * @param crc Expected checksum for the debug file
636 * @returns 1 if the file exists and has the correct checksum,
640 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
643 struct bt_fd_cache_handle
*debug_handle
= NULL
;
650 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
655 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
664 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
669 * Try to set the dwarf_info for a given bin_info instance via the
672 * @param bin bin_info instance for which to retrieve the
673 * DWARF info via debug link
674 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
677 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
680 const gchar
*dbg_dir
= NULL
;
681 gchar
*bin_dir
= NULL
, *dir_name
= NULL
, *path
= NULL
;
683 if (!bin
|| !bin
->dbg_link_filename
) {
687 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
688 dir_name
= g_path_get_dirname(bin
->elf_path
);
693 bin_dir
= g_strconcat(dir_name
, "/", NULL
);
695 /* First look in the executable's dir */
696 path
= g_strconcat(bin_dir
, bin
->dbg_link_filename
, NULL
);
698 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
702 /* If not found, look in .debug subdir */
704 path
= g_strconcat(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
706 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
710 /* Lastly, look under the global debug directory */
713 path
= g_strconcat(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
714 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
728 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
737 * Initialize the DWARF info for a given executable.
739 * @param bin bin_info instance
740 * @returns 0 on success, negative value on failure
743 int bin_info_set_dwarf_info(struct bin_info
*bin
)
752 /* First try to set the DWARF info from the ELF file */
753 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
759 * If that fails, try to find separate debug info via build ID
762 ret
= bin_info_set_dwarf_info_build_id(bin
);
767 ret
= bin_info_set_dwarf_info_debug_link(bin
);
777 void source_location_destroy(struct source_location
*src_loc
)
783 free(src_loc
->filename
);
788 * Append a string representation of an address offset to an existing
791 * On success, the out parameter `result` will contain the base string
792 * followed by the offset string of the form "+0x1234". On failure,
793 * `result` remains unchanged.
795 * @param base_str The string to which to append an offset string
796 * @param low_addr The lower virtual memory address, the base from
797 * which the offset is computed
798 * @param high_addr The higher virtual memory address
799 * @param result Out parameter, the base string followed by the
801 * @returns 0 on success, -1 on failure
804 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
805 uint64_t high_addr
, char **result
)
808 char *_result
= NULL
;
810 if (!base_str
|| !result
) {
814 offset
= high_addr
- low_addr
;
816 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
830 * Try to find the symbol closest to an address within a given ELF
833 * Only function symbols are taken into account. The symbol's address
834 * must precede `addr`. A symbol with a closer address might exist
835 * after `addr` but is irrelevant because it cannot encompass `addr`.
837 * On success, if found, the out parameters `sym` and `shdr` are
838 * set. On failure or if none are found, they remain unchanged.
840 * @param scn ELF section in which to look for the address
841 * @param addr Virtual memory address for which to find the
842 * nearest function symbol
843 * @param sym Out parameter, the nearest function symbol
844 * @param shdr Out parameter, the section header for scn
845 * @returns 0 on success, -1 on failure
848 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
849 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
853 Elf_Data
*data
= NULL
;
854 GElf_Shdr
*_shdr
= NULL
;
855 GElf_Sym
*nearest_sym
= NULL
;
857 if (!scn
|| !sym
|| !shdr
) {
861 _shdr
= g_new0(GElf_Shdr
, 1);
866 _shdr
= gelf_getshdr(scn
, _shdr
);
871 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
873 * We are only interested in symbol table (symtab)
874 * sections, skip this one.
879 data
= elf_getdata(scn
, NULL
);
884 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
886 for (i
= 0; i
< symbol_count
; ++i
) {
887 GElf_Sym
*cur_sym
= NULL
;
889 cur_sym
= g_new0(GElf_Sym
, 1);
893 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
897 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
898 /* We're only interested in the functions. */
903 if (cur_sym
->st_value
<= addr
&&
905 cur_sym
->st_value
> nearest_sym
->st_value
)) {
907 nearest_sym
= cur_sym
;
930 * Get the name of the function containing a given address within an
931 * executable using ELF symbols.
933 * The function name is in fact the name of the nearest ELF symbol,
934 * followed by the offset in bytes between the address and the symbol
935 * (in hex), separated by a '+' character.
937 * If found, the out parameter `func_name` is set on success. On failure,
938 * it remains unchanged.
940 * @param bin bin_info instance for the executable containing
942 * @param addr Virtual memory address for which to find the
944 * @param func_name Out parameter, the function name
945 * @returns 0 on success, -1 on failure
948 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
952 * TODO (possible optimisation): if an ELF has no symtab
953 * section, it has been stripped. Therefore, it would be wise
954 * to store a flag indicating the stripped status after the
955 * first iteration to prevent subsequent ones.
959 GElf_Sym
*sym
= NULL
;
960 GElf_Shdr
*shdr
= NULL
;
961 char *sym_name
= NULL
;
963 /* Set ELF file if it hasn't been accessed yet. */
964 if (!bin
->elf_file
) {
965 ret
= bin_info_set_elf_file(bin
);
967 /* Failed to set ELF file. */
972 scn
= elf_nextscn(bin
->elf_file
, scn
);
977 while (scn
&& !sym
) {
978 ret
= bin_info_get_nearest_symbol_from_section(
979 scn
, addr
, &sym
, &shdr
);
984 scn
= elf_nextscn(bin
->elf_file
, scn
);
988 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
994 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
1012 * Get the name of the function containing a given address within a
1013 * given compile unit (CU).
1015 * If found, the out parameter `func_name` is set on success. On
1016 * failure, it remains unchanged.
1018 * @param cu bt_dwarf_cu instance which may contain the address
1019 * @param addr Virtual memory address for which to find the
1021 * @param func_name Out parameter, the function name
1022 * @returns 0 on success, -1 on failure
1025 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1030 struct bt_dwarf_die
*die
= NULL
;
1032 if (!cu
|| !func_name
) {
1036 die
= bt_dwarf_die_create(cu
);
1041 while (bt_dwarf_die_next(die
) == 0) {
1044 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1049 if (tag
== DW_TAG_subprogram
) {
1050 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1062 uint64_t low_addr
= 0;
1063 char *die_name
= NULL
;
1065 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1070 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1076 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1084 bt_dwarf_die_destroy(die
);
1088 bt_dwarf_die_destroy(die
);
1093 * Get the name of the function containing a given address within an
1094 * executable using DWARF debug info.
1096 * If found, the out parameter `func_name` is set on success. On
1097 * failure, it remains unchanged.
1099 * @param bin bin_info instance for the executable containing
1101 * @param addr Virtual memory address for which to find the
1103 * @param func_name Out parameter, the function name
1104 * @returns 0 on success, -1 on failure
1107 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1111 char *_func_name
= NULL
;
1112 struct bt_dwarf_cu
*cu
= NULL
;
1114 if (!bin
|| !func_name
) {
1118 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1123 while (bt_dwarf_cu_next(cu
) == 0) {
1124 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1135 *func_name
= _func_name
;
1140 bt_dwarf_cu_destroy(cu
);
1144 bt_dwarf_cu_destroy(cu
);
1149 int bin_info_lookup_function_name(struct bin_info
*bin
,
1150 uint64_t addr
, char **func_name
)
1153 char *_func_name
= NULL
;
1155 if (!bin
|| !func_name
) {
1160 * If the bin_info has a build id but it does not match the build id
1161 * that was found on the file system, return an error.
1163 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1167 /* Set DWARF info if it hasn't been accessed yet. */
1168 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1169 ret
= bin_info_set_dwarf_info(bin
);
1171 BT_LOGD_STR("Failed to set bin dwarf info, falling "
1172 "back to ELF lookup.");
1173 /* Failed to set DWARF info, fallback to ELF. */
1174 bin
->is_elf_only
= true;
1178 if (!bin_info_has_address(bin
, addr
)) {
1183 * Addresses in ELF and DWARF are relative to base address for
1184 * PIC, so make the address argument relative too if needed.
1187 addr
-= bin
->low_addr
;
1190 if (bin
->is_elf_only
) {
1191 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1194 BT_LOGD("Failed to lookup function name (ELF): "
1198 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1201 BT_LOGD("Failed to lookup function name (DWARF): "
1206 *func_name
= _func_name
;
1214 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1216 gchar
*_bin_loc
= NULL
;
1218 if (!bin
|| !bin_loc
) {
1223 * If the bin_info has a build id but it does not match the build id
1224 * that was found on the file system, return an error.
1226 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1231 addr
-= bin
->low_addr
;
1232 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1234 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1241 *bin_loc
= _bin_loc
;
1249 * Predicate used to determine whether the children of a given DIE
1250 * contain a specific address.
1252 * More specifically, the parameter `die` is expected to be a
1253 * subprogram (function) DIE, and this predicate tells whether any
1254 * subroutines are inlined within this function and would contain
1257 * On success, the out parameter `contains` is set with the boolean
1258 * value indicating whether the DIE's range covers `addr`. On failure,
1259 * it remains unchanged.
1261 * Do note that this function advances the position of `die`. If the
1262 * address is found within one of its children, `die` will be pointing
1263 * to that child upon returning from the function, allowing to extract
1264 * the information deemed necessary.
1266 * @param die The parent DIE in whose children the address will be
1268 * @param addr The address for which to look for in the DIEs
1269 * @param contains Out parameter, true if addr is contained,
1271 * @returns Returns 0 on success, -1 on failure
1274 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1277 bool _contains
= false;
1283 ret
= bt_dwarf_die_child(die
);
1289 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1296 * The address is within the range of the current DIE
1301 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1306 if (tag
== DW_TAG_inlined_subroutine
) {
1307 /* Found the tracepoint. */
1311 if (bt_dwarf_die_has_children(die
)) {
1313 * Look for the address in the children DIEs.
1315 ret
= bt_dwarf_die_child(die
);
1321 } while (bt_dwarf_die_next(die
) == 0);
1324 *contains
= _contains
;
1332 * Lookup the source location for a given address within a CU, making
1333 * the assumption that it is contained within an inline routine in a
1336 * @param cu bt_dwarf_cu instance in which to look for the address
1337 * @param addr The address for which to look for
1338 * @param src_loc Out parameter, the source location (filename and
1339 * line number) for the address
1340 * @returns 0 on success, -1 on failure
1343 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1344 struct source_location
**src_loc
)
1348 struct bt_dwarf_die
*die
= NULL
;
1349 struct source_location
*_src_loc
= NULL
;
1351 if (!cu
|| !src_loc
) {
1355 die
= bt_dwarf_die_create(cu
);
1360 while (bt_dwarf_die_next(die
) == 0) {
1363 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1368 if (tag
== DW_TAG_subprogram
) {
1369 bool contains
= false;
1371 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1378 * Try to find an inlined subroutine
1379 * child of this DIE containing addr.
1381 ret
= bin_info_child_die_has_address(die
, addr
,
1394 char *filename
= NULL
;
1397 _src_loc
= g_new0(struct source_location
, 1);
1402 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1406 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1412 _src_loc
->filename
= filename
;
1413 _src_loc
->line_no
= line_no
;
1414 *src_loc
= _src_loc
;
1417 bt_dwarf_die_destroy(die
);
1421 source_location_destroy(_src_loc
);
1422 bt_dwarf_die_destroy(die
);
1427 * Lookup the source location for a given address within a CU,
1428 * assuming that it is contained within an inlined function.
1430 * A source location can be found regardless of inlining status for
1431 * this method, but in the case of an inlined function, the returned
1432 * source location will point not to the callsite but rather to the
1433 * definition site of the inline function.
1435 * @param cu bt_dwarf_cu instance in which to look for the address
1436 * @param addr The address for which to look for
1437 * @param src_loc Out parameter, the source location (filename and
1438 * line number) for the address
1439 * @returns 0 on success, -1 on failure
1442 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1443 struct source_location
**src_loc
)
1445 struct source_location
*_src_loc
= NULL
;
1446 struct bt_dwarf_die
*die
= NULL
;
1447 const char *filename
= NULL
;
1448 Dwarf_Line
*line
= NULL
;
1449 Dwarf_Addr line_addr
;
1452 if (!cu
|| !src_loc
) {
1456 die
= bt_dwarf_die_create(cu
);
1461 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1466 ret
= dwarf_lineaddr(line
, &line_addr
);
1471 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1476 if (addr
== line_addr
) {
1477 _src_loc
= g_new0(struct source_location
, 1);
1482 ret
= dwarf_lineno(line
, &line_no
);
1487 _src_loc
->line_no
= line_no
;
1488 _src_loc
->filename
= g_strdup(filename
);
1491 bt_dwarf_die_destroy(die
);
1494 *src_loc
= _src_loc
;
1500 source_location_destroy(_src_loc
);
1501 bt_dwarf_die_destroy(die
);
1506 * Get the source location (file name and line number) for a given
1507 * address within a compile unit (CU).
1509 * On success, the out parameter `src_loc` is set if found. On
1510 * failure, it remains unchanged.
1512 * @param cu bt_dwarf_cu instance for the compile unit which
1513 * may contain the address
1514 * @param addr Virtual memory address for which to find the
1516 * @param src_loc Out parameter, the source location
1517 * @returns 0 on success, -1 on failure
1520 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1521 struct source_location
**src_loc
)
1524 struct source_location
*_src_loc
= NULL
;
1526 if (!cu
|| !src_loc
) {
1530 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1539 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1550 *src_loc
= _src_loc
;
1556 source_location_destroy(_src_loc
);
1561 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1562 struct source_location
**src_loc
)
1564 struct bt_dwarf_cu
*cu
= NULL
;
1565 struct source_location
*_src_loc
= NULL
;
1567 if (!bin
|| !src_loc
) {
1572 * If the bin_info has a build id but it does not match the build id
1573 * that was found on the file system, return an error.
1575 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1579 /* Set DWARF info if it hasn't been accessed yet. */
1580 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1581 if (bin_info_set_dwarf_info(bin
)) {
1582 /* Failed to set DWARF info. */
1583 bin
->is_elf_only
= true;
1587 if (bin
->is_elf_only
) {
1588 /* We cannot lookup source location without DWARF info. */
1592 if (!bin_info_has_address(bin
, addr
)) {
1597 * Addresses in ELF and DWARF are relative to base address for
1598 * PIC, so make the address argument relative too if needed.
1601 addr
-= bin
->low_addr
;
1604 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1609 while (bt_dwarf_cu_next(cu
) == 0) {
1612 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1622 bt_dwarf_cu_destroy(cu
);
1624 *src_loc
= _src_loc
;
1630 source_location_destroy(_src_loc
);
1631 bt_dwarf_cu_destroy(cu
);