trace.h 21.5 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/ftrace.h>
11
#include <trace/boot.h>
12
#include <linux/kmemtrace.h>
13
#include <trace/power.h>
14

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

18 19 20 21 22 23 24
enum trace_type {
	__TRACE_FIRST_TYPE = 0,

	TRACE_FN,
	TRACE_CTX,
	TRACE_WAKE,
	TRACE_STACK,
25
	TRACE_PRINT,
26
	TRACE_BPRINT,
27
	TRACE_SPECIAL,
P
Pekka Paalanen 已提交
28 29
	TRACE_MMIO_RW,
	TRACE_MMIO_MAP,
30
	TRACE_BRANCH,
31 32
	TRACE_BOOT_CALL,
	TRACE_BOOT_RET,
33 34
	TRACE_GRAPH_RET,
	TRACE_GRAPH_ENT,
35
	TRACE_USER_STACK,
36
	TRACE_HW_BRANCHES,
37 38
	TRACE_KMEM_ALLOC,
	TRACE_KMEM_FREE,
39
	TRACE_POWER,
40
	TRACE_BLK,
41

42
	__TRACE_LAST_TYPE,
43 44
};

45 46 47 48
enum kmemtrace_type_id {
	KMEMTRACE_TYPE_KMALLOC = 0,	/* kmalloc() or kfree(). */
	KMEMTRACE_TYPE_CACHE,		/* kmem_cache_*(). */
	KMEMTRACE_TYPE_PAGES,		/* __get_free_pages() and friends. */
49 50
};

51
extern struct tracer boot_tracer;
52

53 54
#undef __field
#define __field(type, item)		type	item;
55

56 57 58 59 60 61
#undef __field_struct
#define __field_struct(type, item)	__field(type, item)

#undef __field_desc
#define __field_desc(type, container, item)

62 63
#undef __array
#define __array(type, item, size)	type	item[size];
64

65 66 67
#undef __array_desc
#define __array_desc(type, container, item, size)

68 69
#undef __dynamic_array
#define __dynamic_array(type, item)	type	item[];
70

71 72
#undef F_STRUCT
#define F_STRUCT(args...)		args
73

74 75 76 77 78 79
#undef FTRACE_ENTRY
#define FTRACE_ENTRY(name, struct_name, id, tstruct, print)	\
	struct struct_name {					\
		struct trace_entry	ent;			\
		tstruct						\
	}
80

81 82
#undef TP_ARGS
#define TP_ARGS(args...)	args
83

84 85
#undef FTRACE_ENTRY_DUP
#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
86

87
#include "trace_entries.h"
88

89 90 91 92
/*
 * syscalls are special, and need special handling, this is why
 * they are not included in trace_entries.h
 */
93 94 95 96 97 98 99 100 101 102 103 104
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;
};

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

122
#define TRACE_BUF_SIZE		1024
123 124 125 126 127 128 129 130

/*
 * 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;
131
	void			*buffer_page;	/* ring buffer spare */
I
Ingo Molnar 已提交
132

133 134 135 136 137 138 139
	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;
140
	unsigned long		skipped_entries;
141 142 143 144 145 146 147 148 149 150 151 152
	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 {
153
	struct ring_buffer	*buffer;
154 155 156
	unsigned long		entries;
	int			cpu;
	cycle_t			time_start;
157
	struct task_struct	*waiter;
158 159 160
	struct trace_array_cpu	*data[NR_CPUS];
};

S
Steven Rostedt 已提交
161 162 163 164 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
#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);	\
193
		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
S
Steven Rostedt 已提交
194
		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
195
		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
S
Steven Rostedt 已提交
196 197 198 199 200
		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);				\
201 202
		IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
		IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
203
		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
204 205 206 207
		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
			  TRACE_GRAPH_ENT);		\
		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
			  TRACE_GRAPH_RET);		\
208
		IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
I
Ingo Molnar 已提交
209
		IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
210 211 212 213
		IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry,	\
			  TRACE_KMEM_ALLOC);	\
		IF_ASSIGN(var, ent, struct kmemtrace_free_entry,	\
			  TRACE_KMEM_FREE);	\
S
Steven Rostedt 已提交
214 215
		__ftrace_bad_type();					\
	} while (0)
216

217 218 219 220 221 222
/*
 * 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 已提交
223 224
	const char	*name; /* Will appear on the trace_options file */
	u32		bit; /* Mask assigned in val field in tracer_flags */
225 226 227 228 229 230 231 232
};

/*
 * 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 已提交
233
	struct tracer_opt	*opts;
234 235 236 237 238
};

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

239

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
/**
 * 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
258 259 260
 */
