xref: /freebsd/sys/geom/vinum/geom_vinum.h (revision 123af6ec70016f5556da5972d4d63c7d175c06d3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2004, 2007 Lukas Ertl
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef	_GEOM_VINUM_H_
32 #define	_GEOM_VINUM_H_
33 
34 /* geom_vinum_create.c */
35 void	gv_concat(struct g_geom *gp, struct gctl_req *);
36 void	gv_mirror(struct g_geom *gp, struct gctl_req *);
37 void	gv_stripe(struct g_geom *gp, struct gctl_req *);
38 void	gv_raid5(struct g_geom *gp, struct gctl_req *);
39 int	gv_create_drive(struct gv_softc *, struct gv_drive *);
40 int	gv_create_volume(struct gv_softc *, struct gv_volume *);
41 int	gv_create_plex(struct gv_softc *, struct gv_plex *);
42 int	gv_create_sd(struct gv_softc *, struct gv_sd *);
43 
44 /* geom_vinum_drive.c */
45 void	gv_save_config(struct gv_softc *);
46 int	gv_read_header(struct g_consumer *, struct gv_hdr *);
47 int	gv_write_header(struct g_consumer *, struct gv_hdr *);
48 
49 /* geom_vinum_init.c */
50 void	gv_start_obj(struct g_geom *, struct gctl_req *);
51 int	gv_start_plex(struct gv_plex *);
52 int	gv_start_vol(struct gv_volume *);
53 
54 /* geom_vinum_list.c */
55 void	gv_ld(struct g_geom *, struct gctl_req *, struct sbuf *);
56 void	gv_lp(struct g_geom *, struct gctl_req *, struct sbuf *);
57 void	gv_ls(struct g_geom *, struct gctl_req *, struct sbuf *);
58 void	gv_lv(struct g_geom *, struct gctl_req *, struct sbuf *);
59 void	gv_list(struct g_geom *, struct gctl_req *);
60 
61 /* geom_vinum_move.c */
62 void	gv_move(struct g_geom *, struct gctl_req *);
63 int	gv_move_sd(struct gv_softc *, struct gv_sd *, struct gv_drive *, int);
64 
65 /* geom_vinum_rename.c */
66 void	gv_rename(struct g_geom *, struct gctl_req *);
67 int	gv_rename_drive(struct gv_softc *, struct gv_drive *, char *, int);
68 int	gv_rename_plex(struct gv_softc *, struct gv_plex *, char *, int);
69 int	gv_rename_sd(struct gv_softc *, struct gv_sd *, char *, int);
70 int	gv_rename_vol(struct gv_softc *, struct gv_volume *, char *, int);
71 
72 /* geom_vinum_rm.c */
73 void	gv_remove(struct g_geom *, struct gctl_req *);
74 int	gv_resetconfig(struct gv_softc *);
75 void	gv_rm_sd(struct gv_softc *sc, struct gv_sd *s);
76 void	gv_rm_drive(struct gv_softc *, struct gv_drive *, int);
77 void	gv_rm_plex(struct gv_softc *, struct gv_plex *);
78 void	gv_rm_vol(struct gv_softc *, struct gv_volume *);
79 
80 
81 /* geom_vinum_state.c */
82 int	gv_sdstatemap(struct gv_plex *);
83 void	gv_setstate(struct g_geom *, struct gctl_req *);
84 int	gv_set_drive_state(struct gv_drive *, int, int);
85 int	gv_set_sd_state(struct gv_sd *, int, int);
86 int	gv_set_vol_state(struct gv_volume *, int, int);
87 int	gv_set_plex_state(struct gv_plex *, int, int);
88 void	gv_update_sd_state(struct gv_sd *);
89 void	gv_update_plex_state(struct gv_plex *);
90 void	gv_update_vol_state(struct gv_volume *);
91 
92 /* geom_vinum_subr.c */
93 void		 	 gv_adjust_freespace(struct gv_sd *, off_t);
94 void		 	 gv_free_sd(struct gv_sd *);
95 struct gv_drive		*gv_find_drive(struct gv_softc *, char *);
96 struct gv_drive		*gv_find_drive_device(struct gv_softc *, char *);
97 struct gv_plex		*gv_find_plex(struct gv_softc *, char *);
98 struct gv_sd		*gv_find_sd(struct gv_softc *, char *);
99 struct gv_volume	*gv_find_vol(struct gv_softc *, char *);
100 void			 gv_format_config(struct gv_softc *, struct sbuf *, int,
101 			     char *);
102 int			 gv_is_striped(struct gv_plex *);
103 int			 gv_consumer_is_open(struct g_consumer *);
104 int			 gv_provider_is_open(struct g_provider *);
105 int			 gv_object_type(struct gv_softc *, char *);
106 void			 gv_parse_config(struct gv_softc *, char *,
107 			     struct gv_drive *);
108 int			 gv_sd_to_drive(struct gv_sd *, struct gv_drive *);
109 int			 gv_sd_to_plex(struct gv_sd *, struct gv_plex *);
110 int			 gv_sdcount(struct gv_plex *, int);
111 void			 gv_update_plex_config(struct gv_plex *);
112 void			 gv_update_vol_size(struct gv_volume *, off_t);
113 off_t			 gv_vol_size(struct gv_volume *);
114 off_t			 gv_plex_size(struct gv_plex *);
115 int			 gv_plexdown(struct gv_volume *);
116 int			 gv_attach_plex(struct gv_plex *, struct gv_volume *,
117 			     int);
118 int			 gv_attach_sd(struct gv_sd *, struct gv_plex *, off_t,
119 			     int);
120 int			 gv_detach_plex(struct gv_plex *, int);
121 int			 gv_detach_sd(struct gv_sd *, int);
122 
123 /* geom_vinum.c */
124 void	gv_worker(void *);
125 void	gv_post_event(struct gv_softc *, int, void *, void *, intmax_t,
126 	    intmax_t);
127 void	gv_worker_exit(struct gv_softc *);
128 struct gv_event *gv_get_event(struct gv_softc *);
129 void	gv_remove_event(struct gv_softc *, struct gv_event *);
130 void	gv_drive_tasted(struct gv_softc *, struct g_provider *);
131 void	gv_drive_lost(struct gv_softc *, struct gv_drive *);
132 void	gv_setup_objects(struct gv_softc *);
133 void	gv_start(struct bio *);
134 int	gv_access(struct g_provider *, int, int, int);
135 void	gv_cleanup(struct gv_softc *);
136 
137 /* geom_vinum_volume.c */
138 void	gv_done(struct bio *);
139 void	gv_volume_start(struct gv_softc *, struct bio *);
140 void	gv_volume_flush(struct gv_volume *);
141 void	gv_bio_done(struct gv_softc *, struct bio *);
142 
143 /* geom_vinum_plex.c */
144 void	gv_plex_start(struct gv_plex *, struct bio *);
145 void	gv_plex_raid5_done(struct gv_plex *, struct bio *);
146 void	gv_plex_normal_done(struct gv_plex *, struct bio *);
147 int	gv_grow_request(struct gv_plex *, off_t, off_t, int, caddr_t);
148 void	gv_grow_complete(struct gv_plex *, struct bio *);
149 void	gv_init_request(struct gv_sd *, off_t, caddr_t, off_t);
150 void	gv_init_complete(struct gv_plex *, struct bio *);
151 void	gv_parity_request(struct gv_plex *, int, off_t);
152 void	gv_parity_complete(struct gv_plex *, struct bio *);
153 void	gv_rebuild_complete(struct gv_plex *, struct bio *);
154 int	gv_sync_request(struct gv_plex *, struct gv_plex *, off_t, off_t, int,
155 	    caddr_t);
156 int	gv_sync_complete(struct gv_plex *, struct bio *);
157 
158 extern	u_int	g_vinum_debug;
159 
160 #define	G_VINUM_DEBUG(lvl, ...)	do {					\
161 	if (g_vinum_debug >= (lvl)) {					\
162 		printf("GEOM_VINUM");					\
163 		if (g_vinum_debug > 0)					\
164 			printf("[%u]", lvl);				\
165 		printf(": ");						\
166 		printf(__VA_ARGS__);					\
167 		printf("\n");						\
168 	}								\
169 } while (0)
170 
171 #define	G_VINUM_LOGREQ(lvl, bp, ...)	do {				\
172 	if (g_vinum_debug >= (lvl)) {					\
173 		printf("GEOM_VINUM");					\
174 		if (g_vinum_debug > 0)					\
175 			printf("[%u]", lvl);				\
176 		printf(": ");						\
177 		printf(__VA_ARGS__);					\
178 		printf(" ");						\
179 		g_print_bio(bp);					\
180 		printf("\n");						\
181 	}								\
182 } while (0)
183 
184 #endif /* !_GEOM_VINUM_H_ */
185