trace.h 23.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/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
/*
 * Function trace entry - function address and parent function addres:
 */
struct ftrace_entry {
49
	struct trace_entry	ent;
50 51 52
	unsigned long		ip;
	unsigned long		parent_ip;
};
53

54 55
/* Function call entry */
struct ftrace_graph_ent_entry {
56
	struct trace_entry		ent;
57 58 59
	struct ftrace_graph_ent		graph_ent;
};

60
/* Function return entry */
61
struct ftrace_graph_ret_entry {
62
	struct trace_entry		ent;
63
	struct ftrace_graph_ret		ret;
64
};
65
extern struct tracer boot_tracer;
66 67 68 69 70

/*
 * Context switch trace entry - which task (and prio) we switched from/to:
 */
struct ctx_switch_entry {
71
	struct trace_entry	ent;
72 73 74 75 76
	unsigned int		prev_pid;
	unsigned char		prev_prio;
	unsigned char		prev_state;
	unsigned int		next_pid;
	unsigned char		next_prio;
P
Peter Zijlstra 已提交
77
	unsigned char		next_state;
78
	unsigned int		next_cpu;
79 80
};

I
Ingo Molnar 已提交
81 82 83 84
/*
 * Special (free-form) trace entry:
 */
struct special_entry {
85
	struct trace_entry	ent;
I
Ingo Molnar 已提交
86 87 88 89 90
	unsigned long		arg1;
	unsigned long		arg2;
	unsigned long		arg3;
};

I
Ingo Molnar 已提交
91 92 93 94
/*
 * Stack-trace entry:
 */

I
Ingo Molnar 已提交
95
#define FTRACE_STACK_ENTRIES	8
I
Ingo Molnar 已提交
96 97

struct stack_entry {
98
	struct trace_entry	ent;
I
Ingo Molnar 已提交
99 100 101
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

102 103 104 105 106
struct userstack_entry {
	struct trace_entry	ent;
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

107
/*
108
 * trace_printk entry:
109
 */
110
struct bprint_entry {
111
	struct trace_entry	ent;
I
Ingo Molnar 已提交
112
	unsigned long		ip;
113
	const char		*fmt;
I
Ingo Molnar 已提交
114
	u32			buf[];
115 116
};

117 118 119 120 121 122
struct print_entry {
	struct trace_entry	ent;
	unsigned long		ip;
	char			buf[];
};

123 124 125 126 127 128 129 130 131 132
struct trace_mmiotrace_rw {
	struct trace_entry	ent;
	struct mmiotrace_rw	rw;
};

struct trace_mmiotrace_map {
	struct trace_entry	ent;
	struct mmiotrace_map	map;
};

133
struct trace_boot_call {
134
	struct trace_entry	ent;
135 136 137 138 139 140
	struct boot_trace_call boot_call;
};

struct trace_boot_ret {
	struct trace_entry	ent;
	struct boot_trace_ret boot_ret;
141 142
};

143 144
#define TRACE_FUNC_SIZE 30
#define TRACE_FILE_SIZE 20
145
struct trace_branch {
146 147 148 149 150 151 152
	struct trace_entry	ent;
	unsigned	        line;
	char			func[TRACE_FUNC_SIZE+1];
	char			file[TRACE_FILE_SIZE+1];
	char			correct;
};

153
struct hw_branch_entry {
154
	struct trace_entry	ent;
155 156
	u64			from;
	u64			to;
157 158
};

159 160 161 162 163
struct trace_power {
	struct trace_entry	ent;
	struct power_trace	state_data;
};

164 165 166 167 168 169
enum kmemtrace_type_id {
	KMEMTRACE_TYPE_KMALLOC = 0,	/* kmalloc() or kfree(). */
	KMEMTRACE_TYPE_CACHE,		/* kmem_cache_*(). */
	KMEMTRACE_TYPE_PAGES,		/* __get_free_pages() and friends. */
};

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
struct kmemtrace_alloc_entry {
	struct trace_entry	ent;
	enum kmemtrace_type_id type_id;
	unsigned long call_site;
	const void *ptr;
	size_t bytes_req;
	size_t bytes_alloc;
	gfp_t gfp_flags;
	int node;
};

struct kmemtrace_free_entry {
	struct trace_entry	ent;
	enum kmemtrace_type_id type_id;
	unsigned long call_site;
	const void *ptr;
};

188 189 190 191 192 193 194 195 196 197 198 199 200
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;
};


201 202 203
/*
 * trace_flag_type is an enumeration that holds different
 * states when a trace occurs. These are:
204
 *  IRQS_OFF		- interrupts were disabled
I
Ingo Molnar 已提交
205
 *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
206 207 208
 *  NEED_RESCED		- reschedule is requested
 *  HARDIRQ		- inside an interrupt handler
 *  SOFTIRQ		- inside a softirq handler
209 210 211
 */
enum trace_flag_type {
	TRACE_FLAG_IRQS_OFF		= 0x01,
212 213 214 215
	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
	TRACE_FLAG_NEED_RESCHED		= 0x04,
	TRACE_FLAG_HARDIRQ		= 0x08,
	TRACE_FLAG_SOFTIRQ		= 0x10,
216 217
};

218
#define TRACE_BUF_SIZE		1024
219 220 221 222 223 224 225 226

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

229 230 231 232 233 234 235
	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;
236
	unsigned long		skipped_entries;
237 238 239 240 241 242 243 244 245 246 247 248
	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 {
249
	struct ring_buffer	*buffer;
250 251 252
	unsigned long		entries;
	int			cpu;
	cycle_t			time_start;
253
	struct task_struct	*waiter;
254 255 256
	struct trace_array_cpu	*data[NR_CPUS];
};

S
Steven Rostedt 已提交
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
#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);	\
289
		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
S
Steven Rostedt 已提交
290
		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
291
		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
S
Steven Rostedt 已提交
292 293 294 295 296
		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);				\
