[mirror_ubuntu-zesty-kernel.git] / tools / perf / util / probe-event.h

#ifndef _PROBE_EVENT_H
#define _PROBE_EVENT_H

#include <stdbool.h>
#include "strlist.h"

extern bool probe_event_dry_run;

/* kprobe-tracer tracing point */
struct kprobe_trace_point {
	char		*symbol;	/* Base symbol */
	unsigned long	offset;		/* Offset from symbol */
	bool		retprobe;	/* Return probe flag */
};

/* kprobe-tracer tracing argument referencing offset */
struct kprobe_trace_arg_ref {
	struct kprobe_trace_arg_ref	*next;	/* Next reference */
	long				offset;	/* Offset value */
};

/* kprobe-tracer tracing argument */
struct kprobe_trace_arg {
	char				*name;	/* Argument name */
	char				*value;	/* Base value */
	char				*type;	/* Type name */
	struct kprobe_trace_arg_ref	*ref;	/* Referencing offset */
};

/* kprobe-tracer tracing event (point + arg) */
struct kprobe_trace_event {
	char				*event;	/* Event name */
	char				*group;	/* Group name */
	struct kprobe_trace_point	point;	/* Trace point */
	int				nargs;	/* Number of args */
	struct kprobe_trace_arg		*args;	/* Arguments */
};

/* Perf probe probing point */
struct perf_probe_point {
	char		*file;		/* File path */
	char		*function;	/* Function name */
	int		line;		/* Line number */
	bool		retprobe;	/* Return probe flag */
	char		*lazy_line;	/* Lazy matching pattern */
	unsigned long	offset;		/* Offset from function entry */
};

/* Perf probe probing argument field chain */
struct perf_probe_arg_field {
	struct perf_probe_arg_field	*next;	/* Next field */
	char				*name;	/* Name of the field */
	bool				ref;	/* Referencing flag */
};

/* Perf probe probing argument */
struct perf_probe_arg {
	char				*name;	/* Argument name */
	char				*var;	/* Variable name */
	char				*type;	/* Type name */
	struct perf_probe_arg_field	*field;	/* Structure fields */
};

/* Perf probe probing event (point + arg) */
struct perf_probe_event {
	char			*event;	/* Event name */
	char			*group;	/* Group name */
	struct perf_probe_point	point;	/* Probe point */
	int			nargs;	/* Number of arguments */
	struct perf_probe_arg	*args;	/* Arguments */
};


/* Line number container */
struct line_node {
	struct list_head	list;
	int			line;
};

/* Line range */
struct line_range {
	char			*file;		/* File name */
	char			*function;	/* Function name */
	int			start;		/* Start line number */
	int			end;		/* End line number */
	int			offset;		/* Start line offset */
	char			*path;		/* Real path name */
	struct list_head	line_list;	/* Visible lines */
};

/* Command string to events */
extern int parse_perf_probe_command(const char *cmd,
				    struct perf_probe_event *pev);
extern int parse_kprobe_trace_command(const char *cmd,
				      struct kprobe_trace_event *tev);

/* Events to command string */
extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
extern char *synthesize_kprobe_trace_command(struct kprobe_trace_event *tev);
extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
				     size_t len);

/* Check the perf_probe_event needs debuginfo */
extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);

/* Convert from kprobe_trace_event to perf_probe_event */
extern int convert_to_perf_probe_event(struct kprobe_trace_event *tev,
				       struct perf_probe_event *pev);

/* Release event contents */
extern void clear_perf_probe_event(struct perf_probe_event *pev);
extern void clear_kprobe_trace_event(struct kprobe_trace_event *tev);

/* Command string to line-range */
extern int parse_line_range_desc(const char *cmd, struct line_range *lr);


extern int add_perf_probe_events(struct perf_probe_event *pevs, int ntevs,
				 bool force_add);
extern int del_perf_probe_events(struct strlist *dellist);
extern int show_perf_probe_events(void);
extern int show_line_range(struct line_range *lr);


/* Maximum index number of event-name postfix */
#define MAX_EVENT_INDEX	1024

#endif /*_PROBE_EVENT_H */
Commit	Line	Data
50656eec MH	1	#ifndef _PROBE_EVENT_H
	2	#define _PROBE_EVENT_H
	3
