1 // SPDX-License-Identifier: GPL-2.0
3 * trace irqs off critical timings
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>
20 #include <trace/events/preemptirq.h>
22 #if defined(CONFIG_IRQSOFF_TRACER) || defined(CONFIG_PREEMPT_TRACER)
23 static struct trace_array *irqsoff_trace __read_mostly;
24 static int tracer_enabled __read_mostly;
26 static DEFINE_PER_CPU(int, tracing_cpu);
28 static DEFINE_RAW_SPINLOCK(max_trace_lock);
31 TRACER_IRQS_OFF = (1 << 1),
32 TRACER_PREEMPT_OFF = (1 << 2),
35 static int trace_type __read_mostly;
37 static int save_flags;
39 static void stop_irqsoff_tracer(struct trace_array *tr, int graph);
40 static int start_irqsoff_tracer(struct trace_array *tr, int graph);
42 #ifdef CONFIG_PREEMPT_TRACER
46 return ((trace_type & TRACER_PREEMPT_OFF) && pc);
49 # define preempt_trace(pc) (0)
52 #ifdef CONFIG_IRQSOFF_TRACER
56 return ((trace_type & TRACER_IRQS_OFF) &&
60 # define irq_trace() (0)
63 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
64 static int irqsoff_display_graph(struct trace_array *tr, int set);
65 # define is_graph(tr) ((tr)->trace_flags & TRACE_ITER_DISPLAY_GRAPH)
67 static inline int irqsoff_display_graph(struct trace_array *tr, int set)
71 # define is_graph(tr) false
75 * Sequence count - we record it when starting a measurement and
76 * skip the latency if the sequence has changed - some other section
77 * did a maximum and could disturb our measurement with serial console
78 * printouts, etc. Truly coinciding maximum latencies should be rare
79 * and what happens together happens separately as well, so this doesn't
80 * decrease the validity of the maximum found:
82 static __cacheline_aligned_in_smp unsigned long max_sequence;
84 #ifdef CONFIG_FUNCTION_TRACER
86 * Prologue for the preempt and irqs off function tracers.
88 * Returns 1 if it is OK to continue, and data->disabled is
90 * 0 if the trace is to be ignored, and data->disabled
93 * Note, this function is also used outside this ifdef but
94 * inside the #ifdef of the function graph tracer below.
95 * This is OK, since the function graph tracer is
96 * dependent on the function tracer.
98 static int func_prolog_dec(struct trace_array *tr,
99 struct trace_array_cpu **data,
100 unsigned long *flags)
106 * Does not matter if we preempt. We test the flags
107 * afterward, to see if irqs are disabled or not.
108 * If we preempt and get a false positive, the flags
111 cpu = raw_smp_processor_id();
112 if (likely(!per_cpu(tracing_cpu, cpu)))
115 local_save_flags(*flags);
117 * Slight chance to get a false positive on tracing_cpu,
118 * although I'm starting to think there isn't a chance.
119 * Leave this for now just to be paranoid.
121 if (!irqs_disabled_flags(*flags) && !preempt_count())
124 *data = per_cpu_ptr(tr->trace_buffer.data, cpu);
125 disabled = atomic_inc_return(&(*data)->disabled);
127 if (likely(disabled == 1))
130 atomic_dec(&(*data)->disabled);
136 * irqsoff uses its own tracer function to keep the overhead down:
139 irqsoff_tracer_call(unsigned long ip, unsigned long parent_ip,
140 struct ftrace_ops *op, struct pt_regs *pt_regs)
142 struct trace_array *tr = irqsoff_trace;
143 struct trace_array_cpu *data;
146 if (!func_prolog_dec(tr, &data, &flags))
149 trace_function(tr, ip, parent_ip, flags, preempt_count());
151 atomic_dec(&data->disabled);
153 #endif /* CONFIG_FUNCTION_TRACER */
155 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
156 static int irqsoff_display_graph(struct trace_array *tr, int set)
160 if (!(is_graph(tr) ^ set))
163 stop_irqsoff_tracer(irqsoff_trace, !set);
165 for_each_possible_cpu(cpu)
166 per_cpu(tracing_cpu, cpu) = 0;
169 tracing_reset_online_cpus(&irqsoff_trace->trace_buffer);
171 return start_irqsoff_tracer(irqsoff_trace, set);
174 static int irqsoff_graph_entry(struct ftrace_graph_ent *trace)
176 struct trace_array *tr = irqsoff_trace;
177 struct trace_array_cpu *data;
182 if (ftrace_graph_ignore_func(trace))
185 * Do not trace a function if it's filtered by set_graph_notrace.
186 * Make the index of ret stack negative to indicate that it should
187 * ignore further functions. But it needs its own ret stack entry
188 * to recover the original index in order to continue tracing after
189 * returning from the function.
191 if (ftrace_graph_notrace_addr(trace->func))
194 if (!func_prolog_dec(tr, &data, &flags))
197 pc = preempt_count();
198 ret = __trace_graph_entry(tr, trace, flags, pc);
199 atomic_dec(&data->disabled);
204 static void irqsoff_graph_return(struct ftrace_graph_ret *trace)
206 struct trace_array *tr = irqsoff_trace;
207 struct trace_array_cpu *data;
211 if (!func_prolog_dec(tr, &data, &flags))
214 pc = preempt_count();
215 __trace_graph_return(tr, trace, flags, pc);
216 atomic_dec(&data->disabled);
219 static void irqsoff_trace_open(struct trace_iterator *iter)
221 if (is_graph(iter->tr))
222 graph_trace_open(iter);
226 static void irqsoff_trace_close(struct trace_iterator *iter)
229 graph_trace_close(iter);
232 #define GRAPH_TRACER_FLAGS (TRACE_GRAPH_PRINT_CPU | \
233 TRACE_GRAPH_PRINT_PROC | \
234 TRACE_GRAPH_PRINT_ABS_TIME | \
235 TRACE_GRAPH_PRINT_DURATION)
237 static enum print_line_t irqsoff_print_line(struct trace_iterator *iter)
240 * In graph mode call the graph tracer output function,
241 * otherwise go with the TRACE_FN event handler
243 if (is_graph(iter->tr))
244 return print_graph_function_flags(iter, GRAPH_TRACER_FLAGS);
246 return TRACE_TYPE_UNHANDLED;
249 static void irqsoff_print_header(struct seq_file *s)
251 struct trace_array *tr = irqsoff_trace;
254 print_graph_headers_flags(s, GRAPH_TRACER_FLAGS);
256 trace_default_header(s);
260 __trace_function(struct trace_array *tr,
261 unsigned long ip, unsigned long parent_ip,
262 unsigned long flags, int pc)
265 trace_graph_function(tr, ip, parent_ip, flags, pc);
267 trace_function(tr, ip, parent_ip, flags, pc);
271 #define __trace_function trace_function
273 #ifdef CONFIG_FUNCTION_TRACER
274 static int irqsoff_graph_entry(struct ftrace_graph_ent *trace)
280 static enum print_line_t irqsoff_print_line(struct trace_iterator *iter)
282 return TRACE_TYPE_UNHANDLED;
285 static void irqsoff_trace_open(struct trace_iterator *iter) { }
286 static void irqsoff_trace_close(struct trace_iterator *iter) { }
288 #ifdef CONFIG_FUNCTION_TRACER
289 static void irqsoff_graph_return(struct ftrace_graph_ret *trace) { }
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);
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->trace_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);
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->trace_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);
448 void stop_critical_timings(void)
450 int pc = preempt_count();
452 if (preempt_trace(pc) || irq_trace())
453 stop_critical_timing(CALLER_ADDR0, CALLER_ADDR1, pc);
455 EXPORT_SYMBOL_GPL(stop_critical_timings);
457 #ifdef CONFIG_FUNCTION_TRACER
458 static bool function_enabled;
460 static int register_irqsoff_function(struct trace_array *tr, int graph, int set)
464 /* 'set' is set if TRACE_ITER_FUNCTION is about to be set */
465 if (function_enabled || (!set && !(tr->trace_flags & TRACE_ITER_FUNCTION)))
469 ret = register_ftrace_graph(&irqsoff_graph_return,
470 &irqsoff_graph_entry);
472 ret = register_ftrace_function(tr->ops);
475 function_enabled = true;
480 static void unregister_irqsoff_function(struct trace_array *tr, int graph)
482 if (!function_enabled)
486 unregister_ftrace_graph();
488 unregister_ftrace_function(tr->ops);
490 function_enabled = false;
493 static int irqsoff_function_set(struct trace_array *tr, u32 mask, int set)
495 if (!(mask & TRACE_ITER_FUNCTION))
499 register_irqsoff_function(tr, is_graph(tr), 1);
501 unregister_irqsoff_function(tr, is_graph(tr));
505 static int register_irqsoff_function(struct trace_array *tr, int graph, int set)
509 static void unregister_irqsoff_function(struct trace_array *tr, int graph) { }
510 static inline int irqsoff_function_set(struct trace_array *tr, u32 mask, int set)
514 #endif /* CONFIG_FUNCTION_TRACER */
516 static int irqsoff_flag_changed(struct trace_array *tr, u32 mask, int set)
518 struct tracer *tracer = tr->current_trace;
520 if (irqsoff_function_set(tr, mask, set))
523 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
524 if (mask & TRACE_ITER_DISPLAY_GRAPH)
525 return irqsoff_display_graph(tr, set);
528 return trace_keep_overwrite(tracer, mask, set);
531 static int start_irqsoff_tracer(struct trace_array *tr, int graph)
535 ret = register_irqsoff_function(tr, graph, 0);
537 if (!ret && tracing_is_enabled())
545 static void stop_irqsoff_tracer(struct trace_array *tr, int graph)
549 unregister_irqsoff_function(tr, graph);
552 static bool irqsoff_busy;
554 static int __irqsoff_tracer_init(struct trace_array *tr)
559 save_flags = tr->trace_flags;
561 /* non overwrite screws up the latency tracers */
562 set_tracer_flag(tr, TRACE_ITER_OVERWRITE, 1);
563 set_tracer_flag(tr, TRACE_ITER_LATENCY_FMT, 1);
567 /* make sure that the tracer is visible */
570 ftrace_init_array_ops(tr, irqsoff_tracer_call);
572 /* Only toplevel instance supports graph tracing */
573 if (start_irqsoff_tracer(tr, (tr->flags & TRACE_ARRAY_FL_GLOBAL &&
575 printk(KERN_ERR "failed to start irqsoff tracer\n");
581 static void __irqsoff_tracer_reset(struct trace_array *tr)
583 int lat_flag = save_flags & TRACE_ITER_LATENCY_FMT;
584 int overwrite_flag = save_flags & TRACE_ITER_OVERWRITE;
586 stop_irqsoff_tracer(tr, is_graph(tr));
588 set_tracer_flag(tr, TRACE_ITER_LATENCY_FMT, lat_flag);
589 set_tracer_flag(tr, TRACE_ITER_OVERWRITE, overwrite_flag);
590 ftrace_reset_array_ops(tr);
592 irqsoff_busy = false;
595 static void irqsoff_tracer_start(struct trace_array *tr)
600 static void irqsoff_tracer_stop(struct trace_array *tr)
605 #ifdef CONFIG_IRQSOFF_TRACER
607 * We are only interested in hardirq on/off events:
609 void tracer_hardirqs_on(unsigned long a0, unsigned long a1)
611 unsigned int pc = preempt_count();
613 if (!preempt_trace(pc) && irq_trace())
614 stop_critical_timing(a0, a1, pc);
617 void tracer_hardirqs_off(unsigned long a0, unsigned long a1)
619 unsigned int pc = preempt_count();
621 if (!preempt_trace(pc) && irq_trace())
622 start_critical_timing(a0, a1, pc);
625 static int irqsoff_tracer_init(struct trace_array *tr)
627 trace_type = TRACER_IRQS_OFF;
629 return __irqsoff_tracer_init(tr);
632 static void irqsoff_tracer_reset(struct trace_array *tr)
634 __irqsoff_tracer_reset(tr);
637 static struct tracer irqsoff_tracer __read_mostly =
640 .init = irqsoff_tracer_init,
641 .reset = irqsoff_tracer_reset,
642 .start = irqsoff_tracer_start,
643 .stop = irqsoff_tracer_stop,
645 .print_header = irqsoff_print_header,
646 .print_line = irqsoff_print_line,
647 .flag_changed = irqsoff_flag_changed,
648 #ifdef CONFIG_FTRACE_SELFTEST
649 .selftest = trace_selftest_startup_irqsoff,
651 .open = irqsoff_trace_open,
652 .close = irqsoff_trace_close,
653 .allow_instances = true,
656 #endif /* CONFIG_IRQSOFF_TRACER */
658 #ifdef CONFIG_PREEMPT_TRACER
659 void tracer_preempt_on(unsigned long a0, unsigned long a1)
661 int pc = preempt_count();
663 if (preempt_trace(pc) && !irq_trace())
664 stop_critical_timing(a0, a1, pc);
667 void tracer_preempt_off(unsigned long a0, unsigned long a1)
669 int pc = preempt_count();
671 if (preempt_trace(pc) && !irq_trace())
672 start_critical_timing(a0, a1, pc);
675 static int preemptoff_tracer_init(struct trace_array *tr)
677 trace_type = TRACER_PREEMPT_OFF;
679 return __irqsoff_tracer_init(tr);
682 static void preemptoff_tracer_reset(struct trace_array *tr)
684 __irqsoff_tracer_reset(tr);
687 static struct tracer preemptoff_tracer __read_mostly =
689 .name = "preemptoff",
690 .init = preemptoff_tracer_init,
691 .reset = preemptoff_tracer_reset,
692 .start = irqsoff_tracer_start,
693 .stop = irqsoff_tracer_stop,
695 .print_header = irqsoff_print_header,
696 .print_line = irqsoff_print_line,
697 .flag_changed = irqsoff_flag_changed,
698 #ifdef CONFIG_FTRACE_SELFTEST
699 .selftest = trace_selftest_startup_preemptoff,
701 .open = irqsoff_trace_open,
702 .close = irqsoff_trace_close,
703 .allow_instances = true,
706 #endif /* CONFIG_PREEMPT_TRACER */
708 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
710 static int preemptirqsoff_tracer_init(struct trace_array *tr)
712 trace_type = TRACER_IRQS_OFF | TRACER_PREEMPT_OFF;
714 return __irqsoff_tracer_init(tr);
717 static void preemptirqsoff_tracer_reset(struct trace_array *tr)
719 __irqsoff_tracer_reset(tr);
722 static struct tracer preemptirqsoff_tracer __read_mostly =
724 .name = "preemptirqsoff",
725 .init = preemptirqsoff_tracer_init,
726 .reset = preemptirqsoff_tracer_reset,
727 .start = irqsoff_tracer_start,
728 .stop = irqsoff_tracer_stop,
730 .print_header = irqsoff_print_header,
731 .print_line = irqsoff_print_line,
732 .flag_changed = irqsoff_flag_changed,
733 #ifdef CONFIG_FTRACE_SELFTEST
734 .selftest = trace_selftest_startup_preemptirqsoff,
736 .open = irqsoff_trace_open,
737 .close = irqsoff_trace_close,
738 .allow_instances = true,
743 __init static int init_irqsoff_tracer(void)
745 #ifdef CONFIG_IRQSOFF_TRACER
746 register_tracer(&irqsoff_tracer);
748 #ifdef CONFIG_PREEMPT_TRACER
749 register_tracer(&preemptoff_tracer);
751 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
752 register_tracer(&preemptirqsoff_tracer);
757 core_initcall(init_irqsoff_tracer);
758 #endif /* IRQSOFF_TRACER || PREEMPTOFF_TRACER */