297 298
		IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
		IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
299
		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
300 301 302 303
		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
			  TRACE_GRAPH_ENT);		\
		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
			  TRACE_GRAPH_RET);		\
304
		IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
I
Ingo Molnar 已提交
305
		IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
306 307 308 309
		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 已提交
310 311
		__ftrace_bad_type();					\
	} while (0)
312

313 314 315 316 317 318
/*
 * 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 已提交
319 320
	const char	*name; /* Will appear on the trace_options file */
	u32		bit; /* Mask assigned in val field in tracer_flags */
321 322 323 324 325 326 327 328
};

/*
 * 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 已提交
329
	struct tracer_opt	*opts;
330 331 332 333 334
};

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

335

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
/**
 * 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
354 355 356
 */
struct tracer {
	const char		*name;
357
	int			(*init)(struct trace_array *tr);
358
	void			(*reset)(struct trace_array *tr);
359 360
	void			(*start)(struct trace_array *tr);
	void			(*stop)(struct trace_array *tr);
361
	void			(*open)(struct trace_iterator *iter);
362
	void			(*pipe_open)(struct trace_iterator *iter);
363
	void			(*wait_pipe)(struct trace_iterator *iter);
364
	void			(*close)(struct trace_iterator *iter);
365 366 367
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
368 369 370 371 372 373
	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 已提交
374 375 376 377
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
378
	void			(*print_header)(struct seq_file *m);
379
	enum print_line_t	(*print_line)(struct trace_iterator *iter);
380 381
	/* If you handled the flag setting, return 0 */
	int			(*set_flag)(u32 old_flags, u32 bit, int set);
382 383
	struct tracer		*next;
	int			print_max;
I
Ingo Molnar 已提交
384
	struct tracer_flags	*flags;
385
	struct tracer_stat	*stats;
386 387
};

388

389 390
#define TRACE_PIPE_ALL_CPU	-1

