Loading...
1
2#ifndef _LINUX_KERNEL_TRACE_H
3#define _LINUX_KERNEL_TRACE_H
4
5#include <linux/fs.h>
6#include <linux/atomic.h>
7#include <linux/sched.h>
8#include <linux/clocksource.h>
9#include <linux/ring_buffer.h>
10#include <linux/mmiotrace.h>
11#include <linux/tracepoint.h>
12#include <linux/ftrace.h>
13#include <linux/hw_breakpoint.h>
14#include <linux/trace_seq.h>
15#include <linux/trace_events.h>
16#include <linux/compiler.h>
17#include <linux/trace_seq.h>
18
19#ifdef CONFIG_FTRACE_SYSCALLS
20#include <asm/unistd.h> /* For NR_SYSCALLS */
21#include <asm/syscall.h> /* some archs define it here */
22#endif
23
24enum trace_type {
25 __TRACE_FIRST_TYPE = 0,
26
27 TRACE_FN,
28 TRACE_CTX,
29 TRACE_WAKE,
30 TRACE_STACK,
31 TRACE_PRINT,
32 TRACE_BPRINT,
33 TRACE_MMIO_RW,
34 TRACE_MMIO_MAP,
35 TRACE_BRANCH,
36 TRACE_GRAPH_RET,
37 TRACE_GRAPH_ENT,
38 TRACE_USER_STACK,
39 TRACE_BLK,
40 TRACE_BPUTS,
41
42 __TRACE_LAST_TYPE,
43};
44
45
46#undef __field
47#define __field(type, item) type item;
48
49#undef __field_struct
50#define __field_struct(type, item) __field(type, item)
51
52#undef __field_desc
53#define __field_desc(type, container, item)
54
55#undef __array
56#define __array(type, item, size) type item[size];
57
58#undef __array_desc
59#define __array_desc(type, container, item, size)
60
61#undef __dynamic_array
62#define __dynamic_array(type, item) type item[];
63
64#undef F_STRUCT
65#define F_STRUCT(args...) args
66
67#undef FTRACE_ENTRY
68#define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
69 struct struct_name { \
70 struct trace_entry ent; \
71 tstruct \
72 }
73
74#undef FTRACE_ENTRY_DUP
75#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
76
77#undef FTRACE_ENTRY_REG
78#define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
79 filter, regfn) \
80 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
81 filter)
82
83#include "trace_entries.h"
84
85/*
86 * syscalls are special, and need special handling, this is why
87 * they are not included in trace_entries.h
88 */
89struct syscall_trace_enter {
90 struct trace_entry ent;
91 int nr;
92 unsigned long args[];
93};
94
95struct syscall_trace_exit {
96 struct trace_entry ent;
97 int nr;
98 long ret;
99};
100
101struct kprobe_trace_entry_head {
102 struct trace_entry ent;
103 unsigned long ip;
104};
105
106struct kretprobe_trace_entry_head {
107 struct trace_entry ent;
108 unsigned long func;
109 unsigned long ret_ip;
110};
111
112/*
113 * trace_flag_type is an enumeration that holds different
114 * states when a trace occurs. These are:
115 * IRQS_OFF - interrupts were disabled
116 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
117 * NEED_RESCHED - reschedule is requested
118 * HARDIRQ - inside an interrupt handler
119 * SOFTIRQ - inside a softirq handler
120 */
121enum trace_flag_type {
122 TRACE_FLAG_IRQS_OFF = 0x01,
123 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
124 TRACE_FLAG_NEED_RESCHED = 0x04,
125 TRACE_FLAG_HARDIRQ = 0x08,
126 TRACE_FLAG_SOFTIRQ = 0x10,
127 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
128 TRACE_FLAG_NMI = 0x40,
129};
130
131#define TRACE_BUF_SIZE 1024
132
133struct trace_array;
134
135/*
136 * The CPU trace array - it consists of thousands of trace entries
137 * plus some other descriptor data: (for example which task started
138 * the trace, etc.)
139 */
140struct trace_array_cpu {
141 atomic_t disabled;
142 void *buffer_page; /* ring buffer spare */
143
144 unsigned long entries;
145 unsigned long saved_latency;
146 unsigned long critical_start;
147 unsigned long critical_end;
148 unsigned long critical_sequence;
149 unsigned long nice;
150 unsigned long policy;
151 unsigned long rt_priority;
152 unsigned long skipped_entries;
153 cycle_t preempt_timestamp;
154 pid_t pid;
155 kuid_t uid;
156 char comm[TASK_COMM_LEN];
157
158 bool ignore_pid;
159};
160
161struct tracer;
162struct trace_option_dentry;
163
164struct trace_buffer {
165 struct trace_array *tr;
166 struct ring_buffer *buffer;
167 struct trace_array_cpu __percpu *data;
168 cycle_t time_start;
169 int cpu;
170};
171
172#define TRACE_FLAGS_MAX_SIZE 32
173
174struct trace_options {
175 struct tracer *tracer;
176 struct trace_option_dentry *topts;
177};
178
179struct trace_pid_list {
180 unsigned int nr_pids;
181 int order;
182 pid_t *pids;
183};
184
185/*
186 * The trace array - an array of per-CPU trace arrays. This is the
187 * highest level data structure that individual tracers deal with.
188 * They have on/off state as well:
189 */
190struct trace_array {
191 struct list_head list;
192 char *name;
193 struct trace_buffer trace_buffer;
194#ifdef CONFIG_TRACER_MAX_TRACE
195 /*
196 * The max_buffer is used to snapshot the trace when a maximum
197 * latency is reached, or when the user initiates a snapshot.
198 * Some tracers will use this to store a maximum trace while
199 * it continues examining live traces.
200 *
201 * The buffers for the max_buffer are set up the same as the trace_buffer
202 * When a snapshot is taken, the buffer of the max_buffer is swapped
203 * with the buffer of the trace_buffer and the buffers are reset for
204 * the trace_buffer so the tracing can continue.
205 */
206 struct trace_buffer max_buffer;
207 bool allocated_snapshot;
208 unsigned long max_latency;
209#endif
210 struct trace_pid_list __rcu *filtered_pids;
211 /*
212 * max_lock is used to protect the swapping of buffers
213 * when taking a max snapshot. The buffers themselves are
214 * protected by per_cpu spinlocks. But the action of the swap
215 * needs its own lock.
216 *
217 * This is defined as a arch_spinlock_t in order to help
218 * with performance when lockdep debugging is enabled.
219 *
220 * It is also used in other places outside the update_max_tr
221 * so it needs to be defined outside of the
222 * CONFIG_TRACER_MAX_TRACE.
223 */
224 arch_spinlock_t max_lock;
225 int buffer_disabled;
226#ifdef CONFIG_FTRACE_SYSCALLS
227 int sys_refcount_enter;
228 int sys_refcount_exit;
229 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
230 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
231#endif
232 int stop_count;
233 int clock_id;
234 int nr_topts;
235 struct tracer *current_trace;
236 unsigned int trace_flags;
237 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
238 unsigned int flags;
239 raw_spinlock_t start_lock;
240 struct dentry *dir;
241 struct dentry *options;
242 struct dentry *percpu_dir;
243 struct dentry *event_dir;
244 struct trace_options *topts;
245 struct list_head systems;
246 struct list_head events;
247 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
248 int ref;
249#ifdef CONFIG_FUNCTION_TRACER
250 struct ftrace_ops *ops;
251 /* function tracing enabled */
252 int function_enabled;
253#endif
254};
255
256enum {
257 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
258};
259
260extern struct list_head ftrace_trace_arrays;
261
262extern struct mutex trace_types_lock;
263
264extern int trace_array_get(struct trace_array *tr);
265extern void trace_array_put(struct trace_array *tr);
266
267/*
268 * The global tracer (top) should be the first trace array added,
269 * but we check the flag anyway.
270 */
271static inline struct trace_array *top_trace_array(void)
272{
273 struct trace_array *tr;
274
275 if (list_empty(&ftrace_trace_arrays))
276 return NULL;
277
278 tr = list_entry(ftrace_trace_arrays.prev,
279 typeof(*tr), list);
280 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
281 return tr;
282}
283
284#define FTRACE_CMP_TYPE(var, type) \
285 __builtin_types_compatible_p(typeof(var), type *)
286
287#undef IF_ASSIGN
288#define IF_ASSIGN(var, entry, etype, id) \
289 if (FTRACE_CMP_TYPE(var, etype)) { \
290 var = (typeof(var))(entry); \
291 WARN_ON(id && (entry)->type != id); \
292 break; \
293 }
294
295/* Will cause compile errors if type is not found. */
296extern void __ftrace_bad_type(void);
297
298/*
299 * The trace_assign_type is a verifier that the entry type is
300 * the same as the type being assigned. To add new types simply
301 * add a line with the following format:
302 *
303 * IF_ASSIGN(var, ent, type, id);
304 *
305 * Where "type" is the trace type that includes the trace_entry
306 * as the "ent" item. And "id" is the trace identifier that is
307 * used in the trace_type enum.
308 *
309 * If the type can have more than one id, then use zero.
310 */
311#define trace_assign_type(var, ent) \
312 do { \
313 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
314 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
315 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
316 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
317 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
318 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
319 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
320 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
321 TRACE_MMIO_RW); \
322 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
323 TRACE_MMIO_MAP); \
324 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
325 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
326 TRACE_GRAPH_ENT); \
327 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
328 TRACE_GRAPH_RET); \
329 __ftrace_bad_type(); \
330 } while (0)
331
332/*
333 * An option specific to a tracer. This is a boolean value.
334 * The bit is the bit index that sets its value on the
335 * flags value in struct tracer_flags.
336 */
337struct tracer_opt {
338 const char *name; /* Will appear on the trace_options file */
339 u32 bit; /* Mask assigned in val field in tracer_flags */
340};
341
342/*
343 * The set of specific options for a tracer. Your tracer
344 * have to set the initial value of the flags val.
345 */
346struct tracer_flags {
347 u32 val;
348 struct tracer_opt *opts;
349 struct tracer *trace;
350};
351
352/* Makes more easy to define a tracer opt */
353#define TRACER_OPT(s, b) .name = #s, .bit = b
354
355
356struct trace_option_dentry {
357 struct tracer_opt *opt;
358 struct tracer_flags *flags;
359 struct trace_array *tr;
360 struct dentry *entry;
361};
362
363/**
364 * struct tracer - a specific tracer and its callbacks to interact with tracefs
365 * @name: the name chosen to select it on the available_tracers file
366 * @init: called when one switches to this tracer (echo name > current_tracer)
367 * @reset: called when one switches to another tracer
368 * @start: called when tracing is unpaused (echo 1 > tracing_on)
369 * @stop: called when tracing is paused (echo 0 > tracing_on)
370 * @update_thresh: called when tracing_thresh is updated
371 * @open: called when the trace file is opened
372 * @pipe_open: called when the trace_pipe file is opened
373 * @close: called when the trace file is released
374 * @pipe_close: called when the trace_pipe file is released
375 * @read: override the default read callback on trace_pipe
376 * @splice_read: override the default splice_read callback on trace_pipe
377 * @selftest: selftest to run on boot (see trace_selftest.c)
378 * @print_headers: override the first lines that describe your columns
379 * @print_line: callback that prints a trace
380 * @set_flag: signals one of your private flags changed (trace_options file)
381 * @flags: your private flags
382 */
383struct tracer {
384 const char *name;
385 int (*init)(struct trace_array *tr);
386 void (*reset)(struct trace_array *tr);
387 void (*start)(struct trace_array *tr);
388 void (*stop)(struct trace_array *tr);
389 int (*update_thresh)(struct trace_array *tr);
390 void (*open)(struct trace_iterator *iter);
391 void (*pipe_open)(struct trace_iterator *iter);
392 void (*close)(struct trace_iterator *iter);
393 void (*pipe_close)(struct trace_iterator *iter);
394 ssize_t (*read)(struct trace_iterator *iter,
395 struct file *filp, char __user *ubuf,
396 size_t cnt, loff_t *ppos);
397 ssize_t (*splice_read)(struct trace_iterator *iter,
398 struct file *filp,
399 loff_t *ppos,
400 struct pipe_inode_info *pipe,
401 size_t len,
402 unsigned int flags);
403#ifdef CONFIG_FTRACE_STARTUP_TEST
404 int (*selftest)(struct tracer *trace,
405 struct trace_array *tr);
406#endif
407 void (*print_header)(struct seq_file *m);
408 enum print_line_t (*print_line)(struct trace_iterator *iter);
409 /* If you handled the flag setting, return 0 */
410 int (*set_flag)(struct trace_array *tr,
411 u32 old_flags, u32 bit, int set);
412 /* Return 0 if OK with change, else return non-zero */
413 int (*flag_changed)(struct trace_array *tr,
414 u32 mask, int set);
415 struct tracer *next;
416 struct tracer_flags *flags;
417 int enabled;
418 int ref;
419 bool print_max;
420 bool allow_instances;
421#ifdef CONFIG_TRACER_MAX_TRACE
422 bool use_max_tr;
423#endif
424};
425
426
427/* Only current can touch trace_recursion */
428
429/*
430 * For function tracing recursion:
431 * The order of these bits are important.
432 *
433 * When function tracing occurs, the following steps are made:
434 * If arch does not support a ftrace feature:
435 * call internal function (uses INTERNAL bits) which calls...
436 * If callback is registered to the "global" list, the list
437 * function is called and recursion checks the GLOBAL bits.
438 * then this function calls...
439 * The function callback, which can use the FTRACE bits to
440 * check for recursion.
441 *
442 * Now if the arch does not suppport a feature, and it calls
443 * the global list function which calls the ftrace callback
444 * all three of these steps will do a recursion protection.
445 * There's no reason to do one if the previous caller already
446 * did. The recursion that we are protecting against will
447 * go through the same steps again.
448 *
449 * To prevent the multiple recursion checks, if a recursion
450 * bit is set that is higher than the MAX bit of the current
451 * check, then we know that the check was made by the previous
452 * caller, and we can skip the current check.
453 */
454enum {
455 TRACE_BUFFER_BIT,
456 TRACE_BUFFER_NMI_BIT,
457 TRACE_BUFFER_IRQ_BIT,
458 TRACE_BUFFER_SIRQ_BIT,
459
460 /* Start of function recursion bits */
461 TRACE_FTRACE_BIT,
462 TRACE_FTRACE_NMI_BIT,
463 TRACE_FTRACE_IRQ_BIT,
464 TRACE_FTRACE_SIRQ_BIT,
465
466 /* INTERNAL_BITs must be greater than FTRACE_BITs */
467 TRACE_INTERNAL_BIT,
468 TRACE_INTERNAL_NMI_BIT,
469 TRACE_INTERNAL_IRQ_BIT,
470 TRACE_INTERNAL_SIRQ_BIT,
471
472 TRACE_BRANCH_BIT,
473/*
474 * Abuse of the trace_recursion.
475 * As we need a way to maintain state if we are tracing the function
476 * graph in irq because we want to trace a particular function that
477 * was called in irq context but we have irq tracing off. Since this
478 * can only be modified by current, we can reuse trace_recursion.
479 */
480 TRACE_IRQ_BIT,
481};
482
483#define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
484#define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
485#define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
486
487#define TRACE_CONTEXT_BITS 4
488
489#define TRACE_FTRACE_START TRACE_FTRACE_BIT
490#define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
491
492#define TRACE_LIST_START TRACE_INTERNAL_BIT
493#define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
494
495#define TRACE_CONTEXT_MASK TRACE_LIST_MAX
496
497static __always_inline int trace_get_context_bit(void)
498{
499 int bit;
500
501 if (in_interrupt()) {
502 if (in_nmi())
503 bit = 0;
504
505 else if (in_irq())
506 bit = 1;
507 else
508 bit = 2;
509 } else
510 bit = 3;
511
512 return bit;
513}
514
515static __always_inline int trace_test_and_set_recursion(int start, int max)
516{
517 unsigned int val = current->trace_recursion;
518 int bit;
519
520 /* A previous recursion check was made */
521 if ((val & TRACE_CONTEXT_MASK) > max)
522 return 0;
523
524 bit = trace_get_context_bit() + start;
525 if (unlikely(val & (1 << bit)))
526 return -1;
527
528 val |= 1 << bit;
529 current->trace_recursion = val;
530 barrier();
531
532 return bit;
533}
534
535static __always_inline void trace_clear_recursion(int bit)
536{
537 unsigned int val = current->trace_recursion;
538
539 if (!bit)
540 return;
541
542 bit = 1 << bit;
543 val &= ~bit;
544
545 barrier();
546 current->trace_recursion = val;
547}
548
549static inline struct ring_buffer_iter *
550trace_buffer_iter(struct trace_iterator *iter, int cpu)
551{
552 if (iter->buffer_iter && iter->buffer_iter[cpu])
553 return iter->buffer_iter[cpu];
554 return NULL;
555}
556
557int tracer_init(struct tracer *t, struct trace_array *tr);
558int tracing_is_enabled(void);
559void tracing_reset(struct trace_buffer *buf, int cpu);
560void tracing_reset_online_cpus(struct trace_buffer *buf);
561void tracing_reset_current(int cpu);
562void tracing_reset_all_online_cpus(void);
563int tracing_open_generic(struct inode *inode, struct file *filp);
564bool tracing_is_disabled(void);
565struct dentry *trace_create_file(const char *name,
566 umode_t mode,
567 struct dentry *parent,
568 void *data,
569 const struct file_operations *fops);
570
571struct dentry *tracing_init_dentry(void);
572
573struct ring_buffer_event;
574
575struct ring_buffer_event *
576trace_buffer_lock_reserve(struct ring_buffer *buffer,
577 int type,
578 unsigned long len,
579 unsigned long flags,
580 int pc);
581
582struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
583 struct trace_array_cpu *data);
584
585struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
586 int *ent_cpu, u64 *ent_ts);
587
588void __buffer_unlock_commit(struct ring_buffer *buffer,
589 struct ring_buffer_event *event);
590
591int trace_empty(struct trace_iterator *iter);
592
593void *trace_find_next_entry_inc(struct trace_iterator *iter);
594
595void trace_init_global_iter(struct trace_iterator *iter);
596
597void tracing_iter_reset(struct trace_iterator *iter, int cpu);
598
599void trace_function(struct trace_array *tr,
600 unsigned long ip,
601 unsigned long parent_ip,
602 unsigned long flags, int pc);
603void trace_graph_function(struct trace_array *tr,
604 unsigned long ip,
605 unsigned long parent_ip,
606 unsigned long flags, int pc);
607void trace_latency_header(struct seq_file *m);
608void trace_default_header(struct seq_file *m);
609void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
610int trace_empty(struct trace_iterator *iter);
611
612void trace_graph_return(struct ftrace_graph_ret *trace);
613int trace_graph_entry(struct ftrace_graph_ent *trace);
614void set_graph_array(struct trace_array *tr);
615
616void tracing_start_cmdline_record(void);
617void tracing_stop_cmdline_record(void);
618int register_tracer(struct tracer *type);
619int is_tracing_stopped(void);
620
621loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
622
623extern cpumask_var_t __read_mostly tracing_buffer_mask;
624
625#define for_each_tracing_cpu(cpu) \
626 for_each_cpu(cpu, tracing_buffer_mask)
627
628extern unsigned long nsecs_to_usecs(unsigned long nsecs);
629
630extern unsigned long tracing_thresh;
631
632#ifdef CONFIG_TRACER_MAX_TRACE
633void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
634void update_max_tr_single(struct trace_array *tr,
635 struct task_struct *tsk, int cpu);
636#endif /* CONFIG_TRACER_MAX_TRACE */
637
638#ifdef CONFIG_STACKTRACE
639void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
640 int pc);
641
642void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
643 int pc);
644#else
645static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
646 unsigned long flags, int pc)
647{
648}
649
650static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
651 int skip, int pc)
652{
653}
654#endif /* CONFIG_STACKTRACE */
655
656extern cycle_t ftrace_now(int cpu);
657
658extern void trace_find_cmdline(int pid, char comm[]);
659
660#ifdef CONFIG_DYNAMIC_FTRACE
661extern unsigned long ftrace_update_tot_cnt;
662#endif
663#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
664extern int DYN_FTRACE_TEST_NAME(void);
665#define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
666extern int DYN_FTRACE_TEST_NAME2(void);
667
668extern bool ring_buffer_expanded;
669extern bool tracing_selftest_disabled;
670
671#ifdef CONFIG_FTRACE_STARTUP_TEST
672extern int trace_selftest_startup_function(struct tracer *trace,
673 struct trace_array *tr);
674extern int trace_selftest_startup_function_graph(struct tracer *trace,
675 struct trace_array *tr);
676extern int trace_selftest_startup_irqsoff(struct tracer *trace,
677 struct trace_array *tr);
678extern int trace_selftest_startup_preemptoff(struct tracer *trace,
679 struct trace_array *tr);
680extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
681 struct trace_array *tr);
682extern int trace_selftest_startup_wakeup(struct tracer *trace,
683 struct trace_array *tr);
684extern int trace_selftest_startup_nop(struct tracer *trace,
685 struct trace_array *tr);
686extern int trace_selftest_startup_sched_switch(struct tracer *trace,
687 struct trace_array *tr);
688extern int trace_selftest_startup_branch(struct tracer *trace,
689 struct trace_array *tr);
690/*
691 * Tracer data references selftest functions that only occur
692 * on boot up. These can be __init functions. Thus, when selftests
693 * are enabled, then the tracers need to reference __init functions.
694 */
695#define __tracer_data __refdata
696#else
697/* Tracers are seldom changed. Optimize when selftests are disabled. */
698#define __tracer_data __read_mostly
699#endif /* CONFIG_FTRACE_STARTUP_TEST */
700
701extern void *head_page(struct trace_array_cpu *data);
702extern unsigned long long ns2usecs(cycle_t nsec);
703extern int
704trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
705extern int
706trace_vprintk(unsigned long ip, const char *fmt, va_list args);
707extern int
708trace_array_vprintk(struct trace_array *tr,
709 unsigned long ip, const char *fmt, va_list args);
710int trace_array_printk(struct trace_array *tr,
711 unsigned long ip, const char *fmt, ...);
712int trace_array_printk_buf(struct ring_buffer *buffer,
713 unsigned long ip, const char *fmt, ...);
714void trace_printk_seq(struct trace_seq *s);
715enum print_line_t print_trace_line(struct trace_iterator *iter);
716
717extern char trace_find_mark(unsigned long long duration);
718
719/* Standard output formatting function used for function return traces */
720#ifdef CONFIG_FUNCTION_GRAPH_TRACER
721
722/* Flag options */
723#define TRACE_GRAPH_PRINT_OVERRUN 0x1
724#define TRACE_GRAPH_PRINT_CPU 0x2
725#define TRACE_GRAPH_PRINT_OVERHEAD 0x4
726#define TRACE_GRAPH_PRINT_PROC 0x8
727#define TRACE_GRAPH_PRINT_DURATION 0x10
728#define TRACE_GRAPH_PRINT_ABS_TIME 0x20
729#define TRACE_GRAPH_PRINT_IRQS 0x40
730#define TRACE_GRAPH_PRINT_TAIL 0x80
731#define TRACE_GRAPH_SLEEP_TIME 0x100
732#define TRACE_GRAPH_GRAPH_TIME 0x200
733#define TRACE_GRAPH_PRINT_FILL_SHIFT 28
734#define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
735
736extern void ftrace_graph_sleep_time_control(bool enable);
737extern void ftrace_graph_graph_time_control(bool enable);
738
739extern enum print_line_t
740print_graph_function_flags(struct trace_iterator *iter, u32 flags);
741extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
742extern void
743trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
744extern void graph_trace_open(struct trace_iterator *iter);
745extern void graph_trace_close(struct trace_iterator *iter);
746extern int __trace_graph_entry(struct trace_array *tr,
747 struct ftrace_graph_ent *trace,
748 unsigned long flags, int pc);
749extern void __trace_graph_return(struct trace_array *tr,
750 struct ftrace_graph_ret *trace,
751 unsigned long flags, int pc);
752
753
754#ifdef CONFIG_DYNAMIC_FTRACE
755/* TODO: make this variable */
756#define FTRACE_GRAPH_MAX_FUNCS 32
757extern int ftrace_graph_count;
758extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
759extern int ftrace_graph_notrace_count;
760extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
761
762static inline int ftrace_graph_addr(unsigned long addr)
763{
764 int i;
765
766 if (!ftrace_graph_count)
767 return 1;
768
769 for (i = 0; i < ftrace_graph_count; i++) {
770 if (addr == ftrace_graph_funcs[i]) {
771 /*
772 * If no irqs are to be traced, but a set_graph_function
773 * is set, and called by an interrupt handler, we still
774 * want to trace it.
775 */
776 if (in_irq())
777 trace_recursion_set(TRACE_IRQ_BIT);
778 else
779 trace_recursion_clear(TRACE_IRQ_BIT);
780 return 1;
781 }
782 }
783
784 return 0;
785}
786
787static inline int ftrace_graph_notrace_addr(unsigned long addr)
788{
789 int i;
790
791 if (!ftrace_graph_notrace_count)
792 return 0;
793
794 for (i = 0; i < ftrace_graph_notrace_count; i++) {
795 if (addr == ftrace_graph_notrace_funcs[i])
796 return 1;
797 }
798
799 return 0;
800}
801#else
802static inline int ftrace_graph_addr(unsigned long addr)
803{
804 return 1;
805}
806
807static inline int ftrace_graph_notrace_addr(unsigned long addr)
808{
809 return 0;
810}
811#endif /* CONFIG_DYNAMIC_FTRACE */
812#else /* CONFIG_FUNCTION_GRAPH_TRACER */
813static inline enum print_line_t
814print_graph_function_flags(struct trace_iterator *iter, u32 flags)
815{
816 return TRACE_TYPE_UNHANDLED;
817}
818#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
819
820extern struct list_head ftrace_pids;
821
822#ifdef CONFIG_FUNCTION_TRACER
823extern bool ftrace_filter_param __initdata;
824static inline int ftrace_trace_task(struct task_struct *task)
825{
826 if (list_empty(&ftrace_pids))
827 return 1;
828
829 return test_tsk_trace_trace(task);
830}
831extern int ftrace_is_dead(void);
832int ftrace_create_function_files(struct trace_array *tr,
833 struct dentry *parent);
834void ftrace_destroy_function_files(struct trace_array *tr);
835void ftrace_init_global_array_ops(struct trace_array *tr);
836void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
837void ftrace_reset_array_ops(struct trace_array *tr);
838int using_ftrace_ops_list_func(void);
839#else
840static inline int ftrace_trace_task(struct task_struct *task)
841{
842 return 1;
843}
844static inline int ftrace_is_dead(void) { return 0; }
845static inline int
846ftrace_create_function_files(struct trace_array *tr,
847 struct dentry *parent)
848{
849 return 0;
850}
851static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
852static inline __init void
853ftrace_init_global_array_ops(struct trace_array *tr) { }
854static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
855/* ftace_func_t type is not defined, use macro instead of static inline */
856#define ftrace_init_array_ops(tr, func) do { } while (0)
857#endif /* CONFIG_FUNCTION_TRACER */
858
859#if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
860void ftrace_create_filter_files(struct ftrace_ops *ops,
861 struct dentry *parent);
862void ftrace_destroy_filter_files(struct ftrace_ops *ops);
863#else
864/*
865 * The ops parameter passed in is usually undefined.
866 * This must be a macro.
867 */
868#define ftrace_create_filter_files(ops, parent) do { } while (0)
869#define ftrace_destroy_filter_files(ops) do { } while (0)
870#endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
871
872bool ftrace_event_is_function(struct trace_event_call *call);
873
874/*
875 * struct trace_parser - servers for reading the user input separated by spaces
876 * @cont: set if the input is not complete - no final space char was found
877 * @buffer: holds the parsed user input
878 * @idx: user input length
879 * @size: buffer size
880 */
881struct trace_parser {
882 bool cont;
883 char *buffer;
884 unsigned idx;
885 unsigned size;
886};
887
888static inline bool trace_parser_loaded(struct trace_parser *parser)
889{
890 return (parser->idx != 0);
891}
892
893static inline bool trace_parser_cont(struct trace_parser *parser)
894{
895 return parser->cont;
896}
897
898static inline void trace_parser_clear(struct trace_parser *parser)
899{
900 parser->cont = false;
901 parser->idx = 0;
902}
903
904extern int trace_parser_get_init(struct trace_parser *parser, int size);
905extern void trace_parser_put(struct trace_parser *parser);
906extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
907 size_t cnt, loff_t *ppos);
908
909/*
910 * Only create function graph options if function graph is configured.
911 */
912#ifdef CONFIG_FUNCTION_GRAPH_TRACER
913# define FGRAPH_FLAGS \
914 C(DISPLAY_GRAPH, "display-graph"),
915#else
916# define FGRAPH_FLAGS
917#endif
918
919#ifdef CONFIG_BRANCH_TRACER
920# define BRANCH_FLAGS \
921 C(BRANCH, "branch"),
922#else
923# define BRANCH_FLAGS
924#endif
925
926#ifdef CONFIG_FUNCTION_TRACER
927# define FUNCTION_FLAGS \
928 C(FUNCTION, "function-trace"),
929# define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
930#else
931# define FUNCTION_FLAGS
932# define FUNCTION_DEFAULT_FLAGS 0UL
933#endif
934
935#ifdef CONFIG_STACKTRACE
936# define STACK_FLAGS \
937 C(STACKTRACE, "stacktrace"),
938#else
939# define STACK_FLAGS
940#endif
941
942/*
943 * trace_iterator_flags is an enumeration that defines bit
944 * positions into trace_flags that controls the output.
945 *
946 * NOTE: These bits must match the trace_options array in
947 * trace.c (this macro guarantees it).
948 */
949#define TRACE_FLAGS \
950 C(PRINT_PARENT, "print-parent"), \
951 C(SYM_OFFSET, "sym-offset"), \
952 C(SYM_ADDR, "sym-addr"), \
953 C(VERBOSE, "verbose"), \
954 C(RAW, "raw"), \
955 C(HEX, "hex"), \
956 C(BIN, "bin"), \
957 C(BLOCK, "block"), \
958 C(PRINTK, "trace_printk"), \
959 C(ANNOTATE, "annotate"), \
960 C(USERSTACKTRACE, "userstacktrace"), \
961 C(SYM_USEROBJ, "sym-userobj"), \
962 C(PRINTK_MSGONLY, "printk-msg-only"), \
963 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
964 C(LATENCY_FMT, "latency-format"), \
965 C(RECORD_CMD, "record-cmd"), \
966 C(OVERWRITE, "overwrite"), \
967 C(STOP_ON_FREE, "disable_on_free"), \
968 C(IRQ_INFO, "irq-info"), \
969 C(MARKERS, "markers"), \
970 FUNCTION_FLAGS \
971 FGRAPH_FLAGS \
972 STACK_FLAGS \
973 BRANCH_FLAGS
974
975/*
976 * By defining C, we can make TRACE_FLAGS a list of bit names
977 * that will define the bits for the flag masks.
978 */
979#undef C
980#define C(a, b) TRACE_ITER_##a##_BIT
981
982enum trace_iterator_bits {
983 TRACE_FLAGS
984 /* Make sure we don't go more than we have bits for */
985 TRACE_ITER_LAST_BIT
986};
987
988/*
989 * By redefining C, we can make TRACE_FLAGS a list of masks that
990 * use the bits as defined above.
991 */
992#undef C
993#define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
994
995enum trace_iterator_flags { TRACE_FLAGS };
996
997/*
998 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
999 * control the output of kernel symbols.
1000 */
1001#define TRACE_ITER_SYM_MASK \
1002 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1003
1004extern struct tracer nop_trace;
1005
1006#ifdef CONFIG_BRANCH_TRACER
1007extern int enable_branch_tracing(struct trace_array *tr);
1008extern void disable_branch_tracing(void);
1009static inline int trace_branch_enable(struct trace_array *tr)
1010{
1011 if (tr->trace_flags & TRACE_ITER_BRANCH)
1012 return enable_branch_tracing(tr);
1013 return 0;
1014}
1015static inline void trace_branch_disable(void)
1016{
1017 /* due to races, always disable */
1018 disable_branch_tracing();
1019}
1020#else
1021static inline int trace_branch_enable(struct trace_array *tr)
1022{
1023 return 0;
1024}
1025static inline void trace_branch_disable(void)
1026{
1027}
1028#endif /* CONFIG_BRANCH_TRACER */
1029
1030/* set ring buffers to default size if not already done so */
1031int tracing_update_buffers(void);
1032
1033struct ftrace_event_field {
1034 struct list_head link;
1035 const char *name;
1036 const char *type;
1037 int filter_type;
1038 int offset;
1039 int size;
1040 int is_signed;
1041};
1042
1043struct event_filter {
1044 int n_preds; /* Number assigned */
1045 int a_preds; /* allocated */
1046 struct filter_pred *preds;
1047 struct filter_pred *root;
1048 char *filter_string;
1049};
1050
1051struct event_subsystem {
1052 struct list_head list;
1053 const char *name;
1054 struct event_filter *filter;
1055 int ref_count;
1056};
1057
1058struct trace_subsystem_dir {
1059 struct list_head list;
1060 struct event_subsystem *subsystem;
1061 struct trace_array *tr;
1062 struct dentry *entry;
1063 int ref_count;
1064 int nr_events;
1065};
1066
1067#define FILTER_PRED_INVALID ((unsigned short)-1)
1068#define FILTER_PRED_IS_RIGHT (1 << 15)
1069#define FILTER_PRED_FOLD (1 << 15)
1070
1071/*
1072 * The max preds is the size of unsigned short with
1073 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1074 * and FOLD flags. The other is reserved.
1075 *
1076 * 2^14 preds is way more than enough.
1077 */
1078#define MAX_FILTER_PRED 16384
1079
1080struct filter_pred;
1081struct regex;
1082
1083typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1084
1085typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1086
1087enum regex_type {
1088 MATCH_FULL = 0,
1089 MATCH_FRONT_ONLY,
1090 MATCH_MIDDLE_ONLY,
1091 MATCH_END_ONLY,
1092};
1093
1094struct regex {
1095 char pattern[MAX_FILTER_STR_VAL];
1096 int len;
1097 int field_len;
1098 regex_match_func match;
1099};
1100
1101struct filter_pred {
1102 filter_pred_fn_t fn;
1103 u64 val;
1104 struct regex regex;
1105 unsigned short *ops;
1106 struct ftrace_event_field *field;
1107 int offset;
1108 int not;
1109 int op;
1110 unsigned short index;
1111 unsigned short parent;
1112 unsigned short left;
1113 unsigned short right;
1114};
1115
1116static inline bool is_string_field(struct ftrace_event_field *field)
1117{
1118 return field->filter_type == FILTER_DYN_STRING ||
1119 field->filter_type == FILTER_STATIC_STRING ||
1120 field->filter_type == FILTER_PTR_STRING;
1121}
1122
1123static inline bool is_function_field(struct ftrace_event_field *field)
1124{
1125 return field->filter_type == FILTER_TRACE_FN;
1126}
1127
1128extern enum regex_type
1129filter_parse_regex(char *buff, int len, char **search, int *not);
1130extern void print_event_filter(struct trace_event_file *file,
1131 struct trace_seq *s);
1132extern int apply_event_filter(struct trace_event_file *file,
1133 char *filter_string);
1134extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1135 char *filter_string);
1136extern void print_subsystem_event_filter(struct event_subsystem *system,
1137 struct trace_seq *s);
1138extern int filter_assign_type(const char *type);
1139extern int create_event_filter(struct trace_event_call *call,
1140 char *filter_str, bool set_str,
1141 struct event_filter **filterp);
1142extern void free_event_filter(struct event_filter *filter);
1143
1144struct ftrace_event_field *
1145trace_find_event_field(struct trace_event_call *call, char *name);
1146
1147extern void trace_event_enable_cmd_record(bool enable);
1148extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1149extern int event_trace_del_tracer(struct trace_array *tr);
1150
1151extern struct trace_event_file *find_event_file(struct trace_array *tr,
1152 const char *system,
1153 const char *event);
1154
1155static inline void *event_file_data(struct file *filp)
1156{
1157 return ACCESS_ONCE(file_inode(filp)->i_private);
1158}
1159
1160extern struct mutex event_mutex;
1161extern struct list_head ftrace_events;
1162
1163extern const struct file_operations event_trigger_fops;
1164
1165extern int register_trigger_cmds(void);
1166extern void clear_event_triggers(struct trace_array *tr);
1167
1168struct event_trigger_data {
1169 unsigned long count;
1170 int ref;
1171 struct event_trigger_ops *ops;
1172 struct event_command *cmd_ops;
1173 struct event_filter __rcu *filter;
1174 char *filter_str;
1175 void *private_data;
1176 bool paused;
1177 struct list_head list;
1178};
1179
1180extern void trigger_data_free(struct event_trigger_data *data);
1181extern int event_trigger_init(struct event_trigger_ops *ops,
1182 struct event_trigger_data *data);
1183extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1184 int trigger_enable);
1185extern void update_cond_flag(struct trace_event_file *file);
1186extern void unregister_trigger(char *glob, struct event_trigger_ops *ops,
1187 struct event_trigger_data *test,
1188 struct trace_event_file *file);
1189extern int set_trigger_filter(char *filter_str,
1190 struct event_trigger_data *trigger_data,
1191 struct trace_event_file *file);
1192extern int register_event_command(struct event_command *cmd);
1193
1194/**
1195 * struct event_trigger_ops - callbacks for trace event triggers
1196 *
1197 * The methods in this structure provide per-event trigger hooks for
1198 * various trigger operations.
1199 *
1200 * All the methods below, except for @init() and @free(), must be
1201 * implemented.
1202 *
1203 * @func: The trigger 'probe' function called when the triggering
1204 * event occurs. The data passed into this callback is the data
1205 * that was supplied to the event_command @reg() function that
1206 * registered the trigger (see struct event_command) along with
1207 * the trace record, rec.
1208 *
1209 * @init: An optional initialization function called for the trigger
1210 * when the trigger is registered (via the event_command reg()
1211 * function). This can be used to perform per-trigger
1212 * initialization such as incrementing a per-trigger reference
1213 * count, for instance. This is usually implemented by the
1214 * generic utility function @event_trigger_init() (see
1215 * trace_event_triggers.c).
1216 *
1217 * @free: An optional de-initialization function called for the
1218 * trigger when the trigger is unregistered (via the
1219 * event_command @reg() function). This can be used to perform
1220 * per-trigger de-initialization such as decrementing a
1221 * per-trigger reference count and freeing corresponding trigger
1222 * data, for instance. This is usually implemented by the
1223 * generic utility function @event_trigger_free() (see
1224 * trace_event_triggers.c).
1225 *
1226 * @print: The callback function invoked to have the trigger print
1227 * itself. This is usually implemented by a wrapper function
1228 * that calls the generic utility function @event_trigger_print()
1229 * (see trace_event_triggers.c).
1230 */
1231struct event_trigger_ops {
1232 void (*func)(struct event_trigger_data *data,
1233 void *rec);
1234 int (*init)(struct event_trigger_ops *ops,
1235 struct event_trigger_data *data);
1236 void (*free)(struct event_trigger_ops *ops,
1237 struct event_trigger_data *data);
1238 int (*print)(struct seq_file *m,
1239 struct event_trigger_ops *ops,
1240 struct event_trigger_data *data);
1241};
1242
1243/**
1244 * struct event_command - callbacks and data members for event commands
1245 *
1246 * Event commands are invoked by users by writing the command name
1247 * into the 'trigger' file associated with a trace event. The
1248 * parameters associated with a specific invocation of an event
1249 * command are used to create an event trigger instance, which is
1250 * added to the list of trigger instances associated with that trace
1251 * event. When the event is hit, the set of triggers associated with
1252 * that event is invoked.
1253 *
1254 * The data members in this structure provide per-event command data
1255 * for various event commands.
1256 *
1257 * All the data members below, except for @post_trigger, must be set
1258 * for each event command.
1259 *
1260 * @name: The unique name that identifies the event command. This is
1261 * the name used when setting triggers via trigger files.
1262 *
1263 * @trigger_type: A unique id that identifies the event command
1264 * 'type'. This value has two purposes, the first to ensure that
1265 * only one trigger of the same type can be set at a given time
1266 * for a particular event e.g. it doesn't make sense to have both
1267 * a traceon and traceoff trigger attached to a single event at
1268 * the same time, so traceon and traceoff have the same type
1269 * though they have different names. The @trigger_type value is
1270 * also used as a bit value for deferring the actual trigger
1271 * action until after the current event is finished. Some
1272 * commands need to do this if they themselves log to the trace
1273 * buffer (see the @post_trigger() member below). @trigger_type
1274 * values are defined by adding new values to the trigger_type
1275 * enum in include/linux/trace_events.h.
1276 *
1277 * @flags: See the enum event_command_flags below.
1278 *
1279 * All the methods below, except for @set_filter() and @unreg_all(),
1280 * must be implemented.
1281 *
1282 * @func: The callback function responsible for parsing and
1283 * registering the trigger written to the 'trigger' file by the
1284 * user. It allocates the trigger instance and registers it with
1285 * the appropriate trace event. It makes use of the other
1286 * event_command callback functions to orchestrate this, and is
1287 * usually implemented by the generic utility function
1288 * @event_trigger_callback() (see trace_event_triggers.c).
1289 *
1290 * @reg: Adds the trigger to the list of triggers associated with the
1291 * event, and enables the event trigger itself, after
1292 * initializing it (via the event_trigger_ops @init() function).
1293 * This is also where commands can use the @trigger_type value to
1294 * make the decision as to whether or not multiple instances of
1295 * the trigger should be allowed. This is usually implemented by
1296 * the generic utility function @register_trigger() (see
1297 * trace_event_triggers.c).
1298 *
1299 * @unreg: Removes the trigger from the list of triggers associated
1300 * with the event, and disables the event trigger itself, after
1301 * initializing it (via the event_trigger_ops @free() function).
1302 * This is usually implemented by the generic utility function
1303 * @unregister_trigger() (see trace_event_triggers.c).
1304 *
1305 * @unreg_all: An optional function called to remove all the triggers
1306 * from the list of triggers associated with the event. Called
1307 * when a trigger file is opened in truncate mode.
1308 *
1309 * @set_filter: An optional function called to parse and set a filter
1310 * for the trigger. If no @set_filter() method is set for the
1311 * event command, filters set by the user for the command will be
1312 * ignored. This is usually implemented by the generic utility
1313 * function @set_trigger_filter() (see trace_event_triggers.c).
1314 *
1315 * @get_trigger_ops: The callback function invoked to retrieve the
1316 * event_trigger_ops implementation associated with the command.
1317 */
1318struct event_command {
1319 struct list_head list;
1320 char *name;
1321 enum event_trigger_type trigger_type;
1322 int flags;
1323 int (*func)(struct event_command *cmd_ops,
1324 struct trace_event_file *file,
1325 char *glob, char *cmd, char *params);
1326 int (*reg)(char *glob,
1327 struct event_trigger_ops *ops,
1328 struct event_trigger_data *data,
1329 struct trace_event_file *file);
1330 void (*unreg)(char *glob,
1331 struct event_trigger_ops *ops,
1332 struct event_trigger_data *data,
1333 struct trace_event_file *file);
1334 void (*unreg_all)(struct trace_event_file *file);
1335 int (*set_filter)(char *filter_str,
1336 struct event_trigger_data *data,
1337 struct trace_event_file *file);
1338 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1339};
1340
1341/**
1342 * enum event_command_flags - flags for struct event_command
1343 *
1344 * @POST_TRIGGER: A flag that says whether or not this command needs
1345 * to have its action delayed until after the current event has
1346 * been closed. Some triggers need to avoid being invoked while
1347 * an event is currently in the process of being logged, since
1348 * the trigger may itself log data into the trace buffer. Thus
1349 * we make sure the current event is committed before invoking
1350 * those triggers. To do that, the trigger invocation is split
1351 * in two - the first part checks the filter using the current
1352 * trace record; if a command has the @post_trigger flag set, it
1353 * sets a bit for itself in the return value, otherwise it
1354 * directly invokes the trigger. Once all commands have been
1355 * either invoked or set their return flag, the current record is
1356 * either committed or discarded. At that point, if any commands
1357 * have deferred their triggers, those commands are finally
1358 * invoked following the close of the current event. In other
1359 * words, if the event_trigger_ops @func() probe implementation
1360 * itself logs to the trace buffer, this flag should be set,
1361 * otherwise it can be left unspecified.
1362 *
1363 * @NEEDS_REC: A flag that says whether or not this command needs
1364 * access to the trace record in order to perform its function,
1365 * regardless of whether or not it has a filter associated with
1366 * it (filters make a trigger require access to the trace record
1367 * but are not always present).
1368 */
1369enum event_command_flags {
1370 EVENT_CMD_FL_POST_TRIGGER = 1,
1371 EVENT_CMD_FL_NEEDS_REC = 2,
1372};
1373
1374static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1375{
1376 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1377}
1378
1379static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1380{
1381 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1382}
1383
1384extern int trace_event_enable_disable(struct trace_event_file *file,
1385 int enable, int soft_disable);
1386extern int tracing_alloc_snapshot(void);
1387
1388extern const char *__start___trace_bprintk_fmt[];
1389extern const char *__stop___trace_bprintk_fmt[];
1390
1391extern const char *__start___tracepoint_str[];
1392extern const char *__stop___tracepoint_str[];
1393
1394void trace_printk_control(bool enabled);
1395void trace_printk_init_buffers(void);
1396void trace_printk_start_comm(void);
1397int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1398int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1399
1400/*
1401 * Normal trace_printk() and friends allocates special buffers
1402 * to do the manipulation, as well as saves the print formats
1403 * into sections to display. But the trace infrastructure wants
1404 * to use these without the added overhead at the price of being
1405 * a bit slower (used mainly for warnings, where we don't care
1406 * about performance). The internal_trace_puts() is for such
1407 * a purpose.
1408 */
1409#define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1410
1411#undef FTRACE_ENTRY
1412#define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1413 extern struct trace_event_call \
1414 __aligned(4) event_##call;
1415#undef FTRACE_ENTRY_DUP
1416#define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1417 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1418 filter)
1419#include "trace_entries.h"
1420
1421#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1422int perf_ftrace_event_register(struct trace_event_call *call,
1423 enum trace_reg type, void *data);
1424#else
1425#define perf_ftrace_event_register NULL
1426#endif
1427
1428#ifdef CONFIG_FTRACE_SYSCALLS
1429void init_ftrace_syscalls(void);
1430const char *get_syscall_name(int syscall);
1431#else
1432static inline void init_ftrace_syscalls(void) { }
1433static inline const char *get_syscall_name(int syscall)
1434{
1435 return NULL;
1436}
1437#endif
1438
1439#ifdef CONFIG_EVENT_TRACING
1440void trace_event_init(void);
1441void trace_event_enum_update(struct trace_enum_map **map, int len);
1442#else
1443static inline void __init trace_event_init(void) { }
1444static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1445#endif
1446
1447extern struct trace_iterator *tracepoint_print_iter;
1448
1449#endif /* _LINUX_KERNEL_TRACE_H */
1// SPDX-License-Identifier: GPL-2.0
2
3#ifndef _LINUX_KERNEL_TRACE_H
4#define _LINUX_KERNEL_TRACE_H
5
6#include <linux/fs.h>
7#include <linux/atomic.h>
8#include <linux/sched.h>
9#include <linux/clocksource.h>
10#include <linux/ring_buffer.h>
11#include <linux/mmiotrace.h>
12#include <linux/tracepoint.h>
13#include <linux/ftrace.h>
14#include <linux/trace.h>
15#include <linux/hw_breakpoint.h>
16#include <linux/trace_seq.h>
17#include <linux/trace_events.h>
18#include <linux/compiler.h>
19#include <linux/glob.h>
20#include <linux/irq_work.h>
21#include <linux/workqueue.h>
22#include <linux/ctype.h>
23#include <linux/once_lite.h>
24
25#include "pid_list.h"
26
27#ifdef CONFIG_FTRACE_SYSCALLS
28#include <asm/unistd.h> /* For NR_syscalls */
29#include <asm/syscall.h> /* some archs define it here */
30#endif
31
32#define TRACE_MODE_WRITE 0640
33#define TRACE_MODE_READ 0440
34
35enum trace_type {
36 __TRACE_FIRST_TYPE = 0,
37
38 TRACE_FN,
39 TRACE_CTX,
40 TRACE_WAKE,
41 TRACE_STACK,
42 TRACE_PRINT,
43 TRACE_BPRINT,
44 TRACE_MMIO_RW,
45 TRACE_MMIO_MAP,
46 TRACE_BRANCH,
47 TRACE_GRAPH_RET,
48 TRACE_GRAPH_ENT,
49 TRACE_USER_STACK,
50 TRACE_BLK,
51 TRACE_BPUTS,
52 TRACE_HWLAT,
53 TRACE_OSNOISE,
54 TRACE_TIMERLAT,
55 TRACE_RAW_DATA,
56 TRACE_FUNC_REPEATS,
57
58 __TRACE_LAST_TYPE,
59};
60
61
62#undef __field
63#define __field(type, item) type item;
64
65#undef __field_fn
66#define __field_fn(type, item) type item;
67
68#undef __field_struct
69#define __field_struct(type, item) __field(type, item)
70
71#undef __field_desc
72#define __field_desc(type, container, item)
73
74#undef __field_packed
75#define __field_packed(type, container, item)
76
77#undef __array
78#define __array(type, item, size) type item[size];
79
80/*
81 * For backward compatibility, older user space expects to see the
82 * kernel_stack event with a fixed size caller field. But today the fix
83 * size is ignored by the kernel, and the real structure is dynamic.
84 * Expose to user space: "unsigned long caller[8];" but the real structure
85 * will be "unsigned long caller[] __counted_by(size)"
86 */
87#undef __stack_array
88#define __stack_array(type, item, size, field) type item[] __counted_by(field);
89
90#undef __array_desc
91#define __array_desc(type, container, item, size)
92
93#undef __dynamic_array
94#define __dynamic_array(type, item) type item[];
95
96#undef __rel_dynamic_array
97#define __rel_dynamic_array(type, item) type item[];
98
99#undef F_STRUCT
100#define F_STRUCT(args...) args
101
102#undef FTRACE_ENTRY
103#define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
104 struct struct_name { \
105 struct trace_entry ent; \
106 tstruct \
107 }
108
109#undef FTRACE_ENTRY_DUP
110#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
111
112#undef FTRACE_ENTRY_REG
113#define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
114 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
115
116#undef FTRACE_ENTRY_PACKED
117#define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
118 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
119
120#include "trace_entries.h"
121
122/* Use this for memory failure errors */
123#define MEM_FAIL(condition, fmt, ...) \
124 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__)
125
126#define FAULT_STRING "(fault)"
127
128#define HIST_STACKTRACE_DEPTH 16
129#define HIST_STACKTRACE_SIZE (HIST_STACKTRACE_DEPTH * sizeof(unsigned long))
130#define HIST_STACKTRACE_SKIP 5
131
132/*
133 * syscalls are special, and need special handling, this is why
134 * they are not included in trace_entries.h
135 */
136struct syscall_trace_enter {
137 struct trace_entry ent;
138 int nr;
139 unsigned long args[];
140};
141
142struct syscall_trace_exit {
143 struct trace_entry ent;
144 int nr;
145 long ret;
146};
147
148struct kprobe_trace_entry_head {
149 struct trace_entry ent;
150 unsigned long ip;
151};
152
153struct eprobe_trace_entry_head {
154 struct trace_entry ent;
155};
156
157struct kretprobe_trace_entry_head {
158 struct trace_entry ent;
159 unsigned long func;
160 unsigned long ret_ip;
161};
162
163struct fentry_trace_entry_head {
164 struct trace_entry ent;
165 unsigned long ip;
166};
167
168struct fexit_trace_entry_head {
169 struct trace_entry ent;
170 unsigned long func;
171 unsigned long ret_ip;
172};
173
174#define TRACE_BUF_SIZE 1024
175
176struct trace_array;
177
178/*
179 * The CPU trace array - it consists of thousands of trace entries
180 * plus some other descriptor data: (for example which task started
181 * the trace, etc.)
182 */
183struct trace_array_cpu {
184 atomic_t disabled;
185 void *buffer_page; /* ring buffer spare */
186
187 unsigned long entries;
188 unsigned long saved_latency;
189 unsigned long critical_start;
190 unsigned long critical_end;
191 unsigned long critical_sequence;
192 unsigned long nice;
193 unsigned long policy;
194 unsigned long rt_priority;
195 unsigned long skipped_entries;
196 u64 preempt_timestamp;
197 pid_t pid;
198 kuid_t uid;
199 char comm[TASK_COMM_LEN];
200
201#ifdef CONFIG_FUNCTION_TRACER
202 int ftrace_ignore_pid;
203#endif
204 bool ignore_pid;
205};
206
207struct tracer;
208struct trace_option_dentry;
209
210struct array_buffer {
211 struct trace_array *tr;
212 struct trace_buffer *buffer;
213 struct trace_array_cpu __percpu *data;
214 u64 time_start;
215 int cpu;
216};
217
218#define TRACE_FLAGS_MAX_SIZE 32
219
220struct trace_options {
221 struct tracer *tracer;
222 struct trace_option_dentry *topts;
223};
224
225struct trace_pid_list *trace_pid_list_alloc(void);
226void trace_pid_list_free(struct trace_pid_list *pid_list);
227bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid);
228int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid);
229int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid);
230int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid);
231int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid,
232 unsigned int *next);
233
234enum {
235 TRACE_PIDS = BIT(0),
236 TRACE_NO_PIDS = BIT(1),
237};
238
239static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
240 struct trace_pid_list *no_pid_list)
241{
242 /* Return true if the pid list in type has pids */
243 return ((type & TRACE_PIDS) && pid_list) ||
244 ((type & TRACE_NO_PIDS) && no_pid_list);
245}
246
247static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
248 struct trace_pid_list *no_pid_list)
249{
250 /*
251 * Turning off what is in @type, return true if the "other"
252 * pid list, still has pids in it.
253 */
254 return (!(type & TRACE_PIDS) && pid_list) ||
255 (!(type & TRACE_NO_PIDS) && no_pid_list);
256}
257
258typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
259
260/**
261 * struct cond_snapshot - conditional snapshot data and callback
262 *
263 * The cond_snapshot structure encapsulates a callback function and
264 * data associated with the snapshot for a given tracing instance.
265 *
266 * When a snapshot is taken conditionally, by invoking
267 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
268 * passed in turn to the cond_snapshot.update() function. That data
269 * can be compared by the update() implementation with the cond_data
270 * contained within the struct cond_snapshot instance associated with
271 * the trace_array. Because the tr->max_lock is held throughout the
272 * update() call, the update() function can directly retrieve the
273 * cond_snapshot and cond_data associated with the per-instance
274 * snapshot associated with the trace_array.
275 *
276 * The cond_snapshot.update() implementation can save data to be
277 * associated with the snapshot if it decides to, and returns 'true'
278 * in that case, or it returns 'false' if the conditional snapshot
279 * shouldn't be taken.
280 *
281 * The cond_snapshot instance is created and associated with the
282 * user-defined cond_data by tracing_cond_snapshot_enable().
283 * Likewise, the cond_snapshot instance is destroyed and is no longer
284 * associated with the trace instance by
285 * tracing_cond_snapshot_disable().
286 *
287 * The method below is required.
288 *
289 * @update: When a conditional snapshot is invoked, the update()
290 * callback function is invoked with the tr->max_lock held. The
291 * update() implementation signals whether or not to actually
292 * take the snapshot, by returning 'true' if so, 'false' if no
293 * snapshot should be taken. Because the max_lock is held for
294 * the duration of update(), the implementation is safe to
295 * directly retrieved and save any implementation data it needs
296 * to in association with the snapshot.
297 */
298struct cond_snapshot {
299 void *cond_data;
300 cond_update_fn_t update;
301};
302
303/*
304 * struct trace_func_repeats - used to keep track of the consecutive
305 * (on the same CPU) calls of a single function.
306 */
307struct trace_func_repeats {
308 unsigned long ip;
309 unsigned long parent_ip;
310 unsigned long count;
311 u64 ts_last_call;
312};
313
314/*
315 * The trace array - an array of per-CPU trace arrays. This is the
316 * highest level data structure that individual tracers deal with.
317 * They have on/off state as well:
318 */
319struct trace_array {
320 struct list_head list;
321 char *name;
322 struct array_buffer array_buffer;
323#ifdef CONFIG_TRACER_MAX_TRACE
324 /*
325 * The max_buffer is used to snapshot the trace when a maximum
326 * latency is reached, or when the user initiates a snapshot.
327 * Some tracers will use this to store a maximum trace while
328 * it continues examining live traces.
329 *
330 * The buffers for the max_buffer are set up the same as the array_buffer
331 * When a snapshot is taken, the buffer of the max_buffer is swapped
332 * with the buffer of the array_buffer and the buffers are reset for
333 * the array_buffer so the tracing can continue.
334 */
335 struct array_buffer max_buffer;
336 bool allocated_snapshot;
337#endif
338#ifdef CONFIG_TRACER_MAX_TRACE
339 unsigned long max_latency;
340#ifdef CONFIG_FSNOTIFY
341 struct dentry *d_max_latency;
342 struct work_struct fsnotify_work;
343 struct irq_work fsnotify_irqwork;
344#endif
345#endif
346 struct trace_pid_list __rcu *filtered_pids;
347 struct trace_pid_list __rcu *filtered_no_pids;
348 /*
349 * max_lock is used to protect the swapping of buffers
350 * when taking a max snapshot. The buffers themselves are
351 * protected by per_cpu spinlocks. But the action of the swap
352 * needs its own lock.
353 *
354 * This is defined as a arch_spinlock_t in order to help
355 * with performance when lockdep debugging is enabled.
356 *
357 * It is also used in other places outside the update_max_tr
358 * so it needs to be defined outside of the
359 * CONFIG_TRACER_MAX_TRACE.
360 */
361 arch_spinlock_t max_lock;
362 int buffer_disabled;
363#ifdef CONFIG_FTRACE_SYSCALLS
364 int sys_refcount_enter;
365 int sys_refcount_exit;
366 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
367 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
368#endif
369 int stop_count;
370 int clock_id;
371 int nr_topts;
372 bool clear_trace;
373 int buffer_percent;
374 unsigned int n_err_log_entries;
375 struct tracer *current_trace;
376 unsigned int trace_flags;
377 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
378 unsigned int flags;
379 raw_spinlock_t start_lock;
380 const char *system_names;
381 struct list_head err_log;
382 struct dentry *dir;
383 struct dentry *options;
384 struct dentry *percpu_dir;
385 struct eventfs_inode *event_dir;
386 struct trace_options *topts;
387 struct list_head systems;
388 struct list_head events;
389 struct trace_event_file *trace_marker_file;
390 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
391 /* one per_cpu trace_pipe can be opened by only one user */
392 cpumask_var_t pipe_cpumask;
393 int ref;
394 int trace_ref;
395#ifdef CONFIG_FUNCTION_TRACER
396 struct ftrace_ops *ops;
397 struct trace_pid_list __rcu *function_pids;
398 struct trace_pid_list __rcu *function_no_pids;
399#ifdef CONFIG_DYNAMIC_FTRACE
400 /* All of these are protected by the ftrace_lock */
401 struct list_head func_probes;
402 struct list_head mod_trace;
403 struct list_head mod_notrace;
404#endif
405 /* function tracing enabled */
406 int function_enabled;
407#endif
408 int no_filter_buffering_ref;
409 struct list_head hist_vars;
410#ifdef CONFIG_TRACER_SNAPSHOT
411 struct cond_snapshot *cond_snapshot;
412#endif
413 struct trace_func_repeats __percpu *last_func_repeats;
414 /*
415 * On boot up, the ring buffer is set to the minimum size, so that
416 * we do not waste memory on systems that are not using tracing.
417 */
418 bool ring_buffer_expanded;
419};
420
421enum {
422 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
423};
424
425extern struct list_head ftrace_trace_arrays;
426
427extern struct mutex trace_types_lock;
428
429extern int trace_array_get(struct trace_array *tr);
430extern int tracing_check_open_get_tr(struct trace_array *tr);
431extern struct trace_array *trace_array_find(const char *instance);
432extern struct trace_array *trace_array_find_get(const char *instance);
433
434extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
435extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
436extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
437
438extern bool trace_clock_in_ns(struct trace_array *tr);
439
440/*
441 * The global tracer (top) should be the first trace array added,
442 * but we check the flag anyway.
443 */
444static inline struct trace_array *top_trace_array(void)
445{
446 struct trace_array *tr;
447
448 if (list_empty(&ftrace_trace_arrays))
449 return NULL;
450
451 tr = list_entry(ftrace_trace_arrays.prev,
452 typeof(*tr), list);
453 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
454 return tr;
455}
456
457#define FTRACE_CMP_TYPE(var, type) \
458 __builtin_types_compatible_p(typeof(var), type *)
459
460#undef IF_ASSIGN
461#define IF_ASSIGN(var, entry, etype, id) \
462 if (FTRACE_CMP_TYPE(var, etype)) { \
463 var = (typeof(var))(entry); \
464 WARN_ON(id != 0 && (entry)->type != id); \
465 break; \
466 }
467
468/* Will cause compile errors if type is not found. */
469extern void __ftrace_bad_type(void);
470
471/*
472 * The trace_assign_type is a verifier that the entry type is
473 * the same as the type being assigned. To add new types simply
474 * add a line with the following format:
475 *
476 * IF_ASSIGN(var, ent, type, id);
477 *
478 * Where "type" is the trace type that includes the trace_entry
479 * as the "ent" item. And "id" is the trace identifier that is
480 * used in the trace_type enum.
481 *
482 * If the type can have more than one id, then use zero.
483 */
484#define trace_assign_type(var, ent) \
485 do { \
486 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
487 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
488 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
489 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
490 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
491 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
492 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
493 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
494 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
495 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
496 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
497 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
498 TRACE_MMIO_RW); \
499 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
500 TRACE_MMIO_MAP); \
501 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
502 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
503 TRACE_GRAPH_ENT); \
504 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
505 TRACE_GRAPH_RET); \
506 IF_ASSIGN(var, ent, struct func_repeats_entry, \
507 TRACE_FUNC_REPEATS); \
508 __ftrace_bad_type(); \
509 } while (0)
510
511/*
512 * An option specific to a tracer. This is a boolean value.
513 * The bit is the bit index that sets its value on the
514 * flags value in struct tracer_flags.
515 */
516struct tracer_opt {
517 const char *name; /* Will appear on the trace_options file */
518 u32 bit; /* Mask assigned in val field in tracer_flags */
519};
520
521/*
522 * The set of specific options for a tracer. Your tracer
523 * have to set the initial value of the flags val.
524 */
525struct tracer_flags {
526 u32 val;
527 struct tracer_opt *opts;
528 struct tracer *trace;
529};
530
531/* Makes more easy to define a tracer opt */
532#define TRACER_OPT(s, b) .name = #s, .bit = b
533
534
535struct trace_option_dentry {
536 struct tracer_opt *opt;
537 struct tracer_flags *flags;
538 struct trace_array *tr;
539 struct dentry *entry;
540};
541
542/**
543 * struct tracer - a specific tracer and its callbacks to interact with tracefs
544 * @name: the name chosen to select it on the available_tracers file
545 * @init: called when one switches to this tracer (echo name > current_tracer)
546 * @reset: called when one switches to another tracer
547 * @start: called when tracing is unpaused (echo 1 > tracing_on)
548 * @stop: called when tracing is paused (echo 0 > tracing_on)
549 * @update_thresh: called when tracing_thresh is updated
550 * @open: called when the trace file is opened
551 * @pipe_open: called when the trace_pipe file is opened
552 * @close: called when the trace file is released
553 * @pipe_close: called when the trace_pipe file is released
554 * @read: override the default read callback on trace_pipe
555 * @splice_read: override the default splice_read callback on trace_pipe
556 * @selftest: selftest to run on boot (see trace_selftest.c)
557 * @print_headers: override the first lines that describe your columns
558 * @print_line: callback that prints a trace
559 * @set_flag: signals one of your private flags changed (trace_options file)
560 * @flags: your private flags
561 */
562struct tracer {
563 const char *name;
564 int (*init)(struct trace_array *tr);
565 void (*reset)(struct trace_array *tr);
566 void (*start)(struct trace_array *tr);
567 void (*stop)(struct trace_array *tr);
568 int (*update_thresh)(struct trace_array *tr);
569 void (*open)(struct trace_iterator *iter);
570 void (*pipe_open)(struct trace_iterator *iter);
571 void (*close)(struct trace_iterator *iter);
572 void (*pipe_close)(struct trace_iterator *iter);
573 ssize_t (*read)(struct trace_iterator *iter,
574 struct file *filp, char __user *ubuf,
575 size_t cnt, loff_t *ppos);
576 ssize_t (*splice_read)(struct trace_iterator *iter,
577 struct file *filp,
578 loff_t *ppos,
579 struct pipe_inode_info *pipe,
580 size_t len,
581 unsigned int flags);
582#ifdef CONFIG_FTRACE_STARTUP_TEST
583 int (*selftest)(struct tracer *trace,
584 struct trace_array *tr);
585#endif
586 void (*print_header)(struct seq_file *m);
587 enum print_line_t (*print_line)(struct trace_iterator *iter);
588 /* If you handled the flag setting, return 0 */
589 int (*set_flag)(struct trace_array *tr,
590 u32 old_flags, u32 bit, int set);
591 /* Return 0 if OK with change, else return non-zero */
592 int (*flag_changed)(struct trace_array *tr,
593 u32 mask, int set);
594 struct tracer *next;
595 struct tracer_flags *flags;
596 int enabled;
597 bool print_max;
598 bool allow_instances;
599#ifdef CONFIG_TRACER_MAX_TRACE
600 bool use_max_tr;
601#endif
602 /* True if tracer cannot be enabled in kernel param */
603 bool noboot;
604};
605
606static inline struct ring_buffer_iter *
607trace_buffer_iter(struct trace_iterator *iter, int cpu)
608{
609 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
610}
611
612int tracer_init(struct tracer *t, struct trace_array *tr);
613int tracing_is_enabled(void);
614void tracing_reset_online_cpus(struct array_buffer *buf);
615void tracing_reset_all_online_cpus(void);
616void tracing_reset_all_online_cpus_unlocked(void);
617int tracing_open_generic(struct inode *inode, struct file *filp);
618int tracing_open_generic_tr(struct inode *inode, struct file *filp);
619int tracing_release_generic_tr(struct inode *inode, struct file *file);
620int tracing_open_file_tr(struct inode *inode, struct file *filp);
621int tracing_release_file_tr(struct inode *inode, struct file *filp);
622int tracing_single_release_file_tr(struct inode *inode, struct file *filp);
623bool tracing_is_disabled(void);
624bool tracer_tracing_is_on(struct trace_array *tr);
625void tracer_tracing_on(struct trace_array *tr);
626void tracer_tracing_off(struct trace_array *tr);
627struct dentry *trace_create_file(const char *name,
628 umode_t mode,
629 struct dentry *parent,
630 void *data,
631 const struct file_operations *fops);
632
633int tracing_init_dentry(void);
634
635struct ring_buffer_event;
636
637struct ring_buffer_event *
638trace_buffer_lock_reserve(struct trace_buffer *buffer,
639 int type,
640 unsigned long len,
641 unsigned int trace_ctx);
642
643struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
644 struct trace_array_cpu *data);
645
646struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
647 int *ent_cpu, u64 *ent_ts);
648
649void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
650 struct ring_buffer_event *event);
651
652bool trace_is_tracepoint_string(const char *str);
653const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
654void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
655 va_list ap) __printf(2, 0);
656char *trace_iter_expand_format(struct trace_iterator *iter);
657
658int trace_empty(struct trace_iterator *iter);
659
660void *trace_find_next_entry_inc(struct trace_iterator *iter);
661
662void trace_init_global_iter(struct trace_iterator *iter);
663
664void tracing_iter_reset(struct trace_iterator *iter, int cpu);
665
666unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
667unsigned long trace_total_entries(struct trace_array *tr);
668
669void trace_function(struct trace_array *tr,
670 unsigned long ip,
671 unsigned long parent_ip,
672 unsigned int trace_ctx);
673void trace_graph_function(struct trace_array *tr,
674 unsigned long ip,
675 unsigned long parent_ip,
676 unsigned int trace_ctx);
677void trace_latency_header(struct seq_file *m);
678void trace_default_header(struct seq_file *m);
679void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
680
681void trace_graph_return(struct ftrace_graph_ret *trace);
682int trace_graph_entry(struct ftrace_graph_ent *trace);
683void set_graph_array(struct trace_array *tr);
684
685void tracing_start_cmdline_record(void);
686void tracing_stop_cmdline_record(void);
687void tracing_start_tgid_record(void);
688void tracing_stop_tgid_record(void);
689
690int register_tracer(struct tracer *type);
691int is_tracing_stopped(void);
692
693loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
694
695extern cpumask_var_t __read_mostly tracing_buffer_mask;
696
697#define for_each_tracing_cpu(cpu) \
698 for_each_cpu(cpu, tracing_buffer_mask)
699
700extern unsigned long nsecs_to_usecs(unsigned long nsecs);
701
702extern unsigned long tracing_thresh;
703
704/* PID filtering */
705
706extern int pid_max;
707
708bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
709 pid_t search_pid);
710bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
711 struct trace_pid_list *filtered_no_pids,
712 struct task_struct *task);
713void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
714 struct task_struct *self,
715 struct task_struct *task);
716void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
717void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
718int trace_pid_show(struct seq_file *m, void *v);
719int trace_pid_write(struct trace_pid_list *filtered_pids,
720 struct trace_pid_list **new_pid_list,
721 const char __user *ubuf, size_t cnt);
722
723#ifdef CONFIG_TRACER_MAX_TRACE
724void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
725 void *cond_data);
726void update_max_tr_single(struct trace_array *tr,
727 struct task_struct *tsk, int cpu);
728
729#ifdef CONFIG_FSNOTIFY
730#define LATENCY_FS_NOTIFY
731#endif
732#endif /* CONFIG_TRACER_MAX_TRACE */
733
734#ifdef LATENCY_FS_NOTIFY
735void latency_fsnotify(struct trace_array *tr);
736#else
737static inline void latency_fsnotify(struct trace_array *tr) { }
738#endif
739
740#ifdef CONFIG_STACKTRACE
741void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
742#else
743static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
744 int skip)
745{
746}
747#endif /* CONFIG_STACKTRACE */
748
749void trace_last_func_repeats(struct trace_array *tr,
750 struct trace_func_repeats *last_info,
751 unsigned int trace_ctx);
752
753extern u64 ftrace_now(int cpu);
754
755extern void trace_find_cmdline(int pid, char comm[]);
756extern int trace_find_tgid(int pid);
757extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
758
759#ifdef CONFIG_DYNAMIC_FTRACE
760extern unsigned long ftrace_update_tot_cnt;
761extern unsigned long ftrace_number_of_pages;
762extern unsigned long ftrace_number_of_groups;
763void ftrace_init_trace_array(struct trace_array *tr);
764#else
765static inline void ftrace_init_trace_array(struct trace_array *tr) { }
766#endif
767#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
768extern int DYN_FTRACE_TEST_NAME(void);
769#define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
770extern int DYN_FTRACE_TEST_NAME2(void);
771
772extern void trace_set_ring_buffer_expanded(struct trace_array *tr);
773extern bool tracing_selftest_disabled;
774
775#ifdef CONFIG_FTRACE_STARTUP_TEST
776extern void __init disable_tracing_selftest(const char *reason);
777
778extern int trace_selftest_startup_function(struct tracer *trace,
779 struct trace_array *tr);
780extern int trace_selftest_startup_function_graph(struct tracer *trace,
781 struct trace_array *tr);
782extern int trace_selftest_startup_irqsoff(struct tracer *trace,
783 struct trace_array *tr);
784extern int trace_selftest_startup_preemptoff(struct tracer *trace,
785 struct trace_array *tr);
786extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
787 struct trace_array *tr);
788extern int trace_selftest_startup_wakeup(struct tracer *trace,
789 struct trace_array *tr);
790extern int trace_selftest_startup_nop(struct tracer *trace,
791 struct trace_array *tr);
792extern int trace_selftest_startup_branch(struct tracer *trace,
793 struct trace_array *tr);
794/*
795 * Tracer data references selftest functions that only occur
796 * on boot up. These can be __init functions. Thus, when selftests
797 * are enabled, then the tracers need to reference __init functions.
798 */
799#define __tracer_data __refdata
800#else
801static inline void __init disable_tracing_selftest(const char *reason)
802{
803}
804/* Tracers are seldom changed. Optimize when selftests are disabled. */
805#define __tracer_data __read_mostly
806#endif /* CONFIG_FTRACE_STARTUP_TEST */
807
808extern void *head_page(struct trace_array_cpu *data);
809extern unsigned long long ns2usecs(u64 nsec);
810extern int
811trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
812extern int
813trace_vprintk(unsigned long ip, const char *fmt, va_list args);
814extern int
815trace_array_vprintk(struct trace_array *tr,
816 unsigned long ip, const char *fmt, va_list args);
817int trace_array_printk_buf(struct trace_buffer *buffer,
818 unsigned long ip, const char *fmt, ...);
819void trace_printk_seq(struct trace_seq *s);
820enum print_line_t print_trace_line(struct trace_iterator *iter);
821
822extern char trace_find_mark(unsigned long long duration);
823
824struct ftrace_hash;
825
826struct ftrace_mod_load {
827 struct list_head list;
828 char *func;
829 char *module;
830 int enable;
831};
832
833enum {
834 FTRACE_HASH_FL_MOD = (1 << 0),
835};
836
837struct ftrace_hash {
838 unsigned long size_bits;
839 struct hlist_head *buckets;
840 unsigned long count;
841 unsigned long flags;
842 struct rcu_head rcu;
843};
844
845struct ftrace_func_entry *
846ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
847
848static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
849{
850 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
851}
852
853/* Standard output formatting function used for function return traces */
854#ifdef CONFIG_FUNCTION_GRAPH_TRACER
855
856/* Flag options */
857#define TRACE_GRAPH_PRINT_OVERRUN 0x1
858#define TRACE_GRAPH_PRINT_CPU 0x2
859#define TRACE_GRAPH_PRINT_OVERHEAD 0x4
860#define TRACE_GRAPH_PRINT_PROC 0x8
861#define TRACE_GRAPH_PRINT_DURATION 0x10
862#define TRACE_GRAPH_PRINT_ABS_TIME 0x20
863#define TRACE_GRAPH_PRINT_REL_TIME 0x40
864#define TRACE_GRAPH_PRINT_IRQS 0x80
865#define TRACE_GRAPH_PRINT_TAIL 0x100
866#define TRACE_GRAPH_SLEEP_TIME 0x200
867#define TRACE_GRAPH_GRAPH_TIME 0x400
868#define TRACE_GRAPH_PRINT_RETVAL 0x800
869#define TRACE_GRAPH_PRINT_RETVAL_HEX 0x1000
870#define TRACE_GRAPH_PRINT_FILL_SHIFT 28
871#define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
872
873extern void ftrace_graph_sleep_time_control(bool enable);
874
875#ifdef CONFIG_FUNCTION_PROFILER
876extern void ftrace_graph_graph_time_control(bool enable);
877#else
878static inline void ftrace_graph_graph_time_control(bool enable) { }
879#endif
880
881extern enum print_line_t
882print_graph_function_flags(struct trace_iterator *iter, u32 flags);
883extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
884extern void
885trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
886extern void graph_trace_open(struct trace_iterator *iter);
887extern void graph_trace_close(struct trace_iterator *iter);
888extern int __trace_graph_entry(struct trace_array *tr,
889 struct ftrace_graph_ent *trace,
890 unsigned int trace_ctx);
891extern void __trace_graph_return(struct trace_array *tr,
892 struct ftrace_graph_ret *trace,
893 unsigned int trace_ctx);
894
895#ifdef CONFIG_DYNAMIC_FTRACE
896extern struct ftrace_hash __rcu *ftrace_graph_hash;
897extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
898
899static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
900{
901 unsigned long addr = trace->func;
902 int ret = 0;
903 struct ftrace_hash *hash;
904
905 preempt_disable_notrace();
906
907 /*
908 * Have to open code "rcu_dereference_sched()" because the
909 * function graph tracer can be called when RCU is not
910 * "watching".
911 * Protected with schedule_on_each_cpu(ftrace_sync)
912 */
913 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
914
915 if (ftrace_hash_empty(hash)) {
916 ret = 1;
917 goto out;
918 }
919
920 if (ftrace_lookup_ip(hash, addr)) {
921
922 /*
923 * This needs to be cleared on the return functions
924 * when the depth is zero.
925 */
926 trace_recursion_set(TRACE_GRAPH_BIT);
927 trace_recursion_set_depth(trace->depth);
928
929 /*
930 * If no irqs are to be traced, but a set_graph_function
931 * is set, and called by an interrupt handler, we still
932 * want to trace it.
933 */
934 if (in_hardirq())
935 trace_recursion_set(TRACE_IRQ_BIT);
936 else
937 trace_recursion_clear(TRACE_IRQ_BIT);
938 ret = 1;
939 }
940
941out:
942 preempt_enable_notrace();
943 return ret;
944}
945
946static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
947{
948 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
949 trace->depth == trace_recursion_depth())
950 trace_recursion_clear(TRACE_GRAPH_BIT);
951}
952
953static inline int ftrace_graph_notrace_addr(unsigned long addr)
954{
955 int ret = 0;
956 struct ftrace_hash *notrace_hash;
957
958 preempt_disable_notrace();
959
960 /*
961 * Have to open code "rcu_dereference_sched()" because the
962 * function graph tracer can be called when RCU is not
963 * "watching".
964 * Protected with schedule_on_each_cpu(ftrace_sync)
965 */
966 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
967 !preemptible());
968
969 if (ftrace_lookup_ip(notrace_hash, addr))
970 ret = 1;
971
972 preempt_enable_notrace();
973 return ret;
974}
975#else
976static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
977{
978 return 1;
979}
980
981static inline int ftrace_graph_notrace_addr(unsigned long addr)
982{
983 return 0;
984}
985static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
986{ }
987#endif /* CONFIG_DYNAMIC_FTRACE */
988
989extern unsigned int fgraph_max_depth;
990
991static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
992{
993 /* trace it when it is-nested-in or is a function enabled. */
994 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
995 ftrace_graph_addr(trace)) ||
996 (trace->depth < 0) ||
997 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
998}
999
1000#else /* CONFIG_FUNCTION_GRAPH_TRACER */
1001static inline enum print_line_t
1002print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1003{
1004 return TRACE_TYPE_UNHANDLED;
1005}
1006#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
1007
1008extern struct list_head ftrace_pids;
1009
1010#ifdef CONFIG_FUNCTION_TRACER
1011
1012#define FTRACE_PID_IGNORE -1
1013#define FTRACE_PID_TRACE -2
1014
1015struct ftrace_func_command {
1016 struct list_head list;
1017 char *name;
1018 int (*func)(struct trace_array *tr,
1019 struct ftrace_hash *hash,
1020 char *func, char *cmd,
1021 char *params, int enable);
1022};
1023extern bool ftrace_filter_param __initdata;
1024static inline int ftrace_trace_task(struct trace_array *tr)
1025{
1026 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
1027 FTRACE_PID_IGNORE;
1028}
1029extern int ftrace_is_dead(void);
1030int ftrace_create_function_files(struct trace_array *tr,
1031 struct dentry *parent);
1032void ftrace_destroy_function_files(struct trace_array *tr);
1033int ftrace_allocate_ftrace_ops(struct trace_array *tr);
1034void ftrace_free_ftrace_ops(struct trace_array *tr);
1035void ftrace_init_global_array_ops(struct trace_array *tr);
1036void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1037void ftrace_reset_array_ops(struct trace_array *tr);
1038void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1039void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1040 struct dentry *d_tracer);
1041void ftrace_clear_pids(struct trace_array *tr);
1042int init_function_trace(void);
1043void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1044#else
1045static inline int ftrace_trace_task(struct trace_array *tr)
1046{
1047 return 1;
1048}
1049static inline int ftrace_is_dead(void) { return 0; }
1050static inline int
1051ftrace_create_function_files(struct trace_array *tr,
1052 struct dentry *parent)
1053{
1054 return 0;
1055}
1056static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1057{
1058 return 0;
1059}
1060static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1061static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1062static inline __init void
1063ftrace_init_global_array_ops(struct trace_array *tr) { }
1064static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1065static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1066static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1067static inline void ftrace_clear_pids(struct trace_array *tr) { }
1068static inline int init_function_trace(void) { return 0; }
1069static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1070/* ftace_func_t type is not defined, use macro instead of static inline */
1071#define ftrace_init_array_ops(tr, func) do { } while (0)
1072#endif /* CONFIG_FUNCTION_TRACER */
1073
1074#if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1075
1076struct ftrace_probe_ops {
1077 void (*func)(unsigned long ip,
1078 unsigned long parent_ip,
1079 struct trace_array *tr,
1080 struct ftrace_probe_ops *ops,
1081 void *data);
1082 int (*init)(struct ftrace_probe_ops *ops,
1083 struct trace_array *tr,
1084 unsigned long ip, void *init_data,
1085 void **data);
1086 void (*free)(struct ftrace_probe_ops *ops,
1087 struct trace_array *tr,
1088 unsigned long ip, void *data);
1089 int (*print)(struct seq_file *m,
1090 unsigned long ip,
1091 struct ftrace_probe_ops *ops,
1092 void *data);
1093};
1094
1095struct ftrace_func_mapper;
1096typedef int (*ftrace_mapper_func)(void *data);
1097
1098struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1099void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1100 unsigned long ip);
1101int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1102 unsigned long ip, void *data);
1103void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1104 unsigned long ip);
1105void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1106 ftrace_mapper_func free_func);
1107
1108extern int
1109register_ftrace_function_probe(char *glob, struct trace_array *tr,
1110 struct ftrace_probe_ops *ops, void *data);
1111extern int
1112unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1113 struct ftrace_probe_ops *ops);
1114extern void clear_ftrace_function_probes(struct trace_array *tr);
1115
1116int register_ftrace_command(struct ftrace_func_command *cmd);
1117int unregister_ftrace_command(struct ftrace_func_command *cmd);
1118
1119void ftrace_create_filter_files(struct ftrace_ops *ops,
1120 struct dentry *parent);
1121void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1122
1123extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1124 int len, int reset);
1125extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1126 int len, int reset);
1127#else
1128struct ftrace_func_command;
1129
1130static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1131{
1132 return -EINVAL;
1133}
1134static inline __init int unregister_ftrace_command(char *cmd_name)
1135{
1136 return -EINVAL;
1137}
1138static inline void clear_ftrace_function_probes(struct trace_array *tr)
1139{
1140}
1141
1142/*
1143 * The ops parameter passed in is usually undefined.
1144 * This must be a macro.
1145 */
1146#define ftrace_create_filter_files(ops, parent) do { } while (0)
1147#define ftrace_destroy_filter_files(ops) do { } while (0)
1148#endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1149
1150bool ftrace_event_is_function(struct trace_event_call *call);
1151
1152/*
1153 * struct trace_parser - servers for reading the user input separated by spaces
1154 * @cont: set if the input is not complete - no final space char was found
1155 * @buffer: holds the parsed user input
1156 * @idx: user input length
1157 * @size: buffer size
1158 */
1159struct trace_parser {
1160 bool cont;
1161 char *buffer;
1162 unsigned idx;
1163 unsigned size;
1164};
1165
1166static inline bool trace_parser_loaded(struct trace_parser *parser)
1167{
1168 return (parser->idx != 0);
1169}
1170
1171static inline bool trace_parser_cont(struct trace_parser *parser)
1172{
1173 return parser->cont;
1174}
1175
1176static inline void trace_parser_clear(struct trace_parser *parser)
1177{
1178 parser->cont = false;
1179 parser->idx = 0;
1180}
1181
1182extern int trace_parser_get_init(struct trace_parser *parser, int size);
1183extern void trace_parser_put(struct trace_parser *parser);
1184extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1185 size_t cnt, loff_t *ppos);
1186
1187/*
1188 * Only create function graph options if function graph is configured.
1189 */
1190#ifdef CONFIG_FUNCTION_GRAPH_TRACER
1191# define FGRAPH_FLAGS \
1192 C(DISPLAY_GRAPH, "display-graph"),
1193#else
1194# define FGRAPH_FLAGS
1195#endif
1196
1197#ifdef CONFIG_BRANCH_TRACER
1198# define BRANCH_FLAGS \
1199 C(BRANCH, "branch"),
1200#else
1201# define BRANCH_FLAGS
1202#endif
1203
1204#ifdef CONFIG_FUNCTION_TRACER
1205# define FUNCTION_FLAGS \
1206 C(FUNCTION, "function-trace"), \
1207 C(FUNC_FORK, "function-fork"),
1208# define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1209#else
1210# define FUNCTION_FLAGS
1211# define FUNCTION_DEFAULT_FLAGS 0UL
1212# define TRACE_ITER_FUNC_FORK 0UL
1213#endif
1214
1215#ifdef CONFIG_STACKTRACE
1216# define STACK_FLAGS \
1217 C(STACKTRACE, "stacktrace"),
1218#else
1219# define STACK_FLAGS
1220#endif
1221
1222/*
1223 * trace_iterator_flags is an enumeration that defines bit
1224 * positions into trace_flags that controls the output.
1225 *
1226 * NOTE: These bits must match the trace_options array in
1227 * trace.c (this macro guarantees it).
1228 */
1229#define TRACE_FLAGS \
1230 C(PRINT_PARENT, "print-parent"), \
1231 C(SYM_OFFSET, "sym-offset"), \
1232 C(SYM_ADDR, "sym-addr"), \
1233 C(VERBOSE, "verbose"), \
1234 C(RAW, "raw"), \
1235 C(HEX, "hex"), \
1236 C(BIN, "bin"), \
1237 C(BLOCK, "block"), \
1238 C(FIELDS, "fields"), \
1239 C(PRINTK, "trace_printk"), \
1240 C(ANNOTATE, "annotate"), \
1241 C(USERSTACKTRACE, "userstacktrace"), \
1242 C(SYM_USEROBJ, "sym-userobj"), \
1243 C(PRINTK_MSGONLY, "printk-msg-only"), \
1244 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1245 C(LATENCY_FMT, "latency-format"), \
1246 C(RECORD_CMD, "record-cmd"), \
1247 C(RECORD_TGID, "record-tgid"), \
1248 C(OVERWRITE, "overwrite"), \
1249 C(STOP_ON_FREE, "disable_on_free"), \
1250 C(IRQ_INFO, "irq-info"), \
1251 C(MARKERS, "markers"), \
1252 C(EVENT_FORK, "event-fork"), \
1253 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1254 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1255 FUNCTION_FLAGS \
1256 FGRAPH_FLAGS \
1257 STACK_FLAGS \
1258 BRANCH_FLAGS
1259
1260/*
1261 * By defining C, we can make TRACE_FLAGS a list of bit names
1262 * that will define the bits for the flag masks.
1263 */
1264#undef C
1265#define C(a, b) TRACE_ITER_##a##_BIT
1266
1267enum trace_iterator_bits {
1268 TRACE_FLAGS
1269 /* Make sure we don't go more than we have bits for */
1270 TRACE_ITER_LAST_BIT
1271};
1272
1273/*
1274 * By redefining C, we can make TRACE_FLAGS a list of masks that
1275 * use the bits as defined above.
1276 */
1277#undef C
1278#define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1279
1280enum trace_iterator_flags { TRACE_FLAGS };
1281
1282/*
1283 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1284 * control the output of kernel symbols.
1285 */
1286#define TRACE_ITER_SYM_MASK \
1287 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1288
1289extern struct tracer nop_trace;
1290
1291#ifdef CONFIG_BRANCH_TRACER
1292extern int enable_branch_tracing(struct trace_array *tr);
1293extern void disable_branch_tracing(void);
1294static inline int trace_branch_enable(struct trace_array *tr)
1295{
1296 if (tr->trace_flags & TRACE_ITER_BRANCH)
1297 return enable_branch_tracing(tr);
1298 return 0;
1299}
1300static inline void trace_branch_disable(void)
1301{
1302 /* due to races, always disable */
1303 disable_branch_tracing();
1304}
1305#else
1306static inline int trace_branch_enable(struct trace_array *tr)
1307{
1308 return 0;
1309}
1310static inline void trace_branch_disable(void)
1311{
1312}
1313#endif /* CONFIG_BRANCH_TRACER */
1314
1315/* set ring buffers to default size if not already done so */
1316int tracing_update_buffers(struct trace_array *tr);
1317
1318union trace_synth_field {
1319 u8 as_u8;
1320 u16 as_u16;
1321 u32 as_u32;
1322 u64 as_u64;
1323 struct trace_dynamic_info as_dynamic;
1324};
1325
1326struct ftrace_event_field {
1327 struct list_head link;
1328 const char *name;
1329 const char *type;
1330 int filter_type;
1331 int offset;
1332 int size;
1333 int is_signed;
1334 int len;
1335};
1336
1337struct prog_entry;
1338
1339struct event_filter {
1340 struct prog_entry __rcu *prog;
1341 char *filter_string;
1342};
1343
1344struct event_subsystem {
1345 struct list_head list;
1346 const char *name;
1347 struct event_filter *filter;
1348 int ref_count;
1349};
1350
1351struct trace_subsystem_dir {
1352 struct list_head list;
1353 struct event_subsystem *subsystem;
1354 struct trace_array *tr;
1355 struct eventfs_inode *ei;
1356 int ref_count;
1357 int nr_events;
1358};
1359
1360extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1361 struct trace_buffer *buffer,
1362 struct ring_buffer_event *event);
1363
1364void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1365 struct trace_buffer *buffer,
1366 struct ring_buffer_event *event,
1367 unsigned int trcace_ctx,
1368 struct pt_regs *regs);
1369
1370static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1371 struct trace_buffer *buffer,
1372 struct ring_buffer_event *event,
1373 unsigned int trace_ctx)
1374{
1375 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1376}
1377
1378DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1379DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1380void trace_buffered_event_disable(void);
1381void trace_buffered_event_enable(void);
1382
1383void early_enable_events(struct trace_array *tr, char *buf, bool disable_first);
1384
1385static inline void
1386__trace_event_discard_commit(struct trace_buffer *buffer,
1387 struct ring_buffer_event *event)
1388{
1389 if (this_cpu_read(trace_buffered_event) == event) {
1390 /* Simply release the temp buffer and enable preemption */
1391 this_cpu_dec(trace_buffered_event_cnt);
1392 preempt_enable_notrace();
1393 return;
1394 }
1395 /* ring_buffer_discard_commit() enables preemption */
1396 ring_buffer_discard_commit(buffer, event);
1397}
1398
1399/*
1400 * Helper function for event_trigger_unlock_commit{_regs}().
1401 * If there are event triggers attached to this event that requires
1402 * filtering against its fields, then they will be called as the
1403 * entry already holds the field information of the current event.
1404 *
1405 * It also checks if the event should be discarded or not.
1406 * It is to be discarded if the event is soft disabled and the
1407 * event was only recorded to process triggers, or if the event
1408 * filter is active and this event did not match the filters.
1409 *
1410 * Returns true if the event is discarded, false otherwise.
1411 */
1412static inline bool
1413__event_trigger_test_discard(struct trace_event_file *file,
1414 struct trace_buffer *buffer,
1415 struct ring_buffer_event *event,
1416 void *entry,
1417 enum event_trigger_type *tt)
1418{
1419 unsigned long eflags = file->flags;
1420
1421 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1422 *tt = event_triggers_call(file, buffer, entry, event);
1423
1424 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1425 EVENT_FILE_FL_FILTERED |
1426 EVENT_FILE_FL_PID_FILTER))))
1427 return false;
1428
1429 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1430 goto discard;
1431
1432 if (file->flags & EVENT_FILE_FL_FILTERED &&
1433 !filter_match_preds(file->filter, entry))
1434 goto discard;
1435
1436 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1437 trace_event_ignore_this_pid(file))
1438 goto discard;
1439
1440 return false;
1441 discard:
1442 __trace_event_discard_commit(buffer, event);
1443 return true;
1444}
1445
1446/**
1447 * event_trigger_unlock_commit - handle triggers and finish event commit
1448 * @file: The file pointer associated with the event
1449 * @buffer: The ring buffer that the event is being written to
1450 * @event: The event meta data in the ring buffer
1451 * @entry: The event itself
1452 * @trace_ctx: The tracing context flags.
1453 *
1454 * This is a helper function to handle triggers that require data
1455 * from the event itself. It also tests the event against filters and
1456 * if the event is soft disabled and should be discarded.
1457 */
1458static inline void
1459event_trigger_unlock_commit(struct trace_event_file *file,
1460 struct trace_buffer *buffer,
1461 struct ring_buffer_event *event,
1462 void *entry, unsigned int trace_ctx)
1463{
1464 enum event_trigger_type tt = ETT_NONE;
1465
1466 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1467 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1468
1469 if (tt)
1470 event_triggers_post_call(file, tt);
1471}
1472
1473#define FILTER_PRED_INVALID ((unsigned short)-1)
1474#define FILTER_PRED_IS_RIGHT (1 << 15)
1475#define FILTER_PRED_FOLD (1 << 15)
1476
1477/*
1478 * The max preds is the size of unsigned short with
1479 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1480 * and FOLD flags. The other is reserved.
1481 *
1482 * 2^14 preds is way more than enough.
1483 */
1484#define MAX_FILTER_PRED 16384
1485
1486struct filter_pred;
1487struct regex;
1488
1489typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1490
1491enum regex_type {
1492 MATCH_FULL = 0,
1493 MATCH_FRONT_ONLY,
1494 MATCH_MIDDLE_ONLY,
1495 MATCH_END_ONLY,
1496 MATCH_GLOB,
1497 MATCH_INDEX,
1498};
1499
1500struct regex {
1501 char pattern[MAX_FILTER_STR_VAL];
1502 int len;
1503 int field_len;
1504 regex_match_func match;
1505};
1506
1507static inline bool is_string_field(struct ftrace_event_field *field)
1508{
1509 return field->filter_type == FILTER_DYN_STRING ||
1510 field->filter_type == FILTER_RDYN_STRING ||
1511 field->filter_type == FILTER_STATIC_STRING ||
1512 field->filter_type == FILTER_PTR_STRING ||
1513 field->filter_type == FILTER_COMM;
1514}
1515
1516static inline bool is_function_field(struct ftrace_event_field *field)
1517{
1518 return field->filter_type == FILTER_TRACE_FN;
1519}
1520
1521extern enum regex_type
1522filter_parse_regex(char *buff, int len, char **search, int *not);
1523extern void print_event_filter(struct trace_event_file *file,
1524 struct trace_seq *s);
1525extern int apply_event_filter(struct trace_event_file *file,
1526 char *filter_string);
1527extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1528 char *filter_string);
1529extern void print_subsystem_event_filter(struct event_subsystem *system,
1530 struct trace_seq *s);
1531extern int filter_assign_type(const char *type);
1532extern int create_event_filter(struct trace_array *tr,
1533 struct trace_event_call *call,
1534 char *filter_str, bool set_str,
1535 struct event_filter **filterp);
1536extern void free_event_filter(struct event_filter *filter);
1537
1538struct ftrace_event_field *
1539trace_find_event_field(struct trace_event_call *call, char *name);
1540
1541extern void trace_event_enable_cmd_record(bool enable);
1542extern void trace_event_enable_tgid_record(bool enable);
1543
1544extern int event_trace_init(void);
1545extern int init_events(void);
1546extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1547extern int event_trace_del_tracer(struct trace_array *tr);
1548extern void __trace_early_add_events(struct trace_array *tr);
1549
1550extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1551 const char *system,
1552 const char *event);
1553extern struct trace_event_file *find_event_file(struct trace_array *tr,
1554 const char *system,
1555 const char *event);
1556
1557static inline void *event_file_data(struct file *filp)
1558{
1559 return READ_ONCE(file_inode(filp)->i_private);
1560}
1561
1562extern struct mutex event_mutex;
1563extern struct list_head ftrace_events;
1564
1565extern const struct file_operations event_trigger_fops;
1566extern const struct file_operations event_hist_fops;
1567extern const struct file_operations event_hist_debug_fops;
1568extern const struct file_operations event_inject_fops;
1569
1570#ifdef CONFIG_HIST_TRIGGERS
1571extern int register_trigger_hist_cmd(void);
1572extern int register_trigger_hist_enable_disable_cmds(void);
1573#else
1574static inline int register_trigger_hist_cmd(void) { return 0; }
1575static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1576#endif
1577
1578extern int register_trigger_cmds(void);
1579extern void clear_event_triggers(struct trace_array *tr);
1580
1581enum {
1582 EVENT_TRIGGER_FL_PROBE = BIT(0),
1583};
1584
1585struct event_trigger_data {
1586 unsigned long count;
1587 int ref;
1588 int flags;
1589 struct event_trigger_ops *ops;
1590 struct event_command *cmd_ops;
1591 struct event_filter __rcu *filter;
1592 char *filter_str;
1593 void *private_data;
1594 bool paused;
1595 bool paused_tmp;
1596 struct list_head list;
1597 char *name;
1598 struct list_head named_list;
1599 struct event_trigger_data *named_data;
1600};
1601
1602/* Avoid typos */
1603#define ENABLE_EVENT_STR "enable_event"
1604#define DISABLE_EVENT_STR "disable_event"
1605#define ENABLE_HIST_STR "enable_hist"
1606#define DISABLE_HIST_STR "disable_hist"
1607
1608struct enable_trigger_data {
1609 struct trace_event_file *file;
1610 bool enable;
1611 bool hist;
1612};
1613
1614extern int event_enable_trigger_print(struct seq_file *m,
1615 struct event_trigger_data *data);
1616extern void event_enable_trigger_free(struct event_trigger_data *data);
1617extern int event_enable_trigger_parse(struct event_command *cmd_ops,
1618 struct trace_event_file *file,
1619 char *glob, char *cmd,
1620 char *param_and_filter);
1621extern int event_enable_register_trigger(char *glob,
1622 struct event_trigger_data *data,
1623 struct trace_event_file *file);
1624extern void event_enable_unregister_trigger(char *glob,
1625 struct event_trigger_data *test,
1626 struct trace_event_file *file);
1627extern void trigger_data_free(struct event_trigger_data *data);
1628extern int event_trigger_init(struct event_trigger_data *data);
1629extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1630 int trigger_enable);
1631extern void update_cond_flag(struct trace_event_file *file);
1632extern int set_trigger_filter(char *filter_str,
1633 struct event_trigger_data *trigger_data,
1634 struct trace_event_file *file);
1635extern struct event_trigger_data *find_named_trigger(const char *name);
1636extern bool is_named_trigger(struct event_trigger_data *test);
1637extern int save_named_trigger(const char *name,
1638 struct event_trigger_data *data);
1639extern void del_named_trigger(struct event_trigger_data *data);
1640extern void pause_named_trigger(struct event_trigger_data *data);
1641extern void unpause_named_trigger(struct event_trigger_data *data);
1642extern void set_named_trigger_data(struct event_trigger_data *data,
1643 struct event_trigger_data *named_data);
1644extern struct event_trigger_data *
1645get_named_trigger_data(struct event_trigger_data *data);
1646extern int register_event_command(struct event_command *cmd);
1647extern int unregister_event_command(struct event_command *cmd);
1648extern int register_trigger_hist_enable_disable_cmds(void);
1649extern bool event_trigger_check_remove(const char *glob);
1650extern bool event_trigger_empty_param(const char *param);
1651extern int event_trigger_separate_filter(char *param_and_filter, char **param,
1652 char **filter, bool param_required);
1653extern struct event_trigger_data *
1654event_trigger_alloc(struct event_command *cmd_ops,
1655 char *cmd,
1656 char *param,
1657 void *private_data);
1658extern int event_trigger_parse_num(char *trigger,
1659 struct event_trigger_data *trigger_data);
1660extern int event_trigger_set_filter(struct event_command *cmd_ops,
1661 struct trace_event_file *file,
1662 char *param,
1663 struct event_trigger_data *trigger_data);
1664extern void event_trigger_reset_filter(struct event_command *cmd_ops,
1665 struct event_trigger_data *trigger_data);
1666extern int event_trigger_register(struct event_command *cmd_ops,
1667 struct trace_event_file *file,
1668 char *glob,
1669 struct event_trigger_data *trigger_data);
1670extern void event_trigger_unregister(struct event_command *cmd_ops,
1671 struct trace_event_file *file,
1672 char *glob,
1673 struct event_trigger_data *trigger_data);
1674
1675extern void event_file_get(struct trace_event_file *file);
1676extern void event_file_put(struct trace_event_file *file);
1677
1678/**
1679 * struct event_trigger_ops - callbacks for trace event triggers
1680 *
1681 * The methods in this structure provide per-event trigger hooks for
1682 * various trigger operations.
1683 *
1684 * The @init and @free methods are used during trigger setup and
1685 * teardown, typically called from an event_command's @parse()
1686 * function implementation.
1687 *
1688 * The @print method is used to print the trigger spec.
1689 *
1690 * The @trigger method is the function that actually implements the
1691 * trigger and is called in the context of the triggering event
1692 * whenever that event occurs.
1693 *
1694 * All the methods below, except for @init() and @free(), must be
1695 * implemented.
1696 *
1697 * @trigger: The trigger 'probe' function called when the triggering
1698 * event occurs. The data passed into this callback is the data
1699 * that was supplied to the event_command @reg() function that
1700 * registered the trigger (see struct event_command) along with
1701 * the trace record, rec.
1702 *
1703 * @init: An optional initialization function called for the trigger
1704 * when the trigger is registered (via the event_command reg()
1705 * function). This can be used to perform per-trigger
1706 * initialization such as incrementing a per-trigger reference
1707 * count, for instance. This is usually implemented by the
1708 * generic utility function @event_trigger_init() (see
1709 * trace_event_triggers.c).
1710 *
1711 * @free: An optional de-initialization function called for the
1712 * trigger when the trigger is unregistered (via the
1713 * event_command @reg() function). This can be used to perform
1714 * per-trigger de-initialization such as decrementing a
1715 * per-trigger reference count and freeing corresponding trigger
1716 * data, for instance. This is usually implemented by the
1717 * generic utility function @event_trigger_free() (see
1718 * trace_event_triggers.c).
1719 *
1720 * @print: The callback function invoked to have the trigger print
1721 * itself. This is usually implemented by a wrapper function
1722 * that calls the generic utility function @event_trigger_print()
1723 * (see trace_event_triggers.c).
1724 */
1725struct event_trigger_ops {
1726 void (*trigger)(struct event_trigger_data *data,
1727 struct trace_buffer *buffer,
1728 void *rec,
1729 struct ring_buffer_event *rbe);
1730 int (*init)(struct event_trigger_data *data);
1731 void (*free)(struct event_trigger_data *data);
1732 int (*print)(struct seq_file *m,
1733 struct event_trigger_data *data);
1734};
1735
1736/**
1737 * struct event_command - callbacks and data members for event commands
1738 *
1739 * Event commands are invoked by users by writing the command name
1740 * into the 'trigger' file associated with a trace event. The
1741 * parameters associated with a specific invocation of an event
1742 * command are used to create an event trigger instance, which is
1743 * added to the list of trigger instances associated with that trace
1744 * event. When the event is hit, the set of triggers associated with
1745 * that event is invoked.
1746 *
1747 * The data members in this structure provide per-event command data
1748 * for various event commands.
1749 *
1750 * All the data members below, except for @post_trigger, must be set
1751 * for each event command.
1752 *
1753 * @name: The unique name that identifies the event command. This is
1754 * the name used when setting triggers via trigger files.
1755 *
1756 * @trigger_type: A unique id that identifies the event command
1757 * 'type'. This value has two purposes, the first to ensure that
1758 * only one trigger of the same type can be set at a given time
1759 * for a particular event e.g. it doesn't make sense to have both
1760 * a traceon and traceoff trigger attached to a single event at
1761 * the same time, so traceon and traceoff have the same type
1762 * though they have different names. The @trigger_type value is
1763 * also used as a bit value for deferring the actual trigger
1764 * action until after the current event is finished. Some
1765 * commands need to do this if they themselves log to the trace
1766 * buffer (see the @post_trigger() member below). @trigger_type
1767 * values are defined by adding new values to the trigger_type
1768 * enum in include/linux/trace_events.h.
1769 *
1770 * @flags: See the enum event_command_flags below.
1771 *
1772 * All the methods below, except for @set_filter() and @unreg_all(),
1773 * must be implemented.
1774 *
1775 * @parse: The callback function responsible for parsing and
1776 * registering the trigger written to the 'trigger' file by the
1777 * user. It allocates the trigger instance and registers it with
1778 * the appropriate trace event. It makes use of the other
1779 * event_command callback functions to orchestrate this, and is
1780 * usually implemented by the generic utility function
1781 * @event_trigger_callback() (see trace_event_triggers.c).
1782 *
1783 * @reg: Adds the trigger to the list of triggers associated with the
1784 * event, and enables the event trigger itself, after
1785 * initializing it (via the event_trigger_ops @init() function).
1786 * This is also where commands can use the @trigger_type value to
1787 * make the decision as to whether or not multiple instances of
1788 * the trigger should be allowed. This is usually implemented by
1789 * the generic utility function @register_trigger() (see
1790 * trace_event_triggers.c).
1791 *
1792 * @unreg: Removes the trigger from the list of triggers associated
1793 * with the event, and disables the event trigger itself, after
1794 * initializing it (via the event_trigger_ops @free() function).
1795 * This is usually implemented by the generic utility function
1796 * @unregister_trigger() (see trace_event_triggers.c).
1797 *
1798 * @unreg_all: An optional function called to remove all the triggers
1799 * from the list of triggers associated with the event. Called
1800 * when a trigger file is opened in truncate mode.
1801 *
1802 * @set_filter: An optional function called to parse and set a filter
1803 * for the trigger. If no @set_filter() method is set for the
1804 * event command, filters set by the user for the command will be
1805 * ignored. This is usually implemented by the generic utility
1806 * function @set_trigger_filter() (see trace_event_triggers.c).
1807 *
1808 * @get_trigger_ops: The callback function invoked to retrieve the
1809 * event_trigger_ops implementation associated with the command.
1810 * This callback function allows a single event_command to
1811 * support multiple trigger implementations via different sets of
1812 * event_trigger_ops, depending on the value of the @param
1813 * string.
1814 */
1815struct event_command {
1816 struct list_head list;
1817 char *name;
1818 enum event_trigger_type trigger_type;
1819 int flags;
1820 int (*parse)(struct event_command *cmd_ops,
1821 struct trace_event_file *file,
1822 char *glob, char *cmd,
1823 char *param_and_filter);
1824 int (*reg)(char *glob,
1825 struct event_trigger_data *data,
1826 struct trace_event_file *file);
1827 void (*unreg)(char *glob,
1828 struct event_trigger_data *data,
1829 struct trace_event_file *file);
1830 void (*unreg_all)(struct trace_event_file *file);
1831 int (*set_filter)(char *filter_str,
1832 struct event_trigger_data *data,
1833 struct trace_event_file *file);
1834 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1835};
1836
1837/**
1838 * enum event_command_flags - flags for struct event_command
1839 *
1840 * @POST_TRIGGER: A flag that says whether or not this command needs
1841 * to have its action delayed until after the current event has
1842 * been closed. Some triggers need to avoid being invoked while
1843 * an event is currently in the process of being logged, since
1844 * the trigger may itself log data into the trace buffer. Thus
1845 * we make sure the current event is committed before invoking
1846 * those triggers. To do that, the trigger invocation is split
1847 * in two - the first part checks the filter using the current
1848 * trace record; if a command has the @post_trigger flag set, it
1849 * sets a bit for itself in the return value, otherwise it
1850 * directly invokes the trigger. Once all commands have been
1851 * either invoked or set their return flag, the current record is
1852 * either committed or discarded. At that point, if any commands
1853 * have deferred their triggers, those commands are finally
1854 * invoked following the close of the current event. In other
1855 * words, if the event_trigger_ops @func() probe implementation
1856 * itself logs to the trace buffer, this flag should be set,
1857 * otherwise it can be left unspecified.
1858 *
1859 * @NEEDS_REC: A flag that says whether or not this command needs
1860 * access to the trace record in order to perform its function,
1861 * regardless of whether or not it has a filter associated with
1862 * it (filters make a trigger require access to the trace record
1863 * but are not always present).
1864 */
1865enum event_command_flags {
1866 EVENT_CMD_FL_POST_TRIGGER = 1,
1867 EVENT_CMD_FL_NEEDS_REC = 2,
1868};
1869
1870static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1871{
1872 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1873}
1874
1875static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1876{
1877 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1878}
1879
1880extern int trace_event_enable_disable(struct trace_event_file *file,
1881 int enable, int soft_disable);
1882extern int tracing_alloc_snapshot(void);
1883extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1884extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1885
1886extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1887extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1888
1889extern const char *__start___trace_bprintk_fmt[];
1890extern const char *__stop___trace_bprintk_fmt[];
1891
1892extern const char *__start___tracepoint_str[];
1893extern const char *__stop___tracepoint_str[];
1894
1895void trace_printk_control(bool enabled);
1896void trace_printk_start_comm(void);
1897int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1898int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1899
1900/* Used from boot time tracer */
1901extern int trace_set_options(struct trace_array *tr, char *option);
1902extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1903extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1904 unsigned long size, int cpu_id);
1905extern int tracing_set_cpumask(struct trace_array *tr,
1906 cpumask_var_t tracing_cpumask_new);
1907
1908
1909#define MAX_EVENT_NAME_LEN 64
1910
1911extern ssize_t trace_parse_run_command(struct file *file,
1912 const char __user *buffer, size_t count, loff_t *ppos,
1913 int (*createfn)(const char *));
1914
1915extern unsigned int err_pos(char *cmd, const char *str);
1916extern void tracing_log_err(struct trace_array *tr,
1917 const char *loc, const char *cmd,
1918 const char **errs, u8 type, u16 pos);
1919
1920/*
1921 * Normal trace_printk() and friends allocates special buffers
1922 * to do the manipulation, as well as saves the print formats
1923 * into sections to display. But the trace infrastructure wants
1924 * to use these without the added overhead at the price of being
1925 * a bit slower (used mainly for warnings, where we don't care
1926 * about performance). The internal_trace_puts() is for such
1927 * a purpose.
1928 */
1929#define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1930
1931#undef FTRACE_ENTRY
1932#define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1933 extern struct trace_event_call \
1934 __aligned(4) event_##call;
1935#undef FTRACE_ENTRY_DUP
1936#define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1937 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1938#undef FTRACE_ENTRY_PACKED
1939#define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1940 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1941
1942#include "trace_entries.h"
1943
1944#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1945int perf_ftrace_event_register(struct trace_event_call *call,
1946 enum trace_reg type, void *data);
1947#else
1948#define perf_ftrace_event_register NULL
1949#endif
1950
1951#ifdef CONFIG_FTRACE_SYSCALLS
1952void init_ftrace_syscalls(void);
1953const char *get_syscall_name(int syscall);
1954#else
1955static inline void init_ftrace_syscalls(void) { }
1956static inline const char *get_syscall_name(int syscall)
1957{
1958 return NULL;
1959}
1960#endif
1961
1962#ifdef CONFIG_EVENT_TRACING
1963void trace_event_init(void);
1964void trace_event_eval_update(struct trace_eval_map **map, int len);
1965/* Used from boot time tracer */
1966extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1967extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1968#else
1969static inline void __init trace_event_init(void) { }
1970static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1971#endif
1972
1973#ifdef CONFIG_TRACER_SNAPSHOT
1974void tracing_snapshot_instance(struct trace_array *tr);
1975int tracing_alloc_snapshot_instance(struct trace_array *tr);
1976#else
1977static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1978static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1979{
1980 return 0;
1981}
1982#endif
1983
1984#ifdef CONFIG_PREEMPT_TRACER
1985void tracer_preempt_on(unsigned long a0, unsigned long a1);
1986void tracer_preempt_off(unsigned long a0, unsigned long a1);
1987#else
1988static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1989static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1990#endif
1991#ifdef CONFIG_IRQSOFF_TRACER
1992void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1993void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1994#else
1995static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1996static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1997#endif
1998
1999/*
2000 * Reset the state of the trace_iterator so that it can read consumed data.
2001 * Normally, the trace_iterator is used for reading the data when it is not
2002 * consumed, and must retain state.
2003 */
2004static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
2005{
2006 memset_startat(iter, 0, seq);
2007 iter->pos = -1;
2008}
2009
2010/* Check the name is good for event/group/fields */
2011static inline bool __is_good_name(const char *name, bool hash_ok)
2012{
2013 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-'))
2014 return false;
2015 while (*++name != '\0') {
2016 if (!isalpha(*name) && !isdigit(*name) && *name != '_' &&
2017 (!hash_ok || *name != '-'))
2018 return false;
2019 }
2020 return true;
2021}
2022
2023/* Check the name is good for event/group/fields */
2024static inline bool is_good_name(const char *name)
2025{
2026 return __is_good_name(name, false);
2027}
2028
2029/* Check the name is good for system */
2030static inline bool is_good_system_name(const char *name)
2031{
2032 return __is_good_name(name, true);
2033}
2034
2035/* Convert certain expected symbols into '_' when generating event names */
2036static inline void sanitize_event_name(char *name)
2037{
2038 while (*name++ != '\0')
2039 if (*name == ':' || *name == '.')
2040 *name = '_';
2041}
2042
2043/*
2044 * This is a generic way to read and write a u64 value from a file in tracefs.
2045 *
2046 * The value is stored on the variable pointed by *val. The value needs
2047 * to be at least *min and at most *max. The write is protected by an
2048 * existing *lock.
2049 */
2050struct trace_min_max_param {
2051 struct mutex *lock;
2052 u64 *val;
2053 u64 *min;
2054 u64 *max;
2055};
2056
2057#define U64_STR_SIZE 24 /* 20 digits max */
2058
2059extern const struct file_operations trace_min_max_fops;
2060
2061#ifdef CONFIG_RV
2062extern int rv_init_interface(void);
2063#else
2064static inline int rv_init_interface(void)
2065{
2066 return 0;
2067}
2068#endif
2069
2070#endif /* _LINUX_KERNEL_TRACE_H */