ftrace_event.h 7.5 KB
Newer Older
1 2 3 4
#ifndef _LINUX_FTRACE_EVENT_H
#define _LINUX_FTRACE_EVENT_H

#include <linux/ring_buffer.h>
5
#include <linux/trace_seq.h>
6
#include <linux/percpu.h>
7
#include <linux/hardirq.h>
8
#include <linux/perf_event.h>
9 10 11

struct trace_array;
struct tracer;
12
struct dentry;
13

14 15 16 17 18 19 20 21 22
struct trace_print_flags {
	unsigned 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);

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

K
Kei Tokunaga 已提交
26 27 28
const char *ftrace_print_hex_seq(struct trace_seq *p,
				 const unsigned char *buf, int len);

29 30 31 32 33 34 35
/*
 * 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 {
36
	unsigned short		type;
37 38 39
	unsigned char		flags;
	unsigned char		preempt_count;
	int			pid;
40
	int			lock_depth;
41 42
};

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

46 47 48 49 50 51 52 53 54 55 56
/*
 * 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;
	void			*private;
	int			cpu_file;
	struct mutex		mutex;
	struct ring_buffer_iter	*buffer_iter[NR_CPUS];
57
	unsigned long		iter_flags;
58

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

62 63 64
	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	struct trace_entry	*ent;
65
	unsigned long		lost_events;
66
	int			leftover;
67 68 69 70 71 72 73 74 75 76
	int			cpu;
	u64			ts;

	loff_t			pos;
	long			idx;

	cpumask_var_t		started;
};


77 78
struct trace_event;

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

struct trace_event_functions {
83 84 85 86 87 88
	trace_print_func	trace;
	trace_print_func	raw;
	trace_print_func	hex;
	trace_print_func	binary;
};

89 90 91 92 93 94 95
struct trace_event {
	struct hlist_node		node;
	struct list_head		list;
	int				type;
	struct trace_event_functions	*funcs;
};

96 97 98 99 100 101 102 103 104 105 106
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 */
};

107 108 109
void tracing_generic_entry_update(struct trace_entry *entry,
				  unsigned long flags,
				  int pc);
110
struct ring_buffer_event *
111 112
trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
				  int type, unsigned long len,
113
				  unsigned long flags, int pc);
114 115
void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
					struct ring_buffer_event *event,
116
					unsigned long flags, int pc);
117 118
void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
				       struct ring_buffer_event *event,
119
					unsigned long flags, int pc);
120 121
void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
					 struct ring_buffer_event *event);
122 123 124

void tracing_record_cmdline(struct task_struct *tsk);

125 126
struct event_filter;

127 128 129 130 131 132 133 134 135
enum trace_reg {
	TRACE_REG_REGISTER,
	TRACE_REG_UNREGISTER,
	TRACE_REG_PERF_REGISTER,
	TRACE_REG_PERF_UNREGISTER,
};

struct ftrace_event_call;

136 137
struct ftrace_event_class {
	char			*system;
138 139 140 141 142 143
	void			*probe;
#ifdef CONFIG_PERF_EVENTS
	void			*perf_probe;
#endif
	int			(*reg)(struct ftrace_event_call *event,
				       enum trace_reg type);
144 145 146
	int			(*define_fields)(struct ftrace_event_call *);
	struct list_head	*(*get_fields)(struct ftrace_event_call *);
	struct list_head	fields;
147
	int			(*raw_init)(struct ftrace_event_call *);
148 149
};

150 151 152
extern int ftrace_event_reg(struct ftrace_event_call *event,
			    enum trace_reg type);

153 154 155
enum {
	TRACE_EVENT_FL_ENABLED_BIT,
	TRACE_EVENT_FL_FILTERED_BIT,
156
	TRACE_EVENT_FL_RECORDED_CMD_BIT,
157 158 159
};

enum {
160 161 162
	TRACE_EVENT_FL_ENABLED		= (1 << TRACE_EVENT_FL_ENABLED_BIT),
	TRACE_EVENT_FL_FILTERED		= (1 << TRACE_EVENT_FL_FILTERED_BIT),
	TRACE_EVENT_FL_RECORDED_CMD	= (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
163 164
};

165
struct ftrace_event_call {
166
	struct list_head	list;
167
	struct ftrace_event_class *class;
168 169
	char			*name;
	struct dentry		*dir;
170
	struct trace_event	event;
L
Lai Jiangshan 已提交
171
	const char		*print_fmt;
172
	struct event_filter	*filter;
173
	void			*mod;
174
	void			*data;
175

176 177 178 179
	/*
	 * 32 bit flags:
	 *   bit 1:		enabled
	 *   bit 2:		filter_active
180
	 *   bit 3:		enabled cmd record
181
	 *
182 183 184 185 186 187 188 189
	 * Changes to flags must hold the event_mutex.
	 *
	 * Note: Reads of flags do not hold the event_mutex since
	 * they occur in critical sections. But the way flags
	 * is currently used, these changes do no 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.
190 191 192
	 */
	unsigned int		flags;

S
Steven Rostedt 已提交
193
#ifdef CONFIG_PERF_EVENTS
194
	int			perf_refcount;
195
	struct hlist_head	*perf_events;
S
Steven Rostedt 已提交
196
#endif
197 198
};

199
#define PERF_MAX_TRACE_SIZE	2048
200

201
#define MAX_FILTER_PRED		32
202
#define MAX_FILTER_STR_VAL	256	/* Should handle KSYM_SYMBOL_LEN */
203

204
extern void destroy_preds(struct ftrace_event_call *call);
L
Li Zefan 已提交
205
extern int filter_match_preds(struct event_filter *filter, void *rec);
206 207
extern int filter_current_check_discard(struct ring_buffer *buffer,
					struct ftrace_event_call *call,
208 209 210
					void *rec,
					struct ring_buffer_event *event);

211 212 213 214
enum {
	FILTER_OTHER = 0,
	FILTER_STATIC_STRING,
	FILTER_DYN_STRING,
215
	FILTER_PTR_STRING,
216 217
};

218
extern int trace_event_raw_init(struct ftrace_event_call *call);
219 220 221
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);
222 223
extern int trace_add_event_call(struct ftrace_event_call *call);
extern void trace_remove_event_call(struct ftrace_event_call *call);
224

225
#define is_signed_type(type)	(((type)(-1)) < 0)
226

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

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
/*
 * 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)

248
#ifdef CONFIG_PERF_EVENTS
L
Li Zefan 已提交
249
struct perf_event;
250 251 252

DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);

253 254 255 256 257
extern int  perf_trace_init(struct perf_event *event);
extern void perf_trace_destroy(struct perf_event *event);
extern int  perf_trace_enable(struct perf_event *event);
extern void perf_trace_disable(struct perf_event *event);
extern int  ftrace_profile_set_filter(struct perf_event *event, int event_id,
L
Li Zefan 已提交
258 259
				     char *filter_str);
extern void ftrace_profile_free_filter(struct perf_event *event);
260 261
extern void *perf_trace_buf_prepare(int size, unsigned short type,
				    struct pt_regs *regs, int *rctxp);
262 263

static inline void
264
perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
265
		       u64 count, struct pt_regs *regs, void *head)
266
{
267
	perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
268
}
L
Li Zefan 已提交
269 270
#endif

271
#endif /* _LINUX_FTRACE_EVENT_H */