trace.h 22.1 KB
Newer Older
1 2 3 4 5 6 7
#ifndef _LINUX_KERNEL_TRACE_H
#define _LINUX_KERNEL_TRACE_H

#include <linux/fs.h>
#include <asm/atomic.h>
#include <linux/sched.h>
#include <linux/clocksource.h>
8
#include <linux/ring_buffer.h>
P
Pekka Paalanen 已提交
9
#include <linux/mmiotrace.h>
10
#include <linux/tracepoint.h>
11
#include <linux/ftrace.h>
12
#include <trace/boot.h>
13
#include <linux/kmemtrace.h>
14

15
#include <linux/trace_seq.h>
16
#include <linux/ftrace_event.h>
17

18 19 20 21
#ifdef CONFIG_KSYM_TRACER
#include <asm/hw_breakpoint.h>
#endif

22 23 24 25 26 27 28
enum trace_type {
	__TRACE_FIRST_TYPE = 0,

	TRACE_FN,
	TRACE_CTX,
	TRACE_WAKE,
	TRACE_STACK,
29
	TRACE_PRINT,
30
	TRACE_BPRINT,
31
	TRACE_SPECIAL,
P
Pekka Paalanen 已提交
32 33
	TRACE_MMIO_RW,
	TRACE_MMIO_MAP,
34
	TRACE_BRANCH,
35 36
	TRACE_BOOT_CALL,
	TRACE_BOOT_RET,
37 38
	TRACE_GRAPH_RET,
	TRACE_GRAPH_ENT,
39
	TRACE_USER_STACK,
40
	TRACE_HW_BRANCHES,
41 42
	TRACE_KMEM_ALLOC,
	TRACE_KMEM_FREE,
43
	TRACE_BLK,
44
	TRACE_KSYM,
45

46
	__TRACE_LAST_TYPE,
47 48
};

49 50 51 52
enum kmemtrace_type_id {
	KMEMTRACE_TYPE_KMALLOC = 0,	/* kmalloc() or kfree(). */
	KMEMTRACE_TYPE_CACHE,		/* kmem_cache_*(). */
	KMEMTRACE_TYPE_PAGES,		/* __get_free_pages() and friends. */
53 54
};

55
extern struct tracer boot_tracer;
56

57 58
#undef __field
#define __field(type, item)		type	item;
59

60 61
#undef __field_struct
#define __field_struct(type, item)	__field(type, item)
62

63 64
#undef __field_desc
#define __field_desc(type, container, item)
65

66 67
#undef __array
#define __array(type, item, size)	type	item[size];
68

69 70
#undef __array_desc
#define __array_desc(type, container, item, size)
71

72 73
#undef __dynamic_array
#define __dynamic_array(type, item)	type	item[];
74

75 76
#undef F_STRUCT
#define F_STRUCT(args...)		args
77

78 79 80 81 82 83
#undef FTRACE_ENTRY
#define FTRACE_ENTRY(name, struct_name, id, tstruct, print)	\
	struct struct_name {					\
		struct trace_entry	ent;			\
		tstruct						\
	}
84

85 86
#undef TP_ARGS
#define TP_ARGS(args...)	args
87

88 89
#undef FTRACE_ENTRY_DUP
#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
90

91
#include "trace_entries.h"
92

93 94 95 96
/*
 * syscalls are special, and need special handling, this is why
 * they are not included in trace_entries.h
 */
97 98 99 100 101 102 103 104 105 106 107 108
struct syscall_trace_enter {
	struct trace_entry	ent;
	int			nr;
	unsigned long		args[];
};

struct syscall_trace_exit {
	struct trace_entry	ent;
	int			nr;
	unsigned long		ret;
};

109 110 111
/*
 * trace_flag_type is an enumeration that holds different
 * states when a trace occurs. These are:
112
 *  IRQS_OFF		- interrupts were disabled
I
Ingo Molnar 已提交
113
 *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
L
Li Zefan 已提交
114
 *  NEED_RESCHED	- reschedule is requested
115 116
 *  HARDIRQ		- inside an interrupt handler
 *  SOFTIRQ		- inside a softirq handler
117 118 119
 */
