xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/vdev.h (revision 6f7938128a2c5e23f4b970ea101137eadd1470a1)
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 
22 /*
23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
25  */
26 
27 #ifndef _SYS_VDEV_H
28 #define	_SYS_VDEV_H
29 
30 #include <sys/spa.h>
31 #include <sys/zio.h>
32 #include <sys/dmu.h>
33 #include <sys/space_map.h>
34 #include <sys/fs/zfs.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 typedef enum vdev_dtl_type {
41 	DTL_MISSING,	/* 0% replication: no copies of the data */
42 	DTL_PARTIAL,	/* less than 100% replication: some copies missing */
43 	DTL_SCRUB,	/* unable to fully repair during scrub/resilver */
44 	DTL_OUTAGE,	/* temporarily missing (used to attempt detach) */
45 	DTL_TYPES
46 } vdev_dtl_type_t;
47 
48 extern boolean_t zfs_nocacheflush;
49 
50 extern void vdev_dbgmsg(vdev_t *vd, const char *fmt, ...);
51 extern void vdev_dbgmsg_print_tree(vdev_t *, int);
52 extern int vdev_open(vdev_t *);
53 extern void vdev_open_children(vdev_t *);
54 extern boolean_t vdev_uses_zvols(vdev_t *);
55 extern int vdev_validate(vdev_t *);
56 extern int vdev_copy_path_strict(vdev_t *, vdev_t *);
57 extern void vdev_copy_path_relaxed(vdev_t *, vdev_t *);
58 extern void vdev_close(vdev_t *);
59 extern int vdev_create(vdev_t *, uint64_t txg, boolean_t isreplace);
60 extern void vdev_reopen(vdev_t *);
61 extern int vdev_validate_aux(vdev_t *vd);
62 extern zio_t *vdev_probe(vdev_t *vd, zio_t *pio);
63 extern boolean_t vdev_is_concrete(vdev_t *vd);
64 extern boolean_t vdev_is_bootable(vdev_t *vd);
65 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
66 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
67 extern int vdev_count_leaves(spa_t *spa);
68 extern void vdev_dtl_dirty(vdev_t *vd, vdev_dtl_type_t d,
69     uint64_t txg, uint64_t size);
70 extern boolean_t vdev_dtl_contains(vdev_t *vd, vdev_dtl_type_t d,
71     uint64_t txg, uint64_t size);
72 extern boolean_t vdev_dtl_empty(vdev_t *vd, vdev_dtl_type_t d);
73 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
74     int scrub_done);
75 extern boolean_t vdev_dtl_required(vdev_t *vd);
76 extern boolean_t vdev_resilver_needed(vdev_t *vd,
77     uint64_t *minp, uint64_t *maxp);
78 extern void vdev_destroy_unlink_zap(vdev_t *vd, uint64_t zapobj,
79     dmu_tx_t *tx);
80 extern uint64_t vdev_create_link_zap(vdev_t *vd, dmu_tx_t *tx);
81 extern void vdev_construct_zaps(vdev_t *vd, dmu_tx_t *tx);
82 extern void vdev_destroy_spacemaps(vdev_t *vd, dmu_tx_t *tx);
83 extern void vdev_indirect_mark_obsolete(vdev_t *vd, uint64_t offset,
84     uint64_t size, uint64_t txg);
85 extern void spa_vdev_indirect_mark_obsolete(spa_t *spa, uint64_t vdev,
86     uint64_t offset, uint64_t size, dmu_tx_t *tx);
87 
88 extern void vdev_hold(vdev_t *);
89 extern void vdev_rele(vdev_t *);
90 
91 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
92 extern void vdev_metaslab_fini(vdev_t *vd);
93 extern void vdev_metaslab_set_size(vdev_t *);
94 extern void vdev_expand(vdev_t *vd, uint64_t txg);
95 extern void vdev_split(vdev_t *vd);
96 extern void vdev_deadman(vdev_t *vd);
97 
98 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
99 extern void vdev_clear_stats(vdev_t *vd);
100 extern void vdev_stat_update(zio_t *zio, uint64_t psize);
101 extern void vdev_scan_stat_init(vdev_t *vd);
102 extern void vdev_propagate_state(vdev_t *vd);
103 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
104     vdev_aux_t aux);
105 extern boolean_t vdev_children_are_offline(vdev_t *vd);
106 
107 extern void vdev_space_update(vdev_t *vd,
108     int64_t alloc_delta, int64_t defer_delta, int64_t space_delta);
109 
110 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
111 
112 extern int vdev_fault(spa_t *spa, uint64_t guid, vdev_aux_t aux);
113 extern int vdev_degrade(spa_t *spa, uint64_t guid, vdev_aux_t aux);
114 extern int vdev_online(spa_t *spa, uint64_t guid, uint64_t flags,
115     vdev_state_t *);
116 extern int vdev_offline(spa_t *spa, uint64_t guid, uint64_t flags);
117 extern void vdev_clear(spa_t *spa, vdev_t *vd);
118 
119 extern boolean_t vdev_is_dead(vdev_t *vd);
120 extern boolean_t vdev_readable(vdev_t *vd);
121 extern boolean_t vdev_writeable(vdev_t *vd);
122 extern boolean_t vdev_allocatable(vdev_t *vd);
123 extern boolean_t vdev_accessible(vdev_t *vd, zio_t *zio);
124 
125 extern void vdev_cache_init(vdev_t *vd);
126 extern void vdev_cache_fini(vdev_t *vd);
127 extern boolean_t vdev_cache_read(zio_t *zio);
128 extern void vdev_cache_write(zio_t *zio);
129 extern void vdev_cache_purge(vdev_t *vd);
130 
131 extern void vdev_queue_init(vdev_t *vd);
132 extern void vdev_queue_fini(vdev_t *vd);
133 extern zio_t *vdev_queue_io(zio_t *zio);
134 extern void vdev_queue_io_done(zio_t *zio);
135 
136 extern void vdev_config_dirty(vdev_t *vd);
137 extern void vdev_config_clean(vdev_t *vd);
138 extern int vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg);
139 
140 extern void vdev_state_dirty(vdev_t *vd);
141 extern void vdev_state_clean(vdev_t *vd);
142 
143 typedef enum vdev_config_flag {
144 	VDEV_CONFIG_SPARE = 1 << 0,
145 	VDEV_CONFIG_L2CACHE = 1 << 1,
146 	VDEV_CONFIG_REMOVING = 1 << 2,
147 	VDEV_CONFIG_MOS = 1 << 3,
148 	VDEV_CONFIG_MISSING = 1 << 4
149 } vdev_config_flag_t;
150 
151 extern void vdev_top_config_generate(spa_t *spa, nvlist_t *config);
152 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
153     boolean_t getstats, vdev_config_flag_t flags);
154 
155 /*
156  * Label routines
157  */
158 struct uberblock;
159 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
160 extern int vdev_label_number(uint64_t psise, uint64_t offset);
161 extern nvlist_t *vdev_label_read_config(vdev_t *vd, uint64_t txg);
162 extern void vdev_uberblock_load(vdev_t *, struct uberblock *, nvlist_t **);
163 
164 typedef enum {
165 	VDEV_LABEL_CREATE,	/* create/add a new device */
166 	VDEV_LABEL_REPLACE,	/* replace an existing device */
167 	VDEV_LABEL_SPARE,	/* add a new hot spare */
168 	VDEV_LABEL_REMOVE,	/* remove an existing device */
169 	VDEV_LABEL_L2CACHE,	/* add an L2ARC cache device */
170 	VDEV_LABEL_SPLIT	/* generating new label for split-off dev */
171 } vdev_labeltype_t;
172 
173 extern int vdev_label_init(vdev_t *vd, uint64_t txg, vdev_labeltype_t reason);
174 
175 #ifdef	__cplusplus
176 }
177 #endif
178 
179 #endif	/* _SYS_VDEV_H */
180