]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/vdev_impl.h
Fix coverity defects: CID 150926
[mirror_zfs.git] / include / sys / vdev_impl.h
CommitLineData
34dc7c2f
BB
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/*
428870ff 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
c3520e7f 23 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
34dc7c2f
BB
24 */
25
26#ifndef _SYS_VDEV_IMPL_H
27#define _SYS_VDEV_IMPL_H
28
34dc7c2f
BB
29#include <sys/avl.h>
30#include <sys/dmu.h>
31#include <sys/metaslab.h>
32#include <sys/nvpair.h>
33#include <sys/space_map.h>
34#include <sys/vdev.h>
35#include <sys/dkio.h>
36#include <sys/uberblock_impl.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42/*
43 * Virtual device descriptors.
44 *
45 * All storage pool operations go through the virtual device framework,
46 * which provides data replication and I/O scheduling.
47 */
48
49/*
50 * Forward declarations that lots of things need.
51 */
52typedef struct vdev_queue vdev_queue_t;
53typedef struct vdev_cache vdev_cache_t;
54typedef struct vdev_cache_entry vdev_cache_entry_t;
55
3dfb57a3
DB
56extern int zfs_vdev_queue_depth_pct;
57extern uint32_t zfs_vdev_async_write_max_active;
58
34dc7c2f
BB
59/*
60 * Virtual device operations
61 */
1bd201e7
CS
62typedef int vdev_open_func_t(vdev_t *vd, uint64_t *size, uint64_t *max_size,
63 uint64_t *ashift);
34dc7c2f 64typedef void vdev_close_func_t(vdev_t *vd);
34dc7c2f 65typedef uint64_t vdev_asize_func_t(vdev_t *vd, uint64_t psize);
98b25418 66typedef void vdev_io_start_func_t(zio_t *zio);
b128c09f 67typedef void vdev_io_done_func_t(zio_t *zio);
34dc7c2f 68typedef void vdev_state_change_func_t(vdev_t *vd, int, int);
428870ff
BB
69typedef void vdev_hold_func_t(vdev_t *vd);
70typedef void vdev_rele_func_t(vdev_t *vd);
34dc7c2f 71
b01615d5 72typedef const struct vdev_ops {
34dc7c2f
BB
73 vdev_open_func_t *vdev_op_open;
74 vdev_close_func_t *vdev_op_close;
34dc7c2f
BB
75 vdev_asize_func_t *vdev_op_asize;
76 vdev_io_start_func_t *vdev_op_io_start;
77 vdev_io_done_func_t *vdev_op_io_done;
78 vdev_state_change_func_t *vdev_op_state_change;
428870ff
BB
79 vdev_hold_func_t *vdev_op_hold;
80 vdev_rele_func_t *vdev_op_rele;
34dc7c2f
BB
81 char vdev_op_type[16];
82 boolean_t vdev_op_leaf;
83} vdev_ops_t;
84
85/*
86 * Virtual device properties
87 */
88struct vdev_cache_entry {
89 char *ve_data;
90 uint64_t ve_offset;
0b75bdb3 91 clock_t ve_lastused;
34dc7c2f
BB
92 avl_node_t ve_offset_node;
93 avl_node_t ve_lastused_node;
94 uint32_t ve_hits;
95 uint16_t ve_missed_update;
96 zio_t *ve_fill_io;
97};
98
99struct vdev_cache {
100 avl_tree_t vc_offset_tree;
101 avl_tree_t vc_lastused_tree;
102 kmutex_t vc_lock;
103};
104
e8b96c60
MA
105typedef struct vdev_queue_class {
106 uint32_t vqc_active;
107
108 /*
109 * Sorted by offset or timestamp, depending on if the queue is
110 * LBA-ordered vs FIFO.
111 */
112 avl_tree_t vqc_queued_tree;
113} vdev_queue_class_t;
114
34dc7c2f 115struct vdev_queue {
e8b96c60
MA
116 vdev_t *vq_vdev;
117 vdev_queue_class_t vq_class[ZIO_PRIORITY_NUM_QUEUEABLE];
118 avl_tree_t vq_active_tree;
ec8501ee
JG
119 avl_tree_t vq_read_offset_tree;
120 avl_tree_t vq_write_offset_tree;
e8b96c60
MA
121 uint64_t vq_last_offset;
122 hrtime_t vq_io_complete_ts; /* time last i/o completed */
cb682a17 123 hrtime_t vq_io_delta_ts;
50b25b21 124 zio_t vq_io_search; /* used as local for stack reduction */
34dc7c2f 125 kmutex_t vq_lock;
9f500936 126 uint64_t vq_lastoffset;
34dc7c2f
BB
127};
128
129/*
130 * Virtual device descriptor
131 */
132struct vdev {
133 /*
134 * Common to all vdev types.
135 */
136 uint64_t vdev_id; /* child number in vdev parent */
137 uint64_t vdev_guid; /* unique ID for this vdev */
138 uint64_t vdev_guid_sum; /* self guid + all child guids */
428870ff 139 uint64_t vdev_orig_guid; /* orig. guid prior to remove */
34dc7c2f 140 uint64_t vdev_asize; /* allocatable device capacity */
9babb374 141 uint64_t vdev_min_asize; /* min acceptable asize */
1bd201e7 142 uint64_t vdev_max_asize; /* max acceptable asize */
34dc7c2f
BB
143 uint64_t vdev_ashift; /* block alignment shift */
144 uint64_t vdev_state; /* see VDEV_STATE_* #defines */
145 uint64_t vdev_prevstate; /* used when reopening a vdev */
146 vdev_ops_t *vdev_ops; /* vdev operations */
147 spa_t *vdev_spa; /* spa for this vdev */
148 void *vdev_tsd; /* type-specific data */
428870ff
BB
149 vnode_t *vdev_name_vp; /* vnode for pathname */
150 vnode_t *vdev_devid_vp; /* vnode for devid */
34dc7c2f
BB
151 vdev_t *vdev_top; /* top-level vdev */
152 vdev_t *vdev_parent; /* parent vdev */
153 vdev_t **vdev_child; /* array of children */
154 uint64_t vdev_children; /* number of children */
34dc7c2f 155 vdev_stat_t vdev_stat; /* virtual device statistics */
193a37cb 156 vdev_stat_ex_t vdev_stat_ex; /* extended statistics */
9babb374 157 boolean_t vdev_expanding; /* expand the vdev? */
428870ff 158 boolean_t vdev_reopening; /* reopen in progress? */
fb40095f 159 boolean_t vdev_nonrot; /* true if solid state */
45d1cae3
BB
160 int vdev_open_error; /* error on last open */
161 kthread_t *vdev_open_thread; /* thread opening children */
428870ff 162 uint64_t vdev_crtxg; /* txg when top-level was added */
34dc7c2f
BB
163
164 /*
165 * Top-level vdev state.
166 */
167 uint64_t vdev_ms_array; /* metaslab array object */
168 uint64_t vdev_ms_shift; /* metaslab size shift */
169 uint64_t vdev_ms_count; /* number of metaslabs */
170 metaslab_group_t *vdev_mg; /* metaslab group */
171 metaslab_t **vdev_ms; /* metaslab array */
920dd524 172 uint64_t vdev_pending_fastwrite; /* allocated fastwrites */
34dc7c2f
BB
173 txg_list_t vdev_ms_list; /* per-txg dirty metaslab lists */
174 txg_list_t vdev_dtl_list; /* per-txg dirty DTL lists */
175 txg_node_t vdev_txg_node; /* per-txg dirty vdev linkage */
176 boolean_t vdev_remove_wanted; /* async remove wanted? */
b128c09f
BB
177 boolean_t vdev_probe_wanted; /* async probe wanted? */
178 list_node_t vdev_config_dirty_node; /* config dirty list */
179 list_node_t vdev_state_dirty_node; /* state dirty list */
34dc7c2f
BB
180 uint64_t vdev_deflate_ratio; /* deflation ratio (x512) */
181 uint64_t vdev_islog; /* is an intent log device */
93cf2076 182 uint64_t vdev_removing; /* device is being removed? */
3dfb57a3
DB
183 boolean_t vdev_ishole; /* is a hole in the namespace */
184 kmutex_t vdev_queue_lock; /* protects vdev_queue_depth */
e0ab3ab5 185 uint64_t vdev_top_zap;
34dc7c2f 186
3dfb57a3
DB
187 /*
188 * The queue depth parameters determine how many async writes are
189 * still pending (i.e. allocated by net yet issued to disk) per
190 * top-level (vdev_async_write_queue_depth) and the maximum allowed
191 * (vdev_max_async_write_queue_depth). These values only apply to
192 * top-level vdevs.
193 */
194 uint64_t vdev_async_write_queue_depth;
195 uint64_t vdev_max_async_write_queue_depth;
196
34dc7c2f
BB
197 /*
198 * Leaf vdev state.
199 */
93cf2076
GW
200 range_tree_t *vdev_dtl[DTL_TYPES]; /* dirty time logs */
201 space_map_t *vdev_dtl_sm; /* dirty time log space map */
34dc7c2f 202 txg_node_t vdev_dtl_node; /* per-txg dirty DTL linkage */
93cf2076
GW
203 uint64_t vdev_dtl_object; /* DTL object */
204 uint64_t vdev_psize; /* physical device capacity */
34dc7c2f
BB
205 uint64_t vdev_wholedisk; /* true if this is a whole disk */
206 uint64_t vdev_offline; /* persistent offline state */
207 uint64_t vdev_faulted; /* persistent faulted state */
208 uint64_t vdev_degraded; /* persistent degraded state */
209 uint64_t vdev_removed; /* persistent removed state */
5d1f7fb6 210 uint64_t vdev_resilver_txg; /* persistent resilvering state */
34dc7c2f
BB
211 uint64_t vdev_nparity; /* number of parity devices for raidz */
212 char *vdev_path; /* vdev path (if any) */
213 char *vdev_devid; /* vdev devid (if any) */
214 char *vdev_physpath; /* vdev device path (if any) */
9babb374 215 char *vdev_fru; /* physical FRU location */
b128c09f
BB
216 uint64_t vdev_not_present; /* not present during import */
217 uint64_t vdev_unspare; /* unspare when resilvering done */
b128c09f
BB
218 boolean_t vdev_nowritecache; /* true if flushwritecache failed */
219 boolean_t vdev_checkremove; /* temporary online test */
220 boolean_t vdev_forcefault; /* force online fault */
428870ff
BB
221 boolean_t vdev_splitting; /* split or repair in progress */
222 boolean_t vdev_delayed_close; /* delayed device close? */
93cf2076
GW
223 boolean_t vdev_tmpoffline; /* device taken offline temporarily? */
224 boolean_t vdev_detached; /* device detached? */
225 boolean_t vdev_cant_read; /* vdev is failing all reads */
226 boolean_t vdev_cant_write; /* vdev is failing all writes */
227 boolean_t vdev_isspare; /* was a hot spare */
228 boolean_t vdev_isl2cache; /* was a l2cache device */
34dc7c2f
BB
229 vdev_queue_t vdev_queue; /* I/O deadline schedule queue */
230 vdev_cache_t vdev_cache; /* physical block cache */
c3520e7f 231 spa_aux_vdev_t *vdev_aux; /* for l2cache and spares vdevs */
b128c09f 232 zio_t *vdev_probe_zio; /* root of current probe */
428870ff 233 vdev_aux_t vdev_label_aux; /* on-disk aux state */
e0ab3ab5 234 uint64_t vdev_leaf_zap;
34dc7c2f
BB
235
236 /*
237 * For DTrace to work in userland (libzpool) context, these fields must
238 * remain at the end of the structure. DTrace will use the kernel's
239 * CTF definition for 'struct vdev', and since the size of a kmutex_t is
9ae529ec 240 * larger in userland, the offsets for the rest of the fields would be
34dc7c2f
BB
241 * incorrect.
242 */
243 kmutex_t vdev_dtl_lock; /* vdev_dtl_{map,resilver} */
244 kmutex_t vdev_stat_lock; /* vdev_stat */
b128c09f 245 kmutex_t vdev_probe_lock; /* protects vdev_probe_zio */
34dc7c2f
BB
246};
247
428870ff
BB
248#define VDEV_RAIDZ_MAXPARITY 3
249
9babb374
BB
250#define VDEV_PAD_SIZE (8 << 10)
251/* 2 padding areas (vl_pad1 and vl_pad2) to skip */
252#define VDEV_SKIP_SIZE VDEV_PAD_SIZE * 2
34dc7c2f
BB
253#define VDEV_PHYS_SIZE (112 << 10)
254#define VDEV_UBERBLOCK_RING (128 << 10)
255
b02fe35d
AR
256/* The largest uberblock we support is 8k. */
257#define MAX_UBERBLOCK_SHIFT (13)
34dc7c2f 258#define VDEV_UBERBLOCK_SHIFT(vd) \
b02fe35d
AR
259 MIN(MAX((vd)->vdev_top->vdev_ashift, UBERBLOCK_SHIFT), \
260 MAX_UBERBLOCK_SHIFT)
34dc7c2f
BB
261#define VDEV_UBERBLOCK_COUNT(vd) \
262 (VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd))
263#define VDEV_UBERBLOCK_OFFSET(vd, n) \
264 offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)])
265#define VDEV_UBERBLOCK_SIZE(vd) (1ULL << VDEV_UBERBLOCK_SHIFT(vd))
266
34dc7c2f 267typedef struct vdev_phys {
428870ff
BB
268 char vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_eck_t)];
269 zio_eck_t vp_zbt;
34dc7c2f
BB
270} vdev_phys_t;
271
272typedef struct vdev_label {
9babb374
BB
273 char vl_pad1[VDEV_PAD_SIZE]; /* 8K */
274 char vl_pad2[VDEV_PAD_SIZE]; /* 8K */
34dc7c2f
BB
275 vdev_phys_t vl_vdev_phys; /* 112K */
276 char vl_uberblock[VDEV_UBERBLOCK_RING]; /* 128K */
277} vdev_label_t; /* 256K total */
278
279/*
280 * vdev_dirty() flags
281 */
282#define VDD_METASLAB 0x01
283#define VDD_DTL 0x02
284
d3cc8b15
WA
285/* Offset of embedded boot loader region on each label */
286#define VDEV_BOOT_OFFSET (2 * sizeof (vdev_label_t))
34dc7c2f 287/*
d3cc8b15 288 * Size of embedded boot loader region on each label.
34dc7c2f
BB
289 * The total size of the first two labels plus the boot area is 4MB.
290 */
d3cc8b15 291#define VDEV_BOOT_SIZE (7ULL << 19) /* 3.5M */
34dc7c2f
BB
292
293/*
294 * Size of label regions at the start and end of each leaf device.
295 */
296#define VDEV_LABEL_START_SIZE (2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE)
297#define VDEV_LABEL_END_SIZE (2 * sizeof (vdev_label_t))
298#define VDEV_LABELS 4
9ae529ec 299#define VDEV_BEST_LABEL VDEV_LABELS
34dc7c2f
BB
300
301#define VDEV_ALLOC_LOAD 0
302#define VDEV_ALLOC_ADD 1
303#define VDEV_ALLOC_SPARE 2
304#define VDEV_ALLOC_L2CACHE 3
9babb374 305#define VDEV_ALLOC_ROOTPOOL 4
428870ff 306#define VDEV_ALLOC_SPLIT 5
5ffb9d1d 307#define VDEV_ALLOC_ATTACH 6
34dc7c2f
BB
308
309/*
310 * Allocate or free a vdev
311 */
428870ff
BB
312extern vdev_t *vdev_alloc_common(spa_t *spa, uint_t id, uint64_t guid,
313 vdev_ops_t *ops);
34dc7c2f
BB
314extern int vdev_alloc(spa_t *spa, vdev_t **vdp, nvlist_t *config,
315 vdev_t *parent, uint_t id, int alloctype);
316extern void vdev_free(vdev_t *vd);
317
318/*
319 * Add or remove children and parents
320 */
321extern void vdev_add_child(vdev_t *pvd, vdev_t *cvd);
322extern void vdev_remove_child(vdev_t *pvd, vdev_t *cvd);
323extern void vdev_compact_children(vdev_t *pvd);
324extern vdev_t *vdev_add_parent(vdev_t *cvd, vdev_ops_t *ops);
325extern void vdev_remove_parent(vdev_t *cvd);
326
327/*
328 * vdev sync load and sync
329 */
428870ff 330extern void vdev_load_log_state(vdev_t *nvd, vdev_t *ovd);
572e2857 331extern boolean_t vdev_log_state_valid(vdev_t *vd);
34dc7c2f 332extern void vdev_load(vdev_t *vd);
93cf2076 333extern int vdev_dtl_load(vdev_t *vd);
34dc7c2f
BB
334extern void vdev_sync(vdev_t *vd, uint64_t txg);
335extern void vdev_sync_done(vdev_t *vd, uint64_t txg);
336extern void vdev_dirty(vdev_t *vd, int flags, void *arg, uint64_t txg);
93cf2076 337extern void vdev_dirty_leaves(vdev_t *vd, int flags, uint64_t txg);
34dc7c2f
BB
338
339/*
340 * Available vdev types.
341 */
342extern vdev_ops_t vdev_root_ops;
343extern vdev_ops_t vdev_mirror_ops;
344extern vdev_ops_t vdev_replacing_ops;
345extern vdev_ops_t vdev_raidz_ops;
346extern vdev_ops_t vdev_disk_ops;
347extern vdev_ops_t vdev_file_ops;
348extern vdev_ops_t vdev_missing_ops;
428870ff 349extern vdev_ops_t vdev_hole_ops;
34dc7c2f
BB
350extern vdev_ops_t vdev_spare_ops;
351
352/*
353 * Common size functions
354 */
355extern uint64_t vdev_default_asize(vdev_t *vd, uint64_t psize);
9babb374
BB
356extern uint64_t vdev_get_min_asize(vdev_t *vd);
357extern void vdev_set_min_asize(vdev_t *vd);
34dc7c2f
BB
358
359/*
d3cc8b15 360 * Global variables
34dc7c2f 361 */
d3cc8b15 362/* zdb uses this tunable, so it must be declared here to make lint happy. */
34dc7c2f
BB
363extern int zfs_vdev_cache_size;
364
365#ifdef __cplusplus
366}
367#endif
368
369#endif /* _SYS_VDEV_IMPL_H */