enum trace_flag_type {
	TRACE_FLAG_IRQS_OFF		= 0x01,
120 121 122 123
	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
	TRACE_FLAG_NEED_RESCHED		= 0x04,
	TRACE_FLAG_HARDIRQ		= 0x08,
	TRACE_FLAG_SOFTIRQ		= 0x10,
124 125
};

126
#define TRACE_BUF_SIZE		1024
127 128 129 130 131 132 133 134

/*
 * The CPU trace array - it consists of thousands of trace entries
 * plus some other descriptor data: (for example which task started
 * the trace, etc.)
 */
struct trace_array_cpu {
	atomic_t		disabled;
135
	void			*buffer_page;	/* ring buffer spare */
I
Ingo Molnar 已提交
136

137 138 139 140 141 142 143
	unsigned long		saved_latency;
	unsigned long		critical_start;
	unsigned long		critical_end;
	unsigned long		critical_sequence;
	unsigned long		nice;
	unsigned long		policy;
	unsigned long		rt_priority;
144
	unsigned long		skipped_entries;
145 146 147 148 149 150 151 152 153 154 155 156
	cycle_t			preempt_timestamp;
	pid_t			pid;
	uid_t			uid;
	char			comm[TASK_COMM_LEN];
};

/*
 * The trace array - an array of per-CPU trace arrays. This is the
 * highest level data structure that individual tracers deal with.
 * They have on/off state as well:
 */
struct trace_array {
157
	struct ring_buffer	*buffer;
158 159 160
	unsigned long		entries;
	int			cpu;
	cycle_t			time_start;
161
	struct task_struct	*waiter;
162 163 164
	struct trace_array_cpu	*data[NR_CPUS];
};

S
Steven Rostedt 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
#define FTRACE_CMP_TYPE(var, type) \
	__builtin_types_compatible_p(typeof(var), type *)

#undef IF_ASSIGN
#define IF_ASSIGN(var, entry, etype, id)		\
	if (FTRACE_CMP_TYPE(var, etype)) {		\
		var = (typeof(var))(entry);		\
		WARN_ON(id && (entry)->type != id);	\
		break;					\
	}

/* Will cause compile errors if type is not found. */
extern void __ftrace_bad_type(void);

/*
 * The trace_assign_type is a verifier that the entry type is
 * the same as the type being assigned. To add new types simply
 * add a line with the following format:
 *
 * IF_ASSIGN(var, ent, type, id);
 *
 *  Where "type" is the trace type that includes the trace_entry
 *  as the "ent" item. And "id" is the trace identifier that is
 *  used in the trace_type enum.
 *
 *  If the type can have more than one id, then use zero.
 */
#define trace_assign_type(var, ent)					\
	do {								\
		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
197
		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
S
Steven Rostedt 已提交
198
		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
199
		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
S
Steven Rostedt 已提交
200 201 202 203 204
		IF_ASSIGN(var, ent, struct special_entry, 0);		\
		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
			  TRACE_MMIO_RW);				\
		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
			  TRACE_MMIO_MAP);				\
205 206
		IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
		IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
207
		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
208 209 210 211
		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
			  TRACE_GRAPH_ENT);		\
		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
			  TRACE_GRAPH_RET);		\
212
		IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
213 214 215 216
		IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry,	\
			  TRACE_KMEM_ALLOC);	\
		IF_ASSIGN(var, ent, struct kmemtrace_free_entry,	\
			  TRACE_KMEM_FREE);	\
217
		IF_ASSIGN(var, ent, struct ksym_trace_entry, TRACE_KSYM);\
S
Steven Rostedt 已提交
218 219
		__ftrace_bad_type();					\
	} while (0)
220

221 222 223 224 225 226
/*
 * An option specific to a tracer. This is a boolean value.
 * The bit is the bit index that sets its value on the
 * flags value in struct tracer_flags.
 */
