ARM: dts: kirkwood: gpio-leds fixes for linkstation ls-wvl/vl
[linux/fpc-iii.git] / tools / perf / util / probe-finder.c
blob2be10fb27172727fe15d5f3822ff194a5ad96d95
1 /*
2 * probe-finder.c : C expression to kprobe event converter
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include <sys/utsname.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <fcntl.h>
26 #include <errno.h>
27 #include <stdio.h>
28 #include <unistd.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <stdarg.h>
32 #include <dwarf-regs.h>
34 #include <linux/bitops.h>
35 #include "event.h"
36 #include "dso.h"
37 #include "debug.h"
38 #include "intlist.h"
39 #include "util.h"
40 #include "symbol.h"
41 #include "probe-finder.h"
43 /* Kprobe tracer basic type is up to u64 */
44 #define MAX_BASIC_TYPE_BITS 64
46 /* Dwarf FL wrappers */
47 static char *debuginfo_path; /* Currently dummy */
49 static const Dwfl_Callbacks offline_callbacks = {
50 .find_debuginfo = dwfl_standard_find_debuginfo,
51 .debuginfo_path = &debuginfo_path,
53 .section_address = dwfl_offline_section_address,
55 /* We use this table for core files too. */
56 .find_elf = dwfl_build_id_find_elf,
59 /* Get a Dwarf from offline image */
60 static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
61 const char *path)
63 int fd;
65 fd = open(path, O_RDONLY);
66 if (fd < 0)
67 return fd;
69 dbg->dwfl = dwfl_begin(&offline_callbacks);
70 if (!dbg->dwfl)
71 goto error;
73 dwfl_report_begin(dbg->dwfl);
74 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
75 if (!dbg->mod)
76 goto error;
78 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
79 if (!dbg->dbg)
80 goto error;
82 dwfl_report_end(dbg->dwfl, NULL, NULL);
84 return 0;
85 error:
86 if (dbg->dwfl)
87 dwfl_end(dbg->dwfl);
88 else
89 close(fd);
90 memset(dbg, 0, sizeof(*dbg));
92 return -ENOENT;
95 static struct debuginfo *__debuginfo__new(const char *path)
97 struct debuginfo *dbg = zalloc(sizeof(*dbg));
98 if (!dbg)
99 return NULL;
101 if (debuginfo__init_offline_dwarf(dbg, path) < 0)
102 zfree(&dbg);
103 if (dbg)
104 pr_debug("Open Debuginfo file: %s\n", path);
105 return dbg;
108 enum dso_binary_type distro_dwarf_types[] = {
109 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
110 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
111 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
112 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
113 DSO_BINARY_TYPE__NOT_FOUND,
116 struct debuginfo *debuginfo__new(const char *path)
118 enum dso_binary_type *type;
119 char buf[PATH_MAX], nil = '\0';
120 struct dso *dso;
121 struct debuginfo *dinfo = NULL;
123 /* Try to open distro debuginfo files */
124 dso = dso__new(path);
125 if (!dso)
126 goto out;
128 for (type = distro_dwarf_types;
129 !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
130 type++) {
131 if (dso__read_binary_type_filename(dso, *type, &nil,
132 buf, PATH_MAX) < 0)
133 continue;
134 dinfo = __debuginfo__new(buf);
136 dso__put(dso);
138 out:
139 /* if failed to open all distro debuginfo, open given binary */
140 return dinfo ? : __debuginfo__new(path);
143 void debuginfo__delete(struct debuginfo *dbg)
145 if (dbg) {
146 if (dbg->dwfl)
147 dwfl_end(dbg->dwfl);
148 free(dbg);
153 * Probe finder related functions
156 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
158 struct probe_trace_arg_ref *ref;
159 ref = zalloc(sizeof(struct probe_trace_arg_ref));
160 if (ref != NULL)
161 ref->offset = offs;
162 return ref;
166 * Convert a location into trace_arg.
167 * If tvar == NULL, this just checks variable can be converted.
168 * If fentry == true and vr_die is a parameter, do huristic search
169 * for the location fuzzed by function entry mcount.
171 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
172 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
173 struct probe_trace_arg *tvar)
175 Dwarf_Attribute attr;
176 Dwarf_Addr tmp = 0;
177 Dwarf_Op *op;
178 size_t nops;
179 unsigned int regn;
180 Dwarf_Word offs = 0;
181 bool ref = false;
182 const char *regs;
183 int ret, ret2 = 0;
185 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
186 goto static_var;
188 /* TODO: handle more than 1 exprs */
189 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
190 return -EINVAL; /* Broken DIE ? */
191 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
192 ret = dwarf_entrypc(sp_die, &tmp);
193 if (ret)
194 return -ENOENT;
196 if (probe_conf.show_location_range &&
197 (dwarf_tag(vr_die) == DW_TAG_variable)) {
198 ret2 = -ERANGE;
199 } else if (addr != tmp ||
200 dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
201 return -ENOENT;
204 ret = dwarf_highpc(sp_die, &tmp);
205 if (ret)
206 return -ENOENT;
208 * This is fuzzed by fentry mcount. We try to find the
209 * parameter location at the earliest address.
211 for (addr += 1; addr <= tmp; addr++) {
212 if (dwarf_getlocation_addr(&attr, addr, &op,
213 &nops, 1) > 0)
214 goto found;
216 return -ENOENT;
218 found:
219 if (nops == 0)
220 /* TODO: Support const_value */
221 return -ENOENT;
223 if (op->atom == DW_OP_addr) {
224 static_var:
225 if (!tvar)
226 return ret2;
227 /* Static variables on memory (not stack), make @varname */
228 ret = strlen(dwarf_diename(vr_die));
229 tvar->value = zalloc(ret + 2);
230 if (tvar->value == NULL)
231 return -ENOMEM;
232 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
233 tvar->ref = alloc_trace_arg_ref((long)offs);
234 if (tvar->ref == NULL)
235 return -ENOMEM;
236 return ret2;
239 /* If this is based on frame buffer, set the offset */
240 if (op->atom == DW_OP_fbreg) {
241 if (fb_ops == NULL)
242 return -ENOTSUP;
243 ref = true;
244 offs = op->number;
245 op = &fb_ops[0];
248 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
249 regn = op->atom - DW_OP_breg0;
250 offs += op->number;
251 ref = true;
252 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
253 regn = op->atom - DW_OP_reg0;
254 } else if (op->atom == DW_OP_bregx) {
255 regn = op->number;
256 offs += op->number2;
257 ref = true;
258 } else if (op->atom == DW_OP_regx) {
259 regn = op->number;
260 } else {
261 pr_debug("DW_OP %x is not supported.\n", op->atom);
262 return -ENOTSUP;
265 if (!tvar)
266 return ret2;
268 regs = get_arch_regstr(regn);
269 if (!regs) {
270 /* This should be a bug in DWARF or this tool */
271 pr_warning("Mapping for the register number %u "
272 "missing on this architecture.\n", regn);
273 return -ENOTSUP;
276 tvar->value = strdup(regs);
277 if (tvar->value == NULL)
278 return -ENOMEM;
280 if (ref) {
281 tvar->ref = alloc_trace_arg_ref((long)offs);
282 if (tvar->ref == NULL)
283 return -ENOMEM;
285 return ret2;
288 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
290 static int convert_variable_type(Dwarf_Die *vr_die,
291 struct probe_trace_arg *tvar,
292 const char *cast)
294 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
295 Dwarf_Die type;
296 char buf[16];
297 char sbuf[STRERR_BUFSIZE];
298 int bsize, boffs, total;
299 int ret;
301 /* TODO: check all types */
302 if (cast && strcmp(cast, "string") != 0) {
303 /* Non string type is OK */
304 tvar->type = strdup(cast);
305 return (tvar->type == NULL) ? -ENOMEM : 0;
308 bsize = dwarf_bitsize(vr_die);
309 if (bsize > 0) {
310 /* This is a bitfield */
311 boffs = dwarf_bitoffset(vr_die);
312 total = dwarf_bytesize(vr_die);
313 if (boffs < 0 || total < 0)
314 return -ENOENT;
315 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
316 BYTES_TO_BITS(total));
317 goto formatted;
320 if (die_get_real_type(vr_die, &type) == NULL) {
321 pr_warning("Failed to get a type information of %s.\n",
322 dwarf_diename(vr_die));
323 return -ENOENT;
326 pr_debug("%s type is %s.\n",
327 dwarf_diename(vr_die), dwarf_diename(&type));
329 if (cast && strcmp(cast, "string") == 0) { /* String type */
330 ret = dwarf_tag(&type);
331 if (ret != DW_TAG_pointer_type &&
332 ret != DW_TAG_array_type) {
333 pr_warning("Failed to cast into string: "
334 "%s(%s) is not a pointer nor array.\n",
335 dwarf_diename(vr_die), dwarf_diename(&type));
336 return -EINVAL;
338 if (die_get_real_type(&type, &type) == NULL) {
339 pr_warning("Failed to get a type"
340 " information.\n");
341 return -ENOENT;
343 if (ret == DW_TAG_pointer_type) {
344 while (*ref_ptr)
345 ref_ptr = &(*ref_ptr)->next;
346 /* Add new reference with offset +0 */
347 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
348 if (*ref_ptr == NULL) {
349 pr_warning("Out of memory error\n");
350 return -ENOMEM;
353 if (!die_compare_name(&type, "char") &&
354 !die_compare_name(&type, "unsigned char")) {
355 pr_warning("Failed to cast into string: "
356 "%s is not (unsigned) char *.\n",
357 dwarf_diename(vr_die));
358 return -EINVAL;
360 tvar->type = strdup(cast);
361 return (tvar->type == NULL) ? -ENOMEM : 0;
364 ret = dwarf_bytesize(&type);
365 if (ret <= 0)
366 /* No size ... try to use default type */
367 return 0;
368 ret = BYTES_TO_BITS(ret);
370 /* Check the bitwidth */
371 if (ret > MAX_BASIC_TYPE_BITS) {
372 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
373 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
374 ret = MAX_BASIC_TYPE_BITS;
376 ret = snprintf(buf, 16, "%c%d",
377 die_is_signed_type(&type) ? 's' : 'u', ret);
379 formatted:
380 if (ret < 0 || ret >= 16) {
381 if (ret >= 16)
382 ret = -E2BIG;
383 pr_warning("Failed to convert variable type: %s\n",
384 strerror_r(-ret, sbuf, sizeof(sbuf)));
385 return ret;
387 tvar->type = strdup(buf);
388 if (tvar->type == NULL)
389 return -ENOMEM;
390 return 0;
393 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
394 struct perf_probe_arg_field *field,
395 struct probe_trace_arg_ref **ref_ptr,
396 Dwarf_Die *die_mem)
398 struct probe_trace_arg_ref *ref = *ref_ptr;
399 Dwarf_Die type;
400 Dwarf_Word offs;
401 int ret, tag;
403 pr_debug("converting %s in %s\n", field->name, varname);
404 if (die_get_real_type(vr_die, &type) == NULL) {
405 pr_warning("Failed to get the type of %s.\n", varname);
406 return -ENOENT;
408 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
409 tag = dwarf_tag(&type);
411 if (field->name[0] == '[' &&
412 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
413 if (field->next)
414 /* Save original type for next field */
415 memcpy(die_mem, &type, sizeof(*die_mem));
416 /* Get the type of this array */
417 if (die_get_real_type(&type, &type) == NULL) {
418 pr_warning("Failed to get the type of %s.\n", varname);
419 return -ENOENT;
421 pr_debug2("Array real type: (%x)\n",
422 (unsigned)dwarf_dieoffset(&type));
423 if (tag == DW_TAG_pointer_type) {
424 ref = zalloc(sizeof(struct probe_trace_arg_ref));
425 if (ref == NULL)
426 return -ENOMEM;
427 if (*ref_ptr)
428 (*ref_ptr)->next = ref;
429 else
430 *ref_ptr = ref;
432 ref->offset += dwarf_bytesize(&type) * field->index;
433 if (!field->next)
434 /* Save vr_die for converting types */
435 memcpy(die_mem, vr_die, sizeof(*die_mem));
436 goto next;
437 } else if (tag == DW_TAG_pointer_type) {
438 /* Check the pointer and dereference */
439 if (!field->ref) {
440 pr_err("Semantic error: %s must be referred by '->'\n",
441 field->name);
442 return -EINVAL;
444 /* Get the type pointed by this pointer */
445 if (die_get_real_type(&type, &type) == NULL) {
446 pr_warning("Failed to get the type of %s.\n", varname);
447 return -ENOENT;
449 /* Verify it is a data structure */
450 tag = dwarf_tag(&type);
451 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
452 pr_warning("%s is not a data structure nor an union.\n",
453 varname);
454 return -EINVAL;
457 ref = zalloc(sizeof(struct probe_trace_arg_ref));
458 if (ref == NULL)
459 return -ENOMEM;
460 if (*ref_ptr)
461 (*ref_ptr)->next = ref;
462 else
463 *ref_ptr = ref;
464 } else {
465 /* Verify it is a data structure */
466 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
467 pr_warning("%s is not a data structure nor an union.\n",
468 varname);
469 return -EINVAL;
471 if (field->name[0] == '[') {
472 pr_err("Semantic error: %s is not a pointer"
473 " nor array.\n", varname);
474 return -EINVAL;
476 /* While prcessing unnamed field, we don't care about this */
477 if (field->ref && dwarf_diename(vr_die)) {
478 pr_err("Semantic error: %s must be referred by '.'\n",
479 field->name);
480 return -EINVAL;
482 if (!ref) {
483 pr_warning("Structure on a register is not "
484 "supported yet.\n");
485 return -ENOTSUP;
489 if (die_find_member(&type, field->name, die_mem) == NULL) {
490 pr_warning("%s(type:%s) has no member %s.\n", varname,
491 dwarf_diename(&type), field->name);
492 return -EINVAL;
495 /* Get the offset of the field */
496 if (tag == DW_TAG_union_type) {
497 offs = 0;
498 } else {
499 ret = die_get_data_member_location(die_mem, &offs);
500 if (ret < 0) {
501 pr_warning("Failed to get the offset of %s.\n",
502 field->name);
503 return ret;
506 ref->offset += (long)offs;
508 /* If this member is unnamed, we need to reuse this field */
509 if (!dwarf_diename(die_mem))
510 return convert_variable_fields(die_mem, varname, field,
511 &ref, die_mem);
513 next:
514 /* Converting next field */
515 if (field->next)
516 return convert_variable_fields(die_mem, field->name,
517 field->next, &ref, die_mem);
518 else
519 return 0;
522 /* Show a variables in kprobe event format */
523 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
525 Dwarf_Die die_mem;
526 int ret;
528 pr_debug("Converting variable %s into trace event.\n",
529 dwarf_diename(vr_die));
531 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
532 &pf->sp_die, pf->tvar);
533 if (ret == -ENOENT || ret == -EINVAL) {
534 pr_err("Failed to find the location of the '%s' variable at this address.\n"
535 " Perhaps it has been optimized out.\n"
536 " Use -V with the --range option to show '%s' location range.\n",
537 pf->pvar->var, pf->pvar->var);
538 } else if (ret == -ENOTSUP)
539 pr_err("Sorry, we don't support this variable location yet.\n");
540 else if (ret == 0 && pf->pvar->field) {
541 ret = convert_variable_fields(vr_die, pf->pvar->var,
542 pf->pvar->field, &pf->tvar->ref,
543 &die_mem);
544 vr_die = &die_mem;
546 if (ret == 0)
547 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
548 /* *expr will be cached in libdw. Don't free it. */
549 return ret;
552 /* Find a variable in a scope DIE */
553 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
555 Dwarf_Die vr_die;
556 char buf[32], *ptr;
557 int ret = 0;
559 /* Copy raw parameters */
560 if (!is_c_varname(pf->pvar->var))
561 return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
563 if (pf->pvar->name)
564 pf->tvar->name = strdup(pf->pvar->name);
565 else {
566 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
567 if (ret < 0)
568 return ret;
569 ptr = strchr(buf, ':'); /* Change type separator to _ */
570 if (ptr)
571 *ptr = '_';
572 pf->tvar->name = strdup(buf);
574 if (pf->tvar->name == NULL)
575 return -ENOMEM;
577 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
578 /* Search child die for local variables and parameters. */
579 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
580 /* Search again in global variables */
581 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
582 0, &vr_die)) {
583 pr_warning("Failed to find '%s' in this function.\n",
584 pf->pvar->var);
585 ret = -ENOENT;
588 if (ret >= 0)
589 ret = convert_variable(&vr_die, pf);
591 return ret;
594 /* Convert subprogram DIE to trace point */
595 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
596 Dwarf_Addr paddr, bool retprobe,
597 const char *function,
598 struct probe_trace_point *tp)
600 Dwarf_Addr eaddr, highaddr;
601 GElf_Sym sym;
602 const char *symbol;
604 /* Verify the address is correct */
605 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
606 pr_warning("Failed to get entry address of %s\n",
607 dwarf_diename(sp_die));
608 return -ENOENT;
610 if (dwarf_highpc(sp_die, &highaddr) != 0) {
611 pr_warning("Failed to get end address of %s\n",
612 dwarf_diename(sp_die));
613 return -ENOENT;
615 if (paddr > highaddr) {
616 pr_warning("Offset specified is greater than size of %s\n",
617 dwarf_diename(sp_die));
618 return -EINVAL;
621 symbol = dwarf_diename(sp_die);
622 if (!symbol) {
623 /* Try to get the symbol name from symtab */
624 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
625 if (!symbol) {
626 pr_warning("Failed to find symbol at 0x%lx\n",
627 (unsigned long)paddr);
628 return -ENOENT;
630 eaddr = sym.st_value;
632 tp->offset = (unsigned long)(paddr - eaddr);
633 tp->address = (unsigned long)paddr;
634 tp->symbol = strdup(symbol);
635 if (!tp->symbol)
636 return -ENOMEM;
638 /* Return probe must be on the head of a subprogram */
639 if (retprobe) {
640 if (eaddr != paddr) {
641 pr_warning("Failed to find \"%s%%return\",\n"
642 " because %s is an inlined function and"
643 " has no return point.\n", function,
644 function);
645 return -EINVAL;
647 tp->retprobe = true;
650 return 0;
653 /* Call probe_finder callback with scope DIE */
654 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
656 Dwarf_Attribute fb_attr;
657 Dwarf_Frame *frame = NULL;
658 size_t nops;
659 int ret;
661 if (!sc_die) {
662 pr_err("Caller must pass a scope DIE. Program error.\n");
663 return -EINVAL;
666 /* If not a real subprogram, find a real one */
667 if (!die_is_func_def(sc_die)) {
668 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
669 if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
670 pr_warning("Ignoring tail call from %s\n",
671 dwarf_diename(&pf->sp_die));
672 return 0;
673 } else {
674 pr_warning("Failed to find probe point in any "
675 "functions.\n");
676 return -ENOENT;
679 } else
680 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
682 /* Get the frame base attribute/ops from subprogram */
683 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
684 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
685 if (ret <= 0 || nops == 0) {
686 pf->fb_ops = NULL;
687 #if _ELFUTILS_PREREQ(0, 142)
688 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
689 pf->cfi != NULL) {
690 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
691 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
692 pr_warning("Failed to get call frame on 0x%jx\n",
693 (uintmax_t)pf->addr);
694 free(frame);
695 return -ENOENT;
697 #endif
700 /* Call finder's callback handler */
701 ret = pf->callback(sc_die, pf);
703 /* Since *pf->fb_ops can be a part of frame. we should free it here. */
704 free(frame);
705 pf->fb_ops = NULL;
707 return ret;
710 struct find_scope_param {
711 const char *function;
712 const char *file;
713 int line;
714 int diff;
715 Dwarf_Die *die_mem;
716 bool found;
719 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
721 struct find_scope_param *fsp = data;
722 const char *file;
723 int lno;
725 /* Skip if declared file name does not match */
726 if (fsp->file) {
727 file = dwarf_decl_file(fn_die);
728 if (!file || strcmp(fsp->file, file) != 0)
729 return 0;
731 /* If the function name is given, that's what user expects */
732 if (fsp->function) {
733 if (die_match_name(fn_die, fsp->function)) {
734 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
735 fsp->found = true;
736 return 1;
738 } else {
739 /* With the line number, find the nearest declared DIE */
740 dwarf_decl_line(fn_die, &lno);
741 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
742 /* Keep a candidate and continue */
743 fsp->diff = fsp->line - lno;
744 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
745 fsp->found = true;
748 return 0;
751 /* Find an appropriate scope fits to given conditions */
752 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
754 struct find_scope_param fsp = {
755 .function = pf->pev->point.function,
756 .file = pf->fname,
757 .line = pf->lno,
758 .diff = INT_MAX,
759 .die_mem = die_mem,
760 .found = false,
763 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
765 return fsp.found ? die_mem : NULL;
768 static int probe_point_line_walker(const char *fname, int lineno,
769 Dwarf_Addr addr, void *data)
771 struct probe_finder *pf = data;
772 Dwarf_Die *sc_die, die_mem;
773 int ret;
775 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
776 return 0;
778 pf->addr = addr;
779 sc_die = find_best_scope(pf, &die_mem);
780 if (!sc_die) {
781 pr_warning("Failed to find scope of probe point.\n");
782 return -ENOENT;
785 ret = call_probe_finder(sc_die, pf);
787 /* Continue if no error, because the line will be in inline function */
788 return ret < 0 ? ret : 0;
791 /* Find probe point from its line number */
792 static int find_probe_point_by_line(struct probe_finder *pf)
794 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
797 /* Find lines which match lazy pattern */
798 static int find_lazy_match_lines(struct intlist *list,
799 const char *fname, const char *pat)
801 FILE *fp;
802 char *line = NULL;
803 size_t line_len;
804 ssize_t len;
805 int count = 0, linenum = 1;
806 char sbuf[STRERR_BUFSIZE];
808 fp = fopen(fname, "r");
809 if (!fp) {
810 pr_warning("Failed to open %s: %s\n", fname,
811 strerror_r(errno, sbuf, sizeof(sbuf)));
812 return -errno;
815 while ((len = getline(&line, &line_len, fp)) > 0) {
817 if (line[len - 1] == '\n')
818 line[len - 1] = '\0';
820 if (strlazymatch(line, pat)) {
821 intlist__add(list, linenum);
822 count++;
824 linenum++;
827 if (ferror(fp))
828 count = -errno;
829 free(line);
830 fclose(fp);
832 if (count == 0)
833 pr_debug("No matched lines found in %s.\n", fname);
834 return count;
837 static int probe_point_lazy_walker(const char *fname, int lineno,
838 Dwarf_Addr addr, void *data)
840 struct probe_finder *pf = data;
841 Dwarf_Die *sc_die, die_mem;
842 int ret;
844 if (!intlist__has_entry(pf->lcache, lineno) ||
845 strtailcmp(fname, pf->fname) != 0)
846 return 0;
848 pr_debug("Probe line found: line:%d addr:0x%llx\n",
849 lineno, (unsigned long long)addr);
850 pf->addr = addr;
851 pf->lno = lineno;
852 sc_die = find_best_scope(pf, &die_mem);
853 if (!sc_die) {
854 pr_warning("Failed to find scope of probe point.\n");
855 return -ENOENT;
858 ret = call_probe_finder(sc_die, pf);
861 * Continue if no error, because the lazy pattern will match
862 * to other lines
864 return ret < 0 ? ret : 0;
867 /* Find probe points from lazy pattern */
868 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
870 int ret = 0;
871 char *fpath;
873 if (intlist__empty(pf->lcache)) {
874 const char *comp_dir;
876 comp_dir = cu_get_comp_dir(&pf->cu_die);
877 ret = get_real_path(pf->fname, comp_dir, &fpath);
878 if (ret < 0) {
879 pr_warning("Failed to find source file path.\n");
880 return ret;
883 /* Matching lazy line pattern */
884 ret = find_lazy_match_lines(pf->lcache, fpath,
885 pf->pev->point.lazy_line);
886 free(fpath);
887 if (ret <= 0)
888 return ret;
891 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
894 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
896 struct probe_finder *pf = data;
897 struct perf_probe_point *pp = &pf->pev->point;
898 Dwarf_Addr addr;
899 int ret;
901 if (pp->lazy_line)
902 ret = find_probe_point_lazy(in_die, pf);
903 else {
904 /* Get probe address */
905 if (dwarf_entrypc(in_die, &addr) != 0) {
906 pr_warning("Failed to get entry address of %s.\n",
907 dwarf_diename(in_die));
908 return -ENOENT;
910 pf->addr = addr;
911 pf->addr += pp->offset;
912 pr_debug("found inline addr: 0x%jx\n",
913 (uintmax_t)pf->addr);
915 ret = call_probe_finder(in_die, pf);
918 return ret;
921 /* Callback parameter with return value for libdw */
922 struct dwarf_callback_param {
923 void *data;
924 int retval;
927 /* Search function from function name */
928 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
930 struct dwarf_callback_param *param = data;
931 struct probe_finder *pf = param->data;
932 struct perf_probe_point *pp = &pf->pev->point;
934 /* Check tag and diename */
935 if (!die_is_func_def(sp_die) ||
936 !die_match_name(sp_die, pp->function))
937 return DWARF_CB_OK;
939 /* Check declared file */
940 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
941 return DWARF_CB_OK;
943 pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
944 pf->fname = dwarf_decl_file(sp_die);
945 if (pp->line) { /* Function relative line */
946 dwarf_decl_line(sp_die, &pf->lno);
947 pf->lno += pp->line;
948 param->retval = find_probe_point_by_line(pf);
949 } else if (die_is_func_instance(sp_die)) {
950 /* Instances always have the entry address */
951 dwarf_entrypc(sp_die, &pf->addr);
952 /* Real function */
953 if (pp->lazy_line)
954 param->retval = find_probe_point_lazy(sp_die, pf);
955 else {
956 pf->addr += pp->offset;
957 /* TODO: Check the address in this function */
958 param->retval = call_probe_finder(sp_die, pf);
960 } else if (!probe_conf.no_inlines) {
961 /* Inlined function: search instances */
962 param->retval = die_walk_instances(sp_die,
963 probe_point_inline_cb, (void *)pf);
964 /* This could be a non-existed inline definition */
965 if (param->retval == -ENOENT && strisglob(pp->function))
966 param->retval = 0;
969 /* We need to find other candidates */
970 if (strisglob(pp->function) && param->retval >= 0) {
971 param->retval = 0; /* We have to clear the result */
972 return DWARF_CB_OK;
975 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
978 static int find_probe_point_by_func(struct probe_finder *pf)
980 struct dwarf_callback_param _param = {.data = (void *)pf,
981 .retval = 0};
982 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
983 return _param.retval;
986 struct pubname_callback_param {
987 char *function;
988 char *file;
989 Dwarf_Die *cu_die;
990 Dwarf_Die *sp_die;
991 int found;
994 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
996 struct pubname_callback_param *param = data;
998 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
999 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1000 return DWARF_CB_OK;
1002 if (die_match_name(param->sp_die, param->function)) {
1003 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1004 return DWARF_CB_OK;
1006 if (param->file &&
1007 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1008 return DWARF_CB_OK;
1010 param->found = 1;
1011 return DWARF_CB_ABORT;
1015 return DWARF_CB_OK;
1018 /* Find probe points from debuginfo */
1019 static int debuginfo__find_probes(struct debuginfo *dbg,
1020 struct probe_finder *pf)
1022 struct perf_probe_point *pp = &pf->pev->point;
1023 Dwarf_Off off, noff;
1024 size_t cuhl;
1025 Dwarf_Die *diep;
1026 int ret = 0;
1028 #if _ELFUTILS_PREREQ(0, 142)
1029 Elf *elf;
1030 GElf_Ehdr ehdr;
1031 GElf_Shdr shdr;
1033 /* Get the call frame information from this dwarf */
1034 elf = dwarf_getelf(dbg->dbg);
1035 if (elf == NULL)
1036 return -EINVAL;
1038 if (gelf_getehdr(elf, &ehdr) == NULL)
1039 return -EINVAL;
1041 if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1042 shdr.sh_type == SHT_PROGBITS) {
1043 pf->cfi = dwarf_getcfi_elf(elf);
1044 } else {
1045 pf->cfi = dwarf_getcfi(dbg->dbg);
1047 #endif
1049 off = 0;
1050 pf->lcache = intlist__new(NULL);
1051 if (!pf->lcache)
1052 return -ENOMEM;
1054 /* Fastpath: lookup by function name from .debug_pubnames section */
1055 if (pp->function && !strisglob(pp->function)) {
1056 struct pubname_callback_param pubname_param = {
1057 .function = pp->function,
1058 .file = pp->file,
1059 .cu_die = &pf->cu_die,
1060 .sp_die = &pf->sp_die,
1061 .found = 0,
1063 struct dwarf_callback_param probe_param = {
1064 .data = pf,
1067 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1068 &pubname_param, 0);
1069 if (pubname_param.found) {
1070 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1071 if (ret)
1072 goto found;
1076 /* Loop on CUs (Compilation Unit) */
1077 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1078 /* Get the DIE(Debugging Information Entry) of this CU */
1079 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1080 if (!diep)
1081 continue;
1083 /* Check if target file is included. */
1084 if (pp->file)
1085 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1086 else
1087 pf->fname = NULL;
1089 if (!pp->file || pf->fname) {
1090 if (pp->function)
1091 ret = find_probe_point_by_func(pf);
1092 else if (pp->lazy_line)
1093 ret = find_probe_point_lazy(&pf->cu_die, pf);
1094 else {
1095 pf->lno = pp->line;
1096 ret = find_probe_point_by_line(pf);
1098 if (ret < 0)
1099 break;
1101 off = noff;
1104 found:
1105 intlist__delete(pf->lcache);
1106 pf->lcache = NULL;
1108 return ret;
1111 struct local_vars_finder {
1112 struct probe_finder *pf;
1113 struct perf_probe_arg *args;
1114 bool vars;
1115 int max_args;
1116 int nargs;
1117 int ret;
1120 /* Collect available variables in this scope */
1121 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1123 struct local_vars_finder *vf = data;
1124 struct probe_finder *pf = vf->pf;
1125 int tag;
1127 tag = dwarf_tag(die_mem);
1128 if (tag == DW_TAG_formal_parameter ||
1129 (tag == DW_TAG_variable && vf->vars)) {
1130 if (convert_variable_location(die_mem, vf->pf->addr,
1131 vf->pf->fb_ops, &pf->sp_die,
1132 NULL) == 0) {
1133 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1134 if (vf->args[vf->nargs].var == NULL) {
1135 vf->ret = -ENOMEM;
1136 return DIE_FIND_CB_END;
1138 pr_debug(" %s", vf->args[vf->nargs].var);
1139 vf->nargs++;
1143 if (dwarf_haspc(die_mem, vf->pf->addr))
1144 return DIE_FIND_CB_CONTINUE;
1145 else
1146 return DIE_FIND_CB_SIBLING;
1149 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1150 struct perf_probe_arg *args)
1152 Dwarf_Die die_mem;
1153 int i;
1154 int n = 0;
1155 struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1156 .max_args = MAX_PROBE_ARGS, .ret = 0};
1158 for (i = 0; i < pf->pev->nargs; i++) {
1159 /* var never be NULL */
1160 if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1161 vf.vars = true;
1162 else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1163 /* Copy normal argument */
1164 args[n] = pf->pev->args[i];
1165 n++;
1166 continue;
1168 pr_debug("Expanding %s into:", pf->pev->args[i].var);
1169 vf.nargs = n;
1170 /* Special local variables */
1171 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1172 &die_mem);
1173 pr_debug(" (%d)\n", vf.nargs - n);
1174 if (vf.ret < 0)
1175 return vf.ret;
1176 n = vf.nargs;
1178 return n;
1181 /* Add a found probe point into trace event list */
1182 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1184 struct trace_event_finder *tf =
1185 container_of(pf, struct trace_event_finder, pf);
1186 struct perf_probe_point *pp = &pf->pev->point;
1187 struct probe_trace_event *tev;
1188 struct perf_probe_arg *args = NULL;
1189 int ret, i;
1191 /* Check number of tevs */
1192 if (tf->ntevs == tf->max_tevs) {
1193 pr_warning("Too many( > %d) probe point found.\n",
1194 tf->max_tevs);
1195 return -ERANGE;
1197 tev = &tf->tevs[tf->ntevs++];
1199 /* Trace point should be converted from subprogram DIE */
1200 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1201 pp->retprobe, pp->function, &tev->point);
1202 if (ret < 0)
1203 goto end;
1205 tev->point.realname = strdup(dwarf_diename(sc_die));
1206 if (!tev->point.realname) {
1207 ret = -ENOMEM;
1208 goto end;
1211 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1212 tev->point.offset);
1214 /* Expand special probe argument if exist */
1215 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1216 if (args == NULL) {
1217 ret = -ENOMEM;
1218 goto end;
1221 ret = expand_probe_args(sc_die, pf, args);
1222 if (ret < 0)
1223 goto end;
1225 tev->nargs = ret;
1226 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1227 if (tev->args == NULL) {
1228 ret = -ENOMEM;
1229 goto end;
1232 /* Find each argument */
1233 for (i = 0; i < tev->nargs; i++) {
1234 pf->pvar = &args[i];
1235 pf->tvar = &tev->args[i];
1236 /* Variable should be found from scope DIE */
1237 ret = find_variable(sc_die, pf);
1238 if (ret != 0)
1239 break;
1242 end:
1243 if (ret) {
1244 clear_probe_trace_event(tev);
1245 tf->ntevs--;
1247 free(args);
1248 return ret;
1251 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1252 int debuginfo__find_trace_events(struct debuginfo *dbg,
1253 struct perf_probe_event *pev,
1254 struct probe_trace_event **tevs)
1256 struct trace_event_finder tf = {
1257 .pf = {.pev = pev, .callback = add_probe_trace_event},
1258 .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1259 int ret, i;
1261 /* Allocate result tevs array */
1262 *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1263 if (*tevs == NULL)
1264 return -ENOMEM;
1266 tf.tevs = *tevs;
1267 tf.ntevs = 0;
1269 ret = debuginfo__find_probes(dbg, &tf.pf);
1270 if (ret < 0) {
1271 for (i = 0; i < tf.ntevs; i++)
1272 clear_probe_trace_event(&tf.tevs[i]);
1273 zfree(tevs);
1274 return ret;
1277 return (ret < 0) ? ret : tf.ntevs;
1280 /* Collect available variables in this scope */
1281 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1283 struct available_var_finder *af = data;
1284 struct variable_list *vl;
1285 int tag, ret;
1287 vl = &af->vls[af->nvls - 1];
1289 tag = dwarf_tag(die_mem);
1290 if (tag == DW_TAG_formal_parameter ||
1291 tag == DW_TAG_variable) {
1292 ret = convert_variable_location(die_mem, af->pf.addr,
1293 af->pf.fb_ops, &af->pf.sp_die,
1294 NULL);
1295 if (ret == 0 || ret == -ERANGE) {
1296 int ret2;
1297 bool externs = !af->child;
1298 struct strbuf buf;
1300 strbuf_init(&buf, 64);
1302 if (probe_conf.show_location_range) {
1303 if (!externs) {
1304 if (ret)
1305 strbuf_addf(&buf, "[INV]\t");
1306 else
1307 strbuf_addf(&buf, "[VAL]\t");
1308 } else
1309 strbuf_addf(&buf, "[EXT]\t");
1312 ret2 = die_get_varname(die_mem, &buf);
1314 if (!ret2 && probe_conf.show_location_range &&
1315 !externs) {
1316 strbuf_addf(&buf, "\t");
1317 ret2 = die_get_var_range(&af->pf.sp_die,
1318 die_mem, &buf);
1321 pr_debug("Add new var: %s\n", buf.buf);
1322 if (ret2 == 0) {
1323 strlist__add(vl->vars,
1324 strbuf_detach(&buf, NULL));
1326 strbuf_release(&buf);
1330 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1331 return DIE_FIND_CB_CONTINUE;
1332 else
1333 return DIE_FIND_CB_SIBLING;
1336 /* Add a found vars into available variables list */
1337 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1339 struct available_var_finder *af =
1340 container_of(pf, struct available_var_finder, pf);
1341 struct perf_probe_point *pp = &pf->pev->point;
1342 struct variable_list *vl;
1343 Dwarf_Die die_mem;
1344 int ret;
1346 /* Check number of tevs */
1347 if (af->nvls == af->max_vls) {
1348 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1349 return -ERANGE;
1351 vl = &af->vls[af->nvls++];
1353 /* Trace point should be converted from subprogram DIE */
1354 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1355 pp->retprobe, pp->function, &vl->point);
1356 if (ret < 0)
1357 return ret;
1359 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1360 vl->point.offset);
1362 /* Find local variables */
1363 vl->vars = strlist__new(NULL, NULL);
1364 if (vl->vars == NULL)
1365 return -ENOMEM;
1366 af->child = true;
1367 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1369 /* Find external variables */
1370 if (!probe_conf.show_ext_vars)
1371 goto out;
1372 /* Don't need to search child DIE for external vars. */
1373 af->child = false;
1374 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1376 out:
1377 if (strlist__empty(vl->vars)) {
1378 strlist__delete(vl->vars);
1379 vl->vars = NULL;
1382 return ret;
1386 * Find available variables at given probe point
1387 * Return the number of found probe points. Return 0 if there is no
1388 * matched probe point. Return <0 if an error occurs.
1390 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1391 struct perf_probe_event *pev,
1392 struct variable_list **vls)
1394 struct available_var_finder af = {
1395 .pf = {.pev = pev, .callback = add_available_vars},
1396 .mod = dbg->mod,
1397 .max_vls = probe_conf.max_probes};
1398 int ret;
1400 /* Allocate result vls array */
1401 *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1402 if (*vls == NULL)
1403 return -ENOMEM;
1405 af.vls = *vls;
1406 af.nvls = 0;
1408 ret = debuginfo__find_probes(dbg, &af.pf);
1409 if (ret < 0) {
1410 /* Free vlist for error */
1411 while (af.nvls--) {
1412 zfree(&af.vls[af.nvls].point.symbol);
1413 strlist__delete(af.vls[af.nvls].vars);
1415 zfree(vls);
1416 return ret;
1419 return (ret < 0) ? ret : af.nvls;
1422 /* For the kernel module, we need a special code to get a DIE */
1423 static int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs)
1425 int n, i;
1426 Elf32_Word shndx;
1427 Elf_Scn *scn;
1428 Elf *elf;
1429 GElf_Shdr mem, *shdr;
1430 const char *p;
1432 elf = dwfl_module_getelf(dbg->mod, &dbg->bias);
1433 if (!elf)
1434 return -EINVAL;
1436 /* Get the number of relocations */
1437 n = dwfl_module_relocations(dbg->mod);
1438 if (n < 0)
1439 return -ENOENT;
1440 /* Search the relocation related .text section */
1441 for (i = 0; i < n; i++) {
1442 p = dwfl_module_relocation_info(dbg->mod, i, &shndx);
1443 if (strcmp(p, ".text") == 0) {
1444 /* OK, get the section header */
1445 scn = elf_getscn(elf, shndx);
1446 if (!scn)
1447 return -ENOENT;
1448 shdr = gelf_getshdr(scn, &mem);
1449 if (!shdr)
1450 return -ENOENT;
1451 *offs = shdr->sh_addr;
1454 return 0;
1457 /* Reverse search */
1458 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1459 struct perf_probe_point *ppt)
1461 Dwarf_Die cudie, spdie, indie;
1462 Dwarf_Addr _addr = 0, baseaddr = 0;
1463 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1464 int baseline = 0, lineno = 0, ret = 0;
1465 bool reloc = false;
1467 retry:
1468 /* Find cu die */
1469 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1470 if (!reloc && debuginfo__get_text_offset(dbg, &baseaddr) == 0) {
1471 addr += baseaddr;
1472 reloc = true;
1473 goto retry;
1475 pr_warning("Failed to find debug information for address %lx\n",
1476 addr);
1477 ret = -EINVAL;
1478 goto end;
1481 /* Find a corresponding line (filename and lineno) */
1482 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1483 /* Don't care whether it failed or not */
1485 /* Find a corresponding function (name, baseline and baseaddr) */
1486 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1487 /* Get function entry information */
1488 func = basefunc = dwarf_diename(&spdie);
1489 if (!func ||
1490 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1491 dwarf_decl_line(&spdie, &baseline) != 0) {
1492 lineno = 0;
1493 goto post;
1496 fname = dwarf_decl_file(&spdie);
1497 if (addr == (unsigned long)baseaddr) {
1498 /* Function entry - Relative line number is 0 */
1499 lineno = baseline;
1500 goto post;
1503 /* Track down the inline functions step by step */
1504 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1505 &indie)) {
1506 /* There is an inline function */
1507 if (dwarf_entrypc(&indie, &_addr) == 0 &&
1508 _addr == addr) {
1510 * addr is at an inline function entry.
1511 * In this case, lineno should be the call-site
1512 * line number. (overwrite lineinfo)
1514 lineno = die_get_call_lineno(&indie);
1515 fname = die_get_call_file(&indie);
1516 break;
1517 } else {
1519 * addr is in an inline function body.
1520 * Since lineno points one of the lines
1521 * of the inline function, baseline should
1522 * be the entry line of the inline function.
1524 tmp = dwarf_diename(&indie);
1525 if (!tmp ||
1526 dwarf_decl_line(&indie, &baseline) != 0)
1527 break;
1528 func = tmp;
1529 spdie = indie;
1532 /* Verify the lineno and baseline are in a same file */
1533 tmp = dwarf_decl_file(&spdie);
1534 if (!tmp || strcmp(tmp, fname) != 0)
1535 lineno = 0;
1538 post:
1539 /* Make a relative line number or an offset */
1540 if (lineno)
1541 ppt->line = lineno - baseline;
1542 else if (basefunc) {
1543 ppt->offset = addr - (unsigned long)baseaddr;
1544 func = basefunc;
1547 /* Duplicate strings */
1548 if (func) {
1549 ppt->function = strdup(func);
1550 if (ppt->function == NULL) {
1551 ret = -ENOMEM;
1552 goto end;
1555 if (fname) {
1556 ppt->file = strdup(fname);
1557 if (ppt->file == NULL) {
1558 zfree(&ppt->function);
1559 ret = -ENOMEM;
1560 goto end;
1563 end:
1564 if (ret == 0 && (fname || func))
1565 ret = 1; /* Found a point */
1566 return ret;
1569 /* Add a line and store the src path */
1570 static int line_range_add_line(const char *src, unsigned int lineno,
1571 struct line_range *lr)
1573 /* Copy source path */
1574 if (!lr->path) {
1575 lr->path = strdup(src);
1576 if (lr->path == NULL)
1577 return -ENOMEM;
1579 return intlist__add(lr->line_list, lineno);
1582 static int line_range_walk_cb(const char *fname, int lineno,
1583 Dwarf_Addr addr __maybe_unused,
1584 void *data)
1586 struct line_finder *lf = data;
1587 int err;
1589 if ((strtailcmp(fname, lf->fname) != 0) ||
1590 (lf->lno_s > lineno || lf->lno_e < lineno))
1591 return 0;
1593 err = line_range_add_line(fname, lineno, lf->lr);
1594 if (err < 0 && err != -EEXIST)
1595 return err;
1597 return 0;
1600 /* Find line range from its line number */
1601 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1603 int ret;
1605 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1607 /* Update status */
1608 if (ret >= 0)
1609 if (!intlist__empty(lf->lr->line_list))
1610 ret = lf->found = 1;
1611 else
1612 ret = 0; /* Lines are not found */
1613 else {
1614 zfree(&lf->lr->path);
1616 return ret;
1619 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1621 int ret = find_line_range_by_line(in_die, data);
1624 * We have to check all instances of inlined function, because
1625 * some execution paths can be optimized out depends on the
1626 * function argument of instances. However, if an error occurs,
1627 * it should be handled by the caller.
1629 return ret < 0 ? ret : 0;
1632 /* Search function definition from function name */
1633 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1635 struct dwarf_callback_param *param = data;
1636 struct line_finder *lf = param->data;
1637 struct line_range *lr = lf->lr;
1639 /* Check declared file */
1640 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1641 return DWARF_CB_OK;
1643 if (die_is_func_def(sp_die) &&
1644 die_match_name(sp_die, lr->function)) {
1645 lf->fname = dwarf_decl_file(sp_die);
1646 dwarf_decl_line(sp_die, &lr->offset);
1647 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1648 lf->lno_s = lr->offset + lr->start;
1649 if (lf->lno_s < 0) /* Overflow */
1650 lf->lno_s = INT_MAX;
1651 lf->lno_e = lr->offset + lr->end;
1652 if (lf->lno_e < 0) /* Overflow */
1653 lf->lno_e = INT_MAX;
1654 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1655 lr->start = lf->lno_s;
1656 lr->end = lf->lno_e;
1657 if (!die_is_func_instance(sp_die))
1658 param->retval = die_walk_instances(sp_die,
1659 line_range_inline_cb, lf);
1660 else
1661 param->retval = find_line_range_by_line(sp_die, lf);
1662 return DWARF_CB_ABORT;
1664 return DWARF_CB_OK;
1667 static int find_line_range_by_func(struct line_finder *lf)
1669 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1670 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
1671 return param.retval;
1674 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1676 struct line_finder lf = {.lr = lr, .found = 0};
1677 int ret = 0;
1678 Dwarf_Off off = 0, noff;
1679 size_t cuhl;
1680 Dwarf_Die *diep;
1681 const char *comp_dir;
1683 /* Fastpath: lookup by function name from .debug_pubnames section */
1684 if (lr->function) {
1685 struct pubname_callback_param pubname_param = {
1686 .function = lr->function, .file = lr->file,
1687 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1688 struct dwarf_callback_param line_range_param = {
1689 .data = (void *)&lf, .retval = 0};
1691 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1692 &pubname_param, 0);
1693 if (pubname_param.found) {
1694 line_range_search_cb(&lf.sp_die, &line_range_param);
1695 if (lf.found)
1696 goto found;
1700 /* Loop on CUs (Compilation Unit) */
1701 while (!lf.found && ret >= 0) {
1702 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1703 NULL, NULL, NULL) != 0)
1704 break;
1706 /* Get the DIE(Debugging Information Entry) of this CU */
1707 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1708 if (!diep)
1709 continue;
1711 /* Check if target file is included. */
1712 if (lr->file)
1713 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1714 else
1715 lf.fname = 0;
1717 if (!lr->file || lf.fname) {
1718 if (lr->function)
1719 ret = find_line_range_by_func(&lf);
1720 else {
1721 lf.lno_s = lr->start;
1722 lf.lno_e = lr->end;
1723 ret = find_line_range_by_line(NULL, &lf);
1726 off = noff;
1729 found:
1730 /* Store comp_dir */
1731 if (lf.found) {
1732 comp_dir = cu_get_comp_dir(&lf.cu_die);
1733 if (comp_dir) {
1734 lr->comp_dir = strdup(comp_dir);
1735 if (!lr->comp_dir)
1736 ret = -ENOMEM;
1740 pr_debug("path: %s\n", lr->path);
1741 return (ret < 0) ? ret : lf.found;
1745 * Find a src file from a DWARF tag path. Prepend optional source path prefix
1746 * and chop off leading directories that do not exist. Result is passed back as
1747 * a newly allocated path on success.
1748 * Return 0 if file was found and readable, -errno otherwise.
1750 int get_real_path(const char *raw_path, const char *comp_dir,
1751 char **new_path)
1753 const char *prefix = symbol_conf.source_prefix;
1755 if (!prefix) {
1756 if (raw_path[0] != '/' && comp_dir)
1757 /* If not an absolute path, try to use comp_dir */
1758 prefix = comp_dir;
1759 else {
1760 if (access(raw_path, R_OK) == 0) {
1761 *new_path = strdup(raw_path);
1762 return *new_path ? 0 : -ENOMEM;
1763 } else
1764 return -errno;
1768 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
1769 if (!*new_path)
1770 return -ENOMEM;
1772 for (;;) {
1773 sprintf(*new_path, "%s/%s", prefix, raw_path);
1775 if (access(*new_path, R_OK) == 0)
1776 return 0;
1778 if (!symbol_conf.source_prefix) {
1779 /* In case of searching comp_dir, don't retry */
1780 zfree(new_path);
1781 return -errno;
1784 switch (errno) {
1785 case ENAMETOOLONG:
1786 case ENOENT:
1787 case EROFS:
1788 case EFAULT:
1789 raw_path = strchr(++raw_path, '/');
1790 if (!raw_path) {
1791 zfree(new_path);
1792 return -ENOENT;
1794 continue;
1796 default:
1797 zfree(new_path);
1798 return -errno;