trace.h 25.0 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 16 17 18 19 20 21
enum trace_type {
	__TRACE_FIRST_TYPE = 0,

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

41
	__TRACE_LAST_TYPE,
42 43
};

44 45 46 47 48 49 50 51 52 53 54
/*
 * 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 {
	unsigned char		type;
	unsigned char		flags;
	unsigned char		preempt_count;
	int			pid;
55
	int			tgid;
56 57
};

58 59 60 61
/*
 * Function trace entry - function address and parent function addres:
 */
struct ftrace_entry {
62
	struct trace_entry	ent;
63 64 65
	unsigned long		ip;
	unsigned long		parent_ip;
};
66

67 68
/* Function call entry */
struct ftrace_graph_ent_entry {
69
	struct trace_entry		ent;
70 71 72
	struct ftrace_graph_ent		graph_ent;
};

73
/* Function return entry */
74
struct ftrace_graph_ret_entry {
75
	struct trace_entry		ent;
76
	struct ftrace_graph_ret		ret;
77
};
78
extern struct tracer boot_tracer;
79 80 81 82 83

/*
 * Context switch trace entry - which task (and prio) we switched from/to:
 */
struct ctx_switch_entry {
84
	struct trace_entry	ent;
85 86 87 88 89
	unsigned int		prev_pid;
	unsigned char		prev_prio;
	unsigned char		prev_state;
	unsigned int		next_pid;
	unsigned char		next_prio;
P
Peter Zijlstra 已提交
90
	unsigned char		next_state;
91
	unsigned int		next_cpu;
92 93
};

I
Ingo Molnar 已提交
94 95 96 97
/*
 * Special (free-form) trace entry:
 */
struct special_entry {
98
	struct trace_entry	ent;
I
Ingo Molnar 已提交
99 100 101 102 103
	unsigned long		arg1;
	unsigned long		arg2;
	unsigned long		arg3;
};

I
Ingo Molnar 已提交
104 105 106 107
/*
 * Stack-trace entry:
 */

I
Ingo Molnar 已提交
108
#define FTRACE_STACK_ENTRIES	8
I
Ingo Molnar 已提交
109 110

struct stack_entry {
111
	struct trace_entry	ent;
I
Ingo Molnar 已提交
112 113 114
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

115 116 117 118 119
struct userstack_entry {
	struct trace_entry	ent;
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

120
/*
121
 * trace_printk entry:
122
 */
123
struct bprint_entry {
124
	struct trace_entry	ent;
I
Ingo Molnar 已提交
125
	unsigned long		ip;
126
	const char		*fmt;
I
Ingo Molnar 已提交
127
	u32			buf[];
128 129
};

130 131 132 133 134 135
struct print_entry {
	struct trace_entry	ent;
	unsigned long		ip;
	char			buf[];
};

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
#define TRACE_OLD_SIZE		88

struct trace_field_cont {
	unsigned char		type;
	/* Temporary till we get rid of this completely */
	char			buf[TRACE_OLD_SIZE - 1];
};

struct trace_mmiotrace_rw {
	struct trace_entry	ent;
	struct mmiotrace_rw	rw;
};

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

154
struct trace_boot_call {
155
	struct trace_entry	ent;
156 157 158 159 160 161
	struct boot_trace_call boot_call;
};

struct trace_boot_ret {
	struct trace_entry	ent;
	struct boot_trace_ret boot_ret;
162 163
};

164 165
#define TRACE_FUNC_SIZE 30
#define TRACE_FILE_SIZE 20
166
struct trace_branch {
167 168 169 170 171 172 173
	struct trace_entry	ent;
	unsigned	        line;
	char			func[TRACE_FUNC_SIZE+1];
	char			file[TRACE_FILE_SIZE+1];
	char			correct;
};

174
struct hw_branch_entry {
175
	struct trace_entry	ent;
176 177
	u64			from;
	u64			to;
178 179
};

180 181 182 183 184
struct trace_power {
	struct trace_entry	ent;
	struct power_trace	state_data;
};

185 186 187 188 189 190
enum kmemtrace_type_id {
	KMEMTRACE_TYPE_KMALLOC = 0,	/* kmalloc() or kfree(). */
	KMEMTRACE_TYPE_CACHE,		/* kmem_cache_*(). */
	KMEMTRACE_TYPE_PAGES,		/* __get_free_pages() and friends. */
};

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
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;
};

209 210 211 212 213 214 215 216 217 218 219 220 221
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;
};


