1 // SPDX-License-Identifier: GPL-2.0
3 * ring buffer based function tracer
8 * Originally taken from the RT patch by:
11 * Based on code from the latency_tracer, that is:
12 * Copyright (C) 2004-2006 Ingo Molnar
13 * Copyright (C) 2004 Nadia Yvette Chambers
15 #include <linux/ring_buffer.h>
16 #include <linux/utsname.h>
17 #include <linux/stacktrace.h>
18 #include <linux/writeback.h>
19 #include <linux/kallsyms.h>
20 #include <linux/security.h>
21 #include <linux/seq_file.h>
22 #include <linux/irqflags.h>
23 #include <linux/debugfs.h>
24 #include <linux/tracefs.h>
25 #include <linux/pagemap.h>
26 #include <linux/hardirq.h>
27 #include <linux/linkage.h>
28 #include <linux/uaccess.h>
29 #include <linux/vmalloc.h>
30 #include <linux/ftrace.h>
31 #include <linux/module.h>
32 #include <linux/percpu.h>
33 #include <linux/splice.h>
34 #include <linux/kdebug.h>
35 #include <linux/string.h>
36 #include <linux/mount.h>
37 #include <linux/rwsem.h>
38 #include <linux/slab.h>
39 #include <linux/ctype.h>
40 #include <linux/init.h>
41 #include <linux/panic_notifier.h>
42 #include <linux/poll.h>
43 #include <linux/nmi.h>
45 #include <linux/trace.h>
46 #include <linux/sched/clock.h>
47 #include <linux/sched/rt.h>
48 #include <linux/fsnotify.h>
49 #include <linux/irq_work.h>
50 #include <linux/workqueue.h>
52 #include <asm/setup.h> /* COMMAND_LINE_SIZE */
55 #include "trace_output.h"
57 #ifdef CONFIG_FTRACE_STARTUP_TEST
59 * We need to change this state when a selftest is running.
60 * A selftest will lurk into the ring-buffer to count the
61 * entries inserted during the selftest although some concurrent
62 * insertions into the ring-buffer such as trace_printk could occurred
63 * at the same time, giving false positive or negative results.
65 static bool __read_mostly tracing_selftest_running;
68 * If boot-time tracing including tracers/events via kernel cmdline
69 * is running, we do not want to run SELFTEST.
71 bool __read_mostly tracing_selftest_disabled;
73 void __init disable_tracing_selftest(const char *reason)
75 if (!tracing_selftest_disabled) {
76 tracing_selftest_disabled = true;
77 pr_info("Ftrace startup test is disabled due to %s\n", reason);
81 #define tracing_selftest_running 0
82 #define tracing_selftest_disabled 0
85 /* Pipe tracepoints to printk */
86 static struct trace_iterator *tracepoint_print_iter;
87 int tracepoint_printk;
88 static bool tracepoint_printk_stop_on_boot __initdata;
89 static DEFINE_STATIC_KEY_FALSE(tracepoint_printk_key);
91 /* For tracers that don't implement custom flags */
92 static struct tracer_opt dummy_tracer_opt[] = {
97 dummy_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
103 * To prevent the comm cache from being overwritten when no
104 * tracing is active, only save the comm when a trace event
107 DEFINE_PER_CPU(bool, trace_taskinfo_save);
110 * Kill all tracing for good (never come back).
111 * It is initialized to 1 but will turn to zero if the initialization
112 * of the tracer is successful. But that is the only place that sets
115 static int tracing_disabled = 1;
117 cpumask_var_t __read_mostly tracing_buffer_mask;
120 * ftrace_dump_on_oops - variable to dump ftrace buffer on oops
122 * If there is an oops (or kernel panic) and the ftrace_dump_on_oops
123 * is set, then ftrace_dump is called. This will output the contents
124 * of the ftrace buffers to the console. This is very useful for
125 * capturing traces that lead to crashes and outputing it to a
128 * It is default off, but you can enable it with either specifying
129 * "ftrace_dump_on_oops" in the kernel command line, or setting
130 * /proc/sys/kernel/ftrace_dump_on_oops
131 * Set 1 if you want to dump buffers of all CPUs
132 * Set 2 if you want to dump the buffer of the CPU that triggered oops
133 * Set instance name if you want to dump the specific trace instance
134 * Multiple instance dump is also supported, and instances are seperated
137 /* Set to string format zero to disable by default */
138 char ftrace_dump_on_oops[MAX_TRACER_SIZE] = "0";
140 /* When set, tracing will stop when a WARN*() is hit */
141 int __disable_trace_on_warning;
143 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
144 /* Map of enums to their values, for "eval_map" file */
145 struct trace_eval_map_head {
147 unsigned long length;
150 union trace_eval_map_item;
152 struct trace_eval_map_tail {
154 * "end" is first and points to NULL as it must be different
155 * than "mod" or "eval_string"
157 union trace_eval_map_item *next;
158 const char *end; /* points to NULL */
161 static DEFINE_MUTEX(trace_eval_mutex);
164 * The trace_eval_maps are saved in an array with two extra elements,
165 * one at the beginning, and one at the end. The beginning item contains
166 * the count of the saved maps (head.length), and the module they
167 * belong to if not built in (head.mod). The ending item contains a
168 * pointer to the next array of saved eval_map items.
170 union trace_eval_map_item {
171 struct trace_eval_map map;
172 struct trace_eval_map_head head;
173 struct trace_eval_map_tail tail;
176 static union trace_eval_map_item *trace_eval_maps;
177 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
179 int tracing_set_tracer(struct trace_array *tr, const char *buf);
180 static void ftrace_trace_userstack(struct trace_array *tr,
181 struct trace_buffer *buffer,
182 unsigned int trace_ctx);
184 static char bootup_tracer_buf[MAX_TRACER_SIZE] __initdata;
185 static char *default_bootup_tracer;
187 static bool allocate_snapshot;
188 static bool snapshot_at_boot;
190 static char boot_instance_info[COMMAND_LINE_SIZE] __initdata;
191 static int boot_instance_index;
193 static char boot_snapshot_info[COMMAND_LINE_SIZE] __initdata;
194 static int boot_snapshot_index;
196 static int __init set_cmdline_ftrace(char *str)
198 strscpy(bootup_tracer_buf, str, MAX_TRACER_SIZE);
199 default_bootup_tracer = bootup_tracer_buf;
200 /* We are using ftrace early, expand it */
201 trace_set_ring_buffer_expanded(NULL);
204 __setup("ftrace=", set_cmdline_ftrace);
206 int ftrace_dump_on_oops_enabled(void)
208 if (!strcmp("0", ftrace_dump_on_oops))
214 static int __init set_ftrace_dump_on_oops(char *str)
217 strscpy(ftrace_dump_on_oops, "1", MAX_TRACER_SIZE);
222 strscpy(ftrace_dump_on_oops, "1", MAX_TRACER_SIZE);
223 strscpy(ftrace_dump_on_oops + 1, str, MAX_TRACER_SIZE - 1);
228 strscpy(ftrace_dump_on_oops, str, MAX_TRACER_SIZE);
234 __setup("ftrace_dump_on_oops", set_ftrace_dump_on_oops);
236 static int __init stop_trace_on_warning(char *str)
238 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
239 __disable_trace_on_warning = 1;
242 __setup("traceoff_on_warning", stop_trace_on_warning);
244 static int __init boot_alloc_snapshot(char *str)
246 char *slot = boot_snapshot_info + boot_snapshot_index;
247 int left = sizeof(boot_snapshot_info) - boot_snapshot_index;
252 if (strlen(str) >= left)
255 ret = snprintf(slot, left, "%s\t", str);
256 boot_snapshot_index += ret;
258 allocate_snapshot = true;
259 /* We also need the main ring buffer expanded */
260 trace_set_ring_buffer_expanded(NULL);
264 __setup("alloc_snapshot", boot_alloc_snapshot);
267 static int __init boot_snapshot(char *str)
269 snapshot_at_boot = true;
270 boot_alloc_snapshot(str);
273 __setup("ftrace_boot_snapshot", boot_snapshot);
276 static int __init boot_instance(char *str)
278 char *slot = boot_instance_info + boot_instance_index;
279 int left = sizeof(boot_instance_info) - boot_instance_index;
282 if (strlen(str) >= left)
285 ret = snprintf(slot, left, "%s\t", str);
286 boot_instance_index += ret;
290 __setup("trace_instance=", boot_instance);
293 static char trace_boot_options_buf[MAX_TRACER_SIZE] __initdata;
295 static int __init set_trace_boot_options(char *str)
297 strscpy(trace_boot_options_buf, str, MAX_TRACER_SIZE);
300 __setup("trace_options=", set_trace_boot_options);
302 static char trace_boot_clock_buf[MAX_TRACER_SIZE] __initdata;
303 static char *trace_boot_clock __initdata;
305 static int __init set_trace_boot_clock(char *str)
307 strscpy(trace_boot_clock_buf, str, MAX_TRACER_SIZE);
308 trace_boot_clock = trace_boot_clock_buf;
311 __setup("trace_clock=", set_trace_boot_clock);
313 static int __init set_tracepoint_printk(char *str)
315 /* Ignore the "tp_printk_stop_on_boot" param */
319 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
320 tracepoint_printk = 1;
323 __setup("tp_printk", set_tracepoint_printk);
325 static int __init set_tracepoint_printk_stop(char *str)
327 tracepoint_printk_stop_on_boot = true;
330 __setup("tp_printk_stop_on_boot", set_tracepoint_printk_stop);
332 unsigned long long ns2usecs(u64 nsec)
340 trace_process_export(struct trace_export *export,
341 struct ring_buffer_event *event, int flag)
343 struct trace_entry *entry;
344 unsigned int size = 0;
346 if (export->flags & flag) {
347 entry = ring_buffer_event_data(event);
348 size = ring_buffer_event_length(event);
349 export->write(export, entry, size);
353 static DEFINE_MUTEX(ftrace_export_lock);
355 static struct trace_export __rcu *ftrace_exports_list __read_mostly;
357 static DEFINE_STATIC_KEY_FALSE(trace_function_exports_enabled);
358 static DEFINE_STATIC_KEY_FALSE(trace_event_exports_enabled);
359 static DEFINE_STATIC_KEY_FALSE(trace_marker_exports_enabled);
361 static inline void ftrace_exports_enable(struct trace_export *export)
363 if (export->flags & TRACE_EXPORT_FUNCTION)
364 static_branch_inc(&trace_function_exports_enabled);
366 if (export->flags & TRACE_EXPORT_EVENT)
367 static_branch_inc(&trace_event_exports_enabled);
369 if (export->flags & TRACE_EXPORT_MARKER)
370 static_branch_inc(&trace_marker_exports_enabled);
373 static inline void ftrace_exports_disable(struct trace_export *export)
375 if (export->flags & TRACE_EXPORT_FUNCTION)
376 static_branch_dec(&trace_function_exports_enabled);
378 if (export->flags & TRACE_EXPORT_EVENT)
379 static_branch_dec(&trace_event_exports_enabled);
381 if (export->flags & TRACE_EXPORT_MARKER)
382 static_branch_dec(&trace_marker_exports_enabled);
385 static void ftrace_exports(struct ring_buffer_event *event, int flag)
387 struct trace_export *export;
389 preempt_disable_notrace();
391 export = rcu_dereference_raw_check(ftrace_exports_list);
393 trace_process_export(export, event, flag);
394 export = rcu_dereference_raw_check(export->next);
397 preempt_enable_notrace();
401 add_trace_export(struct trace_export **list, struct trace_export *export)
403 rcu_assign_pointer(export->next, *list);
405 * We are entering export into the list but another
406 * CPU might be walking that list. We need to make sure
407 * the export->next pointer is valid before another CPU sees
408 * the export pointer included into the list.
410 rcu_assign_pointer(*list, export);
414 rm_trace_export(struct trace_export **list, struct trace_export *export)
416 struct trace_export **p;
418 for (p = list; *p != NULL; p = &(*p)->next)
425 rcu_assign_pointer(*p, (*p)->next);
431 add_ftrace_export(struct trace_export **list, struct trace_export *export)
433 ftrace_exports_enable(export);
435 add_trace_export(list, export);
439 rm_ftrace_export(struct trace_export **list, struct trace_export *export)
443 ret = rm_trace_export(list, export);
444 ftrace_exports_disable(export);
449 int register_ftrace_export(struct trace_export *export)
451 if (WARN_ON_ONCE(!export->write))
454 mutex_lock(&ftrace_export_lock);
456 add_ftrace_export(&ftrace_exports_list, export);
458 mutex_unlock(&ftrace_export_lock);
462 EXPORT_SYMBOL_GPL(register_ftrace_export);
464 int unregister_ftrace_export(struct trace_export *export)
468 mutex_lock(&ftrace_export_lock);
470 ret = rm_ftrace_export(&ftrace_exports_list, export);
472 mutex_unlock(&ftrace_export_lock);
476 EXPORT_SYMBOL_GPL(unregister_ftrace_export);
478 /* trace_flags holds trace_options default values */
479 #define TRACE_DEFAULT_FLAGS \
480 (FUNCTION_DEFAULT_FLAGS | \
481 TRACE_ITER_PRINT_PARENT | TRACE_ITER_PRINTK | \
482 TRACE_ITER_ANNOTATE | TRACE_ITER_CONTEXT_INFO | \
483 TRACE_ITER_RECORD_CMD | TRACE_ITER_OVERWRITE | \
484 TRACE_ITER_IRQ_INFO | TRACE_ITER_MARKERS | \
485 TRACE_ITER_HASH_PTR | TRACE_ITER_TRACE_PRINTK)
487 /* trace_options that are only supported by global_trace */
488 #define TOP_LEVEL_TRACE_FLAGS (TRACE_ITER_PRINTK | \
489 TRACE_ITER_PRINTK_MSGONLY | TRACE_ITER_RECORD_CMD)
491 /* trace_flags that are default zero for instances */
492 #define ZEROED_TRACE_FLAGS \
493 (TRACE_ITER_EVENT_FORK | TRACE_ITER_FUNC_FORK | TRACE_ITER_TRACE_PRINTK)
496 * The global_trace is the descriptor that holds the top-level tracing
497 * buffers for the live tracing.
499 static struct trace_array global_trace = {
500 .trace_flags = TRACE_DEFAULT_FLAGS,
503 static struct trace_array *printk_trace = &global_trace;
505 static __always_inline bool printk_binsafe(struct trace_array *tr)
508 * The binary format of traceprintk can cause a crash if used
509 * by a buffer from another boot. Force the use of the
510 * non binary version of trace_printk if the trace_printk
511 * buffer is a boot mapped ring buffer.
513 return !(tr->flags & TRACE_ARRAY_FL_BOOT);
516 static void update_printk_trace(struct trace_array *tr)
518 if (printk_trace == tr)
521 printk_trace->trace_flags &= ~TRACE_ITER_TRACE_PRINTK;
523 tr->trace_flags |= TRACE_ITER_TRACE_PRINTK;
526 void trace_set_ring_buffer_expanded(struct trace_array *tr)
530 tr->ring_buffer_expanded = true;
533 LIST_HEAD(ftrace_trace_arrays);
535 int trace_array_get(struct trace_array *this_tr)
537 struct trace_array *tr;
540 mutex_lock(&trace_types_lock);
541 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
548 mutex_unlock(&trace_types_lock);
553 static void __trace_array_put(struct trace_array *this_tr)
555 WARN_ON(!this_tr->ref);
560 * trace_array_put - Decrement the reference counter for this trace array.
561 * @this_tr : pointer to the trace array
563 * NOTE: Use this when we no longer need the trace array returned by
564 * trace_array_get_by_name(). This ensures the trace array can be later
568 void trace_array_put(struct trace_array *this_tr)
573 mutex_lock(&trace_types_lock);
574 __trace_array_put(this_tr);
575 mutex_unlock(&trace_types_lock);
577 EXPORT_SYMBOL_GPL(trace_array_put);
579 int tracing_check_open_get_tr(struct trace_array *tr)
583 ret = security_locked_down(LOCKDOWN_TRACEFS);
587 if (tracing_disabled)
590 if (tr && trace_array_get(tr) < 0)
597 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
598 * @filtered_pids: The list of pids to check
599 * @search_pid: The PID to find in @filtered_pids
601 * Returns true if @search_pid is found in @filtered_pids, and false otherwise.
604 trace_find_filtered_pid(struct trace_pid_list *filtered_pids, pid_t search_pid)
606 return trace_pid_list_is_set(filtered_pids, search_pid);
610 * trace_ignore_this_task - should a task be ignored for tracing
611 * @filtered_pids: The list of pids to check
612 * @filtered_no_pids: The list of pids not to be traced
613 * @task: The task that should be ignored if not filtered
615 * Checks if @task should be traced or not from @filtered_pids.
616 * Returns true if @task should *NOT* be traced.
617 * Returns false if @task should be traced.
620 trace_ignore_this_task(struct trace_pid_list *filtered_pids,
621 struct trace_pid_list *filtered_no_pids,
622 struct task_struct *task)
625 * If filtered_no_pids is not empty, and the task's pid is listed
626 * in filtered_no_pids, then return true.
627 * Otherwise, if filtered_pids is empty, that means we can
628 * trace all tasks. If it has content, then only trace pids
629 * within filtered_pids.
632 return (filtered_pids &&
633 !trace_find_filtered_pid(filtered_pids, task->pid)) ||
635 trace_find_filtered_pid(filtered_no_pids, task->pid));
639 * trace_filter_add_remove_task - Add or remove a task from a pid_list
640 * @pid_list: The list to modify
641 * @self: The current task for fork or NULL for exit
642 * @task: The task to add or remove
644 * If adding a task, if @self is defined, the task is only added if @self
645 * is also included in @pid_list. This happens on fork and tasks should
646 * only be added when the parent is listed. If @self is NULL, then the
647 * @task pid will be removed from the list, which would happen on exit
650 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
651 struct task_struct *self,
652 struct task_struct *task)
657 /* For forks, we only add if the forking task is listed */
659 if (!trace_find_filtered_pid(pid_list, self->pid))
663 /* "self" is set for forks, and NULL for exits */
665 trace_pid_list_set(pid_list, task->pid);
667 trace_pid_list_clear(pid_list, task->pid);
671 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
672 * @pid_list: The pid list to show
673 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
674 * @pos: The position of the file
676 * This is used by the seq_file "next" operation to iterate the pids
677 * listed in a trace_pid_list structure.
679 * Returns the pid+1 as we want to display pid of zero, but NULL would
680 * stop the iteration.
682 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos)
684 long pid = (unsigned long)v;
689 /* pid already is +1 of the actual previous bit */
690 if (trace_pid_list_next(pid_list, pid, &next) < 0)
695 /* Return pid + 1 to allow zero to be represented */
696 return (void *)(pid + 1);
700 * trace_pid_start - Used for seq_file to start reading pid lists
701 * @pid_list: The pid list to show
702 * @pos: The position of the file
704 * This is used by seq_file "start" operation to start the iteration
707 * Returns the pid+1 as we want to display pid of zero, but NULL would
708 * stop the iteration.
710 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos)
716 if (trace_pid_list_first(pid_list, &first) < 0)
721 /* Return pid + 1 so that zero can be the exit value */
722 for (pid++; pid && l < *pos;
723 pid = (unsigned long)trace_pid_next(pid_list, (void *)pid, &l))
729 * trace_pid_show - show the current pid in seq_file processing
730 * @m: The seq_file structure to write into
731 * @v: A void pointer of the pid (+1) value to display
733 * Can be directly used by seq_file operations to display the current
736 int trace_pid_show(struct seq_file *m, void *v)
738 unsigned long pid = (unsigned long)v - 1;
740 seq_printf(m, "%lu\n", pid);
744 /* 128 should be much more than enough */
745 #define PID_BUF_SIZE 127
747 int trace_pid_write(struct trace_pid_list *filtered_pids,
748 struct trace_pid_list **new_pid_list,
749 const char __user *ubuf, size_t cnt)
751 struct trace_pid_list *pid_list;
752 struct trace_parser parser;
760 if (trace_parser_get_init(&parser, PID_BUF_SIZE + 1))
764 * Always recreate a new array. The write is an all or nothing
765 * operation. Always create a new array when adding new pids by
766 * the user. If the operation fails, then the current list is
769 pid_list = trace_pid_list_alloc();
771 trace_parser_put(&parser);
776 /* copy the current bits to the new max */
777 ret = trace_pid_list_first(filtered_pids, &pid);
779 trace_pid_list_set(pid_list, pid);
780 ret = trace_pid_list_next(filtered_pids, pid + 1, &pid);
790 ret = trace_get_user(&parser, ubuf, cnt, &pos);
798 if (!trace_parser_loaded(&parser))
802 if (kstrtoul(parser.buffer, 0, &val))
807 if (trace_pid_list_set(pid_list, pid) < 0) {
813 trace_parser_clear(&parser);
816 trace_parser_put(&parser);
819 trace_pid_list_free(pid_list);
824 /* Cleared the list of pids */
825 trace_pid_list_free(pid_list);
829 *new_pid_list = pid_list;
834 static u64 buffer_ftrace_now(struct array_buffer *buf, int cpu)
838 /* Early boot up does not have a buffer yet */
840 return trace_clock_local();
842 ts = ring_buffer_time_stamp(buf->buffer);
843 ring_buffer_normalize_time_stamp(buf->buffer, cpu, &ts);
848 u64 ftrace_now(int cpu)
850 return buffer_ftrace_now(&global_trace.array_buffer, cpu);
854 * tracing_is_enabled - Show if global_trace has been enabled
856 * Shows if the global trace has been enabled or not. It uses the
857 * mirror flag "buffer_disabled" to be used in fast paths such as for
858 * the irqsoff tracer. But it may be inaccurate due to races. If you
859 * need to know the accurate state, use tracing_is_on() which is a little
860 * slower, but accurate.
862 int tracing_is_enabled(void)
865 * For quick access (irqsoff uses this in fast path), just
866 * return the mirror variable of the state of the ring buffer.
867 * It's a little racy, but we don't really care.
870 return !global_trace.buffer_disabled;
874 * trace_buf_size is the size in bytes that is allocated
875 * for a buffer. Note, the number of bytes is always rounded
878 * This number is purposely set to a low number of 16384.
879 * If the dump on oops happens, it will be much appreciated
880 * to not have to wait for all that output. Anyway this can be
881 * boot time and run time configurable.
883 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
885 static unsigned long trace_buf_size = TRACE_BUF_SIZE_DEFAULT;
887 /* trace_types holds a link list of available tracers. */
888 static struct tracer *trace_types __read_mostly;
891 * trace_types_lock is used to protect the trace_types list.
893 DEFINE_MUTEX(trace_types_lock);
896 * serialize the access of the ring buffer
898 * ring buffer serializes readers, but it is low level protection.
899 * The validity of the events (which returns by ring_buffer_peek() ..etc)
900 * are not protected by ring buffer.
902 * The content of events may become garbage if we allow other process consumes
903 * these events concurrently:
904 * A) the page of the consumed events may become a normal page
905 * (not reader page) in ring buffer, and this page will be rewritten
906 * by events producer.
907 * B) The page of the consumed events may become a page for splice_read,
908 * and this page will be returned to system.
910 * These primitives allow multi process access to different cpu ring buffer
913 * These primitives don't distinguish read-only and read-consume access.
914 * Multi read-only access are also serialized.
918 static DECLARE_RWSEM(all_cpu_access_lock);
919 static DEFINE_PER_CPU(struct mutex, cpu_access_lock);
921 static inline void trace_access_lock(int cpu)
923 if (cpu == RING_BUFFER_ALL_CPUS) {
924 /* gain it for accessing the whole ring buffer. */
925 down_write(&all_cpu_access_lock);
927 /* gain it for accessing a cpu ring buffer. */
929 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
930 down_read(&all_cpu_access_lock);
932 /* Secondly block other access to this @cpu ring buffer. */
933 mutex_lock(&per_cpu(cpu_access_lock, cpu));
937 static inline void trace_access_unlock(int cpu)
939 if (cpu == RING_BUFFER_ALL_CPUS) {
940 up_write(&all_cpu_access_lock);
942 mutex_unlock(&per_cpu(cpu_access_lock, cpu));
943 up_read(&all_cpu_access_lock);
947 static inline void trace_access_lock_init(void)
951 for_each_possible_cpu(cpu)
952 mutex_init(&per_cpu(cpu_access_lock, cpu));
957 static DEFINE_MUTEX(access_lock);
959 static inline void trace_access_lock(int cpu)
962 mutex_lock(&access_lock);
965 static inline void trace_access_unlock(int cpu)
968 mutex_unlock(&access_lock);
971 static inline void trace_access_lock_init(void)
977 #ifdef CONFIG_STACKTRACE
978 static void __ftrace_trace_stack(struct trace_array *tr,
979 struct trace_buffer *buffer,
980 unsigned int trace_ctx,
981 int skip, struct pt_regs *regs);
982 static inline void ftrace_trace_stack(struct trace_array *tr,
983 struct trace_buffer *buffer,
984 unsigned int trace_ctx,
985 int skip, struct pt_regs *regs);
988 static inline void __ftrace_trace_stack(struct trace_array *tr,
989 struct trace_buffer *buffer,
990 unsigned int trace_ctx,
991 int skip, struct pt_regs *regs)
994 static inline void ftrace_trace_stack(struct trace_array *tr,
995 struct trace_buffer *buffer,
996 unsigned long trace_ctx,
997 int skip, struct pt_regs *regs)
1003 static __always_inline void
1004 trace_event_setup(struct ring_buffer_event *event,
1005 int type, unsigned int trace_ctx)
1007 struct trace_entry *ent = ring_buffer_event_data(event);
1009 tracing_generic_entry_update(ent, type, trace_ctx);
1012 static __always_inline struct ring_buffer_event *
1013 __trace_buffer_lock_reserve(struct trace_buffer *buffer,
1016 unsigned int trace_ctx)
1018 struct ring_buffer_event *event;
1020 event = ring_buffer_lock_reserve(buffer, len);
1022 trace_event_setup(event, type, trace_ctx);
1027 void tracer_tracing_on(struct trace_array *tr)
1029 if (tr->array_buffer.buffer)
1030 ring_buffer_record_on(tr->array_buffer.buffer);
1032 * This flag is looked at when buffers haven't been allocated
1033 * yet, or by some tracers (like irqsoff), that just want to
1034 * know if the ring buffer has been disabled, but it can handle
1035 * races of where it gets disabled but we still do a record.
1036 * As the check is in the fast path of the tracers, it is more
1037 * important to be fast than accurate.
1039 tr->buffer_disabled = 0;
1040 /* Make the flag seen by readers */
1045 * tracing_on - enable tracing buffers
1047 * This function enables tracing buffers that may have been
1048 * disabled with tracing_off.
1050 void tracing_on(void)
1052 tracer_tracing_on(&global_trace);
1054 EXPORT_SYMBOL_GPL(tracing_on);
1057 static __always_inline void
1058 __buffer_unlock_commit(struct trace_buffer *buffer, struct ring_buffer_event *event)
1060 __this_cpu_write(trace_taskinfo_save, true);
1062 /* If this is the temp buffer, we need to commit fully */
1063 if (this_cpu_read(trace_buffered_event) == event) {
1064 /* Length is in event->array[0] */
1065 ring_buffer_write(buffer, event->array[0], &event->array[1]);
1066 /* Release the temp buffer */
1067 this_cpu_dec(trace_buffered_event_cnt);
1068 /* ring_buffer_unlock_commit() enables preemption */
1069 preempt_enable_notrace();
1071 ring_buffer_unlock_commit(buffer);
1074 int __trace_array_puts(struct trace_array *tr, unsigned long ip,
1075 const char *str, int size)
1077 struct ring_buffer_event *event;
1078 struct trace_buffer *buffer;
1079 struct print_entry *entry;
1080 unsigned int trace_ctx;
1083 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
1086 if (unlikely(tracing_selftest_running && tr == &global_trace))
1089 if (unlikely(tracing_disabled))
1092 alloc = sizeof(*entry) + size + 2; /* possible \n added */
1094 trace_ctx = tracing_gen_ctx();
1095 buffer = tr->array_buffer.buffer;
1096 ring_buffer_nest_start(buffer);
1097 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, alloc,
1104 entry = ring_buffer_event_data(event);
1107 memcpy(&entry->buf, str, size);
1109 /* Add a newline if necessary */
1110 if (entry->buf[size - 1] != '\n') {
1111 entry->buf[size] = '\n';
1112 entry->buf[size + 1] = '\0';
1114 entry->buf[size] = '\0';
1116 __buffer_unlock_commit(buffer, event);
1117 ftrace_trace_stack(tr, buffer, trace_ctx, 4, NULL);
1119 ring_buffer_nest_end(buffer);
1122 EXPORT_SYMBOL_GPL(__trace_array_puts);
1125 * __trace_puts - write a constant string into the trace buffer.
1126 * @ip: The address of the caller
1127 * @str: The constant string to write
1128 * @size: The size of the string.
1130 int __trace_puts(unsigned long ip, const char *str, int size)
1132 return __trace_array_puts(printk_trace, ip, str, size);
1134 EXPORT_SYMBOL_GPL(__trace_puts);
1137 * __trace_bputs - write the pointer to a constant string into trace buffer
1138 * @ip: The address of the caller
1139 * @str: The constant string to write to the buffer to
1141 int __trace_bputs(unsigned long ip, const char *str)
1143 struct trace_array *tr = READ_ONCE(printk_trace);
1144 struct ring_buffer_event *event;
1145 struct trace_buffer *buffer;
1146 struct bputs_entry *entry;
1147 unsigned int trace_ctx;
1148 int size = sizeof(struct bputs_entry);
1151 if (!printk_binsafe(tr))
1152 return __trace_puts(ip, str, strlen(str));
1154 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
1157 if (unlikely(tracing_selftest_running || tracing_disabled))
1160 trace_ctx = tracing_gen_ctx();
1161 buffer = tr->array_buffer.buffer;
1163 ring_buffer_nest_start(buffer);
1164 event = __trace_buffer_lock_reserve(buffer, TRACE_BPUTS, size,
1169 entry = ring_buffer_event_data(event);
1173 __buffer_unlock_commit(buffer, event);
1174 ftrace_trace_stack(tr, buffer, trace_ctx, 4, NULL);
1178 ring_buffer_nest_end(buffer);
1181 EXPORT_SYMBOL_GPL(__trace_bputs);
1183 #ifdef CONFIG_TRACER_SNAPSHOT
1184 static void tracing_snapshot_instance_cond(struct trace_array *tr,
1187 struct tracer *tracer = tr->current_trace;
1188 unsigned long flags;
1191 trace_array_puts(tr, "*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
1192 trace_array_puts(tr, "*** snapshot is being ignored ***\n");
1196 if (!tr->allocated_snapshot) {
1197 trace_array_puts(tr, "*** SNAPSHOT NOT ALLOCATED ***\n");
1198 trace_array_puts(tr, "*** stopping trace here! ***\n");
1199 tracer_tracing_off(tr);
1203 /* Note, snapshot can not be used when the tracer uses it */
1204 if (tracer->use_max_tr) {
1205 trace_array_puts(tr, "*** LATENCY TRACER ACTIVE ***\n");
1206 trace_array_puts(tr, "*** Can not use snapshot (sorry) ***\n");
1211 trace_array_puts(tr, "*** BUFFER MEMORY MAPPED ***\n");
1212 trace_array_puts(tr, "*** Can not use snapshot (sorry) ***\n");
1216 local_irq_save(flags);
1217 update_max_tr(tr, current, smp_processor_id(), cond_data);
1218 local_irq_restore(flags);
1221 void tracing_snapshot_instance(struct trace_array *tr)
1223 tracing_snapshot_instance_cond(tr, NULL);
1227 * tracing_snapshot - take a snapshot of the current buffer.
1229 * This causes a swap between the snapshot buffer and the current live
1230 * tracing buffer. You can use this to take snapshots of the live
1231 * trace when some condition is triggered, but continue to trace.
1233 * Note, make sure to allocate the snapshot with either
1234 * a tracing_snapshot_alloc(), or by doing it manually
1235 * with: echo 1 > /sys/kernel/tracing/snapshot
1237 * If the snapshot buffer is not allocated, it will stop tracing.
1238 * Basically making a permanent snapshot.
1240 void tracing_snapshot(void)
1242 struct trace_array *tr = &global_trace;
1244 tracing_snapshot_instance(tr);
1246 EXPORT_SYMBOL_GPL(tracing_snapshot);
1249 * tracing_snapshot_cond - conditionally take a snapshot of the current buffer.
1250 * @tr: The tracing instance to snapshot
1251 * @cond_data: The data to be tested conditionally, and possibly saved
1253 * This is the same as tracing_snapshot() except that the snapshot is
1254 * conditional - the snapshot will only happen if the
1255 * cond_snapshot.update() implementation receiving the cond_data
1256 * returns true, which means that the trace array's cond_snapshot
1257 * update() operation used the cond_data to determine whether the
1258 * snapshot should be taken, and if it was, presumably saved it along
1259 * with the snapshot.
1261 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1263 tracing_snapshot_instance_cond(tr, cond_data);
1265 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1268 * tracing_cond_snapshot_data - get the user data associated with a snapshot
1269 * @tr: The tracing instance
1271 * When the user enables a conditional snapshot using
1272 * tracing_snapshot_cond_enable(), the user-defined cond_data is saved
1273 * with the snapshot. This accessor is used to retrieve it.
1275 * Should not be called from cond_snapshot.update(), since it takes
1276 * the tr->max_lock lock, which the code calling
1277 * cond_snapshot.update() has already done.
1279 * Returns the cond_data associated with the trace array's snapshot.
1281 void *tracing_cond_snapshot_data(struct trace_array *tr)
1283 void *cond_data = NULL;
1285 local_irq_disable();
1286 arch_spin_lock(&tr->max_lock);
1288 if (tr->cond_snapshot)
1289 cond_data = tr->cond_snapshot->cond_data;
1291 arch_spin_unlock(&tr->max_lock);
1296 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1298 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
1299 struct array_buffer *size_buf, int cpu_id);
1300 static void set_buffer_entries(struct array_buffer *buf, unsigned long val);
1302 int tracing_alloc_snapshot_instance(struct trace_array *tr)
1307 if (!tr->allocated_snapshot) {
1309 /* Make the snapshot buffer have the same order as main buffer */
1310 order = ring_buffer_subbuf_order_get(tr->array_buffer.buffer);
1311 ret = ring_buffer_subbuf_order_set(tr->max_buffer.buffer, order);
1315 /* allocate spare buffer */
1316 ret = resize_buffer_duplicate_size(&tr->max_buffer,
1317 &tr->array_buffer, RING_BUFFER_ALL_CPUS);
1321 tr->allocated_snapshot = true;
1327 static void free_snapshot(struct trace_array *tr)
1330 * We don't free the ring buffer. instead, resize it because
1331 * The max_tr ring buffer has some state (e.g. ring->clock) and
1332 * we want preserve it.
1334 ring_buffer_subbuf_order_set(tr->max_buffer.buffer, 0);
1335 ring_buffer_resize(tr->max_buffer.buffer, 1, RING_BUFFER_ALL_CPUS);
1336 set_buffer_entries(&tr->max_buffer, 1);
1337 tracing_reset_online_cpus(&tr->max_buffer);
1338 tr->allocated_snapshot = false;
1341 static int tracing_arm_snapshot_locked(struct trace_array *tr)
1345 lockdep_assert_held(&trace_types_lock);
1347 spin_lock(&tr->snapshot_trigger_lock);
1348 if (tr->snapshot == UINT_MAX || tr->mapped) {
1349 spin_unlock(&tr->snapshot_trigger_lock);
1354 spin_unlock(&tr->snapshot_trigger_lock);
1356 ret = tracing_alloc_snapshot_instance(tr);
1358 spin_lock(&tr->snapshot_trigger_lock);
1360 spin_unlock(&tr->snapshot_trigger_lock);
1366 int tracing_arm_snapshot(struct trace_array *tr)
1370 mutex_lock(&trace_types_lock);
1371 ret = tracing_arm_snapshot_locked(tr);
1372 mutex_unlock(&trace_types_lock);
1377 void tracing_disarm_snapshot(struct trace_array *tr)
1379 spin_lock(&tr->snapshot_trigger_lock);
1380 if (!WARN_ON(!tr->snapshot))
1382 spin_unlock(&tr->snapshot_trigger_lock);
1386 * tracing_alloc_snapshot - allocate snapshot buffer.
1388 * This only allocates the snapshot buffer if it isn't already
1389 * allocated - it doesn't also take a snapshot.
1391 * This is meant to be used in cases where the snapshot buffer needs
1392 * to be set up for events that can't sleep but need to be able to
1393 * trigger a snapshot.
1395 int tracing_alloc_snapshot(void)
1397 struct trace_array *tr = &global_trace;
1400 ret = tracing_alloc_snapshot_instance(tr);
1405 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1408 * tracing_snapshot_alloc - allocate and take a snapshot of the current buffer.
1410 * This is similar to tracing_snapshot(), but it will allocate the
1411 * snapshot buffer if it isn't already allocated. Use this only
1412 * where it is safe to sleep, as the allocation may sleep.
1414 * This causes a swap between the snapshot buffer and the current live
1415 * tracing buffer. You can use this to take snapshots of the live
1416 * trace when some condition is triggered, but continue to trace.
1418 void tracing_snapshot_alloc(void)
1422 ret = tracing_alloc_snapshot();
1428 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1431 * tracing_snapshot_cond_enable - enable conditional snapshot for an instance
1432 * @tr: The tracing instance
1433 * @cond_data: User data to associate with the snapshot
1434 * @update: Implementation of the cond_snapshot update function
1436 * Check whether the conditional snapshot for the given instance has
1437 * already been enabled, or if the current tracer is already using a
1438 * snapshot; if so, return -EBUSY, else create a cond_snapshot and
1439 * save the cond_data and update function inside.
1441 * Returns 0 if successful, error otherwise.
1443 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data,
1444 cond_update_fn_t update)
1446 struct cond_snapshot *cond_snapshot;
1449 cond_snapshot = kzalloc(sizeof(*cond_snapshot), GFP_KERNEL);
1453 cond_snapshot->cond_data = cond_data;
1454 cond_snapshot->update = update;
1456 mutex_lock(&trace_types_lock);
1458 if (tr->current_trace->use_max_tr) {
1464 * The cond_snapshot can only change to NULL without the
1465 * trace_types_lock. We don't care if we race with it going
1466 * to NULL, but we want to make sure that it's not set to
1467 * something other than NULL when we get here, which we can
1468 * do safely with only holding the trace_types_lock and not
1469 * having to take the max_lock.
1471 if (tr->cond_snapshot) {
1476 ret = tracing_arm_snapshot_locked(tr);
1480 local_irq_disable();
1481 arch_spin_lock(&tr->max_lock);
1482 tr->cond_snapshot = cond_snapshot;
1483 arch_spin_unlock(&tr->max_lock);
1486 mutex_unlock(&trace_types_lock);
1491 mutex_unlock(&trace_types_lock);
1492 kfree(cond_snapshot);
1495 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1498 * tracing_snapshot_cond_disable - disable conditional snapshot for an instance
1499 * @tr: The tracing instance
1501 * Check whether the conditional snapshot for the given instance is
1502 * enabled; if so, free the cond_snapshot associated with it,
1503 * otherwise return -EINVAL.
1505 * Returns 0 if successful, error otherwise.
1507 int tracing_snapshot_cond_disable(struct trace_array *tr)
1511 local_irq_disable();
1512 arch_spin_lock(&tr->max_lock);
1514 if (!tr->cond_snapshot)
1517 kfree(tr->cond_snapshot);
1518 tr->cond_snapshot = NULL;
1521 arch_spin_unlock(&tr->max_lock);
1524 tracing_disarm_snapshot(tr);
1528 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1530 void tracing_snapshot(void)
1532 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1534 EXPORT_SYMBOL_GPL(tracing_snapshot);
1535 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1537 WARN_ONCE(1, "Snapshot feature not enabled, but internal conditional snapshot used");
1539 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1540 int tracing_alloc_snapshot(void)
1542 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1545 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1546 void tracing_snapshot_alloc(void)
1551 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1552 void *tracing_cond_snapshot_data(struct trace_array *tr)
1556 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1557 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update)
1561 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1562 int tracing_snapshot_cond_disable(struct trace_array *tr)
1566 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1567 #define free_snapshot(tr) do { } while (0)
1568 #define tracing_arm_snapshot_locked(tr) ({ -EBUSY; })
1569 #endif /* CONFIG_TRACER_SNAPSHOT */
1571 void tracer_tracing_off(struct trace_array *tr)
1573 if (tr->array_buffer.buffer)
1574 ring_buffer_record_off(tr->array_buffer.buffer);
1576 * This flag is looked at when buffers haven't been allocated
1577 * yet, or by some tracers (like irqsoff), that just want to
1578 * know if the ring buffer has been disabled, but it can handle
1579 * races of where it gets disabled but we still do a record.
1580 * As the check is in the fast path of the tracers, it is more
1581 * important to be fast than accurate.
1583 tr->buffer_disabled = 1;
1584 /* Make the flag seen by readers */
1589 * tracing_off - turn off tracing buffers
1591 * This function stops the tracing buffers from recording data.
1592 * It does not disable any overhead the tracers themselves may
1593 * be causing. This function simply causes all recording to
1594 * the ring buffers to fail.
1596 void tracing_off(void)
1598 tracer_tracing_off(&global_trace);
1600 EXPORT_SYMBOL_GPL(tracing_off);
1602 void disable_trace_on_warning(void)
1604 if (__disable_trace_on_warning) {
1605 trace_array_printk_buf(global_trace.array_buffer.buffer, _THIS_IP_,
1606 "Disabling tracing due to warning\n");
1612 * tracer_tracing_is_on - show real state of ring buffer enabled
1613 * @tr : the trace array to know if ring buffer is enabled
1615 * Shows real state of the ring buffer if it is enabled or not.
1617 bool tracer_tracing_is_on(struct trace_array *tr)
1619 if (tr->array_buffer.buffer)
1620 return ring_buffer_record_is_set_on(tr->array_buffer.buffer);
1621 return !tr->buffer_disabled;
1625 * tracing_is_on - show state of ring buffers enabled
1627 int tracing_is_on(void)
1629 return tracer_tracing_is_on(&global_trace);
1631 EXPORT_SYMBOL_GPL(tracing_is_on);
1633 static int __init set_buf_size(char *str)
1635 unsigned long buf_size;
1639 buf_size = memparse(str, &str);
1641 * nr_entries can not be zero and the startup
1642 * tests require some buffer space. Therefore
1643 * ensure we have at least 4096 bytes of buffer.
1645 trace_buf_size = max(4096UL, buf_size);
1648 __setup("trace_buf_size=", set_buf_size);
1650 static int __init set_tracing_thresh(char *str)
1652 unsigned long threshold;
1657 ret = kstrtoul(str, 0, &threshold);
1660 tracing_thresh = threshold * 1000;
1663 __setup("tracing_thresh=", set_tracing_thresh);
1665 unsigned long nsecs_to_usecs(unsigned long nsecs)
1667 return nsecs / 1000;
1671 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1672 * It uses C(a, b) where 'a' is the eval (enum) name and 'b' is the string that
1673 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1674 * of strings in the order that the evals (enum) were defined.
1679 /* These must match the bit positions in trace_iterator_flags */
1680 static const char *trace_options[] = {
1688 int in_ns; /* is this clock in nanoseconds? */
1689 } trace_clocks[] = {
1690 { trace_clock_local, "local", 1 },
1691 { trace_clock_global, "global", 1 },
1692 { trace_clock_counter, "counter", 0 },
1693 { trace_clock_jiffies, "uptime", 0 },
1694 { trace_clock, "perf", 1 },
1695 { ktime_get_mono_fast_ns, "mono", 1 },
1696 { ktime_get_raw_fast_ns, "mono_raw", 1 },
1697 { ktime_get_boot_fast_ns, "boot", 1 },
1698 { ktime_get_tai_fast_ns, "tai", 1 },
1702 bool trace_clock_in_ns(struct trace_array *tr)
1704 if (trace_clocks[tr->clock_id].in_ns)
1711 * trace_parser_get_init - gets the buffer for trace parser
1713 int trace_parser_get_init(struct trace_parser *parser, int size)
1715 memset(parser, 0, sizeof(*parser));
1717 parser->buffer = kmalloc(size, GFP_KERNEL);
1718 if (!parser->buffer)
1721 parser->size = size;
1726 * trace_parser_put - frees the buffer for trace parser
1728 void trace_parser_put(struct trace_parser *parser)
1730 kfree(parser->buffer);
1731 parser->buffer = NULL;
1735 * trace_get_user - reads the user input string separated by space
1736 * (matched by isspace(ch))
1738 * For each string found the 'struct trace_parser' is updated,
1739 * and the function returns.
1741 * Returns number of bytes read.
1743 * See kernel/trace/trace.h for 'struct trace_parser' details.
1745 int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1746 size_t cnt, loff_t *ppos)
1753 trace_parser_clear(parser);
1755 ret = get_user(ch, ubuf++);
1763 * The parser is not finished with the last write,
1764 * continue reading the user input without skipping spaces.
1766 if (!parser->cont) {
1767 /* skip white space */
1768 while (cnt && isspace(ch)) {
1769 ret = get_user(ch, ubuf++);
1778 /* only spaces were written */
1779 if (isspace(ch) || !ch) {
1786 /* read the non-space input */
1787 while (cnt && !isspace(ch) && ch) {
1788 if (parser->idx < parser->size - 1)
1789 parser->buffer[parser->idx++] = ch;
1794 ret = get_user(ch, ubuf++);
1801 /* We either got finished input or we have to wait for another call. */
1802 if (isspace(ch) || !ch) {
1803 parser->buffer[parser->idx] = 0;
1804 parser->cont = false;
1805 } else if (parser->idx < parser->size - 1) {
1806 parser->cont = true;
1807 parser->buffer[parser->idx++] = ch;
1808 /* Make sure the parsed string always terminates with '\0'. */
1809 parser->buffer[parser->idx] = 0;
1822 /* TODO add a seq_buf_to_buffer() */
1823 static ssize_t trace_seq_to_buffer(struct trace_seq *s, void *buf, size_t cnt)
1827 if (trace_seq_used(s) <= s->readpos)
1830 len = trace_seq_used(s) - s->readpos;
1833 memcpy(buf, s->buffer + s->readpos, cnt);
1839 unsigned long __read_mostly tracing_thresh;
1841 #ifdef CONFIG_TRACER_MAX_TRACE
1842 static const struct file_operations tracing_max_lat_fops;
1844 #ifdef LATENCY_FS_NOTIFY
1846 static struct workqueue_struct *fsnotify_wq;
1848 static void latency_fsnotify_workfn(struct work_struct *work)
1850 struct trace_array *tr = container_of(work, struct trace_array,
1852 fsnotify_inode(tr->d_max_latency->d_inode, FS_MODIFY);
1855 static void latency_fsnotify_workfn_irq(struct irq_work *iwork)
1857 struct trace_array *tr = container_of(iwork, struct trace_array,
1859 queue_work(fsnotify_wq, &tr->fsnotify_work);
1862 static void trace_create_maxlat_file(struct trace_array *tr,
1863 struct dentry *d_tracer)
1865 INIT_WORK(&tr->fsnotify_work, latency_fsnotify_workfn);
1866 init_irq_work(&tr->fsnotify_irqwork, latency_fsnotify_workfn_irq);
1867 tr->d_max_latency = trace_create_file("tracing_max_latency",
1870 &tracing_max_lat_fops);
1873 __init static int latency_fsnotify_init(void)
1875 fsnotify_wq = alloc_workqueue("tr_max_lat_wq",
1876 WQ_UNBOUND | WQ_HIGHPRI, 0);
1878 pr_err("Unable to allocate tr_max_lat_wq\n");
1884 late_initcall_sync(latency_fsnotify_init);
1886 void latency_fsnotify(struct trace_array *tr)
1891 * We cannot call queue_work(&tr->fsnotify_work) from here because it's
1892 * possible that we are called from __schedule() or do_idle(), which
1893 * could cause a deadlock.
1895 irq_work_queue(&tr->fsnotify_irqwork);
1898 #else /* !LATENCY_FS_NOTIFY */
1900 #define trace_create_maxlat_file(tr, d_tracer) \
1901 trace_create_file("tracing_max_latency", TRACE_MODE_WRITE, \
1902 d_tracer, tr, &tracing_max_lat_fops)
1907 * Copy the new maximum trace into the separate maximum-trace
1908 * structure. (this way the maximum trace is permanently saved,
1909 * for later retrieval via /sys/kernel/tracing/tracing_max_latency)
1912 __update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)
1914 struct array_buffer *trace_buf = &tr->array_buffer;
1915 struct array_buffer *max_buf = &tr->max_buffer;
1916 struct trace_array_cpu *data = per_cpu_ptr(trace_buf->data, cpu);
1917 struct trace_array_cpu *max_data = per_cpu_ptr(max_buf->data, cpu);
1920 max_buf->time_start = data->preempt_timestamp;
1922 max_data->saved_latency = tr->max_latency;
1923 max_data->critical_start = data->critical_start;
1924 max_data->critical_end = data->critical_end;
1926 strscpy(max_data->comm, tsk->comm);
1927 max_data->pid = tsk->pid;
1929 * If tsk == current, then use current_uid(), as that does not use
1930 * RCU. The irq tracer can be called out of RCU scope.
1933 max_data->uid = current_uid();
1935 max_data->uid = task_uid(tsk);
1937 max_data->nice = tsk->static_prio - 20 - MAX_RT_PRIO;
1938 max_data->policy = tsk->policy;
1939 max_data->rt_priority = tsk->rt_priority;
1941 /* record this tasks comm */
1942 tracing_record_cmdline(tsk);
1943 latency_fsnotify(tr);
1947 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1949 * @tsk: the task with the latency
1950 * @cpu: The cpu that initiated the trace.
1951 * @cond_data: User data associated with a conditional snapshot
1953 * Flip the buffers between the @tr and the max_tr and record information
1954 * about which task was the cause of this latency.
1957 update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
1963 WARN_ON_ONCE(!irqs_disabled());
1965 if (!tr->allocated_snapshot) {
1966 /* Only the nop tracer should hit this when disabling */
1967 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1971 arch_spin_lock(&tr->max_lock);
1973 /* Inherit the recordable setting from array_buffer */
1974 if (ring_buffer_record_is_set_on(tr->array_buffer.buffer))
1975 ring_buffer_record_on(tr->max_buffer.buffer);
1977 ring_buffer_record_off(tr->max_buffer.buffer);
1979 #ifdef CONFIG_TRACER_SNAPSHOT
1980 if (tr->cond_snapshot && !tr->cond_snapshot->update(tr, cond_data)) {
1981 arch_spin_unlock(&tr->max_lock);
1985 swap(tr->array_buffer.buffer, tr->max_buffer.buffer);
1987 __update_max_tr(tr, tsk, cpu);
1989 arch_spin_unlock(&tr->max_lock);
1991 /* Any waiters on the old snapshot buffer need to wake up */
1992 ring_buffer_wake_waiters(tr->array_buffer.buffer, RING_BUFFER_ALL_CPUS);
1996 * update_max_tr_single - only copy one trace over, and reset the rest
1998 * @tsk: task with the latency
1999 * @cpu: the cpu of the buffer to copy.
2001 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
2004 update_max_tr_single(struct trace_array *tr, struct task_struct *tsk, int cpu)
2011 WARN_ON_ONCE(!irqs_disabled());
2012 if (!tr->allocated_snapshot) {
2013 /* Only the nop tracer should hit this when disabling */
2014 WARN_ON_ONCE(tr->current_trace != &nop_trace);
2018 arch_spin_lock(&tr->max_lock);
2020 ret = ring_buffer_swap_cpu(tr->max_buffer.buffer, tr->array_buffer.buffer, cpu);
2022 if (ret == -EBUSY) {
2024 * We failed to swap the buffer due to a commit taking
2025 * place on this CPU. We fail to record, but we reset
2026 * the max trace buffer (no one writes directly to it)
2027 * and flag that it failed.
2028 * Another reason is resize is in progress.
2030 trace_array_printk_buf(tr->max_buffer.buffer, _THIS_IP_,
2031 "Failed to swap buffers due to commit or resize in progress\n");
2034 WARN_ON_ONCE(ret && ret != -EAGAIN && ret != -EBUSY);
2036 __update_max_tr(tr, tsk, cpu);
2037 arch_spin_unlock(&tr->max_lock);
2040 #endif /* CONFIG_TRACER_MAX_TRACE */
2043 struct trace_iterator *iter;
2047 static bool wait_pipe_cond(void *data)
2049 struct pipe_wait *pwait = data;
2050 struct trace_iterator *iter = pwait->iter;
2052 if (atomic_read_acquire(&iter->wait_index) != pwait->wait_index)
2055 return iter->closed;
2058 static int wait_on_pipe(struct trace_iterator *iter, int full)
2060 struct pipe_wait pwait;
2063 /* Iterators are static, they should be filled or empty */
2064 if (trace_buffer_iter(iter, iter->cpu_file))
2067 pwait.wait_index = atomic_read_acquire(&iter->wait_index);
2070 ret = ring_buffer_wait(iter->array_buffer->buffer, iter->cpu_file, full,
2071 wait_pipe_cond, &pwait);
2073 #ifdef CONFIG_TRACER_MAX_TRACE
2075 * Make sure this is still the snapshot buffer, as if a snapshot were
2076 * to happen, this would now be the main buffer.
2079 iter->array_buffer = &iter->tr->max_buffer;
2084 #ifdef CONFIG_FTRACE_STARTUP_TEST
2085 static bool selftests_can_run;
2087 struct trace_selftests {
2088 struct list_head list;
2089 struct tracer *type;
2092 static LIST_HEAD(postponed_selftests);
2094 static int save_selftest(struct tracer *type)
2096 struct trace_selftests *selftest;
2098 selftest = kmalloc(sizeof(*selftest), GFP_KERNEL);
2102 selftest->type = type;
2103 list_add(&selftest->list, &postponed_selftests);
2107 static int run_tracer_selftest(struct tracer *type)
2109 struct trace_array *tr = &global_trace;
2110 struct tracer *saved_tracer = tr->current_trace;
2113 if (!type->selftest || tracing_selftest_disabled)
2117 * If a tracer registers early in boot up (before scheduling is
2118 * initialized and such), then do not run its selftests yet.
2119 * Instead, run it a little later in the boot process.
2121 if (!selftests_can_run)
2122 return save_selftest(type);
2124 if (!tracing_is_on()) {
2125 pr_warn("Selftest for tracer %s skipped due to tracing disabled\n",
2131 * Run a selftest on this tracer.
2132 * Here we reset the trace buffer, and set the current
2133 * tracer to be this tracer. The tracer can then run some
2134 * internal tracing to verify that everything is in order.
2135 * If we fail, we do not register this tracer.
2137 tracing_reset_online_cpus(&tr->array_buffer);
2139 tr->current_trace = type;
2141 #ifdef CONFIG_TRACER_MAX_TRACE
2142 if (type->use_max_tr) {
2143 /* If we expanded the buffers, make sure the max is expanded too */
2144 if (tr->ring_buffer_expanded)
2145 ring_buffer_resize(tr->max_buffer.buffer, trace_buf_size,
2146 RING_BUFFER_ALL_CPUS);
2147 tr->allocated_snapshot = true;
2151 /* the test is responsible for initializing and enabling */
2152 pr_info("Testing tracer %s: ", type->name);
2153 ret = type->selftest(type, tr);
2154 /* the test is responsible for resetting too */
2155 tr->current_trace = saved_tracer;
2157 printk(KERN_CONT "FAILED!\n");
2158 /* Add the warning after printing 'FAILED' */
2162 /* Only reset on passing, to avoid touching corrupted buffers */
2163 tracing_reset_online_cpus(&tr->array_buffer);
2165 #ifdef CONFIG_TRACER_MAX_TRACE
2166 if (type->use_max_tr) {
2167 tr->allocated_snapshot = false;
2169 /* Shrink the max buffer again */
2170 if (tr->ring_buffer_expanded)
2171 ring_buffer_resize(tr->max_buffer.buffer, 1,
2172 RING_BUFFER_ALL_CPUS);
2176 printk(KERN_CONT "PASSED\n");
2180 static int do_run_tracer_selftest(struct tracer *type)
2185 * Tests can take a long time, especially if they are run one after the
2186 * other, as does happen during bootup when all the tracers are
2187 * registered. This could cause the soft lockup watchdog to trigger.
2191 tracing_selftest_running = true;
2192 ret = run_tracer_selftest(type);
2193 tracing_selftest_running = false;
2198 static __init int init_trace_selftests(void)
2200 struct trace_selftests *p, *n;
2201 struct tracer *t, **last;
2204 selftests_can_run = true;
2206 mutex_lock(&trace_types_lock);
2208 if (list_empty(&postponed_selftests))
2211 pr_info("Running postponed tracer tests:\n");
2213 tracing_selftest_running = true;
2214 list_for_each_entry_safe(p, n, &postponed_selftests, list) {
2215 /* This loop can take minutes when sanitizers are enabled, so
2216 * lets make sure we allow RCU processing.
2219 ret = run_tracer_selftest(p->type);
2220 /* If the test fails, then warn and remove from available_tracers */
2222 WARN(1, "tracer: %s failed selftest, disabling\n",
2224 last = &trace_types;
2225 for (t = trace_types; t; t = t->next) {
2236 tracing_selftest_running = false;
2239 mutex_unlock(&trace_types_lock);
2243 core_initcall(init_trace_selftests);
2245 static inline int do_run_tracer_selftest(struct tracer *type)
2249 #endif /* CONFIG_FTRACE_STARTUP_TEST */
2251 static void add_tracer_options(struct trace_array *tr, struct tracer *t);
2253 static void __init apply_trace_boot_options(void);
2256 * register_tracer - register a tracer with the ftrace system.
2257 * @type: the plugin for the tracer
2259 * Register a new plugin tracer.
2261 int __init register_tracer(struct tracer *type)
2267 pr_info("Tracer must have a name\n");
2271 if (strlen(type->name) >= MAX_TRACER_SIZE) {
2272 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE);
2276 if (security_locked_down(LOCKDOWN_TRACEFS)) {
2277 pr_warn("Can not register tracer %s due to lockdown\n",
2282 mutex_lock(&trace_types_lock);
2284 for (t = trace_types; t; t = t->next) {
2285 if (strcmp(type->name, t->name) == 0) {
2287 pr_info("Tracer %s already registered\n",
2294 if (!type->set_flag)
2295 type->set_flag = &dummy_set_flag;
2297 /*allocate a dummy tracer_flags*/
2298 type->flags = kmalloc(sizeof(*type->flags), GFP_KERNEL);
2303 type->flags->val = 0;
2304 type->flags->opts = dummy_tracer_opt;
2306 if (!type->flags->opts)
2307 type->flags->opts = dummy_tracer_opt;
2309 /* store the tracer for __set_tracer_option */
2310 type->flags->trace = type;
2312 ret = do_run_tracer_selftest(type);
2316 type->next = trace_types;
2318 add_tracer_options(&global_trace, type);
2321 mutex_unlock(&trace_types_lock);
2323 if (ret || !default_bootup_tracer)
2326 if (strncmp(default_bootup_tracer, type->name, MAX_TRACER_SIZE))
2329 printk(KERN_INFO "Starting tracer '%s'\n", type->name);
2330 /* Do we want this tracer to start on bootup? */
2331 tracing_set_tracer(&global_trace, type->name);
2332 default_bootup_tracer = NULL;
2334 apply_trace_boot_options();
2336 /* disable other selftests, since this will break it. */
2337 disable_tracing_selftest("running a tracer");
2343 static void tracing_reset_cpu(struct array_buffer *buf, int cpu)
2345 struct trace_buffer *buffer = buf->buffer;
2350 ring_buffer_record_disable(buffer);
2352 /* Make sure all commits have finished */
2354 ring_buffer_reset_cpu(buffer, cpu);
2356 ring_buffer_record_enable(buffer);
2359 void tracing_reset_online_cpus(struct array_buffer *buf)
2361 struct trace_buffer *buffer = buf->buffer;
2366 ring_buffer_record_disable(buffer);
2368 /* Make sure all commits have finished */
2371 buf->time_start = buffer_ftrace_now(buf, buf->cpu);
2373 ring_buffer_reset_online_cpus(buffer);
2375 ring_buffer_record_enable(buffer);
2378 static void tracing_reset_all_cpus(struct array_buffer *buf)
2380 struct trace_buffer *buffer = buf->buffer;
2385 ring_buffer_record_disable(buffer);
2387 /* Make sure all commits have finished */
2390 buf->time_start = buffer_ftrace_now(buf, buf->cpu);
2392 ring_buffer_reset(buffer);
2394 ring_buffer_record_enable(buffer);
2397 /* Must have trace_types_lock held */
2398 void tracing_reset_all_online_cpus_unlocked(void)
2400 struct trace_array *tr;
2402 lockdep_assert_held(&trace_types_lock);
2404 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
2405 if (!tr->clear_trace)
2407 tr->clear_trace = false;
2408 tracing_reset_online_cpus(&tr->array_buffer);
2409 #ifdef CONFIG_TRACER_MAX_TRACE
2410 tracing_reset_online_cpus(&tr->max_buffer);
2415 void tracing_reset_all_online_cpus(void)
2417 mutex_lock(&trace_types_lock);
2418 tracing_reset_all_online_cpus_unlocked();
2419 mutex_unlock(&trace_types_lock);
2422 int is_tracing_stopped(void)
2424 return global_trace.stop_count;
2427 static void tracing_start_tr(struct trace_array *tr)
2429 struct trace_buffer *buffer;
2430 unsigned long flags;
2432 if (tracing_disabled)
2435 raw_spin_lock_irqsave(&tr->start_lock, flags);
2436 if (--tr->stop_count) {
2437 if (WARN_ON_ONCE(tr->stop_count < 0)) {
2438 /* Someone screwed up their debugging */
2444 /* Prevent the buffers from switching */
2445 arch_spin_lock(&tr->max_lock);
2447 buffer = tr->array_buffer.buffer;
2449 ring_buffer_record_enable(buffer);
2451 #ifdef CONFIG_TRACER_MAX_TRACE
2452 buffer = tr->max_buffer.buffer;
2454 ring_buffer_record_enable(buffer);
2457 arch_spin_unlock(&tr->max_lock);
2460 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2464 * tracing_start - quick start of the tracer
2466 * If tracing is enabled but was stopped by tracing_stop,
2467 * this will start the tracer back up.
2469 void tracing_start(void)
2472 return tracing_start_tr(&global_trace);
2475 static void tracing_stop_tr(struct trace_array *tr)
2477 struct trace_buffer *buffer;
2478 unsigned long flags;
2480 raw_spin_lock_irqsave(&tr->start_lock, flags);
2481 if (tr->stop_count++)
2484 /* Prevent the buffers from switching */
2485 arch_spin_lock(&tr->max_lock);
2487 buffer = tr->array_buffer.buffer;
2489 ring_buffer_record_disable(buffer);
2491 #ifdef CONFIG_TRACER_MAX_TRACE
2492 buffer = tr->max_buffer.buffer;
2494 ring_buffer_record_disable(buffer);
2497 arch_spin_unlock(&tr->max_lock);
2500 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2504 * tracing_stop - quick stop of the tracer
2506 * Light weight way to stop tracing. Use in conjunction with
2509 void tracing_stop(void)
2511 return tracing_stop_tr(&global_trace);
2515 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2516 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2517 * simplifies those functions and keeps them in sync.
2519 enum print_line_t trace_handle_return(struct trace_seq *s)
2521 return trace_seq_has_overflowed(s) ?
2522 TRACE_TYPE_PARTIAL_LINE : TRACE_TYPE_HANDLED;
2524 EXPORT_SYMBOL_GPL(trace_handle_return);
2526 static unsigned short migration_disable_value(void)
2528 #if defined(CONFIG_SMP)
2529 return current->migration_disabled;
2535 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status)
2537 unsigned int trace_flags = irqs_status;
2540 pc = preempt_count();
2543 trace_flags |= TRACE_FLAG_NMI;
2544 if (pc & HARDIRQ_MASK)
2545 trace_flags |= TRACE_FLAG_HARDIRQ;
2546 if (in_serving_softirq())
2547 trace_flags |= TRACE_FLAG_SOFTIRQ;
2548 if (softirq_count() >> (SOFTIRQ_SHIFT + 1))
2549 trace_flags |= TRACE_FLAG_BH_OFF;
2551 if (tif_need_resched())
2552 trace_flags |= TRACE_FLAG_NEED_RESCHED;
2553 if (test_preempt_need_resched())
2554 trace_flags |= TRACE_FLAG_PREEMPT_RESCHED;
2555 if (IS_ENABLED(CONFIG_ARCH_HAS_PREEMPT_LAZY) && tif_test_bit(TIF_NEED_RESCHED_LAZY))
2556 trace_flags |= TRACE_FLAG_NEED_RESCHED_LAZY;
2557 return (trace_flags << 16) | (min_t(unsigned int, pc & 0xff, 0xf)) |
2558 (min_t(unsigned int, migration_disable_value(), 0xf)) << 4;
2561 struct ring_buffer_event *
2562 trace_buffer_lock_reserve(struct trace_buffer *buffer,
2565 unsigned int trace_ctx)
2567 return __trace_buffer_lock_reserve(buffer, type, len, trace_ctx);
2570 DEFINE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
2571 DEFINE_PER_CPU(int, trace_buffered_event_cnt);
2572 static int trace_buffered_event_ref;
2575 * trace_buffered_event_enable - enable buffering events
2577 * When events are being filtered, it is quicker to use a temporary
2578 * buffer to write the event data into if there's a likely chance
2579 * that it will not be committed. The discard of the ring buffer
2580 * is not as fast as committing, and is much slower than copying
2583 * When an event is to be filtered, allocate per cpu buffers to
2584 * write the event data into, and if the event is filtered and discarded
2585 * it is simply dropped, otherwise, the entire data is to be committed
2588 void trace_buffered_event_enable(void)
2590 struct ring_buffer_event *event;
2594 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2596 if (trace_buffered_event_ref++)
2599 for_each_tracing_cpu(cpu) {
2600 page = alloc_pages_node(cpu_to_node(cpu),
2601 GFP_KERNEL | __GFP_NORETRY, 0);
2602 /* This is just an optimization and can handle failures */
2604 pr_err("Failed to allocate event buffer\n");
2608 event = page_address(page);
2609 memset(event, 0, sizeof(*event));
2611 per_cpu(trace_buffered_event, cpu) = event;
2614 if (cpu == smp_processor_id() &&
2615 __this_cpu_read(trace_buffered_event) !=
2616 per_cpu(trace_buffered_event, cpu))
2622 static void enable_trace_buffered_event(void *data)
2624 /* Probably not needed, but do it anyway */
2626 this_cpu_dec(trace_buffered_event_cnt);
2629 static void disable_trace_buffered_event(void *data)
2631 this_cpu_inc(trace_buffered_event_cnt);
2635 * trace_buffered_event_disable - disable buffering events
2637 * When a filter is removed, it is faster to not use the buffered
2638 * events, and to commit directly into the ring buffer. Free up
2639 * the temp buffers when there are no more users. This requires
2640 * special synchronization with current events.
2642 void trace_buffered_event_disable(void)
2646 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2648 if (WARN_ON_ONCE(!trace_buffered_event_ref))
2651 if (--trace_buffered_event_ref)
2654 /* For each CPU, set the buffer as used. */
2655 on_each_cpu_mask(tracing_buffer_mask, disable_trace_buffered_event,
2658 /* Wait for all current users to finish */
2661 for_each_tracing_cpu(cpu) {
2662 free_page((unsigned long)per_cpu(trace_buffered_event, cpu));
2663 per_cpu(trace_buffered_event, cpu) = NULL;
2667 * Wait for all CPUs that potentially started checking if they can use
2668 * their event buffer only after the previous synchronize_rcu() call and
2669 * they still read a valid pointer from trace_buffered_event. It must be
2670 * ensured they don't see cleared trace_buffered_event_cnt else they
2671 * could wrongly decide to use the pointed-to buffer which is now freed.
2675 /* For each CPU, relinquish the buffer */
2676 on_each_cpu_mask(tracing_buffer_mask, enable_trace_buffered_event, NULL,
2680 static struct trace_buffer *temp_buffer;
2682 struct ring_buffer_event *
2683 trace_event_buffer_lock_reserve(struct trace_buffer **current_rb,
2684 struct trace_event_file *trace_file,
2685 int type, unsigned long len,
2686 unsigned int trace_ctx)
2688 struct ring_buffer_event *entry;
2689 struct trace_array *tr = trace_file->tr;
2692 *current_rb = tr->array_buffer.buffer;
2694 if (!tr->no_filter_buffering_ref &&
2695 (trace_file->flags & (EVENT_FILE_FL_SOFT_DISABLED | EVENT_FILE_FL_FILTERED))) {
2696 preempt_disable_notrace();
2698 * Filtering is on, so try to use the per cpu buffer first.
2699 * This buffer will simulate a ring_buffer_event,
2700 * where the type_len is zero and the array[0] will
2701 * hold the full length.
2702 * (see include/linux/ring-buffer.h for details on
2703 * how the ring_buffer_event is structured).
2705 * Using a temp buffer during filtering and copying it
2706 * on a matched filter is quicker than writing directly
2707 * into the ring buffer and then discarding it when
2708 * it doesn't match. That is because the discard
2709 * requires several atomic operations to get right.
2710 * Copying on match and doing nothing on a failed match
2711 * is still quicker than no copy on match, but having
2712 * to discard out of the ring buffer on a failed match.
2714 if ((entry = __this_cpu_read(trace_buffered_event))) {
2715 int max_len = PAGE_SIZE - struct_size(entry, array, 1);
2717 val = this_cpu_inc_return(trace_buffered_event_cnt);
2720 * Preemption is disabled, but interrupts and NMIs
2721 * can still come in now. If that happens after
2722 * the above increment, then it will have to go
2723 * back to the old method of allocating the event
2724 * on the ring buffer, and if the filter fails, it
2725 * will have to call ring_buffer_discard_commit()
2728 * Need to also check the unlikely case that the
2729 * length is bigger than the temp buffer size.
2730 * If that happens, then the reserve is pretty much
2731 * guaranteed to fail, as the ring buffer currently
2732 * only allows events less than a page. But that may
2733 * change in the future, so let the ring buffer reserve
2734 * handle the failure in that case.
2736 if (val == 1 && likely(len <= max_len)) {
2737 trace_event_setup(entry, type, trace_ctx);
2738 entry->array[0] = len;
2739 /* Return with preemption disabled */
2742 this_cpu_dec(trace_buffered_event_cnt);
2744 /* __trace_buffer_lock_reserve() disables preemption */
2745 preempt_enable_notrace();
2748 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2751 * If tracing is off, but we have triggers enabled
2752 * we still need to look at the event data. Use the temp_buffer
2753 * to store the trace event for the trigger to use. It's recursive
2754 * safe and will not be recorded anywhere.
2756 if (!entry && trace_file->flags & EVENT_FILE_FL_TRIGGER_COND) {
2757 *current_rb = temp_buffer;
2758 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2763 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve);
2765 static DEFINE_RAW_SPINLOCK(tracepoint_iter_lock);
2766 static DEFINE_MUTEX(tracepoint_printk_mutex);
2768 static void output_printk(struct trace_event_buffer *fbuffer)
2770 struct trace_event_call *event_call;
2771 struct trace_event_file *file;
2772 struct trace_event *event;
2773 unsigned long flags;
2774 struct trace_iterator *iter = tracepoint_print_iter;
2776 /* We should never get here if iter is NULL */
2777 if (WARN_ON_ONCE(!iter))
2780 event_call = fbuffer->trace_file->event_call;
2781 if (!event_call || !event_call->event.funcs ||
2782 !event_call->event.funcs->trace)
2785 file = fbuffer->trace_file;
2786 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
2787 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
2788 !filter_match_preds(file->filter, fbuffer->entry)))
2791 event = &fbuffer->trace_file->event_call->event;
2793 raw_spin_lock_irqsave(&tracepoint_iter_lock, flags);
2794 trace_seq_init(&iter->seq);
2795 iter->ent = fbuffer->entry;
2796 event_call->event.funcs->trace(iter, 0, event);
2797 trace_seq_putc(&iter->seq, 0);
2798 printk("%s", iter->seq.buffer);
2800 raw_spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
2803 int tracepoint_printk_sysctl(const struct ctl_table *table, int write,
2804 void *buffer, size_t *lenp,
2807 int save_tracepoint_printk;
2810 mutex_lock(&tracepoint_printk_mutex);
2811 save_tracepoint_printk = tracepoint_printk;
2813 ret = proc_dointvec(table, write, buffer, lenp, ppos);
2816 * This will force exiting early, as tracepoint_printk
2817 * is always zero when tracepoint_printk_iter is not allocated
2819 if (!tracepoint_print_iter)
2820 tracepoint_printk = 0;
2822 if (save_tracepoint_printk == tracepoint_printk)
2825 if (tracepoint_printk)
2826 static_key_enable(&tracepoint_printk_key.key);
2828 static_key_disable(&tracepoint_printk_key.key);
2831 mutex_unlock(&tracepoint_printk_mutex);
2836 void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
2838 enum event_trigger_type tt = ETT_NONE;
2839 struct trace_event_file *file = fbuffer->trace_file;
2841 if (__event_trigger_test_discard(file, fbuffer->buffer, fbuffer->event,
2842 fbuffer->entry, &tt))
2845 if (static_key_false(&tracepoint_printk_key.key))
2846 output_printk(fbuffer);
2848 if (static_branch_unlikely(&trace_event_exports_enabled))
2849 ftrace_exports(fbuffer->event, TRACE_EXPORT_EVENT);
2851 trace_buffer_unlock_commit_regs(file->tr, fbuffer->buffer,
2852 fbuffer->event, fbuffer->trace_ctx, fbuffer->regs);
2856 event_triggers_post_call(file, tt);
2859 EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
2864 * trace_buffer_unlock_commit_regs()
2865 * trace_event_buffer_commit()
2866 * trace_event_raw_event_xxx()
2868 # define STACK_SKIP 3
2870 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
2871 struct trace_buffer *buffer,
2872 struct ring_buffer_event *event,
2873 unsigned int trace_ctx,
2874 struct pt_regs *regs)
2876 __buffer_unlock_commit(buffer, event);
2879 * If regs is not set, then skip the necessary functions.
2880 * Note, we can still get here via blktrace, wakeup tracer
2881 * and mmiotrace, but that's ok if they lose a function or
2882 * two. They are not that meaningful.
2884 ftrace_trace_stack(tr, buffer, trace_ctx, regs ? 0 : STACK_SKIP, regs);
2885 ftrace_trace_userstack(tr, buffer, trace_ctx);
2889 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
2892 trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
2893 struct ring_buffer_event *event)
2895 __buffer_unlock_commit(buffer, event);
2899 trace_function(struct trace_array *tr, unsigned long ip, unsigned long
2900 parent_ip, unsigned int trace_ctx)
2902 struct trace_buffer *buffer = tr->array_buffer.buffer;
2903 struct ring_buffer_event *event;
2904 struct ftrace_entry *entry;
2906 event = __trace_buffer_lock_reserve(buffer, TRACE_FN, sizeof(*entry),
2910 entry = ring_buffer_event_data(event);
2912 entry->parent_ip = parent_ip;
2914 if (static_branch_unlikely(&trace_function_exports_enabled))
2915 ftrace_exports(event, TRACE_EXPORT_FUNCTION);
2916 __buffer_unlock_commit(buffer, event);
2919 #ifdef CONFIG_STACKTRACE
2921 /* Allow 4 levels of nesting: normal, softirq, irq, NMI */
2922 #define FTRACE_KSTACK_NESTING 4
2924 #define FTRACE_KSTACK_ENTRIES (SZ_4K / FTRACE_KSTACK_NESTING)
2926 struct ftrace_stack {
2927 unsigned long calls[FTRACE_KSTACK_ENTRIES];
2931 struct ftrace_stacks {
2932 struct ftrace_stack stacks[FTRACE_KSTACK_NESTING];
2935 static DEFINE_PER_CPU(struct ftrace_stacks, ftrace_stacks);
2936 static DEFINE_PER_CPU(int, ftrace_stack_reserve);
2938 static void __ftrace_trace_stack(struct trace_array *tr,
2939 struct trace_buffer *buffer,
2940 unsigned int trace_ctx,
2941 int skip, struct pt_regs *regs)
2943 struct ring_buffer_event *event;
2944 unsigned int size, nr_entries;
2945 struct ftrace_stack *fstack;
2946 struct stack_entry *entry;
2950 * Add one, for this function and the call to save_stack_trace()
2951 * If regs is set, then these functions will not be in the way.
2953 #ifndef CONFIG_UNWINDER_ORC
2958 preempt_disable_notrace();
2960 stackidx = __this_cpu_inc_return(ftrace_stack_reserve) - 1;
2962 /* This should never happen. If it does, yell once and skip */
2963 if (WARN_ON_ONCE(stackidx >= FTRACE_KSTACK_NESTING))
2967 * The above __this_cpu_inc_return() is 'atomic' cpu local. An
2968 * interrupt will either see the value pre increment or post
2969 * increment. If the interrupt happens pre increment it will have
2970 * restored the counter when it returns. We just need a barrier to
2971 * keep gcc from moving things around.
2975 fstack = this_cpu_ptr(ftrace_stacks.stacks) + stackidx;
2976 size = ARRAY_SIZE(fstack->calls);
2979 nr_entries = stack_trace_save_regs(regs, fstack->calls,
2982 nr_entries = stack_trace_save(fstack->calls, size, skip);
2985 #ifdef CONFIG_DYNAMIC_FTRACE
2986 /* Mark entry of stack trace as trampoline code */
2987 if (tr->ops && tr->ops->trampoline) {
2988 unsigned long tramp_start = tr->ops->trampoline;
2989 unsigned long tramp_end = tramp_start + tr->ops->trampoline_size;
2990 unsigned long *calls = fstack->calls;
2992 for (int i = 0; i < nr_entries; i++) {
2993 if (calls[i] >= tramp_start && calls[i] < tramp_end)
2994 calls[i] = FTRACE_TRAMPOLINE_MARKER;
2999 event = __trace_buffer_lock_reserve(buffer, TRACE_STACK,
3000 struct_size(entry, caller, nr_entries),
3004 entry = ring_buffer_event_data(event);
3006 entry->size = nr_entries;
3007 memcpy(&entry->caller, fstack->calls,
3008 flex_array_size(entry, caller, nr_entries));
3010 __buffer_unlock_commit(buffer, event);
3013 /* Again, don't let gcc optimize things here */
3015 __this_cpu_dec(ftrace_stack_reserve);
3016 preempt_enable_notrace();
3020 static inline void ftrace_trace_stack(struct trace_array *tr,
3021 struct trace_buffer *buffer,
3022 unsigned int trace_ctx,
3023 int skip, struct pt_regs *regs)
3025 if (!(tr->trace_flags & TRACE_ITER_STACKTRACE))
3028 __ftrace_trace_stack(tr, buffer, trace_ctx, skip, regs);
3031 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
3034 struct trace_buffer *buffer = tr->array_buffer.buffer;
3036 if (rcu_is_watching()) {
3037 __ftrace_trace_stack(tr, buffer, trace_ctx, skip, NULL);
3041 if (WARN_ON_ONCE(IS_ENABLED(CONFIG_GENERIC_ENTRY)))
3045 * When an NMI triggers, RCU is enabled via ct_nmi_enter(),
3046 * but if the above rcu_is_watching() failed, then the NMI
3047 * triggered someplace critical, and ct_irq_enter() should
3048 * not be called from NMI.
3050 if (unlikely(in_nmi()))
3053 ct_irq_enter_irqson();
3054 __ftrace_trace_stack(tr, buffer, trace_ctx, skip, NULL);
3055 ct_irq_exit_irqson();
3059 * trace_dump_stack - record a stack back trace in the trace buffer
3060 * @skip: Number of functions to skip (helper handlers)
3062 void trace_dump_stack(int skip)
3064 if (tracing_disabled || tracing_selftest_running)
3067 #ifndef CONFIG_UNWINDER_ORC
3068 /* Skip 1 to skip this function. */
3071 __ftrace_trace_stack(printk_trace, printk_trace->array_buffer.buffer,
3072 tracing_gen_ctx(), skip, NULL);
3074 EXPORT_SYMBOL_GPL(trace_dump_stack);
3076 #ifdef CONFIG_USER_STACKTRACE_SUPPORT
3077 static DEFINE_PER_CPU(int, user_stack_count);
3080 ftrace_trace_userstack(struct trace_array *tr,
3081 struct trace_buffer *buffer, unsigned int trace_ctx)
3083 struct ring_buffer_event *event;
3084 struct userstack_entry *entry;
3086 if (!(tr->trace_flags & TRACE_ITER_USERSTACKTRACE))
3090 * NMIs can not handle page faults, even with fix ups.
3091 * The save user stack can (and often does) fault.
3093 if (unlikely(in_nmi()))
3097 * prevent recursion, since the user stack tracing may
3098 * trigger other kernel events.
3101 if (__this_cpu_read(user_stack_count))
3104 __this_cpu_inc(user_stack_count);
3106 event = __trace_buffer_lock_reserve(buffer, TRACE_USER_STACK,
3107 sizeof(*entry), trace_ctx);
3109 goto out_drop_count;
3110 entry = ring_buffer_event_data(event);
3112 entry->tgid = current->tgid;
3113 memset(&entry->caller, 0, sizeof(entry->caller));
3115 stack_trace_save_user(entry->caller, FTRACE_STACK_ENTRIES);
3116 __buffer_unlock_commit(buffer, event);
3119 __this_cpu_dec(user_stack_count);
3123 #else /* CONFIG_USER_STACKTRACE_SUPPORT */
3124 static void ftrace_trace_userstack(struct trace_array *tr,
3125 struct trace_buffer *buffer,
3126 unsigned int trace_ctx)
3129 #endif /* !CONFIG_USER_STACKTRACE_SUPPORT */
3131 #endif /* CONFIG_STACKTRACE */
3134 func_repeats_set_delta_ts(struct func_repeats_entry *entry,
3135 unsigned long long delta)
3137 entry->bottom_delta_ts = delta & U32_MAX;
3138 entry->top_delta_ts = (delta >> 32);
3141 void trace_last_func_repeats(struct trace_array *tr,
3142 struct trace_func_repeats *last_info,
3143 unsigned int trace_ctx)
3145 struct trace_buffer *buffer = tr->array_buffer.buffer;
3146 struct func_repeats_entry *entry;
3147 struct ring_buffer_event *event;
3150 event = __trace_buffer_lock_reserve(buffer, TRACE_FUNC_REPEATS,
3151 sizeof(*entry), trace_ctx);
3155 delta = ring_buffer_event_time_stamp(buffer, event) -
3156 last_info->ts_last_call;
3158 entry = ring_buffer_event_data(event);
3159 entry->ip = last_info->ip;
3160 entry->parent_ip = last_info->parent_ip;
3161 entry->count = last_info->count;
3162 func_repeats_set_delta_ts(entry, delta);
3164 __buffer_unlock_commit(buffer, event);
3167 /* created for use with alloc_percpu */
3168 struct trace_buffer_struct {
3170 char buffer[4][TRACE_BUF_SIZE];
3173 static struct trace_buffer_struct __percpu *trace_percpu_buffer;
3176 * This allows for lockless recording. If we're nested too deeply, then
3177 * this returns NULL.
3179 static char *get_trace_buf(void)
3181 struct trace_buffer_struct *buffer = this_cpu_ptr(trace_percpu_buffer);
3183 if (!trace_percpu_buffer || buffer->nesting >= 4)
3188 /* Interrupts must see nesting incremented before we use the buffer */
3190 return &buffer->buffer[buffer->nesting - 1][0];
3193 static void put_trace_buf(void)
3195 /* Don't let the decrement of nesting leak before this */
3197 this_cpu_dec(trace_percpu_buffer->nesting);
3200 static int alloc_percpu_trace_buffer(void)
3202 struct trace_buffer_struct __percpu *buffers;
3204 if (trace_percpu_buffer)
3207 buffers = alloc_percpu(struct trace_buffer_struct);
3208 if (MEM_FAIL(!buffers, "Could not allocate percpu trace_printk buffer"))
3211 trace_percpu_buffer = buffers;
3215 static int buffers_allocated;
3217 void trace_printk_init_buffers(void)
3219 if (buffers_allocated)
3222 if (alloc_percpu_trace_buffer())
3225 /* trace_printk() is for debug use only. Don't use it in production. */
3228 pr_warn("**********************************************************\n");
3229 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3231 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
3233 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
3234 pr_warn("** unsafe for production use. **\n");
3236 pr_warn("** If you see this message and you are not debugging **\n");
3237 pr_warn("** the kernel, report this immediately to your vendor! **\n");
3239 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3240 pr_warn("**********************************************************\n");
3242 /* Expand the buffers to set size */
3243 tracing_update_buffers(&global_trace);
3245 buffers_allocated = 1;
3248 * trace_printk_init_buffers() can be called by modules.
3249 * If that happens, then we need to start cmdline recording
3250 * directly here. If the global_trace.buffer is already
3251 * allocated here, then this was called by module code.
3253 if (global_trace.array_buffer.buffer)
3254 tracing_start_cmdline_record();
3256 EXPORT_SYMBOL_GPL(trace_printk_init_buffers);
3258 void trace_printk_start_comm(void)
3260 /* Start tracing comms if trace printk is set */
3261 if (!buffers_allocated)
3263 tracing_start_cmdline_record();
3266 static void trace_printk_start_stop_comm(int enabled)
3268 if (!buffers_allocated)
3272 tracing_start_cmdline_record();
3274 tracing_stop_cmdline_record();
3278 * trace_vbprintk - write binary msg to tracing buffer
3279 * @ip: The address of the caller
3280 * @fmt: The string format to write to the buffer
3281 * @args: Arguments for @fmt
3283 int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)
3285 struct ring_buffer_event *event;
3286 struct trace_buffer *buffer;
3287 struct trace_array *tr = READ_ONCE(printk_trace);
3288 struct bprint_entry *entry;
3289 unsigned int trace_ctx;
3293 if (!printk_binsafe(tr))
3294 return trace_vprintk(ip, fmt, args);
3296 if (unlikely(tracing_selftest_running || tracing_disabled))
3299 /* Don't pollute graph traces with trace_vprintk internals */
3300 pause_graph_tracing();
3302 trace_ctx = tracing_gen_ctx();
3303 preempt_disable_notrace();
3305 tbuffer = get_trace_buf();
3311 len = vbin_printf((u32 *)tbuffer, TRACE_BUF_SIZE/sizeof(int), fmt, args);
3313 if (len > TRACE_BUF_SIZE/sizeof(int) || len < 0)
3316 size = sizeof(*entry) + sizeof(u32) * len;
3317 buffer = tr->array_buffer.buffer;
3318 ring_buffer_nest_start(buffer);
3319 event = __trace_buffer_lock_reserve(buffer, TRACE_BPRINT, size,
3323 entry = ring_buffer_event_data(event);
3327 memcpy(entry->buf, tbuffer, sizeof(u32) * len);
3328 __buffer_unlock_commit(buffer, event);
3329 ftrace_trace_stack(tr, buffer, trace_ctx, 6, NULL);
3332 ring_buffer_nest_end(buffer);
3337 preempt_enable_notrace();
3338 unpause_graph_tracing();
3342 EXPORT_SYMBOL_GPL(trace_vbprintk);
3346 __trace_array_vprintk(struct trace_buffer *buffer,
3347 unsigned long ip, const char *fmt, va_list args)
3349 struct ring_buffer_event *event;
3351 struct print_entry *entry;
3352 unsigned int trace_ctx;
3355 if (tracing_disabled)
3358 /* Don't pollute graph traces with trace_vprintk internals */
3359 pause_graph_tracing();
3361 trace_ctx = tracing_gen_ctx();
3362 preempt_disable_notrace();
3365 tbuffer = get_trace_buf();
3371 len = vscnprintf(tbuffer, TRACE_BUF_SIZE, fmt, args);
3373 size = sizeof(*entry) + len + 1;
3374 ring_buffer_nest_start(buffer);
3375 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
3379 entry = ring_buffer_event_data(event);
3382 memcpy(&entry->buf, tbuffer, len + 1);
3383 __buffer_unlock_commit(buffer, event);
3384 ftrace_trace_stack(printk_trace, buffer, trace_ctx, 6, NULL);
3387 ring_buffer_nest_end(buffer);
3391 preempt_enable_notrace();
3392 unpause_graph_tracing();
3398 int trace_array_vprintk(struct trace_array *tr,
3399 unsigned long ip, const char *fmt, va_list args)
3401 if (tracing_selftest_running && tr == &global_trace)
3404 return __trace_array_vprintk(tr->array_buffer.buffer, ip, fmt, args);
3408 * trace_array_printk - Print a message to a specific instance
3409 * @tr: The instance trace_array descriptor
3410 * @ip: The instruction pointer that this is called from.
3411 * @fmt: The format to print (printf format)
3413 * If a subsystem sets up its own instance, they have the right to
3414 * printk strings into their tracing instance buffer using this
3415 * function. Note, this function will not write into the top level
3416 * buffer (use trace_printk() for that), as writing into the top level
3417 * buffer should only have events that can be individually disabled.
3418 * trace_printk() is only used for debugging a kernel, and should not
3419 * be ever incorporated in normal use.
3421 * trace_array_printk() can be used, as it will not add noise to the
3422 * top level tracing buffer.
3424 * Note, trace_array_init_printk() must be called on @tr before this
3428 int trace_array_printk(struct trace_array *tr,
3429 unsigned long ip, const char *fmt, ...)
3437 /* This is only allowed for created instances */
3438 if (tr == &global_trace)
3441 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
3445 ret = trace_array_vprintk(tr, ip, fmt, ap);
3449 EXPORT_SYMBOL_GPL(trace_array_printk);
3452 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3453 * @tr: The trace array to initialize the buffers for
3455 * As trace_array_printk() only writes into instances, they are OK to
3456 * have in the kernel (unlike trace_printk()). This needs to be called
3457 * before trace_array_printk() can be used on a trace_array.
3459 int trace_array_init_printk(struct trace_array *tr)
3464 /* This is only allowed for created instances */
3465 if (tr == &global_trace)
3468 return alloc_percpu_trace_buffer();
3470 EXPORT_SYMBOL_GPL(trace_array_init_printk);
3473 int trace_array_printk_buf(struct trace_buffer *buffer,
3474 unsigned long ip, const char *fmt, ...)
3479 if (!(printk_trace->trace_flags & TRACE_ITER_PRINTK))
3483 ret = __trace_array_vprintk(buffer, ip, fmt, ap);
3489 int trace_vprintk(unsigned long ip, const char *fmt, va_list args)
3491 return trace_array_vprintk(printk_trace, ip, fmt, args);
3493 EXPORT_SYMBOL_GPL(trace_vprintk);
3495 static void trace_iterator_increment(struct trace_iterator *iter)
3497 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, iter->cpu);
3501 ring_buffer_iter_advance(buf_iter);
3504 static struct trace_entry *
3505 peek_next_entry(struct trace_iterator *iter, int cpu, u64 *ts,
3506 unsigned long *lost_events)
3508 struct ring_buffer_event *event;
3509 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, cpu);
3512 event = ring_buffer_iter_peek(buf_iter, ts);
3514 *lost_events = ring_buffer_iter_dropped(buf_iter) ?
3515 (unsigned long)-1 : 0;
3517 event = ring_buffer_peek(iter->array_buffer->buffer, cpu, ts,
3522 iter->ent_size = ring_buffer_event_length(event);
3523 return ring_buffer_event_data(event);
3529 static struct trace_entry *
3530 __find_next_entry(struct trace_iterator *iter, int *ent_cpu,
3531 unsigned long *missing_events, u64 *ent_ts)
3533 struct trace_buffer *buffer = iter->array_buffer->buffer;
3534 struct trace_entry *ent, *next = NULL;
3535 unsigned long lost_events = 0, next_lost = 0;
3536 int cpu_file = iter->cpu_file;
3537 u64 next_ts = 0, ts;
3543 * If we are in a per_cpu trace file, don't bother by iterating over
3544 * all cpu and peek directly.
3546 if (cpu_file > RING_BUFFER_ALL_CPUS) {
3547 if (ring_buffer_empty_cpu(buffer, cpu_file))
3549 ent = peek_next_entry(iter, cpu_file, ent_ts, missing_events);
3551 *ent_cpu = cpu_file;
3556 for_each_tracing_cpu(cpu) {
3558 if (ring_buffer_empty_cpu(buffer, cpu))
3561 ent = peek_next_entry(iter, cpu, &ts, &lost_events);
3564 * Pick the entry with the smallest timestamp:
3566 if (ent && (!next || ts < next_ts)) {
3570 next_lost = lost_events;
3571 next_size = iter->ent_size;
3575 iter->ent_size = next_size;
3578 *ent_cpu = next_cpu;
3584 *missing_events = next_lost;
3589 #define STATIC_FMT_BUF_SIZE 128
3590 static char static_fmt_buf[STATIC_FMT_BUF_SIZE];
3592 char *trace_iter_expand_format(struct trace_iterator *iter)
3597 * iter->tr is NULL when used with tp_printk, which makes
3598 * this get called where it is not safe to call krealloc().
3600 if (!iter->tr || iter->fmt == static_fmt_buf)
3603 tmp = krealloc(iter->fmt, iter->fmt_size + STATIC_FMT_BUF_SIZE,
3606 iter->fmt_size += STATIC_FMT_BUF_SIZE;
3613 /* Returns true if the string is safe to dereference from an event */
3614 static bool trace_safe_str(struct trace_iterator *iter, const char *str)
3616 unsigned long addr = (unsigned long)str;
3617 struct trace_event *trace_event;
3618 struct trace_event_call *event;
3620 /* OK if part of the event data */
3621 if ((addr >= (unsigned long)iter->ent) &&
3622 (addr < (unsigned long)iter->ent + iter->ent_size))
3625 /* OK if part of the temp seq buffer */
3626 if ((addr >= (unsigned long)iter->tmp_seq.buffer) &&
3627 (addr < (unsigned long)iter->tmp_seq.buffer + TRACE_SEQ_BUFFER_SIZE))
3630 /* Core rodata can not be freed */
3631 if (is_kernel_rodata(addr))
3634 if (trace_is_tracepoint_string(str))
3638 * Now this could be a module event, referencing core module
3639 * data, which is OK.
3644 trace_event = ftrace_find_event(iter->ent->type);
3648 event = container_of(trace_event, struct trace_event_call, event);
3649 if ((event->flags & TRACE_EVENT_FL_DYNAMIC) || !event->module)
3652 /* Would rather have rodata, but this will suffice */
3653 if (within_module_core(addr, event->module))
3660 * ignore_event - Check dereferenced fields while writing to the seq buffer
3661 * @iter: The iterator that holds the seq buffer and the event being printed
3663 * At boot up, test_event_printk() will flag any event that dereferences
3664 * a string with "%s" that does exist in the ring buffer. It may still
3665 * be valid, as the string may point to a static string in the kernel
3666 * rodata that never gets freed. But if the string pointer is pointing
3667 * to something that was allocated, there's a chance that it can be freed
3668 * by the time the user reads the trace. This would cause a bad memory
3669 * access by the kernel and possibly crash the system.
3671 * This function will check if the event has any fields flagged as needing
3672 * to be checked at runtime and perform those checks.
3674 * If it is found that a field is unsafe, it will write into the @iter->seq
3675 * a message stating what was found to be unsafe.
3677 * @return: true if the event is unsafe and should be ignored,
3680 bool ignore_event(struct trace_iterator *iter)
3682 struct ftrace_event_field *field;
3683 struct trace_event *trace_event;
3684 struct trace_event_call *event;
3685 struct list_head *head;
3686 struct trace_seq *seq;
3689 trace_event = ftrace_find_event(iter->ent->type);
3694 trace_seq_printf(seq, "EVENT ID %d NOT FOUND?\n", iter->ent->type);
3698 event = container_of(trace_event, struct trace_event_call, event);
3699 if (!(event->flags & TRACE_EVENT_FL_TEST_STR))
3702 head = trace_get_fields(event);
3704 trace_seq_printf(seq, "FIELDS FOR EVENT '%s' NOT FOUND?\n",
3705 trace_event_name(event));
3709 /* Offsets are from the iter->ent that points to the raw event */
3712 list_for_each_entry(field, head, link) {
3716 if (!field->needs_test)
3719 str = *(const char **)(ptr + field->offset);
3721 good = trace_safe_str(iter, str);
3724 * If you hit this warning, it is likely that the
3725 * trace event in question used %s on a string that
3726 * was saved at the time of the event, but may not be
3727 * around when the trace is read. Use __string(),
3728 * __assign_str() and __get_str() helpers in the TRACE_EVENT()
3729 * instead. See samples/trace_events/trace-events-sample.h
3732 if (WARN_ONCE(!good, "event '%s' has unsafe pointer field '%s'",
3733 trace_event_name(event), field->name)) {
3734 trace_seq_printf(seq, "EVENT %s: HAS UNSAFE POINTER FIELD '%s'\n",
3735 trace_event_name(event), field->name);
3742 const char *trace_event_format(struct trace_iterator *iter, const char *fmt)
3744 const char *p, *new_fmt;
3747 if (WARN_ON_ONCE(!fmt))
3750 if (!iter->tr || iter->tr->trace_flags & TRACE_ITER_HASH_PTR)
3754 new_fmt = q = iter->fmt;
3756 if (unlikely(q - new_fmt + 3 > iter->fmt_size)) {
3757 if (!trace_iter_expand_format(iter))
3760 q += iter->fmt - new_fmt;
3761 new_fmt = iter->fmt;
3766 /* Replace %p with %px */
3770 } else if (p[0] == 'p' && !isalnum(p[1])) {
3781 #define STATIC_TEMP_BUF_SIZE 128
3782 static char static_temp_buf[STATIC_TEMP_BUF_SIZE] __aligned(4);
3784 /* Find the next real entry, without updating the iterator itself */
3785 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
3786 int *ent_cpu, u64 *ent_ts)
3788 /* __find_next_entry will reset ent_size */
3789 int ent_size = iter->ent_size;
3790 struct trace_entry *entry;
3793 * If called from ftrace_dump(), then the iter->temp buffer
3794 * will be the static_temp_buf and not created from kmalloc.
3795 * If the entry size is greater than the buffer, we can
3796 * not save it. Just return NULL in that case. This is only
3797 * used to add markers when two consecutive events' time
3798 * stamps have a large delta. See trace_print_lat_context()
3800 if (iter->temp == static_temp_buf &&
3801 STATIC_TEMP_BUF_SIZE < ent_size)
3805 * The __find_next_entry() may call peek_next_entry(), which may
3806 * call ring_buffer_peek() that may make the contents of iter->ent
3807 * undefined. Need to copy iter->ent now.
3809 if (iter->ent && iter->ent != iter->temp) {
3810 if ((!iter->temp || iter->temp_size < iter->ent_size) &&
3811 !WARN_ON_ONCE(iter->temp == static_temp_buf)) {
3813 temp = kmalloc(iter->ent_size, GFP_KERNEL);
3818 iter->temp_size = iter->ent_size;
3820 memcpy(iter->temp, iter->ent, iter->ent_size);
3821 iter->ent = iter->temp;
3823 entry = __find_next_entry(iter, ent_cpu, NULL, ent_ts);
3824 /* Put back the original ent_size */
3825 iter->ent_size = ent_size;
3830 /* Find the next real entry, and increment the iterator to the next entry */
3831 void *trace_find_next_entry_inc(struct trace_iterator *iter)
3833 iter->ent = __find_next_entry(iter, &iter->cpu,
3834 &iter->lost_events, &iter->ts);
3837 trace_iterator_increment(iter);
3839 return iter->ent ? iter : NULL;
3842 static void trace_consume(struct trace_iterator *iter)
3844 ring_buffer_consume(iter->array_buffer->buffer, iter->cpu, &iter->ts,
3845 &iter->lost_events);
3848 static void *s_next(struct seq_file *m, void *v, loff_t *pos)
3850 struct trace_iterator *iter = m->private;
3854 WARN_ON_ONCE(iter->leftover);
3858 /* can't go backwards */
3863 ent = trace_find_next_entry_inc(iter);
3867 while (ent && iter->idx < i)
3868 ent = trace_find_next_entry_inc(iter);
3875 void tracing_iter_reset(struct trace_iterator *iter, int cpu)
3877 struct ring_buffer_iter *buf_iter;
3878 unsigned long entries = 0;
3881 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = 0;
3883 buf_iter = trace_buffer_iter(iter, cpu);
3887 ring_buffer_iter_reset(buf_iter);
3890 * We could have the case with the max latency tracers
3891 * that a reset never took place on a cpu. This is evident
3892 * by the timestamp being before the start of the buffer.
3894 while (ring_buffer_iter_peek(buf_iter, &ts)) {
3895 if (ts >= iter->array_buffer->time_start)
3898 ring_buffer_iter_advance(buf_iter);
3899 /* This could be a big loop */
3903 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = entries;
3907 * The current tracer is copied to avoid a global locking
3910 static void *s_start(struct seq_file *m, loff_t *pos)
3912 struct trace_iterator *iter = m->private;
3913 struct trace_array *tr = iter->tr;
3914 int cpu_file = iter->cpu_file;
3919 mutex_lock(&trace_types_lock);
3920 if (unlikely(tr->current_trace != iter->trace)) {
3921 /* Close iter->trace before switching to the new current tracer */
3922 if (iter->trace->close)
3923 iter->trace->close(iter);
3924 iter->trace = tr->current_trace;
3925 /* Reopen the new current tracer */
3926 if (iter->trace->open)
3927 iter->trace->open(iter);
3929 mutex_unlock(&trace_types_lock);
3931 #ifdef CONFIG_TRACER_MAX_TRACE
3932 if (iter->snapshot && iter->trace->use_max_tr)
3933 return ERR_PTR(-EBUSY);
3936 if (*pos != iter->pos) {
3941 if (cpu_file == RING_BUFFER_ALL_CPUS) {
3942 for_each_tracing_cpu(cpu)
3943 tracing_iter_reset(iter, cpu);
3945 tracing_iter_reset(iter, cpu_file);
3948 for (p = iter; p && l < *pos; p = s_next(m, p, &l))
3953 * If we overflowed the seq_file before, then we want
3954 * to just reuse the trace_seq buffer again.
3960 p = s_next(m, p, &l);
3964 trace_event_read_lock();
3965 trace_access_lock(cpu_file);
3969 static void s_stop(struct seq_file *m, void *p)
3971 struct trace_iterator *iter = m->private;
3973 #ifdef CONFIG_TRACER_MAX_TRACE
3974 if (iter->snapshot && iter->trace->use_max_tr)
3978 trace_access_unlock(iter->cpu_file);
3979 trace_event_read_unlock();
3983 get_total_entries_cpu(struct array_buffer *buf, unsigned long *total,
3984 unsigned long *entries, int cpu)
3986 unsigned long count;
3988 count = ring_buffer_entries_cpu(buf->buffer, cpu);
3990 * If this buffer has skipped entries, then we hold all
3991 * entries for the trace and we need to ignore the
3992 * ones before the time stamp.
3994 if (per_cpu_ptr(buf->data, cpu)->skipped_entries) {
3995 count -= per_cpu_ptr(buf->data, cpu)->skipped_entries;
3996 /* total is the same as the entries */
4000 ring_buffer_overrun_cpu(buf->buffer, cpu);
4005 get_total_entries(struct array_buffer *buf,
4006 unsigned long *total, unsigned long *entries)
4014 for_each_tracing_cpu(cpu) {
4015 get_total_entries_cpu(buf, &t, &e, cpu);
4021 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu)
4023 unsigned long total, entries;
4028 get_total_entries_cpu(&tr->array_buffer, &total, &entries, cpu);
4033 unsigned long trace_total_entries(struct trace_array *tr)
4035 unsigned long total, entries;
4040 get_total_entries(&tr->array_buffer, &total, &entries);
4045 static void print_lat_help_header(struct seq_file *m)
4047 seq_puts(m, "# _------=> CPU# \n"
4048 "# / _-----=> irqs-off/BH-disabled\n"
4049 "# | / _----=> need-resched \n"
4050 "# || / _---=> hardirq/softirq \n"
4051 "# ||| / _--=> preempt-depth \n"
4052 "# |||| / _-=> migrate-disable \n"
4053 "# ||||| / delay \n"
4054 "# cmd pid |||||| time | caller \n"
4055 "# \\ / |||||| \\ | / \n");
4058 static void print_event_info(struct array_buffer *buf, struct seq_file *m)
4060 unsigned long total;
4061 unsigned long entries;
4063 get_total_entries(buf, &total, &entries);
4064 seq_printf(m, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
4065 entries, total, num_online_cpus());
4069 static void print_func_help_header(struct array_buffer *buf, struct seq_file *m,
4072 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4074 print_event_info(buf, m);
4076 seq_printf(m, "# TASK-PID %s CPU# TIMESTAMP FUNCTION\n", tgid ? " TGID " : "");
4077 seq_printf(m, "# | | %s | | |\n", tgid ? " | " : "");
4080 static void print_func_help_header_irq(struct array_buffer *buf, struct seq_file *m,
4083 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4084 static const char space[] = " ";
4085 int prec = tgid ? 12 : 2;
4087 print_event_info(buf, m);
4089 seq_printf(m, "# %.*s _-----=> irqs-off/BH-disabled\n", prec, space);
4090 seq_printf(m, "# %.*s / _----=> need-resched\n", prec, space);
4091 seq_printf(m, "# %.*s| / _---=> hardirq/softirq\n", prec, space);
4092 seq_printf(m, "# %.*s|| / _--=> preempt-depth\n", prec, space);
4093 seq_printf(m, "# %.*s||| / _-=> migrate-disable\n", prec, space);
4094 seq_printf(m, "# %.*s|||| / delay\n", prec, space);
4095 seq_printf(m, "# TASK-PID %.*s CPU# ||||| TIMESTAMP FUNCTION\n", prec, " TGID ");
4096 seq_printf(m, "# | | %.*s | ||||| | |\n", prec, " | ");
4100 print_trace_header(struct seq_file *m, struct trace_iterator *iter)
4102 unsigned long sym_flags = (global_trace.trace_flags & TRACE_ITER_SYM_MASK);
4103 struct array_buffer *buf = iter->array_buffer;
4104 struct trace_array_cpu *data = per_cpu_ptr(buf->data, buf->cpu);
4105 struct tracer *type = iter->trace;
4106 unsigned long entries;
4107 unsigned long total;
4108 const char *name = type->name;
4110 get_total_entries(buf, &total, &entries);
4112 seq_printf(m, "# %s latency trace v1.1.5 on %s\n",
4113 name, init_utsname()->release);
4114 seq_puts(m, "# -----------------------------------"
4115 "---------------------------------\n");
4116 seq_printf(m, "# latency: %lu us, #%lu/%lu, CPU#%d |"
4117 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
4118 nsecs_to_usecs(data->saved_latency),
4122 preempt_model_none() ? "server" :
4123 preempt_model_voluntary() ? "desktop" :
4124 preempt_model_full() ? "preempt" :
4125 preempt_model_rt() ? "preempt_rt" :
4127 /* These are reserved for later use */
4130 seq_printf(m, " #P:%d)\n", num_online_cpus());
4134 seq_puts(m, "# -----------------\n");
4135 seq_printf(m, "# | task: %.16s-%d "
4136 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
4137 data->comm, data->pid,
4138 from_kuid_munged(seq_user_ns(m), data->uid), data->nice,
4139 data->policy, data->rt_priority);
4140 seq_puts(m, "# -----------------\n");
4142 if (data->critical_start) {
4143 seq_puts(m, "# => started at: ");
4144 seq_print_ip_sym(&iter->seq, data->critical_start, sym_flags);
4145 trace_print_seq(m, &iter->seq);
4146 seq_puts(m, "\n# => ended at: ");
4147 seq_print_ip_sym(&iter->seq, data->critical_end, sym_flags);
4148 trace_print_seq(m, &iter->seq);
4149 seq_puts(m, "\n#\n");
4155 static void test_cpu_buff_start(struct trace_iterator *iter)
4157 struct trace_seq *s = &iter->seq;
4158 struct trace_array *tr = iter->tr;
4160 if (!(tr->trace_flags & TRACE_ITER_ANNOTATE))
4163 if (!(iter->iter_flags & TRACE_FILE_ANNOTATE))
4166 if (cpumask_available(iter->started) &&
4167 cpumask_test_cpu(iter->cpu, iter->started))
4170 if (per_cpu_ptr(iter->array_buffer->data, iter->cpu)->skipped_entries)
4173 if (cpumask_available(iter->started))
4174 cpumask_set_cpu(iter->cpu, iter->started);
4176 /* Don't print started cpu buffer for the first entry of the trace */
4178 trace_seq_printf(s, "##### CPU %u buffer started ####\n",
4182 static enum print_line_t print_trace_fmt(struct trace_iterator *iter)
4184 struct trace_array *tr = iter->tr;
4185 struct trace_seq *s = &iter->seq;
4186 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
4187 struct trace_entry *entry;
4188 struct trace_event *event;
4192 test_cpu_buff_start(iter);
4194 event = ftrace_find_event(entry->type);
4196 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4197 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4198 trace_print_lat_context(iter);
4200 trace_print_context(iter);
4203 if (trace_seq_has_overflowed(s))
4204 return TRACE_TYPE_PARTIAL_LINE;
4207 if (tr->trace_flags & TRACE_ITER_FIELDS)
4208 return print_event_fields(iter, event);
4210 * For TRACE_EVENT() events, the print_fmt is not
4211 * safe to use if the array has delta offsets
4212 * Force printing via the fields.
4214 if ((tr->text_delta || tr->data_delta) &&
4215 event->type > __TRACE_LAST_TYPE)
4216 return print_event_fields(iter, event);
4218 return event->funcs->trace(iter, sym_flags, event);
4221 trace_seq_printf(s, "Unknown type %d\n", entry->type);
4223 return trace_handle_return(s);
4226 static enum print_line_t print_raw_fmt(struct trace_iterator *iter)
4228 struct trace_array *tr = iter->tr;
4229 struct trace_seq *s = &iter->seq;
4230 struct trace_entry *entry;
4231 struct trace_event *event;
4235 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO)
4236 trace_seq_printf(s, "%d %d %llu ",
4237 entry->pid, iter->cpu, iter->ts);
4239 if (trace_seq_has_overflowed(s))
4240 return TRACE_TYPE_PARTIAL_LINE;
4242 event = ftrace_find_event(entry->type);
4244 return event->funcs->raw(iter, 0, event);
4246 trace_seq_printf(s, "%d ?\n", entry->type);
4248 return trace_handle_return(s);
4251 static enum print_line_t print_hex_fmt(struct trace_iterator *iter)
4253 struct trace_array *tr = iter->tr;
4254 struct trace_seq *s = &iter->seq;
4255 unsigned char newline = '\n';
4256 struct trace_entry *entry;
4257 struct trace_event *event;
4261 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4262 SEQ_PUT_HEX_FIELD(s, entry->pid);
4263 SEQ_PUT_HEX_FIELD(s, iter->cpu);
4264 SEQ_PUT_HEX_FIELD(s, iter->ts);
4265 if (trace_seq_has_overflowed(s))
4266 return TRACE_TYPE_PARTIAL_LINE;
4269 event = ftrace_find_event(entry->type);
4271 enum print_line_t ret = event->funcs->hex(iter, 0, event);
4272 if (ret != TRACE_TYPE_HANDLED)
4276 SEQ_PUT_FIELD(s, newline);
4278 return trace_handle_return(s);
4281 static enum print_line_t print_bin_fmt(struct trace_iterator *iter)
4283 struct trace_array *tr = iter->tr;
4284 struct trace_seq *s = &iter->seq;
4285 struct trace_entry *entry;
4286 struct trace_event *event;
4290 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4291 SEQ_PUT_FIELD(s, entry->pid);
4292 SEQ_PUT_FIELD(s, iter->cpu);
4293 SEQ_PUT_FIELD(s, iter->ts);
4294 if (trace_seq_has_overflowed(s))
4295 return TRACE_TYPE_PARTIAL_LINE;
4298 event = ftrace_find_event(entry->type);
4299 return event ? event->funcs->binary(iter, 0, event) :
4303 int trace_empty(struct trace_iterator *iter)
4305 struct ring_buffer_iter *buf_iter;
4308 /* If we are looking at one CPU buffer, only check that one */
4309 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
4310 cpu = iter->cpu_file;
4311 buf_iter = trace_buffer_iter(iter, cpu);
4313 if (!ring_buffer_iter_empty(buf_iter))
4316 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4322 for_each_tracing_cpu(cpu) {
4323 buf_iter = trace_buffer_iter(iter, cpu);
4325 if (!ring_buffer_iter_empty(buf_iter))
4328 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4336 /* Called with trace_event_read_lock() held. */
4337 enum print_line_t print_trace_line(struct trace_iterator *iter)
4339 struct trace_array *tr = iter->tr;
4340 unsigned long trace_flags = tr->trace_flags;
4341 enum print_line_t ret;
4343 if (iter->lost_events) {
4344 if (iter->lost_events == (unsigned long)-1)
4345 trace_seq_printf(&iter->seq, "CPU:%d [LOST EVENTS]\n",
4348 trace_seq_printf(&iter->seq, "CPU:%d [LOST %lu EVENTS]\n",
4349 iter->cpu, iter->lost_events);
4350 if (trace_seq_has_overflowed(&iter->seq))
4351 return TRACE_TYPE_PARTIAL_LINE;
4354 if (iter->trace && iter->trace->print_line) {
4355 ret = iter->trace->print_line(iter);
4356 if (ret != TRACE_TYPE_UNHANDLED)
4360 if (iter->ent->type == TRACE_BPUTS &&
4361 trace_flags & TRACE_ITER_PRINTK &&
4362 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4363 return trace_print_bputs_msg_only(iter);
4365 if (iter->ent->type == TRACE_BPRINT &&
4366 trace_flags & TRACE_ITER_PRINTK &&
4367 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4368 return trace_print_bprintk_msg_only(iter);
4370 if (iter->ent->type == TRACE_PRINT &&
4371 trace_flags & TRACE_ITER_PRINTK &&
4372 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4373 return trace_print_printk_msg_only(iter);
4375 if (trace_flags & TRACE_ITER_BIN)
4376 return print_bin_fmt(iter);
4378 if (trace_flags & TRACE_ITER_HEX)
4379 return print_hex_fmt(iter);
4381 if (trace_flags & TRACE_ITER_RAW)
4382 return print_raw_fmt(iter);
4384 return print_trace_fmt(iter);
4387 void trace_latency_header(struct seq_file *m)
4389 struct trace_iterator *iter = m->private;
4390 struct trace_array *tr = iter->tr;
4392 /* print nothing if the buffers are empty */
4393 if (trace_empty(iter))
4396 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4397 print_trace_header(m, iter);
4399 if (!(tr->trace_flags & TRACE_ITER_VERBOSE))
4400 print_lat_help_header(m);
4403 void trace_default_header(struct seq_file *m)
4405 struct trace_iterator *iter = m->private;
4406 struct trace_array *tr = iter->tr;
4407 unsigned long trace_flags = tr->trace_flags;
4409 if (!(trace_flags & TRACE_ITER_CONTEXT_INFO))
4412 if (iter->iter_flags & TRACE_FILE_LAT_FMT) {
4413 /* print nothing if the buffers are empty */
4414 if (trace_empty(iter))
4416 print_trace_header(m, iter);
4417 if (!(trace_flags & TRACE_ITER_VERBOSE))
4418 print_lat_help_header(m);
4420 if (!(trace_flags & TRACE_ITER_VERBOSE)) {
4421 if (trace_flags & TRACE_ITER_IRQ_INFO)
4422 print_func_help_header_irq(iter->array_buffer,
4425 print_func_help_header(iter->array_buffer, m,
4431 static void test_ftrace_alive(struct seq_file *m)
4433 if (!ftrace_is_dead())
4435 seq_puts(m, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
4436 "# MAY BE MISSING FUNCTION EVENTS\n");
4439 #ifdef CONFIG_TRACER_MAX_TRACE
4440 static void show_snapshot_main_help(struct seq_file *m)
4442 seq_puts(m, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
4443 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4444 "# Takes a snapshot of the main buffer.\n"
4445 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
4446 "# (Doesn't have to be '2' works with any number that\n"
4447 "# is not a '0' or '1')\n");
4450 static void show_snapshot_percpu_help(struct seq_file *m)
4452 seq_puts(m, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
4453 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
4454 seq_puts(m, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4455 "# Takes a snapshot of the main buffer for this cpu.\n");
4457 seq_puts(m, "# echo 1 > snapshot : Not supported with this kernel.\n"
4458 "# Must use main snapshot file to allocate.\n");
4460 seq_puts(m, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
4461 "# (Doesn't have to be '2' works with any number that\n"
4462 "# is not a '0' or '1')\n");
4465 static void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter)
4467 if (iter->tr->allocated_snapshot)
4468 seq_puts(m, "#\n# * Snapshot is allocated *\n#\n");
4470 seq_puts(m, "#\n# * Snapshot is freed *\n#\n");
4472 seq_puts(m, "# Snapshot commands:\n");
4473 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
4474 show_snapshot_main_help(m);
4476 show_snapshot_percpu_help(m);
4479 /* Should never be called */
4480 static inline void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter) { }
4483 static int s_show(struct seq_file *m, void *v)
4485 struct trace_iterator *iter = v;
4488 if (iter->ent == NULL) {
4490 seq_printf(m, "# tracer: %s\n", iter->trace->name);
4492 test_ftrace_alive(m);
4494 if (iter->snapshot && trace_empty(iter))
4495 print_snapshot_help(m, iter);
4496 else if (iter->trace && iter->trace->print_header)
4497 iter->trace->print_header(m);
4499 trace_default_header(m);
4501 } else if (iter->leftover) {
4503 * If we filled the seq_file buffer earlier, we
4504 * want to just show it now.
4506 ret = trace_print_seq(m, &iter->seq);
4508 /* ret should this time be zero, but you never know */
4509 iter->leftover = ret;
4512 ret = print_trace_line(iter);
4513 if (ret == TRACE_TYPE_PARTIAL_LINE) {
4515 trace_seq_puts(&iter->seq, "[LINE TOO BIG]\n");
4517 ret = trace_print_seq(m, &iter->seq);
4519 * If we overflow the seq_file buffer, then it will
4520 * ask us for this data again at start up.
4522 * ret is 0 if seq_file write succeeded.
4525 iter->leftover = ret;
4532 * Should be used after trace_array_get(), trace_types_lock
4533 * ensures that i_cdev was already initialized.
4535 static inline int tracing_get_cpu(struct inode *inode)
4537 if (inode->i_cdev) /* See trace_create_cpu_file() */
4538 return (long)inode->i_cdev - 1;
4539 return RING_BUFFER_ALL_CPUS;
4542 static const struct seq_operations tracer_seq_ops = {
4550 * Note, as iter itself can be allocated and freed in different
4551 * ways, this function is only used to free its content, and not
4552 * the iterator itself. The only requirement to all the allocations
4553 * is that it must zero all fields (kzalloc), as freeing works with
4554 * ethier allocated content or NULL.
4556 static void free_trace_iter_content(struct trace_iterator *iter)
4558 /* The fmt is either NULL, allocated or points to static_fmt_buf */
4559 if (iter->fmt != static_fmt_buf)
4563 kfree(iter->buffer_iter);
4564 mutex_destroy(&iter->mutex);
4565 free_cpumask_var(iter->started);
4568 static struct trace_iterator *
4569 __tracing_open(struct inode *inode, struct file *file, bool snapshot)
4571 struct trace_array *tr = inode->i_private;
4572 struct trace_iterator *iter;
4575 if (tracing_disabled)
4576 return ERR_PTR(-ENODEV);
4578 iter = __seq_open_private(file, &tracer_seq_ops, sizeof(*iter));
4580 return ERR_PTR(-ENOMEM);
4582 iter->buffer_iter = kcalloc(nr_cpu_ids, sizeof(*iter->buffer_iter),
4584 if (!iter->buffer_iter)
4588 * trace_find_next_entry() may need to save off iter->ent.
4589 * It will place it into the iter->temp buffer. As most
4590 * events are less than 128, allocate a buffer of that size.
4591 * If one is greater, then trace_find_next_entry() will
4592 * allocate a new buffer to adjust for the bigger iter->ent.
4593 * It's not critical if it fails to get allocated here.
4595 iter->temp = kmalloc(128, GFP_KERNEL);
4597 iter->temp_size = 128;
4600 * trace_event_printf() may need to modify given format
4601 * string to replace %p with %px so that it shows real address
4602 * instead of hash value. However, that is only for the event
4603 * tracing, other tracer may not need. Defer the allocation
4604 * until it is needed.
4609 mutex_lock(&trace_types_lock);
4610 iter->trace = tr->current_trace;
4612 if (!zalloc_cpumask_var(&iter->started, GFP_KERNEL))
4617 #ifdef CONFIG_TRACER_MAX_TRACE
4618 /* Currently only the top directory has a snapshot */
4619 if (tr->current_trace->print_max || snapshot)
4620 iter->array_buffer = &tr->max_buffer;
4623 iter->array_buffer = &tr->array_buffer;
4624 iter->snapshot = snapshot;
4626 iter->cpu_file = tracing_get_cpu(inode);
4627 mutex_init(&iter->mutex);
4629 /* Notify the tracer early; before we stop tracing. */
4630 if (iter->trace->open)
4631 iter->trace->open(iter);
4633 /* Annotate start of buffers if we had overruns */
4634 if (ring_buffer_overruns(iter->array_buffer->buffer))
4635 iter->iter_flags |= TRACE_FILE_ANNOTATE;
4637 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
4638 if (trace_clocks[tr->clock_id].in_ns)
4639 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
4642 * If pause-on-trace is enabled, then stop the trace while
4643 * dumping, unless this is the "snapshot" file
4645 if (!iter->snapshot && (tr->trace_flags & TRACE_ITER_PAUSE_ON_TRACE))
4646 tracing_stop_tr(tr);
4648 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
4649 for_each_tracing_cpu(cpu) {
4650 iter->buffer_iter[cpu] =
4651 ring_buffer_read_prepare(iter->array_buffer->buffer,
4654 ring_buffer_read_prepare_sync();
4655 for_each_tracing_cpu(cpu) {
4656 ring_buffer_read_start(iter->buffer_iter[cpu]);
4657 tracing_iter_reset(iter, cpu);
4660 cpu = iter->cpu_file;
4661 iter->buffer_iter[cpu] =
4662 ring_buffer_read_prepare(iter->array_buffer->buffer,
4664 ring_buffer_read_prepare_sync();
4665 ring_buffer_read_start(iter->buffer_iter[cpu]);
4666 tracing_iter_reset(iter, cpu);
4669 mutex_unlock(&trace_types_lock);
4674 mutex_unlock(&trace_types_lock);
4675 free_trace_iter_content(iter);
4677 seq_release_private(inode, file);
4678 return ERR_PTR(-ENOMEM);
4681 int tracing_open_generic(struct inode *inode, struct file *filp)
4685 ret = tracing_check_open_get_tr(NULL);
4689 filp->private_data = inode->i_private;
4693 bool tracing_is_disabled(void)
4695 return (tracing_disabled) ? true: false;
4699 * Open and update trace_array ref count.
4700 * Must have the current trace_array passed to it.
4702 int tracing_open_generic_tr(struct inode *inode, struct file *filp)
4704 struct trace_array *tr = inode->i_private;
4707 ret = tracing_check_open_get_tr(tr);
4711 filp->private_data = inode->i_private;
4717 * The private pointer of the inode is the trace_event_file.
4718 * Update the tr ref count associated to it.
4720 int tracing_open_file_tr(struct inode *inode, struct file *filp)
4722 struct trace_event_file *file = inode->i_private;
4725 ret = tracing_check_open_get_tr(file->tr);
4729 mutex_lock(&event_mutex);
4731 /* Fail if the file is marked for removal */
4732 if (file->flags & EVENT_FILE_FL_FREED) {
4733 trace_array_put(file->tr);
4736 event_file_get(file);
4739 mutex_unlock(&event_mutex);
4743 filp->private_data = inode->i_private;
4748 int tracing_release_file_tr(struct inode *inode, struct file *filp)
4750 struct trace_event_file *file = inode->i_private;
4752 trace_array_put(file->tr);
4753 event_file_put(file);
4758 int tracing_single_release_file_tr(struct inode *inode, struct file *filp)
4760 tracing_release_file_tr(inode, filp);
4761 return single_release(inode, filp);
4764 static int tracing_mark_open(struct inode *inode, struct file *filp)
4766 stream_open(inode, filp);
4767 return tracing_open_generic_tr(inode, filp);
4770 static int tracing_release(struct inode *inode, struct file *file)
4772 struct trace_array *tr = inode->i_private;
4773 struct seq_file *m = file->private_data;
4774 struct trace_iterator *iter;
4777 if (!(file->f_mode & FMODE_READ)) {
4778 trace_array_put(tr);
4782 /* Writes do not use seq_file */
4784 mutex_lock(&trace_types_lock);
4786 for_each_tracing_cpu(cpu) {
4787 if (iter->buffer_iter[cpu])
4788 ring_buffer_read_finish(iter->buffer_iter[cpu]);
4791 if (iter->trace && iter->trace->close)
4792 iter->trace->close(iter);
4794 if (!iter->snapshot && tr->stop_count)
4795 /* reenable tracing if it was previously enabled */
4796 tracing_start_tr(tr);
4798 __trace_array_put(tr);
4800 mutex_unlock(&trace_types_lock);
4802 free_trace_iter_content(iter);
4803 seq_release_private(inode, file);
4808 int tracing_release_generic_tr(struct inode *inode, struct file *file)
4810 struct trace_array *tr = inode->i_private;
4812 trace_array_put(tr);
4816 static int tracing_single_release_tr(struct inode *inode, struct file *file)
4818 struct trace_array *tr = inode->i_private;
4820 trace_array_put(tr);
4822 return single_release(inode, file);
4825 static int tracing_open(struct inode *inode, struct file *file)
4827 struct trace_array *tr = inode->i_private;
4828 struct trace_iterator *iter;
4831 ret = tracing_check_open_get_tr(tr);
4835 /* If this file was open for write, then erase contents */
4836 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
4837 int cpu = tracing_get_cpu(inode);
4838 struct array_buffer *trace_buf = &tr->array_buffer;
4840 #ifdef CONFIG_TRACER_MAX_TRACE
4841 if (tr->current_trace->print_max)
4842 trace_buf = &tr->max_buffer;
4845 if (cpu == RING_BUFFER_ALL_CPUS)
4846 tracing_reset_online_cpus(trace_buf);
4848 tracing_reset_cpu(trace_buf, cpu);
4851 if (file->f_mode & FMODE_READ) {
4852 iter = __tracing_open(inode, file, false);
4854 ret = PTR_ERR(iter);
4855 else if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
4856 iter->iter_flags |= TRACE_FILE_LAT_FMT;
4860 trace_array_put(tr);
4866 * Some tracers are not suitable for instance buffers.
4867 * A tracer is always available for the global array (toplevel)
4868 * or if it explicitly states that it is.
4871 trace_ok_for_array(struct tracer *t, struct trace_array *tr)
4873 #ifdef CONFIG_TRACER_SNAPSHOT
4874 /* arrays with mapped buffer range do not have snapshots */
4875 if (tr->range_addr_start && t->use_max_tr)
4878 return (tr->flags & TRACE_ARRAY_FL_GLOBAL) || t->allow_instances;
4881 /* Find the next tracer that this trace array may use */
4882 static struct tracer *
4883 get_tracer_for_array(struct trace_array *tr, struct tracer *t)
4885 while (t && !trace_ok_for_array(t, tr))
4892 t_next(struct seq_file *m, void *v, loff_t *pos)
4894 struct trace_array *tr = m->private;
4895 struct tracer *t = v;
4900 t = get_tracer_for_array(tr, t->next);
4905 static void *t_start(struct seq_file *m, loff_t *pos)
4907 struct trace_array *tr = m->private;
4911 mutex_lock(&trace_types_lock);
4913 t = get_tracer_for_array(tr, trace_types);
4914 for (; t && l < *pos; t = t_next(m, t, &l))
4920 static void t_stop(struct seq_file *m, void *p)
4922 mutex_unlock(&trace_types_lock);
4925 static int t_show(struct seq_file *m, void *v)
4927 struct tracer *t = v;
4932 seq_puts(m, t->name);
4941 static const struct seq_operations show_traces_seq_ops = {
4948 static int show_traces_open(struct inode *inode, struct file *file)
4950 struct trace_array *tr = inode->i_private;
4954 ret = tracing_check_open_get_tr(tr);
4958 ret = seq_open(file, &show_traces_seq_ops);
4960 trace_array_put(tr);
4964 m = file->private_data;
4970 static int tracing_seq_release(struct inode *inode, struct file *file)
4972 struct trace_array *tr = inode->i_private;
4974 trace_array_put(tr);
4975 return seq_release(inode, file);
4979 tracing_write_stub(struct file *filp, const char __user *ubuf,
4980 size_t count, loff_t *ppos)
4985 loff_t tracing_lseek(struct file *file, loff_t offset, int whence)
4989 if (file->f_mode & FMODE_READ)
4990 ret = seq_lseek(file, offset, whence);
4992 file->f_pos = ret = 0;
4997 static const struct file_operations tracing_fops = {
4998 .open = tracing_open,
5000 .read_iter = seq_read_iter,
5001 .splice_read = copy_splice_read,
5002 .write = tracing_write_stub,
5003 .llseek = tracing_lseek,
5004 .release = tracing_release,
5007 static const struct file_operations show_traces_fops = {
5008 .open = show_traces_open,
5010 .llseek = seq_lseek,
5011 .release = tracing_seq_release,
5015 tracing_cpumask_read(struct file *filp, char __user *ubuf,
5016 size_t count, loff_t *ppos)
5018 struct trace_array *tr = file_inode(filp)->i_private;
5022 len = snprintf(NULL, 0, "%*pb\n",
5023 cpumask_pr_args(tr->tracing_cpumask)) + 1;
5024 mask_str = kmalloc(len, GFP_KERNEL);
5028 len = snprintf(mask_str, len, "%*pb\n",
5029 cpumask_pr_args(tr->tracing_cpumask));
5034 count = simple_read_from_buffer(ubuf, count, ppos, mask_str, len);
5042 int tracing_set_cpumask(struct trace_array *tr,
5043 cpumask_var_t tracing_cpumask_new)
5050 local_irq_disable();
5051 arch_spin_lock(&tr->max_lock);
5052 for_each_tracing_cpu(cpu) {
5054 * Increase/decrease the disabled counter if we are
5055 * about to flip a bit in the cpumask:
5057 if (cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5058 !cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5059 atomic_inc(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5060 ring_buffer_record_disable_cpu(tr->array_buffer.buffer, cpu);
5061 #ifdef CONFIG_TRACER_MAX_TRACE
5062 ring_buffer_record_disable_cpu(tr->max_buffer.buffer, cpu);
5065 if (!cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5066 cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5067 atomic_dec(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5068 ring_buffer_record_enable_cpu(tr->array_buffer.buffer, cpu);
5069 #ifdef CONFIG_TRACER_MAX_TRACE
5070 ring_buffer_record_enable_cpu(tr->max_buffer.buffer, cpu);
5074 arch_spin_unlock(&tr->max_lock);
5077 cpumask_copy(tr->tracing_cpumask, tracing_cpumask_new);
5083 tracing_cpumask_write(struct file *filp, const char __user *ubuf,
5084 size_t count, loff_t *ppos)
5086 struct trace_array *tr = file_inode(filp)->i_private;
5087 cpumask_var_t tracing_cpumask_new;
5090 if (count == 0 || count > KMALLOC_MAX_SIZE)
5093 if (!zalloc_cpumask_var(&tracing_cpumask_new, GFP_KERNEL))
5096 err = cpumask_parse_user(ubuf, count, tracing_cpumask_new);
5100 err = tracing_set_cpumask(tr, tracing_cpumask_new);
5104 free_cpumask_var(tracing_cpumask_new);
5109 free_cpumask_var(tracing_cpumask_new);
5114 static const struct file_operations tracing_cpumask_fops = {
5115 .open = tracing_open_generic_tr,
5116 .read = tracing_cpumask_read,
5117 .write = tracing_cpumask_write,
5118 .release = tracing_release_generic_tr,
5119 .llseek = generic_file_llseek,
5122 static int tracing_trace_options_show(struct seq_file *m, void *v)
5124 struct tracer_opt *trace_opts;
5125 struct trace_array *tr = m->private;
5129 mutex_lock(&trace_types_lock);
5130 tracer_flags = tr->current_trace->flags->val;
5131 trace_opts = tr->current_trace->flags->opts;
5133 for (i = 0; trace_options[i]; i++) {
5134 if (tr->trace_flags & (1 << i))
5135 seq_printf(m, "%s\n", trace_options[i]);
5137 seq_printf(m, "no%s\n", trace_options[i]);
5140 for (i = 0; trace_opts[i].name; i++) {
5141 if (tracer_flags & trace_opts[i].bit)
5142 seq_printf(m, "%s\n", trace_opts[i].name);
5144 seq_printf(m, "no%s\n", trace_opts[i].name);
5146 mutex_unlock(&trace_types_lock);
5151 static int __set_tracer_option(struct trace_array *tr,
5152 struct tracer_flags *tracer_flags,
5153 struct tracer_opt *opts, int neg)
5155 struct tracer *trace = tracer_flags->trace;
5158 ret = trace->set_flag(tr, tracer_flags->val, opts->bit, !neg);
5163 tracer_flags->val &= ~opts->bit;
5165 tracer_flags->val |= opts->bit;
5169 /* Try to assign a tracer specific option */
5170 static int set_tracer_option(struct trace_array *tr, char *cmp, int neg)
5172 struct tracer *trace = tr->current_trace;
5173 struct tracer_flags *tracer_flags = trace->flags;
5174 struct tracer_opt *opts = NULL;
5177 for (i = 0; tracer_flags->opts[i].name; i++) {
5178 opts = &tracer_flags->opts[i];
5180 if (strcmp(cmp, opts->name) == 0)
5181 return __set_tracer_option(tr, trace->flags, opts, neg);
5187 /* Some tracers require overwrite to stay enabled */
5188 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set)
5190 if (tracer->enabled && (mask & TRACE_ITER_OVERWRITE) && !set)
5196 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled)
5198 if ((mask == TRACE_ITER_RECORD_TGID) ||
5199 (mask == TRACE_ITER_RECORD_CMD) ||
5200 (mask == TRACE_ITER_TRACE_PRINTK))
5201 lockdep_assert_held(&event_mutex);
5203 /* do nothing if flag is already set */
5204 if (!!(tr->trace_flags & mask) == !!enabled)
5207 /* Give the tracer a chance to approve the change */
5208 if (tr->current_trace->flag_changed)
5209 if (tr->current_trace->flag_changed(tr, mask, !!enabled))
5212 if (mask == TRACE_ITER_TRACE_PRINTK) {
5214 update_printk_trace(tr);
5217 * The global_trace cannot clear this.
5218 * It's flag only gets cleared if another instance sets it.
5220 if (printk_trace == &global_trace)
5223 * An instance must always have it set.
5224 * by default, that's the global_trace instane.
5226 if (printk_trace == tr)
5227 update_printk_trace(&global_trace);
5232 tr->trace_flags |= mask;
5234 tr->trace_flags &= ~mask;
5236 if (mask == TRACE_ITER_RECORD_CMD)
5237 trace_event_enable_cmd_record(enabled);
5239 if (mask == TRACE_ITER_RECORD_TGID) {
5241 if (trace_alloc_tgid_map() < 0) {
5242 tr->trace_flags &= ~TRACE_ITER_RECORD_TGID;
5246 trace_event_enable_tgid_record(enabled);
5249 if (mask == TRACE_ITER_EVENT_FORK)
5250 trace_event_follow_fork(tr, enabled);
5252 if (mask == TRACE_ITER_FUNC_FORK)
5253 ftrace_pid_follow_fork(tr, enabled);
5255 if (mask == TRACE_ITER_OVERWRITE) {
5256 ring_buffer_change_overwrite(tr->array_buffer.buffer, enabled);
5257 #ifdef CONFIG_TRACER_MAX_TRACE
5258 ring_buffer_change_overwrite(tr->max_buffer.buffer, enabled);
5262 if (mask == TRACE_ITER_PRINTK) {
5263 trace_printk_start_stop_comm(enabled);
5264 trace_printk_control(enabled);
5270 int trace_set_options(struct trace_array *tr, char *option)
5275 size_t orig_len = strlen(option);
5278 cmp = strstrip(option);
5280 len = str_has_prefix(cmp, "no");
5286 mutex_lock(&event_mutex);
5287 mutex_lock(&trace_types_lock);
5289 ret = match_string(trace_options, -1, cmp);
5290 /* If no option could be set, test the specific tracer options */
5292 ret = set_tracer_option(tr, cmp, neg);
5294 ret = set_tracer_flag(tr, 1 << ret, !neg);
5296 mutex_unlock(&trace_types_lock);
5297 mutex_unlock(&event_mutex);
5300 * If the first trailing whitespace is replaced with '\0' by strstrip,
5301 * turn it back into a space.
5303 if (orig_len > strlen(option))
5304 option[strlen(option)] = ' ';
5309 static void __init apply_trace_boot_options(void)
5311 char *buf = trace_boot_options_buf;
5315 option = strsep(&buf, ",");
5321 trace_set_options(&global_trace, option);
5323 /* Put back the comma to allow this to be called again */
5330 tracing_trace_options_write(struct file *filp, const char __user *ubuf,
5331 size_t cnt, loff_t *ppos)
5333 struct seq_file *m = filp->private_data;
5334 struct trace_array *tr = m->private;
5338 if (cnt >= sizeof(buf))
5341 if (copy_from_user(buf, ubuf, cnt))
5346 ret = trace_set_options(tr, buf);
5355 static int tracing_trace_options_open(struct inode *inode, struct file *file)
5357 struct trace_array *tr = inode->i_private;
5360 ret = tracing_check_open_get_tr(tr);
5364 ret = single_open(file, tracing_trace_options_show, inode->i_private);
5366 trace_array_put(tr);
5371 static const struct file_operations tracing_iter_fops = {
5372 .open = tracing_trace_options_open,
5374 .llseek = seq_lseek,
5375 .release = tracing_single_release_tr,
5376 .write = tracing_trace_options_write,
5379 static const char readme_msg[] =
5380 "tracing mini-HOWTO:\n\n"
5381 "By default tracefs removes all OTH file permission bits.\n"
5382 "When mounting tracefs an optional group id can be specified\n"
5383 "which adds the group to every directory and file in tracefs:\n\n"
5384 "\t e.g. mount -t tracefs [-o [gid=<gid>]] nodev /sys/kernel/tracing\n\n"
5385 "# echo 0 > tracing_on : quick way to disable tracing\n"
5386 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
5387 " Important files:\n"
5388 " trace\t\t\t- The static contents of the buffer\n"
5389 "\t\t\t To clear the buffer write into this file: echo > trace\n"
5390 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
5391 " current_tracer\t- function and latency tracers\n"
5392 " available_tracers\t- list of configured tracers for current_tracer\n"
5393 " error_log\t- error log for failed commands (that support it)\n"
5394 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
5395 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
5396 " trace_clock\t\t- change the clock used to order events\n"
5397 " local: Per cpu clock but may not be synced across CPUs\n"
5398 " global: Synced across CPUs but slows tracing down.\n"
5399 " counter: Not a clock, but just an increment\n"
5400 " uptime: Jiffy counter from time of boot\n"
5401 " perf: Same clock that perf events use\n"
5402 #ifdef CONFIG_X86_64
5403 " x86-tsc: TSC cycle counter\n"
5405 "\n timestamp_mode\t- view the mode used to timestamp events\n"
5406 " delta: Delta difference against a buffer-wide timestamp\n"
5407 " absolute: Absolute (standalone) timestamp\n"
5408 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
5409 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
5410 " tracing_cpumask\t- Limit which CPUs to trace\n"
5411 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
5412 "\t\t\t Remove sub-buffer with rmdir\n"
5413 " trace_options\t\t- Set format or modify how tracing happens\n"
5414 "\t\t\t Disable an option by prefixing 'no' to the\n"
5415 "\t\t\t option name\n"
5416 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
5417 #ifdef CONFIG_DYNAMIC_FTRACE
5418 "\n available_filter_functions - list of functions that can be filtered on\n"
5419 " set_ftrace_filter\t- echo function name in here to only trace these\n"
5420 "\t\t\t functions\n"
5421 "\t accepts: func_full_name or glob-matching-pattern\n"
5422 "\t modules: Can select a group via module\n"
5423 "\t Format: :mod:<module-name>\n"
5424 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
5425 "\t triggers: a command to perform when function is hit\n"
5426 "\t Format: <function>:<trigger>[:count]\n"
5427 "\t trigger: traceon, traceoff\n"
5428 "\t\t enable_event:<system>:<event>\n"
5429 "\t\t disable_event:<system>:<event>\n"
5430 #ifdef CONFIG_STACKTRACE
5433 #ifdef CONFIG_TRACER_SNAPSHOT
5438 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
5439 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
5440 "\t The first one will disable tracing every time do_fault is hit\n"
5441 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
5442 "\t The first time do trap is hit and it disables tracing, the\n"
5443 "\t counter will decrement to 2. If tracing is already disabled,\n"
5444 "\t the counter will not decrement. It only decrements when the\n"
5445 "\t trigger did work\n"
5446 "\t To remove trigger without count:\n"
5447 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
5448 "\t To remove trigger with a count:\n"
5449 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
5450 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
5451 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
5452 "\t modules: Can select a group via module command :mod:\n"
5453 "\t Does not accept triggers\n"
5454 #endif /* CONFIG_DYNAMIC_FTRACE */
5455 #ifdef CONFIG_FUNCTION_TRACER
5456 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
5458 " set_ftrace_notrace_pid\t- Write pid(s) to not function trace those pids\n"
5461 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
5462 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
5463 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
5464 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
5466 #ifdef CONFIG_TRACER_SNAPSHOT
5467 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
5468 "\t\t\t snapshot buffer. Read the contents for more\n"
5469 "\t\t\t information\n"
5471 #ifdef CONFIG_STACK_TRACER
5472 " stack_trace\t\t- Shows the max stack trace when active\n"
5473 " stack_max_size\t- Shows current max stack size that was traced\n"
5474 "\t\t\t Write into this file to reset the max size (trigger a\n"
5475 "\t\t\t new trace)\n"
5476 #ifdef CONFIG_DYNAMIC_FTRACE
5477 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
5480 #endif /* CONFIG_STACK_TRACER */
5481 #ifdef CONFIG_DYNAMIC_EVENTS
5482 " dynamic_events\t\t- Create/append/remove/show the generic dynamic events\n"
5483 "\t\t\t Write into this file to define/undefine new trace events.\n"
5485 #ifdef CONFIG_KPROBE_EVENTS
5486 " kprobe_events\t\t- Create/append/remove/show the kernel dynamic events\n"
5487 "\t\t\t Write into this file to define/undefine new trace events.\n"
5489 #ifdef CONFIG_UPROBE_EVENTS
5490 " uprobe_events\t\t- Create/append/remove/show the userspace dynamic events\n"
5491 "\t\t\t Write into this file to define/undefine new trace events.\n"
5493 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS) || \
5494 defined(CONFIG_FPROBE_EVENTS)
5495 "\t accepts: event-definitions (one definition per line)\n"
5496 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
5497 "\t Format: p[:[<group>/][<event>]] <place> [<args>]\n"
5498 "\t r[maxactive][:[<group>/][<event>]] <place> [<args>]\n"
5500 #ifdef CONFIG_FPROBE_EVENTS
5501 "\t f[:[<group>/][<event>]] <func-name>[%return] [<args>]\n"
5502 "\t t[:[<group>/][<event>]] <tracepoint> [<args>]\n"
5504 #ifdef CONFIG_HIST_TRIGGERS
5505 "\t s:[synthetic/]<event> <field> [<field>]\n"
5507 "\t e[:[<group>/][<event>]] <attached-group>.<attached-event> [<args>] [if <filter>]\n"
5508 "\t -:[<group>/][<event>]\n"
5509 #ifdef CONFIG_KPROBE_EVENTS
5510 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
5511 "place (kretprobe): [<module>:]<symbol>[+<offset>]%return|<memaddr>\n"
5513 #ifdef CONFIG_UPROBE_EVENTS
5514 " place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"
5516 "\t args: <name>=fetcharg[:type]\n"
5517 "\t fetcharg: (%<register>|$<efield>), @<address>, @<symbol>[+|-<offset>],\n"
5518 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
5519 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5520 #ifdef CONFIG_PROBE_EVENTS_BTF_ARGS
5521 "\t <argname>[->field[->field|.field...]],\n"
5524 "\t $stack<index>, $stack, $retval, $comm,\n"
5526 "\t +|-[u]<offset>(<fetcharg>), \\imm-value, \\\"imm-string\"\n"
5527 "\t kernel return probes support: $retval, $arg<N>, $comm\n"
5528 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, char, string, symbol,\n"
5529 "\t b<bit-width>@<bit-offset>/<container-size>, ustring,\n"
5530 "\t symstr, %pd/%pD, <type>\\[<array-size>\\]\n"
5531 #ifdef CONFIG_HIST_TRIGGERS
5532 "\t field: <stype> <name>;\n"
5533 "\t stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"
5534 "\t [unsigned] char/int/long\n"
5536 "\t efield: For event probes ('e' types), the field is on of the fields\n"
5537 "\t of the <attached-group>/<attached-event>.\n"
5539 " events/\t\t- Directory containing all trace event subsystems:\n"
5540 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
5541 " events/<system>/\t- Directory containing all trace events for <system>:\n"
5542 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
5544 " filter\t\t- If set, only events passing filter are traced\n"
5545 " events/<system>/<event>/\t- Directory containing control files for\n"
5547 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
5548 " filter\t\t- If set, only events passing filter are traced\n"
5549 " trigger\t\t- If set, a command to perform when event is hit\n"
5550 "\t Format: <trigger>[:count][if <filter>]\n"
5551 "\t trigger: traceon, traceoff\n"
5552 "\t enable_event:<system>:<event>\n"
5553 "\t disable_event:<system>:<event>\n"
5554 #ifdef CONFIG_HIST_TRIGGERS
5555 "\t enable_hist:<system>:<event>\n"
5556 "\t disable_hist:<system>:<event>\n"
5558 #ifdef CONFIG_STACKTRACE
5561 #ifdef CONFIG_TRACER_SNAPSHOT
5564 #ifdef CONFIG_HIST_TRIGGERS
5565 "\t\t hist (see below)\n"
5567 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
5568 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
5569 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
5570 "\t events/block/block_unplug/trigger\n"
5571 "\t The first disables tracing every time block_unplug is hit.\n"
5572 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
5573 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
5574 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
5575 "\t Like function triggers, the counter is only decremented if it\n"
5576 "\t enabled or disabled tracing.\n"
5577 "\t To remove a trigger without a count:\n"
5578 "\t echo '!<trigger> > <system>/<event>/trigger\n"
5579 "\t To remove a trigger with a count:\n"
5580 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
5581 "\t Filters can be ignored when removing a trigger.\n"
5582 #ifdef CONFIG_HIST_TRIGGERS
5583 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
5584 "\t Format: hist:keys=<field1[,field2,...]>\n"
5585 "\t [:<var1>=<field|var_ref|numeric_literal>[,<var2>=...]]\n"
5586 "\t [:values=<field1[,field2,...]>]\n"
5587 "\t [:sort=<field1[,field2,...]>]\n"
5588 "\t [:size=#entries]\n"
5589 "\t [:pause][:continue][:clear]\n"
5590 "\t [:name=histname1]\n"
5591 "\t [:nohitcount]\n"
5592 "\t [:<handler>.<action>]\n"
5593 "\t [if <filter>]\n\n"
5594 "\t Note, special fields can be used as well:\n"
5595 "\t common_timestamp - to record current timestamp\n"
5596 "\t common_cpu - to record the CPU the event happened on\n"
5598 "\t A hist trigger variable can be:\n"
5599 "\t - a reference to a field e.g. x=current_timestamp,\n"
5600 "\t - a reference to another variable e.g. y=$x,\n"
5601 "\t - a numeric literal: e.g. ms_per_sec=1000,\n"
5602 "\t - an arithmetic expression: e.g. time_secs=current_timestamp/1000\n"
5604 "\t hist trigger arithmetic expressions support addition(+), subtraction(-),\n"
5605 "\t multiplication(*) and division(/) operators. An operand can be either a\n"
5606 "\t variable reference, field or numeric literal.\n"
5608 "\t When a matching event is hit, an entry is added to a hash\n"
5609 "\t table using the key(s) and value(s) named, and the value of a\n"
5610 "\t sum called 'hitcount' is incremented. Keys and values\n"
5611 "\t correspond to fields in the event's format description. Keys\n"
5612 "\t can be any field, or the special string 'common_stacktrace'.\n"
5613 "\t Compound keys consisting of up to two fields can be specified\n"
5614 "\t by the 'keys' keyword. Values must correspond to numeric\n"
5615 "\t fields. Sort keys consisting of up to two fields can be\n"
5616 "\t specified using the 'sort' keyword. The sort direction can\n"
5617 "\t be modified by appending '.descending' or '.ascending' to a\n"
5618 "\t sort field. The 'size' parameter can be used to specify more\n"
5619 "\t or fewer than the default 2048 entries for the hashtable size.\n"
5620 "\t If a hist trigger is given a name using the 'name' parameter,\n"
5621 "\t its histogram data will be shared with other triggers of the\n"
5622 "\t same name, and trigger hits will update this common data.\n\n"
5623 "\t Reading the 'hist' file for the event will dump the hash\n"
5624 "\t table in its entirety to stdout. If there are multiple hist\n"
5625 "\t triggers attached to an event, there will be a table for each\n"
5626 "\t trigger in the output. The table displayed for a named\n"
5627 "\t trigger will be the same as any other instance having the\n"
5628 "\t same name. The default format used to display a given field\n"
5629 "\t can be modified by appending any of the following modifiers\n"
5630 "\t to the field name, as applicable:\n\n"
5631 "\t .hex display a number as a hex value\n"
5632 "\t .sym display an address as a symbol\n"
5633 "\t .sym-offset display an address as a symbol and offset\n"
5634 "\t .execname display a common_pid as a program name\n"
5635 "\t .syscall display a syscall id as a syscall name\n"
5636 "\t .log2 display log2 value rather than raw number\n"
5637 "\t .buckets=size display values in groups of size rather than raw number\n"
5638 "\t .usecs display a common_timestamp in microseconds\n"
5639 "\t .percent display a number of percentage value\n"
5640 "\t .graph display a bar-graph of a value\n\n"
5641 "\t The 'pause' parameter can be used to pause an existing hist\n"
5642 "\t trigger or to start a hist trigger but not log any events\n"
5643 "\t until told to do so. 'continue' can be used to start or\n"
5644 "\t restart a paused hist trigger.\n\n"
5645 "\t The 'clear' parameter will clear the contents of a running\n"
5646 "\t hist trigger and leave its current paused/active state\n"
5648 "\t The 'nohitcount' (or NOHC) parameter will suppress display of\n"
5649 "\t raw hitcount in the histogram.\n\n"
5650 "\t The enable_hist and disable_hist triggers can be used to\n"
5651 "\t have one event conditionally start and stop another event's\n"
5652 "\t already-attached hist trigger. The syntax is analogous to\n"
5653 "\t the enable_event and disable_event triggers.\n\n"
5654 "\t Hist trigger handlers and actions are executed whenever a\n"
5655 "\t a histogram entry is added or updated. They take the form:\n\n"
5656 "\t <handler>.<action>\n\n"
5657 "\t The available handlers are:\n\n"
5658 "\t onmatch(matching.event) - invoke on addition or update\n"
5659 "\t onmax(var) - invoke if var exceeds current max\n"
5660 "\t onchange(var) - invoke action if var changes\n\n"
5661 "\t The available actions are:\n\n"
5662 "\t trace(<synthetic_event>,param list) - generate synthetic event\n"
5663 "\t save(field,...) - save current event fields\n"
5664 #ifdef CONFIG_TRACER_SNAPSHOT
5665 "\t snapshot() - snapshot the trace buffer\n\n"
5667 #ifdef CONFIG_SYNTH_EVENTS
5668 " events/synthetic_events\t- Create/append/remove/show synthetic events\n"
5669 "\t Write into this file to define/undefine new synthetic events.\n"
5670 "\t example: echo 'myevent u64 lat; char name[]; long[] stack' >> synthetic_events\n"
5676 tracing_readme_read(struct file *filp, char __user *ubuf,
5677 size_t cnt, loff_t *ppos)
5679 return simple_read_from_buffer(ubuf, cnt, ppos,
5680 readme_msg, strlen(readme_msg));
5683 static const struct file_operations tracing_readme_fops = {
5684 .open = tracing_open_generic,
5685 .read = tracing_readme_read,
5686 .llseek = generic_file_llseek,
5689 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
5690 static union trace_eval_map_item *
5691 update_eval_map(union trace_eval_map_item *ptr)
5693 if (!ptr->map.eval_string) {
5694 if (ptr->tail.next) {
5695 ptr = ptr->tail.next;
5696 /* Set ptr to the next real item (skip head) */
5704 static void *eval_map_next(struct seq_file *m, void *v, loff_t *pos)
5706 union trace_eval_map_item *ptr = v;
5709 * Paranoid! If ptr points to end, we don't want to increment past it.
5710 * This really should never happen.
5713 ptr = update_eval_map(ptr);
5714 if (WARN_ON_ONCE(!ptr))
5718 ptr = update_eval_map(ptr);
5723 static void *eval_map_start(struct seq_file *m, loff_t *pos)
5725 union trace_eval_map_item *v;
5728 mutex_lock(&trace_eval_mutex);
5730 v = trace_eval_maps;
5734 while (v && l < *pos) {
5735 v = eval_map_next(m, v, &l);
5741 static void eval_map_stop(struct seq_file *m, void *v)
5743 mutex_unlock(&trace_eval_mutex);
5746 static int eval_map_show(struct seq_file *m, void *v)
5748 union trace_eval_map_item *ptr = v;
5750 seq_printf(m, "%s %ld (%s)\n",
5751 ptr->map.eval_string, ptr->map.eval_value,
5757 static const struct seq_operations tracing_eval_map_seq_ops = {
5758 .start = eval_map_start,
5759 .next = eval_map_next,
5760 .stop = eval_map_stop,
5761 .show = eval_map_show,
5764 static int tracing_eval_map_open(struct inode *inode, struct file *filp)
5768 ret = tracing_check_open_get_tr(NULL);
5772 return seq_open(filp, &tracing_eval_map_seq_ops);
5775 static const struct file_operations tracing_eval_map_fops = {
5776 .open = tracing_eval_map_open,
5778 .llseek = seq_lseek,
5779 .release = seq_release,
5782 static inline union trace_eval_map_item *
5783 trace_eval_jmp_to_tail(union trace_eval_map_item *ptr)
5785 /* Return tail of array given the head */
5786 return ptr + ptr->head.length + 1;
5790 trace_insert_eval_map_file(struct module *mod, struct trace_eval_map **start,
5793 struct trace_eval_map **stop;
5794 struct trace_eval_map **map;
5795 union trace_eval_map_item *map_array;
5796 union trace_eval_map_item *ptr;
5801 * The trace_eval_maps contains the map plus a head and tail item,
5802 * where the head holds the module and length of array, and the
5803 * tail holds a pointer to the next list.
5805 map_array = kmalloc_array(len + 2, sizeof(*map_array), GFP_KERNEL);
5807 pr_warn("Unable to allocate trace eval mapping\n");
5811 mutex_lock(&trace_eval_mutex);
5813 if (!trace_eval_maps)
5814 trace_eval_maps = map_array;
5816 ptr = trace_eval_maps;
5818 ptr = trace_eval_jmp_to_tail(ptr);
5819 if (!ptr->tail.next)
5821 ptr = ptr->tail.next;
5824 ptr->tail.next = map_array;
5826 map_array->head.mod = mod;
5827 map_array->head.length = len;
5830 for (map = start; (unsigned long)map < (unsigned long)stop; map++) {
5831 map_array->map = **map;
5834 memset(map_array, 0, sizeof(*map_array));
5836 mutex_unlock(&trace_eval_mutex);
5839 static void trace_create_eval_file(struct dentry *d_tracer)
5841 trace_create_file("eval_map", TRACE_MODE_READ, d_tracer,
5842 NULL, &tracing_eval_map_fops);
5845 #else /* CONFIG_TRACE_EVAL_MAP_FILE */
5846 static inline void trace_create_eval_file(struct dentry *d_tracer) { }
5847 static inline void trace_insert_eval_map_file(struct module *mod,
5848 struct trace_eval_map **start, int len) { }
5849 #endif /* !CONFIG_TRACE_EVAL_MAP_FILE */
5851 static void trace_insert_eval_map(struct module *mod,
5852 struct trace_eval_map **start, int len)
5854 struct trace_eval_map **map;
5861 trace_event_eval_update(map, len);
5863 trace_insert_eval_map_file(mod, start, len);
5867 tracing_set_trace_read(struct file *filp, char __user *ubuf,
5868 size_t cnt, loff_t *ppos)
5870 struct trace_array *tr = filp->private_data;
5871 char buf[MAX_TRACER_SIZE+2];
5874 mutex_lock(&trace_types_lock);
5875 r = sprintf(buf, "%s\n", tr->current_trace->name);
5876 mutex_unlock(&trace_types_lock);
5878 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
5881 int tracer_init(struct tracer *t, struct trace_array *tr)
5883 tracing_reset_online_cpus(&tr->array_buffer);
5887 static void set_buffer_entries(struct array_buffer *buf, unsigned long val)
5891 for_each_tracing_cpu(cpu)
5892 per_cpu_ptr(buf->data, cpu)->entries = val;
5895 static void update_buffer_entries(struct array_buffer *buf, int cpu)
5897 if (cpu == RING_BUFFER_ALL_CPUS) {
5898 set_buffer_entries(buf, ring_buffer_size(buf->buffer, 0));
5900 per_cpu_ptr(buf->data, cpu)->entries = ring_buffer_size(buf->buffer, cpu);
5904 #ifdef CONFIG_TRACER_MAX_TRACE
5905 /* resize @tr's buffer to the size of @size_tr's entries */
5906 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
5907 struct array_buffer *size_buf, int cpu_id)
5911 if (cpu_id == RING_BUFFER_ALL_CPUS) {
5912 for_each_tracing_cpu(cpu) {
5913 ret = ring_buffer_resize(trace_buf->buffer,
5914 per_cpu_ptr(size_buf->data, cpu)->entries, cpu);
5917 per_cpu_ptr(trace_buf->data, cpu)->entries =
5918 per_cpu_ptr(size_buf->data, cpu)->entries;
5921 ret = ring_buffer_resize(trace_buf->buffer,
5922 per_cpu_ptr(size_buf->data, cpu_id)->entries, cpu_id);
5924 per_cpu_ptr(trace_buf->data, cpu_id)->entries =
5925 per_cpu_ptr(size_buf->data, cpu_id)->entries;
5930 #endif /* CONFIG_TRACER_MAX_TRACE */
5932 static int __tracing_resize_ring_buffer(struct trace_array *tr,
5933 unsigned long size, int cpu)
5938 * If kernel or user changes the size of the ring buffer
5939 * we use the size that was given, and we can forget about
5940 * expanding it later.
5942 trace_set_ring_buffer_expanded(tr);
5944 /* May be called before buffers are initialized */
5945 if (!tr->array_buffer.buffer)
5948 /* Do not allow tracing while resizing ring buffer */
5949 tracing_stop_tr(tr);
5951 ret = ring_buffer_resize(tr->array_buffer.buffer, size, cpu);
5955 #ifdef CONFIG_TRACER_MAX_TRACE
5956 if (!tr->allocated_snapshot)
5959 ret = ring_buffer_resize(tr->max_buffer.buffer, size, cpu);
5961 int r = resize_buffer_duplicate_size(&tr->array_buffer,
5962 &tr->array_buffer, cpu);
5965 * AARGH! We are left with different
5966 * size max buffer!!!!
5967 * The max buffer is our "snapshot" buffer.
5968 * When a tracer needs a snapshot (one of the
5969 * latency tracers), it swaps the max buffer
5970 * with the saved snap shot. We succeeded to
5971 * update the size of the main buffer, but failed to
5972 * update the size of the max buffer. But when we tried
5973 * to reset the main buffer to the original size, we
5974 * failed there too. This is very unlikely to
5975 * happen, but if it does, warn and kill all
5979 tracing_disabled = 1;
5984 update_buffer_entries(&tr->max_buffer, cpu);
5987 #endif /* CONFIG_TRACER_MAX_TRACE */
5989 update_buffer_entries(&tr->array_buffer, cpu);
5991 tracing_start_tr(tr);
5995 ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
5996 unsigned long size, int cpu_id)
6000 mutex_lock(&trace_types_lock);
6002 if (cpu_id != RING_BUFFER_ALL_CPUS) {
6003 /* make sure, this cpu is enabled in the mask */
6004 if (!cpumask_test_cpu(cpu_id, tracing_buffer_mask)) {
6010 ret = __tracing_resize_ring_buffer(tr, size, cpu_id);
6015 mutex_unlock(&trace_types_lock);
6020 static void update_last_data(struct trace_array *tr)
6022 if (!tr->text_delta && !tr->data_delta)
6026 * Need to clear all CPU buffers as there cannot be events
6027 * from the previous boot mixed with events with this boot
6028 * as that will cause a confusing trace. Need to clear all
6029 * CPU buffers, even for those that may currently be offline.
6031 tracing_reset_all_cpus(&tr->array_buffer);
6033 /* Using current data now */
6039 * tracing_update_buffers - used by tracing facility to expand ring buffers
6040 * @tr: The tracing instance
6042 * To save on memory when the tracing is never used on a system with it
6043 * configured in. The ring buffers are set to a minimum size. But once
6044 * a user starts to use the tracing facility, then they need to grow
6045 * to their default size.
6047 * This function is to be called when a tracer is about to be used.
6049 int tracing_update_buffers(struct trace_array *tr)
6053 mutex_lock(&trace_types_lock);
6055 update_last_data(tr);
6057 if (!tr->ring_buffer_expanded)
6058 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
6059 RING_BUFFER_ALL_CPUS);
6060 mutex_unlock(&trace_types_lock);
6065 struct trace_option_dentry;
6068 create_trace_option_files(struct trace_array *tr, struct tracer *tracer);
6071 * Used to clear out the tracer before deletion of an instance.
6072 * Must have trace_types_lock held.
6074 static void tracing_set_nop(struct trace_array *tr)
6076 if (tr->current_trace == &nop_trace)
6079 tr->current_trace->enabled--;
6081 if (tr->current_trace->reset)
6082 tr->current_trace->reset(tr);
6084 tr->current_trace = &nop_trace;
6087 static bool tracer_options_updated;
6089 static void add_tracer_options(struct trace_array *tr, struct tracer *t)
6091 /* Only enable if the directory has been created already. */
6095 /* Only create trace option files after update_tracer_options finish */
6096 if (!tracer_options_updated)
6099 create_trace_option_files(tr, t);
6102 int tracing_set_tracer(struct trace_array *tr, const char *buf)
6105 #ifdef CONFIG_TRACER_MAX_TRACE
6110 mutex_lock(&trace_types_lock);
6112 update_last_data(tr);
6114 if (!tr->ring_buffer_expanded) {
6115 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
6116 RING_BUFFER_ALL_CPUS);
6122 for (t = trace_types; t; t = t->next) {
6123 if (strcmp(t->name, buf) == 0)
6130 if (t == tr->current_trace)
6133 #ifdef CONFIG_TRACER_SNAPSHOT
6134 if (t->use_max_tr) {
6135 local_irq_disable();
6136 arch_spin_lock(&tr->max_lock);
6137 if (tr->cond_snapshot)
6139 arch_spin_unlock(&tr->max_lock);
6145 /* Some tracers won't work on kernel command line */
6146 if (system_state < SYSTEM_RUNNING && t->noboot) {
6147 pr_warn("Tracer '%s' is not allowed on command line, ignored\n",
6152 /* Some tracers are only allowed for the top level buffer */
6153 if (!trace_ok_for_array(t, tr)) {
6158 /* If trace pipe files are being read, we can't change the tracer */
6159 if (tr->trace_ref) {
6164 trace_branch_disable();
6166 tr->current_trace->enabled--;
6168 if (tr->current_trace->reset)
6169 tr->current_trace->reset(tr);
6171 #ifdef CONFIG_TRACER_MAX_TRACE
6172 had_max_tr = tr->current_trace->use_max_tr;
6174 /* Current trace needs to be nop_trace before synchronize_rcu */
6175 tr->current_trace = &nop_trace;
6177 if (had_max_tr && !t->use_max_tr) {
6179 * We need to make sure that the update_max_tr sees that
6180 * current_trace changed to nop_trace to keep it from
6181 * swapping the buffers after we resize it.
6182 * The update_max_tr is called from interrupts disabled
6183 * so a synchronized_sched() is sufficient.
6187 tracing_disarm_snapshot(tr);
6190 if (!had_max_tr && t->use_max_tr) {
6191 ret = tracing_arm_snapshot_locked(tr);
6196 tr->current_trace = &nop_trace;
6200 ret = tracer_init(t, tr);
6202 #ifdef CONFIG_TRACER_MAX_TRACE
6204 tracing_disarm_snapshot(tr);
6210 tr->current_trace = t;
6211 tr->current_trace->enabled++;
6212 trace_branch_enable(tr);
6214 mutex_unlock(&trace_types_lock);
6220 tracing_set_trace_write(struct file *filp, const char __user *ubuf,
6221 size_t cnt, loff_t *ppos)
6223 struct trace_array *tr = filp->private_data;
6224 char buf[MAX_TRACER_SIZE+1];
6231 if (cnt > MAX_TRACER_SIZE)
6232 cnt = MAX_TRACER_SIZE;
6234 if (copy_from_user(buf, ubuf, cnt))
6241 err = tracing_set_tracer(tr, name);
6251 tracing_nsecs_read(unsigned long *ptr, char __user *ubuf,
6252 size_t cnt, loff_t *ppos)
6257 r = snprintf(buf, sizeof(buf), "%ld\n",
6258 *ptr == (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr));
6259 if (r > sizeof(buf))
6261 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6265 tracing_nsecs_write(unsigned long *ptr, const char __user *ubuf,
6266 size_t cnt, loff_t *ppos)
6271 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6281 tracing_thresh_read(struct file *filp, char __user *ubuf,
6282 size_t cnt, loff_t *ppos)
6284 return tracing_nsecs_read(&tracing_thresh, ubuf, cnt, ppos);
6288 tracing_thresh_write(struct file *filp, const char __user *ubuf,
6289 size_t cnt, loff_t *ppos)
6291 struct trace_array *tr = filp->private_data;
6294 mutex_lock(&trace_types_lock);
6295 ret = tracing_nsecs_write(&tracing_thresh, ubuf, cnt, ppos);
6299 if (tr->current_trace->update_thresh) {
6300 ret = tr->current_trace->update_thresh(tr);
6307 mutex_unlock(&trace_types_lock);
6312 #ifdef CONFIG_TRACER_MAX_TRACE
6315 tracing_max_lat_read(struct file *filp, char __user *ubuf,
6316 size_t cnt, loff_t *ppos)
6318 struct trace_array *tr = filp->private_data;
6320 return tracing_nsecs_read(&tr->max_latency, ubuf, cnt, ppos);
6324 tracing_max_lat_write(struct file *filp, const char __user *ubuf,
6325 size_t cnt, loff_t *ppos)
6327 struct trace_array *tr = filp->private_data;
6329 return tracing_nsecs_write(&tr->max_latency, ubuf, cnt, ppos);
6334 static int open_pipe_on_cpu(struct trace_array *tr, int cpu)
6336 if (cpu == RING_BUFFER_ALL_CPUS) {
6337 if (cpumask_empty(tr->pipe_cpumask)) {
6338 cpumask_setall(tr->pipe_cpumask);
6341 } else if (!cpumask_test_cpu(cpu, tr->pipe_cpumask)) {
6342 cpumask_set_cpu(cpu, tr->pipe_cpumask);
6348 static void close_pipe_on_cpu(struct trace_array *tr, int cpu)
6350 if (cpu == RING_BUFFER_ALL_CPUS) {
6351 WARN_ON(!cpumask_full(tr->pipe_cpumask));
6352 cpumask_clear(tr->pipe_cpumask);
6354 WARN_ON(!cpumask_test_cpu(cpu, tr->pipe_cpumask));
6355 cpumask_clear_cpu(cpu, tr->pipe_cpumask);
6359 static int tracing_open_pipe(struct inode *inode, struct file *filp)
6361 struct trace_array *tr = inode->i_private;
6362 struct trace_iterator *iter;
6366 ret = tracing_check_open_get_tr(tr);
6370 mutex_lock(&trace_types_lock);
6371 cpu = tracing_get_cpu(inode);
6372 ret = open_pipe_on_cpu(tr, cpu);
6374 goto fail_pipe_on_cpu;
6376 /* create a buffer to store the information to pass to userspace */
6377 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
6380 goto fail_alloc_iter;
6383 trace_seq_init(&iter->seq);
6384 iter->trace = tr->current_trace;
6386 if (!alloc_cpumask_var(&iter->started, GFP_KERNEL)) {
6391 /* trace pipe does not show start of buffer */
6392 cpumask_setall(iter->started);
6394 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
6395 iter->iter_flags |= TRACE_FILE_LAT_FMT;
6397 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
6398 if (trace_clocks[tr->clock_id].in_ns)
6399 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
6402 iter->array_buffer = &tr->array_buffer;
6403 iter->cpu_file = cpu;
6404 mutex_init(&iter->mutex);
6405 filp->private_data = iter;
6407 if (iter->trace->pipe_open)
6408 iter->trace->pipe_open(iter);
6410 nonseekable_open(inode, filp);
6414 mutex_unlock(&trace_types_lock);
6420 close_pipe_on_cpu(tr, cpu);
6422 __trace_array_put(tr);
6423 mutex_unlock(&trace_types_lock);
6427 static int tracing_release_pipe(struct inode *inode, struct file *file)
6429 struct trace_iterator *iter = file->private_data;
6430 struct trace_array *tr = inode->i_private;
6432 mutex_lock(&trace_types_lock);
6436 if (iter->trace->pipe_close)
6437 iter->trace->pipe_close(iter);
6438 close_pipe_on_cpu(tr, iter->cpu_file);
6439 mutex_unlock(&trace_types_lock);
6441 free_trace_iter_content(iter);
6444 trace_array_put(tr);
6450 trace_poll(struct trace_iterator *iter, struct file *filp, poll_table *poll_table)
6452 struct trace_array *tr = iter->tr;
6454 /* Iterators are static, they should be filled or empty */
6455 if (trace_buffer_iter(iter, iter->cpu_file))
6456 return EPOLLIN | EPOLLRDNORM;
6458 if (tr->trace_flags & TRACE_ITER_BLOCK)
6460 * Always select as readable when in blocking mode
6462 return EPOLLIN | EPOLLRDNORM;
6464 return ring_buffer_poll_wait(iter->array_buffer->buffer, iter->cpu_file,
6465 filp, poll_table, iter->tr->buffer_percent);
6469 tracing_poll_pipe(struct file *filp, poll_table *poll_table)
6471 struct trace_iterator *iter = filp->private_data;
6473 return trace_poll(iter, filp, poll_table);
6476 /* Must be called with iter->mutex held. */
6477 static int tracing_wait_pipe(struct file *filp)
6479 struct trace_iterator *iter = filp->private_data;
6482 while (trace_empty(iter)) {
6484 if ((filp->f_flags & O_NONBLOCK)) {
6489 * We block until we read something and tracing is disabled.
6490 * We still block if tracing is disabled, but we have never
6491 * read anything. This allows a user to cat this file, and
6492 * then enable tracing. But after we have read something,
6493 * we give an EOF when tracing is again disabled.
6495 * iter->pos will be 0 if we haven't read anything.
6497 if (!tracer_tracing_is_on(iter->tr) && iter->pos)
6500 mutex_unlock(&iter->mutex);
6502 ret = wait_on_pipe(iter, 0);
6504 mutex_lock(&iter->mutex);
6517 tracing_read_pipe(struct file *filp, char __user *ubuf,
6518 size_t cnt, loff_t *ppos)
6520 struct trace_iterator *iter = filp->private_data;
6524 * Avoid more than one consumer on a single file descriptor
6525 * This is just a matter of traces coherency, the ring buffer itself
6528 mutex_lock(&iter->mutex);
6530 /* return any leftover data */
6531 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6535 trace_seq_init(&iter->seq);
6537 if (iter->trace->read) {
6538 sret = iter->trace->read(iter, filp, ubuf, cnt, ppos);
6544 sret = tracing_wait_pipe(filp);
6548 /* stop when tracing is finished */
6549 if (trace_empty(iter)) {
6554 if (cnt >= TRACE_SEQ_BUFFER_SIZE)
6555 cnt = TRACE_SEQ_BUFFER_SIZE - 1;
6557 /* reset all but tr, trace, and overruns */
6558 trace_iterator_reset(iter);
6559 cpumask_clear(iter->started);
6560 trace_seq_init(&iter->seq);
6562 trace_event_read_lock();
6563 trace_access_lock(iter->cpu_file);
6564 while (trace_find_next_entry_inc(iter) != NULL) {
6565 enum print_line_t ret;
6566 int save_len = iter->seq.seq.len;
6568 ret = print_trace_line(iter);
6569 if (ret == TRACE_TYPE_PARTIAL_LINE) {
6571 * If one print_trace_line() fills entire trace_seq in one shot,
6572 * trace_seq_to_user() will returns -EBUSY because save_len == 0,
6573 * In this case, we need to consume it, otherwise, loop will peek
6574 * this event next time, resulting in an infinite loop.
6576 if (save_len == 0) {
6578 trace_seq_puts(&iter->seq, "[LINE TOO BIG]\n");
6579 trace_consume(iter);
6583 /* In other cases, don't print partial lines */
6584 iter->seq.seq.len = save_len;
6587 if (ret != TRACE_TYPE_NO_CONSUME)
6588 trace_consume(iter);
6590 if (trace_seq_used(&iter->seq) >= cnt)
6594 * Setting the full flag means we reached the trace_seq buffer
6595 * size and we should leave by partial output condition above.
6596 * One of the trace_seq_* functions is not used properly.
6598 WARN_ONCE(iter->seq.full, "full flag set for trace type %d",
6601 trace_access_unlock(iter->cpu_file);
6602 trace_event_read_unlock();
6604 /* Now copy what we have to the user */
6605 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6606 if (iter->seq.readpos >= trace_seq_used(&iter->seq))
6607 trace_seq_init(&iter->seq);
6610 * If there was nothing to send to user, in spite of consuming trace
6611 * entries, go back to wait for more entries.
6617 mutex_unlock(&iter->mutex);
6622 static void tracing_spd_release_pipe(struct splice_pipe_desc *spd,
6625 __free_page(spd->pages[idx]);
6629 tracing_fill_pipe_page(size_t rem, struct trace_iterator *iter)
6635 /* Seq buffer is page-sized, exactly what we need. */
6637 save_len = iter->seq.seq.len;
6638 ret = print_trace_line(iter);
6640 if (trace_seq_has_overflowed(&iter->seq)) {
6641 iter->seq.seq.len = save_len;
6646 * This should not be hit, because it should only
6647 * be set if the iter->seq overflowed. But check it
6648 * anyway to be safe.
6650 if (ret == TRACE_TYPE_PARTIAL_LINE) {
6651 iter->seq.seq.len = save_len;
6655 count = trace_seq_used(&iter->seq) - save_len;
6658 iter->seq.seq.len = save_len;
6662 if (ret != TRACE_TYPE_NO_CONSUME)
6663 trace_consume(iter);
6665 if (!trace_find_next_entry_inc(iter)) {
6675 static ssize_t tracing_splice_read_pipe(struct file *filp,
6677 struct pipe_inode_info *pipe,
6681 struct page *pages_def[PIPE_DEF_BUFFERS];
6682 struct partial_page partial_def[PIPE_DEF_BUFFERS];
6683 struct trace_iterator *iter = filp->private_data;
6684 struct splice_pipe_desc spd = {
6686 .partial = partial_def,
6687 .nr_pages = 0, /* This gets updated below. */
6688 .nr_pages_max = PIPE_DEF_BUFFERS,
6689 .ops = &default_pipe_buf_ops,
6690 .spd_release = tracing_spd_release_pipe,
6696 if (splice_grow_spd(pipe, &spd))
6699 mutex_lock(&iter->mutex);
6701 if (iter->trace->splice_read) {
6702 ret = iter->trace->splice_read(iter, filp,
6703 ppos, pipe, len, flags);
6708 ret = tracing_wait_pipe(filp);
6712 if (!iter->ent && !trace_find_next_entry_inc(iter)) {
6717 trace_event_read_lock();
6718 trace_access_lock(iter->cpu_file);
6720 /* Fill as many pages as possible. */
6721 for (i = 0, rem = len; i < spd.nr_pages_max && rem; i++) {
6722 spd.pages[i] = alloc_page(GFP_KERNEL);
6726 rem = tracing_fill_pipe_page(rem, iter);
6728 /* Copy the data into the page, so we can start over. */
6729 ret = trace_seq_to_buffer(&iter->seq,
6730 page_address(spd.pages[i]),
6731 trace_seq_used(&iter->seq));
6733 __free_page(spd.pages[i]);
6736 spd.partial[i].offset = 0;
6737 spd.partial[i].len = trace_seq_used(&iter->seq);
6739 trace_seq_init(&iter->seq);
6742 trace_access_unlock(iter->cpu_file);
6743 trace_event_read_unlock();
6744 mutex_unlock(&iter->mutex);
6749 ret = splice_to_pipe(pipe, &spd);
6753 splice_shrink_spd(&spd);
6757 mutex_unlock(&iter->mutex);
6762 tracing_entries_read(struct file *filp, char __user *ubuf,
6763 size_t cnt, loff_t *ppos)
6765 struct inode *inode = file_inode(filp);
6766 struct trace_array *tr = inode->i_private;
6767 int cpu = tracing_get_cpu(inode);
6772 mutex_lock(&trace_types_lock);
6774 if (cpu == RING_BUFFER_ALL_CPUS) {
6775 int cpu, buf_size_same;
6780 /* check if all cpu sizes are same */
6781 for_each_tracing_cpu(cpu) {
6782 /* fill in the size from first enabled cpu */
6784 size = per_cpu_ptr(tr->array_buffer.data, cpu)->entries;
6785 if (size != per_cpu_ptr(tr->array_buffer.data, cpu)->entries) {
6791 if (buf_size_same) {
6792 if (!tr->ring_buffer_expanded)
6793 r = sprintf(buf, "%lu (expanded: %lu)\n",
6795 trace_buf_size >> 10);
6797 r = sprintf(buf, "%lu\n", size >> 10);
6799 r = sprintf(buf, "X\n");
6801 r = sprintf(buf, "%lu\n", per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10);
6803 mutex_unlock(&trace_types_lock);
6805 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6810 tracing_entries_write(struct file *filp, const char __user *ubuf,
6811 size_t cnt, loff_t *ppos)
6813 struct inode *inode = file_inode(filp);
6814 struct trace_array *tr = inode->i_private;
6818 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6822 /* must have at least 1 entry */
6826 /* value is in KB */
6828 ret = tracing_resize_ring_buffer(tr, val, tracing_get_cpu(inode));
6838 tracing_total_entries_read(struct file *filp, char __user *ubuf,
6839 size_t cnt, loff_t *ppos)
6841 struct trace_array *tr = filp->private_data;
6844 unsigned long size = 0, expanded_size = 0;
6846 mutex_lock(&trace_types_lock);
6847 for_each_tracing_cpu(cpu) {
6848 size += per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10;
6849 if (!tr->ring_buffer_expanded)
6850 expanded_size += trace_buf_size >> 10;
6852 if (tr->ring_buffer_expanded)
6853 r = sprintf(buf, "%lu\n", size);
6855 r = sprintf(buf, "%lu (expanded: %lu)\n", size, expanded_size);
6856 mutex_unlock(&trace_types_lock);
6858 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6862 tracing_last_boot_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
6864 struct trace_array *tr = filp->private_data;
6868 seq_buf_init(&seq, buf, 64);
6870 seq_buf_printf(&seq, "text delta:\t%ld\n", tr->text_delta);
6871 seq_buf_printf(&seq, "data delta:\t%ld\n", tr->data_delta);
6873 return simple_read_from_buffer(ubuf, cnt, ppos, buf, seq_buf_used(&seq));
6876 static int tracing_buffer_meta_open(struct inode *inode, struct file *filp)
6878 struct trace_array *tr = inode->i_private;
6879 int cpu = tracing_get_cpu(inode);
6882 ret = tracing_check_open_get_tr(tr);
6886 ret = ring_buffer_meta_seq_init(filp, tr->array_buffer.buffer, cpu);
6888 __trace_array_put(tr);
6893 tracing_free_buffer_write(struct file *filp, const char __user *ubuf,
6894 size_t cnt, loff_t *ppos)
6897 * There is no need to read what the user has written, this function
6898 * is just to make sure that there is no error when "echo" is used
6907 tracing_free_buffer_release(struct inode *inode, struct file *filp)
6909 struct trace_array *tr = inode->i_private;
6911 /* disable tracing ? */
6912 if (tr->trace_flags & TRACE_ITER_STOP_ON_FREE)
6913 tracer_tracing_off(tr);
6914 /* resize the ring buffer to 0 */
6915 tracing_resize_ring_buffer(tr, 0, RING_BUFFER_ALL_CPUS);
6917 trace_array_put(tr);
6922 #define TRACE_MARKER_MAX_SIZE 4096
6925 tracing_mark_write(struct file *filp, const char __user *ubuf,
6926 size_t cnt, loff_t *fpos)
6928 struct trace_array *tr = filp->private_data;
6929 struct ring_buffer_event *event;
6930 enum event_trigger_type tt = ETT_NONE;
6931 struct trace_buffer *buffer;
6932 struct print_entry *entry;
6938 /* Used in tracing_mark_raw_write() as well */
6939 #define FAULTED_STR "<faulted>"
6940 #define FAULTED_SIZE (sizeof(FAULTED_STR) - 1) /* '\0' is already accounted for */
6942 if (tracing_disabled)
6945 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
6948 if ((ssize_t)cnt < 0)
6951 if (cnt > TRACE_MARKER_MAX_SIZE)
6952 cnt = TRACE_MARKER_MAX_SIZE;
6954 meta_size = sizeof(*entry) + 2; /* add '\0' and possible '\n' */
6956 size = cnt + meta_size;
6958 /* If less than "<faulted>", then make sure we can still add that */
6959 if (cnt < FAULTED_SIZE)
6960 size += FAULTED_SIZE - cnt;
6962 buffer = tr->array_buffer.buffer;
6963 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
6965 if (unlikely(!event)) {
6967 * If the size was greater than what was allowed, then
6968 * make it smaller and try again.
6970 if (size > ring_buffer_max_event_size(buffer)) {
6971 /* cnt < FAULTED size should never be bigger than max */
6972 if (WARN_ON_ONCE(cnt < FAULTED_SIZE))
6974 cnt = ring_buffer_max_event_size(buffer) - meta_size;
6975 /* The above should only happen once */
6976 if (WARN_ON_ONCE(cnt + meta_size == size))
6981 /* Ring buffer disabled, return as if not open for write */
6985 entry = ring_buffer_event_data(event);
6986 entry->ip = _THIS_IP_;
6988 len = __copy_from_user_inatomic(&entry->buf, ubuf, cnt);
6990 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
6996 if (tr->trace_marker_file && !list_empty(&tr->trace_marker_file->triggers)) {
6997 /* do not add \n before testing triggers, but add \0 */
6998 entry->buf[cnt] = '\0';
6999 tt = event_triggers_call(tr->trace_marker_file, buffer, entry, event);
7002 if (entry->buf[cnt - 1] != '\n') {
7003 entry->buf[cnt] = '\n';
7004 entry->buf[cnt + 1] = '\0';
7006 entry->buf[cnt] = '\0';
7008 if (static_branch_unlikely(&trace_marker_exports_enabled))
7009 ftrace_exports(event, TRACE_EXPORT_MARKER);
7010 __buffer_unlock_commit(buffer, event);
7013 event_triggers_post_call(tr->trace_marker_file, tt);
7019 tracing_mark_raw_write(struct file *filp, const char __user *ubuf,
7020 size_t cnt, loff_t *fpos)
7022 struct trace_array *tr = filp->private_data;
7023 struct ring_buffer_event *event;
7024 struct trace_buffer *buffer;
7025 struct raw_data_entry *entry;
7030 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
7032 if (tracing_disabled)
7035 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
7038 /* The marker must at least have a tag id */
7039 if (cnt < sizeof(unsigned int))
7042 size = sizeof(*entry) + cnt;
7043 if (cnt < FAULT_SIZE_ID)
7044 size += FAULT_SIZE_ID - cnt;
7046 buffer = tr->array_buffer.buffer;
7048 if (size > ring_buffer_max_event_size(buffer))
7051 event = __trace_buffer_lock_reserve(buffer, TRACE_RAW_DATA, size,
7054 /* Ring buffer disabled, return as if not open for write */
7057 entry = ring_buffer_event_data(event);
7059 len = __copy_from_user_inatomic(&entry->id, ubuf, cnt);
7062 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
7067 __buffer_unlock_commit(buffer, event);
7072 static int tracing_clock_show(struct seq_file *m, void *v)
7074 struct trace_array *tr = m->private;
7077 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++)
7079 "%s%s%s%s", i ? " " : "",
7080 i == tr->clock_id ? "[" : "", trace_clocks[i].name,
7081 i == tr->clock_id ? "]" : "");
7087 int tracing_set_clock(struct trace_array *tr, const char *clockstr)
7091 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++) {
7092 if (strcmp(trace_clocks[i].name, clockstr) == 0)
7095 if (i == ARRAY_SIZE(trace_clocks))
7098 mutex_lock(&trace_types_lock);
7102 ring_buffer_set_clock(tr->array_buffer.buffer, trace_clocks[i].func);
7105 * New clock may not be consistent with the previous clock.
7106 * Reset the buffer so that it doesn't have incomparable timestamps.
7108 tracing_reset_online_cpus(&tr->array_buffer);
7110 #ifdef CONFIG_TRACER_MAX_TRACE
7111 if (tr->max_buffer.buffer)
7112 ring_buffer_set_clock(tr->max_buffer.buffer, trace_clocks[i].func);
7113 tracing_reset_online_cpus(&tr->max_buffer);
7116 mutex_unlock(&trace_types_lock);
7121 static ssize_t tracing_clock_write(struct file *filp, const char __user *ubuf,
7122 size_t cnt, loff_t *fpos)
7124 struct seq_file *m = filp->private_data;
7125 struct trace_array *tr = m->private;
7127 const char *clockstr;
7130 if (cnt >= sizeof(buf))
7133 if (copy_from_user(buf, ubuf, cnt))
7138 clockstr = strstrip(buf);
7140 ret = tracing_set_clock(tr, clockstr);
7149 static int tracing_clock_open(struct inode *inode, struct file *file)
7151 struct trace_array *tr = inode->i_private;
7154 ret = tracing_check_open_get_tr(tr);
7158 ret = single_open(file, tracing_clock_show, inode->i_private);
7160 trace_array_put(tr);
7165 static int tracing_time_stamp_mode_show(struct seq_file *m, void *v)
7167 struct trace_array *tr = m->private;
7169 mutex_lock(&trace_types_lock);
7171 if (ring_buffer_time_stamp_abs(tr->array_buffer.buffer))
7172 seq_puts(m, "delta [absolute]\n");
7174 seq_puts(m, "[delta] absolute\n");
7176 mutex_unlock(&trace_types_lock);
7181 static int tracing_time_stamp_mode_open(struct inode *inode, struct file *file)
7183 struct trace_array *tr = inode->i_private;
7186 ret = tracing_check_open_get_tr(tr);
7190 ret = single_open(file, tracing_time_stamp_mode_show, inode->i_private);
7192 trace_array_put(tr);
7197 u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe)
7199 if (rbe == this_cpu_read(trace_buffered_event))
7200 return ring_buffer_time_stamp(buffer);
7202 return ring_buffer_event_time_stamp(buffer, rbe);
7206 * Set or disable using the per CPU trace_buffer_event when possible.
7208 int tracing_set_filter_buffering(struct trace_array *tr, bool set)
7212 mutex_lock(&trace_types_lock);
7214 if (set && tr->no_filter_buffering_ref++)
7218 if (WARN_ON_ONCE(!tr->no_filter_buffering_ref)) {
7223 --tr->no_filter_buffering_ref;
7226 mutex_unlock(&trace_types_lock);
7231 struct ftrace_buffer_info {
7232 struct trace_iterator iter;
7234 unsigned int spare_cpu;
7235 unsigned int spare_size;
7239 #ifdef CONFIG_TRACER_SNAPSHOT
7240 static int tracing_snapshot_open(struct inode *inode, struct file *file)
7242 struct trace_array *tr = inode->i_private;
7243 struct trace_iterator *iter;
7247 ret = tracing_check_open_get_tr(tr);
7251 if (file->f_mode & FMODE_READ) {
7252 iter = __tracing_open(inode, file, true);
7254 ret = PTR_ERR(iter);
7256 /* Writes still need the seq_file to hold the private data */
7258 m = kzalloc(sizeof(*m), GFP_KERNEL);
7261 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
7269 iter->array_buffer = &tr->max_buffer;
7270 iter->cpu_file = tracing_get_cpu(inode);
7272 file->private_data = m;
7276 trace_array_put(tr);
7281 static void tracing_swap_cpu_buffer(void *tr)
7283 update_max_tr_single((struct trace_array *)tr, current, smp_processor_id());
7287 tracing_snapshot_write(struct file *filp, const char __user *ubuf, size_t cnt,
7290 struct seq_file *m = filp->private_data;
7291 struct trace_iterator *iter = m->private;
7292 struct trace_array *tr = iter->tr;
7296 ret = tracing_update_buffers(tr);
7300 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7304 mutex_lock(&trace_types_lock);
7306 if (tr->current_trace->use_max_tr) {
7311 local_irq_disable();
7312 arch_spin_lock(&tr->max_lock);
7313 if (tr->cond_snapshot)
7315 arch_spin_unlock(&tr->max_lock);
7322 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7326 if (tr->allocated_snapshot)
7330 /* Only allow per-cpu swap if the ring buffer supports it */
7331 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
7332 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7337 if (tr->allocated_snapshot)
7338 ret = resize_buffer_duplicate_size(&tr->max_buffer,
7339 &tr->array_buffer, iter->cpu_file);
7341 ret = tracing_arm_snapshot_locked(tr);
7345 /* Now, we're going to swap */
7346 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
7347 local_irq_disable();
7348 update_max_tr(tr, current, smp_processor_id(), NULL);
7351 smp_call_function_single(iter->cpu_file, tracing_swap_cpu_buffer,
7354 tracing_disarm_snapshot(tr);
7357 if (tr->allocated_snapshot) {
7358 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
7359 tracing_reset_online_cpus(&tr->max_buffer);
7361 tracing_reset_cpu(&tr->max_buffer, iter->cpu_file);
7371 mutex_unlock(&trace_types_lock);
7375 static int tracing_snapshot_release(struct inode *inode, struct file *file)
7377 struct seq_file *m = file->private_data;
7380 ret = tracing_release(inode, file);
7382 if (file->f_mode & FMODE_READ)
7385 /* If write only, the seq_file is just a stub */
7393 static int tracing_buffers_open(struct inode *inode, struct file *filp);
7394 static ssize_t tracing_buffers_read(struct file *filp, char __user *ubuf,
7395 size_t count, loff_t *ppos);
7396 static int tracing_buffers_release(struct inode *inode, struct file *file);
7397 static ssize_t tracing_buffers_splice_read(struct file *file, loff_t *ppos,
7398 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
7400 static int snapshot_raw_open(struct inode *inode, struct file *filp)
7402 struct ftrace_buffer_info *info;
7405 /* The following checks for tracefs lockdown */
7406 ret = tracing_buffers_open(inode, filp);
7410 info = filp->private_data;
7412 if (info->iter.trace->use_max_tr) {
7413 tracing_buffers_release(inode, filp);
7417 info->iter.snapshot = true;
7418 info->iter.array_buffer = &info->iter.tr->max_buffer;
7423 #endif /* CONFIG_TRACER_SNAPSHOT */
7426 static const struct file_operations tracing_thresh_fops = {
7427 .open = tracing_open_generic,
7428 .read = tracing_thresh_read,
7429 .write = tracing_thresh_write,
7430 .llseek = generic_file_llseek,
7433 #ifdef CONFIG_TRACER_MAX_TRACE
7434 static const struct file_operations tracing_max_lat_fops = {
7435 .open = tracing_open_generic_tr,
7436 .read = tracing_max_lat_read,
7437 .write = tracing_max_lat_write,
7438 .llseek = generic_file_llseek,
7439 .release = tracing_release_generic_tr,
7443 static const struct file_operations set_tracer_fops = {
7444 .open = tracing_open_generic_tr,
7445 .read = tracing_set_trace_read,
7446 .write = tracing_set_trace_write,
7447 .llseek = generic_file_llseek,
7448 .release = tracing_release_generic_tr,
7451 static const struct file_operations tracing_pipe_fops = {
7452 .open = tracing_open_pipe,
7453 .poll = tracing_poll_pipe,
7454 .read = tracing_read_pipe,
7455 .splice_read = tracing_splice_read_pipe,
7456 .release = tracing_release_pipe,
7459 static const struct file_operations tracing_entries_fops = {
7460 .open = tracing_open_generic_tr,
7461 .read = tracing_entries_read,
7462 .write = tracing_entries_write,
7463 .llseek = generic_file_llseek,
7464 .release = tracing_release_generic_tr,
7467 static const struct file_operations tracing_buffer_meta_fops = {
7468 .open = tracing_buffer_meta_open,
7470 .llseek = seq_lseek,
7471 .release = tracing_seq_release,
7474 static const struct file_operations tracing_total_entries_fops = {
7475 .open = tracing_open_generic_tr,
7476 .read = tracing_total_entries_read,
7477 .llseek = generic_file_llseek,
7478 .release = tracing_release_generic_tr,
7481 static const struct file_operations tracing_free_buffer_fops = {
7482 .open = tracing_open_generic_tr,
7483 .write = tracing_free_buffer_write,
7484 .release = tracing_free_buffer_release,
7487 static const struct file_operations tracing_mark_fops = {
7488 .open = tracing_mark_open,
7489 .write = tracing_mark_write,
7490 .release = tracing_release_generic_tr,
7493 static const struct file_operations tracing_mark_raw_fops = {
7494 .open = tracing_mark_open,
7495 .write = tracing_mark_raw_write,
7496 .release = tracing_release_generic_tr,
7499 static const struct file_operations trace_clock_fops = {
7500 .open = tracing_clock_open,
7502 .llseek = seq_lseek,
7503 .release = tracing_single_release_tr,
7504 .write = tracing_clock_write,
7507 static const struct file_operations trace_time_stamp_mode_fops = {
7508 .open = tracing_time_stamp_mode_open,
7510 .llseek = seq_lseek,
7511 .release = tracing_single_release_tr,
7514 static const struct file_operations last_boot_fops = {
7515 .open = tracing_open_generic_tr,
7516 .read = tracing_last_boot_read,
7517 .llseek = generic_file_llseek,
7518 .release = tracing_release_generic_tr,
7521 #ifdef CONFIG_TRACER_SNAPSHOT
7522 static const struct file_operations snapshot_fops = {
7523 .open = tracing_snapshot_open,
7525 .write = tracing_snapshot_write,
7526 .llseek = tracing_lseek,
7527 .release = tracing_snapshot_release,
7530 static const struct file_operations snapshot_raw_fops = {
7531 .open = snapshot_raw_open,
7532 .read = tracing_buffers_read,
7533 .release = tracing_buffers_release,
7534 .splice_read = tracing_buffers_splice_read,
7537 #endif /* CONFIG_TRACER_SNAPSHOT */
7540 * trace_min_max_write - Write a u64 value to a trace_min_max_param struct
7541 * @filp: The active open file structure
7542 * @ubuf: The userspace provided buffer to read value into
7543 * @cnt: The maximum number of bytes to read
7544 * @ppos: The current "file" position
7546 * This function implements the write interface for a struct trace_min_max_param.
7547 * The filp->private_data must point to a trace_min_max_param structure that
7548 * defines where to write the value, the min and the max acceptable values,
7549 * and a lock to protect the write.
7552 trace_min_max_write(struct file *filp, const char __user *ubuf, size_t cnt, loff_t *ppos)
7554 struct trace_min_max_param *param = filp->private_data;
7561 err = kstrtoull_from_user(ubuf, cnt, 10, &val);
7566 mutex_lock(param->lock);
7568 if (param->min && val < *param->min)
7571 if (param->max && val > *param->max)
7578 mutex_unlock(param->lock);
7587 * trace_min_max_read - Read a u64 value from a trace_min_max_param struct
7588 * @filp: The active open file structure
7589 * @ubuf: The userspace provided buffer to read value into
7590 * @cnt: The maximum number of bytes to read
7591 * @ppos: The current "file" position
7593 * This function implements the read interface for a struct trace_min_max_param.
7594 * The filp->private_data must point to a trace_min_max_param struct with valid
7598 trace_min_max_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
7600 struct trace_min_max_param *param = filp->private_data;
7601 char buf[U64_STR_SIZE];
7610 if (cnt > sizeof(buf))
7613 len = snprintf(buf, sizeof(buf), "%llu\n", val);
7615 return simple_read_from_buffer(ubuf, cnt, ppos, buf, len);
7618 const struct file_operations trace_min_max_fops = {
7619 .open = tracing_open_generic,
7620 .read = trace_min_max_read,
7621 .write = trace_min_max_write,
7624 #define TRACING_LOG_ERRS_MAX 8
7625 #define TRACING_LOG_LOC_MAX 128
7627 #define CMD_PREFIX " Command: "
7630 const char **errs; /* ptr to loc-specific array of err strings */
7631 u8 type; /* index into errs -> specific err string */
7632 u16 pos; /* caret position */
7636 struct tracing_log_err {
7637 struct list_head list;
7638 struct err_info info;
7639 char loc[TRACING_LOG_LOC_MAX]; /* err location */
7640 char *cmd; /* what caused err */
7643 static DEFINE_MUTEX(tracing_err_log_lock);
7645 static struct tracing_log_err *alloc_tracing_log_err(int len)
7647 struct tracing_log_err *err;
7649 err = kzalloc(sizeof(*err), GFP_KERNEL);
7651 return ERR_PTR(-ENOMEM);
7653 err->cmd = kzalloc(len, GFP_KERNEL);
7656 return ERR_PTR(-ENOMEM);
7662 static void free_tracing_log_err(struct tracing_log_err *err)
7668 static struct tracing_log_err *get_tracing_log_err(struct trace_array *tr,
7671 struct tracing_log_err *err;
7674 if (tr->n_err_log_entries < TRACING_LOG_ERRS_MAX) {
7675 err = alloc_tracing_log_err(len);
7676 if (PTR_ERR(err) != -ENOMEM)
7677 tr->n_err_log_entries++;
7681 cmd = kzalloc(len, GFP_KERNEL);
7683 return ERR_PTR(-ENOMEM);
7684 err = list_first_entry(&tr->err_log, struct tracing_log_err, list);
7687 list_del(&err->list);
7693 * err_pos - find the position of a string within a command for error careting
7694 * @cmd: The tracing command that caused the error
7695 * @str: The string to position the caret at within @cmd
7697 * Finds the position of the first occurrence of @str within @cmd. The
7698 * return value can be passed to tracing_log_err() for caret placement
7701 * Returns the index within @cmd of the first occurrence of @str or 0
7702 * if @str was not found.
7704 unsigned int err_pos(char *cmd, const char *str)
7708 if (WARN_ON(!strlen(cmd)))
7711 found = strstr(cmd, str);
7719 * tracing_log_err - write an error to the tracing error log
7720 * @tr: The associated trace array for the error (NULL for top level array)
7721 * @loc: A string describing where the error occurred
7722 * @cmd: The tracing command that caused the error
7723 * @errs: The array of loc-specific static error strings
7724 * @type: The index into errs[], which produces the specific static err string
7725 * @pos: The position the caret should be placed in the cmd
7727 * Writes an error into tracing/error_log of the form:
7729 * <loc>: error: <text>
7733 * tracing/error_log is a small log file containing the last
7734 * TRACING_LOG_ERRS_MAX errors (8). Memory for errors isn't allocated
7735 * unless there has been a tracing error, and the error log can be
7736 * cleared and have its memory freed by writing the empty string in
7737 * truncation mode to it i.e. echo > tracing/error_log.
7739 * NOTE: the @errs array along with the @type param are used to
7740 * produce a static error string - this string is not copied and saved
7741 * when the error is logged - only a pointer to it is saved. See
7742 * existing callers for examples of how static strings are typically
7743 * defined for use with tracing_log_err().
7745 void tracing_log_err(struct trace_array *tr,
7746 const char *loc, const char *cmd,
7747 const char **errs, u8 type, u16 pos)
7749 struct tracing_log_err *err;
7755 len += sizeof(CMD_PREFIX) + 2 * sizeof("\n") + strlen(cmd) + 1;
7757 mutex_lock(&tracing_err_log_lock);
7758 err = get_tracing_log_err(tr, len);
7759 if (PTR_ERR(err) == -ENOMEM) {
7760 mutex_unlock(&tracing_err_log_lock);
7764 snprintf(err->loc, TRACING_LOG_LOC_MAX, "%s: error: ", loc);
7765 snprintf(err->cmd, len, "\n" CMD_PREFIX "%s\n", cmd);
7767 err->info.errs = errs;
7768 err->info.type = type;
7769 err->info.pos = pos;
7770 err->info.ts = local_clock();
7772 list_add_tail(&err->list, &tr->err_log);
7773 mutex_unlock(&tracing_err_log_lock);
7776 static void clear_tracing_err_log(struct trace_array *tr)
7778 struct tracing_log_err *err, *next;
7780 mutex_lock(&tracing_err_log_lock);
7781 list_for_each_entry_safe(err, next, &tr->err_log, list) {
7782 list_del(&err->list);
7783 free_tracing_log_err(err);
7786 tr->n_err_log_entries = 0;
7787 mutex_unlock(&tracing_err_log_lock);
7790 static void *tracing_err_log_seq_start(struct seq_file *m, loff_t *pos)
7792 struct trace_array *tr = m->private;
7794 mutex_lock(&tracing_err_log_lock);
7796 return seq_list_start(&tr->err_log, *pos);
7799 static void *tracing_err_log_seq_next(struct seq_file *m, void *v, loff_t *pos)
7801 struct trace_array *tr = m->private;
7803 return seq_list_next(v, &tr->err_log, pos);
7806 static void tracing_err_log_seq_stop(struct seq_file *m, void *v)
7808 mutex_unlock(&tracing_err_log_lock);
7811 static void tracing_err_log_show_pos(struct seq_file *m, u16 pos)
7815 for (i = 0; i < sizeof(CMD_PREFIX) - 1; i++)
7817 for (i = 0; i < pos; i++)
7822 static int tracing_err_log_seq_show(struct seq_file *m, void *v)
7824 struct tracing_log_err *err = v;
7827 const char *err_text = err->info.errs[err->info.type];
7828 u64 sec = err->info.ts;
7831 nsec = do_div(sec, NSEC_PER_SEC);
7832 seq_printf(m, "[%5llu.%06u] %s%s", sec, nsec / 1000,
7833 err->loc, err_text);
7834 seq_printf(m, "%s", err->cmd);
7835 tracing_err_log_show_pos(m, err->info.pos);
7841 static const struct seq_operations tracing_err_log_seq_ops = {
7842 .start = tracing_err_log_seq_start,
7843 .next = tracing_err_log_seq_next,
7844 .stop = tracing_err_log_seq_stop,
7845 .show = tracing_err_log_seq_show
7848 static int tracing_err_log_open(struct inode *inode, struct file *file)
7850 struct trace_array *tr = inode->i_private;
7853 ret = tracing_check_open_get_tr(tr);
7857 /* If this file was opened for write, then erase contents */
7858 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC))
7859 clear_tracing_err_log(tr);
7861 if (file->f_mode & FMODE_READ) {
7862 ret = seq_open(file, &tracing_err_log_seq_ops);
7864 struct seq_file *m = file->private_data;
7867 trace_array_put(tr);
7873 static ssize_t tracing_err_log_write(struct file *file,
7874 const char __user *buffer,
7875 size_t count, loff_t *ppos)
7880 static int tracing_err_log_release(struct inode *inode, struct file *file)
7882 struct trace_array *tr = inode->i_private;
7884 trace_array_put(tr);
7886 if (file->f_mode & FMODE_READ)
7887 seq_release(inode, file);
7892 static const struct file_operations tracing_err_log_fops = {
7893 .open = tracing_err_log_open,
7894 .write = tracing_err_log_write,
7896 .llseek = tracing_lseek,
7897 .release = tracing_err_log_release,
7900 static int tracing_buffers_open(struct inode *inode, struct file *filp)
7902 struct trace_array *tr = inode->i_private;
7903 struct ftrace_buffer_info *info;
7906 ret = tracing_check_open_get_tr(tr);
7910 info = kvzalloc(sizeof(*info), GFP_KERNEL);
7912 trace_array_put(tr);
7916 mutex_lock(&trace_types_lock);
7919 info->iter.cpu_file = tracing_get_cpu(inode);
7920 info->iter.trace = tr->current_trace;
7921 info->iter.array_buffer = &tr->array_buffer;
7923 /* Force reading ring buffer for first read */
7924 info->read = (unsigned int)-1;
7926 filp->private_data = info;
7930 mutex_unlock(&trace_types_lock);
7932 ret = nonseekable_open(inode, filp);
7934 trace_array_put(tr);
7940 tracing_buffers_poll(struct file *filp, poll_table *poll_table)
7942 struct ftrace_buffer_info *info = filp->private_data;
7943 struct trace_iterator *iter = &info->iter;
7945 return trace_poll(iter, filp, poll_table);
7949 tracing_buffers_read(struct file *filp, char __user *ubuf,
7950 size_t count, loff_t *ppos)
7952 struct ftrace_buffer_info *info = filp->private_data;
7953 struct trace_iterator *iter = &info->iter;
7962 #ifdef CONFIG_TRACER_MAX_TRACE
7963 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
7967 page_size = ring_buffer_subbuf_size_get(iter->array_buffer->buffer);
7969 /* Make sure the spare matches the current sub buffer size */
7971 if (page_size != info->spare_size) {
7972 ring_buffer_free_read_page(iter->array_buffer->buffer,
7973 info->spare_cpu, info->spare);
7979 info->spare = ring_buffer_alloc_read_page(iter->array_buffer->buffer,
7981 if (IS_ERR(info->spare)) {
7982 ret = PTR_ERR(info->spare);
7985 info->spare_cpu = iter->cpu_file;
7986 info->spare_size = page_size;
7992 /* Do we have previous read data to read? */
7993 if (info->read < page_size)
7997 trace_access_lock(iter->cpu_file);
7998 ret = ring_buffer_read_page(iter->array_buffer->buffer,
8002 trace_access_unlock(iter->cpu_file);
8005 if (trace_empty(iter) && !iter->closed) {
8006 if ((filp->f_flags & O_NONBLOCK))
8009 ret = wait_on_pipe(iter, 0);
8020 size = page_size - info->read;
8023 trace_data = ring_buffer_read_page_data(info->spare);
8024 ret = copy_to_user(ubuf, trace_data + info->read, size);
8036 static int tracing_buffers_flush(struct file *file, fl_owner_t id)
8038 struct ftrace_buffer_info *info = file->private_data;
8039 struct trace_iterator *iter = &info->iter;
8041 iter->closed = true;
8042 /* Make sure the waiters see the new wait_index */
8043 (void)atomic_fetch_inc_release(&iter->wait_index);
8045 ring_buffer_wake_waiters(iter->array_buffer->buffer, iter->cpu_file);
8050 static int tracing_buffers_release(struct inode *inode, struct file *file)
8052 struct ftrace_buffer_info *info = file->private_data;
8053 struct trace_iterator *iter = &info->iter;
8055 mutex_lock(&trace_types_lock);
8057 iter->tr->trace_ref--;
8059 __trace_array_put(iter->tr);
8062 ring_buffer_free_read_page(iter->array_buffer->buffer,
8063 info->spare_cpu, info->spare);
8066 mutex_unlock(&trace_types_lock);
8072 struct trace_buffer *buffer;
8075 refcount_t refcount;
8078 static void buffer_ref_release(struct buffer_ref *ref)
8080 if (!refcount_dec_and_test(&ref->refcount))
8082 ring_buffer_free_read_page(ref->buffer, ref->cpu, ref->page);
8086 static void buffer_pipe_buf_release(struct pipe_inode_info *pipe,
8087 struct pipe_buffer *buf)
8089 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
8091 buffer_ref_release(ref);
8095 static bool buffer_pipe_buf_get(struct pipe_inode_info *pipe,
8096 struct pipe_buffer *buf)
8098 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
8100 if (refcount_read(&ref->refcount) > INT_MAX/2)
8103 refcount_inc(&ref->refcount);
8107 /* Pipe buffer operations for a buffer. */
8108 static const struct pipe_buf_operations buffer_pipe_buf_ops = {
8109 .release = buffer_pipe_buf_release,
8110 .get = buffer_pipe_buf_get,
8114 * Callback from splice_to_pipe(), if we need to release some pages
8115 * at the end of the spd in case we error'ed out in filling the pipe.
8117 static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)
8119 struct buffer_ref *ref =
8120 (struct buffer_ref *)spd->partial[i].private;
8122 buffer_ref_release(ref);
8123 spd->partial[i].private = 0;
8127 tracing_buffers_splice_read(struct file *file, loff_t *ppos,
8128 struct pipe_inode_info *pipe, size_t len,
8131 struct ftrace_buffer_info *info = file->private_data;
8132 struct trace_iterator *iter = &info->iter;
8133 struct partial_page partial_def[PIPE_DEF_BUFFERS];
8134 struct page *pages_def[PIPE_DEF_BUFFERS];
8135 struct splice_pipe_desc spd = {
8137 .partial = partial_def,
8138 .nr_pages_max = PIPE_DEF_BUFFERS,
8139 .ops = &buffer_pipe_buf_ops,
8140 .spd_release = buffer_spd_release,
8142 struct buffer_ref *ref;
8148 #ifdef CONFIG_TRACER_MAX_TRACE
8149 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
8153 page_size = ring_buffer_subbuf_size_get(iter->array_buffer->buffer);
8154 if (*ppos & (page_size - 1))
8157 if (len & (page_size - 1)) {
8158 if (len < page_size)
8160 len &= (~(page_size - 1));
8163 if (splice_grow_spd(pipe, &spd))
8167 trace_access_lock(iter->cpu_file);
8168 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8170 for (i = 0; i < spd.nr_pages_max && len && entries; i++, len -= page_size) {
8174 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
8180 refcount_set(&ref->refcount, 1);
8181 ref->buffer = iter->array_buffer->buffer;
8182 ref->page = ring_buffer_alloc_read_page(ref->buffer, iter->cpu_file);
8183 if (IS_ERR(ref->page)) {
8184 ret = PTR_ERR(ref->page);
8189 ref->cpu = iter->cpu_file;
8191 r = ring_buffer_read_page(ref->buffer, ref->page,
8192 len, iter->cpu_file, 1);
8194 ring_buffer_free_read_page(ref->buffer, ref->cpu,
8200 page = virt_to_page(ring_buffer_read_page_data(ref->page));
8202 spd.pages[i] = page;
8203 spd.partial[i].len = page_size;
8204 spd.partial[i].offset = 0;
8205 spd.partial[i].private = (unsigned long)ref;
8209 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8212 trace_access_unlock(iter->cpu_file);
8215 /* did we read anything? */
8216 if (!spd.nr_pages) {
8225 if ((file->f_flags & O_NONBLOCK) || (flags & SPLICE_F_NONBLOCK))
8228 ret = wait_on_pipe(iter, iter->snapshot ? 0 : iter->tr->buffer_percent);
8232 /* No need to wait after waking up when tracing is off */
8233 if (!tracer_tracing_is_on(iter->tr))
8236 /* Iterate one more time to collect any new data then exit */
8242 ret = splice_to_pipe(pipe, &spd);
8244 splice_shrink_spd(&spd);
8249 static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
8251 struct ftrace_buffer_info *info = file->private_data;
8252 struct trace_iterator *iter = &info->iter;
8255 if (cmd == TRACE_MMAP_IOCTL_GET_READER) {
8256 if (!(file->f_flags & O_NONBLOCK)) {
8257 err = ring_buffer_wait(iter->array_buffer->buffer,
8259 iter->tr->buffer_percent,
8265 return ring_buffer_map_get_reader(iter->array_buffer->buffer,
8272 * An ioctl call with cmd 0 to the ring buffer file will wake up all
8275 mutex_lock(&trace_types_lock);
8277 /* Make sure the waiters see the new wait_index */
8278 (void)atomic_fetch_inc_release(&iter->wait_index);
8280 ring_buffer_wake_waiters(iter->array_buffer->buffer, iter->cpu_file);
8282 mutex_unlock(&trace_types_lock);
8286 #ifdef CONFIG_TRACER_MAX_TRACE
8287 static int get_snapshot_map(struct trace_array *tr)
8292 * Called with mmap_lock held. lockdep would be unhappy if we would now
8293 * take trace_types_lock. Instead use the specific
8294 * snapshot_trigger_lock.
8296 spin_lock(&tr->snapshot_trigger_lock);
8298 if (tr->snapshot || tr->mapped == UINT_MAX)
8303 spin_unlock(&tr->snapshot_trigger_lock);
8305 /* Wait for update_max_tr() to observe iter->tr->mapped */
8306 if (tr->mapped == 1)
8312 static void put_snapshot_map(struct trace_array *tr)
8314 spin_lock(&tr->snapshot_trigger_lock);
8315 if (!WARN_ON(!tr->mapped))
8317 spin_unlock(&tr->snapshot_trigger_lock);
8320 static inline int get_snapshot_map(struct trace_array *tr) { return 0; }
8321 static inline void put_snapshot_map(struct trace_array *tr) { }
8324 static void tracing_buffers_mmap_close(struct vm_area_struct *vma)
8326 struct ftrace_buffer_info *info = vma->vm_file->private_data;
8327 struct trace_iterator *iter = &info->iter;
8329 WARN_ON(ring_buffer_unmap(iter->array_buffer->buffer, iter->cpu_file));
8330 put_snapshot_map(iter->tr);
8333 static const struct vm_operations_struct tracing_buffers_vmops = {
8334 .close = tracing_buffers_mmap_close,
8337 static int tracing_buffers_mmap(struct file *filp, struct vm_area_struct *vma)
8339 struct ftrace_buffer_info *info = filp->private_data;
8340 struct trace_iterator *iter = &info->iter;
8343 ret = get_snapshot_map(iter->tr);
8347 ret = ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file, vma);
8349 put_snapshot_map(iter->tr);
8351 vma->vm_ops = &tracing_buffers_vmops;
8356 static const struct file_operations tracing_buffers_fops = {
8357 .open = tracing_buffers_open,
8358 .read = tracing_buffers_read,
8359 .poll = tracing_buffers_poll,
8360 .release = tracing_buffers_release,
8361 .flush = tracing_buffers_flush,
8362 .splice_read = tracing_buffers_splice_read,
8363 .unlocked_ioctl = tracing_buffers_ioctl,
8364 .mmap = tracing_buffers_mmap,
8368 tracing_stats_read(struct file *filp, char __user *ubuf,
8369 size_t count, loff_t *ppos)
8371 struct inode *inode = file_inode(filp);
8372 struct trace_array *tr = inode->i_private;
8373 struct array_buffer *trace_buf = &tr->array_buffer;
8374 int cpu = tracing_get_cpu(inode);
8375 struct trace_seq *s;
8377 unsigned long long t;
8378 unsigned long usec_rem;
8380 s = kmalloc(sizeof(*s), GFP_KERNEL);
8386 cnt = ring_buffer_entries_cpu(trace_buf->buffer, cpu);
8387 trace_seq_printf(s, "entries: %ld\n", cnt);
8389 cnt = ring_buffer_overrun_cpu(trace_buf->buffer, cpu);
8390 trace_seq_printf(s, "overrun: %ld\n", cnt);
8392 cnt = ring_buffer_commit_overrun_cpu(trace_buf->buffer, cpu);
8393 trace_seq_printf(s, "commit overrun: %ld\n", cnt);
8395 cnt = ring_buffer_bytes_cpu(trace_buf->buffer, cpu);
8396 trace_seq_printf(s, "bytes: %ld\n", cnt);
8398 if (trace_clocks[tr->clock_id].in_ns) {
8399 /* local or global for trace_clock */
8400 t = ns2usecs(ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8401 usec_rem = do_div(t, USEC_PER_SEC);
8402 trace_seq_printf(s, "oldest event ts: %5llu.%06lu\n",
8405 t = ns2usecs(ring_buffer_time_stamp(trace_buf->buffer));
8406 usec_rem = do_div(t, USEC_PER_SEC);
8407 trace_seq_printf(s, "now ts: %5llu.%06lu\n", t, usec_rem);
8409 /* counter or tsc mode for trace_clock */
8410 trace_seq_printf(s, "oldest event ts: %llu\n",
8411 ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8413 trace_seq_printf(s, "now ts: %llu\n",
8414 ring_buffer_time_stamp(trace_buf->buffer));
8417 cnt = ring_buffer_dropped_events_cpu(trace_buf->buffer, cpu);
8418 trace_seq_printf(s, "dropped events: %ld\n", cnt);
8420 cnt = ring_buffer_read_events_cpu(trace_buf->buffer, cpu);
8421 trace_seq_printf(s, "read events: %ld\n", cnt);
8423 count = simple_read_from_buffer(ubuf, count, ppos,
8424 s->buffer, trace_seq_used(s));
8431 static const struct file_operations tracing_stats_fops = {
8432 .open = tracing_open_generic_tr,
8433 .read = tracing_stats_read,
8434 .llseek = generic_file_llseek,
8435 .release = tracing_release_generic_tr,
8438 #ifdef CONFIG_DYNAMIC_FTRACE
8441 tracing_read_dyn_info(struct file *filp, char __user *ubuf,
8442 size_t cnt, loff_t *ppos)
8448 /* 512 should be plenty to hold the amount needed */
8449 #define DYN_INFO_BUF_SIZE 512
8451 buf = kmalloc(DYN_INFO_BUF_SIZE, GFP_KERNEL);
8455 r = scnprintf(buf, DYN_INFO_BUF_SIZE,
8456 "%ld pages:%ld groups: %ld\n"
8457 "ftrace boot update time = %llu (ns)\n"
8458 "ftrace module total update time = %llu (ns)\n",
8459 ftrace_update_tot_cnt,
8460 ftrace_number_of_pages,
8461 ftrace_number_of_groups,
8463 ftrace_total_mod_time);
8465 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
8470 static const struct file_operations tracing_dyn_info_fops = {
8471 .open = tracing_open_generic,
8472 .read = tracing_read_dyn_info,
8473 .llseek = generic_file_llseek,
8475 #endif /* CONFIG_DYNAMIC_FTRACE */
8477 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
8479 ftrace_snapshot(unsigned long ip, unsigned long parent_ip,
8480 struct trace_array *tr, struct ftrace_probe_ops *ops,
8483 tracing_snapshot_instance(tr);
8487 ftrace_count_snapshot(unsigned long ip, unsigned long parent_ip,
8488 struct trace_array *tr, struct ftrace_probe_ops *ops,
8491 struct ftrace_func_mapper *mapper = data;
8495 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8505 tracing_snapshot_instance(tr);
8509 ftrace_snapshot_print(struct seq_file *m, unsigned long ip,
8510 struct ftrace_probe_ops *ops, void *data)
8512 struct ftrace_func_mapper *mapper = data;
8515 seq_printf(m, "%ps:", (void *)ip);
8517 seq_puts(m, "snapshot");
8520 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8523 seq_printf(m, ":count=%ld\n", *count);
8525 seq_puts(m, ":unlimited\n");
8531 ftrace_snapshot_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
8532 unsigned long ip, void *init_data, void **data)
8534 struct ftrace_func_mapper *mapper = *data;
8537 mapper = allocate_ftrace_func_mapper();
8543 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
8547 ftrace_snapshot_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
8548 unsigned long ip, void *data)
8550 struct ftrace_func_mapper *mapper = data;
8555 free_ftrace_func_mapper(mapper, NULL);
8559 ftrace_func_mapper_remove_ip(mapper, ip);
8562 static struct ftrace_probe_ops snapshot_probe_ops = {
8563 .func = ftrace_snapshot,
8564 .print = ftrace_snapshot_print,
8567 static struct ftrace_probe_ops snapshot_count_probe_ops = {
8568 .func = ftrace_count_snapshot,
8569 .print = ftrace_snapshot_print,
8570 .init = ftrace_snapshot_init,
8571 .free = ftrace_snapshot_free,
8575 ftrace_trace_snapshot_callback(struct trace_array *tr, struct ftrace_hash *hash,
8576 char *glob, char *cmd, char *param, int enable)
8578 struct ftrace_probe_ops *ops;
8579 void *count = (void *)-1;
8586 /* hash funcs only work with set_ftrace_filter */
8590 ops = param ? &snapshot_count_probe_ops : &snapshot_probe_ops;
8592 if (glob[0] == '!') {
8593 ret = unregister_ftrace_function_probe_func(glob+1, tr, ops);
8595 tracing_disarm_snapshot(tr);
8603 number = strsep(¶m, ":");
8605 if (!strlen(number))
8609 * We use the callback data field (which is a pointer)
8612 ret = kstrtoul(number, 0, (unsigned long *)&count);
8617 ret = tracing_arm_snapshot(tr);
8621 ret = register_ftrace_function_probe(glob, tr, ops, count);
8623 tracing_disarm_snapshot(tr);
8625 return ret < 0 ? ret : 0;
8628 static struct ftrace_func_command ftrace_snapshot_cmd = {
8630 .func = ftrace_trace_snapshot_callback,
8633 static __init int register_snapshot_cmd(void)
8635 return register_ftrace_command(&ftrace_snapshot_cmd);
8638 static inline __init int register_snapshot_cmd(void) { return 0; }
8639 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
8641 static struct dentry *tracing_get_dentry(struct trace_array *tr)
8643 if (WARN_ON(!tr->dir))
8644 return ERR_PTR(-ENODEV);
8646 /* Top directory uses NULL as the parent */
8647 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
8650 /* All sub buffers have a descriptor */
8654 static struct dentry *tracing_dentry_percpu(struct trace_array *tr, int cpu)
8656 struct dentry *d_tracer;
8659 return tr->percpu_dir;
8661 d_tracer = tracing_get_dentry(tr);
8662 if (IS_ERR(d_tracer))
8665 tr->percpu_dir = tracefs_create_dir("per_cpu", d_tracer);
8667 MEM_FAIL(!tr->percpu_dir,
8668 "Could not create tracefs directory 'per_cpu/%d'\n", cpu);
8670 return tr->percpu_dir;
8673 static struct dentry *
8674 trace_create_cpu_file(const char *name, umode_t mode, struct dentry *parent,
8675 void *data, long cpu, const struct file_operations *fops)
8677 struct dentry *ret = trace_create_file(name, mode, parent, data, fops);
8679 if (ret) /* See tracing_get_cpu() */
8680 d_inode(ret)->i_cdev = (void *)(cpu + 1);
8685 tracing_init_tracefs_percpu(struct trace_array *tr, long cpu)
8687 struct dentry *d_percpu = tracing_dentry_percpu(tr, cpu);
8688 struct dentry *d_cpu;
8689 char cpu_dir[30]; /* 30 characters should be more than enough */
8694 snprintf(cpu_dir, 30, "cpu%ld", cpu);
8695 d_cpu = tracefs_create_dir(cpu_dir, d_percpu);
8697 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir);
8701 /* per cpu trace_pipe */
8702 trace_create_cpu_file("trace_pipe", TRACE_MODE_READ, d_cpu,
8703 tr, cpu, &tracing_pipe_fops);
8706 trace_create_cpu_file("trace", TRACE_MODE_WRITE, d_cpu,
8707 tr, cpu, &tracing_fops);
8709 trace_create_cpu_file("trace_pipe_raw", TRACE_MODE_READ, d_cpu,
8710 tr, cpu, &tracing_buffers_fops);
8712 trace_create_cpu_file("stats", TRACE_MODE_READ, d_cpu,
8713 tr, cpu, &tracing_stats_fops);
8715 trace_create_cpu_file("buffer_size_kb", TRACE_MODE_READ, d_cpu,
8716 tr, cpu, &tracing_entries_fops);
8718 if (tr->range_addr_start)
8719 trace_create_cpu_file("buffer_meta", TRACE_MODE_READ, d_cpu,
8720 tr, cpu, &tracing_buffer_meta_fops);
8721 #ifdef CONFIG_TRACER_SNAPSHOT
8722 if (!tr->range_addr_start) {
8723 trace_create_cpu_file("snapshot", TRACE_MODE_WRITE, d_cpu,
8724 tr, cpu, &snapshot_fops);
8726 trace_create_cpu_file("snapshot_raw", TRACE_MODE_READ, d_cpu,
8727 tr, cpu, &snapshot_raw_fops);
8732 #ifdef CONFIG_FTRACE_SELFTEST
8733 /* Let selftest have access to static functions in this file */
8734 #include "trace_selftest.c"
8738 trace_options_read(struct file *filp, char __user *ubuf, size_t cnt,
8741 struct trace_option_dentry *topt = filp->private_data;
8744 if (topt->flags->val & topt->opt->bit)
8749 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
8753 trace_options_write(struct file *filp, const char __user *ubuf, size_t cnt,
8756 struct trace_option_dentry *topt = filp->private_data;
8760 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8764 if (val != 0 && val != 1)
8767 if (!!(topt->flags->val & topt->opt->bit) != val) {
8768 mutex_lock(&trace_types_lock);
8769 ret = __set_tracer_option(topt->tr, topt->flags,
8771 mutex_unlock(&trace_types_lock);
8781 static int tracing_open_options(struct inode *inode, struct file *filp)
8783 struct trace_option_dentry *topt = inode->i_private;
8786 ret = tracing_check_open_get_tr(topt->tr);
8790 filp->private_data = inode->i_private;
8794 static int tracing_release_options(struct inode *inode, struct file *file)
8796 struct trace_option_dentry *topt = file->private_data;
8798 trace_array_put(topt->tr);
8802 static const struct file_operations trace_options_fops = {
8803 .open = tracing_open_options,
8804 .read = trace_options_read,
8805 .write = trace_options_write,
8806 .llseek = generic_file_llseek,
8807 .release = tracing_release_options,
8811 * In order to pass in both the trace_array descriptor as well as the index
8812 * to the flag that the trace option file represents, the trace_array
8813 * has a character array of trace_flags_index[], which holds the index
8814 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
8815 * The address of this character array is passed to the flag option file
8816 * read/write callbacks.
8818 * In order to extract both the index and the trace_array descriptor,
8819 * get_tr_index() uses the following algorithm.
8823 * As the pointer itself contains the address of the index (remember
8826 * Then to get the trace_array descriptor, by subtracting that index
8827 * from the ptr, we get to the start of the index itself.
8829 * ptr - idx == &index[0]
8831 * Then a simple container_of() from that pointer gets us to the
8832 * trace_array descriptor.
8834 static void get_tr_index(void *data, struct trace_array **ptr,
8835 unsigned int *pindex)
8837 *pindex = *(unsigned char *)data;
8839 *ptr = container_of(data - *pindex, struct trace_array,
8844 trace_options_core_read(struct file *filp, char __user *ubuf, size_t cnt,
8847 void *tr_index = filp->private_data;
8848 struct trace_array *tr;
8852 get_tr_index(tr_index, &tr, &index);
8854 if (tr->trace_flags & (1 << index))
8859 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
8863 trace_options_core_write(struct file *filp, const char __user *ubuf, size_t cnt,
8866 void *tr_index = filp->private_data;
8867 struct trace_array *tr;
8872 get_tr_index(tr_index, &tr, &index);
8874 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8878 if (val != 0 && val != 1)
8881 mutex_lock(&event_mutex);
8882 mutex_lock(&trace_types_lock);
8883 ret = set_tracer_flag(tr, 1 << index, val);
8884 mutex_unlock(&trace_types_lock);
8885 mutex_unlock(&event_mutex);
8895 static const struct file_operations trace_options_core_fops = {
8896 .open = tracing_open_generic,
8897 .read = trace_options_core_read,
8898 .write = trace_options_core_write,
8899 .llseek = generic_file_llseek,
8902 struct dentry *trace_create_file(const char *name,
8904 struct dentry *parent,
8906 const struct file_operations *fops)
8910 ret = tracefs_create_file(name, mode, parent, data, fops);
8912 pr_warn("Could not create tracefs '%s' entry\n", name);
8918 static struct dentry *trace_options_init_dentry(struct trace_array *tr)
8920 struct dentry *d_tracer;
8925 d_tracer = tracing_get_dentry(tr);
8926 if (IS_ERR(d_tracer))
8929 tr->options = tracefs_create_dir("options", d_tracer);
8931 pr_warn("Could not create tracefs directory 'options'\n");
8939 create_trace_option_file(struct trace_array *tr,
8940 struct trace_option_dentry *topt,
8941 struct tracer_flags *flags,
8942 struct tracer_opt *opt)
8944 struct dentry *t_options;
8946 t_options = trace_options_init_dentry(tr);
8950 topt->flags = flags;
8954 topt->entry = trace_create_file(opt->name, TRACE_MODE_WRITE,
8955 t_options, topt, &trace_options_fops);
8960 create_trace_option_files(struct trace_array *tr, struct tracer *tracer)
8962 struct trace_option_dentry *topts;
8963 struct trace_options *tr_topts;
8964 struct tracer_flags *flags;
8965 struct tracer_opt *opts;
8972 flags = tracer->flags;
8974 if (!flags || !flags->opts)
8978 * If this is an instance, only create flags for tracers
8979 * the instance may have.
8981 if (!trace_ok_for_array(tracer, tr))
8984 for (i = 0; i < tr->nr_topts; i++) {
8985 /* Make sure there's no duplicate flags. */
8986 if (WARN_ON_ONCE(tr->topts[i].tracer->flags == tracer->flags))
8992 for (cnt = 0; opts[cnt].name; cnt++)
8995 topts = kcalloc(cnt + 1, sizeof(*topts), GFP_KERNEL);
8999 tr_topts = krealloc(tr->topts, sizeof(*tr->topts) * (tr->nr_topts + 1),
9006 tr->topts = tr_topts;
9007 tr->topts[tr->nr_topts].tracer = tracer;
9008 tr->topts[tr->nr_topts].topts = topts;
9011 for (cnt = 0; opts[cnt].name; cnt++) {
9012 create_trace_option_file(tr, &topts[cnt], flags,
9014 MEM_FAIL(topts[cnt].entry == NULL,
9015 "Failed to create trace option: %s",
9020 static struct dentry *
9021 create_trace_option_core_file(struct trace_array *tr,
9022 const char *option, long index)
9024 struct dentry *t_options;
9026 t_options = trace_options_init_dentry(tr);
9030 return trace_create_file(option, TRACE_MODE_WRITE, t_options,
9031 (void *)&tr->trace_flags_index[index],
9032 &trace_options_core_fops);
9035 static void create_trace_options_dir(struct trace_array *tr)
9037 struct dentry *t_options;
9038 bool top_level = tr == &global_trace;
9041 t_options = trace_options_init_dentry(tr);
9045 for (i = 0; trace_options[i]; i++) {
9047 !((1 << i) & TOP_LEVEL_TRACE_FLAGS))
9048 create_trace_option_core_file(tr, trace_options[i], i);
9053 rb_simple_read(struct file *filp, char __user *ubuf,
9054 size_t cnt, loff_t *ppos)
9056 struct trace_array *tr = filp->private_data;
9060 r = tracer_tracing_is_on(tr);
9061 r = sprintf(buf, "%d\n", r);
9063 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
9067 rb_simple_write(struct file *filp, const char __user *ubuf,
9068 size_t cnt, loff_t *ppos)
9070 struct trace_array *tr = filp->private_data;
9071 struct trace_buffer *buffer = tr->array_buffer.buffer;
9075 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9080 mutex_lock(&trace_types_lock);
9081 if (!!val == tracer_tracing_is_on(tr)) {
9082 val = 0; /* do nothing */
9084 tracer_tracing_on(tr);
9085 if (tr->current_trace->start)
9086 tr->current_trace->start(tr);
9088 tracer_tracing_off(tr);
9089 if (tr->current_trace->stop)
9090 tr->current_trace->stop(tr);
9091 /* Wake up any waiters */
9092 ring_buffer_wake_waiters(buffer, RING_BUFFER_ALL_CPUS);
9094 mutex_unlock(&trace_types_lock);
9102 static const struct file_operations rb_simple_fops = {
9103 .open = tracing_open_generic_tr,
9104 .read = rb_simple_read,
9105 .write = rb_simple_write,
9106 .release = tracing_release_generic_tr,
9107 .llseek = default_llseek,
9111 buffer_percent_read(struct file *filp, char __user *ubuf,
9112 size_t cnt, loff_t *ppos)
9114 struct trace_array *tr = filp->private_data;
9118 r = tr->buffer_percent;
9119 r = sprintf(buf, "%d\n", r);
9121 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
9125 buffer_percent_write(struct file *filp, const char __user *ubuf,
9126 size_t cnt, loff_t *ppos)
9128 struct trace_array *tr = filp->private_data;
9132 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9139 tr->buffer_percent = val;
9146 static const struct file_operations buffer_percent_fops = {
9147 .open = tracing_open_generic_tr,
9148 .read = buffer_percent_read,
9149 .write = buffer_percent_write,
9150 .release = tracing_release_generic_tr,
9151 .llseek = default_llseek,
9155 buffer_subbuf_size_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
9157 struct trace_array *tr = filp->private_data;
9163 order = ring_buffer_subbuf_order_get(tr->array_buffer.buffer);
9164 size = (PAGE_SIZE << order) / 1024;
9166 r = sprintf(buf, "%zd\n", size);
9168 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
9172 buffer_subbuf_size_write(struct file *filp, const char __user *ubuf,
9173 size_t cnt, loff_t *ppos)
9175 struct trace_array *tr = filp->private_data;
9182 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9186 val *= 1024; /* value passed in is in KB */
9188 pages = DIV_ROUND_UP(val, PAGE_SIZE);
9189 order = fls(pages - 1);
9191 /* limit between 1 and 128 system pages */
9192 if (order < 0 || order > 7)
9195 /* Do not allow tracing while changing the order of the ring buffer */
9196 tracing_stop_tr(tr);
9198 old_order = ring_buffer_subbuf_order_get(tr->array_buffer.buffer);
9199 if (old_order == order)
9202 ret = ring_buffer_subbuf_order_set(tr->array_buffer.buffer, order);
9206 #ifdef CONFIG_TRACER_MAX_TRACE
9208 if (!tr->allocated_snapshot)
9211 ret = ring_buffer_subbuf_order_set(tr->max_buffer.buffer, order);
9213 /* Put back the old order */
9214 cnt = ring_buffer_subbuf_order_set(tr->array_buffer.buffer, old_order);
9215 if (WARN_ON_ONCE(cnt)) {
9217 * AARGH! We are left with different orders!
9218 * The max buffer is our "snapshot" buffer.
9219 * When a tracer needs a snapshot (one of the
9220 * latency tracers), it swaps the max buffer
9221 * with the saved snap shot. We succeeded to
9222 * update the order of the main buffer, but failed to
9223 * update the order of the max buffer. But when we tried
9224 * to reset the main buffer to the original size, we
9225 * failed there too. This is very unlikely to
9226 * happen, but if it does, warn and kill all
9229 tracing_disabled = 1;
9239 tracing_start_tr(tr);
9243 static const struct file_operations buffer_subbuf_size_fops = {
9244 .open = tracing_open_generic_tr,
9245 .read = buffer_subbuf_size_read,
9246 .write = buffer_subbuf_size_write,
9247 .release = tracing_release_generic_tr,
9248 .llseek = default_llseek,
9251 static struct dentry *trace_instance_dir;
9254 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer);
9257 allocate_trace_buffer(struct trace_array *tr, struct array_buffer *buf, int size)
9259 enum ring_buffer_flags rb_flags;
9261 rb_flags = tr->trace_flags & TRACE_ITER_OVERWRITE ? RB_FL_OVERWRITE : 0;
9265 if (tr->range_addr_start && tr->range_addr_size) {
9266 buf->buffer = ring_buffer_alloc_range(size, rb_flags, 0,
9267 tr->range_addr_start,
9268 tr->range_addr_size);
9270 ring_buffer_last_boot_delta(buf->buffer,
9271 &tr->text_delta, &tr->data_delta);
9273 * This is basically the same as a mapped buffer,
9274 * with the same restrictions.
9278 buf->buffer = ring_buffer_alloc(size, rb_flags);
9283 buf->data = alloc_percpu(struct trace_array_cpu);
9285 ring_buffer_free(buf->buffer);
9290 /* Allocate the first page for all buffers */
9291 set_buffer_entries(&tr->array_buffer,
9292 ring_buffer_size(tr->array_buffer.buffer, 0));
9297 static void free_trace_buffer(struct array_buffer *buf)
9300 ring_buffer_free(buf->buffer);
9302 free_percpu(buf->data);
9307 static int allocate_trace_buffers(struct trace_array *tr, int size)
9311 ret = allocate_trace_buffer(tr, &tr->array_buffer, size);
9315 #ifdef CONFIG_TRACER_MAX_TRACE
9316 /* Fix mapped buffer trace arrays do not have snapshot buffers */
9317 if (tr->range_addr_start)
9320 ret = allocate_trace_buffer(tr, &tr->max_buffer,
9321 allocate_snapshot ? size : 1);
9322 if (MEM_FAIL(ret, "Failed to allocate trace buffer\n")) {
9323 free_trace_buffer(&tr->array_buffer);
9326 tr->allocated_snapshot = allocate_snapshot;
9328 allocate_snapshot = false;
9334 static void free_trace_buffers(struct trace_array *tr)
9339 free_trace_buffer(&tr->array_buffer);
9341 #ifdef CONFIG_TRACER_MAX_TRACE
9342 free_trace_buffer(&tr->max_buffer);
9346 static void init_trace_flags_index(struct trace_array *tr)
9350 /* Used by the trace options files */
9351 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++)
9352 tr->trace_flags_index[i] = i;
9355 static void __update_tracer_options(struct trace_array *tr)
9359 for (t = trace_types; t; t = t->next)
9360 add_tracer_options(tr, t);
9363 static void update_tracer_options(struct trace_array *tr)
9365 mutex_lock(&trace_types_lock);
9366 tracer_options_updated = true;
9367 __update_tracer_options(tr);
9368 mutex_unlock(&trace_types_lock);
9371 /* Must have trace_types_lock held */
9372 struct trace_array *trace_array_find(const char *instance)
9374 struct trace_array *tr, *found = NULL;
9376 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9377 if (tr->name && strcmp(tr->name, instance) == 0) {
9386 struct trace_array *trace_array_find_get(const char *instance)
9388 struct trace_array *tr;
9390 mutex_lock(&trace_types_lock);
9391 tr = trace_array_find(instance);
9394 mutex_unlock(&trace_types_lock);
9399 static int trace_array_create_dir(struct trace_array *tr)
9403 tr->dir = tracefs_create_dir(tr->name, trace_instance_dir);
9407 ret = event_trace_add_tracer(tr->dir, tr);
9409 tracefs_remove(tr->dir);
9413 init_tracer_tracefs(tr, tr->dir);
9414 __update_tracer_options(tr);
9419 static struct trace_array *
9420 trace_array_create_systems(const char *name, const char *systems,
9421 unsigned long range_addr_start,
9422 unsigned long range_addr_size)
9424 struct trace_array *tr;
9428 tr = kzalloc(sizeof(*tr), GFP_KERNEL);
9430 return ERR_PTR(ret);
9432 tr->name = kstrdup(name, GFP_KERNEL);
9436 if (!alloc_cpumask_var(&tr->tracing_cpumask, GFP_KERNEL))
9439 if (!zalloc_cpumask_var(&tr->pipe_cpumask, GFP_KERNEL))
9443 tr->system_names = kstrdup_const(systems, GFP_KERNEL);
9444 if (!tr->system_names)
9448 /* Only for boot up memory mapped ring buffers */
9449 tr->range_addr_start = range_addr_start;
9450 tr->range_addr_size = range_addr_size;
9452 tr->trace_flags = global_trace.trace_flags & ~ZEROED_TRACE_FLAGS;
9454 cpumask_copy(tr->tracing_cpumask, cpu_all_mask);
9456 raw_spin_lock_init(&tr->start_lock);
9458 tr->max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
9459 #ifdef CONFIG_TRACER_MAX_TRACE
9460 spin_lock_init(&tr->snapshot_trigger_lock);
9462 tr->current_trace = &nop_trace;
9464 INIT_LIST_HEAD(&tr->systems);
9465 INIT_LIST_HEAD(&tr->events);
9466 INIT_LIST_HEAD(&tr->hist_vars);
9467 INIT_LIST_HEAD(&tr->err_log);
9469 if (allocate_trace_buffers(tr, trace_buf_size) < 0)
9472 /* The ring buffer is defaultly expanded */
9473 trace_set_ring_buffer_expanded(tr);
9475 if (ftrace_allocate_ftrace_ops(tr) < 0)
9478 ftrace_init_trace_array(tr);
9480 init_trace_flags_index(tr);
9482 if (trace_instance_dir) {
9483 ret = trace_array_create_dir(tr);
9487 __trace_early_add_events(tr);
9489 list_add(&tr->list, &ftrace_trace_arrays);
9496 ftrace_free_ftrace_ops(tr);
9497 free_trace_buffers(tr);
9498 free_cpumask_var(tr->pipe_cpumask);
9499 free_cpumask_var(tr->tracing_cpumask);
9500 kfree_const(tr->system_names);
9504 return ERR_PTR(ret);
9507 static struct trace_array *trace_array_create(const char *name)
9509 return trace_array_create_systems(name, NULL, 0, 0);
9512 static int instance_mkdir(const char *name)
9514 struct trace_array *tr;
9517 mutex_lock(&event_mutex);
9518 mutex_lock(&trace_types_lock);
9521 if (trace_array_find(name))
9524 tr = trace_array_create(name);
9526 ret = PTR_ERR_OR_ZERO(tr);
9529 mutex_unlock(&trace_types_lock);
9530 mutex_unlock(&event_mutex);
9534 static u64 map_pages(u64 start, u64 size)
9536 struct page **pages;
9537 phys_addr_t page_start;
9538 unsigned int page_count;
9542 page_count = DIV_ROUND_UP(size, PAGE_SIZE);
9545 pages = kmalloc_array(page_count, sizeof(struct page *), GFP_KERNEL);
9549 for (i = 0; i < page_count; i++) {
9550 phys_addr_t addr = page_start + i * PAGE_SIZE;
9551 pages[i] = pfn_to_page(addr >> PAGE_SHIFT);
9553 vaddr = vmap(pages, page_count, VM_MAP, PAGE_KERNEL);
9556 return (u64)(unsigned long)vaddr;
9560 * trace_array_get_by_name - Create/Lookup a trace array, given its name.
9561 * @name: The name of the trace array to be looked up/created.
9562 * @systems: A list of systems to create event directories for (NULL for all)
9564 * Returns pointer to trace array with given name.
9565 * NULL, if it cannot be created.
9567 * NOTE: This function increments the reference counter associated with the
9568 * trace array returned. This makes sure it cannot be freed while in use.
9569 * Use trace_array_put() once the trace array is no longer needed.
9570 * If the trace_array is to be freed, trace_array_destroy() needs to
9571 * be called after the trace_array_put(), or simply let user space delete
9572 * it from the tracefs instances directory. But until the
9573 * trace_array_put() is called, user space can not delete it.
9576 struct trace_array *trace_array_get_by_name(const char *name, const char *systems)
9578 struct trace_array *tr;
9580 mutex_lock(&event_mutex);
9581 mutex_lock(&trace_types_lock);
9583 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9584 if (tr->name && strcmp(tr->name, name) == 0)
9588 tr = trace_array_create_systems(name, systems, 0, 0);
9596 mutex_unlock(&trace_types_lock);
9597 mutex_unlock(&event_mutex);
9600 EXPORT_SYMBOL_GPL(trace_array_get_by_name);
9602 static int __remove_instance(struct trace_array *tr)
9606 /* Reference counter for a newly created trace array = 1. */
9607 if (tr->ref > 1 || (tr->current_trace && tr->trace_ref))
9610 list_del(&tr->list);
9612 /* Disable all the flags that were enabled coming in */
9613 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++) {
9614 if ((1 << i) & ZEROED_TRACE_FLAGS)
9615 set_tracer_flag(tr, 1 << i, 0);
9618 if (printk_trace == tr)
9619 update_printk_trace(&global_trace);
9621 tracing_set_nop(tr);
9622 clear_ftrace_function_probes(tr);
9623 event_trace_del_tracer(tr);
9624 ftrace_clear_pids(tr);
9625 ftrace_destroy_function_files(tr);
9626 tracefs_remove(tr->dir);
9627 free_percpu(tr->last_func_repeats);
9628 free_trace_buffers(tr);
9629 clear_tracing_err_log(tr);
9631 for (i = 0; i < tr->nr_topts; i++) {
9632 kfree(tr->topts[i].topts);
9636 free_cpumask_var(tr->pipe_cpumask);
9637 free_cpumask_var(tr->tracing_cpumask);
9638 kfree_const(tr->system_names);
9645 int trace_array_destroy(struct trace_array *this_tr)
9647 struct trace_array *tr;
9653 mutex_lock(&event_mutex);
9654 mutex_lock(&trace_types_lock);
9658 /* Making sure trace array exists before destroying it. */
9659 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9660 if (tr == this_tr) {
9661 ret = __remove_instance(tr);
9666 mutex_unlock(&trace_types_lock);
9667 mutex_unlock(&event_mutex);
9671 EXPORT_SYMBOL_GPL(trace_array_destroy);
9673 static int instance_rmdir(const char *name)
9675 struct trace_array *tr;
9678 mutex_lock(&event_mutex);
9679 mutex_lock(&trace_types_lock);
9682 tr = trace_array_find(name);
9684 ret = __remove_instance(tr);
9686 mutex_unlock(&trace_types_lock);
9687 mutex_unlock(&event_mutex);
9692 static __init void create_trace_instances(struct dentry *d_tracer)
9694 struct trace_array *tr;
9696 trace_instance_dir = tracefs_create_instance_dir("instances", d_tracer,
9699 if (MEM_FAIL(!trace_instance_dir, "Failed to create instances directory\n"))
9702 mutex_lock(&event_mutex);
9703 mutex_lock(&trace_types_lock);
9705 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9708 if (MEM_FAIL(trace_array_create_dir(tr) < 0,
9709 "Failed to create instance directory\n"))
9713 mutex_unlock(&trace_types_lock);
9714 mutex_unlock(&event_mutex);
9718 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer)
9722 trace_create_file("available_tracers", TRACE_MODE_READ, d_tracer,
9723 tr, &show_traces_fops);
9725 trace_create_file("current_tracer", TRACE_MODE_WRITE, d_tracer,
9726 tr, &set_tracer_fops);
9728 trace_create_file("tracing_cpumask", TRACE_MODE_WRITE, d_tracer,
9729 tr, &tracing_cpumask_fops);
9731 trace_create_file("trace_options", TRACE_MODE_WRITE, d_tracer,
9732 tr, &tracing_iter_fops);
9734 trace_create_file("trace", TRACE_MODE_WRITE, d_tracer,
9737 trace_create_file("trace_pipe", TRACE_MODE_READ, d_tracer,
9738 tr, &tracing_pipe_fops);
9740 trace_create_file("buffer_size_kb", TRACE_MODE_WRITE, d_tracer,
9741 tr, &tracing_entries_fops);
9743 trace_create_file("buffer_total_size_kb", TRACE_MODE_READ, d_tracer,
9744 tr, &tracing_total_entries_fops);
9746 trace_create_file("free_buffer", 0200, d_tracer,
9747 tr, &tracing_free_buffer_fops);
9749 trace_create_file("trace_marker", 0220, d_tracer,
9750 tr, &tracing_mark_fops);
9752 tr->trace_marker_file = __find_event_file(tr, "ftrace", "print");
9754 trace_create_file("trace_marker_raw", 0220, d_tracer,
9755 tr, &tracing_mark_raw_fops);
9757 trace_create_file("trace_clock", TRACE_MODE_WRITE, d_tracer, tr,
9760 trace_create_file("tracing_on", TRACE_MODE_WRITE, d_tracer,
9761 tr, &rb_simple_fops);
9763 trace_create_file("timestamp_mode", TRACE_MODE_READ, d_tracer, tr,
9764 &trace_time_stamp_mode_fops);
9766 tr->buffer_percent = 50;
9768 trace_create_file("buffer_percent", TRACE_MODE_WRITE, d_tracer,
9769 tr, &buffer_percent_fops);
9771 trace_create_file("buffer_subbuf_size_kb", TRACE_MODE_WRITE, d_tracer,
9772 tr, &buffer_subbuf_size_fops);
9774 create_trace_options_dir(tr);
9776 #ifdef CONFIG_TRACER_MAX_TRACE
9777 trace_create_maxlat_file(tr, d_tracer);
9780 if (ftrace_create_function_files(tr, d_tracer))
9781 MEM_FAIL(1, "Could not allocate function filter files");
9783 if (tr->range_addr_start) {
9784 trace_create_file("last_boot_info", TRACE_MODE_READ, d_tracer,
9785 tr, &last_boot_fops);
9786 #ifdef CONFIG_TRACER_SNAPSHOT
9788 trace_create_file("snapshot", TRACE_MODE_WRITE, d_tracer,
9789 tr, &snapshot_fops);
9793 trace_create_file("error_log", TRACE_MODE_WRITE, d_tracer,
9794 tr, &tracing_err_log_fops);
9796 for_each_tracing_cpu(cpu)
9797 tracing_init_tracefs_percpu(tr, cpu);
9799 ftrace_init_tracefs(tr, d_tracer);
9802 static struct vfsmount *trace_automount(struct dentry *mntpt, void *ingore)
9804 struct vfsmount *mnt;
9805 struct file_system_type *type;
9808 * To maintain backward compatibility for tools that mount
9809 * debugfs to get to the tracing facility, tracefs is automatically
9810 * mounted to the debugfs/tracing directory.
9812 type = get_fs_type("tracefs");
9815 mnt = vfs_submount(mntpt, type, "tracefs", NULL);
9816 put_filesystem(type);
9825 * tracing_init_dentry - initialize top level trace array
9827 * This is called when creating files or directories in the tracing
9828 * directory. It is called via fs_initcall() by any of the boot up code
9829 * and expects to return the dentry of the top level tracing directory.
9831 int tracing_init_dentry(void)
9833 struct trace_array *tr = &global_trace;
9835 if (security_locked_down(LOCKDOWN_TRACEFS)) {
9836 pr_warn("Tracing disabled due to lockdown\n");
9840 /* The top level trace array uses NULL as parent */
9844 if (WARN_ON(!tracefs_initialized()))
9848 * As there may still be users that expect the tracing
9849 * files to exist in debugfs/tracing, we must automount
9850 * the tracefs file system there, so older tools still
9851 * work with the newer kernel.
9853 tr->dir = debugfs_create_automount("tracing", NULL,
9854 trace_automount, NULL);
9859 extern struct trace_eval_map *__start_ftrace_eval_maps[];
9860 extern struct trace_eval_map *__stop_ftrace_eval_maps[];
9862 static struct workqueue_struct *eval_map_wq __initdata;
9863 static struct work_struct eval_map_work __initdata;
9864 static struct work_struct tracerfs_init_work __initdata;
9866 static void __init eval_map_work_func(struct work_struct *work)
9870 len = __stop_ftrace_eval_maps - __start_ftrace_eval_maps;
9871 trace_insert_eval_map(NULL, __start_ftrace_eval_maps, len);
9874 static int __init trace_eval_init(void)
9876 INIT_WORK(&eval_map_work, eval_map_work_func);
9878 eval_map_wq = alloc_workqueue("eval_map_wq", WQ_UNBOUND, 0);
9880 pr_err("Unable to allocate eval_map_wq\n");
9882 eval_map_work_func(&eval_map_work);
9886 queue_work(eval_map_wq, &eval_map_work);
9890 subsys_initcall(trace_eval_init);
9892 static int __init trace_eval_sync(void)
9894 /* Make sure the eval map updates are finished */
9896 destroy_workqueue(eval_map_wq);
9900 late_initcall_sync(trace_eval_sync);
9903 #ifdef CONFIG_MODULES
9904 static void trace_module_add_evals(struct module *mod)
9906 if (!mod->num_trace_evals)
9910 * Modules with bad taint do not have events created, do
9911 * not bother with enums either.
9913 if (trace_module_has_bad_taint(mod))
9916 trace_insert_eval_map(mod, mod->trace_evals, mod->num_trace_evals);
9919 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
9920 static void trace_module_remove_evals(struct module *mod)
9922 union trace_eval_map_item *map;
9923 union trace_eval_map_item **last = &trace_eval_maps;
9925 if (!mod->num_trace_evals)
9928 mutex_lock(&trace_eval_mutex);
9930 map = trace_eval_maps;
9933 if (map->head.mod == mod)
9935 map = trace_eval_jmp_to_tail(map);
9936 last = &map->tail.next;
9937 map = map->tail.next;
9942 *last = trace_eval_jmp_to_tail(map)->tail.next;
9945 mutex_unlock(&trace_eval_mutex);
9948 static inline void trace_module_remove_evals(struct module *mod) { }
9949 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
9951 static int trace_module_notify(struct notifier_block *self,
9952 unsigned long val, void *data)
9954 struct module *mod = data;
9957 case MODULE_STATE_COMING:
9958 trace_module_add_evals(mod);
9960 case MODULE_STATE_GOING:
9961 trace_module_remove_evals(mod);
9968 static struct notifier_block trace_module_nb = {
9969 .notifier_call = trace_module_notify,
9972 #endif /* CONFIG_MODULES */
9974 static __init void tracer_init_tracefs_work_func(struct work_struct *work)
9979 init_tracer_tracefs(&global_trace, NULL);
9980 ftrace_init_tracefs_toplevel(&global_trace, NULL);
9982 trace_create_file("tracing_thresh", TRACE_MODE_WRITE, NULL,
9983 &global_trace, &tracing_thresh_fops);
9985 trace_create_file("README", TRACE_MODE_READ, NULL,
9986 NULL, &tracing_readme_fops);
9988 trace_create_file("saved_cmdlines", TRACE_MODE_READ, NULL,
9989 NULL, &tracing_saved_cmdlines_fops);
9991 trace_create_file("saved_cmdlines_size", TRACE_MODE_WRITE, NULL,
9992 NULL, &tracing_saved_cmdlines_size_fops);
9994 trace_create_file("saved_tgids", TRACE_MODE_READ, NULL,
9995 NULL, &tracing_saved_tgids_fops);
9997 trace_create_eval_file(NULL);
9999 #ifdef CONFIG_MODULES
10000 register_module_notifier(&trace_module_nb);
10003 #ifdef CONFIG_DYNAMIC_FTRACE
10004 trace_create_file("dyn_ftrace_total_info", TRACE_MODE_READ, NULL,
10005 NULL, &tracing_dyn_info_fops);
10008 create_trace_instances(NULL);
10010 update_tracer_options(&global_trace);
10013 static __init int tracer_init_tracefs(void)
10017 trace_access_lock_init();
10019 ret = tracing_init_dentry();
10024 INIT_WORK(&tracerfs_init_work, tracer_init_tracefs_work_func);
10025 queue_work(eval_map_wq, &tracerfs_init_work);
10027 tracer_init_tracefs_work_func(NULL);
10030 rv_init_interface();
10035 fs_initcall(tracer_init_tracefs);
10037 static int trace_die_panic_handler(struct notifier_block *self,
10038 unsigned long ev, void *unused);
10040 static struct notifier_block trace_panic_notifier = {
10041 .notifier_call = trace_die_panic_handler,
10042 .priority = INT_MAX - 1,
10045 static struct notifier_block trace_die_notifier = {
10046 .notifier_call = trace_die_panic_handler,
10047 .priority = INT_MAX - 1,
10051 * The idea is to execute the following die/panic callback early, in order
10052 * to avoid showing irrelevant information in the trace (like other panic
10053 * notifier functions); we are the 2nd to run, after hung_task/rcu_stall
10054 * warnings get disabled (to prevent potential log flooding).
10056 static int trace_die_panic_handler(struct notifier_block *self,
10057 unsigned long ev, void *unused)
10059 if (!ftrace_dump_on_oops_enabled())
10060 return NOTIFY_DONE;
10062 /* The die notifier requires DIE_OOPS to trigger */
10063 if (self == &trace_die_notifier && ev != DIE_OOPS)
10064 return NOTIFY_DONE;
10066 ftrace_dump(DUMP_PARAM);
10068 return NOTIFY_DONE;
10072 * printk is set to max of 1024, we really don't need it that big.
10073 * Nothing should be printing 1000 characters anyway.
10075 #define TRACE_MAX_PRINT 1000
10078 * Define here KERN_TRACE so that we have one place to modify
10079 * it if we decide to change what log level the ftrace dump
10082 #define KERN_TRACE KERN_EMERG
10085 trace_printk_seq(struct trace_seq *s)
10087 /* Probably should print a warning here. */
10088 if (s->seq.len >= TRACE_MAX_PRINT)
10089 s->seq.len = TRACE_MAX_PRINT;
10092 * More paranoid code. Although the buffer size is set to
10093 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
10094 * an extra layer of protection.
10096 if (WARN_ON_ONCE(s->seq.len >= s->seq.size))
10097 s->seq.len = s->seq.size - 1;
10099 /* should be zero ended, but we are paranoid. */
10100 s->buffer[s->seq.len] = 0;
10102 printk(KERN_TRACE "%s", s->buffer);
10107 static void trace_init_iter(struct trace_iterator *iter, struct trace_array *tr)
10110 iter->trace = iter->tr->current_trace;
10111 iter->cpu_file = RING_BUFFER_ALL_CPUS;
10112 iter->array_buffer = &tr->array_buffer;
10114 if (iter->trace && iter->trace->open)
10115 iter->trace->open(iter);
10117 /* Annotate start of buffers if we had overruns */
10118 if (ring_buffer_overruns(iter->array_buffer->buffer))
10119 iter->iter_flags |= TRACE_FILE_ANNOTATE;
10121 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
10122 if (trace_clocks[iter->tr->clock_id].in_ns)
10123 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
10125 /* Can not use kmalloc for iter.temp and iter.fmt */
10126 iter->temp = static_temp_buf;
10127 iter->temp_size = STATIC_TEMP_BUF_SIZE;
10128 iter->fmt = static_fmt_buf;
10129 iter->fmt_size = STATIC_FMT_BUF_SIZE;
10132 void trace_init_global_iter(struct trace_iterator *iter)
10134 trace_init_iter(iter, &global_trace);
10137 static void ftrace_dump_one(struct trace_array *tr, enum ftrace_dump_mode dump_mode)
10139 /* use static because iter can be a bit big for the stack */
10140 static struct trace_iterator iter;
10141 unsigned int old_userobj;
10142 unsigned long flags;
10146 * Always turn off tracing when we dump.
10147 * We don't need to show trace output of what happens
10148 * between multiple crashes.
10150 * If the user does a sysrq-z, then they can re-enable
10151 * tracing with echo 1 > tracing_on.
10153 tracer_tracing_off(tr);
10155 local_irq_save(flags);
10157 /* Simulate the iterator */
10158 trace_init_iter(&iter, tr);
10160 for_each_tracing_cpu(cpu) {
10161 atomic_inc(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
10164 old_userobj = tr->trace_flags & TRACE_ITER_SYM_USEROBJ;
10166 /* don't look at user memory in panic mode */
10167 tr->trace_flags &= ~TRACE_ITER_SYM_USEROBJ;
10169 if (dump_mode == DUMP_ORIG)
10170 iter.cpu_file = raw_smp_processor_id();
10172 iter.cpu_file = RING_BUFFER_ALL_CPUS;
10174 if (tr == &global_trace)
10175 printk(KERN_TRACE "Dumping ftrace buffer:\n");
10177 printk(KERN_TRACE "Dumping ftrace instance %s buffer:\n", tr->name);
10179 /* Did function tracer already get disabled? */
10180 if (ftrace_is_dead()) {
10181 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
10182 printk("# MAY BE MISSING FUNCTION EVENTS\n");
10186 * We need to stop all tracing on all CPUS to read
10187 * the next buffer. This is a bit expensive, but is
10188 * not done often. We fill all what we can read,
10189 * and then release the locks again.
10192 while (!trace_empty(&iter)) {
10195 printk(KERN_TRACE "---------------------------------\n");
10199 trace_iterator_reset(&iter);
10200 iter.iter_flags |= TRACE_FILE_LAT_FMT;
10202 if (trace_find_next_entry_inc(&iter) != NULL) {
10205 ret = print_trace_line(&iter);
10206 if (ret != TRACE_TYPE_NO_CONSUME)
10207 trace_consume(&iter);
10209 touch_nmi_watchdog();
10211 trace_printk_seq(&iter.seq);
10215 printk(KERN_TRACE " (ftrace buffer empty)\n");
10217 printk(KERN_TRACE "---------------------------------\n");
10219 tr->trace_flags |= old_userobj;
10221 for_each_tracing_cpu(cpu) {
10222 atomic_dec(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
10224 local_irq_restore(flags);
10227 static void ftrace_dump_by_param(void)
10229 bool first_param = true;
10230 char dump_param[MAX_TRACER_SIZE];
10231 char *buf, *token, *inst_name;
10232 struct trace_array *tr;
10234 strscpy(dump_param, ftrace_dump_on_oops, MAX_TRACER_SIZE);
10237 while ((token = strsep(&buf, ",")) != NULL) {
10239 first_param = false;
10240 if (!strcmp("0", token))
10242 else if (!strcmp("1", token)) {
10243 ftrace_dump_one(&global_trace, DUMP_ALL);
10246 else if (!strcmp("2", token) ||
10247 !strcmp("orig_cpu", token)) {
10248 ftrace_dump_one(&global_trace, DUMP_ORIG);
10253 inst_name = strsep(&token, "=");
10254 tr = trace_array_find(inst_name);
10256 printk(KERN_TRACE "Instance %s not found\n", inst_name);
10260 if (token && (!strcmp("2", token) ||
10261 !strcmp("orig_cpu", token)))
10262 ftrace_dump_one(tr, DUMP_ORIG);
10264 ftrace_dump_one(tr, DUMP_ALL);
10268 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode)
10270 static atomic_t dump_running;
10272 /* Only allow one dump user at a time. */
10273 if (atomic_inc_return(&dump_running) != 1) {
10274 atomic_dec(&dump_running);
10278 switch (oops_dump_mode) {
10280 ftrace_dump_one(&global_trace, DUMP_ALL);
10283 ftrace_dump_one(&global_trace, DUMP_ORIG);
10286 ftrace_dump_by_param();
10291 printk(KERN_TRACE "Bad dumping mode, switching to all CPUs dump\n");
10292 ftrace_dump_one(&global_trace, DUMP_ALL);
10295 atomic_dec(&dump_running);
10297 EXPORT_SYMBOL_GPL(ftrace_dump);
10299 #define WRITE_BUFSIZE 4096
10301 ssize_t trace_parse_run_command(struct file *file, const char __user *buffer,
10302 size_t count, loff_t *ppos,
10303 int (*createfn)(const char *))
10305 char *kbuf, *buf, *tmp;
10310 kbuf = kmalloc(WRITE_BUFSIZE, GFP_KERNEL);
10314 while (done < count) {
10315 size = count - done;
10317 if (size >= WRITE_BUFSIZE)
10318 size = WRITE_BUFSIZE - 1;
10320 if (copy_from_user(kbuf, buffer + done, size)) {
10327 tmp = strchr(buf, '\n');
10330 size = tmp - buf + 1;
10332 size = strlen(buf);
10333 if (done + size < count) {
10336 /* This can accept WRITE_BUFSIZE - 2 ('\n' + '\0') */
10337 pr_warn("Line length is too long: Should be less than %d\n",
10338 WRITE_BUFSIZE - 2);
10345 /* Remove comments */
10346 tmp = strchr(buf, '#');
10351 ret = createfn(buf);
10356 } while (done < count);
10366 #ifdef CONFIG_TRACER_MAX_TRACE
10367 __init static bool tr_needs_alloc_snapshot(const char *name)
10370 int len = strlen(name);
10373 if (!boot_snapshot_index)
10376 if (strncmp(name, boot_snapshot_info, len) == 0 &&
10377 boot_snapshot_info[len] == '\t')
10380 test = kmalloc(strlen(name) + 3, GFP_KERNEL);
10384 sprintf(test, "\t%s\t", name);
10385 ret = strstr(boot_snapshot_info, test) == NULL;
10390 __init static void do_allocate_snapshot(const char *name)
10392 if (!tr_needs_alloc_snapshot(name))
10396 * When allocate_snapshot is set, the next call to
10397 * allocate_trace_buffers() (called by trace_array_get_by_name())
10398 * will allocate the snapshot buffer. That will alse clear
10401 allocate_snapshot = true;
10404 static inline void do_allocate_snapshot(const char *name) { }
10407 __init static void enable_instances(void)
10409 struct trace_array *tr;
10415 /* A tab is always appended */
10416 boot_instance_info[boot_instance_index - 1] = '\0';
10417 str = boot_instance_info;
10419 while ((curr_str = strsep(&str, "\t"))) {
10420 phys_addr_t start = 0;
10421 phys_addr_t size = 0;
10422 unsigned long addr = 0;
10423 bool traceprintk = false;
10424 bool traceoff = false;
10428 tok = strsep(&curr_str, ",");
10430 flag_delim = strchr(tok, '^');
10431 addr_delim = strchr(tok, '@');
10434 *addr_delim++ = '\0';
10437 *flag_delim++ = '\0';
10444 while ((flag = strsep(&flag_delim, "^"))) {
10445 if (strcmp(flag, "traceoff") == 0) {
10447 } else if ((strcmp(flag, "printk") == 0) ||
10448 (strcmp(flag, "traceprintk") == 0) ||
10449 (strcmp(flag, "trace_printk") == 0)) {
10450 traceprintk = true;
10452 pr_info("Tracing: Invalid instance flag '%s' for %s\n",
10459 if (tok && isdigit(*tok)) {
10460 start = memparse(tok, &tok);
10462 pr_warn("Tracing: Invalid boot instance address for %s\n",
10467 pr_warn("Tracing: No size specified for instance %s\n", name);
10471 size = memparse(tok, &tok);
10473 pr_warn("Tracing: Invalid boot instance size for %s\n",
10478 if (!reserve_mem_find_by_name(tok, &start, &size)) {
10480 pr_warn("Failed to map boot instance %s to %s\n", name, tok);
10486 addr = map_pages(start, size);
10488 pr_info("Tracing: mapped boot instance %s at physical memory %pa of size 0x%lx\n",
10489 name, &start, (unsigned long)size);
10491 pr_warn("Tracing: Failed to map boot instance %s\n", name);
10495 /* Only non mapped buffers have snapshot buffers */
10496 if (IS_ENABLED(CONFIG_TRACER_MAX_TRACE))
10497 do_allocate_snapshot(name);
10500 tr = trace_array_create_systems(name, NULL, addr, size);
10502 pr_warn("Tracing: Failed to create instance buffer %s\n", curr_str);
10507 tracer_tracing_off(tr);
10510 update_printk_trace(tr);
10513 * If start is set, then this is a mapped buffer, and
10514 * cannot be deleted by user space, so keep the reference
10518 tr->flags |= TRACE_ARRAY_FL_BOOT;
10522 while ((tok = strsep(&curr_str, ","))) {
10523 early_enable_events(tr, tok, true);
10528 __init static int tracer_alloc_buffers(void)
10534 if (security_locked_down(LOCKDOWN_TRACEFS)) {
10535 pr_warn("Tracing disabled due to lockdown\n");
10540 * Make sure we don't accidentally add more trace options
10541 * than we have bits for.
10543 BUILD_BUG_ON(TRACE_ITER_LAST_BIT > TRACE_FLAGS_MAX_SIZE);
10545 if (!alloc_cpumask_var(&tracing_buffer_mask, GFP_KERNEL))
10548 if (!alloc_cpumask_var(&global_trace.tracing_cpumask, GFP_KERNEL))
10549 goto out_free_buffer_mask;
10551 /* Only allocate trace_printk buffers if a trace_printk exists */
10552 if (&__stop___trace_bprintk_fmt != &__start___trace_bprintk_fmt)
10553 /* Must be called before global_trace.buffer is allocated */
10554 trace_printk_init_buffers();
10556 /* To save memory, keep the ring buffer size to its minimum */
10557 if (global_trace.ring_buffer_expanded)
10558 ring_buf_size = trace_buf_size;
10562 cpumask_copy(tracing_buffer_mask, cpu_possible_mask);
10563 cpumask_copy(global_trace.tracing_cpumask, cpu_all_mask);
10565 raw_spin_lock_init(&global_trace.start_lock);
10568 * The prepare callbacks allocates some memory for the ring buffer. We
10569 * don't free the buffer if the CPU goes down. If we were to free
10570 * the buffer, then the user would lose any trace that was in the
10571 * buffer. The memory will be removed once the "instance" is removed.
10573 ret = cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE,
10574 "trace/RB:prepare", trace_rb_cpu_prepare,
10577 goto out_free_cpumask;
10578 /* Used for event triggers */
10580 temp_buffer = ring_buffer_alloc(PAGE_SIZE, RB_FL_OVERWRITE);
10582 goto out_rm_hp_state;
10584 if (trace_create_savedcmd() < 0)
10585 goto out_free_temp_buffer;
10587 if (!zalloc_cpumask_var(&global_trace.pipe_cpumask, GFP_KERNEL))
10588 goto out_free_savedcmd;
10590 /* TODO: make the number of buffers hot pluggable with CPUS */
10591 if (allocate_trace_buffers(&global_trace, ring_buf_size) < 0) {
10592 MEM_FAIL(1, "tracer: failed to allocate ring buffer!\n");
10593 goto out_free_pipe_cpumask;
10595 if (global_trace.buffer_disabled)
10598 if (trace_boot_clock) {
10599 ret = tracing_set_clock(&global_trace, trace_boot_clock);
10601 pr_warn("Trace clock %s not defined, going back to default\n",
10606 * register_tracer() might reference current_trace, so it
10607 * needs to be set before we register anything. This is
10608 * just a bootstrap of current_trace anyway.
10610 global_trace.current_trace = &nop_trace;
10612 global_trace.max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
10613 #ifdef CONFIG_TRACER_MAX_TRACE
10614 spin_lock_init(&global_trace.snapshot_trigger_lock);
10616 ftrace_init_global_array_ops(&global_trace);
10618 init_trace_flags_index(&global_trace);
10620 register_tracer(&nop_trace);
10622 /* Function tracing may start here (via kernel command line) */
10623 init_function_trace();
10625 /* All seems OK, enable tracing */
10626 tracing_disabled = 0;
10628 atomic_notifier_chain_register(&panic_notifier_list,
10629 &trace_panic_notifier);
10631 register_die_notifier(&trace_die_notifier);
10633 global_trace.flags = TRACE_ARRAY_FL_GLOBAL;
10635 INIT_LIST_HEAD(&global_trace.systems);
10636 INIT_LIST_HEAD(&global_trace.events);
10637 INIT_LIST_HEAD(&global_trace.hist_vars);
10638 INIT_LIST_HEAD(&global_trace.err_log);
10639 list_add(&global_trace.list, &ftrace_trace_arrays);
10641 apply_trace_boot_options();
10643 register_snapshot_cmd();
10647 out_free_pipe_cpumask:
10648 free_cpumask_var(global_trace.pipe_cpumask);
10650 trace_free_saved_cmdlines_buffer();
10651 out_free_temp_buffer:
10652 ring_buffer_free(temp_buffer);
10654 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE);
10656 free_cpumask_var(global_trace.tracing_cpumask);
10657 out_free_buffer_mask:
10658 free_cpumask_var(tracing_buffer_mask);
10663 void __init ftrace_boot_snapshot(void)
10665 #ifdef CONFIG_TRACER_MAX_TRACE
10666 struct trace_array *tr;
10668 if (!snapshot_at_boot)
10671 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
10672 if (!tr->allocated_snapshot)
10675 tracing_snapshot_instance(tr);
10676 trace_array_puts(tr, "** Boot snapshot taken **\n");
10681 void __init early_trace_init(void)
10683 if (tracepoint_printk) {
10684 tracepoint_print_iter =
10685 kzalloc(sizeof(*tracepoint_print_iter), GFP_KERNEL);
10686 if (MEM_FAIL(!tracepoint_print_iter,
10687 "Failed to allocate trace iterator\n"))
10688 tracepoint_printk = 0;
10690 static_key_enable(&tracepoint_printk_key.key);
10692 tracer_alloc_buffers();
10697 void __init trace_init(void)
10699 trace_event_init();
10701 if (boot_instance_index)
10702 enable_instances();
10705 __init static void clear_boot_tracer(void)
10708 * The default tracer at boot buffer is an init section.
10709 * This function is called in lateinit. If we did not
10710 * find the boot tracer, then clear it out, to prevent
10711 * later registration from accessing the buffer that is
10712 * about to be freed.
10714 if (!default_bootup_tracer)
10717 printk(KERN_INFO "ftrace bootup tracer '%s' not registered.\n",
10718 default_bootup_tracer);
10719 default_bootup_tracer = NULL;
10722 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
10723 __init static void tracing_set_default_clock(void)
10725 /* sched_clock_stable() is determined in late_initcall */
10726 if (!trace_boot_clock && !sched_clock_stable()) {
10727 if (security_locked_down(LOCKDOWN_TRACEFS)) {
10728 pr_warn("Can not set tracing clock due to lockdown\n");
10732 printk(KERN_WARNING
10733 "Unstable clock detected, switching default tracing clock to \"global\"\n"
10734 "If you want to keep using the local clock, then add:\n"
10735 " \"trace_clock=local\"\n"
10736 "on the kernel command line\n");
10737 tracing_set_clock(&global_trace, "global");
10741 static inline void tracing_set_default_clock(void) { }
10744 __init static int late_trace_init(void)
10746 if (tracepoint_printk && tracepoint_printk_stop_on_boot) {
10747 static_key_disable(&tracepoint_printk_key.key);
10748 tracepoint_printk = 0;
10751 tracing_set_default_clock();
10752 clear_boot_tracer();
10756 late_initcall_sync(late_trace_init);