xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/vdev.h (revision cbab2b2687744cbfdc12fae90f8088127a0b266c)
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 2006 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 /*
42  * Vdev knobs.
43  */
44 typedef struct vdev_knob {
45 	char		*vk_name;		/* knob name		*/
46 	char		*vk_desc;		/* knob description	*/
47 	uint64_t	vk_min;			/* minimum legal value	*/
48 	uint64_t	vk_max;			/* maximum legal value	*/
49 	uint64_t	vk_default;		/* default value	*/
50 	size_t		vk_offset;		/* offset into vdev_t	*/
51 } vdev_knob_t;
52 
53 /*
54  * Fault injection modes.
55  */
56 #define	VDEV_FAULT_NONE		0
57 #define	VDEV_FAULT_RANDOM	1
58 #define	VDEV_FAULT_COUNT	2
59 
60 extern int vdev_open(vdev_t *);
61 extern int vdev_validate(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_init(vdev_t *, uint64_t txg);
65 extern void vdev_reopen(vdev_t *);
66 extern int vdev_validate_spare(vdev_t *);
67 
68 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
69 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
70 extern void vdev_dtl_dirty(space_map_t *sm, uint64_t txg, uint64_t size);
71 extern int vdev_dtl_contains(space_map_t *sm, uint64_t txg, uint64_t size);
72 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
73     int scrub_done);
74 
75 extern const char *vdev_description(vdev_t *vd);
76 
77 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
78 extern void vdev_metaslab_fini(vdev_t *vd);
79 
80 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
81 extern void vdev_stat_update(zio_t *zio);
82 extern void vdev_scrub_stat_update(vdev_t *vd, pool_scrub_type_t type,
83     boolean_t complete);
84 extern int vdev_getspec(spa_t *spa, uint64_t vdev, char **vdev_spec);
85 extern void vdev_propagate_state(vdev_t *vd);
86 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
87     vdev_aux_t aux);
88 
89 extern void vdev_space_update(vdev_t *vd, int64_t space_delta,
90     int64_t alloc_delta);
91 
92 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
93 
94 extern void vdev_io_start(zio_t *zio);
95 extern void vdev_io_done(zio_t *zio);
96 
97 extern int vdev_online(spa_t *spa, uint64_t guid);
98 extern int vdev_offline(spa_t *spa, uint64_t guid, int istmp);
99 extern void vdev_clear(spa_t *spa, vdev_t *vd);
100 
101 extern int vdev_error_inject(vdev_t *vd, zio_t *zio);
102 extern int vdev_is_dead(vdev_t *vd);
103 
104 extern void vdev_cache_init(vdev_t *vd);
105 extern void vdev_cache_fini(vdev_t *vd);
106 extern int vdev_cache_read(zio_t *zio);
107 extern void vdev_cache_write(zio_t *zio);
108 
109 extern void vdev_queue_init(vdev_t *vd);
110 extern void vdev_queue_fini(vdev_t *vd);
111 extern zio_t *vdev_queue_io(zio_t *zio);
112 extern void vdev_queue_io_done(zio_t *zio);
113 
114 extern vdev_knob_t *vdev_knob_next(vdev_knob_t *vk);
115 
116 extern void vdev_config_dirty(vdev_t *vd);
117 extern void vdev_config_clean(vdev_t *vd);
118 extern int vdev_config_sync(vdev_t *vd, uint64_t txg);
119 
120 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
121     boolean_t getstats, boolean_t isspare);
122 
123 /*
124  * Label routines
125  */
126 struct uberblock;
127 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
128 extern nvlist_t *vdev_label_read_config(vdev_t *vd);
129 extern void vdev_uberblock_load(zio_t *zio, vdev_t *vd, struct uberblock *ub);
130 int vdev_label_init(vdev_t *vd, uint64_t create_txg, boolean_t isreplacing);
131 int vdev_label_spare(vdev_t *vd, uint64_t create_txg);
132 
133 #ifdef	__cplusplus
134 }
135 #endif
136 
137 #endif	/* _SYS_VDEV_H */
138