struct tracer_opt {
I
Ingo Molnar 已提交
227 228
	const char	*name; /* Will appear on the trace_options file */
	u32		bit; /* Mask assigned in val field in tracer_flags */
229 230 231 232 233 234 235 236
};

/*
 * The set of specific options for a tracer. Your tracer
 * have to set the initial value of the flags val.
 */
struct tracer_flags {
	u32			val;
I
Ingo Molnar 已提交
237
	struct tracer_opt	*opts;
238 239 240 241 242
};

/* Makes more easy to define a tracer opt */
#define TRACER_OPT(s, b)	.name = #s, .bit = b

243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * struct tracer - a specific tracer and its callbacks to interact with debugfs
 * @name: the name chosen to select it on the available_tracers file
 * @init: called when one switches to this tracer (echo name > current_tracer)
 * @reset: called when one switches to another tracer
 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
 * @open: called when the trace file is opened
 * @pipe_open: called when the trace_pipe file is opened
 * @wait_pipe: override how the user waits for traces on trace_pipe
 * @close: called when the trace file is released
 * @read: override the default read callback on trace_pipe
 * @splice_read: override the default splice_read callback on trace_pipe
 * @selftest: selftest to run on boot (see trace_selftest.c)
 * @print_headers: override the first lines that describe your columns
 * @print_line: callback that prints a trace
 * @set_flag: signals one of your private flags changed (trace_options file)
 * @flags: your private flags
262 263 264
 */
struct tracer {
	const char		*name;
265
	int			(*init)(struct trace_array *tr);
266
	void			(*reset)(struct trace_array *tr);
267 268
	void			(*start)(struct trace_array *tr);
	void			(*stop)(struct trace_array *tr);
269
	void			(*open)(struct trace_iterator *iter);
270
	void			(*pipe_open)(struct trace_iterator *iter);
271
	void			(*wait_pipe)(struct trace_iterator *iter);
272
	void			(*close)(struct trace_iterator *iter);
273 274 275
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
276 277 278 279 280 281
	ssize_t			(*splice_read)(struct trace_iterator *iter,
					       struct file *filp,
					       loff_t *ppos,
					       struct pipe_inode_info *pipe,
					       size_t len,
					       unsigned int flags);
S
Steven Rostedt 已提交
282 283 284 285
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
286
	void			(*print_header)(struct seq_file *m);
287
	enum print_line_t	(*print_line)(struct trace_iterator *iter);
288 289
	/* If you handled the flag setting, return 0 */
	int			(*set_flag)(u32 old_flags, u32 bit, int set);
290 291
	struct tracer		*next;
	int			print_max;
I
Ingo Molnar 已提交
292
	struct tracer_flags	*flags;
293 294
};

295

296 297
#define TRACE_PIPE_ALL_CPU	-1

298
int tracer_init(struct tracer *t, struct trace_array *tr);
299
int tracing_is_enabled(void);
300
void trace_wake_up(void);
301
void tracing_reset(struct trace_array *tr, int cpu);
302
void tracing_reset_online_cpus(struct trace_array *tr);
303 304
void tracing_reset_current(int cpu);
void tracing_reset_current_online_cpus(void);
305
int tracing_open_generic(struct inode *inode, struct file *filp);
306 307 308 309 310 311
struct dentry *trace_create_file(const char *name,
				 mode_t mode,
				 struct dentry *parent,
				 void *data,
				 const struct file_operations *fops);

312
struct dentry *tracing_init_dentry(void);
I
Ingo Molnar 已提交
313 314
void init_tracer_sysprof_debugfs(struct dentry *d_tracer);

315 316
struct ring_buffer_event;

317 318 319 320 321 322 323
struct ring_buffer_event *
trace_buffer_lock_reserve(struct ring_buffer *buffer,
			  int type,
			  unsigned long len,
			  unsigned long flags,
			  int pc);
void trace_buffer_unlock_commit(struct ring_buffer *buffer,
324 325 326
				struct ring_buffer_event *event,
				unsigned long flags, int pc);

