1 // SPDX-License-Identifier: GPL-2.0
3 * trace irqs off critical timings
5 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
6 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
8 * From code in the latency_tracer, that is:
10 * Copyright (C) 2004-2006 Ingo Molnar
11 * Copyright (C) 2004 Nadia Yvette Chambers
13 #include <linux/kallsyms.h>
14 #include <linux/uaccess.h>
15 #include <linux/module.h>
16 #include <linux/ftrace.h>
17 #include <linux/kprobes.h>
21 #include <trace/events/preemptirq.h>
23 #if defined(CONFIG_IRQSOFF_TRACER) || defined(CONFIG_PREEMPT_TRACER)
24 static struct trace_array
*irqsoff_trace __read_mostly
;
25 static int tracer_enabled __read_mostly
;
27 static DEFINE_PER_CPU(int, tracing_cpu
);
29 static DEFINE_RAW_SPINLOCK(max_trace_lock
);
32 TRACER_IRQS_OFF
= (1 << 1),
33 TRACER_PREEMPT_OFF
= (1 << 2),
36 static int trace_type __read_mostly
;
38 static int save_flags
;
40 static void stop_irqsoff_tracer(struct trace_array
*tr
, int graph
);
41 static int start_irqsoff_tracer(struct trace_array
*tr
, int graph
);
43 #ifdef CONFIG_PREEMPT_TRACER
47 return ((trace_type
& TRACER_PREEMPT_OFF
) && pc
);
50 # define preempt_trace(pc) (0)
53 #ifdef CONFIG_IRQSOFF_TRACER
57 return ((trace_type
& TRACER_IRQS_OFF
) &&
61 # define irq_trace() (0)
64 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
65 static int irqsoff_display_graph(struct trace_array
*tr
, int set
);
66 # define is_graph(tr) ((tr)->trace_flags & TRACE_ITER_DISPLAY_GRAPH)
68 static inline int irqsoff_display_graph(struct trace_array
*tr
, int set
)
72 # define is_graph(tr) false
76 * Sequence count - we record it when starting a measurement and
77 * skip the latency if the sequence has changed - some other section
78 * did a maximum and could disturb our measurement with serial console
79 * printouts, etc. Truly coinciding maximum latencies should be rare
80 * and what happens together happens separately as well, so this doesn't
81 * decrease the validity of the maximum found:
83 static __cacheline_aligned_in_smp
unsigned long max_sequence
;
85 #ifdef CONFIG_FUNCTION_TRACER
87 * Prologue for the preempt and irqs off function tracers.
89 * Returns 1 if it is OK to continue, and data->disabled is
91 * 0 if the trace is to be ignored, and data->disabled
94 * Note, this function is also used outside this ifdef but
95 * inside the #ifdef of the function graph tracer below.
96 * This is OK, since the function graph tracer is
97 * dependent on the function tracer.
99 static int func_prolog_dec(struct trace_array
*tr
,
100 struct trace_array_cpu
**data
,
101 unsigned long *flags
)
107 * Does not matter if we preempt. We test the flags
108 * afterward, to see if irqs are disabled or not.
109 * If we preempt and get a false positive, the flags
112 cpu
= raw_smp_processor_id();
113 if (likely(!per_cpu(tracing_cpu
, cpu
)))
116 local_save_flags(*flags
);
118 * Slight chance to get a false positive on tracing_cpu,
119 * although I'm starting to think there isn't a chance.
120 * Leave this for now just to be paranoid.
122 if (!irqs_disabled_flags(*flags
) && !preempt_count())
125 *data
= per_cpu_ptr(tr
->array_buffer
.data
, cpu
);
126 disabled
= atomic_inc_return(&(*data
)->disabled
);
128 if (likely(disabled
== 1))
131 atomic_dec(&(*data
)->disabled
);
137 * irqsoff uses its own tracer function to keep the overhead down:
140 irqsoff_tracer_call(unsigned long ip
, unsigned long parent_ip
,
141 struct ftrace_ops
*op
, struct ftrace_regs
*fregs
)
143 struct trace_array
*tr
= irqsoff_trace
;
144 struct trace_array_cpu
*data
;
147 if (!func_prolog_dec(tr
, &data
, &flags
))
150 trace_function(tr
, ip
, parent_ip
, flags
, preempt_count());
152 atomic_dec(&data
->disabled
);
154 #endif /* CONFIG_FUNCTION_TRACER */
156 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
157 static int irqsoff_display_graph(struct trace_array
*tr
, int set
)
161 if (!(is_graph(tr
) ^ set
))
164 stop_irqsoff_tracer(irqsoff_trace
, !set
);
166 for_each_possible_cpu(cpu
)
167 per_cpu(tracing_cpu
, cpu
) = 0;
170 tracing_reset_online_cpus(&irqsoff_trace
->array_buffer
);
172 return start_irqsoff_tracer(irqsoff_trace
, set
);
175 static int irqsoff_graph_entry(struct ftrace_graph_ent
*trace
)
177 struct trace_array
*tr
= irqsoff_trace
;
178 struct trace_array_cpu
*data
;
183 if (ftrace_graph_ignore_func(trace
))
186 * Do not trace a function if it's filtered by set_graph_notrace.
187 * Make the index of ret stack negative to indicate that it should
188 * ignore further functions. But it needs its own ret stack entry
189 * to recover the original index in order to continue tracing after
190 * returning from the function.
192 if (ftrace_graph_notrace_addr(trace
->func
))
195 if (!func_prolog_dec(tr
, &data
, &flags
))
198 pc
= preempt_count();
199 ret
= __trace_graph_entry(tr
, trace
, flags
, pc
);
200 atomic_dec(&data
->disabled
);
205 static void irqsoff_graph_return(struct ftrace_graph_ret
*trace
)
207 struct trace_array
*tr
= irqsoff_trace
;
208 struct trace_array_cpu
*data
;
212 ftrace_graph_addr_finish(trace
);
214 if (!func_prolog_dec(tr
, &data
, &flags
))
217 pc
= preempt_count();
218 __trace_graph_return(tr
, trace
, flags
, pc
);
219 atomic_dec(&data
->disabled
);
222 static struct fgraph_ops fgraph_ops
= {
223 .entryfunc
= &irqsoff_graph_entry
,
224 .retfunc
= &irqsoff_graph_return
,
227 static void irqsoff_trace_open(struct trace_iterator
*iter
)
229 if (is_graph(iter
->tr
))
230 graph_trace_open(iter
);
234 static void irqsoff_trace_close(struct trace_iterator
*iter
)
237 graph_trace_close(iter
);
240 #define GRAPH_TRACER_FLAGS (TRACE_GRAPH_PRINT_CPU | \
241 TRACE_GRAPH_PRINT_PROC | \
242 TRACE_GRAPH_PRINT_REL_TIME | \
243 TRACE_GRAPH_PRINT_DURATION)
245 static enum print_line_t
irqsoff_print_line(struct trace_iterator
*iter
)
248 * In graph mode call the graph tracer output function,
249 * otherwise go with the TRACE_FN event handler
251 if (is_graph(iter
->tr
))
252 return print_graph_function_flags(iter
, GRAPH_TRACER_FLAGS
);
254 return TRACE_TYPE_UNHANDLED
;
257 static void irqsoff_print_header(struct seq_file
*s
)
259 struct trace_array
*tr
= irqsoff_trace
;
262 print_graph_headers_flags(s
, GRAPH_TRACER_FLAGS
);
264 trace_default_header(s
);
268 __trace_function(struct trace_array
*tr
,
269 unsigned long ip
, unsigned long parent_ip
,
270 unsigned long flags
, int pc
)
273 trace_graph_function(tr
, ip
, parent_ip
, flags
, pc
);
275 trace_function(tr
, ip
, parent_ip
, flags
, pc
);
279 #define __trace_function trace_function
281 static enum print_line_t
irqsoff_print_line(struct trace_iterator
*iter
)
283 return TRACE_TYPE_UNHANDLED
;
286 static void irqsoff_trace_open(struct trace_iterator
*iter
) { }
287 static void irqsoff_trace_close(struct trace_iterator
*iter
) { }
289 #ifdef CONFIG_FUNCTION_TRACER
290 static void irqsoff_print_header(struct seq_file
*s
)
292 trace_default_header(s
);
295 static void irqsoff_print_header(struct seq_file
*s
)
297 trace_latency_header(s
);
299 #endif /* CONFIG_FUNCTION_TRACER */
300 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
303 * Should this new latency be reported/recorded?
305 static bool report_latency(struct trace_array
*tr
, u64 delta
)
307 if (tracing_thresh
) {
308 if (delta
< tracing_thresh
)
311 if (delta
<= tr
->max_latency
)
318 check_critical_timing(struct trace_array
*tr
,
319 struct trace_array_cpu
*data
,
320 unsigned long parent_ip
,
327 T0
= data
->preempt_timestamp
;
328 T1
= ftrace_now(cpu
);
331 local_save_flags(flags
);
333 pc
= preempt_count();
335 if (!report_latency(tr
, delta
))
338 raw_spin_lock_irqsave(&max_trace_lock
, flags
);
340 /* check if we are still the max latency */
341 if (!report_latency(tr
, delta
))
344 __trace_function(tr
, CALLER_ADDR0
, parent_ip
, flags
, pc
);
345 /* Skip 5 functions to get to the irq/preempt enable function */
346 __trace_stack(tr
, flags
, 5, pc
);
348 if (data
->critical_sequence
!= max_sequence
)
351 data
->critical_end
= parent_ip
;
353 if (likely(!is_tracing_stopped())) {
354 tr
->max_latency
= delta
;
355 update_max_tr_single(tr
, current
, cpu
);
361 raw_spin_unlock_irqrestore(&max_trace_lock
, flags
);
364 data
->critical_sequence
= max_sequence
;
365 data
->preempt_timestamp
= ftrace_now(cpu
);
366 __trace_function(tr
, CALLER_ADDR0
, parent_ip
, flags
, pc
);
369 static nokprobe_inline
void
370 start_critical_timing(unsigned long ip
, unsigned long parent_ip
, int pc
)
373 struct trace_array
*tr
= irqsoff_trace
;
374 struct trace_array_cpu
*data
;
377 if (!tracer_enabled
|| !tracing_is_enabled())
380 cpu
= raw_smp_processor_id();
382 if (per_cpu(tracing_cpu
, cpu
))
385 data
= per_cpu_ptr(tr
->array_buffer
.data
, cpu
);
387 if (unlikely(!data
) || atomic_read(&data
->disabled
))
390 atomic_inc(&data
->disabled
);
392 data
->critical_sequence
= max_sequence
;
393 data
->preempt_timestamp
= ftrace_now(cpu
);
394 data
->critical_start
= parent_ip
? : ip
;
396 local_save_flags(flags
);
398 __trace_function(tr
, ip
, parent_ip
, flags
, pc
);
400 per_cpu(tracing_cpu
, cpu
) = 1;
402 atomic_dec(&data
->disabled
);
405 static nokprobe_inline
void
406 stop_critical_timing(unsigned long ip
, unsigned long parent_ip
, int pc
)
409 struct trace_array
*tr
= irqsoff_trace
;
410 struct trace_array_cpu
*data
;
413 cpu
= raw_smp_processor_id();
414 /* Always clear the tracing cpu on stopping the trace */
415 if (unlikely(per_cpu(tracing_cpu
, cpu
)))
416 per_cpu(tracing_cpu
, cpu
) = 0;
420 if (!tracer_enabled
|| !tracing_is_enabled())
423 data
= per_cpu_ptr(tr
->array_buffer
.data
, cpu
);
425 if (unlikely(!data
) ||
426 !data
->critical_start
|| atomic_read(&data
->disabled
))
429 atomic_inc(&data
->disabled
);
431 local_save_flags(flags
);
432 __trace_function(tr
, ip
, parent_ip
, flags
, pc
);
433 check_critical_timing(tr
, data
, parent_ip
? : ip
, cpu
);
434 data
->critical_start
= 0;
435 atomic_dec(&data
->disabled
);
438 /* start and stop critical timings used to for stoppage (in idle) */
439 void start_critical_timings(void)
441 int pc
= preempt_count();
443 if (preempt_trace(pc
) || irq_trace())
444 start_critical_timing(CALLER_ADDR0
, CALLER_ADDR1
, pc
);
446 EXPORT_SYMBOL_GPL(start_critical_timings
);
447 NOKPROBE_SYMBOL(start_critical_timings
);
449 void stop_critical_timings(void)
451 int pc
= preempt_count();
453 if (preempt_trace(pc
) || irq_trace())
454 stop_critical_timing(CALLER_ADDR0
, CALLER_ADDR1
, pc
);
456 EXPORT_SYMBOL_GPL(stop_critical_timings
);
457 NOKPROBE_SYMBOL(stop_critical_timings
);
459 #ifdef CONFIG_FUNCTION_TRACER
460 static bool function_enabled
;
462 static int register_irqsoff_function(struct trace_array
*tr
, int graph
, int set
)
466 /* 'set' is set if TRACE_ITER_FUNCTION is about to be set */
467 if (function_enabled
|| (!set
&& !(tr
->trace_flags
& TRACE_ITER_FUNCTION
)))
471 ret
= register_ftrace_graph(&fgraph_ops
);
473 ret
= register_ftrace_function(tr
->ops
);
476 function_enabled
= true;
481 static void unregister_irqsoff_function(struct trace_array
*tr
, int graph
)
483 if (!function_enabled
)
487 unregister_ftrace_graph(&fgraph_ops
);
489 unregister_ftrace_function(tr
->ops
);
491 function_enabled
= false;
494 static int irqsoff_function_set(struct trace_array
*tr
, u32 mask
, int set
)
496 if (!(mask
& TRACE_ITER_FUNCTION
))
500 register_irqsoff_function(tr
, is_graph(tr
), 1);
502 unregister_irqsoff_function(tr
, is_graph(tr
));
506 static int register_irqsoff_function(struct trace_array
*tr
, int graph
, int set
)
510 static void unregister_irqsoff_function(struct trace_array
*tr
, int graph
) { }
511 static inline int irqsoff_function_set(struct trace_array
*tr
, u32 mask
, int set
)
515 #endif /* CONFIG_FUNCTION_TRACER */
517 static int irqsoff_flag_changed(struct trace_array
*tr
, u32 mask
, int set
)
519 struct tracer
*tracer
= tr
->current_trace
;
521 if (irqsoff_function_set(tr
, mask
, set
))
524 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
525 if (mask
& TRACE_ITER_DISPLAY_GRAPH
)
526 return irqsoff_display_graph(tr
, set
);
529 return trace_keep_overwrite(tracer
, mask
, set
);
532 static int start_irqsoff_tracer(struct trace_array
*tr
, int graph
)
536 ret
= register_irqsoff_function(tr
, graph
, 0);
538 if (!ret
&& tracing_is_enabled())
546 static void stop_irqsoff_tracer(struct trace_array
*tr
, int graph
)
550 unregister_irqsoff_function(tr
, graph
);
553 static bool irqsoff_busy
;
555 static int __irqsoff_tracer_init(struct trace_array
*tr
)
560 save_flags
= tr
->trace_flags
;
562 /* non overwrite screws up the latency tracers */
563 set_tracer_flag(tr
, TRACE_ITER_OVERWRITE
, 1);
564 set_tracer_flag(tr
, TRACE_ITER_LATENCY_FMT
, 1);
568 /* make sure that the tracer is visible */
571 ftrace_init_array_ops(tr
, irqsoff_tracer_call
);
573 /* Only toplevel instance supports graph tracing */
574 if (start_irqsoff_tracer(tr
, (tr
->flags
& TRACE_ARRAY_FL_GLOBAL
&&
576 printk(KERN_ERR
"failed to start irqsoff tracer\n");
582 static void __irqsoff_tracer_reset(struct trace_array
*tr
)
584 int lat_flag
= save_flags
& TRACE_ITER_LATENCY_FMT
;
585 int overwrite_flag
= save_flags
& TRACE_ITER_OVERWRITE
;
587 stop_irqsoff_tracer(tr
, is_graph(tr
));
589 set_tracer_flag(tr
, TRACE_ITER_LATENCY_FMT
, lat_flag
);
590 set_tracer_flag(tr
, TRACE_ITER_OVERWRITE
, overwrite_flag
);
591 ftrace_reset_array_ops(tr
);
593 irqsoff_busy
= false;
596 static void irqsoff_tracer_start(struct trace_array
*tr
)
601 static void irqsoff_tracer_stop(struct trace_array
*tr
)
606 #ifdef CONFIG_IRQSOFF_TRACER
608 * We are only interested in hardirq on/off events:
610 void tracer_hardirqs_on(unsigned long a0
, unsigned long a1
)
612 unsigned int pc
= preempt_count();
614 if (!preempt_trace(pc
) && irq_trace())
615 stop_critical_timing(a0
, a1
, pc
);
617 NOKPROBE_SYMBOL(tracer_hardirqs_on
);
619 void tracer_hardirqs_off(unsigned long a0
, unsigned long a1
)
621 unsigned int pc
= preempt_count();
623 if (!preempt_trace(pc
) && irq_trace())
624 start_critical_timing(a0
, a1
, pc
);
626 NOKPROBE_SYMBOL(tracer_hardirqs_off
);
628 static int irqsoff_tracer_init(struct trace_array
*tr
)
630 trace_type
= TRACER_IRQS_OFF
;
632 return __irqsoff_tracer_init(tr
);
635 static void irqsoff_tracer_reset(struct trace_array
*tr
)
637 __irqsoff_tracer_reset(tr
);
640 static struct tracer irqsoff_tracer __read_mostly
=
643 .init
= irqsoff_tracer_init
,
644 .reset
= irqsoff_tracer_reset
,
645 .start
= irqsoff_tracer_start
,
646 .stop
= irqsoff_tracer_stop
,
648 .print_header
= irqsoff_print_header
,
649 .print_line
= irqsoff_print_line
,
650 .flag_changed
= irqsoff_flag_changed
,
651 #ifdef CONFIG_FTRACE_SELFTEST
652 .selftest
= trace_selftest_startup_irqsoff
,
654 .open
= irqsoff_trace_open
,
655 .close
= irqsoff_trace_close
,
656 .allow_instances
= true,
659 #endif /* CONFIG_IRQSOFF_TRACER */
661 #ifdef CONFIG_PREEMPT_TRACER
662 void tracer_preempt_on(unsigned long a0
, unsigned long a1
)
664 int pc
= preempt_count();
666 if (preempt_trace(pc
) && !irq_trace())
667 stop_critical_timing(a0
, a1
, pc
);
670 void tracer_preempt_off(unsigned long a0
, unsigned long a1
)
672 int pc
= preempt_count();
674 if (preempt_trace(pc
) && !irq_trace())
675 start_critical_timing(a0
, a1
, pc
);
678 static int preemptoff_tracer_init(struct trace_array
*tr
)
680 trace_type
= TRACER_PREEMPT_OFF
;
682 return __irqsoff_tracer_init(tr
);
685 static void preemptoff_tracer_reset(struct trace_array
*tr
)
687 __irqsoff_tracer_reset(tr
);
690 static struct tracer preemptoff_tracer __read_mostly
=
692 .name
= "preemptoff",
693 .init
= preemptoff_tracer_init
,
694 .reset
= preemptoff_tracer_reset
,
695 .start
= irqsoff_tracer_start
,
696 .stop
= irqsoff_tracer_stop
,
698 .print_header
= irqsoff_print_header
,
699 .print_line
= irqsoff_print_line
,
700 .flag_changed
= irqsoff_flag_changed
,
701 #ifdef CONFIG_FTRACE_SELFTEST
702 .selftest
= trace_selftest_startup_preemptoff
,
704 .open
= irqsoff_trace_open
,
705 .close
= irqsoff_trace_close
,
706 .allow_instances
= true,
709 #endif /* CONFIG_PREEMPT_TRACER */
711 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
713 static int preemptirqsoff_tracer_init(struct trace_array
*tr
)
715 trace_type
= TRACER_IRQS_OFF
| TRACER_PREEMPT_OFF
;
717 return __irqsoff_tracer_init(tr
);
720 static void preemptirqsoff_tracer_reset(struct trace_array
*tr
)
722 __irqsoff_tracer_reset(tr
);
725 static struct tracer preemptirqsoff_tracer __read_mostly
=
727 .name
= "preemptirqsoff",
728 .init
= preemptirqsoff_tracer_init
,
729 .reset
= preemptirqsoff_tracer_reset
,
730 .start
= irqsoff_tracer_start
,
731 .stop
= irqsoff_tracer_stop
,
733 .print_header
= irqsoff_print_header
,
734 .print_line
= irqsoff_print_line
,
735 .flag_changed
= irqsoff_flag_changed
,
736 #ifdef CONFIG_FTRACE_SELFTEST
737 .selftest
= trace_selftest_startup_preemptirqsoff
,
739 .open
= irqsoff_trace_open
,
740 .close
= irqsoff_trace_close
,
741 .allow_instances
= true,
746 __init
static int init_irqsoff_tracer(void)
748 #ifdef CONFIG_IRQSOFF_TRACER
749 register_tracer(&irqsoff_tracer
);
751 #ifdef CONFIG_PREEMPT_TRACER
752 register_tracer(&preemptoff_tracer
);
754 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
755 register_tracer(&preemptirqsoff_tracer
);
760 core_initcall(init_irqsoff_tracer
);
761 #endif /* IRQSOFF_TRACER || PREEMPTOFF_TRACER */