1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef _PROBE_EVENT_H
  3#define _PROBE_EVENT_H
  4
  5#include <linux/compiler.h>
  6#include <stdbool.h>
 
 
  7
  8struct intlist;
  9struct nsinfo;
 10
 11/* Probe related configurations */
 12struct probe_conf {
 13	bool	show_ext_vars;
 14	bool	show_location_range;
 15	bool	force_add;
 16	bool	no_inlines;
 17	bool	cache;
 18	int	max_probes;
 19};
 20extern struct probe_conf probe_conf;
 21extern bool probe_event_dry_run;
 22
 23struct symbol;
 24
 25/* kprobe-tracer and uprobe-tracer tracing point */
 26struct probe_trace_point {
 27	char		*realname;	/* function real name (if needed) */
 28	char		*symbol;	/* Base symbol */
 29	char		*module;	/* Module name */
 30	unsigned long	offset;		/* Offset from symbol */
 31	unsigned long	ref_ctr_offset;	/* SDT reference counter offset */
 32	unsigned long	address;	/* Actual address of the trace point */
 33	bool		retprobe;	/* Return probe flag */
 34};
 35
 36/* probe-tracer tracing argument referencing offset */
 37struct probe_trace_arg_ref {
 38	struct probe_trace_arg_ref	*next;	/* Next reference */
 39	long				offset;	/* Offset value */
 40	bool				user_access;	/* User-memory access */
 41};
 42
 43/* kprobe-tracer and uprobe-tracer tracing argument */
 44struct probe_trace_arg {
 45	char				*name;	/* Argument name */
 46	char				*value;	/* Base value */
 47	char				*type;	/* Type name */
 48	struct probe_trace_arg_ref	*ref;	/* Referencing offset */
 49};
 50
 51/* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
 52struct probe_trace_event {
 53	char				*event;	/* Event name */
 54	char				*group;	/* Group name */
 55	struct probe_trace_point	point;	/* Trace point */
 56	int				nargs;	/* Number of args */
 57	bool				uprobes;	/* uprobes only */
 58	struct probe_trace_arg		*args;	/* Arguments */
 59};
 60
 61/* Perf probe probing point */
 62struct perf_probe_point {
 63	char		*file;		/* File path */
 64	char		*function;	/* Function name */
 65	int		line;		/* Line number */
 66	bool		retprobe;	/* Return probe flag */
 67	char		*lazy_line;	/* Lazy matching pattern */
 68	unsigned long	offset;		/* Offset from function entry */
 69	unsigned long	abs_address;	/* Absolute address of the point */
 70};
 71
 72/* Perf probe probing argument field chain */
 73struct perf_probe_arg_field {
 74	struct perf_probe_arg_field	*next;	/* Next field */
 75	char				*name;	/* Name of the field */
 76	long				index;	/* Array index number */
 77	bool				ref;	/* Referencing flag */
 78};
 79
 80/* Perf probe probing argument */
 81struct perf_probe_arg {
 82	char				*name;	/* Argument name */
 83	char				*var;	/* Variable name */
 84	char				*type;	/* Type name */
 85	struct perf_probe_arg_field	*field;	/* Structure fields */
 86	bool				user_access;	/* User-memory access */
 87};
 88
 89/* Perf probe probing event (point + arg) */
 90struct perf_probe_event {
 91	char			*event;	/* Event name */
 92	char			*group;	/* Group name */
 93	struct perf_probe_point	point;	/* Probe point */
 94	int			nargs;	/* Number of arguments */
 95	bool			sdt;	/* SDT/cached event flag */
 96	bool			uprobes;	/* Uprobe event flag */
 97	char			*target;	/* Target binary */
 98	struct perf_probe_arg	*args;	/* Arguments */
 99	struct probe_trace_event *tevs;
100	int			ntevs;
101	struct nsinfo		*nsi;	/* Target namespace */
 
 
 
 
102};
103
104/* Line range */
105struct line_range {
106	char			*file;		/* File name */
107	char			*function;	/* Function name */
108	int			start;		/* Start line number */
109	int			end;		/* End line number */
110	int			offset;		/* Start line offset */
111	char			*path;		/* Real path name */
112	char			*comp_dir;	/* Compile directory */
113	struct intlist		*line_list;	/* Visible lines */
114};
115
116struct strlist;
117
118/* List of variables */
119struct variable_list {
120	struct probe_trace_point	point;	/* Actual probepoint */
121	struct strlist			*vars;	/* Available variables */
122};
123
124struct map;
125int init_probe_symbol_maps(bool user_only);
126void exit_probe_symbol_maps(void);
127
128/* Command string to events */
129int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev);
130int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev);
131
132/* Events to command string */
133char *synthesize_perf_probe_command(struct perf_probe_event *pev);
134char *synthesize_probe_trace_command(struct probe_trace_event *tev);
135char *synthesize_perf_probe_arg(struct perf_probe_arg *pa);
136char *synthesize_perf_probe_point(struct perf_probe_point *pp);
137
138int perf_probe_event__copy(struct perf_probe_event *dst,
139			   struct perf_probe_event *src);
140
141bool perf_probe_with_var(struct perf_probe_event *pev);
142
143/* Check the perf_probe_event needs debuginfo */
144bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
145
146/* Release event contents */
147void clear_perf_probe_event(struct perf_probe_event *pev);
148void clear_probe_trace_event(struct probe_trace_event *tev);
149
150/* Command string to line-range */
151int parse_line_range_desc(const char *cmd, struct line_range *lr);
152
153/* Release line range members */
154void line_range__clear(struct line_range *lr);
155
156/* Initialize line range */
157int line_range__init(struct line_range *lr);
158
159int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
160int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs);
161int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs);
162int show_probe_trace_events(struct perf_probe_event *pevs, int npevs);
163void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs);
164
165struct strfilter;
166
167int del_perf_probe_events(struct strfilter *filter);
168
169int show_perf_probe_event(const char *group, const char *event,
170			  struct perf_probe_event *pev,
171			  const char *module, bool use_stdout);
172int show_perf_probe_events(struct strfilter *filter);
173int show_line_range(struct line_range *lr, const char *module,
174		    struct nsinfo *nsi, bool user);
175int show_available_vars(struct perf_probe_event *pevs, int npevs,
176			struct strfilter *filter);
177int show_available_funcs(const char *module, struct nsinfo *nsi,
178			 struct strfilter *filter, bool user);
179void arch__fix_tev_from_maps(struct perf_probe_event *pev,
180			     struct probe_trace_event *tev, struct map *map,
181			     struct symbol *sym);
182
183/* If there is no space to write, returns -E2BIG. */
184int e_snprintf(char *str, size_t size, const char *format, ...) __printf(3, 4);
 
 
 
 
 
 
 
 
 
