Alexey Ivanov | cc01a9c | 2019-01-16 09:50:46 -0800 | [diff] [blame] | 1 | #!/usr/bin/python |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 2 | # |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 3 | # offcputime Summarize off-CPU time by stack trace |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 4 | # For Linux, uses BCC, eBPF. |
| 5 | # |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 6 | # USAGE: offcputime [-h] [-p PID | -u | -k] [-U | -K] [-f] [duration] |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 7 | # |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 8 | # Copyright 2016 Netflix, Inc. |
| 9 | # Licensed under the Apache License, Version 2.0 (the "License") |
| 10 | # |
| 11 | # 13-Jan-2016 Brendan Gregg Created this. |
| 12 | |
| 13 | from __future__ import print_function |
| 14 | from bcc import BPF |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 15 | from sys import stderr |
Yuto Kawamura | 0d86893 | 2021-01-18 20:30:34 +0900 | [diff] [blame] | 16 | from time import strftime |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 17 | import argparse |
Teng Qin | 0b11d22 | 2016-07-18 13:21:10 -0700 | [diff] [blame] | 18 | import errno |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 19 | import signal |
| 20 | |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 21 | # arg validation |
| 22 | def positive_int(val): |
| 23 | try: |
| 24 | ival = int(val) |
| 25 | except ValueError: |
| 26 | raise argparse.ArgumentTypeError("must be an integer") |
| 27 | |
| 28 | if ival < 0: |
| 29 | raise argparse.ArgumentTypeError("must be positive") |
| 30 | return ival |
| 31 | |
| 32 | def positive_nonzero_int(val): |
| 33 | ival = positive_int(val) |
| 34 | if ival == 0: |
| 35 | raise argparse.ArgumentTypeError("must be nonzero") |
| 36 | return ival |
| 37 | |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 38 | def stack_id_err(stack_id): |
Michael Prokop | c14d02a | 2020-01-09 02:29:18 +0100 | [diff] [blame] | 39 | # -EFAULT in get_stackid normally means the stack-trace is not available, |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 40 | # Such as getting kernel stack trace in userspace code |
| 41 | return (stack_id < 0) and (stack_id != -errno.EFAULT) |
| 42 | |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 43 | # arguments |
| 44 | examples = """examples: |
| 45 | ./offcputime # trace off-CPU stack time until Ctrl-C |
| 46 | ./offcputime 5 # trace for 5 seconds only |
| 47 | ./offcputime -f 5 # 5 seconds, and output in folded format |
Sasha Goldshtein | f41ae86 | 2016-10-19 01:14:30 +0300 | [diff] [blame] | 48 | ./offcputime -m 1000 # trace only events that last more than 1000 usec |
| 49 | ./offcputime -M 10000 # trace only events that last less than 10000 usec |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 50 | ./offcputime -p 185 # only trace threads for PID 185 |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 51 | ./offcputime -t 188 # only trace thread 188 |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 52 | ./offcputime -u # only trace user threads (no kernel) |
| 53 | ./offcputime -k # only trace kernel threads (no user) |
Andrew Birchall | 7f0a6f8 | 2016-05-24 01:44:41 -0700 | [diff] [blame] | 54 | ./offcputime -U # only show user space stacks (no kernel) |
| 55 | ./offcputime -K # only show kernel space stacks (no user) |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 56 | """ |
| 57 | parser = argparse.ArgumentParser( |
Andrew Birchall | 7f0a6f8 | 2016-05-24 01:44:41 -0700 | [diff] [blame] | 58 | description="Summarize off-CPU time by stack trace", |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 59 | formatter_class=argparse.RawDescriptionHelpFormatter, |
| 60 | epilog=examples) |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 61 | thread_group = parser.add_mutually_exclusive_group() |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 62 | # Note: this script provides --pid and --tid flags but their arguments are |
| 63 | # referred to internally using kernel nomenclature: TGID and PID. |
| 64 | thread_group.add_argument("-p", "--pid", metavar="PID", dest="tgid", |
| 65 | help="trace this PID only", type=positive_int) |
| 66 | thread_group.add_argument("-t", "--tid", metavar="TID", dest="pid", |
| 67 | help="trace this TID only", type=positive_int) |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 68 | thread_group.add_argument("-u", "--user-threads-only", action="store_true", |
| 69 | help="user threads only (no kernel threads)") |
Andrew Birchall | 7f0a6f8 | 2016-05-24 01:44:41 -0700 | [diff] [blame] | 70 | thread_group.add_argument("-k", "--kernel-threads-only", action="store_true", |
| 71 | help="kernel threads only (no user threads)") |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 72 | stack_group = parser.add_mutually_exclusive_group() |
| 73 | stack_group.add_argument("-U", "--user-stacks-only", action="store_true", |
Andrew Birchall | 7f0a6f8 | 2016-05-24 01:44:41 -0700 | [diff] [blame] | 74 | help="show stacks from user space only (no kernel space stacks)") |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 75 | stack_group.add_argument("-K", "--kernel-stacks-only", action="store_true", |
Andrew Birchall | 7f0a6f8 | 2016-05-24 01:44:41 -0700 | [diff] [blame] | 76 | help="show stacks from kernel space only (no user space stacks)") |
Evgeny Vereshchagin | 4509f09 | 2016-06-08 06:33:54 +1000 | [diff] [blame] | 77 | parser.add_argument("-d", "--delimited", action="store_true", |
| 78 | help="insert delimiter between kernel/user stacks") |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 79 | parser.add_argument("-f", "--folded", action="store_true", |
| 80 | help="output folded format") |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 81 | parser.add_argument("--stack-storage-size", default=1024, |
| 82 | type=positive_nonzero_int, |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 83 | help="the number of unique stack traces that can be stored and " |
| 84 | "displayed (default 1024)") |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 85 | parser.add_argument("duration", nargs="?", default=99999999, |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 86 | type=positive_nonzero_int, |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 87 | help="duration of trace, in seconds") |
Glauber Costa | 5246458 | 2016-09-26 12:59:32 -0700 | [diff] [blame] | 88 | parser.add_argument("-m", "--min-block-time", default=1, |
| 89 | type=positive_nonzero_int, |
Sasha Goldshtein | f41ae86 | 2016-10-19 01:14:30 +0300 | [diff] [blame] | 90 | help="the amount of time in microseconds over which we " + |
| 91 | "store traces (default 1)") |
| 92 | parser.add_argument("-M", "--max-block-time", default=(1 << 64) - 1, |
Glauber Costa | 5246458 | 2016-09-26 12:59:32 -0700 | [diff] [blame] | 93 | type=positive_nonzero_int, |
Sasha Goldshtein | f41ae86 | 2016-10-19 01:14:30 +0300 | [diff] [blame] | 94 | help="the amount of time in microseconds under which we " + |
| 95 | "store traces (default U64_MAX)") |
Brendan Gregg | 4870819 | 2017-08-03 11:49:27 -0700 | [diff] [blame] | 96 | parser.add_argument("--state", type=positive_int, |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 97 | help="filter on this thread state bitmask (eg, 2 == TASK_UNINTERRUPTIBLE" + |
| 98 | ") see include/linux/sched.h") |
Nathan Scott | cf0792f | 2018-02-02 16:56:50 +1100 | [diff] [blame] | 99 | parser.add_argument("--ebpf", action="store_true", |
| 100 | help=argparse.SUPPRESS) |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 101 | args = parser.parse_args() |
| 102 | folded = args.folded |
| 103 | duration = int(args.duration) |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 104 | debug = 0 |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 105 | |
| 106 | # signal handler |
| 107 | def signal_ignore(signal, frame): |
| 108 | print() |
| 109 | |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 110 | # define BPF program |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 111 | bpf_text = """ |
| 112 | #include <uapi/linux/ptrace.h> |
| 113 | #include <linux/sched.h> |
| 114 | |
Glauber Costa | 5246458 | 2016-09-26 12:59:32 -0700 | [diff] [blame] | 115 | #define MINBLOCK_US MINBLOCK_US_VALUEULL |
| 116 | #define MAXBLOCK_US MAXBLOCK_US_VALUEULL |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 117 | |
| 118 | struct key_t { |
Hengqi Chen | 08765a9 | 2021-10-31 23:20:10 +0800 | [diff] [blame] | 119 | u64 pid; |
| 120 | u64 tgid; |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 121 | int user_stack_id; |
| 122 | int kernel_stack_id; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 123 | char name[TASK_COMM_LEN]; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 124 | }; |
| 125 | BPF_HASH(counts, struct key_t); |
| 126 | BPF_HASH(start, u32); |
Song Liu | 67ae605 | 2018-02-01 14:59:24 -0800 | [diff] [blame] | 127 | BPF_STACK_TRACE(stack_traces, STACK_STORAGE_SIZE); |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 128 | |
Yuto Kawamura | 0d86893 | 2021-01-18 20:30:34 +0900 | [diff] [blame] | 129 | struct warn_event_t { |
| 130 | u32 pid; |
| 131 | u32 tgid; |
| 132 | u32 t_start; |
| 133 | u32 t_end; |
| 134 | }; |
| 135 | BPF_PERF_OUTPUT(warn_events); |
| 136 | |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 137 | int oncpu(struct pt_regs *ctx, struct task_struct *prev) { |
Evgeny Vereshchagin | 9858ca5 | 2016-05-27 06:13:52 +0000 | [diff] [blame] | 138 | u32 pid = prev->pid; |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 139 | u32 tgid = prev->tgid; |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 140 | u64 ts, *tsp; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 141 | |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 142 | // record previous thread sleep time |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 143 | if ((THREAD_FILTER) && (STATE_FILTER)) { |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 144 | ts = bpf_ktime_get_ns(); |
| 145 | start.update(&pid, &ts); |
| 146 | } |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 147 | |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 148 | // get the current thread's start time |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 149 | pid = bpf_get_current_pid_tgid(); |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 150 | tgid = bpf_get_current_pid_tgid() >> 32; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 151 | tsp = start.lookup(&pid); |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 152 | if (tsp == 0) { |
Brendan Gregg | f747114 | 2016-01-19 14:40:41 -0800 | [diff] [blame] | 153 | return 0; // missed start or filtered |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | // calculate current thread's delta time |
Yuto Kawamura | 2b97264 | 2021-01-14 21:14:12 +0900 | [diff] [blame] | 157 | u64 t_start = *tsp; |
| 158 | u64 t_end = bpf_ktime_get_ns(); |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 159 | start.delete(&pid); |
Yuto Kawamura | 2b97264 | 2021-01-14 21:14:12 +0900 | [diff] [blame] | 160 | if (t_start > t_end) { |
Yuto Kawamura | 0d86893 | 2021-01-18 20:30:34 +0900 | [diff] [blame] | 161 | struct warn_event_t event = { |
| 162 | .pid = pid, |
| 163 | .tgid = tgid, |
| 164 | .t_start = t_start, |
| 165 | .t_end = t_end, |
| 166 | }; |
| 167 | warn_events.perf_submit(ctx, &event, sizeof(event)); |
Yuto Kawamura | 2b97264 | 2021-01-14 21:14:12 +0900 | [diff] [blame] | 168 | return 0; |
| 169 | } |
| 170 | u64 delta = t_end - t_start; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 171 | delta = delta / 1000; |
Glauber Costa | 5246458 | 2016-09-26 12:59:32 -0700 | [diff] [blame] | 172 | if ((delta < MINBLOCK_US) || (delta > MAXBLOCK_US)) { |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 173 | return 0; |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 174 | } |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 175 | |
Brendan Gregg | f747114 | 2016-01-19 14:40:41 -0800 | [diff] [blame] | 176 | // create map key |
Brendan Gregg | f747114 | 2016-01-19 14:40:41 -0800 | [diff] [blame] | 177 | struct key_t key = {}; |
Vicent Marti | e82fb1b | 2016-03-25 17:21:44 +0100 | [diff] [blame] | 178 | |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 179 | key.pid = pid; |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 180 | key.tgid = tgid; |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 181 | key.user_stack_id = USER_STACK_GET; |
| 182 | key.kernel_stack_id = KERNEL_STACK_GET; |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 183 | bpf_get_current_comm(&key.name, sizeof(key.name)); |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 184 | |
Javier Honduvilla Coto | 64bf965 | 2018-08-01 06:50:19 +0200 | [diff] [blame] | 185 | counts.increment(key, delta); |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 186 | return 0; |
| 187 | } |
| 188 | """ |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 189 | |
| 190 | # set thread filter |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 191 | thread_context = "" |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 192 | if args.tgid is not None: |
| 193 | thread_context = "PID %d" % args.tgid |
| 194 | thread_filter = 'tgid == %d' % args.tgid |
| 195 | elif args.pid is not None: |
| 196 | thread_context = "TID %d" % args.pid |
| 197 | thread_filter = 'pid == %d' % args.pid |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 198 | elif args.user_threads_only: |
| 199 | thread_context = "user threads" |
| 200 | thread_filter = '!(prev->flags & PF_KTHREAD)' |
| 201 | elif args.kernel_threads_only: |
| 202 | thread_context = "kernel threads" |
| 203 | thread_filter = 'prev->flags & PF_KTHREAD' |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 204 | else: |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 205 | thread_context = "all threads" |
| 206 | thread_filter = '1' |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 207 | if args.state == 0: |
Hengqi Chen | 08765a9 | 2021-10-31 23:20:10 +0800 | [diff] [blame] | 208 | state_filter = 'prev->STATE_FIELD == 0' |
Brendan Gregg | 4870819 | 2017-08-03 11:49:27 -0700 | [diff] [blame] | 209 | elif args.state: |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 210 | # these states are sometimes bitmask checked |
Hengqi Chen | 08765a9 | 2021-10-31 23:20:10 +0800 | [diff] [blame] | 211 | state_filter = 'prev->STATE_FIELD & %d' % args.state |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 212 | else: |
| 213 | state_filter = '1' |
Andrew Birchall | 582b5dd | 2016-05-04 16:03:34 -0700 | [diff] [blame] | 214 | bpf_text = bpf_text.replace('THREAD_FILTER', thread_filter) |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 215 | bpf_text = bpf_text.replace('STATE_FILTER', state_filter) |
Hengqi Chen | 08765a9 | 2021-10-31 23:20:10 +0800 | [diff] [blame] | 216 | if BPF.kernel_struct_has_field(b'task_struct', b'__state') == 1: |
| 217 | bpf_text = bpf_text.replace('STATE_FIELD', '__state') |
| 218 | else: |
| 219 | bpf_text = bpf_text.replace('STATE_FIELD', 'state') |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 220 | |
| 221 | # set stack storage size |
| 222 | bpf_text = bpf_text.replace('STACK_STORAGE_SIZE', str(args.stack_storage_size)) |
Glauber Costa | 5246458 | 2016-09-26 12:59:32 -0700 | [diff] [blame] | 223 | bpf_text = bpf_text.replace('MINBLOCK_US_VALUE', str(args.min_block_time)) |
| 224 | bpf_text = bpf_text.replace('MAXBLOCK_US_VALUE', str(args.max_block_time)) |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 225 | |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 226 | # handle stack args |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 227 | kernel_stack_get = "stack_traces.get_stackid(ctx, 0)" |
| 228 | user_stack_get = "stack_traces.get_stackid(ctx, BPF_F_USER_STACK)" |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 229 | stack_context = "" |
| 230 | if args.user_stacks_only: |
| 231 | stack_context = "user" |
| 232 | kernel_stack_get = "-1" |
| 233 | elif args.kernel_stacks_only: |
| 234 | stack_context = "kernel" |
| 235 | user_stack_get = "-1" |
| 236 | else: |
| 237 | stack_context = "user + kernel" |
| 238 | bpf_text = bpf_text.replace('USER_STACK_GET', user_stack_get) |
| 239 | bpf_text = bpf_text.replace('KERNEL_STACK_GET', kernel_stack_get) |
| 240 | |
Sasha Goldshtein | f41ae86 | 2016-10-19 01:14:30 +0300 | [diff] [blame] | 241 | need_delimiter = args.delimited and not (args.kernel_stacks_only or |
| 242 | args.user_stacks_only) |
Evgeny Vereshchagin | 4509f09 | 2016-06-08 06:33:54 +1000 | [diff] [blame] | 243 | |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 244 | # check for an edge case; the code below will handle this case correctly |
| 245 | # but ultimately nothing will be displayed |
| 246 | if args.kernel_threads_only and args.user_stacks_only: |
Sasha Goldshtein | f41ae86 | 2016-10-19 01:14:30 +0300 | [diff] [blame] | 247 | print("ERROR: Displaying user stacks for kernel threads " + |
| 248 | "doesn't make sense.", file=stderr) |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 249 | exit(1) |
| 250 | |
Nathan Scott | cf0792f | 2018-02-02 16:56:50 +1100 | [diff] [blame] | 251 | if debug or args.ebpf: |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 252 | print(bpf_text) |
Nathan Scott | cf0792f | 2018-02-02 16:56:50 +1100 | [diff] [blame] | 253 | if args.ebpf: |
| 254 | exit() |
Brendan Gregg | 843340d | 2017-07-31 18:39:30 -0700 | [diff] [blame] | 255 | |
Brendan Gregg | d364d04 | 2016-01-19 17:12:52 -0800 | [diff] [blame] | 256 | # initialize BPF |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 257 | b = BPF(text=bpf_text) |
Guodong Xu | 00b72fd | 2021-03-13 02:23:47 +0000 | [diff] [blame] | 258 | b.attach_kprobe(event_re="^finish_task_switch$|^finish_task_switch\.isra\.\d$", |
| 259 | fn_name="oncpu") |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 260 | matched = b.num_open_kprobes() |
| 261 | if matched == 0: |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 262 | print("error: 0 functions traced. Exiting.", file=stderr) |
| 263 | exit(1) |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 264 | |
| 265 | # header |
| 266 | if not folded: |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 267 | print("Tracing off-CPU time (us) of %s by %s stack" % |
| 268 | (thread_context, stack_context), end="") |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 269 | if duration < 99999999: |
| 270 | print(" for %d secs." % duration) |
| 271 | else: |
| 272 | print("... Hit Ctrl-C to end.") |
| 273 | |
Yuto Kawamura | 0d86893 | 2021-01-18 20:30:34 +0900 | [diff] [blame] | 274 | |
| 275 | def print_warn_event(cpu, data, size): |
| 276 | event = b["warn_events"].event(data) |
| 277 | # See https://github.com/iovisor/bcc/pull/3227 for those wondering how can this happen. |
| 278 | print("WARN: Skipped an event with negative duration: pid:%d, tgid:%d, off-cpu:%d, on-cpu:%d" |
| 279 | % (event.pid, event.tgid, event.t_start, event.t_end), |
| 280 | file=stderr) |
| 281 | |
| 282 | b["warn_events"].open_perf_buffer(print_warn_event) |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 283 | try: |
Yuto Kawamura | 0d86893 | 2021-01-18 20:30:34 +0900 | [diff] [blame] | 284 | duration_ms = duration * 1000 |
| 285 | start_time_ms = int(BPF.monotonic_time() / 1000000) |
| 286 | while True: |
| 287 | elapsed_ms = int(BPF.monotonic_time() / 1000000) - start_time_ms |
| 288 | if elapsed_ms >= duration_ms: |
| 289 | break |
| 290 | b.perf_buffer_poll(timeout=duration_ms - elapsed_ms) |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 291 | except KeyboardInterrupt: |
| 292 | # as cleanup can take many seconds, trap Ctrl-C: |
| 293 | signal.signal(signal.SIGINT, signal_ignore) |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 294 | |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 295 | if not folded: |
| 296 | print() |
Brendan Gregg | 38cef48 | 2016-01-15 17:26:30 -0800 | [diff] [blame] | 297 | |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 298 | missing_stacks = 0 |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 299 | has_enomem = False |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 300 | counts = b.get_table("counts") |
| 301 | stack_traces = b.get_table("stack_traces") |
| 302 | for k, v in sorted(counts.items(), key=lambda counts: counts[1].value): |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 303 | # handle get_stackid errors |
| 304 | if not args.user_stacks_only and stack_id_err(k.kernel_stack_id): |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 305 | missing_stacks += 1 |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 306 | has_enomem = has_enomem or k.kernel_stack_id == -errno.ENOMEM |
| 307 | if not args.kernel_stacks_only and stack_id_err(k.user_stack_id): |
| 308 | missing_stacks += 1 |
| 309 | has_enomem = has_enomem or k.user_stack_id == -errno.ENOMEM |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 310 | |
Mark Drayton | 66bf2e8 | 2016-07-31 22:47:07 +0100 | [diff] [blame] | 311 | # user stacks will be symbolized by tgid, not pid, to avoid the overhead |
| 312 | # of one symbol resolver per thread |
Andrew Birchall | 1f202e7 | 2016-05-05 10:56:40 -0700 | [diff] [blame] | 313 | user_stack = [] if k.user_stack_id < 0 else \ |
| 314 | stack_traces.walk(k.user_stack_id) |
| 315 | kernel_stack = [] if k.kernel_stack_id < 0 else \ |
| 316 | stack_traces.walk(k.kernel_stack_id) |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 317 | |
| 318 | if folded: |
| 319 | # print folded stack output |
Evgeny Vereshchagin | ff39d0c | 2016-06-07 18:00:01 +1000 | [diff] [blame] | 320 | user_stack = list(user_stack) |
| 321 | kernel_stack = list(kernel_stack) |
jeromemarchand | b96ebcd | 2018-10-10 01:58:15 +0200 | [diff] [blame] | 322 | line = [k.name.decode('utf-8', 'replace')] |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 323 | # if we failed to get the stack is, such as due to no space (-ENOMEM) or |
| 324 | # hash collision (-EEXIST), we still print a placeholder for consistency |
| 325 | if not args.kernel_stacks_only: |
| 326 | if stack_id_err(k.user_stack_id): |
| 327 | line.append("[Missed User Stack]") |
| 328 | else: |
Jerome Marchand | f03beca | 2019-02-15 17:35:37 +0100 | [diff] [blame] | 329 | line.extend([b.sym(addr, k.tgid).decode('utf-8', 'replace') |
| 330 | for addr in reversed(user_stack)]) |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 331 | if not args.user_stacks_only: |
Teng Qin | e778db0 | 2018-04-24 16:11:49 -0700 | [diff] [blame] | 332 | line.extend(["-"] if (need_delimiter and k.kernel_stack_id >= 0 and k.user_stack_id >= 0) else []) |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 333 | if stack_id_err(k.kernel_stack_id): |
| 334 | line.append("[Missed Kernel Stack]") |
| 335 | else: |
Jerome Marchand | f03beca | 2019-02-15 17:35:37 +0100 | [diff] [blame] | 336 | line.extend([b.ksym(addr).decode('utf-8', 'replace') |
| 337 | for addr in reversed(kernel_stack)]) |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 338 | print("%s %d" % (";".join(line), v.value)) |
| 339 | else: |
| 340 | # print default multi-line stack output |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 341 | if not args.user_stacks_only: |
| 342 | if stack_id_err(k.kernel_stack_id): |
| 343 | print(" [Missed Kernel Stack]") |
| 344 | else: |
| 345 | for addr in kernel_stack: |
Benno Evers | 57975a1 | 2020-11-05 15:24:14 +0100 | [diff] [blame] | 346 | print(" %s" % b.ksym(addr).decode('utf-8', 'replace')) |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 347 | if not args.kernel_stacks_only: |
Teng Qin | e778db0 | 2018-04-24 16:11:49 -0700 | [diff] [blame] | 348 | if need_delimiter and k.user_stack_id >= 0 and k.kernel_stack_id >= 0: |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 349 | print(" --") |
| 350 | if stack_id_err(k.user_stack_id): |
| 351 | print(" [Missed User Stack]") |
| 352 | else: |
| 353 | for addr in user_stack: |
Benno Evers | 57975a1 | 2020-11-05 15:24:14 +0100 | [diff] [blame] | 354 | print(" %s" % b.sym(addr, k.tgid).decode('utf-8', 'replace')) |
jeromemarchand | b96ebcd | 2018-10-10 01:58:15 +0200 | [diff] [blame] | 355 | print(" %-16s %s (%d)" % ("-", k.name.decode('utf-8', 'replace'), k.pid)) |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 356 | print(" %d\n" % v.value) |
| 357 | |
| 358 | if missing_stacks > 0: |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 359 | enomem_str = "" if not has_enomem else \ |
| 360 | " Consider increasing --stack-storage-size." |
Teng Qin | ea72805 | 2018-04-13 16:48:09 -0700 | [diff] [blame] | 361 | print("WARNING: %d stack traces lost and could not be displayed.%s" % |
Andrew Birchall | 47d871f | 2016-05-11 18:31:49 -0700 | [diff] [blame] | 362 | (missing_stacks, enomem_str), |
Andrew Birchall | ee7e5b4 | 2016-05-03 16:54:00 -0700 | [diff] [blame] | 363 | file=stderr) |