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)
596 int call_filter_check_discard(struct trace_event_call
*call
, void *rec
,
597 struct trace_buffer
*buffer
,
598 struct ring_buffer_event
*event
)
600 if (unlikely(call
->flags
& TRACE_EVENT_FL_FILTERED
) &&
601 !filter_match_preds(call
->filter
, rec
)) {
602 __trace_event_discard_commit(buffer
, event
);
610 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
611 * @filtered_pids: The list of pids to check
612 * @search_pid: The PID to find in @filtered_pids
614 * Returns true if @search_pid is found in @filtered_pids, and false otherwise.
617 trace_find_filtered_pid(struct trace_pid_list
*filtered_pids
, pid_t search_pid
)
619 return trace_pid_list_is_set(filtered_pids
, search_pid
);
623 * trace_ignore_this_task - should a task be ignored for tracing
624 * @filtered_pids: The list of pids to check
625 * @filtered_no_pids: The list of pids not to be traced
626 * @task: The task that should be ignored if not filtered
628 * Checks if @task should be traced or not from @filtered_pids.
629 * Returns true if @task should *NOT* be traced.
630 * Returns false if @task should be traced.
633 trace_ignore_this_task(struct trace_pid_list
*filtered_pids
,
634 struct trace_pid_list
*filtered_no_pids
,
635 struct task_struct
*task
)
638 * If filtered_no_pids is not empty, and the task's pid is listed
639 * in filtered_no_pids, then return true.
640 * Otherwise, if filtered_pids is empty, that means we can
641 * trace all tasks. If it has content, then only trace pids
642 * within filtered_pids.
645 return (filtered_pids
&&
646 !trace_find_filtered_pid(filtered_pids
, task
->pid
)) ||
648 trace_find_filtered_pid(filtered_no_pids
, task
->pid
));
652 * trace_filter_add_remove_task - Add or remove a task from a pid_list
653 * @pid_list: The list to modify
654 * @self: The current task for fork or NULL for exit
655 * @task: The task to add or remove
657 * If adding a task, if @self is defined, the task is only added if @self
658 * is also included in @pid_list. This happens on fork and tasks should
659 * only be added when the parent is listed. If @self is NULL, then the
660 * @task pid will be removed from the list, which would happen on exit
663 void trace_filter_add_remove_task(struct trace_pid_list
*pid_list
,
664 struct task_struct
*self
,
665 struct task_struct
*task
)
670 /* For forks, we only add if the forking task is listed */
672 if (!trace_find_filtered_pid(pid_list
, self
->pid
))
676 /* "self" is set for forks, and NULL for exits */
678 trace_pid_list_set(pid_list
, task
->pid
);
680 trace_pid_list_clear(pid_list
, task
->pid
);
684 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
685 * @pid_list: The pid list to show
686 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
687 * @pos: The position of the file
689 * This is used by the seq_file "next" operation to iterate the pids
690 * listed in a trace_pid_list structure.
692 * Returns the pid+1 as we want to display pid of zero, but NULL would
693 * stop the iteration.
695 void *trace_pid_next(struct trace_pid_list
*pid_list
, void *v
, loff_t
*pos
)
697 long pid
= (unsigned long)v
;
702 /* pid already is +1 of the actual previous bit */
703 if (trace_pid_list_next(pid_list
, pid
, &next
) < 0)
708 /* Return pid + 1 to allow zero to be represented */
709 return (void *)(pid
+ 1);
713 * trace_pid_start - Used for seq_file to start reading pid lists
714 * @pid_list: The pid list to show
715 * @pos: The position of the file
717 * This is used by seq_file "start" operation to start the iteration
720 * Returns the pid+1 as we want to display pid of zero, but NULL would
721 * stop the iteration.
723 void *trace_pid_start(struct trace_pid_list
*pid_list
, loff_t
*pos
)
729 if (trace_pid_list_first(pid_list
, &first
) < 0)
734 /* Return pid + 1 so that zero can be the exit value */
735 for (pid
++; pid
&& l
< *pos
;
736 pid
= (unsigned long)trace_pid_next(pid_list
, (void *)pid
, &l
))
742 * trace_pid_show - show the current pid in seq_file processing
743 * @m: The seq_file structure to write into
744 * @v: A void pointer of the pid (+1) value to display
746 * Can be directly used by seq_file operations to display the current
749 int trace_pid_show(struct seq_file
*m
, void *v
)
751 unsigned long pid
= (unsigned long)v
- 1;
753 seq_printf(m
, "%lu\n", pid
);
757 /* 128 should be much more than enough */
758 #define PID_BUF_SIZE 127
760 int trace_pid_write(struct trace_pid_list
*filtered_pids
,
761 struct trace_pid_list
**new_pid_list
,
762 const char __user
*ubuf
, size_t cnt
)
764 struct trace_pid_list
*pid_list
;
765 struct trace_parser parser
;
773 if (trace_parser_get_init(&parser
, PID_BUF_SIZE
+ 1))
777 * Always recreate a new array. The write is an all or nothing
778 * operation. Always create a new array when adding new pids by
779 * the user. If the operation fails, then the current list is
782 pid_list
= trace_pid_list_alloc();
784 trace_parser_put(&parser
);
789 /* copy the current bits to the new max */
790 ret
= trace_pid_list_first(filtered_pids
, &pid
);
792 trace_pid_list_set(pid_list
, pid
);
793 ret
= trace_pid_list_next(filtered_pids
, pid
+ 1, &pid
);
803 ret
= trace_get_user(&parser
, ubuf
, cnt
, &pos
);
811 if (!trace_parser_loaded(&parser
))
815 if (kstrtoul(parser
.buffer
, 0, &val
))
820 if (trace_pid_list_set(pid_list
, pid
) < 0) {
826 trace_parser_clear(&parser
);
829 trace_parser_put(&parser
);
832 trace_pid_list_free(pid_list
);
837 /* Cleared the list of pids */
838 trace_pid_list_free(pid_list
);
842 *new_pid_list
= pid_list
;
847 static u64
buffer_ftrace_now(struct array_buffer
*buf
, int cpu
)
851 /* Early boot up does not have a buffer yet */
853 return trace_clock_local();
855 ts
= ring_buffer_time_stamp(buf
->buffer
);
856 ring_buffer_normalize_time_stamp(buf
->buffer
, cpu
, &ts
);
861 u64
ftrace_now(int cpu
)
863 return buffer_ftrace_now(&global_trace
.array_buffer
, cpu
);
867 * tracing_is_enabled - Show if global_trace has been enabled
869 * Shows if the global trace has been enabled or not. It uses the
870 * mirror flag "buffer_disabled" to be used in fast paths such as for
871 * the irqsoff tracer. But it may be inaccurate due to races. If you
872 * need to know the accurate state, use tracing_is_on() which is a little
873 * slower, but accurate.
875 int tracing_is_enabled(void)
878 * For quick access (irqsoff uses this in fast path), just
879 * return the mirror variable of the state of the ring buffer.
880 * It's a little racy, but we don't really care.
883 return !global_trace
.buffer_disabled
;
887 * trace_buf_size is the size in bytes that is allocated
888 * for a buffer. Note, the number of bytes is always rounded
891 * This number is purposely set to a low number of 16384.
892 * If the dump on oops happens, it will be much appreciated
893 * to not have to wait for all that output. Anyway this can be
894 * boot time and run time configurable.
896 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
898 static unsigned long trace_buf_size
= TRACE_BUF_SIZE_DEFAULT
;
900 /* trace_types holds a link list of available tracers. */
901 static struct tracer
*trace_types __read_mostly
;
904 * trace_types_lock is used to protect the trace_types list.
906 DEFINE_MUTEX(trace_types_lock
);
909 * serialize the access of the ring buffer
911 * ring buffer serializes readers, but it is low level protection.
912 * The validity of the events (which returns by ring_buffer_peek() ..etc)
913 * are not protected by ring buffer.
915 * The content of events may become garbage if we allow other process consumes
916 * these events concurrently:
917 * A) the page of the consumed events may become a normal page
918 * (not reader page) in ring buffer, and this page will be rewritten
919 * by events producer.
920 * B) The page of the consumed events may become a page for splice_read,
921 * and this page will be returned to system.
923 * These primitives allow multi process access to different cpu ring buffer
926 * These primitives don't distinguish read-only and read-consume access.
927 * Multi read-only access are also serialized.
931 static DECLARE_RWSEM(all_cpu_access_lock
);
932 static DEFINE_PER_CPU(struct mutex
, cpu_access_lock
);
934 static inline void trace_access_lock(int cpu
)
936 if (cpu
== RING_BUFFER_ALL_CPUS
) {
937 /* gain it for accessing the whole ring buffer. */
938 down_write(&all_cpu_access_lock
);
940 /* gain it for accessing a cpu ring buffer. */
942 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
943 down_read(&all_cpu_access_lock
);
945 /* Secondly block other access to this @cpu ring buffer. */
946 mutex_lock(&per_cpu(cpu_access_lock
, cpu
));
950 static inline void trace_access_unlock(int cpu
)
952 if (cpu
== RING_BUFFER_ALL_CPUS
) {
953 up_write(&all_cpu_access_lock
);
955 mutex_unlock(&per_cpu(cpu_access_lock
, cpu
));
956 up_read(&all_cpu_access_lock
);
960 static inline void trace_access_lock_init(void)
964 for_each_possible_cpu(cpu
)
965 mutex_init(&per_cpu(cpu_access_lock
, cpu
));
970 static DEFINE_MUTEX(access_lock
);
972 static inline void trace_access_lock(int cpu
)
975 mutex_lock(&access_lock
);
978 static inline void trace_access_unlock(int cpu
)
981 mutex_unlock(&access_lock
);
984 static inline void trace_access_lock_init(void)
990 #ifdef CONFIG_STACKTRACE
991 static void __ftrace_trace_stack(struct trace_buffer
*buffer
,
992 unsigned int trace_ctx
,
993 int skip
, struct pt_regs
*regs
);
994 static inline void ftrace_trace_stack(struct trace_array
*tr
,
995 struct trace_buffer
*buffer
,
996 unsigned int trace_ctx
,
997 int skip
, struct pt_regs
*regs
);
1000 static inline void __ftrace_trace_stack(struct trace_buffer
*buffer
,
1001 unsigned int trace_ctx
,
1002 int skip
, struct pt_regs
*regs
)
1005 static inline void ftrace_trace_stack(struct trace_array
*tr
,
1006 struct trace_buffer
*buffer
,
1007 unsigned long trace_ctx
,
1008 int skip
, struct pt_regs
*regs
)
1014 static __always_inline
void
1015 trace_event_setup(struct ring_buffer_event
*event
,
1016 int type
, unsigned int trace_ctx
)
1018 struct trace_entry
*ent
= ring_buffer_event_data(event
);
1020 tracing_generic_entry_update(ent
, type
, trace_ctx
);
1023 static __always_inline
struct ring_buffer_event
*
1024 __trace_buffer_lock_reserve(struct trace_buffer
*buffer
,
1027 unsigned int trace_ctx
)
1029 struct ring_buffer_event
*event
;
1031 event
= ring_buffer_lock_reserve(buffer
, len
);
1033 trace_event_setup(event
, type
, trace_ctx
);
1038 void tracer_tracing_on(struct trace_array
*tr
)
1040 if (tr
->array_buffer
.buffer
)
1041 ring_buffer_record_on(tr
->array_buffer
.buffer
);
1043 * This flag is looked at when buffers haven't been allocated
1044 * yet, or by some tracers (like irqsoff), that just want to
1045 * know if the ring buffer has been disabled, but it can handle
1046 * races of where it gets disabled but we still do a record.
1047 * As the check is in the fast path of the tracers, it is more
1048 * important to be fast than accurate.
1050 tr
->buffer_disabled
= 0;
1051 /* Make the flag seen by readers */
1056 * tracing_on - enable tracing buffers
1058 * This function enables tracing buffers that may have been
1059 * disabled with tracing_off.
1061 void tracing_on(void)
1063 tracer_tracing_on(&global_trace
);
1065 EXPORT_SYMBOL_GPL(tracing_on
);
1068 static __always_inline
void
1069 __buffer_unlock_commit(struct trace_buffer
*buffer
, struct ring_buffer_event
*event
)
1071 __this_cpu_write(trace_taskinfo_save
, true);
1073 /* If this is the temp buffer, we need to commit fully */
1074 if (this_cpu_read(trace_buffered_event
) == event
) {
1075 /* Length is in event->array[0] */
1076 ring_buffer_write(buffer
, event
->array
[0], &event
->array
[1]);
1077 /* Release the temp buffer */
1078 this_cpu_dec(trace_buffered_event_cnt
);
1079 /* ring_buffer_unlock_commit() enables preemption */
1080 preempt_enable_notrace();
1082 ring_buffer_unlock_commit(buffer
);
1085 int __trace_array_puts(struct trace_array
*tr
, unsigned long ip
,
1086 const char *str
, int size
)
1088 struct ring_buffer_event
*event
;
1089 struct trace_buffer
*buffer
;
1090 struct print_entry
*entry
;
1091 unsigned int trace_ctx
;
1094 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
1097 if (unlikely(tracing_selftest_running
&& tr
== &global_trace
))
1100 if (unlikely(tracing_disabled
))
1103 alloc
= sizeof(*entry
) + size
+ 2; /* possible \n added */
1105 trace_ctx
= tracing_gen_ctx();
1106 buffer
= tr
->array_buffer
.buffer
;
1107 ring_buffer_nest_start(buffer
);
1108 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, alloc
,
1115 entry
= ring_buffer_event_data(event
);
1118 memcpy(&entry
->buf
, str
, size
);
1120 /* Add a newline if necessary */
1121 if (entry
->buf
[size
- 1] != '\n') {
1122 entry
->buf
[size
] = '\n';
1123 entry
->buf
[size
+ 1] = '\0';
1125 entry
->buf
[size
] = '\0';
1127 __buffer_unlock_commit(buffer
, event
);
1128 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 4, NULL
);
1130 ring_buffer_nest_end(buffer
);
1133 EXPORT_SYMBOL_GPL(__trace_array_puts
);
1136 * __trace_puts - write a constant string into the trace buffer.
1137 * @ip: The address of the caller
1138 * @str: The constant string to write
1139 * @size: The size of the string.
1141 int __trace_puts(unsigned long ip
, const char *str
, int size
)
1143 return __trace_array_puts(printk_trace
, ip
, str
, size
);
1145 EXPORT_SYMBOL_GPL(__trace_puts
);
1148 * __trace_bputs - write the pointer to a constant string into trace buffer
1149 * @ip: The address of the caller
1150 * @str: The constant string to write to the buffer to
1152 int __trace_bputs(unsigned long ip
, const char *str
)
1154 struct trace_array
*tr
= READ_ONCE(printk_trace
);
1155 struct ring_buffer_event
*event
;
1156 struct trace_buffer
*buffer
;
1157 struct bputs_entry
*entry
;
1158 unsigned int trace_ctx
;
1159 int size
= sizeof(struct bputs_entry
);
1162 if (!printk_binsafe(tr
))
1163 return __trace_puts(ip
, str
, strlen(str
));
1165 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
1168 if (unlikely(tracing_selftest_running
|| tracing_disabled
))
1171 trace_ctx
= tracing_gen_ctx();
1172 buffer
= tr
->array_buffer
.buffer
;
1174 ring_buffer_nest_start(buffer
);
1175 event
= __trace_buffer_lock_reserve(buffer
, TRACE_BPUTS
, size
,
1180 entry
= ring_buffer_event_data(event
);
1184 __buffer_unlock_commit(buffer
, event
);
1185 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 4, NULL
);
1189 ring_buffer_nest_end(buffer
);
1192 EXPORT_SYMBOL_GPL(__trace_bputs
);
1194 #ifdef CONFIG_TRACER_SNAPSHOT
1195 static void tracing_snapshot_instance_cond(struct trace_array
*tr
,
1198 struct tracer
*tracer
= tr
->current_trace
;
1199 unsigned long flags
;
1202 trace_array_puts(tr
, "*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
1203 trace_array_puts(tr
, "*** snapshot is being ignored ***\n");
1207 if (!tr
->allocated_snapshot
) {
1208 trace_array_puts(tr
, "*** SNAPSHOT NOT ALLOCATED ***\n");
1209 trace_array_puts(tr
, "*** stopping trace here! ***\n");
1210 tracer_tracing_off(tr
);
1214 /* Note, snapshot can not be used when the tracer uses it */
1215 if (tracer
->use_max_tr
) {
1216 trace_array_puts(tr
, "*** LATENCY TRACER ACTIVE ***\n");
1217 trace_array_puts(tr
, "*** Can not use snapshot (sorry) ***\n");
1222 trace_array_puts(tr
, "*** BUFFER MEMORY MAPPED ***\n");
1223 trace_array_puts(tr
, "*** Can not use snapshot (sorry) ***\n");
1227 local_irq_save(flags
);
1228 update_max_tr(tr
, current
, smp_processor_id(), cond_data
);
1229 local_irq_restore(flags
);
1232 void tracing_snapshot_instance(struct trace_array
*tr
)
1234 tracing_snapshot_instance_cond(tr
, NULL
);
1238 * tracing_snapshot - take a snapshot of the current buffer.
1240 * This causes a swap between the snapshot buffer and the current live
1241 * tracing buffer. You can use this to take snapshots of the live
1242 * trace when some condition is triggered, but continue to trace.
1244 * Note, make sure to allocate the snapshot with either
1245 * a tracing_snapshot_alloc(), or by doing it manually
1246 * with: echo 1 > /sys/kernel/tracing/snapshot
1248 * If the snapshot buffer is not allocated, it will stop tracing.
1249 * Basically making a permanent snapshot.
1251 void tracing_snapshot(void)
1253 struct trace_array
*tr
= &global_trace
;
1255 tracing_snapshot_instance(tr
);
1257 EXPORT_SYMBOL_GPL(tracing_snapshot
);
1260 * tracing_snapshot_cond - conditionally take a snapshot of the current buffer.
1261 * @tr: The tracing instance to snapshot
1262 * @cond_data: The data to be tested conditionally, and possibly saved
1264 * This is the same as tracing_snapshot() except that the snapshot is
1265 * conditional - the snapshot will only happen if the
1266 * cond_snapshot.update() implementation receiving the cond_data
1267 * returns true, which means that the trace array's cond_snapshot
1268 * update() operation used the cond_data to determine whether the
1269 * snapshot should be taken, and if it was, presumably saved it along
1270 * with the snapshot.
1272 void tracing_snapshot_cond(struct trace_array
*tr
, void *cond_data
)
1274 tracing_snapshot_instance_cond(tr
, cond_data
);
1276 EXPORT_SYMBOL_GPL(tracing_snapshot_cond
);
1279 * tracing_cond_snapshot_data - get the user data associated with a snapshot
1280 * @tr: The tracing instance
1282 * When the user enables a conditional snapshot using
1283 * tracing_snapshot_cond_enable(), the user-defined cond_data is saved
1284 * with the snapshot. This accessor is used to retrieve it.
1286 * Should not be called from cond_snapshot.update(), since it takes
1287 * the tr->max_lock lock, which the code calling
1288 * cond_snapshot.update() has already done.
1290 * Returns the cond_data associated with the trace array's snapshot.
1292 void *tracing_cond_snapshot_data(struct trace_array
*tr
)
1294 void *cond_data
= NULL
;
1296 local_irq_disable();
1297 arch_spin_lock(&tr
->max_lock
);
1299 if (tr
->cond_snapshot
)
1300 cond_data
= tr
->cond_snapshot
->cond_data
;
1302 arch_spin_unlock(&tr
->max_lock
);
1307 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data
);
1309 static int resize_buffer_duplicate_size(struct array_buffer
*trace_buf
,
1310 struct array_buffer
*size_buf
, int cpu_id
);
1311 static void set_buffer_entries(struct array_buffer
*buf
, unsigned long val
);
1313 int tracing_alloc_snapshot_instance(struct trace_array
*tr
)
1318 if (!tr
->allocated_snapshot
) {
1320 /* Make the snapshot buffer have the same order as main buffer */
1321 order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
1322 ret
= ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, order
);
1326 /* allocate spare buffer */
1327 ret
= resize_buffer_duplicate_size(&tr
->max_buffer
,
1328 &tr
->array_buffer
, RING_BUFFER_ALL_CPUS
);
1332 tr
->allocated_snapshot
= true;
1338 static void free_snapshot(struct trace_array
*tr
)
1341 * We don't free the ring buffer. instead, resize it because
1342 * The max_tr ring buffer has some state (e.g. ring->clock) and
1343 * we want preserve it.
1345 ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, 0);
1346 ring_buffer_resize(tr
->max_buffer
.buffer
, 1, RING_BUFFER_ALL_CPUS
);
1347 set_buffer_entries(&tr
->max_buffer
, 1);
1348 tracing_reset_online_cpus(&tr
->max_buffer
);
1349 tr
->allocated_snapshot
= false;
1352 static int tracing_arm_snapshot_locked(struct trace_array
*tr
)
1356 lockdep_assert_held(&trace_types_lock
);
1358 spin_lock(&tr
->snapshot_trigger_lock
);
1359 if (tr
->snapshot
== UINT_MAX
|| tr
->mapped
) {
1360 spin_unlock(&tr
->snapshot_trigger_lock
);
1365 spin_unlock(&tr
->snapshot_trigger_lock
);
1367 ret
= tracing_alloc_snapshot_instance(tr
);
1369 spin_lock(&tr
->snapshot_trigger_lock
);
1371 spin_unlock(&tr
->snapshot_trigger_lock
);
1377 int tracing_arm_snapshot(struct trace_array
*tr
)
1381 mutex_lock(&trace_types_lock
);
1382 ret
= tracing_arm_snapshot_locked(tr
);
1383 mutex_unlock(&trace_types_lock
);
1388 void tracing_disarm_snapshot(struct trace_array
*tr
)
1390 spin_lock(&tr
->snapshot_trigger_lock
);
1391 if (!WARN_ON(!tr
->snapshot
))
1393 spin_unlock(&tr
->snapshot_trigger_lock
);
1397 * tracing_alloc_snapshot - allocate snapshot buffer.
1399 * This only allocates the snapshot buffer if it isn't already
1400 * allocated - it doesn't also take a snapshot.
1402 * This is meant to be used in cases where the snapshot buffer needs
1403 * to be set up for events that can't sleep but need to be able to
1404 * trigger a snapshot.
1406 int tracing_alloc_snapshot(void)
1408 struct trace_array
*tr
= &global_trace
;
1411 ret
= tracing_alloc_snapshot_instance(tr
);
1416 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot
);
1419 * tracing_snapshot_alloc - allocate and take a snapshot of the current buffer.
1421 * This is similar to tracing_snapshot(), but it will allocate the
1422 * snapshot buffer if it isn't already allocated. Use this only
1423 * where it is safe to sleep, as the allocation may sleep.
1425 * This causes a swap between the snapshot buffer and the current live
1426 * tracing buffer. You can use this to take snapshots of the live
1427 * trace when some condition is triggered, but continue to trace.
1429 void tracing_snapshot_alloc(void)
1433 ret
= tracing_alloc_snapshot();
1439 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc
);
1442 * tracing_snapshot_cond_enable - enable conditional snapshot for an instance
1443 * @tr: The tracing instance
1444 * @cond_data: User data to associate with the snapshot
1445 * @update: Implementation of the cond_snapshot update function
1447 * Check whether the conditional snapshot for the given instance has
1448 * already been enabled, or if the current tracer is already using a
1449 * snapshot; if so, return -EBUSY, else create a cond_snapshot and
1450 * save the cond_data and update function inside.
1452 * Returns 0 if successful, error otherwise.
1454 int tracing_snapshot_cond_enable(struct trace_array
*tr
, void *cond_data
,
1455 cond_update_fn_t update
)
1457 struct cond_snapshot
*cond_snapshot
;
1460 cond_snapshot
= kzalloc(sizeof(*cond_snapshot
), GFP_KERNEL
);
1464 cond_snapshot
->cond_data
= cond_data
;
1465 cond_snapshot
->update
= update
;
1467 mutex_lock(&trace_types_lock
);
1469 if (tr
->current_trace
->use_max_tr
) {
1475 * The cond_snapshot can only change to NULL without the
1476 * trace_types_lock. We don't care if we race with it going
1477 * to NULL, but we want to make sure that it's not set to
1478 * something other than NULL when we get here, which we can
1479 * do safely with only holding the trace_types_lock and not
1480 * having to take the max_lock.
1482 if (tr
->cond_snapshot
) {
1487 ret
= tracing_arm_snapshot_locked(tr
);
1491 local_irq_disable();
1492 arch_spin_lock(&tr
->max_lock
);
1493 tr
->cond_snapshot
= cond_snapshot
;
1494 arch_spin_unlock(&tr
->max_lock
);
1497 mutex_unlock(&trace_types_lock
);
1502 mutex_unlock(&trace_types_lock
);
1503 kfree(cond_snapshot
);
1506 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable
);
1509 * tracing_snapshot_cond_disable - disable conditional snapshot for an instance
1510 * @tr: The tracing instance
1512 * Check whether the conditional snapshot for the given instance is
1513 * enabled; if so, free the cond_snapshot associated with it,
1514 * otherwise return -EINVAL.
1516 * Returns 0 if successful, error otherwise.
1518 int tracing_snapshot_cond_disable(struct trace_array
*tr
)
1522 local_irq_disable();
1523 arch_spin_lock(&tr
->max_lock
);
1525 if (!tr
->cond_snapshot
)
1528 kfree(tr
->cond_snapshot
);
1529 tr
->cond_snapshot
= NULL
;
1532 arch_spin_unlock(&tr
->max_lock
);
1535 tracing_disarm_snapshot(tr
);
1539 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable
);
1541 void tracing_snapshot(void)
1543 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1545 EXPORT_SYMBOL_GPL(tracing_snapshot
);
1546 void tracing_snapshot_cond(struct trace_array
*tr
, void *cond_data
)
1548 WARN_ONCE(1, "Snapshot feature not enabled, but internal conditional snapshot used");
1550 EXPORT_SYMBOL_GPL(tracing_snapshot_cond
);
1551 int tracing_alloc_snapshot(void)
1553 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1556 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot
);
1557 void tracing_snapshot_alloc(void)
1562 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc
);
1563 void *tracing_cond_snapshot_data(struct trace_array
*tr
)
1567 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data
);
1568 int tracing_snapshot_cond_enable(struct trace_array
*tr
, void *cond_data
, cond_update_fn_t update
)
1572 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable
);
1573 int tracing_snapshot_cond_disable(struct trace_array
*tr
)
1577 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable
);
1578 #define free_snapshot(tr) do { } while (0)
1579 #define tracing_arm_snapshot_locked(tr) ({ -EBUSY; })
1580 #endif /* CONFIG_TRACER_SNAPSHOT */
1582 void tracer_tracing_off(struct trace_array
*tr
)
1584 if (tr
->array_buffer
.buffer
)
1585 ring_buffer_record_off(tr
->array_buffer
.buffer
);
1587 * This flag is looked at when buffers haven't been allocated
1588 * yet, or by some tracers (like irqsoff), that just want to
1589 * know if the ring buffer has been disabled, but it can handle
1590 * races of where it gets disabled but we still do a record.
1591 * As the check is in the fast path of the tracers, it is more
1592 * important to be fast than accurate.
1594 tr
->buffer_disabled
= 1;
1595 /* Make the flag seen by readers */
1600 * tracing_off - turn off tracing buffers
1602 * This function stops the tracing buffers from recording data.
1603 * It does not disable any overhead the tracers themselves may
1604 * be causing. This function simply causes all recording to
1605 * the ring buffers to fail.
1607 void tracing_off(void)
1609 tracer_tracing_off(&global_trace
);
1611 EXPORT_SYMBOL_GPL(tracing_off
);
1613 void disable_trace_on_warning(void)
1615 if (__disable_trace_on_warning
) {
1616 trace_array_printk_buf(global_trace
.array_buffer
.buffer
, _THIS_IP_
,
1617 "Disabling tracing due to warning\n");
1623 * tracer_tracing_is_on - show real state of ring buffer enabled
1624 * @tr : the trace array to know if ring buffer is enabled
1626 * Shows real state of the ring buffer if it is enabled or not.
1628 bool tracer_tracing_is_on(struct trace_array
*tr
)
1630 if (tr
->array_buffer
.buffer
)
1631 return ring_buffer_record_is_set_on(tr
->array_buffer
.buffer
);
1632 return !tr
->buffer_disabled
;
1636 * tracing_is_on - show state of ring buffers enabled
1638 int tracing_is_on(void)
1640 return tracer_tracing_is_on(&global_trace
);
1642 EXPORT_SYMBOL_GPL(tracing_is_on
);
1644 static int __init
set_buf_size(char *str
)
1646 unsigned long buf_size
;
1650 buf_size
= memparse(str
, &str
);
1652 * nr_entries can not be zero and the startup
1653 * tests require some buffer space. Therefore
1654 * ensure we have at least 4096 bytes of buffer.
1656 trace_buf_size
= max(4096UL, buf_size
);
1659 __setup("trace_buf_size=", set_buf_size
);
1661 static int __init
set_tracing_thresh(char *str
)
1663 unsigned long threshold
;
1668 ret
= kstrtoul(str
, 0, &threshold
);
1671 tracing_thresh
= threshold
* 1000;
1674 __setup("tracing_thresh=", set_tracing_thresh
);
1676 unsigned long nsecs_to_usecs(unsigned long nsecs
)
1678 return nsecs
/ 1000;
1682 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1683 * It uses C(a, b) where 'a' is the eval (enum) name and 'b' is the string that
1684 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1685 * of strings in the order that the evals (enum) were defined.
1690 /* These must match the bit positions in trace_iterator_flags */
1691 static const char *trace_options
[] = {
1699 int in_ns
; /* is this clock in nanoseconds? */
1700 } trace_clocks
[] = {
1701 { trace_clock_local
, "local", 1 },
1702 { trace_clock_global
, "global", 1 },
1703 { trace_clock_counter
, "counter", 0 },
1704 { trace_clock_jiffies
, "uptime", 0 },
1705 { trace_clock
, "perf", 1 },
1706 { ktime_get_mono_fast_ns
, "mono", 1 },
1707 { ktime_get_raw_fast_ns
, "mono_raw", 1 },
1708 { ktime_get_boot_fast_ns
, "boot", 1 },
1709 { ktime_get_tai_fast_ns
, "tai", 1 },
1713 bool trace_clock_in_ns(struct trace_array
*tr
)
1715 if (trace_clocks
[tr
->clock_id
].in_ns
)
1722 * trace_parser_get_init - gets the buffer for trace parser
1724 int trace_parser_get_init(struct trace_parser
*parser
, int size
)
1726 memset(parser
, 0, sizeof(*parser
));
1728 parser
->buffer
= kmalloc(size
, GFP_KERNEL
);
1729 if (!parser
->buffer
)
1732 parser
->size
= size
;
1737 * trace_parser_put - frees the buffer for trace parser
1739 void trace_parser_put(struct trace_parser
*parser
)
1741 kfree(parser
->buffer
);
1742 parser
->buffer
= NULL
;
1746 * trace_get_user - reads the user input string separated by space
1747 * (matched by isspace(ch))
1749 * For each string found the 'struct trace_parser' is updated,
1750 * and the function returns.
1752 * Returns number of bytes read.
1754 * See kernel/trace/trace.h for 'struct trace_parser' details.
1756 int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
1757 size_t cnt
, loff_t
*ppos
)
1764 trace_parser_clear(parser
);
1766 ret
= get_user(ch
, ubuf
++);
1774 * The parser is not finished with the last write,
1775 * continue reading the user input without skipping spaces.
1777 if (!parser
->cont
) {
1778 /* skip white space */
1779 while (cnt
&& isspace(ch
)) {
1780 ret
= get_user(ch
, ubuf
++);
1789 /* only spaces were written */
1790 if (isspace(ch
) || !ch
) {
1797 /* read the non-space input */
1798 while (cnt
&& !isspace(ch
) && ch
) {
1799 if (parser
->idx
< parser
->size
- 1)
1800 parser
->buffer
[parser
->idx
++] = ch
;
1805 ret
= get_user(ch
, ubuf
++);
1812 /* We either got finished input or we have to wait for another call. */
1813 if (isspace(ch
) || !ch
) {
1814 parser
->buffer
[parser
->idx
] = 0;
1815 parser
->cont
= false;
1816 } else if (parser
->idx
< parser
->size
- 1) {
1817 parser
->cont
= true;
1818 parser
->buffer
[parser
->idx
++] = ch
;
1819 /* Make sure the parsed string always terminates with '\0'. */
1820 parser
->buffer
[parser
->idx
] = 0;
1833 /* TODO add a seq_buf_to_buffer() */
1834 static ssize_t
trace_seq_to_buffer(struct trace_seq
*s
, void *buf
, size_t cnt
)
1838 if (trace_seq_used(s
) <= s
->readpos
)
1841 len
= trace_seq_used(s
) - s
->readpos
;
1844 memcpy(buf
, s
->buffer
+ s
->readpos
, cnt
);
1850 unsigned long __read_mostly tracing_thresh
;
1852 #ifdef CONFIG_TRACER_MAX_TRACE
1853 static const struct file_operations tracing_max_lat_fops
;
1855 #ifdef LATENCY_FS_NOTIFY
1857 static struct workqueue_struct
*fsnotify_wq
;
1859 static void latency_fsnotify_workfn(struct work_struct
*work
)
1861 struct trace_array
*tr
= container_of(work
, struct trace_array
,
1863 fsnotify_inode(tr
->d_max_latency
->d_inode
, FS_MODIFY
);
1866 static void latency_fsnotify_workfn_irq(struct irq_work
*iwork
)
1868 struct trace_array
*tr
= container_of(iwork
, struct trace_array
,
1870 queue_work(fsnotify_wq
, &tr
->fsnotify_work
);
1873 static void trace_create_maxlat_file(struct trace_array
*tr
,
1874 struct dentry
*d_tracer
)
1876 INIT_WORK(&tr
->fsnotify_work
, latency_fsnotify_workfn
);
1877 init_irq_work(&tr
->fsnotify_irqwork
, latency_fsnotify_workfn_irq
);
1878 tr
->d_max_latency
= trace_create_file("tracing_max_latency",
1881 &tracing_max_lat_fops
);
1884 __init
static int latency_fsnotify_init(void)
1886 fsnotify_wq
= alloc_workqueue("tr_max_lat_wq",
1887 WQ_UNBOUND
| WQ_HIGHPRI
, 0);
1889 pr_err("Unable to allocate tr_max_lat_wq\n");
1895 late_initcall_sync(latency_fsnotify_init
);
1897 void latency_fsnotify(struct trace_array
*tr
)
1902 * We cannot call queue_work(&tr->fsnotify_work) from here because it's
1903 * possible that we are called from __schedule() or do_idle(), which
1904 * could cause a deadlock.
1906 irq_work_queue(&tr
->fsnotify_irqwork
);
1909 #else /* !LATENCY_FS_NOTIFY */
1911 #define trace_create_maxlat_file(tr, d_tracer) \
1912 trace_create_file("tracing_max_latency", TRACE_MODE_WRITE, \
1913 d_tracer, tr, &tracing_max_lat_fops)
1918 * Copy the new maximum trace into the separate maximum-trace
1919 * structure. (this way the maximum trace is permanently saved,
1920 * for later retrieval via /sys/kernel/tracing/tracing_max_latency)
1923 __update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
)
1925 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
1926 struct array_buffer
*max_buf
= &tr
->max_buffer
;
1927 struct trace_array_cpu
*data
= per_cpu_ptr(trace_buf
->data
, cpu
);
1928 struct trace_array_cpu
*max_data
= per_cpu_ptr(max_buf
->data
, cpu
);
1931 max_buf
->time_start
= data
->preempt_timestamp
;
1933 max_data
->saved_latency
= tr
->max_latency
;
1934 max_data
->critical_start
= data
->critical_start
;
1935 max_data
->critical_end
= data
->critical_end
;
1937 strncpy(max_data
->comm
, tsk
->comm
, TASK_COMM_LEN
);
1938 max_data
->pid
= tsk
->pid
;
1940 * If tsk == current, then use current_uid(), as that does not use
1941 * RCU. The irq tracer can be called out of RCU scope.
1944 max_data
->uid
= current_uid();
1946 max_data
->uid
= task_uid(tsk
);
1948 max_data
->nice
= tsk
->static_prio
- 20 - MAX_RT_PRIO
;
1949 max_data
->policy
= tsk
->policy
;
1950 max_data
->rt_priority
= tsk
->rt_priority
;
1952 /* record this tasks comm */
1953 tracing_record_cmdline(tsk
);
1954 latency_fsnotify(tr
);
1958 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1960 * @tsk: the task with the latency
1961 * @cpu: The cpu that initiated the trace.
1962 * @cond_data: User data associated with a conditional snapshot
1964 * Flip the buffers between the @tr and the max_tr and record information
1965 * about which task was the cause of this latency.
1968 update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
,
1974 WARN_ON_ONCE(!irqs_disabled());
1976 if (!tr
->allocated_snapshot
) {
1977 /* Only the nop tracer should hit this when disabling */
1978 WARN_ON_ONCE(tr
->current_trace
!= &nop_trace
);
1982 arch_spin_lock(&tr
->max_lock
);
1984 /* Inherit the recordable setting from array_buffer */
1985 if (ring_buffer_record_is_set_on(tr
->array_buffer
.buffer
))
1986 ring_buffer_record_on(tr
->max_buffer
.buffer
);
1988 ring_buffer_record_off(tr
->max_buffer
.buffer
);
1990 #ifdef CONFIG_TRACER_SNAPSHOT
1991 if (tr
->cond_snapshot
&& !tr
->cond_snapshot
->update(tr
, cond_data
)) {
1992 arch_spin_unlock(&tr
->max_lock
);
1996 swap(tr
->array_buffer
.buffer
, tr
->max_buffer
.buffer
);
1998 __update_max_tr(tr
, tsk
, cpu
);
2000 arch_spin_unlock(&tr
->max_lock
);
2002 /* Any waiters on the old snapshot buffer need to wake up */
2003 ring_buffer_wake_waiters(tr
->array_buffer
.buffer
, RING_BUFFER_ALL_CPUS
);
2007 * update_max_tr_single - only copy one trace over, and reset the rest
2009 * @tsk: task with the latency
2010 * @cpu: the cpu of the buffer to copy.
2012 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
2015 update_max_tr_single(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
)
2022 WARN_ON_ONCE(!irqs_disabled());
2023 if (!tr
->allocated_snapshot
) {
2024 /* Only the nop tracer should hit this when disabling */
2025 WARN_ON_ONCE(tr
->current_trace
!= &nop_trace
);
2029 arch_spin_lock(&tr
->max_lock
);
2031 ret
= ring_buffer_swap_cpu(tr
->max_buffer
.buffer
, tr
->array_buffer
.buffer
, cpu
);
2033 if (ret
== -EBUSY
) {
2035 * We failed to swap the buffer due to a commit taking
2036 * place on this CPU. We fail to record, but we reset
2037 * the max trace buffer (no one writes directly to it)
2038 * and flag that it failed.
2039 * Another reason is resize is in progress.
2041 trace_array_printk_buf(tr
->max_buffer
.buffer
, _THIS_IP_
,
2042 "Failed to swap buffers due to commit or resize in progress\n");
2045 WARN_ON_ONCE(ret
&& ret
!= -EAGAIN
&& ret
!= -EBUSY
);
2047 __update_max_tr(tr
, tsk
, cpu
);
2048 arch_spin_unlock(&tr
->max_lock
);
2051 #endif /* CONFIG_TRACER_MAX_TRACE */
2054 struct trace_iterator
*iter
;
2058 static bool wait_pipe_cond(void *data
)
2060 struct pipe_wait
*pwait
= data
;
2061 struct trace_iterator
*iter
= pwait
->iter
;
2063 if (atomic_read_acquire(&iter
->wait_index
) != pwait
->wait_index
)
2066 return iter
->closed
;
2069 static int wait_on_pipe(struct trace_iterator
*iter
, int full
)
2071 struct pipe_wait pwait
;
2074 /* Iterators are static, they should be filled or empty */
2075 if (trace_buffer_iter(iter
, iter
->cpu_file
))
2078 pwait
.wait_index
= atomic_read_acquire(&iter
->wait_index
);
2081 ret
= ring_buffer_wait(iter
->array_buffer
->buffer
, iter
->cpu_file
, full
,
2082 wait_pipe_cond
, &pwait
);
2084 #ifdef CONFIG_TRACER_MAX_TRACE
2086 * Make sure this is still the snapshot buffer, as if a snapshot were
2087 * to happen, this would now be the main buffer.
2090 iter
->array_buffer
= &iter
->tr
->max_buffer
;
2095 #ifdef CONFIG_FTRACE_STARTUP_TEST
2096 static bool selftests_can_run
;
2098 struct trace_selftests
{
2099 struct list_head list
;
2100 struct tracer
*type
;
2103 static LIST_HEAD(postponed_selftests
);
2105 static int save_selftest(struct tracer
*type
)
2107 struct trace_selftests
*selftest
;
2109 selftest
= kmalloc(sizeof(*selftest
), GFP_KERNEL
);
2113 selftest
->type
= type
;
2114 list_add(&selftest
->list
, &postponed_selftests
);
2118 static int run_tracer_selftest(struct tracer
*type
)
2120 struct trace_array
*tr
= &global_trace
;
2121 struct tracer
*saved_tracer
= tr
->current_trace
;
2124 if (!type
->selftest
|| tracing_selftest_disabled
)
2128 * If a tracer registers early in boot up (before scheduling is
2129 * initialized and such), then do not run its selftests yet.
2130 * Instead, run it a little later in the boot process.
2132 if (!selftests_can_run
)
2133 return save_selftest(type
);
2135 if (!tracing_is_on()) {
2136 pr_warn("Selftest for tracer %s skipped due to tracing disabled\n",
2142 * Run a selftest on this tracer.
2143 * Here we reset the trace buffer, and set the current
2144 * tracer to be this tracer. The tracer can then run some
2145 * internal tracing to verify that everything is in order.
2146 * If we fail, we do not register this tracer.
2148 tracing_reset_online_cpus(&tr
->array_buffer
);
2150 tr
->current_trace
= type
;
2152 #ifdef CONFIG_TRACER_MAX_TRACE
2153 if (type
->use_max_tr
) {
2154 /* If we expanded the buffers, make sure the max is expanded too */
2155 if (tr
->ring_buffer_expanded
)
2156 ring_buffer_resize(tr
->max_buffer
.buffer
, trace_buf_size
,
2157 RING_BUFFER_ALL_CPUS
);
2158 tr
->allocated_snapshot
= true;
2162 /* the test is responsible for initializing and enabling */
2163 pr_info("Testing tracer %s: ", type
->name
);
2164 ret
= type
->selftest(type
, tr
);
2165 /* the test is responsible for resetting too */
2166 tr
->current_trace
= saved_tracer
;
2168 printk(KERN_CONT
"FAILED!\n");
2169 /* Add the warning after printing 'FAILED' */
2173 /* Only reset on passing, to avoid touching corrupted buffers */
2174 tracing_reset_online_cpus(&tr
->array_buffer
);
2176 #ifdef CONFIG_TRACER_MAX_TRACE
2177 if (type
->use_max_tr
) {
2178 tr
->allocated_snapshot
= false;
2180 /* Shrink the max buffer again */
2181 if (tr
->ring_buffer_expanded
)
2182 ring_buffer_resize(tr
->max_buffer
.buffer
, 1,
2183 RING_BUFFER_ALL_CPUS
);
2187 printk(KERN_CONT
"PASSED\n");
2191 static int do_run_tracer_selftest(struct tracer
*type
)
2196 * Tests can take a long time, especially if they are run one after the
2197 * other, as does happen during bootup when all the tracers are
2198 * registered. This could cause the soft lockup watchdog to trigger.
2202 tracing_selftest_running
= true;
2203 ret
= run_tracer_selftest(type
);
2204 tracing_selftest_running
= false;
2209 static __init
int init_trace_selftests(void)
2211 struct trace_selftests
*p
, *n
;
2212 struct tracer
*t
, **last
;
2215 selftests_can_run
= true;
2217 mutex_lock(&trace_types_lock
);
2219 if (list_empty(&postponed_selftests
))
2222 pr_info("Running postponed tracer tests:\n");
2224 tracing_selftest_running
= true;
2225 list_for_each_entry_safe(p
, n
, &postponed_selftests
, list
) {
2226 /* This loop can take minutes when sanitizers are enabled, so
2227 * lets make sure we allow RCU processing.
2230 ret
= run_tracer_selftest(p
->type
);
2231 /* If the test fails, then warn and remove from available_tracers */
2233 WARN(1, "tracer: %s failed selftest, disabling\n",
2235 last
= &trace_types
;
2236 for (t
= trace_types
; t
; t
= t
->next
) {
2247 tracing_selftest_running
= false;
2250 mutex_unlock(&trace_types_lock
);
2254 core_initcall(init_trace_selftests
);
2256 static inline int do_run_tracer_selftest(struct tracer
*type
)
2260 #endif /* CONFIG_FTRACE_STARTUP_TEST */
2262 static void add_tracer_options(struct trace_array
*tr
, struct tracer
*t
);
2264 static void __init
apply_trace_boot_options(void);
2267 * register_tracer - register a tracer with the ftrace system.
2268 * @type: the plugin for the tracer
2270 * Register a new plugin tracer.
2272 int __init
register_tracer(struct tracer
*type
)
2278 pr_info("Tracer must have a name\n");
2282 if (strlen(type
->name
) >= MAX_TRACER_SIZE
) {
2283 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE
);
2287 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
2288 pr_warn("Can not register tracer %s due to lockdown\n",
2293 mutex_lock(&trace_types_lock
);
2295 for (t
= trace_types
; t
; t
= t
->next
) {
2296 if (strcmp(type
->name
, t
->name
) == 0) {
2298 pr_info("Tracer %s already registered\n",
2305 if (!type
->set_flag
)
2306 type
->set_flag
= &dummy_set_flag
;
2308 /*allocate a dummy tracer_flags*/
2309 type
->flags
= kmalloc(sizeof(*type
->flags
), GFP_KERNEL
);
2314 type
->flags
->val
= 0;
2315 type
->flags
->opts
= dummy_tracer_opt
;
2317 if (!type
->flags
->opts
)
2318 type
->flags
->opts
= dummy_tracer_opt
;
2320 /* store the tracer for __set_tracer_option */
2321 type
->flags
->trace
= type
;
2323 ret
= do_run_tracer_selftest(type
);
2327 type
->next
= trace_types
;
2329 add_tracer_options(&global_trace
, type
);
2332 mutex_unlock(&trace_types_lock
);
2334 if (ret
|| !default_bootup_tracer
)
2337 if (strncmp(default_bootup_tracer
, type
->name
, MAX_TRACER_SIZE
))
2340 printk(KERN_INFO
"Starting tracer '%s'\n", type
->name
);
2341 /* Do we want this tracer to start on bootup? */
2342 tracing_set_tracer(&global_trace
, type
->name
);
2343 default_bootup_tracer
= NULL
;
2345 apply_trace_boot_options();
2347 /* disable other selftests, since this will break it. */
2348 disable_tracing_selftest("running a tracer");
2354 static void tracing_reset_cpu(struct array_buffer
*buf
, int cpu
)
2356 struct trace_buffer
*buffer
= buf
->buffer
;
2361 ring_buffer_record_disable(buffer
);
2363 /* Make sure all commits have finished */
2365 ring_buffer_reset_cpu(buffer
, cpu
);
2367 ring_buffer_record_enable(buffer
);
2370 void tracing_reset_online_cpus(struct array_buffer
*buf
)
2372 struct trace_buffer
*buffer
= buf
->buffer
;
2377 ring_buffer_record_disable(buffer
);
2379 /* Make sure all commits have finished */
2382 buf
->time_start
= buffer_ftrace_now(buf
, buf
->cpu
);
2384 ring_buffer_reset_online_cpus(buffer
);
2386 ring_buffer_record_enable(buffer
);
2389 /* Must have trace_types_lock held */
2390 void tracing_reset_all_online_cpus_unlocked(void)
2392 struct trace_array
*tr
;
2394 lockdep_assert_held(&trace_types_lock
);
2396 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
2397 if (!tr
->clear_trace
)
2399 tr
->clear_trace
= false;
2400 tracing_reset_online_cpus(&tr
->array_buffer
);
2401 #ifdef CONFIG_TRACER_MAX_TRACE
2402 tracing_reset_online_cpus(&tr
->max_buffer
);
2407 void tracing_reset_all_online_cpus(void)
2409 mutex_lock(&trace_types_lock
);
2410 tracing_reset_all_online_cpus_unlocked();
2411 mutex_unlock(&trace_types_lock
);
2414 int is_tracing_stopped(void)
2416 return global_trace
.stop_count
;
2419 static void tracing_start_tr(struct trace_array
*tr
)
2421 struct trace_buffer
*buffer
;
2422 unsigned long flags
;
2424 if (tracing_disabled
)
2427 raw_spin_lock_irqsave(&tr
->start_lock
, flags
);
2428 if (--tr
->stop_count
) {
2429 if (WARN_ON_ONCE(tr
->stop_count
< 0)) {
2430 /* Someone screwed up their debugging */
2436 /* Prevent the buffers from switching */
2437 arch_spin_lock(&tr
->max_lock
);
2439 buffer
= tr
->array_buffer
.buffer
;
2441 ring_buffer_record_enable(buffer
);
2443 #ifdef CONFIG_TRACER_MAX_TRACE
2444 buffer
= tr
->max_buffer
.buffer
;
2446 ring_buffer_record_enable(buffer
);
2449 arch_spin_unlock(&tr
->max_lock
);
2452 raw_spin_unlock_irqrestore(&tr
->start_lock
, flags
);
2456 * tracing_start - quick start of the tracer
2458 * If tracing is enabled but was stopped by tracing_stop,
2459 * this will start the tracer back up.
2461 void tracing_start(void)
2464 return tracing_start_tr(&global_trace
);
2467 static void tracing_stop_tr(struct trace_array
*tr
)
2469 struct trace_buffer
*buffer
;
2470 unsigned long flags
;
2472 raw_spin_lock_irqsave(&tr
->start_lock
, flags
);
2473 if (tr
->stop_count
++)
2476 /* Prevent the buffers from switching */
2477 arch_spin_lock(&tr
->max_lock
);
2479 buffer
= tr
->array_buffer
.buffer
;
2481 ring_buffer_record_disable(buffer
);
2483 #ifdef CONFIG_TRACER_MAX_TRACE
2484 buffer
= tr
->max_buffer
.buffer
;
2486 ring_buffer_record_disable(buffer
);
2489 arch_spin_unlock(&tr
->max_lock
);
2492 raw_spin_unlock_irqrestore(&tr
->start_lock
, flags
);
2496 * tracing_stop - quick stop of the tracer
2498 * Light weight way to stop tracing. Use in conjunction with
2501 void tracing_stop(void)
2503 return tracing_stop_tr(&global_trace
);
2507 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2508 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2509 * simplifies those functions and keeps them in sync.
2511 enum print_line_t
trace_handle_return(struct trace_seq
*s
)
2513 return trace_seq_has_overflowed(s
) ?
2514 TRACE_TYPE_PARTIAL_LINE
: TRACE_TYPE_HANDLED
;
2516 EXPORT_SYMBOL_GPL(trace_handle_return
);
2518 static unsigned short migration_disable_value(void)
2520 #if defined(CONFIG_SMP)
2521 return current
->migration_disabled
;
2527 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status
)
2529 unsigned int trace_flags
= irqs_status
;
2532 pc
= preempt_count();
2535 trace_flags
|= TRACE_FLAG_NMI
;
2536 if (pc
& HARDIRQ_MASK
)
2537 trace_flags
|= TRACE_FLAG_HARDIRQ
;
2538 if (in_serving_softirq())
2539 trace_flags
|= TRACE_FLAG_SOFTIRQ
;
2540 if (softirq_count() >> (SOFTIRQ_SHIFT
+ 1))
2541 trace_flags
|= TRACE_FLAG_BH_OFF
;
2543 if (tif_need_resched())
2544 trace_flags
|= TRACE_FLAG_NEED_RESCHED
;
2545 if (test_preempt_need_resched())
2546 trace_flags
|= TRACE_FLAG_PREEMPT_RESCHED
;
2547 return (trace_flags
<< 16) | (min_t(unsigned int, pc
& 0xff, 0xf)) |
2548 (min_t(unsigned int, migration_disable_value(), 0xf)) << 4;
2551 struct ring_buffer_event
*
2552 trace_buffer_lock_reserve(struct trace_buffer
*buffer
,
2555 unsigned int trace_ctx
)
2557 return __trace_buffer_lock_reserve(buffer
, type
, len
, trace_ctx
);
2560 DEFINE_PER_CPU(struct ring_buffer_event
*, trace_buffered_event
);
2561 DEFINE_PER_CPU(int, trace_buffered_event_cnt
);
2562 static int trace_buffered_event_ref
;
2565 * trace_buffered_event_enable - enable buffering events
2567 * When events are being filtered, it is quicker to use a temporary
2568 * buffer to write the event data into if there's a likely chance
2569 * that it will not be committed. The discard of the ring buffer
2570 * is not as fast as committing, and is much slower than copying
2573 * When an event is to be filtered, allocate per cpu buffers to
2574 * write the event data into, and if the event is filtered and discarded
2575 * it is simply dropped, otherwise, the entire data is to be committed
2578 void trace_buffered_event_enable(void)
2580 struct ring_buffer_event
*event
;
2584 WARN_ON_ONCE(!mutex_is_locked(&event_mutex
));
2586 if (trace_buffered_event_ref
++)
2589 for_each_tracing_cpu(cpu
) {
2590 page
= alloc_pages_node(cpu_to_node(cpu
),
2591 GFP_KERNEL
| __GFP_NORETRY
, 0);
2592 /* This is just an optimization and can handle failures */
2594 pr_err("Failed to allocate event buffer\n");
2598 event
= page_address(page
);
2599 memset(event
, 0, sizeof(*event
));
2601 per_cpu(trace_buffered_event
, cpu
) = event
;
2604 if (cpu
== smp_processor_id() &&
2605 __this_cpu_read(trace_buffered_event
) !=
2606 per_cpu(trace_buffered_event
, cpu
))
2612 static void enable_trace_buffered_event(void *data
)
2614 /* Probably not needed, but do it anyway */
2616 this_cpu_dec(trace_buffered_event_cnt
);
2619 static void disable_trace_buffered_event(void *data
)
2621 this_cpu_inc(trace_buffered_event_cnt
);
2625 * trace_buffered_event_disable - disable buffering events
2627 * When a filter is removed, it is faster to not use the buffered
2628 * events, and to commit directly into the ring buffer. Free up
2629 * the temp buffers when there are no more users. This requires
2630 * special synchronization with current events.
2632 void trace_buffered_event_disable(void)
2636 WARN_ON_ONCE(!mutex_is_locked(&event_mutex
));
2638 if (WARN_ON_ONCE(!trace_buffered_event_ref
))
2641 if (--trace_buffered_event_ref
)
2644 /* For each CPU, set the buffer as used. */
2645 on_each_cpu_mask(tracing_buffer_mask
, disable_trace_buffered_event
,
2648 /* Wait for all current users to finish */
2651 for_each_tracing_cpu(cpu
) {
2652 free_page((unsigned long)per_cpu(trace_buffered_event
, cpu
));
2653 per_cpu(trace_buffered_event
, cpu
) = NULL
;
2657 * Wait for all CPUs that potentially started checking if they can use
2658 * their event buffer only after the previous synchronize_rcu() call and
2659 * they still read a valid pointer from trace_buffered_event. It must be
2660 * ensured they don't see cleared trace_buffered_event_cnt else they
2661 * could wrongly decide to use the pointed-to buffer which is now freed.
2665 /* For each CPU, relinquish the buffer */
2666 on_each_cpu_mask(tracing_buffer_mask
, enable_trace_buffered_event
, NULL
,
2670 static struct trace_buffer
*temp_buffer
;
2672 struct ring_buffer_event
*
2673 trace_event_buffer_lock_reserve(struct trace_buffer
**current_rb
,
2674 struct trace_event_file
*trace_file
,
2675 int type
, unsigned long len
,
2676 unsigned int trace_ctx
)
2678 struct ring_buffer_event
*entry
;
2679 struct trace_array
*tr
= trace_file
->tr
;
2682 *current_rb
= tr
->array_buffer
.buffer
;
2684 if (!tr
->no_filter_buffering_ref
&&
2685 (trace_file
->flags
& (EVENT_FILE_FL_SOFT_DISABLED
| EVENT_FILE_FL_FILTERED
))) {
2686 preempt_disable_notrace();
2688 * Filtering is on, so try to use the per cpu buffer first.
2689 * This buffer will simulate a ring_buffer_event,
2690 * where the type_len is zero and the array[0] will
2691 * hold the full length.
2692 * (see include/linux/ring-buffer.h for details on
2693 * how the ring_buffer_event is structured).
2695 * Using a temp buffer during filtering and copying it
2696 * on a matched filter is quicker than writing directly
2697 * into the ring buffer and then discarding it when
2698 * it doesn't match. That is because the discard
2699 * requires several atomic operations to get right.
2700 * Copying on match and doing nothing on a failed match
2701 * is still quicker than no copy on match, but having
2702 * to discard out of the ring buffer on a failed match.
2704 if ((entry
= __this_cpu_read(trace_buffered_event
))) {
2705 int max_len
= PAGE_SIZE
- struct_size(entry
, array
, 1);
2707 val
= this_cpu_inc_return(trace_buffered_event_cnt
);
2710 * Preemption is disabled, but interrupts and NMIs
2711 * can still come in now. If that happens after
2712 * the above increment, then it will have to go
2713 * back to the old method of allocating the event
2714 * on the ring buffer, and if the filter fails, it
2715 * will have to call ring_buffer_discard_commit()
2718 * Need to also check the unlikely case that the
2719 * length is bigger than the temp buffer size.
2720 * If that happens, then the reserve is pretty much
2721 * guaranteed to fail, as the ring buffer currently
2722 * only allows events less than a page. But that may
2723 * change in the future, so let the ring buffer reserve
2724 * handle the failure in that case.
2726 if (val
== 1 && likely(len
<= max_len
)) {
2727 trace_event_setup(entry
, type
, trace_ctx
);
2728 entry
->array
[0] = len
;
2729 /* Return with preemption disabled */
2732 this_cpu_dec(trace_buffered_event_cnt
);
2734 /* __trace_buffer_lock_reserve() disables preemption */
2735 preempt_enable_notrace();
2738 entry
= __trace_buffer_lock_reserve(*current_rb
, type
, len
,
2741 * If tracing is off, but we have triggers enabled
2742 * we still need to look at the event data. Use the temp_buffer
2743 * to store the trace event for the trigger to use. It's recursive
2744 * safe and will not be recorded anywhere.
2746 if (!entry
&& trace_file
->flags
& EVENT_FILE_FL_TRIGGER_COND
) {
2747 *current_rb
= temp_buffer
;
2748 entry
= __trace_buffer_lock_reserve(*current_rb
, type
, len
,
2753 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve
);
2755 static DEFINE_RAW_SPINLOCK(tracepoint_iter_lock
);
2756 static DEFINE_MUTEX(tracepoint_printk_mutex
);
2758 static void output_printk(struct trace_event_buffer
*fbuffer
)
2760 struct trace_event_call
*event_call
;
2761 struct trace_event_file
*file
;
2762 struct trace_event
*event
;
2763 unsigned long flags
;
2764 struct trace_iterator
*iter
= tracepoint_print_iter
;
2766 /* We should never get here if iter is NULL */
2767 if (WARN_ON_ONCE(!iter
))
2770 event_call
= fbuffer
->trace_file
->event_call
;
2771 if (!event_call
|| !event_call
->event
.funcs
||
2772 !event_call
->event
.funcs
->trace
)
2775 file
= fbuffer
->trace_file
;
2776 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT
, &file
->flags
) ||
2777 (unlikely(file
->flags
& EVENT_FILE_FL_FILTERED
) &&
2778 !filter_match_preds(file
->filter
, fbuffer
->entry
)))
2781 event
= &fbuffer
->trace_file
->event_call
->event
;
2783 raw_spin_lock_irqsave(&tracepoint_iter_lock
, flags
);
2784 trace_seq_init(&iter
->seq
);
2785 iter
->ent
= fbuffer
->entry
;
2786 event_call
->event
.funcs
->trace(iter
, 0, event
);
2787 trace_seq_putc(&iter
->seq
, 0);
2788 printk("%s", iter
->seq
.buffer
);
2790 raw_spin_unlock_irqrestore(&tracepoint_iter_lock
, flags
);
2793 int tracepoint_printk_sysctl(const struct ctl_table
*table
, int write
,
2794 void *buffer
, size_t *lenp
,
2797 int save_tracepoint_printk
;
2800 mutex_lock(&tracepoint_printk_mutex
);
2801 save_tracepoint_printk
= tracepoint_printk
;
2803 ret
= proc_dointvec(table
, write
, buffer
, lenp
, ppos
);
2806 * This will force exiting early, as tracepoint_printk
2807 * is always zero when tracepoint_printk_iter is not allocated
2809 if (!tracepoint_print_iter
)
2810 tracepoint_printk
= 0;
2812 if (save_tracepoint_printk
== tracepoint_printk
)
2815 if (tracepoint_printk
)
2816 static_key_enable(&tracepoint_printk_key
.key
);
2818 static_key_disable(&tracepoint_printk_key
.key
);
2821 mutex_unlock(&tracepoint_printk_mutex
);
2826 void trace_event_buffer_commit(struct trace_event_buffer
*fbuffer
)
2828 enum event_trigger_type tt
= ETT_NONE
;
2829 struct trace_event_file
*file
= fbuffer
->trace_file
;
2831 if (__event_trigger_test_discard(file
, fbuffer
->buffer
, fbuffer
->event
,
2832 fbuffer
->entry
, &tt
))
2835 if (static_key_false(&tracepoint_printk_key
.key
))
2836 output_printk(fbuffer
);
2838 if (static_branch_unlikely(&trace_event_exports_enabled
))
2839 ftrace_exports(fbuffer
->event
, TRACE_EXPORT_EVENT
);
2841 trace_buffer_unlock_commit_regs(file
->tr
, fbuffer
->buffer
,
2842 fbuffer
->event
, fbuffer
->trace_ctx
, fbuffer
->regs
);
2846 event_triggers_post_call(file
, tt
);
2849 EXPORT_SYMBOL_GPL(trace_event_buffer_commit
);
2854 * trace_buffer_unlock_commit_regs()
2855 * trace_event_buffer_commit()
2856 * trace_event_raw_event_xxx()
2858 # define STACK_SKIP 3
2860 void trace_buffer_unlock_commit_regs(struct trace_array
*tr
,
2861 struct trace_buffer
*buffer
,
2862 struct ring_buffer_event
*event
,
2863 unsigned int trace_ctx
,
2864 struct pt_regs
*regs
)
2866 __buffer_unlock_commit(buffer
, event
);
2869 * If regs is not set, then skip the necessary functions.
2870 * Note, we can still get here via blktrace, wakeup tracer
2871 * and mmiotrace, but that's ok if they lose a function or
2872 * two. They are not that meaningful.
2874 ftrace_trace_stack(tr
, buffer
, trace_ctx
, regs
? 0 : STACK_SKIP
, regs
);
2875 ftrace_trace_userstack(tr
, buffer
, trace_ctx
);
2879 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
2882 trace_buffer_unlock_commit_nostack(struct trace_buffer
*buffer
,
2883 struct ring_buffer_event
*event
)
2885 __buffer_unlock_commit(buffer
, event
);
2889 trace_function(struct trace_array
*tr
, unsigned long ip
, unsigned long
2890 parent_ip
, unsigned int trace_ctx
)
2892 struct trace_event_call
*call
= &event_function
;
2893 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
2894 struct ring_buffer_event
*event
;
2895 struct ftrace_entry
*entry
;
2897 event
= __trace_buffer_lock_reserve(buffer
, TRACE_FN
, sizeof(*entry
),
2901 entry
= ring_buffer_event_data(event
);
2903 entry
->parent_ip
= parent_ip
;
2905 if (!call_filter_check_discard(call
, entry
, buffer
, event
)) {
2906 if (static_branch_unlikely(&trace_function_exports_enabled
))
2907 ftrace_exports(event
, TRACE_EXPORT_FUNCTION
);
2908 __buffer_unlock_commit(buffer
, event
);
2912 #ifdef CONFIG_STACKTRACE
2914 /* Allow 4 levels of nesting: normal, softirq, irq, NMI */
2915 #define FTRACE_KSTACK_NESTING 4
2917 #define FTRACE_KSTACK_ENTRIES (PAGE_SIZE / FTRACE_KSTACK_NESTING)
2919 struct ftrace_stack
{
2920 unsigned long calls
[FTRACE_KSTACK_ENTRIES
];
2924 struct ftrace_stacks
{
2925 struct ftrace_stack stacks
[FTRACE_KSTACK_NESTING
];
2928 static DEFINE_PER_CPU(struct ftrace_stacks
, ftrace_stacks
);
2929 static DEFINE_PER_CPU(int, ftrace_stack_reserve
);
2931 static void __ftrace_trace_stack(struct trace_buffer
*buffer
,
2932 unsigned int trace_ctx
,
2933 int skip
, struct pt_regs
*regs
)
2935 struct trace_event_call
*call
= &event_kernel_stack
;
2936 struct ring_buffer_event
*event
;
2937 unsigned int size
, nr_entries
;
2938 struct ftrace_stack
*fstack
;
2939 struct stack_entry
*entry
;
2943 * Add one, for this function and the call to save_stack_trace()
2944 * If regs is set, then these functions will not be in the way.
2946 #ifndef CONFIG_UNWINDER_ORC
2951 preempt_disable_notrace();
2953 stackidx
= __this_cpu_inc_return(ftrace_stack_reserve
) - 1;
2955 /* This should never happen. If it does, yell once and skip */
2956 if (WARN_ON_ONCE(stackidx
>= FTRACE_KSTACK_NESTING
))
2960 * The above __this_cpu_inc_return() is 'atomic' cpu local. An
2961 * interrupt will either see the value pre increment or post
2962 * increment. If the interrupt happens pre increment it will have
2963 * restored the counter when it returns. We just need a barrier to
2964 * keep gcc from moving things around.
2968 fstack
= this_cpu_ptr(ftrace_stacks
.stacks
) + stackidx
;
2969 size
= ARRAY_SIZE(fstack
->calls
);
2972 nr_entries
= stack_trace_save_regs(regs
, fstack
->calls
,
2975 nr_entries
= stack_trace_save(fstack
->calls
, size
, skip
);
2978 event
= __trace_buffer_lock_reserve(buffer
, TRACE_STACK
,
2979 struct_size(entry
, caller
, nr_entries
),
2983 entry
= ring_buffer_event_data(event
);
2985 entry
->size
= nr_entries
;
2986 memcpy(&entry
->caller
, fstack
->calls
,
2987 flex_array_size(entry
, caller
, nr_entries
));
2989 if (!call_filter_check_discard(call
, entry
, buffer
, event
))
2990 __buffer_unlock_commit(buffer
, event
);
2993 /* Again, don't let gcc optimize things here */
2995 __this_cpu_dec(ftrace_stack_reserve
);
2996 preempt_enable_notrace();
3000 static inline void ftrace_trace_stack(struct trace_array
*tr
,
3001 struct trace_buffer
*buffer
,
3002 unsigned int trace_ctx
,
3003 int skip
, struct pt_regs
*regs
)
3005 if (!(tr
->trace_flags
& TRACE_ITER_STACKTRACE
))
3008 __ftrace_trace_stack(buffer
, trace_ctx
, skip
, regs
);
3011 void __trace_stack(struct trace_array
*tr
, unsigned int trace_ctx
,
3014 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
3016 if (rcu_is_watching()) {
3017 __ftrace_trace_stack(buffer
, trace_ctx
, skip
, NULL
);
3021 if (WARN_ON_ONCE(IS_ENABLED(CONFIG_GENERIC_ENTRY
)))
3025 * When an NMI triggers, RCU is enabled via ct_nmi_enter(),
3026 * but if the above rcu_is_watching() failed, then the NMI
3027 * triggered someplace critical, and ct_irq_enter() should
3028 * not be called from NMI.
3030 if (unlikely(in_nmi()))
3033 ct_irq_enter_irqson();
3034 __ftrace_trace_stack(buffer
, trace_ctx
, skip
, NULL
);
3035 ct_irq_exit_irqson();
3039 * trace_dump_stack - record a stack back trace in the trace buffer
3040 * @skip: Number of functions to skip (helper handlers)
3042 void trace_dump_stack(int skip
)
3044 if (tracing_disabled
|| tracing_selftest_running
)
3047 #ifndef CONFIG_UNWINDER_ORC
3048 /* Skip 1 to skip this function. */
3051 __ftrace_trace_stack(printk_trace
->array_buffer
.buffer
,
3052 tracing_gen_ctx(), skip
, NULL
);
3054 EXPORT_SYMBOL_GPL(trace_dump_stack
);
3056 #ifdef CONFIG_USER_STACKTRACE_SUPPORT
3057 static DEFINE_PER_CPU(int, user_stack_count
);
3060 ftrace_trace_userstack(struct trace_array
*tr
,
3061 struct trace_buffer
*buffer
, unsigned int trace_ctx
)
3063 struct trace_event_call
*call
= &event_user_stack
;
3064 struct ring_buffer_event
*event
;
3065 struct userstack_entry
*entry
;
3067 if (!(tr
->trace_flags
& TRACE_ITER_USERSTACKTRACE
))
3071 * NMIs can not handle page faults, even with fix ups.
3072 * The save user stack can (and often does) fault.
3074 if (unlikely(in_nmi()))
3078 * prevent recursion, since the user stack tracing may
3079 * trigger other kernel events.
3082 if (__this_cpu_read(user_stack_count
))
3085 __this_cpu_inc(user_stack_count
);
3087 event
= __trace_buffer_lock_reserve(buffer
, TRACE_USER_STACK
,
3088 sizeof(*entry
), trace_ctx
);
3090 goto out_drop_count
;
3091 entry
= ring_buffer_event_data(event
);
3093 entry
->tgid
= current
->tgid
;
3094 memset(&entry
->caller
, 0, sizeof(entry
->caller
));
3096 stack_trace_save_user(entry
->caller
, FTRACE_STACK_ENTRIES
);
3097 if (!call_filter_check_discard(call
, entry
, buffer
, event
))
3098 __buffer_unlock_commit(buffer
, event
);
3101 __this_cpu_dec(user_stack_count
);
3105 #else /* CONFIG_USER_STACKTRACE_SUPPORT */
3106 static void ftrace_trace_userstack(struct trace_array
*tr
,
3107 struct trace_buffer
*buffer
,
3108 unsigned int trace_ctx
)
3111 #endif /* !CONFIG_USER_STACKTRACE_SUPPORT */
3113 #endif /* CONFIG_STACKTRACE */
3116 func_repeats_set_delta_ts(struct func_repeats_entry
*entry
,
3117 unsigned long long delta
)
3119 entry
->bottom_delta_ts
= delta
& U32_MAX
;
3120 entry
->top_delta_ts
= (delta
>> 32);
3123 void trace_last_func_repeats(struct trace_array
*tr
,
3124 struct trace_func_repeats
*last_info
,
3125 unsigned int trace_ctx
)
3127 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
3128 struct func_repeats_entry
*entry
;
3129 struct ring_buffer_event
*event
;
3132 event
= __trace_buffer_lock_reserve(buffer
, TRACE_FUNC_REPEATS
,
3133 sizeof(*entry
), trace_ctx
);
3137 delta
= ring_buffer_event_time_stamp(buffer
, event
) -
3138 last_info
->ts_last_call
;
3140 entry
= ring_buffer_event_data(event
);
3141 entry
->ip
= last_info
->ip
;
3142 entry
->parent_ip
= last_info
->parent_ip
;
3143 entry
->count
= last_info
->count
;
3144 func_repeats_set_delta_ts(entry
, delta
);
3146 __buffer_unlock_commit(buffer
, event
);
3149 /* created for use with alloc_percpu */
3150 struct trace_buffer_struct
{
3152 char buffer
[4][TRACE_BUF_SIZE
];
3155 static struct trace_buffer_struct __percpu
*trace_percpu_buffer
;
3158 * This allows for lockless recording. If we're nested too deeply, then
3159 * this returns NULL.
3161 static char *get_trace_buf(void)
3163 struct trace_buffer_struct
*buffer
= this_cpu_ptr(trace_percpu_buffer
);
3165 if (!trace_percpu_buffer
|| buffer
->nesting
>= 4)
3170 /* Interrupts must see nesting incremented before we use the buffer */
3172 return &buffer
->buffer
[buffer
->nesting
- 1][0];
3175 static void put_trace_buf(void)
3177 /* Don't let the decrement of nesting leak before this */
3179 this_cpu_dec(trace_percpu_buffer
->nesting
);
3182 static int alloc_percpu_trace_buffer(void)
3184 struct trace_buffer_struct __percpu
*buffers
;
3186 if (trace_percpu_buffer
)
3189 buffers
= alloc_percpu(struct trace_buffer_struct
);
3190 if (MEM_FAIL(!buffers
, "Could not allocate percpu trace_printk buffer"))
3193 trace_percpu_buffer
= buffers
;
3197 static int buffers_allocated
;
3199 void trace_printk_init_buffers(void)
3201 if (buffers_allocated
)
3204 if (alloc_percpu_trace_buffer())
3207 /* trace_printk() is for debug use only. Don't use it in production. */
3210 pr_warn("**********************************************************\n");
3211 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3213 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
3215 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
3216 pr_warn("** unsafe for production use. **\n");
3218 pr_warn("** If you see this message and you are not debugging **\n");
3219 pr_warn("** the kernel, report this immediately to your vendor! **\n");
3221 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3222 pr_warn("**********************************************************\n");
3224 /* Expand the buffers to set size */
3225 tracing_update_buffers(&global_trace
);
3227 buffers_allocated
= 1;
3230 * trace_printk_init_buffers() can be called by modules.
3231 * If that happens, then we need to start cmdline recording
3232 * directly here. If the global_trace.buffer is already
3233 * allocated here, then this was called by module code.
3235 if (global_trace
.array_buffer
.buffer
)
3236 tracing_start_cmdline_record();
3238 EXPORT_SYMBOL_GPL(trace_printk_init_buffers
);
3240 void trace_printk_start_comm(void)
3242 /* Start tracing comms if trace printk is set */
3243 if (!buffers_allocated
)
3245 tracing_start_cmdline_record();
3248 static void trace_printk_start_stop_comm(int enabled
)
3250 if (!buffers_allocated
)
3254 tracing_start_cmdline_record();
3256 tracing_stop_cmdline_record();
3260 * trace_vbprintk - write binary msg to tracing buffer
3261 * @ip: The address of the caller
3262 * @fmt: The string format to write to the buffer
3263 * @args: Arguments for @fmt
3265 int trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
)
3267 struct trace_event_call
*call
= &event_bprint
;
3268 struct ring_buffer_event
*event
;
3269 struct trace_buffer
*buffer
;
3270 struct trace_array
*tr
= READ_ONCE(printk_trace
);
3271 struct bprint_entry
*entry
;
3272 unsigned int trace_ctx
;
3276 if (!printk_binsafe(tr
))
3277 return trace_vprintk(ip
, fmt
, args
);
3279 if (unlikely(tracing_selftest_running
|| tracing_disabled
))
3282 /* Don't pollute graph traces with trace_vprintk internals */
3283 pause_graph_tracing();
3285 trace_ctx
= tracing_gen_ctx();
3286 preempt_disable_notrace();
3288 tbuffer
= get_trace_buf();
3294 len
= vbin_printf((u32
*)tbuffer
, TRACE_BUF_SIZE
/sizeof(int), fmt
, args
);
3296 if (len
> TRACE_BUF_SIZE
/sizeof(int) || len
< 0)
3299 size
= sizeof(*entry
) + sizeof(u32
) * len
;
3300 buffer
= tr
->array_buffer
.buffer
;
3301 ring_buffer_nest_start(buffer
);
3302 event
= __trace_buffer_lock_reserve(buffer
, TRACE_BPRINT
, size
,
3306 entry
= ring_buffer_event_data(event
);
3310 memcpy(entry
->buf
, tbuffer
, sizeof(u32
) * len
);
3311 if (!call_filter_check_discard(call
, entry
, buffer
, event
)) {
3312 __buffer_unlock_commit(buffer
, event
);
3313 ftrace_trace_stack(tr
, buffer
, trace_ctx
, 6, NULL
);
3317 ring_buffer_nest_end(buffer
);
3322 preempt_enable_notrace();
3323 unpause_graph_tracing();
3327 EXPORT_SYMBOL_GPL(trace_vbprintk
);
3331 __trace_array_vprintk(struct trace_buffer
*buffer
,
3332 unsigned long ip
, const char *fmt
, va_list args
)
3334 struct trace_event_call
*call
= &event_print
;
3335 struct ring_buffer_event
*event
;
3337 struct print_entry
*entry
;
3338 unsigned int trace_ctx
;
3341 if (tracing_disabled
)
3344 /* Don't pollute graph traces with trace_vprintk internals */
3345 pause_graph_tracing();
3347 trace_ctx
= tracing_gen_ctx();
3348 preempt_disable_notrace();
3351 tbuffer
= get_trace_buf();
3357 len
= vscnprintf(tbuffer
, TRACE_BUF_SIZE
, fmt
, args
);
3359 size
= sizeof(*entry
) + len
+ 1;
3360 ring_buffer_nest_start(buffer
);
3361 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, size
,
3365 entry
= ring_buffer_event_data(event
);
3368 memcpy(&entry
->buf
, tbuffer
, len
+ 1);
3369 if (!call_filter_check_discard(call
, entry
, buffer
, event
)) {
3370 __buffer_unlock_commit(buffer
, event
);
3371 ftrace_trace_stack(printk_trace
, buffer
, trace_ctx
, 6, NULL
);
3375 ring_buffer_nest_end(buffer
);
3379 preempt_enable_notrace();
3380 unpause_graph_tracing();
3386 int trace_array_vprintk(struct trace_array
*tr
,
3387 unsigned long ip
, const char *fmt
, va_list args
)
3389 if (tracing_selftest_running
&& tr
== &global_trace
)
3392 return __trace_array_vprintk(tr
->array_buffer
.buffer
, ip
, fmt
, args
);
3396 * trace_array_printk - Print a message to a specific instance
3397 * @tr: The instance trace_array descriptor
3398 * @ip: The instruction pointer that this is called from.
3399 * @fmt: The format to print (printf format)
3401 * If a subsystem sets up its own instance, they have the right to
3402 * printk strings into their tracing instance buffer using this
3403 * function. Note, this function will not write into the top level
3404 * buffer (use trace_printk() for that), as writing into the top level
3405 * buffer should only have events that can be individually disabled.
3406 * trace_printk() is only used for debugging a kernel, and should not
3407 * be ever incorporated in normal use.
3409 * trace_array_printk() can be used, as it will not add noise to the
3410 * top level tracing buffer.
3412 * Note, trace_array_init_printk() must be called on @tr before this
3416 int trace_array_printk(struct trace_array
*tr
,
3417 unsigned long ip
, const char *fmt
, ...)
3425 /* This is only allowed for created instances */
3426 if (tr
== &global_trace
)
3429 if (!(tr
->trace_flags
& TRACE_ITER_PRINTK
))
3433 ret
= trace_array_vprintk(tr
, ip
, fmt
, ap
);
3437 EXPORT_SYMBOL_GPL(trace_array_printk
);
3440 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3441 * @tr: The trace array to initialize the buffers for
3443 * As trace_array_printk() only writes into instances, they are OK to
3444 * have in the kernel (unlike trace_printk()). This needs to be called
3445 * before trace_array_printk() can be used on a trace_array.
3447 int trace_array_init_printk(struct trace_array
*tr
)
3452 /* This is only allowed for created instances */
3453 if (tr
== &global_trace
)
3456 return alloc_percpu_trace_buffer();
3458 EXPORT_SYMBOL_GPL(trace_array_init_printk
);
3461 int trace_array_printk_buf(struct trace_buffer
*buffer
,
3462 unsigned long ip
, const char *fmt
, ...)
3467 if (!(printk_trace
->trace_flags
& TRACE_ITER_PRINTK
))
3471 ret
= __trace_array_vprintk(buffer
, ip
, fmt
, ap
);
3477 int trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
)
3479 return trace_array_vprintk(printk_trace
, ip
, fmt
, args
);
3481 EXPORT_SYMBOL_GPL(trace_vprintk
);
3483 static void trace_iterator_increment(struct trace_iterator
*iter
)
3485 struct ring_buffer_iter
*buf_iter
= trace_buffer_iter(iter
, iter
->cpu
);
3489 ring_buffer_iter_advance(buf_iter
);
3492 static struct trace_entry
*
3493 peek_next_entry(struct trace_iterator
*iter
, int cpu
, u64
*ts
,
3494 unsigned long *lost_events
)
3496 struct ring_buffer_event
*event
;
3497 struct ring_buffer_iter
*buf_iter
= trace_buffer_iter(iter
, cpu
);
3500 event
= ring_buffer_iter_peek(buf_iter
, ts
);
3502 *lost_events
= ring_buffer_iter_dropped(buf_iter
) ?
3503 (unsigned long)-1 : 0;
3505 event
= ring_buffer_peek(iter
->array_buffer
->buffer
, cpu
, ts
,
3510 iter
->ent_size
= ring_buffer_event_length(event
);
3511 return ring_buffer_event_data(event
);
3517 static struct trace_entry
*
3518 __find_next_entry(struct trace_iterator
*iter
, int *ent_cpu
,
3519 unsigned long *missing_events
, u64
*ent_ts
)
3521 struct trace_buffer
*buffer
= iter
->array_buffer
->buffer
;
3522 struct trace_entry
*ent
, *next
= NULL
;
3523 unsigned long lost_events
= 0, next_lost
= 0;
3524 int cpu_file
= iter
->cpu_file
;
3525 u64 next_ts
= 0, ts
;
3531 * If we are in a per_cpu trace file, don't bother by iterating over
3532 * all cpu and peek directly.
3534 if (cpu_file
> RING_BUFFER_ALL_CPUS
) {
3535 if (ring_buffer_empty_cpu(buffer
, cpu_file
))
3537 ent
= peek_next_entry(iter
, cpu_file
, ent_ts
, missing_events
);
3539 *ent_cpu
= cpu_file
;
3544 for_each_tracing_cpu(cpu
) {
3546 if (ring_buffer_empty_cpu(buffer
, cpu
))
3549 ent
= peek_next_entry(iter
, cpu
, &ts
, &lost_events
);
3552 * Pick the entry with the smallest timestamp:
3554 if (ent
&& (!next
|| ts
< next_ts
)) {
3558 next_lost
= lost_events
;
3559 next_size
= iter
->ent_size
;
3563 iter
->ent_size
= next_size
;
3566 *ent_cpu
= next_cpu
;
3572 *missing_events
= next_lost
;
3577 #define STATIC_FMT_BUF_SIZE 128
3578 static char static_fmt_buf
[STATIC_FMT_BUF_SIZE
];
3580 char *trace_iter_expand_format(struct trace_iterator
*iter
)
3585 * iter->tr is NULL when used with tp_printk, which makes
3586 * this get called where it is not safe to call krealloc().
3588 if (!iter
->tr
|| iter
->fmt
== static_fmt_buf
)
3591 tmp
= krealloc(iter
->fmt
, iter
->fmt_size
+ STATIC_FMT_BUF_SIZE
,
3594 iter
->fmt_size
+= STATIC_FMT_BUF_SIZE
;
3601 /* Returns true if the string is safe to dereference from an event */
3602 static bool trace_safe_str(struct trace_iterator
*iter
, const char *str
,
3605 unsigned long addr
= (unsigned long)str
;
3606 struct trace_event
*trace_event
;
3607 struct trace_event_call
*event
;
3609 /* Ignore strings with no length */
3613 /* OK if part of the event data */
3614 if ((addr
>= (unsigned long)iter
->ent
) &&
3615 (addr
< (unsigned long)iter
->ent
+ iter
->ent_size
))
3618 /* OK if part of the temp seq buffer */
3619 if ((addr
>= (unsigned long)iter
->tmp_seq
.buffer
) &&
3620 (addr
< (unsigned long)iter
->tmp_seq
.buffer
+ TRACE_SEQ_BUFFER_SIZE
))
3623 /* Core rodata can not be freed */
3624 if (is_kernel_rodata(addr
))
3627 if (trace_is_tracepoint_string(str
))
3631 * Now this could be a module event, referencing core module
3632 * data, which is OK.
3637 trace_event
= ftrace_find_event(iter
->ent
->type
);
3641 event
= container_of(trace_event
, struct trace_event_call
, event
);
3642 if ((event
->flags
& TRACE_EVENT_FL_DYNAMIC
) || !event
->module
)
3645 /* Would rather have rodata, but this will suffice */
3646 if (within_module_core(addr
, event
->module
))
3652 static DEFINE_STATIC_KEY_FALSE(trace_no_verify
);
3654 static int test_can_verify_check(const char *fmt
, ...)
3661 * The verifier is dependent on vsnprintf() modifies the va_list
3662 * passed to it, where it is sent as a reference. Some architectures
3663 * (like x86_32) passes it by value, which means that vsnprintf()
3664 * does not modify the va_list passed to it, and the verifier
3665 * would then need to be able to understand all the values that
3666 * vsnprintf can use. If it is passed by value, then the verifier
3670 vsnprintf(buf
, 16, "%d", ap
);
3671 ret
= va_arg(ap
, int);
3677 static void test_can_verify(void)
3679 if (!test_can_verify_check("%d %d", 0, 1)) {
3680 pr_info("trace event string verifier disabled\n");
3681 static_branch_inc(&trace_no_verify
);
3686 * trace_check_vprintf - Check dereferenced strings while writing to the seq buffer
3687 * @iter: The iterator that holds the seq buffer and the event being printed
3688 * @fmt: The format used to print the event
3689 * @ap: The va_list holding the data to print from @fmt.
3691 * This writes the data into the @iter->seq buffer using the data from
3692 * @fmt and @ap. If the format has a %s, then the source of the string
3693 * is examined to make sure it is safe to print, otherwise it will
3694 * warn and print "[UNSAFE MEMORY]" in place of the dereferenced string
3697 void trace_check_vprintf(struct trace_iterator
*iter
, const char *fmt
,
3700 long text_delta
= 0;
3701 long data_delta
= 0;
3702 const char *p
= fmt
;
3707 if (WARN_ON_ONCE(!fmt
))
3710 if (static_branch_unlikely(&trace_no_verify
))
3714 * When the kernel is booted with the tp_printk command line
3715 * parameter, trace events go directly through to printk().
3716 * It also is checked by this function, but it does not
3717 * have an associated trace_array (tr) for it.
3720 text_delta
= iter
->tr
->text_delta
;
3721 data_delta
= iter
->tr
->data_delta
;
3724 /* Don't bother checking when doing a ftrace_dump() */
3725 if (iter
->fmt
== static_fmt_buf
)
3735 * We only care about %s and variants
3736 * as well as %p[sS] if delta is non-zero
3738 for (i
= 0; p
[i
]; i
++) {
3739 if (i
+ 1 >= iter
->fmt_size
) {
3741 * If we can't expand the copy buffer,
3744 if (!trace_iter_expand_format(iter
))
3748 if (p
[i
] == '\\' && p
[i
+1]) {
3753 /* Need to test cases like %08.*s */
3754 for (j
= 1; p
[i
+j
]; j
++) {
3755 if (isdigit(p
[i
+j
]) ||
3758 if (p
[i
+j
] == '*') {
3767 if (text_delta
&& p
[i
+1] == 'p' &&
3768 ((p
[i
+2] == 's' || p
[i
+2] == 'S')))
3775 /* If no %s found then just print normally */
3779 /* Copy up to the %s, and print that */
3780 strncpy(iter
->fmt
, p
, i
);
3781 iter
->fmt
[i
] = '\0';
3782 trace_seq_vprintf(&iter
->seq
, iter
->fmt
, ap
);
3784 /* Add delta to %pS pointers */
3785 if (p
[i
+1] == 'p') {
3791 fmt
[2] = p
[i
+2]; /* Either %ps or %pS */
3794 addr
= va_arg(ap
, unsigned long);
3796 trace_seq_printf(&iter
->seq
, fmt
, (void *)addr
);
3803 * If iter->seq is full, the above call no longer guarantees
3804 * that ap is in sync with fmt processing, and further calls
3805 * to va_arg() can return wrong positional arguments.
3807 * Ensure that ap is no longer used in this case.
3809 if (iter
->seq
.full
) {
3815 len
= va_arg(ap
, int);
3817 /* The ap now points to the string data of the %s */
3818 str
= va_arg(ap
, const char *);
3820 good
= trace_safe_str(iter
, str
, star
, len
);
3822 /* Could be from the last boot */
3823 if (data_delta
&& !good
) {
3825 good
= trace_safe_str(iter
, str
, star
, len
);
3829 * If you hit this warning, it is likely that the
3830 * trace event in question used %s on a string that
3831 * was saved at the time of the event, but may not be
3832 * around when the trace is read. Use __string(),
3833 * __assign_str() and __get_str() helpers in the TRACE_EVENT()
3834 * instead. See samples/trace_events/trace-events-sample.h
3837 if (WARN_ONCE(!good
, "fmt: '%s' current_buffer: '%s'",
3838 fmt
, seq_buf_str(&iter
->seq
.seq
))) {
3841 /* Try to safely read the string */
3843 if (len
+ 1 > iter
->fmt_size
)
3844 len
= iter
->fmt_size
- 1;
3847 ret
= copy_from_kernel_nofault(iter
->fmt
, str
, len
);
3851 ret
= strncpy_from_kernel_nofault(iter
->fmt
, str
,
3855 trace_seq_printf(&iter
->seq
, "(0x%px)", str
);
3857 trace_seq_printf(&iter
->seq
, "(0x%px:%s)",
3859 str
= "[UNSAFE-MEMORY]";
3860 strcpy(iter
->fmt
, "%s");
3862 strncpy(iter
->fmt
, p
+ i
, j
+ 1);
3863 iter
->fmt
[j
+1] = '\0';
3866 trace_seq_printf(&iter
->seq
, iter
->fmt
, len
, str
);
3868 trace_seq_printf(&iter
->seq
, iter
->fmt
, str
);
3874 trace_seq_vprintf(&iter
->seq
, p
, ap
);
3877 const char *trace_event_format(struct trace_iterator
*iter
, const char *fmt
)
3879 const char *p
, *new_fmt
;
3882 if (WARN_ON_ONCE(!fmt
))
3885 if (!iter
->tr
|| iter
->tr
->trace_flags
& TRACE_ITER_HASH_PTR
)
3889 new_fmt
= q
= iter
->fmt
;
3891 if (unlikely(q
- new_fmt
+ 3 > iter
->fmt_size
)) {
3892 if (!trace_iter_expand_format(iter
))
3895 q
+= iter
->fmt
- new_fmt
;
3896 new_fmt
= iter
->fmt
;
3901 /* Replace %p with %px */
3905 } else if (p
[0] == 'p' && !isalnum(p
[1])) {
3916 #define STATIC_TEMP_BUF_SIZE 128
3917 static char static_temp_buf
[STATIC_TEMP_BUF_SIZE
] __aligned(4);
3919 /* Find the next real entry, without updating the iterator itself */
3920 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
3921 int *ent_cpu
, u64
*ent_ts
)
3923 /* __find_next_entry will reset ent_size */
3924 int ent_size
= iter
->ent_size
;
3925 struct trace_entry
*entry
;
3928 * If called from ftrace_dump(), then the iter->temp buffer
3929 * will be the static_temp_buf and not created from kmalloc.
3930 * If the entry size is greater than the buffer, we can
3931 * not save it. Just return NULL in that case. This is only
3932 * used to add markers when two consecutive events' time
3933 * stamps have a large delta. See trace_print_lat_context()
3935 if (iter
->temp
== static_temp_buf
&&
3936 STATIC_TEMP_BUF_SIZE
< ent_size
)
3940 * The __find_next_entry() may call peek_next_entry(), which may
3941 * call ring_buffer_peek() that may make the contents of iter->ent
3942 * undefined. Need to copy iter->ent now.
3944 if (iter
->ent
&& iter
->ent
!= iter
->temp
) {
3945 if ((!iter
->temp
|| iter
->temp_size
< iter
->ent_size
) &&
3946 !WARN_ON_ONCE(iter
->temp
== static_temp_buf
)) {
3948 temp
= kmalloc(iter
->ent_size
, GFP_KERNEL
);
3953 iter
->temp_size
= iter
->ent_size
;
3955 memcpy(iter
->temp
, iter
->ent
, iter
->ent_size
);
3956 iter
->ent
= iter
->temp
;
3958 entry
= __find_next_entry(iter
, ent_cpu
, NULL
, ent_ts
);
3959 /* Put back the original ent_size */
3960 iter
->ent_size
= ent_size
;
3965 /* Find the next real entry, and increment the iterator to the next entry */
3966 void *trace_find_next_entry_inc(struct trace_iterator
*iter
)
3968 iter
->ent
= __find_next_entry(iter
, &iter
->cpu
,
3969 &iter
->lost_events
, &iter
->ts
);
3972 trace_iterator_increment(iter
);
3974 return iter
->ent
? iter
: NULL
;
3977 static void trace_consume(struct trace_iterator
*iter
)
3979 ring_buffer_consume(iter
->array_buffer
->buffer
, iter
->cpu
, &iter
->ts
,
3980 &iter
->lost_events
);
3983 static void *s_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
3985 struct trace_iterator
*iter
= m
->private;
3989 WARN_ON_ONCE(iter
->leftover
);
3993 /* can't go backwards */
3998 ent
= trace_find_next_entry_inc(iter
);
4002 while (ent
&& iter
->idx
< i
)
4003 ent
= trace_find_next_entry_inc(iter
);
4010 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
)
4012 struct ring_buffer_iter
*buf_iter
;
4013 unsigned long entries
= 0;
4016 per_cpu_ptr(iter
->array_buffer
->data
, cpu
)->skipped_entries
= 0;
4018 buf_iter
= trace_buffer_iter(iter
, cpu
);
4022 ring_buffer_iter_reset(buf_iter
);
4025 * We could have the case with the max latency tracers
4026 * that a reset never took place on a cpu. This is evident
4027 * by the timestamp being before the start of the buffer.
4029 while (ring_buffer_iter_peek(buf_iter
, &ts
)) {
4030 if (ts
>= iter
->array_buffer
->time_start
)
4033 ring_buffer_iter_advance(buf_iter
);
4034 /* This could be a big loop */
4038 per_cpu_ptr(iter
->array_buffer
->data
, cpu
)->skipped_entries
= entries
;
4042 * The current tracer is copied to avoid a global locking
4045 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
4047 struct trace_iterator
*iter
= m
->private;
4048 struct trace_array
*tr
= iter
->tr
;
4049 int cpu_file
= iter
->cpu_file
;
4054 mutex_lock(&trace_types_lock
);
4055 if (unlikely(tr
->current_trace
!= iter
->trace
)) {
4056 /* Close iter->trace before switching to the new current tracer */
4057 if (iter
->trace
->close
)
4058 iter
->trace
->close(iter
);
4059 iter
->trace
= tr
->current_trace
;
4060 /* Reopen the new current tracer */
4061 if (iter
->trace
->open
)
4062 iter
->trace
->open(iter
);
4064 mutex_unlock(&trace_types_lock
);
4066 #ifdef CONFIG_TRACER_MAX_TRACE
4067 if (iter
->snapshot
&& iter
->trace
->use_max_tr
)
4068 return ERR_PTR(-EBUSY
);
4071 if (*pos
!= iter
->pos
) {
4076 if (cpu_file
== RING_BUFFER_ALL_CPUS
) {
4077 for_each_tracing_cpu(cpu
)
4078 tracing_iter_reset(iter
, cpu
);
4080 tracing_iter_reset(iter
, cpu_file
);
4083 for (p
= iter
; p
&& l
< *pos
; p
= s_next(m
, p
, &l
))
4088 * If we overflowed the seq_file before, then we want
4089 * to just reuse the trace_seq buffer again.
4095 p
= s_next(m
, p
, &l
);
4099 trace_event_read_lock();
4100 trace_access_lock(cpu_file
);
4104 static void s_stop(struct seq_file
*m
, void *p
)
4106 struct trace_iterator
*iter
= m
->private;
4108 #ifdef CONFIG_TRACER_MAX_TRACE
4109 if (iter
->snapshot
&& iter
->trace
->use_max_tr
)
4113 trace_access_unlock(iter
->cpu_file
);
4114 trace_event_read_unlock();
4118 get_total_entries_cpu(struct array_buffer
*buf
, unsigned long *total
,
4119 unsigned long *entries
, int cpu
)
4121 unsigned long count
;
4123 count
= ring_buffer_entries_cpu(buf
->buffer
, cpu
);
4125 * If this buffer has skipped entries, then we hold all
4126 * entries for the trace and we need to ignore the
4127 * ones before the time stamp.
4129 if (per_cpu_ptr(buf
->data
, cpu
)->skipped_entries
) {
4130 count
-= per_cpu_ptr(buf
->data
, cpu
)->skipped_entries
;
4131 /* total is the same as the entries */
4135 ring_buffer_overrun_cpu(buf
->buffer
, cpu
);
4140 get_total_entries(struct array_buffer
*buf
,
4141 unsigned long *total
, unsigned long *entries
)
4149 for_each_tracing_cpu(cpu
) {
4150 get_total_entries_cpu(buf
, &t
, &e
, cpu
);
4156 unsigned long trace_total_entries_cpu(struct trace_array
*tr
, int cpu
)
4158 unsigned long total
, entries
;
4163 get_total_entries_cpu(&tr
->array_buffer
, &total
, &entries
, cpu
);
4168 unsigned long trace_total_entries(struct trace_array
*tr
)
4170 unsigned long total
, entries
;
4175 get_total_entries(&tr
->array_buffer
, &total
, &entries
);
4180 static void print_lat_help_header(struct seq_file
*m
)
4182 seq_puts(m
, "# _------=> CPU# \n"
4183 "# / _-----=> irqs-off/BH-disabled\n"
4184 "# | / _----=> need-resched \n"
4185 "# || / _---=> hardirq/softirq \n"
4186 "# ||| / _--=> preempt-depth \n"
4187 "# |||| / _-=> migrate-disable \n"
4188 "# ||||| / delay \n"
4189 "# cmd pid |||||| time | caller \n"
4190 "# \\ / |||||| \\ | / \n");
4193 static void print_event_info(struct array_buffer
*buf
, struct seq_file
*m
)
4195 unsigned long total
;
4196 unsigned long entries
;
4198 get_total_entries(buf
, &total
, &entries
);
4199 seq_printf(m
, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
4200 entries
, total
, num_online_cpus());
4204 static void print_func_help_header(struct array_buffer
*buf
, struct seq_file
*m
,
4207 bool tgid
= flags
& TRACE_ITER_RECORD_TGID
;
4209 print_event_info(buf
, m
);
4211 seq_printf(m
, "# TASK-PID %s CPU# TIMESTAMP FUNCTION\n", tgid
? " TGID " : "");
4212 seq_printf(m
, "# | | %s | | |\n", tgid
? " | " : "");
4215 static void print_func_help_header_irq(struct array_buffer
*buf
, struct seq_file
*m
,
4218 bool tgid
= flags
& TRACE_ITER_RECORD_TGID
;
4219 static const char space
[] = " ";
4220 int prec
= tgid
? 12 : 2;
4222 print_event_info(buf
, m
);
4224 seq_printf(m
, "# %.*s _-----=> irqs-off/BH-disabled\n", prec
, space
);
4225 seq_printf(m
, "# %.*s / _----=> need-resched\n", prec
, space
);
4226 seq_printf(m
, "# %.*s| / _---=> hardirq/softirq\n", prec
, space
);
4227 seq_printf(m
, "# %.*s|| / _--=> preempt-depth\n", prec
, space
);
4228 seq_printf(m
, "# %.*s||| / _-=> migrate-disable\n", prec
, space
);
4229 seq_printf(m
, "# %.*s|||| / delay\n", prec
, space
);
4230 seq_printf(m
, "# TASK-PID %.*s CPU# ||||| TIMESTAMP FUNCTION\n", prec
, " TGID ");
4231 seq_printf(m
, "# | | %.*s | ||||| | |\n", prec
, " | ");
4235 print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
)
4237 unsigned long sym_flags
= (global_trace
.trace_flags
& TRACE_ITER_SYM_MASK
);
4238 struct array_buffer
*buf
= iter
->array_buffer
;
4239 struct trace_array_cpu
*data
= per_cpu_ptr(buf
->data
, buf
->cpu
);
4240 struct tracer
*type
= iter
->trace
;
4241 unsigned long entries
;
4242 unsigned long total
;
4243 const char *name
= type
->name
;
4245 get_total_entries(buf
, &total
, &entries
);
4247 seq_printf(m
, "# %s latency trace v1.1.5 on %s\n",
4248 name
, init_utsname()->release
);
4249 seq_puts(m
, "# -----------------------------------"
4250 "---------------------------------\n");
4251 seq_printf(m
, "# latency: %lu us, #%lu/%lu, CPU#%d |"
4252 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
4253 nsecs_to_usecs(data
->saved_latency
),
4257 preempt_model_none() ? "server" :
4258 preempt_model_voluntary() ? "desktop" :
4259 preempt_model_full() ? "preempt" :
4260 preempt_model_rt() ? "preempt_rt" :
4262 /* These are reserved for later use */
4265 seq_printf(m
, " #P:%d)\n", num_online_cpus());
4269 seq_puts(m
, "# -----------------\n");
4270 seq_printf(m
, "# | task: %.16s-%d "
4271 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
4272 data
->comm
, data
->pid
,
4273 from_kuid_munged(seq_user_ns(m
), data
->uid
), data
->nice
,
4274 data
->policy
, data
->rt_priority
);
4275 seq_puts(m
, "# -----------------\n");
4277 if (data
->critical_start
) {
4278 seq_puts(m
, "# => started at: ");
4279 seq_print_ip_sym(&iter
->seq
, data
->critical_start
, sym_flags
);
4280 trace_print_seq(m
, &iter
->seq
);
4281 seq_puts(m
, "\n# => ended at: ");
4282 seq_print_ip_sym(&iter
->seq
, data
->critical_end
, sym_flags
);
4283 trace_print_seq(m
, &iter
->seq
);
4284 seq_puts(m
, "\n#\n");
4290 static void test_cpu_buff_start(struct trace_iterator
*iter
)
4292 struct trace_seq
*s
= &iter
->seq
;
4293 struct trace_array
*tr
= iter
->tr
;
4295 if (!(tr
->trace_flags
& TRACE_ITER_ANNOTATE
))
4298 if (!(iter
->iter_flags
& TRACE_FILE_ANNOTATE
))
4301 if (cpumask_available(iter
->started
) &&
4302 cpumask_test_cpu(iter
->cpu
, iter
->started
))
4305 if (per_cpu_ptr(iter
->array_buffer
->data
, iter
->cpu
)->skipped_entries
)
4308 if (cpumask_available(iter
->started
))
4309 cpumask_set_cpu(iter
->cpu
, iter
->started
);
4311 /* Don't print started cpu buffer for the first entry of the trace */
4313 trace_seq_printf(s
, "##### CPU %u buffer started ####\n",
4317 static enum print_line_t
print_trace_fmt(struct trace_iterator
*iter
)
4319 struct trace_array
*tr
= iter
->tr
;
4320 struct trace_seq
*s
= &iter
->seq
;
4321 unsigned long sym_flags
= (tr
->trace_flags
& TRACE_ITER_SYM_MASK
);
4322 struct trace_entry
*entry
;
4323 struct trace_event
*event
;
4327 test_cpu_buff_start(iter
);
4329 event
= ftrace_find_event(entry
->type
);
4331 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4332 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
)
4333 trace_print_lat_context(iter
);
4335 trace_print_context(iter
);
4338 if (trace_seq_has_overflowed(s
))
4339 return TRACE_TYPE_PARTIAL_LINE
;
4342 if (tr
->trace_flags
& TRACE_ITER_FIELDS
)
4343 return print_event_fields(iter
, event
);
4344 return event
->funcs
->trace(iter
, sym_flags
, event
);
4347 trace_seq_printf(s
, "Unknown type %d\n", entry
->type
);
4349 return trace_handle_return(s
);
4352 static enum print_line_t
print_raw_fmt(struct trace_iterator
*iter
)
4354 struct trace_array
*tr
= iter
->tr
;
4355 struct trace_seq
*s
= &iter
->seq
;
4356 struct trace_entry
*entry
;
4357 struct trace_event
*event
;
4361 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
)
4362 trace_seq_printf(s
, "%d %d %llu ",
4363 entry
->pid
, iter
->cpu
, iter
->ts
);
4365 if (trace_seq_has_overflowed(s
))
4366 return TRACE_TYPE_PARTIAL_LINE
;
4368 event
= ftrace_find_event(entry
->type
);
4370 return event
->funcs
->raw(iter
, 0, event
);
4372 trace_seq_printf(s
, "%d ?\n", entry
->type
);
4374 return trace_handle_return(s
);
4377 static enum print_line_t
print_hex_fmt(struct trace_iterator
*iter
)
4379 struct trace_array
*tr
= iter
->tr
;
4380 struct trace_seq
*s
= &iter
->seq
;
4381 unsigned char newline
= '\n';
4382 struct trace_entry
*entry
;
4383 struct trace_event
*event
;
4387 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4388 SEQ_PUT_HEX_FIELD(s
, entry
->pid
);
4389 SEQ_PUT_HEX_FIELD(s
, iter
->cpu
);
4390 SEQ_PUT_HEX_FIELD(s
, iter
->ts
);
4391 if (trace_seq_has_overflowed(s
))
4392 return TRACE_TYPE_PARTIAL_LINE
;
4395 event
= ftrace_find_event(entry
->type
);
4397 enum print_line_t ret
= event
->funcs
->hex(iter
, 0, event
);
4398 if (ret
!= TRACE_TYPE_HANDLED
)
4402 SEQ_PUT_FIELD(s
, newline
);
4404 return trace_handle_return(s
);
4407 static enum print_line_t
print_bin_fmt(struct trace_iterator
*iter
)
4409 struct trace_array
*tr
= iter
->tr
;
4410 struct trace_seq
*s
= &iter
->seq
;
4411 struct trace_entry
*entry
;
4412 struct trace_event
*event
;
4416 if (tr
->trace_flags
& TRACE_ITER_CONTEXT_INFO
) {
4417 SEQ_PUT_FIELD(s
, entry
->pid
);
4418 SEQ_PUT_FIELD(s
, iter
->cpu
);
4419 SEQ_PUT_FIELD(s
, iter
->ts
);
4420 if (trace_seq_has_overflowed(s
))
4421 return TRACE_TYPE_PARTIAL_LINE
;
4424 event
= ftrace_find_event(entry
->type
);
4425 return event
? event
->funcs
->binary(iter
, 0, event
) :
4429 int trace_empty(struct trace_iterator
*iter
)
4431 struct ring_buffer_iter
*buf_iter
;
4434 /* If we are looking at one CPU buffer, only check that one */
4435 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
4436 cpu
= iter
->cpu_file
;
4437 buf_iter
= trace_buffer_iter(iter
, cpu
);
4439 if (!ring_buffer_iter_empty(buf_iter
))
4442 if (!ring_buffer_empty_cpu(iter
->array_buffer
->buffer
, cpu
))
4448 for_each_tracing_cpu(cpu
) {
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
))
4462 /* Called with trace_event_read_lock() held. */
4463 enum print_line_t
print_trace_line(struct trace_iterator
*iter
)
4465 struct trace_array
*tr
= iter
->tr
;
4466 unsigned long trace_flags
= tr
->trace_flags
;
4467 enum print_line_t ret
;
4469 if (iter
->lost_events
) {
4470 if (iter
->lost_events
== (unsigned long)-1)
4471 trace_seq_printf(&iter
->seq
, "CPU:%d [LOST EVENTS]\n",
4474 trace_seq_printf(&iter
->seq
, "CPU:%d [LOST %lu EVENTS]\n",
4475 iter
->cpu
, iter
->lost_events
);
4476 if (trace_seq_has_overflowed(&iter
->seq
))
4477 return TRACE_TYPE_PARTIAL_LINE
;
4480 if (iter
->trace
&& iter
->trace
->print_line
) {
4481 ret
= iter
->trace
->print_line(iter
);
4482 if (ret
!= TRACE_TYPE_UNHANDLED
)
4486 if (iter
->ent
->type
== TRACE_BPUTS
&&
4487 trace_flags
& TRACE_ITER_PRINTK
&&
4488 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4489 return trace_print_bputs_msg_only(iter
);
4491 if (iter
->ent
->type
== TRACE_BPRINT
&&
4492 trace_flags
& TRACE_ITER_PRINTK
&&
4493 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4494 return trace_print_bprintk_msg_only(iter
);
4496 if (iter
->ent
->type
== TRACE_PRINT
&&
4497 trace_flags
& TRACE_ITER_PRINTK
&&
4498 trace_flags
& TRACE_ITER_PRINTK_MSGONLY
)
4499 return trace_print_printk_msg_only(iter
);
4501 if (trace_flags
& TRACE_ITER_BIN
)
4502 return print_bin_fmt(iter
);
4504 if (trace_flags
& TRACE_ITER_HEX
)
4505 return print_hex_fmt(iter
);
4507 if (trace_flags
& TRACE_ITER_RAW
)
4508 return print_raw_fmt(iter
);
4510 return print_trace_fmt(iter
);
4513 void trace_latency_header(struct seq_file
*m
)
4515 struct trace_iterator
*iter
= m
->private;
4516 struct trace_array
*tr
= iter
->tr
;
4518 /* print nothing if the buffers are empty */
4519 if (trace_empty(iter
))
4522 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
)
4523 print_trace_header(m
, iter
);
4525 if (!(tr
->trace_flags
& TRACE_ITER_VERBOSE
))
4526 print_lat_help_header(m
);
4529 void trace_default_header(struct seq_file
*m
)
4531 struct trace_iterator
*iter
= m
->private;
4532 struct trace_array
*tr
= iter
->tr
;
4533 unsigned long trace_flags
= tr
->trace_flags
;
4535 if (!(trace_flags
& TRACE_ITER_CONTEXT_INFO
))
4538 if (iter
->iter_flags
& TRACE_FILE_LAT_FMT
) {
4539 /* print nothing if the buffers are empty */
4540 if (trace_empty(iter
))
4542 print_trace_header(m
, iter
);
4543 if (!(trace_flags
& TRACE_ITER_VERBOSE
))
4544 print_lat_help_header(m
);
4546 if (!(trace_flags
& TRACE_ITER_VERBOSE
)) {
4547 if (trace_flags
& TRACE_ITER_IRQ_INFO
)
4548 print_func_help_header_irq(iter
->array_buffer
,
4551 print_func_help_header(iter
->array_buffer
, m
,
4557 static void test_ftrace_alive(struct seq_file
*m
)
4559 if (!ftrace_is_dead())
4561 seq_puts(m
, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
4562 "# MAY BE MISSING FUNCTION EVENTS\n");
4565 #ifdef CONFIG_TRACER_MAX_TRACE
4566 static void show_snapshot_main_help(struct seq_file
*m
)
4568 seq_puts(m
, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
4569 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4570 "# Takes a snapshot of the main buffer.\n"
4571 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
4572 "# (Doesn't have to be '2' works with any number that\n"
4573 "# is not a '0' or '1')\n");
4576 static void show_snapshot_percpu_help(struct seq_file
*m
)
4578 seq_puts(m
, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
4579 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
4580 seq_puts(m
, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4581 "# Takes a snapshot of the main buffer for this cpu.\n");
4583 seq_puts(m
, "# echo 1 > snapshot : Not supported with this kernel.\n"
4584 "# Must use main snapshot file to allocate.\n");
4586 seq_puts(m
, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
4587 "# (Doesn't have to be '2' works with any number that\n"
4588 "# is not a '0' or '1')\n");
4591 static void print_snapshot_help(struct seq_file
*m
, struct trace_iterator
*iter
)
4593 if (iter
->tr
->allocated_snapshot
)
4594 seq_puts(m
, "#\n# * Snapshot is allocated *\n#\n");
4596 seq_puts(m
, "#\n# * Snapshot is freed *\n#\n");
4598 seq_puts(m
, "# Snapshot commands:\n");
4599 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
)
4600 show_snapshot_main_help(m
);
4602 show_snapshot_percpu_help(m
);
4605 /* Should never be called */
4606 static inline void print_snapshot_help(struct seq_file
*m
, struct trace_iterator
*iter
) { }
4609 static int s_show(struct seq_file
*m
, void *v
)
4611 struct trace_iterator
*iter
= v
;
4614 if (iter
->ent
== NULL
) {
4616 seq_printf(m
, "# tracer: %s\n", iter
->trace
->name
);
4618 test_ftrace_alive(m
);
4620 if (iter
->snapshot
&& trace_empty(iter
))
4621 print_snapshot_help(m
, iter
);
4622 else if (iter
->trace
&& iter
->trace
->print_header
)
4623 iter
->trace
->print_header(m
);
4625 trace_default_header(m
);
4627 } else if (iter
->leftover
) {
4629 * If we filled the seq_file buffer earlier, we
4630 * want to just show it now.
4632 ret
= trace_print_seq(m
, &iter
->seq
);
4634 /* ret should this time be zero, but you never know */
4635 iter
->leftover
= ret
;
4638 ret
= print_trace_line(iter
);
4639 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
4641 trace_seq_puts(&iter
->seq
, "[LINE TOO BIG]\n");
4643 ret
= trace_print_seq(m
, &iter
->seq
);
4645 * If we overflow the seq_file buffer, then it will
4646 * ask us for this data again at start up.
4648 * ret is 0 if seq_file write succeeded.
4651 iter
->leftover
= ret
;
4658 * Should be used after trace_array_get(), trace_types_lock
4659 * ensures that i_cdev was already initialized.
4661 static inline int tracing_get_cpu(struct inode
*inode
)
4663 if (inode
->i_cdev
) /* See trace_create_cpu_file() */
4664 return (long)inode
->i_cdev
- 1;
4665 return RING_BUFFER_ALL_CPUS
;
4668 static const struct seq_operations tracer_seq_ops
= {
4676 * Note, as iter itself can be allocated and freed in different
4677 * ways, this function is only used to free its content, and not
4678 * the iterator itself. The only requirement to all the allocations
4679 * is that it must zero all fields (kzalloc), as freeing works with
4680 * ethier allocated content or NULL.
4682 static void free_trace_iter_content(struct trace_iterator
*iter
)
4684 /* The fmt is either NULL, allocated or points to static_fmt_buf */
4685 if (iter
->fmt
!= static_fmt_buf
)
4689 kfree(iter
->buffer_iter
);
4690 mutex_destroy(&iter
->mutex
);
4691 free_cpumask_var(iter
->started
);
4694 static struct trace_iterator
*
4695 __tracing_open(struct inode
*inode
, struct file
*file
, bool snapshot
)
4697 struct trace_array
*tr
= inode
->i_private
;
4698 struct trace_iterator
*iter
;
4701 if (tracing_disabled
)
4702 return ERR_PTR(-ENODEV
);
4704 iter
= __seq_open_private(file
, &tracer_seq_ops
, sizeof(*iter
));
4706 return ERR_PTR(-ENOMEM
);
4708 iter
->buffer_iter
= kcalloc(nr_cpu_ids
, sizeof(*iter
->buffer_iter
),
4710 if (!iter
->buffer_iter
)
4714 * trace_find_next_entry() may need to save off iter->ent.
4715 * It will place it into the iter->temp buffer. As most
4716 * events are less than 128, allocate a buffer of that size.
4717 * If one is greater, then trace_find_next_entry() will
4718 * allocate a new buffer to adjust for the bigger iter->ent.
4719 * It's not critical if it fails to get allocated here.
4721 iter
->temp
= kmalloc(128, GFP_KERNEL
);
4723 iter
->temp_size
= 128;
4726 * trace_event_printf() may need to modify given format
4727 * string to replace %p with %px so that it shows real address
4728 * instead of hash value. However, that is only for the event
4729 * tracing, other tracer may not need. Defer the allocation
4730 * until it is needed.
4735 mutex_lock(&trace_types_lock
);
4736 iter
->trace
= tr
->current_trace
;
4738 if (!zalloc_cpumask_var(&iter
->started
, GFP_KERNEL
))
4743 #ifdef CONFIG_TRACER_MAX_TRACE
4744 /* Currently only the top directory has a snapshot */
4745 if (tr
->current_trace
->print_max
|| snapshot
)
4746 iter
->array_buffer
= &tr
->max_buffer
;
4749 iter
->array_buffer
= &tr
->array_buffer
;
4750 iter
->snapshot
= snapshot
;
4752 iter
->cpu_file
= tracing_get_cpu(inode
);
4753 mutex_init(&iter
->mutex
);
4755 /* Notify the tracer early; before we stop tracing. */
4756 if (iter
->trace
->open
)
4757 iter
->trace
->open(iter
);
4759 /* Annotate start of buffers if we had overruns */
4760 if (ring_buffer_overruns(iter
->array_buffer
->buffer
))
4761 iter
->iter_flags
|= TRACE_FILE_ANNOTATE
;
4763 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
4764 if (trace_clocks
[tr
->clock_id
].in_ns
)
4765 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
4768 * If pause-on-trace is enabled, then stop the trace while
4769 * dumping, unless this is the "snapshot" file
4771 if (!iter
->snapshot
&& (tr
->trace_flags
& TRACE_ITER_PAUSE_ON_TRACE
))
4772 tracing_stop_tr(tr
);
4774 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
) {
4775 for_each_tracing_cpu(cpu
) {
4776 iter
->buffer_iter
[cpu
] =
4777 ring_buffer_read_prepare(iter
->array_buffer
->buffer
,
4780 ring_buffer_read_prepare_sync();
4781 for_each_tracing_cpu(cpu
) {
4782 ring_buffer_read_start(iter
->buffer_iter
[cpu
]);
4783 tracing_iter_reset(iter
, cpu
);
4786 cpu
= iter
->cpu_file
;
4787 iter
->buffer_iter
[cpu
] =
4788 ring_buffer_read_prepare(iter
->array_buffer
->buffer
,
4790 ring_buffer_read_prepare_sync();
4791 ring_buffer_read_start(iter
->buffer_iter
[cpu
]);
4792 tracing_iter_reset(iter
, cpu
);
4795 mutex_unlock(&trace_types_lock
);
4800 mutex_unlock(&trace_types_lock
);
4801 free_trace_iter_content(iter
);
4803 seq_release_private(inode
, file
);
4804 return ERR_PTR(-ENOMEM
);
4807 int tracing_open_generic(struct inode
*inode
, struct file
*filp
)
4811 ret
= tracing_check_open_get_tr(NULL
);
4815 filp
->private_data
= inode
->i_private
;
4819 bool tracing_is_disabled(void)
4821 return (tracing_disabled
) ? true: false;
4825 * Open and update trace_array ref count.
4826 * Must have the current trace_array passed to it.
4828 int tracing_open_generic_tr(struct inode
*inode
, struct file
*filp
)
4830 struct trace_array
*tr
= inode
->i_private
;
4833 ret
= tracing_check_open_get_tr(tr
);
4837 filp
->private_data
= inode
->i_private
;
4843 * The private pointer of the inode is the trace_event_file.
4844 * Update the tr ref count associated to it.
4846 int tracing_open_file_tr(struct inode
*inode
, struct file
*filp
)
4848 struct trace_event_file
*file
= inode
->i_private
;
4851 ret
= tracing_check_open_get_tr(file
->tr
);
4855 mutex_lock(&event_mutex
);
4857 /* Fail if the file is marked for removal */
4858 if (file
->flags
& EVENT_FILE_FL_FREED
) {
4859 trace_array_put(file
->tr
);
4862 event_file_get(file
);
4865 mutex_unlock(&event_mutex
);
4869 filp
->private_data
= inode
->i_private
;
4874 int tracing_release_file_tr(struct inode
*inode
, struct file
*filp
)
4876 struct trace_event_file
*file
= inode
->i_private
;
4878 trace_array_put(file
->tr
);
4879 event_file_put(file
);
4884 int tracing_single_release_file_tr(struct inode
*inode
, struct file
*filp
)
4886 tracing_release_file_tr(inode
, filp
);
4887 return single_release(inode
, filp
);
4890 static int tracing_mark_open(struct inode
*inode
, struct file
*filp
)
4892 stream_open(inode
, filp
);
4893 return tracing_open_generic_tr(inode
, filp
);
4896 static int tracing_release(struct inode
*inode
, struct file
*file
)
4898 struct trace_array
*tr
= inode
->i_private
;
4899 struct seq_file
*m
= file
->private_data
;
4900 struct trace_iterator
*iter
;
4903 if (!(file
->f_mode
& FMODE_READ
)) {
4904 trace_array_put(tr
);
4908 /* Writes do not use seq_file */
4910 mutex_lock(&trace_types_lock
);
4912 for_each_tracing_cpu(cpu
) {
4913 if (iter
->buffer_iter
[cpu
])
4914 ring_buffer_read_finish(iter
->buffer_iter
[cpu
]);
4917 if (iter
->trace
&& iter
->trace
->close
)
4918 iter
->trace
->close(iter
);
4920 if (!iter
->snapshot
&& tr
->stop_count
)
4921 /* reenable tracing if it was previously enabled */
4922 tracing_start_tr(tr
);
4924 __trace_array_put(tr
);
4926 mutex_unlock(&trace_types_lock
);
4928 free_trace_iter_content(iter
);
4929 seq_release_private(inode
, file
);
4934 int tracing_release_generic_tr(struct inode
*inode
, struct file
*file
)
4936 struct trace_array
*tr
= inode
->i_private
;
4938 trace_array_put(tr
);
4942 static int tracing_single_release_tr(struct inode
*inode
, struct file
*file
)
4944 struct trace_array
*tr
= inode
->i_private
;
4946 trace_array_put(tr
);
4948 return single_release(inode
, file
);
4951 static int tracing_open(struct inode
*inode
, struct file
*file
)
4953 struct trace_array
*tr
= inode
->i_private
;
4954 struct trace_iterator
*iter
;
4957 ret
= tracing_check_open_get_tr(tr
);
4961 /* If this file was open for write, then erase contents */
4962 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
)) {
4963 int cpu
= tracing_get_cpu(inode
);
4964 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
4966 #ifdef CONFIG_TRACER_MAX_TRACE
4967 if (tr
->current_trace
->print_max
)
4968 trace_buf
= &tr
->max_buffer
;
4971 if (cpu
== RING_BUFFER_ALL_CPUS
)
4972 tracing_reset_online_cpus(trace_buf
);
4974 tracing_reset_cpu(trace_buf
, cpu
);
4977 if (file
->f_mode
& FMODE_READ
) {
4978 iter
= __tracing_open(inode
, file
, false);
4980 ret
= PTR_ERR(iter
);
4981 else if (tr
->trace_flags
& TRACE_ITER_LATENCY_FMT
)
4982 iter
->iter_flags
|= TRACE_FILE_LAT_FMT
;
4986 trace_array_put(tr
);
4992 * Some tracers are not suitable for instance buffers.
4993 * A tracer is always available for the global array (toplevel)
4994 * or if it explicitly states that it is.
4997 trace_ok_for_array(struct tracer
*t
, struct trace_array
*tr
)
4999 #ifdef CONFIG_TRACER_SNAPSHOT
5000 /* arrays with mapped buffer range do not have snapshots */
5001 if (tr
->range_addr_start
&& t
->use_max_tr
)
5004 return (tr
->flags
& TRACE_ARRAY_FL_GLOBAL
) || t
->allow_instances
;
5007 /* Find the next tracer that this trace array may use */
5008 static struct tracer
*
5009 get_tracer_for_array(struct trace_array
*tr
, struct tracer
*t
)
5011 while (t
&& !trace_ok_for_array(t
, tr
))
5018 t_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
5020 struct trace_array
*tr
= m
->private;
5021 struct tracer
*t
= v
;
5026 t
= get_tracer_for_array(tr
, t
->next
);
5031 static void *t_start(struct seq_file
*m
, loff_t
*pos
)
5033 struct trace_array
*tr
= m
->private;
5037 mutex_lock(&trace_types_lock
);
5039 t
= get_tracer_for_array(tr
, trace_types
);
5040 for (; t
&& l
< *pos
; t
= t_next(m
, t
, &l
))
5046 static void t_stop(struct seq_file
*m
, void *p
)
5048 mutex_unlock(&trace_types_lock
);
5051 static int t_show(struct seq_file
*m
, void *v
)
5053 struct tracer
*t
= v
;
5058 seq_puts(m
, t
->name
);
5067 static const struct seq_operations show_traces_seq_ops
= {
5074 static int show_traces_open(struct inode
*inode
, struct file
*file
)
5076 struct trace_array
*tr
= inode
->i_private
;
5080 ret
= tracing_check_open_get_tr(tr
);
5084 ret
= seq_open(file
, &show_traces_seq_ops
);
5086 trace_array_put(tr
);
5090 m
= file
->private_data
;
5096 static int tracing_seq_release(struct inode
*inode
, struct file
*file
)
5098 struct trace_array
*tr
= inode
->i_private
;
5100 trace_array_put(tr
);
5101 return seq_release(inode
, file
);
5105 tracing_write_stub(struct file
*filp
, const char __user
*ubuf
,
5106 size_t count
, loff_t
*ppos
)
5111 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
)
5115 if (file
->f_mode
& FMODE_READ
)
5116 ret
= seq_lseek(file
, offset
, whence
);
5118 file
->f_pos
= ret
= 0;
5123 static const struct file_operations tracing_fops
= {
5124 .open
= tracing_open
,
5126 .read_iter
= seq_read_iter
,
5127 .splice_read
= copy_splice_read
,
5128 .write
= tracing_write_stub
,
5129 .llseek
= tracing_lseek
,
5130 .release
= tracing_release
,
5133 static const struct file_operations show_traces_fops
= {
5134 .open
= show_traces_open
,
5136 .llseek
= seq_lseek
,
5137 .release
= tracing_seq_release
,
5141 tracing_cpumask_read(struct file
*filp
, char __user
*ubuf
,
5142 size_t count
, loff_t
*ppos
)
5144 struct trace_array
*tr
= file_inode(filp
)->i_private
;
5148 len
= snprintf(NULL
, 0, "%*pb\n",
5149 cpumask_pr_args(tr
->tracing_cpumask
)) + 1;
5150 mask_str
= kmalloc(len
, GFP_KERNEL
);
5154 len
= snprintf(mask_str
, len
, "%*pb\n",
5155 cpumask_pr_args(tr
->tracing_cpumask
));
5160 count
= simple_read_from_buffer(ubuf
, count
, ppos
, mask_str
, len
);
5168 int tracing_set_cpumask(struct trace_array
*tr
,
5169 cpumask_var_t tracing_cpumask_new
)
5176 local_irq_disable();
5177 arch_spin_lock(&tr
->max_lock
);
5178 for_each_tracing_cpu(cpu
) {
5180 * Increase/decrease the disabled counter if we are
5181 * about to flip a bit in the cpumask:
5183 if (cpumask_test_cpu(cpu
, tr
->tracing_cpumask
) &&
5184 !cpumask_test_cpu(cpu
, tracing_cpumask_new
)) {
5185 atomic_inc(&per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->disabled
);
5186 ring_buffer_record_disable_cpu(tr
->array_buffer
.buffer
, cpu
);
5187 #ifdef CONFIG_TRACER_MAX_TRACE
5188 ring_buffer_record_disable_cpu(tr
->max_buffer
.buffer
, cpu
);
5191 if (!cpumask_test_cpu(cpu
, tr
->tracing_cpumask
) &&
5192 cpumask_test_cpu(cpu
, tracing_cpumask_new
)) {
5193 atomic_dec(&per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->disabled
);
5194 ring_buffer_record_enable_cpu(tr
->array_buffer
.buffer
, cpu
);
5195 #ifdef CONFIG_TRACER_MAX_TRACE
5196 ring_buffer_record_enable_cpu(tr
->max_buffer
.buffer
, cpu
);
5200 arch_spin_unlock(&tr
->max_lock
);
5203 cpumask_copy(tr
->tracing_cpumask
, tracing_cpumask_new
);
5209 tracing_cpumask_write(struct file
*filp
, const char __user
*ubuf
,
5210 size_t count
, loff_t
*ppos
)
5212 struct trace_array
*tr
= file_inode(filp
)->i_private
;
5213 cpumask_var_t tracing_cpumask_new
;
5216 if (!zalloc_cpumask_var(&tracing_cpumask_new
, GFP_KERNEL
))
5219 err
= cpumask_parse_user(ubuf
, count
, tracing_cpumask_new
);
5223 err
= tracing_set_cpumask(tr
, tracing_cpumask_new
);
5227 free_cpumask_var(tracing_cpumask_new
);
5232 free_cpumask_var(tracing_cpumask_new
);
5237 static const struct file_operations tracing_cpumask_fops
= {
5238 .open
= tracing_open_generic_tr
,
5239 .read
= tracing_cpumask_read
,
5240 .write
= tracing_cpumask_write
,
5241 .release
= tracing_release_generic_tr
,
5242 .llseek
= generic_file_llseek
,
5245 static int tracing_trace_options_show(struct seq_file
*m
, void *v
)
5247 struct tracer_opt
*trace_opts
;
5248 struct trace_array
*tr
= m
->private;
5252 mutex_lock(&trace_types_lock
);
5253 tracer_flags
= tr
->current_trace
->flags
->val
;
5254 trace_opts
= tr
->current_trace
->flags
->opts
;
5256 for (i
= 0; trace_options
[i
]; i
++) {
5257 if (tr
->trace_flags
& (1 << i
))
5258 seq_printf(m
, "%s\n", trace_options
[i
]);
5260 seq_printf(m
, "no%s\n", trace_options
[i
]);
5263 for (i
= 0; trace_opts
[i
].name
; i
++) {
5264 if (tracer_flags
& trace_opts
[i
].bit
)
5265 seq_printf(m
, "%s\n", trace_opts
[i
].name
);
5267 seq_printf(m
, "no%s\n", trace_opts
[i
].name
);
5269 mutex_unlock(&trace_types_lock
);
5274 static int __set_tracer_option(struct trace_array
*tr
,
5275 struct tracer_flags
*tracer_flags
,
5276 struct tracer_opt
*opts
, int neg
)
5278 struct tracer
*trace
= tracer_flags
->trace
;
5281 ret
= trace
->set_flag(tr
, tracer_flags
->val
, opts
->bit
, !neg
);
5286 tracer_flags
->val
&= ~opts
->bit
;
5288 tracer_flags
->val
|= opts
->bit
;
5292 /* Try to assign a tracer specific option */
5293 static int set_tracer_option(struct trace_array
*tr
, char *cmp
, int neg
)
5295 struct tracer
*trace
= tr
->current_trace
;
5296 struct tracer_flags
*tracer_flags
= trace
->flags
;
5297 struct tracer_opt
*opts
= NULL
;
5300 for (i
= 0; tracer_flags
->opts
[i
].name
; i
++) {
5301 opts
= &tracer_flags
->opts
[i
];
5303 if (strcmp(cmp
, opts
->name
) == 0)
5304 return __set_tracer_option(tr
, trace
->flags
, opts
, neg
);
5310 /* Some tracers require overwrite to stay enabled */
5311 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
)
5313 if (tracer
->enabled
&& (mask
& TRACE_ITER_OVERWRITE
) && !set
)
5319 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
)
5321 if ((mask
== TRACE_ITER_RECORD_TGID
) ||
5322 (mask
== TRACE_ITER_RECORD_CMD
) ||
5323 (mask
== TRACE_ITER_TRACE_PRINTK
))
5324 lockdep_assert_held(&event_mutex
);
5326 /* do nothing if flag is already set */
5327 if (!!(tr
->trace_flags
& mask
) == !!enabled
)
5330 /* Give the tracer a chance to approve the change */
5331 if (tr
->current_trace
->flag_changed
)
5332 if (tr
->current_trace
->flag_changed(tr
, mask
, !!enabled
))
5335 if (mask
== TRACE_ITER_TRACE_PRINTK
) {
5337 update_printk_trace(tr
);
5340 * The global_trace cannot clear this.
5341 * It's flag only gets cleared if another instance sets it.
5343 if (printk_trace
== &global_trace
)
5346 * An instance must always have it set.
5347 * by default, that's the global_trace instane.
5349 if (printk_trace
== tr
)
5350 update_printk_trace(&global_trace
);
5355 tr
->trace_flags
|= mask
;
5357 tr
->trace_flags
&= ~mask
;
5359 if (mask
== TRACE_ITER_RECORD_CMD
)
5360 trace_event_enable_cmd_record(enabled
);
5362 if (mask
== TRACE_ITER_RECORD_TGID
) {
5364 if (trace_alloc_tgid_map() < 0) {
5365 tr
->trace_flags
&= ~TRACE_ITER_RECORD_TGID
;
5369 trace_event_enable_tgid_record(enabled
);
5372 if (mask
== TRACE_ITER_EVENT_FORK
)
5373 trace_event_follow_fork(tr
, enabled
);
5375 if (mask
== TRACE_ITER_FUNC_FORK
)
5376 ftrace_pid_follow_fork(tr
, enabled
);
5378 if (mask
== TRACE_ITER_OVERWRITE
) {
5379 ring_buffer_change_overwrite(tr
->array_buffer
.buffer
, enabled
);
5380 #ifdef CONFIG_TRACER_MAX_TRACE
5381 ring_buffer_change_overwrite(tr
->max_buffer
.buffer
, enabled
);
5385 if (mask
== TRACE_ITER_PRINTK
) {
5386 trace_printk_start_stop_comm(enabled
);
5387 trace_printk_control(enabled
);
5393 int trace_set_options(struct trace_array
*tr
, char *option
)
5398 size_t orig_len
= strlen(option
);
5401 cmp
= strstrip(option
);
5403 len
= str_has_prefix(cmp
, "no");
5409 mutex_lock(&event_mutex
);
5410 mutex_lock(&trace_types_lock
);
5412 ret
= match_string(trace_options
, -1, cmp
);
5413 /* If no option could be set, test the specific tracer options */
5415 ret
= set_tracer_option(tr
, cmp
, neg
);
5417 ret
= set_tracer_flag(tr
, 1 << ret
, !neg
);
5419 mutex_unlock(&trace_types_lock
);
5420 mutex_unlock(&event_mutex
);
5423 * If the first trailing whitespace is replaced with '\0' by strstrip,
5424 * turn it back into a space.
5426 if (orig_len
> strlen(option
))
5427 option
[strlen(option
)] = ' ';
5432 static void __init
apply_trace_boot_options(void)
5434 char *buf
= trace_boot_options_buf
;
5438 option
= strsep(&buf
, ",");
5444 trace_set_options(&global_trace
, option
);
5446 /* Put back the comma to allow this to be called again */
5453 tracing_trace_options_write(struct file
*filp
, const char __user
*ubuf
,
5454 size_t cnt
, loff_t
*ppos
)
5456 struct seq_file
*m
= filp
->private_data
;
5457 struct trace_array
*tr
= m
->private;
5461 if (cnt
>= sizeof(buf
))
5464 if (copy_from_user(buf
, ubuf
, cnt
))
5469 ret
= trace_set_options(tr
, buf
);
5478 static int tracing_trace_options_open(struct inode
*inode
, struct file
*file
)
5480 struct trace_array
*tr
= inode
->i_private
;
5483 ret
= tracing_check_open_get_tr(tr
);
5487 ret
= single_open(file
, tracing_trace_options_show
, inode
->i_private
);
5489 trace_array_put(tr
);
5494 static const struct file_operations tracing_iter_fops
= {
5495 .open
= tracing_trace_options_open
,
5497 .llseek
= seq_lseek
,
5498 .release
= tracing_single_release_tr
,
5499 .write
= tracing_trace_options_write
,
5502 static const char readme_msg
[] =
5503 "tracing mini-HOWTO:\n\n"
5504 "By default tracefs removes all OTH file permission bits.\n"
5505 "When mounting tracefs an optional group id can be specified\n"
5506 "which adds the group to every directory and file in tracefs:\n\n"
5507 "\t e.g. mount -t tracefs [-o [gid=<gid>]] nodev /sys/kernel/tracing\n\n"
5508 "# echo 0 > tracing_on : quick way to disable tracing\n"
5509 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
5510 " Important files:\n"
5511 " trace\t\t\t- The static contents of the buffer\n"
5512 "\t\t\t To clear the buffer write into this file: echo > trace\n"
5513 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
5514 " current_tracer\t- function and latency tracers\n"
5515 " available_tracers\t- list of configured tracers for current_tracer\n"
5516 " error_log\t- error log for failed commands (that support it)\n"
5517 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
5518 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
5519 " trace_clock\t\t- change the clock used to order events\n"
5520 " local: Per cpu clock but may not be synced across CPUs\n"
5521 " global: Synced across CPUs but slows tracing down.\n"
5522 " counter: Not a clock, but just an increment\n"
5523 " uptime: Jiffy counter from time of boot\n"
5524 " perf: Same clock that perf events use\n"
5525 #ifdef CONFIG_X86_64
5526 " x86-tsc: TSC cycle counter\n"
5528 "\n timestamp_mode\t- view the mode used to timestamp events\n"
5529 " delta: Delta difference against a buffer-wide timestamp\n"
5530 " absolute: Absolute (standalone) timestamp\n"
5531 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
5532 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
5533 " tracing_cpumask\t- Limit which CPUs to trace\n"
5534 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
5535 "\t\t\t Remove sub-buffer with rmdir\n"
5536 " trace_options\t\t- Set format or modify how tracing happens\n"
5537 "\t\t\t Disable an option by prefixing 'no' to the\n"
5538 "\t\t\t option name\n"
5539 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
5540 #ifdef CONFIG_DYNAMIC_FTRACE
5541 "\n available_filter_functions - list of functions that can be filtered on\n"
5542 " set_ftrace_filter\t- echo function name in here to only trace these\n"
5543 "\t\t\t functions\n"
5544 "\t accepts: func_full_name or glob-matching-pattern\n"
5545 "\t modules: Can select a group via module\n"
5546 "\t Format: :mod:<module-name>\n"
5547 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
5548 "\t triggers: a command to perform when function is hit\n"
5549 "\t Format: <function>:<trigger>[:count]\n"
5550 "\t trigger: traceon, traceoff\n"
5551 "\t\t enable_event:<system>:<event>\n"
5552 "\t\t disable_event:<system>:<event>\n"
5553 #ifdef CONFIG_STACKTRACE
5556 #ifdef CONFIG_TRACER_SNAPSHOT
5561 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
5562 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
5563 "\t The first one will disable tracing every time do_fault is hit\n"
5564 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
5565 "\t The first time do trap is hit and it disables tracing, the\n"
5566 "\t counter will decrement to 2. If tracing is already disabled,\n"
5567 "\t the counter will not decrement. It only decrements when the\n"
5568 "\t trigger did work\n"
5569 "\t To remove trigger without count:\n"
5570 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
5571 "\t To remove trigger with a count:\n"
5572 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
5573 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
5574 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
5575 "\t modules: Can select a group via module command :mod:\n"
5576 "\t Does not accept triggers\n"
5577 #endif /* CONFIG_DYNAMIC_FTRACE */
5578 #ifdef CONFIG_FUNCTION_TRACER
5579 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
5581 " set_ftrace_notrace_pid\t- Write pid(s) to not function trace those pids\n"
5584 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
5585 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
5586 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
5587 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
5589 #ifdef CONFIG_TRACER_SNAPSHOT
5590 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
5591 "\t\t\t snapshot buffer. Read the contents for more\n"
5592 "\t\t\t information\n"
5594 #ifdef CONFIG_STACK_TRACER
5595 " stack_trace\t\t- Shows the max stack trace when active\n"
5596 " stack_max_size\t- Shows current max stack size that was traced\n"
5597 "\t\t\t Write into this file to reset the max size (trigger a\n"
5598 "\t\t\t new trace)\n"
5599 #ifdef CONFIG_DYNAMIC_FTRACE
5600 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
5603 #endif /* CONFIG_STACK_TRACER */
5604 #ifdef CONFIG_DYNAMIC_EVENTS
5605 " dynamic_events\t\t- Create/append/remove/show the generic dynamic events\n"
5606 "\t\t\t Write into this file to define/undefine new trace events.\n"
5608 #ifdef CONFIG_KPROBE_EVENTS
5609 " kprobe_events\t\t- Create/append/remove/show the kernel dynamic events\n"
5610 "\t\t\t Write into this file to define/undefine new trace events.\n"
5612 #ifdef CONFIG_UPROBE_EVENTS
5613 " uprobe_events\t\t- Create/append/remove/show the userspace dynamic events\n"
5614 "\t\t\t Write into this file to define/undefine new trace events.\n"
5616 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS) || \
5617 defined(CONFIG_FPROBE_EVENTS)
5618 "\t accepts: event-definitions (one definition per line)\n"
5619 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
5620 "\t Format: p[:[<group>/][<event>]] <place> [<args>]\n"
5621 "\t r[maxactive][:[<group>/][<event>]] <place> [<args>]\n"
5623 #ifdef CONFIG_FPROBE_EVENTS
5624 "\t f[:[<group>/][<event>]] <func-name>[%return] [<args>]\n"
5625 "\t t[:[<group>/][<event>]] <tracepoint> [<args>]\n"
5627 #ifdef CONFIG_HIST_TRIGGERS
5628 "\t s:[synthetic/]<event> <field> [<field>]\n"
5630 "\t e[:[<group>/][<event>]] <attached-group>.<attached-event> [<args>] [if <filter>]\n"
5631 "\t -:[<group>/][<event>]\n"
5632 #ifdef CONFIG_KPROBE_EVENTS
5633 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
5634 "place (kretprobe): [<module>:]<symbol>[+<offset>]%return|<memaddr>\n"
5636 #ifdef CONFIG_UPROBE_EVENTS
5637 " place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"
5639 "\t args: <name>=fetcharg[:type]\n"
5640 "\t fetcharg: (%<register>|$<efield>), @<address>, @<symbol>[+|-<offset>],\n"
5641 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
5642 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5643 #ifdef CONFIG_PROBE_EVENTS_BTF_ARGS
5644 "\t <argname>[->field[->field|.field...]],\n"
5647 "\t $stack<index>, $stack, $retval, $comm,\n"
5649 "\t +|-[u]<offset>(<fetcharg>), \\imm-value, \\\"imm-string\"\n"
5650 "\t kernel return probes support: $retval, $arg<N>, $comm\n"
5651 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, char, string, symbol,\n"
5652 "\t b<bit-width>@<bit-offset>/<container-size>, ustring,\n"
5653 "\t symstr, %pd/%pD, <type>\\[<array-size>\\]\n"
5654 #ifdef CONFIG_HIST_TRIGGERS
5655 "\t field: <stype> <name>;\n"
5656 "\t stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"
5657 "\t [unsigned] char/int/long\n"
5659 "\t efield: For event probes ('e' types), the field is on of the fields\n"
5660 "\t of the <attached-group>/<attached-event>.\n"
5662 " events/\t\t- Directory containing all trace event subsystems:\n"
5663 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
5664 " events/<system>/\t- Directory containing all trace events for <system>:\n"
5665 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
5667 " filter\t\t- If set, only events passing filter are traced\n"
5668 " events/<system>/<event>/\t- Directory containing control files for\n"
5670 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
5671 " filter\t\t- If set, only events passing filter are traced\n"
5672 " trigger\t\t- If set, a command to perform when event is hit\n"
5673 "\t Format: <trigger>[:count][if <filter>]\n"
5674 "\t trigger: traceon, traceoff\n"
5675 "\t enable_event:<system>:<event>\n"
5676 "\t disable_event:<system>:<event>\n"
5677 #ifdef CONFIG_HIST_TRIGGERS
5678 "\t enable_hist:<system>:<event>\n"
5679 "\t disable_hist:<system>:<event>\n"
5681 #ifdef CONFIG_STACKTRACE
5684 #ifdef CONFIG_TRACER_SNAPSHOT
5687 #ifdef CONFIG_HIST_TRIGGERS
5688 "\t\t hist (see below)\n"
5690 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
5691 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
5692 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
5693 "\t events/block/block_unplug/trigger\n"
5694 "\t The first disables tracing every time block_unplug is hit.\n"
5695 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
5696 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
5697 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
5698 "\t Like function triggers, the counter is only decremented if it\n"
5699 "\t enabled or disabled tracing.\n"
5700 "\t To remove a trigger without a count:\n"
5701 "\t echo '!<trigger> > <system>/<event>/trigger\n"
5702 "\t To remove a trigger with a count:\n"
5703 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
5704 "\t Filters can be ignored when removing a trigger.\n"
5705 #ifdef CONFIG_HIST_TRIGGERS
5706 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
5707 "\t Format: hist:keys=<field1[,field2,...]>\n"
5708 "\t [:<var1>=<field|var_ref|numeric_literal>[,<var2>=...]]\n"
5709 "\t [:values=<field1[,field2,...]>]\n"
5710 "\t [:sort=<field1[,field2,...]>]\n"
5711 "\t [:size=#entries]\n"
5712 "\t [:pause][:continue][:clear]\n"
5713 "\t [:name=histname1]\n"
5714 "\t [:nohitcount]\n"
5715 "\t [:<handler>.<action>]\n"
5716 "\t [if <filter>]\n\n"
5717 "\t Note, special fields can be used as well:\n"
5718 "\t common_timestamp - to record current timestamp\n"
5719 "\t common_cpu - to record the CPU the event happened on\n"
5721 "\t A hist trigger variable can be:\n"
5722 "\t - a reference to a field e.g. x=current_timestamp,\n"
5723 "\t - a reference to another variable e.g. y=$x,\n"
5724 "\t - a numeric literal: e.g. ms_per_sec=1000,\n"
5725 "\t - an arithmetic expression: e.g. time_secs=current_timestamp/1000\n"
5727 "\t hist trigger arithmetic expressions support addition(+), subtraction(-),\n"
5728 "\t multiplication(*) and division(/) operators. An operand can be either a\n"
5729 "\t variable reference, field or numeric literal.\n"
5731 "\t When a matching event is hit, an entry is added to a hash\n"
5732 "\t table using the key(s) and value(s) named, and the value of a\n"
5733 "\t sum called 'hitcount' is incremented. Keys and values\n"
5734 "\t correspond to fields in the event's format description. Keys\n"
5735 "\t can be any field, or the special string 'common_stacktrace'.\n"
5736 "\t Compound keys consisting of up to two fields can be specified\n"
5737 "\t by the 'keys' keyword. Values must correspond to numeric\n"
5738 "\t fields. Sort keys consisting of up to two fields can be\n"
5739 "\t specified using the 'sort' keyword. The sort direction can\n"
5740 "\t be modified by appending '.descending' or '.ascending' to a\n"
5741 "\t sort field. The 'size' parameter can be used to specify more\n"
5742 "\t or fewer than the default 2048 entries for the hashtable size.\n"
5743 "\t If a hist trigger is given a name using the 'name' parameter,\n"
5744 "\t its histogram data will be shared with other triggers of the\n"
5745 "\t same name, and trigger hits will update this common data.\n\n"
5746 "\t Reading the 'hist' file for the event will dump the hash\n"
5747 "\t table in its entirety to stdout. If there are multiple hist\n"
5748 "\t triggers attached to an event, there will be a table for each\n"
5749 "\t trigger in the output. The table displayed for a named\n"
5750 "\t trigger will be the same as any other instance having the\n"
5751 "\t same name. The default format used to display a given field\n"
5752 "\t can be modified by appending any of the following modifiers\n"
5753 "\t to the field name, as applicable:\n\n"
5754 "\t .hex display a number as a hex value\n"
5755 "\t .sym display an address as a symbol\n"
5756 "\t .sym-offset display an address as a symbol and offset\n"
5757 "\t .execname display a common_pid as a program name\n"
5758 "\t .syscall display a syscall id as a syscall name\n"
5759 "\t .log2 display log2 value rather than raw number\n"
5760 "\t .buckets=size display values in groups of size rather than raw number\n"
5761 "\t .usecs display a common_timestamp in microseconds\n"
5762 "\t .percent display a number of percentage value\n"
5763 "\t .graph display a bar-graph of a value\n\n"
5764 "\t The 'pause' parameter can be used to pause an existing hist\n"
5765 "\t trigger or to start a hist trigger but not log any events\n"
5766 "\t until told to do so. 'continue' can be used to start or\n"
5767 "\t restart a paused hist trigger.\n\n"
5768 "\t The 'clear' parameter will clear the contents of a running\n"
5769 "\t hist trigger and leave its current paused/active state\n"
5771 "\t The 'nohitcount' (or NOHC) parameter will suppress display of\n"
5772 "\t raw hitcount in the histogram.\n\n"
5773 "\t The enable_hist and disable_hist triggers can be used to\n"
5774 "\t have one event conditionally start and stop another event's\n"
5775 "\t already-attached hist trigger. The syntax is analogous to\n"
5776 "\t the enable_event and disable_event triggers.\n\n"
5777 "\t Hist trigger handlers and actions are executed whenever a\n"
5778 "\t a histogram entry is added or updated. They take the form:\n\n"
5779 "\t <handler>.<action>\n\n"
5780 "\t The available handlers are:\n\n"
5781 "\t onmatch(matching.event) - invoke on addition or update\n"
5782 "\t onmax(var) - invoke if var exceeds current max\n"
5783 "\t onchange(var) - invoke action if var changes\n\n"
5784 "\t The available actions are:\n\n"
5785 "\t trace(<synthetic_event>,param list) - generate synthetic event\n"
5786 "\t save(field,...) - save current event fields\n"
5787 #ifdef CONFIG_TRACER_SNAPSHOT
5788 "\t snapshot() - snapshot the trace buffer\n\n"
5790 #ifdef CONFIG_SYNTH_EVENTS
5791 " events/synthetic_events\t- Create/append/remove/show synthetic events\n"
5792 "\t Write into this file to define/undefine new synthetic events.\n"
5793 "\t example: echo 'myevent u64 lat; char name[]; long[] stack' >> synthetic_events\n"
5799 tracing_readme_read(struct file
*filp
, char __user
*ubuf
,
5800 size_t cnt
, loff_t
*ppos
)
5802 return simple_read_from_buffer(ubuf
, cnt
, ppos
,
5803 readme_msg
, strlen(readme_msg
));
5806 static const struct file_operations tracing_readme_fops
= {
5807 .open
= tracing_open_generic
,
5808 .read
= tracing_readme_read
,
5809 .llseek
= generic_file_llseek
,
5812 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
5813 static union trace_eval_map_item
*
5814 update_eval_map(union trace_eval_map_item
*ptr
)
5816 if (!ptr
->map
.eval_string
) {
5817 if (ptr
->tail
.next
) {
5818 ptr
= ptr
->tail
.next
;
5819 /* Set ptr to the next real item (skip head) */
5827 static void *eval_map_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
5829 union trace_eval_map_item
*ptr
= v
;
5832 * Paranoid! If ptr points to end, we don't want to increment past it.
5833 * This really should never happen.
5836 ptr
= update_eval_map(ptr
);
5837 if (WARN_ON_ONCE(!ptr
))
5841 ptr
= update_eval_map(ptr
);
5846 static void *eval_map_start(struct seq_file
*m
, loff_t
*pos
)
5848 union trace_eval_map_item
*v
;
5851 mutex_lock(&trace_eval_mutex
);
5853 v
= trace_eval_maps
;
5857 while (v
&& l
< *pos
) {
5858 v
= eval_map_next(m
, v
, &l
);
5864 static void eval_map_stop(struct seq_file
*m
, void *v
)
5866 mutex_unlock(&trace_eval_mutex
);
5869 static int eval_map_show(struct seq_file
*m
, void *v
)
5871 union trace_eval_map_item
*ptr
= v
;
5873 seq_printf(m
, "%s %ld (%s)\n",
5874 ptr
->map
.eval_string
, ptr
->map
.eval_value
,
5880 static const struct seq_operations tracing_eval_map_seq_ops
= {
5881 .start
= eval_map_start
,
5882 .next
= eval_map_next
,
5883 .stop
= eval_map_stop
,
5884 .show
= eval_map_show
,
5887 static int tracing_eval_map_open(struct inode
*inode
, struct file
*filp
)
5891 ret
= tracing_check_open_get_tr(NULL
);
5895 return seq_open(filp
, &tracing_eval_map_seq_ops
);
5898 static const struct file_operations tracing_eval_map_fops
= {
5899 .open
= tracing_eval_map_open
,
5901 .llseek
= seq_lseek
,
5902 .release
= seq_release
,
5905 static inline union trace_eval_map_item
*
5906 trace_eval_jmp_to_tail(union trace_eval_map_item
*ptr
)
5908 /* Return tail of array given the head */
5909 return ptr
+ ptr
->head
.length
+ 1;
5913 trace_insert_eval_map_file(struct module
*mod
, struct trace_eval_map
**start
,
5916 struct trace_eval_map
**stop
;
5917 struct trace_eval_map
**map
;
5918 union trace_eval_map_item
*map_array
;
5919 union trace_eval_map_item
*ptr
;
5924 * The trace_eval_maps contains the map plus a head and tail item,
5925 * where the head holds the module and length of array, and the
5926 * tail holds a pointer to the next list.
5928 map_array
= kmalloc_array(len
+ 2, sizeof(*map_array
), GFP_KERNEL
);
5930 pr_warn("Unable to allocate trace eval mapping\n");
5934 mutex_lock(&trace_eval_mutex
);
5936 if (!trace_eval_maps
)
5937 trace_eval_maps
= map_array
;
5939 ptr
= trace_eval_maps
;
5941 ptr
= trace_eval_jmp_to_tail(ptr
);
5942 if (!ptr
->tail
.next
)
5944 ptr
= ptr
->tail
.next
;
5947 ptr
->tail
.next
= map_array
;
5949 map_array
->head
.mod
= mod
;
5950 map_array
->head
.length
= len
;
5953 for (map
= start
; (unsigned long)map
< (unsigned long)stop
; map
++) {
5954 map_array
->map
= **map
;
5957 memset(map_array
, 0, sizeof(*map_array
));
5959 mutex_unlock(&trace_eval_mutex
);
5962 static void trace_create_eval_file(struct dentry
*d_tracer
)
5964 trace_create_file("eval_map", TRACE_MODE_READ
, d_tracer
,
5965 NULL
, &tracing_eval_map_fops
);
5968 #else /* CONFIG_TRACE_EVAL_MAP_FILE */
5969 static inline void trace_create_eval_file(struct dentry
*d_tracer
) { }
5970 static inline void trace_insert_eval_map_file(struct module
*mod
,
5971 struct trace_eval_map
**start
, int len
) { }
5972 #endif /* !CONFIG_TRACE_EVAL_MAP_FILE */
5974 static void trace_insert_eval_map(struct module
*mod
,
5975 struct trace_eval_map
**start
, int len
)
5977 struct trace_eval_map
**map
;
5984 trace_event_eval_update(map
, len
);
5986 trace_insert_eval_map_file(mod
, start
, len
);
5990 tracing_set_trace_read(struct file
*filp
, char __user
*ubuf
,
5991 size_t cnt
, loff_t
*ppos
)
5993 struct trace_array
*tr
= filp
->private_data
;
5994 char buf
[MAX_TRACER_SIZE
+2];
5997 mutex_lock(&trace_types_lock
);
5998 r
= sprintf(buf
, "%s\n", tr
->current_trace
->name
);
5999 mutex_unlock(&trace_types_lock
);
6001 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6004 int tracer_init(struct tracer
*t
, struct trace_array
*tr
)
6006 tracing_reset_online_cpus(&tr
->array_buffer
);
6010 static void set_buffer_entries(struct array_buffer
*buf
, unsigned long val
)
6014 for_each_tracing_cpu(cpu
)
6015 per_cpu_ptr(buf
->data
, cpu
)->entries
= val
;
6018 static void update_buffer_entries(struct array_buffer
*buf
, int cpu
)
6020 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6021 set_buffer_entries(buf
, ring_buffer_size(buf
->buffer
, 0));
6023 per_cpu_ptr(buf
->data
, cpu
)->entries
= ring_buffer_size(buf
->buffer
, cpu
);
6027 #ifdef CONFIG_TRACER_MAX_TRACE
6028 /* resize @tr's buffer to the size of @size_tr's entries */
6029 static int resize_buffer_duplicate_size(struct array_buffer
*trace_buf
,
6030 struct array_buffer
*size_buf
, int cpu_id
)
6034 if (cpu_id
== RING_BUFFER_ALL_CPUS
) {
6035 for_each_tracing_cpu(cpu
) {
6036 ret
= ring_buffer_resize(trace_buf
->buffer
,
6037 per_cpu_ptr(size_buf
->data
, cpu
)->entries
, cpu
);
6040 per_cpu_ptr(trace_buf
->data
, cpu
)->entries
=
6041 per_cpu_ptr(size_buf
->data
, cpu
)->entries
;
6044 ret
= ring_buffer_resize(trace_buf
->buffer
,
6045 per_cpu_ptr(size_buf
->data
, cpu_id
)->entries
, cpu_id
);
6047 per_cpu_ptr(trace_buf
->data
, cpu_id
)->entries
=
6048 per_cpu_ptr(size_buf
->data
, cpu_id
)->entries
;
6053 #endif /* CONFIG_TRACER_MAX_TRACE */
6055 static int __tracing_resize_ring_buffer(struct trace_array
*tr
,
6056 unsigned long size
, int cpu
)
6061 * If kernel or user changes the size of the ring buffer
6062 * we use the size that was given, and we can forget about
6063 * expanding it later.
6065 trace_set_ring_buffer_expanded(tr
);
6067 /* May be called before buffers are initialized */
6068 if (!tr
->array_buffer
.buffer
)
6071 /* Do not allow tracing while resizing ring buffer */
6072 tracing_stop_tr(tr
);
6074 ret
= ring_buffer_resize(tr
->array_buffer
.buffer
, size
, cpu
);
6078 #ifdef CONFIG_TRACER_MAX_TRACE
6079 if (!tr
->allocated_snapshot
)
6082 ret
= ring_buffer_resize(tr
->max_buffer
.buffer
, size
, cpu
);
6084 int r
= resize_buffer_duplicate_size(&tr
->array_buffer
,
6085 &tr
->array_buffer
, cpu
);
6088 * AARGH! We are left with different
6089 * size max buffer!!!!
6090 * The max buffer is our "snapshot" buffer.
6091 * When a tracer needs a snapshot (one of the
6092 * latency tracers), it swaps the max buffer
6093 * with the saved snap shot. We succeeded to
6094 * update the size of the main buffer, but failed to
6095 * update the size of the max buffer. But when we tried
6096 * to reset the main buffer to the original size, we
6097 * failed there too. This is very unlikely to
6098 * happen, but if it does, warn and kill all
6102 tracing_disabled
= 1;
6107 update_buffer_entries(&tr
->max_buffer
, cpu
);
6110 #endif /* CONFIG_TRACER_MAX_TRACE */
6112 update_buffer_entries(&tr
->array_buffer
, cpu
);
6114 tracing_start_tr(tr
);
6118 ssize_t
tracing_resize_ring_buffer(struct trace_array
*tr
,
6119 unsigned long size
, int cpu_id
)
6123 mutex_lock(&trace_types_lock
);
6125 if (cpu_id
!= RING_BUFFER_ALL_CPUS
) {
6126 /* make sure, this cpu is enabled in the mask */
6127 if (!cpumask_test_cpu(cpu_id
, tracing_buffer_mask
)) {
6133 ret
= __tracing_resize_ring_buffer(tr
, size
, cpu_id
);
6138 mutex_unlock(&trace_types_lock
);
6143 static void update_last_data(struct trace_array
*tr
)
6145 if (!tr
->text_delta
&& !tr
->data_delta
)
6148 /* Clear old data */
6149 tracing_reset_online_cpus(&tr
->array_buffer
);
6151 /* Using current data now */
6157 * tracing_update_buffers - used by tracing facility to expand ring buffers
6158 * @tr: The tracing instance
6160 * To save on memory when the tracing is never used on a system with it
6161 * configured in. The ring buffers are set to a minimum size. But once
6162 * a user starts to use the tracing facility, then they need to grow
6163 * to their default size.
6165 * This function is to be called when a tracer is about to be used.
6167 int tracing_update_buffers(struct trace_array
*tr
)
6171 mutex_lock(&trace_types_lock
);
6173 update_last_data(tr
);
6175 if (!tr
->ring_buffer_expanded
)
6176 ret
= __tracing_resize_ring_buffer(tr
, trace_buf_size
,
6177 RING_BUFFER_ALL_CPUS
);
6178 mutex_unlock(&trace_types_lock
);
6183 struct trace_option_dentry
;
6186 create_trace_option_files(struct trace_array
*tr
, struct tracer
*tracer
);
6189 * Used to clear out the tracer before deletion of an instance.
6190 * Must have trace_types_lock held.
6192 static void tracing_set_nop(struct trace_array
*tr
)
6194 if (tr
->current_trace
== &nop_trace
)
6197 tr
->current_trace
->enabled
--;
6199 if (tr
->current_trace
->reset
)
6200 tr
->current_trace
->reset(tr
);
6202 tr
->current_trace
= &nop_trace
;
6205 static bool tracer_options_updated
;
6207 static void add_tracer_options(struct trace_array
*tr
, struct tracer
*t
)
6209 /* Only enable if the directory has been created already. */
6213 /* Only create trace option files after update_tracer_options finish */
6214 if (!tracer_options_updated
)
6217 create_trace_option_files(tr
, t
);
6220 int tracing_set_tracer(struct trace_array
*tr
, const char *buf
)
6223 #ifdef CONFIG_TRACER_MAX_TRACE
6228 mutex_lock(&trace_types_lock
);
6230 update_last_data(tr
);
6232 if (!tr
->ring_buffer_expanded
) {
6233 ret
= __tracing_resize_ring_buffer(tr
, trace_buf_size
,
6234 RING_BUFFER_ALL_CPUS
);
6240 for (t
= trace_types
; t
; t
= t
->next
) {
6241 if (strcmp(t
->name
, buf
) == 0)
6248 if (t
== tr
->current_trace
)
6251 #ifdef CONFIG_TRACER_SNAPSHOT
6252 if (t
->use_max_tr
) {
6253 local_irq_disable();
6254 arch_spin_lock(&tr
->max_lock
);
6255 if (tr
->cond_snapshot
)
6257 arch_spin_unlock(&tr
->max_lock
);
6263 /* Some tracers won't work on kernel command line */
6264 if (system_state
< SYSTEM_RUNNING
&& t
->noboot
) {
6265 pr_warn("Tracer '%s' is not allowed on command line, ignored\n",
6270 /* Some tracers are only allowed for the top level buffer */
6271 if (!trace_ok_for_array(t
, tr
)) {
6276 /* If trace pipe files are being read, we can't change the tracer */
6277 if (tr
->trace_ref
) {
6282 trace_branch_disable();
6284 tr
->current_trace
->enabled
--;
6286 if (tr
->current_trace
->reset
)
6287 tr
->current_trace
->reset(tr
);
6289 #ifdef CONFIG_TRACER_MAX_TRACE
6290 had_max_tr
= tr
->current_trace
->use_max_tr
;
6292 /* Current trace needs to be nop_trace before synchronize_rcu */
6293 tr
->current_trace
= &nop_trace
;
6295 if (had_max_tr
&& !t
->use_max_tr
) {
6297 * We need to make sure that the update_max_tr sees that
6298 * current_trace changed to nop_trace to keep it from
6299 * swapping the buffers after we resize it.
6300 * The update_max_tr is called from interrupts disabled
6301 * so a synchronized_sched() is sufficient.
6305 tracing_disarm_snapshot(tr
);
6308 if (!had_max_tr
&& t
->use_max_tr
) {
6309 ret
= tracing_arm_snapshot_locked(tr
);
6314 tr
->current_trace
= &nop_trace
;
6318 ret
= tracer_init(t
, tr
);
6320 #ifdef CONFIG_TRACER_MAX_TRACE
6322 tracing_disarm_snapshot(tr
);
6328 tr
->current_trace
= t
;
6329 tr
->current_trace
->enabled
++;
6330 trace_branch_enable(tr
);
6332 mutex_unlock(&trace_types_lock
);
6338 tracing_set_trace_write(struct file
*filp
, const char __user
*ubuf
,
6339 size_t cnt
, loff_t
*ppos
)
6341 struct trace_array
*tr
= filp
->private_data
;
6342 char buf
[MAX_TRACER_SIZE
+1];
6349 if (cnt
> MAX_TRACER_SIZE
)
6350 cnt
= MAX_TRACER_SIZE
;
6352 if (copy_from_user(buf
, ubuf
, cnt
))
6359 err
= tracing_set_tracer(tr
, name
);
6369 tracing_nsecs_read(unsigned long *ptr
, char __user
*ubuf
,
6370 size_t cnt
, loff_t
*ppos
)
6375 r
= snprintf(buf
, sizeof(buf
), "%ld\n",
6376 *ptr
== (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr
));
6377 if (r
> sizeof(buf
))
6379 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6383 tracing_nsecs_write(unsigned long *ptr
, const char __user
*ubuf
,
6384 size_t cnt
, loff_t
*ppos
)
6389 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
6399 tracing_thresh_read(struct file
*filp
, char __user
*ubuf
,
6400 size_t cnt
, loff_t
*ppos
)
6402 return tracing_nsecs_read(&tracing_thresh
, ubuf
, cnt
, ppos
);
6406 tracing_thresh_write(struct file
*filp
, const char __user
*ubuf
,
6407 size_t cnt
, loff_t
*ppos
)
6409 struct trace_array
*tr
= filp
->private_data
;
6412 mutex_lock(&trace_types_lock
);
6413 ret
= tracing_nsecs_write(&tracing_thresh
, ubuf
, cnt
, ppos
);
6417 if (tr
->current_trace
->update_thresh
) {
6418 ret
= tr
->current_trace
->update_thresh(tr
);
6425 mutex_unlock(&trace_types_lock
);
6430 #ifdef CONFIG_TRACER_MAX_TRACE
6433 tracing_max_lat_read(struct file
*filp
, char __user
*ubuf
,
6434 size_t cnt
, loff_t
*ppos
)
6436 struct trace_array
*tr
= filp
->private_data
;
6438 return tracing_nsecs_read(&tr
->max_latency
, ubuf
, cnt
, ppos
);
6442 tracing_max_lat_write(struct file
*filp
, const char __user
*ubuf
,
6443 size_t cnt
, loff_t
*ppos
)
6445 struct trace_array
*tr
= filp
->private_data
;
6447 return tracing_nsecs_write(&tr
->max_latency
, ubuf
, cnt
, ppos
);
6452 static int open_pipe_on_cpu(struct trace_array
*tr
, int cpu
)
6454 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6455 if (cpumask_empty(tr
->pipe_cpumask
)) {
6456 cpumask_setall(tr
->pipe_cpumask
);
6459 } else if (!cpumask_test_cpu(cpu
, tr
->pipe_cpumask
)) {
6460 cpumask_set_cpu(cpu
, tr
->pipe_cpumask
);
6466 static void close_pipe_on_cpu(struct trace_array
*tr
, int cpu
)
6468 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6469 WARN_ON(!cpumask_full(tr
->pipe_cpumask
));
6470 cpumask_clear(tr
->pipe_cpumask
);
6472 WARN_ON(!cpumask_test_cpu(cpu
, tr
->pipe_cpumask
));
6473 cpumask_clear_cpu(cpu
, tr
->pipe_cpumask
);
6477 static int tracing_open_pipe(struct inode
*inode
, struct file
*filp
)
6479 struct trace_array
*tr
= inode
->i_private
;
6480 struct trace_iterator
*iter
;
6484 ret
= tracing_check_open_get_tr(tr
);
6488 mutex_lock(&trace_types_lock
);
6489 cpu
= tracing_get_cpu(inode
);
6490 ret
= open_pipe_on_cpu(tr
, cpu
);
6492 goto fail_pipe_on_cpu
;
6494 /* create a buffer to store the information to pass to userspace */
6495 iter
= kzalloc(sizeof(*iter
), GFP_KERNEL
);
6498 goto fail_alloc_iter
;
6501 trace_seq_init(&iter
->seq
);
6502 iter
->trace
= tr
->current_trace
;
6504 if (!alloc_cpumask_var(&iter
->started
, GFP_KERNEL
)) {
6509 /* trace pipe does not show start of buffer */
6510 cpumask_setall(iter
->started
);
6512 if (tr
->trace_flags
& TRACE_ITER_LATENCY_FMT
)
6513 iter
->iter_flags
|= TRACE_FILE_LAT_FMT
;
6515 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
6516 if (trace_clocks
[tr
->clock_id
].in_ns
)
6517 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
6520 iter
->array_buffer
= &tr
->array_buffer
;
6521 iter
->cpu_file
= cpu
;
6522 mutex_init(&iter
->mutex
);
6523 filp
->private_data
= iter
;
6525 if (iter
->trace
->pipe_open
)
6526 iter
->trace
->pipe_open(iter
);
6528 nonseekable_open(inode
, filp
);
6532 mutex_unlock(&trace_types_lock
);
6538 close_pipe_on_cpu(tr
, cpu
);
6540 __trace_array_put(tr
);
6541 mutex_unlock(&trace_types_lock
);
6545 static int tracing_release_pipe(struct inode
*inode
, struct file
*file
)
6547 struct trace_iterator
*iter
= file
->private_data
;
6548 struct trace_array
*tr
= inode
->i_private
;
6550 mutex_lock(&trace_types_lock
);
6554 if (iter
->trace
->pipe_close
)
6555 iter
->trace
->pipe_close(iter
);
6556 close_pipe_on_cpu(tr
, iter
->cpu_file
);
6557 mutex_unlock(&trace_types_lock
);
6559 free_trace_iter_content(iter
);
6562 trace_array_put(tr
);
6568 trace_poll(struct trace_iterator
*iter
, struct file
*filp
, poll_table
*poll_table
)
6570 struct trace_array
*tr
= iter
->tr
;
6572 /* Iterators are static, they should be filled or empty */
6573 if (trace_buffer_iter(iter
, iter
->cpu_file
))
6574 return EPOLLIN
| EPOLLRDNORM
;
6576 if (tr
->trace_flags
& TRACE_ITER_BLOCK
)
6578 * Always select as readable when in blocking mode
6580 return EPOLLIN
| EPOLLRDNORM
;
6582 return ring_buffer_poll_wait(iter
->array_buffer
->buffer
, iter
->cpu_file
,
6583 filp
, poll_table
, iter
->tr
->buffer_percent
);
6587 tracing_poll_pipe(struct file
*filp
, poll_table
*poll_table
)
6589 struct trace_iterator
*iter
= filp
->private_data
;
6591 return trace_poll(iter
, filp
, poll_table
);
6594 /* Must be called with iter->mutex held. */
6595 static int tracing_wait_pipe(struct file
*filp
)
6597 struct trace_iterator
*iter
= filp
->private_data
;
6600 while (trace_empty(iter
)) {
6602 if ((filp
->f_flags
& O_NONBLOCK
)) {
6607 * We block until we read something and tracing is disabled.
6608 * We still block if tracing is disabled, but we have never
6609 * read anything. This allows a user to cat this file, and
6610 * then enable tracing. But after we have read something,
6611 * we give an EOF when tracing is again disabled.
6613 * iter->pos will be 0 if we haven't read anything.
6615 if (!tracer_tracing_is_on(iter
->tr
) && iter
->pos
)
6618 mutex_unlock(&iter
->mutex
);
6620 ret
= wait_on_pipe(iter
, 0);
6622 mutex_lock(&iter
->mutex
);
6635 tracing_read_pipe(struct file
*filp
, char __user
*ubuf
,
6636 size_t cnt
, loff_t
*ppos
)
6638 struct trace_iterator
*iter
= filp
->private_data
;
6642 * Avoid more than one consumer on a single file descriptor
6643 * This is just a matter of traces coherency, the ring buffer itself
6646 mutex_lock(&iter
->mutex
);
6648 /* return any leftover data */
6649 sret
= trace_seq_to_user(&iter
->seq
, ubuf
, cnt
);
6653 trace_seq_init(&iter
->seq
);
6655 if (iter
->trace
->read
) {
6656 sret
= iter
->trace
->read(iter
, filp
, ubuf
, cnt
, ppos
);
6662 sret
= tracing_wait_pipe(filp
);
6666 /* stop when tracing is finished */
6667 if (trace_empty(iter
)) {
6672 if (cnt
>= TRACE_SEQ_BUFFER_SIZE
)
6673 cnt
= TRACE_SEQ_BUFFER_SIZE
- 1;
6675 /* reset all but tr, trace, and overruns */
6676 trace_iterator_reset(iter
);
6677 cpumask_clear(iter
->started
);
6678 trace_seq_init(&iter
->seq
);
6680 trace_event_read_lock();
6681 trace_access_lock(iter
->cpu_file
);
6682 while (trace_find_next_entry_inc(iter
) != NULL
) {
6683 enum print_line_t ret
;
6684 int save_len
= iter
->seq
.seq
.len
;
6686 ret
= print_trace_line(iter
);
6687 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
6689 * If one print_trace_line() fills entire trace_seq in one shot,
6690 * trace_seq_to_user() will returns -EBUSY because save_len == 0,
6691 * In this case, we need to consume it, otherwise, loop will peek
6692 * this event next time, resulting in an infinite loop.
6694 if (save_len
== 0) {
6696 trace_seq_puts(&iter
->seq
, "[LINE TOO BIG]\n");
6697 trace_consume(iter
);
6701 /* In other cases, don't print partial lines */
6702 iter
->seq
.seq
.len
= save_len
;
6705 if (ret
!= TRACE_TYPE_NO_CONSUME
)
6706 trace_consume(iter
);
6708 if (trace_seq_used(&iter
->seq
) >= cnt
)
6712 * Setting the full flag means we reached the trace_seq buffer
6713 * size and we should leave by partial output condition above.
6714 * One of the trace_seq_* functions is not used properly.
6716 WARN_ONCE(iter
->seq
.full
, "full flag set for trace type %d",
6719 trace_access_unlock(iter
->cpu_file
);
6720 trace_event_read_unlock();
6722 /* Now copy what we have to the user */
6723 sret
= trace_seq_to_user(&iter
->seq
, ubuf
, cnt
);
6724 if (iter
->seq
.readpos
>= trace_seq_used(&iter
->seq
))
6725 trace_seq_init(&iter
->seq
);
6728 * If there was nothing to send to user, in spite of consuming trace
6729 * entries, go back to wait for more entries.
6735 mutex_unlock(&iter
->mutex
);
6740 static void tracing_spd_release_pipe(struct splice_pipe_desc
*spd
,
6743 __free_page(spd
->pages
[idx
]);
6747 tracing_fill_pipe_page(size_t rem
, struct trace_iterator
*iter
)
6753 /* Seq buffer is page-sized, exactly what we need. */
6755 save_len
= iter
->seq
.seq
.len
;
6756 ret
= print_trace_line(iter
);
6758 if (trace_seq_has_overflowed(&iter
->seq
)) {
6759 iter
->seq
.seq
.len
= save_len
;
6764 * This should not be hit, because it should only
6765 * be set if the iter->seq overflowed. But check it
6766 * anyway to be safe.
6768 if (ret
== TRACE_TYPE_PARTIAL_LINE
) {
6769 iter
->seq
.seq
.len
= save_len
;
6773 count
= trace_seq_used(&iter
->seq
) - save_len
;
6776 iter
->seq
.seq
.len
= save_len
;
6780 if (ret
!= TRACE_TYPE_NO_CONSUME
)
6781 trace_consume(iter
);
6783 if (!trace_find_next_entry_inc(iter
)) {
6793 static ssize_t
tracing_splice_read_pipe(struct file
*filp
,
6795 struct pipe_inode_info
*pipe
,
6799 struct page
*pages_def
[PIPE_DEF_BUFFERS
];
6800 struct partial_page partial_def
[PIPE_DEF_BUFFERS
];
6801 struct trace_iterator
*iter
= filp
->private_data
;
6802 struct splice_pipe_desc spd
= {
6804 .partial
= partial_def
,
6805 .nr_pages
= 0, /* This gets updated below. */
6806 .nr_pages_max
= PIPE_DEF_BUFFERS
,
6807 .ops
= &default_pipe_buf_ops
,
6808 .spd_release
= tracing_spd_release_pipe
,
6814 if (splice_grow_spd(pipe
, &spd
))
6817 mutex_lock(&iter
->mutex
);
6819 if (iter
->trace
->splice_read
) {
6820 ret
= iter
->trace
->splice_read(iter
, filp
,
6821 ppos
, pipe
, len
, flags
);
6826 ret
= tracing_wait_pipe(filp
);
6830 if (!iter
->ent
&& !trace_find_next_entry_inc(iter
)) {
6835 trace_event_read_lock();
6836 trace_access_lock(iter
->cpu_file
);
6838 /* Fill as many pages as possible. */
6839 for (i
= 0, rem
= len
; i
< spd
.nr_pages_max
&& rem
; i
++) {
6840 spd
.pages
[i
] = alloc_page(GFP_KERNEL
);
6844 rem
= tracing_fill_pipe_page(rem
, iter
);
6846 /* Copy the data into the page, so we can start over. */
6847 ret
= trace_seq_to_buffer(&iter
->seq
,
6848 page_address(spd
.pages
[i
]),
6849 trace_seq_used(&iter
->seq
));
6851 __free_page(spd
.pages
[i
]);
6854 spd
.partial
[i
].offset
= 0;
6855 spd
.partial
[i
].len
= trace_seq_used(&iter
->seq
);
6857 trace_seq_init(&iter
->seq
);
6860 trace_access_unlock(iter
->cpu_file
);
6861 trace_event_read_unlock();
6862 mutex_unlock(&iter
->mutex
);
6867 ret
= splice_to_pipe(pipe
, &spd
);
6871 splice_shrink_spd(&spd
);
6875 mutex_unlock(&iter
->mutex
);
6880 tracing_entries_read(struct file
*filp
, char __user
*ubuf
,
6881 size_t cnt
, loff_t
*ppos
)
6883 struct inode
*inode
= file_inode(filp
);
6884 struct trace_array
*tr
= inode
->i_private
;
6885 int cpu
= tracing_get_cpu(inode
);
6890 mutex_lock(&trace_types_lock
);
6892 if (cpu
== RING_BUFFER_ALL_CPUS
) {
6893 int cpu
, buf_size_same
;
6898 /* check if all cpu sizes are same */
6899 for_each_tracing_cpu(cpu
) {
6900 /* fill in the size from first enabled cpu */
6902 size
= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
;
6903 if (size
!= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
) {
6909 if (buf_size_same
) {
6910 if (!tr
->ring_buffer_expanded
)
6911 r
= sprintf(buf
, "%lu (expanded: %lu)\n",
6913 trace_buf_size
>> 10);
6915 r
= sprintf(buf
, "%lu\n", size
>> 10);
6917 r
= sprintf(buf
, "X\n");
6919 r
= sprintf(buf
, "%lu\n", per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
>> 10);
6921 mutex_unlock(&trace_types_lock
);
6923 ret
= simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6928 tracing_entries_write(struct file
*filp
, const char __user
*ubuf
,
6929 size_t cnt
, loff_t
*ppos
)
6931 struct inode
*inode
= file_inode(filp
);
6932 struct trace_array
*tr
= inode
->i_private
;
6936 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
6940 /* must have at least 1 entry */
6944 /* value is in KB */
6946 ret
= tracing_resize_ring_buffer(tr
, val
, tracing_get_cpu(inode
));
6956 tracing_total_entries_read(struct file
*filp
, char __user
*ubuf
,
6957 size_t cnt
, loff_t
*ppos
)
6959 struct trace_array
*tr
= filp
->private_data
;
6962 unsigned long size
= 0, expanded_size
= 0;
6964 mutex_lock(&trace_types_lock
);
6965 for_each_tracing_cpu(cpu
) {
6966 size
+= per_cpu_ptr(tr
->array_buffer
.data
, cpu
)->entries
>> 10;
6967 if (!tr
->ring_buffer_expanded
)
6968 expanded_size
+= trace_buf_size
>> 10;
6970 if (tr
->ring_buffer_expanded
)
6971 r
= sprintf(buf
, "%lu\n", size
);
6973 r
= sprintf(buf
, "%lu (expanded: %lu)\n", size
, expanded_size
);
6974 mutex_unlock(&trace_types_lock
);
6976 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
6980 tracing_last_boot_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
6982 struct trace_array
*tr
= filp
->private_data
;
6986 seq_buf_init(&seq
, buf
, 64);
6988 seq_buf_printf(&seq
, "text delta:\t%ld\n", tr
->text_delta
);
6989 seq_buf_printf(&seq
, "data delta:\t%ld\n", tr
->data_delta
);
6991 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, seq_buf_used(&seq
));
6994 static int tracing_buffer_meta_open(struct inode
*inode
, struct file
*filp
)
6996 struct trace_array
*tr
= inode
->i_private
;
6997 int cpu
= tracing_get_cpu(inode
);
7000 ret
= tracing_check_open_get_tr(tr
);
7004 ret
= ring_buffer_meta_seq_init(filp
, tr
->array_buffer
.buffer
, cpu
);
7006 __trace_array_put(tr
);
7011 tracing_free_buffer_write(struct file
*filp
, const char __user
*ubuf
,
7012 size_t cnt
, loff_t
*ppos
)
7015 * There is no need to read what the user has written, this function
7016 * is just to make sure that there is no error when "echo" is used
7025 tracing_free_buffer_release(struct inode
*inode
, struct file
*filp
)
7027 struct trace_array
*tr
= inode
->i_private
;
7029 /* disable tracing ? */
7030 if (tr
->trace_flags
& TRACE_ITER_STOP_ON_FREE
)
7031 tracer_tracing_off(tr
);
7032 /* resize the ring buffer to 0 */
7033 tracing_resize_ring_buffer(tr
, 0, RING_BUFFER_ALL_CPUS
);
7035 trace_array_put(tr
);
7040 #define TRACE_MARKER_MAX_SIZE 4096
7043 tracing_mark_write(struct file
*filp
, const char __user
*ubuf
,
7044 size_t cnt
, loff_t
*fpos
)
7046 struct trace_array
*tr
= filp
->private_data
;
7047 struct ring_buffer_event
*event
;
7048 enum event_trigger_type tt
= ETT_NONE
;
7049 struct trace_buffer
*buffer
;
7050 struct print_entry
*entry
;
7056 /* Used in tracing_mark_raw_write() as well */
7057 #define FAULTED_STR "<faulted>"
7058 #define FAULTED_SIZE (sizeof(FAULTED_STR) - 1) /* '\0' is already accounted for */
7060 if (tracing_disabled
)
7063 if (!(tr
->trace_flags
& TRACE_ITER_MARKERS
))
7066 if ((ssize_t
)cnt
< 0)
7069 if (cnt
> TRACE_MARKER_MAX_SIZE
)
7070 cnt
= TRACE_MARKER_MAX_SIZE
;
7072 meta_size
= sizeof(*entry
) + 2; /* add '\0' and possible '\n' */
7074 size
= cnt
+ meta_size
;
7076 /* If less than "<faulted>", then make sure we can still add that */
7077 if (cnt
< FAULTED_SIZE
)
7078 size
+= FAULTED_SIZE
- cnt
;
7080 buffer
= tr
->array_buffer
.buffer
;
7081 event
= __trace_buffer_lock_reserve(buffer
, TRACE_PRINT
, size
,
7083 if (unlikely(!event
)) {
7085 * If the size was greater than what was allowed, then
7086 * make it smaller and try again.
7088 if (size
> ring_buffer_max_event_size(buffer
)) {
7089 /* cnt < FAULTED size should never be bigger than max */
7090 if (WARN_ON_ONCE(cnt
< FAULTED_SIZE
))
7092 cnt
= ring_buffer_max_event_size(buffer
) - meta_size
;
7093 /* The above should only happen once */
7094 if (WARN_ON_ONCE(cnt
+ meta_size
== size
))
7099 /* Ring buffer disabled, return as if not open for write */
7103 entry
= ring_buffer_event_data(event
);
7104 entry
->ip
= _THIS_IP_
;
7106 len
= __copy_from_user_inatomic(&entry
->buf
, ubuf
, cnt
);
7108 memcpy(&entry
->buf
, FAULTED_STR
, FAULTED_SIZE
);
7114 if (tr
->trace_marker_file
&& !list_empty(&tr
->trace_marker_file
->triggers
)) {
7115 /* do not add \n before testing triggers, but add \0 */
7116 entry
->buf
[cnt
] = '\0';
7117 tt
= event_triggers_call(tr
->trace_marker_file
, buffer
, entry
, event
);
7120 if (entry
->buf
[cnt
- 1] != '\n') {
7121 entry
->buf
[cnt
] = '\n';
7122 entry
->buf
[cnt
+ 1] = '\0';
7124 entry
->buf
[cnt
] = '\0';
7126 if (static_branch_unlikely(&trace_marker_exports_enabled
))
7127 ftrace_exports(event
, TRACE_EXPORT_MARKER
);
7128 __buffer_unlock_commit(buffer
, event
);
7131 event_triggers_post_call(tr
->trace_marker_file
, tt
);
7137 tracing_mark_raw_write(struct file
*filp
, const char __user
*ubuf
,
7138 size_t cnt
, loff_t
*fpos
)
7140 struct trace_array
*tr
= filp
->private_data
;
7141 struct ring_buffer_event
*event
;
7142 struct trace_buffer
*buffer
;
7143 struct raw_data_entry
*entry
;
7148 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
7150 if (tracing_disabled
)
7153 if (!(tr
->trace_flags
& TRACE_ITER_MARKERS
))
7156 /* The marker must at least have a tag id */
7157 if (cnt
< sizeof(unsigned int))
7160 size
= sizeof(*entry
) + cnt
;
7161 if (cnt
< FAULT_SIZE_ID
)
7162 size
+= FAULT_SIZE_ID
- cnt
;
7164 buffer
= tr
->array_buffer
.buffer
;
7166 if (size
> ring_buffer_max_event_size(buffer
))
7169 event
= __trace_buffer_lock_reserve(buffer
, TRACE_RAW_DATA
, size
,
7172 /* Ring buffer disabled, return as if not open for write */
7175 entry
= ring_buffer_event_data(event
);
7177 len
= __copy_from_user_inatomic(&entry
->id
, ubuf
, cnt
);
7180 memcpy(&entry
->buf
, FAULTED_STR
, FAULTED_SIZE
);
7185 __buffer_unlock_commit(buffer
, event
);
7190 static int tracing_clock_show(struct seq_file
*m
, void *v
)
7192 struct trace_array
*tr
= m
->private;
7195 for (i
= 0; i
< ARRAY_SIZE(trace_clocks
); i
++)
7197 "%s%s%s%s", i
? " " : "",
7198 i
== tr
->clock_id
? "[" : "", trace_clocks
[i
].name
,
7199 i
== tr
->clock_id
? "]" : "");
7205 int tracing_set_clock(struct trace_array
*tr
, const char *clockstr
)
7209 for (i
= 0; i
< ARRAY_SIZE(trace_clocks
); i
++) {
7210 if (strcmp(trace_clocks
[i
].name
, clockstr
) == 0)
7213 if (i
== ARRAY_SIZE(trace_clocks
))
7216 mutex_lock(&trace_types_lock
);
7220 ring_buffer_set_clock(tr
->array_buffer
.buffer
, trace_clocks
[i
].func
);
7223 * New clock may not be consistent with the previous clock.
7224 * Reset the buffer so that it doesn't have incomparable timestamps.
7226 tracing_reset_online_cpus(&tr
->array_buffer
);
7228 #ifdef CONFIG_TRACER_MAX_TRACE
7229 if (tr
->max_buffer
.buffer
)
7230 ring_buffer_set_clock(tr
->max_buffer
.buffer
, trace_clocks
[i
].func
);
7231 tracing_reset_online_cpus(&tr
->max_buffer
);
7234 mutex_unlock(&trace_types_lock
);
7239 static ssize_t
tracing_clock_write(struct file
*filp
, const char __user
*ubuf
,
7240 size_t cnt
, loff_t
*fpos
)
7242 struct seq_file
*m
= filp
->private_data
;
7243 struct trace_array
*tr
= m
->private;
7245 const char *clockstr
;
7248 if (cnt
>= sizeof(buf
))
7251 if (copy_from_user(buf
, ubuf
, cnt
))
7256 clockstr
= strstrip(buf
);
7258 ret
= tracing_set_clock(tr
, clockstr
);
7267 static int tracing_clock_open(struct inode
*inode
, struct file
*file
)
7269 struct trace_array
*tr
= inode
->i_private
;
7272 ret
= tracing_check_open_get_tr(tr
);
7276 ret
= single_open(file
, tracing_clock_show
, inode
->i_private
);
7278 trace_array_put(tr
);
7283 static int tracing_time_stamp_mode_show(struct seq_file
*m
, void *v
)
7285 struct trace_array
*tr
= m
->private;
7287 mutex_lock(&trace_types_lock
);
7289 if (ring_buffer_time_stamp_abs(tr
->array_buffer
.buffer
))
7290 seq_puts(m
, "delta [absolute]\n");
7292 seq_puts(m
, "[delta] absolute\n");
7294 mutex_unlock(&trace_types_lock
);
7299 static int tracing_time_stamp_mode_open(struct inode
*inode
, struct file
*file
)
7301 struct trace_array
*tr
= inode
->i_private
;
7304 ret
= tracing_check_open_get_tr(tr
);
7308 ret
= single_open(file
, tracing_time_stamp_mode_show
, inode
->i_private
);
7310 trace_array_put(tr
);
7315 u64
tracing_event_time_stamp(struct trace_buffer
*buffer
, struct ring_buffer_event
*rbe
)
7317 if (rbe
== this_cpu_read(trace_buffered_event
))
7318 return ring_buffer_time_stamp(buffer
);
7320 return ring_buffer_event_time_stamp(buffer
, rbe
);
7324 * Set or disable using the per CPU trace_buffer_event when possible.
7326 int tracing_set_filter_buffering(struct trace_array
*tr
, bool set
)
7330 mutex_lock(&trace_types_lock
);
7332 if (set
&& tr
->no_filter_buffering_ref
++)
7336 if (WARN_ON_ONCE(!tr
->no_filter_buffering_ref
)) {
7341 --tr
->no_filter_buffering_ref
;
7344 mutex_unlock(&trace_types_lock
);
7349 struct ftrace_buffer_info
{
7350 struct trace_iterator iter
;
7352 unsigned int spare_cpu
;
7353 unsigned int spare_size
;
7357 #ifdef CONFIG_TRACER_SNAPSHOT
7358 static int tracing_snapshot_open(struct inode
*inode
, struct file
*file
)
7360 struct trace_array
*tr
= inode
->i_private
;
7361 struct trace_iterator
*iter
;
7365 ret
= tracing_check_open_get_tr(tr
);
7369 if (file
->f_mode
& FMODE_READ
) {
7370 iter
= __tracing_open(inode
, file
, true);
7372 ret
= PTR_ERR(iter
);
7374 /* Writes still need the seq_file to hold the private data */
7376 m
= kzalloc(sizeof(*m
), GFP_KERNEL
);
7379 iter
= kzalloc(sizeof(*iter
), GFP_KERNEL
);
7387 iter
->array_buffer
= &tr
->max_buffer
;
7388 iter
->cpu_file
= tracing_get_cpu(inode
);
7390 file
->private_data
= m
;
7394 trace_array_put(tr
);
7399 static void tracing_swap_cpu_buffer(void *tr
)
7401 update_max_tr_single((struct trace_array
*)tr
, current
, smp_processor_id());
7405 tracing_snapshot_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
7408 struct seq_file
*m
= filp
->private_data
;
7409 struct trace_iterator
*iter
= m
->private;
7410 struct trace_array
*tr
= iter
->tr
;
7414 ret
= tracing_update_buffers(tr
);
7418 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
7422 mutex_lock(&trace_types_lock
);
7424 if (tr
->current_trace
->use_max_tr
) {
7429 local_irq_disable();
7430 arch_spin_lock(&tr
->max_lock
);
7431 if (tr
->cond_snapshot
)
7433 arch_spin_unlock(&tr
->max_lock
);
7440 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
7444 if (tr
->allocated_snapshot
)
7448 /* Only allow per-cpu swap if the ring buffer supports it */
7449 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
7450 if (iter
->cpu_file
!= RING_BUFFER_ALL_CPUS
) {
7455 if (tr
->allocated_snapshot
)
7456 ret
= resize_buffer_duplicate_size(&tr
->max_buffer
,
7457 &tr
->array_buffer
, iter
->cpu_file
);
7459 ret
= tracing_arm_snapshot_locked(tr
);
7463 /* Now, we're going to swap */
7464 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
) {
7465 local_irq_disable();
7466 update_max_tr(tr
, current
, smp_processor_id(), NULL
);
7469 smp_call_function_single(iter
->cpu_file
, tracing_swap_cpu_buffer
,
7472 tracing_disarm_snapshot(tr
);
7475 if (tr
->allocated_snapshot
) {
7476 if (iter
->cpu_file
== RING_BUFFER_ALL_CPUS
)
7477 tracing_reset_online_cpus(&tr
->max_buffer
);
7479 tracing_reset_cpu(&tr
->max_buffer
, iter
->cpu_file
);
7489 mutex_unlock(&trace_types_lock
);
7493 static int tracing_snapshot_release(struct inode
*inode
, struct file
*file
)
7495 struct seq_file
*m
= file
->private_data
;
7498 ret
= tracing_release(inode
, file
);
7500 if (file
->f_mode
& FMODE_READ
)
7503 /* If write only, the seq_file is just a stub */
7511 static int tracing_buffers_open(struct inode
*inode
, struct file
*filp
);
7512 static ssize_t
tracing_buffers_read(struct file
*filp
, char __user
*ubuf
,
7513 size_t count
, loff_t
*ppos
);
7514 static int tracing_buffers_release(struct inode
*inode
, struct file
*file
);
7515 static ssize_t
tracing_buffers_splice_read(struct file
*file
, loff_t
*ppos
,
7516 struct pipe_inode_info
*pipe
, size_t len
, unsigned int flags
);
7518 static int snapshot_raw_open(struct inode
*inode
, struct file
*filp
)
7520 struct ftrace_buffer_info
*info
;
7523 /* The following checks for tracefs lockdown */
7524 ret
= tracing_buffers_open(inode
, filp
);
7528 info
= filp
->private_data
;
7530 if (info
->iter
.trace
->use_max_tr
) {
7531 tracing_buffers_release(inode
, filp
);
7535 info
->iter
.snapshot
= true;
7536 info
->iter
.array_buffer
= &info
->iter
.tr
->max_buffer
;
7541 #endif /* CONFIG_TRACER_SNAPSHOT */
7544 static const struct file_operations tracing_thresh_fops
= {
7545 .open
= tracing_open_generic
,
7546 .read
= tracing_thresh_read
,
7547 .write
= tracing_thresh_write
,
7548 .llseek
= generic_file_llseek
,
7551 #ifdef CONFIG_TRACER_MAX_TRACE
7552 static const struct file_operations tracing_max_lat_fops
= {
7553 .open
= tracing_open_generic_tr
,
7554 .read
= tracing_max_lat_read
,
7555 .write
= tracing_max_lat_write
,
7556 .llseek
= generic_file_llseek
,
7557 .release
= tracing_release_generic_tr
,
7561 static const struct file_operations set_tracer_fops
= {
7562 .open
= tracing_open_generic_tr
,
7563 .read
= tracing_set_trace_read
,
7564 .write
= tracing_set_trace_write
,
7565 .llseek
= generic_file_llseek
,
7566 .release
= tracing_release_generic_tr
,
7569 static const struct file_operations tracing_pipe_fops
= {
7570 .open
= tracing_open_pipe
,
7571 .poll
= tracing_poll_pipe
,
7572 .read
= tracing_read_pipe
,
7573 .splice_read
= tracing_splice_read_pipe
,
7574 .release
= tracing_release_pipe
,
7577 static const struct file_operations tracing_entries_fops
= {
7578 .open
= tracing_open_generic_tr
,
7579 .read
= tracing_entries_read
,
7580 .write
= tracing_entries_write
,
7581 .llseek
= generic_file_llseek
,
7582 .release
= tracing_release_generic_tr
,
7585 static const struct file_operations tracing_buffer_meta_fops
= {
7586 .open
= tracing_buffer_meta_open
,
7588 .llseek
= seq_lseek
,
7589 .release
= tracing_seq_release
,
7592 static const struct file_operations tracing_total_entries_fops
= {
7593 .open
= tracing_open_generic_tr
,
7594 .read
= tracing_total_entries_read
,
7595 .llseek
= generic_file_llseek
,
7596 .release
= tracing_release_generic_tr
,
7599 static const struct file_operations tracing_free_buffer_fops
= {
7600 .open
= tracing_open_generic_tr
,
7601 .write
= tracing_free_buffer_write
,
7602 .release
= tracing_free_buffer_release
,
7605 static const struct file_operations tracing_mark_fops
= {
7606 .open
= tracing_mark_open
,
7607 .write
= tracing_mark_write
,
7608 .release
= tracing_release_generic_tr
,
7611 static const struct file_operations tracing_mark_raw_fops
= {
7612 .open
= tracing_mark_open
,
7613 .write
= tracing_mark_raw_write
,
7614 .release
= tracing_release_generic_tr
,
7617 static const struct file_operations trace_clock_fops
= {
7618 .open
= tracing_clock_open
,
7620 .llseek
= seq_lseek
,
7621 .release
= tracing_single_release_tr
,
7622 .write
= tracing_clock_write
,
7625 static const struct file_operations trace_time_stamp_mode_fops
= {
7626 .open
= tracing_time_stamp_mode_open
,
7628 .llseek
= seq_lseek
,
7629 .release
= tracing_single_release_tr
,
7632 static const struct file_operations last_boot_fops
= {
7633 .open
= tracing_open_generic_tr
,
7634 .read
= tracing_last_boot_read
,
7635 .llseek
= generic_file_llseek
,
7636 .release
= tracing_release_generic_tr
,
7639 #ifdef CONFIG_TRACER_SNAPSHOT
7640 static const struct file_operations snapshot_fops
= {
7641 .open
= tracing_snapshot_open
,
7643 .write
= tracing_snapshot_write
,
7644 .llseek
= tracing_lseek
,
7645 .release
= tracing_snapshot_release
,
7648 static const struct file_operations snapshot_raw_fops
= {
7649 .open
= snapshot_raw_open
,
7650 .read
= tracing_buffers_read
,
7651 .release
= tracing_buffers_release
,
7652 .splice_read
= tracing_buffers_splice_read
,
7655 #endif /* CONFIG_TRACER_SNAPSHOT */
7658 * trace_min_max_write - Write a u64 value to a trace_min_max_param struct
7659 * @filp: The active open file structure
7660 * @ubuf: The userspace provided buffer to read value into
7661 * @cnt: The maximum number of bytes to read
7662 * @ppos: The current "file" position
7664 * This function implements the write interface for a struct trace_min_max_param.
7665 * The filp->private_data must point to a trace_min_max_param structure that
7666 * defines where to write the value, the min and the max acceptable values,
7667 * and a lock to protect the write.
7670 trace_min_max_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
7672 struct trace_min_max_param
*param
= filp
->private_data
;
7679 err
= kstrtoull_from_user(ubuf
, cnt
, 10, &val
);
7684 mutex_lock(param
->lock
);
7686 if (param
->min
&& val
< *param
->min
)
7689 if (param
->max
&& val
> *param
->max
)
7696 mutex_unlock(param
->lock
);
7705 * trace_min_max_read - Read a u64 value from a trace_min_max_param struct
7706 * @filp: The active open file structure
7707 * @ubuf: The userspace provided buffer to read value into
7708 * @cnt: The maximum number of bytes to read
7709 * @ppos: The current "file" position
7711 * This function implements the read interface for a struct trace_min_max_param.
7712 * The filp->private_data must point to a trace_min_max_param struct with valid
7716 trace_min_max_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
7718 struct trace_min_max_param
*param
= filp
->private_data
;
7719 char buf
[U64_STR_SIZE
];
7728 if (cnt
> sizeof(buf
))
7731 len
= snprintf(buf
, sizeof(buf
), "%llu\n", val
);
7733 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, len
);
7736 const struct file_operations trace_min_max_fops
= {
7737 .open
= tracing_open_generic
,
7738 .read
= trace_min_max_read
,
7739 .write
= trace_min_max_write
,
7742 #define TRACING_LOG_ERRS_MAX 8
7743 #define TRACING_LOG_LOC_MAX 128
7745 #define CMD_PREFIX " Command: "
7748 const char **errs
; /* ptr to loc-specific array of err strings */
7749 u8 type
; /* index into errs -> specific err string */
7750 u16 pos
; /* caret position */
7754 struct tracing_log_err
{
7755 struct list_head list
;
7756 struct err_info info
;
7757 char loc
[TRACING_LOG_LOC_MAX
]; /* err location */
7758 char *cmd
; /* what caused err */
7761 static DEFINE_MUTEX(tracing_err_log_lock
);
7763 static struct tracing_log_err
*alloc_tracing_log_err(int len
)
7765 struct tracing_log_err
*err
;
7767 err
= kzalloc(sizeof(*err
), GFP_KERNEL
);
7769 return ERR_PTR(-ENOMEM
);
7771 err
->cmd
= kzalloc(len
, GFP_KERNEL
);
7774 return ERR_PTR(-ENOMEM
);
7780 static void free_tracing_log_err(struct tracing_log_err
*err
)
7786 static struct tracing_log_err
*get_tracing_log_err(struct trace_array
*tr
,
7789 struct tracing_log_err
*err
;
7792 if (tr
->n_err_log_entries
< TRACING_LOG_ERRS_MAX
) {
7793 err
= alloc_tracing_log_err(len
);
7794 if (PTR_ERR(err
) != -ENOMEM
)
7795 tr
->n_err_log_entries
++;
7799 cmd
= kzalloc(len
, GFP_KERNEL
);
7801 return ERR_PTR(-ENOMEM
);
7802 err
= list_first_entry(&tr
->err_log
, struct tracing_log_err
, list
);
7805 list_del(&err
->list
);
7811 * err_pos - find the position of a string within a command for error careting
7812 * @cmd: The tracing command that caused the error
7813 * @str: The string to position the caret at within @cmd
7815 * Finds the position of the first occurrence of @str within @cmd. The
7816 * return value can be passed to tracing_log_err() for caret placement
7819 * Returns the index within @cmd of the first occurrence of @str or 0
7820 * if @str was not found.
7822 unsigned int err_pos(char *cmd
, const char *str
)
7826 if (WARN_ON(!strlen(cmd
)))
7829 found
= strstr(cmd
, str
);
7837 * tracing_log_err - write an error to the tracing error log
7838 * @tr: The associated trace array for the error (NULL for top level array)
7839 * @loc: A string describing where the error occurred
7840 * @cmd: The tracing command that caused the error
7841 * @errs: The array of loc-specific static error strings
7842 * @type: The index into errs[], which produces the specific static err string
7843 * @pos: The position the caret should be placed in the cmd
7845 * Writes an error into tracing/error_log of the form:
7847 * <loc>: error: <text>
7851 * tracing/error_log is a small log file containing the last
7852 * TRACING_LOG_ERRS_MAX errors (8). Memory for errors isn't allocated
7853 * unless there has been a tracing error, and the error log can be
7854 * cleared and have its memory freed by writing the empty string in
7855 * truncation mode to it i.e. echo > tracing/error_log.
7857 * NOTE: the @errs array along with the @type param are used to
7858 * produce a static error string - this string is not copied and saved
7859 * when the error is logged - only a pointer to it is saved. See
7860 * existing callers for examples of how static strings are typically
7861 * defined for use with tracing_log_err().
7863 void tracing_log_err(struct trace_array
*tr
,
7864 const char *loc
, const char *cmd
,
7865 const char **errs
, u8 type
, u16 pos
)
7867 struct tracing_log_err
*err
;
7873 len
+= sizeof(CMD_PREFIX
) + 2 * sizeof("\n") + strlen(cmd
) + 1;
7875 mutex_lock(&tracing_err_log_lock
);
7876 err
= get_tracing_log_err(tr
, len
);
7877 if (PTR_ERR(err
) == -ENOMEM
) {
7878 mutex_unlock(&tracing_err_log_lock
);
7882 snprintf(err
->loc
, TRACING_LOG_LOC_MAX
, "%s: error: ", loc
);
7883 snprintf(err
->cmd
, len
, "\n" CMD_PREFIX
"%s\n", cmd
);
7885 err
->info
.errs
= errs
;
7886 err
->info
.type
= type
;
7887 err
->info
.pos
= pos
;
7888 err
->info
.ts
= local_clock();
7890 list_add_tail(&err
->list
, &tr
->err_log
);
7891 mutex_unlock(&tracing_err_log_lock
);
7894 static void clear_tracing_err_log(struct trace_array
*tr
)
7896 struct tracing_log_err
*err
, *next
;
7898 mutex_lock(&tracing_err_log_lock
);
7899 list_for_each_entry_safe(err
, next
, &tr
->err_log
, list
) {
7900 list_del(&err
->list
);
7901 free_tracing_log_err(err
);
7904 tr
->n_err_log_entries
= 0;
7905 mutex_unlock(&tracing_err_log_lock
);
7908 static void *tracing_err_log_seq_start(struct seq_file
*m
, loff_t
*pos
)
7910 struct trace_array
*tr
= m
->private;
7912 mutex_lock(&tracing_err_log_lock
);
7914 return seq_list_start(&tr
->err_log
, *pos
);
7917 static void *tracing_err_log_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
7919 struct trace_array
*tr
= m
->private;
7921 return seq_list_next(v
, &tr
->err_log
, pos
);
7924 static void tracing_err_log_seq_stop(struct seq_file
*m
, void *v
)
7926 mutex_unlock(&tracing_err_log_lock
);
7929 static void tracing_err_log_show_pos(struct seq_file
*m
, u16 pos
)
7933 for (i
= 0; i
< sizeof(CMD_PREFIX
) - 1; i
++)
7935 for (i
= 0; i
< pos
; i
++)
7940 static int tracing_err_log_seq_show(struct seq_file
*m
, void *v
)
7942 struct tracing_log_err
*err
= v
;
7945 const char *err_text
= err
->info
.errs
[err
->info
.type
];
7946 u64 sec
= err
->info
.ts
;
7949 nsec
= do_div(sec
, NSEC_PER_SEC
);
7950 seq_printf(m
, "[%5llu.%06u] %s%s", sec
, nsec
/ 1000,
7951 err
->loc
, err_text
);
7952 seq_printf(m
, "%s", err
->cmd
);
7953 tracing_err_log_show_pos(m
, err
->info
.pos
);
7959 static const struct seq_operations tracing_err_log_seq_ops
= {
7960 .start
= tracing_err_log_seq_start
,
7961 .next
= tracing_err_log_seq_next
,
7962 .stop
= tracing_err_log_seq_stop
,
7963 .show
= tracing_err_log_seq_show
7966 static int tracing_err_log_open(struct inode
*inode
, struct file
*file
)
7968 struct trace_array
*tr
= inode
->i_private
;
7971 ret
= tracing_check_open_get_tr(tr
);
7975 /* If this file was opened for write, then erase contents */
7976 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
))
7977 clear_tracing_err_log(tr
);
7979 if (file
->f_mode
& FMODE_READ
) {
7980 ret
= seq_open(file
, &tracing_err_log_seq_ops
);
7982 struct seq_file
*m
= file
->private_data
;
7985 trace_array_put(tr
);
7991 static ssize_t
tracing_err_log_write(struct file
*file
,
7992 const char __user
*buffer
,
7993 size_t count
, loff_t
*ppos
)
7998 static int tracing_err_log_release(struct inode
*inode
, struct file
*file
)
8000 struct trace_array
*tr
= inode
->i_private
;
8002 trace_array_put(tr
);
8004 if (file
->f_mode
& FMODE_READ
)
8005 seq_release(inode
, file
);
8010 static const struct file_operations tracing_err_log_fops
= {
8011 .open
= tracing_err_log_open
,
8012 .write
= tracing_err_log_write
,
8014 .llseek
= tracing_lseek
,
8015 .release
= tracing_err_log_release
,
8018 static int tracing_buffers_open(struct inode
*inode
, struct file
*filp
)
8020 struct trace_array
*tr
= inode
->i_private
;
8021 struct ftrace_buffer_info
*info
;
8024 ret
= tracing_check_open_get_tr(tr
);
8028 info
= kvzalloc(sizeof(*info
), GFP_KERNEL
);
8030 trace_array_put(tr
);
8034 mutex_lock(&trace_types_lock
);
8037 info
->iter
.cpu_file
= tracing_get_cpu(inode
);
8038 info
->iter
.trace
= tr
->current_trace
;
8039 info
->iter
.array_buffer
= &tr
->array_buffer
;
8041 /* Force reading ring buffer for first read */
8042 info
->read
= (unsigned int)-1;
8044 filp
->private_data
= info
;
8048 mutex_unlock(&trace_types_lock
);
8050 ret
= nonseekable_open(inode
, filp
);
8052 trace_array_put(tr
);
8058 tracing_buffers_poll(struct file
*filp
, poll_table
*poll_table
)
8060 struct ftrace_buffer_info
*info
= filp
->private_data
;
8061 struct trace_iterator
*iter
= &info
->iter
;
8063 return trace_poll(iter
, filp
, poll_table
);
8067 tracing_buffers_read(struct file
*filp
, char __user
*ubuf
,
8068 size_t count
, loff_t
*ppos
)
8070 struct ftrace_buffer_info
*info
= filp
->private_data
;
8071 struct trace_iterator
*iter
= &info
->iter
;
8080 #ifdef CONFIG_TRACER_MAX_TRACE
8081 if (iter
->snapshot
&& iter
->tr
->current_trace
->use_max_tr
)
8085 page_size
= ring_buffer_subbuf_size_get(iter
->array_buffer
->buffer
);
8087 /* Make sure the spare matches the current sub buffer size */
8089 if (page_size
!= info
->spare_size
) {
8090 ring_buffer_free_read_page(iter
->array_buffer
->buffer
,
8091 info
->spare_cpu
, info
->spare
);
8097 info
->spare
= ring_buffer_alloc_read_page(iter
->array_buffer
->buffer
,
8099 if (IS_ERR(info
->spare
)) {
8100 ret
= PTR_ERR(info
->spare
);
8103 info
->spare_cpu
= iter
->cpu_file
;
8104 info
->spare_size
= page_size
;
8110 /* Do we have previous read data to read? */
8111 if (info
->read
< page_size
)
8115 trace_access_lock(iter
->cpu_file
);
8116 ret
= ring_buffer_read_page(iter
->array_buffer
->buffer
,
8120 trace_access_unlock(iter
->cpu_file
);
8123 if (trace_empty(iter
) && !iter
->closed
) {
8124 if ((filp
->f_flags
& O_NONBLOCK
))
8127 ret
= wait_on_pipe(iter
, 0);
8138 size
= page_size
- info
->read
;
8141 trace_data
= ring_buffer_read_page_data(info
->spare
);
8142 ret
= copy_to_user(ubuf
, trace_data
+ info
->read
, size
);
8154 static int tracing_buffers_flush(struct file
*file
, fl_owner_t id
)
8156 struct ftrace_buffer_info
*info
= file
->private_data
;
8157 struct trace_iterator
*iter
= &info
->iter
;
8159 iter
->closed
= true;
8160 /* Make sure the waiters see the new wait_index */
8161 (void)atomic_fetch_inc_release(&iter
->wait_index
);
8163 ring_buffer_wake_waiters(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8168 static int tracing_buffers_release(struct inode
*inode
, struct file
*file
)
8170 struct ftrace_buffer_info
*info
= file
->private_data
;
8171 struct trace_iterator
*iter
= &info
->iter
;
8173 mutex_lock(&trace_types_lock
);
8175 iter
->tr
->trace_ref
--;
8177 __trace_array_put(iter
->tr
);
8180 ring_buffer_free_read_page(iter
->array_buffer
->buffer
,
8181 info
->spare_cpu
, info
->spare
);
8184 mutex_unlock(&trace_types_lock
);
8190 struct trace_buffer
*buffer
;
8193 refcount_t refcount
;
8196 static void buffer_ref_release(struct buffer_ref
*ref
)
8198 if (!refcount_dec_and_test(&ref
->refcount
))
8200 ring_buffer_free_read_page(ref
->buffer
, ref
->cpu
, ref
->page
);
8204 static void buffer_pipe_buf_release(struct pipe_inode_info
*pipe
,
8205 struct pipe_buffer
*buf
)
8207 struct buffer_ref
*ref
= (struct buffer_ref
*)buf
->private;
8209 buffer_ref_release(ref
);
8213 static bool buffer_pipe_buf_get(struct pipe_inode_info
*pipe
,
8214 struct pipe_buffer
*buf
)
8216 struct buffer_ref
*ref
= (struct buffer_ref
*)buf
->private;
8218 if (refcount_read(&ref
->refcount
) > INT_MAX
/2)
8221 refcount_inc(&ref
->refcount
);
8225 /* Pipe buffer operations for a buffer. */
8226 static const struct pipe_buf_operations buffer_pipe_buf_ops
= {
8227 .release
= buffer_pipe_buf_release
,
8228 .get
= buffer_pipe_buf_get
,
8232 * Callback from splice_to_pipe(), if we need to release some pages
8233 * at the end of the spd in case we error'ed out in filling the pipe.
8235 static void buffer_spd_release(struct splice_pipe_desc
*spd
, unsigned int i
)
8237 struct buffer_ref
*ref
=
8238 (struct buffer_ref
*)spd
->partial
[i
].private;
8240 buffer_ref_release(ref
);
8241 spd
->partial
[i
].private = 0;
8245 tracing_buffers_splice_read(struct file
*file
, loff_t
*ppos
,
8246 struct pipe_inode_info
*pipe
, size_t len
,
8249 struct ftrace_buffer_info
*info
= file
->private_data
;
8250 struct trace_iterator
*iter
= &info
->iter
;
8251 struct partial_page partial_def
[PIPE_DEF_BUFFERS
];
8252 struct page
*pages_def
[PIPE_DEF_BUFFERS
];
8253 struct splice_pipe_desc spd
= {
8255 .partial
= partial_def
,
8256 .nr_pages_max
= PIPE_DEF_BUFFERS
,
8257 .ops
= &buffer_pipe_buf_ops
,
8258 .spd_release
= buffer_spd_release
,
8260 struct buffer_ref
*ref
;
8266 #ifdef CONFIG_TRACER_MAX_TRACE
8267 if (iter
->snapshot
&& iter
->tr
->current_trace
->use_max_tr
)
8271 page_size
= ring_buffer_subbuf_size_get(iter
->array_buffer
->buffer
);
8272 if (*ppos
& (page_size
- 1))
8275 if (len
& (page_size
- 1)) {
8276 if (len
< page_size
)
8278 len
&= (~(page_size
- 1));
8281 if (splice_grow_spd(pipe
, &spd
))
8285 trace_access_lock(iter
->cpu_file
);
8286 entries
= ring_buffer_entries_cpu(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8288 for (i
= 0; i
< spd
.nr_pages_max
&& len
&& entries
; i
++, len
-= page_size
) {
8292 ref
= kzalloc(sizeof(*ref
), GFP_KERNEL
);
8298 refcount_set(&ref
->refcount
, 1);
8299 ref
->buffer
= iter
->array_buffer
->buffer
;
8300 ref
->page
= ring_buffer_alloc_read_page(ref
->buffer
, iter
->cpu_file
);
8301 if (IS_ERR(ref
->page
)) {
8302 ret
= PTR_ERR(ref
->page
);
8307 ref
->cpu
= iter
->cpu_file
;
8309 r
= ring_buffer_read_page(ref
->buffer
, ref
->page
,
8310 len
, iter
->cpu_file
, 1);
8312 ring_buffer_free_read_page(ref
->buffer
, ref
->cpu
,
8318 page
= virt_to_page(ring_buffer_read_page_data(ref
->page
));
8320 spd
.pages
[i
] = page
;
8321 spd
.partial
[i
].len
= page_size
;
8322 spd
.partial
[i
].offset
= 0;
8323 spd
.partial
[i
].private = (unsigned long)ref
;
8327 entries
= ring_buffer_entries_cpu(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8330 trace_access_unlock(iter
->cpu_file
);
8333 /* did we read anything? */
8334 if (!spd
.nr_pages
) {
8343 if ((file
->f_flags
& O_NONBLOCK
) || (flags
& SPLICE_F_NONBLOCK
))
8346 ret
= wait_on_pipe(iter
, iter
->snapshot
? 0 : iter
->tr
->buffer_percent
);
8350 /* No need to wait after waking up when tracing is off */
8351 if (!tracer_tracing_is_on(iter
->tr
))
8354 /* Iterate one more time to collect any new data then exit */
8360 ret
= splice_to_pipe(pipe
, &spd
);
8362 splice_shrink_spd(&spd
);
8367 static long tracing_buffers_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
8369 struct ftrace_buffer_info
*info
= file
->private_data
;
8370 struct trace_iterator
*iter
= &info
->iter
;
8373 if (cmd
== TRACE_MMAP_IOCTL_GET_READER
) {
8374 if (!(file
->f_flags
& O_NONBLOCK
)) {
8375 err
= ring_buffer_wait(iter
->array_buffer
->buffer
,
8377 iter
->tr
->buffer_percent
,
8383 return ring_buffer_map_get_reader(iter
->array_buffer
->buffer
,
8390 * An ioctl call with cmd 0 to the ring buffer file will wake up all
8393 mutex_lock(&trace_types_lock
);
8395 /* Make sure the waiters see the new wait_index */
8396 (void)atomic_fetch_inc_release(&iter
->wait_index
);
8398 ring_buffer_wake_waiters(iter
->array_buffer
->buffer
, iter
->cpu_file
);
8400 mutex_unlock(&trace_types_lock
);
8404 #ifdef CONFIG_TRACER_MAX_TRACE
8405 static int get_snapshot_map(struct trace_array
*tr
)
8410 * Called with mmap_lock held. lockdep would be unhappy if we would now
8411 * take trace_types_lock. Instead use the specific
8412 * snapshot_trigger_lock.
8414 spin_lock(&tr
->snapshot_trigger_lock
);
8416 if (tr
->snapshot
|| tr
->mapped
== UINT_MAX
)
8421 spin_unlock(&tr
->snapshot_trigger_lock
);
8423 /* Wait for update_max_tr() to observe iter->tr->mapped */
8424 if (tr
->mapped
== 1)
8430 static void put_snapshot_map(struct trace_array
*tr
)
8432 spin_lock(&tr
->snapshot_trigger_lock
);
8433 if (!WARN_ON(!tr
->mapped
))
8435 spin_unlock(&tr
->snapshot_trigger_lock
);
8438 static inline int get_snapshot_map(struct trace_array
*tr
) { return 0; }
8439 static inline void put_snapshot_map(struct trace_array
*tr
) { }
8442 static void tracing_buffers_mmap_close(struct vm_area_struct
*vma
)
8444 struct ftrace_buffer_info
*info
= vma
->vm_file
->private_data
;
8445 struct trace_iterator
*iter
= &info
->iter
;
8447 WARN_ON(ring_buffer_unmap(iter
->array_buffer
->buffer
, iter
->cpu_file
));
8448 put_snapshot_map(iter
->tr
);
8451 static const struct vm_operations_struct tracing_buffers_vmops
= {
8452 .close
= tracing_buffers_mmap_close
,
8455 static int tracing_buffers_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
8457 struct ftrace_buffer_info
*info
= filp
->private_data
;
8458 struct trace_iterator
*iter
= &info
->iter
;
8461 ret
= get_snapshot_map(iter
->tr
);
8465 ret
= ring_buffer_map(iter
->array_buffer
->buffer
, iter
->cpu_file
, vma
);
8467 put_snapshot_map(iter
->tr
);
8469 vma
->vm_ops
= &tracing_buffers_vmops
;
8474 static const struct file_operations tracing_buffers_fops
= {
8475 .open
= tracing_buffers_open
,
8476 .read
= tracing_buffers_read
,
8477 .poll
= tracing_buffers_poll
,
8478 .release
= tracing_buffers_release
,
8479 .flush
= tracing_buffers_flush
,
8480 .splice_read
= tracing_buffers_splice_read
,
8481 .unlocked_ioctl
= tracing_buffers_ioctl
,
8482 .mmap
= tracing_buffers_mmap
,
8486 tracing_stats_read(struct file
*filp
, char __user
*ubuf
,
8487 size_t count
, loff_t
*ppos
)
8489 struct inode
*inode
= file_inode(filp
);
8490 struct trace_array
*tr
= inode
->i_private
;
8491 struct array_buffer
*trace_buf
= &tr
->array_buffer
;
8492 int cpu
= tracing_get_cpu(inode
);
8493 struct trace_seq
*s
;
8495 unsigned long long t
;
8496 unsigned long usec_rem
;
8498 s
= kmalloc(sizeof(*s
), GFP_KERNEL
);
8504 cnt
= ring_buffer_entries_cpu(trace_buf
->buffer
, cpu
);
8505 trace_seq_printf(s
, "entries: %ld\n", cnt
);
8507 cnt
= ring_buffer_overrun_cpu(trace_buf
->buffer
, cpu
);
8508 trace_seq_printf(s
, "overrun: %ld\n", cnt
);
8510 cnt
= ring_buffer_commit_overrun_cpu(trace_buf
->buffer
, cpu
);
8511 trace_seq_printf(s
, "commit overrun: %ld\n", cnt
);
8513 cnt
= ring_buffer_bytes_cpu(trace_buf
->buffer
, cpu
);
8514 trace_seq_printf(s
, "bytes: %ld\n", cnt
);
8516 if (trace_clocks
[tr
->clock_id
].in_ns
) {
8517 /* local or global for trace_clock */
8518 t
= ns2usecs(ring_buffer_oldest_event_ts(trace_buf
->buffer
, cpu
));
8519 usec_rem
= do_div(t
, USEC_PER_SEC
);
8520 trace_seq_printf(s
, "oldest event ts: %5llu.%06lu\n",
8523 t
= ns2usecs(ring_buffer_time_stamp(trace_buf
->buffer
));
8524 usec_rem
= do_div(t
, USEC_PER_SEC
);
8525 trace_seq_printf(s
, "now ts: %5llu.%06lu\n", t
, usec_rem
);
8527 /* counter or tsc mode for trace_clock */
8528 trace_seq_printf(s
, "oldest event ts: %llu\n",
8529 ring_buffer_oldest_event_ts(trace_buf
->buffer
, cpu
));
8531 trace_seq_printf(s
, "now ts: %llu\n",
8532 ring_buffer_time_stamp(trace_buf
->buffer
));
8535 cnt
= ring_buffer_dropped_events_cpu(trace_buf
->buffer
, cpu
);
8536 trace_seq_printf(s
, "dropped events: %ld\n", cnt
);
8538 cnt
= ring_buffer_read_events_cpu(trace_buf
->buffer
, cpu
);
8539 trace_seq_printf(s
, "read events: %ld\n", cnt
);
8541 count
= simple_read_from_buffer(ubuf
, count
, ppos
,
8542 s
->buffer
, trace_seq_used(s
));
8549 static const struct file_operations tracing_stats_fops
= {
8550 .open
= tracing_open_generic_tr
,
8551 .read
= tracing_stats_read
,
8552 .llseek
= generic_file_llseek
,
8553 .release
= tracing_release_generic_tr
,
8556 #ifdef CONFIG_DYNAMIC_FTRACE
8559 tracing_read_dyn_info(struct file
*filp
, char __user
*ubuf
,
8560 size_t cnt
, loff_t
*ppos
)
8566 /* 256 should be plenty to hold the amount needed */
8567 buf
= kmalloc(256, GFP_KERNEL
);
8571 r
= scnprintf(buf
, 256, "%ld pages:%ld groups: %ld\n",
8572 ftrace_update_tot_cnt
,
8573 ftrace_number_of_pages
,
8574 ftrace_number_of_groups
);
8576 ret
= simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
8581 static const struct file_operations tracing_dyn_info_fops
= {
8582 .open
= tracing_open_generic
,
8583 .read
= tracing_read_dyn_info
,
8584 .llseek
= generic_file_llseek
,
8586 #endif /* CONFIG_DYNAMIC_FTRACE */
8588 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
8590 ftrace_snapshot(unsigned long ip
, unsigned long parent_ip
,
8591 struct trace_array
*tr
, struct ftrace_probe_ops
*ops
,
8594 tracing_snapshot_instance(tr
);
8598 ftrace_count_snapshot(unsigned long ip
, unsigned long parent_ip
,
8599 struct trace_array
*tr
, struct ftrace_probe_ops
*ops
,
8602 struct ftrace_func_mapper
*mapper
= data
;
8606 count
= (long *)ftrace_func_mapper_find_ip(mapper
, ip
);
8616 tracing_snapshot_instance(tr
);
8620 ftrace_snapshot_print(struct seq_file
*m
, unsigned long ip
,
8621 struct ftrace_probe_ops
*ops
, void *data
)
8623 struct ftrace_func_mapper
*mapper
= data
;
8626 seq_printf(m
, "%ps:", (void *)ip
);
8628 seq_puts(m
, "snapshot");
8631 count
= (long *)ftrace_func_mapper_find_ip(mapper
, ip
);
8634 seq_printf(m
, ":count=%ld\n", *count
);
8636 seq_puts(m
, ":unlimited\n");
8642 ftrace_snapshot_init(struct ftrace_probe_ops
*ops
, struct trace_array
*tr
,
8643 unsigned long ip
, void *init_data
, void **data
)
8645 struct ftrace_func_mapper
*mapper
= *data
;
8648 mapper
= allocate_ftrace_func_mapper();
8654 return ftrace_func_mapper_add_ip(mapper
, ip
, init_data
);
8658 ftrace_snapshot_free(struct ftrace_probe_ops
*ops
, struct trace_array
*tr
,
8659 unsigned long ip
, void *data
)
8661 struct ftrace_func_mapper
*mapper
= data
;
8666 free_ftrace_func_mapper(mapper
, NULL
);
8670 ftrace_func_mapper_remove_ip(mapper
, ip
);
8673 static struct ftrace_probe_ops snapshot_probe_ops
= {
8674 .func
= ftrace_snapshot
,
8675 .print
= ftrace_snapshot_print
,
8678 static struct ftrace_probe_ops snapshot_count_probe_ops
= {
8679 .func
= ftrace_count_snapshot
,
8680 .print
= ftrace_snapshot_print
,
8681 .init
= ftrace_snapshot_init
,
8682 .free
= ftrace_snapshot_free
,
8686 ftrace_trace_snapshot_callback(struct trace_array
*tr
, struct ftrace_hash
*hash
,
8687 char *glob
, char *cmd
, char *param
, int enable
)
8689 struct ftrace_probe_ops
*ops
;
8690 void *count
= (void *)-1;
8697 /* hash funcs only work with set_ftrace_filter */
8701 ops
= param
? &snapshot_count_probe_ops
: &snapshot_probe_ops
;
8703 if (glob
[0] == '!') {
8704 ret
= unregister_ftrace_function_probe_func(glob
+1, tr
, ops
);
8706 tracing_disarm_snapshot(tr
);
8714 number
= strsep(¶m
, ":");
8716 if (!strlen(number
))
8720 * We use the callback data field (which is a pointer)
8723 ret
= kstrtoul(number
, 0, (unsigned long *)&count
);
8728 ret
= tracing_arm_snapshot(tr
);
8732 ret
= register_ftrace_function_probe(glob
, tr
, ops
, count
);
8734 tracing_disarm_snapshot(tr
);
8736 return ret
< 0 ? ret
: 0;
8739 static struct ftrace_func_command ftrace_snapshot_cmd
= {
8741 .func
= ftrace_trace_snapshot_callback
,
8744 static __init
int register_snapshot_cmd(void)
8746 return register_ftrace_command(&ftrace_snapshot_cmd
);
8749 static inline __init
int register_snapshot_cmd(void) { return 0; }
8750 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
8752 static struct dentry
*tracing_get_dentry(struct trace_array
*tr
)
8754 if (WARN_ON(!tr
->dir
))
8755 return ERR_PTR(-ENODEV
);
8757 /* Top directory uses NULL as the parent */
8758 if (tr
->flags
& TRACE_ARRAY_FL_GLOBAL
)
8761 /* All sub buffers have a descriptor */
8765 static struct dentry
*tracing_dentry_percpu(struct trace_array
*tr
, int cpu
)
8767 struct dentry
*d_tracer
;
8770 return tr
->percpu_dir
;
8772 d_tracer
= tracing_get_dentry(tr
);
8773 if (IS_ERR(d_tracer
))
8776 tr
->percpu_dir
= tracefs_create_dir("per_cpu", d_tracer
);
8778 MEM_FAIL(!tr
->percpu_dir
,
8779 "Could not create tracefs directory 'per_cpu/%d'\n", cpu
);
8781 return tr
->percpu_dir
;
8784 static struct dentry
*
8785 trace_create_cpu_file(const char *name
, umode_t mode
, struct dentry
*parent
,
8786 void *data
, long cpu
, const struct file_operations
*fops
)
8788 struct dentry
*ret
= trace_create_file(name
, mode
, parent
, data
, fops
);
8790 if (ret
) /* See tracing_get_cpu() */
8791 d_inode(ret
)->i_cdev
= (void *)(cpu
+ 1);
8796 tracing_init_tracefs_percpu(struct trace_array
*tr
, long cpu
)
8798 struct dentry
*d_percpu
= tracing_dentry_percpu(tr
, cpu
);
8799 struct dentry
*d_cpu
;
8800 char cpu_dir
[30]; /* 30 characters should be more than enough */
8805 snprintf(cpu_dir
, 30, "cpu%ld", cpu
);
8806 d_cpu
= tracefs_create_dir(cpu_dir
, d_percpu
);
8808 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir
);
8812 /* per cpu trace_pipe */
8813 trace_create_cpu_file("trace_pipe", TRACE_MODE_READ
, d_cpu
,
8814 tr
, cpu
, &tracing_pipe_fops
);
8817 trace_create_cpu_file("trace", TRACE_MODE_WRITE
, d_cpu
,
8818 tr
, cpu
, &tracing_fops
);
8820 trace_create_cpu_file("trace_pipe_raw", TRACE_MODE_READ
, d_cpu
,
8821 tr
, cpu
, &tracing_buffers_fops
);
8823 trace_create_cpu_file("stats", TRACE_MODE_READ
, d_cpu
,
8824 tr
, cpu
, &tracing_stats_fops
);
8826 trace_create_cpu_file("buffer_size_kb", TRACE_MODE_READ
, d_cpu
,
8827 tr
, cpu
, &tracing_entries_fops
);
8829 if (tr
->range_addr_start
)
8830 trace_create_cpu_file("buffer_meta", TRACE_MODE_READ
, d_cpu
,
8831 tr
, cpu
, &tracing_buffer_meta_fops
);
8832 #ifdef CONFIG_TRACER_SNAPSHOT
8833 if (!tr
->range_addr_start
) {
8834 trace_create_cpu_file("snapshot", TRACE_MODE_WRITE
, d_cpu
,
8835 tr
, cpu
, &snapshot_fops
);
8837 trace_create_cpu_file("snapshot_raw", TRACE_MODE_READ
, d_cpu
,
8838 tr
, cpu
, &snapshot_raw_fops
);
8843 #ifdef CONFIG_FTRACE_SELFTEST
8844 /* Let selftest have access to static functions in this file */
8845 #include "trace_selftest.c"
8849 trace_options_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
,
8852 struct trace_option_dentry
*topt
= filp
->private_data
;
8855 if (topt
->flags
->val
& topt
->opt
->bit
)
8860 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, 2);
8864 trace_options_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
8867 struct trace_option_dentry
*topt
= filp
->private_data
;
8871 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
8875 if (val
!= 0 && val
!= 1)
8878 if (!!(topt
->flags
->val
& topt
->opt
->bit
) != val
) {
8879 mutex_lock(&trace_types_lock
);
8880 ret
= __set_tracer_option(topt
->tr
, topt
->flags
,
8882 mutex_unlock(&trace_types_lock
);
8892 static int tracing_open_options(struct inode
*inode
, struct file
*filp
)
8894 struct trace_option_dentry
*topt
= inode
->i_private
;
8897 ret
= tracing_check_open_get_tr(topt
->tr
);
8901 filp
->private_data
= inode
->i_private
;
8905 static int tracing_release_options(struct inode
*inode
, struct file
*file
)
8907 struct trace_option_dentry
*topt
= file
->private_data
;
8909 trace_array_put(topt
->tr
);
8913 static const struct file_operations trace_options_fops
= {
8914 .open
= tracing_open_options
,
8915 .read
= trace_options_read
,
8916 .write
= trace_options_write
,
8917 .llseek
= generic_file_llseek
,
8918 .release
= tracing_release_options
,
8922 * In order to pass in both the trace_array descriptor as well as the index
8923 * to the flag that the trace option file represents, the trace_array
8924 * has a character array of trace_flags_index[], which holds the index
8925 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
8926 * The address of this character array is passed to the flag option file
8927 * read/write callbacks.
8929 * In order to extract both the index and the trace_array descriptor,
8930 * get_tr_index() uses the following algorithm.
8934 * As the pointer itself contains the address of the index (remember
8937 * Then to get the trace_array descriptor, by subtracting that index
8938 * from the ptr, we get to the start of the index itself.
8940 * ptr - idx == &index[0]
8942 * Then a simple container_of() from that pointer gets us to the
8943 * trace_array descriptor.
8945 static void get_tr_index(void *data
, struct trace_array
**ptr
,
8946 unsigned int *pindex
)
8948 *pindex
= *(unsigned char *)data
;
8950 *ptr
= container_of(data
- *pindex
, struct trace_array
,
8955 trace_options_core_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
,
8958 void *tr_index
= filp
->private_data
;
8959 struct trace_array
*tr
;
8963 get_tr_index(tr_index
, &tr
, &index
);
8965 if (tr
->trace_flags
& (1 << index
))
8970 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, 2);
8974 trace_options_core_write(struct file
*filp
, const char __user
*ubuf
, size_t cnt
,
8977 void *tr_index
= filp
->private_data
;
8978 struct trace_array
*tr
;
8983 get_tr_index(tr_index
, &tr
, &index
);
8985 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
8989 if (val
!= 0 && val
!= 1)
8992 mutex_lock(&event_mutex
);
8993 mutex_lock(&trace_types_lock
);
8994 ret
= set_tracer_flag(tr
, 1 << index
, val
);
8995 mutex_unlock(&trace_types_lock
);
8996 mutex_unlock(&event_mutex
);
9006 static const struct file_operations trace_options_core_fops
= {
9007 .open
= tracing_open_generic
,
9008 .read
= trace_options_core_read
,
9009 .write
= trace_options_core_write
,
9010 .llseek
= generic_file_llseek
,
9013 struct dentry
*trace_create_file(const char *name
,
9015 struct dentry
*parent
,
9017 const struct file_operations
*fops
)
9021 ret
= tracefs_create_file(name
, mode
, parent
, data
, fops
);
9023 pr_warn("Could not create tracefs '%s' entry\n", name
);
9029 static struct dentry
*trace_options_init_dentry(struct trace_array
*tr
)
9031 struct dentry
*d_tracer
;
9036 d_tracer
= tracing_get_dentry(tr
);
9037 if (IS_ERR(d_tracer
))
9040 tr
->options
= tracefs_create_dir("options", d_tracer
);
9042 pr_warn("Could not create tracefs directory 'options'\n");
9050 create_trace_option_file(struct trace_array
*tr
,
9051 struct trace_option_dentry
*topt
,
9052 struct tracer_flags
*flags
,
9053 struct tracer_opt
*opt
)
9055 struct dentry
*t_options
;
9057 t_options
= trace_options_init_dentry(tr
);
9061 topt
->flags
= flags
;
9065 topt
->entry
= trace_create_file(opt
->name
, TRACE_MODE_WRITE
,
9066 t_options
, topt
, &trace_options_fops
);
9071 create_trace_option_files(struct trace_array
*tr
, struct tracer
*tracer
)
9073 struct trace_option_dentry
*topts
;
9074 struct trace_options
*tr_topts
;
9075 struct tracer_flags
*flags
;
9076 struct tracer_opt
*opts
;
9083 flags
= tracer
->flags
;
9085 if (!flags
|| !flags
->opts
)
9089 * If this is an instance, only create flags for tracers
9090 * the instance may have.
9092 if (!trace_ok_for_array(tracer
, tr
))
9095 for (i
= 0; i
< tr
->nr_topts
; i
++) {
9096 /* Make sure there's no duplicate flags. */
9097 if (WARN_ON_ONCE(tr
->topts
[i
].tracer
->flags
== tracer
->flags
))
9103 for (cnt
= 0; opts
[cnt
].name
; cnt
++)
9106 topts
= kcalloc(cnt
+ 1, sizeof(*topts
), GFP_KERNEL
);
9110 tr_topts
= krealloc(tr
->topts
, sizeof(*tr
->topts
) * (tr
->nr_topts
+ 1),
9117 tr
->topts
= tr_topts
;
9118 tr
->topts
[tr
->nr_topts
].tracer
= tracer
;
9119 tr
->topts
[tr
->nr_topts
].topts
= topts
;
9122 for (cnt
= 0; opts
[cnt
].name
; cnt
++) {
9123 create_trace_option_file(tr
, &topts
[cnt
], flags
,
9125 MEM_FAIL(topts
[cnt
].entry
== NULL
,
9126 "Failed to create trace option: %s",
9131 static struct dentry
*
9132 create_trace_option_core_file(struct trace_array
*tr
,
9133 const char *option
, long index
)
9135 struct dentry
*t_options
;
9137 t_options
= trace_options_init_dentry(tr
);
9141 return trace_create_file(option
, TRACE_MODE_WRITE
, t_options
,
9142 (void *)&tr
->trace_flags_index
[index
],
9143 &trace_options_core_fops
);
9146 static void create_trace_options_dir(struct trace_array
*tr
)
9148 struct dentry
*t_options
;
9149 bool top_level
= tr
== &global_trace
;
9152 t_options
= trace_options_init_dentry(tr
);
9156 for (i
= 0; trace_options
[i
]; i
++) {
9158 !((1 << i
) & TOP_LEVEL_TRACE_FLAGS
))
9159 create_trace_option_core_file(tr
, trace_options
[i
], i
);
9164 rb_simple_read(struct file
*filp
, char __user
*ubuf
,
9165 size_t cnt
, loff_t
*ppos
)
9167 struct trace_array
*tr
= filp
->private_data
;
9171 r
= tracer_tracing_is_on(tr
);
9172 r
= sprintf(buf
, "%d\n", r
);
9174 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9178 rb_simple_write(struct file
*filp
, const char __user
*ubuf
,
9179 size_t cnt
, loff_t
*ppos
)
9181 struct trace_array
*tr
= filp
->private_data
;
9182 struct trace_buffer
*buffer
= tr
->array_buffer
.buffer
;
9186 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9191 mutex_lock(&trace_types_lock
);
9192 if (!!val
== tracer_tracing_is_on(tr
)) {
9193 val
= 0; /* do nothing */
9195 tracer_tracing_on(tr
);
9196 if (tr
->current_trace
->start
)
9197 tr
->current_trace
->start(tr
);
9199 tracer_tracing_off(tr
);
9200 if (tr
->current_trace
->stop
)
9201 tr
->current_trace
->stop(tr
);
9202 /* Wake up any waiters */
9203 ring_buffer_wake_waiters(buffer
, RING_BUFFER_ALL_CPUS
);
9205 mutex_unlock(&trace_types_lock
);
9213 static const struct file_operations rb_simple_fops
= {
9214 .open
= tracing_open_generic_tr
,
9215 .read
= rb_simple_read
,
9216 .write
= rb_simple_write
,
9217 .release
= tracing_release_generic_tr
,
9218 .llseek
= default_llseek
,
9222 buffer_percent_read(struct file
*filp
, char __user
*ubuf
,
9223 size_t cnt
, loff_t
*ppos
)
9225 struct trace_array
*tr
= filp
->private_data
;
9229 r
= tr
->buffer_percent
;
9230 r
= sprintf(buf
, "%d\n", r
);
9232 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9236 buffer_percent_write(struct file
*filp
, const char __user
*ubuf
,
9237 size_t cnt
, loff_t
*ppos
)
9239 struct trace_array
*tr
= filp
->private_data
;
9243 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9250 tr
->buffer_percent
= val
;
9257 static const struct file_operations buffer_percent_fops
= {
9258 .open
= tracing_open_generic_tr
,
9259 .read
= buffer_percent_read
,
9260 .write
= buffer_percent_write
,
9261 .release
= tracing_release_generic_tr
,
9262 .llseek
= default_llseek
,
9266 buffer_subbuf_size_read(struct file
*filp
, char __user
*ubuf
, size_t cnt
, loff_t
*ppos
)
9268 struct trace_array
*tr
= filp
->private_data
;
9274 order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
9275 size
= (PAGE_SIZE
<< order
) / 1024;
9277 r
= sprintf(buf
, "%zd\n", size
);
9279 return simple_read_from_buffer(ubuf
, cnt
, ppos
, buf
, r
);
9283 buffer_subbuf_size_write(struct file
*filp
, const char __user
*ubuf
,
9284 size_t cnt
, loff_t
*ppos
)
9286 struct trace_array
*tr
= filp
->private_data
;
9293 ret
= kstrtoul_from_user(ubuf
, cnt
, 10, &val
);
9297 val
*= 1024; /* value passed in is in KB */
9299 pages
= DIV_ROUND_UP(val
, PAGE_SIZE
);
9300 order
= fls(pages
- 1);
9302 /* limit between 1 and 128 system pages */
9303 if (order
< 0 || order
> 7)
9306 /* Do not allow tracing while changing the order of the ring buffer */
9307 tracing_stop_tr(tr
);
9309 old_order
= ring_buffer_subbuf_order_get(tr
->array_buffer
.buffer
);
9310 if (old_order
== order
)
9313 ret
= ring_buffer_subbuf_order_set(tr
->array_buffer
.buffer
, order
);
9317 #ifdef CONFIG_TRACER_MAX_TRACE
9319 if (!tr
->allocated_snapshot
)
9322 ret
= ring_buffer_subbuf_order_set(tr
->max_buffer
.buffer
, order
);
9324 /* Put back the old order */
9325 cnt
= ring_buffer_subbuf_order_set(tr
->array_buffer
.buffer
, old_order
);
9326 if (WARN_ON_ONCE(cnt
)) {
9328 * AARGH! We are left with different orders!
9329 * The max buffer is our "snapshot" buffer.
9330 * When a tracer needs a snapshot (one of the
9331 * latency tracers), it swaps the max buffer
9332 * with the saved snap shot. We succeeded to
9333 * update the order of the main buffer, but failed to
9334 * update the order of the max buffer. But when we tried
9335 * to reset the main buffer to the original size, we
9336 * failed there too. This is very unlikely to
9337 * happen, but if it does, warn and kill all
9340 tracing_disabled
= 1;
9350 tracing_start_tr(tr
);
9354 static const struct file_operations buffer_subbuf_size_fops
= {
9355 .open
= tracing_open_generic_tr
,
9356 .read
= buffer_subbuf_size_read
,
9357 .write
= buffer_subbuf_size_write
,
9358 .release
= tracing_release_generic_tr
,
9359 .llseek
= default_llseek
,
9362 static struct dentry
*trace_instance_dir
;
9365 init_tracer_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
);
9368 allocate_trace_buffer(struct trace_array
*tr
, struct array_buffer
*buf
, int size
)
9370 enum ring_buffer_flags rb_flags
;
9372 rb_flags
= tr
->trace_flags
& TRACE_ITER_OVERWRITE
? RB_FL_OVERWRITE
: 0;
9376 if (tr
->range_addr_start
&& tr
->range_addr_size
) {
9377 buf
->buffer
= ring_buffer_alloc_range(size
, rb_flags
, 0,
9378 tr
->range_addr_start
,
9379 tr
->range_addr_size
);
9381 ring_buffer_last_boot_delta(buf
->buffer
,
9382 &tr
->text_delta
, &tr
->data_delta
);
9384 * This is basically the same as a mapped buffer,
9385 * with the same restrictions.
9389 buf
->buffer
= ring_buffer_alloc(size
, rb_flags
);
9394 buf
->data
= alloc_percpu(struct trace_array_cpu
);
9396 ring_buffer_free(buf
->buffer
);
9401 /* Allocate the first page for all buffers */
9402 set_buffer_entries(&tr
->array_buffer
,
9403 ring_buffer_size(tr
->array_buffer
.buffer
, 0));
9408 static void free_trace_buffer(struct array_buffer
*buf
)
9411 ring_buffer_free(buf
->buffer
);
9413 free_percpu(buf
->data
);
9418 static int allocate_trace_buffers(struct trace_array
*tr
, int size
)
9422 ret
= allocate_trace_buffer(tr
, &tr
->array_buffer
, size
);
9426 #ifdef CONFIG_TRACER_MAX_TRACE
9427 /* Fix mapped buffer trace arrays do not have snapshot buffers */
9428 if (tr
->range_addr_start
)
9431 ret
= allocate_trace_buffer(tr
, &tr
->max_buffer
,
9432 allocate_snapshot
? size
: 1);
9433 if (MEM_FAIL(ret
, "Failed to allocate trace buffer\n")) {
9434 free_trace_buffer(&tr
->array_buffer
);
9437 tr
->allocated_snapshot
= allocate_snapshot
;
9439 allocate_snapshot
= false;
9445 static void free_trace_buffers(struct trace_array
*tr
)
9450 free_trace_buffer(&tr
->array_buffer
);
9452 #ifdef CONFIG_TRACER_MAX_TRACE
9453 free_trace_buffer(&tr
->max_buffer
);
9457 static void init_trace_flags_index(struct trace_array
*tr
)
9461 /* Used by the trace options files */
9462 for (i
= 0; i
< TRACE_FLAGS_MAX_SIZE
; i
++)
9463 tr
->trace_flags_index
[i
] = i
;
9466 static void __update_tracer_options(struct trace_array
*tr
)
9470 for (t
= trace_types
; t
; t
= t
->next
)
9471 add_tracer_options(tr
, t
);
9474 static void update_tracer_options(struct trace_array
*tr
)
9476 mutex_lock(&trace_types_lock
);
9477 tracer_options_updated
= true;
9478 __update_tracer_options(tr
);
9479 mutex_unlock(&trace_types_lock
);
9482 /* Must have trace_types_lock held */
9483 struct trace_array
*trace_array_find(const char *instance
)
9485 struct trace_array
*tr
, *found
= NULL
;
9487 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9488 if (tr
->name
&& strcmp(tr
->name
, instance
) == 0) {
9497 struct trace_array
*trace_array_find_get(const char *instance
)
9499 struct trace_array
*tr
;
9501 mutex_lock(&trace_types_lock
);
9502 tr
= trace_array_find(instance
);
9505 mutex_unlock(&trace_types_lock
);
9510 static int trace_array_create_dir(struct trace_array
*tr
)
9514 tr
->dir
= tracefs_create_dir(tr
->name
, trace_instance_dir
);
9518 ret
= event_trace_add_tracer(tr
->dir
, tr
);
9520 tracefs_remove(tr
->dir
);
9524 init_tracer_tracefs(tr
, tr
->dir
);
9525 __update_tracer_options(tr
);
9530 static struct trace_array
*
9531 trace_array_create_systems(const char *name
, const char *systems
,
9532 unsigned long range_addr_start
,
9533 unsigned long range_addr_size
)
9535 struct trace_array
*tr
;
9539 tr
= kzalloc(sizeof(*tr
), GFP_KERNEL
);
9541 return ERR_PTR(ret
);
9543 tr
->name
= kstrdup(name
, GFP_KERNEL
);
9547 if (!alloc_cpumask_var(&tr
->tracing_cpumask
, GFP_KERNEL
))
9550 if (!zalloc_cpumask_var(&tr
->pipe_cpumask
, GFP_KERNEL
))
9554 tr
->system_names
= kstrdup_const(systems
, GFP_KERNEL
);
9555 if (!tr
->system_names
)
9559 /* Only for boot up memory mapped ring buffers */
9560 tr
->range_addr_start
= range_addr_start
;
9561 tr
->range_addr_size
= range_addr_size
;
9563 tr
->trace_flags
= global_trace
.trace_flags
& ~ZEROED_TRACE_FLAGS
;
9565 cpumask_copy(tr
->tracing_cpumask
, cpu_all_mask
);
9567 raw_spin_lock_init(&tr
->start_lock
);
9569 tr
->max_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
9570 #ifdef CONFIG_TRACER_MAX_TRACE
9571 spin_lock_init(&tr
->snapshot_trigger_lock
);
9573 tr
->current_trace
= &nop_trace
;
9575 INIT_LIST_HEAD(&tr
->systems
);
9576 INIT_LIST_HEAD(&tr
->events
);
9577 INIT_LIST_HEAD(&tr
->hist_vars
);
9578 INIT_LIST_HEAD(&tr
->err_log
);
9580 if (allocate_trace_buffers(tr
, trace_buf_size
) < 0)
9583 /* The ring buffer is defaultly expanded */
9584 trace_set_ring_buffer_expanded(tr
);
9586 if (ftrace_allocate_ftrace_ops(tr
) < 0)
9589 ftrace_init_trace_array(tr
);
9591 init_trace_flags_index(tr
);
9593 if (trace_instance_dir
) {
9594 ret
= trace_array_create_dir(tr
);
9598 __trace_early_add_events(tr
);
9600 list_add(&tr
->list
, &ftrace_trace_arrays
);
9607 ftrace_free_ftrace_ops(tr
);
9608 free_trace_buffers(tr
);
9609 free_cpumask_var(tr
->pipe_cpumask
);
9610 free_cpumask_var(tr
->tracing_cpumask
);
9611 kfree_const(tr
->system_names
);
9615 return ERR_PTR(ret
);
9618 static struct trace_array
*trace_array_create(const char *name
)
9620 return trace_array_create_systems(name
, NULL
, 0, 0);
9623 static int instance_mkdir(const char *name
)
9625 struct trace_array
*tr
;
9628 mutex_lock(&event_mutex
);
9629 mutex_lock(&trace_types_lock
);
9632 if (trace_array_find(name
))
9635 tr
= trace_array_create(name
);
9637 ret
= PTR_ERR_OR_ZERO(tr
);
9640 mutex_unlock(&trace_types_lock
);
9641 mutex_unlock(&event_mutex
);
9645 static u64
map_pages(u64 start
, u64 size
)
9647 struct page
**pages
;
9648 phys_addr_t page_start
;
9649 unsigned int page_count
;
9653 page_count
= DIV_ROUND_UP(size
, PAGE_SIZE
);
9656 pages
= kmalloc_array(page_count
, sizeof(struct page
*), GFP_KERNEL
);
9660 for (i
= 0; i
< page_count
; i
++) {
9661 phys_addr_t addr
= page_start
+ i
* PAGE_SIZE
;
9662 pages
[i
] = pfn_to_page(addr
>> PAGE_SHIFT
);
9664 vaddr
= vmap(pages
, page_count
, VM_MAP
, PAGE_KERNEL
);
9667 return (u64
)(unsigned long)vaddr
;
9671 * trace_array_get_by_name - Create/Lookup a trace array, given its name.
9672 * @name: The name of the trace array to be looked up/created.
9673 * @systems: A list of systems to create event directories for (NULL for all)
9675 * Returns pointer to trace array with given name.
9676 * NULL, if it cannot be created.
9678 * NOTE: This function increments the reference counter associated with the
9679 * trace array returned. This makes sure it cannot be freed while in use.
9680 * Use trace_array_put() once the trace array is no longer needed.
9681 * If the trace_array is to be freed, trace_array_destroy() needs to
9682 * be called after the trace_array_put(), or simply let user space delete
9683 * it from the tracefs instances directory. But until the
9684 * trace_array_put() is called, user space can not delete it.
9687 struct trace_array
*trace_array_get_by_name(const char *name
, const char *systems
)
9689 struct trace_array
*tr
;
9691 mutex_lock(&event_mutex
);
9692 mutex_lock(&trace_types_lock
);
9694 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9695 if (tr
->name
&& strcmp(tr
->name
, name
) == 0)
9699 tr
= trace_array_create_systems(name
, systems
, 0, 0);
9707 mutex_unlock(&trace_types_lock
);
9708 mutex_unlock(&event_mutex
);
9711 EXPORT_SYMBOL_GPL(trace_array_get_by_name
);
9713 static int __remove_instance(struct trace_array
*tr
)
9717 /* Reference counter for a newly created trace array = 1. */
9718 if (tr
->ref
> 1 || (tr
->current_trace
&& tr
->trace_ref
))
9721 list_del(&tr
->list
);
9723 /* Disable all the flags that were enabled coming in */
9724 for (i
= 0; i
< TRACE_FLAGS_MAX_SIZE
; i
++) {
9725 if ((1 << i
) & ZEROED_TRACE_FLAGS
)
9726 set_tracer_flag(tr
, 1 << i
, 0);
9729 if (printk_trace
== tr
)
9730 update_printk_trace(&global_trace
);
9732 tracing_set_nop(tr
);
9733 clear_ftrace_function_probes(tr
);
9734 event_trace_del_tracer(tr
);
9735 ftrace_clear_pids(tr
);
9736 ftrace_destroy_function_files(tr
);
9737 tracefs_remove(tr
->dir
);
9738 free_percpu(tr
->last_func_repeats
);
9739 free_trace_buffers(tr
);
9740 clear_tracing_err_log(tr
);
9742 for (i
= 0; i
< tr
->nr_topts
; i
++) {
9743 kfree(tr
->topts
[i
].topts
);
9747 free_cpumask_var(tr
->pipe_cpumask
);
9748 free_cpumask_var(tr
->tracing_cpumask
);
9749 kfree_const(tr
->system_names
);
9756 int trace_array_destroy(struct trace_array
*this_tr
)
9758 struct trace_array
*tr
;
9764 mutex_lock(&event_mutex
);
9765 mutex_lock(&trace_types_lock
);
9769 /* Making sure trace array exists before destroying it. */
9770 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9771 if (tr
== this_tr
) {
9772 ret
= __remove_instance(tr
);
9777 mutex_unlock(&trace_types_lock
);
9778 mutex_unlock(&event_mutex
);
9782 EXPORT_SYMBOL_GPL(trace_array_destroy
);
9784 static int instance_rmdir(const char *name
)
9786 struct trace_array
*tr
;
9789 mutex_lock(&event_mutex
);
9790 mutex_lock(&trace_types_lock
);
9793 tr
= trace_array_find(name
);
9795 ret
= __remove_instance(tr
);
9797 mutex_unlock(&trace_types_lock
);
9798 mutex_unlock(&event_mutex
);
9803 static __init
void create_trace_instances(struct dentry
*d_tracer
)
9805 struct trace_array
*tr
;
9807 trace_instance_dir
= tracefs_create_instance_dir("instances", d_tracer
,
9810 if (MEM_FAIL(!trace_instance_dir
, "Failed to create instances directory\n"))
9813 mutex_lock(&event_mutex
);
9814 mutex_lock(&trace_types_lock
);
9816 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
9819 if (MEM_FAIL(trace_array_create_dir(tr
) < 0,
9820 "Failed to create instance directory\n"))
9824 mutex_unlock(&trace_types_lock
);
9825 mutex_unlock(&event_mutex
);
9829 init_tracer_tracefs(struct trace_array
*tr
, struct dentry
*d_tracer
)
9833 trace_create_file("available_tracers", TRACE_MODE_READ
, d_tracer
,
9834 tr
, &show_traces_fops
);
9836 trace_create_file("current_tracer", TRACE_MODE_WRITE
, d_tracer
,
9837 tr
, &set_tracer_fops
);
9839 trace_create_file("tracing_cpumask", TRACE_MODE_WRITE
, d_tracer
,
9840 tr
, &tracing_cpumask_fops
);
9842 trace_create_file("trace_options", TRACE_MODE_WRITE
, d_tracer
,
9843 tr
, &tracing_iter_fops
);
9845 trace_create_file("trace", TRACE_MODE_WRITE
, d_tracer
,
9848 trace_create_file("trace_pipe", TRACE_MODE_READ
, d_tracer
,
9849 tr
, &tracing_pipe_fops
);
9851 trace_create_file("buffer_size_kb", TRACE_MODE_WRITE
, d_tracer
,
9852 tr
, &tracing_entries_fops
);
9854 trace_create_file("buffer_total_size_kb", TRACE_MODE_READ
, d_tracer
,
9855 tr
, &tracing_total_entries_fops
);
9857 trace_create_file("free_buffer", 0200, d_tracer
,
9858 tr
, &tracing_free_buffer_fops
);
9860 trace_create_file("trace_marker", 0220, d_tracer
,
9861 tr
, &tracing_mark_fops
);
9863 tr
->trace_marker_file
= __find_event_file(tr
, "ftrace", "print");
9865 trace_create_file("trace_marker_raw", 0220, d_tracer
,
9866 tr
, &tracing_mark_raw_fops
);
9868 trace_create_file("trace_clock", TRACE_MODE_WRITE
, d_tracer
, tr
,
9871 trace_create_file("tracing_on", TRACE_MODE_WRITE
, d_tracer
,
9872 tr
, &rb_simple_fops
);
9874 trace_create_file("timestamp_mode", TRACE_MODE_READ
, d_tracer
, tr
,
9875 &trace_time_stamp_mode_fops
);
9877 tr
->buffer_percent
= 50;
9879 trace_create_file("buffer_percent", TRACE_MODE_WRITE
, d_tracer
,
9880 tr
, &buffer_percent_fops
);
9882 trace_create_file("buffer_subbuf_size_kb", TRACE_MODE_WRITE
, d_tracer
,
9883 tr
, &buffer_subbuf_size_fops
);
9885 create_trace_options_dir(tr
);
9887 #ifdef CONFIG_TRACER_MAX_TRACE
9888 trace_create_maxlat_file(tr
, d_tracer
);
9891 if (ftrace_create_function_files(tr
, d_tracer
))
9892 MEM_FAIL(1, "Could not allocate function filter files");
9894 if (tr
->range_addr_start
) {
9895 trace_create_file("last_boot_info", TRACE_MODE_READ
, d_tracer
,
9896 tr
, &last_boot_fops
);
9897 #ifdef CONFIG_TRACER_SNAPSHOT
9899 trace_create_file("snapshot", TRACE_MODE_WRITE
, d_tracer
,
9900 tr
, &snapshot_fops
);
9904 trace_create_file("error_log", TRACE_MODE_WRITE
, d_tracer
,
9905 tr
, &tracing_err_log_fops
);
9907 for_each_tracing_cpu(cpu
)
9908 tracing_init_tracefs_percpu(tr
, cpu
);
9910 ftrace_init_tracefs(tr
, d_tracer
);
9913 static struct vfsmount
*trace_automount(struct dentry
*mntpt
, void *ingore
)
9915 struct vfsmount
*mnt
;
9916 struct file_system_type
*type
;
9919 * To maintain backward compatibility for tools that mount
9920 * debugfs to get to the tracing facility, tracefs is automatically
9921 * mounted to the debugfs/tracing directory.
9923 type
= get_fs_type("tracefs");
9926 mnt
= vfs_submount(mntpt
, type
, "tracefs", NULL
);
9927 put_filesystem(type
);
9936 * tracing_init_dentry - initialize top level trace array
9938 * This is called when creating files or directories in the tracing
9939 * directory. It is called via fs_initcall() by any of the boot up code
9940 * and expects to return the dentry of the top level tracing directory.
9942 int tracing_init_dentry(void)
9944 struct trace_array
*tr
= &global_trace
;
9946 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
9947 pr_warn("Tracing disabled due to lockdown\n");
9951 /* The top level trace array uses NULL as parent */
9955 if (WARN_ON(!tracefs_initialized()))
9959 * As there may still be users that expect the tracing
9960 * files to exist in debugfs/tracing, we must automount
9961 * the tracefs file system there, so older tools still
9962 * work with the newer kernel.
9964 tr
->dir
= debugfs_create_automount("tracing", NULL
,
9965 trace_automount
, NULL
);
9970 extern struct trace_eval_map
*__start_ftrace_eval_maps
[];
9971 extern struct trace_eval_map
*__stop_ftrace_eval_maps
[];
9973 static struct workqueue_struct
*eval_map_wq __initdata
;
9974 static struct work_struct eval_map_work __initdata
;
9975 static struct work_struct tracerfs_init_work __initdata
;
9977 static void __init
eval_map_work_func(struct work_struct
*work
)
9981 len
= __stop_ftrace_eval_maps
- __start_ftrace_eval_maps
;
9982 trace_insert_eval_map(NULL
, __start_ftrace_eval_maps
, len
);
9985 static int __init
trace_eval_init(void)
9987 INIT_WORK(&eval_map_work
, eval_map_work_func
);
9989 eval_map_wq
= alloc_workqueue("eval_map_wq", WQ_UNBOUND
, 0);
9991 pr_err("Unable to allocate eval_map_wq\n");
9993 eval_map_work_func(&eval_map_work
);
9997 queue_work(eval_map_wq
, &eval_map_work
);
10001 subsys_initcall(trace_eval_init
);
10003 static int __init
trace_eval_sync(void)
10005 /* Make sure the eval map updates are finished */
10007 destroy_workqueue(eval_map_wq
);
10011 late_initcall_sync(trace_eval_sync
);
10014 #ifdef CONFIG_MODULES
10015 static void trace_module_add_evals(struct module
*mod
)
10017 if (!mod
->num_trace_evals
)
10021 * Modules with bad taint do not have events created, do
10022 * not bother with enums either.
10024 if (trace_module_has_bad_taint(mod
))
10027 trace_insert_eval_map(mod
, mod
->trace_evals
, mod
->num_trace_evals
);
10030 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
10031 static void trace_module_remove_evals(struct module
*mod
)
10033 union trace_eval_map_item
*map
;
10034 union trace_eval_map_item
**last
= &trace_eval_maps
;
10036 if (!mod
->num_trace_evals
)
10039 mutex_lock(&trace_eval_mutex
);
10041 map
= trace_eval_maps
;
10044 if (map
->head
.mod
== mod
)
10046 map
= trace_eval_jmp_to_tail(map
);
10047 last
= &map
->tail
.next
;
10048 map
= map
->tail
.next
;
10053 *last
= trace_eval_jmp_to_tail(map
)->tail
.next
;
10056 mutex_unlock(&trace_eval_mutex
);
10059 static inline void trace_module_remove_evals(struct module
*mod
) { }
10060 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
10062 static int trace_module_notify(struct notifier_block
*self
,
10063 unsigned long val
, void *data
)
10065 struct module
*mod
= data
;
10068 case MODULE_STATE_COMING
:
10069 trace_module_add_evals(mod
);
10071 case MODULE_STATE_GOING
:
10072 trace_module_remove_evals(mod
);
10079 static struct notifier_block trace_module_nb
= {
10080 .notifier_call
= trace_module_notify
,
10083 #endif /* CONFIG_MODULES */
10085 static __init
void tracer_init_tracefs_work_func(struct work_struct
*work
)
10088 event_trace_init();
10090 init_tracer_tracefs(&global_trace
, NULL
);
10091 ftrace_init_tracefs_toplevel(&global_trace
, NULL
);
10093 trace_create_file("tracing_thresh", TRACE_MODE_WRITE
, NULL
,
10094 &global_trace
, &tracing_thresh_fops
);
10096 trace_create_file("README", TRACE_MODE_READ
, NULL
,
10097 NULL
, &tracing_readme_fops
);
10099 trace_create_file("saved_cmdlines", TRACE_MODE_READ
, NULL
,
10100 NULL
, &tracing_saved_cmdlines_fops
);
10102 trace_create_file("saved_cmdlines_size", TRACE_MODE_WRITE
, NULL
,
10103 NULL
, &tracing_saved_cmdlines_size_fops
);
10105 trace_create_file("saved_tgids", TRACE_MODE_READ
, NULL
,
10106 NULL
, &tracing_saved_tgids_fops
);
10108 trace_create_eval_file(NULL
);
10110 #ifdef CONFIG_MODULES
10111 register_module_notifier(&trace_module_nb
);
10114 #ifdef CONFIG_DYNAMIC_FTRACE
10115 trace_create_file("dyn_ftrace_total_info", TRACE_MODE_READ
, NULL
,
10116 NULL
, &tracing_dyn_info_fops
);
10119 create_trace_instances(NULL
);
10121 update_tracer_options(&global_trace
);
10124 static __init
int tracer_init_tracefs(void)
10128 trace_access_lock_init();
10130 ret
= tracing_init_dentry();
10135 INIT_WORK(&tracerfs_init_work
, tracer_init_tracefs_work_func
);
10136 queue_work(eval_map_wq
, &tracerfs_init_work
);
10138 tracer_init_tracefs_work_func(NULL
);
10141 rv_init_interface();
10146 fs_initcall(tracer_init_tracefs
);
10148 static int trace_die_panic_handler(struct notifier_block
*self
,
10149 unsigned long ev
, void *unused
);
10151 static struct notifier_block trace_panic_notifier
= {
10152 .notifier_call
= trace_die_panic_handler
,
10153 .priority
= INT_MAX
- 1,
10156 static struct notifier_block trace_die_notifier
= {
10157 .notifier_call
= trace_die_panic_handler
,
10158 .priority
= INT_MAX
- 1,
10162 * The idea is to execute the following die/panic callback early, in order
10163 * to avoid showing irrelevant information in the trace (like other panic
10164 * notifier functions); we are the 2nd to run, after hung_task/rcu_stall
10165 * warnings get disabled (to prevent potential log flooding).
10167 static int trace_die_panic_handler(struct notifier_block
*self
,
10168 unsigned long ev
, void *unused
)
10170 if (!ftrace_dump_on_oops_enabled())
10171 return NOTIFY_DONE
;
10173 /* The die notifier requires DIE_OOPS to trigger */
10174 if (self
== &trace_die_notifier
&& ev
!= DIE_OOPS
)
10175 return NOTIFY_DONE
;
10177 ftrace_dump(DUMP_PARAM
);
10179 return NOTIFY_DONE
;
10183 * printk is set to max of 1024, we really don't need it that big.
10184 * Nothing should be printing 1000 characters anyway.
10186 #define TRACE_MAX_PRINT 1000
10189 * Define here KERN_TRACE so that we have one place to modify
10190 * it if we decide to change what log level the ftrace dump
10193 #define KERN_TRACE KERN_EMERG
10196 trace_printk_seq(struct trace_seq
*s
)
10198 /* Probably should print a warning here. */
10199 if (s
->seq
.len
>= TRACE_MAX_PRINT
)
10200 s
->seq
.len
= TRACE_MAX_PRINT
;
10203 * More paranoid code. Although the buffer size is set to
10204 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
10205 * an extra layer of protection.
10207 if (WARN_ON_ONCE(s
->seq
.len
>= s
->seq
.size
))
10208 s
->seq
.len
= s
->seq
.size
- 1;
10210 /* should be zero ended, but we are paranoid. */
10211 s
->buffer
[s
->seq
.len
] = 0;
10213 printk(KERN_TRACE
"%s", s
->buffer
);
10218 static void trace_init_iter(struct trace_iterator
*iter
, struct trace_array
*tr
)
10221 iter
->trace
= iter
->tr
->current_trace
;
10222 iter
->cpu_file
= RING_BUFFER_ALL_CPUS
;
10223 iter
->array_buffer
= &tr
->array_buffer
;
10225 if (iter
->trace
&& iter
->trace
->open
)
10226 iter
->trace
->open(iter
);
10228 /* Annotate start of buffers if we had overruns */
10229 if (ring_buffer_overruns(iter
->array_buffer
->buffer
))
10230 iter
->iter_flags
|= TRACE_FILE_ANNOTATE
;
10232 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
10233 if (trace_clocks
[iter
->tr
->clock_id
].in_ns
)
10234 iter
->iter_flags
|= TRACE_FILE_TIME_IN_NS
;
10236 /* Can not use kmalloc for iter.temp and iter.fmt */
10237 iter
->temp
= static_temp_buf
;
10238 iter
->temp_size
= STATIC_TEMP_BUF_SIZE
;
10239 iter
->fmt
= static_fmt_buf
;
10240 iter
->fmt_size
= STATIC_FMT_BUF_SIZE
;
10243 void trace_init_global_iter(struct trace_iterator
*iter
)
10245 trace_init_iter(iter
, &global_trace
);
10248 static void ftrace_dump_one(struct trace_array
*tr
, enum ftrace_dump_mode dump_mode
)
10250 /* use static because iter can be a bit big for the stack */
10251 static struct trace_iterator iter
;
10252 unsigned int old_userobj
;
10253 unsigned long flags
;
10257 * Always turn off tracing when we dump.
10258 * We don't need to show trace output of what happens
10259 * between multiple crashes.
10261 * If the user does a sysrq-z, then they can re-enable
10262 * tracing with echo 1 > tracing_on.
10264 tracer_tracing_off(tr
);
10266 local_irq_save(flags
);
10268 /* Simulate the iterator */
10269 trace_init_iter(&iter
, tr
);
10271 for_each_tracing_cpu(cpu
) {
10272 atomic_inc(&per_cpu_ptr(iter
.array_buffer
->data
, cpu
)->disabled
);
10275 old_userobj
= tr
->trace_flags
& TRACE_ITER_SYM_USEROBJ
;
10277 /* don't look at user memory in panic mode */
10278 tr
->trace_flags
&= ~TRACE_ITER_SYM_USEROBJ
;
10280 if (dump_mode
== DUMP_ORIG
)
10281 iter
.cpu_file
= raw_smp_processor_id();
10283 iter
.cpu_file
= RING_BUFFER_ALL_CPUS
;
10285 if (tr
== &global_trace
)
10286 printk(KERN_TRACE
"Dumping ftrace buffer:\n");
10288 printk(KERN_TRACE
"Dumping ftrace instance %s buffer:\n", tr
->name
);
10290 /* Did function tracer already get disabled? */
10291 if (ftrace_is_dead()) {
10292 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
10293 printk("# MAY BE MISSING FUNCTION EVENTS\n");
10297 * We need to stop all tracing on all CPUS to read
10298 * the next buffer. This is a bit expensive, but is
10299 * not done often. We fill all what we can read,
10300 * and then release the locks again.
10303 while (!trace_empty(&iter
)) {
10306 printk(KERN_TRACE
"---------------------------------\n");
10310 trace_iterator_reset(&iter
);
10311 iter
.iter_flags
|= TRACE_FILE_LAT_FMT
;
10313 if (trace_find_next_entry_inc(&iter
) != NULL
) {
10316 ret
= print_trace_line(&iter
);
10317 if (ret
!= TRACE_TYPE_NO_CONSUME
)
10318 trace_consume(&iter
);
10320 touch_nmi_watchdog();
10322 trace_printk_seq(&iter
.seq
);
10326 printk(KERN_TRACE
" (ftrace buffer empty)\n");
10328 printk(KERN_TRACE
"---------------------------------\n");
10330 tr
->trace_flags
|= old_userobj
;
10332 for_each_tracing_cpu(cpu
) {
10333 atomic_dec(&per_cpu_ptr(iter
.array_buffer
->data
, cpu
)->disabled
);
10335 local_irq_restore(flags
);
10338 static void ftrace_dump_by_param(void)
10340 bool first_param
= true;
10341 char dump_param
[MAX_TRACER_SIZE
];
10342 char *buf
, *token
, *inst_name
;
10343 struct trace_array
*tr
;
10345 strscpy(dump_param
, ftrace_dump_on_oops
, MAX_TRACER_SIZE
);
10348 while ((token
= strsep(&buf
, ",")) != NULL
) {
10350 first_param
= false;
10351 if (!strcmp("0", token
))
10353 else if (!strcmp("1", token
)) {
10354 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10357 else if (!strcmp("2", token
) ||
10358 !strcmp("orig_cpu", token
)) {
10359 ftrace_dump_one(&global_trace
, DUMP_ORIG
);
10364 inst_name
= strsep(&token
, "=");
10365 tr
= trace_array_find(inst_name
);
10367 printk(KERN_TRACE
"Instance %s not found\n", inst_name
);
10371 if (token
&& (!strcmp("2", token
) ||
10372 !strcmp("orig_cpu", token
)))
10373 ftrace_dump_one(tr
, DUMP_ORIG
);
10375 ftrace_dump_one(tr
, DUMP_ALL
);
10379 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode
)
10381 static atomic_t dump_running
;
10383 /* Only allow one dump user at a time. */
10384 if (atomic_inc_return(&dump_running
) != 1) {
10385 atomic_dec(&dump_running
);
10389 switch (oops_dump_mode
) {
10391 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10394 ftrace_dump_one(&global_trace
, DUMP_ORIG
);
10397 ftrace_dump_by_param();
10402 printk(KERN_TRACE
"Bad dumping mode, switching to all CPUs dump\n");
10403 ftrace_dump_one(&global_trace
, DUMP_ALL
);
10406 atomic_dec(&dump_running
);
10408 EXPORT_SYMBOL_GPL(ftrace_dump
);
10410 #define WRITE_BUFSIZE 4096
10412 ssize_t
trace_parse_run_command(struct file
*file
, const char __user
*buffer
,
10413 size_t count
, loff_t
*ppos
,
10414 int (*createfn
)(const char *))
10416 char *kbuf
, *buf
, *tmp
;
10421 kbuf
= kmalloc(WRITE_BUFSIZE
, GFP_KERNEL
);
10425 while (done
< count
) {
10426 size
= count
- done
;
10428 if (size
>= WRITE_BUFSIZE
)
10429 size
= WRITE_BUFSIZE
- 1;
10431 if (copy_from_user(kbuf
, buffer
+ done
, size
)) {
10438 tmp
= strchr(buf
, '\n');
10441 size
= tmp
- buf
+ 1;
10443 size
= strlen(buf
);
10444 if (done
+ size
< count
) {
10447 /* This can accept WRITE_BUFSIZE - 2 ('\n' + '\0') */
10448 pr_warn("Line length is too long: Should be less than %d\n",
10449 WRITE_BUFSIZE
- 2);
10456 /* Remove comments */
10457 tmp
= strchr(buf
, '#');
10462 ret
= createfn(buf
);
10467 } while (done
< count
);
10477 #ifdef CONFIG_TRACER_MAX_TRACE
10478 __init
static bool tr_needs_alloc_snapshot(const char *name
)
10481 int len
= strlen(name
);
10484 if (!boot_snapshot_index
)
10487 if (strncmp(name
, boot_snapshot_info
, len
) == 0 &&
10488 boot_snapshot_info
[len
] == '\t')
10491 test
= kmalloc(strlen(name
) + 3, GFP_KERNEL
);
10495 sprintf(test
, "\t%s\t", name
);
10496 ret
= strstr(boot_snapshot_info
, test
) == NULL
;
10501 __init
static void do_allocate_snapshot(const char *name
)
10503 if (!tr_needs_alloc_snapshot(name
))
10507 * When allocate_snapshot is set, the next call to
10508 * allocate_trace_buffers() (called by trace_array_get_by_name())
10509 * will allocate the snapshot buffer. That will alse clear
10512 allocate_snapshot
= true;
10515 static inline void do_allocate_snapshot(const char *name
) { }
10518 __init
static void enable_instances(void)
10520 struct trace_array
*tr
;
10526 /* A tab is always appended */
10527 boot_instance_info
[boot_instance_index
- 1] = '\0';
10528 str
= boot_instance_info
;
10530 while ((curr_str
= strsep(&str
, "\t"))) {
10531 phys_addr_t start
= 0;
10532 phys_addr_t size
= 0;
10533 unsigned long addr
= 0;
10534 bool traceprintk
= false;
10535 bool traceoff
= false;
10539 tok
= strsep(&curr_str
, ",");
10541 flag_delim
= strchr(tok
, '^');
10542 addr_delim
= strchr(tok
, '@');
10545 *addr_delim
++ = '\0';
10548 *flag_delim
++ = '\0';
10555 while ((flag
= strsep(&flag_delim
, "^"))) {
10556 if (strcmp(flag
, "traceoff") == 0) {
10558 } else if ((strcmp(flag
, "printk") == 0) ||
10559 (strcmp(flag
, "traceprintk") == 0) ||
10560 (strcmp(flag
, "trace_printk") == 0)) {
10561 traceprintk
= true;
10563 pr_info("Tracing: Invalid instance flag '%s' for %s\n",
10570 if (tok
&& isdigit(*tok
)) {
10571 start
= memparse(tok
, &tok
);
10573 pr_warn("Tracing: Invalid boot instance address for %s\n",
10578 pr_warn("Tracing: No size specified for instance %s\n", name
);
10582 size
= memparse(tok
, &tok
);
10584 pr_warn("Tracing: Invalid boot instance size for %s\n",
10589 if (!reserve_mem_find_by_name(tok
, &start
, &size
)) {
10591 pr_warn("Failed to map boot instance %s to %s\n", name
, tok
);
10597 addr
= map_pages(start
, size
);
10599 pr_info("Tracing: mapped boot instance %s at physical memory %pa of size 0x%lx\n",
10600 name
, &start
, (unsigned long)size
);
10602 pr_warn("Tracing: Failed to map boot instance %s\n", name
);
10606 /* Only non mapped buffers have snapshot buffers */
10607 if (IS_ENABLED(CONFIG_TRACER_MAX_TRACE
))
10608 do_allocate_snapshot(name
);
10611 tr
= trace_array_create_systems(name
, NULL
, addr
, size
);
10613 pr_warn("Tracing: Failed to create instance buffer %s\n", curr_str
);
10618 tracer_tracing_off(tr
);
10621 update_printk_trace(tr
);
10624 * If start is set, then this is a mapped buffer, and
10625 * cannot be deleted by user space, so keep the reference
10629 tr
->flags
|= TRACE_ARRAY_FL_BOOT
;
10633 while ((tok
= strsep(&curr_str
, ","))) {
10634 early_enable_events(tr
, tok
, true);
10639 __init
static int tracer_alloc_buffers(void)
10645 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
10646 pr_warn("Tracing disabled due to lockdown\n");
10651 * Make sure we don't accidentally add more trace options
10652 * than we have bits for.
10654 BUILD_BUG_ON(TRACE_ITER_LAST_BIT
> TRACE_FLAGS_MAX_SIZE
);
10656 if (!alloc_cpumask_var(&tracing_buffer_mask
, GFP_KERNEL
))
10659 if (!alloc_cpumask_var(&global_trace
.tracing_cpumask
, GFP_KERNEL
))
10660 goto out_free_buffer_mask
;
10662 /* Only allocate trace_printk buffers if a trace_printk exists */
10663 if (&__stop___trace_bprintk_fmt
!= &__start___trace_bprintk_fmt
)
10664 /* Must be called before global_trace.buffer is allocated */
10665 trace_printk_init_buffers();
10667 /* To save memory, keep the ring buffer size to its minimum */
10668 if (global_trace
.ring_buffer_expanded
)
10669 ring_buf_size
= trace_buf_size
;
10673 cpumask_copy(tracing_buffer_mask
, cpu_possible_mask
);
10674 cpumask_copy(global_trace
.tracing_cpumask
, cpu_all_mask
);
10676 raw_spin_lock_init(&global_trace
.start_lock
);
10679 * The prepare callbacks allocates some memory for the ring buffer. We
10680 * don't free the buffer if the CPU goes down. If we were to free
10681 * the buffer, then the user would lose any trace that was in the
10682 * buffer. The memory will be removed once the "instance" is removed.
10684 ret
= cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE
,
10685 "trace/RB:prepare", trace_rb_cpu_prepare
,
10688 goto out_free_cpumask
;
10689 /* Used for event triggers */
10691 temp_buffer
= ring_buffer_alloc(PAGE_SIZE
, RB_FL_OVERWRITE
);
10693 goto out_rm_hp_state
;
10695 if (trace_create_savedcmd() < 0)
10696 goto out_free_temp_buffer
;
10698 if (!zalloc_cpumask_var(&global_trace
.pipe_cpumask
, GFP_KERNEL
))
10699 goto out_free_savedcmd
;
10701 /* TODO: make the number of buffers hot pluggable with CPUS */
10702 if (allocate_trace_buffers(&global_trace
, ring_buf_size
) < 0) {
10703 MEM_FAIL(1, "tracer: failed to allocate ring buffer!\n");
10704 goto out_free_pipe_cpumask
;
10706 if (global_trace
.buffer_disabled
)
10709 if (trace_boot_clock
) {
10710 ret
= tracing_set_clock(&global_trace
, trace_boot_clock
);
10712 pr_warn("Trace clock %s not defined, going back to default\n",
10717 * register_tracer() might reference current_trace, so it
10718 * needs to be set before we register anything. This is
10719 * just a bootstrap of current_trace anyway.
10721 global_trace
.current_trace
= &nop_trace
;
10723 global_trace
.max_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
10724 #ifdef CONFIG_TRACER_MAX_TRACE
10725 spin_lock_init(&global_trace
.snapshot_trigger_lock
);
10727 ftrace_init_global_array_ops(&global_trace
);
10729 init_trace_flags_index(&global_trace
);
10731 register_tracer(&nop_trace
);
10733 /* Function tracing may start here (via kernel command line) */
10734 init_function_trace();
10736 /* All seems OK, enable tracing */
10737 tracing_disabled
= 0;
10739 atomic_notifier_chain_register(&panic_notifier_list
,
10740 &trace_panic_notifier
);
10742 register_die_notifier(&trace_die_notifier
);
10744 global_trace
.flags
= TRACE_ARRAY_FL_GLOBAL
;
10746 INIT_LIST_HEAD(&global_trace
.systems
);
10747 INIT_LIST_HEAD(&global_trace
.events
);
10748 INIT_LIST_HEAD(&global_trace
.hist_vars
);
10749 INIT_LIST_HEAD(&global_trace
.err_log
);
10750 list_add(&global_trace
.list
, &ftrace_trace_arrays
);
10752 apply_trace_boot_options();
10754 register_snapshot_cmd();
10760 out_free_pipe_cpumask
:
10761 free_cpumask_var(global_trace
.pipe_cpumask
);
10763 trace_free_saved_cmdlines_buffer();
10764 out_free_temp_buffer
:
10765 ring_buffer_free(temp_buffer
);
10767 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE
);
10769 free_cpumask_var(global_trace
.tracing_cpumask
);
10770 out_free_buffer_mask
:
10771 free_cpumask_var(tracing_buffer_mask
);
10776 void __init
ftrace_boot_snapshot(void)
10778 #ifdef CONFIG_TRACER_MAX_TRACE
10779 struct trace_array
*tr
;
10781 if (!snapshot_at_boot
)
10784 list_for_each_entry(tr
, &ftrace_trace_arrays
, list
) {
10785 if (!tr
->allocated_snapshot
)
10788 tracing_snapshot_instance(tr
);
10789 trace_array_puts(tr
, "** Boot snapshot taken **\n");
10794 void __init
early_trace_init(void)
10796 if (tracepoint_printk
) {
10797 tracepoint_print_iter
=
10798 kzalloc(sizeof(*tracepoint_print_iter
), GFP_KERNEL
);
10799 if (MEM_FAIL(!tracepoint_print_iter
,
10800 "Failed to allocate trace iterator\n"))
10801 tracepoint_printk
= 0;
10803 static_key_enable(&tracepoint_printk_key
.key
);
10805 tracer_alloc_buffers();
10810 void __init
trace_init(void)
10812 trace_event_init();
10814 if (boot_instance_index
)
10815 enable_instances();
10818 __init
static void clear_boot_tracer(void)
10821 * The default tracer at boot buffer is an init section.
10822 * This function is called in lateinit. If we did not
10823 * find the boot tracer, then clear it out, to prevent
10824 * later registration from accessing the buffer that is
10825 * about to be freed.
10827 if (!default_bootup_tracer
)
10830 printk(KERN_INFO
"ftrace bootup tracer '%s' not registered.\n",
10831 default_bootup_tracer
);
10832 default_bootup_tracer
= NULL
;
10835 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
10836 __init
static void tracing_set_default_clock(void)
10838 /* sched_clock_stable() is determined in late_initcall */
10839 if (!trace_boot_clock
&& !sched_clock_stable()) {
10840 if (security_locked_down(LOCKDOWN_TRACEFS
)) {
10841 pr_warn("Can not set tracing clock due to lockdown\n");
10845 printk(KERN_WARNING
10846 "Unstable clock detected, switching default tracing clock to \"global\"\n"
10847 "If you want to keep using the local clock, then add:\n"
10848 " \"trace_clock=local\"\n"
10849 "on the kernel command line\n");
10850 tracing_set_clock(&global_trace
, "global");
10854 static inline void tracing_set_default_clock(void) { }
10857 __init
static int late_trace_init(void)
10859 if (tracepoint_printk
&& tracepoint_printk_stop_on_boot
) {
10860 static_key_disable(&tracepoint_printk_key
.key
);
10861 tracepoint_printk
= 0;
10864 tracing_set_default_clock();
10865 clear_boot_tracer();
10869 late_initcall_sync(late_trace_init
);