1*4d3c95f5SJorgen Lundman /* 2*4d3c95f5SJorgen Lundman * GRUB -- GRand Unified Bootloader 3*4d3c95f5SJorgen Lundman * Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 4*4d3c95f5SJorgen Lundman * 5*4d3c95f5SJorgen Lundman * This program is free software; you can redistribute it and/or modify 6*4d3c95f5SJorgen Lundman * it under the terms of the GNU General Public License as published by 7*4d3c95f5SJorgen Lundman * the Free Software Foundation; either version 2 of the License, or 8*4d3c95f5SJorgen Lundman * (at your option) any later version. 9*4d3c95f5SJorgen Lundman * 10*4d3c95f5SJorgen Lundman * This program is distributed in the hope that it will be useful, 11*4d3c95f5SJorgen Lundman * but WITHOUT ANY WARRANTY; without even the implied warranty of 12*4d3c95f5SJorgen Lundman * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13*4d3c95f5SJorgen Lundman * GNU General Public License for more details. 14*4d3c95f5SJorgen Lundman * 15*4d3c95f5SJorgen Lundman * You should have received a copy of the GNU General Public License 16*4d3c95f5SJorgen Lundman * along with this program; if not, write to the Free Software 17*4d3c95f5SJorgen Lundman * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18*4d3c95f5SJorgen Lundman */ 19*4d3c95f5SJorgen Lundman /* 20*4d3c95f5SJorgen Lundman * Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved. 21*4d3c95f5SJorgen Lundman */ 22*4d3c95f5SJorgen Lundman 23*4d3c95f5SJorgen Lundman #ifndef _SYS_ZAP_IMPL_H 24*4d3c95f5SJorgen Lundman #define _SYS_ZAP_IMPL_H 25*4d3c95f5SJorgen Lundman 26*4d3c95f5SJorgen Lundman #define ZAP_MAGIC 0x2F52AB2ABULL 27*4d3c95f5SJorgen Lundman 28*4d3c95f5SJorgen Lundman #define ZAP_HASHBITS 28 29*4d3c95f5SJorgen Lundman #define MZAP_ENT_LEN 64 30*4d3c95f5SJorgen Lundman #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 31*4d3c95f5SJorgen Lundman #define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT 32*4d3c95f5SJorgen Lundman #define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT) 33*4d3c95f5SJorgen Lundman 34*4d3c95f5SJorgen Lundman typedef struct mzap_ent_phys { 35*4d3c95f5SJorgen Lundman uint64_t mze_value; 36*4d3c95f5SJorgen Lundman uint32_t mze_cd; 37*4d3c95f5SJorgen Lundman uint16_t mze_pad; /* in case we want to chain them someday */ 38*4d3c95f5SJorgen Lundman char mze_name[MZAP_NAME_LEN]; 39*4d3c95f5SJorgen Lundman } mzap_ent_phys_t; 40*4d3c95f5SJorgen Lundman 41*4d3c95f5SJorgen Lundman typedef struct mzap_phys { 42*4d3c95f5SJorgen Lundman uint64_t mz_block_type; /* ZBT_MICRO */ 43*4d3c95f5SJorgen Lundman uint64_t mz_salt; 44*4d3c95f5SJorgen Lundman uint64_t mz_pad[6]; 45*4d3c95f5SJorgen Lundman mzap_ent_phys_t mz_chunk[1]; 46*4d3c95f5SJorgen Lundman /* actually variable size depending on block size */ 47*4d3c95f5SJorgen Lundman } mzap_phys_t; 48*4d3c95f5SJorgen Lundman 49*4d3c95f5SJorgen Lundman /* 50*4d3c95f5SJorgen Lundman * The (fat) zap is stored in one object. It is an array of 51*4d3c95f5SJorgen Lundman * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 52*4d3c95f5SJorgen Lundman * 53*4d3c95f5SJorgen Lundman * ptrtbl fits in first block: 54*4d3c95f5SJorgen Lundman * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 55*4d3c95f5SJorgen Lundman * 56*4d3c95f5SJorgen Lundman * ptrtbl too big for first block: 57*4d3c95f5SJorgen Lundman * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 58*4d3c95f5SJorgen Lundman * 59*4d3c95f5SJorgen Lundman */ 60*4d3c95f5SJorgen Lundman 61*4d3c95f5SJorgen Lundman #define ZBT_LEAF ((1ULL << 63) + 0) 62*4d3c95f5SJorgen Lundman #define ZBT_HEADER ((1ULL << 63) + 1) 63*4d3c95f5SJorgen Lundman #define ZBT_MICRO ((1ULL << 63) + 3) 64*4d3c95f5SJorgen Lundman /* any other values are ptrtbl blocks */ 65*4d3c95f5SJorgen Lundman 66*4d3c95f5SJorgen Lundman /* 67*4d3c95f5SJorgen Lundman * the embedded pointer table takes up half a block: 68*4d3c95f5SJorgen Lundman * block size / entry size (2^3) / 2 69*4d3c95f5SJorgen Lundman */ 70*4d3c95f5SJorgen Lundman #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 71*4d3c95f5SJorgen Lundman 72*4d3c95f5SJorgen Lundman /* 73*4d3c95f5SJorgen Lundman * The embedded pointer table starts half-way through the block. Since 74*4d3c95f5SJorgen Lundman * the pointer table itself is half the block, it starts at (64-bit) 75*4d3c95f5SJorgen Lundman * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 76*4d3c95f5SJorgen Lundman */ 77*4d3c95f5SJorgen Lundman #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 78*4d3c95f5SJorgen Lundman ((uint64_t *)(zap)->zap_f.zap_phys) \ 79*4d3c95f5SJorgen Lundman [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 80*4d3c95f5SJorgen Lundman 81*4d3c95f5SJorgen Lundman /* 82*4d3c95f5SJorgen Lundman * TAKE NOTE: 83*4d3c95f5SJorgen Lundman * If zap_phys_t is modified, zap_byteswap() must be modified. 84*4d3c95f5SJorgen Lundman */ 85*4d3c95f5SJorgen Lundman typedef struct zap_phys { 86*4d3c95f5SJorgen Lundman uint64_t zap_block_type; /* ZBT_HEADER */ 87*4d3c95f5SJorgen Lundman uint64_t zap_magic; /* ZAP_MAGIC */ 88*4d3c95f5SJorgen Lundman 89*4d3c95f5SJorgen Lundman struct zap_table_phys { 90*4d3c95f5SJorgen Lundman uint64_t zt_blk; /* starting block number */ 91*4d3c95f5SJorgen Lundman uint64_t zt_numblks; /* number of blocks */ 92*4d3c95f5SJorgen Lundman uint64_t zt_shift; /* bits to index it */ 93*4d3c95f5SJorgen Lundman uint64_t zt_nextblk; /* next (larger) copy start block */ 94*4d3c95f5SJorgen Lundman uint64_t zt_blks_copied; /* number source blocks copied */ 95*4d3c95f5SJorgen Lundman } zap_ptrtbl; 96*4d3c95f5SJorgen Lundman 97*4d3c95f5SJorgen Lundman uint64_t zap_freeblk; /* the next free block */ 98*4d3c95f5SJorgen Lundman uint64_t zap_num_leafs; /* number of leafs */ 99*4d3c95f5SJorgen Lundman uint64_t zap_num_entries; /* number of entries */ 100*4d3c95f5SJorgen Lundman uint64_t zap_salt; /* salt to stir into hash function */ 101*4d3c95f5SJorgen Lundman uint64_t zap_normflags; /* flags for u8_textprep_str() */ 102*4d3c95f5SJorgen Lundman uint64_t zap_flags; /* zap_flag_t */ 103*4d3c95f5SJorgen Lundman /* 104*4d3c95f5SJorgen Lundman * This structure is followed by padding, and then the embedded 105*4d3c95f5SJorgen Lundman * pointer table. The embedded pointer table takes up second 106*4d3c95f5SJorgen Lundman * half of the block. It is accessed using the 107*4d3c95f5SJorgen Lundman * ZAP_EMBEDDED_PTRTBL_ENT() macro. 108*4d3c95f5SJorgen Lundman */ 109*4d3c95f5SJorgen Lundman } zap_phys_t; 110*4d3c95f5SJorgen Lundman 111*4d3c95f5SJorgen Lundman #endif /* _SYS_ZAP_IMPL_H */ 112