struct tracer {
	const char		*name;
261
	int			(*init)(struct trace_array *tr);
262
	void			(*reset)(struct trace_array *tr);
263 264
	void			(*start)(struct trace_array *tr);
	void			(*stop)(struct trace_array *tr);
265
	void			(*open)(struct trace_iterator *iter);
266
	void			(*pipe_open)(struct trace_iterator *iter);
267
	void			(*wait_pipe)(struct trace_iterator *iter);
268
	void			(*close)(struct trace_iterator *iter);
269 270 271
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
272 273 274 275 276 277
	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 已提交
278 279 280 281
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
282
	void			(*print_header)(struct seq_file *m);
283
	enum print_line_t	(*print_line)(struct trace_iterator *iter);
284 285
	/* If you handled the flag setting, return 0 */
	int			(*set_flag)(u32 old_flags, u32 bit, int set);
286 287
	struct tracer		*next;
	int			print_max;
I
Ingo Molnar 已提交
288
	struct tracer_flags	*flags;
289 290
};

291

292 293
#define TRACE_PIPE_ALL_CPU	-1

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

308
struct dentry *tracing_init_dentry(void);
I
Ingo Molnar 已提交
309 310
void init_tracer_sysprof_debugfs(struct dentry *d_tracer);

311 312
struct ring_buffer_event;

313 314 315 316 317 318 319
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,
320 321 322
				struct ring_buffer_event *event,
				unsigned long flags, int pc);

323 324
struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
						struct trace_array_cpu *data);
325 326 327 328

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

329 330 331
void default_wait_pipe(struct trace_iterator *iter);
void poll_wait_pipe(struct trace_iterator *iter);

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

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

356
void trace_graph_return(struct ftrace_graph_ret *trace);
357
int trace_graph_entry(struct ftrace_graph_ent *trace);
358
void set_graph_array(struct trace_array *tr);
359

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

extern unsigned long nsecs_to_usecs(unsigned long nsecs);

371
#ifdef CONFIG_TRACER_MAX_TRACE
372 373 374 375 376 377
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);
378
#endif /* CONFIG_TRACER_MAX_TRACE */
379

380
#ifdef CONFIG_STACKTRACE
381
void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
382 383
			int skip, int pc);

384
void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
			    int pc);

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 */
405

I
Ingo Molnar 已提交
406
extern cycle_t ftrace_now(int cpu);
407

408
extern void trace_find_cmdline(int pid, char comm[]);
409

410 411
#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
412 413
#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
extern int DYN_FTRACE_TEST_NAME(void);
414 415
#endif

416 417
extern int ring_buffer_expanded;
extern bool tracing_selftest_disabled;
418
DECLARE_PER_CPU(local_t, ftrace_cpu_disabled);
419

S
Steven Rostedt 已提交
420 421 422
#ifdef CONFIG_FTRACE_STARTUP_TEST
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
423 424
extern int trace_selftest_startup_function_graph(struct tracer *trace,
						 struct trace_array *tr);
S
Steven Rostedt 已提交
425 426 427 428 429 430 431 432
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 已提交
433 434
extern int trace_selftest_startup_nop(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
435 436
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
437 438
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
S
Steven Rostedt 已提交
439 440
extern int trace_selftest_startup_branch(struct tracer *trace,
					 struct trace_array *tr);
441 442
extern int trace_selftest_startup_hw_branches(struct tracer *trace,
					      struct trace_array *tr);
S
Steven Rostedt 已提交
443 444
#endif /* CONFIG_FTRACE_STARTUP_TEST */

I
Ingo Molnar 已提交
445
extern void *head_page(struct trace_array_cpu *data);
446
extern unsigned long long ns2usecs(cycle_t nsec);
447
extern int
448
trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
449
extern int
450
trace_vprintk(unsigned long ip, const char *fmt, va_list args);
451 452 453 454 455
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 已提交
456

457 458
extern unsigned long trace_flags;

459 460
extern int trace_clock_id;

461
/* Standard output formatting function used for function return traces */
462 463
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern enum print_line_t print_graph_function(struct trace_iterator *iter);
464 465
extern enum print_line_t
trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486

#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;
}
487
#else
488 489
static inline int ftrace_trace_addr(unsigned long addr)
{
490 491 492 493 494
	return 1;
}
static inline int ftrace_graph_addr(unsigned long addr)
{
	return 1;
495 496 497
}
#endif /* CONFIG_DYNAMIC_FTRACE */
#else /* CONFIG_FUNCTION_GRAPH_TRACER */
498
static inline enum print_line_t
499
print_graph_function(struct trace_iterator *iter)
500 501 502
{
	return TRACE_TYPE_UNHANDLED;
}
503
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
504

S
Steven Rostedt 已提交
505
extern struct pid *ftrace_pid_trace;
506

507
#ifdef CONFIG_FUNCTION_TRACER
508 509
static inline int ftrace_trace_task(struct task_struct *task)
{
510
	if (!ftrace_pid_trace)
511 512 513 514
		return 1;

	return test_tsk_trace_trace(task);
}
515 516 517 518 519 520
#else
static inline int ftrace_trace_task(struct task_struct *task)
{
	return 1;
}
#endif
521

522 523 524 525 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
/*
 * 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 已提交
557 558 559 560 561 562 563
/*
 * 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.
 */
