2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7 * and NAI Labs, the Security Research Division of Network Associates, Inc.
8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9 * DARPA CHATS research program.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. The names of the authors may not be used to endorse or promote
20 * products derived from this software without specific prior written
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Copyright (c) 1986, 1992, 1993
36 * The Regents of the University of California. All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 #include <sys/cdefs.h>
64 __FBSDID("$FreeBSD$");
66 #include <sys/param.h>
68 #include <sys/kerneldump.h>
69 #include <sys/mount.h>
85 /* The size of the buffer used for I/O. */
86 #define BUFFERSIZE (1024*1024)
90 #define STATUS_UNKNOWN 2
92 static int checkfor, compress, clear, force, keep, verbose; /* flags */
93 static int nfound, nsaved, nerr; /* statistics */
96 extern FILE *zopen(const char *, const char *);
98 static sig_atomic_t got_siginfo;
99 static void infohandler(int);
102 printheader(xo_handle_t *xo, const struct kerneldumpheader *h, const char *device,
103 int bounds, const int status)
107 const char *stat_str;
110 xo_emit_h(xo, "{Lwc:Dump header from device}{:dump_device/%s}\n", device);
111 xo_emit_h(xo, "{P: }{Lwc:Architecture}{:architecture/%s}\n", h->architecture);
112 xo_emit_h(xo, "{P: }{Lwc:Architecture Version}{:architecture_version/%u}\n", dtoh32(h->architectureversion));
113 dumplen = dtoh64(h->dumplength);
114 xo_emit_h(xo, "{P: }{Lwc:Dump Length}{:dump_length_bytes/%lld}\n", (long long)dumplen);
115 xo_emit_h(xo, "{P: }{Lwc:Blocksize}{:blocksize/%d}\n", dtoh32(h->blocksize));
116 t = dtoh64(h->dumptime);
117 xo_emit_h(xo, "{P: }{Lwc:Dumptime}{:dumptime/%s}", ctime(&t));
118 xo_emit_h(xo, "{P: }{Lwc:Hostname}{:hostname/%s}\n", h->hostname);
119 xo_emit_h(xo, "{P: }{Lwc:Magic}{:magic/%s}\n", h->magic);
120 xo_emit_h(xo, "{P: }{Lwc:Version String}{:version_string/%s}", h->versionstring);
121 xo_emit_h(xo, "{P: }{Lwc:Panic String}{:panic_string/%s}\n", h->panicstring);
122 xo_emit_h(xo, "{P: }{Lwc:Dump Parity}{:dump_parity/%u}\n", h->parity);
123 xo_emit_h(xo, "{P: }{Lwc:Bounds}{:bounds/%d}\n", bounds);
133 stat_str = "unknown";
135 xo_emit_h(xo, "{P: }{Lwc:Dump Status}{:dump_status/%s}\n", stat_str);
147 if ((fp = fopen("bounds", "r")) == NULL) {
149 printf("unable to open bounds file, using 0\n");
153 if (fgets(buf, sizeof buf, fp) == NULL) {
155 syslog(LOG_WARNING, "bounds file is empty, using 0");
157 syslog(LOG_WARNING, "bounds file: %s", strerror(errno));
163 ret = (int)strtol(buf, NULL, 10);
164 if (ret == 0 && (errno == EINVAL || errno == ERANGE))
165 syslog(LOG_WARNING, "invalid value found in bounds, using 0");
171 writebounds(int bounds) {
174 if ((fp = fopen("bounds", "w")) == NULL) {
175 syslog(LOG_WARNING, "unable to write to bounds file: %m");
180 printf("bounds number: %d\n", bounds);
182 fprintf(fp, "%d\n", bounds);
187 file_size(const char *path)
191 /* Ignore all errors, those file may not exists. */
192 if (stat(path, &sb) == -1)
198 saved_dump_size(int bounds)
200 static char path[PATH_MAX];
205 (void)snprintf(path, sizeof(path), "info.%d", bounds);
206 dumpsize += file_size(path);
207 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
208 dumpsize += file_size(path);
209 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
210 dumpsize += file_size(path);
211 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
212 dumpsize += file_size(path);
213 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
214 dumpsize += file_size(path);
220 saved_dump_remove(int bounds)
222 static char path[PATH_MAX];
224 (void)snprintf(path, sizeof(path), "info.%d", bounds);
226 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
228 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
230 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
232 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
237 symlinks_remove(void)
240 (void)unlink("info.last");
241 (void)unlink("vmcore.last");
242 (void)unlink("vmcore.last.gz");
243 (void)unlink("textdump.tar.last");
244 (void)unlink("textdump.tar.last.gz");
248 * Check that sufficient space is available on the disk that holds the
252 check_space(const char *savedir, off_t dumpsize, int bounds)
255 off_t minfree, spacefree, totfree, needed;
259 if (statfs(".", &fsbuf) < 0) {
260 syslog(LOG_ERR, "%s: %m", savedir);
263 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
264 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
266 if ((fp = fopen("minfree", "r")) == NULL)
269 if (fgets(buf, sizeof(buf), fp) == NULL)
276 needed = dumpsize / 1024 + 2; /* 2 for info file */
277 needed -= saved_dump_size(bounds);
278 if ((minfree > 0 ? spacefree : totfree) - needed < minfree) {
280 "no dump, not enough free space on device (%lld available, need %lld)",
281 (long long)(minfree > 0 ? spacefree : totfree),
285 if (spacefree - needed < 0)
287 "dump performed, but free space threshold crossed");
291 #define BLOCKSIZE (1<<12)
292 #define BLOCKMASK (~(BLOCKSIZE-1))
295 DoRegularFile(int fd, off_t dumpsize, char *buf, const char *device,
296 const char *filename, FILE *fp)
298 int he, hs, nr, nw, wl;
299 off_t dmpcnt, origsize;
304 while (dumpsize > 0) {
308 nr = read(fd, buf, wl);
312 "WARNING: EOF on dump device");
314 syslog(LOG_ERR, "read error on %s: %m", device);
319 nw = fwrite(buf, 1, wl, fp);
321 for (nw = 0; nw < nr; nw = he) {
322 /* find a contiguous block of zeroes */
323 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
324 for (he = hs; he < nr && buf[he] == 0;
327 /* is the hole long enough to matter? */
328 if (he >= hs + BLOCKSIZE)
332 /* back down to a block boundary */
336 * 1) Don't go beyond the end of the buffer.
337 * 2) If the end of the buffer is less than
338 * BLOCKSIZE bytes away, we're at the end
339 * of the file, so just grab what's left.
341 if (hs + BLOCKSIZE > nr)
345 * At this point, we have a partial ordering:
346 * nw <= hs <= he <= nr
347 * If hs > nw, buf[nw..hs] contains non-zero data.
348 * If he > hs, buf[hs..he] is all zeroes.
351 if (fwrite(buf + nw, hs - nw, 1, fp)
355 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
361 "write error on %s file: %m", filename);
363 "WARNING: vmcore may be incomplete");
369 printf("%llu\r", (unsigned long long)dmpcnt);
374 printf("%s %.1lf%%\n", filename, (100.0 - (100.0 *
375 (double)dumpsize / (double)origsize)));
383 * Specialized version of dump-reading logic for use with textdumps, which
384 * are written backwards from the end of the partition, and must be reversed
385 * before being written to the file. Textdumps are small, so do a bit less
386 * work to optimize/sparsify.
389 DoTextdumpFile(int fd, off_t dumpsize, off_t lasthd, char *buf,
390 const char *device, const char *filename, FILE *fp)
393 off_t dmpcnt, totsize;
398 if ((dumpsize % wl) != 0) {
399 syslog(LOG_ERR, "textdump uneven multiple of 512 on %s",
404 while (dumpsize > 0) {
405 nr = pread(fd, buf, wl, lasthd - (totsize - dumpsize) - wl);
409 "WARNING: EOF on dump device");
411 syslog(LOG_ERR, "read error on %s: %m", device);
415 nw = fwrite(buf, 1, wl, fp);
418 "write error on %s file: %m", filename);
420 "WARNING: textdump may be incomplete");
426 printf("%llu\r", (unsigned long long)dmpcnt);
435 DoFile(const char *savedir, const char *device)
437 xo_handle_t *xostdout, *xoinfo;
438 static char infoname[PATH_MAX], corename[PATH_MAX], linkname[PATH_MAX];
439 static char *buf = NULL;
440 struct kerneldumpheader kdhf, kdhl;
441 off_t mediasize, dumpsize, firsthd, lasthd;
444 int fd, fdinfo, error;
446 u_int sectorsize, xostyle;
449 bounds = getbounds();
451 status = STATUS_UNKNOWN;
453 xostdout = xo_create_to_file(stdout, XO_STYLE_TEXT, 0);
454 if (xostdout == NULL) {
455 syslog(LOG_ERR, "%s: %m", infoname);
459 if (maxdumps > 0 && bounds == maxdumps)
463 buf = malloc(BUFFERSIZE);
465 syslog(LOG_ERR, "%m");
471 printf("checking for kernel dump on device %s\n", device);
473 fd = open(device, (checkfor || keep) ? O_RDONLY : O_RDWR);
475 syslog(LOG_ERR, "%s: %m", device);
479 error = ioctl(fd, DIOCGMEDIASIZE, &mediasize);
481 error = ioctl(fd, DIOCGSECTORSIZE, §orsize);
484 "couldn't find media and/or sector size of %s: %m", device);
489 printf("mediasize = %lld\n", (long long)mediasize);
490 printf("sectorsize = %u\n", sectorsize);
493 lasthd = mediasize - sectorsize;
494 if (lseek(fd, lasthd, SEEK_SET) != lasthd ||
495 read(fd, &kdhl, sizeof(kdhl)) != sizeof(kdhl)) {
497 "error reading last dump header at offset %lld in %s: %m",
498 (long long)lasthd, device);
502 if (strncmp(kdhl.magic, TEXTDUMPMAGIC, sizeof kdhl) == 0) {
504 printf("textdump magic on last dump header on %s\n",
507 if (dtoh32(kdhl.version) != KERNELDUMP_TEXT_VERSION) {
509 "unknown version (%d) in last dump header on %s",
510 dtoh32(kdhl.version), device);
516 } else if (memcmp(kdhl.magic, KERNELDUMPMAGIC, sizeof kdhl.magic) ==
518 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
520 "unknown version (%d) in last dump header on %s",
521 dtoh32(kdhl.version), device);
529 printf("magic mismatch on last dump header on %s\n",
536 if (memcmp(kdhl.magic, KERNELDUMPMAGIC_CLEARED,
537 sizeof kdhl.magic) == 0) {
539 printf("forcing magic on %s\n", device);
540 memcpy(kdhl.magic, KERNELDUMPMAGIC,
543 syslog(LOG_ERR, "unable to force dump - bad magic");
546 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
548 "unknown version (%d) in last dump header on %s",
549 dtoh32(kdhl.version), device);
561 if (kerneldump_parity(&kdhl)) {
563 "parity error on last dump header on %s", device);
569 dumpsize = dtoh64(kdhl.dumplength);
570 firsthd = lasthd - dumpsize - sizeof kdhf;
571 if (lseek(fd, firsthd, SEEK_SET) != firsthd ||
572 read(fd, &kdhf, sizeof(kdhf)) != sizeof(kdhf)) {
574 "error reading first dump header at offset %lld in %s: %m",
575 (long long)firsthd, device);
581 printf("First dump headers:\n");
582 printheader(xostdout, &kdhf, device, bounds, -1);
584 printf("\nLast dump headers:\n");
585 printheader(xostdout, &kdhl, device, bounds, -1);
589 if (memcmp(&kdhl, &kdhf, sizeof kdhl)) {
591 "first and last dump headers disagree on %s", device);
597 status = STATUS_GOOD;
601 printf("A dump exists on %s\n", device);
606 if (kdhl.panicstring[0])
607 syslog(LOG_ALERT, "reboot after panic: %*s",
608 (int)sizeof(kdhl.panicstring), kdhl.panicstring);
610 syslog(LOG_ALERT, "reboot");
613 printf("Checking for available free space\n");
615 if (!check_space(savedir, dumpsize, bounds)) {
620 writebounds(bounds + 1);
622 saved_dump_remove(bounds);
624 snprintf(infoname, sizeof(infoname), "info.%d", bounds);
627 * Create or overwrite any existing dump header files.
629 fdinfo = open(infoname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
631 syslog(LOG_ERR, "%s: %m", infoname);
636 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
638 snprintf(corename, sizeof(corename), "%s.%d.gz",
639 istextdump ? "textdump.tar" : "vmcore", bounds);
640 fp = zopen(corename, "w");
642 snprintf(corename, sizeof(corename), "%s.%d",
643 istextdump ? "textdump.tar" : "vmcore", bounds);
644 fp = fopen(corename, "w");
647 syslog(LOG_ERR, "%s: %m", corename);
654 info = fdopen(fdinfo, "w");
657 syslog(LOG_ERR, "fdopen failed: %m");
662 xostyle = xo_get_style(NULL);
663 xoinfo = xo_create_to_file(info, xostyle, 0);
664 if (xoinfo == NULL) {
665 syslog(LOG_ERR, "%s: %m", infoname);
669 xo_open_container_h(xoinfo, "crashdump");
672 printheader(xostdout, &kdhl, device, bounds, status);
674 printheader(xoinfo, &kdhl, device, bounds, status);
675 xo_close_container_h(xoinfo, "crashdump");
680 syslog(LOG_NOTICE, "writing %score to %s/%s",
681 compress ? "compressed " : "", savedir, corename);
684 if (DoTextdumpFile(fd, dumpsize, lasthd, buf, device,
688 if (DoRegularFile(fd, dumpsize, buf, device, corename, fp)
695 if (fclose(fp) < 0) {
696 syslog(LOG_ERR, "error on %s: %m", corename);
702 if (symlink(infoname, "info.last") == -1) {
703 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
704 savedir, "info.last");
707 snprintf(linkname, sizeof(linkname), "%s.last.gz",
708 istextdump ? "textdump.tar" : "vmcore");
710 snprintf(linkname, sizeof(linkname), "%s.last",
711 istextdump ? "textdump.tar" : "vmcore");
713 if (symlink(corename, linkname) == -1) {
714 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
721 printf("dump saved\n");
726 printf("clearing dump header\n");
727 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof kdhl.magic);
728 if (lseek(fd, lasthd, SEEK_SET) != lasthd ||
729 write(fd, &kdhl, sizeof(kdhl)) != sizeof(kdhl))
731 "error while clearing the dump header: %m");
733 xo_close_container_h(xostdout, "crashdump");
734 xo_finish_h(xostdout);
748 xo_error("%s\n%s\n%s\n",
749 "usage: savecore -c [-v] [device ...]",
750 " savecore -C [-v] [device ...]",
751 " savecore [-fkvz] [-m maxdumps] [directory [device ...]]");
756 main(int argc, char **argv)
758 const char *savedir = ".";
762 checkfor = compress = clear = force = keep = verbose = 0;
763 nfound = nsaved = nerr = 0;
765 openlog("savecore", LOG_PERROR, LOG_DAEMON);
766 signal(SIGINFO, infohandler);
768 argc = xo_parse_args(argc, argv);
772 while ((ch = getopt(argc, argv, "Ccfkm:vz")) != -1)
787 maxdumps = atoi(optarg);
789 syslog(LOG_ERR, "Invalid maxdump value");
803 if (checkfor && (clear || force || keep))
805 if (clear && (compress || keep))
807 if (maxdumps > 0 && (checkfor || clear))
811 if (argc >= 1 && !checkfor && !clear) {
812 error = chdir(argv[0]);
814 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
826 if (strcmp(fsp->fs_vfstype, "swap") &&
827 strcmp(fsp->fs_vfstype, "dump"))
829 DoFile(savedir, fsp->fs_spec);
832 for (i = 0; i < argc; i++)
833 DoFile(savedir, argv[i]);
836 /* Emit minimal output. */
840 printf("No dump exists\n");
844 syslog(LOG_WARNING, "no dumps found");
845 } else if (nsaved == 0) {
848 syslog(LOG_WARNING, "unsaved dumps found but not saved");
851 syslog(LOG_WARNING, "no unsaved dumps found");
858 infohandler(int sig __unused)