1*83d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */ 24d3c95f5SJorgen Lundman /* 34d3c95f5SJorgen Lundman * GRUB -- GRand Unified Bootloader 44d3c95f5SJorgen Lundman * Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 54d3c95f5SJorgen Lundman */ 64d3c95f5SJorgen Lundman /* 74d3c95f5SJorgen Lundman * Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved. 84d3c95f5SJorgen Lundman */ 94d3c95f5SJorgen Lundman 104d3c95f5SJorgen Lundman #ifndef _SYS_ZAP_IMPL_H 114d3c95f5SJorgen Lundman #define _SYS_ZAP_IMPL_H 124d3c95f5SJorgen Lundman 134d3c95f5SJorgen Lundman #define ZAP_MAGIC 0x2F52AB2ABULL 144d3c95f5SJorgen Lundman 154d3c95f5SJorgen Lundman #define ZAP_HASHBITS 28 164d3c95f5SJorgen Lundman #define MZAP_ENT_LEN 64 174d3c95f5SJorgen Lundman #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 184d3c95f5SJorgen Lundman #define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT 194d3c95f5SJorgen Lundman #define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT) 204d3c95f5SJorgen Lundman 214d3c95f5SJorgen Lundman typedef struct mzap_ent_phys { 224d3c95f5SJorgen Lundman uint64_t mze_value; 234d3c95f5SJorgen Lundman uint32_t mze_cd; 244d3c95f5SJorgen Lundman uint16_t mze_pad; /* in case we want to chain them someday */ 254d3c95f5SJorgen Lundman char mze_name[MZAP_NAME_LEN]; 264d3c95f5SJorgen Lundman } mzap_ent_phys_t; 274d3c95f5SJorgen Lundman 284d3c95f5SJorgen Lundman typedef struct mzap_phys { 294d3c95f5SJorgen Lundman uint64_t mz_block_type; /* ZBT_MICRO */ 304d3c95f5SJorgen Lundman uint64_t mz_salt; 314d3c95f5SJorgen Lundman uint64_t mz_pad[6]; 324d3c95f5SJorgen Lundman mzap_ent_phys_t mz_chunk[1]; 334d3c95f5SJorgen Lundman /* actually variable size depending on block size */ 344d3c95f5SJorgen Lundman } mzap_phys_t; 354d3c95f5SJorgen Lundman 364d3c95f5SJorgen Lundman /* 374d3c95f5SJorgen Lundman * The (fat) zap is stored in one object. It is an array of 384d3c95f5SJorgen Lundman * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 394d3c95f5SJorgen Lundman * 404d3c95f5SJorgen Lundman * ptrtbl fits in first block: 414d3c95f5SJorgen Lundman * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 424d3c95f5SJorgen Lundman * 434d3c95f5SJorgen Lundman * ptrtbl too big for first block: 444d3c95f5SJorgen Lundman * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 454d3c95f5SJorgen Lundman * 464d3c95f5SJorgen Lundman */ 474d3c95f5SJorgen Lundman 484d3c95f5SJorgen Lundman #define ZBT_LEAF ((1ULL << 63) + 0) 494d3c95f5SJorgen Lundman #define ZBT_HEADER ((1ULL << 63) + 1) 504d3c95f5SJorgen Lundman #define ZBT_MICRO ((1ULL << 63) + 3) 514d3c95f5SJorgen Lundman /* any other values are ptrtbl blocks */ 524d3c95f5SJorgen Lundman 534d3c95f5SJorgen Lundman /* 544d3c95f5SJorgen Lundman * the embedded pointer table takes up half a block: 554d3c95f5SJorgen Lundman * block size / entry size (2^3) / 2 564d3c95f5SJorgen Lundman */ 574d3c95f5SJorgen Lundman #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 584d3c95f5SJorgen Lundman 594d3c95f5SJorgen Lundman /* 604d3c95f5SJorgen Lundman * The embedded pointer table starts half-way through the block. Since 614d3c95f5SJorgen Lundman * the pointer table itself is half the block, it starts at (64-bit) 624d3c95f5SJorgen Lundman * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 634d3c95f5SJorgen Lundman */ 644d3c95f5SJorgen Lundman #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 654d3c95f5SJorgen Lundman ((uint64_t *)(zap)->zap_f.zap_phys) \ 664d3c95f5SJorgen Lundman [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 674d3c95f5SJorgen Lundman 684d3c95f5SJorgen Lundman /* 694d3c95f5SJorgen Lundman * TAKE NOTE: 704d3c95f5SJorgen Lundman * If zap_phys_t is modified, zap_byteswap() must be modified. 714d3c95f5SJorgen Lundman */ 724d3c95f5SJorgen Lundman typedef struct zap_phys { 734d3c95f5SJorgen Lundman uint64_t zap_block_type; /* ZBT_HEADER */ 744d3c95f5SJorgen Lundman uint64_t zap_magic; /* ZAP_MAGIC */ 754d3c95f5SJorgen Lundman 764d3c95f5SJorgen Lundman struct zap_table_phys { 774d3c95f5SJorgen Lundman uint64_t zt_blk; /* starting block number */ 784d3c95f5SJorgen Lundman uint64_t zt_numblks; /* number of blocks */ 794d3c95f5SJorgen Lundman uint64_t zt_shift; /* bits to index it */ 804d3c95f5SJorgen Lundman uint64_t zt_nextblk; /* next (larger) copy start block */ 814d3c95f5SJorgen Lundman uint64_t zt_blks_copied; /* number source blocks copied */ 824d3c95f5SJorgen Lundman } zap_ptrtbl; 834d3c95f5SJorgen Lundman 844d3c95f5SJorgen Lundman uint64_t zap_freeblk; /* the next free block */ 854d3c95f5SJorgen Lundman uint64_t zap_num_leafs; /* number of leafs */ 864d3c95f5SJorgen Lundman uint64_t zap_num_entries; /* number of entries */ 874d3c95f5SJorgen Lundman uint64_t zap_salt; /* salt to stir into hash function */ 884d3c95f5SJorgen Lundman uint64_t zap_normflags; /* flags for u8_textprep_str() */ 894d3c95f5SJorgen Lundman uint64_t zap_flags; /* zap_flag_t */ 904d3c95f5SJorgen Lundman /* 914d3c95f5SJorgen Lundman * This structure is followed by padding, and then the embedded 924d3c95f5SJorgen Lundman * pointer table. The embedded pointer table takes up second 934d3c95f5SJorgen Lundman * half of the block. It is accessed using the 944d3c95f5SJorgen Lundman * ZAP_EMBEDDED_PTRTBL_ENT() macro. 954d3c95f5SJorgen Lundman */ 964d3c95f5SJorgen Lundman } zap_phys_t; 974d3c95f5SJorgen Lundman 984d3c95f5SJorgen Lundman #endif /* _SYS_ZAP_IMPL_H */ 99