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