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
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD$");
29
30#include "opt_watchdog.h"
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/conf.h>
35#include <sys/cons.h>
36#include <sys/sysctl.h>
37#include <sys/kernel.h>
38#include <sys/proc.h>
39#include <sys/kerneldump.h>
40#ifdef SW_WATCHDOG
41#include <sys/watchdog.h>
42#endif
43#include <vm/vm.h>
44#include <vm/pmap.h>
45#include <machine/elf.h>
46#include <machine/md_var.h>
47#include <machine/pcb.h>
48#include <machine/cache.h>
49
50CTASSERT(sizeof(struct kerneldumpheader) == 512);
51
52int do_minidump = 1;
53TUNABLE_INT("debug.minidump", &do_minidump);
54SYSCTL_INT(_debug, OID_AUTO, minidump, CTLFLAG_RW, &do_minidump, 0,
55    "Enable mini crash dumps");
56
57/*
58 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
59 * is to protect us from metadata and to protect metadata from us.
60 */
61#define	SIZEOF_METADATA		(64*1024)
62
63#define	MD_ALIGN(x)	(((off_t)(x) + PAGE_MASK) & ~PAGE_MASK)
64#define	DEV_ALIGN(x)	(((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
65extern struct pcb dumppcb;
66
67struct md_pa {
68	vm_paddr_t md_start;
69	vm_paddr_t md_size;
70};
71
72typedef int callback_t(struct md_pa *, int, void *);
73
74static struct kerneldumpheader kdh;
75static off_t dumplo, fileofs;
76
77/* Handle buffered writes. */
78static char buffer[DEV_BSIZE];
79static size_t fragsz;
80
81/* XXX: I suppose 20 should be enough. */
82static struct md_pa dump_map[20];
83
84static void
85md_pa_init(void)
86{
87	int n, idx;
88
89	bzero(dump_map, sizeof(dump_map));
90	for (n = 0; n < sizeof(dump_map) / sizeof(dump_map[0]); n++) {
91		idx = n * 2;
92		if (dump_avail[idx] == 0 && dump_avail[idx + 1] == 0)
93			break;
94		dump_map[n].md_start = dump_avail[idx];
95		dump_map[n].md_size = dump_avail[idx + 1] - dump_avail[idx];
96	}
97}
98
99static struct md_pa *
100md_pa_first(void)
101{
102
103	return (&dump_map[0]);
104}
105
106static struct md_pa *
107md_pa_next(struct md_pa *mdp)
108{
109
110	mdp++;
111	if (mdp->md_size == 0)
112		mdp = NULL;
113	return (mdp);
114}
115
116static int
117buf_write(struct dumperinfo *di, char *ptr, size_t sz)
118{
119	size_t len;
120	int error;
121
122	while (sz) {
123		len = DEV_BSIZE - fragsz;
124		if (len > sz)
125			len = sz;
126		bcopy(ptr, buffer + fragsz, len);
127		fragsz += len;
128		ptr += len;
129		sz -= len;
130		if (fragsz == DEV_BSIZE) {
131			error = dump_write(di, buffer, 0, dumplo,
132			    DEV_BSIZE);
133			if (error)
134				return error;
135			dumplo += DEV_BSIZE;
136			fragsz = 0;
137		}
138	}
139
140	return (0);
141}
142
143static int
144buf_flush(struct dumperinfo *di)
145{
146	int error;
147
148	if (fragsz == 0)
149		return (0);
150
151	error = dump_write(di, buffer, 0, dumplo, DEV_BSIZE);
152	dumplo += DEV_BSIZE;
153	fragsz = 0;
154	return (error);
155}
156
157extern vm_offset_t kernel_l1kva;
158extern char *pouet2;
159
160static int
161cb_dumpdata(struct md_pa *mdp, int seqnr, void *arg)
162{
163	struct dumperinfo *di = (struct dumperinfo*)arg;
164	vm_paddr_t pa;
165	uint32_t pgs;
166	size_t counter, sz, chunk;
167	int c, error;
168
169	error = 0;	/* catch case in which chunk size is 0 */
170	counter = 0;
171	pgs = mdp->md_size / PAGE_SIZE;
172	pa = mdp->md_start;
173
174	printf("  chunk %d: %dMB (%d pages)", seqnr, pgs * PAGE_SIZE / (
175	    1024*1024), pgs);
176
177	/* Make sure we write coherent datas. */
178	mips_dcache_wbinv_all();
179	while (pgs) {
180		chunk = pgs;
181		if (chunk > MAXDUMPPGS)
182			chunk = MAXDUMPPGS;
183		sz = chunk << PAGE_SHIFT;
184		counter += sz;
185		if (counter >> 24) {
186			printf(" %d", pgs * PAGE_SIZE);
187			counter &= (1<<24) - 1;
188		}
189
190#ifdef SW_WATCHDOG
191		wdog_kern_pat(WD_LASTVAL);
192#endif
193		error = dump_write(di, (void *)(intptr_t)(pa),0, dumplo, sz); /* XXX fix PA */
194		if (error)
195			break;
196		dumplo += sz;
197		pgs -= chunk;
198		pa += sz;
199
200		/* Check for user abort. */
201		c = cncheckc();
202		if (c == 0x03)
203			return (ECANCELED);
204		if (c != -1)
205			printf(" (CTRL-C to abort) ");
206	}
207	printf(" ... %s\n", (error) ? "fail" : "ok");
208	return (error);
209}
210
211static int
212cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
213{
214	struct dumperinfo *di = (struct dumperinfo*)arg;
215	Elf_Phdr phdr;
216	uint64_t size;
217	int error;
218
219	size = mdp->md_size;
220	bzero(&phdr, sizeof(phdr));
221	phdr.p_type = PT_LOAD;
222	phdr.p_flags = PF_R;			/* XXX */
223	phdr.p_offset = fileofs;
224	phdr.p_vaddr = mdp->md_start;
225	phdr.p_paddr = mdp->md_start;
226	phdr.p_filesz = size;
227	phdr.p_memsz = size;
228	phdr.p_align = PAGE_SIZE;
229
230	error = buf_write(di, (char*)&phdr, sizeof(phdr));
231	fileofs += phdr.p_filesz;
232	return (error);
233}
234
235static int
236cb_size(struct md_pa *mdp, int seqnr, void *arg)
237{
238	uint32_t *sz = (uint32_t*)arg;
239
240	*sz += (uint32_t)mdp->md_size;
241	return (0);
242}
243
244static int
245foreach_chunk(callback_t cb, void *arg)
246{
247	struct md_pa *mdp;
248	int error, seqnr;
249
250	seqnr = 0;
251	mdp = md_pa_first();
252	while (mdp != NULL) {
253		error = (*cb)(mdp, seqnr++, arg);
254		if (error)
255			return (-error);
256		mdp = md_pa_next(mdp);
257	}
258	return (seqnr);
259}
260
261void
262dumpsys(struct dumperinfo *di)
263{
264	Elf_Ehdr ehdr;
265	uint32_t dumpsize;
266	off_t hdrgap;
267	size_t hdrsz;
268	int error;
269
270	if (do_minidump) {
271		minidumpsys(di);
272		return;
273	}
274
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;
283#else
284	ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
285#endif
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_MIPS;
290	ehdr.e_phoff = sizeof(ehdr);
291	ehdr.e_flags = 0;
292	ehdr.e_ehsize = sizeof(ehdr);
293	ehdr.e_phentsize = sizeof(Elf_Phdr);
294	ehdr.e_shentsize = sizeof(Elf_Shdr);
295
296	md_pa_init();
297
298	/* Calculate dump size. */
299	dumpsize = 0L;
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);
303	dumpsize += fileofs;
304	hdrgap = fileofs - DEV_ALIGN(hdrsz);
305
306	/* Determine dump offset on device. */
307	if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
308		error = ENOSPC;
309		goto fail;
310	}
311	dumplo = di->mediaoffset + di->mediasize - dumpsize;
312	dumplo -= sizeof(kdh) * 2;
313
314	mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_MIPS_VERSION, dumpsize, di->blocksize);
315
316	printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
317	    ehdr.e_phnum);
318
319	/* Dump leader */
320	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
321	if (error)
322		goto fail;
323	dumplo += sizeof(kdh);
324
325	/* Dump ELF header */
326	error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
327	if (error)
328		goto fail;
329
330	/* Dump program headers */
331	error = foreach_chunk(cb_dumphdr, di);
332	if (error < 0)
333		goto fail;
334	buf_flush(di);
335
336	/*
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.
342	 */
343	dumplo += hdrgap;
344
345	/* Dump memory chunks (updates dumplo) */
346	error = foreach_chunk(cb_dumpdata, di);
347	if (error < 0)
348		goto fail;
349
350	/* Dump trailer */
351	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
352	if (error)
353		goto fail;
354
355	/* Signal completion, signoff and exit stage left. */
356	dump_write(di, NULL, 0, 0, 0);
357	printf("\nDump complete\n");
358	return;
359
360 fail:
361	if (error < 0)
362		error = -error;
363
364	if (error == ECANCELED)
365		printf("\nDump aborted\n");
366	else if (error == ENOSPC)
367		printf("\nDump failed. Partition too small.\n");
368	else
369		printf("\n** DUMP FAILED (ERROR %d) **\n", error);
370}
371