FreeBSD/Linux Kernel Cross Reference
sys/geom/geom.h
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: releng/5.1/sys/geom/geom.h 114670 2003-05-04 19:24:34Z phk $
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 struct g_class;
49 struct g_geom;
50 struct g_consumer;
51 struct g_provider;
52 struct g_stat;
53 struct thread;
54 struct bio;
55 struct sbuf;
56 struct gctl_req;
57 struct g_configargs;
58
59 typedef int g_config_t (struct g_configargs *ca);
60 typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
61 typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
62 typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
63 typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *,
64 int flags);
65 #define G_TF_NORMAL 0
66 #define G_TF_INSIST 1
67 #define G_TF_TRANSPARENT 2
68 typedef int g_access_t (struct g_provider *, int, int, int);
69 /* XXX: not sure about the thread arg */
70 typedef void g_orphan_t (struct g_consumer *);
71
72 typedef void g_start_t (struct bio *);
73 typedef void g_spoiled_t (struct g_consumer *);
74 typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
75 struct g_consumer *, struct g_provider *);
76
77 /*
78 * The g_class structure describes a transformation class. In other words
79 * all BSD disklabel handlers share one g_class, all MBR handlers share
80 * one common g_class and so on.
81 * Certain operations are instantiated on the class, most notably the
82 * taste and config_geom functions.
83 */
84 struct g_class {
85 const char *name;
86 g_taste_t *taste;
87 g_config_t *config;
88 g_ctl_create_geom_t *create_geom;
89 g_ctl_destroy_geom_t *destroy_geom;
90 g_ctl_config_geom_t *config_geom;
91 /*
92 * The remaning elements are private and classes should use
93 * the G_CLASS_INITIALIZER macro to initialize them.
94 */
95 LIST_ENTRY(g_class) class;
96 LIST_HEAD(,g_geom) geom;
97 u_int protect;
98 };
99
100 #define G_CLASS_INITIALIZER \
101 .class = { 0, 0 }, \
102 .geom = { 0 }, \
103 .protect = 0
104
105 /*
106 * The g_geom is an instance of a g_class.
107 */
108 struct g_geom {
109 u_int protect;
110 char *name;
111 struct g_class *class;
112 LIST_ENTRY(g_geom) geom;
113 LIST_HEAD(,g_consumer) consumer;
114 LIST_HEAD(,g_provider) provider;
115 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */
116 int rank;
117 g_start_t *start;
118 g_spoiled_t *spoiled;
119 g_dumpconf_t *dumpconf;
120 g_access_t *access;
121 g_orphan_t *orphan;
122 void *softc;
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 */
132 struct 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
144 struct 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 int spoiled;
152 struct devstat *stat;
153 u_int nstart, nend;
154 };
155
156 /*
157 * A g_provider is a "logical disk".
158 */
159 struct g_provider {
160 u_int protect;
161 char *name;
162 LIST_ENTRY(g_provider) provider;
163 struct g_geom *geom;
164 LIST_HEAD(,g_consumer) consumers;
165 int acr, acw, ace;
166 int error;
167 TAILQ_ENTRY(g_provider) orphan;
168 u_int index;
169 off_t mediasize;
170 u_int sectorsize;
171 u_int stripesize;
172 u_int stripeoffset;
173 struct devstat *stat;
174 u_int nstart, nend;
175 u_int flags;
176 #define G_PF_CANDELETE 0x1
177 };
178
179 /* geom_dev.c */
180 int g_dev_print(void);
181
182 /* geom_dump.c */
183 void g_hexdump(void *ptr, int length);
184 void g_trace(int level, const char *, ...);
185 # define G_T_TOPOLOGY 1
186 # define G_T_BIO 2
187 # define G_T_ACCESS 4
188
189
190 /* geom_event.c */
191 typedef void g_event_t(void *, int flag);
192 #define EV_CANCEL 1
193 int g_post_event(g_event_t *func, void *arg, int flag, ...);
194 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
195 void g_cancel_event(void *ref);
196 void g_orphan_provider(struct g_provider *pp, int error);
197 void g_waitidle(void);
198
199 /* geom_subr.c */
200 int g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl);
201 int g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl);
202 void g_add_class(struct g_class *mp);
203 int g_attach(struct g_consumer *cp, struct g_provider *pp);
204 void g_destroy_consumer(struct g_consumer *cp);
205 void g_destroy_geom(struct g_geom *pp);
206 void g_destroy_provider(struct g_provider *pp);
207 void g_detach(struct g_consumer *cp);
208 void g_error_provider(struct g_provider *pp, int error);
209 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
210 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
211 int g_handleattr(struct bio *bp, const char *attribute, void *val, int len);
212 int g_handleattr_int(struct bio *bp, const char *attribute, int val);
213 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
214 struct g_consumer * g_new_consumer(struct g_geom *gp);
215 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
216 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
217 void g_sanity(void *ptr);
218 void g_spoil(struct g_provider *pp, struct g_consumer *cp);
219 int g_std_access(struct g_provider *pp, int dr, int dw, int de);
220 void g_std_done(struct bio *bp);
221 void g_std_spoiled(struct g_consumer *cp);
222 void g_wither_geom(struct g_geom *gp, int error);
223
224 /* geom_io.c */
225 struct bio * g_clone_bio(struct bio *);
226 void g_destroy_bio(struct bio *);
227 void g_io_deliver(struct bio *bp, int error);
228 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
229 void g_io_request(struct bio *bp, struct g_consumer *cp);
230 struct bio *g_new_bio(void);
231 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
232 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
233
234 /* geom_kern.c / geom_kernsim.c */
235
236 #ifndef _SYS_CONF_H_
237 typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
238 int fflag, struct thread *td);
239 #endif
240
241 struct g_ioctl {
242 u_long cmd;
243 void *data;
244 int fflag;
245 struct thread *td;
246 d_ioctl_t *func;
247 void *dev;
248 };
249
250 #ifdef _KERNEL
251
252 struct g_kerneldump {
253 off_t offset;
254 off_t length;
255 };
256
257 MALLOC_DECLARE(M_GEOM);
258
259 static __inline void *
260 g_malloc(int size, int flags)
261 {
262 void *p;
263
264 p = malloc(size, M_GEOM, flags);
265 g_sanity(p);
266 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */
267 return (p);
268 }
269
270 static __inline void
271 g_free(void *ptr)
272 {
273 g_sanity(ptr);
274 /* printf("free(%p)\n", ptr); */
275 free(ptr, M_GEOM);
276 }
277
278 extern struct sx topology_lock;
279
280 #define g_topology_lock() \
281 do { \
282 mtx_assert(&Giant, MA_NOTOWNED); \
283 sx_xlock(&topology_lock); \
284 } while (0)
285
286 #define g_topology_unlock() \
287 do { \
288 g_sanity(NULL); \
289 sx_xunlock(&topology_lock); \
290 } while (0)
291
292 #define g_topology_assert() \
293 do { \
294 g_sanity(NULL); \
295 sx_assert(&topology_lock, SX_XLOCKED); \
296 } while (0)
297
298 #define DECLARE_GEOM_CLASS_INIT(class, name, init) \
299 SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL);
300
301 #define DECLARE_GEOM_CLASS(class, name) \
302 static void \
303 name##init(void) \
304 { \
305 mtx_unlock(&Giant); \
306 g_add_class(&class); \
307 mtx_lock(&Giant); \
308 } \
309 DECLARE_GEOM_CLASS_INIT(class, name, name##init);
310
311 #endif /* _KERNEL */
312
313 /* geom_ctl.c */
314 int gctl_set_param(struct gctl_req *req, const char *param, void *ptr, int len);
315 void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
316 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
317 int gctl_error(struct gctl_req *req, const char *fmt, ...);
318
319 #endif /* _GEOM_GEOM_H_ */
Cache object: 8439f8a903e002baf07361f19f1b2c32
|