2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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
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
38 #ifndef _SYS_KERNELDUMP_H
39 #define _SYS_KERNELDUMP_H
41 #include <sys/param.h>
44 #include <machine/endian.h>
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
58 #define KERNELDUMP_ENC_NONE 0
59 #define KERNELDUMP_ENC_AES_256_CBC 1
61 #define KERNELDUMP_BUFFER_SIZE 1024
62 #define KERNELDUMP_IV_MAX_SIZE 32
63 #define KERNELDUMP_KEY_MAX_SIZE 64
64 #define KERNELDUMP_ENCKEY_MAX_SIZE (16384 / 8)
67 * All uintX_t fields are in dump byte order, which is the same as
68 * network byte order. Use the macros defined above to read or
71 struct kerneldumpheader {
73 #define KERNELDUMPMAGIC "FreeBSD Kernel Dump"
74 #define TEXTDUMPMAGIC "FreeBSD Text Dump"
75 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump"
76 char architecture[12];
78 #define KERNELDUMPVERSION 2
79 #define KERNELDUMP_TEXT_VERSION 2
80 uint32_t architectureversion;
81 #define KERNELDUMP_AARCH64_VERSION 1
82 #define KERNELDUMP_AMD64_VERSION 2
83 #define KERNELDUMP_ARM_VERSION 1
84 #define KERNELDUMP_I386_VERSION 2
85 #define KERNELDUMP_MIPS_VERSION 1
86 #define KERNELDUMP_POWERPC_VERSION 1
87 #define KERNELDUMP_RISCV_VERSION 1
88 #define KERNELDUMP_SPARC64_VERSION 1
89 uint64_t dumplength; /* excl headers */
94 char versionstring[192];
95 char panicstring[188];
99 struct kerneldumpkey {
100 uint8_t kdk_encryption;
101 uint8_t kdk_iv[KERNELDUMP_IV_MAX_SIZE];
102 uint32_t kdk_encryptedkeysize;
103 uint8_t kdk_encryptedkey[];
107 * Parity calculation is endian insensitive.
109 static __inline u_int32_t
110 kerneldump_parity(struct kerneldumpheader *kdhp)
112 uint32_t *up, parity;
115 up = (uint32_t *)kdhp;
117 for (i = 0; i < sizeof *kdhp; i += sizeof *up)
128 int kerneldumpcrypto_init(struct kerneldumpcrypto *kdc);
129 uint32_t kerneldumpcrypto_dumpkeysize(const struct kerneldumpcrypto *kdc);
131 void mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver,
132 uint64_t dumplen, uint32_t dumpkeysize, uint32_t blksz);
134 int dumpsys_generic(struct dumperinfo *);
136 void dumpsys_map_chunk(vm_paddr_t, size_t, void **);
137 typedef int dumpsys_callback_t(struct dump_pa *, int, void *);
138 int dumpsys_foreach_chunk(dumpsys_callback_t, void *);
139 int dumpsys_cb_dumpdata(struct dump_pa *, int, void *);
140 int dumpsys_buf_seek(struct dumperinfo *, size_t);
141 int dumpsys_buf_write(struct dumperinfo *, char *, size_t);
142 int dumpsys_buf_flush(struct dumperinfo *);
144 void dumpsys_gen_pa_init(void);
145 struct dump_pa *dumpsys_gen_pa_next(struct dump_pa *);
146 void dumpsys_gen_wbinv_all(void);
147 void dumpsys_gen_unmap_chunk(vm_paddr_t, size_t, void *);
148 int dumpsys_gen_write_aux_headers(struct dumperinfo *);
150 extern int do_minidump;
154 #endif /* _SYS_KERNELDUMP_H */