xref: /openbmc/linux/tools/perf/util/probe-finder.h (revision 2c684d89)
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 
45 /* Find a perf_probe_point from debuginfo */
46 extern int debuginfo__find_probe_point(struct debuginfo *dbg,
47 				       unsigned long addr,
48 				       struct perf_probe_point *ppt);
49 
50 /* Find a line range */
51 extern int debuginfo__find_line_range(struct debuginfo *dbg,
52 				      struct line_range *lr);
53 
54 /* Find available variables */
55 extern int debuginfo__find_available_vars_at(struct debuginfo *dbg,
56 					     struct perf_probe_event *pev,
57 					     struct variable_list **vls);
58 
59 /* Find a src file from a DWARF tag path */
60 int get_real_path(const char *raw_path, const char *comp_dir,
61 			 char **new_path);
62 
63 struct probe_finder {
64 	struct perf_probe_event	*pev;		/* Target probe event */
65 
66 	/* Callback when a probe point is found */
67 	int (*callback)(Dwarf_Die *sc_die, struct probe_finder *pf);
68 
69 	/* For function searching */
70 	int			lno;		/* Line number */
71 	Dwarf_Addr		addr;		/* Address */
72 	const char		*fname;		/* Real file name */
73 	Dwarf_Die		cu_die;		/* Current CU */
74 	Dwarf_Die		sp_die;
75 	struct intlist		*lcache;	/* Line cache for lazy match */
76 
77 	/* For variable searching */
78 #if _ELFUTILS_PREREQ(0, 142)
79 	Dwarf_CFI		*cfi;		/* Call Frame Information */
80 #endif
81 	Dwarf_Op		*fb_ops;	/* Frame base attribute */
82 	struct perf_probe_arg	*pvar;		/* Current target variable */
83 	struct probe_trace_arg	*tvar;		/* Current result variable */
84 };
85 
86 struct trace_event_finder {
87 	struct probe_finder	pf;
88 	Dwfl_Module		*mod;		/* For solving symbols */
89 	struct probe_trace_event *tevs;		/* Found trace events */
90 	int			ntevs;		/* Number of trace events */
91 	int			max_tevs;	/* Max number of trace events */
92 };
93 
94 struct available_var_finder {
95 	struct probe_finder	pf;
96 	Dwfl_Module		*mod;		/* For solving symbols */
97 	struct variable_list	*vls;		/* Found variable lists */
98 	int			nvls;		/* Number of variable lists */
99 	int			max_vls;	/* Max no. of variable lists */
100 	bool			child;		/* Search child scopes */
101 };
102 
103 struct line_finder {
104 	struct line_range	*lr;		/* Target line range */
105 
106 	const char		*fname;		/* File name */
107 	int			lno_s;		/* Start line number */
108 	int			lno_e;		/* End line number */
109 	Dwarf_Die		cu_die;		/* Current CU */
110 	Dwarf_Die		sp_die;
111 	int			found;
112 };
113 
114 #endif /* HAVE_DWARF_SUPPORT */
115 
116 #endif /*_PROBE_FINDER_H */
117