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 */
359 #ifdef CONFIG_FUNCTION_TRACER
360 struct ftrace_ops
*ops
;
361 struct trace_pid_list __rcu
*function_pids
;
362 struct trace_pid_list __rcu
*function_no_pids
;
363 #ifdef CONFIG_DYNAMIC_FTRACE
364 /* All of these are protected by the ftrace_lock */
365 struct list_head func_probes
;
366 struct list_head mod_trace
;
367 struct list_head mod_notrace
;
369 /* function tracing enabled */
370 int function_enabled
;
372 int time_stamp_abs_ref
;
373 struct list_head hist_vars
;
374 #ifdef CONFIG_TRACER_SNAPSHOT
375 struct cond_snapshot
*cond_snapshot
;
380 TRACE_ARRAY_FL_GLOBAL
= (1 << 0)
383 extern struct list_head ftrace_trace_arrays
;
385 extern struct mutex trace_types_lock
;
387 extern int trace_array_get(struct trace_array
*tr
);
388 extern int tracing_check_open_get_tr(struct trace_array
*tr
);
389 extern struct trace_array
*trace_array_find(const char *instance
);
390 extern struct trace_array
*trace_array_find_get(const char *instance
);
392 extern int tracing_set_time_stamp_abs(struct trace_array
*tr
, bool abs
);
393 extern int tracing_set_clock(struct trace_array
*tr
, const char *clockstr
);
395 extern bool trace_clock_in_ns(struct trace_array
*tr
);
398 * The global tracer (top) should be the first trace array added,
399 * but we check the flag anyway.
401 static inline struct trace_array
*top_trace_array(void)
403 struct trace_array
*tr
;
405 if (list_empty(&ftrace_trace_arrays
))
408 tr
= list_entry(ftrace_trace_arrays
.prev
,
410 WARN_ON(!(tr
->flags
& TRACE_ARRAY_FL_GLOBAL
));
414 #define FTRACE_CMP_TYPE(var, type) \
415 __builtin_types_compatible_p(typeof(var), type *)
418 #define IF_ASSIGN(var, entry, etype, id) \
419 if (FTRACE_CMP_TYPE(var, etype)) { \
420 var = (typeof(var))(entry); \
421 WARN_ON(id != 0 && (entry)->type != id); \
425 /* Will cause compile errors if type is not found. */
426 extern void __ftrace_bad_type(void);
429 * The trace_assign_type is a verifier that the entry type is
430 * the same as the type being assigned. To add new types simply
431 * add a line with the following format:
433 * IF_ASSIGN(var, ent, type, id);
435 * Where "type" is the trace type that includes the trace_entry
436 * as the "ent" item. And "id" is the trace identifier that is
437 * used in the trace_type enum.
439 * If the type can have more than one id, then use zero.
441 #define trace_assign_type(var, ent) \
443 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
444 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
445 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
446 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
447 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
448 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
449 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
450 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
451 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
452 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
454 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
456 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
457 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
459 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
461 __ftrace_bad_type(); \
465 * An option specific to a tracer. This is a boolean value.
466 * The bit is the bit index that sets its value on the
467 * flags value in struct tracer_flags.
470 const char *name
; /* Will appear on the trace_options file */
471 u32 bit
; /* Mask assigned in val field in tracer_flags */
475 * The set of specific options for a tracer. Your tracer
476 * have to set the initial value of the flags val.
478 struct tracer_flags
{
480 struct tracer_opt
*opts
;
481 struct tracer
*trace
;
484 /* Makes more easy to define a tracer opt */
485 #define TRACER_OPT(s, b) .name = #s, .bit = b
488 struct trace_option_dentry
{
489 struct tracer_opt
*opt
;
490 struct tracer_flags
*flags
;
491 struct trace_array
*tr
;
492 struct dentry
*entry
;
496 * struct tracer - a specific tracer and its callbacks to interact with tracefs
497 * @name: the name chosen to select it on the available_tracers file
498 * @init: called when one switches to this tracer (echo name > current_tracer)
499 * @reset: called when one switches to another tracer
500 * @start: called when tracing is unpaused (echo 1 > tracing_on)
501 * @stop: called when tracing is paused (echo 0 > tracing_on)
502 * @update_thresh: called when tracing_thresh is updated
503 * @open: called when the trace file is opened
504 * @pipe_open: called when the trace_pipe file is opened
505 * @close: called when the trace file is released
506 * @pipe_close: called when the trace_pipe file is released
507 * @read: override the default read callback on trace_pipe
508 * @splice_read: override the default splice_read callback on trace_pipe
509 * @selftest: selftest to run on boot (see trace_selftest.c)
510 * @print_headers: override the first lines that describe your columns
511 * @print_line: callback that prints a trace
512 * @set_flag: signals one of your private flags changed (trace_options file)
513 * @flags: your private flags
517 int (*init
)(struct trace_array
*tr
);
518 void (*reset
)(struct trace_array
*tr
);
519 void (*start
)(struct trace_array
*tr
);
520 void (*stop
)(struct trace_array
*tr
);
521 int (*update_thresh
)(struct trace_array
*tr
);
522 void (*open
)(struct trace_iterator
*iter
);
523 void (*pipe_open
)(struct trace_iterator
*iter
);
524 void (*close
)(struct trace_iterator
*iter
);
525 void (*pipe_close
)(struct trace_iterator
*iter
);
526 ssize_t (*read
)(struct trace_iterator
*iter
,
527 struct file
*filp
, char __user
*ubuf
,
528 size_t cnt
, loff_t
*ppos
);
529 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
532 struct pipe_inode_info
*pipe
,
535 #ifdef CONFIG_FTRACE_STARTUP_TEST
536 int (*selftest
)(struct tracer
*trace
,
537 struct trace_array
*tr
);
539 void (*print_header
)(struct seq_file
*m
);
540 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
541 /* If you handled the flag setting, return 0 */
542 int (*set_flag
)(struct trace_array
*tr
,
543 u32 old_flags
, u32 bit
, int set
);
544 /* Return 0 if OK with change, else return non-zero */
545 int (*flag_changed
)(struct trace_array
*tr
,
548 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 struct dentry
*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
1106 struct ftrace_func_command
{
1107 struct list_head list
;
1109 int (*func
)(struct trace_array
*tr
,
1110 struct ftrace_hash
*hash
,
1111 char *func
, char *cmd
,
1112 char *params
, int enable
);
1114 extern bool ftrace_filter_param __initdata
;
1115 static inline int ftrace_trace_task(struct trace_array
*tr
)
1117 return !this_cpu_read(tr
->array_buffer
.data
->ftrace_ignore_pid
);
1119 extern int ftrace_is_dead(void);
1120 int ftrace_create_function_files(struct trace_array
*tr
,
1121 struct dentry
*parent
);
1122 void ftrace_destroy_function_files(struct trace_array
*tr
);
1123 void ftrace_init_global_array_ops(struct trace_array
*tr
);
1124 void ftrace_init_array_ops(struct trace_array
*tr
, ftrace_func_t func
);
1125 void ftrace_reset_array_ops(struct trace_array
*tr
);
1126 void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
);
1127 void ftrace_init_tracefs_toplevel(struct trace_array
*tr
,
1128 struct dentry
*d_tracer
);
1129 void ftrace_clear_pids(struct trace_array
*tr
);
1130 int init_function_trace(void);
1131 void ftrace_pid_follow_fork(struct trace_array
*tr
, bool enable
);
1133 static inline int ftrace_trace_task(struct trace_array
*tr
)
1137 static inline int ftrace_is_dead(void) { return 0; }
1139 ftrace_create_function_files(struct trace_array
*tr
,
1140 struct dentry
*parent
)
1144 static inline void ftrace_destroy_function_files(struct trace_array
*tr
) { }
1145 static inline __init
void
1146 ftrace_init_global_array_ops(struct trace_array
*tr
) { }
1147 static inline void ftrace_reset_array_ops(struct trace_array
*tr
) { }
1148 static inline void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d
) { }
1149 static inline void ftrace_init_tracefs_toplevel(struct trace_array
*tr
, struct dentry
*d
) { }
1150 static inline void ftrace_clear_pids(struct trace_array
*tr
) { }
1151 static inline int init_function_trace(void) { return 0; }
1152 static inline void ftrace_pid_follow_fork(struct trace_array
*tr
, bool enable
) { }
1153 /* ftace_func_t type is not defined, use macro instead of static inline */
1154 #define ftrace_init_array_ops(tr, func) do { } while (0)
1155 #endif /* CONFIG_FUNCTION_TRACER */
1157 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1159 struct ftrace_probe_ops
{
1160 void (*func
)(unsigned long ip
,
1161 unsigned long parent_ip
,
1162 struct trace_array
*tr
,
1163 struct ftrace_probe_ops
*ops
,
1165 int (*init
)(struct ftrace_probe_ops
*ops
,
1166 struct trace_array
*tr
,
1167 unsigned long ip
, void *init_data
,
1169 void (*free
)(struct ftrace_probe_ops
*ops
,
1170 struct trace_array
*tr
,
1171 unsigned long ip
, void *data
);
1172 int (*print
)(struct seq_file
*m
,
1174 struct ftrace_probe_ops
*ops
,
1178 struct ftrace_func_mapper
;
1179 typedef int (*ftrace_mapper_func
)(void *data
);
1181 struct ftrace_func_mapper
*allocate_ftrace_func_mapper(void);
1182 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper
*mapper
,
1184 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper
*mapper
,
1185 unsigned long ip
, void *data
);
1186 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper
*mapper
,
1188 void free_ftrace_func_mapper(struct ftrace_func_mapper
*mapper
,
1189 ftrace_mapper_func free_func
);
1192 register_ftrace_function_probe(char *glob
, struct trace_array
*tr
,
1193 struct ftrace_probe_ops
*ops
, void *data
);
1195 unregister_ftrace_function_probe_func(char *glob
, struct trace_array
*tr
,
1196 struct ftrace_probe_ops
*ops
);
1197 extern void clear_ftrace_function_probes(struct trace_array
*tr
);
1199 int register_ftrace_command(struct ftrace_func_command
*cmd
);
1200 int unregister_ftrace_command(struct ftrace_func_command
*cmd
);
1202 void ftrace_create_filter_files(struct ftrace_ops
*ops
,
1203 struct dentry
*parent
);
1204 void ftrace_destroy_filter_files(struct ftrace_ops
*ops
);
1206 extern int ftrace_set_filter(struct ftrace_ops
*ops
, unsigned char *buf
,
1207 int len
, int reset
);
1208 extern int ftrace_set_notrace(struct ftrace_ops
*ops
, unsigned char *buf
,
1209 int len
, int reset
);
1211 struct ftrace_func_command
;
1213 static inline __init
int register_ftrace_command(struct ftrace_func_command
*cmd
)
1217 static inline __init
int unregister_ftrace_command(char *cmd_name
)
1221 static inline void clear_ftrace_function_probes(struct trace_array
*tr
)
1226 * The ops parameter passed in is usually undefined.
1227 * This must be a macro.
1229 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1230 #define ftrace_destroy_filter_files(ops) do { } while (0)
1231 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1233 bool ftrace_event_is_function(struct trace_event_call
*call
);
1236 * struct trace_parser - servers for reading the user input separated by spaces
1237 * @cont: set if the input is not complete - no final space char was found
1238 * @buffer: holds the parsed user input
1239 * @idx: user input length
1240 * @size: buffer size
1242 struct trace_parser
{
1249 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
1251 return (parser
->idx
!= 0);
1254 static inline bool trace_parser_cont(struct trace_parser
*parser
)
1256 return parser
->cont
;
1259 static inline void trace_parser_clear(struct trace_parser
*parser
)
1261 parser
->cont
= false;
1265 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
1266 extern void trace_parser_put(struct trace_parser
*parser
);
1267 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
1268 size_t cnt
, loff_t
*ppos
);
1271 * Only create function graph options if function graph is configured.
1273 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1274 # define FGRAPH_FLAGS \
1275 C(DISPLAY_GRAPH, "display-graph"),
1277 # define FGRAPH_FLAGS
1280 #ifdef CONFIG_BRANCH_TRACER
1281 # define BRANCH_FLAGS \
1282 C(BRANCH, "branch"),
1284 # define BRANCH_FLAGS
1287 #ifdef CONFIG_FUNCTION_TRACER
1288 # define FUNCTION_FLAGS \
1289 C(FUNCTION, "function-trace"), \
1290 C(FUNC_FORK, "function-fork"),
1291 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1293 # define FUNCTION_FLAGS
1294 # define FUNCTION_DEFAULT_FLAGS 0UL
1295 # define TRACE_ITER_FUNC_FORK 0UL
1298 #ifdef CONFIG_STACKTRACE
1299 # define STACK_FLAGS \
1300 C(STACKTRACE, "stacktrace"),
1302 # define STACK_FLAGS
1306 * trace_iterator_flags is an enumeration that defines bit
1307 * positions into trace_flags that controls the output.
1309 * NOTE: These bits must match the trace_options array in
1310 * trace.c (this macro guarantees it).
1312 #define TRACE_FLAGS \
1313 C(PRINT_PARENT, "print-parent"), \
1314 C(SYM_OFFSET, "sym-offset"), \
1315 C(SYM_ADDR, "sym-addr"), \
1316 C(VERBOSE, "verbose"), \
1320 C(BLOCK, "block"), \
1321 C(PRINTK, "trace_printk"), \
1322 C(ANNOTATE, "annotate"), \
1323 C(USERSTACKTRACE, "userstacktrace"), \
1324 C(SYM_USEROBJ, "sym-userobj"), \
1325 C(PRINTK_MSGONLY, "printk-msg-only"), \
1326 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1327 C(LATENCY_FMT, "latency-format"), \
1328 C(RECORD_CMD, "record-cmd"), \
1329 C(RECORD_TGID, "record-tgid"), \
1330 C(OVERWRITE, "overwrite"), \
1331 C(STOP_ON_FREE, "disable_on_free"), \
1332 C(IRQ_INFO, "irq-info"), \
1333 C(MARKERS, "markers"), \
1334 C(EVENT_FORK, "event-fork"), \
1335 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1342 * By defining C, we can make TRACE_FLAGS a list of bit names
1343 * that will define the bits for the flag masks.
1346 #define C(a, b) TRACE_ITER_##a##_BIT
1348 enum trace_iterator_bits
{
1350 /* Make sure we don't go more than we have bits for */
1355 * By redefining C, we can make TRACE_FLAGS a list of masks that
1356 * use the bits as defined above.
1359 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1361 enum trace_iterator_flags
{ TRACE_FLAGS
};
1364 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1365 * control the output of kernel symbols.
1367 #define TRACE_ITER_SYM_MASK \
1368 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1370 extern struct tracer nop_trace
;
1372 #ifdef CONFIG_BRANCH_TRACER
1373 extern int enable_branch_tracing(struct trace_array
*tr
);
1374 extern void disable_branch_tracing(void);
1375 static inline int trace_branch_enable(struct trace_array
*tr
)
1377 if (tr
->trace_flags
& TRACE_ITER_BRANCH
)
1378 return enable_branch_tracing(tr
);
1381 static inline void trace_branch_disable(void)
1383 /* due to races, always disable */
1384 disable_branch_tracing();
1387 static inline int trace_branch_enable(struct trace_array
*tr
)
1391 static inline void trace_branch_disable(void)
1394 #endif /* CONFIG_BRANCH_TRACER */
1396 /* set ring buffers to default size if not already done so */
1397 int tracing_update_buffers(void);
1399 struct ftrace_event_field
{
1400 struct list_head link
;
1411 struct event_filter
{
1412 struct prog_entry __rcu
*prog
;
1413 char *filter_string
;
1416 struct event_subsystem
{
1417 struct list_head list
;
1419 struct event_filter
*filter
;
1423 struct trace_subsystem_dir
{
1424 struct list_head list
;
1425 struct event_subsystem
*subsystem
;
1426 struct trace_array
*tr
;
1427 struct dentry
*entry
;
1432 extern int call_filter_check_discard(struct trace_event_call
*call
, void *rec
,
1433 struct trace_buffer
*buffer
,
1434 struct ring_buffer_event
*event
);
1436 void trace_buffer_unlock_commit_regs(struct trace_array
*tr
,
1437 struct trace_buffer
*buffer
,
1438 struct ring_buffer_event
*event
,
1439 unsigned long flags
, int pc
,
1440 struct pt_regs
*regs
);
1442 static inline void trace_buffer_unlock_commit(struct trace_array
*tr
,
1443 struct trace_buffer
*buffer
,
1444 struct ring_buffer_event
*event
,
1445 unsigned long flags
, int pc
)
1447 trace_buffer_unlock_commit_regs(tr
, buffer
, event
, flags
, pc
, NULL
);
1450 DECLARE_PER_CPU(struct ring_buffer_event
*, trace_buffered_event
);
1451 DECLARE_PER_CPU(int, trace_buffered_event_cnt
);
1452 void trace_buffered_event_disable(void);
1453 void trace_buffered_event_enable(void);
1456 __trace_event_discard_commit(struct trace_buffer
*buffer
,
1457 struct ring_buffer_event
*event
)
1459 if (this_cpu_read(trace_buffered_event
) == event
) {
1460 /* Simply release the temp buffer */
1461 this_cpu_dec(trace_buffered_event_cnt
);
1464 ring_buffer_discard_commit(buffer
, event
);
1468 * Helper function for event_trigger_unlock_commit{_regs}().
1469 * If there are event triggers attached to this event that requires
1470 * filtering against its fields, then they wil be called as the
1471 * entry already holds the field information of the current event.
1473 * It also checks if the event should be discarded or not.
1474 * It is to be discarded if the event is soft disabled and the
1475 * event was only recorded to process triggers, or if the event
1476 * filter is active and this event did not match the filters.
1478 * Returns true if the event is discarded, false otherwise.
1481 __event_trigger_test_discard(struct trace_event_file
*file
,
1482 struct trace_buffer
*buffer
,
1483 struct ring_buffer_event
*event
,
1485 enum event_trigger_type
*tt
)
1487 unsigned long eflags
= file
->flags
;
1489 if (eflags
& EVENT_FILE_FL_TRIGGER_COND
)
1490 *tt
= event_triggers_call(file
, entry
, event
);
1492 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT
, &file
->flags
) ||
1493 (unlikely(file
->flags
& EVENT_FILE_FL_FILTERED
) &&
1494 !filter_match_preds(file
->filter
, entry
))) {
1495 __trace_event_discard_commit(buffer
, event
);
1503 * event_trigger_unlock_commit - handle triggers and finish event commit
1504 * @file: The file pointer assoctiated to the event
1505 * @buffer: The ring buffer that the event is being written to
1506 * @event: The event meta data in the ring buffer
1507 * @entry: The event itself
1508 * @irq_flags: The state of the interrupts at the start of the event
1509 * @pc: The state of the preempt count at the start of the event.
1511 * This is a helper function to handle triggers that require data
1512 * from the event itself. It also tests the event against filters and
1513 * if the event is soft disabled and should be discarded.
1516 event_trigger_unlock_commit(struct trace_event_file
*file
,
1517 struct trace_buffer
*buffer
,
1518 struct ring_buffer_event
*event
,
1519 void *entry
, unsigned long irq_flags
, int pc
)
1521 enum event_trigger_type tt
= ETT_NONE
;
1523 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1524 trace_buffer_unlock_commit(file
->tr
, buffer
, event
, irq_flags
, pc
);
1527 event_triggers_post_call(file
, tt
);
1531 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1532 * @file: The file pointer assoctiated to the event
1533 * @buffer: The ring buffer that the event is being written to
1534 * @event: The event meta data in the ring buffer
1535 * @entry: The event itself
1536 * @irq_flags: The state of the interrupts at the start of the event
1537 * @pc: The state of the preempt count at the start of the event.
1539 * This is a helper function to handle triggers that require data
1540 * from the event itself. It also tests the event against filters and
1541 * if the event is soft disabled and should be discarded.
1543 * Same as event_trigger_unlock_commit() but calls
1544 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1547 event_trigger_unlock_commit_regs(struct trace_event_file
*file
,
1548 struct trace_buffer
*buffer
,
1549 struct ring_buffer_event
*event
,
1550 void *entry
, unsigned long irq_flags
, int pc
,
1551 struct pt_regs
*regs
)
1553 enum event_trigger_type tt
= ETT_NONE
;
1555 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1556 trace_buffer_unlock_commit_regs(file
->tr
, buffer
, event
,
1557 irq_flags
, pc
, regs
);
1560 event_triggers_post_call(file
, tt
);
1563 #define FILTER_PRED_INVALID ((unsigned short)-1)
1564 #define FILTER_PRED_IS_RIGHT (1 << 15)
1565 #define FILTER_PRED_FOLD (1 << 15)
1568 * The max preds is the size of unsigned short with
1569 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1570 * and FOLD flags. The other is reserved.
1572 * 2^14 preds is way more than enough.
1574 #define MAX_FILTER_PRED 16384
1579 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
);
1581 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
1593 char pattern
[MAX_FILTER_STR_VAL
];
1596 regex_match_func match
;
1599 struct filter_pred
{
1600 filter_pred_fn_t fn
;
1603 unsigned short *ops
;
1604 struct ftrace_event_field
*field
;
1610 static inline bool is_string_field(struct ftrace_event_field
*field
)
1612 return field
->filter_type
== FILTER_DYN_STRING
||
1613 field
->filter_type
== FILTER_STATIC_STRING
||
1614 field
->filter_type
== FILTER_PTR_STRING
||
1615 field
->filter_type
== FILTER_COMM
;
1618 static inline bool is_function_field(struct ftrace_event_field
*field
)
1620 return field
->filter_type
== FILTER_TRACE_FN
;
1623 extern enum regex_type
1624 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
1625 extern void print_event_filter(struct trace_event_file
*file
,
1626 struct trace_seq
*s
);
1627 extern int apply_event_filter(struct trace_event_file
*file
,
1628 char *filter_string
);
1629 extern int apply_subsystem_event_filter(struct trace_subsystem_dir
*dir
,
1630 char *filter_string
);
1631 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
1632 struct trace_seq
*s
);
1633 extern int filter_assign_type(const char *type
);
1634 extern int create_event_filter(struct trace_array
*tr
,
1635 struct trace_event_call
*call
,
1636 char *filter_str
, bool set_str
,
1637 struct event_filter
**filterp
);
1638 extern void free_event_filter(struct event_filter
*filter
);
1640 struct ftrace_event_field
*
1641 trace_find_event_field(struct trace_event_call
*call
, char *name
);
1643 extern void trace_event_enable_cmd_record(bool enable
);
1644 extern void trace_event_enable_tgid_record(bool enable
);
1646 extern int event_trace_init(void);
1647 extern int event_trace_add_tracer(struct dentry
*parent
, struct trace_array
*tr
);
1648 extern int event_trace_del_tracer(struct trace_array
*tr
);
1650 extern struct trace_event_file
*__find_event_file(struct trace_array
*tr
,
1653 extern struct trace_event_file
*find_event_file(struct trace_array
*tr
,
1657 static inline void *event_file_data(struct file
*filp
)
1659 return READ_ONCE(file_inode(filp
)->i_private
);
1662 extern struct mutex event_mutex
;
1663 extern struct list_head ftrace_events
;
1665 extern const struct file_operations event_trigger_fops
;
1666 extern const struct file_operations event_hist_fops
;
1667 extern const struct file_operations event_hist_debug_fops
;
1668 extern const struct file_operations event_inject_fops
;
1670 #ifdef CONFIG_HIST_TRIGGERS
1671 extern int register_trigger_hist_cmd(void);
1672 extern int register_trigger_hist_enable_disable_cmds(void);
1674 static inline int register_trigger_hist_cmd(void) { return 0; }
1675 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1678 extern int register_trigger_cmds(void);
1679 extern void clear_event_triggers(struct trace_array
*tr
);
1681 struct event_trigger_data
{
1682 unsigned long count
;
1684 struct event_trigger_ops
*ops
;
1685 struct event_command
*cmd_ops
;
1686 struct event_filter __rcu
*filter
;
1691 struct list_head list
;
1693 struct list_head named_list
;
1694 struct event_trigger_data
*named_data
;
1698 #define ENABLE_EVENT_STR "enable_event"
1699 #define DISABLE_EVENT_STR "disable_event"
1700 #define ENABLE_HIST_STR "enable_hist"
1701 #define DISABLE_HIST_STR "disable_hist"
1703 struct enable_trigger_data
{
1704 struct trace_event_file
*file
;
1709 extern int event_enable_trigger_print(struct seq_file
*m
,
1710 struct event_trigger_ops
*ops
,
1711 struct event_trigger_data
*data
);
1712 extern void event_enable_trigger_free(struct event_trigger_ops
*ops
,
1713 struct event_trigger_data
*data
);
1714 extern int event_enable_trigger_func(struct event_command
*cmd_ops
,
1715 struct trace_event_file
*file
,
1716 char *glob
, char *cmd
, char *param
);
1717 extern int event_enable_register_trigger(char *glob
,
1718 struct event_trigger_ops
*ops
,
1719 struct event_trigger_data
*data
,
1720 struct trace_event_file
*file
);
1721 extern void event_enable_unregister_trigger(char *glob
,
1722 struct event_trigger_ops
*ops
,
1723 struct event_trigger_data
*test
,
1724 struct trace_event_file
*file
);
1725 extern void trigger_data_free(struct event_trigger_data
*data
);
1726 extern int event_trigger_init(struct event_trigger_ops
*ops
,
1727 struct event_trigger_data
*data
);
1728 extern int trace_event_trigger_enable_disable(struct trace_event_file
*file
,
1729 int trigger_enable
);
1730 extern void update_cond_flag(struct trace_event_file
*file
);
1731 extern int set_trigger_filter(char *filter_str
,
1732 struct event_trigger_data
*trigger_data
,
1733 struct trace_event_file
*file
);
1734 extern struct event_trigger_data
*find_named_trigger(const char *name
);
1735 extern bool is_named_trigger(struct event_trigger_data
*test
);
1736 extern int save_named_trigger(const char *name
,
1737 struct event_trigger_data
*data
);
1738 extern void del_named_trigger(struct event_trigger_data
*data
);
1739 extern void pause_named_trigger(struct event_trigger_data
*data
);
1740 extern void unpause_named_trigger(struct event_trigger_data
*data
);
1741 extern void set_named_trigger_data(struct event_trigger_data
*data
,
1742 struct event_trigger_data
*named_data
);
1743 extern struct event_trigger_data
*
1744 get_named_trigger_data(struct event_trigger_data
*data
);
1745 extern int register_event_command(struct event_command
*cmd
);
1746 extern int unregister_event_command(struct event_command
*cmd
);
1747 extern int register_trigger_hist_enable_disable_cmds(void);
1750 * struct event_trigger_ops - callbacks for trace event triggers
1752 * The methods in this structure provide per-event trigger hooks for
1753 * various trigger operations.
1755 * All the methods below, except for @init() and @free(), must be
1758 * @func: The trigger 'probe' function called when the triggering
1759 * event occurs. The data passed into this callback is the data
1760 * that was supplied to the event_command @reg() function that
1761 * registered the trigger (see struct event_command) along with
1762 * the trace record, rec.
1764 * @init: An optional initialization function called for the trigger
1765 * when the trigger is registered (via the event_command reg()
1766 * function). This can be used to perform per-trigger
1767 * initialization such as incrementing a per-trigger reference
1768 * count, for instance. This is usually implemented by the
1769 * generic utility function @event_trigger_init() (see
1770 * trace_event_triggers.c).
1772 * @free: An optional de-initialization function called for the
1773 * trigger when the trigger is unregistered (via the
1774 * event_command @reg() function). This can be used to perform
1775 * per-trigger de-initialization such as decrementing a
1776 * per-trigger reference count and freeing corresponding trigger
1777 * data, for instance. This is usually implemented by the
1778 * generic utility function @event_trigger_free() (see
1779 * trace_event_triggers.c).
1781 * @print: The callback function invoked to have the trigger print
1782 * itself. This is usually implemented by a wrapper function
1783 * that calls the generic utility function @event_trigger_print()
1784 * (see trace_event_triggers.c).
1786 struct event_trigger_ops
{
1787 void (*func
)(struct event_trigger_data
*data
,
1789 struct ring_buffer_event
*rbe
);
1790 int (*init
)(struct event_trigger_ops
*ops
,
1791 struct event_trigger_data
*data
);
1792 void (*free
)(struct event_trigger_ops
*ops
,
1793 struct event_trigger_data
*data
);
1794 int (*print
)(struct seq_file
*m
,
1795 struct event_trigger_ops
*ops
,
1796 struct event_trigger_data
*data
);
1800 * struct event_command - callbacks and data members for event commands
1802 * Event commands are invoked by users by writing the command name
1803 * into the 'trigger' file associated with a trace event. The
1804 * parameters associated with a specific invocation of an event
1805 * command are used to create an event trigger instance, which is
1806 * added to the list of trigger instances associated with that trace
1807 * event. When the event is hit, the set of triggers associated with
1808 * that event is invoked.
1810 * The data members in this structure provide per-event command data
1811 * for various event commands.
1813 * All the data members below, except for @post_trigger, must be set
1814 * for each event command.
1816 * @name: The unique name that identifies the event command. This is
1817 * the name used when setting triggers via trigger files.
1819 * @trigger_type: A unique id that identifies the event command
1820 * 'type'. This value has two purposes, the first to ensure that
1821 * only one trigger of the same type can be set at a given time
1822 * for a particular event e.g. it doesn't make sense to have both
1823 * a traceon and traceoff trigger attached to a single event at
1824 * the same time, so traceon and traceoff have the same type
1825 * though they have different names. The @trigger_type value is
1826 * also used as a bit value for deferring the actual trigger
1827 * action until after the current event is finished. Some
1828 * commands need to do this if they themselves log to the trace
1829 * buffer (see the @post_trigger() member below). @trigger_type
1830 * values are defined by adding new values to the trigger_type
1831 * enum in include/linux/trace_events.h.
1833 * @flags: See the enum event_command_flags below.
1835 * All the methods below, except for @set_filter() and @unreg_all(),
1836 * must be implemented.
1838 * @func: The callback function responsible for parsing and
1839 * registering the trigger written to the 'trigger' file by the
1840 * user. It allocates the trigger instance and registers it with
1841 * the appropriate trace event. It makes use of the other
1842 * event_command callback functions to orchestrate this, and is
1843 * usually implemented by the generic utility function
1844 * @event_trigger_callback() (see trace_event_triggers.c).
1846 * @reg: Adds the trigger to the list of triggers associated with the
1847 * event, and enables the event trigger itself, after
1848 * initializing it (via the event_trigger_ops @init() function).
1849 * This is also where commands can use the @trigger_type value to
1850 * make the decision as to whether or not multiple instances of
1851 * the trigger should be allowed. This is usually implemented by
1852 * the generic utility function @register_trigger() (see
1853 * trace_event_triggers.c).
1855 * @unreg: Removes the trigger from the list of triggers associated
1856 * with the event, and disables the event trigger itself, after
1857 * initializing it (via the event_trigger_ops @free() function).
1858 * This is usually implemented by the generic utility function
1859 * @unregister_trigger() (see trace_event_triggers.c).
1861 * @unreg_all: An optional function called to remove all the triggers
1862 * from the list of triggers associated with the event. Called
1863 * when a trigger file is opened in truncate mode.
1865 * @set_filter: An optional function called to parse and set a filter
1866 * for the trigger. If no @set_filter() method is set for the
1867 * event command, filters set by the user for the command will be
1868 * ignored. This is usually implemented by the generic utility
1869 * function @set_trigger_filter() (see trace_event_triggers.c).
1871 * @get_trigger_ops: The callback function invoked to retrieve the
1872 * event_trigger_ops implementation associated with the command.
1874 struct event_command
{
1875 struct list_head list
;
1877 enum event_trigger_type trigger_type
;
1879 int (*func
)(struct event_command
*cmd_ops
,
1880 struct trace_event_file
*file
,
1881 char *glob
, char *cmd
, char *params
);
1882 int (*reg
)(char *glob
,
1883 struct event_trigger_ops
*ops
,
1884 struct event_trigger_data
*data
,
1885 struct trace_event_file
*file
);
1886 void (*unreg
)(char *glob
,
1887 struct event_trigger_ops
*ops
,
1888 struct event_trigger_data
*data
,
1889 struct trace_event_file
*file
);
1890 void (*unreg_all
)(struct trace_event_file
*file
);
1891 int (*set_filter
)(char *filter_str
,
1892 struct event_trigger_data
*data
,
1893 struct trace_event_file
*file
);
1894 struct event_trigger_ops
*(*get_trigger_ops
)(char *cmd
, char *param
);
1898 * enum event_command_flags - flags for struct event_command
1900 * @POST_TRIGGER: A flag that says whether or not this command needs
1901 * to have its action delayed until after the current event has
1902 * been closed. Some triggers need to avoid being invoked while
1903 * an event is currently in the process of being logged, since
1904 * the trigger may itself log data into the trace buffer. Thus
1905 * we make sure the current event is committed before invoking
1906 * those triggers. To do that, the trigger invocation is split
1907 * in two - the first part checks the filter using the current
1908 * trace record; if a command has the @post_trigger flag set, it
1909 * sets a bit for itself in the return value, otherwise it
1910 * directly invokes the trigger. Once all commands have been
1911 * either invoked or set their return flag, the current record is
1912 * either committed or discarded. At that point, if any commands
1913 * have deferred their triggers, those commands are finally
1914 * invoked following the close of the current event. In other
1915 * words, if the event_trigger_ops @func() probe implementation
1916 * itself logs to the trace buffer, this flag should be set,
1917 * otherwise it can be left unspecified.
1919 * @NEEDS_REC: A flag that says whether or not this command needs
1920 * access to the trace record in order to perform its function,
1921 * regardless of whether or not it has a filter associated with
1922 * it (filters make a trigger require access to the trace record
1923 * but are not always present).
1925 enum event_command_flags
{
1926 EVENT_CMD_FL_POST_TRIGGER
= 1,
1927 EVENT_CMD_FL_NEEDS_REC
= 2,
1930 static inline bool event_command_post_trigger(struct event_command
*cmd_ops
)
1932 return cmd_ops
->flags
& EVENT_CMD_FL_POST_TRIGGER
;
1935 static inline bool event_command_needs_rec(struct event_command
*cmd_ops
)
1937 return cmd_ops
->flags
& EVENT_CMD_FL_NEEDS_REC
;
1940 extern int trace_event_enable_disable(struct trace_event_file
*file
,
1941 int enable
, int soft_disable
);
1942 extern int tracing_alloc_snapshot(void);
1943 extern void tracing_snapshot_cond(struct trace_array
*tr
, void *cond_data
);
1944 extern int tracing_snapshot_cond_enable(struct trace_array
*tr
, void *cond_data
, cond_update_fn_t update
);
1946 extern int tracing_snapshot_cond_disable(struct trace_array
*tr
);
1947 extern void *tracing_cond_snapshot_data(struct trace_array
*tr
);
1949 extern const char *__start___trace_bprintk_fmt
[];
1950 extern const char *__stop___trace_bprintk_fmt
[];
1952 extern const char *__start___tracepoint_str
[];
1953 extern const char *__stop___tracepoint_str
[];
1955 void trace_printk_control(bool enabled
);
1956 void trace_printk_start_comm(void);
1957 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
);
1958 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
);
1960 /* Used from boot time tracer */
1961 extern int trace_set_options(struct trace_array
*tr
, char *option
);
1962 extern int tracing_set_tracer(struct trace_array
*tr
, const char *buf
);
1963 extern ssize_t
tracing_resize_ring_buffer(struct trace_array
*tr
,
1964 unsigned long size
, int cpu_id
);
1965 extern int tracing_set_cpumask(struct trace_array
*tr
,
1966 cpumask_var_t tracing_cpumask_new
);
1969 #define MAX_EVENT_NAME_LEN 64
1971 extern int trace_run_command(const char *buf
, int (*createfn
)(int, char**));
1972 extern ssize_t
trace_parse_run_command(struct file
*file
,
1973 const char __user
*buffer
, size_t count
, loff_t
*ppos
,
1974 int (*createfn
)(int, char**));
1976 extern unsigned int err_pos(char *cmd
, const char *str
);
1977 extern void tracing_log_err(struct trace_array
*tr
,
1978 const char *loc
, const char *cmd
,
1979 const char **errs
, u8 type
, u8 pos
);
1982 * Normal trace_printk() and friends allocates special buffers
1983 * to do the manipulation, as well as saves the print formats
1984 * into sections to display. But the trace infrastructure wants
1985 * to use these without the added overhead at the price of being
1986 * a bit slower (used mainly for warnings, where we don't care
1987 * about performance). The internal_trace_puts() is for such
1990 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1993 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1994 extern struct trace_event_call \
1995 __aligned(4) event_##call;
1996 #undef FTRACE_ENTRY_DUP
1997 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1998 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1999 #undef FTRACE_ENTRY_PACKED
2000 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
2001 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
2003 #include "trace_entries.h"
2005 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
2006 int perf_ftrace_event_register(struct trace_event_call
*call
,
2007 enum trace_reg type
, void *data
);
2009 #define perf_ftrace_event_register NULL
2012 #ifdef CONFIG_FTRACE_SYSCALLS
2013 void init_ftrace_syscalls(void);
2014 const char *get_syscall_name(int syscall
);
2016 static inline void init_ftrace_syscalls(void) { }
2017 static inline const char *get_syscall_name(int syscall
)
2023 #ifdef CONFIG_EVENT_TRACING
2024 void trace_event_init(void);
2025 void trace_event_eval_update(struct trace_eval_map
**map
, int len
);
2026 /* Used from boot time tracer */
2027 extern int ftrace_set_clr_event(struct trace_array
*tr
, char *buf
, int set
);
2028 extern int trigger_process_regex(struct trace_event_file
*file
, char *buff
);
2030 static inline void __init
trace_event_init(void) { }
2031 static inline void trace_event_eval_update(struct trace_eval_map
**map
, int len
) { }
2034 #ifdef CONFIG_TRACER_SNAPSHOT
2035 void tracing_snapshot_instance(struct trace_array
*tr
);
2036 int tracing_alloc_snapshot_instance(struct trace_array
*tr
);
2038 static inline void tracing_snapshot_instance(struct trace_array
*tr
) { }
2039 static inline int tracing_alloc_snapshot_instance(struct trace_array
*tr
)
2045 #ifdef CONFIG_PREEMPT_TRACER
2046 void tracer_preempt_on(unsigned long a0
, unsigned long a1
);
2047 void tracer_preempt_off(unsigned long a0
, unsigned long a1
);
2049 static inline void tracer_preempt_on(unsigned long a0
, unsigned long a1
) { }
2050 static inline void tracer_preempt_off(unsigned long a0
, unsigned long a1
) { }
2052 #ifdef CONFIG_IRQSOFF_TRACER
2053 void tracer_hardirqs_on(unsigned long a0
, unsigned long a1
);
2054 void tracer_hardirqs_off(unsigned long a0
, unsigned long a1
);
2056 static inline void tracer_hardirqs_on(unsigned long a0
, unsigned long a1
) { }
2057 static inline void tracer_hardirqs_off(unsigned long a0
, unsigned long a1
) { }
2060 extern struct trace_iterator
*tracepoint_print_iter
;
2063 * Reset the state of the trace_iterator so that it can read consumed data.
2064 * Normally, the trace_iterator is used for reading the data when it is not
2065 * consumed, and must retain state.
2067 static __always_inline
void trace_iterator_reset(struct trace_iterator
*iter
)
2069 const size_t offset
= offsetof(struct trace_iterator
, seq
);
2072 * Keep gcc from complaining about overwriting more than just one
2073 * member in the structure.
2075 memset((char *)iter
+ offset
, 0, sizeof(struct trace_iterator
) - offset
);
2080 #endif /* _LINUX_KERNEL_TRACE_H */