Home | History | Annotate | Download | only in sys
      1      0   stevel /*
      2      0   stevel  * CDDL HEADER START
      3      0   stevel  *
      4      0   stevel  * The contents of this file are subject to the terms of the
      5   3446      mrj  * Common Development and Distribution License (the "License").
      6   3446      mrj  * You may not use this file except in compliance with the License.
      7      0   stevel  *
      8      0   stevel  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9      0   stevel  * or http://www.opensolaris.org/os/licensing.
     10      0   stevel  * See the License for the specific language governing permissions
     11      0   stevel  * and limitations under the License.
     12      0   stevel  *
     13      0   stevel  * When distributing Covered Code, include this CDDL HEADER in each
     14      0   stevel  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15      0   stevel  * If applicable, add the following below this CDDL HEADER, with the
     16      0   stevel  * fields enclosed by brackets "[]" replaced with your own identifying
     17      0   stevel  * information: Portions Copyright [yyyy] [name of copyright owner]
     18      0   stevel  *
     19      0   stevel  * CDDL HEADER END
     20      0   stevel  */
     21      0   stevel /*
     22  10843     Dave  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     23      0   stevel  * Use is subject to license terms.
     24      0   stevel  */
     25      0   stevel 
     26      0   stevel #ifndef _SYS_DUMPHDR_H
     27      0   stevel #define	_SYS_DUMPHDR_H
     28      0   stevel 
     29      0   stevel #include <sys/types.h>
     30      0   stevel #include <sys/param.h>
     31      0   stevel #include <sys/utsname.h>
     32      0   stevel #include <sys/log.h>
     33      0   stevel 
     34      0   stevel #ifdef	__cplusplus
     35      0   stevel extern "C" {
     36      0   stevel #endif
     37      0   stevel 
     38      0   stevel /*
     39      0   stevel  * The dump header describes the contents of a crash dump.  Two headers
     40      0   stevel  * are written out: one at the beginning of the dump, and the other at
     41      0   stevel  * the very end of the dump device.  The terminal header is at a known
     42      0   stevel  * location (end of device) so we can always find it.  The initial header
     43      0   stevel  * is redundant, but helps savecore(1M) determine whether the dump has been
     44      0   stevel  * overwritten by swap activity.  See dumpadm(1M) for dump configuration.
     45      0   stevel  */
     46      0   stevel #define	DUMP_MAGIC	0xdefec8edU		/* dump magic number */
     47      0   stevel #define	DUMP_VERSION	9			/* version of this dumphdr */
     48      0   stevel #define	DUMP_WORDSIZE	(sizeof (long) * NBBY)	/* word size (32 or 64) */
     49      0   stevel #define	DUMP_PANICSIZE	200			/* Max panic string copied */
     50      0   stevel #define	DUMP_COMPRESS_RATIO	2		/* conservative; usually 2.5+ */
     51      0   stevel #define	DUMP_OFFSET	65536			/* pad at start/end of dev */
     52      0   stevel #define	DUMP_LOGSIZE	(2 * LOG_HIWAT)		/* /dev/log message save area */
     53      0   stevel #define	DUMP_ERPTSIZE   (P2ROUNDUP(	\
     54      0   stevel 	(ERPT_DATA_SZ / 2) *		\
     55      0   stevel 	(ERPT_EVCH_MAX +		\
     56      0   stevel 	ERPT_MAX_ERRS * ERPT_HIWAT),	\
     57      0   stevel 	DUMP_OFFSET))				/* ereport save area */
     58      0   stevel 
     59      0   stevel typedef struct dumphdr {
     60      0   stevel 	uint32_t dump_magic;		/* magic number */
     61      0   stevel 	uint32_t dump_version;		/* version number */
     62      0   stevel 	uint32_t dump_flags;		/* flags; see below */
     63      0   stevel 	uint32_t dump_wordsize;		/* 32 or 64 */
     64      0   stevel 	offset_t dump_start;		/* starting offset on dump device */
     65      0   stevel 	offset_t dump_ksyms;		/* offset of compressed symbol table */
     66      0   stevel 	offset_t dump_pfn;		/* offset of pfn table for all pages */
     67      0   stevel 	offset_t dump_map;		/* offset of page translation map */
     68      0   stevel 	offset_t dump_data;		/* offset of actual dump data */
     69      0   stevel 	struct utsname dump_utsname;	/* copy of utsname structure */
     70      0   stevel 	char	dump_platform[SYS_NMLN]; /* platform name (uname -i) */
     71      0   stevel 	char	dump_panicstring[DUMP_PANICSIZE]; /* copy of panicstr */
     72      0   stevel 	time_t	dump_crashtime;		/* time of crash */
     73      0   stevel 	long	dump_pageshift;		/* log2(pagesize) */
     74      0   stevel 	long	dump_pagesize;		/* pagesize */
     75      0   stevel 	long	dump_hashmask;		/* page translation hash mask */
     76      0   stevel 	long	dump_nvtop;		/* number of vtop table entries */
     77      0   stevel 	pgcnt_t	dump_npages;		/* number of data pages */
     78      0   stevel 	size_t	dump_ksyms_size;	/* kernel symbol table size */
     79      0   stevel 	size_t	dump_ksyms_csize;	/* compressed symbol table size */
     80      0   stevel } dumphdr_t;
     81      0   stevel 
     82      0   stevel /*
     83      0   stevel  * Values for dump_flags
     84      0   stevel  */
     85      0   stevel #define	DF_VALID	0x00000001	/* Dump is valid (savecore clears) */
     86      0   stevel #define	DF_COMPLETE	0x00000002	/* All pages present as configured */
     87      0   stevel #define	DF_LIVE		0x00000004	/* Dump was taken on a live system */
     88  10843     Dave #define	DF_COMPRESSED	0x00000008	/* Dump is compressed */
     89      0   stevel #define	DF_KERNEL	0x00010000	/* Contains kernel pages only */
     90      0   stevel #define	DF_ALL		0x00020000	/* Contains all pages */
     91      0   stevel #define	DF_CURPROC	0x00040000	/* Contains kernel + cur proc pages */
     92      0   stevel #define	DF_CONTENT	0xffff0000	/* The set of all dump content flags */
     93      0   stevel 
     94      0   stevel /*
     95      0   stevel  * Dump translation map hash table entry.
     96      0   stevel  */
     97      0   stevel typedef struct dump_map {
     98      0   stevel 	offset_t	dm_first;
     99      0   stevel 	offset_t	dm_next;
    100      0   stevel 	offset_t	dm_data;
    101      0   stevel 	struct as	*dm_as;
    102      0   stevel 	uintptr_t	dm_va;
    103      0   stevel } dump_map_t;
    104      0   stevel 
    105      0   stevel /*
    106      0   stevel  * Dump translation map hash function.
    107      0   stevel  */
    108      0   stevel #define	DUMP_HASH(dhp, as, va)	\
    109      0   stevel 	((((uintptr_t)(as) >> 3) + ((va) >> (dhp)->dump_pageshift)) & \
    110      0   stevel 	(dhp)->dump_hashmask)
    111      0   stevel 
    112  10843     Dave /*
    113  10843     Dave  * Encoding of the csize word used to provide meta information
    114  10843     Dave  * between dumpsys and savecore.
    115  10843     Dave  *
    116  10843     Dave  *	tag	size
    117  10843     Dave  *	1-4095	1..dump_maxcsize	stream block
    118  10843     Dave  *	0	1..pagesize		one lzjb page
    119  10843     Dave  *	0	0			marks end of data
    120  10843     Dave  */
    121  10843     Dave typedef uint32_t dumpcsize_t;
    122  10843     Dave 
    123  10843     Dave #define	DUMP_MAX_TAG		(0xfffU)
    124  10843     Dave #define	DUMP_MAX_CSIZE		(0xfffffU)
    125  10843     Dave #define	DUMP_SET_TAG(w, v)	(((w) & DUMP_MAX_CSIZE) | ((v) << 20))
    126  10843     Dave #define	DUMP_GET_TAG(w)		(((w) >> 20) & DUMP_MAX_TAG)
    127  10843     Dave #define	DUMP_SET_CSIZE(w, v)	\
    128  10843     Dave 	(((w) & (DUMP_MAX_TAG << 20)) | ((v) & DUMP_MAX_CSIZE))
    129  10843     Dave #define	DUMP_GET_CSIZE(w)	((w) & DUMP_MAX_CSIZE)
    130  10843     Dave 
    131  10843     Dave typedef struct dumpstreamhdr {
    132  10843     Dave 	char		stream_magic[8];	/* "StrmHdr" */
    133  10843     Dave 	pgcnt_t		stream_pagenum;		/* starting pfn */
    134  10843     Dave 	pgcnt_t		stream_npages;		/* uncompressed size */
    135  10843     Dave } dumpstreamhdr_t;
    136  10843     Dave 
    137  10843     Dave #define	DUMP_STREAM_MAGIC	"StrmHdr"
    138  10843     Dave 
    139  10843     Dave /* The number of helpers is limited by the number of stream tags. */
    140  10843     Dave #define	DUMP_MAX_NHELPER	DUMP_MAX_TAG
    141  10843     Dave 
    142  10843     Dave /*
    143  10843     Dave  * The dump data header is placed after the dumphdr in the compressed
    144  10843     Dave  * image. It is not needed after savecore runs and the data pages have
    145  10843     Dave  * been decompressed.
    146  10843     Dave  */
    147  10843     Dave typedef struct dumpdatahdr {
    148  10843     Dave 	uint32_t dump_datahdr_magic;	/* data header presence */
    149  10843     Dave 	uint32_t dump_datahdr_version;	/* data header version */
    150  10843     Dave 	uint64_t dump_data_csize;	/* compressed data size */
    151  10843     Dave 	uint32_t dump_maxcsize;		/* compressed data max block size */
    152  10843     Dave 	uint32_t dump_maxrange;		/* max number of pages per range */
    153  10843     Dave 	uint16_t dump_nstreams;		/* number of compression streams */
    154  10843     Dave 	uint16_t dump_clevel;		/* compression level (0-9) */
    155  10843     Dave 	uint32_t dump_metrics;		/* size of metrics data */
    156  10843     Dave } dumpdatahdr_t;
    157  10843     Dave 
    158  10843     Dave #define	DUMP_DATAHDR_MAGIC	('d' << 24 | 'h' << 16 | 'd' << 8 | 'r')
    159  10843     Dave 
    160  10843     Dave #define	DUMP_DATAHDR_VERSION	1
    161  10843     Dave #define	DUMP_CLEVEL_LZJB	1	/* parallel lzjb compression */
    162  10843     Dave #define	DUMP_CLEVEL_BZIP2	2	/* parallel bzip2 level 1 */
    163  10843     Dave 
    164      0   stevel #ifdef _KERNEL
    165      0   stevel 
    166      0   stevel extern kmutex_t dump_lock;
    167      0   stevel extern struct vnode *dumpvp;
    168      0   stevel extern u_offset_t dumpvp_size;
    169      0   stevel extern struct dumphdr *dumphdr;
    170      0   stevel extern int dump_conflags;
    171      0   stevel extern char *dumppath;
    172      0   stevel 
    173      0   stevel extern int dump_timeout;
    174      0   stevel extern int dump_timeleft;
    175   5084  johnlev extern int dump_ioerr;
    176      0   stevel extern int sync_timeout;
    177      0   stevel extern int sync_timeleft;
    178      0   stevel 
    179      0   stevel extern int dumpinit(struct vnode *, char *, int);
    180      0   stevel extern void dumpfini(void);
    181      0   stevel extern void dump_resize(void);
    182      0   stevel extern void dump_page(pfn_t);
    183      0   stevel extern void dump_addpage(struct as *, void *, pfn_t);
    184      0   stevel extern void dumpsys(void);
    185  10843     Dave extern void dumpsys_helper(void);
    186      0   stevel extern void dump_messages(void);
    187      0   stevel extern void dump_ereports(void);
    188      0   stevel extern void dumpvp_write(const void *, size_t);
    189   6423  gw25295 extern int dumpvp_resize(void);
    190   3446      mrj extern int dump_plat_addr(void);
    191   3446      mrj extern void dump_plat_pfn(void);
    192   3446      mrj extern int dump_plat_data(void *);
    193      0   stevel 
    194  10843     Dave /*
    195  10843     Dave  * Define a CPU count threshold that determines when to employ
    196  10843     Dave  * bzip2. The values are defined per-platform in dump_plat_mincpu, and
    197  10843     Dave  * may be changed with /etc/system. The value 0 disables parallelism,
    198  10843     Dave  * and the old format dump is produced.
    199  10843     Dave  */
    200  10843     Dave extern uint_t dump_plat_mincpu;
    201  10843     Dave 
    202  10843     Dave #define	DUMP_PLAT_SUN4U_MINCPU		51
    203  10843     Dave #define	DUMP_PLAT_SUN4U_OPL_MINCPU	8
    204  10843     Dave #define	DUMP_PLAT_SUN4V_MINCPU		128
    205  10843     Dave #define	DUMP_PLAT_X86_64_MINCPU		11
    206  10843     Dave #define	DUMP_PLAT_X86_32_MINCPU		0
    207  10843     Dave 
    208  10843     Dave /*
    209  10843     Dave  * Pages may be stolen at dump time. Prevent the pages from ever being
    210  10843     Dave  * allocated while dump is running.
    211  10843     Dave  */
    212  10843     Dave #define	IS_DUMP_PAGE(pp) (dump_check_used && dump_test_used((pp)->p_pagenum))
    213  10843     Dave 
    214  10843     Dave extern int dump_test_used(pfn_t);
    215  10843     Dave extern int dump_check_used;
    216  10843     Dave 
    217      0   stevel #endif /* _KERNEL */
    218      0   stevel 
    219      0   stevel #ifdef	__cplusplus
    220      0   stevel }
    221      0   stevel #endif
    222      0   stevel 
    223      0   stevel #endif	/* _SYS_DUMPHDR_H */
    224