222 223 224
/*
 * trace_flag_type is an enumeration that holds different
 * states when a trace occurs. These are:
225
 *  IRQS_OFF		- interrupts were disabled
I
Ingo Molnar 已提交
226
 *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
227 228 229
 *  NEED_RESCED		- reschedule is requested
 *  HARDIRQ		- inside an interrupt handler
 *  SOFTIRQ		- inside a softirq handler
230 231 232
 */
enum trace_flag_type {
	TRACE_FLAG_IRQS_OFF		= 0x01,
233 234 235 236
	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
	TRACE_FLAG_NEED_RESCHED		= 0x04,
	TRACE_FLAG_HARDIRQ		= 0x08,
	TRACE_FLAG_SOFTIRQ		= 0x10,
237 238
};

239
#define TRACE_BUF_SIZE		1024
240 241 242 243 244 245 246 247

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

I
Ingo Molnar 已提交
250 251
	/* these fields get copied into max-trace: */
	unsigned long		trace_idx;
252
	unsigned long		overrun;
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
	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;
	cycle_t			preempt_timestamp;
	pid_t			pid;
	uid_t			uid;
	char			comm[TASK_COMM_LEN];
};

struct trace_iterator;

/*
 * 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 {
274
	struct ring_buffer	*buffer;
275 276 277
	unsigned long		entries;
	int			cpu;
	cycle_t			time_start;
278
	struct task_struct	*waiter;
279 280 281
	struct trace_array_cpu	*data[NR_CPUS];
};

S
Steven Rostedt 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
#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);	\
314
		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
S
Steven Rostedt 已提交
315
		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
316
		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
S
Steven Rostedt 已提交
317 318 319 320 321
		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);				\
322 323
		IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
		IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
324
		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
325 326 327 328
		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
			  TRACE_GRAPH_ENT);		\
		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
			  TRACE_GRAPH_RET);		\
329
		IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
I
Ingo Molnar 已提交
330
		IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
331 332 333 334
		IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry,	\
			  TRACE_KMEM_ALLOC);	\
		IF_ASSIGN(var, ent, struct kmemtrace_free_entry,	\
			  TRACE_KMEM_FREE);	\
335 336 337 338
		IF_ASSIGN(var, ent, struct syscall_trace_enter,		\
			  TRACE_SYSCALL_ENTER);				\
		IF_ASSIGN(var, ent, struct syscall_trace_exit,		\
			  TRACE_SYSCALL_EXIT);				\
S
Steven Rostedt 已提交
339 340
		__ftrace_bad_type();					\
	} while (0)
341 342 343 344 345

/* Return values for print_line callback */
enum print_line_t {
	TRACE_TYPE_PARTIAL_LINE	= 0,	/* Retry after flushing the seq */
	TRACE_TYPE_HANDLED	= 1,
346 347
	TRACE_TYPE_UNHANDLED	= 2,	/* Relay to other output functions */
	TRACE_TYPE_NO_CONSUME	= 3	/* Handled but ask to not consume */
348 349
};

350 351 352 353 354 355 356

/*
 * 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 已提交
357 358
	const char	*name; /* Will appear on the trace_options file */
	u32		bit; /* Mask assigned in val field in tracer_flags */
359 360 361 362 363 364 365 366
};

/*
 * 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 已提交
367
	struct tracer_opt	*opts;
368 369 370 371 372
};

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

373

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/**
 * 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
392 393 394
 */
struct tracer {
	const char		*name;
395
	int			(*init)(struct trace_array *tr);
396
	void			(*reset)(struct trace_array *tr);
397 398
	void			(*start)(struct trace_array *tr);
	void			(*stop)(struct trace_array *tr);
399
	void			(*open)(struct trace_iterator *iter);
400
	void			(*pipe_open)(struct trace_iterator *iter);
401
	void			(*wait_pipe)(struct trace_iterator *iter);
402
	void			(*close)(struct trace_iterator *iter);
403 404 405
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
406 407 408 409 410 411
	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 已提交
412 413 414 415
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
416
	void			(*print_header)(struct seq_file *m);
417
	enum print_line_t	(*print_line)(struct trace_iterator *iter);
418 419
	/* If you handled the flag setting, return 0 */
	int			(*set_flag)(u32 old_flags, u32 bit, int set);
420 421
	struct tracer		*next;
	int			print_max;
I
Ingo Molnar 已提交
422
	struct tracer_flags	*flags;
423
	struct tracer_stat	*stats;
424 425
};

S
Steven Rostedt 已提交
426 427 428
struct trace_seq {
	unsigned char		buffer[PAGE_SIZE];
	unsigned int		len;
429
	unsigned int		readpos;
S
Steven Rostedt 已提交
430 431
};

