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");
160 writebounds(int bounds
) {
163 if ((fp
= fopen("bounds", "w")) == NULL
) {
164 syslog(LOG_WARNING
, "unable to write to bounds file: %m");
169 printf("bounds number: %d\n", bounds
);
171 fprintf(fp
, "%d\n", bounds
);
176 * Check that sufficient space is available on the disk that holds the
180 check_space(const char *savedir
, off_t dumpsize
)
183 off_t minfree
, spacefree
, totfree
, needed
;
185 char buf
[100], path
[MAXPATHLEN
];
187 if (statfs(savedir
, &fsbuf
) < 0) {
188 syslog(LOG_ERR
, "%s: %m", savedir
);
191 spacefree
= ((off_t
) fsbuf
.f_bavail
* fsbuf
.f_bsize
) / 1024;
192 totfree
= ((off_t
) fsbuf
.f_bfree
* fsbuf
.f_bsize
) / 1024;
194 (void)snprintf(path
, sizeof(path
), "%s/minfree", savedir
);
195 if ((fp
= fopen(path
, "r")) == NULL
)
198 if (fgets(buf
, sizeof(buf
), fp
) == NULL
)
205 needed
= dumpsize
/ 1024 + 2; /* 2 for info file */
206 if (((minfree
> 0) ? spacefree
: totfree
) - needed
< minfree
) {
208 "no dump, not enough free space on device (%lld available, need %lld)",
209 (long long)(minfree
> 0 ? spacefree
: totfree
),
213 if (spacefree
- needed
< 0)
215 "dump performed, but free space threshold crossed");
219 #define BLOCKSIZE (1<<12)
220 #define BLOCKMASK (~(BLOCKSIZE-1))
223 DoFile(const char *savedir
, const char *device
)
225 static char *buf
= NULL
;
226 struct partinfo dpart
;
227 struct kerneldumpheader kdhf
, kdhl
;
228 off_t mediasize
, dumpsize
, firsthd
, lasthd
, dmpcnt
;
229 FILE *info
, *fp
, *fpkern
;
231 int fd
, fdinfo
, fdkernin
, error
, wl
;
232 int nr
, nw
, hs
, he
= 0;
236 bounds
= getbounds();
239 status
= STATUS_UNKNOWN
;
242 buf
= malloc(BUFFERSIZE
);
244 syslog(LOG_ERR
, "%m");
250 printf("checking for kernel dump on device %s\n", device
);
252 fd
= open(device
, O_RDWR
);
254 syslog(LOG_ERR
, "%s: %m", device
);
258 bzero(&dpart
, sizeof(dpart
));
259 error
= ioctl(fd
, DIOCGPART
, &dpart
);
262 "couldn't find media and/or sector size of %s: %m", device
);
265 mediasize
= dpart
.media_size
;
266 sectorsize
= dpart
.media_blksize
;
269 printf("mediasize = %lld\n", (long long)mediasize
);
270 printf("sectorsize = %u\n", sectorsize
);
273 lasthd
= mediasize
- sectorsize
;
274 lseek(fd
, lasthd
, SEEK_SET
);
275 error
= read(fd
, &kdhl
, sizeof kdhl
);
276 if (error
!= sizeof kdhl
) {
278 "error reading last dump header at offset %lld in %s: %m",
279 (long long)lasthd
, device
);
282 if (memcmp(kdhl
.magic
, KERNELDUMPMAGIC
, sizeof kdhl
.magic
)) {
284 printf("magic mismatch on last dump header on %s\n",
291 if (memcmp(kdhl
.magic
, KERNELDUMPMAGIC_CLEARED
,
292 sizeof kdhl
.magic
) == 0) {
294 printf("forcing magic on %s\n", device
);
295 memcpy(kdhl
.magic
, KERNELDUMPMAGIC
,
298 syslog(LOG_ERR
, "unable to force dump - bad magic");
302 if (dtoh32(kdhl
.version
) != KERNELDUMPVERSION
) {
304 "unknown version (%d) in last dump header on %s",
305 dtoh32(kdhl
.version
), device
);
316 if (kerneldump_parity(&kdhl
)) {
318 "parity error on last dump header on %s", device
);
324 dumpsize
= dtoh64(kdhl
.dumplength
);
325 firsthd
= lasthd
- dumpsize
- sizeof kdhf
;
326 lseek(fd
, firsthd
, SEEK_SET
);
327 error
= read(fd
, &kdhf
, sizeof kdhf
);
328 if (error
!= sizeof kdhf
) {
330 "error reading first dump header at offset %lld in %s: %m",
331 (long long)firsthd
, device
);
337 printf("First dump headers:\n");
338 printheader(stdout
, &kdhf
, device
, bounds
, -1);
340 printf("\nLast dump headers:\n");
341 printheader(stdout
, &kdhl
, device
, bounds
, -1);
345 if (memcmp(&kdhl
, &kdhf
, sizeof kdhl
)) {
347 "first and last dump headers disagree on %s", device
);
353 status
= STATUS_GOOD
;
357 printf("A dump exists on %s\n", device
);
362 if (kdhl
.panicstring
[0])
363 syslog(LOG_ALERT
, "reboot after panic: %s", kdhl
.panicstring
);
365 syslog(LOG_ALERT
, "reboot");
368 printf("Checking for available free space\n");
369 if (!check_space(savedir
, dumpsize
)) {
374 writebounds(bounds
+ 1);
379 fdkernin
= open(getbootfile(), O_RDONLY
, 0);
381 syslog(LOG_ERR
, "%s: %m", getbootfile());
385 sprintf(buf
, "kern.%d.gz", bounds
);
386 fpkern
= zopen(buf
, "w");
388 sprintf(buf
, "kern.%d", bounds
);
389 fpkern
= fopen(buf
, "w");
391 if (fpkern
== NULL
) {
392 syslog(LOG_ERR
, "%s: %m", buf
);
396 syslog(LOG_NOTICE
, "writing %skernel to %s",
397 compress
? "compressed " : "", buf
);
399 while ((nr
= read(fdkernin
, buf
, BUFFERSIZE
)) > 0) {
400 nw
= fwrite(buf
, 1, nr
, fpkern
);
402 syslog(LOG_ERR
, "kern.%d: %m", bounds
);
404 "WARNING: kernel may be incomplete");
409 syslog(LOG_ERR
, "%s: %m", getbootfile());
411 "WARNING: kernel may be incomplete");
418 sprintf(buf
, "info.%d", bounds
);
421 * Create or overwrite any existing dump header files.
423 fdinfo
= open(buf
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
425 syslog(LOG_ERR
, "%s: %m", buf
);
429 oumask
= umask(S_IRWXG
|S_IRWXO
); /* Restrict access to the core file.*/
431 sprintf(buf
, "vmcore.%d.gz", bounds
);
432 fp
= zopen(buf
, "w");
434 sprintf(buf
, "vmcore.%d", bounds
);
435 fp
= fopen(buf
, "w");
438 syslog(LOG_ERR
, "%s: %m", buf
);
445 info
= fdopen(fdinfo
, "w");
448 syslog(LOG_ERR
, "fdopen failed: %m");
454 printheader(stdout
, &kdhl
, device
, bounds
, status
);
456 printheader(info
, &kdhl
, device
, bounds
, status
);
459 syslog(LOG_NOTICE
, "writing %score to %s",
460 compress
? "compressed " : "", buf
);
462 while (dumpsize
> 0) {
466 nr
= read(fd
, buf
, wl
);
470 "WARNING: EOF on dump device");
472 syslog(LOG_ERR
, "read error on %s: %m", device
);
477 nw
= fwrite(buf
, 1, wl
, fp
);
479 for (nw
= 0; nw
< nr
; nw
= he
) {
480 /* find a contiguous block of zeroes */
481 for (hs
= nw
; hs
< nr
; hs
+= BLOCKSIZE
) {
482 for (he
= hs
; he
< nr
&& buf
[he
] == 0;
485 /* is the hole long enough to matter? */
486 if (he
>= hs
+ BLOCKSIZE
)
490 /* back down to a block boundary */
494 * 1) Don't go beyond the end of the buffer.
495 * 2) If the end of the buffer is less than
496 * BLOCKSIZE bytes away, we're at the end
497 * of the file, so just grab what's left.
499 if (hs
+ BLOCKSIZE
> nr
)
503 * At this point, we have a partial ordering:
504 * nw <= hs <= he <= nr
505 * If hs > nw, buf[nw..hs] contains non-zero data.
506 * If he > hs, buf[hs..he] is all zeroes.
509 if (fwrite(buf
+ nw
, hs
- nw
, 1, fp
)
513 if (fseeko(fp
, he
- hs
, SEEK_CUR
) == -1)
519 "write error on vmcore.%d file: %m", bounds
);
521 "WARNING: vmcore may be incomplete");
527 printf("%llu\r", (unsigned long long)dmpcnt
);
535 if (fclose(fp
) < 0) {
536 syslog(LOG_ERR
, "error on vmcore.%d: %m", bounds
);
543 printf("dump saved\n");
546 if (clear
|| !keep
) {
548 printf("clearing dump header\n");
549 memcpy(kdhl
.magic
, KERNELDUMPMAGIC_CLEARED
, sizeof kdhl
.magic
);
550 lseek(fd
, lasthd
, SEEK_SET
);
551 error
= write(fd
, &kdhl
, sizeof kdhl
);
552 if (error
!= sizeof kdhl
)
554 "error while clearing the dump header: %m");
569 fprintf(stderr
, "%s\n%s\n%s\n",
570 "usage: savecore -c",
571 " savecore -C [-v] [directory device]",
572 " savecore [-fkvz] [directory [device ...]]");
577 main(int argc
, char **argv
)
579 const char *savedir
= ".";
583 checkfor
= compress
= clear
= force
= keep
= verbose
= 0;
584 nfound
= nsaved
= nerr
= 0;
586 openlog("savecore", LOG_PERROR
, LOG_DAEMON
);
588 while ((ch
= getopt(argc
, argv
, "Ccfkvz")) != -1)
612 if (checkfor
&& (clear
|| force
|| keep
))
617 error
= chdir(argv
[0]);
619 syslog(LOG_ERR
, "chdir(%s): %m", argv
[0]);
631 if (strcmp(fsp
->fs_vfstype
, "swap") &&
632 strcmp(fsp
->fs_vfstype
, "dump"))
634 DoFile(savedir
, fsp
->fs_spec
);
637 for (i
= 0; i
< argc
; i
++)
638 DoFile(savedir
, argv
[i
]);
641 /* Emit minimal output. */
644 printf("No dump exists\n");
647 syslog(LOG_WARNING
, "no dumps found");
649 else if (nsaved
== 0) {
651 syslog(LOG_WARNING
, "unsaved dumps found but not saved");
653 syslog(LOG_WARNING
, "no unsaved dumps found");