[deliverable/linux.git] / include / linux / ftrace_event.h

#ifndef _LINUX_FTRACE_EVENT_H
#define _LINUX_FTRACE_EVENT_H

#include <linux/ring_buffer.h>
#include <linux/trace_seq.h>
#include <linux/percpu.h>
#include <linux/hardirq.h>
#include <linux/perf_event.h>

struct trace_array;
struct trace_buffer;
struct tracer;
struct dentry;

struct trace_print_flags {
	unsigned long		mask;
	const char		*name;
};

struct trace_print_flags_u64 {
	unsigned long long	mask;
	const char		*name;
};

const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
				   unsigned long flags,
				   const struct trace_print_flags *flag_array);

const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
				     const struct trace_print_flags *symbol_array);

#if BITS_PER_LONG == 32
const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
					 unsigned long long val,
					 const struct trace_print_flags_u64
								 *symbol_array);
#endif

const char *ftrace_print_hex_seq(struct trace_seq *p,
				 const unsigned char *buf, int len);

struct trace_iterator;
struct trace_event;

int ftrace_raw_output_prep(struct trace_iterator *iter,
			   struct trace_event *event);

/*
 * The trace entry - the most basic unit of tracing. This is what
 * is printed in the end as a single line in the trace output, such as:
 *
 *     bash-15816 [01]   235.197585: idle_cpu <- irq_enter
 */
struct trace_entry {
	unsigned short		type;
	unsigned char		flags;
	unsigned char		preempt_count;
	int			pid;
};

#define FTRACE_MAX_EVENT						\
	((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)

/*
 * Trace iterator - used by printout routines who present trace
 * results to users and which routines might sleep, etc:
 */
struct trace_iterator {
	struct trace_array	*tr;
	struct tracer		*trace;
	struct trace_buffer	*trace_buffer;
	void			*private;
	int			cpu_file;
	struct mutex		mutex;
	struct ring_buffer_iter	**buffer_iter;
	unsigned long		iter_flags;

	/* trace_seq for __print_flags() and __print_symbolic() etc. */
	struct trace_seq	tmp_seq;

	cpumask_var_t		started;

	/* it's true when current open file is snapshot */
	bool			snapshot;

	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	struct trace_entry	*ent;
	unsigned long		lost_events;
	int			leftover;
	int			ent_size;
	int			cpu;
	u64			ts;

	loff_t			pos;
	long			idx;

	/* All new field here will be zeroed out in pipe_read */
};

enum trace_iter_flags {
	TRACE_FILE_LAT_FMT	= 1,
	TRACE_FILE_ANNOTATE	= 2,
	TRACE_FILE_TIME_IN_NS	= 4,
};


typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
				      int flags, struct trace_event *event);

struct trace_event_functions {
	trace_print_func	trace;
	trace_print_func	raw;
	trace_print_func	hex;
	trace_print_func	binary;
};

struct trace_event {
	struct hlist_node		node;
	struct list_head		list;
	int				type;
	struct trace_event_functions	*funcs;
};

extern int register_ftrace_event(struct trace_event *event);
extern int unregister_ftrace_event(struct trace_event *event);

/* Return values for print_line callback */
enum print_line_t {
	TRACE_TYPE_PARTIAL_LINE	= 0,	/* Retry after flushing the seq */
	TRACE_TYPE_HANDLED	= 1,
	TRACE_TYPE_UNHANDLED	= 2,	/* Relay to other output functions */
	TRACE_TYPE_NO_CONSUME	= 3	/* Handled but ask to not consume */
};

void tracing_generic_entry_update(struct trace_entry *entry,
				  unsigned long flags,
				  int pc);
struct ftrace_event_file;

struct ring_buffer_event *
trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer,
				struct ftrace_event_file *ftrace_file,
				int type, unsigned long len,
				unsigned long flags, int pc);
struct ring_buffer_event *
trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
				  int type, unsigned long len,
				  unsigned long flags, int pc);
void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
					struct ring_buffer_event *event,
					unsigned long flags, int pc);
void trace_buffer_unlock_commit(struct ring_buffer *buffer,
				struct ring_buffer_event *event,
				unsigned long flags, int pc);
void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
				     struct ring_buffer_event *event,
				     unsigned long flags, int pc,
				     struct pt_regs *regs);
void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
					 struct ring_buffer_event *event);

void tracing_record_cmdline(struct task_struct *tsk);

struct event_filter;