432 433 434 435 436 437 438 439
static inline void
trace_seq_init(struct trace_seq *s)
{
	s->len = 0;
	s->readpos = 0;
}


440 441
#define TRACE_PIPE_ALL_CPU	-1

442 443 444 445 446 447 448
/*
 * 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;
449
	void			*private;
450
	int			cpu_file;
451 452
	struct mutex		mutex;
	struct ring_buffer_iter	*buffer_iter[NR_CPUS];
I
Ingo Molnar 已提交
453

454 455
	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
456
	struct trace_entry	*ent;
I
Ingo Molnar 已提交
457
	int			cpu;
458
	u64			ts;
I
Ingo Molnar 已提交
459

460 461
	unsigned long		iter_flags;
	loff_t			pos;
462
	long			idx;
463

464
	cpumask_var_t		started;
465 466
};

467
int tracer_init(struct tracer *t, struct trace_array *tr);
468
int tracing_is_enabled(void);
469
void trace_wake_up(void);
470
void tracing_reset(struct trace_array *tr, int cpu);
471
void tracing_reset_online_cpus(struct trace_array *tr);
472
int tracing_open_generic(struct inode *inode, struct file *filp);
473 474 475 476 477 478
struct dentry *trace_create_file(const char *name,
				 mode_t mode,
				 struct dentry *parent,
				 void *data,
				 const struct file_operations *fops);

479
struct dentry *tracing_init_dentry(void);
I
Ingo Molnar 已提交
480 481
void init_tracer_sysprof_debugfs(struct dentry *d_tracer);

482 483 484 485 486 487 488 489 490 491 492
struct ring_buffer_event;

struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
						    unsigned char type,
						    unsigned long len,
						    unsigned long flags,
						    int pc);
void trace_buffer_unlock_commit(struct trace_array *tr,
				struct ring_buffer_event *event,
				unsigned long flags, int pc);

493 494 495 496 497
struct ring_buffer_event *
trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
				  unsigned long flags, int pc);
void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
					unsigned long flags, int pc);
498 499
void trace_nowake_buffer_unlock_commit(struct ring_buffer_event *event,
					unsigned long flags, int pc);
500

501 502
struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
						struct trace_array_cpu *data);
503 504 505 506

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

507
void tracing_generic_entry_update(struct trace_entry *entry,
508 509
				  unsigned long flags,
				  int pc);
510

511 512 513
void default_wait_pipe(struct trace_iterator *iter);
void poll_wait_pipe(struct trace_iterator *iter);

514 515 516 517
void ftrace(struct trace_array *tr,
			    struct trace_array_cpu *data,
			    unsigned long ip,
			    unsigned long parent_ip,
518
			    unsigned long flags, int pc);
519 520 521
void tracing_sched_switch_trace(struct trace_array *tr,
				struct task_struct *prev,
				struct task_struct *next,
522
				unsigned long flags, int pc);
523
void tracing_record_cmdline(struct task_struct *tsk);
524 525 526 527

void tracing_sched_wakeup_trace(struct trace_array *tr,
				struct task_struct *wakee,
				struct task_struct *cur,
528
				unsigned long flags, int pc);
I
Ingo Molnar 已提交
529 530 531 532
void trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
533
		   unsigned long arg3, int pc);
534 535 536
void trace_function(struct trace_array *tr,
		    unsigned long ip,
		    unsigned long parent_ip,
537
		    unsigned long flags, int pc);
538

539
void trace_graph_return(struct ftrace_graph_ret *trace);
540
int trace_graph_entry(struct ftrace_graph_ent *trace);
541

542 543
void tracing_start_cmdline_record(void);
void tracing_stop_cmdline_record(void);
S
Steven Rostedt 已提交
544 545 546
void tracing_sched_switch_assign_trace(struct trace_array *tr);
void tracing_stop_sched_switch_record(void);
void tracing_start_sched_switch_record(void);
547 548 549 550 551 552 553 554 555 556 557 558
int register_tracer(struct tracer *type);
void unregister_tracer(struct tracer *type);

extern unsigned long nsecs_to_usecs(unsigned long nsecs);

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

559 560 561 562
void __trace_stack(struct trace_array *tr,
		   unsigned long flags,
		   int skip, int pc);

I
Ingo Molnar 已提交
563
extern cycle_t ftrace_now(int cpu);
564 565 566 567

#ifdef CONFIG_CONTEXT_SWITCH_TRACER
typedef void
(*tracer_switch_func_t)(void *private,
M
Mathieu Desnoyers 已提交
568
			void *__rq,
569 570 571 572 573 574 575 576 577 578
			struct task_struct *prev,
			struct task_struct *next);

struct tracer_switch_ops {
	tracer_switch_func_t		func;
	void				*private;
	struct tracer_switch_ops	*next;
};
#endif /* CONFIG_CONTEXT_SWITCH_TRACER */

