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 https://opensource.org/licenses/CDDL-1.0.
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, 2020 by Delphix. All rights reserved.
25 * Copyright (c) 2017, Intel Corporation.
26 * Copyright (c) 2019, Datto Inc. All rights reserved.
27 */
28
29 #ifndef _SYS_VDEV_H
30 #define _SYS_VDEV_H
31
32 #include <sys/spa.h>
33 #include <sys/zio.h>
34 #include <sys/dmu.h>
35 #include <sys/space_map.h>
36 #include <sys/metaslab.h>
37 #include <sys/fs/zfs.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 typedef enum vdev_dtl_type {
44 DTL_MISSING, /* 0% replication: no copies of the data */
45 DTL_PARTIAL, /* less than 100% replication: some copies missing */
46 DTL_SCRUB, /* unable to fully repair during scrub/resilver */
47 DTL_OUTAGE, /* temporarily missing (used to attempt detach) */
48 DTL_TYPES
49 } vdev_dtl_type_t;
50
51 extern int zfs_nocacheflush;
52
53 typedef boolean_t vdev_open_children_func_t(vdev_t *vd);
54
55 extern void vdev_dbgmsg(vdev_t *vd, const char *fmt, ...)
56 __attribute__((format(printf, 2, 3)));
57 extern void vdev_dbgmsg_print_tree(vdev_t *, int);
58 extern int vdev_open(vdev_t *);
59 extern void vdev_open_children(vdev_t *);
60 extern void vdev_open_children_subset(vdev_t *, vdev_open_children_func_t *);
61 extern int vdev_validate(vdev_t *);
62 extern int vdev_copy_path_strict(vdev_t *, vdev_t *);
63 extern void vdev_copy_path_relaxed(vdev_t *, vdev_t *);
64 extern void vdev_close(vdev_t *);
65 extern int vdev_create(vdev_t *, uint64_t txg, boolean_t isreplace);
66 extern void vdev_reopen(vdev_t *);
67 extern int vdev_validate_aux(vdev_t *vd);
68 extern zio_t *vdev_probe(vdev_t *vd, zio_t *pio);
69 extern boolean_t vdev_is_concrete(vdev_t *vd);
70 extern boolean_t vdev_is_bootable(vdev_t *vd);
71 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
72 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
73 extern int vdev_count_leaves(spa_t *spa);
74 extern void vdev_dtl_dirty(vdev_t *vd, vdev_dtl_type_t d,
75 uint64_t txg, uint64_t size);
76 extern boolean_t vdev_dtl_contains(vdev_t *vd, vdev_dtl_type_t d,
77 uint64_t txg, uint64_t size);
78 extern boolean_t vdev_dtl_empty(vdev_t *vd, vdev_dtl_type_t d);
79 extern boolean_t vdev_default_need_resilver(vdev_t *vd, const dva_t *dva,
80 size_t psize, uint64_t phys_birth);
81 extern boolean_t vdev_dtl_need_resilver(vdev_t *vd, const dva_t *dva,
82 size_t psize, uint64_t phys_birth);
83 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
84 boolean_t scrub_done, boolean_t rebuild_done);
85 extern boolean_t vdev_dtl_required(vdev_t *vd);
86 extern boolean_t vdev_resilver_needed(vdev_t *vd,
87 uint64_t *minp, uint64_t *maxp);
88 extern void vdev_destroy_unlink_zap(vdev_t *vd, uint64_t zapobj,
89 dmu_tx_t *tx);
90 extern uint64_t vdev_create_link_zap(vdev_t *vd, dmu_tx_t *tx);
91 extern void vdev_construct_zaps(vdev_t *vd, dmu_tx_t *tx);
92 extern void vdev_destroy_spacemaps(vdev_t *vd, dmu_tx_t *tx);
93 extern void vdev_indirect_mark_obsolete(vdev_t *vd, uint64_t offset,
94 uint64_t size);
95 extern void spa_vdev_indirect_mark_obsolete(spa_t *spa, uint64_t vdev,
96 uint64_t offset, uint64_t size, dmu_tx_t *tx);
97 extern boolean_t vdev_replace_in_progress(vdev_t *vdev);
98
99 extern void vdev_hold(vdev_t *);
100 extern void vdev_rele(vdev_t *);
101
102 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
103 extern void vdev_metaslab_fini(vdev_t *vd);
104 extern void vdev_metaslab_set_size(vdev_t *);
105 extern void vdev_expand(vdev_t *vd, uint64_t txg);
106 extern void vdev_split(vdev_t *vd);
107 extern void vdev_deadman(vdev_t *vd, const char *tag);
108
109 typedef void vdev_xlate_func_t(void *arg, range_seg64_t *physical_rs);
110
111 extern boolean_t vdev_xlate_is_empty(range_seg64_t *rs);
112 extern void vdev_xlate(vdev_t *vd, const range_seg64_t *logical_rs,
113 range_seg64_t *physical_rs, range_seg64_t *remain_rs);
114 extern void vdev_xlate_walk(vdev_t *vd, const range_seg64_t *logical_rs,
115 vdev_xlate_func_t *func, void *arg);
116
117 extern void vdev_get_stats_ex(vdev_t *vd, vdev_stat_t *vs, vdev_stat_ex_t *vsx);
118
119 extern metaslab_group_t *vdev_get_mg(vdev_t *vd, metaslab_class_t *mc);
120
121 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
122 extern void vdev_clear_stats(vdev_t *vd);
123 extern void vdev_stat_update(zio_t *zio, uint64_t psize);
124 extern void vdev_scan_stat_init(vdev_t *vd);
125 extern void vdev_propagate_state(vdev_t *vd);
126 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
127 vdev_aux_t aux);
128 extern boolean_t vdev_children_are_offline(vdev_t *vd);
129
130 extern void vdev_space_update(vdev_t *vd,
131 int64_t alloc_delta, int64_t defer_delta, int64_t space_delta);
132
133 extern int64_t vdev_deflated_space(vdev_t *vd, int64_t space);
134
135 extern uint64_t vdev_psize_to_asize_txg(vdev_t *vd, uint64_t psize,
136 uint64_t txg);
137 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
138
139 /*
140 * Return the amount of space allocated for a gang block header. Note that
141 * since the physical birth txg is not provided, this must be constant for
142 * a given vdev. (e.g. raidz expansion can't change this)
143 */
144 static inline uint64_t
vdev_gang_header_asize(vdev_t * vd)145 vdev_gang_header_asize(vdev_t *vd)
146 {
147 return (vdev_psize_to_asize_txg(vd, SPA_GANGBLOCKSIZE, 0));
148 }
149
150 extern int vdev_fault(spa_t *spa, uint64_t guid, vdev_aux_t aux);
151 extern int vdev_degrade(spa_t *spa, uint64_t guid, vdev_aux_t aux);
152 extern int vdev_online(spa_t *spa, uint64_t guid, uint64_t flags,
153 vdev_state_t *);
154 extern int vdev_offline(spa_t *spa, uint64_t guid, uint64_t flags);
155 extern int vdev_remove_wanted(spa_t *spa, uint64_t guid);
156 extern void vdev_clear(spa_t *spa, vdev_t *vd);
157
158 extern boolean_t vdev_is_dead(vdev_t *vd);
159 extern boolean_t vdev_readable(vdev_t *vd);
160 extern boolean_t vdev_writeable(vdev_t *vd);
161 extern boolean_t vdev_allocatable(vdev_t *vd);
162 extern boolean_t vdev_accessible(vdev_t *vd, zio_t *zio);
163 extern boolean_t vdev_is_spacemap_addressable(vdev_t *vd);
164
165 extern void vdev_queue_init(vdev_t *vd);
166 extern void vdev_queue_fini(vdev_t *vd);
167 extern zio_t *vdev_queue_io(zio_t *zio);
168 extern void vdev_queue_io_done(zio_t *zio);
169 extern void vdev_queue_change_io_priority(zio_t *zio, zio_priority_t priority);
170
171 extern uint32_t vdev_queue_length(vdev_t *vd);
172 extern uint64_t vdev_queue_last_offset(vdev_t *vd);
173 extern uint64_t vdev_queue_class_length(vdev_t *vq, zio_priority_t p);
174
175 extern void vdev_config_dirty(vdev_t *vd);
176 extern void vdev_config_clean(vdev_t *vd);
177 extern int vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg);
178
179 extern void vdev_state_dirty(vdev_t *vd);
180 extern void vdev_state_clean(vdev_t *vd);
181
182 extern void vdev_defer_resilver(vdev_t *vd);
183 extern boolean_t vdev_clear_resilver_deferred(vdev_t *vd, dmu_tx_t *tx);
184
185 typedef enum vdev_config_flag {
186 VDEV_CONFIG_SPARE = 1 << 0,
187 VDEV_CONFIG_L2CACHE = 1 << 1,
188 VDEV_CONFIG_MOS = 1 << 2,
189 VDEV_CONFIG_MISSING = 1 << 3
190 } vdev_config_flag_t;
191
192 extern void vdev_post_kobj_evt(vdev_t *vd);
193 extern void vdev_clear_kobj_evt(vdev_t *vd);
194 extern void vdev_top_config_generate(spa_t *spa, nvlist_t *config);
195 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
196 boolean_t getstats, vdev_config_flag_t flags);
197
198 /*
199 * Label routines
200 */
201 struct uberblock;
202 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
203 extern int vdev_label_number(uint64_t psise, uint64_t offset);
204 extern nvlist_t *vdev_label_read_config(vdev_t *vd, uint64_t txg);
205 extern void vdev_uberblock_load(vdev_t *, struct uberblock *, nvlist_t **);
206 extern void vdev_config_generate_stats(vdev_t *vd, nvlist_t *nv);
207 extern void vdev_label_write(zio_t *zio, vdev_t *vd, int l, abd_t *buf, uint64_t
208 offset, uint64_t size, zio_done_func_t *done, void *priv, int flags);
209 extern int vdev_label_read_bootenv(vdev_t *, nvlist_t *);
210 extern int vdev_label_write_bootenv(vdev_t *, nvlist_t *);
211 extern int vdev_uberblock_sync_list(vdev_t **, int, struct uberblock *, int);
212 extern int vdev_check_boot_reserve(spa_t *, vdev_t *);
213
214 typedef enum {
215 VDEV_LABEL_CREATE, /* create/add a new device */
216 VDEV_LABEL_REPLACE, /* replace an existing device */
217 VDEV_LABEL_SPARE, /* add a new hot spare */
218 VDEV_LABEL_REMOVE, /* remove an existing device */
219 VDEV_LABEL_L2CACHE, /* add an L2ARC cache device */
220 VDEV_LABEL_SPLIT /* generating new label for split-off dev */
221 } vdev_labeltype_t;
222
223 extern int vdev_label_init(vdev_t *vd, uint64_t txg, vdev_labeltype_t reason);
224
225 extern int vdev_prop_set(vdev_t *vd, nvlist_t *innvl, nvlist_t *outnvl);
226 extern int vdev_prop_get(vdev_t *vd, nvlist_t *nvprops, nvlist_t *outnvl);
227
228 #ifdef __cplusplus
229 }
230 #endif
231
232 #endif /* _SYS_VDEV_H */
233