1185029Spjd/*- 2185029Spjd * Copyright (c) 2002 McAfee, Inc. 3185029Spjd * All rights reserved. 4185029Spjd * 5185029Spjd * This software was developed for the FreeBSD Project by Marshall 6185029Spjd * Kirk McKusick and McAfee Research,, the Security Research Division of 7185029Spjd * McAfee, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as 8185029Spjd * part of the DARPA CHATS research program 9185029Spjd * 10185029Spjd * Redistribution and use in source and binary forms, with or without 11185029Spjd * modification, are permitted provided that the following conditions 12185029Spjd * are met: 13185029Spjd * 1. Redistributions of source code must retain the above copyright 14185029Spjd * notice, this list of conditions and the following disclaimer. 15185029Spjd * 2. Redistributions in binary form must reproduce the above copyright 16185029Spjd * notice, this list of conditions and the following disclaimer in the 17185029Spjd * documentation and/or other materials provided with the distribution. 18185029Spjd * 19185029Spjd * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20185029Spjd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21185029Spjd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22185029Spjd * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23185029Spjd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24185029Spjd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25185029Spjd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26185029Spjd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27185029Spjd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28185029Spjd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29185029Spjd * SUCH DAMAGE. 30185029Spjd */ 31185029Spjd/* 32185029Spjd * CDDL HEADER START 33185029Spjd * 34185029Spjd * The contents of this file are subject to the terms of the 35185029Spjd * Common Development and Distribution License (the "License"). 36185029Spjd * You may not use this file except in compliance with the License. 37185029Spjd * 38185029Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 39185029Spjd * or http://www.opensolaris.org/os/licensing. 40185029Spjd * See the License for the specific language governing permissions 41185029Spjd * and limitations under the License. 42185029Spjd * 43185029Spjd * When distributing Covered Code, include this CDDL HEADER in each 44185029Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 45185029Spjd * If applicable, add the following below this CDDL HEADER, with the 46185029Spjd * fields enclosed by brackets "[]" replaced with your own identifying 47185029Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 48185029Spjd * 49185029Spjd * CDDL HEADER END 50185029Spjd */ 51185029Spjd/* 52209962Smm * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 53185029Spjd * Use is subject to license terms. 54185029Spjd */ 55246586Sdelphij/* 56246586Sdelphij * Copyright 2013 by Saso Kiselkov. All rights reserved. 57246586Sdelphij */ 58268649Sdelphij/* 59268649Sdelphij * Copyright (c) 2013 by Delphix. All rights reserved. 60268649Sdelphij */ 61185029Spjd 62236884Smm#define MAXNAMELEN 256 63236884Smm 64268649Sdelphij#define _NOTE(s) 65268649Sdelphij 66185029Spjd/* CRC64 table */ 67185029Spjd#define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ 68185029Spjd 69185029Spjd/* 70185029Spjd * Macros for various sorts of alignment and rounding when the alignment 71185029Spjd * is known to be a power of 2. 72185029Spjd */ 73185029Spjd#define P2ALIGN(x, align) ((x) & -(align)) 74185029Spjd#define P2PHASE(x, align) ((x) & ((align) - 1)) 75185029Spjd#define P2NPHASE(x, align) (-(x) & ((align) - 1)) 76185029Spjd#define P2ROUNDUP(x, align) (-(-(x) & -(align))) 77185029Spjd#define P2END(x, align) (-(~(x) & -(align))) 78185029Spjd#define P2PHASEUP(x, align, phase) ((phase) - (((phase) - (x)) & -(align))) 79208047Smm#define P2BOUNDARY(off, len, align) (((off) ^ ((off) + (len) - 1)) > (align) - 1) 80185029Spjd 81185029Spjd/* 82185029Spjd * General-purpose 32-bit and 64-bit bitfield encodings. 83185029Spjd */ 84185029Spjd#define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len)) 85185029Spjd#define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len)) 86185029Spjd#define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low)) 87185029Spjd#define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low)) 88185029Spjd 89185029Spjd#define BF32_GET(x, low, len) BF32_DECODE(x, low, len) 90185029Spjd#define BF64_GET(x, low, len) BF64_DECODE(x, low, len) 91185029Spjd 92185029Spjd#define BF32_SET(x, low, len, val) \ 93185029Spjd ((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len)) 94185029Spjd#define BF64_SET(x, low, len, val) \ 95185029Spjd ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)) 96185029Spjd 97185029Spjd#define BF32_GET_SB(x, low, len, shift, bias) \ 98185029Spjd ((BF32_GET(x, low, len) + (bias)) << (shift)) 99185029Spjd#define BF64_GET_SB(x, low, len, shift, bias) \ 100185029Spjd ((BF64_GET(x, low, len) + (bias)) << (shift)) 101185029Spjd 102185029Spjd#define BF32_SET_SB(x, low, len, shift, bias, val) \ 103185029Spjd BF32_SET(x, low, len, ((val) >> (shift)) - (bias)) 104185029Spjd#define BF64_SET_SB(x, low, len, shift, bias, val) \ 105185029Spjd BF64_SET(x, low, len, ((val) >> (shift)) - (bias)) 106185029Spjd 107185029Spjd/* 108219089Spjd * Macros to reverse byte order 109219089Spjd */ 110219089Spjd#define BSWAP_8(x) ((x) & 0xff) 111219089Spjd#define BSWAP_16(x) ((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8)) 112219089Spjd#define BSWAP_32(x) ((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16)) 113219089Spjd#define BSWAP_64(x) ((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32)) 114219089Spjd 115219089Spjd/* 116185029Spjd * We currently support nine block sizes, from 512 bytes to 128K. 117185029Spjd * We could go higher, but the benefits are near-zero and the cost 118185029Spjd * of COWing a giant block to modify one byte would become excessive. 119185029Spjd */ 120185029Spjd#define SPA_MINBLOCKSHIFT 9 121185029Spjd#define SPA_MAXBLOCKSHIFT 17 122185029Spjd#define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT) 123185029Spjd#define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT) 124185029Spjd 125185029Spjd#define SPA_BLOCKSIZES (SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1) 126185029Spjd 127185029Spjd/* 128185029Spjd * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB. 129185029Spjd * The ASIZE encoding should be at least 64 times larger (6 more bits) 130185029Spjd * to support up to 4-way RAID-Z mirror mode with worst-case gang block 131185029Spjd * overhead, three DVAs per bp, plus one more bit in case we do anything 132185029Spjd * else that expands the ASIZE. 133185029Spjd */ 134185029Spjd#define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */ 135185029Spjd#define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */ 136185029Spjd#define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */ 137185029Spjd 138185029Spjd/* 139185029Spjd * All SPA data is represented by 128-bit data virtual addresses (DVAs). 140185029Spjd * The members of the dva_t should be considered opaque outside the SPA. 141185029Spjd */ 142185029Spjdtypedef struct dva { 143185029Spjd uint64_t dva_word[2]; 144185029Spjd} dva_t; 145185029Spjd 146185029Spjd/* 147185029Spjd * Each block has a 256-bit checksum -- strong enough for cryptographic hashes. 148185029Spjd */ 149185029Spjdtypedef struct zio_cksum { 150185029Spjd uint64_t zc_word[4]; 151185029Spjd} zio_cksum_t; 152185029Spjd 153185029Spjd/* 154185029Spjd * Each block is described by its DVAs, time of birth, checksum, etc. 155185029Spjd * The word-by-word, bit-by-bit layout of the blkptr is as follows: 156185029Spjd * 157185029Spjd * 64 56 48 40 32 24 16 8 0 158185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 159185029Spjd * 0 | vdev1 | GRID | ASIZE | 160185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 161185029Spjd * 1 |G| offset1 | 162185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 163185029Spjd * 2 | vdev2 | GRID | ASIZE | 164185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 165185029Spjd * 3 |G| offset2 | 166185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 167185029Spjd * 4 | vdev3 | GRID | ASIZE | 168185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 169185029Spjd * 5 |G| offset3 | 170185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 171268649Sdelphij * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE | 172185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 173185029Spjd * 7 | padding | 174185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 175185029Spjd * 8 | padding | 176185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 177219089Spjd * 9 | physical birth txg | 178185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 179219089Spjd * a | logical birth txg | 180185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 181185029Spjd * b | fill count | 182185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 183185029Spjd * c | checksum[0] | 184185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 185185029Spjd * d | checksum[1] | 186185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 187185029Spjd * e | checksum[2] | 188185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 189185029Spjd * f | checksum[3] | 190185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 191185029Spjd * 192185029Spjd * Legend: 193185029Spjd * 194185029Spjd * vdev virtual device ID 195185029Spjd * offset offset into virtual device 196185029Spjd * LSIZE logical size 197185029Spjd * PSIZE physical size (after compression) 198185029Spjd * ASIZE allocated size (including RAID-Z parity and gang block headers) 199185029Spjd * GRID RAID-Z layout information (reserved for future use) 200185029Spjd * cksum checksum function 201185029Spjd * comp compression function 202185029Spjd * G gang block indicator 203219089Spjd * B byteorder (endianness) 204219089Spjd * D dedup 205268649Sdelphij * X encryption (on version 30, which is not supported) 206268649Sdelphij * E blkptr_t contains embedded data (see below) 207219089Spjd * lvl level of indirection 208185029Spjd * type DMU object type 209219089Spjd * phys birth txg of block allocation; zero if same as logical birth txg 210219089Spjd * log. birth transaction group in which the block was logically born 211185029Spjd * fill count number of non-zero blocks under this bp 212185029Spjd * checksum[4] 256-bit checksum of the data this bp describes 213185029Spjd */ 214268649Sdelphij 215268649Sdelphij/* 216268649Sdelphij * "Embedded" blkptr_t's don't actually point to a block, instead they 217268649Sdelphij * have a data payload embedded in the blkptr_t itself. See the comment 218268649Sdelphij * in blkptr.c for more details. 219268649Sdelphij * 220268649Sdelphij * The blkptr_t is laid out as follows: 221268649Sdelphij * 222268649Sdelphij * 64 56 48 40 32 24 16 8 0 223268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 224268649Sdelphij * 0 | payload | 225268649Sdelphij * 1 | payload | 226268649Sdelphij * 2 | payload | 227268649Sdelphij * 3 | payload | 228268649Sdelphij * 4 | payload | 229268649Sdelphij * 5 | payload | 230268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 231268649Sdelphij * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE | 232268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 233268649Sdelphij * 7 | payload | 234268649Sdelphij * 8 | payload | 235268649Sdelphij * 9 | payload | 236268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 237268649Sdelphij * a | logical birth txg | 238268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 239268649Sdelphij * b | payload | 240268649Sdelphij * c | payload | 241268649Sdelphij * d | payload | 242268649Sdelphij * e | payload | 243268649Sdelphij * f | payload | 244268649Sdelphij * +-------+-------+-------+-------+-------+-------+-------+-------+ 245268649Sdelphij * 246268649Sdelphij * Legend: 247268649Sdelphij * 248268649Sdelphij * payload contains the embedded data 249268649Sdelphij * B (byteorder) byteorder (endianness) 250268649Sdelphij * D (dedup) padding (set to zero) 251268649Sdelphij * X encryption (set to zero; see above) 252268649Sdelphij * E (embedded) set to one 253268649Sdelphij * lvl indirection level 254268649Sdelphij * type DMU object type 255268649Sdelphij * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*) 256268649Sdelphij * comp compression function of payload 257268649Sdelphij * PSIZE size of payload after compression, in bytes 258268649Sdelphij * LSIZE logical size of payload, in bytes 259268649Sdelphij * note that 25 bits is enough to store the largest 260268649Sdelphij * "normal" BP's LSIZE (2^16 * 2^9) in bytes 261268649Sdelphij * log. birth transaction group in which the block was logically born 262268649Sdelphij * 263268649Sdelphij * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded 264268649Sdelphij * bp's they are stored in units of SPA_MINBLOCKSHIFT. 265268649Sdelphij * Generally, the generic BP_GET_*() macros can be used on embedded BP's. 266268649Sdelphij * The B, D, X, lvl, type, and comp fields are stored the same as with normal 267268649Sdelphij * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must 268268649Sdelphij * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before 269268649Sdelphij * other macros, as they assert that they are only used on BP's of the correct 270268649Sdelphij * "embedded-ness". 271268649Sdelphij */ 272268649Sdelphij 273268649Sdelphij#define BPE_GET_ETYPE(bp) \ 274268649Sdelphij (ASSERT(BP_IS_EMBEDDED(bp)), \ 275268649Sdelphij BF64_GET((bp)->blk_prop, 40, 8)) 276268649Sdelphij#define BPE_SET_ETYPE(bp, t) do { \ 277268649Sdelphij ASSERT(BP_IS_EMBEDDED(bp)); \ 278268649Sdelphij BF64_SET((bp)->blk_prop, 40, 8, t); \ 279268649Sdelphij_NOTE(CONSTCOND) } while (0) 280268649Sdelphij 281268649Sdelphij#define BPE_GET_LSIZE(bp) \ 282268649Sdelphij (ASSERT(BP_IS_EMBEDDED(bp)), \ 283268649Sdelphij BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1)) 284268649Sdelphij#define BPE_SET_LSIZE(bp, x) do { \ 285268649Sdelphij ASSERT(BP_IS_EMBEDDED(bp)); \ 286268649Sdelphij BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \ 287268649Sdelphij_NOTE(CONSTCOND) } while (0) 288268649Sdelphij 289268649Sdelphij#define BPE_GET_PSIZE(bp) \ 290268649Sdelphij (ASSERT(BP_IS_EMBEDDED(bp)), \ 291268649Sdelphij BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1)) 292268649Sdelphij#define BPE_SET_PSIZE(bp, x) do { \ 293268649Sdelphij ASSERT(BP_IS_EMBEDDED(bp)); \ 294268649Sdelphij BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \ 295268649Sdelphij_NOTE(CONSTCOND) } while (0) 296268649Sdelphij 297268649Sdelphijtypedef enum bp_embedded_type { 298268649Sdelphij BP_EMBEDDED_TYPE_DATA, 299268649Sdelphij BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */ 300268649Sdelphij NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED 301268649Sdelphij} bp_embedded_type_t; 302268649Sdelphij 303268649Sdelphij#define BPE_NUM_WORDS 14 304268649Sdelphij#define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t)) 305268649Sdelphij#define BPE_IS_PAYLOADWORD(bp, wp) \ 306268649Sdelphij ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth) 307268649Sdelphij 308219089Spjd#define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */ 309219089Spjd#define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */ 310219089Spjd 311185029Spjdtypedef struct blkptr { 312219089Spjd dva_t blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */ 313219089Spjd uint64_t blk_prop; /* size, compression, type, etc */ 314219089Spjd uint64_t blk_pad[2]; /* Extra space for the future */ 315219089Spjd uint64_t blk_phys_birth; /* txg when block was allocated */ 316219089Spjd uint64_t blk_birth; /* transaction group at birth */ 317219089Spjd uint64_t blk_fill; /* fill count */ 318219089Spjd zio_cksum_t blk_cksum; /* 256-bit checksum */ 319185029Spjd} blkptr_t; 320185029Spjd 321185029Spjd/* 322185029Spjd * Macros to get and set fields in a bp or DVA. 323185029Spjd */ 324185029Spjd#define DVA_GET_ASIZE(dva) \ 325263397Sdelphij BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0) 326185029Spjd#define DVA_SET_ASIZE(dva, x) \ 327263397Sdelphij BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \ 328263397Sdelphij SPA_MINBLOCKSHIFT, 0, x) 329185029Spjd 330185029Spjd#define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8) 331185029Spjd#define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x) 332185029Spjd 333185029Spjd#define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32) 334185029Spjd#define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x) 335185029Spjd 336185029Spjd#define DVA_GET_OFFSET(dva) \ 337185029Spjd BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0) 338185029Spjd#define DVA_SET_OFFSET(dva, x) \ 339185029Spjd BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x) 340185029Spjd 341185029Spjd#define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1) 342185029Spjd#define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x) 343185029Spjd 344185029Spjd#define BP_GET_LSIZE(bp) \ 345268649Sdelphij (BP_IS_EMBEDDED(bp) ? \ 346268649Sdelphij (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \ 347263397Sdelphij BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1)) 348268649Sdelphij#define BP_SET_LSIZE(bp, x) do { \ 349268649Sdelphij ASSERT(!BP_IS_EMBEDDED(bp)); \ 350268649Sdelphij BF64_SET_SB((bp)->blk_prop, \ 351268649Sdelphij 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \ 352268649Sdelphij_NOTE(CONSTCOND) } while (0) 353185029Spjd 354185029Spjd#define BP_GET_PSIZE(bp) \ 355263397Sdelphij BF64_GET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1) 356185029Spjd#define BP_SET_PSIZE(bp, x) \ 357263397Sdelphij BF64_SET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x) 358185029Spjd 359268649Sdelphij#define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 7) 360268649Sdelphij#define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 7, x) 361185029Spjd 362185029Spjd#define BP_GET_CHECKSUM(bp) BF64_GET((bp)->blk_prop, 40, 8) 363185029Spjd#define BP_SET_CHECKSUM(bp, x) BF64_SET((bp)->blk_prop, 40, 8, x) 364185029Spjd 365185029Spjd#define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8) 366185029Spjd#define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x) 367185029Spjd 368185029Spjd#define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5) 369185029Spjd#define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x) 370185029Spjd 371268649Sdelphij#define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1) 372268649Sdelphij 373219089Spjd#define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1) 374219089Spjd#define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x) 375219089Spjd 376263397Sdelphij#define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1) 377185029Spjd#define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x) 378185029Spjd 379219089Spjd#define BP_PHYSICAL_BIRTH(bp) \ 380219089Spjd ((bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth) 381219089Spjd 382185029Spjd#define BP_GET_ASIZE(bp) \ 383185029Spjd (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 384185029Spjd DVA_GET_ASIZE(&(bp)->blk_dva[2])) 385185029Spjd 386185029Spjd#define BP_GET_UCSIZE(bp) \ 387185029Spjd ((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \ 388185029Spjd BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp)); 389185029Spjd 390185029Spjd#define BP_GET_NDVAS(bp) \ 391185029Spjd (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \ 392185029Spjd !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 393185029Spjd !!DVA_GET_ASIZE(&(bp)->blk_dva[2])) 394185029Spjd 395185029Spjd#define DVA_EQUAL(dva1, dva2) \ 396185029Spjd ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \ 397185029Spjd (dva1)->dva_word[0] == (dva2)->dva_word[0]) 398185029Spjd 399185029Spjd#define ZIO_CHECKSUM_EQUAL(zc1, zc2) \ 400185029Spjd (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \ 401185029Spjd ((zc1).zc_word[1] - (zc2).zc_word[1]) | \ 402185029Spjd ((zc1).zc_word[2] - (zc2).zc_word[2]) | \ 403185029Spjd ((zc1).zc_word[3] - (zc2).zc_word[3]))) 404185029Spjd 405185029Spjd 406185029Spjd#define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0) 407185029Spjd 408185029Spjd#define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \ 409185029Spjd{ \ 410185029Spjd (zcp)->zc_word[0] = w0; \ 411185029Spjd (zcp)->zc_word[1] = w1; \ 412185029Spjd (zcp)->zc_word[2] = w2; \ 413185029Spjd (zcp)->zc_word[3] = w3; \ 414185029Spjd} 415185029Spjd 416185029Spjd#define BP_IDENTITY(bp) (&(bp)->blk_dva[0]) 417185029Spjd#define BP_IS_GANG(bp) DVA_GET_GANG(BP_IDENTITY(bp)) 418263397Sdelphij#define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \ 419263397Sdelphij (dva)->dva_word[1] == 0ULL) 420263397Sdelphij#define BP_IS_HOLE(bp) DVA_IS_EMPTY(BP_IDENTITY(bp)) 421185029Spjd#define BP_IS_OLDER(bp, txg) (!BP_IS_HOLE(bp) && (bp)->blk_birth < (txg)) 422185029Spjd 423185029Spjd#define BP_ZERO(bp) \ 424185029Spjd{ \ 425185029Spjd (bp)->blk_dva[0].dva_word[0] = 0; \ 426185029Spjd (bp)->blk_dva[0].dva_word[1] = 0; \ 427185029Spjd (bp)->blk_dva[1].dva_word[0] = 0; \ 428185029Spjd (bp)->blk_dva[1].dva_word[1] = 0; \ 429185029Spjd (bp)->blk_dva[2].dva_word[0] = 0; \ 430185029Spjd (bp)->blk_dva[2].dva_word[1] = 0; \ 431185029Spjd (bp)->blk_prop = 0; \ 432185029Spjd (bp)->blk_pad[0] = 0; \ 433185029Spjd (bp)->blk_pad[1] = 0; \ 434219089Spjd (bp)->blk_phys_birth = 0; \ 435185029Spjd (bp)->blk_birth = 0; \ 436185029Spjd (bp)->blk_fill = 0; \ 437185029Spjd ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \ 438185029Spjd} 439185029Spjd 440268649Sdelphij#define BPE_NUM_WORDS 14 441268649Sdelphij#define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t)) 442268649Sdelphij#define BPE_IS_PAYLOADWORD(bp, wp) \ 443268649Sdelphij ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth) 444268649Sdelphij 445219089Spjd/* 446219089Spjd * Embedded checksum 447219089Spjd */ 448219089Spjd#define ZEC_MAGIC 0x210da7ab10c7a11ULL 449185029Spjd 450219089Spjdtypedef struct zio_eck { 451219089Spjd uint64_t zec_magic; /* for validation, endianness */ 452219089Spjd zio_cksum_t zec_cksum; /* 256-bit checksum */ 453219089Spjd} zio_eck_t; 454185029Spjd 455219089Spjd/* 456219089Spjd * Gang block headers are self-checksumming and contain an array 457219089Spjd * of block pointers. 458219089Spjd */ 459219089Spjd#define SPA_GANGBLOCKSIZE SPA_MINBLOCKSIZE 460219089Spjd#define SPA_GBH_NBLKPTRS ((SPA_GANGBLOCKSIZE - \ 461219089Spjd sizeof (zio_eck_t)) / sizeof (blkptr_t)) 462219089Spjd#define SPA_GBH_FILLER ((SPA_GANGBLOCKSIZE - \ 463219089Spjd sizeof (zio_eck_t) - \ 464219089Spjd (SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\ 465219089Spjd sizeof (uint64_t)) 466219089Spjd 467219089Spjdtypedef struct zio_gbh { 468219089Spjd blkptr_t zg_blkptr[SPA_GBH_NBLKPTRS]; 469219089Spjd uint64_t zg_filler[SPA_GBH_FILLER]; 470219089Spjd zio_eck_t zg_tail; 471219089Spjd} zio_gbh_phys_t; 472219089Spjd 473219089Spjd#define VDEV_RAIDZ_MAXPARITY 3 474219089Spjd 475209962Smm#define VDEV_PAD_SIZE (8 << 10) 476209962Smm/* 2 padding areas (vl_pad1 and vl_pad2) to skip */ 477209962Smm#define VDEV_SKIP_SIZE VDEV_PAD_SIZE * 2 478185029Spjd#define VDEV_PHYS_SIZE (112 << 10) 479185029Spjd#define VDEV_UBERBLOCK_RING (128 << 10) 480185029Spjd 481185029Spjd#define VDEV_UBERBLOCK_SHIFT(vd) \ 482219089Spjd MAX((vd)->v_top->v_ashift, UBERBLOCK_SHIFT) 483185029Spjd#define VDEV_UBERBLOCK_COUNT(vd) \ 484185029Spjd (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd)) 485185029Spjd#define VDEV_UBERBLOCK_OFFSET(vd, n) \ 486185029Spjd offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)]) 487185029Spjd#define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd)) 488185029Spjd 489185029Spjdtypedef struct vdev_phys { 490219089Spjd char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_eck_t)]; 491219089Spjd zio_eck_t vp_zbt; 492185029Spjd} vdev_phys_t; 493185029Spjd 494185029Spjdtypedef struct vdev_label { 495209962Smm char vl_pad1[VDEV_PAD_SIZE]; /* 8K */ 496209962Smm char vl_pad2[VDEV_PAD_SIZE]; /* 8K */ 497185029Spjd vdev_phys_t vl_vdev_phys; /* 112K */ 498185029Spjd char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */ 499185029Spjd} vdev_label_t; /* 256K total */ 500185029Spjd 501185029Spjd/* 502185029Spjd * vdev_dirty() flags 503185029Spjd */ 504185029Spjd#define VDD_METASLAB 0x01 505185029Spjd#define VDD_DTL 0x02 506185029Spjd 507185029Spjd/* 508185029Spjd * Size and offset of embedded boot loader region on each label. 509185029Spjd * The total size of the first two labels plus the boot area is 4MB. 510185029Spjd */ 511185029Spjd#define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 512185029Spjd#define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 513185029Spjd 514185029Spjd/* 515185029Spjd * Size of label regions at the start and end of each leaf device. 516185029Spjd */ 517185029Spjd#define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 518185029Spjd#define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 519185029Spjd#define VDEV_LABELS 4 520185029Spjd 521185029Spjdenum zio_checksum { 522185029Spjd ZIO_CHECKSUM_INHERIT = 0, 523185029Spjd ZIO_CHECKSUM_ON, 524185029Spjd ZIO_CHECKSUM_OFF, 525185029Spjd ZIO_CHECKSUM_LABEL, 526185029Spjd ZIO_CHECKSUM_GANG_HEADER, 527185029Spjd ZIO_CHECKSUM_ZILOG, 528185029Spjd ZIO_CHECKSUM_FLETCHER_2, 529185029Spjd ZIO_CHECKSUM_FLETCHER_4, 530185029Spjd ZIO_CHECKSUM_SHA256, 531219089Spjd ZIO_CHECKSUM_ZILOG2, 532185029Spjd ZIO_CHECKSUM_FUNCTIONS 533185029Spjd}; 534185029Spjd 535219089Spjd#define ZIO_CHECKSUM_ON_VALUE ZIO_CHECKSUM_FLETCHER_4 536185029Spjd#define ZIO_CHECKSUM_DEFAULT ZIO_CHECKSUM_ON 537185029Spjd 538185029Spjdenum zio_compress { 539185029Spjd ZIO_COMPRESS_INHERIT = 0, 540185029Spjd ZIO_COMPRESS_ON, 541185029Spjd ZIO_COMPRESS_OFF, 542185029Spjd ZIO_COMPRESS_LZJB, 543185029Spjd ZIO_COMPRESS_EMPTY, 544185029Spjd ZIO_COMPRESS_GZIP_1, 545185029Spjd ZIO_COMPRESS_GZIP_2, 546185029Spjd ZIO_COMPRESS_GZIP_3, 547185029Spjd ZIO_COMPRESS_GZIP_4, 548185029Spjd ZIO_COMPRESS_GZIP_5, 549185029Spjd ZIO_COMPRESS_GZIP_6, 550185029Spjd ZIO_COMPRESS_GZIP_7, 551185029Spjd ZIO_COMPRESS_GZIP_8, 552185029Spjd ZIO_COMPRESS_GZIP_9, 553219089Spjd ZIO_COMPRESS_ZLE, 554246586Sdelphij ZIO_COMPRESS_LZ4, 555185029Spjd ZIO_COMPRESS_FUNCTIONS 556185029Spjd}; 557185029Spjd 558185029Spjd#define ZIO_COMPRESS_ON_VALUE ZIO_COMPRESS_LZJB 559185029Spjd#define ZIO_COMPRESS_DEFAULT ZIO_COMPRESS_OFF 560185029Spjd 561185029Spjd/* nvlist pack encoding */ 562185029Spjd#define NV_ENCODE_NATIVE 0 563185029Spjd#define NV_ENCODE_XDR 1 564185029Spjd 565185029Spjdtypedef enum { 566185029Spjd DATA_TYPE_UNKNOWN = 0, 567185029Spjd DATA_TYPE_BOOLEAN, 568185029Spjd DATA_TYPE_BYTE, 569185029Spjd DATA_TYPE_INT16, 570185029Spjd DATA_TYPE_UINT16, 571185029Spjd DATA_TYPE_INT32, 572185029Spjd DATA_TYPE_UINT32, 573185029Spjd DATA_TYPE_INT64, 574185029Spjd DATA_TYPE_UINT64, 575185029Spjd DATA_TYPE_STRING, 576185029Spjd DATA_TYPE_BYTE_ARRAY, 577185029Spjd DATA_TYPE_INT16_ARRAY, 578185029Spjd DATA_TYPE_UINT16_ARRAY, 579185029Spjd DATA_TYPE_INT32_ARRAY, 580185029Spjd DATA_TYPE_UINT32_ARRAY, 581185029Spjd DATA_TYPE_INT64_ARRAY, 582185029Spjd DATA_TYPE_UINT64_ARRAY, 583185029Spjd DATA_TYPE_STRING_ARRAY, 584185029Spjd DATA_TYPE_HRTIME, 585185029Spjd DATA_TYPE_NVLIST, 586185029Spjd DATA_TYPE_NVLIST_ARRAY, 587185029Spjd DATA_TYPE_BOOLEAN_VALUE, 588185029Spjd DATA_TYPE_INT8, 589185029Spjd DATA_TYPE_UINT8, 590185029Spjd DATA_TYPE_BOOLEAN_ARRAY, 591185029Spjd DATA_TYPE_INT8_ARRAY, 592185029Spjd DATA_TYPE_UINT8_ARRAY 593185029Spjd} data_type_t; 594185029Spjd 595185029Spjd/* 596185029Spjd * On-disk version number. 597185029Spjd */ 598185097Sdfr#define SPA_VERSION_1 1ULL 599185097Sdfr#define SPA_VERSION_2 2ULL 600185097Sdfr#define SPA_VERSION_3 3ULL 601185097Sdfr#define SPA_VERSION_4 4ULL 602185097Sdfr#define SPA_VERSION_5 5ULL 603185097Sdfr#define SPA_VERSION_6 6ULL 604185097Sdfr#define SPA_VERSION_7 7ULL 605185097Sdfr#define SPA_VERSION_8 8ULL 606185097Sdfr#define SPA_VERSION_9 9ULL 607185097Sdfr#define SPA_VERSION_10 10ULL 608185097Sdfr#define SPA_VERSION_11 11ULL 609185154Sdfr#define SPA_VERSION_12 12ULL 610185154Sdfr#define SPA_VERSION_13 13ULL 611201143Sdelphij#define SPA_VERSION_14 14ULL 612209962Smm#define SPA_VERSION_15 15ULL 613219089Spjd#define SPA_VERSION_16 16ULL 614219089Spjd#define SPA_VERSION_17 17ULL 615219089Spjd#define SPA_VERSION_18 18ULL 616219089Spjd#define SPA_VERSION_19 19ULL 617219089Spjd#define SPA_VERSION_20 20ULL 618219089Spjd#define SPA_VERSION_21 21ULL 619219089Spjd#define SPA_VERSION_22 22ULL 620219089Spjd#define SPA_VERSION_23 23ULL 621219089Spjd#define SPA_VERSION_24 24ULL 622219089Spjd#define SPA_VERSION_25 25ULL 623219089Spjd#define SPA_VERSION_26 26ULL 624219089Spjd#define SPA_VERSION_27 27ULL 625219089Spjd#define SPA_VERSION_28 28ULL 626236884Smm#define SPA_VERSION_5000 5000ULL 627219089Spjd 628185029Spjd/* 629219089Spjd * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 630219089Spjd * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 631219089Spjd * and do the appropriate changes. Also bump the version number in 632219089Spjd * usr/src/grub/capability. 633185029Spjd */ 634236884Smm#define SPA_VERSION SPA_VERSION_5000 635236884Smm#define SPA_VERSION_STRING "5000" 636185029Spjd 637185029Spjd/* 638185097Sdfr * Symbolic names for the changes that caused a SPA_VERSION switch. 639185029Spjd * Used in the code when checking for presence or absence of a feature. 640185029Spjd * Feel free to define multiple symbolic names for each version if there 641185029Spjd * were multiple changes to on-disk structures during that version. 642185029Spjd * 643185097Sdfr * NOTE: When checking the current SPA_VERSION in your code, be sure 644185029Spjd * to use spa_version() since it reports the version of the 645185029Spjd * last synced uberblock. Checking the in-flight version can 646185029Spjd * be dangerous in some cases. 647185029Spjd */ 648185097Sdfr#define SPA_VERSION_INITIAL SPA_VERSION_1 649185097Sdfr#define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 650185097Sdfr#define SPA_VERSION_SPARES SPA_VERSION_3 651185097Sdfr#define SPA_VERSION_RAID6 SPA_VERSION_3 652185097Sdfr#define SPA_VERSION_BPLIST_ACCOUNT SPA_VERSION_3 653185097Sdfr#define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 654185097Sdfr#define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 655185097Sdfr#define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 656185097Sdfr#define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 657185097Sdfr#define SPA_VERSION_BOOTFS SPA_VERSION_6 658185154Sdfr#define SPA_VERSION_SLOGS SPA_VERSION_7 659185154Sdfr#define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 660185154Sdfr#define SPA_VERSION_FUID SPA_VERSION_9 661185154Sdfr#define SPA_VERSION_REFRESERVATION SPA_VERSION_9 662185154Sdfr#define SPA_VERSION_REFQUOTA SPA_VERSION_9 663185154Sdfr#define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 664185154Sdfr#define SPA_VERSION_L2CACHE SPA_VERSION_10 665185154Sdfr#define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 666185154Sdfr#define SPA_VERSION_ORIGIN SPA_VERSION_11 667185154Sdfr#define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 668185154Sdfr#define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 669185154Sdfr#define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 670201143Sdelphij#define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 671209962Smm#define SPA_VERSION_USERSPACE SPA_VERSION_15 672219089Spjd#define SPA_VERSION_STMF_PROP SPA_VERSION_16 673219089Spjd#define SPA_VERSION_RAIDZ3 SPA_VERSION_17 674219089Spjd#define SPA_VERSION_USERREFS SPA_VERSION_18 675219089Spjd#define SPA_VERSION_HOLES SPA_VERSION_19 676219089Spjd#define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 677219089Spjd#define SPA_VERSION_DEDUP SPA_VERSION_21 678219089Spjd#define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 679219089Spjd#define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 680219089Spjd#define SPA_VERSION_SA SPA_VERSION_24 681219089Spjd#define SPA_VERSION_SCAN SPA_VERSION_25 682219089Spjd#define SPA_VERSION_DIR_CLONES SPA_VERSION_26 683219089Spjd#define SPA_VERSION_DEADLISTS SPA_VERSION_26 684219089Spjd#define SPA_VERSION_FAST_SNAP SPA_VERSION_27 685219089Spjd#define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 686236884Smm#define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 687236884Smm#define SPA_VERSION_FEATURES SPA_VERSION_5000 688185029Spjd 689236884Smm#define SPA_VERSION_IS_SUPPORTED(v) \ 690236884Smm (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 691236884Smm ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 692236884Smm 693185029Spjd/* 694185029Spjd * The following are configuration names used in the nvlist describing a pool's 695185029Spjd * configuration. 696185029Spjd */ 697185029Spjd#define ZPOOL_CONFIG_VERSION "version" 698185029Spjd#define ZPOOL_CONFIG_POOL_NAME "name" 699185029Spjd#define ZPOOL_CONFIG_POOL_STATE "state" 700185029Spjd#define ZPOOL_CONFIG_POOL_TXG "txg" 701185029Spjd#define ZPOOL_CONFIG_POOL_GUID "pool_guid" 702185029Spjd#define ZPOOL_CONFIG_CREATE_TXG "create_txg" 703185029Spjd#define ZPOOL_CONFIG_TOP_GUID "top_guid" 704185029Spjd#define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 705185029Spjd#define ZPOOL_CONFIG_TYPE "type" 706185029Spjd#define ZPOOL_CONFIG_CHILDREN "children" 707185029Spjd#define ZPOOL_CONFIG_ID "id" 708185029Spjd#define ZPOOL_CONFIG_GUID "guid" 709185029Spjd#define ZPOOL_CONFIG_PATH "path" 710185029Spjd#define ZPOOL_CONFIG_DEVID "devid" 711185029Spjd#define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 712185029Spjd#define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 713185029Spjd#define ZPOOL_CONFIG_ASHIFT "ashift" 714185029Spjd#define ZPOOL_CONFIG_ASIZE "asize" 715185029Spjd#define ZPOOL_CONFIG_DTL "DTL" 716185029Spjd#define ZPOOL_CONFIG_STATS "stats" 717185029Spjd#define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 718185029Spjd#define ZPOOL_CONFIG_ERRCOUNT "error_count" 719185029Spjd#define ZPOOL_CONFIG_NOT_PRESENT "not_present" 720185029Spjd#define ZPOOL_CONFIG_SPARES "spares" 721185029Spjd#define ZPOOL_CONFIG_IS_SPARE "is_spare" 722185029Spjd#define ZPOOL_CONFIG_NPARITY "nparity" 723185029Spjd#define ZPOOL_CONFIG_HOSTID "hostid" 724185029Spjd#define ZPOOL_CONFIG_HOSTNAME "hostname" 725212407Spjd#define ZPOOL_CONFIG_IS_LOG "is_log" 726185029Spjd#define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 727236884Smm#define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 728185029Spjd 729201689Sdelphij/* 730201689Sdelphij * The persistent vdev state is stored as separate values rather than a single 731201689Sdelphij * 'vdev_state' entry. This is because a device can be in multiple states, such 732201689Sdelphij * as offline and degraded. 733201689Sdelphij */ 734201689Sdelphij#define ZPOOL_CONFIG_OFFLINE "offline" 735201689Sdelphij#define ZPOOL_CONFIG_FAULTED "faulted" 736201689Sdelphij#define ZPOOL_CONFIG_DEGRADED "degraded" 737201689Sdelphij#define ZPOOL_CONFIG_REMOVED "removed" 738219089Spjd#define ZPOOL_CONFIG_FRU "fru" 739219089Spjd#define ZPOOL_CONFIG_AUX_STATE "aux_state" 740201689Sdelphij 741185029Spjd#define VDEV_TYPE_ROOT "root" 742185029Spjd#define VDEV_TYPE_MIRROR "mirror" 743185029Spjd#define VDEV_TYPE_REPLACING "replacing" 744185029Spjd#define VDEV_TYPE_RAIDZ "raidz" 745185029Spjd#define VDEV_TYPE_DISK "disk" 746185029Spjd#define VDEV_TYPE_FILE "file" 747185029Spjd#define VDEV_TYPE_MISSING "missing" 748219089Spjd#define VDEV_TYPE_HOLE "hole" 749185029Spjd#define VDEV_TYPE_SPARE "spare" 750219089Spjd#define VDEV_TYPE_LOG "log" 751219089Spjd#define VDEV_TYPE_L2CACHE "l2cache" 752185029Spjd 753185029Spjd/* 754185029Spjd * This is needed in userland to report the minimum necessary device size. 755185029Spjd */ 756185029Spjd#define SPA_MINDEVSIZE (64ULL << 20) 757185029Spjd 758185029Spjd/* 759185029Spjd * The location of the pool configuration repository, shared between kernel and 760185029Spjd * userland. 761185029Spjd */ 762219089Spjd#define ZPOOL_CACHE "/boot/zfs/zpool.cache" 763185029Spjd 764185029Spjd/* 765185029Spjd * vdev states are ordered from least to most healthy. 766185029Spjd * A vdev that's CANT_OPEN or below is considered unusable. 767185029Spjd */ 768185029Spjdtypedef enum vdev_state { 769185029Spjd VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 770185029Spjd VDEV_STATE_CLOSED, /* Not currently open */ 771185029Spjd VDEV_STATE_OFFLINE, /* Not allowed to open */ 772201689Sdelphij VDEV_STATE_REMOVED, /* Explicitly removed from system */ 773185029Spjd VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 774201689Sdelphij VDEV_STATE_FAULTED, /* External request to fault device */ 775185029Spjd VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 776185029Spjd VDEV_STATE_HEALTHY /* Presumed good */ 777185029Spjd} vdev_state_t; 778185029Spjd 779185029Spjd/* 780185029Spjd * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 781185029Spjd * of the vdev stats structure uses these constants to distinguish why. 782185029Spjd */ 783185029Spjdtypedef enum vdev_aux { 784185029Spjd VDEV_AUX_NONE, /* no error */ 785185029Spjd VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 786185029Spjd VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 787185029Spjd VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 788185029Spjd VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 789185029Spjd VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 790185029Spjd VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 791185029Spjd VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 792185029Spjd VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 793185029Spjd VDEV_AUX_SPARED /* hot spare used in another pool */ 794185029Spjd} vdev_aux_t; 795185029Spjd 796185029Spjd/* 797185029Spjd * pool state. The following states are written to disk as part of the normal 798185029Spjd * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE. The remaining states are 799185029Spjd * software abstractions used at various levels to communicate pool state. 800185029Spjd */ 801185029Spjdtypedef enum pool_state { 802185029Spjd POOL_STATE_ACTIVE = 0, /* In active use */ 803185029Spjd POOL_STATE_EXPORTED, /* Explicitly exported */ 804185029Spjd POOL_STATE_DESTROYED, /* Explicitly destroyed */ 805185029Spjd POOL_STATE_SPARE, /* Reserved for hot spare use */ 806185029Spjd POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 807185029Spjd POOL_STATE_UNAVAIL, /* Internal libzfs state */ 808185029Spjd POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 809185029Spjd} pool_state_t; 810185029Spjd 811185029Spjd/* 812185029Spjd * The uberblock version is incremented whenever an incompatible on-disk 813185029Spjd * format change is made to the SPA, DMU, or ZAP. 814185029Spjd * 815185029Spjd * Note: the first two fields should never be moved. When a storage pool 816185029Spjd * is opened, the uberblock must be read off the disk before the version 817185029Spjd * can be checked. If the ub_version field is moved, we may not detect 818185029Spjd * version mismatch. If the ub_magic field is moved, applications that 819185029Spjd * expect the magic number in the first word won't work. 820185029Spjd */ 821185029Spjd#define UBERBLOCK_MAGIC 0x00bab10c /* oo-ba-bloc! */ 822185029Spjd#define UBERBLOCK_SHIFT 10 /* up to 1K */ 823185029Spjd 824185029Spjdstruct uberblock { 825185029Spjd uint64_t ub_magic; /* UBERBLOCK_MAGIC */ 826185097Sdfr uint64_t ub_version; /* SPA_VERSION */ 827185029Spjd uint64_t ub_txg; /* txg of last sync */ 828185029Spjd uint64_t ub_guid_sum; /* sum of all vdev guids */ 829185029Spjd uint64_t ub_timestamp; /* UTC time of last sync */ 830185029Spjd blkptr_t ub_rootbp; /* MOS objset_phys_t */ 831185029Spjd}; 832185029Spjd 833185029Spjd/* 834185029Spjd * Flags. 835185029Spjd */ 836185029Spjd#define DNODE_MUST_BE_ALLOCATED 1 837185029Spjd#define DNODE_MUST_BE_FREE 2 838185029Spjd 839185029Spjd/* 840185029Spjd * Fixed constants. 841185029Spjd */ 842185029Spjd#define DNODE_SHIFT 9 /* 512 bytes */ 843272332Sdelphij#define DN_MIN_INDBLKSHIFT 12 /* 4k */ 844185029Spjd#define DN_MAX_INDBLKSHIFT 14 /* 16k */ 845185029Spjd#define DNODE_BLOCK_SHIFT 14 /* 16k */ 846185029Spjd#define DNODE_CORE_SIZE 64 /* 64 bytes for dnode sans blkptrs */ 847185029Spjd#define DN_MAX_OBJECT_SHIFT 48 /* 256 trillion (zfs_fid_t limit) */ 848185029Spjd#define DN_MAX_OFFSET_SHIFT 64 /* 2^64 bytes in a dnode */ 849185029Spjd 850185029Spjd/* 851185029Spjd * Derived constants. 852185029Spjd */ 853185029Spjd#define DNODE_SIZE (1 << DNODE_SHIFT) 854185029Spjd#define DN_MAX_NBLKPTR ((DNODE_SIZE - DNODE_CORE_SIZE) >> SPA_BLKPTRSHIFT) 855185029Spjd#define DN_MAX_BONUSLEN (DNODE_SIZE - DNODE_CORE_SIZE - (1 << SPA_BLKPTRSHIFT)) 856185029Spjd#define DN_MAX_OBJECT (1ULL << DN_MAX_OBJECT_SHIFT) 857185029Spjd 858185029Spjd#define DNODES_PER_BLOCK_SHIFT (DNODE_BLOCK_SHIFT - DNODE_SHIFT) 859185029Spjd#define DNODES_PER_BLOCK (1ULL << DNODES_PER_BLOCK_SHIFT) 860185029Spjd#define DNODES_PER_LEVEL_SHIFT (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT) 861185029Spjd 862185029Spjd/* The +2 here is a cheesy way to round up */ 863185029Spjd#define DN_MAX_LEVELS (2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \ 864185029Spjd (DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT))) 865185029Spjd 866185029Spjd#define DN_BONUS(dnp) ((void*)((dnp)->dn_bonus + \ 867185029Spjd (((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t)))) 868185029Spjd 869185029Spjd#define DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \ 870185029Spjd (dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT) 871185029Spjd 872185029Spjd#define EPB(blkshift, typeshift) (1 << (blkshift - typeshift)) 873185029Spjd 874185029Spjd/* Is dn_used in bytes? if not, it's in multiples of SPA_MINBLOCKSIZE */ 875219089Spjd#define DNODE_FLAG_USED_BYTES (1<<0) 876219089Spjd#define DNODE_FLAG_USERUSED_ACCOUNTED (1<<1) 877185029Spjd 878219089Spjd/* Does dnode have a SA spill blkptr in bonus? */ 879219089Spjd#define DNODE_FLAG_SPILL_BLKPTR (1<<2) 880219089Spjd 881185029Spjdtypedef struct dnode_phys { 882185029Spjd uint8_t dn_type; /* dmu_object_type_t */ 883185029Spjd uint8_t dn_indblkshift; /* ln2(indirect block size) */ 884185029Spjd uint8_t dn_nlevels; /* 1=dn_blkptr->data blocks */ 885185029Spjd uint8_t dn_nblkptr; /* length of dn_blkptr */ 886185029Spjd uint8_t dn_bonustype; /* type of data in bonus buffer */ 887185029Spjd uint8_t dn_checksum; /* ZIO_CHECKSUM type */ 888185029Spjd uint8_t dn_compress; /* ZIO_COMPRESS type */ 889185029Spjd uint8_t dn_flags; /* DNODE_FLAG_* */ 890185029Spjd uint16_t dn_datablkszsec; /* data block size in 512b sectors */ 891185029Spjd uint16_t dn_bonuslen; /* length of dn_bonus */ 892185029Spjd uint8_t dn_pad2[4]; 893185029Spjd 894185029Spjd /* accounting is protected by dn_dirty_mtx */ 895185029Spjd uint64_t dn_maxblkid; /* largest allocated block ID */ 896185029Spjd uint64_t dn_used; /* bytes (or sectors) of disk space */ 897185029Spjd 898185029Spjd uint64_t dn_pad3[4]; 899185029Spjd 900185029Spjd blkptr_t dn_blkptr[1]; 901219089Spjd uint8_t dn_bonus[DN_MAX_BONUSLEN - sizeof (blkptr_t)]; 902219089Spjd blkptr_t dn_spill; 903185029Spjd} dnode_phys_t; 904185029Spjd 905185029Spjdtypedef enum dmu_object_type { 906185029Spjd DMU_OT_NONE, 907185029Spjd /* general: */ 908185029Spjd DMU_OT_OBJECT_DIRECTORY, /* ZAP */ 909185029Spjd DMU_OT_OBJECT_ARRAY, /* UINT64 */ 910185029Spjd DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ 911185029Spjd DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ 912185029Spjd DMU_OT_BPLIST, /* UINT64 */ 913185029Spjd DMU_OT_BPLIST_HDR, /* UINT64 */ 914185029Spjd /* spa: */ 915185029Spjd DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ 916185029Spjd DMU_OT_SPACE_MAP, /* UINT64 */ 917185029Spjd /* zil: */ 918185029Spjd DMU_OT_INTENT_LOG, /* UINT64 */ 919185029Spjd /* dmu: */ 920185029Spjd DMU_OT_DNODE, /* DNODE */ 921185029Spjd DMU_OT_OBJSET, /* OBJSET */ 922185029Spjd /* dsl: */ 923185029Spjd DMU_OT_DSL_DIR, /* UINT64 */ 924185029Spjd DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ 925185029Spjd DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ 926185029Spjd DMU_OT_DSL_PROPS, /* ZAP */ 927185029Spjd DMU_OT_DSL_DATASET, /* UINT64 */ 928185029Spjd /* zpl: */ 929185029Spjd DMU_OT_ZNODE, /* ZNODE */ 930219089Spjd DMU_OT_OLDACL, /* Old ACL */ 931185029Spjd DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ 932185029Spjd DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ 933185029Spjd DMU_OT_MASTER_NODE, /* ZAP */ 934185029Spjd DMU_OT_UNLINKED_SET, /* ZAP */ 935185029Spjd /* zvol: */ 936185029Spjd DMU_OT_ZVOL, /* UINT8 */ 937185029Spjd DMU_OT_ZVOL_PROP, /* ZAP */ 938185029Spjd /* other; for testing only! */ 939185029Spjd DMU_OT_PLAIN_OTHER, /* UINT8 */ 940185029Spjd DMU_OT_UINT64_OTHER, /* UINT64 */ 941185029Spjd DMU_OT_ZAP_OTHER, /* ZAP */ 942185029Spjd /* new object types: */ 943185029Spjd DMU_OT_ERROR_LOG, /* ZAP */ 944185029Spjd DMU_OT_SPA_HISTORY, /* UINT8 */ 945185029Spjd DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ 946185029Spjd DMU_OT_POOL_PROPS, /* ZAP */ 947219089Spjd DMU_OT_DSL_PERMS, /* ZAP */ 948219089Spjd DMU_OT_ACL, /* ACL */ 949219089Spjd DMU_OT_SYSACL, /* SYSACL */ 950219089Spjd DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */ 951219089Spjd DMU_OT_FUID_SIZE, /* FUID table size UINT64 */ 952219089Spjd DMU_OT_NEXT_CLONES, /* ZAP */ 953219089Spjd DMU_OT_SCAN_QUEUE, /* ZAP */ 954219089Spjd DMU_OT_USERGROUP_USED, /* ZAP */ 955219089Spjd DMU_OT_USERGROUP_QUOTA, /* ZAP */ 956219089Spjd DMU_OT_USERREFS, /* ZAP */ 957219089Spjd DMU_OT_DDT_ZAP, /* ZAP */ 958219089Spjd DMU_OT_DDT_STATS, /* ZAP */ 959219089Spjd DMU_OT_SA, /* System attr */ 960219089Spjd DMU_OT_SA_MASTER_NODE, /* ZAP */ 961219089Spjd DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */ 962219089Spjd DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */ 963219089Spjd DMU_OT_SCAN_XLATE, /* ZAP */ 964219089Spjd DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */ 965185029Spjd DMU_OT_NUMTYPES 966185029Spjd} dmu_object_type_t; 967185029Spjd 968185029Spjdtypedef enum dmu_objset_type { 969185029Spjd DMU_OST_NONE, 970185029Spjd DMU_OST_META, 971185029Spjd DMU_OST_ZFS, 972185029Spjd DMU_OST_ZVOL, 973185029Spjd DMU_OST_OTHER, /* For testing only! */ 974185029Spjd DMU_OST_ANY, /* Be careful! */ 975185029Spjd DMU_OST_NUMTYPES 976185029Spjd} dmu_objset_type_t; 977185029Spjd 978185029Spjd/* 979219089Spjd * header for all bonus and spill buffers. 980219089Spjd * The header has a fixed portion with a variable number 981219089Spjd * of "lengths" depending on the number of variable sized 982219089Spjd * attribues which are determined by the "layout number" 983219089Spjd */ 984219089Spjd 985219089Spjd#define SA_MAGIC 0x2F505A /* ZFS SA */ 986219089Spjdtypedef struct sa_hdr_phys { 987219089Spjd uint32_t sa_magic; 988219089Spjd uint16_t sa_layout_info; /* Encoded with hdrsize and layout number */ 989219089Spjd uint16_t sa_lengths[1]; /* optional sizes for variable length attrs */ 990219089Spjd /* ... Data follows the lengths. */ 991219089Spjd} sa_hdr_phys_t; 992219089Spjd 993219089Spjd/* 994219089Spjd * sa_hdr_phys -> sa_layout_info 995219089Spjd * 996219089Spjd * 16 10 0 997219089Spjd * +--------+-------+ 998219089Spjd * | hdrsz |layout | 999219089Spjd * +--------+-------+ 1000219089Spjd * 1001219089Spjd * Bits 0-10 are the layout number 1002219089Spjd * Bits 11-16 are the size of the header. 1003219089Spjd * The hdrsize is the number * 8 1004219089Spjd * 1005219089Spjd * For example. 1006219089Spjd * hdrsz of 1 ==> 8 byte header 1007219089Spjd * 2 ==> 16 byte header 1008219089Spjd * 1009219089Spjd */ 1010219089Spjd 1011219089Spjd#define SA_HDR_LAYOUT_NUM(hdr) BF32_GET(hdr->sa_layout_info, 0, 10) 1012219089Spjd#define SA_HDR_SIZE(hdr) BF32_GET_SB(hdr->sa_layout_info, 10, 16, 3, 0) 1013219089Spjd#define SA_HDR_LAYOUT_INFO_ENCODE(x, num, size) \ 1014219089Spjd{ \ 1015219089Spjd BF32_SET_SB(x, 10, 6, 3, 0, size); \ 1016219089Spjd BF32_SET(x, 0, 10, num); \ 1017219089Spjd} 1018219089Spjd 1019219089Spjd#define SA_MODE_OFFSET 0 1020219089Spjd#define SA_SIZE_OFFSET 8 1021219089Spjd#define SA_GEN_OFFSET 16 1022219089Spjd#define SA_UID_OFFSET 24 1023219089Spjd#define SA_GID_OFFSET 32 1024219089Spjd#define SA_PARENT_OFFSET 40 1025219089Spjd 1026219089Spjd/* 1027185029Spjd * Intent log header - this on disk structure holds fields to manage 1028185029Spjd * the log. All fields are 64 bit to easily handle cross architectures. 1029185029Spjd */ 1030185029Spjdtypedef struct zil_header { 1031185029Spjd uint64_t zh_claim_txg; /* txg in which log blocks were claimed */ 1032185029Spjd uint64_t zh_replay_seq; /* highest replayed sequence number */ 1033185029Spjd blkptr_t zh_log; /* log chain */ 1034185029Spjd uint64_t zh_claim_seq; /* highest claimed sequence number */ 1035185029Spjd uint64_t zh_pad[5]; 1036185029Spjd} zil_header_t; 1037185029Spjd 1038219089Spjd#define OBJSET_PHYS_SIZE 2048 1039219089Spjd 1040185029Spjdtypedef struct objset_phys { 1041185029Spjd dnode_phys_t os_meta_dnode; 1042185029Spjd zil_header_t os_zil_header; 1043185029Spjd uint64_t os_type; 1044209962Smm uint64_t os_flags; 1045219089Spjd char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 - 1046209962Smm sizeof (zil_header_t) - sizeof (uint64_t)*2]; 1047209962Smm dnode_phys_t os_userused_dnode; 1048209962Smm dnode_phys_t os_groupused_dnode; 1049185029Spjd} objset_phys_t; 1050185029Spjd 1051185029Spjdtypedef struct dsl_dir_phys { 1052185029Spjd uint64_t dd_creation_time; /* not actually used */ 1053185029Spjd uint64_t dd_head_dataset_obj; 1054185029Spjd uint64_t dd_parent_obj; 1055185029Spjd uint64_t dd_clone_parent_obj; 1056185029Spjd uint64_t dd_child_dir_zapobj; 1057185029Spjd /* 1058185029Spjd * how much space our children are accounting for; for leaf 1059185029Spjd * datasets, == physical space used by fs + snaps 1060185029Spjd */ 1061185029Spjd uint64_t dd_used_bytes; 1062185029Spjd uint64_t dd_compressed_bytes; 1063185029Spjd uint64_t dd_uncompressed_bytes; 1064185029Spjd /* Administrative quota setting */ 1065185029Spjd uint64_t dd_quota; 1066185029Spjd /* Administrative reservation setting */ 1067185029Spjd uint64_t dd_reserved; 1068185029Spjd uint64_t dd_props_zapobj; 1069185029Spjd uint64_t dd_pad[21]; /* pad out to 256 bytes for good measure */ 1070185029Spjd} dsl_dir_phys_t; 1071185029Spjd 1072185029Spjdtypedef struct dsl_dataset_phys { 1073185029Spjd uint64_t ds_dir_obj; 1074185029Spjd uint64_t ds_prev_snap_obj; 1075185029Spjd uint64_t ds_prev_snap_txg; 1076185029Spjd uint64_t ds_next_snap_obj; 1077185029Spjd uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==0 for snaps */ 1078185029Spjd uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 1079185029Spjd uint64_t ds_creation_time; /* seconds since 1970 */ 1080185029Spjd uint64_t ds_creation_txg; 1081185029Spjd uint64_t ds_deadlist_obj; 1082185029Spjd uint64_t ds_used_bytes; 1083185029Spjd uint64_t ds_compressed_bytes; 1084185029Spjd uint64_t ds_uncompressed_bytes; 1085185029Spjd uint64_t ds_unique_bytes; /* only relevant to snapshots */ 1086185029Spjd /* 1087185029Spjd * The ds_fsid_guid is a 56-bit ID that can change to avoid 1088185029Spjd * collisions. The ds_guid is a 64-bit ID that will never 1089185029Spjd * change, so there is a small probability that it will collide. 1090185029Spjd */ 1091185029Spjd uint64_t ds_fsid_guid; 1092185029Spjd uint64_t ds_guid; 1093185029Spjd uint64_t ds_flags; 1094185029Spjd blkptr_t ds_bp; 1095185029Spjd uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 1096185029Spjd} dsl_dataset_phys_t; 1097185029Spjd 1098185029Spjd/* 1099185029Spjd * The names of zap entries in the DIRECTORY_OBJECT of the MOS. 1100185029Spjd */ 1101185029Spjd#define DMU_POOL_DIRECTORY_OBJECT 1 1102185029Spjd#define DMU_POOL_CONFIG "config" 1103185029Spjd#define DMU_POOL_ROOT_DATASET "root_dataset" 1104185029Spjd#define DMU_POOL_SYNC_BPLIST "sync_bplist" 1105185029Spjd#define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" 1106185029Spjd#define DMU_POOL_ERRLOG_LAST "errlog_last" 1107185029Spjd#define DMU_POOL_SPARES "spares" 1108185029Spjd#define DMU_POOL_DEFLATE "deflate" 1109185029Spjd#define DMU_POOL_HISTORY "history" 1110185029Spjd#define DMU_POOL_PROPS "pool_props" 1111185029Spjd 1112185029Spjd#define ZAP_MAGIC 0x2F52AB2ABULL 1113185029Spjd 1114185029Spjd#define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_block_shift) 1115185029Spjd 1116185029Spjd#define ZAP_MAXCD (uint32_t)(-1) 1117185029Spjd#define ZAP_HASHBITS 28 1118185029Spjd#define MZAP_ENT_LEN 64 1119185029Spjd#define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 1120185029Spjd#define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT 1121185029Spjd#define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT) 1122185029Spjd 1123185029Spjdtypedef struct mzap_ent_phys { 1124185029Spjd uint64_t mze_value; 1125185029Spjd uint32_t mze_cd; 1126185029Spjd uint16_t mze_pad; /* in case we want to chain them someday */ 1127185029Spjd char mze_name[MZAP_NAME_LEN]; 1128185029Spjd} mzap_ent_phys_t; 1129185029Spjd 1130185029Spjdtypedef struct mzap_phys { 1131185029Spjd uint64_t mz_block_type; /* ZBT_MICRO */ 1132185029Spjd uint64_t mz_salt; 1133185029Spjd uint64_t mz_pad[6]; 1134185029Spjd mzap_ent_phys_t mz_chunk[1]; 1135185029Spjd /* actually variable size depending on block size */ 1136185029Spjd} mzap_phys_t; 1137185029Spjd 1138185029Spjd/* 1139185029Spjd * The (fat) zap is stored in one object. It is an array of 1140185029Spjd * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 1141185029Spjd * 1142185029Spjd * ptrtbl fits in first block: 1143185029Spjd * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 1144185029Spjd * 1145185029Spjd * ptrtbl too big for first block: 1146185029Spjd * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 1147185029Spjd * 1148185029Spjd */ 1149185029Spjd 1150185029Spjd#define ZBT_LEAF ((1ULL << 63) + 0) 1151185029Spjd#define ZBT_HEADER ((1ULL << 63) + 1) 1152185029Spjd#define ZBT_MICRO ((1ULL << 63) + 3) 1153185029Spjd/* any other values are ptrtbl blocks */ 1154185029Spjd 1155185029Spjd/* 1156185029Spjd * the embedded pointer table takes up half a block: 1157185029Spjd * block size / entry size (2^3) / 2 1158185029Spjd */ 1159185029Spjd#define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 1160185029Spjd 1161185029Spjd/* 1162185029Spjd * The embedded pointer table starts half-way through the block. Since 1163185029Spjd * the pointer table itself is half the block, it starts at (64-bit) 1164185029Spjd * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 1165185029Spjd */ 1166185029Spjd#define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 1167185029Spjd ((uint64_t *)(zap)->zap_phys) \ 1168185029Spjd [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 1169185029Spjd 1170185029Spjd/* 1171185029Spjd * TAKE NOTE: 1172185029Spjd * If zap_phys_t is modified, zap_byteswap() must be modified. 1173185029Spjd */ 1174185029Spjdtypedef struct zap_phys { 1175185029Spjd uint64_t zap_block_type; /* ZBT_HEADER */ 1176185029Spjd uint64_t zap_magic; /* ZAP_MAGIC */ 1177185029Spjd 1178185029Spjd struct zap_table_phys { 1179185029Spjd uint64_t zt_blk; /* starting block number */ 1180185029Spjd uint64_t zt_numblks; /* number of blocks */ 1181185029Spjd uint64_t zt_shift; /* bits to index it */ 1182185029Spjd uint64_t zt_nextblk; /* next (larger) copy start block */ 1183185029Spjd uint64_t zt_blks_copied; /* number source blocks copied */ 1184185029Spjd } zap_ptrtbl; 1185185029Spjd 1186185029Spjd uint64_t zap_freeblk; /* the next free block */ 1187185029Spjd uint64_t zap_num_leafs; /* number of leafs */ 1188185029Spjd uint64_t zap_num_entries; /* number of entries */ 1189185029Spjd uint64_t zap_salt; /* salt to stir into hash function */ 1190185029Spjd /* 1191185029Spjd * This structure is followed by padding, and then the embedded 1192185029Spjd * pointer table. The embedded pointer table takes up second 1193185029Spjd * half of the block. It is accessed using the 1194185029Spjd * ZAP_EMBEDDED_PTRTBL_ENT() macro. 1195185029Spjd */ 1196185029Spjd} zap_phys_t; 1197185029Spjd 1198185029Spjdtypedef struct zap_table_phys zap_table_phys_t; 1199185029Spjd 1200185029Spjdtypedef struct fat_zap { 1201185029Spjd int zap_block_shift; /* block size shift */ 1202185029Spjd zap_phys_t *zap_phys; 1203185029Spjd} fat_zap_t; 1204185029Spjd 1205185029Spjd#define ZAP_LEAF_MAGIC 0x2AB1EAF 1206185029Spjd 1207185029Spjd/* chunk size = 24 bytes */ 1208185029Spjd#define ZAP_LEAF_CHUNKSIZE 24 1209185029Spjd 1210185029Spjd/* 1211185029Spjd * The amount of space available for chunks is: 1212185029Spjd * block size (1<<l->l_bs) - hash entry size (2) * number of hash 1213185029Spjd * entries - header space (2*chunksize) 1214185029Spjd */ 1215185029Spjd#define ZAP_LEAF_NUMCHUNKS(l) \ 1216185029Spjd (((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \ 1217185029Spjd ZAP_LEAF_CHUNKSIZE - 2) 1218185029Spjd 1219185029Spjd/* 1220185029Spjd * The amount of space within the chunk available for the array is: 1221185029Spjd * chunk size - space for type (1) - space for next pointer (2) 1222185029Spjd */ 1223185029Spjd#define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3) 1224185029Spjd 1225185029Spjd#define ZAP_LEAF_ARRAY_NCHUNKS(bytes) \ 1226185029Spjd (((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES) 1227185029Spjd 1228185029Spjd/* 1229185029Spjd * Low water mark: when there are only this many chunks free, start 1230185029Spjd * growing the ptrtbl. Ideally, this should be larger than a 1231185029Spjd * "reasonably-sized" entry. 20 chunks is more than enough for the 1232185029Spjd * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value), 1233185029Spjd * while still being only around 3% for 16k blocks. 1234185029Spjd */ 1235185029Spjd#define ZAP_LEAF_LOW_WATER (20) 1236185029Spjd 1237185029Spjd/* 1238185029Spjd * The leaf hash table has block size / 2^5 (32) number of entries, 1239185029Spjd * which should be more than enough for the maximum number of entries, 1240185029Spjd * which is less than block size / CHUNKSIZE (24) / minimum number of 1241185029Spjd * chunks per entry (3). 1242185029Spjd */ 1243185029Spjd#define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5) 1244185029Spjd#define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l)) 1245185029Spjd 1246185029Spjd/* 1247185029Spjd * The chunks start immediately after the hash table. The end of the 1248185029Spjd * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a 1249185029Spjd * chunk_t. 1250185029Spjd */ 1251185029Spjd#define ZAP_LEAF_CHUNK(l, idx) \ 1252185029Spjd ((zap_leaf_chunk_t *) \ 1253185029Spjd ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx] 1254185029Spjd#define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry) 1255185029Spjd 1256185029Spjdtypedef enum zap_chunk_type { 1257185029Spjd ZAP_CHUNK_FREE = 253, 1258185029Spjd ZAP_CHUNK_ENTRY = 252, 1259185029Spjd ZAP_CHUNK_ARRAY = 251, 1260185029Spjd ZAP_CHUNK_TYPE_MAX = 250 1261185029Spjd} zap_chunk_type_t; 1262185029Spjd 1263185029Spjd/* 1264185029Spjd * TAKE NOTE: 1265185029Spjd * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 1266185029Spjd */ 1267185029Spjdtypedef struct zap_leaf_phys { 1268185029Spjd struct zap_leaf_header { 1269185029Spjd uint64_t lh_block_type; /* ZBT_LEAF */ 1270185029Spjd uint64_t lh_pad1; 1271185029Spjd uint64_t lh_prefix; /* hash prefix of this leaf */ 1272185029Spjd uint32_t lh_magic; /* ZAP_LEAF_MAGIC */ 1273185029Spjd uint16_t lh_nfree; /* number free chunks */ 1274185029Spjd uint16_t lh_nentries; /* number of entries */ 1275185029Spjd uint16_t lh_prefix_len; /* num bits used to id this */ 1276185029Spjd 1277185029Spjd/* above is accessable to zap, below is zap_leaf private */ 1278185029Spjd 1279185029Spjd uint16_t lh_freelist; /* chunk head of free list */ 1280185029Spjd uint8_t lh_pad2[12]; 1281185029Spjd } l_hdr; /* 2 24-byte chunks */ 1282185029Spjd 1283185029Spjd /* 1284185029Spjd * The header is followed by a hash table with 1285185029Spjd * ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is 1286185029Spjd * followed by an array of ZAP_LEAF_NUMCHUNKS(zap) 1287185029Spjd * zap_leaf_chunk structures. These structures are accessed 1288185029Spjd * with the ZAP_LEAF_CHUNK() macro. 1289185029Spjd */ 1290185029Spjd 1291185029Spjd uint16_t l_hash[1]; 1292185029Spjd} zap_leaf_phys_t; 1293185029Spjd 1294185029Spjdtypedef union zap_leaf_chunk { 1295185029Spjd struct zap_leaf_entry { 1296185029Spjd uint8_t le_type; /* always ZAP_CHUNK_ENTRY */ 1297240356Savg uint8_t le_value_intlen; /* size of ints */ 1298185029Spjd uint16_t le_next; /* next entry in hash chain */ 1299185029Spjd uint16_t le_name_chunk; /* first chunk of the name */ 1300240356Savg uint16_t le_name_numints; /* bytes in name, incl null */ 1301185029Spjd uint16_t le_value_chunk; /* first chunk of the value */ 1302240356Savg uint16_t le_value_numints; /* value length in ints */ 1303185029Spjd uint32_t le_cd; /* collision differentiator */ 1304185029Spjd uint64_t le_hash; /* hash value of the name */ 1305185029Spjd } l_entry; 1306185029Spjd struct zap_leaf_array { 1307185029Spjd uint8_t la_type; /* always ZAP_CHUNK_ARRAY */ 1308185029Spjd uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 1309185029Spjd uint16_t la_next; /* next blk or CHAIN_END */ 1310185029Spjd } l_array; 1311185029Spjd struct zap_leaf_free { 1312185029Spjd uint8_t lf_type; /* always ZAP_CHUNK_FREE */ 1313185029Spjd uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 1314185029Spjd uint16_t lf_next; /* next in free list, or CHAIN_END */ 1315185029Spjd } l_free; 1316185029Spjd} zap_leaf_chunk_t; 1317185029Spjd 1318185029Spjdtypedef struct zap_leaf { 1319185029Spjd int l_bs; /* block size shift */ 1320185029Spjd zap_leaf_phys_t *l_phys; 1321185029Spjd} zap_leaf_t; 1322185029Spjd 1323185029Spjd/* 1324185029Spjd * Define special zfs pflags 1325185029Spjd */ 1326185029Spjd#define ZFS_XATTR 0x1 /* is an extended attribute */ 1327185029Spjd#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ 1328185029Spjd#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ 1329185029Spjd 1330185029Spjd#define MASTER_NODE_OBJ 1 1331185029Spjd 1332185029Spjd/* 1333185029Spjd * special attributes for master node. 1334185029Spjd */ 1335185029Spjd 1336185029Spjd#define ZFS_FSID "FSID" 1337185029Spjd#define ZFS_UNLINKED_SET "DELETE_QUEUE" 1338185029Spjd#define ZFS_ROOT_OBJ "ROOT" 1339185029Spjd#define ZPL_VERSION_OBJ "VERSION" 1340185029Spjd#define ZFS_PROP_BLOCKPERPAGE "BLOCKPERPAGE" 1341185029Spjd#define ZFS_PROP_NOGROWBLOCKS "NOGROWBLOCKS" 1342185029Spjd 1343185029Spjd#define ZFS_FLAG_BLOCKPERPAGE 0x1 1344185029Spjd#define ZFS_FLAG_NOGROWBLOCKS 0x2 1345185029Spjd 1346185029Spjd/* 1347185029Spjd * ZPL version - rev'd whenever an incompatible on-disk format change 1348185029Spjd * occurs. Independent of SPA/DMU/ZAP versioning. 1349185029Spjd */ 1350185029Spjd 1351185029Spjd#define ZPL_VERSION 1ULL 1352185029Spjd 1353185029Spjd/* 1354185029Spjd * The directory entry has the type (currently unused on Solaris) in the 1355185029Spjd * top 4 bits, and the object number in the low 48 bits. The "middle" 1356185029Spjd * 12 bits are unused. 1357185029Spjd */ 1358185029Spjd#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) 1359185029Spjd#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) 1360185029Spjd#define ZFS_DIRENT_MAKE(type, obj) (((uint64_t)type << 60) | obj) 1361185029Spjd 1362185029Spjdtypedef struct ace { 1363185029Spjd uid_t a_who; /* uid or gid */ 1364185029Spjd uint32_t a_access_mask; /* read,write,... */ 1365185029Spjd uint16_t a_flags; /* see below */ 1366185029Spjd uint16_t a_type; /* allow or deny */ 1367185029Spjd} ace_t; 1368185029Spjd 1369185029Spjd#define ACE_SLOT_CNT 6 1370185029Spjd 1371185029Spjdtypedef struct zfs_znode_acl { 1372185029Spjd uint64_t z_acl_extern_obj; /* ext acl pieces */ 1373185029Spjd uint32_t z_acl_count; /* Number of ACEs */ 1374185029Spjd uint16_t z_acl_version; /* acl version */ 1375185029Spjd uint16_t z_acl_pad; /* pad */ 1376185029Spjd ace_t z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */ 1377185029Spjd} zfs_znode_acl_t; 1378185029Spjd 1379185029Spjd/* 1380185029Spjd * This is the persistent portion of the znode. It is stored 1381185029Spjd * in the "bonus buffer" of the file. Short symbolic links 1382185029Spjd * are also stored in the bonus buffer. 1383185029Spjd */ 1384185029Spjdtypedef struct znode_phys { 1385185029Spjd uint64_t zp_atime[2]; /* 0 - last file access time */ 1386185029Spjd uint64_t zp_mtime[2]; /* 16 - last file modification time */ 1387185029Spjd uint64_t zp_ctime[2]; /* 32 - last file change time */ 1388185029Spjd uint64_t zp_crtime[2]; /* 48 - creation time */ 1389185029Spjd uint64_t zp_gen; /* 64 - generation (txg of creation) */ 1390185029Spjd uint64_t zp_mode; /* 72 - file mode bits */ 1391185029Spjd uint64_t zp_size; /* 80 - size of file */ 1392185029Spjd uint64_t zp_parent; /* 88 - directory parent (`..') */ 1393185029Spjd uint64_t zp_links; /* 96 - number of links to file */ 1394185029Spjd uint64_t zp_xattr; /* 104 - DMU object for xattrs */ 1395185029Spjd uint64_t zp_rdev; /* 112 - dev_t for VBLK & VCHR files */ 1396185029Spjd uint64_t zp_flags; /* 120 - persistent flags */ 1397185029Spjd uint64_t zp_uid; /* 128 - file owner */ 1398185029Spjd uint64_t zp_gid; /* 136 - owning group */ 1399185029Spjd uint64_t zp_pad[4]; /* 144 - future */ 1400185029Spjd zfs_znode_acl_t zp_acl; /* 176 - 263 ACL */ 1401185029Spjd /* 1402185029Spjd * Data may pad out any remaining bytes in the znode buffer, eg: 1403185029Spjd * 1404185029Spjd * |<---------------------- dnode_phys (512) ------------------------>| 1405185029Spjd * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->| 1406185029Spjd * |<---- znode (264) ---->|<---- data (56) ---->| 1407185029Spjd * 1408185029Spjd * At present, we only use this space to store symbolic links. 1409185029Spjd */ 1410185029Spjd} znode_phys_t; 1411185029Spjd 1412185029Spjd/* 1413185029Spjd * In-core vdev representation. 1414185029Spjd */ 1415185029Spjdstruct vdev; 1416192194Sdfrtypedef int vdev_phys_read_t(struct vdev *vdev, void *priv, 1417192194Sdfr off_t offset, void *buf, size_t bytes); 1418192194Sdfrtypedef int vdev_read_t(struct vdev *vdev, const blkptr_t *bp, 1419192194Sdfr void *buf, off_t offset, size_t bytes); 1420185029Spjd 1421185029Spjdtypedef STAILQ_HEAD(vdev_list, vdev) vdev_list_t; 1422185029Spjd 1423185029Spjdtypedef struct vdev { 1424185029Spjd STAILQ_ENTRY(vdev) v_childlink; /* link in parent's child list */ 1425185029Spjd STAILQ_ENTRY(vdev) v_alllink; /* link in global vdev list */ 1426185029Spjd vdev_list_t v_children; /* children of this vdev */ 1427219089Spjd const char *v_name; /* vdev name */ 1428185029Spjd uint64_t v_guid; /* vdev guid */ 1429185029Spjd int v_id; /* index in parent */ 1430192194Sdfr int v_ashift; /* offset to block shift */ 1431192194Sdfr int v_nparity; /* # parity for raidz */ 1432219089Spjd struct vdev *v_top; /* parent vdev */ 1433192194Sdfr int v_nchildren; /* # children */ 1434185029Spjd vdev_state_t v_state; /* current state */ 1435192194Sdfr vdev_phys_read_t *v_phys_read; /* read from raw leaf vdev */ 1436192194Sdfr vdev_read_t *v_read; /* read from vdev */ 1437185029Spjd void *v_read_priv; /* private data for read function */ 1438185029Spjd} vdev_t; 1439185029Spjd 1440185029Spjd/* 1441185029Spjd * In-core pool representation. 1442185029Spjd */ 1443185029Spjdtypedef STAILQ_HEAD(spa_list, spa) spa_list_t; 1444185029Spjd 1445185029Spjdtypedef struct spa { 1446185029Spjd STAILQ_ENTRY(spa) spa_link; /* link in global pool list */ 1447185029Spjd char *spa_name; /* pool name */ 1448185029Spjd uint64_t spa_guid; /* pool guid */ 1449185029Spjd uint64_t spa_txg; /* most recent transaction */ 1450185029Spjd struct uberblock spa_uberblock; /* best uberblock so far */ 1451185029Spjd vdev_list_t spa_vdevs; /* list of all toplevel vdevs */ 1452185029Spjd objset_phys_t spa_mos; /* MOS for this pool */ 1453235343Savg int spa_inited; /* initialized */ 1454185029Spjd} spa_t; 1455268649Sdelphij 1456268649Sdelphijstatic void decode_embedded_bp_compressed(const blkptr_t *, void *); 1457