1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * probe-finder.c : C expression to kprobe event converter
5 * Written by Masami Hiramatsu <mhiramat@redhat.com>
9 #include <sys/utsname.h>
10 #include <sys/types.h>
19 #include <dwarf-regs.h>
21 #include <linux/bitops.h>
22 #include <linux/zalloc.h>
30 #include "probe-finder.h"
31 #include "probe-file.h"
34 #ifdef HAVE_DEBUGINFOD_SUPPORT
35 #include <elfutils/debuginfod.h>
38 /* Kprobe tracer basic type is up to u64 */
39 #define MAX_BASIC_TYPE_BITS 64
41 /* Dwarf FL wrappers */
42 static char *debuginfo_path; /* Currently dummy */
44 static const Dwfl_Callbacks offline_callbacks = {
45 .find_debuginfo = dwfl_standard_find_debuginfo,
46 .debuginfo_path = &debuginfo_path,
48 .section_address = dwfl_offline_section_address,
50 /* We use this table for core files too. */
51 .find_elf = dwfl_build_id_find_elf,
54 /* Get a Dwarf from offline image */
55 static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
61 fd = open(path, O_RDONLY);
65 dbg->dwfl = dwfl_begin(&offline_callbacks);
69 dwfl_report_begin(dbg->dwfl);
70 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
74 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
78 dwfl_module_build_id(dbg->mod, &dbg->build_id, &dummy);
80 dwfl_report_end(dbg->dwfl, NULL, NULL);
88 memset(dbg, 0, sizeof(*dbg));
93 static struct debuginfo *__debuginfo__new(const char *path)
95 struct debuginfo *dbg = zalloc(sizeof(*dbg));
99 if (debuginfo__init_offline_dwarf(dbg, path) < 0)
102 pr_debug("Open Debuginfo file: %s\n", path);
106 enum dso_binary_type distro_dwarf_types[] = {
107 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
108 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
109 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
110 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
111 DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO,
112 DSO_BINARY_TYPE__NOT_FOUND,
115 struct debuginfo *debuginfo__new(const char *path)
117 enum dso_binary_type *type;
118 char buf[PATH_MAX], nil = '\0';
120 struct debuginfo *dinfo = NULL;
122 /* Try to open distro debuginfo files */
123 dso = dso__new(path);
127 for (type = distro_dwarf_types;
128 !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
130 if (dso__read_binary_type_filename(dso, *type, &nil,
133 dinfo = __debuginfo__new(buf);
138 /* if failed to open all distro debuginfo, open given binary */
139 return dinfo ? : __debuginfo__new(path);
142 void debuginfo__delete(struct debuginfo *dbg)
152 * Probe finder related functions
155 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
157 struct probe_trace_arg_ref *ref;
158 ref = zalloc(sizeof(struct probe_trace_arg_ref));
165 * Convert a location into trace_arg.
166 * If tvar == NULL, this just checks variable can be converted.
167 * If fentry == true and vr_die is a parameter, do huristic search
168 * for the location fuzzed by function entry mcount.
170 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
171 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
172 unsigned int machine,
173 struct probe_trace_arg *tvar)
175 Dwarf_Attribute attr;
185 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
189 if (dwarf_attr(vr_die, DW_AT_const_value, &attr) &&
190 immediate_value_is_supported()) {
193 dwarf_formsdata(&attr, &snum);
194 ret = asprintf(&tvar->value, "\\%ld", (long)snum);
196 return ret < 0 ? -ENOMEM : 0;
199 /* TODO: handle more than 1 exprs */
200 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
201 return -EINVAL; /* Broken DIE ? */
202 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
203 ret = dwarf_entrypc(sp_die, &tmp);
207 if (probe_conf.show_location_range &&
208 (dwarf_tag(vr_die) == DW_TAG_variable)) {
210 } else if (addr != tmp ||
211 dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
215 ret = dwarf_highpc(sp_die, &tmp);
219 * This is fuzzed by fentry mcount. We try to find the
220 * parameter location at the earliest address.
222 for (addr += 1; addr <= tmp; addr++) {
223 if (dwarf_getlocation_addr(&attr, addr, &op,
231 /* TODO: Support const_value */
234 if (op->atom == DW_OP_addr) {
238 /* Static variables on memory (not stack), make @varname */
239 ret = strlen(dwarf_diename(vr_die));
240 tvar->value = zalloc(ret + 2);
241 if (tvar->value == NULL)
243 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
244 tvar->ref = alloc_trace_arg_ref((long)offs);
245 if (tvar->ref == NULL)
250 /* If this is based on frame buffer, set the offset */
251 if (op->atom == DW_OP_fbreg) {
259 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
260 regn = op->atom - DW_OP_breg0;
263 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
264 regn = op->atom - DW_OP_reg0;
265 } else if (op->atom == DW_OP_bregx) {
269 } else if (op->atom == DW_OP_regx) {
272 pr_debug("DW_OP %x is not supported.\n", op->atom);
279 regs = get_dwarf_regstr(regn, machine);
281 /* This should be a bug in DWARF or this tool */
282 pr_warning("Mapping for the register number %u "
283 "missing on this architecture.\n", regn);
287 tvar->value = strdup(regs);
288 if (tvar->value == NULL)
292 tvar->ref = alloc_trace_arg_ref((long)offs);
293 if (tvar->ref == NULL)
299 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
301 static int convert_variable_type(Dwarf_Die *vr_die,
302 struct probe_trace_arg *tvar,
303 const char *cast, bool user_access)
305 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
308 char sbuf[STRERR_BUFSIZE];
309 int bsize, boffs, total;
313 /* TODO: check all types */
314 if (cast && strcmp(cast, "string") != 0 && strcmp(cast, "ustring") &&
315 strcmp(cast, "x") != 0 &&
316 strcmp(cast, "s") != 0 && strcmp(cast, "u") != 0) {
317 /* Non string type is OK */
318 /* and respect signedness/hexadecimal cast */
319 tvar->type = strdup(cast);
320 return (tvar->type == NULL) ? -ENOMEM : 0;
323 bsize = dwarf_bitsize(vr_die);
325 /* This is a bitfield */
326 boffs = dwarf_bitoffset(vr_die);
327 total = dwarf_bytesize(vr_die);
328 if (boffs < 0 || total < 0)
330 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
331 BYTES_TO_BITS(total));
335 if (die_get_real_type(vr_die, &type) == NULL) {
336 pr_warning("Failed to get a type information of %s.\n",
337 dwarf_diename(vr_die));
341 pr_debug("%s type is %s.\n",
342 dwarf_diename(vr_die), dwarf_diename(&type));
344 if (cast && (!strcmp(cast, "string") || !strcmp(cast, "ustring"))) {
346 ret = dwarf_tag(&type);
347 if (ret != DW_TAG_pointer_type &&
348 ret != DW_TAG_array_type) {
349 pr_warning("Failed to cast into string: "
350 "%s(%s) is not a pointer nor array.\n",
351 dwarf_diename(vr_die), dwarf_diename(&type));
354 if (die_get_real_type(&type, &type) == NULL) {
355 pr_warning("Failed to get a type"
359 if (ret == DW_TAG_pointer_type) {
361 ref_ptr = &(*ref_ptr)->next;
362 /* Add new reference with offset +0 */
363 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
364 if (*ref_ptr == NULL) {
365 pr_warning("Out of memory error\n");
368 (*ref_ptr)->user_access = user_access;
370 if (!die_compare_name(&type, "char") &&
371 !die_compare_name(&type, "unsigned char")) {
372 pr_warning("Failed to cast into string: "
373 "%s is not (unsigned) char *.\n",
374 dwarf_diename(vr_die));
377 tvar->type = strdup(cast);
378 return (tvar->type == NULL) ? -ENOMEM : 0;
381 if (cast && (strcmp(cast, "u") == 0))
383 else if (cast && (strcmp(cast, "s") == 0))
385 else if (cast && (strcmp(cast, "x") == 0) &&
386 probe_type_is_available(PROBE_TYPE_X))
389 prefix = die_is_signed_type(&type) ? 's' :
390 probe_type_is_available(PROBE_TYPE_X) ? 'x' : 'u';
392 ret = dwarf_bytesize(&type);
394 /* No size ... try to use default type */
396 ret = BYTES_TO_BITS(ret);
398 /* Check the bitwidth */
399 if (ret > MAX_BASIC_TYPE_BITS) {
400 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
401 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
402 ret = MAX_BASIC_TYPE_BITS;
404 ret = snprintf(buf, 16, "%c%d", prefix, ret);
407 if (ret < 0 || ret >= 16) {
410 pr_warning("Failed to convert variable type: %s\n",
411 str_error_r(-ret, sbuf, sizeof(sbuf)));
414 tvar->type = strdup(buf);
415 if (tvar->type == NULL)
420 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
421 struct perf_probe_arg_field *field,
422 struct probe_trace_arg_ref **ref_ptr,
423 Dwarf_Die *die_mem, bool user_access)
425 struct probe_trace_arg_ref *ref = *ref_ptr;
430 pr_debug("converting %s in %s\n", field->name, varname);
431 if (die_get_real_type(vr_die, &type) == NULL) {
432 pr_warning("Failed to get the type of %s.\n", varname);
435 pr_debug2("Var real type: %s (%x)\n", dwarf_diename(&type),
436 (unsigned)dwarf_dieoffset(&type));
437 tag = dwarf_tag(&type);
439 if (field->name[0] == '[' &&
440 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
441 /* Save original type for next field or type */
442 memcpy(die_mem, &type, sizeof(*die_mem));
443 /* Get the type of this array */
444 if (die_get_real_type(&type, &type) == NULL) {
445 pr_warning("Failed to get the type of %s.\n", varname);
448 pr_debug2("Array real type: %s (%x)\n", dwarf_diename(&type),
449 (unsigned)dwarf_dieoffset(&type));
450 if (tag == DW_TAG_pointer_type) {
451 ref = zalloc(sizeof(struct probe_trace_arg_ref));
455 (*ref_ptr)->next = ref;
459 ref->offset += dwarf_bytesize(&type) * field->index;
460 ref->user_access = user_access;
462 } else if (tag == DW_TAG_pointer_type) {
463 /* Check the pointer and dereference */
465 pr_err("Semantic error: %s must be referred by '->'\n",
469 /* Get the type pointed by this pointer */
470 if (die_get_real_type(&type, &type) == NULL) {
471 pr_warning("Failed to get the type of %s.\n", varname);
474 /* Verify it is a data structure */
475 tag = dwarf_tag(&type);
476 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
477 pr_warning("%s is not a data structure nor a union.\n",
482 ref = zalloc(sizeof(struct probe_trace_arg_ref));
486 (*ref_ptr)->next = ref;
490 /* Verify it is a data structure */
491 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
492 pr_warning("%s is not a data structure nor a union.\n",
496 if (field->name[0] == '[') {
497 pr_err("Semantic error: %s is not a pointer"
498 " nor array.\n", varname);
501 /* While prcessing unnamed field, we don't care about this */
502 if (field->ref && dwarf_diename(vr_die)) {
503 pr_err("Semantic error: %s must be referred by '.'\n",
508 pr_warning("Structure on a register is not "
514 if (die_find_member(&type, field->name, die_mem) == NULL) {
515 pr_warning("%s(type:%s) has no member %s.\n", varname,
516 dwarf_diename(&type), field->name);
520 /* Get the offset of the field */
521 if (tag == DW_TAG_union_type) {
524 ret = die_get_data_member_location(die_mem, &offs);
526 pr_warning("Failed to get the offset of %s.\n",
531 ref->offset += (long)offs;
532 ref->user_access = user_access;
534 /* If this member is unnamed, we need to reuse this field */
535 if (!dwarf_diename(die_mem))
536 return convert_variable_fields(die_mem, varname, field,
537 &ref, die_mem, user_access);
540 /* Converting next field */
542 return convert_variable_fields(die_mem, field->name,
543 field->next, &ref, die_mem, user_access);
548 static void print_var_not_found(const char *varname)
550 pr_err("Failed to find the location of the '%s' variable at this address.\n"
551 " Perhaps it has been optimized out.\n"
552 " Use -V with the --range option to show '%s' location range.\n",
556 /* Show a variables in kprobe event format */
557 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
562 pr_debug("Converting variable %s into trace event.\n",
563 dwarf_diename(vr_die));
565 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
566 &pf->sp_die, pf->machine, pf->tvar);
567 if (ret == -ENOENT && pf->skip_empty_arg)
568 /* This can be found in other place. skip it */
570 if (ret == -ENOENT || ret == -EINVAL) {
571 print_var_not_found(pf->pvar->var);
572 } else if (ret == -ENOTSUP)
573 pr_err("Sorry, we don't support this variable location yet.\n");
574 else if (ret == 0 && pf->pvar->field) {
575 ret = convert_variable_fields(vr_die, pf->pvar->var,
576 pf->pvar->field, &pf->tvar->ref,
577 &die_mem, pf->pvar->user_access);
581 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type,
582 pf->pvar->user_access);
583 /* *expr will be cached in libdw. Don't free it. */
587 /* Find a variable in a scope DIE */
588 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
594 /* Copy raw parameters */
595 if (!is_c_varname(pf->pvar->var))
596 return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
599 pf->tvar->name = strdup(pf->pvar->name);
601 buf = synthesize_perf_probe_arg(pf->pvar);
604 ptr = strchr(buf, ':'); /* Change type separator to _ */
607 pf->tvar->name = buf;
609 if (pf->tvar->name == NULL)
612 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
613 /* Search child die for local variables and parameters. */
614 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
615 /* Search again in global variables */
616 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
618 if (pf->skip_empty_arg)
620 pr_warning("Failed to find '%s' in this function.\n",
626 ret = convert_variable(&vr_die, pf);
631 /* Convert subprogram DIE to trace point */
632 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
633 Dwarf_Addr paddr, bool retprobe,
634 const char *function,
635 struct probe_trace_point *tp)
641 /* Verify the address is correct */
642 if (!dwarf_haspc(sp_die, paddr)) {
643 pr_warning("Specified offset is out of %s\n",
644 dwarf_diename(sp_die));
648 if (dwarf_entrypc(sp_die, &eaddr) == 0) {
649 /* If the DIE has entrypc, use it. */
650 symbol = dwarf_diename(sp_die);
652 /* Try to get actual symbol name and address from symtab */
653 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
654 eaddr = sym.st_value;
657 pr_warning("Failed to find symbol at 0x%lx\n",
658 (unsigned long)paddr);
662 tp->offset = (unsigned long)(paddr - eaddr);
663 tp->address = (unsigned long)paddr;
664 tp->symbol = strdup(symbol);
668 /* Return probe must be on the head of a subprogram */
670 if (eaddr != paddr) {
671 pr_warning("Failed to find \"%s%%return\",\n"
672 " because %s is an inlined function and"
673 " has no return point.\n", function,
683 /* Call probe_finder callback with scope DIE */
684 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
686 Dwarf_Attribute fb_attr;
687 Dwarf_Frame *frame = NULL;
692 pr_err("Caller must pass a scope DIE. Program error.\n");
696 /* If not a real subprogram, find a real one */
697 if (!die_is_func_def(sc_die)) {
698 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
699 if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
700 pr_warning("Ignoring tail call from %s\n",
701 dwarf_diename(&pf->sp_die));
704 pr_warning("Failed to find probe point in any "
710 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
712 /* Get the frame base attribute/ops from subprogram */
713 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
714 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
715 if (ret <= 0 || nops == 0) {
717 #if _ELFUTILS_PREREQ(0, 142)
718 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
719 (pf->cfi_eh != NULL || pf->cfi_dbg != NULL)) {
720 if ((dwarf_cfi_addrframe(pf->cfi_eh, pf->addr, &frame) != 0 &&
721 (dwarf_cfi_addrframe(pf->cfi_dbg, pf->addr, &frame) != 0)) ||
722 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
723 pr_warning("Failed to get call frame on 0x%jx\n",
724 (uintmax_t)pf->addr);
731 /* Call finder's callback handler */
732 ret = pf->callback(sc_die, pf);
734 /* Since *pf->fb_ops can be a part of frame. we should free it here. */
741 struct find_scope_param {
742 const char *function;
750 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
752 struct find_scope_param *fsp = data;
756 /* Skip if declared file name does not match */
758 file = dwarf_decl_file(fn_die);
759 if (!file || strcmp(fsp->file, file) != 0)
762 /* If the function name is given, that's what user expects */
764 if (die_match_name(fn_die, fsp->function)) {
765 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
770 /* With the line number, find the nearest declared DIE */
771 dwarf_decl_line(fn_die, &lno);
772 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
773 /* Keep a candidate and continue */
774 fsp->diff = fsp->line - lno;
775 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
782 /* Return innermost DIE */
783 static int find_inner_scope_cb(Dwarf_Die *fn_die, void *data)
785 struct find_scope_param *fsp = data;
787 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
792 /* Find an appropriate scope fits to given conditions */
793 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
795 struct find_scope_param fsp = {
796 .function = pf->pev->point.function,
805 ret = cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb,
807 if (!ret && !fsp.found)
808 cu_walk_functions_at(&pf->cu_die, pf->addr,
809 find_inner_scope_cb, &fsp);
811 return fsp.found ? die_mem : NULL;
814 static int verify_representive_line(struct probe_finder *pf, const char *fname,
815 int lineno, Dwarf_Addr addr)
817 const char *__fname, *__func = NULL;
821 /* Verify line number and address by reverse search */
822 if (cu_find_lineinfo(&pf->cu_die, addr, &__fname, &__lineno) < 0)
825 pr_debug2("Reversed line: %s:%d\n", __fname, __lineno);
826 if (strcmp(fname, __fname) || lineno == __lineno)
829 pr_warning("This line is sharing the address with other lines.\n");
831 if (pf->pev->point.function) {
832 /* Find best match function name and lines */
834 if (find_best_scope(pf, &die_mem)
835 && die_match_name(&die_mem, pf->pev->point.function)
836 && dwarf_decl_line(&die_mem, &lineno) == 0) {
837 __func = dwarf_diename(&die_mem);
841 pr_warning("Please try to probe at %s:%d instead.\n",
842 __func ? : __fname, __lineno);
847 static int probe_point_line_walker(const char *fname, int lineno,
848 Dwarf_Addr addr, void *data)
850 struct probe_finder *pf = data;
851 Dwarf_Die *sc_die, die_mem;
854 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
857 if (verify_representive_line(pf, fname, lineno, addr))
861 sc_die = find_best_scope(pf, &die_mem);
863 pr_warning("Failed to find scope of probe point.\n");
867 ret = call_probe_finder(sc_die, pf);
869 /* Continue if no error, because the line will be in inline function */
870 return ret < 0 ? ret : 0;
873 /* Find probe point from its line number */
874 static int find_probe_point_by_line(struct probe_finder *pf)
876 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
879 /* Find lines which match lazy pattern */
880 static int find_lazy_match_lines(struct intlist *list,
881 const char *fname, const char *pat)
887 int count = 0, linenum = 1;
888 char sbuf[STRERR_BUFSIZE];
890 fp = fopen(fname, "r");
892 pr_warning("Failed to open %s: %s\n", fname,
893 str_error_r(errno, sbuf, sizeof(sbuf)));
897 while ((len = getline(&line, &line_len, fp)) > 0) {
899 if (line[len - 1] == '\n')
900 line[len - 1] = '\0';
902 if (strlazymatch(line, pat)) {
903 intlist__add(list, linenum);
915 pr_debug("No matched lines found in %s.\n", fname);
919 static int probe_point_lazy_walker(const char *fname, int lineno,
920 Dwarf_Addr addr, void *data)
922 struct probe_finder *pf = data;
923 Dwarf_Die *sc_die, die_mem;
926 if (!intlist__has_entry(pf->lcache, lineno) ||
927 strtailcmp(fname, pf->fname) != 0)
930 pr_debug("Probe line found: line:%d addr:0x%llx\n",
931 lineno, (unsigned long long)addr);
934 sc_die = find_best_scope(pf, &die_mem);
936 pr_warning("Failed to find scope of probe point.\n");
940 ret = call_probe_finder(sc_die, pf);
943 * Continue if no error, because the lazy pattern will match
946 return ret < 0 ? ret : 0;
949 /* Find probe points from lazy pattern */
950 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
953 char sbuild_id[SBUILD_ID_SIZE] = "";
957 if (intlist__empty(pf->lcache)) {
958 const char *comp_dir;
960 comp_dir = cu_get_comp_dir(&pf->cu_die);
961 if (pf->dbg->build_id) {
962 build_id__init(&bid, pf->dbg->build_id, BUILD_ID_SIZE);
963 build_id__sprintf(&bid, sbuild_id);
965 ret = find_source_path(pf->fname, sbuild_id, comp_dir, &fpath);
967 pr_warning("Failed to find source file path.\n");
971 /* Matching lazy line pattern */
972 ret = find_lazy_match_lines(pf->lcache, fpath,
973 pf->pev->point.lazy_line);
979 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
982 static void skip_prologue(Dwarf_Die *sp_die, struct probe_finder *pf)
984 struct perf_probe_point *pp = &pf->pev->point;
987 if (!pf->pev->uprobes)
990 /* Compiled with optimization? */
991 if (die_is_optimized_target(&pf->cu_die))
994 /* Don't know entrypc? */
998 /* Only FUNC and FUNC@SRC are eligible. */
999 if (!pp->function || pp->line || pp->retprobe || pp->lazy_line ||
1000 pp->offset || pp->abs_address)
1003 /* Not interested in func parameter? */
1004 if (!perf_probe_with_var(pf->pev))
1007 pr_info("Target program is compiled without optimization. Skipping prologue.\n"
1008 "Probe on address 0x%" PRIx64 " to force probing at the function entry.\n\n",
1011 die_skip_prologue(sp_die, &pf->cu_die, &pf->addr);
1014 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
1016 struct probe_finder *pf = data;
1017 struct perf_probe_point *pp = &pf->pev->point;
1022 ret = find_probe_point_lazy(in_die, pf);
1024 /* Get probe address */
1025 if (die_entrypc(in_die, &addr) != 0) {
1026 pr_warning("Failed to get entry address of %s.\n",
1027 dwarf_diename(in_die));
1031 pr_debug("%s has no valid entry address. skipped.\n",
1032 dwarf_diename(in_die));
1036 pf->addr += pp->offset;
1037 pr_debug("found inline addr: 0x%jx\n",
1038 (uintmax_t)pf->addr);
1040 ret = call_probe_finder(in_die, pf);
1046 /* Callback parameter with return value for libdw */
1047 struct dwarf_callback_param {
1052 /* Search function from function name */
1053 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
1055 struct dwarf_callback_param *param = data;
1056 struct probe_finder *pf = param->data;
1057 struct perf_probe_point *pp = &pf->pev->point;
1059 /* Check tag and diename */
1060 if (!die_is_func_def(sp_die) ||
1061 !die_match_name(sp_die, pp->function))
1064 /* Check declared file */
1065 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
1068 pr_debug("Matched function: %s [%lx]\n", dwarf_diename(sp_die),
1069 (unsigned long)dwarf_dieoffset(sp_die));
1070 pf->fname = dwarf_decl_file(sp_die);
1071 if (pp->line) { /* Function relative line */
1072 dwarf_decl_line(sp_die, &pf->lno);
1073 pf->lno += pp->line;
1074 param->retval = find_probe_point_by_line(pf);
1075 } else if (die_is_func_instance(sp_die)) {
1076 /* Instances always have the entry address */
1077 die_entrypc(sp_die, &pf->addr);
1078 /* But in some case the entry address is 0 */
1079 if (pf->addr == 0) {
1080 pr_debug("%s has no entry PC. Skipped\n",
1081 dwarf_diename(sp_die));
1084 } else if (pp->lazy_line)
1085 param->retval = find_probe_point_lazy(sp_die, pf);
1087 skip_prologue(sp_die, pf);
1088 pf->addr += pp->offset;
1089 /* TODO: Check the address in this function */
1090 param->retval = call_probe_finder(sp_die, pf);
1092 } else if (!probe_conf.no_inlines) {
1093 /* Inlined function: search instances */
1094 param->retval = die_walk_instances(sp_die,
1095 probe_point_inline_cb, (void *)pf);
1096 /* This could be a non-existed inline definition */
1097 if (param->retval == -ENOENT)
1101 /* We need to find other candidates */
1102 if (strisglob(pp->function) && param->retval >= 0) {
1103 param->retval = 0; /* We have to clear the result */
1107 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1110 static int find_probe_point_by_func(struct probe_finder *pf)
1112 struct dwarf_callback_param _param = {.data = (void *)pf,
1114 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
1115 return _param.retval;
1118 struct pubname_callback_param {
1126 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
1128 struct pubname_callback_param *param = data;
1130 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
1131 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1134 if (die_match_name(param->sp_die, param->function)) {
1135 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1139 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1143 return DWARF_CB_ABORT;
1150 static int debuginfo__find_probe_location(struct debuginfo *dbg,
1151 struct probe_finder *pf)
1153 struct perf_probe_point *pp = &pf->pev->point;
1154 Dwarf_Off off, noff;
1160 pf->lcache = intlist__new(NULL);
1164 /* Fastpath: lookup by function name from .debug_pubnames section */
1165 if (pp->function && !strisglob(pp->function)) {
1166 struct pubname_callback_param pubname_param = {
1167 .function = pp->function,
1169 .cu_die = &pf->cu_die,
1170 .sp_die = &pf->sp_die,
1173 struct dwarf_callback_param probe_param = {
1177 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1179 if (pubname_param.found) {
1180 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1186 /* Loop on CUs (Compilation Unit) */
1187 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1188 /* Get the DIE(Debugging Information Entry) of this CU */
1189 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1193 /* Check if target file is included. */
1195 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1199 if (!pp->file || pf->fname) {
1201 ret = find_probe_point_by_func(pf);
1202 else if (pp->lazy_line)
1203 ret = find_probe_point_lazy(&pf->cu_die, pf);
1206 ret = find_probe_point_by_line(pf);
1215 intlist__delete(pf->lcache);
1221 /* Find probe points from debuginfo */
1222 static int debuginfo__find_probes(struct debuginfo *dbg,
1223 struct probe_finder *pf)
1229 if (pf->cfi_eh || pf->cfi_dbg)
1230 return debuginfo__find_probe_location(dbg, pf);
1232 /* Get the call frame information from this dwarf */
1233 elf = dwarf_getelf(dbg->dbg);
1237 if (gelf_getehdr(elf, &ehdr) == NULL)
1240 pf->machine = ehdr.e_machine;
1242 #if _ELFUTILS_PREREQ(0, 142)
1246 if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1247 shdr.sh_type == SHT_PROGBITS)
1248 pf->cfi_eh = dwarf_getcfi_elf(elf);
1250 pf->cfi_dbg = dwarf_getcfi(dbg->dbg);
1254 ret = debuginfo__find_probe_location(dbg, pf);
1258 struct local_vars_finder {
1259 struct probe_finder *pf;
1260 struct perf_probe_arg *args;
1267 /* Collect available variables in this scope */
1268 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1270 struct local_vars_finder *vf = data;
1271 struct probe_finder *pf = vf->pf;
1274 tag = dwarf_tag(die_mem);
1275 if (tag == DW_TAG_formal_parameter ||
1276 (tag == DW_TAG_variable && vf->vars)) {
1277 if (convert_variable_location(die_mem, vf->pf->addr,
1278 vf->pf->fb_ops, &pf->sp_die,
1279 pf->machine, NULL) == 0) {
1280 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1281 if (vf->args[vf->nargs].var == NULL) {
1283 return DIE_FIND_CB_END;
1285 pr_debug(" %s", vf->args[vf->nargs].var);
1290 if (dwarf_haspc(die_mem, vf->pf->addr))
1291 return DIE_FIND_CB_CONTINUE;
1293 return DIE_FIND_CB_SIBLING;
1296 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1297 struct perf_probe_arg *args)
1302 struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1303 .max_args = MAX_PROBE_ARGS, .ret = 0};
1305 for (i = 0; i < pf->pev->nargs; i++) {
1306 /* var never be NULL */
1307 if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1309 else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1310 /* Copy normal argument */
1311 args[n] = pf->pev->args[i];
1315 pr_debug("Expanding %s into:", pf->pev->args[i].var);
1317 /* Special local variables */
1318 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1320 pr_debug(" (%d)\n", vf.nargs - n);
1328 static bool trace_event_finder_overlap(struct trace_event_finder *tf)
1332 for (i = 0; i < tf->ntevs; i++) {
1333 if (tf->pf.addr == tf->tevs[i].point.address)
1339 /* Add a found probe point into trace event list */
1340 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1342 struct trace_event_finder *tf =
1343 container_of(pf, struct trace_event_finder, pf);
1344 struct perf_probe_point *pp = &pf->pev->point;
1345 struct probe_trace_event *tev;
1346 struct perf_probe_arg *args = NULL;
1350 * For some reason (e.g. different column assigned to same address)
1351 * This callback can be called with the address which already passed.
1354 if (trace_event_finder_overlap(tf))
1357 /* Check number of tevs */
1358 if (tf->ntevs == tf->max_tevs) {
1359 pr_warning("Too many( > %d) probe point found.\n",
1363 tev = &tf->tevs[tf->ntevs++];
1365 /* Trace point should be converted from subprogram DIE */
1366 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1367 pp->retprobe, pp->function, &tev->point);
1371 tev->point.realname = strdup(dwarf_diename(sc_die));
1372 if (!tev->point.realname) {
1377 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1380 /* Expand special probe argument if exist */
1381 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1387 ret = expand_probe_args(sc_die, pf, args);
1392 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1393 if (tev->args == NULL) {
1398 /* Find each argument */
1399 for (i = 0; i < tev->nargs; i++) {
1400 pf->pvar = &args[i];
1401 pf->tvar = &tev->args[i];
1402 /* Variable should be found from scope DIE */
1403 ret = find_variable(sc_die, pf);
1410 clear_probe_trace_event(tev);
1417 static int fill_empty_trace_arg(struct perf_probe_event *pev,
1418 struct probe_trace_event *tevs, int ntevs)
1427 for (i = 0; i < pev->nargs; i++) {
1429 for (j = 0; j < ntevs; j++) {
1430 if (tevs[j].args[i].value) {
1431 type = tevs[j].args[i].type;
1436 print_var_not_found(pev->args[i].var);
1439 for (j = 0; j < ntevs; j++) {
1440 valp = &tevs[j].args[i].value;
1444 ret = asprintf(valp, "\\%lx", probe_conf.magic_num);
1447 /* Note that type can be NULL */
1449 tevs[j].args[i].type = strdup(type);
1450 if (!tevs[j].args[i].type)
1458 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1459 int debuginfo__find_trace_events(struct debuginfo *dbg,
1460 struct perf_probe_event *pev,
1461 struct probe_trace_event **tevs)
1463 struct trace_event_finder tf = {
1464 .pf = {.pev = pev, .dbg = dbg, .callback = add_probe_trace_event},
1465 .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1468 /* Allocate result tevs array */
1469 *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1476 if (pev->nargs != 0 && immediate_value_is_supported())
1477 tf.pf.skip_empty_arg = true;
1479 ret = debuginfo__find_probes(dbg, &tf.pf);
1480 if (ret >= 0 && tf.pf.skip_empty_arg)
1481 ret = fill_empty_trace_arg(pev, tf.tevs, tf.ntevs);
1483 if (ret < 0 || tf.ntevs == 0) {
1484 for (i = 0; i < tf.ntevs; i++)
1485 clear_probe_trace_event(&tf.tevs[i]);
1490 return (ret < 0) ? ret : tf.ntevs;
1493 /* Collect available variables in this scope */
1494 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1496 struct available_var_finder *af = data;
1497 struct variable_list *vl;
1498 struct strbuf buf = STRBUF_INIT;
1501 vl = &af->vls[af->nvls - 1];
1503 tag = dwarf_tag(die_mem);
1504 if (tag == DW_TAG_formal_parameter ||
1505 tag == DW_TAG_variable) {
1506 ret = convert_variable_location(die_mem, af->pf.addr,
1507 af->pf.fb_ops, &af->pf.sp_die,
1508 af->pf.machine, NULL);
1509 if (ret == 0 || ret == -ERANGE) {
1511 bool externs = !af->child;
1513 if (strbuf_init(&buf, 64) < 0)
1516 if (probe_conf.show_location_range) {
1518 ret2 = strbuf_add(&buf,
1519 ret ? "[INV]\t" : "[VAL]\t", 6);
1521 ret2 = strbuf_add(&buf, "[EXT]\t", 6);
1526 ret2 = die_get_varname(die_mem, &buf);
1528 if (!ret2 && probe_conf.show_location_range &&
1530 if (strbuf_addch(&buf, '\t') < 0)
1532 ret2 = die_get_var_range(&af->pf.sp_die,
1536 pr_debug("Add new var: %s\n", buf.buf);
1538 strlist__add(vl->vars,
1539 strbuf_detach(&buf, NULL));
1541 strbuf_release(&buf);
1545 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1546 return DIE_FIND_CB_CONTINUE;
1548 return DIE_FIND_CB_SIBLING;
1550 strbuf_release(&buf);
1551 pr_debug("Error in strbuf\n");
1552 return DIE_FIND_CB_END;
1555 static bool available_var_finder_overlap(struct available_var_finder *af)
1559 for (i = 0; i < af->nvls; i++) {
1560 if (af->pf.addr == af->vls[i].point.address)
1567 /* Add a found vars into available variables list */
1568 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1570 struct available_var_finder *af =
1571 container_of(pf, struct available_var_finder, pf);
1572 struct perf_probe_point *pp = &pf->pev->point;
1573 struct variable_list *vl;
1578 * For some reason (e.g. different column assigned to same address),
1579 * this callback can be called with the address which already passed.
1582 if (available_var_finder_overlap(af))
1585 /* Check number of tevs */
1586 if (af->nvls == af->max_vls) {
1587 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1590 vl = &af->vls[af->nvls++];
1592 /* Trace point should be converted from subprogram DIE */
1593 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1594 pp->retprobe, pp->function, &vl->point);
1598 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1601 /* Find local variables */
1602 vl->vars = strlist__new(NULL, NULL);
1603 if (vl->vars == NULL)
1606 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1608 /* Find external variables */
1609 if (!probe_conf.show_ext_vars)
1611 /* Don't need to search child DIE for external vars. */
1613 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1616 if (strlist__empty(vl->vars)) {
1617 strlist__delete(vl->vars);
1625 * Find available variables at given probe point
1626 * Return the number of found probe points. Return 0 if there is no
1627 * matched probe point. Return <0 if an error occurs.
1629 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1630 struct perf_probe_event *pev,
1631 struct variable_list **vls)
1633 struct available_var_finder af = {
1634 .pf = {.pev = pev, .dbg = dbg, .callback = add_available_vars},
1636 .max_vls = probe_conf.max_probes};
1639 /* Allocate result vls array */
1640 *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1647 ret = debuginfo__find_probes(dbg, &af.pf);
1649 /* Free vlist for error */
1651 zfree(&af.vls[af.nvls].point.symbol);
1652 strlist__delete(af.vls[af.nvls].vars);
1658 return (ret < 0) ? ret : af.nvls;
1661 /* For the kernel module, we need a special code to get a DIE */
1662 int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs,
1669 GElf_Shdr mem, *shdr;
1672 elf = dwfl_module_getelf(dbg->mod, &dbg->bias);
1676 /* Get the number of relocations */
1677 n = dwfl_module_relocations(dbg->mod);
1680 /* Search the relocation related .text section */
1681 for (i = 0; i < n; i++) {
1682 p = dwfl_module_relocation_info(dbg->mod, i, &shndx);
1683 if (strcmp(p, ".text") == 0) {
1684 /* OK, get the section header */
1685 scn = elf_getscn(elf, shndx);
1688 shdr = gelf_getshdr(scn, &mem);
1691 *offs = shdr->sh_addr;
1693 *offs -= shdr->sh_offset;
1699 /* Reverse search */
1700 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1701 struct perf_probe_point *ppt)
1703 Dwarf_Die cudie, spdie, indie;
1704 Dwarf_Addr _addr = 0, baseaddr = 0;
1705 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1706 int baseline = 0, lineno = 0, ret = 0;
1708 /* We always need to relocate the address for aranges */
1709 if (debuginfo__get_text_offset(dbg, &baseaddr, false) == 0)
1712 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1713 pr_warning("Failed to find debug information for address %lx\n",
1719 /* Find a corresponding line (filename and lineno) */
1720 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1721 /* Don't care whether it failed or not */
1723 /* Find a corresponding function (name, baseline and baseaddr) */
1724 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1725 /* Get function entry information */
1726 func = basefunc = dwarf_diename(&spdie);
1728 die_entrypc(&spdie, &baseaddr) != 0 ||
1729 dwarf_decl_line(&spdie, &baseline) != 0) {
1734 fname = dwarf_decl_file(&spdie);
1735 if (addr == (unsigned long)baseaddr) {
1736 /* Function entry - Relative line number is 0 */
1741 /* Track down the inline functions step by step */
1742 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1744 /* There is an inline function */
1745 if (die_entrypc(&indie, &_addr) == 0 &&
1748 * addr is at an inline function entry.
1749 * In this case, lineno should be the call-site
1750 * line number. (overwrite lineinfo)
1752 lineno = die_get_call_lineno(&indie);
1753 fname = die_get_call_file(&indie);
1757 * addr is in an inline function body.
1758 * Since lineno points one of the lines
1759 * of the inline function, baseline should
1760 * be the entry line of the inline function.
1762 tmp = dwarf_diename(&indie);
1764 dwarf_decl_line(&indie, &baseline) != 0)
1770 /* Verify the lineno and baseline are in a same file */
1771 tmp = dwarf_decl_file(&spdie);
1772 if (!tmp || strcmp(tmp, fname) != 0)
1777 /* Make a relative line number or an offset */
1779 ppt->line = lineno - baseline;
1780 else if (basefunc) {
1781 ppt->offset = addr - (unsigned long)baseaddr;
1785 /* Duplicate strings */
1787 ppt->function = strdup(func);
1788 if (ppt->function == NULL) {
1794 ppt->file = strdup(fname);
1795 if (ppt->file == NULL) {
1796 zfree(&ppt->function);
1802 if (ret == 0 && (fname || func))
1803 ret = 1; /* Found a point */
1807 /* Add a line and store the src path */
1808 static int line_range_add_line(const char *src, unsigned int lineno,
1809 struct line_range *lr)
1811 /* Copy source path */
1813 lr->path = strdup(src);
1814 if (lr->path == NULL)
1817 return intlist__add(lr->line_list, lineno);
1820 static int line_range_walk_cb(const char *fname, int lineno,
1821 Dwarf_Addr addr __maybe_unused,
1824 struct line_finder *lf = data;
1825 const char *__fname;
1829 if ((strtailcmp(fname, lf->fname) != 0) ||
1830 (lf->lno_s > lineno || lf->lno_e < lineno))
1833 /* Make sure this line can be reversable */
1834 if (cu_find_lineinfo(&lf->cu_die, addr, &__fname, &__lineno) > 0
1835 && (lineno != __lineno || strcmp(fname, __fname)))
1838 err = line_range_add_line(fname, lineno, lf->lr);
1839 if (err < 0 && err != -EEXIST)
1845 /* Find line range from its line number */
1846 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1850 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1854 if (!intlist__empty(lf->lr->line_list))
1855 ret = lf->found = 1;
1857 ret = 0; /* Lines are not found */
1859 zfree(&lf->lr->path);
1864 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1866 int ret = find_line_range_by_line(in_die, data);
1869 * We have to check all instances of inlined function, because
1870 * some execution paths can be optimized out depends on the
1871 * function argument of instances. However, if an error occurs,
1872 * it should be handled by the caller.
1874 return ret < 0 ? ret : 0;
1877 /* Search function definition from function name */
1878 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1880 struct dwarf_callback_param *param = data;
1881 struct line_finder *lf = param->data;
1882 struct line_range *lr = lf->lr;
1884 /* Check declared file */
1885 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1888 if (die_match_name(sp_die, lr->function) && die_is_func_def(sp_die)) {
1889 lf->fname = dwarf_decl_file(sp_die);
1890 dwarf_decl_line(sp_die, &lr->offset);
1891 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1892 lf->lno_s = lr->offset + lr->start;
1893 if (lf->lno_s < 0) /* Overflow */
1894 lf->lno_s = INT_MAX;
1895 lf->lno_e = lr->offset + lr->end;
1896 if (lf->lno_e < 0) /* Overflow */
1897 lf->lno_e = INT_MAX;
1898 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1899 lr->start = lf->lno_s;
1900 lr->end = lf->lno_e;
1901 if (!die_is_func_instance(sp_die))
1902 param->retval = die_walk_instances(sp_die,
1903 line_range_inline_cb, lf);
1905 param->retval = find_line_range_by_line(sp_die, lf);
1906 return DWARF_CB_ABORT;
1911 static int find_line_range_by_func(struct line_finder *lf)
1913 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1914 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, ¶m, 0);
1915 return param.retval;
1918 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1920 struct line_finder lf = {.lr = lr, .found = 0};
1922 Dwarf_Off off = 0, noff;
1925 const char *comp_dir;
1927 /* Fastpath: lookup by function name from .debug_pubnames section */
1929 struct pubname_callback_param pubname_param = {
1930 .function = lr->function, .file = lr->file,
1931 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1932 struct dwarf_callback_param line_range_param = {
1933 .data = (void *)&lf, .retval = 0};
1935 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1937 if (pubname_param.found) {
1938 line_range_search_cb(&lf.sp_die, &line_range_param);
1944 /* Loop on CUs (Compilation Unit) */
1945 while (!lf.found && ret >= 0) {
1946 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1947 NULL, NULL, NULL) != 0)
1950 /* Get the DIE(Debugging Information Entry) of this CU */
1951 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1955 /* Check if target file is included. */
1957 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1961 if (!lr->file || lf.fname) {
1963 ret = find_line_range_by_func(&lf);
1965 lf.lno_s = lr->start;
1967 ret = find_line_range_by_line(NULL, &lf);
1974 /* Store comp_dir */
1976 comp_dir = cu_get_comp_dir(&lf.cu_die);
1978 lr->comp_dir = strdup(comp_dir);
1984 pr_debug("path: %s\n", lr->path);
1985 return (ret < 0) ? ret : lf.found;
1988 #ifdef HAVE_DEBUGINFOD_SUPPORT
1989 /* debuginfod doesn't require the comp_dir but buildid is required */
1990 static int get_source_from_debuginfod(const char *raw_path,
1991 const char *sbuild_id, char **new_path)
1993 debuginfod_client *c = debuginfod_begin();
1994 const char *p = raw_path;
2000 fd = debuginfod_find_source(c, (const unsigned char *)sbuild_id,
2002 pr_debug("Search %s from debuginfod -> %d\n", p, fd);
2007 pr_debug("Failed to find %s in debuginfod (%s)\n",
2008 raw_path, sbuild_id);
2011 pr_debug("Got a source %s\n", *new_path);
2016 static inline int get_source_from_debuginfod(const char *raw_path __maybe_unused,
2017 const char *sbuild_id __maybe_unused,
2018 char **new_path __maybe_unused)
2024 * Find a src file from a DWARF tag path. Prepend optional source path prefix
2025 * and chop off leading directories that do not exist. Result is passed back as
2026 * a newly allocated path on success.
2027 * Return 0 if file was found and readable, -errno otherwise.
2029 int find_source_path(const char *raw_path, const char *sbuild_id,
2030 const char *comp_dir, char **new_path)
2032 const char *prefix = symbol_conf.source_prefix;
2034 if (sbuild_id && !prefix) {
2035 if (!get_source_from_debuginfod(raw_path, sbuild_id, new_path))
2040 if (raw_path[0] != '/' && comp_dir)
2041 /* If not an absolute path, try to use comp_dir */
2044 if (access(raw_path, R_OK) == 0) {
2045 *new_path = strdup(raw_path);
2046 return *new_path ? 0 : -ENOMEM;
2052 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
2057 sprintf(*new_path, "%s/%s", prefix, raw_path);
2059 if (access(*new_path, R_OK) == 0)
2062 if (!symbol_conf.source_prefix) {
2063 /* In case of searching comp_dir, don't retry */
2073 raw_path = strchr(++raw_path, '/');