1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5fa9e4066Sahrens * Common Development and Distribution License, Version 1.0 only 6fa9e4066Sahrens * (the "License"). You may not use this file except in compliance 7fa9e4066Sahrens * with the License. 8fa9e4066Sahrens * 9fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 11fa9e4066Sahrens * See the License for the specific language governing permissions 12fa9e4066Sahrens * and limitations under the License. 13fa9e4066Sahrens * 14fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 15fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 17fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 18fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 19fa9e4066Sahrens * 20fa9e4066Sahrens * CDDL HEADER END 21fa9e4066Sahrens */ 22fa9e4066Sahrens /* 23fa9e4066Sahrens * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24fa9e4066Sahrens * Use is subject to license terms. 25fa9e4066Sahrens */ 26fa9e4066Sahrens 27fa9e4066Sahrens #ifndef _SYS_VDEV_IMPL_H 28fa9e4066Sahrens #define _SYS_VDEV_IMPL_H 29fa9e4066Sahrens 30fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 31fa9e4066Sahrens 32fa9e4066Sahrens #include <sys/avl.h> 33fa9e4066Sahrens #include <sys/dmu.h> 34fa9e4066Sahrens #include <sys/metaslab.h> 35fa9e4066Sahrens #include <sys/nvpair.h> 36fa9e4066Sahrens #include <sys/space_map.h> 37fa9e4066Sahrens #include <sys/vdev.h> 38fa9e4066Sahrens #include <sys/dkio.h> 39fa9e4066Sahrens #include <sys/uberblock_impl.h> 40fa9e4066Sahrens 41fa9e4066Sahrens #ifdef __cplusplus 42fa9e4066Sahrens extern "C" { 43fa9e4066Sahrens #endif 44fa9e4066Sahrens 45fa9e4066Sahrens /* 46fa9e4066Sahrens * Virtual device descriptors. 47fa9e4066Sahrens * 48fa9e4066Sahrens * All storage pool operations go through the virtual device framework, 49fa9e4066Sahrens * which provides data replication and I/O scheduling. 50fa9e4066Sahrens */ 51fa9e4066Sahrens 52fa9e4066Sahrens /* 53fa9e4066Sahrens * Forward declarations that lots of things need. 54fa9e4066Sahrens */ 55fa9e4066Sahrens typedef struct vdev_queue vdev_queue_t; 56fa9e4066Sahrens typedef struct vdev_cache vdev_cache_t; 57fa9e4066Sahrens typedef struct vdev_cache_entry vdev_cache_entry_t; 58fa9e4066Sahrens 59fa9e4066Sahrens /* 60fa9e4066Sahrens * Virtual device operations 61fa9e4066Sahrens */ 62fa9e4066Sahrens typedef int vdev_open_func_t(vdev_t *vd, uint64_t *size, uint64_t *ashift); 63fa9e4066Sahrens typedef void vdev_close_func_t(vdev_t *vd); 64fa9e4066Sahrens typedef uint64_t vdev_asize_func_t(vdev_t *vd, uint64_t psize); 65fa9e4066Sahrens typedef void vdev_io_start_func_t(zio_t *zio); 66fa9e4066Sahrens typedef void vdev_io_done_func_t(zio_t *zio); 67fa9e4066Sahrens typedef void vdev_state_change_func_t(vdev_t *vd, int, int); 68fa9e4066Sahrens 69fa9e4066Sahrens typedef struct vdev_ops { 70fa9e4066Sahrens vdev_open_func_t *vdev_op_open; 71fa9e4066Sahrens vdev_close_func_t *vdev_op_close; 72fa9e4066Sahrens vdev_asize_func_t *vdev_op_asize; 73fa9e4066Sahrens vdev_io_start_func_t *vdev_op_io_start; 74fa9e4066Sahrens vdev_io_done_func_t *vdev_op_io_done; 75fa9e4066Sahrens vdev_state_change_func_t *vdev_op_state_change; 76fa9e4066Sahrens char vdev_op_type[16]; 77fa9e4066Sahrens boolean_t vdev_op_leaf; 78fa9e4066Sahrens } vdev_ops_t; 79fa9e4066Sahrens 80fa9e4066Sahrens /* 81fa9e4066Sahrens * Virtual device properties 82fa9e4066Sahrens */ 83fa9e4066Sahrens struct vdev_cache_entry { 84fa9e4066Sahrens char *ve_data; 85fa9e4066Sahrens uint64_t ve_offset; 86fa9e4066Sahrens uint64_t ve_lastused; 87fa9e4066Sahrens avl_node_t ve_offset_node; 88fa9e4066Sahrens avl_node_t ve_lastused_node; 89fa9e4066Sahrens uint32_t ve_hits; 90fa9e4066Sahrens uint16_t ve_missed_update; 91fa9e4066Sahrens zio_t *ve_fill_io; 92fa9e4066Sahrens }; 93fa9e4066Sahrens 94fa9e4066Sahrens struct vdev_cache { 95fa9e4066Sahrens uint64_t vc_size; 96fa9e4066Sahrens uint64_t vc_bshift; 97fa9e4066Sahrens uint64_t vc_blocksize; 98fa9e4066Sahrens uint64_t vc_max; 99fa9e4066Sahrens avl_tree_t vc_offset_tree; 100fa9e4066Sahrens avl_tree_t vc_lastused_tree; 101fa9e4066Sahrens kmutex_t vc_lock; 102fa9e4066Sahrens }; 103fa9e4066Sahrens 104fa9e4066Sahrens struct vdev_queue { 105fa9e4066Sahrens uint64_t vq_min_pending; 106fa9e4066Sahrens uint64_t vq_max_pending; 107fa9e4066Sahrens uint64_t vq_agg_limit; 108fa9e4066Sahrens uint64_t vq_time_shift; 109fa9e4066Sahrens uint64_t vq_ramp_rate; 110fa9e4066Sahrens avl_tree_t vq_deadline_tree; 111fa9e4066Sahrens avl_tree_t vq_read_tree; 112fa9e4066Sahrens avl_tree_t vq_write_tree; 113fa9e4066Sahrens avl_tree_t vq_pending_tree; 114fa9e4066Sahrens kmutex_t vq_lock; 115fa9e4066Sahrens }; 116fa9e4066Sahrens 117fa9e4066Sahrens /* 118fa9e4066Sahrens * Virtual device descriptor 119fa9e4066Sahrens */ 120fa9e4066Sahrens struct vdev { 121fa9e4066Sahrens /* 122fa9e4066Sahrens * Common to all vdev types. 123fa9e4066Sahrens */ 124fa9e4066Sahrens uint64_t vdev_id; /* child number in vdev parent */ 125fa9e4066Sahrens uint64_t vdev_guid; /* unique ID for this vdev */ 126fa9e4066Sahrens uint64_t vdev_guid_sum; /* self guid + all child guids */ 127fa9e4066Sahrens uint64_t vdev_asize; /* allocatable device capacity */ 128fa9e4066Sahrens uint64_t vdev_ashift; /* block alignment shift */ 129fa9e4066Sahrens uint64_t vdev_state; /* see VDEV_STATE_* #defines */ 130fa9e4066Sahrens vdev_ops_t *vdev_ops; /* vdev operations */ 131fa9e4066Sahrens spa_t *vdev_spa; /* spa for this vdev */ 132fa9e4066Sahrens void *vdev_tsd; /* type-specific data */ 133fa9e4066Sahrens vdev_t *vdev_top; /* top-level vdev */ 134fa9e4066Sahrens vdev_t *vdev_parent; /* parent vdev */ 135fa9e4066Sahrens vdev_t **vdev_child; /* array of children */ 136fa9e4066Sahrens uint64_t vdev_children; /* number of children */ 137fa9e4066Sahrens space_map_t vdev_dtl_map; /* dirty time log in-core state */ 138fa9e4066Sahrens space_map_t vdev_dtl_scrub; /* DTL for scrub repair writes */ 139fa9e4066Sahrens vdev_stat_t vdev_stat; /* virtual device statistics */ 140fa9e4066Sahrens 141fa9e4066Sahrens /* 142fa9e4066Sahrens * Top-level vdev state. 143fa9e4066Sahrens */ 144fa9e4066Sahrens uint64_t vdev_ms_array; /* metaslab array object */ 145fa9e4066Sahrens uint64_t vdev_ms_shift; /* metaslab size shift */ 146fa9e4066Sahrens uint64_t vdev_ms_count; /* number of metaslabs */ 147fa9e4066Sahrens metaslab_group_t *vdev_mg; /* metaslab group */ 148fa9e4066Sahrens metaslab_t **vdev_ms; /* metaslab array */ 149fa9e4066Sahrens space_map_obj_t *vdev_smo; /* metaslab space map array */ 150fa9e4066Sahrens txg_list_t vdev_ms_list; /* per-txg dirty metaslab lists */ 151fa9e4066Sahrens txg_list_t vdev_dtl_list; /* per-txg dirty DTL lists */ 152fa9e4066Sahrens txg_node_t vdev_txg_node; /* per-txg dirty vdev linkage */ 153fa9e4066Sahrens uint8_t vdev_dirty[TXG_SIZE]; /* per-txg dirty flags */ 154fa9e4066Sahrens int vdev_is_dirty; /* on config dirty list? */ 155fa9e4066Sahrens list_node_t vdev_dirty_node; /* config dirty list */ 156fa9e4066Sahrens zio_t *vdev_io_retry; /* I/O retry list */ 157fa9e4066Sahrens list_t vdev_io_pending; /* I/O pending list */ 158fa9e4066Sahrens 159fa9e4066Sahrens /* 160fa9e4066Sahrens * Leaf vdev state. 161fa9e4066Sahrens */ 162fa9e4066Sahrens uint64_t vdev_psize; /* physical device capacity */ 163fa9e4066Sahrens space_map_obj_t vdev_dtl; /* dirty time log on-disk state */ 164fa9e4066Sahrens txg_node_t vdev_dtl_node; /* per-txg dirty DTL linkage */ 165afefbcddSeschrock uint64_t vdev_wholedisk; /* true if this is a whole disk */ 166fa9e4066Sahrens char *vdev_path; /* vdev path (if any) */ 167fa9e4066Sahrens char *vdev_devid; /* vdev devid (if any) */ 168fa9e4066Sahrens uint64_t vdev_fault_arg; /* fault injection paramater */ 169fa9e4066Sahrens int vdev_fault_mask; /* zio types to fault */ 170fa9e4066Sahrens uint8_t vdev_fault_mode; /* fault injection mode */ 171fa9e4066Sahrens uint8_t vdev_cache_active; /* vdev_cache and vdev_queue */ 172fa9e4066Sahrens uint8_t vdev_offline; /* device taken offline? */ 173fa9e4066Sahrens uint8_t vdev_detached; /* device detached? */ 174fa9e4066Sahrens vdev_queue_t vdev_queue; /* I/O deadline schedule queue */ 175fa9e4066Sahrens vdev_cache_t vdev_cache; /* physical block cache */ 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_dirty_lock; /* vdev_dirty[] */ 186fa9e4066Sahrens kmutex_t vdev_io_lock; /* vdev_io_pending list */ 187fa9e4066Sahrens kcondvar_t vdev_io_cv; /* vdev_io_pending list empty? */ 188fa9e4066Sahrens kmutex_t vdev_stat_lock; /* vdev_stat */ 189fa9e4066Sahrens }; 190fa9e4066Sahrens 191fa9e4066Sahrens #define VDEV_SKIP_SIZE (8 << 10) 192fa9e4066Sahrens #define VDEV_BOOT_HEADER_SIZE (8 << 10) 193fa9e4066Sahrens #define VDEV_PHYS_SIZE (112 << 10) 194fa9e4066Sahrens #define VDEV_UBERBLOCKS ((128 << 10) >> UBERBLOCK_SHIFT) 195fa9e4066Sahrens 196fa9e4066Sahrens #define VDEV_BOOT_MAGIC 0x2f5b007b10c /* ZFS boot block */ 197fa9e4066Sahrens #define VDEV_BOOT_VERSION 1 /* version number */ 198fa9e4066Sahrens 199fa9e4066Sahrens typedef struct vdev_boot_header { 200fa9e4066Sahrens uint64_t vb_magic; /* VDEV_BOOT_MAGIC */ 201fa9e4066Sahrens uint64_t vb_version; /* VDEV_BOOT_VERSION */ 202fa9e4066Sahrens uint64_t vb_offset; /* start offset (bytes) */ 203fa9e4066Sahrens uint64_t vb_size; /* size (bytes) */ 204fa9e4066Sahrens char vb_pad[VDEV_BOOT_HEADER_SIZE - 4 * sizeof (uint64_t)]; 205fa9e4066Sahrens } vdev_boot_header_t; 206fa9e4066Sahrens 207fa9e4066Sahrens typedef struct vdev_phys { 208fa9e4066Sahrens char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_block_tail_t)]; 209fa9e4066Sahrens zio_block_tail_t vp_zbt; 210fa9e4066Sahrens } vdev_phys_t; 211fa9e4066Sahrens 212fa9e4066Sahrens typedef struct vdev_label { 213fa9e4066Sahrens char vl_pad[VDEV_SKIP_SIZE]; /* 8K */ 214fa9e4066Sahrens vdev_boot_header_t vl_boot_header; /* 8K */ 2153dd27b57Stabriz vdev_phys_t vl_vdev_phys; /* 112K */ 216fa9e4066Sahrens uberblock_phys_t vl_uberblock[VDEV_UBERBLOCKS]; /* 128K */ 217fa9e4066Sahrens } vdev_label_t; /* 256K total */ 218fa9e4066Sahrens 219fa9e4066Sahrens /* 220fa9e4066Sahrens * Size and offset of embedded boot loader region on each label. 221fa9e4066Sahrens * The total size of the first two labels plus the boot area is 4MB. 222fa9e4066Sahrens */ 223fa9e4066Sahrens #define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t)) 224fa9e4066Sahrens #define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */ 225fa9e4066Sahrens 226fa9e4066Sahrens /* 227fa9e4066Sahrens * vdev_dirty[] flags 228fa9e4066Sahrens */ 229fa9e4066Sahrens #define VDD_ALLOC 0x01 /* allocated from in this txg */ 230fa9e4066Sahrens #define VDD_FREE 0x02 /* freed to in this txg */ 231fa9e4066Sahrens #define VDD_ADD 0x04 /* added to the pool in this txg */ 232fa9e4066Sahrens #define VDD_DTL 0x08 /* dirty time log entry in this txg */ 233fa9e4066Sahrens 234fa9e4066Sahrens /* 235fa9e4066Sahrens * Size of label regions at the start and end of each leaf device. 236fa9e4066Sahrens */ 237fa9e4066Sahrens #define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE) 238fa9e4066Sahrens #define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t)) 239fa9e4066Sahrens #define VDEV_LABELS 4 240fa9e4066Sahrens 241fa9e4066Sahrens #define VDEV_ALLOC_LOAD 0 242fa9e4066Sahrens #define VDEV_ALLOC_ADD 1 243fa9e4066Sahrens 244fa9e4066Sahrens /* 245fa9e4066Sahrens * Allocate or free a vdev 246fa9e4066Sahrens */ 247fa9e4066Sahrens extern vdev_t *vdev_alloc(spa_t *spa, nvlist_t *config, vdev_t *parent, 248fa9e4066Sahrens uint_t id, int alloctype); 249fa9e4066Sahrens extern void vdev_free(vdev_t *vd); 250fa9e4066Sahrens 251fa9e4066Sahrens /* 252fa9e4066Sahrens * Add or remove children and parents 253fa9e4066Sahrens */ 254fa9e4066Sahrens extern void vdev_add_child(vdev_t *pvd, vdev_t *cvd); 255fa9e4066Sahrens extern void vdev_remove_child(vdev_t *pvd, vdev_t *cvd); 256fa9e4066Sahrens extern void vdev_compact_children(vdev_t *pvd); 257fa9e4066Sahrens extern vdev_t *vdev_add_parent(vdev_t *cvd, vdev_ops_t *ops); 258fa9e4066Sahrens extern void vdev_remove_parent(vdev_t *cvd); 259fa9e4066Sahrens 260fa9e4066Sahrens /* 261fa9e4066Sahrens * vdev sync load and sync 262fa9e4066Sahrens */ 263fa9e4066Sahrens extern int vdev_load(vdev_t *vd, int import); 264fa9e4066Sahrens extern void vdev_sync(vdev_t *vd, uint64_t txg); 265fa9e4066Sahrens extern void vdev_sync_done(vdev_t *vd, uint64_t txg); 266fa9e4066Sahrens extern void vdev_dirty(vdev_t *vd, uint8_t flags, uint64_t txg); 267fa9e4066Sahrens 268fa9e4066Sahrens /* 269fa9e4066Sahrens * Available vdev types. 270fa9e4066Sahrens */ 271fa9e4066Sahrens extern vdev_ops_t vdev_root_ops; 272fa9e4066Sahrens extern vdev_ops_t vdev_mirror_ops; 273fa9e4066Sahrens extern vdev_ops_t vdev_replacing_ops; 274fa9e4066Sahrens extern vdev_ops_t vdev_raidz_ops; 275fa9e4066Sahrens extern vdev_ops_t vdev_disk_ops; 276fa9e4066Sahrens extern vdev_ops_t vdev_file_ops; 277fa9e4066Sahrens extern vdev_ops_t vdev_missing_ops; 278fa9e4066Sahrens 279fa9e4066Sahrens /* 280*2a79c5feSlling * Common size functions 281fa9e4066Sahrens */ 282fa9e4066Sahrens extern uint64_t vdev_default_asize(vdev_t *vd, uint64_t psize); 283*2a79c5feSlling extern uint64_t vdev_get_rsize(vdev_t *vd); 284fa9e4066Sahrens 285fa9e4066Sahrens #ifdef __cplusplus 286fa9e4066Sahrens } 287fa9e4066Sahrens #endif 288fa9e4066Sahrens 289fa9e4066Sahrens #endif /* _SYS_VDEV_IMPL_H */ 290