1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2011, 2020 by Delphix. All rights reserved. 25 * Copyright (c) 2017, Intel Corporation. 26 * Copyright (c) 2023, Klara Inc. 27 */ 28 29 #ifndef _SYS_VDEV_IMPL_H 30 #define _SYS_VDEV_IMPL_H 31 32 #include <sys/avl.h> 33 #include <sys/bpobj.h> 34 #include <sys/dmu.h> 35 #include <sys/metaslab.h> 36 #include <sys/nvpair.h> 37 #include <sys/space_map.h> 38 #include <sys/vdev.h> 39 #include <sys/uberblock_impl.h> 40 #include <sys/vdev_indirect_mapping.h> 41 #include <sys/vdev_indirect_births.h> 42 #include <sys/vdev_rebuild.h> 43 #include <sys/vdev_removal.h> 44 #include <sys/zfs_ratelimit.h> 45 46 #ifdef __cplusplus 47 extern "C" { 48 #endif 49 50 /* 51 * Virtual device descriptors. 52 * 53 * All storage pool operations go through the virtual device framework, 54 * which provides data replication and I/O scheduling. 55 */ 56 57 /* 58 * Forward declarations that lots of things need. 59 */ 60 typedef struct vdev_queue vdev_queue_t; 61 struct abd; 62 63 /* 64 * Virtual device operations 65 */ 66 typedef int vdev_init_func_t(spa_t *spa, nvlist_t *nv, void **tsd); 67 typedef void vdev_kobj_post_evt_func_t(vdev_t *vd); 68 typedef void vdev_fini_func_t(vdev_t *vd); 69 typedef int vdev_open_func_t(vdev_t *vd, uint64_t *size, uint64_t *max_size, 70 uint64_t *ashift, uint64_t *pshift); 71 typedef void vdev_close_func_t(vdev_t *vd); 72 typedef uint64_t vdev_asize_func_t(vdev_t *vd, uint64_t psize, uint64_t txg); 73 typedef uint64_t vdev_min_asize_func_t(vdev_t *vd); 74 typedef uint64_t vdev_min_alloc_func_t(vdev_t *vd); 75 typedef void vdev_io_start_func_t(zio_t *zio); 76 typedef void vdev_io_done_func_t(zio_t *zio); 77 typedef void vdev_state_change_func_t(vdev_t *vd, int, int); 78 typedef boolean_t vdev_need_resilver_func_t(vdev_t *vd, const dva_t *dva, 79 size_t psize, uint64_t phys_birth); 80 typedef void vdev_hold_func_t(vdev_t *vd); 81 typedef void vdev_rele_func_t(vdev_t *vd); 82 83 typedef void vdev_remap_cb_t(uint64_t inner_offset, vdev_t *vd, 84 uint64_t offset, uint64_t size, void *arg); 85 typedef void vdev_remap_func_t(vdev_t *vd, uint64_t offset, uint64_t size, 86 vdev_remap_cb_t callback, void *arg); 87 /* 88 * Given a target vdev, translates the logical range "in" to the physical 89 * range "res" 90 */ 91 typedef void vdev_xlation_func_t(vdev_t *cvd, const zfs_range_seg64_t *logical, 92 zfs_range_seg64_t *physical, zfs_range_seg64_t *remain); 93 typedef uint64_t vdev_rebuild_asize_func_t(vdev_t *vd, uint64_t start, 94 uint64_t size, uint64_t max_segment); 95 typedef void vdev_metaslab_init_func_t(vdev_t *vd, uint64_t *startp, 96 uint64_t *sizep); 97 typedef void vdev_config_generate_func_t(vdev_t *vd, nvlist_t *nv); 98 typedef uint64_t vdev_nparity_func_t(vdev_t *vd); 99 typedef uint64_t vdev_ndisks_func_t(vdev_t *vd); 100 101 typedef const struct vdev_ops { 102 vdev_init_func_t *vdev_op_init; 103 vdev_fini_func_t *vdev_op_fini; 104 vdev_open_func_t *vdev_op_open; 105 vdev_close_func_t *vdev_op_close; 106 vdev_asize_func_t *vdev_op_asize; 107 vdev_min_asize_func_t *vdev_op_min_asize; 108 vdev_min_alloc_func_t *vdev_op_min_alloc; 109 vdev_io_start_func_t *vdev_op_io_start; 110 vdev_io_done_func_t *vdev_op_io_done; 111 vdev_state_change_func_t *vdev_op_state_change; 112 vdev_need_resilver_func_t *vdev_op_need_resilver; 113 vdev_hold_func_t *vdev_op_hold; 114 vdev_rele_func_t *vdev_op_rele; 115 vdev_remap_func_t *vdev_op_remap; 116 vdev_xlation_func_t *vdev_op_xlate; 117 vdev_rebuild_asize_func_t *vdev_op_rebuild_asize; 118 vdev_metaslab_init_func_t *vdev_op_metaslab_init; 119 vdev_config_generate_func_t *vdev_op_config_generate; 120 vdev_nparity_func_t *vdev_op_nparity; 121 vdev_ndisks_func_t *vdev_op_ndisks; 122 vdev_kobj_post_evt_func_t *vdev_op_kobj_evt_post; 123 char vdev_op_type[16]; 124 boolean_t vdev_op_leaf; 125 } vdev_ops_t; 126 127 /* 128 * Virtual device properties 129 */ 130 typedef union vdev_queue_class { 131 struct { 132 ulong_t vqc_list_numnodes; 133 list_t vqc_list; 134 }; 135 avl_tree_t vqc_tree; 136 } vdev_queue_class_t; 137 138 struct vdev_queue { 139 vdev_t *vq_vdev; 140 vdev_queue_class_t vq_class[ZIO_PRIORITY_NUM_QUEUEABLE]; 141 avl_tree_t vq_read_offset_tree; 142 avl_tree_t vq_write_offset_tree; 143 uint64_t vq_last_offset; 144 zio_priority_t vq_last_prio; /* Last sent I/O priority. */ 145 uint32_t vq_cqueued; /* Classes with queued I/Os. */ 146 uint32_t vq_cactive[ZIO_PRIORITY_NUM_QUEUEABLE]; 147 uint32_t vq_active; /* Number of active I/Os. */ 148 uint32_t vq_ia_active; /* Active interactive I/Os. */ 149 uint32_t vq_nia_credit; /* Non-interactive I/Os credit. */ 150 list_t vq_active_list; /* List of active I/Os. */ 151 hrtime_t vq_io_complete_ts; /* time last i/o completed */ 152 hrtime_t vq_io_delta_ts; 153 zio_t vq_io_search; /* used as local for stack reduction */ 154 kmutex_t vq_lock; 155 }; 156 157 typedef enum vdev_alloc_bias { 158 VDEV_BIAS_NONE, 159 VDEV_BIAS_LOG, /* dedicated to ZIL data (SLOG) */ 160 VDEV_BIAS_SPECIAL, /* dedicated to ddt, metadata, and small blks */ 161 VDEV_BIAS_DEDUP /* dedicated to dedup metadata */ 162 } vdev_alloc_bias_t; 163 164 165 /* 166 * On-disk indirect vdev state. 167 * 168 * An indirect vdev is described exclusively in the MOS config of a pool. 169 * The config for an indirect vdev includes several fields, which are 170 * accessed in memory by a vdev_indirect_config_t. 171 */ 172 typedef struct vdev_indirect_config { 173 /* 174 * Object (in MOS) which contains the indirect mapping. This object 175 * contains an array of vdev_indirect_mapping_entry_phys_t ordered by 176 * vimep_src. The bonus buffer for this object is a 177 * vdev_indirect_mapping_phys_t. This object is allocated when a vdev 178 * removal is initiated. 179 * 180 * Note that this object can be empty if none of the data on the vdev 181 * has been copied yet. 182 */ 183 uint64_t vic_mapping_object; 184 185 /* 186 * Object (in MOS) which contains the birth times for the mapping 187 * entries. This object contains an array of 188 * vdev_indirect_birth_entry_phys_t sorted by vibe_offset. The bonus 189 * buffer for this object is a vdev_indirect_birth_phys_t. This object 190 * is allocated when a vdev removal is initiated. 191 * 192 * Note that this object can be empty if none of the vdev has yet been 193 * copied. 194 */ 195 uint64_t vic_births_object; 196 197 /* 198 * This is the vdev ID which was removed previous to this vdev, or 199 * UINT64_MAX if there are no previously removed vdevs. 200 */ 201 uint64_t vic_prev_indirect_vdev; 202 } vdev_indirect_config_t; 203 204 /* 205 * Virtual device descriptor 206 */ 207 struct vdev { 208 /* 209 * Common to all vdev types. 210 */ 211 uint64_t vdev_id; /* child number in vdev parent */ 212 uint64_t vdev_guid; /* unique ID for this vdev */ 213 uint64_t vdev_guid_sum; /* self guid + all child guids */ 214 uint64_t vdev_orig_guid; /* orig. guid prior to remove */ 215 uint64_t vdev_asize; /* allocatable device capacity */ 216 uint64_t vdev_min_asize; /* min acceptable asize */ 217 uint64_t vdev_max_asize; /* max acceptable asize */ 218 uint64_t vdev_ashift; /* block alignment shift */ 219 220 /* 221 * Logical block alignment shift 222 * 223 * The smallest sized/aligned I/O supported by the device. 224 */ 225 uint64_t vdev_logical_ashift; 226 /* 227 * Physical block alignment shift 228 * 229 * The device supports logical I/Os with vdev_logical_ashift 230 * size/alignment, but optimum performance will be achieved by 231 * aligning/sizing requests to vdev_physical_ashift. Smaller 232 * requests may be inflated or incur device level read-modify-write 233 * operations. 234 * 235 * May be 0 to indicate no preference (i.e. use vdev_logical_ashift). 236 */ 237 uint64_t vdev_physical_ashift; 238 uint64_t vdev_state; /* see VDEV_STATE_* #defines */ 239 uint64_t vdev_prevstate; /* used when reopening a vdev */ 240 vdev_ops_t *vdev_ops; /* vdev operations */ 241 spa_t *vdev_spa; /* spa for this vdev */ 242 void *vdev_tsd; /* type-specific data */ 243 vdev_t *vdev_top; /* top-level vdev */ 244 vdev_t *vdev_parent; /* parent vdev */ 245 vdev_t **vdev_child; /* array of children */ 246 uint64_t vdev_children; /* number of children */ 247 vdev_stat_t vdev_stat; /* virtual device statistics */ 248 vdev_stat_ex_t vdev_stat_ex; /* extended statistics */ 249 boolean_t vdev_expanding; /* expand the vdev? */ 250 boolean_t vdev_reopening; /* reopen in progress? */ 251 boolean_t vdev_nonrot; /* true if solid state */ 252 int vdev_load_error; /* error on last load */ 253 int vdev_open_error; /* error on last open */ 254 int vdev_validate_error; /* error on last validate */ 255 kthread_t *vdev_open_thread; /* thread opening children */ 256 kthread_t *vdev_validate_thread; /* thread validating children */ 257 uint64_t vdev_crtxg; /* txg when top-level was added */ 258 uint64_t vdev_root_zap; 259 260 /* 261 * Top-level vdev state. 262 */ 263 uint64_t vdev_ms_array; /* metaslab array object */ 264 uint64_t vdev_ms_shift; /* metaslab size shift */ 265 uint64_t vdev_ms_count; /* number of metaslabs */ 266 metaslab_group_t *vdev_mg; /* metaslab group */ 267 metaslab_group_t *vdev_log_mg; /* embedded slog metaslab group */ 268 metaslab_t **vdev_ms; /* metaslab array */ 269 txg_list_t vdev_ms_list; /* per-txg dirty metaslab lists */ 270 txg_list_t vdev_dtl_list; /* per-txg dirty DTL lists */ 271 txg_node_t vdev_txg_node; /* per-txg dirty vdev linkage */ 272 boolean_t vdev_remove_wanted; /* async remove wanted? */ 273 boolean_t vdev_fault_wanted; /* async faulted wanted? */ 274 list_node_t vdev_config_dirty_node; /* config dirty list */ 275 list_node_t vdev_state_dirty_node; /* state dirty list */ 276 uint64_t vdev_deflate_ratio; /* deflation ratio (x512) */ 277 uint64_t vdev_islog; /* is an intent log device */ 278 uint64_t vdev_noalloc; /* device is passivated? */ 279 uint64_t vdev_removing; /* device is being removed? */ 280 uint64_t vdev_failfast; /* device failfast setting */ 281 boolean_t vdev_rz_expanding; /* raidz is being expanded? */ 282 boolean_t vdev_ishole; /* is a hole in the namespace */ 283 uint64_t vdev_top_zap; 284 vdev_alloc_bias_t vdev_alloc_bias; /* metaslab allocation bias */ 285 286 /* pool checkpoint related */ 287 space_map_t *vdev_checkpoint_sm; /* contains reserved blocks */ 288 289 /* Initialize related */ 290 boolean_t vdev_initialize_exit_wanted; 291 vdev_initializing_state_t vdev_initialize_state; 292 list_node_t vdev_initialize_node; 293 kthread_t *vdev_initialize_thread; 294 /* Protects vdev_initialize_thread and vdev_initialize_state. */ 295 kmutex_t vdev_initialize_lock; 296 kcondvar_t vdev_initialize_cv; 297 uint64_t vdev_initialize_offset[TXG_SIZE]; 298 uint64_t vdev_initialize_last_offset; 299 /* valid while initializing */ 300 zfs_range_tree_t *vdev_initialize_tree; 301 uint64_t vdev_initialize_bytes_est; 302 uint64_t vdev_initialize_bytes_done; 303 uint64_t vdev_initialize_action_time; /* start and end time */ 304 305 /* TRIM related */ 306 boolean_t vdev_trim_exit_wanted; 307 boolean_t vdev_autotrim_exit_wanted; 308 vdev_trim_state_t vdev_trim_state; 309 list_node_t vdev_trim_node; 310 kmutex_t vdev_autotrim_lock; 311 kcondvar_t vdev_autotrim_cv; 312 kcondvar_t vdev_autotrim_kick_cv; 313 kthread_t *vdev_autotrim_thread; 314 /* Protects vdev_trim_thread and vdev_trim_state. */ 315 kmutex_t vdev_trim_lock; 316 kcondvar_t vdev_trim_cv; 317 kthread_t *vdev_trim_thread; 318 uint64_t vdev_trim_offset[TXG_SIZE]; 319 uint64_t vdev_trim_last_offset; 320 uint64_t vdev_trim_bytes_est; 321 uint64_t vdev_trim_bytes_done; 322 uint64_t vdev_trim_rate; /* requested rate (bytes/sec) */ 323 uint64_t vdev_trim_partial; /* requested partial TRIM */ 324 uint64_t vdev_trim_secure; /* requested secure TRIM */ 325 uint64_t vdev_trim_action_time; /* start and end time */ 326 327 /* Rebuild related */ 328 boolean_t vdev_rebuilding; 329 boolean_t vdev_rebuild_exit_wanted; 330 boolean_t vdev_rebuild_cancel_wanted; 331 boolean_t vdev_rebuild_reset_wanted; 332 kmutex_t vdev_rebuild_lock; 333 kcondvar_t vdev_rebuild_cv; 334 kthread_t *vdev_rebuild_thread; 335 vdev_rebuild_t vdev_rebuild_config; 336 337 /* For limiting outstanding I/Os (initialize, TRIM) */ 338 kmutex_t vdev_initialize_io_lock; 339 kcondvar_t vdev_initialize_io_cv; 340 uint64_t vdev_initialize_inflight; 341 kmutex_t vdev_trim_io_lock; 342 kcondvar_t vdev_trim_io_cv; 343 uint64_t vdev_trim_inflight[3]; 344 345 /* 346 * Values stored in the config for an indirect or removing vdev. 347 */ 348 vdev_indirect_config_t vdev_indirect_config; 349 350 /* 351 * The vdev_indirect_rwlock protects the vdev_indirect_mapping 352 * pointer from changing on indirect vdevs (when it is condensed). 353 * Note that removing (not yet indirect) vdevs have different 354 * access patterns (the mapping is not accessed from open context, 355 * e.g. from zio_read) and locking strategy (e.g. svr_lock). 356 */ 357 krwlock_t vdev_indirect_rwlock; 358 vdev_indirect_mapping_t *vdev_indirect_mapping; 359 vdev_indirect_births_t *vdev_indirect_births; 360 361 /* 362 * In memory data structures used to manage the obsolete sm, for 363 * indirect or removing vdevs. 364 * 365 * The vdev_obsolete_segments is the in-core record of the segments 366 * that are no longer referenced anywhere in the pool (due to 367 * being freed or remapped and not referenced by any snapshots). 368 * During a sync, segments are added to vdev_obsolete_segments 369 * via vdev_indirect_mark_obsolete(); at the end of each sync 370 * pass, this is appended to vdev_obsolete_sm via 371 * vdev_indirect_sync_obsolete(). The vdev_obsolete_lock 372 * protects against concurrent modifications of vdev_obsolete_segments 373 * from multiple zio threads. 374 */ 375 kmutex_t vdev_obsolete_lock; 376 zfs_range_tree_t *vdev_obsolete_segments; 377 space_map_t *vdev_obsolete_sm; 378 379 /* 380 * Protects the vdev_scan_io_queue field itself as well as the 381 * structure's contents (when present). 382 */ 383 kmutex_t vdev_scan_io_queue_lock; 384 struct dsl_scan_io_queue *vdev_scan_io_queue; 385 386 /* 387 * Leaf vdev state. 388 */ 389 zfs_range_tree_t *vdev_dtl[DTL_TYPES]; /* dirty time logs */ 390 space_map_t *vdev_dtl_sm; /* dirty time log space map */ 391 txg_node_t vdev_dtl_node; /* per-txg dirty DTL linkage */ 392 uint64_t vdev_dtl_object; /* DTL object */ 393 uint64_t vdev_psize; /* physical device capacity */ 394 uint64_t vdev_wholedisk; /* true if this is a whole disk */ 395 uint64_t vdev_offline; /* persistent offline state */ 396 uint64_t vdev_faulted; /* persistent faulted state */ 397 uint64_t vdev_degraded; /* persistent degraded state */ 398 uint64_t vdev_removed; /* persistent removed state */ 399 uint64_t vdev_resilver_txg; /* persistent resilvering state */ 400 uint64_t vdev_rebuild_txg; /* persistent rebuilding state */ 401 char *vdev_path; /* vdev path (if any) */ 402 char *vdev_devid; /* vdev devid (if any) */ 403 char *vdev_physpath; /* vdev device path (if any) */ 404 char *vdev_enc_sysfs_path; /* enclosure sysfs path */ 405 char *vdev_fru; /* physical FRU location */ 406 uint64_t vdev_not_present; /* not present during import */ 407 uint64_t vdev_unspare; /* unspare when resilvering done */ 408 boolean_t vdev_nowritecache; /* true if flushwritecache failed */ 409 boolean_t vdev_has_trim; /* TRIM is supported */ 410 boolean_t vdev_has_securetrim; /* secure TRIM is supported */ 411 boolean_t vdev_checkremove; /* temporary online test */ 412 boolean_t vdev_forcefault; /* force online fault */ 413 boolean_t vdev_splitting; /* split or repair in progress */ 414 boolean_t vdev_delayed_close; /* delayed device close? */ 415 boolean_t vdev_tmpoffline; /* device taken offline temporarily? */ 416 boolean_t vdev_detached; /* device detached? */ 417 boolean_t vdev_cant_read; /* vdev is failing all reads */ 418 boolean_t vdev_cant_write; /* vdev is failing all writes */ 419 boolean_t vdev_isspare; /* was a hot spare */ 420 boolean_t vdev_isl2cache; /* was a l2cache device */ 421 boolean_t vdev_copy_uberblocks; /* post expand copy uberblocks */ 422 boolean_t vdev_resilver_deferred; /* resilver deferred */ 423 boolean_t vdev_kobj_flag; /* kobj event record */ 424 boolean_t vdev_attaching; /* vdev attach ashift handling */ 425 vdev_queue_t vdev_queue; /* I/O deadline schedule queue */ 426 spa_aux_vdev_t *vdev_aux; /* for l2cache and spares vdevs */ 427 zio_t *vdev_probe_zio; /* root of current probe */ 428 vdev_aux_t vdev_label_aux; /* on-disk aux state */ 429 uint64_t vdev_leaf_zap; 430 hrtime_t vdev_mmp_pending; /* 0 if write finished */ 431 uint64_t vdev_mmp_kstat_id; /* to find kstat entry */ 432 uint64_t vdev_expansion_time; /* vdev's last expansion time */ 433 list_node_t vdev_leaf_node; /* leaf vdev list */ 434 435 /* 436 * For DTrace to work in userland (libzpool) context, these fields must 437 * remain at the end of the structure. DTrace will use the kernel's 438 * CTF definition for 'struct vdev', and since the size of a kmutex_t is 439 * larger in userland, the offsets for the rest of the fields would be 440 * incorrect. 441 */ 442 kmutex_t vdev_dtl_lock; /* vdev_dtl_{map,resilver} */ 443 kmutex_t vdev_stat_lock; /* vdev_stat */ 444 kmutex_t vdev_probe_lock; /* protects vdev_probe_zio */ 445 446 /* 447 * We rate limit ZIO delay, deadman, and checksum events, since they 448 * can flood ZED with tons of events when a drive is acting up. 449 * 450 * We also rate limit Direct I/O write verify errors, since a user might 451 * be continually manipulating a buffer that can flood ZED with tons of 452 * events. 453 */ 454 zfs_ratelimit_t vdev_delay_rl; 455 zfs_ratelimit_t vdev_deadman_rl; 456 zfs_ratelimit_t vdev_dio_verify_rl; 457 zfs_ratelimit_t vdev_checksum_rl; 458 459 /* 460 * Vdev properties for tuning ZED or zfsd 461 */ 462 uint64_t vdev_checksum_n; 463 uint64_t vdev_checksum_t; 464 uint64_t vdev_io_n; 465 uint64_t vdev_io_t; 466 uint64_t vdev_slow_io_n; 467 uint64_t vdev_slow_io_t; 468 }; 469 470 #define VDEV_PAD_SIZE (8 << 10) 471 /* 2 padding areas (vl_pad1 and vl_be) to skip */ 472 #define VDEV_SKIP_SIZE VDEV_PAD_SIZE * 2 473 #define VDEV_PHYS_SIZE (112 << 10) 474 #define VDEV_UBERBLOCK_RING (128 << 10) 475 476 /* 477 * MMP blocks occupy the last MMP_BLOCKS_PER_LABEL slots in the uberblock 478 * ring when MMP is enabled. 479 */ 480 #define MMP_BLOCKS_PER_LABEL 1 481 482 /* The largest uberblock we support is 8k. */ 483 #define MAX_UBERBLOCK_SHIFT (13) 484 #define VDEV_UBERBLOCK_SHIFT(vd) \ 485 MIN(MAX((vd)->vdev_top->vdev_ashift, UBERBLOCK_SHIFT), \ 486 MAX_UBERBLOCK_SHIFT) 487 #define VDEV_UBERBLOCK_COUNT(vd) \ 488 (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd)) 489 #define VDEV_UBERBLOCK_OFFSET(vd, n) \ 490 offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)]) 491 #define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd)) 492 493 typedef struct vdev_phys { 494 char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_eck_t)]; 495 zio_eck_t vp_zbt; 496 } vdev_phys_t; 497 498 typedef enum vbe_vers { 499 /* 500 * The bootenv file is stored as ascii text in the envblock. 501 * It is used by the GRUB bootloader used on Linux to store the 502 * contents of the grubenv file. The file is stored as raw ASCII, 503 * and is protected by an embedded checksum. By default, GRUB will 504 * check if the boot filesystem supports storing the environment data 505 * in a special location, and if so, will invoke filesystem specific 506 * logic to retrieve it. This can be overridden by a variable, should 507 * the user so desire. 508 */ 509 VB_RAW = 0, 510 511 /* 512 * The bootenv file is converted to an nvlist and then packed into the 513 * envblock. 514 */ 515 VB_NVLIST = 1 516 } vbe_vers_t; 517 518 typedef struct vdev_boot_envblock { 519 uint64_t vbe_version; 520 char vbe_bootenv[VDEV_PAD_SIZE - sizeof (uint64_t) - 521 sizeof (zio_eck_t)]; 522 zio_eck_t vbe_zbt; 523 } vdev_boot_envblock_t; 524 _Static_assert(sizeof (vdev_boot_envblock_t) == VDEV_PAD_SIZE, 525 "vdev_boot_envblock_t wrong size"); 526 527 typedef struct vdev_label { 528 char vl_pad1[VDEV_PAD_SIZE]; /* 8K */ 529 vdev_boot_envblock_t vl_be; /* 8K */ 530 vdev_phys_t vl_vdev_phys; /* 112K */ 531 char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */ 532 } vdev_label_t; /* 256K total */ 533 534 /* 535 * vdev_dirty() flags 536 */ 537 #define VDD_METASLAB 0x01 538 #define VDD_DTL 0x02 539 540 /* Offset of embedded boot loader region on each label */ 541 #define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 542 /* 543 * Size of embedded boot loader region on each label. 544 * The total size of the first two labels plus the boot area is 4MB. 545 * On RAIDZ, this space is overwritten during RAIDZ expansion. 546 */ 547 #define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 548 549 /* 550 * Size of label regions at the start and end of each leaf device. 551 */ 552 #define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 553 #define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 554 #define VDEV_LABELS 4 555 #define VDEV_BEST_LABEL VDEV_LABELS 556 #define VDEV_OFFSET_IS_LABEL(vd, off) \ 557 (((off) < VDEV_LABEL_START_SIZE) || \ 558 ((off) >= ((vd)->vdev_psize - VDEV_LABEL_END_SIZE))) 559 560 #define VDEV_ALLOC_LOAD 0 561 #define VDEV_ALLOC_ADD 1 562 #define VDEV_ALLOC_SPARE 2 563 #define VDEV_ALLOC_L2CACHE 3 564 #define VDEV_ALLOC_ROOTPOOL 4 565 #define VDEV_ALLOC_SPLIT 5 566 #define VDEV_ALLOC_ATTACH 6 567 568 /* 569 * Allocate or free a vdev 570 */ 571 extern vdev_t *vdev_alloc_common(spa_t *spa, uint_t id, uint64_t guid, 572 vdev_ops_t *ops); 573 extern int vdev_alloc(spa_t *spa, vdev_t **vdp, nvlist_t *config, 574 vdev_t *parent, uint_t id, int alloctype); 575 extern void vdev_free(vdev_t *vd); 576 577 /* 578 * Add or remove children and parents 579 */ 580 extern void vdev_add_child(vdev_t *pvd, vdev_t *cvd); 581 extern void vdev_remove_child(vdev_t *pvd, vdev_t *cvd); 582 extern void vdev_compact_children(vdev_t *pvd); 583 extern vdev_t *vdev_add_parent(vdev_t *cvd, vdev_ops_t *ops); 584 extern void vdev_remove_parent(vdev_t *cvd); 585 586 /* 587 * vdev sync load and sync 588 */ 589 extern boolean_t vdev_log_state_valid(vdev_t *vd); 590 extern int vdev_load(vdev_t *vd); 591 extern int vdev_dtl_load(vdev_t *vd); 592 extern void vdev_sync(vdev_t *vd, uint64_t txg); 593 extern void vdev_sync_done(vdev_t *vd, uint64_t txg); 594 extern void vdev_dirty(vdev_t *vd, int flags, void *arg, uint64_t txg); 595 extern void vdev_dirty_leaves(vdev_t *vd, int flags, uint64_t txg); 596 597 /* 598 * Available vdev types. 599 */ 600 extern vdev_ops_t vdev_root_ops; 601 extern vdev_ops_t vdev_mirror_ops; 602 extern vdev_ops_t vdev_replacing_ops; 603 extern vdev_ops_t vdev_raidz_ops; 604 extern vdev_ops_t vdev_draid_ops; 605 extern vdev_ops_t vdev_draid_spare_ops; 606 extern vdev_ops_t vdev_disk_ops; 607 extern vdev_ops_t vdev_file_ops; 608 extern vdev_ops_t vdev_missing_ops; 609 extern vdev_ops_t vdev_hole_ops; 610 extern vdev_ops_t vdev_spare_ops; 611 extern vdev_ops_t vdev_indirect_ops; 612 613 /* 614 * Common size functions 615 */ 616 extern void vdev_default_xlate(vdev_t *vd, const zfs_range_seg64_t *logical_rs, 617 zfs_range_seg64_t *physical_rs, zfs_range_seg64_t *remain_rs); 618 extern uint64_t vdev_default_asize(vdev_t *vd, uint64_t psize, uint64_t txg); 619 extern uint64_t vdev_default_min_asize(vdev_t *vd); 620 extern uint64_t vdev_get_min_asize(vdev_t *vd); 621 extern void vdev_set_min_asize(vdev_t *vd); 622 extern uint64_t vdev_get_min_alloc(vdev_t *vd); 623 extern uint64_t vdev_get_nparity(vdev_t *vd); 624 extern uint64_t vdev_get_ndisks(vdev_t *vd); 625 626 /* 627 * Global variables 628 */ 629 extern int zfs_vdev_standard_sm_blksz; 630 631 /* 632 * Functions from vdev_indirect.c 633 */ 634 extern void vdev_indirect_sync_obsolete(vdev_t *vd, dmu_tx_t *tx); 635 extern boolean_t vdev_indirect_should_condense(vdev_t *vd); 636 extern void spa_condense_indirect_start_sync(vdev_t *vd, dmu_tx_t *tx); 637 extern int vdev_obsolete_sm_object(vdev_t *vd, uint64_t *sm_obj); 638 extern int vdev_obsolete_counts_are_precise(vdev_t *vd, boolean_t *are_precise); 639 640 /* 641 * Other miscellaneous functions 642 */ 643 int vdev_checkpoint_sm_object(vdev_t *vd, uint64_t *sm_obj); 644 void vdev_metaslab_group_create(vdev_t *vd); 645 uint64_t vdev_best_ashift(uint64_t logical, uint64_t a, uint64_t b); 646 #if defined(__linux__) 647 int param_get_raidz_impl(char *buf, zfs_kernel_param_t *kp); 648 #endif 649 int param_set_raidz_impl(ZFS_MODULE_PARAM_ARGS); 650 651 /* 652 * Vdev ashift optimization tunables 653 */ 654 extern uint_t zfs_vdev_min_auto_ashift; 655 extern uint_t zfs_vdev_max_auto_ashift; 656 int param_set_min_auto_ashift(ZFS_MODULE_PARAM_ARGS); 657 int param_set_max_auto_ashift(ZFS_MODULE_PARAM_ARGS); 658 659 /* 660 * VDEV checksum verification for Direct I/O writes 661 */ 662 extern uint_t zfs_vdev_direct_write_verify; 663 664 #ifdef __cplusplus 665 } 666 #endif 667 668 #endif /* _SYS_VDEV_IMPL_H */ 669