fac13fd5	4	#include <stdbool.h>
4de189fe	5	#include "strlist.h"
50656eec	6
f4d7da49 MH	7	extern bool probe_event_dry_run;
f4d7da49 MH	8
4235b045 MH	9	/* kprobe-tracer tracing point */
	10	struct kprobe_trace_point {
	11	char symbol; / Base symbol */
	12	unsigned long offset; /* Offset from symbol */
	13	bool retprobe; /* Return probe flag */
	14	};
	15
	16	/* kprobe-tracer tracing argument referencing offset */
	17	struct kprobe_trace_arg_ref {
	18	struct kprobe_trace_arg_ref next; / Next reference */
	19	long offset; /* Offset value */
	20	};
	21
	22	/* kprobe-tracer tracing argument */
	23	struct kprobe_trace_arg {
	24	char name; / Argument name */
	25	char value; / Base value */
4984912e	26	char type; / Type name */
4235b045 MH	27	struct kprobe_trace_arg_ref ref; / Referencing offset */
	28	};
	29
	30	/* kprobe-tracer tracing event (point + arg) */
	31	struct kprobe_trace_event {
	32	char event; / Event name */
	33	char group; / Group name */
	34	struct kprobe_trace_point point; /* Trace point */
	35	int nargs; /* Number of args */
	36	struct kprobe_trace_arg args; / Arguments */
	37	};
	38
	39	/* Perf probe probing point */
	40	struct perf_probe_point {
	41	char file; / File path */
	42	char function; / Function name */
	43	int line; /* Line number */
eed05fe7	44	bool retprobe; /* Return probe flag */
4235b045 MH	45	char lazy_line; / Lazy matching pattern */
4235b045 MH	46	unsigned long offset; /* Offset from function entry */
4235b045 MH	47	};
4235b045 MH	48
7df2f329 MH	49	/* Perf probe probing argument field chain */
	50	struct perf_probe_arg_field {
	51	struct perf_probe_arg_field next; / Next field */
	52	char name; / Name of the field */
	53	bool ref; /* Referencing flag */
	54	};
	55
4235b045 MH	56	/* Perf probe probing argument */
4235b045 MH	57	struct perf_probe_arg {
7df2f329	58	char name; / Argument name */
48481938	59	char var; / Variable name */
11a1ca35	60	char type; / Type name */
7df2f329	61	struct perf_probe_arg_field field; / Structure fields */
4235b045 MH	62	};
	63
	64	/* Perf probe probing event (point + arg) */
	65	struct perf_probe_event {
	66	char event; / Event name */
	67	char group; / Group name */
	68	struct perf_probe_point point; /* Probe point */
	69	int nargs; /* Number of arguments */
	70	struct perf_probe_arg args; / Arguments */
	71	};
	72
	73
	74	/* Line number container */
	75	struct line_node {
	76	struct list_head list;
d3b63d7a	77	int line;
4235b045 MH	78	};
	79
	80	/* Line range */
	81	struct line_range {
	82	char file; / File name */
	83	char function; / Function name */
d3b63d7a MH	84	int start; /* Start line number */
d3b63d7a MH	85	int end; /* End line number */
4235b045 MH	86	int offset; /* Start line offset */
	87	char path; / Real path name */
	88	struct list_head line_list; /* Visible lines */
	89	};
	90
	91	/* Command string to events */
146a1439 MH	92	extern int parse_perf_probe_command(const char *cmd,
	93	struct perf_probe_event *pev);
	94	extern int parse_kprobe_trace_command(const char *cmd,
	95	struct kprobe_trace_event *tev);
4235b045 MH	96
	97	/* Events to command string */
	98	extern char synthesize_perf_probe_command(struct perf_probe_event pev);
	99	extern char synthesize_kprobe_trace_command(struct kprobe_trace_event tev);
7df2f329 MH	100	extern int synthesize_perf_probe_arg(struct perf_probe_arg pa, char buf,
7df2f329 MH	101	size_t len);
4235b045 MH	102
	103	/* Check the perf_probe_event needs debuginfo */
	104	extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
	105
	106	/* Convert from kprobe_trace_event to perf_probe_event */
146a1439 MH	107	extern int convert_to_perf_probe_event(struct kprobe_trace_event *tev,
146a1439 MH	108	struct perf_probe_event *pev);
4235b045 MH	109
	110	/* Release event contents */
	111	extern void clear_perf_probe_event(struct perf_probe_event *pev);
	112	extern void clear_kprobe_trace_event(struct kprobe_trace_event *tev);
	113
	114	/* Command string to line-range */
146a1439	115	extern int parse_line_range_desc(const char cmd, struct line_range lr);
4235b045 MH	116
4235b045 MH	117
146a1439 MH	118	extern int add_perf_probe_events(struct perf_probe_event *pevs, int ntevs,
	119	bool force_add);
	120	extern int del_perf_probe_events(struct strlist *dellist);
	121	extern int show_perf_probe_events(void);
	122	extern int show_line_range(struct line_range *lr);
50656eec	123
4235b045	124
b498ce1f MH	125	/* Maximum index number of event-name postfix */
	126	#define MAX_EVENT_INDEX 1024
	127
50656eec	128	#endif /_PROBE_EVENT_H /