391
int tracer_init(struct tracer *t, struct trace_array *tr);
392
int tracing_is_enabled(void);
393
void trace_wake_up(void);
394
void tracing_reset(struct trace_array *tr, int cpu);
395
void tracing_reset_online_cpus(struct trace_array *tr);
396 397
void tracing_reset_current(int cpu);
void tracing_reset_current_online_cpus(void);
398
int tracing_open_generic(struct inode *inode, struct file *filp);
399 400 401 402 403 404
struct dentry *trace_create_file(const char *name,
				 mode_t mode,
				 struct dentry *parent,
				 void *data,
				 const struct file_operations *fops);

405
struct dentry *tracing_init_dentry(void);
I
Ingo Molnar 已提交
406 407
void init_tracer_sysprof_debugfs(struct dentry *d_tracer);

408 409
struct ring_buffer_event;

410 411 412 413 414 415 416
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,
417 418 419
				struct ring_buffer_event *event,
				unsigned long flags, int pc);

420 421
struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
						struct trace_array_cpu *data);
422 423 424 425

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

426 427 428
void default_wait_pipe(struct trace_iterator *iter);
void poll_wait_pipe(struct trace_iterator *iter);

429 430 431 432
void ftrace(struct trace_array *tr,
			    struct trace_array_cpu *data,
			    unsigned long ip,
			    unsigned long parent_ip,
433
			    unsigned long flags, int pc);
434 435 436
void tracing_sched_switch_trace(struct trace_array *tr,
				struct task_struct *prev,
				struct task_struct *next,
437
				unsigned long flags, int pc);
438 439 440 441

void tracing_sched_wakeup_trace(struct trace_array *tr,
				struct task_struct *wakee,
				struct task_struct *cur,
442
				unsigned long flags, int pc);
I
Ingo Molnar 已提交
443 444 445 446
void trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
447
		   unsigned long arg3, int pc);
448 449 450
void trace_function(struct trace_array *tr,
		    unsigned long ip,
		    unsigned long parent_ip,
451
		    unsigned long flags, int pc);
452

453
void trace_graph_return(struct ftrace_graph_ret *trace);
454
int trace_graph_entry(struct ftrace_graph_ent *trace);
455
void set_graph_array(struct trace_array *tr);
456

457 458
void tracing_start_cmdline_record(void);
void tracing_stop_cmdline_record(void);
S
Steven Rostedt 已提交
459 460 461
void tracing_sched_switch_assign_trace(struct trace_array *tr);
void tracing_stop_sched_switch_record(void);
void tracing_start_sched_switch_record(void);
462 463 464 465 466
int register_tracer(struct tracer *type);
void unregister_tracer(struct tracer *type);

extern unsigned long nsecs_to_usecs(unsigned long nsecs);

467
#ifdef CONFIG_TRACER_MAX_TRACE
468 469 470 471 472 473
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);
474
#endif /* CONFIG_TRACER_MAX_TRACE */
475

476
#ifdef CONFIG_STACKTRACE
477
void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
478 479
			int skip, int pc);

480
void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
			    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 */
501

I
Ingo Molnar 已提交
502
extern cycle_t ftrace_now(int cpu);
503

504
extern void trace_find_cmdline(int pid, char comm[]);
505

506 507
#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
508 509
#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
extern int DYN_FTRACE_TEST_NAME(void);
510 511
#endif

512 513
extern int ring_buffer_expanded;
extern bool tracing_selftest_disabled;
514
DECLARE_PER_CPU(local_t, ftrace_cpu_disabled);
515

S
Steven Rostedt 已提交
516 517 518
#ifdef CONFIG_FTRACE_STARTUP_TEST
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
519 520
extern int trace_selftest_startup_function_graph(struct tracer *trace,
						 struct trace_array *tr);
