xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/vdev.h (revision a07094369b21309434206d9b3601d162693466fc)
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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
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  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_VDEV_H
28 #define	_SYS_VDEV_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
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 /*
43  * Vdev knobs.
44  */
45 typedef struct vdev_knob {
46 	char		*vk_name;		/* knob name		*/
47 	char		*vk_desc;		/* knob description	*/
48 	uint64_t	vk_min;			/* minimum legal value	*/
49 	uint64_t	vk_max;			/* maximum legal value	*/
50 	uint64_t	vk_default;		/* default value	*/
51 	size_t		vk_offset;		/* offset into vdev_t	*/
52 } vdev_knob_t;
53 
54 /*
55  * Fault injection modes.
56  */
57 #define	VDEV_FAULT_NONE		0
58 #define	VDEV_FAULT_RANDOM	1
59 #define	VDEV_FAULT_COUNT	2
60 
61 extern int vdev_open(vdev_t *);
62 extern void vdev_close(vdev_t *);
63 extern int vdev_create(vdev_t *, uint64_t txg);
64 extern void vdev_init(vdev_t *, uint64_t txg);
65 extern void vdev_reopen(vdev_t *, zio_t **zq);
66 
67 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
68 extern vdev_t *vdev_lookup_by_path(vdev_t *vd, const char *path);
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 void 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 void vdev_checksum_error(zio_t *zio, vdev_t *vd);
85 extern int vdev_getspec(spa_t *spa, uint64_t vdev, char **vdev_spec);
86 extern void vdev_set_state(vdev_t *vd, vdev_state_t state, vdev_aux_t aux);
87 
88 extern void vdev_space_update(vdev_t *vd, uint64_t space_delta,
89     uint64_t alloc_delta);
90 
91 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
92 
93 extern void vdev_io_start(zio_t *zio);
94 extern void vdev_io_done(zio_t *zio);
95 
96 extern int vdev_online(spa_t *spa, const char *path);
97 extern int vdev_offline(spa_t *spa, const char *path);
98 
99 extern int vdev_error_setup(spa_t *spa, const char *path, int mode, int mask,
100     uint64_t arg);
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 
119 extern nvlist_t *vdev_config_generate(vdev_t *vd, int getstats);
120 
121 /*
122  * Label routines
123  */
124 struct uberblock;
125 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
126 extern nvlist_t *vdev_label_read_config(vdev_t *vd);
127 extern void vdev_uberblock_load(zio_t *zio, vdev_t *vd, struct uberblock *ub);
128 int vdev_label_init(vdev_t *vd, uint64_t create_txg);
129 extern int spa_sync_labels(spa_t *spa, uint64_t txg);
130 
131 #ifdef	__cplusplus
132 }
133 #endif
134 
135 #endif	/* _SYS_VDEV_H */
136