1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef _PROBE_FINDER_H
3*4882a593Smuzhiyun #define _PROBE_FINDER_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include <stdbool.h>
6*4882a593Smuzhiyun #include "intlist.h"
7*4882a593Smuzhiyun #include "build-id.h"
8*4882a593Smuzhiyun #include "probe-event.h"
9*4882a593Smuzhiyun #include <linux/ctype.h>
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #define MAX_PROBE_BUFFER 1024
12*4882a593Smuzhiyun #define MAX_PROBES 128
13*4882a593Smuzhiyun #define MAX_PROBE_ARGS 128
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #define PROBE_ARG_VARS "$vars"
16*4882a593Smuzhiyun #define PROBE_ARG_PARAMS "$params"
17*4882a593Smuzhiyun
is_c_varname(const char * name)18*4882a593Smuzhiyun static inline int is_c_varname(const char *name)
19*4882a593Smuzhiyun {
20*4882a593Smuzhiyun /* TODO */
21*4882a593Smuzhiyun return isalpha(name[0]) || name[0] == '_';
22*4882a593Smuzhiyun }
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun #ifdef HAVE_DWARF_SUPPORT
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #include "dwarf-aux.h"
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun /* TODO: export debuginfo data structure even if no dwarf support */
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun /* debug information structure */
31*4882a593Smuzhiyun struct debuginfo {
32*4882a593Smuzhiyun Dwarf *dbg;
33*4882a593Smuzhiyun Dwfl_Module *mod;
34*4882a593Smuzhiyun Dwfl *dwfl;
35*4882a593Smuzhiyun Dwarf_Addr bias;
36*4882a593Smuzhiyun const unsigned char *build_id;
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun /* This also tries to open distro debuginfo */
40*4882a593Smuzhiyun struct debuginfo *debuginfo__new(const char *path);
41*4882a593Smuzhiyun void debuginfo__delete(struct debuginfo *dbg);
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /* Find probe_trace_events specified by perf_probe_event from debuginfo */
44*4882a593Smuzhiyun int debuginfo__find_trace_events(struct debuginfo *dbg,
45*4882a593Smuzhiyun struct perf_probe_event *pev,
46*4882a593Smuzhiyun struct probe_trace_event **tevs);
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun /* Find a perf_probe_point from debuginfo */
49*4882a593Smuzhiyun int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
50*4882a593Smuzhiyun struct perf_probe_point *ppt);
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs,
53*4882a593Smuzhiyun bool adjust_offset);
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun /* Find a line range */
56*4882a593Smuzhiyun int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr);
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun /* Find available variables */
59*4882a593Smuzhiyun int debuginfo__find_available_vars_at(struct debuginfo *dbg,
60*4882a593Smuzhiyun struct perf_probe_event *pev,
61*4882a593Smuzhiyun struct variable_list **vls);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun /* Find a src file from a DWARF tag path */
64*4882a593Smuzhiyun int find_source_path(const char *raw_path, const char *sbuild_id,
65*4882a593Smuzhiyun const char *comp_dir, char **new_path);
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun struct probe_finder {
68*4882a593Smuzhiyun struct perf_probe_event *pev; /* Target probe event */
69*4882a593Smuzhiyun struct debuginfo *dbg;
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun /* Callback when a probe point is found */
72*4882a593Smuzhiyun int (*callback)(Dwarf_Die *sc_die, struct probe_finder *pf);
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun /* For function searching */
75*4882a593Smuzhiyun int lno; /* Line number */
76*4882a593Smuzhiyun Dwarf_Addr addr; /* Address */
77*4882a593Smuzhiyun const char *fname; /* Real file name */
78*4882a593Smuzhiyun Dwarf_Die cu_die; /* Current CU */
79*4882a593Smuzhiyun Dwarf_Die sp_die;
80*4882a593Smuzhiyun struct intlist *lcache; /* Line cache for lazy match */
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun /* For variable searching */
83*4882a593Smuzhiyun #if _ELFUTILS_PREREQ(0, 142)
84*4882a593Smuzhiyun /* Call Frame Information from .eh_frame */
85*4882a593Smuzhiyun Dwarf_CFI *cfi_eh;
86*4882a593Smuzhiyun /* Call Frame Information from .debug_frame */
87*4882a593Smuzhiyun Dwarf_CFI *cfi_dbg;
88*4882a593Smuzhiyun #endif
89*4882a593Smuzhiyun Dwarf_Op *fb_ops; /* Frame base attribute */
90*4882a593Smuzhiyun unsigned int machine; /* Target machine arch */
91*4882a593Smuzhiyun struct perf_probe_arg *pvar; /* Current target variable */
92*4882a593Smuzhiyun struct probe_trace_arg *tvar; /* Current result variable */
93*4882a593Smuzhiyun bool skip_empty_arg; /* Skip non-exist args */
94*4882a593Smuzhiyun };
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun struct trace_event_finder {
97*4882a593Smuzhiyun struct probe_finder pf;
98*4882a593Smuzhiyun Dwfl_Module *mod; /* For solving symbols */
99*4882a593Smuzhiyun struct probe_trace_event *tevs; /* Found trace events */
100*4882a593Smuzhiyun int ntevs; /* Number of trace events */
101*4882a593Smuzhiyun int max_tevs; /* Max number of trace events */
102*4882a593Smuzhiyun };
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun struct available_var_finder {
105*4882a593Smuzhiyun struct probe_finder pf;
106*4882a593Smuzhiyun Dwfl_Module *mod; /* For solving symbols */
107*4882a593Smuzhiyun struct variable_list *vls; /* Found variable lists */
108*4882a593Smuzhiyun int nvls; /* Number of variable lists */
109*4882a593Smuzhiyun int max_vls; /* Max no. of variable lists */
110*4882a593Smuzhiyun bool child; /* Search child scopes */
111*4882a593Smuzhiyun };
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun struct line_finder {
114*4882a593Smuzhiyun struct line_range *lr; /* Target line range */
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun const char *fname; /* File name */
117*4882a593Smuzhiyun int lno_s; /* Start line number */
118*4882a593Smuzhiyun int lno_e; /* End line number */
119*4882a593Smuzhiyun Dwarf_Die cu_die; /* Current CU */
120*4882a593Smuzhiyun Dwarf_Die sp_die;
121*4882a593Smuzhiyun int found;
122*4882a593Smuzhiyun };
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun #endif /* HAVE_DWARF_SUPPORT */
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun #endif /*_PROBE_FINDER_H */
127