17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5ae115bc7Smrj * Common Development and Distribution License (the "License"). 6ae115bc7Smrj * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 217c478bd9Sstevel@tonic-gate /* 2280f5ed81SDave Plauger * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved. 233f11de9dSSara Hartse * Copyright (c) 2016 by Delphix. All rights reserved. 247c478bd9Sstevel@tonic-gate */ 257c478bd9Sstevel@tonic-gate 267c478bd9Sstevel@tonic-gate #ifndef _SYS_DUMPHDR_H 277c478bd9Sstevel@tonic-gate #define _SYS_DUMPHDR_H 287c478bd9Sstevel@tonic-gate 297c478bd9Sstevel@tonic-gate #include <sys/types.h> 307c478bd9Sstevel@tonic-gate #include <sys/param.h> 317c478bd9Sstevel@tonic-gate #include <sys/utsname.h> 327c478bd9Sstevel@tonic-gate #include <sys/log.h> 337c478bd9Sstevel@tonic-gate 347c478bd9Sstevel@tonic-gate #ifdef __cplusplus 357c478bd9Sstevel@tonic-gate extern "C" { 367c478bd9Sstevel@tonic-gate #endif 377c478bd9Sstevel@tonic-gate 387c478bd9Sstevel@tonic-gate /* 397c478bd9Sstevel@tonic-gate * The dump header describes the contents of a crash dump. Two headers 407c478bd9Sstevel@tonic-gate * are written out: one at the beginning of the dump, and the other at 417c478bd9Sstevel@tonic-gate * the very end of the dump device. The terminal header is at a known 427c478bd9Sstevel@tonic-gate * location (end of device) so we can always find it. The initial header 43*bbf21555SRichard Lowe * is redundant, but helps savecore(8) determine whether the dump has been 44*bbf21555SRichard Lowe * overwritten by swap activity. See dumpadm(8) for dump configuration. 457c478bd9Sstevel@tonic-gate */ 467c478bd9Sstevel@tonic-gate #define DUMP_MAGIC 0xdefec8edU /* dump magic number */ 47f6e214c7SGavin Maltby #define DUMP_VERSION 10 /* version of this dumphdr */ 487c478bd9Sstevel@tonic-gate #define DUMP_WORDSIZE (sizeof (long) * NBBY) /* word size (32 or 64) */ 497c478bd9Sstevel@tonic-gate #define DUMP_PANICSIZE 200 /* Max panic string copied */ 507c478bd9Sstevel@tonic-gate #define DUMP_COMPRESS_RATIO 2 /* conservative; usually 2.5+ */ 517c478bd9Sstevel@tonic-gate #define DUMP_OFFSET 65536 /* pad at start/end of dev */ 527c478bd9Sstevel@tonic-gate #define DUMP_LOGSIZE (2 * LOG_HIWAT) /* /dev/log message save area */ 537c478bd9Sstevel@tonic-gate #define DUMP_ERPTSIZE (P2ROUNDUP( \ 547c478bd9Sstevel@tonic-gate (ERPT_DATA_SZ / 2) * \ 557c478bd9Sstevel@tonic-gate (ERPT_EVCH_MAX + \ 567c478bd9Sstevel@tonic-gate ERPT_MAX_ERRS * ERPT_HIWAT), \ 577c478bd9Sstevel@tonic-gate DUMP_OFFSET)) /* ereport save area */ 58f6e214c7SGavin Maltby #define DUMP_SUMMARYSIZE (P2ROUNDUP( \ 59f6e214c7SGavin Maltby (STACK_BUF_SIZE + \ 60f6e214c7SGavin Maltby sizeof (summary_dump_t) + 1024), \ 61f6e214c7SGavin Maltby DUMP_OFFSET)) /* summary save area */ 627c478bd9Sstevel@tonic-gate 637c478bd9Sstevel@tonic-gate typedef struct dumphdr { 647c478bd9Sstevel@tonic-gate uint32_t dump_magic; /* magic number */ 657c478bd9Sstevel@tonic-gate uint32_t dump_version; /* version number */ 667c478bd9Sstevel@tonic-gate uint32_t dump_flags; /* flags; see below */ 677c478bd9Sstevel@tonic-gate uint32_t dump_wordsize; /* 32 or 64 */ 687c478bd9Sstevel@tonic-gate offset_t dump_start; /* starting offset on dump device */ 697c478bd9Sstevel@tonic-gate offset_t dump_ksyms; /* offset of compressed symbol table */ 707c478bd9Sstevel@tonic-gate offset_t dump_pfn; /* offset of pfn table for all pages */ 717c478bd9Sstevel@tonic-gate offset_t dump_map; /* offset of page translation map */ 727c478bd9Sstevel@tonic-gate offset_t dump_data; /* offset of actual dump data */ 737c478bd9Sstevel@tonic-gate struct utsname dump_utsname; /* copy of utsname structure */ 747c478bd9Sstevel@tonic-gate char dump_platform[SYS_NMLN]; /* platform name (uname -i) */ 757c478bd9Sstevel@tonic-gate char dump_panicstring[DUMP_PANICSIZE]; /* copy of panicstr */ 767c478bd9Sstevel@tonic-gate time_t dump_crashtime; /* time of crash */ 777c478bd9Sstevel@tonic-gate long dump_pageshift; /* log2(pagesize) */ 787c478bd9Sstevel@tonic-gate long dump_pagesize; /* pagesize */ 797c478bd9Sstevel@tonic-gate long dump_hashmask; /* page translation hash mask */ 807c478bd9Sstevel@tonic-gate long dump_nvtop; /* number of vtop table entries */ 817c478bd9Sstevel@tonic-gate pgcnt_t dump_npages; /* number of data pages */ 827c478bd9Sstevel@tonic-gate size_t dump_ksyms_size; /* kernel symbol table size */ 837c478bd9Sstevel@tonic-gate size_t dump_ksyms_csize; /* compressed symbol table size */ 84f6e214c7SGavin Maltby uint32_t dump_fm_panic; /* initiated from fm subsystems */ 85f6e214c7SGavin Maltby char dump_uuid[36 + 1]; /* os image uuid */ 867c478bd9Sstevel@tonic-gate } dumphdr_t; 877c478bd9Sstevel@tonic-gate 887c478bd9Sstevel@tonic-gate /* 897c478bd9Sstevel@tonic-gate * Values for dump_flags 907c478bd9Sstevel@tonic-gate */ 917c478bd9Sstevel@tonic-gate #define DF_VALID 0x00000001 /* Dump is valid (savecore clears) */ 927c478bd9Sstevel@tonic-gate #define DF_COMPLETE 0x00000002 /* All pages present as configured */ 937c478bd9Sstevel@tonic-gate #define DF_LIVE 0x00000004 /* Dump was taken on a live system */ 94ca3e8d88SDave Plauger #define DF_COMPRESSED 0x00000008 /* Dump is compressed */ 957c478bd9Sstevel@tonic-gate #define DF_KERNEL 0x00010000 /* Contains kernel pages only */ 967c478bd9Sstevel@tonic-gate #define DF_ALL 0x00020000 /* Contains all pages */ 977c478bd9Sstevel@tonic-gate #define DF_CURPROC 0x00040000 /* Contains kernel + cur proc pages */ 987c478bd9Sstevel@tonic-gate #define DF_CONTENT 0xffff0000 /* The set of all dump content flags */ 997c478bd9Sstevel@tonic-gate 1007c478bd9Sstevel@tonic-gate /* 1017c478bd9Sstevel@tonic-gate * Dump translation map hash table entry. 1027c478bd9Sstevel@tonic-gate */ 1037c478bd9Sstevel@tonic-gate typedef struct dump_map { 1047c478bd9Sstevel@tonic-gate offset_t dm_first; 1057c478bd9Sstevel@tonic-gate offset_t dm_next; 1067c478bd9Sstevel@tonic-gate offset_t dm_data; 1077c478bd9Sstevel@tonic-gate struct as *dm_as; 1087c478bd9Sstevel@tonic-gate uintptr_t dm_va; 1097c478bd9Sstevel@tonic-gate } dump_map_t; 1107c478bd9Sstevel@tonic-gate 1117c478bd9Sstevel@tonic-gate /* 1127c478bd9Sstevel@tonic-gate * Dump translation map hash function. 1137c478bd9Sstevel@tonic-gate */ 1147c478bd9Sstevel@tonic-gate #define DUMP_HASH(dhp, as, va) \ 1157c478bd9Sstevel@tonic-gate ((((uintptr_t)(as) >> 3) + ((va) >> (dhp)->dump_pageshift)) & \ 1167c478bd9Sstevel@tonic-gate (dhp)->dump_hashmask) 1177c478bd9Sstevel@tonic-gate 118ca3e8d88SDave Plauger /* 119ca3e8d88SDave Plauger * Encoding of the csize word used to provide meta information 120ca3e8d88SDave Plauger * between dumpsys and savecore. 121ca3e8d88SDave Plauger * 122ca3e8d88SDave Plauger * tag size 123ca3e8d88SDave Plauger * 1-4095 1..dump_maxcsize stream block 124ca3e8d88SDave Plauger * 0 1..pagesize one lzjb page 125ca3e8d88SDave Plauger * 0 0 marks end of data 126ca3e8d88SDave Plauger */ 127ca3e8d88SDave Plauger typedef uint32_t dumpcsize_t; 128ca3e8d88SDave Plauger 129ca3e8d88SDave Plauger #define DUMP_MAX_TAG (0xfffU) 130ca3e8d88SDave Plauger #define DUMP_MAX_CSIZE (0xfffffU) 131ca3e8d88SDave Plauger #define DUMP_SET_TAG(w, v) (((w) & DUMP_MAX_CSIZE) | ((v) << 20)) 132ca3e8d88SDave Plauger #define DUMP_GET_TAG(w) (((w) >> 20) & DUMP_MAX_TAG) 133ca3e8d88SDave Plauger #define DUMP_SET_CSIZE(w, v) \ 134ca3e8d88SDave Plauger (((w) & (DUMP_MAX_TAG << 20)) | ((v) & DUMP_MAX_CSIZE)) 135ca3e8d88SDave Plauger #define DUMP_GET_CSIZE(w) ((w) & DUMP_MAX_CSIZE) 136ca3e8d88SDave Plauger 137ca3e8d88SDave Plauger typedef struct dumpstreamhdr { 138ca3e8d88SDave Plauger char stream_magic[8]; /* "StrmHdr" */ 139ca3e8d88SDave Plauger pgcnt_t stream_pagenum; /* starting pfn */ 140ca3e8d88SDave Plauger pgcnt_t stream_npages; /* uncompressed size */ 141ca3e8d88SDave Plauger } dumpstreamhdr_t; 142ca3e8d88SDave Plauger 143ca3e8d88SDave Plauger #define DUMP_STREAM_MAGIC "StrmHdr" 144ca3e8d88SDave Plauger 145ca3e8d88SDave Plauger /* The number of helpers is limited by the number of stream tags. */ 146ca3e8d88SDave Plauger #define DUMP_MAX_NHELPER DUMP_MAX_TAG 147ca3e8d88SDave Plauger 148ca3e8d88SDave Plauger /* 149ca3e8d88SDave Plauger * The dump data header is placed after the dumphdr in the compressed 150ca3e8d88SDave Plauger * image. It is not needed after savecore runs and the data pages have 151ca3e8d88SDave Plauger * been decompressed. 152ca3e8d88SDave Plauger */ 153ca3e8d88SDave Plauger typedef struct dumpdatahdr { 154ca3e8d88SDave Plauger uint32_t dump_datahdr_magic; /* data header presence */ 155ca3e8d88SDave Plauger uint32_t dump_datahdr_version; /* data header version */ 156ca3e8d88SDave Plauger uint64_t dump_data_csize; /* compressed data size */ 157ca3e8d88SDave Plauger uint32_t dump_maxcsize; /* compressed data max block size */ 158ca3e8d88SDave Plauger uint32_t dump_maxrange; /* max number of pages per range */ 159ca3e8d88SDave Plauger uint16_t dump_nstreams; /* number of compression streams */ 160ca3e8d88SDave Plauger uint16_t dump_clevel; /* compression level (0-9) */ 161ca3e8d88SDave Plauger uint32_t dump_metrics; /* size of metrics data */ 162ca3e8d88SDave Plauger } dumpdatahdr_t; 163ca3e8d88SDave Plauger 164ca3e8d88SDave Plauger #define DUMP_DATAHDR_MAGIC ('d' << 24 | 'h' << 16 | 'd' << 8 | 'r') 165ca3e8d88SDave Plauger 166ca3e8d88SDave Plauger #define DUMP_DATAHDR_VERSION 1 167ca3e8d88SDave Plauger #define DUMP_CLEVEL_LZJB 1 /* parallel lzjb compression */ 168ca3e8d88SDave Plauger #define DUMP_CLEVEL_BZIP2 2 /* parallel bzip2 level 1 */ 169ca3e8d88SDave Plauger 1707c478bd9Sstevel@tonic-gate #ifdef _KERNEL 1717c478bd9Sstevel@tonic-gate 1727c478bd9Sstevel@tonic-gate extern kmutex_t dump_lock; 1737c478bd9Sstevel@tonic-gate extern struct vnode *dumpvp; 1747c478bd9Sstevel@tonic-gate extern u_offset_t dumpvp_size; 1757c478bd9Sstevel@tonic-gate extern struct dumphdr *dumphdr; 1767c478bd9Sstevel@tonic-gate extern int dump_conflags; 1777c478bd9Sstevel@tonic-gate extern char *dumppath; 1787c478bd9Sstevel@tonic-gate 1797c478bd9Sstevel@tonic-gate extern int dump_timeout; 1807c478bd9Sstevel@tonic-gate extern int dump_timeleft; 181843e1988Sjohnlev extern int dump_ioerr; 1827c478bd9Sstevel@tonic-gate 1837c478bd9Sstevel@tonic-gate extern int dumpinit(struct vnode *, char *, int); 1847c478bd9Sstevel@tonic-gate extern void dumpfini(void); 1857c478bd9Sstevel@tonic-gate extern void dump_resize(void); 1867c478bd9Sstevel@tonic-gate extern void dump_page(pfn_t); 1877c478bd9Sstevel@tonic-gate extern void dump_addpage(struct as *, void *, pfn_t); 1887c478bd9Sstevel@tonic-gate extern void dumpsys(void); 189ca3e8d88SDave Plauger extern void dumpsys_helper(void); 19080f5ed81SDave Plauger extern void dumpsys_helper_nw(void); 1917c478bd9Sstevel@tonic-gate extern void dump_messages(void); 1927c478bd9Sstevel@tonic-gate extern void dump_ereports(void); 1937c478bd9Sstevel@tonic-gate extern void dumpvp_write(const void *, size_t); 194e7cbe64fSgw extern int dumpvp_resize(void); 195ae115bc7Smrj extern int dump_plat_addr(void); 196ae115bc7Smrj extern void dump_plat_pfn(void); 197ae115bc7Smrj extern int dump_plat_data(void *); 198f6e214c7SGavin Maltby extern int dump_set_uuid(const char *); 199f6e214c7SGavin Maltby extern const char *dump_get_uuid(void); 2007c478bd9Sstevel@tonic-gate 201ca3e8d88SDave Plauger /* 202ca3e8d88SDave Plauger * Define a CPU count threshold that determines when to employ 2034cca9c84SDave Plauger * bzip2. This value is defined per-platform. 204ca3e8d88SDave Plauger */ 2054cca9c84SDave Plauger extern uint_t dump_plat_mincpu_default; 206ca3e8d88SDave Plauger 207c523716aSRichard Lowe #define DUMP_PLAT_SUN4U_MINCPU 0 208c523716aSRichard Lowe #define DUMP_PLAT_SUN4U_OPL_MINCPU 0 209c523716aSRichard Lowe #define DUMP_PLAT_SUN4V_MINCPU 0 210c523716aSRichard Lowe #define DUMP_PLAT_X86_64_MINCPU 0 211ca3e8d88SDave Plauger #define DUMP_PLAT_X86_32_MINCPU 0 212ca3e8d88SDave Plauger 2134cca9c84SDave Plauger /* 2144cca9c84SDave Plauger * Override the per-platform default by setting this variable with 2154cca9c84SDave Plauger * /etc/system. The value 0 disables parallelism, and the old format 2164cca9c84SDave Plauger * dump is produced. 2174cca9c84SDave Plauger */ 2184cca9c84SDave Plauger extern uint_t dump_plat_mincpu; 2194cca9c84SDave Plauger 220ca3e8d88SDave Plauger /* 221ca3e8d88SDave Plauger * Pages may be stolen at dump time. Prevent the pages from ever being 222ca3e8d88SDave Plauger * allocated while dump is running. 223ca3e8d88SDave Plauger */ 224ca3e8d88SDave Plauger #define IS_DUMP_PAGE(pp) (dump_check_used && dump_test_used((pp)->p_pagenum)) 225ca3e8d88SDave Plauger 226ca3e8d88SDave Plauger extern int dump_test_used(pfn_t); 227ca3e8d88SDave Plauger extern int dump_check_used; 228ca3e8d88SDave Plauger 2297c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 2307c478bd9Sstevel@tonic-gate 2317c478bd9Sstevel@tonic-gate #ifdef __cplusplus 2327c478bd9Sstevel@tonic-gate } 2337c478bd9Sstevel@tonic-gate #endif 2347c478bd9Sstevel@tonic-gate 2357c478bd9Sstevel@tonic-gate #endif /* _SYS_DUMPHDR_H */ 236