579
extern void trace_find_cmdline(int pid, char comm[]);
580

581 582
#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
583 584
#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
extern int DYN_FTRACE_TEST_NAME(void);
585 586
#endif

S
Steven Rostedt 已提交
587 588 589
#ifdef CONFIG_FTRACE_STARTUP_TEST
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
590 591
extern int trace_selftest_startup_function_graph(struct tracer *trace,
						 struct trace_array *tr);
S
Steven Rostedt 已提交
592 593 594 595 596 597 598 599
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 已提交
600 601
extern int trace_selftest_startup_nop(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
602 603
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
604 605
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
S
Steven Rostedt 已提交
606 607
extern int trace_selftest_startup_branch(struct tracer *trace,
					 struct trace_array *tr);
S
Steven Rostedt 已提交
608 609
#endif /* CONFIG_FTRACE_STARTUP_TEST */

I
Ingo Molnar 已提交
610
extern void *head_page(struct trace_array_cpu *data);
611
extern unsigned long long ns2usecs(cycle_t nsec);
612
extern int
613
trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
614
extern int
615
trace_vprintk(unsigned long ip, const char *fmt, va_list args);
I
Ingo Molnar 已提交
616

617 618
extern unsigned long trace_flags;

619
/* Standard output formatting function used for function return traces */
620 621
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern enum print_line_t print_graph_function(struct trace_iterator *iter);
622 623
extern enum print_line_t
trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

#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;
}
645
#else
646 647
static inline int ftrace_trace_addr(unsigned long addr)
{
648 649 650 651 652
	return 1;
}
static inline int ftrace_graph_addr(unsigned long addr)
{
	return 1;
653 654 655
}
#endif /* CONFIG_DYNAMIC_FTRACE */
#else /* CONFIG_FUNCTION_GRAPH_TRACER */
656
static inline enum print_line_t
657
print_graph_function(struct trace_iterator *iter)
658 659 660
{
	return TRACE_TYPE_UNHANDLED;
}
661
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
662

S
Steven Rostedt 已提交
663
extern struct pid *ftrace_pid_trace;
664 665 666

static inline int ftrace_trace_task(struct task_struct *task)
{
667
	if (!ftrace_pid_trace)
668 669 670 671 672
		return 1;

	return test_tsk_trace_trace(task);
}

S
Steven Rostedt 已提交
673 674 675 676 677 678 679
/*
 * 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.
 */
680 681 682 683 684 685 686 687 688 689
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 已提交
690
	TRACE_ITER_SCHED_TREE		= 0x200,
691
	TRACE_ITER_PRINTK		= 0x400,
692
	TRACE_ITER_PREEMPTONLY		= 0x800,
693
	TRACE_ITER_BRANCH		= 0x1000,
694
	TRACE_ITER_ANNOTATE		= 0x2000,
695
	TRACE_ITER_USERSTACKTRACE       = 0x4000,
696
	TRACE_ITER_SYM_USEROBJ          = 0x8000,
697
	TRACE_ITER_PRINTK_MSGONLY	= 0x10000,
698 699
	TRACE_ITER_CONTEXT_INFO		= 0x20000, /* Print pid/cpu/time */
	TRACE_ITER_LATENCY_FMT		= 0x40000,
700
	TRACE_ITER_GLOBAL_CLK		= 0x80000,
701
	TRACE_ITER_SLEEP_TIME		= 0x100000,
702
	TRACE_ITER_GRAPH_TIME		= 0x200000,
703 704
};

705 706 707 708 709 710 711
/*
 * 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)

712 713
extern struct tracer nop_trace;

714 715 716 717 718 719 720 721 722
/**
 * 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.
 *
723
 * To prevent this, we read the need_resched flag before
724 725 726 727
 * 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.
 *
728
 * The rational for doing the above is that if need_resched is set
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
 * 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.
749
 * If resched is set, then we are either inside an atomic or
750 751 752 753 754 755 756 757 758 759 760 761
 * 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();
}

762
#ifdef CONFIG_BRANCH_TRACER
763 764 765
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)
766
{
767 768
	if (trace_flags & TRACE_ITER_BRANCH)
		return enable_branch_tracing(tr);
769 770
	return 0;
}
771
static inline void trace_branch_disable(void)
772 773
{
	/* due to races, always disable */
774
	disable_branch_tracing();
