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