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>
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 *self,
123 fd = open(path, O_RDONLY);
127 self->dwfl = dwfl_begin(&offline_callbacks);
131 self->mod = dwfl_report_offline(self->dwfl, "", "", fd);
135 self->dbg = dwfl_module_getdwarf(self->mod, &self->bias);
142 dwfl_end(self->dwfl);
145 memset(self, 0, sizeof(*self));
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 *self,
186 self->dwfl = dwfl_begin(&kernel_callbacks);
190 /* Load the kernel dwarves: Don't care the result here */
191 dwfl_linux_kernel_report_kernel(self->dwfl);
192 dwfl_linux_kernel_report_modules(self->dwfl);
194 self->dbg = dwfl_addrdwarf(self->dwfl, addr, &self->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);
199 dwfl_end(self->dwfl);
200 memset(self, 0, sizeof(*self));
207 /* With older elfutils, this just support kernel module... */
208 static int debuginfo__init_online_kernel_dwarf(struct debuginfo *self,
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(self, path);
223 struct debuginfo *debuginfo__new(const char *path)
225 struct debuginfo *self = zalloc(sizeof(struct debuginfo));
229 if (debuginfo__init_offline_dwarf(self, path) < 0) {
237 struct debuginfo *debuginfo__new_online_kernel(unsigned long addr)
239 struct debuginfo *self = zalloc(sizeof(struct debuginfo));
243 if (debuginfo__init_online_kernel_dwarf(self, (Dwarf_Addr)addr) < 0) {
251 void debuginfo__delete(struct debuginfo *self)
255 dwfl_end(self->dwfl);
261 * Probe finder related functions
264 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
266 struct probe_trace_arg_ref *ref;
267 ref = zalloc(sizeof(struct probe_trace_arg_ref));
274 * Convert a location into trace_arg.
275 * If tvar == NULL, this just checks variable can be converted.
277 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
279 struct probe_trace_arg *tvar)
281 Dwarf_Attribute attr;
290 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
293 /* TODO: handle more than 1 exprs */
294 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL ||
295 dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0 ||
297 /* TODO: Support const_value */
301 if (op->atom == DW_OP_addr) {
305 /* Static variables on memory (not stack), make @varname */
306 ret = strlen(dwarf_diename(vr_die));
307 tvar->value = zalloc(ret + 2);
308 if (tvar->value == NULL)
310 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
311 tvar->ref = alloc_trace_arg_ref((long)offs);
312 if (tvar->ref == NULL)
317 /* If this is based on frame buffer, set the offset */
318 if (op->atom == DW_OP_fbreg) {
326 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
327 regn = op->atom - DW_OP_breg0;
330 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
331 regn = op->atom - DW_OP_reg0;
332 } else if (op->atom == DW_OP_bregx) {
336 } else if (op->atom == DW_OP_regx) {
339 pr_debug("DW_OP %x is not supported.\n", op->atom);
346 regs = get_arch_regstr(regn);
348 /* This should be a bug in DWARF or this tool */
349 pr_warning("Mapping for the register number %u "
350 "missing on this architecture.\n", regn);
354 tvar->value = strdup(regs);
355 if (tvar->value == NULL)
359 tvar->ref = alloc_trace_arg_ref((long)offs);
360 if (tvar->ref == NULL)
366 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
368 static int convert_variable_type(Dwarf_Die *vr_die,
369 struct probe_trace_arg *tvar,
372 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
375 int bsize, boffs, total;
378 /* TODO: check all types */
379 if (cast && strcmp(cast, "string") != 0) {
380 /* Non string type is OK */
381 tvar->type = strdup(cast);
382 return (tvar->type == NULL) ? -ENOMEM : 0;
385 bsize = dwarf_bitsize(vr_die);
387 /* This is a bitfield */
388 boffs = dwarf_bitoffset(vr_die);
389 total = dwarf_bytesize(vr_die);
390 if (boffs < 0 || total < 0)
392 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
393 BYTES_TO_BITS(total));
397 if (die_get_real_type(vr_die, &type) == NULL) {
398 pr_warning("Failed to get a type information of %s.\n",
399 dwarf_diename(vr_die));
403 pr_debug("%s type is %s.\n",
404 dwarf_diename(vr_die), dwarf_diename(&type));
406 if (cast && strcmp(cast, "string") == 0) { /* String type */
407 ret = dwarf_tag(&type);
408 if (ret != DW_TAG_pointer_type &&
409 ret != DW_TAG_array_type) {
410 pr_warning("Failed to cast into string: "
411 "%s(%s) is not a pointer nor array.\n",
412 dwarf_diename(vr_die), dwarf_diename(&type));
415 if (die_get_real_type(&type, &type) == NULL) {
416 pr_warning("Failed to get a type"
420 if (ret == DW_TAG_pointer_type) {
422 ref_ptr = &(*ref_ptr)->next;
423 /* Add new reference with offset +0 */
424 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
425 if (*ref_ptr == NULL) {
426 pr_warning("Out of memory error\n");
430 if (!die_compare_name(&type, "char") &&
431 !die_compare_name(&type, "unsigned char")) {
432 pr_warning("Failed to cast into string: "
433 "%s is not (unsigned) char *.\n",
434 dwarf_diename(vr_die));
437 tvar->type = strdup(cast);
438 return (tvar->type == NULL) ? -ENOMEM : 0;
441 ret = dwarf_bytesize(&type);
443 /* No size ... try to use default type */
445 ret = BYTES_TO_BITS(ret);
447 /* Check the bitwidth */
448 if (ret > MAX_BASIC_TYPE_BITS) {
449 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
450 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
451 ret = MAX_BASIC_TYPE_BITS;
453 ret = snprintf(buf, 16, "%c%d",
454 die_is_signed_type(&type) ? 's' : 'u', ret);
457 if (ret < 0 || ret >= 16) {
460 pr_warning("Failed to convert variable type: %s\n",
464 tvar->type = strdup(buf);
465 if (tvar->type == NULL)
470 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
471 struct perf_probe_arg_field *field,
472 struct probe_trace_arg_ref **ref_ptr,
475 struct probe_trace_arg_ref *ref = *ref_ptr;
480 pr_debug("converting %s in %s\n", field->name, varname);
481 if (die_get_real_type(vr_die, &type) == NULL) {
482 pr_warning("Failed to get the type of %s.\n", varname);
485 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
486 tag = dwarf_tag(&type);
488 if (field->name[0] == '[' &&
489 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
491 /* Save original type for next field */
492 memcpy(die_mem, &type, sizeof(*die_mem));
493 /* Get the type of this array */
494 if (die_get_real_type(&type, &type) == NULL) {
495 pr_warning("Failed to get the type of %s.\n", varname);
498 pr_debug2("Array real type: (%x)\n",
499 (unsigned)dwarf_dieoffset(&type));
500 if (tag == DW_TAG_pointer_type) {
501 ref = zalloc(sizeof(struct probe_trace_arg_ref));
505 (*ref_ptr)->next = ref;
509 ref->offset += dwarf_bytesize(&type) * field->index;
511 /* Save vr_die for converting types */
512 memcpy(die_mem, vr_die, sizeof(*die_mem));
514 } else if (tag == DW_TAG_pointer_type) {
515 /* Check the pointer and dereference */
517 pr_err("Semantic error: %s must be referred by '->'\n",
521 /* Get the type pointed by this pointer */
522 if (die_get_real_type(&type, &type) == NULL) {
523 pr_warning("Failed to get the type of %s.\n", varname);
526 /* Verify it is a data structure */
527 tag = dwarf_tag(&type);
528 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
529 pr_warning("%s is not a data structure nor an union.\n",
534 ref = zalloc(sizeof(struct probe_trace_arg_ref));
538 (*ref_ptr)->next = ref;
542 /* Verify it is a data structure */
543 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
544 pr_warning("%s is not a data structure nor an union.\n",
548 if (field->name[0] == '[') {
549 pr_err("Semantic error: %s is not a pointor"
550 " nor array.\n", varname);
554 pr_err("Semantic error: %s must be referred by '.'\n",
559 pr_warning("Structure on a register is not "
565 if (die_find_member(&type, field->name, die_mem) == NULL) {
566 pr_warning("%s(tyep:%s) has no member %s.\n", varname,
567 dwarf_diename(&type), field->name);
571 /* Get the offset of the field */
572 if (tag == DW_TAG_union_type) {
575 ret = die_get_data_member_location(die_mem, &offs);
577 pr_warning("Failed to get the offset of %s.\n",
582 ref->offset += (long)offs;
585 /* Converting next field */
587 return convert_variable_fields(die_mem, field->name,
588 field->next, &ref, die_mem);
593 /* Show a variables in kprobe event format */
594 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
599 pr_debug("Converting variable %s into trace event.\n",
600 dwarf_diename(vr_die));
602 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
605 pr_err("Failed to find the location of %s at this address.\n"
606 " Perhaps, it has been optimized out.\n", pf->pvar->var);
607 else if (ret == -ENOTSUP)
608 pr_err("Sorry, we don't support this variable location yet.\n");
609 else if (pf->pvar->field) {
610 ret = convert_variable_fields(vr_die, pf->pvar->var,
611 pf->pvar->field, &pf->tvar->ref,
616 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
617 /* *expr will be cached in libdw. Don't free it. */
621 /* Find a variable in a scope DIE */
622 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
628 if (!is_c_varname(pf->pvar->var)) {
629 /* Copy raw parameters */
630 pf->tvar->value = strdup(pf->pvar->var);
631 if (pf->tvar->value == NULL)
633 if (pf->pvar->type) {
634 pf->tvar->type = strdup(pf->pvar->type);
635 if (pf->tvar->type == NULL)
638 if (pf->pvar->name) {
639 pf->tvar->name = strdup(pf->pvar->name);
640 if (pf->tvar->name == NULL)
643 pf->tvar->name = NULL;
648 pf->tvar->name = strdup(pf->pvar->name);
650 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
653 ptr = strchr(buf, ':'); /* Change type separator to _ */
656 pf->tvar->name = strdup(buf);
658 if (pf->tvar->name == NULL)
661 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
662 /* Search child die for local variables and parameters. */
663 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
664 /* Search again in global variables */
665 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var, 0, &vr_die))
669 ret = convert_variable(&vr_die, pf);
672 pr_warning("Failed to find '%s' in this function.\n",
677 /* Convert subprogram DIE to trace point */
678 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
679 Dwarf_Addr paddr, bool retprobe,
680 struct probe_trace_point *tp)
682 Dwarf_Addr eaddr, highaddr;
686 /* Verify the address is correct */
687 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
688 pr_warning("Failed to get entry address of %s\n",
689 dwarf_diename(sp_die));
692 if (dwarf_highpc(sp_die, &highaddr) != 0) {
693 pr_warning("Failed to get end address of %s\n",
694 dwarf_diename(sp_die));
697 if (paddr > highaddr) {
698 pr_warning("Offset specified is greater than size of %s\n",
699 dwarf_diename(sp_die));
703 /* Get an appropriate symbol from symtab */
704 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
706 pr_warning("Failed to find symbol at 0x%lx\n",
707 (unsigned long)paddr);
710 tp->offset = (unsigned long)(paddr - sym.st_value);
711 tp->symbol = strdup(symbol);
715 /* Return probe must be on the head of a subprogram */
717 if (eaddr != paddr) {
718 pr_warning("Return probe must be on the head of"
719 " a real function.\n");
728 /* Call probe_finder callback with scope DIE */
729 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
731 Dwarf_Attribute fb_attr;
736 pr_err("Caller must pass a scope DIE. Program error.\n");
740 /* If not a real subprogram, find a real one */
741 if (!die_is_func_def(sc_die)) {
742 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
743 pr_warning("Failed to find probe point in any "
748 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
750 /* Get the frame base attribute/ops from subprogram */
751 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
752 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
753 if (ret <= 0 || nops == 0) {
755 #if _ELFUTILS_PREREQ(0, 142)
756 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
759 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
760 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
761 pr_warning("Failed to get call frame on 0x%jx\n",
762 (uintmax_t)pf->addr);
768 /* Call finder's callback handler */
769 ret = pf->callback(sc_die, pf);
771 /* *pf->fb_ops will be cached in libdw. Don't free it. */
777 struct find_scope_param {
778 const char *function;
786 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
788 struct find_scope_param *fsp = data;
792 /* Skip if declared file name does not match */
794 file = dwarf_decl_file(fn_die);
795 if (!file || strcmp(fsp->file, file) != 0)
798 /* If the function name is given, that's what user expects */
800 if (die_compare_name(fn_die, fsp->function)) {
801 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
806 /* With the line number, find the nearest declared DIE */
807 dwarf_decl_line(fn_die, &lno);
808 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
809 /* Keep a candidate and continue */
810 fsp->diff = fsp->line - lno;
811 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
818 /* Find an appropriate scope fits to given conditions */
819 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
821 struct find_scope_param fsp = {
822 .function = pf->pev->point.function,
830 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
832 return fsp.found ? die_mem : NULL;
835 static int probe_point_line_walker(const char *fname, int lineno,
836 Dwarf_Addr addr, void *data)
838 struct probe_finder *pf = data;
839 Dwarf_Die *sc_die, die_mem;
842 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
846 sc_die = find_best_scope(pf, &die_mem);
848 pr_warning("Failed to find scope of probe point.\n");
852 ret = call_probe_finder(sc_die, pf);
854 /* Continue if no error, because the line will be in inline function */
855 return ret < 0 ? ret : 0;
858 /* Find probe point from its line number */
859 static int find_probe_point_by_line(struct probe_finder *pf)
861 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
864 /* Find lines which match lazy pattern */
865 static int find_lazy_match_lines(struct list_head *head,
866 const char *fname, const char *pat)
872 int count = 0, linenum = 1;
874 fp = fopen(fname, "r");
876 pr_warning("Failed to open %s: %s\n", fname, strerror(errno));
880 while ((len = getline(&line, &line_len, fp)) > 0) {
882 if (line[len - 1] == '\n')
883 line[len - 1] = '\0';
885 if (strlazymatch(line, pat)) {
886 line_list__add_line(head, linenum);
898 pr_debug("No matched lines found in %s.\n", fname);
902 static int probe_point_lazy_walker(const char *fname, int lineno,
903 Dwarf_Addr addr, void *data)
905 struct probe_finder *pf = data;
906 Dwarf_Die *sc_die, die_mem;
909 if (!line_list__has_line(&pf->lcache, lineno) ||
910 strtailcmp(fname, pf->fname) != 0)
913 pr_debug("Probe line found: line:%d addr:0x%llx\n",
914 lineno, (unsigned long long)addr);
917 sc_die = find_best_scope(pf, &die_mem);
919 pr_warning("Failed to find scope of probe point.\n");
923 ret = call_probe_finder(sc_die, pf);
926 * Continue if no error, because the lazy pattern will match
929 return ret < 0 ? ret : 0;
932 /* Find probe points from lazy pattern */
933 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
937 if (list_empty(&pf->lcache)) {
938 /* Matching lazy line pattern */
939 ret = find_lazy_match_lines(&pf->lcache, pf->fname,
940 pf->pev->point.lazy_line);
945 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
948 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
950 struct probe_finder *pf = data;
951 struct perf_probe_point *pp = &pf->pev->point;
956 ret = find_probe_point_lazy(in_die, pf);
958 /* Get probe address */
959 if (dwarf_entrypc(in_die, &addr) != 0) {
960 pr_warning("Failed to get entry address of %s.\n",
961 dwarf_diename(in_die));
965 pf->addr += pp->offset;
966 pr_debug("found inline addr: 0x%jx\n",
967 (uintmax_t)pf->addr);
969 ret = call_probe_finder(in_die, pf);
975 /* Callback parameter with return value for libdw */
976 struct dwarf_callback_param {
981 /* Search function from function name */
982 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
984 struct dwarf_callback_param *param = data;
985 struct probe_finder *pf = param->data;
986 struct perf_probe_point *pp = &pf->pev->point;
988 /* Check tag and diename */
989 if (!die_is_func_def(sp_die) ||
990 !die_compare_name(sp_die, pp->function))
993 /* Check declared file */
994 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
997 pf->fname = dwarf_decl_file(sp_die);
998 if (pp->line) { /* Function relative line */
999 dwarf_decl_line(sp_die, &pf->lno);
1000 pf->lno += pp->line;
1001 param->retval = find_probe_point_by_line(pf);
1002 } else if (!dwarf_func_inline(sp_die)) {
1005 param->retval = find_probe_point_lazy(sp_die, pf);
1007 if (dwarf_entrypc(sp_die, &pf->addr) != 0) {
1008 pr_warning("Failed to get entry address of "
1009 "%s.\n", dwarf_diename(sp_die));
1010 param->retval = -ENOENT;
1011 return DWARF_CB_ABORT;
1013 pf->addr += pp->offset;
1014 /* TODO: Check the address in this function */
1015 param->retval = call_probe_finder(sp_die, pf);
1018 /* Inlined function: search instances */
1019 param->retval = die_walk_instances(sp_die,
1020 probe_point_inline_cb, (void *)pf);
1022 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1025 static int find_probe_point_by_func(struct probe_finder *pf)
1027 struct dwarf_callback_param _param = {.data = (void *)pf,
1029 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
1030 return _param.retval;
1033 struct pubname_callback_param {
1041 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
1043 struct pubname_callback_param *param = data;
1045 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
1046 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1049 if (die_compare_name(param->sp_die, param->function)) {
1050 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1054 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1058 return DWARF_CB_ABORT;
1065 /* Find probe points from debuginfo */
1066 static int debuginfo__find_probes(struct debuginfo *self,
1067 struct probe_finder *pf)
1069 struct perf_probe_point *pp = &pf->pev->point;
1070 Dwarf_Off off, noff;
1075 #if _ELFUTILS_PREREQ(0, 142)
1076 /* Get the call frame information from this dwarf */
1077 pf->cfi = dwarf_getcfi(self->dbg);
1081 line_list__init(&pf->lcache);
1083 /* Fastpath: lookup by function name from .debug_pubnames section */
1085 struct pubname_callback_param pubname_param = {
1086 .function = pp->function,
1088 .cu_die = &pf->cu_die,
1089 .sp_die = &pf->sp_die,
1092 struct dwarf_callback_param probe_param = {
1096 dwarf_getpubnames(self->dbg, pubname_search_cb,
1098 if (pubname_param.found) {
1099 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1105 /* Loop on CUs (Compilation Unit) */
1106 while (!dwarf_nextcu(self->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1107 /* Get the DIE(Debugging Information Entry) of this CU */
1108 diep = dwarf_offdie(self->dbg, off + cuhl, &pf->cu_die);
1112 /* Check if target file is included. */
1114 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1118 if (!pp->file || pf->fname) {
1120 ret = find_probe_point_by_func(pf);
1121 else if (pp->lazy_line)
1122 ret = find_probe_point_lazy(NULL, pf);
1125 ret = find_probe_point_by_line(pf);
1134 line_list__free(&pf->lcache);
1139 /* Add a found probe point into trace event list */
1140 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1142 struct trace_event_finder *tf =
1143 container_of(pf, struct trace_event_finder, pf);
1144 struct probe_trace_event *tev;
1147 /* Check number of tevs */
1148 if (tf->ntevs == tf->max_tevs) {
1149 pr_warning("Too many( > %d) probe point found.\n",
1153 tev = &tf->tevs[tf->ntevs++];
1155 /* Trace point should be converted from subprogram DIE */
1156 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1157 pf->pev->point.retprobe, &tev->point);
1161 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1164 /* Find each argument */
1165 tev->nargs = pf->pev->nargs;
1166 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1167 if (tev->args == NULL)
1169 for (i = 0; i < pf->pev->nargs; i++) {
1170 pf->pvar = &pf->pev->args[i];
1171 pf->tvar = &tev->args[i];
1172 /* Variable should be found from scope DIE */
1173 ret = find_variable(sc_die, pf);
1181 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1182 int debuginfo__find_trace_events(struct debuginfo *self,
1183 struct perf_probe_event *pev,
1184 struct probe_trace_event **tevs, int max_tevs)
1186 struct trace_event_finder tf = {
1187 .pf = {.pev = pev, .callback = add_probe_trace_event},
1188 .mod = self->mod, .max_tevs = max_tevs};
1191 /* Allocate result tevs array */
1192 *tevs = zalloc(sizeof(struct probe_trace_event) * max_tevs);
1199 ret = debuginfo__find_probes(self, &tf.pf);
1206 return (ret < 0) ? ret : tf.ntevs;
1209 #define MAX_VAR_LEN 64
1211 /* Collect available variables in this scope */
1212 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1214 struct available_var_finder *af = data;
1215 struct variable_list *vl;
1216 char buf[MAX_VAR_LEN];
1219 vl = &af->vls[af->nvls - 1];
1221 tag = dwarf_tag(die_mem);
1222 if (tag == DW_TAG_formal_parameter ||
1223 tag == DW_TAG_variable) {
1224 ret = convert_variable_location(die_mem, af->pf.addr,
1225 af->pf.fb_ops, NULL);
1227 ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
1228 pr_debug2("Add new var: %s\n", buf);
1230 strlist__add(vl->vars, buf);
1234 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1235 return DIE_FIND_CB_CONTINUE;
1237 return DIE_FIND_CB_SIBLING;
1240 /* Add a found vars into available variables list */
1241 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1243 struct available_var_finder *af =
1244 container_of(pf, struct available_var_finder, pf);
1245 struct variable_list *vl;
1249 /* Check number of tevs */
1250 if (af->nvls == af->max_vls) {
1251 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1254 vl = &af->vls[af->nvls++];
1256 /* Trace point should be converted from subprogram DIE */
1257 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1258 pf->pev->point.retprobe, &vl->point);
1262 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1265 /* Find local variables */
1266 vl->vars = strlist__new(true, NULL);
1267 if (vl->vars == NULL)
1270 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1272 /* Find external variables */
1275 /* Don't need to search child DIE for externs. */
1277 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1280 if (strlist__empty(vl->vars)) {
1281 strlist__delete(vl->vars);
1288 /* Find available variables at given probe point */
1289 int debuginfo__find_available_vars_at(struct debuginfo *self,
1290 struct perf_probe_event *pev,
1291 struct variable_list **vls,
1292 int max_vls, bool externs)
1294 struct available_var_finder af = {
1295 .pf = {.pev = pev, .callback = add_available_vars},
1297 .max_vls = max_vls, .externs = externs};
1300 /* Allocate result vls array */
1301 *vls = zalloc(sizeof(struct variable_list) * max_vls);
1308 ret = debuginfo__find_probes(self, &af.pf);
1310 /* Free vlist for error */
1312 if (af.vls[af.nvls].point.symbol)
1313 free(af.vls[af.nvls].point.symbol);
1314 if (af.vls[af.nvls].vars)
1315 strlist__delete(af.vls[af.nvls].vars);
1322 return (ret < 0) ? ret : af.nvls;
1325 /* Reverse search */
1326 int debuginfo__find_probe_point(struct debuginfo *self, unsigned long addr,
1327 struct perf_probe_point *ppt)
1329 Dwarf_Die cudie, spdie, indie;
1330 Dwarf_Addr _addr = 0, baseaddr = 0;
1331 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1332 int baseline = 0, lineno = 0, ret = 0;
1334 /* Adjust address with bias */
1338 if (!dwarf_addrdie(self->dbg, (Dwarf_Addr)addr - self->bias, &cudie)) {
1339 pr_warning("Failed to find debug information for address %lx\n",
1345 /* Find a corresponding line (filename and lineno) */
1346 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1347 /* Don't care whether it failed or not */
1349 /* Find a corresponding function (name, baseline and baseaddr) */
1350 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1351 /* Get function entry information */
1352 func = basefunc = dwarf_diename(&spdie);
1354 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1355 dwarf_decl_line(&spdie, &baseline) != 0) {
1360 fname = dwarf_decl_file(&spdie);
1361 if (addr == (unsigned long)baseaddr) {
1362 /* Function entry - Relative line number is 0 */
1367 /* Track down the inline functions step by step */
1368 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1370 /* There is an inline function */
1371 if (dwarf_entrypc(&indie, &_addr) == 0 &&
1374 * addr is at an inline function entry.
1375 * In this case, lineno should be the call-site
1376 * line number. (overwrite lineinfo)
1378 lineno = die_get_call_lineno(&indie);
1379 fname = die_get_call_file(&indie);
1383 * addr is in an inline function body.
1384 * Since lineno points one of the lines
1385 * of the inline function, baseline should
1386 * be the entry line of the inline function.
1388 tmp = dwarf_diename(&indie);
1390 dwarf_decl_line(&indie, &baseline) != 0)
1396 /* Verify the lineno and baseline are in a same file */
1397 tmp = dwarf_decl_file(&spdie);
1398 if (!tmp || strcmp(tmp, fname) != 0)
1403 /* Make a relative line number or an offset */
1405 ppt->line = lineno - baseline;
1406 else if (basefunc) {
1407 ppt->offset = addr - (unsigned long)baseaddr;
1411 /* Duplicate strings */
1413 ppt->function = strdup(func);
1414 if (ppt->function == NULL) {
1420 ppt->file = strdup(fname);
1421 if (ppt->file == NULL) {
1422 if (ppt->function) {
1423 free(ppt->function);
1424 ppt->function = NULL;
1431 if (ret == 0 && (fname || func))
1432 ret = 1; /* Found a point */
1436 /* Add a line and store the src path */
1437 static int line_range_add_line(const char *src, unsigned int lineno,
1438 struct line_range *lr)
1440 /* Copy source path */
1442 lr->path = strdup(src);
1443 if (lr->path == NULL)
1446 return line_list__add_line(&lr->line_list, lineno);
1449 static int line_range_walk_cb(const char *fname, int lineno,
1450 Dwarf_Addr addr __maybe_unused,
1453 struct line_finder *lf = data;
1455 if ((strtailcmp(fname, lf->fname) != 0) ||
1456 (lf->lno_s > lineno || lf->lno_e < lineno))
1459 if (line_range_add_line(fname, lineno, lf->lr) < 0)
1465 /* Find line range from its line number */
1466 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1470 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1474 if (!list_empty(&lf->lr->line_list))
1475 ret = lf->found = 1;
1477 ret = 0; /* Lines are not found */
1480 lf->lr->path = NULL;
1485 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1487 find_line_range_by_line(in_die, data);
1490 * We have to check all instances of inlined function, because
1491 * some execution paths can be optimized out depends on the
1492 * function argument of instances
1497 /* Search function definition from function name */
1498 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1500 struct dwarf_callback_param *param = data;
1501 struct line_finder *lf = param->data;
1502 struct line_range *lr = lf->lr;
1504 /* Check declared file */
1505 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1508 if (die_is_func_def(sp_die) &&
1509 die_compare_name(sp_die, lr->function)) {
1510 lf->fname = dwarf_decl_file(sp_die);
1511 dwarf_decl_line(sp_die, &lr->offset);
1512 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1513 lf->lno_s = lr->offset + lr->start;
1514 if (lf->lno_s < 0) /* Overflow */
1515 lf->lno_s = INT_MAX;
1516 lf->lno_e = lr->offset + lr->end;
1517 if (lf->lno_e < 0) /* Overflow */
1518 lf->lno_e = INT_MAX;
1519 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1520 lr->start = lf->lno_s;
1521 lr->end = lf->lno_e;
1522 if (dwarf_func_inline(sp_die))
1523 param->retval = die_walk_instances(sp_die,
1524 line_range_inline_cb, lf);
1526 param->retval = find_line_range_by_line(sp_die, lf);
1527 return DWARF_CB_ABORT;
1532 static int find_line_range_by_func(struct line_finder *lf)
1534 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1535 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, ¶m, 0);
1536 return param.retval;
1539 int debuginfo__find_line_range(struct debuginfo *self, struct line_range *lr)
1541 struct line_finder lf = {.lr = lr, .found = 0};
1543 Dwarf_Off off = 0, noff;
1546 const char *comp_dir;
1548 /* Fastpath: lookup by function name from .debug_pubnames section */
1550 struct pubname_callback_param pubname_param = {
1551 .function = lr->function, .file = lr->file,
1552 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1553 struct dwarf_callback_param line_range_param = {
1554 .data = (void *)&lf, .retval = 0};
1556 dwarf_getpubnames(self->dbg, pubname_search_cb,
1558 if (pubname_param.found) {
1559 line_range_search_cb(&lf.sp_die, &line_range_param);
1565 /* Loop on CUs (Compilation Unit) */
1566 while (!lf.found && ret >= 0) {
1567 if (dwarf_nextcu(self->dbg, off, &noff, &cuhl,
1568 NULL, NULL, NULL) != 0)
1571 /* Get the DIE(Debugging Information Entry) of this CU */
1572 diep = dwarf_offdie(self->dbg, off + cuhl, &lf.cu_die);
1576 /* Check if target file is included. */
1578 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1582 if (!lr->file || lf.fname) {
1584 ret = find_line_range_by_func(&lf);
1586 lf.lno_s = lr->start;
1588 ret = find_line_range_by_line(NULL, &lf);
1595 /* Store comp_dir */
1597 comp_dir = cu_get_comp_dir(&lf.cu_die);
1599 lr->comp_dir = strdup(comp_dir);
1605 pr_debug("path: %s\n", lr->path);
1606 return (ret < 0) ? ret : lf.found;