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 extern unsigned long ftrace_number_of_pages;
752 extern unsigned long ftrace_number_of_groups;
753 void ftrace_init_trace_array(struct trace_array *tr);
755 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
757 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
758 extern int DYN_FTRACE_TEST_NAME(void);
759 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
760 extern int DYN_FTRACE_TEST_NAME2(void);
762 extern bool ring_buffer_expanded;
763 extern bool tracing_selftest_disabled;
765 #ifdef CONFIG_FTRACE_STARTUP_TEST
766 extern int trace_selftest_startup_function(struct tracer *trace,
767 struct trace_array *tr);
768 extern int trace_selftest_startup_function_graph(struct tracer *trace,
769 struct trace_array *tr);
770 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
771 struct trace_array *tr);
772 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
773 struct trace_array *tr);
774 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
775 struct trace_array *tr);
776 extern int trace_selftest_startup_wakeup(struct tracer *trace,
777 struct trace_array *tr);
778 extern int trace_selftest_startup_nop(struct tracer *trace,
779 struct trace_array *tr);
780 extern int trace_selftest_startup_branch(struct tracer *trace,
781 struct trace_array *tr);
783 * Tracer data references selftest functions that only occur
784 * on boot up. These can be __init functions. Thus, when selftests
785 * are enabled, then the tracers need to reference __init functions.
787 #define __tracer_data __refdata
789 /* Tracers are seldom changed. Optimize when selftests are disabled. */
790 #define __tracer_data __read_mostly
791 #endif /* CONFIG_FTRACE_STARTUP_TEST */
793 extern void *head_page(struct trace_array_cpu *data);
794 extern unsigned long long ns2usecs(u64 nsec);
796 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
798 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
800 trace_array_vprintk(struct trace_array *tr,
801 unsigned long ip, const char *fmt, va_list args);
802 int trace_array_printk(struct trace_array *tr,
803 unsigned long ip, const char *fmt, ...);
804 int trace_array_printk_buf(struct ring_buffer *buffer,
805 unsigned long ip, const char *fmt, ...);
806 void trace_printk_seq(struct trace_seq *s);
807 enum print_line_t print_trace_line(struct trace_iterator *iter);
809 extern char trace_find_mark(unsigned long long duration);
813 struct ftrace_mod_load {
814 struct list_head list;
821 FTRACE_HASH_FL_MOD = (1 << 0),
825 unsigned long size_bits;
826 struct hlist_head *buckets;
832 struct ftrace_func_entry *
833 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
835 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
837 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
840 /* Standard output formatting function used for function return traces */
841 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
844 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
845 #define TRACE_GRAPH_PRINT_CPU 0x2
846 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
847 #define TRACE_GRAPH_PRINT_PROC 0x8
848 #define TRACE_GRAPH_PRINT_DURATION 0x10
849 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
850 #define TRACE_GRAPH_PRINT_IRQS 0x40
851 #define TRACE_GRAPH_PRINT_TAIL 0x80
852 #define TRACE_GRAPH_SLEEP_TIME 0x100
853 #define TRACE_GRAPH_GRAPH_TIME 0x200
854 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
855 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
857 extern void ftrace_graph_sleep_time_control(bool enable);
858 extern void ftrace_graph_graph_time_control(bool enable);
860 extern enum print_line_t
861 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
862 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
864 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
865 extern void graph_trace_open(struct trace_iterator *iter);
866 extern void graph_trace_close(struct trace_iterator *iter);
867 extern int __trace_graph_entry(struct trace_array *tr,
868 struct ftrace_graph_ent *trace,
869 unsigned long flags, int pc);
870 extern void __trace_graph_return(struct trace_array *tr,
871 struct ftrace_graph_ret *trace,
872 unsigned long flags, int pc);
874 #ifdef CONFIG_DYNAMIC_FTRACE
875 extern struct ftrace_hash __rcu *ftrace_graph_hash;
876 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
878 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
880 unsigned long addr = trace->func;
882 struct ftrace_hash *hash;
884 preempt_disable_notrace();
887 * Have to open code "rcu_dereference_sched()" because the
888 * function graph tracer can be called when RCU is not
890 * Protected with schedule_on_each_cpu(ftrace_sync)
892 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
894 if (ftrace_hash_empty(hash)) {
899 if (ftrace_lookup_ip(hash, addr)) {
902 * This needs to be cleared on the return functions
903 * when the depth is zero.
905 trace_recursion_set(TRACE_GRAPH_BIT);
906 trace_recursion_set_depth(trace->depth);
909 * If no irqs are to be traced, but a set_graph_function
910 * is set, and called by an interrupt handler, we still
914 trace_recursion_set(TRACE_IRQ_BIT);
916 trace_recursion_clear(TRACE_IRQ_BIT);
921 preempt_enable_notrace();
925 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
927 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
928 trace->depth == trace_recursion_depth())
929 trace_recursion_clear(TRACE_GRAPH_BIT);
932 static inline int ftrace_graph_notrace_addr(unsigned long addr)
935 struct ftrace_hash *notrace_hash;
937 preempt_disable_notrace();
940 * Have to open code "rcu_dereference_sched()" because the
941 * function graph tracer can be called when RCU is not
943 * Protected with schedule_on_each_cpu(ftrace_sync)
945 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
948 if (ftrace_lookup_ip(notrace_hash, addr))
951 preempt_enable_notrace();
955 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
960 static inline int ftrace_graph_notrace_addr(unsigned long addr)
964 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
966 #endif /* CONFIG_DYNAMIC_FTRACE */
968 extern unsigned int fgraph_max_depth;
970 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
972 /* trace it when it is-nested-in or is a function enabled. */
973 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
974 ftrace_graph_addr(trace)) ||
975 (trace->depth < 0) ||
976 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
979 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
980 static inline enum print_line_t
981 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
983 return TRACE_TYPE_UNHANDLED;
985 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
987 extern struct list_head ftrace_pids;
989 #ifdef CONFIG_FUNCTION_TRACER
990 struct ftrace_func_command {
991 struct list_head list;
993 int (*func)(struct trace_array *tr,
994 struct ftrace_hash *hash,
995 char *func, char *cmd,
996 char *params, int enable);
998 extern bool ftrace_filter_param __initdata;
999 static inline int ftrace_trace_task(struct trace_array *tr)
1001 return !this_cpu_read(tr->trace_buffer.data->ftrace_ignore_pid);
1003 extern int ftrace_is_dead(void);
1004 int ftrace_create_function_files(struct trace_array *tr,
1005 struct dentry *parent);
1006 void ftrace_destroy_function_files(struct trace_array *tr);
1007 void ftrace_init_global_array_ops(struct trace_array *tr);
1008 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1009 void ftrace_reset_array_ops(struct trace_array *tr);
1010 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1011 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1012 struct dentry *d_tracer);
1013 void ftrace_clear_pids(struct trace_array *tr);
1014 int init_function_trace(void);
1015 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1017 static inline int ftrace_trace_task(struct trace_array *tr)
1021 static inline int ftrace_is_dead(void) { return 0; }
1023 ftrace_create_function_files(struct trace_array *tr,
1024 struct dentry *parent)
1028 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1029 static inline __init void
1030 ftrace_init_global_array_ops(struct trace_array *tr) { }
1031 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1032 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1033 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1034 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1035 static inline int init_function_trace(void) { return 0; }
1036 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1037 /* ftace_func_t type is not defined, use macro instead of static inline */
1038 #define ftrace_init_array_ops(tr, func) do { } while (0)
1039 #endif /* CONFIG_FUNCTION_TRACER */
1041 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1043 struct ftrace_probe_ops {
1044 void (*func)(unsigned long ip,
1045 unsigned long parent_ip,
1046 struct trace_array *tr,
1047 struct ftrace_probe_ops *ops,
1049 int (*init)(struct ftrace_probe_ops *ops,
1050 struct trace_array *tr,
1051 unsigned long ip, void *init_data,
1053 void (*free)(struct ftrace_probe_ops *ops,
1054 struct trace_array *tr,
1055 unsigned long ip, void *data);
1056 int (*print)(struct seq_file *m,
1058 struct ftrace_probe_ops *ops,
1062 struct ftrace_func_mapper;
1063 typedef int (*ftrace_mapper_func)(void *data);
1065 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1066 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1068 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1069 unsigned long ip, void *data);
1070 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1072 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1073 ftrace_mapper_func free_func);
1076 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1077 struct ftrace_probe_ops *ops, void *data);
1079 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1080 struct ftrace_probe_ops *ops);
1081 extern void clear_ftrace_function_probes(struct trace_array *tr);
1083 int register_ftrace_command(struct ftrace_func_command *cmd);
1084 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1086 void ftrace_create_filter_files(struct ftrace_ops *ops,
1087 struct dentry *parent);
1088 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1090 struct ftrace_func_command;
1092 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1096 static inline __init int unregister_ftrace_command(char *cmd_name)
1100 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1105 * The ops parameter passed in is usually undefined.
1106 * This must be a macro.
1108 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1109 #define ftrace_destroy_filter_files(ops) do { } while (0)
1110 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1112 bool ftrace_event_is_function(struct trace_event_call *call);
1115 * struct trace_parser - servers for reading the user input separated by spaces
1116 * @cont: set if the input is not complete - no final space char was found
1117 * @buffer: holds the parsed user input
1118 * @idx: user input length
1119 * @size: buffer size
1121 struct trace_parser {
1128 static inline bool trace_parser_loaded(struct trace_parser *parser)
1130 return (parser->idx != 0);
1133 static inline bool trace_parser_cont(struct trace_parser *parser)
1135 return parser->cont;
1138 static inline void trace_parser_clear(struct trace_parser *parser)
1140 parser->cont = false;
1144 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1145 extern void trace_parser_put(struct trace_parser *parser);
1146 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1147 size_t cnt, loff_t *ppos);
1150 * Only create function graph options if function graph is configured.
1152 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1153 # define FGRAPH_FLAGS \
1154 C(DISPLAY_GRAPH, "display-graph"),
1156 # define FGRAPH_FLAGS
1159 #ifdef CONFIG_BRANCH_TRACER
1160 # define BRANCH_FLAGS \
1161 C(BRANCH, "branch"),
1163 # define BRANCH_FLAGS
1166 #ifdef CONFIG_FUNCTION_TRACER
1167 # define FUNCTION_FLAGS \
1168 C(FUNCTION, "function-trace"), \
1169 C(FUNC_FORK, "function-fork"),
1170 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1172 # define FUNCTION_FLAGS
1173 # define FUNCTION_DEFAULT_FLAGS 0UL
1174 # define TRACE_ITER_FUNC_FORK 0UL
1177 #ifdef CONFIG_STACKTRACE
1178 # define STACK_FLAGS \
1179 C(STACKTRACE, "stacktrace"),
1181 # define STACK_FLAGS
1185 * trace_iterator_flags is an enumeration that defines bit
1186 * positions into trace_flags that controls the output.
1188 * NOTE: These bits must match the trace_options array in
1189 * trace.c (this macro guarantees it).
1191 #define TRACE_FLAGS \
1192 C(PRINT_PARENT, "print-parent"), \
1193 C(SYM_OFFSET, "sym-offset"), \
1194 C(SYM_ADDR, "sym-addr"), \
1195 C(VERBOSE, "verbose"), \
1199 C(BLOCK, "block"), \
1200 C(PRINTK, "trace_printk"), \
1201 C(ANNOTATE, "annotate"), \
1202 C(USERSTACKTRACE, "userstacktrace"), \
1203 C(SYM_USEROBJ, "sym-userobj"), \
1204 C(PRINTK_MSGONLY, "printk-msg-only"), \
1205 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1206 C(LATENCY_FMT, "latency-format"), \
1207 C(RECORD_CMD, "record-cmd"), \
1208 C(RECORD_TGID, "record-tgid"), \
1209 C(OVERWRITE, "overwrite"), \
1210 C(STOP_ON_FREE, "disable_on_free"), \
1211 C(IRQ_INFO, "irq-info"), \
1212 C(MARKERS, "markers"), \
1213 C(EVENT_FORK, "event-fork"), \
1220 * By defining C, we can make TRACE_FLAGS a list of bit names
1221 * that will define the bits for the flag masks.
1224 #define C(a, b) TRACE_ITER_##a##_BIT
1226 enum trace_iterator_bits {
1228 /* Make sure we don't go more than we have bits for */
1233 * By redefining C, we can make TRACE_FLAGS a list of masks that
1234 * use the bits as defined above.
1237 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1239 enum trace_iterator_flags { TRACE_FLAGS };
1242 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1243 * control the output of kernel symbols.
1245 #define TRACE_ITER_SYM_MASK \
1246 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1248 extern struct tracer nop_trace;
1250 #ifdef CONFIG_BRANCH_TRACER
1251 extern int enable_branch_tracing(struct trace_array *tr);
1252 extern void disable_branch_tracing(void);
1253 static inline int trace_branch_enable(struct trace_array *tr)
1255 if (tr->trace_flags & TRACE_ITER_BRANCH)
1256 return enable_branch_tracing(tr);
1259 static inline void trace_branch_disable(void)
1261 /* due to races, always disable */
1262 disable_branch_tracing();
1265 static inline int trace_branch_enable(struct trace_array *tr)
1269 static inline void trace_branch_disable(void)
1272 #endif /* CONFIG_BRANCH_TRACER */
1274 /* set ring buffers to default size if not already done so */
1275 int tracing_update_buffers(void);
1277 struct ftrace_event_field {
1278 struct list_head link;
1289 struct event_filter {
1290 struct prog_entry __rcu *prog;
1291 char *filter_string;
1294 struct event_subsystem {
1295 struct list_head list;
1297 struct event_filter *filter;
1301 struct trace_subsystem_dir {
1302 struct list_head list;
1303 struct event_subsystem *subsystem;
1304 struct trace_array *tr;
1305 struct dentry *entry;
1310 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1311 struct ring_buffer *buffer,
1312 struct ring_buffer_event *event);
1314 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1315 struct ring_buffer *buffer,
1316 struct ring_buffer_event *event,
1317 unsigned long flags, int pc,
1318 struct pt_regs *regs);
1320 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1321 struct ring_buffer *buffer,
1322 struct ring_buffer_event *event,
1323 unsigned long flags, int pc)
1325 trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1328 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1329 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1330 void trace_buffered_event_disable(void);
1331 void trace_buffered_event_enable(void);
1334 __trace_event_discard_commit(struct ring_buffer *buffer,
1335 struct ring_buffer_event *event)
1337 if (this_cpu_read(trace_buffered_event) == event) {
1338 /* Simply release the temp buffer */
1339 this_cpu_dec(trace_buffered_event_cnt);
1342 ring_buffer_discard_commit(buffer, event);
1346 * Helper function for event_trigger_unlock_commit{_regs}().
1347 * If there are event triggers attached to this event that requires
1348 * filtering against its fields, then they wil be called as the
1349 * entry already holds the field information of the current event.
1351 * It also checks if the event should be discarded or not.
1352 * It is to be discarded if the event is soft disabled and the
1353 * event was only recorded to process triggers, or if the event
1354 * filter is active and this event did not match the filters.
1356 * Returns true if the event is discarded, false otherwise.
1359 __event_trigger_test_discard(struct trace_event_file *file,
1360 struct ring_buffer *buffer,
1361 struct ring_buffer_event *event,
1363 enum event_trigger_type *tt)
1365 unsigned long eflags = file->flags;
1367 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1368 *tt = event_triggers_call(file, entry, event);
1370 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1371 EVENT_FILE_FL_FILTERED |
1372 EVENT_FILE_FL_PID_FILTER))))
1375 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1378 if (file->flags & EVENT_FILE_FL_FILTERED &&
1379 !filter_match_preds(file->filter, entry))
1382 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1383 trace_event_ignore_this_pid(file))
1388 __trace_event_discard_commit(buffer, event);
1393 * event_trigger_unlock_commit - handle triggers and finish event commit
1394 * @file: The file pointer assoctiated to the event
1395 * @buffer: The ring buffer that the event is being written to
1396 * @event: The event meta data in the ring buffer
1397 * @entry: The event itself
1398 * @irq_flags: The state of the interrupts at the start of the event
1399 * @pc: The state of the preempt count at the start of the event.
1401 * This is a helper function to handle triggers that require data
1402 * from the event itself. It also tests the event against filters and
1403 * if the event is soft disabled and should be discarded.
1406 event_trigger_unlock_commit(struct trace_event_file *file,
1407 struct ring_buffer *buffer,
1408 struct ring_buffer_event *event,
1409 void *entry, unsigned long irq_flags, int pc)
1411 enum event_trigger_type tt = ETT_NONE;
1413 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1414 trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1417 event_triggers_post_call(file, tt);
1421 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1422 * @file: The file pointer assoctiated to the event
1423 * @buffer: The ring buffer that the event is being written to
1424 * @event: The event meta data in the ring buffer
1425 * @entry: The event itself
1426 * @irq_flags: The state of the interrupts at the start of the event
1427 * @pc: The state of the preempt count at the start of the event.
1429 * This is a helper function to handle triggers that require data
1430 * from the event itself. It also tests the event against filters and
1431 * if the event is soft disabled and should be discarded.
1433 * Same as event_trigger_unlock_commit() but calls
1434 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1437 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1438 struct ring_buffer *buffer,
1439 struct ring_buffer_event *event,
1440 void *entry, unsigned long irq_flags, int pc,
1441 struct pt_regs *regs)
1443 enum event_trigger_type tt = ETT_NONE;
1445 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1446 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1447 irq_flags, pc, regs);
1450 event_triggers_post_call(file, tt);
1453 #define FILTER_PRED_INVALID ((unsigned short)-1)
1454 #define FILTER_PRED_IS_RIGHT (1 << 15)
1455 #define FILTER_PRED_FOLD (1 << 15)
1458 * The max preds is the size of unsigned short with
1459 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1460 * and FOLD flags. The other is reserved.
1462 * 2^14 preds is way more than enough.
1464 #define MAX_FILTER_PRED 16384
1469 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1471 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1482 char pattern[MAX_FILTER_STR_VAL];
1485 regex_match_func match;
1488 struct filter_pred {
1489 filter_pred_fn_t fn;
1492 unsigned short *ops;
1493 struct ftrace_event_field *field;
1499 static inline bool is_string_field(struct ftrace_event_field *field)
1501 return field->filter_type == FILTER_DYN_STRING ||
1502 field->filter_type == FILTER_STATIC_STRING ||
1503 field->filter_type == FILTER_PTR_STRING ||
1504 field->filter_type == FILTER_COMM;
1507 static inline bool is_function_field(struct ftrace_event_field *field)
1509 return field->filter_type == FILTER_TRACE_FN;
1512 extern enum regex_type
1513 filter_parse_regex(char *buff, int len, char **search, int *not);
1514 extern void print_event_filter(struct trace_event_file *file,
1515 struct trace_seq *s);
1516 extern int apply_event_filter(struct trace_event_file *file,
1517 char *filter_string);
1518 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1519 char *filter_string);
1520 extern void print_subsystem_event_filter(struct event_subsystem *system,
1521 struct trace_seq *s);
1522 extern int filter_assign_type(const char *type);
1523 extern int create_event_filter(struct trace_event_call *call,
1524 char *filter_str, bool set_str,
1525 struct event_filter **filterp);
1526 extern void free_event_filter(struct event_filter *filter);
1528 struct ftrace_event_field *
1529 trace_find_event_field(struct trace_event_call *call, char *name);
1531 extern void trace_event_enable_cmd_record(bool enable);
1532 extern void trace_event_enable_tgid_record(bool enable);
1534 extern int event_trace_init(void);
1535 extern int init_events(void);
1536 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1537 extern int event_trace_del_tracer(struct trace_array *tr);
1539 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1542 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1546 static inline void *event_file_data(struct file *filp)
1548 return READ_ONCE(file_inode(filp)->i_private);
1551 extern struct mutex event_mutex;
1552 extern struct list_head ftrace_events;
1554 extern const struct file_operations event_trigger_fops;
1555 extern const struct file_operations event_hist_fops;
1557 #ifdef CONFIG_HIST_TRIGGERS
1558 extern int register_trigger_hist_cmd(void);
1559 extern int register_trigger_hist_enable_disable_cmds(void);
1561 static inline int register_trigger_hist_cmd(void) { return 0; }
1562 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1565 extern int register_trigger_cmds(void);
1566 extern void clear_event_triggers(struct trace_array *tr);
1568 struct event_trigger_data {
1569 unsigned long count;
1571 struct event_trigger_ops *ops;
1572 struct event_command *cmd_ops;
1573 struct event_filter __rcu *filter;
1578 struct list_head list;
1580 struct list_head named_list;
1581 struct event_trigger_data *named_data;
1585 #define ENABLE_EVENT_STR "enable_event"
1586 #define DISABLE_EVENT_STR "disable_event"
1587 #define ENABLE_HIST_STR "enable_hist"
1588 #define DISABLE_HIST_STR "disable_hist"
1590 struct enable_trigger_data {
1591 struct trace_event_file *file;
1596 extern int event_enable_trigger_print(struct seq_file *m,
1597 struct event_trigger_ops *ops,
1598 struct event_trigger_data *data);
1599 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1600 struct event_trigger_data *data);
1601 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1602 struct trace_event_file *file,
1603 char *glob, char *cmd, char *param);
1604 extern int event_enable_register_trigger(char *glob,
1605 struct event_trigger_ops *ops,
1606 struct event_trigger_data *data,
1607 struct trace_event_file *file);
1608 extern void event_enable_unregister_trigger(char *glob,
1609 struct event_trigger_ops *ops,
1610 struct event_trigger_data *test,
1611 struct trace_event_file *file);
1612 extern void trigger_data_free(struct event_trigger_data *data);
1613 extern int event_trigger_init(struct event_trigger_ops *ops,
1614 struct event_trigger_data *data);
1615 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1616 int trigger_enable);
1617 extern void update_cond_flag(struct trace_event_file *file);
1618 extern int set_trigger_filter(char *filter_str,
1619 struct event_trigger_data *trigger_data,
1620 struct trace_event_file *file);
1621 extern struct event_trigger_data *find_named_trigger(const char *name);
1622 extern bool is_named_trigger(struct event_trigger_data *test);
1623 extern int save_named_trigger(const char *name,
1624 struct event_trigger_data *data);
1625 extern void del_named_trigger(struct event_trigger_data *data);
1626 extern void pause_named_trigger(struct event_trigger_data *data);
1627 extern void unpause_named_trigger(struct event_trigger_data *data);
1628 extern void set_named_trigger_data(struct event_trigger_data *data,
1629 struct event_trigger_data *named_data);
1630 extern struct event_trigger_data *
1631 get_named_trigger_data(struct event_trigger_data *data);
1632 extern int register_event_command(struct event_command *cmd);
1633 extern int unregister_event_command(struct event_command *cmd);
1634 extern int register_trigger_hist_enable_disable_cmds(void);
1637 * struct event_trigger_ops - callbacks for trace event triggers
1639 * The methods in this structure provide per-event trigger hooks for
1640 * various trigger operations.
1642 * All the methods below, except for @init() and @free(), must be
1645 * @func: The trigger 'probe' function called when the triggering
1646 * event occurs. The data passed into this callback is the data
1647 * that was supplied to the event_command @reg() function that
1648 * registered the trigger (see struct event_command) along with
1649 * the trace record, rec.
1651 * @init: An optional initialization function called for the trigger
1652 * when the trigger is registered (via the event_command reg()
1653 * function). This can be used to perform per-trigger
1654 * initialization such as incrementing a per-trigger reference
1655 * count, for instance. This is usually implemented by the
1656 * generic utility function @event_trigger_init() (see
1657 * trace_event_triggers.c).
1659 * @free: An optional de-initialization function called for the
1660 * trigger when the trigger is unregistered (via the
1661 * event_command @reg() function). This can be used to perform
1662 * per-trigger de-initialization such as decrementing a
1663 * per-trigger reference count and freeing corresponding trigger
1664 * data, for instance. This is usually implemented by the
1665 * generic utility function @event_trigger_free() (see
1666 * trace_event_triggers.c).
1668 * @print: The callback function invoked to have the trigger print
1669 * itself. This is usually implemented by a wrapper function
1670 * that calls the generic utility function @event_trigger_print()
1671 * (see trace_event_triggers.c).
1673 struct event_trigger_ops {
1674 void (*func)(struct event_trigger_data *data,
1676 struct ring_buffer_event *rbe);
1677 int (*init)(struct event_trigger_ops *ops,
1678 struct event_trigger_data *data);
1679 void (*free)(struct event_trigger_ops *ops,
1680 struct event_trigger_data *data);
1681 int (*print)(struct seq_file *m,
1682 struct event_trigger_ops *ops,
1683 struct event_trigger_data *data);
1687 * struct event_command - callbacks and data members for event commands
1689 * Event commands are invoked by users by writing the command name
1690 * into the 'trigger' file associated with a trace event. The
1691 * parameters associated with a specific invocation of an event
1692 * command are used to create an event trigger instance, which is
1693 * added to the list of trigger instances associated with that trace
1694 * event. When the event is hit, the set of triggers associated with
1695 * that event is invoked.
1697 * The data members in this structure provide per-event command data
1698 * for various event commands.
1700 * All the data members below, except for @post_trigger, must be set
1701 * for each event command.
1703 * @name: The unique name that identifies the event command. This is
1704 * the name used when setting triggers via trigger files.
1706 * @trigger_type: A unique id that identifies the event command
1707 * 'type'. This value has two purposes, the first to ensure that
1708 * only one trigger of the same type can be set at a given time
1709 * for a particular event e.g. it doesn't make sense to have both
1710 * a traceon and traceoff trigger attached to a single event at
1711 * the same time, so traceon and traceoff have the same type
1712 * though they have different names. The @trigger_type value is
1713 * also used as a bit value for deferring the actual trigger
1714 * action until after the current event is finished. Some
1715 * commands need to do this if they themselves log to the trace
1716 * buffer (see the @post_trigger() member below). @trigger_type
1717 * values are defined by adding new values to the trigger_type
1718 * enum in include/linux/trace_events.h.
1720 * @flags: See the enum event_command_flags below.
1722 * All the methods below, except for @set_filter() and @unreg_all(),
1723 * must be implemented.
1725 * @func: The callback function responsible for parsing and
1726 * registering the trigger written to the 'trigger' file by the
1727 * user. It allocates the trigger instance and registers it with
1728 * the appropriate trace event. It makes use of the other
1729 * event_command callback functions to orchestrate this, and is
1730 * usually implemented by the generic utility function
1731 * @event_trigger_callback() (see trace_event_triggers.c).
1733 * @reg: Adds the trigger to the list of triggers associated with the
1734 * event, and enables the event trigger itself, after
1735 * initializing it (via the event_trigger_ops @init() function).
1736 * This is also where commands can use the @trigger_type value to
1737 * make the decision as to whether or not multiple instances of
1738 * the trigger should be allowed. This is usually implemented by
1739 * the generic utility function @register_trigger() (see
1740 * trace_event_triggers.c).
1742 * @unreg: Removes the trigger from the list of triggers associated
1743 * with the event, and disables the event trigger itself, after
1744 * initializing it (via the event_trigger_ops @free() function).
1745 * This is usually implemented by the generic utility function
1746 * @unregister_trigger() (see trace_event_triggers.c).
1748 * @unreg_all: An optional function called to remove all the triggers
1749 * from the list of triggers associated with the event. Called
1750 * when a trigger file is opened in truncate mode.
1752 * @set_filter: An optional function called to parse and set a filter
1753 * for the trigger. If no @set_filter() method is set for the
1754 * event command, filters set by the user for the command will be
1755 * ignored. This is usually implemented by the generic utility
1756 * function @set_trigger_filter() (see trace_event_triggers.c).
1758 * @get_trigger_ops: The callback function invoked to retrieve the
1759 * event_trigger_ops implementation associated with the command.
1761 struct event_command {
1762 struct list_head list;
1764 enum event_trigger_type trigger_type;
1766 int (*func)(struct event_command *cmd_ops,
1767 struct trace_event_file *file,
1768 char *glob, char *cmd, char *params);
1769 int (*reg)(char *glob,
1770 struct event_trigger_ops *ops,
1771 struct event_trigger_data *data,
1772 struct trace_event_file *file);
1773 void (*unreg)(char *glob,
1774 struct event_trigger_ops *ops,
1775 struct event_trigger_data *data,
1776 struct trace_event_file *file);
1777 void (*unreg_all)(struct trace_event_file *file);
1778 int (*set_filter)(char *filter_str,
1779 struct event_trigger_data *data,
1780 struct trace_event_file *file);
1781 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1785 * enum event_command_flags - flags for struct event_command
1787 * @POST_TRIGGER: A flag that says whether or not this command needs
1788 * to have its action delayed until after the current event has
1789 * been closed. Some triggers need to avoid being invoked while
1790 * an event is currently in the process of being logged, since
1791 * the trigger may itself log data into the trace buffer. Thus
1792 * we make sure the current event is committed before invoking
1793 * those triggers. To do that, the trigger invocation is split
1794 * in two - the first part checks the filter using the current
1795 * trace record; if a command has the @post_trigger flag set, it
1796 * sets a bit for itself in the return value, otherwise it
1797 * directly invokes the trigger. Once all commands have been
1798 * either invoked or set their return flag, the current record is
1799 * either committed or discarded. At that point, if any commands
1800 * have deferred their triggers, those commands are finally
1801 * invoked following the close of the current event. In other
1802 * words, if the event_trigger_ops @func() probe implementation
1803 * itself logs to the trace buffer, this flag should be set,
1804 * otherwise it can be left unspecified.
1806 * @NEEDS_REC: A flag that says whether or not this command needs
1807 * access to the trace record in order to perform its function,
1808 * regardless of whether or not it has a filter associated with
1809 * it (filters make a trigger require access to the trace record
1810 * but are not always present).
1812 enum event_command_flags {
1813 EVENT_CMD_FL_POST_TRIGGER = 1,
1814 EVENT_CMD_FL_NEEDS_REC = 2,
1817 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1819 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1822 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1824 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1827 extern int trace_event_enable_disable(struct trace_event_file *file,
1828 int enable, int soft_disable);
1829 extern int tracing_alloc_snapshot(void);
1831 extern const char *__start___trace_bprintk_fmt[];
1832 extern const char *__stop___trace_bprintk_fmt[];
1834 extern const char *__start___tracepoint_str[];
1835 extern const char *__stop___tracepoint_str[];
1837 void trace_printk_control(bool enabled);
1838 void trace_printk_init_buffers(void);
1839 void trace_printk_start_comm(void);
1840 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1841 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1843 #define MAX_EVENT_NAME_LEN 64
1845 extern int trace_run_command(const char *buf, int (*createfn)(int, char**));
1846 extern ssize_t trace_parse_run_command(struct file *file,
1847 const char __user *buffer, size_t count, loff_t *ppos,
1848 int (*createfn)(int, char**));
1851 * Normal trace_printk() and friends allocates special buffers
1852 * to do the manipulation, as well as saves the print formats
1853 * into sections to display. But the trace infrastructure wants
1854 * to use these without the added overhead at the price of being
1855 * a bit slower (used mainly for warnings, where we don't care
1856 * about performance). The internal_trace_puts() is for such
1859 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1862 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1863 extern struct trace_event_call \
1864 __aligned(4) event_##call;
1865 #undef FTRACE_ENTRY_DUP
1866 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1867 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1869 #undef FTRACE_ENTRY_PACKED
1870 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1871 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1874 #include "trace_entries.h"
1876 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1877 int perf_ftrace_event_register(struct trace_event_call *call,
1878 enum trace_reg type, void *data);
1880 #define perf_ftrace_event_register NULL
1883 #ifdef CONFIG_FTRACE_SYSCALLS
1884 void init_ftrace_syscalls(void);
1885 const char *get_syscall_name(int syscall);
1887 static inline void init_ftrace_syscalls(void) { }
1888 static inline const char *get_syscall_name(int syscall)
1894 #ifdef CONFIG_EVENT_TRACING
1895 void trace_event_init(void);
1896 void trace_event_eval_update(struct trace_eval_map **map, int len);
1898 static inline void __init trace_event_init(void) { }
1899 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1902 #ifdef CONFIG_TRACER_SNAPSHOT
1903 void tracing_snapshot_instance(struct trace_array *tr);
1904 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1906 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1907 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1913 #ifdef CONFIG_PREEMPT_TRACER
1914 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1915 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1917 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1918 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1920 #ifdef CONFIG_IRQSOFF_TRACER
1921 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1922 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1924 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1925 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1928 extern struct trace_iterator *tracepoint_print_iter;
1931 * Reset the state of the trace_iterator so that it can read consumed data.
1932 * Normally, the trace_iterator is used for reading the data when it is not
1933 * consumed, and must retain state.
1935 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1937 const size_t offset = offsetof(struct trace_iterator, seq);
1940 * Keep gcc from complaining about overwriting more than just one
1941 * member in the structure.
1943 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1948 #endif /* _LINUX_KERNEL_TRACE_H */