2 * Copyright (c) 2002 Jake Burkholder
3 * Copyright (c) 2004 Robert Watson
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/usr.bin/ktrdump/ktrdump.c,v 1.10 2005/05/21 09:55:06 ru Exp $
28 * $DragonFly: src/usr.bin/ktrdump/ktrdump.c,v 1.11 2008/02/17 10:23:57 corecode Exp $
31 #include <sys/cdefs.h>
33 #include <sys/types.h>
37 #include <sys/queue.h>
56 struct ktr_entry *ents;
59 int beg_idx; /* Beginning index */
60 int end_idx; /* Ending index */
63 static struct nlist nl[] = {
71 static struct nlist nl2[] = {
89 static double tsc_frequency;
90 static double correction_factor = 0.0;
92 static char corefile[PATH_MAX];
93 static char execfile[PATH_MAX];
95 static char errbuf[_POSIX2_LINE_MAX];
98 static int entries_per_buf;
101 static void usage(void);
102 static int earliest_ts(struct ktr_buffer *buf);
103 static void print_header(FILE *fo, int row);
104 static void print_entry(FILE *fo, kvm_t *kd, int n, int i, struct ktr_entry *entry, u_int64_t *last_timestamp);
105 static struct ktr_info *kvm_ktrinfo(kvm_t *kd, void *kptr);
106 static const char *kvm_string(kvm_t *kd, const char *kptr);
107 static const char *trunc_path(const char *str, int maxlen);
108 static void read_symbols(const char *execfile);
109 static const char *address_to_symbol(void *kptr);
110 static struct ktr_buffer *ktr_bufs_init(int);
111 static void load_bufs(struct ktr_buffer *, struct ktr_entry **);
112 static void print_buf(FILE *, struct ktr_buffer *, int, u_int64_t *);
113 static void print_bufs_timesorted(FILE *, struct ktr_buffer *, u_int64_t *);
117 * Reads the ktr trace buffer from kernel memory and prints the trace entries.
120 main(int ac, char **av)
122 struct ktr_buffer *ktr_bufs;
123 struct ktr_entry **ktr_kbuf;
126 int *ktr_start_index;
132 * Parse commandline arguments.
135 while ((c = getopt(ac, av, "acfinqrtxpslA:N:M:o:")) != -1) {
150 if (strlcpy(execfile, optarg, sizeof(execfile))
152 errx(1, "%s: File name too long", optarg);
165 correction_factor = strtod(optarg, NULL);
168 if (strlcpy(corefile, optarg, sizeof(corefile))
170 errx(1, "%s: File name too long", optarg);
177 if ((fo = fopen(optarg, "w")) == NULL)
178 err(1, "%s", optarg);
190 sflag = 1; /* sort across the cpus */
203 if (cflag + iflag + tflag + xflag + fflag + pflag == 0) {
209 if (correction_factor != 0.0 && (rflag == 0 || nflag)) {
210 fprintf(stderr, "Correction factor can only be applied with -r and without -n\n");
219 * Open our execfile and corefile, resolve needed symbols and read in
222 if ((kd = kvm_openfiles(Nflag ? execfile : NULL,
223 Mflag ? corefile : NULL, NULL, O_RDONLY, errbuf)) == NULL)
224 errx(1, "%s", errbuf);
225 if (kvm_nlist(kd, nl) != 0)
226 errx(1, "%s", kvm_geterr(kd));
227 if (kvm_read(kd, nl[0].n_value, &version, sizeof(version)) == -1)
228 errx(1, "%s", kvm_geterr(kd));
229 if (kvm_read(kd, nl[4].n_value, &ncpus, sizeof(ncpus)) == -1)
230 errx(1, "%s", kvm_geterr(kd));
231 ktr_start_index = malloc(sizeof(*ktr_start_index) * ncpus);
232 if (version >= 3 && kvm_nlist(kd, nl2) == 0) {
233 if (kvm_read(kd, nl2[0].n_value, &tts, sizeof(tts)) == -1)
234 errx(1, "%s", kvm_geterr(kd));
235 tsc_frequency = (double)tts;
237 if (version > KTR_VERSION)
238 errx(1, "ktr version too high for us to handle");
239 if (kvm_read(kd, nl[1].n_value, &entries_per_buf,
240 sizeof(entries_per_buf)) == -1)
241 errx(1, "%s", kvm_geterr(kd));
242 fifo_mask = entries_per_buf - 1;
244 printf("TSC frequency is %6.3f MHz\n", tsc_frequency / 1000000.0);
246 ktr_kbuf = malloc(sizeof(*ktr_kbuf) * ncpus);
249 read_symbols(Nflag ? execfile : NULL);
251 if (kvm_read(kd, nl[3].n_value, ktr_kbuf, sizeof(*ktr_kbuf) * ncpus) == -1)
252 errx(1, "%s", kvm_geterr(kd));
254 ktr_bufs = ktr_bufs_init(ncpus);
257 u_int64_t last_timestamp = 0;
259 load_bufs(ktr_bufs, ktr_kbuf);
260 print_bufs_timesorted(fo, ktr_bufs, &last_timestamp);
262 usleep(1000000 / 10);
265 u_int64_t *last_timestamp = calloc(sizeof(u_int64_t), ncpus);
267 load_bufs(ktr_bufs, ktr_kbuf);
268 for (n = 0; n < ncpus; ++n)
269 print_buf(fo, ktr_bufs, n, &last_timestamp[n]);
271 usleep(1000000 / 10);
278 print_header(FILE *fo, int row)
280 if (qflag == 0 && (u_int32_t)row % 20 == 0) {
281 fprintf(fo, "%-6s ", "index");
283 fprintf(fo, "%-3s ", "cpu");
285 fprintf(fo, "%-16s ", "timestamp");
288 fprintf(fo, "%-10s %-10s", "caller2", "caller1");
290 fprintf(fo, "%-20s %-20s", "caller2", "caller1");
293 fprintf(fo, "%-20s ", "ID");
295 fprintf(fo, "%10s%-30s ", "", "file and line");
297 fprintf(fo, "%s", "trace");
303 print_entry(FILE *fo, kvm_t *kd, int n, int row, struct ktr_entry *entry,
304 u_int64_t *last_timestamp)
306 struct ktr_info *info = NULL;
308 fprintf(fo, " %06x ", row & 0x00FFFFFF);
310 fprintf(fo, "%-3d ", n);
311 if (tflag || rflag) {
312 if (rflag && !nflag && tsc_frequency != 0.0) {
313 fprintf(fo, "%13.3f uS ",
314 (double)(entry->ktr_timestamp - *last_timestamp) * 1000000.0 / tsc_frequency - correction_factor);
316 fprintf(fo, "%-16lld ", entry->ktr_timestamp -
319 fprintf(fo, "%-16lld ", entry->ktr_timestamp);
324 fprintf(fo, "%p %p ",
325 entry->ktr_caller2, entry->ktr_caller1);
327 fprintf(fo, "%-20s ",
328 address_to_symbol(entry->ktr_caller2));
329 fprintf(fo, "%-20s ",
330 address_to_symbol(entry->ktr_caller1));
334 info = kvm_ktrinfo(kd, entry->ktr_info);
336 fprintf(fo, "%-20s ", kvm_string(kd, info->kf_name));
338 fprintf(fo, "%-20s ", "<empty>");
341 fprintf(fo, "%34s:%-4d ", trunc_path(kvm_string(kd, entry->ktr_file), 34), entry->ktr_line);
344 info = kvm_ktrinfo(kd, entry->ktr_info);
346 fprintf(fo, kvm_string(kd, info->kf_format),
347 entry->ktr_data[0], entry->ktr_data[1],
348 entry->ktr_data[2], entry->ktr_data[3],
349 entry->ktr_data[4], entry->ktr_data[5],
350 entry->ktr_data[6], entry->ktr_data[7],
351 entry->ktr_data[8], entry->ktr_data[9]);
357 *last_timestamp = entry->ktr_timestamp;
362 kvm_ktrinfo(kvm_t *kd, void *kptr)
364 static struct ktr_info save_info;
365 static void *save_kptr;
369 if (save_kptr != kptr) {
370 if (kvm_read(kd, (uintptr_t)kptr, &save_info, sizeof(save_info)) == -1) {
371 bzero(&save_info, sizeof(save_info));
381 kvm_string(kvm_t *kd, const char *kptr)
383 static char save_str[128];
384 static const char *save_kptr;
390 if (save_kptr != kptr) {
393 while (l < sizeof(save_str) - 1) {
394 n = 256 - ((intptr_t)(kptr + l) & 255);
395 if (n > sizeof(save_str) - l - 1)
396 n = sizeof(save_str) - l - 1;
397 if (kvm_read(kd, (uintptr_t)(kptr + l), save_str + l, n) < 0)
399 while (l < sizeof(save_str) && n) {
400 if (save_str[l] == 0)
415 trunc_path(const char *str, int maxlen)
417 int len = strlen(str);
420 return(str + len - maxlen);
426 TAILQ_ENTRY(symdata) link;
432 static TAILQ_HEAD(symlist, symdata) symlist;
433 static struct symdata *symcache;
434 static char *symbegin;
439 read_symbols(const char *execfile)
443 int buflen = sizeof(buf);
450 TAILQ_INIT(&symlist);
452 if (execfile == NULL) {
453 if (sysctlbyname("kern.bootfile", buf, &buflen, NULL, 0) < 0)
454 execfile = "/kernel";
458 snprintf(cmd, sizeof(cmd), "nm -n %s", execfile);
459 if ((fp = popen(cmd, "r")) != NULL) {
460 while (fgets(buf, sizeof(buf), fp) != NULL) {
461 s1 = strtok(buf, " \t\n");
462 s2 = strtok(NULL, " \t\n");
463 s3 = strtok(NULL, " \t\n");
464 if (s1 && s2 && s3) {
465 sym = malloc(sizeof(struct symdata));
466 sym->symaddr = (char *)strtoul(s1, NULL, 16);
467 sym->symtype = s2[0];
468 sym->symname = strdup(s3);
469 if (strcmp(s3, "kernbase") == 0)
470 symbegin = sym->symaddr;
471 if (strcmp(s3, "end") == 0)
472 symend = sym->symaddr;
473 TAILQ_INSERT_TAIL(&symlist, sym, link);
478 symcache = TAILQ_FIRST(&symlist);
483 address_to_symbol(void *kptr)
487 if (symcache == NULL ||
488 (char *)kptr < symbegin || (char *)kptr >= symend
490 snprintf(buf, sizeof(buf), "%p", kptr);
493 while ((char *)symcache->symaddr < (char *)kptr) {
494 if (TAILQ_NEXT(symcache, link) == NULL)
496 symcache = TAILQ_NEXT(symcache, link);
498 while ((char *)symcache->symaddr > (char *)kptr) {
499 if (symcache != TAILQ_FIRST(&symlist))
500 symcache = TAILQ_PREV(symcache, symlist, link);
502 snprintf(buf, sizeof(buf), "%s+%d", symcache->symname,
503 (int)((char *)kptr - symcache->symaddr));
509 ktr_bufs_init(int ncpus)
511 struct ktr_buffer *ktr_bufs, *it;
514 ktr_bufs = malloc(sizeof(*ktr_bufs) * ncpus);
516 err(1, "can't allocate data structures\n");
517 for (i = 0; i < ncpus; ++i) {
519 it->ents = malloc(sizeof(struct ktr_entry) * entries_per_buf);
520 if (it->ents == NULL)
521 err(1, "can't allocate data structures\n");
531 get_indices(kvm_t *kd, int *idx)
533 if (kvm_read(kd, nl[2].n_value, idx, sizeof(*idx) * ncpus) == -1)
534 errx(1, "%s", kvm_geterr(kd));
538 * Get the trace buffer data from the kernel
542 load_bufs(struct ktr_buffer *ktr_bufs, struct ktr_entry **kbufs)
544 static int *kern_idx;
545 struct ktr_buffer *kbuf;
549 kern_idx = malloc(sizeof(*kern_idx) * ncpus);
551 err(1, "can't allocate data structures\n");
555 get_indices(kd, kern_idx);
556 for (i = 0; i < ncpus; ++i) {
558 if (kern_idx[i] == kbuf->end_idx)
560 kbuf->end_idx = kern_idx[i];
563 * If we do not have a notion of the beginning index, assume
564 * it is entries_per_buf before the ending index. Don't
565 * worry about underflows/negative numbers, the indices will
569 kbuf->beg_idx = kbuf->end_idx - entries_per_buf + 1;
572 if (kvm_read(kd, (uintptr_t)kbufs[i], ktr_bufs[i].ents,
573 sizeof(struct ktr_entry) * entries_per_buf)
575 errx(1, "%s", kvm_geterr(kd));
577 kbuf->beg_idx = earliest_ts(kbuf);
583 * Locate the earliest timestamp iterating backwards from end_idx, but
584 * not going further back then beg_idx. We have to do this because
585 * the kernel uses a circulating buffer.
589 earliest_ts(struct ktr_buffer *buf)
591 struct ktr_entry *save;
592 int count, scan, i, earliest;
595 earliest = buf->end_idx - 1;
596 save = &buf->ents[earliest & fifo_mask];
597 for (scan = buf->end_idx - 1; scan != buf->beg_idx -1; --scan) {
598 i = scan & fifo_mask;
599 if (buf->ents[i].ktr_timestamp <= save->ktr_timestamp)
602 * We may have gotten so far behind that beg_idx wrapped
603 * more then once around the buffer. Just stop
605 if (++count == entries_per_buf)
613 print_buf(FILE *fo, struct ktr_buffer *ktr_bufs, int cpu,
614 u_int64_t *last_timestamp)
617 struct ktr_buffer *buf = ktr_bufs + cpu;
619 if (buf->modified == 0)
621 if (*last_timestamp == 0) {
623 buf->ents[buf->beg_idx & fifo_mask].ktr_timestamp;
625 while (buf->beg_idx != buf->end_idx) {
626 print_header(fo, buf->beg_idx);
627 print_entry(fo, kd, cpu, buf->beg_idx,
628 &buf->ents[buf->beg_idx & fifo_mask],
637 print_bufs_timesorted(FILE *fo, struct ktr_buffer *ktr_bufs,
638 u_int64_t *last_timestamp)
640 struct ktr_entry *ent;
641 struct ktr_buffer *buf;
649 for (n = 0; n < ncpus; ++n) {
651 if (buf->beg_idx == buf->end_idx)
653 ent = &buf->ents[buf->beg_idx & fifo_mask];
654 if (ts == 0 || (ts >= ent->ktr_timestamp)) {
655 ts = ent->ktr_timestamp;
659 if ((bestn < 0) || (ts < *last_timestamp))
661 buf = ktr_bufs + bestn;
662 print_header(fo, row);
663 print_entry(fo, kd, bestn, row,
664 &buf->ents[buf->beg_idx & fifo_mask],
667 *last_timestamp = ts;
675 fprintf(stderr, "usage: ktrdump [-acfilnpqrtx] [-N execfile] "
676 "[-M corefile] [-o outfile]\n");