2 * Copyright (c) 2002 Marcel Moolenaar
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/kerneldump.h>
38 #include <machine/elf.h>
39 #include <machine/md_var.h>
41 CTASSERT(sizeof(struct kerneldumpheader) == 512);
44 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
45 * is to protect us from metadata and to protect metadata from us.
47 #define SIZEOF_METADATA (64*1024)
49 #define MD_ALIGN(x) (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
50 #define DEV_ALIGN(x) (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
57 typedef int callback_t(struct md_pa *, int, void *);
59 static struct kerneldumpheader kdh;
60 static off_t dumplo, fileofs;
62 /* Handle buffered writes. */
63 static char buffer[DEV_BSIZE];
66 /* 20 phys_avail entry pairs correspond to 10 md_pa's */
67 static struct md_pa dump_map[10];
74 bzero(dump_map, sizeof(dump_map));
75 for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
77 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
79 dump_map[n].md_start = dump_avail[idx];
80 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
88 return (&dump_map[0]);
92 md_pa_next(struct md_pa *mdp)
96 if (mdp->md_size == 0)
101 /* XXX should be MI */
103 mkdumpheader(struct kerneldumpheader *kdh, uint32_t archver, uint64_t dumplen,
107 bzero(kdh, sizeof(*kdh));
108 strncpy(kdh->magic, KERNELDUMPMAGIC, sizeof(kdh->magic));
109 strncpy(kdh->architecture, MACHINE_ARCH, sizeof(kdh->architecture));
110 kdh->version = htod32(KERNELDUMPVERSION);
111 kdh->architectureversion = htod32(archver);
112 kdh->dumplength = htod64(dumplen);
113 kdh->dumptime = htod64(time_second);
114 kdh->blocksize = htod32(blksz);
115 strncpy(kdh->hostname, hostname, sizeof(kdh->hostname));
116 strncpy(kdh->versionstring, version, sizeof(kdh->versionstring));
117 if (panicstr != NULL)
118 strncpy(kdh->panicstring, panicstr, sizeof(kdh->panicstring));
119 kdh->parity = kerneldump_parity(kdh);
123 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
129 len = DEV_BSIZE - fragsz;
132 bcopy(ptr, buffer + fragsz, len);
136 if (fragsz == DEV_BSIZE) {
137 error = di->dumper(di->priv, buffer, 0, dumplo,
150 buf_flush(struct dumperinfo *di)
157 error = di->dumper(di->priv, buffer, 0, dumplo, DEV_BSIZE);
163 #define PG2MB(pgs) ((pgs + (1 << 8) - 1) >> 8)
166 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
168 struct dumperinfo *di = (struct dumperinfo*)arg;
172 size_t counter, sz, chunk;
173 int i, c, error, twiddle;
175 error = 0; /* catch case in which chunk size is 0 */
176 counter = 0; /* Update twiddle every 16MB */
179 pgs = mdp->md_size / PAGE_SIZE;
182 printf(" chunk %d: %ldMB (%ld pages)", seqnr, PG2MB(pgs), pgs);
186 if (chunk > MAXDUMPPGS)
188 sz = chunk << PAGE_SHIFT;
191 printf(" %ld", PG2MB(pgs));
192 counter &= (1<<24) - 1;
194 for (i = 0; i < chunk; i++) {
195 a = pa + i * PAGE_SIZE;
196 va = pmap_kenter_temporary(trunc_page(a), i);
198 error = di->dumper(di->priv, va, 0, dumplo, sz);
205 /* Check for user abort. */
210 printf(" (CTRL-C to abort) ");
212 printf(" ... %s\n", (error) ? "fail" : "ok");
217 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
219 struct dumperinfo *di = (struct dumperinfo*)arg;
225 bzero(&phdr, sizeof(phdr));
226 phdr.p_type = PT_LOAD;
227 phdr.p_flags = PF_R; /* XXX */
228 phdr.p_offset = fileofs;
229 phdr.p_vaddr = mdp->md_start;
230 phdr.p_paddr = mdp->md_start;
231 phdr.p_filesz = size;
233 phdr.p_align = PAGE_SIZE;
235 error = buf_write(di, (char*)&phdr, sizeof(phdr));
236 fileofs += phdr.p_filesz;
241 cb_size(struct md_pa *mdp, int seqnr, void *arg)
243 uint64_t *sz = (uint64_t*)arg;
245 *sz += (uint64_t)mdp->md_size;
250 foreach_chunk(callback_t cb, void *arg)
257 while (mdp != NULL) {
258 error = (*cb)(mdp, seqnr++, arg);
261 mdp = md_pa_next(mdp);
267 dumpsys(struct dumperinfo *di)
275 bzero(&ehdr, sizeof(ehdr));
276 ehdr.e_ident[EI_MAG0] = ELFMAG0;
277 ehdr.e_ident[EI_MAG1] = ELFMAG1;
278 ehdr.e_ident[EI_MAG2] = ELFMAG2;
279 ehdr.e_ident[EI_MAG3] = ELFMAG3;
280 ehdr.e_ident[EI_CLASS] = ELF_CLASS;
281 #if BYTE_ORDER == LITTLE_ENDIAN
282 ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
284 ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
286 ehdr.e_ident[EI_VERSION] = EV_CURRENT;
287 ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE; /* XXX big picture? */
288 ehdr.e_type = ET_CORE;
289 ehdr.e_machine = EM_X86_64;
290 ehdr.e_phoff = sizeof(ehdr);
292 ehdr.e_ehsize = sizeof(ehdr);
293 ehdr.e_phentsize = sizeof(Elf_Phdr);
294 ehdr.e_shentsize = sizeof(Elf_Shdr);
298 /* Calculate dump size. */
300 ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
301 hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
302 fileofs = MD_ALIGN(hdrsz);
304 hdrgap = fileofs - DEV_ALIGN(hdrsz);
306 /* Determine dump offset on device. */
307 if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
311 dumplo = di->mediaoffset + di->mediasize - dumpsize;
312 dumplo -= sizeof(kdh) * 2;
314 mkdumpheader(&kdh, KERNELDUMP_AMD64_VERSION, dumpsize, di->blocksize);
316 printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
320 error = di->dumper(di->priv, &kdh, 0, dumplo, sizeof(kdh));
323 dumplo += sizeof(kdh);
325 /* Dump ELF header */
326 error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
330 /* Dump program headers */
331 error = foreach_chunk(cb_dumphdr, di);
337 * All headers are written using blocked I/O, so we know the
338 * current offset is (still) block aligned. Skip the alignement
339 * in the file to have the segment contents aligned at page
340 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
341 * care and may very well be unaligned within the dump device.
345 /* Dump memory chunks (updates dumplo) */
346 error = foreach_chunk(cb_dumpdata, di);
351 error = di->dumper(di->priv, &kdh, 0, dumplo, sizeof(kdh));
355 /* Signal completion, signoff and exit stage left. */
356 di->dumper(di->priv, NULL, 0, 0, 0);
357 printf("\nDump complete\n");
364 if (error == ECANCELED)
365 printf("\nDump aborted\n");
366 else if (error == ENOSPC)
367 printf("\nDump failed. Partition too small.\n");
369 printf("\n** DUMP FAILED (ERROR %d) **\n", error);