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 #include <machine/pcb.h> 43 44 #if BYTE_ORDER == LITTLE_ENDIAN 45 #define dtoh32(x) __bswap32(x) 46 #define dtoh64(x) __bswap64(x) 47 #define htod32(x) __bswap32(x) 48 #define htod64(x) __bswap64(x) 49 #elif BYTE_ORDER == BIG_ENDIAN 50 #define dtoh32(x) (x) 51 #define dtoh64(x) (x) 52 #define htod32(x) (x) 53 #define htod64(x) (x) 54 #endif 55 struct thread; 56 57 extern struct thread *dumpthread; 58 extern struct pcb dumppcb; 59 extern int dump_stop_usertds; 60 61 /* 62 * All uintX_t fields are in dump byte order, which is the same as 63 * network byte order. Use the macros defined above to read or 64 * write the fields. 65 */ 66 struct kerneldumpheader { 67 char magic[20]; 68 #define KERNELDUMPMAGIC "DragonFly Kern Dump" 69 #define TEXTDUMPMAGIC "DragonFly Text Dump" 70 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump" 71 char architecture[12]; 72 uint32_t version; 73 #define KERNELDUMPVERSION 1 74 uint32_t architectureversion; 75 #define KERNELDUMP_AMD64_VERSION 2 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 void mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver, 104 uint64_t dumplen, uint32_t blksz); 105 106 107 typedef int dumper_t( 108 void *_priv, /* Private to the driver. */ 109 void *_virtual, /* Virtual (mapped) address. */ 110 vm_offset_t _physical, /* Physical address of virtual. */ 111 off_t _offset, /* Byte-offset to write at. */ 112 size_t _length); /* Number of bytes to dump. */ 113 114 115 struct dumperinfo { 116 void *dumper; /* Dumping function. */ 117 void *priv; /* Private parts. */ 118 u_int blocksize; /* Size of block in bytes. */ 119 u_int maxiosize; /* Max size allowed for an individual I/O */ 120 off_t mediaoffset; /* Initial offset in bytes. */ 121 off_t mediasize; /* Space available in bytes. */ 122 }; 123 124 int set_dumper(struct dumperinfo *); 125 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 126 void dumpsys(void); 127 void md_dumpsys(struct dumperinfo *); 128 void dump_reactivate_cpus(void); 129 130 #endif 131 132 133 #endif /* _SYS_KERNELDUMP_H */ 134