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_path("/", target_prefix
,
96 bin
->elf_path
= g_strdup(path
);
103 if (debug_info_dir
) {
104 bin
->debug_info_dir
= g_strdup(debug_info_dir
);
105 if (!bin
->debug_info_dir
) {
110 bin
->is_pic
= is_pic
;
112 bin
->low_addr
= low_addr
;
113 bin
->high_addr
= bin
->low_addr
+ bin
->memsz
;
114 bin
->build_id
= NULL
;
115 bin
->build_id_len
= 0;
116 bin
->file_build_id_matches
= false;
122 bin_info_destroy(bin
);
127 void bin_info_destroy(struct bin_info
*bin
)
133 dwarf_end(bin
->dwarf_info
);
135 g_free(bin
->debug_info_dir
);
136 g_free(bin
->elf_path
);
137 g_free(bin
->dwarf_path
);
138 g_free(bin
->build_id
);
139 g_free(bin
->dbg_link_filename
);
141 elf_end(bin
->elf_file
);
143 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->elf_handle
);
144 bt_fd_cache_put_handle(bin
->fd_cache
, bin
->dwarf_handle
);
150 int bin_info_set_endianness(struct bin_info
*bin
)
153 uint8_t e_ident
[EI_NIDENT
];
155 fd
= bt_fd_cache_handle_get_fd(bin
->elf_handle
);
158 * Read the identification fields of the elf file.
160 if (lseek(fd
, 0, SEEK_SET
) < 0) {
161 BT_LOGE("Error seeking the beginning of ELF file: %s",
167 ret
= bt_common_read(fd
, e_ident
, EI_NIDENT
);
168 if (ret
< EI_NIDENT
) {
169 BT_LOGE_STR("Error reading the ELF identification fields");
175 * Set the endianness.
177 bin
->endianness
= e_ident
[EI_DATA
];
185 * Initialize the ELF file for a given executable.
187 * @param bin bin_info instance
188 * @returns 0 on success, negative value on error.
191 int bin_info_set_elf_file(struct bin_info
*bin
)
193 struct bt_fd_cache_handle
*elf_handle
= NULL
;
194 Elf
*elf_file
= NULL
;
201 elf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, bin
->elf_path
);
203 BT_LOGD("Failed to open %s", bin
->elf_path
);
206 bin
->elf_handle
= elf_handle
;
208 ret
= bin_info_set_endianness(bin
);
213 elf_file
= elf_begin(bt_fd_cache_handle_get_fd(bin
->elf_handle
),
216 BT_LOGE("elf_begin failed: %s", elf_errmsg(-1));
220 bin
->elf_file
= elf_file
;
222 if (elf_kind(elf_file
) != ELF_K_ELF
) {
223 BT_LOGE("Error: %s is not an ELF object", bin
->elf_path
);
230 bt_fd_cache_put_handle(bin
->fd_cache
, elf_handle
);
236 * From a note section data buffer, check if it is a build id note.
238 * @param buf Pointer to a note section
240 * @returns 1 on match, 0 if `buf` does not contain a
241 * valid build id note
244 int is_build_id_note_section(uint8_t *buf
)
247 uint32_t name_sz
, desc_sz
, note_type
;
249 /* The note section header has 3 32bit integer for the following:
250 * - Section name size
254 name_sz
= (uint32_t) *buf
;
255 buf
+= sizeof(name_sz
);
257 buf
+= sizeof(desc_sz
);
259 note_type
= (uint32_t) *buf
;
260 buf
+= sizeof(note_type
);
262 /* Check the note type. */
263 if (note_type
!= NT_GNU_BUILD_ID
) {
267 /* Check the note name. */
268 if (memcmp(buf
, BUILD_ID_NOTE_NAME
, name_sz
) != 0) {
279 * From a build id note section data buffer, check if the build id it contains
280 * is identical to the build id passed as parameter.
282 * @param file_build_id_note Pointer to the file build id note section.
283 * @param build_id Pointer to a build id to compare to.
284 * @param build_id_len length of the build id.
286 * @returns 1 on match, 0 otherwise.
289 int is_build_id_note_section_matching(uint8_t *file_build_id_note
,
290 uint8_t *build_id
, size_t build_id_len
)
292 uint32_t name_sz
, desc_sz
, note_type
;
294 if (build_id_len
<= 0) {
298 /* The note section header has 3 32bit integer for the following:
299 * - Section name size
303 name_sz
= (uint32_t) *file_build_id_note
;
304 file_build_id_note
+= sizeof(name_sz
);
305 file_build_id_note
+= sizeof(desc_sz
);
306 file_build_id_note
+= sizeof(note_type
);
309 * Move the pointer pass the name char array. This corresponds to the
310 * beginning of the description section. The description is the build
311 * id in the case of a build id note.
313 file_build_id_note
+= name_sz
;
316 * Compare the binary build id with the supplied build id.
318 if (memcmp(build_id
, file_build_id_note
, build_id_len
) == 0) {
326 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
327 * id of the ondisk file (bin->elf_file).
329 * @param bin bin_info instance
330 * @param build_id build id to compare ot the on disk file
331 * @param build_id_len length of the build id
333 * @returns 1 on if the build id of stored in `bin` matches
334 * the build id of the ondisk file.
335 * 0 on if they are different or an error occured.
338 int is_build_id_matching(struct bin_info
*bin
)
340 int ret
, is_build_id
, is_matching
= 0;
341 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
342 GElf_Shdr
*curr_section_hdr
= NULL
;
344 if (!bin
->build_id
) {
348 /* Set ELF file if it hasn't been accessed yet. */
349 if (!bin
->elf_file
) {
350 ret
= bin_info_set_elf_file(bin
);
352 /* Failed to set ELF file. */
357 curr_section_hdr
= g_new0(GElf_Shdr
, 1);
358 if (!curr_section_hdr
) {
362 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
367 while (next_section
) {
368 Elf_Data
*file_note_data
= NULL
;
369 Elf_Data native_note_data
;
371 curr_section
= next_section
;
372 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
374 curr_section_hdr
= gelf_getshdr(curr_section
, curr_section_hdr
);
376 if (!curr_section_hdr
) {
380 if (curr_section_hdr
->sh_type
!= SHT_NOTE
) {
384 file_note_data
= elf_getdata(curr_section
, NULL
);
385 if (!file_note_data
) {
390 * Prepare the destination buffer to receive the natively
391 * ordered note. The `d_buf`, `d_size`, and `d_version` fields
392 * of the destination structure must be set before invoking the
393 * `gelf_xlatetom()` function.
395 native_note_data
.d_buf
= g_new0(uint8_t, file_note_data
->d_size
);
396 BT_ASSERT(native_note_data
.d_buf
);
398 native_note_data
.d_size
= file_note_data
->d_size
;
399 native_note_data
.d_version
= file_note_data
->d_version
;
401 /* Translate the note data buffer to the host endianness. */
402 gelf_xlatetom(bin
->elf_file
, &native_note_data
, file_note_data
,
405 /* Check if the note is of the build-id type. */
406 is_build_id
= is_build_id_note_section(native_note_data
.d_buf
);
408 g_free(native_note_data
.d_buf
);
413 * Compare the build id of the on-disk file and
414 * the build id recorded in the trace.
416 is_matching
= is_build_id_note_section_matching(
417 native_note_data
.d_buf
, bin
->build_id
,
419 g_free(native_note_data
.d_buf
);
425 g_free(curr_section_hdr
);
430 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
433 if (!bin
|| !build_id
) {
437 /* Set the build id. */
438 bin
->build_id
= g_new0(uint8_t, build_id_len
);
439 if (!bin
->build_id
) {
443 memcpy(bin
->build_id
, build_id
, build_id_len
);
444 bin
->build_id_len
= build_id_len
;
447 * Check if the file found on the file system has the same build id
448 * that what was recorded in the trace.
450 bin
->file_build_id_matches
= is_build_id_matching(bin
);
451 if (!bin
->file_build_id_matches
) {
452 BT_LOGD_STR("Supplied Build ID does not match Build ID of the "
453 "binary or library found on the file system.");
458 * Reset the is_elf_only flag in case it had been set
459 * previously, because we might find separate debug info using
460 * the new build id information.
462 bin
->is_elf_only
= false;
471 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
474 if (!bin
|| !filename
) {
478 bin
->dbg_link_filename
= g_strdup(filename
);
479 if (!bin
->dbg_link_filename
) {
483 bin
->dbg_link_crc
= crc
;
486 * Reset the is_elf_only flag in case it had been set
487 * previously, because we might find separate debug info using
488 * the new build id information.
490 bin
->is_elf_only
= false;
500 * Tries to read DWARF info from the location given by path, and
501 * attach it to the given bin_info instance if it exists.
503 * @param bin bin_info instance for which to set DWARF info
504 * @param path Presumed location of the DWARF info
505 * @returns 0 on success, negative value on failure
508 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
511 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
512 struct bt_dwarf_cu
*cu
= NULL
;
513 Dwarf
*dwarf_info
= NULL
;
519 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
524 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
531 * Check if the dwarf info has any CU. If not, the
532 * executable's object file contains no DWARF info.
534 cu
= bt_dwarf_cu_create(dwarf_info
);
539 ret
= bt_dwarf_cu_next(cu
);
544 bin
->dwarf_handle
= dwarf_handle
;
545 bin
->dwarf_path
= g_strdup(path
);
546 if (!bin
->dwarf_path
) {
549 bin
->dwarf_info
= dwarf_info
;
555 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
556 dwarf_end(dwarf_info
);
564 * Try to set the dwarf_info for a given bin_info instance via the
567 * @param bin bin_info instance for which to retrieve the
568 * DWARF info via build ID
569 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
572 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
575 char *path
= NULL
, *build_id_file
= NULL
;
576 const char *dbg_dir
= NULL
;
577 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
579 if (!bin
|| !bin
->build_id
) {
583 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
585 /* 2 characters per byte printed in hex, +1 for '/' and +1 for '\0' */
586 build_id_char_len
= (2 * bin
->build_id_len
) + 1;
587 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
588 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
589 build_id_file
= g_new0(gchar
, build_id_file_len
);
590 if (!build_id_file
) {
594 g_snprintf(build_id_file
, 4, "%02x/", bin
->build_id
[0]);
595 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
596 int path_idx
= 3 + 2 * (i
- 1);
598 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
600 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
603 path
= g_build_path("/", dbg_dir
, BUILD_ID_SUBDIR
, build_id_file
, NULL
);
608 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
625 * Tests whether the file located at path exists and has the expected
628 * This predicate is used when looking up separate debug info via the
629 * GNU debuglink method. The expected crc can be found .gnu_debuglink
630 * section in the original ELF file, along with the filename for the
631 * file containing the debug info.
633 * @param path Full path at which to look for the debug file
634 * @param crc Expected checksum for the debug file
635 * @returns 1 if the file exists and has the correct checksum,
639 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
642 struct bt_fd_cache_handle
*debug_handle
= NULL
;
649 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
654 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
663 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
668 * Try to set the dwarf_info for a given bin_info instance via the
671 * @param bin bin_info instance for which to retrieve the
672 * DWARF info via debug link
673 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
676 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
679 const gchar
*dbg_dir
= NULL
;
680 gchar
*bin_dir
= NULL
, *dir_name
= NULL
, *path
= NULL
;
682 if (!bin
|| !bin
->dbg_link_filename
) {
686 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
687 dir_name
= g_path_get_dirname(bin
->elf_path
);
692 bin_dir
= g_strconcat(dir_name
, "/", NULL
);
694 /* First look in the executable's dir */
695 path
= g_strconcat(bin_dir
, bin
->dbg_link_filename
, NULL
);
697 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
701 /* If not found, look in .debug subdir */
703 path
= g_strconcat(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
705 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
709 /* Lastly, look under the global debug directory */
712 path
= g_strconcat(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
713 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
727 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
736 * Initialize the DWARF info for a given executable.
738 * @param bin bin_info instance
739 * @returns 0 on success, negative value on failure
742 int bin_info_set_dwarf_info(struct bin_info
*bin
)
751 /* First try to set the DWARF info from the ELF file */
752 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
758 * If that fails, try to find separate debug info via build ID
761 ret
= bin_info_set_dwarf_info_build_id(bin
);
766 ret
= bin_info_set_dwarf_info_debug_link(bin
);
776 void source_location_destroy(struct source_location
*src_loc
)
782 free(src_loc
->filename
);
787 * Append a string representation of an address offset to an existing
790 * On success, the out parameter `result` will contain the base string
791 * followed by the offset string of the form "+0x1234". On failure,
792 * `result` remains unchanged.
794 * @param base_str The string to which to append an offset string
795 * @param low_addr The lower virtual memory address, the base from
796 * which the offset is computed
797 * @param high_addr The higher virtual memory address
798 * @param result Out parameter, the base string followed by the
800 * @returns 0 on success, -1 on failure
803 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
804 uint64_t high_addr
, char **result
)
807 char *_result
= NULL
;
809 if (!base_str
|| !result
) {
813 offset
= high_addr
- low_addr
;
815 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
829 * Try to find the symbol closest to an address within a given ELF
832 * Only function symbols are taken into account. The symbol's address
833 * must precede `addr`. A symbol with a closer address might exist
834 * after `addr` but is irrelevant because it cannot encompass `addr`.
836 * On success, if found, the out parameters `sym` and `shdr` are
837 * set. On failure or if none are found, they remain unchanged.
839 * @param scn ELF section in which to look for the address
840 * @param addr Virtual memory address for which to find the
841 * nearest function symbol
842 * @param sym Out parameter, the nearest function symbol
843 * @param shdr Out parameter, the section header for scn
844 * @returns 0 on success, -1 on failure
847 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
848 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
852 Elf_Data
*data
= NULL
;
853 GElf_Shdr
*_shdr
= NULL
;
854 GElf_Sym
*nearest_sym
= NULL
;
856 if (!scn
|| !sym
|| !shdr
) {
860 _shdr
= g_new0(GElf_Shdr
, 1);
865 _shdr
= gelf_getshdr(scn
, _shdr
);
870 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
872 * We are only interested in symbol table (symtab)
873 * sections, skip this one.
878 data
= elf_getdata(scn
, NULL
);
883 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
885 for (i
= 0; i
< symbol_count
; ++i
) {
886 GElf_Sym
*cur_sym
= NULL
;
888 cur_sym
= g_new0(GElf_Sym
, 1);
892 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
896 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
897 /* We're only interested in the functions. */
902 if (cur_sym
->st_value
<= addr
&&
904 cur_sym
->st_value
> nearest_sym
->st_value
)) {
906 nearest_sym
= cur_sym
;
929 * Get the name of the function containing a given address within an
930 * executable using ELF symbols.
932 * The function name is in fact the name of the nearest ELF symbol,
933 * followed by the offset in bytes between the address and the symbol
934 * (in hex), separated by a '+' character.
936 * If found, the out parameter `func_name` is set on success. On failure,
937 * it remains unchanged.
939 * @param bin bin_info instance for the executable containing
941 * @param addr Virtual memory address for which to find the
943 * @param func_name Out parameter, the function name
944 * @returns 0 on success, -1 on failure
947 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
951 * TODO (possible optimisation): if an ELF has no symtab
952 * section, it has been stripped. Therefore, it would be wise
953 * to store a flag indicating the stripped status after the
954 * first iteration to prevent subsequent ones.
958 GElf_Sym
*sym
= NULL
;
959 GElf_Shdr
*shdr
= NULL
;
960 char *sym_name
= NULL
;
962 /* Set ELF file if it hasn't been accessed yet. */
963 if (!bin
->elf_file
) {
964 ret
= bin_info_set_elf_file(bin
);
966 /* Failed to set ELF file. */
971 scn
= elf_nextscn(bin
->elf_file
, scn
);
976 while (scn
&& !sym
) {
977 ret
= bin_info_get_nearest_symbol_from_section(
978 scn
, addr
, &sym
, &shdr
);
983 scn
= elf_nextscn(bin
->elf_file
, scn
);
987 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
993 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
1011 * Get the name of the function containing a given address within a
1012 * given compile unit (CU).
1014 * If found, the out parameter `func_name` is set on success. On
1015 * failure, it remains unchanged.
1017 * @param cu bt_dwarf_cu instance which may contain the address
1018 * @param addr Virtual memory address for which to find the
1020 * @param func_name Out parameter, the function name
1021 * @returns 0 on success, -1 on failure
1024 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1029 struct bt_dwarf_die
*die
= NULL
;
1031 if (!cu
|| !func_name
) {
1035 die
= bt_dwarf_die_create(cu
);
1040 while (bt_dwarf_die_next(die
) == 0) {
1043 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1048 if (tag
== DW_TAG_subprogram
) {
1049 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1061 uint64_t low_addr
= 0;
1062 char *die_name
= NULL
;
1064 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1069 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1075 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1083 bt_dwarf_die_destroy(die
);
1087 bt_dwarf_die_destroy(die
);
1092 * Get the name of the function containing a given address within an
1093 * executable using DWARF debug info.
1095 * If found, the out parameter `func_name` is set on success. On
1096 * failure, it remains unchanged.
1098 * @param bin bin_info instance for the executable containing
1100 * @param addr Virtual memory address for which to find the
1102 * @param func_name Out parameter, the function name
1103 * @returns 0 on success, -1 on failure
1106 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1110 char *_func_name
= NULL
;
1111 struct bt_dwarf_cu
*cu
= NULL
;
1113 if (!bin
|| !func_name
) {
1117 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1122 while (bt_dwarf_cu_next(cu
) == 0) {
1123 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1134 *func_name
= _func_name
;
1139 bt_dwarf_cu_destroy(cu
);
1143 bt_dwarf_cu_destroy(cu
);
1148 int bin_info_lookup_function_name(struct bin_info
*bin
,
1149 uint64_t addr
, char **func_name
)
1152 char *_func_name
= NULL
;
1154 if (!bin
|| !func_name
) {
1159 * If the bin_info has a build id but it does not match the build id
1160 * that was found on the file system, return an error.
1162 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1166 /* Set DWARF info if it hasn't been accessed yet. */
1167 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1168 ret
= bin_info_set_dwarf_info(bin
);
1170 BT_LOGD_STR("Failed to set bin dwarf info, falling "
1171 "back to ELF lookup.");
1172 /* Failed to set DWARF info, fallback to ELF. */
1173 bin
->is_elf_only
= true;
1177 if (!bin_info_has_address(bin
, addr
)) {
1182 * Addresses in ELF and DWARF are relative to base address for
1183 * PIC, so make the address argument relative too if needed.
1186 addr
-= bin
->low_addr
;
1189 if (bin
->is_elf_only
) {
1190 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1193 BT_LOGD("Failed to lookup function name (ELF): "
1197 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1200 BT_LOGD("Failed to lookup function name (DWARF): "
1205 *func_name
= _func_name
;
1213 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1215 gchar
*_bin_loc
= NULL
;
1217 if (!bin
|| !bin_loc
) {
1222 * If the bin_info has a build id but it does not match the build id
1223 * that was found on the file system, return an error.
1225 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1230 addr
-= bin
->low_addr
;
1231 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1233 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1240 *bin_loc
= _bin_loc
;
1248 * Predicate used to determine whether the children of a given DIE
1249 * contain a specific address.
1251 * More specifically, the parameter `die` is expected to be a
1252 * subprogram (function) DIE, and this predicate tells whether any
1253 * subroutines are inlined within this function and would contain
1256 * On success, the out parameter `contains` is set with the boolean
1257 * value indicating whether the DIE's range covers `addr`. On failure,
1258 * it remains unchanged.
1260 * Do note that this function advances the position of `die`. If the
1261 * address is found within one of its children, `die` will be pointing
1262 * to that child upon returning from the function, allowing to extract
1263 * the information deemed necessary.
1265 * @param die The parent DIE in whose children the address will be
1267 * @param addr The address for which to look for in the DIEs
1268 * @param contains Out parameter, true if addr is contained,
1270 * @returns Returns 0 on success, -1 on failure
1273 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1276 bool _contains
= false;
1282 ret
= bt_dwarf_die_child(die
);
1288 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1295 * The address is within the range of the current DIE
1300 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1305 if (tag
== DW_TAG_inlined_subroutine
) {
1306 /* Found the tracepoint. */
1310 if (bt_dwarf_die_has_children(die
)) {
1312 * Look for the address in the children DIEs.
1314 ret
= bt_dwarf_die_child(die
);
1320 } while (bt_dwarf_die_next(die
) == 0);
1323 *contains
= _contains
;
1331 * Lookup the source location for a given address within a CU, making
1332 * the assumption that it is contained within an inline routine in a
1335 * @param cu bt_dwarf_cu instance in which to look for the address
1336 * @param addr The address for which to look for
1337 * @param src_loc Out parameter, the source location (filename and
1338 * line number) for the address
1339 * @returns 0 on success, -1 on failure
1342 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1343 struct source_location
**src_loc
)
1347 struct bt_dwarf_die
*die
= NULL
;
1348 struct source_location
*_src_loc
= NULL
;
1350 if (!cu
|| !src_loc
) {
1354 die
= bt_dwarf_die_create(cu
);
1359 while (bt_dwarf_die_next(die
) == 0) {
1362 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1367 if (tag
== DW_TAG_subprogram
) {
1368 bool contains
= false;
1370 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1377 * Try to find an inlined subroutine
1378 * child of this DIE containing addr.
1380 ret
= bin_info_child_die_has_address(die
, addr
,
1393 char *filename
= NULL
;
1396 _src_loc
= g_new0(struct source_location
, 1);
1401 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1405 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1411 _src_loc
->filename
= filename
;
1412 _src_loc
->line_no
= line_no
;
1413 *src_loc
= _src_loc
;
1416 bt_dwarf_die_destroy(die
);
1420 source_location_destroy(_src_loc
);
1421 bt_dwarf_die_destroy(die
);
1426 * Lookup the source location for a given address within a CU,
1427 * assuming that it is contained within an inlined function.
1429 * A source location can be found regardless of inlining status for
1430 * this method, but in the case of an inlined function, the returned
1431 * source location will point not to the callsite but rather to the
1432 * definition site of the inline function.
1434 * @param cu bt_dwarf_cu instance in which to look for the address
1435 * @param addr The address for which to look for
1436 * @param src_loc Out parameter, the source location (filename and
1437 * line number) for the address
1438 * @returns 0 on success, -1 on failure
1441 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1442 struct source_location
**src_loc
)
1444 struct source_location
*_src_loc
= NULL
;
1445 struct bt_dwarf_die
*die
= NULL
;
1446 const char *filename
= NULL
;
1447 Dwarf_Line
*line
= NULL
;
1448 Dwarf_Addr line_addr
;
1451 if (!cu
|| !src_loc
) {
1455 die
= bt_dwarf_die_create(cu
);
1460 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1465 ret
= dwarf_lineaddr(line
, &line_addr
);
1470 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1475 if (addr
== line_addr
) {
1476 _src_loc
= g_new0(struct source_location
, 1);
1481 ret
= dwarf_lineno(line
, &line_no
);
1486 _src_loc
->line_no
= line_no
;
1487 _src_loc
->filename
= g_strdup(filename
);
1490 bt_dwarf_die_destroy(die
);
1493 *src_loc
= _src_loc
;
1499 source_location_destroy(_src_loc
);
1500 bt_dwarf_die_destroy(die
);
1505 * Get the source location (file name and line number) for a given
1506 * address within a compile unit (CU).
1508 * On success, the out parameter `src_loc` is set if found. On
1509 * failure, it remains unchanged.
1511 * @param cu bt_dwarf_cu instance for the compile unit which
1512 * may contain the address
1513 * @param addr Virtual memory address for which to find the
1515 * @param src_loc Out parameter, the source location
1516 * @returns 0 on success, -1 on failure
1519 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1520 struct source_location
**src_loc
)
1523 struct source_location
*_src_loc
= NULL
;
1525 if (!cu
|| !src_loc
) {
1529 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1538 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1549 *src_loc
= _src_loc
;
1555 source_location_destroy(_src_loc
);
1560 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1561 struct source_location
**src_loc
)
1563 struct bt_dwarf_cu
*cu
= NULL
;
1564 struct source_location
*_src_loc
= NULL
;
1566 if (!bin
|| !src_loc
) {
1571 * If the bin_info has a build id but it does not match the build id
1572 * that was found on the file system, return an error.
1574 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1578 /* Set DWARF info if it hasn't been accessed yet. */
1579 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1580 if (bin_info_set_dwarf_info(bin
)) {
1581 /* Failed to set DWARF info. */
1582 bin
->is_elf_only
= true;
1586 if (bin
->is_elf_only
) {
1587 /* We cannot lookup source location without DWARF info. */
1591 if (!bin_info_has_address(bin
, addr
)) {
1596 * Addresses in ELF and DWARF are relative to base address for
1597 * PIC, so make the address argument relative too if needed.
1600 addr
-= bin
->low_addr
;
1603 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1608 while (bt_dwarf_cu_next(cu
) == 0) {
1611 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1621 bt_dwarf_cu_destroy(cu
);
1623 *src_loc
= _src_loc
;
1629 source_location_destroy(_src_loc
);
1630 bt_dwarf_cu_destroy(cu
);