xref: /openbsd/sys/sys/kcore.h (revision 108b671b)
1 /*	$OpenBSD: kcore.h,v 1.2 2023/01/04 10:59:34 jsg Exp $	*/
2 /*	$NetBSD: kcore.h,v 1.1 1996/03/10 21:56:00 leo Exp $	*/
3 
4 /*
5  * Copyright (c) 1996 Leo Weppelman.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef _SYS_KCORE_H_
29 #define	_SYS_KCORE_H_
30 
31 /*
32  * Definitions for the kernel crash-dump format. The structure of
33  * the files and headers is borrowed from the 'regular' core files
34  * as described in <sys/core.h>.
35  */
36 #define	KCORE_MAGIC	0x8fca
37 #define	KCORESEG_MAGIC	0x8fac
38 
39 /*
40  * Description of a memory segment. To make this suitable for sharing
41  * between all architectures, u_quad_t seems to be the necessary type...
42  */
43 typedef struct {
44 	u_quad_t	start;		/* Physical start address	*/
45 	u_quad_t	size;		/* Size in bytes		*/
46 } phys_ram_seg_t;
47 
48 typedef struct kcore_hdr {
49 	u_int32_t	c_midmag;	/* Magic, id, flags		*/
50 	u_int16_t	c_hdrsize;	/* Aligned header size		*/
51 	u_int16_t	c_seghdrsize;	/* Aligned seg-header size	*/
52 	u_int32_t	c_nseg;		/* Number of segments		*/
53 } kcore_hdr_t;
54 
55 typedef struct kcore_seg {
56 	u_int32_t	c_midmag;	/* Magic, id, flags		*/
57 	u_int32_t	c_size;		/* Sizeof this segment		*/
58 } kcore_seg_t;
59 
60 #endif /* _SYS_KCORE_H_ */
61