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/sbuf.h>
47
48#ifdef KERNELSIM
49/*
50 * The GEOM subsystem makes a few concessions in order to be able to run as a
51 * user-land simulation as well as a kernel component.
52 */
53#include <geom_sim.h>
54#endif
55
56struct g_class;
57struct g_geom;
58struct g_consumer;
59struct g_provider;
60struct g_event;
61struct thread;
62struct bio;
63struct sbuf;
64
65typedef struct g_geom * g_create_geom_t (struct g_class *mp,
66 struct g_provider *pp, char *name);
67typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *,
68 int flags);
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 *, 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 create_geom functions.
87 */
88struct g_class {
89 char *name;
90 g_taste_t *taste;
91 g_create_geom_t *create_geom;
92 /*
93 * The remaning elements are private and classes should use
94 * the G_CLASS_INITIALIZER macro to initialize them.
95 */
96 LIST_ENTRY(g_class) class;
97 LIST_HEAD(,g_geom) geom;
98 struct g_event *event;
99 u_int protect;
100};
101
102#define G_CLASS_INITIALIZER { 0, 0 }, { 0 }, 0, 0
103
104/*
105 * The g_geom is an instance of a g_class.
106 */
107struct g_geom {
108 u_int protect;
109 char *name;
110 struct g_class *class;
111 LIST_ENTRY(g_geom) geom;
112 LIST_HEAD(,g_consumer) consumer;
113 LIST_HEAD(,g_provider) provider;
114 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */
115 int rank;
116 g_start_t *start;
117 g_spoiled_t *spoiled;
118 g_dumpconf_t *dumpconf;
119 g_access_t *access;
120 g_orphan_t *orphan;
121 void *softc;
122 struct g_event *event;
123 unsigned flags;
124#define G_GEOM_WITHER 1
125};
126
127/*
128 * The g_bioq is a queue of struct bio's.
129 * XXX: possibly collection point for statistics.
130 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
131 */
132struct g_bioq {
133 TAILQ_HEAD(, bio) bio_queue;
134 struct mtx bio_queue_lock;
135 int bio_queue_length;
136};
137
138/*
139 * A g_consumer is an attachment point for a g_provider. One g_consumer
140 * can only be attached to one g_provider, but multiple g_consumers
141 * can be attached to one g_provider.
142 */
143
144struct g_consumer {
145 u_int protect;
146 struct g_geom *geom;
147 LIST_ENTRY(g_consumer) consumer;
148 struct g_provider *provider;
149 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
150 int acr, acw, ace;
151 struct g_event *event;
152
153 int biocount;
154 int spoiled;
155};
156
157/*
158 * A g_provider is a "logical disk".
159 */
160struct g_provider {
161 u_int protect;
162 char *name;
163 LIST_ENTRY(g_provider) provider;
164 struct g_geom *geom;
165 LIST_HEAD(,g_consumer) consumers;
166 int acr, acw, ace;
167 int error;
168 struct g_event *event;
169 TAILQ_ENTRY(g_provider) orphan;
170 int index;
171 off_t mediasize;
172};
173
174/* geom_dump.c */
175void g_hexdump(void *ptr, int length);
176void g_trace(int level, char *, ...);
177# define G_T_TOPOLOGY 1
178# define G_T_BIO 2
179# define G_T_ACCESS 4
180
181
182/* geom_event.c */
183typedef void g_call_me_t(void *);
184int g_call_me(g_call_me_t *func, void *arg);
185void g_orphan_provider(struct g_provider *pp, int error);
186void g_silence(void);
187void g_waitidle(void);
188
189/* geom_subr.c */
190int g_access_abs(struct g_consumer *cp, int read, int write, int exclusive);
191int g_access_rel(struct g_consumer *cp, int read, int write, int exclusive);
192void g_add_class(struct g_class *mp);
193int g_attach(struct g_consumer *cp, struct g_provider *pp);
194struct g_geom *g_create_geomf(char *class, struct g_provider *, char *fmt, ...);
195void g_destroy_consumer(struct g_consumer *cp);
196void g_destroy_geom(struct g_geom *pp);
197void g_destroy_provider(struct g_provider *pp);
198void g_detach(struct g_consumer *cp);
199void g_error_provider(struct g_provider *pp, int error);
200int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
201#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
202int g_handleattr(struct bio *bp, char *attribute, void *val, int len);
203int g_handleattr_int(struct bio *bp, char *attribute, int val);
204int g_handleattr_off_t(struct bio *bp, char *attribute, off_t val);
205struct g_geom * g_insert_geom(char *class, struct g_consumer *cp);
206struct g_consumer * g_new_consumer(struct g_geom *gp);
207struct g_geom * g_new_geomf(struct g_class *mp, char *fmt, ...);
208struct g_provider * g_new_providerf(struct g_geom *gp, char *fmt, ...);
209void g_sanity(void *ptr);
210void g_spoil(struct g_provider *pp, struct g_consumer *cp);
211int g_std_access(struct g_provider *pp, int dr, int dw, int de);
212void g_std_done(struct bio *bp);
213void g_std_spoiled(struct g_consumer *cp);
214
215/* geom_io.c */
216struct bio * g_clone_bio(struct bio *);
217void g_destroy_bio(struct bio *);
218void g_io_deliver(struct bio *bp, int error);
219int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
220void g_io_request(struct bio *bp, struct g_consumer *cp);
221int g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr);
222struct bio *g_new_bio(void);
223void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
224int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
225
226/* geom_kern.c / geom_kernsim.c */
227
| 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/sbuf.h>
47
48#ifdef KERNELSIM
49/*
50 * The GEOM subsystem makes a few concessions in order to be able to run as a
51 * user-land simulation as well as a kernel component.
52 */
53#include <geom_sim.h>
54#endif
55
56struct g_class;
57struct g_geom;
58struct g_consumer;
59struct g_provider;
60struct g_event;
61struct thread;
62struct bio;
63struct sbuf;
64
65typedef struct g_geom * g_create_geom_t (struct g_class *mp,
66 struct g_provider *pp, char *name);
67typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *,
68 int flags);
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 *, 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 create_geom functions.
87 */
88struct g_class {
89 char *name;
90 g_taste_t *taste;
91 g_create_geom_t *create_geom;
92 /*
93 * The remaning elements are private and classes should use
94 * the G_CLASS_INITIALIZER macro to initialize them.
95 */
96 LIST_ENTRY(g_class) class;
97 LIST_HEAD(,g_geom) geom;
98 struct g_event *event;
99 u_int protect;
100};
101
102#define G_CLASS_INITIALIZER { 0, 0 }, { 0 }, 0, 0
103
104/*
105 * The g_geom is an instance of a g_class.
106 */
107struct g_geom {
108 u_int protect;
109 char *name;
110 struct g_class *class;
111 LIST_ENTRY(g_geom) geom;
112 LIST_HEAD(,g_consumer) consumer;
113 LIST_HEAD(,g_provider) provider;
114 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */
115 int rank;
116 g_start_t *start;
117 g_spoiled_t *spoiled;
118 g_dumpconf_t *dumpconf;
119 g_access_t *access;
120 g_orphan_t *orphan;
121 void *softc;
122 struct g_event *event;
123 unsigned flags;
124#define G_GEOM_WITHER 1
125};
126
127/*
128 * The g_bioq is a queue of struct bio's.
129 * XXX: possibly collection point for statistics.
130 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
131 */
132struct g_bioq {
133 TAILQ_HEAD(, bio) bio_queue;
134 struct mtx bio_queue_lock;
135 int bio_queue_length;
136};
137
138/*
139 * A g_consumer is an attachment point for a g_provider. One g_consumer
140 * can only be attached to one g_provider, but multiple g_consumers
141 * can be attached to one g_provider.
142 */
143
144struct g_consumer {
145 u_int protect;
146 struct g_geom *geom;
147 LIST_ENTRY(g_consumer) consumer;
148 struct g_provider *provider;
149 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
150 int acr, acw, ace;
151 struct g_event *event;
152
153 int biocount;
154 int spoiled;
155};
156
157/*
158 * A g_provider is a "logical disk".
159 */
160struct g_provider {
161 u_int protect;
162 char *name;
163 LIST_ENTRY(g_provider) provider;
164 struct g_geom *geom;
165 LIST_HEAD(,g_consumer) consumers;
166 int acr, acw, ace;
167 int error;
168 struct g_event *event;
169 TAILQ_ENTRY(g_provider) orphan;
170 int index;
171 off_t mediasize;
172};
173
174/* geom_dump.c */
175void g_hexdump(void *ptr, int length);
176void g_trace(int level, char *, ...);
177# define G_T_TOPOLOGY 1
178# define G_T_BIO 2
179# define G_T_ACCESS 4
180
181
182/* geom_event.c */
183typedef void g_call_me_t(void *);
184int g_call_me(g_call_me_t *func, void *arg);
185void g_orphan_provider(struct g_provider *pp, int error);
186void g_silence(void);
187void g_waitidle(void);
188
189/* geom_subr.c */
190int g_access_abs(struct g_consumer *cp, int read, int write, int exclusive);
191int g_access_rel(struct g_consumer *cp, int read, int write, int exclusive);
192void g_add_class(struct g_class *mp);
193int g_attach(struct g_consumer *cp, struct g_provider *pp);
194struct g_geom *g_create_geomf(char *class, struct g_provider *, char *fmt, ...);
195void g_destroy_consumer(struct g_consumer *cp);
196void g_destroy_geom(struct g_geom *pp);
197void g_destroy_provider(struct g_provider *pp);
198void g_detach(struct g_consumer *cp);
199void g_error_provider(struct g_provider *pp, int error);
200int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
201#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
202int g_handleattr(struct bio *bp, char *attribute, void *val, int len);
203int g_handleattr_int(struct bio *bp, char *attribute, int val);
204int g_handleattr_off_t(struct bio *bp, char *attribute, off_t val);
205struct g_geom * g_insert_geom(char *class, struct g_consumer *cp);
206struct g_consumer * g_new_consumer(struct g_geom *gp);
207struct g_geom * g_new_geomf(struct g_class *mp, char *fmt, ...);
208struct g_provider * g_new_providerf(struct g_geom *gp, char *fmt, ...);
209void g_sanity(void *ptr);
210void g_spoil(struct g_provider *pp, struct g_consumer *cp);
211int g_std_access(struct g_provider *pp, int dr, int dw, int de);
212void g_std_done(struct bio *bp);
213void g_std_spoiled(struct g_consumer *cp);
214
215/* geom_io.c */
216struct bio * g_clone_bio(struct bio *);
217void g_destroy_bio(struct bio *);
218void g_io_deliver(struct bio *bp, int error);
219int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
220void g_io_request(struct bio *bp, struct g_consumer *cp);
221int g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr);
222struct bio *g_new_bio(void);
223void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
224int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
225
226/* geom_kern.c / geom_kernsim.c */
227
|
233};
234
235#ifdef _KERNEL
236
237struct g_kerneldump {
238 off_t offset;
239 off_t length;
240};
241
242MALLOC_DECLARE(M_GEOM);
243
244static __inline void *
245g_malloc(int size, int flags)
246{
247 void *p;
248
249 p = malloc(size, M_GEOM, flags);
250 g_sanity(p);
251 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */
252 return (p);
253}
254
255static __inline void
256g_free(void *ptr)
257{
258 g_sanity(ptr);
259 /* printf("free(%p)\n", ptr); */
260 free(ptr, M_GEOM);
261}
262
263extern struct sx topology_lock;
264
265#define g_topology_lock() \
266 do { \
267 mtx_assert(&Giant, MA_NOTOWNED); \
268 sx_xlock(&topology_lock); \
269 } while (0)
270
271#define g_topology_unlock() \
272 do { \
273 g_sanity(NULL); \
274 sx_xunlock(&topology_lock); \
275 } while (0)
276
277#define g_topology_assert() \
278 do { \
279 g_sanity(NULL); \
280 sx_assert(&topology_lock, SX_XLOCKED); \
281 } while (0)
282
283#define DECLARE_GEOM_CLASS(class, name) \
284 static void \
285 name##init(void) \
286 { \
287 mtx_unlock(&Giant); \
288 g_add_class(&class); \
289 mtx_lock(&Giant); \
290 } \
291 SYSINIT(name, SI_SUB_PSEUDO, SI_ORDER_FIRST, name##init, NULL);
292
293#endif /* _KERNEL */
294
295#define GEOMGETCONF _IOWR('G', 0, struct sbuf)
296
297/* geom_enc.c */
298uint16_t g_dec_be2(u_char *p);
299uint32_t g_dec_be4(u_char *p);
300uint16_t g_dec_le2(u_char *p);
301uint32_t g_dec_le4(u_char *p);
302uint64_t g_dec_le8(u_char *p);
303void g_enc_le2(u_char *p, uint16_t u);
304void g_enc_le4(u_char *p, uint32_t u);
305void g_enc_le8(u_char *p, uint64_t u);
306
307#endif /* _GEOM_GEOM_H_ */
| 240};
241
242#ifdef _KERNEL
243
244struct g_kerneldump {
245 off_t offset;
246 off_t length;
247};
248
249MALLOC_DECLARE(M_GEOM);
250
251static __inline void *
252g_malloc(int size, int flags)
253{
254 void *p;
255
256 p = malloc(size, M_GEOM, flags);
257 g_sanity(p);
258 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */
259 return (p);
260}
261
262static __inline void
263g_free(void *ptr)
264{
265 g_sanity(ptr);
266 /* printf("free(%p)\n", ptr); */
267 free(ptr, M_GEOM);
268}
269
270extern struct sx topology_lock;
271
272#define g_topology_lock() \
273 do { \
274 mtx_assert(&Giant, MA_NOTOWNED); \
275 sx_xlock(&topology_lock); \
276 } while (0)
277
278#define g_topology_unlock() \
279 do { \
280 g_sanity(NULL); \
281 sx_xunlock(&topology_lock); \
282 } while (0)
283
284#define g_topology_assert() \
285 do { \
286 g_sanity(NULL); \
287 sx_assert(&topology_lock, SX_XLOCKED); \
288 } while (0)
289
290#define DECLARE_GEOM_CLASS(class, name) \
291 static void \
292 name##init(void) \
293 { \
294 mtx_unlock(&Giant); \
295 g_add_class(&class); \
296 mtx_lock(&Giant); \
297 } \
298 SYSINIT(name, SI_SUB_PSEUDO, SI_ORDER_FIRST, name##init, NULL);
299
300#endif /* _KERNEL */
301
302#define GEOMGETCONF _IOWR('G', 0, struct sbuf)
303
304/* geom_enc.c */
305uint16_t g_dec_be2(u_char *p);
306uint32_t g_dec_be4(u_char *p);
307uint16_t g_dec_le2(u_char *p);
308uint32_t g_dec_le4(u_char *p);
309uint64_t g_dec_le8(u_char *p);
310void g_enc_le2(u_char *p, uint16_t u);
311void g_enc_le4(u_char *p, uint32_t u);
312void g_enc_le8(u_char *p, uint64_t u);
313
314#endif /* _GEOM_GEOM_H_ */
|