zfsimpl.h revision 185029
1185029Spjd/*- 2185029Spjd * Copyright (c) 2002 McAfee, Inc. 3185029Spjd * All rights reserved. 4185029Spjd * 5185029Spjd * This software was developed for the FreeBSD Project by Marshall 6185029Spjd * Kirk McKusick and McAfee Research,, the Security Research Division of 7185029Spjd * McAfee, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as 8185029Spjd * part of the DARPA CHATS research program 9185029Spjd * 10185029Spjd * Redistribution and use in source and binary forms, with or without 11185029Spjd * modification, are permitted provided that the following conditions 12185029Spjd * are met: 13185029Spjd * 1. Redistributions of source code must retain the above copyright 14185029Spjd * notice, this list of conditions and the following disclaimer. 15185029Spjd * 2. Redistributions in binary form must reproduce the above copyright 16185029Spjd * notice, this list of conditions and the following disclaimer in the 17185029Spjd * documentation and/or other materials provided with the distribution. 18185029Spjd * 19185029Spjd * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20185029Spjd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21185029Spjd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22185029Spjd * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23185029Spjd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24185029Spjd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25185029Spjd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26185029Spjd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27185029Spjd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28185029Spjd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29185029Spjd * SUCH DAMAGE. 30185029Spjd */ 31185029Spjd/* 32185029Spjd * CDDL HEADER START 33185029Spjd * 34185029Spjd * The contents of this file are subject to the terms of the 35185029Spjd * Common Development and Distribution License (the "License"). 36185029Spjd * You may not use this file except in compliance with the License. 37185029Spjd * 38185029Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 39185029Spjd * or http://www.opensolaris.org/os/licensing. 40185029Spjd * See the License for the specific language governing permissions 41185029Spjd * and limitations under the License. 42185029Spjd * 43185029Spjd * When distributing Covered Code, include this CDDL HEADER in each 44185029Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 45185029Spjd * If applicable, add the following below this CDDL HEADER, with the 46185029Spjd * fields enclosed by brackets "[]" replaced with your own identifying 47185029Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 48185029Spjd * 49185029Spjd * CDDL HEADER END 50185029Spjd */ 51185029Spjd/* 52185029Spjd * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 53185029Spjd * Use is subject to license terms. 54185029Spjd */ 55185029Spjd 56185029Spjd/* CRC64 table */ 57185029Spjd#define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ 58185029Spjd 59185029Spjd/* 60185029Spjd * Macros for various sorts of alignment and rounding when the alignment 61185029Spjd * is known to be a power of 2. 62185029Spjd */ 63185029Spjd#define P2ALIGN(x, align) ((x) & -(align)) 64185029Spjd#define P2PHASE(x, align) ((x) & ((align) - 1)) 65185029Spjd#define P2NPHASE(x, align) (-(x) & ((align) - 1)) 66185029Spjd#define P2ROUNDUP(x, align) (-(-(x) & -(align))) 67185029Spjd#define P2END(x, align) (-(~(x) & -(align))) 68185029Spjd#define P2PHASEUP(x, align, phase) ((phase) - (((phase) - (x)) & -(align))) 69185029Spjd#define P2CROSS(x, y, align) (((x) ^ (y)) > (align) - 1) 70185029Spjd 71185029Spjd/* 72185029Spjd * General-purpose 32-bit and 64-bit bitfield encodings. 73185029Spjd */ 74185029Spjd#define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len)) 75185029Spjd#define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len)) 76185029Spjd#define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low)) 77185029Spjd#define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low)) 78185029Spjd 79185029Spjd#define BF32_GET(x, low, len) BF32_DECODE(x, low, len) 80185029Spjd#define BF64_GET(x, low, len) BF64_DECODE(x, low, len) 81185029Spjd 82185029Spjd#define BF32_SET(x, low, len, val) \ 83185029Spjd ((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len)) 84185029Spjd#define BF64_SET(x, low, len, val) \ 85185029Spjd ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)) 86185029Spjd 87185029Spjd#define BF32_GET_SB(x, low, len, shift, bias) \ 88185029Spjd ((BF32_GET(x, low, len) + (bias)) << (shift)) 89185029Spjd#define BF64_GET_SB(x, low, len, shift, bias) \ 90185029Spjd ((BF64_GET(x, low, len) + (bias)) << (shift)) 91185029Spjd 92185029Spjd#define BF32_SET_SB(x, low, len, shift, bias, val) \ 93185029Spjd BF32_SET(x, low, len, ((val) >> (shift)) - (bias)) 94185029Spjd#define BF64_SET_SB(x, low, len, shift, bias, val) \ 95185029Spjd BF64_SET(x, low, len, ((val) >> (shift)) - (bias)) 96185029Spjd 97185029Spjd/* 98185029Spjd * We currently support nine block sizes, from 512 bytes to 128K. 99185029Spjd * We could go higher, but the benefits are near-zero and the cost 100185029Spjd * of COWing a giant block to modify one byte would become excessive. 101185029Spjd */ 102185029Spjd#define SPA_MINBLOCKSHIFT 9 103185029Spjd#define SPA_MAXBLOCKSHIFT 17 104185029Spjd#define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT) 105185029Spjd#define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT) 106185029Spjd 107185029Spjd#define SPA_BLOCKSIZES (SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1) 108185029Spjd 109185029Spjd/* 110185029Spjd * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB. 111185029Spjd * The ASIZE encoding should be at least 64 times larger (6 more bits) 112185029Spjd * to support up to 4-way RAID-Z mirror mode with worst-case gang block 113185029Spjd * overhead, three DVAs per bp, plus one more bit in case we do anything 114185029Spjd * else that expands the ASIZE. 115185029Spjd */ 116185029Spjd#define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */ 117185029Spjd#define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */ 118185029Spjd#define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */ 119185029Spjd 120185029Spjd/* 121185029Spjd * All SPA data is represented by 128-bit data virtual addresses (DVAs). 122185029Spjd * The members of the dva_t should be considered opaque outside the SPA. 123185029Spjd */ 124185029Spjdtypedef struct dva { 125185029Spjd uint64_t dva_word[2]; 126185029Spjd} dva_t; 127185029Spjd 128185029Spjd/* 129185029Spjd * Each block has a 256-bit checksum -- strong enough for cryptographic hashes. 130185029Spjd */ 131185029Spjdtypedef struct zio_cksum { 132185029Spjd uint64_t zc_word[4]; 133185029Spjd} zio_cksum_t; 134185029Spjd 135185029Spjd/* 136185029Spjd * Each block is described by its DVAs, time of birth, checksum, etc. 137185029Spjd * The word-by-word, bit-by-bit layout of the blkptr is as follows: 138185029Spjd * 139185029Spjd * 64 56 48 40 32 24 16 8 0 140185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 141185029Spjd * 0 | vdev1 | GRID | ASIZE | 142185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 143185029Spjd * 1 |G| offset1 | 144185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 145185029Spjd * 2 | vdev2 | GRID | ASIZE | 146185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 147185029Spjd * 3 |G| offset2 | 148185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 149185029Spjd * 4 | vdev3 | GRID | ASIZE | 150185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 151185029Spjd * 5 |G| offset3 | 152185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 153185029Spjd * 6 |E| lvl | type | cksum | comp | PSIZE | LSIZE | 154185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 155185029Spjd * 7 | padding | 156185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 157185029Spjd * 8 | padding | 158185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 159185029Spjd * 9 | padding | 160185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 161185029Spjd * a | birth txg | 162185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 163185029Spjd * b | fill count | 164185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 165185029Spjd * c | checksum[0] | 166185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 167185029Spjd * d | checksum[1] | 168185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 169185029Spjd * e | checksum[2] | 170185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 171185029Spjd * f | checksum[3] | 172185029Spjd * +-------+-------+-------+-------+-------+-------+-------+-------+ 173185029Spjd * 174185029Spjd * Legend: 175185029Spjd * 176185029Spjd * vdev virtual device ID 177185029Spjd * offset offset into virtual device 178185029Spjd * LSIZE logical size 179185029Spjd * PSIZE physical size (after compression) 180185029Spjd * ASIZE allocated size (including RAID-Z parity and gang block headers) 181185029Spjd * GRID RAID-Z layout information (reserved for future use) 182185029Spjd * cksum checksum function 183185029Spjd * comp compression function 184185029Spjd * G gang block indicator 185185029Spjd * E endianness 186185029Spjd * type DMU object type 187185029Spjd * lvl level of indirection 188185029Spjd * birth txg transaction group in which the block was born 189185029Spjd * fill count number of non-zero blocks under this bp 190185029Spjd * checksum[4] 256-bit checksum of the data this bp describes 191185029Spjd */ 192185029Spjdtypedef struct blkptr { 193185029Spjd dva_t blk_dva[3]; /* 128-bit Data Virtual Address */ 194185029Spjd uint64_t blk_prop; /* size, compression, type, etc */ 195185029Spjd uint64_t blk_pad[3]; /* Extra space for the future */ 196185029Spjd uint64_t blk_birth; /* transaction group at birth */ 197185029Spjd uint64_t blk_fill; /* fill count */ 198185029Spjd zio_cksum_t blk_cksum; /* 256-bit checksum */ 199185029Spjd} blkptr_t; 200185029Spjd 201185029Spjd#define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */ 202185029Spjd#define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */ 203185029Spjd 204185029Spjd/* 205185029Spjd * Macros to get and set fields in a bp or DVA. 206185029Spjd */ 207185029Spjd#define DVA_GET_ASIZE(dva) \ 208185029Spjd BF64_GET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0) 209185029Spjd#define DVA_SET_ASIZE(dva, x) \ 210185029Spjd BF64_SET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0, x) 211185029Spjd 212185029Spjd#define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8) 213185029Spjd#define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x) 214185029Spjd 215185029Spjd#define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32) 216185029Spjd#define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x) 217185029Spjd 218185029Spjd#define DVA_GET_OFFSET(dva) \ 219185029Spjd BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0) 220185029Spjd#define DVA_SET_OFFSET(dva, x) \ 221185029Spjd BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x) 222185029Spjd 223185029Spjd#define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1) 224185029Spjd#define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x) 225185029Spjd 226185029Spjd#define BP_GET_LSIZE(bp) \ 227185029Spjd (BP_IS_HOLE(bp) ? 0 : \ 228185029Spjd BF64_GET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1)) 229185029Spjd#define BP_SET_LSIZE(bp, x) \ 230185029Spjd BF64_SET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x) 231185029Spjd 232185029Spjd#define BP_GET_PSIZE(bp) \ 233185029Spjd BF64_GET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1) 234185029Spjd#define BP_SET_PSIZE(bp, x) \ 235185029Spjd BF64_SET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1, x) 236185029Spjd 237185029Spjd#define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 8) 238185029Spjd#define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 8, x) 239185029Spjd 240185029Spjd#define BP_GET_CHECKSUM(bp) BF64_GET((bp)->blk_prop, 40, 8) 241185029Spjd#define BP_SET_CHECKSUM(bp, x) BF64_SET((bp)->blk_prop, 40, 8, x) 242185029Spjd 243185029Spjd#define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8) 244185029Spjd#define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x) 245185029Spjd 246185029Spjd#define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5) 247185029Spjd#define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x) 248185029Spjd 249185029Spjd#define BP_GET_BYTEORDER(bp) (0 - BF64_GET((bp)->blk_prop, 63, 1)) 250185029Spjd#define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x) 251185029Spjd 252185029Spjd#define BP_GET_ASIZE(bp) \ 253185029Spjd (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 254185029Spjd DVA_GET_ASIZE(&(bp)->blk_dva[2])) 255185029Spjd 256185029Spjd#define BP_GET_UCSIZE(bp) \ 257185029Spjd ((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \ 258185029Spjd BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp)); 259185029Spjd 260185029Spjd#define BP_GET_NDVAS(bp) \ 261185029Spjd (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \ 262185029Spjd !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \ 263185029Spjd !!DVA_GET_ASIZE(&(bp)->blk_dva[2])) 264185029Spjd 265185029Spjd#define BP_COUNT_GANG(bp) \ 266185029Spjd (DVA_GET_GANG(&(bp)->blk_dva[0]) + \ 267185029Spjd DVA_GET_GANG(&(bp)->blk_dva[1]) + \ 268185029Spjd DVA_GET_GANG(&(bp)->blk_dva[2])) 269185029Spjd 270185029Spjd#define DVA_EQUAL(dva1, dva2) \ 271185029Spjd ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \ 272185029Spjd (dva1)->dva_word[0] == (dva2)->dva_word[0]) 273185029Spjd 274185029Spjd#define ZIO_CHECKSUM_EQUAL(zc1, zc2) \ 275185029Spjd (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \ 276185029Spjd ((zc1).zc_word[1] - (zc2).zc_word[1]) | \ 277185029Spjd ((zc1).zc_word[2] - (zc2).zc_word[2]) | \ 278185029Spjd ((zc1).zc_word[3] - (zc2).zc_word[3]))) 279185029Spjd 280185029Spjd 281185029Spjd#define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0) 282185029Spjd 283185029Spjd#define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \ 284185029Spjd{ \ 285185029Spjd (zcp)->zc_word[0] = w0; \ 286185029Spjd (zcp)->zc_word[1] = w1; \ 287185029Spjd (zcp)->zc_word[2] = w2; \ 288185029Spjd (zcp)->zc_word[3] = w3; \ 289185029Spjd} 290185029Spjd 291185029Spjd#define BP_IDENTITY(bp) (&(bp)->blk_dva[0]) 292185029Spjd#define BP_IS_GANG(bp) DVA_GET_GANG(BP_IDENTITY(bp)) 293185029Spjd#define BP_IS_HOLE(bp) ((bp)->blk_birth == 0) 294185029Spjd#define BP_IS_OLDER(bp, txg) (!BP_IS_HOLE(bp) && (bp)->blk_birth < (txg)) 295185029Spjd 296185029Spjd#define BP_ZERO(bp) \ 297185029Spjd{ \ 298185029Spjd (bp)->blk_dva[0].dva_word[0] = 0; \ 299185029Spjd (bp)->blk_dva[0].dva_word[1] = 0; \ 300185029Spjd (bp)->blk_dva[1].dva_word[0] = 0; \ 301185029Spjd (bp)->blk_dva[1].dva_word[1] = 0; \ 302185029Spjd (bp)->blk_dva[2].dva_word[0] = 0; \ 303185029Spjd (bp)->blk_dva[2].dva_word[1] = 0; \ 304185029Spjd (bp)->blk_prop = 0; \ 305185029Spjd (bp)->blk_pad[0] = 0; \ 306185029Spjd (bp)->blk_pad[1] = 0; \ 307185029Spjd (bp)->blk_pad[2] = 0; \ 308185029Spjd (bp)->blk_birth = 0; \ 309185029Spjd (bp)->blk_fill = 0; \ 310185029Spjd ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \ 311185029Spjd} 312185029Spjd 313185029Spjd#define ZBT_MAGIC 0x210da7ab10c7a11ULL /* zio data bloc tail */ 314185029Spjd 315185029Spjdtypedef struct zio_block_tail { 316185029Spjd uint64_t zbt_magic; /* for validation, endianness */ 317185029Spjd zio_cksum_t zbt_cksum; /* 256-bit checksum */ 318185029Spjd} zio_block_tail_t; 319185029Spjd 320185029Spjd#define VDEV_SKIP_SIZE (8 << 10) 321185029Spjd#define VDEV_BOOT_HEADER_SIZE (8 << 10) 322185029Spjd#define VDEV_PHYS_SIZE (112 << 10) 323185029Spjd#define VDEV_UBERBLOCK_RING (128 << 10) 324185029Spjd 325185029Spjd#define VDEV_UBERBLOCK_SHIFT(vd) \ 326185029Spjd MAX((vd)->vdev_top->vdev_ashift, UBERBLOCK_SHIFT) 327185029Spjd#define VDEV_UBERBLOCK_COUNT(vd) \ 328185029Spjd (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd)) 329185029Spjd#define VDEV_UBERBLOCK_OFFSET(vd, n) \ 330185029Spjd offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)]) 331185029Spjd#define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd)) 332185029Spjd 333185029Spjd/* ZFS boot block */ 334185029Spjd#define VDEV_BOOT_MAGIC 0x2f5b007b10cULL 335185029Spjd#define VDEV_BOOT_VERSION 1 /* version number */ 336185029Spjd 337185029Spjdtypedef struct vdev_boot_header { 338185029Spjd uint64_t vb_magic; /* VDEV_BOOT_MAGIC */ 339185029Spjd uint64_t vb_version; /* VDEV_BOOT_VERSION */ 340185029Spjd uint64_t vb_offset; /* start offset (bytes) */ 341185029Spjd uint64_t vb_size; /* size (bytes) */ 342185029Spjd char vb_pad[VDEV_BOOT_HEADER_SIZE - 4 * sizeof (uint64_t)]; 343185029Spjd} vdev_boot_header_t; 344185029Spjd 345185029Spjdtypedef struct vdev_phys { 346185029Spjd char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_block_tail_t)]; 347185029Spjd zio_block_tail_t vp_zbt; 348185029Spjd} vdev_phys_t; 349185029Spjd 350185029Spjdtypedef struct vdev_label { 351185029Spjd char vl_pad[VDEV_SKIP_SIZE]; /* 8K */ 352185029Spjd vdev_boot_header_t vl_boot_header; /* 8K */ 353185029Spjd vdev_phys_t vl_vdev_phys; /* 112K */ 354185029Spjd char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */ 355185029Spjd} vdev_label_t; /* 256K total */ 356185029Spjd 357185029Spjd/* 358185029Spjd * vdev_dirty() flags 359185029Spjd */ 360185029Spjd#define VDD_METASLAB 0x01 361185029Spjd#define VDD_DTL 0x02 362185029Spjd 363185029Spjd/* 364185029Spjd * Size and offset of embedded boot loader region on each label. 365185029Spjd * The total size of the first two labels plus the boot area is 4MB. 366185029Spjd */ 367185029Spjd#define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 368185029Spjd#define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 369185029Spjd 370185029Spjd/* 371185029Spjd * Size of label regions at the start and end of each leaf device. 372185029Spjd */ 373185029Spjd#define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 374185029Spjd#define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 375185029Spjd#define VDEV_LABELS 4 376185029Spjd 377185029Spjdenum zio_checksum { 378185029Spjd ZIO_CHECKSUM_INHERIT = 0, 379185029Spjd ZIO_CHECKSUM_ON, 380185029Spjd ZIO_CHECKSUM_OFF, 381185029Spjd ZIO_CHECKSUM_LABEL, 382185029Spjd ZIO_CHECKSUM_GANG_HEADER, 383185029Spjd ZIO_CHECKSUM_ZILOG, 384185029Spjd ZIO_CHECKSUM_FLETCHER_2, 385185029Spjd ZIO_CHECKSUM_FLETCHER_4, 386185029Spjd ZIO_CHECKSUM_SHA256, 387185029Spjd ZIO_CHECKSUM_FUNCTIONS 388185029Spjd}; 389185029Spjd 390185029Spjd#define ZIO_CHECKSUM_ON_VALUE ZIO_CHECKSUM_FLETCHER_2 391185029Spjd#define ZIO_CHECKSUM_DEFAULT ZIO_CHECKSUM_ON 392185029Spjd 393185029Spjdenum zio_compress { 394185029Spjd ZIO_COMPRESS_INHERIT = 0, 395185029Spjd ZIO_COMPRESS_ON, 396185029Spjd ZIO_COMPRESS_OFF, 397185029Spjd ZIO_COMPRESS_LZJB, 398185029Spjd ZIO_COMPRESS_EMPTY, 399185029Spjd ZIO_COMPRESS_GZIP_1, 400185029Spjd ZIO_COMPRESS_GZIP_2, 401185029Spjd ZIO_COMPRESS_GZIP_3, 402185029Spjd ZIO_COMPRESS_GZIP_4, 403185029Spjd ZIO_COMPRESS_GZIP_5, 404185029Spjd ZIO_COMPRESS_GZIP_6, 405185029Spjd ZIO_COMPRESS_GZIP_7, 406185029Spjd ZIO_COMPRESS_GZIP_8, 407185029Spjd ZIO_COMPRESS_GZIP_9, 408185029Spjd ZIO_COMPRESS_FUNCTIONS 409185029Spjd}; 410185029Spjd 411185029Spjd#define ZIO_COMPRESS_ON_VALUE ZIO_COMPRESS_LZJB 412185029Spjd#define ZIO_COMPRESS_DEFAULT ZIO_COMPRESS_OFF 413185029Spjd 414185029Spjd/* nvlist pack encoding */ 415185029Spjd#define NV_ENCODE_NATIVE 0 416185029Spjd#define NV_ENCODE_XDR 1 417185029Spjd 418185029Spjdtypedef enum { 419185029Spjd DATA_TYPE_UNKNOWN = 0, 420185029Spjd DATA_TYPE_BOOLEAN, 421185029Spjd DATA_TYPE_BYTE, 422185029Spjd DATA_TYPE_INT16, 423185029Spjd DATA_TYPE_UINT16, 424185029Spjd DATA_TYPE_INT32, 425185029Spjd DATA_TYPE_UINT32, 426185029Spjd DATA_TYPE_INT64, 427185029Spjd DATA_TYPE_UINT64, 428185029Spjd DATA_TYPE_STRING, 429185029Spjd DATA_TYPE_BYTE_ARRAY, 430185029Spjd DATA_TYPE_INT16_ARRAY, 431185029Spjd DATA_TYPE_UINT16_ARRAY, 432185029Spjd DATA_TYPE_INT32_ARRAY, 433185029Spjd DATA_TYPE_UINT32_ARRAY, 434185029Spjd DATA_TYPE_INT64_ARRAY, 435185029Spjd DATA_TYPE_UINT64_ARRAY, 436185029Spjd DATA_TYPE_STRING_ARRAY, 437185029Spjd DATA_TYPE_HRTIME, 438185029Spjd DATA_TYPE_NVLIST, 439185029Spjd DATA_TYPE_NVLIST_ARRAY, 440185029Spjd DATA_TYPE_BOOLEAN_VALUE, 441185029Spjd DATA_TYPE_INT8, 442185029Spjd DATA_TYPE_UINT8, 443185029Spjd DATA_TYPE_BOOLEAN_ARRAY, 444185029Spjd DATA_TYPE_INT8_ARRAY, 445185029Spjd DATA_TYPE_UINT8_ARRAY 446185029Spjd} data_type_t; 447185029Spjd 448185029Spjd/* 449185029Spjd * On-disk version number. 450185029Spjd */ 451185029Spjd#define ZFS_VERSION_1 1ULL 452185029Spjd#define ZFS_VERSION_2 2ULL 453185029Spjd#define ZFS_VERSION_3 3ULL 454185029Spjd#define ZFS_VERSION_4 4ULL 455185029Spjd#define ZFS_VERSION_5 5ULL 456185029Spjd#define ZFS_VERSION_6 6ULL 457185029Spjd/* 458185029Spjd * When bumping up ZFS_VERSION, make sure GRUB ZFS understand the on-disk 459185029Spjd * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*}, 460185029Spjd * and do the appropriate changes. 461185029Spjd */ 462185029Spjd#define ZFS_VERSION ZFS_VERSION_6 463185029Spjd#define ZFS_VERSION_STRING "6" 464185029Spjd 465185029Spjd/* 466185029Spjd * Symbolic names for the changes that caused a ZFS_VERSION switch. 467185029Spjd * Used in the code when checking for presence or absence of a feature. 468185029Spjd * Feel free to define multiple symbolic names for each version if there 469185029Spjd * were multiple changes to on-disk structures during that version. 470185029Spjd * 471185029Spjd * NOTE: When checking the current ZFS_VERSION in your code, be sure 472185029Spjd * to use spa_version() since it reports the version of the 473185029Spjd * last synced uberblock. Checking the in-flight version can 474185029Spjd * be dangerous in some cases. 475185029Spjd */ 476185029Spjd#define ZFS_VERSION_INITIAL ZFS_VERSION_1 477185029Spjd#define ZFS_VERSION_DITTO_BLOCKS ZFS_VERSION_2 478185029Spjd#define ZFS_VERSION_SPARES ZFS_VERSION_3 479185029Spjd#define ZFS_VERSION_RAID6 ZFS_VERSION_3 480185029Spjd#define ZFS_VERSION_BPLIST_ACCOUNT ZFS_VERSION_3 481185029Spjd#define ZFS_VERSION_RAIDZ_DEFLATE ZFS_VERSION_3 482185029Spjd#define ZFS_VERSION_DNODE_BYTES ZFS_VERSION_3 483185029Spjd#define ZFS_VERSION_ZPOOL_HISTORY ZFS_VERSION_4 484185029Spjd#define ZFS_VERSION_GZIP_COMPRESSION ZFS_VERSION_5 485185029Spjd#define ZFS_VERSION_BOOTFS ZFS_VERSION_6 486185029Spjd 487185029Spjd/* 488185029Spjd * The following are configuration names used in the nvlist describing a pool's 489185029Spjd * configuration. 490185029Spjd */ 491185029Spjd#define ZPOOL_CONFIG_VERSION "version" 492185029Spjd#define ZPOOL_CONFIG_POOL_NAME "name" 493185029Spjd#define ZPOOL_CONFIG_POOL_STATE "state" 494185029Spjd#define ZPOOL_CONFIG_POOL_TXG "txg" 495185029Spjd#define ZPOOL_CONFIG_POOL_GUID "pool_guid" 496185029Spjd#define ZPOOL_CONFIG_CREATE_TXG "create_txg" 497185029Spjd#define ZPOOL_CONFIG_TOP_GUID "top_guid" 498185029Spjd#define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 499185029Spjd#define ZPOOL_CONFIG_TYPE "type" 500185029Spjd#define ZPOOL_CONFIG_CHILDREN "children" 501185029Spjd#define ZPOOL_CONFIG_ID "id" 502185029Spjd#define ZPOOL_CONFIG_GUID "guid" 503185029Spjd#define ZPOOL_CONFIG_PATH "path" 504185029Spjd#define ZPOOL_CONFIG_DEVID "devid" 505185029Spjd#define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 506185029Spjd#define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 507185029Spjd#define ZPOOL_CONFIG_ASHIFT "ashift" 508185029Spjd#define ZPOOL_CONFIG_ASIZE "asize" 509185029Spjd#define ZPOOL_CONFIG_DTL "DTL" 510185029Spjd#define ZPOOL_CONFIG_STATS "stats" 511185029Spjd#define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 512185029Spjd#define ZPOOL_CONFIG_OFFLINE "offline" 513185029Spjd#define ZPOOL_CONFIG_ERRCOUNT "error_count" 514185029Spjd#define ZPOOL_CONFIG_NOT_PRESENT "not_present" 515185029Spjd#define ZPOOL_CONFIG_SPARES "spares" 516185029Spjd#define ZPOOL_CONFIG_IS_SPARE "is_spare" 517185029Spjd#define ZPOOL_CONFIG_NPARITY "nparity" 518185029Spjd#define ZPOOL_CONFIG_HOSTID "hostid" 519185029Spjd#define ZPOOL_CONFIG_HOSTNAME "hostname" 520185029Spjd#define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 521185029Spjd 522185029Spjd#define VDEV_TYPE_ROOT "root" 523185029Spjd#define VDEV_TYPE_MIRROR "mirror" 524185029Spjd#define VDEV_TYPE_REPLACING "replacing" 525185029Spjd#define VDEV_TYPE_RAIDZ "raidz" 526185029Spjd#define VDEV_TYPE_DISK "disk" 527185029Spjd#define VDEV_TYPE_FILE "file" 528185029Spjd#define VDEV_TYPE_MISSING "missing" 529185029Spjd#define VDEV_TYPE_SPARE "spare" 530185029Spjd 531185029Spjd/* 532185029Spjd * This is needed in userland to report the minimum necessary device size. 533185029Spjd */ 534185029Spjd#define SPA_MINDEVSIZE (64ULL << 20) 535185029Spjd 536185029Spjd/* 537185029Spjd * The location of the pool configuration repository, shared between kernel and 538185029Spjd * userland. 539185029Spjd */ 540185029Spjd#define ZPOOL_CACHE_DIR "/boot/zfs" 541185029Spjd#define ZPOOL_CACHE_FILE "zpool.cache" 542185029Spjd#define ZPOOL_CACHE_TMP ".zpool.cache" 543185029Spjd 544185029Spjd#define ZPOOL_CACHE ZPOOL_CACHE_DIR "/" ZPOOL_CACHE_FILE 545185029Spjd 546185029Spjd/* 547185029Spjd * vdev states are ordered from least to most healthy. 548185029Spjd * A vdev that's CANT_OPEN or below is considered unusable. 549185029Spjd */ 550185029Spjdtypedef enum vdev_state { 551185029Spjd VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 552185029Spjd VDEV_STATE_CLOSED, /* Not currently open */ 553185029Spjd VDEV_STATE_OFFLINE, /* Not allowed to open */ 554185029Spjd VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 555185029Spjd VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 556185029Spjd VDEV_STATE_HEALTHY /* Presumed good */ 557185029Spjd} vdev_state_t; 558185029Spjd 559185029Spjd/* 560185029Spjd * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 561185029Spjd * of the vdev stats structure uses these constants to distinguish why. 562185029Spjd */ 563185029Spjdtypedef enum vdev_aux { 564185029Spjd VDEV_AUX_NONE, /* no error */ 565185029Spjd VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 566185029Spjd VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 567185029Spjd VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 568185029Spjd VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 569185029Spjd VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 570185029Spjd VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 571185029Spjd VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 572185029Spjd VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 573185029Spjd VDEV_AUX_SPARED /* hot spare used in another pool */ 574185029Spjd} vdev_aux_t; 575185029Spjd 576185029Spjd/* 577185029Spjd * pool state. The following states are written to disk as part of the normal 578185029Spjd * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE. The remaining states are 579185029Spjd * software abstractions used at various levels to communicate pool state. 580185029Spjd */ 581185029Spjdtypedef enum pool_state { 582185029Spjd POOL_STATE_ACTIVE = 0, /* In active use */ 583185029Spjd POOL_STATE_EXPORTED, /* Explicitly exported */ 584185029Spjd POOL_STATE_DESTROYED, /* Explicitly destroyed */ 585185029Spjd POOL_STATE_SPARE, /* Reserved for hot spare use */ 586185029Spjd POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 587185029Spjd POOL_STATE_UNAVAIL, /* Internal libzfs state */ 588185029Spjd POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 589185029Spjd} pool_state_t; 590185029Spjd 591185029Spjd/* 592185029Spjd * The uberblock version is incremented whenever an incompatible on-disk 593185029Spjd * format change is made to the SPA, DMU, or ZAP. 594185029Spjd * 595185029Spjd * Note: the first two fields should never be moved. When a storage pool 596185029Spjd * is opened, the uberblock must be read off the disk before the version 597185029Spjd * can be checked. If the ub_version field is moved, we may not detect 598185029Spjd * version mismatch. If the ub_magic field is moved, applications that 599185029Spjd * expect the magic number in the first word won't work. 600185029Spjd */ 601185029Spjd#define UBERBLOCK_MAGIC 0x00bab10c /* oo-ba-bloc! */ 602185029Spjd#define UBERBLOCK_SHIFT 10 /* up to 1K */ 603185029Spjd 604185029Spjdstruct uberblock { 605185029Spjd uint64_t ub_magic; /* UBERBLOCK_MAGIC */ 606185029Spjd uint64_t ub_version; /* ZFS_VERSION */ 607185029Spjd uint64_t ub_txg; /* txg of last sync */ 608185029Spjd uint64_t ub_guid_sum; /* sum of all vdev guids */ 609185029Spjd uint64_t ub_timestamp; /* UTC time of last sync */ 610185029Spjd blkptr_t ub_rootbp; /* MOS objset_phys_t */ 611185029Spjd}; 612185029Spjd 613185029Spjd/* 614185029Spjd * Flags. 615185029Spjd */ 616185029Spjd#define DNODE_MUST_BE_ALLOCATED 1 617185029Spjd#define DNODE_MUST_BE_FREE 2 618185029Spjd 619185029Spjd/* 620185029Spjd * Fixed constants. 621185029Spjd */ 622185029Spjd#define DNODE_SHIFT 9 /* 512 bytes */ 623185029Spjd#define DN_MIN_INDBLKSHIFT 10 /* 1k */ 624185029Spjd#define DN_MAX_INDBLKSHIFT 14 /* 16k */ 625185029Spjd#define DNODE_BLOCK_SHIFT 14 /* 16k */ 626185029Spjd#define DNODE_CORE_SIZE 64 /* 64 bytes for dnode sans blkptrs */ 627185029Spjd#define DN_MAX_OBJECT_SHIFT 48 /* 256 trillion (zfs_fid_t limit) */ 628185029Spjd#define DN_MAX_OFFSET_SHIFT 64 /* 2^64 bytes in a dnode */ 629185029Spjd 630185029Spjd/* 631185029Spjd * Derived constants. 632185029Spjd */ 633185029Spjd#define DNODE_SIZE (1 << DNODE_SHIFT) 634185029Spjd#define DN_MAX_NBLKPTR ((DNODE_SIZE - DNODE_CORE_SIZE) >> SPA_BLKPTRSHIFT) 635185029Spjd#define DN_MAX_BONUSLEN (DNODE_SIZE - DNODE_CORE_SIZE - (1 << SPA_BLKPTRSHIFT)) 636185029Spjd#define DN_MAX_OBJECT (1ULL << DN_MAX_OBJECT_SHIFT) 637185029Spjd 638185029Spjd#define DNODES_PER_BLOCK_SHIFT (DNODE_BLOCK_SHIFT - DNODE_SHIFT) 639185029Spjd#define DNODES_PER_BLOCK (1ULL << DNODES_PER_BLOCK_SHIFT) 640185029Spjd#define DNODES_PER_LEVEL_SHIFT (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT) 641185029Spjd 642185029Spjd/* The +2 here is a cheesy way to round up */ 643185029Spjd#define DN_MAX_LEVELS (2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \ 644185029Spjd (DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT))) 645185029Spjd 646185029Spjd#define DN_BONUS(dnp) ((void*)((dnp)->dn_bonus + \ 647185029Spjd (((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t)))) 648185029Spjd 649185029Spjd#define DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \ 650185029Spjd (dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT) 651185029Spjd 652185029Spjd#define EPB(blkshift, typeshift) (1 << (blkshift - typeshift)) 653185029Spjd 654185029Spjd/* Is dn_used in bytes? if not, it's in multiples of SPA_MINBLOCKSIZE */ 655185029Spjd#define DNODE_FLAG_USED_BYTES (1<<0) 656185029Spjd 657185029Spjdtypedef struct dnode_phys { 658185029Spjd uint8_t dn_type; /* dmu_object_type_t */ 659185029Spjd uint8_t dn_indblkshift; /* ln2(indirect block size) */ 660185029Spjd uint8_t dn_nlevels; /* 1=dn_blkptr->data blocks */ 661185029Spjd uint8_t dn_nblkptr; /* length of dn_blkptr */ 662185029Spjd uint8_t dn_bonustype; /* type of data in bonus buffer */ 663185029Spjd uint8_t dn_checksum; /* ZIO_CHECKSUM type */ 664185029Spjd uint8_t dn_compress; /* ZIO_COMPRESS type */ 665185029Spjd uint8_t dn_flags; /* DNODE_FLAG_* */ 666185029Spjd uint16_t dn_datablkszsec; /* data block size in 512b sectors */ 667185029Spjd uint16_t dn_bonuslen; /* length of dn_bonus */ 668185029Spjd uint8_t dn_pad2[4]; 669185029Spjd 670185029Spjd /* accounting is protected by dn_dirty_mtx */ 671185029Spjd uint64_t dn_maxblkid; /* largest allocated block ID */ 672185029Spjd uint64_t dn_used; /* bytes (or sectors) of disk space */ 673185029Spjd 674185029Spjd uint64_t dn_pad3[4]; 675185029Spjd 676185029Spjd blkptr_t dn_blkptr[1]; 677185029Spjd uint8_t dn_bonus[DN_MAX_BONUSLEN]; 678185029Spjd} dnode_phys_t; 679185029Spjd 680185029Spjdtypedef enum dmu_object_type { 681185029Spjd DMU_OT_NONE, 682185029Spjd /* general: */ 683185029Spjd DMU_OT_OBJECT_DIRECTORY, /* ZAP */ 684185029Spjd DMU_OT_OBJECT_ARRAY, /* UINT64 */ 685185029Spjd DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ 686185029Spjd DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ 687185029Spjd DMU_OT_BPLIST, /* UINT64 */ 688185029Spjd DMU_OT_BPLIST_HDR, /* UINT64 */ 689185029Spjd /* spa: */ 690185029Spjd DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ 691185029Spjd DMU_OT_SPACE_MAP, /* UINT64 */ 692185029Spjd /* zil: */ 693185029Spjd DMU_OT_INTENT_LOG, /* UINT64 */ 694185029Spjd /* dmu: */ 695185029Spjd DMU_OT_DNODE, /* DNODE */ 696185029Spjd DMU_OT_OBJSET, /* OBJSET */ 697185029Spjd /* dsl: */ 698185029Spjd DMU_OT_DSL_DIR, /* UINT64 */ 699185029Spjd DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ 700185029Spjd DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ 701185029Spjd DMU_OT_DSL_PROPS, /* ZAP */ 702185029Spjd DMU_OT_DSL_DATASET, /* UINT64 */ 703185029Spjd /* zpl: */ 704185029Spjd DMU_OT_ZNODE, /* ZNODE */ 705185029Spjd DMU_OT_ACL, /* ACL */ 706185029Spjd DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ 707185029Spjd DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ 708185029Spjd DMU_OT_MASTER_NODE, /* ZAP */ 709185029Spjd DMU_OT_UNLINKED_SET, /* ZAP */ 710185029Spjd /* zvol: */ 711185029Spjd DMU_OT_ZVOL, /* UINT8 */ 712185029Spjd DMU_OT_ZVOL_PROP, /* ZAP */ 713185029Spjd /* other; for testing only! */ 714185029Spjd DMU_OT_PLAIN_OTHER, /* UINT8 */ 715185029Spjd DMU_OT_UINT64_OTHER, /* UINT64 */ 716185029Spjd DMU_OT_ZAP_OTHER, /* ZAP */ 717185029Spjd /* new object types: */ 718185029Spjd DMU_OT_ERROR_LOG, /* ZAP */ 719185029Spjd DMU_OT_SPA_HISTORY, /* UINT8 */ 720185029Spjd DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ 721185029Spjd DMU_OT_POOL_PROPS, /* ZAP */ 722185029Spjd 723185029Spjd DMU_OT_NUMTYPES 724185029Spjd} dmu_object_type_t; 725185029Spjd 726185029Spjdtypedef enum dmu_objset_type { 727185029Spjd DMU_OST_NONE, 728185029Spjd DMU_OST_META, 729185029Spjd DMU_OST_ZFS, 730185029Spjd DMU_OST_ZVOL, 731185029Spjd DMU_OST_OTHER, /* For testing only! */ 732185029Spjd DMU_OST_ANY, /* Be careful! */ 733185029Spjd DMU_OST_NUMTYPES 734185029Spjd} dmu_objset_type_t; 735185029Spjd 736185029Spjd/* 737185029Spjd * Intent log header - this on disk structure holds fields to manage 738185029Spjd * the log. All fields are 64 bit to easily handle cross architectures. 739185029Spjd */ 740185029Spjdtypedef struct zil_header { 741185029Spjd uint64_t zh_claim_txg; /* txg in which log blocks were claimed */ 742185029Spjd uint64_t zh_replay_seq; /* highest replayed sequence number */ 743185029Spjd blkptr_t zh_log; /* log chain */ 744185029Spjd uint64_t zh_claim_seq; /* highest claimed sequence number */ 745185029Spjd uint64_t zh_pad[5]; 746185029Spjd} zil_header_t; 747185029Spjd 748185029Spjdtypedef struct objset_phys { 749185029Spjd dnode_phys_t os_meta_dnode; 750185029Spjd zil_header_t os_zil_header; 751185029Spjd uint64_t os_type; 752185029Spjd char os_pad[1024 - sizeof (dnode_phys_t) - sizeof (zil_header_t) - 753185029Spjd sizeof (uint64_t)]; 754185029Spjd} objset_phys_t; 755185029Spjd 756185029Spjdtypedef struct dsl_dir_phys { 757185029Spjd uint64_t dd_creation_time; /* not actually used */ 758185029Spjd uint64_t dd_head_dataset_obj; 759185029Spjd uint64_t dd_parent_obj; 760185029Spjd uint64_t dd_clone_parent_obj; 761185029Spjd uint64_t dd_child_dir_zapobj; 762185029Spjd /* 763185029Spjd * how much space our children are accounting for; for leaf 764185029Spjd * datasets, == physical space used by fs + snaps 765185029Spjd */ 766185029Spjd uint64_t dd_used_bytes; 767185029Spjd uint64_t dd_compressed_bytes; 768185029Spjd uint64_t dd_uncompressed_bytes; 769185029Spjd /* Administrative quota setting */ 770185029Spjd uint64_t dd_quota; 771185029Spjd /* Administrative reservation setting */ 772185029Spjd uint64_t dd_reserved; 773185029Spjd uint64_t dd_props_zapobj; 774185029Spjd uint64_t dd_pad[21]; /* pad out to 256 bytes for good measure */ 775185029Spjd} dsl_dir_phys_t; 776185029Spjd 777185029Spjdtypedef struct dsl_dataset_phys { 778185029Spjd uint64_t ds_dir_obj; 779185029Spjd uint64_t ds_prev_snap_obj; 780185029Spjd uint64_t ds_prev_snap_txg; 781185029Spjd uint64_t ds_next_snap_obj; 782185029Spjd uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==0 for snaps */ 783185029Spjd uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 784185029Spjd uint64_t ds_creation_time; /* seconds since 1970 */ 785185029Spjd uint64_t ds_creation_txg; 786185029Spjd uint64_t ds_deadlist_obj; 787185029Spjd uint64_t ds_used_bytes; 788185029Spjd uint64_t ds_compressed_bytes; 789185029Spjd uint64_t ds_uncompressed_bytes; 790185029Spjd uint64_t ds_unique_bytes; /* only relevant to snapshots */ 791185029Spjd /* 792185029Spjd * The ds_fsid_guid is a 56-bit ID that can change to avoid 793185029Spjd * collisions. The ds_guid is a 64-bit ID that will never 794185029Spjd * change, so there is a small probability that it will collide. 795185029Spjd */ 796185029Spjd uint64_t ds_fsid_guid; 797185029Spjd uint64_t ds_guid; 798185029Spjd uint64_t ds_flags; 799185029Spjd blkptr_t ds_bp; 800185029Spjd uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 801185029Spjd} dsl_dataset_phys_t; 802185029Spjd 803185029Spjd/* 804185029Spjd * The names of zap entries in the DIRECTORY_OBJECT of the MOS. 805185029Spjd */ 806185029Spjd#define DMU_POOL_DIRECTORY_OBJECT 1 807185029Spjd#define DMU_POOL_CONFIG "config" 808185029Spjd#define DMU_POOL_ROOT_DATASET "root_dataset" 809185029Spjd#define DMU_POOL_SYNC_BPLIST "sync_bplist" 810185029Spjd#define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" 811185029Spjd#define DMU_POOL_ERRLOG_LAST "errlog_last" 812185029Spjd#define DMU_POOL_SPARES "spares" 813185029Spjd#define DMU_POOL_DEFLATE "deflate" 814185029Spjd#define DMU_POOL_HISTORY "history" 815185029Spjd#define DMU_POOL_PROPS "pool_props" 816185029Spjd 817185029Spjd#define ZAP_MAGIC 0x2F52AB2ABULL 818185029Spjd 819185029Spjd#define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_block_shift) 820185029Spjd 821185029Spjd#define ZAP_MAXCD (uint32_t)(-1) 822185029Spjd#define ZAP_HASHBITS 28 823185029Spjd#define MZAP_ENT_LEN 64 824185029Spjd#define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 825185029Spjd#define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT 826185029Spjd#define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT) 827185029Spjd 828185029Spjdtypedef struct mzap_ent_phys { 829185029Spjd uint64_t mze_value; 830185029Spjd uint32_t mze_cd; 831185029Spjd uint16_t mze_pad; /* in case we want to chain them someday */ 832185029Spjd char mze_name[MZAP_NAME_LEN]; 833185029Spjd} mzap_ent_phys_t; 834185029Spjd 835185029Spjdtypedef struct mzap_phys { 836185029Spjd uint64_t mz_block_type; /* ZBT_MICRO */ 837185029Spjd uint64_t mz_salt; 838185029Spjd uint64_t mz_pad[6]; 839185029Spjd mzap_ent_phys_t mz_chunk[1]; 840185029Spjd /* actually variable size depending on block size */ 841185029Spjd} mzap_phys_t; 842185029Spjd 843185029Spjd/* 844185029Spjd * The (fat) zap is stored in one object. It is an array of 845185029Spjd * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 846185029Spjd * 847185029Spjd * ptrtbl fits in first block: 848185029Spjd * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 849185029Spjd * 850185029Spjd * ptrtbl too big for first block: 851185029Spjd * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 852185029Spjd * 853185029Spjd */ 854185029Spjd 855185029Spjd#define ZBT_LEAF ((1ULL << 63) + 0) 856185029Spjd#define ZBT_HEADER ((1ULL << 63) + 1) 857185029Spjd#define ZBT_MICRO ((1ULL << 63) + 3) 858185029Spjd/* any other values are ptrtbl blocks */ 859185029Spjd 860185029Spjd/* 861185029Spjd * the embedded pointer table takes up half a block: 862185029Spjd * block size / entry size (2^3) / 2 863185029Spjd */ 864185029Spjd#define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 865185029Spjd 866185029Spjd/* 867185029Spjd * The embedded pointer table starts half-way through the block. Since 868185029Spjd * the pointer table itself is half the block, it starts at (64-bit) 869185029Spjd * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 870185029Spjd */ 871185029Spjd#define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 872185029Spjd ((uint64_t *)(zap)->zap_phys) \ 873185029Spjd [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 874185029Spjd 875185029Spjd/* 876185029Spjd * TAKE NOTE: 877185029Spjd * If zap_phys_t is modified, zap_byteswap() must be modified. 878185029Spjd */ 879185029Spjdtypedef struct zap_phys { 880185029Spjd uint64_t zap_block_type; /* ZBT_HEADER */ 881185029Spjd uint64_t zap_magic; /* ZAP_MAGIC */ 882185029Spjd 883185029Spjd struct zap_table_phys { 884185029Spjd uint64_t zt_blk; /* starting block number */ 885185029Spjd uint64_t zt_numblks; /* number of blocks */ 886185029Spjd uint64_t zt_shift; /* bits to index it */ 887185029Spjd uint64_t zt_nextblk; /* next (larger) copy start block */ 888185029Spjd uint64_t zt_blks_copied; /* number source blocks copied */ 889185029Spjd } zap_ptrtbl; 890185029Spjd 891185029Spjd uint64_t zap_freeblk; /* the next free block */ 892185029Spjd uint64_t zap_num_leafs; /* number of leafs */ 893185029Spjd uint64_t zap_num_entries; /* number of entries */ 894185029Spjd uint64_t zap_salt; /* salt to stir into hash function */ 895185029Spjd /* 896185029Spjd * This structure is followed by padding, and then the embedded 897185029Spjd * pointer table. The embedded pointer table takes up second 898185029Spjd * half of the block. It is accessed using the 899185029Spjd * ZAP_EMBEDDED_PTRTBL_ENT() macro. 900185029Spjd */ 901185029Spjd} zap_phys_t; 902185029Spjd 903185029Spjdtypedef struct zap_table_phys zap_table_phys_t; 904185029Spjd 905185029Spjdtypedef struct fat_zap { 906185029Spjd int zap_block_shift; /* block size shift */ 907185029Spjd zap_phys_t *zap_phys; 908185029Spjd} fat_zap_t; 909185029Spjd 910185029Spjd#define ZAP_LEAF_MAGIC 0x2AB1EAF 911185029Spjd 912185029Spjd/* chunk size = 24 bytes */ 913185029Spjd#define ZAP_LEAF_CHUNKSIZE 24 914185029Spjd 915185029Spjd/* 916185029Spjd * The amount of space available for chunks is: 917185029Spjd * block size (1<<l->l_bs) - hash entry size (2) * number of hash 918185029Spjd * entries - header space (2*chunksize) 919185029Spjd */ 920185029Spjd#define ZAP_LEAF_NUMCHUNKS(l) \ 921185029Spjd (((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \ 922185029Spjd ZAP_LEAF_CHUNKSIZE - 2) 923185029Spjd 924185029Spjd/* 925185029Spjd * The amount of space within the chunk available for the array is: 926185029Spjd * chunk size - space for type (1) - space for next pointer (2) 927185029Spjd */ 928185029Spjd#define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3) 929185029Spjd 930185029Spjd#define ZAP_LEAF_ARRAY_NCHUNKS(bytes) \ 931185029Spjd (((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES) 932185029Spjd 933185029Spjd/* 934185029Spjd * Low water mark: when there are only this many chunks free, start 935185029Spjd * growing the ptrtbl. Ideally, this should be larger than a 936185029Spjd * "reasonably-sized" entry. 20 chunks is more than enough for the 937185029Spjd * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value), 938185029Spjd * while still being only around 3% for 16k blocks. 939185029Spjd */ 940185029Spjd#define ZAP_LEAF_LOW_WATER (20) 941185029Spjd 942185029Spjd/* 943185029Spjd * The leaf hash table has block size / 2^5 (32) number of entries, 944185029Spjd * which should be more than enough for the maximum number of entries, 945185029Spjd * which is less than block size / CHUNKSIZE (24) / minimum number of 946185029Spjd * chunks per entry (3). 947185029Spjd */ 948185029Spjd#define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5) 949185029Spjd#define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l)) 950185029Spjd 951185029Spjd/* 952185029Spjd * The chunks start immediately after the hash table. The end of the 953185029Spjd * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a 954185029Spjd * chunk_t. 955185029Spjd */ 956185029Spjd#define ZAP_LEAF_CHUNK(l, idx) \ 957185029Spjd ((zap_leaf_chunk_t *) \ 958185029Spjd ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx] 959185029Spjd#define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry) 960185029Spjd 961185029Spjdtypedef enum zap_chunk_type { 962185029Spjd ZAP_CHUNK_FREE = 253, 963185029Spjd ZAP_CHUNK_ENTRY = 252, 964185029Spjd ZAP_CHUNK_ARRAY = 251, 965185029Spjd ZAP_CHUNK_TYPE_MAX = 250 966185029Spjd} zap_chunk_type_t; 967185029Spjd 968185029Spjd/* 969185029Spjd * TAKE NOTE: 970185029Spjd * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 971185029Spjd */ 972185029Spjdtypedef struct zap_leaf_phys { 973185029Spjd struct zap_leaf_header { 974185029Spjd uint64_t lh_block_type; /* ZBT_LEAF */ 975185029Spjd uint64_t lh_pad1; 976185029Spjd uint64_t lh_prefix; /* hash prefix of this leaf */ 977185029Spjd uint32_t lh_magic; /* ZAP_LEAF_MAGIC */ 978185029Spjd uint16_t lh_nfree; /* number free chunks */ 979185029Spjd uint16_t lh_nentries; /* number of entries */ 980185029Spjd uint16_t lh_prefix_len; /* num bits used to id this */ 981185029Spjd 982185029Spjd/* above is accessable to zap, below is zap_leaf private */ 983185029Spjd 984185029Spjd uint16_t lh_freelist; /* chunk head of free list */ 985185029Spjd uint8_t lh_pad2[12]; 986185029Spjd } l_hdr; /* 2 24-byte chunks */ 987185029Spjd 988185029Spjd /* 989185029Spjd * The header is followed by a hash table with 990185029Spjd * ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is 991185029Spjd * followed by an array of ZAP_LEAF_NUMCHUNKS(zap) 992185029Spjd * zap_leaf_chunk structures. These structures are accessed 993185029Spjd * with the ZAP_LEAF_CHUNK() macro. 994185029Spjd */ 995185029Spjd 996185029Spjd uint16_t l_hash[1]; 997185029Spjd} zap_leaf_phys_t; 998185029Spjd 999185029Spjdtypedef union zap_leaf_chunk { 1000185029Spjd struct zap_leaf_entry { 1001185029Spjd uint8_t le_type; /* always ZAP_CHUNK_ENTRY */ 1002185029Spjd uint8_t le_int_size; /* size of ints */ 1003185029Spjd uint16_t le_next; /* next entry in hash chain */ 1004185029Spjd uint16_t le_name_chunk; /* first chunk of the name */ 1005185029Spjd uint16_t le_name_length; /* bytes in name, incl null */ 1006185029Spjd uint16_t le_value_chunk; /* first chunk of the value */ 1007185029Spjd uint16_t le_value_length; /* value length in ints */ 1008185029Spjd uint32_t le_cd; /* collision differentiator */ 1009185029Spjd uint64_t le_hash; /* hash value of the name */ 1010185029Spjd } l_entry; 1011185029Spjd struct zap_leaf_array { 1012185029Spjd uint8_t la_type; /* always ZAP_CHUNK_ARRAY */ 1013185029Spjd uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 1014185029Spjd uint16_t la_next; /* next blk or CHAIN_END */ 1015185029Spjd } l_array; 1016185029Spjd struct zap_leaf_free { 1017185029Spjd uint8_t lf_type; /* always ZAP_CHUNK_FREE */ 1018185029Spjd uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 1019185029Spjd uint16_t lf_next; /* next in free list, or CHAIN_END */ 1020185029Spjd } l_free; 1021185029Spjd} zap_leaf_chunk_t; 1022185029Spjd 1023185029Spjdtypedef struct zap_leaf { 1024185029Spjd int l_bs; /* block size shift */ 1025185029Spjd zap_leaf_phys_t *l_phys; 1026185029Spjd} zap_leaf_t; 1027185029Spjd 1028185029Spjd/* 1029185029Spjd * Define special zfs pflags 1030185029Spjd */ 1031185029Spjd#define ZFS_XATTR 0x1 /* is an extended attribute */ 1032185029Spjd#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ 1033185029Spjd#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ 1034185029Spjd 1035185029Spjd#define MASTER_NODE_OBJ 1 1036185029Spjd 1037185029Spjd/* 1038185029Spjd * special attributes for master node. 1039185029Spjd */ 1040185029Spjd 1041185029Spjd#define ZFS_FSID "FSID" 1042185029Spjd#define ZFS_UNLINKED_SET "DELETE_QUEUE" 1043185029Spjd#define ZFS_ROOT_OBJ "ROOT" 1044185029Spjd#define ZPL_VERSION_OBJ "VERSION" 1045185029Spjd#define ZFS_PROP_BLOCKPERPAGE "BLOCKPERPAGE" 1046185029Spjd#define ZFS_PROP_NOGROWBLOCKS "NOGROWBLOCKS" 1047185029Spjd 1048185029Spjd#define ZFS_FLAG_BLOCKPERPAGE 0x1 1049185029Spjd#define ZFS_FLAG_NOGROWBLOCKS 0x2 1050185029Spjd 1051185029Spjd/* 1052185029Spjd * ZPL version - rev'd whenever an incompatible on-disk format change 1053185029Spjd * occurs. Independent of SPA/DMU/ZAP versioning. 1054185029Spjd */ 1055185029Spjd 1056185029Spjd#define ZPL_VERSION 1ULL 1057185029Spjd 1058185029Spjd/* 1059185029Spjd * The directory entry has the type (currently unused on Solaris) in the 1060185029Spjd * top 4 bits, and the object number in the low 48 bits. The "middle" 1061185029Spjd * 12 bits are unused. 1062185029Spjd */ 1063185029Spjd#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) 1064185029Spjd#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) 1065185029Spjd#define ZFS_DIRENT_MAKE(type, obj) (((uint64_t)type << 60) | obj) 1066185029Spjd 1067185029Spjdtypedef struct ace { 1068185029Spjd uid_t a_who; /* uid or gid */ 1069185029Spjd uint32_t a_access_mask; /* read,write,... */ 1070185029Spjd uint16_t a_flags; /* see below */ 1071185029Spjd uint16_t a_type; /* allow or deny */ 1072185029Spjd} ace_t; 1073185029Spjd 1074185029Spjd#define ACE_SLOT_CNT 6 1075185029Spjd 1076185029Spjdtypedef struct zfs_znode_acl { 1077185029Spjd uint64_t z_acl_extern_obj; /* ext acl pieces */ 1078185029Spjd uint32_t z_acl_count; /* Number of ACEs */ 1079185029Spjd uint16_t z_acl_version; /* acl version */ 1080185029Spjd uint16_t z_acl_pad; /* pad */ 1081185029Spjd ace_t z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */ 1082185029Spjd} zfs_znode_acl_t; 1083185029Spjd 1084185029Spjd/* 1085185029Spjd * This is the persistent portion of the znode. It is stored 1086185029Spjd * in the "bonus buffer" of the file. Short symbolic links 1087185029Spjd * are also stored in the bonus buffer. 1088185029Spjd */ 1089185029Spjdtypedef struct znode_phys { 1090185029Spjd uint64_t zp_atime[2]; /* 0 - last file access time */ 1091185029Spjd uint64_t zp_mtime[2]; /* 16 - last file modification time */ 1092185029Spjd uint64_t zp_ctime[2]; /* 32 - last file change time */ 1093185029Spjd uint64_t zp_crtime[2]; /* 48 - creation time */ 1094185029Spjd uint64_t zp_gen; /* 64 - generation (txg of creation) */ 1095185029Spjd uint64_t zp_mode; /* 72 - file mode bits */ 1096185029Spjd uint64_t zp_size; /* 80 - size of file */ 1097185029Spjd uint64_t zp_parent; /* 88 - directory parent (`..') */ 1098185029Spjd uint64_t zp_links; /* 96 - number of links to file */ 1099185029Spjd uint64_t zp_xattr; /* 104 - DMU object for xattrs */ 1100185029Spjd uint64_t zp_rdev; /* 112 - dev_t for VBLK & VCHR files */ 1101185029Spjd uint64_t zp_flags; /* 120 - persistent flags */ 1102185029Spjd uint64_t zp_uid; /* 128 - file owner */ 1103185029Spjd uint64_t zp_gid; /* 136 - owning group */ 1104185029Spjd uint64_t zp_pad[4]; /* 144 - future */ 1105185029Spjd zfs_znode_acl_t zp_acl; /* 176 - 263 ACL */ 1106185029Spjd /* 1107185029Spjd * Data may pad out any remaining bytes in the znode buffer, eg: 1108185029Spjd * 1109185029Spjd * |<---------------------- dnode_phys (512) ------------------------>| 1110185029Spjd * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->| 1111185029Spjd * |<---- znode (264) ---->|<---- data (56) ---->| 1112185029Spjd * 1113185029Spjd * At present, we only use this space to store symbolic links. 1114185029Spjd */ 1115185029Spjd} znode_phys_t; 1116185029Spjd 1117185029Spjd/* 1118185029Spjd * In-core vdev representation. 1119185029Spjd */ 1120185029Spjdstruct vdev; 1121185029Spjdtypedef int vdev_read_t(struct vdev *vdev, void *priv, off_t offset, void *buf, size_t bytes); 1122185029Spjd 1123185029Spjdtypedef STAILQ_HEAD(vdev_list, vdev) vdev_list_t; 1124185029Spjd 1125185029Spjdtypedef struct vdev { 1126185029Spjd STAILQ_ENTRY(vdev) v_childlink; /* link in parent's child list */ 1127185029Spjd STAILQ_ENTRY(vdev) v_alllink; /* link in global vdev list */ 1128185029Spjd vdev_list_t v_children; /* children of this vdev */ 1129185029Spjd char *v_name; /* vdev name */ 1130185029Spjd uint64_t v_guid; /* vdev guid */ 1131185029Spjd int v_id; /* index in parent */ 1132185029Spjd vdev_state_t v_state; /* current state */ 1133185029Spjd vdev_read_t *v_read; /* function to read from this vdev */ 1134185029Spjd void *v_read_priv; /* private data for read function */ 1135185029Spjd} vdev_t; 1136185029Spjd 1137185029Spjd/* 1138185029Spjd * In-core pool representation. 1139185029Spjd */ 1140185029Spjdtypedef STAILQ_HEAD(spa_list, spa) spa_list_t; 1141185029Spjd 1142185029Spjdtypedef struct spa { 1143185029Spjd STAILQ_ENTRY(spa) spa_link; /* link in global pool list */ 1144185029Spjd char *spa_name; /* pool name */ 1145185029Spjd uint64_t spa_guid; /* pool guid */ 1146185029Spjd uint64_t spa_txg; /* most recent transaction */ 1147185029Spjd struct uberblock spa_uberblock; /* best uberblock so far */ 1148185029Spjd vdev_list_t spa_vdevs; /* list of all toplevel vdevs */ 1149185029Spjd objset_phys_t spa_mos; /* MOS for this pool */ 1150185029Spjd objset_phys_t spa_root_objset; /* current mounted ZPL objset */ 1151185029Spjd} spa_t; 1152