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>
87 /* The size of the buffer used for I/O. */
88 #define BUFFERSIZE (1024*1024)
92 #define STATUS_UNKNOWN 2
94 static int checkfor, compress, clear, force, keep, verbose; /* flags */
95 static int nfound, nsaved, nerr; /* statistics */
98 extern FILE *zopen(const char *, const char *);
100 static sig_atomic_t got_siginfo;
101 static void infohandler(int);
104 printheader(xo_handle_t *xo, const struct kerneldumpheader *h, const char *device,
105 int bounds, const int status)
109 const char *stat_str;
112 xo_emit_h(xo, "{Lwc:Dump header from device}{:dump_device/%s}\n", device);
113 xo_emit_h(xo, "{P: }{Lwc:Architecture}{:architecture/%s}\n", h->architecture);
114 xo_emit_h(xo, "{P: }{Lwc:Architecture Version}{:architecture_version/%u}\n", dtoh32(h->architectureversion));
115 dumplen = dtoh64(h->dumplength);
116 xo_emit_h(xo, "{P: }{Lwc:Dump Length}{:dump_length_bytes/%lld}\n", (long long)dumplen);
117 xo_emit_h(xo, "{P: }{Lwc:Blocksize}{:blocksize/%d}\n", dtoh32(h->blocksize));
118 t = dtoh64(h->dumptime);
119 xo_emit_h(xo, "{P: }{Lwc:Dumptime}{:dumptime/%s}", ctime(&t));
120 xo_emit_h(xo, "{P: }{Lwc:Hostname}{:hostname/%s}\n", h->hostname);
121 xo_emit_h(xo, "{P: }{Lwc:Magic}{:magic/%s}\n", h->magic);
122 xo_emit_h(xo, "{P: }{Lwc:Version String}{:version_string/%s}", h->versionstring);
123 xo_emit_h(xo, "{P: }{Lwc:Panic String}{:panic_string/%s}\n", h->panicstring);
124 xo_emit_h(xo, "{P: }{Lwc:Dump Parity}{:dump_parity/%u}\n", h->parity);
125 xo_emit_h(xo, "{P: }{Lwc:Bounds}{:bounds/%d}\n", bounds);
135 stat_str = "unknown";
137 xo_emit_h(xo, "{P: }{Lwc:Dump Status}{:dump_status/%s}\n", stat_str);
149 if ((fp = fopen("bounds", "r")) == NULL) {
151 printf("unable to open bounds file, using 0\n");
155 if (fgets(buf, sizeof buf, fp) == NULL) {
157 syslog(LOG_WARNING, "bounds file is empty, using 0");
159 syslog(LOG_WARNING, "bounds file: %s", strerror(errno));
165 ret = (int)strtol(buf, NULL, 10);
166 if (ret == 0 && (errno == EINVAL || errno == ERANGE))
167 syslog(LOG_WARNING, "invalid value found in bounds, using 0");
173 writebounds(int bounds) {
176 if ((fp = fopen("bounds", "w")) == NULL) {
177 syslog(LOG_WARNING, "unable to write to bounds file: %m");
182 printf("bounds number: %d\n", bounds);
184 fprintf(fp, "%d\n", bounds);
189 file_size(const char *path)
193 /* Ignore all errors, those file may not exists. */
194 if (stat(path, &sb) == -1)
200 saved_dump_size(int bounds)
202 static char path[PATH_MAX];
207 (void)snprintf(path, sizeof(path), "info.%d", bounds);
208 dumpsize += file_size(path);
209 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
210 dumpsize += file_size(path);
211 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
212 dumpsize += file_size(path);
213 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
214 dumpsize += file_size(path);
215 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
216 dumpsize += file_size(path);
222 saved_dump_remove(int bounds)
224 static char path[PATH_MAX];
226 (void)snprintf(path, sizeof(path), "info.%d", bounds);
228 (void)snprintf(path, sizeof(path), "vmcore.%d", bounds);
230 (void)snprintf(path, sizeof(path), "vmcore.%d.gz", bounds);
232 (void)snprintf(path, sizeof(path), "textdump.tar.%d", bounds);
234 (void)snprintf(path, sizeof(path), "textdump.tar.%d.gz", bounds);
239 symlinks_remove(void)
242 (void)unlink("info.last");
243 (void)unlink("vmcore.last");
244 (void)unlink("vmcore.last.gz");
245 (void)unlink("textdump.tar.last");
246 (void)unlink("textdump.tar.last.gz");
250 * Check that sufficient space is available on the disk that holds the
254 check_space(const char *savedir, off_t dumpsize, int bounds)
257 off_t available, minfree, spacefree, totfree, needed;
261 if (statfs(".", &fsbuf) < 0) {
262 syslog(LOG_ERR, "%s: %m", savedir);
265 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
266 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
268 if ((fp = fopen("minfree", "r")) == NULL)
271 if (fgets(buf, sizeof(buf), fp) == NULL)
277 minfree = strtoll(buf, &endp, 10);
278 if (minfree == 0 && errno != 0)
281 while (*endp != '\0' && isspace(*endp))
283 if (*endp != '\0' || minfree < 0)
288 "`minfree` didn't contain a valid size "
289 "(`%s`). Defaulting to 0", buf);
294 available = minfree > 0 ? spacefree - minfree : totfree;
295 needed = dumpsize / 1024 + 2; /* 2 for info file */
296 needed -= saved_dump_size(bounds);
297 if (available < needed) {
299 "no dump: not enough free space on device (need at least "
300 "%jdkB for dump; %jdkB available; %jdkB reserved)",
302 (intmax_t)available + minfree,
306 if (spacefree - needed < 0)
308 "dump performed, but free space threshold crossed");
313 compare_magic(const struct kerneldumpheader *kdh, const char *magic)
316 return (strncmp(kdh->magic, magic, sizeof(kdh->magic)) == 0);
319 #define BLOCKSIZE (1<<12)
320 #define BLOCKMASK (~(BLOCKSIZE-1))
323 DoRegularFile(int fd, off_t dumpsize, char *buf, const char *device,
324 const char *filename, FILE *fp)
326 int he, hs, nr, nw, wl;
327 off_t dmpcnt, origsize;
332 while (dumpsize > 0) {
336 nr = read(fd, buf, wl);
340 "WARNING: EOF on dump device");
342 syslog(LOG_ERR, "read error on %s: %m", device);
347 nw = fwrite(buf, 1, wl, fp);
349 for (nw = 0; nw < nr; nw = he) {
350 /* find a contiguous block of zeroes */
351 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
352 for (he = hs; he < nr && buf[he] == 0;
355 /* is the hole long enough to matter? */
356 if (he >= hs + BLOCKSIZE)
360 /* back down to a block boundary */
364 * 1) Don't go beyond the end of the buffer.
365 * 2) If the end of the buffer is less than
366 * BLOCKSIZE bytes away, we're at the end
367 * of the file, so just grab what's left.
369 if (hs + BLOCKSIZE > nr)
373 * At this point, we have a partial ordering:
374 * nw <= hs <= he <= nr
375 * If hs > nw, buf[nw..hs] contains non-zero data.
376 * If he > hs, buf[hs..he] is all zeroes.
379 if (fwrite(buf + nw, hs - nw, 1, fp)
383 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
389 "write error on %s file: %m", filename);
391 "WARNING: vmcore may be incomplete");
397 printf("%llu\r", (unsigned long long)dmpcnt);
402 printf("%s %.1lf%%\n", filename, (100.0 - (100.0 *
403 (double)dumpsize / (double)origsize)));
411 * Specialized version of dump-reading logic for use with textdumps, which
412 * are written backwards from the end of the partition, and must be reversed
413 * before being written to the file. Textdumps are small, so do a bit less
414 * work to optimize/sparsify.
417 DoTextdumpFile(int fd, off_t dumpsize, off_t lasthd, char *buf,
418 const char *device, const char *filename, FILE *fp)
421 off_t dmpcnt, totsize;
426 if ((dumpsize % wl) != 0) {
427 syslog(LOG_ERR, "textdump uneven multiple of 512 on %s",
432 while (dumpsize > 0) {
433 nr = pread(fd, buf, wl, lasthd - (totsize - dumpsize) - wl);
437 "WARNING: EOF on dump device");
439 syslog(LOG_ERR, "read error on %s: %m", device);
443 nw = fwrite(buf, 1, wl, fp);
446 "write error on %s file: %m", filename);
448 "WARNING: textdump may be incomplete");
454 printf("%llu\r", (unsigned long long)dmpcnt);
463 DoFile(const char *savedir, const char *device)
465 xo_handle_t *xostdout, *xoinfo;
466 static char infoname[PATH_MAX], corename[PATH_MAX], linkname[PATH_MAX];
467 static char *buf = NULL, *temp = NULL;
468 struct kerneldumpheader kdhf, kdhl;
469 off_t mediasize, dumpsize, firsthd, lasthd;
472 int fd, fdinfo, error;
474 u_int sectorsize, xostyle;
477 bounds = getbounds();
479 status = STATUS_UNKNOWN;
481 xostdout = xo_create_to_file(stdout, XO_STYLE_TEXT, 0);
482 if (xostdout == NULL) {
483 syslog(LOG_ERR, "%s: %m", infoname);
487 if (maxdumps > 0 && bounds == maxdumps)
491 buf = malloc(BUFFERSIZE);
493 syslog(LOG_ERR, "%m");
499 printf("checking for kernel dump on device %s\n", device);
501 fd = open(device, (checkfor || keep) ? O_RDONLY : O_RDWR);
503 syslog(LOG_ERR, "%s: %m", device);
507 error = ioctl(fd, DIOCGMEDIASIZE, &mediasize);
509 error = ioctl(fd, DIOCGSECTORSIZE, §orsize);
512 "couldn't find media and/or sector size of %s: %m", device);
517 printf("mediasize = %lld bytes\n", (long long)mediasize);
518 printf("sectorsize = %u bytes\n", sectorsize);
521 if (sectorsize < sizeof(kdhl)) {
523 "Sector size is less the kernel dump header %zu",
528 lasthd = mediasize - sectorsize;
530 temp = malloc(sectorsize);
532 syslog(LOG_ERR, "%m");
536 if (lseek(fd, lasthd, SEEK_SET) != lasthd ||
537 read(fd, temp, sectorsize) != (ssize_t)sectorsize) {
539 "error reading last dump header at offset %lld in %s: %m",
540 (long long)lasthd, device);
543 memcpy(&kdhl, temp, sizeof(kdhl));
545 if (compare_magic(&kdhl, TEXTDUMPMAGIC)) {
547 printf("textdump magic on last dump header on %s\n",
550 if (dtoh32(kdhl.version) != KERNELDUMP_TEXT_VERSION) {
552 "unknown version (%d) in last dump header on %s",
553 dtoh32(kdhl.version), device);
559 } else if (compare_magic(&kdhl, KERNELDUMPMAGIC)) {
560 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
562 "unknown version (%d) in last dump header on %s",
563 dtoh32(kdhl.version), device);
571 printf("magic mismatch on last dump header on %s\n",
578 if (compare_magic(&kdhl, KERNELDUMPMAGIC_CLEARED)) {
580 printf("forcing magic on %s\n", device);
581 memcpy(kdhl.magic, KERNELDUMPMAGIC,
584 syslog(LOG_ERR, "unable to force dump - bad magic");
587 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
589 "unknown version (%d) in last dump header on %s",
590 dtoh32(kdhl.version), device);
602 if (kerneldump_parity(&kdhl)) {
604 "parity error on last dump header on %s", device);
610 dumpsize = dtoh64(kdhl.dumplength);
611 firsthd = lasthd - dumpsize - sectorsize;
612 if (lseek(fd, firsthd, SEEK_SET) != firsthd ||
613 read(fd, temp, sectorsize) != (ssize_t)sectorsize) {
615 "error reading first dump header at offset %lld in %s: %m",
616 (long long)firsthd, device);
620 memcpy(&kdhf, temp, sizeof(kdhf));
623 printf("First dump headers:\n");
624 printheader(xostdout, &kdhf, device, bounds, -1);
626 printf("\nLast dump headers:\n");
627 printheader(xostdout, &kdhl, device, bounds, -1);
631 if (memcmp(&kdhl, &kdhf, sizeof(kdhl))) {
633 "first and last dump headers disagree on %s", device);
639 status = STATUS_GOOD;
643 printf("A dump exists on %s\n", device);
648 if (kdhl.panicstring[0] != '\0')
649 syslog(LOG_ALERT, "reboot after panic: %.*s",
650 (int)sizeof(kdhl.panicstring), kdhl.panicstring);
652 syslog(LOG_ALERT, "reboot");
655 printf("Checking for available free space\n");
657 if (!check_space(savedir, dumpsize, bounds)) {
662 writebounds(bounds + 1);
664 saved_dump_remove(bounds);
666 snprintf(infoname, sizeof(infoname), "info.%d", bounds);
669 * Create or overwrite any existing dump header files.
671 fdinfo = open(infoname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
673 syslog(LOG_ERR, "%s: %m", infoname);
678 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
680 snprintf(corename, sizeof(corename), "%s.%d.gz",
681 istextdump ? "textdump.tar" : "vmcore", bounds);
682 fp = zopen(corename, "w");
684 snprintf(corename, sizeof(corename), "%s.%d",
685 istextdump ? "textdump.tar" : "vmcore", bounds);
686 fp = fopen(corename, "w");
689 syslog(LOG_ERR, "%s: %m", corename);
696 info = fdopen(fdinfo, "w");
699 syslog(LOG_ERR, "fdopen failed: %m");
704 xostyle = xo_get_style(NULL);
705 xoinfo = xo_create_to_file(info, xostyle, 0);
706 if (xoinfo == NULL) {
707 syslog(LOG_ERR, "%s: %m", infoname);
711 xo_open_container_h(xoinfo, "crashdump");
714 printheader(xostdout, &kdhl, device, bounds, status);
716 printheader(xoinfo, &kdhl, device, bounds, status);
717 xo_close_container_h(xoinfo, "crashdump");
722 syslog(LOG_NOTICE, "writing %score to %s/%s",
723 compress ? "compressed " : "", savedir, corename);
726 if (DoTextdumpFile(fd, dumpsize, lasthd, buf, device,
730 if (DoRegularFile(fd, dumpsize, buf, device, corename, fp)
737 if (fclose(fp) < 0) {
738 syslog(LOG_ERR, "error on %s: %m", corename);
744 if (symlink(infoname, "info.last") == -1) {
745 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
746 savedir, "info.last");
749 snprintf(linkname, sizeof(linkname), "%s.last.gz",
750 istextdump ? "textdump.tar" : "vmcore");
752 snprintf(linkname, sizeof(linkname), "%s.last",
753 istextdump ? "textdump.tar" : "vmcore");
755 if (symlink(corename, linkname) == -1) {
756 syslog(LOG_WARNING, "unable to create symlink %s/%s: %m",
763 printf("dump saved\n");
768 printf("clearing dump header\n");
769 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof(kdhl.magic));
770 memcpy(temp, &kdhl, sizeof(kdhl));
771 if (lseek(fd, lasthd, SEEK_SET) != lasthd ||
772 write(fd, temp, sectorsize) != (ssize_t)sectorsize)
774 "error while clearing the dump header: %m");
776 xo_close_container_h(xostdout, "crashdump");
777 xo_finish_h(xostdout);
791 xo_error("%s\n%s\n%s\n",
792 "usage: savecore -c [-v] [device ...]",
793 " savecore -C [-v] [device ...]",
794 " savecore [-fkvz] [-m maxdumps] [directory [device ...]]");
799 main(int argc, char **argv)
801 const char *savedir = ".";
805 checkfor = compress = clear = force = keep = verbose = 0;
806 nfound = nsaved = nerr = 0;
808 openlog("savecore", LOG_PERROR, LOG_DAEMON);
809 signal(SIGINFO, infohandler);
811 argc = xo_parse_args(argc, argv);
815 while ((ch = getopt(argc, argv, "Ccfkm:vz")) != -1)
830 maxdumps = atoi(optarg);
832 syslog(LOG_ERR, "Invalid maxdump value");
846 if (checkfor && (clear || force || keep))
848 if (clear && (compress || keep))
850 if (maxdumps > 0 && (checkfor || clear))
854 if (argc >= 1 && !checkfor && !clear) {
855 error = chdir(argv[0]);
857 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
869 if (strcmp(fsp->fs_vfstype, "swap") &&
870 strcmp(fsp->fs_vfstype, "dump"))
872 DoFile(savedir, fsp->fs_spec);
876 for (i = 0; i < argc; i++)
877 DoFile(savedir, argv[i]);
880 /* Emit minimal output. */
884 printf("No dump exists\n");
888 syslog(LOG_WARNING, "no dumps found");
889 } else if (nsaved == 0) {
892 syslog(LOG_WARNING, "unsaved dumps found but not saved");
895 syslog(LOG_WARNING, "no unsaved dumps found");
902 infohandler(int sig __unused)