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>
83 /* The size of the buffer used for I/O. */
84 #define BUFFERSIZE (1024*1024)
88 #define STATUS_UNKNOWN 2
90 static int checkfor, compress, clear, force, keep, verbose; /* flags */
91 static int nfound, nsaved, nerr; /* statistics */
93 extern FILE *zopen(const char *, const char *);
95 static sig_atomic_t got_siginfo;
96 static void infohandler(int);
99 printheader(FILE *f, const struct kerneldumpheader *h, const char *device,
100 int bounds, const int status)
104 const char *stat_str;
106 fprintf(f, "Dump header from device %s\n", device);
107 fprintf(f, " Architecture: %s\n", h->architecture);
108 fprintf(f, " Architecture Version: %u\n",
109 dtoh32(h->architectureversion));
110 dumplen = dtoh64(h->dumplength);
111 fprintf(f, " Dump Length: %lldB (%lld MB)\n", (long long)dumplen,
112 (long long)(dumplen >> 20));
113 fprintf(f, " Blocksize: %d\n", dtoh32(h->blocksize));
114 t = dtoh64(h->dumptime);
115 fprintf(f, " Dumptime: %s", ctime(&t));
116 fprintf(f, " Hostname: %s\n", h->hostname);
117 fprintf(f, " Magic: %s\n", h->magic);
118 fprintf(f, " Version String: %s", h->versionstring);
119 fprintf(f, " Panic String: %s\n", h->panicstring);
120 fprintf(f, " Dump Parity: %u\n", h->parity);
121 fprintf(f, " Bounds: %d\n", bounds);
131 stat_str = "unknown";
133 fprintf(f, " Dump Status: %s\n", stat_str);
145 if ((fp = fopen("bounds", "r")) == NULL) {
147 printf("unable to open bounds file, using 0\n");
151 if (fgets(buf, sizeof buf, fp) == NULL) {
152 syslog(LOG_WARNING, "unable to read from bounds, using 0");
158 ret = (int)strtol(buf, NULL, 10);
159 if (ret == 0 && (errno == EINVAL || errno == ERANGE))
160 syslog(LOG_WARNING, "invalid value found in bounds, using 0");
165 writebounds(int bounds) {
168 if ((fp = fopen("bounds", "w")) == NULL) {
169 syslog(LOG_WARNING, "unable to write to bounds file: %m");
174 printf("bounds number: %d\n", bounds);
176 fprintf(fp, "%d\n", bounds);
181 * Check that sufficient space is available on the disk that holds the
185 check_space(const char *savedir, off_t dumpsize)
188 off_t minfree, spacefree, totfree, needed;
190 char buf[100], path[MAXPATHLEN];
192 if (statfs(savedir, &fsbuf) < 0) {
193 syslog(LOG_ERR, "%s: %m", savedir);
196 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
197 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
199 (void)snprintf(path, sizeof(path), "%s/minfree", savedir);
200 if ((fp = fopen(path, "r")) == NULL)
203 if (fgets(buf, sizeof(buf), fp) == NULL)
210 needed = dumpsize / 1024 + 2; /* 2 for info file */
211 if (((minfree > 0) ? spacefree : totfree) - needed < minfree) {
213 "no dump, not enough free space on device (%lld available, need %lld)",
214 (long long)(minfree > 0 ? spacefree : totfree),
218 if (spacefree - needed < 0)
220 "dump performed, but free space threshold crossed");
224 #define BLOCKSIZE (1<<12)
225 #define BLOCKMASK (~(BLOCKSIZE-1))
228 DoRegularFile(int fd, off_t dumpsize, char *buf, const char *device,
229 const char *filename, FILE *fp)
231 int he, hs, nr, nw, wl;
232 off_t dmpcnt, origsize;
237 while (dumpsize > 0) {
241 nr = read(fd, buf, wl);
245 "WARNING: EOF on dump device");
247 syslog(LOG_ERR, "read error on %s: %m", device);
252 nw = fwrite(buf, 1, wl, fp);
254 for (nw = 0; nw < nr; nw = he) {
255 /* find a contiguous block of zeroes */
256 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
257 for (he = hs; he < nr && buf[he] == 0;
260 /* is the hole long enough to matter? */
261 if (he >= hs + BLOCKSIZE)
265 /* back down to a block boundary */
269 * 1) Don't go beyond the end of the buffer.
270 * 2) If the end of the buffer is less than
271 * BLOCKSIZE bytes away, we're at the end
272 * of the file, so just grab what's left.
274 if (hs + BLOCKSIZE > nr)
278 * At this point, we have a partial ordering:
279 * nw <= hs <= he <= nr
280 * If hs > nw, buf[nw..hs] contains non-zero data.
281 * If he > hs, buf[hs..he] is all zeroes.
284 if (fwrite(buf + nw, hs - nw, 1, fp)
288 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
294 "write error on %s file: %m", filename);
296 "WARNING: vmcore may be incomplete");
302 printf("%llu\r", (unsigned long long)dmpcnt);
307 printf("%s %.1lf%%\n", filename, (100.0 - (100.0 *
308 (double)dumpsize / (double)origsize)));
316 * Specialized version of dump-reading logic for use with textdumps, which
317 * are written backwards from the end of the partition, and must be reversed
318 * before being written to the file. Textdumps are small, so do a bit less
319 * work to optimize/sparsify.
322 DoTextdumpFile(int fd, off_t dumpsize, off_t lasthd, char *buf,
323 const char *device, const char *filename, FILE *fp)
326 off_t dmpcnt, totsize;
331 if ((dumpsize % wl) != 0) {
332 syslog(LOG_ERR, "textdump uneven multiple of 512 on %s",
337 while (dumpsize > 0) {
338 nr = pread(fd, buf, wl, lasthd - (totsize - dumpsize) - wl);
342 "WARNING: EOF on dump device");
344 syslog(LOG_ERR, "read error on %s: %m", device);
348 nw = fwrite(buf, 1, wl, fp);
351 "write error on %s file: %m", filename);
353 "WARNING: textdump may be incomplete");
359 printf("%llu\r", (unsigned long long)dmpcnt);
368 DoFile(const char *savedir, const char *device)
370 static char filename[PATH_MAX];
371 static char *buf = NULL;
372 struct kerneldumpheader kdhf, kdhl;
373 off_t mediasize, dumpsize, firsthd, lasthd;
376 int fd, fdinfo, error;
381 bounds = getbounds();
383 status = STATUS_UNKNOWN;
386 buf = malloc(BUFFERSIZE);
388 syslog(LOG_ERR, "%m");
394 printf("checking for kernel dump on device %s\n", device);
396 fd = open(device, O_RDWR);
398 syslog(LOG_ERR, "%s: %m", device);
402 error = ioctl(fd, DIOCGMEDIASIZE, &mediasize);
404 error = ioctl(fd, DIOCGSECTORSIZE, §orsize);
407 "couldn't find media and/or sector size of %s: %m", device);
412 printf("mediasize = %lld\n", (long long)mediasize);
413 printf("sectorsize = %u\n", sectorsize);
416 lasthd = mediasize - sectorsize;
417 lseek(fd, lasthd, SEEK_SET);
418 error = read(fd, &kdhl, sizeof kdhl);
419 if (error != sizeof kdhl) {
421 "error reading last dump header at offset %lld in %s: %m",
422 (long long)lasthd, device);
426 if (strncmp(kdhl.magic, TEXTDUMPMAGIC, sizeof kdhl) == 0) {
428 printf("textdump magic on last dump header on %s\n",
431 if (dtoh32(kdhl.version) != KERNELDUMP_TEXT_VERSION) {
433 "unknown version (%d) in last dump header on %s",
434 dtoh32(kdhl.version), device);
440 } else if (memcmp(kdhl.magic, KERNELDUMPMAGIC, sizeof kdhl.magic) ==
442 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
444 "unknown version (%d) in last dump header on %s",
445 dtoh32(kdhl.version), device);
453 printf("magic mismatch on last dump header on %s\n",
460 if (memcmp(kdhl.magic, KERNELDUMPMAGIC_CLEARED,
461 sizeof kdhl.magic) == 0) {
463 printf("forcing magic on %s\n", device);
464 memcpy(kdhl.magic, KERNELDUMPMAGIC,
467 syslog(LOG_ERR, "unable to force dump - bad magic");
470 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
472 "unknown version (%d) in last dump header on %s",
473 dtoh32(kdhl.version), device);
485 if (kerneldump_parity(&kdhl)) {
487 "parity error on last dump header on %s", device);
493 dumpsize = dtoh64(kdhl.dumplength);
494 firsthd = lasthd - dumpsize - sizeof kdhf;
495 lseek(fd, firsthd, SEEK_SET);
496 error = read(fd, &kdhf, sizeof kdhf);
497 if (error != sizeof kdhf) {
499 "error reading first dump header at offset %lld in %s: %m",
500 (long long)firsthd, device);
506 printf("First dump headers:\n");
507 printheader(stdout, &kdhf, device, bounds, -1);
509 printf("\nLast dump headers:\n");
510 printheader(stdout, &kdhl, device, bounds, -1);
514 if (memcmp(&kdhl, &kdhf, sizeof kdhl)) {
516 "first and last dump headers disagree on %s", device);
522 status = STATUS_GOOD;
526 printf("A dump exists on %s\n", device);
531 if (kdhl.panicstring[0])
532 syslog(LOG_ALERT, "reboot after panic: %s", kdhl.panicstring);
534 syslog(LOG_ALERT, "reboot");
537 printf("Checking for available free space\n");
538 if (!check_space(savedir, dumpsize)) {
543 writebounds(bounds + 1);
545 sprintf(buf, "info.%d", bounds);
548 * Create or overwrite any existing dump header files.
550 fdinfo = open(buf, O_WRONLY | O_CREAT | O_TRUNC, 0600);
552 syslog(LOG_ERR, "%s: %m", buf);
556 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
558 sprintf(filename, "%s.%d.gz", istextdump ? "textdump.tar" :
560 fp = zopen(filename, "w");
562 sprintf(filename, "%s.%d", istextdump ? "textdump.tar" :
564 fp = fopen(filename, "w");
567 syslog(LOG_ERR, "%s: %m", filename);
574 info = fdopen(fdinfo, "w");
577 syslog(LOG_ERR, "fdopen failed: %m");
583 printheader(stdout, &kdhl, device, bounds, status);
585 printheader(info, &kdhl, device, bounds, status);
588 syslog(LOG_NOTICE, "writing %score to %s",
589 compress ? "compressed " : "", filename);
592 if (DoTextdumpFile(fd, dumpsize, lasthd, buf, device,
596 if (DoRegularFile(fd, dumpsize, buf, device, filename, fp)
603 if (fclose(fp) < 0) {
604 syslog(LOG_ERR, "error on %s: %m", filename);
611 printf("dump saved\n");
614 if (clear || !keep) {
616 printf("clearing dump header\n");
617 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof kdhl.magic);
618 lseek(fd, lasthd, SEEK_SET);
619 error = write(fd, &kdhl, sizeof kdhl);
620 if (error != sizeof kdhl)
622 "error while clearing the dump header: %m");
637 fprintf(stderr, "%s\n%s\n%s\n",
638 "usage: savecore -c",
639 " savecore -C [-v] [directory device]",
640 " savecore [-fkvz] [directory [device ...]]");
645 main(int argc, char **argv)
647 const char *savedir = ".";
651 checkfor = compress = clear = force = keep = verbose = 0;
652 nfound = nsaved = nerr = 0;
654 openlog("savecore", LOG_PERROR, LOG_DAEMON);
655 signal(SIGINFO, infohandler);
657 while ((ch = getopt(argc, argv, "Ccfkvz")) != -1)
681 if (checkfor && (clear || force || keep))
686 error = chdir(argv[0]);
688 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
700 if (strcmp(fsp->fs_vfstype, "swap") &&
701 strcmp(fsp->fs_vfstype, "dump"))
703 DoFile(savedir, fsp->fs_spec);
706 for (i = 0; i < argc; i++)
707 DoFile(savedir, argv[i]);
710 /* Emit minimal output. */
713 printf("No dump exists\n");
716 syslog(LOG_WARNING, "no dumps found");
718 else if (nsaved == 0) {
720 syslog(LOG_WARNING, "unsaved dumps found but not saved");
722 syslog(LOG_WARNING, "no unsaved dumps found");
729 infohandler(int sig __unused)