2 #ifndef _LINUX_KERNEL_TRACE_H
3 #define _LINUX_KERNEL_TRACE_H
6 #include <linux/atomic.h>
7 #include <linux/sched.h>
8 #include <linux/clocksource.h>
9 #include <linux/ring_buffer.h>
10 #include <linux/mmiotrace.h>
11 #include <linux/tracepoint.h>
12 #include <linux/ftrace.h>
13 #include <linux/hw_breakpoint.h>
14 #include <linux/trace_seq.h>
15 #include <linux/trace_events.h>
16 #include <linux/compiler.h>
17 #include <linux/trace_seq.h>
18 #include <linux/glob.h>
20 #ifdef CONFIG_FTRACE_SYSCALLS
21 #include <asm/unistd.h> /* For NR_SYSCALLS */
22 #include <asm/syscall.h> /* some archs define it here */
26 __TRACE_FIRST_TYPE
= 0,
50 #define __field(type, item) type item;
53 #define __field_struct(type, item) __field(type, item)
56 #define __field_desc(type, container, item)
59 #define __array(type, item, size) type item[size];
62 #define __array_desc(type, container, item, size)
64 #undef __dynamic_array
65 #define __dynamic_array(type, item) type item[];
68 #define F_STRUCT(args...) args
71 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
72 struct struct_name { \
73 struct trace_entry ent; \
77 #undef FTRACE_ENTRY_DUP
78 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
80 #undef FTRACE_ENTRY_REG
81 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
83 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
86 #undef FTRACE_ENTRY_PACKED
87 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print, \
89 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
92 #include "trace_entries.h"
95 * syscalls are special, and need special handling, this is why
96 * they are not included in trace_entries.h
98 struct syscall_trace_enter
{
99 struct trace_entry ent
;
101 unsigned long args
[];
104 struct syscall_trace_exit
{
105 struct trace_entry ent
;
110 struct kprobe_trace_entry_head
{
111 struct trace_entry ent
;
115 struct kretprobe_trace_entry_head
{
116 struct trace_entry ent
;
118 unsigned long ret_ip
;
122 * trace_flag_type is an enumeration that holds different
123 * states when a trace occurs. These are:
124 * IRQS_OFF - interrupts were disabled
125 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
126 * NEED_RESCHED - reschedule is requested
127 * HARDIRQ - inside an interrupt handler
128 * SOFTIRQ - inside a softirq handler
130 enum trace_flag_type
{
131 TRACE_FLAG_IRQS_OFF
= 0x01,
132 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
133 TRACE_FLAG_NEED_RESCHED
= 0x04,
134 TRACE_FLAG_HARDIRQ
= 0x08,
135 TRACE_FLAG_SOFTIRQ
= 0x10,
136 TRACE_FLAG_PREEMPT_RESCHED
= 0x20,
137 TRACE_FLAG_NMI
= 0x40,
140 #define TRACE_BUF_SIZE 1024
145 * The CPU trace array - it consists of thousands of trace entries
146 * plus some other descriptor data: (for example which task started
149 struct trace_array_cpu
{
151 void *buffer_page
; /* ring buffer spare */
153 unsigned long entries
;
154 unsigned long saved_latency
;
155 unsigned long critical_start
;
156 unsigned long critical_end
;
157 unsigned long critical_sequence
;
159 unsigned long policy
;
160 unsigned long rt_priority
;
161 unsigned long skipped_entries
;
162 u64 preempt_timestamp
;
165 char comm
[TASK_COMM_LEN
];
168 #ifdef CONFIG_FUNCTION_TRACER
169 bool ftrace_ignore_pid
;
174 struct trace_option_dentry
;
176 struct trace_buffer
{
177 struct trace_array
*tr
;
178 struct ring_buffer
*buffer
;
179 struct trace_array_cpu __percpu
*data
;
184 #define TRACE_FLAGS_MAX_SIZE 32
186 struct trace_options
{
187 struct tracer
*tracer
;
188 struct trace_option_dentry
*topts
;
191 struct trace_pid_list
{
197 * The trace array - an array of per-CPU trace arrays. This is the
198 * highest level data structure that individual tracers deal with.
199 * They have on/off state as well:
202 struct list_head list
;
204 struct trace_buffer trace_buffer
;
205 #ifdef CONFIG_TRACER_MAX_TRACE
207 * The max_buffer is used to snapshot the trace when a maximum
208 * latency is reached, or when the user initiates a snapshot.
209 * Some tracers will use this to store a maximum trace while
210 * it continues examining live traces.
212 * The buffers for the max_buffer are set up the same as the trace_buffer
213 * When a snapshot is taken, the buffer of the max_buffer is swapped
214 * with the buffer of the trace_buffer and the buffers are reset for
215 * the trace_buffer so the tracing can continue.
217 struct trace_buffer max_buffer
;
218 bool allocated_snapshot
;
220 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
221 unsigned long max_latency
;
223 struct trace_pid_list __rcu
*filtered_pids
;
225 * max_lock is used to protect the swapping of buffers
226 * when taking a max snapshot. The buffers themselves are
227 * protected by per_cpu spinlocks. But the action of the swap
228 * needs its own lock.
230 * This is defined as a arch_spinlock_t in order to help
231 * with performance when lockdep debugging is enabled.
233 * It is also used in other places outside the update_max_tr
234 * so it needs to be defined outside of the
235 * CONFIG_TRACER_MAX_TRACE.
237 arch_spinlock_t max_lock
;
239 #ifdef CONFIG_FTRACE_SYSCALLS
240 int sys_refcount_enter
;
241 int sys_refcount_exit
;
242 struct trace_event_file __rcu
*enter_syscall_files
[NR_syscalls
];
243 struct trace_event_file __rcu
*exit_syscall_files
[NR_syscalls
];
248 struct tracer
*current_trace
;
249 unsigned int trace_flags
;
250 unsigned char trace_flags_index
[TRACE_FLAGS_MAX_SIZE
];
252 raw_spinlock_t start_lock
;
254 struct dentry
*options
;
255 struct dentry
*percpu_dir
;
256 struct dentry
*event_dir
;
257 struct trace_options
*topts
;
258 struct list_head systems
;
259 struct list_head events
;
260 cpumask_var_t tracing_cpumask
; /* only trace on set CPUs */
262 #ifdef CONFIG_FUNCTION_TRACER
263 struct ftrace_ops
*ops
;
264 struct trace_pid_list __rcu
*function_pids
;
265 #ifdef CONFIG_DYNAMIC_FTRACE
266 struct list_head func_probes
;
268 /* function tracing enabled */
269 int function_enabled
;
274 TRACE_ARRAY_FL_GLOBAL
= (1 << 0)
277 extern struct list_head ftrace_trace_arrays
;
279 extern struct mutex trace_types_lock
;
281 extern int trace_array_get(struct trace_array
*tr
);
282 extern void trace_array_put(struct trace_array
*tr
);
285 * The global tracer (top) should be the first trace array added,
286 * but we check the flag anyway.
288 static inline struct trace_array
*top_trace_array(void)
290 struct trace_array
*tr
;
292 if (list_empty(&ftrace_trace_arrays
))
295 tr
= list_entry(ftrace_trace_arrays
.prev
,
297 WARN_ON(!(tr
->flags
& TRACE_ARRAY_FL_GLOBAL
));
301 #define FTRACE_CMP_TYPE(var, type) \
302 __builtin_types_compatible_p(typeof(var), type *)
305 #define IF_ASSIGN(var, entry, etype, id) \
306 if (FTRACE_CMP_TYPE(var, etype)) { \
307 var = (typeof(var))(entry); \
308 WARN_ON(id && (entry)->type != id); \
312 /* Will cause compile errors if type is not found. */
313 extern void __ftrace_bad_type(void);
316 * The trace_assign_type is a verifier that the entry type is
317 * the same as the type being assigned. To add new types simply
318 * add a line with the following format:
320 * IF_ASSIGN(var, ent, type, id);
322 * Where "type" is the trace type that includes the trace_entry
323 * as the "ent" item. And "id" is the trace identifier that is
324 * used in the trace_type enum.
326 * If the type can have more than one id, then use zero.
328 #define trace_assign_type(var, ent) \
330 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
331 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
332 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
333 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
334 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
335 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
336 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
337 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
338 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
339 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
341 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
343 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
344 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
346 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
348 __ftrace_bad_type(); \
352 * An option specific to a tracer. This is a boolean value.
353 * The bit is the bit index that sets its value on the
354 * flags value in struct tracer_flags.
357 const char *name
; /* Will appear on the trace_options file */
358 u32 bit
; /* Mask assigned in val field in tracer_flags */
362 * The set of specific options for a tracer. Your tracer
363 * have to set the initial value of the flags val.
365 struct tracer_flags
{
367 struct tracer_opt
*opts
;
368 struct tracer
*trace
;
371 /* Makes more easy to define a tracer opt */
372 #define TRACER_OPT(s, b) .name = #s, .bit = b
375 struct trace_option_dentry
{
376 struct tracer_opt
*opt
;
377 struct tracer_flags
*flags
;
378 struct trace_array
*tr
;
379 struct dentry
*entry
;
383 * struct tracer - a specific tracer and its callbacks to interact with tracefs
384 * @name: the name chosen to select it on the available_tracers file
385 * @init: called when one switches to this tracer (echo name > current_tracer)
386 * @reset: called when one switches to another tracer
387 * @start: called when tracing is unpaused (echo 1 > tracing_on)
388 * @stop: called when tracing is paused (echo 0 > tracing_on)
389 * @update_thresh: called when tracing_thresh is updated
390 * @open: called when the trace file is opened
391 * @pipe_open: called when the trace_pipe file is opened
392 * @close: called when the trace file is released
393 * @pipe_close: called when the trace_pipe file is released
394 * @read: override the default read callback on trace_pipe
395 * @splice_read: override the default splice_read callback on trace_pipe
396 * @selftest: selftest to run on boot (see trace_selftest.c)
397 * @print_headers: override the first lines that describe your columns
398 * @print_line: callback that prints a trace
399 * @set_flag: signals one of your private flags changed (trace_options file)
400 * @flags: your private flags
404 int (*init
)(struct trace_array
*tr
);
405 void (*reset
)(struct trace_array
*tr
);
406 void (*start
)(struct trace_array
*tr
);
407 void (*stop
)(struct trace_array
*tr
);
408 int (*update_thresh
)(struct trace_array
*tr
);
409 void (*open
)(struct trace_iterator
*iter
);
410 void (*pipe_open
)(struct trace_iterator
*iter
);
411 void (*close
)(struct trace_iterator
*iter
);
412 void (*pipe_close
)(struct trace_iterator
*iter
);
413 ssize_t (*read
)(struct trace_iterator
*iter
,
414 struct file
*filp
, char __user
*ubuf
,
415 size_t cnt
, loff_t
*ppos
);
416 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
419 struct pipe_inode_info
*pipe
,
422 #ifdef CONFIG_FTRACE_STARTUP_TEST
423 int (*selftest
)(struct tracer
*trace
,
424 struct trace_array
*tr
);
426 void (*print_header
)(struct seq_file
*m
);
427 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
428 /* If you handled the flag setting, return 0 */
429 int (*set_flag
)(struct trace_array
*tr
,
430 u32 old_flags
, u32 bit
, int set
);
431 /* Return 0 if OK with change, else return non-zero */
432 int (*flag_changed
)(struct trace_array
*tr
,
435 struct tracer_flags
*flags
;
439 bool allow_instances
;
440 #ifdef CONFIG_TRACER_MAX_TRACE
446 /* Only current can touch trace_recursion */
449 * For function tracing recursion:
450 * The order of these bits are important.
452 * When function tracing occurs, the following steps are made:
453 * If arch does not support a ftrace feature:
454 * call internal function (uses INTERNAL bits) which calls...
455 * If callback is registered to the "global" list, the list
456 * function is called and recursion checks the GLOBAL bits.
457 * then this function calls...
458 * The function callback, which can use the FTRACE bits to
459 * check for recursion.
461 * Now if the arch does not suppport a feature, and it calls
462 * the global list function which calls the ftrace callback
463 * all three of these steps will do a recursion protection.
464 * There's no reason to do one if the previous caller already
465 * did. The recursion that we are protecting against will
466 * go through the same steps again.
468 * To prevent the multiple recursion checks, if a recursion
469 * bit is set that is higher than the MAX bit of the current
470 * check, then we know that the check was made by the previous
471 * caller, and we can skip the current check.
475 TRACE_BUFFER_NMI_BIT
,
476 TRACE_BUFFER_IRQ_BIT
,
477 TRACE_BUFFER_SIRQ_BIT
,
479 /* Start of function recursion bits */
481 TRACE_FTRACE_NMI_BIT
,
482 TRACE_FTRACE_IRQ_BIT
,
483 TRACE_FTRACE_SIRQ_BIT
,
485 /* INTERNAL_BITs must be greater than FTRACE_BITs */
487 TRACE_INTERNAL_NMI_BIT
,
488 TRACE_INTERNAL_IRQ_BIT
,
489 TRACE_INTERNAL_SIRQ_BIT
,
493 * Abuse of the trace_recursion.
494 * As we need a way to maintain state if we are tracing the function
495 * graph in irq because we want to trace a particular function that
496 * was called in irq context but we have irq tracing off. Since this
497 * can only be modified by current, we can reuse trace_recursion.
502 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
503 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
504 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
506 #define TRACE_CONTEXT_BITS 4
508 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
509 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
511 #define TRACE_LIST_START TRACE_INTERNAL_BIT
512 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
514 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
516 static __always_inline
int trace_get_context_bit(void)
520 if (in_interrupt()) {
534 static __always_inline
int trace_test_and_set_recursion(int start
, int max
)
536 unsigned int val
= current
->trace_recursion
;
539 /* A previous recursion check was made */
540 if ((val
& TRACE_CONTEXT_MASK
) > max
)
543 bit
= trace_get_context_bit() + start
;
544 if (unlikely(val
& (1 << bit
)))
548 current
->trace_recursion
= val
;
554 static __always_inline
void trace_clear_recursion(int bit
)
556 unsigned int val
= current
->trace_recursion
;
565 current
->trace_recursion
= val
;
568 static inline struct ring_buffer_iter
*
569 trace_buffer_iter(struct trace_iterator
*iter
, int cpu
)
571 if (iter
->buffer_iter
&& iter
->buffer_iter
[cpu
])
572 return iter
->buffer_iter
[cpu
];
576 int tracer_init(struct tracer
*t
, struct trace_array
*tr
);
577 int tracing_is_enabled(void);
578 void tracing_reset(struct trace_buffer
*buf
, int cpu
);
579 void tracing_reset_online_cpus(struct trace_buffer
*buf
);
580 void tracing_reset_current(int cpu
);
581 void tracing_reset_all_online_cpus(void);
582 int tracing_open_generic(struct inode
*inode
, struct file
*filp
);
583 bool tracing_is_disabled(void);
584 int tracer_tracing_is_on(struct trace_array
*tr
);
585 struct dentry
*trace_create_file(const char *name
,
587 struct dentry
*parent
,
589 const struct file_operations
*fops
);
591 struct dentry
*tracing_init_dentry(void);
593 struct ring_buffer_event
;
595 struct ring_buffer_event
*
596 trace_buffer_lock_reserve(struct ring_buffer
*buffer
,
602 struct trace_entry
*tracing_get_trace_entry(struct trace_array
*tr
,
603 struct trace_array_cpu
*data
);
605 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
606 int *ent_cpu
, u64
*ent_ts
);
608 void trace_buffer_unlock_commit_nostack(struct ring_buffer
*buffer
,
609 struct ring_buffer_event
*event
);
611 int trace_empty(struct trace_iterator
*iter
);
613 void *trace_find_next_entry_inc(struct trace_iterator
*iter
);
615 void trace_init_global_iter(struct trace_iterator
*iter
);
617 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
);
619 void trace_function(struct trace_array
*tr
,
621 unsigned long parent_ip
,
622 unsigned long flags
, int pc
);
623 void trace_graph_function(struct trace_array
*tr
,
625 unsigned long parent_ip
,
626 unsigned long flags
, int pc
);
627 void trace_latency_header(struct seq_file
*m
);
628 void trace_default_header(struct seq_file
*m
);
629 void print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
);
630 int trace_empty(struct trace_iterator
*iter
);
632 void trace_graph_return(struct ftrace_graph_ret
*trace
);
633 int trace_graph_entry(struct ftrace_graph_ent
*trace
);
634 void set_graph_array(struct trace_array
*tr
);
636 void tracing_start_cmdline_record(void);
637 void tracing_stop_cmdline_record(void);
638 int register_tracer(struct tracer
*type
);
639 int is_tracing_stopped(void);
641 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
);
643 extern cpumask_var_t __read_mostly tracing_buffer_mask
;
645 #define for_each_tracing_cpu(cpu) \
646 for_each_cpu(cpu, tracing_buffer_mask)
648 extern unsigned long nsecs_to_usecs(unsigned long nsecs
);
650 extern unsigned long tracing_thresh
;
656 bool trace_find_filtered_pid(struct trace_pid_list
*filtered_pids
,
658 bool trace_ignore_this_task(struct trace_pid_list
*filtered_pids
,
659 struct task_struct
*task
);
660 void trace_filter_add_remove_task(struct trace_pid_list
*pid_list
,
661 struct task_struct
*self
,
662 struct task_struct
*task
);
663 void *trace_pid_next(struct trace_pid_list
*pid_list
, void *v
, loff_t
*pos
);
664 void *trace_pid_start(struct trace_pid_list
*pid_list
, loff_t
*pos
);
665 int trace_pid_show(struct seq_file
*m
, void *v
);
666 void trace_free_pid_list(struct trace_pid_list
*pid_list
);
667 int trace_pid_write(struct trace_pid_list
*filtered_pids
,
668 struct trace_pid_list
**new_pid_list
,
669 const char __user
*ubuf
, size_t cnt
);
671 #ifdef CONFIG_TRACER_MAX_TRACE
672 void update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
);
673 void update_max_tr_single(struct trace_array
*tr
,
674 struct task_struct
*tsk
, int cpu
);
675 #endif /* CONFIG_TRACER_MAX_TRACE */
677 #ifdef CONFIG_STACKTRACE
678 void ftrace_trace_userstack(struct ring_buffer
*buffer
, unsigned long flags
,
681 void __trace_stack(struct trace_array
*tr
, unsigned long flags
, int skip
,
684 static inline void ftrace_trace_userstack(struct ring_buffer
*buffer
,
685 unsigned long flags
, int pc
)
689 static inline void __trace_stack(struct trace_array
*tr
, unsigned long flags
,
693 #endif /* CONFIG_STACKTRACE */
695 extern u64
ftrace_now(int cpu
);
697 extern void trace_find_cmdline(int pid
, char comm
[]);
698 extern void trace_event_follow_fork(struct trace_array
*tr
, bool enable
);
700 #ifdef CONFIG_DYNAMIC_FTRACE
701 extern unsigned long ftrace_update_tot_cnt
;
702 void ftrace_init_trace_array(struct trace_array
*tr
);
704 static inline void ftrace_init_trace_array(struct trace_array
*tr
) { }
706 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
707 extern int DYN_FTRACE_TEST_NAME(void);
708 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
709 extern int DYN_FTRACE_TEST_NAME2(void);
711 extern bool ring_buffer_expanded
;
712 extern bool tracing_selftest_disabled
;
714 #ifdef CONFIG_FTRACE_STARTUP_TEST
715 extern int trace_selftest_startup_function(struct tracer
*trace
,
716 struct trace_array
*tr
);
717 extern int trace_selftest_startup_function_graph(struct tracer
*trace
,
718 struct trace_array
*tr
);
719 extern int trace_selftest_startup_irqsoff(struct tracer
*trace
,
720 struct trace_array
*tr
);
721 extern int trace_selftest_startup_preemptoff(struct tracer
*trace
,
722 struct trace_array
*tr
);
723 extern int trace_selftest_startup_preemptirqsoff(struct tracer
*trace
,
724 struct trace_array
*tr
);
725 extern int trace_selftest_startup_wakeup(struct tracer
*trace
,
726 struct trace_array
*tr
);
727 extern int trace_selftest_startup_nop(struct tracer
*trace
,
728 struct trace_array
*tr
);
729 extern int trace_selftest_startup_sched_switch(struct tracer
*trace
,
730 struct trace_array
*tr
);
731 extern int trace_selftest_startup_branch(struct tracer
*trace
,
732 struct trace_array
*tr
);
734 * Tracer data references selftest functions that only occur
735 * on boot up. These can be __init functions. Thus, when selftests
736 * are enabled, then the tracers need to reference __init functions.
738 #define __tracer_data __refdata
740 /* Tracers are seldom changed. Optimize when selftests are disabled. */
741 #define __tracer_data __read_mostly
742 #endif /* CONFIG_FTRACE_STARTUP_TEST */
744 extern void *head_page(struct trace_array_cpu
*data
);
745 extern unsigned long long ns2usecs(u64 nsec
);
747 trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
);
749 trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
);
751 trace_array_vprintk(struct trace_array
*tr
,
752 unsigned long ip
, const char *fmt
, va_list args
);
753 int trace_array_printk(struct trace_array
*tr
,
754 unsigned long ip
, const char *fmt
, ...);
755 int trace_array_printk_buf(struct ring_buffer
*buffer
,
756 unsigned long ip
, const char *fmt
, ...);
757 void trace_printk_seq(struct trace_seq
*s
);
758 enum print_line_t
print_trace_line(struct trace_iterator
*iter
);
760 extern char trace_find_mark(unsigned long long duration
);
763 unsigned long size_bits
;
764 struct hlist_head
*buckets
;
769 struct ftrace_func_entry
*
770 ftrace_lookup_ip(struct ftrace_hash
*hash
, unsigned long ip
);
772 static __always_inline
bool ftrace_hash_empty(struct ftrace_hash
*hash
)
774 return !hash
|| !hash
->count
;
777 /* Standard output formatting function used for function return traces */
778 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
781 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
782 #define TRACE_GRAPH_PRINT_CPU 0x2
783 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
784 #define TRACE_GRAPH_PRINT_PROC 0x8
785 #define TRACE_GRAPH_PRINT_DURATION 0x10
786 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
787 #define TRACE_GRAPH_PRINT_IRQS 0x40
788 #define TRACE_GRAPH_PRINT_TAIL 0x80
789 #define TRACE_GRAPH_SLEEP_TIME 0x100
790 #define TRACE_GRAPH_GRAPH_TIME 0x200
791 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
792 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
794 extern void ftrace_graph_sleep_time_control(bool enable
);
795 extern void ftrace_graph_graph_time_control(bool enable
);
797 extern enum print_line_t
798 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
);
799 extern void print_graph_headers_flags(struct seq_file
*s
, u32 flags
);
801 trace_print_graph_duration(unsigned long long duration
, struct trace_seq
*s
);
802 extern void graph_trace_open(struct trace_iterator
*iter
);
803 extern void graph_trace_close(struct trace_iterator
*iter
);
804 extern int __trace_graph_entry(struct trace_array
*tr
,
805 struct ftrace_graph_ent
*trace
,
806 unsigned long flags
, int pc
);
807 extern void __trace_graph_return(struct trace_array
*tr
,
808 struct ftrace_graph_ret
*trace
,
809 unsigned long flags
, int pc
);
811 #ifdef CONFIG_DYNAMIC_FTRACE
812 extern struct ftrace_hash
*ftrace_graph_hash
;
813 extern struct ftrace_hash
*ftrace_graph_notrace_hash
;
815 static inline int ftrace_graph_addr(unsigned long addr
)
819 preempt_disable_notrace();
821 if (ftrace_hash_empty(ftrace_graph_hash
)) {
826 if (ftrace_lookup_ip(ftrace_graph_hash
, addr
)) {
828 * If no irqs are to be traced, but a set_graph_function
829 * is set, and called by an interrupt handler, we still
833 trace_recursion_set(TRACE_IRQ_BIT
);
835 trace_recursion_clear(TRACE_IRQ_BIT
);
840 preempt_enable_notrace();
844 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
848 preempt_disable_notrace();
850 if (ftrace_lookup_ip(ftrace_graph_notrace_hash
, addr
))
853 preempt_enable_notrace();
857 static inline int ftrace_graph_addr(unsigned long addr
)
862 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
866 #endif /* CONFIG_DYNAMIC_FTRACE */
868 extern unsigned int fgraph_max_depth
;
870 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent
*trace
)
872 /* trace it when it is-nested-in or is a function enabled. */
873 return !(trace
->depth
|| ftrace_graph_addr(trace
->func
)) ||
874 (trace
->depth
< 0) ||
875 (fgraph_max_depth
&& trace
->depth
>= fgraph_max_depth
);
878 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
879 static inline enum print_line_t
880 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
)
882 return TRACE_TYPE_UNHANDLED
;
884 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
886 extern struct list_head ftrace_pids
;
888 #ifdef CONFIG_FUNCTION_TRACER
889 struct ftrace_func_command
{
890 struct list_head list
;
892 int (*func
)(struct trace_array
*tr
,
893 struct ftrace_hash
*hash
,
894 char *func
, char *cmd
,
895 char *params
, int enable
);
897 extern bool ftrace_filter_param __initdata
;
898 static inline int ftrace_trace_task(struct trace_array
*tr
)
900 return !this_cpu_read(tr
->trace_buffer
.data
->ftrace_ignore_pid
);
902 extern int ftrace_is_dead(void);
903 int ftrace_create_function_files(struct trace_array
*tr
,
904 struct dentry
*parent
);
905 void ftrace_destroy_function_files(struct trace_array
*tr
);
906 void ftrace_init_global_array_ops(struct trace_array
*tr
);
907 void ftrace_init_array_ops(struct trace_array
*tr
, ftrace_func_t func
);
908 void ftrace_reset_array_ops(struct trace_array
*tr
);
909 int using_ftrace_ops_list_func(void);
910 void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
);
911 void ftrace_init_tracefs_toplevel(struct trace_array
*tr
,
912 struct dentry
*d_tracer
);
913 int init_function_trace(void);
914 void ftrace_pid_follow_fork(struct trace_array
*tr
, bool enable
);
916 static inline int ftrace_trace_task(struct trace_array
*tr
)
920 static inline int ftrace_is_dead(void) { return 0; }
922 ftrace_create_function_files(struct trace_array
*tr
,
923 struct dentry
*parent
)
927 static inline void ftrace_destroy_function_files(struct trace_array
*tr
) { }
928 static inline __init
void
929 ftrace_init_global_array_ops(struct trace_array
*tr
) { }
930 static inline void ftrace_reset_array_ops(struct trace_array
*tr
) { }
931 static inline void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d
) { }
932 static inline void ftrace_init_tracefs_toplevel(struct trace_array
*tr
, struct dentry
*d
) { }
933 static inline int init_function_trace(void) { return 0; }
934 static inline void ftrace_pid_follow_fork(struct trace_array
*tr
, bool enable
) { }
935 /* ftace_func_t type is not defined, use macro instead of static inline */
936 #define ftrace_init_array_ops(tr, func) do { } while (0)
937 #endif /* CONFIG_FUNCTION_TRACER */
939 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
941 struct ftrace_probe_ops
{
942 struct ftrace_ops ops
;
943 struct list_head list
;
944 void (*func
)(unsigned long ip
,
945 unsigned long parent_ip
,
946 struct trace_array
*tr
,
947 struct ftrace_probe_ops
*ops
,
949 int (*init
)(struct ftrace_probe_ops
*ops
,
950 struct trace_array
*tr
,
951 unsigned long ip
, void *data
);
952 void (*free
)(struct ftrace_probe_ops
*ops
,
953 struct trace_array
*tr
,
954 unsigned long ip
, void **data
);
955 int (*print
)(struct seq_file
*m
,
957 struct ftrace_probe_ops
*ops
,
962 struct ftrace_func_mapper
;
963 typedef int (*ftrace_mapper_func
)(void *data
);
965 struct ftrace_func_mapper
*allocate_ftrace_func_mapper(void);
966 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper
*mapper
,
968 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper
*mapper
,
969 unsigned long ip
, void *data
);
970 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper
*mapper
,
972 void free_ftrace_func_mapper(struct ftrace_func_mapper
*mapper
,
973 ftrace_mapper_func free_func
);
976 register_ftrace_function_probe(char *glob
, struct trace_array
*tr
,
977 struct ftrace_probe_ops
*ops
, void *data
);
979 unregister_ftrace_function_probe_func(char *glob
, struct ftrace_probe_ops
*ops
);
981 int register_ftrace_command(struct ftrace_func_command
*cmd
);
982 int unregister_ftrace_command(struct ftrace_func_command
*cmd
);
984 void ftrace_create_filter_files(struct ftrace_ops
*ops
,
985 struct dentry
*parent
);
986 void ftrace_destroy_filter_files(struct ftrace_ops
*ops
);
988 struct ftrace_func_command
;
990 static inline __init
int register_ftrace_command(struct ftrace_func_command
*cmd
)
994 static inline __init
int unregister_ftrace_command(char *cmd_name
)
999 * The ops parameter passed in is usually undefined.
1000 * This must be a macro.
1002 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1003 #define ftrace_destroy_filter_files(ops) do { } while (0)
1004 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1006 bool ftrace_event_is_function(struct trace_event_call
*call
);
1009 * struct trace_parser - servers for reading the user input separated by spaces
1010 * @cont: set if the input is not complete - no final space char was found
1011 * @buffer: holds the parsed user input
1012 * @idx: user input length
1013 * @size: buffer size
1015 struct trace_parser
{
1022 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
1024 return (parser
->idx
!= 0);
1027 static inline bool trace_parser_cont(struct trace_parser
*parser
)
1029 return parser
->cont
;
1032 static inline void trace_parser_clear(struct trace_parser
*parser
)
1034 parser
->cont
= false;
1038 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
1039 extern void trace_parser_put(struct trace_parser
*parser
);
1040 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
1041 size_t cnt
, loff_t
*ppos
);
1044 * Only create function graph options if function graph is configured.
1046 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1047 # define FGRAPH_FLAGS \
1048 C(DISPLAY_GRAPH, "display-graph"),
1050 # define FGRAPH_FLAGS
1053 #ifdef CONFIG_BRANCH_TRACER
1054 # define BRANCH_FLAGS \
1055 C(BRANCH, "branch"),
1057 # define BRANCH_FLAGS
1060 #ifdef CONFIG_FUNCTION_TRACER
1061 # define FUNCTION_FLAGS \
1062 C(FUNCTION, "function-trace"), \
1063 C(FUNC_FORK, "function-fork"),
1064 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1066 # define FUNCTION_FLAGS
1067 # define FUNCTION_DEFAULT_FLAGS 0UL
1068 # define TRACE_ITER_FUNC_FORK 0UL
1071 #ifdef CONFIG_STACKTRACE
1072 # define STACK_FLAGS \
1073 C(STACKTRACE, "stacktrace"),
1075 # define STACK_FLAGS
1079 * trace_iterator_flags is an enumeration that defines bit
1080 * positions into trace_flags that controls the output.
1082 * NOTE: These bits must match the trace_options array in
1083 * trace.c (this macro guarantees it).
1085 #define TRACE_FLAGS \
1086 C(PRINT_PARENT, "print-parent"), \
1087 C(SYM_OFFSET, "sym-offset"), \
1088 C(SYM_ADDR, "sym-addr"), \
1089 C(VERBOSE, "verbose"), \
1093 C(BLOCK, "block"), \
1094 C(PRINTK, "trace_printk"), \
1095 C(ANNOTATE, "annotate"), \
1096 C(USERSTACKTRACE, "userstacktrace"), \
1097 C(SYM_USEROBJ, "sym-userobj"), \
1098 C(PRINTK_MSGONLY, "printk-msg-only"), \
1099 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1100 C(LATENCY_FMT, "latency-format"), \
1101 C(RECORD_CMD, "record-cmd"), \
1102 C(OVERWRITE, "overwrite"), \
1103 C(STOP_ON_FREE, "disable_on_free"), \
1104 C(IRQ_INFO, "irq-info"), \
1105 C(MARKERS, "markers"), \
1106 C(EVENT_FORK, "event-fork"), \
1113 * By defining C, we can make TRACE_FLAGS a list of bit names
1114 * that will define the bits for the flag masks.
1117 #define C(a, b) TRACE_ITER_##a##_BIT
1119 enum trace_iterator_bits
{
1121 /* Make sure we don't go more than we have bits for */
1126 * By redefining C, we can make TRACE_FLAGS a list of masks that
1127 * use the bits as defined above.
1130 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1132 enum trace_iterator_flags
{ TRACE_FLAGS
};
1135 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1136 * control the output of kernel symbols.
1138 #define TRACE_ITER_SYM_MASK \
1139 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1141 extern struct tracer nop_trace
;
1143 #ifdef CONFIG_BRANCH_TRACER
1144 extern int enable_branch_tracing(struct trace_array
*tr
);
1145 extern void disable_branch_tracing(void);
1146 static inline int trace_branch_enable(struct trace_array
*tr
)
1148 if (tr
->trace_flags
& TRACE_ITER_BRANCH
)
1149 return enable_branch_tracing(tr
);
1152 static inline void trace_branch_disable(void)
1154 /* due to races, always disable */
1155 disable_branch_tracing();
1158 static inline int trace_branch_enable(struct trace_array
*tr
)
1162 static inline void trace_branch_disable(void)
1165 #endif /* CONFIG_BRANCH_TRACER */
1167 /* set ring buffers to default size if not already done so */
1168 int tracing_update_buffers(void);
1170 struct ftrace_event_field
{
1171 struct list_head link
;
1180 struct event_filter
{
1181 int n_preds
; /* Number assigned */
1182 int a_preds
; /* allocated */
1183 struct filter_pred
*preds
;
1184 struct filter_pred
*root
;
1185 char *filter_string
;
1188 struct event_subsystem
{
1189 struct list_head list
;
1191 struct event_filter
*filter
;
1195 struct trace_subsystem_dir
{
1196 struct list_head list
;
1197 struct event_subsystem
*subsystem
;
1198 struct trace_array
*tr
;
1199 struct dentry
*entry
;
1204 extern int call_filter_check_discard(struct trace_event_call
*call
, void *rec
,
1205 struct ring_buffer
*buffer
,
1206 struct ring_buffer_event
*event
);
1208 void trace_buffer_unlock_commit_regs(struct trace_array
*tr
,
1209 struct ring_buffer
*buffer
,
1210 struct ring_buffer_event
*event
,
1211 unsigned long flags
, int pc
,
1212 struct pt_regs
*regs
);
1214 static inline void trace_buffer_unlock_commit(struct trace_array
*tr
,
1215 struct ring_buffer
*buffer
,
1216 struct ring_buffer_event
*event
,
1217 unsigned long flags
, int pc
)
1219 trace_buffer_unlock_commit_regs(tr
, buffer
, event
, flags
, pc
, NULL
);
1222 DECLARE_PER_CPU(struct ring_buffer_event
*, trace_buffered_event
);
1223 DECLARE_PER_CPU(int, trace_buffered_event_cnt
);
1224 void trace_buffered_event_disable(void);
1225 void trace_buffered_event_enable(void);
1228 __trace_event_discard_commit(struct ring_buffer
*buffer
,
1229 struct ring_buffer_event
*event
)
1231 if (this_cpu_read(trace_buffered_event
) == event
) {
1232 /* Simply release the temp buffer */
1233 this_cpu_dec(trace_buffered_event_cnt
);
1236 ring_buffer_discard_commit(buffer
, event
);
1240 * Helper function for event_trigger_unlock_commit{_regs}().
1241 * If there are event triggers attached to this event that requires
1242 * filtering against its fields, then they wil be called as the
1243 * entry already holds the field information of the current event.
1245 * It also checks if the event should be discarded or not.
1246 * It is to be discarded if the event is soft disabled and the
1247 * event was only recorded to process triggers, or if the event
1248 * filter is active and this event did not match the filters.
1250 * Returns true if the event is discarded, false otherwise.
1253 __event_trigger_test_discard(struct trace_event_file
*file
,
1254 struct ring_buffer
*buffer
,
1255 struct ring_buffer_event
*event
,
1257 enum event_trigger_type
*tt
)
1259 unsigned long eflags
= file
->flags
;
1261 if (eflags
& EVENT_FILE_FL_TRIGGER_COND
)
1262 *tt
= event_triggers_call(file
, entry
);
1264 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT
, &file
->flags
) ||
1265 (unlikely(file
->flags
& EVENT_FILE_FL_FILTERED
) &&
1266 !filter_match_preds(file
->filter
, entry
))) {
1267 __trace_event_discard_commit(buffer
, event
);
1275 * event_trigger_unlock_commit - handle triggers and finish event commit
1276 * @file: The file pointer assoctiated to the event
1277 * @buffer: The ring buffer that the event is being written to
1278 * @event: The event meta data in the ring buffer
1279 * @entry: The event itself
1280 * @irq_flags: The state of the interrupts at the start of the event
1281 * @pc: The state of the preempt count at the start of the event.
1283 * This is a helper function to handle triggers that require data
1284 * from the event itself. It also tests the event against filters and
1285 * if the event is soft disabled and should be discarded.
1288 event_trigger_unlock_commit(struct trace_event_file
*file
,
1289 struct ring_buffer
*buffer
,
1290 struct ring_buffer_event
*event
,
1291 void *entry
, unsigned long irq_flags
, int pc
)
1293 enum event_trigger_type tt
= ETT_NONE
;
1295 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1296 trace_buffer_unlock_commit(file
->tr
, buffer
, event
, irq_flags
, pc
);
1299 event_triggers_post_call(file
, tt
, entry
);
1303 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1304 * @file: The file pointer assoctiated to the event
1305 * @buffer: The ring buffer that the event is being written to
1306 * @event: The event meta data in the ring buffer
1307 * @entry: The event itself
1308 * @irq_flags: The state of the interrupts at the start of the event
1309 * @pc: The state of the preempt count at the start of the event.
1311 * This is a helper function to handle triggers that require data
1312 * from the event itself. It also tests the event against filters and
1313 * if the event is soft disabled and should be discarded.
1315 * Same as event_trigger_unlock_commit() but calls
1316 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1319 event_trigger_unlock_commit_regs(struct trace_event_file
*file
,
1320 struct ring_buffer
*buffer
,
1321 struct ring_buffer_event
*event
,
1322 void *entry
, unsigned long irq_flags
, int pc
,
1323 struct pt_regs
*regs
)
1325 enum event_trigger_type tt
= ETT_NONE
;
1327 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1328 trace_buffer_unlock_commit_regs(file
->tr
, buffer
, event
,
1329 irq_flags
, pc
, regs
);
1332 event_triggers_post_call(file
, tt
, entry
);
1335 #define FILTER_PRED_INVALID ((unsigned short)-1)
1336 #define FILTER_PRED_IS_RIGHT (1 << 15)
1337 #define FILTER_PRED_FOLD (1 << 15)
1340 * The max preds is the size of unsigned short with
1341 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1342 * and FOLD flags. The other is reserved.
1344 * 2^14 preds is way more than enough.
1346 #define MAX_FILTER_PRED 16384
1351 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
);
1353 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
1364 char pattern
[MAX_FILTER_STR_VAL
];
1367 regex_match_func match
;
1370 struct filter_pred
{
1371 filter_pred_fn_t fn
;
1374 unsigned short *ops
;
1375 struct ftrace_event_field
*field
;
1379 unsigned short index
;
1380 unsigned short parent
;
1381 unsigned short left
;
1382 unsigned short right
;
1385 static inline bool is_string_field(struct ftrace_event_field
*field
)
1387 return field
->filter_type
== FILTER_DYN_STRING
||
1388 field
->filter_type
== FILTER_STATIC_STRING
||
1389 field
->filter_type
== FILTER_PTR_STRING
||
1390 field
->filter_type
== FILTER_COMM
;
1393 static inline bool is_function_field(struct ftrace_event_field
*field
)
1395 return field
->filter_type
== FILTER_TRACE_FN
;
1398 extern enum regex_type
1399 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
1400 extern void print_event_filter(struct trace_event_file
*file
,
1401 struct trace_seq
*s
);
1402 extern int apply_event_filter(struct trace_event_file
*file
,
1403 char *filter_string
);
1404 extern int apply_subsystem_event_filter(struct trace_subsystem_dir
*dir
,
1405 char *filter_string
);
1406 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
1407 struct trace_seq
*s
);
1408 extern int filter_assign_type(const char *type
);
1409 extern int create_event_filter(struct trace_event_call
*call
,
1410 char *filter_str
, bool set_str
,
1411 struct event_filter
**filterp
);
1412 extern void free_event_filter(struct event_filter
*filter
);
1414 struct ftrace_event_field
*
1415 trace_find_event_field(struct trace_event_call
*call
, char *name
);
1417 extern void trace_event_enable_cmd_record(bool enable
);
1418 extern int event_trace_add_tracer(struct dentry
*parent
, struct trace_array
*tr
);
1419 extern int event_trace_del_tracer(struct trace_array
*tr
);
1421 extern struct trace_event_file
*find_event_file(struct trace_array
*tr
,
1425 static inline void *event_file_data(struct file
*filp
)
1427 return ACCESS_ONCE(file_inode(filp
)->i_private
);
1430 extern struct mutex event_mutex
;
1431 extern struct list_head ftrace_events
;
1433 extern const struct file_operations event_trigger_fops
;
1434 extern const struct file_operations event_hist_fops
;
1436 #ifdef CONFIG_HIST_TRIGGERS
1437 extern int register_trigger_hist_cmd(void);
1438 extern int register_trigger_hist_enable_disable_cmds(void);
1440 static inline int register_trigger_hist_cmd(void) { return 0; }
1441 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1444 extern int register_trigger_cmds(void);
1445 extern void clear_event_triggers(struct trace_array
*tr
);
1447 struct event_trigger_data
{
1448 unsigned long count
;
1450 struct event_trigger_ops
*ops
;
1451 struct event_command
*cmd_ops
;
1452 struct event_filter __rcu
*filter
;
1457 struct list_head list
;
1459 struct list_head named_list
;
1460 struct event_trigger_data
*named_data
;
1464 #define ENABLE_EVENT_STR "enable_event"
1465 #define DISABLE_EVENT_STR "disable_event"
1466 #define ENABLE_HIST_STR "enable_hist"
1467 #define DISABLE_HIST_STR "disable_hist"
1469 struct enable_trigger_data
{
1470 struct trace_event_file
*file
;
1475 extern int event_enable_trigger_print(struct seq_file
*m
,
1476 struct event_trigger_ops
*ops
,
1477 struct event_trigger_data
*data
);
1478 extern void event_enable_trigger_free(struct event_trigger_ops
*ops
,
1479 struct event_trigger_data
*data
);
1480 extern int event_enable_trigger_func(struct event_command
*cmd_ops
,
1481 struct trace_event_file
*file
,
1482 char *glob
, char *cmd
, char *param
);
1483 extern int event_enable_register_trigger(char *glob
,
1484 struct event_trigger_ops
*ops
,
1485 struct event_trigger_data
*data
,
1486 struct trace_event_file
*file
);
1487 extern void event_enable_unregister_trigger(char *glob
,
1488 struct event_trigger_ops
*ops
,
1489 struct event_trigger_data
*test
,
1490 struct trace_event_file
*file
);
1491 extern void trigger_data_free(struct event_trigger_data
*data
);
1492 extern int event_trigger_init(struct event_trigger_ops
*ops
,
1493 struct event_trigger_data
*data
);
1494 extern int trace_event_trigger_enable_disable(struct trace_event_file
*file
,
1495 int trigger_enable
);
1496 extern void update_cond_flag(struct trace_event_file
*file
);
1497 extern void unregister_trigger(char *glob
, struct event_trigger_ops
*ops
,
1498 struct event_trigger_data
*test
,
1499 struct trace_event_file
*file
);
1500 extern int set_trigger_filter(char *filter_str
,
1501 struct event_trigger_data
*trigger_data
,
1502 struct trace_event_file
*file
);
1503 extern struct event_trigger_data
*find_named_trigger(const char *name
);
1504 extern bool is_named_trigger(struct event_trigger_data
*test
);
1505 extern int save_named_trigger(const char *name
,
1506 struct event_trigger_data
*data
);
1507 extern void del_named_trigger(struct event_trigger_data
*data
);
1508 extern void pause_named_trigger(struct event_trigger_data
*data
);
1509 extern void unpause_named_trigger(struct event_trigger_data
*data
);
1510 extern void set_named_trigger_data(struct event_trigger_data
*data
,
1511 struct event_trigger_data
*named_data
);
1512 extern int register_event_command(struct event_command
*cmd
);
1513 extern int unregister_event_command(struct event_command
*cmd
);
1514 extern int register_trigger_hist_enable_disable_cmds(void);
1517 * struct event_trigger_ops - callbacks for trace event triggers
1519 * The methods in this structure provide per-event trigger hooks for
1520 * various trigger operations.
1522 * All the methods below, except for @init() and @free(), must be
1525 * @func: The trigger 'probe' function called when the triggering
1526 * event occurs. The data passed into this callback is the data
1527 * that was supplied to the event_command @reg() function that
1528 * registered the trigger (see struct event_command) along with
1529 * the trace record, rec.
1531 * @init: An optional initialization function called for the trigger
1532 * when the trigger is registered (via the event_command reg()
1533 * function). This can be used to perform per-trigger
1534 * initialization such as incrementing a per-trigger reference
1535 * count, for instance. This is usually implemented by the
1536 * generic utility function @event_trigger_init() (see
1537 * trace_event_triggers.c).
1539 * @free: An optional de-initialization function called for the
1540 * trigger when the trigger is unregistered (via the
1541 * event_command @reg() function). This can be used to perform
1542 * per-trigger de-initialization such as decrementing a
1543 * per-trigger reference count and freeing corresponding trigger
1544 * data, for instance. This is usually implemented by the
1545 * generic utility function @event_trigger_free() (see
1546 * trace_event_triggers.c).
1548 * @print: The callback function invoked to have the trigger print
1549 * itself. This is usually implemented by a wrapper function
1550 * that calls the generic utility function @event_trigger_print()
1551 * (see trace_event_triggers.c).
1553 struct event_trigger_ops
{
1554 void (*func
)(struct event_trigger_data
*data
,
1556 int (*init
)(struct event_trigger_ops
*ops
,
1557 struct event_trigger_data
*data
);
1558 void (*free
)(struct event_trigger_ops
*ops
,
1559 struct event_trigger_data
*data
);
1560 int (*print
)(struct seq_file
*m
,
1561 struct event_trigger_ops
*ops
,
1562 struct event_trigger_data
*data
);
1566 * struct event_command - callbacks and data members for event commands
1568 * Event commands are invoked by users by writing the command name
1569 * into the 'trigger' file associated with a trace event. The
1570 * parameters associated with a specific invocation of an event
1571 * command are used to create an event trigger instance, which is
1572 * added to the list of trigger instances associated with that trace
1573 * event. When the event is hit, the set of triggers associated with
1574 * that event is invoked.
1576 * The data members in this structure provide per-event command data
1577 * for various event commands.
1579 * All the data members below, except for @post_trigger, must be set
1580 * for each event command.
1582 * @name: The unique name that identifies the event command. This is
1583 * the name used when setting triggers via trigger files.
1585 * @trigger_type: A unique id that identifies the event command
1586 * 'type'. This value has two purposes, the first to ensure that
1587 * only one trigger of the same type can be set at a given time
1588 * for a particular event e.g. it doesn't make sense to have both
1589 * a traceon and traceoff trigger attached to a single event at
1590 * the same time, so traceon and traceoff have the same type
1591 * though they have different names. The @trigger_type value is
1592 * also used as a bit value for deferring the actual trigger
1593 * action until after the current event is finished. Some
1594 * commands need to do this if they themselves log to the trace
1595 * buffer (see the @post_trigger() member below). @trigger_type
1596 * values are defined by adding new values to the trigger_type
1597 * enum in include/linux/trace_events.h.
1599 * @flags: See the enum event_command_flags below.
1601 * All the methods below, except for @set_filter() and @unreg_all(),
1602 * must be implemented.
1604 * @func: The callback function responsible for parsing and
1605 * registering the trigger written to the 'trigger' file by the
1606 * user. It allocates the trigger instance and registers it with
1607 * the appropriate trace event. It makes use of the other
1608 * event_command callback functions to orchestrate this, and is
1609 * usually implemented by the generic utility function
1610 * @event_trigger_callback() (see trace_event_triggers.c).
1612 * @reg: Adds the trigger to the list of triggers associated with the
1613 * event, and enables the event trigger itself, after
1614 * initializing it (via the event_trigger_ops @init() function).
1615 * This is also where commands can use the @trigger_type value to
1616 * make the decision as to whether or not multiple instances of
1617 * the trigger should be allowed. This is usually implemented by
1618 * the generic utility function @register_trigger() (see
1619 * trace_event_triggers.c).
1621 * @unreg: Removes the trigger from the list of triggers associated
1622 * with the event, and disables the event trigger itself, after
1623 * initializing it (via the event_trigger_ops @free() function).
1624 * This is usually implemented by the generic utility function
1625 * @unregister_trigger() (see trace_event_triggers.c).
1627 * @unreg_all: An optional function called to remove all the triggers
1628 * from the list of triggers associated with the event. Called
1629 * when a trigger file is opened in truncate mode.
1631 * @set_filter: An optional function called to parse and set a filter
1632 * for the trigger. If no @set_filter() method is set for the
1633 * event command, filters set by the user for the command will be
1634 * ignored. This is usually implemented by the generic utility
1635 * function @set_trigger_filter() (see trace_event_triggers.c).
1637 * @get_trigger_ops: The callback function invoked to retrieve the
1638 * event_trigger_ops implementation associated with the command.
1640 struct event_command
{
1641 struct list_head list
;
1643 enum event_trigger_type trigger_type
;
1645 int (*func
)(struct event_command
*cmd_ops
,
1646 struct trace_event_file
*file
,
1647 char *glob
, char *cmd
, char *params
);
1648 int (*reg
)(char *glob
,
1649 struct event_trigger_ops
*ops
,
1650 struct event_trigger_data
*data
,
1651 struct trace_event_file
*file
);
1652 void (*unreg
)(char *glob
,
1653 struct event_trigger_ops
*ops
,
1654 struct event_trigger_data
*data
,
1655 struct trace_event_file
*file
);
1656 void (*unreg_all
)(struct trace_event_file
*file
);
1657 int (*set_filter
)(char *filter_str
,
1658 struct event_trigger_data
*data
,
1659 struct trace_event_file
*file
);
1660 struct event_trigger_ops
*(*get_trigger_ops
)(char *cmd
, char *param
);
1664 * enum event_command_flags - flags for struct event_command
1666 * @POST_TRIGGER: A flag that says whether or not this command needs
1667 * to have its action delayed until after the current event has
1668 * been closed. Some triggers need to avoid being invoked while
1669 * an event is currently in the process of being logged, since
1670 * the trigger may itself log data into the trace buffer. Thus
1671 * we make sure the current event is committed before invoking
1672 * those triggers. To do that, the trigger invocation is split
1673 * in two - the first part checks the filter using the current
1674 * trace record; if a command has the @post_trigger flag set, it
1675 * sets a bit for itself in the return value, otherwise it
1676 * directly invokes the trigger. Once all commands have been
1677 * either invoked or set their return flag, the current record is
1678 * either committed or discarded. At that point, if any commands
1679 * have deferred their triggers, those commands are finally
1680 * invoked following the close of the current event. In other
1681 * words, if the event_trigger_ops @func() probe implementation
1682 * itself logs to the trace buffer, this flag should be set,
1683 * otherwise it can be left unspecified.
1685 * @NEEDS_REC: A flag that says whether or not this command needs
1686 * access to the trace record in order to perform its function,
1687 * regardless of whether or not it has a filter associated with
1688 * it (filters make a trigger require access to the trace record
1689 * but are not always present).
1691 enum event_command_flags
{
1692 EVENT_CMD_FL_POST_TRIGGER
= 1,
1693 EVENT_CMD_FL_NEEDS_REC
= 2,
1696 static inline bool event_command_post_trigger(struct event_command
*cmd_ops
)
1698 return cmd_ops
->flags
& EVENT_CMD_FL_POST_TRIGGER
;
1701 static inline bool event_command_needs_rec(struct event_command
*cmd_ops
)
1703 return cmd_ops
->flags
& EVENT_CMD_FL_NEEDS_REC
;
1706 extern int trace_event_enable_disable(struct trace_event_file
*file
,
1707 int enable
, int soft_disable
);
1708 extern int tracing_alloc_snapshot(void);
1710 extern const char *__start___trace_bprintk_fmt
[];
1711 extern const char *__stop___trace_bprintk_fmt
[];
1713 extern const char *__start___tracepoint_str
[];
1714 extern const char *__stop___tracepoint_str
[];
1716 void trace_printk_control(bool enabled
);
1717 void trace_printk_init_buffers(void);
1718 void trace_printk_start_comm(void);
1719 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
);
1720 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
);
1723 * Normal trace_printk() and friends allocates special buffers
1724 * to do the manipulation, as well as saves the print formats
1725 * into sections to display. But the trace infrastructure wants
1726 * to use these without the added overhead at the price of being
1727 * a bit slower (used mainly for warnings, where we don't care
1728 * about performance). The internal_trace_puts() is for such
1731 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1734 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1735 extern struct trace_event_call \
1736 __aligned(4) event_##call;
1737 #undef FTRACE_ENTRY_DUP
1738 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1739 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1741 #undef FTRACE_ENTRY_PACKED
1742 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1743 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1746 #include "trace_entries.h"
1748 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1749 int perf_ftrace_event_register(struct trace_event_call
*call
,
1750 enum trace_reg type
, void *data
);
1752 #define perf_ftrace_event_register NULL
1755 #ifdef CONFIG_FTRACE_SYSCALLS
1756 void init_ftrace_syscalls(void);
1757 const char *get_syscall_name(int syscall
);
1759 static inline void init_ftrace_syscalls(void) { }
1760 static inline const char *get_syscall_name(int syscall
)
1766 #ifdef CONFIG_EVENT_TRACING
1767 void trace_event_init(void);
1768 void trace_event_enum_update(struct trace_enum_map
**map
, int len
);
1770 static inline void __init
trace_event_init(void) { }
1771 static inline void trace_event_enum_update(struct trace_enum_map
**map
, int len
) { }
1774 extern struct trace_iterator
*tracepoint_print_iter
;
1776 #endif /* _LINUX_KERNEL_TRACE_H */