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__)
117 * syscalls are special, and need special handling, this is why
118 * they are not included in trace_entries.h
120 struct syscall_trace_enter {
121 struct trace_entry ent;
123 unsigned long args[];
126 struct syscall_trace_exit {
127 struct trace_entry ent;
132 struct kprobe_trace_entry_head {
133 struct trace_entry ent;
137 struct eprobe_trace_entry_head {
138 struct trace_entry ent;
141 struct kretprobe_trace_entry_head {
142 struct trace_entry ent;
144 unsigned long ret_ip;
147 #define TRACE_BUF_SIZE 1024
152 * The CPU trace array - it consists of thousands of trace entries
153 * plus some other descriptor data: (for example which task started
156 struct trace_array_cpu {
158 void *buffer_page; /* ring buffer spare */
160 unsigned long entries;
161 unsigned long saved_latency;
162 unsigned long critical_start;
163 unsigned long critical_end;
164 unsigned long critical_sequence;
166 unsigned long policy;
167 unsigned long rt_priority;
168 unsigned long skipped_entries;
169 u64 preempt_timestamp;
172 char comm[TASK_COMM_LEN];
174 #ifdef CONFIG_FUNCTION_TRACER
175 int ftrace_ignore_pid;
181 struct trace_option_dentry;
183 struct array_buffer {
184 struct trace_array *tr;
185 struct trace_buffer *buffer;
186 struct trace_array_cpu __percpu *data;
191 #define TRACE_FLAGS_MAX_SIZE 32
193 struct trace_options {
194 struct tracer *tracer;
195 struct trace_option_dentry *topts;
198 struct trace_pid_list *trace_pid_list_alloc(void);
199 void trace_pid_list_free(struct trace_pid_list *pid_list);
200 bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid);
201 int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid);
202 int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid);
203 int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid);
204 int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid,
209 TRACE_NO_PIDS = BIT(1),
212 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
213 struct trace_pid_list *no_pid_list)
215 /* Return true if the pid list in type has pids */
216 return ((type & TRACE_PIDS) && pid_list) ||
217 ((type & TRACE_NO_PIDS) && no_pid_list);
220 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
221 struct trace_pid_list *no_pid_list)
224 * Turning off what is in @type, return true if the "other"
225 * pid list, still has pids in it.
227 return (!(type & TRACE_PIDS) && pid_list) ||
228 (!(type & TRACE_NO_PIDS) && no_pid_list);
231 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
234 * struct cond_snapshot - conditional snapshot data and callback
236 * The cond_snapshot structure encapsulates a callback function and
237 * data associated with the snapshot for a given tracing instance.
239 * When a snapshot is taken conditionally, by invoking
240 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
241 * passed in turn to the cond_snapshot.update() function. That data
242 * can be compared by the update() implementation with the cond_data
243 * contained within the struct cond_snapshot instance associated with
244 * the trace_array. Because the tr->max_lock is held throughout the
245 * update() call, the update() function can directly retrieve the
246 * cond_snapshot and cond_data associated with the per-instance
247 * snapshot associated with the trace_array.
249 * The cond_snapshot.update() implementation can save data to be
250 * associated with the snapshot if it decides to, and returns 'true'
251 * in that case, or it returns 'false' if the conditional snapshot
252 * shouldn't be taken.
254 * The cond_snapshot instance is created and associated with the
255 * user-defined cond_data by tracing_cond_snapshot_enable().
256 * Likewise, the cond_snapshot instance is destroyed and is no longer
257 * associated with the trace instance by
258 * tracing_cond_snapshot_disable().
260 * The method below is required.
262 * @update: When a conditional snapshot is invoked, the update()
263 * callback function is invoked with the tr->max_lock held. The
264 * update() implementation signals whether or not to actually
265 * take the snapshot, by returning 'true' if so, 'false' if no
266 * snapshot should be taken. Because the max_lock is held for
267 * the duration of update(), the implementation is safe to
268 * directly retrieved and save any implementation data it needs
269 * to in association with the snapshot.
271 struct cond_snapshot {
273 cond_update_fn_t update;
277 * struct trace_func_repeats - used to keep track of the consecutive
278 * (on the same CPU) calls of a single function.
280 struct trace_func_repeats {
282 unsigned long parent_ip;
288 * The trace array - an array of per-CPU trace arrays. This is the
289 * highest level data structure that individual tracers deal with.
290 * They have on/off state as well:
293 struct list_head list;
295 struct array_buffer array_buffer;
296 #ifdef CONFIG_TRACER_MAX_TRACE
298 * The max_buffer is used to snapshot the trace when a maximum
299 * latency is reached, or when the user initiates a snapshot.
300 * Some tracers will use this to store a maximum trace while
301 * it continues examining live traces.
303 * The buffers for the max_buffer are set up the same as the array_buffer
304 * When a snapshot is taken, the buffer of the max_buffer is swapped
305 * with the buffer of the array_buffer and the buffers are reset for
306 * the array_buffer so the tracing can continue.
308 struct array_buffer max_buffer;
309 bool allocated_snapshot;
311 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER) \
312 || defined(CONFIG_OSNOISE_TRACER)
313 unsigned long max_latency;
314 #ifdef CONFIG_FSNOTIFY
315 struct dentry *d_max_latency;
316 struct work_struct fsnotify_work;
317 struct irq_work fsnotify_irqwork;
320 struct trace_pid_list __rcu *filtered_pids;
321 struct trace_pid_list __rcu *filtered_no_pids;
323 * max_lock is used to protect the swapping of buffers
324 * when taking a max snapshot. The buffers themselves are
325 * protected by per_cpu spinlocks. But the action of the swap
326 * needs its own lock.
328 * This is defined as a arch_spinlock_t in order to help
329 * with performance when lockdep debugging is enabled.
331 * It is also used in other places outside the update_max_tr
332 * so it needs to be defined outside of the
333 * CONFIG_TRACER_MAX_TRACE.
335 arch_spinlock_t max_lock;
337 #ifdef CONFIG_FTRACE_SYSCALLS
338 int sys_refcount_enter;
339 int sys_refcount_exit;
340 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
341 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
348 unsigned int n_err_log_entries;
349 struct tracer *current_trace;
350 unsigned int trace_flags;
351 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
353 raw_spinlock_t start_lock;
354 struct list_head err_log;
356 struct dentry *options;
357 struct dentry *percpu_dir;
358 struct dentry *event_dir;
359 struct trace_options *topts;
360 struct list_head systems;
361 struct list_head events;
362 struct trace_event_file *trace_marker_file;
363 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
366 #ifdef CONFIG_FUNCTION_TRACER
367 struct ftrace_ops *ops;
368 struct trace_pid_list __rcu *function_pids;
369 struct trace_pid_list __rcu *function_no_pids;
370 #ifdef CONFIG_DYNAMIC_FTRACE
371 /* All of these are protected by the ftrace_lock */
372 struct list_head func_probes;
373 struct list_head mod_trace;
374 struct list_head mod_notrace;
376 /* function tracing enabled */
377 int function_enabled;
379 int no_filter_buffering_ref;
380 struct list_head hist_vars;
381 #ifdef CONFIG_TRACER_SNAPSHOT
382 struct cond_snapshot *cond_snapshot;
384 struct trace_func_repeats __percpu *last_func_repeats;
388 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
391 extern struct list_head ftrace_trace_arrays;
393 extern struct mutex trace_types_lock;
395 extern int trace_array_get(struct trace_array *tr);
396 extern int tracing_check_open_get_tr(struct trace_array *tr);
397 extern struct trace_array *trace_array_find(const char *instance);
398 extern struct trace_array *trace_array_find_get(const char *instance);
400 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
401 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
402 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
404 extern bool trace_clock_in_ns(struct trace_array *tr);
407 * The global tracer (top) should be the first trace array added,
408 * but we check the flag anyway.
410 static inline struct trace_array *top_trace_array(void)
412 struct trace_array *tr;
414 if (list_empty(&ftrace_trace_arrays))
417 tr = list_entry(ftrace_trace_arrays.prev,
419 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
423 #define FTRACE_CMP_TYPE(var, type) \
424 __builtin_types_compatible_p(typeof(var), type *)
427 #define IF_ASSIGN(var, entry, etype, id) \
428 if (FTRACE_CMP_TYPE(var, etype)) { \
429 var = (typeof(var))(entry); \
430 WARN_ON(id != 0 && (entry)->type != id); \
434 /* Will cause compile errors if type is not found. */
435 extern void __ftrace_bad_type(void);
438 * The trace_assign_type is a verifier that the entry type is
439 * the same as the type being assigned. To add new types simply
440 * add a line with the following format:
442 * IF_ASSIGN(var, ent, type, id);
444 * Where "type" is the trace type that includes the trace_entry
445 * as the "ent" item. And "id" is the trace identifier that is
446 * used in the trace_type enum.
448 * If the type can have more than one id, then use zero.
450 #define trace_assign_type(var, ent) \
452 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
453 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
454 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
455 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
456 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
457 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
458 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
459 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
460 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
461 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
462 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
463 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
465 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
467 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
468 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
470 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
472 IF_ASSIGN(var, ent, struct func_repeats_entry, \
473 TRACE_FUNC_REPEATS); \
474 __ftrace_bad_type(); \
478 * An option specific to a tracer. This is a boolean value.
479 * The bit is the bit index that sets its value on the
480 * flags value in struct tracer_flags.
483 const char *name; /* Will appear on the trace_options file */
484 u32 bit; /* Mask assigned in val field in tracer_flags */
488 * The set of specific options for a tracer. Your tracer
489 * have to set the initial value of the flags val.
491 struct tracer_flags {
493 struct tracer_opt *opts;
494 struct tracer *trace;
497 /* Makes more easy to define a tracer opt */
498 #define TRACER_OPT(s, b) .name = #s, .bit = b
501 struct trace_option_dentry {
502 struct tracer_opt *opt;
503 struct tracer_flags *flags;
504 struct trace_array *tr;
505 struct dentry *entry;
509 * struct tracer - a specific tracer and its callbacks to interact with tracefs
510 * @name: the name chosen to select it on the available_tracers file
511 * @init: called when one switches to this tracer (echo name > current_tracer)
512 * @reset: called when one switches to another tracer
513 * @start: called when tracing is unpaused (echo 1 > tracing_on)
514 * @stop: called when tracing is paused (echo 0 > tracing_on)
515 * @update_thresh: called when tracing_thresh is updated
516 * @open: called when the trace file is opened
517 * @pipe_open: called when the trace_pipe file is opened
518 * @close: called when the trace file is released
519 * @pipe_close: called when the trace_pipe file is released
520 * @read: override the default read callback on trace_pipe
521 * @splice_read: override the default splice_read callback on trace_pipe
522 * @selftest: selftest to run on boot (see trace_selftest.c)
523 * @print_headers: override the first lines that describe your columns
524 * @print_line: callback that prints a trace
525 * @set_flag: signals one of your private flags changed (trace_options file)
526 * @flags: your private flags
530 int (*init)(struct trace_array *tr);
531 void (*reset)(struct trace_array *tr);
532 void (*start)(struct trace_array *tr);
533 void (*stop)(struct trace_array *tr);
534 int (*update_thresh)(struct trace_array *tr);
535 void (*open)(struct trace_iterator *iter);
536 void (*pipe_open)(struct trace_iterator *iter);
537 void (*close)(struct trace_iterator *iter);
538 void (*pipe_close)(struct trace_iterator *iter);
539 ssize_t (*read)(struct trace_iterator *iter,
540 struct file *filp, char __user *ubuf,
541 size_t cnt, loff_t *ppos);
542 ssize_t (*splice_read)(struct trace_iterator *iter,
545 struct pipe_inode_info *pipe,
548 #ifdef CONFIG_FTRACE_STARTUP_TEST
549 int (*selftest)(struct tracer *trace,
550 struct trace_array *tr);
552 void (*print_header)(struct seq_file *m);
553 enum print_line_t (*print_line)(struct trace_iterator *iter);
554 /* If you handled the flag setting, return 0 */
555 int (*set_flag)(struct trace_array *tr,
556 u32 old_flags, u32 bit, int set);
557 /* Return 0 if OK with change, else return non-zero */
558 int (*flag_changed)(struct trace_array *tr,
561 struct tracer_flags *flags;
564 bool allow_instances;
565 #ifdef CONFIG_TRACER_MAX_TRACE
568 /* True if tracer cannot be enabled in kernel param */
572 static inline struct ring_buffer_iter *
573 trace_buffer_iter(struct trace_iterator *iter, int cpu)
575 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
578 int tracer_init(struct tracer *t, struct trace_array *tr);
579 int tracing_is_enabled(void);
580 void tracing_reset_online_cpus(struct array_buffer *buf);
581 void tracing_reset_current(int cpu);
582 void tracing_reset_all_online_cpus(void);
583 void tracing_reset_all_online_cpus_unlocked(void);
584 int tracing_open_generic(struct inode *inode, struct file *filp);
585 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
586 bool tracing_is_disabled(void);
587 bool tracer_tracing_is_on(struct trace_array *tr);
588 void tracer_tracing_on(struct trace_array *tr);
589 void tracer_tracing_off(struct trace_array *tr);
590 struct dentry *trace_create_file(const char *name,
592 struct dentry *parent,
594 const struct file_operations *fops);
596 int tracing_init_dentry(void);
598 struct ring_buffer_event;
600 struct ring_buffer_event *
601 trace_buffer_lock_reserve(struct trace_buffer *buffer,
604 unsigned int trace_ctx);
606 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
607 struct trace_array_cpu *data);
609 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
610 int *ent_cpu, u64 *ent_ts);
612 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
613 struct ring_buffer_event *event);
615 bool trace_is_tracepoint_string(const char *str);
616 const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
617 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
620 int trace_empty(struct trace_iterator *iter);
622 void *trace_find_next_entry_inc(struct trace_iterator *iter);
624 void trace_init_global_iter(struct trace_iterator *iter);
626 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
628 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
629 unsigned long trace_total_entries(struct trace_array *tr);
631 void trace_function(struct trace_array *tr,
633 unsigned long parent_ip,
634 unsigned int trace_ctx);
635 void trace_graph_function(struct trace_array *tr,
637 unsigned long parent_ip,
638 unsigned int trace_ctx);
639 void trace_latency_header(struct seq_file *m);
640 void trace_default_header(struct seq_file *m);
641 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
643 void trace_graph_return(struct ftrace_graph_ret *trace);
644 int trace_graph_entry(struct ftrace_graph_ent *trace);
645 void set_graph_array(struct trace_array *tr);
647 void tracing_start_cmdline_record(void);
648 void tracing_stop_cmdline_record(void);
649 void tracing_start_tgid_record(void);
650 void tracing_stop_tgid_record(void);
652 int register_tracer(struct tracer *type);
653 int is_tracing_stopped(void);
655 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
657 extern cpumask_var_t __read_mostly tracing_buffer_mask;
659 #define for_each_tracing_cpu(cpu) \
660 for_each_cpu(cpu, tracing_buffer_mask)
662 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
664 extern unsigned long tracing_thresh;
670 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
672 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
673 struct trace_pid_list *filtered_no_pids,
674 struct task_struct *task);
675 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
676 struct task_struct *self,
677 struct task_struct *task);
678 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
679 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
680 int trace_pid_show(struct seq_file *m, void *v);
681 void trace_free_pid_list(struct trace_pid_list *pid_list);
682 int trace_pid_write(struct trace_pid_list *filtered_pids,
683 struct trace_pid_list **new_pid_list,
684 const char __user *ubuf, size_t cnt);
686 #ifdef CONFIG_TRACER_MAX_TRACE
687 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
689 void update_max_tr_single(struct trace_array *tr,
690 struct task_struct *tsk, int cpu);
691 #endif /* CONFIG_TRACER_MAX_TRACE */
693 #if (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER) \
694 || defined(CONFIG_OSNOISE_TRACER)) && defined(CONFIG_FSNOTIFY)
695 #define LATENCY_FS_NOTIFY
698 #ifdef LATENCY_FS_NOTIFY
699 void latency_fsnotify(struct trace_array *tr);
701 static inline void latency_fsnotify(struct trace_array *tr) { }
704 #ifdef CONFIG_STACKTRACE
705 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
707 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
711 #endif /* CONFIG_STACKTRACE */
713 void trace_last_func_repeats(struct trace_array *tr,
714 struct trace_func_repeats *last_info,
715 unsigned int trace_ctx);
717 extern u64 ftrace_now(int cpu);
719 extern void trace_find_cmdline(int pid, char comm[]);
720 extern int trace_find_tgid(int pid);
721 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
723 #ifdef CONFIG_DYNAMIC_FTRACE
724 extern unsigned long ftrace_update_tot_cnt;
725 extern unsigned long ftrace_number_of_pages;
726 extern unsigned long ftrace_number_of_groups;
727 void ftrace_init_trace_array(struct trace_array *tr);
729 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
731 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
732 extern int DYN_FTRACE_TEST_NAME(void);
733 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
734 extern int DYN_FTRACE_TEST_NAME2(void);
736 extern bool ring_buffer_expanded;
737 extern bool tracing_selftest_disabled;
739 #ifdef CONFIG_FTRACE_STARTUP_TEST
740 extern void __init disable_tracing_selftest(const char *reason);
742 extern int trace_selftest_startup_function(struct tracer *trace,
743 struct trace_array *tr);
744 extern int trace_selftest_startup_function_graph(struct tracer *trace,
745 struct trace_array *tr);
746 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
747 struct trace_array *tr);
748 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
749 struct trace_array *tr);
750 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
751 struct trace_array *tr);
752 extern int trace_selftest_startup_wakeup(struct tracer *trace,
753 struct trace_array *tr);
754 extern int trace_selftest_startup_nop(struct tracer *trace,
755 struct trace_array *tr);
756 extern int trace_selftest_startup_branch(struct tracer *trace,
757 struct trace_array *tr);
759 * Tracer data references selftest functions that only occur
760 * on boot up. These can be __init functions. Thus, when selftests
761 * are enabled, then the tracers need to reference __init functions.
763 #define __tracer_data __refdata
765 static inline void __init disable_tracing_selftest(const char *reason)
768 /* Tracers are seldom changed. Optimize when selftests are disabled. */
769 #define __tracer_data __read_mostly
770 #endif /* CONFIG_FTRACE_STARTUP_TEST */
772 extern void *head_page(struct trace_array_cpu *data);
773 extern unsigned long long ns2usecs(u64 nsec);
775 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
777 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
779 trace_array_vprintk(struct trace_array *tr,
780 unsigned long ip, const char *fmt, va_list args);
781 int trace_array_printk_buf(struct trace_buffer *buffer,
782 unsigned long ip, const char *fmt, ...);
783 void trace_printk_seq(struct trace_seq *s);
784 enum print_line_t print_trace_line(struct trace_iterator *iter);
786 extern char trace_find_mark(unsigned long long duration);
790 struct ftrace_mod_load {
791 struct list_head list;
798 FTRACE_HASH_FL_MOD = (1 << 0),
802 unsigned long size_bits;
803 struct hlist_head *buckets;
809 struct ftrace_func_entry *
810 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
812 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
814 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
817 /* Standard output formatting function used for function return traces */
818 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
821 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
822 #define TRACE_GRAPH_PRINT_CPU 0x2
823 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
824 #define TRACE_GRAPH_PRINT_PROC 0x8
825 #define TRACE_GRAPH_PRINT_DURATION 0x10
826 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
827 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
828 #define TRACE_GRAPH_PRINT_IRQS 0x80
829 #define TRACE_GRAPH_PRINT_TAIL 0x100
830 #define TRACE_GRAPH_SLEEP_TIME 0x200
831 #define TRACE_GRAPH_GRAPH_TIME 0x400
832 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
833 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
835 extern void ftrace_graph_sleep_time_control(bool enable);
837 #ifdef CONFIG_FUNCTION_PROFILER
838 extern void ftrace_graph_graph_time_control(bool enable);
840 static inline void ftrace_graph_graph_time_control(bool enable) { }
843 extern enum print_line_t
844 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
845 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
847 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
848 extern void graph_trace_open(struct trace_iterator *iter);
849 extern void graph_trace_close(struct trace_iterator *iter);
850 extern int __trace_graph_entry(struct trace_array *tr,
851 struct ftrace_graph_ent *trace,
852 unsigned int trace_ctx);
853 extern void __trace_graph_return(struct trace_array *tr,
854 struct ftrace_graph_ret *trace,
855 unsigned int trace_ctx);
857 #ifdef CONFIG_DYNAMIC_FTRACE
858 extern struct ftrace_hash __rcu *ftrace_graph_hash;
859 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
861 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
863 unsigned long addr = trace->func;
865 struct ftrace_hash *hash;
867 preempt_disable_notrace();
870 * Have to open code "rcu_dereference_sched()" because the
871 * function graph tracer can be called when RCU is not
873 * Protected with schedule_on_each_cpu(ftrace_sync)
875 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
877 if (ftrace_hash_empty(hash)) {
882 if (ftrace_lookup_ip(hash, addr)) {
885 * This needs to be cleared on the return functions
886 * when the depth is zero.
888 trace_recursion_set(TRACE_GRAPH_BIT);
889 trace_recursion_set_depth(trace->depth);
892 * If no irqs are to be traced, but a set_graph_function
893 * is set, and called by an interrupt handler, we still
897 trace_recursion_set(TRACE_IRQ_BIT);
899 trace_recursion_clear(TRACE_IRQ_BIT);
904 preempt_enable_notrace();
908 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
910 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
911 trace->depth == trace_recursion_depth())
912 trace_recursion_clear(TRACE_GRAPH_BIT);
915 static inline int ftrace_graph_notrace_addr(unsigned long addr)
918 struct ftrace_hash *notrace_hash;
920 preempt_disable_notrace();
923 * Have to open code "rcu_dereference_sched()" because the
924 * function graph tracer can be called when RCU is not
926 * Protected with schedule_on_each_cpu(ftrace_sync)
928 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
931 if (ftrace_lookup_ip(notrace_hash, addr))
934 preempt_enable_notrace();
938 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
943 static inline int ftrace_graph_notrace_addr(unsigned long addr)
947 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
949 #endif /* CONFIG_DYNAMIC_FTRACE */
951 extern unsigned int fgraph_max_depth;
953 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
955 /* trace it when it is-nested-in or is a function enabled. */
956 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
957 ftrace_graph_addr(trace)) ||
958 (trace->depth < 0) ||
959 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
962 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
963 static inline enum print_line_t
964 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
966 return TRACE_TYPE_UNHANDLED;
968 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
970 extern struct list_head ftrace_pids;
972 #ifdef CONFIG_FUNCTION_TRACER
974 #define FTRACE_PID_IGNORE -1
975 #define FTRACE_PID_TRACE -2
977 struct ftrace_func_command {
978 struct list_head list;
980 int (*func)(struct trace_array *tr,
981 struct ftrace_hash *hash,
982 char *func, char *cmd,
983 char *params, int enable);
985 extern bool ftrace_filter_param __initdata;
986 static inline int ftrace_trace_task(struct trace_array *tr)
988 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
991 extern int ftrace_is_dead(void);
992 int ftrace_create_function_files(struct trace_array *tr,
993 struct dentry *parent);
994 void ftrace_destroy_function_files(struct trace_array *tr);
995 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
996 void ftrace_free_ftrace_ops(struct trace_array *tr);
997 void ftrace_init_global_array_ops(struct trace_array *tr);
998 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
999 void ftrace_reset_array_ops(struct trace_array *tr);
1000 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1001 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1002 struct dentry *d_tracer);
1003 void ftrace_clear_pids(struct trace_array *tr);
1004 int init_function_trace(void);
1005 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1007 static inline int ftrace_trace_task(struct trace_array *tr)
1011 static inline int ftrace_is_dead(void) { return 0; }
1013 ftrace_create_function_files(struct trace_array *tr,
1014 struct dentry *parent)
1018 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1022 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1023 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1024 static inline __init void
1025 ftrace_init_global_array_ops(struct trace_array *tr) { }
1026 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1027 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1028 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1029 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1030 static inline int init_function_trace(void) { return 0; }
1031 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1032 /* ftace_func_t type is not defined, use macro instead of static inline */
1033 #define ftrace_init_array_ops(tr, func) do { } while (0)
1034 #endif /* CONFIG_FUNCTION_TRACER */
1036 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1038 struct ftrace_probe_ops {
1039 void (*func)(unsigned long ip,
1040 unsigned long parent_ip,
1041 struct trace_array *tr,
1042 struct ftrace_probe_ops *ops,
1044 int (*init)(struct ftrace_probe_ops *ops,
1045 struct trace_array *tr,
1046 unsigned long ip, void *init_data,
1048 void (*free)(struct ftrace_probe_ops *ops,
1049 struct trace_array *tr,
1050 unsigned long ip, void *data);
1051 int (*print)(struct seq_file *m,
1053 struct ftrace_probe_ops *ops,
1057 struct ftrace_func_mapper;
1058 typedef int (*ftrace_mapper_func)(void *data);
1060 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1061 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1063 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1064 unsigned long ip, void *data);
1065 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1067 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1068 ftrace_mapper_func free_func);
1071 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1072 struct ftrace_probe_ops *ops, void *data);
1074 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1075 struct ftrace_probe_ops *ops);
1076 extern void clear_ftrace_function_probes(struct trace_array *tr);
1078 int register_ftrace_command(struct ftrace_func_command *cmd);
1079 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1081 void ftrace_create_filter_files(struct ftrace_ops *ops,
1082 struct dentry *parent);
1083 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1085 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1086 int len, int reset);
1087 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1088 int len, int reset);
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"), \
1214 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1215 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1222 * By defining C, we can make TRACE_FLAGS a list of bit names
1223 * that will define the bits for the flag masks.
1226 #define C(a, b) TRACE_ITER_##a##_BIT
1228 enum trace_iterator_bits {
1230 /* Make sure we don't go more than we have bits for */
1235 * By redefining C, we can make TRACE_FLAGS a list of masks that
1236 * use the bits as defined above.
1239 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1241 enum trace_iterator_flags { TRACE_FLAGS };
1244 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1245 * control the output of kernel symbols.
1247 #define TRACE_ITER_SYM_MASK \
1248 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1250 extern struct tracer nop_trace;
1252 #ifdef CONFIG_BRANCH_TRACER
1253 extern int enable_branch_tracing(struct trace_array *tr);
1254 extern void disable_branch_tracing(void);
1255 static inline int trace_branch_enable(struct trace_array *tr)
1257 if (tr->trace_flags & TRACE_ITER_BRANCH)
1258 return enable_branch_tracing(tr);
1261 static inline void trace_branch_disable(void)
1263 /* due to races, always disable */
1264 disable_branch_tracing();
1267 static inline int trace_branch_enable(struct trace_array *tr)
1271 static inline void trace_branch_disable(void)
1274 #endif /* CONFIG_BRANCH_TRACER */
1276 /* set ring buffers to default size if not already done so */
1277 int tracing_update_buffers(void);
1279 struct ftrace_event_field {
1280 struct list_head link;
1291 struct event_filter {
1292 struct prog_entry __rcu *prog;
1293 char *filter_string;
1296 struct event_subsystem {
1297 struct list_head list;
1299 struct event_filter *filter;
1303 struct trace_subsystem_dir {
1304 struct list_head list;
1305 struct event_subsystem *subsystem;
1306 struct trace_array *tr;
1307 struct dentry *entry;
1312 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1313 struct trace_buffer *buffer,
1314 struct ring_buffer_event *event);
1316 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1317 struct trace_buffer *buffer,
1318 struct ring_buffer_event *event,
1319 unsigned int trcace_ctx,
1320 struct pt_regs *regs);
1322 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1323 struct trace_buffer *buffer,
1324 struct ring_buffer_event *event,
1325 unsigned int trace_ctx)
1327 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1330 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1331 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1332 void trace_buffered_event_disable(void);
1333 void trace_buffered_event_enable(void);
1336 __trace_event_discard_commit(struct trace_buffer *buffer,
1337 struct ring_buffer_event *event)
1339 if (this_cpu_read(trace_buffered_event) == event) {
1340 /* Simply release the temp buffer and enable preemption */
1341 this_cpu_dec(trace_buffered_event_cnt);
1342 preempt_enable_notrace();
1345 /* ring_buffer_discard_commit() enables preemption */
1346 ring_buffer_discard_commit(buffer, event);
1350 * Helper function for event_trigger_unlock_commit{_regs}().
1351 * If there are event triggers attached to this event that requires
1352 * filtering against its fields, then they will be called as the
1353 * entry already holds the field information of the current event.
1355 * It also checks if the event should be discarded or not.
1356 * It is to be discarded if the event is soft disabled and the
1357 * event was only recorded to process triggers, or if the event
1358 * filter is active and this event did not match the filters.
1360 * Returns true if the event is discarded, false otherwise.
1363 __event_trigger_test_discard(struct trace_event_file *file,
1364 struct trace_buffer *buffer,
1365 struct ring_buffer_event *event,
1367 enum event_trigger_type *tt)
1369 unsigned long eflags = file->flags;
1371 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1372 *tt = event_triggers_call(file, buffer, entry, event);
1374 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1375 EVENT_FILE_FL_FILTERED |
1376 EVENT_FILE_FL_PID_FILTER))))
1379 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1382 if (file->flags & EVENT_FILE_FL_FILTERED &&
1383 !filter_match_preds(file->filter, entry))
1386 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1387 trace_event_ignore_this_pid(file))
1392 __trace_event_discard_commit(buffer, event);
1397 * event_trigger_unlock_commit - handle triggers and finish event commit
1398 * @file: The file pointer associated with the event
1399 * @buffer: The ring buffer that the event is being written to
1400 * @event: The event meta data in the ring buffer
1401 * @entry: The event itself
1402 * @trace_ctx: The tracing context flags.
1404 * This is a helper function to handle triggers that require data
1405 * from the event itself. It also tests the event against filters and
1406 * if the event is soft disabled and should be discarded.
1409 event_trigger_unlock_commit(struct trace_event_file *file,
1410 struct trace_buffer *buffer,
1411 struct ring_buffer_event *event,
1412 void *entry, unsigned int trace_ctx)
1414 enum event_trigger_type tt = ETT_NONE;
1416 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1417 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1420 event_triggers_post_call(file, tt);
1423 #define FILTER_PRED_INVALID ((unsigned short)-1)
1424 #define FILTER_PRED_IS_RIGHT (1 << 15)
1425 #define FILTER_PRED_FOLD (1 << 15)
1428 * The max preds is the size of unsigned short with
1429 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1430 * and FOLD flags. The other is reserved.
1432 * 2^14 preds is way more than enough.
1434 #define MAX_FILTER_PRED 16384
1439 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1451 char pattern[MAX_FILTER_STR_VAL];
1454 regex_match_func match;
1457 static inline bool is_string_field(struct ftrace_event_field *field)
1459 return field->filter_type == FILTER_DYN_STRING ||
1460 field->filter_type == FILTER_RDYN_STRING ||
1461 field->filter_type == FILTER_STATIC_STRING ||
1462 field->filter_type == FILTER_PTR_STRING ||
1463 field->filter_type == FILTER_COMM;
1466 static inline bool is_function_field(struct ftrace_event_field *field)
1468 return field->filter_type == FILTER_TRACE_FN;
1471 extern enum regex_type
1472 filter_parse_regex(char *buff, int len, char **search, int *not);
1473 extern void print_event_filter(struct trace_event_file *file,
1474 struct trace_seq *s);
1475 extern int apply_event_filter(struct trace_event_file *file,
1476 char *filter_string);
1477 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1478 char *filter_string);
1479 extern void print_subsystem_event_filter(struct event_subsystem *system,
1480 struct trace_seq *s);
1481 extern int filter_assign_type(const char *type);
1482 extern int create_event_filter(struct trace_array *tr,
1483 struct trace_event_call *call,
1484 char *filter_str, bool set_str,
1485 struct event_filter **filterp);
1486 extern void free_event_filter(struct event_filter *filter);
1488 struct ftrace_event_field *
1489 trace_find_event_field(struct trace_event_call *call, char *name);
1491 extern void trace_event_enable_cmd_record(bool enable);
1492 extern void trace_event_enable_tgid_record(bool enable);
1494 extern int event_trace_init(void);
1495 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1496 extern int event_trace_del_tracer(struct trace_array *tr);
1497 extern void __trace_early_add_events(struct trace_array *tr);
1499 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1502 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1506 static inline void *event_file_data(struct file *filp)
1508 return READ_ONCE(file_inode(filp)->i_private);
1511 extern struct mutex event_mutex;
1512 extern struct list_head ftrace_events;
1514 extern const struct file_operations event_trigger_fops;
1515 extern const struct file_operations event_hist_fops;
1516 extern const struct file_operations event_hist_debug_fops;
1517 extern const struct file_operations event_inject_fops;
1519 #ifdef CONFIG_HIST_TRIGGERS
1520 extern int register_trigger_hist_cmd(void);
1521 extern int register_trigger_hist_enable_disable_cmds(void);
1523 static inline int register_trigger_hist_cmd(void) { return 0; }
1524 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1527 extern int register_trigger_cmds(void);
1528 extern void clear_event_triggers(struct trace_array *tr);
1531 EVENT_TRIGGER_FL_PROBE = BIT(0),
1534 struct event_trigger_data {
1535 unsigned long count;
1538 struct event_trigger_ops *ops;
1539 struct event_command *cmd_ops;
1540 struct event_filter __rcu *filter;
1545 struct list_head list;
1547 struct list_head named_list;
1548 struct event_trigger_data *named_data;
1552 #define ENABLE_EVENT_STR "enable_event"
1553 #define DISABLE_EVENT_STR "disable_event"
1554 #define ENABLE_HIST_STR "enable_hist"
1555 #define DISABLE_HIST_STR "disable_hist"
1557 struct enable_trigger_data {
1558 struct trace_event_file *file;
1563 extern int event_enable_trigger_print(struct seq_file *m,
1564 struct event_trigger_data *data);
1565 extern void event_enable_trigger_free(struct event_trigger_data *data);
1566 extern int event_enable_trigger_parse(struct event_command *cmd_ops,
1567 struct trace_event_file *file,
1568 char *glob, char *cmd,
1569 char *param_and_filter);
1570 extern int event_enable_register_trigger(char *glob,
1571 struct event_trigger_data *data,
1572 struct trace_event_file *file);
1573 extern void event_enable_unregister_trigger(char *glob,
1574 struct event_trigger_data *test,
1575 struct trace_event_file *file);
1576 extern void trigger_data_free(struct event_trigger_data *data);
1577 extern int event_trigger_init(struct event_trigger_data *data);
1578 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1579 int trigger_enable);
1580 extern void update_cond_flag(struct trace_event_file *file);
1581 extern int set_trigger_filter(char *filter_str,
1582 struct event_trigger_data *trigger_data,
1583 struct trace_event_file *file);
1584 extern struct event_trigger_data *find_named_trigger(const char *name);
1585 extern bool is_named_trigger(struct event_trigger_data *test);
1586 extern int save_named_trigger(const char *name,
1587 struct event_trigger_data *data);
1588 extern void del_named_trigger(struct event_trigger_data *data);
1589 extern void pause_named_trigger(struct event_trigger_data *data);
1590 extern void unpause_named_trigger(struct event_trigger_data *data);
1591 extern void set_named_trigger_data(struct event_trigger_data *data,
1592 struct event_trigger_data *named_data);
1593 extern struct event_trigger_data *
1594 get_named_trigger_data(struct event_trigger_data *data);
1595 extern int register_event_command(struct event_command *cmd);
1596 extern int unregister_event_command(struct event_command *cmd);
1597 extern int register_trigger_hist_enable_disable_cmds(void);
1598 extern bool event_trigger_check_remove(const char *glob);
1599 extern bool event_trigger_empty_param(const char *param);
1600 extern int event_trigger_separate_filter(char *param_and_filter, char **param,
1601 char **filter, bool param_required);
1602 extern struct event_trigger_data *
1603 event_trigger_alloc(struct event_command *cmd_ops,
1606 void *private_data);
1607 extern int event_trigger_parse_num(char *trigger,
1608 struct event_trigger_data *trigger_data);
1609 extern int event_trigger_set_filter(struct event_command *cmd_ops,
1610 struct trace_event_file *file,
1612 struct event_trigger_data *trigger_data);
1613 extern void event_trigger_reset_filter(struct event_command *cmd_ops,
1614 struct event_trigger_data *trigger_data);
1615 extern int event_trigger_register(struct event_command *cmd_ops,
1616 struct trace_event_file *file,
1618 struct event_trigger_data *trigger_data);
1619 extern void event_trigger_unregister(struct event_command *cmd_ops,
1620 struct trace_event_file *file,
1622 struct event_trigger_data *trigger_data);
1625 * struct event_trigger_ops - callbacks for trace event triggers
1627 * The methods in this structure provide per-event trigger hooks for
1628 * various trigger operations.
1630 * The @init and @free methods are used during trigger setup and
1631 * teardown, typically called from an event_command's @parse()
1632 * function implementation.
1634 * The @print method is used to print the trigger spec.
1636 * The @trigger method is the function that actually implements the
1637 * trigger and is called in the context of the triggering event
1638 * whenever that event occurs.
1640 * All the methods below, except for @init() and @free(), must be
1643 * @trigger: The trigger 'probe' function called when the triggering
1644 * event occurs. The data passed into this callback is the data
1645 * that was supplied to the event_command @reg() function that
1646 * registered the trigger (see struct event_command) along with
1647 * the trace record, rec.
1649 * @init: An optional initialization function called for the trigger
1650 * when the trigger is registered (via the event_command reg()
1651 * function). This can be used to perform per-trigger
1652 * initialization such as incrementing a per-trigger reference
1653 * count, for instance. This is usually implemented by the
1654 * generic utility function @event_trigger_init() (see
1655 * trace_event_triggers.c).
1657 * @free: An optional de-initialization function called for the
1658 * trigger when the trigger is unregistered (via the
1659 * event_command @reg() function). This can be used to perform
1660 * per-trigger de-initialization such as decrementing a
1661 * per-trigger reference count and freeing corresponding trigger
1662 * data, for instance. This is usually implemented by the
1663 * generic utility function @event_trigger_free() (see
1664 * trace_event_triggers.c).
1666 * @print: The callback function invoked to have the trigger print
1667 * itself. This is usually implemented by a wrapper function
1668 * that calls the generic utility function @event_trigger_print()
1669 * (see trace_event_triggers.c).
1671 struct event_trigger_ops {
1672 void (*trigger)(struct event_trigger_data *data,
1673 struct trace_buffer *buffer,
1675 struct ring_buffer_event *rbe);
1676 int (*init)(struct event_trigger_data *data);
1677 void (*free)(struct event_trigger_data *data);
1678 int (*print)(struct seq_file *m,
1679 struct event_trigger_data *data);
1683 * struct event_command - callbacks and data members for event commands
1685 * Event commands are invoked by users by writing the command name
1686 * into the 'trigger' file associated with a trace event. The
1687 * parameters associated with a specific invocation of an event
1688 * command are used to create an event trigger instance, which is
1689 * added to the list of trigger instances associated with that trace
1690 * event. When the event is hit, the set of triggers associated with
1691 * that event is invoked.
1693 * The data members in this structure provide per-event command data
1694 * for various event commands.
1696 * All the data members below, except for @post_trigger, must be set
1697 * for each event command.
1699 * @name: The unique name that identifies the event command. This is
1700 * the name used when setting triggers via trigger files.
1702 * @trigger_type: A unique id that identifies the event command
1703 * 'type'. This value has two purposes, the first to ensure that
1704 * only one trigger of the same type can be set at a given time
1705 * for a particular event e.g. it doesn't make sense to have both
1706 * a traceon and traceoff trigger attached to a single event at
1707 * the same time, so traceon and traceoff have the same type
1708 * though they have different names. The @trigger_type value is
1709 * also used as a bit value for deferring the actual trigger
1710 * action until after the current event is finished. Some
1711 * commands need to do this if they themselves log to the trace
1712 * buffer (see the @post_trigger() member below). @trigger_type
1713 * values are defined by adding new values to the trigger_type
1714 * enum in include/linux/trace_events.h.
1716 * @flags: See the enum event_command_flags below.
1718 * All the methods below, except for @set_filter() and @unreg_all(),
1719 * must be implemented.
1721 * @parse: The callback function responsible for parsing and
1722 * registering the trigger written to the 'trigger' file by the
1723 * user. It allocates the trigger instance and registers it with
1724 * the appropriate trace event. It makes use of the other
1725 * event_command callback functions to orchestrate this, and is
1726 * usually implemented by the generic utility function
1727 * @event_trigger_callback() (see trace_event_triggers.c).
1729 * @reg: Adds the trigger to the list of triggers associated with the
1730 * event, and enables the event trigger itself, after
1731 * initializing it (via the event_trigger_ops @init() function).
1732 * This is also where commands can use the @trigger_type value to
1733 * make the decision as to whether or not multiple instances of
1734 * the trigger should be allowed. This is usually implemented by
1735 * the generic utility function @register_trigger() (see
1736 * trace_event_triggers.c).
1738 * @unreg: Removes the trigger from the list of triggers associated
1739 * with the event, and disables the event trigger itself, after
1740 * initializing it (via the event_trigger_ops @free() function).
1741 * This is usually implemented by the generic utility function
1742 * @unregister_trigger() (see trace_event_triggers.c).
1744 * @unreg_all: An optional function called to remove all the triggers
1745 * from the list of triggers associated with the event. Called
1746 * when a trigger file is opened in truncate mode.
1748 * @set_filter: An optional function called to parse and set a filter
1749 * for the trigger. If no @set_filter() method is set for the
1750 * event command, filters set by the user for the command will be
1751 * ignored. This is usually implemented by the generic utility
1752 * function @set_trigger_filter() (see trace_event_triggers.c).
1754 * @get_trigger_ops: The callback function invoked to retrieve the
1755 * event_trigger_ops implementation associated with the command.
1756 * This callback function allows a single event_command to
1757 * support multiple trigger implementations via different sets of
1758 * event_trigger_ops, depending on the value of the @param
1761 struct event_command {
1762 struct list_head list;
1764 enum event_trigger_type trigger_type;
1766 int (*parse)(struct event_command *cmd_ops,
1767 struct trace_event_file *file,
1768 char *glob, char *cmd,
1769 char *param_and_filter);
1770 int (*reg)(char *glob,
1771 struct event_trigger_data *data,
1772 struct trace_event_file *file);
1773 void (*unreg)(char *glob,
1774 struct event_trigger_data *data,
1775 struct trace_event_file *file);
1776 void (*unreg_all)(struct trace_event_file *file);
1777 int (*set_filter)(char *filter_str,
1778 struct event_trigger_data *data,
1779 struct trace_event_file *file);
1780 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1784 * enum event_command_flags - flags for struct event_command
1786 * @POST_TRIGGER: A flag that says whether or not this command needs
1787 * to have its action delayed until after the current event has
1788 * been closed. Some triggers need to avoid being invoked while
1789 * an event is currently in the process of being logged, since
1790 * the trigger may itself log data into the trace buffer. Thus
1791 * we make sure the current event is committed before invoking
1792 * those triggers. To do that, the trigger invocation is split
1793 * in two - the first part checks the filter using the current
1794 * trace record; if a command has the @post_trigger flag set, it
1795 * sets a bit for itself in the return value, otherwise it
1796 * directly invokes the trigger. Once all commands have been
1797 * either invoked or set their return flag, the current record is
1798 * either committed or discarded. At that point, if any commands
1799 * have deferred their triggers, those commands are finally
1800 * invoked following the close of the current event. In other
1801 * words, if the event_trigger_ops @func() probe implementation
1802 * itself logs to the trace buffer, this flag should be set,
1803 * otherwise it can be left unspecified.
1805 * @NEEDS_REC: A flag that says whether or not this command needs
1806 * access to the trace record in order to perform its function,
1807 * regardless of whether or not it has a filter associated with
1808 * it (filters make a trigger require access to the trace record
1809 * but are not always present).
1811 enum event_command_flags {
1812 EVENT_CMD_FL_POST_TRIGGER = 1,
1813 EVENT_CMD_FL_NEEDS_REC = 2,
1816 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1818 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1821 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1823 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1826 extern int trace_event_enable_disable(struct trace_event_file *file,
1827 int enable, int soft_disable);
1828 extern int tracing_alloc_snapshot(void);
1829 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1830 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1832 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1833 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1835 extern const char *__start___trace_bprintk_fmt[];
1836 extern const char *__stop___trace_bprintk_fmt[];
1838 extern const char *__start___tracepoint_str[];
1839 extern const char *__stop___tracepoint_str[];
1841 void trace_printk_control(bool enabled);
1842 void trace_printk_start_comm(void);
1843 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1844 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1846 /* Used from boot time tracer */
1847 extern int trace_set_options(struct trace_array *tr, char *option);
1848 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1849 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1850 unsigned long size, int cpu_id);
1851 extern int tracing_set_cpumask(struct trace_array *tr,
1852 cpumask_var_t tracing_cpumask_new);
1855 #define MAX_EVENT_NAME_LEN 64
1857 extern ssize_t trace_parse_run_command(struct file *file,
1858 const char __user *buffer, size_t count, loff_t *ppos,
1859 int (*createfn)(const char *));
1861 extern unsigned int err_pos(char *cmd, const char *str);
1862 extern void tracing_log_err(struct trace_array *tr,
1863 const char *loc, const char *cmd,
1864 const char **errs, u8 type, u16 pos);
1867 * Normal trace_printk() and friends allocates special buffers
1868 * to do the manipulation, as well as saves the print formats
1869 * into sections to display. But the trace infrastructure wants
1870 * to use these without the added overhead at the price of being
1871 * a bit slower (used mainly for warnings, where we don't care
1872 * about performance). The internal_trace_puts() is for such
1875 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1878 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1879 extern struct trace_event_call \
1880 __aligned(4) event_##call;
1881 #undef FTRACE_ENTRY_DUP
1882 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1883 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1884 #undef FTRACE_ENTRY_PACKED
1885 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1886 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1888 #include "trace_entries.h"
1890 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1891 int perf_ftrace_event_register(struct trace_event_call *call,
1892 enum trace_reg type, void *data);
1894 #define perf_ftrace_event_register NULL
1897 #ifdef CONFIG_FTRACE_SYSCALLS
1898 void init_ftrace_syscalls(void);
1899 const char *get_syscall_name(int syscall);
1901 static inline void init_ftrace_syscalls(void) { }
1902 static inline const char *get_syscall_name(int syscall)
1908 #ifdef CONFIG_EVENT_TRACING
1909 void trace_event_init(void);
1910 void trace_event_eval_update(struct trace_eval_map **map, int len);
1911 /* Used from boot time tracer */
1912 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1913 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1915 static inline void __init trace_event_init(void) { }
1916 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1919 #ifdef CONFIG_TRACER_SNAPSHOT
1920 void tracing_snapshot_instance(struct trace_array *tr);
1921 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1923 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1924 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1930 #ifdef CONFIG_PREEMPT_TRACER
1931 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1932 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1934 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1935 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1937 #ifdef CONFIG_IRQSOFF_TRACER
1938 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1939 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1941 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1942 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1945 extern struct trace_iterator *tracepoint_print_iter;
1948 * Reset the state of the trace_iterator so that it can read consumed data.
1949 * Normally, the trace_iterator is used for reading the data when it is not
1950 * consumed, and must retain state.
1952 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1954 memset_startat(iter, 0, seq);
1958 /* Check the name is good for event/group/fields */
1959 static inline bool is_good_name(const char *name)
1961 if (!isalpha(*name) && *name != '_')
1963 while (*++name != '\0') {
1964 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1970 /* Convert certain expected symbols into '_' when generating event names */
1971 static inline void sanitize_event_name(char *name)
1973 while (*name++ != '\0')
1974 if (*name == ':' || *name == '.')
1979 * This is a generic way to read and write a u64 value from a file in tracefs.
1981 * The value is stored on the variable pointed by *val. The value needs
1982 * to be at least *min and at most *max. The write is protected by an
1985 struct trace_min_max_param {
1992 #define U64_STR_SIZE 24 /* 20 digits max */
1994 extern const struct file_operations trace_min_max_fops;
1997 extern int rv_init_interface(void);
1999 static inline int rv_init_interface(void)
2005 #endif /* _LINUX_KERNEL_TRACE_H */