xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/vdev.h (revision 088f389458728c464569a5506b58070254fa4f7d)
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  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_VDEV_H
27 #define	_SYS_VDEV_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/spa.h>
32 #include <sys/zio.h>
33 #include <sys/dmu.h>
34 #include <sys/space_map.h>
35 #include <sys/fs/zfs.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 extern boolean_t zfs_nocacheflush;
42 
43 /*
44  * Fault injection modes.
45  */
46 #define	VDEV_FAULT_NONE		0
47 #define	VDEV_FAULT_RANDOM	1
48 #define	VDEV_FAULT_COUNT	2
49 
50 extern int vdev_open(vdev_t *);
51 extern int vdev_validate(vdev_t *);
52 extern void vdev_close(vdev_t *);
53 extern int vdev_create(vdev_t *, uint64_t txg, boolean_t isreplace);
54 extern void vdev_init(vdev_t *, uint64_t txg);
55 extern void vdev_reopen(vdev_t *);
56 extern int vdev_validate_aux(vdev_t *vd);
57 extern int vdev_probe(vdev_t *);
58 
59 extern boolean_t vdev_is_bootable(vdev_t *vd);
60 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
61 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
62 extern void vdev_dtl_dirty(space_map_t *sm, uint64_t txg, uint64_t size);
63 extern int vdev_dtl_contains(space_map_t *sm, uint64_t txg, uint64_t size);
64 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
65     int scrub_done);
66 extern boolean_t vdev_resilver_needed(vdev_t *vd,
67     uint64_t *minp, uint64_t *maxp);
68 
69 extern const char *vdev_description(vdev_t *vd);
70 
71 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
72 extern void vdev_metaslab_fini(vdev_t *vd);
73 
74 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
75 extern void vdev_clear_stats(vdev_t *vd);
76 extern void vdev_stat_update(zio_t *zio);
77 extern void vdev_scrub_stat_update(vdev_t *vd, pool_scrub_type_t type,
78     boolean_t complete);
79 extern int vdev_getspec(spa_t *spa, uint64_t vdev, char **vdev_spec);
80 extern void vdev_propagate_state(vdev_t *vd);
81 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
82     vdev_aux_t aux);
83 
84 extern void vdev_space_update(vdev_t *vd, int64_t space_delta,
85     int64_t alloc_delta, boolean_t update_root);
86 
87 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
88 
89 extern int vdev_fault(spa_t *spa, uint64_t guid);
90 extern int vdev_degrade(spa_t *spa, uint64_t guid);
91 extern int vdev_online(spa_t *spa, uint64_t guid, uint64_t flags,
92     vdev_state_t *);
93 extern int vdev_offline(spa_t *spa, uint64_t guid, uint64_t flags);
94 extern void vdev_clear(spa_t *spa, vdev_t *vd, boolean_t reopen_wanted);
95 
96 extern int vdev_error_inject(vdev_t *vd, zio_t *zio);
97 extern int vdev_is_dead(vdev_t *vd);
98 extern int vdev_readable(vdev_t *vd);
99 extern int vdev_writeable(vdev_t *vd);
100 
101 extern void vdev_cache_init(vdev_t *vd);
102 extern void vdev_cache_fini(vdev_t *vd);
103 extern int vdev_cache_read(zio_t *zio);
104 extern void vdev_cache_write(zio_t *zio);
105 extern void vdev_cache_purge(vdev_t *vd);
106 
107 extern void vdev_queue_init(vdev_t *vd);
108 extern void vdev_queue_fini(vdev_t *vd);
109 extern zio_t *vdev_queue_io(zio_t *zio);
110 extern void vdev_queue_io_done(zio_t *zio);
111 
112 extern void vdev_config_dirty(vdev_t *vd);
113 extern void vdev_config_clean(vdev_t *vd);
114 extern void vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg);
115 
116 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
117     boolean_t getstats, boolean_t isspare, boolean_t isl2cache);
118 
119 /*
120  * Label routines
121  */
122 struct uberblock;
123 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
124 extern int vdev_label_number(uint64_t psise, uint64_t offset);
125 extern nvlist_t *vdev_label_read_config(vdev_t *vd);
126 extern void vdev_uberblock_load(zio_t *zio, vdev_t *vd, struct uberblock *ub);
127 
128 typedef enum {
129 	VDEV_LABEL_CREATE,	/* create/add a new device */
130 	VDEV_LABEL_REPLACE,	/* replace an existing device */
131 	VDEV_LABEL_SPARE,	/* add a new hot spare */
132 	VDEV_LABEL_REMOVE,	/* remove an existing device */
133 	VDEV_LABEL_L2CACHE	/* add an L2ARC cache device */
134 } vdev_labeltype_t;
135 
136 extern int vdev_label_init(vdev_t *vd, uint64_t txg, vdev_labeltype_t reason);
137 
138 #ifdef	__cplusplus
139 }
140 #endif
141 
142 #endif	/* _SYS_VDEV_H */
143