2 * Copyright (c) 2007 Robert N. M. Watson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/param.h>
30 #include <sys/sysctl.h>
42 * Walk the stack trace provided by the kernel and reduce it to what we
43 * actually want to print. This involves stripping true instruction pointers,
44 * frame numbers, and carriage returns as generated by stack(9). If -kk is
45 * specified, print the function and offset, otherwise just the function.
47 enum trace_state { TS_FRAMENUM, TS_PC, TS_AT, TS_FUNC, TS_OFF };
49 static enum trace_state
50 kstack_nextstate(enum trace_state ts)
70 errx(-1, "kstack_nextstate");
75 kstack_cleanup(const char *old, char *new, int kflag)
77 enum trace_state old_ts, ts;
82 for (cp_old = old, cp_new = new; *cp_old != '\0'; cp_old++) {
88 ts = kstack_nextstate(old_ts);
89 if (old_ts == TS_OFF) {
93 if (kflag > 1 && old_ts == TS_FUNC) {
99 if (ts == TS_FUNC || (kflag > 1 && ts == TS_OFF)) {
108 * Sort threads by tid.
111 kinfo_kstack_compare(const void *a, const void *b)
114 return ((const struct kinfo_kstack *)a)->kkst_tid -
115 ((const struct kinfo_kstack *)b)->kkst_tid;
119 kinfo_kstack_sort(struct kinfo_kstack *kkstp, int count)
122 qsort(kkstp, count, sizeof(*kkstp), kinfo_kstack_compare);
127 procstat_kstack(pid_t pid, struct kinfo_proc *kipp, int kflag)
129 struct kinfo_kstack *kkstp, *kkstp_free;
130 struct kinfo_proc *kip, *kip_free;
131 char trace[KKST_MAXLEN];
134 size_t kip_len, kstk_len;
137 printf("%5s %6s %-16s %-16s %-29s\n", "PID", "TID", "COMM",
142 name[2] = KERN_PROC_KSTACK;
146 error = sysctl(name, 4, NULL, &kstk_len, NULL, 0);
147 if (error < 0 && errno != ESRCH && errno != EPERM && errno != ENOENT) {
148 warn("sysctl: kern.proc.kstack: %d", pid);
151 if (error < 0 && errno == ENOENT) {
152 warnx("sysctl: kern.proc.kstack unavailable");
153 errx(-1, "options DDB or options STACK required in kernel");
158 kkstp = kkstp_free = malloc(kstk_len);
162 if (sysctl(name, 4, kkstp, &kstk_len, NULL, 0) < 0) {
163 warn("sysctl: kern.proc.pid: %d", pid);
169 * We need to re-query for thread information, so don't use *kipp.
173 name[2] = KERN_PROC_PID | KERN_PROC_INC_THREAD;
177 error = sysctl(name, 4, NULL, &kip_len, NULL, 0);
178 if (error < 0 && errno != ESRCH) {
179 warn("sysctl: kern.proc.pid: %d", pid);
185 kip = kip_free = malloc(kip_len);
189 if (sysctl(name, 4, kip, &kip_len, NULL, 0) < 0) {
190 warn("sysctl: kern.proc.pid: %d", pid);
195 kinfo_kstack_sort(kkstp, kstk_len / sizeof(*kkstp));
196 for (i = 0; i < kstk_len / sizeof(*kkstp); i++) {
197 kkstp = &kkstp_free[i];
200 * Look up the specific thread using its tid so we can
201 * display the per-thread command line.
204 for (j = 0; j < kip_len / sizeof(*kipp); j++) {
206 if (kkstp->kkst_tid == kipp->ki_tid)
213 printf("%6d ", kkstp->kkst_tid);
214 printf("%-16s ", kipp->ki_comm);
215 printf("%-16s ", (strlen(kipp->ki_ocomm) &&
216 (strcmp(kipp->ki_comm, kipp->ki_ocomm) != 0)) ?
217 kipp->ki_ocomm : "-");
219 switch (kkstp->kkst_state) {
220 case KKST_STATE_RUNNING:
221 printf("%-29s\n", "<running>");
224 case KKST_STATE_SWAPPED:
225 printf("%-29s\n", "<swapped>");
228 case KKST_STATE_STACKOK:
232 printf("%-29s\n", "<unknown>");
237 * The kernel generates a trace with carriage returns between
238 * entries, but for a more compact view, we convert carriage
241 kstack_cleanup(kkstp->kkst_trace, trace, kflag);
242 printf("%-29s\n", trace);