1 // SPDX-License-Identifier: GPL-2.0
3 * ring buffer based function tracer
5 * Copyright (C) 2007-2012 Steven Rostedt <srostedt@redhat.com>
6 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
8 * Originally taken from the RT patch by:
9 * Arnaldo Carvalho de Melo <acme@redhat.com>
11 * Based on code from the latency_tracer, that is:
12 * Copyright (C) 2004-2006 Ingo Molnar
13 * Copyright (C) 2004 Nadia Yvette Chambers
15 #include <linux/ring_buffer.h>
16 #include <generated/utsrelease.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 static 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
135 enum ftrace_dump_mode ftrace_dump_on_oops;
137 /* When set, tracing will stop when a WARN*() is hit */
138 int __disable_trace_on_warning;
140 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
141 /* Map of enums to their values, for "eval_map" file */
142 struct trace_eval_map_head {
144 unsigned long length;
147 union trace_eval_map_item;
149 struct trace_eval_map_tail {
151 * "end" is first and points to NULL as it must be different
152 * than "mod" or "eval_string"
154 union trace_eval_map_item *next;
155 const char *end; /* points to NULL */
158 static DEFINE_MUTEX(trace_eval_mutex);
161 * The trace_eval_maps are saved in an array with two extra elements,
162 * one at the beginning, and one at the end. The beginning item contains
163 * the count of the saved maps (head.length), and the module they
164 * belong to if not built in (head.mod). The ending item contains a
165 * pointer to the next array of saved eval_map items.
167 union trace_eval_map_item {
168 struct trace_eval_map map;
169 struct trace_eval_map_head head;
170 struct trace_eval_map_tail tail;
173 static union trace_eval_map_item *trace_eval_maps;
174 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
176 int tracing_set_tracer(struct trace_array *tr, const char *buf);
177 static void ftrace_trace_userstack(struct trace_array *tr,
178 struct trace_buffer *buffer,
179 unsigned int trace_ctx);
181 #define MAX_TRACER_SIZE 100
182 static char bootup_tracer_buf[MAX_TRACER_SIZE] __initdata;
183 static char *default_bootup_tracer;
185 static bool allocate_snapshot;
186 static bool snapshot_at_boot;
188 static char boot_instance_info[COMMAND_LINE_SIZE] __initdata;
189 static int boot_instance_index;
191 static char boot_snapshot_info[COMMAND_LINE_SIZE] __initdata;
192 static int boot_snapshot_index;
194 static int __init set_cmdline_ftrace(char *str)
196 strscpy(bootup_tracer_buf, str, MAX_TRACER_SIZE);
197 default_bootup_tracer = bootup_tracer_buf;
198 /* We are using ftrace early, expand it */
199 trace_set_ring_buffer_expanded(NULL);
202 __setup("ftrace=", set_cmdline_ftrace);
204 static int __init set_ftrace_dump_on_oops(char *str)
206 if (*str++ != '=' || !*str || !strcmp("1", str)) {
207 ftrace_dump_on_oops = DUMP_ALL;
211 if (!strcmp("orig_cpu", str) || !strcmp("2", str)) {
212 ftrace_dump_on_oops = DUMP_ORIG;
218 __setup("ftrace_dump_on_oops", set_ftrace_dump_on_oops);
220 static int __init stop_trace_on_warning(char *str)
222 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
223 __disable_trace_on_warning = 1;
226 __setup("traceoff_on_warning", stop_trace_on_warning);
228 static int __init boot_alloc_snapshot(char *str)
230 char *slot = boot_snapshot_info + boot_snapshot_index;
231 int left = sizeof(boot_snapshot_info) - boot_snapshot_index;
236 if (strlen(str) >= left)
239 ret = snprintf(slot, left, "%s\t", str);
240 boot_snapshot_index += ret;
242 allocate_snapshot = true;
243 /* We also need the main ring buffer expanded */
244 trace_set_ring_buffer_expanded(NULL);
248 __setup("alloc_snapshot", boot_alloc_snapshot);
251 static int __init boot_snapshot(char *str)
253 snapshot_at_boot = true;
254 boot_alloc_snapshot(str);
257 __setup("ftrace_boot_snapshot", boot_snapshot);
260 static int __init boot_instance(char *str)
262 char *slot = boot_instance_info + boot_instance_index;
263 int left = sizeof(boot_instance_info) - boot_instance_index;
266 if (strlen(str) >= left)
269 ret = snprintf(slot, left, "%s\t", str);
270 boot_instance_index += ret;
274 __setup("trace_instance=", boot_instance);
277 static char trace_boot_options_buf[MAX_TRACER_SIZE] __initdata;
279 static int __init set_trace_boot_options(char *str)
281 strscpy(trace_boot_options_buf, str, MAX_TRACER_SIZE);
284 __setup("trace_options=", set_trace_boot_options);
286 static char trace_boot_clock_buf[MAX_TRACER_SIZE] __initdata;
287 static char *trace_boot_clock __initdata;
289 static int __init set_trace_boot_clock(char *str)
291 strscpy(trace_boot_clock_buf, str, MAX_TRACER_SIZE);
292 trace_boot_clock = trace_boot_clock_buf;
295 __setup("trace_clock=", set_trace_boot_clock);
297 static int __init set_tracepoint_printk(char *str)
299 /* Ignore the "tp_printk_stop_on_boot" param */
303 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
304 tracepoint_printk = 1;
307 __setup("tp_printk", set_tracepoint_printk);
309 static int __init set_tracepoint_printk_stop(char *str)
311 tracepoint_printk_stop_on_boot = true;
314 __setup("tp_printk_stop_on_boot", set_tracepoint_printk_stop);
316 unsigned long long ns2usecs(u64 nsec)
324 trace_process_export(struct trace_export *export,
325 struct ring_buffer_event *event, int flag)
327 struct trace_entry *entry;
328 unsigned int size = 0;
330 if (export->flags & flag) {
331 entry = ring_buffer_event_data(event);
332 size = ring_buffer_event_length(event);
333 export->write(export, entry, size);
337 static DEFINE_MUTEX(ftrace_export_lock);
339 static struct trace_export __rcu *ftrace_exports_list __read_mostly;
341 static DEFINE_STATIC_KEY_FALSE(trace_function_exports_enabled);
342 static DEFINE_STATIC_KEY_FALSE(trace_event_exports_enabled);
343 static DEFINE_STATIC_KEY_FALSE(trace_marker_exports_enabled);
345 static inline void ftrace_exports_enable(struct trace_export *export)
347 if (export->flags & TRACE_EXPORT_FUNCTION)
348 static_branch_inc(&trace_function_exports_enabled);
350 if (export->flags & TRACE_EXPORT_EVENT)
351 static_branch_inc(&trace_event_exports_enabled);
353 if (export->flags & TRACE_EXPORT_MARKER)
354 static_branch_inc(&trace_marker_exports_enabled);
357 static inline void ftrace_exports_disable(struct trace_export *export)
359 if (export->flags & TRACE_EXPORT_FUNCTION)
360 static_branch_dec(&trace_function_exports_enabled);
362 if (export->flags & TRACE_EXPORT_EVENT)
363 static_branch_dec(&trace_event_exports_enabled);
365 if (export->flags & TRACE_EXPORT_MARKER)
366 static_branch_dec(&trace_marker_exports_enabled);
369 static void ftrace_exports(struct ring_buffer_event *event, int flag)
371 struct trace_export *export;
373 preempt_disable_notrace();
375 export = rcu_dereference_raw_check(ftrace_exports_list);
377 trace_process_export(export, event, flag);
378 export = rcu_dereference_raw_check(export->next);
381 preempt_enable_notrace();
385 add_trace_export(struct trace_export **list, struct trace_export *export)
387 rcu_assign_pointer(export->next, *list);
389 * We are entering export into the list but another
390 * CPU might be walking that list. We need to make sure
391 * the export->next pointer is valid before another CPU sees
392 * the export pointer included into the list.
394 rcu_assign_pointer(*list, export);
398 rm_trace_export(struct trace_export **list, struct trace_export *export)
400 struct trace_export **p;
402 for (p = list; *p != NULL; p = &(*p)->next)
409 rcu_assign_pointer(*p, (*p)->next);
415 add_ftrace_export(struct trace_export **list, struct trace_export *export)
417 ftrace_exports_enable(export);
419 add_trace_export(list, export);
423 rm_ftrace_export(struct trace_export **list, struct trace_export *export)
427 ret = rm_trace_export(list, export);
428 ftrace_exports_disable(export);
433 int register_ftrace_export(struct trace_export *export)
435 if (WARN_ON_ONCE(!export->write))
438 mutex_lock(&ftrace_export_lock);
440 add_ftrace_export(&ftrace_exports_list, export);
442 mutex_unlock(&ftrace_export_lock);
446 EXPORT_SYMBOL_GPL(register_ftrace_export);
448 int unregister_ftrace_export(struct trace_export *export)
452 mutex_lock(&ftrace_export_lock);
454 ret = rm_ftrace_export(&ftrace_exports_list, export);
456 mutex_unlock(&ftrace_export_lock);
460 EXPORT_SYMBOL_GPL(unregister_ftrace_export);
462 /* trace_flags holds trace_options default values */
463 #define TRACE_DEFAULT_FLAGS \
464 (FUNCTION_DEFAULT_FLAGS | \
465 TRACE_ITER_PRINT_PARENT | TRACE_ITER_PRINTK | \
466 TRACE_ITER_ANNOTATE | TRACE_ITER_CONTEXT_INFO | \
467 TRACE_ITER_RECORD_CMD | TRACE_ITER_OVERWRITE | \
468 TRACE_ITER_IRQ_INFO | TRACE_ITER_MARKERS | \
471 /* trace_options that are only supported by global_trace */
472 #define TOP_LEVEL_TRACE_FLAGS (TRACE_ITER_PRINTK | \
473 TRACE_ITER_PRINTK_MSGONLY | TRACE_ITER_RECORD_CMD)
475 /* trace_flags that are default zero for instances */
476 #define ZEROED_TRACE_FLAGS \
477 (TRACE_ITER_EVENT_FORK | TRACE_ITER_FUNC_FORK)
480 * The global_trace is the descriptor that holds the top-level tracing
481 * buffers for the live tracing.
483 static struct trace_array global_trace = {
484 .trace_flags = TRACE_DEFAULT_FLAGS,
487 void trace_set_ring_buffer_expanded(struct trace_array *tr)
491 tr->ring_buffer_expanded = true;
494 LIST_HEAD(ftrace_trace_arrays);
496 int trace_array_get(struct trace_array *this_tr)
498 struct trace_array *tr;
501 mutex_lock(&trace_types_lock);
502 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
509 mutex_unlock(&trace_types_lock);
514 static void __trace_array_put(struct trace_array *this_tr)
516 WARN_ON(!this_tr->ref);
521 * trace_array_put - Decrement the reference counter for this trace array.
522 * @this_tr : pointer to the trace array
524 * NOTE: Use this when we no longer need the trace array returned by
525 * trace_array_get_by_name(). This ensures the trace array can be later
529 void trace_array_put(struct trace_array *this_tr)
534 mutex_lock(&trace_types_lock);
535 __trace_array_put(this_tr);
536 mutex_unlock(&trace_types_lock);
538 EXPORT_SYMBOL_GPL(trace_array_put);
540 int tracing_check_open_get_tr(struct trace_array *tr)
544 ret = security_locked_down(LOCKDOWN_TRACEFS);
548 if (tracing_disabled)
551 if (tr && trace_array_get(tr) < 0)
557 int call_filter_check_discard(struct trace_event_call *call, void *rec,
558 struct trace_buffer *buffer,
559 struct ring_buffer_event *event)
561 if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
562 !filter_match_preds(call->filter, rec)) {
563 __trace_event_discard_commit(buffer, event);
571 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
572 * @filtered_pids: The list of pids to check
573 * @search_pid: The PID to find in @filtered_pids
575 * Returns true if @search_pid is found in @filtered_pids, and false otherwise.
578 trace_find_filtered_pid(struct trace_pid_list *filtered_pids, pid_t search_pid)
580 return trace_pid_list_is_set(filtered_pids, search_pid);
584 * trace_ignore_this_task - should a task be ignored for tracing
585 * @filtered_pids: The list of pids to check
586 * @filtered_no_pids: The list of pids not to be traced
587 * @task: The task that should be ignored if not filtered
589 * Checks if @task should be traced or not from @filtered_pids.
590 * Returns true if @task should *NOT* be traced.
591 * Returns false if @task should be traced.
594 trace_ignore_this_task(struct trace_pid_list *filtered_pids,
595 struct trace_pid_list *filtered_no_pids,
596 struct task_struct *task)
599 * If filtered_no_pids is not empty, and the task's pid is listed
600 * in filtered_no_pids, then return true.
601 * Otherwise, if filtered_pids is empty, that means we can
602 * trace all tasks. If it has content, then only trace pids
603 * within filtered_pids.
606 return (filtered_pids &&
607 !trace_find_filtered_pid(filtered_pids, task->pid)) ||
609 trace_find_filtered_pid(filtered_no_pids, task->pid));
613 * trace_filter_add_remove_task - Add or remove a task from a pid_list
614 * @pid_list: The list to modify
615 * @self: The current task for fork or NULL for exit
616 * @task: The task to add or remove
618 * If adding a task, if @self is defined, the task is only added if @self
619 * is also included in @pid_list. This happens on fork and tasks should
620 * only be added when the parent is listed. If @self is NULL, then the
621 * @task pid will be removed from the list, which would happen on exit
624 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
625 struct task_struct *self,
626 struct task_struct *task)
631 /* For forks, we only add if the forking task is listed */
633 if (!trace_find_filtered_pid(pid_list, self->pid))
637 /* "self" is set for forks, and NULL for exits */
639 trace_pid_list_set(pid_list, task->pid);
641 trace_pid_list_clear(pid_list, task->pid);
645 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
646 * @pid_list: The pid list to show
647 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
648 * @pos: The position of the file
650 * This is used by the seq_file "next" operation to iterate the pids
651 * listed in a trace_pid_list structure.
653 * Returns the pid+1 as we want to display pid of zero, but NULL would
654 * stop the iteration.
656 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos)
658 long pid = (unsigned long)v;
663 /* pid already is +1 of the actual previous bit */
664 if (trace_pid_list_next(pid_list, pid, &next) < 0)
669 /* Return pid + 1 to allow zero to be represented */
670 return (void *)(pid + 1);
674 * trace_pid_start - Used for seq_file to start reading pid lists
675 * @pid_list: The pid list to show
676 * @pos: The position of the file
678 * This is used by seq_file "start" operation to start the iteration
681 * Returns the pid+1 as we want to display pid of zero, but NULL would
682 * stop the iteration.
684 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos)
690 if (trace_pid_list_first(pid_list, &first) < 0)
695 /* Return pid + 1 so that zero can be the exit value */
696 for (pid++; pid && l < *pos;
697 pid = (unsigned long)trace_pid_next(pid_list, (void *)pid, &l))
703 * trace_pid_show - show the current pid in seq_file processing
704 * @m: The seq_file structure to write into
705 * @v: A void pointer of the pid (+1) value to display
707 * Can be directly used by seq_file operations to display the current
710 int trace_pid_show(struct seq_file *m, void *v)
712 unsigned long pid = (unsigned long)v - 1;
714 seq_printf(m, "%lu\n", pid);
718 /* 128 should be much more than enough */
719 #define PID_BUF_SIZE 127
721 int trace_pid_write(struct trace_pid_list *filtered_pids,
722 struct trace_pid_list **new_pid_list,
723 const char __user *ubuf, size_t cnt)
725 struct trace_pid_list *pid_list;
726 struct trace_parser parser;
734 if (trace_parser_get_init(&parser, PID_BUF_SIZE + 1))
738 * Always recreate a new array. The write is an all or nothing
739 * operation. Always create a new array when adding new pids by
740 * the user. If the operation fails, then the current list is
743 pid_list = trace_pid_list_alloc();
745 trace_parser_put(&parser);
750 /* copy the current bits to the new max */
751 ret = trace_pid_list_first(filtered_pids, &pid);
753 trace_pid_list_set(pid_list, pid);
754 ret = trace_pid_list_next(filtered_pids, pid + 1, &pid);
764 ret = trace_get_user(&parser, ubuf, cnt, &pos);
772 if (!trace_parser_loaded(&parser))
776 if (kstrtoul(parser.buffer, 0, &val))
781 if (trace_pid_list_set(pid_list, pid) < 0) {
787 trace_parser_clear(&parser);
790 trace_parser_put(&parser);
793 trace_pid_list_free(pid_list);
798 /* Cleared the list of pids */
799 trace_pid_list_free(pid_list);
803 *new_pid_list = pid_list;
808 static u64 buffer_ftrace_now(struct array_buffer *buf, int cpu)
812 /* Early boot up does not have a buffer yet */
814 return trace_clock_local();
816 ts = ring_buffer_time_stamp(buf->buffer);
817 ring_buffer_normalize_time_stamp(buf->buffer, cpu, &ts);
822 u64 ftrace_now(int cpu)
824 return buffer_ftrace_now(&global_trace.array_buffer, cpu);
828 * tracing_is_enabled - Show if global_trace has been enabled
830 * Shows if the global trace has been enabled or not. It uses the
831 * mirror flag "buffer_disabled" to be used in fast paths such as for
832 * the irqsoff tracer. But it may be inaccurate due to races. If you
833 * need to know the accurate state, use tracing_is_on() which is a little
834 * slower, but accurate.
836 int tracing_is_enabled(void)
839 * For quick access (irqsoff uses this in fast path), just
840 * return the mirror variable of the state of the ring buffer.
841 * It's a little racy, but we don't really care.
844 return !global_trace.buffer_disabled;
848 * trace_buf_size is the size in bytes that is allocated
849 * for a buffer. Note, the number of bytes is always rounded
852 * This number is purposely set to a low number of 16384.
853 * If the dump on oops happens, it will be much appreciated
854 * to not have to wait for all that output. Anyway this can be
855 * boot time and run time configurable.
857 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
859 static unsigned long trace_buf_size = TRACE_BUF_SIZE_DEFAULT;
861 /* trace_types holds a link list of available tracers. */
862 static struct tracer *trace_types __read_mostly;
865 * trace_types_lock is used to protect the trace_types list.
867 DEFINE_MUTEX(trace_types_lock);
870 * serialize the access of the ring buffer
872 * ring buffer serializes readers, but it is low level protection.
873 * The validity of the events (which returns by ring_buffer_peek() ..etc)
874 * are not protected by ring buffer.
876 * The content of events may become garbage if we allow other process consumes
877 * these events concurrently:
878 * A) the page of the consumed events may become a normal page
879 * (not reader page) in ring buffer, and this page will be rewritten
880 * by events producer.
881 * B) The page of the consumed events may become a page for splice_read,
882 * and this page will be returned to system.
884 * These primitives allow multi process access to different cpu ring buffer
887 * These primitives don't distinguish read-only and read-consume access.
888 * Multi read-only access are also serialized.
892 static DECLARE_RWSEM(all_cpu_access_lock);
893 static DEFINE_PER_CPU(struct mutex, cpu_access_lock);
895 static inline void trace_access_lock(int cpu)
897 if (cpu == RING_BUFFER_ALL_CPUS) {
898 /* gain it for accessing the whole ring buffer. */
899 down_write(&all_cpu_access_lock);
901 /* gain it for accessing a cpu ring buffer. */
903 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
904 down_read(&all_cpu_access_lock);
906 /* Secondly block other access to this @cpu ring buffer. */
907 mutex_lock(&per_cpu(cpu_access_lock, cpu));
911 static inline void trace_access_unlock(int cpu)
913 if (cpu == RING_BUFFER_ALL_CPUS) {
914 up_write(&all_cpu_access_lock);
916 mutex_unlock(&per_cpu(cpu_access_lock, cpu));
917 up_read(&all_cpu_access_lock);
921 static inline void trace_access_lock_init(void)
925 for_each_possible_cpu(cpu)
926 mutex_init(&per_cpu(cpu_access_lock, cpu));
931 static DEFINE_MUTEX(access_lock);
933 static inline void trace_access_lock(int cpu)
936 mutex_lock(&access_lock);
939 static inline void trace_access_unlock(int cpu)
942 mutex_unlock(&access_lock);
945 static inline void trace_access_lock_init(void)
951 #ifdef CONFIG_STACKTRACE
952 static void __ftrace_trace_stack(struct trace_buffer *buffer,
953 unsigned int trace_ctx,
954 int skip, struct pt_regs *regs);
955 static inline void ftrace_trace_stack(struct trace_array *tr,
956 struct trace_buffer *buffer,
957 unsigned int trace_ctx,
958 int skip, struct pt_regs *regs);
961 static inline void __ftrace_trace_stack(struct trace_buffer *buffer,
962 unsigned int trace_ctx,
963 int skip, struct pt_regs *regs)
966 static inline void ftrace_trace_stack(struct trace_array *tr,
967 struct trace_buffer *buffer,
968 unsigned long trace_ctx,
969 int skip, struct pt_regs *regs)
975 static __always_inline void
976 trace_event_setup(struct ring_buffer_event *event,
977 int type, unsigned int trace_ctx)
979 struct trace_entry *ent = ring_buffer_event_data(event);
981 tracing_generic_entry_update(ent, type, trace_ctx);
984 static __always_inline struct ring_buffer_event *
985 __trace_buffer_lock_reserve(struct trace_buffer *buffer,
988 unsigned int trace_ctx)
990 struct ring_buffer_event *event;
992 event = ring_buffer_lock_reserve(buffer, len);
994 trace_event_setup(event, type, trace_ctx);
999 void tracer_tracing_on(struct trace_array *tr)
1001 if (tr->array_buffer.buffer)
1002 ring_buffer_record_on(tr->array_buffer.buffer);
1004 * This flag is looked at when buffers haven't been allocated
1005 * yet, or by some tracers (like irqsoff), that just want to
1006 * know if the ring buffer has been disabled, but it can handle
1007 * races of where it gets disabled but we still do a record.
1008 * As the check is in the fast path of the tracers, it is more
1009 * important to be fast than accurate.
1011 tr->buffer_disabled = 0;
1012 /* Make the flag seen by readers */
1017 * tracing_on - enable tracing buffers
1019 * This function enables tracing buffers that may have been
1020 * disabled with tracing_off.
1022 void tracing_on(void)
1024 tracer_tracing_on(&global_trace);
1026 EXPORT_SYMBOL_GPL(tracing_on);
1029 static __always_inline void
1030 __buffer_unlock_commit(struct trace_buffer *buffer, struct ring_buffer_event *event)
1032 __this_cpu_write(trace_taskinfo_save, true);
1034 /* If this is the temp buffer, we need to commit fully */
1035 if (this_cpu_read(trace_buffered_event) == event) {
1036 /* Length is in event->array[0] */
1037 ring_buffer_write(buffer, event->array[0], &event->array[1]);
1038 /* Release the temp buffer */
1039 this_cpu_dec(trace_buffered_event_cnt);
1040 /* ring_buffer_unlock_commit() enables preemption */
1041 preempt_enable_notrace();
1043 ring_buffer_unlock_commit(buffer);
1046 int __trace_array_puts(struct trace_array *tr, unsigned long ip,
1047 const char *str, int size)
1049 struct ring_buffer_event *event;
1050 struct trace_buffer *buffer;
1051 struct print_entry *entry;
1052 unsigned int trace_ctx;
1055 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
1058 if (unlikely(tracing_selftest_running && tr == &global_trace))
1061 if (unlikely(tracing_disabled))
1064 alloc = sizeof(*entry) + size + 2; /* possible \n added */
1066 trace_ctx = tracing_gen_ctx();
1067 buffer = tr->array_buffer.buffer;
1068 ring_buffer_nest_start(buffer);
1069 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, alloc,
1076 entry = ring_buffer_event_data(event);
1079 memcpy(&entry->buf, str, size);
1081 /* Add a newline if necessary */
1082 if (entry->buf[size - 1] != '\n') {
1083 entry->buf[size] = '\n';
1084 entry->buf[size + 1] = '\0';
1086 entry->buf[size] = '\0';
1088 __buffer_unlock_commit(buffer, event);
1089 ftrace_trace_stack(tr, buffer, trace_ctx, 4, NULL);
1091 ring_buffer_nest_end(buffer);
1094 EXPORT_SYMBOL_GPL(__trace_array_puts);
1097 * __trace_puts - write a constant string into the trace buffer.
1098 * @ip: The address of the caller
1099 * @str: The constant string to write
1100 * @size: The size of the string.
1102 int __trace_puts(unsigned long ip, const char *str, int size)
1104 return __trace_array_puts(&global_trace, ip, str, size);
1106 EXPORT_SYMBOL_GPL(__trace_puts);
1109 * __trace_bputs - write the pointer to a constant string into trace buffer
1110 * @ip: The address of the caller
1111 * @str: The constant string to write to the buffer to
1113 int __trace_bputs(unsigned long ip, const char *str)
1115 struct ring_buffer_event *event;
1116 struct trace_buffer *buffer;
1117 struct bputs_entry *entry;
1118 unsigned int trace_ctx;
1119 int size = sizeof(struct bputs_entry);
1122 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
1125 if (unlikely(tracing_selftest_running || tracing_disabled))
1128 trace_ctx = tracing_gen_ctx();
1129 buffer = global_trace.array_buffer.buffer;
1131 ring_buffer_nest_start(buffer);
1132 event = __trace_buffer_lock_reserve(buffer, TRACE_BPUTS, size,
1137 entry = ring_buffer_event_data(event);
1141 __buffer_unlock_commit(buffer, event);
1142 ftrace_trace_stack(&global_trace, buffer, trace_ctx, 4, NULL);
1146 ring_buffer_nest_end(buffer);
1149 EXPORT_SYMBOL_GPL(__trace_bputs);
1151 #ifdef CONFIG_TRACER_SNAPSHOT
1152 static void tracing_snapshot_instance_cond(struct trace_array *tr,
1155 struct tracer *tracer = tr->current_trace;
1156 unsigned long flags;
1159 trace_array_puts(tr, "*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
1160 trace_array_puts(tr, "*** snapshot is being ignored ***\n");
1164 if (!tr->allocated_snapshot) {
1165 trace_array_puts(tr, "*** SNAPSHOT NOT ALLOCATED ***\n");
1166 trace_array_puts(tr, "*** stopping trace here! ***\n");
1167 tracer_tracing_off(tr);
1171 /* Note, snapshot can not be used when the tracer uses it */
1172 if (tracer->use_max_tr) {
1173 trace_array_puts(tr, "*** LATENCY TRACER ACTIVE ***\n");
1174 trace_array_puts(tr, "*** Can not use snapshot (sorry) ***\n");
1178 local_irq_save(flags);
1179 update_max_tr(tr, current, smp_processor_id(), cond_data);
1180 local_irq_restore(flags);
1183 void tracing_snapshot_instance(struct trace_array *tr)
1185 tracing_snapshot_instance_cond(tr, NULL);
1189 * tracing_snapshot - take a snapshot of the current buffer.
1191 * This causes a swap between the snapshot buffer and the current live
1192 * tracing buffer. You can use this to take snapshots of the live
1193 * trace when some condition is triggered, but continue to trace.
1195 * Note, make sure to allocate the snapshot with either
1196 * a tracing_snapshot_alloc(), or by doing it manually
1197 * with: echo 1 > /sys/kernel/tracing/snapshot
1199 * If the snapshot buffer is not allocated, it will stop tracing.
1200 * Basically making a permanent snapshot.
1202 void tracing_snapshot(void)
1204 struct trace_array *tr = &global_trace;
1206 tracing_snapshot_instance(tr);
1208 EXPORT_SYMBOL_GPL(tracing_snapshot);
1211 * tracing_snapshot_cond - conditionally take a snapshot of the current buffer.
1212 * @tr: The tracing instance to snapshot
1213 * @cond_data: The data to be tested conditionally, and possibly saved
1215 * This is the same as tracing_snapshot() except that the snapshot is
1216 * conditional - the snapshot will only happen if the
1217 * cond_snapshot.update() implementation receiving the cond_data
1218 * returns true, which means that the trace array's cond_snapshot
1219 * update() operation used the cond_data to determine whether the
1220 * snapshot should be taken, and if it was, presumably saved it along
1221 * with the snapshot.
1223 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1225 tracing_snapshot_instance_cond(tr, cond_data);
1227 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1230 * tracing_cond_snapshot_data - get the user data associated with a snapshot
1231 * @tr: The tracing instance
1233 * When the user enables a conditional snapshot using
1234 * tracing_snapshot_cond_enable(), the user-defined cond_data is saved
1235 * with the snapshot. This accessor is used to retrieve it.
1237 * Should not be called from cond_snapshot.update(), since it takes
1238 * the tr->max_lock lock, which the code calling
1239 * cond_snapshot.update() has already done.
1241 * Returns the cond_data associated with the trace array's snapshot.
1243 void *tracing_cond_snapshot_data(struct trace_array *tr)
1245 void *cond_data = NULL;
1247 local_irq_disable();
1248 arch_spin_lock(&tr->max_lock);
1250 if (tr->cond_snapshot)
1251 cond_data = tr->cond_snapshot->cond_data;
1253 arch_spin_unlock(&tr->max_lock);
1258 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1260 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
1261 struct array_buffer *size_buf, int cpu_id);
1262 static void set_buffer_entries(struct array_buffer *buf, unsigned long val);
1264 int tracing_alloc_snapshot_instance(struct trace_array *tr)
1268 if (!tr->allocated_snapshot) {
1270 /* allocate spare buffer */
1271 ret = resize_buffer_duplicate_size(&tr->max_buffer,
1272 &tr->array_buffer, RING_BUFFER_ALL_CPUS);
1276 tr->allocated_snapshot = true;
1282 static void free_snapshot(struct trace_array *tr)
1285 * We don't free the ring buffer. instead, resize it because
1286 * The max_tr ring buffer has some state (e.g. ring->clock) and
1287 * we want preserve it.
1289 ring_buffer_resize(tr->max_buffer.buffer, 1, RING_BUFFER_ALL_CPUS);
1290 set_buffer_entries(&tr->max_buffer, 1);
1291 tracing_reset_online_cpus(&tr->max_buffer);
1292 tr->allocated_snapshot = false;
1296 * tracing_alloc_snapshot - allocate snapshot buffer.
1298 * This only allocates the snapshot buffer if it isn't already
1299 * allocated - it doesn't also take a snapshot.
1301 * This is meant to be used in cases where the snapshot buffer needs
1302 * to be set up for events that can't sleep but need to be able to
1303 * trigger a snapshot.
1305 int tracing_alloc_snapshot(void)
1307 struct trace_array *tr = &global_trace;
1310 ret = tracing_alloc_snapshot_instance(tr);
1315 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1318 * tracing_snapshot_alloc - allocate and take a snapshot of the current buffer.
1320 * This is similar to tracing_snapshot(), but it will allocate the
1321 * snapshot buffer if it isn't already allocated. Use this only
1322 * where it is safe to sleep, as the allocation may sleep.
1324 * This causes a swap between the snapshot buffer and the current live
1325 * tracing buffer. You can use this to take snapshots of the live
1326 * trace when some condition is triggered, but continue to trace.
1328 void tracing_snapshot_alloc(void)
1332 ret = tracing_alloc_snapshot();
1338 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1341 * tracing_snapshot_cond_enable - enable conditional snapshot for an instance
1342 * @tr: The tracing instance
1343 * @cond_data: User data to associate with the snapshot
1344 * @update: Implementation of the cond_snapshot update function
1346 * Check whether the conditional snapshot for the given instance has
1347 * already been enabled, or if the current tracer is already using a
1348 * snapshot; if so, return -EBUSY, else create a cond_snapshot and
1349 * save the cond_data and update function inside.
1351 * Returns 0 if successful, error otherwise.
1353 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data,
1354 cond_update_fn_t update)
1356 struct cond_snapshot *cond_snapshot;
1359 cond_snapshot = kzalloc(sizeof(*cond_snapshot), GFP_KERNEL);
1363 cond_snapshot->cond_data = cond_data;
1364 cond_snapshot->update = update;
1366 mutex_lock(&trace_types_lock);
1368 ret = tracing_alloc_snapshot_instance(tr);
1372 if (tr->current_trace->use_max_tr) {
1378 * The cond_snapshot can only change to NULL without the
1379 * trace_types_lock. We don't care if we race with it going
1380 * to NULL, but we want to make sure that it's not set to
1381 * something other than NULL when we get here, which we can
1382 * do safely with only holding the trace_types_lock and not
1383 * having to take the max_lock.
1385 if (tr->cond_snapshot) {
1390 local_irq_disable();
1391 arch_spin_lock(&tr->max_lock);
1392 tr->cond_snapshot = cond_snapshot;
1393 arch_spin_unlock(&tr->max_lock);
1396 mutex_unlock(&trace_types_lock);
1401 mutex_unlock(&trace_types_lock);
1402 kfree(cond_snapshot);
1405 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1408 * tracing_snapshot_cond_disable - disable conditional snapshot for an instance
1409 * @tr: The tracing instance
1411 * Check whether the conditional snapshot for the given instance is
1412 * enabled; if so, free the cond_snapshot associated with it,
1413 * otherwise return -EINVAL.
1415 * Returns 0 if successful, error otherwise.
1417 int tracing_snapshot_cond_disable(struct trace_array *tr)
1421 local_irq_disable();
1422 arch_spin_lock(&tr->max_lock);
1424 if (!tr->cond_snapshot)
1427 kfree(tr->cond_snapshot);
1428 tr->cond_snapshot = NULL;
1431 arch_spin_unlock(&tr->max_lock);
1436 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1438 void tracing_snapshot(void)
1440 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1442 EXPORT_SYMBOL_GPL(tracing_snapshot);
1443 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1445 WARN_ONCE(1, "Snapshot feature not enabled, but internal conditional snapshot used");
1447 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1448 int tracing_alloc_snapshot(void)
1450 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1453 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1454 void tracing_snapshot_alloc(void)
1459 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1460 void *tracing_cond_snapshot_data(struct trace_array *tr)
1464 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1465 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update)
1469 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1470 int tracing_snapshot_cond_disable(struct trace_array *tr)
1474 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1475 #define free_snapshot(tr) do { } while (0)
1476 #endif /* CONFIG_TRACER_SNAPSHOT */
1478 void tracer_tracing_off(struct trace_array *tr)
1480 if (tr->array_buffer.buffer)
1481 ring_buffer_record_off(tr->array_buffer.buffer);
1483 * This flag is looked at when buffers haven't been allocated
1484 * yet, or by some tracers (like irqsoff), that just want to
1485 * know if the ring buffer has been disabled, but it can handle
1486 * races of where it gets disabled but we still do a record.
1487 * As the check is in the fast path of the tracers, it is more
1488 * important to be fast than accurate.
1490 tr->buffer_disabled = 1;
1491 /* Make the flag seen by readers */
1496 * tracing_off - turn off tracing buffers
1498 * This function stops the tracing buffers from recording data.
1499 * It does not disable any overhead the tracers themselves may
1500 * be causing. This function simply causes all recording to
1501 * the ring buffers to fail.
1503 void tracing_off(void)
1505 tracer_tracing_off(&global_trace);
1507 EXPORT_SYMBOL_GPL(tracing_off);
1509 void disable_trace_on_warning(void)
1511 if (__disable_trace_on_warning) {
1512 trace_array_printk_buf(global_trace.array_buffer.buffer, _THIS_IP_,
1513 "Disabling tracing due to warning\n");
1519 * tracer_tracing_is_on - show real state of ring buffer enabled
1520 * @tr : the trace array to know if ring buffer is enabled
1522 * Shows real state of the ring buffer if it is enabled or not.
1524 bool tracer_tracing_is_on(struct trace_array *tr)
1526 if (tr->array_buffer.buffer)
1527 return ring_buffer_record_is_on(tr->array_buffer.buffer);
1528 return !tr->buffer_disabled;
1532 * tracing_is_on - show state of ring buffers enabled
1534 int tracing_is_on(void)
1536 return tracer_tracing_is_on(&global_trace);
1538 EXPORT_SYMBOL_GPL(tracing_is_on);
1540 static int __init set_buf_size(char *str)
1542 unsigned long buf_size;
1546 buf_size = memparse(str, &str);
1548 * nr_entries can not be zero and the startup
1549 * tests require some buffer space. Therefore
1550 * ensure we have at least 4096 bytes of buffer.
1552 trace_buf_size = max(4096UL, buf_size);
1555 __setup("trace_buf_size=", set_buf_size);
1557 static int __init set_tracing_thresh(char *str)
1559 unsigned long threshold;
1564 ret = kstrtoul(str, 0, &threshold);
1567 tracing_thresh = threshold * 1000;
1570 __setup("tracing_thresh=", set_tracing_thresh);
1572 unsigned long nsecs_to_usecs(unsigned long nsecs)
1574 return nsecs / 1000;
1578 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1579 * It uses C(a, b) where 'a' is the eval (enum) name and 'b' is the string that
1580 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1581 * of strings in the order that the evals (enum) were defined.
1586 /* These must match the bit positions in trace_iterator_flags */
1587 static const char *trace_options[] = {
1595 int in_ns; /* is this clock in nanoseconds? */
1596 } trace_clocks[] = {
1597 { trace_clock_local, "local", 1 },
1598 { trace_clock_global, "global", 1 },
1599 { trace_clock_counter, "counter", 0 },
1600 { trace_clock_jiffies, "uptime", 0 },
1601 { trace_clock, "perf", 1 },
1602 { ktime_get_mono_fast_ns, "mono", 1 },
1603 { ktime_get_raw_fast_ns, "mono_raw", 1 },
1604 { ktime_get_boot_fast_ns, "boot", 1 },
1605 { ktime_get_tai_fast_ns, "tai", 1 },
1609 bool trace_clock_in_ns(struct trace_array *tr)
1611 if (trace_clocks[tr->clock_id].in_ns)
1618 * trace_parser_get_init - gets the buffer for trace parser
1620 int trace_parser_get_init(struct trace_parser *parser, int size)
1622 memset(parser, 0, sizeof(*parser));
1624 parser->buffer = kmalloc(size, GFP_KERNEL);
1625 if (!parser->buffer)
1628 parser->size = size;
1633 * trace_parser_put - frees the buffer for trace parser
1635 void trace_parser_put(struct trace_parser *parser)
1637 kfree(parser->buffer);
1638 parser->buffer = NULL;
1642 * trace_get_user - reads the user input string separated by space
1643 * (matched by isspace(ch))
1645 * For each string found the 'struct trace_parser' is updated,
1646 * and the function returns.
1648 * Returns number of bytes read.
1650 * See kernel/trace/trace.h for 'struct trace_parser' details.
1652 int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1653 size_t cnt, loff_t *ppos)
1660 trace_parser_clear(parser);
1662 ret = get_user(ch, ubuf++);
1670 * The parser is not finished with the last write,
1671 * continue reading the user input without skipping spaces.
1673 if (!parser->cont) {
1674 /* skip white space */
1675 while (cnt && isspace(ch)) {
1676 ret = get_user(ch, ubuf++);
1685 /* only spaces were written */
1686 if (isspace(ch) || !ch) {
1693 /* read the non-space input */
1694 while (cnt && !isspace(ch) && ch) {
1695 if (parser->idx < parser->size - 1)
1696 parser->buffer[parser->idx++] = ch;
1701 ret = get_user(ch, ubuf++);
1708 /* We either got finished input or we have to wait for another call. */
1709 if (isspace(ch) || !ch) {
1710 parser->buffer[parser->idx] = 0;
1711 parser->cont = false;
1712 } else if (parser->idx < parser->size - 1) {
1713 parser->cont = true;
1714 parser->buffer[parser->idx++] = ch;
1715 /* Make sure the parsed string always terminates with '\0'. */
1716 parser->buffer[parser->idx] = 0;
1729 /* TODO add a seq_buf_to_buffer() */
1730 static ssize_t trace_seq_to_buffer(struct trace_seq *s, void *buf, size_t cnt)
1734 if (trace_seq_used(s) <= s->readpos)
1737 len = trace_seq_used(s) - s->readpos;
1740 memcpy(buf, s->buffer + s->readpos, cnt);
1746 unsigned long __read_mostly tracing_thresh;
1748 #ifdef CONFIG_TRACER_MAX_TRACE
1749 static const struct file_operations tracing_max_lat_fops;
1751 #ifdef LATENCY_FS_NOTIFY
1753 static struct workqueue_struct *fsnotify_wq;
1755 static void latency_fsnotify_workfn(struct work_struct *work)
1757 struct trace_array *tr = container_of(work, struct trace_array,
1759 fsnotify_inode(tr->d_max_latency->d_inode, FS_MODIFY);
1762 static void latency_fsnotify_workfn_irq(struct irq_work *iwork)
1764 struct trace_array *tr = container_of(iwork, struct trace_array,
1766 queue_work(fsnotify_wq, &tr->fsnotify_work);
1769 static void trace_create_maxlat_file(struct trace_array *tr,
1770 struct dentry *d_tracer)
1772 INIT_WORK(&tr->fsnotify_work, latency_fsnotify_workfn);
1773 init_irq_work(&tr->fsnotify_irqwork, latency_fsnotify_workfn_irq);
1774 tr->d_max_latency = trace_create_file("tracing_max_latency",
1777 &tracing_max_lat_fops);
1780 __init static int latency_fsnotify_init(void)
1782 fsnotify_wq = alloc_workqueue("tr_max_lat_wq",
1783 WQ_UNBOUND | WQ_HIGHPRI, 0);
1785 pr_err("Unable to allocate tr_max_lat_wq\n");
1791 late_initcall_sync(latency_fsnotify_init);
1793 void latency_fsnotify(struct trace_array *tr)
1798 * We cannot call queue_work(&tr->fsnotify_work) from here because it's
1799 * possible that we are called from __schedule() or do_idle(), which
1800 * could cause a deadlock.
1802 irq_work_queue(&tr->fsnotify_irqwork);
1805 #else /* !LATENCY_FS_NOTIFY */
1807 #define trace_create_maxlat_file(tr, d_tracer) \
1808 trace_create_file("tracing_max_latency", TRACE_MODE_WRITE, \
1809 d_tracer, tr, &tracing_max_lat_fops)
1814 * Copy the new maximum trace into the separate maximum-trace
1815 * structure. (this way the maximum trace is permanently saved,
1816 * for later retrieval via /sys/kernel/tracing/tracing_max_latency)
1819 __update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)
1821 struct array_buffer *trace_buf = &tr->array_buffer;
1822 struct array_buffer *max_buf = &tr->max_buffer;
1823 struct trace_array_cpu *data = per_cpu_ptr(trace_buf->data, cpu);
1824 struct trace_array_cpu *max_data = per_cpu_ptr(max_buf->data, cpu);
1827 max_buf->time_start = data->preempt_timestamp;
1829 max_data->saved_latency = tr->max_latency;
1830 max_data->critical_start = data->critical_start;
1831 max_data->critical_end = data->critical_end;
1833 strncpy(max_data->comm, tsk->comm, TASK_COMM_LEN);
1834 max_data->pid = tsk->pid;
1836 * If tsk == current, then use current_uid(), as that does not use
1837 * RCU. The irq tracer can be called out of RCU scope.
1840 max_data->uid = current_uid();
1842 max_data->uid = task_uid(tsk);
1844 max_data->nice = tsk->static_prio - 20 - MAX_RT_PRIO;
1845 max_data->policy = tsk->policy;
1846 max_data->rt_priority = tsk->rt_priority;
1848 /* record this tasks comm */
1849 tracing_record_cmdline(tsk);
1850 latency_fsnotify(tr);
1854 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1856 * @tsk: the task with the latency
1857 * @cpu: The cpu that initiated the trace.
1858 * @cond_data: User data associated with a conditional snapshot
1860 * Flip the buffers between the @tr and the max_tr and record information
1861 * about which task was the cause of this latency.
1864 update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
1870 WARN_ON_ONCE(!irqs_disabled());
1872 if (!tr->allocated_snapshot) {
1873 /* Only the nop tracer should hit this when disabling */
1874 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1878 arch_spin_lock(&tr->max_lock);
1880 /* Inherit the recordable setting from array_buffer */
1881 if (ring_buffer_record_is_set_on(tr->array_buffer.buffer))
1882 ring_buffer_record_on(tr->max_buffer.buffer);
1884 ring_buffer_record_off(tr->max_buffer.buffer);
1886 #ifdef CONFIG_TRACER_SNAPSHOT
1887 if (tr->cond_snapshot && !tr->cond_snapshot->update(tr, cond_data)) {
1888 arch_spin_unlock(&tr->max_lock);
1892 swap(tr->array_buffer.buffer, tr->max_buffer.buffer);
1894 __update_max_tr(tr, tsk, cpu);
1896 arch_spin_unlock(&tr->max_lock);
1900 * update_max_tr_single - only copy one trace over, and reset the rest
1902 * @tsk: task with the latency
1903 * @cpu: the cpu of the buffer to copy.
1905 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
1908 update_max_tr_single(struct trace_array *tr, struct task_struct *tsk, int cpu)
1915 WARN_ON_ONCE(!irqs_disabled());
1916 if (!tr->allocated_snapshot) {
1917 /* Only the nop tracer should hit this when disabling */
1918 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1922 arch_spin_lock(&tr->max_lock);
1924 ret = ring_buffer_swap_cpu(tr->max_buffer.buffer, tr->array_buffer.buffer, cpu);
1926 if (ret == -EBUSY) {
1928 * We failed to swap the buffer due to a commit taking
1929 * place on this CPU. We fail to record, but we reset
1930 * the max trace buffer (no one writes directly to it)
1931 * and flag that it failed.
1932 * Another reason is resize is in progress.
1934 trace_array_printk_buf(tr->max_buffer.buffer, _THIS_IP_,
1935 "Failed to swap buffers due to commit or resize in progress\n");
1938 WARN_ON_ONCE(ret && ret != -EAGAIN && ret != -EBUSY);
1940 __update_max_tr(tr, tsk, cpu);
1941 arch_spin_unlock(&tr->max_lock);
1944 #endif /* CONFIG_TRACER_MAX_TRACE */
1946 static int wait_on_pipe(struct trace_iterator *iter, int full)
1948 /* Iterators are static, they should be filled or empty */
1949 if (trace_buffer_iter(iter, iter->cpu_file))
1952 return ring_buffer_wait(iter->array_buffer->buffer, iter->cpu_file,
1956 #ifdef CONFIG_FTRACE_STARTUP_TEST
1957 static bool selftests_can_run;
1959 struct trace_selftests {
1960 struct list_head list;
1961 struct tracer *type;
1964 static LIST_HEAD(postponed_selftests);
1966 static int save_selftest(struct tracer *type)
1968 struct trace_selftests *selftest;
1970 selftest = kmalloc(sizeof(*selftest), GFP_KERNEL);
1974 selftest->type = type;
1975 list_add(&selftest->list, &postponed_selftests);
1979 static int run_tracer_selftest(struct tracer *type)
1981 struct trace_array *tr = &global_trace;
1982 struct tracer *saved_tracer = tr->current_trace;
1985 if (!type->selftest || tracing_selftest_disabled)
1989 * If a tracer registers early in boot up (before scheduling is
1990 * initialized and such), then do not run its selftests yet.
1991 * Instead, run it a little later in the boot process.
1993 if (!selftests_can_run)
1994 return save_selftest(type);
1996 if (!tracing_is_on()) {
1997 pr_warn("Selftest for tracer %s skipped due to tracing disabled\n",
2003 * Run a selftest on this tracer.
2004 * Here we reset the trace buffer, and set the current
2005 * tracer to be this tracer. The tracer can then run some
2006 * internal tracing to verify that everything is in order.
2007 * If we fail, we do not register this tracer.
2009 tracing_reset_online_cpus(&tr->array_buffer);
2011 tr->current_trace = type;
2013 #ifdef CONFIG_TRACER_MAX_TRACE
2014 if (type->use_max_tr) {
2015 /* If we expanded the buffers, make sure the max is expanded too */
2016 if (tr->ring_buffer_expanded)
2017 ring_buffer_resize(tr->max_buffer.buffer, trace_buf_size,
2018 RING_BUFFER_ALL_CPUS);
2019 tr->allocated_snapshot = true;
2023 /* the test is responsible for initializing and enabling */
2024 pr_info("Testing tracer %s: ", type->name);
2025 ret = type->selftest(type, tr);
2026 /* the test is responsible for resetting too */
2027 tr->current_trace = saved_tracer;
2029 printk(KERN_CONT "FAILED!\n");
2030 /* Add the warning after printing 'FAILED' */
2034 /* Only reset on passing, to avoid touching corrupted buffers */
2035 tracing_reset_online_cpus(&tr->array_buffer);
2037 #ifdef CONFIG_TRACER_MAX_TRACE
2038 if (type->use_max_tr) {
2039 tr->allocated_snapshot = false;
2041 /* Shrink the max buffer again */
2042 if (tr->ring_buffer_expanded)
2043 ring_buffer_resize(tr->max_buffer.buffer, 1,
2044 RING_BUFFER_ALL_CPUS);
2048 printk(KERN_CONT "PASSED\n");
2052 static int do_run_tracer_selftest(struct tracer *type)
2057 * Tests can take a long time, especially if they are run one after the
2058 * other, as does happen during bootup when all the tracers are
2059 * registered. This could cause the soft lockup watchdog to trigger.
2063 tracing_selftest_running = true;
2064 ret = run_tracer_selftest(type);
2065 tracing_selftest_running = false;
2070 static __init int init_trace_selftests(void)
2072 struct trace_selftests *p, *n;
2073 struct tracer *t, **last;
2076 selftests_can_run = true;
2078 mutex_lock(&trace_types_lock);
2080 if (list_empty(&postponed_selftests))
2083 pr_info("Running postponed tracer tests:\n");
2085 tracing_selftest_running = true;
2086 list_for_each_entry_safe(p, n, &postponed_selftests, list) {
2087 /* This loop can take minutes when sanitizers are enabled, so
2088 * lets make sure we allow RCU processing.
2091 ret = run_tracer_selftest(p->type);
2092 /* If the test fails, then warn and remove from available_tracers */
2094 WARN(1, "tracer: %s failed selftest, disabling\n",
2096 last = &trace_types;
2097 for (t = trace_types; t; t = t->next) {
2108 tracing_selftest_running = false;
2111 mutex_unlock(&trace_types_lock);
2115 core_initcall(init_trace_selftests);
2117 static inline int run_tracer_selftest(struct tracer *type)
2121 static inline int do_run_tracer_selftest(struct tracer *type)
2125 #endif /* CONFIG_FTRACE_STARTUP_TEST */
2127 static void add_tracer_options(struct trace_array *tr, struct tracer *t);
2129 static void __init apply_trace_boot_options(void);
2132 * register_tracer - register a tracer with the ftrace system.
2133 * @type: the plugin for the tracer
2135 * Register a new plugin tracer.
2137 int __init register_tracer(struct tracer *type)
2143 pr_info("Tracer must have a name\n");
2147 if (strlen(type->name) >= MAX_TRACER_SIZE) {
2148 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE);
2152 if (security_locked_down(LOCKDOWN_TRACEFS)) {
2153 pr_warn("Can not register tracer %s due to lockdown\n",
2158 mutex_lock(&trace_types_lock);
2160 for (t = trace_types; t; t = t->next) {
2161 if (strcmp(type->name, t->name) == 0) {
2163 pr_info("Tracer %s already registered\n",
2170 if (!type->set_flag)
2171 type->set_flag = &dummy_set_flag;
2173 /*allocate a dummy tracer_flags*/
2174 type->flags = kmalloc(sizeof(*type->flags), GFP_KERNEL);
2179 type->flags->val = 0;
2180 type->flags->opts = dummy_tracer_opt;
2182 if (!type->flags->opts)
2183 type->flags->opts = dummy_tracer_opt;
2185 /* store the tracer for __set_tracer_option */
2186 type->flags->trace = type;
2188 ret = do_run_tracer_selftest(type);
2192 type->next = trace_types;
2194 add_tracer_options(&global_trace, type);
2197 mutex_unlock(&trace_types_lock);
2199 if (ret || !default_bootup_tracer)
2202 if (strncmp(default_bootup_tracer, type->name, MAX_TRACER_SIZE))
2205 printk(KERN_INFO "Starting tracer '%s'\n", type->name);
2206 /* Do we want this tracer to start on bootup? */
2207 tracing_set_tracer(&global_trace, type->name);
2208 default_bootup_tracer = NULL;
2210 apply_trace_boot_options();
2212 /* disable other selftests, since this will break it. */
2213 disable_tracing_selftest("running a tracer");
2219 static void tracing_reset_cpu(struct array_buffer *buf, int cpu)
2221 struct trace_buffer *buffer = buf->buffer;
2226 ring_buffer_record_disable(buffer);
2228 /* Make sure all commits have finished */
2230 ring_buffer_reset_cpu(buffer, cpu);
2232 ring_buffer_record_enable(buffer);
2235 void tracing_reset_online_cpus(struct array_buffer *buf)
2237 struct trace_buffer *buffer = buf->buffer;
2242 ring_buffer_record_disable(buffer);
2244 /* Make sure all commits have finished */
2247 buf->time_start = buffer_ftrace_now(buf, buf->cpu);
2249 ring_buffer_reset_online_cpus(buffer);
2251 ring_buffer_record_enable(buffer);
2254 /* Must have trace_types_lock held */
2255 void tracing_reset_all_online_cpus_unlocked(void)
2257 struct trace_array *tr;
2259 lockdep_assert_held(&trace_types_lock);
2261 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
2262 if (!tr->clear_trace)
2264 tr->clear_trace = false;
2265 tracing_reset_online_cpus(&tr->array_buffer);
2266 #ifdef CONFIG_TRACER_MAX_TRACE
2267 tracing_reset_online_cpus(&tr->max_buffer);
2272 void tracing_reset_all_online_cpus(void)
2274 mutex_lock(&trace_types_lock);
2275 tracing_reset_all_online_cpus_unlocked();
2276 mutex_unlock(&trace_types_lock);
2280 * The tgid_map array maps from pid to tgid; i.e. the value stored at index i
2281 * is the tgid last observed corresponding to pid=i.
2283 static int *tgid_map;
2285 /* The maximum valid index into tgid_map. */
2286 static size_t tgid_map_max;
2288 #define SAVED_CMDLINES_DEFAULT 128
2289 #define NO_CMDLINE_MAP UINT_MAX
2291 * Preemption must be disabled before acquiring trace_cmdline_lock.
2292 * The various trace_arrays' max_lock must be acquired in a context
2293 * where interrupt is disabled.
2295 static arch_spinlock_t trace_cmdline_lock = __ARCH_SPIN_LOCK_UNLOCKED;
2296 struct saved_cmdlines_buffer {
2297 unsigned map_pid_to_cmdline[PID_MAX_DEFAULT+1];
2298 unsigned *map_cmdline_to_pid;
2299 unsigned cmdline_num;
2301 char *saved_cmdlines;
2303 static struct saved_cmdlines_buffer *savedcmd;
2305 static inline char *get_saved_cmdlines(int idx)
2307 return &savedcmd->saved_cmdlines[idx * TASK_COMM_LEN];
2310 static inline void set_cmdline(int idx, const char *cmdline)
2312 strncpy(get_saved_cmdlines(idx), cmdline, TASK_COMM_LEN);
2315 static int allocate_cmdlines_buffer(unsigned int val,
2316 struct saved_cmdlines_buffer *s)
2318 s->map_cmdline_to_pid = kmalloc_array(val,
2319 sizeof(*s->map_cmdline_to_pid),
2321 if (!s->map_cmdline_to_pid)
2324 s->saved_cmdlines = kmalloc_array(TASK_COMM_LEN, val, GFP_KERNEL);
2325 if (!s->saved_cmdlines) {
2326 kfree(s->map_cmdline_to_pid);
2331 s->cmdline_num = val;
2332 memset(&s->map_pid_to_cmdline, NO_CMDLINE_MAP,
2333 sizeof(s->map_pid_to_cmdline));
2334 memset(s->map_cmdline_to_pid, NO_CMDLINE_MAP,
2335 val * sizeof(*s->map_cmdline_to_pid));
2340 static int trace_create_savedcmd(void)
2344 savedcmd = kmalloc(sizeof(*savedcmd), GFP_KERNEL);
2348 ret = allocate_cmdlines_buffer(SAVED_CMDLINES_DEFAULT, savedcmd);
2358 int is_tracing_stopped(void)
2360 return global_trace.stop_count;
2363 static void tracing_start_tr(struct trace_array *tr)
2365 struct trace_buffer *buffer;
2366 unsigned long flags;
2368 if (tracing_disabled)
2371 raw_spin_lock_irqsave(&tr->start_lock, flags);
2372 if (--tr->stop_count) {
2373 if (WARN_ON_ONCE(tr->stop_count < 0)) {
2374 /* Someone screwed up their debugging */
2380 /* Prevent the buffers from switching */
2381 arch_spin_lock(&tr->max_lock);
2383 buffer = tr->array_buffer.buffer;
2385 ring_buffer_record_enable(buffer);
2387 #ifdef CONFIG_TRACER_MAX_TRACE
2388 buffer = tr->max_buffer.buffer;
2390 ring_buffer_record_enable(buffer);
2393 arch_spin_unlock(&tr->max_lock);
2396 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2400 * tracing_start - quick start of the tracer
2402 * If tracing is enabled but was stopped by tracing_stop,
2403 * this will start the tracer back up.
2405 void tracing_start(void)
2408 return tracing_start_tr(&global_trace);
2411 static void tracing_stop_tr(struct trace_array *tr)
2413 struct trace_buffer *buffer;
2414 unsigned long flags;
2416 raw_spin_lock_irqsave(&tr->start_lock, flags);
2417 if (tr->stop_count++)
2420 /* Prevent the buffers from switching */
2421 arch_spin_lock(&tr->max_lock);
2423 buffer = tr->array_buffer.buffer;
2425 ring_buffer_record_disable(buffer);
2427 #ifdef CONFIG_TRACER_MAX_TRACE
2428 buffer = tr->max_buffer.buffer;
2430 ring_buffer_record_disable(buffer);
2433 arch_spin_unlock(&tr->max_lock);
2436 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2440 * tracing_stop - quick stop of the tracer
2442 * Light weight way to stop tracing. Use in conjunction with
2445 void tracing_stop(void)
2447 return tracing_stop_tr(&global_trace);
2450 static int trace_save_cmdline(struct task_struct *tsk)
2454 /* treat recording of idle task as a success */
2458 tpid = tsk->pid & (PID_MAX_DEFAULT - 1);
2461 * It's not the end of the world if we don't get
2462 * the lock, but we also don't want to spin
2463 * nor do we want to disable interrupts,
2464 * so if we miss here, then better luck next time.
2466 * This is called within the scheduler and wake up, so interrupts
2467 * had better been disabled and run queue lock been held.
2469 lockdep_assert_preemption_disabled();
2470 if (!arch_spin_trylock(&trace_cmdline_lock))
2473 idx = savedcmd->map_pid_to_cmdline[tpid];
2474 if (idx == NO_CMDLINE_MAP) {
2475 idx = (savedcmd->cmdline_idx + 1) % savedcmd->cmdline_num;
2477 savedcmd->map_pid_to_cmdline[tpid] = idx;
2478 savedcmd->cmdline_idx = idx;
2481 savedcmd->map_cmdline_to_pid[idx] = tsk->pid;
2482 set_cmdline(idx, tsk->comm);
2484 arch_spin_unlock(&trace_cmdline_lock);
2489 static void __trace_find_cmdline(int pid, char comm[])
2495 strcpy(comm, "<idle>");
2499 if (WARN_ON_ONCE(pid < 0)) {
2500 strcpy(comm, "<XXX>");
2504 tpid = pid & (PID_MAX_DEFAULT - 1);
2505 map = savedcmd->map_pid_to_cmdline[tpid];
2506 if (map != NO_CMDLINE_MAP) {
2507 tpid = savedcmd->map_cmdline_to_pid[map];
2509 strscpy(comm, get_saved_cmdlines(map), TASK_COMM_LEN);
2513 strcpy(comm, "<...>");
2516 void trace_find_cmdline(int pid, char comm[])
2519 arch_spin_lock(&trace_cmdline_lock);
2521 __trace_find_cmdline(pid, comm);
2523 arch_spin_unlock(&trace_cmdline_lock);
2527 static int *trace_find_tgid_ptr(int pid)
2530 * Pairs with the smp_store_release in set_tracer_flag() to ensure that
2531 * if we observe a non-NULL tgid_map then we also observe the correct
2534 int *map = smp_load_acquire(&tgid_map);
2536 if (unlikely(!map || pid > tgid_map_max))
2542 int trace_find_tgid(int pid)
2544 int *ptr = trace_find_tgid_ptr(pid);
2546 return ptr ? *ptr : 0;
2549 static int trace_save_tgid(struct task_struct *tsk)
2553 /* treat recording of idle task as a success */
2557 ptr = trace_find_tgid_ptr(tsk->pid);
2565 static bool tracing_record_taskinfo_skip(int flags)
2567 if (unlikely(!(flags & (TRACE_RECORD_CMDLINE | TRACE_RECORD_TGID))))
2569 if (!__this_cpu_read(trace_taskinfo_save))
2575 * tracing_record_taskinfo - record the task info of a task
2577 * @task: task to record
2578 * @flags: TRACE_RECORD_CMDLINE for recording comm
2579 * TRACE_RECORD_TGID for recording tgid
2581 void tracing_record_taskinfo(struct task_struct *task, int flags)
2585 if (tracing_record_taskinfo_skip(flags))
2589 * Record as much task information as possible. If some fail, continue
2590 * to try to record the others.
2592 done = !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(task);
2593 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(task);
2595 /* If recording any information failed, retry again soon. */
2599 __this_cpu_write(trace_taskinfo_save, false);
2603 * tracing_record_taskinfo_sched_switch - record task info for sched_switch
2605 * @prev: previous task during sched_switch
2606 * @next: next task during sched_switch
2607 * @flags: TRACE_RECORD_CMDLINE for recording comm
2608 * TRACE_RECORD_TGID for recording tgid
2610 void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
2611 struct task_struct *next, int flags)
2615 if (tracing_record_taskinfo_skip(flags))
2619 * Record as much task information as possible. If some fail, continue
2620 * to try to record the others.
2622 done = !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(prev);
2623 done &= !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(next);
2624 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(prev);
2625 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(next);
2627 /* If recording any information failed, retry again soon. */
2631 __this_cpu_write(trace_taskinfo_save, false);
2634 /* Helpers to record a specific task information */
2635 void tracing_record_cmdline(struct task_struct *task)
2637 tracing_record_taskinfo(task, TRACE_RECORD_CMDLINE);
2640 void tracing_record_tgid(struct task_struct *task)
2642 tracing_record_taskinfo(task, TRACE_RECORD_TGID);
2646 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2647 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2648 * simplifies those functions and keeps them in sync.
2650 enum print_line_t trace_handle_return(struct trace_seq *s)
2652 return trace_seq_has_overflowed(s) ?
2653 TRACE_TYPE_PARTIAL_LINE : TRACE_TYPE_HANDLED;
2655 EXPORT_SYMBOL_GPL(trace_handle_return);
2657 static unsigned short migration_disable_value(void)
2659 #if defined(CONFIG_SMP)
2660 return current->migration_disabled;
2666 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status)
2668 unsigned int trace_flags = irqs_status;
2671 pc = preempt_count();
2674 trace_flags |= TRACE_FLAG_NMI;
2675 if (pc & HARDIRQ_MASK)
2676 trace_flags |= TRACE_FLAG_HARDIRQ;
2677 if (in_serving_softirq())
2678 trace_flags |= TRACE_FLAG_SOFTIRQ;
2679 if (softirq_count() >> (SOFTIRQ_SHIFT + 1))
2680 trace_flags |= TRACE_FLAG_BH_OFF;
2682 if (tif_need_resched())
2683 trace_flags |= TRACE_FLAG_NEED_RESCHED;
2684 if (test_preempt_need_resched())
2685 trace_flags |= TRACE_FLAG_PREEMPT_RESCHED;
2686 return (trace_flags << 16) | (min_t(unsigned int, pc & 0xff, 0xf)) |
2687 (min_t(unsigned int, migration_disable_value(), 0xf)) << 4;
2690 struct ring_buffer_event *
2691 trace_buffer_lock_reserve(struct trace_buffer *buffer,
2694 unsigned int trace_ctx)
2696 return __trace_buffer_lock_reserve(buffer, type, len, trace_ctx);
2699 DEFINE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
2700 DEFINE_PER_CPU(int, trace_buffered_event_cnt);
2701 static int trace_buffered_event_ref;
2704 * trace_buffered_event_enable - enable buffering events
2706 * When events are being filtered, it is quicker to use a temporary
2707 * buffer to write the event data into if there's a likely chance
2708 * that it will not be committed. The discard of the ring buffer
2709 * is not as fast as committing, and is much slower than copying
2712 * When an event is to be filtered, allocate per cpu buffers to
2713 * write the event data into, and if the event is filtered and discarded
2714 * it is simply dropped, otherwise, the entire data is to be committed
2717 void trace_buffered_event_enable(void)
2719 struct ring_buffer_event *event;
2723 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2725 if (trace_buffered_event_ref++)
2728 for_each_tracing_cpu(cpu) {
2729 page = alloc_pages_node(cpu_to_node(cpu),
2730 GFP_KERNEL | __GFP_NORETRY, 0);
2731 /* This is just an optimization and can handle failures */
2733 pr_err("Failed to allocate event buffer\n");
2737 event = page_address(page);
2738 memset(event, 0, sizeof(*event));
2740 per_cpu(trace_buffered_event, cpu) = event;
2743 if (cpu == smp_processor_id() &&
2744 __this_cpu_read(trace_buffered_event) !=
2745 per_cpu(trace_buffered_event, cpu))
2751 static void enable_trace_buffered_event(void *data)
2753 /* Probably not needed, but do it anyway */
2755 this_cpu_dec(trace_buffered_event_cnt);
2758 static void disable_trace_buffered_event(void *data)
2760 this_cpu_inc(trace_buffered_event_cnt);
2764 * trace_buffered_event_disable - disable buffering events
2766 * When a filter is removed, it is faster to not use the buffered
2767 * events, and to commit directly into the ring buffer. Free up
2768 * the temp buffers when there are no more users. This requires
2769 * special synchronization with current events.
2771 void trace_buffered_event_disable(void)
2775 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2777 if (WARN_ON_ONCE(!trace_buffered_event_ref))
2780 if (--trace_buffered_event_ref)
2783 /* For each CPU, set the buffer as used. */
2784 on_each_cpu_mask(tracing_buffer_mask, disable_trace_buffered_event,
2787 /* Wait for all current users to finish */
2790 for_each_tracing_cpu(cpu) {
2791 free_page((unsigned long)per_cpu(trace_buffered_event, cpu));
2792 per_cpu(trace_buffered_event, cpu) = NULL;
2796 * Wait for all CPUs that potentially started checking if they can use
2797 * their event buffer only after the previous synchronize_rcu() call and
2798 * they still read a valid pointer from trace_buffered_event. It must be
2799 * ensured they don't see cleared trace_buffered_event_cnt else they
2800 * could wrongly decide to use the pointed-to buffer which is now freed.
2804 /* For each CPU, relinquish the buffer */
2805 on_each_cpu_mask(tracing_buffer_mask, enable_trace_buffered_event, NULL,
2809 static struct trace_buffer *temp_buffer;
2811 struct ring_buffer_event *
2812 trace_event_buffer_lock_reserve(struct trace_buffer **current_rb,
2813 struct trace_event_file *trace_file,
2814 int type, unsigned long len,
2815 unsigned int trace_ctx)
2817 struct ring_buffer_event *entry;
2818 struct trace_array *tr = trace_file->tr;
2821 *current_rb = tr->array_buffer.buffer;
2823 if (!tr->no_filter_buffering_ref &&
2824 (trace_file->flags & (EVENT_FILE_FL_SOFT_DISABLED | EVENT_FILE_FL_FILTERED))) {
2825 preempt_disable_notrace();
2827 * Filtering is on, so try to use the per cpu buffer first.
2828 * This buffer will simulate a ring_buffer_event,
2829 * where the type_len is zero and the array[0] will
2830 * hold the full length.
2831 * (see include/linux/ring-buffer.h for details on
2832 * how the ring_buffer_event is structured).
2834 * Using a temp buffer during filtering and copying it
2835 * on a matched filter is quicker than writing directly
2836 * into the ring buffer and then discarding it when
2837 * it doesn't match. That is because the discard
2838 * requires several atomic operations to get right.
2839 * Copying on match and doing nothing on a failed match
2840 * is still quicker than no copy on match, but having
2841 * to discard out of the ring buffer on a failed match.
2843 if ((entry = __this_cpu_read(trace_buffered_event))) {
2844 int max_len = PAGE_SIZE - struct_size(entry, array, 1);
2846 val = this_cpu_inc_return(trace_buffered_event_cnt);
2849 * Preemption is disabled, but interrupts and NMIs
2850 * can still come in now. If that happens after
2851 * the above increment, then it will have to go
2852 * back to the old method of allocating the event
2853 * on the ring buffer, and if the filter fails, it
2854 * will have to call ring_buffer_discard_commit()
2857 * Need to also check the unlikely case that the
2858 * length is bigger than the temp buffer size.
2859 * If that happens, then the reserve is pretty much
2860 * guaranteed to fail, as the ring buffer currently
2861 * only allows events less than a page. But that may
2862 * change in the future, so let the ring buffer reserve
2863 * handle the failure in that case.
2865 if (val == 1 && likely(len <= max_len)) {
2866 trace_event_setup(entry, type, trace_ctx);
2867 entry->array[0] = len;
2868 /* Return with preemption disabled */
2871 this_cpu_dec(trace_buffered_event_cnt);
2873 /* __trace_buffer_lock_reserve() disables preemption */
2874 preempt_enable_notrace();
2877 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2880 * If tracing is off, but we have triggers enabled
2881 * we still need to look at the event data. Use the temp_buffer
2882 * to store the trace event for the trigger to use. It's recursive
2883 * safe and will not be recorded anywhere.
2885 if (!entry && trace_file->flags & EVENT_FILE_FL_TRIGGER_COND) {
2886 *current_rb = temp_buffer;
2887 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2892 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve);
2894 static DEFINE_RAW_SPINLOCK(tracepoint_iter_lock);
2895 static DEFINE_MUTEX(tracepoint_printk_mutex);
2897 static void output_printk(struct trace_event_buffer *fbuffer)
2899 struct trace_event_call *event_call;
2900 struct trace_event_file *file;
2901 struct trace_event *event;
2902 unsigned long flags;
2903 struct trace_iterator *iter = tracepoint_print_iter;
2905 /* We should never get here if iter is NULL */
2906 if (WARN_ON_ONCE(!iter))
2909 event_call = fbuffer->trace_file->event_call;
2910 if (!event_call || !event_call->event.funcs ||
2911 !event_call->event.funcs->trace)
2914 file = fbuffer->trace_file;
2915 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
2916 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
2917 !filter_match_preds(file->filter, fbuffer->entry)))
2920 event = &fbuffer->trace_file->event_call->event;
2922 raw_spin_lock_irqsave(&tracepoint_iter_lock, flags);
2923 trace_seq_init(&iter->seq);
2924 iter->ent = fbuffer->entry;
2925 event_call->event.funcs->trace(iter, 0, event);
2926 trace_seq_putc(&iter->seq, 0);
2927 printk("%s", iter->seq.buffer);
2929 raw_spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
2932 int tracepoint_printk_sysctl(struct ctl_table *table, int write,
2933 void *buffer, size_t *lenp,
2936 int save_tracepoint_printk;
2939 mutex_lock(&tracepoint_printk_mutex);
2940 save_tracepoint_printk = tracepoint_printk;
2942 ret = proc_dointvec(table, write, buffer, lenp, ppos);
2945 * This will force exiting early, as tracepoint_printk
2946 * is always zero when tracepoint_printk_iter is not allocated
2948 if (!tracepoint_print_iter)
2949 tracepoint_printk = 0;
2951 if (save_tracepoint_printk == tracepoint_printk)
2954 if (tracepoint_printk)
2955 static_key_enable(&tracepoint_printk_key.key);
2957 static_key_disable(&tracepoint_printk_key.key);
2960 mutex_unlock(&tracepoint_printk_mutex);
2965 void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
2967 enum event_trigger_type tt = ETT_NONE;
2968 struct trace_event_file *file = fbuffer->trace_file;
2970 if (__event_trigger_test_discard(file, fbuffer->buffer, fbuffer->event,
2971 fbuffer->entry, &tt))
2974 if (static_key_false(&tracepoint_printk_key.key))
2975 output_printk(fbuffer);
2977 if (static_branch_unlikely(&trace_event_exports_enabled))
2978 ftrace_exports(fbuffer->event, TRACE_EXPORT_EVENT);
2980 trace_buffer_unlock_commit_regs(file->tr, fbuffer->buffer,
2981 fbuffer->event, fbuffer->trace_ctx, fbuffer->regs);
2985 event_triggers_post_call(file, tt);
2988 EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
2993 * trace_buffer_unlock_commit_regs()
2994 * trace_event_buffer_commit()
2995 * trace_event_raw_event_xxx()
2997 # define STACK_SKIP 3
2999 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
3000 struct trace_buffer *buffer,
3001 struct ring_buffer_event *event,
3002 unsigned int trace_ctx,
3003 struct pt_regs *regs)
3005 __buffer_unlock_commit(buffer, event);
3008 * If regs is not set, then skip the necessary functions.
3009 * Note, we can still get here via blktrace, wakeup tracer
3010 * and mmiotrace, but that's ok if they lose a function or
3011 * two. They are not that meaningful.
3013 ftrace_trace_stack(tr, buffer, trace_ctx, regs ? 0 : STACK_SKIP, regs);
3014 ftrace_trace_userstack(tr, buffer, trace_ctx);
3018 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
3021 trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
3022 struct ring_buffer_event *event)
3024 __buffer_unlock_commit(buffer, event);
3028 trace_function(struct trace_array *tr, unsigned long ip, unsigned long
3029 parent_ip, unsigned int trace_ctx)
3031 struct trace_event_call *call = &event_function;
3032 struct trace_buffer *buffer = tr->array_buffer.buffer;
3033 struct ring_buffer_event *event;
3034 struct ftrace_entry *entry;
3036 event = __trace_buffer_lock_reserve(buffer, TRACE_FN, sizeof(*entry),
3040 entry = ring_buffer_event_data(event);
3042 entry->parent_ip = parent_ip;
3044 if (!call_filter_check_discard(call, entry, buffer, event)) {
3045 if (static_branch_unlikely(&trace_function_exports_enabled))
3046 ftrace_exports(event, TRACE_EXPORT_FUNCTION);
3047 __buffer_unlock_commit(buffer, event);
3051 #ifdef CONFIG_STACKTRACE
3053 /* Allow 4 levels of nesting: normal, softirq, irq, NMI */
3054 #define FTRACE_KSTACK_NESTING 4
3056 #define FTRACE_KSTACK_ENTRIES (PAGE_SIZE / FTRACE_KSTACK_NESTING)
3058 struct ftrace_stack {
3059 unsigned long calls[FTRACE_KSTACK_ENTRIES];
3063 struct ftrace_stacks {
3064 struct ftrace_stack stacks[FTRACE_KSTACK_NESTING];
3067 static DEFINE_PER_CPU(struct ftrace_stacks, ftrace_stacks);
3068 static DEFINE_PER_CPU(int, ftrace_stack_reserve);
3070 static void __ftrace_trace_stack(struct trace_buffer *buffer,
3071 unsigned int trace_ctx,
3072 int skip, struct pt_regs *regs)
3074 struct trace_event_call *call = &event_kernel_stack;
3075 struct ring_buffer_event *event;
3076 unsigned int size, nr_entries;
3077 struct ftrace_stack *fstack;
3078 struct stack_entry *entry;
3082 * Add one, for this function and the call to save_stack_trace()
3083 * If regs is set, then these functions will not be in the way.
3085 #ifndef CONFIG_UNWINDER_ORC
3090 preempt_disable_notrace();
3092 stackidx = __this_cpu_inc_return(ftrace_stack_reserve) - 1;
3094 /* This should never happen. If it does, yell once and skip */
3095 if (WARN_ON_ONCE(stackidx >= FTRACE_KSTACK_NESTING))
3099 * The above __this_cpu_inc_return() is 'atomic' cpu local. An
3100 * interrupt will either see the value pre increment or post
3101 * increment. If the interrupt happens pre increment it will have
3102 * restored the counter when it returns. We just need a barrier to
3103 * keep gcc from moving things around.
3107 fstack = this_cpu_ptr(ftrace_stacks.stacks) + stackidx;
3108 size = ARRAY_SIZE(fstack->calls);
3111 nr_entries = stack_trace_save_regs(regs, fstack->calls,
3114 nr_entries = stack_trace_save(fstack->calls, size, skip);
3117 event = __trace_buffer_lock_reserve(buffer, TRACE_STACK,
3118 struct_size(entry, caller, nr_entries),
3122 entry = ring_buffer_event_data(event);
3124 entry->size = nr_entries;
3125 memcpy(&entry->caller, fstack->calls,
3126 flex_array_size(entry, caller, nr_entries));
3128 if (!call_filter_check_discard(call, entry, buffer, event))
3129 __buffer_unlock_commit(buffer, event);
3132 /* Again, don't let gcc optimize things here */
3134 __this_cpu_dec(ftrace_stack_reserve);
3135 preempt_enable_notrace();
3139 static inline void ftrace_trace_stack(struct trace_array *tr,
3140 struct trace_buffer *buffer,
3141 unsigned int trace_ctx,
3142 int skip, struct pt_regs *regs)
3144 if (!(tr->trace_flags & TRACE_ITER_STACKTRACE))
3147 __ftrace_trace_stack(buffer, trace_ctx, skip, regs);
3150 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
3153 struct trace_buffer *buffer = tr->array_buffer.buffer;
3155 if (rcu_is_watching()) {
3156 __ftrace_trace_stack(buffer, trace_ctx, skip, NULL);
3160 if (WARN_ON_ONCE(IS_ENABLED(CONFIG_GENERIC_ENTRY)))
3164 * When an NMI triggers, RCU is enabled via ct_nmi_enter(),
3165 * but if the above rcu_is_watching() failed, then the NMI
3166 * triggered someplace critical, and ct_irq_enter() should
3167 * not be called from NMI.
3169 if (unlikely(in_nmi()))
3172 ct_irq_enter_irqson();
3173 __ftrace_trace_stack(buffer, trace_ctx, skip, NULL);
3174 ct_irq_exit_irqson();
3178 * trace_dump_stack - record a stack back trace in the trace buffer
3179 * @skip: Number of functions to skip (helper handlers)
3181 void trace_dump_stack(int skip)
3183 if (tracing_disabled || tracing_selftest_running)
3186 #ifndef CONFIG_UNWINDER_ORC
3187 /* Skip 1 to skip this function. */
3190 __ftrace_trace_stack(global_trace.array_buffer.buffer,
3191 tracing_gen_ctx(), skip, NULL);
3193 EXPORT_SYMBOL_GPL(trace_dump_stack);
3195 #ifdef CONFIG_USER_STACKTRACE_SUPPORT
3196 static DEFINE_PER_CPU(int, user_stack_count);
3199 ftrace_trace_userstack(struct trace_array *tr,
3200 struct trace_buffer *buffer, unsigned int trace_ctx)
3202 struct trace_event_call *call = &event_user_stack;
3203 struct ring_buffer_event *event;
3204 struct userstack_entry *entry;
3206 if (!(tr->trace_flags & TRACE_ITER_USERSTACKTRACE))
3210 * NMIs can not handle page faults, even with fix ups.
3211 * The save user stack can (and often does) fault.
3213 if (unlikely(in_nmi()))
3217 * prevent recursion, since the user stack tracing may
3218 * trigger other kernel events.
3221 if (__this_cpu_read(user_stack_count))
3224 __this_cpu_inc(user_stack_count);
3226 event = __trace_buffer_lock_reserve(buffer, TRACE_USER_STACK,
3227 sizeof(*entry), trace_ctx);
3229 goto out_drop_count;
3230 entry = ring_buffer_event_data(event);
3232 entry->tgid = current->tgid;
3233 memset(&entry->caller, 0, sizeof(entry->caller));
3235 stack_trace_save_user(entry->caller, FTRACE_STACK_ENTRIES);
3236 if (!call_filter_check_discard(call, entry, buffer, event))
3237 __buffer_unlock_commit(buffer, event);
3240 __this_cpu_dec(user_stack_count);
3244 #else /* CONFIG_USER_STACKTRACE_SUPPORT */
3245 static void ftrace_trace_userstack(struct trace_array *tr,
3246 struct trace_buffer *buffer,
3247 unsigned int trace_ctx)
3250 #endif /* !CONFIG_USER_STACKTRACE_SUPPORT */
3252 #endif /* CONFIG_STACKTRACE */
3255 func_repeats_set_delta_ts(struct func_repeats_entry *entry,
3256 unsigned long long delta)
3258 entry->bottom_delta_ts = delta & U32_MAX;
3259 entry->top_delta_ts = (delta >> 32);
3262 void trace_last_func_repeats(struct trace_array *tr,
3263 struct trace_func_repeats *last_info,
3264 unsigned int trace_ctx)
3266 struct trace_buffer *buffer = tr->array_buffer.buffer;
3267 struct func_repeats_entry *entry;
3268 struct ring_buffer_event *event;
3271 event = __trace_buffer_lock_reserve(buffer, TRACE_FUNC_REPEATS,
3272 sizeof(*entry), trace_ctx);
3276 delta = ring_buffer_event_time_stamp(buffer, event) -
3277 last_info->ts_last_call;
3279 entry = ring_buffer_event_data(event);
3280 entry->ip = last_info->ip;
3281 entry->parent_ip = last_info->parent_ip;
3282 entry->count = last_info->count;
3283 func_repeats_set_delta_ts(entry, delta);
3285 __buffer_unlock_commit(buffer, event);
3288 /* created for use with alloc_percpu */
3289 struct trace_buffer_struct {
3291 char buffer[4][TRACE_BUF_SIZE];
3294 static struct trace_buffer_struct __percpu *trace_percpu_buffer;
3297 * This allows for lockless recording. If we're nested too deeply, then
3298 * this returns NULL.
3300 static char *get_trace_buf(void)
3302 struct trace_buffer_struct *buffer = this_cpu_ptr(trace_percpu_buffer);
3304 if (!trace_percpu_buffer || buffer->nesting >= 4)
3309 /* Interrupts must see nesting incremented before we use the buffer */
3311 return &buffer->buffer[buffer->nesting - 1][0];
3314 static void put_trace_buf(void)
3316 /* Don't let the decrement of nesting leak before this */
3318 this_cpu_dec(trace_percpu_buffer->nesting);
3321 static int alloc_percpu_trace_buffer(void)
3323 struct trace_buffer_struct __percpu *buffers;
3325 if (trace_percpu_buffer)
3328 buffers = alloc_percpu(struct trace_buffer_struct);
3329 if (MEM_FAIL(!buffers, "Could not allocate percpu trace_printk buffer"))
3332 trace_percpu_buffer = buffers;
3336 static int buffers_allocated;
3338 void trace_printk_init_buffers(void)
3340 if (buffers_allocated)
3343 if (alloc_percpu_trace_buffer())
3346 /* trace_printk() is for debug use only. Don't use it in production. */
3349 pr_warn("**********************************************************\n");
3350 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3352 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
3354 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
3355 pr_warn("** unsafe for production use. **\n");
3357 pr_warn("** If you see this message and you are not debugging **\n");
3358 pr_warn("** the kernel, report this immediately to your vendor! **\n");
3360 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3361 pr_warn("**********************************************************\n");
3363 /* Expand the buffers to set size */
3364 tracing_update_buffers(&global_trace);
3366 buffers_allocated = 1;
3369 * trace_printk_init_buffers() can be called by modules.
3370 * If that happens, then we need to start cmdline recording
3371 * directly here. If the global_trace.buffer is already
3372 * allocated here, then this was called by module code.
3374 if (global_trace.array_buffer.buffer)
3375 tracing_start_cmdline_record();
3377 EXPORT_SYMBOL_GPL(trace_printk_init_buffers);
3379 void trace_printk_start_comm(void)
3381 /* Start tracing comms if trace printk is set */
3382 if (!buffers_allocated)
3384 tracing_start_cmdline_record();
3387 static void trace_printk_start_stop_comm(int enabled)
3389 if (!buffers_allocated)
3393 tracing_start_cmdline_record();
3395 tracing_stop_cmdline_record();
3399 * trace_vbprintk - write binary msg to tracing buffer
3400 * @ip: The address of the caller
3401 * @fmt: The string format to write to the buffer
3402 * @args: Arguments for @fmt
3404 int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)
3406 struct trace_event_call *call = &event_bprint;
3407 struct ring_buffer_event *event;
3408 struct trace_buffer *buffer;
3409 struct trace_array *tr = &global_trace;
3410 struct bprint_entry *entry;
3411 unsigned int trace_ctx;
3415 if (unlikely(tracing_selftest_running || tracing_disabled))
3418 /* Don't pollute graph traces with trace_vprintk internals */
3419 pause_graph_tracing();
3421 trace_ctx = tracing_gen_ctx();
3422 preempt_disable_notrace();
3424 tbuffer = get_trace_buf();
3430 len = vbin_printf((u32 *)tbuffer, TRACE_BUF_SIZE/sizeof(int), fmt, args);
3432 if (len > TRACE_BUF_SIZE/sizeof(int) || len < 0)
3435 size = sizeof(*entry) + sizeof(u32) * len;
3436 buffer = tr->array_buffer.buffer;
3437 ring_buffer_nest_start(buffer);
3438 event = __trace_buffer_lock_reserve(buffer, TRACE_BPRINT, size,
3442 entry = ring_buffer_event_data(event);
3446 memcpy(entry->buf, tbuffer, sizeof(u32) * len);
3447 if (!call_filter_check_discard(call, entry, buffer, event)) {
3448 __buffer_unlock_commit(buffer, event);
3449 ftrace_trace_stack(tr, buffer, trace_ctx, 6, NULL);
3453 ring_buffer_nest_end(buffer);
3458 preempt_enable_notrace();
3459 unpause_graph_tracing();
3463 EXPORT_SYMBOL_GPL(trace_vbprintk);
3467 __trace_array_vprintk(struct trace_buffer *buffer,
3468 unsigned long ip, const char *fmt, va_list args)
3470 struct trace_event_call *call = &event_print;
3471 struct ring_buffer_event *event;
3473 struct print_entry *entry;
3474 unsigned int trace_ctx;
3477 if (tracing_disabled)
3480 /* Don't pollute graph traces with trace_vprintk internals */
3481 pause_graph_tracing();
3483 trace_ctx = tracing_gen_ctx();
3484 preempt_disable_notrace();
3487 tbuffer = get_trace_buf();
3493 len = vscnprintf(tbuffer, TRACE_BUF_SIZE, fmt, args);
3495 size = sizeof(*entry) + len + 1;
3496 ring_buffer_nest_start(buffer);
3497 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
3501 entry = ring_buffer_event_data(event);
3504 memcpy(&entry->buf, tbuffer, len + 1);
3505 if (!call_filter_check_discard(call, entry, buffer, event)) {
3506 __buffer_unlock_commit(buffer, event);
3507 ftrace_trace_stack(&global_trace, buffer, trace_ctx, 6, NULL);
3511 ring_buffer_nest_end(buffer);
3515 preempt_enable_notrace();
3516 unpause_graph_tracing();
3522 int trace_array_vprintk(struct trace_array *tr,
3523 unsigned long ip, const char *fmt, va_list args)
3525 if (tracing_selftest_running && tr == &global_trace)
3528 return __trace_array_vprintk(tr->array_buffer.buffer, ip, fmt, args);
3532 * trace_array_printk - Print a message to a specific instance
3533 * @tr: The instance trace_array descriptor
3534 * @ip: The instruction pointer that this is called from.
3535 * @fmt: The format to print (printf format)
3537 * If a subsystem sets up its own instance, they have the right to
3538 * printk strings into their tracing instance buffer using this
3539 * function. Note, this function will not write into the top level
3540 * buffer (use trace_printk() for that), as writing into the top level
3541 * buffer should only have events that can be individually disabled.
3542 * trace_printk() is only used for debugging a kernel, and should not
3543 * be ever incorporated in normal use.
3545 * trace_array_printk() can be used, as it will not add noise to the
3546 * top level tracing buffer.
3548 * Note, trace_array_init_printk() must be called on @tr before this
3552 int trace_array_printk(struct trace_array *tr,
3553 unsigned long ip, const char *fmt, ...)
3561 /* This is only allowed for created instances */
3562 if (tr == &global_trace)
3565 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
3569 ret = trace_array_vprintk(tr, ip, fmt, ap);
3573 EXPORT_SYMBOL_GPL(trace_array_printk);
3576 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3577 * @tr: The trace array to initialize the buffers for
3579 * As trace_array_printk() only writes into instances, they are OK to
3580 * have in the kernel (unlike trace_printk()). This needs to be called
3581 * before trace_array_printk() can be used on a trace_array.
3583 int trace_array_init_printk(struct trace_array *tr)
3588 /* This is only allowed for created instances */
3589 if (tr == &global_trace)
3592 return alloc_percpu_trace_buffer();
3594 EXPORT_SYMBOL_GPL(trace_array_init_printk);
3597 int trace_array_printk_buf(struct trace_buffer *buffer,
3598 unsigned long ip, const char *fmt, ...)
3603 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
3607 ret = __trace_array_vprintk(buffer, ip, fmt, ap);
3613 int trace_vprintk(unsigned long ip, const char *fmt, va_list args)
3615 return trace_array_vprintk(&global_trace, ip, fmt, args);
3617 EXPORT_SYMBOL_GPL(trace_vprintk);
3619 static void trace_iterator_increment(struct trace_iterator *iter)
3621 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, iter->cpu);
3625 ring_buffer_iter_advance(buf_iter);
3628 static struct trace_entry *
3629 peek_next_entry(struct trace_iterator *iter, int cpu, u64 *ts,
3630 unsigned long *lost_events)
3632 struct ring_buffer_event *event;
3633 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, cpu);
3636 event = ring_buffer_iter_peek(buf_iter, ts);
3638 *lost_events = ring_buffer_iter_dropped(buf_iter) ?
3639 (unsigned long)-1 : 0;
3641 event = ring_buffer_peek(iter->array_buffer->buffer, cpu, ts,
3646 iter->ent_size = ring_buffer_event_length(event);
3647 return ring_buffer_event_data(event);
3653 static struct trace_entry *
3654 __find_next_entry(struct trace_iterator *iter, int *ent_cpu,
3655 unsigned long *missing_events, u64 *ent_ts)
3657 struct trace_buffer *buffer = iter->array_buffer->buffer;
3658 struct trace_entry *ent, *next = NULL;
3659 unsigned long lost_events = 0, next_lost = 0;
3660 int cpu_file = iter->cpu_file;
3661 u64 next_ts = 0, ts;
3667 * If we are in a per_cpu trace file, don't bother by iterating over
3668 * all cpu and peek directly.
3670 if (cpu_file > RING_BUFFER_ALL_CPUS) {
3671 if (ring_buffer_empty_cpu(buffer, cpu_file))
3673 ent = peek_next_entry(iter, cpu_file, ent_ts, missing_events);
3675 *ent_cpu = cpu_file;
3680 for_each_tracing_cpu(cpu) {
3682 if (ring_buffer_empty_cpu(buffer, cpu))
3685 ent = peek_next_entry(iter, cpu, &ts, &lost_events);
3688 * Pick the entry with the smallest timestamp:
3690 if (ent && (!next || ts < next_ts)) {
3694 next_lost = lost_events;
3695 next_size = iter->ent_size;
3699 iter->ent_size = next_size;
3702 *ent_cpu = next_cpu;
3708 *missing_events = next_lost;
3713 #define STATIC_FMT_BUF_SIZE 128
3714 static char static_fmt_buf[STATIC_FMT_BUF_SIZE];
3716 char *trace_iter_expand_format(struct trace_iterator *iter)
3721 * iter->tr is NULL when used with tp_printk, which makes
3722 * this get called where it is not safe to call krealloc().
3724 if (!iter->tr || iter->fmt == static_fmt_buf)
3727 tmp = krealloc(iter->fmt, iter->fmt_size + STATIC_FMT_BUF_SIZE,
3730 iter->fmt_size += STATIC_FMT_BUF_SIZE;
3737 /* Returns true if the string is safe to dereference from an event */
3738 static bool trace_safe_str(struct trace_iterator *iter, const char *str,
3741 unsigned long addr = (unsigned long)str;
3742 struct trace_event *trace_event;
3743 struct trace_event_call *event;
3745 /* Ignore strings with no length */
3749 /* OK if part of the event data */
3750 if ((addr >= (unsigned long)iter->ent) &&
3751 (addr < (unsigned long)iter->ent + iter->ent_size))
3754 /* OK if part of the temp seq buffer */
3755 if ((addr >= (unsigned long)iter->tmp_seq.buffer) &&
3756 (addr < (unsigned long)iter->tmp_seq.buffer + PAGE_SIZE))
3759 /* Core rodata can not be freed */
3760 if (is_kernel_rodata(addr))
3763 if (trace_is_tracepoint_string(str))
3767 * Now this could be a module event, referencing core module
3768 * data, which is OK.
3773 trace_event = ftrace_find_event(iter->ent->type);
3777 event = container_of(trace_event, struct trace_event_call, event);
3778 if ((event->flags & TRACE_EVENT_FL_DYNAMIC) || !event->module)
3781 /* Would rather have rodata, but this will suffice */
3782 if (within_module_core(addr, event->module))
3788 static DEFINE_STATIC_KEY_FALSE(trace_no_verify);
3790 static int test_can_verify_check(const char *fmt, ...)
3797 * The verifier is dependent on vsnprintf() modifies the va_list
3798 * passed to it, where it is sent as a reference. Some architectures
3799 * (like x86_32) passes it by value, which means that vsnprintf()
3800 * does not modify the va_list passed to it, and the verifier
3801 * would then need to be able to understand all the values that
3802 * vsnprintf can use. If it is passed by value, then the verifier
3806 vsnprintf(buf, 16, "%d", ap);
3807 ret = va_arg(ap, int);
3813 static void test_can_verify(void)
3815 if (!test_can_verify_check("%d %d", 0, 1)) {
3816 pr_info("trace event string verifier disabled\n");
3817 static_branch_inc(&trace_no_verify);
3822 * trace_check_vprintf - Check dereferenced strings while writing to the seq buffer
3823 * @iter: The iterator that holds the seq buffer and the event being printed
3824 * @fmt: The format used to print the event
3825 * @ap: The va_list holding the data to print from @fmt.
3827 * This writes the data into the @iter->seq buffer using the data from
3828 * @fmt and @ap. If the format has a %s, then the source of the string
3829 * is examined to make sure it is safe to print, otherwise it will
3830 * warn and print "[UNSAFE MEMORY]" in place of the dereferenced string
3833 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
3836 const char *p = fmt;
3840 if (WARN_ON_ONCE(!fmt))
3843 if (static_branch_unlikely(&trace_no_verify))
3846 /* Don't bother checking when doing a ftrace_dump() */
3847 if (iter->fmt == static_fmt_buf)
3856 /* We only care about %s and variants */
3857 for (i = 0; p[i]; i++) {
3858 if (i + 1 >= iter->fmt_size) {
3860 * If we can't expand the copy buffer,
3863 if (!trace_iter_expand_format(iter))
3867 if (p[i] == '\\' && p[i+1]) {
3872 /* Need to test cases like %08.*s */
3873 for (j = 1; p[i+j]; j++) {
3874 if (isdigit(p[i+j]) ||
3877 if (p[i+j] == '*') {
3889 /* If no %s found then just print normally */
3893 /* Copy up to the %s, and print that */
3894 strncpy(iter->fmt, p, i);
3895 iter->fmt[i] = '\0';
3896 trace_seq_vprintf(&iter->seq, iter->fmt, ap);
3899 * If iter->seq is full, the above call no longer guarantees
3900 * that ap is in sync with fmt processing, and further calls
3901 * to va_arg() can return wrong positional arguments.
3903 * Ensure that ap is no longer used in this case.
3905 if (iter->seq.full) {
3911 len = va_arg(ap, int);
3913 /* The ap now points to the string data of the %s */
3914 str = va_arg(ap, const char *);
3917 * If you hit this warning, it is likely that the
3918 * trace event in question used %s on a string that
3919 * was saved at the time of the event, but may not be
3920 * around when the trace is read. Use __string(),
3921 * __assign_str() and __get_str() helpers in the TRACE_EVENT()
3922 * instead. See samples/trace_events/trace-events-sample.h
3925 if (WARN_ONCE(!trace_safe_str(iter, str, star, len),
3926 "fmt: '%s' current_buffer: '%s'",
3927 fmt, seq_buf_str(&iter->seq.seq))) {
3930 /* Try to safely read the string */
3932 if (len + 1 > iter->fmt_size)
3933 len = iter->fmt_size - 1;
3936 ret = copy_from_kernel_nofault(iter->fmt, str, len);
3940 ret = strncpy_from_kernel_nofault(iter->fmt, str,
3944 trace_seq_printf(&iter->seq, "(0x%px)", str);
3946 trace_seq_printf(&iter->seq, "(0x%px:%s)",
3948 str = "[UNSAFE-MEMORY]";
3949 strcpy(iter->fmt, "%s");
3951 strncpy(iter->fmt, p + i, j + 1);
3952 iter->fmt[j+1] = '\0';
3955 trace_seq_printf(&iter->seq, iter->fmt, len, str);
3957 trace_seq_printf(&iter->seq, iter->fmt, str);
3963 trace_seq_vprintf(&iter->seq, p, ap);
3966 const char *trace_event_format(struct trace_iterator *iter, const char *fmt)
3968 const char *p, *new_fmt;
3971 if (WARN_ON_ONCE(!fmt))
3974 if (!iter->tr || iter->tr->trace_flags & TRACE_ITER_HASH_PTR)
3978 new_fmt = q = iter->fmt;
3980 if (unlikely(q - new_fmt + 3 > iter->fmt_size)) {
3981 if (!trace_iter_expand_format(iter))
3984 q += iter->fmt - new_fmt;
3985 new_fmt = iter->fmt;
3990 /* Replace %p with %px */
3994 } else if (p[0] == 'p' && !isalnum(p[1])) {
4005 #define STATIC_TEMP_BUF_SIZE 128
4006 static char static_temp_buf[STATIC_TEMP_BUF_SIZE] __aligned(4);
4008 /* Find the next real entry, without updating the iterator itself */
4009 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
4010 int *ent_cpu, u64 *ent_ts)
4012 /* __find_next_entry will reset ent_size */
4013 int ent_size = iter->ent_size;
4014 struct trace_entry *entry;
4017 * If called from ftrace_dump(), then the iter->temp buffer
4018 * will be the static_temp_buf and not created from kmalloc.
4019 * If the entry size is greater than the buffer, we can
4020 * not save it. Just return NULL in that case. This is only
4021 * used to add markers when two consecutive events' time
4022 * stamps have a large delta. See trace_print_lat_context()
4024 if (iter->temp == static_temp_buf &&
4025 STATIC_TEMP_BUF_SIZE < ent_size)
4029 * The __find_next_entry() may call peek_next_entry(), which may
4030 * call ring_buffer_peek() that may make the contents of iter->ent
4031 * undefined. Need to copy iter->ent now.
4033 if (iter->ent && iter->ent != iter->temp) {
4034 if ((!iter->temp || iter->temp_size < iter->ent_size) &&
4035 !WARN_ON_ONCE(iter->temp == static_temp_buf)) {
4037 temp = kmalloc(iter->ent_size, GFP_KERNEL);
4042 iter->temp_size = iter->ent_size;
4044 memcpy(iter->temp, iter->ent, iter->ent_size);
4045 iter->ent = iter->temp;
4047 entry = __find_next_entry(iter, ent_cpu, NULL, ent_ts);
4048 /* Put back the original ent_size */
4049 iter->ent_size = ent_size;
4054 /* Find the next real entry, and increment the iterator to the next entry */
4055 void *trace_find_next_entry_inc(struct trace_iterator *iter)
4057 iter->ent = __find_next_entry(iter, &iter->cpu,
4058 &iter->lost_events, &iter->ts);
4061 trace_iterator_increment(iter);
4063 return iter->ent ? iter : NULL;
4066 static void trace_consume(struct trace_iterator *iter)
4068 ring_buffer_consume(iter->array_buffer->buffer, iter->cpu, &iter->ts,
4069 &iter->lost_events);
4072 static void *s_next(struct seq_file *m, void *v, loff_t *pos)
4074 struct trace_iterator *iter = m->private;
4078 WARN_ON_ONCE(iter->leftover);
4082 /* can't go backwards */
4087 ent = trace_find_next_entry_inc(iter);
4091 while (ent && iter->idx < i)
4092 ent = trace_find_next_entry_inc(iter);
4099 void tracing_iter_reset(struct trace_iterator *iter, int cpu)
4101 struct ring_buffer_iter *buf_iter;
4102 unsigned long entries = 0;
4105 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = 0;
4107 buf_iter = trace_buffer_iter(iter, cpu);
4111 ring_buffer_iter_reset(buf_iter);
4114 * We could have the case with the max latency tracers
4115 * that a reset never took place on a cpu. This is evident
4116 * by the timestamp being before the start of the buffer.
4118 while (ring_buffer_iter_peek(buf_iter, &ts)) {
4119 if (ts >= iter->array_buffer->time_start)
4122 ring_buffer_iter_advance(buf_iter);
4125 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = entries;
4129 * The current tracer is copied to avoid a global locking
4132 static void *s_start(struct seq_file *m, loff_t *pos)
4134 struct trace_iterator *iter = m->private;
4135 struct trace_array *tr = iter->tr;
4136 int cpu_file = iter->cpu_file;
4141 mutex_lock(&trace_types_lock);
4142 if (unlikely(tr->current_trace != iter->trace)) {
4143 /* Close iter->trace before switching to the new current tracer */
4144 if (iter->trace->close)
4145 iter->trace->close(iter);
4146 iter->trace = tr->current_trace;
4147 /* Reopen the new current tracer */
4148 if (iter->trace->open)
4149 iter->trace->open(iter);
4151 mutex_unlock(&trace_types_lock);
4153 #ifdef CONFIG_TRACER_MAX_TRACE
4154 if (iter->snapshot && iter->trace->use_max_tr)
4155 return ERR_PTR(-EBUSY);
4158 if (*pos != iter->pos) {
4163 if (cpu_file == RING_BUFFER_ALL_CPUS) {
4164 for_each_tracing_cpu(cpu)
4165 tracing_iter_reset(iter, cpu);
4167 tracing_iter_reset(iter, cpu_file);
4170 for (p = iter; p && l < *pos; p = s_next(m, p, &l))
4175 * If we overflowed the seq_file before, then we want
4176 * to just reuse the trace_seq buffer again.
4182 p = s_next(m, p, &l);
4186 trace_event_read_lock();
4187 trace_access_lock(cpu_file);
4191 static void s_stop(struct seq_file *m, void *p)
4193 struct trace_iterator *iter = m->private;
4195 #ifdef CONFIG_TRACER_MAX_TRACE
4196 if (iter->snapshot && iter->trace->use_max_tr)
4200 trace_access_unlock(iter->cpu_file);
4201 trace_event_read_unlock();
4205 get_total_entries_cpu(struct array_buffer *buf, unsigned long *total,
4206 unsigned long *entries, int cpu)
4208 unsigned long count;
4210 count = ring_buffer_entries_cpu(buf->buffer, cpu);
4212 * If this buffer has skipped entries, then we hold all
4213 * entries for the trace and we need to ignore the
4214 * ones before the time stamp.
4216 if (per_cpu_ptr(buf->data, cpu)->skipped_entries) {
4217 count -= per_cpu_ptr(buf->data, cpu)->skipped_entries;
4218 /* total is the same as the entries */
4222 ring_buffer_overrun_cpu(buf->buffer, cpu);
4227 get_total_entries(struct array_buffer *buf,
4228 unsigned long *total, unsigned long *entries)
4236 for_each_tracing_cpu(cpu) {
4237 get_total_entries_cpu(buf, &t, &e, cpu);
4243 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu)
4245 unsigned long total, entries;
4250 get_total_entries_cpu(&tr->array_buffer, &total, &entries, cpu);
4255 unsigned long trace_total_entries(struct trace_array *tr)
4257 unsigned long total, entries;
4262 get_total_entries(&tr->array_buffer, &total, &entries);
4267 static void print_lat_help_header(struct seq_file *m)
4269 seq_puts(m, "# _------=> CPU# \n"
4270 "# / _-----=> irqs-off/BH-disabled\n"
4271 "# | / _----=> need-resched \n"
4272 "# || / _---=> hardirq/softirq \n"
4273 "# ||| / _--=> preempt-depth \n"
4274 "# |||| / _-=> migrate-disable \n"
4275 "# ||||| / delay \n"
4276 "# cmd pid |||||| time | caller \n"
4277 "# \\ / |||||| \\ | / \n");
4280 static void print_event_info(struct array_buffer *buf, struct seq_file *m)
4282 unsigned long total;
4283 unsigned long entries;
4285 get_total_entries(buf, &total, &entries);
4286 seq_printf(m, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
4287 entries, total, num_online_cpus());
4291 static void print_func_help_header(struct array_buffer *buf, struct seq_file *m,
4294 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4296 print_event_info(buf, m);
4298 seq_printf(m, "# TASK-PID %s CPU# TIMESTAMP FUNCTION\n", tgid ? " TGID " : "");
4299 seq_printf(m, "# | | %s | | |\n", tgid ? " | " : "");
4302 static void print_func_help_header_irq(struct array_buffer *buf, struct seq_file *m,
4305 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4306 static const char space[] = " ";
4307 int prec = tgid ? 12 : 2;
4309 print_event_info(buf, m);
4311 seq_printf(m, "# %.*s _-----=> irqs-off/BH-disabled\n", prec, space);
4312 seq_printf(m, "# %.*s / _----=> need-resched\n", prec, space);
4313 seq_printf(m, "# %.*s| / _---=> hardirq/softirq\n", prec, space);
4314 seq_printf(m, "# %.*s|| / _--=> preempt-depth\n", prec, space);
4315 seq_printf(m, "# %.*s||| / _-=> migrate-disable\n", prec, space);
4316 seq_printf(m, "# %.*s|||| / delay\n", prec, space);
4317 seq_printf(m, "# TASK-PID %.*s CPU# ||||| TIMESTAMP FUNCTION\n", prec, " TGID ");
4318 seq_printf(m, "# | | %.*s | ||||| | |\n", prec, " | ");
4322 print_trace_header(struct seq_file *m, struct trace_iterator *iter)
4324 unsigned long sym_flags = (global_trace.trace_flags & TRACE_ITER_SYM_MASK);
4325 struct array_buffer *buf = iter->array_buffer;
4326 struct trace_array_cpu *data = per_cpu_ptr(buf->data, buf->cpu);
4327 struct tracer *type = iter->trace;
4328 unsigned long entries;
4329 unsigned long total;
4330 const char *name = type->name;
4332 get_total_entries(buf, &total, &entries);
4334 seq_printf(m, "# %s latency trace v1.1.5 on %s\n",
4336 seq_puts(m, "# -----------------------------------"
4337 "---------------------------------\n");
4338 seq_printf(m, "# latency: %lu us, #%lu/%lu, CPU#%d |"
4339 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
4340 nsecs_to_usecs(data->saved_latency),
4344 preempt_model_none() ? "server" :
4345 preempt_model_voluntary() ? "desktop" :
4346 preempt_model_full() ? "preempt" :
4347 preempt_model_rt() ? "preempt_rt" :
4349 /* These are reserved for later use */
4352 seq_printf(m, " #P:%d)\n", num_online_cpus());
4356 seq_puts(m, "# -----------------\n");
4357 seq_printf(m, "# | task: %.16s-%d "
4358 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
4359 data->comm, data->pid,
4360 from_kuid_munged(seq_user_ns(m), data->uid), data->nice,
4361 data->policy, data->rt_priority);
4362 seq_puts(m, "# -----------------\n");
4364 if (data->critical_start) {
4365 seq_puts(m, "# => started at: ");
4366 seq_print_ip_sym(&iter->seq, data->critical_start, sym_flags);
4367 trace_print_seq(m, &iter->seq);
4368 seq_puts(m, "\n# => ended at: ");
4369 seq_print_ip_sym(&iter->seq, data->critical_end, sym_flags);
4370 trace_print_seq(m, &iter->seq);
4371 seq_puts(m, "\n#\n");
4377 static void test_cpu_buff_start(struct trace_iterator *iter)
4379 struct trace_seq *s = &iter->seq;
4380 struct trace_array *tr = iter->tr;
4382 if (!(tr->trace_flags & TRACE_ITER_ANNOTATE))
4385 if (!(iter->iter_flags & TRACE_FILE_ANNOTATE))
4388 if (cpumask_available(iter->started) &&
4389 cpumask_test_cpu(iter->cpu, iter->started))
4392 if (per_cpu_ptr(iter->array_buffer->data, iter->cpu)->skipped_entries)
4395 if (cpumask_available(iter->started))
4396 cpumask_set_cpu(iter->cpu, iter->started);
4398 /* Don't print started cpu buffer for the first entry of the trace */
4400 trace_seq_printf(s, "##### CPU %u buffer started ####\n",
4404 static enum print_line_t print_trace_fmt(struct trace_iterator *iter)
4406 struct trace_array *tr = iter->tr;
4407 struct trace_seq *s = &iter->seq;
4408 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
4409 struct trace_entry *entry;
4410 struct trace_event *event;
4414 test_cpu_buff_start(iter);
4416 event = ftrace_find_event(entry->type);
4418 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4419 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4420 trace_print_lat_context(iter);
4422 trace_print_context(iter);
4425 if (trace_seq_has_overflowed(s))
4426 return TRACE_TYPE_PARTIAL_LINE;
4429 if (tr->trace_flags & TRACE_ITER_FIELDS)
4430 return print_event_fields(iter, event);
4431 return event->funcs->trace(iter, sym_flags, event);
4434 trace_seq_printf(s, "Unknown type %d\n", entry->type);
4436 return trace_handle_return(s);
4439 static enum print_line_t print_raw_fmt(struct trace_iterator *iter)
4441 struct trace_array *tr = iter->tr;
4442 struct trace_seq *s = &iter->seq;
4443 struct trace_entry *entry;
4444 struct trace_event *event;
4448 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO)
4449 trace_seq_printf(s, "%d %d %llu ",
4450 entry->pid, iter->cpu, iter->ts);
4452 if (trace_seq_has_overflowed(s))
4453 return TRACE_TYPE_PARTIAL_LINE;
4455 event = ftrace_find_event(entry->type);
4457 return event->funcs->raw(iter, 0, event);
4459 trace_seq_printf(s, "%d ?\n", entry->type);
4461 return trace_handle_return(s);
4464 static enum print_line_t print_hex_fmt(struct trace_iterator *iter)
4466 struct trace_array *tr = iter->tr;
4467 struct trace_seq *s = &iter->seq;
4468 unsigned char newline = '\n';
4469 struct trace_entry *entry;
4470 struct trace_event *event;
4474 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4475 SEQ_PUT_HEX_FIELD(s, entry->pid);
4476 SEQ_PUT_HEX_FIELD(s, iter->cpu);
4477 SEQ_PUT_HEX_FIELD(s, iter->ts);
4478 if (trace_seq_has_overflowed(s))
4479 return TRACE_TYPE_PARTIAL_LINE;
4482 event = ftrace_find_event(entry->type);
4484 enum print_line_t ret = event->funcs->hex(iter, 0, event);
4485 if (ret != TRACE_TYPE_HANDLED)
4489 SEQ_PUT_FIELD(s, newline);
4491 return trace_handle_return(s);
4494 static enum print_line_t print_bin_fmt(struct trace_iterator *iter)
4496 struct trace_array *tr = iter->tr;
4497 struct trace_seq *s = &iter->seq;
4498 struct trace_entry *entry;
4499 struct trace_event *event;
4503 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4504 SEQ_PUT_FIELD(s, entry->pid);
4505 SEQ_PUT_FIELD(s, iter->cpu);
4506 SEQ_PUT_FIELD(s, iter->ts);
4507 if (trace_seq_has_overflowed(s))
4508 return TRACE_TYPE_PARTIAL_LINE;
4511 event = ftrace_find_event(entry->type);
4512 return event ? event->funcs->binary(iter, 0, event) :
4516 int trace_empty(struct trace_iterator *iter)
4518 struct ring_buffer_iter *buf_iter;
4521 /* If we are looking at one CPU buffer, only check that one */
4522 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
4523 cpu = iter->cpu_file;
4524 buf_iter = trace_buffer_iter(iter, cpu);
4526 if (!ring_buffer_iter_empty(buf_iter))
4529 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4535 for_each_tracing_cpu(cpu) {
4536 buf_iter = trace_buffer_iter(iter, cpu);
4538 if (!ring_buffer_iter_empty(buf_iter))
4541 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4549 /* Called with trace_event_read_lock() held. */
4550 enum print_line_t print_trace_line(struct trace_iterator *iter)
4552 struct trace_array *tr = iter->tr;
4553 unsigned long trace_flags = tr->trace_flags;
4554 enum print_line_t ret;
4556 if (iter->lost_events) {
4557 if (iter->lost_events == (unsigned long)-1)
4558 trace_seq_printf(&iter->seq, "CPU:%d [LOST EVENTS]\n",
4561 trace_seq_printf(&iter->seq, "CPU:%d [LOST %lu EVENTS]\n",
4562 iter->cpu, iter->lost_events);
4563 if (trace_seq_has_overflowed(&iter->seq))
4564 return TRACE_TYPE_PARTIAL_LINE;
4567 if (iter->trace && iter->trace->print_line) {
4568 ret = iter->trace->print_line(iter);
4569 if (ret != TRACE_TYPE_UNHANDLED)
4573 if (iter->ent->type == TRACE_BPUTS &&
4574 trace_flags & TRACE_ITER_PRINTK &&
4575 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4576 return trace_print_bputs_msg_only(iter);
4578 if (iter->ent->type == TRACE_BPRINT &&
4579 trace_flags & TRACE_ITER_PRINTK &&
4580 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4581 return trace_print_bprintk_msg_only(iter);
4583 if (iter->ent->type == TRACE_PRINT &&
4584 trace_flags & TRACE_ITER_PRINTK &&
4585 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4586 return trace_print_printk_msg_only(iter);
4588 if (trace_flags & TRACE_ITER_BIN)
4589 return print_bin_fmt(iter);
4591 if (trace_flags & TRACE_ITER_HEX)
4592 return print_hex_fmt(iter);
4594 if (trace_flags & TRACE_ITER_RAW)
4595 return print_raw_fmt(iter);
4597 return print_trace_fmt(iter);
4600 void trace_latency_header(struct seq_file *m)
4602 struct trace_iterator *iter = m->private;
4603 struct trace_array *tr = iter->tr;
4605 /* print nothing if the buffers are empty */
4606 if (trace_empty(iter))
4609 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4610 print_trace_header(m, iter);
4612 if (!(tr->trace_flags & TRACE_ITER_VERBOSE))
4613 print_lat_help_header(m);
4616 void trace_default_header(struct seq_file *m)
4618 struct trace_iterator *iter = m->private;
4619 struct trace_array *tr = iter->tr;
4620 unsigned long trace_flags = tr->trace_flags;
4622 if (!(trace_flags & TRACE_ITER_CONTEXT_INFO))
4625 if (iter->iter_flags & TRACE_FILE_LAT_FMT) {
4626 /* print nothing if the buffers are empty */
4627 if (trace_empty(iter))
4629 print_trace_header(m, iter);
4630 if (!(trace_flags & TRACE_ITER_VERBOSE))
4631 print_lat_help_header(m);
4633 if (!(trace_flags & TRACE_ITER_VERBOSE)) {
4634 if (trace_flags & TRACE_ITER_IRQ_INFO)
4635 print_func_help_header_irq(iter->array_buffer,
4638 print_func_help_header(iter->array_buffer, m,
4644 static void test_ftrace_alive(struct seq_file *m)
4646 if (!ftrace_is_dead())
4648 seq_puts(m, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
4649 "# MAY BE MISSING FUNCTION EVENTS\n");
4652 #ifdef CONFIG_TRACER_MAX_TRACE
4653 static void show_snapshot_main_help(struct seq_file *m)
4655 seq_puts(m, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
4656 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4657 "# Takes a snapshot of the main buffer.\n"
4658 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
4659 "# (Doesn't have to be '2' works with any number that\n"
4660 "# is not a '0' or '1')\n");
4663 static void show_snapshot_percpu_help(struct seq_file *m)
4665 seq_puts(m, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
4666 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
4667 seq_puts(m, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4668 "# Takes a snapshot of the main buffer for this cpu.\n");
4670 seq_puts(m, "# echo 1 > snapshot : Not supported with this kernel.\n"
4671 "# Must use main snapshot file to allocate.\n");
4673 seq_puts(m, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
4674 "# (Doesn't have to be '2' works with any number that\n"
4675 "# is not a '0' or '1')\n");
4678 static void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter)
4680 if (iter->tr->allocated_snapshot)
4681 seq_puts(m, "#\n# * Snapshot is allocated *\n#\n");
4683 seq_puts(m, "#\n# * Snapshot is freed *\n#\n");
4685 seq_puts(m, "# Snapshot commands:\n");
4686 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
4687 show_snapshot_main_help(m);
4689 show_snapshot_percpu_help(m);
4692 /* Should never be called */
4693 static inline void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter) { }
4696 static int s_show(struct seq_file *m, void *v)
4698 struct trace_iterator *iter = v;
4701 if (iter->ent == NULL) {
4703 seq_printf(m, "# tracer: %s\n", iter->trace->name);
4705 test_ftrace_alive(m);
4707 if (iter->snapshot && trace_empty(iter))
4708 print_snapshot_help(m, iter);
4709 else if (iter->trace && iter->trace->print_header)
4710 iter->trace->print_header(m);
4712 trace_default_header(m);
4714 } else if (iter->leftover) {
4716 * If we filled the seq_file buffer earlier, we
4717 * want to just show it now.
4719 ret = trace_print_seq(m, &iter->seq);
4721 /* ret should this time be zero, but you never know */
4722 iter->leftover = ret;
4725 ret = print_trace_line(iter);
4726 if (ret == TRACE_TYPE_PARTIAL_LINE) {
4728 trace_seq_puts(&iter->seq, "[LINE TOO BIG]\n");
4730 ret = trace_print_seq(m, &iter->seq);
4732 * If we overflow the seq_file buffer, then it will
4733 * ask us for this data again at start up.
4735 * ret is 0 if seq_file write succeeded.
4738 iter->leftover = ret;
4745 * Should be used after trace_array_get(), trace_types_lock
4746 * ensures that i_cdev was already initialized.
4748 static inline int tracing_get_cpu(struct inode *inode)
4750 if (inode->i_cdev) /* See trace_create_cpu_file() */
4751 return (long)inode->i_cdev - 1;
4752 return RING_BUFFER_ALL_CPUS;
4755 static const struct seq_operations tracer_seq_ops = {
4763 * Note, as iter itself can be allocated and freed in different
4764 * ways, this function is only used to free its content, and not
4765 * the iterator itself. The only requirement to all the allocations
4766 * is that it must zero all fields (kzalloc), as freeing works with
4767 * ethier allocated content or NULL.
4769 static void free_trace_iter_content(struct trace_iterator *iter)
4771 /* The fmt is either NULL, allocated or points to static_fmt_buf */
4772 if (iter->fmt != static_fmt_buf)
4776 kfree(iter->buffer_iter);
4777 mutex_destroy(&iter->mutex);
4778 free_cpumask_var(iter->started);
4781 static struct trace_iterator *
4782 __tracing_open(struct inode *inode, struct file *file, bool snapshot)
4784 struct trace_array *tr = inode->i_private;
4785 struct trace_iterator *iter;
4788 if (tracing_disabled)
4789 return ERR_PTR(-ENODEV);
4791 iter = __seq_open_private(file, &tracer_seq_ops, sizeof(*iter));
4793 return ERR_PTR(-ENOMEM);
4795 iter->buffer_iter = kcalloc(nr_cpu_ids, sizeof(*iter->buffer_iter),
4797 if (!iter->buffer_iter)
4801 * trace_find_next_entry() may need to save off iter->ent.
4802 * It will place it into the iter->temp buffer. As most
4803 * events are less than 128, allocate a buffer of that size.
4804 * If one is greater, then trace_find_next_entry() will
4805 * allocate a new buffer to adjust for the bigger iter->ent.
4806 * It's not critical if it fails to get allocated here.
4808 iter->temp = kmalloc(128, GFP_KERNEL);
4810 iter->temp_size = 128;
4813 * trace_event_printf() may need to modify given format
4814 * string to replace %p with %px so that it shows real address
4815 * instead of hash value. However, that is only for the event
4816 * tracing, other tracer may not need. Defer the allocation
4817 * until it is needed.
4822 mutex_lock(&trace_types_lock);
4823 iter->trace = tr->current_trace;
4825 if (!zalloc_cpumask_var(&iter->started, GFP_KERNEL))
4830 #ifdef CONFIG_TRACER_MAX_TRACE
4831 /* Currently only the top directory has a snapshot */
4832 if (tr->current_trace->print_max || snapshot)
4833 iter->array_buffer = &tr->max_buffer;
4836 iter->array_buffer = &tr->array_buffer;
4837 iter->snapshot = snapshot;
4839 iter->cpu_file = tracing_get_cpu(inode);
4840 mutex_init(&iter->mutex);
4842 /* Notify the tracer early; before we stop tracing. */
4843 if (iter->trace->open)
4844 iter->trace->open(iter);
4846 /* Annotate start of buffers if we had overruns */
4847 if (ring_buffer_overruns(iter->array_buffer->buffer))
4848 iter->iter_flags |= TRACE_FILE_ANNOTATE;
4850 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
4851 if (trace_clocks[tr->clock_id].in_ns)
4852 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
4855 * If pause-on-trace is enabled, then stop the trace while
4856 * dumping, unless this is the "snapshot" file
4858 if (!iter->snapshot && (tr->trace_flags & TRACE_ITER_PAUSE_ON_TRACE))
4859 tracing_stop_tr(tr);
4861 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
4862 for_each_tracing_cpu(cpu) {
4863 iter->buffer_iter[cpu] =
4864 ring_buffer_read_prepare(iter->array_buffer->buffer,
4867 ring_buffer_read_prepare_sync();
4868 for_each_tracing_cpu(cpu) {
4869 ring_buffer_read_start(iter->buffer_iter[cpu]);
4870 tracing_iter_reset(iter, cpu);
4873 cpu = iter->cpu_file;
4874 iter->buffer_iter[cpu] =
4875 ring_buffer_read_prepare(iter->array_buffer->buffer,
4877 ring_buffer_read_prepare_sync();
4878 ring_buffer_read_start(iter->buffer_iter[cpu]);
4879 tracing_iter_reset(iter, cpu);
4882 mutex_unlock(&trace_types_lock);
4887 mutex_unlock(&trace_types_lock);
4888 free_trace_iter_content(iter);
4890 seq_release_private(inode, file);
4891 return ERR_PTR(-ENOMEM);
4894 int tracing_open_generic(struct inode *inode, struct file *filp)
4898 ret = tracing_check_open_get_tr(NULL);
4902 filp->private_data = inode->i_private;
4906 bool tracing_is_disabled(void)
4908 return (tracing_disabled) ? true: false;
4912 * Open and update trace_array ref count.
4913 * Must have the current trace_array passed to it.
4915 int tracing_open_generic_tr(struct inode *inode, struct file *filp)
4917 struct trace_array *tr = inode->i_private;
4920 ret = tracing_check_open_get_tr(tr);
4924 filp->private_data = inode->i_private;
4930 * The private pointer of the inode is the trace_event_file.
4931 * Update the tr ref count associated to it.
4933 int tracing_open_file_tr(struct inode *inode, struct file *filp)
4935 struct trace_event_file *file = inode->i_private;
4938 ret = tracing_check_open_get_tr(file->tr);
4942 mutex_lock(&event_mutex);
4944 /* Fail if the file is marked for removal */
4945 if (file->flags & EVENT_FILE_FL_FREED) {
4946 trace_array_put(file->tr);
4949 event_file_get(file);
4952 mutex_unlock(&event_mutex);
4956 filp->private_data = inode->i_private;
4961 int tracing_release_file_tr(struct inode *inode, struct file *filp)
4963 struct trace_event_file *file = inode->i_private;
4965 trace_array_put(file->tr);
4966 event_file_put(file);
4971 static int tracing_mark_open(struct inode *inode, struct file *filp)
4973 stream_open(inode, filp);
4974 return tracing_open_generic_tr(inode, filp);
4977 static int tracing_release(struct inode *inode, struct file *file)
4979 struct trace_array *tr = inode->i_private;
4980 struct seq_file *m = file->private_data;
4981 struct trace_iterator *iter;
4984 if (!(file->f_mode & FMODE_READ)) {
4985 trace_array_put(tr);
4989 /* Writes do not use seq_file */
4991 mutex_lock(&trace_types_lock);
4993 for_each_tracing_cpu(cpu) {
4994 if (iter->buffer_iter[cpu])
4995 ring_buffer_read_finish(iter->buffer_iter[cpu]);
4998 if (iter->trace && iter->trace->close)
4999 iter->trace->close(iter);
5001 if (!iter->snapshot && tr->stop_count)
5002 /* reenable tracing if it was previously enabled */
5003 tracing_start_tr(tr);
5005 __trace_array_put(tr);
5007 mutex_unlock(&trace_types_lock);
5009 free_trace_iter_content(iter);
5010 seq_release_private(inode, file);
5015 static int tracing_release_generic_tr(struct inode *inode, struct file *file)
5017 struct trace_array *tr = inode->i_private;
5019 trace_array_put(tr);
5023 static int tracing_single_release_tr(struct inode *inode, struct file *file)
5025 struct trace_array *tr = inode->i_private;
5027 trace_array_put(tr);
5029 return single_release(inode, file);
5032 static int tracing_open(struct inode *inode, struct file *file)
5034 struct trace_array *tr = inode->i_private;
5035 struct trace_iterator *iter;
5038 ret = tracing_check_open_get_tr(tr);
5042 /* If this file was open for write, then erase contents */
5043 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
5044 int cpu = tracing_get_cpu(inode);
5045 struct array_buffer *trace_buf = &tr->array_buffer;
5047 #ifdef CONFIG_TRACER_MAX_TRACE
5048 if (tr->current_trace->print_max)
5049 trace_buf = &tr->max_buffer;
5052 if (cpu == RING_BUFFER_ALL_CPUS)
5053 tracing_reset_online_cpus(trace_buf);
5055 tracing_reset_cpu(trace_buf, cpu);
5058 if (file->f_mode & FMODE_READ) {
5059 iter = __tracing_open(inode, file, false);
5061 ret = PTR_ERR(iter);
5062 else if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
5063 iter->iter_flags |= TRACE_FILE_LAT_FMT;
5067 trace_array_put(tr);
5073 * Some tracers are not suitable for instance buffers.
5074 * A tracer is always available for the global array (toplevel)
5075 * or if it explicitly states that it is.
5078 trace_ok_for_array(struct tracer *t, struct trace_array *tr)
5080 return (tr->flags & TRACE_ARRAY_FL_GLOBAL) || t->allow_instances;
5083 /* Find the next tracer that this trace array may use */
5084 static struct tracer *
5085 get_tracer_for_array(struct trace_array *tr, struct tracer *t)
5087 while (t && !trace_ok_for_array(t, tr))
5094 t_next(struct seq_file *m, void *v, loff_t *pos)
5096 struct trace_array *tr = m->private;
5097 struct tracer *t = v;
5102 t = get_tracer_for_array(tr, t->next);
5107 static void *t_start(struct seq_file *m, loff_t *pos)
5109 struct trace_array *tr = m->private;
5113 mutex_lock(&trace_types_lock);
5115 t = get_tracer_for_array(tr, trace_types);
5116 for (; t && l < *pos; t = t_next(m, t, &l))
5122 static void t_stop(struct seq_file *m, void *p)
5124 mutex_unlock(&trace_types_lock);
5127 static int t_show(struct seq_file *m, void *v)
5129 struct tracer *t = v;
5134 seq_puts(m, t->name);
5143 static const struct seq_operations show_traces_seq_ops = {
5150 static int show_traces_open(struct inode *inode, struct file *file)
5152 struct trace_array *tr = inode->i_private;
5156 ret = tracing_check_open_get_tr(tr);
5160 ret = seq_open(file, &show_traces_seq_ops);
5162 trace_array_put(tr);
5166 m = file->private_data;
5172 static int show_traces_release(struct inode *inode, struct file *file)
5174 struct trace_array *tr = inode->i_private;
5176 trace_array_put(tr);
5177 return seq_release(inode, file);
5181 tracing_write_stub(struct file *filp, const char __user *ubuf,
5182 size_t count, loff_t *ppos)
5187 loff_t tracing_lseek(struct file *file, loff_t offset, int whence)
5191 if (file->f_mode & FMODE_READ)
5192 ret = seq_lseek(file, offset, whence);
5194 file->f_pos = ret = 0;
5199 static const struct file_operations tracing_fops = {
5200 .open = tracing_open,
5202 .read_iter = seq_read_iter,
5203 .splice_read = copy_splice_read,
5204 .write = tracing_write_stub,
5205 .llseek = tracing_lseek,
5206 .release = tracing_release,
5209 static const struct file_operations show_traces_fops = {
5210 .open = show_traces_open,
5212 .llseek = seq_lseek,
5213 .release = show_traces_release,
5217 tracing_cpumask_read(struct file *filp, char __user *ubuf,
5218 size_t count, loff_t *ppos)
5220 struct trace_array *tr = file_inode(filp)->i_private;
5224 len = snprintf(NULL, 0, "%*pb\n",
5225 cpumask_pr_args(tr->tracing_cpumask)) + 1;
5226 mask_str = kmalloc(len, GFP_KERNEL);
5230 len = snprintf(mask_str, len, "%*pb\n",
5231 cpumask_pr_args(tr->tracing_cpumask));
5236 count = simple_read_from_buffer(ubuf, count, ppos, mask_str, len);
5244 int tracing_set_cpumask(struct trace_array *tr,
5245 cpumask_var_t tracing_cpumask_new)
5252 local_irq_disable();
5253 arch_spin_lock(&tr->max_lock);
5254 for_each_tracing_cpu(cpu) {
5256 * Increase/decrease the disabled counter if we are
5257 * about to flip a bit in the cpumask:
5259 if (cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5260 !cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5261 atomic_inc(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5262 ring_buffer_record_disable_cpu(tr->array_buffer.buffer, cpu);
5263 #ifdef CONFIG_TRACER_MAX_TRACE
5264 ring_buffer_record_disable_cpu(tr->max_buffer.buffer, cpu);
5267 if (!cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5268 cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5269 atomic_dec(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5270 ring_buffer_record_enable_cpu(tr->array_buffer.buffer, cpu);
5271 #ifdef CONFIG_TRACER_MAX_TRACE
5272 ring_buffer_record_enable_cpu(tr->max_buffer.buffer, cpu);
5276 arch_spin_unlock(&tr->max_lock);
5279 cpumask_copy(tr->tracing_cpumask, tracing_cpumask_new);
5285 tracing_cpumask_write(struct file *filp, const char __user *ubuf,
5286 size_t count, loff_t *ppos)
5288 struct trace_array *tr = file_inode(filp)->i_private;
5289 cpumask_var_t tracing_cpumask_new;
5292 if (!zalloc_cpumask_var(&tracing_cpumask_new, GFP_KERNEL))
5295 err = cpumask_parse_user(ubuf, count, tracing_cpumask_new);
5299 err = tracing_set_cpumask(tr, tracing_cpumask_new);
5303 free_cpumask_var(tracing_cpumask_new);
5308 free_cpumask_var(tracing_cpumask_new);
5313 static const struct file_operations tracing_cpumask_fops = {
5314 .open = tracing_open_generic_tr,
5315 .read = tracing_cpumask_read,
5316 .write = tracing_cpumask_write,
5317 .release = tracing_release_generic_tr,
5318 .llseek = generic_file_llseek,
5321 static int tracing_trace_options_show(struct seq_file *m, void *v)
5323 struct tracer_opt *trace_opts;
5324 struct trace_array *tr = m->private;
5328 mutex_lock(&trace_types_lock);
5329 tracer_flags = tr->current_trace->flags->val;
5330 trace_opts = tr->current_trace->flags->opts;
5332 for (i = 0; trace_options[i]; i++) {
5333 if (tr->trace_flags & (1 << i))
5334 seq_printf(m, "%s\n", trace_options[i]);
5336 seq_printf(m, "no%s\n", trace_options[i]);
5339 for (i = 0; trace_opts[i].name; i++) {
5340 if (tracer_flags & trace_opts[i].bit)
5341 seq_printf(m, "%s\n", trace_opts[i].name);
5343 seq_printf(m, "no%s\n", trace_opts[i].name);
5345 mutex_unlock(&trace_types_lock);
5350 static int __set_tracer_option(struct trace_array *tr,
5351 struct tracer_flags *tracer_flags,
5352 struct tracer_opt *opts, int neg)
5354 struct tracer *trace = tracer_flags->trace;
5357 ret = trace->set_flag(tr, tracer_flags->val, opts->bit, !neg);
5362 tracer_flags->val &= ~opts->bit;
5364 tracer_flags->val |= opts->bit;
5368 /* Try to assign a tracer specific option */
5369 static int set_tracer_option(struct trace_array *tr, char *cmp, int neg)
5371 struct tracer *trace = tr->current_trace;
5372 struct tracer_flags *tracer_flags = trace->flags;
5373 struct tracer_opt *opts = NULL;
5376 for (i = 0; tracer_flags->opts[i].name; i++) {
5377 opts = &tracer_flags->opts[i];
5379 if (strcmp(cmp, opts->name) == 0)
5380 return __set_tracer_option(tr, trace->flags, opts, neg);
5386 /* Some tracers require overwrite to stay enabled */
5387 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set)
5389 if (tracer->enabled && (mask & TRACE_ITER_OVERWRITE) && !set)
5395 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled)
5399 if ((mask == TRACE_ITER_RECORD_TGID) ||
5400 (mask == TRACE_ITER_RECORD_CMD))
5401 lockdep_assert_held(&event_mutex);
5403 /* do nothing if flag is already set */
5404 if (!!(tr->trace_flags & mask) == !!enabled)
5407 /* Give the tracer a chance to approve the change */
5408 if (tr->current_trace->flag_changed)
5409 if (tr->current_trace->flag_changed(tr, mask, !!enabled))
5413 tr->trace_flags |= mask;
5415 tr->trace_flags &= ~mask;
5417 if (mask == TRACE_ITER_RECORD_CMD)
5418 trace_event_enable_cmd_record(enabled);
5420 if (mask == TRACE_ITER_RECORD_TGID) {
5422 tgid_map_max = pid_max;
5423 map = kvcalloc(tgid_map_max + 1, sizeof(*tgid_map),
5427 * Pairs with smp_load_acquire() in
5428 * trace_find_tgid_ptr() to ensure that if it observes
5429 * the tgid_map we just allocated then it also observes
5430 * the corresponding tgid_map_max value.
5432 smp_store_release(&tgid_map, map);
5435 tr->trace_flags &= ~TRACE_ITER_RECORD_TGID;
5439 trace_event_enable_tgid_record(enabled);
5442 if (mask == TRACE_ITER_EVENT_FORK)
5443 trace_event_follow_fork(tr, enabled);
5445 if (mask == TRACE_ITER_FUNC_FORK)
5446 ftrace_pid_follow_fork(tr, enabled);
5448 if (mask == TRACE_ITER_OVERWRITE) {
5449 ring_buffer_change_overwrite(tr->array_buffer.buffer, enabled);
5450 #ifdef CONFIG_TRACER_MAX_TRACE
5451 ring_buffer_change_overwrite(tr->max_buffer.buffer, enabled);
5455 if (mask == TRACE_ITER_PRINTK) {
5456 trace_printk_start_stop_comm(enabled);
5457 trace_printk_control(enabled);
5463 int trace_set_options(struct trace_array *tr, char *option)
5468 size_t orig_len = strlen(option);
5471 cmp = strstrip(option);
5473 len = str_has_prefix(cmp, "no");
5479 mutex_lock(&event_mutex);
5480 mutex_lock(&trace_types_lock);
5482 ret = match_string(trace_options, -1, cmp);
5483 /* If no option could be set, test the specific tracer options */
5485 ret = set_tracer_option(tr, cmp, neg);
5487 ret = set_tracer_flag(tr, 1 << ret, !neg);
5489 mutex_unlock(&trace_types_lock);
5490 mutex_unlock(&event_mutex);
5493 * If the first trailing whitespace is replaced with '\0' by strstrip,
5494 * turn it back into a space.
5496 if (orig_len > strlen(option))
5497 option[strlen(option)] = ' ';
5502 static void __init apply_trace_boot_options(void)
5504 char *buf = trace_boot_options_buf;
5508 option = strsep(&buf, ",");
5514 trace_set_options(&global_trace, option);
5516 /* Put back the comma to allow this to be called again */
5523 tracing_trace_options_write(struct file *filp, const char __user *ubuf,
5524 size_t cnt, loff_t *ppos)
5526 struct seq_file *m = filp->private_data;
5527 struct trace_array *tr = m->private;
5531 if (cnt >= sizeof(buf))
5534 if (copy_from_user(buf, ubuf, cnt))
5539 ret = trace_set_options(tr, buf);
5548 static int tracing_trace_options_open(struct inode *inode, struct file *file)
5550 struct trace_array *tr = inode->i_private;
5553 ret = tracing_check_open_get_tr(tr);
5557 ret = single_open(file, tracing_trace_options_show, inode->i_private);
5559 trace_array_put(tr);
5564 static const struct file_operations tracing_iter_fops = {
5565 .open = tracing_trace_options_open,
5567 .llseek = seq_lseek,
5568 .release = tracing_single_release_tr,
5569 .write = tracing_trace_options_write,
5572 static const char readme_msg[] =
5573 "tracing mini-HOWTO:\n\n"
5574 "# echo 0 > tracing_on : quick way to disable tracing\n"
5575 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
5576 " Important files:\n"
5577 " trace\t\t\t- The static contents of the buffer\n"
5578 "\t\t\t To clear the buffer write into this file: echo > trace\n"
5579 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
5580 " current_tracer\t- function and latency tracers\n"
5581 " available_tracers\t- list of configured tracers for current_tracer\n"
5582 " error_log\t- error log for failed commands (that support it)\n"
5583 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
5584 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
5585 " trace_clock\t\t- change the clock used to order events\n"
5586 " local: Per cpu clock but may not be synced across CPUs\n"
5587 " global: Synced across CPUs but slows tracing down.\n"
5588 " counter: Not a clock, but just an increment\n"
5589 " uptime: Jiffy counter from time of boot\n"
5590 " perf: Same clock that perf events use\n"
5591 #ifdef CONFIG_X86_64
5592 " x86-tsc: TSC cycle counter\n"
5594 "\n timestamp_mode\t- view the mode used to timestamp events\n"
5595 " delta: Delta difference against a buffer-wide timestamp\n"
5596 " absolute: Absolute (standalone) timestamp\n"
5597 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
5598 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
5599 " tracing_cpumask\t- Limit which CPUs to trace\n"
5600 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
5601 "\t\t\t Remove sub-buffer with rmdir\n"
5602 " trace_options\t\t- Set format or modify how tracing happens\n"
5603 "\t\t\t Disable an option by prefixing 'no' to the\n"
5604 "\t\t\t option name\n"
5605 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
5606 #ifdef CONFIG_DYNAMIC_FTRACE
5607 "\n available_filter_functions - list of functions that can be filtered on\n"
5608 " set_ftrace_filter\t- echo function name in here to only trace these\n"
5609 "\t\t\t functions\n"
5610 "\t accepts: func_full_name or glob-matching-pattern\n"
5611 "\t modules: Can select a group via module\n"
5612 "\t Format: :mod:<module-name>\n"
5613 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
5614 "\t triggers: a command to perform when function is hit\n"
5615 "\t Format: <function>:<trigger>[:count]\n"
5616 "\t trigger: traceon, traceoff\n"
5617 "\t\t enable_event:<system>:<event>\n"
5618 "\t\t disable_event:<system>:<event>\n"
5619 #ifdef CONFIG_STACKTRACE
5622 #ifdef CONFIG_TRACER_SNAPSHOT
5627 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
5628 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
5629 "\t The first one will disable tracing every time do_fault is hit\n"
5630 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
5631 "\t The first time do trap is hit and it disables tracing, the\n"
5632 "\t counter will decrement to 2. If tracing is already disabled,\n"
5633 "\t the counter will not decrement. It only decrements when the\n"
5634 "\t trigger did work\n"
5635 "\t To remove trigger without count:\n"
5636 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
5637 "\t To remove trigger with a count:\n"
5638 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
5639 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
5640 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
5641 "\t modules: Can select a group via module command :mod:\n"
5642 "\t Does not accept triggers\n"
5643 #endif /* CONFIG_DYNAMIC_FTRACE */
5644 #ifdef CONFIG_FUNCTION_TRACER
5645 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
5647 " set_ftrace_notrace_pid\t- Write pid(s) to not function trace those pids\n"
5650 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
5651 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
5652 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
5653 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
5655 #ifdef CONFIG_TRACER_SNAPSHOT
5656 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
5657 "\t\t\t snapshot buffer. Read the contents for more\n"
5658 "\t\t\t information\n"
5660 #ifdef CONFIG_STACK_TRACER
5661 " stack_trace\t\t- Shows the max stack trace when active\n"
5662 " stack_max_size\t- Shows current max stack size that was traced\n"
5663 "\t\t\t Write into this file to reset the max size (trigger a\n"
5664 "\t\t\t new trace)\n"
5665 #ifdef CONFIG_DYNAMIC_FTRACE
5666 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
5669 #endif /* CONFIG_STACK_TRACER */
5670 #ifdef CONFIG_DYNAMIC_EVENTS
5671 " dynamic_events\t\t- Create/append/remove/show the generic dynamic events\n"
5672 "\t\t\t Write into this file to define/undefine new trace events.\n"
5674 #ifdef CONFIG_KPROBE_EVENTS
5675 " kprobe_events\t\t- Create/append/remove/show the kernel dynamic events\n"
5676 "\t\t\t Write into this file to define/undefine new trace events.\n"
5678 #ifdef CONFIG_UPROBE_EVENTS
5679 " uprobe_events\t\t- Create/append/remove/show the userspace dynamic events\n"
5680 "\t\t\t Write into this file to define/undefine new trace events.\n"
5682 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS) || \
5683 defined(CONFIG_FPROBE_EVENTS)
5684 "\t accepts: event-definitions (one definition per line)\n"
5685 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
5686 "\t Format: p[:[<group>/][<event>]] <place> [<args>]\n"
5687 "\t r[maxactive][:[<group>/][<event>]] <place> [<args>]\n"
5689 #ifdef CONFIG_FPROBE_EVENTS
5690 "\t f[:[<group>/][<event>]] <func-name>[%return] [<args>]\n"
5691 "\t t[:[<group>/][<event>]] <tracepoint> [<args>]\n"
5693 #ifdef CONFIG_HIST_TRIGGERS
5694 "\t s:[synthetic/]<event> <field> [<field>]\n"
5696 "\t e[:[<group>/][<event>]] <attached-group>.<attached-event> [<args>] [if <filter>]\n"
5697 "\t -:[<group>/][<event>]\n"
5698 #ifdef CONFIG_KPROBE_EVENTS
5699 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
5700 "place (kretprobe): [<module>:]<symbol>[+<offset>]%return|<memaddr>\n"
5702 #ifdef CONFIG_UPROBE_EVENTS
5703 " place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"
5705 "\t args: <name>=fetcharg[:type]\n"
5706 "\t fetcharg: (%<register>|$<efield>), @<address>, @<symbol>[+|-<offset>],\n"
5707 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
5708 #ifdef CONFIG_PROBE_EVENTS_BTF_ARGS
5709 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5710 "\t <argname>[->field[->field|.field...]],\n"
5712 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5715 "\t $stack<index>, $stack, $retval, $comm,\n"
5717 "\t +|-[u]<offset>(<fetcharg>), \\imm-value, \\\"imm-string\"\n"
5718 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, char, string, symbol,\n"
5719 "\t b<bit-width>@<bit-offset>/<container-size>, ustring,\n"
5720 "\t symstr, <type>\\[<array-size>\\]\n"
5721 #ifdef CONFIG_HIST_TRIGGERS
5722 "\t field: <stype> <name>;\n"
5723 "\t stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"
5724 "\t [unsigned] char/int/long\n"
5726 "\t efield: For event probes ('e' types), the field is on of the fields\n"
5727 "\t of the <attached-group>/<attached-event>.\n"
5729 " events/\t\t- Directory containing all trace event subsystems:\n"
5730 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
5731 " events/<system>/\t- Directory containing all trace events for <system>:\n"
5732 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
5734 " filter\t\t- If set, only events passing filter are traced\n"
5735 " events/<system>/<event>/\t- Directory containing control files for\n"
5737 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
5738 " filter\t\t- If set, only events passing filter are traced\n"
5739 " trigger\t\t- If set, a command to perform when event is hit\n"
5740 "\t Format: <trigger>[:count][if <filter>]\n"
5741 "\t trigger: traceon, traceoff\n"
5742 "\t enable_event:<system>:<event>\n"
5743 "\t disable_event:<system>:<event>\n"
5744 #ifdef CONFIG_HIST_TRIGGERS
5745 "\t enable_hist:<system>:<event>\n"
5746 "\t disable_hist:<system>:<event>\n"
5748 #ifdef CONFIG_STACKTRACE
5751 #ifdef CONFIG_TRACER_SNAPSHOT
5754 #ifdef CONFIG_HIST_TRIGGERS
5755 "\t\t hist (see below)\n"
5757 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
5758 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
5759 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
5760 "\t events/block/block_unplug/trigger\n"
5761 "\t The first disables tracing every time block_unplug is hit.\n"
5762 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
5763 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
5764 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
5765 "\t Like function triggers, the counter is only decremented if it\n"
5766 "\t enabled or disabled tracing.\n"
5767 "\t To remove a trigger without a count:\n"
5768 "\t echo '!<trigger> > <system>/<event>/trigger\n"
5769 "\t To remove a trigger with a count:\n"
5770 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
5771 "\t Filters can be ignored when removing a trigger.\n"
5772 #ifdef CONFIG_HIST_TRIGGERS
5773 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
5774 "\t Format: hist:keys=<field1[,field2,...]>\n"
5775 "\t [:<var1>=<field|var_ref|numeric_literal>[,<var2>=...]]\n"
5776 "\t [:values=<field1[,field2,...]>]\n"
5777 "\t [:sort=<field1[,field2,...]>]\n"
5778 "\t [:size=#entries]\n"
5779 "\t [:pause][:continue][:clear]\n"
5780 "\t [:name=histname1]\n"
5781 "\t [:nohitcount]\n"
5782 "\t [:<handler>.<action>]\n"
5783 "\t [if <filter>]\n\n"
5784 "\t Note, special fields can be used as well:\n"
5785 "\t common_timestamp - to record current timestamp\n"
5786 "\t common_cpu - to record the CPU the event happened on\n"
5788 "\t A hist trigger variable can be:\n"
5789 "\t - a reference to a field e.g. x=current_timestamp,\n"
5790 "\t - a reference to another variable e.g. y=$x,\n"
5791 "\t - a numeric literal: e.g. ms_per_sec=1000,\n"
5792 "\t - an arithmetic expression: e.g. time_secs=current_timestamp/1000\n"
5794 "\t hist trigger arithmetic expressions support addition(+), subtraction(-),\n"
5795 "\t multiplication(*) and division(/) operators. An operand can be either a\n"
5796 "\t variable reference, field or numeric literal.\n"
5798 "\t When a matching event is hit, an entry is added to a hash\n"
5799 "\t table using the key(s) and value(s) named, and the value of a\n"
5800 "\t sum called 'hitcount' is incremented. Keys and values\n"
5801 "\t correspond to fields in the event's format description. Keys\n"
5802 "\t can be any field, or the special string 'common_stacktrace'.\n"
5803 "\t Compound keys consisting of up to two fields can be specified\n"
5804 "\t by the 'keys' keyword. Values must correspond to numeric\n"
5805 "\t fields. Sort keys consisting of up to two fields can be\n"
5806 "\t specified using the 'sort' keyword. The sort direction can\n"
5807 "\t be modified by appending '.descending' or '.ascending' to a\n"
5808 "\t sort field. The 'size' parameter can be used to specify more\n"
5809 "\t or fewer than the default 2048 entries for the hashtable size.\n"
5810 "\t If a hist trigger is given a name using the 'name' parameter,\n"
5811 "\t its histogram data will be shared with other triggers of the\n"
5812 "\t same name, and trigger hits will update this common data.\n\n"
5813 "\t Reading the 'hist' file for the event will dump the hash\n"
5814 "\t table in its entirety to stdout. If there are multiple hist\n"
5815 "\t triggers attached to an event, there will be a table for each\n"
5816 "\t trigger in the output. The table displayed for a named\n"
5817 "\t trigger will be the same as any other instance having the\n"
5818 "\t same name. The default format used to display a given field\n"
5819 "\t can be modified by appending any of the following modifiers\n"
5820 "\t to the field name, as applicable:\n\n"
5821 "\t .hex display a number as a hex value\n"
5822 "\t .sym display an address as a symbol\n"
5823 "\t .sym-offset display an address as a symbol and offset\n"
5824 "\t .execname display a common_pid as a program name\n"
5825 "\t .syscall display a syscall id as a syscall name\n"
5826 "\t .log2 display log2 value rather than raw number\n"
5827 "\t .buckets=size display values in groups of size rather than raw number\n"
5828 "\t .usecs display a common_timestamp in microseconds\n"
5829 "\t .percent display a number of percentage value\n"
5830 "\t .graph display a bar-graph of a value\n\n"
5831 "\t The 'pause' parameter can be used to pause an existing hist\n"
5832 "\t trigger or to start a hist trigger but not log any events\n"
5833 "\t until told to do so. 'continue' can be used to start or\n"
5834 "\t restart a paused hist trigger.\n\n"
5835 "\t The 'clear' parameter will clear the contents of a running\n"
5836 "\t hist trigger and leave its current paused/active state\n"
5838 "\t The 'nohitcount' (or NOHC) parameter will suppress display of\n"
5839 "\t raw hitcount in the histogram.\n\n"
5840 "\t The enable_hist and disable_hist triggers can be used to\n"
5841 "\t have one event conditionally start and stop another event's\n"
5842 "\t already-attached hist trigger. The syntax is analogous to\n"
5843 "\t the enable_event and disable_event triggers.\n\n"
5844 "\t Hist trigger handlers and actions are executed whenever a\n"
5845 "\t a histogram entry is added or updated. They take the form:\n\n"
5846 "\t <handler>.<action>\n\n"
5847 "\t The available handlers are:\n\n"
5848 "\t onmatch(matching.event) - invoke on addition or update\n"
5849 "\t onmax(var) - invoke if var exceeds current max\n"
5850 "\t onchange(var) - invoke action if var changes\n\n"
5851 "\t The available actions are:\n\n"
5852 "\t trace(<synthetic_event>,param list) - generate synthetic event\n"
5853 "\t save(field,...) - save current event fields\n"
5854 #ifdef CONFIG_TRACER_SNAPSHOT
5855 "\t snapshot() - snapshot the trace buffer\n\n"
5857 #ifdef CONFIG_SYNTH_EVENTS
5858 " events/synthetic_events\t- Create/append/remove/show synthetic events\n"
5859 "\t Write into this file to define/undefine new synthetic events.\n"
5860 "\t example: echo 'myevent u64 lat; char name[]; long[] stack' >> synthetic_events\n"
5866 tracing_readme_read(struct file *filp, char __user *ubuf,
5867 size_t cnt, loff_t *ppos)
5869 return simple_read_from_buffer(ubuf, cnt, ppos,
5870 readme_msg, strlen(readme_msg));
5873 static const struct file_operations tracing_readme_fops = {
5874 .open = tracing_open_generic,
5875 .read = tracing_readme_read,
5876 .llseek = generic_file_llseek,
5879 static void *saved_tgids_next(struct seq_file *m, void *v, loff_t *pos)
5883 return trace_find_tgid_ptr(pid);
5886 static void *saved_tgids_start(struct seq_file *m, loff_t *pos)
5890 return trace_find_tgid_ptr(pid);
5893 static void saved_tgids_stop(struct seq_file *m, void *v)
5897 static int saved_tgids_show(struct seq_file *m, void *v)
5899 int *entry = (int *)v;
5900 int pid = entry - tgid_map;
5906 seq_printf(m, "%d %d\n", pid, tgid);
5910 static const struct seq_operations tracing_saved_tgids_seq_ops = {
5911 .start = saved_tgids_start,
5912 .stop = saved_tgids_stop,
5913 .next = saved_tgids_next,
5914 .show = saved_tgids_show,
5917 static int tracing_saved_tgids_open(struct inode *inode, struct file *filp)
5921 ret = tracing_check_open_get_tr(NULL);
5925 return seq_open(filp, &tracing_saved_tgids_seq_ops);
5929 static const struct file_operations tracing_saved_tgids_fops = {
5930 .open = tracing_saved_tgids_open,
5932 .llseek = seq_lseek,
5933 .release = seq_release,
5936 static void *saved_cmdlines_next(struct seq_file *m, void *v, loff_t *pos)
5938 unsigned int *ptr = v;
5940 if (*pos || m->count)
5945 for (; ptr < &savedcmd->map_cmdline_to_pid[savedcmd->cmdline_num];
5947 if (*ptr == -1 || *ptr == NO_CMDLINE_MAP)
5956 static void *saved_cmdlines_start(struct seq_file *m, loff_t *pos)
5962 arch_spin_lock(&trace_cmdline_lock);
5964 v = &savedcmd->map_cmdline_to_pid[0];
5966 v = saved_cmdlines_next(m, v, &l);
5974 static void saved_cmdlines_stop(struct seq_file *m, void *v)
5976 arch_spin_unlock(&trace_cmdline_lock);
5980 static int saved_cmdlines_show(struct seq_file *m, void *v)
5982 char buf[TASK_COMM_LEN];
5983 unsigned int *pid = v;
5985 __trace_find_cmdline(*pid, buf);
5986 seq_printf(m, "%d %s\n", *pid, buf);
5990 static const struct seq_operations tracing_saved_cmdlines_seq_ops = {
5991 .start = saved_cmdlines_start,
5992 .next = saved_cmdlines_next,
5993 .stop = saved_cmdlines_stop,
5994 .show = saved_cmdlines_show,
5997 static int tracing_saved_cmdlines_open(struct inode *inode, struct file *filp)
6001 ret = tracing_check_open_get_tr(NULL);
6005 return seq_open(filp, &tracing_saved_cmdlines_seq_ops);
6008 static const struct file_operations tracing_saved_cmdlines_fops = {
6009 .open = tracing_saved_cmdlines_open,
6011 .llseek = seq_lseek,
6012 .release = seq_release,
6016 tracing_saved_cmdlines_size_read(struct file *filp, char __user *ubuf,
6017 size_t cnt, loff_t *ppos)
6023 arch_spin_lock(&trace_cmdline_lock);
6024 r = scnprintf(buf, sizeof(buf), "%u\n", savedcmd->cmdline_num);
6025 arch_spin_unlock(&trace_cmdline_lock);
6028 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6031 static void free_saved_cmdlines_buffer(struct saved_cmdlines_buffer *s)
6033 kfree(s->saved_cmdlines);
6034 kfree(s->map_cmdline_to_pid);
6038 static int tracing_resize_saved_cmdlines(unsigned int val)
6040 struct saved_cmdlines_buffer *s, *savedcmd_temp;
6042 s = kmalloc(sizeof(*s), GFP_KERNEL);
6046 if (allocate_cmdlines_buffer(val, s) < 0) {
6052 arch_spin_lock(&trace_cmdline_lock);
6053 savedcmd_temp = savedcmd;
6055 arch_spin_unlock(&trace_cmdline_lock);
6057 free_saved_cmdlines_buffer(savedcmd_temp);
6063 tracing_saved_cmdlines_size_write(struct file *filp, const char __user *ubuf,
6064 size_t cnt, loff_t *ppos)
6069 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6073 /* must have at least 1 entry or less than PID_MAX_DEFAULT */
6074 if (!val || val > PID_MAX_DEFAULT)
6077 ret = tracing_resize_saved_cmdlines((unsigned int)val);
6086 static const struct file_operations tracing_saved_cmdlines_size_fops = {
6087 .open = tracing_open_generic,
6088 .read = tracing_saved_cmdlines_size_read,
6089 .write = tracing_saved_cmdlines_size_write,
6092 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
6093 static union trace_eval_map_item *
6094 update_eval_map(union trace_eval_map_item *ptr)
6096 if (!ptr->map.eval_string) {
6097 if (ptr->tail.next) {
6098 ptr = ptr->tail.next;
6099 /* Set ptr to the next real item (skip head) */
6107 static void *eval_map_next(struct seq_file *m, void *v, loff_t *pos)
6109 union trace_eval_map_item *ptr = v;
6112 * Paranoid! If ptr points to end, we don't want to increment past it.
6113 * This really should never happen.
6116 ptr = update_eval_map(ptr);
6117 if (WARN_ON_ONCE(!ptr))
6121 ptr = update_eval_map(ptr);
6126 static void *eval_map_start(struct seq_file *m, loff_t *pos)
6128 union trace_eval_map_item *v;
6131 mutex_lock(&trace_eval_mutex);
6133 v = trace_eval_maps;
6137 while (v && l < *pos) {
6138 v = eval_map_next(m, v, &l);
6144 static void eval_map_stop(struct seq_file *m, void *v)
6146 mutex_unlock(&trace_eval_mutex);
6149 static int eval_map_show(struct seq_file *m, void *v)
6151 union trace_eval_map_item *ptr = v;
6153 seq_printf(m, "%s %ld (%s)\n",
6154 ptr->map.eval_string, ptr->map.eval_value,
6160 static const struct seq_operations tracing_eval_map_seq_ops = {
6161 .start = eval_map_start,
6162 .next = eval_map_next,
6163 .stop = eval_map_stop,
6164 .show = eval_map_show,
6167 static int tracing_eval_map_open(struct inode *inode, struct file *filp)
6171 ret = tracing_check_open_get_tr(NULL);
6175 return seq_open(filp, &tracing_eval_map_seq_ops);
6178 static const struct file_operations tracing_eval_map_fops = {
6179 .open = tracing_eval_map_open,
6181 .llseek = seq_lseek,
6182 .release = seq_release,
6185 static inline union trace_eval_map_item *
6186 trace_eval_jmp_to_tail(union trace_eval_map_item *ptr)
6188 /* Return tail of array given the head */
6189 return ptr + ptr->head.length + 1;
6193 trace_insert_eval_map_file(struct module *mod, struct trace_eval_map **start,
6196 struct trace_eval_map **stop;
6197 struct trace_eval_map **map;
6198 union trace_eval_map_item *map_array;
6199 union trace_eval_map_item *ptr;
6204 * The trace_eval_maps contains the map plus a head and tail item,
6205 * where the head holds the module and length of array, and the
6206 * tail holds a pointer to the next list.
6208 map_array = kmalloc_array(len + 2, sizeof(*map_array), GFP_KERNEL);
6210 pr_warn("Unable to allocate trace eval mapping\n");
6214 mutex_lock(&trace_eval_mutex);
6216 if (!trace_eval_maps)
6217 trace_eval_maps = map_array;
6219 ptr = trace_eval_maps;
6221 ptr = trace_eval_jmp_to_tail(ptr);
6222 if (!ptr->tail.next)
6224 ptr = ptr->tail.next;
6227 ptr->tail.next = map_array;
6229 map_array->head.mod = mod;
6230 map_array->head.length = len;
6233 for (map = start; (unsigned long)map < (unsigned long)stop; map++) {
6234 map_array->map = **map;
6237 memset(map_array, 0, sizeof(*map_array));
6239 mutex_unlock(&trace_eval_mutex);
6242 static void trace_create_eval_file(struct dentry *d_tracer)
6244 trace_create_file("eval_map", TRACE_MODE_READ, d_tracer,
6245 NULL, &tracing_eval_map_fops);
6248 #else /* CONFIG_TRACE_EVAL_MAP_FILE */
6249 static inline void trace_create_eval_file(struct dentry *d_tracer) { }
6250 static inline void trace_insert_eval_map_file(struct module *mod,
6251 struct trace_eval_map **start, int len) { }
6252 #endif /* !CONFIG_TRACE_EVAL_MAP_FILE */
6254 static void trace_insert_eval_map(struct module *mod,
6255 struct trace_eval_map **start, int len)
6257 struct trace_eval_map **map;
6264 trace_event_eval_update(map, len);
6266 trace_insert_eval_map_file(mod, start, len);
6270 tracing_set_trace_read(struct file *filp, char __user *ubuf,
6271 size_t cnt, loff_t *ppos)
6273 struct trace_array *tr = filp->private_data;
6274 char buf[MAX_TRACER_SIZE+2];
6277 mutex_lock(&trace_types_lock);
6278 r = sprintf(buf, "%s\n", tr->current_trace->name);
6279 mutex_unlock(&trace_types_lock);
6281 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6284 int tracer_init(struct tracer *t, struct trace_array *tr)
6286 tracing_reset_online_cpus(&tr->array_buffer);
6290 static void set_buffer_entries(struct array_buffer *buf, unsigned long val)
6294 for_each_tracing_cpu(cpu)
6295 per_cpu_ptr(buf->data, cpu)->entries = val;
6298 static void update_buffer_entries(struct array_buffer *buf, int cpu)
6300 if (cpu == RING_BUFFER_ALL_CPUS) {
6301 set_buffer_entries(buf, ring_buffer_size(buf->buffer, 0));
6303 per_cpu_ptr(buf->data, cpu)->entries = ring_buffer_size(buf->buffer, cpu);
6307 #ifdef CONFIG_TRACER_MAX_TRACE
6308 /* resize @tr's buffer to the size of @size_tr's entries */
6309 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
6310 struct array_buffer *size_buf, int cpu_id)
6314 if (cpu_id == RING_BUFFER_ALL_CPUS) {
6315 for_each_tracing_cpu(cpu) {
6316 ret = ring_buffer_resize(trace_buf->buffer,
6317 per_cpu_ptr(size_buf->data, cpu)->entries, cpu);
6320 per_cpu_ptr(trace_buf->data, cpu)->entries =
6321 per_cpu_ptr(size_buf->data, cpu)->entries;
6324 ret = ring_buffer_resize(trace_buf->buffer,
6325 per_cpu_ptr(size_buf->data, cpu_id)->entries, cpu_id);
6327 per_cpu_ptr(trace_buf->data, cpu_id)->entries =
6328 per_cpu_ptr(size_buf->data, cpu_id)->entries;
6333 #endif /* CONFIG_TRACER_MAX_TRACE */
6335 static int __tracing_resize_ring_buffer(struct trace_array *tr,
6336 unsigned long size, int cpu)
6341 * If kernel or user changes the size of the ring buffer
6342 * we use the size that was given, and we can forget about
6343 * expanding it later.
6345 trace_set_ring_buffer_expanded(tr);
6347 /* May be called before buffers are initialized */
6348 if (!tr->array_buffer.buffer)
6351 /* Do not allow tracing while resizing ring buffer */
6352 tracing_stop_tr(tr);
6354 ret = ring_buffer_resize(tr->array_buffer.buffer, size, cpu);
6358 #ifdef CONFIG_TRACER_MAX_TRACE
6359 if (!tr->allocated_snapshot)
6362 ret = ring_buffer_resize(tr->max_buffer.buffer, size, cpu);
6364 int r = resize_buffer_duplicate_size(&tr->array_buffer,
6365 &tr->array_buffer, cpu);
6368 * AARGH! We are left with different
6369 * size max buffer!!!!
6370 * The max buffer is our "snapshot" buffer.
6371 * When a tracer needs a snapshot (one of the
6372 * latency tracers), it swaps the max buffer
6373 * with the saved snap shot. We succeeded to
6374 * update the size of the main buffer, but failed to
6375 * update the size of the max buffer. But when we tried
6376 * to reset the main buffer to the original size, we
6377 * failed there too. This is very unlikely to
6378 * happen, but if it does, warn and kill all
6382 tracing_disabled = 1;
6387 update_buffer_entries(&tr->max_buffer, cpu);
6390 #endif /* CONFIG_TRACER_MAX_TRACE */
6392 update_buffer_entries(&tr->array_buffer, cpu);
6394 tracing_start_tr(tr);
6398 ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
6399 unsigned long size, int cpu_id)
6403 mutex_lock(&trace_types_lock);
6405 if (cpu_id != RING_BUFFER_ALL_CPUS) {
6406 /* make sure, this cpu is enabled in the mask */
6407 if (!cpumask_test_cpu(cpu_id, tracing_buffer_mask)) {
6413 ret = __tracing_resize_ring_buffer(tr, size, cpu_id);
6418 mutex_unlock(&trace_types_lock);
6425 * tracing_update_buffers - used by tracing facility to expand ring buffers
6426 * @tr: The tracing instance
6428 * To save on memory when the tracing is never used on a system with it
6429 * configured in. The ring buffers are set to a minimum size. But once
6430 * a user starts to use the tracing facility, then they need to grow
6431 * to their default size.
6433 * This function is to be called when a tracer is about to be used.
6435 int tracing_update_buffers(struct trace_array *tr)
6439 mutex_lock(&trace_types_lock);
6440 if (!tr->ring_buffer_expanded)
6441 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
6442 RING_BUFFER_ALL_CPUS);
6443 mutex_unlock(&trace_types_lock);
6448 struct trace_option_dentry;
6451 create_trace_option_files(struct trace_array *tr, struct tracer *tracer);
6454 * Used to clear out the tracer before deletion of an instance.
6455 * Must have trace_types_lock held.
6457 static void tracing_set_nop(struct trace_array *tr)
6459 if (tr->current_trace == &nop_trace)
6462 tr->current_trace->enabled--;
6464 if (tr->current_trace->reset)
6465 tr->current_trace->reset(tr);
6467 tr->current_trace = &nop_trace;
6470 static bool tracer_options_updated;
6472 static void add_tracer_options(struct trace_array *tr, struct tracer *t)
6474 /* Only enable if the directory has been created already. */
6478 /* Only create trace option files after update_tracer_options finish */
6479 if (!tracer_options_updated)
6482 create_trace_option_files(tr, t);
6485 int tracing_set_tracer(struct trace_array *tr, const char *buf)
6488 #ifdef CONFIG_TRACER_MAX_TRACE
6493 mutex_lock(&trace_types_lock);
6495 if (!tr->ring_buffer_expanded) {
6496 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
6497 RING_BUFFER_ALL_CPUS);
6503 for (t = trace_types; t; t = t->next) {
6504 if (strcmp(t->name, buf) == 0)
6511 if (t == tr->current_trace)
6514 #ifdef CONFIG_TRACER_SNAPSHOT
6515 if (t->use_max_tr) {
6516 local_irq_disable();
6517 arch_spin_lock(&tr->max_lock);
6518 if (tr->cond_snapshot)
6520 arch_spin_unlock(&tr->max_lock);
6526 /* Some tracers won't work on kernel command line */
6527 if (system_state < SYSTEM_RUNNING && t->noboot) {
6528 pr_warn("Tracer '%s' is not allowed on command line, ignored\n",
6533 /* Some tracers are only allowed for the top level buffer */
6534 if (!trace_ok_for_array(t, tr)) {
6539 /* If trace pipe files are being read, we can't change the tracer */
6540 if (tr->trace_ref) {
6545 trace_branch_disable();
6547 tr->current_trace->enabled--;
6549 if (tr->current_trace->reset)
6550 tr->current_trace->reset(tr);
6552 #ifdef CONFIG_TRACER_MAX_TRACE
6553 had_max_tr = tr->current_trace->use_max_tr;
6555 /* Current trace needs to be nop_trace before synchronize_rcu */
6556 tr->current_trace = &nop_trace;
6558 if (had_max_tr && !t->use_max_tr) {
6560 * We need to make sure that the update_max_tr sees that
6561 * current_trace changed to nop_trace to keep it from
6562 * swapping the buffers after we resize it.
6563 * The update_max_tr is called from interrupts disabled
6564 * so a synchronized_sched() is sufficient.
6570 if (t->use_max_tr && !tr->allocated_snapshot) {
6571 ret = tracing_alloc_snapshot_instance(tr);
6576 tr->current_trace = &nop_trace;
6580 ret = tracer_init(t, tr);
6585 tr->current_trace = t;
6586 tr->current_trace->enabled++;
6587 trace_branch_enable(tr);
6589 mutex_unlock(&trace_types_lock);
6595 tracing_set_trace_write(struct file *filp, const char __user *ubuf,
6596 size_t cnt, loff_t *ppos)
6598 struct trace_array *tr = filp->private_data;
6599 char buf[MAX_TRACER_SIZE+1];
6606 if (cnt > MAX_TRACER_SIZE)
6607 cnt = MAX_TRACER_SIZE;
6609 if (copy_from_user(buf, ubuf, cnt))
6616 err = tracing_set_tracer(tr, name);
6626 tracing_nsecs_read(unsigned long *ptr, char __user *ubuf,
6627 size_t cnt, loff_t *ppos)
6632 r = snprintf(buf, sizeof(buf), "%ld\n",
6633 *ptr == (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr));
6634 if (r > sizeof(buf))
6636 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6640 tracing_nsecs_write(unsigned long *ptr, const char __user *ubuf,
6641 size_t cnt, loff_t *ppos)
6646 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6656 tracing_thresh_read(struct file *filp, char __user *ubuf,
6657 size_t cnt, loff_t *ppos)
6659 return tracing_nsecs_read(&tracing_thresh, ubuf, cnt, ppos);
6663 tracing_thresh_write(struct file *filp, const char __user *ubuf,
6664 size_t cnt, loff_t *ppos)
6666 struct trace_array *tr = filp->private_data;
6669 mutex_lock(&trace_types_lock);
6670 ret = tracing_nsecs_write(&tracing_thresh, ubuf, cnt, ppos);
6674 if (tr->current_trace->update_thresh) {
6675 ret = tr->current_trace->update_thresh(tr);
6682 mutex_unlock(&trace_types_lock);
6687 #ifdef CONFIG_TRACER_MAX_TRACE
6690 tracing_max_lat_read(struct file *filp, char __user *ubuf,
6691 size_t cnt, loff_t *ppos)
6693 struct trace_array *tr = filp->private_data;
6695 return tracing_nsecs_read(&tr->max_latency, ubuf, cnt, ppos);
6699 tracing_max_lat_write(struct file *filp, const char __user *ubuf,
6700 size_t cnt, loff_t *ppos)
6702 struct trace_array *tr = filp->private_data;
6704 return tracing_nsecs_write(&tr->max_latency, ubuf, cnt, ppos);
6709 static int open_pipe_on_cpu(struct trace_array *tr, int cpu)
6711 if (cpu == RING_BUFFER_ALL_CPUS) {
6712 if (cpumask_empty(tr->pipe_cpumask)) {
6713 cpumask_setall(tr->pipe_cpumask);
6716 } else if (!cpumask_test_cpu(cpu, tr->pipe_cpumask)) {
6717 cpumask_set_cpu(cpu, tr->pipe_cpumask);
6723 static void close_pipe_on_cpu(struct trace_array *tr, int cpu)
6725 if (cpu == RING_BUFFER_ALL_CPUS) {
6726 WARN_ON(!cpumask_full(tr->pipe_cpumask));
6727 cpumask_clear(tr->pipe_cpumask);
6729 WARN_ON(!cpumask_test_cpu(cpu, tr->pipe_cpumask));
6730 cpumask_clear_cpu(cpu, tr->pipe_cpumask);
6734 static int tracing_open_pipe(struct inode *inode, struct file *filp)
6736 struct trace_array *tr = inode->i_private;
6737 struct trace_iterator *iter;
6741 ret = tracing_check_open_get_tr(tr);
6745 mutex_lock(&trace_types_lock);
6746 cpu = tracing_get_cpu(inode);
6747 ret = open_pipe_on_cpu(tr, cpu);
6749 goto fail_pipe_on_cpu;
6751 /* create a buffer to store the information to pass to userspace */
6752 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
6755 goto fail_alloc_iter;
6758 trace_seq_init(&iter->seq);
6759 iter->trace = tr->current_trace;
6761 if (!alloc_cpumask_var(&iter->started, GFP_KERNEL)) {
6766 /* trace pipe does not show start of buffer */
6767 cpumask_setall(iter->started);
6769 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
6770 iter->iter_flags |= TRACE_FILE_LAT_FMT;
6772 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
6773 if (trace_clocks[tr->clock_id].in_ns)
6774 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
6777 iter->array_buffer = &tr->array_buffer;
6778 iter->cpu_file = cpu;
6779 mutex_init(&iter->mutex);
6780 filp->private_data = iter;
6782 if (iter->trace->pipe_open)
6783 iter->trace->pipe_open(iter);
6785 nonseekable_open(inode, filp);
6789 mutex_unlock(&trace_types_lock);
6795 close_pipe_on_cpu(tr, cpu);
6797 __trace_array_put(tr);
6798 mutex_unlock(&trace_types_lock);
6802 static int tracing_release_pipe(struct inode *inode, struct file *file)
6804 struct trace_iterator *iter = file->private_data;
6805 struct trace_array *tr = inode->i_private;
6807 mutex_lock(&trace_types_lock);
6811 if (iter->trace->pipe_close)
6812 iter->trace->pipe_close(iter);
6813 close_pipe_on_cpu(tr, iter->cpu_file);
6814 mutex_unlock(&trace_types_lock);
6816 free_trace_iter_content(iter);
6819 trace_array_put(tr);
6825 trace_poll(struct trace_iterator *iter, struct file *filp, poll_table *poll_table)
6827 struct trace_array *tr = iter->tr;
6829 /* Iterators are static, they should be filled or empty */
6830 if (trace_buffer_iter(iter, iter->cpu_file))
6831 return EPOLLIN | EPOLLRDNORM;
6833 if (tr->trace_flags & TRACE_ITER_BLOCK)
6835 * Always select as readable when in blocking mode
6837 return EPOLLIN | EPOLLRDNORM;
6839 return ring_buffer_poll_wait(iter->array_buffer->buffer, iter->cpu_file,
6840 filp, poll_table, iter->tr->buffer_percent);
6844 tracing_poll_pipe(struct file *filp, poll_table *poll_table)
6846 struct trace_iterator *iter = filp->private_data;
6848 return trace_poll(iter, filp, poll_table);
6851 /* Must be called with iter->mutex held. */
6852 static int tracing_wait_pipe(struct file *filp)
6854 struct trace_iterator *iter = filp->private_data;
6857 while (trace_empty(iter)) {
6859 if ((filp->f_flags & O_NONBLOCK)) {
6864 * We block until we read something and tracing is disabled.
6865 * We still block if tracing is disabled, but we have never
6866 * read anything. This allows a user to cat this file, and
6867 * then enable tracing. But after we have read something,
6868 * we give an EOF when tracing is again disabled.
6870 * iter->pos will be 0 if we haven't read anything.
6872 if (!tracer_tracing_is_on(iter->tr) && iter->pos)
6875 mutex_unlock(&iter->mutex);
6877 ret = wait_on_pipe(iter, 0);
6879 mutex_lock(&iter->mutex);
6892 tracing_read_pipe(struct file *filp, char __user *ubuf,
6893 size_t cnt, loff_t *ppos)
6895 struct trace_iterator *iter = filp->private_data;
6899 * Avoid more than one consumer on a single file descriptor
6900 * This is just a matter of traces coherency, the ring buffer itself
6903 mutex_lock(&iter->mutex);
6905 /* return any leftover data */
6906 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6910 trace_seq_init(&iter->seq);
6912 if (iter->trace->read) {
6913 sret = iter->trace->read(iter, filp, ubuf, cnt, ppos);
6919 sret = tracing_wait_pipe(filp);
6923 /* stop when tracing is finished */
6924 if (trace_empty(iter)) {
6929 if (cnt >= PAGE_SIZE)
6930 cnt = PAGE_SIZE - 1;
6932 /* reset all but tr, trace, and overruns */
6933 trace_iterator_reset(iter);
6934 cpumask_clear(iter->started);
6935 trace_seq_init(&iter->seq);
6937 trace_event_read_lock();
6938 trace_access_lock(iter->cpu_file);
6939 while (trace_find_next_entry_inc(iter) != NULL) {
6940 enum print_line_t ret;
6941 int save_len = iter->seq.seq.len;
6943 ret = print_trace_line(iter);
6944 if (ret == TRACE_TYPE_PARTIAL_LINE) {
6946 * If one print_trace_line() fills entire trace_seq in one shot,
6947 * trace_seq_to_user() will returns -EBUSY because save_len == 0,
6948 * In this case, we need to consume it, otherwise, loop will peek
6949 * this event next time, resulting in an infinite loop.
6951 if (save_len == 0) {
6953 trace_seq_puts(&iter->seq, "[LINE TOO BIG]\n");
6954 trace_consume(iter);
6958 /* In other cases, don't print partial lines */
6959 iter->seq.seq.len = save_len;
6962 if (ret != TRACE_TYPE_NO_CONSUME)
6963 trace_consume(iter);
6965 if (trace_seq_used(&iter->seq) >= cnt)
6969 * Setting the full flag means we reached the trace_seq buffer
6970 * size and we should leave by partial output condition above.
6971 * One of the trace_seq_* functions is not used properly.
6973 WARN_ONCE(iter->seq.full, "full flag set for trace type %d",
6976 trace_access_unlock(iter->cpu_file);
6977 trace_event_read_unlock();
6979 /* Now copy what we have to the user */
6980 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6981 if (iter->seq.readpos >= trace_seq_used(&iter->seq))
6982 trace_seq_init(&iter->seq);
6985 * If there was nothing to send to user, in spite of consuming trace
6986 * entries, go back to wait for more entries.
6992 mutex_unlock(&iter->mutex);
6997 static void tracing_spd_release_pipe(struct splice_pipe_desc *spd,
7000 __free_page(spd->pages[idx]);
7004 tracing_fill_pipe_page(size_t rem, struct trace_iterator *iter)
7010 /* Seq buffer is page-sized, exactly what we need. */
7012 save_len = iter->seq.seq.len;
7013 ret = print_trace_line(iter);
7015 if (trace_seq_has_overflowed(&iter->seq)) {
7016 iter->seq.seq.len = save_len;
7021 * This should not be hit, because it should only
7022 * be set if the iter->seq overflowed. But check it
7023 * anyway to be safe.
7025 if (ret == TRACE_TYPE_PARTIAL_LINE) {
7026 iter->seq.seq.len = save_len;
7030 count = trace_seq_used(&iter->seq) - save_len;
7033 iter->seq.seq.len = save_len;
7037 if (ret != TRACE_TYPE_NO_CONSUME)
7038 trace_consume(iter);
7040 if (!trace_find_next_entry_inc(iter)) {
7050 static ssize_t tracing_splice_read_pipe(struct file *filp,
7052 struct pipe_inode_info *pipe,
7056 struct page *pages_def[PIPE_DEF_BUFFERS];
7057 struct partial_page partial_def[PIPE_DEF_BUFFERS];
7058 struct trace_iterator *iter = filp->private_data;
7059 struct splice_pipe_desc spd = {
7061 .partial = partial_def,
7062 .nr_pages = 0, /* This gets updated below. */
7063 .nr_pages_max = PIPE_DEF_BUFFERS,
7064 .ops = &default_pipe_buf_ops,
7065 .spd_release = tracing_spd_release_pipe,
7071 if (splice_grow_spd(pipe, &spd))
7074 mutex_lock(&iter->mutex);
7076 if (iter->trace->splice_read) {
7077 ret = iter->trace->splice_read(iter, filp,
7078 ppos, pipe, len, flags);
7083 ret = tracing_wait_pipe(filp);
7087 if (!iter->ent && !trace_find_next_entry_inc(iter)) {
7092 trace_event_read_lock();
7093 trace_access_lock(iter->cpu_file);
7095 /* Fill as many pages as possible. */
7096 for (i = 0, rem = len; i < spd.nr_pages_max && rem; i++) {
7097 spd.pages[i] = alloc_page(GFP_KERNEL);
7101 rem = tracing_fill_pipe_page(rem, iter);
7103 /* Copy the data into the page, so we can start over. */
7104 ret = trace_seq_to_buffer(&iter->seq,
7105 page_address(spd.pages[i]),
7106 trace_seq_used(&iter->seq));
7108 __free_page(spd.pages[i]);
7111 spd.partial[i].offset = 0;
7112 spd.partial[i].len = trace_seq_used(&iter->seq);
7114 trace_seq_init(&iter->seq);
7117 trace_access_unlock(iter->cpu_file);
7118 trace_event_read_unlock();
7119 mutex_unlock(&iter->mutex);
7124 ret = splice_to_pipe(pipe, &spd);
7128 splice_shrink_spd(&spd);
7132 mutex_unlock(&iter->mutex);
7137 tracing_entries_read(struct file *filp, char __user *ubuf,
7138 size_t cnt, loff_t *ppos)
7140 struct inode *inode = file_inode(filp);
7141 struct trace_array *tr = inode->i_private;
7142 int cpu = tracing_get_cpu(inode);
7147 mutex_lock(&trace_types_lock);
7149 if (cpu == RING_BUFFER_ALL_CPUS) {
7150 int cpu, buf_size_same;
7155 /* check if all cpu sizes are same */
7156 for_each_tracing_cpu(cpu) {
7157 /* fill in the size from first enabled cpu */
7159 size = per_cpu_ptr(tr->array_buffer.data, cpu)->entries;
7160 if (size != per_cpu_ptr(tr->array_buffer.data, cpu)->entries) {
7166 if (buf_size_same) {
7167 if (!tr->ring_buffer_expanded)
7168 r = sprintf(buf, "%lu (expanded: %lu)\n",
7170 trace_buf_size >> 10);
7172 r = sprintf(buf, "%lu\n", size >> 10);
7174 r = sprintf(buf, "X\n");
7176 r = sprintf(buf, "%lu\n", per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10);
7178 mutex_unlock(&trace_types_lock);
7180 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
7185 tracing_entries_write(struct file *filp, const char __user *ubuf,
7186 size_t cnt, loff_t *ppos)
7188 struct inode *inode = file_inode(filp);
7189 struct trace_array *tr = inode->i_private;
7193 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7197 /* must have at least 1 entry */
7201 /* value is in KB */
7203 ret = tracing_resize_ring_buffer(tr, val, tracing_get_cpu(inode));
7213 tracing_total_entries_read(struct file *filp, char __user *ubuf,
7214 size_t cnt, loff_t *ppos)
7216 struct trace_array *tr = filp->private_data;
7219 unsigned long size = 0, expanded_size = 0;
7221 mutex_lock(&trace_types_lock);
7222 for_each_tracing_cpu(cpu) {
7223 size += per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10;
7224 if (!tr->ring_buffer_expanded)
7225 expanded_size += trace_buf_size >> 10;
7227 if (tr->ring_buffer_expanded)
7228 r = sprintf(buf, "%lu\n", size);
7230 r = sprintf(buf, "%lu (expanded: %lu)\n", size, expanded_size);
7231 mutex_unlock(&trace_types_lock);
7233 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
7237 tracing_free_buffer_write(struct file *filp, const char __user *ubuf,
7238 size_t cnt, loff_t *ppos)
7241 * There is no need to read what the user has written, this function
7242 * is just to make sure that there is no error when "echo" is used
7251 tracing_free_buffer_release(struct inode *inode, struct file *filp)
7253 struct trace_array *tr = inode->i_private;
7255 /* disable tracing ? */
7256 if (tr->trace_flags & TRACE_ITER_STOP_ON_FREE)
7257 tracer_tracing_off(tr);
7258 /* resize the ring buffer to 0 */
7259 tracing_resize_ring_buffer(tr, 0, RING_BUFFER_ALL_CPUS);
7261 trace_array_put(tr);
7267 tracing_mark_write(struct file *filp, const char __user *ubuf,
7268 size_t cnt, loff_t *fpos)
7270 struct trace_array *tr = filp->private_data;
7271 struct ring_buffer_event *event;
7272 enum event_trigger_type tt = ETT_NONE;
7273 struct trace_buffer *buffer;
7274 struct print_entry *entry;
7279 /* Used in tracing_mark_raw_write() as well */
7280 #define FAULTED_STR "<faulted>"
7281 #define FAULTED_SIZE (sizeof(FAULTED_STR) - 1) /* '\0' is already accounted for */
7283 if (tracing_disabled)
7286 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
7289 if (cnt > TRACE_BUF_SIZE)
7290 cnt = TRACE_BUF_SIZE;
7292 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
7294 size = sizeof(*entry) + cnt + 2; /* add '\0' and possible '\n' */
7296 /* If less than "<faulted>", then make sure we can still add that */
7297 if (cnt < FAULTED_SIZE)
7298 size += FAULTED_SIZE - cnt;
7300 buffer = tr->array_buffer.buffer;
7301 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
7303 if (unlikely(!event))
7304 /* Ring buffer disabled, return as if not open for write */
7307 entry = ring_buffer_event_data(event);
7308 entry->ip = _THIS_IP_;
7310 len = __copy_from_user_inatomic(&entry->buf, ubuf, cnt);
7312 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
7318 if (tr->trace_marker_file && !list_empty(&tr->trace_marker_file->triggers)) {
7319 /* do not add \n before testing triggers, but add \0 */
7320 entry->buf[cnt] = '\0';
7321 tt = event_triggers_call(tr->trace_marker_file, buffer, entry, event);
7324 if (entry->buf[cnt - 1] != '\n') {
7325 entry->buf[cnt] = '\n';
7326 entry->buf[cnt + 1] = '\0';
7328 entry->buf[cnt] = '\0';
7330 if (static_branch_unlikely(&trace_marker_exports_enabled))
7331 ftrace_exports(event, TRACE_EXPORT_MARKER);
7332 __buffer_unlock_commit(buffer, event);
7335 event_triggers_post_call(tr->trace_marker_file, tt);
7340 /* Limit it for now to 3K (including tag) */
7341 #define RAW_DATA_MAX_SIZE (1024*3)
7344 tracing_mark_raw_write(struct file *filp, const char __user *ubuf,
7345 size_t cnt, loff_t *fpos)
7347 struct trace_array *tr = filp->private_data;
7348 struct ring_buffer_event *event;
7349 struct trace_buffer *buffer;
7350 struct raw_data_entry *entry;
7355 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
7357 if (tracing_disabled)
7360 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
7363 /* The marker must at least have a tag id */
7364 if (cnt < sizeof(unsigned int) || cnt > RAW_DATA_MAX_SIZE)
7367 if (cnt > TRACE_BUF_SIZE)
7368 cnt = TRACE_BUF_SIZE;
7370 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
7372 size = sizeof(*entry) + cnt;
7373 if (cnt < FAULT_SIZE_ID)
7374 size += FAULT_SIZE_ID - cnt;
7376 buffer = tr->array_buffer.buffer;
7377 event = __trace_buffer_lock_reserve(buffer, TRACE_RAW_DATA, size,
7380 /* Ring buffer disabled, return as if not open for write */
7383 entry = ring_buffer_event_data(event);
7385 len = __copy_from_user_inatomic(&entry->id, ubuf, cnt);
7388 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
7393 __buffer_unlock_commit(buffer, event);
7398 static int tracing_clock_show(struct seq_file *m, void *v)
7400 struct trace_array *tr = m->private;
7403 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++)
7405 "%s%s%s%s", i ? " " : "",
7406 i == tr->clock_id ? "[" : "", trace_clocks[i].name,
7407 i == tr->clock_id ? "]" : "");
7413 int tracing_set_clock(struct trace_array *tr, const char *clockstr)
7417 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++) {
7418 if (strcmp(trace_clocks[i].name, clockstr) == 0)
7421 if (i == ARRAY_SIZE(trace_clocks))
7424 mutex_lock(&trace_types_lock);
7428 ring_buffer_set_clock(tr->array_buffer.buffer, trace_clocks[i].func);
7431 * New clock may not be consistent with the previous clock.
7432 * Reset the buffer so that it doesn't have incomparable timestamps.
7434 tracing_reset_online_cpus(&tr->array_buffer);
7436 #ifdef CONFIG_TRACER_MAX_TRACE
7437 if (tr->max_buffer.buffer)
7438 ring_buffer_set_clock(tr->max_buffer.buffer, trace_clocks[i].func);
7439 tracing_reset_online_cpus(&tr->max_buffer);
7442 mutex_unlock(&trace_types_lock);
7447 static ssize_t tracing_clock_write(struct file *filp, const char __user *ubuf,
7448 size_t cnt, loff_t *fpos)
7450 struct seq_file *m = filp->private_data;
7451 struct trace_array *tr = m->private;
7453 const char *clockstr;
7456 if (cnt >= sizeof(buf))
7459 if (copy_from_user(buf, ubuf, cnt))
7464 clockstr = strstrip(buf);
7466 ret = tracing_set_clock(tr, clockstr);
7475 static int tracing_clock_open(struct inode *inode, struct file *file)
7477 struct trace_array *tr = inode->i_private;
7480 ret = tracing_check_open_get_tr(tr);
7484 ret = single_open(file, tracing_clock_show, inode->i_private);
7486 trace_array_put(tr);
7491 static int tracing_time_stamp_mode_show(struct seq_file *m, void *v)
7493 struct trace_array *tr = m->private;
7495 mutex_lock(&trace_types_lock);
7497 if (ring_buffer_time_stamp_abs(tr->array_buffer.buffer))
7498 seq_puts(m, "delta [absolute]\n");
7500 seq_puts(m, "[delta] absolute\n");
7502 mutex_unlock(&trace_types_lock);
7507 static int tracing_time_stamp_mode_open(struct inode *inode, struct file *file)
7509 struct trace_array *tr = inode->i_private;
7512 ret = tracing_check_open_get_tr(tr);
7516 ret = single_open(file, tracing_time_stamp_mode_show, inode->i_private);
7518 trace_array_put(tr);
7523 u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe)
7525 if (rbe == this_cpu_read(trace_buffered_event))
7526 return ring_buffer_time_stamp(buffer);
7528 return ring_buffer_event_time_stamp(buffer, rbe);
7532 * Set or disable using the per CPU trace_buffer_event when possible.
7534 int tracing_set_filter_buffering(struct trace_array *tr, bool set)
7538 mutex_lock(&trace_types_lock);
7540 if (set && tr->no_filter_buffering_ref++)
7544 if (WARN_ON_ONCE(!tr->no_filter_buffering_ref)) {
7549 --tr->no_filter_buffering_ref;
7552 mutex_unlock(&trace_types_lock);
7557 struct ftrace_buffer_info {
7558 struct trace_iterator iter;
7560 unsigned int spare_cpu;
7564 #ifdef CONFIG_TRACER_SNAPSHOT
7565 static int tracing_snapshot_open(struct inode *inode, struct file *file)
7567 struct trace_array *tr = inode->i_private;
7568 struct trace_iterator *iter;
7572 ret = tracing_check_open_get_tr(tr);
7576 if (file->f_mode & FMODE_READ) {
7577 iter = __tracing_open(inode, file, true);
7579 ret = PTR_ERR(iter);
7581 /* Writes still need the seq_file to hold the private data */
7583 m = kzalloc(sizeof(*m), GFP_KERNEL);
7586 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
7594 iter->array_buffer = &tr->max_buffer;
7595 iter->cpu_file = tracing_get_cpu(inode);
7597 file->private_data = m;
7601 trace_array_put(tr);
7606 static void tracing_swap_cpu_buffer(void *tr)
7608 update_max_tr_single((struct trace_array *)tr, current, smp_processor_id());
7612 tracing_snapshot_write(struct file *filp, const char __user *ubuf, size_t cnt,
7615 struct seq_file *m = filp->private_data;
7616 struct trace_iterator *iter = m->private;
7617 struct trace_array *tr = iter->tr;
7621 ret = tracing_update_buffers(tr);
7625 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7629 mutex_lock(&trace_types_lock);
7631 if (tr->current_trace->use_max_tr) {
7636 local_irq_disable();
7637 arch_spin_lock(&tr->max_lock);
7638 if (tr->cond_snapshot)
7640 arch_spin_unlock(&tr->max_lock);
7647 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7651 if (tr->allocated_snapshot)
7655 /* Only allow per-cpu swap if the ring buffer supports it */
7656 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
7657 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7662 if (tr->allocated_snapshot)
7663 ret = resize_buffer_duplicate_size(&tr->max_buffer,
7664 &tr->array_buffer, iter->cpu_file);
7666 ret = tracing_alloc_snapshot_instance(tr);
7669 /* Now, we're going to swap */
7670 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
7671 local_irq_disable();
7672 update_max_tr(tr, current, smp_processor_id(), NULL);
7675 smp_call_function_single(iter->cpu_file, tracing_swap_cpu_buffer,
7680 if (tr->allocated_snapshot) {
7681 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
7682 tracing_reset_online_cpus(&tr->max_buffer);
7684 tracing_reset_cpu(&tr->max_buffer, iter->cpu_file);
7694 mutex_unlock(&trace_types_lock);
7698 static int tracing_snapshot_release(struct inode *inode, struct file *file)
7700 struct seq_file *m = file->private_data;
7703 ret = tracing_release(inode, file);
7705 if (file->f_mode & FMODE_READ)
7708 /* If write only, the seq_file is just a stub */
7716 static int tracing_buffers_open(struct inode *inode, struct file *filp);
7717 static ssize_t tracing_buffers_read(struct file *filp, char __user *ubuf,
7718 size_t count, loff_t *ppos);
7719 static int tracing_buffers_release(struct inode *inode, struct file *file);
7720 static ssize_t tracing_buffers_splice_read(struct file *file, loff_t *ppos,
7721 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
7723 static int snapshot_raw_open(struct inode *inode, struct file *filp)
7725 struct ftrace_buffer_info *info;
7728 /* The following checks for tracefs lockdown */
7729 ret = tracing_buffers_open(inode, filp);
7733 info = filp->private_data;
7735 if (info->iter.trace->use_max_tr) {
7736 tracing_buffers_release(inode, filp);
7740 info->iter.snapshot = true;
7741 info->iter.array_buffer = &info->iter.tr->max_buffer;
7746 #endif /* CONFIG_TRACER_SNAPSHOT */
7749 static const struct file_operations tracing_thresh_fops = {
7750 .open = tracing_open_generic,
7751 .read = tracing_thresh_read,
7752 .write = tracing_thresh_write,
7753 .llseek = generic_file_llseek,
7756 #ifdef CONFIG_TRACER_MAX_TRACE
7757 static const struct file_operations tracing_max_lat_fops = {
7758 .open = tracing_open_generic_tr,
7759 .read = tracing_max_lat_read,
7760 .write = tracing_max_lat_write,
7761 .llseek = generic_file_llseek,
7762 .release = tracing_release_generic_tr,
7766 static const struct file_operations set_tracer_fops = {
7767 .open = tracing_open_generic_tr,
7768 .read = tracing_set_trace_read,
7769 .write = tracing_set_trace_write,
7770 .llseek = generic_file_llseek,
7771 .release = tracing_release_generic_tr,
7774 static const struct file_operations tracing_pipe_fops = {
7775 .open = tracing_open_pipe,
7776 .poll = tracing_poll_pipe,
7777 .read = tracing_read_pipe,
7778 .splice_read = tracing_splice_read_pipe,
7779 .release = tracing_release_pipe,
7780 .llseek = no_llseek,
7783 static const struct file_operations tracing_entries_fops = {
7784 .open = tracing_open_generic_tr,
7785 .read = tracing_entries_read,
7786 .write = tracing_entries_write,
7787 .llseek = generic_file_llseek,
7788 .release = tracing_release_generic_tr,
7791 static const struct file_operations tracing_total_entries_fops = {
7792 .open = tracing_open_generic_tr,
7793 .read = tracing_total_entries_read,
7794 .llseek = generic_file_llseek,
7795 .release = tracing_release_generic_tr,
7798 static const struct file_operations tracing_free_buffer_fops = {
7799 .open = tracing_open_generic_tr,
7800 .write = tracing_free_buffer_write,
7801 .release = tracing_free_buffer_release,
7804 static const struct file_operations tracing_mark_fops = {
7805 .open = tracing_mark_open,
7806 .write = tracing_mark_write,
7807 .release = tracing_release_generic_tr,
7810 static const struct file_operations tracing_mark_raw_fops = {
7811 .open = tracing_mark_open,
7812 .write = tracing_mark_raw_write,
7813 .release = tracing_release_generic_tr,
7816 static const struct file_operations trace_clock_fops = {
7817 .open = tracing_clock_open,
7819 .llseek = seq_lseek,
7820 .release = tracing_single_release_tr,
7821 .write = tracing_clock_write,
7824 static const struct file_operations trace_time_stamp_mode_fops = {
7825 .open = tracing_time_stamp_mode_open,
7827 .llseek = seq_lseek,
7828 .release = tracing_single_release_tr,
7831 #ifdef CONFIG_TRACER_SNAPSHOT
7832 static const struct file_operations snapshot_fops = {
7833 .open = tracing_snapshot_open,
7835 .write = tracing_snapshot_write,
7836 .llseek = tracing_lseek,
7837 .release = tracing_snapshot_release,
7840 static const struct file_operations snapshot_raw_fops = {
7841 .open = snapshot_raw_open,
7842 .read = tracing_buffers_read,
7843 .release = tracing_buffers_release,
7844 .splice_read = tracing_buffers_splice_read,
7845 .llseek = no_llseek,
7848 #endif /* CONFIG_TRACER_SNAPSHOT */
7851 * trace_min_max_write - Write a u64 value to a trace_min_max_param struct
7852 * @filp: The active open file structure
7853 * @ubuf: The userspace provided buffer to read value into
7854 * @cnt: The maximum number of bytes to read
7855 * @ppos: The current "file" position
7857 * This function implements the write interface for a struct trace_min_max_param.
7858 * The filp->private_data must point to a trace_min_max_param structure that
7859 * defines where to write the value, the min and the max acceptable values,
7860 * and a lock to protect the write.
7863 trace_min_max_write(struct file *filp, const char __user *ubuf, size_t cnt, loff_t *ppos)
7865 struct trace_min_max_param *param = filp->private_data;
7872 err = kstrtoull_from_user(ubuf, cnt, 10, &val);
7877 mutex_lock(param->lock);
7879 if (param->min && val < *param->min)
7882 if (param->max && val > *param->max)
7889 mutex_unlock(param->lock);
7898 * trace_min_max_read - Read a u64 value from a trace_min_max_param struct
7899 * @filp: The active open file structure
7900 * @ubuf: The userspace provided buffer to read value into
7901 * @cnt: The maximum number of bytes to read
7902 * @ppos: The current "file" position
7904 * This function implements the read interface for a struct trace_min_max_param.
7905 * The filp->private_data must point to a trace_min_max_param struct with valid
7909 trace_min_max_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
7911 struct trace_min_max_param *param = filp->private_data;
7912 char buf[U64_STR_SIZE];
7921 if (cnt > sizeof(buf))
7924 len = snprintf(buf, sizeof(buf), "%llu\n", val);
7926 return simple_read_from_buffer(ubuf, cnt, ppos, buf, len);
7929 const struct file_operations trace_min_max_fops = {
7930 .open = tracing_open_generic,
7931 .read = trace_min_max_read,
7932 .write = trace_min_max_write,
7935 #define TRACING_LOG_ERRS_MAX 8
7936 #define TRACING_LOG_LOC_MAX 128
7938 #define CMD_PREFIX " Command: "
7941 const char **errs; /* ptr to loc-specific array of err strings */
7942 u8 type; /* index into errs -> specific err string */
7943 u16 pos; /* caret position */
7947 struct tracing_log_err {
7948 struct list_head list;
7949 struct err_info info;
7950 char loc[TRACING_LOG_LOC_MAX]; /* err location */
7951 char *cmd; /* what caused err */
7954 static DEFINE_MUTEX(tracing_err_log_lock);
7956 static struct tracing_log_err *alloc_tracing_log_err(int len)
7958 struct tracing_log_err *err;
7960 err = kzalloc(sizeof(*err), GFP_KERNEL);
7962 return ERR_PTR(-ENOMEM);
7964 err->cmd = kzalloc(len, GFP_KERNEL);
7967 return ERR_PTR(-ENOMEM);
7973 static void free_tracing_log_err(struct tracing_log_err *err)
7979 static struct tracing_log_err *get_tracing_log_err(struct trace_array *tr,
7982 struct tracing_log_err *err;
7985 if (tr->n_err_log_entries < TRACING_LOG_ERRS_MAX) {
7986 err = alloc_tracing_log_err(len);
7987 if (PTR_ERR(err) != -ENOMEM)
7988 tr->n_err_log_entries++;
7992 cmd = kzalloc(len, GFP_KERNEL);
7994 return ERR_PTR(-ENOMEM);
7995 err = list_first_entry(&tr->err_log, struct tracing_log_err, list);
7998 list_del(&err->list);
8004 * err_pos - find the position of a string within a command for error careting
8005 * @cmd: The tracing command that caused the error
8006 * @str: The string to position the caret at within @cmd
8008 * Finds the position of the first occurrence of @str within @cmd. The
8009 * return value can be passed to tracing_log_err() for caret placement
8012 * Returns the index within @cmd of the first occurrence of @str or 0
8013 * if @str was not found.
8015 unsigned int err_pos(char *cmd, const char *str)
8019 if (WARN_ON(!strlen(cmd)))
8022 found = strstr(cmd, str);
8030 * tracing_log_err - write an error to the tracing error log
8031 * @tr: The associated trace array for the error (NULL for top level array)
8032 * @loc: A string describing where the error occurred
8033 * @cmd: The tracing command that caused the error
8034 * @errs: The array of loc-specific static error strings
8035 * @type: The index into errs[], which produces the specific static err string
8036 * @pos: The position the caret should be placed in the cmd
8038 * Writes an error into tracing/error_log of the form:
8040 * <loc>: error: <text>
8044 * tracing/error_log is a small log file containing the last
8045 * TRACING_LOG_ERRS_MAX errors (8). Memory for errors isn't allocated
8046 * unless there has been a tracing error, and the error log can be
8047 * cleared and have its memory freed by writing the empty string in
8048 * truncation mode to it i.e. echo > tracing/error_log.
8050 * NOTE: the @errs array along with the @type param are used to
8051 * produce a static error string - this string is not copied and saved
8052 * when the error is logged - only a pointer to it is saved. See
8053 * existing callers for examples of how static strings are typically
8054 * defined for use with tracing_log_err().
8056 void tracing_log_err(struct trace_array *tr,
8057 const char *loc, const char *cmd,
8058 const char **errs, u8 type, u16 pos)
8060 struct tracing_log_err *err;
8066 len += sizeof(CMD_PREFIX) + 2 * sizeof("\n") + strlen(cmd) + 1;
8068 mutex_lock(&tracing_err_log_lock);
8069 err = get_tracing_log_err(tr, len);
8070 if (PTR_ERR(err) == -ENOMEM) {
8071 mutex_unlock(&tracing_err_log_lock);
8075 snprintf(err->loc, TRACING_LOG_LOC_MAX, "%s: error: ", loc);
8076 snprintf(err->cmd, len, "\n" CMD_PREFIX "%s\n", cmd);
8078 err->info.errs = errs;
8079 err->info.type = type;
8080 err->info.pos = pos;
8081 err->info.ts = local_clock();
8083 list_add_tail(&err->list, &tr->err_log);
8084 mutex_unlock(&tracing_err_log_lock);
8087 static void clear_tracing_err_log(struct trace_array *tr)
8089 struct tracing_log_err *err, *next;
8091 mutex_lock(&tracing_err_log_lock);
8092 list_for_each_entry_safe(err, next, &tr->err_log, list) {
8093 list_del(&err->list);
8094 free_tracing_log_err(err);
8097 tr->n_err_log_entries = 0;
8098 mutex_unlock(&tracing_err_log_lock);
8101 static void *tracing_err_log_seq_start(struct seq_file *m, loff_t *pos)
8103 struct trace_array *tr = m->private;
8105 mutex_lock(&tracing_err_log_lock);
8107 return seq_list_start(&tr->err_log, *pos);
8110 static void *tracing_err_log_seq_next(struct seq_file *m, void *v, loff_t *pos)
8112 struct trace_array *tr = m->private;
8114 return seq_list_next(v, &tr->err_log, pos);
8117 static void tracing_err_log_seq_stop(struct seq_file *m, void *v)
8119 mutex_unlock(&tracing_err_log_lock);
8122 static void tracing_err_log_show_pos(struct seq_file *m, u16 pos)
8126 for (i = 0; i < sizeof(CMD_PREFIX) - 1; i++)
8128 for (i = 0; i < pos; i++)
8133 static int tracing_err_log_seq_show(struct seq_file *m, void *v)
8135 struct tracing_log_err *err = v;
8138 const char *err_text = err->info.errs[err->info.type];
8139 u64 sec = err->info.ts;
8142 nsec = do_div(sec, NSEC_PER_SEC);
8143 seq_printf(m, "[%5llu.%06u] %s%s", sec, nsec / 1000,
8144 err->loc, err_text);
8145 seq_printf(m, "%s", err->cmd);
8146 tracing_err_log_show_pos(m, err->info.pos);
8152 static const struct seq_operations tracing_err_log_seq_ops = {
8153 .start = tracing_err_log_seq_start,
8154 .next = tracing_err_log_seq_next,
8155 .stop = tracing_err_log_seq_stop,
8156 .show = tracing_err_log_seq_show
8159 static int tracing_err_log_open(struct inode *inode, struct file *file)
8161 struct trace_array *tr = inode->i_private;
8164 ret = tracing_check_open_get_tr(tr);
8168 /* If this file was opened for write, then erase contents */
8169 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC))
8170 clear_tracing_err_log(tr);
8172 if (file->f_mode & FMODE_READ) {
8173 ret = seq_open(file, &tracing_err_log_seq_ops);
8175 struct seq_file *m = file->private_data;
8178 trace_array_put(tr);
8184 static ssize_t tracing_err_log_write(struct file *file,
8185 const char __user *buffer,
8186 size_t count, loff_t *ppos)
8191 static int tracing_err_log_release(struct inode *inode, struct file *file)
8193 struct trace_array *tr = inode->i_private;
8195 trace_array_put(tr);
8197 if (file->f_mode & FMODE_READ)
8198 seq_release(inode, file);
8203 static const struct file_operations tracing_err_log_fops = {
8204 .open = tracing_err_log_open,
8205 .write = tracing_err_log_write,
8207 .llseek = tracing_lseek,
8208 .release = tracing_err_log_release,
8211 static int tracing_buffers_open(struct inode *inode, struct file *filp)
8213 struct trace_array *tr = inode->i_private;
8214 struct ftrace_buffer_info *info;
8217 ret = tracing_check_open_get_tr(tr);
8221 info = kvzalloc(sizeof(*info), GFP_KERNEL);
8223 trace_array_put(tr);
8227 mutex_lock(&trace_types_lock);
8230 info->iter.cpu_file = tracing_get_cpu(inode);
8231 info->iter.trace = tr->current_trace;
8232 info->iter.array_buffer = &tr->array_buffer;
8234 /* Force reading ring buffer for first read */
8235 info->read = (unsigned int)-1;
8237 filp->private_data = info;
8241 mutex_unlock(&trace_types_lock);
8243 ret = nonseekable_open(inode, filp);
8245 trace_array_put(tr);
8251 tracing_buffers_poll(struct file *filp, poll_table *poll_table)
8253 struct ftrace_buffer_info *info = filp->private_data;
8254 struct trace_iterator *iter = &info->iter;
8256 return trace_poll(iter, filp, poll_table);
8260 tracing_buffers_read(struct file *filp, char __user *ubuf,
8261 size_t count, loff_t *ppos)
8263 struct ftrace_buffer_info *info = filp->private_data;
8264 struct trace_iterator *iter = &info->iter;
8271 #ifdef CONFIG_TRACER_MAX_TRACE
8272 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
8277 info->spare = ring_buffer_alloc_read_page(iter->array_buffer->buffer,
8279 if (IS_ERR(info->spare)) {
8280 ret = PTR_ERR(info->spare);
8283 info->spare_cpu = iter->cpu_file;
8289 /* Do we have previous read data to read? */
8290 if (info->read < PAGE_SIZE)
8294 trace_access_lock(iter->cpu_file);
8295 ret = ring_buffer_read_page(iter->array_buffer->buffer,
8299 trace_access_unlock(iter->cpu_file);
8302 if (trace_empty(iter)) {
8303 if ((filp->f_flags & O_NONBLOCK))
8306 ret = wait_on_pipe(iter, 0);
8317 size = PAGE_SIZE - info->read;
8321 ret = copy_to_user(ubuf, info->spare + info->read, size);
8333 static int tracing_buffers_release(struct inode *inode, struct file *file)
8335 struct ftrace_buffer_info *info = file->private_data;
8336 struct trace_iterator *iter = &info->iter;
8338 mutex_lock(&trace_types_lock);
8340 iter->tr->trace_ref--;
8342 __trace_array_put(iter->tr);
8345 /* Make sure the waiters see the new wait_index */
8348 ring_buffer_wake_waiters(iter->array_buffer->buffer, iter->cpu_file);
8351 ring_buffer_free_read_page(iter->array_buffer->buffer,
8352 info->spare_cpu, info->spare);
8355 mutex_unlock(&trace_types_lock);
8361 struct trace_buffer *buffer;
8364 refcount_t refcount;
8367 static void buffer_ref_release(struct buffer_ref *ref)
8369 if (!refcount_dec_and_test(&ref->refcount))
8371 ring_buffer_free_read_page(ref->buffer, ref->cpu, ref->page);
8375 static void buffer_pipe_buf_release(struct pipe_inode_info *pipe,
8376 struct pipe_buffer *buf)
8378 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
8380 buffer_ref_release(ref);
8384 static bool buffer_pipe_buf_get(struct pipe_inode_info *pipe,
8385 struct pipe_buffer *buf)
8387 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
8389 if (refcount_read(&ref->refcount) > INT_MAX/2)
8392 refcount_inc(&ref->refcount);
8396 /* Pipe buffer operations for a buffer. */
8397 static const struct pipe_buf_operations buffer_pipe_buf_ops = {
8398 .release = buffer_pipe_buf_release,
8399 .get = buffer_pipe_buf_get,
8403 * Callback from splice_to_pipe(), if we need to release some pages
8404 * at the end of the spd in case we error'ed out in filling the pipe.
8406 static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)
8408 struct buffer_ref *ref =
8409 (struct buffer_ref *)spd->partial[i].private;
8411 buffer_ref_release(ref);
8412 spd->partial[i].private = 0;
8416 tracing_buffers_splice_read(struct file *file, loff_t *ppos,
8417 struct pipe_inode_info *pipe, size_t len,
8420 struct ftrace_buffer_info *info = file->private_data;
8421 struct trace_iterator *iter = &info->iter;
8422 struct partial_page partial_def[PIPE_DEF_BUFFERS];
8423 struct page *pages_def[PIPE_DEF_BUFFERS];
8424 struct splice_pipe_desc spd = {
8426 .partial = partial_def,
8427 .nr_pages_max = PIPE_DEF_BUFFERS,
8428 .ops = &buffer_pipe_buf_ops,
8429 .spd_release = buffer_spd_release,
8431 struct buffer_ref *ref;
8435 #ifdef CONFIG_TRACER_MAX_TRACE
8436 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
8440 if (*ppos & (PAGE_SIZE - 1))
8443 if (len & (PAGE_SIZE - 1)) {
8444 if (len < PAGE_SIZE)
8449 if (splice_grow_spd(pipe, &spd))
8453 trace_access_lock(iter->cpu_file);
8454 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8456 for (i = 0; i < spd.nr_pages_max && len && entries; i++, len -= PAGE_SIZE) {
8460 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
8466 refcount_set(&ref->refcount, 1);
8467 ref->buffer = iter->array_buffer->buffer;
8468 ref->page = ring_buffer_alloc_read_page(ref->buffer, iter->cpu_file);
8469 if (IS_ERR(ref->page)) {
8470 ret = PTR_ERR(ref->page);
8475 ref->cpu = iter->cpu_file;
8477 r = ring_buffer_read_page(ref->buffer, &ref->page,
8478 len, iter->cpu_file, 1);
8480 ring_buffer_free_read_page(ref->buffer, ref->cpu,
8486 page = virt_to_page(ref->page);
8488 spd.pages[i] = page;
8489 spd.partial[i].len = PAGE_SIZE;
8490 spd.partial[i].offset = 0;
8491 spd.partial[i].private = (unsigned long)ref;
8495 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8498 trace_access_unlock(iter->cpu_file);
8501 /* did we read anything? */
8502 if (!spd.nr_pages) {
8509 if ((file->f_flags & O_NONBLOCK) || (flags & SPLICE_F_NONBLOCK))
8512 wait_index = READ_ONCE(iter->wait_index);
8514 ret = wait_on_pipe(iter, iter->tr->buffer_percent);
8518 /* No need to wait after waking up when tracing is off */
8519 if (!tracer_tracing_is_on(iter->tr))
8522 /* Make sure we see the new wait_index */
8524 if (wait_index != iter->wait_index)
8530 ret = splice_to_pipe(pipe, &spd);
8532 splice_shrink_spd(&spd);
8537 /* An ioctl call with cmd 0 to the ring buffer file will wake up all waiters */
8538 static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
8540 struct ftrace_buffer_info *info = file->private_data;
8541 struct trace_iterator *iter = &info->iter;
8544 return -ENOIOCTLCMD;
8546 mutex_lock(&trace_types_lock);
8549 /* Make sure the waiters see the new wait_index */
8552 ring_buffer_wake_waiters(iter->array_buffer->buffer, iter->cpu_file);
8554 mutex_unlock(&trace_types_lock);
8558 static const struct file_operations tracing_buffers_fops = {
8559 .open = tracing_buffers_open,
8560 .read = tracing_buffers_read,
8561 .poll = tracing_buffers_poll,
8562 .release = tracing_buffers_release,
8563 .splice_read = tracing_buffers_splice_read,
8564 .unlocked_ioctl = tracing_buffers_ioctl,
8565 .llseek = no_llseek,
8569 tracing_stats_read(struct file *filp, char __user *ubuf,
8570 size_t count, loff_t *ppos)
8572 struct inode *inode = file_inode(filp);
8573 struct trace_array *tr = inode->i_private;
8574 struct array_buffer *trace_buf = &tr->array_buffer;
8575 int cpu = tracing_get_cpu(inode);
8576 struct trace_seq *s;
8578 unsigned long long t;
8579 unsigned long usec_rem;
8581 s = kmalloc(sizeof(*s), GFP_KERNEL);
8587 cnt = ring_buffer_entries_cpu(trace_buf->buffer, cpu);
8588 trace_seq_printf(s, "entries: %ld\n", cnt);
8590 cnt = ring_buffer_overrun_cpu(trace_buf->buffer, cpu);
8591 trace_seq_printf(s, "overrun: %ld\n", cnt);
8593 cnt = ring_buffer_commit_overrun_cpu(trace_buf->buffer, cpu);
8594 trace_seq_printf(s, "commit overrun: %ld\n", cnt);
8596 cnt = ring_buffer_bytes_cpu(trace_buf->buffer, cpu);
8597 trace_seq_printf(s, "bytes: %ld\n", cnt);
8599 if (trace_clocks[tr->clock_id].in_ns) {
8600 /* local or global for trace_clock */
8601 t = ns2usecs(ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8602 usec_rem = do_div(t, USEC_PER_SEC);
8603 trace_seq_printf(s, "oldest event ts: %5llu.%06lu\n",
8606 t = ns2usecs(ring_buffer_time_stamp(trace_buf->buffer));
8607 usec_rem = do_div(t, USEC_PER_SEC);
8608 trace_seq_printf(s, "now ts: %5llu.%06lu\n", t, usec_rem);
8610 /* counter or tsc mode for trace_clock */
8611 trace_seq_printf(s, "oldest event ts: %llu\n",
8612 ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8614 trace_seq_printf(s, "now ts: %llu\n",
8615 ring_buffer_time_stamp(trace_buf->buffer));
8618 cnt = ring_buffer_dropped_events_cpu(trace_buf->buffer, cpu);
8619 trace_seq_printf(s, "dropped events: %ld\n", cnt);
8621 cnt = ring_buffer_read_events_cpu(trace_buf->buffer, cpu);
8622 trace_seq_printf(s, "read events: %ld\n", cnt);
8624 count = simple_read_from_buffer(ubuf, count, ppos,
8625 s->buffer, trace_seq_used(s));
8632 static const struct file_operations tracing_stats_fops = {
8633 .open = tracing_open_generic_tr,
8634 .read = tracing_stats_read,
8635 .llseek = generic_file_llseek,
8636 .release = tracing_release_generic_tr,
8639 #ifdef CONFIG_DYNAMIC_FTRACE
8642 tracing_read_dyn_info(struct file *filp, char __user *ubuf,
8643 size_t cnt, loff_t *ppos)
8649 /* 256 should be plenty to hold the amount needed */
8650 buf = kmalloc(256, GFP_KERNEL);
8654 r = scnprintf(buf, 256, "%ld pages:%ld groups: %ld\n",
8655 ftrace_update_tot_cnt,
8656 ftrace_number_of_pages,
8657 ftrace_number_of_groups);
8659 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
8664 static const struct file_operations tracing_dyn_info_fops = {
8665 .open = tracing_open_generic,
8666 .read = tracing_read_dyn_info,
8667 .llseek = generic_file_llseek,
8669 #endif /* CONFIG_DYNAMIC_FTRACE */
8671 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
8673 ftrace_snapshot(unsigned long ip, unsigned long parent_ip,
8674 struct trace_array *tr, struct ftrace_probe_ops *ops,
8677 tracing_snapshot_instance(tr);
8681 ftrace_count_snapshot(unsigned long ip, unsigned long parent_ip,
8682 struct trace_array *tr, struct ftrace_probe_ops *ops,
8685 struct ftrace_func_mapper *mapper = data;
8689 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8699 tracing_snapshot_instance(tr);
8703 ftrace_snapshot_print(struct seq_file *m, unsigned long ip,
8704 struct ftrace_probe_ops *ops, void *data)
8706 struct ftrace_func_mapper *mapper = data;
8709 seq_printf(m, "%ps:", (void *)ip);
8711 seq_puts(m, "snapshot");
8714 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8717 seq_printf(m, ":count=%ld\n", *count);
8719 seq_puts(m, ":unlimited\n");
8725 ftrace_snapshot_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
8726 unsigned long ip, void *init_data, void **data)
8728 struct ftrace_func_mapper *mapper = *data;
8731 mapper = allocate_ftrace_func_mapper();
8737 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
8741 ftrace_snapshot_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
8742 unsigned long ip, void *data)
8744 struct ftrace_func_mapper *mapper = data;
8749 free_ftrace_func_mapper(mapper, NULL);
8753 ftrace_func_mapper_remove_ip(mapper, ip);
8756 static struct ftrace_probe_ops snapshot_probe_ops = {
8757 .func = ftrace_snapshot,
8758 .print = ftrace_snapshot_print,
8761 static struct ftrace_probe_ops snapshot_count_probe_ops = {
8762 .func = ftrace_count_snapshot,
8763 .print = ftrace_snapshot_print,
8764 .init = ftrace_snapshot_init,
8765 .free = ftrace_snapshot_free,
8769 ftrace_trace_snapshot_callback(struct trace_array *tr, struct ftrace_hash *hash,
8770 char *glob, char *cmd, char *param, int enable)
8772 struct ftrace_probe_ops *ops;
8773 void *count = (void *)-1;
8780 /* hash funcs only work with set_ftrace_filter */
8784 ops = param ? &snapshot_count_probe_ops : &snapshot_probe_ops;
8787 return unregister_ftrace_function_probe_func(glob+1, tr, ops);
8792 number = strsep(¶m, ":");
8794 if (!strlen(number))
8798 * We use the callback data field (which is a pointer)
8801 ret = kstrtoul(number, 0, (unsigned long *)&count);
8806 ret = tracing_alloc_snapshot_instance(tr);
8810 ret = register_ftrace_function_probe(glob, tr, ops, count);
8813 return ret < 0 ? ret : 0;
8816 static struct ftrace_func_command ftrace_snapshot_cmd = {
8818 .func = ftrace_trace_snapshot_callback,
8821 static __init int register_snapshot_cmd(void)
8823 return register_ftrace_command(&ftrace_snapshot_cmd);
8826 static inline __init int register_snapshot_cmd(void) { return 0; }
8827 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
8829 static struct dentry *tracing_get_dentry(struct trace_array *tr)
8831 if (WARN_ON(!tr->dir))
8832 return ERR_PTR(-ENODEV);
8834 /* Top directory uses NULL as the parent */
8835 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
8838 /* All sub buffers have a descriptor */
8842 static struct dentry *tracing_dentry_percpu(struct trace_array *tr, int cpu)
8844 struct dentry *d_tracer;
8847 return tr->percpu_dir;
8849 d_tracer = tracing_get_dentry(tr);
8850 if (IS_ERR(d_tracer))
8853 tr->percpu_dir = tracefs_create_dir("per_cpu", d_tracer);
8855 MEM_FAIL(!tr->percpu_dir,
8856 "Could not create tracefs directory 'per_cpu/%d'\n", cpu);
8858 return tr->percpu_dir;
8861 static struct dentry *
8862 trace_create_cpu_file(const char *name, umode_t mode, struct dentry *parent,
8863 void *data, long cpu, const struct file_operations *fops)
8865 struct dentry *ret = trace_create_file(name, mode, parent, data, fops);
8867 if (ret) /* See tracing_get_cpu() */
8868 d_inode(ret)->i_cdev = (void *)(cpu + 1);
8873 tracing_init_tracefs_percpu(struct trace_array *tr, long cpu)
8875 struct dentry *d_percpu = tracing_dentry_percpu(tr, cpu);
8876 struct dentry *d_cpu;
8877 char cpu_dir[30]; /* 30 characters should be more than enough */
8882 snprintf(cpu_dir, 30, "cpu%ld", cpu);
8883 d_cpu = tracefs_create_dir(cpu_dir, d_percpu);
8885 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir);
8889 /* per cpu trace_pipe */
8890 trace_create_cpu_file("trace_pipe", TRACE_MODE_READ, d_cpu,
8891 tr, cpu, &tracing_pipe_fops);
8894 trace_create_cpu_file("trace", TRACE_MODE_WRITE, d_cpu,
8895 tr, cpu, &tracing_fops);
8897 trace_create_cpu_file("trace_pipe_raw", TRACE_MODE_READ, d_cpu,
8898 tr, cpu, &tracing_buffers_fops);
8900 trace_create_cpu_file("stats", TRACE_MODE_READ, d_cpu,
8901 tr, cpu, &tracing_stats_fops);
8903 trace_create_cpu_file("buffer_size_kb", TRACE_MODE_READ, d_cpu,
8904 tr, cpu, &tracing_entries_fops);
8906 #ifdef CONFIG_TRACER_SNAPSHOT
8907 trace_create_cpu_file("snapshot", TRACE_MODE_WRITE, d_cpu,
8908 tr, cpu, &snapshot_fops);
8910 trace_create_cpu_file("snapshot_raw", TRACE_MODE_READ, d_cpu,
8911 tr, cpu, &snapshot_raw_fops);
8915 #ifdef CONFIG_FTRACE_SELFTEST
8916 /* Let selftest have access to static functions in this file */
8917 #include "trace_selftest.c"
8921 trace_options_read(struct file *filp, char __user *ubuf, size_t cnt,
8924 struct trace_option_dentry *topt = filp->private_data;
8927 if (topt->flags->val & topt->opt->bit)
8932 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
8936 trace_options_write(struct file *filp, const char __user *ubuf, size_t cnt,
8939 struct trace_option_dentry *topt = filp->private_data;
8943 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8947 if (val != 0 && val != 1)
8950 if (!!(topt->flags->val & topt->opt->bit) != val) {
8951 mutex_lock(&trace_types_lock);
8952 ret = __set_tracer_option(topt->tr, topt->flags,
8954 mutex_unlock(&trace_types_lock);
8964 static int tracing_open_options(struct inode *inode, struct file *filp)
8966 struct trace_option_dentry *topt = inode->i_private;
8969 ret = tracing_check_open_get_tr(topt->tr);
8973 filp->private_data = inode->i_private;
8977 static int tracing_release_options(struct inode *inode, struct file *file)
8979 struct trace_option_dentry *topt = file->private_data;
8981 trace_array_put(topt->tr);
8985 static const struct file_operations trace_options_fops = {
8986 .open = tracing_open_options,
8987 .read = trace_options_read,
8988 .write = trace_options_write,
8989 .llseek = generic_file_llseek,
8990 .release = tracing_release_options,
8994 * In order to pass in both the trace_array descriptor as well as the index
8995 * to the flag that the trace option file represents, the trace_array
8996 * has a character array of trace_flags_index[], which holds the index
8997 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
8998 * The address of this character array is passed to the flag option file
8999 * read/write callbacks.
9001 * In order to extract both the index and the trace_array descriptor,
9002 * get_tr_index() uses the following algorithm.
9006 * As the pointer itself contains the address of the index (remember
9009 * Then to get the trace_array descriptor, by subtracting that index
9010 * from the ptr, we get to the start of the index itself.
9012 * ptr - idx == &index[0]
9014 * Then a simple container_of() from that pointer gets us to the
9015 * trace_array descriptor.
9017 static void get_tr_index(void *data, struct trace_array **ptr,
9018 unsigned int *pindex)
9020 *pindex = *(unsigned char *)data;
9022 *ptr = container_of(data - *pindex, struct trace_array,
9027 trace_options_core_read(struct file *filp, char __user *ubuf, size_t cnt,
9030 void *tr_index = filp->private_data;
9031 struct trace_array *tr;
9035 get_tr_index(tr_index, &tr, &index);
9037 if (tr->trace_flags & (1 << index))
9042 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
9046 trace_options_core_write(struct file *filp, const char __user *ubuf, size_t cnt,
9049 void *tr_index = filp->private_data;
9050 struct trace_array *tr;
9055 get_tr_index(tr_index, &tr, &index);
9057 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9061 if (val != 0 && val != 1)
9064 mutex_lock(&event_mutex);
9065 mutex_lock(&trace_types_lock);
9066 ret = set_tracer_flag(tr, 1 << index, val);
9067 mutex_unlock(&trace_types_lock);
9068 mutex_unlock(&event_mutex);
9078 static const struct file_operations trace_options_core_fops = {
9079 .open = tracing_open_generic,
9080 .read = trace_options_core_read,
9081 .write = trace_options_core_write,
9082 .llseek = generic_file_llseek,
9085 struct dentry *trace_create_file(const char *name,
9087 struct dentry *parent,
9089 const struct file_operations *fops)
9093 ret = tracefs_create_file(name, mode, parent, data, fops);
9095 pr_warn("Could not create tracefs '%s' entry\n", name);
9101 static struct dentry *trace_options_init_dentry(struct trace_array *tr)
9103 struct dentry *d_tracer;
9108 d_tracer = tracing_get_dentry(tr);
9109 if (IS_ERR(d_tracer))
9112 tr->options = tracefs_create_dir("options", d_tracer);
9114 pr_warn("Could not create tracefs directory 'options'\n");
9122 create_trace_option_file(struct trace_array *tr,
9123 struct trace_option_dentry *topt,
9124 struct tracer_flags *flags,
9125 struct tracer_opt *opt)
9127 struct dentry *t_options;
9129 t_options = trace_options_init_dentry(tr);
9133 topt->flags = flags;
9137 topt->entry = trace_create_file(opt->name, TRACE_MODE_WRITE,
9138 t_options, topt, &trace_options_fops);
9143 create_trace_option_files(struct trace_array *tr, struct tracer *tracer)
9145 struct trace_option_dentry *topts;
9146 struct trace_options *tr_topts;
9147 struct tracer_flags *flags;
9148 struct tracer_opt *opts;
9155 flags = tracer->flags;
9157 if (!flags || !flags->opts)
9161 * If this is an instance, only create flags for tracers
9162 * the instance may have.
9164 if (!trace_ok_for_array(tracer, tr))
9167 for (i = 0; i < tr->nr_topts; i++) {
9168 /* Make sure there's no duplicate flags. */
9169 if (WARN_ON_ONCE(tr->topts[i].tracer->flags == tracer->flags))
9175 for (cnt = 0; opts[cnt].name; cnt++)
9178 topts = kcalloc(cnt + 1, sizeof(*topts), GFP_KERNEL);
9182 tr_topts = krealloc(tr->topts, sizeof(*tr->topts) * (tr->nr_topts + 1),
9189 tr->topts = tr_topts;
9190 tr->topts[tr->nr_topts].tracer = tracer;
9191 tr->topts[tr->nr_topts].topts = topts;
9194 for (cnt = 0; opts[cnt].name; cnt++) {
9195 create_trace_option_file(tr, &topts[cnt], flags,
9197 MEM_FAIL(topts[cnt].entry == NULL,
9198 "Failed to create trace option: %s",
9203 static struct dentry *
9204 create_trace_option_core_file(struct trace_array *tr,
9205 const char *option, long index)
9207 struct dentry *t_options;
9209 t_options = trace_options_init_dentry(tr);
9213 return trace_create_file(option, TRACE_MODE_WRITE, t_options,
9214 (void *)&tr->trace_flags_index[index],
9215 &trace_options_core_fops);
9218 static void create_trace_options_dir(struct trace_array *tr)
9220 struct dentry *t_options;
9221 bool top_level = tr == &global_trace;
9224 t_options = trace_options_init_dentry(tr);
9228 for (i = 0; trace_options[i]; i++) {
9230 !((1 << i) & TOP_LEVEL_TRACE_FLAGS))
9231 create_trace_option_core_file(tr, trace_options[i], i);
9236 rb_simple_read(struct file *filp, char __user *ubuf,
9237 size_t cnt, loff_t *ppos)
9239 struct trace_array *tr = filp->private_data;
9243 r = tracer_tracing_is_on(tr);
9244 r = sprintf(buf, "%d\n", r);
9246 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
9250 rb_simple_write(struct file *filp, const char __user *ubuf,
9251 size_t cnt, loff_t *ppos)
9253 struct trace_array *tr = filp->private_data;
9254 struct trace_buffer *buffer = tr->array_buffer.buffer;
9258 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9263 mutex_lock(&trace_types_lock);
9264 if (!!val == tracer_tracing_is_on(tr)) {
9265 val = 0; /* do nothing */
9267 tracer_tracing_on(tr);
9268 if (tr->current_trace->start)
9269 tr->current_trace->start(tr);
9271 tracer_tracing_off(tr);
9272 if (tr->current_trace->stop)
9273 tr->current_trace->stop(tr);
9274 /* Wake up any waiters */
9275 ring_buffer_wake_waiters(buffer, RING_BUFFER_ALL_CPUS);
9277 mutex_unlock(&trace_types_lock);
9285 static const struct file_operations rb_simple_fops = {
9286 .open = tracing_open_generic_tr,
9287 .read = rb_simple_read,
9288 .write = rb_simple_write,
9289 .release = tracing_release_generic_tr,
9290 .llseek = default_llseek,
9294 buffer_percent_read(struct file *filp, char __user *ubuf,
9295 size_t cnt, loff_t *ppos)
9297 struct trace_array *tr = filp->private_data;
9301 r = tr->buffer_percent;
9302 r = sprintf(buf, "%d\n", r);
9304 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
9308 buffer_percent_write(struct file *filp, const char __user *ubuf,
9309 size_t cnt, loff_t *ppos)
9311 struct trace_array *tr = filp->private_data;
9315 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
9322 tr->buffer_percent = val;
9329 static const struct file_operations buffer_percent_fops = {
9330 .open = tracing_open_generic_tr,
9331 .read = buffer_percent_read,
9332 .write = buffer_percent_write,
9333 .release = tracing_release_generic_tr,
9334 .llseek = default_llseek,
9337 static struct dentry *trace_instance_dir;
9340 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer);
9343 allocate_trace_buffer(struct trace_array *tr, struct array_buffer *buf, int size)
9345 enum ring_buffer_flags rb_flags;
9347 rb_flags = tr->trace_flags & TRACE_ITER_OVERWRITE ? RB_FL_OVERWRITE : 0;
9351 buf->buffer = ring_buffer_alloc(size, rb_flags);
9355 buf->data = alloc_percpu(struct trace_array_cpu);
9357 ring_buffer_free(buf->buffer);
9362 /* Allocate the first page for all buffers */
9363 set_buffer_entries(&tr->array_buffer,
9364 ring_buffer_size(tr->array_buffer.buffer, 0));
9369 static void free_trace_buffer(struct array_buffer *buf)
9372 ring_buffer_free(buf->buffer);
9374 free_percpu(buf->data);
9379 static int allocate_trace_buffers(struct trace_array *tr, int size)
9383 ret = allocate_trace_buffer(tr, &tr->array_buffer, size);
9387 #ifdef CONFIG_TRACER_MAX_TRACE
9388 ret = allocate_trace_buffer(tr, &tr->max_buffer,
9389 allocate_snapshot ? size : 1);
9390 if (MEM_FAIL(ret, "Failed to allocate trace buffer\n")) {
9391 free_trace_buffer(&tr->array_buffer);
9394 tr->allocated_snapshot = allocate_snapshot;
9396 allocate_snapshot = false;
9402 static void free_trace_buffers(struct trace_array *tr)
9407 free_trace_buffer(&tr->array_buffer);
9409 #ifdef CONFIG_TRACER_MAX_TRACE
9410 free_trace_buffer(&tr->max_buffer);
9414 static void init_trace_flags_index(struct trace_array *tr)
9418 /* Used by the trace options files */
9419 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++)
9420 tr->trace_flags_index[i] = i;
9423 static void __update_tracer_options(struct trace_array *tr)
9427 for (t = trace_types; t; t = t->next)
9428 add_tracer_options(tr, t);
9431 static void update_tracer_options(struct trace_array *tr)
9433 mutex_lock(&trace_types_lock);
9434 tracer_options_updated = true;
9435 __update_tracer_options(tr);
9436 mutex_unlock(&trace_types_lock);
9439 /* Must have trace_types_lock held */
9440 struct trace_array *trace_array_find(const char *instance)
9442 struct trace_array *tr, *found = NULL;
9444 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9445 if (tr->name && strcmp(tr->name, instance) == 0) {
9454 struct trace_array *trace_array_find_get(const char *instance)
9456 struct trace_array *tr;
9458 mutex_lock(&trace_types_lock);
9459 tr = trace_array_find(instance);
9462 mutex_unlock(&trace_types_lock);
9467 static int trace_array_create_dir(struct trace_array *tr)
9471 tr->dir = tracefs_create_dir(tr->name, trace_instance_dir);
9475 ret = event_trace_add_tracer(tr->dir, tr);
9477 tracefs_remove(tr->dir);
9481 init_tracer_tracefs(tr, tr->dir);
9482 __update_tracer_options(tr);
9487 static struct trace_array *trace_array_create(const char *name)
9489 struct trace_array *tr;
9493 tr = kzalloc(sizeof(*tr), GFP_KERNEL);
9495 return ERR_PTR(ret);
9497 tr->name = kstrdup(name, GFP_KERNEL);
9501 if (!alloc_cpumask_var(&tr->tracing_cpumask, GFP_KERNEL))
9504 if (!zalloc_cpumask_var(&tr->pipe_cpumask, GFP_KERNEL))
9507 tr->trace_flags = global_trace.trace_flags & ~ZEROED_TRACE_FLAGS;
9509 cpumask_copy(tr->tracing_cpumask, cpu_all_mask);
9511 raw_spin_lock_init(&tr->start_lock);
9513 tr->max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
9515 tr->current_trace = &nop_trace;
9517 INIT_LIST_HEAD(&tr->systems);
9518 INIT_LIST_HEAD(&tr->events);
9519 INIT_LIST_HEAD(&tr->hist_vars);
9520 INIT_LIST_HEAD(&tr->err_log);
9522 if (allocate_trace_buffers(tr, trace_buf_size) < 0)
9525 /* The ring buffer is defaultly expanded */
9526 trace_set_ring_buffer_expanded(tr);
9528 if (ftrace_allocate_ftrace_ops(tr) < 0)
9531 ftrace_init_trace_array(tr);
9533 init_trace_flags_index(tr);
9535 if (trace_instance_dir) {
9536 ret = trace_array_create_dir(tr);
9540 __trace_early_add_events(tr);
9542 list_add(&tr->list, &ftrace_trace_arrays);
9549 ftrace_free_ftrace_ops(tr);
9550 free_trace_buffers(tr);
9551 free_cpumask_var(tr->pipe_cpumask);
9552 free_cpumask_var(tr->tracing_cpumask);
9556 return ERR_PTR(ret);
9559 static int instance_mkdir(const char *name)
9561 struct trace_array *tr;
9564 mutex_lock(&event_mutex);
9565 mutex_lock(&trace_types_lock);
9568 if (trace_array_find(name))
9571 tr = trace_array_create(name);
9573 ret = PTR_ERR_OR_ZERO(tr);
9576 mutex_unlock(&trace_types_lock);
9577 mutex_unlock(&event_mutex);
9582 * trace_array_get_by_name - Create/Lookup a trace array, given its name.
9583 * @name: The name of the trace array to be looked up/created.
9585 * Returns pointer to trace array with given name.
9586 * NULL, if it cannot be created.
9588 * NOTE: This function increments the reference counter associated with the
9589 * trace array returned. This makes sure it cannot be freed while in use.
9590 * Use trace_array_put() once the trace array is no longer needed.
9591 * If the trace_array is to be freed, trace_array_destroy() needs to
9592 * be called after the trace_array_put(), or simply let user space delete
9593 * it from the tracefs instances directory. But until the
9594 * trace_array_put() is called, user space can not delete it.
9597 struct trace_array *trace_array_get_by_name(const char *name)
9599 struct trace_array *tr;
9601 mutex_lock(&event_mutex);
9602 mutex_lock(&trace_types_lock);
9604 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9605 if (tr->name && strcmp(tr->name, name) == 0)
9609 tr = trace_array_create(name);
9617 mutex_unlock(&trace_types_lock);
9618 mutex_unlock(&event_mutex);
9621 EXPORT_SYMBOL_GPL(trace_array_get_by_name);
9623 static int __remove_instance(struct trace_array *tr)
9627 /* Reference counter for a newly created trace array = 1. */
9628 if (tr->ref > 1 || (tr->current_trace && tr->trace_ref))
9631 list_del(&tr->list);
9633 /* Disable all the flags that were enabled coming in */
9634 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++) {
9635 if ((1 << i) & ZEROED_TRACE_FLAGS)
9636 set_tracer_flag(tr, 1 << i, 0);
9639 tracing_set_nop(tr);
9640 clear_ftrace_function_probes(tr);
9641 event_trace_del_tracer(tr);
9642 ftrace_clear_pids(tr);
9643 ftrace_destroy_function_files(tr);
9644 tracefs_remove(tr->dir);
9645 free_percpu(tr->last_func_repeats);
9646 free_trace_buffers(tr);
9647 clear_tracing_err_log(tr);
9649 for (i = 0; i < tr->nr_topts; i++) {
9650 kfree(tr->topts[i].topts);
9654 free_cpumask_var(tr->pipe_cpumask);
9655 free_cpumask_var(tr->tracing_cpumask);
9662 int trace_array_destroy(struct trace_array *this_tr)
9664 struct trace_array *tr;
9670 mutex_lock(&event_mutex);
9671 mutex_lock(&trace_types_lock);
9675 /* Making sure trace array exists before destroying it. */
9676 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9677 if (tr == this_tr) {
9678 ret = __remove_instance(tr);
9683 mutex_unlock(&trace_types_lock);
9684 mutex_unlock(&event_mutex);
9688 EXPORT_SYMBOL_GPL(trace_array_destroy);
9690 static int instance_rmdir(const char *name)
9692 struct trace_array *tr;
9695 mutex_lock(&event_mutex);
9696 mutex_lock(&trace_types_lock);
9699 tr = trace_array_find(name);
9701 ret = __remove_instance(tr);
9703 mutex_unlock(&trace_types_lock);
9704 mutex_unlock(&event_mutex);
9709 static __init void create_trace_instances(struct dentry *d_tracer)
9711 struct trace_array *tr;
9713 trace_instance_dir = tracefs_create_instance_dir("instances", d_tracer,
9716 if (MEM_FAIL(!trace_instance_dir, "Failed to create instances directory\n"))
9719 mutex_lock(&event_mutex);
9720 mutex_lock(&trace_types_lock);
9722 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9725 if (MEM_FAIL(trace_array_create_dir(tr) < 0,
9726 "Failed to create instance directory\n"))
9730 mutex_unlock(&trace_types_lock);
9731 mutex_unlock(&event_mutex);
9735 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer)
9739 trace_create_file("available_tracers", TRACE_MODE_READ, d_tracer,
9740 tr, &show_traces_fops);
9742 trace_create_file("current_tracer", TRACE_MODE_WRITE, d_tracer,
9743 tr, &set_tracer_fops);
9745 trace_create_file("tracing_cpumask", TRACE_MODE_WRITE, d_tracer,
9746 tr, &tracing_cpumask_fops);
9748 trace_create_file("trace_options", TRACE_MODE_WRITE, d_tracer,
9749 tr, &tracing_iter_fops);
9751 trace_create_file("trace", TRACE_MODE_WRITE, d_tracer,
9754 trace_create_file("trace_pipe", TRACE_MODE_READ, d_tracer,
9755 tr, &tracing_pipe_fops);
9757 trace_create_file("buffer_size_kb", TRACE_MODE_WRITE, d_tracer,
9758 tr, &tracing_entries_fops);
9760 trace_create_file("buffer_total_size_kb", TRACE_MODE_READ, d_tracer,
9761 tr, &tracing_total_entries_fops);
9763 trace_create_file("free_buffer", 0200, d_tracer,
9764 tr, &tracing_free_buffer_fops);
9766 trace_create_file("trace_marker", 0220, d_tracer,
9767 tr, &tracing_mark_fops);
9769 tr->trace_marker_file = __find_event_file(tr, "ftrace", "print");
9771 trace_create_file("trace_marker_raw", 0220, d_tracer,
9772 tr, &tracing_mark_raw_fops);
9774 trace_create_file("trace_clock", TRACE_MODE_WRITE, d_tracer, tr,
9777 trace_create_file("tracing_on", TRACE_MODE_WRITE, d_tracer,
9778 tr, &rb_simple_fops);
9780 trace_create_file("timestamp_mode", TRACE_MODE_READ, d_tracer, tr,
9781 &trace_time_stamp_mode_fops);
9783 tr->buffer_percent = 50;
9785 trace_create_file("buffer_percent", TRACE_MODE_WRITE, d_tracer,
9786 tr, &buffer_percent_fops);
9788 create_trace_options_dir(tr);
9790 #ifdef CONFIG_TRACER_MAX_TRACE
9791 trace_create_maxlat_file(tr, d_tracer);
9794 if (ftrace_create_function_files(tr, d_tracer))
9795 MEM_FAIL(1, "Could not allocate function filter files");
9797 #ifdef CONFIG_TRACER_SNAPSHOT
9798 trace_create_file("snapshot", TRACE_MODE_WRITE, d_tracer,
9799 tr, &snapshot_fops);
9802 trace_create_file("error_log", TRACE_MODE_WRITE, d_tracer,
9803 tr, &tracing_err_log_fops);
9805 for_each_tracing_cpu(cpu)
9806 tracing_init_tracefs_percpu(tr, cpu);
9808 ftrace_init_tracefs(tr, d_tracer);
9811 static struct vfsmount *trace_automount(struct dentry *mntpt, void *ingore)
9813 struct vfsmount *mnt;
9814 struct file_system_type *type;
9817 * To maintain backward compatibility for tools that mount
9818 * debugfs to get to the tracing facility, tracefs is automatically
9819 * mounted to the debugfs/tracing directory.
9821 type = get_fs_type("tracefs");
9824 mnt = vfs_submount(mntpt, type, "tracefs", NULL);
9825 put_filesystem(type);
9834 * tracing_init_dentry - initialize top level trace array
9836 * This is called when creating files or directories in the tracing
9837 * directory. It is called via fs_initcall() by any of the boot up code
9838 * and expects to return the dentry of the top level tracing directory.
9840 int tracing_init_dentry(void)
9842 struct trace_array *tr = &global_trace;
9844 if (security_locked_down(LOCKDOWN_TRACEFS)) {
9845 pr_warn("Tracing disabled due to lockdown\n");
9849 /* The top level trace array uses NULL as parent */
9853 if (WARN_ON(!tracefs_initialized()))
9857 * As there may still be users that expect the tracing
9858 * files to exist in debugfs/tracing, we must automount
9859 * the tracefs file system there, so older tools still
9860 * work with the newer kernel.
9862 tr->dir = debugfs_create_automount("tracing", NULL,
9863 trace_automount, NULL);
9868 extern struct trace_eval_map *__start_ftrace_eval_maps[];
9869 extern struct trace_eval_map *__stop_ftrace_eval_maps[];
9871 static struct workqueue_struct *eval_map_wq __initdata;
9872 static struct work_struct eval_map_work __initdata;
9873 static struct work_struct tracerfs_init_work __initdata;
9875 static void __init eval_map_work_func(struct work_struct *work)
9879 len = __stop_ftrace_eval_maps - __start_ftrace_eval_maps;
9880 trace_insert_eval_map(NULL, __start_ftrace_eval_maps, len);
9883 static int __init trace_eval_init(void)
9885 INIT_WORK(&eval_map_work, eval_map_work_func);
9887 eval_map_wq = alloc_workqueue("eval_map_wq", WQ_UNBOUND, 0);
9889 pr_err("Unable to allocate eval_map_wq\n");
9891 eval_map_work_func(&eval_map_work);
9895 queue_work(eval_map_wq, &eval_map_work);
9899 subsys_initcall(trace_eval_init);
9901 static int __init trace_eval_sync(void)
9903 /* Make sure the eval map updates are finished */
9905 destroy_workqueue(eval_map_wq);
9909 late_initcall_sync(trace_eval_sync);
9912 #ifdef CONFIG_MODULES
9913 static void trace_module_add_evals(struct module *mod)
9915 if (!mod->num_trace_evals)
9919 * Modules with bad taint do not have events created, do
9920 * not bother with enums either.
9922 if (trace_module_has_bad_taint(mod))
9925 trace_insert_eval_map(mod, mod->trace_evals, mod->num_trace_evals);
9928 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
9929 static void trace_module_remove_evals(struct module *mod)
9931 union trace_eval_map_item *map;
9932 union trace_eval_map_item **last = &trace_eval_maps;
9934 if (!mod->num_trace_evals)
9937 mutex_lock(&trace_eval_mutex);
9939 map = trace_eval_maps;
9942 if (map->head.mod == mod)
9944 map = trace_eval_jmp_to_tail(map);
9945 last = &map->tail.next;
9946 map = map->tail.next;
9951 *last = trace_eval_jmp_to_tail(map)->tail.next;
9954 mutex_unlock(&trace_eval_mutex);
9957 static inline void trace_module_remove_evals(struct module *mod) { }
9958 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
9960 static int trace_module_notify(struct notifier_block *self,
9961 unsigned long val, void *data)
9963 struct module *mod = data;
9966 case MODULE_STATE_COMING:
9967 trace_module_add_evals(mod);
9969 case MODULE_STATE_GOING:
9970 trace_module_remove_evals(mod);
9977 static struct notifier_block trace_module_nb = {
9978 .notifier_call = trace_module_notify,
9981 #endif /* CONFIG_MODULES */
9983 static __init void tracer_init_tracefs_work_func(struct work_struct *work)
9988 init_tracer_tracefs(&global_trace, NULL);
9989 ftrace_init_tracefs_toplevel(&global_trace, NULL);
9991 trace_create_file("tracing_thresh", TRACE_MODE_WRITE, NULL,
9992 &global_trace, &tracing_thresh_fops);
9994 trace_create_file("README", TRACE_MODE_READ, NULL,
9995 NULL, &tracing_readme_fops);
9997 trace_create_file("saved_cmdlines", TRACE_MODE_READ, NULL,
9998 NULL, &tracing_saved_cmdlines_fops);
10000 trace_create_file("saved_cmdlines_size", TRACE_MODE_WRITE, NULL,
10001 NULL, &tracing_saved_cmdlines_size_fops);
10003 trace_create_file("saved_tgids", TRACE_MODE_READ, NULL,
10004 NULL, &tracing_saved_tgids_fops);
10006 trace_create_eval_file(NULL);
10008 #ifdef CONFIG_MODULES
10009 register_module_notifier(&trace_module_nb);
10012 #ifdef CONFIG_DYNAMIC_FTRACE
10013 trace_create_file("dyn_ftrace_total_info", TRACE_MODE_READ, NULL,
10014 NULL, &tracing_dyn_info_fops);
10017 create_trace_instances(NULL);
10019 update_tracer_options(&global_trace);
10022 static __init int tracer_init_tracefs(void)
10026 trace_access_lock_init();
10028 ret = tracing_init_dentry();
10033 INIT_WORK(&tracerfs_init_work, tracer_init_tracefs_work_func);
10034 queue_work(eval_map_wq, &tracerfs_init_work);
10036 tracer_init_tracefs_work_func(NULL);
10039 rv_init_interface();
10044 fs_initcall(tracer_init_tracefs);
10046 static int trace_die_panic_handler(struct notifier_block *self,
10047 unsigned long ev, void *unused);
10049 static struct notifier_block trace_panic_notifier = {
10050 .notifier_call = trace_die_panic_handler,
10051 .priority = INT_MAX - 1,
10054 static struct notifier_block trace_die_notifier = {
10055 .notifier_call = trace_die_panic_handler,
10056 .priority = INT_MAX - 1,
10060 * The idea is to execute the following die/panic callback early, in order
10061 * to avoid showing irrelevant information in the trace (like other panic
10062 * notifier functions); we are the 2nd to run, after hung_task/rcu_stall
10063 * warnings get disabled (to prevent potential log flooding).
10065 static int trace_die_panic_handler(struct notifier_block *self,
10066 unsigned long ev, void *unused)
10068 if (!ftrace_dump_on_oops)
10069 return NOTIFY_DONE;
10071 /* The die notifier requires DIE_OOPS to trigger */
10072 if (self == &trace_die_notifier && ev != DIE_OOPS)
10073 return NOTIFY_DONE;
10075 ftrace_dump(ftrace_dump_on_oops);
10077 return NOTIFY_DONE;
10081 * printk is set to max of 1024, we really don't need it that big.
10082 * Nothing should be printing 1000 characters anyway.
10084 #define TRACE_MAX_PRINT 1000
10087 * Define here KERN_TRACE so that we have one place to modify
10088 * it if we decide to change what log level the ftrace dump
10091 #define KERN_TRACE KERN_EMERG
10094 trace_printk_seq(struct trace_seq *s)
10096 /* Probably should print a warning here. */
10097 if (s->seq.len >= TRACE_MAX_PRINT)
10098 s->seq.len = TRACE_MAX_PRINT;
10101 * More paranoid code. Although the buffer size is set to
10102 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
10103 * an extra layer of protection.
10105 if (WARN_ON_ONCE(s->seq.len >= s->seq.size))
10106 s->seq.len = s->seq.size - 1;
10108 /* should be zero ended, but we are paranoid. */
10109 s->buffer[s->seq.len] = 0;
10111 printk(KERN_TRACE "%s", s->buffer);
10116 void trace_init_global_iter(struct trace_iterator *iter)
10118 iter->tr = &global_trace;
10119 iter->trace = iter->tr->current_trace;
10120 iter->cpu_file = RING_BUFFER_ALL_CPUS;
10121 iter->array_buffer = &global_trace.array_buffer;
10123 if (iter->trace && iter->trace->open)
10124 iter->trace->open(iter);
10126 /* Annotate start of buffers if we had overruns */
10127 if (ring_buffer_overruns(iter->array_buffer->buffer))
10128 iter->iter_flags |= TRACE_FILE_ANNOTATE;
10130 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
10131 if (trace_clocks[iter->tr->clock_id].in_ns)
10132 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
10134 /* Can not use kmalloc for iter.temp and iter.fmt */
10135 iter->temp = static_temp_buf;
10136 iter->temp_size = STATIC_TEMP_BUF_SIZE;
10137 iter->fmt = static_fmt_buf;
10138 iter->fmt_size = STATIC_FMT_BUF_SIZE;
10141 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode)
10143 /* use static because iter can be a bit big for the stack */
10144 static struct trace_iterator iter;
10145 static atomic_t dump_running;
10146 struct trace_array *tr = &global_trace;
10147 unsigned int old_userobj;
10148 unsigned long flags;
10151 /* Only allow one dump user at a time. */
10152 if (atomic_inc_return(&dump_running) != 1) {
10153 atomic_dec(&dump_running);
10158 * Always turn off tracing when we dump.
10159 * We don't need to show trace output of what happens
10160 * between multiple crashes.
10162 * If the user does a sysrq-z, then they can re-enable
10163 * tracing with echo 1 > tracing_on.
10167 local_irq_save(flags);
10169 /* Simulate the iterator */
10170 trace_init_global_iter(&iter);
10172 for_each_tracing_cpu(cpu) {
10173 atomic_inc(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
10176 old_userobj = tr->trace_flags & TRACE_ITER_SYM_USEROBJ;
10178 /* don't look at user memory in panic mode */
10179 tr->trace_flags &= ~TRACE_ITER_SYM_USEROBJ;
10181 switch (oops_dump_mode) {
10183 iter.cpu_file = RING_BUFFER_ALL_CPUS;
10186 iter.cpu_file = raw_smp_processor_id();
10191 printk(KERN_TRACE "Bad dumping mode, switching to all CPUs dump\n");
10192 iter.cpu_file = RING_BUFFER_ALL_CPUS;
10195 printk(KERN_TRACE "Dumping ftrace buffer:\n");
10197 /* Did function tracer already get disabled? */
10198 if (ftrace_is_dead()) {
10199 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
10200 printk("# MAY BE MISSING FUNCTION EVENTS\n");
10204 * We need to stop all tracing on all CPUS to read
10205 * the next buffer. This is a bit expensive, but is
10206 * not done often. We fill all what we can read,
10207 * and then release the locks again.
10210 while (!trace_empty(&iter)) {
10213 printk(KERN_TRACE "---------------------------------\n");
10217 trace_iterator_reset(&iter);
10218 iter.iter_flags |= TRACE_FILE_LAT_FMT;
10220 if (trace_find_next_entry_inc(&iter) != NULL) {
10223 ret = print_trace_line(&iter);
10224 if (ret != TRACE_TYPE_NO_CONSUME)
10225 trace_consume(&iter);
10227 touch_nmi_watchdog();
10229 trace_printk_seq(&iter.seq);
10233 printk(KERN_TRACE " (ftrace buffer empty)\n");
10235 printk(KERN_TRACE "---------------------------------\n");
10238 tr->trace_flags |= old_userobj;
10240 for_each_tracing_cpu(cpu) {
10241 atomic_dec(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
10243 atomic_dec(&dump_running);
10244 local_irq_restore(flags);
10246 EXPORT_SYMBOL_GPL(ftrace_dump);
10248 #define WRITE_BUFSIZE 4096
10250 ssize_t trace_parse_run_command(struct file *file, const char __user *buffer,
10251 size_t count, loff_t *ppos,
10252 int (*createfn)(const char *))
10254 char *kbuf, *buf, *tmp;
10259 kbuf = kmalloc(WRITE_BUFSIZE, GFP_KERNEL);
10263 while (done < count) {
10264 size = count - done;
10266 if (size >= WRITE_BUFSIZE)
10267 size = WRITE_BUFSIZE - 1;
10269 if (copy_from_user(kbuf, buffer + done, size)) {
10276 tmp = strchr(buf, '\n');
10279 size = tmp - buf + 1;
10281 size = strlen(buf);
10282 if (done + size < count) {
10285 /* This can accept WRITE_BUFSIZE - 2 ('\n' + '\0') */
10286 pr_warn("Line length is too long: Should be less than %d\n",
10287 WRITE_BUFSIZE - 2);
10294 /* Remove comments */
10295 tmp = strchr(buf, '#');
10300 ret = createfn(buf);
10305 } while (done < count);
10315 #ifdef CONFIG_TRACER_MAX_TRACE
10316 __init static bool tr_needs_alloc_snapshot(const char *name)
10319 int len = strlen(name);
10322 if (!boot_snapshot_index)
10325 if (strncmp(name, boot_snapshot_info, len) == 0 &&
10326 boot_snapshot_info[len] == '\t')
10329 test = kmalloc(strlen(name) + 3, GFP_KERNEL);
10333 sprintf(test, "\t%s\t", name);
10334 ret = strstr(boot_snapshot_info, test) == NULL;
10339 __init static void do_allocate_snapshot(const char *name)
10341 if (!tr_needs_alloc_snapshot(name))
10345 * When allocate_snapshot is set, the next call to
10346 * allocate_trace_buffers() (called by trace_array_get_by_name())
10347 * will allocate the snapshot buffer. That will alse clear
10350 allocate_snapshot = true;
10353 static inline void do_allocate_snapshot(const char *name) { }
10356 __init static void enable_instances(void)
10358 struct trace_array *tr;
10363 /* A tab is always appended */
10364 boot_instance_info[boot_instance_index - 1] = '\0';
10365 str = boot_instance_info;
10367 while ((curr_str = strsep(&str, "\t"))) {
10369 tok = strsep(&curr_str, ",");
10371 if (IS_ENABLED(CONFIG_TRACER_MAX_TRACE))
10372 do_allocate_snapshot(tok);
10374 tr = trace_array_get_by_name(tok);
10376 pr_warn("Failed to create instance buffer %s\n", curr_str);
10379 /* Allow user space to delete it */
10380 trace_array_put(tr);
10382 while ((tok = strsep(&curr_str, ","))) {
10383 early_enable_events(tr, tok, true);
10388 __init static int tracer_alloc_buffers(void)
10394 if (security_locked_down(LOCKDOWN_TRACEFS)) {
10395 pr_warn("Tracing disabled due to lockdown\n");
10400 * Make sure we don't accidentally add more trace options
10401 * than we have bits for.
10403 BUILD_BUG_ON(TRACE_ITER_LAST_BIT > TRACE_FLAGS_MAX_SIZE);
10405 if (!alloc_cpumask_var(&tracing_buffer_mask, GFP_KERNEL))
10408 if (!alloc_cpumask_var(&global_trace.tracing_cpumask, GFP_KERNEL))
10409 goto out_free_buffer_mask;
10411 /* Only allocate trace_printk buffers if a trace_printk exists */
10412 if (&__stop___trace_bprintk_fmt != &__start___trace_bprintk_fmt)
10413 /* Must be called before global_trace.buffer is allocated */
10414 trace_printk_init_buffers();
10416 /* To save memory, keep the ring buffer size to its minimum */
10417 if (global_trace.ring_buffer_expanded)
10418 ring_buf_size = trace_buf_size;
10422 cpumask_copy(tracing_buffer_mask, cpu_possible_mask);
10423 cpumask_copy(global_trace.tracing_cpumask, cpu_all_mask);
10425 raw_spin_lock_init(&global_trace.start_lock);
10428 * The prepare callbacks allocates some memory for the ring buffer. We
10429 * don't free the buffer if the CPU goes down. If we were to free
10430 * the buffer, then the user would lose any trace that was in the
10431 * buffer. The memory will be removed once the "instance" is removed.
10433 ret = cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE,
10434 "trace/RB:prepare", trace_rb_cpu_prepare,
10437 goto out_free_cpumask;
10438 /* Used for event triggers */
10440 temp_buffer = ring_buffer_alloc(PAGE_SIZE, RB_FL_OVERWRITE);
10442 goto out_rm_hp_state;
10444 if (trace_create_savedcmd() < 0)
10445 goto out_free_temp_buffer;
10447 if (!zalloc_cpumask_var(&global_trace.pipe_cpumask, GFP_KERNEL))
10448 goto out_free_savedcmd;
10450 /* TODO: make the number of buffers hot pluggable with CPUS */
10451 if (allocate_trace_buffers(&global_trace, ring_buf_size) < 0) {
10452 MEM_FAIL(1, "tracer: failed to allocate ring buffer!\n");
10453 goto out_free_pipe_cpumask;
10455 if (global_trace.buffer_disabled)
10458 if (trace_boot_clock) {
10459 ret = tracing_set_clock(&global_trace, trace_boot_clock);
10461 pr_warn("Trace clock %s not defined, going back to default\n",
10466 * register_tracer() might reference current_trace, so it
10467 * needs to be set before we register anything. This is
10468 * just a bootstrap of current_trace anyway.
10470 global_trace.current_trace = &nop_trace;
10472 global_trace.max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
10474 ftrace_init_global_array_ops(&global_trace);
10476 init_trace_flags_index(&global_trace);
10478 register_tracer(&nop_trace);
10480 /* Function tracing may start here (via kernel command line) */
10481 init_function_trace();
10483 /* All seems OK, enable tracing */
10484 tracing_disabled = 0;
10486 atomic_notifier_chain_register(&panic_notifier_list,
10487 &trace_panic_notifier);
10489 register_die_notifier(&trace_die_notifier);
10491 global_trace.flags = TRACE_ARRAY_FL_GLOBAL;
10493 INIT_LIST_HEAD(&global_trace.systems);
10494 INIT_LIST_HEAD(&global_trace.events);
10495 INIT_LIST_HEAD(&global_trace.hist_vars);
10496 INIT_LIST_HEAD(&global_trace.err_log);
10497 list_add(&global_trace.list, &ftrace_trace_arrays);
10499 apply_trace_boot_options();
10501 register_snapshot_cmd();
10507 out_free_pipe_cpumask:
10508 free_cpumask_var(global_trace.pipe_cpumask);
10510 free_saved_cmdlines_buffer(savedcmd);
10511 out_free_temp_buffer:
10512 ring_buffer_free(temp_buffer);
10514 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE);
10516 free_cpumask_var(global_trace.tracing_cpumask);
10517 out_free_buffer_mask:
10518 free_cpumask_var(tracing_buffer_mask);
10523 void __init ftrace_boot_snapshot(void)
10525 #ifdef CONFIG_TRACER_MAX_TRACE
10526 struct trace_array *tr;
10528 if (!snapshot_at_boot)
10531 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
10532 if (!tr->allocated_snapshot)
10535 tracing_snapshot_instance(tr);
10536 trace_array_puts(tr, "** Boot snapshot taken **\n");
10541 void __init early_trace_init(void)
10543 if (tracepoint_printk) {
10544 tracepoint_print_iter =
10545 kzalloc(sizeof(*tracepoint_print_iter), GFP_KERNEL);
10546 if (MEM_FAIL(!tracepoint_print_iter,
10547 "Failed to allocate trace iterator\n"))
10548 tracepoint_printk = 0;
10550 static_key_enable(&tracepoint_printk_key.key);
10552 tracer_alloc_buffers();
10557 void __init trace_init(void)
10559 trace_event_init();
10561 if (boot_instance_index)
10562 enable_instances();
10565 __init static void clear_boot_tracer(void)
10568 * The default tracer at boot buffer is an init section.
10569 * This function is called in lateinit. If we did not
10570 * find the boot tracer, then clear it out, to prevent
10571 * later registration from accessing the buffer that is
10572 * about to be freed.
10574 if (!default_bootup_tracer)
10577 printk(KERN_INFO "ftrace bootup tracer '%s' not registered.\n",
10578 default_bootup_tracer);
10579 default_bootup_tracer = NULL;
10582 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
10583 __init static void tracing_set_default_clock(void)
10585 /* sched_clock_stable() is determined in late_initcall */
10586 if (!trace_boot_clock && !sched_clock_stable()) {
10587 if (security_locked_down(LOCKDOWN_TRACEFS)) {
10588 pr_warn("Can not set tracing clock due to lockdown\n");
10592 printk(KERN_WARNING
10593 "Unstable clock detected, switching default tracing clock to \"global\"\n"
10594 "If you want to keep using the local clock, then add:\n"
10595 " \"trace_clock=local\"\n"
10596 "on the kernel command line\n");
10597 tracing_set_clock(&global_trace, "global");
10601 static inline void tracing_set_default_clock(void) { }
10604 __init static int late_trace_init(void)
10606 if (tracepoint_printk && tracepoint_printk_stop_on_boot) {
10607 static_key_disable(&tracepoint_printk_key.key);
10608 tracepoint_printk = 0;
10611 tracing_set_default_clock();
10612 clear_boot_tracer();
10616 late_initcall_sync(late_trace_init);