blob: 98f1991e32651f6771f1fffe198ac9ad22177c15 [file] [log] [blame]
Alexey Ivanovcc01a9c2019-01-16 09:50:46 -08001#!/usr/bin/python
Alexei Starovoitovbdf07732016-01-14 10:09:20 -08002# @lint-avoid-python-3-compatibility-imports
Brendan Gregg860b6492015-10-20 15:52:23 -07003#
Alexei Starovoitovbdf07732016-01-14 10:09:20 -08004# hardirqs Summarize hard IRQ (interrupt) event time.
5# For Linux, uses BCC, eBPF.
Brendan Gregg860b6492015-10-20 15:52:23 -07006#
Brendan Greggc32b8452017-11-26 23:38:32 -08007# USAGE: hardirqs [-h] [-T] [-N] [-C] [-d] [interval] [outputs]
Brendan Gregg860b6492015-10-20 15:52:23 -07008#
9# Thanks Amer Ather for help understanding irq behavior.
10#
11# Copyright (c) 2015 Brendan Gregg.
12# Licensed under the Apache License, Version 2.0 (the "License")
13#
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080014# 19-Oct-2015 Brendan Gregg Created this.
Hengqi Chene6aa65e2021-05-22 16:07:36 +080015# 22-May-2021 Hengqi Chen Migrated to kernel tracepoints.
Brendan Gregg860b6492015-10-20 15:52:23 -070016
17from __future__ import print_function
18from bcc import BPF
19from time import sleep, strftime
20import argparse
21
Sasha Goldshteinf41ae862016-10-19 01:14:30 +030022# arguments
Brendan Gregg860b6492015-10-20 15:52:23 -070023examples = """examples:
24 ./hardirqs # sum hard irq event time
25 ./hardirqs -d # show hard irq event time as histograms
26 ./hardirqs 1 10 # print 1 second summaries, 10 times
27 ./hardirqs -NT 1 # 1s summaries, nanoseconds, and timestamps
28"""
29parser = argparse.ArgumentParser(
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080030 description="Summarize hard irq event time as histograms",
31 formatter_class=argparse.RawDescriptionHelpFormatter,
32 epilog=examples)
Brendan Gregg860b6492015-10-20 15:52:23 -070033parser.add_argument("-T", "--timestamp", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080034 help="include timestamp on output")
Brendan Gregg860b6492015-10-20 15:52:23 -070035parser.add_argument("-N", "--nanoseconds", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080036 help="output in nanoseconds")
Brendan Greggc32b8452017-11-26 23:38:32 -080037parser.add_argument("-C", "--count", action="store_true",
38 help="show event counts instead of timing")
Brendan Gregg860b6492015-10-20 15:52:23 -070039parser.add_argument("-d", "--dist", action="store_true",
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080040 help="show distributions as histograms")
Brendan Gregg860b6492015-10-20 15:52:23 -070041parser.add_argument("interval", nargs="?", default=99999999,
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080042 help="output interval, in seconds")
Brendan Greggc32b8452017-11-26 23:38:32 -080043parser.add_argument("outputs", nargs="?", default=99999999,
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080044 help="number of outputs")
Nathan Scottcf0792f2018-02-02 16:56:50 +110045parser.add_argument("--ebpf", action="store_true",
46 help=argparse.SUPPRESS)
Brendan Gregg860b6492015-10-20 15:52:23 -070047args = parser.parse_args()
Brendan Greggc32b8452017-11-26 23:38:32 -080048countdown = int(args.outputs)
49if args.count and (args.dist or args.nanoseconds):
50 print("The --count option can't be used with time-based options")
51 exit()
52if args.count:
53 factor = 1
54 label = "count"
55elif args.nanoseconds:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080056 factor = 1
57 label = "nsecs"
Brendan Gregg860b6492015-10-20 15:52:23 -070058else:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080059 factor = 1000
60 label = "usecs"
Brendan Gregg860b6492015-10-20 15:52:23 -070061debug = 0
62
Sasha Goldshteinf41ae862016-10-19 01:14:30 +030063# define BPF program
Brendan Gregg860b6492015-10-20 15:52:23 -070064bpf_text = """
65#include <uapi/linux/ptrace.h>
66#include <linux/irq.h>
67#include <linux/irqdesc.h>
68#include <linux/interrupt.h>
69
70typedef struct irq_key {
Alexei Starovoitovbdf07732016-01-14 10:09:20 -080071 char name[32];
72 u64 slot;
Brendan Gregg860b6492015-10-20 15:52:23 -070073} irq_key_t;
Hengqi Chene6aa65e2021-05-22 16:07:36 +080074
75typedef struct irq_name {
76 char name[32];
77} irq_name_t;
78
Brendan Gregg860b6492015-10-20 15:52:23 -070079BPF_HASH(start, u32);
Hengqi Chene6aa65e2021-05-22 16:07:36 +080080BPF_HASH(irqnames, u32, irq_name_t);
Brendan Gregg860b6492015-10-20 15:52:23 -070081BPF_HISTOGRAM(dist, irq_key_t);
Hengqi Chene6aa65e2021-05-22 16:07:36 +080082"""
Brendan Gregg860b6492015-10-20 15:52:23 -070083
Hengqi Chene6aa65e2021-05-22 16:07:36 +080084bpf_text_count = """
85TRACEPOINT_PROBE(irq, irq_handler_entry)
Brendan Greggc32b8452017-11-26 23:38:32 -080086{
Ism Hong814c2642021-12-06 11:28:34 +080087 u32 tid = bpf_get_current_pid_tgid();
88 irq_name_t name = {};
89
90 TP_DATA_LOC_READ_STR(&name.name, name, sizeof(name));
91 irqnames.update(&tid, &name);
92 return 0;
93}
94
95TRACEPOINT_PROBE(irq, irq_handler_exit)
96{
97 u32 tid = bpf_get_current_pid_tgid();
98
99 // check ret value of irq handler is not IRQ_NONE to make sure
100 // the current event belong to this irq handler
101 if (args->ret != IRQ_NONE) {
102 irq_name_t *namep;
103
104 namep = irqnames.lookup(&tid);
105 if (namep == 0) {
106 return 0; // missed irq name
107 }
108 char *name = (char *)namep->name;
109 irq_key_t key = {.slot = 0 /* ignore */};
110
111 bpf_probe_read_kernel(&key.name, sizeof(key.name), name);
112 dist.atomic_increment(key);
113 }
114
115 irqnames.delete(&tid);
Brendan Greggc32b8452017-11-26 23:38:32 -0800116 return 0;
117}
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800118"""
Brendan Greggc32b8452017-11-26 23:38:32 -0800119
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800120bpf_text_time = """
121TRACEPOINT_PROBE(irq, irq_handler_entry)
Brendan Gregg860b6492015-10-20 15:52:23 -0700122{
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800123 u32 tid = bpf_get_current_pid_tgid();
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800124 u64 ts = bpf_ktime_get_ns();
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800125 irq_name_t name = {};
126
Hengqi Chen2cffe362021-11-22 21:54:51 +0800127 TP_DATA_LOC_READ_STR(&name.name, name, sizeof(name));
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800128 irqnames.update(&tid, &name);
129 start.update(&tid, &ts);
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800130 return 0;
Brendan Gregg860b6492015-10-20 15:52:23 -0700131}
132
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800133TRACEPOINT_PROBE(irq, irq_handler_exit)
Brendan Gregg860b6492015-10-20 15:52:23 -0700134{
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800135 u64 *tsp, delta;
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800136 irq_name_t *namep;
137 u32 tid = bpf_get_current_pid_tgid();
Brendan Gregg860b6492015-10-20 15:52:23 -0700138
Ism Hong814c2642021-12-06 11:28:34 +0800139 // check ret value of irq handler is not IRQ_NONE to make sure
140 // the current event belong to this irq handler
141 if (args->ret != IRQ_NONE) {
142 // fetch timestamp and calculate delta
143 tsp = start.lookup(&tid);
144 namep = irqnames.lookup(&tid);
145 if (tsp == 0 || namep == 0) {
146 return 0; // missed start
147 }
148
149 char *name = (char *)namep->name;
150 delta = bpf_ktime_get_ns() - *tsp;
151
152 // store as sum or histogram
153 STORE
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800154 }
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800155
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800156 start.delete(&tid);
157 irqnames.delete(&tid);
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800158 return 0;
Brendan Gregg860b6492015-10-20 15:52:23 -0700159}
160"""
161
Hengqi Chene6aa65e2021-05-22 16:07:36 +0800162if args.count:
163 bpf_text += bpf_text_count
164else:
165 bpf_text += bpf_text_time
166
Sasha Goldshteinf41ae862016-10-19 01:14:30 +0300167# code substitutions
Brendan Gregg860b6492015-10-20 15:52:23 -0700168if args.dist:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800169 bpf_text = bpf_text.replace('STORE',
Kirill Smelkovf2d125e2017-09-25 11:23:03 +0300170 'irq_key_t key = {.slot = bpf_log2l(delta / %d)};' % factor +
Sumanth Korikkar7f6066d2020-05-20 10:49:56 -0500171 'bpf_probe_read_kernel(&key.name, sizeof(key.name), name);' +
zcy80242fb2021-07-02 00:12:32 +0800172 'dist.atomic_increment(key);')
Brendan Gregg860b6492015-10-20 15:52:23 -0700173else:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800174 bpf_text = bpf_text.replace('STORE',
175 'irq_key_t key = {.slot = 0 /* ignore */};' +
Sumanth Korikkar7f6066d2020-05-20 10:49:56 -0500176 'bpf_probe_read_kernel(&key.name, sizeof(key.name), name);' +
zcy80242fb2021-07-02 00:12:32 +0800177 'dist.atomic_increment(key, delta);')
Nathan Scottcf0792f2018-02-02 16:56:50 +1100178if debug or args.ebpf:
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800179 print(bpf_text)
Nathan Scottcf0792f2018-02-02 16:56:50 +1100180 if args.ebpf:
181 exit()
Brendan Gregg860b6492015-10-20 15:52:23 -0700182
Sasha Goldshteinf41ae862016-10-19 01:14:30 +0300183# load BPF program
Brendan Gregg860b6492015-10-20 15:52:23 -0700184b = BPF(text=bpf_text)
185
Brendan Greggc32b8452017-11-26 23:38:32 -0800186if args.count:
Brendan Greggc32b8452017-11-26 23:38:32 -0800187 print("Tracing hard irq events... Hit Ctrl-C to end.")
188else:
Brendan Greggc32b8452017-11-26 23:38:32 -0800189 print("Tracing hard irq event time... Hit Ctrl-C to end.")
Brendan Gregg860b6492015-10-20 15:52:23 -0700190
Sasha Goldshteinf41ae862016-10-19 01:14:30 +0300191# output
Brendan Gregg860b6492015-10-20 15:52:23 -0700192exiting = 0 if args.interval else 1
193dist = b.get_table("dist")
194while (1):
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800195 try:
196 sleep(int(args.interval))
197 except KeyboardInterrupt:
198 exiting = 1
Brendan Gregg860b6492015-10-20 15:52:23 -0700199
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800200 print()
201 if args.timestamp:
202 print("%-8s\n" % strftime("%H:%M:%S"), end="")
Brendan Gregg860b6492015-10-20 15:52:23 -0700203
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800204 if args.dist:
205 dist.print_log2_hist(label, "hardirq")
206 else:
207 print("%-26s %11s" % ("HARDIRQ", "TOTAL_" + label))
208 for k, v in sorted(dist.items(), key=lambda dist: dist[1].value):
jeromemarchandb96ebcd2018-10-10 01:58:15 +0200209 print("%-26s %11d" % (k.name.decode('utf-8', 'replace'), v.value / factor))
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800210 dist.clear()
Brendan Gregg860b6492015-10-20 15:52:23 -0700211
Alexei Starovoitovbdf07732016-01-14 10:09:20 -0800212 countdown -= 1
213 if exiting or countdown == 0:
214 exit()