775 776
}
#else
777
static inline int trace_branch_enable(struct trace_array *tr)
778 779 780
{
	return 0;
}
781
static inline void trace_branch_disable(void)
782 783
{
}
784
#endif /* CONFIG_BRANCH_TRACER */
785

786 787 788
/* set ring buffers to default size if not already done so */
int tracing_update_buffers(void);

789 790 791 792 793 794
/* trace event type bit fields, not numeric */
enum {
	TRACE_EVENT_TYPE_PRINTF		= 1,
	TRACE_EVENT_TYPE_RAW		= 2,
};

795 796 797 798 799 800 801 802
struct ftrace_event_field {
	struct list_head	link;
	char			*name;
	char			*type;
	int			offset;
	int			size;
};

803
struct ftrace_event_call {
804 805 806 807 808 809 810 811 812 813 814
	char			*name;
	char			*system;
	struct dentry		*dir;
	int			enabled;
	int			(*regfunc)(void);
	void			(*unregfunc)(void);
	int			id;
	int			(*raw_init)(void);
	int			(*show_format)(struct trace_seq *s);
	int			(*define_fields)(void);
	struct list_head	fields;
T
Tom Zanussi 已提交
815
	struct filter_pred	**preds;
P
Peter Zijlstra 已提交
816 817 818 819 820 821

#ifdef CONFIG_EVENT_PROFILE
	atomic_t	profile_count;
	int		(*profile_enable)(struct ftrace_event_call *);
	void		(*profile_disable)(struct ftrace_event_call *);
#endif
822 823
};

824 825 826 827 828 829 830 831 832 833 834 835
struct event_subsystem {
	struct list_head	list;
	const char		*name;
	struct dentry		*entry;
	struct filter_pred	**preds;
};

#define events_for_each(event)						\
	for (event = __start_ftrace_events;				\
	     (unsigned long)event < (unsigned long)__stop_ftrace_events; \
	     event++)

T
Tom Zanussi 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
#define MAX_FILTER_PRED 8

struct filter_pred;

typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);

struct filter_pred {
	filter_pred_fn_t fn;
	u64 val;
	char *str_val;
	int str_len;
	char *field_name;
	int offset;
	int not;
	int or;
	int compound;
	int clear;
};

855 856
int trace_define_field(struct ftrace_event_call *call, char *type,
		       char *name, int offset, int size);
T
Tom Zanussi 已提交
857
extern void filter_free_pred(struct filter_pred *pred);
858 859
extern void filter_print_preds(struct filter_pred **preds,
			       struct trace_seq *s);
T
Tom Zanussi 已提交
860 861 862 863 864
extern int filter_parse(char **pbuf, struct filter_pred *pred);
extern int filter_add_pred(struct ftrace_event_call *call,
			   struct filter_pred *pred);
extern void filter_free_preds(struct ftrace_event_call *call);
extern int filter_match_preds(struct ftrace_event_call *call, void *rec);
865 866 867
extern void filter_free_subsystem_preds(struct event_subsystem *system);
extern int filter_add_subsystem_pred(struct event_subsystem *system,
				     struct filter_pred *pred);
T
Tom Zanussi 已提交
868

869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
static inline void
filter_check_discard(struct ftrace_event_call *call, void *rec,
		     struct ring_buffer_event *event)
{
	if (unlikely(call->preds) && !filter_match_preds(call, rec))
		ring_buffer_event_discard(event);
}

#define __common_field(type, item)					\
	ret = trace_define_field(event_call, #type, "common_" #item,	\
				 offsetof(typeof(field.ent), item),	\
				 sizeof(field.ent.item));		\
	if (ret)							\
		return ret;

884 885 886 887
void event_trace_printk(unsigned long ip, const char *fmt, ...);
extern struct ftrace_event_call __start_ftrace_events[];
extern struct ftrace_event_call __stop_ftrace_events[];

P
Peter Zijlstra 已提交
888 889 890 891 892
#define for_each_event(event)						\
	for (event = __start_ftrace_events;				\
	     (unsigned long)event < (unsigned long)__stop_ftrace_events; \
	     event++)

893 894 895
extern const char *__start___trace_bprintk_fmt[];
extern const char *__stop___trace_bprintk_fmt[];

896 897 898 899 900
/*
 * 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.
 */
901 902 903 904 905 906 907 908 909 910 911 912 913 914
#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)

915 916 917 918 919
#undef TRACE_EVENT_FORMAT
#define TRACE_EVENT_FORMAT(call, proto, args, fmt, tstruct, tpfmt)	\
	extern struct ftrace_event_call event_##call;
#include "trace_event_types.h"

920
#endif /* _LINUX_KERNEL_TRACE_H */