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>
32 #include <dwarf-regs.h>
34 #include <linux/bitops.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,
65 fd = open(path, O_RDONLY);
69 dbg->dwfl = dwfl_begin(&offline_callbacks);
73 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
77 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
87 memset(dbg, 0, sizeof(*dbg));
92 static struct debuginfo *__debuginfo__new(const char *path)
94 struct debuginfo *dbg = zalloc(sizeof(*dbg));
98 if (debuginfo__init_offline_dwarf(dbg, path) < 0)
101 pr_debug("Open Debuginfo file: %s\n", path);
105 enum dso_binary_type distro_dwarf_types[] = {
106 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
107 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
108 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
109 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
110 DSO_BINARY_TYPE__NOT_FOUND,
113 struct debuginfo *debuginfo__new(const char *path)
115 enum dso_binary_type *type;
116 char buf[PATH_MAX], nil = '\0';
118 struct debuginfo *dinfo = NULL;
120 /* Try to open distro debuginfo files */
121 dso = dso__new(path);
125 for (type = distro_dwarf_types;
126 !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
128 if (dso__read_binary_type_filename(dso, *type, &nil,
131 dinfo = __debuginfo__new(buf);
136 /* if failed to open all distro debuginfo, open given binary */
137 return dinfo ? : __debuginfo__new(path);
140 void debuginfo__delete(struct debuginfo *dbg)
150 * Probe finder related functions
153 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
155 struct probe_trace_arg_ref *ref;
156 ref = zalloc(sizeof(struct probe_trace_arg_ref));
163 * Convert a location into trace_arg.
164 * If tvar == NULL, this just checks variable can be converted.
165 * If fentry == true and vr_die is a parameter, do huristic search
166 * for the location fuzzed by function entry mcount.
168 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
169 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
170 struct probe_trace_arg *tvar)
172 Dwarf_Attribute attr;
182 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
185 /* TODO: handle more than 1 exprs */
186 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
187 return -EINVAL; /* Broken DIE ? */
188 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
189 ret = dwarf_entrypc(sp_die, &tmp);
193 if (probe_conf.show_location_range &&
194 (dwarf_tag(vr_die) == DW_TAG_variable)) {
196 } else if (addr != tmp ||
197 dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
201 ret = dwarf_highpc(sp_die, &tmp);
205 * This is fuzzed by fentry mcount. We try to find the
206 * parameter location at the earliest address.
208 for (addr += 1; addr <= tmp; addr++) {
209 if (dwarf_getlocation_addr(&attr, addr, &op,
217 /* TODO: Support const_value */
220 if (op->atom == DW_OP_addr) {
224 /* Static variables on memory (not stack), make @varname */
225 ret = strlen(dwarf_diename(vr_die));
226 tvar->value = zalloc(ret + 2);
227 if (tvar->value == NULL)
229 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
230 tvar->ref = alloc_trace_arg_ref((long)offs);
231 if (tvar->ref == NULL)
236 /* If this is based on frame buffer, set the offset */
237 if (op->atom == DW_OP_fbreg) {
245 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
246 regn = op->atom - DW_OP_breg0;
249 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
250 regn = op->atom - DW_OP_reg0;
251 } else if (op->atom == DW_OP_bregx) {
255 } else if (op->atom == DW_OP_regx) {
258 pr_debug("DW_OP %x is not supported.\n", op->atom);
265 regs = get_arch_regstr(regn);
267 /* This should be a bug in DWARF or this tool */
268 pr_warning("Mapping for the register number %u "
269 "missing on this architecture.\n", regn);
273 tvar->value = strdup(regs);
274 if (tvar->value == NULL)
278 tvar->ref = alloc_trace_arg_ref((long)offs);
279 if (tvar->ref == NULL)
285 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
287 static int convert_variable_type(Dwarf_Die *vr_die,
288 struct probe_trace_arg *tvar,
291 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
294 char sbuf[STRERR_BUFSIZE];
295 int bsize, boffs, total;
298 /* TODO: check all types */
299 if (cast && strcmp(cast, "string") != 0) {
300 /* Non string type is OK */
301 tvar->type = strdup(cast);
302 return (tvar->type == NULL) ? -ENOMEM : 0;
305 bsize = dwarf_bitsize(vr_die);
307 /* This is a bitfield */
308 boffs = dwarf_bitoffset(vr_die);
309 total = dwarf_bytesize(vr_die);
310 if (boffs < 0 || total < 0)
312 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
313 BYTES_TO_BITS(total));
317 if (die_get_real_type(vr_die, &type) == NULL) {
318 pr_warning("Failed to get a type information of %s.\n",
319 dwarf_diename(vr_die));
323 pr_debug("%s type is %s.\n",
324 dwarf_diename(vr_die), dwarf_diename(&type));
326 if (cast && strcmp(cast, "string") == 0) { /* String type */
327 ret = dwarf_tag(&type);
328 if (ret != DW_TAG_pointer_type &&
329 ret != DW_TAG_array_type) {
330 pr_warning("Failed to cast into string: "
331 "%s(%s) is not a pointer nor array.\n",
332 dwarf_diename(vr_die), dwarf_diename(&type));
335 if (die_get_real_type(&type, &type) == NULL) {
336 pr_warning("Failed to get a type"
340 if (ret == DW_TAG_pointer_type) {
342 ref_ptr = &(*ref_ptr)->next;
343 /* Add new reference with offset +0 */
344 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
345 if (*ref_ptr == NULL) {
346 pr_warning("Out of memory error\n");
350 if (!die_compare_name(&type, "char") &&
351 !die_compare_name(&type, "unsigned char")) {
352 pr_warning("Failed to cast into string: "
353 "%s is not (unsigned) char *.\n",
354 dwarf_diename(vr_die));
357 tvar->type = strdup(cast);
358 return (tvar->type == NULL) ? -ENOMEM : 0;
361 ret = dwarf_bytesize(&type);
363 /* No size ... try to use default type */
365 ret = BYTES_TO_BITS(ret);
367 /* Check the bitwidth */
368 if (ret > MAX_BASIC_TYPE_BITS) {
369 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
370 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
371 ret = MAX_BASIC_TYPE_BITS;
373 ret = snprintf(buf, 16, "%c%d",
374 die_is_signed_type(&type) ? 's' : 'u', ret);
377 if (ret < 0 || ret >= 16) {
380 pr_warning("Failed to convert variable type: %s\n",
381 strerror_r(-ret, sbuf, sizeof(sbuf)));
384 tvar->type = strdup(buf);
385 if (tvar->type == NULL)
390 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
391 struct perf_probe_arg_field *field,
392 struct probe_trace_arg_ref **ref_ptr,
395 struct probe_trace_arg_ref *ref = *ref_ptr;
400 pr_debug("converting %s in %s\n", field->name, varname);
401 if (die_get_real_type(vr_die, &type) == NULL) {
402 pr_warning("Failed to get the type of %s.\n", varname);
405 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
406 tag = dwarf_tag(&type);
408 if (field->name[0] == '[' &&
409 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
411 /* Save original type for next field */
412 memcpy(die_mem, &type, sizeof(*die_mem));
413 /* Get the type of this array */
414 if (die_get_real_type(&type, &type) == NULL) {
415 pr_warning("Failed to get the type of %s.\n", varname);
418 pr_debug2("Array real type: (%x)\n",
419 (unsigned)dwarf_dieoffset(&type));
420 if (tag == DW_TAG_pointer_type) {
421 ref = zalloc(sizeof(struct probe_trace_arg_ref));
425 (*ref_ptr)->next = ref;
429 ref->offset += dwarf_bytesize(&type) * field->index;
431 /* Save vr_die for converting types */
432 memcpy(die_mem, vr_die, sizeof(*die_mem));
434 } else if (tag == DW_TAG_pointer_type) {
435 /* Check the pointer and dereference */
437 pr_err("Semantic error: %s must be referred by '->'\n",
441 /* Get the type pointed by this pointer */
442 if (die_get_real_type(&type, &type) == NULL) {
443 pr_warning("Failed to get the type of %s.\n", varname);
446 /* Verify it is a data structure */
447 tag = dwarf_tag(&type);
448 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
449 pr_warning("%s is not a data structure nor an union.\n",
454 ref = zalloc(sizeof(struct probe_trace_arg_ref));
458 (*ref_ptr)->next = ref;
462 /* Verify it is a data structure */
463 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
464 pr_warning("%s is not a data structure nor an union.\n",
468 if (field->name[0] == '[') {
469 pr_err("Semantic error: %s is not a pointer"
470 " nor array.\n", varname);
473 /* While prcessing unnamed field, we don't care about this */
474 if (field->ref && dwarf_diename(vr_die)) {
475 pr_err("Semantic error: %s must be referred by '.'\n",
480 pr_warning("Structure on a register is not "
486 if (die_find_member(&type, field->name, die_mem) == NULL) {
487 pr_warning("%s(type:%s) has no member %s.\n", varname,
488 dwarf_diename(&type), field->name);
492 /* Get the offset of the field */
493 if (tag == DW_TAG_union_type) {
496 ret = die_get_data_member_location(die_mem, &offs);
498 pr_warning("Failed to get the offset of %s.\n",
503 ref->offset += (long)offs;
505 /* If this member is unnamed, we need to reuse this field */
506 if (!dwarf_diename(die_mem))
507 return convert_variable_fields(die_mem, varname, field,
511 /* Converting next field */
513 return convert_variable_fields(die_mem, field->name,
514 field->next, &ref, die_mem);
519 /* Show a variables in kprobe event format */
520 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
525 pr_debug("Converting variable %s into trace event.\n",
526 dwarf_diename(vr_die));
528 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
529 &pf->sp_die, pf->tvar);
530 if (ret == -ENOENT || ret == -EINVAL) {
531 pr_err("Failed to find the location of the '%s' variable at this address.\n"
532 " Perhaps it has been optimized out.\n"
533 " Use -V with the --range option to show '%s' location range.\n",
534 pf->pvar->var, pf->pvar->var);
535 } else if (ret == -ENOTSUP)
536 pr_err("Sorry, we don't support this variable location yet.\n");
537 else if (ret == 0 && pf->pvar->field) {
538 ret = convert_variable_fields(vr_die, pf->pvar->var,
539 pf->pvar->field, &pf->tvar->ref,
544 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
545 /* *expr will be cached in libdw. Don't free it. */
549 /* Find a variable in a scope DIE */
550 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
556 if (!is_c_varname(pf->pvar->var)) {
557 /* Copy raw parameters */
558 pf->tvar->value = strdup(pf->pvar->var);
559 if (pf->tvar->value == NULL)
561 if (pf->pvar->type) {
562 pf->tvar->type = strdup(pf->pvar->type);
563 if (pf->tvar->type == NULL)
566 if (pf->pvar->name) {
567 pf->tvar->name = strdup(pf->pvar->name);
568 if (pf->tvar->name == NULL)
571 pf->tvar->name = NULL;
576 pf->tvar->name = strdup(pf->pvar->name);
578 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
581 ptr = strchr(buf, ':'); /* Change type separator to _ */
584 pf->tvar->name = strdup(buf);
586 if (pf->tvar->name == NULL)
589 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
590 /* Search child die for local variables and parameters. */
591 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
592 /* Search again in global variables */
593 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
595 pr_warning("Failed to find '%s' in this function.\n",
601 ret = convert_variable(&vr_die, pf);
606 /* Convert subprogram DIE to trace point */
607 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
608 Dwarf_Addr paddr, bool retprobe,
609 struct probe_trace_point *tp)
611 Dwarf_Addr eaddr, highaddr;
615 /* Verify the address is correct */
616 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
617 pr_warning("Failed to get entry address of %s\n",
618 dwarf_diename(sp_die));
621 if (dwarf_highpc(sp_die, &highaddr) != 0) {
622 pr_warning("Failed to get end address of %s\n",
623 dwarf_diename(sp_die));
626 if (paddr > highaddr) {
627 pr_warning("Offset specified is greater than size of %s\n",
628 dwarf_diename(sp_die));
632 symbol = dwarf_diename(sp_die);
634 /* Try to get the symbol name from symtab */
635 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
637 pr_warning("Failed to find symbol at 0x%lx\n",
638 (unsigned long)paddr);
641 eaddr = sym.st_value;
643 tp->offset = (unsigned long)(paddr - eaddr);
644 tp->address = (unsigned long)paddr;
645 tp->symbol = strdup(symbol);
649 /* Return probe must be on the head of a subprogram */
651 if (eaddr != paddr) {
652 pr_warning("Return probe must be on the head of"
653 " a real function.\n");
662 /* Call probe_finder callback with scope DIE */
663 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
665 Dwarf_Attribute fb_attr;
670 pr_err("Caller must pass a scope DIE. Program error.\n");
674 /* If not a real subprogram, find a real one */
675 if (!die_is_func_def(sc_die)) {
676 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
677 pr_warning("Failed to find probe point in any "
682 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
684 /* Get the frame base attribute/ops from subprogram */
685 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
686 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
687 if (ret <= 0 || nops == 0) {
689 #if _ELFUTILS_PREREQ(0, 142)
690 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
693 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
694 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
695 pr_warning("Failed to get call frame on 0x%jx\n",
696 (uintmax_t)pf->addr);
702 /* Call finder's callback handler */
703 ret = pf->callback(sc_die, pf);
705 /* *pf->fb_ops will be cached in libdw. Don't free it. */
711 struct find_scope_param {
712 const char *function;
720 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
722 struct find_scope_param *fsp = data;
726 /* Skip if declared file name does not match */
728 file = dwarf_decl_file(fn_die);
729 if (!file || strcmp(fsp->file, file) != 0)
732 /* If the function name is given, that's what user expects */
734 if (die_match_name(fn_die, fsp->function)) {
735 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
740 /* With the line number, find the nearest declared DIE */
741 dwarf_decl_line(fn_die, &lno);
742 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
743 /* Keep a candidate and continue */
744 fsp->diff = fsp->line - lno;
745 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
752 /* Find an appropriate scope fits to given conditions */
753 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
755 struct find_scope_param fsp = {
756 .function = pf->pev->point.function,
764 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
766 return fsp.found ? die_mem : NULL;
769 static int probe_point_line_walker(const char *fname, int lineno,
770 Dwarf_Addr addr, void *data)
772 struct probe_finder *pf = data;
773 Dwarf_Die *sc_die, die_mem;
776 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
780 sc_die = find_best_scope(pf, &die_mem);
782 pr_warning("Failed to find scope of probe point.\n");
786 ret = call_probe_finder(sc_die, pf);
788 /* Continue if no error, because the line will be in inline function */
789 return ret < 0 ? ret : 0;
792 /* Find probe point from its line number */
793 static int find_probe_point_by_line(struct probe_finder *pf)
795 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
798 /* Find lines which match lazy pattern */
799 static int find_lazy_match_lines(struct intlist *list,
800 const char *fname, const char *pat)
806 int count = 0, linenum = 1;
807 char sbuf[STRERR_BUFSIZE];
809 fp = fopen(fname, "r");
811 pr_warning("Failed to open %s: %s\n", fname,
812 strerror_r(errno, sbuf, sizeof(sbuf)));
816 while ((len = getline(&line, &line_len, fp)) > 0) {
818 if (line[len - 1] == '\n')
819 line[len - 1] = '\0';
821 if (strlazymatch(line, pat)) {
822 intlist__add(list, linenum);
834 pr_debug("No matched lines found in %s.\n", fname);
838 static int probe_point_lazy_walker(const char *fname, int lineno,
839 Dwarf_Addr addr, void *data)
841 struct probe_finder *pf = data;
842 Dwarf_Die *sc_die, die_mem;
845 if (!intlist__has_entry(pf->lcache, lineno) ||
846 strtailcmp(fname, pf->fname) != 0)
849 pr_debug("Probe line found: line:%d addr:0x%llx\n",
850 lineno, (unsigned long long)addr);
853 sc_die = find_best_scope(pf, &die_mem);
855 pr_warning("Failed to find scope of probe point.\n");
859 ret = call_probe_finder(sc_die, pf);
862 * Continue if no error, because the lazy pattern will match
865 return ret < 0 ? ret : 0;
868 /* Find probe points from lazy pattern */
869 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
874 if (intlist__empty(pf->lcache)) {
875 const char *comp_dir;
877 comp_dir = cu_get_comp_dir(&pf->cu_die);
878 ret = get_real_path(pf->fname, comp_dir, &fpath);
880 pr_warning("Failed to find source file path.\n");
884 /* Matching lazy line pattern */
885 ret = find_lazy_match_lines(pf->lcache, fpath,
886 pf->pev->point.lazy_line);
892 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
895 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
897 struct probe_finder *pf = data;
898 struct perf_probe_point *pp = &pf->pev->point;
903 ret = find_probe_point_lazy(in_die, pf);
905 /* Get probe address */
906 if (dwarf_entrypc(in_die, &addr) != 0) {
907 pr_warning("Failed to get entry address of %s.\n",
908 dwarf_diename(in_die));
912 pf->addr += pp->offset;
913 pr_debug("found inline addr: 0x%jx\n",
914 (uintmax_t)pf->addr);
916 ret = call_probe_finder(in_die, pf);
922 /* Callback parameter with return value for libdw */
923 struct dwarf_callback_param {
928 /* Search function from function name */
929 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
931 struct dwarf_callback_param *param = data;
932 struct probe_finder *pf = param->data;
933 struct perf_probe_point *pp = &pf->pev->point;
935 /* Check tag and diename */
936 if (!die_is_func_def(sp_die) ||
937 !die_match_name(sp_die, pp->function))
940 /* Check declared file */
941 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
944 pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
945 pf->fname = dwarf_decl_file(sp_die);
946 if (pp->line) { /* Function relative line */
947 dwarf_decl_line(sp_die, &pf->lno);
949 param->retval = find_probe_point_by_line(pf);
950 } else if (die_is_func_instance(sp_die)) {
951 /* Instances always have the entry address */
952 dwarf_entrypc(sp_die, &pf->addr);
955 param->retval = find_probe_point_lazy(sp_die, pf);
957 pf->addr += pp->offset;
958 /* TODO: Check the address in this function */
959 param->retval = call_probe_finder(sp_die, pf);
961 } else if (!probe_conf.no_inlines) {
962 /* Inlined function: search instances */
963 param->retval = die_walk_instances(sp_die,
964 probe_point_inline_cb, (void *)pf);
965 /* This could be a non-existed inline definition */
966 if (param->retval == -ENOENT && strisglob(pp->function))
970 /* We need to find other candidates */
971 if (strisglob(pp->function) && param->retval >= 0) {
972 param->retval = 0; /* We have to clear the result */
976 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
979 static int find_probe_point_by_func(struct probe_finder *pf)
981 struct dwarf_callback_param _param = {.data = (void *)pf,
983 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
984 return _param.retval;
987 struct pubname_callback_param {
995 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
997 struct pubname_callback_param *param = data;
999 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
1000 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1003 if (die_match_name(param->sp_die, param->function)) {
1004 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1008 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1012 return DWARF_CB_ABORT;
1019 /* Find probe points from debuginfo */
1020 static int debuginfo__find_probes(struct debuginfo *dbg,
1021 struct probe_finder *pf)
1023 struct perf_probe_point *pp = &pf->pev->point;
1024 Dwarf_Off off, noff;
1029 #if _ELFUTILS_PREREQ(0, 142)
1034 /* Get the call frame information from this dwarf */
1035 elf = dwarf_getelf(dbg->dbg);
1039 if (gelf_getehdr(elf, &ehdr) == NULL)
1042 if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1043 shdr.sh_type == SHT_PROGBITS) {
1044 pf->cfi = dwarf_getcfi_elf(elf);
1046 pf->cfi = dwarf_getcfi(dbg->dbg);
1051 pf->lcache = intlist__new(NULL);
1055 /* Fastpath: lookup by function name from .debug_pubnames section */
1056 if (pp->function && !strisglob(pp->function)) {
1057 struct pubname_callback_param pubname_param = {
1058 .function = pp->function,
1060 .cu_die = &pf->cu_die,
1061 .sp_die = &pf->sp_die,
1064 struct dwarf_callback_param probe_param = {
1068 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1070 if (pubname_param.found) {
1071 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1077 /* Loop on CUs (Compilation Unit) */
1078 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1079 /* Get the DIE(Debugging Information Entry) of this CU */
1080 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1084 /* Check if target file is included. */
1086 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1090 if (!pp->file || pf->fname) {
1092 ret = find_probe_point_by_func(pf);
1093 else if (pp->lazy_line)
1094 ret = find_probe_point_lazy(&pf->cu_die, pf);
1097 ret = find_probe_point_by_line(pf);
1106 intlist__delete(pf->lcache);
1112 struct local_vars_finder {
1113 struct probe_finder *pf;
1114 struct perf_probe_arg *args;
1121 /* Collect available variables in this scope */
1122 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1124 struct local_vars_finder *vf = data;
1125 struct probe_finder *pf = vf->pf;
1128 tag = dwarf_tag(die_mem);
1129 if (tag == DW_TAG_formal_parameter ||
1130 (tag == DW_TAG_variable && vf->vars)) {
1131 if (convert_variable_location(die_mem, vf->pf->addr,
1132 vf->pf->fb_ops, &pf->sp_die,
1134 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1135 if (vf->args[vf->nargs].var == NULL) {
1137 return DIE_FIND_CB_END;
1139 pr_debug(" %s", vf->args[vf->nargs].var);
1144 if (dwarf_haspc(die_mem, vf->pf->addr))
1145 return DIE_FIND_CB_CONTINUE;
1147 return DIE_FIND_CB_SIBLING;
1150 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1151 struct perf_probe_arg *args)
1156 struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1157 .max_args = MAX_PROBE_ARGS, .ret = 0};
1159 for (i = 0; i < pf->pev->nargs; i++) {
1160 /* var never be NULL */
1161 if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1163 else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1164 /* Copy normal argument */
1165 args[n] = pf->pev->args[i];
1169 pr_debug("Expanding %s into:", pf->pev->args[i].var);
1171 /* Special local variables */
1172 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1174 pr_debug(" (%d)\n", vf.nargs - n);
1182 /* Add a found probe point into trace event list */
1183 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1185 struct trace_event_finder *tf =
1186 container_of(pf, struct trace_event_finder, pf);
1187 struct probe_trace_event *tev;
1188 struct perf_probe_arg *args;
1191 /* Check number of tevs */
1192 if (tf->ntevs == tf->max_tevs) {
1193 pr_warning("Too many( > %d) probe point found.\n",
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 pf->pev->point.retprobe, &tev->point);
1205 tev->point.realname = strdup(dwarf_diename(sc_die));
1206 if (!tev->point.realname)
1209 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1212 /* Expand special probe argument if exist */
1213 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1217 ret = expand_probe_args(sc_die, pf, args);
1222 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1223 if (tev->args == NULL) {
1228 /* Find each argument */
1229 for (i = 0; i < tev->nargs; i++) {
1230 pf->pvar = &args[i];
1231 pf->tvar = &tev->args[i];
1232 /* Variable should be found from scope DIE */
1233 ret = find_variable(sc_die, pf);
1243 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1244 int debuginfo__find_trace_events(struct debuginfo *dbg,
1245 struct perf_probe_event *pev,
1246 struct probe_trace_event **tevs)
1248 struct trace_event_finder tf = {
1249 .pf = {.pev = pev, .callback = add_probe_trace_event},
1250 .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1253 /* Allocate result tevs array */
1254 *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1261 ret = debuginfo__find_probes(dbg, &tf.pf);
1267 return (ret < 0) ? ret : tf.ntevs;
1270 /* Collect available variables in this scope */
1271 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1273 struct available_var_finder *af = data;
1274 struct variable_list *vl;
1277 vl = &af->vls[af->nvls - 1];
1279 tag = dwarf_tag(die_mem);
1280 if (tag == DW_TAG_formal_parameter ||
1281 tag == DW_TAG_variable) {
1282 ret = convert_variable_location(die_mem, af->pf.addr,
1283 af->pf.fb_ops, &af->pf.sp_die,
1285 if (ret == 0 || ret == -ERANGE) {
1287 bool externs = !af->child;
1290 strbuf_init(&buf, 64);
1292 if (probe_conf.show_location_range) {
1295 strbuf_addf(&buf, "[INV]\t");
1297 strbuf_addf(&buf, "[VAL]\t");
1299 strbuf_addf(&buf, "[EXT]\t");
1302 ret2 = die_get_varname(die_mem, &buf);
1304 if (!ret2 && probe_conf.show_location_range &&
1306 strbuf_addf(&buf, "\t");
1307 ret2 = die_get_var_range(&af->pf.sp_die,
1311 pr_debug("Add new var: %s\n", buf.buf);
1313 strlist__add(vl->vars,
1314 strbuf_detach(&buf, NULL));
1316 strbuf_release(&buf);
1320 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1321 return DIE_FIND_CB_CONTINUE;
1323 return DIE_FIND_CB_SIBLING;
1326 /* Add a found vars into available variables list */
1327 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1329 struct available_var_finder *af =
1330 container_of(pf, struct available_var_finder, pf);
1331 struct variable_list *vl;
1335 /* Check number of tevs */
1336 if (af->nvls == af->max_vls) {
1337 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1340 vl = &af->vls[af->nvls++];
1342 /* Trace point should be converted from subprogram DIE */
1343 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1344 pf->pev->point.retprobe, &vl->point);
1348 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1351 /* Find local variables */
1352 vl->vars = strlist__new(true, NULL);
1353 if (vl->vars == NULL)
1356 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1358 /* Find external variables */
1359 if (!probe_conf.show_ext_vars)
1361 /* Don't need to search child DIE for external vars. */
1363 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1366 if (strlist__empty(vl->vars)) {
1367 strlist__delete(vl->vars);
1375 * Find available variables at given probe point
1376 * Return the number of found probe points. Return 0 if there is no
1377 * matched probe point. Return <0 if an error occurs.
1379 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1380 struct perf_probe_event *pev,
1381 struct variable_list **vls)
1383 struct available_var_finder af = {
1384 .pf = {.pev = pev, .callback = add_available_vars},
1386 .max_vls = probe_conf.max_probes};
1389 /* Allocate result vls array */
1390 *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1397 ret = debuginfo__find_probes(dbg, &af.pf);
1399 /* Free vlist for error */
1401 zfree(&af.vls[af.nvls].point.symbol);
1402 strlist__delete(af.vls[af.nvls].vars);
1408 return (ret < 0) ? ret : af.nvls;
1411 /* Reverse search */
1412 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1413 struct perf_probe_point *ppt)
1415 Dwarf_Die cudie, spdie, indie;
1416 Dwarf_Addr _addr = 0, baseaddr = 0;
1417 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1418 int baseline = 0, lineno = 0, ret = 0;
1421 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1422 pr_warning("Failed to find debug information for address %lx\n",
1428 /* Find a corresponding line (filename and lineno) */
1429 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1430 /* Don't care whether it failed or not */
1432 /* Find a corresponding function (name, baseline and baseaddr) */
1433 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1434 /* Get function entry information */
1435 func = basefunc = dwarf_diename(&spdie);
1437 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1438 dwarf_decl_line(&spdie, &baseline) != 0) {
1443 fname = dwarf_decl_file(&spdie);
1444 if (addr == (unsigned long)baseaddr) {
1445 /* Function entry - Relative line number is 0 */
1450 /* Track down the inline functions step by step */
1451 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1453 /* There is an inline function */
1454 if (dwarf_entrypc(&indie, &_addr) == 0 &&
1457 * addr is at an inline function entry.
1458 * In this case, lineno should be the call-site
1459 * line number. (overwrite lineinfo)
1461 lineno = die_get_call_lineno(&indie);
1462 fname = die_get_call_file(&indie);
1466 * addr is in an inline function body.
1467 * Since lineno points one of the lines
1468 * of the inline function, baseline should
1469 * be the entry line of the inline function.
1471 tmp = dwarf_diename(&indie);
1473 dwarf_decl_line(&indie, &baseline) != 0)
1479 /* Verify the lineno and baseline are in a same file */
1480 tmp = dwarf_decl_file(&spdie);
1481 if (!tmp || strcmp(tmp, fname) != 0)
1486 /* Make a relative line number or an offset */
1488 ppt->line = lineno - baseline;
1489 else if (basefunc) {
1490 ppt->offset = addr - (unsigned long)baseaddr;
1494 /* Duplicate strings */
1496 ppt->function = strdup(func);
1497 if (ppt->function == NULL) {
1503 ppt->file = strdup(fname);
1504 if (ppt->file == NULL) {
1505 zfree(&ppt->function);
1511 if (ret == 0 && (fname || func))
1512 ret = 1; /* Found a point */
1516 /* Add a line and store the src path */
1517 static int line_range_add_line(const char *src, unsigned int lineno,
1518 struct line_range *lr)
1520 /* Copy source path */
1522 lr->path = strdup(src);
1523 if (lr->path == NULL)
1526 return intlist__add(lr->line_list, lineno);
1529 static int line_range_walk_cb(const char *fname, int lineno,
1530 Dwarf_Addr addr __maybe_unused,
1533 struct line_finder *lf = data;
1536 if ((strtailcmp(fname, lf->fname) != 0) ||
1537 (lf->lno_s > lineno || lf->lno_e < lineno))
1540 err = line_range_add_line(fname, lineno, lf->lr);
1541 if (err < 0 && err != -EEXIST)
1547 /* Find line range from its line number */
1548 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1552 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1556 if (!intlist__empty(lf->lr->line_list))
1557 ret = lf->found = 1;
1559 ret = 0; /* Lines are not found */
1561 zfree(&lf->lr->path);
1566 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1568 int ret = find_line_range_by_line(in_die, data);
1571 * We have to check all instances of inlined function, because
1572 * some execution paths can be optimized out depends on the
1573 * function argument of instances. However, if an error occurs,
1574 * it should be handled by the caller.
1576 return ret < 0 ? ret : 0;
1579 /* Search function definition from function name */
1580 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1582 struct dwarf_callback_param *param = data;
1583 struct line_finder *lf = param->data;
1584 struct line_range *lr = lf->lr;
1586 /* Check declared file */
1587 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1590 if (die_is_func_def(sp_die) &&
1591 die_match_name(sp_die, lr->function)) {
1592 lf->fname = dwarf_decl_file(sp_die);
1593 dwarf_decl_line(sp_die, &lr->offset);
1594 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1595 lf->lno_s = lr->offset + lr->start;
1596 if (lf->lno_s < 0) /* Overflow */
1597 lf->lno_s = INT_MAX;
1598 lf->lno_e = lr->offset + lr->end;
1599 if (lf->lno_e < 0) /* Overflow */
1600 lf->lno_e = INT_MAX;
1601 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1602 lr->start = lf->lno_s;
1603 lr->end = lf->lno_e;
1604 if (!die_is_func_instance(sp_die))
1605 param->retval = die_walk_instances(sp_die,
1606 line_range_inline_cb, lf);
1608 param->retval = find_line_range_by_line(sp_die, lf);
1609 return DWARF_CB_ABORT;
1614 static int find_line_range_by_func(struct line_finder *lf)
1616 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1617 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, ¶m, 0);
1618 return param.retval;
1621 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1623 struct line_finder lf = {.lr = lr, .found = 0};
1625 Dwarf_Off off = 0, noff;
1628 const char *comp_dir;
1630 /* Fastpath: lookup by function name from .debug_pubnames section */
1632 struct pubname_callback_param pubname_param = {
1633 .function = lr->function, .file = lr->file,
1634 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1635 struct dwarf_callback_param line_range_param = {
1636 .data = (void *)&lf, .retval = 0};
1638 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1640 if (pubname_param.found) {
1641 line_range_search_cb(&lf.sp_die, &line_range_param);
1647 /* Loop on CUs (Compilation Unit) */
1648 while (!lf.found && ret >= 0) {
1649 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1650 NULL, NULL, NULL) != 0)
1653 /* Get the DIE(Debugging Information Entry) of this CU */
1654 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1658 /* Check if target file is included. */
1660 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1664 if (!lr->file || lf.fname) {
1666 ret = find_line_range_by_func(&lf);
1668 lf.lno_s = lr->start;
1670 ret = find_line_range_by_line(NULL, &lf);
1677 /* Store comp_dir */
1679 comp_dir = cu_get_comp_dir(&lf.cu_die);
1681 lr->comp_dir = strdup(comp_dir);
1687 pr_debug("path: %s\n", lr->path);
1688 return (ret < 0) ? ret : lf.found;
1692 * Find a src file from a DWARF tag path. Prepend optional source path prefix
1693 * and chop off leading directories that do not exist. Result is passed back as
1694 * a newly allocated path on success.
1695 * Return 0 if file was found and readable, -errno otherwise.
1697 int get_real_path(const char *raw_path, const char *comp_dir,
1700 const char *prefix = symbol_conf.source_prefix;
1703 if (raw_path[0] != '/' && comp_dir)
1704 /* If not an absolute path, try to use comp_dir */
1707 if (access(raw_path, R_OK) == 0) {
1708 *new_path = strdup(raw_path);
1709 return *new_path ? 0 : -ENOMEM;
1715 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
1720 sprintf(*new_path, "%s/%s", prefix, raw_path);
1722 if (access(*new_path, R_OK) == 0)
1725 if (!symbol_conf.source_prefix) {
1726 /* In case of searching comp_dir, don't retry */
1736 raw_path = strchr(++raw_path, '/');