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_I386_VERSION 2 77 #define KERNELDUMP_TEXT_VERSION 1 78 uint64_t dumplength; /* excl headers */ 79 uint64_t dumptime; 80 uint32_t blocksize; 81 char hostname[64]; 82 char versionstring[192]; 83 char panicstring[192]; 84 uint32_t parity; 85 }; 86 87 /* 88 * Parity calculation is endian insensitive. 89 */ 90 static __inline u_int32_t 91 kerneldump_parity(struct kerneldumpheader *kdhp) 92 { 93 uint32_t *up, parity; 94 u_int i; 95 96 up = (uint32_t *)kdhp; 97 parity = 0; 98 for (i = 0; i < sizeof *kdhp; i += sizeof *up) 99 parity ^= *up++; 100 return (parity); 101 } 102 103 #ifdef _KERNEL 104 void mkdumpheader(struct kerneldumpheader *kdh, char *magic, uint32_t archver, 105 uint64_t dumplen, uint32_t blksz); 106 107 108 typedef int dumper_t( 109 void *_priv, /* Private to the driver. */ 110 void *_virtual, /* Virtual (mapped) address. */ 111 vm_offset_t _physical, /* Physical address of virtual. */ 112 off_t _offset, /* Byte-offset to write at. */ 113 size_t _length); /* Number of bytes to dump. */ 114 115 116 struct dumperinfo { 117 void *dumper; /* Dumping function. */ 118 void *priv; /* Private parts. */ 119 u_int blocksize; /* Size of block in bytes. */ 120 u_int maxiosize; /* Max size allowed for an individual I/O */ 121 off_t mediaoffset; /* Initial offset in bytes. */ 122 off_t mediasize; /* Space available in bytes. */ 123 }; 124 125 int set_dumper(struct dumperinfo *); 126 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 127 void dumpsys(void); 128 void md_dumpsys(struct dumperinfo *); 129 void dump_reactivate_cpus(void); 130 131 #endif 132 133 134 #endif /* _SYS_KERNELDUMP_H */ 135