enum trace_reg {
	TRACE_REG_REGISTER,
	TRACE_REG_UNREGISTER,
#ifdef CONFIG_PERF_EVENTS
	TRACE_REG_PERF_REGISTER,
	TRACE_REG_PERF_UNREGISTER,
	TRACE_REG_PERF_OPEN,
	TRACE_REG_PERF_CLOSE,
	TRACE_REG_PERF_ADD,
	TRACE_REG_PERF_DEL,
#endif
};

struct ftrace_event_call;

struct ftrace_event_class {
	char			*system;
	void			*probe;
#ifdef CONFIG_PERF_EVENTS
	void			*perf_probe;
#endif
	int			(*reg)(struct ftrace_event_call *event,
				       enum trace_reg type, void *data);
	int			(*define_fields)(struct ftrace_event_call *);
	struct list_head	*(*get_fields)(struct ftrace_event_call *);
	struct list_head	fields;
	int			(*raw_init)(struct ftrace_event_call *);
};

extern int ftrace_event_reg(struct ftrace_event_call *event,
			    enum trace_reg type, void *data);

enum {
	TRACE_EVENT_FL_FILTERED_BIT,
	TRACE_EVENT_FL_CAP_ANY_BIT,
	TRACE_EVENT_FL_NO_SET_FILTER_BIT,
	TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
	TRACE_EVENT_FL_WAS_ENABLED_BIT,
	TRACE_EVENT_FL_USE_CALL_FILTER_BIT,
};

/*
 * Event flags:
 *  FILTERED	  - The event has a filter attached
 *  CAP_ANY	  - Any user can enable for perf
 *  NO_SET_FILTER - Set when filter has error and is to be ignored
 *  IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file
 *  WAS_ENABLED   - Set and stays set when an event was ever enabled
 *                    (used for module unloading, if a module event is enabled,
 *                     it is best to clear the buffers that used it).
 *  USE_CALL_FILTER - For ftrace internal events, don't use file filter
 */
