2 * ring buffer based function tracer
7 * Originally taken from the RT patch by:
10 * Based on code from the latency_tracer, that is:
11 * Copyright (C) 2004-2006 Ingo Molnar
12 * Copyright (C) 2004 Nadia Yvette Chambers
14 #include <linux/ring_buffer.h>
15 #include <generated/utsrelease.h>
16 #include <linux/stacktrace.h>
17 #include <linux/writeback.h>
18 #include <linux/kallsyms.h>
19 #include <linux/seq_file.h>
20 #include <linux/notifier.h>
21 #include <linux/irqflags.h>
22 #include <linux/debugfs.h>
23 #include <linux/tracefs.h>
24 #include <linux/pagemap.h>
25 #include <linux/hardirq.h>
26 #include <linux/linkage.h>
27 #include <linux/uaccess.h>
28 #include <linux/vmalloc.h>
29 #include <linux/ftrace.h>
30 #include <linux/module.h>
31 #include <linux/percpu.h>
32 #include <linux/splice.h>
33 #include <linux/kdebug.h>
34 #include <linux/string.h>
35 #include <linux/mount.h>
36 #include <linux/rwsem.h>
37 #include <linux/slab.h>
38 #include <linux/ctype.h>
39 #include <linux/init.h>
40 #include <linux/poll.h>
41 #include <linux/nmi.h>
43 #include <linux/trace.h>
44 #include <linux/sched/rt.h>
47 #include "trace_output.h"
50 * On boot up, the ring buffer is set to the minimum size, so that
51 * we do not waste memory on systems that are not using tracing.
53 bool ring_buffer_expanded;
56 * We need to change this state when a selftest is running.
57 * A selftest will lurk into the ring-buffer to count the
58 * entries inserted during the selftest although some concurrent
59 * insertions into the ring-buffer such as trace_printk could occurred
60 * at the same time, giving false positive or negative results.
62 static bool __read_mostly tracing_selftest_running;
65 * If a tracer is running, we do not want to run SELFTEST.
67 bool __read_mostly tracing_selftest_disabled;
69 /* Pipe tracepoints to printk */
70 struct trace_iterator *tracepoint_print_iter;
71 int tracepoint_printk;
72 static DEFINE_STATIC_KEY_FALSE(tracepoint_printk_key);
74 /* For tracers that don't implement custom flags */
75 static struct tracer_opt dummy_tracer_opt[] = {
80 dummy_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
86 * To prevent the comm cache from being overwritten when no
87 * tracing is active, only save the comm when a trace event
90 static DEFINE_PER_CPU(bool, trace_cmdline_save);
93 * Kill all tracing for good (never come back).
94 * It is initialized to 1 but will turn to zero if the initialization
95 * of the tracer is successful. But that is the only place that sets
98 static int tracing_disabled = 1;
100 cpumask_var_t __read_mostly tracing_buffer_mask;
103 * ftrace_dump_on_oops - variable to dump ftrace buffer on oops
105 * If there is an oops (or kernel panic) and the ftrace_dump_on_oops
106 * is set, then ftrace_dump is called. This will output the contents
107 * of the ftrace buffers to the console. This is very useful for
108 * capturing traces that lead to crashes and outputing it to a
111 * It is default off, but you can enable it with either specifying
112 * "ftrace_dump_on_oops" in the kernel command line, or setting
113 * /proc/sys/kernel/ftrace_dump_on_oops
114 * Set 1 if you want to dump buffers of all CPUs
115 * Set 2 if you want to dump the buffer of the CPU that triggered oops
118 enum ftrace_dump_mode ftrace_dump_on_oops;
120 /* When set, tracing will stop when a WARN*() is hit */
121 int __disable_trace_on_warning;
123 #ifdef CONFIG_TRACE_ENUM_MAP_FILE
124 /* Map of enums to their values, for "enum_map" file */
125 struct trace_enum_map_head {
127 unsigned long length;
130 union trace_enum_map_item;
132 struct trace_enum_map_tail {
134 * "end" is first and points to NULL as it must be different
135 * than "mod" or "enum_string"
137 union trace_enum_map_item *next;
138 const char *end; /* points to NULL */
141 static DEFINE_MUTEX(trace_enum_mutex);
144 * The trace_enum_maps are saved in an array with two extra elements,
145 * one at the beginning, and one at the end. The beginning item contains
146 * the count of the saved maps (head.length), and the module they
147 * belong to if not built in (head.mod). The ending item contains a
148 * pointer to the next array of saved enum_map items.
150 union trace_enum_map_item {
151 struct trace_enum_map map;
152 struct trace_enum_map_head head;
153 struct trace_enum_map_tail tail;
156 static union trace_enum_map_item *trace_enum_maps;
157 #endif /* CONFIG_TRACE_ENUM_MAP_FILE */
159 static int tracing_set_tracer(struct trace_array *tr, const char *buf);
161 #define MAX_TRACER_SIZE 100
162 static char bootup_tracer_buf[MAX_TRACER_SIZE] __initdata;
163 static char *default_bootup_tracer;
165 static bool allocate_snapshot;
167 static int __init set_cmdline_ftrace(char *str)
169 strlcpy(bootup_tracer_buf, str, MAX_TRACER_SIZE);
170 default_bootup_tracer = bootup_tracer_buf;
171 /* We are using ftrace early, expand it */
172 ring_buffer_expanded = true;
175 __setup("ftrace=", set_cmdline_ftrace);
177 static int __init set_ftrace_dump_on_oops(char *str)
179 if (*str++ != '=' || !*str) {
180 ftrace_dump_on_oops = DUMP_ALL;
184 if (!strcmp("orig_cpu", str)) {
185 ftrace_dump_on_oops = DUMP_ORIG;
191 __setup("ftrace_dump_on_oops", set_ftrace_dump_on_oops);
193 static int __init stop_trace_on_warning(char *str)
195 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
196 __disable_trace_on_warning = 1;
199 __setup("traceoff_on_warning", stop_trace_on_warning);
201 static int __init boot_alloc_snapshot(char *str)
203 allocate_snapshot = true;
204 /* We also need the main ring buffer expanded */
205 ring_buffer_expanded = true;
208 __setup("alloc_snapshot", boot_alloc_snapshot);
211 static char trace_boot_options_buf[MAX_TRACER_SIZE] __initdata;
213 static int __init set_trace_boot_options(char *str)
215 strlcpy(trace_boot_options_buf, str, MAX_TRACER_SIZE);
218 __setup("trace_options=", set_trace_boot_options);
220 static char trace_boot_clock_buf[MAX_TRACER_SIZE] __initdata;
221 static char *trace_boot_clock __initdata;
223 static int __init set_trace_boot_clock(char *str)
225 strlcpy(trace_boot_clock_buf, str, MAX_TRACER_SIZE);
226 trace_boot_clock = trace_boot_clock_buf;
229 __setup("trace_clock=", set_trace_boot_clock);
231 static int __init set_tracepoint_printk(char *str)
233 if ((strcmp(str, "=0") != 0 && strcmp(str, "=off") != 0))
234 tracepoint_printk = 1;
237 __setup("tp_printk", set_tracepoint_printk);
239 unsigned long long ns2usecs(u64 nsec)
246 /* trace_flags holds trace_options default values */
247 #define TRACE_DEFAULT_FLAGS \
248 (FUNCTION_DEFAULT_FLAGS | \
249 TRACE_ITER_PRINT_PARENT | TRACE_ITER_PRINTK | \
250 TRACE_ITER_ANNOTATE | TRACE_ITER_CONTEXT_INFO | \
251 TRACE_ITER_RECORD_CMD | TRACE_ITER_OVERWRITE | \
252 TRACE_ITER_IRQ_INFO | TRACE_ITER_MARKERS)
254 /* trace_options that are only supported by global_trace */
255 #define TOP_LEVEL_TRACE_FLAGS (TRACE_ITER_PRINTK | \
256 TRACE_ITER_PRINTK_MSGONLY | TRACE_ITER_RECORD_CMD)
258 /* trace_flags that are default zero for instances */
259 #define ZEROED_TRACE_FLAGS \
260 (TRACE_ITER_EVENT_FORK | TRACE_ITER_FUNC_FORK)
263 * The global_trace is the descriptor that holds the top-level tracing
264 * buffers for the live tracing.
266 static struct trace_array global_trace = {
267 .trace_flags = TRACE_DEFAULT_FLAGS,
270 LIST_HEAD(ftrace_trace_arrays);
272 int trace_array_get(struct trace_array *this_tr)
274 struct trace_array *tr;
277 mutex_lock(&trace_types_lock);
278 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
285 mutex_unlock(&trace_types_lock);
290 static void __trace_array_put(struct trace_array *this_tr)
292 WARN_ON(!this_tr->ref);
296 void trace_array_put(struct trace_array *this_tr)
298 mutex_lock(&trace_types_lock);
299 __trace_array_put(this_tr);
300 mutex_unlock(&trace_types_lock);
303 int call_filter_check_discard(struct trace_event_call *call, void *rec,
304 struct ring_buffer *buffer,
305 struct ring_buffer_event *event)
307 if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
308 !filter_match_preds(call->filter, rec)) {
309 __trace_event_discard_commit(buffer, event);
316 void trace_free_pid_list(struct trace_pid_list *pid_list)
318 vfree(pid_list->pids);
323 * trace_find_filtered_pid - check if a pid exists in a filtered_pid list
324 * @filtered_pids: The list of pids to check
325 * @search_pid: The PID to find in @filtered_pids
327 * Returns true if @search_pid is fonud in @filtered_pids, and false otherwis.
330 trace_find_filtered_pid(struct trace_pid_list *filtered_pids, pid_t search_pid)
333 * If pid_max changed after filtered_pids was created, we
334 * by default ignore all pids greater than the previous pid_max.
336 if (search_pid >= filtered_pids->pid_max)
339 return test_bit(search_pid, filtered_pids->pids);
343 * trace_ignore_this_task - should a task be ignored for tracing
344 * @filtered_pids: The list of pids to check
345 * @task: The task that should be ignored if not filtered
347 * Checks if @task should be traced or not from @filtered_pids.
348 * Returns true if @task should *NOT* be traced.
349 * Returns false if @task should be traced.
352 trace_ignore_this_task(struct trace_pid_list *filtered_pids, struct task_struct *task)
355 * Return false, because if filtered_pids does not exist,
356 * all pids are good to trace.
361 return !trace_find_filtered_pid(filtered_pids, task->pid);
365 * trace_pid_filter_add_remove - Add or remove a task from a pid_list
366 * @pid_list: The list to modify
367 * @self: The current task for fork or NULL for exit
368 * @task: The task to add or remove
370 * If adding a task, if @self is defined, the task is only added if @self
371 * is also included in @pid_list. This happens on fork and tasks should
372 * only be added when the parent is listed. If @self is NULL, then the
373 * @task pid will be removed from the list, which would happen on exit
376 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
377 struct task_struct *self,
378 struct task_struct *task)
383 /* For forks, we only add if the forking task is listed */
385 if (!trace_find_filtered_pid(pid_list, self->pid))
389 /* Sorry, but we don't support pid_max changing after setting */
390 if (task->pid >= pid_list->pid_max)
393 /* "self" is set for forks, and NULL for exits */
395 set_bit(task->pid, pid_list->pids);
397 clear_bit(task->pid, pid_list->pids);
401 * trace_pid_next - Used for seq_file to get to the next pid of a pid_list
402 * @pid_list: The pid list to show
403 * @v: The last pid that was shown (+1 the actual pid to let zero be displayed)
404 * @pos: The position of the file
406 * This is used by the seq_file "next" operation to iterate the pids
407 * listed in a trace_pid_list structure.
409 * Returns the pid+1 as we want to display pid of zero, but NULL would
410 * stop the iteration.
412 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos)
414 unsigned long pid = (unsigned long)v;
418 /* pid already is +1 of the actual prevous bit */
419 pid = find_next_bit(pid_list->pids, pid_list->pid_max, pid);
421 /* Return pid + 1 to allow zero to be represented */
422 if (pid < pid_list->pid_max)
423 return (void *)(pid + 1);
429 * trace_pid_start - Used for seq_file to start reading pid lists
430 * @pid_list: The pid list to show
431 * @pos: The position of the file
433 * This is used by seq_file "start" operation to start the iteration
436 * Returns the pid+1 as we want to display pid of zero, but NULL would
437 * stop the iteration.
439 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos)
444 pid = find_first_bit(pid_list->pids, pid_list->pid_max);
445 if (pid >= pid_list->pid_max)
448 /* Return pid + 1 so that zero can be the exit value */
449 for (pid++; pid && l < *pos;
450 pid = (unsigned long)trace_pid_next(pid_list, (void *)pid, &l))
456 * trace_pid_show - show the current pid in seq_file processing
457 * @m: The seq_file structure to write into
458 * @v: A void pointer of the pid (+1) value to display
460 * Can be directly used by seq_file operations to display the current
463 int trace_pid_show(struct seq_file *m, void *v)
465 unsigned long pid = (unsigned long)v - 1;
467 seq_printf(m, "%lu\n", pid);
471 /* 128 should be much more than enough */
472 #define PID_BUF_SIZE 127
474 int trace_pid_write(struct trace_pid_list *filtered_pids,
475 struct trace_pid_list **new_pid_list,
476 const char __user *ubuf, size_t cnt)
478 struct trace_pid_list *pid_list;
479 struct trace_parser parser;
487 if (trace_parser_get_init(&parser, PID_BUF_SIZE + 1))
491 * Always recreate a new array. The write is an all or nothing
492 * operation. Always create a new array when adding new pids by
493 * the user. If the operation fails, then the current list is
496 pid_list = kmalloc(sizeof(*pid_list), GFP_KERNEL);
500 pid_list->pid_max = READ_ONCE(pid_max);
502 /* Only truncating will shrink pid_max */
503 if (filtered_pids && filtered_pids->pid_max > pid_list->pid_max)
504 pid_list->pid_max = filtered_pids->pid_max;
506 pid_list->pids = vzalloc((pid_list->pid_max + 7) >> 3);
507 if (!pid_list->pids) {
513 /* copy the current bits to the new max */
514 for_each_set_bit(pid, filtered_pids->pids,
515 filtered_pids->pid_max) {
516 set_bit(pid, pid_list->pids);
525 ret = trace_get_user(&parser, ubuf, cnt, &pos);
526 if (ret < 0 || !trace_parser_loaded(&parser))
533 parser.buffer[parser.idx] = 0;
536 if (kstrtoul(parser.buffer, 0, &val))
538 if (val >= pid_list->pid_max)
543 set_bit(pid, pid_list->pids);
546 trace_parser_clear(&parser);
549 trace_parser_put(&parser);
552 trace_free_pid_list(pid_list);
557 /* Cleared the list of pids */
558 trace_free_pid_list(pid_list);
563 *new_pid_list = pid_list;
568 static u64 buffer_ftrace_now(struct trace_buffer *buf, int cpu)
572 /* Early boot up does not have a buffer yet */
574 return trace_clock_local();
576 ts = ring_buffer_time_stamp(buf->buffer, cpu);
577 ring_buffer_normalize_time_stamp(buf->buffer, cpu, &ts);
582 u64 ftrace_now(int cpu)
584 return buffer_ftrace_now(&global_trace.trace_buffer, cpu);
588 * tracing_is_enabled - Show if global_trace has been disabled
590 * Shows if the global trace has been enabled or not. It uses the
591 * mirror flag "buffer_disabled" to be used in fast paths such as for
592 * the irqsoff tracer. But it may be inaccurate due to races. If you
593 * need to know the accurate state, use tracing_is_on() which is a little
594 * slower, but accurate.
596 int tracing_is_enabled(void)
599 * For quick access (irqsoff uses this in fast path), just
600 * return the mirror variable of the state of the ring buffer.
601 * It's a little racy, but we don't really care.
604 return !global_trace.buffer_disabled;
608 * trace_buf_size is the size in bytes that is allocated
609 * for a buffer. Note, the number of bytes is always rounded
612 * This number is purposely set to a low number of 16384.
613 * If the dump on oops happens, it will be much appreciated
614 * to not have to wait for all that output. Anyway this can be
615 * boot time and run time configurable.
617 #define TRACE_BUF_SIZE_DEFAULT 1441792UL /* 16384 * 88 (sizeof(entry)) */
619 static unsigned long trace_buf_size = TRACE_BUF_SIZE_DEFAULT;
621 /* trace_types holds a link list of available tracers. */
622 static struct tracer *trace_types __read_mostly;
625 * trace_types_lock is used to protect the trace_types list.
627 DEFINE_MUTEX(trace_types_lock);
630 * serialize the access of the ring buffer
632 * ring buffer serializes readers, but it is low level protection.
633 * The validity of the events (which returns by ring_buffer_peek() ..etc)
634 * are not protected by ring buffer.
636 * The content of events may become garbage if we allow other process consumes
637 * these events concurrently:
638 * A) the page of the consumed events may become a normal page
639 * (not reader page) in ring buffer, and this page will be rewrited
640 * by events producer.
641 * B) The page of the consumed events may become a page for splice_read,
642 * and this page will be returned to system.
644 * These primitives allow multi process access to different cpu ring buffer
647 * These primitives don't distinguish read-only and read-consume access.
648 * Multi read-only access are also serialized.
652 static DECLARE_RWSEM(all_cpu_access_lock);
653 static DEFINE_PER_CPU(struct mutex, cpu_access_lock);
655 static inline void trace_access_lock(int cpu)
657 if (cpu == RING_BUFFER_ALL_CPUS) {
658 /* gain it for accessing the whole ring buffer. */
659 down_write(&all_cpu_access_lock);
661 /* gain it for accessing a cpu ring buffer. */
663 /* Firstly block other trace_access_lock(RING_BUFFER_ALL_CPUS). */
664 down_read(&all_cpu_access_lock);
666 /* Secondly block other access to this @cpu ring buffer. */
667 mutex_lock(&per_cpu(cpu_access_lock, cpu));
671 static inline void trace_access_unlock(int cpu)
673 if (cpu == RING_BUFFER_ALL_CPUS) {
674 up_write(&all_cpu_access_lock);
676 mutex_unlock(&per_cpu(cpu_access_lock, cpu));
677 up_read(&all_cpu_access_lock);
681 static inline void trace_access_lock_init(void)
685 for_each_possible_cpu(cpu)
686 mutex_init(&per_cpu(cpu_access_lock, cpu));
691 static DEFINE_MUTEX(access_lock);
693 static inline void trace_access_lock(int cpu)
696 mutex_lock(&access_lock);
699 static inline void trace_access_unlock(int cpu)
702 mutex_unlock(&access_lock);
705 static inline void trace_access_lock_init(void)
711 #ifdef CONFIG_STACKTRACE
712 static void __ftrace_trace_stack(struct ring_buffer *buffer,
714 int skip, int pc, struct pt_regs *regs);
715 static inline void ftrace_trace_stack(struct trace_array *tr,
716 struct ring_buffer *buffer,
718 int skip, int pc, struct pt_regs *regs);
721 static inline void __ftrace_trace_stack(struct ring_buffer *buffer,
723 int skip, int pc, struct pt_regs *regs)
726 static inline void ftrace_trace_stack(struct trace_array *tr,
727 struct ring_buffer *buffer,
729 int skip, int pc, struct pt_regs *regs)
735 static __always_inline void
736 trace_event_setup(struct ring_buffer_event *event,
737 int type, unsigned long flags, int pc)
739 struct trace_entry *ent = ring_buffer_event_data(event);
741 tracing_generic_entry_update(ent, flags, pc);
745 static __always_inline struct ring_buffer_event *
746 __trace_buffer_lock_reserve(struct ring_buffer *buffer,
749 unsigned long flags, int pc)
751 struct ring_buffer_event *event;
753 event = ring_buffer_lock_reserve(buffer, len);
755 trace_event_setup(event, type, flags, pc);
760 void tracer_tracing_on(struct trace_array *tr)
762 if (tr->trace_buffer.buffer)
763 ring_buffer_record_on(tr->trace_buffer.buffer);
765 * This flag is looked at when buffers haven't been allocated
766 * yet, or by some tracers (like irqsoff), that just want to
767 * know if the ring buffer has been disabled, but it can handle
768 * races of where it gets disabled but we still do a record.
769 * As the check is in the fast path of the tracers, it is more
770 * important to be fast than accurate.
772 tr->buffer_disabled = 0;
773 /* Make the flag seen by readers */
778 * tracing_on - enable tracing buffers
780 * This function enables tracing buffers that may have been
781 * disabled with tracing_off.
783 void tracing_on(void)
785 tracer_tracing_on(&global_trace);
787 EXPORT_SYMBOL_GPL(tracing_on);
790 static __always_inline void
791 __buffer_unlock_commit(struct ring_buffer *buffer, struct ring_buffer_event *event)
793 __this_cpu_write(trace_cmdline_save, true);
795 /* If this is the temp buffer, we need to commit fully */
796 if (this_cpu_read(trace_buffered_event) == event) {
797 /* Length is in event->array[0] */
798 ring_buffer_write(buffer, event->array[0], &event->array[1]);
799 /* Release the temp buffer */
800 this_cpu_dec(trace_buffered_event_cnt);
802 ring_buffer_unlock_commit(buffer, event);
806 * __trace_puts - write a constant string into the trace buffer.
807 * @ip: The address of the caller
808 * @str: The constant string to write
809 * @size: The size of the string.
811 int __trace_puts(unsigned long ip, const char *str, int size)
813 struct ring_buffer_event *event;
814 struct ring_buffer *buffer;
815 struct print_entry *entry;
816 unsigned long irq_flags;
820 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
823 pc = preempt_count();
825 if (unlikely(tracing_selftest_running || tracing_disabled))
828 alloc = sizeof(*entry) + size + 2; /* possible \n added */
830 local_save_flags(irq_flags);
831 buffer = global_trace.trace_buffer.buffer;
832 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, alloc,
837 entry = ring_buffer_event_data(event);
840 memcpy(&entry->buf, str, size);
842 /* Add a newline if necessary */
843 if (entry->buf[size - 1] != '\n') {
844 entry->buf[size] = '\n';
845 entry->buf[size + 1] = '\0';
847 entry->buf[size] = '\0';
849 __buffer_unlock_commit(buffer, event);
850 ftrace_trace_stack(&global_trace, buffer, irq_flags, 4, pc, NULL);
854 EXPORT_SYMBOL_GPL(__trace_puts);
857 * __trace_bputs - write the pointer to a constant string into trace buffer
858 * @ip: The address of the caller
859 * @str: The constant string to write to the buffer to
861 int __trace_bputs(unsigned long ip, const char *str)
863 struct ring_buffer_event *event;
864 struct ring_buffer *buffer;
865 struct bputs_entry *entry;
866 unsigned long irq_flags;
867 int size = sizeof(struct bputs_entry);
870 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
873 pc = preempt_count();
875 if (unlikely(tracing_selftest_running || tracing_disabled))
878 local_save_flags(irq_flags);
879 buffer = global_trace.trace_buffer.buffer;
880 event = __trace_buffer_lock_reserve(buffer, TRACE_BPUTS, size,
885 entry = ring_buffer_event_data(event);
889 __buffer_unlock_commit(buffer, event);
890 ftrace_trace_stack(&global_trace, buffer, irq_flags, 4, pc, NULL);
894 EXPORT_SYMBOL_GPL(__trace_bputs);
896 #ifdef CONFIG_TRACER_SNAPSHOT
897 static void tracing_snapshot_instance(struct trace_array *tr)
899 struct tracer *tracer = tr->current_trace;
903 internal_trace_puts("*** SNAPSHOT CALLED FROM NMI CONTEXT ***\n");
904 internal_trace_puts("*** snapshot is being ignored ***\n");
908 if (!tr->allocated_snapshot) {
909 internal_trace_puts("*** SNAPSHOT NOT ALLOCATED ***\n");
910 internal_trace_puts("*** stopping trace here! ***\n");
915 /* Note, snapshot can not be used when the tracer uses it */
916 if (tracer->use_max_tr) {
917 internal_trace_puts("*** LATENCY TRACER ACTIVE ***\n");
918 internal_trace_puts("*** Can not use snapshot (sorry) ***\n");
922 local_irq_save(flags);
923 update_max_tr(tr, current, smp_processor_id());
924 local_irq_restore(flags);
928 * trace_snapshot - take a snapshot of the current buffer.
930 * This causes a swap between the snapshot buffer and the current live
931 * tracing buffer. You can use this to take snapshots of the live
932 * trace when some condition is triggered, but continue to trace.
934 * Note, make sure to allocate the snapshot with either
935 * a tracing_snapshot_alloc(), or by doing it manually
936 * with: echo 1 > /sys/kernel/debug/tracing/snapshot
938 * If the snapshot buffer is not allocated, it will stop tracing.
939 * Basically making a permanent snapshot.
941 void tracing_snapshot(void)
943 struct trace_array *tr = &global_trace;
945 tracing_snapshot_instance(tr);
947 EXPORT_SYMBOL_GPL(tracing_snapshot);
949 static int resize_buffer_duplicate_size(struct trace_buffer *trace_buf,
950 struct trace_buffer *size_buf, int cpu_id);
951 static void set_buffer_entries(struct trace_buffer *buf, unsigned long val);
953 static int alloc_snapshot(struct trace_array *tr)
957 if (!tr->allocated_snapshot) {
959 /* allocate spare buffer */
960 ret = resize_buffer_duplicate_size(&tr->max_buffer,
961 &tr->trace_buffer, RING_BUFFER_ALL_CPUS);
965 tr->allocated_snapshot = true;
971 static void free_snapshot(struct trace_array *tr)
974 * We don't free the ring buffer. instead, resize it because
975 * The max_tr ring buffer has some state (e.g. ring->clock) and
976 * we want preserve it.
978 ring_buffer_resize(tr->max_buffer.buffer, 1, RING_BUFFER_ALL_CPUS);
979 set_buffer_entries(&tr->max_buffer, 1);
980 tracing_reset_online_cpus(&tr->max_buffer);
981 tr->allocated_snapshot = false;
985 * tracing_alloc_snapshot - allocate snapshot buffer.
987 * This only allocates the snapshot buffer if it isn't already
988 * allocated - it doesn't also take a snapshot.
990 * This is meant to be used in cases where the snapshot buffer needs
991 * to be set up for events that can't sleep but need to be able to
992 * trigger a snapshot.
994 int tracing_alloc_snapshot(void)
996 struct trace_array *tr = &global_trace;
999 ret = alloc_snapshot(tr);
1004 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1007 * trace_snapshot_alloc - allocate and take a snapshot of the current buffer.
1009 * This is similar to trace_snapshot(), but it will allocate the
1010 * snapshot buffer if it isn't already allocated. Use this only
1011 * where it is safe to sleep, as the allocation may sleep.
1013 * This causes a swap between the snapshot buffer and the current live
1014 * tracing buffer. You can use this to take snapshots of the live
1015 * trace when some condition is triggered, but continue to trace.
1017 void tracing_snapshot_alloc(void)
1021 ret = tracing_alloc_snapshot();
1027 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1029 void tracing_snapshot(void)
1031 WARN_ONCE(1, "Snapshot feature not enabled, but internal snapshot used");
1033 EXPORT_SYMBOL_GPL(tracing_snapshot);
1034 int tracing_alloc_snapshot(void)
1036 WARN_ONCE(1, "Snapshot feature not enabled, but snapshot allocation used");
1039 EXPORT_SYMBOL_GPL(tracing_alloc_snapshot);
1040 void tracing_snapshot_alloc(void)
1045 EXPORT_SYMBOL_GPL(tracing_snapshot_alloc);
1046 #endif /* CONFIG_TRACER_SNAPSHOT */
1048 void tracer_tracing_off(struct trace_array *tr)
1050 if (tr->trace_buffer.buffer)
1051 ring_buffer_record_off(tr->trace_buffer.buffer);
1053 * This flag is looked at when buffers haven't been allocated
1054 * yet, or by some tracers (like irqsoff), that just want to
1055 * know if the ring buffer has been disabled, but it can handle
1056 * races of where it gets disabled but we still do a record.
1057 * As the check is in the fast path of the tracers, it is more
1058 * important to be fast than accurate.
1060 tr->buffer_disabled = 1;
1061 /* Make the flag seen by readers */
1066 * tracing_off - turn off tracing buffers
1068 * This function stops the tracing buffers from recording data.
1069 * It does not disable any overhead the tracers themselves may
1070 * be causing. This function simply causes all recording to
1071 * the ring buffers to fail.
1073 void tracing_off(void)
1075 tracer_tracing_off(&global_trace);
1077 EXPORT_SYMBOL_GPL(tracing_off);
1079 void disable_trace_on_warning(void)
1081 if (__disable_trace_on_warning)
1086 * tracer_tracing_is_on - show real state of ring buffer enabled
1087 * @tr : the trace array to know if ring buffer is enabled
1089 * Shows real state of the ring buffer if it is enabled or not.
1091 int tracer_tracing_is_on(struct trace_array *tr)
1093 if (tr->trace_buffer.buffer)
1094 return ring_buffer_record_is_on(tr->trace_buffer.buffer);
1095 return !tr->buffer_disabled;
1099 * tracing_is_on - show state of ring buffers enabled
1101 int tracing_is_on(void)
1103 return tracer_tracing_is_on(&global_trace);
1105 EXPORT_SYMBOL_GPL(tracing_is_on);
1107 static int __init set_buf_size(char *str)
1109 unsigned long buf_size;
1113 buf_size = memparse(str, &str);
1114 /* nr_entries can not be zero */
1117 trace_buf_size = buf_size;
1120 __setup("trace_buf_size=", set_buf_size);
1122 static int __init set_tracing_thresh(char *str)
1124 unsigned long threshold;
1129 ret = kstrtoul(str, 0, &threshold);
1132 tracing_thresh = threshold * 1000;
1135 __setup("tracing_thresh=", set_tracing_thresh);
1137 unsigned long nsecs_to_usecs(unsigned long nsecs)
1139 return nsecs / 1000;
1143 * TRACE_FLAGS is defined as a tuple matching bit masks with strings.
1144 * It uses C(a, b) where 'a' is the enum name and 'b' is the string that
1145 * matches it. By defining "C(a, b) b", TRACE_FLAGS becomes a list
1146 * of strings in the order that the enums were defined.
1151 /* These must match the bit postions in trace_iterator_flags */
1152 static const char *trace_options[] = {
1160 int in_ns; /* is this clock in nanoseconds? */
1161 } trace_clocks[] = {
1162 { trace_clock_local, "local", 1 },
1163 { trace_clock_global, "global", 1 },
1164 { trace_clock_counter, "counter", 0 },
1165 { trace_clock_jiffies, "uptime", 0 },
1166 { trace_clock, "perf", 1 },
1167 { ktime_get_mono_fast_ns, "mono", 1 },
1168 { ktime_get_raw_fast_ns, "mono_raw", 1 },
1169 { ktime_get_boot_fast_ns, "boot", 1 },
1174 * trace_parser_get_init - gets the buffer for trace parser
1176 int trace_parser_get_init(struct trace_parser *parser, int size)
1178 memset(parser, 0, sizeof(*parser));
1180 parser->buffer = kmalloc(size, GFP_KERNEL);
1181 if (!parser->buffer)
1184 parser->size = size;
1189 * trace_parser_put - frees the buffer for trace parser
1191 void trace_parser_put(struct trace_parser *parser)
1193 kfree(parser->buffer);
1194 parser->buffer = NULL;
1198 * trace_get_user - reads the user input string separated by space
1199 * (matched by isspace(ch))
1201 * For each string found the 'struct trace_parser' is updated,
1202 * and the function returns.
1204 * Returns number of bytes read.
1206 * See kernel/trace/trace.h for 'struct trace_parser' details.
1208 int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1209 size_t cnt, loff_t *ppos)
1216 trace_parser_clear(parser);
1218 ret = get_user(ch, ubuf++);
1226 * The parser is not finished with the last write,
1227 * continue reading the user input without skipping spaces.
1229 if (!parser->cont) {
1230 /* skip white space */
1231 while (cnt && isspace(ch)) {
1232 ret = get_user(ch, ubuf++);
1239 /* only spaces were written */
1249 /* read the non-space input */
1250 while (cnt && !isspace(ch)) {
1251 if (parser->idx < parser->size - 1)
1252 parser->buffer[parser->idx++] = ch;
1257 ret = get_user(ch, ubuf++);
1264 /* We either got finished input or we have to wait for another call. */
1266 parser->buffer[parser->idx] = 0;
1267 parser->cont = false;
1268 } else if (parser->idx < parser->size - 1) {
1269 parser->cont = true;
1270 parser->buffer[parser->idx++] = ch;
1283 /* TODO add a seq_buf_to_buffer() */
1284 static ssize_t trace_seq_to_buffer(struct trace_seq *s, void *buf, size_t cnt)
1288 if (trace_seq_used(s) <= s->seq.readpos)
1291 len = trace_seq_used(s) - s->seq.readpos;
1294 memcpy(buf, s->buffer + s->seq.readpos, cnt);
1296 s->seq.readpos += cnt;
1300 unsigned long __read_mostly tracing_thresh;
1302 #ifdef CONFIG_TRACER_MAX_TRACE
1304 * Copy the new maximum trace into the separate maximum-trace
1305 * structure. (this way the maximum trace is permanently saved,
1306 * for later retrieval via /sys/kernel/debug/tracing/latency_trace)
1309 __update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)
1311 struct trace_buffer *trace_buf = &tr->trace_buffer;
1312 struct trace_buffer *max_buf = &tr->max_buffer;
1313 struct trace_array_cpu *data = per_cpu_ptr(trace_buf->data, cpu);
1314 struct trace_array_cpu *max_data = per_cpu_ptr(max_buf->data, cpu);
1317 max_buf->time_start = data->preempt_timestamp;
1319 max_data->saved_latency = tr->max_latency;
1320 max_data->critical_start = data->critical_start;
1321 max_data->critical_end = data->critical_end;
1323 memcpy(max_data->comm, tsk->comm, TASK_COMM_LEN);
1324 max_data->pid = tsk->pid;
1326 * If tsk == current, then use current_uid(), as that does not use
1327 * RCU. The irq tracer can be called out of RCU scope.
1330 max_data->uid = current_uid();
1332 max_data->uid = task_uid(tsk);
1334 max_data->nice = tsk->static_prio - 20 - MAX_RT_PRIO;
1335 max_data->policy = tsk->policy;
1336 max_data->rt_priority = tsk->rt_priority;
1338 /* record this tasks comm */
1339 tracing_record_cmdline(tsk);
1343 * update_max_tr - snapshot all trace buffers from global_trace to max_tr
1345 * @tsk: the task with the latency
1346 * @cpu: The cpu that initiated the trace.
1348 * Flip the buffers between the @tr and the max_tr and record information
1349 * about which task was the cause of this latency.
1352 update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)
1354 struct ring_buffer *buf;
1359 WARN_ON_ONCE(!irqs_disabled());
1361 if (!tr->allocated_snapshot) {
1362 /* Only the nop tracer should hit this when disabling */
1363 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1367 arch_spin_lock(&tr->max_lock);
1369 buf = tr->trace_buffer.buffer;
1370 tr->trace_buffer.buffer = tr->max_buffer.buffer;
1371 tr->max_buffer.buffer = buf;
1373 __update_max_tr(tr, tsk, cpu);
1374 arch_spin_unlock(&tr->max_lock);
1378 * update_max_tr_single - only copy one trace over, and reset the rest
1380 * @tsk - task with the latency
1381 * @cpu - the cpu of the buffer to copy.
1383 * Flip the trace of a single CPU buffer between the @tr and the max_tr.
1386 update_max_tr_single(struct trace_array *tr, struct task_struct *tsk, int cpu)
1393 WARN_ON_ONCE(!irqs_disabled());
1394 if (!tr->allocated_snapshot) {
1395 /* Only the nop tracer should hit this when disabling */
1396 WARN_ON_ONCE(tr->current_trace != &nop_trace);
1400 arch_spin_lock(&tr->max_lock);
1402 ret = ring_buffer_swap_cpu(tr->max_buffer.buffer, tr->trace_buffer.buffer, cpu);
1404 if (ret == -EBUSY) {
1406 * We failed to swap the buffer due to a commit taking
1407 * place on this CPU. We fail to record, but we reset
1408 * the max trace buffer (no one writes directly to it)
1409 * and flag that it failed.
1411 trace_array_printk_buf(tr->max_buffer.buffer, _THIS_IP_,
1412 "Failed to swap buffers due to commit in progress\n");
1415 WARN_ON_ONCE(ret && ret != -EAGAIN && ret != -EBUSY);
1417 __update_max_tr(tr, tsk, cpu);
1418 arch_spin_unlock(&tr->max_lock);
1420 #endif /* CONFIG_TRACER_MAX_TRACE */
1422 static int wait_on_pipe(struct trace_iterator *iter, bool full)
1424 /* Iterators are static, they should be filled or empty */
1425 if (trace_buffer_iter(iter, iter->cpu_file))
1428 return ring_buffer_wait(iter->trace_buffer->buffer, iter->cpu_file,
1432 #ifdef CONFIG_FTRACE_STARTUP_TEST
1433 static bool selftests_can_run;
1435 struct trace_selftests {
1436 struct list_head list;
1437 struct tracer *type;
1440 static LIST_HEAD(postponed_selftests);
1442 static int save_selftest(struct tracer *type)
1444 struct trace_selftests *selftest;
1446 selftest = kmalloc(sizeof(*selftest), GFP_KERNEL);
1450 selftest->type = type;
1451 list_add(&selftest->list, &postponed_selftests);
1455 static int run_tracer_selftest(struct tracer *type)
1457 struct trace_array *tr = &global_trace;
1458 struct tracer *saved_tracer = tr->current_trace;
1461 if (!type->selftest || tracing_selftest_disabled)
1465 * If a tracer registers early in boot up (before scheduling is
1466 * initialized and such), then do not run its selftests yet.
1467 * Instead, run it a little later in the boot process.
1469 if (!selftests_can_run)
1470 return save_selftest(type);
1473 * Run a selftest on this tracer.
1474 * Here we reset the trace buffer, and set the current
1475 * tracer to be this tracer. The tracer can then run some
1476 * internal tracing to verify that everything is in order.
1477 * If we fail, we do not register this tracer.
1479 tracing_reset_online_cpus(&tr->trace_buffer);
1481 tr->current_trace = type;
1483 #ifdef CONFIG_TRACER_MAX_TRACE
1484 if (type->use_max_tr) {
1485 /* If we expanded the buffers, make sure the max is expanded too */
1486 if (ring_buffer_expanded)
1487 ring_buffer_resize(tr->max_buffer.buffer, trace_buf_size,
1488 RING_BUFFER_ALL_CPUS);
1489 tr->allocated_snapshot = true;
1493 /* the test is responsible for initializing and enabling */
1494 pr_info("Testing tracer %s: ", type->name);
1495 ret = type->selftest(type, tr);
1496 /* the test is responsible for resetting too */
1497 tr->current_trace = saved_tracer;
1499 printk(KERN_CONT "FAILED!\n");
1500 /* Add the warning after printing 'FAILED' */
1504 /* Only reset on passing, to avoid touching corrupted buffers */
1505 tracing_reset_online_cpus(&tr->trace_buffer);
1507 #ifdef CONFIG_TRACER_MAX_TRACE
1508 if (type->use_max_tr) {
1509 tr->allocated_snapshot = false;
1511 /* Shrink the max buffer again */
1512 if (ring_buffer_expanded)
1513 ring_buffer_resize(tr->max_buffer.buffer, 1,
1514 RING_BUFFER_ALL_CPUS);
1518 printk(KERN_CONT "PASSED\n");
1522 static __init int init_trace_selftests(void)
1524 struct trace_selftests *p, *n;
1525 struct tracer *t, **last;
1528 selftests_can_run = true;
1530 mutex_lock(&trace_types_lock);
1532 if (list_empty(&postponed_selftests))
1535 pr_info("Running postponed tracer tests:\n");
1537 list_for_each_entry_safe(p, n, &postponed_selftests, list) {
1538 ret = run_tracer_selftest(p->type);
1539 /* If the test fails, then warn and remove from available_tracers */
1541 WARN(1, "tracer: %s failed selftest, disabling\n",
1543 last = &trace_types;
1544 for (t = trace_types; t; t = t->next) {
1557 mutex_unlock(&trace_types_lock);
1561 core_initcall(init_trace_selftests);
1563 static inline int run_tracer_selftest(struct tracer *type)
1567 #endif /* CONFIG_FTRACE_STARTUP_TEST */
1569 static void add_tracer_options(struct trace_array *tr, struct tracer *t);
1571 static void __init apply_trace_boot_options(void);
1574 * register_tracer - register a tracer with the ftrace system.
1575 * @type - the plugin for the tracer
1577 * Register a new plugin tracer.
1579 int __init register_tracer(struct tracer *type)
1585 pr_info("Tracer must have a name\n");
1589 if (strlen(type->name) >= MAX_TRACER_SIZE) {
1590 pr_info("Tracer has a name longer than %d\n", MAX_TRACER_SIZE);
1594 mutex_lock(&trace_types_lock);
1596 tracing_selftest_running = true;
1598 for (t = trace_types; t; t = t->next) {
1599 if (strcmp(type->name, t->name) == 0) {
1601 pr_info("Tracer %s already registered\n",
1608 if (!type->set_flag)
1609 type->set_flag = &dummy_set_flag;
1611 /*allocate a dummy tracer_flags*/
1612 type->flags = kmalloc(sizeof(*type->flags), GFP_KERNEL);
1617 type->flags->val = 0;
1618 type->flags->opts = dummy_tracer_opt;
1620 if (!type->flags->opts)
1621 type->flags->opts = dummy_tracer_opt;
1623 /* store the tracer for __set_tracer_option */
1624 type->flags->trace = type;
1626 ret = run_tracer_selftest(type);
1630 type->next = trace_types;
1632 add_tracer_options(&global_trace, type);
1635 tracing_selftest_running = false;
1636 mutex_unlock(&trace_types_lock);
1638 if (ret || !default_bootup_tracer)
1641 if (strncmp(default_bootup_tracer, type->name, MAX_TRACER_SIZE))
1644 printk(KERN_INFO "Starting tracer '%s'\n", type->name);
1645 /* Do we want this tracer to start on bootup? */
1646 tracing_set_tracer(&global_trace, type->name);
1647 default_bootup_tracer = NULL;
1649 apply_trace_boot_options();
1651 /* disable other selftests, since this will break it. */
1652 tracing_selftest_disabled = true;
1653 #ifdef CONFIG_FTRACE_STARTUP_TEST
1654 printk(KERN_INFO "Disabling FTRACE selftests due to running tracer '%s'\n",
1662 void tracing_reset(struct trace_buffer *buf, int cpu)
1664 struct ring_buffer *buffer = buf->buffer;
1669 ring_buffer_record_disable(buffer);
1671 /* Make sure all commits have finished */
1672 synchronize_sched();
1673 ring_buffer_reset_cpu(buffer, cpu);
1675 ring_buffer_record_enable(buffer);
1678 void tracing_reset_online_cpus(struct trace_buffer *buf)
1680 struct ring_buffer *buffer = buf->buffer;
1686 ring_buffer_record_disable(buffer);
1688 /* Make sure all commits have finished */
1689 synchronize_sched();
1691 buf->time_start = buffer_ftrace_now(buf, buf->cpu);
1693 for_each_online_cpu(cpu)
1694 ring_buffer_reset_cpu(buffer, cpu);
1696 ring_buffer_record_enable(buffer);
1699 /* Must have trace_types_lock held */
1700 void tracing_reset_all_online_cpus(void)
1702 struct trace_array *tr;
1704 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
1705 tracing_reset_online_cpus(&tr->trace_buffer);
1706 #ifdef CONFIG_TRACER_MAX_TRACE
1707 tracing_reset_online_cpus(&tr->max_buffer);
1712 #define SAVED_CMDLINES_DEFAULT 128
1713 #define NO_CMDLINE_MAP UINT_MAX
1714 static arch_spinlock_t trace_cmdline_lock = __ARCH_SPIN_LOCK_UNLOCKED;
1715 struct saved_cmdlines_buffer {
1716 unsigned map_pid_to_cmdline[PID_MAX_DEFAULT+1];
1717 unsigned *map_cmdline_to_pid;
1718 unsigned cmdline_num;
1720 char *saved_cmdlines;
1722 static struct saved_cmdlines_buffer *savedcmd;
1724 /* temporary disable recording */
1725 static atomic_t trace_record_cmdline_disabled __read_mostly;
1727 static inline char *get_saved_cmdlines(int idx)
1729 return &savedcmd->saved_cmdlines[idx * TASK_COMM_LEN];
1732 static inline void set_cmdline(int idx, const char *cmdline)
1734 memcpy(get_saved_cmdlines(idx), cmdline, TASK_COMM_LEN);
1737 static int allocate_cmdlines_buffer(unsigned int val,
1738 struct saved_cmdlines_buffer *s)
1740 s->map_cmdline_to_pid = kmalloc(val * sizeof(*s->map_cmdline_to_pid),
1742 if (!s->map_cmdline_to_pid)
1745 s->saved_cmdlines = kmalloc(val * TASK_COMM_LEN, GFP_KERNEL);
1746 if (!s->saved_cmdlines) {
1747 kfree(s->map_cmdline_to_pid);
1752 s->cmdline_num = val;
1753 memset(&s->map_pid_to_cmdline, NO_CMDLINE_MAP,
1754 sizeof(s->map_pid_to_cmdline));
1755 memset(s->map_cmdline_to_pid, NO_CMDLINE_MAP,
1756 val * sizeof(*s->map_cmdline_to_pid));
1761 static int trace_create_savedcmd(void)
1765 savedcmd = kmalloc(sizeof(*savedcmd), GFP_KERNEL);
1769 ret = allocate_cmdlines_buffer(SAVED_CMDLINES_DEFAULT, savedcmd);
1779 int is_tracing_stopped(void)
1781 return global_trace.stop_count;
1785 * tracing_start - quick start of the tracer
1787 * If tracing is enabled but was stopped by tracing_stop,
1788 * this will start the tracer back up.
1790 void tracing_start(void)
1792 struct ring_buffer *buffer;
1793 unsigned long flags;
1795 if (tracing_disabled)
1798 raw_spin_lock_irqsave(&global_trace.start_lock, flags);
1799 if (--global_trace.stop_count) {
1800 if (global_trace.stop_count < 0) {
1801 /* Someone screwed up their debugging */
1803 global_trace.stop_count = 0;
1808 /* Prevent the buffers from switching */
1809 arch_spin_lock(&global_trace.max_lock);
1811 buffer = global_trace.trace_buffer.buffer;
1813 ring_buffer_record_enable(buffer);
1815 #ifdef CONFIG_TRACER_MAX_TRACE
1816 buffer = global_trace.max_buffer.buffer;
1818 ring_buffer_record_enable(buffer);
1821 arch_spin_unlock(&global_trace.max_lock);
1824 raw_spin_unlock_irqrestore(&global_trace.start_lock, flags);
1827 static void tracing_start_tr(struct trace_array *tr)
1829 struct ring_buffer *buffer;
1830 unsigned long flags;
1832 if (tracing_disabled)
1835 /* If global, we need to also start the max tracer */
1836 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
1837 return tracing_start();
1839 raw_spin_lock_irqsave(&tr->start_lock, flags);
1841 if (--tr->stop_count) {
1842 if (tr->stop_count < 0) {
1843 /* Someone screwed up their debugging */
1850 buffer = tr->trace_buffer.buffer;
1852 ring_buffer_record_enable(buffer);
1855 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
1859 * tracing_stop - quick stop of the tracer
1861 * Light weight way to stop tracing. Use in conjunction with
1864 void tracing_stop(void)
1866 struct ring_buffer *buffer;
1867 unsigned long flags;
1869 raw_spin_lock_irqsave(&global_trace.start_lock, flags);
1870 if (global_trace.stop_count++)
1873 /* Prevent the buffers from switching */
1874 arch_spin_lock(&global_trace.max_lock);
1876 buffer = global_trace.trace_buffer.buffer;
1878 ring_buffer_record_disable(buffer);
1880 #ifdef CONFIG_TRACER_MAX_TRACE
1881 buffer = global_trace.max_buffer.buffer;
1883 ring_buffer_record_disable(buffer);
1886 arch_spin_unlock(&global_trace.max_lock);
1889 raw_spin_unlock_irqrestore(&global_trace.start_lock, flags);
1892 static void tracing_stop_tr(struct trace_array *tr)
1894 struct ring_buffer *buffer;
1895 unsigned long flags;
1897 /* If global, we need to also stop the max tracer */
1898 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
1899 return tracing_stop();
1901 raw_spin_lock_irqsave(&tr->start_lock, flags);
1902 if (tr->stop_count++)
1905 buffer = tr->trace_buffer.buffer;
1907 ring_buffer_record_disable(buffer);
1910 raw_spin_unlock_irqrestore(&tr->start_lock, flags);
1913 void trace_stop_cmdline_recording(void);
1915 static int trace_save_cmdline(struct task_struct *tsk)
1919 if (!tsk->pid || unlikely(tsk->pid > PID_MAX_DEFAULT))
1923 * It's not the end of the world if we don't get
1924 * the lock, but we also don't want to spin
1925 * nor do we want to disable interrupts,
1926 * so if we miss here, then better luck next time.
1928 if (!arch_spin_trylock(&trace_cmdline_lock))
1931 idx = savedcmd->map_pid_to_cmdline[tsk->pid];
1932 if (idx == NO_CMDLINE_MAP) {
1933 idx = (savedcmd->cmdline_idx + 1) % savedcmd->cmdline_num;
1936 * Check whether the cmdline buffer at idx has a pid
1937 * mapped. We are going to overwrite that entry so we
1938 * need to clear the map_pid_to_cmdline. Otherwise we
1939 * would read the new comm for the old pid.
1941 pid = savedcmd->map_cmdline_to_pid[idx];
1942 if (pid != NO_CMDLINE_MAP)
1943 savedcmd->map_pid_to_cmdline[pid] = NO_CMDLINE_MAP;
1945 savedcmd->map_cmdline_to_pid[idx] = tsk->pid;
1946 savedcmd->map_pid_to_cmdline[tsk->pid] = idx;
1948 savedcmd->cmdline_idx = idx;
1951 set_cmdline(idx, tsk->comm);
1953 arch_spin_unlock(&trace_cmdline_lock);
1958 static void __trace_find_cmdline(int pid, char comm[])
1963 strcpy(comm, "<idle>");
1967 if (WARN_ON_ONCE(pid < 0)) {
1968 strcpy(comm, "<XXX>");
1972 if (pid > PID_MAX_DEFAULT) {
1973 strcpy(comm, "<...>");
1977 map = savedcmd->map_pid_to_cmdline[pid];
1978 if (map != NO_CMDLINE_MAP)
1979 strlcpy(comm, get_saved_cmdlines(map), TASK_COMM_LEN);
1981 strcpy(comm, "<...>");
1984 void trace_find_cmdline(int pid, char comm[])
1987 arch_spin_lock(&trace_cmdline_lock);
1989 __trace_find_cmdline(pid, comm);
1991 arch_spin_unlock(&trace_cmdline_lock);
1995 void tracing_record_cmdline(struct task_struct *tsk)
1997 if (atomic_read(&trace_record_cmdline_disabled) || !tracing_is_on())
2000 if (!__this_cpu_read(trace_cmdline_save))
2003 if (trace_save_cmdline(tsk))
2004 __this_cpu_write(trace_cmdline_save, false);
2008 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
2009 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
2010 * simplifies those functions and keeps them in sync.
2012 enum print_line_t trace_handle_return(struct trace_seq *s)
2014 return trace_seq_has_overflowed(s) ?
2015 TRACE_TYPE_PARTIAL_LINE : TRACE_TYPE_HANDLED;
2017 EXPORT_SYMBOL_GPL(trace_handle_return);
2020 tracing_generic_entry_update(struct trace_entry *entry, unsigned long flags,
2023 struct task_struct *tsk = current;
2025 entry->preempt_count = pc & 0xff;
2026 entry->pid = (tsk) ? tsk->pid : 0;
2028 #ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
2029 (irqs_disabled_flags(flags) ? TRACE_FLAG_IRQS_OFF : 0) |
2031 TRACE_FLAG_IRQS_NOSUPPORT |
2033 ((pc & NMI_MASK ) ? TRACE_FLAG_NMI : 0) |
2034 ((pc & HARDIRQ_MASK) ? TRACE_FLAG_HARDIRQ : 0) |
2035 ((pc & SOFTIRQ_OFFSET) ? TRACE_FLAG_SOFTIRQ : 0) |
2036 (tif_need_resched() ? TRACE_FLAG_NEED_RESCHED : 0) |
2037 (test_preempt_need_resched() ? TRACE_FLAG_PREEMPT_RESCHED : 0);
2039 EXPORT_SYMBOL_GPL(tracing_generic_entry_update);
2041 struct ring_buffer_event *
2042 trace_buffer_lock_reserve(struct ring_buffer *buffer,
2045 unsigned long flags, int pc)
2047 return __trace_buffer_lock_reserve(buffer, type, len, flags, pc);
2050 DEFINE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
2051 DEFINE_PER_CPU(int, trace_buffered_event_cnt);
2052 static int trace_buffered_event_ref;
2055 * trace_buffered_event_enable - enable buffering events
2057 * When events are being filtered, it is quicker to use a temporary
2058 * buffer to write the event data into if there's a likely chance
2059 * that it will not be committed. The discard of the ring buffer
2060 * is not as fast as committing, and is much slower than copying
2063 * When an event is to be filtered, allocate per cpu buffers to
2064 * write the event data into, and if the event is filtered and discarded
2065 * it is simply dropped, otherwise, the entire data is to be committed
2068 void trace_buffered_event_enable(void)
2070 struct ring_buffer_event *event;
2074 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2076 if (trace_buffered_event_ref++)
2079 for_each_tracing_cpu(cpu) {
2080 page = alloc_pages_node(cpu_to_node(cpu),
2081 GFP_KERNEL | __GFP_NORETRY, 0);
2085 event = page_address(page);
2086 memset(event, 0, sizeof(*event));
2088 per_cpu(trace_buffered_event, cpu) = event;
2091 if (cpu == smp_processor_id() &&
2092 this_cpu_read(trace_buffered_event) !=
2093 per_cpu(trace_buffered_event, cpu))
2100 trace_buffered_event_disable();
2103 static void enable_trace_buffered_event(void *data)
2105 /* Probably not needed, but do it anyway */
2107 this_cpu_dec(trace_buffered_event_cnt);
2110 static void disable_trace_buffered_event(void *data)
2112 this_cpu_inc(trace_buffered_event_cnt);
2116 * trace_buffered_event_disable - disable buffering events
2118 * When a filter is removed, it is faster to not use the buffered
2119 * events, and to commit directly into the ring buffer. Free up
2120 * the temp buffers when there are no more users. This requires
2121 * special synchronization with current events.
2123 void trace_buffered_event_disable(void)
2127 WARN_ON_ONCE(!mutex_is_locked(&event_mutex));
2129 if (WARN_ON_ONCE(!trace_buffered_event_ref))
2132 if (--trace_buffered_event_ref)
2136 /* For each CPU, set the buffer as used. */
2137 smp_call_function_many(tracing_buffer_mask,
2138 disable_trace_buffered_event, NULL, 1);
2141 /* Wait for all current users to finish */
2142 synchronize_sched();
2144 for_each_tracing_cpu(cpu) {
2145 free_page((unsigned long)per_cpu(trace_buffered_event, cpu));
2146 per_cpu(trace_buffered_event, cpu) = NULL;
2149 * Make sure trace_buffered_event is NULL before clearing
2150 * trace_buffered_event_cnt.
2155 /* Do the work on each cpu */
2156 smp_call_function_many(tracing_buffer_mask,
2157 enable_trace_buffered_event, NULL, 1);
2161 static struct ring_buffer *temp_buffer;
2163 struct ring_buffer_event *
2164 trace_event_buffer_lock_reserve(struct ring_buffer **current_rb,
2165 struct trace_event_file *trace_file,
2166 int type, unsigned long len,
2167 unsigned long flags, int pc)
2169 struct ring_buffer_event *entry;
2172 *current_rb = trace_file->tr->trace_buffer.buffer;
2174 if ((trace_file->flags &
2175 (EVENT_FILE_FL_SOFT_DISABLED | EVENT_FILE_FL_FILTERED)) &&
2176 (entry = this_cpu_read(trace_buffered_event))) {
2177 /* Try to use the per cpu buffer first */
2178 val = this_cpu_inc_return(trace_buffered_event_cnt);
2180 trace_event_setup(entry, type, flags, pc);
2181 entry->array[0] = len;
2184 this_cpu_dec(trace_buffered_event_cnt);
2187 entry = __trace_buffer_lock_reserve(*current_rb,
2188 type, len, flags, pc);
2190 * If tracing is off, but we have triggers enabled
2191 * we still need to look at the event data. Use the temp_buffer
2192 * to store the trace event for the tigger to use. It's recusive
2193 * safe and will not be recorded anywhere.
2195 if (!entry && trace_file->flags & EVENT_FILE_FL_TRIGGER_COND) {
2196 *current_rb = temp_buffer;
2197 entry = __trace_buffer_lock_reserve(*current_rb,
2198 type, len, flags, pc);
2202 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve);
2204 static DEFINE_SPINLOCK(tracepoint_iter_lock);
2205 static DEFINE_MUTEX(tracepoint_printk_mutex);
2207 static void output_printk(struct trace_event_buffer *fbuffer)
2209 struct trace_event_call *event_call;
2210 struct trace_event *event;
2211 unsigned long flags;
2212 struct trace_iterator *iter = tracepoint_print_iter;
2214 /* We should never get here if iter is NULL */
2215 if (WARN_ON_ONCE(!iter))
2218 event_call = fbuffer->trace_file->event_call;
2219 if (!event_call || !event_call->event.funcs ||
2220 !event_call->event.funcs->trace)
2223 event = &fbuffer->trace_file->event_call->event;
2225 spin_lock_irqsave(&tracepoint_iter_lock, flags);
2226 trace_seq_init(&iter->seq);
2227 iter->ent = fbuffer->entry;
2228 event_call->event.funcs->trace(iter, 0, event);
2229 trace_seq_putc(&iter->seq, 0);
2230 printk("%s", iter->seq.buffer);
2232 spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
2235 int tracepoint_printk_sysctl(struct ctl_table *table, int write,
2236 void __user *buffer, size_t *lenp,
2239 int save_tracepoint_printk;
2242 mutex_lock(&tracepoint_printk_mutex);
2243 save_tracepoint_printk = tracepoint_printk;
2245 ret = proc_dointvec(table, write, buffer, lenp, ppos);
2248 * This will force exiting early, as tracepoint_printk
2249 * is always zero when tracepoint_printk_iter is not allocated
2251 if (!tracepoint_print_iter)
2252 tracepoint_printk = 0;
2254 if (save_tracepoint_printk == tracepoint_printk)
2257 if (tracepoint_printk)
2258 static_key_enable(&tracepoint_printk_key.key);
2260 static_key_disable(&tracepoint_printk_key.key);
2263 mutex_unlock(&tracepoint_printk_mutex);
2268 void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
2270 if (static_key_false(&tracepoint_printk_key.key))
2271 output_printk(fbuffer);
2273 event_trigger_unlock_commit(fbuffer->trace_file, fbuffer->buffer,
2274 fbuffer->event, fbuffer->entry,
2275 fbuffer->flags, fbuffer->pc);
2277 EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
2279 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
2280 struct ring_buffer *buffer,
2281 struct ring_buffer_event *event,
2282 unsigned long flags, int pc,
2283 struct pt_regs *regs)
2285 __buffer_unlock_commit(buffer, event);
2288 * If regs is not set, then skip the following callers:
2289 * trace_buffer_unlock_commit_regs
2290 * event_trigger_unlock_commit
2291 * trace_event_buffer_commit
2292 * trace_event_raw_event_sched_switch
2293 * Note, we can still get here via blktrace, wakeup tracer
2294 * and mmiotrace, but that's ok if they lose a function or
2295 * two. They are that meaningful.
2297 ftrace_trace_stack(tr, buffer, flags, regs ? 0 : 4, pc, regs);
2298 ftrace_trace_userstack(buffer, flags, pc);
2302 * Similar to trace_buffer_unlock_commit_regs() but do not dump stack.
2305 trace_buffer_unlock_commit_nostack(struct ring_buffer *buffer,
2306 struct ring_buffer_event *event)
2308 __buffer_unlock_commit(buffer, event);
2312 trace_process_export(struct trace_export *export,
2313 struct ring_buffer_event *event)
2315 struct trace_entry *entry;
2316 unsigned int size = 0;
2318 entry = ring_buffer_event_data(event);
2319 size = ring_buffer_event_length(event);
2320 export->write(entry, size);
2323 static DEFINE_MUTEX(ftrace_export_lock);
2325 static struct trace_export __rcu *ftrace_exports_list __read_mostly;
2327 static DEFINE_STATIC_KEY_FALSE(ftrace_exports_enabled);
2329 static inline void ftrace_exports_enable(void)
2331 static_branch_enable(&ftrace_exports_enabled);
2334 static inline void ftrace_exports_disable(void)
2336 static_branch_disable(&ftrace_exports_enabled);
2339 void ftrace_exports(struct ring_buffer_event *event)
2341 struct trace_export *export;
2343 preempt_disable_notrace();
2345 export = rcu_dereference_raw_notrace(ftrace_exports_list);
2347 trace_process_export(export, event);
2348 export = rcu_dereference_raw_notrace(export->next);
2351 preempt_enable_notrace();
2355 add_trace_export(struct trace_export **list, struct trace_export *export)
2357 rcu_assign_pointer(export->next, *list);
2359 * We are entering export into the list but another
2360 * CPU might be walking that list. We need to make sure
2361 * the export->next pointer is valid before another CPU sees
2362 * the export pointer included into the list.
2364 rcu_assign_pointer(*list, export);
2368 rm_trace_export(struct trace_export **list, struct trace_export *export)
2370 struct trace_export **p;
2372 for (p = list; *p != NULL; p = &(*p)->next)
2379 rcu_assign_pointer(*p, (*p)->next);
2385 add_ftrace_export(struct trace_export **list, struct trace_export *export)
2388 ftrace_exports_enable();
2390 add_trace_export(list, export);
2394 rm_ftrace_export(struct trace_export **list, struct trace_export *export)
2398 ret = rm_trace_export(list, export);
2400 ftrace_exports_disable();
2405 int register_ftrace_export(struct trace_export *export)
2407 if (WARN_ON_ONCE(!export->write))
2410 mutex_lock(&ftrace_export_lock);
2412 add_ftrace_export(&ftrace_exports_list, export);
2414 mutex_unlock(&ftrace_export_lock);
2418 EXPORT_SYMBOL_GPL(register_ftrace_export);
2420 int unregister_ftrace_export(struct trace_export *export)
2424 mutex_lock(&ftrace_export_lock);
2426 ret = rm_ftrace_export(&ftrace_exports_list, export);
2428 mutex_unlock(&ftrace_export_lock);
2432 EXPORT_SYMBOL_GPL(unregister_ftrace_export);
2435 trace_function(struct trace_array *tr,
2436 unsigned long ip, unsigned long parent_ip, unsigned long flags,
2439 struct trace_event_call *call = &event_function;
2440 struct ring_buffer *buffer = tr->trace_buffer.buffer;
2441 struct ring_buffer_event *event;
2442 struct ftrace_entry *entry;
2444 event = __trace_buffer_lock_reserve(buffer, TRACE_FN, sizeof(*entry),
2448 entry = ring_buffer_event_data(event);
2450 entry->parent_ip = parent_ip;
2452 if (!call_filter_check_discard(call, entry, buffer, event)) {
2453 if (static_branch_unlikely(&ftrace_exports_enabled))
2454 ftrace_exports(event);
2455 __buffer_unlock_commit(buffer, event);
2459 #ifdef CONFIG_STACKTRACE
2461 #define FTRACE_STACK_MAX_ENTRIES (PAGE_SIZE / sizeof(unsigned long))
2462 struct ftrace_stack {
2463 unsigned long calls[FTRACE_STACK_MAX_ENTRIES];
2466 static DEFINE_PER_CPU(struct ftrace_stack, ftrace_stack);
2467 static DEFINE_PER_CPU(int, ftrace_stack_reserve);
2469 static void __ftrace_trace_stack(struct ring_buffer *buffer,
2470 unsigned long flags,
2471 int skip, int pc, struct pt_regs *regs)
2473 struct trace_event_call *call = &event_kernel_stack;
2474 struct ring_buffer_event *event;
2475 struct stack_entry *entry;
2476 struct stack_trace trace;
2478 int size = FTRACE_STACK_ENTRIES;
2480 trace.nr_entries = 0;
2484 * Add two, for this function and the call to save_stack_trace()
2485 * If regs is set, then these functions will not be in the way.
2491 * Since events can happen in NMIs there's no safe way to
2492 * use the per cpu ftrace_stacks. We reserve it and if an interrupt
2493 * or NMI comes in, it will just have to use the default
2494 * FTRACE_STACK_SIZE.
2496 preempt_disable_notrace();
2498 use_stack = __this_cpu_inc_return(ftrace_stack_reserve);
2500 * We don't need any atomic variables, just a barrier.
2501 * If an interrupt comes in, we don't care, because it would
2502 * have exited and put the counter back to what we want.
2503 * We just need a barrier to keep gcc from moving things
2507 if (use_stack == 1) {
2508 trace.entries = this_cpu_ptr(ftrace_stack.calls);
2509 trace.max_entries = FTRACE_STACK_MAX_ENTRIES;
2512 save_stack_trace_regs(regs, &trace);
2514 save_stack_trace(&trace);
2516 if (trace.nr_entries > size)
2517 size = trace.nr_entries;
2519 /* From now on, use_stack is a boolean */
2522 size *= sizeof(unsigned long);
2524 event = __trace_buffer_lock_reserve(buffer, TRACE_STACK,
2525 sizeof(*entry) + size, flags, pc);
2528 entry = ring_buffer_event_data(event);
2530 memset(&entry->caller, 0, size);
2533 memcpy(&entry->caller, trace.entries,
2534 trace.nr_entries * sizeof(unsigned long));
2536 trace.max_entries = FTRACE_STACK_ENTRIES;
2537 trace.entries = entry->caller;
2539 save_stack_trace_regs(regs, &trace);
2541 save_stack_trace(&trace);
2544 entry->size = trace.nr_entries;
2546 if (!call_filter_check_discard(call, entry, buffer, event))
2547 __buffer_unlock_commit(buffer, event);
2550 /* Again, don't let gcc optimize things here */
2552 __this_cpu_dec(ftrace_stack_reserve);
2553 preempt_enable_notrace();
2557 static inline void ftrace_trace_stack(struct trace_array *tr,
2558 struct ring_buffer *buffer,
2559 unsigned long flags,
2560 int skip, int pc, struct pt_regs *regs)
2562 if (!(tr->trace_flags & TRACE_ITER_STACKTRACE))
2565 __ftrace_trace_stack(buffer, flags, skip, pc, regs);
2568 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
2571 struct ring_buffer *buffer = tr->trace_buffer.buffer;
2573 if (rcu_is_watching()) {
2574 __ftrace_trace_stack(buffer, flags, skip, pc, NULL);
2579 * When an NMI triggers, RCU is enabled via rcu_nmi_enter(),
2580 * but if the above rcu_is_watching() failed, then the NMI
2581 * triggered someplace critical, and rcu_irq_enter() should
2582 * not be called from NMI.
2584 if (unlikely(in_nmi()))
2588 * It is possible that a function is being traced in a
2589 * location that RCU is not watching. A call to
2590 * rcu_irq_enter() will make sure that it is, but there's
2591 * a few internal rcu functions that could be traced
2592 * where that wont work either. In those cases, we just
2595 if (unlikely(rcu_irq_enter_disabled()))
2598 rcu_irq_enter_irqson();
2599 __ftrace_trace_stack(buffer, flags, skip, pc, NULL);
2600 rcu_irq_exit_irqson();
2604 * trace_dump_stack - record a stack back trace in the trace buffer
2605 * @skip: Number of functions to skip (helper handlers)
2607 void trace_dump_stack(int skip)
2609 unsigned long flags;
2611 if (tracing_disabled || tracing_selftest_running)
2614 local_save_flags(flags);
2617 * Skip 3 more, seems to get us at the caller of
2621 __ftrace_trace_stack(global_trace.trace_buffer.buffer,
2622 flags, skip, preempt_count(), NULL);
2625 static DEFINE_PER_CPU(int, user_stack_count);
2628 ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags, int pc)
2630 struct trace_event_call *call = &event_user_stack;
2631 struct ring_buffer_event *event;
2632 struct userstack_entry *entry;
2633 struct stack_trace trace;
2635 if (!(global_trace.trace_flags & TRACE_ITER_USERSTACKTRACE))
2639 * NMIs can not handle page faults, even with fix ups.
2640 * The save user stack can (and often does) fault.
2642 if (unlikely(in_nmi()))
2646 * prevent recursion, since the user stack tracing may
2647 * trigger other kernel events.
2650 if (__this_cpu_read(user_stack_count))
2653 __this_cpu_inc(user_stack_count);
2655 event = __trace_buffer_lock_reserve(buffer, TRACE_USER_STACK,
2656 sizeof(*entry), flags, pc);
2658 goto out_drop_count;
2659 entry = ring_buffer_event_data(event);
2661 entry->tgid = current->tgid;
2662 memset(&entry->caller, 0, sizeof(entry->caller));
2664 trace.nr_entries = 0;
2665 trace.max_entries = FTRACE_STACK_ENTRIES;
2667 trace.entries = entry->caller;
2669 save_stack_trace_user(&trace);
2670 if (!call_filter_check_discard(call, entry, buffer, event))
2671 __buffer_unlock_commit(buffer, event);
2674 __this_cpu_dec(user_stack_count);
2680 static void __trace_userstack(struct trace_array *tr, unsigned long flags)
2682 ftrace_trace_userstack(tr, flags, preempt_count());
2686 #endif /* CONFIG_STACKTRACE */
2688 /* created for use with alloc_percpu */
2689 struct trace_buffer_struct {
2691 char buffer[4][TRACE_BUF_SIZE];
2694 static struct trace_buffer_struct *trace_percpu_buffer;
2697 * Thise allows for lockless recording. If we're nested too deeply, then
2698 * this returns NULL.
2700 static char *get_trace_buf(void)
2702 struct trace_buffer_struct *buffer = this_cpu_ptr(trace_percpu_buffer);
2704 if (!buffer || buffer->nesting >= 4)
2707 return &buffer->buffer[buffer->nesting++][0];
2710 static void put_trace_buf(void)
2712 this_cpu_dec(trace_percpu_buffer->nesting);
2715 static int alloc_percpu_trace_buffer(void)
2717 struct trace_buffer_struct *buffers;
2719 buffers = alloc_percpu(struct trace_buffer_struct);
2720 if (WARN(!buffers, "Could not allocate percpu trace_printk buffer"))
2723 trace_percpu_buffer = buffers;
2727 static int buffers_allocated;
2729 void trace_printk_init_buffers(void)
2731 if (buffers_allocated)
2734 if (alloc_percpu_trace_buffer())
2737 /* trace_printk() is for debug use only. Don't use it in production. */
2740 pr_warn("**********************************************************\n");
2741 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2743 pr_warn("** trace_printk() being used. Allocating extra memory. **\n");
2745 pr_warn("** This means that this is a DEBUG kernel and it is **\n");
2746 pr_warn("** unsafe for production use. **\n");
2748 pr_warn("** If you see this message and you are not debugging **\n");
2749 pr_warn("** the kernel, report this immediately to your vendor! **\n");
2751 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2752 pr_warn("**********************************************************\n");
2754 /* Expand the buffers to set size */
2755 tracing_update_buffers();
2757 buffers_allocated = 1;
2760 * trace_printk_init_buffers() can be called by modules.
2761 * If that happens, then we need to start cmdline recording
2762 * directly here. If the global_trace.buffer is already
2763 * allocated here, then this was called by module code.
2765 if (global_trace.trace_buffer.buffer)
2766 tracing_start_cmdline_record();
2769 void trace_printk_start_comm(void)
2771 /* Start tracing comms if trace printk is set */
2772 if (!buffers_allocated)
2774 tracing_start_cmdline_record();
2777 static void trace_printk_start_stop_comm(int enabled)
2779 if (!buffers_allocated)
2783 tracing_start_cmdline_record();
2785 tracing_stop_cmdline_record();
2789 * trace_vbprintk - write binary msg to tracing buffer
2792 int trace_vbprintk(unsigned long ip, const char *fmt, va_list args)
2794 struct trace_event_call *call = &event_bprint;
2795 struct ring_buffer_event *event;
2796 struct ring_buffer *buffer;
2797 struct trace_array *tr = &global_trace;
2798 struct bprint_entry *entry;
2799 unsigned long flags;
2801 int len = 0, size, pc;
2803 if (unlikely(tracing_selftest_running || tracing_disabled))
2806 /* Don't pollute graph traces with trace_vprintk internals */
2807 pause_graph_tracing();
2809 pc = preempt_count();
2810 preempt_disable_notrace();
2812 tbuffer = get_trace_buf();
2818 len = vbin_printf((u32 *)tbuffer, TRACE_BUF_SIZE/sizeof(int), fmt, args);
2820 if (len > TRACE_BUF_SIZE/sizeof(int) || len < 0)
2823 local_save_flags(flags);
2824 size = sizeof(*entry) + sizeof(u32) * len;
2825 buffer = tr->trace_buffer.buffer;
2826 event = __trace_buffer_lock_reserve(buffer, TRACE_BPRINT, size,
2830 entry = ring_buffer_event_data(event);
2834 memcpy(entry->buf, tbuffer, sizeof(u32) * len);
2835 if (!call_filter_check_discard(call, entry, buffer, event)) {
2836 __buffer_unlock_commit(buffer, event);
2837 ftrace_trace_stack(tr, buffer, flags, 6, pc, NULL);
2844 preempt_enable_notrace();
2845 unpause_graph_tracing();
2849 EXPORT_SYMBOL_GPL(trace_vbprintk);
2852 __trace_array_vprintk(struct ring_buffer *buffer,
2853 unsigned long ip, const char *fmt, va_list args)
2855 struct trace_event_call *call = &event_print;
2856 struct ring_buffer_event *event;
2857 int len = 0, size, pc;
2858 struct print_entry *entry;
2859 unsigned long flags;
2862 if (tracing_disabled || tracing_selftest_running)
2865 /* Don't pollute graph traces with trace_vprintk internals */
2866 pause_graph_tracing();
2868 pc = preempt_count();
2869 preempt_disable_notrace();
2872 tbuffer = get_trace_buf();
2878 len = vscnprintf(tbuffer, TRACE_BUF_SIZE, fmt, args);
2880 local_save_flags(flags);
2881 size = sizeof(*entry) + len + 1;
2882 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
2886 entry = ring_buffer_event_data(event);
2889 memcpy(&entry->buf, tbuffer, len + 1);
2890 if (!call_filter_check_discard(call, entry, buffer, event)) {
2891 __buffer_unlock_commit(buffer, event);
2892 ftrace_trace_stack(&global_trace, buffer, flags, 6, pc, NULL);
2899 preempt_enable_notrace();
2900 unpause_graph_tracing();
2905 int trace_array_vprintk(struct trace_array *tr,
2906 unsigned long ip, const char *fmt, va_list args)
2908 return __trace_array_vprintk(tr->trace_buffer.buffer, ip, fmt, args);
2911 int trace_array_printk(struct trace_array *tr,
2912 unsigned long ip, const char *fmt, ...)
2917 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
2921 ret = trace_array_vprintk(tr, ip, fmt, ap);
2926 int trace_array_printk_buf(struct ring_buffer *buffer,
2927 unsigned long ip, const char *fmt, ...)
2932 if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
2936 ret = __trace_array_vprintk(buffer, ip, fmt, ap);
2941 int trace_vprintk(unsigned long ip, const char *fmt, va_list args)
2943 return trace_array_vprintk(&global_trace, ip, fmt, args);
2945 EXPORT_SYMBOL_GPL(trace_vprintk);
2947 static void trace_iterator_increment(struct trace_iterator *iter)
2949 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, iter->cpu);
2953 ring_buffer_read(buf_iter, NULL);
2956 static struct trace_entry *
2957 peek_next_entry(struct trace_iterator *iter, int cpu, u64 *ts,
2958 unsigned long *lost_events)
2960 struct ring_buffer_event *event;
2961 struct ring_buffer_iter *buf_iter = trace_buffer_iter(iter, cpu);
2964 event = ring_buffer_iter_peek(buf_iter, ts);
2966 event = ring_buffer_peek(iter->trace_buffer->buffer, cpu, ts,
2970 iter->ent_size = ring_buffer_event_length(event);
2971 return ring_buffer_event_data(event);
2977 static struct trace_entry *
2978 __find_next_entry(struct trace_iterator *iter, int *ent_cpu,
2979 unsigned long *missing_events, u64 *ent_ts)
2981 struct ring_buffer *buffer = iter->trace_buffer->buffer;
2982 struct trace_entry *ent, *next = NULL;
2983 unsigned long lost_events = 0, next_lost = 0;
2984 int cpu_file = iter->cpu_file;
2985 u64 next_ts = 0, ts;
2991 * If we are in a per_cpu trace file, don't bother by iterating over
2992 * all cpu and peek directly.
2994 if (cpu_file > RING_BUFFER_ALL_CPUS) {
2995 if (ring_buffer_empty_cpu(buffer, cpu_file))
2997 ent = peek_next_entry(iter, cpu_file, ent_ts, missing_events);
2999 *ent_cpu = cpu_file;
3004 for_each_tracing_cpu(cpu) {
3006 if (ring_buffer_empty_cpu(buffer, cpu))
3009 ent = peek_next_entry(iter, cpu, &ts, &lost_events);
3012 * Pick the entry with the smallest timestamp:
3014 if (ent && (!next || ts < next_ts)) {
3018 next_lost = lost_events;
3019 next_size = iter->ent_size;
3023 iter->ent_size = next_size;
3026 *ent_cpu = next_cpu;
3032 *missing_events = next_lost;
3037 /* Find the next real entry, without updating the iterator itself */
3038 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
3039 int *ent_cpu, u64 *ent_ts)
3041 return __find_next_entry(iter, ent_cpu, NULL, ent_ts);
3044 /* Find the next real entry, and increment the iterator to the next entry */
3045 void *trace_find_next_entry_inc(struct trace_iterator *iter)
3047 iter->ent = __find_next_entry(iter, &iter->cpu,
3048 &iter->lost_events, &iter->ts);
3051 trace_iterator_increment(iter);
3053 return iter->ent ? iter : NULL;
3056 static void trace_consume(struct trace_iterator *iter)
3058 ring_buffer_consume(iter->trace_buffer->buffer, iter->cpu, &iter->ts,
3059 &iter->lost_events);
3062 static void *s_next(struct seq_file *m, void *v, loff_t *pos)
3064 struct trace_iterator *iter = m->private;
3068 WARN_ON_ONCE(iter->leftover);
3072 /* can't go backwards */
3077 ent = trace_find_next_entry_inc(iter);
3081 while (ent && iter->idx < i)
3082 ent = trace_find_next_entry_inc(iter);
3089 void tracing_iter_reset(struct trace_iterator *iter, int cpu)
3091 struct ring_buffer_event *event;
3092 struct ring_buffer_iter *buf_iter;
3093 unsigned long entries = 0;
3096 per_cpu_ptr(iter->trace_buffer->data, cpu)->skipped_entries = 0;
3098 buf_iter = trace_buffer_iter(iter, cpu);
3102 ring_buffer_iter_reset(buf_iter);
3105 * We could have the case with the max latency tracers
3106 * that a reset never took place on a cpu. This is evident
3107 * by the timestamp being before the start of the buffer.
3109 while ((event = ring_buffer_iter_peek(buf_iter, &ts))) {
3110 if (ts >= iter->trace_buffer->time_start)
3113 ring_buffer_read(buf_iter, NULL);
3116 per_cpu_ptr(iter->trace_buffer->data, cpu)->skipped_entries = entries;
3120 * The current tracer is copied to avoid a global locking
3123 static void *s_start(struct seq_file *m, loff_t *pos)
3125 struct trace_iterator *iter = m->private;
3126 struct trace_array *tr = iter->tr;
3127 int cpu_file = iter->cpu_file;
3133 * copy the tracer to avoid using a global lock all around.
3134 * iter->trace is a copy of current_trace, the pointer to the
3135 * name may be used instead of a strcmp(), as iter->trace->name
3136 * will point to the same string as current_trace->name.
3138 mutex_lock(&trace_types_lock);
3139 if (unlikely(tr->current_trace && iter->trace->name != tr->current_trace->name))
3140 *iter->trace = *tr->current_trace;
3141 mutex_unlock(&trace_types_lock);
3143 #ifdef CONFIG_TRACER_MAX_TRACE
3144 if (iter->snapshot && iter->trace->use_max_tr)
3145 return ERR_PTR(-EBUSY);
3148 if (!iter->snapshot)
3149 atomic_inc(&trace_record_cmdline_disabled);
3151 if (*pos != iter->pos) {
3156 if (cpu_file == RING_BUFFER_ALL_CPUS) {
3157 for_each_tracing_cpu(cpu)
3158 tracing_iter_reset(iter, cpu);
3160 tracing_iter_reset(iter, cpu_file);
3163 for (p = iter; p && l < *pos; p = s_next(m, p, &l))
3168 * If we overflowed the seq_file before, then we want
3169 * to just reuse the trace_seq buffer again.
3175 p = s_next(m, p, &l);
3179 trace_event_read_lock();
3180 trace_access_lock(cpu_file);
3184 static void s_stop(struct seq_file *m, void *p)
3186 struct trace_iterator *iter = m->private;
3188 #ifdef CONFIG_TRACER_MAX_TRACE
3189 if (iter->snapshot && iter->trace->use_max_tr)
3193 if (!iter->snapshot)
3194 atomic_dec(&trace_record_cmdline_disabled);
3196 trace_access_unlock(iter->cpu_file);
3197 trace_event_read_unlock();
3201 get_total_entries(struct trace_buffer *buf,
3202 unsigned long *total, unsigned long *entries)
3204 unsigned long count;
3210 for_each_tracing_cpu(cpu) {
3211 count = ring_buffer_entries_cpu(buf->buffer, cpu);
3213 * If this buffer has skipped entries, then we hold all
3214 * entries for the trace and we need to ignore the
3215 * ones before the time stamp.
3217 if (per_cpu_ptr(buf->data, cpu)->skipped_entries) {
3218 count -= per_cpu_ptr(buf->data, cpu)->skipped_entries;
3219 /* total is the same as the entries */
3223 ring_buffer_overrun_cpu(buf->buffer, cpu);
3228 static void print_lat_help_header(struct seq_file *m)
3230 seq_puts(m, "# _------=> CPU# \n"
3231 "# / _-----=> irqs-off \n"
3232 "# | / _----=> need-resched \n"
3233 "# || / _---=> hardirq/softirq \n"
3234 "# ||| / _--=> preempt-depth \n"
3236 "# cmd pid ||||| time | caller \n"
3237 "# \\ / ||||| \\ | / \n");
3240 static void print_event_info(struct trace_buffer *buf, struct seq_file *m)
3242 unsigned long total;
3243 unsigned long entries;
3245 get_total_entries(buf, &total, &entries);
3246 seq_printf(m, "# entries-in-buffer/entries-written: %lu/%lu #P:%d\n",
3247 entries, total, num_online_cpus());
3251 static void print_func_help_header(struct trace_buffer *buf, struct seq_file *m)
3253 print_event_info(buf, m);
3254 seq_puts(m, "# TASK-PID CPU# TIMESTAMP FUNCTION\n"
3258 static void print_func_help_header_irq(struct trace_buffer *buf, struct seq_file *m)
3260 print_event_info(buf, m);
3261 seq_puts(m, "# _-----=> irqs-off\n"
3262 "# / _----=> need-resched\n"
3263 "# | / _---=> hardirq/softirq\n"
3264 "# || / _--=> preempt-depth\n"
3266 "# TASK-PID CPU# |||| TIMESTAMP FUNCTION\n"
3267 "# | | | |||| | |\n");
3271 print_trace_header(struct seq_file *m, struct trace_iterator *iter)
3273 unsigned long sym_flags = (global_trace.trace_flags & TRACE_ITER_SYM_MASK);
3274 struct trace_buffer *buf = iter->trace_buffer;
3275 struct trace_array_cpu *data = per_cpu_ptr(buf->data, buf->cpu);
3276 struct tracer *type = iter->trace;
3277 unsigned long entries;
3278 unsigned long total;
3279 const char *name = "preemption";
3283 get_total_entries(buf, &total, &entries);
3285 seq_printf(m, "# %s latency trace v1.1.5 on %s\n",
3287 seq_puts(m, "# -----------------------------------"
3288 "---------------------------------\n");
3289 seq_printf(m, "# latency: %lu us, #%lu/%lu, CPU#%d |"
3290 " (M:%s VP:%d, KP:%d, SP:%d HP:%d",
3291 nsecs_to_usecs(data->saved_latency),
3295 #if defined(CONFIG_PREEMPT_NONE)
3297 #elif defined(CONFIG_PREEMPT_VOLUNTARY)
3299 #elif defined(CONFIG_PREEMPT)
3304 /* These are reserved for later use */
3307 seq_printf(m, " #P:%d)\n", num_online_cpus());
3311 seq_puts(m, "# -----------------\n");
3312 seq_printf(m, "# | task: %.16s-%d "
3313 "(uid:%d nice:%ld policy:%ld rt_prio:%ld)\n",
3314 data->comm, data->pid,
3315 from_kuid_munged(seq_user_ns(m), data->uid), data->nice,
3316 data->policy, data->rt_priority);
3317 seq_puts(m, "# -----------------\n");
3319 if (data->critical_start) {
3320 seq_puts(m, "# => started at: ");
3321 seq_print_ip_sym(&iter->seq, data->critical_start, sym_flags);
3322 trace_print_seq(m, &iter->seq);
3323 seq_puts(m, "\n# => ended at: ");
3324 seq_print_ip_sym(&iter->seq, data->critical_end, sym_flags);
3325 trace_print_seq(m, &iter->seq);
3326 seq_puts(m, "\n#\n");
3332 static void test_cpu_buff_start(struct trace_iterator *iter)
3334 struct trace_seq *s = &iter->seq;
3335 struct trace_array *tr = iter->tr;
3337 if (!(tr->trace_flags & TRACE_ITER_ANNOTATE))
3340 if (!(iter->iter_flags & TRACE_FILE_ANNOTATE))
3343 if (cpumask_available(iter->started) &&
3344 cpumask_test_cpu(iter->cpu, iter->started))
3347 if (per_cpu_ptr(iter->trace_buffer->data, iter->cpu)->skipped_entries)
3350 if (cpumask_available(iter->started))
3351 cpumask_set_cpu(iter->cpu, iter->started);
3353 /* Don't print started cpu buffer for the first entry of the trace */
3355 trace_seq_printf(s, "##### CPU %u buffer started ####\n",
3359 static enum print_line_t print_trace_fmt(struct trace_iterator *iter)
3361 struct trace_array *tr = iter->tr;
3362 struct trace_seq *s = &iter->seq;
3363 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
3364 struct trace_entry *entry;
3365 struct trace_event *event;
3369 test_cpu_buff_start(iter);
3371 event = ftrace_find_event(entry->type);
3373 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
3374 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
3375 trace_print_lat_context(iter);
3377 trace_print_context(iter);
3380 if (trace_seq_has_overflowed(s))
3381 return TRACE_TYPE_PARTIAL_LINE;
3384 return event->funcs->trace(iter, sym_flags, event);
3386 trace_seq_printf(s, "Unknown type %d\n", entry->type);
3388 return trace_handle_return(s);
3391 static enum print_line_t print_raw_fmt(struct trace_iterator *iter)
3393 struct trace_array *tr = iter->tr;
3394 struct trace_seq *s = &iter->seq;
3395 struct trace_entry *entry;
3396 struct trace_event *event;
3400 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO)
3401 trace_seq_printf(s, "%d %d %llu ",
3402 entry->pid, iter->cpu, iter->ts);
3404 if (trace_seq_has_overflowed(s))
3405 return TRACE_TYPE_PARTIAL_LINE;
3407 event = ftrace_find_event(entry->type);
3409 return event->funcs->raw(iter, 0, event);
3411 trace_seq_printf(s, "%d ?\n", entry->type);
3413 return trace_handle_return(s);
3416 static enum print_line_t print_hex_fmt(struct trace_iterator *iter)
3418 struct trace_array *tr = iter->tr;
3419 struct trace_seq *s = &iter->seq;
3420 unsigned char newline = '\n';
3421 struct trace_entry *entry;
3422 struct trace_event *event;
3426 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
3427 SEQ_PUT_HEX_FIELD(s, entry->pid);
3428 SEQ_PUT_HEX_FIELD(s, iter->cpu);
3429 SEQ_PUT_HEX_FIELD(s, iter->ts);
3430 if (trace_seq_has_overflowed(s))
3431 return TRACE_TYPE_PARTIAL_LINE;
3434 event = ftrace_find_event(entry->type);
3436 enum print_line_t ret = event->funcs->hex(iter, 0, event);
3437 if (ret != TRACE_TYPE_HANDLED)
3441 SEQ_PUT_FIELD(s, newline);
3443 return trace_handle_return(s);
3446 static enum print_line_t print_bin_fmt(struct trace_iterator *iter)
3448 struct trace_array *tr = iter->tr;
3449 struct trace_seq *s = &iter->seq;
3450 struct trace_entry *entry;
3451 struct trace_event *event;
3455 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
3456 SEQ_PUT_FIELD(s, entry->pid);
3457 SEQ_PUT_FIELD(s, iter->cpu);
3458 SEQ_PUT_FIELD(s, iter->ts);
3459 if (trace_seq_has_overflowed(s))
3460 return TRACE_TYPE_PARTIAL_LINE;
3463 event = ftrace_find_event(entry->type);
3464 return event ? event->funcs->binary(iter, 0, event) :
3468 int trace_empty(struct trace_iterator *iter)
3470 struct ring_buffer_iter *buf_iter;
3473 /* If we are looking at one CPU buffer, only check that one */
3474 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
3475 cpu = iter->cpu_file;
3476 buf_iter = trace_buffer_iter(iter, cpu);
3478 if (!ring_buffer_iter_empty(buf_iter))
3481 if (!ring_buffer_empty_cpu(iter->trace_buffer->buffer, cpu))
3487 for_each_tracing_cpu(cpu) {
3488 buf_iter = trace_buffer_iter(iter, cpu);
3490 if (!ring_buffer_iter_empty(buf_iter))
3493 if (!ring_buffer_empty_cpu(iter->trace_buffer->buffer, cpu))
3501 /* Called with trace_event_read_lock() held. */
3502 enum print_line_t print_trace_line(struct trace_iterator *iter)
3504 struct trace_array *tr = iter->tr;
3505 unsigned long trace_flags = tr->trace_flags;
3506 enum print_line_t ret;
3508 if (iter->lost_events) {
3509 trace_seq_printf(&iter->seq, "CPU:%d [LOST %lu EVENTS]\n",
3510 iter->cpu, iter->lost_events);
3511 if (trace_seq_has_overflowed(&iter->seq))
3512 return TRACE_TYPE_PARTIAL_LINE;
3515 if (iter->trace && iter->trace->print_line) {
3516 ret = iter->trace->print_line(iter);
3517 if (ret != TRACE_TYPE_UNHANDLED)
3521 if (iter->ent->type == TRACE_BPUTS &&
3522 trace_flags & TRACE_ITER_PRINTK &&
3523 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
3524 return trace_print_bputs_msg_only(iter);
3526 if (iter->ent->type == TRACE_BPRINT &&
3527 trace_flags & TRACE_ITER_PRINTK &&
3528 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
3529 return trace_print_bprintk_msg_only(iter);
3531 if (iter->ent->type == TRACE_PRINT &&
3532 trace_flags & TRACE_ITER_PRINTK &&
3533 trace_flags & TRACE_ITER_PRINTK_MSGONLY)
3534 return trace_print_printk_msg_only(iter);
3536 if (trace_flags & TRACE_ITER_BIN)
3537 return print_bin_fmt(iter);
3539 if (trace_flags & TRACE_ITER_HEX)
3540 return print_hex_fmt(iter);
3542 if (trace_flags & TRACE_ITER_RAW)
3543 return print_raw_fmt(iter);
3545 return print_trace_fmt(iter);
3548 void trace_latency_header(struct seq_file *m)
3550 struct trace_iterator *iter = m->private;
3551 struct trace_array *tr = iter->tr;
3553 /* print nothing if the buffers are empty */
3554 if (trace_empty(iter))
3557 if (iter->iter_flags & TRACE_FILE_LAT_FMT)
3558 print_trace_header(m, iter);
3560 if (!(tr->trace_flags & TRACE_ITER_VERBOSE))
3561 print_lat_help_header(m);
3564 void trace_default_header(struct seq_file *m)
3566 struct trace_iterator *iter = m->private;
3567 struct trace_array *tr = iter->tr;
3568 unsigned long trace_flags = tr->trace_flags;
3570 if (!(trace_flags & TRACE_ITER_CONTEXT_INFO))
3573 if (iter->iter_flags & TRACE_FILE_LAT_FMT) {
3574 /* print nothing if the buffers are empty */
3575 if (trace_empty(iter))
3577 print_trace_header(m, iter);
3578 if (!(trace_flags & TRACE_ITER_VERBOSE))
3579 print_lat_help_header(m);
3581 if (!(trace_flags & TRACE_ITER_VERBOSE)) {
3582 if (trace_flags & TRACE_ITER_IRQ_INFO)
3583 print_func_help_header_irq(iter->trace_buffer, m);
3585 print_func_help_header(iter->trace_buffer, m);
3590 static void test_ftrace_alive(struct seq_file *m)
3592 if (!ftrace_is_dead())
3594 seq_puts(m, "# WARNING: FUNCTION TRACING IS CORRUPTED\n"
3595 "# MAY BE MISSING FUNCTION EVENTS\n");
3598 #ifdef CONFIG_TRACER_MAX_TRACE
3599 static void show_snapshot_main_help(struct seq_file *m)
3601 seq_puts(m, "# echo 0 > snapshot : Clears and frees snapshot buffer\n"
3602 "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
3603 "# Takes a snapshot of the main buffer.\n"
3604 "# echo 2 > snapshot : Clears snapshot buffer (but does not allocate or free)\n"
3605 "# (Doesn't have to be '2' works with any number that\n"
3606 "# is not a '0' or '1')\n");
3609 static void show_snapshot_percpu_help(struct seq_file *m)
3611 seq_puts(m, "# echo 0 > snapshot : Invalid for per_cpu snapshot file.\n");
3612 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
3613 seq_puts(m, "# echo 1 > snapshot : Allocates snapshot buffer, if not already allocated.\n"
3614 "# Takes a snapshot of the main buffer for this cpu.\n");
3616 seq_puts(m, "# echo 1 > snapshot : Not supported with this kernel.\n"
3617 "# Must use main snapshot file to allocate.\n");
3619 seq_puts(m, "# echo 2 > snapshot : Clears this cpu's snapshot buffer (but does not allocate)\n"
3620 "# (Doesn't have to be '2' works with any number that\n"
3621 "# is not a '0' or '1')\n");
3624 static void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter)
3626 if (iter->tr->allocated_snapshot)
3627 seq_puts(m, "#\n# * Snapshot is allocated *\n#\n");
3629 seq_puts(m, "#\n# * Snapshot is freed *\n#\n");
3631 seq_puts(m, "# Snapshot commands:\n");
3632 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
3633 show_snapshot_main_help(m);
3635 show_snapshot_percpu_help(m);
3638 /* Should never be called */
3639 static inline void print_snapshot_help(struct seq_file *m, struct trace_iterator *iter) { }
3642 static int s_show(struct seq_file *m, void *v)
3644 struct trace_iterator *iter = v;
3647 if (iter->ent == NULL) {
3649 seq_printf(m, "# tracer: %s\n", iter->trace->name);
3651 test_ftrace_alive(m);
3653 if (iter->snapshot && trace_empty(iter))
3654 print_snapshot_help(m, iter);
3655 else if (iter->trace && iter->trace->print_header)
3656 iter->trace->print_header(m);
3658 trace_default_header(m);
3660 } else if (iter->leftover) {
3662 * If we filled the seq_file buffer earlier, we
3663 * want to just show it now.
3665 ret = trace_print_seq(m, &iter->seq);
3667 /* ret should this time be zero, but you never know */
3668 iter->leftover = ret;
3671 print_trace_line(iter);
3672 ret = trace_print_seq(m, &iter->seq);
3674 * If we overflow the seq_file buffer, then it will
3675 * ask us for this data again at start up.
3677 * ret is 0 if seq_file write succeeded.
3680 iter->leftover = ret;
3687 * Should be used after trace_array_get(), trace_types_lock
3688 * ensures that i_cdev was already initialized.
3690 static inline int tracing_get_cpu(struct inode *inode)
3692 if (inode->i_cdev) /* See trace_create_cpu_file() */
3693 return (long)inode->i_cdev - 1;
3694 return RING_BUFFER_ALL_CPUS;
3697 static const struct seq_operations tracer_seq_ops = {
3704 static struct trace_iterator *
3705 __tracing_open(struct inode *inode, struct file *file, bool snapshot)
3707 struct trace_array *tr = inode->i_private;
3708 struct trace_iterator *iter;
3711 if (tracing_disabled)
3712 return ERR_PTR(-ENODEV);
3714 iter = __seq_open_private(file, &tracer_seq_ops, sizeof(*iter));
3716 return ERR_PTR(-ENOMEM);
3718 iter->buffer_iter = kcalloc(nr_cpu_ids, sizeof(*iter->buffer_iter),
3720 if (!iter->buffer_iter)
3724 * We make a copy of the current tracer to avoid concurrent
3725 * changes on it while we are reading.
3727 mutex_lock(&trace_types_lock);
3728 iter->trace = kzalloc(sizeof(*iter->trace), GFP_KERNEL);
3732 *iter->trace = *tr->current_trace;
3734 if (!zalloc_cpumask_var(&iter->started, GFP_KERNEL))
3739 #ifdef CONFIG_TRACER_MAX_TRACE
3740 /* Currently only the top directory has a snapshot */
3741 if (tr->current_trace->print_max || snapshot)
3742 iter->trace_buffer = &tr->max_buffer;
3745 iter->trace_buffer = &tr->trace_buffer;
3746 iter->snapshot = snapshot;
3748 iter->cpu_file = tracing_get_cpu(inode);
3749 mutex_init(&iter->mutex);
3751 /* Notify the tracer early; before we stop tracing. */
3752 if (iter->trace && iter->trace->open)
3753 iter->trace->open(iter);
3755 /* Annotate start of buffers if we had overruns */
3756 if (ring_buffer_overruns(iter->trace_buffer->buffer))
3757 iter->iter_flags |= TRACE_FILE_ANNOTATE;
3759 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
3760 if (trace_clocks[tr->clock_id].in_ns)
3761 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
3763 /* stop the trace while dumping if we are not opening "snapshot" */
3764 if (!iter->snapshot)
3765 tracing_stop_tr(tr);
3767 if (iter->cpu_file == RING_BUFFER_ALL_CPUS) {
3768 for_each_tracing_cpu(cpu) {
3769 iter->buffer_iter[cpu] =
3770 ring_buffer_read_prepare(iter->trace_buffer->buffer, cpu);
3772 ring_buffer_read_prepare_sync();
3773 for_each_tracing_cpu(cpu) {
3774 ring_buffer_read_start(iter->buffer_iter[cpu]);
3775 tracing_iter_reset(iter, cpu);
3778 cpu = iter->cpu_file;
3779 iter->buffer_iter[cpu] =
3780 ring_buffer_read_prepare(iter->trace_buffer->buffer, cpu);
3781 ring_buffer_read_prepare_sync();
3782 ring_buffer_read_start(iter->buffer_iter[cpu]);
3783 tracing_iter_reset(iter, cpu);
3786 mutex_unlock(&trace_types_lock);
3791 mutex_unlock(&trace_types_lock);
3793 kfree(iter->buffer_iter);
3795 seq_release_private(inode, file);
3796 return ERR_PTR(-ENOMEM);
3799 int tracing_open_generic(struct inode *inode, struct file *filp)
3801 if (tracing_disabled)
3804 filp->private_data = inode->i_private;
3808 bool tracing_is_disabled(void)
3810 return (tracing_disabled) ? true: false;
3814 * Open and update trace_array ref count.
3815 * Must have the current trace_array passed to it.
3817 static int tracing_open_generic_tr(struct inode *inode, struct file *filp)
3819 struct trace_array *tr = inode->i_private;
3821 if (tracing_disabled)
3824 if (trace_array_get(tr) < 0)
3827 filp->private_data = inode->i_private;
3832 static int tracing_release(struct inode *inode, struct file *file)
3834 struct trace_array *tr = inode->i_private;
3835 struct seq_file *m = file->private_data;
3836 struct trace_iterator *iter;
3839 if (!(file->f_mode & FMODE_READ)) {
3840 trace_array_put(tr);
3844 /* Writes do not use seq_file */
3846 mutex_lock(&trace_types_lock);
3848 for_each_tracing_cpu(cpu) {
3849 if (iter->buffer_iter[cpu])
3850 ring_buffer_read_finish(iter->buffer_iter[cpu]);
3853 if (iter->trace && iter->trace->close)
3854 iter->trace->close(iter);
3856 if (!iter->snapshot)
3857 /* reenable tracing if it was previously enabled */
3858 tracing_start_tr(tr);
3860 __trace_array_put(tr);
3862 mutex_unlock(&trace_types_lock);
3864 mutex_destroy(&iter->mutex);
3865 free_cpumask_var(iter->started);
3867 kfree(iter->buffer_iter);
3868 seq_release_private(inode, file);
3873 static int tracing_release_generic_tr(struct inode *inode, struct file *file)
3875 struct trace_array *tr = inode->i_private;
3877 trace_array_put(tr);
3881 static int tracing_single_release_tr(struct inode *inode, struct file *file)
3883 struct trace_array *tr = inode->i_private;
3885 trace_array_put(tr);
3887 return single_release(inode, file);
3890 static int tracing_open(struct inode *inode, struct file *file)
3892 struct trace_array *tr = inode->i_private;
3893 struct trace_iterator *iter;
3896 if (trace_array_get(tr) < 0)
3899 /* If this file was open for write, then erase contents */
3900 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
3901 int cpu = tracing_get_cpu(inode);
3903 if (cpu == RING_BUFFER_ALL_CPUS)
3904 tracing_reset_online_cpus(&tr->trace_buffer);
3906 tracing_reset(&tr->trace_buffer, cpu);
3909 if (file->f_mode & FMODE_READ) {
3910 iter = __tracing_open(inode, file, false);
3912 ret = PTR_ERR(iter);
3913 else if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
3914 iter->iter_flags |= TRACE_FILE_LAT_FMT;
3918 trace_array_put(tr);
3924 * Some tracers are not suitable for instance buffers.
3925 * A tracer is always available for the global array (toplevel)
3926 * or if it explicitly states that it is.
3929 trace_ok_for_array(struct tracer *t, struct trace_array *tr)
3931 return (tr->flags & TRACE_ARRAY_FL_GLOBAL) || t->allow_instances;
3934 /* Find the next tracer that this trace array may use */
3935 static struct tracer *
3936 get_tracer_for_array(struct trace_array *tr, struct tracer *t)
3938 while (t && !trace_ok_for_array(t, tr))
3945 t_next(struct seq_file *m, void *v, loff_t *pos)
3947 struct trace_array *tr = m->private;
3948 struct tracer *t = v;
3953 t = get_tracer_for_array(tr, t->next);
3958 static void *t_start(struct seq_file *m, loff_t *pos)
3960 struct trace_array *tr = m->private;
3964 mutex_lock(&trace_types_lock);
3966 t = get_tracer_for_array(tr, trace_types);
3967 for (; t && l < *pos; t = t_next(m, t, &l))
3973 static void t_stop(struct seq_file *m, void *p)
3975 mutex_unlock(&trace_types_lock);
3978 static int t_show(struct seq_file *m, void *v)
3980 struct tracer *t = v;
3985 seq_puts(m, t->name);
3994 static const struct seq_operations show_traces_seq_ops = {
4001 static int show_traces_open(struct inode *inode, struct file *file)
4003 struct trace_array *tr = inode->i_private;
4007 if (tracing_disabled)
4010 ret = seq_open(file, &show_traces_seq_ops);
4014 m = file->private_data;
4021 tracing_write_stub(struct file *filp, const char __user *ubuf,
4022 size_t count, loff_t *ppos)
4027 loff_t tracing_lseek(struct file *file, loff_t offset, int whence)
4031 if (file->f_mode & FMODE_READ)
4032 ret = seq_lseek(file, offset, whence);
4034 file->f_pos = ret = 0;
4039 static const struct file_operations tracing_fops = {
4040 .open = tracing_open,
4042 .write = tracing_write_stub,
4043 .llseek = tracing_lseek,
4044 .release = tracing_release,
4047 static const struct file_operations show_traces_fops = {
4048 .open = show_traces_open,
4050 .release = seq_release,
4051 .llseek = seq_lseek,
4055 * The tracer itself will not take this lock, but still we want
4056 * to provide a consistent cpumask to user-space:
4058 static DEFINE_MUTEX(tracing_cpumask_update_lock);
4061 * Temporary storage for the character representation of the
4062 * CPU bitmask (and one more byte for the newline):
4064 static char mask_str[NR_CPUS + 1];
4067 tracing_cpumask_read(struct file *filp, char __user *ubuf,
4068 size_t count, loff_t *ppos)
4070 struct trace_array *tr = file_inode(filp)->i_private;
4073 mutex_lock(&tracing_cpumask_update_lock);
4075 len = snprintf(mask_str, count, "%*pb\n",
4076 cpumask_pr_args(tr->tracing_cpumask));
4081 count = simple_read_from_buffer(ubuf, count, ppos, mask_str, NR_CPUS+1);
4084 mutex_unlock(&tracing_cpumask_update_lock);
4090 tracing_cpumask_write(struct file *filp, const char __user *ubuf,
4091 size_t count, loff_t *ppos)
4093 struct trace_array *tr = file_inode(filp)->i_private;
4094 cpumask_var_t tracing_cpumask_new;
4097 if (!alloc_cpumask_var(&tracing_cpumask_new, GFP_KERNEL))
4100 err = cpumask_parse_user(ubuf, count, tracing_cpumask_new);
4104 mutex_lock(&tracing_cpumask_update_lock);
4106 local_irq_disable();
4107 arch_spin_lock(&tr->max_lock);
4108 for_each_tracing_cpu(cpu) {
4110 * Increase/decrease the disabled counter if we are
4111 * about to flip a bit in the cpumask:
4113 if (cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
4114 !cpumask_test_cpu(cpu, tracing_cpumask_new)) {
4115 atomic_inc(&per_cpu_ptr(tr->trace_buffer.data, cpu)->disabled);
4116 ring_buffer_record_disable_cpu(tr->trace_buffer.buffer, cpu);
4118 if (!cpumask_test_cpu(cpu, tr->tracing_cpumask) &&
4119 cpumask_test_cpu(cpu, tracing_cpumask_new)) {
4120 atomic_dec(&per_cpu_ptr(tr->trace_buffer.data, cpu)->disabled);
4121 ring_buffer_record_enable_cpu(tr->trace_buffer.buffer, cpu);
4124 arch_spin_unlock(&tr->max_lock);
4127 cpumask_copy(tr->tracing_cpumask, tracing_cpumask_new);
4129 mutex_unlock(&tracing_cpumask_update_lock);
4130 free_cpumask_var(tracing_cpumask_new);
4135 free_cpumask_var(tracing_cpumask_new);
4140 static const struct file_operations tracing_cpumask_fops = {
4141 .open = tracing_open_generic_tr,
4142 .read = tracing_cpumask_read,
4143 .write = tracing_cpumask_write,
4144 .release = tracing_release_generic_tr,
4145 .llseek = generic_file_llseek,
4148 static int tracing_trace_options_show(struct seq_file *m, void *v)
4150 struct tracer_opt *trace_opts;
4151 struct trace_array *tr = m->private;
4155 mutex_lock(&trace_types_lock);
4156 tracer_flags = tr->current_trace->flags->val;
4157 trace_opts = tr->current_trace->flags->opts;
4159 for (i = 0; trace_options[i]; i++) {
4160 if (tr->trace_flags & (1 << i))
4161 seq_printf(m, "%s\n", trace_options[i]);
4163 seq_printf(m, "no%s\n", trace_options[i]);
4166 for (i = 0; trace_opts[i].name; i++) {
4167 if (tracer_flags & trace_opts[i].bit)
4168 seq_printf(m, "%s\n", trace_opts[i].name);
4170 seq_printf(m, "no%s\n", trace_opts[i].name);
4172 mutex_unlock(&trace_types_lock);
4177 static int __set_tracer_option(struct trace_array *tr,
4178 struct tracer_flags *tracer_flags,
4179 struct tracer_opt *opts, int neg)
4181 struct tracer *trace = tracer_flags->trace;
4184 ret = trace->set_flag(tr, tracer_flags->val, opts->bit, !neg);
4189 tracer_flags->val &= ~opts->bit;
4191 tracer_flags->val |= opts->bit;
4195 /* Try to assign a tracer specific option */
4196 static int set_tracer_option(struct trace_array *tr, char *cmp, int neg)
4198 struct tracer *trace = tr->current_trace;
4199 struct tracer_flags *tracer_flags = trace->flags;
4200 struct tracer_opt *opts = NULL;
4203 for (i = 0; tracer_flags->opts[i].name; i++) {
4204 opts = &tracer_flags->opts[i];
4206 if (strcmp(cmp, opts->name) == 0)
4207 return __set_tracer_option(tr, trace->flags, opts, neg);
4213 /* Some tracers require overwrite to stay enabled */
4214 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set)
4216 if (tracer->enabled && (mask & TRACE_ITER_OVERWRITE) && !set)
4222 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled)
4224 /* do nothing if flag is already set */
4225 if (!!(tr->trace_flags & mask) == !!enabled)
4228 /* Give the tracer a chance to approve the change */
4229 if (tr->current_trace->flag_changed)
4230 if (tr->current_trace->flag_changed(tr, mask, !!enabled))
4234 tr->trace_flags |= mask;
4236 tr->trace_flags &= ~mask;
4238 if (mask == TRACE_ITER_RECORD_CMD)
4239 trace_event_enable_cmd_record(enabled);
4241 if (mask == TRACE_ITER_EVENT_FORK)
4242 trace_event_follow_fork(tr, enabled);
4244 if (mask == TRACE_ITER_FUNC_FORK)
4245 ftrace_pid_follow_fork(tr, enabled);
4247 if (mask == TRACE_ITER_OVERWRITE) {
4248 ring_buffer_change_overwrite(tr->trace_buffer.buffer, enabled);
4249 #ifdef CONFIG_TRACER_MAX_TRACE
4250 ring_buffer_change_overwrite(tr->max_buffer.buffer, enabled);
4254 if (mask == TRACE_ITER_PRINTK) {
4255 trace_printk_start_stop_comm(enabled);
4256 trace_printk_control(enabled);
4262 static int trace_set_options(struct trace_array *tr, char *option)
4268 size_t orig_len = strlen(option);
4270 cmp = strstrip(option);
4272 if (strncmp(cmp, "no", 2) == 0) {
4277 mutex_lock(&trace_types_lock);
4279 for (i = 0; trace_options[i]; i++) {
4280 if (strcmp(cmp, trace_options[i]) == 0) {
4281 ret = set_tracer_flag(tr, 1 << i, !neg);
4286 /* If no option could be set, test the specific tracer options */
4287 if (!trace_options[i])
4288 ret = set_tracer_option(tr, cmp, neg);
4290 mutex_unlock(&trace_types_lock);
4293 * If the first trailing whitespace is replaced with '\0' by strstrip,
4294 * turn it back into a space.
4296 if (orig_len > strlen(option))
4297 option[strlen(option)] = ' ';
4302 static void __init apply_trace_boot_options(void)
4304 char *buf = trace_boot_options_buf;
4308 option = strsep(&buf, ",");
4314 trace_set_options(&global_trace, option);
4316 /* Put back the comma to allow this to be called again */
4323 tracing_trace_options_write(struct file *filp, const char __user *ubuf,
4324 size_t cnt, loff_t *ppos)
4326 struct seq_file *m = filp->private_data;
4327 struct trace_array *tr = m->private;
4331 if (cnt >= sizeof(buf))
4334 if (copy_from_user(buf, ubuf, cnt))
4339 ret = trace_set_options(tr, buf);
4348 static int tracing_trace_options_open(struct inode *inode, struct file *file)
4350 struct trace_array *tr = inode->i_private;
4353 if (tracing_disabled)
4356 if (trace_array_get(tr) < 0)
4359 ret = single_open(file, tracing_trace_options_show, inode->i_private);
4361 trace_array_put(tr);
4366 static const struct file_operations tracing_iter_fops = {
4367 .open = tracing_trace_options_open,
4369 .llseek = seq_lseek,
4370 .release = tracing_single_release_tr,
4371 .write = tracing_trace_options_write,
4374 static const char readme_msg[] =
4375 "tracing mini-HOWTO:\n\n"
4376 "# echo 0 > tracing_on : quick way to disable tracing\n"
4377 "# echo 1 > tracing_on : quick way to re-enable tracing\n\n"
4378 " Important files:\n"
4379 " trace\t\t\t- The static contents of the buffer\n"
4380 "\t\t\t To clear the buffer write into this file: echo > trace\n"
4381 " trace_pipe\t\t- A consuming read to see the contents of the buffer\n"
4382 " current_tracer\t- function and latency tracers\n"
4383 " available_tracers\t- list of configured tracers for current_tracer\n"
4384 " buffer_size_kb\t- view and modify size of per cpu buffer\n"
4385 " buffer_total_size_kb - view total size of all cpu buffers\n\n"
4386 " trace_clock\t\t-change the clock used to order events\n"
4387 " local: Per cpu clock but may not be synced across CPUs\n"
4388 " global: Synced across CPUs but slows tracing down.\n"
4389 " counter: Not a clock, but just an increment\n"
4390 " uptime: Jiffy counter from time of boot\n"
4391 " perf: Same clock that perf events use\n"
4392 #ifdef CONFIG_X86_64
4393 " x86-tsc: TSC cycle counter\n"
4395 "\n trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
4396 "\n trace_marker_raw\t\t- Writes into this file writes binary data into the kernel buffer\n"
4397 " tracing_cpumask\t- Limit which CPUs to trace\n"
4398 " instances\t\t- Make sub-buffers with: mkdir instances/foo\n"
4399 "\t\t\t Remove sub-buffer with rmdir\n"
4400 " trace_options\t\t- Set format or modify how tracing happens\n"
4401 "\t\t\t Disable an option by adding a suffix 'no' to the\n"
4402 "\t\t\t option name\n"
4403 " saved_cmdlines_size\t- echo command number in here to store comm-pid list\n"
4404 #ifdef CONFIG_DYNAMIC_FTRACE
4405 "\n available_filter_functions - list of functions that can be filtered on\n"
4406 " set_ftrace_filter\t- echo function name in here to only trace these\n"
4407 "\t\t\t functions\n"
4408 "\t accepts: func_full_name or glob-matching-pattern\n"
4409 "\t modules: Can select a group via module\n"
4410 "\t Format: :mod:<module-name>\n"
4411 "\t example: echo :mod:ext3 > set_ftrace_filter\n"
4412 "\t triggers: a command to perform when function is hit\n"
4413 "\t Format: <function>:<trigger>[:count]\n"
4414 "\t trigger: traceon, traceoff\n"
4415 "\t\t enable_event:<system>:<event>\n"
4416 "\t\t disable_event:<system>:<event>\n"
4417 #ifdef CONFIG_STACKTRACE
4420 #ifdef CONFIG_TRACER_SNAPSHOT
4425 "\t example: echo do_fault:traceoff > set_ftrace_filter\n"
4426 "\t echo do_trap:traceoff:3 > set_ftrace_filter\n"
4427 "\t The first one will disable tracing every time do_fault is hit\n"
4428 "\t The second will disable tracing at most 3 times when do_trap is hit\n"
4429 "\t The first time do trap is hit and it disables tracing, the\n"
4430 "\t counter will decrement to 2. If tracing is already disabled,\n"
4431 "\t the counter will not decrement. It only decrements when the\n"
4432 "\t trigger did work\n"
4433 "\t To remove trigger without count:\n"
4434 "\t echo '!<function>:<trigger> > set_ftrace_filter\n"
4435 "\t To remove trigger with a count:\n"
4436 "\t echo '!<function>:<trigger>:0 > set_ftrace_filter\n"
4437 " set_ftrace_notrace\t- echo function name in here to never trace.\n"
4438 "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n"
4439 "\t modules: Can select a group via module command :mod:\n"
4440 "\t Does not accept triggers\n"
4441 #endif /* CONFIG_DYNAMIC_FTRACE */
4442 #ifdef CONFIG_FUNCTION_TRACER
4443 " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n"
4446 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
4447 " set_graph_function\t- Trace the nested calls of a function (function_graph)\n"
4448 " set_graph_notrace\t- Do not trace the nested calls of a function (function_graph)\n"
4449 " max_graph_depth\t- Trace a limited depth of nested calls (0 is unlimited)\n"
4451 #ifdef CONFIG_TRACER_SNAPSHOT
4452 "\n snapshot\t\t- Like 'trace' but shows the content of the static\n"
4453 "\t\t\t snapshot buffer. Read the contents for more\n"
4454 "\t\t\t information\n"
4456 #ifdef CONFIG_STACK_TRACER
4457 " stack_trace\t\t- Shows the max stack trace when active\n"
4458 " stack_max_size\t- Shows current max stack size that was traced\n"
4459 "\t\t\t Write into this file to reset the max size (trigger a\n"
4460 "\t\t\t new trace)\n"
4461 #ifdef CONFIG_DYNAMIC_FTRACE
4462 " stack_trace_filter\t- Like set_ftrace_filter but limits what stack_trace\n"
4465 #endif /* CONFIG_STACK_TRACER */
4466 #ifdef CONFIG_KPROBE_EVENTS
4467 " kprobe_events\t\t- Add/remove/show the kernel dynamic events\n"
4468 "\t\t\t Write into this file to define/undefine new trace events.\n"
4470 #ifdef CONFIG_UPROBE_EVENTS
4471 " uprobe_events\t\t- Add/remove/show the userspace dynamic events\n"
4472 "\t\t\t Write into this file to define/undefine new trace events.\n"
4474 #if defined(CONFIG_KPROBE_EVENTS) || defined(CONFIG_UPROBE_EVENTS)
4475 "\t accepts: event-definitions (one definition per line)\n"
4476 "\t Format: p|r[:[<group>/]<event>] <place> [<args>]\n"
4477 "\t -:[<group>/]<event>\n"
4478 #ifdef CONFIG_KPROBE_EVENTS
4479 "\t place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
4480 "place (kretprobe): [<module>:]<symbol>[+<offset>]|<memaddr>\n"
4482 #ifdef CONFIG_UPROBE_EVENTS
4483 "\t place: <path>:<offset>\n"
4485 "\t args: <name>=fetcharg[:type]\n"
4486 "\t fetcharg: %<register>, @<address>, @<symbol>[+|-<offset>],\n"
4487 "\t $stack<index>, $stack, $retval, $comm\n"
4488 "\t type: s8/16/32/64, u8/16/32/64, x8/16/32/64, string,\n"
4489 "\t b<bit-width>@<bit-offset>/<container-size>\n"
4491 " events/\t\t- Directory containing all trace event subsystems:\n"
4492 " enable\t\t- Write 0/1 to enable/disable tracing of all events\n"
4493 " events/<system>/\t- Directory containing all trace events for <system>:\n"
4494 " enable\t\t- Write 0/1 to enable/disable tracing of all <system>\n"
4496 " filter\t\t- If set, only events passing filter are traced\n"
4497 " events/<system>/<event>/\t- Directory containing control files for\n"
4499 " enable\t\t- Write 0/1 to enable/disable tracing of <event>\n"
4500 " filter\t\t- If set, only events passing filter are traced\n"
4501 " trigger\t\t- If set, a command to perform when event is hit\n"
4502 "\t Format: <trigger>[:count][if <filter>]\n"
4503 "\t trigger: traceon, traceoff\n"
4504 "\t enable_event:<system>:<event>\n"
4505 "\t disable_event:<system>:<event>\n"
4506 #ifdef CONFIG_HIST_TRIGGERS
4507 "\t enable_hist:<system>:<event>\n"
4508 "\t disable_hist:<system>:<event>\n"
4510 #ifdef CONFIG_STACKTRACE
4513 #ifdef CONFIG_TRACER_SNAPSHOT
4516 #ifdef CONFIG_HIST_TRIGGERS
4517 "\t\t hist (see below)\n"
4519 "\t example: echo traceoff > events/block/block_unplug/trigger\n"
4520 "\t echo traceoff:3 > events/block/block_unplug/trigger\n"
4521 "\t echo 'enable_event:kmem:kmalloc:3 if nr_rq > 1' > \\\n"
4522 "\t events/block/block_unplug/trigger\n"
4523 "\t The first disables tracing every time block_unplug is hit.\n"
4524 "\t The second disables tracing the first 3 times block_unplug is hit.\n"
4525 "\t The third enables the kmalloc event the first 3 times block_unplug\n"
4526 "\t is hit and has value of greater than 1 for the 'nr_rq' event field.\n"
4527 "\t Like function triggers, the counter is only decremented if it\n"
4528 "\t enabled or disabled tracing.\n"
4529 "\t To remove a trigger without a count:\n"
4530 "\t echo '!<trigger> > <system>/<event>/trigger\n"
4531 "\t To remove a trigger with a count:\n"
4532 "\t echo '!<trigger>:0 > <system>/<event>/trigger\n"
4533 "\t Filters can be ignored when removing a trigger.\n"
4534 #ifdef CONFIG_HIST_TRIGGERS
4535 " hist trigger\t- If set, event hits are aggregated into a hash table\n"
4536 "\t Format: hist:keys=<field1[,field2,...]>\n"
4537 "\t [:values=<field1[,field2,...]>]\n"
4538 "\t [:sort=<field1[,field2,...]>]\n"
4539 "\t [:size=#entries]\n"
4540 "\t [:pause][:continue][:clear]\n"
4541 "\t [:name=histname1]\n"
4542 "\t [if <filter>]\n\n"
4543 "\t When a matching event is hit, an entry is added to a hash\n"
4544 "\t table using the key(s) and value(s) named, and the value of a\n"
4545 "\t sum called 'hitcount' is incremented. Keys and values\n"
4546 "\t correspond to fields in the event's format description. Keys\n"
4547 "\t can be any field, or the special string 'stacktrace'.\n"
4548 "\t Compound keys consisting of up to two fields can be specified\n"
4549 "\t by the 'keys' keyword. Values must correspond to numeric\n"
4550 "\t fields. Sort keys consisting of up to two fields can be\n"
4551 "\t specified using the 'sort' keyword. The sort direction can\n"
4552 "\t be modified by appending '.descending' or '.ascending' to a\n"
4553 "\t sort field. The 'size' parameter can be used to specify more\n"
4554 "\t or fewer than the default 2048 entries for the hashtable size.\n"
4555 "\t If a hist trigger is given a name using the 'name' parameter,\n"
4556 "\t its histogram data will be shared with other triggers of the\n"
4557 "\t same name, and trigger hits will update this common data.\n\n"
4558 "\t Reading the 'hist' file for the event will dump the hash\n"
4559 "\t table in its entirety to stdout. If there are multiple hist\n"
4560 "\t triggers attached to an event, there will be a table for each\n"
4561 "\t trigger in the output. The table displayed for a named\n"
4562 "\t trigger will be the same as any other instance having the\n"
4563 "\t same name. The default format used to display a given field\n"
4564 "\t can be modified by appending any of the following modifiers\n"
4565 "\t to the field name, as applicable:\n\n"
4566 "\t .hex display a number as a hex value\n"
4567 "\t .sym display an address as a symbol\n"
4568 "\t .sym-offset display an address as a symbol and offset\n"
4569 "\t .execname display a common_pid as a program name\n"
4570 "\t .syscall display a syscall id as a syscall name\n\n"
4571 "\t .log2 display log2 value rather than raw number\n\n"
4572 "\t The 'pause' parameter can be used to pause an existing hist\n"
4573 "\t trigger or to start a hist trigger but not log any events\n"
4574 "\t until told to do so. 'continue' can be used to start or\n"
4575 "\t restart a paused hist trigger.\n\n"
4576 "\t The 'clear' parameter will clear the contents of a running\n"
4577 "\t hist trigger and leave its current paused/active state\n"
4579 "\t The enable_hist and disable_hist triggers can be used to\n"
4580 "\t have one event conditionally start and stop another event's\n"
4581 "\t already-attached hist trigger. The syntax is analagous to\n"
4582 "\t the enable_event and disable_event triggers.\n"
4587 tracing_readme_read(struct file *filp, char __user *ubuf,
4588 size_t cnt, loff_t *ppos)
4590 return simple_read_from_buffer(ubuf, cnt, ppos,
4591 readme_msg, strlen(readme_msg));
4594 static const struct file_operations tracing_readme_fops = {
4595 .open = tracing_open_generic,
4596 .read = tracing_readme_read,
4597 .llseek = generic_file_llseek,
4600 static void *saved_cmdlines_next(struct seq_file *m, void *v, loff_t *pos)
4602 unsigned int *ptr = v;
4604 if (*pos || m->count)
4609 for (; ptr < &savedcmd->map_cmdline_to_pid[savedcmd->cmdline_num];
4611 if (*ptr == -1 || *ptr == NO_CMDLINE_MAP)
4620 static void *saved_cmdlines_start(struct seq_file *m, loff_t *pos)
4626 arch_spin_lock(&trace_cmdline_lock);
4628 v = &savedcmd->map_cmdline_to_pid[0];
4630 v = saved_cmdlines_next(m, v, &l);
4638 static void saved_cmdlines_stop(struct seq_file *m, void *v)
4640 arch_spin_unlock(&trace_cmdline_lock);
4644 static int saved_cmdlines_show(struct seq_file *m, void *v)
4646 char buf[TASK_COMM_LEN];
4647 unsigned int *pid = v;
4649 __trace_find_cmdline(*pid, buf);
4650 seq_printf(m, "%d %s\n", *pid, buf);
4654 static const struct seq_operations tracing_saved_cmdlines_seq_ops = {
4655 .start = saved_cmdlines_start,
4656 .next = saved_cmdlines_next,
4657 .stop = saved_cmdlines_stop,
4658 .show = saved_cmdlines_show,
4661 static int tracing_saved_cmdlines_open(struct inode *inode, struct file *filp)
4663 if (tracing_disabled)
4666 return seq_open(filp, &tracing_saved_cmdlines_seq_ops);
4669 static const struct file_operations tracing_saved_cmdlines_fops = {
4670 .open = tracing_saved_cmdlines_open,
4672 .llseek = seq_lseek,
4673 .release = seq_release,
4677 tracing_saved_cmdlines_size_read(struct file *filp, char __user *ubuf,
4678 size_t cnt, loff_t *ppos)
4683 arch_spin_lock(&trace_cmdline_lock);
4684 r = scnprintf(buf, sizeof(buf), "%u\n", savedcmd->cmdline_num);
4685 arch_spin_unlock(&trace_cmdline_lock);
4687 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
4690 static void free_saved_cmdlines_buffer(struct saved_cmdlines_buffer *s)
4692 kfree(s->saved_cmdlines);
4693 kfree(s->map_cmdline_to_pid);
4697 static int tracing_resize_saved_cmdlines(unsigned int val)
4699 struct saved_cmdlines_buffer *s, *savedcmd_temp;
4701 s = kmalloc(sizeof(*s), GFP_KERNEL);
4705 if (allocate_cmdlines_buffer(val, s) < 0) {
4710 arch_spin_lock(&trace_cmdline_lock);
4711 savedcmd_temp = savedcmd;
4713 arch_spin_unlock(&trace_cmdline_lock);
4714 free_saved_cmdlines_buffer(savedcmd_temp);
4720 tracing_saved_cmdlines_size_write(struct file *filp, const char __user *ubuf,
4721 size_t cnt, loff_t *ppos)
4726 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
4730 /* must have at least 1 entry or less than PID_MAX_DEFAULT */
4731 if (!val || val > PID_MAX_DEFAULT)
4734 ret = tracing_resize_saved_cmdlines((unsigned int)val);
4743 static const struct file_operations tracing_saved_cmdlines_size_fops = {
4744 .open = tracing_open_generic,
4745 .read = tracing_saved_cmdlines_size_read,
4746 .write = tracing_saved_cmdlines_size_write,
4749 #ifdef CONFIG_TRACE_ENUM_MAP_FILE
4750 static union trace_enum_map_item *
4751 update_enum_map(union trace_enum_map_item *ptr)
4753 if (!ptr->map.enum_string) {
4754 if (ptr->tail.next) {
4755 ptr = ptr->tail.next;
4756 /* Set ptr to the next real item (skip head) */
4764 static void *enum_map_next(struct seq_file *m, void *v, loff_t *pos)
4766 union trace_enum_map_item *ptr = v;
4769 * Paranoid! If ptr points to end, we don't want to increment past it.
4770 * This really should never happen.
4772 ptr = update_enum_map(ptr);
4773 if (WARN_ON_ONCE(!ptr))
4780 ptr = update_enum_map(ptr);
4785 static void *enum_map_start(struct seq_file *m, loff_t *pos)
4787 union trace_enum_map_item *v;
4790 mutex_lock(&trace_enum_mutex);
4792 v = trace_enum_maps;
4796 while (v && l < *pos) {
4797 v = enum_map_next(m, v, &l);
4803 static void enum_map_stop(struct seq_file *m, void *v)
4805 mutex_unlock(&trace_enum_mutex);
4808 static int enum_map_show(struct seq_file *m, void *v)
4810 union trace_enum_map_item *ptr = v;
4812 seq_printf(m, "%s %ld (%s)\n",
4813 ptr->map.enum_string, ptr->map.enum_value,
4819 static const struct seq_operations tracing_enum_map_seq_ops = {
4820 .start = enum_map_start,
4821 .next = enum_map_next,
4822 .stop = enum_map_stop,
4823 .show = enum_map_show,
4826 static int tracing_enum_map_open(struct inode *inode, struct file *filp)
4828 if (tracing_disabled)
4831 return seq_open(filp, &tracing_enum_map_seq_ops);
4834 static const struct file_operations tracing_enum_map_fops = {
4835 .open = tracing_enum_map_open,
4837 .llseek = seq_lseek,
4838 .release = seq_release,
4841 static inline union trace_enum_map_item *
4842 trace_enum_jmp_to_tail(union trace_enum_map_item *ptr)
4844 /* Return tail of array given the head */
4845 return ptr + ptr->head.length + 1;
4849 trace_insert_enum_map_file(struct module *mod, struct trace_enum_map **start,
4852 struct trace_enum_map **stop;
4853 struct trace_enum_map **map;
4854 union trace_enum_map_item *map_array;
4855 union trace_enum_map_item *ptr;
4860 * The trace_enum_maps contains the map plus a head and tail item,
4861 * where the head holds the module and length of array, and the
4862 * tail holds a pointer to the next list.
4864 map_array = kmalloc(sizeof(*map_array) * (len + 2), GFP_KERNEL);
4866 pr_warn("Unable to allocate trace enum mapping\n");
4870 mutex_lock(&trace_enum_mutex);
4872 if (!trace_enum_maps)
4873 trace_enum_maps = map_array;
4875 ptr = trace_enum_maps;
4877 ptr = trace_enum_jmp_to_tail(ptr);
4878 if (!ptr->tail.next)
4880 ptr = ptr->tail.next;
4883 ptr->tail.next = map_array;
4885 map_array->head.mod = mod;
4886 map_array->head.length = len;
4889 for (map = start; (unsigned long)map < (unsigned long)stop; map++) {
4890 map_array->map = **map;
4893 memset(map_array, 0, sizeof(*map_array));
4895 mutex_unlock(&trace_enum_mutex);
4898 static void trace_create_enum_file(struct dentry *d_tracer)
4900 trace_create_file("enum_map", 0444, d_tracer,
4901 NULL, &tracing_enum_map_fops);
4904 #else /* CONFIG_TRACE_ENUM_MAP_FILE */
4905 static inline void trace_create_enum_file(struct dentry *d_tracer) { }
4906 static inline void trace_insert_enum_map_file(struct module *mod,
4907 struct trace_enum_map **start, int len) { }
4908 #endif /* !CONFIG_TRACE_ENUM_MAP_FILE */
4910 static void trace_insert_enum_map(struct module *mod,
4911 struct trace_enum_map **start, int len)
4913 struct trace_enum_map **map;
4920 trace_event_enum_update(map, len);
4922 trace_insert_enum_map_file(mod, start, len);
4926 tracing_set_trace_read(struct file *filp, char __user *ubuf,
4927 size_t cnt, loff_t *ppos)
4929 struct trace_array *tr = filp->private_data;
4930 char buf[MAX_TRACER_SIZE+2];
4933 mutex_lock(&trace_types_lock);
4934 r = sprintf(buf, "%s\n", tr->current_trace->name);
4935 mutex_unlock(&trace_types_lock);
4937 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
4940 int tracer_init(struct tracer *t, struct trace_array *tr)
4942 tracing_reset_online_cpus(&tr->trace_buffer);
4946 static void set_buffer_entries(struct trace_buffer *buf, unsigned long val)
4950 for_each_tracing_cpu(cpu)
4951 per_cpu_ptr(buf->data, cpu)->entries = val;
4954 #ifdef CONFIG_TRACER_MAX_TRACE
4955 /* resize @tr's buffer to the size of @size_tr's entries */
4956 static int resize_buffer_duplicate_size(struct trace_buffer *trace_buf,
4957 struct trace_buffer *size_buf, int cpu_id)
4961 if (cpu_id == RING_BUFFER_ALL_CPUS) {
4962 for_each_tracing_cpu(cpu) {
4963 ret = ring_buffer_resize(trace_buf->buffer,
4964 per_cpu_ptr(size_buf->data, cpu)->entries, cpu);
4967 per_cpu_ptr(trace_buf->data, cpu)->entries =
4968 per_cpu_ptr(size_buf->data, cpu)->entries;
4971 ret = ring_buffer_resize(trace_buf->buffer,
4972 per_cpu_ptr(size_buf->data, cpu_id)->entries, cpu_id);
4974 per_cpu_ptr(trace_buf->data, cpu_id)->entries =
4975 per_cpu_ptr(size_buf->data, cpu_id)->entries;
4980 #endif /* CONFIG_TRACER_MAX_TRACE */
4982 static int __tracing_resize_ring_buffer(struct trace_array *tr,
4983 unsigned long size, int cpu)
4988 * If kernel or user changes the size of the ring buffer
4989 * we use the size that was given, and we can forget about
4990 * expanding it later.
4992 ring_buffer_expanded = true;
4994 /* May be called before buffers are initialized */
4995 if (!tr->trace_buffer.buffer)
4998 ret = ring_buffer_resize(tr->trace_buffer.buffer, size, cpu);
5002 #ifdef CONFIG_TRACER_MAX_TRACE
5003 if (!(tr->flags & TRACE_ARRAY_FL_GLOBAL) ||
5004 !tr->current_trace->use_max_tr)
5007 ret = ring_buffer_resize(tr->max_buffer.buffer, size, cpu);
5009 int r = resize_buffer_duplicate_size(&tr->trace_buffer,
5010 &tr->trace_buffer, cpu);
5013 * AARGH! We are left with different
5014 * size max buffer!!!!
5015 * The max buffer is our "snapshot" buffer.
5016 * When a tracer needs a snapshot (one of the
5017 * latency tracers), it swaps the max buffer
5018 * with the saved snap shot. We succeeded to
5019 * update the size of the main buffer, but failed to
5020 * update the size of the max buffer. But when we tried
5021 * to reset the main buffer to the original size, we
5022 * failed there too. This is very unlikely to
5023 * happen, but if it does, warn and kill all
5027 tracing_disabled = 1;
5032 if (cpu == RING_BUFFER_ALL_CPUS)
5033 set_buffer_entries(&tr->max_buffer, size);
5035 per_cpu_ptr(tr->max_buffer.data, cpu)->entries = size;
5038 #endif /* CONFIG_TRACER_MAX_TRACE */
5040 if (cpu == RING_BUFFER_ALL_CPUS)
5041 set_buffer_entries(&tr->trace_buffer, size);
5043 per_cpu_ptr(tr->trace_buffer.data, cpu)->entries = size;
5048 static ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
5049 unsigned long size, int cpu_id)
5053 mutex_lock(&trace_types_lock);
5055 if (cpu_id != RING_BUFFER_ALL_CPUS) {
5056 /* make sure, this cpu is enabled in the mask */
5057 if (!cpumask_test_cpu(cpu_id, tracing_buffer_mask)) {
5063 ret = __tracing_resize_ring_buffer(tr, size, cpu_id);
5068 mutex_unlock(&trace_types_lock);
5075 * tracing_update_buffers - used by tracing facility to expand ring buffers
5077 * To save on memory when the tracing is never used on a system with it
5078 * configured in. The ring buffers are set to a minimum size. But once
5079 * a user starts to use the tracing facility, then they need to grow
5080 * to their default size.
5082 * This function is to be called when a tracer is about to be used.
5084 int tracing_update_buffers(void)
5088 mutex_lock(&trace_types_lock);
5089 if (!ring_buffer_expanded)
5090 ret = __tracing_resize_ring_buffer(&global_trace, trace_buf_size,
5091 RING_BUFFER_ALL_CPUS);
5092 mutex_unlock(&trace_types_lock);
5097 struct trace_option_dentry;
5100 create_trace_option_files(struct trace_array *tr, struct tracer *tracer);
5103 * Used to clear out the tracer before deletion of an instance.
5104 * Must have trace_types_lock held.
5106 static void tracing_set_nop(struct trace_array *tr)
5108 if (tr->current_trace == &nop_trace)
5111 tr->current_trace->enabled--;
5113 if (tr->current_trace->reset)
5114 tr->current_trace->reset(tr);
5116 tr->current_trace = &nop_trace;
5119 static void add_tracer_options(struct trace_array *tr, struct tracer *t)
5121 /* Only enable if the directory has been created already. */
5125 create_trace_option_files(tr, t);
5128 static int tracing_set_tracer(struct trace_array *tr, const char *buf)
5131 #ifdef CONFIG_TRACER_MAX_TRACE
5136 mutex_lock(&trace_types_lock);
5138 if (!ring_buffer_expanded) {
5139 ret = __tracing_resize_ring_buffer(tr, trace_buf_size,
5140 RING_BUFFER_ALL_CPUS);
5146 for (t = trace_types; t; t = t->next) {
5147 if (strcmp(t->name, buf) == 0)
5154 if (t == tr->current_trace)
5157 /* Some tracers are only allowed for the top level buffer */
5158 if (!trace_ok_for_array(t, tr)) {
5163 /* If trace pipe files are being read, we can't change the tracer */
5164 if (tr->current_trace->ref) {
5169 trace_branch_disable();
5171 tr->current_trace->enabled--;
5173 if (tr->current_trace->reset)
5174 tr->current_trace->reset(tr);
5176 /* Current trace needs to be nop_trace before synchronize_sched */
5177 tr->current_trace = &nop_trace;
5179 #ifdef CONFIG_TRACER_MAX_TRACE
5180 had_max_tr = tr->allocated_snapshot;
5182 if (had_max_tr && !t->use_max_tr) {
5184 * We need to make sure that the update_max_tr sees that
5185 * current_trace changed to nop_trace to keep it from
5186 * swapping the buffers after we resize it.
5187 * The update_max_tr is called from interrupts disabled
5188 * so a synchronized_sched() is sufficient.
5190 synchronize_sched();
5195 #ifdef CONFIG_TRACER_MAX_TRACE
5196 if (t->use_max_tr && !had_max_tr) {
5197 ret = alloc_snapshot(tr);
5204 ret = tracer_init(t, tr);
5209 tr->current_trace = t;
5210 tr->current_trace->enabled++;
5211 trace_branch_enable(tr);
5213 mutex_unlock(&trace_types_lock);
5219 tracing_set_trace_write(struct file *filp, const char __user *ubuf,
5220 size_t cnt, loff_t *ppos)
5222 struct trace_array *tr = filp->private_data;
5223 char buf[MAX_TRACER_SIZE+1];
5230 if (cnt > MAX_TRACER_SIZE)
5231 cnt = MAX_TRACER_SIZE;
5233 if (copy_from_user(buf, ubuf, cnt))
5238 /* strip ending whitespace. */
5239 for (i = cnt - 1; i > 0 && isspace(buf[i]); i--)
5242 err = tracing_set_tracer(tr, buf);
5252 tracing_nsecs_read(unsigned long *ptr, char __user *ubuf,
5253 size_t cnt, loff_t *ppos)
5258 r = snprintf(buf, sizeof(buf), "%ld\n",
5259 *ptr == (unsigned long)-1 ? -1 : nsecs_to_usecs(*ptr));
5260 if (r > sizeof(buf))
5262 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
5266 tracing_nsecs_write(unsigned long *ptr, const char __user *ubuf,
5267 size_t cnt, loff_t *ppos)
5272 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
5282 tracing_thresh_read(struct file *filp, char __user *ubuf,
5283 size_t cnt, loff_t *ppos)
5285 return tracing_nsecs_read(&tracing_thresh, ubuf, cnt, ppos);
5289 tracing_thresh_write(struct file *filp, const char __user *ubuf,
5290 size_t cnt, loff_t *ppos)
5292 struct trace_array *tr = filp->private_data;
5295 mutex_lock(&trace_types_lock);
5296 ret = tracing_nsecs_write(&tracing_thresh, ubuf, cnt, ppos);
5300 if (tr->current_trace->update_thresh) {
5301 ret = tr->current_trace->update_thresh(tr);
5308 mutex_unlock(&trace_types_lock);
5313 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
5316 tracing_max_lat_read(struct file *filp, char __user *ubuf,
5317 size_t cnt, loff_t *ppos)
5319 return tracing_nsecs_read(filp->private_data, ubuf, cnt, ppos);
5323 tracing_max_lat_write(struct file *filp, const char __user *ubuf,
5324 size_t cnt, loff_t *ppos)
5326 return tracing_nsecs_write(filp->private_data, ubuf, cnt, ppos);
5331 static int tracing_open_pipe(struct inode *inode, struct file *filp)
5333 struct trace_array *tr = inode->i_private;
5334 struct trace_iterator *iter;
5337 if (tracing_disabled)
5340 if (trace_array_get(tr) < 0)
5343 mutex_lock(&trace_types_lock);
5345 /* create a buffer to store the information to pass to userspace */
5346 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
5349 __trace_array_put(tr);
5353 trace_seq_init(&iter->seq);
5354 iter->trace = tr->current_trace;
5356 if (!alloc_cpumask_var(&iter->started, GFP_KERNEL)) {
5361 /* trace pipe does not show start of buffer */
5362 cpumask_setall(iter->started);
5364 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
5365 iter->iter_flags |= TRACE_FILE_LAT_FMT;
5367 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
5368 if (trace_clocks[tr->clock_id].in_ns)
5369 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
5372 iter->trace_buffer = &tr->trace_buffer;
5373 iter->cpu_file = tracing_get_cpu(inode);
5374 mutex_init(&iter->mutex);
5375 filp->private_data = iter;
5377 if (iter->trace->pipe_open)
5378 iter->trace->pipe_open(iter);
5380 nonseekable_open(inode, filp);
5382 tr->current_trace->ref++;
5384 mutex_unlock(&trace_types_lock);
5390 __trace_array_put(tr);
5391 mutex_unlock(&trace_types_lock);
5395 static int tracing_release_pipe(struct inode *inode, struct file *file)
5397 struct trace_iterator *iter = file->private_data;
5398 struct trace_array *tr = inode->i_private;
5400 mutex_lock(&trace_types_lock);
5402 tr->current_trace->ref--;
5404 if (iter->trace->pipe_close)
5405 iter->trace->pipe_close(iter);
5407 mutex_unlock(&trace_types_lock);
5409 free_cpumask_var(iter->started);
5410 mutex_destroy(&iter->mutex);
5413 trace_array_put(tr);
5419 trace_poll(struct trace_iterator *iter, struct file *filp, poll_table *poll_table)
5421 struct trace_array *tr = iter->tr;
5423 /* Iterators are static, they should be filled or empty */
5424 if (trace_buffer_iter(iter, iter->cpu_file))
5425 return POLLIN | POLLRDNORM;
5427 if (tr->trace_flags & TRACE_ITER_BLOCK)
5429 * Always select as readable when in blocking mode
5431 return POLLIN | POLLRDNORM;
5433 return ring_buffer_poll_wait(iter->trace_buffer->buffer, iter->cpu_file,
5438 tracing_poll_pipe(struct file *filp, poll_table *poll_table)
5440 struct trace_iterator *iter = filp->private_data;
5442 return trace_poll(iter, filp, poll_table);
5445 /* Must be called with iter->mutex held. */
5446 static int tracing_wait_pipe(struct file *filp)
5448 struct trace_iterator *iter = filp->private_data;
5451 while (trace_empty(iter)) {
5453 if ((filp->f_flags & O_NONBLOCK)) {
5458 * We block until we read something and tracing is disabled.
5459 * We still block if tracing is disabled, but we have never
5460 * read anything. This allows a user to cat this file, and
5461 * then enable tracing. But after we have read something,
5462 * we give an EOF when tracing is again disabled.
5464 * iter->pos will be 0 if we haven't read anything.
5466 if (!tracing_is_on() && iter->pos)
5469 mutex_unlock(&iter->mutex);
5471 ret = wait_on_pipe(iter, false);
5473 mutex_lock(&iter->mutex);
5486 tracing_read_pipe(struct file *filp, char __user *ubuf,
5487 size_t cnt, loff_t *ppos)
5489 struct trace_iterator *iter = filp->private_data;
5493 * Avoid more than one consumer on a single file descriptor
5494 * This is just a matter of traces coherency, the ring buffer itself
5497 mutex_lock(&iter->mutex);
5499 /* return any leftover data */
5500 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
5504 trace_seq_init(&iter->seq);
5506 if (iter->trace->read) {
5507 sret = iter->trace->read(iter, filp, ubuf, cnt, ppos);
5513 sret = tracing_wait_pipe(filp);
5517 /* stop when tracing is finished */
5518 if (trace_empty(iter)) {
5523 if (cnt >= PAGE_SIZE)
5524 cnt = PAGE_SIZE - 1;
5526 /* reset all but tr, trace, and overruns */
5527 memset(&iter->seq, 0,
5528 sizeof(struct trace_iterator) -
5529 offsetof(struct trace_iterator, seq));
5530 cpumask_clear(iter->started);
5533 trace_event_read_lock();
5534 trace_access_lock(iter->cpu_file);
5535 while (trace_find_next_entry_inc(iter) != NULL) {
5536 enum print_line_t ret;
5537 int save_len = iter->seq.seq.len;
5539 ret = print_trace_line(iter);
5540 if (ret == TRACE_TYPE_PARTIAL_LINE) {
5541 /* don't print partial lines */
5542 iter->seq.seq.len = save_len;
5545 if (ret != TRACE_TYPE_NO_CONSUME)
5546 trace_consume(iter);
5548 if (trace_seq_used(&iter->seq) >= cnt)
5552 * Setting the full flag means we reached the trace_seq buffer
5553 * size and we should leave by partial output condition above.
5554 * One of the trace_seq_* functions is not used properly.
5556 WARN_ONCE(iter->seq.full, "full flag set for trace type %d",
5559 trace_access_unlock(iter->cpu_file);
5560 trace_event_read_unlock();
5562 /* Now copy what we have to the user */
5563 sret = trace_seq_to_user(&iter->seq, ubuf, cnt);
5564 if (iter->seq.seq.readpos >= trace_seq_used(&iter->seq))
5565 trace_seq_init(&iter->seq);
5568 * If there was nothing to send to user, in spite of consuming trace
5569 * entries, go back to wait for more entries.
5575 mutex_unlock(&iter->mutex);
5580 static void tracing_spd_release_pipe(struct splice_pipe_desc *spd,
5583 __free_page(spd->pages[idx]);
5586 static const struct pipe_buf_operations tracing_pipe_buf_ops = {
5588 .confirm = generic_pipe_buf_confirm,
5589 .release = generic_pipe_buf_release,
5590 .steal = generic_pipe_buf_steal,
5591 .get = generic_pipe_buf_get,
5595 tracing_fill_pipe_page(size_t rem, struct trace_iterator *iter)
5601 /* Seq buffer is page-sized, exactly what we need. */
5603 save_len = iter->seq.seq.len;
5604 ret = print_trace_line(iter);
5606 if (trace_seq_has_overflowed(&iter->seq)) {
5607 iter->seq.seq.len = save_len;
5612 * This should not be hit, because it should only
5613 * be set if the iter->seq overflowed. But check it
5614 * anyway to be safe.
5616 if (ret == TRACE_TYPE_PARTIAL_LINE) {
5617 iter->seq.seq.len = save_len;
5621 count = trace_seq_used(&iter->seq) - save_len;
5624 iter->seq.seq.len = save_len;
5628 if (ret != TRACE_TYPE_NO_CONSUME)
5629 trace_consume(iter);
5631 if (!trace_find_next_entry_inc(iter)) {
5641 static ssize_t tracing_splice_read_pipe(struct file *filp,
5643 struct pipe_inode_info *pipe,
5647 struct page *pages_def[PIPE_DEF_BUFFERS];
5648 struct partial_page partial_def[PIPE_DEF_BUFFERS];
5649 struct trace_iterator *iter = filp->private_data;
5650 struct splice_pipe_desc spd = {
5652 .partial = partial_def,
5653 .nr_pages = 0, /* This gets updated below. */
5654 .nr_pages_max = PIPE_DEF_BUFFERS,
5655 .ops = &tracing_pipe_buf_ops,
5656 .spd_release = tracing_spd_release_pipe,
5662 if (splice_grow_spd(pipe, &spd))
5665 mutex_lock(&iter->mutex);
5667 if (iter->trace->splice_read) {
5668 ret = iter->trace->splice_read(iter, filp,
5669 ppos, pipe, len, flags);
5674 ret = tracing_wait_pipe(filp);
5678 if (!iter->ent && !trace_find_next_entry_inc(iter)) {
5683 trace_event_read_lock();
5684 trace_access_lock(iter->cpu_file);
5686 /* Fill as many pages as possible. */
5687 for (i = 0, rem = len; i < spd.nr_pages_max && rem; i++) {
5688 spd.pages[i] = alloc_page(GFP_KERNEL);
5692 rem = tracing_fill_pipe_page(rem, iter);
5694 /* Copy the data into the page, so we can start over. */
5695 ret = trace_seq_to_buffer(&iter->seq,
5696 page_address(spd.pages[i]),
5697 trace_seq_used(&iter->seq));
5699 __free_page(spd.pages[i]);
5702 spd.partial[i].offset = 0;
5703 spd.partial[i].len = trace_seq_used(&iter->seq);
5705 trace_seq_init(&iter->seq);
5708 trace_access_unlock(iter->cpu_file);
5709 trace_event_read_unlock();
5710 mutex_unlock(&iter->mutex);
5715 ret = splice_to_pipe(pipe, &spd);
5719 splice_shrink_spd(&spd);
5723 mutex_unlock(&iter->mutex);
5728 tracing_entries_read(struct file *filp, char __user *ubuf,
5729 size_t cnt, loff_t *ppos)
5731 struct inode *inode = file_inode(filp);
5732 struct trace_array *tr = inode->i_private;
5733 int cpu = tracing_get_cpu(inode);
5738 mutex_lock(&trace_types_lock);
5740 if (cpu == RING_BUFFER_ALL_CPUS) {
5741 int cpu, buf_size_same;
5746 /* check if all cpu sizes are same */
5747 for_each_tracing_cpu(cpu) {
5748 /* fill in the size from first enabled cpu */
5750 size = per_cpu_ptr(tr->trace_buffer.data, cpu)->entries;
5751 if (size != per_cpu_ptr(tr->trace_buffer.data, cpu)->entries) {
5757 if (buf_size_same) {
5758 if (!ring_buffer_expanded)
5759 r = sprintf(buf, "%lu (expanded: %lu)\n",
5761 trace_buf_size >> 10);
5763 r = sprintf(buf, "%lu\n", size >> 10);
5765 r = sprintf(buf, "X\n");
5767 r = sprintf(buf, "%lu\n", per_cpu_ptr(tr->trace_buffer.data, cpu)->entries >> 10);
5769 mutex_unlock(&trace_types_lock);
5771 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
5776 tracing_entries_write(struct file *filp, const char __user *ubuf,
5777 size_t cnt, loff_t *ppos)
5779 struct inode *inode = file_inode(filp);
5780 struct trace_array *tr = inode->i_private;
5784 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
5788 /* must have at least 1 entry */
5792 /* value is in KB */
5794 ret = tracing_resize_ring_buffer(tr, val, tracing_get_cpu(inode));
5804 tracing_total_entries_read(struct file *filp, char __user *ubuf,
5805 size_t cnt, loff_t *ppos)
5807 struct trace_array *tr = filp->private_data;
5810 unsigned long size = 0, expanded_size = 0;
5812 mutex_lock(&trace_types_lock);
5813 for_each_tracing_cpu(cpu) {
5814 size += per_cpu_ptr(tr->trace_buffer.data, cpu)->entries >> 10;
5815 if (!ring_buffer_expanded)
5816 expanded_size += trace_buf_size >> 10;
5818 if (ring_buffer_expanded)
5819 r = sprintf(buf, "%lu\n", size);
5821 r = sprintf(buf, "%lu (expanded: %lu)\n", size, expanded_size);
5822 mutex_unlock(&trace_types_lock);
5824 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
5828 tracing_free_buffer_write(struct file *filp, const char __user *ubuf,
5829 size_t cnt, loff_t *ppos)
5832 * There is no need to read what the user has written, this function
5833 * is just to make sure that there is no error when "echo" is used
5842 tracing_free_buffer_release(struct inode *inode, struct file *filp)
5844 struct trace_array *tr = inode->i_private;
5846 /* disable tracing ? */
5847 if (tr->trace_flags & TRACE_ITER_STOP_ON_FREE)
5848 tracer_tracing_off(tr);
5849 /* resize the ring buffer to 0 */
5850 tracing_resize_ring_buffer(tr, 0, RING_BUFFER_ALL_CPUS);
5852 trace_array_put(tr);
5858 tracing_mark_write(struct file *filp, const char __user *ubuf,
5859 size_t cnt, loff_t *fpos)
5861 struct trace_array *tr = filp->private_data;
5862 struct ring_buffer_event *event;
5863 struct ring_buffer *buffer;
5864 struct print_entry *entry;
5865 unsigned long irq_flags;
5866 const char faulted[] = "<faulted>";
5871 /* Used in tracing_mark_raw_write() as well */
5872 #define FAULTED_SIZE (sizeof(faulted) - 1) /* '\0' is already accounted for */
5874 if (tracing_disabled)
5877 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
5880 if (cnt > TRACE_BUF_SIZE)
5881 cnt = TRACE_BUF_SIZE;
5883 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
5885 local_save_flags(irq_flags);
5886 size = sizeof(*entry) + cnt + 2; /* add '\0' and possible '\n' */
5888 /* If less than "<faulted>", then make sure we can still add that */
5889 if (cnt < FAULTED_SIZE)
5890 size += FAULTED_SIZE - cnt;
5892 buffer = tr->trace_buffer.buffer;
5893 event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, size,
5894 irq_flags, preempt_count());
5895 if (unlikely(!event))
5896 /* Ring buffer disabled, return as if not open for write */
5899 entry = ring_buffer_event_data(event);
5900 entry->ip = _THIS_IP_;
5902 len = __copy_from_user_inatomic(&entry->buf, ubuf, cnt);
5904 memcpy(&entry->buf, faulted, FAULTED_SIZE);
5911 if (entry->buf[cnt - 1] != '\n') {
5912 entry->buf[cnt] = '\n';
5913 entry->buf[cnt + 1] = '\0';
5915 entry->buf[cnt] = '\0';
5917 __buffer_unlock_commit(buffer, event);
5925 /* Limit it for now to 3K (including tag) */
5926 #define RAW_DATA_MAX_SIZE (1024*3)
5929 tracing_mark_raw_write(struct file *filp, const char __user *ubuf,
5930 size_t cnt, loff_t *fpos)
5932 struct trace_array *tr = filp->private_data;
5933 struct ring_buffer_event *event;
5934 struct ring_buffer *buffer;
5935 struct raw_data_entry *entry;
5936 const char faulted[] = "<faulted>";
5937 unsigned long irq_flags;
5942 #define FAULT_SIZE_ID (FAULTED_SIZE + sizeof(int))
5944 if (tracing_disabled)
5947 if (!(tr->trace_flags & TRACE_ITER_MARKERS))
5950 /* The marker must at least have a tag id */
5951 if (cnt < sizeof(unsigned int) || cnt > RAW_DATA_MAX_SIZE)
5954 if (cnt > TRACE_BUF_SIZE)
5955 cnt = TRACE_BUF_SIZE;
5957 BUILD_BUG_ON(TRACE_BUF_SIZE >= PAGE_SIZE);
5959 local_save_flags(irq_flags);
5960 size = sizeof(*entry) + cnt;
5961 if (cnt < FAULT_SIZE_ID)
5962 size += FAULT_SIZE_ID - cnt;
5964 buffer = tr->trace_buffer.buffer;
5965 event = __trace_buffer_lock_reserve(buffer, TRACE_RAW_DATA, size,
5966 irq_flags, preempt_count());
5968 /* Ring buffer disabled, return as if not open for write */
5971 entry = ring_buffer_event_data(event);
5973 len = __copy_from_user_inatomic(&entry->id, ubuf, cnt);
5976 memcpy(&entry->buf, faulted, FAULTED_SIZE);
5981 __buffer_unlock_commit(buffer, event);
5989 static int tracing_clock_show(struct seq_file *m, void *v)
5991 struct trace_array *tr = m->private;
5994 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++)
5996 "%s%s%s%s", i ? " " : "",
5997 i == tr->clock_id ? "[" : "", trace_clocks[i].name,
5998 i == tr->clock_id ? "]" : "");
6004 static int tracing_set_clock(struct trace_array *tr, const char *clockstr)
6008 for (i = 0; i < ARRAY_SIZE(trace_clocks); i++) {
6009 if (strcmp(trace_clocks[i].name, clockstr) == 0)
6012 if (i == ARRAY_SIZE(trace_clocks))
6015 mutex_lock(&trace_types_lock);
6019 ring_buffer_set_clock(tr->trace_buffer.buffer, trace_clocks[i].func);
6022 * New clock may not be consistent with the previous clock.
6023 * Reset the buffer so that it doesn't have incomparable timestamps.
6025 tracing_reset_online_cpus(&tr->trace_buffer);
6027 #ifdef CONFIG_TRACER_MAX_TRACE
6028 if (tr->flags & TRACE_ARRAY_FL_GLOBAL && tr->max_buffer.buffer)
6029 ring_buffer_set_clock(tr->max_buffer.buffer, trace_clocks[i].func);
6030 tracing_reset_online_cpus(&tr->max_buffer);
6033 mutex_unlock(&trace_types_lock);
6038 static ssize_t tracing_clock_write(struct file *filp, const char __user *ubuf,
6039 size_t cnt, loff_t *fpos)
6041 struct seq_file *m = filp->private_data;
6042 struct trace_array *tr = m->private;
6044 const char *clockstr;
6047 if (cnt >= sizeof(buf))
6050 if (copy_from_user(buf, ubuf, cnt))
6055 clockstr = strstrip(buf);
6057 ret = tracing_set_clock(tr, clockstr);
6066 static int tracing_clock_open(struct inode *inode, struct file *file)
6068 struct trace_array *tr = inode->i_private;
6071 if (tracing_disabled)
6074 if (trace_array_get(tr))
6077 ret = single_open(file, tracing_clock_show, inode->i_private);
6079 trace_array_put(tr);
6084 struct ftrace_buffer_info {
6085 struct trace_iterator iter;
6087 unsigned int spare_cpu;
6091 #ifdef CONFIG_TRACER_SNAPSHOT
6092 static int tracing_snapshot_open(struct inode *inode, struct file *file)
6094 struct trace_array *tr = inode->i_private;
6095 struct trace_iterator *iter;
6099 if (trace_array_get(tr) < 0)
6102 if (file->f_mode & FMODE_READ) {
6103 iter = __tracing_open(inode, file, true);
6105 ret = PTR_ERR(iter);
6107 /* Writes still need the seq_file to hold the private data */
6109 m = kzalloc(sizeof(*m), GFP_KERNEL);
6112 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
6120 iter->trace_buffer = &tr->max_buffer;
6121 iter->cpu_file = tracing_get_cpu(inode);
6123 file->private_data = m;
6127 trace_array_put(tr);
6133 tracing_snapshot_write(struct file *filp, const char __user *ubuf, size_t cnt,
6136 struct seq_file *m = filp->private_data;
6137 struct trace_iterator *iter = m->private;
6138 struct trace_array *tr = iter->tr;
6142 ret = tracing_update_buffers();
6146 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
6150 mutex_lock(&trace_types_lock);
6152 if (tr->current_trace->use_max_tr) {
6159 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
6163 if (tr->allocated_snapshot)
6167 /* Only allow per-cpu swap if the ring buffer supports it */
6168 #ifndef CONFIG_RING_BUFFER_ALLOW_SWAP
6169 if (iter->cpu_file != RING_BUFFER_ALL_CPUS) {
6174 if (!tr->allocated_snapshot) {
6175 ret = alloc_snapshot(tr);
6179 local_irq_disable();
6180 /* Now, we're going to swap */
6181 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
6182 update_max_tr(tr, current, smp_processor_id());
6184 update_max_tr_single(tr, current, iter->cpu_file);
6188 if (tr->allocated_snapshot) {
6189 if (iter->cpu_file == RING_BUFFER_ALL_CPUS)
6190 tracing_reset_online_cpus(&tr->max_buffer);
6192 tracing_reset(&tr->max_buffer, iter->cpu_file);
6202 mutex_unlock(&trace_types_lock);
6206 static int tracing_snapshot_release(struct inode *inode, struct file *file)
6208 struct seq_file *m = file->private_data;
6211 ret = tracing_release(inode, file);
6213 if (file->f_mode & FMODE_READ)
6216 /* If write only, the seq_file is just a stub */
6224 static int tracing_buffers_open(struct inode *inode, struct file *filp);
6225 static ssize_t tracing_buffers_read(struct file *filp, char __user *ubuf,
6226 size_t count, loff_t *ppos);
6227 static int tracing_buffers_release(struct inode *inode, struct file *file);
6228 static ssize_t tracing_buffers_splice_read(struct file *file, loff_t *ppos,
6229 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
6231 static int snapshot_raw_open(struct inode *inode, struct file *filp)
6233 struct ftrace_buffer_info *info;
6236 ret = tracing_buffers_open(inode, filp);
6240 info = filp->private_data;
6242 if (info->iter.trace->use_max_tr) {
6243 tracing_buffers_release(inode, filp);
6247 info->iter.snapshot = true;
6248 info->iter.trace_buffer = &info->iter.tr->max_buffer;
6253 #endif /* CONFIG_TRACER_SNAPSHOT */
6256 static const struct file_operations tracing_thresh_fops = {
6257 .open = tracing_open_generic,
6258 .read = tracing_thresh_read,
6259 .write = tracing_thresh_write,
6260 .llseek = generic_file_llseek,
6263 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
6264 static const struct file_operations tracing_max_lat_fops = {
6265 .open = tracing_open_generic,
6266 .read = tracing_max_lat_read,
6267 .write = tracing_max_lat_write,
6268 .llseek = generic_file_llseek,
6272 static const struct file_operations set_tracer_fops = {
6273 .open = tracing_open_generic,
6274 .read = tracing_set_trace_read,
6275 .write = tracing_set_trace_write,
6276 .llseek = generic_file_llseek,
6279 static const struct file_operations tracing_pipe_fops = {
6280 .open = tracing_open_pipe,
6281 .poll = tracing_poll_pipe,
6282 .read = tracing_read_pipe,
6283 .splice_read = tracing_splice_read_pipe,
6284 .release = tracing_release_pipe,
6285 .llseek = no_llseek,
6288 static const struct file_operations tracing_entries_fops = {
6289 .open = tracing_open_generic_tr,
6290 .read = tracing_entries_read,
6291 .write = tracing_entries_write,
6292 .llseek = generic_file_llseek,
6293 .release = tracing_release_generic_tr,
6296 static const struct file_operations tracing_total_entries_fops = {
6297 .open = tracing_open_generic_tr,
6298 .read = tracing_total_entries_read,
6299 .llseek = generic_file_llseek,
6300 .release = tracing_release_generic_tr,
6303 static const struct file_operations tracing_free_buffer_fops = {
6304 .open = tracing_open_generic_tr,
6305 .write = tracing_free_buffer_write,
6306 .release = tracing_free_buffer_release,
6309 static const struct file_operations tracing_mark_fops = {
6310 .open = tracing_open_generic_tr,
6311 .write = tracing_mark_write,
6312 .llseek = generic_file_llseek,
6313 .release = tracing_release_generic_tr,
6316 static const struct file_operations tracing_mark_raw_fops = {
6317 .open = tracing_open_generic_tr,
6318 .write = tracing_mark_raw_write,
6319 .llseek = generic_file_llseek,
6320 .release = tracing_release_generic_tr,
6323 static const struct file_operations trace_clock_fops = {
6324 .open = tracing_clock_open,
6326 .llseek = seq_lseek,
6327 .release = tracing_single_release_tr,
6328 .write = tracing_clock_write,
6331 #ifdef CONFIG_TRACER_SNAPSHOT
6332 static const struct file_operations snapshot_fops = {
6333 .open = tracing_snapshot_open,
6335 .write = tracing_snapshot_write,
6336 .llseek = tracing_lseek,
6337 .release = tracing_snapshot_release,
6340 static const struct file_operations snapshot_raw_fops = {
6341 .open = snapshot_raw_open,
6342 .read = tracing_buffers_read,
6343 .release = tracing_buffers_release,
6344 .splice_read = tracing_buffers_splice_read,
6345 .llseek = no_llseek,
6348 #endif /* CONFIG_TRACER_SNAPSHOT */
6350 static int tracing_buffers_open(struct inode *inode, struct file *filp)
6352 struct trace_array *tr = inode->i_private;
6353 struct ftrace_buffer_info *info;
6356 if (tracing_disabled)
6359 if (trace_array_get(tr) < 0)
6362 info = kzalloc(sizeof(*info), GFP_KERNEL);
6364 trace_array_put(tr);
6368 mutex_lock(&trace_types_lock);
6371 info->iter.cpu_file = tracing_get_cpu(inode);
6372 info->iter.trace = tr->current_trace;
6373 info->iter.trace_buffer = &tr->trace_buffer;
6375 /* Force reading ring buffer for first read */
6376 info->read = (unsigned int)-1;
6378 filp->private_data = info;
6380 tr->current_trace->ref++;
6382 mutex_unlock(&trace_types_lock);
6384 ret = nonseekable_open(inode, filp);
6386 trace_array_put(tr);
6392 tracing_buffers_poll(struct file *filp, poll_table *poll_table)
6394 struct ftrace_buffer_info *info = filp->private_data;
6395 struct trace_iterator *iter = &info->iter;
6397 return trace_poll(iter, filp, poll_table);
6401 tracing_buffers_read(struct file *filp, char __user *ubuf,
6402 size_t count, loff_t *ppos)
6404 struct ftrace_buffer_info *info = filp->private_data;
6405 struct trace_iterator *iter = &info->iter;
6412 #ifdef CONFIG_TRACER_MAX_TRACE
6413 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
6418 info->spare = ring_buffer_alloc_read_page(iter->trace_buffer->buffer,
6420 info->spare_cpu = iter->cpu_file;
6425 /* Do we have previous read data to read? */
6426 if (info->read < PAGE_SIZE)
6430 trace_access_lock(iter->cpu_file);
6431 ret = ring_buffer_read_page(iter->trace_buffer->buffer,
6435 trace_access_unlock(iter->cpu_file);
6438 if (trace_empty(iter)) {
6439 if ((filp->f_flags & O_NONBLOCK))
6442 ret = wait_on_pipe(iter, false);
6453 size = PAGE_SIZE - info->read;
6457 ret = copy_to_user(ubuf, info->spare + info->read, size);
6469 static int tracing_buffers_release(struct inode *inode, struct file *file)
6471 struct ftrace_buffer_info *info = file->private_data;
6472 struct trace_iterator *iter = &info->iter;
6474 mutex_lock(&trace_types_lock);
6476 iter->tr->current_trace->ref--;
6478 __trace_array_put(iter->tr);
6481 ring_buffer_free_read_page(iter->trace_buffer->buffer,
6482 info->spare_cpu, info->spare);
6485 mutex_unlock(&trace_types_lock);
6491 struct ring_buffer *buffer;
6497 static void buffer_pipe_buf_release(struct pipe_inode_info *pipe,
6498 struct pipe_buffer *buf)
6500 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
6505 ring_buffer_free_read_page(ref->buffer, ref->cpu, ref->page);
6510 static void buffer_pipe_buf_get(struct pipe_inode_info *pipe,
6511 struct pipe_buffer *buf)
6513 struct buffer_ref *ref = (struct buffer_ref *)buf->private;
6518 /* Pipe buffer operations for a buffer. */
6519 static const struct pipe_buf_operations buffer_pipe_buf_ops = {
6521 .confirm = generic_pipe_buf_confirm,
6522 .release = buffer_pipe_buf_release,
6523 .steal = generic_pipe_buf_steal,
6524 .get = buffer_pipe_buf_get,
6528 * Callback from splice_to_pipe(), if we need to release some pages
6529 * at the end of the spd in case we error'ed out in filling the pipe.
6531 static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)
6533 struct buffer_ref *ref =
6534 (struct buffer_ref *)spd->partial[i].private;
6539 ring_buffer_free_read_page(ref->buffer, ref->cpu, ref->page);
6541 spd->partial[i].private = 0;
6545 tracing_buffers_splice_read(struct file *file, loff_t *ppos,
6546 struct pipe_inode_info *pipe, size_t len,
6549 struct ftrace_buffer_info *info = file->private_data;
6550 struct trace_iterator *iter = &info->iter;
6551 struct partial_page partial_def[PIPE_DEF_BUFFERS];
6552 struct page *pages_def[PIPE_DEF_BUFFERS];
6553 struct splice_pipe_desc spd = {
6555 .partial = partial_def,
6556 .nr_pages_max = PIPE_DEF_BUFFERS,
6557 .ops = &buffer_pipe_buf_ops,
6558 .spd_release = buffer_spd_release,
6560 struct buffer_ref *ref;
6561 int entries, size, i;
6564 #ifdef CONFIG_TRACER_MAX_TRACE
6565 if (iter->snapshot && iter->tr->current_trace->use_max_tr)
6569 if (*ppos & (PAGE_SIZE - 1))
6572 if (len & (PAGE_SIZE - 1)) {
6573 if (len < PAGE_SIZE)
6578 if (splice_grow_spd(pipe, &spd))
6582 trace_access_lock(iter->cpu_file);
6583 entries = ring_buffer_entries_cpu(iter->trace_buffer->buffer, iter->cpu_file);
6585 for (i = 0; i < spd.nr_pages_max && len && entries; i++, len -= PAGE_SIZE) {
6589 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
6596 ref->buffer = iter->trace_buffer->buffer;
6597 ref->page = ring_buffer_alloc_read_page(ref->buffer, iter->cpu_file);
6603 ref->cpu = iter->cpu_file;
6605 r = ring_buffer_read_page(ref->buffer, &ref->page,
6606 len, iter->cpu_file, 1);
6608 ring_buffer_free_read_page(ref->buffer, ref->cpu,
6615 * zero out any left over data, this is going to
6618 size = ring_buffer_page_len(ref->page);
6619 if (size < PAGE_SIZE)
6620 memset(ref->page + size, 0, PAGE_SIZE - size);
6622 page = virt_to_page(ref->page);
6624 spd.pages[i] = page;
6625 spd.partial[i].len = PAGE_SIZE;
6626 spd.partial[i].offset = 0;
6627 spd.partial[i].private = (unsigned long)ref;
6631 entries = ring_buffer_entries_cpu(iter->trace_buffer->buffer, iter->cpu_file);
6634 trace_access_unlock(iter->cpu_file);
6637 /* did we read anything? */
6638 if (!spd.nr_pages) {
6643 if ((file->f_flags & O_NONBLOCK) || (flags & SPLICE_F_NONBLOCK))
6646 ret = wait_on_pipe(iter, true);
6653 ret = splice_to_pipe(pipe, &spd);
6655 splice_shrink_spd(&spd);
6660 static const struct file_operations tracing_buffers_fops = {
6661 .open = tracing_buffers_open,
6662 .read = tracing_buffers_read,
6663 .poll = tracing_buffers_poll,
6664 .release = tracing_buffers_release,
6665 .splice_read = tracing_buffers_splice_read,
6666 .llseek = no_llseek,
6670 tracing_stats_read(struct file *filp, char __user *ubuf,
6671 size_t count, loff_t *ppos)
6673 struct inode *inode = file_inode(filp);
6674 struct trace_array *tr = inode->i_private;
6675 struct trace_buffer *trace_buf = &tr->trace_buffer;
6676 int cpu = tracing_get_cpu(inode);
6677 struct trace_seq *s;
6679 unsigned long long t;
6680 unsigned long usec_rem;
6682 s = kmalloc(sizeof(*s), GFP_KERNEL);
6688 cnt = ring_buffer_entries_cpu(trace_buf->buffer, cpu);
6689 trace_seq_printf(s, "entries: %ld\n", cnt);
6691 cnt = ring_buffer_overrun_cpu(trace_buf->buffer, cpu);
6692 trace_seq_printf(s, "overrun: %ld\n", cnt);
6694 cnt = ring_buffer_commit_overrun_cpu(trace_buf->buffer, cpu);
6695 trace_seq_printf(s, "commit overrun: %ld\n", cnt);
6697 cnt = ring_buffer_bytes_cpu(trace_buf->buffer, cpu);
6698 trace_seq_printf(s, "bytes: %ld\n", cnt);
6700 if (trace_clocks[tr->clock_id].in_ns) {
6701 /* local or global for trace_clock */
6702 t = ns2usecs(ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
6703 usec_rem = do_div(t, USEC_PER_SEC);
6704 trace_seq_printf(s, "oldest event ts: %5llu.%06lu\n",
6707 t = ns2usecs(ring_buffer_time_stamp(trace_buf->buffer, cpu));
6708 usec_rem = do_div(t, USEC_PER_SEC);
6709 trace_seq_printf(s, "now ts: %5llu.%06lu\n", t, usec_rem);
6711 /* counter or tsc mode for trace_clock */
6712 trace_seq_printf(s, "oldest event ts: %llu\n",
6713 ring_buffer_oldest_event_ts(trace_buf->buffer, cpu));
6715 trace_seq_printf(s, "now ts: %llu\n",
6716 ring_buffer_time_stamp(trace_buf->buffer, cpu));
6719 cnt = ring_buffer_dropped_events_cpu(trace_buf->buffer, cpu);
6720 trace_seq_printf(s, "dropped events: %ld\n", cnt);
6722 cnt = ring_buffer_read_events_cpu(trace_buf->buffer, cpu);
6723 trace_seq_printf(s, "read events: %ld\n", cnt);
6725 count = simple_read_from_buffer(ubuf, count, ppos,
6726 s->buffer, trace_seq_used(s));
6733 static const struct file_operations tracing_stats_fops = {
6734 .open = tracing_open_generic_tr,
6735 .read = tracing_stats_read,
6736 .llseek = generic_file_llseek,
6737 .release = tracing_release_generic_tr,
6740 #ifdef CONFIG_DYNAMIC_FTRACE
6742 int __weak ftrace_arch_read_dyn_info(char *buf, int size)
6748 tracing_read_dyn_info(struct file *filp, char __user *ubuf,
6749 size_t cnt, loff_t *ppos)
6751 static char ftrace_dyn_info_buffer[1024];
6752 static DEFINE_MUTEX(dyn_info_mutex);
6753 unsigned long *p = filp->private_data;
6754 char *buf = ftrace_dyn_info_buffer;
6755 int size = ARRAY_SIZE(ftrace_dyn_info_buffer);
6758 mutex_lock(&dyn_info_mutex);
6759 r = sprintf(buf, "%ld ", *p);
6761 r += ftrace_arch_read_dyn_info(buf+r, (size-1)-r);
6764 r = simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
6766 mutex_unlock(&dyn_info_mutex);
6771 static const struct file_operations tracing_dyn_info_fops = {
6772 .open = tracing_open_generic,
6773 .read = tracing_read_dyn_info,
6774 .llseek = generic_file_llseek,
6776 #endif /* CONFIG_DYNAMIC_FTRACE */
6778 #if defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE)
6780 ftrace_snapshot(unsigned long ip, unsigned long parent_ip,
6781 struct trace_array *tr, struct ftrace_probe_ops *ops,
6784 tracing_snapshot_instance(tr);
6788 ftrace_count_snapshot(unsigned long ip, unsigned long parent_ip,
6789 struct trace_array *tr, struct ftrace_probe_ops *ops,
6792 struct ftrace_func_mapper *mapper = data;
6796 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
6806 tracing_snapshot_instance(tr);
6810 ftrace_snapshot_print(struct seq_file *m, unsigned long ip,
6811 struct ftrace_probe_ops *ops, void *data)
6813 struct ftrace_func_mapper *mapper = data;
6816 seq_printf(m, "%ps:", (void *)ip);
6818 seq_puts(m, "snapshot");
6821 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
6824 seq_printf(m, ":count=%ld\n", *count);
6826 seq_puts(m, ":unlimited\n");
6832 ftrace_snapshot_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
6833 unsigned long ip, void *init_data, void **data)
6835 struct ftrace_func_mapper *mapper = *data;
6838 mapper = allocate_ftrace_func_mapper();
6844 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
6848 ftrace_snapshot_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
6849 unsigned long ip, void *data)
6851 struct ftrace_func_mapper *mapper = data;
6856 free_ftrace_func_mapper(mapper, NULL);
6860 ftrace_func_mapper_remove_ip(mapper, ip);
6863 static struct ftrace_probe_ops snapshot_probe_ops = {
6864 .func = ftrace_snapshot,
6865 .print = ftrace_snapshot_print,
6868 static struct ftrace_probe_ops snapshot_count_probe_ops = {
6869 .func = ftrace_count_snapshot,
6870 .print = ftrace_snapshot_print,
6871 .init = ftrace_snapshot_init,
6872 .free = ftrace_snapshot_free,
6876 ftrace_trace_snapshot_callback(struct trace_array *tr, struct ftrace_hash *hash,
6877 char *glob, char *cmd, char *param, int enable)
6879 struct ftrace_probe_ops *ops;
6880 void *count = (void *)-1;
6887 /* hash funcs only work with set_ftrace_filter */
6891 ops = param ? &snapshot_count_probe_ops : &snapshot_probe_ops;
6894 return unregister_ftrace_function_probe_func(glob+1, tr, ops);
6899 number = strsep(¶m, ":");
6901 if (!strlen(number))
6905 * We use the callback data field (which is a pointer)
6908 ret = kstrtoul(number, 0, (unsigned long *)&count);
6913 ret = alloc_snapshot(tr);
6917 ret = register_ftrace_function_probe(glob, tr, ops, count);
6920 return ret < 0 ? ret : 0;
6923 static struct ftrace_func_command ftrace_snapshot_cmd = {
6925 .func = ftrace_trace_snapshot_callback,
6928 static __init int register_snapshot_cmd(void)
6930 return register_ftrace_command(&ftrace_snapshot_cmd);
6933 static inline __init int register_snapshot_cmd(void) { return 0; }
6934 #endif /* defined(CONFIG_TRACER_SNAPSHOT) && defined(CONFIG_DYNAMIC_FTRACE) */
6936 static struct dentry *tracing_get_dentry(struct trace_array *tr)
6938 if (WARN_ON(!tr->dir))
6939 return ERR_PTR(-ENODEV);
6941 /* Top directory uses NULL as the parent */
6942 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
6945 /* All sub buffers have a descriptor */
6949 static struct dentry *tracing_dentry_percpu(struct trace_array *tr, int cpu)
6951 struct dentry *d_tracer;
6954 return tr->percpu_dir;
6956 d_tracer = tracing_get_dentry(tr);
6957 if (IS_ERR(d_tracer))
6960 tr->percpu_dir = tracefs_create_dir("per_cpu", d_tracer);
6962 WARN_ONCE(!tr->percpu_dir,
6963 "Could not create tracefs directory 'per_cpu/%d'\n", cpu);
6965 return tr->percpu_dir;
6968 static struct dentry *
6969 trace_create_cpu_file(const char *name, umode_t mode, struct dentry *parent,
6970 void *data, long cpu, const struct file_operations *fops)
6972 struct dentry *ret = trace_create_file(name, mode, parent, data, fops);
6974 if (ret) /* See tracing_get_cpu() */
6975 d_inode(ret)->i_cdev = (void *)(cpu + 1);
6980 tracing_init_tracefs_percpu(struct trace_array *tr, long cpu)
6982 struct dentry *d_percpu = tracing_dentry_percpu(tr, cpu);
6983 struct dentry *d_cpu;
6984 char cpu_dir[30]; /* 30 characters should be more than enough */
6989 snprintf(cpu_dir, 30, "cpu%ld", cpu);
6990 d_cpu = tracefs_create_dir(cpu_dir, d_percpu);
6992 pr_warn("Could not create tracefs '%s' entry\n", cpu_dir);
6996 /* per cpu trace_pipe */
6997 trace_create_cpu_file("trace_pipe", 0444, d_cpu,
6998 tr, cpu, &tracing_pipe_fops);
7001 trace_create_cpu_file("trace", 0644, d_cpu,
7002 tr, cpu, &tracing_fops);
7004 trace_create_cpu_file("trace_pipe_raw", 0444, d_cpu,
7005 tr, cpu, &tracing_buffers_fops);
7007 trace_create_cpu_file("stats", 0444, d_cpu,
7008 tr, cpu, &tracing_stats_fops);
7010 trace_create_cpu_file("buffer_size_kb", 0444, d_cpu,
7011 tr, cpu, &tracing_entries_fops);
7013 #ifdef CONFIG_TRACER_SNAPSHOT
7014 trace_create_cpu_file("snapshot", 0644, d_cpu,
7015 tr, cpu, &snapshot_fops);
7017 trace_create_cpu_file("snapshot_raw", 0444, d_cpu,
7018 tr, cpu, &snapshot_raw_fops);
7022 #ifdef CONFIG_FTRACE_SELFTEST
7023 /* Let selftest have access to static functions in this file */
7024 #include "trace_selftest.c"
7028 trace_options_read(struct file *filp, char __user *ubuf, size_t cnt,
7031 struct trace_option_dentry *topt = filp->private_data;
7034 if (topt->flags->val & topt->opt->bit)
7039 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
7043 trace_options_write(struct file *filp, const char __user *ubuf, size_t cnt,
7046 struct trace_option_dentry *topt = filp->private_data;
7050 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7054 if (val != 0 && val != 1)
7057 if (!!(topt->flags->val & topt->opt->bit) != val) {
7058 mutex_lock(&trace_types_lock);
7059 ret = __set_tracer_option(topt->tr, topt->flags,
7061 mutex_unlock(&trace_types_lock);
7072 static const struct file_operations trace_options_fops = {
7073 .open = tracing_open_generic,
7074 .read = trace_options_read,
7075 .write = trace_options_write,
7076 .llseek = generic_file_llseek,
7080 * In order to pass in both the trace_array descriptor as well as the index
7081 * to the flag that the trace option file represents, the trace_array
7082 * has a character array of trace_flags_index[], which holds the index
7083 * of the bit for the flag it represents. index[0] == 0, index[1] == 1, etc.
7084 * The address of this character array is passed to the flag option file
7085 * read/write callbacks.
7087 * In order to extract both the index and the trace_array descriptor,
7088 * get_tr_index() uses the following algorithm.
7092 * As the pointer itself contains the address of the index (remember
7095 * Then to get the trace_array descriptor, by subtracting that index
7096 * from the ptr, we get to the start of the index itself.
7098 * ptr - idx == &index[0]
7100 * Then a simple container_of() from that pointer gets us to the
7101 * trace_array descriptor.
7103 static void get_tr_index(void *data, struct trace_array **ptr,
7104 unsigned int *pindex)
7106 *pindex = *(unsigned char *)data;
7108 *ptr = container_of(data - *pindex, struct trace_array,
7113 trace_options_core_read(struct file *filp, char __user *ubuf, size_t cnt,
7116 void *tr_index = filp->private_data;
7117 struct trace_array *tr;
7121 get_tr_index(tr_index, &tr, &index);
7123 if (tr->trace_flags & (1 << index))
7128 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
7132 trace_options_core_write(struct file *filp, const char __user *ubuf, size_t cnt,
7135 void *tr_index = filp->private_data;
7136 struct trace_array *tr;
7141 get_tr_index(tr_index, &tr, &index);
7143 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7147 if (val != 0 && val != 1)
7150 mutex_lock(&trace_types_lock);
7151 ret = set_tracer_flag(tr, 1 << index, val);
7152 mutex_unlock(&trace_types_lock);
7162 static const struct file_operations trace_options_core_fops = {
7163 .open = tracing_open_generic,
7164 .read = trace_options_core_read,
7165 .write = trace_options_core_write,
7166 .llseek = generic_file_llseek,
7169 struct dentry *trace_create_file(const char *name,
7171 struct dentry *parent,
7173 const struct file_operations *fops)
7177 ret = tracefs_create_file(name, mode, parent, data, fops);
7179 pr_warn("Could not create tracefs '%s' entry\n", name);
7185 static struct dentry *trace_options_init_dentry(struct trace_array *tr)
7187 struct dentry *d_tracer;
7192 d_tracer = tracing_get_dentry(tr);
7193 if (IS_ERR(d_tracer))
7196 tr->options = tracefs_create_dir("options", d_tracer);
7198 pr_warn("Could not create tracefs directory 'options'\n");
7206 create_trace_option_file(struct trace_array *tr,
7207 struct trace_option_dentry *topt,
7208 struct tracer_flags *flags,
7209 struct tracer_opt *opt)
7211 struct dentry *t_options;
7213 t_options = trace_options_init_dentry(tr);
7217 topt->flags = flags;
7221 topt->entry = trace_create_file(opt->name, 0644, t_options, topt,
7222 &trace_options_fops);
7227 create_trace_option_files(struct trace_array *tr, struct tracer *tracer)
7229 struct trace_option_dentry *topts;
7230 struct trace_options *tr_topts;
7231 struct tracer_flags *flags;
7232 struct tracer_opt *opts;
7239 flags = tracer->flags;
7241 if (!flags || !flags->opts)
7245 * If this is an instance, only create flags for tracers
7246 * the instance may have.
7248 if (!trace_ok_for_array(tracer, tr))
7251 for (i = 0; i < tr->nr_topts; i++) {
7252 /* Make sure there's no duplicate flags. */
7253 if (WARN_ON_ONCE(tr->topts[i].tracer->flags == tracer->flags))
7259 for (cnt = 0; opts[cnt].name; cnt++)
7262 topts = kcalloc(cnt + 1, sizeof(*topts), GFP_KERNEL);
7266 tr_topts = krealloc(tr->topts, sizeof(*tr->topts) * (tr->nr_topts + 1),
7273 tr->topts = tr_topts;
7274 tr->topts[tr->nr_topts].tracer = tracer;
7275 tr->topts[tr->nr_topts].topts = topts;
7278 for (cnt = 0; opts[cnt].name; cnt++) {
7279 create_trace_option_file(tr, &topts[cnt], flags,
7281 WARN_ONCE(topts[cnt].entry == NULL,
7282 "Failed to create trace option: %s",
7287 static struct dentry *
7288 create_trace_option_core_file(struct trace_array *tr,
7289 const char *option, long index)
7291 struct dentry *t_options;
7293 t_options = trace_options_init_dentry(tr);
7297 return trace_create_file(option, 0644, t_options,
7298 (void *)&tr->trace_flags_index[index],
7299 &trace_options_core_fops);
7302 static void create_trace_options_dir(struct trace_array *tr)
7304 struct dentry *t_options;
7305 bool top_level = tr == &global_trace;
7308 t_options = trace_options_init_dentry(tr);
7312 for (i = 0; trace_options[i]; i++) {
7314 !((1 << i) & TOP_LEVEL_TRACE_FLAGS))
7315 create_trace_option_core_file(tr, trace_options[i], i);
7320 rb_simple_read(struct file *filp, char __user *ubuf,
7321 size_t cnt, loff_t *ppos)
7323 struct trace_array *tr = filp->private_data;
7327 r = tracer_tracing_is_on(tr);
7328 r = sprintf(buf, "%d\n", r);
7330 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
7334 rb_simple_write(struct file *filp, const char __user *ubuf,
7335 size_t cnt, loff_t *ppos)
7337 struct trace_array *tr = filp->private_data;
7338 struct ring_buffer *buffer = tr->trace_buffer.buffer;
7342 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
7347 mutex_lock(&trace_types_lock);
7349 tracer_tracing_on(tr);
7350 if (tr->current_trace->start)
7351 tr->current_trace->start(tr);
7353 tracer_tracing_off(tr);
7354 if (tr->current_trace->stop)
7355 tr->current_trace->stop(tr);
7357 mutex_unlock(&trace_types_lock);
7365 static const struct file_operations rb_simple_fops = {
7366 .open = tracing_open_generic_tr,
7367 .read = rb_simple_read,
7368 .write = rb_simple_write,
7369 .release = tracing_release_generic_tr,
7370 .llseek = default_llseek,
7373 struct dentry *trace_instance_dir;
7376 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer);
7379 allocate_trace_buffer(struct trace_array *tr, struct trace_buffer *buf, int size)
7381 enum ring_buffer_flags rb_flags;
7383 rb_flags = tr->trace_flags & TRACE_ITER_OVERWRITE ? RB_FL_OVERWRITE : 0;
7387 buf->buffer = ring_buffer_alloc(size, rb_flags);
7391 buf->data = alloc_percpu(struct trace_array_cpu);
7393 ring_buffer_free(buf->buffer);
7397 /* Allocate the first page for all buffers */
7398 set_buffer_entries(&tr->trace_buffer,
7399 ring_buffer_size(tr->trace_buffer.buffer, 0));
7404 static int allocate_trace_buffers(struct trace_array *tr, int size)
7408 ret = allocate_trace_buffer(tr, &tr->trace_buffer, size);
7412 #ifdef CONFIG_TRACER_MAX_TRACE
7413 ret = allocate_trace_buffer(tr, &tr->max_buffer,
7414 allocate_snapshot ? size : 1);
7416 ring_buffer_free(tr->trace_buffer.buffer);
7417 free_percpu(tr->trace_buffer.data);
7420 tr->allocated_snapshot = allocate_snapshot;
7423 * Only the top level trace array gets its snapshot allocated
7424 * from the kernel command line.
7426 allocate_snapshot = false;
7431 static void free_trace_buffer(struct trace_buffer *buf)
7434 ring_buffer_free(buf->buffer);
7436 free_percpu(buf->data);
7441 static void free_trace_buffers(struct trace_array *tr)
7446 free_trace_buffer(&tr->trace_buffer);
7448 #ifdef CONFIG_TRACER_MAX_TRACE
7449 free_trace_buffer(&tr->max_buffer);
7453 static void init_trace_flags_index(struct trace_array *tr)
7457 /* Used by the trace options files */
7458 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++)
7459 tr->trace_flags_index[i] = i;
7462 static void __update_tracer_options(struct trace_array *tr)
7466 for (t = trace_types; t; t = t->next)
7467 add_tracer_options(tr, t);
7470 static void update_tracer_options(struct trace_array *tr)
7472 mutex_lock(&trace_types_lock);
7473 __update_tracer_options(tr);
7474 mutex_unlock(&trace_types_lock);
7477 static int instance_mkdir(const char *name)
7479 struct trace_array *tr;
7482 mutex_lock(&trace_types_lock);
7485 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
7486 if (tr->name && strcmp(tr->name, name) == 0)
7491 tr = kzalloc(sizeof(*tr), GFP_KERNEL);
7495 tr->name = kstrdup(name, GFP_KERNEL);
7499 if (!alloc_cpumask_var(&tr->tracing_cpumask, GFP_KERNEL))
7502 tr->trace_flags = global_trace.trace_flags & ~ZEROED_TRACE_FLAGS;
7504 cpumask_copy(tr->tracing_cpumask, cpu_all_mask);
7506 raw_spin_lock_init(&tr->start_lock);
7508 tr->max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
7510 tr->current_trace = &nop_trace;
7512 INIT_LIST_HEAD(&tr->systems);
7513 INIT_LIST_HEAD(&tr->events);
7515 if (allocate_trace_buffers(tr, trace_buf_size) < 0)
7518 tr->dir = tracefs_create_dir(name, trace_instance_dir);
7522 ret = event_trace_add_tracer(tr->dir, tr);
7524 tracefs_remove_recursive(tr->dir);
7528 ftrace_init_trace_array(tr);
7530 init_tracer_tracefs(tr, tr->dir);
7531 init_trace_flags_index(tr);
7532 __update_tracer_options(tr);
7534 list_add(&tr->list, &ftrace_trace_arrays);
7536 mutex_unlock(&trace_types_lock);
7541 free_trace_buffers(tr);
7542 free_cpumask_var(tr->tracing_cpumask);
7547 mutex_unlock(&trace_types_lock);
7553 static int instance_rmdir(const char *name)
7555 struct trace_array *tr;
7560 mutex_lock(&trace_types_lock);
7563 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
7564 if (tr->name && strcmp(tr->name, name) == 0) {
7573 if (tr->ref || (tr->current_trace && tr->current_trace->ref))
7576 list_del(&tr->list);
7578 /* Disable all the flags that were enabled coming in */
7579 for (i = 0; i < TRACE_FLAGS_MAX_SIZE; i++) {
7580 if ((1 << i) & ZEROED_TRACE_FLAGS)
7581 set_tracer_flag(tr, 1 << i, 0);
7584 tracing_set_nop(tr);
7585 clear_ftrace_function_probes(tr);
7586 event_trace_del_tracer(tr);
7587 ftrace_clear_pids(tr);
7588 ftrace_destroy_function_files(tr);
7589 tracefs_remove_recursive(tr->dir);
7590 free_trace_buffers(tr);
7592 for (i = 0; i < tr->nr_topts; i++) {
7593 kfree(tr->topts[i].topts);
7603 mutex_unlock(&trace_types_lock);
7608 static __init void create_trace_instances(struct dentry *d_tracer)
7610 trace_instance_dir = tracefs_create_instance_dir("instances", d_tracer,
7613 if (WARN_ON(!trace_instance_dir))
7618 init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer)
7622 trace_create_file("available_tracers", 0444, d_tracer,
7623 tr, &show_traces_fops);
7625 trace_create_file("current_tracer", 0644, d_tracer,
7626 tr, &set_tracer_fops);
7628 trace_create_file("tracing_cpumask", 0644, d_tracer,
7629 tr, &tracing_cpumask_fops);
7631 trace_create_file("trace_options", 0644, d_tracer,
7632 tr, &tracing_iter_fops);
7634 trace_create_file("trace", 0644, d_tracer,
7637 trace_create_file("trace_pipe", 0444, d_tracer,
7638 tr, &tracing_pipe_fops);
7640 trace_create_file("buffer_size_kb", 0644, d_tracer,
7641 tr, &tracing_entries_fops);
7643 trace_create_file("buffer_total_size_kb", 0444, d_tracer,
7644 tr, &tracing_total_entries_fops);
7646 trace_create_file("free_buffer", 0200, d_tracer,
7647 tr, &tracing_free_buffer_fops);
7649 trace_create_file("trace_marker", 0220, d_tracer,
7650 tr, &tracing_mark_fops);
7652 trace_create_file("trace_marker_raw", 0220, d_tracer,
7653 tr, &tracing_mark_raw_fops);
7655 trace_create_file("trace_clock", 0644, d_tracer, tr,
7658 trace_create_file("tracing_on", 0644, d_tracer,
7659 tr, &rb_simple_fops);
7661 create_trace_options_dir(tr);
7663 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
7664 trace_create_file("tracing_max_latency", 0644, d_tracer,
7665 &tr->max_latency, &tracing_max_lat_fops);
7668 if (ftrace_create_function_files(tr, d_tracer))
7669 WARN(1, "Could not allocate function filter files");
7671 #ifdef CONFIG_TRACER_SNAPSHOT
7672 trace_create_file("snapshot", 0644, d_tracer,
7673 tr, &snapshot_fops);
7676 for_each_tracing_cpu(cpu)
7677 tracing_init_tracefs_percpu(tr, cpu);
7679 ftrace_init_tracefs(tr, d_tracer);
7682 static struct vfsmount *trace_automount(struct dentry *mntpt, void *ingore)
7684 struct vfsmount *mnt;
7685 struct file_system_type *type;
7688 * To maintain backward compatibility for tools that mount
7689 * debugfs to get to the tracing facility, tracefs is automatically
7690 * mounted to the debugfs/tracing directory.
7692 type = get_fs_type("tracefs");
7695 mnt = vfs_submount(mntpt, type, "tracefs", NULL);
7696 put_filesystem(type);
7705 * tracing_init_dentry - initialize top level trace array
7707 * This is called when creating files or directories in the tracing
7708 * directory. It is called via fs_initcall() by any of the boot up code
7709 * and expects to return the dentry of the top level tracing directory.
7711 struct dentry *tracing_init_dentry(void)
7713 struct trace_array *tr = &global_trace;
7715 /* The top level trace array uses NULL as parent */
7719 if (WARN_ON(!tracefs_initialized()) ||
7720 (IS_ENABLED(CONFIG_DEBUG_FS) &&
7721 WARN_ON(!debugfs_initialized())))
7722 return ERR_PTR(-ENODEV);
7725 * As there may still be users that expect the tracing
7726 * files to exist in debugfs/tracing, we must automount
7727 * the tracefs file system there, so older tools still
7728 * work with the newer kerenl.
7730 tr->dir = debugfs_create_automount("tracing", NULL,
7731 trace_automount, NULL);
7733 pr_warn_once("Could not create debugfs directory 'tracing'\n");
7734 return ERR_PTR(-ENOMEM);
7740 extern struct trace_enum_map *__start_ftrace_enum_maps[];
7741 extern struct trace_enum_map *__stop_ftrace_enum_maps[];
7743 static void __init trace_enum_init(void)
7747 len = __stop_ftrace_enum_maps - __start_ftrace_enum_maps;
7748 trace_insert_enum_map(NULL, __start_ftrace_enum_maps, len);
7751 #ifdef CONFIG_MODULES
7752 static void trace_module_add_enums(struct module *mod)
7754 if (!mod->num_trace_enums)
7758 * Modules with bad taint do not have events created, do
7759 * not bother with enums either.
7761 if (trace_module_has_bad_taint(mod))
7764 trace_insert_enum_map(mod, mod->trace_enums, mod->num_trace_enums);
7767 #ifdef CONFIG_TRACE_ENUM_MAP_FILE
7768 static void trace_module_remove_enums(struct module *mod)
7770 union trace_enum_map_item *map;
7771 union trace_enum_map_item **last = &trace_enum_maps;
7773 if (!mod->num_trace_enums)
7776 mutex_lock(&trace_enum_mutex);
7778 map = trace_enum_maps;
7781 if (map->head.mod == mod)
7783 map = trace_enum_jmp_to_tail(map);
7784 last = &map->tail.next;
7785 map = map->tail.next;
7790 *last = trace_enum_jmp_to_tail(map)->tail.next;
7793 mutex_unlock(&trace_enum_mutex);
7796 static inline void trace_module_remove_enums(struct module *mod) { }
7797 #endif /* CONFIG_TRACE_ENUM_MAP_FILE */
7799 static int trace_module_notify(struct notifier_block *self,
7800 unsigned long val, void *data)
7802 struct module *mod = data;
7805 case MODULE_STATE_COMING:
7806 trace_module_add_enums(mod);
7808 case MODULE_STATE_GOING:
7809 trace_module_remove_enums(mod);
7816 static struct notifier_block trace_module_nb = {
7817 .notifier_call = trace_module_notify,
7820 #endif /* CONFIG_MODULES */
7822 static __init int tracer_init_tracefs(void)
7824 struct dentry *d_tracer;
7826 trace_access_lock_init();
7828 d_tracer = tracing_init_dentry();
7829 if (IS_ERR(d_tracer))
7832 init_tracer_tracefs(&global_trace, d_tracer);
7833 ftrace_init_tracefs_toplevel(&global_trace, d_tracer);
7835 trace_create_file("tracing_thresh", 0644, d_tracer,
7836 &global_trace, &tracing_thresh_fops);
7838 trace_create_file("README", 0444, d_tracer,
7839 NULL, &tracing_readme_fops);
7841 trace_create_file("saved_cmdlines", 0444, d_tracer,
7842 NULL, &tracing_saved_cmdlines_fops);
7844 trace_create_file("saved_cmdlines_size", 0644, d_tracer,
7845 NULL, &tracing_saved_cmdlines_size_fops);
7849 trace_create_enum_file(d_tracer);
7851 #ifdef CONFIG_MODULES
7852 register_module_notifier(&trace_module_nb);
7855 #ifdef CONFIG_DYNAMIC_FTRACE
7856 trace_create_file("dyn_ftrace_total_info", 0444, d_tracer,
7857 &ftrace_update_tot_cnt, &tracing_dyn_info_fops);
7860 create_trace_instances(d_tracer);
7862 update_tracer_options(&global_trace);
7867 static int trace_panic_handler(struct notifier_block *this,
7868 unsigned long event, void *unused)
7870 if (ftrace_dump_on_oops)
7871 ftrace_dump(ftrace_dump_on_oops);
7875 static struct notifier_block trace_panic_notifier = {
7876 .notifier_call = trace_panic_handler,
7878 .priority = 150 /* priority: INT_MAX >= x >= 0 */
7881 static int trace_die_handler(struct notifier_block *self,
7887 if (ftrace_dump_on_oops)
7888 ftrace_dump(ftrace_dump_on_oops);
7896 static struct notifier_block trace_die_notifier = {
7897 .notifier_call = trace_die_handler,
7902 * printk is set to max of 1024, we really don't need it that big.
7903 * Nothing should be printing 1000 characters anyway.
7905 #define TRACE_MAX_PRINT 1000
7908 * Define here KERN_TRACE so that we have one place to modify
7909 * it if we decide to change what log level the ftrace dump
7912 #define KERN_TRACE KERN_EMERG
7915 trace_printk_seq(struct trace_seq *s)
7917 /* Probably should print a warning here. */
7918 if (s->seq.len >= TRACE_MAX_PRINT)
7919 s->seq.len = TRACE_MAX_PRINT;
7922 * More paranoid code. Although the buffer size is set to
7923 * PAGE_SIZE, and TRACE_MAX_PRINT is 1000, this is just
7924 * an extra layer of protection.
7926 if (WARN_ON_ONCE(s->seq.len >= s->seq.size))
7927 s->seq.len = s->seq.size - 1;
7929 /* should be zero ended, but we are paranoid. */
7930 s->buffer[s->seq.len] = 0;
7932 printk(KERN_TRACE "%s", s->buffer);
7937 void trace_init_global_iter(struct trace_iterator *iter)
7939 iter->tr = &global_trace;
7940 iter->trace = iter->tr->current_trace;
7941 iter->cpu_file = RING_BUFFER_ALL_CPUS;
7942 iter->trace_buffer = &global_trace.trace_buffer;
7944 if (iter->trace && iter->trace->open)
7945 iter->trace->open(iter);
7947 /* Annotate start of buffers if we had overruns */
7948 if (ring_buffer_overruns(iter->trace_buffer->buffer))
7949 iter->iter_flags |= TRACE_FILE_ANNOTATE;
7951 /* Output in nanoseconds only if we are using a clock in nanoseconds. */
7952 if (trace_clocks[iter->tr->clock_id].in_ns)
7953 iter->iter_flags |= TRACE_FILE_TIME_IN_NS;
7956 void ftrace_dump(enum ftrace_dump_mode oops_dump_mode)
7958 /* use static because iter can be a bit big for the stack */
7959 static struct trace_iterator iter;
7960 static atomic_t dump_running;
7961 struct trace_array *tr = &global_trace;
7962 unsigned int old_userobj;
7963 unsigned long flags;
7966 /* Only allow one dump user at a time. */
7967 if (atomic_inc_return(&dump_running) != 1) {
7968 atomic_dec(&dump_running);
7973 * Always turn off tracing when we dump.
7974 * We don't need to show trace output of what happens
7975 * between multiple crashes.
7977 * If the user does a sysrq-z, then they can re-enable
7978 * tracing with echo 1 > tracing_on.
7982 local_irq_save(flags);
7984 /* Simulate the iterator */
7985 trace_init_global_iter(&iter);
7987 for_each_tracing_cpu(cpu) {
7988 atomic_inc(&per_cpu_ptr(iter.trace_buffer->data, cpu)->disabled);
7991 old_userobj = tr->trace_flags & TRACE_ITER_SYM_USEROBJ;
7993 /* don't look at user memory in panic mode */
7994 tr->trace_flags &= ~TRACE_ITER_SYM_USEROBJ;
7996 switch (oops_dump_mode) {
7998 iter.cpu_file = RING_BUFFER_ALL_CPUS;
8001 iter.cpu_file = raw_smp_processor_id();
8006 printk(KERN_TRACE "Bad dumping mode, switching to all CPUs dump\n");
8007 iter.cpu_file = RING_BUFFER_ALL_CPUS;
8010 printk(KERN_TRACE "Dumping ftrace buffer:\n");
8012 /* Did function tracer already get disabled? */
8013 if (ftrace_is_dead()) {
8014 printk("# WARNING: FUNCTION TRACING IS CORRUPTED\n");
8015 printk("# MAY BE MISSING FUNCTION EVENTS\n");
8019 * We need to stop all tracing on all CPUS to read the
8020 * the next buffer. This is a bit expensive, but is
8021 * not done often. We fill all what we can read,
8022 * and then release the locks again.
8025 while (!trace_empty(&iter)) {
8028 printk(KERN_TRACE "---------------------------------\n");
8032 /* reset all but tr, trace, and overruns */
8033 memset(&iter.seq, 0,
8034 sizeof(struct trace_iterator) -
8035 offsetof(struct trace_iterator, seq));
8036 iter.iter_flags |= TRACE_FILE_LAT_FMT;
8039 if (trace_find_next_entry_inc(&iter) != NULL) {
8042 ret = print_trace_line(&iter);
8043 if (ret != TRACE_TYPE_NO_CONSUME)
8044 trace_consume(&iter);
8046 touch_nmi_watchdog();
8048 trace_printk_seq(&iter.seq);
8052 printk(KERN_TRACE " (ftrace buffer empty)\n");
8054 printk(KERN_TRACE "---------------------------------\n");
8057 tr->trace_flags |= old_userobj;
8059 for_each_tracing_cpu(cpu) {
8060 atomic_dec(&per_cpu_ptr(iter.trace_buffer->data, cpu)->disabled);
8062 atomic_dec(&dump_running);
8063 local_irq_restore(flags);
8065 EXPORT_SYMBOL_GPL(ftrace_dump);
8067 __init static int tracer_alloc_buffers(void)
8073 * Make sure we don't accidently add more trace options
8074 * than we have bits for.
8076 BUILD_BUG_ON(TRACE_ITER_LAST_BIT > TRACE_FLAGS_MAX_SIZE);
8078 if (!alloc_cpumask_var(&tracing_buffer_mask, GFP_KERNEL))
8081 if (!alloc_cpumask_var(&global_trace.tracing_cpumask, GFP_KERNEL))
8082 goto out_free_buffer_mask;
8084 /* Only allocate trace_printk buffers if a trace_printk exists */
8085 if (__stop___trace_bprintk_fmt != __start___trace_bprintk_fmt)
8086 /* Must be called before global_trace.buffer is allocated */
8087 trace_printk_init_buffers();
8089 /* To save memory, keep the ring buffer size to its minimum */
8090 if (ring_buffer_expanded)
8091 ring_buf_size = trace_buf_size;
8095 cpumask_copy(tracing_buffer_mask, cpu_possible_mask);
8096 cpumask_copy(global_trace.tracing_cpumask, cpu_all_mask);
8098 raw_spin_lock_init(&global_trace.start_lock);
8101 * The prepare callbacks allocates some memory for the ring buffer. We
8102 * don't free the buffer if the if the CPU goes down. If we were to free
8103 * the buffer, then the user would lose any trace that was in the
8104 * buffer. The memory will be removed once the "instance" is removed.
8106 ret = cpuhp_setup_state_multi(CPUHP_TRACE_RB_PREPARE,
8107 "trace/RB:preapre", trace_rb_cpu_prepare,
8110 goto out_free_cpumask;
8111 /* Used for event triggers */
8112 temp_buffer = ring_buffer_alloc(PAGE_SIZE, RB_FL_OVERWRITE);
8114 goto out_rm_hp_state;
8116 if (trace_create_savedcmd() < 0)
8117 goto out_free_temp_buffer;
8119 /* TODO: make the number of buffers hot pluggable with CPUS */
8120 if (allocate_trace_buffers(&global_trace, ring_buf_size) < 0) {
8121 printk(KERN_ERR "tracer: failed to allocate ring buffer!\n");
8123 goto out_free_savedcmd;
8126 if (global_trace.buffer_disabled)
8129 if (trace_boot_clock) {
8130 ret = tracing_set_clock(&global_trace, trace_boot_clock);
8132 pr_warn("Trace clock %s not defined, going back to default\n",
8137 * register_tracer() might reference current_trace, so it
8138 * needs to be set before we register anything. This is
8139 * just a bootstrap of current_trace anyway.
8141 global_trace.current_trace = &nop_trace;
8143 global_trace.max_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
8145 ftrace_init_global_array_ops(&global_trace);
8147 init_trace_flags_index(&global_trace);
8149 register_tracer(&nop_trace);
8151 /* Function tracing may start here (via kernel command line) */
8152 init_function_trace();
8154 /* All seems OK, enable tracing */
8155 tracing_disabled = 0;
8157 atomic_notifier_chain_register(&panic_notifier_list,
8158 &trace_panic_notifier);
8160 register_die_notifier(&trace_die_notifier);
8162 global_trace.flags = TRACE_ARRAY_FL_GLOBAL;
8164 INIT_LIST_HEAD(&global_trace.systems);
8165 INIT_LIST_HEAD(&global_trace.events);
8166 list_add(&global_trace.list, &ftrace_trace_arrays);
8168 apply_trace_boot_options();
8170 register_snapshot_cmd();
8175 free_saved_cmdlines_buffer(savedcmd);
8176 out_free_temp_buffer:
8177 ring_buffer_free(temp_buffer);
8179 cpuhp_remove_multi_state(CPUHP_TRACE_RB_PREPARE);
8181 free_cpumask_var(global_trace.tracing_cpumask);
8182 out_free_buffer_mask:
8183 free_cpumask_var(tracing_buffer_mask);
8188 void __init early_trace_init(void)
8190 if (tracepoint_printk) {
8191 tracepoint_print_iter =
8192 kmalloc(sizeof(*tracepoint_print_iter), GFP_KERNEL);
8193 if (WARN_ON(!tracepoint_print_iter))
8194 tracepoint_printk = 0;
8196 static_key_enable(&tracepoint_printk_key.key);
8198 tracer_alloc_buffers();
8201 void __init trace_init(void)
8206 __init static int clear_boot_tracer(void)
8209 * The default tracer at boot buffer is an init section.
8210 * This function is called in lateinit. If we did not
8211 * find the boot tracer, then clear it out, to prevent
8212 * later registration from accessing the buffer that is
8213 * about to be freed.
8215 if (!default_bootup_tracer)
8218 printk(KERN_INFO "ftrace bootup tracer '%s' not registered.\n",
8219 default_bootup_tracer);
8220 default_bootup_tracer = NULL;
8225 fs_initcall(tracer_init_tracefs);
8226 late_initcall(clear_boot_tracer);