dump_machdep.c revision 266373 
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: stable/10/sys/arm/arm/dump_machdep.c 266373 2014-05-17 22:50:16Z ian $");
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/armreg.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	/*
178	 * Make sure we write coherent data.  Note that in the SMP case this
179	 * only operates on the L1 cache of the current CPU, but all other CPUs
180	 * have already been stopped, and their flush/invalidate was done as
181	 * part of stopping.
182	 */
183	cpu_idcache_wbinv_all();
184	cpu_l2cache_wbinv_all();
185#ifdef __XSCALE__
186	xscale_cache_clean_minidata();
187#endif
188	while (pgs) {
189		chunk = pgs;
190		if (chunk > MAXDUMPPGS)
191			chunk = MAXDUMPPGS;
192		sz = chunk << PAGE_SHIFT;
193		counter += sz;
194		if (counter >> 24) {
195			printf(" %d", pgs * PAGE_SIZE);
196			counter &= (1<<24) - 1;
197		}
198		if (pa == (pa & L1_ADDR_BITS)) {
199			pmap_kenter_section(0, pa & L1_ADDR_BITS, 0);
200			cpu_tlb_flushID_SE(0);
201			cpu_cpwait();
202		}
203#ifdef SW_WATCHDOG
204		wdog_kern_pat(WD_LASTVAL);
205#endif
206		error = dump_write(di,
207		    (void *)(pa - (pa & L1_ADDR_BITS)),0, dumplo, sz);
208		if (error)
209			break;
210		dumplo += sz;
211		pgs -= chunk;
212		pa += sz;
213
214		/* Check for user abort. */
215		c = cncheckc();
216		if (c == 0x03)
217			return (ECANCELED);
218		if (c != -1)
219			printf(" (CTRL-C to abort) ");
220	}
221	printf(" ... %s\n", (error) ? "fail" : "ok");
222	return (error);
223}
224
225static int
226cb_dumphdr(struct md_pa *mdp, int seqnr, void *arg)
227{
228	struct dumperinfo *di = (struct dumperinfo*)arg;
229	Elf_Phdr phdr;
230	uint64_t size;
231	int error;
232
233	size = mdp->md_size;
234	bzero(&phdr, sizeof(phdr));
235	phdr.p_type = PT_LOAD;
236	phdr.p_flags = PF_R;			/* XXX */
237	phdr.p_offset = fileofs;
238	phdr.p_vaddr = mdp->md_start;
239	phdr.p_paddr = mdp->md_start;
240	phdr.p_filesz = size;
241	phdr.p_memsz = size;
242	phdr.p_align = PAGE_SIZE;
243
244	error = buf_write(di, (char*)&phdr, sizeof(phdr));
245	fileofs += phdr.p_filesz;
246	return (error);
247}
248
249static int
250cb_size(struct md_pa *mdp, int seqnr, void *arg)
251{
252	uint32_t *sz = (uint32_t*)arg;
253
254	*sz += (uint32_t)mdp->md_size;
255	return (0);
256}
257
258static int
259foreach_chunk(callback_t cb, void *arg)
260{
261	struct md_pa *mdp;
262	int error, seqnr;
263
264	seqnr = 0;
265	mdp = md_pa_first();
266	while (mdp != NULL) {
267		error = (*cb)(mdp, seqnr++, arg);
268		if (error)
269			return (-error);
270		mdp = md_pa_next(mdp);
271	}
272	return (seqnr);
273}
274
275void
276dumpsys(struct dumperinfo *di)
277{
278	Elf_Ehdr ehdr;
279	uint32_t dumpsize;
280	off_t hdrgap;
281	size_t hdrsz;
282	int error;
283
284	if (do_minidump) {
285		minidumpsys(di);
286		return;
287	}
288
289	bzero(&ehdr, sizeof(ehdr));
290	ehdr.e_ident[EI_MAG0] = ELFMAG0;
291	ehdr.e_ident[EI_MAG1] = ELFMAG1;
292	ehdr.e_ident[EI_MAG2] = ELFMAG2;
293	ehdr.e_ident[EI_MAG3] = ELFMAG3;
294	ehdr.e_ident[EI_CLASS] = ELF_CLASS;
295#if BYTE_ORDER == LITTLE_ENDIAN
296	ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
297#else
298	ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
299#endif
300	ehdr.e_ident[EI_VERSION] = EV_CURRENT;
301	ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;	/* XXX big picture? */
302	ehdr.e_type = ET_CORE;
303	ehdr.e_machine = EM_ARM;
304	ehdr.e_phoff = sizeof(ehdr);
305	ehdr.e_flags = 0;
306	ehdr.e_ehsize = sizeof(ehdr);
307	ehdr.e_phentsize = sizeof(Elf_Phdr);
308	ehdr.e_shentsize = sizeof(Elf_Shdr);
309
310	md_pa_init();
311
312	/* Calculate dump size. */
313	dumpsize = 0L;
314	ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
315	hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
316	fileofs = MD_ALIGN(hdrsz);
317	dumpsize += fileofs;
318	hdrgap = fileofs - DEV_ALIGN(hdrsz);
319
320	/* Determine dump offset on device. */
321	if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
322		error = ENOSPC;
323		goto fail;
324	}
325	dumplo = di->mediaoffset + di->mediasize - dumpsize;
326	dumplo -= sizeof(kdh) * 2;
327
328	mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_ARM_VERSION, dumpsize, di->blocksize);
329
330	printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
331	    ehdr.e_phnum);
332
333	/* Dump leader */
334	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
335	if (error)
336		goto fail;
337	dumplo += sizeof(kdh);
338
339	/* Dump ELF header */
340	error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
341	if (error)
342		goto fail;
343
344	/* Dump program headers */
345	error = foreach_chunk(cb_dumphdr, di);
346	if (error < 0)
347		goto fail;
348	buf_flush(di);
349
350	/*
351	 * All headers are written using blocked I/O, so we know the
352	 * current offset is (still) block aligned. Skip the alignement
353	 * in the file to have the segment contents aligned at page
354	 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
355	 * care and may very well be unaligned within the dump device.
356	 */
357	dumplo += hdrgap;
358
359	/* Dump memory chunks (updates dumplo) */
360	error = foreach_chunk(cb_dumpdata, di);
361	if (error < 0)
362		goto fail;
363
364	/* Dump trailer */
365	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
366	if (error)
367		goto fail;
368
369	/* Signal completion, signoff and exit stage left. */
370	dump_write(di, NULL, 0, 0, 0);
371	printf("\nDump complete\n");
372	return;
373
374 fail:
375	if (error < 0)
376		error = -error;
377
378	if (error == ECANCELED)
379		printf("\nDump aborted\n");
380	else if (error == ENOSPC)
381		printf("\nDump failed. Partition too small.\n");
382	else
383		printf("\n** DUMP FAILED (ERROR %d) **\n", error);
384}
385