185
186/* Maximum index number of event-name postfix */
187#define MAX_EVENT_INDEX	1024
188
189int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
190			    struct perf_probe_arg *pvar);
191
192struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user);
193
194void arch__post_process_probe_trace_events(struct perf_probe_event *pev,
195					   int ntevs);
196
197#endif /*_PROBE_EVENT_H */

 
  1#ifndef _PROBE_EVENT_H
  2#define _PROBE_EVENT_H
  3
 
  4#include <stdbool.h>
  5#include "strlist.h"
  6#include "strfilter.h"
  7
 
 
 
 
 
 
 
 
 
 
 
 
 
  8extern bool probe_event_dry_run;
  9
 
 
 10/* kprobe-tracer and uprobe-tracer tracing point */
 11struct probe_trace_point {
 
 12	char		*symbol;	/* Base symbol */
 13	char		*module;	/* Module name */
 14	unsigned long	offset;		/* Offset from symbol */
 
 
 15	bool		retprobe;	/* Return probe flag */
 16};
 17
 18/* probe-tracer tracing argument referencing offset */
 19struct probe_trace_arg_ref {
 20	struct probe_trace_arg_ref	*next;	/* Next reference */
 21	long				offset;	/* Offset value */
 
 22};
 23
 24/* kprobe-tracer and uprobe-tracer tracing argument */
 25struct probe_trace_arg {
 26	char				*name;	/* Argument name */
 27	char				*value;	/* Base value */
 28	char				*type;	/* Type name */
 29	struct probe_trace_arg_ref	*ref;	/* Referencing offset */
 30};
 31
 32/* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
 33struct probe_trace_event {
 34	char				*event;	/* Event name */
 35	char				*group;	/* Group name */
 36	struct probe_trace_point	point;	/* Trace point */
 37	int				nargs;	/* Number of args */
 38	bool				uprobes;	/* uprobes only */
 39	struct probe_trace_arg		*args;	/* Arguments */
 40};
 41
 42/* Perf probe probing point */
 43struct perf_probe_point {
 44	char		*file;		/* File path */
 45	char		*function;	/* Function name */
 46	int		line;		/* Line number */
 47	bool		retprobe;	/* Return probe flag */
 48	char		*lazy_line;	/* Lazy matching pattern */
 49	unsigned long	offset;		/* Offset from function entry */
 
 50};
 51
 52/* Perf probe probing argument field chain */
 53struct perf_probe_arg_field {
 54	struct perf_probe_arg_field	*next;	/* Next field */
 55	char				*name;	/* Name of the field */
 56	long				index;	/* Array index number */
 57	bool				ref;	/* Referencing flag */
 58};
 59
 60/* Perf probe probing argument */
 61struct perf_probe_arg {
 62	char				*name;	/* Argument name */
 63	char				*var;	/* Variable name */
 64	char				*type;	/* Type name */
 65	struct perf_probe_arg_field	*field;	/* Structure fields */
 
 66};
 67
 68/* Perf probe probing event (point + arg) */
 69struct perf_probe_event {
 70	char			*event;	/* Event name */
 71	char			*group;	/* Group name */
 72	struct perf_probe_point	point;	/* Probe point */
 73	int			nargs;	/* Number of arguments */
 74	bool			uprobes;
 
 
 75	struct perf_probe_arg	*args;	/* Arguments */
 76};
 77
 78
 79/* Line number container */
 80struct line_node {
 81	struct list_head	list;
 82	int			line;
 83};
 84
 85/* Line range */
 86struct line_range {
 87	char			*file;		/* File name */
 88	char			*function;	/* Function name */
 89	int			start;		/* Start line number */
 90	int			end;		/* End line number */
 91	int			offset;		/* Start line offset */
 92	char			*path;		/* Real path name */
 93	char			*comp_dir;	/* Compile directory */
 94	struct list_head	line_list;	/* Visible lines */
 95};
 96
 
 
 97/* List of variables */
 98struct variable_list {
 99	struct probe_trace_point	point;	/* Actual probepoint */
100	struct strlist			*vars;	/* Available variables */
101};
102
 
 
 
 
103/* Command string to events */
104extern int parse_perf_probe_command(const char *cmd,
105				    struct perf_probe_event *pev);
106
107/* Events to command string */
108extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
109extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
110extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
111				     size_t len);
 
 
 
 
 
112
113/* Check the perf_probe_event needs debuginfo */
114extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
115
116/* Release event contents */
117extern void clear_perf_probe_event(struct perf_probe_event *pev);
 
118
119/* Command string to line-range */
120extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
 
 
 
 
 
 
121
122/* Internal use: Return kernel/module path */
123extern const char *kernel_get_module_path(const char *module);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
124
125extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
126				 int max_probe_points, const char *module,
127				 bool force_add);
128extern int del_perf_probe_events(struct strlist *dellist);
129extern int show_perf_probe_events(void);
130extern int show_line_range(struct line_range *lr, const char *module);
131extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
132			       int max_probe_points, const char *module,
133			       struct strfilter *filter, bool externs);
134extern int show_available_funcs(const char *module, struct strfilter *filter,
135				bool user);
136
137/* Maximum index number of event-name postfix */
138#define MAX_EVENT_INDEX	1024
 
 
 
 
 
 
 
 
139
140#endif /*_PROBE_EVENT_H */