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>
24 #ifdef CONFIG_FTRACE_SYSCALLS
25 #include <asm/unistd.h> /* For NR_SYSCALLS */
26 #include <asm/syscall.h> /* some archs define it here */
30 __TRACE_FIRST_TYPE = 0,
54 #define __field(type, item) type item;
57 #define __field_fn(type, item) type item;
60 #define __field_struct(type, item) __field(type, item)
63 #define __field_desc(type, container, item)
66 #define __field_packed(type, container, item)
69 #define __array(type, item, size) type item[size];
72 #define __array_desc(type, container, item, size)
74 #undef __dynamic_array
75 #define __dynamic_array(type, item) type item[];
78 #define F_STRUCT(args...) args
81 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
82 struct struct_name { \
83 struct trace_entry ent; \
87 #undef FTRACE_ENTRY_DUP
88 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
90 #undef FTRACE_ENTRY_REG
91 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
92 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
94 #undef FTRACE_ENTRY_PACKED
95 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
96 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
98 #include "trace_entries.h"
100 /* Use this for memory failure errors */
101 #define MEM_FAIL(condition, fmt, ...) ({ \
102 static bool __section(".data.once") __warned; \
103 int __ret_warn_once = !!(condition); \
105 if (unlikely(__ret_warn_once && !__warned)) { \
107 pr_err("ERROR: " fmt, ##__VA_ARGS__); \
109 unlikely(__ret_warn_once); \
113 * syscalls are special, and need special handling, this is why
114 * they are not included in trace_entries.h
116 struct syscall_trace_enter {
117 struct trace_entry ent;
119 unsigned long args[];
122 struct syscall_trace_exit {
123 struct trace_entry ent;
128 struct kprobe_trace_entry_head {
129 struct trace_entry ent;
133 struct kretprobe_trace_entry_head {
134 struct trace_entry ent;
136 unsigned long ret_ip;
139 #define TRACE_BUF_SIZE 1024
144 * The CPU trace array - it consists of thousands of trace entries
145 * plus some other descriptor data: (for example which task started
148 struct trace_array_cpu {
150 void *buffer_page; /* ring buffer spare */
152 unsigned long entries;
153 unsigned long saved_latency;
154 unsigned long critical_start;
155 unsigned long critical_end;
156 unsigned long critical_sequence;
158 unsigned long policy;
159 unsigned long rt_priority;
160 unsigned long skipped_entries;
161 u64 preempt_timestamp;
164 char comm[TASK_COMM_LEN];
166 #ifdef CONFIG_FUNCTION_TRACER
167 int ftrace_ignore_pid;
173 struct trace_option_dentry;
175 struct array_buffer {
176 struct trace_array *tr;
177 struct trace_buffer *buffer;
178 struct trace_array_cpu __percpu *data;
183 #define TRACE_FLAGS_MAX_SIZE 32
185 struct trace_options {
186 struct tracer *tracer;
187 struct trace_option_dentry *topts;
190 struct trace_pid_list {
197 TRACE_NO_PIDS = BIT(1),
200 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
201 struct trace_pid_list *no_pid_list)
203 /* Return true if the pid list in type has pids */
204 return ((type & TRACE_PIDS) && pid_list) ||
205 ((type & TRACE_NO_PIDS) && no_pid_list);
208 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
209 struct trace_pid_list *no_pid_list)
212 * Turning off what is in @type, return true if the "other"
213 * pid list, still has pids in it.
215 return (!(type & TRACE_PIDS) && pid_list) ||
216 (!(type & TRACE_NO_PIDS) && no_pid_list);
219 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
222 * struct cond_snapshot - conditional snapshot data and callback
224 * The cond_snapshot structure encapsulates a callback function and
225 * data associated with the snapshot for a given tracing instance.
227 * When a snapshot is taken conditionally, by invoking
228 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
229 * passed in turn to the cond_snapshot.update() function. That data
230 * can be compared by the update() implementation with the cond_data
231 * contained within the struct cond_snapshot instance associated with
232 * the trace_array. Because the tr->max_lock is held throughout the
233 * update() call, the update() function can directly retrieve the
234 * cond_snapshot and cond_data associated with the per-instance
235 * snapshot associated with the trace_array.
237 * The cond_snapshot.update() implementation can save data to be
238 * associated with the snapshot if it decides to, and returns 'true'
239 * in that case, or it returns 'false' if the conditional snapshot
240 * shouldn't be taken.
242 * The cond_snapshot instance is created and associated with the
243 * user-defined cond_data by tracing_cond_snapshot_enable().
244 * Likewise, the cond_snapshot instance is destroyed and is no longer
245 * associated with the trace instance by
246 * tracing_cond_snapshot_disable().
248 * The method below is required.
250 * @update: When a conditional snapshot is invoked, the update()
251 * callback function is invoked with the tr->max_lock held. The
252 * update() implementation signals whether or not to actually
253 * take the snapshot, by returning 'true' if so, 'false' if no
254 * snapshot should be taken. Because the max_lock is held for
255 * the duration of update(), the implementation is safe to
256 * directly retrieved and save any implementation data it needs
257 * to in association with the snapshot.
259 struct cond_snapshot {
261 cond_update_fn_t update;
265 * The trace array - an array of per-CPU trace arrays. This is the
266 * highest level data structure that individual tracers deal with.
267 * They have on/off state as well:
270 struct list_head list;
272 struct array_buffer array_buffer;
273 #ifdef CONFIG_TRACER_MAX_TRACE
275 * The max_buffer is used to snapshot the trace when a maximum
276 * latency is reached, or when the user initiates a snapshot.
277 * Some tracers will use this to store a maximum trace while
278 * it continues examining live traces.
280 * The buffers for the max_buffer are set up the same as the array_buffer
281 * When a snapshot is taken, the buffer of the max_buffer is swapped
282 * with the buffer of the array_buffer and the buffers are reset for
283 * the array_buffer so the tracing can continue.
285 struct array_buffer max_buffer;
286 bool allocated_snapshot;
288 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
289 unsigned long max_latency;
290 #ifdef CONFIG_FSNOTIFY
291 struct dentry *d_max_latency;
292 struct work_struct fsnotify_work;
293 struct irq_work fsnotify_irqwork;
296 struct trace_pid_list __rcu *filtered_pids;
297 struct trace_pid_list __rcu *filtered_no_pids;
299 * max_lock is used to protect the swapping of buffers
300 * when taking a max snapshot. The buffers themselves are
301 * protected by per_cpu spinlocks. But the action of the swap
302 * needs its own lock.
304 * This is defined as a arch_spinlock_t in order to help
305 * with performance when lockdep debugging is enabled.
307 * It is also used in other places outside the update_max_tr
308 * so it needs to be defined outside of the
309 * CONFIG_TRACER_MAX_TRACE.
311 arch_spinlock_t max_lock;
313 #ifdef CONFIG_FTRACE_SYSCALLS
314 int sys_refcount_enter;
315 int sys_refcount_exit;
316 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
317 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
324 unsigned int n_err_log_entries;
325 struct tracer *current_trace;
326 unsigned int trace_flags;
327 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
329 raw_spinlock_t start_lock;
330 struct list_head err_log;
332 struct dentry *options;
333 struct dentry *percpu_dir;
334 struct dentry *event_dir;
335 struct trace_options *topts;
336 struct list_head systems;
337 struct list_head events;
338 struct trace_event_file *trace_marker_file;
339 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
342 #ifdef CONFIG_FUNCTION_TRACER
343 struct ftrace_ops *ops;
344 struct trace_pid_list __rcu *function_pids;
345 struct trace_pid_list __rcu *function_no_pids;
346 #ifdef CONFIG_DYNAMIC_FTRACE
347 /* All of these are protected by the ftrace_lock */
348 struct list_head func_probes;
349 struct list_head mod_trace;
350 struct list_head mod_notrace;
352 /* function tracing enabled */
353 int function_enabled;
355 int time_stamp_abs_ref;
356 struct list_head hist_vars;
357 #ifdef CONFIG_TRACER_SNAPSHOT
358 struct cond_snapshot *cond_snapshot;
363 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
366 extern struct list_head ftrace_trace_arrays;
368 extern struct mutex trace_types_lock;
370 extern int trace_array_get(struct trace_array *tr);
371 extern int tracing_check_open_get_tr(struct trace_array *tr);
372 extern struct trace_array *trace_array_find(const char *instance);
373 extern struct trace_array *trace_array_find_get(const char *instance);
375 extern int tracing_set_time_stamp_abs(struct trace_array *tr, bool abs);
376 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
378 extern bool trace_clock_in_ns(struct trace_array *tr);
381 * The global tracer (top) should be the first trace array added,
382 * but we check the flag anyway.
384 static inline struct trace_array *top_trace_array(void)
386 struct trace_array *tr;
388 if (list_empty(&ftrace_trace_arrays))
391 tr = list_entry(ftrace_trace_arrays.prev,
393 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
397 #define FTRACE_CMP_TYPE(var, type) \
398 __builtin_types_compatible_p(typeof(var), type *)
401 #define IF_ASSIGN(var, entry, etype, id) \
402 if (FTRACE_CMP_TYPE(var, etype)) { \
403 var = (typeof(var))(entry); \
404 WARN_ON(id != 0 && (entry)->type != id); \
408 /* Will cause compile errors if type is not found. */
409 extern void __ftrace_bad_type(void);
412 * The trace_assign_type is a verifier that the entry type is
413 * the same as the type being assigned. To add new types simply
414 * add a line with the following format:
416 * IF_ASSIGN(var, ent, type, id);
418 * Where "type" is the trace type that includes the trace_entry
419 * as the "ent" item. And "id" is the trace identifier that is
420 * used in the trace_type enum.
422 * If the type can have more than one id, then use zero.
424 #define trace_assign_type(var, ent) \
426 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
427 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
428 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
429 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
430 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
431 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
432 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
433 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
434 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
435 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
437 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
439 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
440 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
442 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
444 __ftrace_bad_type(); \
448 * An option specific to a tracer. This is a boolean value.
449 * The bit is the bit index that sets its value on the
450 * flags value in struct tracer_flags.
453 const char *name; /* Will appear on the trace_options file */
454 u32 bit; /* Mask assigned in val field in tracer_flags */
458 * The set of specific options for a tracer. Your tracer
459 * have to set the initial value of the flags val.
461 struct tracer_flags {
463 struct tracer_opt *opts;
464 struct tracer *trace;
467 /* Makes more easy to define a tracer opt */
468 #define TRACER_OPT(s, b) .name = #s, .bit = b
471 struct trace_option_dentry {
472 struct tracer_opt *opt;
473 struct tracer_flags *flags;
474 struct trace_array *tr;
475 struct dentry *entry;
479 * struct tracer - a specific tracer and its callbacks to interact with tracefs
480 * @name: the name chosen to select it on the available_tracers file
481 * @init: called when one switches to this tracer (echo name > current_tracer)
482 * @reset: called when one switches to another tracer
483 * @start: called when tracing is unpaused (echo 1 > tracing_on)
484 * @stop: called when tracing is paused (echo 0 > tracing_on)
485 * @update_thresh: called when tracing_thresh is updated
486 * @open: called when the trace file is opened
487 * @pipe_open: called when the trace_pipe file is opened
488 * @close: called when the trace file is released
489 * @pipe_close: called when the trace_pipe file is released
490 * @read: override the default read callback on trace_pipe
491 * @splice_read: override the default splice_read callback on trace_pipe
492 * @selftest: selftest to run on boot (see trace_selftest.c)
493 * @print_headers: override the first lines that describe your columns
494 * @print_line: callback that prints a trace
495 * @set_flag: signals one of your private flags changed (trace_options file)
496 * @flags: your private flags
500 int (*init)(struct trace_array *tr);
501 void (*reset)(struct trace_array *tr);
502 void (*start)(struct trace_array *tr);
503 void (*stop)(struct trace_array *tr);
504 int (*update_thresh)(struct trace_array *tr);
505 void (*open)(struct trace_iterator *iter);
506 void (*pipe_open)(struct trace_iterator *iter);
507 void (*close)(struct trace_iterator *iter);
508 void (*pipe_close)(struct trace_iterator *iter);
509 ssize_t (*read)(struct trace_iterator *iter,
510 struct file *filp, char __user *ubuf,
511 size_t cnt, loff_t *ppos);
512 ssize_t (*splice_read)(struct trace_iterator *iter,
515 struct pipe_inode_info *pipe,
518 #ifdef CONFIG_FTRACE_STARTUP_TEST
519 int (*selftest)(struct tracer *trace,
520 struct trace_array *tr);
522 void (*print_header)(struct seq_file *m);
523 enum print_line_t (*print_line)(struct trace_iterator *iter);
524 /* If you handled the flag setting, return 0 */
525 int (*set_flag)(struct trace_array *tr,
526 u32 old_flags, u32 bit, int set);
527 /* Return 0 if OK with change, else return non-zero */
528 int (*flag_changed)(struct trace_array *tr,
531 struct tracer_flags *flags;
534 bool allow_instances;
535 #ifdef CONFIG_TRACER_MAX_TRACE
538 /* True if tracer cannot be enabled in kernel param */
542 static inline struct ring_buffer_iter *
543 trace_buffer_iter(struct trace_iterator *iter, int cpu)
545 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
548 int tracer_init(struct tracer *t, struct trace_array *tr);
549 int tracing_is_enabled(void);
550 void tracing_reset_online_cpus(struct array_buffer *buf);
551 void tracing_reset_current(int cpu);
552 void tracing_reset_all_online_cpus(void);
553 int tracing_open_generic(struct inode *inode, struct file *filp);
554 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
555 bool tracing_is_disabled(void);
556 bool tracer_tracing_is_on(struct trace_array *tr);
557 void tracer_tracing_on(struct trace_array *tr);
558 void tracer_tracing_off(struct trace_array *tr);
559 struct dentry *trace_create_file(const char *name,
561 struct dentry *parent,
563 const struct file_operations *fops);
565 int tracing_init_dentry(void);
567 struct ring_buffer_event;
569 struct ring_buffer_event *
570 trace_buffer_lock_reserve(struct trace_buffer *buffer,
573 unsigned int trace_ctx);
575 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
576 struct trace_array_cpu *data);
578 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
579 int *ent_cpu, u64 *ent_ts);
581 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
582 struct ring_buffer_event *event);
584 int trace_empty(struct trace_iterator *iter);
586 void *trace_find_next_entry_inc(struct trace_iterator *iter);
588 void trace_init_global_iter(struct trace_iterator *iter);
590 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
592 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
593 unsigned long trace_total_entries(struct trace_array *tr);
595 void trace_function(struct trace_array *tr,
597 unsigned long parent_ip,
598 unsigned int trace_ctx);
599 void trace_graph_function(struct trace_array *tr,
601 unsigned long parent_ip,
602 unsigned int trace_ctx);
603 void trace_latency_header(struct seq_file *m);
604 void trace_default_header(struct seq_file *m);
605 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
606 int trace_empty(struct trace_iterator *iter);
608 void trace_graph_return(struct ftrace_graph_ret *trace);
609 int trace_graph_entry(struct ftrace_graph_ent *trace);
610 void set_graph_array(struct trace_array *tr);
612 void tracing_start_cmdline_record(void);
613 void tracing_stop_cmdline_record(void);
614 void tracing_start_tgid_record(void);
615 void tracing_stop_tgid_record(void);
617 int register_tracer(struct tracer *type);
618 int is_tracing_stopped(void);
620 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
622 extern cpumask_var_t __read_mostly tracing_buffer_mask;
624 #define for_each_tracing_cpu(cpu) \
625 for_each_cpu(cpu, tracing_buffer_mask)
627 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
629 extern unsigned long tracing_thresh;
635 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
637 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
638 struct trace_pid_list *filtered_no_pids,
639 struct task_struct *task);
640 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
641 struct task_struct *self,
642 struct task_struct *task);
643 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
644 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
645 int trace_pid_show(struct seq_file *m, void *v);
646 void trace_free_pid_list(struct trace_pid_list *pid_list);
647 int trace_pid_write(struct trace_pid_list *filtered_pids,
648 struct trace_pid_list **new_pid_list,
649 const char __user *ubuf, size_t cnt);
651 #ifdef CONFIG_TRACER_MAX_TRACE
652 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
654 void update_max_tr_single(struct trace_array *tr,
655 struct task_struct *tsk, int cpu);
656 #endif /* CONFIG_TRACER_MAX_TRACE */
658 #if (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)) && \
659 defined(CONFIG_FSNOTIFY)
661 void latency_fsnotify(struct trace_array *tr);
665 static inline void latency_fsnotify(struct trace_array *tr) { }
669 #ifdef CONFIG_STACKTRACE
670 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
672 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
676 #endif /* CONFIG_STACKTRACE */
678 extern u64 ftrace_now(int cpu);
680 extern void trace_find_cmdline(int pid, char comm[]);
681 extern int trace_find_tgid(int pid);
682 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
684 #ifdef CONFIG_DYNAMIC_FTRACE
685 extern unsigned long ftrace_update_tot_cnt;
686 extern unsigned long ftrace_number_of_pages;
687 extern unsigned long ftrace_number_of_groups;
688 void ftrace_init_trace_array(struct trace_array *tr);
690 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
692 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
693 extern int DYN_FTRACE_TEST_NAME(void);
694 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
695 extern int DYN_FTRACE_TEST_NAME2(void);
697 extern bool ring_buffer_expanded;
698 extern bool tracing_selftest_disabled;
700 #ifdef CONFIG_FTRACE_STARTUP_TEST
701 extern void __init disable_tracing_selftest(const char *reason);
703 extern int trace_selftest_startup_function(struct tracer *trace,
704 struct trace_array *tr);
705 extern int trace_selftest_startup_function_graph(struct tracer *trace,
706 struct trace_array *tr);
707 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
708 struct trace_array *tr);
709 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
710 struct trace_array *tr);
711 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
712 struct trace_array *tr);
713 extern int trace_selftest_startup_wakeup(struct tracer *trace,
714 struct trace_array *tr);
715 extern int trace_selftest_startup_nop(struct tracer *trace,
716 struct trace_array *tr);
717 extern int trace_selftest_startup_branch(struct tracer *trace,
718 struct trace_array *tr);
720 * Tracer data references selftest functions that only occur
721 * on boot up. These can be __init functions. Thus, when selftests
722 * are enabled, then the tracers need to reference __init functions.
724 #define __tracer_data __refdata
726 static inline void __init disable_tracing_selftest(const char *reason)
729 /* Tracers are seldom changed. Optimize when selftests are disabled. */
730 #define __tracer_data __read_mostly
731 #endif /* CONFIG_FTRACE_STARTUP_TEST */
733 extern void *head_page(struct trace_array_cpu *data);
734 extern unsigned long long ns2usecs(u64 nsec);
736 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
738 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
740 trace_array_vprintk(struct trace_array *tr,
741 unsigned long ip, const char *fmt, va_list args);
742 int trace_array_printk_buf(struct trace_buffer *buffer,
743 unsigned long ip, const char *fmt, ...);
744 void trace_printk_seq(struct trace_seq *s);
745 enum print_line_t print_trace_line(struct trace_iterator *iter);
747 extern char trace_find_mark(unsigned long long duration);
751 struct ftrace_mod_load {
752 struct list_head list;
759 FTRACE_HASH_FL_MOD = (1 << 0),
763 unsigned long size_bits;
764 struct hlist_head *buckets;
770 struct ftrace_func_entry *
771 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
773 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
775 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
778 /* Standard output formatting function used for function return traces */
779 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
782 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
783 #define TRACE_GRAPH_PRINT_CPU 0x2
784 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
785 #define TRACE_GRAPH_PRINT_PROC 0x8
786 #define TRACE_GRAPH_PRINT_DURATION 0x10
787 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
788 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
789 #define TRACE_GRAPH_PRINT_IRQS 0x80
790 #define TRACE_GRAPH_PRINT_TAIL 0x100
791 #define TRACE_GRAPH_SLEEP_TIME 0x200
792 #define TRACE_GRAPH_GRAPH_TIME 0x400
793 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
794 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
796 extern void ftrace_graph_sleep_time_control(bool enable);
798 #ifdef CONFIG_FUNCTION_PROFILER
799 extern void ftrace_graph_graph_time_control(bool enable);
801 static inline void ftrace_graph_graph_time_control(bool enable) { }
804 extern enum print_line_t
805 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
806 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
808 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
809 extern void graph_trace_open(struct trace_iterator *iter);
810 extern void graph_trace_close(struct trace_iterator *iter);
811 extern int __trace_graph_entry(struct trace_array *tr,
812 struct ftrace_graph_ent *trace,
813 unsigned int trace_ctx);
814 extern void __trace_graph_return(struct trace_array *tr,
815 struct ftrace_graph_ret *trace,
816 unsigned int trace_ctx);
818 #ifdef CONFIG_DYNAMIC_FTRACE
819 extern struct ftrace_hash __rcu *ftrace_graph_hash;
820 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
822 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
824 unsigned long addr = trace->func;
826 struct ftrace_hash *hash;
828 preempt_disable_notrace();
831 * Have to open code "rcu_dereference_sched()" because the
832 * function graph tracer can be called when RCU is not
834 * Protected with schedule_on_each_cpu(ftrace_sync)
836 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
838 if (ftrace_hash_empty(hash)) {
843 if (ftrace_lookup_ip(hash, addr)) {
846 * This needs to be cleared on the return functions
847 * when the depth is zero.
849 trace_recursion_set(TRACE_GRAPH_BIT);
850 trace_recursion_set_depth(trace->depth);
853 * If no irqs are to be traced, but a set_graph_function
854 * is set, and called by an interrupt handler, we still
858 trace_recursion_set(TRACE_IRQ_BIT);
860 trace_recursion_clear(TRACE_IRQ_BIT);
865 preempt_enable_notrace();
869 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
871 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
872 trace->depth == trace_recursion_depth())
873 trace_recursion_clear(TRACE_GRAPH_BIT);
876 static inline int ftrace_graph_notrace_addr(unsigned long addr)
879 struct ftrace_hash *notrace_hash;
881 preempt_disable_notrace();
884 * Have to open code "rcu_dereference_sched()" because the
885 * function graph tracer can be called when RCU is not
887 * Protected with schedule_on_each_cpu(ftrace_sync)
889 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
892 if (ftrace_lookup_ip(notrace_hash, addr))
895 preempt_enable_notrace();
899 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
904 static inline int ftrace_graph_notrace_addr(unsigned long addr)
908 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
910 #endif /* CONFIG_DYNAMIC_FTRACE */
912 extern unsigned int fgraph_max_depth;
914 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
916 /* trace it when it is-nested-in or is a function enabled. */
917 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
918 ftrace_graph_addr(trace)) ||
919 (trace->depth < 0) ||
920 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
923 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
924 static inline enum print_line_t
925 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
927 return TRACE_TYPE_UNHANDLED;
929 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
931 extern struct list_head ftrace_pids;
933 #ifdef CONFIG_FUNCTION_TRACER
935 #define FTRACE_PID_IGNORE -1
936 #define FTRACE_PID_TRACE -2
938 struct ftrace_func_command {
939 struct list_head list;
941 int (*func)(struct trace_array *tr,
942 struct ftrace_hash *hash,
943 char *func, char *cmd,
944 char *params, int enable);
946 extern bool ftrace_filter_param __initdata;
947 static inline int ftrace_trace_task(struct trace_array *tr)
949 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
952 extern int ftrace_is_dead(void);
953 int ftrace_create_function_files(struct trace_array *tr,
954 struct dentry *parent);
955 void ftrace_destroy_function_files(struct trace_array *tr);
956 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
957 void ftrace_free_ftrace_ops(struct trace_array *tr);
958 void ftrace_init_global_array_ops(struct trace_array *tr);
959 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
960 void ftrace_reset_array_ops(struct trace_array *tr);
961 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
962 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
963 struct dentry *d_tracer);
964 void ftrace_clear_pids(struct trace_array *tr);
965 int init_function_trace(void);
966 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
968 static inline int ftrace_trace_task(struct trace_array *tr)
972 static inline int ftrace_is_dead(void) { return 0; }
974 ftrace_create_function_files(struct trace_array *tr,
975 struct dentry *parent)
979 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
983 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
984 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
985 static inline __init void
986 ftrace_init_global_array_ops(struct trace_array *tr) { }
987 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
988 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
989 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
990 static inline void ftrace_clear_pids(struct trace_array *tr) { }
991 static inline int init_function_trace(void) { return 0; }
992 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
993 /* ftace_func_t type is not defined, use macro instead of static inline */
994 #define ftrace_init_array_ops(tr, func) do { } while (0)
995 #endif /* CONFIG_FUNCTION_TRACER */
997 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
999 struct ftrace_probe_ops {
1000 void (*func)(unsigned long ip,
1001 unsigned long parent_ip,
1002 struct trace_array *tr,
1003 struct ftrace_probe_ops *ops,
1005 int (*init)(struct ftrace_probe_ops *ops,
1006 struct trace_array *tr,
1007 unsigned long ip, void *init_data,
1009 void (*free)(struct ftrace_probe_ops *ops,
1010 struct trace_array *tr,
1011 unsigned long ip, void *data);
1012 int (*print)(struct seq_file *m,
1014 struct ftrace_probe_ops *ops,
1018 struct ftrace_func_mapper;
1019 typedef int (*ftrace_mapper_func)(void *data);
1021 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1022 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1024 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1025 unsigned long ip, void *data);
1026 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1028 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1029 ftrace_mapper_func free_func);
1032 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1033 struct ftrace_probe_ops *ops, void *data);
1035 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1036 struct ftrace_probe_ops *ops);
1037 extern void clear_ftrace_function_probes(struct trace_array *tr);
1039 int register_ftrace_command(struct ftrace_func_command *cmd);
1040 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1042 void ftrace_create_filter_files(struct ftrace_ops *ops,
1043 struct dentry *parent);
1044 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1046 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1047 int len, int reset);
1048 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1049 int len, int reset);
1051 struct ftrace_func_command;
1053 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1057 static inline __init int unregister_ftrace_command(char *cmd_name)
1061 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1066 * The ops parameter passed in is usually undefined.
1067 * This must be a macro.
1069 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1070 #define ftrace_destroy_filter_files(ops) do { } while (0)
1071 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1073 bool ftrace_event_is_function(struct trace_event_call *call);
1076 * struct trace_parser - servers for reading the user input separated by spaces
1077 * @cont: set if the input is not complete - no final space char was found
1078 * @buffer: holds the parsed user input
1079 * @idx: user input length
1080 * @size: buffer size
1082 struct trace_parser {
1089 static inline bool trace_parser_loaded(struct trace_parser *parser)
1091 return (parser->idx != 0);
1094 static inline bool trace_parser_cont(struct trace_parser *parser)
1096 return parser->cont;
1099 static inline void trace_parser_clear(struct trace_parser *parser)
1101 parser->cont = false;
1105 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1106 extern void trace_parser_put(struct trace_parser *parser);
1107 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1108 size_t cnt, loff_t *ppos);
1111 * Only create function graph options if function graph is configured.
1113 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1114 # define FGRAPH_FLAGS \
1115 C(DISPLAY_GRAPH, "display-graph"),
1117 # define FGRAPH_FLAGS
1120 #ifdef CONFIG_BRANCH_TRACER
1121 # define BRANCH_FLAGS \
1122 C(BRANCH, "branch"),
1124 # define BRANCH_FLAGS
1127 #ifdef CONFIG_FUNCTION_TRACER
1128 # define FUNCTION_FLAGS \
1129 C(FUNCTION, "function-trace"), \
1130 C(FUNC_FORK, "function-fork"),
1131 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1133 # define FUNCTION_FLAGS
1134 # define FUNCTION_DEFAULT_FLAGS 0UL
1135 # define TRACE_ITER_FUNC_FORK 0UL
1138 #ifdef CONFIG_STACKTRACE
1139 # define STACK_FLAGS \
1140 C(STACKTRACE, "stacktrace"),
1142 # define STACK_FLAGS
1146 * trace_iterator_flags is an enumeration that defines bit
1147 * positions into trace_flags that controls the output.
1149 * NOTE: These bits must match the trace_options array in
1150 * trace.c (this macro guarantees it).
1152 #define TRACE_FLAGS \
1153 C(PRINT_PARENT, "print-parent"), \
1154 C(SYM_OFFSET, "sym-offset"), \
1155 C(SYM_ADDR, "sym-addr"), \
1156 C(VERBOSE, "verbose"), \
1160 C(BLOCK, "block"), \
1161 C(PRINTK, "trace_printk"), \
1162 C(ANNOTATE, "annotate"), \
1163 C(USERSTACKTRACE, "userstacktrace"), \
1164 C(SYM_USEROBJ, "sym-userobj"), \
1165 C(PRINTK_MSGONLY, "printk-msg-only"), \
1166 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1167 C(LATENCY_FMT, "latency-format"), \
1168 C(RECORD_CMD, "record-cmd"), \
1169 C(RECORD_TGID, "record-tgid"), \
1170 C(OVERWRITE, "overwrite"), \
1171 C(STOP_ON_FREE, "disable_on_free"), \
1172 C(IRQ_INFO, "irq-info"), \
1173 C(MARKERS, "markers"), \
1174 C(EVENT_FORK, "event-fork"), \
1175 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1182 * By defining C, we can make TRACE_FLAGS a list of bit names
1183 * that will define the bits for the flag masks.
1186 #define C(a, b) TRACE_ITER_##a##_BIT
1188 enum trace_iterator_bits {
1190 /* Make sure we don't go more than we have bits for */
1195 * By redefining C, we can make TRACE_FLAGS a list of masks that
1196 * use the bits as defined above.
1199 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1201 enum trace_iterator_flags { TRACE_FLAGS };
1204 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1205 * control the output of kernel symbols.
1207 #define TRACE_ITER_SYM_MASK \
1208 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1210 extern struct tracer nop_trace;
1212 #ifdef CONFIG_BRANCH_TRACER
1213 extern int enable_branch_tracing(struct trace_array *tr);
1214 extern void disable_branch_tracing(void);
1215 static inline int trace_branch_enable(struct trace_array *tr)
1217 if (tr->trace_flags & TRACE_ITER_BRANCH)
1218 return enable_branch_tracing(tr);
1221 static inline void trace_branch_disable(void)
1223 /* due to races, always disable */
1224 disable_branch_tracing();
1227 static inline int trace_branch_enable(struct trace_array *tr)
1231 static inline void trace_branch_disable(void)
1234 #endif /* CONFIG_BRANCH_TRACER */
1236 /* set ring buffers to default size if not already done so */
1237 int tracing_update_buffers(void);
1239 struct ftrace_event_field {
1240 struct list_head link;
1251 struct event_filter {
1252 struct prog_entry __rcu *prog;
1253 char *filter_string;
1256 struct event_subsystem {
1257 struct list_head list;
1259 struct event_filter *filter;
1263 struct trace_subsystem_dir {
1264 struct list_head list;
1265 struct event_subsystem *subsystem;
1266 struct trace_array *tr;
1267 struct dentry *entry;
1272 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1273 struct trace_buffer *buffer,
1274 struct ring_buffer_event *event);
1276 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1277 struct trace_buffer *buffer,
1278 struct ring_buffer_event *event,
1279 unsigned int trcace_ctx,
1280 struct pt_regs *regs);
1282 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1283 struct trace_buffer *buffer,
1284 struct ring_buffer_event *event,
1285 unsigned int trace_ctx)
1287 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1290 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1291 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1292 void trace_buffered_event_disable(void);
1293 void trace_buffered_event_enable(void);
1296 __trace_event_discard_commit(struct trace_buffer *buffer,
1297 struct ring_buffer_event *event)
1299 if (this_cpu_read(trace_buffered_event) == event) {
1300 /* Simply release the temp buffer */
1301 this_cpu_dec(trace_buffered_event_cnt);
1304 ring_buffer_discard_commit(buffer, event);
1308 * Helper function for event_trigger_unlock_commit{_regs}().
1309 * If there are event triggers attached to this event that requires
1310 * filtering against its fields, then they will be called as the
1311 * entry already holds the field information of the current event.
1313 * It also checks if the event should be discarded or not.
1314 * It is to be discarded if the event is soft disabled and the
1315 * event was only recorded to process triggers, or if the event
1316 * filter is active and this event did not match the filters.
1318 * Returns true if the event is discarded, false otherwise.
1321 __event_trigger_test_discard(struct trace_event_file *file,
1322 struct trace_buffer *buffer,
1323 struct ring_buffer_event *event,
1325 enum event_trigger_type *tt)
1327 unsigned long eflags = file->flags;
1329 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1330 *tt = event_triggers_call(file, entry, event);
1332 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
1333 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
1334 !filter_match_preds(file->filter, entry))) {
1335 __trace_event_discard_commit(buffer, event);
1343 * event_trigger_unlock_commit - handle triggers and finish event commit
1344 * @file: The file pointer assoctiated to the event
1345 * @buffer: The ring buffer that the event is being written to
1346 * @event: The event meta data in the ring buffer
1347 * @entry: The event itself
1348 * @trace_ctx: The tracing context flags.
1350 * This is a helper function to handle triggers that require data
1351 * from the event itself. It also tests the event against filters and
1352 * if the event is soft disabled and should be discarded.
1355 event_trigger_unlock_commit(struct trace_event_file *file,
1356 struct trace_buffer *buffer,
1357 struct ring_buffer_event *event,
1358 void *entry, unsigned int trace_ctx)
1360 enum event_trigger_type tt = ETT_NONE;
1362 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1363 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1366 event_triggers_post_call(file, tt);
1370 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1371 * @file: The file pointer assoctiated to the event
1372 * @buffer: The ring buffer that the event is being written to
1373 * @event: The event meta data in the ring buffer
1374 * @entry: The event itself
1375 * @trace_ctx: The tracing context flags.
1377 * This is a helper function to handle triggers that require data
1378 * from the event itself. It also tests the event against filters and
1379 * if the event is soft disabled and should be discarded.
1381 * Same as event_trigger_unlock_commit() but calls
1382 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1385 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1386 struct trace_buffer *buffer,
1387 struct ring_buffer_event *event,
1388 void *entry, unsigned int trace_ctx,
1389 struct pt_regs *regs)
1391 enum event_trigger_type tt = ETT_NONE;
1393 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1394 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1398 event_triggers_post_call(file, tt);
1401 #define FILTER_PRED_INVALID ((unsigned short)-1)
1402 #define FILTER_PRED_IS_RIGHT (1 << 15)
1403 #define FILTER_PRED_FOLD (1 << 15)
1406 * The max preds is the size of unsigned short with
1407 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1408 * and FOLD flags. The other is reserved.
1410 * 2^14 preds is way more than enough.
1412 #define MAX_FILTER_PRED 16384
1417 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1419 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1431 char pattern[MAX_FILTER_STR_VAL];
1434 regex_match_func match;
1437 struct filter_pred {
1438 filter_pred_fn_t fn;
1441 unsigned short *ops;
1442 struct ftrace_event_field *field;
1448 static inline bool is_string_field(struct ftrace_event_field *field)
1450 return field->filter_type == FILTER_DYN_STRING ||
1451 field->filter_type == FILTER_STATIC_STRING ||
1452 field->filter_type == FILTER_PTR_STRING ||
1453 field->filter_type == FILTER_COMM;
1456 static inline bool is_function_field(struct ftrace_event_field *field)
1458 return field->filter_type == FILTER_TRACE_FN;
1461 extern enum regex_type
1462 filter_parse_regex(char *buff, int len, char **search, int *not);
1463 extern void print_event_filter(struct trace_event_file *file,
1464 struct trace_seq *s);
1465 extern int apply_event_filter(struct trace_event_file *file,
1466 char *filter_string);
1467 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1468 char *filter_string);
1469 extern void print_subsystem_event_filter(struct event_subsystem *system,
1470 struct trace_seq *s);
1471 extern int filter_assign_type(const char *type);
1472 extern int create_event_filter(struct trace_array *tr,
1473 struct trace_event_call *call,
1474 char *filter_str, bool set_str,
1475 struct event_filter **filterp);
1476 extern void free_event_filter(struct event_filter *filter);
1478 struct ftrace_event_field *
1479 trace_find_event_field(struct trace_event_call *call, char *name);
1481 extern void trace_event_enable_cmd_record(bool enable);
1482 extern void trace_event_enable_tgid_record(bool enable);
1484 extern int event_trace_init(void);
1485 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1486 extern int event_trace_del_tracer(struct trace_array *tr);
1487 extern void __trace_early_add_events(struct trace_array *tr);
1489 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1492 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1496 static inline void *event_file_data(struct file *filp)
1498 return READ_ONCE(file_inode(filp)->i_private);
1501 extern struct mutex event_mutex;
1502 extern struct list_head ftrace_events;
1504 extern const struct file_operations event_trigger_fops;
1505 extern const struct file_operations event_hist_fops;
1506 extern const struct file_operations event_hist_debug_fops;
1507 extern const struct file_operations event_inject_fops;
1509 #ifdef CONFIG_HIST_TRIGGERS
1510 extern int register_trigger_hist_cmd(void);
1511 extern int register_trigger_hist_enable_disable_cmds(void);
1513 static inline int register_trigger_hist_cmd(void) { return 0; }
1514 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1517 extern int register_trigger_cmds(void);
1518 extern void clear_event_triggers(struct trace_array *tr);
1520 struct event_trigger_data {
1521 unsigned long count;
1523 struct event_trigger_ops *ops;
1524 struct event_command *cmd_ops;
1525 struct event_filter __rcu *filter;
1530 struct list_head list;
1532 struct list_head named_list;
1533 struct event_trigger_data *named_data;
1537 #define ENABLE_EVENT_STR "enable_event"
1538 #define DISABLE_EVENT_STR "disable_event"
1539 #define ENABLE_HIST_STR "enable_hist"
1540 #define DISABLE_HIST_STR "disable_hist"
1542 struct enable_trigger_data {
1543 struct trace_event_file *file;
1548 extern int event_enable_trigger_print(struct seq_file *m,
1549 struct event_trigger_ops *ops,
1550 struct event_trigger_data *data);
1551 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1552 struct event_trigger_data *data);
1553 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1554 struct trace_event_file *file,
1555 char *glob, char *cmd, char *param);
1556 extern int event_enable_register_trigger(char *glob,
1557 struct event_trigger_ops *ops,
1558 struct event_trigger_data *data,
1559 struct trace_event_file *file);
1560 extern void event_enable_unregister_trigger(char *glob,
1561 struct event_trigger_ops *ops,
1562 struct event_trigger_data *test,
1563 struct trace_event_file *file);
1564 extern void trigger_data_free(struct event_trigger_data *data);
1565 extern int event_trigger_init(struct event_trigger_ops *ops,
1566 struct event_trigger_data *data);
1567 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1568 int trigger_enable);
1569 extern void update_cond_flag(struct trace_event_file *file);
1570 extern int set_trigger_filter(char *filter_str,
1571 struct event_trigger_data *trigger_data,
1572 struct trace_event_file *file);
1573 extern struct event_trigger_data *find_named_trigger(const char *name);
1574 extern bool is_named_trigger(struct event_trigger_data *test);
1575 extern int save_named_trigger(const char *name,
1576 struct event_trigger_data *data);
1577 extern void del_named_trigger(struct event_trigger_data *data);
1578 extern void pause_named_trigger(struct event_trigger_data *data);
1579 extern void unpause_named_trigger(struct event_trigger_data *data);
1580 extern void set_named_trigger_data(struct event_trigger_data *data,
1581 struct event_trigger_data *named_data);
1582 extern struct event_trigger_data *
1583 get_named_trigger_data(struct event_trigger_data *data);
1584 extern int register_event_command(struct event_command *cmd);
1585 extern int unregister_event_command(struct event_command *cmd);
1586 extern int register_trigger_hist_enable_disable_cmds(void);
1589 * struct event_trigger_ops - callbacks for trace event triggers
1591 * The methods in this structure provide per-event trigger hooks for
1592 * various trigger operations.
1594 * All the methods below, except for @init() and @free(), must be
1597 * @func: The trigger 'probe' function called when the triggering
1598 * event occurs. The data passed into this callback is the data
1599 * that was supplied to the event_command @reg() function that
1600 * registered the trigger (see struct event_command) along with
1601 * the trace record, rec.
1603 * @init: An optional initialization function called for the trigger
1604 * when the trigger is registered (via the event_command reg()
1605 * function). This can be used to perform per-trigger
1606 * initialization such as incrementing a per-trigger reference
1607 * count, for instance. This is usually implemented by the
1608 * generic utility function @event_trigger_init() (see
1609 * trace_event_triggers.c).
1611 * @free: An optional de-initialization function called for the
1612 * trigger when the trigger is unregistered (via the
1613 * event_command @reg() function). This can be used to perform
1614 * per-trigger de-initialization such as decrementing a
1615 * per-trigger reference count and freeing corresponding trigger
1616 * data, for instance. This is usually implemented by the
1617 * generic utility function @event_trigger_free() (see
1618 * trace_event_triggers.c).
1620 * @print: The callback function invoked to have the trigger print
1621 * itself. This is usually implemented by a wrapper function
1622 * that calls the generic utility function @event_trigger_print()
1623 * (see trace_event_triggers.c).
1625 struct event_trigger_ops {
1626 void (*func)(struct event_trigger_data *data,
1628 struct ring_buffer_event *rbe);
1629 int (*init)(struct event_trigger_ops *ops,
1630 struct event_trigger_data *data);
1631 void (*free)(struct event_trigger_ops *ops,
1632 struct event_trigger_data *data);
1633 int (*print)(struct seq_file *m,
1634 struct event_trigger_ops *ops,
1635 struct event_trigger_data *data);
1639 * struct event_command - callbacks and data members for event commands
1641 * Event commands are invoked by users by writing the command name
1642 * into the 'trigger' file associated with a trace event. The
1643 * parameters associated with a specific invocation of an event
1644 * command are used to create an event trigger instance, which is
1645 * added to the list of trigger instances associated with that trace
1646 * event. When the event is hit, the set of triggers associated with
1647 * that event is invoked.
1649 * The data members in this structure provide per-event command data
1650 * for various event commands.
1652 * All the data members below, except for @post_trigger, must be set
1653 * for each event command.
1655 * @name: The unique name that identifies the event command. This is
1656 * the name used when setting triggers via trigger files.
1658 * @trigger_type: A unique id that identifies the event command
1659 * 'type'. This value has two purposes, the first to ensure that
1660 * only one trigger of the same type can be set at a given time
1661 * for a particular event e.g. it doesn't make sense to have both
1662 * a traceon and traceoff trigger attached to a single event at
1663 * the same time, so traceon and traceoff have the same type
1664 * though they have different names. The @trigger_type value is
1665 * also used as a bit value for deferring the actual trigger
1666 * action until after the current event is finished. Some
1667 * commands need to do this if they themselves log to the trace
1668 * buffer (see the @post_trigger() member below). @trigger_type
1669 * values are defined by adding new values to the trigger_type
1670 * enum in include/linux/trace_events.h.
1672 * @flags: See the enum event_command_flags below.
1674 * All the methods below, except for @set_filter() and @unreg_all(),
1675 * must be implemented.
1677 * @func: The callback function responsible for parsing and
1678 * registering the trigger written to the 'trigger' file by the
1679 * user. It allocates the trigger instance and registers it with
1680 * the appropriate trace event. It makes use of the other
1681 * event_command callback functions to orchestrate this, and is
1682 * usually implemented by the generic utility function
1683 * @event_trigger_callback() (see trace_event_triggers.c).
1685 * @reg: Adds the trigger to the list of triggers associated with the
1686 * event, and enables the event trigger itself, after
1687 * initializing it (via the event_trigger_ops @init() function).
1688 * This is also where commands can use the @trigger_type value to
1689 * make the decision as to whether or not multiple instances of
1690 * the trigger should be allowed. This is usually implemented by
1691 * the generic utility function @register_trigger() (see
1692 * trace_event_triggers.c).
1694 * @unreg: Removes the trigger from the list of triggers associated
1695 * with the event, and disables the event trigger itself, after
1696 * initializing it (via the event_trigger_ops @free() function).
1697 * This is usually implemented by the generic utility function
1698 * @unregister_trigger() (see trace_event_triggers.c).
1700 * @unreg_all: An optional function called to remove all the triggers
1701 * from the list of triggers associated with the event. Called
1702 * when a trigger file is opened in truncate mode.
1704 * @set_filter: An optional function called to parse and set a filter
1705 * for the trigger. If no @set_filter() method is set for the
1706 * event command, filters set by the user for the command will be
1707 * ignored. This is usually implemented by the generic utility
1708 * function @set_trigger_filter() (see trace_event_triggers.c).
1710 * @get_trigger_ops: The callback function invoked to retrieve the
1711 * event_trigger_ops implementation associated with the command.
1713 struct event_command {
1714 struct list_head list;
1716 enum event_trigger_type trigger_type;
1718 int (*func)(struct event_command *cmd_ops,
1719 struct trace_event_file *file,
1720 char *glob, char *cmd, char *params);
1721 int (*reg)(char *glob,
1722 struct event_trigger_ops *ops,
1723 struct event_trigger_data *data,
1724 struct trace_event_file *file);
1725 void (*unreg)(char *glob,
1726 struct event_trigger_ops *ops,
1727 struct event_trigger_data *data,
1728 struct trace_event_file *file);
1729 void (*unreg_all)(struct trace_event_file *file);
1730 int (*set_filter)(char *filter_str,
1731 struct event_trigger_data *data,
1732 struct trace_event_file *file);
1733 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1737 * enum event_command_flags - flags for struct event_command
1739 * @POST_TRIGGER: A flag that says whether or not this command needs
1740 * to have its action delayed until after the current event has
1741 * been closed. Some triggers need to avoid being invoked while
1742 * an event is currently in the process of being logged, since
1743 * the trigger may itself log data into the trace buffer. Thus
1744 * we make sure the current event is committed before invoking
1745 * those triggers. To do that, the trigger invocation is split
1746 * in two - the first part checks the filter using the current
1747 * trace record; if a command has the @post_trigger flag set, it
1748 * sets a bit for itself in the return value, otherwise it
1749 * directly invokes the trigger. Once all commands have been
1750 * either invoked or set their return flag, the current record is
1751 * either committed or discarded. At that point, if any commands
1752 * have deferred their triggers, those commands are finally
1753 * invoked following the close of the current event. In other
1754 * words, if the event_trigger_ops @func() probe implementation
1755 * itself logs to the trace buffer, this flag should be set,
1756 * otherwise it can be left unspecified.
1758 * @NEEDS_REC: A flag that says whether or not this command needs
1759 * access to the trace record in order to perform its function,
1760 * regardless of whether or not it has a filter associated with
1761 * it (filters make a trigger require access to the trace record
1762 * but are not always present).
1764 enum event_command_flags {
1765 EVENT_CMD_FL_POST_TRIGGER = 1,
1766 EVENT_CMD_FL_NEEDS_REC = 2,
1769 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1771 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1774 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1776 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1779 extern int trace_event_enable_disable(struct trace_event_file *file,
1780 int enable, int soft_disable);
1781 extern int tracing_alloc_snapshot(void);
1782 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1783 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1785 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1786 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1788 extern const char *__start___trace_bprintk_fmt[];
1789 extern const char *__stop___trace_bprintk_fmt[];
1791 extern const char *__start___tracepoint_str[];
1792 extern const char *__stop___tracepoint_str[];
1794 void trace_printk_control(bool enabled);
1795 void trace_printk_start_comm(void);
1796 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1797 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1799 /* Used from boot time tracer */
1800 extern int trace_set_options(struct trace_array *tr, char *option);
1801 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1802 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1803 unsigned long size, int cpu_id);
1804 extern int tracing_set_cpumask(struct trace_array *tr,
1805 cpumask_var_t tracing_cpumask_new);
1808 #define MAX_EVENT_NAME_LEN 64
1810 extern int trace_run_command(const char *buf, int (*createfn)(int, char**));
1811 extern ssize_t trace_parse_run_command(struct file *file,
1812 const char __user *buffer, size_t count, loff_t *ppos,
1813 int (*createfn)(int, char**));
1815 extern unsigned int err_pos(char *cmd, const char *str);
1816 extern void tracing_log_err(struct trace_array *tr,
1817 const char *loc, const char *cmd,
1818 const char **errs, u8 type, u8 pos);
1821 * Normal trace_printk() and friends allocates special buffers
1822 * to do the manipulation, as well as saves the print formats
1823 * into sections to display. But the trace infrastructure wants
1824 * to use these without the added overhead at the price of being
1825 * a bit slower (used mainly for warnings, where we don't care
1826 * about performance). The internal_trace_puts() is for such
1829 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1832 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1833 extern struct trace_event_call \
1834 __aligned(4) event_##call;
1835 #undef FTRACE_ENTRY_DUP
1836 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1837 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1838 #undef FTRACE_ENTRY_PACKED
1839 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1840 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1842 #include "trace_entries.h"
1844 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1845 int perf_ftrace_event_register(struct trace_event_call *call,
1846 enum trace_reg type, void *data);
1848 #define perf_ftrace_event_register NULL
1851 #ifdef CONFIG_FTRACE_SYSCALLS
1852 void init_ftrace_syscalls(void);
1853 const char *get_syscall_name(int syscall);
1855 static inline void init_ftrace_syscalls(void) { }
1856 static inline const char *get_syscall_name(int syscall)
1862 #ifdef CONFIG_EVENT_TRACING
1863 void trace_event_init(void);
1864 void trace_event_eval_update(struct trace_eval_map **map, int len);
1865 /* Used from boot time tracer */
1866 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1867 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1869 static inline void __init trace_event_init(void) { }
1870 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1873 #ifdef CONFIG_TRACER_SNAPSHOT
1874 void tracing_snapshot_instance(struct trace_array *tr);
1875 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1877 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1878 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1884 #ifdef CONFIG_PREEMPT_TRACER
1885 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1886 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1888 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1889 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1891 #ifdef CONFIG_IRQSOFF_TRACER
1892 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1893 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1895 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1896 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1899 extern struct trace_iterator *tracepoint_print_iter;
1902 * Reset the state of the trace_iterator so that it can read consumed data.
1903 * Normally, the trace_iterator is used for reading the data when it is not
1904 * consumed, and must retain state.
1906 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1908 const size_t offset = offsetof(struct trace_iterator, seq);
1911 * Keep gcc from complaining about overwriting more than just one
1912 * member in the structure.
1914 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1919 /* Check the name is good for event/group/fields */
1920 static inline bool is_good_name(const char *name)
1922 if (!isalpha(*name) && *name != '_')
1924 while (*++name != '\0') {
1925 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1931 #endif /* _LINUX_KERNEL_TRACE_H */