1 // SPDX-License-Identifier: GPL-2.0
3 #ifndef _LINUX_KERNEL_TRACE_H
4 #define _LINUX_KERNEL_TRACE_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/hw_breakpoint.h>
15 #include <linux/trace_seq.h>
16 #include <linux/trace_events.h>
17 #include <linux/compiler.h>
18 #include <linux/trace_seq.h>
19 #include <linux/glob.h>
21 #ifdef CONFIG_FTRACE_SYSCALLS
22 #include <asm/unistd.h> /* For NR_SYSCALLS */
23 #include <asm/syscall.h> /* some archs define it here */
27 __TRACE_FIRST_TYPE = 0,
51 #define __field(type, item) type item;
54 #define __field_struct(type, item) __field(type, item)
57 #define __field_desc(type, container, item)
60 #define __array(type, item, size) type item[size];
63 #define __array_desc(type, container, item, size)
65 #undef __dynamic_array
66 #define __dynamic_array(type, item) type item[];
69 #define F_STRUCT(args...) args
72 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
73 struct struct_name { \
74 struct trace_entry ent; \
78 #undef FTRACE_ENTRY_DUP
79 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
81 #undef FTRACE_ENTRY_REG
82 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
84 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
87 #undef FTRACE_ENTRY_PACKED
88 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print, \
90 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
93 #include "trace_entries.h"
96 * syscalls are special, and need special handling, this is why
97 * they are not included in trace_entries.h
99 struct syscall_trace_enter {
100 struct trace_entry ent;
102 unsigned long args[];
105 struct syscall_trace_exit {
106 struct trace_entry ent;
111 struct kprobe_trace_entry_head {
112 struct trace_entry ent;
116 struct kretprobe_trace_entry_head {
117 struct trace_entry ent;
119 unsigned long ret_ip;
123 * trace_flag_type is an enumeration that holds different
124 * states when a trace occurs. These are:
125 * IRQS_OFF - interrupts were disabled
126 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
127 * NEED_RESCHED - reschedule is requested
128 * HARDIRQ - inside an interrupt handler
129 * SOFTIRQ - inside a softirq handler
131 enum trace_flag_type {
132 TRACE_FLAG_IRQS_OFF = 0x01,
133 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
134 TRACE_FLAG_NEED_RESCHED = 0x04,
135 TRACE_FLAG_HARDIRQ = 0x08,
136 TRACE_FLAG_SOFTIRQ = 0x10,
137 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
138 TRACE_FLAG_NMI = 0x40,
141 #define TRACE_BUF_SIZE 1024
146 * The CPU trace array - it consists of thousands of trace entries
147 * plus some other descriptor data: (for example which task started
150 struct trace_array_cpu {
152 void *buffer_page; /* ring buffer spare */
154 unsigned long entries;
155 unsigned long saved_latency;
156 unsigned long critical_start;
157 unsigned long critical_end;
158 unsigned long critical_sequence;
160 unsigned long policy;
161 unsigned long rt_priority;
162 unsigned long skipped_entries;
163 u64 preempt_timestamp;
166 char comm[TASK_COMM_LEN];
169 #ifdef CONFIG_FUNCTION_TRACER
170 bool ftrace_ignore_pid;
175 struct trace_option_dentry;
177 struct trace_buffer {
178 struct trace_array *tr;
179 struct ring_buffer *buffer;
180 struct trace_array_cpu __percpu *data;
185 #define TRACE_FLAGS_MAX_SIZE 32
187 struct trace_options {
188 struct tracer *tracer;
189 struct trace_option_dentry *topts;
192 struct trace_pid_list {
198 * The trace array - an array of per-CPU trace arrays. This is the
199 * highest level data structure that individual tracers deal with.
200 * They have on/off state as well:
203 struct list_head list;
205 struct trace_buffer trace_buffer;
206 #ifdef CONFIG_TRACER_MAX_TRACE
208 * The max_buffer is used to snapshot the trace when a maximum
209 * latency is reached, or when the user initiates a snapshot.
210 * Some tracers will use this to store a maximum trace while
211 * it continues examining live traces.
213 * The buffers for the max_buffer are set up the same as the trace_buffer
214 * When a snapshot is taken, the buffer of the max_buffer is swapped
215 * with the buffer of the trace_buffer and the buffers are reset for
216 * the trace_buffer so the tracing can continue.
218 struct trace_buffer max_buffer;
219 bool allocated_snapshot;
221 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
222 unsigned long max_latency;
224 struct trace_pid_list __rcu *filtered_pids;
226 * max_lock is used to protect the swapping of buffers
227 * when taking a max snapshot. The buffers themselves are
228 * protected by per_cpu spinlocks. But the action of the swap
229 * needs its own lock.
231 * This is defined as a arch_spinlock_t in order to help
232 * with performance when lockdep debugging is enabled.
234 * It is also used in other places outside the update_max_tr
235 * so it needs to be defined outside of the
236 * CONFIG_TRACER_MAX_TRACE.
238 arch_spinlock_t max_lock;
240 #ifdef CONFIG_FTRACE_SYSCALLS
241 int sys_refcount_enter;
242 int sys_refcount_exit;
243 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
244 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
250 struct tracer *current_trace;
251 unsigned int trace_flags;
252 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
254 raw_spinlock_t start_lock;
256 struct dentry *options;
257 struct dentry *percpu_dir;
258 struct dentry *event_dir;
259 struct trace_options *topts;
260 struct list_head systems;
261 struct list_head events;
262 struct trace_event_file *trace_marker_file;
263 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
265 #ifdef CONFIG_FUNCTION_TRACER
266 struct ftrace_ops *ops;
267 struct trace_pid_list __rcu *function_pids;
268 #ifdef CONFIG_DYNAMIC_FTRACE
269 /* All of these are protected by the ftrace_lock */
270 struct list_head func_probes;
271 struct list_head mod_trace;
272 struct list_head mod_notrace;
274 /* function tracing enabled */
275 int function_enabled;
277 int time_stamp_abs_ref;
278 struct list_head hist_vars;
282 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
285 extern struct list_head ftrace_trace_arrays;
287 extern struct mutex trace_types_lock;
289 extern int trace_array_get(struct trace_array *tr);
290 extern void trace_array_put(struct trace_array *tr);
292 extern int tracing_set_time_stamp_abs(struct trace_array *tr, bool abs);
293 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
295 extern bool trace_clock_in_ns(struct trace_array *tr);
298 * The global tracer (top) should be the first trace array added,
299 * but we check the flag anyway.
301 static inline struct trace_array *top_trace_array(void)
303 struct trace_array *tr;
305 if (list_empty(&ftrace_trace_arrays))
308 tr = list_entry(ftrace_trace_arrays.prev,
310 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
314 #define FTRACE_CMP_TYPE(var, type) \
315 __builtin_types_compatible_p(typeof(var), type *)
318 #define IF_ASSIGN(var, entry, etype, id) \
319 if (FTRACE_CMP_TYPE(var, etype)) { \
320 var = (typeof(var))(entry); \
321 WARN_ON(id && (entry)->type != id); \
325 /* Will cause compile errors if type is not found. */
326 extern void __ftrace_bad_type(void);
329 * The trace_assign_type is a verifier that the entry type is
330 * the same as the type being assigned. To add new types simply
331 * add a line with the following format:
333 * IF_ASSIGN(var, ent, type, id);
335 * Where "type" is the trace type that includes the trace_entry
336 * as the "ent" item. And "id" is the trace identifier that is
337 * used in the trace_type enum.
339 * If the type can have more than one id, then use zero.
341 #define trace_assign_type(var, ent) \
343 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
344 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
345 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
346 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
347 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
348 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
349 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
350 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
351 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
352 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
354 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
356 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
357 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
359 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
361 __ftrace_bad_type(); \
365 * An option specific to a tracer. This is a boolean value.
366 * The bit is the bit index that sets its value on the
367 * flags value in struct tracer_flags.
370 const char *name; /* Will appear on the trace_options file */
371 u32 bit; /* Mask assigned in val field in tracer_flags */
375 * The set of specific options for a tracer. Your tracer
376 * have to set the initial value of the flags val.
378 struct tracer_flags {
380 struct tracer_opt *opts;
381 struct tracer *trace;
384 /* Makes more easy to define a tracer opt */
385 #define TRACER_OPT(s, b) .name = #s, .bit = b
388 struct trace_option_dentry {
389 struct tracer_opt *opt;
390 struct tracer_flags *flags;
391 struct trace_array *tr;
392 struct dentry *entry;
396 * struct tracer - a specific tracer and its callbacks to interact with tracefs
397 * @name: the name chosen to select it on the available_tracers file
398 * @init: called when one switches to this tracer (echo name > current_tracer)
399 * @reset: called when one switches to another tracer
400 * @start: called when tracing is unpaused (echo 1 > tracing_on)
401 * @stop: called when tracing is paused (echo 0 > tracing_on)
402 * @update_thresh: called when tracing_thresh is updated
403 * @open: called when the trace file is opened
404 * @pipe_open: called when the trace_pipe file is opened
405 * @close: called when the trace file is released
406 * @pipe_close: called when the trace_pipe file is released
407 * @read: override the default read callback on trace_pipe
408 * @splice_read: override the default splice_read callback on trace_pipe
409 * @selftest: selftest to run on boot (see trace_selftest.c)
410 * @print_headers: override the first lines that describe your columns
411 * @print_line: callback that prints a trace
412 * @set_flag: signals one of your private flags changed (trace_options file)
413 * @flags: your private flags
417 int (*init)(struct trace_array *tr);
418 void (*reset)(struct trace_array *tr);
419 void (*start)(struct trace_array *tr);
420 void (*stop)(struct trace_array *tr);
421 int (*update_thresh)(struct trace_array *tr);
422 void (*open)(struct trace_iterator *iter);
423 void (*pipe_open)(struct trace_iterator *iter);
424 void (*close)(struct trace_iterator *iter);
425 void (*pipe_close)(struct trace_iterator *iter);
426 ssize_t (*read)(struct trace_iterator *iter,
427 struct file *filp, char __user *ubuf,
428 size_t cnt, loff_t *ppos);
429 ssize_t (*splice_read)(struct trace_iterator *iter,
432 struct pipe_inode_info *pipe,
435 #ifdef CONFIG_FTRACE_STARTUP_TEST
436 int (*selftest)(struct tracer *trace,
437 struct trace_array *tr);
439 void (*print_header)(struct seq_file *m);
440 enum print_line_t (*print_line)(struct trace_iterator *iter);
441 /* If you handled the flag setting, return 0 */
442 int (*set_flag)(struct trace_array *tr,
443 u32 old_flags, u32 bit, int set);
444 /* Return 0 if OK with change, else return non-zero */
445 int (*flag_changed)(struct trace_array *tr,
448 struct tracer_flags *flags;
452 bool allow_instances;
453 #ifdef CONFIG_TRACER_MAX_TRACE
456 /* True if tracer cannot be enabled in kernel param */
461 /* Only current can touch trace_recursion */
464 * For function tracing recursion:
465 * The order of these bits are important.
467 * When function tracing occurs, the following steps are made:
468 * If arch does not support a ftrace feature:
469 * call internal function (uses INTERNAL bits) which calls...
470 * The function callback, which can use the FTRACE bits to
471 * check for recursion.
475 TRACE_BUFFER_NMI_BIT,
476 TRACE_BUFFER_IRQ_BIT,
477 TRACE_BUFFER_SIRQ_BIT,
479 /* Start of function recursion bits */
481 TRACE_FTRACE_NMI_BIT,
482 TRACE_FTRACE_IRQ_BIT,
483 TRACE_FTRACE_SIRQ_BIT,
484 TRACE_FTRACE_TRANSITION_BIT,
486 /* Internal use recursion bits */
488 TRACE_INTERNAL_NMI_BIT,
489 TRACE_INTERNAL_IRQ_BIT,
490 TRACE_INTERNAL_SIRQ_BIT,
491 TRACE_INTERNAL_TRANSITION_BIT,
495 * Abuse of the trace_recursion.
496 * As we need a way to maintain state if we are tracing the function
497 * graph in irq because we want to trace a particular function that
498 * was called in irq context but we have irq tracing off. Since this
499 * can only be modified by current, we can reuse trace_recursion.
503 /* Set if the function is in the set_graph_function file */
507 * In the very unlikely case that an interrupt came in
508 * at a start of graph tracing, and we want to trace
509 * the function in that interrupt, the depth can be greater
510 * than zero, because of the preempted start of a previous
511 * trace. In an even more unlikely case, depth could be 2
512 * if a softirq interrupted the start of graph tracing,
513 * followed by an interrupt preempting a start of graph
514 * tracing in the softirq, and depth can even be 3
515 * if an NMI came in at the start of an interrupt function
516 * that preempted a softirq start of a function that
517 * preempted normal context!!!! Luckily, it can't be
518 * greater than 3, so the next two bits are a mask
519 * of what the depth is when we set TRACE_GRAPH_BIT
522 TRACE_GRAPH_DEPTH_START_BIT,
523 TRACE_GRAPH_DEPTH_END_BIT,
526 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
527 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
528 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
530 #define trace_recursion_depth() \
531 (((current)->trace_recursion >> TRACE_GRAPH_DEPTH_START_BIT) & 3)
532 #define trace_recursion_set_depth(depth) \
534 current->trace_recursion &= \
535 ~(3 << TRACE_GRAPH_DEPTH_START_BIT); \
536 current->trace_recursion |= \
537 ((depth) & 3) << TRACE_GRAPH_DEPTH_START_BIT; \
540 #define TRACE_CONTEXT_BITS 4
542 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
544 #define TRACE_LIST_START TRACE_INTERNAL_BIT
546 #define TRACE_CONTEXT_MASK ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
553 TRACE_CTX_TRANSITION,
556 static __always_inline int trace_get_context_bit(void)
560 if (in_interrupt()) {
567 bit = TRACE_CTX_SOFTIRQ;
569 bit = TRACE_CTX_NORMAL;
574 static __always_inline int trace_test_and_set_recursion(int start)
576 unsigned int val = current->trace_recursion;
579 bit = trace_get_context_bit() + start;
580 if (unlikely(val & (1 << bit))) {
582 * It could be that preempt_count has not been updated during
583 * a switch between contexts. Allow for a single recursion.
585 bit = start + TRACE_CTX_TRANSITION;
586 if (trace_recursion_test(bit))
588 trace_recursion_set(bit);
594 current->trace_recursion = val;
600 static __always_inline void trace_clear_recursion(int bit)
602 unsigned int val = current->trace_recursion;
608 current->trace_recursion = val;
611 static inline struct ring_buffer_iter *
612 trace_buffer_iter(struct trace_iterator *iter, int cpu)
614 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
617 int tracer_init(struct tracer *t, struct trace_array *tr);
618 int tracing_is_enabled(void);
619 void tracing_reset(struct trace_buffer *buf, int cpu);
620 void tracing_reset_online_cpus(struct trace_buffer *buf);
621 void tracing_reset_current(int cpu);
622 void tracing_reset_all_online_cpus(void);
623 int tracing_open_generic(struct inode *inode, struct file *filp);
624 bool tracing_is_disabled(void);
625 bool tracer_tracing_is_on(struct trace_array *tr);
626 void tracer_tracing_on(struct trace_array *tr);
627 void tracer_tracing_off(struct trace_array *tr);
628 struct dentry *trace_create_file(const char *name,
630 struct dentry *parent,
632 const struct file_operations *fops);
634 struct dentry *tracing_init_dentry(void);
636 struct ring_buffer_event;
638 struct ring_buffer_event *
639 trace_buffer_lock_reserve(struct ring_buffer *buffer,
645 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
646 struct trace_array_cpu *data);
648 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
649 int *ent_cpu, u64 *ent_ts);
651 void trace_buffer_unlock_commit_nostack(struct ring_buffer *buffer,
652 struct ring_buffer_event *event);
654 int trace_empty(struct trace_iterator *iter);
656 void *trace_find_next_entry_inc(struct trace_iterator *iter);
658 void trace_init_global_iter(struct trace_iterator *iter);
660 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
662 void trace_function(struct trace_array *tr,
664 unsigned long parent_ip,
665 unsigned long flags, int pc);
666 void trace_graph_function(struct trace_array *tr,
668 unsigned long parent_ip,
669 unsigned long flags, int pc);
670 void trace_latency_header(struct seq_file *m);
671 void trace_default_header(struct seq_file *m);
672 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
673 int trace_empty(struct trace_iterator *iter);
675 void trace_graph_return(struct ftrace_graph_ret *trace);
676 int trace_graph_entry(struct ftrace_graph_ent *trace);
677 void set_graph_array(struct trace_array *tr);
679 void tracing_start_cmdline_record(void);
680 void tracing_stop_cmdline_record(void);
681 void tracing_start_tgid_record(void);
682 void tracing_stop_tgid_record(void);
684 int register_tracer(struct tracer *type);
685 int is_tracing_stopped(void);
687 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
689 extern cpumask_var_t __read_mostly tracing_buffer_mask;
691 #define for_each_tracing_cpu(cpu) \
692 for_each_cpu(cpu, tracing_buffer_mask)
694 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
696 extern unsigned long tracing_thresh;
702 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
704 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
705 struct task_struct *task);
706 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
707 struct task_struct *self,
708 struct task_struct *task);
709 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
710 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
711 int trace_pid_show(struct seq_file *m, void *v);
712 void trace_free_pid_list(struct trace_pid_list *pid_list);
713 int trace_pid_write(struct trace_pid_list *filtered_pids,
714 struct trace_pid_list **new_pid_list,
715 const char __user *ubuf, size_t cnt);
717 #ifdef CONFIG_TRACER_MAX_TRACE
718 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
719 void update_max_tr_single(struct trace_array *tr,
720 struct task_struct *tsk, int cpu);
721 #endif /* CONFIG_TRACER_MAX_TRACE */
723 #ifdef CONFIG_STACKTRACE
724 void ftrace_trace_userstack(struct trace_array *tr,
725 struct ring_buffer *buffer, unsigned long flags,
728 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
731 static inline void ftrace_trace_userstack(struct trace_array *tr,
732 struct ring_buffer *buffer,
733 unsigned long flags, int pc)
737 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
741 #endif /* CONFIG_STACKTRACE */
743 extern u64 ftrace_now(int cpu);
745 extern void trace_find_cmdline(int pid, char comm[]);
746 extern int trace_find_tgid(int pid);
747 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
749 #ifdef CONFIG_DYNAMIC_FTRACE
750 extern unsigned long ftrace_update_tot_cnt;
751 void ftrace_init_trace_array(struct trace_array *tr);
753 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
755 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
756 extern int DYN_FTRACE_TEST_NAME(void);
757 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
758 extern int DYN_FTRACE_TEST_NAME2(void);
760 extern bool ring_buffer_expanded;
761 extern bool tracing_selftest_disabled;
763 #ifdef CONFIG_FTRACE_STARTUP_TEST
764 extern int trace_selftest_startup_function(struct tracer *trace,
765 struct trace_array *tr);
766 extern int trace_selftest_startup_function_graph(struct tracer *trace,
767 struct trace_array *tr);
768 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
769 struct trace_array *tr);
770 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
771 struct trace_array *tr);
772 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
773 struct trace_array *tr);
774 extern int trace_selftest_startup_wakeup(struct tracer *trace,
775 struct trace_array *tr);
776 extern int trace_selftest_startup_nop(struct tracer *trace,
777 struct trace_array *tr);
778 extern int trace_selftest_startup_branch(struct tracer *trace,
779 struct trace_array *tr);
781 * Tracer data references selftest functions that only occur
782 * on boot up. These can be __init functions. Thus, when selftests
783 * are enabled, then the tracers need to reference __init functions.
785 #define __tracer_data __refdata
787 /* Tracers are seldom changed. Optimize when selftests are disabled. */
788 #define __tracer_data __read_mostly
789 #endif /* CONFIG_FTRACE_STARTUP_TEST */
791 extern void *head_page(struct trace_array_cpu *data);
792 extern unsigned long long ns2usecs(u64 nsec);
794 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
796 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
798 trace_array_vprintk(struct trace_array *tr,
799 unsigned long ip, const char *fmt, va_list args);
800 int trace_array_printk(struct trace_array *tr,
801 unsigned long ip, const char *fmt, ...);
802 int trace_array_printk_buf(struct ring_buffer *buffer,
803 unsigned long ip, const char *fmt, ...);
804 void trace_printk_seq(struct trace_seq *s);
805 enum print_line_t print_trace_line(struct trace_iterator *iter);
807 extern char trace_find_mark(unsigned long long duration);
811 struct ftrace_mod_load {
812 struct list_head list;
819 FTRACE_HASH_FL_MOD = (1 << 0),
823 unsigned long size_bits;
824 struct hlist_head *buckets;
830 struct ftrace_func_entry *
831 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
833 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
835 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
838 /* Standard output formatting function used for function return traces */
839 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
842 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
843 #define TRACE_GRAPH_PRINT_CPU 0x2
844 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
845 #define TRACE_GRAPH_PRINT_PROC 0x8
846 #define TRACE_GRAPH_PRINT_DURATION 0x10
847 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
848 #define TRACE_GRAPH_PRINT_IRQS 0x40
849 #define TRACE_GRAPH_PRINT_TAIL 0x80
850 #define TRACE_GRAPH_SLEEP_TIME 0x100
851 #define TRACE_GRAPH_GRAPH_TIME 0x200
852 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
853 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
855 extern void ftrace_graph_sleep_time_control(bool enable);
856 extern void ftrace_graph_graph_time_control(bool enable);
858 extern enum print_line_t
859 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
860 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
862 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
863 extern void graph_trace_open(struct trace_iterator *iter);
864 extern void graph_trace_close(struct trace_iterator *iter);
865 extern int __trace_graph_entry(struct trace_array *tr,
866 struct ftrace_graph_ent *trace,
867 unsigned long flags, int pc);
868 extern void __trace_graph_return(struct trace_array *tr,
869 struct ftrace_graph_ret *trace,
870 unsigned long flags, int pc);
872 #ifdef CONFIG_DYNAMIC_FTRACE
873 extern struct ftrace_hash __rcu *ftrace_graph_hash;
874 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
876 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
878 unsigned long addr = trace->func;
880 struct ftrace_hash *hash;
882 preempt_disable_notrace();
885 * Have to open code "rcu_dereference_sched()" because the
886 * function graph tracer can be called when RCU is not
888 * Protected with schedule_on_each_cpu(ftrace_sync)
890 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
892 if (ftrace_hash_empty(hash)) {
897 if (ftrace_lookup_ip(hash, addr)) {
900 * This needs to be cleared on the return functions
901 * when the depth is zero.
903 trace_recursion_set(TRACE_GRAPH_BIT);
904 trace_recursion_set_depth(trace->depth);
907 * If no irqs are to be traced, but a set_graph_function
908 * is set, and called by an interrupt handler, we still
912 trace_recursion_set(TRACE_IRQ_BIT);
914 trace_recursion_clear(TRACE_IRQ_BIT);
919 preempt_enable_notrace();
923 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
925 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
926 trace->depth == trace_recursion_depth())
927 trace_recursion_clear(TRACE_GRAPH_BIT);
930 static inline int ftrace_graph_notrace_addr(unsigned long addr)
933 struct ftrace_hash *notrace_hash;
935 preempt_disable_notrace();
938 * Have to open code "rcu_dereference_sched()" because the
939 * function graph tracer can be called when RCU is not
941 * Protected with schedule_on_each_cpu(ftrace_sync)
943 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
946 if (ftrace_lookup_ip(notrace_hash, addr))
949 preempt_enable_notrace();
953 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
958 static inline int ftrace_graph_notrace_addr(unsigned long addr)
962 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
964 #endif /* CONFIG_DYNAMIC_FTRACE */
966 extern unsigned int fgraph_max_depth;
968 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
970 /* trace it when it is-nested-in or is a function enabled. */
971 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
972 ftrace_graph_addr(trace)) ||
973 (trace->depth < 0) ||
974 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
977 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
978 static inline enum print_line_t
979 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
981 return TRACE_TYPE_UNHANDLED;
983 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
985 extern struct list_head ftrace_pids;
987 #ifdef CONFIG_FUNCTION_TRACER
988 struct ftrace_func_command {
989 struct list_head list;
991 int (*func)(struct trace_array *tr,
992 struct ftrace_hash *hash,
993 char *func, char *cmd,
994 char *params, int enable);
996 extern bool ftrace_filter_param __initdata;
997 static inline int ftrace_trace_task(struct trace_array *tr)
999 return !this_cpu_read(tr->trace_buffer.data->ftrace_ignore_pid);
1001 extern int ftrace_is_dead(void);
1002 int ftrace_create_function_files(struct trace_array *tr,
1003 struct dentry *parent);
1004 void ftrace_destroy_function_files(struct trace_array *tr);
1005 void ftrace_init_global_array_ops(struct trace_array *tr);
1006 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1007 void ftrace_reset_array_ops(struct trace_array *tr);
1008 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1009 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1010 struct dentry *d_tracer);
1011 void ftrace_clear_pids(struct trace_array *tr);
1012 int init_function_trace(void);
1013 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1015 static inline int ftrace_trace_task(struct trace_array *tr)
1019 static inline int ftrace_is_dead(void) { return 0; }
1021 ftrace_create_function_files(struct trace_array *tr,
1022 struct dentry *parent)
1026 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1027 static inline __init void
1028 ftrace_init_global_array_ops(struct trace_array *tr) { }
1029 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1030 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1031 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1032 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1033 static inline int init_function_trace(void) { return 0; }
1034 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1035 /* ftace_func_t type is not defined, use macro instead of static inline */
1036 #define ftrace_init_array_ops(tr, func) do { } while (0)
1037 #endif /* CONFIG_FUNCTION_TRACER */
1039 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1041 struct ftrace_probe_ops {
1042 void (*func)(unsigned long ip,
1043 unsigned long parent_ip,
1044 struct trace_array *tr,
1045 struct ftrace_probe_ops *ops,
1047 int (*init)(struct ftrace_probe_ops *ops,
1048 struct trace_array *tr,
1049 unsigned long ip, void *init_data,
1051 void (*free)(struct ftrace_probe_ops *ops,
1052 struct trace_array *tr,
1053 unsigned long ip, void *data);
1054 int (*print)(struct seq_file *m,
1056 struct ftrace_probe_ops *ops,
1060 struct ftrace_func_mapper;
1061 typedef int (*ftrace_mapper_func)(void *data);
1063 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1064 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1066 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1067 unsigned long ip, void *data);
1068 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1070 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1071 ftrace_mapper_func free_func);
1074 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1075 struct ftrace_probe_ops *ops, void *data);
1077 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1078 struct ftrace_probe_ops *ops);
1079 extern void clear_ftrace_function_probes(struct trace_array *tr);
1081 int register_ftrace_command(struct ftrace_func_command *cmd);
1082 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1084 void ftrace_create_filter_files(struct ftrace_ops *ops,
1085 struct dentry *parent);
1086 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1088 struct ftrace_func_command;
1090 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1094 static inline __init int unregister_ftrace_command(char *cmd_name)
1098 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1103 * The ops parameter passed in is usually undefined.
1104 * This must be a macro.
1106 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1107 #define ftrace_destroy_filter_files(ops) do { } while (0)
1108 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1110 bool ftrace_event_is_function(struct trace_event_call *call);
1113 * struct trace_parser - servers for reading the user input separated by spaces
1114 * @cont: set if the input is not complete - no final space char was found
1115 * @buffer: holds the parsed user input
1116 * @idx: user input length
1117 * @size: buffer size
1119 struct trace_parser {
1126 static inline bool trace_parser_loaded(struct trace_parser *parser)
1128 return (parser->idx != 0);
1131 static inline bool trace_parser_cont(struct trace_parser *parser)
1133 return parser->cont;
1136 static inline void trace_parser_clear(struct trace_parser *parser)
1138 parser->cont = false;
1142 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1143 extern void trace_parser_put(struct trace_parser *parser);
1144 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1145 size_t cnt, loff_t *ppos);
1148 * Only create function graph options if function graph is configured.
1150 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1151 # define FGRAPH_FLAGS \
1152 C(DISPLAY_GRAPH, "display-graph"),
1154 # define FGRAPH_FLAGS
1157 #ifdef CONFIG_BRANCH_TRACER
1158 # define BRANCH_FLAGS \
1159 C(BRANCH, "branch"),
1161 # define BRANCH_FLAGS
1164 #ifdef CONFIG_FUNCTION_TRACER
1165 # define FUNCTION_FLAGS \
1166 C(FUNCTION, "function-trace"), \
1167 C(FUNC_FORK, "function-fork"),
1168 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1170 # define FUNCTION_FLAGS
1171 # define FUNCTION_DEFAULT_FLAGS 0UL
1172 # define TRACE_ITER_FUNC_FORK 0UL
1175 #ifdef CONFIG_STACKTRACE
1176 # define STACK_FLAGS \
1177 C(STACKTRACE, "stacktrace"),
1179 # define STACK_FLAGS
1183 * trace_iterator_flags is an enumeration that defines bit
1184 * positions into trace_flags that controls the output.
1186 * NOTE: These bits must match the trace_options array in
1187 * trace.c (this macro guarantees it).
1189 #define TRACE_FLAGS \
1190 C(PRINT_PARENT, "print-parent"), \
1191 C(SYM_OFFSET, "sym-offset"), \
1192 C(SYM_ADDR, "sym-addr"), \
1193 C(VERBOSE, "verbose"), \
1197 C(BLOCK, "block"), \
1198 C(PRINTK, "trace_printk"), \
1199 C(ANNOTATE, "annotate"), \
1200 C(USERSTACKTRACE, "userstacktrace"), \
1201 C(SYM_USEROBJ, "sym-userobj"), \
1202 C(PRINTK_MSGONLY, "printk-msg-only"), \
1203 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1204 C(LATENCY_FMT, "latency-format"), \
1205 C(RECORD_CMD, "record-cmd"), \
1206 C(RECORD_TGID, "record-tgid"), \
1207 C(OVERWRITE, "overwrite"), \
1208 C(STOP_ON_FREE, "disable_on_free"), \
1209 C(IRQ_INFO, "irq-info"), \
1210 C(MARKERS, "markers"), \
1211 C(EVENT_FORK, "event-fork"), \
1218 * By defining C, we can make TRACE_FLAGS a list of bit names
1219 * that will define the bits for the flag masks.
1222 #define C(a, b) TRACE_ITER_##a##_BIT
1224 enum trace_iterator_bits {
1226 /* Make sure we don't go more than we have bits for */
1231 * By redefining C, we can make TRACE_FLAGS a list of masks that
1232 * use the bits as defined above.
1235 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1237 enum trace_iterator_flags { TRACE_FLAGS };
1240 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1241 * control the output of kernel symbols.
1243 #define TRACE_ITER_SYM_MASK \
1244 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1246 extern struct tracer nop_trace;
1248 #ifdef CONFIG_BRANCH_TRACER
1249 extern int enable_branch_tracing(struct trace_array *tr);
1250 extern void disable_branch_tracing(void);
1251 static inline int trace_branch_enable(struct trace_array *tr)
1253 if (tr->trace_flags & TRACE_ITER_BRANCH)
1254 return enable_branch_tracing(tr);
1257 static inline void trace_branch_disable(void)
1259 /* due to races, always disable */
1260 disable_branch_tracing();
1263 static inline int trace_branch_enable(struct trace_array *tr)
1267 static inline void trace_branch_disable(void)
1270 #endif /* CONFIG_BRANCH_TRACER */
1272 /* set ring buffers to default size if not already done so */
1273 int tracing_update_buffers(void);
1275 struct ftrace_event_field {
1276 struct list_head link;
1287 struct event_filter {
1288 struct prog_entry __rcu *prog;
1289 char *filter_string;
1292 struct event_subsystem {
1293 struct list_head list;
1295 struct event_filter *filter;
1299 struct trace_subsystem_dir {
1300 struct list_head list;
1301 struct event_subsystem *subsystem;
1302 struct trace_array *tr;
1303 struct dentry *entry;
1308 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1309 struct ring_buffer *buffer,
1310 struct ring_buffer_event *event);
1312 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1313 struct ring_buffer *buffer,
1314 struct ring_buffer_event *event,
1315 unsigned long flags, int pc,
1316 struct pt_regs *regs);
1318 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1319 struct ring_buffer *buffer,
1320 struct ring_buffer_event *event,
1321 unsigned long flags, int pc)
1323 trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1326 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1327 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1328 void trace_buffered_event_disable(void);
1329 void trace_buffered_event_enable(void);
1332 __trace_event_discard_commit(struct ring_buffer *buffer,
1333 struct ring_buffer_event *event)
1335 if (this_cpu_read(trace_buffered_event) == event) {
1336 /* Simply release the temp buffer */
1337 this_cpu_dec(trace_buffered_event_cnt);
1340 ring_buffer_discard_commit(buffer, event);
1344 * Helper function for event_trigger_unlock_commit{_regs}().
1345 * If there are event triggers attached to this event that requires
1346 * filtering against its fields, then they wil be called as the
1347 * entry already holds the field information of the current event.
1349 * It also checks if the event should be discarded or not.
1350 * It is to be discarded if the event is soft disabled and the
1351 * event was only recorded to process triggers, or if the event
1352 * filter is active and this event did not match the filters.
1354 * Returns true if the event is discarded, false otherwise.
1357 __event_trigger_test_discard(struct trace_event_file *file,
1358 struct ring_buffer *buffer,
1359 struct ring_buffer_event *event,
1361 enum event_trigger_type *tt)
1363 unsigned long eflags = file->flags;
1365 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1366 *tt = event_triggers_call(file, entry, event);
1368 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1369 EVENT_FILE_FL_FILTERED |
1370 EVENT_FILE_FL_PID_FILTER))))
1373 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1376 if (file->flags & EVENT_FILE_FL_FILTERED &&
1377 !filter_match_preds(file->filter, entry))
1380 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1381 trace_event_ignore_this_pid(file))
1386 __trace_event_discard_commit(buffer, event);
1391 * event_trigger_unlock_commit - handle triggers and finish event commit
1392 * @file: The file pointer assoctiated to the event
1393 * @buffer: The ring buffer that the event is being written to
1394 * @event: The event meta data in the ring buffer
1395 * @entry: The event itself
1396 * @irq_flags: The state of the interrupts at the start of the event
1397 * @pc: The state of the preempt count at the start of the event.
1399 * This is a helper function to handle triggers that require data
1400 * from the event itself. It also tests the event against filters and
1401 * if the event is soft disabled and should be discarded.
1404 event_trigger_unlock_commit(struct trace_event_file *file,
1405 struct ring_buffer *buffer,
1406 struct ring_buffer_event *event,
1407 void *entry, unsigned long irq_flags, int pc)
1409 enum event_trigger_type tt = ETT_NONE;
1411 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1412 trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1415 event_triggers_post_call(file, tt);
1419 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1420 * @file: The file pointer assoctiated to the event
1421 * @buffer: The ring buffer that the event is being written to
1422 * @event: The event meta data in the ring buffer
1423 * @entry: The event itself
1424 * @irq_flags: The state of the interrupts at the start of the event
1425 * @pc: The state of the preempt count at the start of the event.
1427 * This is a helper function to handle triggers that require data
1428 * from the event itself. It also tests the event against filters and
1429 * if the event is soft disabled and should be discarded.
1431 * Same as event_trigger_unlock_commit() but calls
1432 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1435 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1436 struct ring_buffer *buffer,
1437 struct ring_buffer_event *event,
1438 void *entry, unsigned long irq_flags, int pc,
1439 struct pt_regs *regs)
1441 enum event_trigger_type tt = ETT_NONE;
1443 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1444 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1445 irq_flags, pc, regs);
1448 event_triggers_post_call(file, tt);
1451 #define FILTER_PRED_INVALID ((unsigned short)-1)
1452 #define FILTER_PRED_IS_RIGHT (1 << 15)
1453 #define FILTER_PRED_FOLD (1 << 15)
1456 * The max preds is the size of unsigned short with
1457 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1458 * and FOLD flags. The other is reserved.
1460 * 2^14 preds is way more than enough.
1462 #define MAX_FILTER_PRED 16384
1467 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1469 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1480 char pattern[MAX_FILTER_STR_VAL];
1483 regex_match_func match;
1486 struct filter_pred {
1487 filter_pred_fn_t fn;
1490 unsigned short *ops;
1491 struct ftrace_event_field *field;
1497 static inline bool is_string_field(struct ftrace_event_field *field)
1499 return field->filter_type == FILTER_DYN_STRING ||
1500 field->filter_type == FILTER_STATIC_STRING ||
1501 field->filter_type == FILTER_PTR_STRING ||
1502 field->filter_type == FILTER_COMM;
1505 static inline bool is_function_field(struct ftrace_event_field *field)
1507 return field->filter_type == FILTER_TRACE_FN;
1510 extern enum regex_type
1511 filter_parse_regex(char *buff, int len, char **search, int *not);
1512 extern void print_event_filter(struct trace_event_file *file,
1513 struct trace_seq *s);
1514 extern int apply_event_filter(struct trace_event_file *file,
1515 char *filter_string);
1516 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1517 char *filter_string);
1518 extern void print_subsystem_event_filter(struct event_subsystem *system,
1519 struct trace_seq *s);
1520 extern int filter_assign_type(const char *type);
1521 extern int create_event_filter(struct trace_event_call *call,
1522 char *filter_str, bool set_str,
1523 struct event_filter **filterp);
1524 extern void free_event_filter(struct event_filter *filter);
1526 struct ftrace_event_field *
1527 trace_find_event_field(struct trace_event_call *call, char *name);
1529 extern void trace_event_enable_cmd_record(bool enable);
1530 extern void trace_event_enable_tgid_record(bool enable);
1532 extern int event_trace_init(void);
1533 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1534 extern int event_trace_del_tracer(struct trace_array *tr);
1536 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1539 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1543 static inline void *event_file_data(struct file *filp)
1545 return READ_ONCE(file_inode(filp)->i_private);
1548 extern struct mutex event_mutex;
1549 extern struct list_head ftrace_events;
1551 extern const struct file_operations event_trigger_fops;
1552 extern const struct file_operations event_hist_fops;
1554 #ifdef CONFIG_HIST_TRIGGERS
1555 extern int register_trigger_hist_cmd(void);
1556 extern int register_trigger_hist_enable_disable_cmds(void);
1558 static inline int register_trigger_hist_cmd(void) { return 0; }
1559 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1562 extern int register_trigger_cmds(void);
1563 extern void clear_event_triggers(struct trace_array *tr);
1565 struct event_trigger_data {
1566 unsigned long count;
1568 struct event_trigger_ops *ops;
1569 struct event_command *cmd_ops;
1570 struct event_filter __rcu *filter;
1575 struct list_head list;
1577 struct list_head named_list;
1578 struct event_trigger_data *named_data;
1582 #define ENABLE_EVENT_STR "enable_event"
1583 #define DISABLE_EVENT_STR "disable_event"
1584 #define ENABLE_HIST_STR "enable_hist"
1585 #define DISABLE_HIST_STR "disable_hist"
1587 struct enable_trigger_data {
1588 struct trace_event_file *file;
1593 extern int event_enable_trigger_print(struct seq_file *m,
1594 struct event_trigger_ops *ops,
1595 struct event_trigger_data *data);
1596 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1597 struct event_trigger_data *data);
1598 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1599 struct trace_event_file *file,
1600 char *glob, char *cmd, char *param);
1601 extern int event_enable_register_trigger(char *glob,
1602 struct event_trigger_ops *ops,
1603 struct event_trigger_data *data,
1604 struct trace_event_file *file);
1605 extern void event_enable_unregister_trigger(char *glob,
1606 struct event_trigger_ops *ops,
1607 struct event_trigger_data *test,
1608 struct trace_event_file *file);
1609 extern void trigger_data_free(struct event_trigger_data *data);
1610 extern int event_trigger_init(struct event_trigger_ops *ops,
1611 struct event_trigger_data *data);
1612 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1613 int trigger_enable);
1614 extern void update_cond_flag(struct trace_event_file *file);
1615 extern int set_trigger_filter(char *filter_str,
1616 struct event_trigger_data *trigger_data,
1617 struct trace_event_file *file);
1618 extern struct event_trigger_data *find_named_trigger(const char *name);
1619 extern bool is_named_trigger(struct event_trigger_data *test);
1620 extern int save_named_trigger(const char *name,
1621 struct event_trigger_data *data);
1622 extern void del_named_trigger(struct event_trigger_data *data);
1623 extern void pause_named_trigger(struct event_trigger_data *data);
1624 extern void unpause_named_trigger(struct event_trigger_data *data);
1625 extern void set_named_trigger_data(struct event_trigger_data *data,
1626 struct event_trigger_data *named_data);
1627 extern struct event_trigger_data *
1628 get_named_trigger_data(struct event_trigger_data *data);
1629 extern int register_event_command(struct event_command *cmd);
1630 extern int unregister_event_command(struct event_command *cmd);
1631 extern int register_trigger_hist_enable_disable_cmds(void);
1634 * struct event_trigger_ops - callbacks for trace event triggers
1636 * The methods in this structure provide per-event trigger hooks for
1637 * various trigger operations.
1639 * All the methods below, except for @init() and @free(), must be
1642 * @func: The trigger 'probe' function called when the triggering
1643 * event occurs. The data passed into this callback is the data
1644 * that was supplied to the event_command @reg() function that
1645 * registered the trigger (see struct event_command) along with
1646 * the trace record, rec.
1648 * @init: An optional initialization function called for the trigger
1649 * when the trigger is registered (via the event_command reg()
1650 * function). This can be used to perform per-trigger
1651 * initialization such as incrementing a per-trigger reference
1652 * count, for instance. This is usually implemented by the
1653 * generic utility function @event_trigger_init() (see
1654 * trace_event_triggers.c).
1656 * @free: An optional de-initialization function called for the
1657 * trigger when the trigger is unregistered (via the
1658 * event_command @reg() function). This can be used to perform
1659 * per-trigger de-initialization such as decrementing a
1660 * per-trigger reference count and freeing corresponding trigger
1661 * data, for instance. This is usually implemented by the
1662 * generic utility function @event_trigger_free() (see
1663 * trace_event_triggers.c).
1665 * @print: The callback function invoked to have the trigger print
1666 * itself. This is usually implemented by a wrapper function
1667 * that calls the generic utility function @event_trigger_print()
1668 * (see trace_event_triggers.c).
1670 struct event_trigger_ops {
1671 void (*func)(struct event_trigger_data *data,
1673 struct ring_buffer_event *rbe);
1674 int (*init)(struct event_trigger_ops *ops,
1675 struct event_trigger_data *data);
1676 void (*free)(struct event_trigger_ops *ops,
1677 struct event_trigger_data *data);
1678 int (*print)(struct seq_file *m,
1679 struct event_trigger_ops *ops,
1680 struct event_trigger_data *data);
1684 * struct event_command - callbacks and data members for event commands
1686 * Event commands are invoked by users by writing the command name
1687 * into the 'trigger' file associated with a trace event. The
1688 * parameters associated with a specific invocation of an event
1689 * command are used to create an event trigger instance, which is
1690 * added to the list of trigger instances associated with that trace
1691 * event. When the event is hit, the set of triggers associated with
1692 * that event is invoked.
1694 * The data members in this structure provide per-event command data
1695 * for various event commands.
1697 * All the data members below, except for @post_trigger, must be set
1698 * for each event command.
1700 * @name: The unique name that identifies the event command. This is
1701 * the name used when setting triggers via trigger files.
1703 * @trigger_type: A unique id that identifies the event command
1704 * 'type'. This value has two purposes, the first to ensure that
1705 * only one trigger of the same type can be set at a given time
1706 * for a particular event e.g. it doesn't make sense to have both
1707 * a traceon and traceoff trigger attached to a single event at
1708 * the same time, so traceon and traceoff have the same type
1709 * though they have different names. The @trigger_type value is
1710 * also used as a bit value for deferring the actual trigger
1711 * action until after the current event is finished. Some
1712 * commands need to do this if they themselves log to the trace
1713 * buffer (see the @post_trigger() member below). @trigger_type
1714 * values are defined by adding new values to the trigger_type
1715 * enum in include/linux/trace_events.h.
1717 * @flags: See the enum event_command_flags below.
1719 * All the methods below, except for @set_filter() and @unreg_all(),
1720 * must be implemented.
1722 * @func: The callback function responsible for parsing and
1723 * registering the trigger written to the 'trigger' file by the
1724 * user. It allocates the trigger instance and registers it with
1725 * the appropriate trace event. It makes use of the other
1726 * event_command callback functions to orchestrate this, and is
1727 * usually implemented by the generic utility function
1728 * @event_trigger_callback() (see trace_event_triggers.c).
1730 * @reg: Adds the trigger to the list of triggers associated with the
1731 * event, and enables the event trigger itself, after
1732 * initializing it (via the event_trigger_ops @init() function).
1733 * This is also where commands can use the @trigger_type value to
1734 * make the decision as to whether or not multiple instances of
1735 * the trigger should be allowed. This is usually implemented by
1736 * the generic utility function @register_trigger() (see
1737 * trace_event_triggers.c).
1739 * @unreg: Removes the trigger from the list of triggers associated
1740 * with the event, and disables the event trigger itself, after
1741 * initializing it (via the event_trigger_ops @free() function).
1742 * This is usually implemented by the generic utility function
1743 * @unregister_trigger() (see trace_event_triggers.c).
1745 * @unreg_all: An optional function called to remove all the triggers
1746 * from the list of triggers associated with the event. Called
1747 * when a trigger file is opened in truncate mode.
1749 * @set_filter: An optional function called to parse and set a filter
1750 * for the trigger. If no @set_filter() method is set for the
1751 * event command, filters set by the user for the command will be
1752 * ignored. This is usually implemented by the generic utility
1753 * function @set_trigger_filter() (see trace_event_triggers.c).
1755 * @get_trigger_ops: The callback function invoked to retrieve the
1756 * event_trigger_ops implementation associated with the command.
1758 struct event_command {
1759 struct list_head list;
1761 enum event_trigger_type trigger_type;
1763 int (*func)(struct event_command *cmd_ops,
1764 struct trace_event_file *file,
1765 char *glob, char *cmd, char *params);
1766 int (*reg)(char *glob,
1767 struct event_trigger_ops *ops,
1768 struct event_trigger_data *data,
1769 struct trace_event_file *file);
1770 void (*unreg)(char *glob,
1771 struct event_trigger_ops *ops,
1772 struct event_trigger_data *data,
1773 struct trace_event_file *file);
1774 void (*unreg_all)(struct trace_event_file *file);
1775 int (*set_filter)(char *filter_str,
1776 struct event_trigger_data *data,
1777 struct trace_event_file *file);
1778 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1782 * enum event_command_flags - flags for struct event_command
1784 * @POST_TRIGGER: A flag that says whether or not this command needs
1785 * to have its action delayed until after the current event has
1786 * been closed. Some triggers need to avoid being invoked while
1787 * an event is currently in the process of being logged, since
1788 * the trigger may itself log data into the trace buffer. Thus
1789 * we make sure the current event is committed before invoking
1790 * those triggers. To do that, the trigger invocation is split
1791 * in two - the first part checks the filter using the current
1792 * trace record; if a command has the @post_trigger flag set, it
1793 * sets a bit for itself in the return value, otherwise it
1794 * directly invokes the trigger. Once all commands have been
1795 * either invoked or set their return flag, the current record is
1796 * either committed or discarded. At that point, if any commands
1797 * have deferred their triggers, those commands are finally
1798 * invoked following the close of the current event. In other
1799 * words, if the event_trigger_ops @func() probe implementation
1800 * itself logs to the trace buffer, this flag should be set,
1801 * otherwise it can be left unspecified.
1803 * @NEEDS_REC: A flag that says whether or not this command needs
1804 * access to the trace record in order to perform its function,
1805 * regardless of whether or not it has a filter associated with
1806 * it (filters make a trigger require access to the trace record
1807 * but are not always present).
1809 enum event_command_flags {
1810 EVENT_CMD_FL_POST_TRIGGER = 1,
1811 EVENT_CMD_FL_NEEDS_REC = 2,
1814 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1816 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1819 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1821 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1824 extern int trace_event_enable_disable(struct trace_event_file *file,
1825 int enable, int soft_disable);
1826 extern int tracing_alloc_snapshot(void);
1828 extern const char *__start___trace_bprintk_fmt[];
1829 extern const char *__stop___trace_bprintk_fmt[];
1831 extern const char *__start___tracepoint_str[];
1832 extern const char *__stop___tracepoint_str[];
1834 void trace_printk_control(bool enabled);
1835 void trace_printk_init_buffers(void);
1836 void trace_printk_start_comm(void);
1837 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1838 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1840 #define MAX_EVENT_NAME_LEN 64
1842 extern int trace_run_command(const char *buf, int (*createfn)(int, char**));
1843 extern ssize_t trace_parse_run_command(struct file *file,
1844 const char __user *buffer, size_t count, loff_t *ppos,
1845 int (*createfn)(int, char**));
1848 * Normal trace_printk() and friends allocates special buffers
1849 * to do the manipulation, as well as saves the print formats
1850 * into sections to display. But the trace infrastructure wants
1851 * to use these without the added overhead at the price of being
1852 * a bit slower (used mainly for warnings, where we don't care
1853 * about performance). The internal_trace_puts() is for such
1856 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1859 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1860 extern struct trace_event_call \
1861 __aligned(4) event_##call;
1862 #undef FTRACE_ENTRY_DUP
1863 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1864 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1866 #undef FTRACE_ENTRY_PACKED
1867 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1868 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1871 #include "trace_entries.h"
1873 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1874 int perf_ftrace_event_register(struct trace_event_call *call,
1875 enum trace_reg type, void *data);
1877 #define perf_ftrace_event_register NULL
1880 #ifdef CONFIG_FTRACE_SYSCALLS
1881 void init_ftrace_syscalls(void);
1882 const char *get_syscall_name(int syscall);
1884 static inline void init_ftrace_syscalls(void) { }
1885 static inline const char *get_syscall_name(int syscall)
1891 #ifdef CONFIG_EVENT_TRACING
1892 void trace_event_init(void);
1893 void trace_event_eval_update(struct trace_eval_map **map, int len);
1895 static inline void __init trace_event_init(void) { }
1896 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1899 #ifdef CONFIG_TRACER_SNAPSHOT
1900 void tracing_snapshot_instance(struct trace_array *tr);
1901 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1903 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1904 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1910 #ifdef CONFIG_PREEMPT_TRACER
1911 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1912 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1914 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1915 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1917 #ifdef CONFIG_IRQSOFF_TRACER
1918 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1919 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1921 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1922 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1925 extern struct trace_iterator *tracepoint_print_iter;
1928 * Reset the state of the trace_iterator so that it can read consumed data.
1929 * Normally, the trace_iterator is used for reading the data when it is not
1930 * consumed, and must retain state.
1932 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1934 const size_t offset = offsetof(struct trace_iterator, seq);
1937 * Keep gcc from complaining about overwriting more than just one
1938 * member in the structure.
1940 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1945 #endif /* _LINUX_KERNEL_TRACE_H */