564 565 566 567 568 569 570 571 572 573
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 已提交
574
	TRACE_ITER_SCHED_TREE		= 0x200,
575
	TRACE_ITER_PRINTK		= 0x400,
576
	TRACE_ITER_PREEMPTONLY		= 0x800,
577
	TRACE_ITER_BRANCH		= 0x1000,
578
	TRACE_ITER_ANNOTATE		= 0x2000,
579
	TRACE_ITER_USERSTACKTRACE       = 0x4000,
580
	TRACE_ITER_SYM_USEROBJ          = 0x8000,
581
	TRACE_ITER_PRINTK_MSGONLY	= 0x10000,
582 583
	TRACE_ITER_CONTEXT_INFO		= 0x20000, /* Print pid/cpu/time */
	TRACE_ITER_LATENCY_FMT		= 0x40000,
584 585
	TRACE_ITER_SLEEP_TIME		= 0x80000,
	TRACE_ITER_GRAPH_TIME		= 0x100000,
586 587
};

588 589 590 591 592 593 594
/*
 * 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)

595 596
extern struct tracer nop_trace;

597 598 599 600 601 602 603 604 605
/**
 * 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.
 *
606
 * To prevent this, we read the need_resched flag before
607 608 609 610
 * 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.
 *
611
 * The rational for doing the above is that if need_resched is set
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
 * 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.
632
 * If resched is set, then we are either inside an atomic or
633 634 635 636 637 638 639 640 641 642 643 644
 * 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();
}

645
#ifdef CONFIG_BRANCH_TRACER
646 647 648
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)
649
{
650 651
	if (trace_flags & TRACE_ITER_BRANCH)
		return enable_branch_tracing(tr);
652 653
	return 0;
}
654
static inline void trace_branch_disable(void)
655 656
{
	/* due to races, always disable */
657
	disable_branch_tracing();
658 659
}
#else
660
static inline int trace_branch_enable(struct trace_array *tr)
661 662 663
{
	return 0;
}
664
static inline void trace_branch_disable(void)
665 666
{
}
667
#endif /* CONFIG_BRANCH_TRACER */
668

669 670 671
/* set ring buffers to default size if not already done so */
int tracing_update_buffers(void);

672 673 674 675 676 677
/* trace event type bit fields, not numeric */
enum {
	TRACE_EVENT_TYPE_PRINTF		= 1,
	TRACE_EVENT_TYPE_RAW		= 2,
};

678 679 680 681
struct ftrace_event_field {
	struct list_head	link;
	char			*name;
	char			*type;
682
	int			filter_type;
683 684
	int			offset;
	int			size;
685
	int			is_signed;
686 687
};

688 689 690
struct event_filter {
	int			n_preds;
	struct filter_pred	**preds;
691
	char			*filter_string;
692
	bool			no_reset;
693 694
};

695 696 697 698
struct event_subsystem {
	struct list_head	list;
	const char		*name;
	struct dentry		*entry;
699
	struct event_filter	*filter;
700
	int			nr_events;
701 702
};

T
Tom Zanussi 已提交
703 704
struct filter_pred;

705 706
typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
				 int val1, int val2);
T
Tom Zanussi 已提交
707 708 709 710

struct filter_pred {
	filter_pred_fn_t fn;
	u64 val;
711
	char str_val[MAX_FILTER_STR_VAL];
T
Tom Zanussi 已提交
712 713 714 715
	int str_len;
	char *field_name;
	int offset;
	int not;
716 717
	int op;
	int pop_n;
T
Tom Zanussi 已提交
718 719
};

720
extern void print_event_filter(struct ftrace_event_call *call,
721
			       struct trace_seq *s);
722 723 724 725 726
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,
727
					 struct trace_seq *s);
728
extern int filter_assign_type(const char *type);
T
Tom Zanussi 已提交
729

730
static inline int
731
filter_check_discard(struct ftrace_event_call *call, void *rec,
732
		     struct ring_buffer *buffer,
733 734
		     struct ring_buffer_event *event)
{
735
	if (unlikely(call->filter_active) && !filter_match_preds(call, rec)) {
736 737 738 739 740
		ring_buffer_discard_commit(buffer, event);
		return 1;
	}

	return 0;
741 742
}

743
extern struct mutex event_mutex;
744
extern struct list_head ftrace_events;
P
Peter Zijlstra 已提交
745

746 747 748
extern const char *__start___trace_bprintk_fmt[];
extern const char *__stop___trace_bprintk_fmt[];

749 750 751
#undef TRACE_EVENT_FORMAT
#define TRACE_EVENT_FORMAT(call, proto, args, fmt, tstruct, tpfmt)	\
	extern struct ftrace_event_call event_##call;
752 753
#undef TRACE_EVENT_FORMAT_NOFILTER
#define TRACE_EVENT_FORMAT_NOFILTER(call, proto, args, fmt, tstruct, tpfmt)
754 755
#include "trace_event_types.h"

756
#endif /* _LINUX_KERNEL_TRACE_H */