2 * dwarf-aux.c : libdw auxiliary interfaces
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include "dwarf-aux.h"
29 * cu_find_realpath - Find the realpath of the target file
30 * @cu_die: A DIE(dwarf information entry) of CU(compilation Unit)
31 * @fname: The tail filename of the target file
33 * Find the real(long) path of @fname in @cu_die.
35 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
39 const char *src = NULL;
45 ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
49 for (i = 0; i < nfiles; i++) {
50 src = dwarf_filesrc(files, i, NULL, NULL);
51 if (strtailcmp(src, fname) == 0)
60 * cu_get_comp_dir - Get the path of compilation directory
63 * Get the path of compilation directory of given @cu_die.
64 * Since this depends on DW_AT_comp_dir, older gcc will not
65 * embedded it. In that case, this returns NULL.
67 const char *cu_get_comp_dir(Dwarf_Die *cu_die)
70 if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
72 return dwarf_formstring(&attr);
76 * cu_find_lineinfo - Get a line number and file name for given address
79 * @fname: a pointer which returns the file name string
80 * @lineno: a pointer which returns the line number
82 * Find a line number and file name for @addr in @cu_die.
84 int cu_find_lineinfo(Dwarf_Die *cu_die, unsigned long addr,
85 const char **fname, int *lineno)
90 line = dwarf_getsrc_die(cu_die, (Dwarf_Addr)addr);
91 if (line && dwarf_lineaddr(line, &laddr) == 0 &&
92 addr == (unsigned long)laddr && dwarf_lineno(line, lineno) == 0) {
93 *fname = dwarf_linesrc(line, NULL, NULL);
95 /* line number is useless without filename */
99 return *lineno ?: -ENOENT;
102 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data);
105 * cu_walk_functions_at - Walk on function DIEs at given address
108 * @callback: A callback which called with found DIEs
111 * Walk on function DIEs at given @addr in @cu_die. Passed DIEs
112 * should be subprogram or inlined-subroutines.
114 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
115 int (*callback)(Dwarf_Die *, void *), void *data)
121 /* Inlined function could be recursive. Trace it until fail */
122 for (sc_die = die_find_realfunc(cu_die, addr, &die_mem);
124 sc_die = die_find_child(sc_die, __die_find_inline_cb, &addr,
126 ret = callback(sc_die, data);
136 * die_get_linkage_name - Get the linkage name of the object
137 * @dw_die: A DIE of the object
139 * Get the linkage name attiribute of given @dw_die.
140 * For C++ binary, the linkage name will be the mangled symbol.
142 const char *die_get_linkage_name(Dwarf_Die *dw_die)
144 Dwarf_Attribute attr;
146 if (dwarf_attr_integrate(dw_die, DW_AT_linkage_name, &attr) == NULL)
148 return dwarf_formstring(&attr);
152 * die_compare_name - Compare diename and tname
154 * @tname: a string of target name
156 * Compare the name of @dw_die and @tname. Return false if @dw_die has no name.
158 bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
162 name = dwarf_diename(dw_die);
163 return name ? (strcmp(tname, name) == 0) : false;
167 * die_match_name - Match diename/linkage name and glob
169 * @glob: a string of target glob pattern
171 * Glob matching the name of @dw_die and @glob. Return false if matching fail.
172 * This also match linkage name.
174 bool die_match_name(Dwarf_Die *dw_die, const char *glob)
178 name = dwarf_diename(dw_die);
179 if (name && strglobmatch(name, glob))
181 /* fall back to check linkage name */
182 name = die_get_linkage_name(dw_die);
183 if (name && strglobmatch(name, glob))
190 * die_get_call_lineno - Get callsite line number of inline-function instance
191 * @in_die: a DIE of an inlined function instance
193 * Get call-site line number of @in_die. This means from where the inline
194 * function is called.
196 int die_get_call_lineno(Dwarf_Die *in_die)
198 Dwarf_Attribute attr;
201 if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
204 dwarf_formudata(&attr, &ret);
209 * die_get_type - Get type DIE
210 * @vr_die: a DIE of a variable
211 * @die_mem: where to store a type DIE
213 * Get a DIE of the type of given variable (@vr_die), and store
214 * it to die_mem. Return NULL if fails to get a type DIE.
216 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
218 Dwarf_Attribute attr;
220 if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
221 dwarf_formref_die(&attr, die_mem))
227 /* Get a type die, but skip qualifiers */
228 static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
233 vr_die = die_get_type(vr_die, die_mem);
236 tag = dwarf_tag(vr_die);
237 } while (tag == DW_TAG_const_type ||
238 tag == DW_TAG_restrict_type ||
239 tag == DW_TAG_volatile_type ||
240 tag == DW_TAG_shared_type);
246 * die_get_real_type - Get a type die, but skip qualifiers and typedef
247 * @vr_die: a DIE of a variable
248 * @die_mem: where to store a type DIE
250 * Get a DIE of the type of given variable (@vr_die), and store
251 * it to die_mem. Return NULL if fails to get a type DIE.
252 * If the type is qualifiers (e.g. const) or typedef, this skips it
253 * and tries to find real type (structure or basic types, e.g. int).
255 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
258 vr_die = __die_get_real_type(vr_die, die_mem);
259 } while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
264 /* Get attribute and translate it as a udata */
265 static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
268 Dwarf_Attribute attr;
270 if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
271 dwarf_formudata(&attr, result) != 0)
277 /* Get attribute and translate it as a sdata */
278 static int die_get_attr_sdata(Dwarf_Die *tp_die, unsigned int attr_name,
281 Dwarf_Attribute attr;
283 if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
284 dwarf_formsdata(&attr, result) != 0)
291 * die_is_signed_type - Check whether a type DIE is signed or not
292 * @tp_die: a DIE of a type
294 * Get the encoding of @tp_die and return true if the encoding
297 bool die_is_signed_type(Dwarf_Die *tp_die)
301 if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
304 return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
305 ret == DW_ATE_signed_fixed);
309 * die_is_func_def - Ensure that this DIE is a subprogram and definition
312 * Ensure that this DIE is a subprogram and NOT a declaration. This
313 * returns true if @dw_die is a function definition.
315 bool die_is_func_def(Dwarf_Die *dw_die)
317 Dwarf_Attribute attr;
319 return (dwarf_tag(dw_die) == DW_TAG_subprogram &&
320 dwarf_attr(dw_die, DW_AT_declaration, &attr) == NULL);
324 * die_entrypc - Returns entry PC (the lowest address) of a DIE
326 * @addr: where to store entry PC
328 * Since dwarf_entrypc() does not return entry PC if the DIE has only address
329 * range, we have to use this to retrieve the lowest address from the address
332 int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr)
334 Dwarf_Addr base, end;
335 Dwarf_Attribute attr;
340 if (dwarf_entrypc(dw_die, addr) == 0)
344 * Since the dwarf_ranges() will return 0 if there is no
345 * DW_AT_ranges attribute, we should check it first.
347 if (!dwarf_attr(dw_die, DW_AT_ranges, &attr))
350 return dwarf_ranges(dw_die, 0, &base, addr, &end) < 0 ? -ENOENT : 0;
354 * die_is_func_instance - Ensure that this DIE is an instance of a subprogram
357 * Ensure that this DIE is an instance (which has an entry address).
358 * This returns true if @dw_die is a function instance. If not, the @dw_die
359 * must be a prototype. You can use die_walk_instances() to find actual
362 bool die_is_func_instance(Dwarf_Die *dw_die)
365 Dwarf_Attribute attr_mem;
366 int tag = dwarf_tag(dw_die);
368 if (tag != DW_TAG_subprogram &&
369 tag != DW_TAG_inlined_subroutine)
372 return dwarf_entrypc(dw_die, &tmp) == 0 ||
373 dwarf_attr(dw_die, DW_AT_ranges, &attr_mem) != NULL;
377 * die_get_data_member_location - Get the data-member offset
378 * @mb_die: a DIE of a member of a data structure
379 * @offs: The offset of the member in the data structure
381 * Get the offset of @mb_die in the data structure including @mb_die, and
382 * stores result offset to @offs. If any error occurs this returns errno.
384 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
386 Dwarf_Attribute attr;
391 if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
394 if (dwarf_formudata(&attr, offs) != 0) {
395 /* DW_AT_data_member_location should be DW_OP_plus_uconst */
396 ret = dwarf_getlocation(&attr, &expr, &nexpr);
397 if (ret < 0 || nexpr == 0)
400 if (expr[0].atom != DW_OP_plus_uconst || nexpr != 1) {
401 pr_debug("Unable to get offset:Unexpected OP %x (%zd)\n",
402 expr[0].atom, nexpr);
405 *offs = (Dwarf_Word)expr[0].number;
410 /* Get the call file index number in CU DIE */
411 static int die_get_call_fileno(Dwarf_Die *in_die)
415 if (die_get_attr_sdata(in_die, DW_AT_call_file, &idx) == 0)
421 /* Get the declared file index number in CU DIE */
422 static int die_get_decl_fileno(Dwarf_Die *pdie)
426 if (die_get_attr_sdata(pdie, DW_AT_decl_file, &idx) == 0)
433 * die_get_call_file - Get callsite file name of inlined function instance
434 * @in_die: a DIE of an inlined function instance
436 * Get call-site file name of @in_die. This means from which file the inline
437 * function is called.
439 const char *die_get_call_file(Dwarf_Die *in_die)
445 idx = die_get_call_fileno(in_die);
446 if (idx < 0 || !dwarf_diecu(in_die, &cu_die, NULL, NULL) ||
447 dwarf_getsrcfiles(&cu_die, &files, NULL) != 0)
450 return dwarf_filesrc(files, idx, NULL, NULL);
455 * die_find_child - Generic DIE search function in DIE tree
456 * @rt_die: a root DIE
457 * @callback: a callback function
458 * @data: a user data passed to the callback function
459 * @die_mem: a buffer for result DIE
461 * Trace DIE tree from @rt_die and call @callback for each child DIE.
462 * If @callback returns DIE_FIND_CB_END, this stores the DIE into
463 * @die_mem and returns it. If @callback returns DIE_FIND_CB_CONTINUE,
464 * this continues to trace the tree. Optionally, @callback can return
465 * DIE_FIND_CB_CHILD and DIE_FIND_CB_SIBLING, those means trace only
466 * the children and trace only the siblings respectively.
467 * Returns NULL if @callback can't find any appropriate DIE.
469 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
470 int (*callback)(Dwarf_Die *, void *),
471 void *data, Dwarf_Die *die_mem)
476 ret = dwarf_child(rt_die, die_mem);
481 ret = callback(die_mem, data);
482 if (ret == DIE_FIND_CB_END)
485 if ((ret & DIE_FIND_CB_CHILD) &&
486 die_find_child(die_mem, callback, data, &child_die)) {
487 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
490 } while ((ret & DIE_FIND_CB_SIBLING) &&
491 dwarf_siblingof(die_mem, die_mem) == 0);
496 struct __addr_die_search_param {
501 static int __die_search_func_tail_cb(Dwarf_Die *fn_die, void *data)
503 struct __addr_die_search_param *ad = data;
506 if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
507 !dwarf_highpc(fn_die, &addr) &&
509 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
510 return DWARF_CB_ABORT;
516 * die_find_tailfunc - Search for a non-inlined function with tail call at
518 * @cu_die: a CU DIE which including @addr
519 * @addr: target address
520 * @die_mem: a buffer for result DIE
522 * Search for a non-inlined function DIE with tail call at @addr. Stores the
523 * DIE to @die_mem and returns it if found. Returns NULL if failed.
525 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
528 struct __addr_die_search_param ad;
530 ad.die_mem = die_mem;
531 /* dwarf_getscopes can't find subprogram. */
532 if (!dwarf_getfuncs(cu_die, __die_search_func_tail_cb, &ad, 0))
538 /* die_find callback for non-inlined function search */
539 static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
541 struct __addr_die_search_param *ad = data;
544 * Since a declaration entry doesn't has given pc, this always returns
545 * function definition entry.
547 if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
548 dwarf_haspc(fn_die, ad->addr)) {
549 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
550 return DWARF_CB_ABORT;
556 * die_find_realfunc - Search a non-inlined function at given address
557 * @cu_die: a CU DIE which including @addr
558 * @addr: target address
559 * @die_mem: a buffer for result DIE
561 * Search a non-inlined function DIE which includes @addr. Stores the
562 * DIE to @die_mem and returns it if found. Returns NULL if failed.
564 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
567 struct __addr_die_search_param ad;
569 ad.die_mem = die_mem;
570 /* dwarf_getscopes can't find subprogram. */
571 if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
577 /* die_find callback for inline function search */
578 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
580 Dwarf_Addr *addr = data;
582 if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
583 dwarf_haspc(die_mem, *addr))
584 return DIE_FIND_CB_END;
586 return DIE_FIND_CB_CONTINUE;
590 * die_find_top_inlinefunc - Search the top inlined function at given address
591 * @sp_die: a subprogram DIE which including @addr
592 * @addr: target address
593 * @die_mem: a buffer for result DIE
595 * Search an inlined function DIE which includes @addr. Stores the
596 * DIE to @die_mem and returns it if found. Returns NULL if failed.
597 * Even if several inlined functions are expanded recursively, this
598 * doesn't trace it down, and returns the topmost one.
600 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
603 return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
607 * die_find_inlinefunc - Search an inlined function at given address
608 * @sp_die: a subprogram DIE which including @addr
609 * @addr: target address
610 * @die_mem: a buffer for result DIE
612 * Search an inlined function DIE which includes @addr. Stores the
613 * DIE to @die_mem and returns it if found. Returns NULL if failed.
614 * If several inlined functions are expanded recursively, this trace
615 * it down and returns deepest one.
617 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
622 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
626 /* Inlined function could be recursive. Trace it until fail */
628 memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
629 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
636 struct __instance_walk_param {
638 int (*callback)(Dwarf_Die *, void *);
643 static int __die_walk_instances_cb(Dwarf_Die *inst, void *data)
645 struct __instance_walk_param *iwp = data;
646 Dwarf_Attribute attr_mem;
647 Dwarf_Die origin_mem;
648 Dwarf_Attribute *attr;
652 if (!die_is_func_instance(inst))
653 return DIE_FIND_CB_CONTINUE;
655 attr = dwarf_attr(inst, DW_AT_abstract_origin, &attr_mem);
657 return DIE_FIND_CB_CONTINUE;
659 origin = dwarf_formref_die(attr, &origin_mem);
660 if (origin == NULL || origin->addr != iwp->addr)
661 return DIE_FIND_CB_CONTINUE;
663 /* Ignore redundant instances */
664 if (dwarf_tag(inst) == DW_TAG_inlined_subroutine) {
665 dwarf_decl_line(origin, &tmp);
666 if (die_get_call_lineno(inst) == tmp) {
667 tmp = die_get_decl_fileno(origin);
668 if (die_get_call_fileno(inst) == tmp)
669 return DIE_FIND_CB_CONTINUE;
673 iwp->retval = iwp->callback(inst, iwp->data);
675 return (iwp->retval) ? DIE_FIND_CB_END : DIE_FIND_CB_CONTINUE;
679 * die_walk_instances - Walk on instances of given DIE
680 * @or_die: an abstract original DIE
681 * @callback: a callback function which is called with instance DIE
684 * Walk on the instances of give @in_die. @in_die must be an inlined function
685 * declartion. This returns the return value of @callback if it returns
686 * non-zero value, or -ENOENT if there is no instance.
688 int die_walk_instances(Dwarf_Die *or_die, int (*callback)(Dwarf_Die *, void *),
693 struct __instance_walk_param iwp = {
694 .addr = or_die->addr,
695 .callback = callback,
700 if (dwarf_diecu(or_die, &cu_die, NULL, NULL) == NULL)
703 die_find_child(&cu_die, __die_walk_instances_cb, &iwp, &die_mem);
708 /* Line walker internal parameters */
709 struct __line_walk_param {
711 line_walk_callback_t callback;
716 static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
718 struct __line_walk_param *lw = data;
723 if (dwarf_tag(in_die) == DW_TAG_inlined_subroutine) {
724 fname = die_get_call_file(in_die);
725 lineno = die_get_call_lineno(in_die);
726 if (fname && lineno > 0 && die_entrypc(in_die, &addr) == 0) {
727 lw->retval = lw->callback(fname, lineno, addr, lw->data);
729 return DIE_FIND_CB_END;
732 return DIE_FIND_CB_SIBLING;
736 fname = dwarf_decl_file(in_die);
737 if (fname && dwarf_decl_line(in_die, &lineno) == 0) {
738 lw->retval = lw->callback(fname, lineno, addr, lw->data);
740 return DIE_FIND_CB_END;
744 /* Continue to search nested inlined function call-sites */
745 return DIE_FIND_CB_CONTINUE;
748 /* Walk on lines of blocks included in given DIE */
749 static int __die_walk_funclines(Dwarf_Die *sp_die, bool recursive,
750 line_walk_callback_t callback, void *data)
752 struct __line_walk_param lw = {
753 .recursive = recursive,
754 .callback = callback,
763 /* Handle function declaration line */
764 fname = dwarf_decl_file(sp_die);
765 if (fname && dwarf_decl_line(sp_die, &lineno) == 0 &&
766 die_entrypc(sp_die, &addr) == 0) {
767 lw.retval = callback(fname, lineno, addr, data);
771 die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
776 static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
778 struct __line_walk_param *lw = data;
781 * Since inlined function can include another inlined function in
782 * the same file, we need to walk in it recursively.
784 lw->retval = __die_walk_funclines(sp_die, true, lw->callback, lw->data);
786 return DWARF_CB_ABORT;
792 * die_walk_lines - Walk on lines inside given DIE
793 * @rt_die: a root DIE (CU, subprogram or inlined_subroutine)
794 * @callback: callback routine
797 * Walk on all lines inside given @rt_die and call @callback on each line.
798 * If the @rt_die is a function, walk only on the lines inside the function,
799 * otherwise @rt_die must be a CU DIE.
800 * Note that this walks not only dwarf line list, but also function entries
801 * and inline call-site.
803 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data)
808 const char *fname, *decf = NULL, *inf = NULL;
811 Dwarf_Die die_mem, *cu_die;
816 if (dwarf_tag(rt_die) != DW_TAG_compile_unit) {
817 cu_die = dwarf_diecu(rt_die, &die_mem, NULL, NULL);
818 dwarf_decl_line(rt_die, &decl);
819 decf = dwarf_decl_file(rt_die);
823 pr_debug2("Failed to get CU from given DIE.\n");
827 /* Get lines list in the CU */
828 if (dwarf_getsrclines(cu_die, &lines, &nlines) != 0) {
829 pr_debug2("Failed to get source lines on this CU.\n");
832 pr_debug2("Get %zd lines from this CU\n", nlines);
834 /* Walk on the lines on lines list */
835 for (i = 0; i < nlines; i++) {
836 line = dwarf_onesrcline(lines, i);
838 dwarf_lineno(line, &lineno) != 0 ||
839 dwarf_lineaddr(line, &addr) != 0) {
840 pr_debug2("Failed to get line info. "
841 "Possible error in debuginfo.\n");
844 /* Skip end-of-sequence */
845 if (dwarf_lineendsequence(line, &flag) != 0 || flag)
847 /* Skip Non statement line-info */
848 if (dwarf_linebeginstatement(line, &flag) != 0 || !flag)
850 /* Filter lines based on address */
851 if (rt_die != cu_die) {
854 * The line is included in given function, and
855 * no inline block includes it.
857 if (!dwarf_haspc(rt_die, addr))
860 if (die_find_inlinefunc(rt_die, addr, &die_mem)) {
861 /* Call-site check */
862 inf = die_get_call_file(&die_mem);
863 if ((inf && !strcmp(inf, decf)) &&
864 die_get_call_lineno(&die_mem) == lineno)
867 dwarf_decl_line(&die_mem, &inl);
869 decf != dwarf_decl_file(&die_mem))
874 /* Get source line */
875 fname = dwarf_linesrc(line, NULL, NULL);
877 ret = callback(fname, lineno, addr, data);
883 * Dwarf lines doesn't include function declarations and inlined
884 * subroutines. We have to check functions list or given function.
886 if (rt_die != cu_die)
888 * Don't need walk inlined functions recursively, because
889 * inner inlined functions don't have the lines of the
890 * specified function.
892 ret = __die_walk_funclines(rt_die, false, callback, data);
894 struct __line_walk_param param = {
895 .callback = callback,
899 dwarf_getfuncs(cu_die, __die_walk_culines_cb, ¶m, 0);
906 struct __find_variable_param {
911 static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
913 struct __find_variable_param *fvp = data;
914 Dwarf_Attribute attr;
917 tag = dwarf_tag(die_mem);
918 if ((tag == DW_TAG_formal_parameter ||
919 tag == DW_TAG_variable) &&
920 die_compare_name(die_mem, fvp->name) &&
921 /* Does the DIE have location information or external instance? */
922 (dwarf_attr(die_mem, DW_AT_external, &attr) ||
923 dwarf_attr(die_mem, DW_AT_location, &attr)))
924 return DIE_FIND_CB_END;
925 if (dwarf_haspc(die_mem, fvp->addr))
926 return DIE_FIND_CB_CONTINUE;
928 return DIE_FIND_CB_SIBLING;
932 * die_find_variable_at - Find a given name variable at given address
933 * @sp_die: a function DIE
934 * @name: variable name
936 * @die_mem: a buffer for result DIE
938 * Find a variable DIE called @name at @addr in @sp_die.
940 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
941 Dwarf_Addr addr, Dwarf_Die *die_mem)
943 struct __find_variable_param fvp = { .name = name, .addr = addr};
945 return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
949 static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
951 const char *name = data;
953 if (dwarf_tag(die_mem) == DW_TAG_member) {
954 if (die_compare_name(die_mem, name))
955 return DIE_FIND_CB_END;
956 else if (!dwarf_diename(die_mem)) { /* Unnamed structure */
957 Dwarf_Die type_die, tmp_die;
958 if (die_get_type(die_mem, &type_die) &&
959 die_find_member(&type_die, name, &tmp_die))
960 return DIE_FIND_CB_END;
963 return DIE_FIND_CB_SIBLING;
967 * die_find_member - Find a given name member in a data structure
968 * @st_die: a data structure type DIE
970 * @die_mem: a buffer for result DIE
972 * Find a member DIE called @name in @st_die.
974 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
977 return die_find_child(st_die, __die_find_member_cb, (void *)name,
982 * die_get_typename - Get the name of given variable DIE
983 * @vr_die: a variable DIE
984 * @buf: a strbuf for result type name
986 * Get the name of @vr_die and stores it to @buf. Return 0 if succeeded.
987 * and Return -ENOENT if failed to find type name.
988 * Note that the result will stores typedef name if possible, and stores
989 * "*(function_type)" if the type is a function pointer.
991 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf)
995 const char *tmp = "";
997 if (__die_get_real_type(vr_die, &type) == NULL)
1000 tag = dwarf_tag(&type);
1001 if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
1003 else if (tag == DW_TAG_subroutine_type) {
1004 /* Function pointer */
1005 return strbuf_add(buf, "(function_type)", 15);
1007 if (!dwarf_diename(&type))
1009 if (tag == DW_TAG_union_type)
1011 else if (tag == DW_TAG_structure_type)
1013 else if (tag == DW_TAG_enumeration_type)
1015 /* Write a base name */
1016 return strbuf_addf(buf, "%s%s", tmp, dwarf_diename(&type));
1018 ret = die_get_typename(&type, buf);
1019 return ret ? ret : strbuf_addstr(buf, tmp);
1023 * die_get_varname - Get the name and type of given variable DIE
1024 * @vr_die: a variable DIE
1025 * @buf: a strbuf for type and variable name
1027 * Get the name and type of @vr_die and stores it in @buf as "type\tname".
1029 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf)
1033 ret = die_get_typename(vr_die, buf);
1035 pr_debug("Failed to get type, make it unknown.\n");
1036 ret = strbuf_add(buf, " (unknown_type)", 14);
1039 return ret < 0 ? ret : strbuf_addf(buf, "\t%s", dwarf_diename(vr_die));
1042 #ifdef HAVE_DWARF_GETLOCATIONS_SUPPORT
1044 * die_get_var_innermost_scope - Get innermost scope range of given variable DIE
1045 * @sp_die: a subprogram DIE
1046 * @vr_die: a variable DIE
1047 * @buf: a strbuf for variable byte offset range
1049 * Get the innermost scope range of @vr_die and stores it in @buf as
1050 * "@<function_name+[NN-NN,NN-NN]>".
1052 static int die_get_var_innermost_scope(Dwarf_Die *sp_die, Dwarf_Die *vr_die,
1059 Dwarf_Addr start, end;
1065 ret = die_entrypc(sp_die, &entry);
1069 name = dwarf_diename(sp_die);
1073 count = dwarf_getscopes_die(vr_die, &scopes);
1075 /* (*SCOPES)[1] is the DIE for the scope containing that scope */
1081 while ((offset = dwarf_ranges(&scopes[1], offset, &base,
1082 &start, &end)) > 0) {
1087 ret = strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1091 ret = strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1099 ret = strbuf_add(buf, "]>", 2);
1107 * die_get_var_range - Get byte offset range of given variable DIE
1108 * @sp_die: a subprogram DIE
1109 * @vr_die: a variable DIE
1110 * @buf: a strbuf for type and variable name and byte offset range
1112 * Get the byte offset range of @vr_die and stores it in @buf as
1113 * "@<function_name+[NN-NN,NN-NN]>".
1115 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf)
1119 Dwarf_Addr start, end;
1124 Dwarf_Attribute attr;
1128 ret = die_entrypc(sp_die, &entry);
1132 name = dwarf_diename(sp_die);
1136 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
1139 while ((offset = dwarf_getlocations(&attr, offset, &base,
1140 &start, &end, &op, &nops)) > 0) {
1142 /* Single Location Descriptions */
1143 ret = die_get_var_innermost_scope(sp_die, vr_die, buf);
1147 /* Location Lists */
1151 ret = strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1155 ret = strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1163 ret = strbuf_add(buf, "]>", 2);
1168 int die_get_var_range(Dwarf_Die *sp_die __maybe_unused,
1169 Dwarf_Die *vr_die __maybe_unused,
1170 struct strbuf *buf __maybe_unused)
1177 * die_has_loclist - Check if DW_AT_location of @vr_die is a location list
1178 * @vr_die: a variable DIE
1180 static bool die_has_loclist(Dwarf_Die *vr_die)
1182 Dwarf_Attribute loc;
1183 int tag = dwarf_tag(vr_die);
1185 if (tag != DW_TAG_formal_parameter &&
1186 tag != DW_TAG_variable)
1189 return (dwarf_attr_integrate(vr_die, DW_AT_location, &loc) &&
1190 dwarf_whatform(&loc) == DW_FORM_sec_offset);
1194 * die_is_optimized_target - Check if target program is compiled with
1198 * For any object in given CU whose DW_AT_location is a location list,
1199 * target program is compiled with optimization. This is applicable to
1202 bool die_is_optimized_target(Dwarf_Die *cu_die)
1206 if (die_has_loclist(cu_die))
1209 if (!dwarf_child(cu_die, &tmp_die) &&
1210 die_is_optimized_target(&tmp_die))
1213 if (!dwarf_siblingof(cu_die, &tmp_die) &&
1214 die_is_optimized_target(&tmp_die))
1221 * die_search_idx - Search index of given line address
1222 * @lines: Line records of single CU
1223 * @nr_lines: Number of @lines
1224 * @addr: address we are looking for
1225 * @idx: index to be set by this function (return value)
1227 * Search for @addr by looping over every lines of CU. If address
1228 * matches, set index of that line in @idx. Note that single source
1229 * line can have multiple line records. i.e. single source line can
1230 * have multiple index.
1232 static bool die_search_idx(Dwarf_Lines *lines, unsigned long nr_lines,
1233 Dwarf_Addr addr, unsigned long *idx)
1238 for (i = 0; i < nr_lines; i++) {
1239 if (dwarf_lineaddr(dwarf_onesrcline(lines, i), &tmp))
1251 * die_get_postprologue_addr - Search next address after function prologue
1252 * @entrypc_idx: entrypc index
1253 * @lines: Line records of single CU
1254 * @nr_lines: Number of @lines
1255 * @hignpc: high PC address of function
1256 * @postprologue_addr: Next address after function prologue (return value)
1258 * Look for prologue-end marker. If there is no explicit marker, return
1259 * address of next line record or next source line.
1261 static bool die_get_postprologue_addr(unsigned long entrypc_idx,
1263 unsigned long nr_lines,
1265 Dwarf_Addr *postprologue_addr)
1268 int entrypc_lno, lno;
1273 /* entrypc_lno is actual source line number */
1274 line = dwarf_onesrcline(lines, entrypc_idx);
1275 if (dwarf_lineno(line, &entrypc_lno))
1278 for (i = entrypc_idx; i < nr_lines; i++) {
1279 line = dwarf_onesrcline(lines, i);
1281 if (dwarf_lineaddr(line, &addr) ||
1282 dwarf_lineno(line, &lno) ||
1283 dwarf_lineprologueend(line, &p_end))
1286 /* highpc is exclusive. [entrypc,highpc) */
1290 /* clang supports prologue-end marker */
1294 /* Actual next line in source */
1295 if (lno != entrypc_lno)
1299 * Single source line can have multiple line records.
1301 * void foo() { printf("hello\n"); }
1302 * contains two line records. One points to declaration and
1303 * other points to printf() line. Variable 'lno' won't get
1304 * incremented in this case but 'i' will.
1306 if (i != entrypc_idx)
1310 dwarf_lineaddr(line, postprologue_addr);
1311 if (*postprologue_addr >= highpc)
1312 dwarf_lineaddr(dwarf_onesrcline(lines, i - 1),
1319 * die_skip_prologue - Use next address after prologue as probe location
1320 * @sp_die: a subprogram DIE
1322 * @entrypc: entrypc of the function
1324 * Function prologue prepares stack and registers before executing function
1325 * logic. When target program is compiled without optimization, function
1326 * parameter information is only valid after prologue. When we probe entrypc
1327 * of the function, and try to record function parameter, it contains
1330 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
1331 Dwarf_Addr *entrypc)
1333 size_t nr_lines = 0;
1334 unsigned long entrypc_idx = 0;
1335 Dwarf_Lines *lines = NULL;
1336 Dwarf_Addr postprologue_addr;
1339 if (dwarf_highpc(sp_die, &highpc))
1342 if (dwarf_getsrclines(cu_die, &lines, &nr_lines))
1345 if (!die_search_idx(lines, nr_lines, *entrypc, &entrypc_idx))
1348 if (!die_get_postprologue_addr(entrypc_idx, lines, nr_lines,
1349 highpc, &postprologue_addr))
1352 *entrypc = postprologue_addr;