327 328
struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
						struct trace_array_cpu *data);
329 330 331 332

struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
					  int *ent_cpu, u64 *ent_ts);

333 334 335
void default_wait_pipe(struct trace_iterator *iter);
void poll_wait_pipe(struct trace_iterator *iter);

336 337 338 339
void ftrace(struct trace_array *tr,
			    struct trace_array_cpu *data,
			    unsigned long ip,
			    unsigned long parent_ip,
340
			    unsigned long flags, int pc);
341 342 343
void tracing_sched_switch_trace(struct trace_array *tr,
				struct task_struct *prev,
				struct task_struct *next,
344
				unsigned long flags, int pc);
345 346 347 348

void tracing_sched_wakeup_trace(struct trace_array *tr,
				struct task_struct *wakee,
				struct task_struct *cur,
349
				unsigned long flags, int pc);
I
Ingo Molnar 已提交
350 351 352 353
void trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
354
		   unsigned long arg3, int pc);
355 356 357
void trace_function(struct trace_array *tr,
		    unsigned long ip,
		    unsigned long parent_ip,
358
		    unsigned long flags, int pc);
359

360
void trace_graph_return(struct ftrace_graph_ret *trace);
361
int trace_graph_entry(struct ftrace_graph_ent *trace);
362
void set_graph_array(struct trace_array *tr);
363

364 365
void tracing_start_cmdline_record(void);
void tracing_stop_cmdline_record(void);
S
Steven Rostedt 已提交
366 367 368
void tracing_sched_switch_assign_trace(struct trace_array *tr);
void tracing_stop_sched_switch_record(void);
void tracing_start_sched_switch_record(void);
369 370
int register_tracer(struct tracer *type);
void unregister_tracer(struct tracer *type);
371
int is_tracing_stopped(void);
372

373 374
#define KSYM_SELFTEST_ENTRY "ksym_selftest_dummy"
extern int process_new_ksym_entry(char *ksymname, int op, unsigned long addr);
375 376 377

extern unsigned long nsecs_to_usecs(unsigned long nsecs);

378
#ifdef CONFIG_TRACER_MAX_TRACE
379 380 381 382 383 384
extern unsigned long tracing_max_latency;
extern unsigned long tracing_thresh;

void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
void update_max_tr_single(struct trace_array *tr,
			  struct task_struct *tsk, int cpu);
385
#endif /* CONFIG_TRACER_MAX_TRACE */
386

387
#ifdef CONFIG_STACKTRACE
388
void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
389 390
			int skip, int pc);

391
void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
392
			    int pc);
393

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
		   int pc);
#else
static inline void ftrace_trace_stack(struct trace_array *tr,
				      unsigned long flags, int skip, int pc)
{
}

static inline void ftrace_trace_userstack(struct trace_array *tr,
					  unsigned long flags, int pc)
{
}

static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
				 int skip, int pc)
{
}
#endif /* CONFIG_STACKTRACE */
412

I
Ingo Molnar 已提交
413
extern cycle_t ftrace_now(int cpu);
414

415
extern void trace_find_cmdline(int pid, char comm[]);
416

417 418
#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
419 420
#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
extern int DYN_FTRACE_TEST_NAME(void);
421 422
#endif

423 424
extern int ring_buffer_expanded;
extern bool tracing_selftest_disabled;
425
DECLARE_PER_CPU(local_t, ftrace_cpu_disabled);
426

S
Steven Rostedt 已提交
427 428 429
#ifdef CONFIG_FTRACE_STARTUP_TEST
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
430 431
extern int trace_selftest_startup_function_graph(struct tracer *trace,
						 struct trace_array *tr);
S
Steven Rostedt 已提交
432 433 434 435 436 437 438 439
extern int trace_selftest_startup_irqsoff(struct tracer *trace,
					  struct trace_array *tr);
extern int trace_selftest_startup_preemptoff(struct tracer *trace,
					     struct trace_array *tr);
extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
						 struct trace_array *tr);
extern int trace_selftest_startup_wakeup(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Noonan 已提交
440 441
extern int trace_selftest_startup_nop(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
442 443
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
444 445
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
S
Steven Rostedt 已提交
446 447
extern int trace_selftest_startup_branch(struct tracer *trace,
					 struct trace_array *tr);
448 449
extern int trace_selftest_startup_hw_branches(struct tracer *trace,
					      struct trace_array *tr);
450 451
extern int trace_selftest_startup_ksym(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
452 453
#endif /* CONFIG_FTRACE_STARTUP_TEST */

I
Ingo Molnar 已提交
454
extern void *head_page(struct trace_array_cpu *data);
455
extern unsigned long long ns2usecs(cycle_t nsec);
456
extern int
457
trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
458
extern int
459
trace_vprintk(unsigned long ip, const char *fmt, va_list args);
460 461 462 463 464
extern int
trace_array_vprintk(struct trace_array *tr,
		    unsigned long ip, const char *fmt, va_list args);
int trace_array_printk(struct trace_array *tr,
		       unsigned long ip, const char *fmt, ...);
I
Ingo Molnar 已提交
465

466 467
extern unsigned long trace_flags;

468 469
extern int trace_clock_id;

470
/* Standard output formatting function used for function return traces */
471 472
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern enum print_line_t print_graph_function(struct trace_iterator *iter);
473 474
extern enum print_line_t
trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

#ifdef CONFIG_DYNAMIC_FTRACE
/* TODO: make this variable */
#define FTRACE_GRAPH_MAX_FUNCS		32
extern int ftrace_graph_count;
extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];

static inline int ftrace_graph_addr(unsigned long addr)
{
	int i;

	if (!ftrace_graph_count || test_tsk_trace_graph(current))
		return 1;

	for (i = 0; i < ftrace_graph_count; i++) {
		if (addr == ftrace_graph_funcs[i])
			return 1;
	}

	return 0;
}
496
#else
497 498 499
static inline int ftrace_graph_addr(unsigned long addr)
{
	return 1;
500 501 502
}
#endif /* CONFIG_DYNAMIC_FTRACE */
#else /* CONFIG_FUNCTION_GRAPH_TRACER */
503
static inline enum print_line_t
504
print_graph_function(struct trace_iterator *iter)
505 506 507
{
	return TRACE_TYPE_UNHANDLED;
}
508
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
509

510
extern struct list_head ftrace_pids;
511

512
#ifdef CONFIG_FUNCTION_TRACER
513 514
static inline int ftrace_trace_task(struct task_struct *task)
{
515
	if (list_empty(&ftrace_pids))
516 517 518 519
		return 1;

	return test_tsk_trace_trace(task);
}
520 521 522 523 524 525
#else
static inline int ftrace_trace_task(struct task_struct *task)
{
	return 1;
}
#endif
526

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
/*
 * struct trace_parser - servers for reading the user input separated by spaces
 * @cont: set if the input is not complete - no final space char was found
 * @buffer: holds the parsed user input
 * @idx: user input lenght
 * @size: buffer size
 */
struct trace_parser {
	bool		cont;
	char		*buffer;
	unsigned	idx;
	unsigned	size;
};

static inline bool trace_parser_loaded(struct trace_parser *parser)
{
	return (parser->idx != 0);
}

static inline bool trace_parser_cont(struct trace_parser *parser)
{
	return parser->cont;
}

static inline void trace_parser_clear(struct trace_parser *parser)
{
	parser->cont = false;
	parser->idx = 0;
}

extern int trace_parser_get_init(struct trace_parser *parser, int size);
extern void trace_parser_put(struct trace_parser *parser);
extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
	size_t cnt, loff_t *ppos);

S
Steven Rostedt 已提交
562 563 564 565 566 567 568
/*
 * trace_iterator_flags is an enumeration that defines bit
 * positions into trace_flags that controls the output.
 *
 * NOTE: These bits must match the trace_options array in
 *       trace.c.
 */
569 570 571 572 573 574 575 576 577 578
enum trace_iterator_flags {
	TRACE_ITER_PRINT_PARENT		= 0x01,
	TRACE_ITER_SYM_OFFSET		= 0x02,
	TRACE_ITER_SYM_ADDR		= 0x04,
	TRACE_ITER_VERBOSE		= 0x08,
	TRACE_ITER_RAW			= 0x10,
	TRACE_ITER_HEX			= 0x20,
	TRACE_ITER_BIN			= 0x40,
	TRACE_ITER_BLOCK		= 0x80,
	TRACE_ITER_STACKTRACE		= 0x100,
I
Ingo Molnar 已提交
579
	TRACE_ITER_SCHED_TREE		= 0x200,
580
	TRACE_ITER_PRINTK		= 0x400,
581
	TRACE_ITER_PREEMPTONLY		= 0x800,
582
	TRACE_ITER_BRANCH		= 0x1000,
583
	TRACE_ITER_ANNOTATE		= 0x2000,
584
	TRACE_ITER_USERSTACKTRACE       = 0x4000,
585
	TRACE_ITER_SYM_USEROBJ          = 0x8000,
586
	TRACE_ITER_PRINTK_MSGONLY	= 0x10000,
587 588
	TRACE_ITER_CONTEXT_INFO		= 0x20000, /* Print pid/cpu/time */
	TRACE_ITER_LATENCY_FMT		= 0x40000,
589 590
	TRACE_ITER_SLEEP_TIME		= 0x80000,
	TRACE_ITER_GRAPH_TIME		= 0x100000,
591 592
};

593 594 595 596 597 598 599
/*
 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
 * control the output of kernel symbols.
 */
#define TRACE_ITER_SYM_MASK \
	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)

