1 // SPDX-License-Identifier: GPL-2.0
3 * ring buffer based function tracer
8 * Originally taken from the RT patch by:
11 * Based on code from the latency_tracer, that is:
12 * Copyright (C) 2004-2006 Ingo Molnar
13 * Copyright (C) 2004 Nadia Yvette Chambers
15 #include <linux/ring_buffer.h>
16 #include <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/notifier.h>
23 #include <linux/irqflags.h>
24 #include <linux/debugfs.h>
25 #include <linux/tracefs.h>
26 #include <linux/pagemap.h>
27 #include <linux/hardirq.h>
28 #include <linux/linkage.h>
29 #include <linux/uaccess.h>
30 #include <linux/vmalloc.h>
31 #include <linux/ftrace.h>
32 #include <linux/module.h>
33 #include <linux/percpu.h>
34 #include <linux/splice.h>
35 #include <linux/kdebug.h>
36 #include <linux/string.h>
37 #include <linux/mount.h>
38 #include <linux/rwsem.h>
39 #include <linux/slab.h>
40 #include <linux/ctype.h>
41 #include <linux/init.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>
53 #include "trace_output.h"
56 * On boot up, the ring buffer is set to the minimum size, so that
57 * we do not waste memory on systems that are not using tracing.
59 bool ring_buffer_expanded;
62 * We need to change this state when a selftest is running.
63 * A selftest will lurk into the ring-buffer to count the
64 * entries inserted during the selftest although some concurrent
65 * insertions into the ring-buffer such as trace_printk could occurred
66 * at the same time, giving false positive or negative results.
68 static bool __read_mostly tracing_selftest_running;
71 * If boot-time tracing including tracers/events via kernel cmdline
72 * is running, we do not want to run SELFTEST.
74 bool __read_mostly tracing_selftest_disabled;
76 #ifdef CONFIG_FTRACE_STARTUP_TEST
77 void __init disable_tracing_selftest(const char *reason)
79 if (!tracing_selftest_disabled) {
80 tracing_selftest_disabled = true;
81 pr_info("Ftrace startup test is disabled due to %s\n", reason);
86 /* Pipe tracepoints to printk */
87 struct trace_iterator *tracepoint_print_iter;
88 int tracepoint_printk;
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;
187 static int __init set_cmdline_ftrace(char *str)
189 strlcpy(bootup_tracer_buf, str, MAX_TRACER_SIZE);
190 default_bootup_tracer = bootup_tracer_buf;
191 /* We are using ftrace early, expand it */
192 ring_buffer_expanded = true;
195 __setup("ftrace=", set_cmdline_ftrace);
197 static int __init set_ftrace_dump_on_oops(char *str)
199 if (*str++ != '=' || !*str) {
200 ftrace_dump_on_oops = DUMP_ALL;
204 if (!strcmp("orig_cpu", str)) {
205 ftrace_dump_on_oops = DUMP_ORIG;
211 __setup("ftrace_dump_on_oops", set_ftrace_dump_on_oops);
213 static int __init stop_trace_on_warning(char *str)
215 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
216 __disable_trace_on_warning = 1;
219 __setup("traceoff_on_warning", stop_trace_on_warning);
221 static int __init boot_alloc_snapshot(char *str)
223 allocate_snapshot = true;
224 /* We also need the main ring buffer expanded */
225 ring_buffer_expanded = true;
228 __setup("alloc_snapshot", boot_alloc_snapshot);
231 static char trace_boot_options_buf[MAX_TRACER_SIZE] __initdata;
233 static int __init set_trace_boot_options(char *str)
235 strlcpy(trace_boot_options_buf, str, MAX_TRACER_SIZE);
238 __setup("trace_options=", set_trace_boot_options);
240 static char trace_boot_clock_buf[MAX_TRACER_SIZE] __initdata;
241 static char *trace_boot_clock __initdata;
243 static int __init set_trace_boot_clock(char *str)
245 strlcpy(trace_boot_clock_buf, str, MAX_TRACER_SIZE);
246 trace_boot_clock = trace_boot_clock_buf;
249 __setup("trace_clock=", set_trace_boot_clock);
251 static int __init set_tracepoint_printk(char *str)
253 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
254 tracepoint_printk = 1;
257 __setup("tp_printk", set_tracepoint_printk);
259 unsigned long long ns2usecs(u64 nsec)
267 trace_process_export(struct trace_export *export,
268 struct ring_buffer_event *event, int flag)
270 struct trace_entry *entry;
271 unsigned int size = 0;
273 if (export->flags & flag) {
274 entry = ring_buffer_event_data(event);
275 size = ring_buffer_event_length(event);
276 export->write(export, entry, size);
280 static DEFINE_MUTEX(ftrace_export_lock);
282 static struct trace_export __rcu *ftrace_exports_list __read_mostly;
284 static DEFINE_STATIC_KEY_FALSE(trace_function_exports_enabled);
285 static DEFINE_STATIC_KEY_FALSE(trace_event_exports_enabled);
286 static DEFINE_STATIC_KEY_FALSE(trace_marker_exports_enabled);
288 static inline void ftrace_exports_enable(struct trace_export *export)
290 if (export->flags & TRACE_EXPORT_FUNCTION)
291 static_branch_inc(&trace_function_exports_enabled);
293 if (export->flags & TRACE_EXPORT_EVENT)
294 static_branch_inc(&trace_event_exports_enabled);
296 if (export->flags & TRACE_EXPORT_MARKER)
297 static_branch_inc(&trace_marker_exports_enabled);
300 static inline void ftrace_exports_disable(struct trace_export *export)
302 if (export->flags & TRACE_EXPORT_FUNCTION)
303 static_branch_dec(&trace_function_exports_enabled);
305 if (export->flags & TRACE_EXPORT_EVENT)
306 static_branch_dec(&trace_event_exports_enabled);
308 if (export->flags & TRACE_EXPORT_MARKER)
309 static_branch_dec(&trace_marker_exports_enabled);
312 static void ftrace_exports(struct ring_buffer_event *event, int flag)
314 struct trace_export *export;
316 preempt_disable_notrace();
318 export = rcu_dereference_raw_check(ftrace_exports_list);
320 trace_process_export(export, event, flag);
321 export = rcu_dereference_raw_check(export->next);
324 preempt_enable_notrace();
328 add_trace_export(struct trace_export **list, struct trace_export *export)
330 rcu_assign_pointer(export->next, *list);
332 * We are entering export into the list but another
333 * CPU might be walking that list. We need to make sure
334 * the export->next pointer is valid before another CPU sees
335 * the export pointer included into the list.
337 rcu_assign_pointer(*list, export);
341 rm_trace_export(struct trace_export **list, struct trace_export *export)
343 struct trace_export **p;
345 for (p = list; *p != NULL; p = &(*p)->next)
352 rcu_assign_pointer(*p, (*p)->next);
358 add_ftrace_export(struct trace_export **list, struct trace_export *export)
360 ftrace_exports_enable(export);
362 add_trace_export(list, export);
366 rm_ftrace_export(struct trace_export **list, struct trace_export *export)
370 ret = rm_trace_export(list, export);
371 ftrace_exports_disable(export);
376 int register_ftrace_export(struct trace_export *export)
378 if (WARN_ON_ONCE(!export->write))
381 mutex_lock(&ftrace_export_lock);
383 add_ftrace_export(&ftrace_exports_list, export);
385 mutex_unlock(&ftrace_export_lock);
389 EXPORT_SYMBOL_GPL(register_ftrace_export);
391 int unregister_ftrace_export(struct trace_export *export)
395 mutex_lock(&ftrace_export_lock);
397 ret = rm_ftrace_export(&ftrace_exports_list, export);
399 mutex_unlock(&ftrace_export_lock);
403 EXPORT_SYMBOL_GPL(unregister_ftrace_export);
405 /* trace_flags holds trace_options default values */
406 #define TRACE_DEFAULT_FLAGS \
407 (FUNCTION_DEFAULT_FLAGS | \
408 TRACE_ITER_PRINT_PARENT | TRACE_ITER_PRINTK | \
409 TRACE_ITER_ANNOTATE | TRACE_ITER_CONTEXT_INFO | \
410 TRACE_ITER_RECORD_CMD | TRACE_ITER_OVERWRITE | \
411 TRACE_ITER_IRQ_INFO | TRACE_ITER_MARKERS | \
414 /* trace_options that are only supported by global_trace */
415 #define TOP_LEVEL_TRACE_FLAGS (TRACE_ITER_PRINTK | \
416 TRACE_ITER_PRINTK_MSGONLY | TRACE_ITER_RECORD_CMD)
418 /* trace_flags that are default zero for instances */
419 #define ZEROED_TRACE_FLAGS \
420 (TRACE_ITER_EVENT_FORK | TRACE_ITER_FUNC_FORK)
423 * The global_trace is the descriptor that holds the top-level tracing
424 * buffers for the live tracing.
426 static struct trace_array global_trace = {
427 .trace_flags = TRACE_DEFAULT_FLAGS,
430 LIST_HEAD(ftrace_trace_arrays);
432 int trace_array_get(struct trace_array *this_tr)
434 struct trace_array *tr;
437 mutex_lock(&trace_types_lock);
438 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
445 mutex_unlock(&trace_types_lock);
450 static void __trace_array_put(struct trace_array *this_tr)
452 WARN_ON(!this_tr->ref);
457 * trace_array_put - Decrement the reference counter for this trace array.
458 * @this_tr : pointer to the trace array
460 * NOTE: Use this when we no longer need the trace array returned by
461 * trace_array_get_by_name(). This ensures the trace array can be later
465 void trace_array_put(struct trace_array *this_tr)
470 mutex_lock(&trace_types_lock);
471 __trace_array_put(this_tr);
472 mutex_unlock(&trace_types_lock);
474 EXPORT_SYMBOL_GPL(trace_array_put);
476 int tracing_check_open_get_tr(struct trace_array *tr)
480 ret = security_locked_down(LOCKDOWN_TRACEFS);
484 if (tracing_disabled)
487 if (tr && trace_array_get(tr) < 0)
493 int call_filter_check_discard(struct trace_event_call *call, void *rec,
494 struct trace_buffer *buffer,
495 struct ring_buffer_event *event)
497 if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
498 !filter_match_preds(call->filter, rec)) {
499 __trace_event_discard_commit(buffer, event);
506 void trace_free_pid_list(struct trace_pid_list *pid_list)
508 vfree(pid_list->pids);
513 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
514 * @filtered_pids: The list of pids to check
515 * @search_pid: The PID to find in @filtered_pids
517 * Returns true if @search_pid is found in @filtered_pids, and false otherwise.
520 trace_find_filtered_pid(struct trace_pid_list *filtered_pids, pid_t search_pid)
523 * If pid_max changed after filtered_pids was created, we
524 * by default ignore all pids greater than the previous pid_max.
526 if (search_pid >= filtered_pids->pid_max)
529 return test_bit(search_pid, filtered_pids->pids);
533 * trace_ignore_this_task - should a task be ignored for tracing
534 * @filtered_pids: The list of pids to check
535 * @filtered_no_pids: The list of pids not to be traced
536 * @task: The task that should be ignored if not filtered
538 * Checks if @task should be traced or not from @filtered_pids.
539 * Returns true if @task should *NOT* be traced.
540 * Returns false if @task should be traced.
543 trace_ignore_this_task(struct trace_pid_list *filtered_pids,
544 struct trace_pid_list *filtered_no_pids,
545 struct task_struct *task)
548 * If filtered_no_pids is not empty, and the task's pid is listed
549 * in filtered_no_pids, then return true.
550 * Otherwise, if filtered_pids is empty, that means we can
551 * trace all tasks. If it has content, then only trace pids
552 * within filtered_pids.
555 return (filtered_pids &&
556 !trace_find_filtered_pid(filtered_pids, task->pid)) ||
558 trace_find_filtered_pid(filtered_no_pids, task->pid));
562 * trace_filter_add_remove_task - Add or remove a task from a pid_list
563 * @pid_list: The list to modify
564 * @self: The current task for fork or NULL for exit
565 * @task: The task to add or remove
567 * If adding a task, if @self is defined, the task is only added if @self
568 * is also included in @pid_list. This happens on fork and tasks should
569 * only be added when the parent is listed. If @self is NULL, then the
570 * @task pid will be removed from the list, which would happen on exit
573 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
574 struct task_struct *self,
575 struct task_struct *task)
580 /* For forks, we only add if the forking task is listed */
582 if (!trace_find_filtered_pid(pid_list, self->pid))
586 /* Sorry, but we don't support pid_max changing after setting */
587 if (task->pid >= pid_list->pid_max)
590 /* "self" is set for forks, and NULL for exits */
592 set_bit(task->pid, pid_list->pids);
594 clear_bit(task->pid, pid_list->pids);
598 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
599 * @pid_list: The pid list to show
600 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
601 * @pos: The position of the file
603 * This is used by the seq_file "next" operation to iterate the pids
604 * listed in a trace_pid_list structure.
606 * Returns the pid+1 as we want to display pid of zero, but NULL would
607 * stop the iteration.
609 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos)
611 unsigned long pid = (unsigned long)v;
615 /* pid already is +1 of the actual previous bit */
616 pid = find_next_bit(pid_list->pids, pid_list->pid_max, pid);
618 /* Return pid + 1 to allow zero to be represented */
619 if (pid < pid_list->pid_max)
620 return (void *)(pid + 1);
626 * trace_pid_start - Used for seq_file to start reading pid lists
627 * @pid_list: The pid list to show
628 * @pos: The position of the file
630 * This is used by seq_file "start" operation to start the iteration
633 * Returns the pid+1 as we want to display pid of zero, but NULL would
634 * stop the iteration.
636 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos)
641 pid = find_first_bit(pid_list->pids, pid_list->pid_max);
642 if (pid >= pid_list->pid_max)
645 /* Return pid + 1 so that zero can be the exit value */
646 for (pid++; pid && l < *pos;
647 pid = (unsigned long)trace_pid_next(pid_list, (void *)pid, &l))
653 * trace_pid_show - show the current pid in seq_file processing
654 * @m: The seq_file structure to write into
655 * @v: A void pointer of the pid (+1) value to display
657 * Can be directly used by seq_file operations to display the current
660 int trace_pid_show(struct seq_file *m, void *v)
662 unsigned long pid = (unsigned long)v - 1;
664 seq_printf(m, "%lu\n", pid);
668 /* 128 should be much more than enough */
669 #define PID_BUF_SIZE 127
671 int trace_pid_write(struct trace_pid_list *filtered_pids,
672 struct trace_pid_list **new_pid_list,
673 const char __user *ubuf, size_t cnt)
675 struct trace_pid_list *pid_list;
676 struct trace_parser parser;
684 if (trace_parser_get_init(&parser, PID_BUF_SIZE + 1))
688 * Always recreate a new array. The write is an all or nothing
689 * operation. Always create a new array when adding new pids by
690 * the user. If the operation fails, then the current list is
693 pid_list = kmalloc(sizeof(*pid_list), GFP_KERNEL);
695 trace_parser_put(&parser);
699 pid_list->pid_max = READ_ONCE(pid_max);
701 /* Only truncating will shrink pid_max */
702 if (filtered_pids && filtered_pids->pid_max > pid_list->pid_max)
703 pid_list->pid_max = filtered_pids->pid_max;
705 pid_list->pids = vzalloc((pid_list->pid_max + 7) >> 3);
706 if (!pid_list->pids) {
707 trace_parser_put(&parser);
713 /* copy the current bits to the new max */
714 for_each_set_bit(pid, filtered_pids->pids,
715 filtered_pids->pid_max) {
716 set_bit(pid, pid_list->pids);
725 ret = trace_get_user(&parser, ubuf, cnt, &pos);
726 if (ret < 0 || !trace_parser_loaded(&parser))
734 if (kstrtoul(parser.buffer, 0, &val))
736 if (val >= pid_list->pid_max)
741 set_bit(pid, pid_list->pids);
744 trace_parser_clear(&parser);
747 trace_parser_put(&parser);
750 trace_free_pid_list(pid_list);
755 /* Cleared the list of pids */
756 trace_free_pid_list(pid_list);
761 *new_pid_list = pid_list;
766 static u64 buffer_ftrace_now(struct array_buffer *buf, int cpu)
770 /* Early boot up does not have a buffer yet */
772 return trace_clock_local();
774 ts = ring_buffer_time_stamp(buf->buffer);
775 ring_buffer_normalize_time_stamp(buf->buffer, cpu, &ts);
780 u64 ftrace_now(int cpu)
782 return buffer_ftrace_now(&global_trace.array_buffer, cpu);
786 * tracing_is_enabled - Show if global_trace has been enabled
788 * Shows if the global trace has been enabled or not. It uses the
789 * mirror flag "buffer_disabled" to be used in fast paths such as for
790 * the irqsoff tracer. But it may be inaccurate due to races. If you
791 * need to know the accurate state, use tracing_is_on() which is a little
792 * slower, but accurate.
794 int tracing_is_enabled(void)
797 * For quick access (irqsoff uses this in fast path), just
798 * return the mirror variable of the state of the ring buffer.
799 * It's a little racy, but we don't really care.
802 return !global_trace.buffer_disabled;
806 * trace_buf_size is the size in bytes that is allocated
807 * for a buffer. Note, the number of bytes is always rounded
810 * This number is purposely set to a low number of 16384.
811 * If the dump on oops happens, it will be much appreciated
812 * to not have to wait for all that output. Anyway this can be
813 * boot time and run time configurable.
815 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
817 static unsigned long trace_buf_size = TRACE_BUF_SIZE_DEFAULT;
819 /* trace_types holds a link list of available tracers. */
820 static struct tracer *trace_types __read_mostly;
823 * trace_types_lock is used to protect the trace_types list.
825 DEFINE_MUTEX(trace_types_lock);
828 * serialize the access of the ring buffer
830 * ring buffer serializes readers, but it is low level protection.
831 * The validity of the events (which returns by ring_buffer_peek() ..etc)
832 * are not protected by ring buffer.
834 * The content of events may become garbage if we allow other process consumes
835 * these events concurrently:
836 * A) the page of the consumed events may become a normal page
837 * (not reader page) in ring buffer, and this page will be rewritten
838 * by events producer.
839 * B) The page of the consumed events may become a page for splice_read,
840 * and this page will be returned to system.
842 * These primitives allow multi process access to different cpu ring buffer
845 * These primitives don't distinguish read-only and read-consume access.
846 * Multi read-only access are also serialized.
850 static DECLARE_RWSEM(all_cpu_access_lock);
851 static DEFINE_PER_CPU(struct mutex, cpu_access_lock);
853 static inline void trace_access_lock(int cpu)
855 if (cpu == RING_BUFFER_ALL_CPUS) {
856 /* gain it for accessing the whole ring buffer. */
857 down_write(&all_cpu_access_lock);
859 /* gain it for accessing a cpu ring buffer. */
861 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
862 down_read(&all_cpu_access_lock);
864 /* Secondly block other access to this @cpu ring buffer. */
865 mutex_lock(&per_cpu(cpu_access_lock, cpu));
869 static inline void trace_access_unlock(int cpu)
871 if (cpu == RING_BUFFER_ALL_CPUS) {
872 up_write(&all_cpu_access_lock);
874 mutex_unlock(&per_cpu(cpu_access_lock, cpu));
875 up_read(&all_cpu_access_lock);
879 static inline void trace_access_lock_init(void)
883 for_each_possible_cpu(cpu)
884 mutex_init(&per_cpu(cpu_access_lock, cpu));
889 static DEFINE_MUTEX(access_lock);
891 static inline void trace_access_lock(int cpu)
894 mutex_lock(&access_lock);
897 static inline void trace_access_unlock(int cpu)
900 mutex_unlock(&access_lock);
903 static inline void trace_access_lock_init(void)
909 #ifdef CONFIG_STACKTRACE
910 static void __ftrace_trace_stack(struct trace_buffer *buffer,
911 unsigned int trace_ctx,
912 int skip, struct pt_regs *regs);
913 static inline void ftrace_trace_stack(struct trace_array *tr,
914 struct trace_buffer *buffer,
915 unsigned int trace_ctx,
916 int skip, struct pt_regs *regs);
919 static inline void __ftrace_trace_stack(struct trace_buffer *buffer,
920 unsigned int trace_ctx,
921 int skip, struct pt_regs *regs)
924 static inline void ftrace_trace_stack(struct trace_array *tr,
925 struct trace_buffer *buffer,
926 unsigned long trace_ctx,
927 int skip, struct pt_regs *regs)
933 static __always_inline void
934 trace_event_setup(struct ring_buffer_event *event,
935 int type, unsigned int trace_ctx)
937 struct trace_entry *ent = ring_buffer_event_data(event);
939 tracing_generic_entry_update(ent, type, trace_ctx);
942 static __always_inline struct ring_buffer_event *
943 __trace_buffer_lock_reserve(struct trace_buffer *buffer,
946 unsigned int trace_ctx)
948 struct ring_buffer_event *event;
950 event = ring_buffer_lock_reserve(buffer, len);
952 trace_event_setup(event, type, trace_ctx);
957 void tracer_tracing_on(struct trace_array *tr)
959 if (tr->array_buffer.buffer)
960 ring_buffer_record_on(tr->array_buffer.buffer);
962 * This flag is looked at when buffers haven't been allocated
963 * yet, or by some tracers (like irqsoff), that just want to
964 * know if the ring buffer has been disabled, but it can handle
965 * races of where it gets disabled but we still do a record.
966 * As the check is in the fast path of the tracers, it is more
967 * important to be fast than accurate.
969 tr->buffer_disabled = 0;
970 /* Make the flag seen by readers */
975 * tracing_on - enable tracing buffers
977 * This function enables tracing buffers that may have been
978 * disabled with tracing_off.
980 void tracing_on(void)
982 tracer_tracing_on(&global_trace);
984 EXPORT_SYMBOL_GPL(tracing_on);
987 static __always_inline void
988 __buffer_unlock_commit(struct trace_buffer *buffer, struct ring_buffer_event *event)
990 __this_cpu_write(trace_taskinfo_save, true);
992 /* If this is the temp buffer, we need to commit fully */
993 if (this_cpu_read(trace_buffered_event) == event) {
994 /* Length is in event->array[0] */
995 ring_buffer_write(buffer, event->array[0], &event->array[1]);
996 /* Release the temp buffer */
997 this_cpu_dec(trace_buffered_event_cnt);
999 ring_buffer_unlock_commit(buffer, event);
1003 * __trace_puts - write a constant string into the trace buffer.
1004 * @ip: The address of the caller
1005 * @str: The constant string to write
1006 * @size: The size of the string.
1008 int __trace_puts(unsigned long ip, const char *str, int size)
1010 struct ring_buffer_event *event;
1011 struct trace_buffer *buffer;
1012 struct print_entry *entry;
1013 unsigned int trace_ctx;
1016 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
1019 if (unlikely(tracing_selftest_running || tracing_disabled))
1022 alloc = sizeof(*entry) + size + 2; /* possible \n added */
1024 trace_ctx = tracing_gen_ctx();
1025 buffer = global_trace.array_buffer.buffer;
1026 ring_buffer_nest_start(buffer);
1027 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, alloc,
1034 entry = ring_buffer_event_data(event);
1037 memcpy(&entry->buf, str, size);
1039 /* Add a newline if necessary */
1040 if (entry->buf[size - 1] != '\n') {
1041 entry->buf[size] = '\n';
1042 entry->buf[size + 1] = '\0';
1044 entry->buf[size] = '\0';
1046 __buffer_unlock_commit(buffer, event);
1047 ftrace_trace_stack(&global_trace, buffer, trace_ctx, 4, NULL);
1049 ring_buffer_nest_end(buffer);
1052 EXPORT_SYMBOL_GPL(__trace_puts);
1055 * __trace_bputs - write the pointer to a constant string into trace buffer
1056 * @ip: The address of the caller
1057 * @str: The constant string to write to the buffer to
1059 int __trace_bputs(unsigned long ip, const char *str)
1061 struct ring_buffer_event *event;
1062 struct trace_buffer *buffer;
1063 struct bputs_entry *entry;
1064 unsigned int trace_ctx;
1065 int size = sizeof(struct bputs_entry);
1068 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
1071 if (unlikely(tracing_selftest_running || tracing_disabled))
1074 trace_ctx = tracing_gen_ctx();
1075 buffer = global_trace.array_buffer.buffer;
1077 ring_buffer_nest_start(buffer);
1078 event = __trace_buffer_lock_reserve(buffer, TRACE_BPUTS, size,
1083 entry = ring_buffer_event_data(event);
1087 __buffer_unlock_commit(buffer, event);
1088 ftrace_trace_stack(&global_trace, buffer, trace_ctx, 4, NULL);
1092 ring_buffer_nest_end(buffer);
1095 EXPORT_SYMBOL_GPL(__trace_bputs);
1097 #ifdef CONFIG_TRACER_SNAPSHOT
1098 static void tracing_snapshot_instance_cond(struct trace_array *tr,
1101 struct tracer *tracer = tr->current_trace;
1102 unsigned long flags;
1105 internal_trace_puts("*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
1106 internal_trace_puts("*** snapshot is being ignored ***\n");
1110 if (!tr->allocated_snapshot) {
1111 internal_trace_puts("*** SNAPSHOT NOT ALLOCATED ***\n");
1112 internal_trace_puts("*** stopping trace here! ***\n");
1117 /* Note, snapshot can not be used when the tracer uses it */
1118 if (tracer->use_max_tr) {
1119 internal_trace_puts("*** LATENCY TRACER ACTIVE ***\n");
1120 internal_trace_puts("*** Can not use snapshot (sorry) ***\n");
1124 local_irq_save(flags);
1125 update_max_tr(tr, current, smp_processor_id(), cond_data);
1126 local_irq_restore(flags);
1129 void tracing_snapshot_instance(struct trace_array *tr)
1131 tracing_snapshot_instance_cond(tr, NULL);
1135 * tracing_snapshot - take a snapshot of the current buffer.
1137 * This causes a swap between the snapshot buffer and the current live
1138 * tracing buffer. You can use this to take snapshots of the live
1139 * trace when some condition is triggered, but continue to trace.
1141 * Note, make sure to allocate the snapshot with either
1142 * a tracing_snapshot_alloc(), or by doing it manually
1143 * with: echo 1 > /sys/kernel/debug/tracing/snapshot
1145 * If the snapshot buffer is not allocated, it will stop tracing.
1146 * Basically making a permanent snapshot.
1148 void tracing_snapshot(void)
1150 struct trace_array *tr = &global_trace;
1152 tracing_snapshot_instance(tr);
1154 EXPORT_SYMBOL_GPL(tracing_snapshot);
1157 * tracing_snapshot_cond - conditionally take a snapshot of the current buffer.
1158 * @tr: The tracing instance to snapshot
1159 * @cond_data: The data to be tested conditionally, and possibly saved
1161 * This is the same as tracing_snapshot() except that the snapshot is
1162 * conditional - the snapshot will only happen if the
1163 * cond_snapshot.update() implementation receiving the cond_data
1164 * returns true, which means that the trace array's cond_snapshot
1165 * update() operation used the cond_data to determine whether the
1166 * snapshot should be taken, and if it was, presumably saved it along
1167 * with the snapshot.
1169 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1171 tracing_snapshot_instance_cond(tr, cond_data);
1173 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1176 * tracing_snapshot_cond_data - get the user data associated with a snapshot
1177 * @tr: The tracing instance
1179 * When the user enables a conditional snapshot using
1180 * tracing_snapshot_cond_enable(), the user-defined cond_data is saved
1181 * with the snapshot. This accessor is used to retrieve it.
1183 * Should not be called from cond_snapshot.update(), since it takes
1184 * the tr->max_lock lock, which the code calling
1185 * cond_snapshot.update() has already done.
1187 * Returns the cond_data associated with the trace array's snapshot.
1189 void *tracing_cond_snapshot_data(struct trace_array *tr)
1191 void *cond_data = NULL;
1193 arch_spin_lock(&tr->max_lock);
1195 if (tr->cond_snapshot)
1196 cond_data = tr->cond_snapshot->cond_data;
1198 arch_spin_unlock(&tr->max_lock);
1202 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1204 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
1205 struct array_buffer *size_buf, int cpu_id);
1206 static void set_buffer_entries(struct array_buffer *buf, unsigned long val);
1208 int tracing_alloc_snapshot_instance(struct trace_array *tr)
1212 if (!tr->allocated_snapshot) {
1214 /* allocate spare buffer */
1215 ret = resize_buffer_duplicate_size(&tr->max_buffer,
1216 &tr->array_buffer, RING_BUFFER_ALL_CPUS);
1220 tr->allocated_snapshot = true;
1226 static void free_snapshot(struct trace_array *tr)
1229 * We don't free the ring buffer. instead, resize it because
1230 * The max_tr ring buffer has some state (e.g. ring->clock) and
1231 * we want preserve it.
1233 ring_buffer_resize(tr->max_buffer.buffer, 1, RING_BUFFER_ALL_CPUS);
1234 set_buffer_entries(&tr->max_buffer, 1);
1235 tracing_reset_online_cpus(&tr->max_buffer);
1236 tr->allocated_snapshot = false;
1240 * tracing_alloc_snapshot - allocate snapshot buffer.
1242 * This only allocates the snapshot buffer if it isn't already
1243 * allocated - it doesn't also take a snapshot.
1245 * This is meant to be used in cases where the snapshot buffer needs
1246 * to be set up for events that can't sleep but need to be able to
1247 * trigger a snapshot.
1249 int tracing_alloc_snapshot(void)
1251 struct trace_array *tr = &global_trace;
1254 ret = tracing_alloc_snapshot_instance(tr);
1259 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1262 * tracing_snapshot_alloc - allocate and take a snapshot of the current buffer.
1264 * This is similar to tracing_snapshot(), but it will allocate the
1265 * snapshot buffer if it isn't already allocated. Use this only
1266 * where it is safe to sleep, as the allocation may sleep.
1268 * This causes a swap between the snapshot buffer and the current live
1269 * tracing buffer. You can use this to take snapshots of the live
1270 * trace when some condition is triggered, but continue to trace.
1272 void tracing_snapshot_alloc(void)
1276 ret = tracing_alloc_snapshot();
1282 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1285 * tracing_snapshot_cond_enable - enable conditional snapshot for an instance
1286 * @tr: The tracing instance
1287 * @cond_data: User data to associate with the snapshot
1288 * @update: Implementation of the cond_snapshot update function
1290 * Check whether the conditional snapshot for the given instance has
1291 * already been enabled, or if the current tracer is already using a
1292 * snapshot; if so, return -EBUSY, else create a cond_snapshot and
1293 * save the cond_data and update function inside.
1295 * Returns 0 if successful, error otherwise.
1297 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data,
1298 cond_update_fn_t update)
1300 struct cond_snapshot *cond_snapshot;
1303 cond_snapshot = kzalloc(sizeof(*cond_snapshot), GFP_KERNEL);
1307 cond_snapshot->cond_data = cond_data;
1308 cond_snapshot->update = update;
1310 mutex_lock(&trace_types_lock);
1312 ret = tracing_alloc_snapshot_instance(tr);
1316 if (tr->current_trace->use_max_tr) {
1322 * The cond_snapshot can only change to NULL without the
1323 * trace_types_lock. We don't care if we race with it going
1324 * to NULL, but we want to make sure that it's not set to
1325 * something other than NULL when we get here, which we can
1326 * do safely with only holding the trace_types_lock and not
1327 * having to take the max_lock.
1329 if (tr->cond_snapshot) {
1334 arch_spin_lock(&tr->max_lock);
1335 tr->cond_snapshot = cond_snapshot;
1336 arch_spin_unlock(&tr->max_lock);
1338 mutex_unlock(&trace_types_lock);
1343 mutex_unlock(&trace_types_lock);
1344 kfree(cond_snapshot);
1347 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1350 * tracing_snapshot_cond_disable - disable conditional snapshot for an instance
1351 * @tr: The tracing instance
1353 * Check whether the conditional snapshot for the given instance is
1354 * enabled; if so, free the cond_snapshot associated with it,
1355 * otherwise return -EINVAL.
1357 * Returns 0 if successful, error otherwise.
1359 int tracing_snapshot_cond_disable(struct trace_array *tr)
1363 arch_spin_lock(&tr->max_lock);
1365 if (!tr->cond_snapshot)
1368 kfree(tr->cond_snapshot);
1369 tr->cond_snapshot = NULL;
1372 arch_spin_unlock(&tr->max_lock);
1376 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1378 void tracing_snapshot(void)
1380 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1382 EXPORT_SYMBOL_GPL(tracing_snapshot);
1383 void tracing_snapshot_cond(struct trace_array *tr, void *cond_data)
1385 WARN_ONCE(1, "Snapshot feature not enabled, but internal conditional snapshot used");
1387 EXPORT_SYMBOL_GPL(tracing_snapshot_cond);
1388 int tracing_alloc_snapshot(void)
1390 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1393 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1394 void tracing_snapshot_alloc(void)
1399 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1400 void *tracing_cond_snapshot_data(struct trace_array *tr)
1404 EXPORT_SYMBOL_GPL(tracing_cond_snapshot_data);
1405 int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update)
1409 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_enable);
1410 int tracing_snapshot_cond_disable(struct trace_array *tr)
1414 EXPORT_SYMBOL_GPL(tracing_snapshot_cond_disable);
1415 #endif /* CONFIG_TRACER_SNAPSHOT */
1417 void tracer_tracing_off(struct trace_array *tr)
1419 if (tr->array_buffer.buffer)
1420 ring_buffer_record_off(tr->array_buffer.buffer);
1422 * This flag is looked at when buffers haven't been allocated
1423 * yet, or by some tracers (like irqsoff), that just want to
1424 * know if the ring buffer has been disabled, but it can handle
1425 * races of where it gets disabled but we still do a record.
1426 * As the check is in the fast path of the tracers, it is more
1427 * important to be fast than accurate.
1429 tr->buffer_disabled = 1;
1430 /* Make the flag seen by readers */
1435 * tracing_off - turn off tracing buffers
1437 * This function stops the tracing buffers from recording data.
1438 * It does not disable any overhead the tracers themselves may
1439 * be causing. This function simply causes all recording to
1440 * the ring buffers to fail.
1442 void tracing_off(void)
1444 tracer_tracing_off(&global_trace);
1446 EXPORT_SYMBOL_GPL(tracing_off);
1448 void disable_trace_on_warning(void)
1450 if (__disable_trace_on_warning) {
1451 trace_array_printk_buf(global_trace.array_buffer.buffer, _THIS_IP_,
1452 "Disabling tracing due to warning\n");
1458 * tracer_tracing_is_on - show real state of ring buffer enabled
1459 * @tr : the trace array to know if ring buffer is enabled
1461 * Shows real state of the ring buffer if it is enabled or not.
1463 bool tracer_tracing_is_on(struct trace_array *tr)
1465 if (tr->array_buffer.buffer)
1466 return ring_buffer_record_is_on(tr->array_buffer.buffer);
1467 return !tr->buffer_disabled;
1471 * tracing_is_on - show state of ring buffers enabled
1473 int tracing_is_on(void)
1475 return tracer_tracing_is_on(&global_trace);
1477 EXPORT_SYMBOL_GPL(tracing_is_on);
1479 static int __init set_buf_size(char *str)
1481 unsigned long buf_size;
1485 buf_size = memparse(str, &str);
1486 /* nr_entries can not be zero */
1489 trace_buf_size = buf_size;
1492 __setup("trace_buf_size=", set_buf_size);
1494 static int __init set_tracing_thresh(char *str)
1496 unsigned long threshold;
1501 ret = kstrtoul(str, 0, &threshold);
1504 tracing_thresh = threshold * 1000;
1507 __setup("tracing_thresh=", set_tracing_thresh);
1509 unsigned long nsecs_to_usecs(unsigned long nsecs)
1511 return nsecs / 1000;
1515 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1516 * It uses C(a, b) where 'a' is the eval (enum) name and 'b' is the string that
1517 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1518 * of strings in the order that the evals (enum) were defined.
1523 /* These must match the bit positions in trace_iterator_flags */
1524 static const char *trace_options[] = {
1532 int in_ns; /* is this clock in nanoseconds? */
1533 } trace_clocks[] = {
1534 { trace_clock_local, "local", 1 },
1535 { trace_clock_global, "global", 1 },
1536 { trace_clock_counter, "counter", 0 },
1537 { trace_clock_jiffies, "uptime", 0 },
1538 { trace_clock, "perf", 1 },
1539 { ktime_get_mono_fast_ns, "mono", 1 },
1540 { ktime_get_raw_fast_ns, "mono_raw", 1 },
1541 { ktime_get_boot_fast_ns, "boot", 1 },
1545 bool trace_clock_in_ns(struct trace_array *tr)
1547 if (trace_clocks[tr->clock_id].in_ns)
1554 * trace_parser_get_init - gets the buffer for trace parser
1556 int trace_parser_get_init(struct trace_parser *parser, int size)
1558 memset(parser, 0, sizeof(*parser));
1560 parser->buffer = kmalloc(size, GFP_KERNEL);
1561 if (!parser->buffer)
1564 parser->size = size;
1569 * trace_parser_put - frees the buffer for trace parser
1571 void trace_parser_put(struct trace_parser *parser)
1573 kfree(parser->buffer);
1574 parser->buffer = NULL;
1578 * trace_get_user - reads the user input string separated by space
1579 * (matched by isspace(ch))
1581 * For each string found the 'struct trace_parser' is updated,
1582 * and the function returns.
1584 * Returns number of bytes read.
1586 * See kernel/trace/trace.h for 'struct trace_parser' details.
1588 int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1589 size_t cnt, loff_t *ppos)
1596 trace_parser_clear(parser);
1598 ret = get_user(ch, ubuf++);
1606 * The parser is not finished with the last write,
1607 * continue reading the user input without skipping spaces.
1609 if (!parser->cont) {
1610 /* skip white space */
1611 while (cnt && isspace(ch)) {
1612 ret = get_user(ch, ubuf++);
1621 /* only spaces were written */
1622 if (isspace(ch) || !ch) {
1629 /* read the non-space input */
1630 while (cnt && !isspace(ch) && ch) {
1631 if (parser->idx < parser->size - 1)
1632 parser->buffer[parser->idx++] = ch;
1637 ret = get_user(ch, ubuf++);
1644 /* We either got finished input or we have to wait for another call. */
1645 if (isspace(ch) || !ch) {
1646 parser->buffer[parser->idx] = 0;
1647 parser->cont = false;
1648 } else if (parser->idx < parser->size - 1) {
1649 parser->cont = true;
1650 parser->buffer[parser->idx++] = ch;
1651 /* Make sure the parsed string always terminates with '\0'. */
1652 parser->buffer[parser->idx] = 0;
1665 /* TODO add a seq_buf_to_buffer() */
1666 static ssize_t trace_seq_to_buffer(struct trace_seq *s, void *buf, size_t cnt)
1670 if (trace_seq_used(s) <= s->seq.readpos)
1673 len = trace_seq_used(s) - s->seq.readpos;
1676 memcpy(buf, s->buffer + s->seq.readpos, cnt);
1678 s->seq.readpos += cnt;
1682 unsigned long __read_mostly tracing_thresh;
1683 static const struct file_operations tracing_max_lat_fops;
1685 #if (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)) && \
1686 defined(CONFIG_FSNOTIFY)
1688 static struct workqueue_struct *fsnotify_wq;
1690 static void latency_fsnotify_workfn(struct work_struct *work)
1692 struct trace_array *tr = container_of(work, struct trace_array,
1694 fsnotify_inode(tr->d_max_latency->d_inode, FS_MODIFY);
1697 static void latency_fsnotify_workfn_irq(struct irq_work *iwork)
1699 struct trace_array *tr = container_of(iwork, struct trace_array,
1701 queue_work(fsnotify_wq, &tr->fsnotify_work);
1704 static void trace_create_maxlat_file(struct trace_array *tr,
1705 struct dentry *d_tracer)
1707 INIT_WORK(&tr->fsnotify_work, latency_fsnotify_workfn);
1708 init_irq_work(&tr->fsnotify_irqwork, latency_fsnotify_workfn_irq);
1709 tr->d_max_latency = trace_create_file("tracing_max_latency", 0644,
1710 d_tracer, &tr->max_latency,
1711 &tracing_max_lat_fops);
1714 __init static int latency_fsnotify_init(void)
1716 fsnotify_wq = alloc_workqueue("tr_max_lat_wq",
1717 WQ_UNBOUND | WQ_HIGHPRI, 0);
1719 pr_err("Unable to allocate tr_max_lat_wq\n");
1725 late_initcall_sync(latency_fsnotify_init);
1727 void latency_fsnotify(struct trace_array *tr)
1732 * We cannot call queue_work(&tr->fsnotify_work) from here because it's
1733 * possible that we are called from __schedule() or do_idle(), which
1734 * could cause a deadlock.
1736 irq_work_queue(&tr->fsnotify_irqwork);
1740 * (defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)) && \
1741 * defined(CONFIG_FSNOTIFY)
1745 #define trace_create_maxlat_file(tr, d_tracer) \
1746 trace_create_file("tracing_max_latency", 0644, d_tracer, \
1747 &tr->max_latency, &tracing_max_lat_fops)
1751 #ifdef CONFIG_TRACER_MAX_TRACE
1753 * Copy the new maximum trace into the separate maximum-trace
1754 * structure. (this way the maximum trace is permanently saved,
1755 * for later retrieval via /sys/kernel/tracing/tracing_max_latency)
1758 __update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)
1760 struct array_buffer *trace_buf = &tr->array_buffer;
1761 struct array_buffer *max_buf = &tr->max_buffer;
1762 struct trace_array_cpu *data = per_cpu_ptr(trace_buf->data, cpu);
1763 struct trace_array_cpu *max_data = per_cpu_ptr(max_buf->data, cpu);
1766 max_buf->time_start = data->preempt_timestamp;
1768 max_data->saved_latency = tr->max_latency;
1769 max_data->critical_start = data->critical_start;
1770 max_data->critical_end = data->critical_end;
1772 strncpy(max_data->comm, tsk->comm, TASK_COMM_LEN);
1773 max_data->pid = tsk->pid;
1775 * If tsk == current, then use current_uid(), as that does not use
1776 * RCU. The irq tracer can be called out of RCU scope.
1779 max_data->uid = current_uid();
1781 max_data->uid = task_uid(tsk);
1783 max_data->nice = tsk->static_prio - 20 - MAX_RT_PRIO;
1784 max_data->policy = tsk->policy;
1785 max_data->rt_priority = tsk->rt_priority;
1787 /* record this tasks comm */
1788 tracing_record_cmdline(tsk);
1789 latency_fsnotify(tr);
1793 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1795 * @tsk: the task with the latency
1796 * @cpu: The cpu that initiated the trace.
1797 * @cond_data: User data associated with a conditional snapshot
1799 * Flip the buffers between the @tr and the max_tr and record information
1800 * about which task was the cause of this latency.
1803 update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
1809 WARN_ON_ONCE(!irqs_disabled());
1811 if (!tr->allocated_snapshot) {
1812 /* Only the nop tracer should hit this when disabling */
1813 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1817 arch_spin_lock(&tr->max_lock);
1819 /* Inherit the recordable setting from array_buffer */
1820 if (ring_buffer_record_is_set_on(tr->array_buffer.buffer))
1821 ring_buffer_record_on(tr->max_buffer.buffer);
1823 ring_buffer_record_off(tr->max_buffer.buffer);
1825 #ifdef CONFIG_TRACER_SNAPSHOT
1826 if (tr->cond_snapshot && !tr->cond_snapshot->update(tr, cond_data))
1829 swap(tr->array_buffer.buffer, tr->max_buffer.buffer);
1831 __update_max_tr(tr, tsk, cpu);
1834 arch_spin_unlock(&tr->max_lock);
1838 * update_max_tr_single - only copy one trace over, and reset the rest
1840 * @tsk: task with the latency
1841 * @cpu: the cpu of the buffer to copy.
1843 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
1846 update_max_tr_single(struct trace_array *tr, struct task_struct *tsk, int cpu)
1853 WARN_ON_ONCE(!irqs_disabled());
1854 if (!tr->allocated_snapshot) {
1855 /* Only the nop tracer should hit this when disabling */
1856 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1860 arch_spin_lock(&tr->max_lock);
1862 ret = ring_buffer_swap_cpu(tr->max_buffer.buffer, tr->array_buffer.buffer, cpu);
1864 if (ret == -EBUSY) {
1866 * We failed to swap the buffer due to a commit taking
1867 * place on this CPU. We fail to record, but we reset
1868 * the max trace buffer (no one writes directly to it)
1869 * and flag that it failed.
1871 trace_array_printk_buf(tr->max_buffer.buffer, _THIS_IP_,
1872 "Failed to swap buffers due to commit in progress\n");
1875 WARN_ON_ONCE(ret && ret != -EAGAIN && ret != -EBUSY);
1877 __update_max_tr(tr, tsk, cpu);
1878 arch_spin_unlock(&tr->max_lock);
1880 #endif /* CONFIG_TRACER_MAX_TRACE */
1882 static int wait_on_pipe(struct trace_iterator *iter, int full)
1884 /* Iterators are static, they should be filled or empty */
1885 if (trace_buffer_iter(iter, iter->cpu_file))
1888 return ring_buffer_wait(iter->array_buffer->buffer, iter->cpu_file,
1892 #ifdef CONFIG_FTRACE_STARTUP_TEST
1893 static bool selftests_can_run;
1895 struct trace_selftests {
1896 struct list_head list;
1897 struct tracer *type;
1900 static LIST_HEAD(postponed_selftests);
1902 static int save_selftest(struct tracer *type)
1904 struct trace_selftests *selftest;
1906 selftest = kmalloc(sizeof(*selftest), GFP_KERNEL);
1910 selftest->type = type;
1911 list_add(&selftest->list, &postponed_selftests);
1915 static int run_tracer_selftest(struct tracer *type)
1917 struct trace_array *tr = &global_trace;
1918 struct tracer *saved_tracer = tr->current_trace;
1921 if (!type->selftest || tracing_selftest_disabled)
1925 * If a tracer registers early in boot up (before scheduling is
1926 * initialized and such), then do not run its selftests yet.
1927 * Instead, run it a little later in the boot process.
1929 if (!selftests_can_run)
1930 return save_selftest(type);
1932 if (!tracing_is_on()) {
1933 pr_warn("Selftest for tracer %s skipped due to tracing disabled\n",
1939 * Run a selftest on this tracer.
1940 * Here we reset the trace buffer, and set the current
1941 * tracer to be this tracer. The tracer can then run some
1942 * internal tracing to verify that everything is in order.
1943 * If we fail, we do not register this tracer.
1945 tracing_reset_online_cpus(&tr->array_buffer);
1947 tr->current_trace = type;
1949 #ifdef CONFIG_TRACER_MAX_TRACE
1950 if (type->use_max_tr) {
1951 /* If we expanded the buffers, make sure the max is expanded too */
1952 if (ring_buffer_expanded)
1953 ring_buffer_resize(tr->max_buffer.buffer, trace_buf_size,
1954 RING_BUFFER_ALL_CPUS);
1955 tr->allocated_snapshot = true;
1959 /* the test is responsible for initializing and enabling */
1960 pr_info("Testing tracer %s: ", type->name);
1961 ret = type->selftest(type, tr);
1962 /* the test is responsible for resetting too */
1963 tr->current_trace = saved_tracer;
1965 printk(KERN_CONT "FAILED!\n");
1966 /* Add the warning after printing 'FAILED' */
1970 /* Only reset on passing, to avoid touching corrupted buffers */
1971 tracing_reset_online_cpus(&tr->array_buffer);
1973 #ifdef CONFIG_TRACER_MAX_TRACE
1974 if (type->use_max_tr) {
1975 tr->allocated_snapshot = false;
1977 /* Shrink the max buffer again */
1978 if (ring_buffer_expanded)
1979 ring_buffer_resize(tr->max_buffer.buffer, 1,
1980 RING_BUFFER_ALL_CPUS);
1984 printk(KERN_CONT "PASSED\n");
1988 static __init int init_trace_selftests(void)
1990 struct trace_selftests *p, *n;
1991 struct tracer *t, **last;
1994 selftests_can_run = true;
1996 mutex_lock(&trace_types_lock);
1998 if (list_empty(&postponed_selftests))
2001 pr_info("Running postponed tracer tests:\n");
2003 tracing_selftest_running = true;
2004 list_for_each_entry_safe(p, n, &postponed_selftests, list) {
2005 /* This loop can take minutes when sanitizers are enabled, so
2006 * lets make sure we allow RCU processing.
2009 ret = run_tracer_selftest(p->type);
2010 /* If the test fails, then warn and remove from available_tracers */
2012 WARN(1, "tracer: %s failed selftest, disabling\n",
2014 last = &trace_types;
2015 for (t = trace_types; t; t = t->next) {
2026 tracing_selftest_running = false;
2029 mutex_unlock(&trace_types_lock);
2033 core_initcall(init_trace_selftests);
2035 static inline int run_tracer_selftest(struct tracer *type)
2039 #endif /* CONFIG_FTRACE_STARTUP_TEST */
2041 static void add_tracer_options(struct trace_array *tr, struct tracer *t);
2043 static void __init apply_trace_boot_options(void);
2046 * register_tracer - register a tracer with the ftrace system.
2047 * @type: the plugin for the tracer
2049 * Register a new plugin tracer.
2051 int __init register_tracer(struct tracer *type)
2057 pr_info("Tracer must have a name\n");
2061 if (strlen(type->name) >= MAX_TRACER_SIZE) {
2062 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE);
2066 if (security_locked_down(LOCKDOWN_TRACEFS)) {
2067 pr_warn("Can not register tracer %s due to lockdown\n",
2072 mutex_lock(&trace_types_lock);
2074 tracing_selftest_running = true;
2076 for (t = trace_types; t; t = t->next) {
2077 if (strcmp(type->name, t->name) == 0) {
2079 pr_info("Tracer %s already registered\n",
2086 if (!type->set_flag)
2087 type->set_flag = &dummy_set_flag;
2089 /*allocate a dummy tracer_flags*/
2090 type->flags = kmalloc(sizeof(*type->flags), GFP_KERNEL);
2095 type->flags->val = 0;
2096 type->flags->opts = dummy_tracer_opt;
2098 if (!type->flags->opts)
2099 type->flags->opts = dummy_tracer_opt;
2101 /* store the tracer for __set_tracer_option */
2102 type->flags->trace = type;
2104 ret = run_tracer_selftest(type);
2108 type->next = trace_types;
2110 add_tracer_options(&global_trace, type);
2113 tracing_selftest_running = false;
2114 mutex_unlock(&trace_types_lock);
2116 if (ret || !default_bootup_tracer)
2119 if (strncmp(default_bootup_tracer, type->name, MAX_TRACER_SIZE))
2122 printk(KERN_INFO "Starting tracer '%s'\n", type->name);
2123 /* Do we want this tracer to start on bootup? */
2124 tracing_set_tracer(&global_trace, type->name);
2125 default_bootup_tracer = NULL;
2127 apply_trace_boot_options();
2129 /* disable other selftests, since this will break it. */
2130 disable_tracing_selftest("running a tracer");
2136 static void tracing_reset_cpu(struct array_buffer *buf, int cpu)
2138 struct trace_buffer *buffer = buf->buffer;
2143 ring_buffer_record_disable(buffer);
2145 /* Make sure all commits have finished */
2147 ring_buffer_reset_cpu(buffer, cpu);
2149 ring_buffer_record_enable(buffer);
2152 void tracing_reset_online_cpus(struct array_buffer *buf)
2154 struct trace_buffer *buffer = buf->buffer;
2159 ring_buffer_record_disable(buffer);
2161 /* Make sure all commits have finished */
2164 buf->time_start = buffer_ftrace_now(buf, buf->cpu);
2166 ring_buffer_reset_online_cpus(buffer);
2168 ring_buffer_record_enable(buffer);
2171 /* Must have trace_types_lock held */
2172 void tracing_reset_all_online_cpus(void)
2174 struct trace_array *tr;
2176 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
2177 if (!tr->clear_trace)
2179 tr->clear_trace = false;
2180 tracing_reset_online_cpus(&tr->array_buffer);
2181 #ifdef CONFIG_TRACER_MAX_TRACE
2182 tracing_reset_online_cpus(&tr->max_buffer);
2187 static int *tgid_map;
2189 #define SAVED_CMDLINES_DEFAULT 128
2190 #define NO_CMDLINE_MAP UINT_MAX
2191 static arch_spinlock_t trace_cmdline_lock = __ARCH_SPIN_LOCK_UNLOCKED;
2192 struct saved_cmdlines_buffer {
2193 unsigned map_pid_to_cmdline[PID_MAX_DEFAULT+1];
2194 unsigned *map_cmdline_to_pid;
2195 unsigned cmdline_num;
2197 char *saved_cmdlines;
2199 static struct saved_cmdlines_buffer *savedcmd;
2201 /* temporary disable recording */
2202 static atomic_t trace_record_taskinfo_disabled __read_mostly;
2204 static inline char *get_saved_cmdlines(int idx)
2206 return &savedcmd->saved_cmdlines[idx * TASK_COMM_LEN];
2209 static inline void set_cmdline(int idx, const char *cmdline)
2211 strncpy(get_saved_cmdlines(idx), cmdline, TASK_COMM_LEN);
2214 static int allocate_cmdlines_buffer(unsigned int val,
2215 struct saved_cmdlines_buffer *s)
2217 s->map_cmdline_to_pid = kmalloc_array(val,
2218 sizeof(*s->map_cmdline_to_pid),
2220 if (!s->map_cmdline_to_pid)
2223 s->saved_cmdlines = kmalloc_array(TASK_COMM_LEN, val, GFP_KERNEL);
2224 if (!s->saved_cmdlines) {
2225 kfree(s->map_cmdline_to_pid);
2230 s->cmdline_num = val;
2231 memset(&s->map_pid_to_cmdline, NO_CMDLINE_MAP,
2232 sizeof(s->map_pid_to_cmdline));
2233 memset(s->map_cmdline_to_pid, NO_CMDLINE_MAP,
2234 val * sizeof(*s->map_cmdline_to_pid));
2239 static int trace_create_savedcmd(void)
2243 savedcmd = kmalloc(sizeof(*savedcmd), GFP_KERNEL);
2247 ret = allocate_cmdlines_buffer(SAVED_CMDLINES_DEFAULT, savedcmd);
2257 int is_tracing_stopped(void)
2259 return global_trace.stop_count;
2263 * tracing_start - quick start of the tracer
2265 * If tracing is enabled but was stopped by tracing_stop,
2266 * this will start the tracer back up.
2268 void tracing_start(void)
2270 struct trace_buffer *buffer;
2271 unsigned long flags;
2273 if (tracing_disabled)
2276 raw_spin_lock_irqsave(&global_trace.start_lock, flags);
2277 if (--global_trace.stop_count) {
2278 if (global_trace.stop_count < 0) {
2279 /* Someone screwed up their debugging */
2281 global_trace.stop_count = 0;
2286 /* Prevent the buffers from switching */
2287 arch_spin_lock(&global_trace.max_lock);
2289 buffer = global_trace.array_buffer.buffer;
2291 ring_buffer_record_enable(buffer);
2293 #ifdef CONFIG_TRACER_MAX_TRACE
2294 buffer = global_trace.max_buffer.buffer;
2296 ring_buffer_record_enable(buffer);
2299 arch_spin_unlock(&global_trace.max_lock);
2302 raw_spin_unlock_irqrestore(&global_trace.start_lock, flags);
2305 static void tracing_start_tr(struct trace_array *tr)
2307 struct trace_buffer *buffer;
2308 unsigned long flags;
2310 if (tracing_disabled)
2313 /* If global, we need to also start the max tracer */
2314 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
2315 return tracing_start();
2317 raw_spin_lock_irqsave(&tr->start_lock, flags);
2319 if (--tr->stop_count) {
2320 if (tr->stop_count < 0) {
2321 /* Someone screwed up their debugging */
2328 buffer = tr->array_buffer.buffer;
2330 ring_buffer_record_enable(buffer);
2333 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2337 * tracing_stop - quick stop of the tracer
2339 * Light weight way to stop tracing. Use in conjunction with
2342 void tracing_stop(void)
2344 struct trace_buffer *buffer;
2345 unsigned long flags;
2347 raw_spin_lock_irqsave(&global_trace.start_lock, flags);
2348 if (global_trace.stop_count++)
2351 /* Prevent the buffers from switching */
2352 arch_spin_lock(&global_trace.max_lock);
2354 buffer = global_trace.array_buffer.buffer;
2356 ring_buffer_record_disable(buffer);
2358 #ifdef CONFIG_TRACER_MAX_TRACE
2359 buffer = global_trace.max_buffer.buffer;
2361 ring_buffer_record_disable(buffer);
2364 arch_spin_unlock(&global_trace.max_lock);
2367 raw_spin_unlock_irqrestore(&global_trace.start_lock, flags);
2370 static void tracing_stop_tr(struct trace_array *tr)
2372 struct trace_buffer *buffer;
2373 unsigned long flags;
2375 /* If global, we need to also stop the max tracer */
2376 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
2377 return tracing_stop();
2379 raw_spin_lock_irqsave(&tr->start_lock, flags);
2380 if (tr->stop_count++)
2383 buffer = tr->array_buffer.buffer;
2385 ring_buffer_record_disable(buffer);
2388 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
2391 static int trace_save_cmdline(struct task_struct *tsk)
2395 /* treat recording of idle task as a success */
2399 tpid = tsk->pid & (PID_MAX_DEFAULT - 1);
2402 * It's not the end of the world if we don't get
2403 * the lock, but we also don't want to spin
2404 * nor do we want to disable interrupts,
2405 * so if we miss here, then better luck next time.
2407 if (!arch_spin_trylock(&trace_cmdline_lock))
2410 idx = savedcmd->map_pid_to_cmdline[tpid];
2411 if (idx == NO_CMDLINE_MAP) {
2412 idx = (savedcmd->cmdline_idx + 1) % savedcmd->cmdline_num;
2414 savedcmd->map_pid_to_cmdline[tpid] = idx;
2415 savedcmd->cmdline_idx = idx;
2418 savedcmd->map_cmdline_to_pid[idx] = tsk->pid;
2419 set_cmdline(idx, tsk->comm);
2421 arch_spin_unlock(&trace_cmdline_lock);
2426 static void __trace_find_cmdline(int pid, char comm[])
2432 strcpy(comm, "<idle>");
2436 if (WARN_ON_ONCE(pid < 0)) {
2437 strcpy(comm, "<XXX>");
2441 tpid = pid & (PID_MAX_DEFAULT - 1);
2442 map = savedcmd->map_pid_to_cmdline[tpid];
2443 if (map != NO_CMDLINE_MAP) {
2444 tpid = savedcmd->map_cmdline_to_pid[map];
2446 strlcpy(comm, get_saved_cmdlines(map), TASK_COMM_LEN);
2450 strcpy(comm, "<...>");
2453 void trace_find_cmdline(int pid, char comm[])
2456 arch_spin_lock(&trace_cmdline_lock);
2458 __trace_find_cmdline(pid, comm);
2460 arch_spin_unlock(&trace_cmdline_lock);
2464 int trace_find_tgid(int pid)
2466 if (unlikely(!tgid_map || !pid || pid > PID_MAX_DEFAULT))
2469 return tgid_map[pid];
2472 static int trace_save_tgid(struct task_struct *tsk)
2474 /* treat recording of idle task as a success */
2478 if (unlikely(!tgid_map || tsk->pid > PID_MAX_DEFAULT))
2481 tgid_map[tsk->pid] = tsk->tgid;
2485 static bool tracing_record_taskinfo_skip(int flags)
2487 if (unlikely(!(flags & (TRACE_RECORD_CMDLINE | TRACE_RECORD_TGID))))
2489 if (atomic_read(&trace_record_taskinfo_disabled) || !tracing_is_on())
2491 if (!__this_cpu_read(trace_taskinfo_save))
2497 * tracing_record_taskinfo - record the task info of a task
2499 * @task: task to record
2500 * @flags: TRACE_RECORD_CMDLINE for recording comm
2501 * TRACE_RECORD_TGID for recording tgid
2503 void tracing_record_taskinfo(struct task_struct *task, int flags)
2507 if (tracing_record_taskinfo_skip(flags))
2511 * Record as much task information as possible. If some fail, continue
2512 * to try to record the others.
2514 done = !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(task);
2515 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(task);
2517 /* If recording any information failed, retry again soon. */
2521 __this_cpu_write(trace_taskinfo_save, false);
2525 * tracing_record_taskinfo_sched_switch - record task info for sched_switch
2527 * @prev: previous task during sched_switch
2528 * @next: next task during sched_switch
2529 * @flags: TRACE_RECORD_CMDLINE for recording comm
2530 * TRACE_RECORD_TGID for recording tgid
2532 void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
2533 struct task_struct *next, int flags)
2537 if (tracing_record_taskinfo_skip(flags))
2541 * Record as much task information as possible. If some fail, continue
2542 * to try to record the others.
2544 done = !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(prev);
2545 done &= !(flags & TRACE_RECORD_CMDLINE) || trace_save_cmdline(next);
2546 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(prev);
2547 done &= !(flags & TRACE_RECORD_TGID) || trace_save_tgid(next);
2549 /* If recording any information failed, retry again soon. */
2553 __this_cpu_write(trace_taskinfo_save, false);
2556 /* Helpers to record a specific task information */
2557 void tracing_record_cmdline(struct task_struct *task)
2559 tracing_record_taskinfo(task, TRACE_RECORD_CMDLINE);
2562 void tracing_record_tgid(struct task_struct *task)
2564 tracing_record_taskinfo(task, TRACE_RECORD_TGID);
2568 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2569 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2570 * simplifies those functions and keeps them in sync.
2572 enum print_line_t trace_handle_return(struct trace_seq *s)
2574 return trace_seq_has_overflowed(s) ?
2575 TRACE_TYPE_PARTIAL_LINE : TRACE_TYPE_HANDLED;
2577 EXPORT_SYMBOL_GPL(trace_handle_return);
2579 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status)
2581 unsigned int trace_flags = irqs_status;
2584 pc = preempt_count();
2587 trace_flags |= TRACE_FLAG_NMI;
2588 if (pc & HARDIRQ_MASK)
2589 trace_flags |= TRACE_FLAG_HARDIRQ;
2590 if (in_serving_softirq())
2591 trace_flags |= TRACE_FLAG_SOFTIRQ;
2593 if (tif_need_resched())
2594 trace_flags |= TRACE_FLAG_NEED_RESCHED;
2595 if (test_preempt_need_resched())
2596 trace_flags |= TRACE_FLAG_PREEMPT_RESCHED;
2597 return (trace_flags << 16) | (pc & 0xff);
2600 struct ring_buffer_event *
2601 trace_buffer_lock_reserve(struct trace_buffer *buffer,
2604 unsigned int trace_ctx)
2606 return __trace_buffer_lock_reserve(buffer, type, len, trace_ctx);
2609 DEFINE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
2610 DEFINE_PER_CPU(int, trace_buffered_event_cnt);
2611 static int trace_buffered_event_ref;
2614 * trace_buffered_event_enable - enable buffering events
2616 * When events are being filtered, it is quicker to use a temporary
2617 * buffer to write the event data into if there's a likely chance
2618 * that it will not be committed. The discard of the ring buffer
2619 * is not as fast as committing, and is much slower than copying
2622 * When an event is to be filtered, allocate per cpu buffers to
2623 * write the event data into, and if the event is filtered and discarded
2624 * it is simply dropped, otherwise, the entire data is to be committed
2627 void trace_buffered_event_enable(void)
2629 struct ring_buffer_event *event;
2633 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2635 if (trace_buffered_event_ref++)
2638 for_each_tracing_cpu(cpu) {
2639 page = alloc_pages_node(cpu_to_node(cpu),
2640 GFP_KERNEL | __GFP_NORETRY, 0);
2644 event = page_address(page);
2645 memset(event, 0, sizeof(*event));
2647 per_cpu(trace_buffered_event, cpu) = event;
2650 if (cpu == smp_processor_id() &&
2651 __this_cpu_read(trace_buffered_event) !=
2652 per_cpu(trace_buffered_event, cpu))
2659 trace_buffered_event_disable();
2662 static void enable_trace_buffered_event(void *data)
2664 /* Probably not needed, but do it anyway */
2666 this_cpu_dec(trace_buffered_event_cnt);
2669 static void disable_trace_buffered_event(void *data)
2671 this_cpu_inc(trace_buffered_event_cnt);
2675 * trace_buffered_event_disable - disable buffering events
2677 * When a filter is removed, it is faster to not use the buffered
2678 * events, and to commit directly into the ring buffer. Free up
2679 * the temp buffers when there are no more users. This requires
2680 * special synchronization with current events.
2682 void trace_buffered_event_disable(void)
2686 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2688 if (WARN_ON_ONCE(!trace_buffered_event_ref))
2691 if (--trace_buffered_event_ref)
2695 /* For each CPU, set the buffer as used. */
2696 smp_call_function_many(tracing_buffer_mask,
2697 disable_trace_buffered_event, NULL, 1);
2700 /* Wait for all current users to finish */
2703 for_each_tracing_cpu(cpu) {
2704 free_page((unsigned long)per_cpu(trace_buffered_event, cpu));
2705 per_cpu(trace_buffered_event, cpu) = NULL;
2708 * Make sure trace_buffered_event is NULL before clearing
2709 * trace_buffered_event_cnt.
2714 /* Do the work on each cpu */
2715 smp_call_function_many(tracing_buffer_mask,
2716 enable_trace_buffered_event, NULL, 1);
2720 static struct trace_buffer *temp_buffer;
2722 struct ring_buffer_event *
2723 trace_event_buffer_lock_reserve(struct trace_buffer **current_rb,
2724 struct trace_event_file *trace_file,
2725 int type, unsigned long len,
2726 unsigned int trace_ctx)
2728 struct ring_buffer_event *entry;
2729 struct trace_array *tr = trace_file->tr;
2732 *current_rb = tr->array_buffer.buffer;
2734 if (!tr->no_filter_buffering_ref &&
2735 (trace_file->flags & (EVENT_FILE_FL_SOFT_DISABLED | EVENT_FILE_FL_FILTERED)) &&
2736 (entry = this_cpu_read(trace_buffered_event))) {
2737 /* Try to use the per cpu buffer first */
2738 val = this_cpu_inc_return(trace_buffered_event_cnt);
2739 if ((len < (PAGE_SIZE - sizeof(*entry))) && val == 1) {
2740 trace_event_setup(entry, type, trace_ctx);
2741 entry->array[0] = len;
2744 this_cpu_dec(trace_buffered_event_cnt);
2747 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2750 * If tracing is off, but we have triggers enabled
2751 * we still need to look at the event data. Use the temp_buffer
2752 * to store the trace event for the trigger to use. It's recursive
2753 * safe and will not be recorded anywhere.
2755 if (!entry && trace_file->flags & EVENT_FILE_FL_TRIGGER_COND) {
2756 *current_rb = temp_buffer;
2757 entry = __trace_buffer_lock_reserve(*current_rb, type, len,
2762 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve);
2764 static DEFINE_SPINLOCK(tracepoint_iter_lock);
2765 static DEFINE_MUTEX(tracepoint_printk_mutex);
2767 static void output_printk(struct trace_event_buffer *fbuffer)
2769 struct trace_event_call *event_call;
2770 struct trace_event_file *file;
2771 struct trace_event *event;
2772 unsigned long flags;
2773 struct trace_iterator *iter = tracepoint_print_iter;
2775 /* We should never get here if iter is NULL */
2776 if (WARN_ON_ONCE(!iter))
2779 event_call = fbuffer->trace_file->event_call;
2780 if (!event_call || !event_call->event.funcs ||
2781 !event_call->event.funcs->trace)
2784 file = fbuffer->trace_file;
2785 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
2786 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
2787 !filter_match_preds(file->filter, fbuffer->entry)))
2790 event = &fbuffer->trace_file->event_call->event;
2792 spin_lock_irqsave(&tracepoint_iter_lock, flags);
2793 trace_seq_init(&iter->seq);
2794 iter->ent = fbuffer->entry;
2795 event_call->event.funcs->trace(iter, 0, event);
2796 trace_seq_putc(&iter->seq, 0);
2797 printk("%s", iter->seq.buffer);
2799 spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
2802 int tracepoint_printk_sysctl(struct ctl_table *table, int write,
2803 void *buffer, size_t *lenp,
2806 int save_tracepoint_printk;
2809 mutex_lock(&tracepoint_printk_mutex);
2810 save_tracepoint_printk = tracepoint_printk;
2812 ret = proc_dointvec(table, write, buffer, lenp, ppos);
2815 * This will force exiting early, as tracepoint_printk
2816 * is always zero when tracepoint_printk_iter is not allocated
2818 if (!tracepoint_print_iter)
2819 tracepoint_printk = 0;
2821 if (save_tracepoint_printk == tracepoint_printk)
2824 if (tracepoint_printk)
2825 static_key_enable(&tracepoint_printk_key.key);
2827 static_key_disable(&tracepoint_printk_key.key);
2830 mutex_unlock(&tracepoint_printk_mutex);
2835 void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
2837 if (static_key_false(&tracepoint_printk_key.key))
2838 output_printk(fbuffer);
2840 if (static_branch_unlikely(&trace_event_exports_enabled))
2841 ftrace_exports(fbuffer->event, TRACE_EXPORT_EVENT);
2842 event_trigger_unlock_commit_regs(fbuffer->trace_file, fbuffer->buffer,
2843 fbuffer->event, fbuffer->entry,
2844 fbuffer->trace_ctx, fbuffer->regs);
2846 EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
2851 * trace_buffer_unlock_commit_regs()
2852 * trace_event_buffer_commit()
2853 * trace_event_raw_event_xxx()
2855 # define STACK_SKIP 3
2857 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
2858 struct trace_buffer *buffer,
2859 struct ring_buffer_event *event,
2860 unsigned int trace_ctx,
2861 struct pt_regs *regs)
2863 __buffer_unlock_commit(buffer, event);
2866 * If regs is not set, then skip the necessary functions.
2867 * Note, we can still get here via blktrace, wakeup tracer
2868 * and mmiotrace, but that's ok if they lose a function or
2869 * two. They are not that meaningful.
2871 ftrace_trace_stack(tr, buffer, trace_ctx, regs ? 0 : STACK_SKIP, regs);
2872 ftrace_trace_userstack(tr, buffer, trace_ctx);
2876 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
2879 trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
2880 struct ring_buffer_event *event)
2882 __buffer_unlock_commit(buffer, event);
2886 trace_function(struct trace_array *tr, unsigned long ip, unsigned long
2887 parent_ip, unsigned int trace_ctx)
2889 struct trace_event_call *call = &event_function;
2890 struct trace_buffer *buffer = tr->array_buffer.buffer;
2891 struct ring_buffer_event *event;
2892 struct ftrace_entry *entry;
2894 event = __trace_buffer_lock_reserve(buffer, TRACE_FN, sizeof(*entry),
2898 entry = ring_buffer_event_data(event);
2900 entry->parent_ip = parent_ip;
2902 if (!call_filter_check_discard(call, entry, buffer, event)) {
2903 if (static_branch_unlikely(&trace_function_exports_enabled))
2904 ftrace_exports(event, TRACE_EXPORT_FUNCTION);
2905 __buffer_unlock_commit(buffer, event);
2909 #ifdef CONFIG_STACKTRACE
2911 /* Allow 4 levels of nesting: normal, softirq, irq, NMI */
2912 #define FTRACE_KSTACK_NESTING 4
2914 #define FTRACE_KSTACK_ENTRIES (PAGE_SIZE / FTRACE_KSTACK_NESTING)
2916 struct ftrace_stack {
2917 unsigned long calls[FTRACE_KSTACK_ENTRIES];
2921 struct ftrace_stacks {
2922 struct ftrace_stack stacks[FTRACE_KSTACK_NESTING];
2925 static DEFINE_PER_CPU(struct ftrace_stacks, ftrace_stacks);
2926 static DEFINE_PER_CPU(int, ftrace_stack_reserve);
2928 static void __ftrace_trace_stack(struct trace_buffer *buffer,
2929 unsigned int trace_ctx,
2930 int skip, struct pt_regs *regs)
2932 struct trace_event_call *call = &event_kernel_stack;
2933 struct ring_buffer_event *event;
2934 unsigned int size, nr_entries;
2935 struct ftrace_stack *fstack;
2936 struct stack_entry *entry;
2940 * Add one, for this function and the call to save_stack_trace()
2941 * If regs is set, then these functions will not be in the way.
2943 #ifndef CONFIG_UNWINDER_ORC
2948 preempt_disable_notrace();
2950 stackidx = __this_cpu_inc_return(ftrace_stack_reserve) - 1;
2952 /* This should never happen. If it does, yell once and skip */
2953 if (WARN_ON_ONCE(stackidx >= FTRACE_KSTACK_NESTING))
2957 * The above __this_cpu_inc_return() is 'atomic' cpu local. An
2958 * interrupt will either see the value pre increment or post
2959 * increment. If the interrupt happens pre increment it will have
2960 * restored the counter when it returns. We just need a barrier to
2961 * keep gcc from moving things around.
2965 fstack = this_cpu_ptr(ftrace_stacks.stacks) + stackidx;
2966 size = ARRAY_SIZE(fstack->calls);
2969 nr_entries = stack_trace_save_regs(regs, fstack->calls,
2972 nr_entries = stack_trace_save(fstack->calls, size, skip);
2975 size = nr_entries * sizeof(unsigned long);
2976 event = __trace_buffer_lock_reserve(buffer, TRACE_STACK,
2977 (sizeof(*entry) - sizeof(entry->caller)) + size,
2981 entry = ring_buffer_event_data(event);
2983 memcpy(&entry->caller, fstack->calls, size);
2984 entry->size = nr_entries;
2986 if (!call_filter_check_discard(call, entry, buffer, event))
2987 __buffer_unlock_commit(buffer, event);
2990 /* Again, don't let gcc optimize things here */
2992 __this_cpu_dec(ftrace_stack_reserve);
2993 preempt_enable_notrace();
2997 static inline void ftrace_trace_stack(struct trace_array *tr,
2998 struct trace_buffer *buffer,
2999 unsigned int trace_ctx,
3000 int skip, struct pt_regs *regs)
3002 if (!(tr->trace_flags & TRACE_ITER_STACKTRACE))
3005 __ftrace_trace_stack(buffer, trace_ctx, skip, regs);
3008 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
3011 struct trace_buffer *buffer = tr->array_buffer.buffer;
3013 if (rcu_is_watching()) {
3014 __ftrace_trace_stack(buffer, trace_ctx, skip, NULL);
3019 * When an NMI triggers, RCU is enabled via rcu_nmi_enter(),
3020 * but if the above rcu_is_watching() failed, then the NMI
3021 * triggered someplace critical, and rcu_irq_enter() should
3022 * not be called from NMI.
3024 if (unlikely(in_nmi()))
3027 rcu_irq_enter_irqson();
3028 __ftrace_trace_stack(buffer, trace_ctx, skip, NULL);
3029 rcu_irq_exit_irqson();
3033 * trace_dump_stack - record a stack back trace in the trace buffer
3034 * @skip: Number of functions to skip (helper handlers)
3036 void trace_dump_stack(int skip)
3038 if (tracing_disabled || tracing_selftest_running)
3041 #ifndef CONFIG_UNWINDER_ORC
3042 /* Skip 1 to skip this function. */
3045 __ftrace_trace_stack(global_trace.array_buffer.buffer,
3046 tracing_gen_ctx(), skip, NULL);
3048 EXPORT_SYMBOL_GPL(trace_dump_stack);
3050 #ifdef CONFIG_USER_STACKTRACE_SUPPORT
3051 static DEFINE_PER_CPU(int, user_stack_count);
3054 ftrace_trace_userstack(struct trace_array *tr,
3055 struct trace_buffer *buffer, unsigned int trace_ctx)
3057 struct trace_event_call *call = &event_user_stack;
3058 struct ring_buffer_event *event;
3059 struct userstack_entry *entry;
3061 if (!(tr->trace_flags & TRACE_ITER_USERSTACKTRACE))
3065 * NMIs can not handle page faults, even with fix ups.
3066 * The save user stack can (and often does) fault.
3068 if (unlikely(in_nmi()))
3072 * prevent recursion, since the user stack tracing may
3073 * trigger other kernel events.
3076 if (__this_cpu_read(user_stack_count))
3079 __this_cpu_inc(user_stack_count);
3081 event = __trace_buffer_lock_reserve(buffer, TRACE_USER_STACK,
3082 sizeof(*entry), trace_ctx);
3084 goto out_drop_count;
3085 entry = ring_buffer_event_data(event);
3087 entry->tgid = current->tgid;
3088 memset(&entry->caller, 0, sizeof(entry->caller));
3090 stack_trace_save_user(entry->caller, FTRACE_STACK_ENTRIES);
3091 if (!call_filter_check_discard(call, entry, buffer, event))
3092 __buffer_unlock_commit(buffer, event);
3095 __this_cpu_dec(user_stack_count);
3099 #else /* CONFIG_USER_STACKTRACE_SUPPORT */
3100 static void ftrace_trace_userstack(struct trace_array *tr,
3101 struct trace_buffer *buffer,
3102 unsigned int trace_ctx)
3105 #endif /* !CONFIG_USER_STACKTRACE_SUPPORT */
3107 #endif /* CONFIG_STACKTRACE */
3110 func_repeats_set_delta_ts(struct func_repeats_entry *entry,
3111 unsigned long long delta)
3113 entry->bottom_delta_ts = delta & U32_MAX;
3114 entry->top_delta_ts = (delta >> 32);
3117 void trace_last_func_repeats(struct trace_array *tr,
3118 struct trace_func_repeats *last_info,
3119 unsigned int trace_ctx)
3121 struct trace_buffer *buffer = tr->array_buffer.buffer;
3122 struct func_repeats_entry *entry;
3123 struct ring_buffer_event *event;
3126 event = __trace_buffer_lock_reserve(buffer, TRACE_FUNC_REPEATS,
3127 sizeof(*entry), trace_ctx);
3131 delta = ring_buffer_event_time_stamp(buffer, event) -
3132 last_info->ts_last_call;
3134 entry = ring_buffer_event_data(event);
3135 entry->ip = last_info->ip;
3136 entry->parent_ip = last_info->parent_ip;
3137 entry->count = last_info->count;
3138 func_repeats_set_delta_ts(entry, delta);
3140 __buffer_unlock_commit(buffer, event);
3143 /* created for use with alloc_percpu */
3144 struct trace_buffer_struct {
3146 char buffer[4][TRACE_BUF_SIZE];
3149 static struct trace_buffer_struct *trace_percpu_buffer;
3152 * This allows for lockless recording. If we're nested too deeply, then
3153 * this returns NULL.
3155 static char *get_trace_buf(void)
3157 struct trace_buffer_struct *buffer = this_cpu_ptr(trace_percpu_buffer);
3159 if (!buffer || buffer->nesting >= 4)
3164 /* Interrupts must see nesting incremented before we use the buffer */
3166 return &buffer->buffer[buffer->nesting - 1][0];
3169 static void put_trace_buf(void)
3171 /* Don't let the decrement of nesting leak before this */
3173 this_cpu_dec(trace_percpu_buffer->nesting);
3176 static int alloc_percpu_trace_buffer(void)
3178 struct trace_buffer_struct *buffers;
3180 if (trace_percpu_buffer)
3183 buffers = alloc_percpu(struct trace_buffer_struct);
3184 if (MEM_FAIL(!buffers, "Could not allocate percpu trace_printk buffer"))
3187 trace_percpu_buffer = buffers;
3191 static int buffers_allocated;
3193 void trace_printk_init_buffers(void)
3195 if (buffers_allocated)
3198 if (alloc_percpu_trace_buffer())
3201 /* trace_printk() is for debug use only. Don't use it in production. */
3204 pr_warn("**********************************************************\n");
3205 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3207 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
3209 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
3210 pr_warn("** unsafe for production use. **\n");
3212 pr_warn("** If you see this message and you are not debugging **\n");
3213 pr_warn("** the kernel, report this immediately to your vendor! **\n");
3215 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
3216 pr_warn("**********************************************************\n");
3218 /* Expand the buffers to set size */
3219 tracing_update_buffers();
3221 buffers_allocated = 1;
3224 * trace_printk_init_buffers() can be called by modules.
3225 * If that happens, then we need to start cmdline recording
3226 * directly here. If the global_trace.buffer is already
3227 * allocated here, then this was called by module code.
3229 if (global_trace.array_buffer.buffer)
3230 tracing_start_cmdline_record();
3232 EXPORT_SYMBOL_GPL(trace_printk_init_buffers);
3234 void trace_printk_start_comm(void)
3236 /* Start tracing comms if trace printk is set */
3237 if (!buffers_allocated)
3239 tracing_start_cmdline_record();
3242 static void trace_printk_start_stop_comm(int enabled)
3244 if (!buffers_allocated)
3248 tracing_start_cmdline_record();
3250 tracing_stop_cmdline_record();
3254 * trace_vbprintk - write binary msg to tracing buffer
3255 * @ip: The address of the caller
3256 * @fmt: The string format to write to the buffer
3257 * @args: Arguments for @fmt
3259 int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)
3261 struct trace_event_call *call = &event_bprint;
3262 struct ring_buffer_event *event;
3263 struct trace_buffer *buffer;
3264 struct trace_array *tr = &global_trace;
3265 struct bprint_entry *entry;
3266 unsigned int trace_ctx;
3270 if (unlikely(tracing_selftest_running || tracing_disabled))
3273 /* Don't pollute graph traces with trace_vprintk internals */
3274 pause_graph_tracing();
3276 trace_ctx = tracing_gen_ctx();
3277 preempt_disable_notrace();
3279 tbuffer = get_trace_buf();
3285 len = vbin_printf((u32 *)tbuffer, TRACE_BUF_SIZE/sizeof(int), fmt, args);
3287 if (len > TRACE_BUF_SIZE/sizeof(int) || len < 0)
3290 size = sizeof(*entry) + sizeof(u32) * len;
3291 buffer = tr->array_buffer.buffer;
3292 ring_buffer_nest_start(buffer);
3293 event = __trace_buffer_lock_reserve(buffer, TRACE_BPRINT, size,
3297 entry = ring_buffer_event_data(event);
3301 memcpy(entry->buf, tbuffer, sizeof(u32) * len);
3302 if (!call_filter_check_discard(call, entry, buffer, event)) {
3303 __buffer_unlock_commit(buffer, event);
3304 ftrace_trace_stack(tr, buffer, trace_ctx, 6, NULL);
3308 ring_buffer_nest_end(buffer);
3313 preempt_enable_notrace();
3314 unpause_graph_tracing();
3318 EXPORT_SYMBOL_GPL(trace_vbprintk);
3322 __trace_array_vprintk(struct trace_buffer *buffer,
3323 unsigned long ip, const char *fmt, va_list args)
3325 struct trace_event_call *call = &event_print;
3326 struct ring_buffer_event *event;
3328 struct print_entry *entry;
3329 unsigned int trace_ctx;
3332 if (tracing_disabled || tracing_selftest_running)
3335 /* Don't pollute graph traces with trace_vprintk internals */
3336 pause_graph_tracing();
3338 trace_ctx = tracing_gen_ctx();
3339 preempt_disable_notrace();
3342 tbuffer = get_trace_buf();
3348 len = vscnprintf(tbuffer, TRACE_BUF_SIZE, fmt, args);
3350 size = sizeof(*entry) + len + 1;
3351 ring_buffer_nest_start(buffer);
3352 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
3356 entry = ring_buffer_event_data(event);
3359 memcpy(&entry->buf, tbuffer, len + 1);
3360 if (!call_filter_check_discard(call, entry, buffer, event)) {
3361 __buffer_unlock_commit(buffer, event);
3362 ftrace_trace_stack(&global_trace, buffer, trace_ctx, 6, NULL);
3366 ring_buffer_nest_end(buffer);
3370 preempt_enable_notrace();
3371 unpause_graph_tracing();
3377 int trace_array_vprintk(struct trace_array *tr,
3378 unsigned long ip, const char *fmt, va_list args)
3380 return __trace_array_vprintk(tr->array_buffer.buffer, ip, fmt, args);
3384 * trace_array_printk - Print a message to a specific instance
3385 * @tr: The instance trace_array descriptor
3386 * @ip: The instruction pointer that this is called from.
3387 * @fmt: The format to print (printf format)
3389 * If a subsystem sets up its own instance, they have the right to
3390 * printk strings into their tracing instance buffer using this
3391 * function. Note, this function will not write into the top level
3392 * buffer (use trace_printk() for that), as writing into the top level
3393 * buffer should only have events that can be individually disabled.
3394 * trace_printk() is only used for debugging a kernel, and should not
3395 * be ever incorporated in normal use.
3397 * trace_array_printk() can be used, as it will not add noise to the
3398 * top level tracing buffer.
3400 * Note, trace_array_init_printk() must be called on @tr before this
3404 int trace_array_printk(struct trace_array *tr,
3405 unsigned long ip, const char *fmt, ...)
3413 /* This is only allowed for created instances */
3414 if (tr == &global_trace)
3417 if (!(tr->trace_flags & TRACE_ITER_PRINTK))
3421 ret = trace_array_vprintk(tr, ip, fmt, ap);
3425 EXPORT_SYMBOL_GPL(trace_array_printk);
3428 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3429 * @tr: The trace array to initialize the buffers for
3431 * As trace_array_printk() only writes into instances, they are OK to
3432 * have in the kernel (unlike trace_printk()). This needs to be called
3433 * before trace_array_printk() can be used on a trace_array.
3435 int trace_array_init_printk(struct trace_array *tr)
3440 /* This is only allowed for created instances */
3441 if (tr == &global_trace)
3444 return alloc_percpu_trace_buffer();
3446 EXPORT_SYMBOL_GPL(trace_array_init_printk);
3449 int trace_array_printk_buf(struct trace_buffer *buffer,
3450 unsigned long ip, const char *fmt, ...)
3455 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
3459 ret = __trace_array_vprintk(buffer, ip, fmt, ap);
3465 int trace_vprintk(unsigned long ip, const char *fmt, va_list args)
3467 return trace_array_vprintk(&global_trace, ip, fmt, args);
3469 EXPORT_SYMBOL_GPL(trace_vprintk);
3471 static void trace_iterator_increment(struct trace_iterator *iter)
3473 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, iter->cpu);
3477 ring_buffer_iter_advance(buf_iter);
3480 static struct trace_entry *
3481 peek_next_entry(struct trace_iterator *iter, int cpu, u64 *ts,
3482 unsigned long *lost_events)
3484 struct ring_buffer_event *event;
3485 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, cpu);
3488 event = ring_buffer_iter_peek(buf_iter, ts);
3490 *lost_events = ring_buffer_iter_dropped(buf_iter) ?
3491 (unsigned long)-1 : 0;
3493 event = ring_buffer_peek(iter->array_buffer->buffer, cpu, ts,
3498 iter->ent_size = ring_buffer_event_length(event);
3499 return ring_buffer_event_data(event);
3505 static struct trace_entry *
3506 __find_next_entry(struct trace_iterator *iter, int *ent_cpu,
3507 unsigned long *missing_events, u64 *ent_ts)
3509 struct trace_buffer *buffer = iter->array_buffer->buffer;
3510 struct trace_entry *ent, *next = NULL;
3511 unsigned long lost_events = 0, next_lost = 0;
3512 int cpu_file = iter->cpu_file;
3513 u64 next_ts = 0, ts;
3519 * If we are in a per_cpu trace file, don't bother by iterating over
3520 * all cpu and peek directly.
3522 if (cpu_file > RING_BUFFER_ALL_CPUS) {
3523 if (ring_buffer_empty_cpu(buffer, cpu_file))
3525 ent = peek_next_entry(iter, cpu_file, ent_ts, missing_events);
3527 *ent_cpu = cpu_file;
3532 for_each_tracing_cpu(cpu) {
3534 if (ring_buffer_empty_cpu(buffer, cpu))
3537 ent = peek_next_entry(iter, cpu, &ts, &lost_events);
3540 * Pick the entry with the smallest timestamp:
3542 if (ent && (!next || ts < next_ts)) {
3546 next_lost = lost_events;
3547 next_size = iter->ent_size;
3551 iter->ent_size = next_size;
3554 *ent_cpu = next_cpu;
3560 *missing_events = next_lost;
3565 #define STATIC_FMT_BUF_SIZE 128
3566 static char static_fmt_buf[STATIC_FMT_BUF_SIZE];
3568 static char *trace_iter_expand_format(struct trace_iterator *iter)
3573 * iter->tr is NULL when used with tp_printk, which makes
3574 * this get called where it is not safe to call krealloc().
3576 if (!iter->tr || iter->fmt == static_fmt_buf)
3579 tmp = krealloc(iter->fmt, iter->fmt_size + STATIC_FMT_BUF_SIZE,
3582 iter->fmt_size += STATIC_FMT_BUF_SIZE;
3589 /* Returns true if the string is safe to dereference from an event */
3590 static bool trace_safe_str(struct trace_iterator *iter, const char *str)
3592 unsigned long addr = (unsigned long)str;
3593 struct trace_event *trace_event;
3594 struct trace_event_call *event;
3596 /* OK if part of the event data */
3597 if ((addr >= (unsigned long)iter->ent) &&
3598 (addr < (unsigned long)iter->ent + iter->ent_size))
3601 /* OK if part of the temp seq buffer */
3602 if ((addr >= (unsigned long)iter->tmp_seq.buffer) &&
3603 (addr < (unsigned long)iter->tmp_seq.buffer + PAGE_SIZE))
3606 /* Core rodata can not be freed */
3607 if (is_kernel_rodata(addr))
3610 if (trace_is_tracepoint_string(str))
3614 * Now this could be a module event, referencing core module
3615 * data, which is OK.
3620 trace_event = ftrace_find_event(iter->ent->type);
3624 event = container_of(trace_event, struct trace_event_call, event);
3628 /* Would rather have rodata, but this will suffice */
3629 if (within_module_core(addr, event->mod))
3635 static const char *show_buffer(struct trace_seq *s)
3637 struct seq_buf *seq = &s->seq;
3639 seq_buf_terminate(seq);
3644 static DEFINE_STATIC_KEY_FALSE(trace_no_verify);
3646 static int test_can_verify_check(const char *fmt, ...)
3653 * The verifier is dependent on vsnprintf() modifies the va_list
3654 * passed to it, where it is sent as a reference. Some architectures
3655 * (like x86_32) passes it by value, which means that vsnprintf()
3656 * does not modify the va_list passed to it, and the verifier
3657 * would then need to be able to understand all the values that
3658 * vsnprintf can use. If it is passed by value, then the verifier
3662 vsnprintf(buf, 16, "%d", ap);
3663 ret = va_arg(ap, int);
3669 static void test_can_verify(void)
3671 if (!test_can_verify_check("%d %d", 0, 1)) {
3672 pr_info("trace event string verifier disabled\n");
3673 static_branch_inc(&trace_no_verify);
3678 * trace_check_vprintf - Check dereferenced strings while writing to the seq buffer
3679 * @iter: The iterator that holds the seq buffer and the event being printed
3680 * @fmt: The format used to print the event
3681 * @ap: The va_list holding the data to print from @fmt.
3683 * This writes the data into the @iter->seq buffer using the data from
3684 * @fmt and @ap. If the format has a %s, then the source of the string
3685 * is examined to make sure it is safe to print, otherwise it will
3686 * warn and print "[UNSAFE MEMORY]" in place of the dereferenced string
3689 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
3692 const char *p = fmt;
3696 if (WARN_ON_ONCE(!fmt))
3699 if (static_branch_unlikely(&trace_no_verify))
3702 /* Don't bother checking when doing a ftrace_dump() */
3703 if (iter->fmt == static_fmt_buf)
3709 /* We only care about %s and variants */
3710 for (i = 0; p[i]; i++) {
3711 if (i + 1 >= iter->fmt_size) {
3713 * If we can't expand the copy buffer,
3716 if (!trace_iter_expand_format(iter))
3720 if (p[i] == '\\' && p[i+1]) {
3725 /* Need to test cases like %08.*s */
3726 for (j = 1; p[i+j]; j++) {
3727 if (isdigit(p[i+j]) ||
3738 /* If no %s found then just print normally */
3742 /* Copy up to the %s, and print that */
3743 strncpy(iter->fmt, p, i);
3744 iter->fmt[i] = '\0';
3745 trace_seq_vprintf(&iter->seq, iter->fmt, ap);
3747 /* The ap now points to the string data of the %s */
3748 str = va_arg(ap, const char *);
3751 * If you hit this warning, it is likely that the
3752 * trace event in question used %s on a string that
3753 * was saved at the time of the event, but may not be
3754 * around when the trace is read. Use __string(),
3755 * __assign_str() and __get_str() helpers in the TRACE_EVENT()
3756 * instead. See samples/trace_events/trace-events-sample.h
3759 if (WARN_ONCE(!trace_safe_str(iter, str),
3760 "fmt: '%s' current_buffer: '%s'",
3761 fmt, show_buffer(&iter->seq))) {
3764 /* Try to safely read the string */
3765 ret = strncpy_from_kernel_nofault(iter->fmt, str,
3768 trace_seq_printf(&iter->seq, "(0x%px)", str);
3770 trace_seq_printf(&iter->seq, "(0x%px:%s)",
3772 str = "[UNSAFE-MEMORY]";
3773 strcpy(iter->fmt, "%s");
3775 strncpy(iter->fmt, p + i, j + 1);
3776 iter->fmt[j+1] = '\0';
3778 trace_seq_printf(&iter->seq, iter->fmt, str);
3784 trace_seq_vprintf(&iter->seq, p, ap);
3787 const char *trace_event_format(struct trace_iterator *iter, const char *fmt)
3789 const char *p, *new_fmt;
3792 if (WARN_ON_ONCE(!fmt))
3795 if (!iter->tr || iter->tr->trace_flags & TRACE_ITER_HASH_PTR)
3799 new_fmt = q = iter->fmt;
3801 if (unlikely(q - new_fmt + 3 > iter->fmt_size)) {
3802 if (!trace_iter_expand_format(iter))
3805 q += iter->fmt - new_fmt;
3806 new_fmt = iter->fmt;
3811 /* Replace %p with %px */
3815 } else if (p[0] == 'p' && !isalnum(p[1])) {
3826 #define STATIC_TEMP_BUF_SIZE 128
3827 static char static_temp_buf[STATIC_TEMP_BUF_SIZE] __aligned(4);
3829 /* Find the next real entry, without updating the iterator itself */
3830 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
3831 int *ent_cpu, u64 *ent_ts)
3833 /* __find_next_entry will reset ent_size */
3834 int ent_size = iter->ent_size;
3835 struct trace_entry *entry;
3838 * If called from ftrace_dump(), then the iter->temp buffer
3839 * will be the static_temp_buf and not created from kmalloc.
3840 * If the entry size is greater than the buffer, we can
3841 * not save it. Just return NULL in that case. This is only
3842 * used to add markers when two consecutive events' time
3843 * stamps have a large delta. See trace_print_lat_context()
3845 if (iter->temp == static_temp_buf &&
3846 STATIC_TEMP_BUF_SIZE < ent_size)
3850 * The __find_next_entry() may call peek_next_entry(), which may
3851 * call ring_buffer_peek() that may make the contents of iter->ent
3852 * undefined. Need to copy iter->ent now.
3854 if (iter->ent && iter->ent != iter->temp) {
3855 if ((!iter->temp || iter->temp_size < iter->ent_size) &&
3856 !WARN_ON_ONCE(iter->temp == static_temp_buf)) {
3858 temp = kmalloc(iter->ent_size, GFP_KERNEL);
3863 iter->temp_size = iter->ent_size;
3865 memcpy(iter->temp, iter->ent, iter->ent_size);
3866 iter->ent = iter->temp;
3868 entry = __find_next_entry(iter, ent_cpu, NULL, ent_ts);
3869 /* Put back the original ent_size */
3870 iter->ent_size = ent_size;
3875 /* Find the next real entry, and increment the iterator to the next entry */
3876 void *trace_find_next_entry_inc(struct trace_iterator *iter)
3878 iter->ent = __find_next_entry(iter, &iter->cpu,
3879 &iter->lost_events, &iter->ts);
3882 trace_iterator_increment(iter);
3884 return iter->ent ? iter : NULL;
3887 static void trace_consume(struct trace_iterator *iter)
3889 ring_buffer_consume(iter->array_buffer->buffer, iter->cpu, &iter->ts,
3890 &iter->lost_events);
3893 static void *s_next(struct seq_file *m, void *v, loff_t *pos)
3895 struct trace_iterator *iter = m->private;
3899 WARN_ON_ONCE(iter->leftover);
3903 /* can't go backwards */
3908 ent = trace_find_next_entry_inc(iter);
3912 while (ent && iter->idx < i)
3913 ent = trace_find_next_entry_inc(iter);
3920 void tracing_iter_reset(struct trace_iterator *iter, int cpu)
3922 struct ring_buffer_iter *buf_iter;
3923 unsigned long entries = 0;
3926 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = 0;
3928 buf_iter = trace_buffer_iter(iter, cpu);
3932 ring_buffer_iter_reset(buf_iter);
3935 * We could have the case with the max latency tracers
3936 * that a reset never took place on a cpu. This is evident
3937 * by the timestamp being before the start of the buffer.
3939 while (ring_buffer_iter_peek(buf_iter, &ts)) {
3940 if (ts >= iter->array_buffer->time_start)
3943 ring_buffer_iter_advance(buf_iter);
3946 per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = entries;
3950 * The current tracer is copied to avoid a global locking
3953 static void *s_start(struct seq_file *m, loff_t *pos)
3955 struct trace_iterator *iter = m->private;
3956 struct trace_array *tr = iter->tr;
3957 int cpu_file = iter->cpu_file;
3963 * copy the tracer to avoid using a global lock all around.
3964 * iter->trace is a copy of current_trace, the pointer to the
3965 * name may be used instead of a strcmp(), as iter->trace->name
3966 * will point to the same string as current_trace->name.
3968 mutex_lock(&trace_types_lock);
3969 if (unlikely(tr->current_trace && iter->trace->name != tr->current_trace->name))
3970 *iter->trace = *tr->current_trace;
3971 mutex_unlock(&trace_types_lock);
3973 #ifdef CONFIG_TRACER_MAX_TRACE
3974 if (iter->snapshot && iter->trace->use_max_tr)
3975 return ERR_PTR(-EBUSY);
3978 if (!iter->snapshot)
3979 atomic_inc(&trace_record_taskinfo_disabled);
3981 if (*pos != iter->pos) {
3986 if (cpu_file == RING_BUFFER_ALL_CPUS) {
3987 for_each_tracing_cpu(cpu)
3988 tracing_iter_reset(iter, cpu);
3990 tracing_iter_reset(iter, cpu_file);
3993 for (p = iter; p && l < *pos; p = s_next(m, p, &l))
3998 * If we overflowed the seq_file before, then we want
3999 * to just reuse the trace_seq buffer again.
4005 p = s_next(m, p, &l);
4009 trace_event_read_lock();
4010 trace_access_lock(cpu_file);
4014 static void s_stop(struct seq_file *m, void *p)
4016 struct trace_iterator *iter = m->private;
4018 #ifdef CONFIG_TRACER_MAX_TRACE
4019 if (iter->snapshot && iter->trace->use_max_tr)
4023 if (!iter->snapshot)
4024 atomic_dec(&trace_record_taskinfo_disabled);
4026 trace_access_unlock(iter->cpu_file);
4027 trace_event_read_unlock();
4031 get_total_entries_cpu(struct array_buffer *buf, unsigned long *total,
4032 unsigned long *entries, int cpu)
4034 unsigned long count;
4036 count = ring_buffer_entries_cpu(buf->buffer, cpu);
4038 * If this buffer has skipped entries, then we hold all
4039 * entries for the trace and we need to ignore the
4040 * ones before the time stamp.
4042 if (per_cpu_ptr(buf->data, cpu)->skipped_entries) {
4043 count -= per_cpu_ptr(buf->data, cpu)->skipped_entries;
4044 /* total is the same as the entries */
4048 ring_buffer_overrun_cpu(buf->buffer, cpu);
4053 get_total_entries(struct array_buffer *buf,
4054 unsigned long *total, unsigned long *entries)
4062 for_each_tracing_cpu(cpu) {
4063 get_total_entries_cpu(buf, &t, &e, cpu);
4069 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu)
4071 unsigned long total, entries;
4076 get_total_entries_cpu(&tr->array_buffer, &total, &entries, cpu);
4081 unsigned long trace_total_entries(struct trace_array *tr)
4083 unsigned long total, entries;
4088 get_total_entries(&tr->array_buffer, &total, &entries);
4093 static void print_lat_help_header(struct seq_file *m)
4095 seq_puts(m, "# _------=> CPU# \n"
4096 "# / _-----=> irqs-off \n"
4097 "# | / _----=> need-resched \n"
4098 "# || / _---=> hardirq/softirq \n"
4099 "# ||| / _--=> preempt-depth \n"
4101 "# cmd pid ||||| time | caller \n"
4102 "# \\ / ||||| \\ | / \n");
4105 static void print_event_info(struct array_buffer *buf, struct seq_file *m)
4107 unsigned long total;
4108 unsigned long entries;
4110 get_total_entries(buf, &total, &entries);
4111 seq_printf(m, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
4112 entries, total, num_online_cpus());
4116 static void print_func_help_header(struct array_buffer *buf, struct seq_file *m,
4119 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4121 print_event_info(buf, m);
4123 seq_printf(m, "# TASK-PID %s CPU# TIMESTAMP FUNCTION\n", tgid ? " TGID " : "");
4124 seq_printf(m, "# | | %s | | |\n", tgid ? " | " : "");
4127 static void print_func_help_header_irq(struct array_buffer *buf, struct seq_file *m,
4130 bool tgid = flags & TRACE_ITER_RECORD_TGID;
4131 const char *space = " ";
4132 int prec = tgid ? 12 : 2;
4134 print_event_info(buf, m);
4136 seq_printf(m, "# %.*s _-----=> irqs-off\n", prec, space);
4137 seq_printf(m, "# %.*s / _----=> need-resched\n", prec, space);
4138 seq_printf(m, "# %.*s| / _---=> hardirq/softirq\n", prec, space);
4139 seq_printf(m, "# %.*s|| / _--=> preempt-depth\n", prec, space);
4140 seq_printf(m, "# %.*s||| / delay\n", prec, space);
4141 seq_printf(m, "# TASK-PID %.*s CPU# |||| TIMESTAMP FUNCTION\n", prec, " TGID ");
4142 seq_printf(m, "# | | %.*s | |||| | |\n", prec, " | ");
4146 print_trace_header(struct seq_file *m, struct trace_iterator *iter)
4148 unsigned long sym_flags = (global_trace.trace_flags & TRACE_ITER_SYM_MASK);
4149 struct array_buffer *buf = iter->array_buffer;
4150 struct trace_array_cpu *data = per_cpu_ptr(buf->data, buf->cpu);
4151 struct tracer *type = iter->trace;
4152 unsigned long entries;
4153 unsigned long total;
4154 const char *name = "preemption";
4158 get_total_entries(buf, &total, &entries);
4160 seq_printf(m, "# %s latency trace v1.1.5 on %s\n",
4162 seq_puts(m, "# -----------------------------------"
4163 "---------------------------------\n");
4164 seq_printf(m, "# latency: %lu us, #%lu/%lu, CPU#%d |"
4165 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
4166 nsecs_to_usecs(data->saved_latency),
4170 #if defined(CONFIG_PREEMPT_NONE)
4172 #elif defined(CONFIG_PREEMPT_VOLUNTARY)
4174 #elif defined(CONFIG_PREEMPT)
4176 #elif defined(CONFIG_PREEMPT_RT)
4181 /* These are reserved for later use */
4184 seq_printf(m, " #P:%d)\n", num_online_cpus());
4188 seq_puts(m, "# -----------------\n");
4189 seq_printf(m, "# | task: %.16s-%d "
4190 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
4191 data->comm, data->pid,
4192 from_kuid_munged(seq_user_ns(m), data->uid), data->nice,
4193 data->policy, data->rt_priority);
4194 seq_puts(m, "# -----------------\n");
4196 if (data->critical_start) {
4197 seq_puts(m, "# => started at: ");
4198 seq_print_ip_sym(&iter->seq, data->critical_start, sym_flags);
4199 trace_print_seq(m, &iter->seq);
4200 seq_puts(m, "\n# => ended at: ");
4201 seq_print_ip_sym(&iter->seq, data->critical_end, sym_flags);
4202 trace_print_seq(m, &iter->seq);
4203 seq_puts(m, "\n#\n");
4209 static void test_cpu_buff_start(struct trace_iterator *iter)
4211 struct trace_seq *s = &iter->seq;
4212 struct trace_array *tr = iter->tr;
4214 if (!(tr->trace_flags & TRACE_ITER_ANNOTATE))
4217 if (!(iter->iter_flags & TRACE_FILE_ANNOTATE))
4220 if (cpumask_available(iter->started) &&
4221 cpumask_test_cpu(iter->cpu, iter->started))
4224 if (per_cpu_ptr(iter->array_buffer->data, iter->cpu)->skipped_entries)
4227 if (cpumask_available(iter->started))
4228 cpumask_set_cpu(iter->cpu, iter->started);
4230 /* Don't print started cpu buffer for the first entry of the trace */
4232 trace_seq_printf(s, "##### CPU %u buffer started ####\n",
4236 static enum print_line_t print_trace_fmt(struct trace_iterator *iter)
4238 struct trace_array *tr = iter->tr;
4239 struct trace_seq *s = &iter->seq;
4240 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
4241 struct trace_entry *entry;
4242 struct trace_event *event;
4246 test_cpu_buff_start(iter);
4248 event = ftrace_find_event(entry->type);
4250 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4251 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4252 trace_print_lat_context(iter);
4254 trace_print_context(iter);
4257 if (trace_seq_has_overflowed(s))
4258 return TRACE_TYPE_PARTIAL_LINE;
4261 return event->funcs->trace(iter, sym_flags, event);
4263 trace_seq_printf(s, "Unknown type %d\n", entry->type);
4265 return trace_handle_return(s);
4268 static enum print_line_t print_raw_fmt(struct trace_iterator *iter)
4270 struct trace_array *tr = iter->tr;
4271 struct trace_seq *s = &iter->seq;
4272 struct trace_entry *entry;
4273 struct trace_event *event;
4277 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO)
4278 trace_seq_printf(s, "%d %d %llu ",
4279 entry->pid, iter->cpu, iter->ts);
4281 if (trace_seq_has_overflowed(s))
4282 return TRACE_TYPE_PARTIAL_LINE;
4284 event = ftrace_find_event(entry->type);
4286 return event->funcs->raw(iter, 0, event);
4288 trace_seq_printf(s, "%d ?\n", entry->type);
4290 return trace_handle_return(s);
4293 static enum print_line_t print_hex_fmt(struct trace_iterator *iter)
4295 struct trace_array *tr = iter->tr;
4296 struct trace_seq *s = &iter->seq;
4297 unsigned char newline = '\n';
4298 struct trace_entry *entry;
4299 struct trace_event *event;
4303 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4304 SEQ_PUT_HEX_FIELD(s, entry->pid);
4305 SEQ_PUT_HEX_FIELD(s, iter->cpu);
4306 SEQ_PUT_HEX_FIELD(s, iter->ts);
4307 if (trace_seq_has_overflowed(s))
4308 return TRACE_TYPE_PARTIAL_LINE;
4311 event = ftrace_find_event(entry->type);
4313 enum print_line_t ret = event->funcs->hex(iter, 0, event);
4314 if (ret != TRACE_TYPE_HANDLED)
4318 SEQ_PUT_FIELD(s, newline);
4320 return trace_handle_return(s);
4323 static enum print_line_t print_bin_fmt(struct trace_iterator *iter)
4325 struct trace_array *tr = iter->tr;
4326 struct trace_seq *s = &iter->seq;
4327 struct trace_entry *entry;
4328 struct trace_event *event;
4332 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
4333 SEQ_PUT_FIELD(s, entry->pid);
4334 SEQ_PUT_FIELD(s, iter->cpu);
4335 SEQ_PUT_FIELD(s, iter->ts);
4336 if (trace_seq_has_overflowed(s))
4337 return TRACE_TYPE_PARTIAL_LINE;
4340 event = ftrace_find_event(entry->type);
4341 return event ? event->funcs->binary(iter, 0, event) :
4345 int trace_empty(struct trace_iterator *iter)
4347 struct ring_buffer_iter *buf_iter;
4350 /* If we are looking at one CPU buffer, only check that one */
4351 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
4352 cpu = iter->cpu_file;
4353 buf_iter = trace_buffer_iter(iter, cpu);
4355 if (!ring_buffer_iter_empty(buf_iter))
4358 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4364 for_each_tracing_cpu(cpu) {
4365 buf_iter = trace_buffer_iter(iter, cpu);
4367 if (!ring_buffer_iter_empty(buf_iter))
4370 if (!ring_buffer_empty_cpu(iter->array_buffer->buffer, cpu))
4378 /* Called with trace_event_read_lock() held. */
4379 enum print_line_t print_trace_line(struct trace_iterator *iter)
4381 struct trace_array *tr = iter->tr;
4382 unsigned long trace_flags = tr->trace_flags;
4383 enum print_line_t ret;
4385 if (iter->lost_events) {
4386 if (iter->lost_events == (unsigned long)-1)
4387 trace_seq_printf(&iter->seq, "CPU:%d [LOST EVENTS]\n",
4390 trace_seq_printf(&iter->seq, "CPU:%d [LOST %lu EVENTS]\n",
4391 iter->cpu, iter->lost_events);
4392 if (trace_seq_has_overflowed(&iter->seq))
4393 return TRACE_TYPE_PARTIAL_LINE;
4396 if (iter->trace && iter->trace->print_line) {
4397 ret = iter->trace->print_line(iter);
4398 if (ret != TRACE_TYPE_UNHANDLED)
4402 if (iter->ent->type == TRACE_BPUTS &&
4403 trace_flags & TRACE_ITER_PRINTK &&
4404 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4405 return trace_print_bputs_msg_only(iter);
4407 if (iter->ent->type == TRACE_BPRINT &&
4408 trace_flags & TRACE_ITER_PRINTK &&
4409 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4410 return trace_print_bprintk_msg_only(iter);
4412 if (iter->ent->type == TRACE_PRINT &&
4413 trace_flags & TRACE_ITER_PRINTK &&
4414 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
4415 return trace_print_printk_msg_only(iter);
4417 if (trace_flags & TRACE_ITER_BIN)
4418 return print_bin_fmt(iter);
4420 if (trace_flags & TRACE_ITER_HEX)
4421 return print_hex_fmt(iter);
4423 if (trace_flags & TRACE_ITER_RAW)
4424 return print_raw_fmt(iter);
4426 return print_trace_fmt(iter);
4429 void trace_latency_header(struct seq_file *m)
4431 struct trace_iterator *iter = m->private;
4432 struct trace_array *tr = iter->tr;
4434 /* print nothing if the buffers are empty */
4435 if (trace_empty(iter))
4438 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
4439 print_trace_header(m, iter);
4441 if (!(tr->trace_flags & TRACE_ITER_VERBOSE))
4442 print_lat_help_header(m);
4445 void trace_default_header(struct seq_file *m)
4447 struct trace_iterator *iter = m->private;
4448 struct trace_array *tr = iter->tr;
4449 unsigned long trace_flags = tr->trace_flags;
4451 if (!(trace_flags & TRACE_ITER_CONTEXT_INFO))
4454 if (iter->iter_flags & TRACE_FILE_LAT_FMT) {
4455 /* print nothing if the buffers are empty */
4456 if (trace_empty(iter))
4458 print_trace_header(m, iter);
4459 if (!(trace_flags & TRACE_ITER_VERBOSE))
4460 print_lat_help_header(m);
4462 if (!(trace_flags & TRACE_ITER_VERBOSE)) {
4463 if (trace_flags & TRACE_ITER_IRQ_INFO)
4464 print_func_help_header_irq(iter->array_buffer,
4467 print_func_help_header(iter->array_buffer, m,
4473 static void test_ftrace_alive(struct seq_file *m)
4475 if (!ftrace_is_dead())
4477 seq_puts(m, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
4478 "# MAY BE MISSING FUNCTION EVENTS\n");
4481 #ifdef CONFIG_TRACER_MAX_TRACE
4482 static void show_snapshot_main_help(struct seq_file *m)
4484 seq_puts(m, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
4485 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4486 "# Takes a snapshot of the main buffer.\n"
4487 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
4488 "# (Doesn't have to be '2' works with any number that\n"
4489 "# is not a '0' or '1')\n");
4492 static void show_snapshot_percpu_help(struct seq_file *m)
4494 seq_puts(m, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
4495 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
4496 seq_puts(m, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
4497 "# Takes a snapshot of the main buffer for this cpu.\n");
4499 seq_puts(m, "# echo 1 > snapshot : Not supported with this kernel.\n"
4500 "# Must use main snapshot file to allocate.\n");
4502 seq_puts(m, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
4503 "# (Doesn't have to be '2' works with any number that\n"
4504 "# is not a '0' or '1')\n");
4507 static void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter)
4509 if (iter->tr->allocated_snapshot)
4510 seq_puts(m, "#\n# * Snapshot is allocated *\n#\n");
4512 seq_puts(m, "#\n# * Snapshot is freed *\n#\n");
4514 seq_puts(m, "# Snapshot commands:\n");
4515 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
4516 show_snapshot_main_help(m);
4518 show_snapshot_percpu_help(m);
4521 /* Should never be called */
4522 static inline void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter) { }
4525 static int s_show(struct seq_file *m, void *v)
4527 struct trace_iterator *iter = v;
4530 if (iter->ent == NULL) {
4532 seq_printf(m, "# tracer: %s\n", iter->trace->name);
4534 test_ftrace_alive(m);
4536 if (iter->snapshot && trace_empty(iter))
4537 print_snapshot_help(m, iter);
4538 else if (iter->trace && iter->trace->print_header)
4539 iter->trace->print_header(m);
4541 trace_default_header(m);
4543 } else if (iter->leftover) {
4545 * If we filled the seq_file buffer earlier, we
4546 * want to just show it now.
4548 ret = trace_print_seq(m, &iter->seq);
4550 /* ret should this time be zero, but you never know */
4551 iter->leftover = ret;
4554 print_trace_line(iter);
4555 ret = trace_print_seq(m, &iter->seq);
4557 * If we overflow the seq_file buffer, then it will
4558 * ask us for this data again at start up.
4560 * ret is 0 if seq_file write succeeded.
4563 iter->leftover = ret;
4570 * Should be used after trace_array_get(), trace_types_lock
4571 * ensures that i_cdev was already initialized.
4573 static inline int tracing_get_cpu(struct inode *inode)
4575 if (inode->i_cdev) /* See trace_create_cpu_file() */
4576 return (long)inode->i_cdev - 1;
4577 return RING_BUFFER_ALL_CPUS;
4580 static const struct seq_operations tracer_seq_ops = {
4587 static struct trace_iterator *
4588 __tracing_open(struct inode *inode, struct file *file, bool snapshot)
4590 struct trace_array *tr = inode->i_private;
4591 struct trace_iterator *iter;
4594 if (tracing_disabled)
4595 return ERR_PTR(-ENODEV);
4597 iter = __seq_open_private(file, &tracer_seq_ops, sizeof(*iter));
4599 return ERR_PTR(-ENOMEM);
4601 iter->buffer_iter = kcalloc(nr_cpu_ids, sizeof(*iter->buffer_iter),
4603 if (!iter->buffer_iter)
4607 * trace_find_next_entry() may need to save off iter->ent.
4608 * It will place it into the iter->temp buffer. As most
4609 * events are less than 128, allocate a buffer of that size.
4610 * If one is greater, then trace_find_next_entry() will
4611 * allocate a new buffer to adjust for the bigger iter->ent.
4612 * It's not critical if it fails to get allocated here.
4614 iter->temp = kmalloc(128, GFP_KERNEL);
4616 iter->temp_size = 128;
4619 * trace_event_printf() may need to modify given format
4620 * string to replace %p with %px so that it shows real address
4621 * instead of hash value. However, that is only for the event
4622 * tracing, other tracer may not need. Defer the allocation
4623 * until it is needed.
4629 * We make a copy of the current tracer to avoid concurrent
4630 * changes on it while we are reading.
4632 mutex_lock(&trace_types_lock);
4633 iter->trace = kzalloc(sizeof(*iter->trace), GFP_KERNEL);
4637 *iter->trace = *tr->current_trace;
4639 if (!zalloc_cpumask_var(&iter->started, GFP_KERNEL))
4644 #ifdef CONFIG_TRACER_MAX_TRACE
4645 /* Currently only the top directory has a snapshot */
4646 if (tr->current_trace->print_max || snapshot)
4647 iter->array_buffer = &tr->max_buffer;
4650 iter->array_buffer = &tr->array_buffer;
4651 iter->snapshot = snapshot;
4653 iter->cpu_file = tracing_get_cpu(inode);
4654 mutex_init(&iter->mutex);
4656 /* Notify the tracer early; before we stop tracing. */
4657 if (iter->trace->open)
4658 iter->trace->open(iter);
4660 /* Annotate start of buffers if we had overruns */
4661 if (ring_buffer_overruns(iter->array_buffer->buffer))
4662 iter->iter_flags |= TRACE_FILE_ANNOTATE;
4664 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
4665 if (trace_clocks[tr->clock_id].in_ns)
4666 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
4669 * If pause-on-trace is enabled, then stop the trace while
4670 * dumping, unless this is the "snapshot" file
4672 if (!iter->snapshot && (tr->trace_flags & TRACE_ITER_PAUSE_ON_TRACE))
4673 tracing_stop_tr(tr);
4675 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
4676 for_each_tracing_cpu(cpu) {
4677 iter->buffer_iter[cpu] =
4678 ring_buffer_read_prepare(iter->array_buffer->buffer,
4681 ring_buffer_read_prepare_sync();
4682 for_each_tracing_cpu(cpu) {
4683 ring_buffer_read_start(iter->buffer_iter[cpu]);
4684 tracing_iter_reset(iter, cpu);
4687 cpu = iter->cpu_file;
4688 iter->buffer_iter[cpu] =
4689 ring_buffer_read_prepare(iter->array_buffer->buffer,
4691 ring_buffer_read_prepare_sync();
4692 ring_buffer_read_start(iter->buffer_iter[cpu]);
4693 tracing_iter_reset(iter, cpu);
4696 mutex_unlock(&trace_types_lock);
4701 mutex_unlock(&trace_types_lock);
4704 kfree(iter->buffer_iter);
4706 seq_release_private(inode, file);
4707 return ERR_PTR(-ENOMEM);
4710 int tracing_open_generic(struct inode *inode, struct file *filp)
4714 ret = tracing_check_open_get_tr(NULL);
4718 filp->private_data = inode->i_private;
4722 bool tracing_is_disabled(void)
4724 return (tracing_disabled) ? true: false;
4728 * Open and update trace_array ref count.
4729 * Must have the current trace_array passed to it.
4731 int tracing_open_generic_tr(struct inode *inode, struct file *filp)
4733 struct trace_array *tr = inode->i_private;
4736 ret = tracing_check_open_get_tr(tr);
4740 filp->private_data = inode->i_private;
4745 static int tracing_release(struct inode *inode, struct file *file)
4747 struct trace_array *tr = inode->i_private;
4748 struct seq_file *m = file->private_data;
4749 struct trace_iterator *iter;
4752 if (!(file->f_mode & FMODE_READ)) {
4753 trace_array_put(tr);
4757 /* Writes do not use seq_file */
4759 mutex_lock(&trace_types_lock);
4761 for_each_tracing_cpu(cpu) {
4762 if (iter->buffer_iter[cpu])
4763 ring_buffer_read_finish(iter->buffer_iter[cpu]);
4766 if (iter->trace && iter->trace->close)
4767 iter->trace->close(iter);
4769 if (!iter->snapshot && tr->stop_count)
4770 /* reenable tracing if it was previously enabled */
4771 tracing_start_tr(tr);
4773 __trace_array_put(tr);
4775 mutex_unlock(&trace_types_lock);
4777 mutex_destroy(&iter->mutex);
4778 free_cpumask_var(iter->started);
4782 kfree(iter->buffer_iter);
4783 seq_release_private(inode, file);
4788 static int tracing_release_generic_tr(struct inode *inode, struct file *file)
4790 struct trace_array *tr = inode->i_private;
4792 trace_array_put(tr);
4796 static int tracing_single_release_tr(struct inode *inode, struct file *file)
4798 struct trace_array *tr = inode->i_private;
4800 trace_array_put(tr);
4802 return single_release(inode, file);
4805 static int tracing_open(struct inode *inode, struct file *file)
4807 struct trace_array *tr = inode->i_private;
4808 struct trace_iterator *iter;
4811 ret = tracing_check_open_get_tr(tr);
4815 /* If this file was open for write, then erase contents */
4816 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
4817 int cpu = tracing_get_cpu(inode);
4818 struct array_buffer *trace_buf = &tr->array_buffer;
4820 #ifdef CONFIG_TRACER_MAX_TRACE
4821 if (tr->current_trace->print_max)
4822 trace_buf = &tr->max_buffer;
4825 if (cpu == RING_BUFFER_ALL_CPUS)
4826 tracing_reset_online_cpus(trace_buf);
4828 tracing_reset_cpu(trace_buf, cpu);
4831 if (file->f_mode & FMODE_READ) {
4832 iter = __tracing_open(inode, file, false);
4834 ret = PTR_ERR(iter);
4835 else if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
4836 iter->iter_flags |= TRACE_FILE_LAT_FMT;
4840 trace_array_put(tr);
4846 * Some tracers are not suitable for instance buffers.
4847 * A tracer is always available for the global array (toplevel)
4848 * or if it explicitly states that it is.
4851 trace_ok_for_array(struct tracer *t, struct trace_array *tr)
4853 return (tr->flags & TRACE_ARRAY_FL_GLOBAL) || t->allow_instances;
4856 /* Find the next tracer that this trace array may use */
4857 static struct tracer *
4858 get_tracer_for_array(struct trace_array *tr, struct tracer *t)
4860 while (t && !trace_ok_for_array(t, tr))
4867 t_next(struct seq_file *m, void *v, loff_t *pos)
4869 struct trace_array *tr = m->private;
4870 struct tracer *t = v;
4875 t = get_tracer_for_array(tr, t->next);
4880 static void *t_start(struct seq_file *m, loff_t *pos)
4882 struct trace_array *tr = m->private;
4886 mutex_lock(&trace_types_lock);
4888 t = get_tracer_for_array(tr, trace_types);
4889 for (; t && l < *pos; t = t_next(m, t, &l))
4895 static void t_stop(struct seq_file *m, void *p)
4897 mutex_unlock(&trace_types_lock);
4900 static int t_show(struct seq_file *m, void *v)
4902 struct tracer *t = v;
4907 seq_puts(m, t->name);
4916 static const struct seq_operations show_traces_seq_ops = {
4923 static int show_traces_open(struct inode *inode, struct file *file)
4925 struct trace_array *tr = inode->i_private;
4929 ret = tracing_check_open_get_tr(tr);
4933 ret = seq_open(file, &show_traces_seq_ops);
4935 trace_array_put(tr);
4939 m = file->private_data;
4945 static int show_traces_release(struct inode *inode, struct file *file)
4947 struct trace_array *tr = inode->i_private;
4949 trace_array_put(tr);
4950 return seq_release(inode, file);
4954 tracing_write_stub(struct file *filp, const char __user *ubuf,
4955 size_t count, loff_t *ppos)
4960 loff_t tracing_lseek(struct file *file, loff_t offset, int whence)
4964 if (file->f_mode & FMODE_READ)
4965 ret = seq_lseek(file, offset, whence);
4967 file->f_pos = ret = 0;
4972 static const struct file_operations tracing_fops = {
4973 .open = tracing_open,
4975 .write = tracing_write_stub,
4976 .llseek = tracing_lseek,
4977 .release = tracing_release,
4980 static const struct file_operations show_traces_fops = {
4981 .open = show_traces_open,
4983 .llseek = seq_lseek,
4984 .release = show_traces_release,
4988 tracing_cpumask_read(struct file *filp, char __user *ubuf,
4989 size_t count, loff_t *ppos)
4991 struct trace_array *tr = file_inode(filp)->i_private;
4995 len = snprintf(NULL, 0, "%*pb\n",
4996 cpumask_pr_args(tr->tracing_cpumask)) + 1;
4997 mask_str = kmalloc(len, GFP_KERNEL);
5001 len = snprintf(mask_str, len, "%*pb\n",
5002 cpumask_pr_args(tr->tracing_cpumask));
5007 count = simple_read_from_buffer(ubuf, count, ppos, mask_str, len);
5015 int tracing_set_cpumask(struct trace_array *tr,
5016 cpumask_var_t tracing_cpumask_new)
5023 local_irq_disable();
5024 arch_spin_lock(&tr->max_lock);
5025 for_each_tracing_cpu(cpu) {
5027 * Increase/decrease the disabled counter if we are
5028 * about to flip a bit in the cpumask:
5030 if (cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5031 !cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5032 atomic_inc(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5033 ring_buffer_record_disable_cpu(tr->array_buffer.buffer, cpu);
5035 if (!cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
5036 cpumask_test_cpu(cpu, tracing_cpumask_new)) {
5037 atomic_dec(&per_cpu_ptr(tr->array_buffer.data, cpu)->disabled);
5038 ring_buffer_record_enable_cpu(tr->array_buffer.buffer, cpu);
5041 arch_spin_unlock(&tr->max_lock);
5044 cpumask_copy(tr->tracing_cpumask, tracing_cpumask_new);
5050 tracing_cpumask_write(struct file *filp, const char __user *ubuf,
5051 size_t count, loff_t *ppos)
5053 struct trace_array *tr = file_inode(filp)->i_private;
5054 cpumask_var_t tracing_cpumask_new;
5057 if (!zalloc_cpumask_var(&tracing_cpumask_new, GFP_KERNEL))
5060 err = cpumask_parse_user(ubuf, count, tracing_cpumask_new);
5064 err = tracing_set_cpumask(tr, tracing_cpumask_new);
5068 free_cpumask_var(tracing_cpumask_new);
5073 free_cpumask_var(tracing_cpumask_new);
5078 static const struct file_operations tracing_cpumask_fops = {
5079 .open = tracing_open_generic_tr,
5080 .read = tracing_cpumask_read,
5081 .write = tracing_cpumask_write,
5082 .release = tracing_release_generic_tr,
5083 .llseek = generic_file_llseek,
5086 static int tracing_trace_options_show(struct seq_file *m, void *v)
5088 struct tracer_opt *trace_opts;
5089 struct trace_array *tr = m->private;
5093 mutex_lock(&trace_types_lock);
5094 tracer_flags = tr->current_trace->flags->val;
5095 trace_opts = tr->current_trace->flags->opts;
5097 for (i = 0; trace_options[i]; i++) {
5098 if (tr->trace_flags & (1 << i))
5099 seq_printf(m, "%s\n", trace_options[i]);
5101 seq_printf(m, "no%s\n", trace_options[i]);
5104 for (i = 0; trace_opts[i].name; i++) {
5105 if (tracer_flags & trace_opts[i].bit)
5106 seq_printf(m, "%s\n", trace_opts[i].name);
5108 seq_printf(m, "no%s\n", trace_opts[i].name);
5110 mutex_unlock(&trace_types_lock);
5115 static int __set_tracer_option(struct trace_array *tr,
5116 struct tracer_flags *tracer_flags,
5117 struct tracer_opt *opts, int neg)
5119 struct tracer *trace = tracer_flags->trace;
5122 ret = trace->set_flag(tr, tracer_flags->val, opts->bit, !neg);
5127 tracer_flags->val &= ~opts->bit;
5129 tracer_flags->val |= opts->bit;
5133 /* Try to assign a tracer specific option */
5134 static int set_tracer_option(struct trace_array *tr, char *cmp, int neg)
5136 struct tracer *trace = tr->current_trace;
5137 struct tracer_flags *tracer_flags = trace->flags;
5138 struct tracer_opt *opts = NULL;
5141 for (i = 0; tracer_flags->opts[i].name; i++) {
5142 opts = &tracer_flags->opts[i];
5144 if (strcmp(cmp, opts->name) == 0)
5145 return __set_tracer_option(tr, trace->flags, opts, neg);
5151 /* Some tracers require overwrite to stay enabled */
5152 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set)
5154 if (tracer->enabled && (mask & TRACE_ITER_OVERWRITE) && !set)
5160 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled)
5162 if ((mask == TRACE_ITER_RECORD_TGID) ||
5163 (mask == TRACE_ITER_RECORD_CMD))
5164 lockdep_assert_held(&event_mutex);
5166 /* do nothing if flag is already set */
5167 if (!!(tr->trace_flags & mask) == !!enabled)
5170 /* Give the tracer a chance to approve the change */
5171 if (tr->current_trace->flag_changed)
5172 if (tr->current_trace->flag_changed(tr, mask, !!enabled))
5176 tr->trace_flags |= mask;
5178 tr->trace_flags &= ~mask;
5180 if (mask == TRACE_ITER_RECORD_CMD)
5181 trace_event_enable_cmd_record(enabled);
5183 if (mask == TRACE_ITER_RECORD_TGID) {
5185 tgid_map = kvcalloc(PID_MAX_DEFAULT + 1,
5189 tr->trace_flags &= ~TRACE_ITER_RECORD_TGID;
5193 trace_event_enable_tgid_record(enabled);
5196 if (mask == TRACE_ITER_EVENT_FORK)
5197 trace_event_follow_fork(tr, enabled);
5199 if (mask == TRACE_ITER_FUNC_FORK)
5200 ftrace_pid_follow_fork(tr, enabled);
5202 if (mask == TRACE_ITER_OVERWRITE) {
5203 ring_buffer_change_overwrite(tr->array_buffer.buffer, enabled);
5204 #ifdef CONFIG_TRACER_MAX_TRACE
5205 ring_buffer_change_overwrite(tr->max_buffer.buffer, enabled);
5209 if (mask == TRACE_ITER_PRINTK) {
5210 trace_printk_start_stop_comm(enabled);
5211 trace_printk_control(enabled);
5217 int trace_set_options(struct trace_array *tr, char *option)
5222 size_t orig_len = strlen(option);
5225 cmp = strstrip(option);
5227 len = str_has_prefix(cmp, "no");
5233 mutex_lock(&event_mutex);
5234 mutex_lock(&trace_types_lock);
5236 ret = match_string(trace_options, -1, cmp);
5237 /* If no option could be set, test the specific tracer options */
5239 ret = set_tracer_option(tr, cmp, neg);
5241 ret = set_tracer_flag(tr, 1 << ret, !neg);
5243 mutex_unlock(&trace_types_lock);
5244 mutex_unlock(&event_mutex);
5247 * If the first trailing whitespace is replaced with '\0' by strstrip,
5248 * turn it back into a space.
5250 if (orig_len > strlen(option))
5251 option[strlen(option)] = ' ';
5256 static void __init apply_trace_boot_options(void)
5258 char *buf = trace_boot_options_buf;
5262 option = strsep(&buf, ",");
5268 trace_set_options(&global_trace, option);
5270 /* Put back the comma to allow this to be called again */
5277 tracing_trace_options_write(struct file *filp, const char __user *ubuf,
5278 size_t cnt, loff_t *ppos)
5280 struct seq_file *m = filp->private_data;
5281 struct trace_array *tr = m->private;
5285 if (cnt >= sizeof(buf))
5288 if (copy_from_user(buf, ubuf, cnt))
5293 ret = trace_set_options(tr, buf);
5302 static int tracing_trace_options_open(struct inode *inode, struct file *file)
5304 struct trace_array *tr = inode->i_private;
5307 ret = tracing_check_open_get_tr(tr);
5311 ret = single_open(file, tracing_trace_options_show, inode->i_private);
5313 trace_array_put(tr);
5318 static const struct file_operations tracing_iter_fops = {
5319 .open = tracing_trace_options_open,
5321 .llseek = seq_lseek,
5322 .release = tracing_single_release_tr,
5323 .write = tracing_trace_options_write,
5326 static const char readme_msg[] =
5327 "tracing mini-HOWTO:\n\n"
5328 "# echo 0 > tracing_on : quick way to disable tracing\n"
5329 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
5330 " Important files:\n"
5331 " trace\t\t\t- The static contents of the buffer\n"
5332 "\t\t\t To clear the buffer write into this file: echo > trace\n"
5333 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
5334 " current_tracer\t- function and latency tracers\n"
5335 " available_tracers\t- list of configured tracers for current_tracer\n"
5336 " error_log\t- error log for failed commands (that support it)\n"
5337 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
5338 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
5339 " trace_clock\t\t-change the clock used to order events\n"
5340 " local: Per cpu clock but may not be synced across CPUs\n"
5341 " global: Synced across CPUs but slows tracing down.\n"
5342 " counter: Not a clock, but just an increment\n"
5343 " uptime: Jiffy counter from time of boot\n"
5344 " perf: Same clock that perf events use\n"
5345 #ifdef CONFIG_X86_64
5346 " x86-tsc: TSC cycle counter\n"
5348 "\n timestamp_mode\t-view the mode used to timestamp events\n"
5349 " delta: Delta difference against a buffer-wide timestamp\n"
5350 " absolute: Absolute (standalone) timestamp\n"
5351 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
5352 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
5353 " tracing_cpumask\t- Limit which CPUs to trace\n"
5354 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
5355 "\t\t\t Remove sub-buffer with rmdir\n"
5356 " trace_options\t\t- Set format or modify how tracing happens\n"
5357 "\t\t\t Disable an option by prefixing 'no' to the\n"
5358 "\t\t\t option name\n"
5359 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
5360 #ifdef CONFIG_DYNAMIC_FTRACE
5361 "\n available_filter_functions - list of functions that can be filtered on\n"
5362 " set_ftrace_filter\t- echo function name in here to only trace these\n"
5363 "\t\t\t functions\n"
5364 "\t accepts: func_full_name or glob-matching-pattern\n"
5365 "\t modules: Can select a group via module\n"
5366 "\t Format: :mod:<module-name>\n"
5367 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
5368 "\t triggers: a command to perform when function is hit\n"
5369 "\t Format: <function>:<trigger>[:count]\n"
5370 "\t trigger: traceon, traceoff\n"
5371 "\t\t enable_event:<system>:<event>\n"
5372 "\t\t disable_event:<system>:<event>\n"
5373 #ifdef CONFIG_STACKTRACE
5376 #ifdef CONFIG_TRACER_SNAPSHOT
5381 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
5382 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
5383 "\t The first one will disable tracing every time do_fault is hit\n"
5384 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
5385 "\t The first time do trap is hit and it disables tracing, the\n"
5386 "\t counter will decrement to 2. If tracing is already disabled,\n"
5387 "\t the counter will not decrement. It only decrements when the\n"
5388 "\t trigger did work\n"
5389 "\t To remove trigger without count:\n"
5390 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
5391 "\t To remove trigger with a count:\n"
5392 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
5393 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
5394 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
5395 "\t modules: Can select a group via module command :mod:\n"
5396 "\t Does not accept triggers\n"
5397 #endif /* CONFIG_DYNAMIC_FTRACE */
5398 #ifdef CONFIG_FUNCTION_TRACER
5399 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
5401 " set_ftrace_notrace_pid\t- Write pid(s) to not function trace those pids\n"
5404 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
5405 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
5406 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
5407 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
5409 #ifdef CONFIG_TRACER_SNAPSHOT
5410 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
5411 "\t\t\t snapshot buffer. Read the contents for more\n"
5412 "\t\t\t information\n"
5414 #ifdef CONFIG_STACK_TRACER
5415 " stack_trace\t\t- Shows the max stack trace when active\n"
5416 " stack_max_size\t- Shows current max stack size that was traced\n"
5417 "\t\t\t Write into this file to reset the max size (trigger a\n"
5418 "\t\t\t new trace)\n"
5419 #ifdef CONFIG_DYNAMIC_FTRACE
5420 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
5423 #endif /* CONFIG_STACK_TRACER */
5424 #ifdef CONFIG_DYNAMIC_EVENTS
5425 " dynamic_events\t\t- Create/append/remove/show the generic dynamic events\n"
5426 "\t\t\t Write into this file to define/undefine new trace events.\n"
5428 #ifdef CONFIG_KPROBE_EVENTS
5429 " kprobe_events\t\t- Create/append/remove/show the kernel dynamic events\n"
5430 "\t\t\t Write into this file to define/undefine new trace events.\n"
5432 #ifdef CONFIG_UPROBE_EVENTS
5433 " uprobe_events\t\t- Create/append/remove/show the userspace dynamic events\n"
5434 "\t\t\t Write into this file to define/undefine new trace events.\n"
5436 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
5437 "\t accepts: event-definitions (one definition per line)\n"
5438 "\t Format: p[:[<group>/]<event>] <place> [<args>]\n"
5439 "\t r[maxactive][:[<group>/]<event>] <place> [<args>]\n"
5440 #ifdef CONFIG_HIST_TRIGGERS
5441 "\t s:[synthetic/]<event> <field> [<field>]\n"
5443 "\t -:[<group>/]<event>\n"
5444 #ifdef CONFIG_KPROBE_EVENTS
5445 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
5446 "place (kretprobe): [<module>:]<symbol>[+<offset>]%return|<memaddr>\n"
5448 #ifdef CONFIG_UPROBE_EVENTS
5449 " place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"
5451 "\t args: <name>=fetcharg[:type]\n"
5452 "\t fetcharg: %<register>, @<address>, @<symbol>[+|-<offset>],\n"
5453 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
5454 "\t $stack<index>, $stack, $retval, $comm, $arg<N>,\n"
5456 "\t $stack<index>, $stack, $retval, $comm,\n"
5458 "\t +|-[u]<offset>(<fetcharg>), \\imm-value, \\\"imm-string\"\n"
5459 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, string, symbol,\n"
5460 "\t b<bit-width>@<bit-offset>/<container-size>, ustring,\n"
5461 "\t <type>\\[<array-size>\\]\n"
5462 #ifdef CONFIG_HIST_TRIGGERS
5463 "\t field: <stype> <name>;\n"
5464 "\t stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"
5465 "\t [unsigned] char/int/long\n"
5468 " events/\t\t- Directory containing all trace event subsystems:\n"
5469 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
5470 " events/<system>/\t- Directory containing all trace events for <system>:\n"
5471 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
5473 " filter\t\t- If set, only events passing filter are traced\n"
5474 " events/<system>/<event>/\t- Directory containing control files for\n"
5476 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
5477 " filter\t\t- If set, only events passing filter are traced\n"
5478 " trigger\t\t- If set, a command to perform when event is hit\n"
5479 "\t Format: <trigger>[:count][if <filter>]\n"
5480 "\t trigger: traceon, traceoff\n"
5481 "\t enable_event:<system>:<event>\n"
5482 "\t disable_event:<system>:<event>\n"
5483 #ifdef CONFIG_HIST_TRIGGERS
5484 "\t enable_hist:<system>:<event>\n"
5485 "\t disable_hist:<system>:<event>\n"
5487 #ifdef CONFIG_STACKTRACE
5490 #ifdef CONFIG_TRACER_SNAPSHOT
5493 #ifdef CONFIG_HIST_TRIGGERS
5494 "\t\t hist (see below)\n"
5496 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
5497 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
5498 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
5499 "\t events/block/block_unplug/trigger\n"
5500 "\t The first disables tracing every time block_unplug is hit.\n"
5501 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
5502 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
5503 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
5504 "\t Like function triggers, the counter is only decremented if it\n"
5505 "\t enabled or disabled tracing.\n"
5506 "\t To remove a trigger without a count:\n"
5507 "\t echo '!<trigger> > <system>/<event>/trigger\n"
5508 "\t To remove a trigger with a count:\n"
5509 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
5510 "\t Filters can be ignored when removing a trigger.\n"
5511 #ifdef CONFIG_HIST_TRIGGERS
5512 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
5513 "\t Format: hist:keys=<field1[,field2,...]>\n"
5514 "\t [:values=<field1[,field2,...]>]\n"
5515 "\t [:sort=<field1[,field2,...]>]\n"
5516 "\t [:size=#entries]\n"
5517 "\t [:pause][:continue][:clear]\n"
5518 "\t [:name=histname1]\n"
5519 "\t [:<handler>.<action>]\n"
5520 "\t [if <filter>]\n\n"
5521 "\t When a matching event is hit, an entry is added to a hash\n"
5522 "\t table using the key(s) and value(s) named, and the value of a\n"
5523 "\t sum called 'hitcount' is incremented. Keys and values\n"
5524 "\t correspond to fields in the event's format description. Keys\n"
5525 "\t can be any field, or the special string 'stacktrace'.\n"
5526 "\t Compound keys consisting of up to two fields can be specified\n"
5527 "\t by the 'keys' keyword. Values must correspond to numeric\n"
5528 "\t fields. Sort keys consisting of up to two fields can be\n"
5529 "\t specified using the 'sort' keyword. The sort direction can\n"
5530 "\t be modified by appending '.descending' or '.ascending' to a\n"
5531 "\t sort field. The 'size' parameter can be used to specify more\n"
5532 "\t or fewer than the default 2048 entries for the hashtable size.\n"
5533 "\t If a hist trigger is given a name using the 'name' parameter,\n"
5534 "\t its histogram data will be shared with other triggers of the\n"
5535 "\t same name, and trigger hits will update this common data.\n\n"
5536 "\t Reading the 'hist' file for the event will dump the hash\n"
5537 "\t table in its entirety to stdout. If there are multiple hist\n"
5538 "\t triggers attached to an event, there will be a table for each\n"
5539 "\t trigger in the output. The table displayed for a named\n"
5540 "\t trigger will be the same as any other instance having the\n"
5541 "\t same name. The default format used to display a given field\n"
5542 "\t can be modified by appending any of the following modifiers\n"
5543 "\t to the field name, as applicable:\n\n"
5544 "\t .hex display a number as a hex value\n"
5545 "\t .sym display an address as a symbol\n"
5546 "\t .sym-offset display an address as a symbol and offset\n"
5547 "\t .execname display a common_pid as a program name\n"
5548 "\t .syscall display a syscall id as a syscall name\n"
5549 "\t .log2 display log2 value rather than raw number\n"
5550 "\t .usecs display a common_timestamp in microseconds\n\n"
5551 "\t The 'pause' parameter can be used to pause an existing hist\n"
5552 "\t trigger or to start a hist trigger but not log any events\n"
5553 "\t until told to do so. 'continue' can be used to start or\n"
5554 "\t restart a paused hist trigger.\n\n"
5555 "\t The 'clear' parameter will clear the contents of a running\n"
5556 "\t hist trigger and leave its current paused/active state\n"
5558 "\t The enable_hist and disable_hist triggers can be used to\n"
5559 "\t have one event conditionally start and stop another event's\n"
5560 "\t already-attached hist trigger. The syntax is analogous to\n"
5561 "\t the enable_event and disable_event triggers.\n\n"
5562 "\t Hist trigger handlers and actions are executed whenever a\n"
5563 "\t a histogram entry is added or updated. They take the form:\n\n"
5564 "\t <handler>.<action>\n\n"
5565 "\t The available handlers are:\n\n"
5566 "\t onmatch(matching.event) - invoke on addition or update\n"
5567 "\t onmax(var) - invoke if var exceeds current max\n"
5568 "\t onchange(var) - invoke action if var changes\n\n"
5569 "\t The available actions are:\n\n"
5570 "\t trace(<synthetic_event>,param list) - generate synthetic event\n"
5571 "\t save(field,...) - save current event fields\n"
5572 #ifdef CONFIG_TRACER_SNAPSHOT
5573 "\t snapshot() - snapshot the trace buffer\n\n"
5575 #ifdef CONFIG_SYNTH_EVENTS
5576 " events/synthetic_events\t- Create/append/remove/show synthetic events\n"
5577 "\t Write into this file to define/undefine new synthetic events.\n"
5578 "\t example: echo 'myevent u64 lat; char name[]' >> synthetic_events\n"
5584 tracing_readme_read(struct file *filp, char __user *ubuf,
5585 size_t cnt, loff_t *ppos)
5587 return simple_read_from_buffer(ubuf, cnt, ppos,
5588 readme_msg, strlen(readme_msg));
5591 static const struct file_operations tracing_readme_fops = {
5592 .open = tracing_open_generic,
5593 .read = tracing_readme_read,
5594 .llseek = generic_file_llseek,
5597 static void *saved_tgids_next(struct seq_file *m, void *v, loff_t *pos)
5601 if (*pos || m->count)
5606 for (; ptr <= &tgid_map[PID_MAX_DEFAULT]; ptr++) {
5607 if (trace_find_tgid(*ptr))
5614 static void *saved_tgids_start(struct seq_file *m, loff_t *pos)
5624 v = saved_tgids_next(m, v, &l);
5632 static void saved_tgids_stop(struct seq_file *m, void *v)
5636 static int saved_tgids_show(struct seq_file *m, void *v)
5638 int pid = (int *)v - tgid_map;
5640 seq_printf(m, "%d %d\n", pid, trace_find_tgid(pid));
5644 static const struct seq_operations tracing_saved_tgids_seq_ops = {
5645 .start = saved_tgids_start,
5646 .stop = saved_tgids_stop,
5647 .next = saved_tgids_next,
5648 .show = saved_tgids_show,
5651 static int tracing_saved_tgids_open(struct inode *inode, struct file *filp)
5655 ret = tracing_check_open_get_tr(NULL);
5659 return seq_open(filp, &tracing_saved_tgids_seq_ops);
5663 static const struct file_operations tracing_saved_tgids_fops = {
5664 .open = tracing_saved_tgids_open,
5666 .llseek = seq_lseek,
5667 .release = seq_release,
5670 static void *saved_cmdlines_next(struct seq_file *m, void *v, loff_t *pos)
5672 unsigned int *ptr = v;
5674 if (*pos || m->count)
5679 for (; ptr < &savedcmd->map_cmdline_to_pid[savedcmd->cmdline_num];
5681 if (*ptr == -1 || *ptr == NO_CMDLINE_MAP)
5690 static void *saved_cmdlines_start(struct seq_file *m, loff_t *pos)
5696 arch_spin_lock(&trace_cmdline_lock);
5698 v = &savedcmd->map_cmdline_to_pid[0];
5700 v = saved_cmdlines_next(m, v, &l);
5708 static void saved_cmdlines_stop(struct seq_file *m, void *v)
5710 arch_spin_unlock(&trace_cmdline_lock);
5714 static int saved_cmdlines_show(struct seq_file *m, void *v)
5716 char buf[TASK_COMM_LEN];
5717 unsigned int *pid = v;
5719 __trace_find_cmdline(*pid, buf);
5720 seq_printf(m, "%d %s\n", *pid, buf);
5724 static const struct seq_operations tracing_saved_cmdlines_seq_ops = {
5725 .start = saved_cmdlines_start,
5726 .next = saved_cmdlines_next,
5727 .stop = saved_cmdlines_stop,
5728 .show = saved_cmdlines_show,
5731 static int tracing_saved_cmdlines_open(struct inode *inode, struct file *filp)
5735 ret = tracing_check_open_get_tr(NULL);
5739 return seq_open(filp, &tracing_saved_cmdlines_seq_ops);
5742 static const struct file_operations tracing_saved_cmdlines_fops = {
5743 .open = tracing_saved_cmdlines_open,
5745 .llseek = seq_lseek,
5746 .release = seq_release,
5750 tracing_saved_cmdlines_size_read(struct file *filp, char __user *ubuf,
5751 size_t cnt, loff_t *ppos)
5756 arch_spin_lock(&trace_cmdline_lock);
5757 r = scnprintf(buf, sizeof(buf), "%u\n", savedcmd->cmdline_num);
5758 arch_spin_unlock(&trace_cmdline_lock);
5760 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
5763 static void free_saved_cmdlines_buffer(struct saved_cmdlines_buffer *s)
5765 kfree(s->saved_cmdlines);
5766 kfree(s->map_cmdline_to_pid);
5770 static int tracing_resize_saved_cmdlines(unsigned int val)
5772 struct saved_cmdlines_buffer *s, *savedcmd_temp;
5774 s = kmalloc(sizeof(*s), GFP_KERNEL);
5778 if (allocate_cmdlines_buffer(val, s) < 0) {
5783 arch_spin_lock(&trace_cmdline_lock);
5784 savedcmd_temp = savedcmd;
5786 arch_spin_unlock(&trace_cmdline_lock);
5787 free_saved_cmdlines_buffer(savedcmd_temp);
5793 tracing_saved_cmdlines_size_write(struct file *filp, const char __user *ubuf,
5794 size_t cnt, loff_t *ppos)
5799 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
5803 /* must have at least 1 entry or less than PID_MAX_DEFAULT */
5804 if (!val || val > PID_MAX_DEFAULT)
5807 ret = tracing_resize_saved_cmdlines((unsigned int)val);
5816 static const struct file_operations tracing_saved_cmdlines_size_fops = {
5817 .open = tracing_open_generic,
5818 .read = tracing_saved_cmdlines_size_read,
5819 .write = tracing_saved_cmdlines_size_write,
5822 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
5823 static union trace_eval_map_item *
5824 update_eval_map(union trace_eval_map_item *ptr)
5826 if (!ptr->map.eval_string) {
5827 if (ptr->tail.next) {
5828 ptr = ptr->tail.next;
5829 /* Set ptr to the next real item (skip head) */
5837 static void *eval_map_next(struct seq_file *m, void *v, loff_t *pos)
5839 union trace_eval_map_item *ptr = v;
5842 * Paranoid! If ptr points to end, we don't want to increment past it.
5843 * This really should never happen.
5846 ptr = update_eval_map(ptr);
5847 if (WARN_ON_ONCE(!ptr))
5851 ptr = update_eval_map(ptr);
5856 static void *eval_map_start(struct seq_file *m, loff_t *pos)
5858 union trace_eval_map_item *v;
5861 mutex_lock(&trace_eval_mutex);
5863 v = trace_eval_maps;
5867 while (v && l < *pos) {
5868 v = eval_map_next(m, v, &l);
5874 static void eval_map_stop(struct seq_file *m, void *v)
5876 mutex_unlock(&trace_eval_mutex);
5879 static int eval_map_show(struct seq_file *m, void *v)
5881 union trace_eval_map_item *ptr = v;
5883 seq_printf(m, "%s %ld (%s)\n",
5884 ptr->map.eval_string, ptr->map.eval_value,
5890 static const struct seq_operations tracing_eval_map_seq_ops = {
5891 .start = eval_map_start,
5892 .next = eval_map_next,
5893 .stop = eval_map_stop,
5894 .show = eval_map_show,
5897 static int tracing_eval_map_open(struct inode *inode, struct file *filp)
5901 ret = tracing_check_open_get_tr(NULL);
5905 return seq_open(filp, &tracing_eval_map_seq_ops);
5908 static const struct file_operations tracing_eval_map_fops = {
5909 .open = tracing_eval_map_open,
5911 .llseek = seq_lseek,
5912 .release = seq_release,
5915 static inline union trace_eval_map_item *
5916 trace_eval_jmp_to_tail(union trace_eval_map_item *ptr)
5918 /* Return tail of array given the head */
5919 return ptr + ptr->head.length + 1;
5923 trace_insert_eval_map_file(struct module *mod, struct trace_eval_map **start,
5926 struct trace_eval_map **stop;
5927 struct trace_eval_map **map;
5928 union trace_eval_map_item *map_array;
5929 union trace_eval_map_item *ptr;
5934 * The trace_eval_maps contains the map plus a head and tail item,
5935 * where the head holds the module and length of array, and the
5936 * tail holds a pointer to the next list.
5938 map_array = kmalloc_array(len + 2, sizeof(*map_array), GFP_KERNEL);
5940 pr_warn("Unable to allocate trace eval mapping\n");
5944 mutex_lock(&trace_eval_mutex);
5946 if (!trace_eval_maps)
5947 trace_eval_maps = map_array;
5949 ptr = trace_eval_maps;
5951 ptr = trace_eval_jmp_to_tail(ptr);
5952 if (!ptr->tail.next)
5954 ptr = ptr->tail.next;
5957 ptr->tail.next = map_array;
5959 map_array->head.mod = mod;
5960 map_array->head.length = len;
5963 for (map = start; (unsigned long)map < (unsigned long)stop; map++) {
5964 map_array->map = **map;
5967 memset(map_array, 0, sizeof(*map_array));
5969 mutex_unlock(&trace_eval_mutex);
5972 static void trace_create_eval_file(struct dentry *d_tracer)
5974 trace_create_file("eval_map", 0444, d_tracer,
5975 NULL, &tracing_eval_map_fops);
5978 #else /* CONFIG_TRACE_EVAL_MAP_FILE */
5979 static inline void trace_create_eval_file(struct dentry *d_tracer) { }
5980 static inline void trace_insert_eval_map_file(struct module *mod,
5981 struct trace_eval_map **start, int len) { }
5982 #endif /* !CONFIG_TRACE_EVAL_MAP_FILE */
5984 static void trace_insert_eval_map(struct module *mod,
5985 struct trace_eval_map **start, int len)
5987 struct trace_eval_map **map;
5994 trace_event_eval_update(map, len);
5996 trace_insert_eval_map_file(mod, start, len);
6000 tracing_set_trace_read(struct file *filp, char __user *ubuf,
6001 size_t cnt, loff_t *ppos)
6003 struct trace_array *tr = filp->private_data;
6004 char buf[MAX_TRACER_SIZE+2];
6007 mutex_lock(&trace_types_lock);
6008 r = sprintf(buf, "%s\n", tr->current_trace->name);
6009 mutex_unlock(&trace_types_lock);
6011 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6014 int tracer_init(struct tracer *t, struct trace_array *tr)
6016 tracing_reset_online_cpus(&tr->array_buffer);
6020 static void set_buffer_entries(struct array_buffer *buf, unsigned long val)
6024 for_each_tracing_cpu(cpu)
6025 per_cpu_ptr(buf->data, cpu)->entries = val;
6028 #ifdef CONFIG_TRACER_MAX_TRACE
6029 /* resize @tr's buffer to the size of @size_tr's entries */
6030 static int resize_buffer_duplicate_size(struct array_buffer *trace_buf,
6031 struct array_buffer *size_buf, int cpu_id)
6035 if (cpu_id == RING_BUFFER_ALL_CPUS) {
6036 for_each_tracing_cpu(cpu) {
6037 ret = ring_buffer_resize(trace_buf->buffer,
6038 per_cpu_ptr(size_buf->data, cpu)->entries, cpu);
6041 per_cpu_ptr(trace_buf->data, cpu)->entries =
6042 per_cpu_ptr(size_buf->data, cpu)->entries;
6045 ret = ring_buffer_resize(trace_buf->buffer,
6046 per_cpu_ptr(size_buf->data, cpu_id)->entries, cpu_id);
6048 per_cpu_ptr(trace_buf->data, cpu_id)->entries =
6049 per_cpu_ptr(size_buf->data, cpu_id)->entries;
6054 #endif /* CONFIG_TRACER_MAX_TRACE */
6056 static int __tracing_resize_ring_buffer(struct trace_array *tr,
6057 unsigned long size, int cpu)
6062 * If kernel or user changes the size of the ring buffer
6063 * we use the size that was given, and we can forget about
6064 * expanding it later.
6066 ring_buffer_expanded = true;
6068 /* May be called before buffers are initialized */
6069 if (!tr->array_buffer.buffer)
6072 ret = ring_buffer_resize(tr->array_buffer.buffer, size, cpu);
6076 #ifdef CONFIG_TRACER_MAX_TRACE
6077 if (!(tr->flags & TRACE_ARRAY_FL_GLOBAL) ||
6078 !tr->current_trace->use_max_tr)
6081 ret = ring_buffer_resize(tr->max_buffer.buffer, size, cpu);
6083 int r = resize_buffer_duplicate_size(&tr->array_buffer,
6084 &tr->array_buffer, cpu);
6087 * AARGH! We are left with different
6088 * size max buffer!!!!
6089 * The max buffer is our "snapshot" buffer.
6090 * When a tracer needs a snapshot (one of the
6091 * latency tracers), it swaps the max buffer
6092 * with the saved snap shot. We succeeded to
6093 * update the size of the main buffer, but failed to
6094 * update the size of the max buffer. But when we tried
6095 * to reset the main buffer to the original size, we
6096 * failed there too. This is very unlikely to
6097 * happen, but if it does, warn and kill all
6101 tracing_disabled = 1;
6106 if (cpu == RING_BUFFER_ALL_CPUS)
6107 set_buffer_entries(&tr->max_buffer, size);
6109 per_cpu_ptr(tr->max_buffer.data, cpu)->entries = size;
6112 #endif /* CONFIG_TRACER_MAX_TRACE */
6114 if (cpu == RING_BUFFER_ALL_CPUS)
6115 set_buffer_entries(&tr->array_buffer, size);
6117 per_cpu_ptr(tr->array_buffer.data, cpu)->entries = size;
6122 ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
6123 unsigned long size, int cpu_id)
6127 mutex_lock(&trace_types_lock);
6129 if (cpu_id != RING_BUFFER_ALL_CPUS) {
6130 /* make sure, this cpu is enabled in the mask */
6131 if (!cpumask_test_cpu(cpu_id, tracing_buffer_mask)) {
6137 ret = __tracing_resize_ring_buffer(tr, size, cpu_id);
6142 mutex_unlock(&trace_types_lock);
6149 * tracing_update_buffers - used by tracing facility to expand ring buffers
6151 * To save on memory when the tracing is never used on a system with it
6152 * configured in. The ring buffers are set to a minimum size. But once
6153 * a user starts to use the tracing facility, then they need to grow
6154 * to their default size.
6156 * This function is to be called when a tracer is about to be used.
6158 int tracing_update_buffers(void)
6162 mutex_lock(&trace_types_lock);
6163 if (!ring_buffer_expanded)
6164 ret = __tracing_resize_ring_buffer(&global_trace, trace_buf_size,
6165 RING_BUFFER_ALL_CPUS);
6166 mutex_unlock(&trace_types_lock);
6171 struct trace_option_dentry;
6174 create_trace_option_files(struct trace_array *tr, struct tracer *tracer);
6177 * Used to clear out the tracer before deletion of an instance.
6178 * Must have trace_types_lock held.
6180 static void tracing_set_nop(struct trace_array *tr)
6182 if (tr->current_trace == &nop_trace)
6185 tr->current_trace->enabled--;
6187 if (tr->current_trace->reset)
6188 tr->current_trace->reset(tr);
6190 tr->current_trace = &nop_trace;
6193 static void add_tracer_options(struct trace_array *tr, struct tracer *t)
6195 /* Only enable if the directory has been created already. */
6199 create_trace_option_files(tr, t);
6202 int tracing_set_tracer(struct trace_array *tr, const char *buf)
6205 #ifdef CONFIG_TRACER_MAX_TRACE
6210 mutex_lock(&trace_types_lock);
6212 if (!ring_buffer_expanded) {
6213 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
6214 RING_BUFFER_ALL_CPUS);
6220 for (t = trace_types; t; t = t->next) {
6221 if (strcmp(t->name, buf) == 0)
6228 if (t == tr->current_trace)
6231 #ifdef CONFIG_TRACER_SNAPSHOT
6232 if (t->use_max_tr) {
6233 arch_spin_lock(&tr->max_lock);
6234 if (tr->cond_snapshot)
6236 arch_spin_unlock(&tr->max_lock);
6241 /* Some tracers won't work on kernel command line */
6242 if (system_state < SYSTEM_RUNNING && t->noboot) {
6243 pr_warn("Tracer '%s' is not allowed on command line, ignored\n",
6248 /* Some tracers are only allowed for the top level buffer */
6249 if (!trace_ok_for_array(t, tr)) {
6254 /* If trace pipe files are being read, we can't change the tracer */
6255 if (tr->trace_ref) {
6260 trace_branch_disable();
6262 tr->current_trace->enabled--;
6264 if (tr->current_trace->reset)
6265 tr->current_trace->reset(tr);
6267 /* Current trace needs to be nop_trace before synchronize_rcu */
6268 tr->current_trace = &nop_trace;
6270 #ifdef CONFIG_TRACER_MAX_TRACE
6271 had_max_tr = tr->allocated_snapshot;
6273 if (had_max_tr && !t->use_max_tr) {
6275 * We need to make sure that the update_max_tr sees that
6276 * current_trace changed to nop_trace to keep it from
6277 * swapping the buffers after we resize it.
6278 * The update_max_tr is called from interrupts disabled
6279 * so a synchronized_sched() is sufficient.
6286 #ifdef CONFIG_TRACER_MAX_TRACE
6287 if (t->use_max_tr && !had_max_tr) {
6288 ret = tracing_alloc_snapshot_instance(tr);
6295 ret = tracer_init(t, tr);
6300 tr->current_trace = t;
6301 tr->current_trace->enabled++;
6302 trace_branch_enable(tr);
6304 mutex_unlock(&trace_types_lock);
6310 tracing_set_trace_write(struct file *filp, const char __user *ubuf,
6311 size_t cnt, loff_t *ppos)
6313 struct trace_array *tr = filp->private_data;
6314 char buf[MAX_TRACER_SIZE+1];
6321 if (cnt > MAX_TRACER_SIZE)
6322 cnt = MAX_TRACER_SIZE;
6324 if (copy_from_user(buf, ubuf, cnt))
6329 /* strip ending whitespace. */
6330 for (i = cnt - 1; i > 0 && isspace(buf[i]); i--)
6333 err = tracing_set_tracer(tr, buf);
6343 tracing_nsecs_read(unsigned long *ptr, char __user *ubuf,
6344 size_t cnt, loff_t *ppos)
6349 r = snprintf(buf, sizeof(buf), "%ld\n",
6350 *ptr == (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr));
6351 if (r > sizeof(buf))
6353 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6357 tracing_nsecs_write(unsigned long *ptr, const char __user *ubuf,
6358 size_t cnt, loff_t *ppos)
6363 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6373 tracing_thresh_read(struct file *filp, char __user *ubuf,
6374 size_t cnt, loff_t *ppos)
6376 return tracing_nsecs_read(&tracing_thresh, ubuf, cnt, ppos);
6380 tracing_thresh_write(struct file *filp, const char __user *ubuf,
6381 size_t cnt, loff_t *ppos)
6383 struct trace_array *tr = filp->private_data;
6386 mutex_lock(&trace_types_lock);
6387 ret = tracing_nsecs_write(&tracing_thresh, ubuf, cnt, ppos);
6391 if (tr->current_trace->update_thresh) {
6392 ret = tr->current_trace->update_thresh(tr);
6399 mutex_unlock(&trace_types_lock);
6404 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
6407 tracing_max_lat_read(struct file *filp, char __user *ubuf,
6408 size_t cnt, loff_t *ppos)
6410 return tracing_nsecs_read(filp->private_data, ubuf, cnt, ppos);
6414 tracing_max_lat_write(struct file *filp, const char __user *ubuf,
6415 size_t cnt, loff_t *ppos)
6417 return tracing_nsecs_write(filp->private_data, ubuf, cnt, ppos);
6422 static int tracing_open_pipe(struct inode *inode, struct file *filp)
6424 struct trace_array *tr = inode->i_private;
6425 struct trace_iterator *iter;
6428 ret = tracing_check_open_get_tr(tr);
6432 mutex_lock(&trace_types_lock);
6434 /* create a buffer to store the information to pass to userspace */
6435 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
6438 __trace_array_put(tr);
6442 trace_seq_init(&iter->seq);
6443 iter->trace = tr->current_trace;
6445 if (!alloc_cpumask_var(&iter->started, GFP_KERNEL)) {
6450 /* trace pipe does not show start of buffer */
6451 cpumask_setall(iter->started);
6453 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
6454 iter->iter_flags |= TRACE_FILE_LAT_FMT;
6456 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
6457 if (trace_clocks[tr->clock_id].in_ns)
6458 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
6461 iter->array_buffer = &tr->array_buffer;
6462 iter->cpu_file = tracing_get_cpu(inode);
6463 mutex_init(&iter->mutex);
6464 filp->private_data = iter;
6466 if (iter->trace->pipe_open)
6467 iter->trace->pipe_open(iter);
6469 nonseekable_open(inode, filp);
6473 mutex_unlock(&trace_types_lock);
6478 __trace_array_put(tr);
6479 mutex_unlock(&trace_types_lock);
6483 static int tracing_release_pipe(struct inode *inode, struct file *file)
6485 struct trace_iterator *iter = file->private_data;
6486 struct trace_array *tr = inode->i_private;
6488 mutex_lock(&trace_types_lock);
6492 if (iter->trace->pipe_close)
6493 iter->trace->pipe_close(iter);
6495 mutex_unlock(&trace_types_lock);
6497 free_cpumask_var(iter->started);
6498 mutex_destroy(&iter->mutex);
6501 trace_array_put(tr);
6507 trace_poll(struct trace_iterator *iter, struct file *filp, poll_table *poll_table)
6509 struct trace_array *tr = iter->tr;
6511 /* Iterators are static, they should be filled or empty */
6512 if (trace_buffer_iter(iter, iter->cpu_file))
6513 return EPOLLIN | EPOLLRDNORM;
6515 if (tr->trace_flags & TRACE_ITER_BLOCK)
6517 * Always select as readable when in blocking mode
6519 return EPOLLIN | EPOLLRDNORM;
6521 return ring_buffer_poll_wait(iter->array_buffer->buffer, iter->cpu_file,
6526 tracing_poll_pipe(struct file *filp, poll_table *poll_table)
6528 struct trace_iterator *iter = filp->private_data;
6530 return trace_poll(iter, filp, poll_table);
6533 /* Must be called with iter->mutex held. */
6534 static int tracing_wait_pipe(struct file *filp)
6536 struct trace_iterator *iter = filp->private_data;
6539 while (trace_empty(iter)) {
6541 if ((filp->f_flags & O_NONBLOCK)) {
6546 * We block until we read something and tracing is disabled.
6547 * We still block if tracing is disabled, but we have never
6548 * read anything. This allows a user to cat this file, and
6549 * then enable tracing. But after we have read something,
6550 * we give an EOF when tracing is again disabled.
6552 * iter->pos will be 0 if we haven't read anything.
6554 if (!tracer_tracing_is_on(iter->tr) && iter->pos)
6557 mutex_unlock(&iter->mutex);
6559 ret = wait_on_pipe(iter, 0);
6561 mutex_lock(&iter->mutex);
6574 tracing_read_pipe(struct file *filp, char __user *ubuf,
6575 size_t cnt, loff_t *ppos)
6577 struct trace_iterator *iter = filp->private_data;
6581 * Avoid more than one consumer on a single file descriptor
6582 * This is just a matter of traces coherency, the ring buffer itself
6585 mutex_lock(&iter->mutex);
6587 /* return any leftover data */
6588 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6592 trace_seq_init(&iter->seq);
6594 if (iter->trace->read) {
6595 sret = iter->trace->read(iter, filp, ubuf, cnt, ppos);
6601 sret = tracing_wait_pipe(filp);
6605 /* stop when tracing is finished */
6606 if (trace_empty(iter)) {
6611 if (cnt >= PAGE_SIZE)
6612 cnt = PAGE_SIZE - 1;
6614 /* reset all but tr, trace, and overruns */
6615 memset(&iter->seq, 0,
6616 sizeof(struct trace_iterator) -
6617 offsetof(struct trace_iterator, seq));
6618 cpumask_clear(iter->started);
6619 trace_seq_init(&iter->seq);
6622 trace_event_read_lock();
6623 trace_access_lock(iter->cpu_file);
6624 while (trace_find_next_entry_inc(iter) != NULL) {
6625 enum print_line_t ret;
6626 int save_len = iter->seq.seq.len;
6628 ret = print_trace_line(iter);
6629 if (ret == TRACE_TYPE_PARTIAL_LINE) {
6630 /* don't print partial lines */
6631 iter->seq.seq.len = save_len;
6634 if (ret != TRACE_TYPE_NO_CONSUME)
6635 trace_consume(iter);
6637 if (trace_seq_used(&iter->seq) >= cnt)
6641 * Setting the full flag means we reached the trace_seq buffer
6642 * size and we should leave by partial output condition above.
6643 * One of the trace_seq_* functions is not used properly.
6645 WARN_ONCE(iter->seq.full, "full flag set for trace type %d",
6648 trace_access_unlock(iter->cpu_file);
6649 trace_event_read_unlock();
6651 /* Now copy what we have to the user */
6652 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
6653 if (iter->seq.seq.readpos >= trace_seq_used(&iter->seq))
6654 trace_seq_init(&iter->seq);
6657 * If there was nothing to send to user, in spite of consuming trace
6658 * entries, go back to wait for more entries.
6664 mutex_unlock(&iter->mutex);
6669 static void tracing_spd_release_pipe(struct splice_pipe_desc *spd,
6672 __free_page(spd->pages[idx]);
6676 tracing_fill_pipe_page(size_t rem, struct trace_iterator *iter)
6682 /* Seq buffer is page-sized, exactly what we need. */
6684 save_len = iter->seq.seq.len;
6685 ret = print_trace_line(iter);
6687 if (trace_seq_has_overflowed(&iter->seq)) {
6688 iter->seq.seq.len = save_len;
6693 * This should not be hit, because it should only
6694 * be set if the iter->seq overflowed. But check it
6695 * anyway to be safe.
6697 if (ret == TRACE_TYPE_PARTIAL_LINE) {
6698 iter->seq.seq.len = save_len;
6702 count = trace_seq_used(&iter->seq) - save_len;
6705 iter->seq.seq.len = save_len;
6709 if (ret != TRACE_TYPE_NO_CONSUME)
6710 trace_consume(iter);
6712 if (!trace_find_next_entry_inc(iter)) {
6722 static ssize_t tracing_splice_read_pipe(struct file *filp,
6724 struct pipe_inode_info *pipe,
6728 struct page *pages_def[PIPE_DEF_BUFFERS];
6729 struct partial_page partial_def[PIPE_DEF_BUFFERS];
6730 struct trace_iterator *iter = filp->private_data;
6731 struct splice_pipe_desc spd = {
6733 .partial = partial_def,
6734 .nr_pages = 0, /* This gets updated below. */
6735 .nr_pages_max = PIPE_DEF_BUFFERS,
6736 .ops = &default_pipe_buf_ops,
6737 .spd_release = tracing_spd_release_pipe,
6743 if (splice_grow_spd(pipe, &spd))
6746 mutex_lock(&iter->mutex);
6748 if (iter->trace->splice_read) {
6749 ret = iter->trace->splice_read(iter, filp,
6750 ppos, pipe, len, flags);
6755 ret = tracing_wait_pipe(filp);
6759 if (!iter->ent && !trace_find_next_entry_inc(iter)) {
6764 trace_event_read_lock();
6765 trace_access_lock(iter->cpu_file);
6767 /* Fill as many pages as possible. */
6768 for (i = 0, rem = len; i < spd.nr_pages_max && rem; i++) {
6769 spd.pages[i] = alloc_page(GFP_KERNEL);
6773 rem = tracing_fill_pipe_page(rem, iter);
6775 /* Copy the data into the page, so we can start over. */
6776 ret = trace_seq_to_buffer(&iter->seq,
6777 page_address(spd.pages[i]),
6778 trace_seq_used(&iter->seq));
6780 __free_page(spd.pages[i]);
6783 spd.partial[i].offset = 0;
6784 spd.partial[i].len = trace_seq_used(&iter->seq);
6786 trace_seq_init(&iter->seq);
6789 trace_access_unlock(iter->cpu_file);
6790 trace_event_read_unlock();
6791 mutex_unlock(&iter->mutex);
6796 ret = splice_to_pipe(pipe, &spd);
6800 splice_shrink_spd(&spd);
6804 mutex_unlock(&iter->mutex);
6809 tracing_entries_read(struct file *filp, char __user *ubuf,
6810 size_t cnt, loff_t *ppos)
6812 struct inode *inode = file_inode(filp);
6813 struct trace_array *tr = inode->i_private;
6814 int cpu = tracing_get_cpu(inode);
6819 mutex_lock(&trace_types_lock);
6821 if (cpu == RING_BUFFER_ALL_CPUS) {
6822 int cpu, buf_size_same;
6827 /* check if all cpu sizes are same */
6828 for_each_tracing_cpu(cpu) {
6829 /* fill in the size from first enabled cpu */
6831 size = per_cpu_ptr(tr->array_buffer.data, cpu)->entries;
6832 if (size != per_cpu_ptr(tr->array_buffer.data, cpu)->entries) {
6838 if (buf_size_same) {
6839 if (!ring_buffer_expanded)
6840 r = sprintf(buf, "%lu (expanded: %lu)\n",
6842 trace_buf_size >> 10);
6844 r = sprintf(buf, "%lu\n", size >> 10);
6846 r = sprintf(buf, "X\n");
6848 r = sprintf(buf, "%lu\n", per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10);
6850 mutex_unlock(&trace_types_lock);
6852 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6857 tracing_entries_write(struct file *filp, const char __user *ubuf,
6858 size_t cnt, loff_t *ppos)
6860 struct inode *inode = file_inode(filp);
6861 struct trace_array *tr = inode->i_private;
6865 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6869 /* must have at least 1 entry */
6873 /* value is in KB */
6875 ret = tracing_resize_ring_buffer(tr, val, tracing_get_cpu(inode));
6885 tracing_total_entries_read(struct file *filp, char __user *ubuf,
6886 size_t cnt, loff_t *ppos)
6888 struct trace_array *tr = filp->private_data;
6891 unsigned long size = 0, expanded_size = 0;
6893 mutex_lock(&trace_types_lock);
6894 for_each_tracing_cpu(cpu) {
6895 size += per_cpu_ptr(tr->array_buffer.data, cpu)->entries >> 10;
6896 if (!ring_buffer_expanded)
6897 expanded_size += trace_buf_size >> 10;
6899 if (ring_buffer_expanded)
6900 r = sprintf(buf, "%lu\n", size);
6902 r = sprintf(buf, "%lu (expanded: %lu)\n", size, expanded_size);
6903 mutex_unlock(&trace_types_lock);
6905 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6909 tracing_free_buffer_write(struct file *filp, const char __user *ubuf,
6910 size_t cnt, loff_t *ppos)
6913 * There is no need to read what the user has written, this function
6914 * is just to make sure that there is no error when "echo" is used
6923 tracing_free_buffer_release(struct inode *inode, struct file *filp)
6925 struct trace_array *tr = inode->i_private;
6927 /* disable tracing ? */
6928 if (tr->trace_flags & TRACE_ITER_STOP_ON_FREE)
6929 tracer_tracing_off(tr);
6930 /* resize the ring buffer to 0 */
6931 tracing_resize_ring_buffer(tr, 0, RING_BUFFER_ALL_CPUS);
6933 trace_array_put(tr);
6939 tracing_mark_write(struct file *filp, const char __user *ubuf,
6940 size_t cnt, loff_t *fpos)
6942 struct trace_array *tr = filp->private_data;
6943 struct ring_buffer_event *event;
6944 enum event_trigger_type tt = ETT_NONE;
6945 struct trace_buffer *buffer;
6946 struct print_entry *entry;
6951 /* Used in tracing_mark_raw_write() as well */
6952 #define FAULTED_STR "<faulted>"
6953 #define FAULTED_SIZE (sizeof(FAULTED_STR) - 1) /* '\0' is already accounted for */
6955 if (tracing_disabled)
6958 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
6961 if (cnt > TRACE_BUF_SIZE)
6962 cnt = TRACE_BUF_SIZE;
6964 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
6966 size = sizeof(*entry) + cnt + 2; /* add '\0' and possible '\n' */
6968 /* If less than "<faulted>", then make sure we can still add that */
6969 if (cnt < FAULTED_SIZE)
6970 size += FAULTED_SIZE - cnt;
6972 buffer = tr->array_buffer.buffer;
6973 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
6975 if (unlikely(!event))
6976 /* Ring buffer disabled, return as if not open for write */
6979 entry = ring_buffer_event_data(event);
6980 entry->ip = _THIS_IP_;
6982 len = __copy_from_user_inatomic(&entry->buf, ubuf, cnt);
6984 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
6990 if (tr->trace_marker_file && !list_empty(&tr->trace_marker_file->triggers)) {
6991 /* do not add \n before testing triggers, but add \0 */
6992 entry->buf[cnt] = '\0';
6993 tt = event_triggers_call(tr->trace_marker_file, buffer, entry, event);
6996 if (entry->buf[cnt - 1] != '\n') {
6997 entry->buf[cnt] = '\n';
6998 entry->buf[cnt + 1] = '\0';
7000 entry->buf[cnt] = '\0';
7002 if (static_branch_unlikely(&trace_marker_exports_enabled))
7003 ftrace_exports(event, TRACE_EXPORT_MARKER);
7004 __buffer_unlock_commit(buffer, event);
7007 event_triggers_post_call(tr->trace_marker_file, tt);
7015 /* Limit it for now to 3K (including tag) */
7016 #define RAW_DATA_MAX_SIZE (1024*3)
7019 tracing_mark_raw_write(struct file *filp, const char __user *ubuf,
7020 size_t cnt, loff_t *fpos)
7022 struct trace_array *tr = filp->private_data;
7023 struct ring_buffer_event *event;
7024 struct trace_buffer *buffer;
7025 struct raw_data_entry *entry;
7030 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
7032 if (tracing_disabled)
7035 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
7038 /* The marker must at least have a tag id */
7039 if (cnt < sizeof(unsigned int) || cnt > RAW_DATA_MAX_SIZE)
7042 if (cnt > TRACE_BUF_SIZE)
7043 cnt = TRACE_BUF_SIZE;
7045 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
7047 size = sizeof(*entry) + cnt;
7048 if (cnt < FAULT_SIZE_ID)
7049 size += FAULT_SIZE_ID - cnt;
7051 buffer = tr->array_buffer.buffer;
7052 event = __trace_buffer_lock_reserve(buffer, TRACE_RAW_DATA, size,
7055 /* Ring buffer disabled, return as if not open for write */
7058 entry = ring_buffer_event_data(event);
7060 len = __copy_from_user_inatomic(&entry->id, ubuf, cnt);
7063 memcpy(&entry->buf, FAULTED_STR, FAULTED_SIZE);
7068 __buffer_unlock_commit(buffer, event);
7076 static int tracing_clock_show(struct seq_file *m, void *v)
7078 struct trace_array *tr = m->private;
7081 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++)
7083 "%s%s%s%s", i ? " " : "",
7084 i == tr->clock_id ? "[" : "", trace_clocks[i].name,
7085 i == tr->clock_id ? "]" : "");
7091 int tracing_set_clock(struct trace_array *tr, const char *clockstr)
7095 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++) {
7096 if (strcmp(trace_clocks[i].name, clockstr) == 0)
7099 if (i == ARRAY_SIZE(trace_clocks))
7102 mutex_lock(&trace_types_lock);
7106 ring_buffer_set_clock(tr->array_buffer.buffer, trace_clocks[i].func);
7109 * New clock may not be consistent with the previous clock.
7110 * Reset the buffer so that it doesn't have incomparable timestamps.
7112 tracing_reset_online_cpus(&tr->array_buffer);
7114 #ifdef CONFIG_TRACER_MAX_TRACE
7115 if (tr->max_buffer.buffer)
7116 ring_buffer_set_clock(tr->max_buffer.buffer, trace_clocks[i].func);
7117 tracing_reset_online_cpus(&tr->max_buffer);
7120 mutex_unlock(&trace_types_lock);
7125 static ssize_t tracing_clock_write(struct file *filp, const char __user *ubuf,
7126 size_t cnt, loff_t *fpos)
7128 struct seq_file *m = filp->private_data;
7129 struct trace_array *tr = m->private;
7131 const char *clockstr;
7134 if (cnt >= sizeof(buf))
7137 if (copy_from_user(buf, ubuf, cnt))
7142 clockstr = strstrip(buf);
7144 ret = tracing_set_clock(tr, clockstr);
7153 static int tracing_clock_open(struct inode *inode, struct file *file)
7155 struct trace_array *tr = inode->i_private;
7158 ret = tracing_check_open_get_tr(tr);
7162 ret = single_open(file, tracing_clock_show, inode->i_private);
7164 trace_array_put(tr);
7169 static int tracing_time_stamp_mode_show(struct seq_file *m, void *v)
7171 struct trace_array *tr = m->private;
7173 mutex_lock(&trace_types_lock);
7175 if (ring_buffer_time_stamp_abs(tr->array_buffer.buffer))
7176 seq_puts(m, "delta [absolute]\n");
7178 seq_puts(m, "[delta] absolute\n");
7180 mutex_unlock(&trace_types_lock);
7185 static int tracing_time_stamp_mode_open(struct inode *inode, struct file *file)
7187 struct trace_array *tr = inode->i_private;
7190 ret = tracing_check_open_get_tr(tr);
7194 ret = single_open(file, tracing_time_stamp_mode_show, inode->i_private);
7196 trace_array_put(tr);
7201 u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe)
7203 if (rbe == this_cpu_read(trace_buffered_event))
7204 return ring_buffer_time_stamp(buffer);
7206 return ring_buffer_event_time_stamp(buffer, rbe);
7210 * Set or disable using the per CPU trace_buffer_event when possible.
7212 int tracing_set_filter_buffering(struct trace_array *tr, bool set)
7216 mutex_lock(&trace_types_lock);
7218 if (set && tr->no_filter_buffering_ref++)
7222 if (WARN_ON_ONCE(!tr->no_filter_buffering_ref)) {
7227 --tr->no_filter_buffering_ref;
7230 mutex_unlock(&trace_types_lock);
7235 struct ftrace_buffer_info {
7236 struct trace_iterator iter;
7238 unsigned int spare_cpu;
7242 #ifdef CONFIG_TRACER_SNAPSHOT
7243 static int tracing_snapshot_open(struct inode *inode, struct file *file)
7245 struct trace_array *tr = inode->i_private;
7246 struct trace_iterator *iter;
7250 ret = tracing_check_open_get_tr(tr);
7254 if (file->f_mode & FMODE_READ) {
7255 iter = __tracing_open(inode, file, true);
7257 ret = PTR_ERR(iter);
7259 /* Writes still need the seq_file to hold the private data */
7261 m = kzalloc(sizeof(*m), GFP_KERNEL);
7264 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
7272 iter->array_buffer = &tr->max_buffer;
7273 iter->cpu_file = tracing_get_cpu(inode);
7275 file->private_data = m;
7279 trace_array_put(tr);
7285 tracing_snapshot_write(struct file *filp, const char __user *ubuf, size_t cnt,
7288 struct seq_file *m = filp->private_data;
7289 struct trace_iterator *iter = m->private;
7290 struct trace_array *tr = iter->tr;
7294 ret = tracing_update_buffers();
7298 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7302 mutex_lock(&trace_types_lock);
7304 if (tr->current_trace->use_max_tr) {
7309 arch_spin_lock(&tr->max_lock);
7310 if (tr->cond_snapshot)
7312 arch_spin_unlock(&tr->max_lock);
7318 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7322 if (tr->allocated_snapshot)
7326 /* Only allow per-cpu swap if the ring buffer supports it */
7327 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
7328 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
7333 if (tr->allocated_snapshot)
7334 ret = resize_buffer_duplicate_size(&tr->max_buffer,
7335 &tr->array_buffer, iter->cpu_file);
7337 ret = tracing_alloc_snapshot_instance(tr);
7340 local_irq_disable();
7341 /* Now, we're going to swap */
7342 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
7343 update_max_tr(tr, current, smp_processor_id(), NULL);
7345 update_max_tr_single(tr, current, iter->cpu_file);
7349 if (tr->allocated_snapshot) {
7350 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
7351 tracing_reset_online_cpus(&tr->max_buffer);
7353 tracing_reset_cpu(&tr->max_buffer, iter->cpu_file);
7363 mutex_unlock(&trace_types_lock);
7367 static int tracing_snapshot_release(struct inode *inode, struct file *file)
7369 struct seq_file *m = file->private_data;
7372 ret = tracing_release(inode, file);
7374 if (file->f_mode & FMODE_READ)
7377 /* If write only, the seq_file is just a stub */
7385 static int tracing_buffers_open(struct inode *inode, struct file *filp);
7386 static ssize_t tracing_buffers_read(struct file *filp, char __user *ubuf,
7387 size_t count, loff_t *ppos);
7388 static int tracing_buffers_release(struct inode *inode, struct file *file);
7389 static ssize_t tracing_buffers_splice_read(struct file *file, loff_t *ppos,
7390 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
7392 static int snapshot_raw_open(struct inode *inode, struct file *filp)
7394 struct ftrace_buffer_info *info;
7397 /* The following checks for tracefs lockdown */
7398 ret = tracing_buffers_open(inode, filp);
7402 info = filp->private_data;
7404 if (info->iter.trace->use_max_tr) {
7405 tracing_buffers_release(inode, filp);
7409 info->iter.snapshot = true;
7410 info->iter.array_buffer = &info->iter.tr->max_buffer;
7415 #endif /* CONFIG_TRACER_SNAPSHOT */
7418 static const struct file_operations tracing_thresh_fops = {
7419 .open = tracing_open_generic,
7420 .read = tracing_thresh_read,
7421 .write = tracing_thresh_write,
7422 .llseek = generic_file_llseek,
7425 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
7426 static const struct file_operations tracing_max_lat_fops = {
7427 .open = tracing_open_generic,
7428 .read = tracing_max_lat_read,
7429 .write = tracing_max_lat_write,
7430 .llseek = generic_file_llseek,
7434 static const struct file_operations set_tracer_fops = {
7435 .open = tracing_open_generic,
7436 .read = tracing_set_trace_read,
7437 .write = tracing_set_trace_write,
7438 .llseek = generic_file_llseek,
7441 static const struct file_operations tracing_pipe_fops = {
7442 .open = tracing_open_pipe,
7443 .poll = tracing_poll_pipe,
7444 .read = tracing_read_pipe,
7445 .splice_read = tracing_splice_read_pipe,
7446 .release = tracing_release_pipe,
7447 .llseek = no_llseek,
7450 static const struct file_operations tracing_entries_fops = {
7451 .open = tracing_open_generic_tr,
7452 .read = tracing_entries_read,
7453 .write = tracing_entries_write,
7454 .llseek = generic_file_llseek,
7455 .release = tracing_release_generic_tr,
7458 static const struct file_operations tracing_total_entries_fops = {
7459 .open = tracing_open_generic_tr,
7460 .read = tracing_total_entries_read,
7461 .llseek = generic_file_llseek,
7462 .release = tracing_release_generic_tr,
7465 static const struct file_operations tracing_free_buffer_fops = {
7466 .open = tracing_open_generic_tr,
7467 .write = tracing_free_buffer_write,
7468 .release = tracing_free_buffer_release,
7471 static const struct file_operations tracing_mark_fops = {
7472 .open = tracing_open_generic_tr,
7473 .write = tracing_mark_write,
7474 .llseek = generic_file_llseek,
7475 .release = tracing_release_generic_tr,
7478 static const struct file_operations tracing_mark_raw_fops = {
7479 .open = tracing_open_generic_tr,
7480 .write = tracing_mark_raw_write,
7481 .llseek = generic_file_llseek,
7482 .release = tracing_release_generic_tr,
7485 static const struct file_operations trace_clock_fops = {
7486 .open = tracing_clock_open,
7488 .llseek = seq_lseek,
7489 .release = tracing_single_release_tr,
7490 .write = tracing_clock_write,
7493 static const struct file_operations trace_time_stamp_mode_fops = {
7494 .open = tracing_time_stamp_mode_open,
7496 .llseek = seq_lseek,
7497 .release = tracing_single_release_tr,
7500 #ifdef CONFIG_TRACER_SNAPSHOT
7501 static const struct file_operations snapshot_fops = {
7502 .open = tracing_snapshot_open,
7504 .write = tracing_snapshot_write,
7505 .llseek = tracing_lseek,
7506 .release = tracing_snapshot_release,
7509 static const struct file_operations snapshot_raw_fops = {
7510 .open = snapshot_raw_open,
7511 .read = tracing_buffers_read,
7512 .release = tracing_buffers_release,
7513 .splice_read = tracing_buffers_splice_read,
7514 .llseek = no_llseek,
7517 #endif /* CONFIG_TRACER_SNAPSHOT */
7519 #define TRACING_LOG_ERRS_MAX 8
7520 #define TRACING_LOG_LOC_MAX 128
7522 #define CMD_PREFIX " Command: "
7525 const char **errs; /* ptr to loc-specific array of err strings */
7526 u8 type; /* index into errs -> specific err string */
7527 u8 pos; /* MAX_FILTER_STR_VAL = 256 */
7531 struct tracing_log_err {
7532 struct list_head list;
7533 struct err_info info;
7534 char loc[TRACING_LOG_LOC_MAX]; /* err location */
7535 char cmd[MAX_FILTER_STR_VAL]; /* what caused err */
7538 static DEFINE_MUTEX(tracing_err_log_lock);
7540 static struct tracing_log_err *get_tracing_log_err(struct trace_array *tr)
7542 struct tracing_log_err *err;
7544 if (tr->n_err_log_entries < TRACING_LOG_ERRS_MAX) {
7545 err = kzalloc(sizeof(*err), GFP_KERNEL);
7547 err = ERR_PTR(-ENOMEM);
7548 tr->n_err_log_entries++;
7553 err = list_first_entry(&tr->err_log, struct tracing_log_err, list);
7554 list_del(&err->list);
7560 * err_pos - find the position of a string within a command for error careting
7561 * @cmd: The tracing command that caused the error
7562 * @str: The string to position the caret at within @cmd
7564 * Finds the position of the first occurrence of @str within @cmd. The
7565 * return value can be passed to tracing_log_err() for caret placement
7568 * Returns the index within @cmd of the first occurrence of @str or 0
7569 * if @str was not found.
7571 unsigned int err_pos(char *cmd, const char *str)
7575 if (WARN_ON(!strlen(cmd)))
7578 found = strstr(cmd, str);
7586 * tracing_log_err - write an error to the tracing error log
7587 * @tr: The associated trace array for the error (NULL for top level array)
7588 * @loc: A string describing where the error occurred
7589 * @cmd: The tracing command that caused the error
7590 * @errs: The array of loc-specific static error strings
7591 * @type: The index into errs[], which produces the specific static err string
7592 * @pos: The position the caret should be placed in the cmd
7594 * Writes an error into tracing/error_log of the form:
7596 * <loc>: error: <text>
7600 * tracing/error_log is a small log file containing the last
7601 * TRACING_LOG_ERRS_MAX errors (8). Memory for errors isn't allocated
7602 * unless there has been a tracing error, and the error log can be
7603 * cleared and have its memory freed by writing the empty string in
7604 * truncation mode to it i.e. echo > tracing/error_log.
7606 * NOTE: the @errs array along with the @type param are used to
7607 * produce a static error string - this string is not copied and saved
7608 * when the error is logged - only a pointer to it is saved. See
7609 * existing callers for examples of how static strings are typically
7610 * defined for use with tracing_log_err().
7612 void tracing_log_err(struct trace_array *tr,
7613 const char *loc, const char *cmd,
7614 const char **errs, u8 type, u8 pos)
7616 struct tracing_log_err *err;
7621 mutex_lock(&tracing_err_log_lock);
7622 err = get_tracing_log_err(tr);
7623 if (PTR_ERR(err) == -ENOMEM) {
7624 mutex_unlock(&tracing_err_log_lock);
7628 snprintf(err->loc, TRACING_LOG_LOC_MAX, "%s: error: ", loc);
7629 snprintf(err->cmd, MAX_FILTER_STR_VAL,"\n" CMD_PREFIX "%s\n", cmd);
7631 err->info.errs = errs;
7632 err->info.type = type;
7633 err->info.pos = pos;
7634 err->info.ts = local_clock();
7636 list_add_tail(&err->list, &tr->err_log);
7637 mutex_unlock(&tracing_err_log_lock);
7640 static void clear_tracing_err_log(struct trace_array *tr)
7642 struct tracing_log_err *err, *next;
7644 mutex_lock(&tracing_err_log_lock);
7645 list_for_each_entry_safe(err, next, &tr->err_log, list) {
7646 list_del(&err->list);
7650 tr->n_err_log_entries = 0;
7651 mutex_unlock(&tracing_err_log_lock);
7654 static void *tracing_err_log_seq_start(struct seq_file *m, loff_t *pos)
7656 struct trace_array *tr = m->private;
7658 mutex_lock(&tracing_err_log_lock);
7660 return seq_list_start(&tr->err_log, *pos);
7663 static void *tracing_err_log_seq_next(struct seq_file *m, void *v, loff_t *pos)
7665 struct trace_array *tr = m->private;
7667 return seq_list_next(v, &tr->err_log, pos);
7670 static void tracing_err_log_seq_stop(struct seq_file *m, void *v)
7672 mutex_unlock(&tracing_err_log_lock);
7675 static void tracing_err_log_show_pos(struct seq_file *m, u8 pos)
7679 for (i = 0; i < sizeof(CMD_PREFIX) - 1; i++)
7681 for (i = 0; i < pos; i++)
7686 static int tracing_err_log_seq_show(struct seq_file *m, void *v)
7688 struct tracing_log_err *err = v;
7691 const char *err_text = err->info.errs[err->info.type];
7692 u64 sec = err->info.ts;
7695 nsec = do_div(sec, NSEC_PER_SEC);
7696 seq_printf(m, "[%5llu.%06u] %s%s", sec, nsec / 1000,
7697 err->loc, err_text);
7698 seq_printf(m, "%s", err->cmd);
7699 tracing_err_log_show_pos(m, err->info.pos);
7705 static const struct seq_operations tracing_err_log_seq_ops = {
7706 .start = tracing_err_log_seq_start,
7707 .next = tracing_err_log_seq_next,
7708 .stop = tracing_err_log_seq_stop,
7709 .show = tracing_err_log_seq_show
7712 static int tracing_err_log_open(struct inode *inode, struct file *file)
7714 struct trace_array *tr = inode->i_private;
7717 ret = tracing_check_open_get_tr(tr);
7721 /* If this file was opened for write, then erase contents */
7722 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC))
7723 clear_tracing_err_log(tr);
7725 if (file->f_mode & FMODE_READ) {
7726 ret = seq_open(file, &tracing_err_log_seq_ops);
7728 struct seq_file *m = file->private_data;
7731 trace_array_put(tr);
7737 static ssize_t tracing_err_log_write(struct file *file,
7738 const char __user *buffer,
7739 size_t count, loff_t *ppos)
7744 static int tracing_err_log_release(struct inode *inode, struct file *file)
7746 struct trace_array *tr = inode->i_private;
7748 trace_array_put(tr);
7750 if (file->f_mode & FMODE_READ)
7751 seq_release(inode, file);
7756 static const struct file_operations tracing_err_log_fops = {
7757 .open = tracing_err_log_open,
7758 .write = tracing_err_log_write,
7760 .llseek = seq_lseek,
7761 .release = tracing_err_log_release,
7764 static int tracing_buffers_open(struct inode *inode, struct file *filp)
7766 struct trace_array *tr = inode->i_private;
7767 struct ftrace_buffer_info *info;
7770 ret = tracing_check_open_get_tr(tr);
7774 info = kvzalloc(sizeof(*info), GFP_KERNEL);
7776 trace_array_put(tr);
7780 mutex_lock(&trace_types_lock);
7783 info->iter.cpu_file = tracing_get_cpu(inode);
7784 info->iter.trace = tr->current_trace;
7785 info->iter.array_buffer = &tr->array_buffer;
7787 /* Force reading ring buffer for first read */
7788 info->read = (unsigned int)-1;
7790 filp->private_data = info;
7794 mutex_unlock(&trace_types_lock);
7796 ret = nonseekable_open(inode, filp);
7798 trace_array_put(tr);
7804 tracing_buffers_poll(struct file *filp, poll_table *poll_table)
7806 struct ftrace_buffer_info *info = filp->private_data;
7807 struct trace_iterator *iter = &info->iter;
7809 return trace_poll(iter, filp, poll_table);
7813 tracing_buffers_read(struct file *filp, char __user *ubuf,
7814 size_t count, loff_t *ppos)
7816 struct ftrace_buffer_info *info = filp->private_data;
7817 struct trace_iterator *iter = &info->iter;
7824 #ifdef CONFIG_TRACER_MAX_TRACE
7825 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
7830 info->spare = ring_buffer_alloc_read_page(iter->array_buffer->buffer,
7832 if (IS_ERR(info->spare)) {
7833 ret = PTR_ERR(info->spare);
7836 info->spare_cpu = iter->cpu_file;
7842 /* Do we have previous read data to read? */
7843 if (info->read < PAGE_SIZE)
7847 trace_access_lock(iter->cpu_file);
7848 ret = ring_buffer_read_page(iter->array_buffer->buffer,
7852 trace_access_unlock(iter->cpu_file);
7855 if (trace_empty(iter)) {
7856 if ((filp->f_flags & O_NONBLOCK))
7859 ret = wait_on_pipe(iter, 0);
7870 size = PAGE_SIZE - info->read;
7874 ret = copy_to_user(ubuf, info->spare + info->read, size);
7886 static int tracing_buffers_release(struct inode *inode, struct file *file)
7888 struct ftrace_buffer_info *info = file->private_data;
7889 struct trace_iterator *iter = &info->iter;
7891 mutex_lock(&trace_types_lock);
7893 iter->tr->trace_ref--;
7895 __trace_array_put(iter->tr);
7898 ring_buffer_free_read_page(iter->array_buffer->buffer,
7899 info->spare_cpu, info->spare);
7902 mutex_unlock(&trace_types_lock);
7908 struct trace_buffer *buffer;
7911 refcount_t refcount;
7914 static void buffer_ref_release(struct buffer_ref *ref)
7916 if (!refcount_dec_and_test(&ref->refcount))
7918 ring_buffer_free_read_page(ref->buffer, ref->cpu, ref->page);
7922 static void buffer_pipe_buf_release(struct pipe_inode_info *pipe,
7923 struct pipe_buffer *buf)
7925 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
7927 buffer_ref_release(ref);
7931 static bool buffer_pipe_buf_get(struct pipe_inode_info *pipe,
7932 struct pipe_buffer *buf)
7934 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
7936 if (refcount_read(&ref->refcount) > INT_MAX/2)
7939 refcount_inc(&ref->refcount);
7943 /* Pipe buffer operations for a buffer. */
7944 static const struct pipe_buf_operations buffer_pipe_buf_ops = {
7945 .release = buffer_pipe_buf_release,
7946 .get = buffer_pipe_buf_get,
7950 * Callback from splice_to_pipe(), if we need to release some pages
7951 * at the end of the spd in case we error'ed out in filling the pipe.
7953 static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)
7955 struct buffer_ref *ref =
7956 (struct buffer_ref *)spd->partial[i].private;
7958 buffer_ref_release(ref);
7959 spd->partial[i].private = 0;
7963 tracing_buffers_splice_read(struct file *file, loff_t *ppos,
7964 struct pipe_inode_info *pipe, size_t len,
7967 struct ftrace_buffer_info *info = file->private_data;
7968 struct trace_iterator *iter = &info->iter;
7969 struct partial_page partial_def[PIPE_DEF_BUFFERS];
7970 struct page *pages_def[PIPE_DEF_BUFFERS];
7971 struct splice_pipe_desc spd = {
7973 .partial = partial_def,
7974 .nr_pages_max = PIPE_DEF_BUFFERS,
7975 .ops = &buffer_pipe_buf_ops,
7976 .spd_release = buffer_spd_release,
7978 struct buffer_ref *ref;
7982 #ifdef CONFIG_TRACER_MAX_TRACE
7983 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
7987 if (*ppos & (PAGE_SIZE - 1))
7990 if (len & (PAGE_SIZE - 1)) {
7991 if (len < PAGE_SIZE)
7996 if (splice_grow_spd(pipe, &spd))
8000 trace_access_lock(iter->cpu_file);
8001 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8003 for (i = 0; i < spd.nr_pages_max && len && entries; i++, len -= PAGE_SIZE) {
8007 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
8013 refcount_set(&ref->refcount, 1);
8014 ref->buffer = iter->array_buffer->buffer;
8015 ref->page = ring_buffer_alloc_read_page(ref->buffer, iter->cpu_file);
8016 if (IS_ERR(ref->page)) {
8017 ret = PTR_ERR(ref->page);
8022 ref->cpu = iter->cpu_file;
8024 r = ring_buffer_read_page(ref->buffer, &ref->page,
8025 len, iter->cpu_file, 1);
8027 ring_buffer_free_read_page(ref->buffer, ref->cpu,
8033 page = virt_to_page(ref->page);
8035 spd.pages[i] = page;
8036 spd.partial[i].len = PAGE_SIZE;
8037 spd.partial[i].offset = 0;
8038 spd.partial[i].private = (unsigned long)ref;
8042 entries = ring_buffer_entries_cpu(iter->array_buffer->buffer, iter->cpu_file);
8045 trace_access_unlock(iter->cpu_file);
8048 /* did we read anything? */
8049 if (!spd.nr_pages) {
8054 if ((file->f_flags & O_NONBLOCK) || (flags & SPLICE_F_NONBLOCK))
8057 ret = wait_on_pipe(iter, iter->tr->buffer_percent);
8064 ret = splice_to_pipe(pipe, &spd);
8066 splice_shrink_spd(&spd);
8071 static const struct file_operations tracing_buffers_fops = {
8072 .open = tracing_buffers_open,
8073 .read = tracing_buffers_read,
8074 .poll = tracing_buffers_poll,
8075 .release = tracing_buffers_release,
8076 .splice_read = tracing_buffers_splice_read,
8077 .llseek = no_llseek,
8081 tracing_stats_read(struct file *filp, char __user *ubuf,
8082 size_t count, loff_t *ppos)
8084 struct inode *inode = file_inode(filp);
8085 struct trace_array *tr = inode->i_private;
8086 struct array_buffer *trace_buf = &tr->array_buffer;
8087 int cpu = tracing_get_cpu(inode);
8088 struct trace_seq *s;
8090 unsigned long long t;
8091 unsigned long usec_rem;
8093 s = kmalloc(sizeof(*s), GFP_KERNEL);
8099 cnt = ring_buffer_entries_cpu(trace_buf->buffer, cpu);
8100 trace_seq_printf(s, "entries: %ld\n", cnt);
8102 cnt = ring_buffer_overrun_cpu(trace_buf->buffer, cpu);
8103 trace_seq_printf(s, "overrun: %ld\n", cnt);
8105 cnt = ring_buffer_commit_overrun_cpu(trace_buf->buffer, cpu);
8106 trace_seq_printf(s, "commit overrun: %ld\n", cnt);
8108 cnt = ring_buffer_bytes_cpu(trace_buf->buffer, cpu);
8109 trace_seq_printf(s, "bytes: %ld\n", cnt);
8111 if (trace_clocks[tr->clock_id].in_ns) {
8112 /* local or global for trace_clock */
8113 t = ns2usecs(ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8114 usec_rem = do_div(t, USEC_PER_SEC);
8115 trace_seq_printf(s, "oldest event ts: %5llu.%06lu\n",
8118 t = ns2usecs(ring_buffer_time_stamp(trace_buf->buffer));
8119 usec_rem = do_div(t, USEC_PER_SEC);
8120 trace_seq_printf(s, "now ts: %5llu.%06lu\n", t, usec_rem);
8122 /* counter or tsc mode for trace_clock */
8123 trace_seq_printf(s, "oldest event ts: %llu\n",
8124 ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
8126 trace_seq_printf(s, "now ts: %llu\n",
8127 ring_buffer_time_stamp(trace_buf->buffer));
8130 cnt = ring_buffer_dropped_events_cpu(trace_buf->buffer, cpu);
8131 trace_seq_printf(s, "dropped events: %ld\n", cnt);
8133 cnt = ring_buffer_read_events_cpu(trace_buf->buffer, cpu);
8134 trace_seq_printf(s, "read events: %ld\n", cnt);
8136 count = simple_read_from_buffer(ubuf, count, ppos,
8137 s->buffer, trace_seq_used(s));
8144 static const struct file_operations tracing_stats_fops = {
8145 .open = tracing_open_generic_tr,
8146 .read = tracing_stats_read,
8147 .llseek = generic_file_llseek,
8148 .release = tracing_release_generic_tr,
8151 #ifdef CONFIG_DYNAMIC_FTRACE
8154 tracing_read_dyn_info(struct file *filp, char __user *ubuf,
8155 size_t cnt, loff_t *ppos)
8161 /* 256 should be plenty to hold the amount needed */
8162 buf = kmalloc(256, GFP_KERNEL);
8166 r = scnprintf(buf, 256, "%ld pages:%ld groups: %ld\n",
8167 ftrace_update_tot_cnt,
8168 ftrace_number_of_pages,
8169 ftrace_number_of_groups);
8171 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
8176 static const struct file_operations tracing_dyn_info_fops = {
8177 .open = tracing_open_generic,
8178 .read = tracing_read_dyn_info,
8179 .llseek = generic_file_llseek,
8181 #endif /* CONFIG_DYNAMIC_FTRACE */
8183 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
8185 ftrace_snapshot(unsigned long ip, unsigned long parent_ip,
8186 struct trace_array *tr, struct ftrace_probe_ops *ops,
8189 tracing_snapshot_instance(tr);
8193 ftrace_count_snapshot(unsigned long ip, unsigned long parent_ip,
8194 struct trace_array *tr, struct ftrace_probe_ops *ops,
8197 struct ftrace_func_mapper *mapper = data;
8201 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8211 tracing_snapshot_instance(tr);
8215 ftrace_snapshot_print(struct seq_file *m, unsigned long ip,
8216 struct ftrace_probe_ops *ops, void *data)
8218 struct ftrace_func_mapper *mapper = data;
8221 seq_printf(m, "%ps:", (void *)ip);
8223 seq_puts(m, "snapshot");
8226 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
8229 seq_printf(m, ":count=%ld\n", *count);
8231 seq_puts(m, ":unlimited\n");
8237 ftrace_snapshot_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
8238 unsigned long ip, void *init_data, void **data)
8240 struct ftrace_func_mapper *mapper = *data;
8243 mapper = allocate_ftrace_func_mapper();
8249 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
8253 ftrace_snapshot_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
8254 unsigned long ip, void *data)
8256 struct ftrace_func_mapper *mapper = data;
8261 free_ftrace_func_mapper(mapper, NULL);
8265 ftrace_func_mapper_remove_ip(mapper, ip);
8268 static struct ftrace_probe_ops snapshot_probe_ops = {
8269 .func = ftrace_snapshot,
8270 .print = ftrace_snapshot_print,
8273 static struct ftrace_probe_ops snapshot_count_probe_ops = {
8274 .func = ftrace_count_snapshot,
8275 .print = ftrace_snapshot_print,
8276 .init = ftrace_snapshot_init,
8277 .free = ftrace_snapshot_free,
8281 ftrace_trace_snapshot_callback(struct trace_array *tr, struct ftrace_hash *hash,
8282 char *glob, char *cmd, char *param, int enable)
8284 struct ftrace_probe_ops *ops;
8285 void *count = (void *)-1;
8292 /* hash funcs only work with set_ftrace_filter */
8296 ops = param ? &snapshot_count_probe_ops : &snapshot_probe_ops;
8299 return unregister_ftrace_function_probe_func(glob+1, tr, ops);
8304 number = strsep(¶m, ":");
8306 if (!strlen(number))
8310 * We use the callback data field (which is a pointer)
8313 ret = kstrtoul(number, 0, (unsigned long *)&count);
8318 ret = tracing_alloc_snapshot_instance(tr);
8322 ret = register_ftrace_function_probe(glob, tr, ops, count);
8325 return ret < 0 ? ret : 0;
8328 static struct ftrace_func_command ftrace_snapshot_cmd = {
8330 .func = ftrace_trace_snapshot_callback,
8333 static __init int register_snapshot_cmd(void)
8335 return register_ftrace_command(&ftrace_snapshot_cmd);
8338 static inline __init int register_snapshot_cmd(void) { return 0; }
8339 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
8341 static struct dentry *tracing_get_dentry(struct trace_array *tr)
8343 if (WARN_ON(!tr->dir))
8344 return ERR_PTR(-ENODEV);
8346 /* Top directory uses NULL as the parent */
8347 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
8350 /* All sub buffers have a descriptor */
8354 static struct dentry *tracing_dentry_percpu(struct trace_array *tr, int cpu)
8356 struct dentry *d_tracer;
8359 return tr->percpu_dir;
8361 d_tracer = tracing_get_dentry(tr);
8362 if (IS_ERR(d_tracer))
8365 tr->percpu_dir = tracefs_create_dir("per_cpu", d_tracer);
8367 MEM_FAIL(!tr->percpu_dir,
8368 "Could not create tracefs directory 'per_cpu/%d'\n", cpu);
8370 return tr->percpu_dir;
8373 static struct dentry *
8374 trace_create_cpu_file(const char *name, umode_t mode, struct dentry *parent,
8375 void *data, long cpu, const struct file_operations *fops)
8377 struct dentry *ret = trace_create_file(name, mode, parent, data, fops);
8379 if (ret) /* See tracing_get_cpu() */
8380 d_inode(ret)->i_cdev = (void *)(cpu + 1);
8385 tracing_init_tracefs_percpu(struct trace_array *tr, long cpu)
8387 struct dentry *d_percpu = tracing_dentry_percpu(tr, cpu);
8388 struct dentry *d_cpu;
8389 char cpu_dir[30]; /* 30 characters should be more than enough */
8394 snprintf(cpu_dir, 30, "cpu%ld", cpu);
8395 d_cpu = tracefs_create_dir(cpu_dir, d_percpu);
8397 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir);
8401 /* per cpu trace_pipe */
8402 trace_create_cpu_file("trace_pipe", 0444, d_cpu,
8403 tr, cpu, &tracing_pipe_fops);
8406 trace_create_cpu_file("trace", 0644, d_cpu,
8407 tr, cpu, &tracing_fops);
8409 trace_create_cpu_file("trace_pipe_raw", 0444, d_cpu,
8410 tr, cpu, &tracing_buffers_fops);
8412 trace_create_cpu_file("stats", 0444, d_cpu,
8413 tr, cpu, &tracing_stats_fops);
8415 trace_create_cpu_file("buffer_size_kb", 0444, d_cpu,
8416 tr, cpu, &tracing_entries_fops);
8418 #ifdef CONFIG_TRACER_SNAPSHOT
8419 trace_create_cpu_file("snapshot", 0644, d_cpu,
8420 tr, cpu, &snapshot_fops);
8422 trace_create_cpu_file("snapshot_raw", 0444, d_cpu,
8423 tr, cpu, &snapshot_raw_fops);
8427 #ifdef CONFIG_FTRACE_SELFTEST
8428 /* Let selftest have access to static functions in this file */
8429 #include "trace_selftest.c"
8433 trace_options_read(struct file *filp, char __user *ubuf, size_t cnt,
8436 struct trace_option_dentry *topt = filp->private_data;
8439 if (topt->flags->val & topt->opt->bit)
8444 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
8448 trace_options_write(struct file *filp, const char __user *ubuf, size_t cnt,
8451 struct trace_option_dentry *topt = filp->private_data;
8455 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8459 if (val != 0 && val != 1)
8462 if (!!(topt->flags->val & topt->opt->bit) != val) {
8463 mutex_lock(&trace_types_lock);
8464 ret = __set_tracer_option(topt->tr, topt->flags,
8466 mutex_unlock(&trace_types_lock);
8477 static const struct file_operations trace_options_fops = {
8478 .open = tracing_open_generic,
8479 .read = trace_options_read,
8480 .write = trace_options_write,
8481 .llseek = generic_file_llseek,
8485 * In order to pass in both the trace_array descriptor as well as the index
8486 * to the flag that the trace option file represents, the trace_array
8487 * has a character array of trace_flags_index[], which holds the index
8488 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
8489 * The address of this character array is passed to the flag option file
8490 * read/write callbacks.
8492 * In order to extract both the index and the trace_array descriptor,
8493 * get_tr_index() uses the following algorithm.
8497 * As the pointer itself contains the address of the index (remember
8500 * Then to get the trace_array descriptor, by subtracting that index
8501 * from the ptr, we get to the start of the index itself.
8503 * ptr - idx == &index[0]
8505 * Then a simple container_of() from that pointer gets us to the
8506 * trace_array descriptor.
8508 static void get_tr_index(void *data, struct trace_array **ptr,
8509 unsigned int *pindex)
8511 *pindex = *(unsigned char *)data;
8513 *ptr = container_of(data - *pindex, struct trace_array,
8518 trace_options_core_read(struct file *filp, char __user *ubuf, size_t cnt,
8521 void *tr_index = filp->private_data;
8522 struct trace_array *tr;
8526 get_tr_index(tr_index, &tr, &index);
8528 if (tr->trace_flags & (1 << index))
8533 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
8537 trace_options_core_write(struct file *filp, const char __user *ubuf, size_t cnt,
8540 void *tr_index = filp->private_data;
8541 struct trace_array *tr;
8546 get_tr_index(tr_index, &tr, &index);
8548 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8552 if (val != 0 && val != 1)
8555 mutex_lock(&event_mutex);
8556 mutex_lock(&trace_types_lock);
8557 ret = set_tracer_flag(tr, 1 << index, val);
8558 mutex_unlock(&trace_types_lock);
8559 mutex_unlock(&event_mutex);
8569 static const struct file_operations trace_options_core_fops = {
8570 .open = tracing_open_generic,
8571 .read = trace_options_core_read,
8572 .write = trace_options_core_write,
8573 .llseek = generic_file_llseek,
8576 struct dentry *trace_create_file(const char *name,
8578 struct dentry *parent,
8580 const struct file_operations *fops)
8584 ret = tracefs_create_file(name, mode, parent, data, fops);
8586 pr_warn("Could not create tracefs '%s' entry\n", name);
8592 static struct dentry *trace_options_init_dentry(struct trace_array *tr)
8594 struct dentry *d_tracer;
8599 d_tracer = tracing_get_dentry(tr);
8600 if (IS_ERR(d_tracer))
8603 tr->options = tracefs_create_dir("options", d_tracer);
8605 pr_warn("Could not create tracefs directory 'options'\n");
8613 create_trace_option_file(struct trace_array *tr,
8614 struct trace_option_dentry *topt,
8615 struct tracer_flags *flags,
8616 struct tracer_opt *opt)
8618 struct dentry *t_options;
8620 t_options = trace_options_init_dentry(tr);
8624 topt->flags = flags;
8628 topt->entry = trace_create_file(opt->name, 0644, t_options, topt,
8629 &trace_options_fops);
8634 create_trace_option_files(struct trace_array *tr, struct tracer *tracer)
8636 struct trace_option_dentry *topts;
8637 struct trace_options *tr_topts;
8638 struct tracer_flags *flags;
8639 struct tracer_opt *opts;
8646 flags = tracer->flags;
8648 if (!flags || !flags->opts)
8652 * If this is an instance, only create flags for tracers
8653 * the instance may have.
8655 if (!trace_ok_for_array(tracer, tr))
8658 for (i = 0; i < tr->nr_topts; i++) {
8659 /* Make sure there's no duplicate flags. */
8660 if (WARN_ON_ONCE(tr->topts[i].tracer->flags == tracer->flags))
8666 for (cnt = 0; opts[cnt].name; cnt++)
8669 topts = kcalloc(cnt + 1, sizeof(*topts), GFP_KERNEL);
8673 tr_topts = krealloc(tr->topts, sizeof(*tr->topts) * (tr->nr_topts + 1),
8680 tr->topts = tr_topts;
8681 tr->topts[tr->nr_topts].tracer = tracer;
8682 tr->topts[tr->nr_topts].topts = topts;
8685 for (cnt = 0; opts[cnt].name; cnt++) {
8686 create_trace_option_file(tr, &topts[cnt], flags,
8688 MEM_FAIL(topts[cnt].entry == NULL,
8689 "Failed to create trace option: %s",
8694 static struct dentry *
8695 create_trace_option_core_file(struct trace_array *tr,
8696 const char *option, long index)
8698 struct dentry *t_options;
8700 t_options = trace_options_init_dentry(tr);
8704 return trace_create_file(option, 0644, t_options,
8705 (void *)&tr->trace_flags_index[index],
8706 &trace_options_core_fops);
8709 static void create_trace_options_dir(struct trace_array *tr)
8711 struct dentry *t_options;
8712 bool top_level = tr == &global_trace;
8715 t_options = trace_options_init_dentry(tr);
8719 for (i = 0; trace_options[i]; i++) {
8721 !((1 << i) & TOP_LEVEL_TRACE_FLAGS))
8722 create_trace_option_core_file(tr, trace_options[i], i);
8727 rb_simple_read(struct file *filp, char __user *ubuf,
8728 size_t cnt, loff_t *ppos)
8730 struct trace_array *tr = filp->private_data;
8734 r = tracer_tracing_is_on(tr);
8735 r = sprintf(buf, "%d\n", r);
8737 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
8741 rb_simple_write(struct file *filp, const char __user *ubuf,
8742 size_t cnt, loff_t *ppos)
8744 struct trace_array *tr = filp->private_data;
8745 struct trace_buffer *buffer = tr->array_buffer.buffer;
8749 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8754 mutex_lock(&trace_types_lock);
8755 if (!!val == tracer_tracing_is_on(tr)) {
8756 val = 0; /* do nothing */
8758 tracer_tracing_on(tr);
8759 if (tr->current_trace->start)
8760 tr->current_trace->start(tr);
8762 tracer_tracing_off(tr);
8763 if (tr->current_trace->stop)
8764 tr->current_trace->stop(tr);
8766 mutex_unlock(&trace_types_lock);
8774 static const struct file_operations rb_simple_fops = {
8775 .open = tracing_open_generic_tr,
8776 .read = rb_simple_read,
8777 .write = rb_simple_write,
8778 .release = tracing_release_generic_tr,
8779 .llseek = default_llseek,
8783 buffer_percent_read(struct file *filp, char __user *ubuf,
8784 size_t cnt, loff_t *ppos)
8786 struct trace_array *tr = filp->private_data;
8790 r = tr->buffer_percent;
8791 r = sprintf(buf, "%d\n", r);
8793 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
8797 buffer_percent_write(struct file *filp, const char __user *ubuf,
8798 size_t cnt, loff_t *ppos)
8800 struct trace_array *tr = filp->private_data;
8804 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
8814 tr->buffer_percent = val;
8821 static const struct file_operations buffer_percent_fops = {
8822 .open = tracing_open_generic_tr,
8823 .read = buffer_percent_read,
8824 .write = buffer_percent_write,
8825 .release = tracing_release_generic_tr,
8826 .llseek = default_llseek,
8829 static struct dentry *trace_instance_dir;
8832 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer);
8835 allocate_trace_buffer(struct trace_array *tr, struct array_buffer *buf, int size)
8837 enum ring_buffer_flags rb_flags;
8839 rb_flags = tr->trace_flags & TRACE_ITER_OVERWRITE ? RB_FL_OVERWRITE : 0;
8843 buf->buffer = ring_buffer_alloc(size, rb_flags);
8847 buf->data = alloc_percpu(struct trace_array_cpu);
8849 ring_buffer_free(buf->buffer);
8854 /* Allocate the first page for all buffers */
8855 set_buffer_entries(&tr->array_buffer,
8856 ring_buffer_size(tr->array_buffer.buffer, 0));
8861 static int allocate_trace_buffers(struct trace_array *tr, int size)
8865 ret = allocate_trace_buffer(tr, &tr->array_buffer, size);
8869 #ifdef CONFIG_TRACER_MAX_TRACE
8870 ret = allocate_trace_buffer(tr, &tr->max_buffer,
8871 allocate_snapshot ? size : 1);
8872 if (MEM_FAIL(ret, "Failed to allocate trace buffer\n")) {
8873 ring_buffer_free(tr->array_buffer.buffer);
8874 tr->array_buffer.buffer = NULL;
8875 free_percpu(tr->array_buffer.data);
8876 tr->array_buffer.data = NULL;
8879 tr->allocated_snapshot = allocate_snapshot;
8882 * Only the top level trace array gets its snapshot allocated
8883 * from the kernel command line.
8885 allocate_snapshot = false;
8891 static void free_trace_buffer(struct array_buffer *buf)
8894 ring_buffer_free(buf->buffer);
8896 free_percpu(buf->data);
8901 static void free_trace_buffers(struct trace_array *tr)
8906 free_trace_buffer(&tr->array_buffer);
8908 #ifdef CONFIG_TRACER_MAX_TRACE
8909 free_trace_buffer(&tr->max_buffer);
8913 static void init_trace_flags_index(struct trace_array *tr)
8917 /* Used by the trace options files */
8918 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++)
8919 tr->trace_flags_index[i] = i;
8922 static void __update_tracer_options(struct trace_array *tr)
8926 for (t = trace_types; t; t = t->next)
8927 add_tracer_options(tr, t);
8930 static void update_tracer_options(struct trace_array *tr)
8932 mutex_lock(&trace_types_lock);
8933 __update_tracer_options(tr);
8934 mutex_unlock(&trace_types_lock);
8937 /* Must have trace_types_lock held */
8938 struct trace_array *trace_array_find(const char *instance)
8940 struct trace_array *tr, *found = NULL;
8942 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
8943 if (tr->name && strcmp(tr->name, instance) == 0) {
8952 struct trace_array *trace_array_find_get(const char *instance)
8954 struct trace_array *tr;
8956 mutex_lock(&trace_types_lock);
8957 tr = trace_array_find(instance);
8960 mutex_unlock(&trace_types_lock);
8965 static int trace_array_create_dir(struct trace_array *tr)
8969 tr->dir = tracefs_create_dir(tr->name, trace_instance_dir);
8973 ret = event_trace_add_tracer(tr->dir, tr);
8975 tracefs_remove(tr->dir);
8977 init_tracer_tracefs(tr, tr->dir);
8978 __update_tracer_options(tr);
8983 static struct trace_array *trace_array_create(const char *name)
8985 struct trace_array *tr;
8989 tr = kzalloc(sizeof(*tr), GFP_KERNEL);
8991 return ERR_PTR(ret);
8993 tr->name = kstrdup(name, GFP_KERNEL);
8997 if (!alloc_cpumask_var(&tr->tracing_cpumask, GFP_KERNEL))
9000 tr->trace_flags = global_trace.trace_flags & ~ZEROED_TRACE_FLAGS;
9002 cpumask_copy(tr->tracing_cpumask, cpu_all_mask);
9004 raw_spin_lock_init(&tr->start_lock);
9006 tr->max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
9008 tr->current_trace = &nop_trace;
9010 INIT_LIST_HEAD(&tr->systems);
9011 INIT_LIST_HEAD(&tr->events);
9012 INIT_LIST_HEAD(&tr->hist_vars);
9013 INIT_LIST_HEAD(&tr->err_log);
9015 if (allocate_trace_buffers(tr, trace_buf_size) < 0)
9018 if (ftrace_allocate_ftrace_ops(tr) < 0)
9021 ftrace_init_trace_array(tr);
9023 init_trace_flags_index(tr);
9025 if (trace_instance_dir) {
9026 ret = trace_array_create_dir(tr);
9030 __trace_early_add_events(tr);
9032 list_add(&tr->list, &ftrace_trace_arrays);
9039 ftrace_free_ftrace_ops(tr);
9040 free_trace_buffers(tr);
9041 free_cpumask_var(tr->tracing_cpumask);
9045 return ERR_PTR(ret);
9048 static int instance_mkdir(const char *name)
9050 struct trace_array *tr;
9053 mutex_lock(&event_mutex);
9054 mutex_lock(&trace_types_lock);
9057 if (trace_array_find(name))
9060 tr = trace_array_create(name);
9062 ret = PTR_ERR_OR_ZERO(tr);
9065 mutex_unlock(&trace_types_lock);
9066 mutex_unlock(&event_mutex);
9071 * trace_array_get_by_name - Create/Lookup a trace array, given its name.
9072 * @name: The name of the trace array to be looked up/created.
9074 * Returns pointer to trace array with given name.
9075 * NULL, if it cannot be created.
9077 * NOTE: This function increments the reference counter associated with the
9078 * trace array returned. This makes sure it cannot be freed while in use.
9079 * Use trace_array_put() once the trace array is no longer needed.
9080 * If the trace_array is to be freed, trace_array_destroy() needs to
9081 * be called after the trace_array_put(), or simply let user space delete
9082 * it from the tracefs instances directory. But until the
9083 * trace_array_put() is called, user space can not delete it.
9086 struct trace_array *trace_array_get_by_name(const char *name)
9088 struct trace_array *tr;
9090 mutex_lock(&event_mutex);
9091 mutex_lock(&trace_types_lock);
9093 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9094 if (tr->name && strcmp(tr->name, name) == 0)
9098 tr = trace_array_create(name);
9106 mutex_unlock(&trace_types_lock);
9107 mutex_unlock(&event_mutex);
9110 EXPORT_SYMBOL_GPL(trace_array_get_by_name);
9112 static int __remove_instance(struct trace_array *tr)
9116 /* Reference counter for a newly created trace array = 1. */
9117 if (tr->ref > 1 || (tr->current_trace && tr->trace_ref))
9120 list_del(&tr->list);
9122 /* Disable all the flags that were enabled coming in */
9123 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++) {
9124 if ((1 << i) & ZEROED_TRACE_FLAGS)
9125 set_tracer_flag(tr, 1 << i, 0);
9128 tracing_set_nop(tr);
9129 clear_ftrace_function_probes(tr);
9130 event_trace_del_tracer(tr);
9131 ftrace_clear_pids(tr);
9132 ftrace_destroy_function_files(tr);
9133 tracefs_remove(tr->dir);
9134 free_percpu(tr->last_func_repeats);
9135 free_trace_buffers(tr);
9137 for (i = 0; i < tr->nr_topts; i++) {
9138 kfree(tr->topts[i].topts);
9142 free_cpumask_var(tr->tracing_cpumask);
9149 int trace_array_destroy(struct trace_array *this_tr)
9151 struct trace_array *tr;
9157 mutex_lock(&event_mutex);
9158 mutex_lock(&trace_types_lock);
9162 /* Making sure trace array exists before destroying it. */
9163 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9164 if (tr == this_tr) {
9165 ret = __remove_instance(tr);
9170 mutex_unlock(&trace_types_lock);
9171 mutex_unlock(&event_mutex);
9175 EXPORT_SYMBOL_GPL(trace_array_destroy);
9177 static int instance_rmdir(const char *name)
9179 struct trace_array *tr;
9182 mutex_lock(&event_mutex);
9183 mutex_lock(&trace_types_lock);
9186 tr = trace_array_find(name);
9188 ret = __remove_instance(tr);
9190 mutex_unlock(&trace_types_lock);
9191 mutex_unlock(&event_mutex);
9196 static __init void create_trace_instances(struct dentry *d_tracer)
9198 struct trace_array *tr;
9200 trace_instance_dir = tracefs_create_instance_dir("instances", d_tracer,
9203 if (MEM_FAIL(!trace_instance_dir, "Failed to create instances directory\n"))
9206 mutex_lock(&event_mutex);
9207 mutex_lock(&trace_types_lock);
9209 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
9212 if (MEM_FAIL(trace_array_create_dir(tr) < 0,
9213 "Failed to create instance directory\n"))
9217 mutex_unlock(&trace_types_lock);
9218 mutex_unlock(&event_mutex);
9222 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer)
9224 struct trace_event_file *file;
9227 trace_create_file("available_tracers", 0444, d_tracer,
9228 tr, &show_traces_fops);
9230 trace_create_file("current_tracer", 0644, d_tracer,
9231 tr, &set_tracer_fops);
9233 trace_create_file("tracing_cpumask", 0644, d_tracer,
9234 tr, &tracing_cpumask_fops);
9236 trace_create_file("trace_options", 0644, d_tracer,
9237 tr, &tracing_iter_fops);
9239 trace_create_file("trace", 0644, d_tracer,
9242 trace_create_file("trace_pipe", 0444, d_tracer,
9243 tr, &tracing_pipe_fops);
9245 trace_create_file("buffer_size_kb", 0644, d_tracer,
9246 tr, &tracing_entries_fops);
9248 trace_create_file("buffer_total_size_kb", 0444, d_tracer,
9249 tr, &tracing_total_entries_fops);
9251 trace_create_file("free_buffer", 0200, d_tracer,
9252 tr, &tracing_free_buffer_fops);
9254 trace_create_file("trace_marker", 0220, d_tracer,
9255 tr, &tracing_mark_fops);
9257 file = __find_event_file(tr, "ftrace", "print");
9258 if (file && file->dir)
9259 trace_create_file("trigger", 0644, file->dir, file,
9260 &event_trigger_fops);
9261 tr->trace_marker_file = file;
9263 trace_create_file("trace_marker_raw", 0220, d_tracer,
9264 tr, &tracing_mark_raw_fops);
9266 trace_create_file("trace_clock", 0644, d_tracer, tr,
9269 trace_create_file("tracing_on", 0644, d_tracer,
9270 tr, &rb_simple_fops);
9272 trace_create_file("timestamp_mode", 0444, d_tracer, tr,
9273 &trace_time_stamp_mode_fops);
9275 tr->buffer_percent = 50;
9277 trace_create_file("buffer_percent", 0444, d_tracer,
9278 tr, &buffer_percent_fops);
9280 create_trace_options_dir(tr);
9282 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
9283 trace_create_maxlat_file(tr, d_tracer);
9286 if (ftrace_create_function_files(tr, d_tracer))
9287 MEM_FAIL(1, "Could not allocate function filter files");
9289 #ifdef CONFIG_TRACER_SNAPSHOT
9290 trace_create_file("snapshot", 0644, d_tracer,
9291 tr, &snapshot_fops);
9294 trace_create_file("error_log", 0644, d_tracer,
9295 tr, &tracing_err_log_fops);
9297 for_each_tracing_cpu(cpu)
9298 tracing_init_tracefs_percpu(tr, cpu);
9300 ftrace_init_tracefs(tr, d_tracer);
9303 static struct vfsmount *trace_automount(struct dentry *mntpt, void *ingore)
9305 struct vfsmount *mnt;
9306 struct file_system_type *type;
9309 * To maintain backward compatibility for tools that mount
9310 * debugfs to get to the tracing facility, tracefs is automatically
9311 * mounted to the debugfs/tracing directory.
9313 type = get_fs_type("tracefs");
9316 mnt = vfs_submount(mntpt, type, "tracefs", NULL);
9317 put_filesystem(type);
9326 * tracing_init_dentry - initialize top level trace array
9328 * This is called when creating files or directories in the tracing
9329 * directory. It is called via fs_initcall() by any of the boot up code
9330 * and expects to return the dentry of the top level tracing directory.
9332 int tracing_init_dentry(void)
9334 struct trace_array *tr = &global_trace;
9336 if (security_locked_down(LOCKDOWN_TRACEFS)) {
9337 pr_warn("Tracing disabled due to lockdown\n");
9341 /* The top level trace array uses NULL as parent */
9345 if (WARN_ON(!tracefs_initialized()))
9349 * As there may still be users that expect the tracing
9350 * files to exist in debugfs/tracing, we must automount
9351 * the tracefs file system there, so older tools still
9352 * work with the newer kernel.
9354 tr->dir = debugfs_create_automount("tracing", NULL,
9355 trace_automount, NULL);
9360 extern struct trace_eval_map *__start_ftrace_eval_maps[];
9361 extern struct trace_eval_map *__stop_ftrace_eval_maps[];
9363 static struct workqueue_struct *eval_map_wq __initdata;
9364 static struct work_struct eval_map_work __initdata;
9366 static void __init eval_map_work_func(struct work_struct *work)
9370 len = __stop_ftrace_eval_maps - __start_ftrace_eval_maps;
9371 trace_insert_eval_map(NULL, __start_ftrace_eval_maps, len);
9374 static int __init trace_eval_init(void)
9376 INIT_WORK(&eval_map_work, eval_map_work_func);
9378 eval_map_wq = alloc_workqueue("eval_map_wq", WQ_UNBOUND, 0);
9380 pr_err("Unable to allocate eval_map_wq\n");
9382 eval_map_work_func(&eval_map_work);
9386 queue_work(eval_map_wq, &eval_map_work);
9390 static int __init trace_eval_sync(void)
9392 /* Make sure the eval map updates are finished */
9394 destroy_workqueue(eval_map_wq);
9398 late_initcall_sync(trace_eval_sync);
9401 #ifdef CONFIG_MODULES
9402 static void trace_module_add_evals(struct module *mod)
9404 if (!mod->num_trace_evals)
9408 * Modules with bad taint do not have events created, do
9409 * not bother with enums either.
9411 if (trace_module_has_bad_taint(mod))
9414 trace_insert_eval_map(mod, mod->trace_evals, mod->num_trace_evals);
9417 #ifdef CONFIG_TRACE_EVAL_MAP_FILE
9418 static void trace_module_remove_evals(struct module *mod)
9420 union trace_eval_map_item *map;
9421 union trace_eval_map_item **last = &trace_eval_maps;
9423 if (!mod->num_trace_evals)
9426 mutex_lock(&trace_eval_mutex);
9428 map = trace_eval_maps;
9431 if (map->head.mod == mod)
9433 map = trace_eval_jmp_to_tail(map);
9434 last = &map->tail.next;
9435 map = map->tail.next;
9440 *last = trace_eval_jmp_to_tail(map)->tail.next;
9443 mutex_unlock(&trace_eval_mutex);
9446 static inline void trace_module_remove_evals(struct module *mod) { }
9447 #endif /* CONFIG_TRACE_EVAL_MAP_FILE */
9449 static int trace_module_notify(struct notifier_block *self,
9450 unsigned long val, void *data)
9452 struct module *mod = data;
9455 case MODULE_STATE_COMING:
9456 trace_module_add_evals(mod);
9458 case MODULE_STATE_GOING:
9459 trace_module_remove_evals(mod);
9466 static struct notifier_block trace_module_nb = {
9467 .notifier_call = trace_module_notify,
9470 #endif /* CONFIG_MODULES */
9472 static __init int tracer_init_tracefs(void)
9476 trace_access_lock_init();
9478 ret = tracing_init_dentry();
9484 init_tracer_tracefs(&global_trace, NULL);
9485 ftrace_init_tracefs_toplevel(&global_trace, NULL);
9487 trace_create_file("tracing_thresh", 0644, NULL,
9488 &global_trace, &tracing_thresh_fops);
9490 trace_create_file("README", 0444, NULL,
9491 NULL, &tracing_readme_fops);
9493 trace_create_file("saved_cmdlines", 0444, NULL,
9494 NULL, &tracing_saved_cmdlines_fops);
9496 trace_create_file("saved_cmdlines_size", 0644, NULL,
9497 NULL, &tracing_saved_cmdlines_size_fops);
9499 trace_create_file("saved_tgids", 0444, NULL,
9500 NULL, &tracing_saved_tgids_fops);
9504 trace_create_eval_file(NULL);
9506 #ifdef CONFIG_MODULES
9507 register_module_notifier(&trace_module_nb);
9510 #ifdef CONFIG_DYNAMIC_FTRACE
9511 trace_create_file("dyn_ftrace_total_info", 0444, NULL,
9512 NULL, &tracing_dyn_info_fops);
9515 create_trace_instances(NULL);
9517 update_tracer_options(&global_trace);
9522 static int trace_panic_handler(struct notifier_block *this,
9523 unsigned long event, void *unused)
9525 if (ftrace_dump_on_oops)
9526 ftrace_dump(ftrace_dump_on_oops);
9530 static struct notifier_block trace_panic_notifier = {
9531 .notifier_call = trace_panic_handler,
9533 .priority = 150 /* priority: INT_MAX >= x >= 0 */
9536 static int trace_die_handler(struct notifier_block *self,
9542 if (ftrace_dump_on_oops)
9543 ftrace_dump(ftrace_dump_on_oops);
9551 static struct notifier_block trace_die_notifier = {
9552 .notifier_call = trace_die_handler,
9557 * printk is set to max of 1024, we really don't need it that big.
9558 * Nothing should be printing 1000 characters anyway.
9560 #define TRACE_MAX_PRINT 1000
9563 * Define here KERN_TRACE so that we have one place to modify
9564 * it if we decide to change what log level the ftrace dump
9567 #define KERN_TRACE KERN_EMERG
9570 trace_printk_seq(struct trace_seq *s)
9572 /* Probably should print a warning here. */
9573 if (s->seq.len >= TRACE_MAX_PRINT)
9574 s->seq.len = TRACE_MAX_PRINT;
9577 * More paranoid code. Although the buffer size is set to
9578 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
9579 * an extra layer of protection.
9581 if (WARN_ON_ONCE(s->seq.len >= s->seq.size))
9582 s->seq.len = s->seq.size - 1;
9584 /* should be zero ended, but we are paranoid. */
9585 s->buffer[s->seq.len] = 0;
9587 printk(KERN_TRACE "%s", s->buffer);
9592 void trace_init_global_iter(struct trace_iterator *iter)
9594 iter->tr = &global_trace;
9595 iter->trace = iter->tr->current_trace;
9596 iter->cpu_file = RING_BUFFER_ALL_CPUS;
9597 iter->array_buffer = &global_trace.array_buffer;
9599 if (iter->trace && iter->trace->open)
9600 iter->trace->open(iter);
9602 /* Annotate start of buffers if we had overruns */
9603 if (ring_buffer_overruns(iter->array_buffer->buffer))
9604 iter->iter_flags |= TRACE_FILE_ANNOTATE;
9606 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
9607 if (trace_clocks[iter->tr->clock_id].in_ns)
9608 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
9611 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode)
9613 /* use static because iter can be a bit big for the stack */
9614 static struct trace_iterator iter;
9615 static atomic_t dump_running;
9616 struct trace_array *tr = &global_trace;
9617 unsigned int old_userobj;
9618 unsigned long flags;
9621 /* Only allow one dump user at a time. */
9622 if (atomic_inc_return(&dump_running) != 1) {
9623 atomic_dec(&dump_running);
9628 * Always turn off tracing when we dump.
9629 * We don't need to show trace output of what happens
9630 * between multiple crashes.
9632 * If the user does a sysrq-z, then they can re-enable
9633 * tracing with echo 1 > tracing_on.
9637 local_irq_save(flags);
9638 printk_nmi_direct_enter();
9640 /* Simulate the iterator */
9641 trace_init_global_iter(&iter);
9642 /* Can not use kmalloc for iter.temp and iter.fmt */
9643 iter.temp = static_temp_buf;
9644 iter.temp_size = STATIC_TEMP_BUF_SIZE;
9645 iter.fmt = static_fmt_buf;
9646 iter.fmt_size = STATIC_FMT_BUF_SIZE;
9648 for_each_tracing_cpu(cpu) {
9649 atomic_inc(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
9652 old_userobj = tr->trace_flags & TRACE_ITER_SYM_USEROBJ;
9654 /* don't look at user memory in panic mode */
9655 tr->trace_flags &= ~TRACE_ITER_SYM_USEROBJ;
9657 switch (oops_dump_mode) {
9659 iter.cpu_file = RING_BUFFER_ALL_CPUS;
9662 iter.cpu_file = raw_smp_processor_id();
9667 printk(KERN_TRACE "Bad dumping mode, switching to all CPUs dump\n");
9668 iter.cpu_file = RING_BUFFER_ALL_CPUS;
9671 printk(KERN_TRACE "Dumping ftrace buffer:\n");
9673 /* Did function tracer already get disabled? */
9674 if (ftrace_is_dead()) {
9675 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
9676 printk("# MAY BE MISSING FUNCTION EVENTS\n");
9680 * We need to stop all tracing on all CPUS to read
9681 * the next buffer. This is a bit expensive, but is
9682 * not done often. We fill all what we can read,
9683 * and then release the locks again.
9686 while (!trace_empty(&iter)) {
9689 printk(KERN_TRACE "---------------------------------\n");
9693 trace_iterator_reset(&iter);
9694 iter.iter_flags |= TRACE_FILE_LAT_FMT;
9696 if (trace_find_next_entry_inc(&iter) != NULL) {
9699 ret = print_trace_line(&iter);
9700 if (ret != TRACE_TYPE_NO_CONSUME)
9701 trace_consume(&iter);
9703 touch_nmi_watchdog();
9705 trace_printk_seq(&iter.seq);
9709 printk(KERN_TRACE " (ftrace buffer empty)\n");
9711 printk(KERN_TRACE "---------------------------------\n");
9714 tr->trace_flags |= old_userobj;
9716 for_each_tracing_cpu(cpu) {
9717 atomic_dec(&per_cpu_ptr(iter.array_buffer->data, cpu)->disabled);
9719 atomic_dec(&dump_running);
9720 printk_nmi_direct_exit();
9721 local_irq_restore(flags);
9723 EXPORT_SYMBOL_GPL(ftrace_dump);
9725 #define WRITE_BUFSIZE 4096
9727 ssize_t trace_parse_run_command(struct file *file, const char __user *buffer,
9728 size_t count, loff_t *ppos,
9729 int (*createfn)(const char *))
9731 char *kbuf, *buf, *tmp;
9736 kbuf = kmalloc(WRITE_BUFSIZE, GFP_KERNEL);
9740 while (done < count) {
9741 size = count - done;
9743 if (size >= WRITE_BUFSIZE)
9744 size = WRITE_BUFSIZE - 1;
9746 if (copy_from_user(kbuf, buffer + done, size)) {
9753 tmp = strchr(buf, '\n');
9756 size = tmp - buf + 1;
9759 if (done + size < count) {
9762 /* This can accept WRITE_BUFSIZE - 2 ('\n' + '\0') */
9763 pr_warn("Line length is too long: Should be less than %d\n",
9771 /* Remove comments */
9772 tmp = strchr(buf, '#');
9777 ret = createfn(buf);
9782 } while (done < count);
9792 __init static int tracer_alloc_buffers(void)
9798 if (security_locked_down(LOCKDOWN_TRACEFS)) {
9799 pr_warn("Tracing disabled due to lockdown\n");
9804 * Make sure we don't accidentally add more trace options
9805 * than we have bits for.
9807 BUILD_BUG_ON(TRACE_ITER_LAST_BIT > TRACE_FLAGS_MAX_SIZE);
9809 if (!alloc_cpumask_var(&tracing_buffer_mask, GFP_KERNEL))
9812 if (!alloc_cpumask_var(&global_trace.tracing_cpumask, GFP_KERNEL))
9813 goto out_free_buffer_mask;
9815 /* Only allocate trace_printk buffers if a trace_printk exists */
9816 if (&__stop___trace_bprintk_fmt != &__start___trace_bprintk_fmt)
9817 /* Must be called before global_trace.buffer is allocated */
9818 trace_printk_init_buffers();
9820 /* To save memory, keep the ring buffer size to its minimum */
9821 if (ring_buffer_expanded)
9822 ring_buf_size = trace_buf_size;
9826 cpumask_copy(tracing_buffer_mask, cpu_possible_mask);
9827 cpumask_copy(global_trace.tracing_cpumask, cpu_all_mask);
9829 raw_spin_lock_init(&global_trace.start_lock);
9832 * The prepare callbacks allocates some memory for the ring buffer. We
9833 * don't free the buffer if the CPU goes down. If we were to free
9834 * the buffer, then the user would lose any trace that was in the
9835 * buffer. The memory will be removed once the "instance" is removed.
9837 ret = cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE,
9838 "trace/RB:preapre", trace_rb_cpu_prepare,
9841 goto out_free_cpumask;
9842 /* Used for event triggers */
9844 temp_buffer = ring_buffer_alloc(PAGE_SIZE, RB_FL_OVERWRITE);
9846 goto out_rm_hp_state;
9848 if (trace_create_savedcmd() < 0)
9849 goto out_free_temp_buffer;
9851 /* TODO: make the number of buffers hot pluggable with CPUS */
9852 if (allocate_trace_buffers(&global_trace, ring_buf_size) < 0) {
9853 MEM_FAIL(1, "tracer: failed to allocate ring buffer!\n");
9854 goto out_free_savedcmd;
9857 if (global_trace.buffer_disabled)
9860 if (trace_boot_clock) {
9861 ret = tracing_set_clock(&global_trace, trace_boot_clock);
9863 pr_warn("Trace clock %s not defined, going back to default\n",
9868 * register_tracer() might reference current_trace, so it
9869 * needs to be set before we register anything. This is
9870 * just a bootstrap of current_trace anyway.
9872 global_trace.current_trace = &nop_trace;
9874 global_trace.max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
9876 ftrace_init_global_array_ops(&global_trace);
9878 init_trace_flags_index(&global_trace);
9880 register_tracer(&nop_trace);
9882 /* Function tracing may start here (via kernel command line) */
9883 init_function_trace();
9885 /* All seems OK, enable tracing */
9886 tracing_disabled = 0;
9888 atomic_notifier_chain_register(&panic_notifier_list,
9889 &trace_panic_notifier);
9891 register_die_notifier(&trace_die_notifier);
9893 global_trace.flags = TRACE_ARRAY_FL_GLOBAL;
9895 INIT_LIST_HEAD(&global_trace.systems);
9896 INIT_LIST_HEAD(&global_trace.events);
9897 INIT_LIST_HEAD(&global_trace.hist_vars);
9898 INIT_LIST_HEAD(&global_trace.err_log);
9899 list_add(&global_trace.list, &ftrace_trace_arrays);
9901 apply_trace_boot_options();
9903 register_snapshot_cmd();
9910 free_saved_cmdlines_buffer(savedcmd);
9911 out_free_temp_buffer:
9912 ring_buffer_free(temp_buffer);
9914 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE);
9916 free_cpumask_var(global_trace.tracing_cpumask);
9917 out_free_buffer_mask:
9918 free_cpumask_var(tracing_buffer_mask);
9923 void __init early_trace_init(void)
9925 if (tracepoint_printk) {
9926 tracepoint_print_iter =
9927 kzalloc(sizeof(*tracepoint_print_iter), GFP_KERNEL);
9928 if (MEM_FAIL(!tracepoint_print_iter,
9929 "Failed to allocate trace iterator\n"))
9930 tracepoint_printk = 0;
9932 static_key_enable(&tracepoint_printk_key.key);
9934 tracer_alloc_buffers();
9937 void __init trace_init(void)
9942 __init static int clear_boot_tracer(void)
9945 * The default tracer at boot buffer is an init section.
9946 * This function is called in lateinit. If we did not
9947 * find the boot tracer, then clear it out, to prevent
9948 * later registration from accessing the buffer that is
9949 * about to be freed.
9951 if (!default_bootup_tracer)
9954 printk(KERN_INFO "ftrace bootup tracer '%s' not registered.\n",
9955 default_bootup_tracer);
9956 default_bootup_tracer = NULL;
9961 fs_initcall(tracer_init_tracefs);
9962 late_initcall_sync(clear_boot_tracer);
9964 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
9965 __init static int tracing_set_default_clock(void)
9967 /* sched_clock_stable() is determined in late_initcall */
9968 if (!trace_boot_clock && !sched_clock_stable()) {
9969 if (security_locked_down(LOCKDOWN_TRACEFS)) {
9970 pr_warn("Can not set tracing clock due to lockdown\n");
9975 "Unstable clock detected, switching default tracing clock to \"global\"\n"
9976 "If you want to keep using the local clock, then add:\n"
9977 " \"trace_clock=local\"\n"
9978 "on the kernel command line\n");
9979 tracing_set_clock(&global_trace, "global");
9984 late_initcall_sync(tracing_set_default_clock);