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 *
| 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 *
|
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/module.h>
48
49struct g_class;
50struct g_geom;
51struct g_consumer;
52struct g_provider;
53struct g_stat;
54struct thread;
55struct bio;
56struct sbuf;
57struct gctl_req;
58struct g_configargs;
59
60typedef int g_config_t (struct g_configargs *ca);
61typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb);
62typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
63typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
64typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
65typedef void g_init_t (struct g_class *mp);
66typedef void g_fini_t (struct g_class *mp);
67typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags);
68typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td);
69#define G_TF_NORMAL 0
70#define G_TF_INSIST 1
71#define G_TF_TRANSPARENT 2
72typedef int g_access_t (struct g_provider *, int, int, int);
73/* XXX: not sure about the thread arg */
74typedef void g_orphan_t (struct g_consumer *);
75
76typedef void g_start_t (struct bio *);
77typedef void g_spoiled_t (struct g_consumer *);
78typedef void g_attrchanged_t (struct g_consumer *, const char *attr);
79typedef void g_provgone_t (struct g_provider *);
80typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
81 struct g_consumer *, struct g_provider *);
82
83/*
84 * The g_class structure describes a transformation class. In other words
85 * all BSD disklabel handlers share one g_class, all MBR handlers share
86 * one common g_class and so on.
87 * Certain operations are instantiated on the class, most notably the
88 * taste and config_geom functions.
89 */
90struct g_class {
91 const char *name;
92 u_int version;
93 u_int spare0;
94 g_taste_t *taste;
95 g_config_t *config;
96 g_ctl_req_t *ctlreq;
97 g_init_t *init;
98 g_fini_t *fini;
99 g_ctl_destroy_geom_t *destroy_geom;
100 /*
101 * Default values for geom methods
102 */
103 g_start_t *start;
104 g_spoiled_t *spoiled;
105 g_attrchanged_t *attrchanged;
| 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/module.h>
48
49struct g_class;
50struct g_geom;
51struct g_consumer;
52struct g_provider;
53struct g_stat;
54struct thread;
55struct bio;
56struct sbuf;
57struct gctl_req;
58struct g_configargs;
59
60typedef int g_config_t (struct g_configargs *ca);
61typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb);
62typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
63typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
64typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
65typedef void g_init_t (struct g_class *mp);
66typedef void g_fini_t (struct g_class *mp);
67typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags);
68typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td);
69#define G_TF_NORMAL 0
70#define G_TF_INSIST 1
71#define G_TF_TRANSPARENT 2
72typedef int g_access_t (struct g_provider *, int, int, int);
73/* XXX: not sure about the thread arg */
74typedef void g_orphan_t (struct g_consumer *);
75
76typedef void g_start_t (struct bio *);
77typedef void g_spoiled_t (struct g_consumer *);
78typedef void g_attrchanged_t (struct g_consumer *, const char *attr);
79typedef void g_provgone_t (struct g_provider *);
80typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
81 struct g_consumer *, struct g_provider *);
82
83/*
84 * The g_class structure describes a transformation class. In other words
85 * all BSD disklabel handlers share one g_class, all MBR handlers share
86 * one common g_class and so on.
87 * Certain operations are instantiated on the class, most notably the
88 * taste and config_geom functions.
89 */
90struct g_class {
91 const char *name;
92 u_int version;
93 u_int spare0;
94 g_taste_t *taste;
95 g_config_t *config;
96 g_ctl_req_t *ctlreq;
97 g_init_t *init;
98 g_fini_t *fini;
99 g_ctl_destroy_geom_t *destroy_geom;
100 /*
101 * Default values for geom methods
102 */
103 g_start_t *start;
104 g_spoiled_t *spoiled;
105 g_attrchanged_t *attrchanged;
|
144 void *spare1;
145 void *softc;
146 unsigned flags;
147#define G_GEOM_WITHER 1
148#define G_GEOM_VOLATILE_BIO 2
149};
150
151/*
152 * The g_bioq is a queue of struct bio's.
153 * XXX: possibly collection point for statistics.
154 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
155 */
156struct g_bioq {
157 TAILQ_HEAD(, bio) bio_queue;
158 struct mtx bio_queue_lock;
159 int bio_queue_length;
160};
161
162/*
163 * A g_consumer is an attachment point for a g_provider. One g_consumer
164 * can only be attached to one g_provider, but multiple g_consumers
165 * can be attached to one g_provider.
166 */
167
168struct g_consumer {
169 struct g_geom *geom;
170 LIST_ENTRY(g_consumer) consumer;
171 struct g_provider *provider;
172 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
173 int acr, acw, ace;
174 int spoiled;
175 struct devstat *stat;
176 u_int nstart, nend;
177
178 /* Two fields for the implementing class to use */
179 void *private;
180 u_int index;
181};
182
183/*
184 * A g_provider is a "logical disk".
185 */
186struct g_provider {
187 char *name;
188 LIST_ENTRY(g_provider) provider;
189 struct g_geom *geom;
190 LIST_HEAD(,g_consumer) consumers;
191 int acr, acw, ace;
192 int error;
193 TAILQ_ENTRY(g_provider) orphan;
194 off_t mediasize;
195 u_int sectorsize;
196 u_int stripesize;
197 u_int stripeoffset;
198 struct devstat *stat;
199 u_int nstart, nend;
200 u_int flags;
201#define G_PF_CANDELETE 0x1
202#define G_PF_WITHER 0x2
203#define G_PF_ORPHAN 0x4
204
205 /* Two fields for the implementing class to use */
206 void *private;
207 u_int index;
208};
209
210/*
211 * Descriptor of a classifier. We can register a function and
212 * an argument, which is called by g_io_request() on bio's
213 * that are not previously classified.
214 */
215struct g_classifier_hook {
216 TAILQ_ENTRY(g_classifier_hook) link;
217 int (*func)(void *arg, struct bio *bp);
218 void *arg;
219};
220
221/* BIO_GETATTR("GEOM::setstate") argument values. */
222#define G_STATE_FAILED 0
223#define G_STATE_REBUILD 1
224#define G_STATE_RESYNC 2
225#define G_STATE_ACTIVE 3
226
227/* geom_dev.c */
228struct cdev;
229void g_dev_print(void);
230void g_dev_physpath_changed(void);
231struct g_provider *g_dev_getprovider(struct cdev *dev);
232
233/* geom_dump.c */
234void g_trace(int level, const char *, ...);
235# define G_T_TOPOLOGY 1
236# define G_T_BIO 2
237# define G_T_ACCESS 4
238
239
240/* geom_event.c */
241typedef void g_event_t(void *, int flag);
242#define EV_CANCEL 1
243int g_post_event(g_event_t *func, void *arg, int flag, ...);
244int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
245void g_cancel_event(void *ref);
246int g_attr_changed(struct g_provider *pp, const char *attr, int flag);
247void g_orphan_provider(struct g_provider *pp, int error);
248void g_waitidlelock(void);
249
250/* geom_subr.c */
251int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl);
252int g_attach(struct g_consumer *cp, struct g_provider *pp);
253int g_compare_names(const char *namea, const char *nameb);
254void g_destroy_consumer(struct g_consumer *cp);
255void g_destroy_geom(struct g_geom *pp);
256void g_destroy_provider(struct g_provider *pp);
257void g_detach(struct g_consumer *cp);
258void g_error_provider(struct g_provider *pp, int error);
259struct g_provider *g_provider_by_name(char const *arg);
260int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
261#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
262int g_handleattr(struct bio *bp, const char *attribute, const void *val,
263 int len);
264int g_handleattr_int(struct bio *bp, const char *attribute, int val);
265int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
266int g_handleattr_str(struct bio *bp, const char *attribute, const char *str);
267struct g_consumer * g_new_consumer(struct g_geom *gp);
268struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
269struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
270int g_retaste(struct g_class *mp);
271void g_spoil(struct g_provider *pp, struct g_consumer *cp);
272int g_std_access(struct g_provider *pp, int dr, int dw, int de);
273void g_std_done(struct bio *bp);
274void g_std_spoiled(struct g_consumer *cp);
275void g_wither_geom(struct g_geom *gp, int error);
276void g_wither_geom_close(struct g_geom *gp, int error);
277void g_wither_provider(struct g_provider *pp, int error);
278
279#if defined(DIAGNOSTIC) || defined(DDB)
280int g_valid_obj(void const *ptr);
281#endif
282#ifdef DIAGNOSTIC
283#define G_VALID_CLASS(foo) \
284 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo))
285#define G_VALID_GEOM(foo) \
286 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo))
287#define G_VALID_CONSUMER(foo) \
288 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo))
289#define G_VALID_PROVIDER(foo) \
290 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo))
291#else
292#define G_VALID_CLASS(foo) do { } while (0)
293#define G_VALID_GEOM(foo) do { } while (0)
294#define G_VALID_CONSUMER(foo) do { } while (0)
295#define G_VALID_PROVIDER(foo) do { } while (0)
296#endif
297
298int g_modevent(module_t, int, void *);
299
300/* geom_io.c */
301struct bio * g_clone_bio(struct bio *);
302struct bio * g_duplicate_bio(struct bio *);
303void g_destroy_bio(struct bio *);
304void g_io_deliver(struct bio *bp, int error);
305int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
306int g_io_flush(struct g_consumer *cp);
307int g_register_classifier(struct g_classifier_hook *hook);
308void g_unregister_classifier(struct g_classifier_hook *hook);
309void g_io_request(struct bio *bp, struct g_consumer *cp);
310struct bio *g_new_bio(void);
311struct bio *g_alloc_bio(void);
312void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
313int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
314int g_delete_data(struct g_consumer *cp, off_t offset, off_t length);
315void g_print_bio(struct bio *bp);
316
317/* geom_kern.c / geom_kernsim.c */
318
319#ifdef _KERNEL
320
321extern struct sx topology_lock;
322
323struct g_kerneldump {
324 off_t offset;
325 off_t length;
326 struct dumperinfo di;
327};
328
329MALLOC_DECLARE(M_GEOM);
330
331static __inline void *
332g_malloc(int size, int flags)
333{
334 void *p;
335
336 p = malloc(size, M_GEOM, flags);
337 return (p);
338}
339
340static __inline void
341g_free(void *ptr)
342{
343
344#ifdef DIAGNOSTIC
345 if (sx_xlocked(&topology_lock)) {
346 KASSERT(g_valid_obj(ptr) == 0,
347 ("g_free(%p) of live object, type %d", ptr,
348 g_valid_obj(ptr)));
349 }
350#endif
351 free(ptr, M_GEOM);
352}
353
354#define g_topology_lock() \
355 do { \
356 mtx_assert(&Giant, MA_NOTOWNED); \
357 sx_xlock(&topology_lock); \
358 } while (0)
359
360#define g_topology_try_lock() sx_try_xlock(&topology_lock)
361
362#define g_topology_unlock() \
363 do { \
364 sx_xunlock(&topology_lock); \
365 } while (0)
366
367#define g_topology_assert() \
368 do { \
369 sx_assert(&topology_lock, SX_XLOCKED); \
370 } while (0)
371
372#define g_topology_assert_not() \
373 do { \
374 sx_assert(&topology_lock, SX_UNLOCKED); \
375 } while (0)
376
377#define g_topology_sleep(chan, timo) \
378 sx_sleep(chan, &topology_lock, 0, "gtopol", timo)
379
380#define DECLARE_GEOM_CLASS(class, name) \
381 static moduledata_t name##_mod = { \
382 #name, g_modevent, &class \
383 }; \
384 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
385
386#endif /* _KERNEL */
387
388/* geom_ctl.c */
389int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
390void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len);
391void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
392char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
393void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
394int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3);
395struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
396struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg);
397struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
398
399#endif /* _GEOM_GEOM_H_ */
| 142 void *spare1;
143 void *softc;
144 unsigned flags;
145#define G_GEOM_WITHER 1
146#define G_GEOM_VOLATILE_BIO 2
147};
148
149/*
150 * The g_bioq is a queue of struct bio's.
151 * XXX: possibly collection point for statistics.
152 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
153 */
154struct g_bioq {
155 TAILQ_HEAD(, bio) bio_queue;
156 struct mtx bio_queue_lock;
157 int bio_queue_length;
158};
159
160/*
161 * A g_consumer is an attachment point for a g_provider. One g_consumer
162 * can only be attached to one g_provider, but multiple g_consumers
163 * can be attached to one g_provider.
164 */
165
166struct g_consumer {
167 struct g_geom *geom;
168 LIST_ENTRY(g_consumer) consumer;
169 struct g_provider *provider;
170 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
171 int acr, acw, ace;
172 int spoiled;
173 struct devstat *stat;
174 u_int nstart, nend;
175
176 /* Two fields for the implementing class to use */
177 void *private;
178 u_int index;
179};
180
181/*
182 * A g_provider is a "logical disk".
183 */
184struct g_provider {
185 char *name;
186 LIST_ENTRY(g_provider) provider;
187 struct g_geom *geom;
188 LIST_HEAD(,g_consumer) consumers;
189 int acr, acw, ace;
190 int error;
191 TAILQ_ENTRY(g_provider) orphan;
192 off_t mediasize;
193 u_int sectorsize;
194 u_int stripesize;
195 u_int stripeoffset;
196 struct devstat *stat;
197 u_int nstart, nend;
198 u_int flags;
199#define G_PF_CANDELETE 0x1
200#define G_PF_WITHER 0x2
201#define G_PF_ORPHAN 0x4
202
203 /* Two fields for the implementing class to use */
204 void *private;
205 u_int index;
206};
207
208/*
209 * Descriptor of a classifier. We can register a function and
210 * an argument, which is called by g_io_request() on bio's
211 * that are not previously classified.
212 */
213struct g_classifier_hook {
214 TAILQ_ENTRY(g_classifier_hook) link;
215 int (*func)(void *arg, struct bio *bp);
216 void *arg;
217};
218
219/* BIO_GETATTR("GEOM::setstate") argument values. */
220#define G_STATE_FAILED 0
221#define G_STATE_REBUILD 1
222#define G_STATE_RESYNC 2
223#define G_STATE_ACTIVE 3
224
225/* geom_dev.c */
226struct cdev;
227void g_dev_print(void);
228void g_dev_physpath_changed(void);
229struct g_provider *g_dev_getprovider(struct cdev *dev);
230
231/* geom_dump.c */
232void g_trace(int level, const char *, ...);
233# define G_T_TOPOLOGY 1
234# define G_T_BIO 2
235# define G_T_ACCESS 4
236
237
238/* geom_event.c */
239typedef void g_event_t(void *, int flag);
240#define EV_CANCEL 1
241int g_post_event(g_event_t *func, void *arg, int flag, ...);
242int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
243void g_cancel_event(void *ref);
244int g_attr_changed(struct g_provider *pp, const char *attr, int flag);
245void g_orphan_provider(struct g_provider *pp, int error);
246void g_waitidlelock(void);
247
248/* geom_subr.c */
249int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl);
250int g_attach(struct g_consumer *cp, struct g_provider *pp);
251int g_compare_names(const char *namea, const char *nameb);
252void g_destroy_consumer(struct g_consumer *cp);
253void g_destroy_geom(struct g_geom *pp);
254void g_destroy_provider(struct g_provider *pp);
255void g_detach(struct g_consumer *cp);
256void g_error_provider(struct g_provider *pp, int error);
257struct g_provider *g_provider_by_name(char const *arg);
258int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
259#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
260int g_handleattr(struct bio *bp, const char *attribute, const void *val,
261 int len);
262int g_handleattr_int(struct bio *bp, const char *attribute, int val);
263int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
264int g_handleattr_str(struct bio *bp, const char *attribute, const char *str);
265struct g_consumer * g_new_consumer(struct g_geom *gp);
266struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
267struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
268int g_retaste(struct g_class *mp);
269void g_spoil(struct g_provider *pp, struct g_consumer *cp);
270int g_std_access(struct g_provider *pp, int dr, int dw, int de);
271void g_std_done(struct bio *bp);
272void g_std_spoiled(struct g_consumer *cp);
273void g_wither_geom(struct g_geom *gp, int error);
274void g_wither_geom_close(struct g_geom *gp, int error);
275void g_wither_provider(struct g_provider *pp, int error);
276
277#if defined(DIAGNOSTIC) || defined(DDB)
278int g_valid_obj(void const *ptr);
279#endif
280#ifdef DIAGNOSTIC
281#define G_VALID_CLASS(foo) \
282 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo))
283#define G_VALID_GEOM(foo) \
284 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo))
285#define G_VALID_CONSUMER(foo) \
286 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo))
287#define G_VALID_PROVIDER(foo) \
288 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo))
289#else
290#define G_VALID_CLASS(foo) do { } while (0)
291#define G_VALID_GEOM(foo) do { } while (0)
292#define G_VALID_CONSUMER(foo) do { } while (0)
293#define G_VALID_PROVIDER(foo) do { } while (0)
294#endif
295
296int g_modevent(module_t, int, void *);
297
298/* geom_io.c */
299struct bio * g_clone_bio(struct bio *);
300struct bio * g_duplicate_bio(struct bio *);
301void g_destroy_bio(struct bio *);
302void g_io_deliver(struct bio *bp, int error);
303int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
304int g_io_flush(struct g_consumer *cp);
305int g_register_classifier(struct g_classifier_hook *hook);
306void g_unregister_classifier(struct g_classifier_hook *hook);
307void g_io_request(struct bio *bp, struct g_consumer *cp);
308struct bio *g_new_bio(void);
309struct bio *g_alloc_bio(void);
310void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
311int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
312int g_delete_data(struct g_consumer *cp, off_t offset, off_t length);
313void g_print_bio(struct bio *bp);
314
315/* geom_kern.c / geom_kernsim.c */
316
317#ifdef _KERNEL
318
319extern struct sx topology_lock;
320
321struct g_kerneldump {
322 off_t offset;
323 off_t length;
324 struct dumperinfo di;
325};
326
327MALLOC_DECLARE(M_GEOM);
328
329static __inline void *
330g_malloc(int size, int flags)
331{
332 void *p;
333
334 p = malloc(size, M_GEOM, flags);
335 return (p);
336}
337
338static __inline void
339g_free(void *ptr)
340{
341
342#ifdef DIAGNOSTIC
343 if (sx_xlocked(&topology_lock)) {
344 KASSERT(g_valid_obj(ptr) == 0,
345 ("g_free(%p) of live object, type %d", ptr,
346 g_valid_obj(ptr)));
347 }
348#endif
349 free(ptr, M_GEOM);
350}
351
352#define g_topology_lock() \
353 do { \
354 mtx_assert(&Giant, MA_NOTOWNED); \
355 sx_xlock(&topology_lock); \
356 } while (0)
357
358#define g_topology_try_lock() sx_try_xlock(&topology_lock)
359
360#define g_topology_unlock() \
361 do { \
362 sx_xunlock(&topology_lock); \
363 } while (0)
364
365#define g_topology_assert() \
366 do { \
367 sx_assert(&topology_lock, SX_XLOCKED); \
368 } while (0)
369
370#define g_topology_assert_not() \
371 do { \
372 sx_assert(&topology_lock, SX_UNLOCKED); \
373 } while (0)
374
375#define g_topology_sleep(chan, timo) \
376 sx_sleep(chan, &topology_lock, 0, "gtopol", timo)
377
378#define DECLARE_GEOM_CLASS(class, name) \
379 static moduledata_t name##_mod = { \
380 #name, g_modevent, &class \
381 }; \
382 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
383
384#endif /* _KERNEL */
385
386/* geom_ctl.c */
387int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
388void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len);
389void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
390char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
391void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
392int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3);
393struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
394struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg);
395struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
396
397#endif /* _GEOM_GEOM_H_ */
|