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 <sys/param.h> 42 #include <sys/conf.h> 43 44 #include <machine/endian.h> 45 46 #if BYTE_ORDER == LITTLE_ENDIAN 47 #define dtoh32(x) __bswap32(x) 48 #define dtoh64(x) __bswap64(x) 49 #define htod32(x) __bswap32(x) 50 #define htod64(x) __bswap64(x) 51 #elif BYTE_ORDER == BIG_ENDIAN 52 #define dtoh32(x) (x) 53 #define dtoh64(x) (x) 54 #define htod32(x) (x) 55 #define htod64(x) (x) 56 #endif 57 58 #define KERNELDUMP_COMP_NONE 0 59 #define KERNELDUMP_COMP_GZIP 1 60 61 #define KERNELDUMP_ENC_NONE 0 62 #define KERNELDUMP_ENC_AES_256_CBC 1 63 64 #define KERNELDUMP_BUFFER_SIZE 4096 65 #define KERNELDUMP_IV_MAX_SIZE 32 66 #define KERNELDUMP_KEY_MAX_SIZE 64 67 #define KERNELDUMP_ENCKEY_MAX_SIZE (16384 / 8) 68 69 /* 70 * All uintX_t fields are in dump byte order, which is the same as 71 * network byte order. Use the macros defined above to read or 72 * write the fields. 73 */ 74 struct kerneldumpheader { 75 char magic[20]; 76 #define KERNELDUMPMAGIC "FreeBSD Kernel Dump" 77 #define TEXTDUMPMAGIC "FreeBSD Text Dump" 78 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump" 79 char architecture[12]; 80 uint32_t version; 81 #define KERNELDUMPVERSION 3 82 #define KERNELDUMP_TEXT_VERSION 3 83 uint32_t architectureversion; 84 #define KERNELDUMP_AARCH64_VERSION 1 85 #define KERNELDUMP_AMD64_VERSION 2 86 #define KERNELDUMP_ARM_VERSION 1 87 #define KERNELDUMP_I386_VERSION 2 88 #define KERNELDUMP_MIPS_VERSION 1 89 #define KERNELDUMP_POWERPC_VERSION 1 90 #define KERNELDUMP_RISCV_VERSION 1 91 #define KERNELDUMP_SPARC64_VERSION 1 92 uint64_t dumplength; /* excl headers */ 93 uint64_t dumpextent; 94 uint64_t dumptime; 95 uint32_t dumpkeysize; 96 uint32_t blocksize; 97 uint8_t compression; 98 char hostname[64]; 99 char versionstring[192]; 100 char panicstring[179]; 101 uint32_t parity; 102 }; 103 104 struct kerneldumpkey { 105 uint8_t kdk_encryption; 106 uint8_t kdk_iv[KERNELDUMP_IV_MAX_SIZE]; 107 uint32_t kdk_encryptedkeysize; 108 uint8_t kdk_encryptedkey[]; 109 } __packed; 110 111 /* 112 * Parity calculation is endian insensitive. 113 */ 114 static __inline u_int32_t 115 kerneldump_parity(struct kerneldumpheader *kdhp) 116 { 117 uint32_t *up, parity; 118 u_int i; 119 120 up = (uint32_t *)kdhp; 121 parity = 0; 122 for (i = 0; i < sizeof *kdhp; i += sizeof *up) 123 parity ^= *up++; 124 return (parity); 125 } 126 127 #ifdef _KERNEL 128 struct dump_pa { 129 vm_paddr_t pa_start; 130 vm_paddr_t pa_size; 131 }; 132 133 int dumpsys_generic(struct dumperinfo *); 134 135 void dumpsys_map_chunk(vm_paddr_t, size_t, void **); 136 typedef int dumpsys_callback_t(struct dump_pa *, int, void *); 137 int dumpsys_foreach_chunk(dumpsys_callback_t, void *); 138 int dumpsys_cb_dumpdata(struct dump_pa *, int, void *); 139 int dumpsys_buf_seek(struct dumperinfo *, size_t); 140 int dumpsys_buf_write(struct dumperinfo *, char *, size_t); 141 int dumpsys_buf_flush(struct dumperinfo *); 142 143 void dumpsys_gen_pa_init(void); 144 struct dump_pa *dumpsys_gen_pa_next(struct dump_pa *); 145 void dumpsys_gen_wbinv_all(void); 146 void dumpsys_gen_unmap_chunk(vm_paddr_t, size_t, void *); 147 int dumpsys_gen_write_aux_headers(struct dumperinfo *); 148 149 extern int do_minidump; 150 151 #endif 152 153 #endif /* _SYS_KERNELDUMP_H */ 154