S
Steven Rostedt 已提交
521 522 523 524 525 526 527 528
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 已提交
529 530
extern int trace_selftest_startup_nop(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
531 532
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
533 534
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
S
Steven Rostedt 已提交
535 536
extern int trace_selftest_startup_branch(struct tracer *trace,
					 struct trace_array *tr);
537 538
extern int trace_selftest_startup_hw_branches(struct tracer *trace,
					      struct trace_array *tr);
S
Steven Rostedt 已提交
539 540
#endif /* CONFIG_FTRACE_STARTUP_TEST */

I
Ingo Molnar 已提交
541
extern void *head_page(struct trace_array_cpu *data);
542
extern unsigned long long ns2usecs(cycle_t nsec);
543
extern int
544
trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
545
extern int
546
trace_vprintk(unsigned long ip, const char *fmt, va_list args);
547 548 549 550 551
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 已提交
552

553 554
extern unsigned long trace_flags;

555 556
extern int trace_clock_id;

557
/* Standard output formatting function used for function return traces */
558 559
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern enum print_line_t print_graph_function(struct trace_iterator *iter);
560 561
extern enum print_line_t
trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

#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;
}
583
#else
584 585
static inline int ftrace_trace_addr(unsigned long addr)
{
586 587 588 589 590
	return 1;
}
static inline int ftrace_graph_addr(unsigned long addr)
{
	return 1;
591 592 593
}
#endif /* CONFIG_DYNAMIC_FTRACE */
#else /* CONFIG_FUNCTION_GRAPH_TRACER */
594
static inline enum print_line_t
595
print_graph_function(struct trace_iterator *iter)
596 597 598
{
	return TRACE_TYPE_UNHANDLED;
}
599
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
600

S
Steven Rostedt 已提交
601
extern struct pid *ftrace_pid_trace;
602

603
#ifdef CONFIG_FUNCTION_TRACER
604 605
static inline int ftrace_trace_task(struct task_struct *task)
{
606
	if (!ftrace_pid_trace)
607 608 609 610
		return 1;

	return test_tsk_trace_trace(task);
}
611 612 613 614 615 616
#else
static inline int ftrace_trace_task(struct task_struct *task)
{
	return 1;
}
#endif
617

S
Steven Rostedt 已提交
618 619 620 621 622 623 624
/*
 * 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.
 */
625 626 627 628 629 630 631 632 633 634
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 已提交
635
	TRACE_ITER_SCHED_TREE		= 0x200,
636
	TRACE_ITER_PRINTK		= 0x400,
637
	TRACE_ITER_PREEMPTONLY		= 0x800,
638
	TRACE_ITER_BRANCH		= 0x1000,
639
	TRACE_ITER_ANNOTATE		= 0x2000,
640
	TRACE_ITER_USERSTACKTRACE       = 0x4000,
641
	TRACE_ITER_SYM_USEROBJ          = 0x8000,
642
	TRACE_ITER_PRINTK_MSGONLY	= 0x10000,
643 644
	TRACE_ITER_CONTEXT_INFO		= 0x20000, /* Print pid/cpu/time */
	TRACE_ITER_LATENCY_FMT		= 0x40000,
645 646
	TRACE_ITER_SLEEP_TIME		= 0x80000,
	TRACE_ITER_GRAPH_TIME		= 0x100000,
647 648
};

649 650 651 652 653 654 655
/*
 * 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)

656 657
extern struct tracer nop_trace;

658 659 660 661 662 663 664 665 666
/**
 * 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.
 *
667
 * To prevent this, we read the need_resched flag before
668 669 670 671
 * 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.
 *
672
 * The rational for doing the above is that if need_resched is set
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
 * 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.
693
 * If resched is set, then we are either inside an atomic or
694 695 696 697 698 699 700 701 702 703 704 705
 * 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();
}

706
#ifdef CONFIG_BRANCH_TRACER
707 708 709
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)
710
{
711 712
	if (trace_flags & TRACE_ITER_BRANCH)
		return enable_branch_tracing(tr);
713 714
	return 0;
}
715
static inline void trace_branch_disable(void)
716 717
{
	/* due to races, always disable */
718
	disable_branch_tracing();
719 720
}
#else
721
static inline int trace_branch_enable(struct trace_array *tr)
722 723 724
{
	return 0;
}
725
static inline void trace_branch_disable(void)
726 727
{
}
728
#endif /* CONFIG_BRANCH_TRACER */
729

