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