2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002 Jake Burkholder
5 * Copyright (c) 2004 Robert Watson
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/types.h>
34 #include <sys/capsicum.h>
39 #include <capsicum_helpers.h>
54 "usage: ktrdump [-cflqrtH] [-i ktrfile] [-M core] [-N system] [-o outfile]\n"
56 static void usage(void);
58 static struct nlist nl[] = {
59 { .n_name = "_ktr_version" },
60 { .n_name = "_ktr_entries" },
61 { .n_name = "_ktr_idx" },
62 { .n_name = "_ktr_buf" },
77 static char corefile[PATH_MAX];
78 static char execfile[PATH_MAX];
79 static char outfile[PATH_MAX] = "stdout";
81 static char desc[SBUFLEN];
82 static char errbuf[_POSIX2_LINE_MAX];
83 static char fbuf[PATH_MAX];
84 static char obuf[PATH_MAX];
85 static char sbuf[KTR_PARMS][SBUFLEN];
88 * Reads the ktr trace buffer from kernel memory and prints the trace entries.
91 main(int ac, char **av)
93 u_long parms[KTR_PARMS];
94 struct ktr_entry *buf;
95 uintmax_t tlast, tnow;
112 * Parse commandline arguments.
115 while ((c = getopt(ac, av, "cflqrtHe:i:m:M:N:o:")) != -1)
122 if (strlcpy(execfile, optarg, sizeof(execfile))
124 errx(1, "%s: File name too long", optarg);
132 if ((in = open(optarg, O_RDONLY)) == -1)
133 err(1, "%s", optarg);
134 cap_rights_init(&rights, CAP_FSTAT, CAP_MMAP_R);
135 if (caph_rights_limit(in, &rights) < 0)
136 err(1, "unable to limit rights for %s",
144 if (strlcpy(corefile, optarg, sizeof(corefile))
146 errx(1, "%s: File name too long", optarg);
150 if ((out = fopen(optarg, "w")) == NULL)
151 err(1, "%s", optarg);
152 strlcpy(outfile, optarg, sizeof(outfile));
175 if (caph_limit_stream(fileno(out), CAPH_WRITE) < 0)
176 err(1, "unable to limit rights for %s", outfile);
177 if (caph_limit_stderr() < 0)
178 err(1, "unable to limit rights for stderr");
181 * Open our execfile and corefile, resolve needed symbols and read in
184 if ((kd = kvm_openfiles(Nflag ? execfile : NULL,
185 Mflag ? corefile : NULL, NULL, O_RDONLY, errbuf)) == NULL)
186 errx(1, "%s", errbuf);
189 * Cache NLS data, for strerror, for err(3), before entering capability
192 caph_cache_catpages();
194 count = kvm_nlist(kd, nl);
196 errx(1, "%s", kvm_geterr(kd));
198 errx(1, "failed to resolve ktr symbols");
199 if (kvm_read(kd, nl[0].n_value, &version, sizeof(version)) == -1)
200 errx(1, "%s", kvm_geterr(kd));
201 if (version != KTR_VERSION)
202 errx(1, "ktr version mismatch");
205 * Enter Capsicum sandbox.
207 * kvm_nlist() above uses kldsym(2) for native kernels, and that isn't
208 * allowed in the sandbox.
210 if (caph_enter() < 0)
211 err(1, "unable to enter capability mode");
214 if (fstat(in, &sb) == -1)
216 entries = sb.st_size / sizeof(*buf);
218 buf = mmap(NULL, sb.st_size, PROT_READ, MAP_SHARED, in, 0);
219 if (buf == MAP_FAILED)
222 if (kvm_read(kd, nl[1].n_value, &entries, sizeof(entries))
224 errx(1, "%s", kvm_geterr(kd));
225 if ((buf = malloc(sizeof(*buf) * entries)) == NULL)
227 if (kvm_read(kd, nl[2].n_value, &index, sizeof(index)) == -1 ||
228 kvm_read(kd, nl[3].n_value, &bufptr,
229 sizeof(bufptr)) == -1 ||
230 kvm_read(kd, bufptr, buf, sizeof(*buf) * entries) == -1 ||
231 kvm_read(kd, nl[2].n_value, &index2, sizeof(index2)) == -1)
232 errx(1, "%s", kvm_geterr(kd));
236 * Print a nice header.
239 fprintf(out, "%-6s ", "index");
241 fprintf(out, "%-3s ", "cpu");
243 fprintf(out, "%-16s ", "timestamp");
245 fprintf(out, "%-40s ", "file and line");
247 fprintf(out, "%-18s ", "tid");
248 fprintf(out, "%s", "trace");
251 fprintf(out, "------ ");
253 fprintf(out, "--- ");
255 fprintf(out, "---------------- ");
258 "---------------------------------------- ");
260 fprintf(out, "------------------ ");
261 fprintf(out, "----- ");
267 * Now tear through the trace buffer.
269 * In "live" mode, find the oldest entry (first non-NULL entry
270 * after index2) and walk forward. Otherwise, start with the
271 * most recent entry and walk backwards.
275 i = index2 + 1 % entries;
276 while (buf[i].ktr_desc == NULL && i != index) {
289 if (buf[i].ktr_desc == NULL)
291 if (kvm_read(kd, (u_long)buf[i].ktr_desc, desc,
293 errx(1, "%s", kvm_geterr(kd));
294 desc[sizeof(desc) - 1] = '\0';
296 for (p = desc; (c = *p++) != '\0';) {
299 next: if ((c = *p++) == '\0')
303 if (parm == KTR_PARMS)
304 errx(1, "too many parameters in \"%s\"", desc);
306 case '0': case '1': case '2': case '3': case '4':
307 case '5': case '6': case '7': case '8': case '9':
308 case '#': case '-': case ' ': case '+': case '\'':
309 case 'h': case 'l': case 'j': case 't': case 'z':
310 case 'q': case 'L': case '.':
313 if (kvm_read(kd, (u_long)buf[i].ktr_parms[parm],
314 sbuf[parm], sizeof(sbuf[parm])) == -1)
315 strcpy(sbuf[parm], "(null)");
316 sbuf[parm][sizeof(sbuf[0]) - 1] = '\0';
317 parms[parm] = (u_long)sbuf[parm];
321 parms[parm] = buf[i].ktr_parms[parm];
326 fprintf(out, "%6d ", i);
328 fprintf(out, "%3d ", buf[i].ktr_cpu);
330 tnow = (uintmax_t)buf[i].ktr_timestamp;
332 if (tlast == UINTPTR_MAX)
334 fprintf(out, "%16ju ", !iflag ? tlast - tnow :
338 fprintf(out, "%16ju ", tnow);
341 if (kvm_read(kd, (u_long)buf[i].ktr_file, fbuf,
343 strcpy(fbuf, "(null)");
344 snprintf(obuf, sizeof(obuf), "%s:%d", fbuf,
346 fprintf(out, "%-40s ", obuf);
349 fprintf(out, "%p ", buf[i].ktr_thread);
350 fprintf(out, desc, parms[0], parms[1], parms[2], parms[3],
355 * 'index' and 'index2' are the values of 'ktr_idx'
356 * before and after the KTR buffer was copied into
357 * 'buf'. Since the KTR entries between 'index' and
358 * 'index2' were in flux while the KTR buffer was
359 * being copied to userspace we don't dump them.
379 * In "live" mode, poll 'ktr_idx' periodically and dump any
380 * new entries since our last pass through the ring.
382 if (lflag && !iflag) {
383 while (index == index2) {
385 if (kvm_read(kd, nl[2].n_value, &index2,
386 sizeof(index2)) == -1)
387 errx(1, "%s", kvm_geterr(kd));
391 if (kvm_read(kd, bufptr, buf, sizeof(*buf) * entries) == -1 ||
392 kvm_read(kd, nl[2].n_value, &index2, sizeof(index2)) == -1)
393 errx(1, "%s", kvm_geterr(kd));
404 fprintf(stderr, USAGE);