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