GNU Linux-libre 4.19.211-gnu1
[releases.git] / tools / perf / util / dwarf-aux.c
1 /*
2  * dwarf-aux.c : libdw auxiliary interfaces
3  *
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.
8  *
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.
13  *
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.
17  *
18  */
19
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <stdbool.h>
23 #include "util.h"
24 #include "debug.h"
25 #include "dwarf-aux.h"
26 #include "string2.h"
27
28 /**
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
32  *
33  * Find the real(long) path of @fname in @cu_die.
34  */
35 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
36 {
37         Dwarf_Files *files;
38         size_t nfiles, i;
39         const char *src = NULL;
40         int ret;
41
42         if (!fname)
43                 return NULL;
44
45         ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
46         if (ret != 0)
47                 return NULL;
48
49         for (i = 0; i < nfiles; i++) {
50                 src = dwarf_filesrc(files, i, NULL, NULL);
51                 if (strtailcmp(src, fname) == 0)
52                         break;
53         }
54         if (i == nfiles)
55                 return NULL;
56         return src;
57 }
58
59 /**
60  * cu_get_comp_dir - Get the path of compilation directory
61  * @cu_die: a CU DIE
62  *
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.
66  */
67 const char *cu_get_comp_dir(Dwarf_Die *cu_die)
68 {
69         Dwarf_Attribute attr;
70         if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
71                 return NULL;
72         return dwarf_formstring(&attr);
73 }
74
75 /**
76  * cu_find_lineinfo - Get a line number and file name for given address
77  * @cu_die: a CU DIE
78  * @addr: An address
79  * @fname: a pointer which returns the file name string
80  * @lineno: a pointer which returns the line number
81  *
82  * Find a line number and file name for @addr in @cu_die.
83  */
84 int cu_find_lineinfo(Dwarf_Die *cu_die, unsigned long addr,
85                     const char **fname, int *lineno)
86 {
87         Dwarf_Line *line;
88         Dwarf_Addr laddr;
89
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);
94                 if (!*fname)
95                         /* line number is useless without filename */
96                         *lineno = 0;
97         }
98
99         return *lineno ?: -ENOENT;
100 }
101
102 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data);
103
104 /**
105  * cu_walk_functions_at - Walk on function DIEs at given address
106  * @cu_die: A CU DIE
107  * @addr: An address
108  * @callback: A callback which called with found DIEs
109  * @data: A user data
110  *
111  * Walk on function DIEs at given @addr in @cu_die. Passed DIEs
112  * should be subprogram or inlined-subroutines.
113  */
114 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
115                     int (*callback)(Dwarf_Die *, void *), void *data)
116 {
117         Dwarf_Die die_mem;
118         Dwarf_Die *sc_die;
119         int ret = -ENOENT;
120
121         /* Inlined function could be recursive. Trace it until fail */
122         for (sc_die = die_find_realfunc(cu_die, addr, &die_mem);
123              sc_die != NULL;
124              sc_die = die_find_child(sc_die, __die_find_inline_cb, &addr,
125                                      &die_mem)) {
126                 ret = callback(sc_die, data);
127                 if (ret)
128                         break;
129         }
130
131         return ret;
132
133 }
134
135 /**
136  * die_get_linkage_name - Get the linkage name of the object
137  * @dw_die: A DIE of the object
138  *
139  * Get the linkage name attiribute of given @dw_die.
140  * For C++ binary, the linkage name will be the mangled symbol.
141  */
142 const char *die_get_linkage_name(Dwarf_Die *dw_die)
143 {
144         Dwarf_Attribute attr;
145
146         if (dwarf_attr_integrate(dw_die, DW_AT_linkage_name, &attr) == NULL)
147                 return NULL;
148         return dwarf_formstring(&attr);
149 }
150
151 /**
152  * die_compare_name - Compare diename and tname
153  * @dw_die: a DIE
154  * @tname: a string of target name
155  *
156  * Compare the name of @dw_die and @tname. Return false if @dw_die has no name.
157  */
158 bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
159 {
160         const char *name;
161
162         name = dwarf_diename(dw_die);
163         return name ? (strcmp(tname, name) == 0) : false;
164 }
165
166 /**
167  * die_match_name - Match diename/linkage name and glob
168  * @dw_die: a DIE
169  * @glob: a string of target glob pattern
170  *
171  * Glob matching the name of @dw_die and @glob. Return false if matching fail.
172  * This also match linkage name.
173  */
174 bool die_match_name(Dwarf_Die *dw_die, const char *glob)
175 {
176         const char *name;
177
178         name = dwarf_diename(dw_die);
179         if (name && strglobmatch(name, glob))
180                 return true;
181         /* fall back to check linkage name */
182         name = die_get_linkage_name(dw_die);
183         if (name && strglobmatch(name, glob))
184                 return true;
185
186         return false;
187 }
188
189 /**
190  * die_get_call_lineno - Get callsite line number of inline-function instance
191  * @in_die: a DIE of an inlined function instance
192  *
193  * Get call-site line number of @in_die. This means from where the inline
194  * function is called.
195  */
196 int die_get_call_lineno(Dwarf_Die *in_die)
197 {
198         Dwarf_Attribute attr;
199         Dwarf_Word ret;
200
201         if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
202                 return -ENOENT;
203
204         dwarf_formudata(&attr, &ret);
205         return (int)ret;
206 }
207
208 /**
209  * die_get_type - Get type DIE
210  * @vr_die: a DIE of a variable
211  * @die_mem: where to store a type DIE
212  *
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.
215  */
216 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
217 {
218         Dwarf_Attribute attr;
219
220         if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
221             dwarf_formref_die(&attr, die_mem))
222                 return die_mem;
223         else
224                 return NULL;
225 }
226
227 /* Get a type die, but skip qualifiers */
228 static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
229 {
230         int tag;
231
232         do {
233                 vr_die = die_get_type(vr_die, die_mem);
234                 if (!vr_die)
235                         break;
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);
241
242         return vr_die;
243 }
244
245 /**
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
249  *
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).
254  */
255 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
256 {
257         do {
258                 vr_die = __die_get_real_type(vr_die, die_mem);
259         } while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
260
261         return vr_die;
262 }
263
264 /* Get attribute and translate it as a udata */
265 static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
266                               Dwarf_Word *result)
267 {
268         Dwarf_Attribute attr;
269
270         if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
271             dwarf_formudata(&attr, result) != 0)
272                 return -ENOENT;
273
274         return 0;
275 }
276
277 /* Get attribute and translate it as a sdata */
278 static int die_get_attr_sdata(Dwarf_Die *tp_die, unsigned int attr_name,
279                               Dwarf_Sword *result)
280 {
281         Dwarf_Attribute attr;
282
283         if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
284             dwarf_formsdata(&attr, result) != 0)
285                 return -ENOENT;
286
287         return 0;
288 }
289
290 /**
291  * die_is_signed_type - Check whether a type DIE is signed or not
292  * @tp_die: a DIE of a type
293  *
294  * Get the encoding of @tp_die and return true if the encoding
295  * is signed.
296  */
297 bool die_is_signed_type(Dwarf_Die *tp_die)
298 {
299         Dwarf_Word ret;
300
301         if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
302                 return false;
303
304         return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
305                 ret == DW_ATE_signed_fixed);
306 }
307
308 /**
309  * die_is_func_def - Ensure that this DIE is a subprogram and definition
310  * @dw_die: a DIE
311  *
312  * Ensure that this DIE is a subprogram and NOT a declaration. This
313  * returns true if @dw_die is a function definition.
314  **/
315 bool die_is_func_def(Dwarf_Die *dw_die)
316 {
317         Dwarf_Attribute attr;
318
319         return (dwarf_tag(dw_die) == DW_TAG_subprogram &&
320                 dwarf_attr(dw_die, DW_AT_declaration, &attr) == NULL);
321 }
322
323 /**
324  * die_entrypc - Returns entry PC (the lowest address) of a DIE
325  * @dw_die: a DIE
326  * @addr: where to store entry PC
327  *
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
330  * range attribute.
331  */
332 int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr)
333 {
334         Dwarf_Addr base, end;
335         Dwarf_Attribute attr;
336
337         if (!addr)
338                 return -EINVAL;
339
340         if (dwarf_entrypc(dw_die, addr) == 0)
341                 return 0;
342
343         /*
344          *  Since the dwarf_ranges() will return 0 if there is no
345          * DW_AT_ranges attribute, we should check it first.
346          */
347         if (!dwarf_attr(dw_die, DW_AT_ranges, &attr))
348                 return -ENOENT;
349
350         return dwarf_ranges(dw_die, 0, &base, addr, &end) < 0 ? -ENOENT : 0;
351 }
352
353 /**
354  * die_is_func_instance - Ensure that this DIE is an instance of a subprogram
355  * @dw_die: a DIE
356  *
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
360  * instances.
361  **/
362 bool die_is_func_instance(Dwarf_Die *dw_die)
363 {
364         Dwarf_Addr tmp;
365         Dwarf_Attribute attr_mem;
366         int tag = dwarf_tag(dw_die);
367
368         if (tag != DW_TAG_subprogram &&
369             tag != DW_TAG_inlined_subroutine)
370                 return false;
371
372         return dwarf_entrypc(dw_die, &tmp) == 0 ||
373                 dwarf_attr(dw_die, DW_AT_ranges, &attr_mem) != NULL;
374 }
375
376 /**
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
380  *
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.
383  */
384 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
385 {
386         Dwarf_Attribute attr;
387         Dwarf_Op *expr;
388         size_t nexpr;
389         int ret;
390
391         if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
392                 return -ENOENT;
393
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)
398                         return -ENOENT;
399
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);
403                         return -ENOTSUP;
404                 }
405                 *offs = (Dwarf_Word)expr[0].number;
406         }
407         return 0;
408 }
409
410 /* Get the call file index number in CU DIE */
411 static int die_get_call_fileno(Dwarf_Die *in_die)
412 {
413         Dwarf_Sword idx;
414
415         if (die_get_attr_sdata(in_die, DW_AT_call_file, &idx) == 0)
416                 return (int)idx;
417         else
418                 return -ENOENT;
419 }
420
421 /* Get the declared file index number in CU DIE */
422 static int die_get_decl_fileno(Dwarf_Die *pdie)
423 {
424         Dwarf_Sword idx;
425
426         if (die_get_attr_sdata(pdie, DW_AT_decl_file, &idx) == 0)
427                 return (int)idx;
428         else
429                 return -ENOENT;
430 }
431
432 /**
433  * die_get_call_file - Get callsite file name of inlined function instance
434  * @in_die: a DIE of an inlined function instance
435  *
436  * Get call-site file name of @in_die. This means from which file the inline
437  * function is called.
438  */
439 const char *die_get_call_file(Dwarf_Die *in_die)
440 {
441         Dwarf_Die cu_die;
442         Dwarf_Files *files;
443         int idx;
444
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)
448                 return NULL;
449
450         return dwarf_filesrc(files, idx, NULL, NULL);
451 }
452
453
454 /**
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
460  *
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.
468  */
469 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
470                           int (*callback)(Dwarf_Die *, void *),
471                           void *data, Dwarf_Die *die_mem)
472 {
473         Dwarf_Die child_die;
474         int ret;
475
476         ret = dwarf_child(rt_die, die_mem);
477         if (ret != 0)
478                 return NULL;
479
480         do {
481                 ret = callback(die_mem, data);
482                 if (ret == DIE_FIND_CB_END)
483                         return die_mem;
484
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));
488                         return die_mem;
489                 }
490         } while ((ret & DIE_FIND_CB_SIBLING) &&
491                  dwarf_siblingof(die_mem, die_mem) == 0);
492
493         return NULL;
494 }
495
496 struct __addr_die_search_param {
497         Dwarf_Addr      addr;
498         Dwarf_Die       *die_mem;
499 };
500
501 static int __die_search_func_tail_cb(Dwarf_Die *fn_die, void *data)
502 {
503         struct __addr_die_search_param *ad = data;
504         Dwarf_Addr addr = 0;
505
506         if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
507             !dwarf_highpc(fn_die, &addr) &&
508             addr == ad->addr) {
509                 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
510                 return DWARF_CB_ABORT;
511         }
512         return DWARF_CB_OK;
513 }
514
515 /**
516  * die_find_tailfunc - Search for a non-inlined function with tail call at
517  * given address
518  * @cu_die: a CU DIE which including @addr
519  * @addr: target address
520  * @die_mem: a buffer for result DIE
521  *
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.
524  */
525 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
526                                     Dwarf_Die *die_mem)
527 {
528         struct __addr_die_search_param ad;
529         ad.addr = addr;
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))
533                 return NULL;
534         else
535                 return die_mem;
536 }
537
538 /* die_find callback for non-inlined function search */
539 static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
540 {
541         struct __addr_die_search_param *ad = data;
542
543         /*
544          * Since a declaration entry doesn't has given pc, this always returns
545          * function definition entry.
546          */
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;
551         }
552         return DWARF_CB_OK;
553 }
554
555 /**
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
560  *
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.
563  */
564 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
565                                     Dwarf_Die *die_mem)
566 {
567         struct __addr_die_search_param ad;
568         ad.addr = addr;
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))
572                 return NULL;
573         else
574                 return die_mem;
575 }
576
577 /* die_find callback for inline function search */
578 static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
579 {
580         Dwarf_Addr *addr = data;
581
582         if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
583             dwarf_haspc(die_mem, *addr))
584                 return DIE_FIND_CB_END;
585
586         return DIE_FIND_CB_CONTINUE;
587 }
588
589 /**
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
594  *
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.
599  */
600 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
601                                    Dwarf_Die *die_mem)
602 {
603         return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
604 }
605
606 /**
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
611  *
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.
616  */
617 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
618                                Dwarf_Die *die_mem)
619 {
620         Dwarf_Die tmp_die;
621
622         sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
623         if (!sp_die)
624                 return NULL;
625
626         /* Inlined function could be recursive. Trace it until fail */
627         while (sp_die) {
628                 memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
629                 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
630                                         &tmp_die);
631         }
632
633         return die_mem;
634 }
635
636 struct __instance_walk_param {
637         void    *addr;
638         int     (*callback)(Dwarf_Die *, void *);
639         void    *data;
640         int     retval;
641 };
642
643 static int __die_walk_instances_cb(Dwarf_Die *inst, void *data)
644 {
645         struct __instance_walk_param *iwp = data;
646         Dwarf_Attribute attr_mem;
647         Dwarf_Die origin_mem;
648         Dwarf_Attribute *attr;
649         Dwarf_Die *origin;
650         int tmp;
651
652         if (!die_is_func_instance(inst))
653                 return DIE_FIND_CB_CONTINUE;
654
655         attr = dwarf_attr(inst, DW_AT_abstract_origin, &attr_mem);
656         if (attr == NULL)
657                 return DIE_FIND_CB_CONTINUE;
658
659         origin = dwarf_formref_die(attr, &origin_mem);
660         if (origin == NULL || origin->addr != iwp->addr)
661                 return DIE_FIND_CB_CONTINUE;
662
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;
670                 }
671         }
672
673         iwp->retval = iwp->callback(inst, iwp->data);
674
675         return (iwp->retval) ? DIE_FIND_CB_END : DIE_FIND_CB_CONTINUE;
676 }
677
678 /**
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
682  * @data: user data
683  *
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.
687  */
688 int die_walk_instances(Dwarf_Die *or_die, int (*callback)(Dwarf_Die *, void *),
689                        void *data)
690 {
691         Dwarf_Die cu_die;
692         Dwarf_Die die_mem;
693         struct __instance_walk_param iwp = {
694                 .addr = or_die->addr,
695                 .callback = callback,
696                 .data = data,
697                 .retval = -ENOENT,
698         };
699
700         if (dwarf_diecu(or_die, &cu_die, NULL, NULL) == NULL)
701                 return -ENOENT;
702
703         die_find_child(&cu_die, __die_walk_instances_cb, &iwp, &die_mem);
704
705         return iwp.retval;
706 }
707
708 /* Line walker internal parameters */
709 struct __line_walk_param {
710         bool recursive;
711         line_walk_callback_t callback;
712         void *data;
713         int retval;
714 };
715
716 static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
717 {
718         struct __line_walk_param *lw = data;
719         Dwarf_Addr addr = 0;
720         const char *fname;
721         int lineno;
722
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);
728                         if (lw->retval != 0)
729                                 return DIE_FIND_CB_END;
730                 }
731                 if (!lw->recursive)
732                         return DIE_FIND_CB_SIBLING;
733         }
734
735         if (addr) {
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);
739                         if (lw->retval != 0)
740                                 return DIE_FIND_CB_END;
741                 }
742         }
743
744         /* Continue to search nested inlined function call-sites */
745         return DIE_FIND_CB_CONTINUE;
746 }
747
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)
751 {
752         struct __line_walk_param lw = {
753                 .recursive = recursive,
754                 .callback = callback,
755                 .data = data,
756                 .retval = 0,
757         };
758         Dwarf_Die die_mem;
759         Dwarf_Addr addr;
760         const char *fname;
761         int lineno;
762
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);
768                 if (lw.retval != 0)
769                         goto done;
770         }
771         die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
772 done:
773         return lw.retval;
774 }
775
776 static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
777 {
778         struct __line_walk_param *lw = data;
779
780         /*
781          * Since inlined function can include another inlined function in
782          * the same file, we need to walk in it recursively.
783          */
784         lw->retval = __die_walk_funclines(sp_die, true, lw->callback, lw->data);
785         if (lw->retval != 0)
786                 return DWARF_CB_ABORT;
787
788         return DWARF_CB_OK;
789 }
790
791 /**
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
795  * @data: user data
796  *
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.
802  */
803 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data)
804 {
805         Dwarf_Lines *lines;
806         Dwarf_Line *line;
807         Dwarf_Addr addr;
808         const char *fname, *decf = NULL, *inf = NULL;
809         int lineno, ret = 0;
810         int decl = 0, inl;
811         Dwarf_Die die_mem, *cu_die;
812         size_t nlines, i;
813         bool flag;
814
815         /* Get the 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);
820         } else
821                 cu_die = rt_die;
822         if (!cu_die) {
823                 pr_debug2("Failed to get CU from given DIE.\n");
824                 return -EINVAL;
825         }
826
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");
830                 return -ENOENT;
831         }
832         pr_debug2("Get %zd lines from this CU\n", nlines);
833
834         /* Walk on the lines on lines list */
835         for (i = 0; i < nlines; i++) {
836                 line = dwarf_onesrcline(lines, i);
837                 if (line == NULL ||
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");
842                         continue;
843                 }
844                 /* Skip end-of-sequence */
845                 if (dwarf_lineendsequence(line, &flag) != 0 || flag)
846                         continue;
847                 /* Skip Non statement line-info */
848                 if (dwarf_linebeginstatement(line, &flag) != 0 || !flag)
849                         continue;
850                 /* Filter lines based on address */
851                 if (rt_die != cu_die) {
852                         /*
853                          * Address filtering
854                          * The line is included in given function, and
855                          * no inline block includes it.
856                          */
857                         if (!dwarf_haspc(rt_die, addr))
858                                 continue;
859
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)
865                                         goto found;
866
867                                 dwarf_decl_line(&die_mem, &inl);
868                                 if (inl != decl ||
869                                     decf != dwarf_decl_file(&die_mem))
870                                         continue;
871                         }
872                 }
873 found:
874                 /* Get source line */
875                 fname = dwarf_linesrc(line, NULL, NULL);
876
877                 ret = callback(fname, lineno, addr, data);
878                 if (ret != 0)
879                         return ret;
880         }
881
882         /*
883          * Dwarf lines doesn't include function declarations and inlined
884          * subroutines. We have to check functions list or given function.
885          */
886         if (rt_die != cu_die)
887                 /*
888                  * Don't need walk inlined functions recursively, because
889                  * inner inlined functions don't have the lines of the
890                  * specified function.
891                  */
892                 ret = __die_walk_funclines(rt_die, false, callback, data);
893         else {
894                 struct __line_walk_param param = {
895                         .callback = callback,
896                         .data = data,
897                         .retval = 0,
898                 };
899                 dwarf_getfuncs(cu_die, __die_walk_culines_cb, &param, 0);
900                 ret = param.retval;
901         }
902
903         return ret;
904 }
905
906 struct __find_variable_param {
907         const char *name;
908         Dwarf_Addr addr;
909 };
910
911 static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
912 {
913         struct __find_variable_param *fvp = data;
914         Dwarf_Attribute attr;
915         int tag;
916
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;
927         else
928                 return DIE_FIND_CB_SIBLING;
929 }
930
931 /**
932  * die_find_variable_at - Find a given name variable at given address
933  * @sp_die: a function DIE
934  * @name: variable name
935  * @addr: address
936  * @die_mem: a buffer for result DIE
937  *
938  * Find a variable DIE called @name at @addr in @sp_die.
939  */
940 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
941                                 Dwarf_Addr addr, Dwarf_Die *die_mem)
942 {
943         struct __find_variable_param fvp = { .name = name, .addr = addr};
944
945         return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
946                               die_mem);
947 }
948
949 static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
950 {
951         const char *name = data;
952
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;
961                 }
962         }
963         return DIE_FIND_CB_SIBLING;
964 }
965
966 /**
967  * die_find_member - Find a given name member in a data structure
968  * @st_die: a data structure type DIE
969  * @name: member name
970  * @die_mem: a buffer for result DIE
971  *
972  * Find a member DIE called @name in @st_die.
973  */
974 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
975                            Dwarf_Die *die_mem)
976 {
977         return die_find_child(st_die, __die_find_member_cb, (void *)name,
978                               die_mem);
979 }
980
981 /**
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
985  *
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.
990  */
991 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf)
992 {
993         Dwarf_Die type;
994         int tag, ret;
995         const char *tmp = "";
996
997         if (__die_get_real_type(vr_die, &type) == NULL)
998                 return -ENOENT;
999
1000         tag = dwarf_tag(&type);
1001         if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
1002                 tmp = "*";
1003         else if (tag == DW_TAG_subroutine_type) {
1004                 /* Function pointer */
1005                 return strbuf_add(buf, "(function_type)", 15);
1006         } else {
1007                 if (!dwarf_diename(&type))
1008                         return -ENOENT;
1009                 if (tag == DW_TAG_union_type)
1010                         tmp = "union ";
1011                 else if (tag == DW_TAG_structure_type)
1012                         tmp = "struct ";
1013                 else if (tag == DW_TAG_enumeration_type)
1014                         tmp = "enum ";
1015                 /* Write a base name */
1016                 return strbuf_addf(buf, "%s%s", tmp, dwarf_diename(&type));
1017         }
1018         ret = die_get_typename(&type, buf);
1019         return ret ? ret : strbuf_addstr(buf, tmp);
1020 }
1021
1022 /**
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
1026  *
1027  * Get the name and type of @vr_die and stores it in @buf as "type\tname".
1028  */
1029 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf)
1030 {
1031         int ret;
1032
1033         ret = die_get_typename(vr_die, buf);
1034         if (ret < 0) {
1035                 pr_debug("Failed to get type, make it unknown.\n");
1036                 ret = strbuf_add(buf, " (unknown_type)", 14);
1037         }
1038
1039         return ret < 0 ? ret : strbuf_addf(buf, "\t%s", dwarf_diename(vr_die));
1040 }
1041
1042 #ifdef HAVE_DWARF_GETLOCATIONS_SUPPORT
1043 /**
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
1048  *
1049  * Get the innermost scope range of @vr_die and stores it in @buf as
1050  * "@<function_name+[NN-NN,NN-NN]>".
1051  */
1052 static int die_get_var_innermost_scope(Dwarf_Die *sp_die, Dwarf_Die *vr_die,
1053                                 struct strbuf *buf)
1054 {
1055         Dwarf_Die *scopes;
1056         int count;
1057         size_t offset = 0;
1058         Dwarf_Addr base;
1059         Dwarf_Addr start, end;
1060         Dwarf_Addr entry;
1061         int ret;
1062         bool first = true;
1063         const char *name;
1064
1065         ret = die_entrypc(sp_die, &entry);
1066         if (ret)
1067                 return ret;
1068
1069         name = dwarf_diename(sp_die);
1070         if (!name)
1071                 return -ENOENT;
1072
1073         count = dwarf_getscopes_die(vr_die, &scopes);
1074
1075         /* (*SCOPES)[1] is the DIE for the scope containing that scope */
1076         if (count <= 1) {
1077                 ret = -EINVAL;
1078                 goto out;
1079         }
1080
1081         while ((offset = dwarf_ranges(&scopes[1], offset, &base,
1082                                         &start, &end)) > 0) {
1083                 start -= entry;
1084                 end -= entry;
1085
1086                 if (first) {
1087                         ret = strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1088                                           name, start, end);
1089                         first = false;
1090                 } else {
1091                         ret = strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1092                                           start, end);
1093                 }
1094                 if (ret < 0)
1095                         goto out;
1096         }
1097
1098         if (!first)
1099                 ret = strbuf_add(buf, "]>", 2);
1100
1101 out:
1102         free(scopes);
1103         return ret;
1104 }
1105
1106 /**
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
1111  *
1112  * Get the byte offset range of @vr_die and stores it in @buf as
1113  * "@<function_name+[NN-NN,NN-NN]>".
1114  */
1115 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf)
1116 {
1117         int ret = 0;
1118         Dwarf_Addr base;
1119         Dwarf_Addr start, end;
1120         Dwarf_Addr entry;
1121         Dwarf_Op *op;
1122         size_t nops;
1123         size_t offset = 0;
1124         Dwarf_Attribute attr;
1125         bool first = true;
1126         const char *name;
1127
1128         ret = die_entrypc(sp_die, &entry);
1129         if (ret)
1130                 return ret;
1131
1132         name = dwarf_diename(sp_die);
1133         if (!name)
1134                 return -ENOENT;
1135
1136         if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
1137                 return -EINVAL;
1138
1139         while ((offset = dwarf_getlocations(&attr, offset, &base,
1140                                         &start, &end, &op, &nops)) > 0) {
1141                 if (start == 0) {
1142                         /* Single Location Descriptions */
1143                         ret = die_get_var_innermost_scope(sp_die, vr_die, buf);
1144                         goto out;
1145                 }
1146
1147                 /* Location Lists */
1148                 start -= entry;
1149                 end -= entry;
1150                 if (first) {
1151                         ret = strbuf_addf(buf, "@<%s+[%" PRIu64 "-%" PRIu64,
1152                                           name, start, end);
1153                         first = false;
1154                 } else {
1155                         ret = strbuf_addf(buf, ",%" PRIu64 "-%" PRIu64,
1156                                           start, end);
1157                 }
1158                 if (ret < 0)
1159                         goto out;
1160         }
1161
1162         if (!first)
1163                 ret = strbuf_add(buf, "]>", 2);
1164 out:
1165         return ret;
1166 }
1167 #else
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)
1171 {
1172         return -ENOTSUP;
1173 }
1174 #endif
1175
1176 /*
1177  * die_has_loclist - Check if DW_AT_location of @vr_die is a location list
1178  * @vr_die: a variable DIE
1179  */
1180 static bool die_has_loclist(Dwarf_Die *vr_die)
1181 {
1182         Dwarf_Attribute loc;
1183         int tag = dwarf_tag(vr_die);
1184
1185         if (tag != DW_TAG_formal_parameter &&
1186             tag != DW_TAG_variable)
1187                 return false;
1188
1189         return (dwarf_attr_integrate(vr_die, DW_AT_location, &loc) &&
1190                 dwarf_whatform(&loc) == DW_FORM_sec_offset);
1191 }
1192
1193 /*
1194  * die_is_optimized_target - Check if target program is compiled with
1195  * optimization
1196  * @cu_die: a CU DIE
1197  *
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
1200  * clang as well.
1201  */
1202 bool die_is_optimized_target(Dwarf_Die *cu_die)
1203 {
1204         Dwarf_Die tmp_die;
1205
1206         if (die_has_loclist(cu_die))
1207                 return true;
1208
1209         if (!dwarf_child(cu_die, &tmp_die) &&
1210             die_is_optimized_target(&tmp_die))
1211                 return true;
1212
1213         if (!dwarf_siblingof(cu_die, &tmp_die) &&
1214             die_is_optimized_target(&tmp_die))
1215                 return true;
1216
1217         return false;
1218 }
1219
1220 /*
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)
1226  *
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.
1231  */
1232 static bool die_search_idx(Dwarf_Lines *lines, unsigned long nr_lines,
1233                            Dwarf_Addr addr, unsigned long *idx)
1234 {
1235         unsigned long i;
1236         Dwarf_Addr tmp;
1237
1238         for (i = 0; i < nr_lines; i++) {
1239                 if (dwarf_lineaddr(dwarf_onesrcline(lines, i), &tmp))
1240                         return false;
1241
1242                 if (tmp == addr) {
1243                         *idx = i;
1244                         return true;
1245                 }
1246         }
1247         return false;
1248 }
1249
1250 /*
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)
1257  *
1258  * Look for prologue-end marker. If there is no explicit marker, return
1259  * address of next line record or next source line.
1260  */
1261 static bool die_get_postprologue_addr(unsigned long entrypc_idx,
1262                                       Dwarf_Lines *lines,
1263                                       unsigned long nr_lines,
1264                                       Dwarf_Addr highpc,
1265                                       Dwarf_Addr *postprologue_addr)
1266 {
1267         unsigned long i;
1268         int entrypc_lno, lno;
1269         Dwarf_Line *line;
1270         Dwarf_Addr addr;
1271         bool p_end;
1272
1273         /* entrypc_lno is actual source line number */
1274         line = dwarf_onesrcline(lines, entrypc_idx);
1275         if (dwarf_lineno(line, &entrypc_lno))
1276                 return false;
1277
1278         for (i = entrypc_idx; i < nr_lines; i++) {
1279                 line = dwarf_onesrcline(lines, i);
1280
1281                 if (dwarf_lineaddr(line, &addr) ||
1282                     dwarf_lineno(line, &lno)    ||
1283                     dwarf_lineprologueend(line, &p_end))
1284                         return false;
1285
1286                 /* highpc is exclusive. [entrypc,highpc) */
1287                 if (addr >= highpc)
1288                         break;
1289
1290                 /* clang supports prologue-end marker */
1291                 if (p_end)
1292                         break;
1293
1294                 /* Actual next line in source */
1295                 if (lno != entrypc_lno)
1296                         break;
1297
1298                 /*
1299                  * Single source line can have multiple line records.
1300                  * For Example,
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.
1305                  */
1306                 if (i != entrypc_idx)
1307                         break;
1308         }
1309
1310         dwarf_lineaddr(line, postprologue_addr);
1311         if (*postprologue_addr >= highpc)
1312                 dwarf_lineaddr(dwarf_onesrcline(lines, i - 1),
1313                                postprologue_addr);
1314
1315         return true;
1316 }
1317
1318 /*
1319  * die_skip_prologue - Use next address after prologue as probe location
1320  * @sp_die: a subprogram DIE
1321  * @cu_die: a CU DIE
1322  * @entrypc: entrypc of the function
1323  *
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
1328  * garbage value.
1329  */
1330 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
1331                        Dwarf_Addr *entrypc)
1332 {
1333         size_t nr_lines = 0;
1334         unsigned long entrypc_idx = 0;
1335         Dwarf_Lines *lines = NULL;
1336         Dwarf_Addr postprologue_addr;
1337         Dwarf_Addr highpc;
1338
1339         if (dwarf_highpc(sp_die, &highpc))
1340                 return;
1341
1342         if (dwarf_getsrclines(cu_die, &lines, &nr_lines))
1343                 return;
1344
1345         if (!die_search_idx(lines, nr_lines, *entrypc, &entrypc_idx))
1346                 return;
1347
1348         if (!die_get_postprologue_addr(entrypc_idx, lines, nr_lines,
1349                                        highpc, &postprologue_addr))
1350                 return;
1351
1352         *entrypc = postprologue_addr;
1353 }