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