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>
25 #ifdef CONFIG_FTRACE_SYSCALLS
26 #include <asm/unistd.h> /* For NR_SYSCALLS */
27 #include <asm/syscall.h> /* some archs define it here */
31 __TRACE_FIRST_TYPE = 0,
58 #define __field(type, item) type item;
61 #define __field_fn(type, item) type item;
64 #define __field_struct(type, item) __field(type, item)
67 #define __field_desc(type, container, item)
70 #define __field_packed(type, container, item)
73 #define __array(type, item, size) type item[size];
76 #define __array_desc(type, container, item, size)
78 #undef __dynamic_array
79 #define __dynamic_array(type, item) type item[];
82 #define F_STRUCT(args...) args
85 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
86 struct struct_name { \
87 struct trace_entry ent; \
91 #undef FTRACE_ENTRY_DUP
92 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
94 #undef FTRACE_ENTRY_REG
95 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
96 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
98 #undef FTRACE_ENTRY_PACKED
99 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
100 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
102 #include "trace_entries.h"
104 /* Use this for memory failure errors */
105 #define MEM_FAIL(condition, fmt, ...) \
106 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__)
109 * syscalls are special, and need special handling, this is why
110 * they are not included in trace_entries.h
112 struct syscall_trace_enter {
113 struct trace_entry ent;
115 unsigned long args[];
118 struct syscall_trace_exit {
119 struct trace_entry ent;
124 struct kprobe_trace_entry_head {
125 struct trace_entry ent;
129 struct kretprobe_trace_entry_head {
130 struct trace_entry ent;
132 unsigned long ret_ip;
135 #define TRACE_BUF_SIZE 1024
140 * The CPU trace array - it consists of thousands of trace entries
141 * plus some other descriptor data: (for example which task started
144 struct trace_array_cpu {
146 void *buffer_page; /* ring buffer spare */
148 unsigned long entries;
149 unsigned long saved_latency;
150 unsigned long critical_start;
151 unsigned long critical_end;
152 unsigned long critical_sequence;
154 unsigned long policy;
155 unsigned long rt_priority;
156 unsigned long skipped_entries;
157 u64 preempt_timestamp;
160 char comm[TASK_COMM_LEN];
162 #ifdef CONFIG_FUNCTION_TRACER
163 int ftrace_ignore_pid;
169 struct trace_option_dentry;
171 struct array_buffer {
172 struct trace_array *tr;
173 struct trace_buffer *buffer;
174 struct trace_array_cpu __percpu *data;
179 #define TRACE_FLAGS_MAX_SIZE 32
181 struct trace_options {
182 struct tracer *tracer;
183 struct trace_option_dentry *topts;
186 struct trace_pid_list {
193 TRACE_NO_PIDS = BIT(1),
196 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
197 struct trace_pid_list *no_pid_list)
199 /* Return true if the pid list in type has pids */
200 return ((type & TRACE_PIDS) && pid_list) ||
201 ((type & TRACE_NO_PIDS) && no_pid_list);
204 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
205 struct trace_pid_list *no_pid_list)
208 * Turning off what is in @type, return true if the "other"
209 * pid list, still has pids in it.
211 return (!(type & TRACE_PIDS) && pid_list) ||
212 (!(type & TRACE_NO_PIDS) && no_pid_list);
215 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
218 * struct cond_snapshot - conditional snapshot data and callback
220 * The cond_snapshot structure encapsulates a callback function and
221 * data associated with the snapshot for a given tracing instance.
223 * When a snapshot is taken conditionally, by invoking
224 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
225 * passed in turn to the cond_snapshot.update() function. That data
226 * can be compared by the update() implementation with the cond_data
227 * contained within the struct cond_snapshot instance associated with
228 * the trace_array. Because the tr->max_lock is held throughout the
229 * update() call, the update() function can directly retrieve the
230 * cond_snapshot and cond_data associated with the per-instance
231 * snapshot associated with the trace_array.
233 * The cond_snapshot.update() implementation can save data to be
234 * associated with the snapshot if it decides to, and returns 'true'
235 * in that case, or it returns 'false' if the conditional snapshot
236 * shouldn't be taken.
238 * The cond_snapshot instance is created and associated with the
239 * user-defined cond_data by tracing_cond_snapshot_enable().
240 * Likewise, the cond_snapshot instance is destroyed and is no longer
241 * associated with the trace instance by
242 * tracing_cond_snapshot_disable().
244 * The method below is required.
246 * @update: When a conditional snapshot is invoked, the update()
247 * callback function is invoked with the tr->max_lock held. The
248 * update() implementation signals whether or not to actually
249 * take the snapshot, by returning 'true' if so, 'false' if no
250 * snapshot should be taken. Because the max_lock is held for
251 * the duration of update(), the implementation is safe to
252 * directly retrieved and save any implementation data it needs
253 * to in association with the snapshot.
255 struct cond_snapshot {
257 cond_update_fn_t update;
261 * struct trace_func_repeats - used to keep track of the consecutive
262 * (on the same CPU) calls of a single function.
264 struct trace_func_repeats {
266 unsigned long parent_ip;
272 * The trace array - an array of per-CPU trace arrays. This is the
273 * highest level data structure that individual tracers deal with.
274 * They have on/off state as well:
277 struct list_head list;
279 struct array_buffer array_buffer;
280 #ifdef CONFIG_TRACER_MAX_TRACE
282 * The max_buffer is used to snapshot the trace when a maximum
283 * latency is reached, or when the user initiates a snapshot.
284 * Some tracers will use this to store a maximum trace while
285 * it continues examining live traces.
287 * The buffers for the max_buffer are set up the same as the array_buffer
288 * When a snapshot is taken, the buffer of the max_buffer is swapped
289 * with the buffer of the array_buffer and the buffers are reset for
290 * the array_buffer so the tracing can continue.
292 struct array_buffer max_buffer;
293 bool allocated_snapshot;
295 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER) \
296 || defined(CONFIG_OSNOISE_TRACER)
297 unsigned long max_latency;
298 #ifdef CONFIG_FSNOTIFY
299 struct dentry *d_max_latency;
300 struct work_struct fsnotify_work;
301 struct irq_work fsnotify_irqwork;
304 struct trace_pid_list __rcu *filtered_pids;
305 struct trace_pid_list __rcu *filtered_no_pids;
307 * max_lock is used to protect the swapping of buffers
308 * when taking a max snapshot. The buffers themselves are
309 * protected by per_cpu spinlocks. But the action of the swap
310 * needs its own lock.
312 * This is defined as a arch_spinlock_t in order to help
313 * with performance when lockdep debugging is enabled.
315 * It is also used in other places outside the update_max_tr
316 * so it needs to be defined outside of the
317 * CONFIG_TRACER_MAX_TRACE.
319 arch_spinlock_t max_lock;
321 #ifdef CONFIG_FTRACE_SYSCALLS
322 int sys_refcount_enter;
323 int sys_refcount_exit;
324 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
325 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
332 unsigned int n_err_log_entries;
333 struct tracer *current_trace;
334 unsigned int trace_flags;
335 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
337 raw_spinlock_t start_lock;
338 struct list_head err_log;
340 struct dentry *options;
341 struct dentry *percpu_dir;
342 struct dentry *event_dir;
343 struct trace_options *topts;
344 struct list_head systems;
345 struct list_head events;
346 struct trace_event_file *trace_marker_file;
347 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
350 #ifdef CONFIG_FUNCTION_TRACER
351 struct ftrace_ops *ops;
352 struct trace_pid_list __rcu *function_pids;
353 struct trace_pid_list __rcu *function_no_pids;
354 #ifdef CONFIG_DYNAMIC_FTRACE
355 /* All of these are protected by the ftrace_lock */
356 struct list_head func_probes;
357 struct list_head mod_trace;
358 struct list_head mod_notrace;
360 /* function tracing enabled */
361 int function_enabled;
363 int no_filter_buffering_ref;
364 struct list_head hist_vars;
365 #ifdef CONFIG_TRACER_SNAPSHOT
366 struct cond_snapshot *cond_snapshot;
368 struct trace_func_repeats __percpu *last_func_repeats;
372 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
375 extern struct list_head ftrace_trace_arrays;
377 extern struct mutex trace_types_lock;
379 extern int trace_array_get(struct trace_array *tr);
380 extern int tracing_check_open_get_tr(struct trace_array *tr);
381 extern struct trace_array *trace_array_find(const char *instance);
382 extern struct trace_array *trace_array_find_get(const char *instance);
384 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
385 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
386 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
388 extern bool trace_clock_in_ns(struct trace_array *tr);
391 * The global tracer (top) should be the first trace array added,
392 * but we check the flag anyway.
394 static inline struct trace_array *top_trace_array(void)
396 struct trace_array *tr;
398 if (list_empty(&ftrace_trace_arrays))
401 tr = list_entry(ftrace_trace_arrays.prev,
403 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
407 #define FTRACE_CMP_TYPE(var, type) \
408 __builtin_types_compatible_p(typeof(var), type *)
411 #define IF_ASSIGN(var, entry, etype, id) \
412 if (FTRACE_CMP_TYPE(var, etype)) { \
413 var = (typeof(var))(entry); \
414 WARN_ON(id != 0 && (entry)->type != id); \
418 /* Will cause compile errors if type is not found. */
419 extern void __ftrace_bad_type(void);
422 * The trace_assign_type is a verifier that the entry type is
423 * the same as the type being assigned. To add new types simply
424 * add a line with the following format:
426 * IF_ASSIGN(var, ent, type, id);
428 * Where "type" is the trace type that includes the trace_entry
429 * as the "ent" item. And "id" is the trace identifier that is
430 * used in the trace_type enum.
432 * If the type can have more than one id, then use zero.
434 #define trace_assign_type(var, ent) \
436 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
437 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
438 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
439 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
440 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
441 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
442 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
443 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
444 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
445 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
446 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
447 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
449 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
451 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
452 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
454 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
456 IF_ASSIGN(var, ent, struct func_repeats_entry, \
457 TRACE_FUNC_REPEATS); \
458 __ftrace_bad_type(); \
462 * An option specific to a tracer. This is a boolean value.
463 * The bit is the bit index that sets its value on the
464 * flags value in struct tracer_flags.
467 const char *name; /* Will appear on the trace_options file */
468 u32 bit; /* Mask assigned in val field in tracer_flags */
472 * The set of specific options for a tracer. Your tracer
473 * have to set the initial value of the flags val.
475 struct tracer_flags {
477 struct tracer_opt *opts;
478 struct tracer *trace;
481 /* Makes more easy to define a tracer opt */
482 #define TRACER_OPT(s, b) .name = #s, .bit = b
485 struct trace_option_dentry {
486 struct tracer_opt *opt;
487 struct tracer_flags *flags;
488 struct trace_array *tr;
489 struct dentry *entry;
493 * struct tracer - a specific tracer and its callbacks to interact with tracefs
494 * @name: the name chosen to select it on the available_tracers file
495 * @init: called when one switches to this tracer (echo name > current_tracer)
496 * @reset: called when one switches to another tracer
497 * @start: called when tracing is unpaused (echo 1 > tracing_on)
498 * @stop: called when tracing is paused (echo 0 > tracing_on)
499 * @update_thresh: called when tracing_thresh is updated
500 * @open: called when the trace file is opened
501 * @pipe_open: called when the trace_pipe file is opened
502 * @close: called when the trace file is released
503 * @pipe_close: called when the trace_pipe file is released
504 * @read: override the default read callback on trace_pipe
505 * @splice_read: override the default splice_read callback on trace_pipe
506 * @selftest: selftest to run on boot (see trace_selftest.c)
507 * @print_headers: override the first lines that describe your columns
508 * @print_line: callback that prints a trace
509 * @set_flag: signals one of your private flags changed (trace_options file)
510 * @flags: your private flags
514 int (*init)(struct trace_array *tr);
515 void (*reset)(struct trace_array *tr);
516 void (*start)(struct trace_array *tr);
517 void (*stop)(struct trace_array *tr);
518 int (*update_thresh)(struct trace_array *tr);
519 void (*open)(struct trace_iterator *iter);
520 void (*pipe_open)(struct trace_iterator *iter);
521 void (*close)(struct trace_iterator *iter);
522 void (*pipe_close)(struct trace_iterator *iter);
523 ssize_t (*read)(struct trace_iterator *iter,
524 struct file *filp, char __user *ubuf,
525 size_t cnt, loff_t *ppos);
526 ssize_t (*splice_read)(struct trace_iterator *iter,
529 struct pipe_inode_info *pipe,
532 #ifdef CONFIG_FTRACE_STARTUP_TEST
533 int (*selftest)(struct tracer *trace,
534 struct trace_array *tr);
536 void (*print_header)(struct seq_file *m);
537 enum print_line_t (*print_line)(struct trace_iterator *iter);
538 /* If you handled the flag setting, return 0 */
539 int (*set_flag)(struct trace_array *tr,
540 u32 old_flags, u32 bit, int set);
541 /* Return 0 if OK with change, else return non-zero */
542 int (*flag_changed)(struct trace_array *tr,
545 struct tracer_flags *flags;
548 bool allow_instances;
549 #ifdef CONFIG_TRACER_MAX_TRACE
552 /* True if tracer cannot be enabled in kernel param */
556 static inline struct ring_buffer_iter *
557 trace_buffer_iter(struct trace_iterator *iter, int cpu)
559 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
562 int tracer_init(struct tracer *t, struct trace_array *tr);
563 int tracing_is_enabled(void);
564 void tracing_reset_online_cpus(struct array_buffer *buf);
565 void tracing_reset_current(int cpu);
566 void tracing_reset_all_online_cpus(void);
567 int tracing_open_generic(struct inode *inode, struct file *filp);
568 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
569 bool tracing_is_disabled(void);
570 bool tracer_tracing_is_on(struct trace_array *tr);
571 void tracer_tracing_on(struct trace_array *tr);
572 void tracer_tracing_off(struct trace_array *tr);
573 struct dentry *trace_create_file(const char *name,
575 struct dentry *parent,
577 const struct file_operations *fops);
579 int tracing_init_dentry(void);
581 struct ring_buffer_event;
583 struct ring_buffer_event *
584 trace_buffer_lock_reserve(struct trace_buffer *buffer,
587 unsigned int trace_ctx);
589 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
590 struct trace_array_cpu *data);
592 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
593 int *ent_cpu, u64 *ent_ts);
595 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
596 struct ring_buffer_event *event);
598 bool trace_is_tracepoint_string(const char *str);
599 const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
600 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
603 int trace_empty(struct trace_iterator *iter);
605 void *trace_find_next_entry_inc(struct trace_iterator *iter);
607 void trace_init_global_iter(struct trace_iterator *iter);
609 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
611 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
612 unsigned long trace_total_entries(struct trace_array *tr);
614 void trace_function(struct trace_array *tr,
616 unsigned long parent_ip,
617 unsigned int trace_ctx);
618 void trace_graph_function(struct trace_array *tr,
620 unsigned long parent_ip,
621 unsigned int trace_ctx);
622 void trace_latency_header(struct seq_file *m);
623 void trace_default_header(struct seq_file *m);
624 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
626 void trace_graph_return(struct ftrace_graph_ret *trace);
627 int trace_graph_entry(struct ftrace_graph_ent *trace);
628 void set_graph_array(struct trace_array *tr);
630 void tracing_start_cmdline_record(void);
631 void tracing_stop_cmdline_record(void);
632 void tracing_start_tgid_record(void);
633 void tracing_stop_tgid_record(void);
635 int register_tracer(struct tracer *type);
636 int is_tracing_stopped(void);
638 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
640 extern cpumask_var_t __read_mostly tracing_buffer_mask;
642 #define for_each_tracing_cpu(cpu) \
643 for_each_cpu(cpu, tracing_buffer_mask)
645 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
647 extern unsigned long tracing_thresh;
653 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
655 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
656 struct trace_pid_list *filtered_no_pids,
657 struct task_struct *task);
658 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
659 struct task_struct *self,
660 struct task_struct *task);
661 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
662 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
663 int trace_pid_show(struct seq_file *m, void *v);
664 void trace_free_pid_list(struct trace_pid_list *pid_list);
665 int trace_pid_write(struct trace_pid_list *filtered_pids,
666 struct trace_pid_list **new_pid_list,
667 const char __user *ubuf, size_t cnt);
669 #ifdef CONFIG_TRACER_MAX_TRACE
670 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
672 void update_max_tr_single(struct trace_array *tr,
673 struct task_struct *tsk, int cpu);
674 #endif /* CONFIG_TRACER_MAX_TRACE */
676 #if (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER) \
677 || defined(CONFIG_OSNOISE_TRACER)) && defined(CONFIG_FSNOTIFY)
678 #define LATENCY_FS_NOTIFY
681 #ifdef LATENCY_FS_NOTIFY
682 void latency_fsnotify(struct trace_array *tr);
684 static inline void latency_fsnotify(struct trace_array *tr) { }
687 #ifdef CONFIG_STACKTRACE
688 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
690 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
694 #endif /* CONFIG_STACKTRACE */
696 void trace_last_func_repeats(struct trace_array *tr,
697 struct trace_func_repeats *last_info,
698 unsigned int trace_ctx);
700 extern u64 ftrace_now(int cpu);
702 extern void trace_find_cmdline(int pid, char comm[]);
703 extern int trace_find_tgid(int pid);
704 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
706 #ifdef CONFIG_DYNAMIC_FTRACE
707 extern unsigned long ftrace_update_tot_cnt;
708 extern unsigned long ftrace_number_of_pages;
709 extern unsigned long ftrace_number_of_groups;
710 void ftrace_init_trace_array(struct trace_array *tr);
712 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
714 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
715 extern int DYN_FTRACE_TEST_NAME(void);
716 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
717 extern int DYN_FTRACE_TEST_NAME2(void);
719 extern bool ring_buffer_expanded;
720 extern bool tracing_selftest_disabled;
722 #ifdef CONFIG_FTRACE_STARTUP_TEST
723 extern void __init disable_tracing_selftest(const char *reason);
725 extern int trace_selftest_startup_function(struct tracer *trace,
726 struct trace_array *tr);
727 extern int trace_selftest_startup_function_graph(struct tracer *trace,
728 struct trace_array *tr);
729 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
730 struct trace_array *tr);
731 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
732 struct trace_array *tr);
733 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
734 struct trace_array *tr);
735 extern int trace_selftest_startup_wakeup(struct tracer *trace,
736 struct trace_array *tr);
737 extern int trace_selftest_startup_nop(struct tracer *trace,
738 struct trace_array *tr);
739 extern int trace_selftest_startup_branch(struct tracer *trace,
740 struct trace_array *tr);
742 * Tracer data references selftest functions that only occur
743 * on boot up. These can be __init functions. Thus, when selftests
744 * are enabled, then the tracers need to reference __init functions.
746 #define __tracer_data __refdata
748 static inline void __init disable_tracing_selftest(const char *reason)
751 /* Tracers are seldom changed. Optimize when selftests are disabled. */
752 #define __tracer_data __read_mostly
753 #endif /* CONFIG_FTRACE_STARTUP_TEST */
755 extern void *head_page(struct trace_array_cpu *data);
756 extern unsigned long long ns2usecs(u64 nsec);
758 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
760 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
762 trace_array_vprintk(struct trace_array *tr,
763 unsigned long ip, const char *fmt, va_list args);
764 int trace_array_printk_buf(struct trace_buffer *buffer,
765 unsigned long ip, const char *fmt, ...);
766 void trace_printk_seq(struct trace_seq *s);
767 enum print_line_t print_trace_line(struct trace_iterator *iter);
769 extern char trace_find_mark(unsigned long long duration);
773 struct ftrace_mod_load {
774 struct list_head list;
781 FTRACE_HASH_FL_MOD = (1 << 0),
785 unsigned long size_bits;
786 struct hlist_head *buckets;
792 struct ftrace_func_entry *
793 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
795 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
797 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
800 /* Standard output formatting function used for function return traces */
801 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
804 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
805 #define TRACE_GRAPH_PRINT_CPU 0x2
806 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
807 #define TRACE_GRAPH_PRINT_PROC 0x8
808 #define TRACE_GRAPH_PRINT_DURATION 0x10
809 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
810 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
811 #define TRACE_GRAPH_PRINT_IRQS 0x80
812 #define TRACE_GRAPH_PRINT_TAIL 0x100
813 #define TRACE_GRAPH_SLEEP_TIME 0x200
814 #define TRACE_GRAPH_GRAPH_TIME 0x400
815 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
816 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
818 extern void ftrace_graph_sleep_time_control(bool enable);
820 #ifdef CONFIG_FUNCTION_PROFILER
821 extern void ftrace_graph_graph_time_control(bool enable);
823 static inline void ftrace_graph_graph_time_control(bool enable) { }
826 extern enum print_line_t
827 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
828 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
830 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
831 extern void graph_trace_open(struct trace_iterator *iter);
832 extern void graph_trace_close(struct trace_iterator *iter);
833 extern int __trace_graph_entry(struct trace_array *tr,
834 struct ftrace_graph_ent *trace,
835 unsigned int trace_ctx);
836 extern void __trace_graph_return(struct trace_array *tr,
837 struct ftrace_graph_ret *trace,
838 unsigned int trace_ctx);
840 #ifdef CONFIG_DYNAMIC_FTRACE
841 extern struct ftrace_hash __rcu *ftrace_graph_hash;
842 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
844 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
846 unsigned long addr = trace->func;
848 struct ftrace_hash *hash;
850 preempt_disable_notrace();
853 * Have to open code "rcu_dereference_sched()" because the
854 * function graph tracer can be called when RCU is not
856 * Protected with schedule_on_each_cpu(ftrace_sync)
858 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
860 if (ftrace_hash_empty(hash)) {
865 if (ftrace_lookup_ip(hash, addr)) {
868 * This needs to be cleared on the return functions
869 * when the depth is zero.
871 trace_recursion_set(TRACE_GRAPH_BIT);
872 trace_recursion_set_depth(trace->depth);
875 * If no irqs are to be traced, but a set_graph_function
876 * is set, and called by an interrupt handler, we still
880 trace_recursion_set(TRACE_IRQ_BIT);
882 trace_recursion_clear(TRACE_IRQ_BIT);
887 preempt_enable_notrace();
891 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
893 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
894 trace->depth == trace_recursion_depth())
895 trace_recursion_clear(TRACE_GRAPH_BIT);
898 static inline int ftrace_graph_notrace_addr(unsigned long addr)
901 struct ftrace_hash *notrace_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 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
914 if (ftrace_lookup_ip(notrace_hash, addr))
917 preempt_enable_notrace();
921 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
926 static inline int ftrace_graph_notrace_addr(unsigned long addr)
930 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
932 #endif /* CONFIG_DYNAMIC_FTRACE */
934 extern unsigned int fgraph_max_depth;
936 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
938 /* trace it when it is-nested-in or is a function enabled. */
939 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
940 ftrace_graph_addr(trace)) ||
941 (trace->depth < 0) ||
942 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
945 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
946 static inline enum print_line_t
947 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
949 return TRACE_TYPE_UNHANDLED;
951 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
953 extern struct list_head ftrace_pids;
955 #ifdef CONFIG_FUNCTION_TRACER
957 #define FTRACE_PID_IGNORE -1
958 #define FTRACE_PID_TRACE -2
960 struct ftrace_func_command {
961 struct list_head list;
963 int (*func)(struct trace_array *tr,
964 struct ftrace_hash *hash,
965 char *func, char *cmd,
966 char *params, int enable);
968 extern bool ftrace_filter_param __initdata;
969 static inline int ftrace_trace_task(struct trace_array *tr)
971 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
974 extern int ftrace_is_dead(void);
975 int ftrace_create_function_files(struct trace_array *tr,
976 struct dentry *parent);
977 void ftrace_destroy_function_files(struct trace_array *tr);
978 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
979 void ftrace_free_ftrace_ops(struct trace_array *tr);
980 void ftrace_init_global_array_ops(struct trace_array *tr);
981 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
982 void ftrace_reset_array_ops(struct trace_array *tr);
983 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
984 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
985 struct dentry *d_tracer);
986 void ftrace_clear_pids(struct trace_array *tr);
987 int init_function_trace(void);
988 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
990 static inline int ftrace_trace_task(struct trace_array *tr)
994 static inline int ftrace_is_dead(void) { return 0; }
996 ftrace_create_function_files(struct trace_array *tr,
997 struct dentry *parent)
1001 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1005 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1006 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1007 static inline __init void
1008 ftrace_init_global_array_ops(struct trace_array *tr) { }
1009 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1010 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1011 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1012 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1013 static inline int init_function_trace(void) { return 0; }
1014 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1015 /* ftace_func_t type is not defined, use macro instead of static inline */
1016 #define ftrace_init_array_ops(tr, func) do { } while (0)
1017 #endif /* CONFIG_FUNCTION_TRACER */
1019 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1021 struct ftrace_probe_ops {
1022 void (*func)(unsigned long ip,
1023 unsigned long parent_ip,
1024 struct trace_array *tr,
1025 struct ftrace_probe_ops *ops,
1027 int (*init)(struct ftrace_probe_ops *ops,
1028 struct trace_array *tr,
1029 unsigned long ip, void *init_data,
1031 void (*free)(struct ftrace_probe_ops *ops,
1032 struct trace_array *tr,
1033 unsigned long ip, void *data);
1034 int (*print)(struct seq_file *m,
1036 struct ftrace_probe_ops *ops,
1040 struct ftrace_func_mapper;
1041 typedef int (*ftrace_mapper_func)(void *data);
1043 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1044 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1046 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1047 unsigned long ip, void *data);
1048 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1050 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1051 ftrace_mapper_func free_func);
1054 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1055 struct ftrace_probe_ops *ops, void *data);
1057 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1058 struct ftrace_probe_ops *ops);
1059 extern void clear_ftrace_function_probes(struct trace_array *tr);
1061 int register_ftrace_command(struct ftrace_func_command *cmd);
1062 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1064 void ftrace_create_filter_files(struct ftrace_ops *ops,
1065 struct dentry *parent);
1066 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1068 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1069 int len, int reset);
1070 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1071 int len, int reset);
1073 struct ftrace_func_command;
1075 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1079 static inline __init int unregister_ftrace_command(char *cmd_name)
1083 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1088 * The ops parameter passed in is usually undefined.
1089 * This must be a macro.
1091 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1092 #define ftrace_destroy_filter_files(ops) do { } while (0)
1093 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1095 bool ftrace_event_is_function(struct trace_event_call *call);
1098 * struct trace_parser - servers for reading the user input separated by spaces
1099 * @cont: set if the input is not complete - no final space char was found
1100 * @buffer: holds the parsed user input
1101 * @idx: user input length
1102 * @size: buffer size
1104 struct trace_parser {
1111 static inline bool trace_parser_loaded(struct trace_parser *parser)
1113 return (parser->idx != 0);
1116 static inline bool trace_parser_cont(struct trace_parser *parser)
1118 return parser->cont;
1121 static inline void trace_parser_clear(struct trace_parser *parser)
1123 parser->cont = false;
1127 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1128 extern void trace_parser_put(struct trace_parser *parser);
1129 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1130 size_t cnt, loff_t *ppos);
1133 * Only create function graph options if function graph is configured.
1135 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1136 # define FGRAPH_FLAGS \
1137 C(DISPLAY_GRAPH, "display-graph"),
1139 # define FGRAPH_FLAGS
1142 #ifdef CONFIG_BRANCH_TRACER
1143 # define BRANCH_FLAGS \
1144 C(BRANCH, "branch"),
1146 # define BRANCH_FLAGS
1149 #ifdef CONFIG_FUNCTION_TRACER
1150 # define FUNCTION_FLAGS \
1151 C(FUNCTION, "function-trace"), \
1152 C(FUNC_FORK, "function-fork"),
1153 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1155 # define FUNCTION_FLAGS
1156 # define FUNCTION_DEFAULT_FLAGS 0UL
1157 # define TRACE_ITER_FUNC_FORK 0UL
1160 #ifdef CONFIG_STACKTRACE
1161 # define STACK_FLAGS \
1162 C(STACKTRACE, "stacktrace"),
1164 # define STACK_FLAGS
1168 * trace_iterator_flags is an enumeration that defines bit
1169 * positions into trace_flags that controls the output.
1171 * NOTE: These bits must match the trace_options array in
1172 * trace.c (this macro guarantees it).
1174 #define TRACE_FLAGS \
1175 C(PRINT_PARENT, "print-parent"), \
1176 C(SYM_OFFSET, "sym-offset"), \
1177 C(SYM_ADDR, "sym-addr"), \
1178 C(VERBOSE, "verbose"), \
1182 C(BLOCK, "block"), \
1183 C(PRINTK, "trace_printk"), \
1184 C(ANNOTATE, "annotate"), \
1185 C(USERSTACKTRACE, "userstacktrace"), \
1186 C(SYM_USEROBJ, "sym-userobj"), \
1187 C(PRINTK_MSGONLY, "printk-msg-only"), \
1188 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1189 C(LATENCY_FMT, "latency-format"), \
1190 C(RECORD_CMD, "record-cmd"), \
1191 C(RECORD_TGID, "record-tgid"), \
1192 C(OVERWRITE, "overwrite"), \
1193 C(STOP_ON_FREE, "disable_on_free"), \
1194 C(IRQ_INFO, "irq-info"), \
1195 C(MARKERS, "markers"), \
1196 C(EVENT_FORK, "event-fork"), \
1197 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1198 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1205 * By defining C, we can make TRACE_FLAGS a list of bit names
1206 * that will define the bits for the flag masks.
1209 #define C(a, b) TRACE_ITER_##a##_BIT
1211 enum trace_iterator_bits {
1213 /* Make sure we don't go more than we have bits for */
1218 * By redefining C, we can make TRACE_FLAGS a list of masks that
1219 * use the bits as defined above.
1222 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1224 enum trace_iterator_flags { TRACE_FLAGS };
1227 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1228 * control the output of kernel symbols.
1230 #define TRACE_ITER_SYM_MASK \
1231 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1233 extern struct tracer nop_trace;
1235 #ifdef CONFIG_BRANCH_TRACER
1236 extern int enable_branch_tracing(struct trace_array *tr);
1237 extern void disable_branch_tracing(void);
1238 static inline int trace_branch_enable(struct trace_array *tr)
1240 if (tr->trace_flags & TRACE_ITER_BRANCH)
1241 return enable_branch_tracing(tr);
1244 static inline void trace_branch_disable(void)
1246 /* due to races, always disable */
1247 disable_branch_tracing();
1250 static inline int trace_branch_enable(struct trace_array *tr)
1254 static inline void trace_branch_disable(void)
1257 #endif /* CONFIG_BRANCH_TRACER */
1259 /* set ring buffers to default size if not already done so */
1260 int tracing_update_buffers(void);
1262 struct ftrace_event_field {
1263 struct list_head link;
1274 struct event_filter {
1275 struct prog_entry __rcu *prog;
1276 char *filter_string;
1279 struct event_subsystem {
1280 struct list_head list;
1282 struct event_filter *filter;
1286 struct trace_subsystem_dir {
1287 struct list_head list;
1288 struct event_subsystem *subsystem;
1289 struct trace_array *tr;
1290 struct dentry *entry;
1295 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1296 struct trace_buffer *buffer,
1297 struct ring_buffer_event *event);
1299 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1300 struct trace_buffer *buffer,
1301 struct ring_buffer_event *event,
1302 unsigned int trcace_ctx,
1303 struct pt_regs *regs);
1305 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1306 struct trace_buffer *buffer,
1307 struct ring_buffer_event *event,
1308 unsigned int trace_ctx)
1310 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1313 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1314 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1315 void trace_buffered_event_disable(void);
1316 void trace_buffered_event_enable(void);
1319 __trace_event_discard_commit(struct trace_buffer *buffer,
1320 struct ring_buffer_event *event)
1322 if (this_cpu_read(trace_buffered_event) == event) {
1323 /* Simply release the temp buffer */
1324 this_cpu_dec(trace_buffered_event_cnt);
1327 ring_buffer_discard_commit(buffer, event);
1331 * Helper function for event_trigger_unlock_commit{_regs}().
1332 * If there are event triggers attached to this event that requires
1333 * filtering against its fields, then they will be called as the
1334 * entry already holds the field information of the current event.
1336 * It also checks if the event should be discarded or not.
1337 * It is to be discarded if the event is soft disabled and the
1338 * event was only recorded to process triggers, or if the event
1339 * filter is active and this event did not match the filters.
1341 * Returns true if the event is discarded, false otherwise.
1344 __event_trigger_test_discard(struct trace_event_file *file,
1345 struct trace_buffer *buffer,
1346 struct ring_buffer_event *event,
1348 enum event_trigger_type *tt)
1350 unsigned long eflags = file->flags;
1352 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1353 *tt = event_triggers_call(file, buffer, entry, event);
1355 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
1356 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
1357 !filter_match_preds(file->filter, entry))) {
1358 __trace_event_discard_commit(buffer, event);
1366 * event_trigger_unlock_commit - handle triggers and finish event commit
1367 * @file: The file pointer associated with the event
1368 * @buffer: The ring buffer that the event is being written to
1369 * @event: The event meta data in the ring buffer
1370 * @entry: The event itself
1371 * @trace_ctx: The tracing context flags.
1373 * This is a helper function to handle triggers that require data
1374 * from the event itself. It also tests the event against filters and
1375 * if the event is soft disabled and should be discarded.
1378 event_trigger_unlock_commit(struct trace_event_file *file,
1379 struct trace_buffer *buffer,
1380 struct ring_buffer_event *event,
1381 void *entry, unsigned int trace_ctx)
1383 enum event_trigger_type tt = ETT_NONE;
1385 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1386 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1389 event_triggers_post_call(file, tt);
1393 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1394 * @file: The file pointer associated with the event
1395 * @buffer: The ring buffer that the event is being written to
1396 * @event: The event meta data in the ring buffer
1397 * @entry: The event itself
1398 * @trace_ctx: The tracing context flags.
1400 * This is a helper function to handle triggers that require data
1401 * from the event itself. It also tests the event against filters and
1402 * if the event is soft disabled and should be discarded.
1404 * Same as event_trigger_unlock_commit() but calls
1405 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1408 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1409 struct trace_buffer *buffer,
1410 struct ring_buffer_event *event,
1411 void *entry, unsigned int trace_ctx,
1412 struct pt_regs *regs)
1414 enum event_trigger_type tt = ETT_NONE;
1416 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1417 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1421 event_triggers_post_call(file, tt);
1424 #define FILTER_PRED_INVALID ((unsigned short)-1)
1425 #define FILTER_PRED_IS_RIGHT (1 << 15)
1426 #define FILTER_PRED_FOLD (1 << 15)
1429 * The max preds is the size of unsigned short with
1430 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1431 * and FOLD flags. The other is reserved.
1433 * 2^14 preds is way more than enough.
1435 #define MAX_FILTER_PRED 16384
1440 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1442 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1454 char pattern[MAX_FILTER_STR_VAL];
1457 regex_match_func match;
1460 struct filter_pred {
1461 filter_pred_fn_t fn;
1464 unsigned short *ops;
1465 struct ftrace_event_field *field;
1471 static inline bool is_string_field(struct ftrace_event_field *field)
1473 return field->filter_type == FILTER_DYN_STRING ||
1474 field->filter_type == FILTER_STATIC_STRING ||
1475 field->filter_type == FILTER_PTR_STRING ||
1476 field->filter_type == FILTER_COMM;
1479 static inline bool is_function_field(struct ftrace_event_field *field)
1481 return field->filter_type == FILTER_TRACE_FN;
1484 extern enum regex_type
1485 filter_parse_regex(char *buff, int len, char **search, int *not);
1486 extern void print_event_filter(struct trace_event_file *file,
1487 struct trace_seq *s);
1488 extern int apply_event_filter(struct trace_event_file *file,
1489 char *filter_string);
1490 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1491 char *filter_string);
1492 extern void print_subsystem_event_filter(struct event_subsystem *system,
1493 struct trace_seq *s);
1494 extern int filter_assign_type(const char *type);
1495 extern int create_event_filter(struct trace_array *tr,
1496 struct trace_event_call *call,
1497 char *filter_str, bool set_str,
1498 struct event_filter **filterp);
1499 extern void free_event_filter(struct event_filter *filter);
1501 struct ftrace_event_field *
1502 trace_find_event_field(struct trace_event_call *call, char *name);
1504 extern void trace_event_enable_cmd_record(bool enable);
1505 extern void trace_event_enable_tgid_record(bool enable);
1507 extern int event_trace_init(void);
1508 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1509 extern int event_trace_del_tracer(struct trace_array *tr);
1510 extern void __trace_early_add_events(struct trace_array *tr);
1512 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1515 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1519 static inline void *event_file_data(struct file *filp)
1521 return READ_ONCE(file_inode(filp)->i_private);
1524 extern struct mutex event_mutex;
1525 extern struct list_head ftrace_events;
1527 extern const struct file_operations event_trigger_fops;
1528 extern const struct file_operations event_hist_fops;
1529 extern const struct file_operations event_hist_debug_fops;
1530 extern const struct file_operations event_inject_fops;
1532 #ifdef CONFIG_HIST_TRIGGERS
1533 extern int register_trigger_hist_cmd(void);
1534 extern int register_trigger_hist_enable_disable_cmds(void);
1536 static inline int register_trigger_hist_cmd(void) { return 0; }
1537 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1540 extern int register_trigger_cmds(void);
1541 extern void clear_event_triggers(struct trace_array *tr);
1543 struct event_trigger_data {
1544 unsigned long count;
1546 struct event_trigger_ops *ops;
1547 struct event_command *cmd_ops;
1548 struct event_filter __rcu *filter;
1553 struct list_head list;
1555 struct list_head named_list;
1556 struct event_trigger_data *named_data;
1560 #define ENABLE_EVENT_STR "enable_event"
1561 #define DISABLE_EVENT_STR "disable_event"
1562 #define ENABLE_HIST_STR "enable_hist"
1563 #define DISABLE_HIST_STR "disable_hist"
1565 struct enable_trigger_data {
1566 struct trace_event_file *file;
1571 extern int event_enable_trigger_print(struct seq_file *m,
1572 struct event_trigger_ops *ops,
1573 struct event_trigger_data *data);
1574 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1575 struct event_trigger_data *data);
1576 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1577 struct trace_event_file *file,
1578 char *glob, char *cmd, char *param);
1579 extern int event_enable_register_trigger(char *glob,
1580 struct event_trigger_ops *ops,
1581 struct event_trigger_data *data,
1582 struct trace_event_file *file);
1583 extern void event_enable_unregister_trigger(char *glob,
1584 struct event_trigger_ops *ops,
1585 struct event_trigger_data *test,
1586 struct trace_event_file *file);
1587 extern void trigger_data_free(struct event_trigger_data *data);
1588 extern int event_trigger_init(struct event_trigger_ops *ops,
1589 struct event_trigger_data *data);
1590 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1591 int trigger_enable);
1592 extern void update_cond_flag(struct trace_event_file *file);
1593 extern int set_trigger_filter(char *filter_str,
1594 struct event_trigger_data *trigger_data,
1595 struct trace_event_file *file);
1596 extern struct event_trigger_data *find_named_trigger(const char *name);
1597 extern bool is_named_trigger(struct event_trigger_data *test);
1598 extern int save_named_trigger(const char *name,
1599 struct event_trigger_data *data);
1600 extern void del_named_trigger(struct event_trigger_data *data);
1601 extern void pause_named_trigger(struct event_trigger_data *data);
1602 extern void unpause_named_trigger(struct event_trigger_data *data);
1603 extern void set_named_trigger_data(struct event_trigger_data *data,
1604 struct event_trigger_data *named_data);
1605 extern struct event_trigger_data *
1606 get_named_trigger_data(struct event_trigger_data *data);
1607 extern int register_event_command(struct event_command *cmd);
1608 extern int unregister_event_command(struct event_command *cmd);
1609 extern int register_trigger_hist_enable_disable_cmds(void);
1612 * struct event_trigger_ops - callbacks for trace event triggers
1614 * The methods in this structure provide per-event trigger hooks for
1615 * various trigger operations.
1617 * All the methods below, except for @init() and @free(), must be
1620 * @func: The trigger 'probe' function called when the triggering
1621 * event occurs. The data passed into this callback is the data
1622 * that was supplied to the event_command @reg() function that
1623 * registered the trigger (see struct event_command) along with
1624 * the trace record, rec.
1626 * @init: An optional initialization function called for the trigger
1627 * when the trigger is registered (via the event_command reg()
1628 * function). This can be used to perform per-trigger
1629 * initialization such as incrementing a per-trigger reference
1630 * count, for instance. This is usually implemented by the
1631 * generic utility function @event_trigger_init() (see
1632 * trace_event_triggers.c).
1634 * @free: An optional de-initialization function called for the
1635 * trigger when the trigger is unregistered (via the
1636 * event_command @reg() function). This can be used to perform
1637 * per-trigger de-initialization such as decrementing a
1638 * per-trigger reference count and freeing corresponding trigger
1639 * data, for instance. This is usually implemented by the
1640 * generic utility function @event_trigger_free() (see
1641 * trace_event_triggers.c).
1643 * @print: The callback function invoked to have the trigger print
1644 * itself. This is usually implemented by a wrapper function
1645 * that calls the generic utility function @event_trigger_print()
1646 * (see trace_event_triggers.c).
1648 struct event_trigger_ops {
1649 void (*func)(struct event_trigger_data *data,
1650 struct trace_buffer *buffer, void *rec,
1651 struct ring_buffer_event *rbe);
1652 int (*init)(struct event_trigger_ops *ops,
1653 struct event_trigger_data *data);
1654 void (*free)(struct event_trigger_ops *ops,
1655 struct event_trigger_data *data);
1656 int (*print)(struct seq_file *m,
1657 struct event_trigger_ops *ops,
1658 struct event_trigger_data *data);
1662 * struct event_command - callbacks and data members for event commands
1664 * Event commands are invoked by users by writing the command name
1665 * into the 'trigger' file associated with a trace event. The
1666 * parameters associated with a specific invocation of an event
1667 * command are used to create an event trigger instance, which is
1668 * added to the list of trigger instances associated with that trace
1669 * event. When the event is hit, the set of triggers associated with
1670 * that event is invoked.
1672 * The data members in this structure provide per-event command data
1673 * for various event commands.
1675 * All the data members below, except for @post_trigger, must be set
1676 * for each event command.
1678 * @name: The unique name that identifies the event command. This is
1679 * the name used when setting triggers via trigger files.
1681 * @trigger_type: A unique id that identifies the event command
1682 * 'type'. This value has two purposes, the first to ensure that
1683 * only one trigger of the same type can be set at a given time
1684 * for a particular event e.g. it doesn't make sense to have both
1685 * a traceon and traceoff trigger attached to a single event at
1686 * the same time, so traceon and traceoff have the same type
1687 * though they have different names. The @trigger_type value is
1688 * also used as a bit value for deferring the actual trigger
1689 * action until after the current event is finished. Some
1690 * commands need to do this if they themselves log to the trace
1691 * buffer (see the @post_trigger() member below). @trigger_type
1692 * values are defined by adding new values to the trigger_type
1693 * enum in include/linux/trace_events.h.
1695 * @flags: See the enum event_command_flags below.
1697 * All the methods below, except for @set_filter() and @unreg_all(),
1698 * must be implemented.
1700 * @func: The callback function responsible for parsing and
1701 * registering the trigger written to the 'trigger' file by the
1702 * user. It allocates the trigger instance and registers it with
1703 * the appropriate trace event. It makes use of the other
1704 * event_command callback functions to orchestrate this, and is
1705 * usually implemented by the generic utility function
1706 * @event_trigger_callback() (see trace_event_triggers.c).
1708 * @reg: Adds the trigger to the list of triggers associated with the
1709 * event, and enables the event trigger itself, after
1710 * initializing it (via the event_trigger_ops @init() function).
1711 * This is also where commands can use the @trigger_type value to
1712 * make the decision as to whether or not multiple instances of
1713 * the trigger should be allowed. This is usually implemented by
1714 * the generic utility function @register_trigger() (see
1715 * trace_event_triggers.c).
1717 * @unreg: Removes the trigger from the list of triggers associated
1718 * with the event, and disables the event trigger itself, after
1719 * initializing it (via the event_trigger_ops @free() function).
1720 * This is usually implemented by the generic utility function
1721 * @unregister_trigger() (see trace_event_triggers.c).
1723 * @unreg_all: An optional function called to remove all the triggers
1724 * from the list of triggers associated with the event. Called
1725 * when a trigger file is opened in truncate mode.
1727 * @set_filter: An optional function called to parse and set a filter
1728 * for the trigger. If no @set_filter() method is set for the
1729 * event command, filters set by the user for the command will be
1730 * ignored. This is usually implemented by the generic utility
1731 * function @set_trigger_filter() (see trace_event_triggers.c).
1733 * @get_trigger_ops: The callback function invoked to retrieve the
1734 * event_trigger_ops implementation associated with the command.
1736 struct event_command {
1737 struct list_head list;
1739 enum event_trigger_type trigger_type;
1741 int (*func)(struct event_command *cmd_ops,
1742 struct trace_event_file *file,
1743 char *glob, char *cmd, char *params);
1744 int (*reg)(char *glob,
1745 struct event_trigger_ops *ops,
1746 struct event_trigger_data *data,
1747 struct trace_event_file *file);
1748 void (*unreg)(char *glob,
1749 struct event_trigger_ops *ops,
1750 struct event_trigger_data *data,
1751 struct trace_event_file *file);
1752 void (*unreg_all)(struct trace_event_file *file);
1753 int (*set_filter)(char *filter_str,
1754 struct event_trigger_data *data,
1755 struct trace_event_file *file);
1756 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1760 * enum event_command_flags - flags for struct event_command
1762 * @POST_TRIGGER: A flag that says whether or not this command needs
1763 * to have its action delayed until after the current event has
1764 * been closed. Some triggers need to avoid being invoked while
1765 * an event is currently in the process of being logged, since
1766 * the trigger may itself log data into the trace buffer. Thus
1767 * we make sure the current event is committed before invoking
1768 * those triggers. To do that, the trigger invocation is split
1769 * in two - the first part checks the filter using the current
1770 * trace record; if a command has the @post_trigger flag set, it
1771 * sets a bit for itself in the return value, otherwise it
1772 * directly invokes the trigger. Once all commands have been
1773 * either invoked or set their return flag, the current record is
1774 * either committed or discarded. At that point, if any commands
1775 * have deferred their triggers, those commands are finally
1776 * invoked following the close of the current event. In other
1777 * words, if the event_trigger_ops @func() probe implementation
1778 * itself logs to the trace buffer, this flag should be set,
1779 * otherwise it can be left unspecified.
1781 * @NEEDS_REC: A flag that says whether or not this command needs
1782 * access to the trace record in order to perform its function,
1783 * regardless of whether or not it has a filter associated with
1784 * it (filters make a trigger require access to the trace record
1785 * but are not always present).
1787 enum event_command_flags {
1788 EVENT_CMD_FL_POST_TRIGGER = 1,
1789 EVENT_CMD_FL_NEEDS_REC = 2,
1792 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1794 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1797 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1799 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1802 extern int trace_event_enable_disable(struct trace_event_file *file,
1803 int enable, int soft_disable);
1804 extern int tracing_alloc_snapshot(void);
1805 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1806 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1808 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1809 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1811 extern const char *__start___trace_bprintk_fmt[];
1812 extern const char *__stop___trace_bprintk_fmt[];
1814 extern const char *__start___tracepoint_str[];
1815 extern const char *__stop___tracepoint_str[];
1817 void trace_printk_control(bool enabled);
1818 void trace_printk_start_comm(void);
1819 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1820 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1822 /* Used from boot time tracer */
1823 extern int trace_set_options(struct trace_array *tr, char *option);
1824 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1825 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1826 unsigned long size, int cpu_id);
1827 extern int tracing_set_cpumask(struct trace_array *tr,
1828 cpumask_var_t tracing_cpumask_new);
1831 #define MAX_EVENT_NAME_LEN 64
1833 extern ssize_t trace_parse_run_command(struct file *file,
1834 const char __user *buffer, size_t count, loff_t *ppos,
1835 int (*createfn)(const char *));
1837 extern unsigned int err_pos(char *cmd, const char *str);
1838 extern void tracing_log_err(struct trace_array *tr,
1839 const char *loc, const char *cmd,
1840 const char **errs, u8 type, u8 pos);
1843 * Normal trace_printk() and friends allocates special buffers
1844 * to do the manipulation, as well as saves the print formats
1845 * into sections to display. But the trace infrastructure wants
1846 * to use these without the added overhead at the price of being
1847 * a bit slower (used mainly for warnings, where we don't care
1848 * about performance). The internal_trace_puts() is for such
1851 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1854 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1855 extern struct trace_event_call \
1856 __aligned(4) event_##call;
1857 #undef FTRACE_ENTRY_DUP
1858 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1859 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1860 #undef FTRACE_ENTRY_PACKED
1861 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1862 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1864 #include "trace_entries.h"
1866 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1867 int perf_ftrace_event_register(struct trace_event_call *call,
1868 enum trace_reg type, void *data);
1870 #define perf_ftrace_event_register NULL
1873 #ifdef CONFIG_FTRACE_SYSCALLS
1874 void init_ftrace_syscalls(void);
1875 const char *get_syscall_name(int syscall);
1877 static inline void init_ftrace_syscalls(void) { }
1878 static inline const char *get_syscall_name(int syscall)
1884 #ifdef CONFIG_EVENT_TRACING
1885 void trace_event_init(void);
1886 void trace_event_eval_update(struct trace_eval_map **map, int len);
1887 /* Used from boot time tracer */
1888 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1889 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1891 static inline void __init trace_event_init(void) { }
1892 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1895 #ifdef CONFIG_TRACER_SNAPSHOT
1896 void tracing_snapshot_instance(struct trace_array *tr);
1897 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1899 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1900 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1906 #ifdef CONFIG_PREEMPT_TRACER
1907 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1908 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1910 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1911 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1913 #ifdef CONFIG_IRQSOFF_TRACER
1914 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1915 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1917 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1918 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1921 extern struct trace_iterator *tracepoint_print_iter;
1924 * Reset the state of the trace_iterator so that it can read consumed data.
1925 * Normally, the trace_iterator is used for reading the data when it is not
1926 * consumed, and must retain state.
1928 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1930 const size_t offset = offsetof(struct trace_iterator, seq);
1933 * Keep gcc from complaining about overwriting more than just one
1934 * member in the structure.
1936 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1941 /* Check the name is good for event/group/fields */
1942 static inline bool is_good_name(const char *name)
1944 if (!isalpha(*name) && *name != '_')
1946 while (*++name != '\0') {
1947 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1954 * This is a generic way to read and write a u64 value from a file in tracefs.
1956 * The value is stored on the variable pointed by *val. The value needs
1957 * to be at least *min and at most *max. The write is protected by an
1960 struct trace_min_max_param {
1967 #define U64_STR_SIZE 24 /* 20 digits max */
1969 extern const struct file_operations trace_min_max_fops;
1971 #endif /* _LINUX_KERNEL_TRACE_H */