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.
26 * $FreeBSD: src/sys/amd64/amd64/dump_machdep.c,v 1.18 2009/05/29 21:27:12 jamie Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
33 #include <sys/sysctl.h>
34 #include <sys/device.h>
35 #include <sys/kernel.h>
36 #include <sys/kerneldump.h>
39 #include <machine/elf.h>
40 #include <machine/md_var.h>
41 #include <machine/thread.h>
42 #include <sys/thread2.h>
44 CTASSERT(sizeof(struct kerneldumpheader
) == 512);
47 TUNABLE_INT("debug.minidump", &do_minidump
);
48 SYSCTL_INT(_debug
, OID_AUTO
, minidump
, CTLFLAG_RW
, &do_minidump
, 0,
49 "Enable mini crash dumps");
52 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
53 * is to protect us from metadata and to protect metadata from us.
55 #define SIZEOF_METADATA (64*1024)
57 #define MD_ALIGN(x) (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
58 #define DEV_ALIGN(x) (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
65 typedef int callback_t(struct md_pa
*, int, void *);
67 static struct kerneldumpheader kdh
;
68 static off_t dumplo
, fileofs
;
70 /* Handle buffered writes. */
71 static char buffer
[DEV_BSIZE
];
74 /* 20 phys_avail entry pairs correspond to 10 md_pa's */
75 static struct md_pa dump_map
[10];
82 bzero(dump_map
, sizeof(dump_map
));
83 for (n
= 0; n
< sizeof(dump_map
) / sizeof(dump_map
[0]); n
++) {
85 if (dump_avail
[idx
] == 0 && dump_avail
[idx
+ 1] == 0)
87 dump_map
[n
].md_start
= dump_avail
[idx
];
88 dump_map
[n
].md_size
= dump_avail
[idx
+ 1] - dump_avail
[idx
];
96 return (&dump_map
[0]);
100 md_pa_next(struct md_pa
*mdp
)
104 if (mdp
->md_size
== 0)
110 buf_write(struct dumperinfo
*di
, char *ptr
, size_t sz
)
116 len
= DEV_BSIZE
- fragsz
;
119 bcopy(ptr
, buffer
+ fragsz
, len
);
123 if (fragsz
== DEV_BSIZE
) {
124 error
= dev_ddump(di
->priv
, buffer
, 0, dumplo
,
137 buf_flush(struct dumperinfo
*di
)
144 error
= dev_ddump(di
->priv
, buffer
, 0, dumplo
, DEV_BSIZE
);
150 #define PG2MB(pgs) ((pgs + (1 << 8) - 1) >> 8)
153 cb_dumpdata(struct md_pa
*mdp
, int seqnr
, void *arg
)
155 struct dumperinfo
*di
= (struct dumperinfo
*)arg
;
159 size_t counter
, sz
, chunk
;
160 int i
, c
, error
, twiddle
;
162 error
= 0; /* catch case in which chunk size is 0 */
163 counter
= 0; /* Update twiddle every 16MB */
166 pgs
= mdp
->md_size
/ PAGE_SIZE
;
169 kprintf(" chunk %d: %ldMB (%ld pages)", seqnr
, PG2MB(pgs
), pgs
);
173 if (chunk
> MAXDUMPPGS
)
175 sz
= chunk
<< PAGE_SHIFT
;
178 kprintf(" %ld", PG2MB(pgs
));
179 counter
&= (1<<24) - 1;
181 for (i
= 0; i
< chunk
; i
++) {
182 a
= pa
+ i
* PAGE_SIZE
;
183 va
= pmap_kenter_temporary(trunc_page(a
), i
);
185 error
= dev_ddump(di
->priv
, va
, 0, dumplo
, sz
);
192 /* Check for user abort. */
197 kprintf(" (CTRL-C to abort) ");
199 kprintf(" ... %s\n", (error
) ? "fail" : "ok");
204 cb_dumphdr(struct md_pa
*mdp
, int seqnr
, void *arg
)
206 struct dumperinfo
*di
= (struct dumperinfo
*)arg
;
212 bzero(&phdr
, sizeof(phdr
));
213 phdr
.p_type
= PT_LOAD
;
214 phdr
.p_flags
= PF_R
; /* XXX */
215 phdr
.p_offset
= fileofs
;
216 phdr
.p_vaddr
= mdp
->md_start
;
217 phdr
.p_paddr
= mdp
->md_start
;
218 phdr
.p_filesz
= size
;
220 phdr
.p_align
= PAGE_SIZE
;
222 error
= buf_write(di
, (char*)&phdr
, sizeof(phdr
));
223 fileofs
+= phdr
.p_filesz
;
228 cb_size(struct md_pa
*mdp
, int seqnr
, void *arg
)
230 uint64_t *sz
= (uint64_t*)arg
;
232 *sz
+= (uint64_t)mdp
->md_size
;
237 foreach_chunk(callback_t cb
, void *arg
)
244 while (mdp
!= NULL
) {
245 error
= (*cb
)(mdp
, seqnr
++, arg
);
248 mdp
= md_pa_next(mdp
);
254 dumpsys(struct dumperinfo
*di
)
263 dumpthread
= curthread
;
269 bzero(&ehdr
, sizeof(ehdr
));
270 ehdr
.e_ident
[EI_MAG0
] = ELFMAG0
;
271 ehdr
.e_ident
[EI_MAG1
] = ELFMAG1
;
272 ehdr
.e_ident
[EI_MAG2
] = ELFMAG2
;
273 ehdr
.e_ident
[EI_MAG3
] = ELFMAG3
;
274 ehdr
.e_ident
[EI_CLASS
] = ELF_CLASS
;
275 #if BYTE_ORDER == LITTLE_ENDIAN
276 ehdr
.e_ident
[EI_DATA
] = ELFDATA2LSB
;
278 ehdr
.e_ident
[EI_DATA
] = ELFDATA2MSB
;
280 ehdr
.e_ident
[EI_VERSION
] = EV_CURRENT
;
281 ehdr
.e_ident
[EI_OSABI
] = ELFOSABI_STANDALONE
; /* XXX big picture? */
282 ehdr
.e_type
= ET_CORE
;
283 ehdr
.e_machine
= EM_X86_64
;
284 ehdr
.e_phoff
= sizeof(ehdr
);
286 ehdr
.e_ehsize
= sizeof(ehdr
);
287 ehdr
.e_phentsize
= sizeof(Elf_Phdr
);
288 ehdr
.e_shentsize
= sizeof(Elf_Shdr
);
292 /* Calculate dump size. */
294 ehdr
.e_phnum
= foreach_chunk(cb_size
, &dumpsize
);
295 hdrsz
= ehdr
.e_phoff
+ ehdr
.e_phnum
* ehdr
.e_phentsize
;
296 fileofs
= MD_ALIGN(hdrsz
);
298 hdrgap
= fileofs
- DEV_ALIGN(hdrsz
);
300 /* Determine dump offset on device. */
301 if (di
->mediasize
< SIZEOF_METADATA
+ dumpsize
+ sizeof(kdh
) * 2) {
305 dumplo
= di
->mediaoffset
+ di
->mediasize
- dumpsize
;
306 dumplo
-= sizeof(kdh
) * 2;
308 mkdumpheader(&kdh
, KERNELDUMPMAGIC
, KERNELDUMP_AMD64_VERSION
,
309 dumpsize
, di
->blocksize
);
311 kprintf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize
>> 20,
315 error
= dev_ddump(di
->priv
, &kdh
, 0, dumplo
, sizeof(kdh
));
318 dumplo
+= sizeof(kdh
);
320 /* Dump ELF header */
321 error
= buf_write(di
, (char*)&ehdr
, sizeof(ehdr
));
325 /* Dump program headers */
326 error
= foreach_chunk(cb_dumphdr
, di
);
332 * All headers are written using blocked I/O, so we know the
333 * current offset is (still) block aligned. Skip the alignement
334 * in the file to have the segment contents aligned at page
335 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
336 * care and may very well be unaligned within the dump device.
340 /* Dump memory chunks (updates dumplo) */
341 error
= foreach_chunk(cb_dumpdata
, di
);
346 error
= dev_ddump(di
->priv
, &kdh
, 0, dumplo
, sizeof(kdh
));
350 /* Signal completion, signoff and exit stage left. */
351 dev_ddump(di
->priv
, NULL
, 0, 0, 0);
352 kprintf("\nDump complete\n");
359 if (error
== ECANCELED
)
360 kprintf("\nDump aborted\n");
361 else if (error
== ENOSPC
)
362 kprintf("\nDump failed. Partition too small.\n");
364 kprintf("\n** DUMP FAILED (ERROR %d) **\n", error
);