1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5441d80aaSlling * Common Development and Distribution License (the "License"). 6441d80aaSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 2205b2b3b8Smishra * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23fa9e4066Sahrens * Use is subject to license terms. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _SYS_VDEV_IMPL_H 27fa9e4066Sahrens #define _SYS_VDEV_IMPL_H 28fa9e4066Sahrens 29fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 30fa9e4066Sahrens 31fa9e4066Sahrens #include <sys/avl.h> 32fa9e4066Sahrens #include <sys/dmu.h> 33fa9e4066Sahrens #include <sys/metaslab.h> 34fa9e4066Sahrens #include <sys/nvpair.h> 35fa9e4066Sahrens #include <sys/space_map.h> 36fa9e4066Sahrens #include <sys/vdev.h> 37fa9e4066Sahrens #include <sys/dkio.h> 38fa9e4066Sahrens #include <sys/uberblock_impl.h> 39fa9e4066Sahrens 40fa9e4066Sahrens #ifdef __cplusplus 41fa9e4066Sahrens extern "C" { 42fa9e4066Sahrens #endif 43fa9e4066Sahrens 44fa9e4066Sahrens /* 45fa9e4066Sahrens * Virtual device descriptors. 46fa9e4066Sahrens * 47fa9e4066Sahrens * All storage pool operations go through the virtual device framework, 48fa9e4066Sahrens * which provides data replication and I/O scheduling. 49fa9e4066Sahrens */ 50fa9e4066Sahrens 51fa9e4066Sahrens /* 52fa9e4066Sahrens * Forward declarations that lots of things need. 53fa9e4066Sahrens */ 54fa9e4066Sahrens typedef struct vdev_queue vdev_queue_t; 55fa9e4066Sahrens typedef struct vdev_cache vdev_cache_t; 56fa9e4066Sahrens typedef struct vdev_cache_entry vdev_cache_entry_t; 57fa9e4066Sahrens 58fa9e4066Sahrens /* 59fa9e4066Sahrens * Virtual device operations 60fa9e4066Sahrens */ 61fa9e4066Sahrens typedef int vdev_open_func_t(vdev_t *vd, uint64_t *size, uint64_t *ashift); 62fa9e4066Sahrens typedef void vdev_close_func_t(vdev_t *vd); 63fa9e4066Sahrens typedef uint64_t vdev_asize_func_t(vdev_t *vd, uint64_t psize); 64fa9e4066Sahrens typedef void vdev_io_start_func_t(zio_t *zio); 65fa9e4066Sahrens typedef void vdev_io_done_func_t(zio_t *zio); 66fa9e4066Sahrens typedef void vdev_state_change_func_t(vdev_t *vd, int, int); 67fa9e4066Sahrens 68fa9e4066Sahrens typedef struct vdev_ops { 69fa9e4066Sahrens vdev_open_func_t *vdev_op_open; 70fa9e4066Sahrens vdev_close_func_t *vdev_op_close; 71fa9e4066Sahrens vdev_asize_func_t *vdev_op_asize; 72fa9e4066Sahrens vdev_io_start_func_t *vdev_op_io_start; 73fa9e4066Sahrens vdev_io_done_func_t *vdev_op_io_done; 74fa9e4066Sahrens vdev_state_change_func_t *vdev_op_state_change; 75fa9e4066Sahrens char vdev_op_type[16]; 76fa9e4066Sahrens boolean_t vdev_op_leaf; 77fa9e4066Sahrens } vdev_ops_t; 78fa9e4066Sahrens 79fa9e4066Sahrens /* 80fa9e4066Sahrens * Virtual device properties 81fa9e4066Sahrens */ 82fa9e4066Sahrens struct vdev_cache_entry { 83fa9e4066Sahrens char *ve_data; 84fa9e4066Sahrens uint64_t ve_offset; 85fa9e4066Sahrens uint64_t ve_lastused; 86fa9e4066Sahrens avl_node_t ve_offset_node; 87fa9e4066Sahrens avl_node_t ve_lastused_node; 88fa9e4066Sahrens uint32_t ve_hits; 89fa9e4066Sahrens uint16_t ve_missed_update; 90fa9e4066Sahrens zio_t *ve_fill_io; 91fa9e4066Sahrens }; 92fa9e4066Sahrens 93fa9e4066Sahrens struct vdev_cache { 94fa9e4066Sahrens avl_tree_t vc_offset_tree; 95fa9e4066Sahrens avl_tree_t vc_lastused_tree; 96fa9e4066Sahrens kmutex_t vc_lock; 97fa9e4066Sahrens }; 98fa9e4066Sahrens 99fa9e4066Sahrens struct vdev_queue { 100fa9e4066Sahrens avl_tree_t vq_deadline_tree; 101fa9e4066Sahrens avl_tree_t vq_read_tree; 102fa9e4066Sahrens avl_tree_t vq_write_tree; 103fa9e4066Sahrens avl_tree_t vq_pending_tree; 104fa9e4066Sahrens kmutex_t vq_lock; 105fa9e4066Sahrens }; 106fa9e4066Sahrens 107fa9e4066Sahrens /* 108fa9e4066Sahrens * Virtual device descriptor 109fa9e4066Sahrens */ 110fa9e4066Sahrens struct vdev { 111fa9e4066Sahrens /* 112fa9e4066Sahrens * Common to all vdev types. 113fa9e4066Sahrens */ 114fa9e4066Sahrens uint64_t vdev_id; /* child number in vdev parent */ 115fa9e4066Sahrens uint64_t vdev_guid; /* unique ID for this vdev */ 116fa9e4066Sahrens uint64_t vdev_guid_sum; /* self guid + all child guids */ 117fa9e4066Sahrens uint64_t vdev_asize; /* allocatable device capacity */ 118fa9e4066Sahrens uint64_t vdev_ashift; /* block alignment shift */ 119fa9e4066Sahrens uint64_t vdev_state; /* see VDEV_STATE_* #defines */ 120560e6e96Seschrock uint64_t vdev_prevstate; /* used when reopening a vdev */ 121fa9e4066Sahrens vdev_ops_t *vdev_ops; /* vdev operations */ 122fa9e4066Sahrens spa_t *vdev_spa; /* spa for this vdev */ 123fa9e4066Sahrens void *vdev_tsd; /* type-specific data */ 124fa9e4066Sahrens vdev_t *vdev_top; /* top-level vdev */ 125fa9e4066Sahrens vdev_t *vdev_parent; /* parent vdev */ 126fa9e4066Sahrens vdev_t **vdev_child; /* array of children */ 127fa9e4066Sahrens uint64_t vdev_children; /* number of children */ 128fa9e4066Sahrens space_map_t vdev_dtl_map; /* dirty time log in-core state */ 129fa9e4066Sahrens space_map_t vdev_dtl_scrub; /* DTL for scrub repair writes */ 130fa9e4066Sahrens vdev_stat_t vdev_stat; /* virtual device statistics */ 131fa9e4066Sahrens 132fa9e4066Sahrens /* 133fa9e4066Sahrens * Top-level vdev state. 134fa9e4066Sahrens */ 135fa9e4066Sahrens uint64_t vdev_ms_array; /* metaslab array object */ 136fa9e4066Sahrens uint64_t vdev_ms_shift; /* metaslab size shift */ 137fa9e4066Sahrens uint64_t vdev_ms_count; /* number of metaslabs */ 138fa9e4066Sahrens metaslab_group_t *vdev_mg; /* metaslab group */ 139fa9e4066Sahrens metaslab_t **vdev_ms; /* metaslab array */ 140fa9e4066Sahrens txg_list_t vdev_ms_list; /* per-txg dirty metaslab lists */ 141fa9e4066Sahrens txg_list_t vdev_dtl_list; /* per-txg dirty DTL lists */ 142fa9e4066Sahrens txg_node_t vdev_txg_node; /* per-txg dirty vdev linkage */ 143*3d7072f8Seschrock boolean_t vdev_remove_wanted; /* async remove wanted? */ 144fa9e4066Sahrens list_node_t vdev_dirty_node; /* config dirty list */ 14599653d4eSeschrock uint64_t vdev_deflate_ratio; /* deflation ratio (x512) */ 146fa9e4066Sahrens 147fa9e4066Sahrens /* 148fa9e4066Sahrens * Leaf vdev state. 149fa9e4066Sahrens */ 150fa9e4066Sahrens uint64_t vdev_psize; /* physical device capacity */ 151fa9e4066Sahrens space_map_obj_t vdev_dtl; /* dirty time log on-disk state */ 152fa9e4066Sahrens txg_node_t vdev_dtl_node; /* per-txg dirty DTL linkage */ 153afefbcddSeschrock uint64_t vdev_wholedisk; /* true if this is a whole disk */ 154*3d7072f8Seschrock uint64_t vdev_offline; /* persistent offline state */ 155*3d7072f8Seschrock uint64_t vdev_faulted; /* persistent faulted state */ 156*3d7072f8Seschrock uint64_t vdev_degraded; /* persistent degraded state */ 157*3d7072f8Seschrock uint64_t vdev_removed; /* persistent removed state */ 15899653d4eSeschrock uint64_t vdev_nparity; /* number of parity devices for raidz */ 159fa9e4066Sahrens char *vdev_path; /* vdev path (if any) */ 160fa9e4066Sahrens char *vdev_devid; /* vdev devid (if any) */ 161*3d7072f8Seschrock char *vdev_physpath; /* vdev device path (if any) */ 162fa9e4066Sahrens uint64_t vdev_fault_arg; /* fault injection paramater */ 163fa9e4066Sahrens int vdev_fault_mask; /* zio types to fault */ 164fa9e4066Sahrens uint8_t vdev_fault_mode; /* fault injection mode */ 165441d80aaSlling uint8_t vdev_tmpoffline; /* device taken offline temporarily? */ 166fa9e4066Sahrens uint8_t vdev_detached; /* device detached? */ 16799653d4eSeschrock uint64_t vdev_isspare; /* was a hot spare */ 168fa9e4066Sahrens vdev_queue_t vdev_queue; /* I/O deadline schedule queue */ 169fa9e4066Sahrens vdev_cache_t vdev_cache; /* physical block cache */ 170ea8dc4b6Seschrock uint64_t vdev_not_present; /* not present during import */ 171ea8dc4b6Seschrock hrtime_t vdev_last_try; /* last reopen time */ 172b468a217Seschrock boolean_t vdev_nowritecache; /* true if flushwritecache failed */ 173*3d7072f8Seschrock uint64_t vdev_unspare; /* unspare when resilvering done */ 174*3d7072f8Seschrock boolean_t vdev_checkremove; /* temporary online test */ 175*3d7072f8Seschrock boolean_t vdev_forcefault; /* force online fault */ 176fa9e4066Sahrens 177fa9e4066Sahrens /* 178fa9e4066Sahrens * For DTrace to work in userland (libzpool) context, these fields must 179fa9e4066Sahrens * remain at the end of the structure. DTrace will use the kernel's 180fa9e4066Sahrens * CTF definition for 'struct vdev', and since the size of a kmutex_t is 181fa9e4066Sahrens * larger in userland, the offsets for the rest fields would be 182fa9e4066Sahrens * incorrect. 183fa9e4066Sahrens */ 184fa9e4066Sahrens kmutex_t vdev_dtl_lock; /* vdev_dtl_{map,resilver} */ 185fa9e4066Sahrens kmutex_t vdev_stat_lock; /* vdev_stat */ 186fa9e4066Sahrens }; 187fa9e4066Sahrens 188fa9e4066Sahrens #define VDEV_SKIP_SIZE (8 << 10) 189fa9e4066Sahrens #define VDEV_BOOT_HEADER_SIZE (8 << 10) 190fa9e4066Sahrens #define VDEV_PHYS_SIZE (112 << 10) 191ecc2d604Sbonwick #define VDEV_UBERBLOCK_RING (128 << 10) 192ecc2d604Sbonwick 193ecc2d604Sbonwick #define VDEV_UBERBLOCK_SHIFT(vd) \ 194ecc2d604Sbonwick MAX((vd)->vdev_top->vdev_ashift, UBERBLOCK_SHIFT) 195ecc2d604Sbonwick #define VDEV_UBERBLOCK_COUNT(vd) \ 196ecc2d604Sbonwick (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd)) 197ecc2d604Sbonwick #define VDEV_UBERBLOCK_OFFSET(vd, n) \ 198ecc2d604Sbonwick offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)]) 199ecc2d604Sbonwick #define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd)) 200fa9e4066Sahrens 2015ad82045Snd /* ZFS boot block */ 2025ad82045Snd #define VDEV_BOOT_MAGIC 0x2f5b007b10cULL 203fa9e4066Sahrens #define VDEV_BOOT_VERSION 1 /* version number */ 204fa9e4066Sahrens 205fa9e4066Sahrens typedef struct vdev_boot_header { 206fa9e4066Sahrens uint64_t vb_magic; /* VDEV_BOOT_MAGIC */ 207fa9e4066Sahrens uint64_t vb_version; /* VDEV_BOOT_VERSION */ 208fa9e4066Sahrens uint64_t vb_offset; /* start offset (bytes) */ 209fa9e4066Sahrens uint64_t vb_size; /* size (bytes) */ 210fa9e4066Sahrens char vb_pad[VDEV_BOOT_HEADER_SIZE - 4 * sizeof (uint64_t)]; 211fa9e4066Sahrens } vdev_boot_header_t; 212fa9e4066Sahrens 213fa9e4066Sahrens typedef struct vdev_phys { 214fa9e4066Sahrens char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_block_tail_t)]; 215fa9e4066Sahrens zio_block_tail_t vp_zbt; 216fa9e4066Sahrens } vdev_phys_t; 217fa9e4066Sahrens 218fa9e4066Sahrens typedef struct vdev_label { 219ecc2d604Sbonwick char vl_pad[VDEV_SKIP_SIZE]; /* 8K */ 220ecc2d604Sbonwick vdev_boot_header_t vl_boot_header; /* 8K */ 221ecc2d604Sbonwick vdev_phys_t vl_vdev_phys; /* 112K */ 222ecc2d604Sbonwick char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */ 223fa9e4066Sahrens } vdev_label_t; /* 256K total */ 224fa9e4066Sahrens 225ecc2d604Sbonwick /* 226ecc2d604Sbonwick * vdev_dirty() flags 227ecc2d604Sbonwick */ 228ecc2d604Sbonwick #define VDD_METASLAB 0x01 229ecc2d604Sbonwick #define VDD_DTL 0x02 230ecc2d604Sbonwick 231fa9e4066Sahrens /* 232fa9e4066Sahrens * Size and offset of embedded boot loader region on each label. 233fa9e4066Sahrens * The total size of the first two labels plus the boot area is 4MB. 234fa9e4066Sahrens */ 235fa9e4066Sahrens #define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 236fa9e4066Sahrens #define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 237fa9e4066Sahrens 238fa9e4066Sahrens /* 239fa9e4066Sahrens * Size of label regions at the start and end of each leaf device. 240fa9e4066Sahrens */ 241fa9e4066Sahrens #define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 242fa9e4066Sahrens #define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 243fa9e4066Sahrens #define VDEV_LABELS 4 244fa9e4066Sahrens 245fa9e4066Sahrens #define VDEV_ALLOC_LOAD 0 246fa9e4066Sahrens #define VDEV_ALLOC_ADD 1 24799653d4eSeschrock #define VDEV_ALLOC_SPARE 2 248fa9e4066Sahrens 249fa9e4066Sahrens /* 250fa9e4066Sahrens * Allocate or free a vdev 251fa9e4066Sahrens */ 25299653d4eSeschrock extern int vdev_alloc(spa_t *spa, vdev_t **vdp, nvlist_t *config, 25399653d4eSeschrock vdev_t *parent, uint_t id, int alloctype); 254fa9e4066Sahrens extern void vdev_free(vdev_t *vd); 255fa9e4066Sahrens 256fa9e4066Sahrens /* 257fa9e4066Sahrens * Add or remove children and parents 258fa9e4066Sahrens */ 259fa9e4066Sahrens extern void vdev_add_child(vdev_t *pvd, vdev_t *cvd); 260fa9e4066Sahrens extern void vdev_remove_child(vdev_t *pvd, vdev_t *cvd); 261fa9e4066Sahrens extern void vdev_compact_children(vdev_t *pvd); 262fa9e4066Sahrens extern vdev_t *vdev_add_parent(vdev_t *cvd, vdev_ops_t *ops); 263fa9e4066Sahrens extern void vdev_remove_parent(vdev_t *cvd); 264fa9e4066Sahrens 265fa9e4066Sahrens /* 266fa9e4066Sahrens * vdev sync load and sync 267fa9e4066Sahrens */ 268560e6e96Seschrock extern void vdev_load(vdev_t *vd); 269fa9e4066Sahrens extern void vdev_sync(vdev_t *vd, uint64_t txg); 270fa9e4066Sahrens extern void vdev_sync_done(vdev_t *vd, uint64_t txg); 271ecc2d604Sbonwick extern void vdev_dirty(vdev_t *vd, int flags, void *arg, uint64_t txg); 272fa9e4066Sahrens 273fa9e4066Sahrens /* 274fa9e4066Sahrens * Available vdev types. 275fa9e4066Sahrens */ 276fa9e4066Sahrens extern vdev_ops_t vdev_root_ops; 277fa9e4066Sahrens extern vdev_ops_t vdev_mirror_ops; 278fa9e4066Sahrens extern vdev_ops_t vdev_replacing_ops; 279fa9e4066Sahrens extern vdev_ops_t vdev_raidz_ops; 280fa9e4066Sahrens extern vdev_ops_t vdev_disk_ops; 281fa9e4066Sahrens extern vdev_ops_t vdev_file_ops; 282fa9e4066Sahrens extern vdev_ops_t vdev_missing_ops; 28399653d4eSeschrock extern vdev_ops_t vdev_spare_ops; 284fa9e4066Sahrens 285fa9e4066Sahrens /* 2862a79c5feSlling * Common size functions 287fa9e4066Sahrens */ 288fa9e4066Sahrens extern uint64_t vdev_default_asize(vdev_t *vd, uint64_t psize); 2892a79c5feSlling extern uint64_t vdev_get_rsize(vdev_t *vd); 290fa9e4066Sahrens 291e81c57b1Sahrens /* 292e81c57b1Sahrens * zdb uses this tunable, so it must be declared here to make lint happy. 293e81c57b1Sahrens */ 294e81c57b1Sahrens extern int zfs_vdev_cache_size; 295e81c57b1Sahrens 296fa9e4066Sahrens #ifdef __cplusplus 297fa9e4066Sahrens } 298fa9e4066Sahrens #endif 299fa9e4066Sahrens 300fa9e4066Sahrens #endif /* _SYS_VDEV_IMPL_H */ 301