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