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/trace.h>
15 #include <linux/hw_breakpoint.h>
16 #include <linux/trace_seq.h>
17 #include <linux/trace_events.h>
18 #include <linux/compiler.h>
19 #include <linux/glob.h>
20 #include <linux/irq_work.h>
21 #include <linux/workqueue.h>
22 #include <linux/ctype.h>
23 #include <linux/once_lite.h>
27 #ifdef CONFIG_FTRACE_SYSCALLS
28 #include <asm/unistd.h> /* For NR_SYSCALLS */
29 #include <asm/syscall.h> /* some archs define it here */
32 #define TRACE_MODE_WRITE 0640
33 #define TRACE_MODE_READ 0440
36 __TRACE_FIRST_TYPE = 0,
63 #define __field(type, item) type item;
66 #define __field_fn(type, item) type item;
69 #define __field_struct(type, item) __field(type, item)
72 #define __field_desc(type, container, item)
75 #define __field_packed(type, container, item)
78 #define __array(type, item, size) type item[size];
81 #define __array_desc(type, container, item, size)
83 #undef __dynamic_array
84 #define __dynamic_array(type, item) type item[];
86 #undef __rel_dynamic_array
87 #define __rel_dynamic_array(type, item) type item[];
90 #define F_STRUCT(args...) args
93 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
94 struct struct_name { \
95 struct trace_entry ent; \
99 #undef FTRACE_ENTRY_DUP
100 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
102 #undef FTRACE_ENTRY_REG
103 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
104 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
106 #undef FTRACE_ENTRY_PACKED
107 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
108 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
110 #include "trace_entries.h"
112 /* Use this for memory failure errors */
113 #define MEM_FAIL(condition, fmt, ...) \
114 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__)
116 #define FAULT_STRING "(fault)"
118 #define HIST_STACKTRACE_DEPTH 16
119 #define HIST_STACKTRACE_SIZE (HIST_STACKTRACE_DEPTH * sizeof(unsigned long))
120 #define HIST_STACKTRACE_SKIP 5
123 * syscalls are special, and need special handling, this is why
124 * they are not included in trace_entries.h
126 struct syscall_trace_enter {
127 struct trace_entry ent;
129 unsigned long args[];
132 struct syscall_trace_exit {
133 struct trace_entry ent;
138 struct kprobe_trace_entry_head {
139 struct trace_entry ent;
143 struct eprobe_trace_entry_head {
144 struct trace_entry ent;
148 struct kretprobe_trace_entry_head {
149 struct trace_entry ent;
151 unsigned long ret_ip;
154 #define TRACE_BUF_SIZE 1024
159 * The CPU trace array - it consists of thousands of trace entries
160 * plus some other descriptor data: (for example which task started
163 struct trace_array_cpu {
165 void *buffer_page; /* ring buffer spare */
167 unsigned long entries;
168 unsigned long saved_latency;
169 unsigned long critical_start;
170 unsigned long critical_end;
171 unsigned long critical_sequence;
173 unsigned long policy;
174 unsigned long rt_priority;
175 unsigned long skipped_entries;
176 u64 preempt_timestamp;
179 char comm[TASK_COMM_LEN];
181 #ifdef CONFIG_FUNCTION_TRACER
182 int ftrace_ignore_pid;
188 struct trace_option_dentry;
190 struct array_buffer {
191 struct trace_array *tr;
192 struct trace_buffer *buffer;
193 struct trace_array_cpu __percpu *data;
198 #define TRACE_FLAGS_MAX_SIZE 32
200 struct trace_options {
201 struct tracer *tracer;
202 struct trace_option_dentry *topts;
205 struct trace_pid_list *trace_pid_list_alloc(void);
206 void trace_pid_list_free(struct trace_pid_list *pid_list);
207 bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid);
208 int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid);
209 int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid);
210 int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid);
211 int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid,
216 TRACE_NO_PIDS = BIT(1),
219 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
220 struct trace_pid_list *no_pid_list)
222 /* Return true if the pid list in type has pids */
223 return ((type & TRACE_PIDS) && pid_list) ||
224 ((type & TRACE_NO_PIDS) && no_pid_list);
227 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
228 struct trace_pid_list *no_pid_list)
231 * Turning off what is in @type, return true if the "other"
232 * pid list, still has pids in it.
234 return (!(type & TRACE_PIDS) && pid_list) ||
235 (!(type & TRACE_NO_PIDS) && no_pid_list);
238 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
241 * struct cond_snapshot - conditional snapshot data and callback
243 * The cond_snapshot structure encapsulates a callback function and
244 * data associated with the snapshot for a given tracing instance.
246 * When a snapshot is taken conditionally, by invoking
247 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
248 * passed in turn to the cond_snapshot.update() function. That data
249 * can be compared by the update() implementation with the cond_data
250 * contained within the struct cond_snapshot instance associated with
251 * the trace_array. Because the tr->max_lock is held throughout the
252 * update() call, the update() function can directly retrieve the
253 * cond_snapshot and cond_data associated with the per-instance
254 * snapshot associated with the trace_array.
256 * The cond_snapshot.update() implementation can save data to be
257 * associated with the snapshot if it decides to, and returns 'true'
258 * in that case, or it returns 'false' if the conditional snapshot
259 * shouldn't be taken.
261 * The cond_snapshot instance is created and associated with the
262 * user-defined cond_data by tracing_cond_snapshot_enable().
263 * Likewise, the cond_snapshot instance is destroyed and is no longer
264 * associated with the trace instance by
265 * tracing_cond_snapshot_disable().
267 * The method below is required.
269 * @update: When a conditional snapshot is invoked, the update()
270 * callback function is invoked with the tr->max_lock held. The
271 * update() implementation signals whether or not to actually
272 * take the snapshot, by returning 'true' if so, 'false' if no
273 * snapshot should be taken. Because the max_lock is held for
274 * the duration of update(), the implementation is safe to
275 * directly retrieved and save any implementation data it needs
276 * to in association with the snapshot.
278 struct cond_snapshot {
280 cond_update_fn_t update;
284 * struct trace_func_repeats - used to keep track of the consecutive
285 * (on the same CPU) calls of a single function.
287 struct trace_func_repeats {
289 unsigned long parent_ip;
295 * The trace array - an array of per-CPU trace arrays. This is the
296 * highest level data structure that individual tracers deal with.
297 * They have on/off state as well:
300 struct list_head list;
302 struct array_buffer array_buffer;
303 #ifdef CONFIG_TRACER_MAX_TRACE
305 * The max_buffer is used to snapshot the trace when a maximum
306 * latency is reached, or when the user initiates a snapshot.
307 * Some tracers will use this to store a maximum trace while
308 * it continues examining live traces.
310 * The buffers for the max_buffer are set up the same as the array_buffer
311 * When a snapshot is taken, the buffer of the max_buffer is swapped
312 * with the buffer of the array_buffer and the buffers are reset for
313 * the array_buffer so the tracing can continue.
315 struct array_buffer max_buffer;
316 bool allocated_snapshot;
318 #ifdef CONFIG_TRACER_MAX_TRACE
319 unsigned long max_latency;
320 #ifdef CONFIG_FSNOTIFY
321 struct dentry *d_max_latency;
322 struct work_struct fsnotify_work;
323 struct irq_work fsnotify_irqwork;
326 struct trace_pid_list __rcu *filtered_pids;
327 struct trace_pid_list __rcu *filtered_no_pids;
329 * max_lock is used to protect the swapping of buffers
330 * when taking a max snapshot. The buffers themselves are
331 * protected by per_cpu spinlocks. But the action of the swap
332 * needs its own lock.
334 * This is defined as a arch_spinlock_t in order to help
335 * with performance when lockdep debugging is enabled.
337 * It is also used in other places outside the update_max_tr
338 * so it needs to be defined outside of the
339 * CONFIG_TRACER_MAX_TRACE.
341 arch_spinlock_t max_lock;
343 #ifdef CONFIG_FTRACE_SYSCALLS
344 int sys_refcount_enter;
345 int sys_refcount_exit;
346 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
347 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
354 unsigned int n_err_log_entries;
355 struct tracer *current_trace;
356 unsigned int trace_flags;
357 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
359 raw_spinlock_t start_lock;
360 struct list_head err_log;
362 struct dentry *options;
363 struct dentry *percpu_dir;
364 struct dentry *event_dir;
365 struct trace_options *topts;
366 struct list_head systems;
367 struct list_head events;
368 struct trace_event_file *trace_marker_file;
369 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
370 /* one per_cpu trace_pipe can be opened by only one user */
371 cpumask_var_t pipe_cpumask;
374 #ifdef CONFIG_FUNCTION_TRACER
375 struct ftrace_ops *ops;
376 struct trace_pid_list __rcu *function_pids;
377 struct trace_pid_list __rcu *function_no_pids;
378 #ifdef CONFIG_DYNAMIC_FTRACE
379 /* All of these are protected by the ftrace_lock */
380 struct list_head func_probes;
381 struct list_head mod_trace;
382 struct list_head mod_notrace;
384 /* function tracing enabled */
385 int function_enabled;
387 int no_filter_buffering_ref;
388 struct list_head hist_vars;
389 #ifdef CONFIG_TRACER_SNAPSHOT
390 struct cond_snapshot *cond_snapshot;
392 struct trace_func_repeats __percpu *last_func_repeats;
396 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
399 extern struct list_head ftrace_trace_arrays;
401 extern struct mutex trace_types_lock;
403 extern int trace_array_get(struct trace_array *tr);
404 extern int tracing_check_open_get_tr(struct trace_array *tr);
405 extern struct trace_array *trace_array_find(const char *instance);
406 extern struct trace_array *trace_array_find_get(const char *instance);
408 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
409 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
410 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
412 extern bool trace_clock_in_ns(struct trace_array *tr);
415 * The global tracer (top) should be the first trace array added,
416 * but we check the flag anyway.
418 static inline struct trace_array *top_trace_array(void)
420 struct trace_array *tr;
422 if (list_empty(&ftrace_trace_arrays))
425 tr = list_entry(ftrace_trace_arrays.prev,
427 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
431 #define FTRACE_CMP_TYPE(var, type) \
432 __builtin_types_compatible_p(typeof(var), type *)
435 #define IF_ASSIGN(var, entry, etype, id) \
436 if (FTRACE_CMP_TYPE(var, etype)) { \
437 var = (typeof(var))(entry); \
438 WARN_ON(id != 0 && (entry)->type != id); \
442 /* Will cause compile errors if type is not found. */
443 extern void __ftrace_bad_type(void);
446 * The trace_assign_type is a verifier that the entry type is
447 * the same as the type being assigned. To add new types simply
448 * add a line with the following format:
450 * IF_ASSIGN(var, ent, type, id);
452 * Where "type" is the trace type that includes the trace_entry
453 * as the "ent" item. And "id" is the trace identifier that is
454 * used in the trace_type enum.
456 * If the type can have more than one id, then use zero.
458 #define trace_assign_type(var, ent) \
460 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
461 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
462 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
463 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
464 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
465 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
466 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
467 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
468 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
469 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
470 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
471 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
473 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
475 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
476 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
478 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
480 IF_ASSIGN(var, ent, struct func_repeats_entry, \
481 TRACE_FUNC_REPEATS); \
482 __ftrace_bad_type(); \
486 * An option specific to a tracer. This is a boolean value.
487 * The bit is the bit index that sets its value on the
488 * flags value in struct tracer_flags.
491 const char *name; /* Will appear on the trace_options file */
492 u32 bit; /* Mask assigned in val field in tracer_flags */
496 * The set of specific options for a tracer. Your tracer
497 * have to set the initial value of the flags val.
499 struct tracer_flags {
501 struct tracer_opt *opts;
502 struct tracer *trace;
505 /* Makes more easy to define a tracer opt */
506 #define TRACER_OPT(s, b) .name = #s, .bit = b
509 struct trace_option_dentry {
510 struct tracer_opt *opt;
511 struct tracer_flags *flags;
512 struct trace_array *tr;
513 struct dentry *entry;
517 * struct tracer - a specific tracer and its callbacks to interact with tracefs
518 * @name: the name chosen to select it on the available_tracers file
519 * @init: called when one switches to this tracer (echo name > current_tracer)
520 * @reset: called when one switches to another tracer
521 * @start: called when tracing is unpaused (echo 1 > tracing_on)
522 * @stop: called when tracing is paused (echo 0 > tracing_on)
523 * @update_thresh: called when tracing_thresh is updated
524 * @open: called when the trace file is opened
525 * @pipe_open: called when the trace_pipe file is opened
526 * @close: called when the trace file is released
527 * @pipe_close: called when the trace_pipe file is released
528 * @read: override the default read callback on trace_pipe
529 * @splice_read: override the default splice_read callback on trace_pipe
530 * @selftest: selftest to run on boot (see trace_selftest.c)
531 * @print_headers: override the first lines that describe your columns
532 * @print_line: callback that prints a trace
533 * @set_flag: signals one of your private flags changed (trace_options file)
534 * @flags: your private flags
538 int (*init)(struct trace_array *tr);
539 void (*reset)(struct trace_array *tr);
540 void (*start)(struct trace_array *tr);
541 void (*stop)(struct trace_array *tr);
542 int (*update_thresh)(struct trace_array *tr);
543 void (*open)(struct trace_iterator *iter);
544 void (*pipe_open)(struct trace_iterator *iter);
545 void (*close)(struct trace_iterator *iter);
546 void (*pipe_close)(struct trace_iterator *iter);
547 ssize_t (*read)(struct trace_iterator *iter,
548 struct file *filp, char __user *ubuf,
549 size_t cnt, loff_t *ppos);
550 ssize_t (*splice_read)(struct trace_iterator *iter,
553 struct pipe_inode_info *pipe,
556 #ifdef CONFIG_FTRACE_STARTUP_TEST
557 int (*selftest)(struct tracer *trace,
558 struct trace_array *tr);
560 void (*print_header)(struct seq_file *m);
561 enum print_line_t (*print_line)(struct trace_iterator *iter);
562 /* If you handled the flag setting, return 0 */
563 int (*set_flag)(struct trace_array *tr,
564 u32 old_flags, u32 bit, int set);
565 /* Return 0 if OK with change, else return non-zero */
566 int (*flag_changed)(struct trace_array *tr,
569 struct tracer_flags *flags;
572 bool allow_instances;
573 #ifdef CONFIG_TRACER_MAX_TRACE
576 /* True if tracer cannot be enabled in kernel param */
580 static inline struct ring_buffer_iter *
581 trace_buffer_iter(struct trace_iterator *iter, int cpu)
583 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
586 int tracer_init(struct tracer *t, struct trace_array *tr);
587 int tracing_is_enabled(void);
588 void tracing_reset_online_cpus(struct array_buffer *buf);
589 void tracing_reset_current(int cpu);
590 void tracing_reset_all_online_cpus(void);
591 void tracing_reset_all_online_cpus_unlocked(void);
592 int tracing_open_generic(struct inode *inode, struct file *filp);
593 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
594 int tracing_open_file_tr(struct inode *inode, struct file *filp);
595 int tracing_release_file_tr(struct inode *inode, struct file *filp);
596 bool tracing_is_disabled(void);
597 bool tracer_tracing_is_on(struct trace_array *tr);
598 void tracer_tracing_on(struct trace_array *tr);
599 void tracer_tracing_off(struct trace_array *tr);
600 struct dentry *trace_create_file(const char *name,
602 struct dentry *parent,
604 const struct file_operations *fops);
606 int tracing_init_dentry(void);
608 struct ring_buffer_event;
610 struct ring_buffer_event *
611 trace_buffer_lock_reserve(struct trace_buffer *buffer,
614 unsigned int trace_ctx);
616 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
617 struct trace_array_cpu *data);
619 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
620 int *ent_cpu, u64 *ent_ts);
622 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
623 struct ring_buffer_event *event);
625 bool trace_is_tracepoint_string(const char *str);
626 const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
627 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
630 int trace_empty(struct trace_iterator *iter);
632 void *trace_find_next_entry_inc(struct trace_iterator *iter);
634 void trace_init_global_iter(struct trace_iterator *iter);
636 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
638 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
639 unsigned long trace_total_entries(struct trace_array *tr);
641 void trace_function(struct trace_array *tr,
643 unsigned long parent_ip,
644 unsigned int trace_ctx);
645 void trace_graph_function(struct trace_array *tr,
647 unsigned long parent_ip,
648 unsigned int trace_ctx);
649 void trace_latency_header(struct seq_file *m);
650 void trace_default_header(struct seq_file *m);
651 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
653 void trace_graph_return(struct ftrace_graph_ret *trace);
654 int trace_graph_entry(struct ftrace_graph_ent *trace);
655 void set_graph_array(struct trace_array *tr);
657 void tracing_start_cmdline_record(void);
658 void tracing_stop_cmdline_record(void);
659 void tracing_start_tgid_record(void);
660 void tracing_stop_tgid_record(void);
662 int register_tracer(struct tracer *type);
663 int is_tracing_stopped(void);
665 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
667 extern cpumask_var_t __read_mostly tracing_buffer_mask;
669 #define for_each_tracing_cpu(cpu) \
670 for_each_cpu(cpu, tracing_buffer_mask)
672 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
674 extern unsigned long tracing_thresh;
680 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
682 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
683 struct trace_pid_list *filtered_no_pids,
684 struct task_struct *task);
685 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
686 struct task_struct *self,
687 struct task_struct *task);
688 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
689 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
690 int trace_pid_show(struct seq_file *m, void *v);
691 void trace_free_pid_list(struct trace_pid_list *pid_list);
692 int trace_pid_write(struct trace_pid_list *filtered_pids,
693 struct trace_pid_list **new_pid_list,
694 const char __user *ubuf, size_t cnt);
696 #ifdef CONFIG_TRACER_MAX_TRACE
697 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
699 void update_max_tr_single(struct trace_array *tr,
700 struct task_struct *tsk, int cpu);
702 #ifdef CONFIG_FSNOTIFY
703 #define LATENCY_FS_NOTIFY
705 #endif /* CONFIG_TRACER_MAX_TRACE */
707 #ifdef LATENCY_FS_NOTIFY
708 void latency_fsnotify(struct trace_array *tr);
710 static inline void latency_fsnotify(struct trace_array *tr) { }
713 #ifdef CONFIG_STACKTRACE
714 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
716 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
720 #endif /* CONFIG_STACKTRACE */
722 void trace_last_func_repeats(struct trace_array *tr,
723 struct trace_func_repeats *last_info,
724 unsigned int trace_ctx);
726 extern u64 ftrace_now(int cpu);
728 extern void trace_find_cmdline(int pid, char comm[]);
729 extern int trace_find_tgid(int pid);
730 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
732 #ifdef CONFIG_DYNAMIC_FTRACE
733 extern unsigned long ftrace_update_tot_cnt;
734 extern unsigned long ftrace_number_of_pages;
735 extern unsigned long ftrace_number_of_groups;
736 void ftrace_init_trace_array(struct trace_array *tr);
738 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
740 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
741 extern int DYN_FTRACE_TEST_NAME(void);
742 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
743 extern int DYN_FTRACE_TEST_NAME2(void);
745 extern bool ring_buffer_expanded;
746 extern bool tracing_selftest_disabled;
748 #ifdef CONFIG_FTRACE_STARTUP_TEST
749 extern void __init disable_tracing_selftest(const char *reason);
751 extern int trace_selftest_startup_function(struct tracer *trace,
752 struct trace_array *tr);
753 extern int trace_selftest_startup_function_graph(struct tracer *trace,
754 struct trace_array *tr);
755 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
756 struct trace_array *tr);
757 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
758 struct trace_array *tr);
759 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
760 struct trace_array *tr);
761 extern int trace_selftest_startup_wakeup(struct tracer *trace,
762 struct trace_array *tr);
763 extern int trace_selftest_startup_nop(struct tracer *trace,
764 struct trace_array *tr);
765 extern int trace_selftest_startup_branch(struct tracer *trace,
766 struct trace_array *tr);
768 * Tracer data references selftest functions that only occur
769 * on boot up. These can be __init functions. Thus, when selftests
770 * are enabled, then the tracers need to reference __init functions.
772 #define __tracer_data __refdata
774 static inline void __init disable_tracing_selftest(const char *reason)
777 /* Tracers are seldom changed. Optimize when selftests are disabled. */
778 #define __tracer_data __read_mostly
779 #endif /* CONFIG_FTRACE_STARTUP_TEST */
781 extern void *head_page(struct trace_array_cpu *data);
782 extern unsigned long long ns2usecs(u64 nsec);
784 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
786 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
788 trace_array_vprintk(struct trace_array *tr,
789 unsigned long ip, const char *fmt, va_list args);
790 int trace_array_printk_buf(struct trace_buffer *buffer,
791 unsigned long ip, const char *fmt, ...);
792 void trace_printk_seq(struct trace_seq *s);
793 enum print_line_t print_trace_line(struct trace_iterator *iter);
795 extern char trace_find_mark(unsigned long long duration);
799 struct ftrace_mod_load {
800 struct list_head list;
807 FTRACE_HASH_FL_MOD = (1 << 0),
811 unsigned long size_bits;
812 struct hlist_head *buckets;
818 struct ftrace_func_entry *
819 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
821 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
823 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
826 /* Standard output formatting function used for function return traces */
827 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
830 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
831 #define TRACE_GRAPH_PRINT_CPU 0x2
832 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
833 #define TRACE_GRAPH_PRINT_PROC 0x8
834 #define TRACE_GRAPH_PRINT_DURATION 0x10
835 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
836 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
837 #define TRACE_GRAPH_PRINT_IRQS 0x80
838 #define TRACE_GRAPH_PRINT_TAIL 0x100
839 #define TRACE_GRAPH_SLEEP_TIME 0x200
840 #define TRACE_GRAPH_GRAPH_TIME 0x400
841 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
842 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
844 extern void ftrace_graph_sleep_time_control(bool enable);
846 #ifdef CONFIG_FUNCTION_PROFILER
847 extern void ftrace_graph_graph_time_control(bool enable);
849 static inline void ftrace_graph_graph_time_control(bool enable) { }
852 extern enum print_line_t
853 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
854 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
856 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
857 extern void graph_trace_open(struct trace_iterator *iter);
858 extern void graph_trace_close(struct trace_iterator *iter);
859 extern int __trace_graph_entry(struct trace_array *tr,
860 struct ftrace_graph_ent *trace,
861 unsigned int trace_ctx);
862 extern void __trace_graph_return(struct trace_array *tr,
863 struct ftrace_graph_ret *trace,
864 unsigned int trace_ctx);
866 #ifdef CONFIG_DYNAMIC_FTRACE
867 extern struct ftrace_hash __rcu *ftrace_graph_hash;
868 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
870 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
872 unsigned long addr = trace->func;
874 struct ftrace_hash *hash;
876 preempt_disable_notrace();
879 * Have to open code "rcu_dereference_sched()" because the
880 * function graph tracer can be called when RCU is not
882 * Protected with schedule_on_each_cpu(ftrace_sync)
884 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
886 if (ftrace_hash_empty(hash)) {
891 if (ftrace_lookup_ip(hash, addr)) {
894 * This needs to be cleared on the return functions
895 * when the depth is zero.
897 trace_recursion_set(TRACE_GRAPH_BIT);
898 trace_recursion_set_depth(trace->depth);
901 * If no irqs are to be traced, but a set_graph_function
902 * is set, and called by an interrupt handler, we still
906 trace_recursion_set(TRACE_IRQ_BIT);
908 trace_recursion_clear(TRACE_IRQ_BIT);
913 preempt_enable_notrace();
917 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
919 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
920 trace->depth == trace_recursion_depth())
921 trace_recursion_clear(TRACE_GRAPH_BIT);
924 static inline int ftrace_graph_notrace_addr(unsigned long addr)
927 struct ftrace_hash *notrace_hash;
929 preempt_disable_notrace();
932 * Have to open code "rcu_dereference_sched()" because the
933 * function graph tracer can be called when RCU is not
935 * Protected with schedule_on_each_cpu(ftrace_sync)
937 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
940 if (ftrace_lookup_ip(notrace_hash, addr))
943 preempt_enable_notrace();
947 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
952 static inline int ftrace_graph_notrace_addr(unsigned long addr)
956 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
958 #endif /* CONFIG_DYNAMIC_FTRACE */
960 extern unsigned int fgraph_max_depth;
962 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
964 /* trace it when it is-nested-in or is a function enabled. */
965 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
966 ftrace_graph_addr(trace)) ||
967 (trace->depth < 0) ||
968 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
971 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
972 static inline enum print_line_t
973 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
975 return TRACE_TYPE_UNHANDLED;
977 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
979 extern struct list_head ftrace_pids;
981 #ifdef CONFIG_FUNCTION_TRACER
983 #define FTRACE_PID_IGNORE -1
984 #define FTRACE_PID_TRACE -2
986 struct ftrace_func_command {
987 struct list_head list;
989 int (*func)(struct trace_array *tr,
990 struct ftrace_hash *hash,
991 char *func, char *cmd,
992 char *params, int enable);
994 extern bool ftrace_filter_param __initdata;
995 static inline int ftrace_trace_task(struct trace_array *tr)
997 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
1000 extern int ftrace_is_dead(void);
1001 int ftrace_create_function_files(struct trace_array *tr,
1002 struct dentry *parent);
1003 void ftrace_destroy_function_files(struct trace_array *tr);
1004 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
1005 void ftrace_free_ftrace_ops(struct trace_array *tr);
1006 void ftrace_init_global_array_ops(struct trace_array *tr);
1007 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1008 void ftrace_reset_array_ops(struct trace_array *tr);
1009 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1010 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1011 struct dentry *d_tracer);
1012 void ftrace_clear_pids(struct trace_array *tr);
1013 int init_function_trace(void);
1014 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1016 static inline int ftrace_trace_task(struct trace_array *tr)
1020 static inline int ftrace_is_dead(void) { return 0; }
1022 ftrace_create_function_files(struct trace_array *tr,
1023 struct dentry *parent)
1027 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1031 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1032 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1033 static inline __init void
1034 ftrace_init_global_array_ops(struct trace_array *tr) { }
1035 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1036 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1037 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1038 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1039 static inline int init_function_trace(void) { return 0; }
1040 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1041 /* ftace_func_t type is not defined, use macro instead of static inline */
1042 #define ftrace_init_array_ops(tr, func) do { } while (0)
1043 #endif /* CONFIG_FUNCTION_TRACER */
1045 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1047 struct ftrace_probe_ops {
1048 void (*func)(unsigned long ip,
1049 unsigned long parent_ip,
1050 struct trace_array *tr,
1051 struct ftrace_probe_ops *ops,
1053 int (*init)(struct ftrace_probe_ops *ops,
1054 struct trace_array *tr,
1055 unsigned long ip, void *init_data,
1057 void (*free)(struct ftrace_probe_ops *ops,
1058 struct trace_array *tr,
1059 unsigned long ip, void *data);
1060 int (*print)(struct seq_file *m,
1062 struct ftrace_probe_ops *ops,
1066 struct ftrace_func_mapper;
1067 typedef int (*ftrace_mapper_func)(void *data);
1069 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1070 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1072 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1073 unsigned long ip, void *data);
1074 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1076 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1077 ftrace_mapper_func free_func);
1080 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1081 struct ftrace_probe_ops *ops, void *data);
1083 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1084 struct ftrace_probe_ops *ops);
1085 extern void clear_ftrace_function_probes(struct trace_array *tr);
1087 int register_ftrace_command(struct ftrace_func_command *cmd);
1088 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1090 void ftrace_create_filter_files(struct ftrace_ops *ops,
1091 struct dentry *parent);
1092 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1094 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1095 int len, int reset);
1096 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1097 int len, int reset);
1099 struct ftrace_func_command;
1101 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1105 static inline __init int unregister_ftrace_command(char *cmd_name)
1109 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1114 * The ops parameter passed in is usually undefined.
1115 * This must be a macro.
1117 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1118 #define ftrace_destroy_filter_files(ops) do { } while (0)
1119 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1121 bool ftrace_event_is_function(struct trace_event_call *call);
1124 * struct trace_parser - servers for reading the user input separated by spaces
1125 * @cont: set if the input is not complete - no final space char was found
1126 * @buffer: holds the parsed user input
1127 * @idx: user input length
1128 * @size: buffer size
1130 struct trace_parser {
1137 static inline bool trace_parser_loaded(struct trace_parser *parser)
1139 return (parser->idx != 0);
1142 static inline bool trace_parser_cont(struct trace_parser *parser)
1144 return parser->cont;
1147 static inline void trace_parser_clear(struct trace_parser *parser)
1149 parser->cont = false;
1153 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1154 extern void trace_parser_put(struct trace_parser *parser);
1155 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1156 size_t cnt, loff_t *ppos);
1159 * Only create function graph options if function graph is configured.
1161 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1162 # define FGRAPH_FLAGS \
1163 C(DISPLAY_GRAPH, "display-graph"),
1165 # define FGRAPH_FLAGS
1168 #ifdef CONFIG_BRANCH_TRACER
1169 # define BRANCH_FLAGS \
1170 C(BRANCH, "branch"),
1172 # define BRANCH_FLAGS
1175 #ifdef CONFIG_FUNCTION_TRACER
1176 # define FUNCTION_FLAGS \
1177 C(FUNCTION, "function-trace"), \
1178 C(FUNC_FORK, "function-fork"),
1179 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1181 # define FUNCTION_FLAGS
1182 # define FUNCTION_DEFAULT_FLAGS 0UL
1183 # define TRACE_ITER_FUNC_FORK 0UL
1186 #ifdef CONFIG_STACKTRACE
1187 # define STACK_FLAGS \
1188 C(STACKTRACE, "stacktrace"),
1190 # define STACK_FLAGS
1194 * trace_iterator_flags is an enumeration that defines bit
1195 * positions into trace_flags that controls the output.
1197 * NOTE: These bits must match the trace_options array in
1198 * trace.c (this macro guarantees it).
1200 #define TRACE_FLAGS \
1201 C(PRINT_PARENT, "print-parent"), \
1202 C(SYM_OFFSET, "sym-offset"), \
1203 C(SYM_ADDR, "sym-addr"), \
1204 C(VERBOSE, "verbose"), \
1208 C(BLOCK, "block"), \
1209 C(PRINTK, "trace_printk"), \
1210 C(ANNOTATE, "annotate"), \
1211 C(USERSTACKTRACE, "userstacktrace"), \
1212 C(SYM_USEROBJ, "sym-userobj"), \
1213 C(PRINTK_MSGONLY, "printk-msg-only"), \
1214 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1215 C(LATENCY_FMT, "latency-format"), \
1216 C(RECORD_CMD, "record-cmd"), \
1217 C(RECORD_TGID, "record-tgid"), \
1218 C(OVERWRITE, "overwrite"), \
1219 C(STOP_ON_FREE, "disable_on_free"), \
1220 C(IRQ_INFO, "irq-info"), \
1221 C(MARKERS, "markers"), \
1222 C(EVENT_FORK, "event-fork"), \
1223 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1224 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1231 * By defining C, we can make TRACE_FLAGS a list of bit names
1232 * that will define the bits for the flag masks.
1235 #define C(a, b) TRACE_ITER_##a##_BIT
1237 enum trace_iterator_bits {
1239 /* Make sure we don't go more than we have bits for */
1244 * By redefining C, we can make TRACE_FLAGS a list of masks that
1245 * use the bits as defined above.
1248 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1250 enum trace_iterator_flags { TRACE_FLAGS };
1253 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1254 * control the output of kernel symbols.
1256 #define TRACE_ITER_SYM_MASK \
1257 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1259 extern struct tracer nop_trace;
1261 #ifdef CONFIG_BRANCH_TRACER
1262 extern int enable_branch_tracing(struct trace_array *tr);
1263 extern void disable_branch_tracing(void);
1264 static inline int trace_branch_enable(struct trace_array *tr)
1266 if (tr->trace_flags & TRACE_ITER_BRANCH)
1267 return enable_branch_tracing(tr);
1270 static inline void trace_branch_disable(void)
1272 /* due to races, always disable */
1273 disable_branch_tracing();
1276 static inline int trace_branch_enable(struct trace_array *tr)
1280 static inline void trace_branch_disable(void)
1283 #endif /* CONFIG_BRANCH_TRACER */
1285 /* set ring buffers to default size if not already done so */
1286 int tracing_update_buffers(void);
1288 struct ftrace_event_field {
1289 struct list_head link;
1300 struct event_filter {
1301 struct prog_entry __rcu *prog;
1302 char *filter_string;
1305 struct event_subsystem {
1306 struct list_head list;
1308 struct event_filter *filter;
1312 struct trace_subsystem_dir {
1313 struct list_head list;
1314 struct event_subsystem *subsystem;
1315 struct trace_array *tr;
1316 struct dentry *entry;
1321 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1322 struct trace_buffer *buffer,
1323 struct ring_buffer_event *event);
1325 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1326 struct trace_buffer *buffer,
1327 struct ring_buffer_event *event,
1328 unsigned int trcace_ctx,
1329 struct pt_regs *regs);
1331 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1332 struct trace_buffer *buffer,
1333 struct ring_buffer_event *event,
1334 unsigned int trace_ctx)
1336 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1339 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1340 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1341 void trace_buffered_event_disable(void);
1342 void trace_buffered_event_enable(void);
1345 __trace_event_discard_commit(struct trace_buffer *buffer,
1346 struct ring_buffer_event *event)
1348 if (this_cpu_read(trace_buffered_event) == event) {
1349 /* Simply release the temp buffer */
1350 this_cpu_dec(trace_buffered_event_cnt);
1353 ring_buffer_discard_commit(buffer, event);
1357 * Helper function for event_trigger_unlock_commit{_regs}().
1358 * If there are event triggers attached to this event that requires
1359 * filtering against its fields, then they will be called as the
1360 * entry already holds the field information of the current event.
1362 * It also checks if the event should be discarded or not.
1363 * It is to be discarded if the event is soft disabled and the
1364 * event was only recorded to process triggers, or if the event
1365 * filter is active and this event did not match the filters.
1367 * Returns true if the event is discarded, false otherwise.
1370 __event_trigger_test_discard(struct trace_event_file *file,
1371 struct trace_buffer *buffer,
1372 struct ring_buffer_event *event,
1374 enum event_trigger_type *tt)
1376 unsigned long eflags = file->flags;
1378 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1379 *tt = event_triggers_call(file, buffer, entry, event);
1381 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1382 EVENT_FILE_FL_FILTERED |
1383 EVENT_FILE_FL_PID_FILTER))))
1386 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1389 if (file->flags & EVENT_FILE_FL_FILTERED &&
1390 !filter_match_preds(file->filter, entry))
1393 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1394 trace_event_ignore_this_pid(file))
1399 __trace_event_discard_commit(buffer, event);
1404 * event_trigger_unlock_commit - handle triggers and finish event commit
1405 * @file: The file pointer associated with the event
1406 * @buffer: The ring buffer that the event is being written to
1407 * @event: The event meta data in the ring buffer
1408 * @entry: The event itself
1409 * @trace_ctx: The tracing context flags.
1411 * This is a helper function to handle triggers that require data
1412 * from the event itself. It also tests the event against filters and
1413 * if the event is soft disabled and should be discarded.
1416 event_trigger_unlock_commit(struct trace_event_file *file,
1417 struct trace_buffer *buffer,
1418 struct ring_buffer_event *event,
1419 void *entry, unsigned int trace_ctx)
1421 enum event_trigger_type tt = ETT_NONE;
1423 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1424 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1427 event_triggers_post_call(file, tt);
1430 #define FILTER_PRED_INVALID ((unsigned short)-1)
1431 #define FILTER_PRED_IS_RIGHT (1 << 15)
1432 #define FILTER_PRED_FOLD (1 << 15)
1435 * The max preds is the size of unsigned short with
1436 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1437 * and FOLD flags. The other is reserved.
1439 * 2^14 preds is way more than enough.
1441 #define MAX_FILTER_PRED 16384
1446 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1448 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1460 char pattern[MAX_FILTER_STR_VAL];
1463 regex_match_func match;
1466 struct filter_pred {
1467 filter_pred_fn_t fn;
1470 unsigned short *ops;
1471 struct ftrace_event_field *field;
1477 static inline bool is_string_field(struct ftrace_event_field *field)
1479 return field->filter_type == FILTER_DYN_STRING ||
1480 field->filter_type == FILTER_STATIC_STRING ||
1481 field->filter_type == FILTER_PTR_STRING ||
1482 field->filter_type == FILTER_COMM;
1485 static inline bool is_function_field(struct ftrace_event_field *field)
1487 return field->filter_type == FILTER_TRACE_FN;
1490 extern enum regex_type
1491 filter_parse_regex(char *buff, int len, char **search, int *not);
1492 extern void print_event_filter(struct trace_event_file *file,
1493 struct trace_seq *s);
1494 extern int apply_event_filter(struct trace_event_file *file,
1495 char *filter_string);
1496 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1497 char *filter_string);
1498 extern void print_subsystem_event_filter(struct event_subsystem *system,
1499 struct trace_seq *s);
1500 extern int filter_assign_type(const char *type);
1501 extern int create_event_filter(struct trace_array *tr,
1502 struct trace_event_call *call,
1503 char *filter_str, bool set_str,
1504 struct event_filter **filterp);
1505 extern void free_event_filter(struct event_filter *filter);
1507 struct ftrace_event_field *
1508 trace_find_event_field(struct trace_event_call *call, char *name);
1510 extern void trace_event_enable_cmd_record(bool enable);
1511 extern void trace_event_enable_tgid_record(bool enable);
1513 extern int event_trace_init(void);
1514 extern int init_events(void);
1515 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1516 extern int event_trace_del_tracer(struct trace_array *tr);
1517 extern void __trace_early_add_events(struct trace_array *tr);
1519 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1522 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1526 static inline void *event_file_data(struct file *filp)
1528 return READ_ONCE(file_inode(filp)->i_private);
1531 extern struct mutex event_mutex;
1532 extern struct list_head ftrace_events;
1534 extern const struct file_operations event_trigger_fops;
1535 extern const struct file_operations event_hist_fops;
1536 extern const struct file_operations event_hist_debug_fops;
1537 extern const struct file_operations event_inject_fops;
1539 #ifdef CONFIG_HIST_TRIGGERS
1540 extern int register_trigger_hist_cmd(void);
1541 extern int register_trigger_hist_enable_disable_cmds(void);
1543 static inline int register_trigger_hist_cmd(void) { return 0; }
1544 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1547 extern int register_trigger_cmds(void);
1548 extern void clear_event_triggers(struct trace_array *tr);
1551 EVENT_TRIGGER_FL_PROBE = BIT(0),
1554 struct event_trigger_data {
1555 unsigned long count;
1558 struct event_trigger_ops *ops;
1559 struct event_command *cmd_ops;
1560 struct event_filter __rcu *filter;
1565 struct list_head list;
1567 struct list_head named_list;
1568 struct event_trigger_data *named_data;
1572 #define ENABLE_EVENT_STR "enable_event"
1573 #define DISABLE_EVENT_STR "disable_event"
1574 #define ENABLE_HIST_STR "enable_hist"
1575 #define DISABLE_HIST_STR "disable_hist"
1577 struct enable_trigger_data {
1578 struct trace_event_file *file;
1583 extern int event_enable_trigger_print(struct seq_file *m,
1584 struct event_trigger_ops *ops,
1585 struct event_trigger_data *data);
1586 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1587 struct event_trigger_data *data);
1588 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1589 struct trace_event_file *file,
1590 char *glob, char *cmd, char *param);
1591 extern int event_enable_register_trigger(char *glob,
1592 struct event_trigger_ops *ops,
1593 struct event_trigger_data *data,
1594 struct trace_event_file *file);
1595 extern void event_enable_unregister_trigger(char *glob,
1596 struct event_trigger_ops *ops,
1597 struct event_trigger_data *test,
1598 struct trace_event_file *file);
1599 extern void trigger_data_free(struct event_trigger_data *data);
1600 extern int event_trigger_init(struct event_trigger_ops *ops,
1601 struct event_trigger_data *data);
1602 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1603 int trigger_enable);
1604 extern void update_cond_flag(struct trace_event_file *file);
1605 extern int set_trigger_filter(char *filter_str,
1606 struct event_trigger_data *trigger_data,
1607 struct trace_event_file *file);
1608 extern struct event_trigger_data *find_named_trigger(const char *name);
1609 extern bool is_named_trigger(struct event_trigger_data *test);
1610 extern int save_named_trigger(const char *name,
1611 struct event_trigger_data *data);
1612 extern void del_named_trigger(struct event_trigger_data *data);
1613 extern void pause_named_trigger(struct event_trigger_data *data);
1614 extern void unpause_named_trigger(struct event_trigger_data *data);
1615 extern void set_named_trigger_data(struct event_trigger_data *data,
1616 struct event_trigger_data *named_data);
1617 extern struct event_trigger_data *
1618 get_named_trigger_data(struct event_trigger_data *data);
1619 extern int register_event_command(struct event_command *cmd);
1620 extern int unregister_event_command(struct event_command *cmd);
1621 extern int register_trigger_hist_enable_disable_cmds(void);
1624 * struct event_trigger_ops - callbacks for trace event triggers
1626 * The methods in this structure provide per-event trigger hooks for
1627 * various trigger operations.
1629 * All the methods below, except for @init() and @free(), must be
1632 * @func: The trigger 'probe' function called when the triggering
1633 * event occurs. The data passed into this callback is the data
1634 * that was supplied to the event_command @reg() function that
1635 * registered the trigger (see struct event_command) along with
1636 * the trace record, rec.
1638 * @init: An optional initialization function called for the trigger
1639 * when the trigger is registered (via the event_command reg()
1640 * function). This can be used to perform per-trigger
1641 * initialization such as incrementing a per-trigger reference
1642 * count, for instance. This is usually implemented by the
1643 * generic utility function @event_trigger_init() (see
1644 * trace_event_triggers.c).
1646 * @free: An optional de-initialization function called for the
1647 * trigger when the trigger is unregistered (via the
1648 * event_command @reg() function). This can be used to perform
1649 * per-trigger de-initialization such as decrementing a
1650 * per-trigger reference count and freeing corresponding trigger
1651 * data, for instance. This is usually implemented by the
1652 * generic utility function @event_trigger_free() (see
1653 * trace_event_triggers.c).
1655 * @print: The callback function invoked to have the trigger print
1656 * itself. This is usually implemented by a wrapper function
1657 * that calls the generic utility function @event_trigger_print()
1658 * (see trace_event_triggers.c).
1660 struct event_trigger_ops {
1661 void (*func)(struct event_trigger_data *data,
1662 struct trace_buffer *buffer, void *rec,
1663 struct ring_buffer_event *rbe);
1664 int (*init)(struct event_trigger_ops *ops,
1665 struct event_trigger_data *data);
1666 void (*free)(struct event_trigger_ops *ops,
1667 struct event_trigger_data *data);
1668 int (*print)(struct seq_file *m,
1669 struct event_trigger_ops *ops,
1670 struct event_trigger_data *data);
1674 * struct event_command - callbacks and data members for event commands
1676 * Event commands are invoked by users by writing the command name
1677 * into the 'trigger' file associated with a trace event. The
1678 * parameters associated with a specific invocation of an event
1679 * command are used to create an event trigger instance, which is
1680 * added to the list of trigger instances associated with that trace
1681 * event. When the event is hit, the set of triggers associated with
1682 * that event is invoked.
1684 * The data members in this structure provide per-event command data
1685 * for various event commands.
1687 * All the data members below, except for @post_trigger, must be set
1688 * for each event command.
1690 * @name: The unique name that identifies the event command. This is
1691 * the name used when setting triggers via trigger files.
1693 * @trigger_type: A unique id that identifies the event command
1694 * 'type'. This value has two purposes, the first to ensure that
1695 * only one trigger of the same type can be set at a given time
1696 * for a particular event e.g. it doesn't make sense to have both
1697 * a traceon and traceoff trigger attached to a single event at
1698 * the same time, so traceon and traceoff have the same type
1699 * though they have different names. The @trigger_type value is
1700 * also used as a bit value for deferring the actual trigger
1701 * action until after the current event is finished. Some
1702 * commands need to do this if they themselves log to the trace
1703 * buffer (see the @post_trigger() member below). @trigger_type
1704 * values are defined by adding new values to the trigger_type
1705 * enum in include/linux/trace_events.h.
1707 * @flags: See the enum event_command_flags below.
1709 * All the methods below, except for @set_filter() and @unreg_all(),
1710 * must be implemented.
1712 * @func: The callback function responsible for parsing and
1713 * registering the trigger written to the 'trigger' file by the
1714 * user. It allocates the trigger instance and registers it with
1715 * the appropriate trace event. It makes use of the other
1716 * event_command callback functions to orchestrate this, and is
1717 * usually implemented by the generic utility function
1718 * @event_trigger_callback() (see trace_event_triggers.c).
1720 * @reg: Adds the trigger to the list of triggers associated with the
1721 * event, and enables the event trigger itself, after
1722 * initializing it (via the event_trigger_ops @init() function).
1723 * This is also where commands can use the @trigger_type value to
1724 * make the decision as to whether or not multiple instances of
1725 * the trigger should be allowed. This is usually implemented by
1726 * the generic utility function @register_trigger() (see
1727 * trace_event_triggers.c).
1729 * @unreg: Removes the trigger from the list of triggers associated
1730 * with the event, and disables the event trigger itself, after
1731 * initializing it (via the event_trigger_ops @free() function).
1732 * This is usually implemented by the generic utility function
1733 * @unregister_trigger() (see trace_event_triggers.c).
1735 * @unreg_all: An optional function called to remove all the triggers
1736 * from the list of triggers associated with the event. Called
1737 * when a trigger file is opened in truncate mode.
1739 * @set_filter: An optional function called to parse and set a filter
1740 * for the trigger. If no @set_filter() method is set for the
1741 * event command, filters set by the user for the command will be
1742 * ignored. This is usually implemented by the generic utility
1743 * function @set_trigger_filter() (see trace_event_triggers.c).
1745 * @get_trigger_ops: The callback function invoked to retrieve the
1746 * event_trigger_ops implementation associated with the command.
1748 struct event_command {
1749 struct list_head list;
1751 enum event_trigger_type trigger_type;
1753 int (*func)(struct event_command *cmd_ops,
1754 struct trace_event_file *file,
1755 char *glob, char *cmd, char *params);
1756 int (*reg)(char *glob,
1757 struct event_trigger_ops *ops,
1758 struct event_trigger_data *data,
1759 struct trace_event_file *file);
1760 void (*unreg)(char *glob,
1761 struct event_trigger_ops *ops,
1762 struct event_trigger_data *data,
1763 struct trace_event_file *file);
1764 void (*unreg_all)(struct trace_event_file *file);
1765 int (*set_filter)(char *filter_str,
1766 struct event_trigger_data *data,
1767 struct trace_event_file *file);
1768 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1772 * enum event_command_flags - flags for struct event_command
1774 * @POST_TRIGGER: A flag that says whether or not this command needs
1775 * to have its action delayed until after the current event has
1776 * been closed. Some triggers need to avoid being invoked while
1777 * an event is currently in the process of being logged, since
1778 * the trigger may itself log data into the trace buffer. Thus
1779 * we make sure the current event is committed before invoking
1780 * those triggers. To do that, the trigger invocation is split
1781 * in two - the first part checks the filter using the current
1782 * trace record; if a command has the @post_trigger flag set, it
1783 * sets a bit for itself in the return value, otherwise it
1784 * directly invokes the trigger. Once all commands have been
1785 * either invoked or set their return flag, the current record is
1786 * either committed or discarded. At that point, if any commands
1787 * have deferred their triggers, those commands are finally
1788 * invoked following the close of the current event. In other
1789 * words, if the event_trigger_ops @func() probe implementation
1790 * itself logs to the trace buffer, this flag should be set,
1791 * otherwise it can be left unspecified.
1793 * @NEEDS_REC: A flag that says whether or not this command needs
1794 * access to the trace record in order to perform its function,
1795 * regardless of whether or not it has a filter associated with
1796 * it (filters make a trigger require access to the trace record
1797 * but are not always present).
1799 enum event_command_flags {
1800 EVENT_CMD_FL_POST_TRIGGER = 1,
1801 EVENT_CMD_FL_NEEDS_REC = 2,
1804 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1806 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1809 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1811 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1814 extern int trace_event_enable_disable(struct trace_event_file *file,
1815 int enable, int soft_disable);
1816 extern int tracing_alloc_snapshot(void);
1817 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1818 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1820 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1821 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1823 extern const char *__start___trace_bprintk_fmt[];
1824 extern const char *__stop___trace_bprintk_fmt[];
1826 extern const char *__start___tracepoint_str[];
1827 extern const char *__stop___tracepoint_str[];
1829 void trace_printk_control(bool enabled);
1830 void trace_printk_start_comm(void);
1831 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1832 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1834 /* Used from boot time tracer */
1835 extern int trace_set_options(struct trace_array *tr, char *option);
1836 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1837 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1838 unsigned long size, int cpu_id);
1839 extern int tracing_set_cpumask(struct trace_array *tr,
1840 cpumask_var_t tracing_cpumask_new);
1843 #define MAX_EVENT_NAME_LEN 64
1845 extern ssize_t trace_parse_run_command(struct file *file,
1846 const char __user *buffer, size_t count, loff_t *ppos,
1847 int (*createfn)(const char *));
1849 extern unsigned int err_pos(char *cmd, const char *str);
1850 extern void tracing_log_err(struct trace_array *tr,
1851 const char *loc, const char *cmd,
1852 const char **errs, u8 type, u8 pos);
1855 * Normal trace_printk() and friends allocates special buffers
1856 * to do the manipulation, as well as saves the print formats
1857 * into sections to display. But the trace infrastructure wants
1858 * to use these without the added overhead at the price of being
1859 * a bit slower (used mainly for warnings, where we don't care
1860 * about performance). The internal_trace_puts() is for such
1863 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1866 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1867 extern struct trace_event_call \
1868 __aligned(4) event_##call;
1869 #undef FTRACE_ENTRY_DUP
1870 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1871 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1872 #undef FTRACE_ENTRY_PACKED
1873 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1874 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1876 #include "trace_entries.h"
1878 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1879 int perf_ftrace_event_register(struct trace_event_call *call,
1880 enum trace_reg type, void *data);
1882 #define perf_ftrace_event_register NULL
1885 #ifdef CONFIG_FTRACE_SYSCALLS
1886 void init_ftrace_syscalls(void);
1887 const char *get_syscall_name(int syscall);
1889 static inline void init_ftrace_syscalls(void) { }
1890 static inline const char *get_syscall_name(int syscall)
1896 #ifdef CONFIG_EVENT_TRACING
1897 void trace_event_init(void);
1898 void trace_event_eval_update(struct trace_eval_map **map, int len);
1899 /* Used from boot time tracer */
1900 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1901 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1903 static inline void __init trace_event_init(void) { }
1904 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1907 #ifdef CONFIG_TRACER_SNAPSHOT
1908 void tracing_snapshot_instance(struct trace_array *tr);
1909 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1911 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1912 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1918 #ifdef CONFIG_PREEMPT_TRACER
1919 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1920 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1922 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1923 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1925 #ifdef CONFIG_IRQSOFF_TRACER
1926 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1927 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1929 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1930 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1933 extern struct trace_iterator *tracepoint_print_iter;
1936 * Reset the state of the trace_iterator so that it can read consumed data.
1937 * Normally, the trace_iterator is used for reading the data when it is not
1938 * consumed, and must retain state.
1940 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1942 const size_t offset = offsetof(struct trace_iterator, seq);
1945 * Keep gcc from complaining about overwriting more than just one
1946 * member in the structure.
1948 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1953 /* Check the name is good for event/group/fields */
1954 static inline bool __is_good_name(const char *name, bool hash_ok)
1956 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-'))
1958 while (*++name != '\0') {
1959 if (!isalpha(*name) && !isdigit(*name) && *name != '_' &&
1960 (!hash_ok || *name != '-'))
1966 /* Check the name is good for event/group/fields */
1967 static inline bool is_good_name(const char *name)
1969 return __is_good_name(name, false);
1972 /* Check the name is good for system */
1973 static inline bool is_good_system_name(const char *name)
1975 return __is_good_name(name, true);
1978 /* Convert certain expected symbols into '_' when generating event names */
1979 static inline void sanitize_event_name(char *name)
1981 while (*name++ != '\0')
1982 if (*name == ':' || *name == '.')
1987 * This is a generic way to read and write a u64 value from a file in tracefs.
1989 * The value is stored on the variable pointed by *val. The value needs
1990 * to be at least *min and at most *max. The write is protected by an
1993 struct trace_min_max_param {
2000 #define U64_STR_SIZE 24 /* 20 digits max */
2002 extern const struct file_operations trace_min_max_fops;
2004 #endif /* _LINUX_KERNEL_TRACE_H */