1 /*- 2 * Copyright (c) 2002 Poul-Henning Kamp 3 * Copyright (c) 2002 Networks Associates Technology, Inc. 4 * All rights reserved. 5 * 6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp 7 * and NAI Labs, the Security Research Division of Network Associates, Inc. 8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 9 * DARPA CHATS research program. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. The names of the authors may not be used to endorse or promote 20 * products derived from this software without specific prior written 21 * permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * $FreeBSD$ 36 */ 37 38 #ifndef _SYS_KERNELDUMP_H 39 #define _SYS_KERNELDUMP_H 40 41 #include <machine/endian.h> 42 43 #if BYTE_ORDER == LITTLE_ENDIAN 44 #define dtoh32(x) __bswap32(x) 45 #define dtoh64(x) __bswap64(x) 46 #define htod32(x) __bswap32(x) 47 #define htod64(x) __bswap64(x) 48 #elif BYTE_ORDER == BIG_ENDIAN 49 #define dtoh32(x) (x) 50 #define dtoh64(x) (x) 51 #define htod32(x) (x) 52 #define htod64(x) (x) 53 #endif 54 55 /* 56 * All uintX_t fields are in dump byte order, which is the same as 57 * network byte order. Use the macros defined above to read or 58 * write the fields. 59 */ 60 struct kerneldumpheader { 61 char magic[20]; 62 #define KERNELDUMPMAGIC "FreeBSD Kernel Dump" 63 #define TEXTDUMPMAGIC "FreeBSD Text Dump" 64 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump" 65 char architecture[12]; 66 uint32_t version; 67 #define KERNELDUMPVERSION 1 68 uint32_t architectureversion; 69 #define KERNELDUMP_AARCH64_VERSION 1 70 #define KERNELDUMP_AMD64_VERSION 2 71 #define KERNELDUMP_ARM_VERSION 1 72 #define KERNELDUMP_I386_VERSION 2 73 #define KERNELDUMP_MIPS_VERSION 1 74 #define KERNELDUMP_POWERPC_VERSION 1 75 #define KERNELDUMP_SPARC64_VERSION 1 76 #define KERNELDUMP_TEXT_VERSION 1 77 uint64_t dumplength; /* excl headers */ 78 uint64_t dumptime; 79 uint32_t blocksize; 80 char hostname[64]; 81 char versionstring[192]; 82 char panicstring[192]; 83 uint32_t parity; 84 }; 85 86 /* 87 * Parity calculation is endian insensitive. 88 */ 89 static __inline u_int32_t 90 kerneldump_parity(struct kerneldumpheader *kdhp) 91 { 92 uint32_t *up, parity; 93 u_int i; 94 95 up = (uint32_t *)kdhp; 96 parity = 0; 97 for (i = 0; i < sizeof *kdhp; i += sizeof *up) 98 parity ^= *up++; 99 return (parity); 100 } 101 102 #ifdef _KERNEL 103 struct dump_pa { 104 vm_paddr_t pa_start; 105 vm_paddr_t pa_size; 106 }; 107 108 void mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver, 109 uint64_t dumplen, uint32_t blksz); 110 111 int dumpsys_generic(struct dumperinfo *); 112 113 void dumpsys_map_chunk(vm_paddr_t, size_t, void **); 114 typedef int dumpsys_callback_t(struct dump_pa *, int, void *); 115 int dumpsys_foreach_chunk(dumpsys_callback_t, void *); 116 int dumpsys_cb_dumpdata(struct dump_pa *, int, void *); 117 int dumpsys_buf_write(struct dumperinfo *, char *, size_t); 118 int dumpsys_buf_flush(struct dumperinfo *); 119 120 void dumpsys_gen_pa_init(void); 121 struct dump_pa *dumpsys_gen_pa_next(struct dump_pa *); 122 void dumpsys_gen_wbinv_all(void); 123 void dumpsys_gen_unmap_chunk(vm_paddr_t, size_t, void *); 124 int dumpsys_gen_write_aux_headers(struct dumperinfo *); 125 126 extern int do_minidump; 127 128 #endif 129 130 #endif /* _SYS_KERNELDUMP_H */ 131