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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 #ifndef _SYS_VDEV_IMPL_H
27 #define _SYS_VDEV_IMPL_H
31 #include <sys/metaslab.h>
32 #include <sys/nvpair.h>
33 #include <sys/space_map.h>
36 #include <sys/uberblock_impl.h>
43 * Virtual device descriptors.
45 * All storage pool operations go through the virtual device framework,
46 * which provides data replication and I/O scheduling.
50 * Forward declarations that lots of things need.
52 typedef struct vdev_queue vdev_queue_t
;
53 typedef struct vdev_cache vdev_cache_t
;
54 typedef struct vdev_cache_entry vdev_cache_entry_t
;
57 * Virtual device operations
59 typedef int vdev_open_func_t(vdev_t
*vd
, uint64_t *size
, uint64_t *max_size
,
61 typedef void vdev_close_func_t(vdev_t
*vd
);
62 typedef uint64_t vdev_asize_func_t(vdev_t
*vd
, uint64_t psize
);
63 typedef void vdev_io_start_func_t(zio_t
*zio
);
64 typedef void vdev_io_done_func_t(zio_t
*zio
);
65 typedef void vdev_state_change_func_t(vdev_t
*vd
, int, int);
66 typedef void vdev_hold_func_t(vdev_t
*vd
);
67 typedef void vdev_rele_func_t(vdev_t
*vd
);
69 typedef const struct vdev_ops
{
70 vdev_open_func_t
*vdev_op_open
;
71 vdev_close_func_t
*vdev_op_close
;
72 vdev_asize_func_t
*vdev_op_asize
;
73 vdev_io_start_func_t
*vdev_op_io_start
;
74 vdev_io_done_func_t
*vdev_op_io_done
;
75 vdev_state_change_func_t
*vdev_op_state_change
;
76 vdev_hold_func_t
*vdev_op_hold
;
77 vdev_rele_func_t
*vdev_op_rele
;
78 char vdev_op_type
[16];
79 boolean_t vdev_op_leaf
;
83 * Virtual device properties
85 struct vdev_cache_entry
{
89 avl_node_t ve_offset_node
;
90 avl_node_t ve_lastused_node
;
92 uint16_t ve_missed_update
;
97 avl_tree_t vc_offset_tree
;
98 avl_tree_t vc_lastused_tree
;
102 typedef struct vdev_queue_class
{
106 * Sorted by offset or timestamp, depending on if the queue is
107 * LBA-ordered vs FIFO.
109 avl_tree_t vqc_queued_tree
;
110 } vdev_queue_class_t
;
114 vdev_queue_class_t vq_class
[ZIO_PRIORITY_NUM_QUEUEABLE
];
115 avl_tree_t vq_active_tree
;
116 avl_tree_t vq_read_offset_tree
;
117 avl_tree_t vq_write_offset_tree
;
118 uint64_t vq_last_offset
;
119 hrtime_t vq_io_complete_ts
; /* time last i/o completed */
120 hrtime_t vq_io_delta_ts
;
121 zio_t vq_io_search
; /* used as local for stack reduction */
126 * Virtual device descriptor
130 * Common to all vdev types.
132 uint64_t vdev_id
; /* child number in vdev parent */
133 uint64_t vdev_guid
; /* unique ID for this vdev */
134 uint64_t vdev_guid_sum
; /* self guid + all child guids */
135 uint64_t vdev_orig_guid
; /* orig. guid prior to remove */
136 uint64_t vdev_asize
; /* allocatable device capacity */
137 uint64_t vdev_min_asize
; /* min acceptable asize */
138 uint64_t vdev_max_asize
; /* max acceptable asize */
139 uint64_t vdev_ashift
; /* block alignment shift */
140 uint64_t vdev_state
; /* see VDEV_STATE_* #defines */
141 uint64_t vdev_prevstate
; /* used when reopening a vdev */
142 vdev_ops_t
*vdev_ops
; /* vdev operations */
143 spa_t
*vdev_spa
; /* spa for this vdev */
144 void *vdev_tsd
; /* type-specific data */
145 vnode_t
*vdev_name_vp
; /* vnode for pathname */
146 vnode_t
*vdev_devid_vp
; /* vnode for devid */
147 vdev_t
*vdev_top
; /* top-level vdev */
148 vdev_t
*vdev_parent
; /* parent vdev */
149 vdev_t
**vdev_child
; /* array of children */
150 uint64_t vdev_children
; /* number of children */
151 vdev_stat_t vdev_stat
; /* virtual device statistics */
152 boolean_t vdev_expanding
; /* expand the vdev? */
153 boolean_t vdev_reopening
; /* reopen in progress? */
154 boolean_t vdev_nonrot
; /* true if solid state */
155 int vdev_open_error
; /* error on last open */
156 kthread_t
*vdev_open_thread
; /* thread opening children */
157 uint64_t vdev_crtxg
; /* txg when top-level was added */
160 * Top-level vdev state.
162 uint64_t vdev_ms_array
; /* metaslab array object */
163 uint64_t vdev_ms_shift
; /* metaslab size shift */
164 uint64_t vdev_ms_count
; /* number of metaslabs */
165 metaslab_group_t
*vdev_mg
; /* metaslab group */
166 metaslab_t
**vdev_ms
; /* metaslab array */
167 uint64_t vdev_pending_fastwrite
; /* allocated fastwrites */
168 txg_list_t vdev_ms_list
; /* per-txg dirty metaslab lists */
169 txg_list_t vdev_dtl_list
; /* per-txg dirty DTL lists */
170 txg_node_t vdev_txg_node
; /* per-txg dirty vdev linkage */
171 boolean_t vdev_remove_wanted
; /* async remove wanted? */
172 boolean_t vdev_probe_wanted
; /* async probe wanted? */
173 list_node_t vdev_config_dirty_node
; /* config dirty list */
174 list_node_t vdev_state_dirty_node
; /* state dirty list */
175 uint64_t vdev_deflate_ratio
; /* deflation ratio (x512) */
176 uint64_t vdev_islog
; /* is an intent log device */
177 uint64_t vdev_removing
; /* device is being removed? */
178 boolean_t vdev_ishole
; /* is a hole in the namespace */
183 range_tree_t
*vdev_dtl
[DTL_TYPES
]; /* dirty time logs */
184 space_map_t
*vdev_dtl_sm
; /* dirty time log space map */
185 txg_node_t vdev_dtl_node
; /* per-txg dirty DTL linkage */
186 uint64_t vdev_dtl_object
; /* DTL object */
187 uint64_t vdev_psize
; /* physical device capacity */
188 uint64_t vdev_wholedisk
; /* true if this is a whole disk */
189 uint64_t vdev_offline
; /* persistent offline state */
190 uint64_t vdev_faulted
; /* persistent faulted state */
191 uint64_t vdev_degraded
; /* persistent degraded state */
192 uint64_t vdev_removed
; /* persistent removed state */
193 uint64_t vdev_resilver_txg
; /* persistent resilvering state */
194 uint64_t vdev_nparity
; /* number of parity devices for raidz */
195 char *vdev_path
; /* vdev path (if any) */
196 char *vdev_devid
; /* vdev devid (if any) */
197 char *vdev_physpath
; /* vdev device path (if any) */
198 char *vdev_fru
; /* physical FRU location */
199 uint64_t vdev_not_present
; /* not present during import */
200 uint64_t vdev_unspare
; /* unspare when resilvering done */
201 boolean_t vdev_nowritecache
; /* true if flushwritecache failed */
202 boolean_t vdev_checkremove
; /* temporary online test */
203 boolean_t vdev_forcefault
; /* force online fault */
204 boolean_t vdev_splitting
; /* split or repair in progress */
205 boolean_t vdev_delayed_close
; /* delayed device close? */
206 boolean_t vdev_tmpoffline
; /* device taken offline temporarily? */
207 boolean_t vdev_detached
; /* device detached? */
208 boolean_t vdev_cant_read
; /* vdev is failing all reads */
209 boolean_t vdev_cant_write
; /* vdev is failing all writes */
210 boolean_t vdev_isspare
; /* was a hot spare */
211 boolean_t vdev_isl2cache
; /* was a l2cache device */
212 vdev_queue_t vdev_queue
; /* I/O deadline schedule queue */
213 vdev_cache_t vdev_cache
; /* physical block cache */
214 spa_aux_vdev_t
*vdev_aux
; /* for l2cache and spares vdevs */
215 zio_t
*vdev_probe_zio
; /* root of current probe */
216 vdev_aux_t vdev_label_aux
; /* on-disk aux state */
219 * For DTrace to work in userland (libzpool) context, these fields must
220 * remain at the end of the structure. DTrace will use the kernel's
221 * CTF definition for 'struct vdev', and since the size of a kmutex_t is
222 * larger in userland, the offsets for the rest of the fields would be
225 kmutex_t vdev_dtl_lock
; /* vdev_dtl_{map,resilver} */
226 kmutex_t vdev_stat_lock
; /* vdev_stat */
227 kmutex_t vdev_probe_lock
; /* protects vdev_probe_zio */
230 #define VDEV_RAIDZ_MAXPARITY 3
232 #define VDEV_PAD_SIZE (8 << 10)
233 /* 2 padding areas (vl_pad1 and vl_pad2) to skip */
234 #define VDEV_SKIP_SIZE VDEV_PAD_SIZE * 2
235 #define VDEV_PHYS_SIZE (112 << 10)
236 #define VDEV_UBERBLOCK_RING (128 << 10)
238 /* The largest uberblock we support is 8k. */
239 #define MAX_UBERBLOCK_SHIFT (13)
240 #define VDEV_UBERBLOCK_SHIFT(vd) \
241 MIN(MAX((vd)->vdev_top->vdev_ashift, UBERBLOCK_SHIFT), \
243 #define VDEV_UBERBLOCK_COUNT(vd) \
244 (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd))
245 #define VDEV_UBERBLOCK_OFFSET(vd, n) \
246 offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)])
247 #define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd))
249 typedef struct vdev_phys
{
250 char vp_nvlist
[VDEV_PHYS_SIZE
- sizeof (zio_eck_t
)];
254 typedef struct vdev_label
{
255 char vl_pad1
[VDEV_PAD_SIZE
]; /* 8K */
256 char vl_pad2
[VDEV_PAD_SIZE
]; /* 8K */
257 vdev_phys_t vl_vdev_phys
; /* 112K */
258 char vl_uberblock
[VDEV_UBERBLOCK_RING
]; /* 128K */
259 } vdev_label_t
; /* 256K total */
264 #define VDD_METASLAB 0x01
267 /* Offset of embedded boot loader region on each label */
268 #define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t))
270 * Size of embedded boot loader region on each label.
271 * The total size of the first two labels plus the boot area is 4MB.
273 #define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */
276 * Size of label regions at the start and end of each leaf device.
278 #define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE)
279 #define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t))
280 #define VDEV_LABELS 4
281 #define VDEV_BEST_LABEL VDEV_LABELS
283 #define VDEV_ALLOC_LOAD 0
284 #define VDEV_ALLOC_ADD 1
285 #define VDEV_ALLOC_SPARE 2
286 #define VDEV_ALLOC_L2CACHE 3
287 #define VDEV_ALLOC_ROOTPOOL 4
288 #define VDEV_ALLOC_SPLIT 5
289 #define VDEV_ALLOC_ATTACH 6
292 * Allocate or free a vdev
294 extern vdev_t
*vdev_alloc_common(spa_t
*spa
, uint_t id
, uint64_t guid
,
296 extern int vdev_alloc(spa_t
*spa
, vdev_t
**vdp
, nvlist_t
*config
,
297 vdev_t
*parent
, uint_t id
, int alloctype
);
298 extern void vdev_free(vdev_t
*vd
);
301 * Add or remove children and parents
303 extern void vdev_add_child(vdev_t
*pvd
, vdev_t
*cvd
);
304 extern void vdev_remove_child(vdev_t
*pvd
, vdev_t
*cvd
);
305 extern void vdev_compact_children(vdev_t
*pvd
);
306 extern vdev_t
*vdev_add_parent(vdev_t
*cvd
, vdev_ops_t
*ops
);
307 extern void vdev_remove_parent(vdev_t
*cvd
);
310 * vdev sync load and sync
312 extern void vdev_load_log_state(vdev_t
*nvd
, vdev_t
*ovd
);
313 extern boolean_t
vdev_log_state_valid(vdev_t
*vd
);
314 extern void vdev_load(vdev_t
*vd
);
315 extern int vdev_dtl_load(vdev_t
*vd
);
316 extern void vdev_sync(vdev_t
*vd
, uint64_t txg
);
317 extern void vdev_sync_done(vdev_t
*vd
, uint64_t txg
);
318 extern void vdev_dirty(vdev_t
*vd
, int flags
, void *arg
, uint64_t txg
);
319 extern void vdev_dirty_leaves(vdev_t
*vd
, int flags
, uint64_t txg
);
322 * Available vdev types.
324 extern vdev_ops_t vdev_root_ops
;
325 extern vdev_ops_t vdev_mirror_ops
;
326 extern vdev_ops_t vdev_replacing_ops
;
327 extern vdev_ops_t vdev_raidz_ops
;
328 extern vdev_ops_t vdev_disk_ops
;
329 extern vdev_ops_t vdev_file_ops
;
330 extern vdev_ops_t vdev_missing_ops
;
331 extern vdev_ops_t vdev_hole_ops
;
332 extern vdev_ops_t vdev_spare_ops
;
335 * Common size functions
337 extern uint64_t vdev_default_asize(vdev_t
*vd
, uint64_t psize
);
338 extern uint64_t vdev_get_min_asize(vdev_t
*vd
);
339 extern void vdev_set_min_asize(vdev_t
*vd
);
344 /* zdb uses this tunable, so it must be declared here to make lint happy. */
345 extern int zfs_vdev_cache_size
;
351 #endif /* _SYS_VDEV_IMPL_H */