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 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 #include <sys/cdefs.h>
68 __FBSDID("$FreeBSD$");
70 #include <sys/param.h>
72 #include <sys/kerneldump.h>
73 #include <sys/param.h>
74 #include <sys/mount.h>
88 /* The size of the buffer used for I/O. */
89 #define BUFFERSIZE (1024*1024)
93 #define STATUS_UNKNOWN 2
95 static int checkfor, compress, clear, force, keep, verbose; /* flags */
96 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(FILE *f, const struct kerneldumpheader *h, const char *device,
105 int bounds, const int status)
109 const char *stat_str;
111 fprintf(f, "Dump header from device %s\n", device);
112 fprintf(f, " Architecture: %s\n", h->architecture);
113 fprintf(f, " Architecture Version: %u\n",
114 dtoh32(h->architectureversion));
115 dumplen = dtoh64(h->dumplength);
116 fprintf(f, " Dump Length: %lldB (%lld MB)\n", (long long)dumplen,
117 (long long)(dumplen >> 20));
118 fprintf(f, " Blocksize: %d\n", dtoh32(h->blocksize));
119 t = dtoh64(h->dumptime);
120 fprintf(f, " Dumptime: %s", ctime(&t));
121 fprintf(f, " Hostname: %s\n", h->hostname);
122 fprintf(f, " Magic: %s\n", h->magic);
123 fprintf(f, " Version String: %s", h->versionstring);
124 fprintf(f, " Panic String: %s\n", h->panicstring);
125 fprintf(f, " Dump Parity: %u\n", h->parity);
126 fprintf(f, " Bounds: %d\n", bounds);
136 stat_str = "unknown";
138 fprintf(f, " Dump Status: %s\n", stat_str);
150 if ((fp = fopen("bounds", "r")) == NULL) {
152 printf("unable to open bounds file, using 0\n");
156 if (fgets(buf, sizeof buf, fp) == NULL) {
157 syslog(LOG_WARNING, "unable to read from bounds, using 0");
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");
170 writebounds(int bounds) {
173 if ((fp = fopen("bounds", "w")) == NULL) {
174 syslog(LOG_WARNING, "unable to write to bounds file: %m");
179 printf("bounds number: %d\n", bounds);
181 fprintf(fp, "%d\n", bounds);
186 * Check that sufficient space is available on the disk that holds the
190 check_space(const char *savedir, off_t dumpsize)
193 off_t minfree, spacefree, totfree, needed;
195 char buf[100], path[MAXPATHLEN];
197 if (statfs(savedir, &fsbuf) < 0) {
198 syslog(LOG_ERR, "%s: %m", savedir);
201 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
202 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
204 (void)snprintf(path, sizeof(path), "%s/minfree", savedir);
205 if ((fp = fopen(path, "r")) == NULL)
208 if (fgets(buf, sizeof(buf), fp) == NULL)
215 needed = dumpsize / 1024 + 2; /* 2 for info file */
216 if (((minfree > 0) ? spacefree : totfree) - needed < minfree) {
218 "no dump, not enough free space on device (%lld available, need %lld)",
219 (long long)(minfree > 0 ? spacefree : totfree),
223 if (spacefree - needed < 0)
225 "dump performed, but free space threshold crossed");
229 #define BLOCKSIZE (1<<12)
230 #define BLOCKMASK (~(BLOCKSIZE-1))
233 DoRegularFile(int fd, off_t dumpsize, char *buf, const char *device,
234 const char *filename, FILE *fp)
236 int he, hs, nr, nw, wl;
237 off_t dmpcnt, origsize;
242 while (dumpsize > 0) {
246 nr = read(fd, buf, wl);
250 "WARNING: EOF on dump device");
252 syslog(LOG_ERR, "read error on %s: %m", device);
257 nw = fwrite(buf, 1, wl, fp);
259 for (nw = 0; nw < nr; nw = he) {
260 /* find a contiguous block of zeroes */
261 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
262 for (he = hs; he < nr && buf[he] == 0;
265 /* is the hole long enough to matter? */
266 if (he >= hs + BLOCKSIZE)
270 /* back down to a block boundary */
274 * 1) Don't go beyond the end of the buffer.
275 * 2) If the end of the buffer is less than
276 * BLOCKSIZE bytes away, we're at the end
277 * of the file, so just grab what's left.
279 if (hs + BLOCKSIZE > nr)
283 * At this point, we have a partial ordering:
284 * nw <= hs <= he <= nr
285 * If hs > nw, buf[nw..hs] contains non-zero data.
286 * If he > hs, buf[hs..he] is all zeroes.
289 if (fwrite(buf + nw, hs - nw, 1, fp)
293 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
299 "write error on %s file: %m", filename);
301 "WARNING: vmcore may be incomplete");
307 printf("%llu\r", (unsigned long long)dmpcnt);
312 printf("%s %.1lf%%\n", filename, (100.0 - (100.0 *
313 (double)dumpsize / (double)origsize)));
321 * Specialized version of dump-reading logic for use with textdumps, which
322 * are written backwards from the end of the partition, and must be reversed
323 * before being written to the file. Textdumps are small, so do a bit less
324 * work to optimize/sparsify.
327 DoTextdumpFile(int fd, off_t dumpsize, off_t lasthd, char *buf,
328 const char *device, const char *filename, FILE *fp)
331 off_t dmpcnt, totsize;
336 if ((dumpsize % wl) != 0) {
337 syslog(LOG_ERR, "textdump uneven multiple of 512 on %s",
342 while (dumpsize > 0) {
343 nr = pread(fd, buf, wl, lasthd - (totsize - dumpsize) - wl);
347 "WARNING: EOF on dump device");
349 syslog(LOG_ERR, "read error on %s: %m", device);
353 nw = fwrite(buf, 1, wl, fp);
356 "write error on %s file: %m", filename);
358 "WARNING: textdump may be incomplete");
364 printf("%llu\r", (unsigned long long)dmpcnt);
373 DoFile(const char *savedir, const char *device)
375 static char filename[PATH_MAX];
376 static char *buf = NULL;
377 struct kerneldumpheader kdhf, kdhl;
378 off_t mediasize, dumpsize, firsthd, lasthd;
381 int fd, fdinfo, error;
386 bounds = getbounds();
388 status = STATUS_UNKNOWN;
391 buf = malloc(BUFFERSIZE);
393 syslog(LOG_ERR, "%m");
399 printf("checking for kernel dump on device %s\n", device);
401 fd = open(device, O_RDWR);
403 syslog(LOG_ERR, "%s: %m", device);
407 error = ioctl(fd, DIOCGMEDIASIZE, &mediasize);
409 error = ioctl(fd, DIOCGSECTORSIZE, §orsize);
412 "couldn't find media and/or sector size of %s: %m", device);
417 printf("mediasize = %lld\n", (long long)mediasize);
418 printf("sectorsize = %u\n", sectorsize);
421 lasthd = mediasize - sectorsize;
422 lseek(fd, lasthd, SEEK_SET);
423 error = read(fd, &kdhl, sizeof kdhl);
424 if (error != sizeof kdhl) {
426 "error reading last dump header at offset %lld in %s: %m",
427 (long long)lasthd, device);
431 if (strncmp(kdhl.magic, TEXTDUMPMAGIC, sizeof kdhl) == 0) {
433 printf("textdump magic on last dump header on %s\n",
436 if (dtoh32(kdhl.version) != KERNELDUMP_TEXT_VERSION) {
438 "unknown version (%d) in last dump header on %s",
439 dtoh32(kdhl.version), device);
445 } else if (memcmp(kdhl.magic, KERNELDUMPMAGIC, sizeof kdhl.magic) ==
447 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
449 "unknown version (%d) in last dump header on %s",
450 dtoh32(kdhl.version), device);
458 printf("magic mismatch on last dump header on %s\n",
465 if (memcmp(kdhl.magic, KERNELDUMPMAGIC_CLEARED,
466 sizeof kdhl.magic) == 0) {
468 printf("forcing magic on %s\n", device);
469 memcpy(kdhl.magic, KERNELDUMPMAGIC,
472 syslog(LOG_ERR, "unable to force dump - bad magic");
475 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
477 "unknown version (%d) in last dump header on %s",
478 dtoh32(kdhl.version), device);
490 if (kerneldump_parity(&kdhl)) {
492 "parity error on last dump header on %s", device);
498 dumpsize = dtoh64(kdhl.dumplength);
499 firsthd = lasthd - dumpsize - sizeof kdhf;
500 lseek(fd, firsthd, SEEK_SET);
501 error = read(fd, &kdhf, sizeof kdhf);
502 if (error != sizeof kdhf) {
504 "error reading first dump header at offset %lld in %s: %m",
505 (long long)firsthd, device);
511 printf("First dump headers:\n");
512 printheader(stdout, &kdhf, device, bounds, -1);
514 printf("\nLast dump headers:\n");
515 printheader(stdout, &kdhl, device, bounds, -1);
519 if (memcmp(&kdhl, &kdhf, sizeof kdhl)) {
521 "first and last dump headers disagree on %s", device);
527 status = STATUS_GOOD;
531 printf("A dump exists on %s\n", device);
536 if (kdhl.panicstring[0])
537 syslog(LOG_ALERT, "reboot after panic: %s", kdhl.panicstring);
539 syslog(LOG_ALERT, "reboot");
542 printf("Checking for available free space\n");
543 if (!check_space(savedir, dumpsize)) {
548 writebounds(bounds + 1);
550 sprintf(buf, "info.%d", bounds);
553 * Create or overwrite any existing dump header files.
555 fdinfo = open(buf, O_WRONLY | O_CREAT | O_TRUNC, 0600);
557 syslog(LOG_ERR, "%s: %m", buf);
561 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
563 sprintf(filename, "%s.%d.gz", istextdump ? "textdump.tar" :
565 fp = zopen(filename, "w");
567 sprintf(filename, "%s.%d", istextdump ? "textdump.tar" :
569 fp = fopen(filename, "w");
572 syslog(LOG_ERR, "%s: %m", filename);
579 info = fdopen(fdinfo, "w");
582 syslog(LOG_ERR, "fdopen failed: %m");
588 printheader(stdout, &kdhl, device, bounds, status);
590 printheader(info, &kdhl, device, bounds, status);
593 syslog(LOG_NOTICE, "writing %score to %s",
594 compress ? "compressed " : "", filename);
597 if (DoTextdumpFile(fd, dumpsize, lasthd, buf, device,
601 if (DoRegularFile(fd, dumpsize, buf, device, filename, fp)
608 if (fclose(fp) < 0) {
609 syslog(LOG_ERR, "error on %s: %m", filename);
616 printf("dump saved\n");
619 if (clear || !keep) {
621 printf("clearing dump header\n");
622 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof kdhl.magic);
623 lseek(fd, lasthd, SEEK_SET);
624 error = write(fd, &kdhl, sizeof kdhl);
625 if (error != sizeof kdhl)
627 "error while clearing the dump header: %m");
642 fprintf(stderr, "%s\n%s\n%s\n",
643 "usage: savecore -c",
644 " savecore -C [-v] [directory device]",
645 " savecore [-fkvz] [directory [device ...]]");
650 main(int argc, char **argv)
652 const char *savedir = ".";
656 checkfor = compress = clear = force = keep = verbose = 0;
657 nfound = nsaved = nerr = 0;
659 openlog("savecore", LOG_PERROR, LOG_DAEMON);
660 signal(SIGINFO, infohandler);
662 while ((ch = getopt(argc, argv, "Ccfkvz")) != -1)
686 if (checkfor && (clear || force || keep))
691 error = chdir(argv[0]);
693 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
705 if (strcmp(fsp->fs_vfstype, "swap") &&
706 strcmp(fsp->fs_vfstype, "dump"))
708 DoFile(savedir, fsp->fs_spec);
711 for (i = 0; i < argc; i++)
712 DoFile(savedir, argv[i]);
715 /* Emit minimal output. */
718 printf("No dump exists\n");
721 syslog(LOG_WARNING, "no dumps found");
723 else if (nsaved == 0) {
725 syslog(LOG_WARNING, "unsaved dumps found but not saved");
727 syslog(LOG_WARNING, "no unsaved dumps found");
734 infohandler(int sig __unused)