sys/sys/kerneldump.h

   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_ENC_NONE             0
  59 #define KERNELDUMP_ENC_AES_256_CBC      1
  60
  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)
  65
  66 /*
  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
  69  * write the fields.
  70  */
  71 struct kerneldumpheader {
  72         char            magic[20];
  73 #define KERNELDUMPMAGIC         "FreeBSD Kernel Dump"
  74 #define TEXTDUMPMAGIC           "FreeBSD Text Dump"
  75 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump"
  76         char            architecture[12];
  77         uint32_t        version;
  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 */
  90         uint64_t        dumptime;
  91         uint32_t        dumpkeysize;
  92         uint32_t        blocksize;
  93         char            hostname[64];
  94         char            versionstring[192];
  95         char            panicstring[188];
  96         uint32_t        parity;
  97 };
  98
  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[];
 104 } __packed;
 105
 106 /*
 107  * Parity calculation is endian insensitive.
 108  */
 109 static __inline u_int32_t
 110 kerneldump_parity(struct kerneldumpheader *kdhp)
 111 {
 112         uint32_t *up, parity;
 113         u_int i;
 114
 115         up = (uint32_t *)kdhp;
 116         parity = 0;
 117         for (i = 0; i < sizeof *kdhp; i += sizeof *up)
 118                 parity ^= *up++;
 119         return (parity);
 120 }
 121
 122 #ifdef _KERNEL
 123 struct dump_pa {
 124         vm_paddr_t pa_start;
 125         vm_paddr_t pa_size;
 126 };
 127
 128 int kerneldumpcrypto_init(struct kerneldumpcrypto *kdc);
 129 uint32_t kerneldumpcrypto_dumpkeysize(const struct kerneldumpcrypto *kdc);
 130
 131 void mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver,
 132     uint64_t dumplen, uint32_t dumpkeysize, uint32_t blksz);
 133
 134 int dumpsys_generic(struct dumperinfo *);
 135
 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 *);
 143
 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 *);
 149
 150 extern int do_minidump;
 151
 152 #endif
 153
 154 #endif /* _SYS_KERNELDUMP_H */