]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/util/dwarf-aux.c
perf trace: Removed duplicated NULL test
[mirror_ubuntu-hirsute-kernel.git] / tools / perf / util / dwarf-aux.c
CommitLineData
e0d153c6
MH
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 <stdbool.h>
21#include "util.h"
22#include "debug.h"
23#include "dwarf-aux.h"
24
25/**
26 * cu_find_realpath - Find the realpath of the target file
27 * @cu_die: A DIE(dwarf information entry) of CU(compilation Unit)
28 * @fname: The tail filename of the target file
29 *
30 * Find the real(long) path of @fname in @cu_die.
31 */
32const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
33{
34 Dwarf_Files *files;
35 size_t nfiles, i;
36 const char *src = NULL;
37 int ret;
38
39 if (!fname)
40 return NULL;
41
42 ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
43 if (ret != 0)
44 return NULL;
45
46 for (i = 0; i < nfiles; i++) {
47 src = dwarf_filesrc(files, i, NULL, NULL);
48 if (strtailcmp(src, fname) == 0)
49 break;
50 }
51 if (i == nfiles)
52 return NULL;
53 return src;
54}
55
56/**
57 * cu_get_comp_dir - Get the path of compilation directory
58 * @cu_die: a CU DIE
59 *
60 * Get the path of compilation directory of given @cu_die.
61 * Since this depends on DW_AT_comp_dir, older gcc will not
62 * embedded it. In that case, this returns NULL.
63 */
64const char *cu_get_comp_dir(Dwarf_Die *cu_die)
65{
66 Dwarf_Attribute attr;
67 if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
68 return NULL;
69 return dwarf_formstring(&attr);
70}
71
72/**
73 * cu_find_lineinfo - Get a line number and file name for given address
74 * @cu_die: a CU DIE
75 * @addr: An address
76 * @fname: a pointer which returns the file name string
77 * @lineno: a pointer which returns the line number
78 *
79 * Find a line number and file name for @addr in @cu_die.
80 */
81int cu_find_lineinfo(Dwarf_Die *cu_die, unsigned long addr,
82 const char **fname, int *lineno)
83{
84 Dwarf_Line *line;
85 Dwarf_Addr laddr;
86
87 line = dwarf_getsrc_die(cu_die, (Dwarf_Addr)addr);
88 if (line && dwarf_lineaddr(line, &laddr) == 0 &&
89 addr == (unsigned long)laddr && dwarf_lineno(line, lineno) == 0) {
90 *fname = dwarf_linesrc(line, NULL, NULL);
91 if (!*fname)
92 /* line number is useless without filename */
93 *lineno = 0;
94 }
95
96 return *lineno ?: -ENOENT;
97}
98
221d0611
MH
99static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data);
100
101/**
102 * cu_walk_functions_at - Walk on function DIEs at given address
103 * @cu_die: A CU DIE
104 * @addr: An address
105 * @callback: A callback which called with found DIEs
106 * @data: A user data
107 *
108 * Walk on function DIEs at given @addr in @cu_die. Passed DIEs
109 * should be subprogram or inlined-subroutines.
110 */
111int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
112 int (*callback)(Dwarf_Die *, void *), void *data)
113{
114 Dwarf_Die die_mem;
115 Dwarf_Die *sc_die;
116 int ret = -ENOENT;
117
118 /* Inlined function could be recursive. Trace it until fail */
119 for (sc_die = die_find_realfunc(cu_die, addr, &die_mem);
120 sc_die != NULL;
121 sc_die = die_find_child(sc_die, __die_find_inline_cb, &addr,
122 &die_mem)) {
123 ret = callback(sc_die, data);
124 if (ret)
125 break;
126 }
127
128 return ret;
129
130}
131
e0d153c6
MH
132/**
133 * die_compare_name - Compare diename and tname
134 * @dw_die: a DIE
135 * @tname: a string of target name
136 *
137 * Compare the name of @dw_die and @tname. Return false if @dw_die has no name.
138 */
139bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
140{
141 const char *name;
4c859351 142
e0d153c6
MH
143 name = dwarf_diename(dw_die);
144 return name ? (strcmp(tname, name) == 0) : false;
145}
146
4c859351
MH
147/**
148 * die_match_name - Match diename and glob
149 * @dw_die: a DIE
150 * @glob: a string of target glob pattern
151 *
152 * Glob matching the name of @dw_die and @glob. Return false if matching fail.
153 */
154bool die_match_name(Dwarf_Die *dw_die, const char *glob)
155{
156 const char *name;
157
158 name = dwarf_diename(dw_die);
159 return name ? strglobmatch(name, glob) : false;
160}
161
e0d153c6
MH
162/**
163 * die_get_call_lineno - Get callsite line number of inline-function instance
164 * @in_die: a DIE of an inlined function instance
165 *
166 * Get call-site line number of @in_die. This means from where the inline
167 * function is called.
168 */
169int die_get_call_lineno(Dwarf_Die *in_die)
170{
171 Dwarf_Attribute attr;
172 Dwarf_Word ret;
173
174 if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
175 return -ENOENT;
176
177 dwarf_formudata(&attr, &ret);
178 return (int)ret;
179}
180
181/**
182 * die_get_type - Get type DIE
183 * @vr_die: a DIE of a variable
184 * @die_mem: where to store a type DIE
185 *
186 * Get a DIE of the type of given variable (@vr_die), and store
187 * it to die_mem. Return NULL if fails to get a type DIE.
188 */
189Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
190{
191 Dwarf_Attribute attr;
192
193 if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
194 dwarf_formref_die(&attr, die_mem))
195 return die_mem;
196 else
197 return NULL;
198}
199
200/* Get a type die, but skip qualifiers */
201static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
202{
203 int tag;
204
205 do {
206 vr_die = die_get_type(vr_die, die_mem);
207 if (!vr_die)
208 break;
209 tag = dwarf_tag(vr_die);
210 } while (tag == DW_TAG_const_type ||
211 tag == DW_TAG_restrict_type ||
212 tag == DW_TAG_volatile_type ||
213 tag == DW_TAG_shared_type);
214
215 return vr_die;
216}
217
218/**
219 * die_get_real_type - Get a type die, but skip qualifiers and typedef
220 * @vr_die: a DIE of a variable
221 * @die_mem: where to store a type DIE
222 *
223 * Get a DIE of the type of given variable (@vr_die), and store
224 * it to die_mem. Return NULL if fails to get a type DIE.
225 * If the type is qualifiers (e.g. const) or typedef, this skips it
226 * and tries to find real type (structure or basic types, e.g. int).
227 */
228Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
229{
230 do {
231 vr_die = __die_get_real_type(vr_die, die_mem);
232 } while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
233
234 return vr_die;
235}
236
237/* Get attribute and translate it as a udata */
238static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
239 Dwarf_Word *result)
240{
241 Dwarf_Attribute attr;
242
243 if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
244 dwarf_formudata(&attr, result) != 0)
245 return -ENOENT;
246
247 return 0;
248}
249
b0e9cb28
MH
250/* Get attribute and translate it as a sdata */
251static int die_get_attr_sdata(Dwarf_Die *tp_die, unsigned int attr_name,
252 Dwarf_Sword *result)
253{
254 Dwarf_Attribute attr;
255
256 if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
257 dwarf_formsdata(&attr, result) != 0)
258 return -ENOENT;
259
260 return 0;
261}
262
e0d153c6
MH
263/**
264 * die_is_signed_type - Check whether a type DIE is signed or not
265 * @tp_die: a DIE of a type
266 *
267 * Get the encoding of @tp_die and return true if the encoding
268 * is signed.
269 */
270bool die_is_signed_type(Dwarf_Die *tp_die)
271{
272 Dwarf_Word ret;
273
274 if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
275 return false;
276
277 return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
278 ret == DW_ATE_signed_fixed);
279}
280
0dbb1cac
MH
281/**
282 * die_is_func_def - Ensure that this DIE is a subprogram and definition
283 * @dw_die: a DIE
284 *
285 * Ensure that this DIE is a subprogram and NOT a declaration. This
286 * returns true if @dw_die is a function definition.
287 **/
288bool die_is_func_def(Dwarf_Die *dw_die)
289{
290 Dwarf_Attribute attr;
291
292 return (dwarf_tag(dw_die) == DW_TAG_subprogram &&
293 dwarf_attr(dw_die, DW_AT_declaration, &attr) == NULL);
294}
295
e1ecbbc3
MH
296/**
297 * die_is_func_instance - Ensure that this DIE is an instance of a subprogram
298 * @dw_die: a DIE
299 *
300 * Ensure that this DIE is an instance (which has an entry address).
301 * This returns true if @dw_die is a function instance. If not, you need to
302 * call die_walk_instances() to find actual instances.
303 **/
304bool die_is_func_instance(Dwarf_Die *dw_die)
305{
306 Dwarf_Addr tmp;
307
308 /* Actually gcc optimizes non-inline as like as inlined */
309 return !dwarf_func_inline(dw_die) && dwarf_entrypc(dw_die, &tmp) == 0;
310}
e0d153c6
MH
311/**
312 * die_get_data_member_location - Get the data-member offset
313 * @mb_die: a DIE of a member of a data structure
314 * @offs: The offset of the member in the data structure
315 *
316 * Get the offset of @mb_die in the data structure including @mb_die, and
317 * stores result offset to @offs. If any error occurs this returns errno.
318 */
319int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
320{
321 Dwarf_Attribute attr;
322 Dwarf_Op *expr;
323 size_t nexpr;
324 int ret;
325
326 if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
327 return -ENOENT;
328
329 if (dwarf_formudata(&attr, offs) != 0) {
330 /* DW_AT_data_member_location should be DW_OP_plus_uconst */
331 ret = dwarf_getlocation(&attr, &expr, &nexpr);
332 if (ret < 0 || nexpr == 0)
333 return -ENOENT;
334
335 if (expr[0].atom != DW_OP_plus_uconst || nexpr != 1) {
336 pr_debug("Unable to get offset:Unexpected OP %x (%zd)\n",
337 expr[0].atom, nexpr);
338 return -ENOTSUP;
339 }
340 *offs = (Dwarf_Word)expr[0].number;
341 }
342 return 0;
343}
344
b0e9cb28
MH
345/* Get the call file index number in CU DIE */
346static int die_get_call_fileno(Dwarf_Die *in_die)
347{
348 Dwarf_Sword idx;
349
350 if (die_get_attr_sdata(in_die, DW_AT_call_file, &idx) == 0)
351 return (int)idx;
352 else
353 return -ENOENT;
354}
355
3f4460a2
MH
356/* Get the declared file index number in CU DIE */
357static int die_get_decl_fileno(Dwarf_Die *pdie)
358{
359 Dwarf_Sword idx;
360
361 if (die_get_attr_sdata(pdie, DW_AT_decl_file, &idx) == 0)
362 return (int)idx;
363 else
364 return -ENOENT;
365}
366
b0e9cb28
MH
367/**
368 * die_get_call_file - Get callsite file name of inlined function instance
369 * @in_die: a DIE of an inlined function instance
370 *
371 * Get call-site file name of @in_die. This means from which file the inline
372 * function is called.
373 */
374const char *die_get_call_file(Dwarf_Die *in_die)
375{
376 Dwarf_Die cu_die;
377 Dwarf_Files *files;
378 int idx;
379
380 idx = die_get_call_fileno(in_die);
381 if (idx < 0 || !dwarf_diecu(in_die, &cu_die, NULL, NULL) ||
382 dwarf_getsrcfiles(&cu_die, &files, NULL) != 0)
383 return NULL;
384
385 return dwarf_filesrc(files, idx, NULL, NULL);
386}
387
388
e0d153c6
MH
389/**
390 * die_find_child - Generic DIE search function in DIE tree
391 * @rt_die: a root DIE
392 * @callback: a callback function
393 * @data: a user data passed to the callback function
394 * @die_mem: a buffer for result DIE
395 *
396 * Trace DIE tree from @rt_die and call @callback for each child DIE.
397 * If @callback returns DIE_FIND_CB_END, this stores the DIE into
398 * @die_mem and returns it. If @callback returns DIE_FIND_CB_CONTINUE,
399 * this continues to trace the tree. Optionally, @callback can return
400 * DIE_FIND_CB_CHILD and DIE_FIND_CB_SIBLING, those means trace only
401 * the children and trace only the siblings respectively.
402 * Returns NULL if @callback can't find any appropriate DIE.
403 */
404Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
405 int (*callback)(Dwarf_Die *, void *),
406 void *data, Dwarf_Die *die_mem)
407{
408 Dwarf_Die child_die;
409 int ret;
410
411 ret = dwarf_child(rt_die, die_mem);
412 if (ret != 0)
413 return NULL;
414
415 do {
416 ret = callback(die_mem, data);
417 if (ret == DIE_FIND_CB_END)
418 return die_mem;
419
420 if ((ret & DIE_FIND_CB_CHILD) &&
421 die_find_child(die_mem, callback, data, &child_die)) {
422 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
423 return die_mem;
424 }
425 } while ((ret & DIE_FIND_CB_SIBLING) &&
426 dwarf_siblingof(die_mem, die_mem) == 0);
427
428 return NULL;
429}
430
431struct __addr_die_search_param {
432 Dwarf_Addr addr;
433 Dwarf_Die *die_mem;
434};
435
436/* die_find callback for non-inlined function search */
437static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
438{
439 struct __addr_die_search_param *ad = data;
440
0dbb1cac
MH
441 /*
442 * Since a declaration entry doesn't has given pc, this always returns
443 * function definition entry.
444 */
e0d153c6
MH
445 if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
446 dwarf_haspc(fn_die, ad->addr)) {
447 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
448 return DWARF_CB_ABORT;
449 }
450 return DWARF_CB_OK;
451}
452
453/**
454 * die_find_realfunc - Search a non-inlined function at given address
455 * @cu_die: a CU DIE which including @addr
456 * @addr: target address
457 * @die_mem: a buffer for result DIE
458 *
459 * Search a non-inlined function DIE which includes @addr. Stores the
e08cfd4b 460 * DIE to @die_mem and returns it if found. Returns NULL if failed.
e0d153c6
MH
461 */
462Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
463 Dwarf_Die *die_mem)
464{
465 struct __addr_die_search_param ad;
466 ad.addr = addr;
467 ad.die_mem = die_mem;
468 /* dwarf_getscopes can't find subprogram. */
469 if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
470 return NULL;
471 else
472 return die_mem;
473}
474
475/* die_find callback for inline function search */
476static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
477{
478 Dwarf_Addr *addr = data;
479
480 if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
481 dwarf_haspc(die_mem, *addr))
482 return DIE_FIND_CB_END;
483
484 return DIE_FIND_CB_CONTINUE;
485}
486
e08cfd4b
MH
487/**
488 * die_find_top_inlinefunc - Search the top inlined function at given address
489 * @sp_die: a subprogram DIE which including @addr
490 * @addr: target address
491 * @die_mem: a buffer for result DIE
492 *
493 * Search an inlined function DIE which includes @addr. Stores the
494 * DIE to @die_mem and returns it if found. Returns NULL if failed.
495 * Even if several inlined functions are expanded recursively, this
496 * doesn't trace it down, and returns the topmost one.
497 */
498Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
499 Dwarf_Die *die_mem)
500{
501 return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
502}
503
e0d153c6
MH
504/**
505 * die_find_inlinefunc - Search an inlined function at given address
e08cfd4b 506 * @sp_die: a subprogram DIE which including @addr
e0d153c6
MH
507 * @addr: target address
508 * @die_mem: a buffer for result DIE
509 *
510 * Search an inlined function DIE which includes @addr. Stores the
e08cfd4b 511 * DIE to @die_mem and returns it if found. Returns NULL if failed.
e0d153c6 512 * If several inlined functions are expanded recursively, this trace
e08cfd4b 513 * it down and returns deepest one.
e0d153c6
MH
514 */
515Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
516 Dwarf_Die *die_mem)
517{
518 Dwarf_Die tmp_die;
519
520 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
521 if (!sp_die)
522 return NULL;
523
524 /* Inlined function could be recursive. Trace it until fail */
525 while (sp_die) {
526 memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
527 sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
528 &tmp_die);
529 }
530
531 return die_mem;
532}
533
db0d2c64
MH
534struct __instance_walk_param {
535 void *addr;
536 int (*callback)(Dwarf_Die *, void *);
537 void *data;
538 int retval;
539};
540
541static int __die_walk_instances_cb(Dwarf_Die *inst, void *data)
542{
543 struct __instance_walk_param *iwp = data;
544 Dwarf_Attribute attr_mem;
545 Dwarf_Die origin_mem;
546 Dwarf_Attribute *attr;
547 Dwarf_Die *origin;
3f4460a2 548 int tmp;
db0d2c64
MH
549
550 attr = dwarf_attr(inst, DW_AT_abstract_origin, &attr_mem);
551 if (attr == NULL)
552 return DIE_FIND_CB_CONTINUE;
553
554 origin = dwarf_formref_die(attr, &origin_mem);
555 if (origin == NULL || origin->addr != iwp->addr)
556 return DIE_FIND_CB_CONTINUE;
557
3f4460a2
MH
558 /* Ignore redundant instances */
559 if (dwarf_tag(inst) == DW_TAG_inlined_subroutine) {
560 dwarf_decl_line(origin, &tmp);
561 if (die_get_call_lineno(inst) == tmp) {
562 tmp = die_get_decl_fileno(origin);
563 if (die_get_call_fileno(inst) == tmp)
564 return DIE_FIND_CB_CONTINUE;
565 }
566 }
567
db0d2c64
MH
568 iwp->retval = iwp->callback(inst, iwp->data);
569
570 return (iwp->retval) ? DIE_FIND_CB_END : DIE_FIND_CB_CONTINUE;
571}
572
573/**
574 * die_walk_instances - Walk on instances of given DIE
575 * @or_die: an abstract original DIE
576 * @callback: a callback function which is called with instance DIE
577 * @data: user data
578 *
579 * Walk on the instances of give @in_die. @in_die must be an inlined function
580 * declartion. This returns the return value of @callback if it returns
581 * non-zero value, or -ENOENT if there is no instance.
582 */
583int die_walk_instances(Dwarf_Die *or_die, int (*callback)(Dwarf_Die *, void *),
584 void *data)
585{
586 Dwarf_Die cu_die;
587 Dwarf_Die die_mem;
588 struct __instance_walk_param iwp = {
589 .addr = or_die->addr,
590 .callback = callback,
591 .data = data,
592 .retval = -ENOENT,
593 };
594
595 if (dwarf_diecu(or_die, &cu_die, NULL, NULL) == NULL)
596 return -ENOENT;
597
598 die_find_child(&cu_die, __die_walk_instances_cb, &iwp, &die_mem);
599
600 return iwp.retval;
601}
602
e0d153c6
MH
603/* Line walker internal parameters */
604struct __line_walk_param {
b0e9cb28 605 bool recursive;
e0d153c6
MH
606 line_walk_callback_t callback;
607 void *data;
608 int retval;
609};
610
611static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
612{
613 struct __line_walk_param *lw = data;
b0e9cb28
MH
614 Dwarf_Addr addr = 0;
615 const char *fname;
e0d153c6
MH
616 int lineno;
617
618 if (dwarf_tag(in_die) == DW_TAG_inlined_subroutine) {
b0e9cb28 619 fname = die_get_call_file(in_die);
e0d153c6 620 lineno = die_get_call_lineno(in_die);
b0e9cb28
MH
621 if (fname && lineno > 0 && dwarf_entrypc(in_die, &addr) == 0) {
622 lw->retval = lw->callback(fname, lineno, addr, lw->data);
623 if (lw->retval != 0)
624 return DIE_FIND_CB_END;
625 }
626 }
627 if (!lw->recursive)
628 /* Don't need to search recursively */
629 return DIE_FIND_CB_SIBLING;
630
631 if (addr) {
632 fname = dwarf_decl_file(in_die);
633 if (fname && dwarf_decl_line(in_die, &lineno) == 0) {
634 lw->retval = lw->callback(fname, lineno, addr, lw->data);
e0d153c6
MH
635 if (lw->retval != 0)
636 return DIE_FIND_CB_END;
637 }
638 }
b0e9cb28
MH
639
640 /* Continue to search nested inlined function call-sites */
641 return DIE_FIND_CB_CONTINUE;
e0d153c6
MH
642}
643
644/* Walk on lines of blocks included in given DIE */
b0e9cb28 645static int __die_walk_funclines(Dwarf_Die *sp_die, bool recursive,
e0d153c6
MH
646 line_walk_callback_t callback, void *data)
647{
648 struct __line_walk_param lw = {
b0e9cb28 649 .recursive = recursive,
e0d153c6
MH
650 .callback = callback,
651 .data = data,
652 .retval = 0,
653 };
654 Dwarf_Die die_mem;
655 Dwarf_Addr addr;
b0e9cb28 656 const char *fname;
e0d153c6
MH
657 int lineno;
658
659 /* Handle function declaration line */
b0e9cb28
MH
660 fname = dwarf_decl_file(sp_die);
661 if (fname && dwarf_decl_line(sp_die, &lineno) == 0 &&
e0d153c6 662 dwarf_entrypc(sp_die, &addr) == 0) {
b0e9cb28 663 lw.retval = callback(fname, lineno, addr, data);
e0d153c6
MH
664 if (lw.retval != 0)
665 goto done;
666 }
667 die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
668done:
669 return lw.retval;
670}
671
672static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
673{
674 struct __line_walk_param *lw = data;
675
b0e9cb28 676 lw->retval = __die_walk_funclines(sp_die, true, lw->callback, lw->data);
e0d153c6
MH
677 if (lw->retval != 0)
678 return DWARF_CB_ABORT;
679
680 return DWARF_CB_OK;
681}
682
683/**
684 * die_walk_lines - Walk on lines inside given DIE
a128405c 685 * @rt_die: a root DIE (CU, subprogram or inlined_subroutine)
e0d153c6
MH
686 * @callback: callback routine
687 * @data: user data
688 *
689 * Walk on all lines inside given @rt_die and call @callback on each line.
690 * If the @rt_die is a function, walk only on the lines inside the function,
691 * otherwise @rt_die must be a CU DIE.
692 * Note that this walks not only dwarf line list, but also function entries
693 * and inline call-site.
694 */
695int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data)
696{
697 Dwarf_Lines *lines;
698 Dwarf_Line *line;
699 Dwarf_Addr addr;
700 const char *fname;
701 int lineno, ret = 0;
702 Dwarf_Die die_mem, *cu_die;
703 size_t nlines, i;
704
705 /* Get the CU die */
a128405c 706 if (dwarf_tag(rt_die) != DW_TAG_compile_unit)
e0d153c6
MH
707 cu_die = dwarf_diecu(rt_die, &die_mem, NULL, NULL);
708 else
709 cu_die = rt_die;
710 if (!cu_die) {
a128405c 711 pr_debug2("Failed to get CU from given DIE.\n");
e0d153c6
MH
712 return -EINVAL;
713 }
714
715 /* Get lines list in the CU */
716 if (dwarf_getsrclines(cu_die, &lines, &nlines) != 0) {
717 pr_debug2("Failed to get source lines on this CU.\n");
718 return -ENOENT;
719 }
720 pr_debug2("Get %zd lines from this CU\n", nlines);
721
722 /* Walk on the lines on lines list */
723 for (i = 0; i < nlines; i++) {
724 line = dwarf_onesrcline(lines, i);
725 if (line == NULL ||
726 dwarf_lineno(line, &lineno) != 0 ||
727 dwarf_lineaddr(line, &addr) != 0) {
728 pr_debug2("Failed to get line info. "
729 "Possible error in debuginfo.\n");
730 continue;
731 }
732 /* Filter lines based on address */
733 if (rt_die != cu_die)
734 /*
735 * Address filtering
736 * The line is included in given function, and
737 * no inline block includes it.
738 */
739 if (!dwarf_haspc(rt_die, addr) ||
740 die_find_inlinefunc(rt_die, addr, &die_mem))
741 continue;
742 /* Get source line */
743 fname = dwarf_linesrc(line, NULL, NULL);
744
745 ret = callback(fname, lineno, addr, data);
746 if (ret != 0)
747 return ret;
748 }
749
750 /*
751 * Dwarf lines doesn't include function declarations and inlined
752 * subroutines. We have to check functions list or given function.
753 */
754 if (rt_die != cu_die)
b0e9cb28
MH
755 /*
756 * Don't need walk functions recursively, because nested
757 * inlined functions don't have lines of the specified DIE.
758 */
759 ret = __die_walk_funclines(rt_die, false, callback, data);
e0d153c6
MH
760 else {
761 struct __line_walk_param param = {
762 .callback = callback,
763 .data = data,
764 .retval = 0,
765 };
766 dwarf_getfuncs(cu_die, __die_walk_culines_cb, &param, 0);
767 ret = param.retval;
768 }
769
770 return ret;
771}
772
773struct __find_variable_param {
774 const char *name;
775 Dwarf_Addr addr;
776};
777
778static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
779{
780 struct __find_variable_param *fvp = data;
082f96a9 781 Dwarf_Attribute attr;
e0d153c6
MH
782 int tag;
783
784 tag = dwarf_tag(die_mem);
785 if ((tag == DW_TAG_formal_parameter ||
786 tag == DW_TAG_variable) &&
082f96a9
MH
787 die_compare_name(die_mem, fvp->name) &&
788 /* Does the DIE have location information or external instance? */
789 (dwarf_attr(die_mem, DW_AT_external, &attr) ||
790 dwarf_attr(die_mem, DW_AT_location, &attr)))
e0d153c6 791 return DIE_FIND_CB_END;
e0d153c6
MH
792 if (dwarf_haspc(die_mem, fvp->addr))
793 return DIE_FIND_CB_CONTINUE;
794 else
795 return DIE_FIND_CB_SIBLING;
796}
797
798/**
799 * die_find_variable_at - Find a given name variable at given address
800 * @sp_die: a function DIE
801 * @name: variable name
802 * @addr: address
803 * @die_mem: a buffer for result DIE
804 *
805 * Find a variable DIE called @name at @addr in @sp_die.
806 */
807Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
808 Dwarf_Addr addr, Dwarf_Die *die_mem)
809{
810 struct __find_variable_param fvp = { .name = name, .addr = addr};
811
812 return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
813 die_mem);
814}
815
816static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
817{
818 const char *name = data;
819
c7273835
MH
820 if (dwarf_tag(die_mem) == DW_TAG_member) {
821 if (die_compare_name(die_mem, name))
822 return DIE_FIND_CB_END;
823 else if (!dwarf_diename(die_mem)) { /* Unnamed structure */
824 Dwarf_Die type_die, tmp_die;
825 if (die_get_type(die_mem, &type_die) &&
826 die_find_member(&type_die, name, &tmp_die))
827 return DIE_FIND_CB_END;
828 }
829 }
e0d153c6
MH
830 return DIE_FIND_CB_SIBLING;
831}
832
833/**
834 * die_find_member - Find a given name member in a data structure
835 * @st_die: a data structure type DIE
836 * @name: member name
837 * @die_mem: a buffer for result DIE
838 *
839 * Find a member DIE called @name in @st_die.
840 */
841Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
842 Dwarf_Die *die_mem)
843{
844 return die_find_child(st_die, __die_find_member_cb, (void *)name,
845 die_mem);
846}
847
848/**
849 * die_get_typename - Get the name of given variable DIE
850 * @vr_die: a variable DIE
851 * @buf: a buffer for result type name
852 * @len: a max-length of @buf
853 *
854 * Get the name of @vr_die and stores it to @buf. Return the actual length
855 * of type name if succeeded. Return -E2BIG if @len is not enough long, and
856 * Return -ENOENT if failed to find type name.
857 * Note that the result will stores typedef name if possible, and stores
858 * "*(function_type)" if the type is a function pointer.
859 */
860int die_get_typename(Dwarf_Die *vr_die, char *buf, int len)
861{
862 Dwarf_Die type;
863 int tag, ret, ret2;
864 const char *tmp = "";
865
866 if (__die_get_real_type(vr_die, &type) == NULL)
867 return -ENOENT;
868
869 tag = dwarf_tag(&type);
870 if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
871 tmp = "*";
872 else if (tag == DW_TAG_subroutine_type) {
873 /* Function pointer */
874 ret = snprintf(buf, len, "(function_type)");
875 return (ret >= len) ? -E2BIG : ret;
876 } else {
877 if (!dwarf_diename(&type))
878 return -ENOENT;
879 if (tag == DW_TAG_union_type)
880 tmp = "union ";
881 else if (tag == DW_TAG_structure_type)
882 tmp = "struct ";
bb2d17a0
HL
883 else if (tag == DW_TAG_enumeration_type)
884 tmp = "enum ";
e0d153c6
MH
885 /* Write a base name */
886 ret = snprintf(buf, len, "%s%s", tmp, dwarf_diename(&type));
887 return (ret >= len) ? -E2BIG : ret;
888 }
889 ret = die_get_typename(&type, buf, len);
890 if (ret > 0) {
891 ret2 = snprintf(buf + ret, len - ret, "%s", tmp);
892 ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
893 }
894 return ret;
895}
896
897/**
898 * die_get_varname - Get the name and type of given variable DIE
899 * @vr_die: a variable DIE
900 * @buf: a buffer for type and variable name
901 * @len: the max-length of @buf
902 *
903 * Get the name and type of @vr_die and stores it in @buf as "type\tname".
904 */
905int die_get_varname(Dwarf_Die *vr_die, char *buf, int len)
906{
907 int ret, ret2;
908
909 ret = die_get_typename(vr_die, buf, len);
910 if (ret < 0) {
911 pr_debug("Failed to get type, make it unknown.\n");
912 ret = snprintf(buf, len, "(unknown_type)");
913 }
914 if (ret > 0) {
915 ret2 = snprintf(buf + ret, len - ret, "\t%s",
916 dwarf_diename(vr_die));
917 ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
918 }
919 return ret;
920}
921