blob: 98ed28cf31cc5c2a96385f1f7c9d538eeb9e6d1d [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/*
2 * trace irqs off critical timings
3 *
4 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
5 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
6 *
7 * From code in the latency_tracer, that is:
8 *
9 * Copyright (C) 2004-2006 Ingo Molnar
10 * Copyright (C) 2004 William Lee Irwin III
11 */
12#include <linux/kallsyms.h>
13#include <linux/debugfs.h>
14#include <linux/uaccess.h>
15#include <linux/module.h>
16#include <linux/ftrace.h>
17#include <linux/fs.h>
18
19#include "trace.h"
20#include <trace/events/hist.h>
21
22static struct trace_array *irqsoff_trace __read_mostly;
23static int tracer_enabled __read_mostly;
24
25static DEFINE_PER_CPU(int, tracing_cpu);
26
27static DEFINE_RAW_SPINLOCK(max_trace_lock);
28
29enum {
30 TRACER_IRQS_OFF = (1 << 1),
31 TRACER_PREEMPT_OFF = (1 << 2),
32};
33
34static int trace_type __read_mostly;
35
36static int save_flags;
37
38static void stop_irqsoff_tracer(struct trace_array *tr, int graph);
39static int start_irqsoff_tracer(struct trace_array *tr, int graph);
40
41#ifdef CONFIG_PREEMPT_TRACER
42static inline int
43preempt_trace(void)
44{
45 return ((trace_type & TRACER_PREEMPT_OFF) && preempt_count());
46}
47#else
48# define preempt_trace() (0)
49#endif
50
51#ifdef CONFIG_IRQSOFF_TRACER
52static inline int
53irq_trace(void)
54{
55 return ((trace_type & TRACER_IRQS_OFF) &&
56 irqs_disabled());
57}
58#else
59# define irq_trace() (0)
60#endif
61
62#define TRACE_DISPLAY_GRAPH 1
63
64static struct tracer_opt trace_opts[] = {
65#ifdef CONFIG_FUNCTION_GRAPH_TRACER
66 /* display latency trace as call graph */
67 { TRACER_OPT(display-graph, TRACE_DISPLAY_GRAPH) },
68#endif
69 { } /* Empty entry */
70};
71
72static struct tracer_flags tracer_flags = {
73 .val = 0,
74 .opts = trace_opts,
75};
76
77#define is_graph() (tracer_flags.val & TRACE_DISPLAY_GRAPH)
78
79/*
80 * Sequence count - we record it when starting a measurement and
81 * skip the latency if the sequence has changed - some other section
82 * did a maximum and could disturb our measurement with serial console
83 * printouts, etc. Truly coinciding maximum latencies should be rare
84 * and what happens together happens separately as well, so this doesn't
85 * decrease the validity of the maximum found:
86 */
87static __cacheline_aligned_in_smp unsigned long max_sequence;
88
89#ifdef CONFIG_FUNCTION_TRACER
90/*
91 * Prologue for the preempt and irqs off function tracers.
92 *
93 * Returns 1 if it is OK to continue, and data->disabled is
94 * incremented.
95 * 0 if the trace is to be ignored, and data->disabled
96 * is kept the same.
97 *
98 * Note, this function is also used outside this ifdef but
99 * inside the #ifdef of the function graph tracer below.
100 * This is OK, since the function graph tracer is
101 * dependent on the function tracer.
102 */
103static int func_prolog_dec(struct trace_array *tr,
104 struct trace_array_cpu **data,
105 unsigned long *flags)
106{
107 long disabled;
108 int cpu;
109
110 /*
111 * Does not matter if we preempt. We test the flags
112 * afterward, to see if irqs are disabled or not.
113 * If we preempt and get a false positive, the flags
114 * test will fail.
115 */
116 cpu = raw_smp_processor_id();
117 if (likely(!per_cpu(tracing_cpu, cpu)))
118 return 0;
119
120 local_save_flags(*flags);
121 /* slight chance to get a false positive on tracing_cpu */
122 if (!irqs_disabled_flags(*flags))
123 return 0;
124
125 *data = tr->data[cpu];
126 disabled = atomic_inc_return(&(*data)->disabled);
127
128 if (likely(disabled == 1))
129 return 1;
130
131 atomic_dec(&(*data)->disabled);
132
133 return 0;
134}
135
136/*
137 * irqsoff uses its own tracer function to keep the overhead down:
138 */
139static void
140irqsoff_tracer_call(unsigned long ip, unsigned long parent_ip)
141{
142 struct trace_array *tr = irqsoff_trace;
143 struct trace_array_cpu *data;
144 unsigned long flags;
145
146 if (!func_prolog_dec(tr, &data, &flags))
147 return;
148
149 trace_function(tr, ip, parent_ip, flags, preempt_count());
150
151 atomic_dec(&data->disabled);
152}
153
154static struct ftrace_ops trace_ops __read_mostly =
155{
156 .func = irqsoff_tracer_call,
157 .flags = FTRACE_OPS_FL_GLOBAL,
158};
159#endif /* CONFIG_FUNCTION_TRACER */
160
161#ifdef CONFIG_FUNCTION_GRAPH_TRACER
162static int irqsoff_set_flag(u32 old_flags, u32 bit, int set)
163{
164 int cpu;
165
166 if (!(bit & TRACE_DISPLAY_GRAPH))
167 return -EINVAL;
168
169 if (!(is_graph() ^ set))
170 return 0;
171
172 stop_irqsoff_tracer(irqsoff_trace, !set);
173
174 for_each_possible_cpu(cpu)
175 per_cpu(tracing_cpu, cpu) = 0;
176
177 tracing_max_latency = 0;
178 tracing_reset_online_cpus(irqsoff_trace);
179
180 return start_irqsoff_tracer(irqsoff_trace, set);
181}
182
183static int irqsoff_graph_entry(struct ftrace_graph_ent *trace)
184{
185 struct trace_array *tr = irqsoff_trace;
186 struct trace_array_cpu *data;
187 unsigned long flags;
188 int ret;
189 int pc;
190
191 if (!func_prolog_dec(tr, &data, &flags))
192 return 0;
193
194 pc = preempt_count();
195 ret = __trace_graph_entry(tr, trace, flags, pc);
196 atomic_dec(&data->disabled);
197
198 return ret;
199}
200
201static void irqsoff_graph_return(struct ftrace_graph_ret *trace)
202{
203 struct trace_array *tr = irqsoff_trace;
204 struct trace_array_cpu *data;
205 unsigned long flags;
206 int pc;
207
208 if (!func_prolog_dec(tr, &data, &flags))
209 return;
210
211 pc = preempt_count();
212 __trace_graph_return(tr, trace, flags, pc);
213 atomic_dec(&data->disabled);
214}
215
216static void irqsoff_trace_open(struct trace_iterator *iter)
217{
218 if (is_graph())
219 graph_trace_open(iter);
220
221}
222
223static void irqsoff_trace_close(struct trace_iterator *iter)
224{
225 if (iter->private)
226 graph_trace_close(iter);
227}
228
229#define GRAPH_TRACER_FLAGS (TRACE_GRAPH_PRINT_CPU | \
230 TRACE_GRAPH_PRINT_PROC | \
231 TRACE_GRAPH_PRINT_ABS_TIME | \
232 TRACE_GRAPH_PRINT_DURATION)
233
234static enum print_line_t irqsoff_print_line(struct trace_iterator *iter)
235{
236 /*
237 * In graph mode call the graph tracer output function,
238 * otherwise go with the TRACE_FN event handler
239 */
240 if (is_graph())
241 return print_graph_function_flags(iter, GRAPH_TRACER_FLAGS);
242
243 return TRACE_TYPE_UNHANDLED;
244}
245
246static void irqsoff_print_header(struct seq_file *s)
247{
248 if (is_graph())
249 print_graph_headers_flags(s, GRAPH_TRACER_FLAGS);
250 else
251 trace_default_header(s);
252}
253
254static void
255__trace_function(struct trace_array *tr,
256 unsigned long ip, unsigned long parent_ip,
257 unsigned long flags, int pc)
258{
259 if (is_graph())
260 trace_graph_function(tr, ip, parent_ip, flags, pc);
261 else
262 trace_function(tr, ip, parent_ip, flags, pc);
263}
264
265#else
266#define __trace_function trace_function
267
268static int irqsoff_set_flag(u32 old_flags, u32 bit, int set)
269{
270 return -EINVAL;
271}
272
273static int irqsoff_graph_entry(struct ftrace_graph_ent *trace)
274{
275 return -1;
276}
277
278static enum print_line_t irqsoff_print_line(struct trace_iterator *iter)
279{
280 return TRACE_TYPE_UNHANDLED;
281}
282
283static void irqsoff_graph_return(struct ftrace_graph_ret *trace) { }
284static void irqsoff_trace_open(struct trace_iterator *iter) { }
285static void irqsoff_trace_close(struct trace_iterator *iter) { }
286
287#ifdef CONFIG_FUNCTION_TRACER
288static void irqsoff_print_header(struct seq_file *s)
289{
290 trace_default_header(s);
291}
292#else
293static void irqsoff_print_header(struct seq_file *s)
294{
295 trace_latency_header(s);
296}
297#endif /* CONFIG_FUNCTION_TRACER */
298#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
299
300/*
301 * Should this new latency be reported/recorded?
302 */
303static int report_latency(cycle_t delta)
304{
305 if (tracing_thresh) {
306 if (delta < tracing_thresh)
307 return 0;
308 } else {
309 if (delta <= tracing_max_latency)
310 return 0;
311 }
312 return 1;
313}
314
315static void
316check_critical_timing(struct trace_array *tr,
317 struct trace_array_cpu *data,
318 unsigned long parent_ip,
319 int cpu)
320{
321 cycle_t T0, T1, delta;
322 unsigned long flags;
323 int pc;
324
325 T0 = data->preempt_timestamp;
326 T1 = ftrace_now(cpu);
327 delta = T1-T0;
328
329 local_save_flags(flags);
330
331 pc = preempt_count();
332
333 if (!report_latency(delta))
334 goto out;
335
336 raw_spin_lock_irqsave(&max_trace_lock, flags);
337
338 /* check if we are still the max latency */
339 if (!report_latency(delta))
340 goto out_unlock;
341
342 __trace_function(tr, CALLER_ADDR0, parent_ip, flags, pc);
343 /* Skip 5 functions to get to the irq/preempt enable function */
344 __trace_stack(tr, flags, 5, pc);
345
346 if (data->critical_sequence != max_sequence)
347 goto out_unlock;
348
349 data->critical_end = parent_ip;
350
351 if (likely(!is_tracing_stopped())) {
352 tracing_max_latency = delta;
353 update_max_tr_single(tr, current, cpu);
354 }
355
356 max_sequence++;
357
358out_unlock:
359 raw_spin_unlock_irqrestore(&max_trace_lock, flags);
360
361out:
362 data->critical_sequence = max_sequence;
363 data->preempt_timestamp = ftrace_now(cpu);
364 __trace_function(tr, CALLER_ADDR0, parent_ip, flags, pc);
365}
366
367static inline void
368start_critical_timing(unsigned long ip, unsigned long parent_ip)
369{
370 int cpu;
371 struct trace_array *tr = irqsoff_trace;
372 struct trace_array_cpu *data;
373 unsigned long flags;
374
375 if (likely(!tracer_enabled))
376 return;
377
378 cpu = raw_smp_processor_id();
379
380 if (per_cpu(tracing_cpu, cpu))
381 return;
382
383 data = tr->data[cpu];
384
385 if (unlikely(!data) || atomic_read(&data->disabled))
386 return;
387
388 atomic_inc(&data->disabled);
389
390 data->critical_sequence = max_sequence;
391 data->preempt_timestamp = ftrace_now(cpu);
392 data->critical_start = parent_ip ? : ip;
393
394 local_save_flags(flags);
395
396 __trace_function(tr, ip, parent_ip, flags, preempt_count());
397
398 per_cpu(tracing_cpu, cpu) = 1;
399
400 atomic_dec(&data->disabled);
401}
402
403static inline void
404stop_critical_timing(unsigned long ip, unsigned long parent_ip)
405{
406 int cpu;
407 struct trace_array *tr = irqsoff_trace;
408 struct trace_array_cpu *data;
409 unsigned long flags;
410
411 cpu = raw_smp_processor_id();
412 /* Always clear the tracing cpu on stopping the trace */
413 if (unlikely(per_cpu(tracing_cpu, cpu)))
414 per_cpu(tracing_cpu, cpu) = 0;
415 else
416 return;
417
418 if (!tracer_enabled)
419 return;
420
421 data = tr->data[cpu];
422
423 if (unlikely(!data) ||
424 !data->critical_start || atomic_read(&data->disabled))
425 return;
426
427 atomic_inc(&data->disabled);
428
429 local_save_flags(flags);
430 __trace_function(tr, ip, parent_ip, flags, preempt_count());
431 check_critical_timing(tr, data, parent_ip ? : ip, cpu);
432 data->critical_start = 0;
433 atomic_dec(&data->disabled);
434}
435
436/* start and stop critical timings used to for stoppage (in idle) */
437void start_critical_timings(void)
438{
439 if (preempt_trace() || irq_trace())
440 start_critical_timing(CALLER_ADDR0, CALLER_ADDR1);
441 trace_preemptirqsoff_hist_rcuidle(TRACE_START, 1);
442}
443EXPORT_SYMBOL_GPL(start_critical_timings);
444
445void stop_critical_timings(void)
446{
447 trace_preemptirqsoff_hist_rcuidle(TRACE_STOP, 0);
448 if (preempt_trace() || irq_trace())
449 stop_critical_timing(CALLER_ADDR0, CALLER_ADDR1);
450}
451EXPORT_SYMBOL_GPL(stop_critical_timings);
452
453#ifdef CONFIG_IRQSOFF_TRACER
454#ifdef CONFIG_PROVE_LOCKING
455void time_hardirqs_on(unsigned long a0, unsigned long a1)
456{
457 trace_preemptirqsoff_hist(IRQS_ON, 0);
458 if (!preempt_trace() && irq_trace())
459 stop_critical_timing(a0, a1);
460}
461
462void time_hardirqs_off(unsigned long a0, unsigned long a1)
463{
464 if (!preempt_trace() && irq_trace())
465 start_critical_timing(a0, a1);
466 trace_preemptirqsoff_hist(IRQS_OFF, 1);
467}
468
469#else /* !CONFIG_PROVE_LOCKING */
470
471/*
472 * Stubs:
473 */
474
475void trace_softirqs_on(unsigned long ip)
476{
477}
478
479void trace_softirqs_off(unsigned long ip)
480{
481}
482
483inline void print_irqtrace_events(struct task_struct *curr)
484{
485}
486
487/*
488 * We are only interested in hardirq on/off events:
489 */
490void trace_hardirqs_on(void)
491{
492 trace_preemptirqsoff_hist_rcuidle(IRQS_ON, 0);
493 if (!preempt_trace() && irq_trace())
494 stop_critical_timing(CALLER_ADDR0, CALLER_ADDR1);
495}
496EXPORT_SYMBOL(trace_hardirqs_on);
497
498void trace_hardirqs_off(void)
499{
500 if (!preempt_trace() && irq_trace())
501 start_critical_timing(CALLER_ADDR0, CALLER_ADDR1);
502 trace_preemptirqsoff_hist_rcuidle(IRQS_OFF, 1);
503}
504EXPORT_SYMBOL(trace_hardirqs_off);
505
506void trace_hardirqs_on_caller(unsigned long caller_addr)
507{
508 trace_preemptirqsoff_hist(IRQS_ON, 0);
509 if (!preempt_trace() && irq_trace())
510 stop_critical_timing(CALLER_ADDR0, caller_addr);
511}
512EXPORT_SYMBOL(trace_hardirqs_on_caller);
513
514void trace_hardirqs_off_caller(unsigned long caller_addr)
515{
516 if (!preempt_trace() && irq_trace())
517 start_critical_timing(CALLER_ADDR0, caller_addr);
518 trace_preemptirqsoff_hist(IRQS_OFF, 1);
519}
520EXPORT_SYMBOL(trace_hardirqs_off_caller);
521
522#endif /* CONFIG_PROVE_LOCKING */
523#endif /* CONFIG_IRQSOFF_TRACER */
524
525#ifdef CONFIG_PREEMPT_TRACER
526void trace_preempt_on(unsigned long a0, unsigned long a1)
527{
528 trace_preemptirqsoff_hist(PREEMPT_ON, 0);
529 if (preempt_trace() && !irq_trace())
530 stop_critical_timing(a0, a1);
531}
532
533void trace_preempt_off(unsigned long a0, unsigned long a1)
534{
535 trace_preemptirqsoff_hist(PREEMPT_ON, 1);
536 if (preempt_trace() && !irq_trace())
537 start_critical_timing(a0, a1);
538}
539#endif /* CONFIG_PREEMPT_TRACER */
540
541static int start_irqsoff_tracer(struct trace_array *tr, int graph)
542{
543 int ret = 0;
544
545 if (!graph)
546 ret = register_ftrace_function(&trace_ops);
547 else
548 ret = register_ftrace_graph(&irqsoff_graph_return,
549 &irqsoff_graph_entry);
550
551 if (!ret && tracing_is_enabled())
552 tracer_enabled = 1;
553 else
554 tracer_enabled = 0;
555
556 return ret;
557}
558
559static void stop_irqsoff_tracer(struct trace_array *tr, int graph)
560{
561 tracer_enabled = 0;
562
563 if (!graph)
564 unregister_ftrace_function(&trace_ops);
565 else
566 unregister_ftrace_graph();
567}
568
569static void __irqsoff_tracer_init(struct trace_array *tr)
570{
571 save_flags = trace_flags;
572
573 /* non overwrite screws up the latency tracers */
574 set_tracer_flag(TRACE_ITER_OVERWRITE, 1);
575 set_tracer_flag(TRACE_ITER_LATENCY_FMT, 1);
576
577 tracing_max_latency = 0;
578 irqsoff_trace = tr;
579 /* make sure that the tracer is visible */
580 smp_wmb();
581 tracing_reset_online_cpus(tr);
582
583 if (start_irqsoff_tracer(tr, is_graph()))
584 printk(KERN_ERR "failed to start irqsoff tracer\n");
585}
586
587static void irqsoff_tracer_reset(struct trace_array *tr)
588{
589 int lat_flag = save_flags & TRACE_ITER_LATENCY_FMT;
590 int overwrite_flag = save_flags & TRACE_ITER_OVERWRITE;
591
592 stop_irqsoff_tracer(tr, is_graph());
593
594 set_tracer_flag(TRACE_ITER_LATENCY_FMT, lat_flag);
595 set_tracer_flag(TRACE_ITER_OVERWRITE, overwrite_flag);
596}
597
598static void irqsoff_tracer_start(struct trace_array *tr)
599{
600 tracer_enabled = 1;
601}
602
603static void irqsoff_tracer_stop(struct trace_array *tr)
604{
605 tracer_enabled = 0;
606}
607
608#ifdef CONFIG_IRQSOFF_TRACER
609static int irqsoff_tracer_init(struct trace_array *tr)
610{
611 trace_type = TRACER_IRQS_OFF;
612
613 __irqsoff_tracer_init(tr);
614 return 0;
615}
616static struct tracer irqsoff_tracer __read_mostly =
617{
618 .name = "irqsoff",
619 .init = irqsoff_tracer_init,
620 .reset = irqsoff_tracer_reset,
621 .start = irqsoff_tracer_start,
622 .stop = irqsoff_tracer_stop,
623 .print_max = 1,
624 .print_header = irqsoff_print_header,
625 .print_line = irqsoff_print_line,
626 .flags = &tracer_flags,
627 .set_flag = irqsoff_set_flag,
628 .flag_changed = trace_keep_overwrite,
629#ifdef CONFIG_FTRACE_SELFTEST
630 .selftest = trace_selftest_startup_irqsoff,
631#endif
632 .open = irqsoff_trace_open,
633 .close = irqsoff_trace_close,
634 .use_max_tr = 1,
635};
636# define register_irqsoff(trace) register_tracer(&trace)
637#else
638# define register_irqsoff(trace) do { } while (0)
639#endif
640
641#ifdef CONFIG_PREEMPT_TRACER
642static int preemptoff_tracer_init(struct trace_array *tr)
643{
644 trace_type = TRACER_PREEMPT_OFF;
645
646 __irqsoff_tracer_init(tr);
647 return 0;
648}
649
650static struct tracer preemptoff_tracer __read_mostly =
651{
652 .name = "preemptoff",
653 .init = preemptoff_tracer_init,
654 .reset = irqsoff_tracer_reset,
655 .start = irqsoff_tracer_start,
656 .stop = irqsoff_tracer_stop,
657 .print_max = 1,
658 .print_header = irqsoff_print_header,
659 .print_line = irqsoff_print_line,
660 .flags = &tracer_flags,
661 .set_flag = irqsoff_set_flag,
662 .flag_changed = trace_keep_overwrite,
663#ifdef CONFIG_FTRACE_SELFTEST
664 .selftest = trace_selftest_startup_preemptoff,
665#endif
666 .open = irqsoff_trace_open,
667 .close = irqsoff_trace_close,
668 .use_max_tr = 1,
669};
670# define register_preemptoff(trace) register_tracer(&trace)
671#else
672# define register_preemptoff(trace) do { } while (0)
673#endif
674
675#if defined(CONFIG_IRQSOFF_TRACER) && \
676 defined(CONFIG_PREEMPT_TRACER)
677
678static int preemptirqsoff_tracer_init(struct trace_array *tr)
679{
680 trace_type = TRACER_IRQS_OFF | TRACER_PREEMPT_OFF;
681
682 __irqsoff_tracer_init(tr);
683 return 0;
684}
685
686static struct tracer preemptirqsoff_tracer __read_mostly =
687{
688 .name = "preemptirqsoff",
689 .init = preemptirqsoff_tracer_init,
690 .reset = irqsoff_tracer_reset,
691 .start = irqsoff_tracer_start,
692 .stop = irqsoff_tracer_stop,
693 .print_max = 1,
694 .print_header = irqsoff_print_header,
695 .print_line = irqsoff_print_line,
696 .flags = &tracer_flags,
697 .set_flag = irqsoff_set_flag,
698 .flag_changed = trace_keep_overwrite,
699#ifdef CONFIG_FTRACE_SELFTEST
700 .selftest = trace_selftest_startup_preemptirqsoff,
701#endif
702 .open = irqsoff_trace_open,
703 .close = irqsoff_trace_close,
704 .use_max_tr = 1,
705};
706
707# define register_preemptirqsoff(trace) register_tracer(&trace)
708#else
709# define register_preemptirqsoff(trace) do { } while (0)
710#endif
711
712__init static int init_irqsoff_tracer(void)
713{
714 register_irqsoff(irqsoff_tracer);
715 register_preemptoff(preemptoff_tracer);
716 register_preemptirqsoff(preemptirqsoff_tracer);
717
718 return 0;
719}
720device_initcall(init_irqsoff_tracer);