108487eeaSToomas Soome /* 2199767f8SToomas Soome * Copyright (c) 2002 McAfee, Inc. 3199767f8SToomas Soome * All rights reserved. 4199767f8SToomas Soome * 5199767f8SToomas Soome * This software was developed for the FreeBSD Project by Marshall 6199767f8SToomas Soome * Kirk McKusick and McAfee Research,, the Security Research Division of 7199767f8SToomas Soome * McAfee, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as 8199767f8SToomas Soome * part of the DARPA CHATS research program 9199767f8SToomas Soome * 10199767f8SToomas Soome * Redistribution and use in source and binary forms, with or without 11199767f8SToomas Soome * modification, are permitted provided that the following conditions 12199767f8SToomas Soome * are met: 13199767f8SToomas Soome * 1. Redistributions of source code must retain the above copyright 14199767f8SToomas Soome * notice, this list of conditions and the following disclaimer. 15199767f8SToomas Soome * 2. Redistributions in binary form must reproduce the above copyright 16199767f8SToomas Soome * notice, this list of conditions and the following disclaimer in the 17199767f8SToomas Soome * documentation and/or other materials provided with the distribution. 18199767f8SToomas Soome * 19199767f8SToomas Soome * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20199767f8SToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21199767f8SToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22199767f8SToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23199767f8SToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24199767f8SToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25199767f8SToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26199767f8SToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27199767f8SToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28199767f8SToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29199767f8SToomas Soome * SUCH DAMAGE. 30199767f8SToomas Soome */ 31199767f8SToomas Soome /* 32199767f8SToomas Soome * CDDL HEADER START 33199767f8SToomas Soome * 34199767f8SToomas Soome * The contents of this file are subject to the terms of the 35199767f8SToomas Soome * Common Development and Distribution License (the "License"). 36199767f8SToomas Soome * You may not use this file except in compliance with the License. 37199767f8SToomas Soome * 38199767f8SToomas Soome * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 39199767f8SToomas Soome * or http://www.opensolaris.org/os/licensing. 40199767f8SToomas Soome * See the License for the specific language governing permissions 41199767f8SToomas Soome * and limitations under the License. 42199767f8SToomas Soome * 43199767f8SToomas Soome * When distributing Covered Code, include this CDDL HEADER in each 44199767f8SToomas Soome * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 45199767f8SToomas Soome * If applicable, add the following below this CDDL HEADER, with the 46199767f8SToomas Soome * fields enclosed by brackets "[]" replaced with your own identifying 47199767f8SToomas Soome * information: Portions Copyright [yyyy] [name of copyright owner] 48199767f8SToomas Soome * 49199767f8SToomas Soome * CDDL HEADER END 50199767f8SToomas Soome */ 51199767f8SToomas Soome /* 52199767f8SToomas Soome * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 53199767f8SToomas Soome * Use is subject to license terms. 54199767f8SToomas Soome */ 55199767f8SToomas Soome /* 56199767f8SToomas Soome * Copyright 2013 by Saso Kiselkov. All rights reserved. 57199767f8SToomas Soome */ 58199767f8SToomas Soome /* 59199767f8SToomas Soome * Copyright (c) 2013 by Delphix. All rights reserved. 60199767f8SToomas Soome */ 61199767f8SToomas Soome 62*b713c91eSToomas Soome #ifndef _ZFSIMPL_H_ 63*b713c91eSToomas Soome #define _ZFSIMPL_H_ 64*b713c91eSToomas Soome 65*b713c91eSToomas Soome #include <sys/queue.h> 66*b713c91eSToomas Soome #include <sys/list.h> 67*b713c91eSToomas Soome #include <bootstrap.h> 6808487eeaSToomas Soome 69199767f8SToomas Soome #define MAXNAMELEN 256 70199767f8SToomas Soome 71199767f8SToomas Soome #define _NOTE(s) 72199767f8SToomas Soome 737dcf02b3SToomas Soome /* 747dcf02b3SToomas Soome * AVL comparator helpers 757dcf02b3SToomas Soome */ 767dcf02b3SToomas Soome #define AVL_ISIGN(a) (((a) > 0) - ((a) < 0)) 777dcf02b3SToomas Soome #define AVL_CMP(a, b) (((a) > (b)) - ((a) < (b))) 787dcf02b3SToomas Soome #define AVL_PCMP(a, b) \ 797dcf02b3SToomas Soome (((uintptr_t)(a) > (uintptr_t)(b)) - ((uintptr_t)(a) < (uintptr_t)(b))) 807dcf02b3SToomas Soome 81199767f8SToomas Soome /* CRC64 table */ 82199767f8SToomas Soome #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ 83199767f8SToomas Soome 84199767f8SToomas Soome /* 85199767f8SToomas Soome * Macros for various sorts of alignment and rounding when the alignment 86199767f8SToomas Soome * is known to be a power of 2. 87199767f8SToomas Soome */ 88199767f8SToomas Soome #define P2ALIGN(x, align) ((x) & -(align)) 89199767f8SToomas Soome #define P2PHASE(x, align) ((x) & ((align) - 1)) 90199767f8SToomas Soome #define P2NPHASE(x, align) (-(x) & ((align) - 1)) 91199767f8SToomas Soome #define P2ROUNDUP(x, align) (-(-(x) & -(align))) 92199767f8SToomas Soome #define P2END(x, align) (-(~(x) & -(align))) 93199767f8SToomas Soome #define P2PHASEUP(x, align, phase) ((phase) - (((phase) - (x)) & -(align))) 9408487eeaSToomas Soome #define P2BOUNDARY(off, len, align) \ 9508487eeaSToomas Soome (((off) ^ ((off) + (len) - 1)) > (align) - 1) 96199767f8SToomas Soome 97199767f8SToomas Soome /* 98199767f8SToomas Soome * General-purpose 32-bit and 64-bit bitfield encodings. 99199767f8SToomas Soome */ 100199767f8SToomas Soome #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len)) 101199767f8SToomas Soome #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len)) 102199767f8SToomas Soome #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low)) 103199767f8SToomas Soome #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low)) 104199767f8SToomas Soome 105199767f8SToomas Soome #define BF32_GET(x, low, len) BF32_DECODE(x, low, len) 106199767f8SToomas Soome #define BF64_GET(x, low, len) BF64_DECODE(x, low, len) 107199767f8SToomas Soome 108199767f8SToomas Soome #define BF32_SET(x, low, len, val) \ 109199767f8SToomas Soome ((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len)) 110199767f8SToomas Soome #define BF64_SET(x, low, len, val) \ 111199767f8SToomas Soome ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)) 112199767f8SToomas Soome 113199767f8SToomas Soome #define BF32_GET_SB(x, low, len, shift, bias) \ 114199767f8SToomas Soome ((BF32_GET(x, low, len) + (bias)) << (shift)) 115199767f8SToomas Soome #define BF64_GET_SB(x, low, len, shift, bias) \ 116199767f8SToomas Soome ((BF64_GET(x, low, len) + (bias)) << (shift)) 117199767f8SToomas Soome 118199767f8SToomas Soome #define BF32_SET_SB(x, low, len, shift, bias, val) \ 119199767f8SToomas Soome BF32_SET(x, low, len, ((val) >> (shift)) - (bias)) 120199767f8SToomas Soome #define BF64_SET_SB(x, low, len, shift, bias, val) \ 121199767f8SToomas Soome BF64_SET(x, low, len, ((val) >> (shift)) - (bias)) 122199767f8SToomas Soome 123199767f8SToomas Soome /* 124199767f8SToomas Soome * Macros to reverse byte order 125199767f8SToomas Soome */ 126199767f8SToomas Soome #define BSWAP_8(x) ((x) & 0xff) 127199767f8SToomas Soome #define BSWAP_16(x) ((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8)) 128199767f8SToomas Soome #define BSWAP_32(x) ((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16)) 129199767f8SToomas Soome #define BSWAP_64(x) ((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32)) 130199767f8SToomas Soome 131199767f8SToomas Soome #define SPA_MINBLOCKSHIFT 9 132199767f8SToomas Soome #define SPA_OLDMAXBLOCKSHIFT 17 133199767f8SToomas Soome #define SPA_MAXBLOCKSHIFT 24 134199767f8SToomas Soome #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT) 135199767f8SToomas Soome #define SPA_OLDMAXBLOCKSIZE (1ULL << SPA_OLDMAXBLOCKSHIFT) 136199767f8SToomas Soome #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT) 137199767f8SToomas Soome 138199767f8SToomas Soome /* 139199767f8SToomas Soome * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB. 140199767f8SToomas Soome * The ASIZE encoding should be at least 64 times larger (6 more bits) 141199767f8SToomas Soome * to support up to 4-way RAID-Z mirror mode with worst-case gang block 142199767f8SToomas Soome * overhead, three DVAs per bp, plus one more bit in case we do anything 143199767f8SToomas Soome * else that expands the ASIZE. 144199767f8SToomas Soome */ 145199767f8SToomas Soome #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */ 146199767f8SToomas Soome #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */ 147199767f8SToomas Soome #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */ 148199767f8SToomas Soome 149199767f8SToomas Soome /* 150199767f8SToomas Soome * All SPA data is represented by 128-bit data virtual addresses (DVAs). 151199767f8SToomas Soome * The members of the dva_t should be considered opaque outside the SPA. 152199767f8SToomas Soome */ 153199767f8SToomas Soome typedef struct dva { 154199767f8SToomas Soome uint64_t dva_word[2]; 155199767f8SToomas Soome } dva_t; 156199767f8SToomas Soome 157199767f8SToomas Soome /* 158199767f8SToomas Soome * Each block has a 256-bit checksum -- strong enough for cryptographic hashes. 159199767f8SToomas Soome */ 160199767f8SToomas Soome typedef struct zio_cksum { 161199767f8SToomas Soome uint64_t zc_word[4]; 162199767f8SToomas Soome } zio_cksum_t; 163199767f8SToomas Soome 164199767f8SToomas Soome /* 165199767f8SToomas Soome * Some checksums/hashes need a 256-bit initialization salt. This salt is kept 166199767f8SToomas Soome * secret and is suitable for use in MAC algorithms as the key. 167199767f8SToomas Soome */ 168199767f8SToomas Soome typedef struct zio_cksum_salt { 169199767f8SToomas Soome uint8_t zcs_bytes[32]; 170199767f8SToomas Soome } zio_cksum_salt_t; 171199767f8SToomas Soome 172199767f8SToomas Soome /* 173199767f8SToomas Soome * Each block is described by its DVAs, time of birth, checksum, etc. 174199767f8SToomas Soome * The word-by-word, bit-by-bit layout of the blkptr is as follows: 175199767f8SToomas Soome * 176199767f8SToomas Soome * 64 56 48 40 32 24 16 8 0 177199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 178199767f8SToomas Soome * 0 | vdev1 | GRID | ASIZE | 179199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 180199767f8SToomas Soome * 1 |G| offset1 | 181199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 182199767f8SToomas Soome * 2 | vdev2 | GRID | ASIZE | 183199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 184199767f8SToomas Soome * 3 |G| offset2 | 185199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 186199767f8SToomas Soome * 4 | vdev3 | GRID | ASIZE | 187199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 188199767f8SToomas Soome * 5 |G| offset3 | 189199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 190199767f8SToomas Soome * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE | 191199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 192199767f8SToomas Soome * 7 | padding | 193199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 194199767f8SToomas Soome * 8 | padding | 195199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 196199767f8SToomas Soome * 9 | physical birth txg | 197199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 198199767f8SToomas Soome * a | logical birth txg | 199199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 200199767f8SToomas Soome * b | fill count | 201199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 202199767f8SToomas Soome * c | checksum[0] | 203199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 204199767f8SToomas Soome * d | checksum[1] | 205199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 206199767f8SToomas Soome * e | checksum[2] | 207199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 208199767f8SToomas Soome * f | checksum[3] | 209199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 210199767f8SToomas Soome * 211199767f8SToomas Soome * Legend: 212199767f8SToomas Soome * 213199767f8SToomas Soome * vdev virtual device ID 214199767f8SToomas Soome * offset offset into virtual device 215199767f8SToomas Soome * LSIZE logical size 216199767f8SToomas Soome * PSIZE physical size (after compression) 217199767f8SToomas Soome * ASIZE allocated size (including RAID-Z parity and gang block headers) 218199767f8SToomas Soome * GRID RAID-Z layout information (reserved for future use) 219199767f8SToomas Soome * cksum checksum function 220199767f8SToomas Soome * comp compression function 221199767f8SToomas Soome * G gang block indicator 222199767f8SToomas Soome * B byteorder (endianness) 223199767f8SToomas Soome * D dedup 224199767f8SToomas Soome * X encryption (on version 30, which is not supported) 225199767f8SToomas Soome * E blkptr_t contains embedded data (see below) 226199767f8SToomas Soome * lvl level of indirection 227199767f8SToomas Soome * type DMU object type 228199767f8SToomas Soome * phys birth txg of block allocation; zero if same as logical birth txg 229199767f8SToomas Soome * log. birth transaction group in which the block was logically born 230199767f8SToomas Soome * fill count number of non-zero blocks under this bp 231199767f8SToomas Soome * checksum[4] 256-bit checksum of the data this bp describes 232199767f8SToomas Soome */ 233199767f8SToomas Soome 234199767f8SToomas Soome /* 235199767f8SToomas Soome * "Embedded" blkptr_t's don't actually point to a block, instead they 236199767f8SToomas Soome * have a data payload embedded in the blkptr_t itself. See the comment 237199767f8SToomas Soome * in blkptr.c for more details. 238199767f8SToomas Soome * 239199767f8SToomas Soome * The blkptr_t is laid out as follows: 240199767f8SToomas Soome * 241199767f8SToomas Soome * 64 56 48 40 32 24 16 8 0 242199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 243199767f8SToomas Soome * 0 | payload | 244199767f8SToomas Soome * 1 | payload | 245199767f8SToomas Soome * 2 | payload | 246199767f8SToomas Soome * 3 | payload | 247199767f8SToomas Soome * 4 | payload | 248199767f8SToomas Soome * 5 | payload | 249199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 250199767f8SToomas Soome * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE | 251199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 252199767f8SToomas Soome * 7 | payload | 253199767f8SToomas Soome * 8 | payload | 254199767f8SToomas Soome * 9 | payload | 255199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 256199767f8SToomas Soome * a | logical birth txg | 257199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 258199767f8SToomas Soome * b | payload | 259199767f8SToomas Soome * c | payload | 260199767f8SToomas Soome * d | payload | 261199767f8SToomas Soome * e | payload | 262199767f8SToomas Soome * f | payload | 263199767f8SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 264199767f8SToomas Soome * 265199767f8SToomas Soome * Legend: 266199767f8SToomas Soome * 267199767f8SToomas Soome * payload contains the embedded data 268199767f8SToomas Soome * B (byteorder) byteorder (endianness) 269199767f8SToomas Soome * D (dedup) padding (set to zero) 270199767f8SToomas Soome * X encryption (set to zero; see above) 271199767f8SToomas Soome * E (embedded) set to one 272199767f8SToomas Soome * lvl indirection level 273199767f8SToomas Soome * type DMU object type 274199767f8SToomas Soome * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*) 275199767f8SToomas Soome * comp compression function of payload 276199767f8SToomas Soome * PSIZE size of payload after compression, in bytes 277199767f8SToomas Soome * LSIZE logical size of payload, in bytes 278199767f8SToomas Soome * note that 25 bits is enough to store the largest 279199767f8SToomas Soome * "normal" BP's LSIZE (2^16 * 2^9) in bytes 280199767f8SToomas Soome * log. birth transaction group in which the block was logically born 281199767f8SToomas Soome * 282199767f8SToomas Soome * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded 283199767f8SToomas Soome * bp's they are stored in units of SPA_MINBLOCKSHIFT. 284199767f8SToomas Soome * Generally, the generic BP_GET_*() macros can be used on embedded BP's. 285199767f8SToomas Soome * The B, D, X, lvl, type, and comp fields are stored the same as with normal 286199767f8SToomas Soome * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must 287199767f8SToomas Soome * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before 288199767f8SToomas Soome * other macros, as they assert that they are only used on BP's of the correct 289199767f8SToomas Soome * "embedded-ness". 290199767f8SToomas Soome */ 291199767f8SToomas Soome 292199767f8SToomas Soome #define BPE_GET_ETYPE(bp) \ 293199767f8SToomas Soome (ASSERT(BP_IS_EMBEDDED(bp)), \ 294199767f8SToomas Soome BF64_GET((bp)->blk_prop, 40, 8)) 295199767f8SToomas Soome #define BPE_SET_ETYPE(bp, t) do { \ 296199767f8SToomas Soome ASSERT(BP_IS_EMBEDDED(bp)); \ 297199767f8SToomas Soome BF64_SET((bp)->blk_prop, 40, 8, t); \ 298199767f8SToomas Soome _NOTE(CONSTCOND) } while (0) 299199767f8SToomas Soome 300199767f8SToomas Soome #define BPE_GET_LSIZE(bp) \ 301199767f8SToomas Soome (ASSERT(BP_IS_EMBEDDED(bp)), \ 302199767f8SToomas Soome BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1)) 303199767f8SToomas Soome #define BPE_SET_LSIZE(bp, x) do { \ 304199767f8SToomas Soome ASSERT(BP_IS_EMBEDDED(bp)); \ 305199767f8SToomas Soome BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \ 306199767f8SToomas Soome _NOTE(CONSTCOND) } while (0) 307199767f8SToomas Soome 308199767f8SToomas Soome #define BPE_GET_PSIZE(bp) \ 309199767f8SToomas Soome (ASSERT(BP_IS_EMBEDDED(bp)), \ 310199767f8SToomas Soome BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1)) 311199767f8SToomas Soome #define BPE_SET_PSIZE(bp, x) do { \ 312199767f8SToomas Soome ASSERT(BP_IS_EMBEDDED(bp)); \ 313199767f8SToomas Soome BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \ 314199767f8SToomas Soome _NOTE(CONSTCOND) } while (0) 315199767f8SToomas Soome 316199767f8SToomas Soome typedef enum bp_embedded_type { 317199767f8SToomas Soome BP_EMBEDDED_TYPE_DATA, 318199767f8SToomas Soome BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */ 319199767f8SToomas Soome NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED 320199767f8SToomas Soome } bp_embedded_type_t; 321199767f8SToomas Soome 322199767f8SToomas Soome #define BPE_NUM_WORDS 14 323199767f8SToomas Soome #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t)) 324199767f8SToomas Soome #define BPE_IS_PAYLOADWORD(bp, wp) \ 325199767f8SToomas Soome ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth) 326199767f8SToomas Soome 327199767f8SToomas Soome #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */ 328199767f8SToomas Soome #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */ 329199767f8SToomas Soome 330199767f8SToomas Soome typedef struct blkptr { 331199767f8SToomas Soome dva_t blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */ 332199767f8SToomas Soome uint64_t blk_prop; /* size, compression, type, etc */ 333199767f8SToomas Soome uint64_t blk_pad[2]; /* Extra space for the future */ 334199767f8SToomas Soome uint64_t blk_phys_birth; /* txg when block was allocated */ 335199767f8SToomas Soome uint64_t blk_birth; /* transaction group at birth */ 336199767f8SToomas Soome uint64_t blk_fill; /* fill count */ 337199767f8SToomas Soome zio_cksum_t blk_cksum; /* 256-bit checksum */ 338199767f8SToomas Soome } blkptr_t; 339199767f8SToomas Soome 340199767f8SToomas Soome /* 341199767f8SToomas Soome * Macros to get and set fields in a bp or DVA. 342199767f8SToomas Soome */ 343199767f8SToomas Soome #define DVA_GET_ASIZE(dva) \ 344199767f8SToomas Soome BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0) 345199767f8SToomas Soome #define DVA_SET_ASIZE(dva, x) \ 346199767f8SToomas Soome BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \ 347199767f8SToomas Soome SPA_MINBLOCKSHIFT, 0, x) 348199767f8SToomas Soome 349199767f8SToomas Soome #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8) 350199767f8SToomas Soome #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x) 351199767f8SToomas Soome 352199767f8SToomas Soome #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32) 353199767f8SToomas Soome #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x) 354199767f8SToomas Soome 355199767f8SToomas Soome #define DVA_GET_OFFSET(dva) \ 356199767f8SToomas Soome BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0) 357199767f8SToomas Soome #define DVA_SET_OFFSET(dva, x) \ 358199767f8SToomas Soome BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x) 359199767f8SToomas Soome 360199767f8SToomas Soome #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1) 361199767f8SToomas Soome #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x) 362199767f8SToomas Soome 363199767f8SToomas Soome #define BP_GET_LSIZE(bp) \ 364199767f8SToomas Soome (BP_IS_EMBEDDED(bp) ? \ 365199767f8SToomas Soome (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \ 366199767f8SToomas Soome BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1)) 367199767f8SToomas Soome #define BP_SET_LSIZE(bp, x) do { \ 368199767f8SToomas Soome ASSERT(!BP_IS_EMBEDDED(bp)); \ 369199767f8SToomas Soome BF64_SET_SB((bp)->blk_prop, \ 370199767f8SToomas Soome 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \ 371199767f8SToomas Soome _NOTE(CONSTCOND) } while (0) 372199767f8SToomas Soome 373199767f8SToomas Soome #define BP_GET_PSIZE(bp) \ 374199767f8SToomas Soome BF64_GET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1) 375199767f8SToomas Soome #define BP_SET_PSIZE(bp, x) \ 376199767f8SToomas Soome BF64_SET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x) 377199767f8SToomas Soome 378199767f8SToomas Soome #define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 7) 379199767f8SToomas Soome #define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 7, x) 380199767f8SToomas Soome 381199767f8SToomas Soome #define BP_GET_CHECKSUM(bp) BF64_GET((bp)->blk_prop, 40, 8) 382199767f8SToomas Soome #define BP_SET_CHECKSUM(bp, x) BF64_SET((bp)->blk_prop, 40, 8, x) 383199767f8SToomas Soome 384199767f8SToomas Soome #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8) 385199767f8SToomas Soome #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x) 386199767f8SToomas Soome 387199767f8SToomas Soome #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5) 388199767f8SToomas Soome #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x) 389199767f8SToomas Soome 390199767f8SToomas Soome #define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1) 391199767f8SToomas Soome 392199767f8SToomas Soome #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1) 393199767f8SToomas Soome #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x) 394199767f8SToomas Soome 395199767f8SToomas Soome #define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1) 396199767f8SToomas Soome #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x) 397199767f8SToomas Soome 398199767f8SToomas Soome #define BP_PHYSICAL_BIRTH(bp) \ 399199767f8SToomas Soome ((bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth) 400199767f8SToomas Soome 401199767f8SToomas Soome #define BP_GET_ASIZE(bp) \ 402199767f8SToomas Soome (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 403199767f8SToomas Soome DVA_GET_ASIZE(&(bp)->blk_dva[2])) 404199767f8SToomas Soome 405199767f8SToomas Soome #define BP_GET_UCSIZE(bp) \ 406199767f8SToomas Soome ((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \ 407199767f8SToomas Soome BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp)); 408199767f8SToomas Soome 409199767f8SToomas Soome #define BP_GET_NDVAS(bp) \ 410199767f8SToomas Soome (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \ 411199767f8SToomas Soome !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 412199767f8SToomas Soome !!DVA_GET_ASIZE(&(bp)->blk_dva[2])) 413199767f8SToomas Soome 414199767f8SToomas Soome #define DVA_EQUAL(dva1, dva2) \ 415199767f8SToomas Soome ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \ 416199767f8SToomas Soome (dva1)->dva_word[0] == (dva2)->dva_word[0]) 417199767f8SToomas Soome 418199767f8SToomas Soome #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \ 419199767f8SToomas Soome (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \ 420199767f8SToomas Soome ((zc1).zc_word[1] - (zc2).zc_word[1]) | \ 421199767f8SToomas Soome ((zc1).zc_word[2] - (zc2).zc_word[2]) | \ 422199767f8SToomas Soome ((zc1).zc_word[3] - (zc2).zc_word[3]))) 423199767f8SToomas Soome 424199767f8SToomas Soome 425199767f8SToomas Soome #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0) 426199767f8SToomas Soome 427199767f8SToomas Soome #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \ 428199767f8SToomas Soome { \ 429199767f8SToomas Soome (zcp)->zc_word[0] = w0; \ 430199767f8SToomas Soome (zcp)->zc_word[1] = w1; \ 431199767f8SToomas Soome (zcp)->zc_word[2] = w2; \ 432199767f8SToomas Soome (zcp)->zc_word[3] = w3; \ 433199767f8SToomas Soome } 434199767f8SToomas Soome 435199767f8SToomas Soome #define BP_IDENTITY(bp) (&(bp)->blk_dva[0]) 436199767f8SToomas Soome #define BP_IS_GANG(bp) DVA_GET_GANG(BP_IDENTITY(bp)) 437199767f8SToomas Soome #define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \ 438199767f8SToomas Soome (dva)->dva_word[1] == 0ULL) 439199767f8SToomas Soome #define BP_IS_HOLE(bp) DVA_IS_EMPTY(BP_IDENTITY(bp)) 440199767f8SToomas Soome #define BP_IS_OLDER(bp, txg) (!BP_IS_HOLE(bp) && (bp)->blk_birth < (txg)) 441199767f8SToomas Soome 442199767f8SToomas Soome #define BP_ZERO(bp) \ 443199767f8SToomas Soome { \ 444199767f8SToomas Soome (bp)->blk_dva[0].dva_word[0] = 0; \ 445199767f8SToomas Soome (bp)->blk_dva[0].dva_word[1] = 0; \ 446199767f8SToomas Soome (bp)->blk_dva[1].dva_word[0] = 0; \ 447199767f8SToomas Soome (bp)->blk_dva[1].dva_word[1] = 0; \ 448199767f8SToomas Soome (bp)->blk_dva[2].dva_word[0] = 0; \ 449199767f8SToomas Soome (bp)->blk_dva[2].dva_word[1] = 0; \ 450199767f8SToomas Soome (bp)->blk_prop = 0; \ 451199767f8SToomas Soome (bp)->blk_pad[0] = 0; \ 452199767f8SToomas Soome (bp)->blk_pad[1] = 0; \ 453199767f8SToomas Soome (bp)->blk_phys_birth = 0; \ 454199767f8SToomas Soome (bp)->blk_birth = 0; \ 455199767f8SToomas Soome (bp)->blk_fill = 0; \ 456199767f8SToomas Soome ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \ 457199767f8SToomas Soome } 458199767f8SToomas Soome 459ece0bc84SToomas Soome #if BYTE_ORDER == _BIG_ENDIAN 460ece0bc84SToomas Soome #define ZFS_HOST_BYTEORDER (0ULL) 461ece0bc84SToomas Soome #else 462ece0bc84SToomas Soome #define ZFS_HOST_BYTEORDER (1ULL) 463ece0bc84SToomas Soome #endif 464ece0bc84SToomas Soome 465ece0bc84SToomas Soome #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER) 466199767f8SToomas Soome #define BPE_NUM_WORDS 14 467199767f8SToomas Soome #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t)) 468199767f8SToomas Soome #define BPE_IS_PAYLOADWORD(bp, wp) \ 469199767f8SToomas Soome ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth) 470199767f8SToomas Soome 471199767f8SToomas Soome /* 472199767f8SToomas Soome * Embedded checksum 473199767f8SToomas Soome */ 474199767f8SToomas Soome #define ZEC_MAGIC 0x210da7ab10c7a11ULL 475199767f8SToomas Soome 476199767f8SToomas Soome typedef struct zio_eck { 477199767f8SToomas Soome uint64_t zec_magic; /* for validation, endianness */ 478199767f8SToomas Soome zio_cksum_t zec_cksum; /* 256-bit checksum */ 479199767f8SToomas Soome } zio_eck_t; 480199767f8SToomas Soome 481199767f8SToomas Soome /* 482199767f8SToomas Soome * Gang block headers are self-checksumming and contain an array 483199767f8SToomas Soome * of block pointers. 484199767f8SToomas Soome */ 485199767f8SToomas Soome #define SPA_GANGBLOCKSIZE SPA_MINBLOCKSIZE 486199767f8SToomas Soome #define SPA_GBH_NBLKPTRS ((SPA_GANGBLOCKSIZE - \ 487199767f8SToomas Soome sizeof (zio_eck_t)) / sizeof (blkptr_t)) 488199767f8SToomas Soome #define SPA_GBH_FILLER ((SPA_GANGBLOCKSIZE - \ 489199767f8SToomas Soome sizeof (zio_eck_t) - \ 490199767f8SToomas Soome (SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\ 491199767f8SToomas Soome sizeof (uint64_t)) 492199767f8SToomas Soome 493199767f8SToomas Soome typedef struct zio_gbh { 494199767f8SToomas Soome blkptr_t zg_blkptr[SPA_GBH_NBLKPTRS]; 495199767f8SToomas Soome uint64_t zg_filler[SPA_GBH_FILLER]; 496199767f8SToomas Soome zio_eck_t zg_tail; 497199767f8SToomas Soome } zio_gbh_phys_t; 498199767f8SToomas Soome 499199767f8SToomas Soome #define VDEV_RAIDZ_MAXPARITY 3 500199767f8SToomas Soome 501199767f8SToomas Soome #define VDEV_PAD_SIZE (8 << 10) 502*b713c91eSToomas Soome /* 2 padding areas (vl_pad1 and vl_be) to skip */ 503199767f8SToomas Soome #define VDEV_SKIP_SIZE VDEV_PAD_SIZE * 2 504199767f8SToomas Soome #define VDEV_PHYS_SIZE (112 << 10) 505199767f8SToomas Soome #define VDEV_UBERBLOCK_RING (128 << 10) 506199767f8SToomas Soome 5077dcf02b3SToomas Soome /* 5087dcf02b3SToomas Soome * MMP blocks occupy the last MMP_BLOCKS_PER_LABEL slots in the uberblock 5097dcf02b3SToomas Soome * ring when MMP is enabled. 5107dcf02b3SToomas Soome */ 5117dcf02b3SToomas Soome #define MMP_BLOCKS_PER_LABEL 1 5127dcf02b3SToomas Soome 5137dcf02b3SToomas Soome /* The largest uberblock we support is 8k. */ 5147dcf02b3SToomas Soome #define MAX_UBERBLOCK_SHIFT (13) 515199767f8SToomas Soome #define VDEV_UBERBLOCK_SHIFT(vd) \ 5167dcf02b3SToomas Soome MIN(MAX((vd)->v_top->v_ashift, UBERBLOCK_SHIFT), MAX_UBERBLOCK_SHIFT) 517199767f8SToomas Soome #define VDEV_UBERBLOCK_COUNT(vd) \ 518199767f8SToomas Soome (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd)) 519199767f8SToomas Soome #define VDEV_UBERBLOCK_OFFSET(vd, n) \ 520199767f8SToomas Soome offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)]) 521199767f8SToomas Soome #define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd)) 522199767f8SToomas Soome 523199767f8SToomas Soome typedef struct vdev_phys { 524199767f8SToomas Soome char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_eck_t)]; 525199767f8SToomas Soome zio_eck_t vp_zbt; 526199767f8SToomas Soome } vdev_phys_t; 527199767f8SToomas Soome 528*b713c91eSToomas Soome typedef enum vbe_vers { 529*b713c91eSToomas Soome /* The bootenv file is stored as ascii text in the envblock */ 530*b713c91eSToomas Soome VB_RAW = 0, 531*b713c91eSToomas Soome 532*b713c91eSToomas Soome /* 533*b713c91eSToomas Soome * The bootenv file is converted to an nvlist and then packed into the 534*b713c91eSToomas Soome * envblock. 535*b713c91eSToomas Soome */ 536*b713c91eSToomas Soome VB_NVLIST = 1 537*b713c91eSToomas Soome } vbe_vers_t; 538*b713c91eSToomas Soome 539*b713c91eSToomas Soome typedef struct vdev_boot_envblock { 540*b713c91eSToomas Soome uint64_t vbe_version; 541*b713c91eSToomas Soome char vbe_bootenv[VDEV_PAD_SIZE - sizeof (uint64_t) - 542*b713c91eSToomas Soome sizeof (zio_eck_t)]; 543*b713c91eSToomas Soome zio_eck_t vbe_zbt; 544*b713c91eSToomas Soome } vdev_boot_envblock_t; 545*b713c91eSToomas Soome 546*b713c91eSToomas Soome CTASSERT(sizeof (vdev_boot_envblock_t) == VDEV_PAD_SIZE); 547*b713c91eSToomas Soome 548199767f8SToomas Soome typedef struct vdev_label { 549199767f8SToomas Soome char vl_pad1[VDEV_PAD_SIZE]; /* 8K */ 550*b713c91eSToomas Soome vdev_boot_envblock_t vl_be; /* 8K */ 551199767f8SToomas Soome vdev_phys_t vl_vdev_phys; /* 112K */ 552199767f8SToomas Soome char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */ 553199767f8SToomas Soome } vdev_label_t; /* 256K total */ 554199767f8SToomas Soome 555199767f8SToomas Soome /* 556199767f8SToomas Soome * vdev_dirty() flags 557199767f8SToomas Soome */ 558199767f8SToomas Soome #define VDD_METASLAB 0x01 559199767f8SToomas Soome #define VDD_DTL 0x02 560199767f8SToomas Soome 561199767f8SToomas Soome /* 562199767f8SToomas Soome * Size and offset of embedded boot loader region on each label. 563199767f8SToomas Soome * The total size of the first two labels plus the boot area is 4MB. 564199767f8SToomas Soome */ 565199767f8SToomas Soome #define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 566199767f8SToomas Soome #define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 567199767f8SToomas Soome 568199767f8SToomas Soome /* 569199767f8SToomas Soome * Size of label regions at the start and end of each leaf device. 570199767f8SToomas Soome */ 571199767f8SToomas Soome #define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 572199767f8SToomas Soome #define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 573199767f8SToomas Soome #define VDEV_LABELS 4 574199767f8SToomas Soome 575199767f8SToomas Soome enum zio_checksum { 576199767f8SToomas Soome ZIO_CHECKSUM_INHERIT = 0, 577199767f8SToomas Soome ZIO_CHECKSUM_ON, 578199767f8SToomas Soome ZIO_CHECKSUM_OFF, 579199767f8SToomas Soome ZIO_CHECKSUM_LABEL, 580199767f8SToomas Soome ZIO_CHECKSUM_GANG_HEADER, 581199767f8SToomas Soome ZIO_CHECKSUM_ZILOG, 582199767f8SToomas Soome ZIO_CHECKSUM_FLETCHER_2, 583199767f8SToomas Soome ZIO_CHECKSUM_FLETCHER_4, 584199767f8SToomas Soome ZIO_CHECKSUM_SHA256, 585199767f8SToomas Soome ZIO_CHECKSUM_ZILOG2, 586199767f8SToomas Soome ZIO_CHECKSUM_NOPARITY, 587199767f8SToomas Soome ZIO_CHECKSUM_SHA512, 588199767f8SToomas Soome ZIO_CHECKSUM_SKEIN, 589199767f8SToomas Soome ZIO_CHECKSUM_EDONR, 590199767f8SToomas Soome ZIO_CHECKSUM_FUNCTIONS 591199767f8SToomas Soome }; 592199767f8SToomas Soome 593199767f8SToomas Soome #define ZIO_CHECKSUM_ON_VALUE ZIO_CHECKSUM_FLETCHER_4 594199767f8SToomas Soome #define ZIO_CHECKSUM_DEFAULT ZIO_CHECKSUM_ON 595199767f8SToomas Soome 596199767f8SToomas Soome enum zio_compress { 597199767f8SToomas Soome ZIO_COMPRESS_INHERIT = 0, 598199767f8SToomas Soome ZIO_COMPRESS_ON, 599199767f8SToomas Soome ZIO_COMPRESS_OFF, 600199767f8SToomas Soome ZIO_COMPRESS_LZJB, 601199767f8SToomas Soome ZIO_COMPRESS_EMPTY, 602199767f8SToomas Soome ZIO_COMPRESS_GZIP_1, 603199767f8SToomas Soome ZIO_COMPRESS_GZIP_2, 604199767f8SToomas Soome ZIO_COMPRESS_GZIP_3, 605199767f8SToomas Soome ZIO_COMPRESS_GZIP_4, 606199767f8SToomas Soome ZIO_COMPRESS_GZIP_5, 607199767f8SToomas Soome ZIO_COMPRESS_GZIP_6, 608199767f8SToomas Soome ZIO_COMPRESS_GZIP_7, 609199767f8SToomas Soome ZIO_COMPRESS_GZIP_8, 610199767f8SToomas Soome ZIO_COMPRESS_GZIP_9, 611199767f8SToomas Soome ZIO_COMPRESS_ZLE, 612199767f8SToomas Soome ZIO_COMPRESS_LZ4, 613199767f8SToomas Soome ZIO_COMPRESS_FUNCTIONS 614199767f8SToomas Soome }; 615199767f8SToomas Soome 616199767f8SToomas Soome #define ZIO_COMPRESS_ON_VALUE ZIO_COMPRESS_LZJB 617199767f8SToomas Soome #define ZIO_COMPRESS_DEFAULT ZIO_COMPRESS_OFF 618199767f8SToomas Soome 619199767f8SToomas Soome /* nvlist pack encoding */ 620199767f8SToomas Soome #define NV_ENCODE_NATIVE 0 621199767f8SToomas Soome #define NV_ENCODE_XDR 1 622199767f8SToomas Soome 623199767f8SToomas Soome typedef enum { 624199767f8SToomas Soome DATA_TYPE_UNKNOWN = 0, 625199767f8SToomas Soome DATA_TYPE_BOOLEAN, 626199767f8SToomas Soome DATA_TYPE_BYTE, 627199767f8SToomas Soome DATA_TYPE_INT16, 628199767f8SToomas Soome DATA_TYPE_UINT16, 629199767f8SToomas Soome DATA_TYPE_INT32, 630199767f8SToomas Soome DATA_TYPE_UINT32, 631199767f8SToomas Soome DATA_TYPE_INT64, 632199767f8SToomas Soome DATA_TYPE_UINT64, 633199767f8SToomas Soome DATA_TYPE_STRING, 634199767f8SToomas Soome DATA_TYPE_BYTE_ARRAY, 635199767f8SToomas Soome DATA_TYPE_INT16_ARRAY, 636199767f8SToomas Soome DATA_TYPE_UINT16_ARRAY, 637199767f8SToomas Soome DATA_TYPE_INT32_ARRAY, 638199767f8SToomas Soome DATA_TYPE_UINT32_ARRAY, 639199767f8SToomas Soome DATA_TYPE_INT64_ARRAY, 640199767f8SToomas Soome DATA_TYPE_UINT64_ARRAY, 641199767f8SToomas Soome DATA_TYPE_STRING_ARRAY, 642199767f8SToomas Soome DATA_TYPE_HRTIME, 643199767f8SToomas Soome DATA_TYPE_NVLIST, 644199767f8SToomas Soome DATA_TYPE_NVLIST_ARRAY, 645199767f8SToomas Soome DATA_TYPE_BOOLEAN_VALUE, 646199767f8SToomas Soome DATA_TYPE_INT8, 647199767f8SToomas Soome DATA_TYPE_UINT8, 648199767f8SToomas Soome DATA_TYPE_BOOLEAN_ARRAY, 649199767f8SToomas Soome DATA_TYPE_INT8_ARRAY, 650199767f8SToomas Soome DATA_TYPE_UINT8_ARRAY 651199767f8SToomas Soome } data_type_t; 652199767f8SToomas Soome 653199767f8SToomas Soome /* 654199767f8SToomas Soome * On-disk version number. 655199767f8SToomas Soome */ 656199767f8SToomas Soome #define SPA_VERSION_1 1ULL 657199767f8SToomas Soome #define SPA_VERSION_2 2ULL 658199767f8SToomas Soome #define SPA_VERSION_3 3ULL 659199767f8SToomas Soome #define SPA_VERSION_4 4ULL 660199767f8SToomas Soome #define SPA_VERSION_5 5ULL 661199767f8SToomas Soome #define SPA_VERSION_6 6ULL 662199767f8SToomas Soome #define SPA_VERSION_7 7ULL 663199767f8SToomas Soome #define SPA_VERSION_8 8ULL 664199767f8SToomas Soome #define SPA_VERSION_9 9ULL 665199767f8SToomas Soome #define SPA_VERSION_10 10ULL 666199767f8SToomas Soome #define SPA_VERSION_11 11ULL 667199767f8SToomas Soome #define SPA_VERSION_12 12ULL 668199767f8SToomas Soome #define SPA_VERSION_13 13ULL 669199767f8SToomas Soome #define SPA_VERSION_14 14ULL 670199767f8SToomas Soome #define SPA_VERSION_15 15ULL 671199767f8SToomas Soome #define SPA_VERSION_16 16ULL 672199767f8SToomas Soome #define SPA_VERSION_17 17ULL 673199767f8SToomas Soome #define SPA_VERSION_18 18ULL 674199767f8SToomas Soome #define SPA_VERSION_19 19ULL 675199767f8SToomas Soome #define SPA_VERSION_20 20ULL 676199767f8SToomas Soome #define SPA_VERSION_21 21ULL 677199767f8SToomas Soome #define SPA_VERSION_22 22ULL 678199767f8SToomas Soome #define SPA_VERSION_23 23ULL 679199767f8SToomas Soome #define SPA_VERSION_24 24ULL 680199767f8SToomas Soome #define SPA_VERSION_25 25ULL 681199767f8SToomas Soome #define SPA_VERSION_26 26ULL 682199767f8SToomas Soome #define SPA_VERSION_27 27ULL 683199767f8SToomas Soome #define SPA_VERSION_28 28ULL 684199767f8SToomas Soome #define SPA_VERSION_5000 5000ULL 685199767f8SToomas Soome 686199767f8SToomas Soome /* 687199767f8SToomas Soome * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 688199767f8SToomas Soome * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 689199767f8SToomas Soome * and do the appropriate changes. Also bump the version number in 690199767f8SToomas Soome * usr/src/grub/capability. 691199767f8SToomas Soome */ 692199767f8SToomas Soome #define SPA_VERSION SPA_VERSION_5000 693199767f8SToomas Soome #define SPA_VERSION_STRING "5000" 694199767f8SToomas Soome 695199767f8SToomas Soome /* 696199767f8SToomas Soome * Symbolic names for the changes that caused a SPA_VERSION switch. 697199767f8SToomas Soome * Used in the code when checking for presence or absence of a feature. 698199767f8SToomas Soome * Feel free to define multiple symbolic names for each version if there 699199767f8SToomas Soome * were multiple changes to on-disk structures during that version. 700199767f8SToomas Soome * 701199767f8SToomas Soome * NOTE: When checking the current SPA_VERSION in your code, be sure 702199767f8SToomas Soome * to use spa_version() since it reports the version of the 703199767f8SToomas Soome * last synced uberblock. Checking the in-flight version can 704199767f8SToomas Soome * be dangerous in some cases. 705199767f8SToomas Soome */ 706199767f8SToomas Soome #define SPA_VERSION_INITIAL SPA_VERSION_1 707199767f8SToomas Soome #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 708199767f8SToomas Soome #define SPA_VERSION_SPARES SPA_VERSION_3 709199767f8SToomas Soome #define SPA_VERSION_RAID6 SPA_VERSION_3 710199767f8SToomas Soome #define SPA_VERSION_BPLIST_ACCOUNT SPA_VERSION_3 711199767f8SToomas Soome #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 712199767f8SToomas Soome #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 713199767f8SToomas Soome #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 714199767f8SToomas Soome #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 715199767f8SToomas Soome #define SPA_VERSION_BOOTFS SPA_VERSION_6 716199767f8SToomas Soome #define SPA_VERSION_SLOGS SPA_VERSION_7 717199767f8SToomas Soome #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 718199767f8SToomas Soome #define SPA_VERSION_FUID SPA_VERSION_9 719199767f8SToomas Soome #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 720199767f8SToomas Soome #define SPA_VERSION_REFQUOTA SPA_VERSION_9 721199767f8SToomas Soome #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 722199767f8SToomas Soome #define SPA_VERSION_L2CACHE SPA_VERSION_10 723199767f8SToomas Soome #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 724199767f8SToomas Soome #define SPA_VERSION_ORIGIN SPA_VERSION_11 725199767f8SToomas Soome #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 726199767f8SToomas Soome #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 727199767f8SToomas Soome #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 728199767f8SToomas Soome #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 72908487eeaSToomas Soome #define SPA_VERSION_USERSPACE SPA_VERSION_15 730199767f8SToomas Soome #define SPA_VERSION_STMF_PROP SPA_VERSION_16 731199767f8SToomas Soome #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 732199767f8SToomas Soome #define SPA_VERSION_USERREFS SPA_VERSION_18 733199767f8SToomas Soome #define SPA_VERSION_HOLES SPA_VERSION_19 734199767f8SToomas Soome #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 735199767f8SToomas Soome #define SPA_VERSION_DEDUP SPA_VERSION_21 736199767f8SToomas Soome #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 737199767f8SToomas Soome #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 738199767f8SToomas Soome #define SPA_VERSION_SA SPA_VERSION_24 739199767f8SToomas Soome #define SPA_VERSION_SCAN SPA_VERSION_25 740199767f8SToomas Soome #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 741199767f8SToomas Soome #define SPA_VERSION_DEADLISTS SPA_VERSION_26 742199767f8SToomas Soome #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 743199767f8SToomas Soome #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 744199767f8SToomas Soome #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 745199767f8SToomas Soome #define SPA_VERSION_FEATURES SPA_VERSION_5000 746199767f8SToomas Soome 747199767f8SToomas Soome #define SPA_VERSION_IS_SUPPORTED(v) \ 748199767f8SToomas Soome (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 749199767f8SToomas Soome ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 750199767f8SToomas Soome 751199767f8SToomas Soome /* 752199767f8SToomas Soome * The following are configuration names used in the nvlist describing a pool's 753199767f8SToomas Soome * configuration. 754199767f8SToomas Soome */ 755199767f8SToomas Soome #define ZPOOL_CONFIG_VERSION "version" 756199767f8SToomas Soome #define ZPOOL_CONFIG_POOL_NAME "name" 757199767f8SToomas Soome #define ZPOOL_CONFIG_POOL_STATE "state" 758199767f8SToomas Soome #define ZPOOL_CONFIG_POOL_TXG "txg" 759199767f8SToomas Soome #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 760199767f8SToomas Soome #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 761199767f8SToomas Soome #define ZPOOL_CONFIG_TOP_GUID "top_guid" 762199767f8SToomas Soome #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 763199767f8SToomas Soome #define ZPOOL_CONFIG_TYPE "type" 764199767f8SToomas Soome #define ZPOOL_CONFIG_CHILDREN "children" 765199767f8SToomas Soome #define ZPOOL_CONFIG_ID "id" 766199767f8SToomas Soome #define ZPOOL_CONFIG_GUID "guid" 767c023f651SToomas Soome #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object" 768c023f651SToomas Soome #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births" 769c023f651SToomas Soome #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev" 770199767f8SToomas Soome #define ZPOOL_CONFIG_PATH "path" 771199767f8SToomas Soome #define ZPOOL_CONFIG_DEVID "devid" 772199767f8SToomas Soome #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 773199767f8SToomas Soome #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 774199767f8SToomas Soome #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 775199767f8SToomas Soome #define ZPOOL_CONFIG_ASHIFT "ashift" 776199767f8SToomas Soome #define ZPOOL_CONFIG_ASIZE "asize" 777199767f8SToomas Soome #define ZPOOL_CONFIG_DTL "DTL" 778199767f8SToomas Soome #define ZPOOL_CONFIG_STATS "stats" 779199767f8SToomas Soome #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 780199767f8SToomas Soome #define ZPOOL_CONFIG_ERRCOUNT "error_count" 781199767f8SToomas Soome #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 782199767f8SToomas Soome #define ZPOOL_CONFIG_SPARES "spares" 783199767f8SToomas Soome #define ZPOOL_CONFIG_IS_SPARE "is_spare" 784199767f8SToomas Soome #define ZPOOL_CONFIG_NPARITY "nparity" 785199767f8SToomas Soome #define ZPOOL_CONFIG_HOSTID "hostid" 786199767f8SToomas Soome #define ZPOOL_CONFIG_HOSTNAME "hostname" 787199767f8SToomas Soome #define ZPOOL_CONFIG_IS_LOG "is_log" 788199767f8SToomas Soome #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 789199767f8SToomas Soome #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 790da9bf005SToomas Soome #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 791199767f8SToomas Soome 792199767f8SToomas Soome /* 793199767f8SToomas Soome * The persistent vdev state is stored as separate values rather than a single 794199767f8SToomas Soome * 'vdev_state' entry. This is because a device can be in multiple states, such 795199767f8SToomas Soome * as offline and degraded. 796199767f8SToomas Soome */ 79708487eeaSToomas Soome #define ZPOOL_CONFIG_OFFLINE "offline" 79808487eeaSToomas Soome #define ZPOOL_CONFIG_FAULTED "faulted" 79908487eeaSToomas Soome #define ZPOOL_CONFIG_DEGRADED "degraded" 80008487eeaSToomas Soome #define ZPOOL_CONFIG_REMOVED "removed" 801199767f8SToomas Soome #define ZPOOL_CONFIG_FRU "fru" 802199767f8SToomas Soome #define ZPOOL_CONFIG_AUX_STATE "aux_state" 803199767f8SToomas Soome 804199767f8SToomas Soome #define VDEV_TYPE_ROOT "root" 805199767f8SToomas Soome #define VDEV_TYPE_MIRROR "mirror" 806199767f8SToomas Soome #define VDEV_TYPE_REPLACING "replacing" 807199767f8SToomas Soome #define VDEV_TYPE_RAIDZ "raidz" 808199767f8SToomas Soome #define VDEV_TYPE_DISK "disk" 809199767f8SToomas Soome #define VDEV_TYPE_FILE "file" 810199767f8SToomas Soome #define VDEV_TYPE_MISSING "missing" 811199767f8SToomas Soome #define VDEV_TYPE_HOLE "hole" 812199767f8SToomas Soome #define VDEV_TYPE_SPARE "spare" 813199767f8SToomas Soome #define VDEV_TYPE_LOG "log" 814199767f8SToomas Soome #define VDEV_TYPE_L2CACHE "l2cache" 815c023f651SToomas Soome #define VDEV_TYPE_INDIRECT "indirect" 816199767f8SToomas Soome 817199767f8SToomas Soome /* 818199767f8SToomas Soome * This is needed in userland to report the minimum necessary device size. 819199767f8SToomas Soome */ 820199767f8SToomas Soome #define SPA_MINDEVSIZE (64ULL << 20) 821199767f8SToomas Soome 822199767f8SToomas Soome /* 823199767f8SToomas Soome * The location of the pool configuration repository, shared between kernel and 824199767f8SToomas Soome * userland. 825199767f8SToomas Soome */ 826199767f8SToomas Soome #define ZPOOL_CACHE "/boot/zfs/zpool.cache" 827199767f8SToomas Soome 828199767f8SToomas Soome /* 829199767f8SToomas Soome * vdev states are ordered from least to most healthy. 830199767f8SToomas Soome * A vdev that's CANT_OPEN or below is considered unusable. 831199767f8SToomas Soome */ 832199767f8SToomas Soome typedef enum vdev_state { 833199767f8SToomas Soome VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 834199767f8SToomas Soome VDEV_STATE_CLOSED, /* Not currently open */ 835199767f8SToomas Soome VDEV_STATE_OFFLINE, /* Not allowed to open */ 836199767f8SToomas Soome VDEV_STATE_REMOVED, /* Explicitly removed from system */ 837199767f8SToomas Soome VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 838199767f8SToomas Soome VDEV_STATE_FAULTED, /* External request to fault device */ 839199767f8SToomas Soome VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 840199767f8SToomas Soome VDEV_STATE_HEALTHY /* Presumed good */ 841199767f8SToomas Soome } vdev_state_t; 842199767f8SToomas Soome 843199767f8SToomas Soome /* 844199767f8SToomas Soome * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 845199767f8SToomas Soome * of the vdev stats structure uses these constants to distinguish why. 846199767f8SToomas Soome */ 847199767f8SToomas Soome typedef enum vdev_aux { 848199767f8SToomas Soome VDEV_AUX_NONE, /* no error */ 849199767f8SToomas Soome VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 850199767f8SToomas Soome VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 851199767f8SToomas Soome VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 852199767f8SToomas Soome VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 853199767f8SToomas Soome VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 854199767f8SToomas Soome VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 855199767f8SToomas Soome VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 856199767f8SToomas Soome VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 857199767f8SToomas Soome VDEV_AUX_SPARED /* hot spare used in another pool */ 858199767f8SToomas Soome } vdev_aux_t; 859199767f8SToomas Soome 860199767f8SToomas Soome /* 861199767f8SToomas Soome * pool state. The following states are written to disk as part of the normal 862199767f8SToomas Soome * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE. The remaining states are 863199767f8SToomas Soome * software abstractions used at various levels to communicate pool state. 864199767f8SToomas Soome */ 865199767f8SToomas Soome typedef enum pool_state { 866199767f8SToomas Soome POOL_STATE_ACTIVE = 0, /* In active use */ 867199767f8SToomas Soome POOL_STATE_EXPORTED, /* Explicitly exported */ 868199767f8SToomas Soome POOL_STATE_DESTROYED, /* Explicitly destroyed */ 869199767f8SToomas Soome POOL_STATE_SPARE, /* Reserved for hot spare use */ 870199767f8SToomas Soome POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 871199767f8SToomas Soome POOL_STATE_UNAVAIL, /* Internal libzfs state */ 872199767f8SToomas Soome POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 873199767f8SToomas Soome } pool_state_t; 874199767f8SToomas Soome 875199767f8SToomas Soome /* 876199767f8SToomas Soome * The uberblock version is incremented whenever an incompatible on-disk 877199767f8SToomas Soome * format change is made to the SPA, DMU, or ZAP. 878199767f8SToomas Soome * 879199767f8SToomas Soome * Note: the first two fields should never be moved. When a storage pool 880199767f8SToomas Soome * is opened, the uberblock must be read off the disk before the version 881199767f8SToomas Soome * can be checked. If the ub_version field is moved, we may not detect 882199767f8SToomas Soome * version mismatch. If the ub_magic field is moved, applications that 883199767f8SToomas Soome * expect the magic number in the first word won't work. 884199767f8SToomas Soome */ 885199767f8SToomas Soome #define UBERBLOCK_MAGIC 0x00bab10c /* oo-ba-bloc! */ 886199767f8SToomas Soome #define UBERBLOCK_SHIFT 10 /* up to 1K */ 8877dcf02b3SToomas Soome #define MMP_MAGIC 0xa11cea11 /* all-see-all */ 8887dcf02b3SToomas Soome 8897dcf02b3SToomas Soome #define MMP_INTERVAL_VALID_BIT 0x01 8907dcf02b3SToomas Soome #define MMP_SEQ_VALID_BIT 0x02 8917dcf02b3SToomas Soome #define MMP_FAIL_INT_VALID_BIT 0x04 8927dcf02b3SToomas Soome 8937dcf02b3SToomas Soome #define MMP_VALID(ubp) (ubp->ub_magic == UBERBLOCK_MAGIC && \ 8947dcf02b3SToomas Soome ubp->ub_mmp_magic == MMP_MAGIC) 8957dcf02b3SToomas Soome #define MMP_INTERVAL_VALID(ubp) (MMP_VALID(ubp) && (ubp->ub_mmp_config & \ 8967dcf02b3SToomas Soome MMP_INTERVAL_VALID_BIT)) 8977dcf02b3SToomas Soome #define MMP_SEQ_VALID(ubp) (MMP_VALID(ubp) && (ubp->ub_mmp_config & \ 8987dcf02b3SToomas Soome MMP_SEQ_VALID_BIT)) 8997dcf02b3SToomas Soome #define MMP_FAIL_INT_VALID(ubp) (MMP_VALID(ubp) && (ubp->ub_mmp_config & \ 9007dcf02b3SToomas Soome MMP_FAIL_INT_VALID_BIT)) 9017dcf02b3SToomas Soome 9027dcf02b3SToomas Soome #define MMP_INTERVAL(ubp) ((ubp->ub_mmp_config & 0x00000000FFFFFF00) \ 9037dcf02b3SToomas Soome >> 8) 9047dcf02b3SToomas Soome #define MMP_SEQ(ubp) ((ubp->ub_mmp_config & 0x0000FFFF00000000) \ 9057dcf02b3SToomas Soome >> 32) 9067dcf02b3SToomas Soome #define MMP_FAIL_INT(ubp) ((ubp->ub_mmp_config & 0xFFFF000000000000) \ 9077dcf02b3SToomas Soome >> 48) 9087dcf02b3SToomas Soome 9097dcf02b3SToomas Soome typedef struct uberblock { 910199767f8SToomas Soome uint64_t ub_magic; /* UBERBLOCK_MAGIC */ 911199767f8SToomas Soome uint64_t ub_version; /* SPA_VERSION */ 912199767f8SToomas Soome uint64_t ub_txg; /* txg of last sync */ 913199767f8SToomas Soome uint64_t ub_guid_sum; /* sum of all vdev guids */ 914199767f8SToomas Soome uint64_t ub_timestamp; /* UTC time of last sync */ 915199767f8SToomas Soome blkptr_t ub_rootbp; /* MOS objset_phys_t */ 9167dcf02b3SToomas Soome /* highest SPA_VERSION supported by software that wrote this txg */ 9177dcf02b3SToomas Soome uint64_t ub_software_version; 9187dcf02b3SToomas Soome /* Maybe missing in uberblocks we read, but always written */ 9197dcf02b3SToomas Soome uint64_t ub_mmp_magic; 9207dcf02b3SToomas Soome /* 9217dcf02b3SToomas Soome * If ub_mmp_delay == 0 and ub_mmp_magic is valid, MMP is off. 9227dcf02b3SToomas Soome * Otherwise, nanosec since last MMP write. 9237dcf02b3SToomas Soome */ 9247dcf02b3SToomas Soome uint64_t ub_mmp_delay; 9257dcf02b3SToomas Soome 926*b713c91eSToomas Soome /* BEGIN CSTYLED */ 9277dcf02b3SToomas Soome /* 9287dcf02b3SToomas Soome * The ub_mmp_config contains the multihost write interval, multihost 9297dcf02b3SToomas Soome * fail intervals, sequence number for sub-second granularity, and 9307dcf02b3SToomas Soome * valid bit mask. This layout is as follows: 9317dcf02b3SToomas Soome * 9327dcf02b3SToomas Soome * 64 56 48 40 32 24 16 8 0 9337dcf02b3SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 9347dcf02b3SToomas Soome * 0 | Fail Intervals| Seq | Write Interval (ms) | VALID | 9357dcf02b3SToomas Soome * +-------+-------+-------+-------+-------+-------+-------+-------+ 9367dcf02b3SToomas Soome * 9377dcf02b3SToomas Soome * This allows a write_interval of (2^24/1000)s, over 4.5 hours 9387dcf02b3SToomas Soome * 9397dcf02b3SToomas Soome * VALID Bits: 9407dcf02b3SToomas Soome * - 0x01 - Write Interval (ms) 9417dcf02b3SToomas Soome * - 0x02 - Sequence number exists 9427dcf02b3SToomas Soome * - 0x04 - Fail Intervals 9437dcf02b3SToomas Soome * - 0xf8 - Reserved 9447dcf02b3SToomas Soome */ 945*b713c91eSToomas Soome /* END CSTYLED */ 9467dcf02b3SToomas Soome uint64_t ub_mmp_config; 9477dcf02b3SToomas Soome 9487dcf02b3SToomas Soome /* 9497dcf02b3SToomas Soome * ub_checkpoint_txg indicates two things about the current uberblock: 9507dcf02b3SToomas Soome * 9517dcf02b3SToomas Soome * 1] If it is not zero then this uberblock is a checkpoint. If it is 9527dcf02b3SToomas Soome * zero, then this uberblock is not a checkpoint. 9537dcf02b3SToomas Soome * 9547dcf02b3SToomas Soome * 2] On checkpointed uberblocks, the value of ub_checkpoint_txg is 9557dcf02b3SToomas Soome * the ub_txg that the uberblock had at the time we moved it to 9567dcf02b3SToomas Soome * the MOS config. 9577dcf02b3SToomas Soome * 9587dcf02b3SToomas Soome * The field is set when we checkpoint the uberblock and continues to 9597dcf02b3SToomas Soome * hold that value even after we've rewound (unlike the ub_txg that 9607dcf02b3SToomas Soome * is reset to a higher value). 9617dcf02b3SToomas Soome * 9627dcf02b3SToomas Soome * Besides checks used to determine whether we are reopening the 9637dcf02b3SToomas Soome * pool from a checkpointed uberblock [see spa_ld_select_uberblock()], 9647dcf02b3SToomas Soome * the value of the field is used to determine which ZIL blocks have 9657dcf02b3SToomas Soome * been allocated according to the ms_sm when we are rewinding to a 9667dcf02b3SToomas Soome * checkpoint. Specifically, if blk_birth > ub_checkpoint_txg, then 9677dcf02b3SToomas Soome * the ZIL block is not allocated [see uses of spa_min_claim_txg()]. 9687dcf02b3SToomas Soome */ 9697dcf02b3SToomas Soome uint64_t ub_checkpoint_txg; 9707dcf02b3SToomas Soome } uberblock_t; 971199767f8SToomas Soome 972199767f8SToomas Soome /* 973199767f8SToomas Soome * Flags. 974199767f8SToomas Soome */ 975199767f8SToomas Soome #define DNODE_MUST_BE_ALLOCATED 1 976199767f8SToomas Soome #define DNODE_MUST_BE_FREE 2 977199767f8SToomas Soome 978199767f8SToomas Soome /* 979199767f8SToomas Soome * Fixed constants. 980199767f8SToomas Soome */ 981199767f8SToomas Soome #define DNODE_SHIFT 9 /* 512 bytes */ 982199767f8SToomas Soome #define DN_MIN_INDBLKSHIFT 12 /* 4k */ 983c023f651SToomas Soome #define DN_MAX_INDBLKSHIFT 17 /* 128k */ 984199767f8SToomas Soome #define DNODE_BLOCK_SHIFT 14 /* 16k */ 985199767f8SToomas Soome #define DNODE_CORE_SIZE 64 /* 64 bytes for dnode sans blkptrs */ 986199767f8SToomas Soome #define DN_MAX_OBJECT_SHIFT 48 /* 256 trillion (zfs_fid_t limit) */ 987199767f8SToomas Soome #define DN_MAX_OFFSET_SHIFT 64 /* 2^64 bytes in a dnode */ 988199767f8SToomas Soome 989199767f8SToomas Soome /* 990199767f8SToomas Soome * Derived constants. 991199767f8SToomas Soome */ 992f905073dSToomas Soome #define DNODE_MIN_SIZE (1 << DNODE_SHIFT) 993f905073dSToomas Soome #define DNODE_MAX_SIZE (1 << DNODE_BLOCK_SHIFT) 994f905073dSToomas Soome #define DNODE_BLOCK_SIZE (1 << DNODE_BLOCK_SHIFT) 995f905073dSToomas Soome #define DNODE_MIN_SLOTS (DNODE_MIN_SIZE >> DNODE_SHIFT) 996f905073dSToomas Soome #define DNODE_MAX_SLOTS (DNODE_MAX_SIZE >> DNODE_SHIFT) 997f905073dSToomas Soome #define DN_BONUS_SIZE(dnsize) ((dnsize) - DNODE_CORE_SIZE - \ 998f905073dSToomas Soome (1 << SPA_BLKPTRSHIFT)) 999f905073dSToomas Soome #define DN_SLOTS_TO_BONUSLEN(slots) DN_BONUS_SIZE((slots) << DNODE_SHIFT) 1000f905073dSToomas Soome #define DN_OLD_MAX_BONUSLEN (DN_BONUS_SIZE(DNODE_MIN_SIZE)) 1001f905073dSToomas Soome #define DN_MAX_NBLKPTR ((DNODE_MIN_SIZE - DNODE_CORE_SIZE) >> \ 1002f905073dSToomas Soome SPA_BLKPTRSHIFT) 1003f905073dSToomas Soome #define DN_MAX_OBJECT (1ULL << DN_MAX_OBJECT_SHIFT) 1004f905073dSToomas Soome #define DN_ZERO_BONUSLEN (DN_BONUS_SIZE(DNODE_MAX_SIZE) + 1) 1005199767f8SToomas Soome 1006199767f8SToomas Soome #define DNODES_PER_BLOCK_SHIFT (DNODE_BLOCK_SHIFT - DNODE_SHIFT) 1007199767f8SToomas Soome #define DNODES_PER_BLOCK (1ULL << DNODES_PER_BLOCK_SHIFT) 1008199767f8SToomas Soome #define DNODES_PER_LEVEL_SHIFT (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT) 1009199767f8SToomas Soome 1010199767f8SToomas Soome /* The +2 here is a cheesy way to round up */ 1011199767f8SToomas Soome #define DN_MAX_LEVELS (2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \ 1012199767f8SToomas Soome (DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT))) 1013199767f8SToomas Soome 1014199767f8SToomas Soome #define DN_BONUS(dnp) ((void*)((dnp)->dn_bonus + \ 1015199767f8SToomas Soome (((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t)))) 1016199767f8SToomas Soome 1017199767f8SToomas Soome #define DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \ 1018199767f8SToomas Soome (dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT) 1019199767f8SToomas Soome 1020199767f8SToomas Soome #define EPB(blkshift, typeshift) (1 << (blkshift - typeshift)) 1021199767f8SToomas Soome 1022199767f8SToomas Soome /* Is dn_used in bytes? if not, it's in multiples of SPA_MINBLOCKSIZE */ 1023199767f8SToomas Soome #define DNODE_FLAG_USED_BYTES (1<<0) 1024199767f8SToomas Soome #define DNODE_FLAG_USERUSED_ACCOUNTED (1<<1) 1025199767f8SToomas Soome 1026199767f8SToomas Soome /* Does dnode have a SA spill blkptr in bonus? */ 1027199767f8SToomas Soome #define DNODE_FLAG_SPILL_BLKPTR (1<<2) 1028199767f8SToomas Soome 1029199767f8SToomas Soome typedef struct dnode_phys { 1030199767f8SToomas Soome uint8_t dn_type; /* dmu_object_type_t */ 1031199767f8SToomas Soome uint8_t dn_indblkshift; /* ln2(indirect block size) */ 1032199767f8SToomas Soome uint8_t dn_nlevels; /* 1=dn_blkptr->data blocks */ 1033199767f8SToomas Soome uint8_t dn_nblkptr; /* length of dn_blkptr */ 1034199767f8SToomas Soome uint8_t dn_bonustype; /* type of data in bonus buffer */ 1035199767f8SToomas Soome uint8_t dn_checksum; /* ZIO_CHECKSUM type */ 1036199767f8SToomas Soome uint8_t dn_compress; /* ZIO_COMPRESS type */ 1037199767f8SToomas Soome uint8_t dn_flags; /* DNODE_FLAG_* */ 1038199767f8SToomas Soome uint16_t dn_datablkszsec; /* data block size in 512b sectors */ 1039199767f8SToomas Soome uint16_t dn_bonuslen; /* length of dn_bonus */ 1040f905073dSToomas Soome uint8_t dn_extra_slots; /* # of subsequent slots consumed */ 1041f905073dSToomas Soome uint8_t dn_pad2[3]; 1042199767f8SToomas Soome 1043199767f8SToomas Soome /* accounting is protected by dn_dirty_mtx */ 1044199767f8SToomas Soome uint64_t dn_maxblkid; /* largest allocated block ID */ 1045199767f8SToomas Soome uint64_t dn_used; /* bytes (or sectors) of disk space */ 1046199767f8SToomas Soome 1047199767f8SToomas Soome uint64_t dn_pad3[4]; 1048199767f8SToomas Soome 1049*b713c91eSToomas Soome /* BEGIN CSTYLED */ 1050f905073dSToomas Soome /* 1051f905073dSToomas Soome * The tail region is 448 bytes for a 512 byte dnode, and 1052f905073dSToomas Soome * correspondingly larger for larger dnode sizes. The spill 1053f905073dSToomas Soome * block pointer, when present, is always at the end of the tail 1054f905073dSToomas Soome * region. There are three ways this space may be used, using 1055f905073dSToomas Soome * a 512 byte dnode for this diagram: 1056f905073dSToomas Soome * 1057f905073dSToomas Soome * 0 64 128 192 256 320 384 448 (offset) 1058f905073dSToomas Soome * +---------------+---------------+---------------+-------+ 1059f905073dSToomas Soome * | dn_blkptr[0] | dn_blkptr[1] | dn_blkptr[2] | / | 1060f905073dSToomas Soome * +---------------+---------------+---------------+-------+ 1061f905073dSToomas Soome * | dn_blkptr[0] | dn_bonus[0..319] | 1062f905073dSToomas Soome * +---------------+-----------------------+---------------+ 1063f905073dSToomas Soome * | dn_blkptr[0] | dn_bonus[0..191] | dn_spill | 1064f905073dSToomas Soome * +---------------+-----------------------+---------------+ 1065f905073dSToomas Soome */ 1066*b713c91eSToomas Soome /* END CSTYLED */ 1067f905073dSToomas Soome union { 1068f905073dSToomas Soome blkptr_t dn_blkptr[1+DN_OLD_MAX_BONUSLEN/sizeof (blkptr_t)]; 1069f905073dSToomas Soome struct { 1070f905073dSToomas Soome blkptr_t __dn_ignore1; 1071f905073dSToomas Soome uint8_t dn_bonus[DN_OLD_MAX_BONUSLEN]; 1072f905073dSToomas Soome }; 1073f905073dSToomas Soome struct { 1074f905073dSToomas Soome blkptr_t __dn_ignore2; 1075f905073dSToomas Soome uint8_t __dn_ignore3[DN_OLD_MAX_BONUSLEN - 1076f905073dSToomas Soome sizeof (blkptr_t)]; 1077f905073dSToomas Soome blkptr_t dn_spill; 1078f905073dSToomas Soome }; 1079f905073dSToomas Soome }; 1080199767f8SToomas Soome } dnode_phys_t; 1081199767f8SToomas Soome 1082f905073dSToomas Soome #define DN_SPILL_BLKPTR(dnp) (blkptr_t *)((char *)(dnp) + \ 1083f905073dSToomas Soome (((dnp)->dn_extra_slots + 1) << DNODE_SHIFT) - (1 << SPA_BLKPTRSHIFT)) 1084f905073dSToomas Soome 1085199767f8SToomas Soome typedef enum dmu_object_byteswap { 1086199767f8SToomas Soome DMU_BSWAP_UINT8, 1087199767f8SToomas Soome DMU_BSWAP_UINT16, 1088199767f8SToomas Soome DMU_BSWAP_UINT32, 1089199767f8SToomas Soome DMU_BSWAP_UINT64, 1090199767f8SToomas Soome DMU_BSWAP_ZAP, 1091199767f8SToomas Soome DMU_BSWAP_DNODE, 1092199767f8SToomas Soome DMU_BSWAP_OBJSET, 1093199767f8SToomas Soome DMU_BSWAP_ZNODE, 1094199767f8SToomas Soome DMU_BSWAP_OLDACL, 1095199767f8SToomas Soome DMU_BSWAP_ACL, 1096199767f8SToomas Soome /* 1097199767f8SToomas Soome * Allocating a new byteswap type number makes the on-disk format 1098199767f8SToomas Soome * incompatible with any other format that uses the same number. 1099199767f8SToomas Soome * 1100199767f8SToomas Soome * Data can usually be structured to work with one of the 1101199767f8SToomas Soome * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types. 1102199767f8SToomas Soome */ 1103199767f8SToomas Soome DMU_BSWAP_NUMFUNCS 1104199767f8SToomas Soome } dmu_object_byteswap_t; 1105199767f8SToomas Soome 1106199767f8SToomas Soome #define DMU_OT_NEWTYPE 0x80 1107199767f8SToomas Soome #define DMU_OT_METADATA 0x40 1108199767f8SToomas Soome #define DMU_OT_BYTESWAP_MASK 0x3f 1109199767f8SToomas Soome 1110199767f8SToomas Soome /* 1111199767f8SToomas Soome * Defines a uint8_t object type. Object types specify if the data 1112199767f8SToomas Soome * in the object is metadata (boolean) and how to byteswap the data 1113199767f8SToomas Soome * (dmu_object_byteswap_t). 1114199767f8SToomas Soome */ 1115199767f8SToomas Soome #define DMU_OT(byteswap, metadata) \ 1116199767f8SToomas Soome (DMU_OT_NEWTYPE | \ 1117199767f8SToomas Soome ((metadata) ? DMU_OT_METADATA : 0) | \ 1118199767f8SToomas Soome ((byteswap) & DMU_OT_BYTESWAP_MASK)) 1119199767f8SToomas Soome 1120199767f8SToomas Soome typedef enum dmu_object_type { 1121199767f8SToomas Soome DMU_OT_NONE, 1122199767f8SToomas Soome /* general: */ 1123199767f8SToomas Soome DMU_OT_OBJECT_DIRECTORY, /* ZAP */ 1124199767f8SToomas Soome DMU_OT_OBJECT_ARRAY, /* UINT64 */ 1125199767f8SToomas Soome DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ 1126199767f8SToomas Soome DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ 1127199767f8SToomas Soome DMU_OT_BPLIST, /* UINT64 */ 1128199767f8SToomas Soome DMU_OT_BPLIST_HDR, /* UINT64 */ 1129199767f8SToomas Soome /* spa: */ 1130199767f8SToomas Soome DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ 1131199767f8SToomas Soome DMU_OT_SPACE_MAP, /* UINT64 */ 1132199767f8SToomas Soome /* zil: */ 1133199767f8SToomas Soome DMU_OT_INTENT_LOG, /* UINT64 */ 1134199767f8SToomas Soome /* dmu: */ 1135199767f8SToomas Soome DMU_OT_DNODE, /* DNODE */ 1136199767f8SToomas Soome DMU_OT_OBJSET, /* OBJSET */ 1137199767f8SToomas Soome /* dsl: */ 1138199767f8SToomas Soome DMU_OT_DSL_DIR, /* UINT64 */ 1139199767f8SToomas Soome DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ 1140199767f8SToomas Soome DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ 1141199767f8SToomas Soome DMU_OT_DSL_PROPS, /* ZAP */ 1142199767f8SToomas Soome DMU_OT_DSL_DATASET, /* UINT64 */ 1143199767f8SToomas Soome /* zpl: */ 1144199767f8SToomas Soome DMU_OT_ZNODE, /* ZNODE */ 1145199767f8SToomas Soome DMU_OT_OLDACL, /* Old ACL */ 1146199767f8SToomas Soome DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ 1147199767f8SToomas Soome DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ 1148199767f8SToomas Soome DMU_OT_MASTER_NODE, /* ZAP */ 1149199767f8SToomas Soome DMU_OT_UNLINKED_SET, /* ZAP */ 1150199767f8SToomas Soome /* zvol: */ 1151199767f8SToomas Soome DMU_OT_ZVOL, /* UINT8 */ 1152199767f8SToomas Soome DMU_OT_ZVOL_PROP, /* ZAP */ 1153199767f8SToomas Soome /* other; for testing only! */ 1154199767f8SToomas Soome DMU_OT_PLAIN_OTHER, /* UINT8 */ 1155199767f8SToomas Soome DMU_OT_UINT64_OTHER, /* UINT64 */ 1156199767f8SToomas Soome DMU_OT_ZAP_OTHER, /* ZAP */ 1157199767f8SToomas Soome /* new object types: */ 1158199767f8SToomas Soome DMU_OT_ERROR_LOG, /* ZAP */ 1159199767f8SToomas Soome DMU_OT_SPA_HISTORY, /* UINT8 */ 1160199767f8SToomas Soome DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ 1161199767f8SToomas Soome DMU_OT_POOL_PROPS, /* ZAP */ 1162199767f8SToomas Soome DMU_OT_DSL_PERMS, /* ZAP */ 1163199767f8SToomas Soome DMU_OT_ACL, /* ACL */ 1164199767f8SToomas Soome DMU_OT_SYSACL, /* SYSACL */ 1165199767f8SToomas Soome DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */ 1166199767f8SToomas Soome DMU_OT_FUID_SIZE, /* FUID table size UINT64 */ 1167199767f8SToomas Soome DMU_OT_NEXT_CLONES, /* ZAP */ 1168199767f8SToomas Soome DMU_OT_SCAN_QUEUE, /* ZAP */ 1169199767f8SToomas Soome DMU_OT_USERGROUP_USED, /* ZAP */ 1170199767f8SToomas Soome DMU_OT_USERGROUP_QUOTA, /* ZAP */ 1171199767f8SToomas Soome DMU_OT_USERREFS, /* ZAP */ 1172199767f8SToomas Soome DMU_OT_DDT_ZAP, /* ZAP */ 1173199767f8SToomas Soome DMU_OT_DDT_STATS, /* ZAP */ 1174199767f8SToomas Soome DMU_OT_SA, /* System attr */ 1175199767f8SToomas Soome DMU_OT_SA_MASTER_NODE, /* ZAP */ 1176199767f8SToomas Soome DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */ 1177199767f8SToomas Soome DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */ 1178199767f8SToomas Soome DMU_OT_SCAN_XLATE, /* ZAP */ 1179199767f8SToomas Soome DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */ 1180199767f8SToomas Soome DMU_OT_NUMTYPES, 1181199767f8SToomas Soome 1182199767f8SToomas Soome /* 1183199767f8SToomas Soome * Names for valid types declared with DMU_OT(). 1184199767f8SToomas Soome */ 1185199767f8SToomas Soome DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE), 1186199767f8SToomas Soome DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE), 1187199767f8SToomas Soome DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE), 1188199767f8SToomas Soome DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE), 1189199767f8SToomas Soome DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE), 1190199767f8SToomas Soome DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE), 1191199767f8SToomas Soome DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE), 1192199767f8SToomas Soome DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE), 1193199767f8SToomas Soome DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE), 1194199767f8SToomas Soome DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE) 1195199767f8SToomas Soome } dmu_object_type_t; 1196199767f8SToomas Soome 1197199767f8SToomas Soome typedef enum dmu_objset_type { 1198199767f8SToomas Soome DMU_OST_NONE, 1199199767f8SToomas Soome DMU_OST_META, 1200199767f8SToomas Soome DMU_OST_ZFS, 1201199767f8SToomas Soome DMU_OST_ZVOL, 1202199767f8SToomas Soome DMU_OST_OTHER, /* For testing only! */ 1203199767f8SToomas Soome DMU_OST_ANY, /* Be careful! */ 1204199767f8SToomas Soome DMU_OST_NUMTYPES 1205199767f8SToomas Soome } dmu_objset_type_t; 1206199767f8SToomas Soome 12074a04e8dbSToomas Soome #define ZAP_MAXVALUELEN (1024 * 8) 12084a04e8dbSToomas Soome 1209199767f8SToomas Soome /* 1210199767f8SToomas Soome * header for all bonus and spill buffers. 1211199767f8SToomas Soome * The header has a fixed portion with a variable number 1212199767f8SToomas Soome * of "lengths" depending on the number of variable sized 1213199767f8SToomas Soome * attribues which are determined by the "layout number" 1214199767f8SToomas Soome */ 1215199767f8SToomas Soome 1216199767f8SToomas Soome #define SA_MAGIC 0x2F505A /* ZFS SA */ 1217199767f8SToomas Soome typedef struct sa_hdr_phys { 1218199767f8SToomas Soome uint32_t sa_magic; 1219199767f8SToomas Soome uint16_t sa_layout_info; /* Encoded with hdrsize and layout number */ 1220199767f8SToomas Soome uint16_t sa_lengths[1]; /* optional sizes for variable length attrs */ 1221199767f8SToomas Soome /* ... Data follows the lengths. */ 1222199767f8SToomas Soome } sa_hdr_phys_t; 1223199767f8SToomas Soome 1224199767f8SToomas Soome /* 1225199767f8SToomas Soome * sa_hdr_phys -> sa_layout_info 1226199767f8SToomas Soome * 1227199767f8SToomas Soome * 16 10 0 1228199767f8SToomas Soome * +--------+-------+ 1229199767f8SToomas Soome * | hdrsz |layout | 1230199767f8SToomas Soome * +--------+-------+ 1231199767f8SToomas Soome * 1232199767f8SToomas Soome * Bits 0-10 are the layout number 1233199767f8SToomas Soome * Bits 11-16 are the size of the header. 1234199767f8SToomas Soome * The hdrsize is the number * 8 1235199767f8SToomas Soome * 1236199767f8SToomas Soome * For example. 1237199767f8SToomas Soome * hdrsz of 1 ==> 8 byte header 1238199767f8SToomas Soome * 2 ==> 16 byte header 1239199767f8SToomas Soome * 1240199767f8SToomas Soome */ 1241199767f8SToomas Soome 1242199767f8SToomas Soome #define SA_HDR_LAYOUT_NUM(hdr) BF32_GET(hdr->sa_layout_info, 0, 10) 1243199767f8SToomas Soome #define SA_HDR_SIZE(hdr) BF32_GET_SB(hdr->sa_layout_info, 10, 16, 3, 0) 1244199767f8SToomas Soome #define SA_HDR_LAYOUT_INFO_ENCODE(x, num, size) \ 1245199767f8SToomas Soome { \ 1246199767f8SToomas Soome BF32_SET_SB(x, 10, 6, 3, 0, size); \ 1247199767f8SToomas Soome BF32_SET(x, 0, 10, num); \ 1248199767f8SToomas Soome } 1249199767f8SToomas Soome 1250199767f8SToomas Soome #define SA_MODE_OFFSET 0 1251199767f8SToomas Soome #define SA_SIZE_OFFSET 8 1252199767f8SToomas Soome #define SA_GEN_OFFSET 16 1253199767f8SToomas Soome #define SA_UID_OFFSET 24 1254199767f8SToomas Soome #define SA_GID_OFFSET 32 1255199767f8SToomas Soome #define SA_PARENT_OFFSET 40 1256fae4f9e0SToomas Soome #define SA_SYMLINK_OFFSET 160 1257199767f8SToomas Soome 125808487eeaSToomas Soome #define ZIO_OBJSET_MAC_LEN 32 125908487eeaSToomas Soome 1260199767f8SToomas Soome /* 1261199767f8SToomas Soome * Intent log header - this on disk structure holds fields to manage 1262199767f8SToomas Soome * the log. All fields are 64 bit to easily handle cross architectures. 1263199767f8SToomas Soome */ 1264199767f8SToomas Soome typedef struct zil_header { 1265199767f8SToomas Soome uint64_t zh_claim_txg; /* txg in which log blocks were claimed */ 1266199767f8SToomas Soome uint64_t zh_replay_seq; /* highest replayed sequence number */ 1267199767f8SToomas Soome blkptr_t zh_log; /* log chain */ 1268199767f8SToomas Soome uint64_t zh_claim_seq; /* highest claimed sequence number */ 1269199767f8SToomas Soome uint64_t zh_pad[5]; 1270199767f8SToomas Soome } zil_header_t; 1271199767f8SToomas Soome 127208487eeaSToomas Soome #define OBJSET_PHYS_SIZE_V2 2048 127308487eeaSToomas Soome #define OBJSET_PHYS_SIZE_V3 4096 127408487eeaSToomas Soome 127508487eeaSToomas Soome #define OBJSET_PHYS_PAD0_SIZE \ 127608487eeaSToomas Soome (OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t) * 3 - \ 127708487eeaSToomas Soome sizeof (zil_header_t) - sizeof (uint64_t) * 2 - \ 127808487eeaSToomas Soome 2 * ZIO_OBJSET_MAC_LEN) 127908487eeaSToomas Soome #define OBJSET_PHYS_PAD1_SIZE \ 128008487eeaSToomas Soome (OBJSET_PHYS_SIZE_V3 - OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t)) 1281199767f8SToomas Soome 1282199767f8SToomas Soome typedef struct objset_phys { 1283199767f8SToomas Soome dnode_phys_t os_meta_dnode; 1284199767f8SToomas Soome zil_header_t os_zil_header; 1285199767f8SToomas Soome uint64_t os_type; 1286199767f8SToomas Soome uint64_t os_flags; 128708487eeaSToomas Soome uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN]; 128808487eeaSToomas Soome uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN]; 128908487eeaSToomas Soome char os_pad0[OBJSET_PHYS_PAD0_SIZE]; 1290199767f8SToomas Soome dnode_phys_t os_userused_dnode; 1291199767f8SToomas Soome dnode_phys_t os_groupused_dnode; 129208487eeaSToomas Soome dnode_phys_t os_projectused_dnode; 129308487eeaSToomas Soome char os_pad1[OBJSET_PHYS_PAD1_SIZE]; 1294199767f8SToomas Soome } objset_phys_t; 1295199767f8SToomas Soome 1296199767f8SToomas Soome typedef struct dsl_dir_phys { 1297199767f8SToomas Soome uint64_t dd_creation_time; /* not actually used */ 1298199767f8SToomas Soome uint64_t dd_head_dataset_obj; 1299199767f8SToomas Soome uint64_t dd_parent_obj; 1300199767f8SToomas Soome uint64_t dd_clone_parent_obj; 1301199767f8SToomas Soome uint64_t dd_child_dir_zapobj; 1302199767f8SToomas Soome /* 1303199767f8SToomas Soome * how much space our children are accounting for; for leaf 1304199767f8SToomas Soome * datasets, == physical space used by fs + snaps 1305199767f8SToomas Soome */ 1306199767f8SToomas Soome uint64_t dd_used_bytes; 1307199767f8SToomas Soome uint64_t dd_compressed_bytes; 1308199767f8SToomas Soome uint64_t dd_uncompressed_bytes; 1309199767f8SToomas Soome /* Administrative quota setting */ 1310199767f8SToomas Soome uint64_t dd_quota; 1311199767f8SToomas Soome /* Administrative reservation setting */ 1312199767f8SToomas Soome uint64_t dd_reserved; 1313199767f8SToomas Soome uint64_t dd_props_zapobj; 1314199767f8SToomas Soome uint64_t dd_pad[21]; /* pad out to 256 bytes for good measure */ 1315199767f8SToomas Soome } dsl_dir_phys_t; 1316199767f8SToomas Soome 1317199767f8SToomas Soome typedef struct dsl_dataset_phys { 1318199767f8SToomas Soome uint64_t ds_dir_obj; 1319199767f8SToomas Soome uint64_t ds_prev_snap_obj; 1320199767f8SToomas Soome uint64_t ds_prev_snap_txg; 1321199767f8SToomas Soome uint64_t ds_next_snap_obj; 1322199767f8SToomas Soome uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==0 for snaps */ 1323199767f8SToomas Soome uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 1324199767f8SToomas Soome uint64_t ds_creation_time; /* seconds since 1970 */ 1325199767f8SToomas Soome uint64_t ds_creation_txg; 1326199767f8SToomas Soome uint64_t ds_deadlist_obj; 1327199767f8SToomas Soome uint64_t ds_used_bytes; 1328199767f8SToomas Soome uint64_t ds_compressed_bytes; 1329199767f8SToomas Soome uint64_t ds_uncompressed_bytes; 1330199767f8SToomas Soome uint64_t ds_unique_bytes; /* only relevant to snapshots */ 1331199767f8SToomas Soome /* 1332199767f8SToomas Soome * The ds_fsid_guid is a 56-bit ID that can change to avoid 1333199767f8SToomas Soome * collisions. The ds_guid is a 64-bit ID that will never 1334199767f8SToomas Soome * change, so there is a small probability that it will collide. 1335199767f8SToomas Soome */ 1336199767f8SToomas Soome uint64_t ds_fsid_guid; 1337199767f8SToomas Soome uint64_t ds_guid; 1338199767f8SToomas Soome uint64_t ds_flags; 1339199767f8SToomas Soome blkptr_t ds_bp; 1340199767f8SToomas Soome uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 1341199767f8SToomas Soome } dsl_dataset_phys_t; 1342199767f8SToomas Soome 1343199767f8SToomas Soome /* 1344199767f8SToomas Soome * The names of zap entries in the DIRECTORY_OBJECT of the MOS. 1345199767f8SToomas Soome */ 1346199767f8SToomas Soome #define DMU_POOL_DIRECTORY_OBJECT 1 1347199767f8SToomas Soome #define DMU_POOL_CONFIG "config" 1348199767f8SToomas Soome #define DMU_POOL_FEATURES_FOR_READ "features_for_read" 1349199767f8SToomas Soome #define DMU_POOL_ROOT_DATASET "root_dataset" 1350199767f8SToomas Soome #define DMU_POOL_SYNC_BPLIST "sync_bplist" 1351199767f8SToomas Soome #define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" 1352199767f8SToomas Soome #define DMU_POOL_ERRLOG_LAST "errlog_last" 1353199767f8SToomas Soome #define DMU_POOL_SPARES "spares" 1354199767f8SToomas Soome #define DMU_POOL_DEFLATE "deflate" 1355199767f8SToomas Soome #define DMU_POOL_HISTORY "history" 1356199767f8SToomas Soome #define DMU_POOL_PROPS "pool_props" 13574a04e8dbSToomas Soome #define DMU_POOL_CHECKSUM_SALT "org.illumos:checksum_salt" 1358c023f651SToomas Soome #define DMU_POOL_REMOVING "com.delphix:removing" 1359c023f651SToomas Soome #define DMU_POOL_OBSOLETE_BPOBJ "com.delphix:obsolete_bpobj" 1360c023f651SToomas Soome #define DMU_POOL_CONDENSING_INDIRECT "com.delphix:condensing_indirect" 1361199767f8SToomas Soome 1362199767f8SToomas Soome #define ZAP_MAGIC 0x2F52AB2ABULL 1363199767f8SToomas Soome 1364199767f8SToomas Soome #define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_block_shift) 1365199767f8SToomas Soome 1366199767f8SToomas Soome #define ZAP_MAXCD (uint32_t)(-1) 1367199767f8SToomas Soome #define ZAP_HASHBITS 28 1368199767f8SToomas Soome #define MZAP_ENT_LEN 64 1369199767f8SToomas Soome #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 1370fdefee4cSToomas Soome #define MZAP_MAX_BLKSZ SPA_OLD_MAXBLOCKSIZE 1371199767f8SToomas Soome 1372199767f8SToomas Soome typedef struct mzap_ent_phys { 1373199767f8SToomas Soome uint64_t mze_value; 1374199767f8SToomas Soome uint32_t mze_cd; 1375199767f8SToomas Soome uint16_t mze_pad; /* in case we want to chain them someday */ 1376199767f8SToomas Soome char mze_name[MZAP_NAME_LEN]; 1377199767f8SToomas Soome } mzap_ent_phys_t; 1378199767f8SToomas Soome 1379199767f8SToomas Soome typedef struct mzap_phys { 1380199767f8SToomas Soome uint64_t mz_block_type; /* ZBT_MICRO */ 1381199767f8SToomas Soome uint64_t mz_salt; 1382fdefee4cSToomas Soome uint64_t mz_normflags; 1383fdefee4cSToomas Soome uint64_t mz_pad[5]; 1384199767f8SToomas Soome mzap_ent_phys_t mz_chunk[1]; 1385199767f8SToomas Soome /* actually variable size depending on block size */ 1386199767f8SToomas Soome } mzap_phys_t; 1387199767f8SToomas Soome 1388199767f8SToomas Soome /* 1389199767f8SToomas Soome * The (fat) zap is stored in one object. It is an array of 1390199767f8SToomas Soome * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 1391199767f8SToomas Soome * 1392199767f8SToomas Soome * ptrtbl fits in first block: 13939890ff83SToomas Soome * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 1394199767f8SToomas Soome * 1395199767f8SToomas Soome * ptrtbl too big for first block: 13969890ff83SToomas Soome * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 1397199767f8SToomas Soome * 1398199767f8SToomas Soome */ 1399199767f8SToomas Soome 1400199767f8SToomas Soome #define ZBT_LEAF ((1ULL << 63) + 0) 1401199767f8SToomas Soome #define ZBT_HEADER ((1ULL << 63) + 1) 1402199767f8SToomas Soome #define ZBT_MICRO ((1ULL << 63) + 3) 1403199767f8SToomas Soome /* any other values are ptrtbl blocks */ 1404199767f8SToomas Soome 1405199767f8SToomas Soome /* 1406199767f8SToomas Soome * the embedded pointer table takes up half a block: 1407199767f8SToomas Soome * block size / entry size (2^3) / 2 1408199767f8SToomas Soome */ 1409199767f8SToomas Soome #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 1410199767f8SToomas Soome 1411199767f8SToomas Soome /* 1412199767f8SToomas Soome * The embedded pointer table starts half-way through the block. Since 1413199767f8SToomas Soome * the pointer table itself is half the block, it starts at (64-bit) 1414199767f8SToomas Soome * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 1415199767f8SToomas Soome */ 1416199767f8SToomas Soome #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 1417199767f8SToomas Soome ((uint64_t *)(zap)->zap_phys) \ 1418199767f8SToomas Soome [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 1419199767f8SToomas Soome 1420199767f8SToomas Soome /* 1421199767f8SToomas Soome * TAKE NOTE: 1422199767f8SToomas Soome * If zap_phys_t is modified, zap_byteswap() must be modified. 1423199767f8SToomas Soome */ 1424199767f8SToomas Soome typedef struct zap_phys { 1425199767f8SToomas Soome uint64_t zap_block_type; /* ZBT_HEADER */ 1426199767f8SToomas Soome uint64_t zap_magic; /* ZAP_MAGIC */ 1427199767f8SToomas Soome 1428199767f8SToomas Soome struct zap_table_phys { 1429199767f8SToomas Soome uint64_t zt_blk; /* starting block number */ 1430199767f8SToomas Soome uint64_t zt_numblks; /* number of blocks */ 1431199767f8SToomas Soome uint64_t zt_shift; /* bits to index it */ 1432199767f8SToomas Soome uint64_t zt_nextblk; /* next (larger) copy start block */ 1433199767f8SToomas Soome uint64_t zt_blks_copied; /* number source blocks copied */ 1434199767f8SToomas Soome } zap_ptrtbl; 1435199767f8SToomas Soome 1436199767f8SToomas Soome uint64_t zap_freeblk; /* the next free block */ 1437199767f8SToomas Soome uint64_t zap_num_leafs; /* number of leafs */ 1438199767f8SToomas Soome uint64_t zap_num_entries; /* number of entries */ 1439199767f8SToomas Soome uint64_t zap_salt; /* salt to stir into hash function */ 1440fdefee4cSToomas Soome uint64_t zap_normflags; /* flags for u8_textprep_str() */ 1441fdefee4cSToomas Soome uint64_t zap_flags; /* zap_flags_t */ 1442199767f8SToomas Soome /* 1443199767f8SToomas Soome * This structure is followed by padding, and then the embedded 1444199767f8SToomas Soome * pointer table. The embedded pointer table takes up second 1445199767f8SToomas Soome * half of the block. It is accessed using the 1446199767f8SToomas Soome * ZAP_EMBEDDED_PTRTBL_ENT() macro. 1447199767f8SToomas Soome */ 1448199767f8SToomas Soome } zap_phys_t; 1449199767f8SToomas Soome 1450199767f8SToomas Soome typedef struct zap_table_phys zap_table_phys_t; 1451199767f8SToomas Soome 1452fdefee4cSToomas Soome struct spa; 1453199767f8SToomas Soome typedef struct fat_zap { 1454199767f8SToomas Soome int zap_block_shift; /* block size shift */ 1455199767f8SToomas Soome zap_phys_t *zap_phys; 1456fdefee4cSToomas Soome const struct spa *zap_spa; 1457fdefee4cSToomas Soome const dnode_phys_t *zap_dnode; 1458199767f8SToomas Soome } fat_zap_t; 1459199767f8SToomas Soome 1460199767f8SToomas Soome #define ZAP_LEAF_MAGIC 0x2AB1EAF 1461199767f8SToomas Soome 1462199767f8SToomas Soome /* chunk size = 24 bytes */ 1463199767f8SToomas Soome #define ZAP_LEAF_CHUNKSIZE 24 1464199767f8SToomas Soome 1465199767f8SToomas Soome /* 1466199767f8SToomas Soome * The amount of space available for chunks is: 1467199767f8SToomas Soome * block size (1<<l->l_bs) - hash entry size (2) * number of hash 1468199767f8SToomas Soome * entries - header space (2*chunksize) 1469199767f8SToomas Soome */ 1470199767f8SToomas Soome #define ZAP_LEAF_NUMCHUNKS(l) \ 1471199767f8SToomas Soome (((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \ 1472199767f8SToomas Soome ZAP_LEAF_CHUNKSIZE - 2) 1473199767f8SToomas Soome 1474199767f8SToomas Soome /* 1475199767f8SToomas Soome * The amount of space within the chunk available for the array is: 1476199767f8SToomas Soome * chunk size - space for type (1) - space for next pointer (2) 1477199767f8SToomas Soome */ 1478199767f8SToomas Soome #define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3) 1479199767f8SToomas Soome 1480199767f8SToomas Soome #define ZAP_LEAF_ARRAY_NCHUNKS(bytes) \ 1481199767f8SToomas Soome (((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES) 1482199767f8SToomas Soome 1483199767f8SToomas Soome /* 1484199767f8SToomas Soome * Low water mark: when there are only this many chunks free, start 1485199767f8SToomas Soome * growing the ptrtbl. Ideally, this should be larger than a 1486199767f8SToomas Soome * "reasonably-sized" entry. 20 chunks is more than enough for the 1487199767f8SToomas Soome * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value), 1488199767f8SToomas Soome * while still being only around 3% for 16k blocks. 1489199767f8SToomas Soome */ 1490199767f8SToomas Soome #define ZAP_LEAF_LOW_WATER (20) 1491199767f8SToomas Soome 1492199767f8SToomas Soome /* 1493199767f8SToomas Soome * The leaf hash table has block size / 2^5 (32) number of entries, 1494199767f8SToomas Soome * which should be more than enough for the maximum number of entries, 1495199767f8SToomas Soome * which is less than block size / CHUNKSIZE (24) / minimum number of 1496199767f8SToomas Soome * chunks per entry (3). 1497199767f8SToomas Soome */ 1498199767f8SToomas Soome #define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5) 1499199767f8SToomas Soome #define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l)) 1500199767f8SToomas Soome 1501199767f8SToomas Soome /* 1502199767f8SToomas Soome * The chunks start immediately after the hash table. The end of the 1503199767f8SToomas Soome * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a 1504199767f8SToomas Soome * chunk_t. 1505199767f8SToomas Soome */ 1506199767f8SToomas Soome #define ZAP_LEAF_CHUNK(l, idx) \ 1507199767f8SToomas Soome ((zap_leaf_chunk_t *) \ 1508199767f8SToomas Soome ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx] 1509199767f8SToomas Soome #define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry) 1510199767f8SToomas Soome 1511199767f8SToomas Soome typedef enum zap_chunk_type { 1512199767f8SToomas Soome ZAP_CHUNK_FREE = 253, 1513199767f8SToomas Soome ZAP_CHUNK_ENTRY = 252, 1514199767f8SToomas Soome ZAP_CHUNK_ARRAY = 251, 1515199767f8SToomas Soome ZAP_CHUNK_TYPE_MAX = 250 1516199767f8SToomas Soome } zap_chunk_type_t; 1517199767f8SToomas Soome 1518199767f8SToomas Soome /* 1519199767f8SToomas Soome * TAKE NOTE: 1520199767f8SToomas Soome * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 1521199767f8SToomas Soome */ 1522199767f8SToomas Soome typedef struct zap_leaf_phys { 1523199767f8SToomas Soome struct zap_leaf_header { 1524199767f8SToomas Soome uint64_t lh_block_type; /* ZBT_LEAF */ 1525199767f8SToomas Soome uint64_t lh_pad1; 1526199767f8SToomas Soome uint64_t lh_prefix; /* hash prefix of this leaf */ 1527199767f8SToomas Soome uint32_t lh_magic; /* ZAP_LEAF_MAGIC */ 1528199767f8SToomas Soome uint16_t lh_nfree; /* number free chunks */ 1529199767f8SToomas Soome uint16_t lh_nentries; /* number of entries */ 1530199767f8SToomas Soome uint16_t lh_prefix_len; /* num bits used to id this */ 1531199767f8SToomas Soome 1532199767f8SToomas Soome /* above is accessable to zap, below is zap_leaf private */ 1533199767f8SToomas Soome 1534199767f8SToomas Soome uint16_t lh_freelist; /* chunk head of free list */ 1535199767f8SToomas Soome uint8_t lh_pad2[12]; 1536199767f8SToomas Soome } l_hdr; /* 2 24-byte chunks */ 1537199767f8SToomas Soome 1538199767f8SToomas Soome /* 1539199767f8SToomas Soome * The header is followed by a hash table with 1540199767f8SToomas Soome * ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is 1541199767f8SToomas Soome * followed by an array of ZAP_LEAF_NUMCHUNKS(zap) 1542199767f8SToomas Soome * zap_leaf_chunk structures. These structures are accessed 1543199767f8SToomas Soome * with the ZAP_LEAF_CHUNK() macro. 1544199767f8SToomas Soome */ 1545199767f8SToomas Soome 1546199767f8SToomas Soome uint16_t l_hash[1]; 1547199767f8SToomas Soome } zap_leaf_phys_t; 1548199767f8SToomas Soome 1549199767f8SToomas Soome typedef union zap_leaf_chunk { 1550199767f8SToomas Soome struct zap_leaf_entry { 15519890ff83SToomas Soome uint8_t le_type; /* always ZAP_CHUNK_ENTRY */ 1552199767f8SToomas Soome uint8_t le_value_intlen; /* size of ints */ 1553199767f8SToomas Soome uint16_t le_next; /* next entry in hash chain */ 1554199767f8SToomas Soome uint16_t le_name_chunk; /* first chunk of the name */ 1555199767f8SToomas Soome uint16_t le_name_numints; /* bytes in name, incl null */ 1556199767f8SToomas Soome uint16_t le_value_chunk; /* first chunk of the value */ 1557199767f8SToomas Soome uint16_t le_value_numints; /* value length in ints */ 1558199767f8SToomas Soome uint32_t le_cd; /* collision differentiator */ 1559199767f8SToomas Soome uint64_t le_hash; /* hash value of the name */ 1560199767f8SToomas Soome } l_entry; 1561199767f8SToomas Soome struct zap_leaf_array { 1562199767f8SToomas Soome uint8_t la_type; /* always ZAP_CHUNK_ARRAY */ 1563199767f8SToomas Soome uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 1564199767f8SToomas Soome uint16_t la_next; /* next blk or CHAIN_END */ 1565199767f8SToomas Soome } l_array; 1566199767f8SToomas Soome struct zap_leaf_free { 1567199767f8SToomas Soome uint8_t lf_type; /* always ZAP_CHUNK_FREE */ 1568199767f8SToomas Soome uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 1569199767f8SToomas Soome uint16_t lf_next; /* next in free list, or CHAIN_END */ 1570199767f8SToomas Soome } l_free; 1571199767f8SToomas Soome } zap_leaf_chunk_t; 1572199767f8SToomas Soome 1573199767f8SToomas Soome typedef struct zap_leaf { 1574199767f8SToomas Soome int l_bs; /* block size shift */ 1575199767f8SToomas Soome zap_leaf_phys_t *l_phys; 1576199767f8SToomas Soome } zap_leaf_t; 1577199767f8SToomas Soome 1578199767f8SToomas Soome /* 1579199767f8SToomas Soome * Define special zfs pflags 1580199767f8SToomas Soome */ 1581199767f8SToomas Soome #define ZFS_XATTR 0x1 /* is an extended attribute */ 1582199767f8SToomas Soome #define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ 1583199767f8SToomas Soome #define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ 1584199767f8SToomas Soome 1585199767f8SToomas Soome #define MASTER_NODE_OBJ 1 1586199767f8SToomas Soome 1587199767f8SToomas Soome /* 1588199767f8SToomas Soome * special attributes for master node. 1589199767f8SToomas Soome */ 1590199767f8SToomas Soome 1591199767f8SToomas Soome #define ZFS_FSID "FSID" 1592199767f8SToomas Soome #define ZFS_UNLINKED_SET "DELETE_QUEUE" 1593199767f8SToomas Soome #define ZFS_ROOT_OBJ "ROOT" 1594199767f8SToomas Soome #define ZPL_VERSION_OBJ "VERSION" 1595199767f8SToomas Soome #define ZFS_PROP_BLOCKPERPAGE "BLOCKPERPAGE" 1596199767f8SToomas Soome #define ZFS_PROP_NOGROWBLOCKS "NOGROWBLOCKS" 1597199767f8SToomas Soome 1598199767f8SToomas Soome #define ZFS_FLAG_BLOCKPERPAGE 0x1 1599199767f8SToomas Soome #define ZFS_FLAG_NOGROWBLOCKS 0x2 1600199767f8SToomas Soome 1601199767f8SToomas Soome /* 1602199767f8SToomas Soome * ZPL version - rev'd whenever an incompatible on-disk format change 1603199767f8SToomas Soome * occurs. Independent of SPA/DMU/ZAP versioning. 1604199767f8SToomas Soome */ 1605199767f8SToomas Soome 1606199767f8SToomas Soome #define ZPL_VERSION 1ULL 1607199767f8SToomas Soome 1608199767f8SToomas Soome /* 1609199767f8SToomas Soome * The directory entry has the type (currently unused on Solaris) in the 1610199767f8SToomas Soome * top 4 bits, and the object number in the low 48 bits. The "middle" 1611199767f8SToomas Soome * 12 bits are unused. 1612199767f8SToomas Soome */ 1613199767f8SToomas Soome #define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) 1614199767f8SToomas Soome #define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) 1615199767f8SToomas Soome #define ZFS_DIRENT_MAKE(type, obj) (((uint64_t)type << 60) | obj) 1616199767f8SToomas Soome 1617199767f8SToomas Soome typedef struct ace { 1618199767f8SToomas Soome uid_t a_who; /* uid or gid */ 1619199767f8SToomas Soome uint32_t a_access_mask; /* read,write,... */ 1620199767f8SToomas Soome uint16_t a_flags; /* see below */ 1621199767f8SToomas Soome uint16_t a_type; /* allow or deny */ 1622199767f8SToomas Soome } ace_t; 1623199767f8SToomas Soome 162408487eeaSToomas Soome #define ACE_SLOT_CNT 6 1625199767f8SToomas Soome 1626199767f8SToomas Soome typedef struct zfs_znode_acl { 1627199767f8SToomas Soome uint64_t z_acl_extern_obj; /* ext acl pieces */ 1628199767f8SToomas Soome uint32_t z_acl_count; /* Number of ACEs */ 1629199767f8SToomas Soome uint16_t z_acl_version; /* acl version */ 1630199767f8SToomas Soome uint16_t z_acl_pad; /* pad */ 1631199767f8SToomas Soome ace_t z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */ 1632199767f8SToomas Soome } zfs_znode_acl_t; 1633199767f8SToomas Soome 1634199767f8SToomas Soome /* 1635199767f8SToomas Soome * This is the persistent portion of the znode. It is stored 1636199767f8SToomas Soome * in the "bonus buffer" of the file. Short symbolic links 1637199767f8SToomas Soome * are also stored in the bonus buffer. 1638199767f8SToomas Soome */ 1639199767f8SToomas Soome typedef struct znode_phys { 1640199767f8SToomas Soome uint64_t zp_atime[2]; /* 0 - last file access time */ 1641199767f8SToomas Soome uint64_t zp_mtime[2]; /* 16 - last file modification time */ 1642199767f8SToomas Soome uint64_t zp_ctime[2]; /* 32 - last file change time */ 1643199767f8SToomas Soome uint64_t zp_crtime[2]; /* 48 - creation time */ 1644199767f8SToomas Soome uint64_t zp_gen; /* 64 - generation (txg of creation) */ 1645199767f8SToomas Soome uint64_t zp_mode; /* 72 - file mode bits */ 1646199767f8SToomas Soome uint64_t zp_size; /* 80 - size of file */ 1647199767f8SToomas Soome uint64_t zp_parent; /* 88 - directory parent (`..') */ 1648199767f8SToomas Soome uint64_t zp_links; /* 96 - number of links to file */ 1649199767f8SToomas Soome uint64_t zp_xattr; /* 104 - DMU object for xattrs */ 1650199767f8SToomas Soome uint64_t zp_rdev; /* 112 - dev_t for VBLK & VCHR files */ 1651199767f8SToomas Soome uint64_t zp_flags; /* 120 - persistent flags */ 1652199767f8SToomas Soome uint64_t zp_uid; /* 128 - file owner */ 1653199767f8SToomas Soome uint64_t zp_gid; /* 136 - owning group */ 1654199767f8SToomas Soome uint64_t zp_pad[4]; /* 144 - future */ 1655199767f8SToomas Soome zfs_znode_acl_t zp_acl; /* 176 - 263 ACL */ 1656199767f8SToomas Soome /* 1657199767f8SToomas Soome * Data may pad out any remaining bytes in the znode buffer, eg: 1658199767f8SToomas Soome * 1659199767f8SToomas Soome * |<---------------------- dnode_phys (512) ------------------------>| 1660199767f8SToomas Soome * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->| 1661199767f8SToomas Soome * |<---- znode (264) ---->|<---- data (56) ---->| 1662199767f8SToomas Soome * 1663199767f8SToomas Soome * At present, we only use this space to store symbolic links. 1664199767f8SToomas Soome */ 1665199767f8SToomas Soome } znode_phys_t; 1666199767f8SToomas Soome 1667199767f8SToomas Soome /* 1668199767f8SToomas Soome * In-core vdev representation. 1669199767f8SToomas Soome */ 1670199767f8SToomas Soome struct vdev; 16714a04e8dbSToomas Soome struct spa; 1672*b713c91eSToomas Soome typedef int vdev_phys_read_t(struct vdev *, void *, off_t, void *, size_t); 1673*b713c91eSToomas Soome typedef int vdev_phys_write_t(struct vdev *, off_t, void *, size_t); 1674*b713c91eSToomas Soome typedef int vdev_read_t(struct vdev *, const blkptr_t *, void *, off_t, size_t); 1675199767f8SToomas Soome 1676199767f8SToomas Soome typedef STAILQ_HEAD(vdev_list, vdev) vdev_list_t; 1677199767f8SToomas Soome 1678c023f651SToomas Soome typedef struct vdev_indirect_mapping_entry_phys { 1679c023f651SToomas Soome /* 1680c023f651SToomas Soome * Decode with DVA_MAPPING_* macros. 1681c023f651SToomas Soome * Contains: 1682c023f651SToomas Soome * the source offset (low 63 bits) 1683c023f651SToomas Soome * the one-bit "mark", used for garbage collection (by zdb) 1684c023f651SToomas Soome */ 1685c023f651SToomas Soome uint64_t vimep_src; 1686c023f651SToomas Soome 1687c023f651SToomas Soome /* 1688c023f651SToomas Soome * Note: the DVA's asize is 24 bits, and can thus store ranges 1689c023f651SToomas Soome * up to 8GB. 1690c023f651SToomas Soome */ 1691c023f651SToomas Soome dva_t vimep_dst; 1692c023f651SToomas Soome } vdev_indirect_mapping_entry_phys_t; 1693c023f651SToomas Soome 1694c023f651SToomas Soome #define DVA_MAPPING_GET_SRC_OFFSET(vimep) \ 1695c023f651SToomas Soome BF64_GET_SB((vimep)->vimep_src, 0, 63, SPA_MINBLOCKSHIFT, 0) 1696c023f651SToomas Soome #define DVA_MAPPING_SET_SRC_OFFSET(vimep, x) \ 1697c023f651SToomas Soome BF64_SET_SB((vimep)->vimep_src, 0, 63, SPA_MINBLOCKSHIFT, 0, x) 1698c023f651SToomas Soome 1699c023f651SToomas Soome typedef struct vdev_indirect_mapping_entry { 1700c023f651SToomas Soome vdev_indirect_mapping_entry_phys_t vime_mapping; 1701c023f651SToomas Soome uint32_t vime_obsolete_count; 1702c023f651SToomas Soome list_node_t vime_node; 1703c023f651SToomas Soome } vdev_indirect_mapping_entry_t; 1704c023f651SToomas Soome 1705c023f651SToomas Soome /* 1706c023f651SToomas Soome * This is stored in the bonus buffer of the mapping object, see comment of 1707c023f651SToomas Soome * vdev_indirect_config for more details. 1708c023f651SToomas Soome */ 1709c023f651SToomas Soome typedef struct vdev_indirect_mapping_phys { 1710c023f651SToomas Soome uint64_t vimp_max_offset; 1711c023f651SToomas Soome uint64_t vimp_bytes_mapped; 1712c023f651SToomas Soome uint64_t vimp_num_entries; /* number of v_i_m_entry_phys_t's */ 1713c023f651SToomas Soome 1714c023f651SToomas Soome /* 1715c023f651SToomas Soome * For each entry in the mapping object, this object contains an 1716c023f651SToomas Soome * entry representing the number of bytes of that mapping entry 1717c023f651SToomas Soome * that were no longer in use by the pool at the time this indirect 1718c023f651SToomas Soome * vdev was last condensed. 1719c023f651SToomas Soome */ 1720c023f651SToomas Soome uint64_t vimp_counts_object; 1721c023f651SToomas Soome } vdev_indirect_mapping_phys_t; 1722c023f651SToomas Soome 1723c023f651SToomas Soome #define VDEV_INDIRECT_MAPPING_SIZE_V0 (3 * sizeof (uint64_t)) 1724c023f651SToomas Soome 1725c023f651SToomas Soome typedef struct vdev_indirect_mapping { 1726c023f651SToomas Soome uint64_t vim_object; 1727c023f651SToomas Soome boolean_t vim_havecounts; 1728c023f651SToomas Soome 1729c023f651SToomas Soome /* vim_entries segment offset currently in memory. */ 1730c023f651SToomas Soome uint64_t vim_entry_offset; 1731c023f651SToomas Soome /* vim_entries segment size. */ 1732c023f651SToomas Soome size_t vim_num_entries; 1733c023f651SToomas Soome 1734c023f651SToomas Soome /* Needed by dnode_read() */ 1735c023f651SToomas Soome const void *vim_spa; 1736c023f651SToomas Soome dnode_phys_t *vim_dn; 1737c023f651SToomas Soome 1738c023f651SToomas Soome /* 1739c023f651SToomas Soome * An ordered array of mapping entries, sorted by source offset. 1740c023f651SToomas Soome * Note that vim_entries is needed during a removal (and contains 1741c023f651SToomas Soome * mappings that have been synced to disk so far) to handle frees 1742c023f651SToomas Soome * from the removing device. 1743c023f651SToomas Soome */ 1744c023f651SToomas Soome vdev_indirect_mapping_entry_phys_t *vim_entries; 1745c023f651SToomas Soome objset_phys_t *vim_objset; 1746c023f651SToomas Soome vdev_indirect_mapping_phys_t *vim_phys; 1747c023f651SToomas Soome } vdev_indirect_mapping_t; 1748c023f651SToomas Soome 1749c023f651SToomas Soome /* 1750c023f651SToomas Soome * On-disk indirect vdev state. 1751c023f651SToomas Soome * 1752c023f651SToomas Soome * An indirect vdev is described exclusively in the MOS config of a pool. 1753c023f651SToomas Soome * The config for an indirect vdev includes several fields, which are 1754c023f651SToomas Soome * accessed in memory by a vdev_indirect_config_t. 1755c023f651SToomas Soome */ 1756c023f651SToomas Soome typedef struct vdev_indirect_config { 1757c023f651SToomas Soome /* 1758c023f651SToomas Soome * Object (in MOS) which contains the indirect mapping. This object 1759c023f651SToomas Soome * contains an array of vdev_indirect_mapping_entry_phys_t ordered by 1760c023f651SToomas Soome * vimep_src. The bonus buffer for this object is a 1761c023f651SToomas Soome * vdev_indirect_mapping_phys_t. This object is allocated when a vdev 1762c023f651SToomas Soome * removal is initiated. 1763c023f651SToomas Soome * 1764c023f651SToomas Soome * Note that this object can be empty if none of the data on the vdev 1765c023f651SToomas Soome * has been copied yet. 1766c023f651SToomas Soome */ 1767c023f651SToomas Soome uint64_t vic_mapping_object; 1768c023f651SToomas Soome 1769c023f651SToomas Soome /* 1770c023f651SToomas Soome * Object (in MOS) which contains the birth times for the mapping 1771c023f651SToomas Soome * entries. This object contains an array of 1772c023f651SToomas Soome * vdev_indirect_birth_entry_phys_t sorted by vibe_offset. The bonus 1773c023f651SToomas Soome * buffer for this object is a vdev_indirect_birth_phys_t. This object 1774c023f651SToomas Soome * is allocated when a vdev removal is initiated. 1775c023f651SToomas Soome * 1776c023f651SToomas Soome * Note that this object can be empty if none of the vdev has yet been 1777c023f651SToomas Soome * copied. 1778c023f651SToomas Soome */ 1779c023f651SToomas Soome uint64_t vic_births_object; 1780c023f651SToomas Soome 1781c023f651SToomas Soome /* 1782c023f651SToomas Soome * This is the vdev ID which was removed previous to this vdev, or 1783c023f651SToomas Soome * UINT64_MAX if there are no previously removed vdevs. 1784c023f651SToomas Soome */ 1785c023f651SToomas Soome uint64_t vic_prev_indirect_vdev; 1786c023f651SToomas Soome } vdev_indirect_config_t; 1787c023f651SToomas Soome 1788199767f8SToomas Soome typedef struct vdev { 1789199767f8SToomas Soome STAILQ_ENTRY(vdev) v_childlink; /* link in parent's child list */ 1790199767f8SToomas Soome STAILQ_ENTRY(vdev) v_alllink; /* link in global vdev list */ 1791199767f8SToomas Soome vdev_list_t v_children; /* children of this vdev */ 1792199767f8SToomas Soome const char *v_name; /* vdev name */ 1793199767f8SToomas Soome const char *v_phys_path; /* vdev bootpath */ 1794199767f8SToomas Soome const char *v_devid; /* vdev devid */ 1795199767f8SToomas Soome uint64_t v_guid; /* vdev guid */ 17964c2b14fdSToomas Soome uint64_t v_id; /* index in parent */ 17974c2b14fdSToomas Soome uint64_t v_psize; /* physical device capacity */ 1798199767f8SToomas Soome int v_ashift; /* offset to block shift */ 1799199767f8SToomas Soome int v_nparity; /* # parity for raidz */ 1800199767f8SToomas Soome struct vdev *v_top; /* parent vdev */ 1801da9bf005SToomas Soome size_t v_nchildren; /* # children */ 1802199767f8SToomas Soome vdev_state_t v_state; /* current state */ 1803199767f8SToomas Soome vdev_phys_read_t *v_phys_read; /* read from raw leaf vdev */ 1804*b713c91eSToomas Soome vdev_phys_write_t *v_phys_write; /* write to raw leaf vdev */ 1805199767f8SToomas Soome vdev_read_t *v_read; /* read from vdev */ 1806*b713c91eSToomas Soome void *v_priv; /* data for read/write function */ 180767806cd7SToomas Soome boolean_t v_islog; 1808da9bf005SToomas Soome struct spa *v_spa; /* link to spa */ 1809c023f651SToomas Soome /* 1810c023f651SToomas Soome * Values stored in the config for an indirect or removing vdev. 1811c023f651SToomas Soome */ 1812c023f651SToomas Soome vdev_indirect_config_t vdev_indirect_config; 1813c023f651SToomas Soome vdev_indirect_mapping_t *v_mapping; 1814199767f8SToomas Soome } vdev_t; 1815199767f8SToomas Soome 1816199767f8SToomas Soome /* 1817199767f8SToomas Soome * In-core pool representation. 1818199767f8SToomas Soome */ 1819199767f8SToomas Soome typedef STAILQ_HEAD(spa_list, spa) spa_list_t; 1820199767f8SToomas Soome 1821199767f8SToomas Soome typedef struct spa { 1822199767f8SToomas Soome STAILQ_ENTRY(spa) spa_link; /* link in global pool list */ 1823199767f8SToomas Soome char *spa_name; /* pool name */ 1824199767f8SToomas Soome uint64_t spa_guid; /* pool guid */ 1825199767f8SToomas Soome uint64_t spa_txg; /* most recent transaction */ 1826199767f8SToomas Soome struct uberblock spa_uberblock; /* best uberblock so far */ 1827da9bf005SToomas Soome vdev_t *spa_root_vdev; /* toplevel vdev container */ 1828199767f8SToomas Soome objset_phys_t spa_mos; /* MOS for this pool */ 18294a04e8dbSToomas Soome zio_cksum_salt_t spa_cksum_salt; /* secret salt for cksum */ 18304a04e8dbSToomas Soome void *spa_cksum_tmpls[ZIO_CHECKSUM_FUNCTIONS]; 183145137058SToomas Soome vdev_t *spa_boot_vdev; /* boot device for kernel */ 183267806cd7SToomas Soome boolean_t spa_with_log; /* this pool has log */ 1833*b713c91eSToomas Soome void *spa_bootenv; /* bootenv from pool label */ 1834199767f8SToomas Soome } spa_t; 1835199767f8SToomas Soome 1836c023f651SToomas Soome /* IO related arguments. */ 1837c023f651SToomas Soome typedef struct zio { 1838c023f651SToomas Soome spa_t *io_spa; 1839c023f651SToomas Soome blkptr_t *io_bp; 1840c023f651SToomas Soome void *io_data; 1841c023f651SToomas Soome uint64_t io_size; 1842c023f651SToomas Soome uint64_t io_offset; 1843c023f651SToomas Soome 1844c023f651SToomas Soome /* Stuff for the vdev stack */ 1845c023f651SToomas Soome vdev_t *io_vd; 1846c023f651SToomas Soome void *io_vsd; 1847c023f651SToomas Soome 1848c023f651SToomas Soome int io_error; 1849c023f651SToomas Soome } zio_t; 1850c023f651SToomas Soome 1851*b713c91eSToomas Soome extern void decode_embedded_bp_compressed(const blkptr_t *, void *); 185208487eeaSToomas Soome 1853*b713c91eSToomas Soome #endif /* _ZFSIMPL_H_ */ 1854