730 731 732
/* set ring buffers to default size if not already done so */
int tracing_update_buffers(void);

733 734 735 736 737 738
/* trace event type bit fields, not numeric */
enum {
	TRACE_EVENT_TYPE_PRINTF		= 1,
	TRACE_EVENT_TYPE_RAW		= 2,
};

739 740 741 742
struct ftrace_event_field {
	struct list_head	link;
	char			*name;
	char			*type;
743
	int			filter_type;
744 745
	int			offset;
	int			size;
746
	int			is_signed;
747 748
};

749 750 751
struct event_filter {
	int			n_preds;
	struct filter_pred	**preds;
752
	char			*filter_string;
753
	bool			no_reset;
754 755
};

756 757 758 759
struct event_subsystem {
	struct list_head	list;
	const char		*name;
	struct dentry		*entry;
760
	struct event_filter	*filter;
761
	int			nr_events;
762 763
};

T
Tom Zanussi 已提交
764 765
struct filter_pred;

766 767
typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
				 int val1, int val2);
T
Tom Zanussi 已提交
768 769 770 771

struct filter_pred {
	filter_pred_fn_t fn;
	u64 val;
772
	char str_val[MAX_FILTER_STR_VAL];
T
Tom Zanussi 已提交
773 774 775 776
	int str_len;
	char *field_name;
	int offset;
	int not;
777 778
	int op;
	int pop_n;
T
Tom Zanussi 已提交
779 780
};

781
extern void print_event_filter(struct ftrace_event_call *call,
782
			       struct trace_seq *s);
783 784 785 786 787
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,
788
					 struct trace_seq *s);
789
extern int filter_assign_type(const char *type);
T
Tom Zanussi 已提交
790

791
static inline int
792
filter_check_discard(struct ftrace_event_call *call, void *rec,
793
		     struct ring_buffer *buffer,
794 795
		     struct ring_buffer_event *event)
{
796
	if (unlikely(call->filter_active) && !filter_match_preds(call, rec)) {
797 798 799 800 801
		ring_buffer_discard_commit(buffer, event);
		return 1;
	}

	return 0;
802 803
}

804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
#define DEFINE_COMPARISON_PRED(type)					\
static int filter_pred_##type(struct filter_pred *pred, void *event,	\
			      int val1, int val2)			\
{									\
	type *addr = (type *)(event + pred->offset);			\
	type val = (type)pred->val;					\
	int match = 0;							\
									\
	switch (pred->op) {						\
	case OP_LT:							\
		match = (*addr < val);					\
		break;							\
	case OP_LE:							\
		match = (*addr <= val);					\
		break;							\
	case OP_GT:							\
		match = (*addr > val);					\
		break;							\
	case OP_GE:							\
		match = (*addr >= val);					\
		break;							\
	default:							\
		break;							\
	}								\
									\
	return match;							\
}

#define DEFINE_EQUALITY_PRED(size)					\
static int filter_pred_##size(struct filter_pred *pred, void *event,	\
			      int val1, int val2)			\
{									\
	u##size *addr = (u##size *)(event + pred->offset);		\
	u##size val = (u##size)pred->val;				\
	int match;							\
									\
	match = (val == *addr) ^ pred->not;				\
									\
	return match;							\
}

845
extern struct mutex event_mutex;
846
extern struct list_head ftrace_events;
P
Peter Zijlstra 已提交
847

848 849 850
extern const char *__start___trace_bprintk_fmt[];
extern const char *__stop___trace_bprintk_fmt[];

851 852 853
#undef TRACE_EVENT_FORMAT
#define TRACE_EVENT_FORMAT(call, proto, args, fmt, tstruct, tpfmt)	\
	extern struct ftrace_event_call event_##call;
854 855
#undef TRACE_EVENT_FORMAT_NOFILTER
#define TRACE_EVENT_FORMAT_NOFILTER(call, proto, args, fmt, tstruct, tpfmt)
856 857
#include "trace_event_types.h"

858
#endif /* _LINUX_KERNEL_TRACE_H */