600 601
extern struct tracer nop_trace;

602 603 604 605 606 607 608 609 610
/**
 * ftrace_preempt_disable - disable preemption scheduler safe
 *
 * When tracing can happen inside the scheduler, there exists
 * cases that the tracing might happen before the need_resched
 * flag is checked. If this happens and the tracer calls
 * preempt_enable (after a disable), a schedule might take place
 * causing an infinite recursion.
 *
611
 * To prevent this, we read the need_resched flag before
612 613 614 615
 * disabling preemption. When we want to enable preemption we
 * check the flag, if it is set, then we call preempt_enable_no_resched.
 * Otherwise, we call preempt_enable.
 *
616
 * The rational for doing the above is that if need_resched is set
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
 * and we have yet to reschedule, we are either in an atomic location
 * (where we do not need to check for scheduling) or we are inside
 * the scheduler and do not want to resched.
 */
static inline int ftrace_preempt_disable(void)
{
	int resched;

	resched = need_resched();
	preempt_disable_notrace();

	return resched;
}

/**
 * ftrace_preempt_enable - enable preemption scheduler safe
 * @resched: the return value from ftrace_preempt_disable
 *
 * This is a scheduler safe way to enable preemption and not miss
 * any preemption checks. The disabled saved the state of preemption.
637
 * If resched is set, then we are either inside an atomic or
638 639 640 641 642 643 644 645 646 647 648 649
 * are inside the scheduler (we would have already scheduled
 * otherwise). In this case, we do not want to call normal
 * preempt_enable, but preempt_enable_no_resched instead.
 */
static inline void ftrace_preempt_enable(int resched)
{
	if (resched)
		preempt_enable_no_resched_notrace();
	else
		preempt_enable_notrace();
}

650
#ifdef CONFIG_BRANCH_TRACER
651 652 653
extern int enable_branch_tracing(struct trace_array *tr);
extern void disable_branch_tracing(void);
static inline int trace_branch_enable(struct trace_array *tr)
654
{
655 656
	if (trace_flags & TRACE_ITER_BRANCH)
		return enable_branch_tracing(tr);
657 658
	return 0;
}
659
static inline void trace_branch_disable(void)
660 661
{
	/* due to races, always disable */
662
	disable_branch_tracing();
663 664
}
#else
665
static inline int trace_branch_enable(struct trace_array *tr)
666 667 668
{
	return 0;
}
669
static inline void trace_branch_disable(void)
670 671
{
}
672
#endif /* CONFIG_BRANCH_TRACER */
673