enum {
	TRACE_EVENT_FL_FILTERED		= (1 << TRACE_EVENT_FL_FILTERED_BIT),
	TRACE_EVENT_FL_CAP_ANY		= (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
	TRACE_EVENT_FL_NO_SET_FILTER	= (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
	TRACE_EVENT_FL_IGNORE_ENABLE	= (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
	TRACE_EVENT_FL_WAS_ENABLED	= (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT),
	TRACE_EVENT_FL_USE_CALL_FILTER	= (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT),
};

struct ftrace_event_call {
	struct list_head	list;
	struct ftrace_event_class *class;
	char			*name;
	struct trace_event	event;
	const char		*print_fmt;
	struct event_filter	*filter;
	struct list_head	*files;
	void			*mod;
	void			*data;
	/*
	 *   bit 0:		filter_active
	 *   bit 1:		allow trace by non root (cap any)
	 *   bit 2:		failed to apply filter
	 *   bit 3:		ftrace internal event (do not enable)
	 *   bit 4:		Event was enabled by module
	 *   bit 5:		use call filter rather than file filter
	 */
	int			flags; /* static flags of different events */

#ifdef CONFIG_PERF_EVENTS
	int				perf_refcount;
	struct hlist_head __percpu	*perf_events;

	int	(*perf_perm)(struct ftrace_event_call *,
			     struct perf_event *);
#endif
};

struct trace_array;
struct ftrace_subsystem_dir;

enum {
	FTRACE_EVENT_FL_ENABLED_BIT,
	FTRACE_EVENT_FL_RECORDED_CMD_BIT,
	FTRACE_EVENT_FL_FILTERED_BIT,
	FTRACE_EVENT_FL_NO_SET_FILTER_BIT,
	FTRACE_EVENT_FL_SOFT_MODE_BIT,
	FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
};

/*
 * Ftrace event file flags:
 *  ENABLED	  - The event is enabled
 *  RECORDED_CMD  - The comms should be recorded at sched_switch
 *  FILTERED	  - The event has a filter attached
 *  NO_SET_FILTER - Set when filter has error and is to be ignored
 *  SOFT_MODE     - The event is enabled/disabled by SOFT_DISABLED
 *  SOFT_DISABLED - When set, do not trace the event (even though its
 *                   tracepoint may be enabled)
 */
enum {
	FTRACE_EVENT_FL_ENABLED		= (1 << FTRACE_EVENT_FL_ENABLED_BIT),
	FTRACE_EVENT_FL_RECORDED_CMD	= (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
	FTRACE_EVENT_FL_FILTERED	= (1 << FTRACE_EVENT_FL_FILTERED_BIT),
	FTRACE_EVENT_FL_NO_SET_FILTER	= (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT),
	FTRACE_EVENT_FL_SOFT_MODE	= (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT),
	FTRACE_EVENT_FL_SOFT_DISABLED	= (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT),
};

struct ftrace_event_file {
	struct list_head		list;
	struct ftrace_event_call	*event_call;
	struct event_filter		*filter;
	struct dentry			*dir;
	struct trace_array		*tr;
	struct ftrace_subsystem_dir	*system;

	/*
	 * 32 bit flags:
	 *   bit 0:		enabled
	 *   bit 1:		enabled cmd record
	 *   bit 2:		enable/disable with the soft disable bit
	 *   bit 3:		soft disabled
	 *
	 * Note: The bits must be set atomically to prevent races
	 * from other writers. Reads of flags do not need to be in
	 * sync as they occur in critical sections. But the way flags
	 * is currently used, these changes do not affect the code
	 * except that when a change is made, it may have a slight
	 * delay in propagating the changes to other CPUs due to
	 * caching and such. Which is mostly OK ;-)
	 */
	unsigned long		flags;
	atomic_t		sm_ref;	/* soft-mode reference counter */
};

#define __TRACE_EVENT_FLAGS(name, value)				\
	static int __init trace_init_flags_##name(void)			\
	{								\
		event_##name.flags = value;				\
		return 0;						\
	}								\
	early_initcall(trace_init_flags_##name);

#define __TRACE_EVENT_PERF_PERM(name, expr...)				\
	static int perf_perm_##name(struct ftrace_event_call *tp_event, \
				    struct perf_event *p_event)		\
	{								\
		return ({ expr; });					\
	}								\
	static int __init trace_init_perf_perm_##name(void)		\
	{								\
		event_##name.perf_perm = &perf_perm_##name;		\
		return 0;						\
	}								\
	early_initcall(trace_init_perf_perm_##name);

#define PERF_MAX_TRACE_SIZE	2048

#define MAX_FILTER_STR_VAL	256	/* Should handle KSYM_SYMBOL_LEN */

extern void destroy_preds(struct ftrace_event_file *file);
extern void destroy_call_preds(struct ftrace_event_call *call);
extern int filter_match_preds(struct event_filter *filter, void *rec);

extern int filter_check_discard(struct ftrace_event_file *file, void *rec,
				struct ring_buffer *buffer,
				struct ring_buffer_event *event);
extern int call_filter_check_discard(struct ftrace_event_call *call, void *rec,
				     struct ring_buffer *buffer,
				     struct ring_buffer_event *event);

enum {
	FILTER_OTHER = 0,
	FILTER_STATIC_STRING,
	FILTER_DYN_STRING,
	FILTER_PTR_STRING,
	FILTER_TRACE_FN,
};

#define EVENT_STORAGE_SIZE 128
extern struct mutex event_storage_mutex;
extern char event_storage[EVENT_STORAGE_SIZE];

extern int trace_event_raw_init(struct ftrace_event_call *call);
extern int trace_define_field(struct ftrace_event_call *call, const char *type,
			      const char *name, int offset, int size,
			      int is_signed, int filter_type);
extern int trace_add_event_call(struct ftrace_event_call *call);
extern int trace_remove_event_call(struct ftrace_event_call *call);

#define is_signed_type(type)	(((type)(-1)) < (type)1)

int trace_set_clr_event(const char *system, const char *event, int set);

/*
 * The double __builtin_constant_p is because gcc will give us an error
 * if we try to allocate the static variable to fmt if it is not a
 * constant. Even with the outer if statement optimizing out.
 */
#define event_trace_printk(ip, fmt, args...)				\
do {									\
	__trace_printk_check_format(fmt, ##args);			\
	tracing_record_cmdline(current);				\
	if (__builtin_constant_p(fmt)) {				\
		static const char *trace_printk_fmt			\
		  __attribute__((section("__trace_printk_fmt"))) =	\
			__builtin_constant_p(fmt) ? fmt : NULL;		\
									\
		__trace_bprintk(ip, trace_printk_fmt, ##args);		\
	} else								\
		__trace_printk(ip, fmt, ##args);			\
} while (0)

/**
 * tracepoint_string - register constant persistent string to trace system
 * @str - a constant persistent string that will be referenced in tracepoints
 *
 * If constant strings are being used in tracepoints, it is faster and
 * more efficient to just save the pointer to the string and reference
 * that with a printf "%s" instead of saving the string in the ring buffer
 * and wasting space and time.
 *
 * The problem with the above approach is that userspace tools that read
 * the binary output of the trace buffers do not have access to the string.
 * Instead they just show the address of the string which is not very
 * useful to users.
 *
 * With tracepoint_string(), the string will be registered to the tracing
 * system and exported to userspace via the debugfs/tracing/printk_formats
 * file that maps the string address to the string text. This way userspace
 * tools that read the binary buffers have a way to map the pointers to
 * the ASCII strings they represent.
 *
 * The @str used must be a constant string and persistent as it would not
 * make sense to show a string that no longer exists. But it is still fine
 * to be used with modules, because when modules are unloaded, if they
 * had tracepoints, the ring buffers are cleared too. As long as the string
 * does not change during the life of the module, it is fine to use
 * tracepoint_string() within a module.
 */
#define tracepoint_string(str)						\
	({								\
		static const char *___tp_str __tracepoint_string = str; \
		___tp_str;						\
	})
#define __tracepoint_string	__attribute__((section("__tracepoint_str")))

#ifdef CONFIG_PERF_EVENTS
struct perf_event;

DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);

extern int  perf_trace_init(struct perf_event *event);
extern void perf_trace_destroy(struct perf_event *event);
extern int  perf_trace_add(struct perf_event *event, int flags);
extern void perf_trace_del(struct perf_event *event, int flags);
extern int  ftrace_profile_set_filter(struct perf_event *event, int event_id,
				     char *filter_str);
extern void ftrace_profile_free_filter(struct perf_event *event);
extern void *perf_trace_buf_prepare(int size, unsigned short type,
				    struct pt_regs *regs, int *rctxp);

static inline void
perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
		       u64 count, struct pt_regs *regs, void *head,
		       struct task_struct *task)
{
	perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
}
#endif

#endif /* _LINUX_FTRACE_EVENT_H */
Commit	Line	Data
97f20251 SR	1	#ifndef _LINUX_FTRACE_EVENT_H
	2	#define _LINUX_FTRACE_EVENT_H
	3
97f20251	4	#include <linux/ring_buffer.h>
16bb8eb1	5	#include <linux/trace_seq.h>
be74b73a	6	#include <linux/percpu.h>
20ab4425	7	#include <linux/hardirq.h>
430ad5a6	8	#include <linux/perf_event.h>
97f20251 SR	9
97f20251 SR	10	struct trace_array;
12883efb	11	struct trace_buffer;
97f20251	12	struct tracer;
6d723736	13	struct dentry;
97f20251	14
be74b73a SR	15	struct trace_print_flags {
	16	unsigned long mask;
	17	const char *name;
	18	};
	19
2fc1b6f0	20	struct trace_print_flags_u64 {
	21	unsigned long long mask;
	22	const char *name;
	23	};
	24
be74b73a SR	25	const char ftrace_print_flags_seq(struct trace_seq p, const char *delim,
	26	unsigned long flags,
	27	const struct trace_print_flags *flag_array);
	28
0f4fc29d SR	29	const char ftrace_print_symbols_seq(struct trace_seq p, unsigned long val,
	30	const struct trace_print_flags *symbol_array);
	31
2fc1b6f0	32	#if BITS_PER_LONG == 32
	33	const char ftrace_print_symbols_seq_u64(struct trace_seq p,
	34	unsigned long long val,
	35	const struct trace_print_flags_u64
	36	*symbol_array);
	37	#endif
	38
5a2e3995 KT	39	const char ftrace_print_hex_seq(struct trace_seq p,
	40	const unsigned char *buf, int len);
	41
f71130de LZ	42	struct trace_iterator;
	43	struct trace_event;
	44
	45	int ftrace_raw_output_prep(struct trace_iterator *iter,
	46	struct trace_event *event);
	47
97f20251 SR	48	/*
	49	* The trace entry - the most basic unit of tracing. This is what
	50	* is printed in the end as a single line in the trace output, such as:
	51	*
	52	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	53	*/
	54	struct trace_entry {
89ec0dee	55	unsigned short type;
97f20251 SR	56	unsigned char flags;
	57	unsigned char preempt_count;
	58	int pid;
97f20251 SR	59	};
97f20251 SR	60
89ec0dee SR	61	#define FTRACE_MAX_EVENT \
	62	((1 << (sizeof(((struct trace_entry )0)->type) 8)) - 1)
	63
97f20251 SR	64	/*
	65	* Trace iterator - used by printout routines who present trace
	66	* results to users and which routines might sleep, etc:
	67	*/
	68	struct trace_iterator {
	69	struct trace_array *tr;
	70	struct tracer *trace;
12883efb	71	struct trace_buffer *trace_buffer;
97f20251 SR	72	void *private;
	73	int cpu_file;
	74	struct mutex mutex;
6d158a81	75	struct ring_buffer_iter **buffer_iter;
112f38a7	76	unsigned long iter_flags;
97f20251	77
bc289ae9 LJ	78	/* trace_seq for __print_flags() and __print_symbolic() etc. */
	79	struct trace_seq tmp_seq;
	80
ed5467da AV	81	cpumask_var_t started;
	82
	83	/* it's true when current open file is snapshot */
	84	bool snapshot;
	85
97f20251 SR	86	/* The below is zeroed out in pipe_read */
	87	struct trace_seq seq;
	88	struct trace_entry *ent;
bc21b478	89	unsigned long lost_events;
a63ce5b3	90	int leftover;
4a9bd3f1	91	int ent_size;
97f20251 SR	92	int cpu;
	93	u64 ts;
	94
97f20251 SR	95	loff_t pos;
	96	long idx;
	97
ed5467da	98	/* All new field here will be zeroed out in pipe_read */
97f20251 SR	99	};
97f20251 SR	100
8be0709f DS	101	enum trace_iter_flags {
	102	TRACE_FILE_LAT_FMT = 1,
	103	TRACE_FILE_ANNOTATE = 2,
	104	TRACE_FILE_TIME_IN_NS = 4,
	105	};
	106
97f20251 SR	107
97f20251 SR	108	typedef enum print_line_t (trace_print_func)(struct trace_iterator iter,
a9a57763 SR	109	int flags, struct trace_event *event);
	110
	111	struct trace_event_functions {
97f20251 SR	112	trace_print_func trace;
	113	trace_print_func raw;
	114	trace_print_func hex;
	115	trace_print_func binary;
	116	};
	117
a9a57763 SR	118	struct trace_event {
	119	struct hlist_node node;
	120	struct list_head list;
	121	int type;
	122	struct trace_event_functions *funcs;
	123	};
	124
97f20251 SR	125	extern int register_ftrace_event(struct trace_event *event);
	126	extern int unregister_ftrace_event(struct trace_event *event);
	127
	128	/* Return values for print_line callback */
	129	enum print_line_t {
	130	TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
	131	TRACE_TYPE_HANDLED = 1,
	132	TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
	133	TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
	134	};
	135
f413cdb8 FW	136	void tracing_generic_entry_update(struct trace_entry *entry,
	137	unsigned long flags,
	138	int pc);
ccb469a1 SR	139	struct ftrace_event_file;
	140
	141	struct ring_buffer_event *
	142	trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer,
	143	struct ftrace_event_file *ftrace_file,
	144	int type, unsigned long len,
	145	unsigned long flags, int pc);
97f20251	146	struct ring_buffer_event *
e77405ad SR	147	trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
e77405ad SR	148	int type, unsigned long len,
97f20251	149	unsigned long flags, int pc);
e77405ad SR	150	void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
e77405ad SR	151	struct ring_buffer_event *event,
97f20251	152	unsigned long flags, int pc);
0d5c6e1c SR	153	void trace_buffer_unlock_commit(struct ring_buffer *buffer,
	154	struct ring_buffer_event *event,
	155	unsigned long flags, int pc);
	156	void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
	157	struct ring_buffer_event *event,
	158	unsigned long flags, int pc,
	159	struct pt_regs *regs);
e77405ad SR	160	void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
e77405ad SR	161	struct ring_buffer_event *event);
97f20251 SR	162
	163	void tracing_record_cmdline(struct task_struct *tsk);
	164
1f9963cb LZ	165	struct event_filter;
1f9963cb LZ	166
2239291a SR	167	enum trace_reg {
	168	TRACE_REG_REGISTER,
	169	TRACE_REG_UNREGISTER,
37d73998	170	#ifdef CONFIG_PERF_EVENTS
2239291a SR	171	TRACE_REG_PERF_REGISTER,
2239291a SR	172	TRACE_REG_PERF_UNREGISTER,
ceec0b6f JO	173	TRACE_REG_PERF_OPEN,
ceec0b6f JO	174	TRACE_REG_PERF_CLOSE,
489c75c3 JO	175	TRACE_REG_PERF_ADD,
489c75c3 JO	176	TRACE_REG_PERF_DEL,
37d73998	177	#endif
2239291a SR	178	};
	179
	180	struct ftrace_event_call;
	181
8f082018 SR	182	struct ftrace_event_class {
8f082018 SR	183	char *system;
2239291a SR	184	void *probe;
	185	#ifdef CONFIG_PERF_EVENTS
	186	void *perf_probe;
	187	#endif
	188	int (reg)(struct ftrace_event_call event,
ceec0b6f	189	enum trace_reg type, void *data);
2e33af02 SR	190	int (define_fields)(struct ftrace_event_call );
	191	struct list_head (get_fields)(struct ftrace_event_call *);
	192	struct list_head fields;
0405ab80	193	int (raw_init)(struct ftrace_event_call );
8f082018 SR	194	};
8f082018 SR	195
a1d0ce82	196	extern int ftrace_event_reg(struct ftrace_event_call *event,
ceec0b6f	197	enum trace_reg type, void *data);
a1d0ce82	198
553552ce	199	enum {
553552ce	200	TRACE_EVENT_FL_FILTERED_BIT,
61c32659	201	TRACE_EVENT_FL_CAP_ANY_BIT,
27b14b56	202	TRACE_EVENT_FL_NO_SET_FILTER_BIT,
9b63776f	203	TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
575380da	204	TRACE_EVENT_FL_WAS_ENABLED_BIT,
f306cc82	205	TRACE_EVENT_FL_USE_CALL_FILTER_BIT,
553552ce SR	206	};
553552ce SR	207
ae63b31e SR	208	/*
	209	* Event flags:
	210	* FILTERED - The event has a filter attached
	211	* CAP_ANY - Any user can enable for perf
	212	* NO_SET_FILTER - Set when filter has error and is to be ignored
2a30c11f	213	* IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file
575380da SRRH	214	* WAS_ENABLED - Set and stays set when an event was ever enabled
	215	* (used for module unloading, if a module event is enabled,
	216	* it is best to clear the buffers that used it).
f306cc82	217	* USE_CALL_FILTER - For ftrace internal events, don't use file filter
ae63b31e	218	*/
553552ce	219	enum {
e870e9a1	220	TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
61c32659	221	TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
27b14b56	222	TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
9b63776f	223	TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
575380da	224	TRACE_EVENT_FL_WAS_ENABLED = (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT),
f306cc82	225	TRACE_EVENT_FL_USE_CALL_FILTER = (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT),
553552ce SR	226	};
553552ce SR	227
97f20251	228	struct ftrace_event_call {
a59fd602	229	struct list_head list;
8f082018	230	struct ftrace_event_class *class;
97f20251	231	char *name;
80decc70	232	struct trace_event event;
509e760c	233	const char *print_fmt;
1f9963cb	234	struct event_filter *filter;
ae63b31e	235	struct list_head *files;
6d723736	236	void *mod;
69fd4f0e	237	void *data;
57d01ad0 SRRH	238	/*
	239	* bit 0: filter_active
	240	* bit 1: allow trace by non root (cap any)
	241	* bit 2: failed to apply filter
	242	* bit 3: ftrace internal event (do not enable)
	243	* bit 4: Event was enabled by module
f306cc82	244	* bit 5: use call filter rather than file filter
57d01ad0	245	*/
ae63b31e SR	246	int flags; /* static flags of different events */
	247
	248	#ifdef CONFIG_PERF_EVENTS
	249	int perf_refcount;
	250	struct hlist_head __percpu *perf_events;
d5b5f391 PZ	251
	252	int (perf_perm)(struct ftrace_event_call ,
	253	struct perf_event *);
ae63b31e SR	254	#endif
	255	};
	256
	257	struct trace_array;
	258	struct ftrace_subsystem_dir;
	259
	260	enum {
	261	FTRACE_EVENT_FL_ENABLED_BIT,
	262	FTRACE_EVENT_FL_RECORDED_CMD_BIT,
f306cc82 TZ	263	FTRACE_EVENT_FL_FILTERED_BIT,
f306cc82 TZ	264	FTRACE_EVENT_FL_NO_SET_FILTER_BIT,
417944c4 SRRH	265	FTRACE_EVENT_FL_SOFT_MODE_BIT,
417944c4 SRRH	266	FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
ae63b31e SR	267	};
	268
	269	/*
	270	* Ftrace event file flags:
57d01ad0	271	* ENABLED - The event is enabled
ae63b31e	272	* RECORDED_CMD - The comms should be recorded at sched_switch
f306cc82 TZ	273	* FILTERED - The event has a filter attached
f306cc82 TZ	274	* NO_SET_FILTER - Set when filter has error and is to be ignored
417944c4 SRRH	275	* SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED
	276	* SOFT_DISABLED - When set, do not trace the event (even though its
	277	* tracepoint may be enabled)
ae63b31e SR	278	*/
	279	enum {
	280	FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT),
	281	FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
f306cc82 TZ	282	FTRACE_EVENT_FL_FILTERED = (1 << FTRACE_EVENT_FL_FILTERED_BIT),
f306cc82 TZ	283	FTRACE_EVENT_FL_NO_SET_FILTER = (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT),
417944c4 SRRH	284	FTRACE_EVENT_FL_SOFT_MODE = (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT),
417944c4 SRRH	285	FTRACE_EVENT_FL_SOFT_DISABLED = (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT),
ae63b31e SR	286	};
	287
	288	struct ftrace_event_file {
	289	struct list_head list;
	290	struct ftrace_event_call *event_call;
f306cc82	291	struct event_filter *filter;
ae63b31e SR	292	struct dentry *dir;
	293	struct trace_array *tr;
	294	struct ftrace_subsystem_dir *system;
97f20251	295
553552ce SR	296	/*
553552ce SR	297	* 32 bit flags:
57d01ad0 SRRH	298	* bit 0: enabled
57d01ad0 SRRH	299	* bit 1: enabled cmd record
417944c4 SRRH	300	* bit 2: enable/disable with the soft disable bit
417944c4 SRRH	301	* bit 3: soft disabled
553552ce	302	*
417944c4 SRRH	303	* Note: The bits must be set atomically to prevent races
	304	* from other writers. Reads of flags do not need to be in
	305	* sync as they occur in critical sections. But the way flags
ae63b31e	306	* is currently used, these changes do not affect the code
1eaa4787 SR	307	* except that when a change is made, it may have a slight
1eaa4787 SR	308	* delay in propagating the changes to other CPUs due to
417944c4	309	* caching and such. Which is mostly OK ;-)
553552ce	310	*/
417944c4	311	unsigned long flags;
1cf4c073	312	atomic_t sm_ref; /* soft-mode reference counter */
97f20251 SR	313	};
97f20251 SR	314
53cf810b FW	315	#define __TRACE_EVENT_FLAGS(name, value) \
	316	static int __init trace_init_flags_##name(void) \
	317	{ \
	318	event_##name.flags = value; \
	319	return 0; \
	320	} \
	321	early_initcall(trace_init_flags_##name);
	322
d5b5f391 PZ	323	#define __TRACE_EVENT_PERF_PERM(name, expr...) \
	324	static int perf_perm_##name(struct ftrace_event_call *tp_event, \
	325	struct perf_event *p_event) \
	326	{ \
	327	return ({ expr; }); \
	328	} \
	329	static int __init trace_init_perf_perm_##name(void) \
	330	{ \
	331	event_##name.perf_perm = &perf_perm_##name; \
	332	return 0; \
	333	} \
	334	early_initcall(trace_init_perf_perm_##name);
	335
97d5a220	336	#define PERF_MAX_TRACE_SIZE 2048
20ab4425	337
16bb8eb1	338	#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
97f20251	339
f306cc82 TZ	340	extern void destroy_preds(struct ftrace_event_file *file);
f306cc82 TZ	341	extern void destroy_call_preds(struct ftrace_event_call *call);
6fb2915d	342	extern int filter_match_preds(struct event_filter filter, void rec);
f306cc82 TZ	343
	344	extern int filter_check_discard(struct ftrace_event_file file, void rec,
	345	struct ring_buffer *buffer,
	346	struct ring_buffer_event *event);
	347	extern int call_filter_check_discard(struct ftrace_event_call call, void rec,
	348	struct ring_buffer *buffer,
	349	struct ring_buffer_event *event);
97f20251	350
43b51ead LZ	351	enum {
	352	FILTER_OTHER = 0,
	353	FILTER_STATIC_STRING,
	354	FILTER_DYN_STRING,
87a342f5	355	FILTER_PTR_STRING,
02aa3162	356	FILTER_TRACE_FN,
43b51ead LZ	357	};
43b51ead LZ	358
04295780 SR	359	#define EVENT_STORAGE_SIZE 128
	360	extern struct mutex event_storage_mutex;
	361	extern char event_storage[EVENT_STORAGE_SIZE];
	362
87d9b4e1	363	extern int trace_event_raw_init(struct ftrace_event_call *call);
aeaeae11 FW	364	extern int trace_define_field(struct ftrace_event_call call, const char type,
	365	const char *name, int offset, int size,
	366	int is_signed, int filter_type);
bd1a5c84	367	extern int trace_add_event_call(struct ftrace_event_call *call);
2816c551	368	extern int trace_remove_event_call(struct ftrace_event_call *call);
97f20251	369
d2802d07	370	#define is_signed_type(type) (((type)(-1)) < (type)1)
97f20251	371
4671c794 SR	372	int trace_set_clr_event(const char system, const char event, int set);
4671c794 SR	373
97f20251 SR	374	/*
	375	* The double __builtin_constant_p is because gcc will give us an error
	376	* if we try to allocate the static variable to fmt if it is not a
	377	* constant. Even with the outer if statement optimizing out.
	378	*/
	379	#define event_trace_printk(ip, fmt, args...) \
	380	do { \
	381	__trace_printk_check_format(fmt, ##args); \
	382	tracing_record_cmdline(current); \
	383	if (__builtin_constant_p(fmt)) { \
	384	static const char *trace_printk_fmt \
	385	__attribute__((section("__trace_printk_fmt"))) = \
	386	__builtin_constant_p(fmt) ? fmt : NULL; \
	387	\
	388	__trace_bprintk(ip, trace_printk_fmt, ##args); \
	389	} else \
	390	__trace_printk(ip, fmt, ##args); \
	391	} while (0)
	392
102c9323 SRRH	393	/**
	394	* tracepoint_string - register constant persistent string to trace system
	395	* @str - a constant persistent string that will be referenced in tracepoints
	396	*
	397	* If constant strings are being used in tracepoints, it is faster and
	398	* more efficient to just save the pointer to the string and reference
	399	* that with a printf "%s" instead of saving the string in the ring buffer
	400	* and wasting space and time.
	401	*
	402	* The problem with the above approach is that userspace tools that read
	403	* the binary output of the trace buffers do not have access to the string.
	404	* Instead they just show the address of the string which is not very
	405	* useful to users.
	406	*
	407	* With tracepoint_string(), the string will be registered to the tracing
	408	* system and exported to userspace via the debugfs/tracing/printk_formats
	409	* file that maps the string address to the string text. This way userspace
	410	* tools that read the binary buffers have a way to map the pointers to
	411	* the ASCII strings they represent.
	412	*
	413	* The @str used must be a constant string and persistent as it would not
	414	* make sense to show a string that no longer exists. But it is still fine
	415	* to be used with modules, because when modules are unloaded, if they
	416	* had tracepoints, the ring buffers are cleared too. As long as the string
	417	* does not change during the life of the module, it is fine to use
	418	* tracepoint_string() within a module.
	419	*/
	420	#define tracepoint_string(str) \
	421	({ \
	422	static const char *___tp_str __tracepoint_string = str; \
	423	___tp_str; \
	424	})
	425	#define __tracepoint_string __attribute__((section("__tracepoint_str")))
	426
07b139c8	427	#ifdef CONFIG_PERF_EVENTS
6fb2915d	428	struct perf_event;
c530665c FW	429
	430	DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
	431
1c024eca PZ	432	extern int perf_trace_init(struct perf_event *event);
1c024eca PZ	433	extern void perf_trace_destroy(struct perf_event *event);
a4eaf7f1 PZ	434	extern int perf_trace_add(struct perf_event *event, int flags);
a4eaf7f1 PZ	435	extern void perf_trace_del(struct perf_event *event, int flags);
1c024eca	436	extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
6fb2915d LZ	437	char *filter_str);
6fb2915d LZ	438	extern void ftrace_profile_free_filter(struct perf_event *event);
b7e2ecef PZ	439	extern void *perf_trace_buf_prepare(int size, unsigned short type,
b7e2ecef PZ	440	struct pt_regs regs, int rctxp);
430ad5a6 XG	441
430ad5a6 XG	442	static inline void
97d5a220	443	perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
e6dab5ff AV	444	u64 count, struct pt_regs regs, void head,
e6dab5ff AV	445	struct task_struct *task)
430ad5a6	446	{
e6dab5ff	447	perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
430ad5a6	448	}
6fb2915d LZ	449	#endif
6fb2915d LZ	450
97f20251	451	#endif /* _LINUX_FTRACE_EVENT_H */