[mirror_ubuntu-artful-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 */
	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 */
	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;
	unsigned int		line;
};

/* Line range */
struct line_range {
	char			*file;		/* File name */
	char			*function;	/* Function name */
	unsigned int		start;		/* Start line number */
	unsigned 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 void parse_perf_probe_command(const char *cmd,
				     struct perf_probe_event *pev);
extern void 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 void 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 void parse_line_range_desc(const char *cmd, struct line_range *lr);


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