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, 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/fs/zfs.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 typedef enum vdev_dtl_type {
43 	DTL_MISSING,	/* 0% replication: no copies of the data */
44 	DTL_PARTIAL,	/* less than 100% replication: some copies missing */
45 	DTL_SCRUB,	/* unable to fully repair during scrub/resilver */
46 	DTL_OUTAGE,	/* temporarily missing (used to attempt detach) */
47 	DTL_TYPES
48 } vdev_dtl_type_t;
49 
50 extern int zfs_nocacheflush;
51 
52 typedef boolean_t vdev_open_children_func_t(vdev_t *vd);
53 
54 extern void vdev_dbgmsg(vdev_t *vd, const char *fmt, ...);
55 extern void vdev_dbgmsg_print_tree(vdev_t *, int);
56 extern int vdev_open(vdev_t *);
57 extern void vdev_open_children(vdev_t *);
58 extern void vdev_open_children_subset(vdev_t *, vdev_open_children_func_t *);
59 extern int vdev_validate(vdev_t *);
60 extern int vdev_copy_path_strict(vdev_t *, vdev_t *);
61 extern void vdev_copy_path_relaxed(vdev_t *, vdev_t *);
62 extern void vdev_close(vdev_t *);
63 extern int vdev_create(vdev_t *, uint64_t txg, boolean_t isreplace);
64 extern void vdev_reopen(vdev_t *);
65 extern int vdev_validate_aux(vdev_t *vd);
66 extern zio_t *vdev_probe(vdev_t *vd, zio_t *pio);
67 extern boolean_t vdev_is_concrete(vdev_t *vd);
68 extern boolean_t vdev_is_bootable(vdev_t *vd);
69 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
70 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
71 extern int vdev_count_leaves(spa_t *spa);
72 extern void vdev_dtl_dirty(vdev_t *vd, vdev_dtl_type_t d,
73     uint64_t txg, uint64_t size);
74 extern boolean_t vdev_dtl_contains(vdev_t *vd, vdev_dtl_type_t d,
75     uint64_t txg, uint64_t size);
76 extern boolean_t vdev_dtl_empty(vdev_t *vd, vdev_dtl_type_t d);
77 extern boolean_t vdev_default_need_resilver(vdev_t *vd, const dva_t *dva,
78     size_t psize, uint64_t phys_birth);
79 extern boolean_t vdev_dtl_need_resilver(vdev_t *vd, const dva_t *dva,
80     size_t psize, uint64_t phys_birth);
81 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
82     boolean_t scrub_done, boolean_t rebuild_done);
83 extern boolean_t vdev_dtl_required(vdev_t *vd);
84 extern boolean_t vdev_resilver_needed(vdev_t *vd,
85     uint64_t *minp, uint64_t *maxp);
86 extern void vdev_destroy_unlink_zap(vdev_t *vd, uint64_t zapobj,
87     dmu_tx_t *tx);
88 extern uint64_t vdev_create_link_zap(vdev_t *vd, dmu_tx_t *tx);
89 extern void vdev_construct_zaps(vdev_t *vd, dmu_tx_t *tx);
90 extern void vdev_destroy_spacemaps(vdev_t *vd, dmu_tx_t *tx);
91 extern void vdev_indirect_mark_obsolete(vdev_t *vd, uint64_t offset,
92     uint64_t size);
93 extern void spa_vdev_indirect_mark_obsolete(spa_t *spa, uint64_t vdev,
94     uint64_t offset, uint64_t size, dmu_tx_t *tx);
95 extern boolean_t vdev_replace_in_progress(vdev_t *vdev);
96 
97 extern void vdev_hold(vdev_t *);
98 extern void vdev_rele(vdev_t *);
99 
100 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
101 extern void vdev_metaslab_fini(vdev_t *vd);
102 extern void vdev_metaslab_set_size(vdev_t *);
103 extern void vdev_expand(vdev_t *vd, uint64_t txg);
104 extern void vdev_split(vdev_t *vd);
105 extern void vdev_deadman(vdev_t *vd, char *tag);
106 
107 typedef void vdev_xlate_func_t(void *arg, range_seg64_t *physical_rs);
108 
109 extern boolean_t vdev_xlate_is_empty(range_seg64_t *rs);
110 extern void vdev_xlate(vdev_t *vd, const range_seg64_t *logical_rs,
111     range_seg64_t *physical_rs, range_seg64_t *remain_rs);
112 extern void vdev_xlate_walk(vdev_t *vd, const range_seg64_t *logical_rs,
113     vdev_xlate_func_t *func, void *arg);
114 
115 extern void vdev_get_stats_ex(vdev_t *vd, vdev_stat_t *vs, vdev_stat_ex_t *vsx);
116 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
117 extern void vdev_clear_stats(vdev_t *vd);
118 extern void vdev_stat_update(zio_t *zio, uint64_t psize);
119 extern void vdev_scan_stat_init(vdev_t *vd);
120 extern void vdev_propagate_state(vdev_t *vd);
121 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
122     vdev_aux_t aux);
123 extern boolean_t vdev_children_are_offline(vdev_t *vd);
124 
125 extern void vdev_space_update(vdev_t *vd,
126     int64_t alloc_delta, int64_t defer_delta, int64_t space_delta);
127 
128 extern int64_t vdev_deflated_space(vdev_t *vd, int64_t space);
129 
130 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
131 
132 extern int vdev_fault(spa_t *spa, uint64_t guid, vdev_aux_t aux);
133 extern int vdev_degrade(spa_t *spa, uint64_t guid, vdev_aux_t aux);
134 extern int vdev_online(spa_t *spa, uint64_t guid, uint64_t flags,
135     vdev_state_t *);
136 extern int vdev_offline(spa_t *spa, uint64_t guid, uint64_t flags);
137 extern void vdev_clear(spa_t *spa, vdev_t *vd);
138 
139 extern boolean_t vdev_is_dead(vdev_t *vd);
140 extern boolean_t vdev_readable(vdev_t *vd);
141 extern boolean_t vdev_writeable(vdev_t *vd);
142 extern boolean_t vdev_allocatable(vdev_t *vd);
143 extern boolean_t vdev_accessible(vdev_t *vd, zio_t *zio);
144 extern boolean_t vdev_is_spacemap_addressable(vdev_t *vd);
145 
146 extern void vdev_cache_init(vdev_t *vd);
147 extern void vdev_cache_fini(vdev_t *vd);
148 extern boolean_t vdev_cache_read(zio_t *zio);
149 extern void vdev_cache_write(zio_t *zio);
150 extern void vdev_cache_purge(vdev_t *vd);
151 
152 extern void vdev_queue_init(vdev_t *vd);
153 extern void vdev_queue_fini(vdev_t *vd);
154 extern zio_t *vdev_queue_io(zio_t *zio);
155 extern void vdev_queue_io_done(zio_t *zio);
156 extern void vdev_queue_change_io_priority(zio_t *zio, zio_priority_t priority);
157 
158 extern int vdev_queue_length(vdev_t *vd);
159 extern uint64_t vdev_queue_last_offset(vdev_t *vd);
160 
161 extern void vdev_config_dirty(vdev_t *vd);
162 extern void vdev_config_clean(vdev_t *vd);
163 extern int vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg);
164 
165 extern void vdev_state_dirty(vdev_t *vd);
166 extern void vdev_state_clean(vdev_t *vd);
167 
168 extern void vdev_defer_resilver(vdev_t *vd);
169 extern boolean_t vdev_clear_resilver_deferred(vdev_t *vd, dmu_tx_t *tx);
170 
171 typedef enum vdev_config_flag {
172 	VDEV_CONFIG_SPARE = 1 << 0,
173 	VDEV_CONFIG_L2CACHE = 1 << 1,
174 	VDEV_CONFIG_REMOVING = 1 << 2,
175 	VDEV_CONFIG_MOS = 1 << 3,
176 	VDEV_CONFIG_MISSING = 1 << 4
177 } vdev_config_flag_t;
178 
179 extern void vdev_top_config_generate(spa_t *spa, nvlist_t *config);
180 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
181     boolean_t getstats, vdev_config_flag_t flags);
182 
183 /*
184  * Label routines
185  */
186 struct uberblock;
187 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
188 extern int vdev_label_number(uint64_t psise, uint64_t offset);
189 extern nvlist_t *vdev_label_read_config(vdev_t *vd, uint64_t txg);
190 extern void vdev_uberblock_load(vdev_t *, struct uberblock *, nvlist_t **);
191 extern void vdev_config_generate_stats(vdev_t *vd, nvlist_t *nv);
192 extern void vdev_label_write(zio_t *zio, vdev_t *vd, int l, abd_t *buf, uint64_t
193     offset, uint64_t size, zio_done_func_t *done, void *priv, int flags);
194 extern int vdev_label_read_bootenv(vdev_t *, nvlist_t *);
195 extern int vdev_label_write_bootenv(vdev_t *, nvlist_t *);
196 
197 typedef enum {
198 	VDEV_LABEL_CREATE,	/* create/add a new device */
199 	VDEV_LABEL_REPLACE,	/* replace an existing device */
200 	VDEV_LABEL_SPARE,	/* add a new hot spare */
201 	VDEV_LABEL_REMOVE,	/* remove an existing device */
202 	VDEV_LABEL_L2CACHE,	/* add an L2ARC cache device */
203 	VDEV_LABEL_SPLIT	/* generating new label for split-off dev */
204 } vdev_labeltype_t;
205 
206 extern int vdev_label_init(vdev_t *vd, uint64_t txg, vdev_labeltype_t reason);
207 
208 #ifdef	__cplusplus
209 }
210 #endif
211 
212 #endif	/* _SYS_VDEV_H */
213