ftrace_event.h 7.26 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
23
24
DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);

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);

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

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

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

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

48
49
50
51
52
53
54
55
56
57
58
/*
 * 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];
59
	unsigned long		iter_flags;
60
61
62
63

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

	loff_t			pos;
	long			idx;

	cpumask_var_t		started;
};


76
77
struct trace_event;

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

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

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

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

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

void tracing_record_cmdline(struct task_struct *tsk);

124
125
struct event_filter;

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

struct ftrace_event_call;

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

149
150
151
152
153
154
155
156
157
158
enum {
	TRACE_EVENT_FL_ENABLED_BIT,
	TRACE_EVENT_FL_FILTERED_BIT,
};

enum {
	TRACE_EVENT_FL_ENABLED	= (1 << TRACE_EVENT_FL_ENABLED_BIT),
	TRACE_EVENT_FL_FILTERED	= (1 << TRACE_EVENT_FL_FILTERED_BIT),
};

159
struct ftrace_event_call {
160
	struct list_head	list;
161
	struct ftrace_event_class *class;
162
163
	char			*name;
	struct dentry		*dir;
164
	struct trace_event	event;
Lai Jiangshan's avatar
Lai Jiangshan committed
165
	const char		*print_fmt;
166
	struct event_filter	*filter;
167
	void			*mod;
168
	void			*data;
169

170
171
172
173
174
	/*
	 * 32 bit flags:
	 *   bit 1:		enabled
	 *   bit 2:		filter_active
	 *
175
176
177
178
179
180
181
182
	 * 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.
183
184
185
	 */
	unsigned int		flags;

186
#ifdef CONFIG_PERF_EVENTS
187
	int			perf_refcount;
188
	struct hlist_head	*perf_events;
189
#endif
190
191
};

192
#define PERF_MAX_TRACE_SIZE	2048
193

194
#define MAX_FILTER_PRED		32
195
#define MAX_FILTER_STR_VAL	256	/* Should handle KSYM_SYMBOL_LEN */
196

197
extern void destroy_preds(struct ftrace_event_call *call);
Li Zefan's avatar
Li Zefan committed
198
extern int filter_match_preds(struct event_filter *filter, void *rec);
199
200
extern int filter_current_check_discard(struct ring_buffer *buffer,
					struct ftrace_event_call *call,
201
202
203
					void *rec,
					struct ring_buffer_event *event);

204
205
206
207
enum {
	FILTER_OTHER = 0,
	FILTER_STATIC_STRING,
	FILTER_DYN_STRING,
208
	FILTER_PTR_STRING,
209
210
};

211
extern int trace_event_raw_init(struct ftrace_event_call *call);
212
213
214
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);
215
216
extern int trace_add_event_call(struct ftrace_event_call *call);
extern void trace_remove_event_call(struct ftrace_event_call *call);
217

218
#define is_signed_type(type)	(((type)(-1)) < 0)
219

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

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/*
 * 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)

241
#ifdef CONFIG_PERF_EVENTS
Li Zefan's avatar
Li Zefan committed
242
struct perf_event;
243
244
245

DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);

246
247
248
249
250
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,
Li Zefan's avatar
Li Zefan committed
251
252
				     char *filter_str);
extern void ftrace_profile_free_filter(struct perf_event *event);
253
254
extern void *perf_trace_buf_prepare(int size, unsigned short type,
				    struct pt_regs *regs, int *rctxp);
255
256

static inline void
257
perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
258
		       u64 count, struct pt_regs *regs, void *head)
259
{
260
	perf_tp_event(addr, count, raw_data, size, regs, head);
261
262
	perf_swevent_put_recursion_context(rctx);
}
Li Zefan's avatar
Li Zefan committed
263
264
#endif

265
#endif /* _LINUX_FTRACE_EVENT_H */