sys/cddl/contrib/opensolaris/uts/common/fs/zfs/sys/spa.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2013 by Delphix. All rights reserved.
  24  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
  25  */
  26
  27 #ifndef _SYS_SPA_H
  28 #define _SYS_SPA_H
  29
  30 #include <sys/avl.h>
  31 #include <sys/zfs_context.h>
  32 #include <sys/nvpair.h>
  33 #include <sys/sysmacros.h>
  34 #include <sys/types.h>
  35 #include <sys/fs/zfs.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /*
  42  * Forward references that lots of things need.
  43  */
  44 typedef struct spa spa_t;
  45 typedef struct vdev vdev_t;
  46 typedef struct metaslab metaslab_t;
  47 typedef struct metaslab_group metaslab_group_t;
  48 typedef struct metaslab_class metaslab_class_t;
  49 typedef struct zio zio_t;
  50 typedef struct zilog zilog_t;
  51 typedef struct spa_aux_vdev spa_aux_vdev_t;
  52 typedef struct ddt ddt_t;
  53 typedef struct ddt_entry ddt_entry_t;
  54 struct dsl_pool;
  55 struct dsl_dataset;
  56
  57 /*
  58  * General-purpose 32-bit and 64-bit bitfield encodings.
  59  */
  60 #define BF32_DECODE(x, low, len)        P2PHASE((x) >> (low), 1U << (len))
  61 #define BF64_DECODE(x, low, len)        P2PHASE((x) >> (low), 1ULL << (len))
  62 #define BF32_ENCODE(x, low, len)        (P2PHASE((x), 1U << (len)) << (low))
  63 #define BF64_ENCODE(x, low, len)        (P2PHASE((x), 1ULL << (len)) << (low))
  64
  65 #define BF32_GET(x, low, len)           BF32_DECODE(x, low, len)
  66 #define BF64_GET(x, low, len)           BF64_DECODE(x, low, len)
  67
  68 #define BF32_SET(x, low, len, val) do { \
  69         ASSERT3U(val, <, 1U << (len)); \
  70         ASSERT3U(low + len, <=, 32); \
  71         (x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
  72 _NOTE(CONSTCOND) } while (0)
  73
  74 #define BF64_SET(x, low, len, val) do { \
  75         ASSERT3U(val, <, 1ULL << (len)); \
  76         ASSERT3U(low + len, <=, 64); \
  77         ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
  78 _NOTE(CONSTCOND) } while (0)
  79
  80 #define BF32_GET_SB(x, low, len, shift, bias)   \
  81         ((BF32_GET(x, low, len) + (bias)) << (shift))
  82 #define BF64_GET_SB(x, low, len, shift, bias)   \
  83         ((BF64_GET(x, low, len) + (bias)) << (shift))
  84
  85 #define BF32_SET_SB(x, low, len, shift, bias, val) do { \
  86         ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
  87         ASSERT3S((val) >> (shift), >=, bias); \
  88         BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
  89 _NOTE(CONSTCOND) } while (0)
  90 #define BF64_SET_SB(x, low, len, shift, bias, val) do { \
  91         ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
  92         ASSERT3S((val) >> (shift), >=, bias); \
  93         BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
  94 _NOTE(CONSTCOND) } while (0)
  95
  96 /*
  97  * We currently support nine block sizes, from 512 bytes to 128K.
  98  * We could go higher, but the benefits are near-zero and the cost
  99  * of COWing a giant block to modify one byte would become excessive.
 100  */
 101 #define SPA_MINBLOCKSHIFT       9
 102 #define SPA_MAXBLOCKSHIFT       17
 103 #define SPA_MINBLOCKSIZE        (1ULL << SPA_MINBLOCKSHIFT)
 104 #define SPA_MAXBLOCKSIZE        (1ULL << SPA_MAXBLOCKSHIFT)
 105
 106 #define SPA_BLOCKSIZES          (SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1)
 107
 108 /*
 109  * Maximum supported logical ashift.
 110  *
 111  * The current 8k allocation block size limit is due to the 8k
 112  * aligned/sized operations performed by vdev_probe() on
 113  * vdev_label->vl_pad2.  Using another "safe region" for these tests
 114  * would allow the limit to be raised to 16k, at the expense of
 115  * only having 8 available uberblocks in the label area.
 116  */
 117 #define SPA_MAXASHIFT           13
 118
 119 /*
 120  * Size of block to hold the configuration data (a packed nvlist)
 121  */
 122 #define SPA_CONFIG_BLOCKSIZE    (1ULL << 14)
 123
 124 /*
 125  * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
 126  * The ASIZE encoding should be at least 64 times larger (6 more bits)
 127  * to support up to 4-way RAID-Z mirror mode with worst-case gang block
 128  * overhead, three DVAs per bp, plus one more bit in case we do anything
 129  * else that expands the ASIZE.
 130  */
 131 #define SPA_LSIZEBITS           16      /* LSIZE up to 32M (2^16 * 512) */
 132 #define SPA_PSIZEBITS           16      /* PSIZE up to 32M (2^16 * 512) */
 133 #define SPA_ASIZEBITS           24      /* ASIZE up to 64 times larger  */
 134
 135 /*
 136  * All SPA data is represented by 128-bit data virtual addresses (DVAs).
 137  * The members of the dva_t should be considered opaque outside the SPA.
 138  */
 139 typedef struct dva {
 140         uint64_t        dva_word[2];
 141 } dva_t;
 142
 143 /*
 144  * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
 145  */
 146 typedef struct zio_cksum {
 147         uint64_t        zc_word[4];
 148 } zio_cksum_t;
 149
 150 /*
 151  * Each block is described by its DVAs, time of birth, checksum, etc.
 152  * The word-by-word, bit-by-bit layout of the blkptr is as follows:
 153  *
 154  *      64      56      48      40      32      24      16      8       0
 155  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 156  * 0    |               vdev1           | GRID  |         ASIZE         |
 157  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 158  * 1    |G|                      offset1                                |
 159  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 160  * 2    |               vdev2           | GRID  |         ASIZE         |
 161  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 162  * 3    |G|                      offset2                                |
 163  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 164  * 4    |               vdev3           | GRID  |         ASIZE         |
 165  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 166  * 5    |G|                      offset3                                |
 167  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 168  * 6    |BDX|lvl| type  | cksum | comp  |     PSIZE     |     LSIZE     |
 169  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 170  * 7    |                       padding                                 |
 171  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 172  * 8    |                       padding                                 |
 173  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 174  * 9    |                       physical birth txg                      |
 175  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 176  * a    |                       logical birth txg                       |
 177  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 178  * b    |                       fill count                              |
 179  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 180  * c    |                       checksum[0]                             |
 181  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 182  * d    |                       checksum[1]                             |
 183  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 184  * e    |                       checksum[2]                             |
 185  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 186  * f    |                       checksum[3]                             |
 187  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 188  *
 189  * Legend:
 190  *
 191  * vdev         virtual device ID
 192  * offset       offset into virtual device
 193  * LSIZE        logical size
 194  * PSIZE        physical size (after compression)
 195  * ASIZE        allocated size (including RAID-Z parity and gang block headers)
 196  * GRID         RAID-Z layout information (reserved for future use)
 197  * cksum        checksum function
 198  * comp         compression function
 199  * G            gang block indicator
 200  * B            byteorder (endianness)
 201  * D            dedup
 202  * X            unused
 203  * lvl          level of indirection
 204  * type         DMU object type
 205  * phys birth   txg of block allocation; zero if same as logical birth txg
 206  * log. birth   transaction group in which the block was logically born
 207  * fill count   number of non-zero blocks under this bp
 208  * checksum[4]  256-bit checksum of the data this bp describes
 209  */
 210 #define SPA_BLKPTRSHIFT 7               /* blkptr_t is 128 bytes        */
 211 #define SPA_DVAS_PER_BP 3               /* Number of DVAs in a bp       */
 212
 213 /*
 214  * A block is a hole when it has either 1) never been written to, or
 215  * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
 216  * without physically allocating disk space. Holes are represented in the
 217  * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
 218  * done through the BP_IS_HOLE macro. For holes, the logical size, level,
 219  * DMU object type, and birth times are all also stored for holes that
 220  * were written to at some point (i.e. were punched after having been filled).
 221  */
 222 typedef struct blkptr {
 223         dva_t           blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
 224         uint64_t        blk_prop;       /* size, compression, type, etc     */
 225         uint64_t        blk_pad[2];     /* Extra space for the future       */
 226         uint64_t        blk_phys_birth; /* txg when block was allocated     */
 227         uint64_t        blk_birth;      /* transaction group at birth       */
 228         uint64_t        blk_fill;       /* fill count                       */
 229         zio_cksum_t     blk_cksum;      /* 256-bit checksum                 */
 230 } blkptr_t;
 231
 232 /*
 233  * Macros to get and set fields in a bp or DVA.
 234  */
 235 #define DVA_GET_ASIZE(dva)      \
 236         BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
 237 #define DVA_SET_ASIZE(dva, x)   \
 238         BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
 239         SPA_MINBLOCKSHIFT, 0, x)
 240
 241 #define DVA_GET_GRID(dva)       BF64_GET((dva)->dva_word[0], 24, 8)
 242 #define DVA_SET_GRID(dva, x)    BF64_SET((dva)->dva_word[0], 24, 8, x)
 243
 244 #define DVA_GET_VDEV(dva)       BF64_GET((dva)->dva_word[0], 32, 32)
 245 #define DVA_SET_VDEV(dva, x)    BF64_SET((dva)->dva_word[0], 32, 32, x)
 246
 247 #define DVA_GET_OFFSET(dva)     \
 248         BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
 249 #define DVA_SET_OFFSET(dva, x)  \
 250         BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
 251
 252 #define DVA_GET_GANG(dva)       BF64_GET((dva)->dva_word[1], 63, 1)
 253 #define DVA_SET_GANG(dva, x)    BF64_SET((dva)->dva_word[1], 63, 1, x)
 254
 255 #define BP_GET_LSIZE(bp)        \
 256         BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1)
 257 #define BP_SET_LSIZE(bp, x)     \
 258         BF64_SET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x)
 259
 260 #define BP_GET_PSIZE(bp)        \
 261         BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1)
 262 #define BP_SET_PSIZE(bp, x)     \
 263         BF64_SET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x)
 264
 265 #define BP_GET_COMPRESS(bp)             BF64_GET((bp)->blk_prop, 32, 8)
 266 #define BP_SET_COMPRESS(bp, x)          BF64_SET((bp)->blk_prop, 32, 8, x)
 267
 268 #define BP_GET_CHECKSUM(bp)             BF64_GET((bp)->blk_prop, 40, 8)
 269 #define BP_SET_CHECKSUM(bp, x)          BF64_SET((bp)->blk_prop, 40, 8, x)
 270
 271 #define BP_GET_TYPE(bp)                 BF64_GET((bp)->blk_prop, 48, 8)
 272 #define BP_SET_TYPE(bp, x)              BF64_SET((bp)->blk_prop, 48, 8, x)
 273
 274 #define BP_GET_LEVEL(bp)                BF64_GET((bp)->blk_prop, 56, 5)
 275 #define BP_SET_LEVEL(bp, x)             BF64_SET((bp)->blk_prop, 56, 5, x)
 276
 277 #define BP_GET_PROP_BIT_61(bp)          BF64_GET((bp)->blk_prop, 61, 1)
 278 #define BP_SET_PROP_BIT_61(bp, x)       BF64_SET((bp)->blk_prop, 61, 1, x)
 279
 280 #define BP_GET_DEDUP(bp)                BF64_GET((bp)->blk_prop, 62, 1)
 281 #define BP_SET_DEDUP(bp, x)             BF64_SET((bp)->blk_prop, 62, 1, x)
 282
 283 #define BP_GET_BYTEORDER(bp)            BF64_GET((bp)->blk_prop, 63, 1)
 284 #define BP_SET_BYTEORDER(bp, x)         BF64_SET((bp)->blk_prop, 63, 1, x)
 285
 286 #define BP_PHYSICAL_BIRTH(bp)           \
 287         ((bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
 288
 289 #define BP_SET_BIRTH(bp, logical, physical)     \
 290 {                                               \
 291         (bp)->blk_birth = (logical);            \
 292         (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
 293 }
 294
 295 #define BP_GET_ASIZE(bp)        \
 296         (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
 297                 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
 298
 299 #define BP_GET_UCSIZE(bp) \
 300         ((BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp))) ? \
 301         BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
 302
 303 #define BP_GET_NDVAS(bp)        \
 304         (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
 305         !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
 306         !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
 307
 308 #define BP_COUNT_GANG(bp)       \
 309         (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
 310         DVA_GET_GANG(&(bp)->blk_dva[1]) + \
 311         DVA_GET_GANG(&(bp)->blk_dva[2]))
 312
 313 #define DVA_EQUAL(dva1, dva2)   \
 314         ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
 315         (dva1)->dva_word[0] == (dva2)->dva_word[0])
 316
 317 #define BP_EQUAL(bp1, bp2)      \
 318         (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) &&    \
 319         DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) &&    \
 320         DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) &&    \
 321         DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
 322
 323 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
 324         (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
 325         ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
 326         ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
 327         ((zc1).zc_word[3] - (zc2).zc_word[3])))
 328
 329 #define DVA_IS_VALID(dva)       (DVA_GET_ASIZE(dva) != 0)
 330
 331 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3)   \
 332 {                                               \
 333         (zcp)->zc_word[0] = w0;                 \
 334         (zcp)->zc_word[1] = w1;                 \
 335         (zcp)->zc_word[2] = w2;                 \
 336         (zcp)->zc_word[3] = w3;                 \
 337 }
 338
 339 #define BP_IDENTITY(bp)         (&(bp)->blk_dva[0])
 340 #define BP_IS_GANG(bp)          DVA_GET_GANG(BP_IDENTITY(bp))
 341 #define DVA_IS_EMPTY(dva)       ((dva)->dva_word[0] == 0ULL &&  \
 342                                 (dva)->dva_word[1] == 0ULL)
 343 #define BP_IS_HOLE(bp)          DVA_IS_EMPTY(BP_IDENTITY(bp))
 344
 345 /* BP_IS_RAIDZ(bp) assumes no block compression */
 346 #define BP_IS_RAIDZ(bp)         (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
 347                                 BP_GET_PSIZE(bp))
 348
 349 #define BP_ZERO(bp)                             \
 350 {                                               \
 351         (bp)->blk_dva[0].dva_word[0] = 0;       \
 352         (bp)->blk_dva[0].dva_word[1] = 0;       \
 353         (bp)->blk_dva[1].dva_word[0] = 0;       \
 354         (bp)->blk_dva[1].dva_word[1] = 0;       \
 355         (bp)->blk_dva[2].dva_word[0] = 0;       \
 356         (bp)->blk_dva[2].dva_word[1] = 0;       \
 357         (bp)->blk_prop = 0;                     \
 358         (bp)->blk_pad[0] = 0;                   \
 359         (bp)->blk_pad[1] = 0;                   \
 360         (bp)->blk_phys_birth = 0;               \
 361         (bp)->blk_birth = 0;                    \
 362         (bp)->blk_fill = 0;                     \
 363         ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
 364 }
 365
 366 #if BYTE_ORDER == _BIG_ENDIAN
 367 #define ZFS_HOST_BYTEORDER      (0ULL)
 368 #else
 369 #define ZFS_HOST_BYTEORDER      (1ULL)
 370 #endif
 371
 372 #define BP_SHOULD_BYTESWAP(bp)  (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
 373
 374 #define BP_SPRINTF_LEN  320
 375
 376 /*
 377  * This macro allows code sharing between zfs, libzpool, and mdb.
 378  * 'func' is either snprintf() or mdb_snprintf().
 379  * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
 380  */
 381 #define SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
 382 {                                                                       \
 383         static const char *copyname[] =                                 \
 384             { "zero", "single", "double", "triple" };                   \
 385         int len = 0;                                                    \
 386         int copies = 0;                                                 \
 387                                                                         \
 388         if (bp == NULL) {                                               \
 389                 len += func(buf + len, size - len, "<NULL>");           \
 390         } else if (BP_IS_HOLE(bp)) {                                    \
 391                 len += func(buf + len, size - len, "<hole>");           \
 392                 if (bp->blk_birth > 0) {                                \
 393                         len += func(buf + len, size - len,              \
 394                             " birth=%lluL",                             \
 395                             (u_longlong_t)bp->blk_birth);               \
 396                 }                                                       \
 397         } else {                                                        \
 398                 for (int d = 0; d < BP_GET_NDVAS(bp); d++) {            \
 399                         const dva_t *dva = &bp->blk_dva[d];             \
 400                         if (DVA_IS_VALID(dva))                          \
 401                                 copies++;                               \
 402                         len += func(buf + len, size - len,              \
 403                             "DVA[%d]=<%llu:%llx:%llx>%c", d,            \
 404                             (u_longlong_t)DVA_GET_VDEV(dva),            \
 405                             (u_longlong_t)DVA_GET_OFFSET(dva),          \
 406                             (u_longlong_t)DVA_GET_ASIZE(dva),           \
 407                             ws);                                        \
 408                 }                                                       \
 409                 if (BP_IS_GANG(bp) &&                                   \
 410                     DVA_GET_ASIZE(&bp->blk_dva[2]) <=                   \
 411                     DVA_GET_ASIZE(&bp->blk_dva[1]) / 2)                 \
 412                         copies--;                                       \
 413                 len += func(buf + len, size - len,                      \
 414                     "[L%llu %s] %s %s %s %s %s %s%c"                    \
 415                     "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c"    \
 416                     "cksum=%llx:%llx:%llx:%llx",                        \
 417                     (u_longlong_t)BP_GET_LEVEL(bp),                     \
 418                     type,                                               \
 419                     checksum,                                           \
 420                     compress,                                           \
 421                     BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE",            \
 422                     BP_IS_GANG(bp) ? "gang" : "contiguous",             \
 423                     BP_GET_DEDUP(bp) ? "dedup" : "unique",              \
 424                     copyname[copies],                                   \
 425                     ws,                                                 \
 426                     (u_longlong_t)BP_GET_LSIZE(bp),                     \
 427                     (u_longlong_t)BP_GET_PSIZE(bp),                     \
 428                     (u_longlong_t)bp->blk_birth,                        \
 429                     (u_longlong_t)BP_PHYSICAL_BIRTH(bp),                \
 430                     (u_longlong_t)bp->blk_fill,                         \
 431                     ws,                                                 \
 432                     (u_longlong_t)bp->blk_cksum.zc_word[0],             \
 433                     (u_longlong_t)bp->blk_cksum.zc_word[1],             \
 434                     (u_longlong_t)bp->blk_cksum.zc_word[2],             \
 435                     (u_longlong_t)bp->blk_cksum.zc_word[3]);            \
 436         }                                                               \
 437         ASSERT(len < size);                                             \
 438 }
 439
 440 #include <sys/dmu.h>
 441
 442 #define BP_GET_BUFC_TYPE(bp)                                            \
 443         (((BP_GET_LEVEL(bp) > 0) || (DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))) ? \
 444         ARC_BUFC_METADATA : ARC_BUFC_DATA)
 445
 446 typedef enum spa_import_type {
 447         SPA_IMPORT_EXISTING,
 448         SPA_IMPORT_ASSEMBLE
 449 } spa_import_type_t;
 450
 451 /* state manipulation functions */
 452 extern int spa_open(const char *pool, spa_t **, void *tag);
 453 extern int spa_open_rewind(const char *pool, spa_t **, void *tag,
 454     nvlist_t *policy, nvlist_t **config);
 455 extern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
 456     size_t buflen);
 457 extern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
 458     nvlist_t *zplprops);
 459 #if defined(sun)
 460 extern int spa_import_rootpool(char *devpath, char *devid);
 461 #else
 462 extern int spa_import_rootpool(const char *name);
 463 #endif
 464 extern int spa_import(const char *pool, nvlist_t *config, nvlist_t *props,
 465     uint64_t flags);
 466 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
 467 extern int spa_destroy(char *pool);
 468 extern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
 469     boolean_t hardforce);
 470 extern int spa_reset(char *pool);
 471 extern void spa_async_request(spa_t *spa, int flag);
 472 extern void spa_async_unrequest(spa_t *spa, int flag);
 473 extern void spa_async_suspend(spa_t *spa);
 474 extern void spa_async_resume(spa_t *spa);
 475 extern spa_t *spa_inject_addref(char *pool);
 476 extern void spa_inject_delref(spa_t *spa);
 477 extern void spa_scan_stat_init(spa_t *spa);
 478 extern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
 479
 480 #define SPA_ASYNC_CONFIG_UPDATE 0x01
 481 #define SPA_ASYNC_REMOVE        0x02
 482 #define SPA_ASYNC_PROBE         0x04
 483 #define SPA_ASYNC_RESILVER_DONE 0x08
 484 #define SPA_ASYNC_RESILVER      0x10
 485 #define SPA_ASYNC_AUTOEXPAND    0x20
 486 #define SPA_ASYNC_REMOVE_DONE   0x40
 487 #define SPA_ASYNC_REMOVE_STOP   0x80
 488
 489 /*
 490  * Controls the behavior of spa_vdev_remove().
 491  */
 492 #define SPA_REMOVE_UNSPARE      0x01
 493 #define SPA_REMOVE_DONE         0x02
 494
 495 /* device manipulation */
 496 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
 497 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
 498     int replacing);
 499 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
 500     int replace_done);
 501 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
 502 extern boolean_t spa_vdev_remove_active(spa_t *spa);
 503 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
 504 extern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
 505 extern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
 506     nvlist_t *props, boolean_t exp);
 507
 508 /* spare state (which is global across all pools) */
 509 extern void spa_spare_add(vdev_t *vd);
 510 extern void spa_spare_remove(vdev_t *vd);
 511 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
 512 extern void spa_spare_activate(vdev_t *vd);
 513
 514 /* L2ARC state (which is global across all pools) */
 515 extern void spa_l2cache_add(vdev_t *vd);
 516 extern void spa_l2cache_remove(vdev_t *vd);
 517 extern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
 518 extern void spa_l2cache_activate(vdev_t *vd);
 519 extern void spa_l2cache_drop(spa_t *spa);
 520
 521 /* scanning */
 522 extern int spa_scan(spa_t *spa, pool_scan_func_t func);
 523 extern int spa_scan_stop(spa_t *spa);
 524
 525 /* spa syncing */
 526 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
 527 extern void spa_sync_allpools(void);
 528
 529 /* spa namespace global mutex */
 530 extern kmutex_t spa_namespace_lock;
 531
 532 /*
 533  * SPA configuration functions in spa_config.c
 534  */
 535
 536 #define SPA_CONFIG_UPDATE_POOL  0
 537 #define SPA_CONFIG_UPDATE_VDEVS 1
 538
 539 extern void spa_config_sync(spa_t *, boolean_t, boolean_t);
 540 extern void spa_config_load(void);
 541 extern nvlist_t *spa_all_configs(uint64_t *);
 542 extern void spa_config_set(spa_t *spa, nvlist_t *config);
 543 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
 544     int getstats);
 545 extern void spa_config_update(spa_t *spa, int what);
 546
 547 /*
 548  * Miscellaneous SPA routines in spa_misc.c
 549  */
 550
 551 /* Namespace manipulation */
 552 extern spa_t *spa_lookup(const char *name);
 553 extern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
 554 extern void spa_remove(spa_t *spa);
 555 extern spa_t *spa_next(spa_t *prev);
 556
 557 /* Refcount functions */
 558 extern void spa_open_ref(spa_t *spa, void *tag);
 559 extern void spa_close(spa_t *spa, void *tag);
 560 extern boolean_t spa_refcount_zero(spa_t *spa);
 561
 562 #define SCL_NONE        0x00
 563 #define SCL_CONFIG      0x01
 564 #define SCL_STATE       0x02
 565 #define SCL_L2ARC       0x04            /* hack until L2ARC 2.0 */
 566 #define SCL_ALLOC       0x08
 567 #define SCL_ZIO         0x10
 568 #define SCL_FREE        0x20
 569 #define SCL_VDEV        0x40
 570 #define SCL_LOCKS       7
 571 #define SCL_ALL         ((1 << SCL_LOCKS) - 1)
 572 #define SCL_STATE_ALL   (SCL_STATE | SCL_L2ARC | SCL_ZIO)
 573
 574 /* Pool configuration locks */
 575 extern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
 576 extern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
 577 extern void spa_config_exit(spa_t *spa, int locks, void *tag);
 578 extern int spa_config_held(spa_t *spa, int locks, krw_t rw);
 579
 580 /* Pool vdev add/remove lock */
 581 extern uint64_t spa_vdev_enter(spa_t *spa);
 582 extern uint64_t spa_vdev_config_enter(spa_t *spa);
 583 extern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
 584     int error, char *tag);
 585 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
 586
 587 /* Pool vdev state change lock */
 588 extern void spa_vdev_state_enter(spa_t *spa, int oplock);
 589 extern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
 590
 591 /* Log state */
 592 typedef enum spa_log_state {
 593         SPA_LOG_UNKNOWN = 0,    /* unknown log state */
 594         SPA_LOG_MISSING,        /* missing log(s) */
 595         SPA_LOG_CLEAR,          /* clear the log(s) */
 596         SPA_LOG_GOOD,           /* log(s) are good */
 597 } spa_log_state_t;
 598
 599 extern spa_log_state_t spa_get_log_state(spa_t *spa);
 600 extern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
 601 extern int spa_offline_log(spa_t *spa);
 602
 603 /* Log claim callback */
 604 extern void spa_claim_notify(zio_t *zio);
 605
 606 /* Accessor functions */
 607 extern boolean_t spa_shutting_down(spa_t *spa);
 608 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
 609 extern boolean_t spa_is_initializing(spa_t *spa);
 610 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
 611 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
 612 extern void spa_altroot(spa_t *, char *, size_t);
 613 extern int spa_sync_pass(spa_t *spa);
 614 extern char *spa_name(spa_t *spa);
 615 extern uint64_t spa_guid(spa_t *spa);
 616 extern uint64_t spa_load_guid(spa_t *spa);
 617 extern uint64_t spa_last_synced_txg(spa_t *spa);
 618 extern uint64_t spa_first_txg(spa_t *spa);
 619 extern uint64_t spa_syncing_txg(spa_t *spa);
 620 extern uint64_t spa_version(spa_t *spa);
 621 extern pool_state_t spa_state(spa_t *spa);
 622 extern spa_load_state_t spa_load_state(spa_t *spa);
 623 extern uint64_t spa_freeze_txg(spa_t *spa);
 624 extern uint64_t spa_get_asize(spa_t *spa, uint64_t lsize);
 625 extern uint64_t spa_get_dspace(spa_t *spa);
 626 extern void spa_update_dspace(spa_t *spa);
 627 extern uint64_t spa_version(spa_t *spa);
 628 extern boolean_t spa_deflate(spa_t *spa);
 629 extern metaslab_class_t *spa_normal_class(spa_t *spa);
 630 extern metaslab_class_t *spa_log_class(spa_t *spa);
 631 extern int spa_max_replication(spa_t *spa);
 632 extern int spa_prev_software_version(spa_t *spa);
 633 extern int spa_busy(void);
 634 extern uint8_t spa_get_failmode(spa_t *spa);
 635 extern boolean_t spa_suspended(spa_t *spa);
 636 extern uint64_t spa_bootfs(spa_t *spa);
 637 extern uint64_t spa_delegation(spa_t *spa);
 638 extern objset_t *spa_meta_objset(spa_t *spa);
 639 extern uint64_t spa_deadman_synctime(spa_t *spa);
 640
 641 /* Miscellaneous support routines */
 642 extern void spa_activate_mos_feature(spa_t *spa, const char *feature,
 643     dmu_tx_t *tx);
 644 extern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
 645 extern int spa_rename(const char *oldname, const char *newname);
 646 extern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
 647 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
 648 extern char *spa_strdup(const char *);
 649 extern void spa_strfree(char *);
 650 extern uint64_t spa_get_random(uint64_t range);
 651 extern uint64_t spa_generate_guid(spa_t *spa);
 652 extern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
 653 extern void spa_freeze(spa_t *spa);
 654 extern int spa_change_guid(spa_t *spa);
 655 extern void spa_upgrade(spa_t *spa, uint64_t version);
 656 extern void spa_evict_all(void);
 657 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
 658     boolean_t l2cache);
 659 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
 660 extern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
 661 extern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
 662 extern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
 663 extern boolean_t spa_has_slogs(spa_t *spa);
 664 extern boolean_t spa_is_root(spa_t *spa);
 665 extern boolean_t spa_writeable(spa_t *spa);
 666
 667 extern int spa_mode(spa_t *spa);
 668 extern uint64_t zfs_strtonum(const char *str, char **nptr);
 669 #define strtonum(str, nptr)     zfs_strtonum((str), (nptr))
 670
 671 extern char *spa_his_ievent_table[];
 672
 673 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
 674 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
 675     char *his_buf);
 676 extern int spa_history_log(spa_t *spa, const char *his_buf);
 677 extern int spa_history_log_nvl(spa_t *spa, nvlist_t *nvl);
 678 extern void spa_history_log_version(spa_t *spa, const char *operation);
 679 extern void spa_history_log_internal(spa_t *spa, const char *operation,
 680     dmu_tx_t *tx, const char *fmt, ...);
 681 extern void spa_history_log_internal_ds(struct dsl_dataset *ds, const char *op,
 682     dmu_tx_t *tx, const char *fmt, ...);
 683 extern void spa_history_log_internal_dd(dsl_dir_t *dd, const char *operation,
 684     dmu_tx_t *tx, const char *fmt, ...);
 685
 686 /* error handling */
 687 struct zbookmark;
 688 extern void spa_log_error(spa_t *spa, zio_t *zio);
 689 extern void zfs_ereport_post(const char *cls, spa_t *spa, vdev_t *vd,
 690     zio_t *zio, uint64_t stateoroffset, uint64_t length);
 691 extern void zfs_post_remove(spa_t *spa, vdev_t *vd);
 692 extern void zfs_post_state_change(spa_t *spa, vdev_t *vd);
 693 extern void zfs_post_autoreplace(spa_t *spa, vdev_t *vd);
 694 extern uint64_t spa_get_errlog_size(spa_t *spa);
 695 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
 696 extern void spa_errlog_rotate(spa_t *spa);
 697 extern void spa_errlog_drain(spa_t *spa);
 698 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
 699 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
 700
 701 /* vdev cache */
 702 extern void vdev_cache_stat_init(void);
 703 extern void vdev_cache_stat_fini(void);
 704
 705 /* Initialization and termination */
 706 extern void spa_init(int flags);
 707 extern void spa_fini(void);
 708 extern void spa_boot_init();
 709
 710 /* properties */
 711 extern int spa_prop_set(spa_t *spa, nvlist_t *nvp);
 712 extern int spa_prop_get(spa_t *spa, nvlist_t **nvp);
 713 extern void spa_prop_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
 714 extern void spa_configfile_set(spa_t *, nvlist_t *, boolean_t);
 715
 716 /* asynchronous event notification */
 717 extern void spa_event_notify(spa_t *spa, vdev_t *vdev, const char *name);
 718
 719 #ifdef ZFS_DEBUG
 720 #define dprintf_bp(bp, fmt, ...) do {                           \
 721         if (zfs_flags & ZFS_DEBUG_DPRINTF) {                    \
 722         char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP);  \
 723         snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp));        \
 724         dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf);            \
 725         kmem_free(__blkbuf, BP_SPRINTF_LEN);                    \
 726         } \
 727 _NOTE(CONSTCOND) } while (0)
 728 #else
 729 #define dprintf_bp(bp, fmt, ...)
 730 #endif
 731
 732 extern boolean_t spa_debug_enabled(spa_t *spa);
 733 #define spa_dbgmsg(spa, ...)                    \
 734 {                                               \
 735         if (spa_debug_enabled(spa))             \
 736                 zfs_dbgmsg(__VA_ARGS__);        \
 737 }
 738
 739 extern int spa_mode_global;                     /* mode, e.g. FREAD | FWRITE */
 740
 741 #ifdef  __cplusplus
 742 }
 743 #endif
 744
 745 #endif  /* _SYS_SPA_H */