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