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>
23 #ifdef CONFIG_FTRACE_SYSCALLS
24 #include <asm/unistd.h> /* For NR_SYSCALLS */
25 #include <asm/syscall.h> /* some archs define it here */
29 __TRACE_FIRST_TYPE = 0,
53 #define __field(type, item) type item;
56 #define __field_fn(type, item) type item;
59 #define __field_struct(type, item) __field(type, item)
62 #define __field_desc(type, container, item)
65 #define __field_packed(type, container, item)
68 #define __array(type, item, size) type item[size];
71 #define __array_desc(type, container, item, size)
73 #undef __dynamic_array
74 #define __dynamic_array(type, item) type item[];
77 #define F_STRUCT(args...) args
80 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
81 struct struct_name { \
82 struct trace_entry ent; \
86 #undef FTRACE_ENTRY_DUP
87 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
89 #undef FTRACE_ENTRY_REG
90 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
91 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
93 #undef FTRACE_ENTRY_PACKED
94 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
95 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
97 #include "trace_entries.h"
99 /* Use this for memory failure errors */
100 #define MEM_FAIL(condition, fmt, ...) ({ \
101 static bool __section(.data.once) __warned; \
102 int __ret_warn_once = !!(condition); \
104 if (unlikely(__ret_warn_once && !__warned)) { \
106 pr_err("ERROR: " fmt, ##__VA_ARGS__); \
108 unlikely(__ret_warn_once); \
112 * syscalls are special, and need special handling, this is why
113 * they are not included in trace_entries.h
115 struct syscall_trace_enter {
116 struct trace_entry ent;
118 unsigned long args[];
121 struct syscall_trace_exit {
122 struct trace_entry ent;
127 struct kprobe_trace_entry_head {
128 struct trace_entry ent;
132 struct kretprobe_trace_entry_head {
133 struct trace_entry ent;
135 unsigned long ret_ip;
139 * trace_flag_type is an enumeration that holds different
140 * states when a trace occurs. These are:
141 * IRQS_OFF - interrupts were disabled
142 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
143 * NEED_RESCHED - reschedule is requested
144 * HARDIRQ - inside an interrupt handler
145 * SOFTIRQ - inside a softirq handler
147 enum trace_flag_type {
148 TRACE_FLAG_IRQS_OFF = 0x01,
149 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
150 TRACE_FLAG_NEED_RESCHED = 0x04,
151 TRACE_FLAG_HARDIRQ = 0x08,
152 TRACE_FLAG_SOFTIRQ = 0x10,
153 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
154 TRACE_FLAG_NMI = 0x40,
157 #define TRACE_BUF_SIZE 1024
162 * The CPU trace array - it consists of thousands of trace entries
163 * plus some other descriptor data: (for example which task started
166 struct trace_array_cpu {
168 void *buffer_page; /* ring buffer spare */
170 unsigned long entries;
171 unsigned long saved_latency;
172 unsigned long critical_start;
173 unsigned long critical_end;
174 unsigned long critical_sequence;
176 unsigned long policy;
177 unsigned long rt_priority;
178 unsigned long skipped_entries;
179 u64 preempt_timestamp;
182 char comm[TASK_COMM_LEN];
184 #ifdef CONFIG_FUNCTION_TRACER
185 int ftrace_ignore_pid;
191 struct trace_option_dentry;
193 struct array_buffer {
194 struct trace_array *tr;
195 struct trace_buffer *buffer;
196 struct trace_array_cpu __percpu *data;
201 #define TRACE_FLAGS_MAX_SIZE 32
203 struct trace_options {
204 struct tracer *tracer;
205 struct trace_option_dentry *topts;
208 struct trace_pid_list {
215 TRACE_NO_PIDS = BIT(1),
218 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
219 struct trace_pid_list *no_pid_list)
221 /* Return true if the pid list in type has pids */
222 return ((type & TRACE_PIDS) && pid_list) ||
223 ((type & TRACE_NO_PIDS) && no_pid_list);
226 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
227 struct trace_pid_list *no_pid_list)
230 * Turning off what is in @type, return true if the "other"
231 * pid list, still has pids in it.
233 return (!(type & TRACE_PIDS) && pid_list) ||
234 (!(type & TRACE_NO_PIDS) && no_pid_list);
237 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
240 * struct cond_snapshot - conditional snapshot data and callback
242 * The cond_snapshot structure encapsulates a callback function and
243 * data associated with the snapshot for a given tracing instance.
245 * When a snapshot is taken conditionally, by invoking
246 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
247 * passed in turn to the cond_snapshot.update() function. That data
248 * can be compared by the update() implementation with the cond_data
249 * contained wihin the struct cond_snapshot instance associated with
250 * the trace_array. Because the tr->max_lock is held throughout the
251 * update() call, the update() function can directly retrieve the
252 * cond_snapshot and cond_data associated with the per-instance
253 * snapshot associated with the trace_array.
255 * The cond_snapshot.update() implementation can save data to be
256 * associated with the snapshot if it decides to, and returns 'true'
257 * in that case, or it returns 'false' if the conditional snapshot
258 * shouldn't be taken.
260 * The cond_snapshot instance is created and associated with the
261 * user-defined cond_data by tracing_cond_snapshot_enable().
262 * Likewise, the cond_snapshot instance is destroyed and is no longer
263 * associated with the trace instance by
264 * tracing_cond_snapshot_disable().
266 * The method below is required.
268 * @update: When a conditional snapshot is invoked, the update()
269 * callback function is invoked with the tr->max_lock held. The
270 * update() implementation signals whether or not to actually
271 * take the snapshot, by returning 'true' if so, 'false' if no
272 * snapshot should be taken. Because the max_lock is held for
273 * the duration of update(), the implementation is safe to
274 * directly retrieven and save any implementation data it needs
275 * to in association with the snapshot.
277 struct cond_snapshot {
279 cond_update_fn_t update;
283 * The trace array - an array of per-CPU trace arrays. This is the
284 * highest level data structure that individual tracers deal with.
285 * They have on/off state as well:
288 struct list_head list;
290 struct array_buffer array_buffer;
291 #ifdef CONFIG_TRACER_MAX_TRACE
293 * The max_buffer is used to snapshot the trace when a maximum
294 * latency is reached, or when the user initiates a snapshot.
295 * Some tracers will use this to store a maximum trace while
296 * it continues examining live traces.
298 * The buffers for the max_buffer are set up the same as the array_buffer
299 * When a snapshot is taken, the buffer of the max_buffer is swapped
300 * with the buffer of the array_buffer and the buffers are reset for
301 * the array_buffer so the tracing can continue.
303 struct array_buffer max_buffer;
304 bool allocated_snapshot;
306 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
307 unsigned long max_latency;
308 #ifdef CONFIG_FSNOTIFY
309 struct dentry *d_max_latency;
310 struct work_struct fsnotify_work;
311 struct irq_work fsnotify_irqwork;
314 struct trace_pid_list __rcu *filtered_pids;
315 struct trace_pid_list __rcu *filtered_no_pids;
317 * max_lock is used to protect the swapping of buffers
318 * when taking a max snapshot. The buffers themselves are
319 * protected by per_cpu spinlocks. But the action of the swap
320 * needs its own lock.
322 * This is defined as a arch_spinlock_t in order to help
323 * with performance when lockdep debugging is enabled.
325 * It is also used in other places outside the update_max_tr
326 * so it needs to be defined outside of the
327 * CONFIG_TRACER_MAX_TRACE.
329 arch_spinlock_t max_lock;
331 #ifdef CONFIG_FTRACE_SYSCALLS
332 int sys_refcount_enter;
333 int sys_refcount_exit;
334 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
335 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
342 unsigned int n_err_log_entries;
343 struct tracer *current_trace;
344 unsigned int trace_flags;
345 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
347 raw_spinlock_t start_lock;
348 struct list_head err_log;
350 struct dentry *options;
351 struct dentry *percpu_dir;
352 struct dentry *event_dir;
353 struct trace_options *topts;
354 struct list_head systems;
355 struct list_head events;
356 struct trace_event_file *trace_marker_file;
357 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
360 #ifdef CONFIG_FUNCTION_TRACER
361 struct ftrace_ops *ops;
362 struct trace_pid_list __rcu *function_pids;
363 struct trace_pid_list __rcu *function_no_pids;
364 #ifdef CONFIG_DYNAMIC_FTRACE
365 /* All of these are protected by the ftrace_lock */
366 struct list_head func_probes;
367 struct list_head mod_trace;
368 struct list_head mod_notrace;
370 /* function tracing enabled */
371 int function_enabled;
373 int time_stamp_abs_ref;
374 struct list_head hist_vars;
375 #ifdef CONFIG_TRACER_SNAPSHOT
376 struct cond_snapshot *cond_snapshot;
381 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
384 extern struct list_head ftrace_trace_arrays;
386 extern struct mutex trace_types_lock;
388 extern int trace_array_get(struct trace_array *tr);
389 extern int tracing_check_open_get_tr(struct trace_array *tr);
390 extern struct trace_array *trace_array_find(const char *instance);
391 extern struct trace_array *trace_array_find_get(const char *instance);
393 extern int tracing_set_time_stamp_abs(struct trace_array *tr, bool abs);
394 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
396 extern bool trace_clock_in_ns(struct trace_array *tr);
399 * The global tracer (top) should be the first trace array added,
400 * but we check the flag anyway.
402 static inline struct trace_array *top_trace_array(void)
404 struct trace_array *tr;
406 if (list_empty(&ftrace_trace_arrays))
409 tr = list_entry(ftrace_trace_arrays.prev,
411 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
415 #define FTRACE_CMP_TYPE(var, type) \
416 __builtin_types_compatible_p(typeof(var), type *)
419 #define IF_ASSIGN(var, entry, etype, id) \
420 if (FTRACE_CMP_TYPE(var, etype)) { \
421 var = (typeof(var))(entry); \
422 WARN_ON(id != 0 && (entry)->type != id); \
426 /* Will cause compile errors if type is not found. */
427 extern void __ftrace_bad_type(void);
430 * The trace_assign_type is a verifier that the entry type is
431 * the same as the type being assigned. To add new types simply
432 * add a line with the following format:
434 * IF_ASSIGN(var, ent, type, id);
436 * Where "type" is the trace type that includes the trace_entry
437 * as the "ent" item. And "id" is the trace identifier that is
438 * used in the trace_type enum.
440 * If the type can have more than one id, then use zero.
442 #define trace_assign_type(var, ent) \
444 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
445 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
446 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
447 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
448 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
449 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
450 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
451 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
452 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
453 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
455 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
457 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
458 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
460 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
462 __ftrace_bad_type(); \
466 * An option specific to a tracer. This is a boolean value.
467 * The bit is the bit index that sets its value on the
468 * flags value in struct tracer_flags.
471 const char *name; /* Will appear on the trace_options file */
472 u32 bit; /* Mask assigned in val field in tracer_flags */
476 * The set of specific options for a tracer. Your tracer
477 * have to set the initial value of the flags val.
479 struct tracer_flags {
481 struct tracer_opt *opts;
482 struct tracer *trace;
485 /* Makes more easy to define a tracer opt */
486 #define TRACER_OPT(s, b) .name = #s, .bit = b
489 struct trace_option_dentry {
490 struct tracer_opt *opt;
491 struct tracer_flags *flags;
492 struct trace_array *tr;
493 struct dentry *entry;
497 * struct tracer - a specific tracer and its callbacks to interact with tracefs
498 * @name: the name chosen to select it on the available_tracers file
499 * @init: called when one switches to this tracer (echo name > current_tracer)
500 * @reset: called when one switches to another tracer
501 * @start: called when tracing is unpaused (echo 1 > tracing_on)
502 * @stop: called when tracing is paused (echo 0 > tracing_on)
503 * @update_thresh: called when tracing_thresh is updated
504 * @open: called when the trace file is opened
505 * @pipe_open: called when the trace_pipe file is opened
506 * @close: called when the trace file is released
507 * @pipe_close: called when the trace_pipe file is released
508 * @read: override the default read callback on trace_pipe
509 * @splice_read: override the default splice_read callback on trace_pipe
510 * @selftest: selftest to run on boot (see trace_selftest.c)
511 * @print_headers: override the first lines that describe your columns
512 * @print_line: callback that prints a trace
513 * @set_flag: signals one of your private flags changed (trace_options file)
514 * @flags: your private flags
518 int (*init)(struct trace_array *tr);
519 void (*reset)(struct trace_array *tr);
520 void (*start)(struct trace_array *tr);
521 void (*stop)(struct trace_array *tr);
522 int (*update_thresh)(struct trace_array *tr);
523 void (*open)(struct trace_iterator *iter);
524 void (*pipe_open)(struct trace_iterator *iter);
525 void (*close)(struct trace_iterator *iter);
526 void (*pipe_close)(struct trace_iterator *iter);
527 ssize_t (*read)(struct trace_iterator *iter,
528 struct file *filp, char __user *ubuf,
529 size_t cnt, loff_t *ppos);
530 ssize_t (*splice_read)(struct trace_iterator *iter,
533 struct pipe_inode_info *pipe,
536 #ifdef CONFIG_FTRACE_STARTUP_TEST
537 int (*selftest)(struct tracer *trace,
538 struct trace_array *tr);
540 void (*print_header)(struct seq_file *m);
541 enum print_line_t (*print_line)(struct trace_iterator *iter);
542 /* If you handled the flag setting, return 0 */
543 int (*set_flag)(struct trace_array *tr,
544 u32 old_flags, u32 bit, int set);
545 /* Return 0 if OK with change, else return non-zero */
546 int (*flag_changed)(struct trace_array *tr,
549 struct tracer_flags *flags;
552 bool allow_instances;
553 #ifdef CONFIG_TRACER_MAX_TRACE
556 /* True if tracer cannot be enabled in kernel param */
561 /* Only current can touch trace_recursion */
564 * For function tracing recursion:
565 * The order of these bits are important.
567 * When function tracing occurs, the following steps are made:
568 * If arch does not support a ftrace feature:
569 * call internal function (uses INTERNAL bits) which calls...
570 * If callback is registered to the "global" list, the list
571 * function is called and recursion checks the GLOBAL bits.
572 * then this function calls...
573 * The function callback, which can use the FTRACE bits to
574 * check for recursion.
576 * Now if the arch does not suppport a feature, and it calls
577 * the global list function which calls the ftrace callback
578 * all three of these steps will do a recursion protection.
579 * There's no reason to do one if the previous caller already
580 * did. The recursion that we are protecting against will
581 * go through the same steps again.
583 * To prevent the multiple recursion checks, if a recursion
584 * bit is set that is higher than the MAX bit of the current
585 * check, then we know that the check was made by the previous
586 * caller, and we can skip the current check.
589 /* Function recursion bits */
591 TRACE_FTRACE_NMI_BIT,
592 TRACE_FTRACE_IRQ_BIT,
593 TRACE_FTRACE_SIRQ_BIT,
595 /* INTERNAL_BITs must be greater than FTRACE_BITs */
597 TRACE_INTERNAL_NMI_BIT,
598 TRACE_INTERNAL_IRQ_BIT,
599 TRACE_INTERNAL_SIRQ_BIT,
603 * Abuse of the trace_recursion.
604 * As we need a way to maintain state if we are tracing the function
605 * graph in irq because we want to trace a particular function that
606 * was called in irq context but we have irq tracing off. Since this
607 * can only be modified by current, we can reuse trace_recursion.
611 /* Set if the function is in the set_graph_function file */
615 * In the very unlikely case that an interrupt came in
616 * at a start of graph tracing, and we want to trace
617 * the function in that interrupt, the depth can be greater
618 * than zero, because of the preempted start of a previous
619 * trace. In an even more unlikely case, depth could be 2
620 * if a softirq interrupted the start of graph tracing,
621 * followed by an interrupt preempting a start of graph
622 * tracing in the softirq, and depth can even be 3
623 * if an NMI came in at the start of an interrupt function
624 * that preempted a softirq start of a function that
625 * preempted normal context!!!! Luckily, it can't be
626 * greater than 3, so the next two bits are a mask
627 * of what the depth is when we set TRACE_GRAPH_BIT
630 TRACE_GRAPH_DEPTH_START_BIT,
631 TRACE_GRAPH_DEPTH_END_BIT,
634 * To implement set_graph_notrace, if this bit is set, we ignore
635 * function graph tracing of called functions, until the return
636 * function is called to clear it.
638 TRACE_GRAPH_NOTRACE_BIT,
641 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
642 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
643 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
645 #define trace_recursion_depth() \
646 (((current)->trace_recursion >> TRACE_GRAPH_DEPTH_START_BIT) & 3)
647 #define trace_recursion_set_depth(depth) \
649 current->trace_recursion &= \
650 ~(3 << TRACE_GRAPH_DEPTH_START_BIT); \
651 current->trace_recursion |= \
652 ((depth) & 3) << TRACE_GRAPH_DEPTH_START_BIT; \
655 #define TRACE_CONTEXT_BITS 4
657 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
658 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
660 #define TRACE_LIST_START TRACE_INTERNAL_BIT
661 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
663 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
665 static __always_inline int trace_get_context_bit(void)
669 if (in_interrupt()) {
683 static __always_inline int trace_test_and_set_recursion(int start, int max)
685 unsigned int val = current->trace_recursion;
688 /* A previous recursion check was made */
689 if ((val & TRACE_CONTEXT_MASK) > max)
692 bit = trace_get_context_bit() + start;
693 if (unlikely(val & (1 << bit)))
697 current->trace_recursion = val;
703 static __always_inline void trace_clear_recursion(int bit)
705 unsigned int val = current->trace_recursion;
714 current->trace_recursion = val;
717 static inline struct ring_buffer_iter *
718 trace_buffer_iter(struct trace_iterator *iter, int cpu)
720 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
723 int tracer_init(struct tracer *t, struct trace_array *tr);
724 int tracing_is_enabled(void);
725 void tracing_reset_online_cpus(struct array_buffer *buf);
726 void tracing_reset_current(int cpu);
727 void tracing_reset_all_online_cpus(void);
728 int tracing_open_generic(struct inode *inode, struct file *filp);
729 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
730 bool tracing_is_disabled(void);
731 bool tracer_tracing_is_on(struct trace_array *tr);
732 void tracer_tracing_on(struct trace_array *tr);
733 void tracer_tracing_off(struct trace_array *tr);
734 struct dentry *trace_create_file(const char *name,
736 struct dentry *parent,
738 const struct file_operations *fops);
740 int tracing_init_dentry(void);
742 struct ring_buffer_event;
744 struct ring_buffer_event *
745 trace_buffer_lock_reserve(struct trace_buffer *buffer,
751 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
752 struct trace_array_cpu *data);
754 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
755 int *ent_cpu, u64 *ent_ts);
757 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
758 struct ring_buffer_event *event);
760 int trace_empty(struct trace_iterator *iter);
762 void *trace_find_next_entry_inc(struct trace_iterator *iter);
764 void trace_init_global_iter(struct trace_iterator *iter);
766 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
768 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
769 unsigned long trace_total_entries(struct trace_array *tr);
771 void trace_function(struct trace_array *tr,
773 unsigned long parent_ip,
774 unsigned long flags, int pc);
775 void trace_graph_function(struct trace_array *tr,
777 unsigned long parent_ip,
778 unsigned long flags, int pc);
779 void trace_latency_header(struct seq_file *m);
780 void trace_default_header(struct seq_file *m);
781 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
782 int trace_empty(struct trace_iterator *iter);
784 void trace_graph_return(struct ftrace_graph_ret *trace);
785 int trace_graph_entry(struct ftrace_graph_ent *trace);
786 void set_graph_array(struct trace_array *tr);
788 void tracing_start_cmdline_record(void);
789 void tracing_stop_cmdline_record(void);
790 void tracing_start_tgid_record(void);
791 void tracing_stop_tgid_record(void);
793 int register_tracer(struct tracer *type);
794 int is_tracing_stopped(void);
796 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
798 extern cpumask_var_t __read_mostly tracing_buffer_mask;
800 #define for_each_tracing_cpu(cpu) \
801 for_each_cpu(cpu, tracing_buffer_mask)
803 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
805 extern unsigned long tracing_thresh;
811 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
813 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
814 struct trace_pid_list *filtered_no_pids,
815 struct task_struct *task);
816 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
817 struct task_struct *self,
818 struct task_struct *task);
819 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
820 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
821 int trace_pid_show(struct seq_file *m, void *v);
822 void trace_free_pid_list(struct trace_pid_list *pid_list);
823 int trace_pid_write(struct trace_pid_list *filtered_pids,
824 struct trace_pid_list **new_pid_list,
825 const char __user *ubuf, size_t cnt);
827 #ifdef CONFIG_TRACER_MAX_TRACE
828 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
830 void update_max_tr_single(struct trace_array *tr,
831 struct task_struct *tsk, int cpu);
832 #endif /* CONFIG_TRACER_MAX_TRACE */
834 #if (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)) && \
835 defined(CONFIG_FSNOTIFY)
837 void latency_fsnotify(struct trace_array *tr);
841 static inline void latency_fsnotify(struct trace_array *tr) { }
845 #ifdef CONFIG_STACKTRACE
846 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
849 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
853 #endif /* CONFIG_STACKTRACE */
855 extern u64 ftrace_now(int cpu);
857 extern void trace_find_cmdline(int pid, char comm[]);
858 extern int trace_find_tgid(int pid);
859 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
861 #ifdef CONFIG_DYNAMIC_FTRACE
862 extern unsigned long ftrace_update_tot_cnt;
863 extern unsigned long ftrace_number_of_pages;
864 extern unsigned long ftrace_number_of_groups;
865 void ftrace_init_trace_array(struct trace_array *tr);
867 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
869 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
870 extern int DYN_FTRACE_TEST_NAME(void);
871 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
872 extern int DYN_FTRACE_TEST_NAME2(void);
874 extern bool ring_buffer_expanded;
875 extern bool tracing_selftest_disabled;
877 #ifdef CONFIG_FTRACE_STARTUP_TEST
878 extern int trace_selftest_startup_function(struct tracer *trace,
879 struct trace_array *tr);
880 extern int trace_selftest_startup_function_graph(struct tracer *trace,
881 struct trace_array *tr);
882 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
883 struct trace_array *tr);
884 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
885 struct trace_array *tr);
886 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
887 struct trace_array *tr);
888 extern int trace_selftest_startup_wakeup(struct tracer *trace,
889 struct trace_array *tr);
890 extern int trace_selftest_startup_nop(struct tracer *trace,
891 struct trace_array *tr);
892 extern int trace_selftest_startup_branch(struct tracer *trace,
893 struct trace_array *tr);
895 * Tracer data references selftest functions that only occur
896 * on boot up. These can be __init functions. Thus, when selftests
897 * are enabled, then the tracers need to reference __init functions.
899 #define __tracer_data __refdata
901 /* Tracers are seldom changed. Optimize when selftests are disabled. */
902 #define __tracer_data __read_mostly
903 #endif /* CONFIG_FTRACE_STARTUP_TEST */
905 extern void *head_page(struct trace_array_cpu *data);
906 extern unsigned long long ns2usecs(u64 nsec);
908 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
910 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
912 trace_array_vprintk(struct trace_array *tr,
913 unsigned long ip, const char *fmt, va_list args);
914 int trace_array_printk_buf(struct trace_buffer *buffer,
915 unsigned long ip, const char *fmt, ...);
916 void trace_printk_seq(struct trace_seq *s);
917 enum print_line_t print_trace_line(struct trace_iterator *iter);
919 extern char trace_find_mark(unsigned long long duration);
923 struct ftrace_mod_load {
924 struct list_head list;
931 FTRACE_HASH_FL_MOD = (1 << 0),
935 unsigned long size_bits;
936 struct hlist_head *buckets;
942 struct ftrace_func_entry *
943 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
945 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
947 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
950 /* Standard output formatting function used for function return traces */
951 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
954 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
955 #define TRACE_GRAPH_PRINT_CPU 0x2
956 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
957 #define TRACE_GRAPH_PRINT_PROC 0x8
958 #define TRACE_GRAPH_PRINT_DURATION 0x10
959 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
960 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
961 #define TRACE_GRAPH_PRINT_IRQS 0x80
962 #define TRACE_GRAPH_PRINT_TAIL 0x100
963 #define TRACE_GRAPH_SLEEP_TIME 0x200
964 #define TRACE_GRAPH_GRAPH_TIME 0x400
965 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
966 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
968 extern void ftrace_graph_sleep_time_control(bool enable);
970 #ifdef CONFIG_FUNCTION_PROFILER
971 extern void ftrace_graph_graph_time_control(bool enable);
973 static inline void ftrace_graph_graph_time_control(bool enable) { }
976 extern enum print_line_t
977 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
978 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
980 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
981 extern void graph_trace_open(struct trace_iterator *iter);
982 extern void graph_trace_close(struct trace_iterator *iter);
983 extern int __trace_graph_entry(struct trace_array *tr,
984 struct ftrace_graph_ent *trace,
985 unsigned long flags, int pc);
986 extern void __trace_graph_return(struct trace_array *tr,
987 struct ftrace_graph_ret *trace,
988 unsigned long flags, int pc);
990 #ifdef CONFIG_DYNAMIC_FTRACE
991 extern struct ftrace_hash __rcu *ftrace_graph_hash;
992 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
994 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
996 unsigned long addr = trace->func;
998 struct ftrace_hash *hash;
1000 preempt_disable_notrace();
1003 * Have to open code "rcu_dereference_sched()" because the
1004 * function graph tracer can be called when RCU is not
1006 * Protected with schedule_on_each_cpu(ftrace_sync)
1008 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
1010 if (ftrace_hash_empty(hash)) {
1015 if (ftrace_lookup_ip(hash, addr)) {
1018 * This needs to be cleared on the return functions
1019 * when the depth is zero.
1021 trace_recursion_set(TRACE_GRAPH_BIT);
1022 trace_recursion_set_depth(trace->depth);
1025 * If no irqs are to be traced, but a set_graph_function
1026 * is set, and called by an interrupt handler, we still
1030 trace_recursion_set(TRACE_IRQ_BIT);
1032 trace_recursion_clear(TRACE_IRQ_BIT);
1037 preempt_enable_notrace();
1041 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
1043 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
1044 trace->depth == trace_recursion_depth())
1045 trace_recursion_clear(TRACE_GRAPH_BIT);
1048 static inline int ftrace_graph_notrace_addr(unsigned long addr)
1051 struct ftrace_hash *notrace_hash;
1053 preempt_disable_notrace();
1056 * Have to open code "rcu_dereference_sched()" because the
1057 * function graph tracer can be called when RCU is not
1059 * Protected with schedule_on_each_cpu(ftrace_sync)
1061 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
1064 if (ftrace_lookup_ip(notrace_hash, addr))
1067 preempt_enable_notrace();
1071 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
1076 static inline int ftrace_graph_notrace_addr(unsigned long addr)
1080 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
1082 #endif /* CONFIG_DYNAMIC_FTRACE */
1084 extern unsigned int fgraph_max_depth;
1086 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
1088 /* trace it when it is-nested-in or is a function enabled. */
1089 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
1090 ftrace_graph_addr(trace)) ||
1091 (trace->depth < 0) ||
1092 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
1095 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
1096 static inline enum print_line_t
1097 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1099 return TRACE_TYPE_UNHANDLED;
1101 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
1103 extern struct list_head ftrace_pids;
1105 #ifdef CONFIG_FUNCTION_TRACER
1107 #define FTRACE_PID_IGNORE -1
1108 #define FTRACE_PID_TRACE -2
1110 struct ftrace_func_command {
1111 struct list_head list;
1113 int (*func)(struct trace_array *tr,
1114 struct ftrace_hash *hash,
1115 char *func, char *cmd,
1116 char *params, int enable);
1118 extern bool ftrace_filter_param __initdata;
1119 static inline int ftrace_trace_task(struct trace_array *tr)
1121 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
1124 extern int ftrace_is_dead(void);
1125 int ftrace_create_function_files(struct trace_array *tr,
1126 struct dentry *parent);
1127 void ftrace_destroy_function_files(struct trace_array *tr);
1128 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
1129 void ftrace_free_ftrace_ops(struct trace_array *tr);
1130 void ftrace_init_global_array_ops(struct trace_array *tr);
1131 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1132 void ftrace_reset_array_ops(struct trace_array *tr);
1133 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1134 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1135 struct dentry *d_tracer);
1136 void ftrace_clear_pids(struct trace_array *tr);
1137 int init_function_trace(void);
1138 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1140 static inline int ftrace_trace_task(struct trace_array *tr)
1144 static inline int ftrace_is_dead(void) { return 0; }
1146 ftrace_create_function_files(struct trace_array *tr,
1147 struct dentry *parent)
1151 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1155 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
1156 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1157 static inline __init void
1158 ftrace_init_global_array_ops(struct trace_array *tr) { }
1159 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1160 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1161 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1162 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1163 static inline int init_function_trace(void) { return 0; }
1164 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1165 /* ftace_func_t type is not defined, use macro instead of static inline */
1166 #define ftrace_init_array_ops(tr, func) do { } while (0)
1167 #endif /* CONFIG_FUNCTION_TRACER */
1169 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1171 struct ftrace_probe_ops {
1172 void (*func)(unsigned long ip,
1173 unsigned long parent_ip,
1174 struct trace_array *tr,
1175 struct ftrace_probe_ops *ops,
1177 int (*init)(struct ftrace_probe_ops *ops,
1178 struct trace_array *tr,
1179 unsigned long ip, void *init_data,
1181 void (*free)(struct ftrace_probe_ops *ops,
1182 struct trace_array *tr,
1183 unsigned long ip, void *data);
1184 int (*print)(struct seq_file *m,
1186 struct ftrace_probe_ops *ops,
1190 struct ftrace_func_mapper;
1191 typedef int (*ftrace_mapper_func)(void *data);
1193 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1194 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1196 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1197 unsigned long ip, void *data);
1198 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1200 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1201 ftrace_mapper_func free_func);
1204 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1205 struct ftrace_probe_ops *ops, void *data);
1207 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1208 struct ftrace_probe_ops *ops);
1209 extern void clear_ftrace_function_probes(struct trace_array *tr);
1211 int register_ftrace_command(struct ftrace_func_command *cmd);
1212 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1214 void ftrace_create_filter_files(struct ftrace_ops *ops,
1215 struct dentry *parent);
1216 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1218 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1219 int len, int reset);
1220 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1221 int len, int reset);
1223 struct ftrace_func_command;
1225 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1229 static inline __init int unregister_ftrace_command(char *cmd_name)
1233 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1238 * The ops parameter passed in is usually undefined.
1239 * This must be a macro.
1241 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1242 #define ftrace_destroy_filter_files(ops) do { } while (0)
1243 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1245 bool ftrace_event_is_function(struct trace_event_call *call);
1248 * struct trace_parser - servers for reading the user input separated by spaces
1249 * @cont: set if the input is not complete - no final space char was found
1250 * @buffer: holds the parsed user input
1251 * @idx: user input length
1252 * @size: buffer size
1254 struct trace_parser {
1261 static inline bool trace_parser_loaded(struct trace_parser *parser)
1263 return (parser->idx != 0);
1266 static inline bool trace_parser_cont(struct trace_parser *parser)
1268 return parser->cont;
1271 static inline void trace_parser_clear(struct trace_parser *parser)
1273 parser->cont = false;
1277 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1278 extern void trace_parser_put(struct trace_parser *parser);
1279 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1280 size_t cnt, loff_t *ppos);
1283 * Only create function graph options if function graph is configured.
1285 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1286 # define FGRAPH_FLAGS \
1287 C(DISPLAY_GRAPH, "display-graph"),
1289 # define FGRAPH_FLAGS
1292 #ifdef CONFIG_BRANCH_TRACER
1293 # define BRANCH_FLAGS \
1294 C(BRANCH, "branch"),
1296 # define BRANCH_FLAGS
1299 #ifdef CONFIG_FUNCTION_TRACER
1300 # define FUNCTION_FLAGS \
1301 C(FUNCTION, "function-trace"), \
1302 C(FUNC_FORK, "function-fork"),
1303 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1305 # define FUNCTION_FLAGS
1306 # define FUNCTION_DEFAULT_FLAGS 0UL
1307 # define TRACE_ITER_FUNC_FORK 0UL
1310 #ifdef CONFIG_STACKTRACE
1311 # define STACK_FLAGS \
1312 C(STACKTRACE, "stacktrace"),
1314 # define STACK_FLAGS
1318 * trace_iterator_flags is an enumeration that defines bit
1319 * positions into trace_flags that controls the output.
1321 * NOTE: These bits must match the trace_options array in
1322 * trace.c (this macro guarantees it).
1324 #define TRACE_FLAGS \
1325 C(PRINT_PARENT, "print-parent"), \
1326 C(SYM_OFFSET, "sym-offset"), \
1327 C(SYM_ADDR, "sym-addr"), \
1328 C(VERBOSE, "verbose"), \
1332 C(BLOCK, "block"), \
1333 C(PRINTK, "trace_printk"), \
1334 C(ANNOTATE, "annotate"), \
1335 C(USERSTACKTRACE, "userstacktrace"), \
1336 C(SYM_USEROBJ, "sym-userobj"), \
1337 C(PRINTK_MSGONLY, "printk-msg-only"), \
1338 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1339 C(LATENCY_FMT, "latency-format"), \
1340 C(RECORD_CMD, "record-cmd"), \
1341 C(RECORD_TGID, "record-tgid"), \
1342 C(OVERWRITE, "overwrite"), \
1343 C(STOP_ON_FREE, "disable_on_free"), \
1344 C(IRQ_INFO, "irq-info"), \
1345 C(MARKERS, "markers"), \
1346 C(EVENT_FORK, "event-fork"), \
1347 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1354 * By defining C, we can make TRACE_FLAGS a list of bit names
1355 * that will define the bits for the flag masks.
1358 #define C(a, b) TRACE_ITER_##a##_BIT
1360 enum trace_iterator_bits {
1362 /* Make sure we don't go more than we have bits for */
1367 * By redefining C, we can make TRACE_FLAGS a list of masks that
1368 * use the bits as defined above.
1371 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1373 enum trace_iterator_flags { TRACE_FLAGS };
1376 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1377 * control the output of kernel symbols.
1379 #define TRACE_ITER_SYM_MASK \
1380 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1382 extern struct tracer nop_trace;
1384 #ifdef CONFIG_BRANCH_TRACER
1385 extern int enable_branch_tracing(struct trace_array *tr);
1386 extern void disable_branch_tracing(void);
1387 static inline int trace_branch_enable(struct trace_array *tr)
1389 if (tr->trace_flags & TRACE_ITER_BRANCH)
1390 return enable_branch_tracing(tr);
1393 static inline void trace_branch_disable(void)
1395 /* due to races, always disable */
1396 disable_branch_tracing();
1399 static inline int trace_branch_enable(struct trace_array *tr)
1403 static inline void trace_branch_disable(void)
1406 #endif /* CONFIG_BRANCH_TRACER */
1408 /* set ring buffers to default size if not already done so */
1409 int tracing_update_buffers(void);
1411 struct ftrace_event_field {
1412 struct list_head link;
1423 struct event_filter {
1424 struct prog_entry __rcu *prog;
1425 char *filter_string;
1428 struct event_subsystem {
1429 struct list_head list;
1431 struct event_filter *filter;
1435 struct trace_subsystem_dir {
1436 struct list_head list;
1437 struct event_subsystem *subsystem;
1438 struct trace_array *tr;
1439 struct dentry *entry;
1444 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1445 struct trace_buffer *buffer,
1446 struct ring_buffer_event *event);
1448 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1449 struct trace_buffer *buffer,
1450 struct ring_buffer_event *event,
1451 unsigned long flags, int pc,
1452 struct pt_regs *regs);
1454 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1455 struct trace_buffer *buffer,
1456 struct ring_buffer_event *event,
1457 unsigned long flags, int pc)
1459 trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1462 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1463 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1464 void trace_buffered_event_disable(void);
1465 void trace_buffered_event_enable(void);
1468 __trace_event_discard_commit(struct trace_buffer *buffer,
1469 struct ring_buffer_event *event)
1471 if (this_cpu_read(trace_buffered_event) == event) {
1472 /* Simply release the temp buffer */
1473 this_cpu_dec(trace_buffered_event_cnt);
1476 ring_buffer_discard_commit(buffer, event);
1480 * Helper function for event_trigger_unlock_commit{_regs}().
1481 * If there are event triggers attached to this event that requires
1482 * filtering against its fields, then they wil be called as the
1483 * entry already holds the field information of the current event.
1485 * It also checks if the event should be discarded or not.
1486 * It is to be discarded if the event is soft disabled and the
1487 * event was only recorded to process triggers, or if the event
1488 * filter is active and this event did not match the filters.
1490 * Returns true if the event is discarded, false otherwise.
1493 __event_trigger_test_discard(struct trace_event_file *file,
1494 struct trace_buffer *buffer,
1495 struct ring_buffer_event *event,
1497 enum event_trigger_type *tt)
1499 unsigned long eflags = file->flags;
1501 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1502 *tt = event_triggers_call(file, entry, event);
1504 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
1505 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
1506 !filter_match_preds(file->filter, entry))) {
1507 __trace_event_discard_commit(buffer, event);
1515 * event_trigger_unlock_commit - handle triggers and finish event commit
1516 * @file: The file pointer assoctiated to the event
1517 * @buffer: The ring buffer that the event is being written to
1518 * @event: The event meta data in the ring buffer
1519 * @entry: The event itself
1520 * @irq_flags: The state of the interrupts at the start of the event
1521 * @pc: The state of the preempt count at the start of the event.
1523 * This is a helper function to handle triggers that require data
1524 * from the event itself. It also tests the event against filters and
1525 * if the event is soft disabled and should be discarded.
1528 event_trigger_unlock_commit(struct trace_event_file *file,
1529 struct trace_buffer *buffer,
1530 struct ring_buffer_event *event,
1531 void *entry, unsigned long irq_flags, int pc)
1533 enum event_trigger_type tt = ETT_NONE;
1535 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1536 trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1539 event_triggers_post_call(file, tt);
1543 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1544 * @file: The file pointer assoctiated to the event
1545 * @buffer: The ring buffer that the event is being written to
1546 * @event: The event meta data in the ring buffer
1547 * @entry: The event itself
1548 * @irq_flags: The state of the interrupts at the start of the event
1549 * @pc: The state of the preempt count at the start of the event.
1551 * This is a helper function to handle triggers that require data
1552 * from the event itself. It also tests the event against filters and
1553 * if the event is soft disabled and should be discarded.
1555 * Same as event_trigger_unlock_commit() but calls
1556 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1559 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1560 struct trace_buffer *buffer,
1561 struct ring_buffer_event *event,
1562 void *entry, unsigned long irq_flags, int pc,
1563 struct pt_regs *regs)
1565 enum event_trigger_type tt = ETT_NONE;
1567 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1568 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1569 irq_flags, pc, regs);
1572 event_triggers_post_call(file, tt);
1575 #define FILTER_PRED_INVALID ((unsigned short)-1)
1576 #define FILTER_PRED_IS_RIGHT (1 << 15)
1577 #define FILTER_PRED_FOLD (1 << 15)
1580 * The max preds is the size of unsigned short with
1581 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1582 * and FOLD flags. The other is reserved.
1584 * 2^14 preds is way more than enough.
1586 #define MAX_FILTER_PRED 16384
1591 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1593 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1605 char pattern[MAX_FILTER_STR_VAL];
1608 regex_match_func match;
1611 struct filter_pred {
1612 filter_pred_fn_t fn;
1615 unsigned short *ops;
1616 struct ftrace_event_field *field;
1622 static inline bool is_string_field(struct ftrace_event_field *field)
1624 return field->filter_type == FILTER_DYN_STRING ||
1625 field->filter_type == FILTER_STATIC_STRING ||
1626 field->filter_type == FILTER_PTR_STRING ||
1627 field->filter_type == FILTER_COMM;
1630 static inline bool is_function_field(struct ftrace_event_field *field)
1632 return field->filter_type == FILTER_TRACE_FN;
1635 extern enum regex_type
1636 filter_parse_regex(char *buff, int len, char **search, int *not);
1637 extern void print_event_filter(struct trace_event_file *file,
1638 struct trace_seq *s);
1639 extern int apply_event_filter(struct trace_event_file *file,
1640 char *filter_string);
1641 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1642 char *filter_string);
1643 extern void print_subsystem_event_filter(struct event_subsystem *system,
1644 struct trace_seq *s);
1645 extern int filter_assign_type(const char *type);
1646 extern int create_event_filter(struct trace_array *tr,
1647 struct trace_event_call *call,
1648 char *filter_str, bool set_str,
1649 struct event_filter **filterp);
1650 extern void free_event_filter(struct event_filter *filter);
1652 struct ftrace_event_field *
1653 trace_find_event_field(struct trace_event_call *call, char *name);
1655 extern void trace_event_enable_cmd_record(bool enable);
1656 extern void trace_event_enable_tgid_record(bool enable);
1658 extern int event_trace_init(void);
1659 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1660 extern int event_trace_del_tracer(struct trace_array *tr);
1662 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1665 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1669 static inline void *event_file_data(struct file *filp)
1671 return READ_ONCE(file_inode(filp)->i_private);
1674 extern struct mutex event_mutex;
1675 extern struct list_head ftrace_events;
1677 extern const struct file_operations event_trigger_fops;
1678 extern const struct file_operations event_hist_fops;
1679 extern const struct file_operations event_hist_debug_fops;
1680 extern const struct file_operations event_inject_fops;
1682 #ifdef CONFIG_HIST_TRIGGERS
1683 extern int register_trigger_hist_cmd(void);
1684 extern int register_trigger_hist_enable_disable_cmds(void);
1686 static inline int register_trigger_hist_cmd(void) { return 0; }
1687 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1690 extern int register_trigger_cmds(void);
1691 extern void clear_event_triggers(struct trace_array *tr);
1693 struct event_trigger_data {
1694 unsigned long count;
1696 struct event_trigger_ops *ops;
1697 struct event_command *cmd_ops;
1698 struct event_filter __rcu *filter;
1703 struct list_head list;
1705 struct list_head named_list;
1706 struct event_trigger_data *named_data;
1710 #define ENABLE_EVENT_STR "enable_event"
1711 #define DISABLE_EVENT_STR "disable_event"
1712 #define ENABLE_HIST_STR "enable_hist"
1713 #define DISABLE_HIST_STR "disable_hist"
1715 struct enable_trigger_data {
1716 struct trace_event_file *file;
1721 extern int event_enable_trigger_print(struct seq_file *m,
1722 struct event_trigger_ops *ops,
1723 struct event_trigger_data *data);
1724 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1725 struct event_trigger_data *data);
1726 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1727 struct trace_event_file *file,
1728 char *glob, char *cmd, char *param);
1729 extern int event_enable_register_trigger(char *glob,
1730 struct event_trigger_ops *ops,
1731 struct event_trigger_data *data,
1732 struct trace_event_file *file);
1733 extern void event_enable_unregister_trigger(char *glob,
1734 struct event_trigger_ops *ops,
1735 struct event_trigger_data *test,
1736 struct trace_event_file *file);
1737 extern void trigger_data_free(struct event_trigger_data *data);
1738 extern int event_trigger_init(struct event_trigger_ops *ops,
1739 struct event_trigger_data *data);
1740 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1741 int trigger_enable);
1742 extern void update_cond_flag(struct trace_event_file *file);
1743 extern int set_trigger_filter(char *filter_str,
1744 struct event_trigger_data *trigger_data,
1745 struct trace_event_file *file);
1746 extern struct event_trigger_data *find_named_trigger(const char *name);
1747 extern bool is_named_trigger(struct event_trigger_data *test);
1748 extern int save_named_trigger(const char *name,
1749 struct event_trigger_data *data);
1750 extern void del_named_trigger(struct event_trigger_data *data);
1751 extern void pause_named_trigger(struct event_trigger_data *data);
1752 extern void unpause_named_trigger(struct event_trigger_data *data);
1753 extern void set_named_trigger_data(struct event_trigger_data *data,
1754 struct event_trigger_data *named_data);
1755 extern struct event_trigger_data *
1756 get_named_trigger_data(struct event_trigger_data *data);
1757 extern int register_event_command(struct event_command *cmd);
1758 extern int unregister_event_command(struct event_command *cmd);
1759 extern int register_trigger_hist_enable_disable_cmds(void);
1762 * struct event_trigger_ops - callbacks for trace event triggers
1764 * The methods in this structure provide per-event trigger hooks for
1765 * various trigger operations.
1767 * All the methods below, except for @init() and @free(), must be
1770 * @func: The trigger 'probe' function called when the triggering
1771 * event occurs. The data passed into this callback is the data
1772 * that was supplied to the event_command @reg() function that
1773 * registered the trigger (see struct event_command) along with
1774 * the trace record, rec.
1776 * @init: An optional initialization function called for the trigger
1777 * when the trigger is registered (via the event_command reg()
1778 * function). This can be used to perform per-trigger
1779 * initialization such as incrementing a per-trigger reference
1780 * count, for instance. This is usually implemented by the
1781 * generic utility function @event_trigger_init() (see
1782 * trace_event_triggers.c).
1784 * @free: An optional de-initialization function called for the
1785 * trigger when the trigger is unregistered (via the
1786 * event_command @reg() function). This can be used to perform
1787 * per-trigger de-initialization such as decrementing a
1788 * per-trigger reference count and freeing corresponding trigger
1789 * data, for instance. This is usually implemented by the
1790 * generic utility function @event_trigger_free() (see
1791 * trace_event_triggers.c).
1793 * @print: The callback function invoked to have the trigger print
1794 * itself. This is usually implemented by a wrapper function
1795 * that calls the generic utility function @event_trigger_print()
1796 * (see trace_event_triggers.c).
1798 struct event_trigger_ops {
1799 void (*func)(struct event_trigger_data *data,
1801 struct ring_buffer_event *rbe);
1802 int (*init)(struct event_trigger_ops *ops,
1803 struct event_trigger_data *data);
1804 void (*free)(struct event_trigger_ops *ops,
1805 struct event_trigger_data *data);
1806 int (*print)(struct seq_file *m,
1807 struct event_trigger_ops *ops,
1808 struct event_trigger_data *data);
1812 * struct event_command - callbacks and data members for event commands
1814 * Event commands are invoked by users by writing the command name
1815 * into the 'trigger' file associated with a trace event. The
1816 * parameters associated with a specific invocation of an event
1817 * command are used to create an event trigger instance, which is
1818 * added to the list of trigger instances associated with that trace
1819 * event. When the event is hit, the set of triggers associated with
1820 * that event is invoked.
1822 * The data members in this structure provide per-event command data
1823 * for various event commands.
1825 * All the data members below, except for @post_trigger, must be set
1826 * for each event command.
1828 * @name: The unique name that identifies the event command. This is
1829 * the name used when setting triggers via trigger files.
1831 * @trigger_type: A unique id that identifies the event command
1832 * 'type'. This value has two purposes, the first to ensure that
1833 * only one trigger of the same type can be set at a given time
1834 * for a particular event e.g. it doesn't make sense to have both
1835 * a traceon and traceoff trigger attached to a single event at
1836 * the same time, so traceon and traceoff have the same type
1837 * though they have different names. The @trigger_type value is
1838 * also used as a bit value for deferring the actual trigger
1839 * action until after the current event is finished. Some
1840 * commands need to do this if they themselves log to the trace
1841 * buffer (see the @post_trigger() member below). @trigger_type
1842 * values are defined by adding new values to the trigger_type
1843 * enum in include/linux/trace_events.h.
1845 * @flags: See the enum event_command_flags below.
1847 * All the methods below, except for @set_filter() and @unreg_all(),
1848 * must be implemented.
1850 * @func: The callback function responsible for parsing and
1851 * registering the trigger written to the 'trigger' file by the
1852 * user. It allocates the trigger instance and registers it with
1853 * the appropriate trace event. It makes use of the other
1854 * event_command callback functions to orchestrate this, and is
1855 * usually implemented by the generic utility function
1856 * @event_trigger_callback() (see trace_event_triggers.c).
1858 * @reg: Adds the trigger to the list of triggers associated with the
1859 * event, and enables the event trigger itself, after
1860 * initializing it (via the event_trigger_ops @init() function).
1861 * This is also where commands can use the @trigger_type value to
1862 * make the decision as to whether or not multiple instances of
1863 * the trigger should be allowed. This is usually implemented by
1864 * the generic utility function @register_trigger() (see
1865 * trace_event_triggers.c).
1867 * @unreg: Removes the trigger from the list of triggers associated
1868 * with the event, and disables the event trigger itself, after
1869 * initializing it (via the event_trigger_ops @free() function).
1870 * This is usually implemented by the generic utility function
1871 * @unregister_trigger() (see trace_event_triggers.c).
1873 * @unreg_all: An optional function called to remove all the triggers
1874 * from the list of triggers associated with the event. Called
1875 * when a trigger file is opened in truncate mode.
1877 * @set_filter: An optional function called to parse and set a filter
1878 * for the trigger. If no @set_filter() method is set for the
1879 * event command, filters set by the user for the command will be
1880 * ignored. This is usually implemented by the generic utility
1881 * function @set_trigger_filter() (see trace_event_triggers.c).
1883 * @get_trigger_ops: The callback function invoked to retrieve the
1884 * event_trigger_ops implementation associated with the command.
1886 struct event_command {
1887 struct list_head list;
1889 enum event_trigger_type trigger_type;
1891 int (*func)(struct event_command *cmd_ops,
1892 struct trace_event_file *file,
1893 char *glob, char *cmd, char *params);
1894 int (*reg)(char *glob,
1895 struct event_trigger_ops *ops,
1896 struct event_trigger_data *data,
1897 struct trace_event_file *file);
1898 void (*unreg)(char *glob,
1899 struct event_trigger_ops *ops,
1900 struct event_trigger_data *data,
1901 struct trace_event_file *file);
1902 void (*unreg_all)(struct trace_event_file *file);
1903 int (*set_filter)(char *filter_str,
1904 struct event_trigger_data *data,
1905 struct trace_event_file *file);
1906 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1910 * enum event_command_flags - flags for struct event_command
1912 * @POST_TRIGGER: A flag that says whether or not this command needs
1913 * to have its action delayed until after the current event has
1914 * been closed. Some triggers need to avoid being invoked while
1915 * an event is currently in the process of being logged, since
1916 * the trigger may itself log data into the trace buffer. Thus
1917 * we make sure the current event is committed before invoking
1918 * those triggers. To do that, the trigger invocation is split
1919 * in two - the first part checks the filter using the current
1920 * trace record; if a command has the @post_trigger flag set, it
1921 * sets a bit for itself in the return value, otherwise it
1922 * directly invokes the trigger. Once all commands have been
1923 * either invoked or set their return flag, the current record is
1924 * either committed or discarded. At that point, if any commands
1925 * have deferred their triggers, those commands are finally
1926 * invoked following the close of the current event. In other
1927 * words, if the event_trigger_ops @func() probe implementation
1928 * itself logs to the trace buffer, this flag should be set,
1929 * otherwise it can be left unspecified.
1931 * @NEEDS_REC: A flag that says whether or not this command needs
1932 * access to the trace record in order to perform its function,
1933 * regardless of whether or not it has a filter associated with
1934 * it (filters make a trigger require access to the trace record
1935 * but are not always present).
1937 enum event_command_flags {
1938 EVENT_CMD_FL_POST_TRIGGER = 1,
1939 EVENT_CMD_FL_NEEDS_REC = 2,
1942 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1944 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1947 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1949 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1952 extern int trace_event_enable_disable(struct trace_event_file *file,
1953 int enable, int soft_disable);
1954 extern int tracing_alloc_snapshot(void);
1955 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1956 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1958 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1959 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1961 extern const char *__start___trace_bprintk_fmt[];
1962 extern const char *__stop___trace_bprintk_fmt[];
1964 extern const char *__start___tracepoint_str[];
1965 extern const char *__stop___tracepoint_str[];
1967 void trace_printk_control(bool enabled);
1968 void trace_printk_start_comm(void);
1969 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1970 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1972 /* Used from boot time tracer */
1973 extern int trace_set_options(struct trace_array *tr, char *option);
1974 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1975 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1976 unsigned long size, int cpu_id);
1977 extern int tracing_set_cpumask(struct trace_array *tr,
1978 cpumask_var_t tracing_cpumask_new);
1981 #define MAX_EVENT_NAME_LEN 64
1983 extern int trace_run_command(const char *buf, int (*createfn)(int, char**));
1984 extern ssize_t trace_parse_run_command(struct file *file,
1985 const char __user *buffer, size_t count, loff_t *ppos,
1986 int (*createfn)(int, char**));
1988 extern unsigned int err_pos(char *cmd, const char *str);
1989 extern void tracing_log_err(struct trace_array *tr,
1990 const char *loc, const char *cmd,
1991 const char **errs, u8 type, u8 pos);
1994 * Normal trace_printk() and friends allocates special buffers
1995 * to do the manipulation, as well as saves the print formats
1996 * into sections to display. But the trace infrastructure wants
1997 * to use these without the added overhead at the price of being
1998 * a bit slower (used mainly for warnings, where we don't care
1999 * about performance). The internal_trace_puts() is for such
2002 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
2005 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
2006 extern struct trace_event_call \
2007 __aligned(4) event_##call;
2008 #undef FTRACE_ENTRY_DUP
2009 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
2010 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
2011 #undef FTRACE_ENTRY_PACKED
2012 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
2013 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
2015 #include "trace_entries.h"
2017 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
2018 int perf_ftrace_event_register(struct trace_event_call *call,
2019 enum trace_reg type, void *data);
2021 #define perf_ftrace_event_register NULL
2024 #ifdef CONFIG_FTRACE_SYSCALLS
2025 void init_ftrace_syscalls(void);
2026 const char *get_syscall_name(int syscall);
2028 static inline void init_ftrace_syscalls(void) { }
2029 static inline const char *get_syscall_name(int syscall)
2035 #ifdef CONFIG_EVENT_TRACING
2036 void trace_event_init(void);
2037 void trace_event_eval_update(struct trace_eval_map **map, int len);
2038 /* Used from boot time tracer */
2039 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
2040 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
2042 static inline void __init trace_event_init(void) { }
2043 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
2046 #ifdef CONFIG_TRACER_SNAPSHOT
2047 void tracing_snapshot_instance(struct trace_array *tr);
2048 int tracing_alloc_snapshot_instance(struct trace_array *tr);
2050 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
2051 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
2057 #ifdef CONFIG_PREEMPT_TRACER
2058 void tracer_preempt_on(unsigned long a0, unsigned long a1);
2059 void tracer_preempt_off(unsigned long a0, unsigned long a1);
2061 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
2062 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
2064 #ifdef CONFIG_IRQSOFF_TRACER
2065 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
2066 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
2068 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
2069 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
2072 extern struct trace_iterator *tracepoint_print_iter;
2075 * Reset the state of the trace_iterator so that it can read consumed data.
2076 * Normally, the trace_iterator is used for reading the data when it is not
2077 * consumed, and must retain state.
2079 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
2081 const size_t offset = offsetof(struct trace_iterator, seq);
2084 * Keep gcc from complaining about overwriting more than just one
2085 * member in the structure.
2087 memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
2092 #endif /* _LINUX_KERNEL_TRACE_H */