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
;
254 buf
+= sizeof(name_sz
);
256 buf
+= sizeof(desc_sz
);
258 note_type
= (uint32_t) *buf
;
259 buf
+= sizeof(note_type
);
261 /* Check the note type. */
262 if (note_type
!= NT_GNU_BUILD_ID
) {
266 /* Check the note name. */
267 if (memcmp(buf
, BUILD_ID_NOTE_NAME
, name_sz
) != 0) {
278 * From a build id note section data buffer, check if the build id it contains
279 * is identical to the build id passed as parameter.
281 * @param file_build_id_note Pointer to the file build id note section.
282 * @param build_id Pointer to a build id to compare to.
283 * @param build_id_len length of the build id.
285 * @returns 1 on match, 0 otherwise.
288 int is_build_id_note_section_matching(uint8_t *file_build_id_note
,
289 uint8_t *build_id
, size_t build_id_len
)
291 uint32_t name_sz
, desc_sz
, note_type
;
293 if (build_id_len
<= 0) {
297 /* The note section header has 3 32bit integer for the following:
298 * - Section name size
302 name_sz
= (uint32_t) *file_build_id_note
;
303 file_build_id_note
+= sizeof(name_sz
);
304 file_build_id_note
+= sizeof(desc_sz
);
305 file_build_id_note
+= sizeof(note_type
);
308 * Move the pointer pass the name char array. This corresponds to the
309 * beginning of the description section. The description is the build
310 * id in the case of a build id note.
312 file_build_id_note
+= name_sz
;
315 * Compare the binary build id with the supplied build id.
317 if (memcmp(build_id
, file_build_id_note
, build_id_len
) == 0) {
325 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
326 * id of the ondisk file (bin->elf_file).
328 * @param bin bin_info instance
329 * @param build_id build id to compare ot the on disk file
330 * @param build_id_len length of the build id
332 * @returns 1 on if the build id of stored in `bin` matches
333 * the build id of the ondisk file.
334 * 0 on if they are different or an error occured.
337 int is_build_id_matching(struct bin_info
*bin
)
339 int ret
, is_build_id
, is_matching
= 0;
340 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
341 GElf_Shdr curr_section_hdr
;
343 if (!bin
->build_id
) {
347 /* Set ELF file if it hasn't been accessed yet. */
348 if (!bin
->elf_file
) {
349 ret
= bin_info_set_elf_file(bin
);
351 /* Failed to set ELF file. */
356 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
361 while (next_section
) {
362 Elf_Data
*file_note_data
= NULL
;
363 Elf_Data native_note_data
;
365 curr_section
= next_section
;
366 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
368 if (!gelf_getshdr(curr_section
, &curr_section_hdr
)) {
372 if (curr_section_hdr
.sh_type
!= SHT_NOTE
) {
376 file_note_data
= elf_getdata(curr_section
, NULL
);
377 if (!file_note_data
) {
382 * Prepare the destination buffer to receive the natively
383 * ordered note. The `d_buf`, `d_size`, and `d_version` fields
384 * of the destination structure must be set before invoking the
385 * `gelf_xlatetom()` function.
387 native_note_data
.d_buf
= g_new0(uint8_t, file_note_data
->d_size
);
388 BT_ASSERT(native_note_data
.d_buf
);
390 native_note_data
.d_size
= file_note_data
->d_size
;
391 native_note_data
.d_version
= file_note_data
->d_version
;
393 /* Translate the note data buffer to the host endianness. */
394 gelf_xlatetom(bin
->elf_file
, &native_note_data
, file_note_data
,
397 /* Check if the note is of the build-id type. */
398 is_build_id
= is_build_id_note_section(native_note_data
.d_buf
);
400 g_free(native_note_data
.d_buf
);
405 * Compare the build id of the on-disk file and
406 * the build id recorded in the trace.
408 is_matching
= is_build_id_note_section_matching(
409 native_note_data
.d_buf
, bin
->build_id
,
411 g_free(native_note_data
.d_buf
);
421 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
424 if (!bin
|| !build_id
) {
428 /* Set the build id. */
429 bin
->build_id
= g_new0(uint8_t, build_id_len
);
430 if (!bin
->build_id
) {
434 memcpy(bin
->build_id
, build_id
, build_id_len
);
435 bin
->build_id_len
= build_id_len
;
438 * Check if the file found on the file system has the same build id
439 * that what was recorded in the trace.
441 bin
->file_build_id_matches
= is_build_id_matching(bin
);
442 if (!bin
->file_build_id_matches
) {
443 BT_LOGD_STR("Supplied Build ID does not match Build ID of the "
444 "binary or library found on the file system.");
449 * Reset the is_elf_only flag in case it had been set
450 * previously, because we might find separate debug info using
451 * the new build id information.
453 bin
->is_elf_only
= false;
462 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
465 if (!bin
|| !filename
) {
469 bin
->dbg_link_filename
= g_strdup(filename
);
470 if (!bin
->dbg_link_filename
) {
474 bin
->dbg_link_crc
= crc
;
477 * Reset the is_elf_only flag in case it had been set
478 * previously, because we might find separate debug info using
479 * the new build id information.
481 bin
->is_elf_only
= false;
491 * Tries to read DWARF info from the location given by path, and
492 * attach it to the given bin_info instance if it exists.
494 * @param bin bin_info instance for which to set DWARF info
495 * @param path Presumed location of the DWARF info
496 * @returns 0 on success, negative value on failure
499 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
502 struct bt_fd_cache_handle
*dwarf_handle
= NULL
;
503 struct bt_dwarf_cu
*cu
= NULL
;
504 Dwarf
*dwarf_info
= NULL
;
510 dwarf_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
515 dwarf_info
= dwarf_begin(bt_fd_cache_handle_get_fd(dwarf_handle
),
522 * Check if the dwarf info has any CU. If not, the
523 * executable's object file contains no DWARF info.
525 cu
= bt_dwarf_cu_create(dwarf_info
);
530 ret
= bt_dwarf_cu_next(cu
);
535 bin
->dwarf_handle
= dwarf_handle
;
536 bin
->dwarf_path
= g_strdup(path
);
537 if (!bin
->dwarf_path
) {
540 bin
->dwarf_info
= dwarf_info
;
546 bt_fd_cache_put_handle(bin
->fd_cache
, dwarf_handle
);
547 dwarf_end(dwarf_info
);
555 * Try to set the dwarf_info for a given bin_info instance via the
558 * @param bin bin_info instance for which to retrieve the
559 * DWARF info via build ID
560 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
563 int bin_info_set_dwarf_info_build_id(struct bin_info
*bin
)
566 char *path
= NULL
, *build_id_file
= NULL
;
567 const char *dbg_dir
= NULL
;
568 size_t build_id_char_len
, build_id_suffix_char_len
, build_id_file_len
;
570 if (!bin
|| !bin
->build_id
) {
574 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
576 /* 2 characters per byte printed in hex, +1 for '/' and +1 for '\0' */
577 build_id_char_len
= (2 * bin
->build_id_len
) + 1;
578 build_id_suffix_char_len
= strlen(BUILD_ID_SUFFIX
) + 1;
579 build_id_file_len
= build_id_char_len
+ build_id_suffix_char_len
;
580 build_id_file
= g_new0(gchar
, build_id_file_len
);
581 if (!build_id_file
) {
585 g_snprintf(build_id_file
, 4, "%02x/", bin
->build_id
[0]);
586 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
587 int path_idx
= 3 + 2 * (i
- 1);
589 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
591 g_snprintf(&build_id_file
[build_id_char_len
], build_id_suffix_char_len
,
594 path
= g_build_filename(dbg_dir
, BUILD_ID_SUBDIR
, build_id_file
, NULL
);
599 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
616 * Tests whether the file located at path exists and has the expected
619 * This predicate is used when looking up separate debug info via the
620 * GNU debuglink method. The expected crc can be found .gnu_debuglink
621 * section in the original ELF file, along with the filename for the
622 * file containing the debug info.
624 * @param path Full path at which to look for the debug file
625 * @param crc Expected checksum for the debug file
626 * @returns 1 if the file exists and has the correct checksum,
630 int is_valid_debug_file(struct bin_info
*bin
, char *path
, uint32_t crc
)
633 struct bt_fd_cache_handle
*debug_handle
= NULL
;
640 debug_handle
= bt_fd_cache_get_handle(bin
->fd_cache
, path
);
645 ret
= crc32(bt_fd_cache_handle_get_fd(debug_handle
), &_crc
);
654 bt_fd_cache_put_handle(bin
->fd_cache
, debug_handle
);
659 * Try to set the dwarf_info for a given bin_info instance via the
662 * @param bin bin_info instance for which to retrieve the
663 * DWARF info via debug link
664 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
667 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
670 const gchar
*dbg_dir
= NULL
;
671 gchar
*bin_dir
= NULL
, *dir_name
= NULL
, *path
= NULL
;
673 if (!bin
|| !bin
->dbg_link_filename
) {
677 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
678 dir_name
= g_path_get_dirname(bin
->elf_path
);
683 bin_dir
= g_strconcat(dir_name
, "/", NULL
);
685 /* First look in the executable's dir */
686 path
= g_strconcat(bin_dir
, bin
->dbg_link_filename
, NULL
);
688 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
692 /* If not found, look in .debug subdir */
694 path
= g_strconcat(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
696 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
700 /* Lastly, look under the global debug directory */
703 path
= g_strconcat(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
704 if (is_valid_debug_file(bin
, path
, bin
->dbg_link_crc
)) {
718 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
727 * Initialize the DWARF info for a given executable.
729 * @param bin bin_info instance
730 * @returns 0 on success, negative value on failure
733 int bin_info_set_dwarf_info(struct bin_info
*bin
)
742 /* First try to set the DWARF info from the ELF file */
743 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
749 * If that fails, try to find separate debug info via build ID
752 ret
= bin_info_set_dwarf_info_build_id(bin
);
757 ret
= bin_info_set_dwarf_info_debug_link(bin
);
767 void source_location_destroy(struct source_location
*src_loc
)
773 free(src_loc
->filename
);
778 * Append a string representation of an address offset to an existing
781 * On success, the out parameter `result` will contain the base string
782 * followed by the offset string of the form "+0x1234". On failure,
783 * `result` remains unchanged.
785 * @param base_str The string to which to append an offset string
786 * @param low_addr The lower virtual memory address, the base from
787 * which the offset is computed
788 * @param high_addr The higher virtual memory address
789 * @param result Out parameter, the base string followed by the
791 * @returns 0 on success, -1 on failure
794 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
795 uint64_t high_addr
, char **result
)
798 char *_result
= NULL
;
800 if (!base_str
|| !result
) {
804 offset
= high_addr
- low_addr
;
806 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
820 * Try to find the symbol closest to an address within a given ELF
823 * Only function symbols are taken into account. The symbol's address
824 * must precede `addr`. A symbol with a closer address might exist
825 * after `addr` but is irrelevant because it cannot encompass `addr`.
827 * On success, if found, the out parameters `sym` and `shdr` are
828 * set. On failure or if none are found, they remain unchanged.
830 * @param scn ELF section in which to look for the address
831 * @param addr Virtual memory address for which to find the
832 * nearest function symbol
833 * @param sym Out parameter, the nearest function symbol
834 * @param shdr Out parameter, the section header for scn
835 * @returns 0 on success, -1 on failure
838 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
839 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
843 Elf_Data
*data
= NULL
;
844 GElf_Shdr
*_shdr
= NULL
;
845 GElf_Sym
*nearest_sym
= NULL
;
847 if (!scn
|| !sym
|| !shdr
) {
851 _shdr
= g_new0(GElf_Shdr
, 1);
856 _shdr
= gelf_getshdr(scn
, _shdr
);
861 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
863 * We are only interested in symbol table (symtab)
864 * sections, skip this one.
869 data
= elf_getdata(scn
, NULL
);
874 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
876 for (i
= 0; i
< symbol_count
; ++i
) {
877 GElf_Sym
*cur_sym
= NULL
;
879 cur_sym
= g_new0(GElf_Sym
, 1);
883 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
887 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
888 /* We're only interested in the functions. */
893 if (cur_sym
->st_value
<= addr
&&
895 cur_sym
->st_value
> nearest_sym
->st_value
)) {
897 nearest_sym
= cur_sym
;
920 * Get the name of the function containing a given address within an
921 * executable using ELF symbols.
923 * The function name is in fact the name of the nearest ELF symbol,
924 * followed by the offset in bytes between the address and the symbol
925 * (in hex), separated by a '+' character.
927 * If found, the out parameter `func_name` is set on success. On failure,
928 * it remains unchanged.
930 * @param bin bin_info instance for the executable containing
932 * @param addr Virtual memory address for which to find the
934 * @param func_name Out parameter, the function name
935 * @returns 0 on success, -1 on failure
938 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
942 * TODO (possible optimisation): if an ELF has no symtab
943 * section, it has been stripped. Therefore, it would be wise
944 * to store a flag indicating the stripped status after the
945 * first iteration to prevent subsequent ones.
949 GElf_Sym
*sym
= NULL
;
950 GElf_Shdr
*shdr
= NULL
;
951 char *sym_name
= NULL
;
953 /* Set ELF file if it hasn't been accessed yet. */
954 if (!bin
->elf_file
) {
955 ret
= bin_info_set_elf_file(bin
);
957 /* Failed to set ELF file. */
962 scn
= elf_nextscn(bin
->elf_file
, scn
);
967 while (scn
&& !sym
) {
968 ret
= bin_info_get_nearest_symbol_from_section(
969 scn
, addr
, &sym
, &shdr
);
974 scn
= elf_nextscn(bin
->elf_file
, scn
);
978 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
984 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
1002 * Get the name of the function containing a given address within a
1003 * given compile unit (CU).
1005 * If found, the out parameter `func_name` is set on success. On
1006 * failure, it remains unchanged.
1008 * @param cu bt_dwarf_cu instance which may contain the address
1009 * @param addr Virtual memory address for which to find the
1011 * @param func_name Out parameter, the function name
1012 * @returns 0 on success, -1 on failure
1015 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1020 struct bt_dwarf_die
*die
= NULL
;
1022 if (!cu
|| !func_name
) {
1026 die
= bt_dwarf_die_create(cu
);
1031 while (bt_dwarf_die_next(die
) == 0) {
1034 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1039 if (tag
== DW_TAG_subprogram
) {
1040 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
1052 uint64_t low_addr
= 0;
1053 char *die_name
= NULL
;
1055 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1060 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1066 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1074 bt_dwarf_die_destroy(die
);
1078 bt_dwarf_die_destroy(die
);
1083 * Get the name of the function containing a given address within an
1084 * executable using DWARF debug info.
1086 * If found, the out parameter `func_name` is set on success. On
1087 * failure, it remains unchanged.
1089 * @param bin bin_info instance for the executable containing
1091 * @param addr Virtual memory address for which to find the
1093 * @param func_name Out parameter, the function name
1094 * @returns 0 on success, -1 on failure
1097 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1101 char *_func_name
= NULL
;
1102 struct bt_dwarf_cu
*cu
= NULL
;
1104 if (!bin
|| !func_name
) {
1108 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1113 while (bt_dwarf_cu_next(cu
) == 0) {
1114 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1125 *func_name
= _func_name
;
1130 bt_dwarf_cu_destroy(cu
);
1134 bt_dwarf_cu_destroy(cu
);
1139 int bin_info_lookup_function_name(struct bin_info
*bin
,
1140 uint64_t addr
, char **func_name
)
1143 char *_func_name
= NULL
;
1145 if (!bin
|| !func_name
) {
1150 * If the bin_info has a build id but it does not match the build id
1151 * that was found on the file system, return an error.
1153 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1157 /* Set DWARF info if it hasn't been accessed yet. */
1158 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1159 ret
= bin_info_set_dwarf_info(bin
);
1161 BT_LOGD_STR("Failed to set bin dwarf info, falling "
1162 "back to ELF lookup.");
1163 /* Failed to set DWARF info, fallback to ELF. */
1164 bin
->is_elf_only
= true;
1168 if (!bin_info_has_address(bin
, addr
)) {
1173 * Addresses in ELF and DWARF are relative to base address for
1174 * PIC, so make the address argument relative too if needed.
1177 addr
-= bin
->low_addr
;
1180 if (bin
->is_elf_only
) {
1181 ret
= bin_info_lookup_elf_function_name(bin
, addr
,
1184 BT_LOGD("Failed to lookup function name (ELF): "
1188 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
,
1191 BT_LOGD("Failed to lookup function name (DWARF): "
1196 *func_name
= _func_name
;
1204 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1206 gchar
*_bin_loc
= NULL
;
1208 if (!bin
|| !bin_loc
) {
1213 * If the bin_info has a build id but it does not match the build id
1214 * that was found on the file system, return an error.
1216 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1221 addr
-= bin
->low_addr
;
1222 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1224 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1231 *bin_loc
= _bin_loc
;
1239 * Predicate used to determine whether the children of a given DIE
1240 * contain a specific address.
1242 * More specifically, the parameter `die` is expected to be a
1243 * subprogram (function) DIE, and this predicate tells whether any
1244 * subroutines are inlined within this function and would contain
1247 * On success, the out parameter `contains` is set with the boolean
1248 * value indicating whether the DIE's range covers `addr`. On failure,
1249 * it remains unchanged.
1251 * Do note that this function advances the position of `die`. If the
1252 * address is found within one of its children, `die` will be pointing
1253 * to that child upon returning from the function, allowing to extract
1254 * the information deemed necessary.
1256 * @param die The parent DIE in whose children the address will be
1258 * @param addr The address for which to look for in the DIEs
1259 * @param contains Out parameter, true if addr is contained,
1261 * @returns Returns 0 on success, -1 on failure
1264 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1267 bool _contains
= false;
1273 ret
= bt_dwarf_die_child(die
);
1279 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1286 * The address is within the range of the current DIE
1291 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1296 if (tag
== DW_TAG_inlined_subroutine
) {
1297 /* Found the tracepoint. */
1301 if (bt_dwarf_die_has_children(die
)) {
1303 * Look for the address in the children DIEs.
1305 ret
= bt_dwarf_die_child(die
);
1311 } while (bt_dwarf_die_next(die
) == 0);
1314 *contains
= _contains
;
1322 * Lookup the source location for a given address within a CU, making
1323 * the assumption that it is contained within an inline routine in a
1326 * @param cu bt_dwarf_cu instance in which to look for the address
1327 * @param addr The address for which to look for
1328 * @param src_loc Out parameter, the source location (filename and
1329 * line number) for the address
1330 * @returns 0 on success, -1 on failure
1333 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1334 struct source_location
**src_loc
)
1338 struct bt_dwarf_die
*die
= NULL
;
1339 struct source_location
*_src_loc
= NULL
;
1341 if (!cu
|| !src_loc
) {
1345 die
= bt_dwarf_die_create(cu
);
1350 while (bt_dwarf_die_next(die
) == 0) {
1353 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1358 if (tag
== DW_TAG_subprogram
) {
1359 bool contains
= false;
1361 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1368 * Try to find an inlined subroutine
1369 * child of this DIE containing addr.
1371 ret
= bin_info_child_die_has_address(die
, addr
,
1384 char *filename
= NULL
;
1387 _src_loc
= g_new0(struct source_location
, 1);
1392 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1396 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1402 _src_loc
->filename
= filename
;
1403 _src_loc
->line_no
= line_no
;
1404 *src_loc
= _src_loc
;
1407 bt_dwarf_die_destroy(die
);
1411 source_location_destroy(_src_loc
);
1412 bt_dwarf_die_destroy(die
);
1417 * Lookup the source location for a given address within a CU,
1418 * assuming that it is contained within an inlined function.
1420 * A source location can be found regardless of inlining status for
1421 * this method, but in the case of an inlined function, the returned
1422 * source location will point not to the callsite but rather to the
1423 * definition site of the inline function.
1425 * @param cu bt_dwarf_cu instance in which to look for the address
1426 * @param addr The address for which to look for
1427 * @param src_loc Out parameter, the source location (filename and
1428 * line number) for the address
1429 * @returns 0 on success, -1 on failure
1432 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1433 struct source_location
**src_loc
)
1435 struct source_location
*_src_loc
= NULL
;
1436 struct bt_dwarf_die
*die
= NULL
;
1437 const char *filename
= NULL
;
1438 Dwarf_Line
*line
= NULL
;
1439 Dwarf_Addr line_addr
;
1442 if (!cu
|| !src_loc
) {
1446 die
= bt_dwarf_die_create(cu
);
1451 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1456 ret
= dwarf_lineaddr(line
, &line_addr
);
1461 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1466 if (addr
== line_addr
) {
1467 _src_loc
= g_new0(struct source_location
, 1);
1472 ret
= dwarf_lineno(line
, &line_no
);
1477 _src_loc
->line_no
= line_no
;
1478 _src_loc
->filename
= g_strdup(filename
);
1481 bt_dwarf_die_destroy(die
);
1484 *src_loc
= _src_loc
;
1490 source_location_destroy(_src_loc
);
1491 bt_dwarf_die_destroy(die
);
1496 * Get the source location (file name and line number) for a given
1497 * address within a compile unit (CU).
1499 * On success, the out parameter `src_loc` is set if found. On
1500 * failure, it remains unchanged.
1502 * @param cu bt_dwarf_cu instance for the compile unit which
1503 * may contain the address
1504 * @param addr Virtual memory address for which to find the
1506 * @param src_loc Out parameter, the source location
1507 * @returns 0 on success, -1 on failure
1510 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1511 struct source_location
**src_loc
)
1514 struct source_location
*_src_loc
= NULL
;
1516 if (!cu
|| !src_loc
) {
1520 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1529 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1540 *src_loc
= _src_loc
;
1546 source_location_destroy(_src_loc
);
1551 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1552 struct source_location
**src_loc
)
1554 struct bt_dwarf_cu
*cu
= NULL
;
1555 struct source_location
*_src_loc
= NULL
;
1557 if (!bin
|| !src_loc
) {
1562 * If the bin_info has a build id but it does not match the build id
1563 * that was found on the file system, return an error.
1565 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1569 /* Set DWARF info if it hasn't been accessed yet. */
1570 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1571 if (bin_info_set_dwarf_info(bin
)) {
1572 /* Failed to set DWARF info. */
1573 bin
->is_elf_only
= true;
1577 if (bin
->is_elf_only
) {
1578 /* We cannot lookup source location without DWARF info. */
1582 if (!bin_info_has_address(bin
, addr
)) {
1587 * Addresses in ELF and DWARF are relative to base address for
1588 * PIC, so make the address argument relative too if needed.
1591 addr
-= bin
->low_addr
;
1594 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1599 while (bt_dwarf_cu_next(cu
) == 0) {
1602 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1612 bt_dwarf_cu_destroy(cu
);
1614 *src_loc
= _src_loc
;
1620 source_location_destroy(_src_loc
);
1621 bt_dwarf_cu_destroy(cu
);