2 #ifndef _LINUX_KERNEL_TRACE_H
3 #define _LINUX_KERNEL_TRACE_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>
19 #ifdef CONFIG_FTRACE_SYSCALLS
20 #include <asm/unistd.h> /* For NR_SYSCALLS */
21 #include <asm/syscall.h> /* some archs define it here */
25 __TRACE_FIRST_TYPE = 0,
48 #define __field(type, item) type item;
51 #define __field_struct(type, item) __field(type, item)
54 #define __field_desc(type, container, item)
57 #define __array(type, item, size) type item[size];
60 #define __array_desc(type, container, item, size)
62 #undef __dynamic_array
63 #define __dynamic_array(type, item) type item[];
66 #define F_STRUCT(args...) args
69 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
70 struct struct_name { \
71 struct trace_entry ent; \
75 #undef FTRACE_ENTRY_DUP
76 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
78 #undef FTRACE_ENTRY_REG
79 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
81 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
84 #undef FTRACE_ENTRY_PACKED
85 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print, \
87 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
90 #include "trace_entries.h"
93 * syscalls are special, and need special handling, this is why
94 * they are not included in trace_entries.h
96 struct syscall_trace_enter {
97 struct trace_entry ent;
102 struct syscall_trace_exit {
103 struct trace_entry ent;
108 struct kprobe_trace_entry_head {
109 struct trace_entry ent;
113 struct kretprobe_trace_entry_head {
114 struct trace_entry ent;
116 unsigned long ret_ip;
120 * trace_flag_type is an enumeration that holds different
121 * states when a trace occurs. These are:
122 * IRQS_OFF - interrupts were disabled
123 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
124 * NEED_RESCHED - reschedule is requested
125 * HARDIRQ - inside an interrupt handler
126 * SOFTIRQ - inside a softirq handler
128 enum trace_flag_type {
129 TRACE_FLAG_IRQS_OFF = 0x01,
130 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
131 TRACE_FLAG_NEED_RESCHED = 0x04,
132 TRACE_FLAG_HARDIRQ = 0x08,
133 TRACE_FLAG_SOFTIRQ = 0x10,
134 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
135 TRACE_FLAG_NMI = 0x40,
138 #define TRACE_BUF_SIZE 1024
143 * The CPU trace array - it consists of thousands of trace entries
144 * plus some other descriptor data: (for example which task started
147 struct trace_array_cpu {
149 void *buffer_page; /* ring buffer spare */
151 unsigned long entries;
152 unsigned long saved_latency;
153 unsigned long critical_start;
154 unsigned long critical_end;
155 unsigned long critical_sequence;
157 unsigned long policy;
158 unsigned long rt_priority;
159 unsigned long skipped_entries;
160 cycle_t preempt_timestamp;
163 char comm[TASK_COMM_LEN];
166 #ifdef CONFIG_FUNCTION_TRACER
167 bool ftrace_ignore_pid;
172 struct trace_option_dentry;
174 struct trace_buffer {
175 struct trace_array *tr;
176 struct ring_buffer *buffer;
177 struct trace_array_cpu __percpu *data;
182 #define TRACE_FLAGS_MAX_SIZE 32
184 struct trace_options {
185 struct tracer *tracer;
186 struct trace_option_dentry *topts;
189 struct trace_pid_list {
195 * The trace array - an array of per-CPU trace arrays. This is the
196 * highest level data structure that individual tracers deal with.
197 * They have on/off state as well:
200 struct list_head list;
202 struct trace_buffer trace_buffer;
203 #ifdef CONFIG_TRACER_MAX_TRACE
205 * The max_buffer is used to snapshot the trace when a maximum
206 * latency is reached, or when the user initiates a snapshot.
207 * Some tracers will use this to store a maximum trace while
208 * it continues examining live traces.
210 * The buffers for the max_buffer are set up the same as the trace_buffer
211 * When a snapshot is taken, the buffer of the max_buffer is swapped
212 * with the buffer of the trace_buffer and the buffers are reset for
213 * the trace_buffer so the tracing can continue.
215 struct trace_buffer max_buffer;
216 bool allocated_snapshot;
218 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
219 unsigned long max_latency;
221 struct trace_pid_list __rcu *filtered_pids;
223 * max_lock is used to protect the swapping of buffers
224 * when taking a max snapshot. The buffers themselves are
225 * protected by per_cpu spinlocks. But the action of the swap
226 * needs its own lock.
228 * This is defined as a arch_spinlock_t in order to help
229 * with performance when lockdep debugging is enabled.
231 * It is also used in other places outside the update_max_tr
232 * so it needs to be defined outside of the
233 * CONFIG_TRACER_MAX_TRACE.
235 arch_spinlock_t max_lock;
237 #ifdef CONFIG_FTRACE_SYSCALLS
238 int sys_refcount_enter;
239 int sys_refcount_exit;
240 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
241 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
246 struct tracer *current_trace;
247 unsigned int trace_flags;
248 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
250 raw_spinlock_t start_lock;
252 struct dentry *options;
253 struct dentry *percpu_dir;
254 struct dentry *event_dir;
255 struct trace_options *topts;
256 struct list_head systems;
257 struct list_head events;
258 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
260 #ifdef CONFIG_FUNCTION_TRACER
261 struct ftrace_ops *ops;
262 struct trace_pid_list __rcu *function_pids;
263 /* function tracing enabled */
264 int function_enabled;
269 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
272 extern struct list_head ftrace_trace_arrays;
274 extern struct mutex trace_types_lock;
276 extern int trace_array_get(struct trace_array *tr);
277 extern void trace_array_put(struct trace_array *tr);
280 * The global tracer (top) should be the first trace array added,
281 * but we check the flag anyway.
283 static inline struct trace_array *top_trace_array(void)
285 struct trace_array *tr;
287 if (list_empty(&ftrace_trace_arrays))
290 tr = list_entry(ftrace_trace_arrays.prev,
292 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
296 #define FTRACE_CMP_TYPE(var, type) \
297 __builtin_types_compatible_p(typeof(var), type *)
300 #define IF_ASSIGN(var, entry, etype, id) \
301 if (FTRACE_CMP_TYPE(var, etype)) { \
302 var = (typeof(var))(entry); \
303 WARN_ON(id && (entry)->type != id); \
307 /* Will cause compile errors if type is not found. */
308 extern void __ftrace_bad_type(void);
311 * The trace_assign_type is a verifier that the entry type is
312 * the same as the type being assigned. To add new types simply
313 * add a line with the following format:
315 * IF_ASSIGN(var, ent, type, id);
317 * Where "type" is the trace type that includes the trace_entry
318 * as the "ent" item. And "id" is the trace identifier that is
319 * used in the trace_type enum.
321 * If the type can have more than one id, then use zero.
323 #define trace_assign_type(var, ent) \
325 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
326 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
327 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
328 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
329 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
330 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
331 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
332 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
333 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
335 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
337 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
338 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
340 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
342 __ftrace_bad_type(); \
346 * An option specific to a tracer. This is a boolean value.
347 * The bit is the bit index that sets its value on the
348 * flags value in struct tracer_flags.
351 const char *name; /* Will appear on the trace_options file */
352 u32 bit; /* Mask assigned in val field in tracer_flags */
356 * The set of specific options for a tracer. Your tracer
357 * have to set the initial value of the flags val.
359 struct tracer_flags {
361 struct tracer_opt *opts;
362 struct tracer *trace;
365 /* Makes more easy to define a tracer opt */
366 #define TRACER_OPT(s, b) .name = #s, .bit = b
369 struct trace_option_dentry {
370 struct tracer_opt *opt;
371 struct tracer_flags *flags;
372 struct trace_array *tr;
373 struct dentry *entry;
377 * struct tracer - a specific tracer and its callbacks to interact with tracefs
378 * @name: the name chosen to select it on the available_tracers file
379 * @init: called when one switches to this tracer (echo name > current_tracer)
380 * @reset: called when one switches to another tracer
381 * @start: called when tracing is unpaused (echo 1 > tracing_on)
382 * @stop: called when tracing is paused (echo 0 > tracing_on)
383 * @update_thresh: called when tracing_thresh is updated
384 * @open: called when the trace file is opened
385 * @pipe_open: called when the trace_pipe file is opened
386 * @close: called when the trace file is released
387 * @pipe_close: called when the trace_pipe file is released
388 * @read: override the default read callback on trace_pipe
389 * @splice_read: override the default splice_read callback on trace_pipe
390 * @selftest: selftest to run on boot (see trace_selftest.c)
391 * @print_headers: override the first lines that describe your columns
392 * @print_line: callback that prints a trace
393 * @set_flag: signals one of your private flags changed (trace_options file)
394 * @flags: your private flags
398 int (*init)(struct trace_array *tr);
399 void (*reset)(struct trace_array *tr);
400 void (*start)(struct trace_array *tr);
401 void (*stop)(struct trace_array *tr);
402 int (*update_thresh)(struct trace_array *tr);
403 void (*open)(struct trace_iterator *iter);
404 void (*pipe_open)(struct trace_iterator *iter);
405 void (*close)(struct trace_iterator *iter);
406 void (*pipe_close)(struct trace_iterator *iter);
407 ssize_t (*read)(struct trace_iterator *iter,
408 struct file *filp, char __user *ubuf,
409 size_t cnt, loff_t *ppos);
410 ssize_t (*splice_read)(struct trace_iterator *iter,
413 struct pipe_inode_info *pipe,
416 #ifdef CONFIG_FTRACE_STARTUP_TEST
417 int (*selftest)(struct tracer *trace,
418 struct trace_array *tr);
420 void (*print_header)(struct seq_file *m);
421 enum print_line_t (*print_line)(struct trace_iterator *iter);
422 /* If you handled the flag setting, return 0 */
423 int (*set_flag)(struct trace_array *tr,
424 u32 old_flags, u32 bit, int set);
425 /* Return 0 if OK with change, else return non-zero */
426 int (*flag_changed)(struct trace_array *tr,
429 struct tracer_flags *flags;
433 bool allow_instances;
434 #ifdef CONFIG_TRACER_MAX_TRACE
440 /* Only current can touch trace_recursion */
443 * For function tracing recursion:
444 * The order of these bits are important.
446 * When function tracing occurs, the following steps are made:
447 * If arch does not support a ftrace feature:
448 * call internal function (uses INTERNAL bits) which calls...
449 * The function callback, which can use the FTRACE bits to
450 * check for recursion.
454 TRACE_BUFFER_NMI_BIT,
455 TRACE_BUFFER_IRQ_BIT,
456 TRACE_BUFFER_SIRQ_BIT,
458 /* Start of function recursion bits */
460 TRACE_FTRACE_NMI_BIT,
461 TRACE_FTRACE_IRQ_BIT,
462 TRACE_FTRACE_SIRQ_BIT,
463 TRACE_FTRACE_TRANSITION_BIT,
465 /* Internal use recursion bits */
467 TRACE_INTERNAL_NMI_BIT,
468 TRACE_INTERNAL_IRQ_BIT,
469 TRACE_INTERNAL_SIRQ_BIT,
470 TRACE_INTERNAL_TRANSITION_BIT,
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.
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)))
487 #define TRACE_CONTEXT_BITS 4
489 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
491 #define TRACE_LIST_START TRACE_INTERNAL_BIT
493 #define TRACE_CONTEXT_MASK ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
500 TRACE_CTX_TRANSITION,
503 static __always_inline int trace_get_context_bit(void)
507 if (in_interrupt()) {
514 bit = TRACE_CTX_SOFTIRQ;
516 bit = TRACE_CTX_NORMAL;
521 static __always_inline int trace_test_and_set_recursion(int start)
523 unsigned int val = current->trace_recursion;
526 bit = trace_get_context_bit() + start;
527 if (unlikely(val & (1 << bit))) {
529 * It could be that preempt_count has not been updated during
530 * a switch between contexts. Allow for a single recursion.
532 bit = start + TRACE_CTX_TRANSITION;
533 if (trace_recursion_test(bit))
535 trace_recursion_set(bit);
541 current->trace_recursion = val;
547 static __always_inline void trace_clear_recursion(int bit)
549 unsigned int val = current->trace_recursion;
555 current->trace_recursion = val;
558 static inline struct ring_buffer_iter *
559 trace_buffer_iter(struct trace_iterator *iter, int cpu)
561 if (iter->buffer_iter && iter->buffer_iter[cpu])
562 return iter->buffer_iter[cpu];
566 int tracer_init(struct tracer *t, struct trace_array *tr);
567 int tracing_is_enabled(void);
568 void tracing_reset(struct trace_buffer *buf, int cpu);
569 void tracing_reset_online_cpus(struct trace_buffer *buf);
570 void tracing_reset_current(int cpu);
571 void tracing_reset_all_online_cpus(void);
572 int tracing_open_generic(struct inode *inode, struct file *filp);
573 bool tracing_is_disabled(void);
574 int tracer_tracing_is_on(struct trace_array *tr);
575 struct dentry *trace_create_file(const char *name,
577 struct dentry *parent,
579 const struct file_operations *fops);
581 struct dentry *tracing_init_dentry(void);
583 struct ring_buffer_event;
585 struct ring_buffer_event *
586 trace_buffer_lock_reserve(struct ring_buffer *buffer,
592 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
593 struct trace_array_cpu *data);
595 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
596 int *ent_cpu, u64 *ent_ts);
598 void __buffer_unlock_commit(struct ring_buffer *buffer,
599 struct ring_buffer_event *event);
601 int trace_empty(struct trace_iterator *iter);
603 void *trace_find_next_entry_inc(struct trace_iterator *iter);
605 void trace_init_global_iter(struct trace_iterator *iter);
607 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
609 void trace_function(struct trace_array *tr,
611 unsigned long parent_ip,
612 unsigned long flags, int pc);
613 void trace_graph_function(struct trace_array *tr,
615 unsigned long parent_ip,
616 unsigned long flags, int pc);
617 void trace_latency_header(struct seq_file *m);
618 void trace_default_header(struct seq_file *m);
619 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
620 int trace_empty(struct trace_iterator *iter);
622 void trace_graph_return(struct ftrace_graph_ret *trace);
623 int trace_graph_entry(struct ftrace_graph_ent *trace);
624 void set_graph_array(struct trace_array *tr);
626 void tracing_start_cmdline_record(void);
627 void tracing_stop_cmdline_record(void);
628 int register_tracer(struct tracer *type);
629 int is_tracing_stopped(void);
631 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
633 extern cpumask_var_t __read_mostly tracing_buffer_mask;
635 #define for_each_tracing_cpu(cpu) \
636 for_each_cpu(cpu, tracing_buffer_mask)
638 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
640 extern unsigned long tracing_thresh;
646 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
648 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
649 struct task_struct *task);
650 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
651 struct task_struct *self,
652 struct task_struct *task);
653 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
654 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
655 int trace_pid_show(struct seq_file *m, void *v);
656 void trace_free_pid_list(struct trace_pid_list *pid_list);
657 int trace_pid_write(struct trace_pid_list *filtered_pids,
658 struct trace_pid_list **new_pid_list,
659 const char __user *ubuf, size_t cnt);
661 #ifdef CONFIG_TRACER_MAX_TRACE
662 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
663 void update_max_tr_single(struct trace_array *tr,
664 struct task_struct *tsk, int cpu);
665 #endif /* CONFIG_TRACER_MAX_TRACE */
667 #ifdef CONFIG_STACKTRACE
668 void ftrace_trace_userstack(struct trace_array *tr,
669 struct ring_buffer *buffer, unsigned long flags,
672 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
675 static inline void ftrace_trace_userstack(struct trace_array *tr,
676 struct ring_buffer *buffer,
677 unsigned long flags, int pc)
681 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
685 #endif /* CONFIG_STACKTRACE */
687 extern cycle_t ftrace_now(int cpu);
689 extern void trace_find_cmdline(int pid, char comm[]);
690 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
692 #ifdef CONFIG_DYNAMIC_FTRACE
693 extern unsigned long ftrace_update_tot_cnt;
695 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
696 extern int DYN_FTRACE_TEST_NAME(void);
697 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
698 extern int DYN_FTRACE_TEST_NAME2(void);
700 extern bool ring_buffer_expanded;
701 extern bool tracing_selftest_disabled;
703 #ifdef CONFIG_FTRACE_STARTUP_TEST
704 extern int trace_selftest_startup_function(struct tracer *trace,
705 struct trace_array *tr);
706 extern int trace_selftest_startup_function_graph(struct tracer *trace,
707 struct trace_array *tr);
708 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
709 struct trace_array *tr);
710 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
711 struct trace_array *tr);
712 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
713 struct trace_array *tr);
714 extern int trace_selftest_startup_wakeup(struct tracer *trace,
715 struct trace_array *tr);
716 extern int trace_selftest_startup_nop(struct tracer *trace,
717 struct trace_array *tr);
718 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
719 struct trace_array *tr);
720 extern int trace_selftest_startup_branch(struct tracer *trace,
721 struct trace_array *tr);
723 * Tracer data references selftest functions that only occur
724 * on boot up. These can be __init functions. Thus, when selftests
725 * are enabled, then the tracers need to reference __init functions.
727 #define __tracer_data __refdata
729 /* Tracers are seldom changed. Optimize when selftests are disabled. */
730 #define __tracer_data __read_mostly
731 #endif /* CONFIG_FTRACE_STARTUP_TEST */
733 extern void *head_page(struct trace_array_cpu *data);
734 extern unsigned long long ns2usecs(cycle_t nsec);
736 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
738 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
740 trace_array_vprintk(struct trace_array *tr,
741 unsigned long ip, const char *fmt, va_list args);
742 int trace_array_printk(struct trace_array *tr,
743 unsigned long ip, const char *fmt, ...);
744 int trace_array_printk_buf(struct ring_buffer *buffer,
745 unsigned long ip, const char *fmt, ...);
746 void trace_printk_seq(struct trace_seq *s);
747 enum print_line_t print_trace_line(struct trace_iterator *iter);
749 extern char trace_find_mark(unsigned long long duration);
751 /* Standard output formatting function used for function return traces */
752 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
755 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
756 #define TRACE_GRAPH_PRINT_CPU 0x2
757 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
758 #define TRACE_GRAPH_PRINT_PROC 0x8
759 #define TRACE_GRAPH_PRINT_DURATION 0x10
760 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
761 #define TRACE_GRAPH_PRINT_IRQS 0x40
762 #define TRACE_GRAPH_PRINT_TAIL 0x80
763 #define TRACE_GRAPH_SLEEP_TIME 0x100
764 #define TRACE_GRAPH_GRAPH_TIME 0x200
765 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
766 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
768 extern void ftrace_graph_sleep_time_control(bool enable);
769 extern void ftrace_graph_graph_time_control(bool enable);
771 extern enum print_line_t
772 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
773 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
775 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
776 extern void graph_trace_open(struct trace_iterator *iter);
777 extern void graph_trace_close(struct trace_iterator *iter);
778 extern int __trace_graph_entry(struct trace_array *tr,
779 struct ftrace_graph_ent *trace,
780 unsigned long flags, int pc);
781 extern void __trace_graph_return(struct trace_array *tr,
782 struct ftrace_graph_ret *trace,
783 unsigned long flags, int pc);
786 #ifdef CONFIG_DYNAMIC_FTRACE
787 /* TODO: make this variable */
788 #define FTRACE_GRAPH_MAX_FUNCS 32
789 extern int ftrace_graph_count;
790 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
791 extern int ftrace_graph_notrace_count;
792 extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
794 static inline int ftrace_graph_addr(unsigned long addr)
798 if (!ftrace_graph_count)
801 for (i = 0; i < ftrace_graph_count; i++) {
802 if (addr == ftrace_graph_funcs[i]) {
804 * If no irqs are to be traced, but a set_graph_function
805 * is set, and called by an interrupt handler, we still
809 trace_recursion_set(TRACE_IRQ_BIT);
811 trace_recursion_clear(TRACE_IRQ_BIT);
819 static inline int ftrace_graph_notrace_addr(unsigned long addr)
823 if (!ftrace_graph_notrace_count)
826 for (i = 0; i < ftrace_graph_notrace_count; i++) {
827 if (addr == ftrace_graph_notrace_funcs[i])
834 static inline int ftrace_graph_addr(unsigned long addr)
839 static inline int ftrace_graph_notrace_addr(unsigned long addr)
843 #endif /* CONFIG_DYNAMIC_FTRACE */
844 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
845 static inline enum print_line_t
846 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
848 return TRACE_TYPE_UNHANDLED;
850 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
852 extern struct list_head ftrace_pids;
854 #ifdef CONFIG_FUNCTION_TRACER
855 extern bool ftrace_filter_param __initdata;
856 static inline int ftrace_trace_task(struct trace_array *tr)
858 return !this_cpu_read(tr->trace_buffer.data->ftrace_ignore_pid);
860 extern int ftrace_is_dead(void);
861 int ftrace_create_function_files(struct trace_array *tr,
862 struct dentry *parent);
863 void ftrace_destroy_function_files(struct trace_array *tr);
864 void ftrace_init_global_array_ops(struct trace_array *tr);
865 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
866 void ftrace_reset_array_ops(struct trace_array *tr);
867 int using_ftrace_ops_list_func(void);
868 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
869 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
870 struct dentry *d_tracer);
871 void ftrace_clear_pids(struct trace_array *tr);
873 static inline int ftrace_trace_task(struct trace_array *tr)
877 static inline int ftrace_is_dead(void) { return 0; }
879 ftrace_create_function_files(struct trace_array *tr,
880 struct dentry *parent)
884 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
885 static inline __init void
886 ftrace_init_global_array_ops(struct trace_array *tr) { }
887 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
888 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
889 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
890 static inline void ftrace_clear_pids(struct trace_array *tr) { }
891 /* ftace_func_t type is not defined, use macro instead of static inline */
892 #define ftrace_init_array_ops(tr, func) do { } while (0)
893 #endif /* CONFIG_FUNCTION_TRACER */
895 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
896 void ftrace_create_filter_files(struct ftrace_ops *ops,
897 struct dentry *parent);
898 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
901 * The ops parameter passed in is usually undefined.
902 * This must be a macro.
904 #define ftrace_create_filter_files(ops, parent) do { } while (0)
905 #define ftrace_destroy_filter_files(ops) do { } while (0)
906 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
908 bool ftrace_event_is_function(struct trace_event_call *call);
911 * struct trace_parser - servers for reading the user input separated by spaces
912 * @cont: set if the input is not complete - no final space char was found
913 * @buffer: holds the parsed user input
914 * @idx: user input length
917 struct trace_parser {
924 static inline bool trace_parser_loaded(struct trace_parser *parser)
926 return (parser->idx != 0);
929 static inline bool trace_parser_cont(struct trace_parser *parser)
934 static inline void trace_parser_clear(struct trace_parser *parser)
936 parser->cont = false;
940 extern int trace_parser_get_init(struct trace_parser *parser, int size);
941 extern void trace_parser_put(struct trace_parser *parser);
942 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
943 size_t cnt, loff_t *ppos);
946 * Only create function graph options if function graph is configured.
948 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
949 # define FGRAPH_FLAGS \
950 C(DISPLAY_GRAPH, "display-graph"),
952 # define FGRAPH_FLAGS
955 #ifdef CONFIG_BRANCH_TRACER
956 # define BRANCH_FLAGS \
959 # define BRANCH_FLAGS
962 #ifdef CONFIG_FUNCTION_TRACER
963 # define FUNCTION_FLAGS \
964 C(FUNCTION, "function-trace"),
965 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
967 # define FUNCTION_FLAGS
968 # define FUNCTION_DEFAULT_FLAGS 0UL
971 #ifdef CONFIG_STACKTRACE
972 # define STACK_FLAGS \
973 C(STACKTRACE, "stacktrace"),
979 * trace_iterator_flags is an enumeration that defines bit
980 * positions into trace_flags that controls the output.
982 * NOTE: These bits must match the trace_options array in
983 * trace.c (this macro guarantees it).
985 #define TRACE_FLAGS \
986 C(PRINT_PARENT, "print-parent"), \
987 C(SYM_OFFSET, "sym-offset"), \
988 C(SYM_ADDR, "sym-addr"), \
989 C(VERBOSE, "verbose"), \
994 C(PRINTK, "trace_printk"), \
995 C(ANNOTATE, "annotate"), \
996 C(USERSTACKTRACE, "userstacktrace"), \
997 C(SYM_USEROBJ, "sym-userobj"), \
998 C(PRINTK_MSGONLY, "printk-msg-only"), \
999 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1000 C(LATENCY_FMT, "latency-format"), \
1001 C(RECORD_CMD, "record-cmd"), \
1002 C(OVERWRITE, "overwrite"), \
1003 C(STOP_ON_FREE, "disable_on_free"), \
1004 C(IRQ_INFO, "irq-info"), \
1005 C(MARKERS, "markers"), \
1006 C(EVENT_FORK, "event-fork"), \
1013 * By defining C, we can make TRACE_FLAGS a list of bit names
1014 * that will define the bits for the flag masks.
1017 #define C(a, b) TRACE_ITER_##a##_BIT
1019 enum trace_iterator_bits {
1021 /* Make sure we don't go more than we have bits for */
1026 * By redefining C, we can make TRACE_FLAGS a list of masks that
1027 * use the bits as defined above.
1030 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1032 enum trace_iterator_flags { TRACE_FLAGS };
1035 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1036 * control the output of kernel symbols.
1038 #define TRACE_ITER_SYM_MASK \
1039 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1041 extern struct tracer nop_trace;
1043 #ifdef CONFIG_BRANCH_TRACER
1044 extern int enable_branch_tracing(struct trace_array *tr);
1045 extern void disable_branch_tracing(void);
1046 static inline int trace_branch_enable(struct trace_array *tr)
1048 if (tr->trace_flags & TRACE_ITER_BRANCH)
1049 return enable_branch_tracing(tr);
1052 static inline void trace_branch_disable(void)
1054 /* due to races, always disable */
1055 disable_branch_tracing();
1058 static inline int trace_branch_enable(struct trace_array *tr)
1062 static inline void trace_branch_disable(void)
1065 #endif /* CONFIG_BRANCH_TRACER */
1067 /* set ring buffers to default size if not already done so */
1068 int tracing_update_buffers(void);
1070 struct ftrace_event_field {
1071 struct list_head link;
1080 struct event_filter {
1081 int n_preds; /* Number assigned */
1082 int a_preds; /* allocated */
1083 struct filter_pred *preds;
1084 struct filter_pred *root;
1085 char *filter_string;
1088 struct event_subsystem {
1089 struct list_head list;
1091 struct event_filter *filter;
1095 struct trace_subsystem_dir {
1096 struct list_head list;
1097 struct event_subsystem *subsystem;
1098 struct trace_array *tr;
1099 struct dentry *entry;
1104 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1105 struct ring_buffer *buffer,
1106 struct ring_buffer_event *event);
1108 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1109 struct ring_buffer *buffer,
1110 struct ring_buffer_event *event,
1111 unsigned long flags, int pc,
1112 struct pt_regs *regs);
1114 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1115 struct ring_buffer *buffer,
1116 struct ring_buffer_event *event,
1117 unsigned long flags, int pc)
1119 trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1122 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1123 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1124 void trace_buffered_event_disable(void);
1125 void trace_buffered_event_enable(void);
1128 __trace_event_discard_commit(struct ring_buffer *buffer,
1129 struct ring_buffer_event *event)
1131 if (this_cpu_read(trace_buffered_event) == event) {
1132 /* Simply release the temp buffer */
1133 this_cpu_dec(trace_buffered_event_cnt);
1136 ring_buffer_discard_commit(buffer, event);
1140 * Helper function for event_trigger_unlock_commit{_regs}().
1141 * If there are event triggers attached to this event that requires
1142 * filtering against its fields, then they wil be called as the
1143 * entry already holds the field information of the current event.
1145 * It also checks if the event should be discarded or not.
1146 * It is to be discarded if the event is soft disabled and the
1147 * event was only recorded to process triggers, or if the event
1148 * filter is active and this event did not match the filters.
1150 * Returns true if the event is discarded, false otherwise.
1153 __event_trigger_test_discard(struct trace_event_file *file,
1154 struct ring_buffer *buffer,
1155 struct ring_buffer_event *event,
1157 enum event_trigger_type *tt)
1159 unsigned long eflags = file->flags;
1161 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1162 *tt = event_triggers_call(file, entry);
1164 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1165 EVENT_FILE_FL_FILTERED |
1166 EVENT_FILE_FL_PID_FILTER))))
1169 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1172 if (file->flags & EVENT_FILE_FL_FILTERED &&
1173 !filter_match_preds(file->filter, entry))
1176 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1177 trace_event_ignore_this_pid(file))
1182 __trace_event_discard_commit(buffer, event);
1187 * event_trigger_unlock_commit - handle triggers and finish event commit
1188 * @file: The file pointer assoctiated to the event
1189 * @buffer: The ring buffer that the event is being written to
1190 * @event: The event meta data in the ring buffer
1191 * @entry: The event itself
1192 * @irq_flags: The state of the interrupts at the start of the event
1193 * @pc: The state of the preempt count at the start of the event.
1195 * This is a helper function to handle triggers that require data
1196 * from the event itself. It also tests the event against filters and
1197 * if the event is soft disabled and should be discarded.
1200 event_trigger_unlock_commit(struct trace_event_file *file,
1201 struct ring_buffer *buffer,
1202 struct ring_buffer_event *event,
1203 void *entry, unsigned long irq_flags, int pc)
1205 enum event_trigger_type tt = ETT_NONE;
1207 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1208 trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1211 event_triggers_post_call(file, tt, entry);
1215 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1216 * @file: The file pointer assoctiated to the event
1217 * @buffer: The ring buffer that the event is being written to
1218 * @event: The event meta data in the ring buffer
1219 * @entry: The event itself
1220 * @irq_flags: The state of the interrupts at the start of the event
1221 * @pc: The state of the preempt count at the start of the event.
1223 * This is a helper function to handle triggers that require data
1224 * from the event itself. It also tests the event against filters and
1225 * if the event is soft disabled and should be discarded.
1227 * Same as event_trigger_unlock_commit() but calls
1228 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1231 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1232 struct ring_buffer *buffer,
1233 struct ring_buffer_event *event,
1234 void *entry, unsigned long irq_flags, int pc,
1235 struct pt_regs *regs)
1237 enum event_trigger_type tt = ETT_NONE;
1239 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1240 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1241 irq_flags, pc, regs);
1244 event_triggers_post_call(file, tt, entry);
1247 #define FILTER_PRED_INVALID ((unsigned short)-1)
1248 #define FILTER_PRED_IS_RIGHT (1 << 15)
1249 #define FILTER_PRED_FOLD (1 << 15)
1252 * The max preds is the size of unsigned short with
1253 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1254 * and FOLD flags. The other is reserved.
1256 * 2^14 preds is way more than enough.
1258 #define MAX_FILTER_PRED 16384
1263 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1265 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1275 char pattern[MAX_FILTER_STR_VAL];
1278 regex_match_func match;
1281 struct filter_pred {
1282 filter_pred_fn_t fn;
1285 unsigned short *ops;
1286 struct ftrace_event_field *field;
1290 unsigned short index;
1291 unsigned short parent;
1292 unsigned short left;
1293 unsigned short right;
1296 static inline bool is_string_field(struct ftrace_event_field *field)
1298 return field->filter_type == FILTER_DYN_STRING ||
1299 field->filter_type == FILTER_STATIC_STRING ||
1300 field->filter_type == FILTER_PTR_STRING;
1303 static inline bool is_function_field(struct ftrace_event_field *field)
1305 return field->filter_type == FILTER_TRACE_FN;
1308 extern enum regex_type
1309 filter_parse_regex(char *buff, int len, char **search, int *not);
1310 extern void print_event_filter(struct trace_event_file *file,
1311 struct trace_seq *s);
1312 extern int apply_event_filter(struct trace_event_file *file,
1313 char *filter_string);
1314 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1315 char *filter_string);
1316 extern void print_subsystem_event_filter(struct event_subsystem *system,
1317 struct trace_seq *s);
1318 extern int filter_assign_type(const char *type);
1319 extern int create_event_filter(struct trace_event_call *call,
1320 char *filter_str, bool set_str,
1321 struct event_filter **filterp);
1322 extern void free_event_filter(struct event_filter *filter);
1324 struct ftrace_event_field *
1325 trace_find_event_field(struct trace_event_call *call, char *name);
1327 extern void trace_event_enable_cmd_record(bool enable);
1328 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1329 extern int event_trace_del_tracer(struct trace_array *tr);
1331 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1335 static inline void *event_file_data(struct file *filp)
1337 return ACCESS_ONCE(file_inode(filp)->i_private);
1340 extern struct mutex event_mutex;
1341 extern struct list_head ftrace_events;
1343 extern const struct file_operations event_trigger_fops;
1344 extern const struct file_operations event_hist_fops;
1346 #ifdef CONFIG_HIST_TRIGGERS
1347 extern int register_trigger_hist_cmd(void);
1348 extern int register_trigger_hist_enable_disable_cmds(void);
1350 static inline int register_trigger_hist_cmd(void) { return 0; }
1351 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1354 extern int register_trigger_cmds(void);
1355 extern void clear_event_triggers(struct trace_array *tr);
1357 struct event_trigger_data {
1358 unsigned long count;
1360 struct event_trigger_ops *ops;
1361 struct event_command *cmd_ops;
1362 struct event_filter __rcu *filter;
1367 struct list_head list;
1369 struct list_head named_list;
1370 struct event_trigger_data *named_data;
1374 #define ENABLE_EVENT_STR "enable_event"
1375 #define DISABLE_EVENT_STR "disable_event"
1376 #define ENABLE_HIST_STR "enable_hist"
1377 #define DISABLE_HIST_STR "disable_hist"
1379 struct enable_trigger_data {
1380 struct trace_event_file *file;
1385 extern int event_enable_trigger_print(struct seq_file *m,
1386 struct event_trigger_ops *ops,
1387 struct event_trigger_data *data);
1388 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1389 struct event_trigger_data *data);
1390 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1391 struct trace_event_file *file,
1392 char *glob, char *cmd, char *param);
1393 extern int event_enable_register_trigger(char *glob,
1394 struct event_trigger_ops *ops,
1395 struct event_trigger_data *data,
1396 struct trace_event_file *file);
1397 extern void event_enable_unregister_trigger(char *glob,
1398 struct event_trigger_ops *ops,
1399 struct event_trigger_data *test,
1400 struct trace_event_file *file);
1401 extern void trigger_data_free(struct event_trigger_data *data);
1402 extern int event_trigger_init(struct event_trigger_ops *ops,
1403 struct event_trigger_data *data);
1404 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1405 int trigger_enable);
1406 extern void update_cond_flag(struct trace_event_file *file);
1407 extern void unregister_trigger(char *glob, struct event_trigger_ops *ops,
1408 struct event_trigger_data *test,
1409 struct trace_event_file *file);
1410 extern int set_trigger_filter(char *filter_str,
1411 struct event_trigger_data *trigger_data,
1412 struct trace_event_file *file);
1413 extern struct event_trigger_data *find_named_trigger(const char *name);
1414 extern bool is_named_trigger(struct event_trigger_data *test);
1415 extern int save_named_trigger(const char *name,
1416 struct event_trigger_data *data);
1417 extern void del_named_trigger(struct event_trigger_data *data);
1418 extern void pause_named_trigger(struct event_trigger_data *data);
1419 extern void unpause_named_trigger(struct event_trigger_data *data);
1420 extern void set_named_trigger_data(struct event_trigger_data *data,
1421 struct event_trigger_data *named_data);
1422 extern int register_event_command(struct event_command *cmd);
1423 extern int unregister_event_command(struct event_command *cmd);
1424 extern int register_trigger_hist_enable_disable_cmds(void);
1427 * struct event_trigger_ops - callbacks for trace event triggers
1429 * The methods in this structure provide per-event trigger hooks for
1430 * various trigger operations.
1432 * All the methods below, except for @init() and @free(), must be
1435 * @func: The trigger 'probe' function called when the triggering
1436 * event occurs. The data passed into this callback is the data
1437 * that was supplied to the event_command @reg() function that
1438 * registered the trigger (see struct event_command) along with
1439 * the trace record, rec.
1441 * @init: An optional initialization function called for the trigger
1442 * when the trigger is registered (via the event_command reg()
1443 * function). This can be used to perform per-trigger
1444 * initialization such as incrementing a per-trigger reference
1445 * count, for instance. This is usually implemented by the
1446 * generic utility function @event_trigger_init() (see
1447 * trace_event_triggers.c).
1449 * @free: An optional de-initialization function called for the
1450 * trigger when the trigger is unregistered (via the
1451 * event_command @reg() function). This can be used to perform
1452 * per-trigger de-initialization such as decrementing a
1453 * per-trigger reference count and freeing corresponding trigger
1454 * data, for instance. This is usually implemented by the
1455 * generic utility function @event_trigger_free() (see
1456 * trace_event_triggers.c).
1458 * @print: The callback function invoked to have the trigger print
1459 * itself. This is usually implemented by a wrapper function
1460 * that calls the generic utility function @event_trigger_print()
1461 * (see trace_event_triggers.c).
1463 struct event_trigger_ops {
1464 void (*func)(struct event_trigger_data *data,
1466 int (*init)(struct event_trigger_ops *ops,
1467 struct event_trigger_data *data);
1468 void (*free)(struct event_trigger_ops *ops,
1469 struct event_trigger_data *data);
1470 int (*print)(struct seq_file *m,
1471 struct event_trigger_ops *ops,
1472 struct event_trigger_data *data);
1476 * struct event_command - callbacks and data members for event commands
1478 * Event commands are invoked by users by writing the command name
1479 * into the 'trigger' file associated with a trace event. The
1480 * parameters associated with a specific invocation of an event
1481 * command are used to create an event trigger instance, which is
1482 * added to the list of trigger instances associated with that trace
1483 * event. When the event is hit, the set of triggers associated with
1484 * that event is invoked.
1486 * The data members in this structure provide per-event command data
1487 * for various event commands.
1489 * All the data members below, except for @post_trigger, must be set
1490 * for each event command.
1492 * @name: The unique name that identifies the event command. This is
1493 * the name used when setting triggers via trigger files.
1495 * @trigger_type: A unique id that identifies the event command
1496 * 'type'. This value has two purposes, the first to ensure that
1497 * only one trigger of the same type can be set at a given time
1498 * for a particular event e.g. it doesn't make sense to have both
1499 * a traceon and traceoff trigger attached to a single event at
1500 * the same time, so traceon and traceoff have the same type
1501 * though they have different names. The @trigger_type value is
1502 * also used as a bit value for deferring the actual trigger
1503 * action until after the current event is finished. Some
1504 * commands need to do this if they themselves log to the trace
1505 * buffer (see the @post_trigger() member below). @trigger_type
1506 * values are defined by adding new values to the trigger_type
1507 * enum in include/linux/trace_events.h.
1509 * @flags: See the enum event_command_flags below.
1511 * All the methods below, except for @set_filter() and @unreg_all(),
1512 * must be implemented.
1514 * @func: The callback function responsible for parsing and
1515 * registering the trigger written to the 'trigger' file by the
1516 * user. It allocates the trigger instance and registers it with
1517 * the appropriate trace event. It makes use of the other
1518 * event_command callback functions to orchestrate this, and is
1519 * usually implemented by the generic utility function
1520 * @event_trigger_callback() (see trace_event_triggers.c).
1522 * @reg: Adds the trigger to the list of triggers associated with the
1523 * event, and enables the event trigger itself, after
1524 * initializing it (via the event_trigger_ops @init() function).
1525 * This is also where commands can use the @trigger_type value to
1526 * make the decision as to whether or not multiple instances of
1527 * the trigger should be allowed. This is usually implemented by
1528 * the generic utility function @register_trigger() (see
1529 * trace_event_triggers.c).
1531 * @unreg: Removes the trigger from the list of triggers associated
1532 * with the event, and disables the event trigger itself, after
1533 * initializing it (via the event_trigger_ops @free() function).
1534 * This is usually implemented by the generic utility function
1535 * @unregister_trigger() (see trace_event_triggers.c).
1537 * @unreg_all: An optional function called to remove all the triggers
1538 * from the list of triggers associated with the event. Called
1539 * when a trigger file is opened in truncate mode.
1541 * @set_filter: An optional function called to parse and set a filter
1542 * for the trigger. If no @set_filter() method is set for the
1543 * event command, filters set by the user for the command will be
1544 * ignored. This is usually implemented by the generic utility
1545 * function @set_trigger_filter() (see trace_event_triggers.c).
1547 * @get_trigger_ops: The callback function invoked to retrieve the
1548 * event_trigger_ops implementation associated with the command.
1550 struct event_command {
1551 struct list_head list;
1553 enum event_trigger_type trigger_type;
1555 int (*func)(struct event_command *cmd_ops,
1556 struct trace_event_file *file,
1557 char *glob, char *cmd, char *params);
1558 int (*reg)(char *glob,
1559 struct event_trigger_ops *ops,
1560 struct event_trigger_data *data,
1561 struct trace_event_file *file);
1562 void (*unreg)(char *glob,
1563 struct event_trigger_ops *ops,
1564 struct event_trigger_data *data,
1565 struct trace_event_file *file);
1566 void (*unreg_all)(struct trace_event_file *file);
1567 int (*set_filter)(char *filter_str,
1568 struct event_trigger_data *data,
1569 struct trace_event_file *file);
1570 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1574 * enum event_command_flags - flags for struct event_command
1576 * @POST_TRIGGER: A flag that says whether or not this command needs
1577 * to have its action delayed until after the current event has
1578 * been closed. Some triggers need to avoid being invoked while
1579 * an event is currently in the process of being logged, since
1580 * the trigger may itself log data into the trace buffer. Thus
1581 * we make sure the current event is committed before invoking
1582 * those triggers. To do that, the trigger invocation is split
1583 * in two - the first part checks the filter using the current
1584 * trace record; if a command has the @post_trigger flag set, it
1585 * sets a bit for itself in the return value, otherwise it
1586 * directly invokes the trigger. Once all commands have been
1587 * either invoked or set their return flag, the current record is
1588 * either committed or discarded. At that point, if any commands
1589 * have deferred their triggers, those commands are finally
1590 * invoked following the close of the current event. In other
1591 * words, if the event_trigger_ops @func() probe implementation
1592 * itself logs to the trace buffer, this flag should be set,
1593 * otherwise it can be left unspecified.
1595 * @NEEDS_REC: A flag that says whether or not this command needs
1596 * access to the trace record in order to perform its function,
1597 * regardless of whether or not it has a filter associated with
1598 * it (filters make a trigger require access to the trace record
1599 * but are not always present).
1601 enum event_command_flags {
1602 EVENT_CMD_FL_POST_TRIGGER = 1,
1603 EVENT_CMD_FL_NEEDS_REC = 2,
1606 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1608 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1611 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1613 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1616 extern int trace_event_enable_disable(struct trace_event_file *file,
1617 int enable, int soft_disable);
1618 extern int tracing_alloc_snapshot(void);
1620 extern const char *__start___trace_bprintk_fmt[];
1621 extern const char *__stop___trace_bprintk_fmt[];
1623 extern const char *__start___tracepoint_str[];
1624 extern const char *__stop___tracepoint_str[];
1626 void trace_printk_control(bool enabled);
1627 void trace_printk_init_buffers(void);
1628 void trace_printk_start_comm(void);
1629 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1630 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1633 * Normal trace_printk() and friends allocates special buffers
1634 * to do the manipulation, as well as saves the print formats
1635 * into sections to display. But the trace infrastructure wants
1636 * to use these without the added overhead at the price of being
1637 * a bit slower (used mainly for warnings, where we don't care
1638 * about performance). The internal_trace_puts() is for such
1641 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1644 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1645 extern struct trace_event_call \
1646 __aligned(4) event_##call;
1647 #undef FTRACE_ENTRY_DUP
1648 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1649 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1651 #undef FTRACE_ENTRY_PACKED
1652 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1653 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1656 #include "trace_entries.h"
1658 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1659 int perf_ftrace_event_register(struct trace_event_call *call,
1660 enum trace_reg type, void *data);
1662 #define perf_ftrace_event_register NULL
1665 #ifdef CONFIG_FTRACE_SYSCALLS
1666 void init_ftrace_syscalls(void);
1667 const char *get_syscall_name(int syscall);
1669 static inline void init_ftrace_syscalls(void) { }
1670 static inline const char *get_syscall_name(int syscall)
1676 #ifdef CONFIG_EVENT_TRACING
1677 void trace_event_init(void);
1678 void trace_event_enum_update(struct trace_enum_map **map, int len);
1680 static inline void __init trace_event_init(void) { }
1681 static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1684 extern struct trace_iterator *tracepoint_print_iter;
1687 * Reset the state of the trace_iterator so that it can read consumed data.
1688 * Normally, the trace_iterator is used for reading the data when it is not
1689 * consumed, and must retain state.
1691 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1693 const size_t offset = offsetof(struct trace_iterator, seq);
1696 * Keep gcc from complaining about overwriting more than just one
1697 * member in the structure.
1699 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1704 #endif /* _LINUX_KERNEL_TRACE_H */