Remove inclusion of <sys/cdefs.h> from kernel .c files.
[dragonfly.git] / sys / platform / pc32 / i386 / dump_machdep.c
1 /*-
2  * Copyright (c) 2002 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
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.
14  *
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.
25  *
26  * $FreeBSD: src/sys/i386/i386/dump_machdep.c,v 1.20 2009/12/10 03:09:35 kmacy Exp $
27  */
28
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/conf.h>
32 #include <sys/cons.h>
33 #include <sys/sysctl.h>
34 #include <sys/device.h>
35 #include <sys/kernel.h>
36 #include <sys/kerneldump.h>
37 #include <vm/vm.h>
38 #include <vm/pmap.h>
39 #include <machine/elf.h>
40 #include <machine/md_var.h>
41 #include <machine/thread.h>
42 #include <sys/thread2.h>
43
44 CTASSERT(sizeof(struct kerneldumpheader) == 512);
45
46 int do_minidump = 1;
47 TUNABLE_INT("debug.minidump", &do_minidump);
48 SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
49     "Enable mini crash dumps");
50
51
52 /*
53  * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
54  * is to protect us from metadata and to protect metadata from us.
55  */
56 #define SIZEOF_METADATA         (64*1024)
57
58 #define MD_ALIGN(x)     (((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
59 #define DEV_ALIGN(x)    (((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
60
61 struct md_pa {
62         vm_paddr_t md_start;
63         vm_paddr_t md_size;
64 };
65
66 typedef int callback_t(struct md_pa *, int, void *);
67
68 static struct kerneldumpheader kdh;
69 static off_t dumplo, fileofs;
70
71 /* Handle buffered writes. */
72 static char buffer[DEV_BSIZE];
73 static size_t fragsz;
74
75 /* 20 phys_avail entry pairs correspond to 10 md_pa's */
76 static struct md_pa dump_map[10];
77
78 static void
79 md_pa_init(void)
80 {
81         int n, idx;
82
83         bzero(dump_map, sizeof(dump_map));
84         for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
85                 idx = n * 2;
86                 if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
87                         break;
88                 dump_map[n].md_start = dump_avail[idx];
89                 dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
90         }
91 }
92
93 static struct md_pa *
94 md_pa_first(void)
95 {
96
97         return (&dump_map[0]);
98 }
99
100 static struct md_pa *
101 md_pa_next(struct md_pa *mdp)
102 {
103
104         mdp++;
105         if (mdp->md_size == 0)
106                 mdp = NULL;
107         return (mdp);
108 }
109
110 static int
111 buf_write(struct dumperinfo *di, char *ptr, size_t sz)
112 {
113         size_t len;
114         int error;
115
116         while (sz) {
117                 len = DEV_BSIZE - fragsz;
118                 if (len > sz)
119                         len = sz;
120                 bcopy(ptr, buffer + fragsz, len);
121                 fragsz += len;
122                 ptr += len;
123                 sz -= len;
124                 if (fragsz == DEV_BSIZE) {
125                         error = dev_ddump(di->priv, buffer, 0, dumplo,
126                             DEV_BSIZE);
127                         if (error)
128                                 return error;
129                         dumplo += DEV_BSIZE;
130                         fragsz = 0;
131                 }
132         }
133
134         return (0);
135 }
136
137 static int
138 buf_flush(struct dumperinfo *di)
139 {
140         int error;
141
142         if (fragsz == 0)
143                 return (0);
144
145         error = dev_ddump(di->priv, buffer, 0, dumplo, DEV_BSIZE);
146         dumplo += DEV_BSIZE;
147         fragsz = 0;
148         return (error);
149 }
150
151 #define PG2MB(pgs) ((pgs + (1 << 8) - 1) >> 8)
152
153 static int
154 cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
155 {
156         struct dumperinfo *di = (struct dumperinfo*)arg;
157         vm_paddr_t a, pa;
158         void *va;
159         uint64_t pgs;
160         size_t counter, sz, chunk;
161         int i, c, error, twiddle;
162
163         error = 0;      /* catch case in which chunk size is 0 */
164         counter = 0;    /* Update twiddle every 16MB */
165         twiddle = 0;
166         va = 0;
167         pgs = mdp->md_size / PAGE_SIZE;
168         pa = mdp->md_start;
169
170         kprintf("  chunk %d: %lldMB (%lld pages)", seqnr, PG2MB(pgs), pgs);
171
172         while (pgs) {
173                 chunk = pgs;
174                 if (chunk > MAXDUMPPGS)
175                         chunk = MAXDUMPPGS;
176                 sz = chunk << PAGE_SHIFT;
177                 counter += sz;
178                 if (counter >> 24) {
179                         kprintf(" %lld", PG2MB(pgs));
180                         counter &= (1<<24) - 1;
181                 }
182                 for (i = 0; i < chunk; i++) {
183                         a = pa + i * PAGE_SIZE;
184                         va = pmap_kenter_temporary(trunc_page(a), i);
185                 }
186                 error = dev_ddump(di->priv, va, 0, dumplo, sz);
187                 if (error)
188                         break;
189                 dumplo += sz;
190                 pgs -= chunk;
191                 pa += sz;
192
193                 /* Check for user abort. */
194                 c = cncheckc();
195                 if (c == 0x03)
196                         return (ECANCELED);
197                 if (c != -1)
198                         kprintf(" (CTRL-C to abort) ");
199         }
200         kprintf(" ... %s\n", (error) ? "fail" : "ok");
201         return (error);
202 }
203
204 static int
205 cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
206 {
207         struct dumperinfo *di = (struct dumperinfo*)arg;
208         Elf_Phdr phdr;
209         uint64_t size;
210         int error;
211
212         size = mdp->md_size;
213         bzero(&phdr, sizeof(phdr));
214         phdr.p_type = PT_LOAD;
215         phdr.p_flags = PF_R;                    /* XXX */
216         phdr.p_offset = fileofs;
217         phdr.p_vaddr = mdp->md_start;
218         phdr.p_paddr = mdp->md_start;
219         phdr.p_filesz = size;
220         phdr.p_memsz = size;
221         phdr.p_align = PAGE_SIZE;
222
223         error = buf_write(di, (char*)&phdr, sizeof(phdr));
224         fileofs += phdr.p_filesz;
225         return (error);
226 }
227
228 static int
229 cb_size(struct md_pa *mdp, int seqnr, void *arg)
230 {
231         uint64_t *sz = (uint64_t*)arg;
232
233         *sz += (uint64_t)mdp->md_size;
234         return (0);
235 }
236
237 static int
238 foreach_chunk(callback_t cb, void *arg)
239 {
240         struct md_pa *mdp;
241         int error, seqnr;
242
243         seqnr = 0;
244         mdp = md_pa_first();
245         while (mdp != NULL) {
246                 error = (*cb)(mdp, seqnr++, arg);
247                 if (error)
248                         return (-error);
249                 mdp = md_pa_next(mdp);
250         }
251         return (seqnr);
252 }
253
254 void
255 dumpsys(struct dumperinfo *di)
256 {
257         Elf_Ehdr ehdr;
258         uint64_t dumpsize;
259         off_t hdrgap;
260         size_t hdrsz;
261         int error;
262
263         savectx(&dumppcb);
264         dumpthread = curthread;
265
266         if (do_minidump) {
267                 minidumpsys(di);
268                 return;
269         }
270
271         bzero(&ehdr, sizeof(ehdr));
272         ehdr.e_ident[EI_MAG0] = ELFMAG0;
273         ehdr.e_ident[EI_MAG1] = ELFMAG1;
274         ehdr.e_ident[EI_MAG2] = ELFMAG2;
275         ehdr.e_ident[EI_MAG3] = ELFMAG3;
276         ehdr.e_ident[EI_CLASS] = ELF_CLASS;
277 #if BYTE_ORDER == LITTLE_ENDIAN
278         ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
279 #else
280         ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
281 #endif
282         ehdr.e_ident[EI_VERSION] = EV_CURRENT;
283         ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;   /* XXX big picture? */
284         ehdr.e_type = ET_CORE;
285         ehdr.e_machine = EM_386;
286         ehdr.e_phoff = sizeof(ehdr);
287         ehdr.e_flags = 0;
288         ehdr.e_ehsize = sizeof(ehdr);
289         ehdr.e_phentsize = sizeof(Elf_Phdr);
290         ehdr.e_shentsize = sizeof(Elf_Shdr);
291
292         md_pa_init();
293
294         /* Calculate dump size. */
295         dumpsize = 0L;
296         ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
297         hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
298         fileofs = MD_ALIGN(hdrsz);
299         dumpsize += fileofs;
300         hdrgap = fileofs - DEV_ALIGN(hdrsz);
301
302         /* Determine dump offset on device. */
303         if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
304                 error = ENOSPC;
305                 goto fail;
306         }
307         dumplo = di->mediaoffset + di->mediasize - dumpsize;
308         dumplo -= sizeof(kdh) * 2;
309
310         mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_I386_VERSION,
311             dumpsize, di->blocksize);
312
313         kprintf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
314             ehdr.e_phnum);
315
316         /* Dump leader */
317         error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
318         if (error)
319                 goto fail;
320         dumplo += sizeof(kdh);
321
322         /* Dump ELF header */
323         error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
324         if (error)
325                 goto fail;
326
327         /* Dump program headers */
328         error = foreach_chunk(cb_dumphdr, di);
329         if (error < 0)
330                 goto fail;
331         buf_flush(di);
332
333         /*
334          * All headers are written using blocked I/O, so we know the
335          * current offset is (still) block aligned. Skip the alignement
336          * in the file to have the segment contents aligned at page
337          * boundary. We cannot use MD_ALIGN on dumplo, because we don't
338          * care and may very well be unaligned within the dump device.
339          */
340         dumplo += hdrgap;
341
342         /* Dump memory chunks (updates dumplo) */
343         error = foreach_chunk(cb_dumpdata, di);
344         if (error < 0)
345                 goto fail;
346
347         /* Dump trailer */
348         error = dev_ddump(di->priv, &kdh, 0, dumplo, sizeof(kdh));
349         if (error)
350                 goto fail;
351
352         /* Signal completion, signoff and exit stage left. */
353         dev_ddump(di->priv, NULL, 0, 0, 0);
354         kprintf("\nDump complete\n");
355         return;
356
357  fail:
358         if (error < 0)
359                 error = -error;
360
361         if (error == ECANCELED)
362                 kprintf("\nDump aborted\n");
363         else if (error == ENOSPC)
364                 kprintf("\nDump failed. Partition too small.\n");
365         else
366                 kprintf("\n** DUMP FAILED (ERROR %d) **\n", error);
367 }