1 // SPDX-License-Identifier: GPL-2.0
3 * ring buffer based function tracer
5 * Copyright (C) 2007-2012 Steven Rostedt <srostedt@redhat.com>
6 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
8 * Originally taken from the RT patch by:
9 * Arnaldo Carvalho de Melo <acme@redhat.com>
11 * Based on code from the latency_tracer, that is:
12 * Copyright (C) 2004-2006 Ingo Molnar
13 * Copyright (C) 2004 Nadia Yvette Chambers
15 #include <linux/ring_buffer.h>
16 #include <linux/utsname.h>
17 #include <linux/stacktrace.h>
18 #include <linux/writeback.h>
19 #include <linux/kallsyms.h>
20 #include <linux/security.h>
21 #include <linux/seq_file.h>
22 #include <linux/irqflags.h>
23 #include <linux/debugfs.h>
24 #include <linux/tracefs.h>
25 #include <linux/pagemap.h>
26 #include <linux/hardirq.h>
27 #include <linux/linkage.h>
28 #include <linux/uaccess.h>
29 #include <linux/vmalloc.h>
30 #include <linux/ftrace.h>
31 #include <linux/module.h>
32 #include <linux/percpu.h>
33 #include <linux/splice.h>
34 #include <linux/kdebug.h>
35 #include <linux/string.h>
36 #include <linux/mount.h>
37 #include <linux/rwsem.h>
38 #include <linux/slab.h>
39 #include <linux/ctype.h>
40 #include <linux/init.h>
41 #include <linux/panic_notifier.h>
42 #include <linux/poll.h>
43 #include <linux/nmi.h>
45 #include <linux/trace.h>
46 #include <linux/sched/clock.h>
47 #include <linux/sched/rt.h>
48 #include <linux/fsnotify.h>
49 #include <linux/irq_work.h>
50 #include <linux/workqueue.h>
52 #include <asm/setup.h> /* COMMAND_LINE_SIZE */
55 #include "trace_output.h"
57 #ifdef CONFIG_FTRACE_STARTUP_TEST
59 * We need to change this state when a selftest is running.
60 * A selftest will lurk into the ring-buffer to count the
61 * entries inserted during the selftest although some concurrent
62 * insertions into the ring-buffer such as trace_printk could occurred
63 * at the same time, giving false positive or negative results.
65 static bool __read_mostly tracing_selftest_running
;
68 * If boot-time tracing including tracers/events via kernel cmdline
69 * is running, we do not want to run SELFTEST.
71 bool __read_mostly tracing_selftest_disabled
;
73 void __init
disable_tracing_selftest(const char *reason
)
75 if (!tracing_selftest_disabled
) {
76 tracing_selftest_disabled
= true;
77 pr_info("Ftrace startup test is disabled due to %s\n", reason
);
81 #define tracing_selftest_running 0
82 #define tracing_selftest_disabled 0
85 /* Pipe tracepoints to printk */
86 static struct trace_iterator
*tracepoint_print_iter
;
87 int tracepoint_printk
;
88 static bool tracepoint_printk_stop_on_boot __initdata
;
89 static DEFINE_STATIC_KEY_FALSE(tracepoint_printk_key
);
91 /* For tracers that don't implement custom flags */
92 static struct tracer_opt dummy_tracer_opt
[] = {
97 dummy_set_flag(struct trace_array
*tr
, u32 old_flags
, u32 bit
, int set
)
103 * To prevent the comm cache from being overwritten when no
104 * tracing is active, only save the comm when a trace event
107 DEFINE_PER_CPU(bool, trace_taskinfo_save
);
110 * Kill all tracing for good (never come back).
111 * It is initialized to 1 but will turn to zero if the initialization
112 * of the tracer is successful. But that is the only place that sets
115 static int tracing_disabled
= 1;
117 cpumask_var_t __read_mostly tracing_buffer_mask
;
120 * ftrace_dump_on_oops - variable to dump ftrace buffer on oops
122 * If there is an oops (or kernel panic) and the ftrace_dump_on_oops
123 * is set, then ftrace_dump is called. This will output the contents
124 * of the ftrace buffers to the console. This is very useful for
125 * capturing traces that lead to crashes and outputing it to a
128 * It is default off, but you can enable it with either specifying
129 * "ftrace_dump_on_oops" in the kernel command line, or setting
130 * /proc/sys/kernel/ftrace_dump_on_oops
131 * Set 1 if you want to dump buffers of all CPUs
132 * Set 2 if you want to dump the buffer of the CPU that triggered oops
133 * Set instance name if you want to dump the specific trace instance
134 * Multiple instance dump is also supported, and instances are seperated
137 /* Set to string format zero to disable by default */
138 char ftrace_dump_on_oops
[MAX_TRACER_SIZE
] = "0";
140 /* When set, tracing will stop when a WARN*() is hit */
141 int __disable_trace_on_warning
;
143 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
144 /* Map of enums to their values, for "eval_map" file */
145 struct trace_eval_map_head
{
147 unsigned long length
;
150 union trace_eval_map_item
;
152 struct trace_eval_map_tail
{
154 * "end" is first and points to NULL as it must be different
155 * than "mod" or "eval_string"
157 union trace_eval_map_item
*next
;
158 const char *end
; /* points to NULL */
161 static DEFINE_MUTEX(trace_eval_mutex
);
164 * The trace_eval_maps are saved in an array with two extra elements,
165 * one at the beginning, and one at the end. The beginning item contains
166 * the count of the saved maps (head.length), and the module they
167 * belong to if not built in (head.mod). The ending item contains a
168 * pointer to the next array of saved eval_map items.
170 union trace_eval_map_item
{
171 struct trace_eval_map map
;
172 struct trace_eval_map_head head
;
173 struct trace_eval_map_tail tail
;
176 static union trace_eval_map_item
*trace_eval_maps
;
177 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
179 int tracing_set_tracer(struct trace_array
*tr
, const char *buf
);
180 static void ftrace_trace_userstack(struct trace_array
*tr
,
181 struct trace_buffer
*buffer
,
182 unsigned int trace_ctx
);
184 static char bootup_tracer_buf
[MAX_TRACER_SIZE
] __initdata
;
185 static char *default_bootup_tracer
;
187 static bool allocate_snapshot
;
188 static bool snapshot_at_boot
;
190 static char boot_instance_info
[COMMAND_LINE_SIZE
] __initdata
;
191 static int boot_instance_index
;
193 static char boot_snapshot_info
[COMMAND_LINE_SIZE
] __initdata
;
194 static int boot_snapshot_index
;
196 static int __init
set_cmdline_ftrace(char *str
)
198 strscpy(bootup_tracer_buf
, str
, MAX_TRACER_SIZE
);
199 default_bootup_tracer
= bootup_tracer_buf
;
200 /* We are using ftrace early, expand it */
201 trace_set_ring_buffer_expanded(NULL
);
204 __setup("ftrace=", set_cmdline_ftrace
);
206 int ftrace_dump_on_oops_enabled(void)
208 if (!strcmp("0", ftrace_dump_on_oops
))
214 static int __init
set_ftrace_dump_on_oops(char *str
)
217 strscpy(ftrace_dump_on_oops
, "1", MAX_TRACER_SIZE
);
222 strscpy(ftrace_dump_on_oops
, "1", MAX_TRACER_SIZE
);
223 strscpy(ftrace_dump_on_oops
+ 1, str
, MAX_TRACER_SIZE
- 1);
228 strscpy(ftrace_dump_on_oops
, str
, MAX_TRACER_SIZE
);
234 __setup("ftrace_dump_on_oops", set_ftrace_dump_on_oops
);
236 static int __init
stop_trace_on_warning(char *str
)
238 if ((strcmp(str
, "=0") != 0 && strcmp(str
, "=off") != 0))
239 __disable_trace_on_warning
= 1;
242 __setup("traceoff_on_warning", stop_trace_on_warning
);
244 static int __init
boot_alloc_snapshot(char *str
)
246 char *slot
= boot_snapshot_info
+ boot_snapshot_index
;
247 int left
= sizeof(boot_snapshot_info
) - boot_snapshot_index
;
252 if (strlen(str
) >= left
)
255 ret
= snprintf(slot
, left
, "%s\t", str
);
256 boot_snapshot_index
+= ret
;
258 allocate_snapshot
= true;
259 /* We also need the main ring buffer expanded */
260 trace_set_ring_buffer_expanded(NULL
);
264 __setup("alloc_snapshot", boot_alloc_snapshot
);
267 static int __init
boot_snapshot(char *str
)
269 snapshot_at_boot
= true;
270 boot_alloc_snapshot(str
);
273 __setup("ftrace_boot_snapshot", boot_snapshot
);
276 static int __init
boot_instance(char *str
)
278 char *slot
= boot_instance_info
+ boot_instance_index
;
279 int left
= sizeof(boot_instance_info
) - boot_instance_index
;
282 if (strlen(str
) >= left
)
285 ret
= snprintf(slot
, left
, "%s\t", str
);
286 boot_instance_index
+= ret
;
290 __setup("trace_instance=", boot_instance
);
293 static char trace_boot_options_buf
[MAX_TRACER_SIZE
] __initdata
;
295 static int __init
set_trace_boot_options(char *str
)
297 strscpy(trace_boot_options_buf
, str
, MAX_TRACER_SIZE
);
300 __setup("trace_options=", set_trace_boot_options
);
302 static char trace_boot_clock_buf
[MAX_TRACER_SIZE
] __initdata
;
303 static char *trace_boot_clock __initdata
;
305 static int __init
set_trace_boot_clock(char *str
)
307 strscpy(trace_boot_clock_buf
, str
, MAX_TRACER_SIZE
);
308 trace_boot_clock
= trace_boot_clock_buf
;
311 __setup("trace_clock=", set_trace_boot_clock
);
313 static int __init
set_tracepoint_printk(char *str
)
315 /* Ignore the "tp_printk_stop_on_boot" param */
319 if ((strcmp(str
, "=0") != 0 && strcmp(str
, "=off") != 0))
320 tracepoint_printk
= 1;
323 __setup("tp_printk", set_tracepoint_printk
);
325 static int __init
set_tracepoint_printk_stop(char *str
)
327 tracepoint_printk_stop_on_boot
= true;
330 __setup("tp_printk_stop_on_boot", set_tracepoint_printk_stop
);
332 unsigned long long ns2usecs(u64 nsec
)
340 trace_process_export(struct trace_export
*export
,
341 struct ring_buffer_event
*event
, int flag
)
343 struct trace_entry
*entry
;
344 unsigned int size
= 0;
346 if (export
->flags
& flag
) {
347 entry
= ring_buffer_event_data(event
);
348 size
= ring_buffer_event_length(event
);
349 export
->write(export
, entry
, size
);
353 static DEFINE_MUTEX(ftrace_export_lock
);
355 static struct trace_export __rcu
*ftrace_exports_list __read_mostly
;
357 static DEFINE_STATIC_KEY_FALSE(trace_function_exports_enabled
);
358 static DEFINE_STATIC_KEY_FALSE(trace_event_exports_enabled
);
359 static DEFINE_STATIC_KEY_FALSE(trace_marker_exports_enabled
);
361 static inline void ftrace_exports_enable(struct trace_export
*export
)
363 if (export
->flags
& TRACE_EXPORT_FUNCTION
)
364 static_branch_inc(&trace_function_exports_enabled
);
366 if (export
->flags
& TRACE_EXPORT_EVENT
)
367 static_branch_inc(&trace_event_exports_enabled
);
369 if (export
->flags
& TRACE_EXPORT_MARKER
)
370 static_branch_inc(&trace_marker_exports_enabled
);
373 static inline void ftrace_exports_disable(struct trace_export
*export
)
375 if (export
->flags
& TRACE_EXPORT_FUNCTION
)
376 static_branch_dec(&trace_function_exports_enabled
);
378 if (export
->flags
& TRACE_EXPORT_EVENT
)
379 static_branch_dec(&trace_event_exports_enabled
);
381 if (export
->flags
& TRACE_EXPORT_MARKER
)
382 static_branch_dec(&trace_marker_exports_enabled
);
385 static void ftrace_exports(struct ring_buffer_event
*event
, int flag
)
387 struct trace_export
*export
;
389 preempt_disable_notrace();
391 export
= rcu_dereference_raw_check(ftrace_exports_list
);
393 trace_process_export(export
, event
, flag
);
394 export
= rcu_dereference_raw_check(export
->next
);
397 preempt_enable_notrace();
401 add_trace_export(struct trace_export
**list
, struct trace_export
*export
)
403 rcu_assign_pointer(export
->next
, *list
);
405 * We are entering export into the list but another
406 * CPU might be walking that list. We need to make sure
407 * the export->next pointer is valid before another CPU sees
408 * the export pointer included into the list.
410 rcu_assign_pointer(*list
, export
);
414 rm_trace_export(struct trace_export
**list
, struct trace_export
*export
)
416 struct trace_export
**p
;
418 for (p
= list
; *p
!= NULL
; p
= &(*p
)->next
)
425 rcu_assign_pointer(*p
, (*p
)->next
);
431 add_ftrace_export(struct trace_export
**list
, struct trace_export
*export
)
433 ftrace_exports_enable(export
);
435 add_trace_export(list
, export
);
439 rm_ftrace_export(struct trace_export
**list
, struct trace_export
*export
)
443 ret
= rm_trace_export(list
, export
);
444 ftrace_exports_disable(export
);
449 int register_ftrace_export(struct trace_export
*export
)
451 if (WARN_ON_ONCE(!export
->write
))
454 mutex_lock(&ftrace_export_lock
);
456 add_ftrace_export(&ftrace_exports_list
, export
);
458 mutex_unlock(&ftrace_export_lock
);
462 EXPORT_SYMBOL_GPL(register_ftrace_export
);
464 int unregister_ftrace_export(struct trace_export
*export
)
468 mutex_lock(&ftrace_export_lock
);
470 ret
= rm_ftrace_export(&ftrace_exports_list
, export
);
472 mutex_unlock(&ftrace_export_lock
);
476 EXPORT_SYMBOL_GPL(unregister_ftrace_export
);
478 /* trace_flags holds trace_options default values */
479 #define TRACE_DEFAULT_FLAGS \
480 (FUNCTION_DEFAULT_FLAGS | \
481 TRACE_ITER_PRINT_PARENT | TRACE_ITER_PRINTK | \
482 TRACE_ITER_ANNOTATE | TRACE_ITER_CONTEXT_INFO | \
483 TRACE_ITER_RECORD_CMD | TRACE_ITER_OVERWRITE | \
484 TRACE_ITER_IRQ_INFO | TRACE_ITER_MARKERS | \
485 TRACE_ITER_HASH_PTR | TRACE_ITER_TRACE_PRINTK)
487 /* trace_options that are only supported by global_trace */
488 #define TOP_LEVEL_TRACE_FLAGS (TRACE_ITER_PRINTK | \
489 TRACE_ITER_PRINTK_MSGONLY | TRACE_ITER_RECORD_CMD)
491 /* trace_flags that are default zero for instances */
492 #define ZEROED_TRACE_FLAGS \
493 (TRACE_ITER_EVENT_FORK | TRACE_ITER_FUNC_FORK | TRACE_ITER_TRACE_PRINTK)
496 * The global_trace is the descriptor that holds the top-level tracing
497 * buffers for the live tracing.
499 static struct trace_array global_trace
= {
500 .trace_flags
= TRACE_DEFAULT_FLAGS
,
503 static struct trace_array
*printk_trace
= &global_trace
;
505 static __always_inline
bool printk_binsafe(struct trace_array
*tr
)
508 * The binary format of traceprintk can cause a crash if used
509 * by a buffer from another boot. Force the use of the
510 * non binary version of trace_printk if the trace_printk
511 * buffer is a boot mapped ring buffer.
513 return !(tr
->flags
& TRACE_ARRAY_FL_BOOT
);
516 static void update_printk_trace(struct trace_array
*tr
)
518 if (printk_trace
== tr
)
521 printk_trace
->trace_flags
&= ~TRACE_ITER_TRACE_PRINTK
;
523 tr
->trace_flags
|= TRACE_ITER_TRACE_PRINTK
;
526 void trace_set_ring_buffer_expanded(struct trace_array
*tr
)
530 tr
->ring_buffer_expanded
= true;
533 LIST_HEAD(ftrace_trace_arrays
);
535 int trace_array_get(struct trace_array
*this_tr
)
537 struct trace_array
*tr
;
540 mutex_lock(&trace_types_lock
);
541 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
548 mutex_unlock(&trace_types_lock
);
553 static void __trace_array_put(struct trace_array
*this_tr
)
555 WARN_ON(!this_tr
->ref
);
560 * trace_array_put - Decrement the reference counter for this trace array.
561 * @this_tr : pointer to the trace array
563 * NOTE: Use this when we no longer need the trace array returned by
564 * trace_array_get_by_name(). This ensures the trace array can be later
568 void trace_array_put(struct trace_array
*this_tr
)
573 mutex_lock(&trace_types_lock
);
574 __trace_array_put(this_tr
);
575 mutex_unlock(&trace_types_lock
);
577 EXPORT_SYMBOL_GPL(trace_array_put
);
579 int tracing_check_open_get_tr(struct trace_array
*tr
)
583 ret
= security_locked_down(LOCKDOWN_TRACEFS
);
587 if (tracing_disabled
)
590 if (tr
&& trace_array_get(tr
) < 0)
597 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
598 * @filtered_pids: The list of pids to check
599 * @search_pid: The PID to find in @filtered_pids
601 * Returns true if @search_pid is found in @filtered_pids, and false otherwise.
604 trace_find_filtered_pid(struct trace_pid_list
*filtered_pids
, pid_t search_pid
)
606 return trace_pid_list_is_set(filtered_pids
, search_pid
);
610 * trace_ignore_this_task - should a task be ignored for tracing
611 * @filtered_pids: The list of pids to check
612 * @filtered_no_pids: The list of pids not to be traced
613 * @task: The task that should be ignored if not filtered
615 * Checks if @task should be traced or not from @filtered_pids.
616 * Returns true if @task should *NOT* be traced.
617 * Returns false if @task should be traced.
620 trace_ignore_this_task(struct trace_pid_list
*filtered_pids
,
621 struct trace_pid_list
*filtered_no_pids
,
622 struct task_struct
*task
)
625 * If filtered_no_pids is not empty, and the task's pid is listed
626 * in filtered_no_pids, then return true.
627 * Otherwise, if filtered_pids is empty, that means we can
628 * trace all tasks. If it has content, then only trace pids
629 * within filtered_pids.
632 return (filtered_pids
&&
633 !trace_find_filtered_pid(filtered_pids
, task
->pid
)) ||
635 trace_find_filtered_pid(filtered_no_pids
, task
->pid
));
639 * trace_filter_add_remove_task - Add or remove a task from a pid_list
640 * @pid_list: The list to modify
641 * @self: The current task for fork or NULL for exit
642 * @task: The task to add or remove
644 * If adding a task, if @self is defined, the task is only added if @self
645 * is also included in @pid_list. This happens on fork and tasks should
646 * only be added when the parent is listed. If @self is NULL, then the
647 * @task pid will be removed from the list, which would happen on exit
650 void trace_filter_add_remove_task(struct trace_pid_list
*pid_list
,
651 struct task_struct
*self
,
652 struct task_struct
*task
)
657 /* For forks, we only add if the forking task is listed */
659 if (!trace_find_filtered_pid(pid_list
, self
->pid
))
663 /* "self" is set for forks, and NULL for exits */
665 trace_pid_list_set(pid_list
, task
->pid
);
667 trace_pid_list_clear(pid_list
, task
->pid
);
671 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
672 * @pid_list: The pid list to show
673 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
674 * @pos: The position of the file
676 * This is used by the seq_file "next" operation to iterate the pids
677 * listed in a trace_pid_list structure.
679 * Returns the pid+1 as we want to display pid of zero, but NULL would
680 * stop the iteration.
682 void *trace_pid_next(struct trace_pid_list
*pid_list
, void *v
, loff_t
*pos
)
684 long pid
= (unsigned long)v
;
689 /* pid already is +1 of the actual previous bit */
690 if (trace_pid_list_next(pid_list
, pid
, &next
) < 0)
695 /* Return pid + 1 to allow zero to be represented */
696 return (void *)(pid
+ 1);
700 * trace_pid_start - Used for seq_file to start reading pid lists
701 * @pid_list: The pid list to show
702 * @pos: The position of the file
704 * This is used by seq_file "start" operation to start the iteration
707 * Returns the pid+1 as we want to display pid of zero, but NULL would
708 * stop the iteration.
710 void *trace_pid_start(struct trace_pid_list
*pid_list
, loff_t
*pos
)
716 if (trace_pid_list_first(pid_list
, &first
) < 0)
721 /* Return pid + 1 so that zero can be the exit value */
722 for (pid
++; pid
&& l
< *pos
;
723 pid
= (unsigned long)trace_pid_next(pid_list
, (void *)pid
, &l
))
729 * trace_pid_show - show the current pid in seq_file processing
730 * @m: The seq_file structure to write into
731 * @v: A void pointer of the pid (+1) value to display
733 * Can be directly used by seq_file operations to display the current
736 int trace_pid_show(struct seq_file
*m
, void *v
)
738 unsigned long pid
= (unsigned long)v
- 1;
740 seq_printf(m
, "%lu\n", pid
);
744 /* 128 should be much more than enough */
745 #define PID_BUF_SIZE 127
747 int trace_pid_write(struct trace_pid_list
*filtered_pids
,
748 struct trace_pid_list
**new_pid_list
,
749 const char __user
*ubuf
, size_t cnt
)
751 struct trace_pid_list
*pid_list
;
752 struct trace_parser parser
;
760 if (trace_parser_get_init(&parser
, PID_BUF_SIZE
+ 1))
764 * Always recreate a new array. The write is an all or nothing
765 * operation. Always create a new array when adding new pids by
766 * the user. If the operation fails, then the current list is
769 pid_list
= trace_pid_list_alloc();
771 trace_parser_put(&parser
);
776 /* copy the current bits to the new max */
777 ret
= trace_pid_list_first(filtered_pids
, &pid
);
779 trace_pid_list_set(pid_list
, pid
);
780 ret
= trace_pid_list_next(filtered_pids
, pid
+ 1, &pid
);
790 ret
= trace_get_user(&parser
, ubuf
, cnt
, &pos
);
798 if (!trace_parser_loaded(&parser
))
802 if (kstrtoul(parser
.buffer
, 0, &val
))
807 if (trace_pid_list_set(pid_list
, pid
) < 0) {
813 trace_parser_clear(&parser
);
816 trace_parser_put(&parser
);
819 trace_pid_list_free(pid_list
);
824 /* Cleared the list of pids */
825 trace_pid_list_free(pid_list
);
829 *new_pid_list
= pid_list
;
834 static u64
buffer_ftrace_now(struct array_buffer
*buf
, int cpu
)
838 /* Early boot up does not have a buffer yet */
840 return trace_clock_local();
842 ts
= ring_buffer_time_stamp(buf
->buffer
);
843 ring_buffer_normalize_time_stamp(buf
->buffer
, cpu
, &ts
);
848 u64
ftrace_now(int cpu
)
850 return buffer_ftrace_now(&global_trace
.array_buffer
, cpu
);
854 * tracing_is_enabled - Show if global_trace has been enabled
856 * Shows if the global trace has been enabled or not. It uses the
857 * mirror flag "buffer_disabled" to be used in fast paths such as for
858 * the irqsoff tracer. But it may be inaccurate due to races. If you
859 * need to know the accurate state, use tracing_is_on() which is a little
860 * slower, but accurate.
862 int tracing_is_enabled(void)
865 * For quick access (irqsoff uses this in fast path), just
866 * return the mirror variable of the state of the ring buffer.
867 * It's a little racy, but we don't really care.
870 return !global_trace
.buffer_disabled
;
874 * trace_buf_size is the size in bytes that is allocated
875 * for a buffer. Note, the number of bytes is always rounded
878 * This number is purposely set to a low number of 16384.
879 * If the dump on oops happens, it will be much appreciated
880 * to not have to wait for all that output. Anyway this can be
881 * boot time and run time configurable.
883 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
885 static unsigned long trace_buf_size
= TRACE_BUF_SIZE_DEFAULT
;
887 /* trace_types holds a link list of available tracers. */
888 static struct tracer
*trace_types __read_mostly
;
891 * trace_types_lock is used to protect the trace_types list.
893 DEFINE_MUTEX(trace_types_lock
);
896 * serialize the access of the ring buffer
898 * ring buffer serializes readers, but it is low level protection.
899 * The validity of the events (which returns by ring_buffer_peek() ..etc)
900 * are not protected by ring buffer.
902 * The content of events may become garbage if we allow other process consumes
903 * these events concurrently:
904 * A) the page of the consumed events may become a normal page
905 * (not reader page) in ring buffer, and this page will be rewritten
906 * by events producer.
907 * B) The page of the consumed events may become a page for splice_read,
908 * and this page will be returned to system.
910 * These primitives allow multi process access to different cpu ring buffer
913 * These primitives don't distinguish read-only and read-consume access.
914 * Multi read-only access are also serialized.
918 static DECLARE_RWSEM(all_cpu_access_lock
);
919 static DEFINE_PER_CPU(struct mutex
, cpu_access_lock
);
921 static inline void trace_access_lock(int cpu
)
923 if (cpu
== RING_BUFFER_ALL_CPUS
) {
924 /* gain it for accessing the whole ring buffer. */
925 down_write(&all_cpu_access_lock
);
927 /* gain it for accessing a cpu ring buffer. */
929 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
930 down_read(&all_cpu_access_lock
);
932 /* Secondly block other access to this @cpu ring buffer. */
933 mutex_lock(&per_cpu(cpu_access_lock
, cpu
));
937 static inline void trace_access_unlock(int cpu
)
939 if (cpu
== RING_BUFFER_ALL_CPUS
) {
940 up_write(&all_cpu_access_lock
);
942 mutex_unlock(&per_cpu(cpu_access_lock
, cpu
));
943 up_read(&all_cpu_access_lock
);
947 static inline void trace_access_lock_init(void)
951 for_each_possible_cpu(cpu
)
952 mutex_init(&per_cpu(cpu_access_lock
, cpu
));
957 static DEFINE_MUTEX(access_lock
);
959 static inline void trace_access_lock(int cpu
)
962 mutex_lock(&access_lock
);
965 static inline void trace_access_unlock(int cpu
)
968 mutex_unlock(&access_lock
);
971 static inline void trace_access_lock_init(void)
977 #ifdef CONFIG_STACKTRACE
978 static void __ftrace_trace_stack(struct trace_array
*tr
,
979 struct trace_buffer
*buffer
,
980 unsigned int trace_ctx
,
981 int skip
, struct pt_regs
*regs
);
982 static inline void ftrace_trace_stack(struct trace_array
*tr
,
983 struct trace_buffer
*buffer
,
984 unsigned int trace_ctx
,
985 int skip
, struct pt_regs
*regs
);
988 static inline void __ftrace_trace_stack(struct trace_array
*tr
,
989 struct trace_buffer
*buffer
,
990 unsigned int trace_ctx
,
991 int skip
, struct pt_regs
*regs
)
994 static inline void ftrace_trace_stack(struct trace_array
*tr
,
995 struct trace_buffer
*buffer
,
996 unsigned long trace_ctx
,
997 int skip
, struct pt_regs
*regs
)
1003 static __always_inline
void
1004 trace_event_setup(struct ring_buffer_event
*event
,
1005 int type
, unsigned int trace_ctx
)
1007 struct trace_entry
*ent
= ring_buffer_event_data(event
);
1009 tracing_generic_entry_update(ent
, type
, trace_ctx
);
1012 static __always_inline
struct ring_buffer_event
*
1013 __trace_buffer_lock_reserve(struct trace_buffer
*buffer
,
1016 unsigned int trace_ctx
)
1018 struct ring_buffer_event
*event
;
1020 event
= ring_buffer_lock_reserve(buffer
, len
);
1022 trace_event_setup(event
, type
, trace_ctx
);
1027 void tracer_tracing_on(struct trace_array
*tr
)
1029 if (tr
->array_buffer
.buffer
)
1030 ring_buffer_record_on(tr
->array_buffer
.buffer
);
1032 * This flag is looked at when buffers haven't been allocated
1033 * yet, or by some tracers (like irqsoff), that just want to
1034 * know if the ring buffer has been disabled, but it can handle
1035 * races of where it gets disabled but we still do a record.
1036 * As the check is in the fast path of the tracers, it is more
1037 * important to be fast than accurate.
1039 tr
->buffer_disabled
= 0;
1040 /* Make the flag seen by readers */
1045 * tracing_on - enable tracing buffers
1047 * This function enables tracing buffers that may have been
1048 * disabled with tracing_off.
1050 void tracing_on(void)
1052 tracer_tracing_on(&global_trace
);
1054 EXPORT_SYMBOL_GPL(tracing_on
);
1057 static __always_inline
void
1058 __buffer_unlock_commit(struct trace_buffer
*buffer
, struct ring_buffer_event
*event
)
1060 __this_cpu_write(trace_taskinfo_save
, true);
1062 /* If this is the temp buffer, we need to commit fully */
1063 if (this_cpu_read(trace_buffered_event
) == event
) {
1064 /* Length is in event->array[0] */
1065 ring_buffer_write(buffer
, event
->array
[0], &event
->array
[1]);
1066 /* Release the temp buffer */
1067 this_cpu_dec(trace_buffered_event_cnt
);
1068 /* ring_buffer_unlock_commit() enables preemption */
1069 preempt_enable_notrace();
1071 ring_buffer_unlock_commit(buffer
);
1074 int __trace_array_puts(struct trace_array
*tr
, unsigned long ip
,
1075 const char *str
, int size
)
1077 struct ring_buffer_event
*event
;
1078 struct trace_buffer
*buffer
;
1079 struct print_entry
*entry
;
1080 unsigned int trace_ctx
;
1083 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
1086 if (unlikely(tracing_selftest_running
&& tr
== &global_trace
))
1089 if (unlikely(tracing_disabled
))
1092 alloc
= sizeof(*entry
) + size
+ 2; /* possible \n added */
1094 trace_ctx
= tracing_gen_ctx();
1095 buffer
= tr
->array_buffer
.buffer
;
1096 ring_buffer_nest_start(buffer
);
1097 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, alloc
,
1104 entry
= ring_buffer_event_data(event
);
1107 memcpy(&entry
->buf
, str
, size
);
1109 /* Add a newline if necessary */
1110 if (entry
->buf
[size
- 1] != '\n') {
1111 entry
->buf
[size
] = '\n';
1112 entry
->buf
[size
+ 1] = '\0';
1114 entry
->buf
[size
] = '\0';
1116 __buffer_unlock_commit(buffer
, event
);
1117 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 4, NULL
);
1119 ring_buffer_nest_end(buffer
);
1122 EXPORT_SYMBOL_GPL(__trace_array_puts
);
1125 * __trace_puts - write a constant string into the trace buffer.
1126 * @ip: The address of the caller
1127 * @str: The constant string to write
1128 * @size: The size of the string.
1130 int __trace_puts(unsigned long ip
, const char *str
, int size
)
1132 return __trace_array_puts(printk_trace
, ip
, str
, size
);
1134 EXPORT_SYMBOL_GPL(__trace_puts
);
1137 * __trace_bputs - write the pointer to a constant string into trace buffer
1138 * @ip: The address of the caller
1139 * @str: The constant string to write to the buffer to
1141 int __trace_bputs(unsigned long ip
, const char *str
)
1143 struct trace_array
*tr
= READ_ONCE(printk_trace
);
1144 struct ring_buffer_event
*event
;
1145 struct trace_buffer
*buffer
;
1146 struct bputs_entry
*entry
;
1147 unsigned int trace_ctx
;
1148 int size
= sizeof(struct bputs_entry
);
1151 if (!printk_binsafe(tr
))
1152 return __trace_puts(ip
, str
, strlen(str
));
1154 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
1157 if (unlikely(tracing_selftest_running
|| tracing_disabled
))
1160 trace_ctx
= tracing_gen_ctx();
1161 buffer
= tr
->array_buffer
.buffer
;
1163 ring_buffer_nest_start(buffer
);
1164 event
= __trace_buffer_lock_reserve(buffer
, TRACE_BPUTS
, size
,
1169 entry
= ring_buffer_event_data(event
);
1173 __buffer_unlock_commit(buffer
, event
);
1174 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 4, NULL
);
1178 ring_buffer_nest_end(buffer
);
1181 EXPORT_SYMBOL_GPL(__trace_bputs
);
1183 #ifdef CONFIG_TRACER_SNAPSHOT
1184 static void tracing_snapshot_instance_cond(struct trace_array
*tr
,
1187 struct tracer
*tracer
= tr
->current_trace
;
1188 unsigned long flags
;
1191 trace_array_puts(tr
, "*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
1192 trace_array_puts(tr
, "*** snapshot is being ignored ***\n");
1196 if (!tr
->allocated_snapshot
) {
1197 trace_array_puts(tr
, "*** SNAPSHOT NOT ALLOCATED ***\n");
1198 trace_array_puts(tr
, "*** stopping trace here! ***\n");
1199 tracer_tracing_off(tr
);
1203 /* Note, snapshot can not be used when the tracer uses it */
1204 if (tracer
->use_max_tr
) {
1205 trace_array_puts(tr
, "*** LATENCY TRACER ACTIVE ***\n");
1206 trace_array_puts(tr
, "*** Can not use snapshot (sorry) ***\n");
1211 trace_array_puts(tr
, "*** BUFFER MEMORY MAPPED ***\n");
1212 trace_array_puts(tr
, "*** Can not use snapshot (sorry) ***\n");
1216 local_irq_save(flags
);
1217 update_max_tr(tr
, current
, smp_processor_id(), cond_data
);
1218 local_irq_restore(flags
);
1221 void tracing_snapshot_instance(struct trace_array
*tr
)
1223 tracing_snapshot_instance_cond(tr
, NULL
);
1227 * tracing_snapshot - take a snapshot of the current buffer.
1229 * This causes a swap between the snapshot buffer and the current live
1230 * tracing buffer. You can use this to take snapshots of the live
1231 * trace when some condition is triggered, but continue to trace.
1233 * Note, make sure to allocate the snapshot with either
1234 * a tracing_snapshot_alloc(), or by doing it manually
1235 * with: echo 1 > /sys/kernel/tracing/snapshot
1237 * If the snapshot buffer is not allocated, it will stop tracing.
1238 * Basically making a permanent snapshot.
1240 void tracing_snapshot(void)
1242 struct trace_array
*tr
= &global_trace
;
1244 tracing_snapshot_instance(tr
);
1246 EXPORT_SYMBOL_GPL(tracing_snapshot
);
1249 * tracing_snapshot_cond - conditionally take a snapshot of the current buffer.
1250 * @tr: The tracing instance to snapshot
1251 * @cond_data: The data to be tested conditionally, and possibly saved
1253 * This is the same as tracing_snapshot() except that the snapshot is
1254 * conditional - the snapshot will only happen if the
1255 * cond_snapshot.update() implementation receiving the cond_data
1256 * returns true, which means that the trace array's cond_snapshot
1257 * update() operation used the cond_data to determine whether the
1258 * snapshot should be taken, and if it was, presumably saved it along
1259 * with the snapshot.
1261 void tracing_snapshot_cond(struct trace_array
*tr
, void *cond_data
)
1263 tracing_snapshot_instance_cond(tr
, cond_data
);
1265 EXPORT_SYMBOL_GPL(tracing_snapshot_cond
);
1268 * tracing_cond_snapshot_data - get the user data associated with a snapshot
1269 * @tr: The tracing instance
1271 * When the user enables a conditional snapshot using
1272 * tracing_snapshot_cond_enable(), the user-defined cond_data is saved
1273 * with the snapshot. This accessor is used to retrieve it.
1275 * Should not be called from cond_snapshot.update(), since it takes
1276 * the tr->max_lock lock, which the code calling
1277 * cond_snapshot.update() has already done.
1279 * Returns the cond_data associated with the trace array's snapshot.
1281 void *tracing_cond_snapshot_data(struct trace_array
*tr
)
1283 void *cond_data
= NULL
;
1285 local_irq_disable();
1286 arch_spin_lock(&tr
->max_lock
);
1288 if (tr
->cond_snapshot
)
1289 cond_data
= tr
->cond_snapshot
->cond_data
;
1291 arch_spin_unlock(&tr
->max_lock
);
1296 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data
);
1298 static int resize_buffer_duplicate_size(struct array_buffer
*trace_buf
,
1299 struct array_buffer
*size_buf
, int cpu_id
);
1300 static void set_buffer_entries(struct array_buffer
*buf
, unsigned long val
);
1302 int tracing_alloc_snapshot_instance(struct trace_array
*tr
)
1307 if (!tr
->allocated_snapshot
) {
1309 /* Make the snapshot buffer have the same order as main buffer */
1310 order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
1311 ret
= ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, order
);
1315 /* allocate spare buffer */
1316 ret
= resize_buffer_duplicate_size(&tr
->max_buffer
,
1317 &tr
->array_buffer
, RING_BUFFER_ALL_CPUS
);
1321 tr
->allocated_snapshot
= true;
1327 static void free_snapshot(struct trace_array
*tr
)
1330 * We don't free the ring buffer. instead, resize it because
1331 * The max_tr ring buffer has some state (e.g. ring->clock) and
1332 * we want preserve it.
1334 ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, 0);
1335 ring_buffer_resize(tr
->max_buffer
.buffer
, 1, RING_BUFFER_ALL_CPUS
);
1336 set_buffer_entries(&tr
->max_buffer
, 1);
1337 tracing_reset_online_cpus(&tr
->max_buffer
);
1338 tr
->allocated_snapshot
= false;
1341 static int tracing_arm_snapshot_locked(struct trace_array
*tr
)
1345 lockdep_assert_held(&trace_types_lock
);
1347 spin_lock(&tr
->snapshot_trigger_lock
);
1348 if (tr
->snapshot
== UINT_MAX
|| tr
->mapped
) {
1349 spin_unlock(&tr
->snapshot_trigger_lock
);
1354 spin_unlock(&tr
->snapshot_trigger_lock
);
1356 ret
= tracing_alloc_snapshot_instance(tr
);
1358 spin_lock(&tr
->snapshot_trigger_lock
);
1360 spin_unlock(&tr
->snapshot_trigger_lock
);
1366 int tracing_arm_snapshot(struct trace_array
*tr
)
1370 mutex_lock(&trace_types_lock
);
1371 ret
= tracing_arm_snapshot_locked(tr
);
1372 mutex_unlock(&trace_types_lock
);
1377 void tracing_disarm_snapshot(struct trace_array
*tr
)
1379 spin_lock(&tr
->snapshot_trigger_lock
);
1380 if (!WARN_ON(!tr
->snapshot
))
1382 spin_unlock(&tr
->snapshot_trigger_lock
);
1386 * tracing_alloc_snapshot - allocate snapshot buffer.
1388 * This only allocates the snapshot buffer if it isn't already
1389 * allocated - it doesn't also take a snapshot.
1391 * This is meant to be used in cases where the snapshot buffer needs
1392 * to be set up for events that can't sleep but need to be able to
1393 * trigger a snapshot.
1395 int tracing_alloc_snapshot(void)
1397 struct trace_array
*tr
= &global_trace
;
1400 ret
= tracing_alloc_snapshot_instance(tr
);
1405 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot
);
1408 * tracing_snapshot_alloc - allocate and take a snapshot of the current buffer.
1410 * This is similar to tracing_snapshot(), but it will allocate the
1411 * snapshot buffer if it isn't already allocated. Use this only
1412 * where it is safe to sleep, as the allocation may sleep.
1414 * This causes a swap between the snapshot buffer and the current live
1415 * tracing buffer. You can use this to take snapshots of the live
1416 * trace when some condition is triggered, but continue to trace.
1418 void tracing_snapshot_alloc(void)
1422 ret
= tracing_alloc_snapshot();
1428 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc
);
1431 * tracing_snapshot_cond_enable - enable conditional snapshot for an instance
1432 * @tr: The tracing instance
1433 * @cond_data: User data to associate with the snapshot
1434 * @update: Implementation of the cond_snapshot update function
1436 * Check whether the conditional snapshot for the given instance has
1437 * already been enabled, or if the current tracer is already using a
1438 * snapshot; if so, return -EBUSY, else create a cond_snapshot and
1439 * save the cond_data and update function inside.
1441 * Returns 0 if successful, error otherwise.
1443 int tracing_snapshot_cond_enable(struct trace_array
*tr
, void *cond_data
,
1444 cond_update_fn_t update
)
1446 struct cond_snapshot
*cond_snapshot
;
1449 cond_snapshot
= kzalloc(sizeof(*cond_snapshot
), GFP_KERNEL
);
1453 cond_snapshot
->cond_data
= cond_data
;
1454 cond_snapshot
->update
= update
;
1456 mutex_lock(&trace_types_lock
);
1458 if (tr
->current_trace
->use_max_tr
) {
1464 * The cond_snapshot can only change to NULL without the
1465 * trace_types_lock. We don't care if we race with it going
1466 * to NULL, but we want to make sure that it's not set to
1467 * something other than NULL when we get here, which we can
1468 * do safely with only holding the trace_types_lock and not
1469 * having to take the max_lock.
1471 if (tr
->cond_snapshot
) {
1476 ret
= tracing_arm_snapshot_locked(tr
);
1480 local_irq_disable();
1481 arch_spin_lock(&tr
->max_lock
);
1482 tr
->cond_snapshot
= cond_snapshot
;
1483 arch_spin_unlock(&tr
->max_lock
);
1486 mutex_unlock(&trace_types_lock
);
1491 mutex_unlock(&trace_types_lock
);
1492 kfree(cond_snapshot
);
1495 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable
);
1498 * tracing_snapshot_cond_disable - disable conditional snapshot for an instance
1499 * @tr: The tracing instance
1501 * Check whether the conditional snapshot for the given instance is
1502 * enabled; if so, free the cond_snapshot associated with it,
1503 * otherwise return -EINVAL.
1505 * Returns 0 if successful, error otherwise.
1507 int tracing_snapshot_cond_disable(struct trace_array
*tr
)
1511 local_irq_disable();
1512 arch_spin_lock(&tr
->max_lock
);
1514 if (!tr
->cond_snapshot
)
1517 kfree(tr
->cond_snapshot
);
1518 tr
->cond_snapshot
= NULL
;
1521 arch_spin_unlock(&tr
->max_lock
);
1524 tracing_disarm_snapshot(tr
);
1528 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable
);
1530 void tracing_snapshot(void)
1532 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1534 EXPORT_SYMBOL_GPL(tracing_snapshot
);
1535 void tracing_snapshot_cond(struct trace_array
*tr
, void *cond_data
)
1537 WARN_ONCE(1, "Snapshot feature not enabled, but internal conditional snapshot used");
1539 EXPORT_SYMBOL_GPL(tracing_snapshot_cond
);
1540 int tracing_alloc_snapshot(void)
1542 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1545 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot
);
1546 void tracing_snapshot_alloc(void)
1551 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc
);
1552 void *tracing_cond_snapshot_data(struct trace_array
*tr
)
1556 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data
);
1557 int tracing_snapshot_cond_enable(struct trace_array
*tr
, void *cond_data
, cond_update_fn_t update
)
1561 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable
);
1562 int tracing_snapshot_cond_disable(struct trace_array
*tr
)
1566 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable
);
1567 #define free_snapshot(tr) do { } while (0)
1568 #define tracing_arm_snapshot_locked(tr) ({ -EBUSY; })
1569 #endif /* CONFIG_TRACER_SNAPSHOT */
1571 void tracer_tracing_off(struct trace_array
*tr
)
1573 if (tr
->array_buffer
.buffer
)
1574 ring_buffer_record_off(tr
->array_buffer
.buffer
);
1576 * This flag is looked at when buffers haven't been allocated
1577 * yet, or by some tracers (like irqsoff), that just want to
1578 * know if the ring buffer has been disabled, but it can handle
1579 * races of where it gets disabled but we still do a record.
1580 * As the check is in the fast path of the tracers, it is more
1581 * important to be fast than accurate.
1583 tr
->buffer_disabled
= 1;
1584 /* Make the flag seen by readers */
1589 * tracing_off - turn off tracing buffers
1591 * This function stops the tracing buffers from recording data.
1592 * It does not disable any overhead the tracers themselves may
1593 * be causing. This function simply causes all recording to
1594 * the ring buffers to fail.
1596 void tracing_off(void)
1598 tracer_tracing_off(&global_trace
);
1600 EXPORT_SYMBOL_GPL(tracing_off
);
1602 void disable_trace_on_warning(void)
1604 if (__disable_trace_on_warning
) {
1605 trace_array_printk_buf(global_trace
.array_buffer
.buffer
, _THIS_IP_
,
1606 "Disabling tracing due to warning\n");
1612 * tracer_tracing_is_on - show real state of ring buffer enabled
1613 * @tr : the trace array to know if ring buffer is enabled
1615 * Shows real state of the ring buffer if it is enabled or not.
1617 bool tracer_tracing_is_on(struct trace_array
*tr
)
1619 if (tr
->array_buffer
.buffer
)
1620 return ring_buffer_record_is_set_on(tr
->array_buffer
.buffer
);
1621 return !tr
->buffer_disabled
;
1625 * tracing_is_on - show state of ring buffers enabled
1627 int tracing_is_on(void)
1629 return tracer_tracing_is_on(&global_trace
);
1631 EXPORT_SYMBOL_GPL(tracing_is_on
);
1633 static int __init
set_buf_size(char *str
)
1635 unsigned long buf_size
;
1639 buf_size
= memparse(str
, &str
);
1641 * nr_entries can not be zero and the startup
1642 * tests require some buffer space. Therefore
1643 * ensure we have at least 4096 bytes of buffer.
1645 trace_buf_size
= max(4096UL, buf_size
);
1648 __setup("trace_buf_size=", set_buf_size
);
1650 static int __init
set_tracing_thresh(char *str
)
1652 unsigned long threshold
;
1657 ret
= kstrtoul(str
, 0, &threshold
);
1660 tracing_thresh
= threshold
* 1000;
1663 __setup("tracing_thresh=", set_tracing_thresh
);
1665 unsigned long nsecs_to_usecs(unsigned long nsecs
)
1667 return nsecs
/ 1000;
1671 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1672 * It uses C(a, b) where 'a' is the eval (enum) name and 'b' is the string that
1673 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1674 * of strings in the order that the evals (enum) were defined.
1679 /* These must match the bit positions in trace_iterator_flags */
1680 static const char *trace_options
[] = {
1688 int in_ns
; /* is this clock in nanoseconds? */
1689 } trace_clocks
[] = {
1690 { trace_clock_local
, "local", 1 },
1691 { trace_clock_global
, "global", 1 },
1692 { trace_clock_counter
, "counter", 0 },
1693 { trace_clock_jiffies
, "uptime", 0 },
1694 { trace_clock
, "perf", 1 },
1695 { ktime_get_mono_fast_ns
, "mono", 1 },
1696 { ktime_get_raw_fast_ns
, "mono_raw", 1 },
1697 { ktime_get_boot_fast_ns
, "boot", 1 },
1698 { ktime_get_tai_fast_ns
, "tai", 1 },
1702 bool trace_clock_in_ns(struct trace_array
*tr
)
1704 if (trace_clocks
[tr
->clock_id
].in_ns
)
1711 * trace_parser_get_init - gets the buffer for trace parser
1713 int trace_parser_get_init(struct trace_parser
*parser
, int size
)
1715 memset(parser
, 0, sizeof(*parser
));
1717 parser
->buffer
= kmalloc(size
, GFP_KERNEL
);
1718 if (!parser
->buffer
)
1721 parser
->size
= size
;
1726 * trace_parser_put - frees the buffer for trace parser
1728 void trace_parser_put(struct trace_parser
*parser
)
1730 kfree(parser
->buffer
);
1731 parser
->buffer
= NULL
;
1735 * trace_get_user - reads the user input string separated by space
1736 * (matched by isspace(ch))
1738 * For each string found the 'struct trace_parser' is updated,
1739 * and the function returns.
1741 * Returns number of bytes read.
1743 * See kernel/trace/trace.h for 'struct trace_parser' details.
1745 int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
1746 size_t cnt
, loff_t
*ppos
)
1753 trace_parser_clear(parser
);
1755 ret
= get_user(ch
, ubuf
++);
1763 * The parser is not finished with the last write,
1764 * continue reading the user input without skipping spaces.
1766 if (!parser
->cont
) {
1767 /* skip white space */
1768 while (cnt
&& isspace(ch
)) {
1769 ret
= get_user(ch
, ubuf
++);
1778 /* only spaces were written */
1779 if (isspace(ch
) || !ch
) {
1786 /* read the non-space input */
1787 while (cnt
&& !isspace(ch
) && ch
) {
1788 if (parser
->idx
< parser
->size
- 1)
1789 parser
->buffer
[parser
->idx
++] = ch
;
1794 ret
= get_user(ch
, ubuf
++);
1801 /* We either got finished input or we have to wait for another call. */
1802 if (isspace(ch
) || !ch
) {
1803 parser
->buffer
[parser
->idx
] = 0;
1804 parser
->cont
= false;
1805 } else if (parser
->idx
< parser
->size
- 1) {
1806 parser
->cont
= true;
1807 parser
->buffer
[parser
->idx
++] = ch
;
1808 /* Make sure the parsed string always terminates with '\0'. */
1809 parser
->buffer
[parser
->idx
] = 0;
1822 /* TODO add a seq_buf_to_buffer() */
1823 static ssize_t
trace_seq_to_buffer(struct trace_seq
*s
, void *buf
, size_t cnt
)
1827 if (trace_seq_used(s
) <= s
->readpos
)
1830 len
= trace_seq_used(s
) - s
->readpos
;
1833 memcpy(buf
, s
->buffer
+ s
->readpos
, cnt
);
1839 unsigned long __read_mostly tracing_thresh
;
1841 #ifdef CONFIG_TRACER_MAX_TRACE
1842 static const struct file_operations tracing_max_lat_fops
;
1844 #ifdef LATENCY_FS_NOTIFY
1846 static struct workqueue_struct
*fsnotify_wq
;
1848 static void latency_fsnotify_workfn(struct work_struct
*work
)
1850 struct trace_array
*tr
= container_of(work
, struct trace_array
,
1852 fsnotify_inode(tr
->d_max_latency
->d_inode
, FS_MODIFY
);
1855 static void latency_fsnotify_workfn_irq(struct irq_work
*iwork
)
1857 struct trace_array
*tr
= container_of(iwork
, struct trace_array
,
1859 queue_work(fsnotify_wq
, &tr
->fsnotify_work
);
1862 static void trace_create_maxlat_file(struct trace_array
*tr
,
1863 struct dentry
*d_tracer
)
1865 INIT_WORK(&tr
->fsnotify_work
, latency_fsnotify_workfn
);
1866 init_irq_work(&tr
->fsnotify_irqwork
, latency_fsnotify_workfn_irq
);
1867 tr
->d_max_latency
= trace_create_file("tracing_max_latency",
1870 &tracing_max_lat_fops
);
1873 __init
static int latency_fsnotify_init(void)
1875 fsnotify_wq
= alloc_workqueue("tr_max_lat_wq",
1876 WQ_UNBOUND
| WQ_HIGHPRI
, 0);
1878 pr_err("Unable to allocate tr_max_lat_wq\n");
1884 late_initcall_sync(latency_fsnotify_init
);
1886 void latency_fsnotify(struct trace_array
*tr
)
1891 * We cannot call queue_work(&tr->fsnotify_work) from here because it's
1892 * possible that we are called from __schedule() or do_idle(), which
1893 * could cause a deadlock.
1895 irq_work_queue(&tr
->fsnotify_irqwork
);
1898 #else /* !LATENCY_FS_NOTIFY */
1900 #define trace_create_maxlat_file(tr, d_tracer) \
1901 trace_create_file("tracing_max_latency", TRACE_MODE_WRITE, \
1902 d_tracer, tr, &tracing_max_lat_fops)
1907 * Copy the new maximum trace into the separate maximum-trace
1908 * structure. (this way the maximum trace is permanently saved,
1909 * for later retrieval via /sys/kernel/tracing/tracing_max_latency)
1912 __update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
)
1914 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
1915 struct array_buffer
*max_buf
= &tr
->max_buffer
;
1916 struct trace_array_cpu
*data
= per_cpu_ptr(trace_buf
->data
, cpu
);
1917 struct trace_array_cpu
*max_data
= per_cpu_ptr(max_buf
->data
, cpu
);
1920 max_buf
->time_start
= data
->preempt_timestamp
;
1922 max_data
->saved_latency
= tr
->max_latency
;
1923 max_data
->critical_start
= data
->critical_start
;
1924 max_data
->critical_end
= data
->critical_end
;
1926 strscpy(max_data
->comm
, tsk
->comm
);
1927 max_data
->pid
= tsk
->pid
;
1929 * If tsk == current, then use current_uid(), as that does not use
1930 * RCU. The irq tracer can be called out of RCU scope.
1933 max_data
->uid
= current_uid();
1935 max_data
->uid
= task_uid(tsk
);
1937 max_data
->nice
= tsk
->static_prio
- 20 - MAX_RT_PRIO
;
1938 max_data
->policy
= tsk
->policy
;
1939 max_data
->rt_priority
= tsk
->rt_priority
;
1941 /* record this tasks comm */
1942 tracing_record_cmdline(tsk
);
1943 latency_fsnotify(tr
);
1947 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1949 * @tsk: the task with the latency
1950 * @cpu: The cpu that initiated the trace.
1951 * @cond_data: User data associated with a conditional snapshot
1953 * Flip the buffers between the @tr and the max_tr and record information
1954 * about which task was the cause of this latency.
1957 update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
,
1963 WARN_ON_ONCE(!irqs_disabled());
1965 if (!tr
->allocated_snapshot
) {
1966 /* Only the nop tracer should hit this when disabling */
1967 WARN_ON_ONCE(tr
->current_trace
!= &nop_trace
);
1971 arch_spin_lock(&tr
->max_lock
);
1973 /* Inherit the recordable setting from array_buffer */
1974 if (ring_buffer_record_is_set_on(tr
->array_buffer
.buffer
))
1975 ring_buffer_record_on(tr
->max_buffer
.buffer
);
1977 ring_buffer_record_off(tr
->max_buffer
.buffer
);
1979 #ifdef CONFIG_TRACER_SNAPSHOT
1980 if (tr
->cond_snapshot
&& !tr
->cond_snapshot
->update(tr
, cond_data
)) {
1981 arch_spin_unlock(&tr
->max_lock
);
1985 swap(tr
->array_buffer
.buffer
, tr
->max_buffer
.buffer
);
1987 __update_max_tr(tr
, tsk
, cpu
);
1989 arch_spin_unlock(&tr
->max_lock
);
1991 /* Any waiters on the old snapshot buffer need to wake up */
1992 ring_buffer_wake_waiters(tr
->array_buffer
.buffer
, RING_BUFFER_ALL_CPUS
);
1996 * update_max_tr_single - only copy one trace over, and reset the rest
1998 * @tsk: task with the latency
1999 * @cpu: the cpu of the buffer to copy.
2001 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
2004 update_max_tr_single(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
)
2011 WARN_ON_ONCE(!irqs_disabled());
2012 if (!tr
->allocated_snapshot
) {
2013 /* Only the nop tracer should hit this when disabling */
2014 WARN_ON_ONCE(tr
->current_trace
!= &nop_trace
);
2018 arch_spin_lock(&tr
->max_lock
);
2020 ret
= ring_buffer_swap_cpu(tr
->max_buffer
.buffer
, tr
->array_buffer
.buffer
, cpu
);
2022 if (ret
== -EBUSY
) {
2024 * We failed to swap the buffer due to a commit taking
2025 * place on this CPU. We fail to record, but we reset
2026 * the max trace buffer (no one writes directly to it)
2027 * and flag that it failed.
2028 * Another reason is resize is in progress.
2030 trace_array_printk_buf(tr
->max_buffer
.buffer
, _THIS_IP_
,
2031 "Failed to swap buffers due to commit or resize in progress\n");
2034 WARN_ON_ONCE(ret
&& ret
!= -EAGAIN
&& ret
!= -EBUSY
);
2036 __update_max_tr(tr
, tsk
, cpu
);
2037 arch_spin_unlock(&tr
->max_lock
);
2040 #endif /* CONFIG_TRACER_MAX_TRACE */
2043 struct trace_iterator
*iter
;
2047 static bool wait_pipe_cond(void *data
)
2049 struct pipe_wait
*pwait
= data
;
2050 struct trace_iterator
*iter
= pwait
->iter
;
2052 if (atomic_read_acquire(&iter
->wait_index
) != pwait
->wait_index
)
2055 return iter
->closed
;
2058 static int wait_on_pipe(struct trace_iterator
*iter
, int full
)
2060 struct pipe_wait pwait
;
2063 /* Iterators are static, they should be filled or empty */
2064 if (trace_buffer_iter(iter
, iter
->cpu_file
))
2067 pwait
.wait_index
= atomic_read_acquire(&iter
->wait_index
);
2070 ret
= ring_buffer_wait(iter
->array_buffer
->buffer
, iter
->cpu_file
, full
,
2071 wait_pipe_cond
, &pwait
);
2073 #ifdef CONFIG_TRACER_MAX_TRACE
2075 * Make sure this is still the snapshot buffer, as if a snapshot were
2076 * to happen, this would now be the main buffer.
2079 iter
->array_buffer
= &iter
->tr
->max_buffer
;
2084 #ifdef CONFIG_FTRACE_STARTUP_TEST
2085 static bool selftests_can_run
;
2087 struct trace_selftests
{
2088 struct list_head list
;
2089 struct tracer
*type
;
2092 static LIST_HEAD(postponed_selftests
);
2094 static int save_selftest(struct tracer
*type
)
2096 struct trace_selftests
*selftest
;
2098 selftest
= kmalloc(sizeof(*selftest
), GFP_KERNEL
);
2102 selftest
->type
= type
;
2103 list_add(&selftest
->list
, &postponed_selftests
);
2107 static int run_tracer_selftest(struct tracer
*type
)
2109 struct trace_array
*tr
= &global_trace
;
2110 struct tracer
*saved_tracer
= tr
->current_trace
;
2113 if (!type
->selftest
|| tracing_selftest_disabled
)
2117 * If a tracer registers early in boot up (before scheduling is
2118 * initialized and such), then do not run its selftests yet.
2119 * Instead, run it a little later in the boot process.
2121 if (!selftests_can_run
)
2122 return save_selftest(type
);
2124 if (!tracing_is_on()) {
2125 pr_warn("Selftest for tracer %s skipped due to tracing disabled\n",
2131 * Run a selftest on this tracer.
2132 * Here we reset the trace buffer, and set the current
2133 * tracer to be this tracer. The tracer can then run some
2134 * internal tracing to verify that everything is in order.
2135 * If we fail, we do not register this tracer.
2137 tracing_reset_online_cpus(&tr
->array_buffer
);
2139 tr
->current_trace
= type
;
2141 #ifdef CONFIG_TRACER_MAX_TRACE
2142 if (type
->use_max_tr
) {
2143 /* If we expanded the buffers, make sure the max is expanded too */
2144 if (tr
->ring_buffer_expanded
)
2145 ring_buffer_resize(tr
->max_buffer
.buffer
, trace_buf_size
,
2146 RING_BUFFER_ALL_CPUS
);
2147 tr
->allocated_snapshot
= true;
2151 /* the test is responsible for initializing and enabling */
2152 pr_info("Testing tracer %s: ", type
->name
);
2153 ret
= type
->selftest(type
, tr
);
2154 /* the test is responsible for resetting too */
2155 tr
->current_trace
= saved_tracer
;
2157 printk(KERN_CONT
"FAILED!\n");
2158 /* Add the warning after printing 'FAILED' */
2162 /* Only reset on passing, to avoid touching corrupted buffers */
2163 tracing_reset_online_cpus(&tr
->array_buffer
);
2165 #ifdef CONFIG_TRACER_MAX_TRACE
2166 if (type
->use_max_tr
) {
2167 tr
->allocated_snapshot
= false;
2169 /* Shrink the max buffer again */
2170 if (tr
->ring_buffer_expanded
)
2171 ring_buffer_resize(tr
->max_buffer
.buffer
, 1,
2172 RING_BUFFER_ALL_CPUS
);
2176 printk(KERN_CONT
"PASSED\n");
2180 static int do_run_tracer_selftest(struct tracer
*type
)
2185 * Tests can take a long time, especially if they are run one after the
2186 * other, as does happen during bootup when all the tracers are
2187 * registered. This could cause the soft lockup watchdog to trigger.
2191 tracing_selftest_running
= true;
2192 ret
= run_tracer_selftest(type
);
2193 tracing_selftest_running
= false;
2198 static __init
int init_trace_selftests(void)
2200 struct trace_selftests
*p
, *n
;
2201 struct tracer
*t
, **last
;
2204 selftests_can_run
= true;
2206 mutex_lock(&trace_types_lock
);
2208 if (list_empty(&postponed_selftests
))
2211 pr_info("Running postponed tracer tests:\n");
2213 tracing_selftest_running
= true;
2214 list_for_each_entry_safe(p
, n
, &postponed_selftests
, list
) {
2215 /* This loop can take minutes when sanitizers are enabled, so
2216 * lets make sure we allow RCU processing.
2219 ret
= run_tracer_selftest(p
->type
);
2220 /* If the test fails, then warn and remove from available_tracers */
2222 WARN(1, "tracer: %s failed selftest, disabling\n",
2224 last
= &trace_types
;
2225 for (t
= trace_types
; t
; t
= t
->next
) {
2236 tracing_selftest_running
= false;
2239 mutex_unlock(&trace_types_lock
);
2243 core_initcall(init_trace_selftests
);
2245 static inline int do_run_tracer_selftest(struct tracer
*type
)
2249 #endif /* CONFIG_FTRACE_STARTUP_TEST */
2251 static void add_tracer_options(struct trace_array
*tr
, struct tracer
*t
);
2253 static void __init
apply_trace_boot_options(void);
2256 * register_tracer - register a tracer with the ftrace system.
2257 * @type: the plugin for the tracer
2259 * Register a new plugin tracer.
2261 int __init
register_tracer(struct tracer
*type
)
2267 pr_info("Tracer must have a name\n");
2271 if (strlen(type
->name
) >= MAX_TRACER_SIZE
) {
2272 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE
);
2276 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
2277 pr_warn("Can not register tracer %s due to lockdown\n",
2282 mutex_lock(&trace_types_lock
);
2284 for (t
= trace_types
; t
; t
= t
->next
) {
2285 if (strcmp(type
->name
, t
->name
) == 0) {
2287 pr_info("Tracer %s already registered\n",
2294 if (!type
->set_flag
)
2295 type
->set_flag
= &dummy_set_flag
;
2297 /*allocate a dummy tracer_flags*/
2298 type
->flags
= kmalloc(sizeof(*type
->flags
), GFP_KERNEL
);
2303 type
->flags
->val
= 0;
2304 type
->flags
->opts
= dummy_tracer_opt
;
2306 if (!type
->flags
->opts
)
2307 type
->flags
->opts
= dummy_tracer_opt
;
2309 /* store the tracer for __set_tracer_option */
2310 type
->flags
->trace
= type
;
2312 ret
= do_run_tracer_selftest(type
);
2316 type
->next
= trace_types
;
2318 add_tracer_options(&global_trace
, type
);
2321 mutex_unlock(&trace_types_lock
);
2323 if (ret
|| !default_bootup_tracer
)
2326 if (strncmp(default_bootup_tracer
, type
->name
, MAX_TRACER_SIZE
))
2329 printk(KERN_INFO
"Starting tracer '%s'\n", type
->name
);
2330 /* Do we want this tracer to start on bootup? */
2331 tracing_set_tracer(&global_trace
, type
->name
);
2332 default_bootup_tracer
= NULL
;
2334 apply_trace_boot_options();
2336 /* disable other selftests, since this will break it. */
2337 disable_tracing_selftest("running a tracer");
2343 static void tracing_reset_cpu(struct array_buffer
*buf
, int cpu
)
2345 struct trace_buffer
*buffer
= buf
->buffer
;
2350 ring_buffer_record_disable(buffer
);
2352 /* Make sure all commits have finished */
2354 ring_buffer_reset_cpu(buffer
, cpu
);
2356 ring_buffer_record_enable(buffer
);
2359 void tracing_reset_online_cpus(struct array_buffer
*buf
)
2361 struct trace_buffer
*buffer
= buf
->buffer
;
2366 ring_buffer_record_disable(buffer
);
2368 /* Make sure all commits have finished */
2371 buf
->time_start
= buffer_ftrace_now(buf
, buf
->cpu
);
2373 ring_buffer_reset_online_cpus(buffer
);
2375 ring_buffer_record_enable(buffer
);
2378 static void tracing_reset_all_cpus(struct array_buffer
*buf
)
2380 struct trace_buffer
*buffer
= buf
->buffer
;
2385 ring_buffer_record_disable(buffer
);
2387 /* Make sure all commits have finished */
2390 buf
->time_start
= buffer_ftrace_now(buf
, buf
->cpu
);
2392 ring_buffer_reset(buffer
);
2394 ring_buffer_record_enable(buffer
);
2397 /* Must have trace_types_lock held */
2398 void tracing_reset_all_online_cpus_unlocked(void)
2400 struct trace_array
*tr
;
2402 lockdep_assert_held(&trace_types_lock
);
2404 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
2405 if (!tr
->clear_trace
)
2407 tr
->clear_trace
= false;
2408 tracing_reset_online_cpus(&tr
->array_buffer
);
2409 #ifdef CONFIG_TRACER_MAX_TRACE
2410 tracing_reset_online_cpus(&tr
->max_buffer
);
2415 void tracing_reset_all_online_cpus(void)
2417 mutex_lock(&trace_types_lock
);
2418 tracing_reset_all_online_cpus_unlocked();
2419 mutex_unlock(&trace_types_lock
);
2422 int is_tracing_stopped(void)
2424 return global_trace
.stop_count
;
2427 static void tracing_start_tr(struct trace_array
*tr
)
2429 struct trace_buffer
*buffer
;
2430 unsigned long flags
;
2432 if (tracing_disabled
)
2435 raw_spin_lock_irqsave(&tr
->start_lock
, flags
);
2436 if (--tr
->stop_count
) {
2437 if (WARN_ON_ONCE(tr
->stop_count
< 0)) {
2438 /* Someone screwed up their debugging */
2444 /* Prevent the buffers from switching */
2445 arch_spin_lock(&tr
->max_lock
);
2447 buffer
= tr
->array_buffer
.buffer
;
2449 ring_buffer_record_enable(buffer
);
2451 #ifdef CONFIG_TRACER_MAX_TRACE
2452 buffer
= tr
->max_buffer
.buffer
;
2454 ring_buffer_record_enable(buffer
);
2457 arch_spin_unlock(&tr
->max_lock
);
2460 raw_spin_unlock_irqrestore(&tr
->start_lock
, flags
);
2464 * tracing_start - quick start of the tracer
2466 * If tracing is enabled but was stopped by tracing_stop,
2467 * this will start the tracer back up.
2469 void tracing_start(void)
2472 return tracing_start_tr(&global_trace
);
2475 static void tracing_stop_tr(struct trace_array
*tr
)
2477 struct trace_buffer
*buffer
;
2478 unsigned long flags
;
2480 raw_spin_lock_irqsave(&tr
->start_lock
, flags
);
2481 if (tr
->stop_count
++)
2484 /* Prevent the buffers from switching */
2485 arch_spin_lock(&tr
->max_lock
);
2487 buffer
= tr
->array_buffer
.buffer
;
2489 ring_buffer_record_disable(buffer
);
2491 #ifdef CONFIG_TRACER_MAX_TRACE
2492 buffer
= tr
->max_buffer
.buffer
;
2494 ring_buffer_record_disable(buffer
);
2497 arch_spin_unlock(&tr
->max_lock
);
2500 raw_spin_unlock_irqrestore(&tr
->start_lock
, flags
);
2504 * tracing_stop - quick stop of the tracer
2506 * Light weight way to stop tracing. Use in conjunction with
2509 void tracing_stop(void)
2511 return tracing_stop_tr(&global_trace
);
2515 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2516 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2517 * simplifies those functions and keeps them in sync.
2519 enum print_line_t
trace_handle_return(struct trace_seq
*s
)
2521 return trace_seq_has_overflowed(s
) ?
2522 TRACE_TYPE_PARTIAL_LINE
: TRACE_TYPE_HANDLED
;
2524 EXPORT_SYMBOL_GPL(trace_handle_return
);
2526 static unsigned short migration_disable_value(void)
2528 #if defined(CONFIG_SMP)
2529 return current
->migration_disabled
;
2535 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status
)
2537 unsigned int trace_flags
= irqs_status
;
2540 pc
= preempt_count();
2543 trace_flags
|= TRACE_FLAG_NMI
;
2544 if (pc
& HARDIRQ_MASK
)
2545 trace_flags
|= TRACE_FLAG_HARDIRQ
;
2546 if (in_serving_softirq())
2547 trace_flags
|= TRACE_FLAG_SOFTIRQ
;
2548 if (softirq_count() >> (SOFTIRQ_SHIFT
+ 1))
2549 trace_flags
|= TRACE_FLAG_BH_OFF
;
2551 if (tif_need_resched())
2552 trace_flags
|= TRACE_FLAG_NEED_RESCHED
;
2553 if (test_preempt_need_resched())
2554 trace_flags
|= TRACE_FLAG_PREEMPT_RESCHED
;
2555 if (IS_ENABLED(CONFIG_ARCH_HAS_PREEMPT_LAZY
) && tif_test_bit(TIF_NEED_RESCHED_LAZY
))
2556 trace_flags
|= TRACE_FLAG_NEED_RESCHED_LAZY
;
2557 return (trace_flags
<< 16) | (min_t(unsigned int, pc
& 0xff, 0xf)) |
2558 (min_t(unsigned int, migration_disable_value(), 0xf)) << 4;
2561 struct ring_buffer_event
*
2562 trace_buffer_lock_reserve(struct trace_buffer
*buffer
,
2565 unsigned int trace_ctx
)
2567 return __trace_buffer_lock_reserve(buffer
, type
, len
, trace_ctx
);
2570 DEFINE_PER_CPU(struct ring_buffer_event
*, trace_buffered_event
);
2571 DEFINE_PER_CPU(int, trace_buffered_event_cnt
);
2572 static int trace_buffered_event_ref
;
2575 * trace_buffered_event_enable - enable buffering events
2577 * When events are being filtered, it is quicker to use a temporary
2578 * buffer to write the event data into if there's a likely chance
2579 * that it will not be committed. The discard of the ring buffer
2580 * is not as fast as committing, and is much slower than copying
2583 * When an event is to be filtered, allocate per cpu buffers to
2584 * write the event data into, and if the event is filtered and discarded
2585 * it is simply dropped, otherwise, the entire data is to be committed
2588 void trace_buffered_event_enable(void)
2590 struct ring_buffer_event
*event
;
2594 WARN_ON_ONCE(!mutex_is_locked(&event_mutex
));
2596 if (trace_buffered_event_ref
++)
2599 for_each_tracing_cpu(cpu
) {
2600 page
= alloc_pages_node(cpu_to_node(cpu
),
2601 GFP_KERNEL
| __GFP_NORETRY
, 0);
2602 /* This is just an optimization and can handle failures */
2604 pr_err("Failed to allocate event buffer\n");
2608 event
= page_address(page
);
2609 memset(event
, 0, sizeof(*event
));
2611 per_cpu(trace_buffered_event
, cpu
) = event
;
2614 if (cpu
== smp_processor_id() &&
2615 __this_cpu_read(trace_buffered_event
) !=
2616 per_cpu(trace_buffered_event
, cpu
))
2622 static void enable_trace_buffered_event(void *data
)
2624 /* Probably not needed, but do it anyway */
2626 this_cpu_dec(trace_buffered_event_cnt
);
2629 static void disable_trace_buffered_event(void *data
)
2631 this_cpu_inc(trace_buffered_event_cnt
);
2635 * trace_buffered_event_disable - disable buffering events
2637 * When a filter is removed, it is faster to not use the buffered
2638 * events, and to commit directly into the ring buffer. Free up
2639 * the temp buffers when there are no more users. This requires
2640 * special synchronization with current events.
2642 void trace_buffered_event_disable(void)
2646 WARN_ON_ONCE(!mutex_is_locked(&event_mutex
));
2648 if (WARN_ON_ONCE(!trace_buffered_event_ref
))
2651 if (--trace_buffered_event_ref
)
2654 /* For each CPU, set the buffer as used. */
2655 on_each_cpu_mask(tracing_buffer_mask
, disable_trace_buffered_event
,
2658 /* Wait for all current users to finish */
2661 for_each_tracing_cpu(cpu
) {
2662 free_page((unsigned long)per_cpu(trace_buffered_event
, cpu
));
2663 per_cpu(trace_buffered_event
, cpu
) = NULL
;
2667 * Wait for all CPUs that potentially started checking if they can use
2668 * their event buffer only after the previous synchronize_rcu() call and
2669 * they still read a valid pointer from trace_buffered_event. It must be
2670 * ensured they don't see cleared trace_buffered_event_cnt else they
2671 * could wrongly decide to use the pointed-to buffer which is now freed.
2675 /* For each CPU, relinquish the buffer */
2676 on_each_cpu_mask(tracing_buffer_mask
, enable_trace_buffered_event
, NULL
,
2680 static struct trace_buffer
*temp_buffer
;
2682 struct ring_buffer_event
*
2683 trace_event_buffer_lock_reserve(struct trace_buffer
**current_rb
,
2684 struct trace_event_file
*trace_file
,
2685 int type
, unsigned long len
,
2686 unsigned int trace_ctx
)
2688 struct ring_buffer_event
*entry
;
2689 struct trace_array
*tr
= trace_file
->tr
;
2692 *current_rb
= tr
->array_buffer
.buffer
;
2694 if (!tr
->no_filter_buffering_ref
&&
2695 (trace_file
->flags
& (EVENT_FILE_FL_SOFT_DISABLED
| EVENT_FILE_FL_FILTERED
))) {
2696 preempt_disable_notrace();
2698 * Filtering is on, so try to use the per cpu buffer first.
2699 * This buffer will simulate a ring_buffer_event,
2700 * where the type_len is zero and the array[0] will
2701 * hold the full length.
2702 * (see include/linux/ring-buffer.h for details on
2703 * how the ring_buffer_event is structured).
2705 * Using a temp buffer during filtering and copying it
2706 * on a matched filter is quicker than writing directly
2707 * into the ring buffer and then discarding it when
2708 * it doesn't match. That is because the discard
2709 * requires several atomic operations to get right.
2710 * Copying on match and doing nothing on a failed match
2711 * is still quicker than no copy on match, but having
2712 * to discard out of the ring buffer on a failed match.
2714 if ((entry
= __this_cpu_read(trace_buffered_event
))) {
2715 int max_len
= PAGE_SIZE
- struct_size(entry
, array
, 1);
2717 val
= this_cpu_inc_return(trace_buffered_event_cnt
);
2720 * Preemption is disabled, but interrupts and NMIs
2721 * can still come in now. If that happens after
2722 * the above increment, then it will have to go
2723 * back to the old method of allocating the event
2724 * on the ring buffer, and if the filter fails, it
2725 * will have to call ring_buffer_discard_commit()
2728 * Need to also check the unlikely case that the
2729 * length is bigger than the temp buffer size.
2730 * If that happens, then the reserve is pretty much
2731 * guaranteed to fail, as the ring buffer currently
2732 * only allows events less than a page. But that may
2733 * change in the future, so let the ring buffer reserve
2734 * handle the failure in that case.
2736 if (val
== 1 && likely(len
<= max_len
)) {
2737 trace_event_setup(entry
, type
, trace_ctx
);
2738 entry
->array
[0] = len
;
2739 /* Return with preemption disabled */
2742 this_cpu_dec(trace_buffered_event_cnt
);
2744 /* __trace_buffer_lock_reserve() disables preemption */
2745 preempt_enable_notrace();
2748 entry
= __trace_buffer_lock_reserve(*current_rb
, type
, len
,
2751 * If tracing is off, but we have triggers enabled
2752 * we still need to look at the event data. Use the temp_buffer
2753 * to store the trace event for the trigger to use. It's recursive
2754 * safe and will not be recorded anywhere.
2756 if (!entry
&& trace_file
->flags
& EVENT_FILE_FL_TRIGGER_COND
) {
2757 *current_rb
= temp_buffer
;
2758 entry
= __trace_buffer_lock_reserve(*current_rb
, type
, len
,
2763 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve
);
2765 static DEFINE_RAW_SPINLOCK(tracepoint_iter_lock
);
2766 static DEFINE_MUTEX(tracepoint_printk_mutex
);
2768 static void output_printk(struct trace_event_buffer
*fbuffer
)
2770 struct trace_event_call
*event_call
;
2771 struct trace_event_file
*file
;
2772 struct trace_event
*event
;
2773 unsigned long flags
;
2774 struct trace_iterator
*iter
= tracepoint_print_iter
;
2776 /* We should never get here if iter is NULL */
2777 if (WARN_ON_ONCE(!iter
))
2780 event_call
= fbuffer
->trace_file
->event_call
;
2781 if (!event_call
|| !event_call
->event
.funcs
||
2782 !event_call
->event
.funcs
->trace
)
2785 file
= fbuffer
->trace_file
;
2786 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT
, &file
->flags
) ||
2787 (unlikely(file
->flags
& EVENT_FILE_FL_FILTERED
) &&
2788 !filter_match_preds(file
->filter
, fbuffer
->entry
)))
2791 event
= &fbuffer
->trace_file
->event_call
->event
;
2793 raw_spin_lock_irqsave(&tracepoint_iter_lock
, flags
);
2794 trace_seq_init(&iter
->seq
);
2795 iter
->ent
= fbuffer
->entry
;
2796 event_call
->event
.funcs
->trace(iter
, 0, event
);
2797 trace_seq_putc(&iter
->seq
, 0);
2798 printk("%s", iter
->seq
.buffer
);
2800 raw_spin_unlock_irqrestore(&tracepoint_iter_lock
, flags
);
2803 int tracepoint_printk_sysctl(const struct ctl_table
*table
, int write
,
2804 void *buffer
, size_t *lenp
,
2807 int save_tracepoint_printk
;
2810 mutex_lock(&tracepoint_printk_mutex
);
2811 save_tracepoint_printk
= tracepoint_printk
;
2813 ret
= proc_dointvec(table
, write
, buffer
, lenp
, ppos
);
2816 * This will force exiting early, as tracepoint_printk
2817 * is always zero when tracepoint_printk_iter is not allocated
2819 if (!tracepoint_print_iter
)
2820 tracepoint_printk
= 0;
2822 if (save_tracepoint_printk
== tracepoint_printk
)
2825 if (tracepoint_printk
)
2826 static_key_enable(&tracepoint_printk_key
.key
);
2828 static_key_disable(&tracepoint_printk_key
.key
);
2831 mutex_unlock(&tracepoint_printk_mutex
);
2836 void trace_event_buffer_commit(struct trace_event_buffer
*fbuffer
)
2838 enum event_trigger_type tt
= ETT_NONE
;
2839 struct trace_event_file
*file
= fbuffer
->trace_file
;
2841 if (__event_trigger_test_discard(file
, fbuffer
->buffer
, fbuffer
->event
,
2842 fbuffer
->entry
, &tt
))
2845 if (static_key_false(&tracepoint_printk_key
.key
))
2846 output_printk(fbuffer
);
2848 if (static_branch_unlikely(&trace_event_exports_enabled
))
2849 ftrace_exports(fbuffer
->event
, TRACE_EXPORT_EVENT
);
2851 trace_buffer_unlock_commit_regs(file
->tr
, fbuffer
->buffer
,
2852 fbuffer
->event
, fbuffer
->trace_ctx
, fbuffer
->regs
);
2856 event_triggers_post_call(file
, tt
);
2859 EXPORT_SYMBOL_GPL(trace_event_buffer_commit
);
2864 * trace_buffer_unlock_commit_regs()
2865 * trace_event_buffer_commit()
2866 * trace_event_raw_event_xxx()
2868 # define STACK_SKIP 3
2870 void trace_buffer_unlock_commit_regs(struct trace_array
*tr
,
2871 struct trace_buffer
*buffer
,
2872 struct ring_buffer_event
*event
,
2873 unsigned int trace_ctx
,
2874 struct pt_regs
*regs
)
2876 __buffer_unlock_commit(buffer
, event
);
2879 * If regs is not set, then skip the necessary functions.
2880 * Note, we can still get here via blktrace, wakeup tracer
2881 * and mmiotrace, but that's ok if they lose a function or
2882 * two. They are not that meaningful.
2884 ftrace_trace_stack(tr
, buffer
, trace_ctx
, regs
? 0 : STACK_SKIP
, regs
);
2885 ftrace_trace_userstack(tr
, buffer
, trace_ctx
);
2889 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
2892 trace_buffer_unlock_commit_nostack(struct trace_buffer
*buffer
,
2893 struct ring_buffer_event
*event
)
2895 __buffer_unlock_commit(buffer
, event
);
2899 trace_function(struct trace_array
*tr
, unsigned long ip
, unsigned long
2900 parent_ip
, unsigned int trace_ctx
)
2902 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
2903 struct ring_buffer_event
*event
;
2904 struct ftrace_entry
*entry
;
2906 event
= __trace_buffer_lock_reserve(buffer
, TRACE_FN
, sizeof(*entry
),
2910 entry
= ring_buffer_event_data(event
);
2912 entry
->parent_ip
= parent_ip
;
2914 if (static_branch_unlikely(&trace_function_exports_enabled
))
2915 ftrace_exports(event
, TRACE_EXPORT_FUNCTION
);
2916 __buffer_unlock_commit(buffer
, event
);
2919 #ifdef CONFIG_STACKTRACE
2921 /* Allow 4 levels of nesting: normal, softirq, irq, NMI */
2922 #define FTRACE_KSTACK_NESTING 4
2924 #define FTRACE_KSTACK_ENTRIES (SZ_4K / FTRACE_KSTACK_NESTING)
2926 struct ftrace_stack
{
2927 unsigned long calls
[FTRACE_KSTACK_ENTRIES
];
2931 struct ftrace_stacks
{
2932 struct ftrace_stack stacks
[FTRACE_KSTACK_NESTING
];
2935 static DEFINE_PER_CPU(struct ftrace_stacks
, ftrace_stacks
);
2936 static DEFINE_PER_CPU(int, ftrace_stack_reserve
);
2938 static void __ftrace_trace_stack(struct trace_array
*tr
,
2939 struct trace_buffer
*buffer
,
2940 unsigned int trace_ctx
,
2941 int skip
, struct pt_regs
*regs
)
2943 struct ring_buffer_event
*event
;
2944 unsigned int size
, nr_entries
;
2945 struct ftrace_stack
*fstack
;
2946 struct stack_entry
*entry
;
2950 * Add one, for this function and the call to save_stack_trace()
2951 * If regs is set, then these functions will not be in the way.
2953 #ifndef CONFIG_UNWINDER_ORC
2958 preempt_disable_notrace();
2960 stackidx
= __this_cpu_inc_return(ftrace_stack_reserve
) - 1;
2962 /* This should never happen. If it does, yell once and skip */
2963 if (WARN_ON_ONCE(stackidx
>= FTRACE_KSTACK_NESTING
))
2967 * The above __this_cpu_inc_return() is 'atomic' cpu local. An
2968 * interrupt will either see the value pre increment or post
2969 * increment. If the interrupt happens pre increment it will have
2970 * restored the counter when it returns. We just need a barrier to
2971 * keep gcc from moving things around.
2975 fstack
= this_cpu_ptr(ftrace_stacks
.stacks
) + stackidx
;
2976 size
= ARRAY_SIZE(fstack
->calls
);
2979 nr_entries
= stack_trace_save_regs(regs
, fstack
->calls
,
2982 nr_entries
= stack_trace_save(fstack
->calls
, size
, skip
);
2985 #ifdef CONFIG_DYNAMIC_FTRACE
2986 /* Mark entry of stack trace as trampoline code */
2987 if (tr
->ops
&& tr
->ops
->trampoline
) {
2988 unsigned long tramp_start
= tr
->ops
->trampoline
;
2989 unsigned long tramp_end
= tramp_start
+ tr
->ops
->trampoline_size
;
2990 unsigned long *calls
= fstack
->calls
;
2992 for (int i
= 0; i
< nr_entries
; i
++) {
2993 if (calls
[i
] >= tramp_start
&& calls
[i
] < tramp_end
)
2994 calls
[i
] = FTRACE_TRAMPOLINE_MARKER
;
2999 event
= __trace_buffer_lock_reserve(buffer
, TRACE_STACK
,
3000 struct_size(entry
, caller
, nr_entries
),
3004 entry
= ring_buffer_event_data(event
);
3006 entry
->size
= nr_entries
;
3007 memcpy(&entry
->caller
, fstack
->calls
,
3008 flex_array_size(entry
, caller
, nr_entries
));
3010 __buffer_unlock_commit(buffer
, event
);
3013 /* Again, don't let gcc optimize things here */
3015 __this_cpu_dec(ftrace_stack_reserve
);
3016 preempt_enable_notrace();
3020 static inline void ftrace_trace_stack(struct trace_array
*tr
,
3021 struct trace_buffer
*buffer
,
3022 unsigned int trace_ctx
,
3023 int skip
, struct pt_regs
*regs
)
3025 if (!(tr
->trace_flags
& TRACE_ITER_STACKTRACE
))
3028 __ftrace_trace_stack(tr
, buffer
, trace_ctx
, skip
, regs
);
3031 void __trace_stack(struct trace_array
*tr
, unsigned int trace_ctx
,
3034 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
3036 if (rcu_is_watching()) {
3037 __ftrace_trace_stack(tr
, buffer
, trace_ctx
, skip
, NULL
);
3041 if (WARN_ON_ONCE(IS_ENABLED(CONFIG_GENERIC_ENTRY
)))
3045 * When an NMI triggers, RCU is enabled via ct_nmi_enter(),
3046 * but if the above rcu_is_watching() failed, then the NMI
3047 * triggered someplace critical, and ct_irq_enter() should
3048 * not be called from NMI.
3050 if (unlikely(in_nmi()))
3053 ct_irq_enter_irqson();
3054 __ftrace_trace_stack(tr
, buffer
, trace_ctx
, skip
, NULL
);
3055 ct_irq_exit_irqson();
3059 * trace_dump_stack - record a stack back trace in the trace buffer
3060 * @skip: Number of functions to skip (helper handlers)
3062 void trace_dump_stack(int skip
)
3064 if (tracing_disabled
|| tracing_selftest_running
)
3067 #ifndef CONFIG_UNWINDER_ORC
3068 /* Skip 1 to skip this function. */
3071 __ftrace_trace_stack(printk_trace
, printk_trace
->array_buffer
.buffer
,
3072 tracing_gen_ctx(), skip
, NULL
);
3074 EXPORT_SYMBOL_GPL(trace_dump_stack
);
3076 #ifdef CONFIG_USER_STACKTRACE_SUPPORT
3077 static DEFINE_PER_CPU(int, user_stack_count
);
3080 ftrace_trace_userstack(struct trace_array
*tr
,
3081 struct trace_buffer
*buffer
, unsigned int trace_ctx
)
3083 struct ring_buffer_event
*event
;
3084 struct userstack_entry
*entry
;
3086 if (!(tr
->trace_flags
& TRACE_ITER_USERSTACKTRACE
))
3090 * NMIs can not handle page faults, even with fix ups.
3091 * The save user stack can (and often does) fault.
3093 if (unlikely(in_nmi()))
3097 * prevent recursion, since the user stack tracing may
3098 * trigger other kernel events.
3101 if (__this_cpu_read(user_stack_count
))
3104 __this_cpu_inc(user_stack_count
);
3106 event
= __trace_buffer_lock_reserve(buffer
, TRACE_USER_STACK
,
3107 sizeof(*entry
), trace_ctx
);
3109 goto out_drop_count
;
3110 entry
= ring_buffer_event_data(event
);
3112 entry
->tgid
= current
->tgid
;
3113 memset(&entry
->caller
, 0, sizeof(entry
->caller
));
3115 stack_trace_save_user(entry
->caller
, FTRACE_STACK_ENTRIES
);
3116 __buffer_unlock_commit(buffer
, event
);
3119 __this_cpu_dec(user_stack_count
);
3123 #else /* CONFIG_USER_STACKTRACE_SUPPORT */
3124 static void ftrace_trace_userstack(struct trace_array
*tr
,
3125 struct trace_buffer
*buffer
,
3126 unsigned int trace_ctx
)
3129 #endif /* !CONFIG_USER_STACKTRACE_SUPPORT */
3131 #endif /* CONFIG_STACKTRACE */
3134 func_repeats_set_delta_ts(struct func_repeats_entry
*entry
,
3135 unsigned long long delta
)
3137 entry
->bottom_delta_ts
= delta
& U32_MAX
;
3138 entry
->top_delta_ts
= (delta
>> 32);
3141 void trace_last_func_repeats(struct trace_array
*tr
,
3142 struct trace_func_repeats
*last_info
,
3143 unsigned int trace_ctx
)
3145 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
3146 struct func_repeats_entry
*entry
;
3147 struct ring_buffer_event
*event
;
3150 event
= __trace_buffer_lock_reserve(buffer
, TRACE_FUNC_REPEATS
,
3151 sizeof(*entry
), trace_ctx
);
3155 delta
= ring_buffer_event_time_stamp(buffer
, event
) -
3156 last_info
->ts_last_call
;
3158 entry
= ring_buffer_event_data(event
);
3159 entry
->ip
= last_info
->ip
;
3160 entry
->parent_ip
= last_info
->parent_ip
;
3161 entry
->count
= last_info
->count
;
3162 func_repeats_set_delta_ts(entry
, delta
);
3164 __buffer_unlock_commit(buffer
, event
);
3167 /* created for use with alloc_percpu */
3168 struct trace_buffer_struct
{
3170 char buffer
[4][TRACE_BUF_SIZE
];
3173 static struct trace_buffer_struct __percpu
*trace_percpu_buffer
;
3176 * This allows for lockless recording. If we're nested too deeply, then
3177 * this returns NULL.
3179 static char *get_trace_buf(void)
3181 struct trace_buffer_struct
*buffer
= this_cpu_ptr(trace_percpu_buffer
);
3183 if (!trace_percpu_buffer
|| buffer
->nesting
>= 4)
3188 /* Interrupts must see nesting incremented before we use the buffer */
3190 return &buffer
->buffer
[buffer
->nesting
- 1][0];
3193 static void put_trace_buf(void)
3195 /* Don't let the decrement of nesting leak before this */
3197 this_cpu_dec(trace_percpu_buffer
->nesting
);
3200 static int alloc_percpu_trace_buffer(void)
3202 struct trace_buffer_struct __percpu
*buffers
;
3204 if (trace_percpu_buffer
)
3207 buffers
= alloc_percpu(struct trace_buffer_struct
);
3208 if (MEM_FAIL(!buffers
, "Could not allocate percpu trace_printk buffer"))
3211 trace_percpu_buffer
= buffers
;
3215 static int buffers_allocated
;
3217 void trace_printk_init_buffers(void)
3219 if (buffers_allocated
)
3222 if (alloc_percpu_trace_buffer())
3225 /* trace_printk() is for debug use only. Don't use it in production. */
3228 pr_warn("**********************************************************\n");
3229 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3231 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
3233 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
3234 pr_warn("** unsafe for production use. **\n");
3236 pr_warn("** If you see this message and you are not debugging **\n");
3237 pr_warn("** the kernel, report this immediately to your vendor! **\n");
3239 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3240 pr_warn("**********************************************************\n");
3242 /* Expand the buffers to set size */
3243 tracing_update_buffers(&global_trace
);
3245 buffers_allocated
= 1;
3248 * trace_printk_init_buffers() can be called by modules.
3249 * If that happens, then we need to start cmdline recording
3250 * directly here. If the global_trace.buffer is already
3251 * allocated here, then this was called by module code.
3253 if (global_trace
.array_buffer
.buffer
)
3254 tracing_start_cmdline_record();
3256 EXPORT_SYMBOL_GPL(trace_printk_init_buffers
);
3258 void trace_printk_start_comm(void)
3260 /* Start tracing comms if trace printk is set */
3261 if (!buffers_allocated
)
3263 tracing_start_cmdline_record();
3266 static void trace_printk_start_stop_comm(int enabled
)
3268 if (!buffers_allocated
)
3272 tracing_start_cmdline_record();
3274 tracing_stop_cmdline_record();
3278 * trace_vbprintk - write binary msg to tracing buffer
3279 * @ip: The address of the caller
3280 * @fmt: The string format to write to the buffer
3281 * @args: Arguments for @fmt
3283 int trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
)
3285 struct ring_buffer_event
*event
;
3286 struct trace_buffer
*buffer
;
3287 struct trace_array
*tr
= READ_ONCE(printk_trace
);
3288 struct bprint_entry
*entry
;
3289 unsigned int trace_ctx
;
3293 if (!printk_binsafe(tr
))
3294 return trace_vprintk(ip
, fmt
, args
);
3296 if (unlikely(tracing_selftest_running
|| tracing_disabled
))
3299 /* Don't pollute graph traces with trace_vprintk internals */
3300 pause_graph_tracing();
3302 trace_ctx
= tracing_gen_ctx();
3303 preempt_disable_notrace();
3305 tbuffer
= get_trace_buf();
3311 len
= vbin_printf((u32
*)tbuffer
, TRACE_BUF_SIZE
/sizeof(int), fmt
, args
);
3313 if (len
> TRACE_BUF_SIZE
/sizeof(int) || len
< 0)
3316 size
= sizeof(*entry
) + sizeof(u32
) * len
;
3317 buffer
= tr
->array_buffer
.buffer
;
3318 ring_buffer_nest_start(buffer
);
3319 event
= __trace_buffer_lock_reserve(buffer
, TRACE_BPRINT
, size
,
3323 entry
= ring_buffer_event_data(event
);
3327 memcpy(entry
->buf
, tbuffer
, sizeof(u32
) * len
);
3328 __buffer_unlock_commit(buffer
, event
);
3329 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 6, NULL
);
3332 ring_buffer_nest_end(buffer
);
3337 preempt_enable_notrace();
3338 unpause_graph_tracing();
3342 EXPORT_SYMBOL_GPL(trace_vbprintk
);
3346 __trace_array_vprintk(struct trace_buffer
*buffer
,
3347 unsigned long ip
, const char *fmt
, va_list args
)
3349 struct ring_buffer_event
*event
;
3351 struct print_entry
*entry
;
3352 unsigned int trace_ctx
;
3355 if (tracing_disabled
)
3358 /* Don't pollute graph traces with trace_vprintk internals */
3359 pause_graph_tracing();
3361 trace_ctx
= tracing_gen_ctx();
3362 preempt_disable_notrace();
3365 tbuffer
= get_trace_buf();
3371 len
= vscnprintf(tbuffer
, TRACE_BUF_SIZE
, fmt
, args
);
3373 size
= sizeof(*entry
) + len
+ 1;
3374 ring_buffer_nest_start(buffer
);
3375 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, size
,
3379 entry
= ring_buffer_event_data(event
);
3382 memcpy(&entry
->buf
, tbuffer
, len
+ 1);
3383 __buffer_unlock_commit(buffer
, event
);
3384 ftrace_trace_stack(printk_trace
, buffer
, trace_ctx
, 6, NULL
);
3387 ring_buffer_nest_end(buffer
);
3391 preempt_enable_notrace();
3392 unpause_graph_tracing();
3398 int trace_array_vprintk(struct trace_array
*tr
,
3399 unsigned long ip
, const char *fmt
, va_list args
)
3401 if (tracing_selftest_running
&& tr
== &global_trace
)
3404 return __trace_array_vprintk(tr
->array_buffer
.buffer
, ip
, fmt
, args
);
3408 * trace_array_printk - Print a message to a specific instance
3409 * @tr: The instance trace_array descriptor
3410 * @ip: The instruction pointer that this is called from.
3411 * @fmt: The format to print (printf format)
3413 * If a subsystem sets up its own instance, they have the right to
3414 * printk strings into their tracing instance buffer using this
3415 * function. Note, this function will not write into the top level
3416 * buffer (use trace_printk() for that), as writing into the top level
3417 * buffer should only have events that can be individually disabled.
3418 * trace_printk() is only used for debugging a kernel, and should not
3419 * be ever incorporated in normal use.
3421 * trace_array_printk() can be used, as it will not add noise to the
3422 * top level tracing buffer.
3424 * Note, trace_array_init_printk() must be called on @tr before this
3428 int trace_array_printk(struct trace_array
*tr
,
3429 unsigned long ip
, const char *fmt
, ...)
3437 /* This is only allowed for created instances */
3438 if (tr
== &global_trace
)
3441 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
3445 ret
= trace_array_vprintk(tr
, ip
, fmt
, ap
);
3449 EXPORT_SYMBOL_GPL(trace_array_printk
);
3452 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3453 * @tr: The trace array to initialize the buffers for
3455 * As trace_array_printk() only writes into instances, they are OK to
3456 * have in the kernel (unlike trace_printk()). This needs to be called
3457 * before trace_array_printk() can be used on a trace_array.
3459 int trace_array_init_printk(struct trace_array
*tr
)
3464 /* This is only allowed for created instances */
3465 if (tr
== &global_trace
)
3468 return alloc_percpu_trace_buffer();
3470 EXPORT_SYMBOL_GPL(trace_array_init_printk
);
3473 int trace_array_printk_buf(struct trace_buffer
*buffer
,
3474 unsigned long ip
, const char *fmt
, ...)
3479 if (!(printk_trace
->trace_flags
& TRACE_ITER_PRINTK
))
3483 ret
= __trace_array_vprintk(buffer
, ip
, fmt
, ap
);
3489 int trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
)
3491 return trace_array_vprintk(printk_trace
, ip
, fmt
, args
);
3493 EXPORT_SYMBOL_GPL(trace_vprintk
);
3495 static void trace_iterator_increment(struct trace_iterator
*iter
)
3497 struct ring_buffer_iter
*buf_iter
= trace_buffer_iter(iter
, iter
->cpu
);
3501 ring_buffer_iter_advance(buf_iter
);
3504 static struct trace_entry
*
3505 peek_next_entry(struct trace_iterator
*iter
, int cpu
, u64
*ts
,
3506 unsigned long *lost_events
)
3508 struct ring_buffer_event
*event
;
3509 struct ring_buffer_iter
*buf_iter
= trace_buffer_iter(iter
, cpu
);
3512 event
= ring_buffer_iter_peek(buf_iter
, ts
);
3514 *lost_events
= ring_buffer_iter_dropped(buf_iter
) ?
3515 (unsigned long)-1 : 0;
3517 event
= ring_buffer_peek(iter
->array_buffer
->buffer
, cpu
, ts
,
3522 iter
->ent_size
= ring_buffer_event_length(event
);
3523 return ring_buffer_event_data(event
);
3529 static struct trace_entry
*
3530 __find_next_entry(struct trace_iterator
*iter
, int *ent_cpu
,
3531 unsigned long *missing_events
, u64
*ent_ts
)
3533 struct trace_buffer
*buffer
= iter
->array_buffer
->buffer
;
3534 struct trace_entry
*ent
, *next
= NULL
;
3535 unsigned long lost_events
= 0, next_lost
= 0;
3536 int cpu_file
= iter
->cpu_file
;
3537 u64 next_ts
= 0, ts
;
3543 * If we are in a per_cpu trace file, don't bother by iterating over
3544 * all cpu and peek directly.
3546 if (cpu_file
> RING_BUFFER_ALL_CPUS
) {
3547 if (ring_buffer_empty_cpu(buffer
, cpu_file
))
3549 ent
= peek_next_entry(iter
, cpu_file
, ent_ts
, missing_events
);
3551 *ent_cpu
= cpu_file
;
3556 for_each_tracing_cpu(cpu
) {
3558 if (ring_buffer_empty_cpu(buffer
, cpu
))
3561 ent
= peek_next_entry(iter
, cpu
, &ts
, &lost_events
);
3564 * Pick the entry with the smallest timestamp:
3566 if (ent
&& (!next
|| ts
< next_ts
)) {
3570 next_lost
= lost_events
;
3571 next_size
= iter
->ent_size
;
3575 iter
->ent_size
= next_size
;
3578 *ent_cpu
= next_cpu
;
3584 *missing_events
= next_lost
;
3589 #define STATIC_FMT_BUF_SIZE 128
3590 static char static_fmt_buf
[STATIC_FMT_BUF_SIZE
];
3592 char *trace_iter_expand_format(struct trace_iterator
*iter
)
3597 * iter->tr is NULL when used with tp_printk, which makes
3598 * this get called where it is not safe to call krealloc().
3600 if (!iter
->tr
|| iter
->fmt
== static_fmt_buf
)
3603 tmp
= krealloc(iter
->fmt
, iter
->fmt_size
+ STATIC_FMT_BUF_SIZE
,
3606 iter
->fmt_size
+= STATIC_FMT_BUF_SIZE
;
3613 /* Returns true if the string is safe to dereference from an event */
3614 static bool trace_safe_str(struct trace_iterator
*iter
, const char *str
,
3617 unsigned long addr
= (unsigned long)str
;
3618 struct trace_event
*trace_event
;
3619 struct trace_event_call
*event
;
3621 /* Ignore strings with no length */
3625 /* OK if part of the event data */
3626 if ((addr
>= (unsigned long)iter
->ent
) &&
3627 (addr
< (unsigned long)iter
->ent
+ iter
->ent_size
))
3630 /* OK if part of the temp seq buffer */
3631 if ((addr
>= (unsigned long)iter
->tmp_seq
.buffer
) &&
3632 (addr
< (unsigned long)iter
->tmp_seq
.buffer
+ TRACE_SEQ_BUFFER_SIZE
))
3635 /* Core rodata can not be freed */
3636 if (is_kernel_rodata(addr
))
3639 if (trace_is_tracepoint_string(str
))
3643 * Now this could be a module event, referencing core module
3644 * data, which is OK.
3649 trace_event
= ftrace_find_event(iter
->ent
->type
);
3653 event
= container_of(trace_event
, struct trace_event_call
, event
);
3654 if ((event
->flags
& TRACE_EVENT_FL_DYNAMIC
) || !event
->module
)
3657 /* Would rather have rodata, but this will suffice */
3658 if (within_module_core(addr
, event
->module
))
3664 static DEFINE_STATIC_KEY_FALSE(trace_no_verify
);
3666 static int test_can_verify_check(const char *fmt
, ...)
3673 * The verifier is dependent on vsnprintf() modifies the va_list
3674 * passed to it, where it is sent as a reference. Some architectures
3675 * (like x86_32) passes it by value, which means that vsnprintf()
3676 * does not modify the va_list passed to it, and the verifier
3677 * would then need to be able to understand all the values that
3678 * vsnprintf can use. If it is passed by value, then the verifier
3682 vsnprintf(buf
, 16, "%d", ap
);
3683 ret
= va_arg(ap
, int);
3689 static void test_can_verify(void)
3691 if (!test_can_verify_check("%d %d", 0, 1)) {
3692 pr_info("trace event string verifier disabled\n");
3693 static_branch_inc(&trace_no_verify
);
3698 * trace_check_vprintf - Check dereferenced strings while writing to the seq buffer
3699 * @iter: The iterator that holds the seq buffer and the event being printed
3700 * @fmt: The format used to print the event
3701 * @ap: The va_list holding the data to print from @fmt.
3703 * This writes the data into the @iter->seq buffer using the data from
3704 * @fmt and @ap. If the format has a %s, then the source of the string
3705 * is examined to make sure it is safe to print, otherwise it will
3706 * warn and print "[UNSAFE MEMORY]" in place of the dereferenced string
3709 void trace_check_vprintf(struct trace_iterator
*iter
, const char *fmt
,
3712 long text_delta
= 0;
3713 long data_delta
= 0;
3714 const char *p
= fmt
;
3719 if (WARN_ON_ONCE(!fmt
))
3722 if (static_branch_unlikely(&trace_no_verify
))
3726 * When the kernel is booted with the tp_printk command line
3727 * parameter, trace events go directly through to printk().
3728 * It also is checked by this function, but it does not
3729 * have an associated trace_array (tr) for it.
3732 text_delta
= iter
->tr
->text_delta
;
3733 data_delta
= iter
->tr
->data_delta
;
3736 /* Don't bother checking when doing a ftrace_dump() */
3737 if (iter
->fmt
== static_fmt_buf
)
3747 * We only care about %s and variants
3748 * as well as %p[sS] if delta is non-zero
3750 for (i
= 0; p
[i
]; i
++) {
3751 if (i
+ 1 >= iter
->fmt_size
) {
3753 * If we can't expand the copy buffer,
3756 if (!trace_iter_expand_format(iter
))
3760 if (p
[i
] == '\\' && p
[i
+1]) {
3765 /* Need to test cases like %08.*s */
3766 for (j
= 1; p
[i
+j
]; j
++) {
3767 if (isdigit(p
[i
+j
]) ||
3770 if (p
[i
+j
] == '*') {
3779 if (text_delta
&& p
[i
+1] == 'p' &&
3780 ((p
[i
+2] == 's' || p
[i
+2] == 'S')))
3787 /* If no %s found then just print normally */
3791 /* Copy up to the %s, and print that */
3792 strncpy(iter
->fmt
, p
, i
);
3793 iter
->fmt
[i
] = '\0';
3794 trace_seq_vprintf(&iter
->seq
, iter
->fmt
, ap
);
3796 /* Add delta to %pS pointers */
3797 if (p
[i
+1] == 'p') {
3803 fmt
[2] = p
[i
+2]; /* Either %ps or %pS */
3806 addr
= va_arg(ap
, unsigned long);
3808 trace_seq_printf(&iter
->seq
, fmt
, (void *)addr
);
3815 * If iter->seq is full, the above call no longer guarantees
3816 * that ap is in sync with fmt processing, and further calls
3817 * to va_arg() can return wrong positional arguments.
3819 * Ensure that ap is no longer used in this case.
3821 if (iter
->seq
.full
) {
3827 len
= va_arg(ap
, int);
3829 /* The ap now points to the string data of the %s */
3830 str
= va_arg(ap
, const char *);
3832 good
= trace_safe_str(iter
, str
, star
, len
);
3834 /* Could be from the last boot */
3835 if (data_delta
&& !good
) {
3837 good
= trace_safe_str(iter
, str
, star
, len
);
3841 * If you hit this warning, it is likely that the
3842 * trace event in question used %s on a string that
3843 * was saved at the time of the event, but may not be
3844 * around when the trace is read. Use __string(),
3845 * __assign_str() and __get_str() helpers in the TRACE_EVENT()
3846 * instead. See samples/trace_events/trace-events-sample.h
3849 if (WARN_ONCE(!good
, "fmt: '%s' current_buffer: '%s'",
3850 fmt
, seq_buf_str(&iter
->seq
.seq
))) {
3853 /* Try to safely read the string */
3855 if (len
+ 1 > iter
->fmt_size
)
3856 len
= iter
->fmt_size
- 1;
3859 ret
= copy_from_kernel_nofault(iter
->fmt
, str
, len
);
3863 ret
= strncpy_from_kernel_nofault(iter
->fmt
, str
,
3867 trace_seq_printf(&iter
->seq
, "(0x%px)", str
);
3869 trace_seq_printf(&iter
->seq
, "(0x%px:%s)",
3871 str
= "[UNSAFE-MEMORY]";
3872 strcpy(iter
->fmt
, "%s");
3874 strncpy(iter
->fmt
, p
+ i
, j
+ 1);
3875 iter
->fmt
[j
+1] = '\0';
3878 trace_seq_printf(&iter
->seq
, iter
->fmt
, len
, str
);
3880 trace_seq_printf(&iter
->seq
, iter
->fmt
, str
);
3886 trace_seq_vprintf(&iter
->seq
, p
, ap
);
3889 const char *trace_event_format(struct trace_iterator
*iter
, const char *fmt
)
3891 const char *p
, *new_fmt
;
3894 if (WARN_ON_ONCE(!fmt
))
3897 if (!iter
->tr
|| iter
->tr
->trace_flags
& TRACE_ITER_HASH_PTR
)
3901 new_fmt
= q
= iter
->fmt
;
3903 if (unlikely(q
- new_fmt
+ 3 > iter
->fmt_size
)) {
3904 if (!trace_iter_expand_format(iter
))
3907 q
+= iter
->fmt
- new_fmt
;
3908 new_fmt
= iter
->fmt
;
3913 /* Replace %p with %px */
3917 } else if (p
[0] == 'p' && !isalnum(p
[1])) {
3928 #define STATIC_TEMP_BUF_SIZE 128
3929 static char static_temp_buf
[STATIC_TEMP_BUF_SIZE
] __aligned(4);
3931 /* Find the next real entry, without updating the iterator itself */
3932 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
3933 int *ent_cpu
, u64
*ent_ts
)
3935 /* __find_next_entry will reset ent_size */
3936 int ent_size
= iter
->ent_size
;
3937 struct trace_entry
*entry
;
3940 * If called from ftrace_dump(), then the iter->temp buffer
3941 * will be the static_temp_buf and not created from kmalloc.
3942 * If the entry size is greater than the buffer, we can
3943 * not save it. Just return NULL in that case. This is only
3944 * used to add markers when two consecutive events' time
3945 * stamps have a large delta. See trace_print_lat_context()
3947 if (iter
->temp
== static_temp_buf
&&
3948 STATIC_TEMP_BUF_SIZE
< ent_size
)
3952 * The __find_next_entry() may call peek_next_entry(), which may
3953 * call ring_buffer_peek() that may make the contents of iter->ent
3954 * undefined. Need to copy iter->ent now.
3956 if (iter
->ent
&& iter
->ent
!= iter
->temp
) {
3957 if ((!iter
->temp
|| iter
->temp_size
< iter
->ent_size
) &&
3958 !WARN_ON_ONCE(iter
->temp
== static_temp_buf
)) {
3960 temp
= kmalloc(iter
->ent_size
, GFP_KERNEL
);
3965 iter
->temp_size
= iter
->ent_size
;
3967 memcpy(iter
->temp
, iter
->ent
, iter
->ent_size
);
3968 iter
->ent
= iter
->temp
;
3970 entry
= __find_next_entry(iter
, ent_cpu
, NULL
, ent_ts
);
3971 /* Put back the original ent_size */
3972 iter
->ent_size
= ent_size
;
3977 /* Find the next real entry, and increment the iterator to the next entry */
3978 void *trace_find_next_entry_inc(struct trace_iterator
*iter
)
3980 iter
->ent
= __find_next_entry(iter
, &iter
->cpu
,
3981 &iter
->lost_events
, &iter
->ts
);
3984 trace_iterator_increment(iter
);
3986 return iter
->ent
? iter
: NULL
;
3989 static void trace_consume(struct trace_iterator
*iter
)
3991 ring_buffer_consume(iter
->array_buffer
->buffer
, iter
->cpu
, &iter
->ts
,
3992 &iter
->lost_events
);
3995 static void *s_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
3997 struct trace_iterator
*iter
= m
->private;
4001 WARN_ON_ONCE(iter
->leftover
);
4005 /* can't go backwards */
4010 ent
= trace_find_next_entry_inc(iter
);
4014 while (ent
&& iter
->idx
< i
)
4015 ent
= trace_find_next_entry_inc(iter
);
4022 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
)
4024 struct ring_buffer_iter
*buf_iter
;
4025 unsigned long entries
= 0;
4028 per_cpu_ptr(iter
->array_buffer
->data
, cpu
)->skipped_entries
= 0;
4030 buf_iter
= trace_buffer_iter(iter
, cpu
);
4034 ring_buffer_iter_reset(buf_iter
);
4037 * We could have the case with the max latency tracers
4038 * that a reset never took place on a cpu. This is evident
4039 * by the timestamp being before the start of the buffer.
4041 while (ring_buffer_iter_peek(buf_iter
, &ts
)) {
4042 if (ts
>= iter
->array_buffer
->time_start
)
4045 ring_buffer_iter_advance(buf_iter
);
4046 /* This could be a big loop */
4050 per_cpu_ptr(iter
->array_buffer
->data
, cpu
)->skipped_entries
= entries
;
4054 * The current tracer is copied to avoid a global locking
4057 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
4059 struct trace_iterator
*iter
= m
->private;
4060 struct trace_array
*tr
= iter
->tr
;
4061 int cpu_file
= iter
->cpu_file
;
4066 mutex_lock(&trace_types_lock
);
4067 if (unlikely(tr
->current_trace
!= iter
->trace
)) {
4068 /* Close iter->trace before switching to the new current tracer */
4069 if (iter
->trace
->close
)
4070 iter
->trace
->close(iter
);
4071 iter
->trace
= tr
->current_trace
;
4072 /* Reopen the new current tracer */
4073 if (iter
->trace
->open
)
4074 iter
->trace
->open(iter
);
4076 mutex_unlock(&trace_types_lock
);
4078 #ifdef CONFIG_TRACER_MAX_TRACE
4079 if (iter
->snapshot
&& iter
->trace
->use_max_tr
)
4080 return ERR_PTR(-EBUSY
);
4083 if (*pos
!= iter
->pos
) {
4088 if (cpu_file
== RING_BUFFER_ALL_CPUS
) {
4089 for_each_tracing_cpu(cpu
)
4090 tracing_iter_reset(iter
, cpu
);
4092 tracing_iter_reset(iter
, cpu_file
);
4095 for (p
= iter
; p
&& l
< *pos
; p
= s_next(m
, p
, &l
))
4100 * If we overflowed the seq_file before, then we want
4101 * to just reuse the trace_seq buffer again.
4107 p
= s_next(m
, p
, &l
);
4111 trace_event_read_lock();
4112 trace_access_lock(cpu_file
);
4116 static void s_stop(struct seq_file
*m
, void *p
)
4118 struct trace_iterator
*iter
= m
->private;
4120 #ifdef CONFIG_TRACER_MAX_TRACE
4121 if (iter
->snapshot
&& iter
->trace
->use_max_tr
)
4125 trace_access_unlock(iter
->cpu_file
);
4126 trace_event_read_unlock();
4130 get_total_entries_cpu(struct array_buffer
*buf
, unsigned long *total
,
4131 unsigned long *entries
, int cpu
)
4133 unsigned long count
;
4135 count
= ring_buffer_entries_cpu(buf
->buffer
, cpu
);
4137 * If this buffer has skipped entries, then we hold all
4138 * entries for the trace and we need to ignore the
4139 * ones before the time stamp.
4141 if (per_cpu_ptr(buf
->data
, cpu
)->skipped_entries
) {
4142 count
-= per_cpu_ptr(buf
->data
, cpu
)->skipped_entries
;
4143 /* total is the same as the entries */
4147 ring_buffer_overrun_cpu(buf
->buffer
, cpu
);
4152 get_total_entries(struct array_buffer
*buf
,
4153 unsigned long *total
, unsigned long *entries
)
4161 for_each_tracing_cpu(cpu
) {
4162 get_total_entries_cpu(buf
, &t
, &e
, cpu
);
4168 unsigned long trace_total_entries_cpu(struct trace_array
*tr
, int cpu
)
4170 unsigned long total
, entries
;
4175 get_total_entries_cpu(&tr
->array_buffer
, &total
, &entries
, cpu
);
4180 unsigned long trace_total_entries(struct trace_array
*tr
)
4182 unsigned long total
, entries
;
4187 get_total_entries(&tr
->array_buffer
, &total
, &entries
);
4192 static void print_lat_help_header(struct seq_file
*m
)
4194 seq_puts(m
, "# _------=> CPU# \n"
4195 "# / _-----=> irqs-off/BH-disabled\n"
4196 "# | / _----=> need-resched \n"
4197 "# || / _---=> hardirq/softirq \n"
4198 "# ||| / _--=> preempt-depth \n"
4199 "# |||| / _-=> migrate-disable \n"
4200 "# ||||| / delay \n"
4201 "# cmd pid |||||| time | caller \n"
4202 "# \\ / |||||| \\ | / \n");
4205 static void print_event_info(struct array_buffer
*buf
, struct seq_file
*m
)
4207 unsigned long total
;
4208 unsigned long entries
;
4210 get_total_entries(buf
, &total
, &entries
);
4211 seq_printf(m
, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
4212 entries
, total
, num_online_cpus());
4216 static void print_func_help_header(struct array_buffer
*buf
, struct seq_file
*m
,
4219 bool tgid
= flags
& TRACE_ITER_RECORD_TGID
;
4221 print_event_info(buf
, m
);
4223 seq_printf(m
, "# TASK-PID %s CPU# TIMESTAMP FUNCTION\n", tgid
? " TGID " : "");
4224 seq_printf(m
, "# | | %s | | |\n", tgid
? " | " : "");
4227 static void print_func_help_header_irq(struct array_buffer
*buf
, struct seq_file
*m
,
4230 bool tgid
= flags
& TRACE_ITER_RECORD_TGID
;
4231 static const char space
[] = " ";
4232 int prec
= tgid
? 12 : 2;
4234 print_event_info(buf
, m
);
4236 seq_printf(m
, "# %.*s _-----=> irqs-off/BH-disabled\n", prec
, space
);
4237 seq_printf(m
, "# %.*s / _----=> need-resched\n", prec
, space
);
4238 seq_printf(m
, "# %.*s| / _---=> hardirq/softirq\n", prec
, space
);
4239 seq_printf(m
, "# %.*s|| / _--=> preempt-depth\n", prec
, space
);
4240 seq_printf(m
, "# %.*s||| / _-=> migrate-disable\n", prec
, space
);
4241 seq_printf(m
, "# %.*s|||| / delay\n", prec
, space
);
4242 seq_printf(m
, "# TASK-PID %.*s CPU# ||||| TIMESTAMP FUNCTION\n", prec
, " TGID ");
4243 seq_printf(m
, "# | | %.*s | ||||| | |\n", prec
, " | ");
4247 print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
)
4249 unsigned long sym_flags
= (global_trace
.trace_flags
& TRACE_ITER_SYM_MASK
);
4250 struct array_buffer
*buf
= iter
->array_buffer
;
4251 struct trace_array_cpu
*data
= per_cpu_ptr(buf
->data
, buf
->cpu
);
4252 struct tracer
*type
= iter
->trace
;
4253 unsigned long entries
;
4254 unsigned long total
;
4255 const char *name
= type
->name
;
4257 get_total_entries(buf
, &total
, &entries
);
4259 seq_printf(m
, "# %s latency trace v1.1.5 on %s\n",
4260 name
, init_utsname()->release
);
4261 seq_puts(m
, "# -----------------------------------"
4262 "---------------------------------\n");
4263 seq_printf(m
, "# latency: %lu us, #%lu/%lu, CPU#%d |"
4264 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
4265 nsecs_to_usecs(data
->saved_latency
),
4269 preempt_model_none() ? "server" :
4270 preempt_model_voluntary() ? "desktop" :
4271 preempt_model_full() ? "preempt" :
4272 preempt_model_rt() ? "preempt_rt" :
4274 /* These are reserved for later use */
4277 seq_printf(m
, " #P:%d)\n", num_online_cpus());
4281 seq_puts(m
, "# -----------------\n");
4282 seq_printf(m
, "# | task: %.16s-%d "
4283 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
4284 data
->comm
, data
->pid
,
4285 from_kuid_munged(seq_user_ns(m
), data
->uid
), data
->nice
,
4286 data
->policy
, data
->rt_priority
);
4287 seq_puts(m
, "# -----------------\n");
4289 if (data
->critical_start
) {
4290 seq_puts(m
, "# => started at: ");
4291 seq_print_ip_sym(&iter
->seq
, data
->critical_start
, sym_flags
);
4292 trace_print_seq(m
, &iter
->seq
);
4293 seq_puts(m
, "\n# => ended at: ");
4294 seq_print_ip_sym(&iter
->seq
, data
->critical_end
, sym_flags
);
4295 trace_print_seq(m
, &iter
->seq
);
4296 seq_puts(m
, "\n#\n");
4302 static void test_cpu_buff_start(struct trace_iterator
*iter
)
4304 struct trace_seq
*s
= &iter
->seq
;
4305 struct trace_array
*tr
= iter
->tr
;
4307 if (!(tr
->trace_flags
& TRACE_ITER_ANNOTATE
))
4310 if (!(iter
->iter_flags
& TRACE_FILE_ANNOTATE
))
4313 if (cpumask_available(iter
->started
) &&
4314 cpumask_test_cpu(iter
->cpu
, iter
->started
))
4317 if (per_cpu_ptr(iter
->array_buffer
->data
, iter
->cpu
)->skipped_entries
)
4320 if (cpumask_available(iter
->started
))
4321 cpumask_set_cpu(iter
->cpu
, iter
->started
);
4323 /* Don't print started cpu buffer for the first entry of the trace */
4325 trace_seq_printf(s
, "##### CPU %u buffer started ####\n",
4329 static enum print_line_t
print_trace_fmt(struct trace_iterator
*iter
)
4331 struct trace_array
*tr
= iter
->tr
;
4332 struct trace_seq
*s
= &iter
->seq
;
4333 unsigned long sym_flags
= (tr
->trace_flags
& TRACE_ITER_SYM_MASK
);
4334 struct trace_entry
*entry
;
4335 struct trace_event
*event
;
4339 test_cpu_buff_start(iter
);
4341 event
= ftrace_find_event(entry
->type
);
4343 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4344 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
)
4345 trace_print_lat_context(iter
);
4347 trace_print_context(iter
);
4350 if (trace_seq_has_overflowed(s
))
4351 return TRACE_TYPE_PARTIAL_LINE
;
4354 if (tr
->trace_flags
& TRACE_ITER_FIELDS
)
4355 return print_event_fields(iter
, event
);
4356 return event
->funcs
->trace(iter
, sym_flags
, event
);
4359 trace_seq_printf(s
, "Unknown type %d\n", entry
->type
);
4361 return trace_handle_return(s
);
4364 static enum print_line_t
print_raw_fmt(struct trace_iterator
*iter
)
4366 struct trace_array
*tr
= iter
->tr
;
4367 struct trace_seq
*s
= &iter
->seq
;
4368 struct trace_entry
*entry
;
4369 struct trace_event
*event
;
4373 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
)
4374 trace_seq_printf(s
, "%d %d %llu ",
4375 entry
->pid
, iter
->cpu
, iter
->ts
);
4377 if (trace_seq_has_overflowed(s
))
4378 return TRACE_TYPE_PARTIAL_LINE
;
4380 event
= ftrace_find_event(entry
->type
);
4382 return event
->funcs
->raw(iter
, 0, event
);
4384 trace_seq_printf(s
, "%d ?\n", entry
->type
);
4386 return trace_handle_return(s
);
4389 static enum print_line_t
print_hex_fmt(struct trace_iterator
*iter
)
4391 struct trace_array
*tr
= iter
->tr
;
4392 struct trace_seq
*s
= &iter
->seq
;
4393 unsigned char newline
= '\n';
4394 struct trace_entry
*entry
;
4395 struct trace_event
*event
;
4399 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4400 SEQ_PUT_HEX_FIELD(s
, entry
->pid
);
4401 SEQ_PUT_HEX_FIELD(s
, iter
->cpu
);
4402 SEQ_PUT_HEX_FIELD(s
, iter
->ts
);
4403 if (trace_seq_has_overflowed(s
))
4404 return TRACE_TYPE_PARTIAL_LINE
;
4407 event
= ftrace_find_event(entry
->type
);
4409 enum print_line_t ret
= event
->funcs
->hex(iter
, 0, event
);
4410 if (ret
!= TRACE_TYPE_HANDLED
)
4414 SEQ_PUT_FIELD(s
, newline
);
4416 return trace_handle_return(s
);
4419 static enum print_line_t
print_bin_fmt(struct trace_iterator
*iter
)
4421 struct trace_array
*tr
= iter
->tr
;
4422 struct trace_seq
*s
= &iter
->seq
;
4423 struct trace_entry
*entry
;
4424 struct trace_event
*event
;
4428 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4429 SEQ_PUT_FIELD(s
, entry
->pid
);
4430 SEQ_PUT_FIELD(s
, iter
->cpu
);
4431 SEQ_PUT_FIELD(s
, iter
->ts
);
4432 if (trace_seq_has_overflowed(s
))
4433 return TRACE_TYPE_PARTIAL_LINE
;
4436 event
= ftrace_find_event(entry
->type
);
4437 return event
? event
->funcs
->binary(iter
, 0, event
) :
4441 int trace_empty(struct trace_iterator
*iter
)
4443 struct ring_buffer_iter
*buf_iter
;
4446 /* If we are looking at one CPU buffer, only check that one */
4447 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
4448 cpu
= iter
->cpu_file
;
4449 buf_iter
= trace_buffer_iter(iter
, cpu
);
4451 if (!ring_buffer_iter_empty(buf_iter
))
4454 if (!ring_buffer_empty_cpu(iter
->array_buffer
->buffer
, cpu
))
4460 for_each_tracing_cpu(cpu
) {
4461 buf_iter
= trace_buffer_iter(iter
, cpu
);
4463 if (!ring_buffer_iter_empty(buf_iter
))
4466 if (!ring_buffer_empty_cpu(iter
->array_buffer
->buffer
, cpu
))
4474 /* Called with trace_event_read_lock() held. */
4475 enum print_line_t
print_trace_line(struct trace_iterator
*iter
)
4477 struct trace_array
*tr
= iter
->tr
;
4478 unsigned long trace_flags
= tr
->trace_flags
;
4479 enum print_line_t ret
;
4481 if (iter
->lost_events
) {
4482 if (iter
->lost_events
== (unsigned long)-1)
4483 trace_seq_printf(&iter
->seq
, "CPU:%d [LOST EVENTS]\n",
4486 trace_seq_printf(&iter
->seq
, "CPU:%d [LOST %lu EVENTS]\n",
4487 iter
->cpu
, iter
->lost_events
);
4488 if (trace_seq_has_overflowed(&iter
->seq
))
4489 return TRACE_TYPE_PARTIAL_LINE
;
4492 if (iter
->trace
&& iter
->trace
->print_line
) {
4493 ret
= iter
->trace
->print_line(iter
);
4494 if (ret
!= TRACE_TYPE_UNHANDLED
)
4498 if (iter
->ent
->type
== TRACE_BPUTS
&&
4499 trace_flags
& TRACE_ITER_PRINTK
&&
4500 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4501 return trace_print_bputs_msg_only(iter
);
4503 if (iter
->ent
->type
== TRACE_BPRINT
&&
4504 trace_flags
& TRACE_ITER_PRINTK
&&
4505 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4506 return trace_print_bprintk_msg_only(iter
);
4508 if (iter
->ent
->type
== TRACE_PRINT
&&
4509 trace_flags
& TRACE_ITER_PRINTK
&&
4510 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4511 return trace_print_printk_msg_only(iter
);
4513 if (trace_flags
& TRACE_ITER_BIN
)
4514 return print_bin_fmt(iter
);
4516 if (trace_flags
& TRACE_ITER_HEX
)
4517 return print_hex_fmt(iter
);
4519 if (trace_flags
& TRACE_ITER_RAW
)
4520 return print_raw_fmt(iter
);
4522 return print_trace_fmt(iter
);
4525 void trace_latency_header(struct seq_file
*m
)
4527 struct trace_iterator
*iter
= m
->private;
4528 struct trace_array
*tr
= iter
->tr
;
4530 /* print nothing if the buffers are empty */
4531 if (trace_empty(iter
))
4534 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
)
4535 print_trace_header(m
, iter
);
4537 if (!(tr
->trace_flags
& TRACE_ITER_VERBOSE
))
4538 print_lat_help_header(m
);
4541 void trace_default_header(struct seq_file
*m
)
4543 struct trace_iterator
*iter
= m
->private;
4544 struct trace_array
*tr
= iter
->tr
;
4545 unsigned long trace_flags
= tr
->trace_flags
;
4547 if (!(trace_flags
& TRACE_ITER_CONTEXT_INFO
))
4550 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
) {
4551 /* print nothing if the buffers are empty */
4552 if (trace_empty(iter
))
4554 print_trace_header(m
, iter
);
4555 if (!(trace_flags
& TRACE_ITER_VERBOSE
))
4556 print_lat_help_header(m
);
4558 if (!(trace_flags
& TRACE_ITER_VERBOSE
)) {
4559 if (trace_flags
& TRACE_ITER_IRQ_INFO
)
4560 print_func_help_header_irq(iter
->array_buffer
,
4563 print_func_help_header(iter
->array_buffer
, m
,
4569 static void test_ftrace_alive(struct seq_file
*m
)
4571 if (!ftrace_is_dead())
4573 seq_puts(m
, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
4574 "# MAY BE MISSING FUNCTION EVENTS\n");
4577 #ifdef CONFIG_TRACER_MAX_TRACE
4578 static void show_snapshot_main_help(struct seq_file
*m
)
4580 seq_puts(m
, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
4581 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4582 "# Takes a snapshot of the main buffer.\n"
4583 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
4584 "# (Doesn't have to be '2' works with any number that\n"
4585 "# is not a '0' or '1')\n");
4588 static void show_snapshot_percpu_help(struct seq_file
*m
)
4590 seq_puts(m
, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
4591 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
4592 seq_puts(m
, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4593 "# Takes a snapshot of the main buffer for this cpu.\n");
4595 seq_puts(m
, "# echo 1 > snapshot : Not supported with this kernel.\n"
4596 "# Must use main snapshot file to allocate.\n");
4598 seq_puts(m
, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
4599 "# (Doesn't have to be '2' works with any number that\n"
4600 "# is not a '0' or '1')\n");
4603 static void print_snapshot_help(struct seq_file
*m
, struct trace_iterator
*iter
)
4605 if (iter
->tr
->allocated_snapshot
)
4606 seq_puts(m
, "#\n# * Snapshot is allocated *\n#\n");
4608 seq_puts(m
, "#\n# * Snapshot is freed *\n#\n");
4610 seq_puts(m
, "# Snapshot commands:\n");
4611 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
)
4612 show_snapshot_main_help(m
);
4614 show_snapshot_percpu_help(m
);
4617 /* Should never be called */
4618 static inline void print_snapshot_help(struct seq_file
*m
, struct trace_iterator
*iter
) { }
4621 static int s_show(struct seq_file
*m
, void *v
)
4623 struct trace_iterator
*iter
= v
;
4626 if (iter
->ent
== NULL
) {
4628 seq_printf(m
, "# tracer: %s\n", iter
->trace
->name
);
4630 test_ftrace_alive(m
);
4632 if (iter
->snapshot
&& trace_empty(iter
))
4633 print_snapshot_help(m
, iter
);
4634 else if (iter
->trace
&& iter
->trace
->print_header
)
4635 iter
->trace
->print_header(m
);
4637 trace_default_header(m
);
4639 } else if (iter
->leftover
) {
4641 * If we filled the seq_file buffer earlier, we
4642 * want to just show it now.
4644 ret
= trace_print_seq(m
, &iter
->seq
);
4646 /* ret should this time be zero, but you never know */
4647 iter
->leftover
= ret
;
4650 ret
= print_trace_line(iter
);
4651 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
4653 trace_seq_puts(&iter
->seq
, "[LINE TOO BIG]\n");
4655 ret
= trace_print_seq(m
, &iter
->seq
);
4657 * If we overflow the seq_file buffer, then it will
4658 * ask us for this data again at start up.
4660 * ret is 0 if seq_file write succeeded.
4663 iter
->leftover
= ret
;
4670 * Should be used after trace_array_get(), trace_types_lock
4671 * ensures that i_cdev was already initialized.
4673 static inline int tracing_get_cpu(struct inode
*inode
)
4675 if (inode
->i_cdev
) /* See trace_create_cpu_file() */
4676 return (long)inode
->i_cdev
- 1;
4677 return RING_BUFFER_ALL_CPUS
;
4680 static const struct seq_operations tracer_seq_ops
= {
4688 * Note, as iter itself can be allocated and freed in different
4689 * ways, this function is only used to free its content, and not
4690 * the iterator itself. The only requirement to all the allocations
4691 * is that it must zero all fields (kzalloc), as freeing works with
4692 * ethier allocated content or NULL.
4694 static void free_trace_iter_content(struct trace_iterator
*iter
)
4696 /* The fmt is either NULL, allocated or points to static_fmt_buf */
4697 if (iter
->fmt
!= static_fmt_buf
)
4701 kfree(iter
->buffer_iter
);
4702 mutex_destroy(&iter
->mutex
);
4703 free_cpumask_var(iter
->started
);
4706 static struct trace_iterator
*
4707 __tracing_open(struct inode
*inode
, struct file
*file
, bool snapshot
)
4709 struct trace_array
*tr
= inode
->i_private
;
4710 struct trace_iterator
*iter
;
4713 if (tracing_disabled
)
4714 return ERR_PTR(-ENODEV
);
4716 iter
= __seq_open_private(file
, &tracer_seq_ops
, sizeof(*iter
));
4718 return ERR_PTR(-ENOMEM
);
4720 iter
->buffer_iter
= kcalloc(nr_cpu_ids
, sizeof(*iter
->buffer_iter
),
4722 if (!iter
->buffer_iter
)
4726 * trace_find_next_entry() may need to save off iter->ent.
4727 * It will place it into the iter->temp buffer. As most
4728 * events are less than 128, allocate a buffer of that size.
4729 * If one is greater, then trace_find_next_entry() will
4730 * allocate a new buffer to adjust for the bigger iter->ent.
4731 * It's not critical if it fails to get allocated here.
4733 iter
->temp
= kmalloc(128, GFP_KERNEL
);
4735 iter
->temp_size
= 128;
4738 * trace_event_printf() may need to modify given format
4739 * string to replace %p with %px so that it shows real address
4740 * instead of hash value. However, that is only for the event
4741 * tracing, other tracer may not need. Defer the allocation
4742 * until it is needed.
4747 mutex_lock(&trace_types_lock
);
4748 iter
->trace
= tr
->current_trace
;
4750 if (!zalloc_cpumask_var(&iter
->started
, GFP_KERNEL
))
4755 #ifdef CONFIG_TRACER_MAX_TRACE
4756 /* Currently only the top directory has a snapshot */
4757 if (tr
->current_trace
->print_max
|| snapshot
)
4758 iter
->array_buffer
= &tr
->max_buffer
;
4761 iter
->array_buffer
= &tr
->array_buffer
;
4762 iter
->snapshot
= snapshot
;
4764 iter
->cpu_file
= tracing_get_cpu(inode
);
4765 mutex_init(&iter
->mutex
);
4767 /* Notify the tracer early; before we stop tracing. */
4768 if (iter
->trace
->open
)
4769 iter
->trace
->open(iter
);
4771 /* Annotate start of buffers if we had overruns */
4772 if (ring_buffer_overruns(iter
->array_buffer
->buffer
))
4773 iter
->iter_flags
|= TRACE_FILE_ANNOTATE
;
4775 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
4776 if (trace_clocks
[tr
->clock_id
].in_ns
)
4777 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
4780 * If pause-on-trace is enabled, then stop the trace while
4781 * dumping, unless this is the "snapshot" file
4783 if (!iter
->snapshot
&& (tr
->trace_flags
& TRACE_ITER_PAUSE_ON_TRACE
))
4784 tracing_stop_tr(tr
);
4786 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
) {
4787 for_each_tracing_cpu(cpu
) {
4788 iter
->buffer_iter
[cpu
] =
4789 ring_buffer_read_prepare(iter
->array_buffer
->buffer
,
4792 ring_buffer_read_prepare_sync();
4793 for_each_tracing_cpu(cpu
) {
4794 ring_buffer_read_start(iter
->buffer_iter
[cpu
]);
4795 tracing_iter_reset(iter
, cpu
);
4798 cpu
= iter
->cpu_file
;
4799 iter
->buffer_iter
[cpu
] =
4800 ring_buffer_read_prepare(iter
->array_buffer
->buffer
,
4802 ring_buffer_read_prepare_sync();
4803 ring_buffer_read_start(iter
->buffer_iter
[cpu
]);
4804 tracing_iter_reset(iter
, cpu
);
4807 mutex_unlock(&trace_types_lock
);
4812 mutex_unlock(&trace_types_lock
);
4813 free_trace_iter_content(iter
);
4815 seq_release_private(inode
, file
);
4816 return ERR_PTR(-ENOMEM
);
4819 int tracing_open_generic(struct inode
*inode
, struct file
*filp
)
4823 ret
= tracing_check_open_get_tr(NULL
);
4827 filp
->private_data
= inode
->i_private
;
4831 bool tracing_is_disabled(void)
4833 return (tracing_disabled
) ? true: false;
4837 * Open and update trace_array ref count.
4838 * Must have the current trace_array passed to it.
4840 int tracing_open_generic_tr(struct inode
*inode
, struct file
*filp
)
4842 struct trace_array
*tr
= inode
->i_private
;
4845 ret
= tracing_check_open_get_tr(tr
);
4849 filp
->private_data
= inode
->i_private
;
4855 * The private pointer of the inode is the trace_event_file.
4856 * Update the tr ref count associated to it.
4858 int tracing_open_file_tr(struct inode
*inode
, struct file
*filp
)
4860 struct trace_event_file
*file
= inode
->i_private
;
4863 ret
= tracing_check_open_get_tr(file
->tr
);
4867 mutex_lock(&event_mutex
);
4869 /* Fail if the file is marked for removal */
4870 if (file
->flags
& EVENT_FILE_FL_FREED
) {
4871 trace_array_put(file
->tr
);
4874 event_file_get(file
);
4877 mutex_unlock(&event_mutex
);
4881 filp
->private_data
= inode
->i_private
;
4886 int tracing_release_file_tr(struct inode
*inode
, struct file
*filp
)
4888 struct trace_event_file
*file
= inode
->i_private
;
4890 trace_array_put(file
->tr
);
4891 event_file_put(file
);
4896 int tracing_single_release_file_tr(struct inode
*inode
, struct file
*filp
)
4898 tracing_release_file_tr(inode
, filp
);
4899 return single_release(inode
, filp
);
4902 static int tracing_mark_open(struct inode
*inode
, struct file
*filp
)
4904 stream_open(inode
, filp
);
4905 return tracing_open_generic_tr(inode
, filp
);
4908 static int tracing_release(struct inode
*inode
, struct file
*file
)
4910 struct trace_array
*tr
= inode
->i_private
;
4911 struct seq_file
*m
= file
->private_data
;
4912 struct trace_iterator
*iter
;
4915 if (!(file
->f_mode
& FMODE_READ
)) {
4916 trace_array_put(tr
);
4920 /* Writes do not use seq_file */
4922 mutex_lock(&trace_types_lock
);
4924 for_each_tracing_cpu(cpu
) {
4925 if (iter
->buffer_iter
[cpu
])
4926 ring_buffer_read_finish(iter
->buffer_iter
[cpu
]);
4929 if (iter
->trace
&& iter
->trace
->close
)
4930 iter
->trace
->close(iter
);
4932 if (!iter
->snapshot
&& tr
->stop_count
)
4933 /* reenable tracing if it was previously enabled */
4934 tracing_start_tr(tr
);
4936 __trace_array_put(tr
);
4938 mutex_unlock(&trace_types_lock
);
4940 free_trace_iter_content(iter
);
4941 seq_release_private(inode
, file
);
4946 int tracing_release_generic_tr(struct inode
*inode
, struct file
*file
)
4948 struct trace_array
*tr
= inode
->i_private
;
4950 trace_array_put(tr
);
4954 static int tracing_single_release_tr(struct inode
*inode
, struct file
*file
)
4956 struct trace_array
*tr
= inode
->i_private
;
4958 trace_array_put(tr
);
4960 return single_release(inode
, file
);
4963 static int tracing_open(struct inode
*inode
, struct file
*file
)
4965 struct trace_array
*tr
= inode
->i_private
;
4966 struct trace_iterator
*iter
;
4969 ret
= tracing_check_open_get_tr(tr
);
4973 /* If this file was open for write, then erase contents */
4974 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
)) {
4975 int cpu
= tracing_get_cpu(inode
);
4976 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
4978 #ifdef CONFIG_TRACER_MAX_TRACE
4979 if (tr
->current_trace
->print_max
)
4980 trace_buf
= &tr
->max_buffer
;
4983 if (cpu
== RING_BUFFER_ALL_CPUS
)
4984 tracing_reset_online_cpus(trace_buf
);
4986 tracing_reset_cpu(trace_buf
, cpu
);
4989 if (file
->f_mode
& FMODE_READ
) {
4990 iter
= __tracing_open(inode
, file
, false);
4992 ret
= PTR_ERR(iter
);
4993 else if (tr
->trace_flags
& TRACE_ITER_LATENCY_FMT
)
4994 iter
->iter_flags
|= TRACE_FILE_LAT_FMT
;
4998 trace_array_put(tr
);
5004 * Some tracers are not suitable for instance buffers.
5005 * A tracer is always available for the global array (toplevel)
5006 * or if it explicitly states that it is.
5009 trace_ok_for_array(struct tracer
*t
, struct trace_array
*tr
)
5011 #ifdef CONFIG_TRACER_SNAPSHOT
5012 /* arrays with mapped buffer range do not have snapshots */
5013 if (tr
->range_addr_start
&& t
->use_max_tr
)
5016 return (tr
->flags
& TRACE_ARRAY_FL_GLOBAL
) || t
->allow_instances
;
5019 /* Find the next tracer that this trace array may use */
5020 static struct tracer
*
5021 get_tracer_for_array(struct trace_array
*tr
, struct tracer
*t
)
5023 while (t
&& !trace_ok_for_array(t
, tr
))
5030 t_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
5032 struct trace_array
*tr
= m
->private;
5033 struct tracer
*t
= v
;
5038 t
= get_tracer_for_array(tr
, t
->next
);
5043 static void *t_start(struct seq_file
*m
, loff_t
*pos
)
5045 struct trace_array
*tr
= m
->private;
5049 mutex_lock(&trace_types_lock
);
5051 t
= get_tracer_for_array(tr
, trace_types
);
5052 for (; t
&& l
< *pos
; t
= t_next(m
, t
, &l
))
5058 static void t_stop(struct seq_file
*m
, void *p
)
5060 mutex_unlock(&trace_types_lock
);
5063 static int t_show(struct seq_file
*m
, void *v
)
5065 struct tracer
*t
= v
;
5070 seq_puts(m
, t
->name
);
5079 static const struct seq_operations show_traces_seq_ops
= {
5086 static int show_traces_open(struct inode
*inode
, struct file
*file
)
5088 struct trace_array
*tr
= inode
->i_private
;
5092 ret
= tracing_check_open_get_tr(tr
);
5096 ret
= seq_open(file
, &show_traces_seq_ops
);
5098 trace_array_put(tr
);
5102 m
= file
->private_data
;
5108 static int tracing_seq_release(struct inode
*inode
, struct file
*file
)
5110 struct trace_array
*tr
= inode
->i_private
;
5112 trace_array_put(tr
);
5113 return seq_release(inode
, file
);
5117 tracing_write_stub(struct file
*filp
, const char __user
*ubuf
,
5118 size_t count
, loff_t
*ppos
)
5123 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
)
5127 if (file
->f_mode
& FMODE_READ
)
5128 ret
= seq_lseek(file
, offset
, whence
);
5130 file
->f_pos
= ret
= 0;
5135 static const struct file_operations tracing_fops
= {
5136 .open
= tracing_open
,
5138 .read_iter
= seq_read_iter
,
5139 .splice_read
= copy_splice_read
,
5140 .write
= tracing_write_stub
,
5141 .llseek
= tracing_lseek
,
5142 .release
= tracing_release
,
5145 static const struct file_operations show_traces_fops
= {
5146 .open
= show_traces_open
,
5148 .llseek
= seq_lseek
,
5149 .release
= tracing_seq_release
,
5153 tracing_cpumask_read(struct file
*filp
, char __user
*ubuf
,
5154 size_t count
, loff_t
*ppos
)
5156 struct trace_array
*tr
= file_inode(filp
)->i_private
;
5160 len
= snprintf(NULL
, 0, "%*pb\n",
5161 cpumask_pr_args(tr
->tracing_cpumask
)) + 1;
5162 mask_str
= kmalloc(len
, GFP_KERNEL
);
5166 len
= snprintf(mask_str
, len
, "%*pb\n",
5167 cpumask_pr_args(tr
->tracing_cpumask
));
5172 count
= simple_read_from_buffer(ubuf
, count
, ppos
, mask_str
, len
);
5180 int tracing_set_cpumask(struct trace_array
*tr
,
5181 cpumask_var_t tracing_cpumask_new
)
5188 local_irq_disable();
5189 arch_spin_lock(&tr
->max_lock
);
5190 for_each_tracing_cpu(cpu
) {
5192 * Increase/decrease the disabled counter if we are
5193 * about to flip a bit in the cpumask:
5195 if (cpumask_test_cpu(cpu
, tr
->tracing_cpumask
) &&
5196 !cpumask_test_cpu(cpu
, tracing_cpumask_new
)) {
5197 atomic_inc(&per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->disabled
);
5198 ring_buffer_record_disable_cpu(tr
->array_buffer
.buffer
, cpu
);
5199 #ifdef CONFIG_TRACER_MAX_TRACE
5200 ring_buffer_record_disable_cpu(tr
->max_buffer
.buffer
, cpu
);
5203 if (!cpumask_test_cpu(cpu
, tr
->tracing_cpumask
) &&
5204 cpumask_test_cpu(cpu
, tracing_cpumask_new
)) {
5205 atomic_dec(&per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->disabled
);
5206 ring_buffer_record_enable_cpu(tr
->array_buffer
.buffer
, cpu
);
5207 #ifdef CONFIG_TRACER_MAX_TRACE
5208 ring_buffer_record_enable_cpu(tr
->max_buffer
.buffer
, cpu
);
5212 arch_spin_unlock(&tr
->max_lock
);
5215 cpumask_copy(tr
->tracing_cpumask
, tracing_cpumask_new
);
5221 tracing_cpumask_write(struct file
*filp
, const char __user
*ubuf
,
5222 size_t count
, loff_t
*ppos
)
5224 struct trace_array
*tr
= file_inode(filp
)->i_private
;
5225 cpumask_var_t tracing_cpumask_new
;
5228 if (!zalloc_cpumask_var(&tracing_cpumask_new
, GFP_KERNEL
))
5231 err
= cpumask_parse_user(ubuf
, count
, tracing_cpumask_new
);
5235 err
= tracing_set_cpumask(tr
, tracing_cpumask_new
);
5239 free_cpumask_var(tracing_cpumask_new
);
5244 free_cpumask_var(tracing_cpumask_new
);
5249 static const struct file_operations tracing_cpumask_fops
= {
5250 .open
= tracing_open_generic_tr
,
5251 .read
= tracing_cpumask_read
,
5252 .write
= tracing_cpumask_write
,
5253 .release
= tracing_release_generic_tr
,
5254 .llseek
= generic_file_llseek
,
5257 static int tracing_trace_options_show(struct seq_file
*m
, void *v
)
5259 struct tracer_opt
*trace_opts
;
5260 struct trace_array
*tr
= m
->private;
5264 mutex_lock(&trace_types_lock
);
5265 tracer_flags
= tr
->current_trace
->flags
->val
;
5266 trace_opts
= tr
->current_trace
->flags
->opts
;
5268 for (i
= 0; trace_options
[i
]; i
++) {
5269 if (tr
->trace_flags
& (1 << i
))
5270 seq_printf(m
, "%s\n", trace_options
[i
]);
5272 seq_printf(m
, "no%s\n", trace_options
[i
]);
5275 for (i
= 0; trace_opts
[i
].name
; i
++) {
5276 if (tracer_flags
& trace_opts
[i
].bit
)
5277 seq_printf(m
, "%s\n", trace_opts
[i
].name
);
5279 seq_printf(m
, "no%s\n", trace_opts
[i
].name
);
5281 mutex_unlock(&trace_types_lock
);
5286 static int __set_tracer_option(struct trace_array
*tr
,
5287 struct tracer_flags
*tracer_flags
,
5288 struct tracer_opt
*opts
, int neg
)
5290 struct tracer
*trace
= tracer_flags
->trace
;
5293 ret
= trace
->set_flag(tr
, tracer_flags
->val
, opts
->bit
, !neg
);
5298 tracer_flags
->val
&= ~opts
->bit
;
5300 tracer_flags
->val
|= opts
->bit
;
5304 /* Try to assign a tracer specific option */
5305 static int set_tracer_option(struct trace_array
*tr
, char *cmp
, int neg
)
5307 struct tracer
*trace
= tr
->current_trace
;
5308 struct tracer_flags
*tracer_flags
= trace
->flags
;
5309 struct tracer_opt
*opts
= NULL
;
5312 for (i
= 0; tracer_flags
->opts
[i
].name
; i
++) {
5313 opts
= &tracer_flags
->opts
[i
];
5315 if (strcmp(cmp
, opts
->name
) == 0)
5316 return __set_tracer_option(tr
, trace
->flags
, opts
, neg
);
5322 /* Some tracers require overwrite to stay enabled */
5323 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
)
5325 if (tracer
->enabled
&& (mask
& TRACE_ITER_OVERWRITE
) && !set
)
5331 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
)
5333 if ((mask
== TRACE_ITER_RECORD_TGID
) ||
5334 (mask
== TRACE_ITER_RECORD_CMD
) ||
5335 (mask
== TRACE_ITER_TRACE_PRINTK
))
5336 lockdep_assert_held(&event_mutex
);
5338 /* do nothing if flag is already set */
5339 if (!!(tr
->trace_flags
& mask
) == !!enabled
)
5342 /* Give the tracer a chance to approve the change */
5343 if (tr
->current_trace
->flag_changed
)
5344 if (tr
->current_trace
->flag_changed(tr
, mask
, !!enabled
))
5347 if (mask
== TRACE_ITER_TRACE_PRINTK
) {
5349 update_printk_trace(tr
);
5352 * The global_trace cannot clear this.
5353 * It's flag only gets cleared if another instance sets it.
5355 if (printk_trace
== &global_trace
)
5358 * An instance must always have it set.
5359 * by default, that's the global_trace instane.
5361 if (printk_trace
== tr
)
5362 update_printk_trace(&global_trace
);
5367 tr
->trace_flags
|= mask
;
5369 tr
->trace_flags
&= ~mask
;
5371 if (mask
== TRACE_ITER_RECORD_CMD
)
5372 trace_event_enable_cmd_record(enabled
);
5374 if (mask
== TRACE_ITER_RECORD_TGID
) {
5376 if (trace_alloc_tgid_map() < 0) {
5377 tr
->trace_flags
&= ~TRACE_ITER_RECORD_TGID
;
5381 trace_event_enable_tgid_record(enabled
);
5384 if (mask
== TRACE_ITER_EVENT_FORK
)
5385 trace_event_follow_fork(tr
, enabled
);
5387 if (mask
== TRACE_ITER_FUNC_FORK
)
5388 ftrace_pid_follow_fork(tr
, enabled
);
5390 if (mask
== TRACE_ITER_OVERWRITE
) {
5391 ring_buffer_change_overwrite(tr
->array_buffer
.buffer
, enabled
);
5392 #ifdef CONFIG_TRACER_MAX_TRACE
5393 ring_buffer_change_overwrite(tr
->max_buffer
.buffer
, enabled
);
5397 if (mask
== TRACE_ITER_PRINTK
) {
5398 trace_printk_start_stop_comm(enabled
);
5399 trace_printk_control(enabled
);
5405 int trace_set_options(struct trace_array
*tr
, char *option
)
5410 size_t orig_len
= strlen(option
);
5413 cmp
= strstrip(option
);
5415 len
= str_has_prefix(cmp
, "no");
5421 mutex_lock(&event_mutex
);
5422 mutex_lock(&trace_types_lock
);
5424 ret
= match_string(trace_options
, -1, cmp
);
5425 /* If no option could be set, test the specific tracer options */
5427 ret
= set_tracer_option(tr
, cmp
, neg
);
5429 ret
= set_tracer_flag(tr
, 1 << ret
, !neg
);
5431 mutex_unlock(&trace_types_lock
);
5432 mutex_unlock(&event_mutex
);
5435 * If the first trailing whitespace is replaced with '\0' by strstrip,
5436 * turn it back into a space.
5438 if (orig_len
> strlen(option
))
5439 option
[strlen(option
)] = ' ';
5444 static void __init
apply_trace_boot_options(void)
5446 char *buf
= trace_boot_options_buf
;
5450 option
= strsep(&buf
, ",");
5456 trace_set_options(&global_trace
, option
);
5458 /* Put back the comma to allow this to be called again */
5465 tracing_trace_options_write(struct file
*filp
, const char __user
*ubuf
,
5466 size_t cnt
, loff_t
*ppos
)
5468 struct seq_file
*m
= filp
->private_data
;
5469 struct trace_array
*tr
= m
->private;
5473 if (cnt
>= sizeof(buf
))
5476 if (copy_from_user(buf
, ubuf
, cnt
))
5481 ret
= trace_set_options(tr
, buf
);
5490 static int tracing_trace_options_open(struct inode
*inode
, struct file
*file
)
5492 struct trace_array
*tr
= inode
->i_private
;
5495 ret
= tracing_check_open_get_tr(tr
);
5499 ret
= single_open(file
, tracing_trace_options_show
, inode
->i_private
);
5501 trace_array_put(tr
);
5506 static const struct file_operations tracing_iter_fops
= {
5507 .open
= tracing_trace_options_open
,
5509 .llseek
= seq_lseek
,
5510 .release
= tracing_single_release_tr
,
5511 .write
= tracing_trace_options_write
,
5514 static const char readme_msg
[] =
5515 "tracing mini-HOWTO:\n\n"
5516 "By default tracefs removes all OTH file permission bits.\n"
5517 "When mounting tracefs an optional group id can be specified\n"
5518 "which adds the group to every directory and file in tracefs:\n\n"
5519 "\t e.g. mount -t tracefs [-o [gid=<gid>]] nodev /sys/kernel/tracing\n\n"
5520 "# echo 0 > tracing_on : quick way to disable tracing\n"
5521 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
5522 " Important files:\n"
5523 " trace\t\t\t- The static contents of the buffer\n"
5524 "\t\t\t To clear the buffer write into this file: echo > trace\n"
5525 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
5526 " current_tracer\t- function and latency tracers\n"
5527 " available_tracers\t- list of configured tracers for current_tracer\n"
5528 " error_log\t- error log for failed commands (that support it)\n"
5529 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
5530 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
5531 " trace_clock\t\t- change the clock used to order events\n"
5532 " local: Per cpu clock but may not be synced across CPUs\n"
5533 " global: Synced across CPUs but slows tracing down.\n"
5534 " counter: Not a clock, but just an increment\n"
5535 " uptime: Jiffy counter from time of boot\n"
5536 " perf: Same clock that perf events use\n"
5537 #ifdef CONFIG_X86_64
5538 " x86-tsc: TSC cycle counter\n"
5540 "\n timestamp_mode\t- view the mode used to timestamp events\n"
5541 " delta: Delta difference against a buffer-wide timestamp\n"
5542 " absolute: Absolute (standalone) timestamp\n"
5543 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
5544 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
5545 " tracing_cpumask\t- Limit which CPUs to trace\n"
5546 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
5547 "\t\t\t Remove sub-buffer with rmdir\n"
5548 " trace_options\t\t- Set format or modify how tracing happens\n"
5549 "\t\t\t Disable an option by prefixing 'no' to the\n"
5550 "\t\t\t option name\n"
5551 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
5552 #ifdef CONFIG_DYNAMIC_FTRACE
5553 "\n available_filter_functions - list of functions that can be filtered on\n"
5554 " set_ftrace_filter\t- echo function name in here to only trace these\n"
5555 "\t\t\t functions\n"
5556 "\t accepts: func_full_name or glob-matching-pattern\n"
5557 "\t modules: Can select a group via module\n"
5558 "\t Format: :mod:<module-name>\n"
5559 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
5560 "\t triggers: a command to perform when function is hit\n"
5561 "\t Format: <function>:<trigger>[:count]\n"
5562 "\t trigger: traceon, traceoff\n"
5563 "\t\t enable_event:<system>:<event>\n"
5564 "\t\t disable_event:<system>:<event>\n"
5565 #ifdef CONFIG_STACKTRACE
5568 #ifdef CONFIG_TRACER_SNAPSHOT
5573 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
5574 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
5575 "\t The first one will disable tracing every time do_fault is hit\n"
5576 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
5577 "\t The first time do trap is hit and it disables tracing, the\n"
5578 "\t counter will decrement to 2. If tracing is already disabled,\n"
5579 "\t the counter will not decrement. It only decrements when the\n"
5580 "\t trigger did work\n"
5581 "\t To remove trigger without count:\n"
5582 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
5583 "\t To remove trigger with a count:\n"
5584 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
5585 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
5586 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
5587 "\t modules: Can select a group via module command :mod:\n"
5588 "\t Does not accept triggers\n"
5589 #endif /* CONFIG_DYNAMIC_FTRACE */
5590 #ifdef CONFIG_FUNCTION_TRACER
5591 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
5593 " set_ftrace_notrace_pid\t- Write pid(s) to not function trace those pids\n"
5596 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
5597 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
5598 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
5599 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
5601 #ifdef CONFIG_TRACER_SNAPSHOT
5602 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
5603 "\t\t\t snapshot buffer. Read the contents for more\n"
5604 "\t\t\t information\n"
5606 #ifdef CONFIG_STACK_TRACER
5607 " stack_trace\t\t- Shows the max stack trace when active\n"
5608 " stack_max_size\t- Shows current max stack size that was traced\n"
5609 "\t\t\t Write into this file to reset the max size (trigger a\n"
5610 "\t\t\t new trace)\n"
5611 #ifdef CONFIG_DYNAMIC_FTRACE
5612 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
5615 #endif /* CONFIG_STACK_TRACER */
5616 #ifdef CONFIG_DYNAMIC_EVENTS
5617 " dynamic_events\t\t- Create/append/remove/show the generic dynamic events\n"
5618 "\t\t\t Write into this file to define/undefine new trace events.\n"
5620 #ifdef CONFIG_KPROBE_EVENTS
5621 " kprobe_events\t\t- Create/append/remove/show the kernel dynamic events\n"
5622 "\t\t\t Write into this file to define/undefine new trace events.\n"
5624 #ifdef CONFIG_UPROBE_EVENTS
5625 " uprobe_events\t\t- Create/append/remove/show the userspace dynamic events\n"
5626 "\t\t\t Write into this file to define/undefine new trace events.\n"
5628 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS) || \
5629 defined(CONFIG_FPROBE_EVENTS)
5630 "\t accepts: event-definitions (one definition per line)\n"
5631 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
5632 "\t Format: p[:[<group>/][<event>]] <place> [<args>]\n"
5633 "\t r[maxactive][:[<group>/][<event>]] <place> [<args>]\n"
5635 #ifdef CONFIG_FPROBE_EVENTS
5636 "\t f[:[<group>/][<event>]] <func-name>[%return] [<args>]\n"
5637 "\t t[:[<group>/][<event>]] <tracepoint> [<args>]\n"
5639 #ifdef CONFIG_HIST_TRIGGERS
5640 "\t s:[synthetic/]<event> <field> [<field>]\n"
5642 "\t e[:[<group>/][<event>]] <attached-group>.<attached-event> [<args>] [if <filter>]\n"
5643 "\t -:[<group>/][<event>]\n"
5644 #ifdef CONFIG_KPROBE_EVENTS
5645 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
5646 "place (kretprobe): [<module>:]<symbol>[+<offset>]%return|<memaddr>\n"
5648 #ifdef CONFIG_UPROBE_EVENTS
5649 " place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"
5651 "\t args: <name>=fetcharg[:type]\n"
5652 "\t fetcharg: (%<register>|$<efield>), @<address>, @<symbol>[+|-<offset>],\n"
5653 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
5654 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5655 #ifdef CONFIG_PROBE_EVENTS_BTF_ARGS
5656 "\t <argname>[->field[->field|.field...]],\n"
5659 "\t $stack<index>, $stack, $retval, $comm,\n"
5661 "\t +|-[u]<offset>(<fetcharg>), \\imm-value, \\\"imm-string\"\n"
5662 "\t kernel return probes support: $retval, $arg<N>, $comm\n"
5663 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, char, string, symbol,\n"
5664 "\t b<bit-width>@<bit-offset>/<container-size>, ustring,\n"
5665 "\t symstr, %pd/%pD, <type>\\[<array-size>\\]\n"
5666 #ifdef CONFIG_HIST_TRIGGERS
5667 "\t field: <stype> <name>;\n"
5668 "\t stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"
5669 "\t [unsigned] char/int/long\n"
5671 "\t efield: For event probes ('e' types), the field is on of the fields\n"
5672 "\t of the <attached-group>/<attached-event>.\n"
5674 " events/\t\t- Directory containing all trace event subsystems:\n"
5675 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
5676 " events/<system>/\t- Directory containing all trace events for <system>:\n"
5677 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
5679 " filter\t\t- If set, only events passing filter are traced\n"
5680 " events/<system>/<event>/\t- Directory containing control files for\n"
5682 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
5683 " filter\t\t- If set, only events passing filter are traced\n"
5684 " trigger\t\t- If set, a command to perform when event is hit\n"
5685 "\t Format: <trigger>[:count][if <filter>]\n"
5686 "\t trigger: traceon, traceoff\n"
5687 "\t enable_event:<system>:<event>\n"
5688 "\t disable_event:<system>:<event>\n"
5689 #ifdef CONFIG_HIST_TRIGGERS
5690 "\t enable_hist:<system>:<event>\n"
5691 "\t disable_hist:<system>:<event>\n"
5693 #ifdef CONFIG_STACKTRACE
5696 #ifdef CONFIG_TRACER_SNAPSHOT
5699 #ifdef CONFIG_HIST_TRIGGERS
5700 "\t\t hist (see below)\n"
5702 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
5703 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
5704 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
5705 "\t events/block/block_unplug/trigger\n"
5706 "\t The first disables tracing every time block_unplug is hit.\n"
5707 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
5708 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
5709 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
5710 "\t Like function triggers, the counter is only decremented if it\n"
5711 "\t enabled or disabled tracing.\n"
5712 "\t To remove a trigger without a count:\n"
5713 "\t echo '!<trigger> > <system>/<event>/trigger\n"
5714 "\t To remove a trigger with a count:\n"
5715 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
5716 "\t Filters can be ignored when removing a trigger.\n"
5717 #ifdef CONFIG_HIST_TRIGGERS
5718 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
5719 "\t Format: hist:keys=<field1[,field2,...]>\n"
5720 "\t [:<var1>=<field|var_ref|numeric_literal>[,<var2>=...]]\n"
5721 "\t [:values=<field1[,field2,...]>]\n"
5722 "\t [:sort=<field1[,field2,...]>]\n"
5723 "\t [:size=#entries]\n"
5724 "\t [:pause][:continue][:clear]\n"
5725 "\t [:name=histname1]\n"
5726 "\t [:nohitcount]\n"
5727 "\t [:<handler>.<action>]\n"
5728 "\t [if <filter>]\n\n"
5729 "\t Note, special fields can be used as well:\n"
5730 "\t common_timestamp - to record current timestamp\n"
5731 "\t common_cpu - to record the CPU the event happened on\n"
5733 "\t A hist trigger variable can be:\n"
5734 "\t - a reference to a field e.g. x=current_timestamp,\n"
5735 "\t - a reference to another variable e.g. y=$x,\n"
5736 "\t - a numeric literal: e.g. ms_per_sec=1000,\n"
5737 "\t - an arithmetic expression: e.g. time_secs=current_timestamp/1000\n"
5739 "\t hist trigger arithmetic expressions support addition(+), subtraction(-),\n"
5740 "\t multiplication(*) and division(/) operators. An operand can be either a\n"
5741 "\t variable reference, field or numeric literal.\n"
5743 "\t When a matching event is hit, an entry is added to a hash\n"
5744 "\t table using the key(s) and value(s) named, and the value of a\n"
5745 "\t sum called 'hitcount' is incremented. Keys and values\n"
5746 "\t correspond to fields in the event's format description. Keys\n"
5747 "\t can be any field, or the special string 'common_stacktrace'.\n"
5748 "\t Compound keys consisting of up to two fields can be specified\n"
5749 "\t by the 'keys' keyword. Values must correspond to numeric\n"
5750 "\t fields. Sort keys consisting of up to two fields can be\n"
5751 "\t specified using the 'sort' keyword. The sort direction can\n"
5752 "\t be modified by appending '.descending' or '.ascending' to a\n"
5753 "\t sort field. The 'size' parameter can be used to specify more\n"
5754 "\t or fewer than the default 2048 entries for the hashtable size.\n"
5755 "\t If a hist trigger is given a name using the 'name' parameter,\n"
5756 "\t its histogram data will be shared with other triggers of the\n"
5757 "\t same name, and trigger hits will update this common data.\n\n"
5758 "\t Reading the 'hist' file for the event will dump the hash\n"
5759 "\t table in its entirety to stdout. If there are multiple hist\n"
5760 "\t triggers attached to an event, there will be a table for each\n"
5761 "\t trigger in the output. The table displayed for a named\n"
5762 "\t trigger will be the same as any other instance having the\n"
5763 "\t same name. The default format used to display a given field\n"
5764 "\t can be modified by appending any of the following modifiers\n"
5765 "\t to the field name, as applicable:\n\n"
5766 "\t .hex display a number as a hex value\n"
5767 "\t .sym display an address as a symbol\n"
5768 "\t .sym-offset display an address as a symbol and offset\n"
5769 "\t .execname display a common_pid as a program name\n"
5770 "\t .syscall display a syscall id as a syscall name\n"
5771 "\t .log2 display log2 value rather than raw number\n"
5772 "\t .buckets=size display values in groups of size rather than raw number\n"
5773 "\t .usecs display a common_timestamp in microseconds\n"
5774 "\t .percent display a number of percentage value\n"
5775 "\t .graph display a bar-graph of a value\n\n"
5776 "\t The 'pause' parameter can be used to pause an existing hist\n"
5777 "\t trigger or to start a hist trigger but not log any events\n"
5778 "\t until told to do so. 'continue' can be used to start or\n"
5779 "\t restart a paused hist trigger.\n\n"
5780 "\t The 'clear' parameter will clear the contents of a running\n"
5781 "\t hist trigger and leave its current paused/active state\n"
5783 "\t The 'nohitcount' (or NOHC) parameter will suppress display of\n"
5784 "\t raw hitcount in the histogram.\n\n"
5785 "\t The enable_hist and disable_hist triggers can be used to\n"
5786 "\t have one event conditionally start and stop another event's\n"
5787 "\t already-attached hist trigger. The syntax is analogous to\n"
5788 "\t the enable_event and disable_event triggers.\n\n"
5789 "\t Hist trigger handlers and actions are executed whenever a\n"
5790 "\t a histogram entry is added or updated. They take the form:\n\n"
5791 "\t <handler>.<action>\n\n"
5792 "\t The available handlers are:\n\n"
5793 "\t onmatch(matching.event) - invoke on addition or update\n"
5794 "\t onmax(var) - invoke if var exceeds current max\n"
5795 "\t onchange(var) - invoke action if var changes\n\n"
5796 "\t The available actions are:\n\n"
5797 "\t trace(<synthetic_event>,param list) - generate synthetic event\n"
5798 "\t save(field,...) - save current event fields\n"
5799 #ifdef CONFIG_TRACER_SNAPSHOT
5800 "\t snapshot() - snapshot the trace buffer\n\n"
5802 #ifdef CONFIG_SYNTH_EVENTS
5803 " events/synthetic_events\t- Create/append/remove/show synthetic events\n"
5804 "\t Write into this file to define/undefine new synthetic events.\n"
5805 "\t example: echo 'myevent u64 lat; char name[]; long[] stack' >> synthetic_events\n"
5811 tracing_readme_read(struct file
*filp
, char __user
*ubuf
,
5812 size_t cnt
, loff_t
*ppos
)
5814 return simple_read_from_buffer(ubuf
, cnt
, ppos
,
5815 readme_msg
, strlen(readme_msg
));
5818 static const struct file_operations tracing_readme_fops
= {
5819 .open
= tracing_open_generic
,
5820 .read
= tracing_readme_read
,
5821 .llseek
= generic_file_llseek
,
5824 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
5825 static union trace_eval_map_item
*
5826 update_eval_map(union trace_eval_map_item
*ptr
)
5828 if (!ptr
->map
.eval_string
) {
5829 if (ptr
->tail
.next
) {
5830 ptr
= ptr
->tail
.next
;
5831 /* Set ptr to the next real item (skip head) */
5839 static void *eval_map_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
5841 union trace_eval_map_item
*ptr
= v
;
5844 * Paranoid! If ptr points to end, we don't want to increment past it.
5845 * This really should never happen.
5848 ptr
= update_eval_map(ptr
);
5849 if (WARN_ON_ONCE(!ptr
))
5853 ptr
= update_eval_map(ptr
);
5858 static void *eval_map_start(struct seq_file
*m
, loff_t
*pos
)
5860 union trace_eval_map_item
*v
;
5863 mutex_lock(&trace_eval_mutex
);
5865 v
= trace_eval_maps
;
5869 while (v
&& l
< *pos
) {
5870 v
= eval_map_next(m
, v
, &l
);
5876 static void eval_map_stop(struct seq_file
*m
, void *v
)
5878 mutex_unlock(&trace_eval_mutex
);
5881 static int eval_map_show(struct seq_file
*m
, void *v
)
5883 union trace_eval_map_item
*ptr
= v
;
5885 seq_printf(m
, "%s %ld (%s)\n",
5886 ptr
->map
.eval_string
, ptr
->map
.eval_value
,
5892 static const struct seq_operations tracing_eval_map_seq_ops
= {
5893 .start
= eval_map_start
,
5894 .next
= eval_map_next
,
5895 .stop
= eval_map_stop
,
5896 .show
= eval_map_show
,
5899 static int tracing_eval_map_open(struct inode
*inode
, struct file
*filp
)
5903 ret
= tracing_check_open_get_tr(NULL
);
5907 return seq_open(filp
, &tracing_eval_map_seq_ops
);
5910 static const struct file_operations tracing_eval_map_fops
= {
5911 .open
= tracing_eval_map_open
,
5913 .llseek
= seq_lseek
,
5914 .release
= seq_release
,
5917 static inline union trace_eval_map_item
*
5918 trace_eval_jmp_to_tail(union trace_eval_map_item
*ptr
)
5920 /* Return tail of array given the head */
5921 return ptr
+ ptr
->head
.length
+ 1;
5925 trace_insert_eval_map_file(struct module
*mod
, struct trace_eval_map
**start
,
5928 struct trace_eval_map
**stop
;
5929 struct trace_eval_map
**map
;
5930 union trace_eval_map_item
*map_array
;
5931 union trace_eval_map_item
*ptr
;
5936 * The trace_eval_maps contains the map plus a head and tail item,
5937 * where the head holds the module and length of array, and the
5938 * tail holds a pointer to the next list.
5940 map_array
= kmalloc_array(len
+ 2, sizeof(*map_array
), GFP_KERNEL
);
5942 pr_warn("Unable to allocate trace eval mapping\n");
5946 mutex_lock(&trace_eval_mutex
);
5948 if (!trace_eval_maps
)
5949 trace_eval_maps
= map_array
;
5951 ptr
= trace_eval_maps
;
5953 ptr
= trace_eval_jmp_to_tail(ptr
);
5954 if (!ptr
->tail
.next
)
5956 ptr
= ptr
->tail
.next
;
5959 ptr
->tail
.next
= map_array
;
5961 map_array
->head
.mod
= mod
;
5962 map_array
->head
.length
= len
;
5965 for (map
= start
; (unsigned long)map
< (unsigned long)stop
; map
++) {
5966 map_array
->map
= **map
;
5969 memset(map_array
, 0, sizeof(*map_array
));
5971 mutex_unlock(&trace_eval_mutex
);
5974 static void trace_create_eval_file(struct dentry
*d_tracer
)
5976 trace_create_file("eval_map", TRACE_MODE_READ
, d_tracer
,
5977 NULL
, &tracing_eval_map_fops
);
5980 #else /* CONFIG_TRACE_EVAL_MAP_FILE */
5981 static inline void trace_create_eval_file(struct dentry
*d_tracer
) { }
5982 static inline void trace_insert_eval_map_file(struct module
*mod
,
5983 struct trace_eval_map
**start
, int len
) { }
5984 #endif /* !CONFIG_TRACE_EVAL_MAP_FILE */
5986 static void trace_insert_eval_map(struct module
*mod
,
5987 struct trace_eval_map
**start
, int len
)
5989 struct trace_eval_map
**map
;
5996 trace_event_eval_update(map
, len
);
5998 trace_insert_eval_map_file(mod
, start
, len
);
6002 tracing_set_trace_read(struct file
*filp
, char __user
*ubuf
,
6003 size_t cnt
, loff_t
*ppos
)
6005 struct trace_array
*tr
= filp
->private_data
;
6006 char buf
[MAX_TRACER_SIZE
+2];
6009 mutex_lock(&trace_types_lock
);
6010 r
= sprintf(buf
, "%s\n", tr
->current_trace
->name
);
6011 mutex_unlock(&trace_types_lock
);
6013 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6016 int tracer_init(struct tracer
*t
, struct trace_array
*tr
)
6018 tracing_reset_online_cpus(&tr
->array_buffer
);
6022 static void set_buffer_entries(struct array_buffer
*buf
, unsigned long val
)
6026 for_each_tracing_cpu(cpu
)
6027 per_cpu_ptr(buf
->data
, cpu
)->entries
= val
;
6030 static void update_buffer_entries(struct array_buffer
*buf
, int cpu
)
6032 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6033 set_buffer_entries(buf
, ring_buffer_size(buf
->buffer
, 0));
6035 per_cpu_ptr(buf
->data
, cpu
)->entries
= ring_buffer_size(buf
->buffer
, cpu
);
6039 #ifdef CONFIG_TRACER_MAX_TRACE
6040 /* resize @tr's buffer to the size of @size_tr's entries */
6041 static int resize_buffer_duplicate_size(struct array_buffer
*trace_buf
,
6042 struct array_buffer
*size_buf
, int cpu_id
)
6046 if (cpu_id
== RING_BUFFER_ALL_CPUS
) {
6047 for_each_tracing_cpu(cpu
) {
6048 ret
= ring_buffer_resize(trace_buf
->buffer
,
6049 per_cpu_ptr(size_buf
->data
, cpu
)->entries
, cpu
);
6052 per_cpu_ptr(trace_buf
->data
, cpu
)->entries
=
6053 per_cpu_ptr(size_buf
->data
, cpu
)->entries
;
6056 ret
= ring_buffer_resize(trace_buf
->buffer
,
6057 per_cpu_ptr(size_buf
->data
, cpu_id
)->entries
, cpu_id
);
6059 per_cpu_ptr(trace_buf
->data
, cpu_id
)->entries
=
6060 per_cpu_ptr(size_buf
->data
, cpu_id
)->entries
;
6065 #endif /* CONFIG_TRACER_MAX_TRACE */
6067 static int __tracing_resize_ring_buffer(struct trace_array
*tr
,
6068 unsigned long size
, int cpu
)
6073 * If kernel or user changes the size of the ring buffer
6074 * we use the size that was given, and we can forget about
6075 * expanding it later.
6077 trace_set_ring_buffer_expanded(tr
);
6079 /* May be called before buffers are initialized */
6080 if (!tr
->array_buffer
.buffer
)
6083 /* Do not allow tracing while resizing ring buffer */
6084 tracing_stop_tr(tr
);
6086 ret
= ring_buffer_resize(tr
->array_buffer
.buffer
, size
, cpu
);
6090 #ifdef CONFIG_TRACER_MAX_TRACE
6091 if (!tr
->allocated_snapshot
)
6094 ret
= ring_buffer_resize(tr
->max_buffer
.buffer
, size
, cpu
);
6096 int r
= resize_buffer_duplicate_size(&tr
->array_buffer
,
6097 &tr
->array_buffer
, cpu
);
6100 * AARGH! We are left with different
6101 * size max buffer!!!!
6102 * The max buffer is our "snapshot" buffer.
6103 * When a tracer needs a snapshot (one of the
6104 * latency tracers), it swaps the max buffer
6105 * with the saved snap shot. We succeeded to
6106 * update the size of the main buffer, but failed to
6107 * update the size of the max buffer. But when we tried
6108 * to reset the main buffer to the original size, we
6109 * failed there too. This is very unlikely to
6110 * happen, but if it does, warn and kill all
6114 tracing_disabled
= 1;
6119 update_buffer_entries(&tr
->max_buffer
, cpu
);
6122 #endif /* CONFIG_TRACER_MAX_TRACE */
6124 update_buffer_entries(&tr
->array_buffer
, cpu
);
6126 tracing_start_tr(tr
);
6130 ssize_t
tracing_resize_ring_buffer(struct trace_array
*tr
,
6131 unsigned long size
, int cpu_id
)
6135 mutex_lock(&trace_types_lock
);
6137 if (cpu_id
!= RING_BUFFER_ALL_CPUS
) {
6138 /* make sure, this cpu is enabled in the mask */
6139 if (!cpumask_test_cpu(cpu_id
, tracing_buffer_mask
)) {
6145 ret
= __tracing_resize_ring_buffer(tr
, size
, cpu_id
);
6150 mutex_unlock(&trace_types_lock
);
6155 static void update_last_data(struct trace_array
*tr
)
6157 if (!tr
->text_delta
&& !tr
->data_delta
)
6161 * Need to clear all CPU buffers as there cannot be events
6162 * from the previous boot mixed with events with this boot
6163 * as that will cause a confusing trace. Need to clear all
6164 * CPU buffers, even for those that may currently be offline.
6166 tracing_reset_all_cpus(&tr
->array_buffer
);
6168 /* Using current data now */
6174 * tracing_update_buffers - used by tracing facility to expand ring buffers
6175 * @tr: The tracing instance
6177 * To save on memory when the tracing is never used on a system with it
6178 * configured in. The ring buffers are set to a minimum size. But once
6179 * a user starts to use the tracing facility, then they need to grow
6180 * to their default size.
6182 * This function is to be called when a tracer is about to be used.
6184 int tracing_update_buffers(struct trace_array
*tr
)
6188 mutex_lock(&trace_types_lock
);
6190 update_last_data(tr
);
6192 if (!tr
->ring_buffer_expanded
)
6193 ret
= __tracing_resize_ring_buffer(tr
, trace_buf_size
,
6194 RING_BUFFER_ALL_CPUS
);
6195 mutex_unlock(&trace_types_lock
);
6200 struct trace_option_dentry
;
6203 create_trace_option_files(struct trace_array
*tr
, struct tracer
*tracer
);
6206 * Used to clear out the tracer before deletion of an instance.
6207 * Must have trace_types_lock held.
6209 static void tracing_set_nop(struct trace_array
*tr
)
6211 if (tr
->current_trace
== &nop_trace
)
6214 tr
->current_trace
->enabled
--;
6216 if (tr
->current_trace
->reset
)
6217 tr
->current_trace
->reset(tr
);
6219 tr
->current_trace
= &nop_trace
;
6222 static bool tracer_options_updated
;
6224 static void add_tracer_options(struct trace_array
*tr
, struct tracer
*t
)
6226 /* Only enable if the directory has been created already. */
6230 /* Only create trace option files after update_tracer_options finish */
6231 if (!tracer_options_updated
)
6234 create_trace_option_files(tr
, t
);
6237 int tracing_set_tracer(struct trace_array
*tr
, const char *buf
)
6240 #ifdef CONFIG_TRACER_MAX_TRACE
6245 mutex_lock(&trace_types_lock
);
6247 update_last_data(tr
);
6249 if (!tr
->ring_buffer_expanded
) {
6250 ret
= __tracing_resize_ring_buffer(tr
, trace_buf_size
,
6251 RING_BUFFER_ALL_CPUS
);
6257 for (t
= trace_types
; t
; t
= t
->next
) {
6258 if (strcmp(t
->name
, buf
) == 0)
6265 if (t
== tr
->current_trace
)
6268 #ifdef CONFIG_TRACER_SNAPSHOT
6269 if (t
->use_max_tr
) {
6270 local_irq_disable();
6271 arch_spin_lock(&tr
->max_lock
);
6272 if (tr
->cond_snapshot
)
6274 arch_spin_unlock(&tr
->max_lock
);
6280 /* Some tracers won't work on kernel command line */
6281 if (system_state
< SYSTEM_RUNNING
&& t
->noboot
) {
6282 pr_warn("Tracer '%s' is not allowed on command line, ignored\n",
6287 /* Some tracers are only allowed for the top level buffer */
6288 if (!trace_ok_for_array(t
, tr
)) {
6293 /* If trace pipe files are being read, we can't change the tracer */
6294 if (tr
->trace_ref
) {
6299 trace_branch_disable();
6301 tr
->current_trace
->enabled
--;
6303 if (tr
->current_trace
->reset
)
6304 tr
->current_trace
->reset(tr
);
6306 #ifdef CONFIG_TRACER_MAX_TRACE
6307 had_max_tr
= tr
->current_trace
->use_max_tr
;
6309 /* Current trace needs to be nop_trace before synchronize_rcu */
6310 tr
->current_trace
= &nop_trace
;
6312 if (had_max_tr
&& !t
->use_max_tr
) {
6314 * We need to make sure that the update_max_tr sees that
6315 * current_trace changed to nop_trace to keep it from
6316 * swapping the buffers after we resize it.
6317 * The update_max_tr is called from interrupts disabled
6318 * so a synchronized_sched() is sufficient.
6322 tracing_disarm_snapshot(tr
);
6325 if (!had_max_tr
&& t
->use_max_tr
) {
6326 ret
= tracing_arm_snapshot_locked(tr
);
6331 tr
->current_trace
= &nop_trace
;
6335 ret
= tracer_init(t
, tr
);
6337 #ifdef CONFIG_TRACER_MAX_TRACE
6339 tracing_disarm_snapshot(tr
);
6345 tr
->current_trace
= t
;
6346 tr
->current_trace
->enabled
++;
6347 trace_branch_enable(tr
);
6349 mutex_unlock(&trace_types_lock
);
6355 tracing_set_trace_write(struct file
*filp
, const char __user
*ubuf
,
6356 size_t cnt
, loff_t
*ppos
)
6358 struct trace_array
*tr
= filp
->private_data
;
6359 char buf
[MAX_TRACER_SIZE
+1];
6366 if (cnt
> MAX_TRACER_SIZE
)
6367 cnt
= MAX_TRACER_SIZE
;
6369 if (copy_from_user(buf
, ubuf
, cnt
))
6376 err
= tracing_set_tracer(tr
, name
);
6386 tracing_nsecs_read(unsigned long *ptr
, char __user
*ubuf
,
6387 size_t cnt
, loff_t
*ppos
)
6392 r
= snprintf(buf
, sizeof(buf
), "%ld\n",
6393 *ptr
== (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr
));
6394 if (r
> sizeof(buf
))
6396 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6400 tracing_nsecs_write(unsigned long *ptr
, const char __user
*ubuf
,
6401 size_t cnt
, loff_t
*ppos
)
6406 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
6416 tracing_thresh_read(struct file
*filp
, char __user
*ubuf
,
6417 size_t cnt
, loff_t
*ppos
)
6419 return tracing_nsecs_read(&tracing_thresh
, ubuf
, cnt
, ppos
);
6423 tracing_thresh_write(struct file
*filp
, const char __user
*ubuf
,
6424 size_t cnt
, loff_t
*ppos
)
6426 struct trace_array
*tr
= filp
->private_data
;
6429 mutex_lock(&trace_types_lock
);
6430 ret
= tracing_nsecs_write(&tracing_thresh
, ubuf
, cnt
, ppos
);
6434 if (tr
->current_trace
->update_thresh
) {
6435 ret
= tr
->current_trace
->update_thresh(tr
);
6442 mutex_unlock(&trace_types_lock
);
6447 #ifdef CONFIG_TRACER_MAX_TRACE
6450 tracing_max_lat_read(struct file
*filp
, char __user
*ubuf
,
6451 size_t cnt
, loff_t
*ppos
)
6453 struct trace_array
*tr
= filp
->private_data
;
6455 return tracing_nsecs_read(&tr
->max_latency
, ubuf
, cnt
, ppos
);
6459 tracing_max_lat_write(struct file
*filp
, const char __user
*ubuf
,
6460 size_t cnt
, loff_t
*ppos
)
6462 struct trace_array
*tr
= filp
->private_data
;
6464 return tracing_nsecs_write(&tr
->max_latency
, ubuf
, cnt
, ppos
);
6469 static int open_pipe_on_cpu(struct trace_array
*tr
, int cpu
)
6471 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6472 if (cpumask_empty(tr
->pipe_cpumask
)) {
6473 cpumask_setall(tr
->pipe_cpumask
);
6476 } else if (!cpumask_test_cpu(cpu
, tr
->pipe_cpumask
)) {
6477 cpumask_set_cpu(cpu
, tr
->pipe_cpumask
);
6483 static void close_pipe_on_cpu(struct trace_array
*tr
, int cpu
)
6485 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6486 WARN_ON(!cpumask_full(tr
->pipe_cpumask
));
6487 cpumask_clear(tr
->pipe_cpumask
);
6489 WARN_ON(!cpumask_test_cpu(cpu
, tr
->pipe_cpumask
));
6490 cpumask_clear_cpu(cpu
, tr
->pipe_cpumask
);
6494 static int tracing_open_pipe(struct inode
*inode
, struct file
*filp
)
6496 struct trace_array
*tr
= inode
->i_private
;
6497 struct trace_iterator
*iter
;
6501 ret
= tracing_check_open_get_tr(tr
);
6505 mutex_lock(&trace_types_lock
);
6506 cpu
= tracing_get_cpu(inode
);
6507 ret
= open_pipe_on_cpu(tr
, cpu
);
6509 goto fail_pipe_on_cpu
;
6511 /* create a buffer to store the information to pass to userspace */
6512 iter
= kzalloc(sizeof(*iter
), GFP_KERNEL
);
6515 goto fail_alloc_iter
;
6518 trace_seq_init(&iter
->seq
);
6519 iter
->trace
= tr
->current_trace
;
6521 if (!alloc_cpumask_var(&iter
->started
, GFP_KERNEL
)) {
6526 /* trace pipe does not show start of buffer */
6527 cpumask_setall(iter
->started
);
6529 if (tr
->trace_flags
& TRACE_ITER_LATENCY_FMT
)
6530 iter
->iter_flags
|= TRACE_FILE_LAT_FMT
;
6532 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
6533 if (trace_clocks
[tr
->clock_id
].in_ns
)
6534 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
6537 iter
->array_buffer
= &tr
->array_buffer
;
6538 iter
->cpu_file
= cpu
;
6539 mutex_init(&iter
->mutex
);
6540 filp
->private_data
= iter
;
6542 if (iter
->trace
->pipe_open
)
6543 iter
->trace
->pipe_open(iter
);
6545 nonseekable_open(inode
, filp
);
6549 mutex_unlock(&trace_types_lock
);
6555 close_pipe_on_cpu(tr
, cpu
);
6557 __trace_array_put(tr
);
6558 mutex_unlock(&trace_types_lock
);
6562 static int tracing_release_pipe(struct inode
*inode
, struct file
*file
)
6564 struct trace_iterator
*iter
= file
->private_data
;
6565 struct trace_array
*tr
= inode
->i_private
;
6567 mutex_lock(&trace_types_lock
);
6571 if (iter
->trace
->pipe_close
)
6572 iter
->trace
->pipe_close(iter
);
6573 close_pipe_on_cpu(tr
, iter
->cpu_file
);
6574 mutex_unlock(&trace_types_lock
);
6576 free_trace_iter_content(iter
);
6579 trace_array_put(tr
);
6585 trace_poll(struct trace_iterator
*iter
, struct file
*filp
, poll_table
*poll_table
)
6587 struct trace_array
*tr
= iter
->tr
;
6589 /* Iterators are static, they should be filled or empty */
6590 if (trace_buffer_iter(iter
, iter
->cpu_file
))
6591 return EPOLLIN
| EPOLLRDNORM
;
6593 if (tr
->trace_flags
& TRACE_ITER_BLOCK
)
6595 * Always select as readable when in blocking mode
6597 return EPOLLIN
| EPOLLRDNORM
;
6599 return ring_buffer_poll_wait(iter
->array_buffer
->buffer
, iter
->cpu_file
,
6600 filp
, poll_table
, iter
->tr
->buffer_percent
);
6604 tracing_poll_pipe(struct file
*filp
, poll_table
*poll_table
)
6606 struct trace_iterator
*iter
= filp
->private_data
;
6608 return trace_poll(iter
, filp
, poll_table
);
6611 /* Must be called with iter->mutex held. */
6612 static int tracing_wait_pipe(struct file
*filp
)
6614 struct trace_iterator
*iter
= filp
->private_data
;
6617 while (trace_empty(iter
)) {
6619 if ((filp
->f_flags
& O_NONBLOCK
)) {
6624 * We block until we read something and tracing is disabled.
6625 * We still block if tracing is disabled, but we have never
6626 * read anything. This allows a user to cat this file, and
6627 * then enable tracing. But after we have read something,
6628 * we give an EOF when tracing is again disabled.
6630 * iter->pos will be 0 if we haven't read anything.
6632 if (!tracer_tracing_is_on(iter
->tr
) && iter
->pos
)
6635 mutex_unlock(&iter
->mutex
);
6637 ret
= wait_on_pipe(iter
, 0);
6639 mutex_lock(&iter
->mutex
);
6652 tracing_read_pipe(struct file
*filp
, char __user
*ubuf
,
6653 size_t cnt
, loff_t
*ppos
)
6655 struct trace_iterator
*iter
= filp
->private_data
;
6659 * Avoid more than one consumer on a single file descriptor
6660 * This is just a matter of traces coherency, the ring buffer itself
6663 mutex_lock(&iter
->mutex
);
6665 /* return any leftover data */
6666 sret
= trace_seq_to_user(&iter
->seq
, ubuf
, cnt
);
6670 trace_seq_init(&iter
->seq
);
6672 if (iter
->trace
->read
) {
6673 sret
= iter
->trace
->read(iter
, filp
, ubuf
, cnt
, ppos
);
6679 sret
= tracing_wait_pipe(filp
);
6683 /* stop when tracing is finished */
6684 if (trace_empty(iter
)) {
6689 if (cnt
>= TRACE_SEQ_BUFFER_SIZE
)
6690 cnt
= TRACE_SEQ_BUFFER_SIZE
- 1;
6692 /* reset all but tr, trace, and overruns */
6693 trace_iterator_reset(iter
);
6694 cpumask_clear(iter
->started
);
6695 trace_seq_init(&iter
->seq
);
6697 trace_event_read_lock();
6698 trace_access_lock(iter
->cpu_file
);
6699 while (trace_find_next_entry_inc(iter
) != NULL
) {
6700 enum print_line_t ret
;
6701 int save_len
= iter
->seq
.seq
.len
;
6703 ret
= print_trace_line(iter
);
6704 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
6706 * If one print_trace_line() fills entire trace_seq in one shot,
6707 * trace_seq_to_user() will returns -EBUSY because save_len == 0,
6708 * In this case, we need to consume it, otherwise, loop will peek
6709 * this event next time, resulting in an infinite loop.
6711 if (save_len
== 0) {
6713 trace_seq_puts(&iter
->seq
, "[LINE TOO BIG]\n");
6714 trace_consume(iter
);
6718 /* In other cases, don't print partial lines */
6719 iter
->seq
.seq
.len
= save_len
;
6722 if (ret
!= TRACE_TYPE_NO_CONSUME
)
6723 trace_consume(iter
);
6725 if (trace_seq_used(&iter
->seq
) >= cnt
)
6729 * Setting the full flag means we reached the trace_seq buffer
6730 * size and we should leave by partial output condition above.
6731 * One of the trace_seq_* functions is not used properly.
6733 WARN_ONCE(iter
->seq
.full
, "full flag set for trace type %d",
6736 trace_access_unlock(iter
->cpu_file
);
6737 trace_event_read_unlock();
6739 /* Now copy what we have to the user */
6740 sret
= trace_seq_to_user(&iter
->seq
, ubuf
, cnt
);
6741 if (iter
->seq
.readpos
>= trace_seq_used(&iter
->seq
))
6742 trace_seq_init(&iter
->seq
);
6745 * If there was nothing to send to user, in spite of consuming trace
6746 * entries, go back to wait for more entries.
6752 mutex_unlock(&iter
->mutex
);
6757 static void tracing_spd_release_pipe(struct splice_pipe_desc
*spd
,
6760 __free_page(spd
->pages
[idx
]);
6764 tracing_fill_pipe_page(size_t rem
, struct trace_iterator
*iter
)
6770 /* Seq buffer is page-sized, exactly what we need. */
6772 save_len
= iter
->seq
.seq
.len
;
6773 ret
= print_trace_line(iter
);
6775 if (trace_seq_has_overflowed(&iter
->seq
)) {
6776 iter
->seq
.seq
.len
= save_len
;
6781 * This should not be hit, because it should only
6782 * be set if the iter->seq overflowed. But check it
6783 * anyway to be safe.
6785 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
6786 iter
->seq
.seq
.len
= save_len
;
6790 count
= trace_seq_used(&iter
->seq
) - save_len
;
6793 iter
->seq
.seq
.len
= save_len
;
6797 if (ret
!= TRACE_TYPE_NO_CONSUME
)
6798 trace_consume(iter
);
6800 if (!trace_find_next_entry_inc(iter
)) {
6810 static ssize_t
tracing_splice_read_pipe(struct file
*filp
,
6812 struct pipe_inode_info
*pipe
,
6816 struct page
*pages_def
[PIPE_DEF_BUFFERS
];
6817 struct partial_page partial_def
[PIPE_DEF_BUFFERS
];
6818 struct trace_iterator
*iter
= filp
->private_data
;
6819 struct splice_pipe_desc spd
= {
6821 .partial
= partial_def
,
6822 .nr_pages
= 0, /* This gets updated below. */
6823 .nr_pages_max
= PIPE_DEF_BUFFERS
,
6824 .ops
= &default_pipe_buf_ops
,
6825 .spd_release
= tracing_spd_release_pipe
,
6831 if (splice_grow_spd(pipe
, &spd
))
6834 mutex_lock(&iter
->mutex
);
6836 if (iter
->trace
->splice_read
) {
6837 ret
= iter
->trace
->splice_read(iter
, filp
,
6838 ppos
, pipe
, len
, flags
);
6843 ret
= tracing_wait_pipe(filp
);
6847 if (!iter
->ent
&& !trace_find_next_entry_inc(iter
)) {
6852 trace_event_read_lock();
6853 trace_access_lock(iter
->cpu_file
);
6855 /* Fill as many pages as possible. */
6856 for (i
= 0, rem
= len
; i
< spd
.nr_pages_max
&& rem
; i
++) {
6857 spd
.pages
[i
] = alloc_page(GFP_KERNEL
);
6861 rem
= tracing_fill_pipe_page(rem
, iter
);
6863 /* Copy the data into the page, so we can start over. */
6864 ret
= trace_seq_to_buffer(&iter
->seq
,
6865 page_address(spd
.pages
[i
]),
6866 trace_seq_used(&iter
->seq
));
6868 __free_page(spd
.pages
[i
]);
6871 spd
.partial
[i
].offset
= 0;
6872 spd
.partial
[i
].len
= trace_seq_used(&iter
->seq
);
6874 trace_seq_init(&iter
->seq
);
6877 trace_access_unlock(iter
->cpu_file
);
6878 trace_event_read_unlock();
6879 mutex_unlock(&iter
->mutex
);
6884 ret
= splice_to_pipe(pipe
, &spd
);
6888 splice_shrink_spd(&spd
);
6892 mutex_unlock(&iter
->mutex
);
6897 tracing_entries_read(struct file
*filp
, char __user
*ubuf
,
6898 size_t cnt
, loff_t
*ppos
)
6900 struct inode
*inode
= file_inode(filp
);
6901 struct trace_array
*tr
= inode
->i_private
;
6902 int cpu
= tracing_get_cpu(inode
);
6907 mutex_lock(&trace_types_lock
);
6909 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6910 int cpu
, buf_size_same
;
6915 /* check if all cpu sizes are same */
6916 for_each_tracing_cpu(cpu
) {
6917 /* fill in the size from first enabled cpu */
6919 size
= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
;
6920 if (size
!= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
) {
6926 if (buf_size_same
) {
6927 if (!tr
->ring_buffer_expanded
)
6928 r
= sprintf(buf
, "%lu (expanded: %lu)\n",
6930 trace_buf_size
>> 10);
6932 r
= sprintf(buf
, "%lu\n", size
>> 10);
6934 r
= sprintf(buf
, "X\n");
6936 r
= sprintf(buf
, "%lu\n", per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
>> 10);
6938 mutex_unlock(&trace_types_lock
);
6940 ret
= simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6945 tracing_entries_write(struct file
*filp
, const char __user
*ubuf
,
6946 size_t cnt
, loff_t
*ppos
)
6948 struct inode
*inode
= file_inode(filp
);
6949 struct trace_array
*tr
= inode
->i_private
;
6953 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
6957 /* must have at least 1 entry */
6961 /* value is in KB */
6963 ret
= tracing_resize_ring_buffer(tr
, val
, tracing_get_cpu(inode
));
6973 tracing_total_entries_read(struct file
*filp
, char __user
*ubuf
,
6974 size_t cnt
, loff_t
*ppos
)
6976 struct trace_array
*tr
= filp
->private_data
;
6979 unsigned long size
= 0, expanded_size
= 0;
6981 mutex_lock(&trace_types_lock
);
6982 for_each_tracing_cpu(cpu
) {
6983 size
+= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
>> 10;
6984 if (!tr
->ring_buffer_expanded
)
6985 expanded_size
+= trace_buf_size
>> 10;
6987 if (tr
->ring_buffer_expanded
)
6988 r
= sprintf(buf
, "%lu\n", size
);
6990 r
= sprintf(buf
, "%lu (expanded: %lu)\n", size
, expanded_size
);
6991 mutex_unlock(&trace_types_lock
);
6993 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6997 tracing_last_boot_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
6999 struct trace_array
*tr
= filp
->private_data
;
7003 seq_buf_init(&seq
, buf
, 64);
7005 seq_buf_printf(&seq
, "text delta:\t%ld\n", tr
->text_delta
);
7006 seq_buf_printf(&seq
, "data delta:\t%ld\n", tr
->data_delta
);
7008 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, seq_buf_used(&seq
));
7011 static int tracing_buffer_meta_open(struct inode
*inode
, struct file
*filp
)
7013 struct trace_array
*tr
= inode
->i_private
;
7014 int cpu
= tracing_get_cpu(inode
);
7017 ret
= tracing_check_open_get_tr(tr
);
7021 ret
= ring_buffer_meta_seq_init(filp
, tr
->array_buffer
.buffer
, cpu
);
7023 __trace_array_put(tr
);
7028 tracing_free_buffer_write(struct file
*filp
, const char __user
*ubuf
,
7029 size_t cnt
, loff_t
*ppos
)
7032 * There is no need to read what the user has written, this function
7033 * is just to make sure that there is no error when "echo" is used
7042 tracing_free_buffer_release(struct inode
*inode
, struct file
*filp
)
7044 struct trace_array
*tr
= inode
->i_private
;
7046 /* disable tracing ? */
7047 if (tr
->trace_flags
& TRACE_ITER_STOP_ON_FREE
)
7048 tracer_tracing_off(tr
);
7049 /* resize the ring buffer to 0 */
7050 tracing_resize_ring_buffer(tr
, 0, RING_BUFFER_ALL_CPUS
);
7052 trace_array_put(tr
);
7057 #define TRACE_MARKER_MAX_SIZE 4096
7060 tracing_mark_write(struct file
*filp
, const char __user
*ubuf
,
7061 size_t cnt
, loff_t
*fpos
)
7063 struct trace_array
*tr
= filp
->private_data
;
7064 struct ring_buffer_event
*event
;
7065 enum event_trigger_type tt
= ETT_NONE
;
7066 struct trace_buffer
*buffer
;
7067 struct print_entry
*entry
;
7073 /* Used in tracing_mark_raw_write() as well */
7074 #define FAULTED_STR "<faulted>"
7075 #define FAULTED_SIZE (sizeof(FAULTED_STR) - 1) /* '\0' is already accounted for */
7077 if (tracing_disabled
)
7080 if (!(tr
->trace_flags
& TRACE_ITER_MARKERS
))
7083 if ((ssize_t
)cnt
< 0)
7086 if (cnt
> TRACE_MARKER_MAX_SIZE
)
7087 cnt
= TRACE_MARKER_MAX_SIZE
;
7089 meta_size
= sizeof(*entry
) + 2; /* add '\0' and possible '\n' */
7091 size
= cnt
+ meta_size
;
7093 /* If less than "<faulted>", then make sure we can still add that */
7094 if (cnt
< FAULTED_SIZE
)
7095 size
+= FAULTED_SIZE
- cnt
;
7097 buffer
= tr
->array_buffer
.buffer
;
7098 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, size
,
7100 if (unlikely(!event
)) {
7102 * If the size was greater than what was allowed, then
7103 * make it smaller and try again.
7105 if (size
> ring_buffer_max_event_size(buffer
)) {
7106 /* cnt < FAULTED size should never be bigger than max */
7107 if (WARN_ON_ONCE(cnt
< FAULTED_SIZE
))
7109 cnt
= ring_buffer_max_event_size(buffer
) - meta_size
;
7110 /* The above should only happen once */
7111 if (WARN_ON_ONCE(cnt
+ meta_size
== size
))
7116 /* Ring buffer disabled, return as if not open for write */
7120 entry
= ring_buffer_event_data(event
);
7121 entry
->ip
= _THIS_IP_
;
7123 len
= __copy_from_user_inatomic(&entry
->buf
, ubuf
, cnt
);
7125 memcpy(&entry
->buf
, FAULTED_STR
, FAULTED_SIZE
);
7131 if (tr
->trace_marker_file
&& !list_empty(&tr
->trace_marker_file
->triggers
)) {
7132 /* do not add \n before testing triggers, but add \0 */
7133 entry
->buf
[cnt
] = '\0';
7134 tt
= event_triggers_call(tr
->trace_marker_file
, buffer
, entry
, event
);
7137 if (entry
->buf
[cnt
- 1] != '\n') {
7138 entry
->buf
[cnt
] = '\n';
7139 entry
->buf
[cnt
+ 1] = '\0';
7141 entry
->buf
[cnt
] = '\0';
7143 if (static_branch_unlikely(&trace_marker_exports_enabled
))
7144 ftrace_exports(event
, TRACE_EXPORT_MARKER
);
7145 __buffer_unlock_commit(buffer
, event
);
7148 event_triggers_post_call(tr
->trace_marker_file
, tt
);
7154 tracing_mark_raw_write(struct file
*filp
, const char __user
*ubuf
,
7155 size_t cnt
, loff_t
*fpos
)
7157 struct trace_array
*tr
= filp
->private_data
;
7158 struct ring_buffer_event
*event
;
7159 struct trace_buffer
*buffer
;
7160 struct raw_data_entry
*entry
;
7165 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
7167 if (tracing_disabled
)
7170 if (!(tr
->trace_flags
& TRACE_ITER_MARKERS
))
7173 /* The marker must at least have a tag id */
7174 if (cnt
< sizeof(unsigned int))
7177 size
= sizeof(*entry
) + cnt
;
7178 if (cnt
< FAULT_SIZE_ID
)
7179 size
+= FAULT_SIZE_ID
- cnt
;
7181 buffer
= tr
->array_buffer
.buffer
;
7183 if (size
> ring_buffer_max_event_size(buffer
))
7186 event
= __trace_buffer_lock_reserve(buffer
, TRACE_RAW_DATA
, size
,
7189 /* Ring buffer disabled, return as if not open for write */
7192 entry
= ring_buffer_event_data(event
);
7194 len
= __copy_from_user_inatomic(&entry
->id
, ubuf
, cnt
);
7197 memcpy(&entry
->buf
, FAULTED_STR
, FAULTED_SIZE
);
7202 __buffer_unlock_commit(buffer
, event
);
7207 static int tracing_clock_show(struct seq_file
*m
, void *v
)
7209 struct trace_array
*tr
= m
->private;
7212 for (i
= 0; i
< ARRAY_SIZE(trace_clocks
); i
++)
7214 "%s%s%s%s", i
? " " : "",
7215 i
== tr
->clock_id
? "[" : "", trace_clocks
[i
].name
,
7216 i
== tr
->clock_id
? "]" : "");
7222 int tracing_set_clock(struct trace_array
*tr
, const char *clockstr
)
7226 for (i
= 0; i
< ARRAY_SIZE(trace_clocks
); i
++) {
7227 if (strcmp(trace_clocks
[i
].name
, clockstr
) == 0)
7230 if (i
== ARRAY_SIZE(trace_clocks
))
7233 mutex_lock(&trace_types_lock
);
7237 ring_buffer_set_clock(tr
->array_buffer
.buffer
, trace_clocks
[i
].func
);
7240 * New clock may not be consistent with the previous clock.
7241 * Reset the buffer so that it doesn't have incomparable timestamps.
7243 tracing_reset_online_cpus(&tr
->array_buffer
);
7245 #ifdef CONFIG_TRACER_MAX_TRACE
7246 if (tr
->max_buffer
.buffer
)
7247 ring_buffer_set_clock(tr
->max_buffer
.buffer
, trace_clocks
[i
].func
);
7248 tracing_reset_online_cpus(&tr
->max_buffer
);
7251 mutex_unlock(&trace_types_lock
);
7256 static ssize_t
tracing_clock_write(struct file
*filp
, const char __user
*ubuf
,
7257 size_t cnt
, loff_t
*fpos
)
7259 struct seq_file
*m
= filp
->private_data
;
7260 struct trace_array
*tr
= m
->private;
7262 const char *clockstr
;
7265 if (cnt
>= sizeof(buf
))
7268 if (copy_from_user(buf
, ubuf
, cnt
))
7273 clockstr
= strstrip(buf
);
7275 ret
= tracing_set_clock(tr
, clockstr
);
7284 static int tracing_clock_open(struct inode
*inode
, struct file
*file
)
7286 struct trace_array
*tr
= inode
->i_private
;
7289 ret
= tracing_check_open_get_tr(tr
);
7293 ret
= single_open(file
, tracing_clock_show
, inode
->i_private
);
7295 trace_array_put(tr
);
7300 static int tracing_time_stamp_mode_show(struct seq_file
*m
, void *v
)
7302 struct trace_array
*tr
= m
->private;
7304 mutex_lock(&trace_types_lock
);
7306 if (ring_buffer_time_stamp_abs(tr
->array_buffer
.buffer
))
7307 seq_puts(m
, "delta [absolute]\n");
7309 seq_puts(m
, "[delta] absolute\n");
7311 mutex_unlock(&trace_types_lock
);
7316 static int tracing_time_stamp_mode_open(struct inode
*inode
, struct file
*file
)
7318 struct trace_array
*tr
= inode
->i_private
;
7321 ret
= tracing_check_open_get_tr(tr
);
7325 ret
= single_open(file
, tracing_time_stamp_mode_show
, inode
->i_private
);
7327 trace_array_put(tr
);
7332 u64
tracing_event_time_stamp(struct trace_buffer
*buffer
, struct ring_buffer_event
*rbe
)
7334 if (rbe
== this_cpu_read(trace_buffered_event
))
7335 return ring_buffer_time_stamp(buffer
);
7337 return ring_buffer_event_time_stamp(buffer
, rbe
);
7341 * Set or disable using the per CPU trace_buffer_event when possible.
7343 int tracing_set_filter_buffering(struct trace_array
*tr
, bool set
)
7347 mutex_lock(&trace_types_lock
);
7349 if (set
&& tr
->no_filter_buffering_ref
++)
7353 if (WARN_ON_ONCE(!tr
->no_filter_buffering_ref
)) {
7358 --tr
->no_filter_buffering_ref
;
7361 mutex_unlock(&trace_types_lock
);
7366 struct ftrace_buffer_info
{
7367 struct trace_iterator iter
;
7369 unsigned int spare_cpu
;
7370 unsigned int spare_size
;
7374 #ifdef CONFIG_TRACER_SNAPSHOT
7375 static int tracing_snapshot_open(struct inode
*inode
, struct file
*file
)
7377 struct trace_array
*tr
= inode
->i_private
;
7378 struct trace_iterator
*iter
;
7382 ret
= tracing_check_open_get_tr(tr
);
7386 if (file
->f_mode
& FMODE_READ
) {
7387 iter
= __tracing_open(inode
, file
, true);
7389 ret
= PTR_ERR(iter
);
7391 /* Writes still need the seq_file to hold the private data */
7393 m
= kzalloc(sizeof(*m
), GFP_KERNEL
);
7396 iter
= kzalloc(sizeof(*iter
), GFP_KERNEL
);
7404 iter
->array_buffer
= &tr
->max_buffer
;
7405 iter
->cpu_file
= tracing_get_cpu(inode
);
7407 file
->private_data
= m
;
7411 trace_array_put(tr
);
7416 static void tracing_swap_cpu_buffer(void *tr
)
7418 update_max_tr_single((struct trace_array
*)tr
, current
, smp_processor_id());
7422 tracing_snapshot_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
7425 struct seq_file
*m
= filp
->private_data
;
7426 struct trace_iterator
*iter
= m
->private;
7427 struct trace_array
*tr
= iter
->tr
;
7431 ret
= tracing_update_buffers(tr
);
7435 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
7439 mutex_lock(&trace_types_lock
);
7441 if (tr
->current_trace
->use_max_tr
) {
7446 local_irq_disable();
7447 arch_spin_lock(&tr
->max_lock
);
7448 if (tr
->cond_snapshot
)
7450 arch_spin_unlock(&tr
->max_lock
);
7457 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
7461 if (tr
->allocated_snapshot
)
7465 /* Only allow per-cpu swap if the ring buffer supports it */
7466 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
7467 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
7472 if (tr
->allocated_snapshot
)
7473 ret
= resize_buffer_duplicate_size(&tr
->max_buffer
,
7474 &tr
->array_buffer
, iter
->cpu_file
);
7476 ret
= tracing_arm_snapshot_locked(tr
);
7480 /* Now, we're going to swap */
7481 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
) {
7482 local_irq_disable();
7483 update_max_tr(tr
, current
, smp_processor_id(), NULL
);
7486 smp_call_function_single(iter
->cpu_file
, tracing_swap_cpu_buffer
,
7489 tracing_disarm_snapshot(tr
);
7492 if (tr
->allocated_snapshot
) {
7493 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
)
7494 tracing_reset_online_cpus(&tr
->max_buffer
);
7496 tracing_reset_cpu(&tr
->max_buffer
, iter
->cpu_file
);
7506 mutex_unlock(&trace_types_lock
);
7510 static int tracing_snapshot_release(struct inode
*inode
, struct file
*file
)
7512 struct seq_file
*m
= file
->private_data
;
7515 ret
= tracing_release(inode
, file
);
7517 if (file
->f_mode
& FMODE_READ
)
7520 /* If write only, the seq_file is just a stub */
7528 static int tracing_buffers_open(struct inode
*inode
, struct file
*filp
);
7529 static ssize_t
tracing_buffers_read(struct file
*filp
, char __user
*ubuf
,
7530 size_t count
, loff_t
*ppos
);
7531 static int tracing_buffers_release(struct inode
*inode
, struct file
*file
);
7532 static ssize_t
tracing_buffers_splice_read(struct file
*file
, loff_t
*ppos
,
7533 struct pipe_inode_info
*pipe
, size_t len
, unsigned int flags
);
7535 static int snapshot_raw_open(struct inode
*inode
, struct file
*filp
)
7537 struct ftrace_buffer_info
*info
;
7540 /* The following checks for tracefs lockdown */
7541 ret
= tracing_buffers_open(inode
, filp
);
7545 info
= filp
->private_data
;
7547 if (info
->iter
.trace
->use_max_tr
) {
7548 tracing_buffers_release(inode
, filp
);
7552 info
->iter
.snapshot
= true;
7553 info
->iter
.array_buffer
= &info
->iter
.tr
->max_buffer
;
7558 #endif /* CONFIG_TRACER_SNAPSHOT */
7561 static const struct file_operations tracing_thresh_fops
= {
7562 .open
= tracing_open_generic
,
7563 .read
= tracing_thresh_read
,
7564 .write
= tracing_thresh_write
,
7565 .llseek
= generic_file_llseek
,
7568 #ifdef CONFIG_TRACER_MAX_TRACE
7569 static const struct file_operations tracing_max_lat_fops
= {
7570 .open
= tracing_open_generic_tr
,
7571 .read
= tracing_max_lat_read
,
7572 .write
= tracing_max_lat_write
,
7573 .llseek
= generic_file_llseek
,
7574 .release
= tracing_release_generic_tr
,
7578 static const struct file_operations set_tracer_fops
= {
7579 .open
= tracing_open_generic_tr
,
7580 .read
= tracing_set_trace_read
,
7581 .write
= tracing_set_trace_write
,
7582 .llseek
= generic_file_llseek
,
7583 .release
= tracing_release_generic_tr
,
7586 static const struct file_operations tracing_pipe_fops
= {
7587 .open
= tracing_open_pipe
,
7588 .poll
= tracing_poll_pipe
,
7589 .read
= tracing_read_pipe
,
7590 .splice_read
= tracing_splice_read_pipe
,
7591 .release
= tracing_release_pipe
,
7594 static const struct file_operations tracing_entries_fops
= {
7595 .open
= tracing_open_generic_tr
,
7596 .read
= tracing_entries_read
,
7597 .write
= tracing_entries_write
,
7598 .llseek
= generic_file_llseek
,
7599 .release
= tracing_release_generic_tr
,
7602 static const struct file_operations tracing_buffer_meta_fops
= {
7603 .open
= tracing_buffer_meta_open
,
7605 .llseek
= seq_lseek
,
7606 .release
= tracing_seq_release
,
7609 static const struct file_operations tracing_total_entries_fops
= {
7610 .open
= tracing_open_generic_tr
,
7611 .read
= tracing_total_entries_read
,
7612 .llseek
= generic_file_llseek
,
7613 .release
= tracing_release_generic_tr
,
7616 static const struct file_operations tracing_free_buffer_fops
= {
7617 .open
= tracing_open_generic_tr
,
7618 .write
= tracing_free_buffer_write
,
7619 .release
= tracing_free_buffer_release
,
7622 static const struct file_operations tracing_mark_fops
= {
7623 .open
= tracing_mark_open
,
7624 .write
= tracing_mark_write
,
7625 .release
= tracing_release_generic_tr
,
7628 static const struct file_operations tracing_mark_raw_fops
= {
7629 .open
= tracing_mark_open
,
7630 .write
= tracing_mark_raw_write
,
7631 .release
= tracing_release_generic_tr
,
7634 static const struct file_operations trace_clock_fops
= {
7635 .open
= tracing_clock_open
,
7637 .llseek
= seq_lseek
,
7638 .release
= tracing_single_release_tr
,
7639 .write
= tracing_clock_write
,
7642 static const struct file_operations trace_time_stamp_mode_fops
= {
7643 .open
= tracing_time_stamp_mode_open
,
7645 .llseek
= seq_lseek
,
7646 .release
= tracing_single_release_tr
,
7649 static const struct file_operations last_boot_fops
= {
7650 .open
= tracing_open_generic_tr
,
7651 .read
= tracing_last_boot_read
,
7652 .llseek
= generic_file_llseek
,
7653 .release
= tracing_release_generic_tr
,
7656 #ifdef CONFIG_TRACER_SNAPSHOT
7657 static const struct file_operations snapshot_fops
= {
7658 .open
= tracing_snapshot_open
,
7660 .write
= tracing_snapshot_write
,
7661 .llseek
= tracing_lseek
,
7662 .release
= tracing_snapshot_release
,
7665 static const struct file_operations snapshot_raw_fops
= {
7666 .open
= snapshot_raw_open
,
7667 .read
= tracing_buffers_read
,
7668 .release
= tracing_buffers_release
,
7669 .splice_read
= tracing_buffers_splice_read
,
7672 #endif /* CONFIG_TRACER_SNAPSHOT */
7675 * trace_min_max_write - Write a u64 value to a trace_min_max_param struct
7676 * @filp: The active open file structure
7677 * @ubuf: The userspace provided buffer to read value into
7678 * @cnt: The maximum number of bytes to read
7679 * @ppos: The current "file" position
7681 * This function implements the write interface for a struct trace_min_max_param.
7682 * The filp->private_data must point to a trace_min_max_param structure that
7683 * defines where to write the value, the min and the max acceptable values,
7684 * and a lock to protect the write.
7687 trace_min_max_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
7689 struct trace_min_max_param
*param
= filp
->private_data
;
7696 err
= kstrtoull_from_user(ubuf
, cnt
, 10, &val
);
7701 mutex_lock(param
->lock
);
7703 if (param
->min
&& val
< *param
->min
)
7706 if (param
->max
&& val
> *param
->max
)
7713 mutex_unlock(param
->lock
);
7722 * trace_min_max_read - Read a u64 value from a trace_min_max_param struct
7723 * @filp: The active open file structure
7724 * @ubuf: The userspace provided buffer to read value into
7725 * @cnt: The maximum number of bytes to read
7726 * @ppos: The current "file" position
7728 * This function implements the read interface for a struct trace_min_max_param.
7729 * The filp->private_data must point to a trace_min_max_param struct with valid
7733 trace_min_max_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
7735 struct trace_min_max_param
*param
= filp
->private_data
;
7736 char buf
[U64_STR_SIZE
];
7745 if (cnt
> sizeof(buf
))
7748 len
= snprintf(buf
, sizeof(buf
), "%llu\n", val
);
7750 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, len
);
7753 const struct file_operations trace_min_max_fops
= {
7754 .open
= tracing_open_generic
,
7755 .read
= trace_min_max_read
,
7756 .write
= trace_min_max_write
,
7759 #define TRACING_LOG_ERRS_MAX 8
7760 #define TRACING_LOG_LOC_MAX 128
7762 #define CMD_PREFIX " Command: "
7765 const char **errs
; /* ptr to loc-specific array of err strings */
7766 u8 type
; /* index into errs -> specific err string */
7767 u16 pos
; /* caret position */
7771 struct tracing_log_err
{
7772 struct list_head list
;
7773 struct err_info info
;
7774 char loc
[TRACING_LOG_LOC_MAX
]; /* err location */
7775 char *cmd
; /* what caused err */
7778 static DEFINE_MUTEX(tracing_err_log_lock
);
7780 static struct tracing_log_err
*alloc_tracing_log_err(int len
)
7782 struct tracing_log_err
*err
;
7784 err
= kzalloc(sizeof(*err
), GFP_KERNEL
);
7786 return ERR_PTR(-ENOMEM
);
7788 err
->cmd
= kzalloc(len
, GFP_KERNEL
);
7791 return ERR_PTR(-ENOMEM
);
7797 static void free_tracing_log_err(struct tracing_log_err
*err
)
7803 static struct tracing_log_err
*get_tracing_log_err(struct trace_array
*tr
,
7806 struct tracing_log_err
*err
;
7809 if (tr
->n_err_log_entries
< TRACING_LOG_ERRS_MAX
) {
7810 err
= alloc_tracing_log_err(len
);
7811 if (PTR_ERR(err
) != -ENOMEM
)
7812 tr
->n_err_log_entries
++;
7816 cmd
= kzalloc(len
, GFP_KERNEL
);
7818 return ERR_PTR(-ENOMEM
);
7819 err
= list_first_entry(&tr
->err_log
, struct tracing_log_err
, list
);
7822 list_del(&err
->list
);
7828 * err_pos - find the position of a string within a command for error careting
7829 * @cmd: The tracing command that caused the error
7830 * @str: The string to position the caret at within @cmd
7832 * Finds the position of the first occurrence of @str within @cmd. The
7833 * return value can be passed to tracing_log_err() for caret placement
7836 * Returns the index within @cmd of the first occurrence of @str or 0
7837 * if @str was not found.
7839 unsigned int err_pos(char *cmd
, const char *str
)
7843 if (WARN_ON(!strlen(cmd
)))
7846 found
= strstr(cmd
, str
);
7854 * tracing_log_err - write an error to the tracing error log
7855 * @tr: The associated trace array for the error (NULL for top level array)
7856 * @loc: A string describing where the error occurred
7857 * @cmd: The tracing command that caused the error
7858 * @errs: The array of loc-specific static error strings
7859 * @type: The index into errs[], which produces the specific static err string
7860 * @pos: The position the caret should be placed in the cmd
7862 * Writes an error into tracing/error_log of the form:
7864 * <loc>: error: <text>
7868 * tracing/error_log is a small log file containing the last
7869 * TRACING_LOG_ERRS_MAX errors (8). Memory for errors isn't allocated
7870 * unless there has been a tracing error, and the error log can be
7871 * cleared and have its memory freed by writing the empty string in
7872 * truncation mode to it i.e. echo > tracing/error_log.
7874 * NOTE: the @errs array along with the @type param are used to
7875 * produce a static error string - this string is not copied and saved
7876 * when the error is logged - only a pointer to it is saved. See
7877 * existing callers for examples of how static strings are typically
7878 * defined for use with tracing_log_err().
7880 void tracing_log_err(struct trace_array
*tr
,
7881 const char *loc
, const char *cmd
,
7882 const char **errs
, u8 type
, u16 pos
)
7884 struct tracing_log_err
*err
;
7890 len
+= sizeof(CMD_PREFIX
) + 2 * sizeof("\n") + strlen(cmd
) + 1;
7892 mutex_lock(&tracing_err_log_lock
);
7893 err
= get_tracing_log_err(tr
, len
);
7894 if (PTR_ERR(err
) == -ENOMEM
) {
7895 mutex_unlock(&tracing_err_log_lock
);
7899 snprintf(err
->loc
, TRACING_LOG_LOC_MAX
, "%s: error: ", loc
);
7900 snprintf(err
->cmd
, len
, "\n" CMD_PREFIX
"%s\n", cmd
);
7902 err
->info
.errs
= errs
;
7903 err
->info
.type
= type
;
7904 err
->info
.pos
= pos
;
7905 err
->info
.ts
= local_clock();
7907 list_add_tail(&err
->list
, &tr
->err_log
);
7908 mutex_unlock(&tracing_err_log_lock
);
7911 static void clear_tracing_err_log(struct trace_array
*tr
)
7913 struct tracing_log_err
*err
, *next
;
7915 mutex_lock(&tracing_err_log_lock
);
7916 list_for_each_entry_safe(err
, next
, &tr
->err_log
, list
) {
7917 list_del(&err
->list
);
7918 free_tracing_log_err(err
);
7921 tr
->n_err_log_entries
= 0;
7922 mutex_unlock(&tracing_err_log_lock
);
7925 static void *tracing_err_log_seq_start(struct seq_file
*m
, loff_t
*pos
)
7927 struct trace_array
*tr
= m
->private;
7929 mutex_lock(&tracing_err_log_lock
);
7931 return seq_list_start(&tr
->err_log
, *pos
);
7934 static void *tracing_err_log_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
7936 struct trace_array
*tr
= m
->private;
7938 return seq_list_next(v
, &tr
->err_log
, pos
);
7941 static void tracing_err_log_seq_stop(struct seq_file
*m
, void *v
)
7943 mutex_unlock(&tracing_err_log_lock
);
7946 static void tracing_err_log_show_pos(struct seq_file
*m
, u16 pos
)
7950 for (i
= 0; i
< sizeof(CMD_PREFIX
) - 1; i
++)
7952 for (i
= 0; i
< pos
; i
++)
7957 static int tracing_err_log_seq_show(struct seq_file
*m
, void *v
)
7959 struct tracing_log_err
*err
= v
;
7962 const char *err_text
= err
->info
.errs
[err
->info
.type
];
7963 u64 sec
= err
->info
.ts
;
7966 nsec
= do_div(sec
, NSEC_PER_SEC
);
7967 seq_printf(m
, "[%5llu.%06u] %s%s", sec
, nsec
/ 1000,
7968 err
->loc
, err_text
);
7969 seq_printf(m
, "%s", err
->cmd
);
7970 tracing_err_log_show_pos(m
, err
->info
.pos
);
7976 static const struct seq_operations tracing_err_log_seq_ops
= {
7977 .start
= tracing_err_log_seq_start
,
7978 .next
= tracing_err_log_seq_next
,
7979 .stop
= tracing_err_log_seq_stop
,
7980 .show
= tracing_err_log_seq_show
7983 static int tracing_err_log_open(struct inode
*inode
, struct file
*file
)
7985 struct trace_array
*tr
= inode
->i_private
;
7988 ret
= tracing_check_open_get_tr(tr
);
7992 /* If this file was opened for write, then erase contents */
7993 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
))
7994 clear_tracing_err_log(tr
);
7996 if (file
->f_mode
& FMODE_READ
) {
7997 ret
= seq_open(file
, &tracing_err_log_seq_ops
);
7999 struct seq_file
*m
= file
->private_data
;
8002 trace_array_put(tr
);
8008 static ssize_t
tracing_err_log_write(struct file
*file
,
8009 const char __user
*buffer
,
8010 size_t count
, loff_t
*ppos
)
8015 static int tracing_err_log_release(struct inode
*inode
, struct file
*file
)
8017 struct trace_array
*tr
= inode
->i_private
;
8019 trace_array_put(tr
);
8021 if (file
->f_mode
& FMODE_READ
)
8022 seq_release(inode
, file
);
8027 static const struct file_operations tracing_err_log_fops
= {
8028 .open
= tracing_err_log_open
,
8029 .write
= tracing_err_log_write
,
8031 .llseek
= tracing_lseek
,
8032 .release
= tracing_err_log_release
,
8035 static int tracing_buffers_open(struct inode
*inode
, struct file
*filp
)
8037 struct trace_array
*tr
= inode
->i_private
;
8038 struct ftrace_buffer_info
*info
;
8041 ret
= tracing_check_open_get_tr(tr
);
8045 info
= kvzalloc(sizeof(*info
), GFP_KERNEL
);
8047 trace_array_put(tr
);
8051 mutex_lock(&trace_types_lock
);
8054 info
->iter
.cpu_file
= tracing_get_cpu(inode
);
8055 info
->iter
.trace
= tr
->current_trace
;
8056 info
->iter
.array_buffer
= &tr
->array_buffer
;
8058 /* Force reading ring buffer for first read */
8059 info
->read
= (unsigned int)-1;
8061 filp
->private_data
= info
;
8065 mutex_unlock(&trace_types_lock
);
8067 ret
= nonseekable_open(inode
, filp
);
8069 trace_array_put(tr
);
8075 tracing_buffers_poll(struct file
*filp
, poll_table
*poll_table
)
8077 struct ftrace_buffer_info
*info
= filp
->private_data
;
8078 struct trace_iterator
*iter
= &info
->iter
;
8080 return trace_poll(iter
, filp
, poll_table
);
8084 tracing_buffers_read(struct file
*filp
, char __user
*ubuf
,
8085 size_t count
, loff_t
*ppos
)
8087 struct ftrace_buffer_info
*info
= filp
->private_data
;
8088 struct trace_iterator
*iter
= &info
->iter
;
8097 #ifdef CONFIG_TRACER_MAX_TRACE
8098 if (iter
->snapshot
&& iter
->tr
->current_trace
->use_max_tr
)
8102 page_size
= ring_buffer_subbuf_size_get(iter
->array_buffer
->buffer
);
8104 /* Make sure the spare matches the current sub buffer size */
8106 if (page_size
!= info
->spare_size
) {
8107 ring_buffer_free_read_page(iter
->array_buffer
->buffer
,
8108 info
->spare_cpu
, info
->spare
);
8114 info
->spare
= ring_buffer_alloc_read_page(iter
->array_buffer
->buffer
,
8116 if (IS_ERR(info
->spare
)) {
8117 ret
= PTR_ERR(info
->spare
);
8120 info
->spare_cpu
= iter
->cpu_file
;
8121 info
->spare_size
= page_size
;
8127 /* Do we have previous read data to read? */
8128 if (info
->read
< page_size
)
8132 trace_access_lock(iter
->cpu_file
);
8133 ret
= ring_buffer_read_page(iter
->array_buffer
->buffer
,
8137 trace_access_unlock(iter
->cpu_file
);
8140 if (trace_empty(iter
) && !iter
->closed
) {
8141 if ((filp
->f_flags
& O_NONBLOCK
))
8144 ret
= wait_on_pipe(iter
, 0);
8155 size
= page_size
- info
->read
;
8158 trace_data
= ring_buffer_read_page_data(info
->spare
);
8159 ret
= copy_to_user(ubuf
, trace_data
+ info
->read
, size
);
8171 static int tracing_buffers_flush(struct file
*file
, fl_owner_t id
)
8173 struct ftrace_buffer_info
*info
= file
->private_data
;
8174 struct trace_iterator
*iter
= &info
->iter
;
8176 iter
->closed
= true;
8177 /* Make sure the waiters see the new wait_index */
8178 (void)atomic_fetch_inc_release(&iter
->wait_index
);
8180 ring_buffer_wake_waiters(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8185 static int tracing_buffers_release(struct inode
*inode
, struct file
*file
)
8187 struct ftrace_buffer_info
*info
= file
->private_data
;
8188 struct trace_iterator
*iter
= &info
->iter
;
8190 mutex_lock(&trace_types_lock
);
8192 iter
->tr
->trace_ref
--;
8194 __trace_array_put(iter
->tr
);
8197 ring_buffer_free_read_page(iter
->array_buffer
->buffer
,
8198 info
->spare_cpu
, info
->spare
);
8201 mutex_unlock(&trace_types_lock
);
8207 struct trace_buffer
*buffer
;
8210 refcount_t refcount
;
8213 static void buffer_ref_release(struct buffer_ref
*ref
)
8215 if (!refcount_dec_and_test(&ref
->refcount
))
8217 ring_buffer_free_read_page(ref
->buffer
, ref
->cpu
, ref
->page
);
8221 static void buffer_pipe_buf_release(struct pipe_inode_info
*pipe
,
8222 struct pipe_buffer
*buf
)
8224 struct buffer_ref
*ref
= (struct buffer_ref
*)buf
->private;
8226 buffer_ref_release(ref
);
8230 static bool buffer_pipe_buf_get(struct pipe_inode_info
*pipe
,
8231 struct pipe_buffer
*buf
)
8233 struct buffer_ref
*ref
= (struct buffer_ref
*)buf
->private;
8235 if (refcount_read(&ref
->refcount
) > INT_MAX
/2)
8238 refcount_inc(&ref
->refcount
);
8242 /* Pipe buffer operations for a buffer. */
8243 static const struct pipe_buf_operations buffer_pipe_buf_ops
= {
8244 .release
= buffer_pipe_buf_release
,
8245 .get
= buffer_pipe_buf_get
,
8249 * Callback from splice_to_pipe(), if we need to release some pages
8250 * at the end of the spd in case we error'ed out in filling the pipe.
8252 static void buffer_spd_release(struct splice_pipe_desc
*spd
, unsigned int i
)
8254 struct buffer_ref
*ref
=
8255 (struct buffer_ref
*)spd
->partial
[i
].private;
8257 buffer_ref_release(ref
);
8258 spd
->partial
[i
].private = 0;
8262 tracing_buffers_splice_read(struct file
*file
, loff_t
*ppos
,
8263 struct pipe_inode_info
*pipe
, size_t len
,
8266 struct ftrace_buffer_info
*info
= file
->private_data
;
8267 struct trace_iterator
*iter
= &info
->iter
;
8268 struct partial_page partial_def
[PIPE_DEF_BUFFERS
];
8269 struct page
*pages_def
[PIPE_DEF_BUFFERS
];
8270 struct splice_pipe_desc spd
= {
8272 .partial
= partial_def
,
8273 .nr_pages_max
= PIPE_DEF_BUFFERS
,
8274 .ops
= &buffer_pipe_buf_ops
,
8275 .spd_release
= buffer_spd_release
,
8277 struct buffer_ref
*ref
;
8283 #ifdef CONFIG_TRACER_MAX_TRACE
8284 if (iter
->snapshot
&& iter
->tr
->current_trace
->use_max_tr
)
8288 page_size
= ring_buffer_subbuf_size_get(iter
->array_buffer
->buffer
);
8289 if (*ppos
& (page_size
- 1))
8292 if (len
& (page_size
- 1)) {
8293 if (len
< page_size
)
8295 len
&= (~(page_size
- 1));
8298 if (splice_grow_spd(pipe
, &spd
))
8302 trace_access_lock(iter
->cpu_file
);
8303 entries
= ring_buffer_entries_cpu(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8305 for (i
= 0; i
< spd
.nr_pages_max
&& len
&& entries
; i
++, len
-= page_size
) {
8309 ref
= kzalloc(sizeof(*ref
), GFP_KERNEL
);
8315 refcount_set(&ref
->refcount
, 1);
8316 ref
->buffer
= iter
->array_buffer
->buffer
;
8317 ref
->page
= ring_buffer_alloc_read_page(ref
->buffer
, iter
->cpu_file
);
8318 if (IS_ERR(ref
->page
)) {
8319 ret
= PTR_ERR(ref
->page
);
8324 ref
->cpu
= iter
->cpu_file
;
8326 r
= ring_buffer_read_page(ref
->buffer
, ref
->page
,
8327 len
, iter
->cpu_file
, 1);
8329 ring_buffer_free_read_page(ref
->buffer
, ref
->cpu
,
8335 page
= virt_to_page(ring_buffer_read_page_data(ref
->page
));
8337 spd
.pages
[i
] = page
;
8338 spd
.partial
[i
].len
= page_size
;
8339 spd
.partial
[i
].offset
= 0;
8340 spd
.partial
[i
].private = (unsigned long)ref
;
8344 entries
= ring_buffer_entries_cpu(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8347 trace_access_unlock(iter
->cpu_file
);
8350 /* did we read anything? */
8351 if (!spd
.nr_pages
) {
8360 if ((file
->f_flags
& O_NONBLOCK
) || (flags
& SPLICE_F_NONBLOCK
))
8363 ret
= wait_on_pipe(iter
, iter
->snapshot
? 0 : iter
->tr
->buffer_percent
);
8367 /* No need to wait after waking up when tracing is off */
8368 if (!tracer_tracing_is_on(iter
->tr
))
8371 /* Iterate one more time to collect any new data then exit */
8377 ret
= splice_to_pipe(pipe
, &spd
);
8379 splice_shrink_spd(&spd
);
8384 static long tracing_buffers_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
8386 struct ftrace_buffer_info
*info
= file
->private_data
;
8387 struct trace_iterator
*iter
= &info
->iter
;
8390 if (cmd
== TRACE_MMAP_IOCTL_GET_READER
) {
8391 if (!(file
->f_flags
& O_NONBLOCK
)) {
8392 err
= ring_buffer_wait(iter
->array_buffer
->buffer
,
8394 iter
->tr
->buffer_percent
,
8400 return ring_buffer_map_get_reader(iter
->array_buffer
->buffer
,
8407 * An ioctl call with cmd 0 to the ring buffer file will wake up all
8410 mutex_lock(&trace_types_lock
);
8412 /* Make sure the waiters see the new wait_index */
8413 (void)atomic_fetch_inc_release(&iter
->wait_index
);
8415 ring_buffer_wake_waiters(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8417 mutex_unlock(&trace_types_lock
);
8421 #ifdef CONFIG_TRACER_MAX_TRACE
8422 static int get_snapshot_map(struct trace_array
*tr
)
8427 * Called with mmap_lock held. lockdep would be unhappy if we would now
8428 * take trace_types_lock. Instead use the specific
8429 * snapshot_trigger_lock.
8431 spin_lock(&tr
->snapshot_trigger_lock
);
8433 if (tr
->snapshot
|| tr
->mapped
== UINT_MAX
)
8438 spin_unlock(&tr
->snapshot_trigger_lock
);
8440 /* Wait for update_max_tr() to observe iter->tr->mapped */
8441 if (tr
->mapped
== 1)
8447 static void put_snapshot_map(struct trace_array
*tr
)
8449 spin_lock(&tr
->snapshot_trigger_lock
);
8450 if (!WARN_ON(!tr
->mapped
))
8452 spin_unlock(&tr
->snapshot_trigger_lock
);
8455 static inline int get_snapshot_map(struct trace_array
*tr
) { return 0; }
8456 static inline void put_snapshot_map(struct trace_array
*tr
) { }
8459 static void tracing_buffers_mmap_close(struct vm_area_struct
*vma
)
8461 struct ftrace_buffer_info
*info
= vma
->vm_file
->private_data
;
8462 struct trace_iterator
*iter
= &info
->iter
;
8464 WARN_ON(ring_buffer_unmap(iter
->array_buffer
->buffer
, iter
->cpu_file
));
8465 put_snapshot_map(iter
->tr
);
8468 static const struct vm_operations_struct tracing_buffers_vmops
= {
8469 .close
= tracing_buffers_mmap_close
,
8472 static int tracing_buffers_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
8474 struct ftrace_buffer_info
*info
= filp
->private_data
;
8475 struct trace_iterator
*iter
= &info
->iter
;
8478 ret
= get_snapshot_map(iter
->tr
);
8482 ret
= ring_buffer_map(iter
->array_buffer
->buffer
, iter
->cpu_file
, vma
);
8484 put_snapshot_map(iter
->tr
);
8486 vma
->vm_ops
= &tracing_buffers_vmops
;
8491 static const struct file_operations tracing_buffers_fops
= {
8492 .open
= tracing_buffers_open
,
8493 .read
= tracing_buffers_read
,
8494 .poll
= tracing_buffers_poll
,
8495 .release
= tracing_buffers_release
,
8496 .flush
= tracing_buffers_flush
,
8497 .splice_read
= tracing_buffers_splice_read
,
8498 .unlocked_ioctl
= tracing_buffers_ioctl
,
8499 .mmap
= tracing_buffers_mmap
,
8503 tracing_stats_read(struct file
*filp
, char __user
*ubuf
,
8504 size_t count
, loff_t
*ppos
)
8506 struct inode
*inode
= file_inode(filp
);
8507 struct trace_array
*tr
= inode
->i_private
;
8508 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
8509 int cpu
= tracing_get_cpu(inode
);
8510 struct trace_seq
*s
;
8512 unsigned long long t
;
8513 unsigned long usec_rem
;
8515 s
= kmalloc(sizeof(*s
), GFP_KERNEL
);
8521 cnt
= ring_buffer_entries_cpu(trace_buf
->buffer
, cpu
);
8522 trace_seq_printf(s
, "entries: %ld\n", cnt
);
8524 cnt
= ring_buffer_overrun_cpu(trace_buf
->buffer
, cpu
);
8525 trace_seq_printf(s
, "overrun: %ld\n", cnt
);
8527 cnt
= ring_buffer_commit_overrun_cpu(trace_buf
->buffer
, cpu
);
8528 trace_seq_printf(s
, "commit overrun: %ld\n", cnt
);
8530 cnt
= ring_buffer_bytes_cpu(trace_buf
->buffer
, cpu
);
8531 trace_seq_printf(s
, "bytes: %ld\n", cnt
);
8533 if (trace_clocks
[tr
->clock_id
].in_ns
) {
8534 /* local or global for trace_clock */
8535 t
= ns2usecs(ring_buffer_oldest_event_ts(trace_buf
->buffer
, cpu
));
8536 usec_rem
= do_div(t
, USEC_PER_SEC
);
8537 trace_seq_printf(s
, "oldest event ts: %5llu.%06lu\n",
8540 t
= ns2usecs(ring_buffer_time_stamp(trace_buf
->buffer
));
8541 usec_rem
= do_div(t
, USEC_PER_SEC
);
8542 trace_seq_printf(s
, "now ts: %5llu.%06lu\n", t
, usec_rem
);
8544 /* counter or tsc mode for trace_clock */
8545 trace_seq_printf(s
, "oldest event ts: %llu\n",
8546 ring_buffer_oldest_event_ts(trace_buf
->buffer
, cpu
));
8548 trace_seq_printf(s
, "now ts: %llu\n",
8549 ring_buffer_time_stamp(trace_buf
->buffer
));
8552 cnt
= ring_buffer_dropped_events_cpu(trace_buf
->buffer
, cpu
);
8553 trace_seq_printf(s
, "dropped events: %ld\n", cnt
);
8555 cnt
= ring_buffer_read_events_cpu(trace_buf
->buffer
, cpu
);
8556 trace_seq_printf(s
, "read events: %ld\n", cnt
);
8558 count
= simple_read_from_buffer(ubuf
, count
, ppos
,
8559 s
->buffer
, trace_seq_used(s
));
8566 static const struct file_operations tracing_stats_fops
= {
8567 .open
= tracing_open_generic_tr
,
8568 .read
= tracing_stats_read
,
8569 .llseek
= generic_file_llseek
,
8570 .release
= tracing_release_generic_tr
,
8573 #ifdef CONFIG_DYNAMIC_FTRACE
8576 tracing_read_dyn_info(struct file
*filp
, char __user
*ubuf
,
8577 size_t cnt
, loff_t
*ppos
)
8583 /* 512 should be plenty to hold the amount needed */
8584 #define DYN_INFO_BUF_SIZE 512
8586 buf
= kmalloc(DYN_INFO_BUF_SIZE
, GFP_KERNEL
);
8590 r
= scnprintf(buf
, DYN_INFO_BUF_SIZE
,
8591 "%ld pages:%ld groups: %ld\n"
8592 "ftrace boot update time = %llu (ns)\n"
8593 "ftrace module total update time = %llu (ns)\n",
8594 ftrace_update_tot_cnt
,
8595 ftrace_number_of_pages
,
8596 ftrace_number_of_groups
,
8598 ftrace_total_mod_time
);
8600 ret
= simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
8605 static const struct file_operations tracing_dyn_info_fops
= {
8606 .open
= tracing_open_generic
,
8607 .read
= tracing_read_dyn_info
,
8608 .llseek
= generic_file_llseek
,
8610 #endif /* CONFIG_DYNAMIC_FTRACE */
8612 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
8614 ftrace_snapshot(unsigned long ip
, unsigned long parent_ip
,
8615 struct trace_array
*tr
, struct ftrace_probe_ops
*ops
,
8618 tracing_snapshot_instance(tr
);
8622 ftrace_count_snapshot(unsigned long ip
, unsigned long parent_ip
,
8623 struct trace_array
*tr
, struct ftrace_probe_ops
*ops
,
8626 struct ftrace_func_mapper
*mapper
= data
;
8630 count
= (long *)ftrace_func_mapper_find_ip(mapper
, ip
);
8640 tracing_snapshot_instance(tr
);
8644 ftrace_snapshot_print(struct seq_file
*m
, unsigned long ip
,
8645 struct ftrace_probe_ops
*ops
, void *data
)
8647 struct ftrace_func_mapper
*mapper
= data
;
8650 seq_printf(m
, "%ps:", (void *)ip
);
8652 seq_puts(m
, "snapshot");
8655 count
= (long *)ftrace_func_mapper_find_ip(mapper
, ip
);
8658 seq_printf(m
, ":count=%ld\n", *count
);
8660 seq_puts(m
, ":unlimited\n");
8666 ftrace_snapshot_init(struct ftrace_probe_ops
*ops
, struct trace_array
*tr
,
8667 unsigned long ip
, void *init_data
, void **data
)
8669 struct ftrace_func_mapper
*mapper
= *data
;
8672 mapper
= allocate_ftrace_func_mapper();
8678 return ftrace_func_mapper_add_ip(mapper
, ip
, init_data
);
8682 ftrace_snapshot_free(struct ftrace_probe_ops
*ops
, struct trace_array
*tr
,
8683 unsigned long ip
, void *data
)
8685 struct ftrace_func_mapper
*mapper
= data
;
8690 free_ftrace_func_mapper(mapper
, NULL
);
8694 ftrace_func_mapper_remove_ip(mapper
, ip
);
8697 static struct ftrace_probe_ops snapshot_probe_ops
= {
8698 .func
= ftrace_snapshot
,
8699 .print
= ftrace_snapshot_print
,
8702 static struct ftrace_probe_ops snapshot_count_probe_ops
= {
8703 .func
= ftrace_count_snapshot
,
8704 .print
= ftrace_snapshot_print
,
8705 .init
= ftrace_snapshot_init
,
8706 .free
= ftrace_snapshot_free
,
8710 ftrace_trace_snapshot_callback(struct trace_array
*tr
, struct ftrace_hash
*hash
,
8711 char *glob
, char *cmd
, char *param
, int enable
)
8713 struct ftrace_probe_ops
*ops
;
8714 void *count
= (void *)-1;
8721 /* hash funcs only work with set_ftrace_filter */
8725 ops
= param
? &snapshot_count_probe_ops
: &snapshot_probe_ops
;
8727 if (glob
[0] == '!') {
8728 ret
= unregister_ftrace_function_probe_func(glob
+1, tr
, ops
);
8730 tracing_disarm_snapshot(tr
);
8738 number
= strsep(¶m
, ":");
8740 if (!strlen(number
))
8744 * We use the callback data field (which is a pointer)
8747 ret
= kstrtoul(number
, 0, (unsigned long *)&count
);
8752 ret
= tracing_arm_snapshot(tr
);
8756 ret
= register_ftrace_function_probe(glob
, tr
, ops
, count
);
8758 tracing_disarm_snapshot(tr
);
8760 return ret
< 0 ? ret
: 0;
8763 static struct ftrace_func_command ftrace_snapshot_cmd
= {
8765 .func
= ftrace_trace_snapshot_callback
,
8768 static __init
int register_snapshot_cmd(void)
8770 return register_ftrace_command(&ftrace_snapshot_cmd
);
8773 static inline __init
int register_snapshot_cmd(void) { return 0; }
8774 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
8776 static struct dentry
*tracing_get_dentry(struct trace_array
*tr
)
8778 if (WARN_ON(!tr
->dir
))
8779 return ERR_PTR(-ENODEV
);
8781 /* Top directory uses NULL as the parent */
8782 if (tr
->flags
& TRACE_ARRAY_FL_GLOBAL
)
8785 /* All sub buffers have a descriptor */
8789 static struct dentry
*tracing_dentry_percpu(struct trace_array
*tr
, int cpu
)
8791 struct dentry
*d_tracer
;
8794 return tr
->percpu_dir
;
8796 d_tracer
= tracing_get_dentry(tr
);
8797 if (IS_ERR(d_tracer
))
8800 tr
->percpu_dir
= tracefs_create_dir("per_cpu", d_tracer
);
8802 MEM_FAIL(!tr
->percpu_dir
,
8803 "Could not create tracefs directory 'per_cpu/%d'\n", cpu
);
8805 return tr
->percpu_dir
;
8808 static struct dentry
*
8809 trace_create_cpu_file(const char *name
, umode_t mode
, struct dentry
*parent
,
8810 void *data
, long cpu
, const struct file_operations
*fops
)
8812 struct dentry
*ret
= trace_create_file(name
, mode
, parent
, data
, fops
);
8814 if (ret
) /* See tracing_get_cpu() */
8815 d_inode(ret
)->i_cdev
= (void *)(cpu
+ 1);
8820 tracing_init_tracefs_percpu(struct trace_array
*tr
, long cpu
)
8822 struct dentry
*d_percpu
= tracing_dentry_percpu(tr
, cpu
);
8823 struct dentry
*d_cpu
;
8824 char cpu_dir
[30]; /* 30 characters should be more than enough */
8829 snprintf(cpu_dir
, 30, "cpu%ld", cpu
);
8830 d_cpu
= tracefs_create_dir(cpu_dir
, d_percpu
);
8832 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir
);
8836 /* per cpu trace_pipe */
8837 trace_create_cpu_file("trace_pipe", TRACE_MODE_READ
, d_cpu
,
8838 tr
, cpu
, &tracing_pipe_fops
);
8841 trace_create_cpu_file("trace", TRACE_MODE_WRITE
, d_cpu
,
8842 tr
, cpu
, &tracing_fops
);
8844 trace_create_cpu_file("trace_pipe_raw", TRACE_MODE_READ
, d_cpu
,
8845 tr
, cpu
, &tracing_buffers_fops
);
8847 trace_create_cpu_file("stats", TRACE_MODE_READ
, d_cpu
,
8848 tr
, cpu
, &tracing_stats_fops
);
8850 trace_create_cpu_file("buffer_size_kb", TRACE_MODE_READ
, d_cpu
,
8851 tr
, cpu
, &tracing_entries_fops
);
8853 if (tr
->range_addr_start
)
8854 trace_create_cpu_file("buffer_meta", TRACE_MODE_READ
, d_cpu
,
8855 tr
, cpu
, &tracing_buffer_meta_fops
);
8856 #ifdef CONFIG_TRACER_SNAPSHOT
8857 if (!tr
->range_addr_start
) {
8858 trace_create_cpu_file("snapshot", TRACE_MODE_WRITE
, d_cpu
,
8859 tr
, cpu
, &snapshot_fops
);
8861 trace_create_cpu_file("snapshot_raw", TRACE_MODE_READ
, d_cpu
,
8862 tr
, cpu
, &snapshot_raw_fops
);
8867 #ifdef CONFIG_FTRACE_SELFTEST
8868 /* Let selftest have access to static functions in this file */
8869 #include "trace_selftest.c"
8873 trace_options_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
,
8876 struct trace_option_dentry
*topt
= filp
->private_data
;
8879 if (topt
->flags
->val
& topt
->opt
->bit
)
8884 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, 2);
8888 trace_options_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
8891 struct trace_option_dentry
*topt
= filp
->private_data
;
8895 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
8899 if (val
!= 0 && val
!= 1)
8902 if (!!(topt
->flags
->val
& topt
->opt
->bit
) != val
) {
8903 mutex_lock(&trace_types_lock
);
8904 ret
= __set_tracer_option(topt
->tr
, topt
->flags
,
8906 mutex_unlock(&trace_types_lock
);
8916 static int tracing_open_options(struct inode
*inode
, struct file
*filp
)
8918 struct trace_option_dentry
*topt
= inode
->i_private
;
8921 ret
= tracing_check_open_get_tr(topt
->tr
);
8925 filp
->private_data
= inode
->i_private
;
8929 static int tracing_release_options(struct inode
*inode
, struct file
*file
)
8931 struct trace_option_dentry
*topt
= file
->private_data
;
8933 trace_array_put(topt
->tr
);
8937 static const struct file_operations trace_options_fops
= {
8938 .open
= tracing_open_options
,
8939 .read
= trace_options_read
,
8940 .write
= trace_options_write
,
8941 .llseek
= generic_file_llseek
,
8942 .release
= tracing_release_options
,
8946 * In order to pass in both the trace_array descriptor as well as the index
8947 * to the flag that the trace option file represents, the trace_array
8948 * has a character array of trace_flags_index[], which holds the index
8949 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
8950 * The address of this character array is passed to the flag option file
8951 * read/write callbacks.
8953 * In order to extract both the index and the trace_array descriptor,
8954 * get_tr_index() uses the following algorithm.
8958 * As the pointer itself contains the address of the index (remember
8961 * Then to get the trace_array descriptor, by subtracting that index
8962 * from the ptr, we get to the start of the index itself.
8964 * ptr - idx == &index[0]
8966 * Then a simple container_of() from that pointer gets us to the
8967 * trace_array descriptor.
8969 static void get_tr_index(void *data
, struct trace_array
**ptr
,
8970 unsigned int *pindex
)
8972 *pindex
= *(unsigned char *)data
;
8974 *ptr
= container_of(data
- *pindex
, struct trace_array
,
8979 trace_options_core_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
,
8982 void *tr_index
= filp
->private_data
;
8983 struct trace_array
*tr
;
8987 get_tr_index(tr_index
, &tr
, &index
);
8989 if (tr
->trace_flags
& (1 << index
))
8994 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, 2);
8998 trace_options_core_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
9001 void *tr_index
= filp
->private_data
;
9002 struct trace_array
*tr
;
9007 get_tr_index(tr_index
, &tr
, &index
);
9009 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9013 if (val
!= 0 && val
!= 1)
9016 mutex_lock(&event_mutex
);
9017 mutex_lock(&trace_types_lock
);
9018 ret
= set_tracer_flag(tr
, 1 << index
, val
);
9019 mutex_unlock(&trace_types_lock
);
9020 mutex_unlock(&event_mutex
);
9030 static const struct file_operations trace_options_core_fops
= {
9031 .open
= tracing_open_generic
,
9032 .read
= trace_options_core_read
,
9033 .write
= trace_options_core_write
,
9034 .llseek
= generic_file_llseek
,
9037 struct dentry
*trace_create_file(const char *name
,
9039 struct dentry
*parent
,
9041 const struct file_operations
*fops
)
9045 ret
= tracefs_create_file(name
, mode
, parent
, data
, fops
);
9047 pr_warn("Could not create tracefs '%s' entry\n", name
);
9053 static struct dentry
*trace_options_init_dentry(struct trace_array
*tr
)
9055 struct dentry
*d_tracer
;
9060 d_tracer
= tracing_get_dentry(tr
);
9061 if (IS_ERR(d_tracer
))
9064 tr
->options
= tracefs_create_dir("options", d_tracer
);
9066 pr_warn("Could not create tracefs directory 'options'\n");
9074 create_trace_option_file(struct trace_array
*tr
,
9075 struct trace_option_dentry
*topt
,
9076 struct tracer_flags
*flags
,
9077 struct tracer_opt
*opt
)
9079 struct dentry
*t_options
;
9081 t_options
= trace_options_init_dentry(tr
);
9085 topt
->flags
= flags
;
9089 topt
->entry
= trace_create_file(opt
->name
, TRACE_MODE_WRITE
,
9090 t_options
, topt
, &trace_options_fops
);
9095 create_trace_option_files(struct trace_array
*tr
, struct tracer
*tracer
)
9097 struct trace_option_dentry
*topts
;
9098 struct trace_options
*tr_topts
;
9099 struct tracer_flags
*flags
;
9100 struct tracer_opt
*opts
;
9107 flags
= tracer
->flags
;
9109 if (!flags
|| !flags
->opts
)
9113 * If this is an instance, only create flags for tracers
9114 * the instance may have.
9116 if (!trace_ok_for_array(tracer
, tr
))
9119 for (i
= 0; i
< tr
->nr_topts
; i
++) {
9120 /* Make sure there's no duplicate flags. */
9121 if (WARN_ON_ONCE(tr
->topts
[i
].tracer
->flags
== tracer
->flags
))
9127 for (cnt
= 0; opts
[cnt
].name
; cnt
++)
9130 topts
= kcalloc(cnt
+ 1, sizeof(*topts
), GFP_KERNEL
);
9134 tr_topts
= krealloc(tr
->topts
, sizeof(*tr
->topts
) * (tr
->nr_topts
+ 1),
9141 tr
->topts
= tr_topts
;
9142 tr
->topts
[tr
->nr_topts
].tracer
= tracer
;
9143 tr
->topts
[tr
->nr_topts
].topts
= topts
;
9146 for (cnt
= 0; opts
[cnt
].name
; cnt
++) {
9147 create_trace_option_file(tr
, &topts
[cnt
], flags
,
9149 MEM_FAIL(topts
[cnt
].entry
== NULL
,
9150 "Failed to create trace option: %s",
9155 static struct dentry
*
9156 create_trace_option_core_file(struct trace_array
*tr
,
9157 const char *option
, long index
)
9159 struct dentry
*t_options
;
9161 t_options
= trace_options_init_dentry(tr
);
9165 return trace_create_file(option
, TRACE_MODE_WRITE
, t_options
,
9166 (void *)&tr
->trace_flags_index
[index
],
9167 &trace_options_core_fops
);
9170 static void create_trace_options_dir(struct trace_array
*tr
)
9172 struct dentry
*t_options
;
9173 bool top_level
= tr
== &global_trace
;
9176 t_options
= trace_options_init_dentry(tr
);
9180 for (i
= 0; trace_options
[i
]; i
++) {
9182 !((1 << i
) & TOP_LEVEL_TRACE_FLAGS
))
9183 create_trace_option_core_file(tr
, trace_options
[i
], i
);
9188 rb_simple_read(struct file
*filp
, char __user
*ubuf
,
9189 size_t cnt
, loff_t
*ppos
)
9191 struct trace_array
*tr
= filp
->private_data
;
9195 r
= tracer_tracing_is_on(tr
);
9196 r
= sprintf(buf
, "%d\n", r
);
9198 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9202 rb_simple_write(struct file
*filp
, const char __user
*ubuf
,
9203 size_t cnt
, loff_t
*ppos
)
9205 struct trace_array
*tr
= filp
->private_data
;
9206 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
9210 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9215 mutex_lock(&trace_types_lock
);
9216 if (!!val
== tracer_tracing_is_on(tr
)) {
9217 val
= 0; /* do nothing */
9219 tracer_tracing_on(tr
);
9220 if (tr
->current_trace
->start
)
9221 tr
->current_trace
->start(tr
);
9223 tracer_tracing_off(tr
);
9224 if (tr
->current_trace
->stop
)
9225 tr
->current_trace
->stop(tr
);
9226 /* Wake up any waiters */
9227 ring_buffer_wake_waiters(buffer
, RING_BUFFER_ALL_CPUS
);
9229 mutex_unlock(&trace_types_lock
);
9237 static const struct file_operations rb_simple_fops
= {
9238 .open
= tracing_open_generic_tr
,
9239 .read
= rb_simple_read
,
9240 .write
= rb_simple_write
,
9241 .release
= tracing_release_generic_tr
,
9242 .llseek
= default_llseek
,
9246 buffer_percent_read(struct file
*filp
, char __user
*ubuf
,
9247 size_t cnt
, loff_t
*ppos
)
9249 struct trace_array
*tr
= filp
->private_data
;
9253 r
= tr
->buffer_percent
;
9254 r
= sprintf(buf
, "%d\n", r
);
9256 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9260 buffer_percent_write(struct file
*filp
, const char __user
*ubuf
,
9261 size_t cnt
, loff_t
*ppos
)
9263 struct trace_array
*tr
= filp
->private_data
;
9267 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9274 tr
->buffer_percent
= val
;
9281 static const struct file_operations buffer_percent_fops
= {
9282 .open
= tracing_open_generic_tr
,
9283 .read
= buffer_percent_read
,
9284 .write
= buffer_percent_write
,
9285 .release
= tracing_release_generic_tr
,
9286 .llseek
= default_llseek
,
9290 buffer_subbuf_size_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
9292 struct trace_array
*tr
= filp
->private_data
;
9298 order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
9299 size
= (PAGE_SIZE
<< order
) / 1024;
9301 r
= sprintf(buf
, "%zd\n", size
);
9303 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9307 buffer_subbuf_size_write(struct file
*filp
, const char __user
*ubuf
,
9308 size_t cnt
, loff_t
*ppos
)
9310 struct trace_array
*tr
= filp
->private_data
;
9317 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9321 val
*= 1024; /* value passed in is in KB */
9323 pages
= DIV_ROUND_UP(val
, PAGE_SIZE
);
9324 order
= fls(pages
- 1);
9326 /* limit between 1 and 128 system pages */
9327 if (order
< 0 || order
> 7)
9330 /* Do not allow tracing while changing the order of the ring buffer */
9331 tracing_stop_tr(tr
);
9333 old_order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
9334 if (old_order
== order
)
9337 ret
= ring_buffer_subbuf_order_set(tr
->array_buffer
.buffer
, order
);
9341 #ifdef CONFIG_TRACER_MAX_TRACE
9343 if (!tr
->allocated_snapshot
)
9346 ret
= ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, order
);
9348 /* Put back the old order */
9349 cnt
= ring_buffer_subbuf_order_set(tr
->array_buffer
.buffer
, old_order
);
9350 if (WARN_ON_ONCE(cnt
)) {
9352 * AARGH! We are left with different orders!
9353 * The max buffer is our "snapshot" buffer.
9354 * When a tracer needs a snapshot (one of the
9355 * latency tracers), it swaps the max buffer
9356 * with the saved snap shot. We succeeded to
9357 * update the order of the main buffer, but failed to
9358 * update the order of the max buffer. But when we tried
9359 * to reset the main buffer to the original size, we
9360 * failed there too. This is very unlikely to
9361 * happen, but if it does, warn and kill all
9364 tracing_disabled
= 1;
9374 tracing_start_tr(tr
);
9378 static const struct file_operations buffer_subbuf_size_fops
= {
9379 .open
= tracing_open_generic_tr
,
9380 .read
= buffer_subbuf_size_read
,
9381 .write
= buffer_subbuf_size_write
,
9382 .release
= tracing_release_generic_tr
,
9383 .llseek
= default_llseek
,
9386 static struct dentry
*trace_instance_dir
;
9389 init_tracer_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
);
9392 allocate_trace_buffer(struct trace_array
*tr
, struct array_buffer
*buf
, int size
)
9394 enum ring_buffer_flags rb_flags
;
9396 rb_flags
= tr
->trace_flags
& TRACE_ITER_OVERWRITE
? RB_FL_OVERWRITE
: 0;
9400 if (tr
->range_addr_start
&& tr
->range_addr_size
) {
9401 buf
->buffer
= ring_buffer_alloc_range(size
, rb_flags
, 0,
9402 tr
->range_addr_start
,
9403 tr
->range_addr_size
);
9405 ring_buffer_last_boot_delta(buf
->buffer
,
9406 &tr
->text_delta
, &tr
->data_delta
);
9408 * This is basically the same as a mapped buffer,
9409 * with the same restrictions.
9413 buf
->buffer
= ring_buffer_alloc(size
, rb_flags
);
9418 buf
->data
= alloc_percpu(struct trace_array_cpu
);
9420 ring_buffer_free(buf
->buffer
);
9425 /* Allocate the first page for all buffers */
9426 set_buffer_entries(&tr
->array_buffer
,
9427 ring_buffer_size(tr
->array_buffer
.buffer
, 0));
9432 static void free_trace_buffer(struct array_buffer
*buf
)
9435 ring_buffer_free(buf
->buffer
);
9437 free_percpu(buf
->data
);
9442 static int allocate_trace_buffers(struct trace_array
*tr
, int size
)
9446 ret
= allocate_trace_buffer(tr
, &tr
->array_buffer
, size
);
9450 #ifdef CONFIG_TRACER_MAX_TRACE
9451 /* Fix mapped buffer trace arrays do not have snapshot buffers */
9452 if (tr
->range_addr_start
)
9455 ret
= allocate_trace_buffer(tr
, &tr
->max_buffer
,
9456 allocate_snapshot
? size
: 1);
9457 if (MEM_FAIL(ret
, "Failed to allocate trace buffer\n")) {
9458 free_trace_buffer(&tr
->array_buffer
);
9461 tr
->allocated_snapshot
= allocate_snapshot
;
9463 allocate_snapshot
= false;
9469 static void free_trace_buffers(struct trace_array
*tr
)
9474 free_trace_buffer(&tr
->array_buffer
);
9476 #ifdef CONFIG_TRACER_MAX_TRACE
9477 free_trace_buffer(&tr
->max_buffer
);
9481 static void init_trace_flags_index(struct trace_array
*tr
)
9485 /* Used by the trace options files */
9486 for (i
= 0; i
< TRACE_FLAGS_MAX_SIZE
; i
++)
9487 tr
->trace_flags_index
[i
] = i
;
9490 static void __update_tracer_options(struct trace_array
*tr
)
9494 for (t
= trace_types
; t
; t
= t
->next
)
9495 add_tracer_options(tr
, t
);
9498 static void update_tracer_options(struct trace_array
*tr
)
9500 mutex_lock(&trace_types_lock
);
9501 tracer_options_updated
= true;
9502 __update_tracer_options(tr
);
9503 mutex_unlock(&trace_types_lock
);
9506 /* Must have trace_types_lock held */
9507 struct trace_array
*trace_array_find(const char *instance
)
9509 struct trace_array
*tr
, *found
= NULL
;
9511 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9512 if (tr
->name
&& strcmp(tr
->name
, instance
) == 0) {
9521 struct trace_array
*trace_array_find_get(const char *instance
)
9523 struct trace_array
*tr
;
9525 mutex_lock(&trace_types_lock
);
9526 tr
= trace_array_find(instance
);
9529 mutex_unlock(&trace_types_lock
);
9534 static int trace_array_create_dir(struct trace_array
*tr
)
9538 tr
->dir
= tracefs_create_dir(tr
->name
, trace_instance_dir
);
9542 ret
= event_trace_add_tracer(tr
->dir
, tr
);
9544 tracefs_remove(tr
->dir
);
9548 init_tracer_tracefs(tr
, tr
->dir
);
9549 __update_tracer_options(tr
);
9554 static struct trace_array
*
9555 trace_array_create_systems(const char *name
, const char *systems
,
9556 unsigned long range_addr_start
,
9557 unsigned long range_addr_size
)
9559 struct trace_array
*tr
;
9563 tr
= kzalloc(sizeof(*tr
), GFP_KERNEL
);
9565 return ERR_PTR(ret
);
9567 tr
->name
= kstrdup(name
, GFP_KERNEL
);
9571 if (!alloc_cpumask_var(&tr
->tracing_cpumask
, GFP_KERNEL
))
9574 if (!zalloc_cpumask_var(&tr
->pipe_cpumask
, GFP_KERNEL
))
9578 tr
->system_names
= kstrdup_const(systems
, GFP_KERNEL
);
9579 if (!tr
->system_names
)
9583 /* Only for boot up memory mapped ring buffers */
9584 tr
->range_addr_start
= range_addr_start
;
9585 tr
->range_addr_size
= range_addr_size
;
9587 tr
->trace_flags
= global_trace
.trace_flags
& ~ZEROED_TRACE_FLAGS
;
9589 cpumask_copy(tr
->tracing_cpumask
, cpu_all_mask
);
9591 raw_spin_lock_init(&tr
->start_lock
);
9593 tr
->max_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
9594 #ifdef CONFIG_TRACER_MAX_TRACE
9595 spin_lock_init(&tr
->snapshot_trigger_lock
);
9597 tr
->current_trace
= &nop_trace
;
9599 INIT_LIST_HEAD(&tr
->systems
);
9600 INIT_LIST_HEAD(&tr
->events
);
9601 INIT_LIST_HEAD(&tr
->hist_vars
);
9602 INIT_LIST_HEAD(&tr
->err_log
);
9604 if (allocate_trace_buffers(tr
, trace_buf_size
) < 0)
9607 /* The ring buffer is defaultly expanded */
9608 trace_set_ring_buffer_expanded(tr
);
9610 if (ftrace_allocate_ftrace_ops(tr
) < 0)
9613 ftrace_init_trace_array(tr
);
9615 init_trace_flags_index(tr
);
9617 if (trace_instance_dir
) {
9618 ret
= trace_array_create_dir(tr
);
9622 __trace_early_add_events(tr
);
9624 list_add(&tr
->list
, &ftrace_trace_arrays
);
9631 ftrace_free_ftrace_ops(tr
);
9632 free_trace_buffers(tr
);
9633 free_cpumask_var(tr
->pipe_cpumask
);
9634 free_cpumask_var(tr
->tracing_cpumask
);
9635 kfree_const(tr
->system_names
);
9639 return ERR_PTR(ret
);
9642 static struct trace_array
*trace_array_create(const char *name
)
9644 return trace_array_create_systems(name
, NULL
, 0, 0);
9647 static int instance_mkdir(const char *name
)
9649 struct trace_array
*tr
;
9652 mutex_lock(&event_mutex
);
9653 mutex_lock(&trace_types_lock
);
9656 if (trace_array_find(name
))
9659 tr
= trace_array_create(name
);
9661 ret
= PTR_ERR_OR_ZERO(tr
);
9664 mutex_unlock(&trace_types_lock
);
9665 mutex_unlock(&event_mutex
);
9669 static u64
map_pages(u64 start
, u64 size
)
9671 struct page
**pages
;
9672 phys_addr_t page_start
;
9673 unsigned int page_count
;
9677 page_count
= DIV_ROUND_UP(size
, PAGE_SIZE
);
9680 pages
= kmalloc_array(page_count
, sizeof(struct page
*), GFP_KERNEL
);
9684 for (i
= 0; i
< page_count
; i
++) {
9685 phys_addr_t addr
= page_start
+ i
* PAGE_SIZE
;
9686 pages
[i
] = pfn_to_page(addr
>> PAGE_SHIFT
);
9688 vaddr
= vmap(pages
, page_count
, VM_MAP
, PAGE_KERNEL
);
9691 return (u64
)(unsigned long)vaddr
;
9695 * trace_array_get_by_name - Create/Lookup a trace array, given its name.
9696 * @name: The name of the trace array to be looked up/created.
9697 * @systems: A list of systems to create event directories for (NULL for all)
9699 * Returns pointer to trace array with given name.
9700 * NULL, if it cannot be created.
9702 * NOTE: This function increments the reference counter associated with the
9703 * trace array returned. This makes sure it cannot be freed while in use.
9704 * Use trace_array_put() once the trace array is no longer needed.
9705 * If the trace_array is to be freed, trace_array_destroy() needs to
9706 * be called after the trace_array_put(), or simply let user space delete
9707 * it from the tracefs instances directory. But until the
9708 * trace_array_put() is called, user space can not delete it.
9711 struct trace_array
*trace_array_get_by_name(const char *name
, const char *systems
)
9713 struct trace_array
*tr
;
9715 mutex_lock(&event_mutex
);
9716 mutex_lock(&trace_types_lock
);
9718 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9719 if (tr
->name
&& strcmp(tr
->name
, name
) == 0)
9723 tr
= trace_array_create_systems(name
, systems
, 0, 0);
9731 mutex_unlock(&trace_types_lock
);
9732 mutex_unlock(&event_mutex
);
9735 EXPORT_SYMBOL_GPL(trace_array_get_by_name
);
9737 static int __remove_instance(struct trace_array
*tr
)
9741 /* Reference counter for a newly created trace array = 1. */
9742 if (tr
->ref
> 1 || (tr
->current_trace
&& tr
->trace_ref
))
9745 list_del(&tr
->list
);
9747 /* Disable all the flags that were enabled coming in */
9748 for (i
= 0; i
< TRACE_FLAGS_MAX_SIZE
; i
++) {
9749 if ((1 << i
) & ZEROED_TRACE_FLAGS
)
9750 set_tracer_flag(tr
, 1 << i
, 0);
9753 if (printk_trace
== tr
)
9754 update_printk_trace(&global_trace
);
9756 tracing_set_nop(tr
);
9757 clear_ftrace_function_probes(tr
);
9758 event_trace_del_tracer(tr
);
9759 ftrace_clear_pids(tr
);
9760 ftrace_destroy_function_files(tr
);
9761 tracefs_remove(tr
->dir
);
9762 free_percpu(tr
->last_func_repeats
);
9763 free_trace_buffers(tr
);
9764 clear_tracing_err_log(tr
);
9766 for (i
= 0; i
< tr
->nr_topts
; i
++) {
9767 kfree(tr
->topts
[i
].topts
);
9771 free_cpumask_var(tr
->pipe_cpumask
);
9772 free_cpumask_var(tr
->tracing_cpumask
);
9773 kfree_const(tr
->system_names
);
9780 int trace_array_destroy(struct trace_array
*this_tr
)
9782 struct trace_array
*tr
;
9788 mutex_lock(&event_mutex
);
9789 mutex_lock(&trace_types_lock
);
9793 /* Making sure trace array exists before destroying it. */
9794 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9795 if (tr
== this_tr
) {
9796 ret
= __remove_instance(tr
);
9801 mutex_unlock(&trace_types_lock
);
9802 mutex_unlock(&event_mutex
);
9806 EXPORT_SYMBOL_GPL(trace_array_destroy
);
9808 static int instance_rmdir(const char *name
)
9810 struct trace_array
*tr
;
9813 mutex_lock(&event_mutex
);
9814 mutex_lock(&trace_types_lock
);
9817 tr
= trace_array_find(name
);
9819 ret
= __remove_instance(tr
);
9821 mutex_unlock(&trace_types_lock
);
9822 mutex_unlock(&event_mutex
);
9827 static __init
void create_trace_instances(struct dentry
*d_tracer
)
9829 struct trace_array
*tr
;
9831 trace_instance_dir
= tracefs_create_instance_dir("instances", d_tracer
,
9834 if (MEM_FAIL(!trace_instance_dir
, "Failed to create instances directory\n"))
9837 mutex_lock(&event_mutex
);
9838 mutex_lock(&trace_types_lock
);
9840 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9843 if (MEM_FAIL(trace_array_create_dir(tr
) < 0,
9844 "Failed to create instance directory\n"))
9848 mutex_unlock(&trace_types_lock
);
9849 mutex_unlock(&event_mutex
);
9853 init_tracer_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
)
9857 trace_create_file("available_tracers", TRACE_MODE_READ
, d_tracer
,
9858 tr
, &show_traces_fops
);
9860 trace_create_file("current_tracer", TRACE_MODE_WRITE
, d_tracer
,
9861 tr
, &set_tracer_fops
);
9863 trace_create_file("tracing_cpumask", TRACE_MODE_WRITE
, d_tracer
,
9864 tr
, &tracing_cpumask_fops
);
9866 trace_create_file("trace_options", TRACE_MODE_WRITE
, d_tracer
,
9867 tr
, &tracing_iter_fops
);
9869 trace_create_file("trace", TRACE_MODE_WRITE
, d_tracer
,
9872 trace_create_file("trace_pipe", TRACE_MODE_READ
, d_tracer
,
9873 tr
, &tracing_pipe_fops
);
9875 trace_create_file("buffer_size_kb", TRACE_MODE_WRITE
, d_tracer
,
9876 tr
, &tracing_entries_fops
);
9878 trace_create_file("buffer_total_size_kb", TRACE_MODE_READ
, d_tracer
,
9879 tr
, &tracing_total_entries_fops
);
9881 trace_create_file("free_buffer", 0200, d_tracer
,
9882 tr
, &tracing_free_buffer_fops
);
9884 trace_create_file("trace_marker", 0220, d_tracer
,
9885 tr
, &tracing_mark_fops
);
9887 tr
->trace_marker_file
= __find_event_file(tr
, "ftrace", "print");
9889 trace_create_file("trace_marker_raw", 0220, d_tracer
,
9890 tr
, &tracing_mark_raw_fops
);
9892 trace_create_file("trace_clock", TRACE_MODE_WRITE
, d_tracer
, tr
,
9895 trace_create_file("tracing_on", TRACE_MODE_WRITE
, d_tracer
,
9896 tr
, &rb_simple_fops
);
9898 trace_create_file("timestamp_mode", TRACE_MODE_READ
, d_tracer
, tr
,
9899 &trace_time_stamp_mode_fops
);
9901 tr
->buffer_percent
= 50;
9903 trace_create_file("buffer_percent", TRACE_MODE_WRITE
, d_tracer
,
9904 tr
, &buffer_percent_fops
);
9906 trace_create_file("buffer_subbuf_size_kb", TRACE_MODE_WRITE
, d_tracer
,
9907 tr
, &buffer_subbuf_size_fops
);
9909 create_trace_options_dir(tr
);
9911 #ifdef CONFIG_TRACER_MAX_TRACE
9912 trace_create_maxlat_file(tr
, d_tracer
);
9915 if (ftrace_create_function_files(tr
, d_tracer
))
9916 MEM_FAIL(1, "Could not allocate function filter files");
9918 if (tr
->range_addr_start
) {
9919 trace_create_file("last_boot_info", TRACE_MODE_READ
, d_tracer
,
9920 tr
, &last_boot_fops
);
9921 #ifdef CONFIG_TRACER_SNAPSHOT
9923 trace_create_file("snapshot", TRACE_MODE_WRITE
, d_tracer
,
9924 tr
, &snapshot_fops
);
9928 trace_create_file("error_log", TRACE_MODE_WRITE
, d_tracer
,
9929 tr
, &tracing_err_log_fops
);
9931 for_each_tracing_cpu(cpu
)
9932 tracing_init_tracefs_percpu(tr
, cpu
);
9934 ftrace_init_tracefs(tr
, d_tracer
);
9937 static struct vfsmount
*trace_automount(struct dentry
*mntpt
, void *ingore
)
9939 struct vfsmount
*mnt
;
9940 struct file_system_type
*type
;
9943 * To maintain backward compatibility for tools that mount
9944 * debugfs to get to the tracing facility, tracefs is automatically
9945 * mounted to the debugfs/tracing directory.
9947 type
= get_fs_type("tracefs");
9950 mnt
= vfs_submount(mntpt
, type
, "tracefs", NULL
);
9951 put_filesystem(type
);
9960 * tracing_init_dentry - initialize top level trace array
9962 * This is called when creating files or directories in the tracing
9963 * directory. It is called via fs_initcall() by any of the boot up code
9964 * and expects to return the dentry of the top level tracing directory.
9966 int tracing_init_dentry(void)
9968 struct trace_array
*tr
= &global_trace
;
9970 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
9971 pr_warn("Tracing disabled due to lockdown\n");
9975 /* The top level trace array uses NULL as parent */
9979 if (WARN_ON(!tracefs_initialized()))
9983 * As there may still be users that expect the tracing
9984 * files to exist in debugfs/tracing, we must automount
9985 * the tracefs file system there, so older tools still
9986 * work with the newer kernel.
9988 tr
->dir
= debugfs_create_automount("tracing", NULL
,
9989 trace_automount
, NULL
);
9994 extern struct trace_eval_map
*__start_ftrace_eval_maps
[];
9995 extern struct trace_eval_map
*__stop_ftrace_eval_maps
[];
9997 static struct workqueue_struct
*eval_map_wq __initdata
;
9998 static struct work_struct eval_map_work __initdata
;
9999 static struct work_struct tracerfs_init_work __initdata
;
10001 static void __init
eval_map_work_func(struct work_struct
*work
)
10005 len
= __stop_ftrace_eval_maps
- __start_ftrace_eval_maps
;
10006 trace_insert_eval_map(NULL
, __start_ftrace_eval_maps
, len
);
10009 static int __init
trace_eval_init(void)
10011 INIT_WORK(&eval_map_work
, eval_map_work_func
);
10013 eval_map_wq
= alloc_workqueue("eval_map_wq", WQ_UNBOUND
, 0);
10014 if (!eval_map_wq
) {
10015 pr_err("Unable to allocate eval_map_wq\n");
10017 eval_map_work_func(&eval_map_work
);
10021 queue_work(eval_map_wq
, &eval_map_work
);
10025 subsys_initcall(trace_eval_init
);
10027 static int __init
trace_eval_sync(void)
10029 /* Make sure the eval map updates are finished */
10031 destroy_workqueue(eval_map_wq
);
10035 late_initcall_sync(trace_eval_sync
);
10038 #ifdef CONFIG_MODULES
10039 static void trace_module_add_evals(struct module
*mod
)
10041 if (!mod
->num_trace_evals
)
10045 * Modules with bad taint do not have events created, do
10046 * not bother with enums either.
10048 if (trace_module_has_bad_taint(mod
))
10051 trace_insert_eval_map(mod
, mod
->trace_evals
, mod
->num_trace_evals
);
10054 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
10055 static void trace_module_remove_evals(struct module
*mod
)
10057 union trace_eval_map_item
*map
;
10058 union trace_eval_map_item
**last
= &trace_eval_maps
;
10060 if (!mod
->num_trace_evals
)
10063 mutex_lock(&trace_eval_mutex
);
10065 map
= trace_eval_maps
;
10068 if (map
->head
.mod
== mod
)
10070 map
= trace_eval_jmp_to_tail(map
);
10071 last
= &map
->tail
.next
;
10072 map
= map
->tail
.next
;
10077 *last
= trace_eval_jmp_to_tail(map
)->tail
.next
;
10080 mutex_unlock(&trace_eval_mutex
);
10083 static inline void trace_module_remove_evals(struct module
*mod
) { }
10084 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
10086 static int trace_module_notify(struct notifier_block
*self
,
10087 unsigned long val
, void *data
)
10089 struct module
*mod
= data
;
10092 case MODULE_STATE_COMING
:
10093 trace_module_add_evals(mod
);
10095 case MODULE_STATE_GOING
:
10096 trace_module_remove_evals(mod
);
10103 static struct notifier_block trace_module_nb
= {
10104 .notifier_call
= trace_module_notify
,
10107 #endif /* CONFIG_MODULES */
10109 static __init
void tracer_init_tracefs_work_func(struct work_struct
*work
)
10112 event_trace_init();
10114 init_tracer_tracefs(&global_trace
, NULL
);
10115 ftrace_init_tracefs_toplevel(&global_trace
, NULL
);
10117 trace_create_file("tracing_thresh", TRACE_MODE_WRITE
, NULL
,
10118 &global_trace
, &tracing_thresh_fops
);
10120 trace_create_file("README", TRACE_MODE_READ
, NULL
,
10121 NULL
, &tracing_readme_fops
);
10123 trace_create_file("saved_cmdlines", TRACE_MODE_READ
, NULL
,
10124 NULL
, &tracing_saved_cmdlines_fops
);
10126 trace_create_file("saved_cmdlines_size", TRACE_MODE_WRITE
, NULL
,
10127 NULL
, &tracing_saved_cmdlines_size_fops
);
10129 trace_create_file("saved_tgids", TRACE_MODE_READ
, NULL
,
10130 NULL
, &tracing_saved_tgids_fops
);
10132 trace_create_eval_file(NULL
);
10134 #ifdef CONFIG_MODULES
10135 register_module_notifier(&trace_module_nb
);
10138 #ifdef CONFIG_DYNAMIC_FTRACE
10139 trace_create_file("dyn_ftrace_total_info", TRACE_MODE_READ
, NULL
,
10140 NULL
, &tracing_dyn_info_fops
);
10143 create_trace_instances(NULL
);
10145 update_tracer_options(&global_trace
);
10148 static __init
int tracer_init_tracefs(void)
10152 trace_access_lock_init();
10154 ret
= tracing_init_dentry();
10159 INIT_WORK(&tracerfs_init_work
, tracer_init_tracefs_work_func
);
10160 queue_work(eval_map_wq
, &tracerfs_init_work
);
10162 tracer_init_tracefs_work_func(NULL
);
10165 rv_init_interface();
10170 fs_initcall(tracer_init_tracefs
);
10172 static int trace_die_panic_handler(struct notifier_block
*self
,
10173 unsigned long ev
, void *unused
);
10175 static struct notifier_block trace_panic_notifier
= {
10176 .notifier_call
= trace_die_panic_handler
,
10177 .priority
= INT_MAX
- 1,
10180 static struct notifier_block trace_die_notifier
= {
10181 .notifier_call
= trace_die_panic_handler
,
10182 .priority
= INT_MAX
- 1,
10186 * The idea is to execute the following die/panic callback early, in order
10187 * to avoid showing irrelevant information in the trace (like other panic
10188 * notifier functions); we are the 2nd to run, after hung_task/rcu_stall
10189 * warnings get disabled (to prevent potential log flooding).
10191 static int trace_die_panic_handler(struct notifier_block
*self
,
10192 unsigned long ev
, void *unused
)
10194 if (!ftrace_dump_on_oops_enabled())
10195 return NOTIFY_DONE
;
10197 /* The die notifier requires DIE_OOPS to trigger */
10198 if (self
== &trace_die_notifier
&& ev
!= DIE_OOPS
)
10199 return NOTIFY_DONE
;
10201 ftrace_dump(DUMP_PARAM
);
10203 return NOTIFY_DONE
;
10207 * printk is set to max of 1024, we really don't need it that big.
10208 * Nothing should be printing 1000 characters anyway.
10210 #define TRACE_MAX_PRINT 1000
10213 * Define here KERN_TRACE so that we have one place to modify
10214 * it if we decide to change what log level the ftrace dump
10217 #define KERN_TRACE KERN_EMERG
10220 trace_printk_seq(struct trace_seq
*s
)
10222 /* Probably should print a warning here. */
10223 if (s
->seq
.len
>= TRACE_MAX_PRINT
)
10224 s
->seq
.len
= TRACE_MAX_PRINT
;
10227 * More paranoid code. Although the buffer size is set to
10228 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
10229 * an extra layer of protection.
10231 if (WARN_ON_ONCE(s
->seq
.len
>= s
->seq
.size
))
10232 s
->seq
.len
= s
->seq
.size
- 1;
10234 /* should be zero ended, but we are paranoid. */
10235 s
->buffer
[s
->seq
.len
] = 0;
10237 printk(KERN_TRACE
"%s", s
->buffer
);
10242 static void trace_init_iter(struct trace_iterator
*iter
, struct trace_array
*tr
)
10245 iter
->trace
= iter
->tr
->current_trace
;
10246 iter
->cpu_file
= RING_BUFFER_ALL_CPUS
;
10247 iter
->array_buffer
= &tr
->array_buffer
;
10249 if (iter
->trace
&& iter
->trace
->open
)
10250 iter
->trace
->open(iter
);
10252 /* Annotate start of buffers if we had overruns */
10253 if (ring_buffer_overruns(iter
->array_buffer
->buffer
))
10254 iter
->iter_flags
|= TRACE_FILE_ANNOTATE
;
10256 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
10257 if (trace_clocks
[iter
->tr
->clock_id
].in_ns
)
10258 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
10260 /* Can not use kmalloc for iter.temp and iter.fmt */
10261 iter
->temp
= static_temp_buf
;
10262 iter
->temp_size
= STATIC_TEMP_BUF_SIZE
;
10263 iter
->fmt
= static_fmt_buf
;
10264 iter
->fmt_size
= STATIC_FMT_BUF_SIZE
;
10267 void trace_init_global_iter(struct trace_iterator
*iter
)
10269 trace_init_iter(iter
, &global_trace
);
10272 static void ftrace_dump_one(struct trace_array
*tr
, enum ftrace_dump_mode dump_mode
)
10274 /* use static because iter can be a bit big for the stack */
10275 static struct trace_iterator iter
;
10276 unsigned int old_userobj
;
10277 unsigned long flags
;
10281 * Always turn off tracing when we dump.
10282 * We don't need to show trace output of what happens
10283 * between multiple crashes.
10285 * If the user does a sysrq-z, then they can re-enable
10286 * tracing with echo 1 > tracing_on.
10288 tracer_tracing_off(tr
);
10290 local_irq_save(flags
);
10292 /* Simulate the iterator */
10293 trace_init_iter(&iter
, tr
);
10295 for_each_tracing_cpu(cpu
) {
10296 atomic_inc(&per_cpu_ptr(iter
.array_buffer
->data
, cpu
)->disabled
);
10299 old_userobj
= tr
->trace_flags
& TRACE_ITER_SYM_USEROBJ
;
10301 /* don't look at user memory in panic mode */
10302 tr
->trace_flags
&= ~TRACE_ITER_SYM_USEROBJ
;
10304 if (dump_mode
== DUMP_ORIG
)
10305 iter
.cpu_file
= raw_smp_processor_id();
10307 iter
.cpu_file
= RING_BUFFER_ALL_CPUS
;
10309 if (tr
== &global_trace
)
10310 printk(KERN_TRACE
"Dumping ftrace buffer:\n");
10312 printk(KERN_TRACE
"Dumping ftrace instance %s buffer:\n", tr
->name
);
10314 /* Did function tracer already get disabled? */
10315 if (ftrace_is_dead()) {
10316 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
10317 printk("# MAY BE MISSING FUNCTION EVENTS\n");
10321 * We need to stop all tracing on all CPUS to read
10322 * the next buffer. This is a bit expensive, but is
10323 * not done often. We fill all what we can read,
10324 * and then release the locks again.
10327 while (!trace_empty(&iter
)) {
10330 printk(KERN_TRACE
"---------------------------------\n");
10334 trace_iterator_reset(&iter
);
10335 iter
.iter_flags
|= TRACE_FILE_LAT_FMT
;
10337 if (trace_find_next_entry_inc(&iter
) != NULL
) {
10340 ret
= print_trace_line(&iter
);
10341 if (ret
!= TRACE_TYPE_NO_CONSUME
)
10342 trace_consume(&iter
);
10344 touch_nmi_watchdog();
10346 trace_printk_seq(&iter
.seq
);
10350 printk(KERN_TRACE
" (ftrace buffer empty)\n");
10352 printk(KERN_TRACE
"---------------------------------\n");
10354 tr
->trace_flags
|= old_userobj
;
10356 for_each_tracing_cpu(cpu
) {
10357 atomic_dec(&per_cpu_ptr(iter
.array_buffer
->data
, cpu
)->disabled
);
10359 local_irq_restore(flags
);
10362 static void ftrace_dump_by_param(void)
10364 bool first_param
= true;
10365 char dump_param
[MAX_TRACER_SIZE
];
10366 char *buf
, *token
, *inst_name
;
10367 struct trace_array
*tr
;
10369 strscpy(dump_param
, ftrace_dump_on_oops
, MAX_TRACER_SIZE
);
10372 while ((token
= strsep(&buf
, ",")) != NULL
) {
10374 first_param
= false;
10375 if (!strcmp("0", token
))
10377 else if (!strcmp("1", token
)) {
10378 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10381 else if (!strcmp("2", token
) ||
10382 !strcmp("orig_cpu", token
)) {
10383 ftrace_dump_one(&global_trace
, DUMP_ORIG
);
10388 inst_name
= strsep(&token
, "=");
10389 tr
= trace_array_find(inst_name
);
10391 printk(KERN_TRACE
"Instance %s not found\n", inst_name
);
10395 if (token
&& (!strcmp("2", token
) ||
10396 !strcmp("orig_cpu", token
)))
10397 ftrace_dump_one(tr
, DUMP_ORIG
);
10399 ftrace_dump_one(tr
, DUMP_ALL
);
10403 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode
)
10405 static atomic_t dump_running
;
10407 /* Only allow one dump user at a time. */
10408 if (atomic_inc_return(&dump_running
) != 1) {
10409 atomic_dec(&dump_running
);
10413 switch (oops_dump_mode
) {
10415 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10418 ftrace_dump_one(&global_trace
, DUMP_ORIG
);
10421 ftrace_dump_by_param();
10426 printk(KERN_TRACE
"Bad dumping mode, switching to all CPUs dump\n");
10427 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10430 atomic_dec(&dump_running
);
10432 EXPORT_SYMBOL_GPL(ftrace_dump
);
10434 #define WRITE_BUFSIZE 4096
10436 ssize_t
trace_parse_run_command(struct file
*file
, const char __user
*buffer
,
10437 size_t count
, loff_t
*ppos
,
10438 int (*createfn
)(const char *))
10440 char *kbuf
, *buf
, *tmp
;
10445 kbuf
= kmalloc(WRITE_BUFSIZE
, GFP_KERNEL
);
10449 while (done
< count
) {
10450 size
= count
- done
;
10452 if (size
>= WRITE_BUFSIZE
)
10453 size
= WRITE_BUFSIZE
- 1;
10455 if (copy_from_user(kbuf
, buffer
+ done
, size
)) {
10462 tmp
= strchr(buf
, '\n');
10465 size
= tmp
- buf
+ 1;
10467 size
= strlen(buf
);
10468 if (done
+ size
< count
) {
10471 /* This can accept WRITE_BUFSIZE - 2 ('\n' + '\0') */
10472 pr_warn("Line length is too long: Should be less than %d\n",
10473 WRITE_BUFSIZE
- 2);
10480 /* Remove comments */
10481 tmp
= strchr(buf
, '#');
10486 ret
= createfn(buf
);
10491 } while (done
< count
);
10501 #ifdef CONFIG_TRACER_MAX_TRACE
10502 __init
static bool tr_needs_alloc_snapshot(const char *name
)
10505 int len
= strlen(name
);
10508 if (!boot_snapshot_index
)
10511 if (strncmp(name
, boot_snapshot_info
, len
) == 0 &&
10512 boot_snapshot_info
[len
] == '\t')
10515 test
= kmalloc(strlen(name
) + 3, GFP_KERNEL
);
10519 sprintf(test
, "\t%s\t", name
);
10520 ret
= strstr(boot_snapshot_info
, test
) == NULL
;
10525 __init
static void do_allocate_snapshot(const char *name
)
10527 if (!tr_needs_alloc_snapshot(name
))
10531 * When allocate_snapshot is set, the next call to
10532 * allocate_trace_buffers() (called by trace_array_get_by_name())
10533 * will allocate the snapshot buffer. That will alse clear
10536 allocate_snapshot
= true;
10539 static inline void do_allocate_snapshot(const char *name
) { }
10542 __init
static void enable_instances(void)
10544 struct trace_array
*tr
;
10550 /* A tab is always appended */
10551 boot_instance_info
[boot_instance_index
- 1] = '\0';
10552 str
= boot_instance_info
;
10554 while ((curr_str
= strsep(&str
, "\t"))) {
10555 phys_addr_t start
= 0;
10556 phys_addr_t size
= 0;
10557 unsigned long addr
= 0;
10558 bool traceprintk
= false;
10559 bool traceoff
= false;
10563 tok
= strsep(&curr_str
, ",");
10565 flag_delim
= strchr(tok
, '^');
10566 addr_delim
= strchr(tok
, '@');
10569 *addr_delim
++ = '\0';
10572 *flag_delim
++ = '\0';
10579 while ((flag
= strsep(&flag_delim
, "^"))) {
10580 if (strcmp(flag
, "traceoff") == 0) {
10582 } else if ((strcmp(flag
, "printk") == 0) ||
10583 (strcmp(flag
, "traceprintk") == 0) ||
10584 (strcmp(flag
, "trace_printk") == 0)) {
10585 traceprintk
= true;
10587 pr_info("Tracing: Invalid instance flag '%s' for %s\n",
10594 if (tok
&& isdigit(*tok
)) {
10595 start
= memparse(tok
, &tok
);
10597 pr_warn("Tracing: Invalid boot instance address for %s\n",
10602 pr_warn("Tracing: No size specified for instance %s\n", name
);
10606 size
= memparse(tok
, &tok
);
10608 pr_warn("Tracing: Invalid boot instance size for %s\n",
10613 if (!reserve_mem_find_by_name(tok
, &start
, &size
)) {
10615 pr_warn("Failed to map boot instance %s to %s\n", name
, tok
);
10621 addr
= map_pages(start
, size
);
10623 pr_info("Tracing: mapped boot instance %s at physical memory %pa of size 0x%lx\n",
10624 name
, &start
, (unsigned long)size
);
10626 pr_warn("Tracing: Failed to map boot instance %s\n", name
);
10630 /* Only non mapped buffers have snapshot buffers */
10631 if (IS_ENABLED(CONFIG_TRACER_MAX_TRACE
))
10632 do_allocate_snapshot(name
);
10635 tr
= trace_array_create_systems(name
, NULL
, addr
, size
);
10637 pr_warn("Tracing: Failed to create instance buffer %s\n", curr_str
);
10642 tracer_tracing_off(tr
);
10645 update_printk_trace(tr
);
10648 * If start is set, then this is a mapped buffer, and
10649 * cannot be deleted by user space, so keep the reference
10653 tr
->flags
|= TRACE_ARRAY_FL_BOOT
;
10657 while ((tok
= strsep(&curr_str
, ","))) {
10658 early_enable_events(tr
, tok
, true);
10663 __init
static int tracer_alloc_buffers(void)
10669 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
10670 pr_warn("Tracing disabled due to lockdown\n");
10675 * Make sure we don't accidentally add more trace options
10676 * than we have bits for.
10678 BUILD_BUG_ON(TRACE_ITER_LAST_BIT
> TRACE_FLAGS_MAX_SIZE
);
10680 if (!alloc_cpumask_var(&tracing_buffer_mask
, GFP_KERNEL
))
10683 if (!alloc_cpumask_var(&global_trace
.tracing_cpumask
, GFP_KERNEL
))
10684 goto out_free_buffer_mask
;
10686 /* Only allocate trace_printk buffers if a trace_printk exists */
10687 if (&__stop___trace_bprintk_fmt
!= &__start___trace_bprintk_fmt
)
10688 /* Must be called before global_trace.buffer is allocated */
10689 trace_printk_init_buffers();
10691 /* To save memory, keep the ring buffer size to its minimum */
10692 if (global_trace
.ring_buffer_expanded
)
10693 ring_buf_size
= trace_buf_size
;
10697 cpumask_copy(tracing_buffer_mask
, cpu_possible_mask
);
10698 cpumask_copy(global_trace
.tracing_cpumask
, cpu_all_mask
);
10700 raw_spin_lock_init(&global_trace
.start_lock
);
10703 * The prepare callbacks allocates some memory for the ring buffer. We
10704 * don't free the buffer if the CPU goes down. If we were to free
10705 * the buffer, then the user would lose any trace that was in the
10706 * buffer. The memory will be removed once the "instance" is removed.
10708 ret
= cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE
,
10709 "trace/RB:prepare", trace_rb_cpu_prepare
,
10712 goto out_free_cpumask
;
10713 /* Used for event triggers */
10715 temp_buffer
= ring_buffer_alloc(PAGE_SIZE
, RB_FL_OVERWRITE
);
10717 goto out_rm_hp_state
;
10719 if (trace_create_savedcmd() < 0)
10720 goto out_free_temp_buffer
;
10722 if (!zalloc_cpumask_var(&global_trace
.pipe_cpumask
, GFP_KERNEL
))
10723 goto out_free_savedcmd
;
10725 /* TODO: make the number of buffers hot pluggable with CPUS */
10726 if (allocate_trace_buffers(&global_trace
, ring_buf_size
) < 0) {
10727 MEM_FAIL(1, "tracer: failed to allocate ring buffer!\n");
10728 goto out_free_pipe_cpumask
;
10730 if (global_trace
.buffer_disabled
)
10733 if (trace_boot_clock
) {
10734 ret
= tracing_set_clock(&global_trace
, trace_boot_clock
);
10736 pr_warn("Trace clock %s not defined, going back to default\n",
10741 * register_tracer() might reference current_trace, so it
10742 * needs to be set before we register anything. This is
10743 * just a bootstrap of current_trace anyway.
10745 global_trace
.current_trace
= &nop_trace
;
10747 global_trace
.max_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
10748 #ifdef CONFIG_TRACER_MAX_TRACE
10749 spin_lock_init(&global_trace
.snapshot_trigger_lock
);
10751 ftrace_init_global_array_ops(&global_trace
);
10753 init_trace_flags_index(&global_trace
);
10755 register_tracer(&nop_trace
);
10757 /* Function tracing may start here (via kernel command line) */
10758 init_function_trace();
10760 /* All seems OK, enable tracing */
10761 tracing_disabled
= 0;
10763 atomic_notifier_chain_register(&panic_notifier_list
,
10764 &trace_panic_notifier
);
10766 register_die_notifier(&trace_die_notifier
);
10768 global_trace
.flags
= TRACE_ARRAY_FL_GLOBAL
;
10770 INIT_LIST_HEAD(&global_trace
.systems
);
10771 INIT_LIST_HEAD(&global_trace
.events
);
10772 INIT_LIST_HEAD(&global_trace
.hist_vars
);
10773 INIT_LIST_HEAD(&global_trace
.err_log
);
10774 list_add(&global_trace
.list
, &ftrace_trace_arrays
);
10776 apply_trace_boot_options();
10778 register_snapshot_cmd();
10784 out_free_pipe_cpumask
:
10785 free_cpumask_var(global_trace
.pipe_cpumask
);
10787 trace_free_saved_cmdlines_buffer();
10788 out_free_temp_buffer
:
10789 ring_buffer_free(temp_buffer
);
10791 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE
);
10793 free_cpumask_var(global_trace
.tracing_cpumask
);
10794 out_free_buffer_mask
:
10795 free_cpumask_var(tracing_buffer_mask
);
10800 void __init
ftrace_boot_snapshot(void)
10802 #ifdef CONFIG_TRACER_MAX_TRACE
10803 struct trace_array
*tr
;
10805 if (!snapshot_at_boot
)
10808 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
10809 if (!tr
->allocated_snapshot
)
10812 tracing_snapshot_instance(tr
);
10813 trace_array_puts(tr
, "** Boot snapshot taken **\n");
10818 void __init
early_trace_init(void)
10820 if (tracepoint_printk
) {
10821 tracepoint_print_iter
=
10822 kzalloc(sizeof(*tracepoint_print_iter
), GFP_KERNEL
);
10823 if (MEM_FAIL(!tracepoint_print_iter
,
10824 "Failed to allocate trace iterator\n"))
10825 tracepoint_printk
= 0;
10827 static_key_enable(&tracepoint_printk_key
.key
);
10829 tracer_alloc_buffers();
10834 void __init
trace_init(void)
10836 trace_event_init();
10838 if (boot_instance_index
)
10839 enable_instances();
10842 __init
static void clear_boot_tracer(void)
10845 * The default tracer at boot buffer is an init section.
10846 * This function is called in lateinit. If we did not
10847 * find the boot tracer, then clear it out, to prevent
10848 * later registration from accessing the buffer that is
10849 * about to be freed.
10851 if (!default_bootup_tracer
)
10854 printk(KERN_INFO
"ftrace bootup tracer '%s' not registered.\n",
10855 default_bootup_tracer
);
10856 default_bootup_tracer
= NULL
;
10859 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
10860 __init
static void tracing_set_default_clock(void)
10862 /* sched_clock_stable() is determined in late_initcall */
10863 if (!trace_boot_clock
&& !sched_clock_stable()) {
10864 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
10865 pr_warn("Can not set tracing clock due to lockdown\n");
10869 printk(KERN_WARNING
10870 "Unstable clock detected, switching default tracing clock to \"global\"\n"
10871 "If you want to keep using the local clock, then add:\n"
10872 " \"trace_clock=local\"\n"
10873 "on the kernel command line\n");
10874 tracing_set_clock(&global_trace
, "global");
10878 static inline void tracing_set_default_clock(void) { }
10881 __init
static int late_trace_init(void)
10883 if (tracepoint_printk
&& tracepoint_printk_stop_on_boot
) {
10884 static_key_disable(&tracepoint_printk_key
.key
);
10885 tracepoint_printk
= 0;
10888 tracing_set_default_clock();
10889 clear_boot_tracer();
10893 late_initcall_sync(late_trace_init
);