xref: /freebsd/sys/geom/geom.h (revision 7a1c0d963366a31363d3705697a083dd8efee077)
1 /*-
2  * Copyright (c) 2002 Poul-Henning Kamp
3  * Copyright (c) 2002 Networks Associates Technology, Inc.
4  * All rights reserved.
5  *
6  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7  * and NAI Labs, the Security Research Division of Network Associates, Inc.
8  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9  * DARPA CHATS research program.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. The names of the authors may not be used to endorse or promote
20  *    products derived from this software without specific prior written
21  *    permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  * $FreeBSD$
36  */
37 
38 #ifndef _GEOM_GEOM_H_
39 #define _GEOM_GEOM_H_
40 
41 #include <sys/lock.h>
42 #include <sys/mutex.h>
43 #include <sys/sx.h>
44 #include <sys/queue.h>
45 #include <sys/ioccom.h>
46 #include <sys/conf.h>
47 #include <sys/sbuf.h>
48 #include <sys/module.h>
49 
50 struct g_class;
51 struct g_geom;
52 struct g_consumer;
53 struct g_provider;
54 struct g_stat;
55 struct thread;
56 struct bio;
57 struct sbuf;
58 struct gctl_req;
59 struct g_configargs;
60 
61 typedef int g_config_t (struct g_configargs *ca);
62 typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb);
63 typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
64 typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
65 typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
66 typedef void g_init_t (struct g_class *mp);
67 typedef void g_fini_t (struct g_class *mp);
68 typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags);
69 typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td);
70 #define G_TF_NORMAL		0
71 #define G_TF_INSIST		1
72 #define G_TF_TRANSPARENT	2
73 typedef int g_access_t (struct g_provider *, int, int, int);
74 /* XXX: not sure about the thread arg */
75 typedef void g_orphan_t (struct g_consumer *);
76 
77 typedef void g_start_t (struct bio *);
78 typedef void g_spoiled_t (struct g_consumer *);
79 typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
80     struct g_consumer *, struct g_provider *);
81 
82 /*
83  * The g_class structure describes a transformation class.  In other words
84  * all BSD disklabel handlers share one g_class, all MBR handlers share
85  * one common g_class and so on.
86  * Certain operations are instantiated on the class, most notably the
87  * taste and config_geom functions.
88  */
89 struct g_class {
90 	const char		*name;
91 	u_int			version;
92 	g_taste_t		*taste;
93 	g_config_t		*config;
94 	g_ctl_req_t		*ctlreq;
95 	g_init_t		*init;
96 	g_fini_t		*fini;
97 	g_ctl_destroy_geom_t	*destroy_geom;
98 	/*
99 	 * Default values for geom methods
100 	 */
101 	g_start_t		*start;
102 	g_spoiled_t		*spoiled;
103 	g_dumpconf_t		*dumpconf;
104 	g_access_t		*access;
105 	g_orphan_t		*orphan;
106 	g_ioctl_t		*ioctl;
107 	/*
108 	 * The remaining elements are private
109 	 */
110 	LIST_ENTRY(g_class)	class;
111 	LIST_HEAD(,g_geom)	geom;
112 };
113 
114 #define G_VERSION_00	0x19950323
115 #define G_VERSION_01	0x20041207	/* add fflag to g_ioctl_t */
116 #define G_VERSION	G_VERSION_01
117 
118 /*
119  * The g_geom is an instance of a g_class.
120  */
121 struct g_geom {
122 	char			*name;
123 	struct g_class		*class;
124 	LIST_ENTRY(g_geom)	geom;
125 	LIST_HEAD(,g_consumer)	consumer;
126 	LIST_HEAD(,g_provider)	provider;
127 	TAILQ_ENTRY(g_geom)	geoms;	/* XXX: better name */
128 	int			rank;
129 	g_start_t		*start;
130 	g_spoiled_t		*spoiled;
131 	g_dumpconf_t		*dumpconf;
132 	g_access_t		*access;
133 	g_orphan_t		*orphan;
134 	g_ioctl_t		*ioctl;
135 	void			*softc;
136 	unsigned		flags;
137 #define	G_GEOM_WITHER		1
138 #define	G_GEOM_VOLATILE_BIO	2
139 };
140 
141 /*
142  * The g_bioq is a queue of struct bio's.
143  * XXX: possibly collection point for statistics.
144  * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
145  */
146 struct g_bioq {
147 	TAILQ_HEAD(, bio)	bio_queue;
148 	struct mtx		bio_queue_lock;
149 	int			bio_queue_length;
150 };
151 
152 /*
153  * A g_consumer is an attachment point for a g_provider.  One g_consumer
154  * can only be attached to one g_provider, but multiple g_consumers
155  * can be attached to one g_provider.
156  */
157 
158 struct g_consumer {
159 	struct g_geom		*geom;
160 	LIST_ENTRY(g_consumer)	consumer;
161 	struct g_provider	*provider;
162 	LIST_ENTRY(g_consumer)	consumers;	/* XXX: better name */
163 	int			acr, acw, ace;
164 	int			spoiled;
165 	struct devstat		*stat;
166 	u_int			nstart, nend;
167 
168 	/* Two fields for the implementing class to use */
169 	void			*private;
170 	u_int			index;
171 };
172 
173 /*
174  * A g_provider is a "logical disk".
175  */
176 struct g_provider {
177 	char			*name;
178 	LIST_ENTRY(g_provider)	provider;
179 	struct g_geom		*geom;
180 	LIST_HEAD(,g_consumer)	consumers;
181 	int			acr, acw, ace;
182 	int			error;
183 	TAILQ_ENTRY(g_provider)	orphan;
184 	off_t			mediasize;
185 	u_int			sectorsize;
186 	u_int			stripesize;
187 	u_int			stripeoffset;
188 	struct devstat		*stat;
189 	u_int			nstart, nend;
190 	u_int			flags;
191 #define G_PF_CANDELETE		0x1
192 #define G_PF_WITHER		0x2
193 #define G_PF_ORPHAN		0x4
194 
195 	/* Two fields for the implementing class to use */
196 	void			*private;
197 	u_int			index;
198 };
199 
200 /*
201  * Descriptor of a classifier. We can register a function and
202  * an argument, which is called by g_io_request() on bio's
203  * that are not previously classified.
204  */
205 struct g_classifier_hook {
206 	TAILQ_ENTRY(g_classifier_hook) link;
207 	int			(*func)(void *arg, struct bio *bp);
208 	void			*arg;
209 };
210 
211 /* BIO_GETATTR("GEOM::setstate") argument values. */
212 #define G_STATE_FAILED		0
213 #define G_STATE_REBUILD		1
214 #define G_STATE_RESYNC		2
215 #define G_STATE_ACTIVE		3
216 
217 /* geom_dev.c */
218 struct cdev;
219 void g_dev_print(void);
220 struct g_provider *g_dev_getprovider(struct cdev *dev);
221 
222 /* geom_dump.c */
223 void g_trace(int level, const char *, ...);
224 #	define G_T_TOPOLOGY	1
225 #	define G_T_BIO		2
226 #	define G_T_ACCESS	4
227 
228 
229 /* geom_event.c */
230 typedef void g_event_t(void *, int flag);
231 #define EV_CANCEL	1
232 int g_post_event(g_event_t *func, void *arg, int flag, ...);
233 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
234 void g_cancel_event(void *ref);
235 void g_orphan_provider(struct g_provider *pp, int error);
236 void g_waitidlelock(void);
237 
238 /* geom_subr.c */
239 int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl);
240 int g_attach(struct g_consumer *cp, struct g_provider *pp);
241 void g_destroy_consumer(struct g_consumer *cp);
242 void g_destroy_geom(struct g_geom *pp);
243 void g_destroy_provider(struct g_provider *pp);
244 void g_detach(struct g_consumer *cp);
245 void g_error_provider(struct g_provider *pp, int error);
246 struct g_provider *g_provider_by_name(char const *arg);
247 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
248 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
249 int g_handleattr(struct bio *bp, const char *attribute, const void *val,
250     int len);
251 int g_handleattr_int(struct bio *bp, const char *attribute, int val);
252 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
253 int g_handleattr_str(struct bio *bp, const char *attribute, const char *str);
254 struct g_consumer * g_new_consumer(struct g_geom *gp);
255 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
256 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
257 int g_retaste(struct g_class *mp);
258 void g_spoil(struct g_provider *pp, struct g_consumer *cp);
259 int g_std_access(struct g_provider *pp, int dr, int dw, int de);
260 void g_std_done(struct bio *bp);
261 void g_std_spoiled(struct g_consumer *cp);
262 void g_wither_geom(struct g_geom *gp, int error);
263 void g_wither_geom_close(struct g_geom *gp, int error);
264 void g_wither_provider(struct g_provider *pp, int error);
265 
266 #if defined(DIAGNOSTIC) || defined(DDB)
267 int g_valid_obj(void const *ptr);
268 #endif
269 #ifdef DIAGNOSTIC
270 #define G_VALID_CLASS(foo) \
271     KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo))
272 #define G_VALID_GEOM(foo) \
273     KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo))
274 #define G_VALID_CONSUMER(foo) \
275     KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo))
276 #define G_VALID_PROVIDER(foo) \
277     KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo))
278 #else
279 #define G_VALID_CLASS(foo) do { } while (0)
280 #define G_VALID_GEOM(foo) do { } while (0)
281 #define G_VALID_CONSUMER(foo) do { } while (0)
282 #define G_VALID_PROVIDER(foo) do { } while (0)
283 #endif
284 
285 int g_modevent(module_t, int, void *);
286 
287 /* geom_io.c */
288 struct bio * g_clone_bio(struct bio *);
289 struct bio * g_duplicate_bio(struct bio *);
290 void g_destroy_bio(struct bio *);
291 void g_io_deliver(struct bio *bp, int error);
292 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
293 int g_io_flush(struct g_consumer *cp);
294 int g_register_classifier(struct g_classifier_hook *hook);
295 void g_unregister_classifier(struct g_classifier_hook *hook);
296 void g_io_request(struct bio *bp, struct g_consumer *cp);
297 struct bio *g_new_bio(void);
298 struct bio *g_alloc_bio(void);
299 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
300 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
301 int g_delete_data(struct g_consumer *cp, off_t offset, off_t length);
302 void g_print_bio(struct bio *bp);
303 
304 /* geom_kern.c / geom_kernsim.c */
305 
306 #ifdef _KERNEL
307 
308 extern struct sx topology_lock;
309 
310 struct g_kerneldump {
311 	off_t		offset;
312 	off_t		length;
313 	struct dumperinfo di;
314 };
315 
316 MALLOC_DECLARE(M_GEOM);
317 
318 static __inline void *
319 g_malloc(int size, int flags)
320 {
321 	void *p;
322 
323 	p = malloc(size, M_GEOM, flags);
324 	return (p);
325 }
326 
327 static __inline void
328 g_free(void *ptr)
329 {
330 
331 #ifdef DIAGNOSTIC
332 	if (sx_xlocked(&topology_lock)) {
333 		KASSERT(g_valid_obj(ptr) == 0,
334 		    ("g_free(%p) of live object, type %d", ptr,
335 		    g_valid_obj(ptr)));
336 	}
337 #endif
338 	free(ptr, M_GEOM);
339 }
340 
341 #define g_topology_lock() 					\
342 	do {							\
343 		mtx_assert(&Giant, MA_NOTOWNED);		\
344 		sx_xlock(&topology_lock);			\
345 	} while (0)
346 
347 #define g_topology_try_lock()	sx_try_xlock(&topology_lock)
348 
349 #define g_topology_unlock()					\
350 	do {							\
351 		sx_xunlock(&topology_lock);			\
352 	} while (0)
353 
354 #define g_topology_assert()					\
355 	do {							\
356 		sx_assert(&topology_lock, SX_XLOCKED);		\
357 	} while (0)
358 
359 #define g_topology_assert_not()					\
360 	do {							\
361 		sx_assert(&topology_lock, SX_UNLOCKED);		\
362 	} while (0)
363 
364 #define g_topology_sleep(chan, timo)				\
365 	sx_sleep(chan, &topology_lock, 0, "gtopol", timo)
366 
367 #define DECLARE_GEOM_CLASS(class, name) 			\
368 	static moduledata_t name##_mod = {			\
369 		#name, g_modevent, &class			\
370 	};							\
371 	DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
372 
373 #endif /* _KERNEL */
374 
375 /* geom_ctl.c */
376 int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
377 void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len);
378 void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
379 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
380 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
381 int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3);
382 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
383 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg);
384 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
385 
386 #endif /* _GEOM_GEOM_H_ */
387