2 * ring buffer based function tracer
7 * Based on code from the latency_tracer, that is:
9 * Copyright (C) 2004-2006 Ingo Molnar
10 * Copyright (C) 2004 Nadia Yvette Chambers
12 #include <linux/ring_buffer.h>
13 #include <linux/debugfs.h>
14 #include <linux/uaccess.h>
15 #include <linux/ftrace.h>
16 #include <linux/slab.h>
21 static void tracing_start_function_trace(struct trace_array *tr);
22 static void tracing_stop_function_trace(struct trace_array *tr);
24 function_trace_call(unsigned long ip, unsigned long parent_ip,
25 struct ftrace_ops *op, struct pt_regs *pt_regs);
27 function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
28 struct ftrace_ops *op, struct pt_regs *pt_regs);
29 static struct tracer_flags func_flags;
33 TRACE_FUNC_OPT_STACK = 0x1,
36 static int allocate_ftrace_ops(struct trace_array *tr)
38 struct ftrace_ops *ops;
40 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
44 /* Currently only the non stack verision is supported */
45 ops->func = function_trace_call;
46 ops->flags = FTRACE_OPS_FL_RECURSION_SAFE | FTRACE_OPS_FL_PID;
54 int ftrace_create_function_files(struct trace_array *tr,
55 struct dentry *parent)
60 * The top level array uses the "global_ops", and the files are
63 if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
66 ret = allocate_ftrace_ops(tr);
70 ftrace_create_filter_files(tr->ops, parent);
75 void ftrace_destroy_function_files(struct trace_array *tr)
77 ftrace_destroy_filter_files(tr->ops);
82 static int function_trace_init(struct trace_array *tr)
87 * Instance trace_arrays get their ops allocated
88 * at instance creation. Unless it failed
94 /* Currently only the global instance can do stack tracing */
95 if (tr->flags & TRACE_ARRAY_FL_GLOBAL &&
96 func_flags.val & TRACE_FUNC_OPT_STACK)
97 func = function_stack_trace_call;
99 func = function_trace_call;
101 ftrace_init_array_ops(tr, func);
103 tr->trace_buffer.cpu = get_cpu();
106 tracing_start_cmdline_record();
107 tracing_start_function_trace(tr);
111 static void function_trace_reset(struct trace_array *tr)
113 tracing_stop_function_trace(tr);
114 tracing_stop_cmdline_record();
115 ftrace_reset_array_ops(tr);
118 static void function_trace_start(struct trace_array *tr)
120 tracing_reset_online_cpus(&tr->trace_buffer);
124 function_trace_call(unsigned long ip, unsigned long parent_ip,
125 struct ftrace_ops *op, struct pt_regs *pt_regs)
127 struct trace_array *tr = op->private;
128 struct trace_array_cpu *data;
134 if (unlikely(!tr->function_enabled))
137 pc = preempt_count();
138 preempt_disable_notrace();
140 bit = trace_test_and_set_recursion(TRACE_FTRACE_START, TRACE_FTRACE_MAX);
144 cpu = smp_processor_id();
145 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
146 if (!atomic_read(&data->disabled)) {
147 local_save_flags(flags);
148 trace_function(tr, ip, parent_ip, flags, pc);
150 trace_clear_recursion(bit);
153 preempt_enable_notrace();
157 function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
158 struct ftrace_ops *op, struct pt_regs *pt_regs)
160 struct trace_array *tr = op->private;
161 struct trace_array_cpu *data;
167 if (unlikely(!tr->function_enabled))
171 * Need to use raw, since this must be called before the
172 * recursive protection is performed.
174 local_irq_save(flags);
175 cpu = raw_smp_processor_id();
176 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
177 disabled = atomic_inc_return(&data->disabled);
179 if (likely(disabled == 1)) {
180 pc = preempt_count();
181 trace_function(tr, ip, parent_ip, flags, pc);
184 * __ftrace_trace_stack,
186 * function_stack_trace_call
190 __trace_stack(tr, flags, 5, pc);
193 atomic_dec(&data->disabled);
194 local_irq_restore(flags);
197 static struct tracer_opt func_opts[] = {
198 #ifdef CONFIG_STACKTRACE
199 { TRACER_OPT(func_stack_trace, TRACE_FUNC_OPT_STACK) },
201 { } /* Always set a last empty entry */
204 static struct tracer_flags func_flags = {
205 .val = 0, /* By default: all flags disabled */
209 static void tracing_start_function_trace(struct trace_array *tr)
211 tr->function_enabled = 0;
212 register_ftrace_function(tr->ops);
213 tr->function_enabled = 1;
216 static void tracing_stop_function_trace(struct trace_array *tr)
218 tr->function_enabled = 0;
219 unregister_ftrace_function(tr->ops);
222 static struct tracer function_trace;
225 func_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
228 case TRACE_FUNC_OPT_STACK:
229 /* do nothing if already set */
230 if (!!set == !!(func_flags.val & TRACE_FUNC_OPT_STACK))
233 /* We can change this flag when not running. */
234 if (tr->current_trace != &function_trace)
237 unregister_ftrace_function(tr->ops);
240 tr->ops->func = function_stack_trace_call;
241 register_ftrace_function(tr->ops);
243 tr->ops->func = function_trace_call;
244 register_ftrace_function(tr->ops);
255 static struct tracer function_trace __tracer_data =
258 .init = function_trace_init,
259 .reset = function_trace_reset,
260 .start = function_trace_start,
261 .flags = &func_flags,
262 .set_flag = func_set_flag,
263 .allow_instances = true,
264 #ifdef CONFIG_FTRACE_SELFTEST
265 .selftest = trace_selftest_startup_function,
269 #ifdef CONFIG_DYNAMIC_FTRACE
270 static void update_traceon_count(struct ftrace_probe_ops *ops,
272 struct trace_array *tr, bool on,
275 struct ftrace_func_mapper *mapper = data;
280 * Tracing gets disabled (or enabled) once per count.
281 * This function can be called at the same time on multiple CPUs.
282 * It is fine if both disable (or enable) tracing, as disabling
283 * (or enabling) the second time doesn't do anything as the
284 * state of the tracer is already disabled (or enabled).
285 * What needs to be synchronized in this case is that the count
286 * only gets decremented once, even if the tracer is disabled
287 * (or enabled) twice, as the second one is really a nop.
289 * The memory barriers guarantee that we only decrement the
290 * counter once. First the count is read to a local variable
291 * and a read barrier is used to make sure that it is loaded
292 * before checking if the tracer is in the state we want.
293 * If the tracer is not in the state we want, then the count
294 * is guaranteed to be the old count.
296 * Next the tracer is set to the state we want (disabled or enabled)
297 * then a write memory barrier is used to make sure that
298 * the new state is visible before changing the counter by
299 * one minus the old counter. This guarantees that another CPU
300 * executing this code will see the new state before seeing
301 * the new counter value, and would not do anything if the new
304 * Note, there is no synchronization between this and a user
305 * setting the tracing_on file. But we currently don't care
308 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
314 /* Make sure we see count before checking tracing state */
317 if (on == !!tracer_tracing_is_on(tr))
321 tracer_tracing_on(tr);
323 tracer_tracing_off(tr);
325 /* Make sure tracing state is visible before updating count */
328 *count = old_count - 1;
332 ftrace_traceon_count(unsigned long ip, unsigned long parent_ip,
333 struct trace_array *tr, struct ftrace_probe_ops *ops,
336 update_traceon_count(ops, ip, tr, 1, data);
340 ftrace_traceoff_count(unsigned long ip, unsigned long parent_ip,
341 struct trace_array *tr, struct ftrace_probe_ops *ops,
344 update_traceon_count(ops, ip, tr, 0, data);
348 ftrace_traceon(unsigned long ip, unsigned long parent_ip,
349 struct trace_array *tr, struct ftrace_probe_ops *ops,
352 if (tracer_tracing_is_on(tr))
355 tracer_tracing_on(tr);
359 ftrace_traceoff(unsigned long ip, unsigned long parent_ip,
360 struct trace_array *tr, struct ftrace_probe_ops *ops,
363 if (!tracer_tracing_is_on(tr))
366 tracer_tracing_off(tr);
371 * ftrace_stacktrace()
372 * function_trace_probe_call()
373 * ftrace_ops_list_func()
378 static __always_inline void trace_stack(struct trace_array *tr)
383 local_save_flags(flags);
384 pc = preempt_count();
386 __trace_stack(tr, flags, STACK_SKIP, pc);
390 ftrace_stacktrace(unsigned long ip, unsigned long parent_ip,
391 struct trace_array *tr, struct ftrace_probe_ops *ops,
398 ftrace_stacktrace_count(unsigned long ip, unsigned long parent_ip,
399 struct trace_array *tr, struct ftrace_probe_ops *ops,
402 struct ftrace_func_mapper *mapper = data;
407 if (!tracing_is_on())
416 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
419 * Stack traces should only execute the number of times the
420 * user specified in the counter.
428 new_count = old_count - 1;
429 new_count = cmpxchg(count, old_count, new_count);
430 if (new_count == old_count)
433 if (!tracing_is_on())
436 } while (new_count != old_count);
439 static int update_count(struct ftrace_probe_ops *ops, unsigned long ip,
442 struct ftrace_func_mapper *mapper = data;
446 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
458 ftrace_dump_probe(unsigned long ip, unsigned long parent_ip,
459 struct trace_array *tr, struct ftrace_probe_ops *ops,
462 if (update_count(ops, ip, data))
463 ftrace_dump(DUMP_ALL);
466 /* Only dump the current CPU buffer. */
468 ftrace_cpudump_probe(unsigned long ip, unsigned long parent_ip,
469 struct trace_array *tr, struct ftrace_probe_ops *ops,
472 if (update_count(ops, ip, data))
473 ftrace_dump(DUMP_ORIG);
477 ftrace_probe_print(const char *name, struct seq_file *m,
478 unsigned long ip, struct ftrace_probe_ops *ops,
481 struct ftrace_func_mapper *mapper = data;
484 seq_printf(m, "%ps:%s", (void *)ip, name);
487 count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
490 seq_printf(m, ":count=%ld\n", *count);
492 seq_puts(m, ":unlimited\n");
498 ftrace_traceon_print(struct seq_file *m, unsigned long ip,
499 struct ftrace_probe_ops *ops,
502 return ftrace_probe_print("traceon", m, ip, ops, data);
506 ftrace_traceoff_print(struct seq_file *m, unsigned long ip,
507 struct ftrace_probe_ops *ops, void *data)
509 return ftrace_probe_print("traceoff", m, ip, ops, data);
513 ftrace_stacktrace_print(struct seq_file *m, unsigned long ip,
514 struct ftrace_probe_ops *ops, void *data)
516 return ftrace_probe_print("stacktrace", m, ip, ops, data);
520 ftrace_dump_print(struct seq_file *m, unsigned long ip,
521 struct ftrace_probe_ops *ops, void *data)
523 return ftrace_probe_print("dump", m, ip, ops, data);
527 ftrace_cpudump_print(struct seq_file *m, unsigned long ip,
528 struct ftrace_probe_ops *ops, void *data)
530 return ftrace_probe_print("cpudump", m, ip, ops, data);
535 ftrace_count_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
536 unsigned long ip, void *init_data, void **data)
538 struct ftrace_func_mapper *mapper = *data;
541 mapper = allocate_ftrace_func_mapper();
547 return ftrace_func_mapper_add_ip(mapper, ip, init_data);
551 ftrace_count_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
552 unsigned long ip, void *data)
554 struct ftrace_func_mapper *mapper = data;
557 free_ftrace_func_mapper(mapper, NULL);
561 ftrace_func_mapper_remove_ip(mapper, ip);
564 static struct ftrace_probe_ops traceon_count_probe_ops = {
565 .func = ftrace_traceon_count,
566 .print = ftrace_traceon_print,
567 .init = ftrace_count_init,
568 .free = ftrace_count_free,
571 static struct ftrace_probe_ops traceoff_count_probe_ops = {
572 .func = ftrace_traceoff_count,
573 .print = ftrace_traceoff_print,
574 .init = ftrace_count_init,
575 .free = ftrace_count_free,
578 static struct ftrace_probe_ops stacktrace_count_probe_ops = {
579 .func = ftrace_stacktrace_count,
580 .print = ftrace_stacktrace_print,
581 .init = ftrace_count_init,
582 .free = ftrace_count_free,
585 static struct ftrace_probe_ops dump_probe_ops = {
586 .func = ftrace_dump_probe,
587 .print = ftrace_dump_print,
588 .init = ftrace_count_init,
589 .free = ftrace_count_free,
592 static struct ftrace_probe_ops cpudump_probe_ops = {
593 .func = ftrace_cpudump_probe,
594 .print = ftrace_cpudump_print,
597 static struct ftrace_probe_ops traceon_probe_ops = {
598 .func = ftrace_traceon,
599 .print = ftrace_traceon_print,
602 static struct ftrace_probe_ops traceoff_probe_ops = {
603 .func = ftrace_traceoff,
604 .print = ftrace_traceoff_print,
607 static struct ftrace_probe_ops stacktrace_probe_ops = {
608 .func = ftrace_stacktrace,
609 .print = ftrace_stacktrace_print,
613 ftrace_trace_probe_callback(struct trace_array *tr,
614 struct ftrace_probe_ops *ops,
615 struct ftrace_hash *hash, char *glob,
616 char *cmd, char *param, int enable)
618 void *count = (void *)-1;
622 /* hash funcs only work with set_ftrace_filter */
627 return unregister_ftrace_function_probe_func(glob+1, tr, ops);
632 number = strsep(¶m, ":");
638 * We use the callback data field (which is a pointer)
641 ret = kstrtoul(number, 0, (unsigned long *)&count);
646 ret = register_ftrace_function_probe(glob, tr, ops, count);
648 return ret < 0 ? ret : 0;
652 ftrace_trace_onoff_callback(struct trace_array *tr, struct ftrace_hash *hash,
653 char *glob, char *cmd, char *param, int enable)
655 struct ftrace_probe_ops *ops;
657 /* we register both traceon and traceoff to this callback */
658 if (strcmp(cmd, "traceon") == 0)
659 ops = param ? &traceon_count_probe_ops : &traceon_probe_ops;
661 ops = param ? &traceoff_count_probe_ops : &traceoff_probe_ops;
663 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
668 ftrace_stacktrace_callback(struct trace_array *tr, struct ftrace_hash *hash,
669 char *glob, char *cmd, char *param, int enable)
671 struct ftrace_probe_ops *ops;
673 ops = param ? &stacktrace_count_probe_ops : &stacktrace_probe_ops;
675 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
680 ftrace_dump_callback(struct trace_array *tr, struct ftrace_hash *hash,
681 char *glob, char *cmd, char *param, int enable)
683 struct ftrace_probe_ops *ops;
685 ops = &dump_probe_ops;
687 /* Only dump once. */
688 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
693 ftrace_cpudump_callback(struct trace_array *tr, struct ftrace_hash *hash,
694 char *glob, char *cmd, char *param, int enable)
696 struct ftrace_probe_ops *ops;
698 ops = &cpudump_probe_ops;
700 /* Only dump once. */
701 return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
705 static struct ftrace_func_command ftrace_traceon_cmd = {
707 .func = ftrace_trace_onoff_callback,
710 static struct ftrace_func_command ftrace_traceoff_cmd = {
712 .func = ftrace_trace_onoff_callback,
715 static struct ftrace_func_command ftrace_stacktrace_cmd = {
716 .name = "stacktrace",
717 .func = ftrace_stacktrace_callback,
720 static struct ftrace_func_command ftrace_dump_cmd = {
722 .func = ftrace_dump_callback,
725 static struct ftrace_func_command ftrace_cpudump_cmd = {
727 .func = ftrace_cpudump_callback,
730 static int __init init_func_cmd_traceon(void)
734 ret = register_ftrace_command(&ftrace_traceoff_cmd);
738 ret = register_ftrace_command(&ftrace_traceon_cmd);
740 goto out_free_traceoff;
742 ret = register_ftrace_command(&ftrace_stacktrace_cmd);
744 goto out_free_traceon;
746 ret = register_ftrace_command(&ftrace_dump_cmd);
748 goto out_free_stacktrace;
750 ret = register_ftrace_command(&ftrace_cpudump_cmd);
757 unregister_ftrace_command(&ftrace_dump_cmd);
759 unregister_ftrace_command(&ftrace_stacktrace_cmd);
761 unregister_ftrace_command(&ftrace_traceon_cmd);
763 unregister_ftrace_command(&ftrace_traceoff_cmd);
768 static inline int init_func_cmd_traceon(void)
772 #endif /* CONFIG_DYNAMIC_FTRACE */
774 __init int init_function_trace(void)
776 init_func_cmd_traceon();
777 return register_tracer(&function_trace);