2 * probe-finder.c : C expression to kprobe event converter
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>
33 #include <dwarf-regs.h>
35 #include <linux/bitops.h>
40 #include "probe-finder.h"
42 /* Kprobe tracer basic type is up to u64 */
43 #define MAX_BASIC_TYPE_BITS 64
45 /* Line number list operations */
47 /* Add a line to line number list */
48 static int line_list__add_line(struct list_head *head, int line)
53 /* Reverse search, because new line will be the last one */
54 list_for_each_entry_reverse(ln, head, list) {
55 if (ln->line < line) {
58 } else if (ln->line == line) /* Already exist */
61 /* List is empty, or the smallest entry */
64 pr_debug("line list: add a line %u\n", line);
65 ln = zalloc(sizeof(struct line_node));
69 INIT_LIST_HEAD(&ln->list);
70 list_add(&ln->list, p);
74 /* Check if the line in line number list */
75 static int line_list__has_line(struct list_head *head, int line)
79 /* Reverse search, because new line will be the last one */
80 list_for_each_entry(ln, head, list)
87 /* Init line number list */
88 static void line_list__init(struct list_head *head)
93 /* Free line number list */
94 static void line_list__free(struct list_head *head)
97 while (!list_empty(head)) {
98 ln = list_first_entry(head, struct line_node, list);
104 /* Dwarf FL wrappers */
105 static char *debuginfo_path; /* Currently dummy */
107 static const Dwfl_Callbacks offline_callbacks = {
108 .find_debuginfo = dwfl_standard_find_debuginfo,
109 .debuginfo_path = &debuginfo_path,
111 .section_address = dwfl_offline_section_address,
113 /* We use this table for core files too. */
114 .find_elf = dwfl_build_id_find_elf,
117 /* Get a Dwarf from offline image */
118 static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
123 fd = open(path, O_RDONLY);
127 dbg->dwfl = dwfl_begin(&offline_callbacks);
131 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
135 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
145 memset(dbg, 0, sizeof(*dbg));
150 #if _ELFUTILS_PREREQ(0, 148)
151 /* This method is buggy if elfutils is older than 0.148 */
152 static int __linux_kernel_find_elf(Dwfl_Module *mod,
154 const char *module_name,
156 char **file_name, Elf **elfp)
159 const char *path = kernel_get_module_path(module_name);
161 pr_debug2("Use file %s for %s\n", path, module_name);
163 fd = open(path, O_RDONLY);
165 *file_name = strdup(path);
169 /* If failed, try to call standard method */
170 return dwfl_linux_kernel_find_elf(mod, userdata, module_name, base,
174 static const Dwfl_Callbacks kernel_callbacks = {
175 .find_debuginfo = dwfl_standard_find_debuginfo,
176 .debuginfo_path = &debuginfo_path,
178 .find_elf = __linux_kernel_find_elf,
179 .section_address = dwfl_linux_kernel_module_section_address,
182 /* Get a Dwarf from live kernel image */
183 static int debuginfo__init_online_kernel_dwarf(struct debuginfo *dbg,
186 dbg->dwfl = dwfl_begin(&kernel_callbacks);
190 /* Load the kernel dwarves: Don't care the result here */
191 dwfl_linux_kernel_report_kernel(dbg->dwfl);
192 dwfl_linux_kernel_report_modules(dbg->dwfl);
194 dbg->dbg = dwfl_addrdwarf(dbg->dwfl, addr, &dbg->bias);
195 /* Here, check whether we could get a real dwarf */
197 pr_debug("Failed to find kernel dwarf at %lx\n",
198 (unsigned long)addr);
200 memset(dbg, 0, sizeof(*dbg));
207 /* With older elfutils, this just support kernel module... */
208 static int debuginfo__init_online_kernel_dwarf(struct debuginfo *dbg,
209 Dwarf_Addr addr __maybe_unused)
211 const char *path = kernel_get_module_path("kernel");
214 pr_err("Failed to find vmlinux path\n");
218 pr_debug2("Use file %s for debuginfo\n", path);
219 return debuginfo__init_offline_dwarf(dbg, path);
223 struct debuginfo *debuginfo__new(const char *path)
225 struct debuginfo *dbg = zalloc(sizeof(*dbg));
229 if (debuginfo__init_offline_dwarf(dbg, path) < 0) {
237 struct debuginfo *debuginfo__new_online_kernel(unsigned long addr)
239 struct debuginfo *dbg = zalloc(sizeof(*dbg));
244 if (debuginfo__init_online_kernel_dwarf(dbg, (Dwarf_Addr)addr) < 0) {
252 void debuginfo__delete(struct debuginfo *dbg)
262 * Probe finder related functions
265 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
267 struct probe_trace_arg_ref *ref;
268 ref = zalloc(sizeof(struct probe_trace_arg_ref));
275 * Convert a location into trace_arg.
276 * If tvar == NULL, this just checks variable can be converted.
277 * If fentry == true and vr_die is a parameter, do huristic search
278 * for the location fuzzed by function entry mcount.
280 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
281 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
282 struct probe_trace_arg *tvar)
284 Dwarf_Attribute attr;
294 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
297 /* TODO: handle more than 1 exprs */
298 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
299 return -EINVAL; /* Broken DIE ? */
300 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
301 ret = dwarf_entrypc(sp_die, &tmp);
302 if (ret || addr != tmp ||
303 dwarf_tag(vr_die) != DW_TAG_formal_parameter ||
304 dwarf_highpc(sp_die, &tmp))
307 * This is fuzzed by fentry mcount. We try to find the
308 * parameter location at the earliest address.
310 for (addr += 1; addr <= tmp; addr++) {
311 if (dwarf_getlocation_addr(&attr, addr, &op,
319 /* TODO: Support const_value */
322 if (op->atom == DW_OP_addr) {
326 /* Static variables on memory (not stack), make @varname */
327 ret = strlen(dwarf_diename(vr_die));
328 tvar->value = zalloc(ret + 2);
329 if (tvar->value == NULL)
331 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
332 tvar->ref = alloc_trace_arg_ref((long)offs);
333 if (tvar->ref == NULL)
338 /* If this is based on frame buffer, set the offset */
339 if (op->atom == DW_OP_fbreg) {
347 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
348 regn = op->atom - DW_OP_breg0;
351 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
352 regn = op->atom - DW_OP_reg0;
353 } else if (op->atom == DW_OP_bregx) {
357 } else if (op->atom == DW_OP_regx) {
360 pr_debug("DW_OP %x is not supported.\n", op->atom);
367 regs = get_arch_regstr(regn);
369 /* This should be a bug in DWARF or this tool */
370 pr_warning("Mapping for the register number %u "
371 "missing on this architecture.\n", regn);
375 tvar->value = strdup(regs);
376 if (tvar->value == NULL)
380 tvar->ref = alloc_trace_arg_ref((long)offs);
381 if (tvar->ref == NULL)
387 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
389 static int convert_variable_type(Dwarf_Die *vr_die,
390 struct probe_trace_arg *tvar,
393 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
396 int bsize, boffs, total;
399 /* TODO: check all types */
400 if (cast && strcmp(cast, "string") != 0) {
401 /* Non string type is OK */
402 tvar->type = strdup(cast);
403 return (tvar->type == NULL) ? -ENOMEM : 0;
406 bsize = dwarf_bitsize(vr_die);
408 /* This is a bitfield */
409 boffs = dwarf_bitoffset(vr_die);
410 total = dwarf_bytesize(vr_die);
411 if (boffs < 0 || total < 0)
413 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
414 BYTES_TO_BITS(total));
418 if (die_get_real_type(vr_die, &type) == NULL) {
419 pr_warning("Failed to get a type information of %s.\n",
420 dwarf_diename(vr_die));
424 pr_debug("%s type is %s.\n",
425 dwarf_diename(vr_die), dwarf_diename(&type));
427 if (cast && strcmp(cast, "string") == 0) { /* String type */
428 ret = dwarf_tag(&type);
429 if (ret != DW_TAG_pointer_type &&
430 ret != DW_TAG_array_type) {
431 pr_warning("Failed to cast into string: "
432 "%s(%s) is not a pointer nor array.\n",
433 dwarf_diename(vr_die), dwarf_diename(&type));
436 if (die_get_real_type(&type, &type) == NULL) {
437 pr_warning("Failed to get a type"
441 if (ret == DW_TAG_pointer_type) {
443 ref_ptr = &(*ref_ptr)->next;
444 /* Add new reference with offset +0 */
445 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
446 if (*ref_ptr == NULL) {
447 pr_warning("Out of memory error\n");
451 if (!die_compare_name(&type, "char") &&
452 !die_compare_name(&type, "unsigned char")) {
453 pr_warning("Failed to cast into string: "
454 "%s is not (unsigned) char *.\n",
455 dwarf_diename(vr_die));
458 tvar->type = strdup(cast);
459 return (tvar->type == NULL) ? -ENOMEM : 0;
462 ret = dwarf_bytesize(&type);
464 /* No size ... try to use default type */
466 ret = BYTES_TO_BITS(ret);
468 /* Check the bitwidth */
469 if (ret > MAX_BASIC_TYPE_BITS) {
470 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
471 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
472 ret = MAX_BASIC_TYPE_BITS;
474 ret = snprintf(buf, 16, "%c%d",
475 die_is_signed_type(&type) ? 's' : 'u', ret);
478 if (ret < 0 || ret >= 16) {
481 pr_warning("Failed to convert variable type: %s\n",
485 tvar->type = strdup(buf);
486 if (tvar->type == NULL)
491 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
492 struct perf_probe_arg_field *field,
493 struct probe_trace_arg_ref **ref_ptr,
496 struct probe_trace_arg_ref *ref = *ref_ptr;
501 pr_debug("converting %s in %s\n", field->name, varname);
502 if (die_get_real_type(vr_die, &type) == NULL) {
503 pr_warning("Failed to get the type of %s.\n", varname);
506 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
507 tag = dwarf_tag(&type);
509 if (field->name[0] == '[' &&
510 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
512 /* Save original type for next field */
513 memcpy(die_mem, &type, sizeof(*die_mem));
514 /* Get the type of this array */
515 if (die_get_real_type(&type, &type) == NULL) {
516 pr_warning("Failed to get the type of %s.\n", varname);
519 pr_debug2("Array real type: (%x)\n",
520 (unsigned)dwarf_dieoffset(&type));
521 if (tag == DW_TAG_pointer_type) {
522 ref = zalloc(sizeof(struct probe_trace_arg_ref));
526 (*ref_ptr)->next = ref;
530 ref->offset += dwarf_bytesize(&type) * field->index;
532 /* Save vr_die for converting types */
533 memcpy(die_mem, vr_die, sizeof(*die_mem));
535 } else if (tag == DW_TAG_pointer_type) {
536 /* Check the pointer and dereference */
538 pr_err("Semantic error: %s must be referred by '->'\n",
542 /* Get the type pointed by this pointer */
543 if (die_get_real_type(&type, &type) == NULL) {
544 pr_warning("Failed to get the type of %s.\n", varname);
547 /* Verify it is a data structure */
548 tag = dwarf_tag(&type);
549 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
550 pr_warning("%s is not a data structure nor an union.\n",
555 ref = zalloc(sizeof(struct probe_trace_arg_ref));
559 (*ref_ptr)->next = ref;
563 /* Verify it is a data structure */
564 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
565 pr_warning("%s is not a data structure nor an union.\n",
569 if (field->name[0] == '[') {
570 pr_err("Semantic error: %s is not a pointor"
571 " nor array.\n", varname);
575 pr_err("Semantic error: %s must be referred by '.'\n",
580 pr_warning("Structure on a register is not "
586 if (die_find_member(&type, field->name, die_mem) == NULL) {
587 pr_warning("%s(type:%s) has no member %s.\n", varname,
588 dwarf_diename(&type), field->name);
592 /* Get the offset of the field */
593 if (tag == DW_TAG_union_type) {
596 ret = die_get_data_member_location(die_mem, &offs);
598 pr_warning("Failed to get the offset of %s.\n",
603 ref->offset += (long)offs;
606 /* Converting next field */
608 return convert_variable_fields(die_mem, field->name,
609 field->next, &ref, die_mem);
614 /* Show a variables in kprobe event format */
615 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
620 pr_debug("Converting variable %s into trace event.\n",
621 dwarf_diename(vr_die));
623 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
624 &pf->sp_die, pf->tvar);
626 pr_err("Failed to find the location of %s at this address.\n"
627 " Perhaps, it has been optimized out.\n", pf->pvar->var);
628 else if (ret == -ENOTSUP)
629 pr_err("Sorry, we don't support this variable location yet.\n");
630 else if (pf->pvar->field) {
631 ret = convert_variable_fields(vr_die, pf->pvar->var,
632 pf->pvar->field, &pf->tvar->ref,
637 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
638 /* *expr will be cached in libdw. Don't free it. */
642 /* Find a variable in a scope DIE */
643 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
649 if (!is_c_varname(pf->pvar->var)) {
650 /* Copy raw parameters */
651 pf->tvar->value = strdup(pf->pvar->var);
652 if (pf->tvar->value == NULL)
654 if (pf->pvar->type) {
655 pf->tvar->type = strdup(pf->pvar->type);
656 if (pf->tvar->type == NULL)
659 if (pf->pvar->name) {
660 pf->tvar->name = strdup(pf->pvar->name);
661 if (pf->tvar->name == NULL)
664 pf->tvar->name = NULL;
669 pf->tvar->name = strdup(pf->pvar->name);
671 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
674 ptr = strchr(buf, ':'); /* Change type separator to _ */
677 pf->tvar->name = strdup(buf);
679 if (pf->tvar->name == NULL)
682 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
683 /* Search child die for local variables and parameters. */
684 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
685 /* Search again in global variables */
686 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var, 0, &vr_die))
690 ret = convert_variable(&vr_die, pf);
693 pr_warning("Failed to find '%s' in this function.\n",
698 /* Convert subprogram DIE to trace point */
699 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
700 Dwarf_Addr paddr, bool retprobe,
701 struct probe_trace_point *tp)
703 Dwarf_Addr eaddr, highaddr;
707 /* Verify the address is correct */
708 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
709 pr_warning("Failed to get entry address of %s\n",
710 dwarf_diename(sp_die));
713 if (dwarf_highpc(sp_die, &highaddr) != 0) {
714 pr_warning("Failed to get end address of %s\n",
715 dwarf_diename(sp_die));
718 if (paddr > highaddr) {
719 pr_warning("Offset specified is greater than size of %s\n",
720 dwarf_diename(sp_die));
724 /* Get an appropriate symbol from symtab */
725 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
727 pr_warning("Failed to find symbol at 0x%lx\n",
728 (unsigned long)paddr);
731 tp->offset = (unsigned long)(paddr - sym.st_value);
732 tp->symbol = strdup(symbol);
736 /* Return probe must be on the head of a subprogram */
738 if (eaddr != paddr) {
739 pr_warning("Return probe must be on the head of"
740 " a real function.\n");
749 /* Call probe_finder callback with scope DIE */
750 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
752 Dwarf_Attribute fb_attr;
757 pr_err("Caller must pass a scope DIE. Program error.\n");
761 /* If not a real subprogram, find a real one */
762 if (!die_is_func_def(sc_die)) {
763 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
764 pr_warning("Failed to find probe point in any "
769 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
771 /* Get the frame base attribute/ops from subprogram */
772 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
773 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
774 if (ret <= 0 || nops == 0) {
776 #if _ELFUTILS_PREREQ(0, 142)
777 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
780 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
781 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
782 pr_warning("Failed to get call frame on 0x%jx\n",
783 (uintmax_t)pf->addr);
789 /* Call finder's callback handler */
790 ret = pf->callback(sc_die, pf);
792 /* *pf->fb_ops will be cached in libdw. Don't free it. */
798 struct find_scope_param {
799 const char *function;
807 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
809 struct find_scope_param *fsp = data;
813 /* Skip if declared file name does not match */
815 file = dwarf_decl_file(fn_die);
816 if (!file || strcmp(fsp->file, file) != 0)
819 /* If the function name is given, that's what user expects */
821 if (die_compare_name(fn_die, fsp->function)) {
822 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
827 /* With the line number, find the nearest declared DIE */
828 dwarf_decl_line(fn_die, &lno);
829 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
830 /* Keep a candidate and continue */
831 fsp->diff = fsp->line - lno;
832 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
839 /* Find an appropriate scope fits to given conditions */
840 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
842 struct find_scope_param fsp = {
843 .function = pf->pev->point.function,
851 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
853 return fsp.found ? die_mem : NULL;
856 static int probe_point_line_walker(const char *fname, int lineno,
857 Dwarf_Addr addr, void *data)
859 struct probe_finder *pf = data;
860 Dwarf_Die *sc_die, die_mem;
863 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
867 sc_die = find_best_scope(pf, &die_mem);
869 pr_warning("Failed to find scope of probe point.\n");
873 ret = call_probe_finder(sc_die, pf);
875 /* Continue if no error, because the line will be in inline function */
876 return ret < 0 ? ret : 0;
879 /* Find probe point from its line number */
880 static int find_probe_point_by_line(struct probe_finder *pf)
882 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
885 /* Find lines which match lazy pattern */
886 static int find_lazy_match_lines(struct list_head *head,
887 const char *fname, const char *pat)
893 int count = 0, linenum = 1;
895 fp = fopen(fname, "r");
897 pr_warning("Failed to open %s: %s\n", fname, strerror(errno));
901 while ((len = getline(&line, &line_len, fp)) > 0) {
903 if (line[len - 1] == '\n')
904 line[len - 1] = '\0';
906 if (strlazymatch(line, pat)) {
907 line_list__add_line(head, linenum);
919 pr_debug("No matched lines found in %s.\n", fname);
923 static int probe_point_lazy_walker(const char *fname, int lineno,
924 Dwarf_Addr addr, void *data)
926 struct probe_finder *pf = data;
927 Dwarf_Die *sc_die, die_mem;
930 if (!line_list__has_line(&pf->lcache, lineno) ||
931 strtailcmp(fname, pf->fname) != 0)
934 pr_debug("Probe line found: line:%d addr:0x%llx\n",
935 lineno, (unsigned long long)addr);
938 sc_die = find_best_scope(pf, &die_mem);
940 pr_warning("Failed to find scope of probe point.\n");
944 ret = call_probe_finder(sc_die, pf);
947 * Continue if no error, because the lazy pattern will match
950 return ret < 0 ? ret : 0;
953 /* Find probe points from lazy pattern */
954 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
958 if (list_empty(&pf->lcache)) {
959 /* Matching lazy line pattern */
960 ret = find_lazy_match_lines(&pf->lcache, pf->fname,
961 pf->pev->point.lazy_line);
966 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
969 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
971 struct probe_finder *pf = data;
972 struct perf_probe_point *pp = &pf->pev->point;
977 ret = find_probe_point_lazy(in_die, pf);
979 /* Get probe address */
980 if (dwarf_entrypc(in_die, &addr) != 0) {
981 pr_warning("Failed to get entry address of %s.\n",
982 dwarf_diename(in_die));
986 pf->addr += pp->offset;
987 pr_debug("found inline addr: 0x%jx\n",
988 (uintmax_t)pf->addr);
990 ret = call_probe_finder(in_die, pf);
996 /* Callback parameter with return value for libdw */
997 struct dwarf_callback_param {
1002 /* Search function from function name */
1003 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
1005 struct dwarf_callback_param *param = data;
1006 struct probe_finder *pf = param->data;
1007 struct perf_probe_point *pp = &pf->pev->point;
1009 /* Check tag and diename */
1010 if (!die_is_func_def(sp_die) ||
1011 !die_compare_name(sp_die, pp->function))
1014 /* Check declared file */
1015 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
1018 pf->fname = dwarf_decl_file(sp_die);
1019 if (pp->line) { /* Function relative line */
1020 dwarf_decl_line(sp_die, &pf->lno);
1021 pf->lno += pp->line;
1022 param->retval = find_probe_point_by_line(pf);
1023 } else if (!dwarf_func_inline(sp_die)) {
1026 param->retval = find_probe_point_lazy(sp_die, pf);
1028 if (dwarf_entrypc(sp_die, &pf->addr) != 0) {
1029 pr_warning("Failed to get entry address of "
1030 "%s.\n", dwarf_diename(sp_die));
1031 param->retval = -ENOENT;
1032 return DWARF_CB_ABORT;
1034 pf->addr += pp->offset;
1035 /* TODO: Check the address in this function */
1036 param->retval = call_probe_finder(sp_die, pf);
1039 /* Inlined function: search instances */
1040 param->retval = die_walk_instances(sp_die,
1041 probe_point_inline_cb, (void *)pf);
1043 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1046 static int find_probe_point_by_func(struct probe_finder *pf)
1048 struct dwarf_callback_param _param = {.data = (void *)pf,
1050 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
1051 return _param.retval;
1054 struct pubname_callback_param {
1062 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
1064 struct pubname_callback_param *param = data;
1066 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
1067 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1070 if (die_compare_name(param->sp_die, param->function)) {
1071 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1075 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1079 return DWARF_CB_ABORT;
1086 /* Find probe points from debuginfo */
1087 static int debuginfo__find_probes(struct debuginfo *dbg,
1088 struct probe_finder *pf)
1090 struct perf_probe_point *pp = &pf->pev->point;
1091 Dwarf_Off off, noff;
1096 #if _ELFUTILS_PREREQ(0, 142)
1097 /* Get the call frame information from this dwarf */
1098 pf->cfi = dwarf_getcfi(dbg->dbg);
1102 line_list__init(&pf->lcache);
1104 /* Fastpath: lookup by function name from .debug_pubnames section */
1106 struct pubname_callback_param pubname_param = {
1107 .function = pp->function,
1109 .cu_die = &pf->cu_die,
1110 .sp_die = &pf->sp_die,
1113 struct dwarf_callback_param probe_param = {
1117 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1119 if (pubname_param.found) {
1120 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1126 /* Loop on CUs (Compilation Unit) */
1127 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1128 /* Get the DIE(Debugging Information Entry) of this CU */
1129 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1133 /* Check if target file is included. */
1135 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1139 if (!pp->file || pf->fname) {
1141 ret = find_probe_point_by_func(pf);
1142 else if (pp->lazy_line)
1143 ret = find_probe_point_lazy(NULL, pf);
1146 ret = find_probe_point_by_line(pf);
1155 line_list__free(&pf->lcache);
1160 struct local_vars_finder {
1161 struct probe_finder *pf;
1162 struct perf_probe_arg *args;
1168 /* Collect available variables in this scope */
1169 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1171 struct local_vars_finder *vf = data;
1172 struct probe_finder *pf = vf->pf;
1175 tag = dwarf_tag(die_mem);
1176 if (tag == DW_TAG_formal_parameter ||
1177 tag == DW_TAG_variable) {
1178 if (convert_variable_location(die_mem, vf->pf->addr,
1179 vf->pf->fb_ops, &pf->sp_die,
1181 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1182 if (vf->args[vf->nargs].var == NULL) {
1184 return DIE_FIND_CB_END;
1186 pr_debug(" %s", vf->args[vf->nargs].var);
1191 if (dwarf_haspc(die_mem, vf->pf->addr))
1192 return DIE_FIND_CB_CONTINUE;
1194 return DIE_FIND_CB_SIBLING;
1197 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1198 struct perf_probe_arg *args)
1203 struct local_vars_finder vf = {.pf = pf, .args = args,
1204 .max_args = MAX_PROBE_ARGS, .ret = 0};
1206 for (i = 0; i < pf->pev->nargs; i++) {
1207 /* var never be NULL */
1208 if (strcmp(pf->pev->args[i].var, "$vars") == 0) {
1209 pr_debug("Expanding $vars into:");
1211 /* Special local variables */
1212 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1214 pr_debug(" (%d)\n", vf.nargs - n);
1219 /* Copy normal argument */
1220 args[n] = pf->pev->args[i];
1227 /* Add a found probe point into trace event list */
1228 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1230 struct trace_event_finder *tf =
1231 container_of(pf, struct trace_event_finder, pf);
1232 struct probe_trace_event *tev;
1233 struct perf_probe_arg *args;
1236 /* Check number of tevs */
1237 if (tf->ntevs == tf->max_tevs) {
1238 pr_warning("Too many( > %d) probe point found.\n",
1242 tev = &tf->tevs[tf->ntevs++];
1244 /* Trace point should be converted from subprogram DIE */
1245 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1246 pf->pev->point.retprobe, &tev->point);
1250 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1253 /* Expand special probe argument if exist */
1254 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1258 ret = expand_probe_args(sc_die, pf, args);
1263 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1264 if (tev->args == NULL) {
1269 /* Find each argument */
1270 for (i = 0; i < tev->nargs; i++) {
1271 pf->pvar = &args[i];
1272 pf->tvar = &tev->args[i];
1273 /* Variable should be found from scope DIE */
1274 ret = find_variable(sc_die, pf);
1284 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1285 int debuginfo__find_trace_events(struct debuginfo *dbg,
1286 struct perf_probe_event *pev,
1287 struct probe_trace_event **tevs, int max_tevs)
1289 struct trace_event_finder tf = {
1290 .pf = {.pev = pev, .callback = add_probe_trace_event},
1291 .mod = dbg->mod, .max_tevs = max_tevs};
1294 /* Allocate result tevs array */
1295 *tevs = zalloc(sizeof(struct probe_trace_event) * max_tevs);
1302 ret = debuginfo__find_probes(dbg, &tf.pf);
1309 return (ret < 0) ? ret : tf.ntevs;
1312 #define MAX_VAR_LEN 64
1314 /* Collect available variables in this scope */
1315 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1317 struct available_var_finder *af = data;
1318 struct variable_list *vl;
1319 char buf[MAX_VAR_LEN];
1322 vl = &af->vls[af->nvls - 1];
1324 tag = dwarf_tag(die_mem);
1325 if (tag == DW_TAG_formal_parameter ||
1326 tag == DW_TAG_variable) {
1327 ret = convert_variable_location(die_mem, af->pf.addr,
1328 af->pf.fb_ops, &af->pf.sp_die,
1331 ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
1332 pr_debug2("Add new var: %s\n", buf);
1334 strlist__add(vl->vars, buf);
1338 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1339 return DIE_FIND_CB_CONTINUE;
1341 return DIE_FIND_CB_SIBLING;
1344 /* Add a found vars into available variables list */
1345 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1347 struct available_var_finder *af =
1348 container_of(pf, struct available_var_finder, pf);
1349 struct variable_list *vl;
1353 /* Check number of tevs */
1354 if (af->nvls == af->max_vls) {
1355 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1358 vl = &af->vls[af->nvls++];
1360 /* Trace point should be converted from subprogram DIE */
1361 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1362 pf->pev->point.retprobe, &vl->point);
1366 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1369 /* Find local variables */
1370 vl->vars = strlist__new(true, NULL);
1371 if (vl->vars == NULL)
1374 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1376 /* Find external variables */
1379 /* Don't need to search child DIE for externs. */
1381 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1384 if (strlist__empty(vl->vars)) {
1385 strlist__delete(vl->vars);
1392 /* Find available variables at given probe point */
1393 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1394 struct perf_probe_event *pev,
1395 struct variable_list **vls,
1396 int max_vls, bool externs)
1398 struct available_var_finder af = {
1399 .pf = {.pev = pev, .callback = add_available_vars},
1401 .max_vls = max_vls, .externs = externs};
1404 /* Allocate result vls array */
1405 *vls = zalloc(sizeof(struct variable_list) * max_vls);
1412 ret = debuginfo__find_probes(dbg, &af.pf);
1414 /* Free vlist for error */
1416 if (af.vls[af.nvls].point.symbol)
1417 free(af.vls[af.nvls].point.symbol);
1418 if (af.vls[af.nvls].vars)
1419 strlist__delete(af.vls[af.nvls].vars);
1426 return (ret < 0) ? ret : af.nvls;
1429 /* Reverse search */
1430 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1431 struct perf_probe_point *ppt)
1433 Dwarf_Die cudie, spdie, indie;
1434 Dwarf_Addr _addr = 0, baseaddr = 0;
1435 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1436 int baseline = 0, lineno = 0, ret = 0;
1438 /* Adjust address with bias */
1442 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr - dbg->bias, &cudie)) {
1443 pr_warning("Failed to find debug information for address %lx\n",
1449 /* Find a corresponding line (filename and lineno) */
1450 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1451 /* Don't care whether it failed or not */
1453 /* Find a corresponding function (name, baseline and baseaddr) */
1454 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1455 /* Get function entry information */
1456 func = basefunc = dwarf_diename(&spdie);
1458 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1459 dwarf_decl_line(&spdie, &baseline) != 0) {
1464 fname = dwarf_decl_file(&spdie);
1465 if (addr == (unsigned long)baseaddr) {
1466 /* Function entry - Relative line number is 0 */
1471 /* Track down the inline functions step by step */
1472 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1474 /* There is an inline function */
1475 if (dwarf_entrypc(&indie, &_addr) == 0 &&
1478 * addr is at an inline function entry.
1479 * In this case, lineno should be the call-site
1480 * line number. (overwrite lineinfo)
1482 lineno = die_get_call_lineno(&indie);
1483 fname = die_get_call_file(&indie);
1487 * addr is in an inline function body.
1488 * Since lineno points one of the lines
1489 * of the inline function, baseline should
1490 * be the entry line of the inline function.
1492 tmp = dwarf_diename(&indie);
1494 dwarf_decl_line(&indie, &baseline) != 0)
1500 /* Verify the lineno and baseline are in a same file */
1501 tmp = dwarf_decl_file(&spdie);
1502 if (!tmp || strcmp(tmp, fname) != 0)
1507 /* Make a relative line number or an offset */
1509 ppt->line = lineno - baseline;
1510 else if (basefunc) {
1511 ppt->offset = addr - (unsigned long)baseaddr;
1515 /* Duplicate strings */
1517 ppt->function = strdup(func);
1518 if (ppt->function == NULL) {
1524 ppt->file = strdup(fname);
1525 if (ppt->file == NULL) {
1526 if (ppt->function) {
1527 free(ppt->function);
1528 ppt->function = NULL;
1535 if (ret == 0 && (fname || func))
1536 ret = 1; /* Found a point */
1540 /* Add a line and store the src path */
1541 static int line_range_add_line(const char *src, unsigned int lineno,
1542 struct line_range *lr)
1544 /* Copy source path */
1546 lr->path = strdup(src);
1547 if (lr->path == NULL)
1550 return line_list__add_line(&lr->line_list, lineno);
1553 static int line_range_walk_cb(const char *fname, int lineno,
1554 Dwarf_Addr addr __maybe_unused,
1557 struct line_finder *lf = data;
1559 if ((strtailcmp(fname, lf->fname) != 0) ||
1560 (lf->lno_s > lineno || lf->lno_e < lineno))
1563 if (line_range_add_line(fname, lineno, lf->lr) < 0)
1569 /* Find line range from its line number */
1570 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1574 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1578 if (!list_empty(&lf->lr->line_list))
1579 ret = lf->found = 1;
1581 ret = 0; /* Lines are not found */
1584 lf->lr->path = NULL;
1589 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1591 find_line_range_by_line(in_die, data);
1594 * We have to check all instances of inlined function, because
1595 * some execution paths can be optimized out depends on the
1596 * function argument of instances
1601 /* Search function definition from function name */
1602 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1604 struct dwarf_callback_param *param = data;
1605 struct line_finder *lf = param->data;
1606 struct line_range *lr = lf->lr;
1608 /* Check declared file */
1609 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1612 if (die_is_func_def(sp_die) &&
1613 die_compare_name(sp_die, lr->function)) {
1614 lf->fname = dwarf_decl_file(sp_die);
1615 dwarf_decl_line(sp_die, &lr->offset);
1616 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1617 lf->lno_s = lr->offset + lr->start;
1618 if (lf->lno_s < 0) /* Overflow */
1619 lf->lno_s = INT_MAX;
1620 lf->lno_e = lr->offset + lr->end;
1621 if (lf->lno_e < 0) /* Overflow */
1622 lf->lno_e = INT_MAX;
1623 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1624 lr->start = lf->lno_s;
1625 lr->end = lf->lno_e;
1626 if (dwarf_func_inline(sp_die))
1627 param->retval = die_walk_instances(sp_die,
1628 line_range_inline_cb, lf);
1630 param->retval = find_line_range_by_line(sp_die, lf);
1631 return DWARF_CB_ABORT;
1636 static int find_line_range_by_func(struct line_finder *lf)
1638 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1639 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, ¶m, 0);
1640 return param.retval;
1643 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1645 struct line_finder lf = {.lr = lr, .found = 0};
1647 Dwarf_Off off = 0, noff;
1650 const char *comp_dir;
1652 /* Fastpath: lookup by function name from .debug_pubnames section */
1654 struct pubname_callback_param pubname_param = {
1655 .function = lr->function, .file = lr->file,
1656 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1657 struct dwarf_callback_param line_range_param = {
1658 .data = (void *)&lf, .retval = 0};
1660 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1662 if (pubname_param.found) {
1663 line_range_search_cb(&lf.sp_die, &line_range_param);
1669 /* Loop on CUs (Compilation Unit) */
1670 while (!lf.found && ret >= 0) {
1671 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1672 NULL, NULL, NULL) != 0)
1675 /* Get the DIE(Debugging Information Entry) of this CU */
1676 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1680 /* Check if target file is included. */
1682 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1686 if (!lr->file || lf.fname) {
1688 ret = find_line_range_by_func(&lf);
1690 lf.lno_s = lr->start;
1692 ret = find_line_range_by_line(NULL, &lf);
1699 /* Store comp_dir */
1701 comp_dir = cu_get_comp_dir(&lf.cu_die);
1703 lr->comp_dir = strdup(comp_dir);
1709 pr_debug("path: %s\n", lr->path);
1710 return (ret < 0) ? ret : lf.found;