zap_impl.h 3.6 KB

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