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. 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/param.h>
64 #include <sys/kerneldump.h>
65 #include <sys/diskslice.h>
66 #include <sys/ioctl.h>
67 #include <sys/mount.h>
81 /* The size of the buffer used for I/O. */
82 #define BUFFERSIZE (1024*1024)
86 #define STATUS_UNKNOWN 2
88 static int checkfor, compress, clear, force, keep, verbose; /* flags */
89 static int nfound, nsaved, nerr; /* statistics */
91 extern FILE *zopen(const char *, const char *);
94 printheader(FILE *f, const struct kerneldumpheader *h, const char *device,
95 int bounds, const int status)
101 fprintf(f, "Dump header from device %s\n", device);
102 fprintf(f, " Architecture: %s\n", h->architecture);
103 fprintf(f, " Architecture Version: %u\n",
104 dtoh32(h->architectureversion));
105 dumplen = dtoh64(h->dumplength);
106 fprintf(f, " Dump Length: %lldB (%lld MB)\n", (long long)dumplen,
107 (long long)(dumplen >> 20));
108 fprintf(f, " Blocksize: %d\n", dtoh32(h->blocksize));
109 t = dtoh64(h->dumptime);
110 fprintf(f, " Dumptime: %s", ctime(&t));
111 fprintf(f, " Hostname: %s\n", h->hostname);
112 fprintf(f, " Magic: %s\n", h->magic);
113 fprintf(f, " Version String: %s", h->versionstring);
114 fprintf(f, " Panic String: %s\n", h->panicstring);
115 fprintf(f, " Dump Parity: %u\n", h->parity);
116 fprintf(f, " Bounds: %d\n", bounds);
126 stat_str = "unknown";
128 fprintf(f, " Dump Status: %s\n", stat_str);
140 if ((fp = fopen("bounds", "r")) == NULL) {
142 printf("unable to open bounds file, using 0\n");
146 if (fgets(buf, sizeof buf, fp) == NULL) {
147 syslog(LOG_WARNING, "unable to read from bounds, using 0");
153 ret = (int)strtol(buf, NULL, 10);
154 if (ret == 0 && (errno == EINVAL || errno == ERANGE))
155 syslog(LOG_WARNING, "invalid value found in bounds, using 0");
161 writebounds(int bounds) {
164 if ((fp = fopen("bounds", "w")) == NULL) {
165 syslog(LOG_WARNING, "unable to write to bounds file: %m");
170 printf("bounds number: %d\n", bounds);
172 fprintf(fp, "%d\n", bounds);
177 * Check that sufficient space is available on the disk that holds the
181 check_space(const char *savedir, off_t dumpsize)
184 off_t minfree, spacefree, totfree, needed;
186 char buf[100], path[MAXPATHLEN];
188 if (statfs(savedir, &fsbuf) < 0) {
189 syslog(LOG_ERR, "%s: %m", savedir);
192 spacefree = ((off_t) fsbuf.f_bavail * fsbuf.f_bsize) / 1024;
193 totfree = ((off_t) fsbuf.f_bfree * fsbuf.f_bsize) / 1024;
195 (void)snprintf(path, sizeof(path), "%s/minfree", savedir);
196 if ((fp = fopen(path, "r")) == NULL)
199 if (fgets(buf, sizeof(buf), fp) == NULL)
206 needed = dumpsize / 1024 + 2; /* 2 for info file */
207 if (((minfree > 0) ? spacefree : totfree) - needed < minfree) {
209 "no dump, not enough free space on device (%lld available, need %lld)",
210 (long long)(minfree > 0 ? spacefree : totfree),
214 if (spacefree - needed < 0)
216 "dump performed, but free space threshold crossed");
220 #define BLOCKSIZE (1<<12)
221 #define BLOCKMASK (~(BLOCKSIZE-1))
224 DoFile(const char *savedir, const char *device)
226 static char *buf = NULL;
227 struct partinfo dpart;
228 struct kerneldumpheader kdhf, kdhl;
229 off_t mediasize, dumpsize, firsthd, lasthd, dmpcnt;
230 FILE *info, *fp, *fpkern;
232 int fd, fdinfo, fdkernin, error, wl;
233 int nr, nw, hs, he = 0;
237 bounds = getbounds();
240 status = STATUS_UNKNOWN;
243 buf = malloc(BUFFERSIZE);
245 syslog(LOG_ERR, "%m");
251 printf("checking for kernel dump on device %s\n", device);
253 fd = open(device, O_RDWR);
255 syslog(LOG_ERR, "%s: %m", device);
259 bzero(&dpart, sizeof(dpart));
260 error = ioctl(fd, DIOCGPART, &dpart);
263 "couldn't find media and/or sector size of %s: %m", device);
266 mediasize = dpart.media_size;
267 sectorsize = dpart.media_blksize;
270 printf("mediasize = %lld\n", (long long)mediasize);
271 printf("sectorsize = %u\n", sectorsize);
274 lasthd = mediasize - sectorsize;
275 lseek(fd, lasthd, SEEK_SET);
276 error = read(fd, &kdhl, sizeof kdhl);
277 if (error != sizeof kdhl) {
279 "error reading last dump header at offset %lld in %s: %m",
280 (long long)lasthd, device);
283 if (memcmp(kdhl.magic, KERNELDUMPMAGIC, sizeof kdhl.magic)) {
285 printf("magic mismatch on last dump header on %s\n",
292 if (memcmp(kdhl.magic, KERNELDUMPMAGIC_CLEARED,
293 sizeof kdhl.magic) == 0) {
295 printf("forcing magic on %s\n", device);
296 memcpy(kdhl.magic, KERNELDUMPMAGIC,
299 syslog(LOG_ERR, "unable to force dump - bad magic");
303 if (dtoh32(kdhl.version) != KERNELDUMPVERSION) {
305 "unknown version (%d) in last dump header on %s",
306 dtoh32(kdhl.version), device);
317 if (kerneldump_parity(&kdhl)) {
319 "parity error on last dump header on %s", device);
325 dumpsize = dtoh64(kdhl.dumplength);
326 firsthd = lasthd - dumpsize - sizeof kdhf;
327 lseek(fd, firsthd, SEEK_SET);
328 error = read(fd, &kdhf, sizeof kdhf);
329 if (error != sizeof kdhf) {
331 "error reading first dump header at offset %lld in %s: %m",
332 (long long)firsthd, device);
338 printf("First dump headers:\n");
339 printheader(stdout, &kdhf, device, bounds, -1);
341 printf("\nLast dump headers:\n");
342 printheader(stdout, &kdhl, device, bounds, -1);
346 if (memcmp(&kdhl, &kdhf, sizeof kdhl)) {
348 "first and last dump headers disagree on %s", device);
354 status = STATUS_GOOD;
358 printf("A dump exists on %s\n", device);
363 if (kdhl.panicstring[0])
364 syslog(LOG_ALERT, "reboot after panic: %s", kdhl.panicstring);
366 syslog(LOG_ALERT, "reboot");
369 printf("Checking for available free space\n");
370 if (!check_space(savedir, dumpsize)) {
375 writebounds(bounds + 1);
380 fdkernin = open(getbootfile(), O_RDONLY, 0);
382 syslog(LOG_ERR, "%s: %m", getbootfile());
386 sprintf(buf, "kern.%d.gz", bounds);
387 fpkern = zopen(buf, "w");
389 sprintf(buf, "kern.%d", bounds);
390 fpkern = fopen(buf, "w");
392 if (fpkern == NULL) {
393 syslog(LOG_ERR, "%s: %m", buf);
397 syslog(LOG_NOTICE, "writing %skernel to %s",
398 compress ? "compressed " : "", buf);
400 while ((nr = read(fdkernin, buf, BUFFERSIZE)) > 0) {
401 nw = fwrite(buf, 1, nr, fpkern);
403 syslog(LOG_ERR, "kern.%d: %m", bounds);
405 "WARNING: kernel may be incomplete");
410 syslog(LOG_ERR, "%s: %m", getbootfile());
412 "WARNING: kernel may be incomplete");
419 sprintf(buf, "info.%d", bounds);
422 * Create or overwrite any existing dump header files.
424 fdinfo = open(buf, O_WRONLY | O_CREAT | O_TRUNC, 0600);
426 syslog(LOG_ERR, "%s: %m", buf);
430 oumask = umask(S_IRWXG|S_IRWXO); /* Restrict access to the core file.*/
432 sprintf(buf, "vmcore.%d.gz", bounds);
433 fp = zopen(buf, "w");
435 sprintf(buf, "vmcore.%d", bounds);
436 fp = fopen(buf, "w");
439 syslog(LOG_ERR, "%s: %m", buf);
446 info = fdopen(fdinfo, "w");
449 syslog(LOG_ERR, "fdopen failed: %m");
455 printheader(stdout, &kdhl, device, bounds, status);
457 printheader(info, &kdhl, device, bounds, status);
460 syslog(LOG_NOTICE, "writing %score to %s",
461 compress ? "compressed " : "", buf);
463 while (dumpsize > 0) {
467 nr = read(fd, buf, wl);
471 "WARNING: EOF on dump device");
473 syslog(LOG_ERR, "read error on %s: %m", device);
478 nw = fwrite(buf, 1, wl, fp);
480 for (nw = 0; nw < nr; nw = he) {
481 /* find a contiguous block of zeroes */
482 for (hs = nw; hs < nr; hs += BLOCKSIZE) {
483 for (he = hs; he < nr && buf[he] == 0;
486 /* is the hole long enough to matter? */
487 if (he >= hs + BLOCKSIZE)
491 /* back down to a block boundary */
495 * 1) Don't go beyond the end of the buffer.
496 * 2) If the end of the buffer is less than
497 * BLOCKSIZE bytes away, we're at the end
498 * of the file, so just grab what's left.
500 if (hs + BLOCKSIZE > nr)
504 * At this point, we have a partial ordering:
505 * nw <= hs <= he <= nr
506 * If hs > nw, buf[nw..hs] contains non-zero data.
507 * If he > hs, buf[hs..he] is all zeroes.
510 if (fwrite(buf + nw, hs - nw, 1, fp)
514 if (fseeko(fp, he - hs, SEEK_CUR) == -1)
520 "write error on vmcore.%d file: %m", bounds);
522 "WARNING: vmcore may be incomplete");
528 printf("%llu\r", (unsigned long long)dmpcnt);
536 if (fclose(fp) < 0) {
537 syslog(LOG_ERR, "error on vmcore.%d: %m", bounds);
544 printf("dump saved\n");
547 if (clear || !keep) {
549 printf("clearing dump header\n");
550 memcpy(kdhl.magic, KERNELDUMPMAGIC_CLEARED, sizeof kdhl.magic);
551 lseek(fd, lasthd, SEEK_SET);
552 error = write(fd, &kdhl, sizeof kdhl);
553 if (error != sizeof kdhl)
555 "error while clearing the dump header: %m");
570 fprintf(stderr, "%s\n%s\n%s\n",
571 "usage: savecore -c",
572 " savecore -C [-v] [directory device]",
573 " savecore [-fkvz] [directory [device ...]]");
578 main(int argc, char **argv)
580 const char *savedir = ".";
584 checkfor = compress = clear = force = keep = verbose = 0;
585 nfound = nsaved = nerr = 0;
587 openlog("savecore", LOG_PERROR, LOG_DAEMON);
589 while ((ch = getopt(argc, argv, "Ccfkvz")) != -1)
613 if (checkfor && (clear || force || keep))
618 error = chdir(argv[0]);
620 syslog(LOG_ERR, "chdir(%s): %m", argv[0]);
632 if (strcmp(fsp->fs_vfstype, "swap") &&
633 strcmp(fsp->fs_vfstype, "dump"))
635 DoFile(savedir, fsp->fs_spec);
638 for (i = 0; i < argc; i++)
639 DoFile(savedir, argv[i]);
642 /* Emit minimal output. */
645 printf("No dump exists\n");
648 syslog(LOG_WARNING, "no dumps found");
650 else if (nsaved == 0) {
652 syslog(LOG_WARNING, "unsaved dumps found but not saved");
654 syslog(LOG_WARNING, "no unsaved dumps found");