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 * For backward compatibility, older user space expects to see the
82 * kernel_stack event with a fixed size caller field. But today the fix
83 * size is ignored by the kernel, and the real structure is dynamic.
84 * Expose to user space: "unsigned long caller[8];" but the real structure
85 * will be "unsigned long caller[] __counted_by(size)"
88 #define __stack_array(type, item, size, field) type item[] __counted_by(field);
91 #define __array_desc(type, container, item, size)
93 #undef __dynamic_array
94 #define __dynamic_array(type, item) type item[];
96 #undef __rel_dynamic_array
97 #define __rel_dynamic_array(type, item) type item[];
100 #define F_STRUCT(args...) args
103 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
104 struct struct_name { \
105 struct trace_entry ent; \
109 #undef FTRACE_ENTRY_DUP
110 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
112 #undef FTRACE_ENTRY_REG
113 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
114 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
116 #undef FTRACE_ENTRY_PACKED
117 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
118 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
120 #include "trace_entries.h"
122 /* Use this for memory failure errors */
123 #define MEM_FAIL(condition, fmt, ...) \
124 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__)
126 #define FAULT_STRING "(fault)"
128 #define HIST_STACKTRACE_DEPTH 16
129 #define HIST_STACKTRACE_SIZE (HIST_STACKTRACE_DEPTH * sizeof(unsigned long))
130 #define HIST_STACKTRACE_SKIP 5
133 * syscalls are special, and need special handling, this is why
134 * they are not included in trace_entries.h
136 struct syscall_trace_enter {
137 struct trace_entry ent;
139 unsigned long args[];
142 struct syscall_trace_exit {
143 struct trace_entry ent;
148 struct kprobe_trace_entry_head {
149 struct trace_entry ent;
153 struct eprobe_trace_entry_head {
154 struct trace_entry ent;
157 struct kretprobe_trace_entry_head {
158 struct trace_entry ent;
160 unsigned long ret_ip;
163 struct fentry_trace_entry_head {
164 struct trace_entry ent;
168 struct fexit_trace_entry_head {
169 struct trace_entry ent;
171 unsigned long ret_ip;
174 #define TRACE_BUF_SIZE 1024
179 * The CPU trace array - it consists of thousands of trace entries
180 * plus some other descriptor data: (for example which task started
183 struct trace_array_cpu {
185 void *buffer_page; /* ring buffer spare */
187 unsigned long entries;
188 unsigned long saved_latency;
189 unsigned long critical_start;
190 unsigned long critical_end;
191 unsigned long critical_sequence;
193 unsigned long policy;
194 unsigned long rt_priority;
195 unsigned long skipped_entries;
196 u64 preempt_timestamp;
199 char comm[TASK_COMM_LEN];
201 #ifdef CONFIG_FUNCTION_TRACER
202 int ftrace_ignore_pid;
208 struct trace_option_dentry;
210 struct array_buffer {
211 struct trace_array *tr;
212 struct trace_buffer *buffer;
213 struct trace_array_cpu __percpu *data;
218 #define TRACE_FLAGS_MAX_SIZE 32
220 struct trace_options {
221 struct tracer *tracer;
222 struct trace_option_dentry *topts;
225 struct trace_pid_list *trace_pid_list_alloc(void);
226 void trace_pid_list_free(struct trace_pid_list *pid_list);
227 bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid);
228 int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid);
229 int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid);
230 int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid);
231 int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid,
236 TRACE_NO_PIDS = BIT(1),
239 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
240 struct trace_pid_list *no_pid_list)
242 /* Return true if the pid list in type has pids */
243 return ((type & TRACE_PIDS) && pid_list) ||
244 ((type & TRACE_NO_PIDS) && no_pid_list);
247 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
248 struct trace_pid_list *no_pid_list)
251 * Turning off what is in @type, return true if the "other"
252 * pid list, still has pids in it.
254 return (!(type & TRACE_PIDS) && pid_list) ||
255 (!(type & TRACE_NO_PIDS) && no_pid_list);
258 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
261 * struct cond_snapshot - conditional snapshot data and callback
263 * The cond_snapshot structure encapsulates a callback function and
264 * data associated with the snapshot for a given tracing instance.
266 * When a snapshot is taken conditionally, by invoking
267 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
268 * passed in turn to the cond_snapshot.update() function. That data
269 * can be compared by the update() implementation with the cond_data
270 * contained within the struct cond_snapshot instance associated with
271 * the trace_array. Because the tr->max_lock is held throughout the
272 * update() call, the update() function can directly retrieve the
273 * cond_snapshot and cond_data associated with the per-instance
274 * snapshot associated with the trace_array.
276 * The cond_snapshot.update() implementation can save data to be
277 * associated with the snapshot if it decides to, and returns 'true'
278 * in that case, or it returns 'false' if the conditional snapshot
279 * shouldn't be taken.
281 * The cond_snapshot instance is created and associated with the
282 * user-defined cond_data by tracing_cond_snapshot_enable().
283 * Likewise, the cond_snapshot instance is destroyed and is no longer
284 * associated with the trace instance by
285 * tracing_cond_snapshot_disable().
287 * The method below is required.
289 * @update: When a conditional snapshot is invoked, the update()
290 * callback function is invoked with the tr->max_lock held. The
291 * update() implementation signals whether or not to actually
292 * take the snapshot, by returning 'true' if so, 'false' if no
293 * snapshot should be taken. Because the max_lock is held for
294 * the duration of update(), the implementation is safe to
295 * directly retrieved and save any implementation data it needs
296 * to in association with the snapshot.
298 struct cond_snapshot {
300 cond_update_fn_t update;
304 * struct trace_func_repeats - used to keep track of the consecutive
305 * (on the same CPU) calls of a single function.
307 struct trace_func_repeats {
309 unsigned long parent_ip;
315 * The trace array - an array of per-CPU trace arrays. This is the
316 * highest level data structure that individual tracers deal with.
317 * They have on/off state as well:
320 struct list_head list;
322 struct array_buffer array_buffer;
323 #ifdef CONFIG_TRACER_MAX_TRACE
325 * The max_buffer is used to snapshot the trace when a maximum
326 * latency is reached, or when the user initiates a snapshot.
327 * Some tracers will use this to store a maximum trace while
328 * it continues examining live traces.
330 * The buffers for the max_buffer are set up the same as the array_buffer
331 * When a snapshot is taken, the buffer of the max_buffer is swapped
332 * with the buffer of the array_buffer and the buffers are reset for
333 * the array_buffer so the tracing can continue.
335 struct array_buffer max_buffer;
336 bool allocated_snapshot;
338 #ifdef CONFIG_TRACER_MAX_TRACE
339 unsigned long max_latency;
340 #ifdef CONFIG_FSNOTIFY
341 struct dentry *d_max_latency;
342 struct work_struct fsnotify_work;
343 struct irq_work fsnotify_irqwork;
346 struct trace_pid_list __rcu *filtered_pids;
347 struct trace_pid_list __rcu *filtered_no_pids;
349 * max_lock is used to protect the swapping of buffers
350 * when taking a max snapshot. The buffers themselves are
351 * protected by per_cpu spinlocks. But the action of the swap
352 * needs its own lock.
354 * This is defined as a arch_spinlock_t in order to help
355 * with performance when lockdep debugging is enabled.
357 * It is also used in other places outside the update_max_tr
358 * so it needs to be defined outside of the
359 * CONFIG_TRACER_MAX_TRACE.
361 arch_spinlock_t max_lock;
363 #ifdef CONFIG_FTRACE_SYSCALLS
364 int sys_refcount_enter;
365 int sys_refcount_exit;
366 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
367 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
374 unsigned int n_err_log_entries;
375 struct tracer *current_trace;
376 unsigned int trace_flags;
377 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
379 raw_spinlock_t start_lock;
380 struct list_head err_log;
382 struct dentry *options;
383 struct dentry *percpu_dir;
384 struct eventfs_inode *event_dir;
385 struct trace_options *topts;
386 struct list_head systems;
387 struct list_head events;
388 struct trace_event_file *trace_marker_file;
389 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
390 /* one per_cpu trace_pipe can be opened by only one user */
391 cpumask_var_t pipe_cpumask;
394 #ifdef CONFIG_FUNCTION_TRACER
395 struct ftrace_ops *ops;
396 struct trace_pid_list __rcu *function_pids;
397 struct trace_pid_list __rcu *function_no_pids;
398 #ifdef CONFIG_DYNAMIC_FTRACE
399 /* All of these are protected by the ftrace_lock */
400 struct list_head func_probes;
401 struct list_head mod_trace;
402 struct list_head mod_notrace;
404 /* function tracing enabled */
405 int function_enabled;
407 int no_filter_buffering_ref;
408 struct list_head hist_vars;
409 #ifdef CONFIG_TRACER_SNAPSHOT
410 struct cond_snapshot *cond_snapshot;
412 struct trace_func_repeats __percpu *last_func_repeats;
414 * On boot up, the ring buffer is set to the minimum size, so that
415 * we do not waste memory on systems that are not using tracing.
417 bool ring_buffer_expanded;
421 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
424 extern struct list_head ftrace_trace_arrays;
426 extern struct mutex trace_types_lock;
428 extern int trace_array_get(struct trace_array *tr);
429 extern int tracing_check_open_get_tr(struct trace_array *tr);
430 extern struct trace_array *trace_array_find(const char *instance);
431 extern struct trace_array *trace_array_find_get(const char *instance);
433 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
434 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
435 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
437 extern bool trace_clock_in_ns(struct trace_array *tr);
440 * The global tracer (top) should be the first trace array added,
441 * but we check the flag anyway.
443 static inline struct trace_array *top_trace_array(void)
445 struct trace_array *tr;
447 if (list_empty(&ftrace_trace_arrays))
450 tr = list_entry(ftrace_trace_arrays.prev,
452 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
456 #define FTRACE_CMP_TYPE(var, type) \
457 __builtin_types_compatible_p(typeof(var), type *)
460 #define IF_ASSIGN(var, entry, etype, id) \
461 if (FTRACE_CMP_TYPE(var, etype)) { \
462 var = (typeof(var))(entry); \
463 WARN_ON(id != 0 && (entry)->type != id); \
467 /* Will cause compile errors if type is not found. */
468 extern void __ftrace_bad_type(void);
471 * The trace_assign_type is a verifier that the entry type is
472 * the same as the type being assigned. To add new types simply
473 * add a line with the following format:
475 * IF_ASSIGN(var, ent, type, id);
477 * Where "type" is the trace type that includes the trace_entry
478 * as the "ent" item. And "id" is the trace identifier that is
479 * used in the trace_type enum.
481 * If the type can have more than one id, then use zero.
483 #define trace_assign_type(var, ent) \
485 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
486 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
487 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
488 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
489 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
490 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
491 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
492 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
493 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
494 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
495 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
496 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
498 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
500 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
501 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
503 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
505 IF_ASSIGN(var, ent, struct func_repeats_entry, \
506 TRACE_FUNC_REPEATS); \
507 __ftrace_bad_type(); \
511 * An option specific to a tracer. This is a boolean value.
512 * The bit is the bit index that sets its value on the
513 * flags value in struct tracer_flags.
516 const char *name; /* Will appear on the trace_options file */
517 u32 bit; /* Mask assigned in val field in tracer_flags */
521 * The set of specific options for a tracer. Your tracer
522 * have to set the initial value of the flags val.
524 struct tracer_flags {
526 struct tracer_opt *opts;
527 struct tracer *trace;
530 /* Makes more easy to define a tracer opt */
531 #define TRACER_OPT(s, b) .name = #s, .bit = b
534 struct trace_option_dentry {
535 struct tracer_opt *opt;
536 struct tracer_flags *flags;
537 struct trace_array *tr;
538 struct dentry *entry;
542 * struct tracer - a specific tracer and its callbacks to interact with tracefs
543 * @name: the name chosen to select it on the available_tracers file
544 * @init: called when one switches to this tracer (echo name > current_tracer)
545 * @reset: called when one switches to another tracer
546 * @start: called when tracing is unpaused (echo 1 > tracing_on)
547 * @stop: called when tracing is paused (echo 0 > tracing_on)
548 * @update_thresh: called when tracing_thresh is updated
549 * @open: called when the trace file is opened
550 * @pipe_open: called when the trace_pipe file is opened
551 * @close: called when the trace file is released
552 * @pipe_close: called when the trace_pipe file is released
553 * @read: override the default read callback on trace_pipe
554 * @splice_read: override the default splice_read callback on trace_pipe
555 * @selftest: selftest to run on boot (see trace_selftest.c)
556 * @print_headers: override the first lines that describe your columns
557 * @print_line: callback that prints a trace
558 * @set_flag: signals one of your private flags changed (trace_options file)
559 * @flags: your private flags
563 int (*init)(struct trace_array *tr);
564 void (*reset)(struct trace_array *tr);
565 void (*start)(struct trace_array *tr);
566 void (*stop)(struct trace_array *tr);
567 int (*update_thresh)(struct trace_array *tr);
568 void (*open)(struct trace_iterator *iter);
569 void (*pipe_open)(struct trace_iterator *iter);
570 void (*close)(struct trace_iterator *iter);
571 void (*pipe_close)(struct trace_iterator *iter);
572 ssize_t (*read)(struct trace_iterator *iter,
573 struct file *filp, char __user *ubuf,
574 size_t cnt, loff_t *ppos);
575 ssize_t (*splice_read)(struct trace_iterator *iter,
578 struct pipe_inode_info *pipe,
581 #ifdef CONFIG_FTRACE_STARTUP_TEST
582 int (*selftest)(struct tracer *trace,
583 struct trace_array *tr);
585 void (*print_header)(struct seq_file *m);
586 enum print_line_t (*print_line)(struct trace_iterator *iter);
587 /* If you handled the flag setting, return 0 */
588 int (*set_flag)(struct trace_array *tr,
589 u32 old_flags, u32 bit, int set);
590 /* Return 0 if OK with change, else return non-zero */
591 int (*flag_changed)(struct trace_array *tr,
594 struct tracer_flags *flags;
597 bool allow_instances;
598 #ifdef CONFIG_TRACER_MAX_TRACE
601 /* True if tracer cannot be enabled in kernel param */
605 static inline struct ring_buffer_iter *
606 trace_buffer_iter(struct trace_iterator *iter, int cpu)
608 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
611 int tracer_init(struct tracer *t, struct trace_array *tr);
612 int tracing_is_enabled(void);
613 void tracing_reset_online_cpus(struct array_buffer *buf);
614 void tracing_reset_all_online_cpus(void);
615 void tracing_reset_all_online_cpus_unlocked(void);
616 int tracing_open_generic(struct inode *inode, struct file *filp);
617 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
618 int tracing_open_file_tr(struct inode *inode, struct file *filp);
619 int tracing_release_file_tr(struct inode *inode, struct file *filp);
620 int tracing_single_release_file_tr(struct inode *inode, struct file *filp);
621 bool tracing_is_disabled(void);
622 bool tracer_tracing_is_on(struct trace_array *tr);
623 void tracer_tracing_on(struct trace_array *tr);
624 void tracer_tracing_off(struct trace_array *tr);
625 struct dentry *trace_create_file(const char *name,
627 struct dentry *parent,
629 const struct file_operations *fops);
631 int tracing_init_dentry(void);
633 struct ring_buffer_event;
635 struct ring_buffer_event *
636 trace_buffer_lock_reserve(struct trace_buffer *buffer,
639 unsigned int trace_ctx);
641 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
642 struct trace_array_cpu *data);
644 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
645 int *ent_cpu, u64 *ent_ts);
647 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
648 struct ring_buffer_event *event);
650 bool trace_is_tracepoint_string(const char *str);
651 const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
652 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
653 va_list ap) __printf(2, 0);
654 char *trace_iter_expand_format(struct trace_iterator *iter);
656 int trace_empty(struct trace_iterator *iter);
658 void *trace_find_next_entry_inc(struct trace_iterator *iter);
660 void trace_init_global_iter(struct trace_iterator *iter);
662 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
664 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
665 unsigned long trace_total_entries(struct trace_array *tr);
667 void trace_function(struct trace_array *tr,
669 unsigned long parent_ip,
670 unsigned int trace_ctx);
671 void trace_graph_function(struct trace_array *tr,
673 unsigned long parent_ip,
674 unsigned int trace_ctx);
675 void trace_latency_header(struct seq_file *m);
676 void trace_default_header(struct seq_file *m);
677 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
679 void trace_graph_return(struct ftrace_graph_ret *trace);
680 int trace_graph_entry(struct ftrace_graph_ent *trace);
681 void set_graph_array(struct trace_array *tr);
683 void tracing_start_cmdline_record(void);
684 void tracing_stop_cmdline_record(void);
685 void tracing_start_tgid_record(void);
686 void tracing_stop_tgid_record(void);
688 int register_tracer(struct tracer *type);
689 int is_tracing_stopped(void);
691 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
693 extern cpumask_var_t __read_mostly tracing_buffer_mask;
695 #define for_each_tracing_cpu(cpu) \
696 for_each_cpu(cpu, tracing_buffer_mask)
698 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
700 extern unsigned long tracing_thresh;
706 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
708 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
709 struct trace_pid_list *filtered_no_pids,
710 struct task_struct *task);
711 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
712 struct task_struct *self,
713 struct task_struct *task);
714 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
715 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
716 int trace_pid_show(struct seq_file *m, void *v);
717 int trace_pid_write(struct trace_pid_list *filtered_pids,
718 struct trace_pid_list **new_pid_list,
719 const char __user *ubuf, size_t cnt);
721 #ifdef CONFIG_TRACER_MAX_TRACE
722 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
724 void update_max_tr_single(struct trace_array *tr,
725 struct task_struct *tsk, int cpu);
727 #ifdef CONFIG_FSNOTIFY
728 #define LATENCY_FS_NOTIFY
730 #endif /* CONFIG_TRACER_MAX_TRACE */
732 #ifdef LATENCY_FS_NOTIFY
733 void latency_fsnotify(struct trace_array *tr);
735 static inline void latency_fsnotify(struct trace_array *tr) { }
738 #ifdef CONFIG_STACKTRACE
739 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
741 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
745 #endif /* CONFIG_STACKTRACE */
747 void trace_last_func_repeats(struct trace_array *tr,
748 struct trace_func_repeats *last_info,
749 unsigned int trace_ctx);
751 extern u64 ftrace_now(int cpu);
753 extern void trace_find_cmdline(int pid, char comm[]);
754 extern int trace_find_tgid(int pid);
755 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
757 #ifdef CONFIG_DYNAMIC_FTRACE
758 extern unsigned long ftrace_update_tot_cnt;
759 extern unsigned long ftrace_number_of_pages;
760 extern unsigned long ftrace_number_of_groups;
761 void ftrace_init_trace_array(struct trace_array *tr);
763 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
765 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
766 extern int DYN_FTRACE_TEST_NAME(void);
767 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
768 extern int DYN_FTRACE_TEST_NAME2(void);
770 extern void trace_set_ring_buffer_expanded(struct trace_array *tr);
771 extern bool tracing_selftest_disabled;
773 #ifdef CONFIG_FTRACE_STARTUP_TEST
774 extern void __init disable_tracing_selftest(const char *reason);
776 extern int trace_selftest_startup_function(struct tracer *trace,
777 struct trace_array *tr);
778 extern int trace_selftest_startup_function_graph(struct tracer *trace,
779 struct trace_array *tr);
780 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
781 struct trace_array *tr);
782 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
783 struct trace_array *tr);
784 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
785 struct trace_array *tr);
786 extern int trace_selftest_startup_wakeup(struct tracer *trace,
787 struct trace_array *tr);
788 extern int trace_selftest_startup_nop(struct tracer *trace,
789 struct trace_array *tr);
790 extern int trace_selftest_startup_branch(struct tracer *trace,
791 struct trace_array *tr);
793 * Tracer data references selftest functions that only occur
794 * on boot up. These can be __init functions. Thus, when selftests
795 * are enabled, then the tracers need to reference __init functions.
797 #define __tracer_data __refdata
799 static inline void __init disable_tracing_selftest(const char *reason)
802 /* Tracers are seldom changed. Optimize when selftests are disabled. */
803 #define __tracer_data __read_mostly
804 #endif /* CONFIG_FTRACE_STARTUP_TEST */
806 extern void *head_page(struct trace_array_cpu *data);
807 extern unsigned long long ns2usecs(u64 nsec);
809 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
811 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
813 trace_array_vprintk(struct trace_array *tr,
814 unsigned long ip, const char *fmt, va_list args);
815 int trace_array_printk_buf(struct trace_buffer *buffer,
816 unsigned long ip, const char *fmt, ...);
817 void trace_printk_seq(struct trace_seq *s);
818 enum print_line_t print_trace_line(struct trace_iterator *iter);
820 extern char trace_find_mark(unsigned long long duration);
824 struct ftrace_mod_load {
825 struct list_head list;
832 FTRACE_HASH_FL_MOD = (1 << 0),
836 unsigned long size_bits;
837 struct hlist_head *buckets;
843 struct ftrace_func_entry *
844 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
846 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
848 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
851 /* Standard output formatting function used for function return traces */
852 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
855 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
856 #define TRACE_GRAPH_PRINT_CPU 0x2
857 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
858 #define TRACE_GRAPH_PRINT_PROC 0x8
859 #define TRACE_GRAPH_PRINT_DURATION 0x10
860 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
861 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
862 #define TRACE_GRAPH_PRINT_IRQS 0x80
863 #define TRACE_GRAPH_PRINT_TAIL 0x100
864 #define TRACE_GRAPH_SLEEP_TIME 0x200
865 #define TRACE_GRAPH_GRAPH_TIME 0x400
866 #define TRACE_GRAPH_PRINT_RETVAL 0x800
867 #define TRACE_GRAPH_PRINT_RETVAL_HEX 0x1000
868 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
869 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
871 extern void ftrace_graph_sleep_time_control(bool enable);
873 #ifdef CONFIG_FUNCTION_PROFILER
874 extern void ftrace_graph_graph_time_control(bool enable);
876 static inline void ftrace_graph_graph_time_control(bool enable) { }
879 extern enum print_line_t
880 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
881 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
883 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
884 extern void graph_trace_open(struct trace_iterator *iter);
885 extern void graph_trace_close(struct trace_iterator *iter);
886 extern int __trace_graph_entry(struct trace_array *tr,
887 struct ftrace_graph_ent *trace,
888 unsigned int trace_ctx);
889 extern void __trace_graph_return(struct trace_array *tr,
890 struct ftrace_graph_ret *trace,
891 unsigned int trace_ctx);
893 #ifdef CONFIG_DYNAMIC_FTRACE
894 extern struct ftrace_hash __rcu *ftrace_graph_hash;
895 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
897 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
899 unsigned long addr = trace->func;
901 struct ftrace_hash *hash;
903 preempt_disable_notrace();
906 * Have to open code "rcu_dereference_sched()" because the
907 * function graph tracer can be called when RCU is not
909 * Protected with schedule_on_each_cpu(ftrace_sync)
911 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
913 if (ftrace_hash_empty(hash)) {
918 if (ftrace_lookup_ip(hash, addr)) {
921 * This needs to be cleared on the return functions
922 * when the depth is zero.
924 trace_recursion_set(TRACE_GRAPH_BIT);
925 trace_recursion_set_depth(trace->depth);
928 * If no irqs are to be traced, but a set_graph_function
929 * is set, and called by an interrupt handler, we still
933 trace_recursion_set(TRACE_IRQ_BIT);
935 trace_recursion_clear(TRACE_IRQ_BIT);
940 preempt_enable_notrace();
944 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
946 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
947 trace->depth == trace_recursion_depth())
948 trace_recursion_clear(TRACE_GRAPH_BIT);
951 static inline int ftrace_graph_notrace_addr(unsigned long addr)
954 struct ftrace_hash *notrace_hash;
956 preempt_disable_notrace();
959 * Have to open code "rcu_dereference_sched()" because the
960 * function graph tracer can be called when RCU is not
962 * Protected with schedule_on_each_cpu(ftrace_sync)
964 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
967 if (ftrace_lookup_ip(notrace_hash, addr))
970 preempt_enable_notrace();
974 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
979 static inline int ftrace_graph_notrace_addr(unsigned long addr)
983 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
985 #endif /* CONFIG_DYNAMIC_FTRACE */
987 extern unsigned int fgraph_max_depth;
989 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
991 /* trace it when it is-nested-in or is a function enabled. */
992 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
993 ftrace_graph_addr(trace)) ||
994 (trace->depth < 0) ||
995 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
998 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
999 static inline enum print_line_t
1000 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1002 return TRACE_TYPE_UNHANDLED;
1004 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
1006 extern struct list_head ftrace_pids;
1008 #ifdef CONFIG_FUNCTION_TRACER
1010 #define FTRACE_PID_IGNORE -1
1011 #define FTRACE_PID_TRACE -2
1013 struct ftrace_func_command {
1014 struct list_head list;
1016 int (*func)(struct trace_array *tr,
1017 struct ftrace_hash *hash,
1018 char *func, char *cmd,
1019 char *params, int enable);
1021 extern bool ftrace_filter_param __initdata;
1022 static inline int ftrace_trace_task(struct trace_array *tr)
1024 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
1027 extern int ftrace_is_dead(void);
1028 int ftrace_create_function_files(struct trace_array *tr,
1029 struct dentry *parent);
1030 void ftrace_destroy_function_files(struct trace_array *tr);
1031 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
1032 void ftrace_free_ftrace_ops(struct trace_array *tr);
1033 void ftrace_init_global_array_ops(struct trace_array *tr);
1034 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1035 void ftrace_reset_array_ops(struct trace_array *tr);
1036 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1037 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1038 struct dentry *d_tracer);
1039 void ftrace_clear_pids(struct trace_array *tr);
1040 int init_function_trace(void);
1041 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1043 static inline int ftrace_trace_task(struct trace_array *tr)
1047 static inline int ftrace_is_dead(void) { return 0; }
1049 ftrace_create_function_files(struct trace_array *tr,
1050 struct dentry *parent)
1054 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1058 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1059 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1060 static inline __init void
1061 ftrace_init_global_array_ops(struct trace_array *tr) { }
1062 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1063 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1064 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1065 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1066 static inline int init_function_trace(void) { return 0; }
1067 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1068 /* ftace_func_t type is not defined, use macro instead of static inline */
1069 #define ftrace_init_array_ops(tr, func) do { } while (0)
1070 #endif /* CONFIG_FUNCTION_TRACER */
1072 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1074 struct ftrace_probe_ops {
1075 void (*func)(unsigned long ip,
1076 unsigned long parent_ip,
1077 struct trace_array *tr,
1078 struct ftrace_probe_ops *ops,
1080 int (*init)(struct ftrace_probe_ops *ops,
1081 struct trace_array *tr,
1082 unsigned long ip, void *init_data,
1084 void (*free)(struct ftrace_probe_ops *ops,
1085 struct trace_array *tr,
1086 unsigned long ip, void *data);
1087 int (*print)(struct seq_file *m,
1089 struct ftrace_probe_ops *ops,
1093 struct ftrace_func_mapper;
1094 typedef int (*ftrace_mapper_func)(void *data);
1096 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1097 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1099 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1100 unsigned long ip, void *data);
1101 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1103 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1104 ftrace_mapper_func free_func);
1107 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1108 struct ftrace_probe_ops *ops, void *data);
1110 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1111 struct ftrace_probe_ops *ops);
1112 extern void clear_ftrace_function_probes(struct trace_array *tr);
1114 int register_ftrace_command(struct ftrace_func_command *cmd);
1115 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1117 void ftrace_create_filter_files(struct ftrace_ops *ops,
1118 struct dentry *parent);
1119 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1121 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1122 int len, int reset);
1123 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1124 int len, int reset);
1126 struct ftrace_func_command;
1128 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1132 static inline __init int unregister_ftrace_command(char *cmd_name)
1136 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1141 * The ops parameter passed in is usually undefined.
1142 * This must be a macro.
1144 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1145 #define ftrace_destroy_filter_files(ops) do { } while (0)
1146 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1148 bool ftrace_event_is_function(struct trace_event_call *call);
1151 * struct trace_parser - servers for reading the user input separated by spaces
1152 * @cont: set if the input is not complete - no final space char was found
1153 * @buffer: holds the parsed user input
1154 * @idx: user input length
1155 * @size: buffer size
1157 struct trace_parser {
1164 static inline bool trace_parser_loaded(struct trace_parser *parser)
1166 return (parser->idx != 0);
1169 static inline bool trace_parser_cont(struct trace_parser *parser)
1171 return parser->cont;
1174 static inline void trace_parser_clear(struct trace_parser *parser)
1176 parser->cont = false;
1180 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1181 extern void trace_parser_put(struct trace_parser *parser);
1182 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1183 size_t cnt, loff_t *ppos);
1186 * Only create function graph options if function graph is configured.
1188 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1189 # define FGRAPH_FLAGS \
1190 C(DISPLAY_GRAPH, "display-graph"),
1192 # define FGRAPH_FLAGS
1195 #ifdef CONFIG_BRANCH_TRACER
1196 # define BRANCH_FLAGS \
1197 C(BRANCH, "branch"),
1199 # define BRANCH_FLAGS
1202 #ifdef CONFIG_FUNCTION_TRACER
1203 # define FUNCTION_FLAGS \
1204 C(FUNCTION, "function-trace"), \
1205 C(FUNC_FORK, "function-fork"),
1206 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1208 # define FUNCTION_FLAGS
1209 # define FUNCTION_DEFAULT_FLAGS 0UL
1210 # define TRACE_ITER_FUNC_FORK 0UL
1213 #ifdef CONFIG_STACKTRACE
1214 # define STACK_FLAGS \
1215 C(STACKTRACE, "stacktrace"),
1217 # define STACK_FLAGS
1221 * trace_iterator_flags is an enumeration that defines bit
1222 * positions into trace_flags that controls the output.
1224 * NOTE: These bits must match the trace_options array in
1225 * trace.c (this macro guarantees it).
1227 #define TRACE_FLAGS \
1228 C(PRINT_PARENT, "print-parent"), \
1229 C(SYM_OFFSET, "sym-offset"), \
1230 C(SYM_ADDR, "sym-addr"), \
1231 C(VERBOSE, "verbose"), \
1235 C(BLOCK, "block"), \
1236 C(FIELDS, "fields"), \
1237 C(PRINTK, "trace_printk"), \
1238 C(ANNOTATE, "annotate"), \
1239 C(USERSTACKTRACE, "userstacktrace"), \
1240 C(SYM_USEROBJ, "sym-userobj"), \
1241 C(PRINTK_MSGONLY, "printk-msg-only"), \
1242 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1243 C(LATENCY_FMT, "latency-format"), \
1244 C(RECORD_CMD, "record-cmd"), \
1245 C(RECORD_TGID, "record-tgid"), \
1246 C(OVERWRITE, "overwrite"), \
1247 C(STOP_ON_FREE, "disable_on_free"), \
1248 C(IRQ_INFO, "irq-info"), \
1249 C(MARKERS, "markers"), \
1250 C(EVENT_FORK, "event-fork"), \
1251 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1252 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1259 * By defining C, we can make TRACE_FLAGS a list of bit names
1260 * that will define the bits for the flag masks.
1263 #define C(a, b) TRACE_ITER_##a##_BIT
1265 enum trace_iterator_bits {
1267 /* Make sure we don't go more than we have bits for */
1272 * By redefining C, we can make TRACE_FLAGS a list of masks that
1273 * use the bits as defined above.
1276 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1278 enum trace_iterator_flags { TRACE_FLAGS };
1281 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1282 * control the output of kernel symbols.
1284 #define TRACE_ITER_SYM_MASK \
1285 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1287 extern struct tracer nop_trace;
1289 #ifdef CONFIG_BRANCH_TRACER
1290 extern int enable_branch_tracing(struct trace_array *tr);
1291 extern void disable_branch_tracing(void);
1292 static inline int trace_branch_enable(struct trace_array *tr)
1294 if (tr->trace_flags & TRACE_ITER_BRANCH)
1295 return enable_branch_tracing(tr);
1298 static inline void trace_branch_disable(void)
1300 /* due to races, always disable */
1301 disable_branch_tracing();
1304 static inline int trace_branch_enable(struct trace_array *tr)
1308 static inline void trace_branch_disable(void)
1311 #endif /* CONFIG_BRANCH_TRACER */
1313 /* set ring buffers to default size if not already done so */
1314 int tracing_update_buffers(struct trace_array *tr);
1316 union trace_synth_field {
1321 struct trace_dynamic_info as_dynamic;
1324 struct ftrace_event_field {
1325 struct list_head link;
1337 struct event_filter {
1338 struct prog_entry __rcu *prog;
1339 char *filter_string;
1342 struct event_subsystem {
1343 struct list_head list;
1345 struct event_filter *filter;
1349 struct trace_subsystem_dir {
1350 struct list_head list;
1351 struct event_subsystem *subsystem;
1352 struct trace_array *tr;
1353 struct eventfs_inode *ei;
1358 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1359 struct trace_buffer *buffer,
1360 struct ring_buffer_event *event);
1362 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1363 struct trace_buffer *buffer,
1364 struct ring_buffer_event *event,
1365 unsigned int trcace_ctx,
1366 struct pt_regs *regs);
1368 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1369 struct trace_buffer *buffer,
1370 struct ring_buffer_event *event,
1371 unsigned int trace_ctx)
1373 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1376 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1377 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1378 void trace_buffered_event_disable(void);
1379 void trace_buffered_event_enable(void);
1381 void early_enable_events(struct trace_array *tr, char *buf, bool disable_first);
1384 __trace_event_discard_commit(struct trace_buffer *buffer,
1385 struct ring_buffer_event *event)
1387 if (this_cpu_read(trace_buffered_event) == event) {
1388 /* Simply release the temp buffer and enable preemption */
1389 this_cpu_dec(trace_buffered_event_cnt);
1390 preempt_enable_notrace();
1393 /* ring_buffer_discard_commit() enables preemption */
1394 ring_buffer_discard_commit(buffer, event);
1398 * Helper function for event_trigger_unlock_commit{_regs}().
1399 * If there are event triggers attached to this event that requires
1400 * filtering against its fields, then they will be called as the
1401 * entry already holds the field information of the current event.
1403 * It also checks if the event should be discarded or not.
1404 * It is to be discarded if the event is soft disabled and the
1405 * event was only recorded to process triggers, or if the event
1406 * filter is active and this event did not match the filters.
1408 * Returns true if the event is discarded, false otherwise.
1411 __event_trigger_test_discard(struct trace_event_file *file,
1412 struct trace_buffer *buffer,
1413 struct ring_buffer_event *event,
1415 enum event_trigger_type *tt)
1417 unsigned long eflags = file->flags;
1419 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1420 *tt = event_triggers_call(file, buffer, entry, event);
1422 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1423 EVENT_FILE_FL_FILTERED |
1424 EVENT_FILE_FL_PID_FILTER))))
1427 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1430 if (file->flags & EVENT_FILE_FL_FILTERED &&
1431 !filter_match_preds(file->filter, entry))
1434 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1435 trace_event_ignore_this_pid(file))
1440 __trace_event_discard_commit(buffer, event);
1445 * event_trigger_unlock_commit - handle triggers and finish event commit
1446 * @file: The file pointer associated with the event
1447 * @buffer: The ring buffer that the event is being written to
1448 * @event: The event meta data in the ring buffer
1449 * @entry: The event itself
1450 * @trace_ctx: The tracing context flags.
1452 * This is a helper function to handle triggers that require data
1453 * from the event itself. It also tests the event against filters and
1454 * if the event is soft disabled and should be discarded.
1457 event_trigger_unlock_commit(struct trace_event_file *file,
1458 struct trace_buffer *buffer,
1459 struct ring_buffer_event *event,
1460 void *entry, unsigned int trace_ctx)
1462 enum event_trigger_type tt = ETT_NONE;
1464 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1465 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1468 event_triggers_post_call(file, tt);
1471 #define FILTER_PRED_INVALID ((unsigned short)-1)
1472 #define FILTER_PRED_IS_RIGHT (1 << 15)
1473 #define FILTER_PRED_FOLD (1 << 15)
1476 * The max preds is the size of unsigned short with
1477 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1478 * and FOLD flags. The other is reserved.
1480 * 2^14 preds is way more than enough.
1482 #define MAX_FILTER_PRED 16384
1487 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1499 char pattern[MAX_FILTER_STR_VAL];
1502 regex_match_func match;
1505 static inline bool is_string_field(struct ftrace_event_field *field)
1507 return field->filter_type == FILTER_DYN_STRING ||
1508 field->filter_type == FILTER_RDYN_STRING ||
1509 field->filter_type == FILTER_STATIC_STRING ||
1510 field->filter_type == FILTER_PTR_STRING ||
1511 field->filter_type == FILTER_COMM;
1514 static inline bool is_function_field(struct ftrace_event_field *field)
1516 return field->filter_type == FILTER_TRACE_FN;
1519 extern enum regex_type
1520 filter_parse_regex(char *buff, int len, char **search, int *not);
1521 extern void print_event_filter(struct trace_event_file *file,
1522 struct trace_seq *s);
1523 extern int apply_event_filter(struct trace_event_file *file,
1524 char *filter_string);
1525 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1526 char *filter_string);
1527 extern void print_subsystem_event_filter(struct event_subsystem *system,
1528 struct trace_seq *s);
1529 extern int filter_assign_type(const char *type);
1530 extern int create_event_filter(struct trace_array *tr,
1531 struct trace_event_call *call,
1532 char *filter_str, bool set_str,
1533 struct event_filter **filterp);
1534 extern void free_event_filter(struct event_filter *filter);
1536 struct ftrace_event_field *
1537 trace_find_event_field(struct trace_event_call *call, char *name);
1539 extern void trace_event_enable_cmd_record(bool enable);
1540 extern void trace_event_enable_tgid_record(bool enable);
1542 extern int event_trace_init(void);
1543 extern int init_events(void);
1544 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1545 extern int event_trace_del_tracer(struct trace_array *tr);
1546 extern void __trace_early_add_events(struct trace_array *tr);
1548 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1551 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1555 static inline void *event_file_data(struct file *filp)
1557 return READ_ONCE(file_inode(filp)->i_private);
1560 extern struct mutex event_mutex;
1561 extern struct list_head ftrace_events;
1563 extern const struct file_operations event_trigger_fops;
1564 extern const struct file_operations event_hist_fops;
1565 extern const struct file_operations event_hist_debug_fops;
1566 extern const struct file_operations event_inject_fops;
1568 #ifdef CONFIG_HIST_TRIGGERS
1569 extern int register_trigger_hist_cmd(void);
1570 extern int register_trigger_hist_enable_disable_cmds(void);
1572 static inline int register_trigger_hist_cmd(void) { return 0; }
1573 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1576 extern int register_trigger_cmds(void);
1577 extern void clear_event_triggers(struct trace_array *tr);
1580 EVENT_TRIGGER_FL_PROBE = BIT(0),
1583 struct event_trigger_data {
1584 unsigned long count;
1587 struct event_trigger_ops *ops;
1588 struct event_command *cmd_ops;
1589 struct event_filter __rcu *filter;
1594 struct list_head list;
1596 struct list_head named_list;
1597 struct event_trigger_data *named_data;
1601 #define ENABLE_EVENT_STR "enable_event"
1602 #define DISABLE_EVENT_STR "disable_event"
1603 #define ENABLE_HIST_STR "enable_hist"
1604 #define DISABLE_HIST_STR "disable_hist"
1606 struct enable_trigger_data {
1607 struct trace_event_file *file;
1612 extern int event_enable_trigger_print(struct seq_file *m,
1613 struct event_trigger_data *data);
1614 extern void event_enable_trigger_free(struct event_trigger_data *data);
1615 extern int event_enable_trigger_parse(struct event_command *cmd_ops,
1616 struct trace_event_file *file,
1617 char *glob, char *cmd,
1618 char *param_and_filter);
1619 extern int event_enable_register_trigger(char *glob,
1620 struct event_trigger_data *data,
1621 struct trace_event_file *file);
1622 extern void event_enable_unregister_trigger(char *glob,
1623 struct event_trigger_data *test,
1624 struct trace_event_file *file);
1625 extern void trigger_data_free(struct event_trigger_data *data);
1626 extern int event_trigger_init(struct event_trigger_data *data);
1627 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1628 int trigger_enable);
1629 extern void update_cond_flag(struct trace_event_file *file);
1630 extern int set_trigger_filter(char *filter_str,
1631 struct event_trigger_data *trigger_data,
1632 struct trace_event_file *file);
1633 extern struct event_trigger_data *find_named_trigger(const char *name);
1634 extern bool is_named_trigger(struct event_trigger_data *test);
1635 extern int save_named_trigger(const char *name,
1636 struct event_trigger_data *data);
1637 extern void del_named_trigger(struct event_trigger_data *data);
1638 extern void pause_named_trigger(struct event_trigger_data *data);
1639 extern void unpause_named_trigger(struct event_trigger_data *data);
1640 extern void set_named_trigger_data(struct event_trigger_data *data,
1641 struct event_trigger_data *named_data);
1642 extern struct event_trigger_data *
1643 get_named_trigger_data(struct event_trigger_data *data);
1644 extern int register_event_command(struct event_command *cmd);
1645 extern int unregister_event_command(struct event_command *cmd);
1646 extern int register_trigger_hist_enable_disable_cmds(void);
1647 extern bool event_trigger_check_remove(const char *glob);
1648 extern bool event_trigger_empty_param(const char *param);
1649 extern int event_trigger_separate_filter(char *param_and_filter, char **param,
1650 char **filter, bool param_required);
1651 extern struct event_trigger_data *
1652 event_trigger_alloc(struct event_command *cmd_ops,
1655 void *private_data);
1656 extern int event_trigger_parse_num(char *trigger,
1657 struct event_trigger_data *trigger_data);
1658 extern int event_trigger_set_filter(struct event_command *cmd_ops,
1659 struct trace_event_file *file,
1661 struct event_trigger_data *trigger_data);
1662 extern void event_trigger_reset_filter(struct event_command *cmd_ops,
1663 struct event_trigger_data *trigger_data);
1664 extern int event_trigger_register(struct event_command *cmd_ops,
1665 struct trace_event_file *file,
1667 struct event_trigger_data *trigger_data);
1668 extern void event_trigger_unregister(struct event_command *cmd_ops,
1669 struct trace_event_file *file,
1671 struct event_trigger_data *trigger_data);
1673 extern void event_file_get(struct trace_event_file *file);
1674 extern void event_file_put(struct trace_event_file *file);
1677 * struct event_trigger_ops - callbacks for trace event triggers
1679 * The methods in this structure provide per-event trigger hooks for
1680 * various trigger operations.
1682 * The @init and @free methods are used during trigger setup and
1683 * teardown, typically called from an event_command's @parse()
1684 * function implementation.
1686 * The @print method is used to print the trigger spec.
1688 * The @trigger method is the function that actually implements the
1689 * trigger and is called in the context of the triggering event
1690 * whenever that event occurs.
1692 * All the methods below, except for @init() and @free(), must be
1695 * @trigger: The trigger 'probe' function called when the triggering
1696 * event occurs. The data passed into this callback is the data
1697 * that was supplied to the event_command @reg() function that
1698 * registered the trigger (see struct event_command) along with
1699 * the trace record, rec.
1701 * @init: An optional initialization function called for the trigger
1702 * when the trigger is registered (via the event_command reg()
1703 * function). This can be used to perform per-trigger
1704 * initialization such as incrementing a per-trigger reference
1705 * count, for instance. This is usually implemented by the
1706 * generic utility function @event_trigger_init() (see
1707 * trace_event_triggers.c).
1709 * @free: An optional de-initialization function called for the
1710 * trigger when the trigger is unregistered (via the
1711 * event_command @reg() function). This can be used to perform
1712 * per-trigger de-initialization such as decrementing a
1713 * per-trigger reference count and freeing corresponding trigger
1714 * data, for instance. This is usually implemented by the
1715 * generic utility function @event_trigger_free() (see
1716 * trace_event_triggers.c).
1718 * @print: The callback function invoked to have the trigger print
1719 * itself. This is usually implemented by a wrapper function
1720 * that calls the generic utility function @event_trigger_print()
1721 * (see trace_event_triggers.c).
1723 struct event_trigger_ops {
1724 void (*trigger)(struct event_trigger_data *data,
1725 struct trace_buffer *buffer,
1727 struct ring_buffer_event *rbe);
1728 int (*init)(struct event_trigger_data *data);
1729 void (*free)(struct event_trigger_data *data);
1730 int (*print)(struct seq_file *m,
1731 struct event_trigger_data *data);
1735 * struct event_command - callbacks and data members for event commands
1737 * Event commands are invoked by users by writing the command name
1738 * into the 'trigger' file associated with a trace event. The
1739 * parameters associated with a specific invocation of an event
1740 * command are used to create an event trigger instance, which is
1741 * added to the list of trigger instances associated with that trace
1742 * event. When the event is hit, the set of triggers associated with
1743 * that event is invoked.
1745 * The data members in this structure provide per-event command data
1746 * for various event commands.
1748 * All the data members below, except for @post_trigger, must be set
1749 * for each event command.
1751 * @name: The unique name that identifies the event command. This is
1752 * the name used when setting triggers via trigger files.
1754 * @trigger_type: A unique id that identifies the event command
1755 * 'type'. This value has two purposes, the first to ensure that
1756 * only one trigger of the same type can be set at a given time
1757 * for a particular event e.g. it doesn't make sense to have both
1758 * a traceon and traceoff trigger attached to a single event at
1759 * the same time, so traceon and traceoff have the same type
1760 * though they have different names. The @trigger_type value is
1761 * also used as a bit value for deferring the actual trigger
1762 * action until after the current event is finished. Some
1763 * commands need to do this if they themselves log to the trace
1764 * buffer (see the @post_trigger() member below). @trigger_type
1765 * values are defined by adding new values to the trigger_type
1766 * enum in include/linux/trace_events.h.
1768 * @flags: See the enum event_command_flags below.
1770 * All the methods below, except for @set_filter() and @unreg_all(),
1771 * must be implemented.
1773 * @parse: The callback function responsible for parsing and
1774 * registering the trigger written to the 'trigger' file by the
1775 * user. It allocates the trigger instance and registers it with
1776 * the appropriate trace event. It makes use of the other
1777 * event_command callback functions to orchestrate this, and is
1778 * usually implemented by the generic utility function
1779 * @event_trigger_callback() (see trace_event_triggers.c).
1781 * @reg: Adds the trigger to the list of triggers associated with the
1782 * event, and enables the event trigger itself, after
1783 * initializing it (via the event_trigger_ops @init() function).
1784 * This is also where commands can use the @trigger_type value to
1785 * make the decision as to whether or not multiple instances of
1786 * the trigger should be allowed. This is usually implemented by
1787 * the generic utility function @register_trigger() (see
1788 * trace_event_triggers.c).
1790 * @unreg: Removes the trigger from the list of triggers associated
1791 * with the event, and disables the event trigger itself, after
1792 * initializing it (via the event_trigger_ops @free() function).
1793 * This is usually implemented by the generic utility function
1794 * @unregister_trigger() (see trace_event_triggers.c).
1796 * @unreg_all: An optional function called to remove all the triggers
1797 * from the list of triggers associated with the event. Called
1798 * when a trigger file is opened in truncate mode.
1800 * @set_filter: An optional function called to parse and set a filter
1801 * for the trigger. If no @set_filter() method is set for the
1802 * event command, filters set by the user for the command will be
1803 * ignored. This is usually implemented by the generic utility
1804 * function @set_trigger_filter() (see trace_event_triggers.c).
1806 * @get_trigger_ops: The callback function invoked to retrieve the
1807 * event_trigger_ops implementation associated with the command.
1808 * This callback function allows a single event_command to
1809 * support multiple trigger implementations via different sets of
1810 * event_trigger_ops, depending on the value of the @param
1813 struct event_command {
1814 struct list_head list;
1816 enum event_trigger_type trigger_type;
1818 int (*parse)(struct event_command *cmd_ops,
1819 struct trace_event_file *file,
1820 char *glob, char *cmd,
1821 char *param_and_filter);
1822 int (*reg)(char *glob,
1823 struct event_trigger_data *data,
1824 struct trace_event_file *file);
1825 void (*unreg)(char *glob,
1826 struct event_trigger_data *data,
1827 struct trace_event_file *file);
1828 void (*unreg_all)(struct trace_event_file *file);
1829 int (*set_filter)(char *filter_str,
1830 struct event_trigger_data *data,
1831 struct trace_event_file *file);
1832 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1836 * enum event_command_flags - flags for struct event_command
1838 * @POST_TRIGGER: A flag that says whether or not this command needs
1839 * to have its action delayed until after the current event has
1840 * been closed. Some triggers need to avoid being invoked while
1841 * an event is currently in the process of being logged, since
1842 * the trigger may itself log data into the trace buffer. Thus
1843 * we make sure the current event is committed before invoking
1844 * those triggers. To do that, the trigger invocation is split
1845 * in two - the first part checks the filter using the current
1846 * trace record; if a command has the @post_trigger flag set, it
1847 * sets a bit for itself in the return value, otherwise it
1848 * directly invokes the trigger. Once all commands have been
1849 * either invoked or set their return flag, the current record is
1850 * either committed or discarded. At that point, if any commands
1851 * have deferred their triggers, those commands are finally
1852 * invoked following the close of the current event. In other
1853 * words, if the event_trigger_ops @func() probe implementation
1854 * itself logs to the trace buffer, this flag should be set,
1855 * otherwise it can be left unspecified.
1857 * @NEEDS_REC: A flag that says whether or not this command needs
1858 * access to the trace record in order to perform its function,
1859 * regardless of whether or not it has a filter associated with
1860 * it (filters make a trigger require access to the trace record
1861 * but are not always present).
1863 enum event_command_flags {
1864 EVENT_CMD_FL_POST_TRIGGER = 1,
1865 EVENT_CMD_FL_NEEDS_REC = 2,
1868 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1870 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1873 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1875 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1878 extern int trace_event_enable_disable(struct trace_event_file *file,
1879 int enable, int soft_disable);
1880 extern int tracing_alloc_snapshot(void);
1881 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1882 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1884 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1885 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1887 extern const char *__start___trace_bprintk_fmt[];
1888 extern const char *__stop___trace_bprintk_fmt[];
1890 extern const char *__start___tracepoint_str[];
1891 extern const char *__stop___tracepoint_str[];
1893 void trace_printk_control(bool enabled);
1894 void trace_printk_start_comm(void);
1895 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1896 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1898 /* Used from boot time tracer */
1899 extern int trace_set_options(struct trace_array *tr, char *option);
1900 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1901 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1902 unsigned long size, int cpu_id);
1903 extern int tracing_set_cpumask(struct trace_array *tr,
1904 cpumask_var_t tracing_cpumask_new);
1907 #define MAX_EVENT_NAME_LEN 64
1909 extern ssize_t trace_parse_run_command(struct file *file,
1910 const char __user *buffer, size_t count, loff_t *ppos,
1911 int (*createfn)(const char *));
1913 extern unsigned int err_pos(char *cmd, const char *str);
1914 extern void tracing_log_err(struct trace_array *tr,
1915 const char *loc, const char *cmd,
1916 const char **errs, u8 type, u16 pos);
1919 * Normal trace_printk() and friends allocates special buffers
1920 * to do the manipulation, as well as saves the print formats
1921 * into sections to display. But the trace infrastructure wants
1922 * to use these without the added overhead at the price of being
1923 * a bit slower (used mainly for warnings, where we don't care
1924 * about performance). The internal_trace_puts() is for such
1927 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1930 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1931 extern struct trace_event_call \
1932 __aligned(4) event_##call;
1933 #undef FTRACE_ENTRY_DUP
1934 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1935 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1936 #undef FTRACE_ENTRY_PACKED
1937 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1938 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1940 #include "trace_entries.h"
1942 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1943 int perf_ftrace_event_register(struct trace_event_call *call,
1944 enum trace_reg type, void *data);
1946 #define perf_ftrace_event_register NULL
1949 #ifdef CONFIG_FTRACE_SYSCALLS
1950 void init_ftrace_syscalls(void);
1951 const char *get_syscall_name(int syscall);
1953 static inline void init_ftrace_syscalls(void) { }
1954 static inline const char *get_syscall_name(int syscall)
1960 #ifdef CONFIG_EVENT_TRACING
1961 void trace_event_init(void);
1962 void trace_event_eval_update(struct trace_eval_map **map, int len);
1963 /* Used from boot time tracer */
1964 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1965 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1967 static inline void __init trace_event_init(void) { }
1968 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1971 #ifdef CONFIG_TRACER_SNAPSHOT
1972 void tracing_snapshot_instance(struct trace_array *tr);
1973 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1975 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1976 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1982 #ifdef CONFIG_PREEMPT_TRACER
1983 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1984 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1986 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1987 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1989 #ifdef CONFIG_IRQSOFF_TRACER
1990 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1991 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1993 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1994 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1998 * Reset the state of the trace_iterator so that it can read consumed data.
1999 * Normally, the trace_iterator is used for reading the data when it is not
2000 * consumed, and must retain state.
2002 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
2004 memset_startat(iter, 0, seq);
2008 /* Check the name is good for event/group/fields */
2009 static inline bool __is_good_name(const char *name, bool hash_ok)
2011 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-'))
2013 while (*++name != '\0') {
2014 if (!isalpha(*name) && !isdigit(*name) && *name != '_' &&
2015 (!hash_ok || *name != '-'))
2021 /* Check the name is good for event/group/fields */
2022 static inline bool is_good_name(const char *name)
2024 return __is_good_name(name, false);
2027 /* Check the name is good for system */
2028 static inline bool is_good_system_name(const char *name)
2030 return __is_good_name(name, true);
2033 /* Convert certain expected symbols into '_' when generating event names */
2034 static inline void sanitize_event_name(char *name)
2036 while (*name++ != '\0')
2037 if (*name == ':' || *name == '.')
2042 * This is a generic way to read and write a u64 value from a file in tracefs.
2044 * The value is stored on the variable pointed by *val. The value needs
2045 * to be at least *min and at most *max. The write is protected by an
2048 struct trace_min_max_param {
2055 #define U64_STR_SIZE 24 /* 20 digits max */
2057 extern const struct file_operations trace_min_max_fops;
2060 extern int rv_init_interface(void);
2062 static inline int rv_init_interface(void)
2068 #endif /* _LINUX_KERNEL_TRACE_H */