674 675 676
/* set ring buffers to default size if not already done so */
int tracing_update_buffers(void);

677 678 679 680 681 682
/* trace event type bit fields, not numeric */
enum {
	TRACE_EVENT_TYPE_PRINTF		= 1,
	TRACE_EVENT_TYPE_RAW		= 2,
};

683 684 685 686
struct ftrace_event_field {
	struct list_head	link;
	char			*name;
	char			*type;
687
	int			filter_type;
688 689
	int			offset;
	int			size;
690
	int			is_signed;
691 692
};

693 694 695
struct event_filter {
	int			n_preds;
	struct filter_pred	**preds;
696
	char			*filter_string;
697 698
};

699 700 701 702
struct event_subsystem {
	struct list_head	list;
	const char		*name;
	struct dentry		*entry;
703
	struct event_filter	*filter;
704
	int			nr_events;
705 706
};

T
Tom Zanussi 已提交
707
struct filter_pred;
708
struct regex;
T
Tom Zanussi 已提交
709

710 711
typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
				 int val1, int val2);
T
Tom Zanussi 已提交
712

713 714
typedef int (*regex_match_func)(char *str, struct regex *r, int len);

715
enum regex_type {
716
	MATCH_FULL = 0,
717 718 719 720 721
	MATCH_FRONT_ONLY,
	MATCH_MIDDLE_ONLY,
	MATCH_END_ONLY,
};

722 723 724 725 726
struct regex {
	char			pattern[MAX_FILTER_STR_VAL];
	int			len;
	int			field_len;
	regex_match_func	match;
T
Tom Zanussi 已提交
727 728 729
};

struct filter_pred {
730 731 732 733 734 735 736 737
	filter_pred_fn_t 	fn;
	u64 			val;
	struct regex		regex;
	char 			*field_name;
	int 			offset;
	int 			not;
	int 			op;
	int 			pop_n;
T
Tom Zanussi 已提交
738 739
};

740 741
extern enum regex_type
filter_parse_regex(char *buff, int len, char **search, int *not);
742
extern void print_event_filter(struct ftrace_event_call *call,
743
			       struct trace_seq *s);
744 745 746 747 748
extern int apply_event_filter(struct ftrace_event_call *call,
			      char *filter_string);
extern int apply_subsystem_event_filter(struct event_subsystem *system,
					char *filter_string);
extern void print_subsystem_event_filter(struct event_subsystem *system,
749
					 struct trace_seq *s);
750
extern int filter_assign_type(const char *type);
T
Tom Zanussi 已提交
751

752
static inline int
753
filter_check_discard(struct ftrace_event_call *call, void *rec,
754
		     struct ring_buffer *buffer,
755 756
		     struct ring_buffer_event *event)
{
L
Li Zefan 已提交
757 758
	if (unlikely(call->filter_active) &&
	    !filter_match_preds(call->filter, rec)) {
759 760 761 762 763
		ring_buffer_discard_commit(buffer, event);
		return 1;
	}

	return 0;
764 765
}

766
extern struct mutex event_mutex;
767
extern struct list_head ftrace_events;
P
Peter Zijlstra 已提交
768

769 770 771
extern const char *__start___trace_bprintk_fmt[];
extern const char *__stop___trace_bprintk_fmt[];

772 773
#undef FTRACE_ENTRY
#define FTRACE_ENTRY(call, struct_name, id, tstruct, print)		\
774
	extern struct ftrace_event_call event_##call;
775 776 777 778
#undef FTRACE_ENTRY_DUP
#define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print)		\
	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
#include "trace_entries.h"
779

780
#endif /* _LINUX_KERNEL_TRACE_H */