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 <machine/endian.h>
  42
  43 #if BYTE_ORDER == LITTLE_ENDIAN
  44 #define dtoh32(x)       __bswap32(x)
  45 #define dtoh64(x)       __bswap64(x)
  46 #define htod32(x)       __bswap32(x)
  47 #define htod64(x)       __bswap64(x)
  48 #elif BYTE_ORDER == BIG_ENDIAN
  49 #define dtoh32(x)       (x)
  50 #define dtoh64(x)       (x)
  51 #define htod32(x)       (x)
  52 #define htod64(x)       (x)
  53 #endif
  54
  55 /*
  56  * All uintX_t fields are in dump byte order, which is the same as
  57  * network byte order. Use the macros defined above to read or
  58  * write the fields.
  59  */
  60 struct kerneldumpheader {
  61         char            magic[20];
  62 #define KERNELDUMPMAGIC         "FreeBSD Kernel Dump"
  63 #define TEXTDUMPMAGIC           "FreeBSD Text Dump"
  64 #define KERNELDUMPMAGIC_CLEARED "Cleared Kernel Dump"
  65         char            architecture[12];
  66         uint32_t        version;
  67 #define KERNELDUMPVERSION       1
  68         uint32_t        architectureversion;
  69 #define KERNELDUMP_ALPHA_VERSION        1
  70 #define KERNELDUMP_AMD64_VERSION        2
  71 #define KERNELDUMP_ARM_VERSION          1
  72 #define KERNELDUMP_I386_VERSION         2
  73 #define KERNELDUMP_IA64_VERSION         1
  74 #define KERNELDUMP_MIPS_VERSION         1
  75 #define KERNELDUMP_POWERPC_VERSION      1
  76 #define KERNELDUMP_SPARC64_VERSION      1
  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 #endif
 107
 108 #endif /* _SYS_KERNELDUMP_H */