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"
49 * An address printed in hex is at most 20 bytes (16 for 64-bits +
50 * leading 0x + optional leading '+' if addr is an offset + null
53 #define ADDR_STR_LEN 20
54 #define BUILD_ID_NOTE_NAME "GNU"
57 int bin_info_init(void)
61 if (elf_version(EV_CURRENT
) == EV_NONE
) {
62 BT_LOGD("ELF library initialization failed: %s.",
71 struct bin_info
*bin_info_create(const char *path
, uint64_t low_addr
,
72 uint64_t memsz
, bool is_pic
, const char *debug_info_dir
,
73 const char *target_prefix
)
75 struct bin_info
*bin
= NULL
;
81 bin
= g_new0(struct bin_info
, 1);
87 bin
->elf_path
= g_build_path("/", target_prefix
,
90 bin
->elf_path
= g_strdup(path
);
98 bin
->debug_info_dir
= g_strdup(debug_info_dir
);
99 if (!bin
->debug_info_dir
) {
104 bin
->is_pic
= is_pic
;
106 bin
->low_addr
= low_addr
;
107 bin
->high_addr
= bin
->low_addr
+ bin
->memsz
;
108 bin
->build_id
= NULL
;
109 bin
->build_id_len
= 0;
110 bin
->file_build_id_matches
= false;
115 bin_info_destroy(bin
);
120 void bin_info_destroy(struct bin_info
*bin
)
126 dwarf_end(bin
->dwarf_info
);
128 g_free(bin
->debug_info_dir
);
129 g_free(bin
->elf_path
);
130 g_free(bin
->dwarf_path
);
131 g_free(bin
->build_id
);
132 g_free(bin
->dbg_link_filename
);
134 elf_end(bin
->elf_file
);
137 close(bin
->dwarf_fd
);
143 * Initialize the ELF file for a given executable.
145 * @param bin bin_info instance
146 * @returns 0 on success, negative value on error.
149 int bin_info_set_elf_file(struct bin_info
*bin
)
152 Elf
*elf_file
= NULL
;
158 elf_fd
= open(bin
->elf_path
, O_RDONLY
);
161 BT_LOGE("Failed to open %s\n", bin
->elf_path
);
165 elf_file
= elf_begin(elf_fd
, ELF_C_READ
, NULL
);
167 BT_LOGE("elf_begin failed: %s\n", elf_errmsg(-1));
171 if (elf_kind(elf_file
) != ELF_K_ELF
) {
172 BT_LOGE("Error: %s is not an ELF object\n",
177 bin
->elf_fd
= elf_fd
;
178 bin
->elf_file
= elf_file
;
191 * From a note section data buffer, check if it is a build id note.
193 * @param buf Pointer to a note section
195 * @returns 1 on match, 0 if `buf` does not contain a
196 * valid build id note
199 int is_build_id_note_section(uint8_t *buf
)
202 uint32_t name_sz
, desc_sz
, note_type
;
204 /* The note section header has 3 32bit integer for the following:
205 * - Section name size
209 name_sz
= (uint32_t) *buf
;
210 buf
+= sizeof(name_sz
);
212 buf
+= sizeof(desc_sz
);
214 note_type
= (uint32_t) *buf
;
215 buf
+= sizeof(note_type
);
217 /* Check the note type. */
218 if (note_type
!= NT_GNU_BUILD_ID
) {
222 /* Check the note name. */
223 if (memcmp(buf
, BUILD_ID_NOTE_NAME
, name_sz
) != 0) {
234 * From a build id note section data buffer, check if the build id it contains
235 * is identical to the build id passed as parameter.
237 * @param file_build_id_note Pointer to the file build id note section.
238 * @param build_id Pointer to a build id to compare to.
239 * @param build_id_len length of the build id.
241 * @returns 1 on match, 0 otherwise.
244 int is_build_id_note_section_matching(uint8_t *file_build_id_note
,
245 uint8_t *build_id
, size_t build_id_len
)
247 uint32_t name_sz
, desc_sz
, note_type
;
249 if (build_id_len
<= 0) {
253 /* The note section header has 3 32bit integer for the following:
254 * - Section name size
258 name_sz
= (uint32_t) *file_build_id_note
;
259 file_build_id_note
+= sizeof(name_sz
);
260 file_build_id_note
+= sizeof(desc_sz
);
261 file_build_id_note
+= sizeof(note_type
);
264 * Move the pointer pass the name char array. This corresponds to the
265 * beginning of the description section. The description is the build
266 * id in the case of a build id note.
268 file_build_id_note
+= name_sz
;
271 * Compare the binary build id with the supplied build id.
273 if (memcmp(build_id
, file_build_id_note
, build_id_len
) == 0) {
281 * Checks if the build id stored in `bin` (bin->build_id) is matching the build
282 * id of the ondisk file (bin->elf_file).
284 * @param bin bin_info instance
285 * @param build_id build id to compare ot the on disk file
286 * @param build_id_len length of the build id
288 * @returns 1 on if the build id of stored in `bin` matches
289 * the build id of the ondisk file.
290 * 0 on if they are different or an error occured.
293 int is_build_id_matching(struct bin_info
*bin
)
295 int ret
, is_build_id
, is_matching
= 0;
296 Elf_Scn
*curr_section
= NULL
, *next_section
= NULL
;
297 Elf_Data
*note_data
= NULL
;
298 GElf_Shdr
*curr_section_hdr
= NULL
;
300 if (!bin
->build_id
) {
304 /* Set ELF file if it hasn't been accessed yet. */
305 if (!bin
->elf_file
) {
306 ret
= bin_info_set_elf_file(bin
);
308 /* Failed to set ELF file. */
313 curr_section_hdr
= g_new0(GElf_Shdr
, 1);
314 if (!curr_section_hdr
) {
318 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
323 while (next_section
) {
324 curr_section
= next_section
;
325 next_section
= elf_nextscn(bin
->elf_file
, curr_section
);
327 curr_section_hdr
= gelf_getshdr(curr_section
, curr_section_hdr
);
329 if (!curr_section_hdr
) {
333 if (curr_section_hdr
->sh_type
!= SHT_NOTE
) {
337 note_data
= elf_getdata(curr_section
, NULL
);
342 /* Check if the note is of the build-id type. */
343 is_build_id
= is_build_id_note_section(note_data
->d_buf
);
349 * Compare the build id of the on-disk file and
350 * the build id recorded in the trace.
352 is_matching
= is_build_id_note_section_matching(note_data
->d_buf
,
353 bin
->build_id
, bin
->build_id_len
);
359 g_free(curr_section_hdr
);
364 int bin_info_set_build_id(struct bin_info
*bin
, uint8_t *build_id
,
367 if (!bin
|| !build_id
) {
371 /* Set the build id. */
372 bin
->build_id
= g_new0(uint8_t, build_id_len
);
373 if (!bin
->build_id
) {
377 memcpy(bin
->build_id
, build_id
, build_id_len
);
378 bin
->build_id_len
= build_id_len
;
381 * Check if the file found on the file system has the same build id
382 * that what was recorded in the trace.
384 bin
->file_build_id_matches
= is_build_id_matching(bin
);
385 if (!bin
->file_build_id_matches
) {
386 BT_LOGD_STR("Supplied Build ID does not match Build ID of the "
387 "binary or library found on the file system.");
392 * Reset the is_elf_only flag in case it had been set
393 * previously, because we might find separate debug info using
394 * the new build id information.
396 bin
->is_elf_only
= false;
405 int bin_info_set_debug_link(struct bin_info
*bin
, const char *filename
,
408 if (!bin
|| !filename
) {
412 bin
->dbg_link_filename
= g_strdup(filename
);
413 if (!bin
->dbg_link_filename
) {
417 bin
->dbg_link_crc
= crc
;
420 * Reset the is_elf_only flag in case it had been set
421 * previously, because we might find separate debug info using
422 * the new build id information.
424 bin
->is_elf_only
= false;
434 * Tries to read DWARF info from the location given by path, and
435 * attach it to the given bin_info instance if it exists.
437 * @param bin bin_info instance for which to set DWARF info
438 * @param path Presumed location of the DWARF info
439 * @returns 0 on success, negative value on failure
442 int bin_info_set_dwarf_info_from_path(struct bin_info
*bin
, char *path
)
444 int fd
= -1, ret
= 0;
445 struct bt_dwarf_cu
*cu
= NULL
;
446 Dwarf
*dwarf_info
= NULL
;
452 fd
= open(path
, O_RDONLY
);
458 dwarf_info
= dwarf_begin(fd
, DWARF_C_READ
);
464 * Check if the dwarf info has any CU. If not, the
465 * executable's object file contains no DWARF info.
467 cu
= bt_dwarf_cu_create(dwarf_info
);
472 ret
= bt_dwarf_cu_next(cu
);
478 bin
->dwarf_path
= g_strdup(path
);
479 if (!bin
->dwarf_path
) {
482 bin
->dwarf_info
= dwarf_info
;
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_file
= NULL
;
512 const char *dbg_dir
= NULL
;
513 size_t build_id_file_len
;
515 if (!bin
|| !bin
->build_id
) {
519 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
521 /* 2 characters per byte printed in hex, +1 for '/' and +1 for '\0' */
522 build_id_file_len
= (2 * bin
->build_id_len
) + 1 +
523 strlen(BUILD_ID_SUFFIX
) + 1;
524 build_id_file
= g_new0(gchar
, build_id_file_len
);
525 if (!build_id_file
) {
529 g_snprintf(build_id_file
, 4, "%02x/", bin
->build_id
[0]);
530 for (i
= 1; i
< bin
->build_id_len
; ++i
) {
531 int path_idx
= 3 + 2 * (i
- 1);
533 g_snprintf(&build_id_file
[path_idx
], 3, "%02x", bin
->build_id
[i
]);
535 g_strconcat(build_id_file
, BUILD_ID_SUFFIX
, NULL
);
537 path
= g_build_path("/", dbg_dir
, BUILD_ID_SUBDIR
, build_id_file
, NULL
);
542 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
559 * Tests whether the file located at path exists and has the expected
562 * This predicate is used when looking up separate debug info via the
563 * GNU debuglink method. The expected crc can be found .gnu_debuglink
564 * section in the original ELF file, along with the filename for the
565 * file containing the debug info.
567 * @param path Full path at which to look for the debug file
568 * @param crc Expected checksum for the debug file
569 * @returns 1 if the file exists and has the correct checksum,
573 int is_valid_debug_file(char *path
, uint32_t crc
)
575 int ret
= 0, fd
= -1;
582 fd
= open(path
, O_RDONLY
);
587 ret
= crc32(fd
, &_crc
);
602 * Try to set the dwarf_info for a given bin_info instance via the
605 * @param bin bin_info instance for which to retrieve the
606 * DWARF info via debug link
607 * @returns 0 on success (i.e. dwarf_info set), -1 on failure
610 int bin_info_set_dwarf_info_debug_link(struct bin_info
*bin
)
613 const gchar
*dbg_dir
= NULL
;
614 gchar
*bin_dir
= NULL
, *dir_name
= NULL
, *path
= NULL
;
616 if (!bin
|| !bin
->dbg_link_filename
) {
620 dbg_dir
= bin
->debug_info_dir
? bin
->debug_info_dir
: DEFAULT_DEBUG_DIR
;
621 dir_name
= g_path_get_dirname(bin
->elf_path
);
626 bin_dir
= g_strconcat(dir_name
, "/", NULL
);
628 /* First look in the executable's dir */
629 path
= g_strconcat(bin_dir
, bin
->dbg_link_filename
, NULL
);
631 if (is_valid_debug_file(path
, bin
->dbg_link_crc
)) {
635 /* If not found, look in .debug subdir */
637 path
= g_strconcat(bin_dir
, DEBUG_SUBDIR
, bin
->dbg_link_filename
, NULL
);
639 if (is_valid_debug_file(path
, bin
->dbg_link_crc
)) {
643 /* Lastly, look under the global debug directory */
646 path
= g_strconcat(dbg_dir
, bin_dir
, bin
->dbg_link_filename
, NULL
);
647 if (is_valid_debug_file(path
, bin
->dbg_link_crc
)) {
660 ret
= bin_info_set_dwarf_info_from_path(bin
, path
);
669 * Initialize the DWARF info for a given executable.
671 * @param bin bin_info instance
672 * @returns 0 on success, negative value on failure
675 int bin_info_set_dwarf_info(struct bin_info
*bin
)
684 /* First try to set the DWARF info from the ELF file */
685 ret
= bin_info_set_dwarf_info_from_path(bin
, bin
->elf_path
);
691 * If that fails, try to find separate debug info via build ID
694 ret
= bin_info_set_dwarf_info_build_id(bin
);
699 ret
= bin_info_set_dwarf_info_debug_link(bin
);
709 void source_location_destroy(struct source_location
*src_loc
)
715 free(src_loc
->filename
);
720 * Append a string representation of an address offset to an existing
723 * On success, the out parameter `result` will contain the base string
724 * followed by the offset string of the form "+0x1234". On failure,
725 * `result` remains unchanged.
727 * @param base_str The string to which to append an offset string
728 * @param low_addr The lower virtual memory address, the base from
729 * which the offset is computed
730 * @param high_addr The higher virtual memory address
731 * @param result Out parameter, the base string followed by the
733 * @returns 0 on success, -1 on failure
736 int bin_info_append_offset_str(const char *base_str
, uint64_t low_addr
,
737 uint64_t high_addr
, char **result
)
740 char *_result
= NULL
;
743 if (!base_str
|| !result
) {
747 offset
= high_addr
- low_addr
;
749 _result
= g_strdup_printf("%s+%#0" PRIx64
, base_str
, offset
);
763 * Try to find the symbol closest to an address within a given ELF
766 * Only function symbols are taken into account. The symbol's address
767 * must precede `addr`. A symbol with a closer address might exist
768 * after `addr` but is irrelevant because it cannot encompass `addr`.
770 * On success, if found, the out parameters `sym` and `shdr` are
771 * set. On failure or if none are found, they remain unchanged.
773 * @param scn ELF section in which to look for the address
774 * @param addr Virtual memory address for which to find the
775 * nearest function symbol
776 * @param sym Out parameter, the nearest function symbol
777 * @param shdr Out parameter, the section header for scn
778 * @returns 0 on success, -1 on failure
781 int bin_info_get_nearest_symbol_from_section(Elf_Scn
*scn
, uint64_t addr
,
782 GElf_Sym
**sym
, GElf_Shdr
**shdr
)
786 Elf_Data
*data
= NULL
;
787 GElf_Shdr
*_shdr
= NULL
;
788 GElf_Sym
*nearest_sym
= NULL
;
790 if (!scn
|| !sym
|| !shdr
) {
794 _shdr
= g_new0(GElf_Shdr
, 1);
799 _shdr
= gelf_getshdr(scn
, _shdr
);
804 if (_shdr
->sh_type
!= SHT_SYMTAB
) {
806 * We are only interested in symbol table (symtab)
807 * sections, skip this one.
812 data
= elf_getdata(scn
, NULL
);
817 symbol_count
= _shdr
->sh_size
/ _shdr
->sh_entsize
;
819 for (i
= 0; i
< symbol_count
; ++i
) {
820 GElf_Sym
*cur_sym
= NULL
;
822 cur_sym
= g_new0(GElf_Sym
, 1);
826 cur_sym
= gelf_getsym(data
, i
, cur_sym
);
830 if (GELF_ST_TYPE(cur_sym
->st_info
) != STT_FUNC
) {
831 /* We're only interested in the functions. */
836 if (cur_sym
->st_value
<= addr
&&
838 cur_sym
->st_value
> nearest_sym
->st_value
)) {
840 nearest_sym
= cur_sym
;
863 * Get the name of the function containing a given address within an
864 * executable using ELF symbols.
866 * The function name is in fact the name of the nearest ELF symbol,
867 * followed by the offset in bytes between the address and the symbol
868 * (in hex), separated by a '+' character.
870 * If found, the out parameter `func_name` is set on success. On failure,
871 * it remains unchanged.
873 * @param bin bin_info instance for the executable containing
875 * @param addr Virtual memory address for which to find the
877 * @param func_name Out parameter, the function name
878 * @returns 0 on success, -1 on failure
881 int bin_info_lookup_elf_function_name(struct bin_info
*bin
, uint64_t addr
,
885 * TODO (possible optimisation): if an ELF has no symtab
886 * section, it has been stripped. Therefore, it would be wise
887 * to store a flag indicating the stripped status after the
888 * first iteration to prevent subsequent ones.
892 GElf_Sym
*sym
= NULL
;
893 GElf_Shdr
*shdr
= NULL
;
894 char *sym_name
= NULL
;
896 /* Set ELF file if it hasn't been accessed yet. */
897 if (!bin
->elf_file
) {
898 ret
= bin_info_set_elf_file(bin
);
900 /* Failed to set ELF file. */
905 scn
= elf_nextscn(bin
->elf_file
, scn
);
910 while (scn
&& !sym
) {
911 ret
= bin_info_get_nearest_symbol_from_section(
912 scn
, addr
, &sym
, &shdr
);
917 scn
= elf_nextscn(bin
->elf_file
, scn
);
921 sym_name
= elf_strptr(bin
->elf_file
, shdr
->sh_link
,
927 ret
= bin_info_append_offset_str(sym_name
, sym
->st_value
, addr
,
945 * Get the name of the function containing a given address within a
946 * given compile unit (CU).
948 * If found, the out parameter `func_name` is set on success. On
949 * failure, it remains unchanged.
951 * @param cu bt_dwarf_cu instance which may contain the address
952 * @param addr Virtual memory address for which to find the
954 * @param func_name Out parameter, the function name
955 * @returns 0 on success, -1 on failure
958 int bin_info_lookup_cu_function_name(struct bt_dwarf_cu
*cu
, uint64_t addr
,
963 struct bt_dwarf_die
*die
= NULL
;
965 if (!cu
|| !func_name
) {
969 die
= bt_dwarf_die_create(cu
);
974 while (bt_dwarf_die_next(die
) == 0) {
977 ret
= bt_dwarf_die_get_tag(die
, &tag
);
982 if (tag
== DW_TAG_subprogram
) {
983 ret
= bt_dwarf_die_contains_addr(die
, addr
, &found
);
995 uint64_t low_addr
= 0;
996 char *die_name
= NULL
;
998 ret
= bt_dwarf_die_get_name(die
, &die_name
);
1003 ret
= dwarf_lowpc(die
->dwarf_die
, &low_addr
);
1009 ret
= bin_info_append_offset_str(die_name
, low_addr
, addr
,
1017 bt_dwarf_die_destroy(die
);
1021 bt_dwarf_die_destroy(die
);
1026 * Get the name of the function containing a given address within an
1027 * executable using DWARF debug info.
1029 * If found, the out parameter `func_name` is set on success. On
1030 * failure, it remains unchanged.
1032 * @param bin bin_info instance for the executable containing
1034 * @param addr Virtual memory address for which to find the
1036 * @param func_name Out parameter, the function name
1037 * @returns 0 on success, -1 on failure
1040 int bin_info_lookup_dwarf_function_name(struct bin_info
*bin
, uint64_t addr
,
1044 char *_func_name
= NULL
;
1045 struct bt_dwarf_cu
*cu
= NULL
;
1047 if (!bin
|| !func_name
) {
1051 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1056 while (bt_dwarf_cu_next(cu
) == 0) {
1057 ret
= bin_info_lookup_cu_function_name(cu
, addr
, &_func_name
);
1068 *func_name
= _func_name
;
1073 bt_dwarf_cu_destroy(cu
);
1077 bt_dwarf_cu_destroy(cu
);
1082 int bin_info_lookup_function_name(struct bin_info
*bin
,
1083 uint64_t addr
, char **func_name
)
1086 char *_func_name
= NULL
;
1088 if (!bin
|| !func_name
) {
1093 * If the bin_info has a build id but it does not match the build id
1094 * that was found on the file system, return an error.
1096 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1100 /* Set DWARF info if it hasn't been accessed yet. */
1101 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1102 ret
= bin_info_set_dwarf_info(bin
);
1104 BT_LOGD_STR("Failed to set bin dwarf info, falling back to ELF lookup.");
1105 /* Failed to set DWARF info, fallback to ELF. */
1106 bin
->is_elf_only
= true;
1110 if (!bin_info_has_address(bin
, addr
)) {
1115 * Addresses in ELF and DWARF are relative to base address for
1116 * PIC, so make the address argument relative too if needed.
1119 addr
-= bin
->low_addr
;
1122 if (bin
->is_elf_only
) {
1123 ret
= bin_info_lookup_elf_function_name(bin
, addr
, &_func_name
);
1124 BT_LOGD("Failed to lookup function name (ELF): ret=%d", ret
);
1126 ret
= bin_info_lookup_dwarf_function_name(bin
, addr
, &_func_name
);
1127 BT_LOGD("Failed to lookup function name (DWARF): ret=%d", ret
);
1130 *func_name
= _func_name
;
1138 int bin_info_get_bin_loc(struct bin_info
*bin
, uint64_t addr
, char **bin_loc
)
1140 gchar
*_bin_loc
= NULL
;
1142 if (!bin
|| !bin_loc
) {
1147 * If the bin_info has a build id but it does not match the build id
1148 * that was found on the file system, return an error.
1150 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1155 addr
-= bin
->low_addr
;
1156 _bin_loc
= g_strdup_printf("+%#0" PRIx64
, addr
);
1158 _bin_loc
= g_strdup_printf("@%#0" PRIx64
, addr
);
1165 *bin_loc
= _bin_loc
;
1173 * Predicate used to determine whether the children of a given DIE
1174 * contain a specific address.
1176 * More specifically, the parameter `die` is expected to be a
1177 * subprogram (function) DIE, and this predicate tells whether any
1178 * subroutines are inlined within this function and would contain
1181 * On success, the out parameter `contains` is set with the boolean
1182 * value indicating whether the DIE's range covers `addr`. On failure,
1183 * it remains unchanged.
1185 * Do note that this function advances the position of `die`. If the
1186 * address is found within one of its children, `die` will be pointing
1187 * to that child upon returning from the function, allowing to extract
1188 * the information deemed necessary.
1190 * @param die The parent DIE in whose children the address will be
1192 * @param addr The address for which to look for in the DIEs
1193 * @param contains Out parameter, true if addr is contained,
1195 * @returns Returns 0 on success, -1 on failure
1198 int bin_info_child_die_has_address(struct bt_dwarf_die
*die
, uint64_t addr
, bool *contains
)
1201 bool _contains
= false;
1207 ret
= bt_dwarf_die_child(die
);
1215 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1220 if (tag
== DW_TAG_inlined_subroutine
) {
1221 ret
= bt_dwarf_die_contains_addr(die
, addr
, &_contains
);
1230 } while (bt_dwarf_die_next(die
) == 0);
1233 *contains
= _contains
;
1241 * Lookup the source location for a given address within a CU, making
1242 * the assumption that it is contained within an inline routine in a
1245 * @param cu bt_dwarf_cu instance in which to look for the address
1246 * @param addr The address for which to look for
1247 * @param src_loc Out parameter, the source location (filename and
1248 * line number) for the address
1249 * @returns 0 on success, -1 on failure
1252 int bin_info_lookup_cu_src_loc_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1253 struct source_location
**src_loc
)
1257 struct bt_dwarf_die
*die
= NULL
;
1258 struct source_location
*_src_loc
= NULL
;
1260 if (!cu
|| !src_loc
) {
1264 die
= bt_dwarf_die_create(cu
);
1269 while (bt_dwarf_die_next(die
) == 0) {
1272 ret
= bt_dwarf_die_get_tag(die
, &tag
);
1277 if (tag
== DW_TAG_subprogram
) {
1278 bool contains
= false;
1280 ret
= bt_dwarf_die_contains_addr(die
, addr
, &contains
);
1287 * Try to find an inlined subroutine
1288 * child of this DIE containing addr.
1290 ret
= bin_info_child_die_has_address(die
, addr
,
1303 char *filename
= NULL
;
1306 _src_loc
= g_new0(struct source_location
, 1);
1311 ret
= bt_dwarf_die_get_call_file(die
, &filename
);
1315 ret
= bt_dwarf_die_get_call_line(die
, &line_no
);
1321 _src_loc
->filename
= filename
;
1322 _src_loc
->line_no
= line_no
;
1323 *src_loc
= _src_loc
;
1326 bt_dwarf_die_destroy(die
);
1330 source_location_destroy(_src_loc
);
1331 bt_dwarf_die_destroy(die
);
1336 * Lookup the source location for a given address within a CU,
1337 * assuming that it is contained within an inlined function.
1339 * A source location can be found regardless of inlining status for
1340 * this method, but in the case of an inlined function, the returned
1341 * source location will point not to the callsite but rather to the
1342 * definition site of the inline function.
1344 * @param cu bt_dwarf_cu instance in which to look for the address
1345 * @param addr The address for which to look for
1346 * @param src_loc Out parameter, the source location (filename and
1347 * line number) for the address
1348 * @returns 0 on success, -1 on failure
1351 int bin_info_lookup_cu_src_loc_no_inl(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1352 struct source_location
**src_loc
)
1354 struct source_location
*_src_loc
= NULL
;
1355 struct bt_dwarf_die
*die
= NULL
;
1356 const char *filename
= NULL
;
1357 Dwarf_Line
*line
= NULL
;
1358 Dwarf_Addr line_addr
;
1361 if (!cu
|| !src_loc
) {
1365 die
= bt_dwarf_die_create(cu
);
1370 line
= dwarf_getsrc_die(die
->dwarf_die
, addr
);
1375 ret
= dwarf_lineaddr(line
, &line_addr
);
1380 filename
= dwarf_linesrc(line
, NULL
, NULL
);
1385 if (addr
== line_addr
) {
1386 _src_loc
= g_new0(struct source_location
, 1);
1391 ret
= dwarf_lineno(line
, &line_no
);
1396 _src_loc
->line_no
= line_no
;
1397 _src_loc
->filename
= g_strdup(filename
);
1400 bt_dwarf_die_destroy(die
);
1403 *src_loc
= _src_loc
;
1409 source_location_destroy(_src_loc
);
1410 bt_dwarf_die_destroy(die
);
1415 * Get the source location (file name and line number) for a given
1416 * address within a compile unit (CU).
1418 * On success, the out parameter `src_loc` is set if found. On
1419 * failure, it remains unchanged.
1421 * @param cu bt_dwarf_cu instance for the compile unit which
1422 * may contain the address
1423 * @param addr Virtual memory address for which to find the
1425 * @param src_loc Out parameter, the source location
1426 * @returns 0 on success, -1 on failure
1429 int bin_info_lookup_cu_src_loc(struct bt_dwarf_cu
*cu
, uint64_t addr
,
1430 struct source_location
**src_loc
)
1433 struct source_location
*_src_loc
= NULL
;
1435 if (!cu
|| !src_loc
) {
1439 ret
= bin_info_lookup_cu_src_loc_inl(cu
, addr
, &_src_loc
);
1448 ret
= bin_info_lookup_cu_src_loc_no_inl(cu
, addr
, &_src_loc
);
1459 *src_loc
= _src_loc
;
1465 source_location_destroy(_src_loc
);
1470 int bin_info_lookup_source_location(struct bin_info
*bin
, uint64_t addr
,
1471 struct source_location
**src_loc
)
1473 struct bt_dwarf_cu
*cu
= NULL
;
1474 struct source_location
*_src_loc
= NULL
;
1476 if (!bin
|| !src_loc
) {
1481 * If the bin_info has a build id but it does not match the build id
1482 * that was found on the file system, return an error.
1484 if (bin
->build_id
&& !bin
->file_build_id_matches
) {
1488 /* Set DWARF info if it hasn't been accessed yet. */
1489 if (!bin
->dwarf_info
&& !bin
->is_elf_only
) {
1490 if (bin_info_set_dwarf_info(bin
)) {
1491 /* Failed to set DWARF info. */
1492 bin
->is_elf_only
= true;
1496 if (bin
->is_elf_only
) {
1497 /* We cannot lookup source location without DWARF info. */
1501 if (!bin_info_has_address(bin
, addr
)) {
1506 * Addresses in ELF and DWARF are relative to base address for
1507 * PIC, so make the address argument relative too if needed.
1510 addr
-= bin
->low_addr
;
1513 cu
= bt_dwarf_cu_create(bin
->dwarf_info
);
1518 while (bt_dwarf_cu_next(cu
) == 0) {
1521 ret
= bin_info_lookup_cu_src_loc(cu
, addr
, &_src_loc
);
1531 bt_dwarf_cu_destroy(cu
);
1533 *src_loc
= _src_loc
;
1539 source_location_destroy(_src_loc
);
1540 bt_dwarf_cu_destroy(cu
);