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/kernel.h>
37#include <sys/kerneldump.h>
38#ifdef SW_WATCHDOG
39#include <sys/watchdog.h>
40#endif
41#include <vm/vm.h>
42#include <vm/pmap.h>
43#include <machine/bootinfo.h>
44#include <machine/efi.h>
45#include <machine/elf.h>
46#include <machine/md_var.h>
47
48CTASSERT(sizeof(struct kerneldumpheader) == 512);
49
50/*
51 * Don't touch the first SIZEOF_METADATA bytes on the dump device. This
52 * is to protect us from metadata and to protect metadata from us.
53 */
54#define	SIZEOF_METADATA		(64*1024)
55
56#define	MD_ALIGN(x)	(((off_t)(x) + EFI_PAGE_MASK) & ~EFI_PAGE_MASK)
57#define	DEV_ALIGN(x)	(((off_t)(x) + (DEV_BSIZE-1)) & ~(DEV_BSIZE-1))
58
59typedef int callback_t(struct efi_md*, int, void*);
60
61static struct kerneldumpheader kdh;
62static off_t dumplo, fileofs;
63
64/* Handle buffered writes. */
65static char buffer[DEV_BSIZE];
66static size_t fragsz;
67
68static int
69buf_write(struct dumperinfo *di, char *ptr, size_t sz)
70{
71	size_t len;
72	int error;
73
74	while (sz) {
75		len = DEV_BSIZE - fragsz;
76		if (len > sz)
77			len = sz;
78		bcopy(ptr, buffer + fragsz, len);
79		fragsz += len;
80		ptr += len;
81		sz -= len;
82		if (fragsz == DEV_BSIZE) {
83			error = dump_write(di, buffer, 0, dumplo,
84			    DEV_BSIZE);
85			if (error)
86				return error;
87			dumplo += DEV_BSIZE;
88			fragsz = 0;
89		}
90	}
91
92	return (0);
93}
94
95static int
96buf_flush(struct dumperinfo *di)
97{
98	int error;
99
100	if (fragsz == 0)
101		return (0);
102
103	error = dump_write(di, buffer, 0, dumplo, DEV_BSIZE);
104	dumplo += DEV_BSIZE;
105	fragsz = 0;
106	return (error);
107}
108
109static int
110cb_dumpdata(struct efi_md *mdp, int seqnr, void *arg)
111{
112	struct dumperinfo *di = (struct dumperinfo*)arg;
113	vm_offset_t pa;
114	uint64_t pgs;
115	size_t counter, sz;
116	int c, error, twiddle;
117
118	error = 0;	/* catch case in which mdp->md_pages is 0 */
119	counter = 0;	/* Update twiddle every 16MB */
120	twiddle = 0;
121	pgs = mdp->md_pages;
122	pa = IA64_PHYS_TO_RR7(mdp->md_phys);
123
124	printf("  chunk %d: %ld pages ", seqnr, (long)pgs);
125
126	while (pgs) {
127		sz = (pgs > (DFLTPHYS >> EFI_PAGE_SHIFT))
128		    ? DFLTPHYS : pgs << EFI_PAGE_SHIFT;
129		counter += sz;
130		if (counter >> 24) {
131			printf("%c\b", "|/-\\"[twiddle++ & 3]);
132			counter &= (1<<24) - 1;
133		}
134#ifdef SW_WATCHDOG
135		wdog_kern_pat(WD_LASTVAL);
136#endif
137		error = dump_write(di, (void*)pa, 0, dumplo, sz);
138		if (error)
139			break;
140		dumplo += sz;
141		pgs -= sz >> EFI_PAGE_SHIFT;
142		pa += sz;
143
144		/* Check for user abort. */
145		c = cncheckc();
146		if (c == 0x03)
147			return (ECANCELED);
148		if (c != -1)
149			printf("(CTRL-C to abort)  ");
150	}
151	printf("... %s\n", (error) ? "fail" : "ok");
152	return (error);
153}
154
155static int
156cb_dumphdr(struct efi_md *mdp, int seqnr, void *arg)
157{
158	struct dumperinfo *di = (struct dumperinfo*)arg;
159	Elf64_Phdr phdr;
160	int error;
161
162	bzero(&phdr, sizeof(phdr));
163	phdr.p_type = PT_LOAD;
164	phdr.p_flags = PF_R;			/* XXX */
165	phdr.p_offset = fileofs;
166	phdr.p_vaddr = (uintptr_t)mdp->md_virt;	/* XXX probably bogus. */
167	phdr.p_paddr = mdp->md_phys;
168	phdr.p_filesz = mdp->md_pages << EFI_PAGE_SHIFT;
169	phdr.p_memsz = mdp->md_pages << EFI_PAGE_SHIFT;
170	phdr.p_align = EFI_PAGE_SIZE;
171
172	error = buf_write(di, (char*)&phdr, sizeof(phdr));
173	fileofs += phdr.p_filesz;
174	return (error);
175}
176
177static int
178cb_size(struct efi_md *mdp, int seqnr, void *arg)
179{
180	uint64_t *sz = (uint64_t*)arg;
181
182	*sz += (uint64_t)mdp->md_pages << EFI_PAGE_SHIFT;
183	return (0);
184}
185
186static int
187foreach_chunk(callback_t cb, void *arg)
188{
189	struct efi_md *mdp;
190	int error, seqnr;
191
192	seqnr = 0;
193	mdp = efi_md_first();
194	while (mdp != NULL) {
195		if (mdp->md_type == EFI_MD_TYPE_FREE ||
196		    mdp->md_type == EFI_MD_TYPE_DATA) {
197			error = (*cb)(mdp, seqnr++, arg);
198			if (error)
199				return (-error);
200		}
201		mdp = efi_md_next(mdp);
202	}
203	return (seqnr);
204}
205
206void
207dumpsys(struct dumperinfo *di)
208{
209	Elf64_Ehdr ehdr;
210	uint64_t dumpsize;
211	off_t hdrgap;
212	size_t hdrsz;
213	int error;
214
215	bzero(&ehdr, sizeof(ehdr));
216	ehdr.e_ident[EI_MAG0] = ELFMAG0;
217	ehdr.e_ident[EI_MAG1] = ELFMAG1;
218	ehdr.e_ident[EI_MAG2] = ELFMAG2;
219	ehdr.e_ident[EI_MAG3] = ELFMAG3;
220	ehdr.e_ident[EI_CLASS] = ELFCLASS64;
221#if BYTE_ORDER == LITTLE_ENDIAN
222	ehdr.e_ident[EI_DATA] = ELFDATA2LSB;
223#else
224	ehdr.e_ident[EI_DATA] = ELFDATA2MSB;
225#endif
226	ehdr.e_ident[EI_VERSION] = EV_CURRENT;
227	ehdr.e_ident[EI_OSABI] = ELFOSABI_STANDALONE;	/* XXX big picture? */
228	ehdr.e_type = ET_CORE;
229	ehdr.e_machine = EM_IA_64;
230	ehdr.e_entry = ia64_tpa((uintptr_t)bootinfo);
231	ehdr.e_phoff = sizeof(ehdr);
232	ehdr.e_flags = EF_IA_64_ABSOLUTE;		/* XXX misuse? */
233	ehdr.e_ehsize = sizeof(ehdr);
234	ehdr.e_phentsize = sizeof(Elf64_Phdr);
235	ehdr.e_shentsize = sizeof(Elf64_Shdr);
236
237	/* Calculate dump size. */
238	dumpsize = 0L;
239	ehdr.e_phnum = foreach_chunk(cb_size, &dumpsize);
240	hdrsz = ehdr.e_phoff + ehdr.e_phnum * ehdr.e_phentsize;
241	fileofs = MD_ALIGN(hdrsz);
242	dumpsize += fileofs;
243	hdrgap = fileofs - DEV_ALIGN(hdrsz);
244
245	/* Determine dump offset on device. */
246	if (di->mediasize < SIZEOF_METADATA + dumpsize + sizeof(kdh) * 2) {
247		error = ENOSPC;
248		goto fail;
249	}
250	dumplo = di->mediaoffset + di->mediasize - dumpsize;
251	dumplo -= sizeof(kdh) * 2;
252
253	mkdumpheader(&kdh, KERNELDUMPMAGIC, KERNELDUMP_IA64_VERSION, dumpsize, di->blocksize);
254
255	printf("Dumping %llu MB (%d chunks)\n", (long long)dumpsize >> 20,
256	    ehdr.e_phnum);
257
258	/* Dump leader */
259	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
260	if (error)
261		goto fail;
262	dumplo += sizeof(kdh);
263
264	/* Dump ELF header */
265	error = buf_write(di, (char*)&ehdr, sizeof(ehdr));
266	if (error)
267		goto fail;
268
269	/* Dump program headers */
270	error = foreach_chunk(cb_dumphdr, di);
271	if (error < 0)
272		goto fail;
273	buf_flush(di);
274
275	/*
276	 * All headers are written using blocked I/O, so we know the
277	 * current offset is (still) block aligned. Skip the alignement
278	 * in the file to have the segment contents aligned at page
279	 * boundary. We cannot use MD_ALIGN on dumplo, because we don't
280	 * care and may very well be unaligned within the dump device.
281	 */
282	dumplo += hdrgap;
283
284	/* Dump memory chunks (updates dumplo) */
285	error = foreach_chunk(cb_dumpdata, di);
286	if (error < 0)
287		goto fail;
288
289	/* Dump trailer */
290	error = dump_write(di, &kdh, 0, dumplo, sizeof(kdh));
291	if (error)
292		goto fail;
293
294	/* Signal completion, signoff and exit stage left. */
295	dump_write(di, NULL, 0, 0, 0);
296	printf("\nDump complete\n");
297	return;
298
299 fail:
300	if (error < 0)
301		error = -error;
302
303	if (error == ECANCELED)
304		printf("\nDump aborted\n");
305	else
306		printf("\n** DUMP FAILED (ERROR %d) **\n", error);
307}
308