1 // SPDX-License-Identifier: GPL-2.0
3 * ring buffer based function tracer
5 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
6 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
8 * Based on code from the latency_tracer, that is:
10 * Copyright (C) 2004-2006 Ingo Molnar
11 * Copyright (C) 2004 Nadia Yvette Chambers
13 #include <linux/ring_buffer.h>
14 #include <linux/debugfs.h>
15 #include <linux/uaccess.h>
16 #include <linux/ftrace.h>
17 #include <linux/slab.h>
22 static void tracing_start_function_trace(struct trace_array *tr);
23 static void tracing_stop_function_trace(struct trace_array *tr);
25 function_trace_call(unsigned long ip, unsigned long parent_ip,
26 struct ftrace_ops *op, struct ftrace_regs *fregs);
28 function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
29 struct ftrace_ops *op, struct ftrace_regs *fregs);
31 function_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
32 struct ftrace_ops *op, struct ftrace_regs *fregs);
34 function_stack_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
35 struct ftrace_ops *op,
36 struct ftrace_regs *fregs);
37 static struct tracer_flags func_flags;
42 TRACE_FUNC_NO_OPTS = 0x0, /* No flags set. */
43 TRACE_FUNC_OPT_STACK = 0x1,
44 TRACE_FUNC_OPT_NO_REPEATS = 0x2,
46 /* Update this to next highest bit. */
47 TRACE_FUNC_OPT_HIGHEST_BIT = 0x4
50 #define TRACE_FUNC_OPT_MASK (TRACE_FUNC_OPT_HIGHEST_BIT - 1)
52 int ftrace_allocate_ftrace_ops(struct trace_array *tr)
54 struct ftrace_ops *ops;
56 /* The top level array uses the "global_ops" */
57 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
60 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
64 /* Currently only the non stack version is supported */
65 ops->func = function_trace_call;
66 ops->flags = FTRACE_OPS_FL_PID;
74 void ftrace_free_ftrace_ops(struct trace_array *tr)
80 int ftrace_create_function_files(struct trace_array *tr,
81 struct dentry *parent)
84 * The top level array uses the "global_ops", and the files are
87 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
93 ftrace_create_filter_files(tr->ops, parent);
98 void ftrace_destroy_function_files(struct trace_array *tr)
100 ftrace_destroy_filter_files(tr->ops);
101 ftrace_free_ftrace_ops(tr);
104 static ftrace_func_t select_trace_function(u32 flags_val)
106 switch (flags_val & TRACE_FUNC_OPT_MASK) {
107 case TRACE_FUNC_NO_OPTS:
108 return function_trace_call;
109 case TRACE_FUNC_OPT_STACK:
110 return function_stack_trace_call;
111 case TRACE_FUNC_OPT_NO_REPEATS:
112 return function_no_repeats_trace_call;
113 case TRACE_FUNC_OPT_STACK | TRACE_FUNC_OPT_NO_REPEATS:
114 return function_stack_no_repeats_trace_call;
120 static bool handle_func_repeats(struct trace_array *tr, u32 flags_val)
122 if (!tr->last_func_repeats &&
123 (flags_val & TRACE_FUNC_OPT_NO_REPEATS)) {
124 tr->last_func_repeats = alloc_percpu(struct trace_func_repeats);
125 if (!tr->last_func_repeats)
132 static int function_trace_init(struct trace_array *tr)
136 * Instance trace_arrays get their ops allocated
137 * at instance creation. Unless it failed
143 func = select_trace_function(func_flags.val);
147 if (!handle_func_repeats(tr, func_flags.val))
150 ftrace_init_array_ops(tr, func);
152 tr->array_buffer.cpu = raw_smp_processor_id();
154 tracing_start_cmdline_record();
155 tracing_start_function_trace(tr);
159 static void function_trace_reset(struct trace_array *tr)
161 tracing_stop_function_trace(tr);
162 tracing_stop_cmdline_record();
163 ftrace_reset_array_ops(tr);
166 static void function_trace_start(struct trace_array *tr)
168 tracing_reset_online_cpus(&tr->array_buffer);
172 function_trace_call(unsigned long ip, unsigned long parent_ip,
173 struct ftrace_ops *op, struct ftrace_regs *fregs)
175 struct trace_array *tr = op->private;
176 struct trace_array_cpu *data;
177 unsigned int trace_ctx;
181 if (unlikely(!tr->function_enabled))
184 bit = ftrace_test_recursion_trylock(ip, parent_ip);
188 trace_ctx = tracing_gen_ctx();
190 cpu = smp_processor_id();
191 data = per_cpu_ptr(tr->array_buffer.data, cpu);
192 if (!atomic_read(&data->disabled))
193 trace_function(tr, ip, parent_ip, trace_ctx);
195 ftrace_test_recursion_unlock(bit);
198 #ifdef CONFIG_UNWINDER_ORC
202 * function_stack_trace_call()
210 * function_stack_trace_call()
217 function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
218 struct ftrace_ops *op, struct ftrace_regs *fregs)
220 struct trace_array *tr = op->private;
221 struct trace_array_cpu *data;
225 unsigned int trace_ctx;
227 if (unlikely(!tr->function_enabled))
231 * Need to use raw, since this must be called before the
232 * recursive protection is performed.
234 local_irq_save(flags);
235 cpu = raw_smp_processor_id();
236 data = per_cpu_ptr(tr->array_buffer.data, cpu);
237 disabled = atomic_inc_return(&data->disabled);
239 if (likely(disabled == 1)) {
240 trace_ctx = tracing_gen_ctx_flags(flags);
241 trace_function(tr, ip, parent_ip, trace_ctx);
242 __trace_stack(tr, trace_ctx, STACK_SKIP);
245 atomic_dec(&data->disabled);
246 local_irq_restore(flags);
249 static inline bool is_repeat_check(struct trace_array *tr,
250 struct trace_func_repeats *last_info,
251 unsigned long ip, unsigned long parent_ip)
253 if (last_info->ip == ip &&
254 last_info->parent_ip == parent_ip &&
255 last_info->count < U16_MAX) {
256 last_info->ts_last_call =
257 ring_buffer_time_stamp(tr->array_buffer.buffer);
265 static inline void process_repeats(struct trace_array *tr,
266 unsigned long ip, unsigned long parent_ip,
267 struct trace_func_repeats *last_info,
268 unsigned int trace_ctx)
270 if (last_info->count) {
271 trace_last_func_repeats(tr, last_info, trace_ctx);
272 last_info->count = 0;
276 last_info->parent_ip = parent_ip;
280 function_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
281 struct ftrace_ops *op,
282 struct ftrace_regs *fregs)
284 struct trace_func_repeats *last_info;
285 struct trace_array *tr = op->private;
286 struct trace_array_cpu *data;
287 unsigned int trace_ctx;
292 if (unlikely(!tr->function_enabled))
295 bit = ftrace_test_recursion_trylock(ip, parent_ip);
299 cpu = smp_processor_id();
300 data = per_cpu_ptr(tr->array_buffer.data, cpu);
301 if (atomic_read(&data->disabled))
305 * An interrupt may happen at any place here. But as far as I can see,
306 * the only damage that this can cause is to mess up the repetition
307 * counter without valuable data being lost.
308 * TODO: think about a solution that is better than just hoping to be
311 last_info = per_cpu_ptr(tr->last_func_repeats, cpu);
312 if (is_repeat_check(tr, last_info, ip, parent_ip))
315 local_save_flags(flags);
316 trace_ctx = tracing_gen_ctx_flags(flags);
317 process_repeats(tr, ip, parent_ip, last_info, trace_ctx);
319 trace_function(tr, ip, parent_ip, trace_ctx);
322 ftrace_test_recursion_unlock(bit);
326 function_stack_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
327 struct ftrace_ops *op,
328 struct ftrace_regs *fregs)
330 struct trace_func_repeats *last_info;
331 struct trace_array *tr = op->private;
332 struct trace_array_cpu *data;
336 unsigned int trace_ctx;
338 if (unlikely(!tr->function_enabled))
342 * Need to use raw, since this must be called before the
343 * recursive protection is performed.
345 local_irq_save(flags);
346 cpu = raw_smp_processor_id();
347 data = per_cpu_ptr(tr->array_buffer.data, cpu);
348 disabled = atomic_inc_return(&data->disabled);
350 if (likely(disabled == 1)) {
351 last_info = per_cpu_ptr(tr->last_func_repeats, cpu);
352 if (is_repeat_check(tr, last_info, ip, parent_ip))
355 trace_ctx = tracing_gen_ctx_flags(flags);
356 process_repeats(tr, ip, parent_ip, last_info, trace_ctx);
358 trace_function(tr, ip, parent_ip, trace_ctx);
359 __trace_stack(tr, trace_ctx, STACK_SKIP);
363 atomic_dec(&data->disabled);
364 local_irq_restore(flags);
367 static struct tracer_opt func_opts[] = {
368 #ifdef CONFIG_STACKTRACE
369 { TRACER_OPT(func_stack_trace, TRACE_FUNC_OPT_STACK) },
371 { TRACER_OPT(func-no-repeats, TRACE_FUNC_OPT_NO_REPEATS) },
372 { } /* Always set a last empty entry */
375 static struct tracer_flags func_flags = {
376 .val = TRACE_FUNC_NO_OPTS, /* By default: all flags disabled */
380 static void tracing_start_function_trace(struct trace_array *tr)
382 tr->function_enabled = 0;
383 register_ftrace_function(tr->ops);
384 tr->function_enabled = 1;
387 static void tracing_stop_function_trace(struct trace_array *tr)
389 tr->function_enabled = 0;
390 unregister_ftrace_function(tr->ops);
393 static struct tracer function_trace;
396 func_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
401 /* Do nothing if already set. */
402 if (!!set == !!(func_flags.val & bit))
405 /* We can change this flag only when not running. */
406 if (tr->current_trace != &function_trace)
409 new_flags = (func_flags.val & ~bit) | (set ? bit : 0);
410 func = select_trace_function(new_flags);
414 /* Check if there's anything to change. */
415 if (tr->ops->func == func)
418 if (!handle_func_repeats(tr, new_flags))
421 unregister_ftrace_function(tr->ops);
422 tr->ops->func = func;
423 register_ftrace_function(tr->ops);
428 static struct tracer function_trace __tracer_data =
431 .init = function_trace_init,
432 .reset = function_trace_reset,
433 .start = function_trace_start,
434 .flags = &func_flags,
435 .set_flag = func_set_flag,
436 .allow_instances = true,
437 #ifdef CONFIG_FTRACE_SELFTEST
438 .selftest = trace_selftest_startup_function,
442 #ifdef CONFIG_DYNAMIC_FTRACE
443 static void update_traceon_count(struct ftrace_probe_ops *ops,
445 struct trace_array *tr, bool on,
448 struct ftrace_func_mapper *mapper = data;
453 * Tracing gets disabled (or enabled) once per count.
454 * This function can be called at the same time on multiple CPUs.
455 * It is fine if both disable (or enable) tracing, as disabling
456 * (or enabling) the second time doesn't do anything as the
457 * state of the tracer is already disabled (or enabled).
458 * What needs to be synchronized in this case is that the count
459 * only gets decremented once, even if the tracer is disabled
460 * (or enabled) twice, as the second one is really a nop.
462 * The memory barriers guarantee that we only decrement the
463 * counter once. First the count is read to a local variable
464 * and a read barrier is used to make sure that it is loaded
465 * before checking if the tracer is in the state we want.
466 * If the tracer is not in the state we want, then the count
467 * is guaranteed to be the old count.
469 * Next the tracer is set to the state we want (disabled or enabled)
470 * then a write memory barrier is used to make sure that
471 * the new state is visible before changing the counter by
472 * one minus the old counter. This guarantees that another CPU
473 * executing this code will see the new state before seeing
474 * the new counter value, and would not do anything if the new
477 * Note, there is no synchronization between this and a user
478 * setting the tracing_on file. But we currently don't care
481 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
487 /* Make sure we see count before checking tracing state */
490 if (on == !!tracer_tracing_is_on(tr))
494 tracer_tracing_on(tr);
496 tracer_tracing_off(tr);
498 /* Make sure tracing state is visible before updating count */
501 *count = old_count - 1;
505 ftrace_traceon_count(unsigned long ip, unsigned long parent_ip,
506 struct trace_array *tr, struct ftrace_probe_ops *ops,
509 update_traceon_count(ops, ip, tr, 1, data);
513 ftrace_traceoff_count(unsigned long ip, unsigned long parent_ip,
514 struct trace_array *tr, struct ftrace_probe_ops *ops,
517 update_traceon_count(ops, ip, tr, 0, data);
521 ftrace_traceon(unsigned long ip, unsigned long parent_ip,
522 struct trace_array *tr, struct ftrace_probe_ops *ops,
525 if (tracer_tracing_is_on(tr))
528 tracer_tracing_on(tr);
532 ftrace_traceoff(unsigned long ip, unsigned long parent_ip,
533 struct trace_array *tr, struct ftrace_probe_ops *ops,
536 if (!tracer_tracing_is_on(tr))
539 tracer_tracing_off(tr);
542 #ifdef CONFIG_UNWINDER_ORC
546 * function_trace_probe_call()
547 * ftrace_ops_assist_func()
550 #define FTRACE_STACK_SKIP 3
556 * ftrace_stacktrace()
557 * function_trace_probe_call()
558 * ftrace_ops_assist_func()
561 #define FTRACE_STACK_SKIP 5
564 static __always_inline void trace_stack(struct trace_array *tr)
566 unsigned int trace_ctx;
568 trace_ctx = tracing_gen_ctx();
570 __trace_stack(tr, trace_ctx, FTRACE_STACK_SKIP);
574 ftrace_stacktrace(unsigned long ip, unsigned long parent_ip,
575 struct trace_array *tr, struct ftrace_probe_ops *ops,
582 ftrace_stacktrace_count(unsigned long ip, unsigned long parent_ip,
583 struct trace_array *tr, struct ftrace_probe_ops *ops,
586 struct ftrace_func_mapper *mapper = data;
591 if (!tracing_is_on())
600 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
603 * Stack traces should only execute the number of times the
604 * user specified in the counter.
612 new_count = old_count - 1;
613 new_count = cmpxchg(count, old_count, new_count);
614 if (new_count == old_count)
617 if (!tracing_is_on())
620 } while (new_count != old_count);
623 static int update_count(struct ftrace_probe_ops *ops, unsigned long ip,
626 struct ftrace_func_mapper *mapper = data;
630 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
642 ftrace_dump_probe(unsigned long ip, unsigned long parent_ip,
643 struct trace_array *tr, struct ftrace_probe_ops *ops,
646 if (update_count(ops, ip, data))
647 ftrace_dump(DUMP_ALL);
650 /* Only dump the current CPU buffer. */
652 ftrace_cpudump_probe(unsigned long ip, unsigned long parent_ip,
653 struct trace_array *tr, struct ftrace_probe_ops *ops,
656 if (update_count(ops, ip, data))
657 ftrace_dump(DUMP_ORIG);
661 ftrace_probe_print(const char *name, struct seq_file *m,
662 unsigned long ip, struct ftrace_probe_ops *ops,
665 struct ftrace_func_mapper *mapper = data;
668 seq_printf(m, "%ps:%s", (void *)ip, name);
671 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
674 seq_printf(m, ":count=%ld\n", *count);
676 seq_puts(m, ":unlimited\n");
682 ftrace_traceon_print(struct seq_file *m, unsigned long ip,
683 struct ftrace_probe_ops *ops,
686 return ftrace_probe_print("traceon", m, ip, ops, data);
690 ftrace_traceoff_print(struct seq_file *m, unsigned long ip,
691 struct ftrace_probe_ops *ops, void *data)
693 return ftrace_probe_print("traceoff", m, ip, ops, data);
697 ftrace_stacktrace_print(struct seq_file *m, unsigned long ip,
698 struct ftrace_probe_ops *ops, void *data)
700 return ftrace_probe_print("stacktrace", m, ip, ops, data);
704 ftrace_dump_print(struct seq_file *m, unsigned long ip,
705 struct ftrace_probe_ops *ops, void *data)
707 return ftrace_probe_print("dump", m, ip, ops, data);
711 ftrace_cpudump_print(struct seq_file *m, unsigned long ip,
712 struct ftrace_probe_ops *ops, void *data)
714 return ftrace_probe_print("cpudump", m, ip, ops, data);
719 ftrace_count_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
720 unsigned long ip, void *init_data, void **data)
722 struct ftrace_func_mapper *mapper = *data;
725 mapper = allocate_ftrace_func_mapper();
731 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
735 ftrace_count_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
736 unsigned long ip, void *data)
738 struct ftrace_func_mapper *mapper = data;
741 free_ftrace_func_mapper(mapper, NULL);
745 ftrace_func_mapper_remove_ip(mapper, ip);
748 static struct ftrace_probe_ops traceon_count_probe_ops = {
749 .func = ftrace_traceon_count,
750 .print = ftrace_traceon_print,
751 .init = ftrace_count_init,
752 .free = ftrace_count_free,
755 static struct ftrace_probe_ops traceoff_count_probe_ops = {
756 .func = ftrace_traceoff_count,
757 .print = ftrace_traceoff_print,
758 .init = ftrace_count_init,
759 .free = ftrace_count_free,
762 static struct ftrace_probe_ops stacktrace_count_probe_ops = {
763 .func = ftrace_stacktrace_count,
764 .print = ftrace_stacktrace_print,
765 .init = ftrace_count_init,
766 .free = ftrace_count_free,
769 static struct ftrace_probe_ops dump_probe_ops = {
770 .func = ftrace_dump_probe,
771 .print = ftrace_dump_print,
772 .init = ftrace_count_init,
773 .free = ftrace_count_free,
776 static struct ftrace_probe_ops cpudump_probe_ops = {
777 .func = ftrace_cpudump_probe,
778 .print = ftrace_cpudump_print,
781 static struct ftrace_probe_ops traceon_probe_ops = {
782 .func = ftrace_traceon,
783 .print = ftrace_traceon_print,
786 static struct ftrace_probe_ops traceoff_probe_ops = {
787 .func = ftrace_traceoff,
788 .print = ftrace_traceoff_print,
791 static struct ftrace_probe_ops stacktrace_probe_ops = {
792 .func = ftrace_stacktrace,
793 .print = ftrace_stacktrace_print,
797 ftrace_trace_probe_callback(struct trace_array *tr,
798 struct ftrace_probe_ops *ops,
799 struct ftrace_hash *hash, char *glob,
800 char *cmd, char *param, int enable)
802 void *count = (void *)-1;
806 /* hash funcs only work with set_ftrace_filter */
811 return unregister_ftrace_function_probe_func(glob+1, tr, ops);
816 number = strsep(¶m, ":");
822 * We use the callback data field (which is a pointer)
825 ret = kstrtoul(number, 0, (unsigned long *)&count);
830 ret = register_ftrace_function_probe(glob, tr, ops, count);
832 return ret < 0 ? ret : 0;
836 ftrace_trace_onoff_callback(struct trace_array *tr, struct ftrace_hash *hash,
837 char *glob, char *cmd, char *param, int enable)
839 struct ftrace_probe_ops *ops;
844 /* we register both traceon and traceoff to this callback */
845 if (strcmp(cmd, "traceon") == 0)
846 ops = param ? &traceon_count_probe_ops : &traceon_probe_ops;
848 ops = param ? &traceoff_count_probe_ops : &traceoff_probe_ops;
850 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
855 ftrace_stacktrace_callback(struct trace_array *tr, struct ftrace_hash *hash,
856 char *glob, char *cmd, char *param, int enable)
858 struct ftrace_probe_ops *ops;
863 ops = param ? &stacktrace_count_probe_ops : &stacktrace_probe_ops;
865 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
870 ftrace_dump_callback(struct trace_array *tr, struct ftrace_hash *hash,
871 char *glob, char *cmd, char *param, int enable)
873 struct ftrace_probe_ops *ops;
878 ops = &dump_probe_ops;
880 /* Only dump once. */
881 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
886 ftrace_cpudump_callback(struct trace_array *tr, struct ftrace_hash *hash,
887 char *glob, char *cmd, char *param, int enable)
889 struct ftrace_probe_ops *ops;
894 ops = &cpudump_probe_ops;
896 /* Only dump once. */
897 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
901 static struct ftrace_func_command ftrace_traceon_cmd = {
903 .func = ftrace_trace_onoff_callback,
906 static struct ftrace_func_command ftrace_traceoff_cmd = {
908 .func = ftrace_trace_onoff_callback,
911 static struct ftrace_func_command ftrace_stacktrace_cmd = {
912 .name = "stacktrace",
913 .func = ftrace_stacktrace_callback,
916 static struct ftrace_func_command ftrace_dump_cmd = {
918 .func = ftrace_dump_callback,
921 static struct ftrace_func_command ftrace_cpudump_cmd = {
923 .func = ftrace_cpudump_callback,
926 static int __init init_func_cmd_traceon(void)
930 ret = register_ftrace_command(&ftrace_traceoff_cmd);
934 ret = register_ftrace_command(&ftrace_traceon_cmd);
936 goto out_free_traceoff;
938 ret = register_ftrace_command(&ftrace_stacktrace_cmd);
940 goto out_free_traceon;
942 ret = register_ftrace_command(&ftrace_dump_cmd);
944 goto out_free_stacktrace;
946 ret = register_ftrace_command(&ftrace_cpudump_cmd);
953 unregister_ftrace_command(&ftrace_dump_cmd);
955 unregister_ftrace_command(&ftrace_stacktrace_cmd);
957 unregister_ftrace_command(&ftrace_traceon_cmd);
959 unregister_ftrace_command(&ftrace_traceoff_cmd);
964 static inline int init_func_cmd_traceon(void)
968 #endif /* CONFIG_DYNAMIC_FTRACE */
970 __init int init_function_trace(void)
972 init_func_cmd_traceon();
973 return register_tracer(&function_trace);