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(FILE *f, const struct kerneldumpheader *h, const char *device,
103 int bounds, const int status)
107 const char *stat_str;
109 fprintf(f, "Dump header from device %s\n", device);
110 fprintf(f, " Architecture: %s\n", h->architecture);
111 fprintf(f, " Architecture Version: %u\n",
112 dtoh32(h->architectureversion));
113 dumplen = dtoh64(h->dumplength);
114 fprintf(f, " Dump Length: %lldB (%lld MB)\n", (long long)dumplen,
115 (long long)(dumplen >> 20));
116 fprintf(f, " Blocksize: %d\n", dtoh32(h->blocksize));
117 t = dtoh64(h->dumptime);
118 fprintf(f, " Dumptime: %s", ctime(&t));
119 fprintf(f, " Hostname: %s\n", h->hostname);
120 fprintf(f, " Magic: %s\n", h->magic);
121 fprintf(f, " Version String: %s", h->versionstring);
122 fprintf(f, " Panic String: %s\n", h->panicstring);
123 fprintf(f, " Dump Parity: %u\n", h->parity);
124 fprintf(f, " Bounds: %d\n", bounds);
134 stat_str = "unknown";
136 fprintf(f, " Dump Status: %s\n", stat_str);
148 if ((fp = fopen("bounds", "r")) == NULL) {
150 printf("unable to open bounds file, using 0\n");
154 if (fgets(buf, sizeof buf, fp) == NULL) {
156 syslog(LOG_WARNING, "bounds file is empty, using 0");
158 syslog(LOG_WARNING, "bounds file: %s", strerror(errno));
164 ret = (int)strtol(buf, NULL, 10);
165 if (ret == 0 && (errno == EINVAL || errno == ERANGE))
166 syslog(LOG_WARNING, "invalid value found in bounds, using 0");
172 writebounds(int bounds) {
175 if ((fp = fopen("bounds", "w")) == NULL) {
176 syslog(LOG_WARNING, "unable to write to bounds file: %m");
181 printf("bounds number: %d\n", bounds);
183 fprintf(fp, "%d\n", bounds);
188 file_size(const char *path)
192 /* Ignore all errors, those file may not exists. */
193 if (stat(path, &sb) == -1)
199 saved_dump_size(int bounds)
201 static char path[PATH_MAX];
206 (void)snprintf(path, sizeof(path), "info.%d", bounds);
207 dumpsize += file_size(path);
208 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
209 dumpsize += file_size(path);
210 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
211 dumpsize += file_size(path);
212 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
213 dumpsize += file_size(path);
214 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
215 dumpsize += file_size(path);
221 saved_dump_remove(int bounds)
223 static char path[PATH_MAX];
225 (void)snprintf(path, sizeof(path), "info.%d", bounds);
227 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
229 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
231 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
233 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
238 symlinks_remove(void)
241 (void)unlink("info.last");
242 (void)unlink("vmcore.last");
243 (void)unlink("vmcore.last.gz");
244 (void)unlink("textdump.tar.last");
245 (void)unlink("textdump.tar.last.gz");
249 * Check that sufficient space is available on the disk that holds the
253 check_space(const char *savedir, off_t dumpsize, int bounds)
256 off_t available, minfree, spacefree, totfree, needed;
260 if (statfs(".", &fsbuf) < 0) {
261 syslog(LOG_ERR, "%s: %m", savedir);
264 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
265 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
267 if ((fp = fopen("minfree", "r")) == NULL)
270 if (fgets(buf, sizeof(buf), fp) == NULL)
276 minfree = strtoll(buf, &endp, 10);
277 if (minfree == 0 && errno != 0)
280 while (*endp != '\0' && isspace(*endp))
282 if (*endp != '\0' || minfree < 0)
287 "`minfree` didn't contain a valid size "
288 "(`%s`). Defaulting to 0", buf);
293 available = minfree > 0 ? spacefree - minfree : totfree;
294 needed = dumpsize / 1024 + 2; /* 2 for info file */
295 needed -= saved_dump_size(bounds);
296 if (available < needed) {
298 "no dump: not enough free space on device (need at least "
299 "%jdkB for dump; %jdkB available; %jdkB reserved)",
301 (intmax_t)available + minfree,
305 if (spacefree - needed < 0)
307 "dump performed, but free space threshold crossed");
311 #define BLOCKSIZE (1<<12)
312 #define BLOCKMASK (~(BLOCKSIZE-1))
315 DoRegularFile(int fd, off_t dumpsize, char *buf, const char *device,
316 const char *filename, FILE *fp)
318 int he, hs, nr, nw, wl;
319 off_t dmpcnt, origsize;
324 while (dumpsize > 0) {
328 nr = read(fd, buf, wl);
332 "WARNING: EOF on dump device");
334 syslog(LOG_ERR, "read error on %s: %m", device);
339 nw = fwrite(buf, 1, wl, fp);
341 for (nw = 0; nw < nr; nw = he) {
342 /* find a contiguous block of zeroes */
343 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
344 for (he = hs; he < nr && buf[he] == 0;
347 /* is the hole long enough to matter? */
348 if (he >= hs + BLOCKSIZE)
352 /* back down to a block boundary */
356 * 1) Don't go beyond the end of the buffer.
357 * 2) If the end of the buffer is less than
358 * BLOCKSIZE bytes away, we're at the end
359 * of the file, so just grab what's left.
361 if (hs + BLOCKSIZE > nr)
365 * At this point, we have a partial ordering:
366 * nw <= hs <= he <= nr
367 * If hs > nw, buf[nw..hs] contains non-zero data.
368 * If he > hs, buf[hs..he] is all zeroes.
371 if (fwrite(buf + nw, hs - nw, 1, fp)
375 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
381 "write error on %s file: %m", filename);
383 "WARNING: vmcore may be incomplete");
389 printf("%llu\r", (unsigned long long)dmpcnt);
394 printf("%s %.1lf%%\n", filename, (100.0 - (100.0 *
395 (double)dumpsize / (double)origsize)));
403 * Specialized version of dump-reading logic for use with textdumps, which
404 * are written backwards from the end of the partition, and must be reversed
405 * before being written to the file. Textdumps are small, so do a bit less
406 * work to optimize/sparsify.
409 DoTextdumpFile(int fd, off_t dumpsize, off_t lasthd, char *buf,
410 const char *device, const char *filename, FILE *fp)
413 off_t dmpcnt, totsize;
418 if ((dumpsize % wl) != 0) {
419 syslog(LOG_ERR, "textdump uneven multiple of 512 on %s",
424 while (dumpsize > 0) {
425 nr = pread(fd, buf, wl, lasthd - (totsize - dumpsize) - wl);
429 "WARNING: EOF on dump device");
431 syslog(LOG_ERR, "read error on %s: %m", device);
435 nw = fwrite(buf, 1, wl, fp);
438 "write error on %s file: %m", filename);
440 "WARNING: textdump may be incomplete");
446 printf("%llu\r", (unsigned long long)dmpcnt);
455 DoFile(const char *savedir, const char *device)
457 static char infoname[PATH_MAX], corename[PATH_MAX], linkname[PATH_MAX];
458 static char *buf = NULL;
459 struct kerneldumpheader kdhf, kdhl;
460 off_t mediasize, dumpsize, firsthd, lasthd;
463 int fd, fdinfo, error;
468 bounds = getbounds();
470 status = STATUS_UNKNOWN;
472 if (maxdumps > 0 && bounds == maxdumps)
476 buf = malloc(BUFFERSIZE);
478 syslog(LOG_ERR, "%m");
484 printf("checking for kernel dump on device %s\n", device);
486 fd = open(device, (checkfor || keep) ? O_RDONLY : O_RDWR);
488 syslog(LOG_ERR, "%s: %m", device);
492 error = ioctl(fd, DIOCGMEDIASIZE, &mediasize);
494 error = ioctl(fd, DIOCGSECTORSIZE, §orsize);
497 "couldn't find media and/or sector size of %s: %m", device);
502 printf("mediasize = %lld bytes\n", (long long)mediasize);
503 printf("sectorsize = %u bytes\n", sectorsize);
506 lasthd = mediasize - sectorsize;
507 lseek(fd, lasthd, SEEK_SET);
508 error = read(fd, &kdhl, sizeof kdhl);
509 if (error != sizeof kdhl) {
511 "error reading last dump header at offset %lld in %s: %m",
512 (long long)lasthd, device);
516 if (strncmp(kdhl.magic, TEXTDUMPMAGIC, sizeof kdhl) == 0) {
518 printf("textdump magic on last dump header on %s\n",
521 if (dtoh32(kdhl.version) != KERNELDUMP_TEXT_VERSION) {
523 "unknown version (%d) in last dump header on %s",
524 dtoh32(kdhl.version), device);
530 } else if (memcmp(kdhl.magic, KERNELDUMPMAGIC, sizeof kdhl.magic) ==
532 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
534 "unknown version (%d) in last dump header on %s",
535 dtoh32(kdhl.version), device);
543 printf("magic mismatch on last dump header on %s\n",
550 if (memcmp(kdhl.magic, KERNELDUMPMAGIC_CLEARED,
551 sizeof kdhl.magic) == 0) {
553 printf("forcing magic on %s\n", device);
554 memcpy(kdhl.magic, KERNELDUMPMAGIC,
557 syslog(LOG_ERR, "unable to force dump - bad magic");
560 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
562 "unknown version (%d) in last dump header on %s",
563 dtoh32(kdhl.version), device);
575 if (kerneldump_parity(&kdhl)) {
577 "parity error on last dump header on %s", device);
583 dumpsize = dtoh64(kdhl.dumplength);
584 firsthd = lasthd - dumpsize - sizeof kdhf;
585 lseek(fd, firsthd, SEEK_SET);
586 error = read(fd, &kdhf, sizeof kdhf);
587 if (error != sizeof kdhf) {
589 "error reading first dump header at offset %lld in %s: %m",
590 (long long)firsthd, device);
596 printf("First dump headers:\n");
597 printheader(stdout, &kdhf, device, bounds, -1);
599 printf("\nLast dump headers:\n");
600 printheader(stdout, &kdhl, device, bounds, -1);
604 if (memcmp(&kdhl, &kdhf, sizeof kdhl)) {
606 "first and last dump headers disagree on %s", device);
612 status = STATUS_GOOD;
616 printf("A dump exists on %s\n", device);
621 if (kdhl.panicstring[0])
622 syslog(LOG_ALERT, "reboot after panic: %s", kdhl.panicstring);
624 syslog(LOG_ALERT, "reboot");
627 printf("Checking for available free space\n");
629 if (!check_space(savedir, dumpsize, bounds)) {
634 writebounds(bounds + 1);
636 saved_dump_remove(bounds);
638 snprintf(infoname, sizeof(infoname), "info.%d", bounds);
641 * Create or overwrite any existing dump header files.
643 fdinfo = open(infoname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
645 syslog(LOG_ERR, "%s: %m", infoname);
649 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
651 snprintf(corename, sizeof(corename), "%s.%d.gz",
652 istextdump ? "textdump.tar" : "vmcore", bounds);
653 fp = zopen(corename, "w");
655 snprintf(corename, sizeof(corename), "%s.%d",
656 istextdump ? "textdump.tar" : "vmcore", bounds);
657 fp = fopen(corename, "w");
660 syslog(LOG_ERR, "%s: %m", corename);
667 info = fdopen(fdinfo, "w");
670 syslog(LOG_ERR, "fdopen failed: %m");
676 printheader(stdout, &kdhl, device, bounds, status);
678 printheader(info, &kdhl, device, bounds, status);
681 syslog(LOG_NOTICE, "writing %score to %s/%s",
682 compress ? "compressed " : "", savedir, corename);
685 if (DoTextdumpFile(fd, dumpsize, lasthd, buf, device,
689 if (DoRegularFile(fd, dumpsize, buf, device, corename, fp)
696 if (fclose(fp) < 0) {
697 syslog(LOG_ERR, "error on %s: %m", corename);
703 if (symlink(infoname, "info.last") == -1) {
704 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
705 savedir, "info.last");
708 snprintf(linkname, sizeof(linkname), "%s.last.gz",
709 istextdump ? "textdump.tar" : "vmcore");
711 snprintf(linkname, sizeof(linkname), "%s.last",
712 istextdump ? "textdump.tar" : "vmcore");
714 if (symlink(corename, linkname) == -1) {
715 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
722 printf("dump saved\n");
727 printf("clearing dump header\n");
728 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof kdhl.magic);
729 lseek(fd, lasthd, SEEK_SET);
730 error = write(fd, &kdhl, sizeof kdhl);
731 if (error != sizeof kdhl)
733 "error while clearing the dump header: %m");
748 fprintf(stderr, "%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 while ((ch = getopt(argc, argv, "Ccfkm:vz")) != -1)
783 maxdumps = atoi(optarg);
785 syslog(LOG_ERR, "Invalid maxdump value");
799 if (checkfor && (clear || force || keep))
801 if (clear && (compress || keep))
803 if (maxdumps > 0 && (checkfor || clear))
807 if (argc >= 1 && !checkfor && !clear) {
808 error = chdir(argv[0]);
810 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
822 if (strcmp(fsp->fs_vfstype, "swap") &&
823 strcmp(fsp->fs_vfstype, "dump"))
825 DoFile(savedir, fsp->fs_spec);
828 for (i = 0; i < argc; i++)
829 DoFile(savedir, argv[i]);
832 /* Emit minimal output. */
835 printf("No dump exists\n");
838 syslog(LOG_WARNING, "no dumps found");
840 else if (nsaved == 0) {
842 syslog(LOG_WARNING, "unsaved dumps found but not saved");
844 syslog(LOG_WARNING, "no unsaved dumps found");
851 infohandler(int sig __unused)