2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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
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
42 #include <sys/mutex.h>
44 #include <sys/queue.h>
45 #include <sys/ioccom.h>
47 #include <sys/module.h>
60 typedef int g_config_t (struct g_configargs *ca);
61 typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb);
62 typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
63 typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
64 typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
65 typedef void g_init_t (struct g_class *mp);
66 typedef void g_fini_t (struct g_class *mp);
67 typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags);
68 typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td);
71 #define G_TF_TRANSPARENT 2
72 typedef int g_access_t (struct g_provider *, int, int, int);
73 /* XXX: not sure about the thread arg */
74 typedef void g_orphan_t (struct g_consumer *);
76 typedef void g_start_t (struct bio *);
77 typedef void g_spoiled_t (struct g_consumer *);
78 typedef void g_attrchanged_t (struct g_consumer *, const char *attr);
79 typedef void g_provgone_t (struct g_provider *);
80 typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
81 struct g_consumer *, struct g_provider *);
82 typedef void g_resize_t(struct g_consumer *cp);
85 * The g_class structure describes a transformation class. In other words
86 * all BSD disklabel handlers share one g_class, all MBR handlers share
87 * one common g_class and so on.
88 * Certain operations are instantiated on the class, most notably the
89 * taste and config_geom functions.
100 g_ctl_destroy_geom_t *destroy_geom;
102 * Default values for geom methods
105 g_spoiled_t *spoiled;
106 g_attrchanged_t *attrchanged;
107 g_dumpconf_t *dumpconf;
111 g_provgone_t *providergone;
116 * The remaining elements are private
118 LIST_ENTRY(g_class) class;
119 LIST_HEAD(,g_geom) geom;
122 #define G_VERSION_00 0x19950323
123 #define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */
124 #define G_VERSION G_VERSION_01
127 * The g_geom is an instance of a g_class.
131 struct g_class *class;
132 LIST_ENTRY(g_geom) geom;
133 LIST_HEAD(,g_consumer) consumer;
134 LIST_HEAD(,g_provider) provider;
135 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */
138 g_spoiled_t *spoiled;
139 g_attrchanged_t *attrchanged;
140 g_dumpconf_t *dumpconf;
144 g_provgone_t *providergone;
150 #define G_GEOM_WITHER 0x01
151 #define G_GEOM_VOLATILE_BIO 0x02
152 #define G_GEOM_IN_ACCESS 0x04
153 #define G_GEOM_ACCESS_WAIT 0x08
157 * The g_bioq is a queue of struct bio's.
158 * XXX: possibly collection point for statistics.
159 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
162 TAILQ_HEAD(, bio) bio_queue;
163 struct mtx bio_queue_lock;
164 int bio_queue_length;
168 * A g_consumer is an attachment point for a g_provider. One g_consumer
169 * can only be attached to one g_provider, but multiple g_consumers
170 * can be attached to one g_provider.
175 LIST_ENTRY(g_consumer) consumer;
176 struct g_provider *provider;
177 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
180 #define G_CF_SPOILED 0x1
181 #define G_CF_ORPHAN 0x4
182 #define G_CF_DIRECT_SEND 0x10
183 #define G_CF_DIRECT_RECEIVE 0x20
184 struct devstat *stat;
187 /* Two fields for the implementing class to use */
193 * A g_provider is a "logical disk".
197 LIST_ENTRY(g_provider) provider;
199 LIST_HEAD(,g_consumer) consumers;
202 TAILQ_ENTRY(g_provider) orphan;
207 struct devstat *stat;
210 #define G_PF_WITHER 0x2
211 #define G_PF_ORPHAN 0x4
212 #define G_PF_ACCEPT_UNMAPPED 0x8
213 #define G_PF_DIRECT_SEND 0x10
214 #define G_PF_DIRECT_RECEIVE 0x20
216 /* Two fields for the implementing class to use */
222 * Descriptor of a classifier. We can register a function and
223 * an argument, which is called by g_io_request() on bio's
224 * that are not previously classified.
226 struct g_classifier_hook {
227 TAILQ_ENTRY(g_classifier_hook) link;
228 int (*func)(void *arg, struct bio *bp);
232 /* BIO_GETATTR("GEOM::setstate") argument values. */
233 #define G_STATE_FAILED 0
234 #define G_STATE_REBUILD 1
235 #define G_STATE_RESYNC 2
236 #define G_STATE_ACTIVE 3
240 void g_dev_print(void);
241 void g_dev_physpath_changed(void);
242 struct g_provider *g_dev_getprovider(struct cdev *dev);
245 void g_trace(int level, const char *, ...);
246 # define G_T_TOPOLOGY 1
248 # define G_T_ACCESS 4
252 typedef void g_event_t(void *, int flag);
254 int g_post_event(g_event_t *func, void *arg, int flag, ...);
255 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
256 void g_cancel_event(void *ref);
257 int g_attr_changed(struct g_provider *pp, const char *attr, int flag);
258 int g_media_changed(struct g_provider *pp, int flag);
259 int g_media_gone(struct g_provider *pp, int flag);
260 void g_orphan_provider(struct g_provider *pp, int error);
261 void g_waitidlelock(void);
264 int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl);
265 int g_attach(struct g_consumer *cp, struct g_provider *pp);
266 int g_compare_names(const char *namea, const char *nameb);
267 void g_destroy_consumer(struct g_consumer *cp);
268 void g_destroy_geom(struct g_geom *pp);
269 void g_destroy_provider(struct g_provider *pp);
270 void g_detach(struct g_consumer *cp);
271 void g_error_provider(struct g_provider *pp, int error);
272 struct g_provider *g_provider_by_name(char const *arg);
273 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
274 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
275 int g_handleattr(struct bio *bp, const char *attribute, const void *val,
277 int g_handleattr_int(struct bio *bp, const char *attribute, int val);
278 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
279 int g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val);
280 int g_handleattr_str(struct bio *bp, const char *attribute, const char *str);
281 struct g_consumer * g_new_consumer(struct g_geom *gp);
282 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...)
284 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...)
286 void g_resize_provider(struct g_provider *pp, off_t size);
287 int g_retaste(struct g_class *mp);
288 void g_spoil(struct g_provider *pp, struct g_consumer *cp);
289 int g_std_access(struct g_provider *pp, int dr, int dw, int de);
290 void g_std_done(struct bio *bp);
291 void g_std_spoiled(struct g_consumer *cp);
292 void g_wither_geom(struct g_geom *gp, int error);
293 void g_wither_geom_close(struct g_geom *gp, int error);
294 void g_wither_provider(struct g_provider *pp, int error);
296 #if defined(DIAGNOSTIC) || defined(DDB)
297 int g_valid_obj(void const *ptr);
300 #define G_VALID_CLASS(foo) \
301 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo))
302 #define G_VALID_GEOM(foo) \
303 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo))
304 #define G_VALID_CONSUMER(foo) \
305 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo))
306 #define G_VALID_PROVIDER(foo) \
307 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo))
309 #define G_VALID_CLASS(foo) do { } while (0)
310 #define G_VALID_GEOM(foo) do { } while (0)
311 #define G_VALID_CONSUMER(foo) do { } while (0)
312 #define G_VALID_PROVIDER(foo) do { } while (0)
315 int g_modevent(module_t, int, void *);
318 struct bio * g_clone_bio(struct bio *);
319 struct bio * g_duplicate_bio(struct bio *);
320 void g_destroy_bio(struct bio *);
321 void g_io_deliver(struct bio *bp, int error);
322 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
323 int g_io_flush(struct g_consumer *cp);
324 int g_register_classifier(struct g_classifier_hook *hook);
325 void g_unregister_classifier(struct g_classifier_hook *hook);
326 void g_io_request(struct bio *bp, struct g_consumer *cp);
327 struct bio *g_new_bio(void);
328 struct bio *g_alloc_bio(void);
329 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
330 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
331 int g_delete_data(struct g_consumer *cp, off_t offset, off_t length);
332 void g_print_bio(struct bio *bp);
334 /* geom_kern.c / geom_kernsim.c */
338 extern struct sx topology_lock;
340 struct g_kerneldump {
343 struct dumperinfo di;
346 MALLOC_DECLARE(M_GEOM);
348 static __inline void *
349 g_malloc(int size, int flags)
353 p = malloc(size, M_GEOM, flags);
362 if (sx_xlocked(&topology_lock)) {
363 KASSERT(g_valid_obj(ptr) == 0,
364 ("g_free(%p) of live object, type %d", ptr,
371 #define g_topology_lock() \
373 mtx_assert(&Giant, MA_NOTOWNED); \
374 sx_xlock(&topology_lock); \
377 #define g_topology_try_lock() sx_try_xlock(&topology_lock)
379 #define g_topology_unlock() \
381 sx_xunlock(&topology_lock); \
384 #define g_topology_assert() \
386 sx_assert(&topology_lock, SX_XLOCKED); \
389 #define g_topology_assert_not() \
391 sx_assert(&topology_lock, SX_UNLOCKED); \
394 #define g_topology_sleep(chan, timo) \
395 sx_sleep(chan, &topology_lock, 0, "gtopol", timo)
397 #define DECLARE_GEOM_CLASS(class, name) \
398 static moduledata_t name##_mod = { \
399 #name, g_modevent, &class \
401 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
403 int g_is_geom_thread(struct thread *td);
408 int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
409 void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len);
410 void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
411 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
412 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
413 int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3);
414 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
415 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg);
416 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
418 #endif /* _GEOM_GEOM_H_ */