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 /* function tracing enabled */
266 int function_enabled
;
271 TRACE_ARRAY_FL_GLOBAL
= (1 << 0)
274 extern struct list_head ftrace_trace_arrays
;
276 extern struct mutex trace_types_lock
;
278 extern int trace_array_get(struct trace_array
*tr
);
279 extern void trace_array_put(struct trace_array
*tr
);
282 * The global tracer (top) should be the first trace array added,
283 * but we check the flag anyway.
285 static inline struct trace_array
*top_trace_array(void)
287 struct trace_array
*tr
;
289 if (list_empty(&ftrace_trace_arrays
))
292 tr
= list_entry(ftrace_trace_arrays
.prev
,
294 WARN_ON(!(tr
->flags
& TRACE_ARRAY_FL_GLOBAL
));
298 #define FTRACE_CMP_TYPE(var, type) \
299 __builtin_types_compatible_p(typeof(var), type *)
302 #define IF_ASSIGN(var, entry, etype, id) \
303 if (FTRACE_CMP_TYPE(var, etype)) { \
304 var = (typeof(var))(entry); \
305 WARN_ON(id && (entry)->type != id); \
309 /* Will cause compile errors if type is not found. */
310 extern void __ftrace_bad_type(void);
313 * The trace_assign_type is a verifier that the entry type is
314 * the same as the type being assigned. To add new types simply
315 * add a line with the following format:
317 * IF_ASSIGN(var, ent, type, id);
319 * Where "type" is the trace type that includes the trace_entry
320 * as the "ent" item. And "id" is the trace identifier that is
321 * used in the trace_type enum.
323 * If the type can have more than one id, then use zero.
325 #define trace_assign_type(var, ent) \
327 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
328 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
329 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
330 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
331 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
332 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
333 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
334 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
335 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
336 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
338 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
340 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
341 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
343 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
345 __ftrace_bad_type(); \
349 * An option specific to a tracer. This is a boolean value.
350 * The bit is the bit index that sets its value on the
351 * flags value in struct tracer_flags.
354 const char *name
; /* Will appear on the trace_options file */
355 u32 bit
; /* Mask assigned in val field in tracer_flags */
359 * The set of specific options for a tracer. Your tracer
360 * have to set the initial value of the flags val.
362 struct tracer_flags
{
364 struct tracer_opt
*opts
;
365 struct tracer
*trace
;
368 /* Makes more easy to define a tracer opt */
369 #define TRACER_OPT(s, b) .name = #s, .bit = b
372 struct trace_option_dentry
{
373 struct tracer_opt
*opt
;
374 struct tracer_flags
*flags
;
375 struct trace_array
*tr
;
376 struct dentry
*entry
;
380 * struct tracer - a specific tracer and its callbacks to interact with tracefs
381 * @name: the name chosen to select it on the available_tracers file
382 * @init: called when one switches to this tracer (echo name > current_tracer)
383 * @reset: called when one switches to another tracer
384 * @start: called when tracing is unpaused (echo 1 > tracing_on)
385 * @stop: called when tracing is paused (echo 0 > tracing_on)
386 * @update_thresh: called when tracing_thresh is updated
387 * @open: called when the trace file is opened
388 * @pipe_open: called when the trace_pipe file is opened
389 * @close: called when the trace file is released
390 * @pipe_close: called when the trace_pipe file is released
391 * @read: override the default read callback on trace_pipe
392 * @splice_read: override the default splice_read callback on trace_pipe
393 * @selftest: selftest to run on boot (see trace_selftest.c)
394 * @print_headers: override the first lines that describe your columns
395 * @print_line: callback that prints a trace
396 * @set_flag: signals one of your private flags changed (trace_options file)
397 * @flags: your private flags
401 int (*init
)(struct trace_array
*tr
);
402 void (*reset
)(struct trace_array
*tr
);
403 void (*start
)(struct trace_array
*tr
);
404 void (*stop
)(struct trace_array
*tr
);
405 int (*update_thresh
)(struct trace_array
*tr
);
406 void (*open
)(struct trace_iterator
*iter
);
407 void (*pipe_open
)(struct trace_iterator
*iter
);
408 void (*close
)(struct trace_iterator
*iter
);
409 void (*pipe_close
)(struct trace_iterator
*iter
);
410 ssize_t (*read
)(struct trace_iterator
*iter
,
411 struct file
*filp
, char __user
*ubuf
,
412 size_t cnt
, loff_t
*ppos
);
413 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
416 struct pipe_inode_info
*pipe
,
419 #ifdef CONFIG_FTRACE_STARTUP_TEST
420 int (*selftest
)(struct tracer
*trace
,
421 struct trace_array
*tr
);
423 void (*print_header
)(struct seq_file
*m
);
424 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
425 /* If you handled the flag setting, return 0 */
426 int (*set_flag
)(struct trace_array
*tr
,
427 u32 old_flags
, u32 bit
, int set
);
428 /* Return 0 if OK with change, else return non-zero */
429 int (*flag_changed
)(struct trace_array
*tr
,
432 struct tracer_flags
*flags
;
436 bool allow_instances
;
437 #ifdef CONFIG_TRACER_MAX_TRACE
443 /* Only current can touch trace_recursion */
446 * For function tracing recursion:
447 * The order of these bits are important.
449 * When function tracing occurs, the following steps are made:
450 * If arch does not support a ftrace feature:
451 * call internal function (uses INTERNAL bits) which calls...
452 * If callback is registered to the "global" list, the list
453 * function is called and recursion checks the GLOBAL bits.
454 * then this function calls...
455 * The function callback, which can use the FTRACE bits to
456 * check for recursion.
458 * Now if the arch does not suppport a feature, and it calls
459 * the global list function which calls the ftrace callback
460 * all three of these steps will do a recursion protection.
461 * There's no reason to do one if the previous caller already
462 * did. The recursion that we are protecting against will
463 * go through the same steps again.
465 * To prevent the multiple recursion checks, if a recursion
466 * bit is set that is higher than the MAX bit of the current
467 * check, then we know that the check was made by the previous
468 * caller, and we can skip the current check.
472 TRACE_BUFFER_NMI_BIT
,
473 TRACE_BUFFER_IRQ_BIT
,
474 TRACE_BUFFER_SIRQ_BIT
,
476 /* Start of function recursion bits */
478 TRACE_FTRACE_NMI_BIT
,
479 TRACE_FTRACE_IRQ_BIT
,
480 TRACE_FTRACE_SIRQ_BIT
,
482 /* INTERNAL_BITs must be greater than FTRACE_BITs */
484 TRACE_INTERNAL_NMI_BIT
,
485 TRACE_INTERNAL_IRQ_BIT
,
486 TRACE_INTERNAL_SIRQ_BIT
,
490 * Abuse of the trace_recursion.
491 * As we need a way to maintain state if we are tracing the function
492 * graph in irq because we want to trace a particular function that
493 * was called in irq context but we have irq tracing off. Since this
494 * can only be modified by current, we can reuse trace_recursion.
499 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
500 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
501 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
503 #define TRACE_CONTEXT_BITS 4
505 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
506 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
508 #define TRACE_LIST_START TRACE_INTERNAL_BIT
509 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
511 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
513 static __always_inline
int trace_get_context_bit(void)
517 if (in_interrupt()) {
531 static __always_inline
int trace_test_and_set_recursion(int start
, int max
)
533 unsigned int val
= current
->trace_recursion
;
536 /* A previous recursion check was made */
537 if ((val
& TRACE_CONTEXT_MASK
) > max
)
540 bit
= trace_get_context_bit() + start
;
541 if (unlikely(val
& (1 << bit
)))
545 current
->trace_recursion
= val
;
551 static __always_inline
void trace_clear_recursion(int bit
)
553 unsigned int val
= current
->trace_recursion
;
562 current
->trace_recursion
= val
;
565 static inline struct ring_buffer_iter
*
566 trace_buffer_iter(struct trace_iterator
*iter
, int cpu
)
568 if (iter
->buffer_iter
&& iter
->buffer_iter
[cpu
])
569 return iter
->buffer_iter
[cpu
];
573 int tracer_init(struct tracer
*t
, struct trace_array
*tr
);
574 int tracing_is_enabled(void);
575 void tracing_reset(struct trace_buffer
*buf
, int cpu
);
576 void tracing_reset_online_cpus(struct trace_buffer
*buf
);
577 void tracing_reset_current(int cpu
);
578 void tracing_reset_all_online_cpus(void);
579 int tracing_open_generic(struct inode
*inode
, struct file
*filp
);
580 bool tracing_is_disabled(void);
581 int tracer_tracing_is_on(struct trace_array
*tr
);
582 struct dentry
*trace_create_file(const char *name
,
584 struct dentry
*parent
,
586 const struct file_operations
*fops
);
588 struct dentry
*tracing_init_dentry(void);
590 struct ring_buffer_event
;
592 struct ring_buffer_event
*
593 trace_buffer_lock_reserve(struct ring_buffer
*buffer
,
599 struct trace_entry
*tracing_get_trace_entry(struct trace_array
*tr
,
600 struct trace_array_cpu
*data
);
602 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
603 int *ent_cpu
, u64
*ent_ts
);
605 void trace_buffer_unlock_commit_nostack(struct ring_buffer
*buffer
,
606 struct ring_buffer_event
*event
);
608 int trace_empty(struct trace_iterator
*iter
);
610 void *trace_find_next_entry_inc(struct trace_iterator
*iter
);
612 void trace_init_global_iter(struct trace_iterator
*iter
);
614 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
);
616 void trace_function(struct trace_array
*tr
,
618 unsigned long parent_ip
,
619 unsigned long flags
, int pc
);
620 void trace_graph_function(struct trace_array
*tr
,
622 unsigned long parent_ip
,
623 unsigned long flags
, int pc
);
624 void trace_latency_header(struct seq_file
*m
);
625 void trace_default_header(struct seq_file
*m
);
626 void print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
);
627 int trace_empty(struct trace_iterator
*iter
);
629 void trace_graph_return(struct ftrace_graph_ret
*trace
);
630 int trace_graph_entry(struct ftrace_graph_ent
*trace
);
631 void set_graph_array(struct trace_array
*tr
);
633 void tracing_start_cmdline_record(void);
634 void tracing_stop_cmdline_record(void);
635 int register_tracer(struct tracer
*type
);
636 int is_tracing_stopped(void);
638 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
);
640 extern cpumask_var_t __read_mostly tracing_buffer_mask
;
642 #define for_each_tracing_cpu(cpu) \
643 for_each_cpu(cpu, tracing_buffer_mask)
645 extern unsigned long nsecs_to_usecs(unsigned long nsecs
);
647 extern unsigned long tracing_thresh
;
653 bool trace_find_filtered_pid(struct trace_pid_list
*filtered_pids
,
655 bool trace_ignore_this_task(struct trace_pid_list
*filtered_pids
,
656 struct task_struct
*task
);
657 void trace_filter_add_remove_task(struct trace_pid_list
*pid_list
,
658 struct task_struct
*self
,
659 struct task_struct
*task
);
660 void *trace_pid_next(struct trace_pid_list
*pid_list
, void *v
, loff_t
*pos
);
661 void *trace_pid_start(struct trace_pid_list
*pid_list
, loff_t
*pos
);
662 int trace_pid_show(struct seq_file
*m
, void *v
);
663 void trace_free_pid_list(struct trace_pid_list
*pid_list
);
664 int trace_pid_write(struct trace_pid_list
*filtered_pids
,
665 struct trace_pid_list
**new_pid_list
,
666 const char __user
*ubuf
, size_t cnt
);
668 #ifdef CONFIG_TRACER_MAX_TRACE
669 void update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
);
670 void update_max_tr_single(struct trace_array
*tr
,
671 struct task_struct
*tsk
, int cpu
);
672 #endif /* CONFIG_TRACER_MAX_TRACE */
674 #ifdef CONFIG_STACKTRACE
675 void ftrace_trace_userstack(struct ring_buffer
*buffer
, unsigned long flags
,
678 void __trace_stack(struct trace_array
*tr
, unsigned long flags
, int skip
,
681 static inline void ftrace_trace_userstack(struct ring_buffer
*buffer
,
682 unsigned long flags
, int pc
)
686 static inline void __trace_stack(struct trace_array
*tr
, unsigned long flags
,
690 #endif /* CONFIG_STACKTRACE */
692 extern u64
ftrace_now(int cpu
);
694 extern void trace_find_cmdline(int pid
, char comm
[]);
695 extern void trace_event_follow_fork(struct trace_array
*tr
, bool enable
);
697 #ifdef CONFIG_DYNAMIC_FTRACE
698 extern unsigned long ftrace_update_tot_cnt
;
700 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
701 extern int DYN_FTRACE_TEST_NAME(void);
702 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
703 extern int DYN_FTRACE_TEST_NAME2(void);
705 extern bool ring_buffer_expanded
;
706 extern bool tracing_selftest_disabled
;
708 #ifdef CONFIG_FTRACE_STARTUP_TEST
709 extern int trace_selftest_startup_function(struct tracer
*trace
,
710 struct trace_array
*tr
);
711 extern int trace_selftest_startup_function_graph(struct tracer
*trace
,
712 struct trace_array
*tr
);
713 extern int trace_selftest_startup_irqsoff(struct tracer
*trace
,
714 struct trace_array
*tr
);
715 extern int trace_selftest_startup_preemptoff(struct tracer
*trace
,
716 struct trace_array
*tr
);
717 extern int trace_selftest_startup_preemptirqsoff(struct tracer
*trace
,
718 struct trace_array
*tr
);
719 extern int trace_selftest_startup_wakeup(struct tracer
*trace
,
720 struct trace_array
*tr
);
721 extern int trace_selftest_startup_nop(struct tracer
*trace
,
722 struct trace_array
*tr
);
723 extern int trace_selftest_startup_sched_switch(struct tracer
*trace
,
724 struct trace_array
*tr
);
725 extern int trace_selftest_startup_branch(struct tracer
*trace
,
726 struct trace_array
*tr
);
728 * Tracer data references selftest functions that only occur
729 * on boot up. These can be __init functions. Thus, when selftests
730 * are enabled, then the tracers need to reference __init functions.
732 #define __tracer_data __refdata
734 /* Tracers are seldom changed. Optimize when selftests are disabled. */
735 #define __tracer_data __read_mostly
736 #endif /* CONFIG_FTRACE_STARTUP_TEST */
738 extern void *head_page(struct trace_array_cpu
*data
);
739 extern unsigned long long ns2usecs(u64 nsec
);
741 trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
);
743 trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
);
745 trace_array_vprintk(struct trace_array
*tr
,
746 unsigned long ip
, const char *fmt
, va_list args
);
747 int trace_array_printk(struct trace_array
*tr
,
748 unsigned long ip
, const char *fmt
, ...);
749 int trace_array_printk_buf(struct ring_buffer
*buffer
,
750 unsigned long ip
, const char *fmt
, ...);
751 void trace_printk_seq(struct trace_seq
*s
);
752 enum print_line_t
print_trace_line(struct trace_iterator
*iter
);
754 extern char trace_find_mark(unsigned long long duration
);
756 /* Standard output formatting function used for function return traces */
757 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
760 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
761 #define TRACE_GRAPH_PRINT_CPU 0x2
762 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
763 #define TRACE_GRAPH_PRINT_PROC 0x8
764 #define TRACE_GRAPH_PRINT_DURATION 0x10
765 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
766 #define TRACE_GRAPH_PRINT_IRQS 0x40
767 #define TRACE_GRAPH_PRINT_TAIL 0x80
768 #define TRACE_GRAPH_SLEEP_TIME 0x100
769 #define TRACE_GRAPH_GRAPH_TIME 0x200
770 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
771 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
773 extern void ftrace_graph_sleep_time_control(bool enable
);
774 extern void ftrace_graph_graph_time_control(bool enable
);
776 extern enum print_line_t
777 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
);
778 extern void print_graph_headers_flags(struct seq_file
*s
, u32 flags
);
780 trace_print_graph_duration(unsigned long long duration
, struct trace_seq
*s
);
781 extern void graph_trace_open(struct trace_iterator
*iter
);
782 extern void graph_trace_close(struct trace_iterator
*iter
);
783 extern int __trace_graph_entry(struct trace_array
*tr
,
784 struct ftrace_graph_ent
*trace
,
785 unsigned long flags
, int pc
);
786 extern void __trace_graph_return(struct trace_array
*tr
,
787 struct ftrace_graph_ret
*trace
,
788 unsigned long flags
, int pc
);
791 #ifdef CONFIG_DYNAMIC_FTRACE
792 /* TODO: make this variable */
793 #define FTRACE_GRAPH_MAX_FUNCS 32
794 extern int ftrace_graph_count
;
795 extern unsigned long ftrace_graph_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
796 extern int ftrace_graph_notrace_count
;
797 extern unsigned long ftrace_graph_notrace_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
799 static inline int ftrace_graph_addr(unsigned long addr
)
803 if (!ftrace_graph_count
)
806 for (i
= 0; i
< ftrace_graph_count
; i
++) {
807 if (addr
== ftrace_graph_funcs
[i
]) {
809 * If no irqs are to be traced, but a set_graph_function
810 * is set, and called by an interrupt handler, we still
814 trace_recursion_set(TRACE_IRQ_BIT
);
816 trace_recursion_clear(TRACE_IRQ_BIT
);
824 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
828 if (!ftrace_graph_notrace_count
)
831 for (i
= 0; i
< ftrace_graph_notrace_count
; i
++) {
832 if (addr
== ftrace_graph_notrace_funcs
[i
])
839 static inline int ftrace_graph_addr(unsigned long addr
)
844 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
848 #endif /* CONFIG_DYNAMIC_FTRACE */
850 extern unsigned int fgraph_max_depth
;
852 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent
*trace
)
854 /* trace it when it is-nested-in or is a function enabled. */
855 return !(trace
->depth
|| ftrace_graph_addr(trace
->func
)) ||
856 (trace
->depth
< 0) ||
857 (fgraph_max_depth
&& trace
->depth
>= fgraph_max_depth
);
860 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
861 static inline enum print_line_t
862 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
)
864 return TRACE_TYPE_UNHANDLED
;
866 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
868 extern struct list_head ftrace_pids
;
870 #ifdef CONFIG_FUNCTION_TRACER
871 extern bool ftrace_filter_param __initdata
;
872 static inline int ftrace_trace_task(struct trace_array
*tr
)
874 return !this_cpu_read(tr
->trace_buffer
.data
->ftrace_ignore_pid
);
876 extern int ftrace_is_dead(void);
877 int ftrace_create_function_files(struct trace_array
*tr
,
878 struct dentry
*parent
);
879 void ftrace_destroy_function_files(struct trace_array
*tr
);
880 void ftrace_init_global_array_ops(struct trace_array
*tr
);
881 void ftrace_init_array_ops(struct trace_array
*tr
, ftrace_func_t func
);
882 void ftrace_reset_array_ops(struct trace_array
*tr
);
883 int using_ftrace_ops_list_func(void);
884 void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
);
885 void ftrace_init_tracefs_toplevel(struct trace_array
*tr
,
886 struct dentry
*d_tracer
);
887 void ftrace_clear_pids(struct trace_array
*tr
);
889 static inline int ftrace_trace_task(struct trace_array
*tr
)
893 static inline int ftrace_is_dead(void) { return 0; }
895 ftrace_create_function_files(struct trace_array
*tr
,
896 struct dentry
*parent
)
900 static inline void ftrace_destroy_function_files(struct trace_array
*tr
) { }
901 static inline __init
void
902 ftrace_init_global_array_ops(struct trace_array
*tr
) { }
903 static inline void ftrace_reset_array_ops(struct trace_array
*tr
) { }
904 static inline void ftrace_init_tracefs(struct trace_array
*tr
, struct dentry
*d
) { }
905 static inline void ftrace_init_tracefs_toplevel(struct trace_array
*tr
, struct dentry
*d
) { }
906 static inline void ftrace_clear_pids(struct trace_array
*tr
) { }
907 /* ftace_func_t type is not defined, use macro instead of static inline */
908 #define ftrace_init_array_ops(tr, func) do { } while (0)
909 #endif /* CONFIG_FUNCTION_TRACER */
911 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
912 void ftrace_create_filter_files(struct ftrace_ops
*ops
,
913 struct dentry
*parent
);
914 void ftrace_destroy_filter_files(struct ftrace_ops
*ops
);
917 * The ops parameter passed in is usually undefined.
918 * This must be a macro.
920 #define ftrace_create_filter_files(ops, parent) do { } while (0)
921 #define ftrace_destroy_filter_files(ops) do { } while (0)
922 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
924 bool ftrace_event_is_function(struct trace_event_call
*call
);
927 * struct trace_parser - servers for reading the user input separated by spaces
928 * @cont: set if the input is not complete - no final space char was found
929 * @buffer: holds the parsed user input
930 * @idx: user input length
933 struct trace_parser
{
940 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
942 return (parser
->idx
!= 0);
945 static inline bool trace_parser_cont(struct trace_parser
*parser
)
950 static inline void trace_parser_clear(struct trace_parser
*parser
)
952 parser
->cont
= false;
956 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
957 extern void trace_parser_put(struct trace_parser
*parser
);
958 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
959 size_t cnt
, loff_t
*ppos
);
962 * Only create function graph options if function graph is configured.
964 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
965 # define FGRAPH_FLAGS \
966 C(DISPLAY_GRAPH, "display-graph"),
968 # define FGRAPH_FLAGS
971 #ifdef CONFIG_BRANCH_TRACER
972 # define BRANCH_FLAGS \
975 # define BRANCH_FLAGS
978 #ifdef CONFIG_FUNCTION_TRACER
979 # define FUNCTION_FLAGS \
980 C(FUNCTION, "function-trace"),
981 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
983 # define FUNCTION_FLAGS
984 # define FUNCTION_DEFAULT_FLAGS 0UL
987 #ifdef CONFIG_STACKTRACE
988 # define STACK_FLAGS \
989 C(STACKTRACE, "stacktrace"),
995 * trace_iterator_flags is an enumeration that defines bit
996 * positions into trace_flags that controls the output.
998 * NOTE: These bits must match the trace_options array in
999 * trace.c (this macro guarantees it).
1001 #define TRACE_FLAGS \
1002 C(PRINT_PARENT, "print-parent"), \
1003 C(SYM_OFFSET, "sym-offset"), \
1004 C(SYM_ADDR, "sym-addr"), \
1005 C(VERBOSE, "verbose"), \
1009 C(BLOCK, "block"), \
1010 C(PRINTK, "trace_printk"), \
1011 C(ANNOTATE, "annotate"), \
1012 C(USERSTACKTRACE, "userstacktrace"), \
1013 C(SYM_USEROBJ, "sym-userobj"), \
1014 C(PRINTK_MSGONLY, "printk-msg-only"), \
1015 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1016 C(LATENCY_FMT, "latency-format"), \
1017 C(RECORD_CMD, "record-cmd"), \
1018 C(OVERWRITE, "overwrite"), \
1019 C(STOP_ON_FREE, "disable_on_free"), \
1020 C(IRQ_INFO, "irq-info"), \
1021 C(MARKERS, "markers"), \
1022 C(EVENT_FORK, "event-fork"), \
1029 * By defining C, we can make TRACE_FLAGS a list of bit names
1030 * that will define the bits for the flag masks.
1033 #define C(a, b) TRACE_ITER_##a##_BIT
1035 enum trace_iterator_bits
{
1037 /* Make sure we don't go more than we have bits for */
1042 * By redefining C, we can make TRACE_FLAGS a list of masks that
1043 * use the bits as defined above.
1046 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1048 enum trace_iterator_flags
{ TRACE_FLAGS
};
1051 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1052 * control the output of kernel symbols.
1054 #define TRACE_ITER_SYM_MASK \
1055 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1057 extern struct tracer nop_trace
;
1059 #ifdef CONFIG_BRANCH_TRACER
1060 extern int enable_branch_tracing(struct trace_array
*tr
);
1061 extern void disable_branch_tracing(void);
1062 static inline int trace_branch_enable(struct trace_array
*tr
)
1064 if (tr
->trace_flags
& TRACE_ITER_BRANCH
)
1065 return enable_branch_tracing(tr
);
1068 static inline void trace_branch_disable(void)
1070 /* due to races, always disable */
1071 disable_branch_tracing();
1074 static inline int trace_branch_enable(struct trace_array
*tr
)
1078 static inline void trace_branch_disable(void)
1081 #endif /* CONFIG_BRANCH_TRACER */
1083 /* set ring buffers to default size if not already done so */
1084 int tracing_update_buffers(void);
1086 struct ftrace_event_field
{
1087 struct list_head link
;
1096 struct event_filter
{
1097 int n_preds
; /* Number assigned */
1098 int a_preds
; /* allocated */
1099 struct filter_pred
*preds
;
1100 struct filter_pred
*root
;
1101 char *filter_string
;
1104 struct event_subsystem
{
1105 struct list_head list
;
1107 struct event_filter
*filter
;
1111 struct trace_subsystem_dir
{
1112 struct list_head list
;
1113 struct event_subsystem
*subsystem
;
1114 struct trace_array
*tr
;
1115 struct dentry
*entry
;
1120 extern int call_filter_check_discard(struct trace_event_call
*call
, void *rec
,
1121 struct ring_buffer
*buffer
,
1122 struct ring_buffer_event
*event
);
1124 void trace_buffer_unlock_commit_regs(struct trace_array
*tr
,
1125 struct ring_buffer
*buffer
,
1126 struct ring_buffer_event
*event
,
1127 unsigned long flags
, int pc
,
1128 struct pt_regs
*regs
);
1130 static inline void trace_buffer_unlock_commit(struct trace_array
*tr
,
1131 struct ring_buffer
*buffer
,
1132 struct ring_buffer_event
*event
,
1133 unsigned long flags
, int pc
)
1135 trace_buffer_unlock_commit_regs(tr
, buffer
, event
, flags
, pc
, NULL
);
1138 DECLARE_PER_CPU(struct ring_buffer_event
*, trace_buffered_event
);
1139 DECLARE_PER_CPU(int, trace_buffered_event_cnt
);
1140 void trace_buffered_event_disable(void);
1141 void trace_buffered_event_enable(void);
1144 __trace_event_discard_commit(struct ring_buffer
*buffer
,
1145 struct ring_buffer_event
*event
)
1147 if (this_cpu_read(trace_buffered_event
) == event
) {
1148 /* Simply release the temp buffer */
1149 this_cpu_dec(trace_buffered_event_cnt
);
1152 ring_buffer_discard_commit(buffer
, event
);
1156 * Helper function for event_trigger_unlock_commit{_regs}().
1157 * If there are event triggers attached to this event that requires
1158 * filtering against its fields, then they wil be called as the
1159 * entry already holds the field information of the current event.
1161 * It also checks if the event should be discarded or not.
1162 * It is to be discarded if the event is soft disabled and the
1163 * event was only recorded to process triggers, or if the event
1164 * filter is active and this event did not match the filters.
1166 * Returns true if the event is discarded, false otherwise.
1169 __event_trigger_test_discard(struct trace_event_file
*file
,
1170 struct ring_buffer
*buffer
,
1171 struct ring_buffer_event
*event
,
1173 enum event_trigger_type
*tt
)
1175 unsigned long eflags
= file
->flags
;
1177 if (eflags
& EVENT_FILE_FL_TRIGGER_COND
)
1178 *tt
= event_triggers_call(file
, entry
);
1180 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT
, &file
->flags
) ||
1181 (unlikely(file
->flags
& EVENT_FILE_FL_FILTERED
) &&
1182 !filter_match_preds(file
->filter
, entry
))) {
1183 __trace_event_discard_commit(buffer
, event
);
1191 * event_trigger_unlock_commit - handle triggers and finish event commit
1192 * @file: The file pointer assoctiated to the event
1193 * @buffer: The ring buffer that the event is being written to
1194 * @event: The event meta data in the ring buffer
1195 * @entry: The event itself
1196 * @irq_flags: The state of the interrupts at the start of the event
1197 * @pc: The state of the preempt count at the start of the event.
1199 * This is a helper function to handle triggers that require data
1200 * from the event itself. It also tests the event against filters and
1201 * if the event is soft disabled and should be discarded.
1204 event_trigger_unlock_commit(struct trace_event_file
*file
,
1205 struct ring_buffer
*buffer
,
1206 struct ring_buffer_event
*event
,
1207 void *entry
, unsigned long irq_flags
, int pc
)
1209 enum event_trigger_type tt
= ETT_NONE
;
1211 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1212 trace_buffer_unlock_commit(file
->tr
, buffer
, event
, irq_flags
, pc
);
1215 event_triggers_post_call(file
, tt
, entry
);
1219 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1220 * @file: The file pointer assoctiated to the event
1221 * @buffer: The ring buffer that the event is being written to
1222 * @event: The event meta data in the ring buffer
1223 * @entry: The event itself
1224 * @irq_flags: The state of the interrupts at the start of the event
1225 * @pc: The state of the preempt count at the start of the event.
1227 * This is a helper function to handle triggers that require data
1228 * from the event itself. It also tests the event against filters and
1229 * if the event is soft disabled and should be discarded.
1231 * Same as event_trigger_unlock_commit() but calls
1232 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1235 event_trigger_unlock_commit_regs(struct trace_event_file
*file
,
1236 struct ring_buffer
*buffer
,
1237 struct ring_buffer_event
*event
,
1238 void *entry
, unsigned long irq_flags
, int pc
,
1239 struct pt_regs
*regs
)
1241 enum event_trigger_type tt
= ETT_NONE
;
1243 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
1244 trace_buffer_unlock_commit_regs(file
->tr
, buffer
, event
,
1245 irq_flags
, pc
, regs
);
1248 event_triggers_post_call(file
, tt
, entry
);
1251 #define FILTER_PRED_INVALID ((unsigned short)-1)
1252 #define FILTER_PRED_IS_RIGHT (1 << 15)
1253 #define FILTER_PRED_FOLD (1 << 15)
1256 * The max preds is the size of unsigned short with
1257 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1258 * and FOLD flags. The other is reserved.
1260 * 2^14 preds is way more than enough.
1262 #define MAX_FILTER_PRED 16384
1267 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
);
1269 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
1280 char pattern
[MAX_FILTER_STR_VAL
];
1283 regex_match_func match
;
1286 struct filter_pred
{
1287 filter_pred_fn_t fn
;
1290 unsigned short *ops
;
1291 struct ftrace_event_field
*field
;
1295 unsigned short index
;
1296 unsigned short parent
;
1297 unsigned short left
;
1298 unsigned short right
;
1301 static inline bool is_string_field(struct ftrace_event_field
*field
)
1303 return field
->filter_type
== FILTER_DYN_STRING
||
1304 field
->filter_type
== FILTER_STATIC_STRING
||
1305 field
->filter_type
== FILTER_PTR_STRING
;
1308 static inline bool is_function_field(struct ftrace_event_field
*field
)
1310 return field
->filter_type
== FILTER_TRACE_FN
;
1313 extern enum regex_type
1314 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
1315 extern void print_event_filter(struct trace_event_file
*file
,
1316 struct trace_seq
*s
);
1317 extern int apply_event_filter(struct trace_event_file
*file
,
1318 char *filter_string
);
1319 extern int apply_subsystem_event_filter(struct trace_subsystem_dir
*dir
,
1320 char *filter_string
);
1321 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
1322 struct trace_seq
*s
);
1323 extern int filter_assign_type(const char *type
);
1324 extern int create_event_filter(struct trace_event_call
*call
,
1325 char *filter_str
, bool set_str
,
1326 struct event_filter
**filterp
);
1327 extern void free_event_filter(struct event_filter
*filter
);
1329 struct ftrace_event_field
*
1330 trace_find_event_field(struct trace_event_call
*call
, char *name
);
1332 extern void trace_event_enable_cmd_record(bool enable
);
1333 extern int event_trace_add_tracer(struct dentry
*parent
, struct trace_array
*tr
);
1334 extern int event_trace_del_tracer(struct trace_array
*tr
);
1336 extern struct trace_event_file
*find_event_file(struct trace_array
*tr
,
1340 static inline void *event_file_data(struct file
*filp
)
1342 return ACCESS_ONCE(file_inode(filp
)->i_private
);
1345 extern struct mutex event_mutex
;
1346 extern struct list_head ftrace_events
;
1348 extern const struct file_operations event_trigger_fops
;
1349 extern const struct file_operations event_hist_fops
;
1351 #ifdef CONFIG_HIST_TRIGGERS
1352 extern int register_trigger_hist_cmd(void);
1353 extern int register_trigger_hist_enable_disable_cmds(void);
1355 static inline int register_trigger_hist_cmd(void) { return 0; }
1356 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1359 extern int register_trigger_cmds(void);
1360 extern void clear_event_triggers(struct trace_array
*tr
);
1362 struct event_trigger_data
{
1363 unsigned long count
;
1365 struct event_trigger_ops
*ops
;
1366 struct event_command
*cmd_ops
;
1367 struct event_filter __rcu
*filter
;
1372 struct list_head list
;
1374 struct list_head named_list
;
1375 struct event_trigger_data
*named_data
;
1379 #define ENABLE_EVENT_STR "enable_event"
1380 #define DISABLE_EVENT_STR "disable_event"
1381 #define ENABLE_HIST_STR "enable_hist"
1382 #define DISABLE_HIST_STR "disable_hist"
1384 struct enable_trigger_data
{
1385 struct trace_event_file
*file
;
1390 extern int event_enable_trigger_print(struct seq_file
*m
,
1391 struct event_trigger_ops
*ops
,
1392 struct event_trigger_data
*data
);
1393 extern void event_enable_trigger_free(struct event_trigger_ops
*ops
,
1394 struct event_trigger_data
*data
);
1395 extern int event_enable_trigger_func(struct event_command
*cmd_ops
,
1396 struct trace_event_file
*file
,
1397 char *glob
, char *cmd
, char *param
);
1398 extern int event_enable_register_trigger(char *glob
,
1399 struct event_trigger_ops
*ops
,
1400 struct event_trigger_data
*data
,
1401 struct trace_event_file
*file
);
1402 extern void event_enable_unregister_trigger(char *glob
,
1403 struct event_trigger_ops
*ops
,
1404 struct event_trigger_data
*test
,
1405 struct trace_event_file
*file
);
1406 extern void trigger_data_free(struct event_trigger_data
*data
);
1407 extern int event_trigger_init(struct event_trigger_ops
*ops
,
1408 struct event_trigger_data
*data
);
1409 extern int trace_event_trigger_enable_disable(struct trace_event_file
*file
,
1410 int trigger_enable
);
1411 extern void update_cond_flag(struct trace_event_file
*file
);
1412 extern void unregister_trigger(char *glob
, struct event_trigger_ops
*ops
,
1413 struct event_trigger_data
*test
,
1414 struct trace_event_file
*file
);
1415 extern int set_trigger_filter(char *filter_str
,
1416 struct event_trigger_data
*trigger_data
,
1417 struct trace_event_file
*file
);
1418 extern struct event_trigger_data
*find_named_trigger(const char *name
);
1419 extern bool is_named_trigger(struct event_trigger_data
*test
);
1420 extern int save_named_trigger(const char *name
,
1421 struct event_trigger_data
*data
);
1422 extern void del_named_trigger(struct event_trigger_data
*data
);
1423 extern void pause_named_trigger(struct event_trigger_data
*data
);
1424 extern void unpause_named_trigger(struct event_trigger_data
*data
);
1425 extern void set_named_trigger_data(struct event_trigger_data
*data
,
1426 struct event_trigger_data
*named_data
);
1427 extern int register_event_command(struct event_command
*cmd
);
1428 extern int unregister_event_command(struct event_command
*cmd
);
1429 extern int register_trigger_hist_enable_disable_cmds(void);
1432 * struct event_trigger_ops - callbacks for trace event triggers
1434 * The methods in this structure provide per-event trigger hooks for
1435 * various trigger operations.
1437 * All the methods below, except for @init() and @free(), must be
1440 * @func: The trigger 'probe' function called when the triggering
1441 * event occurs. The data passed into this callback is the data
1442 * that was supplied to the event_command @reg() function that
1443 * registered the trigger (see struct event_command) along with
1444 * the trace record, rec.
1446 * @init: An optional initialization function called for the trigger
1447 * when the trigger is registered (via the event_command reg()
1448 * function). This can be used to perform per-trigger
1449 * initialization such as incrementing a per-trigger reference
1450 * count, for instance. This is usually implemented by the
1451 * generic utility function @event_trigger_init() (see
1452 * trace_event_triggers.c).
1454 * @free: An optional de-initialization function called for the
1455 * trigger when the trigger is unregistered (via the
1456 * event_command @reg() function). This can be used to perform
1457 * per-trigger de-initialization such as decrementing a
1458 * per-trigger reference count and freeing corresponding trigger
1459 * data, for instance. This is usually implemented by the
1460 * generic utility function @event_trigger_free() (see
1461 * trace_event_triggers.c).
1463 * @print: The callback function invoked to have the trigger print
1464 * itself. This is usually implemented by a wrapper function
1465 * that calls the generic utility function @event_trigger_print()
1466 * (see trace_event_triggers.c).
1468 struct event_trigger_ops
{
1469 void (*func
)(struct event_trigger_data
*data
,
1471 int (*init
)(struct event_trigger_ops
*ops
,
1472 struct event_trigger_data
*data
);
1473 void (*free
)(struct event_trigger_ops
*ops
,
1474 struct event_trigger_data
*data
);
1475 int (*print
)(struct seq_file
*m
,
1476 struct event_trigger_ops
*ops
,
1477 struct event_trigger_data
*data
);
1481 * struct event_command - callbacks and data members for event commands
1483 * Event commands are invoked by users by writing the command name
1484 * into the 'trigger' file associated with a trace event. The
1485 * parameters associated with a specific invocation of an event
1486 * command are used to create an event trigger instance, which is
1487 * added to the list of trigger instances associated with that trace
1488 * event. When the event is hit, the set of triggers associated with
1489 * that event is invoked.
1491 * The data members in this structure provide per-event command data
1492 * for various event commands.
1494 * All the data members below, except for @post_trigger, must be set
1495 * for each event command.
1497 * @name: The unique name that identifies the event command. This is
1498 * the name used when setting triggers via trigger files.
1500 * @trigger_type: A unique id that identifies the event command
1501 * 'type'. This value has two purposes, the first to ensure that
1502 * only one trigger of the same type can be set at a given time
1503 * for a particular event e.g. it doesn't make sense to have both
1504 * a traceon and traceoff trigger attached to a single event at
1505 * the same time, so traceon and traceoff have the same type
1506 * though they have different names. The @trigger_type value is
1507 * also used as a bit value for deferring the actual trigger
1508 * action until after the current event is finished. Some
1509 * commands need to do this if they themselves log to the trace
1510 * buffer (see the @post_trigger() member below). @trigger_type
1511 * values are defined by adding new values to the trigger_type
1512 * enum in include/linux/trace_events.h.
1514 * @flags: See the enum event_command_flags below.
1516 * All the methods below, except for @set_filter() and @unreg_all(),
1517 * must be implemented.
1519 * @func: The callback function responsible for parsing and
1520 * registering the trigger written to the 'trigger' file by the
1521 * user. It allocates the trigger instance and registers it with
1522 * the appropriate trace event. It makes use of the other
1523 * event_command callback functions to orchestrate this, and is
1524 * usually implemented by the generic utility function
1525 * @event_trigger_callback() (see trace_event_triggers.c).
1527 * @reg: Adds the trigger to the list of triggers associated with the
1528 * event, and enables the event trigger itself, after
1529 * initializing it (via the event_trigger_ops @init() function).
1530 * This is also where commands can use the @trigger_type value to
1531 * make the decision as to whether or not multiple instances of
1532 * the trigger should be allowed. This is usually implemented by
1533 * the generic utility function @register_trigger() (see
1534 * trace_event_triggers.c).
1536 * @unreg: Removes the trigger from the list of triggers associated
1537 * with the event, and disables the event trigger itself, after
1538 * initializing it (via the event_trigger_ops @free() function).
1539 * This is usually implemented by the generic utility function
1540 * @unregister_trigger() (see trace_event_triggers.c).
1542 * @unreg_all: An optional function called to remove all the triggers
1543 * from the list of triggers associated with the event. Called
1544 * when a trigger file is opened in truncate mode.
1546 * @set_filter: An optional function called to parse and set a filter
1547 * for the trigger. If no @set_filter() method is set for the
1548 * event command, filters set by the user for the command will be
1549 * ignored. This is usually implemented by the generic utility
1550 * function @set_trigger_filter() (see trace_event_triggers.c).
1552 * @get_trigger_ops: The callback function invoked to retrieve the
1553 * event_trigger_ops implementation associated with the command.
1555 struct event_command
{
1556 struct list_head list
;
1558 enum event_trigger_type trigger_type
;
1560 int (*func
)(struct event_command
*cmd_ops
,
1561 struct trace_event_file
*file
,
1562 char *glob
, char *cmd
, char *params
);
1563 int (*reg
)(char *glob
,
1564 struct event_trigger_ops
*ops
,
1565 struct event_trigger_data
*data
,
1566 struct trace_event_file
*file
);
1567 void (*unreg
)(char *glob
,
1568 struct event_trigger_ops
*ops
,
1569 struct event_trigger_data
*data
,
1570 struct trace_event_file
*file
);
1571 void (*unreg_all
)(struct trace_event_file
*file
);
1572 int (*set_filter
)(char *filter_str
,
1573 struct event_trigger_data
*data
,
1574 struct trace_event_file
*file
);
1575 struct event_trigger_ops
*(*get_trigger_ops
)(char *cmd
, char *param
);
1579 * enum event_command_flags - flags for struct event_command
1581 * @POST_TRIGGER: A flag that says whether or not this command needs
1582 * to have its action delayed until after the current event has
1583 * been closed. Some triggers need to avoid being invoked while
1584 * an event is currently in the process of being logged, since
1585 * the trigger may itself log data into the trace buffer. Thus
1586 * we make sure the current event is committed before invoking
1587 * those triggers. To do that, the trigger invocation is split
1588 * in two - the first part checks the filter using the current
1589 * trace record; if a command has the @post_trigger flag set, it
1590 * sets a bit for itself in the return value, otherwise it
1591 * directly invokes the trigger. Once all commands have been
1592 * either invoked or set their return flag, the current record is
1593 * either committed or discarded. At that point, if any commands
1594 * have deferred their triggers, those commands are finally
1595 * invoked following the close of the current event. In other
1596 * words, if the event_trigger_ops @func() probe implementation
1597 * itself logs to the trace buffer, this flag should be set,
1598 * otherwise it can be left unspecified.
1600 * @NEEDS_REC: A flag that says whether or not this command needs
1601 * access to the trace record in order to perform its function,
1602 * regardless of whether or not it has a filter associated with
1603 * it (filters make a trigger require access to the trace record
1604 * but are not always present).
1606 enum event_command_flags
{
1607 EVENT_CMD_FL_POST_TRIGGER
= 1,
1608 EVENT_CMD_FL_NEEDS_REC
= 2,
1611 static inline bool event_command_post_trigger(struct event_command
*cmd_ops
)
1613 return cmd_ops
->flags
& EVENT_CMD_FL_POST_TRIGGER
;
1616 static inline bool event_command_needs_rec(struct event_command
*cmd_ops
)
1618 return cmd_ops
->flags
& EVENT_CMD_FL_NEEDS_REC
;
1621 extern int trace_event_enable_disable(struct trace_event_file
*file
,
1622 int enable
, int soft_disable
);
1623 extern int tracing_alloc_snapshot(void);
1625 extern const char *__start___trace_bprintk_fmt
[];
1626 extern const char *__stop___trace_bprintk_fmt
[];
1628 extern const char *__start___tracepoint_str
[];
1629 extern const char *__stop___tracepoint_str
[];
1631 void trace_printk_control(bool enabled
);
1632 void trace_printk_init_buffers(void);
1633 void trace_printk_start_comm(void);
1634 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
);
1635 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
);
1638 * Normal trace_printk() and friends allocates special buffers
1639 * to do the manipulation, as well as saves the print formats
1640 * into sections to display. But the trace infrastructure wants
1641 * to use these without the added overhead at the price of being
1642 * a bit slower (used mainly for warnings, where we don't care
1643 * about performance). The internal_trace_puts() is for such
1646 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1649 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1650 extern struct trace_event_call \
1651 __aligned(4) event_##call;
1652 #undef FTRACE_ENTRY_DUP
1653 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1654 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1656 #undef FTRACE_ENTRY_PACKED
1657 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1658 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1661 #include "trace_entries.h"
1663 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1664 int perf_ftrace_event_register(struct trace_event_call
*call
,
1665 enum trace_reg type
, void *data
);
1667 #define perf_ftrace_event_register NULL
1670 #ifdef CONFIG_FTRACE_SYSCALLS
1671 void init_ftrace_syscalls(void);
1672 const char *get_syscall_name(int syscall
);
1674 static inline void init_ftrace_syscalls(void) { }
1675 static inline const char *get_syscall_name(int syscall
)
1681 #ifdef CONFIG_EVENT_TRACING
1682 void trace_event_init(void);
1683 void trace_event_enum_update(struct trace_enum_map
**map
, int len
);
1685 static inline void __init
trace_event_init(void) { }
1686 static inline void trace_event_enum_update(struct trace_enum_map
**map
, int len
) { }
1689 extern struct trace_iterator
*tracepoint_print_iter
;
1691 #endif /* _LINUX_KERNEL_TRACE_H */