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.2/sys/geom/geom.h 123993 2003-12-30 12:00:40Z 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 #include <sys/module.h>
48
49 struct g_class;
50 struct g_geom;
51 struct g_consumer;
52 struct g_provider;
53 struct g_stat;
54 struct thread;
55 struct bio;
56 struct sbuf;
57 struct gctl_req;
58 struct g_configargs;
59
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, struct thread *td);
69 #define G_TF_NORMAL 0
70 #define G_TF_INSIST 1
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 *);
75
76 typedef void g_start_t (struct bio *);
77 typedef void g_spoiled_t (struct g_consumer *);
78 typedef 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 */
88 struct g_class {
89 const char *name;
90 g_taste_t *taste;
91 g_config_t *config;
92 g_ctl_req_t *ctlreq;
93 g_init_t *init;
94 g_fini_t *fini;
95 g_ctl_destroy_geom_t *destroy_geom;
96 /*
97 * The remaining elements are private
98 */
99 LIST_ENTRY(g_class) class;
100 LIST_HEAD(,g_geom) geom;
101 };
102
103 /*
104 * The g_geom is an instance of a g_class.
105 */
106 struct g_geom {
107 char *name;
108 struct g_class *class;
109 LIST_ENTRY(g_geom) geom;
110 LIST_HEAD(,g_consumer) consumer;
111 LIST_HEAD(,g_provider) provider;
112 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */
113 int rank;
114 g_start_t *start;
115 g_spoiled_t *spoiled;
116 g_dumpconf_t *dumpconf;
117 g_access_t *access;
118 g_orphan_t *orphan;
119 g_ioctl_t *ioctl;
120 void *softc;
121 unsigned flags;
122 #define G_GEOM_WITHER 1
123 };
124
125 /*
126 * The g_bioq is a queue of struct bio's.
127 * XXX: possibly collection point for statistics.
128 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
129 */
130 struct g_bioq {
131 TAILQ_HEAD(, bio) bio_queue;
132 struct mtx bio_queue_lock;
133 int bio_queue_length;
134 };
135
136 /*
137 * A g_consumer is an attachment point for a g_provider. One g_consumer
138 * can only be attached to one g_provider, but multiple g_consumers
139 * can be attached to one g_provider.
140 */
141
142 struct g_consumer {
143 struct g_geom *geom;
144 LIST_ENTRY(g_consumer) consumer;
145 struct g_provider *provider;
146 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
147 int acr, acw, ace;
148 int spoiled;
149 struct devstat *stat;
150 u_int nstart, nend;
151 };
152
153 /*
154 * A g_provider is a "logical disk".
155 */
156 struct g_provider {
157 char *name;
158 LIST_ENTRY(g_provider) provider;
159 struct g_geom *geom;
160 LIST_HEAD(,g_consumer) consumers;
161 int acr, acw, ace;
162 int error;
163 TAILQ_ENTRY(g_provider) orphan;
164 u_int index;
165 off_t mediasize;
166 u_int sectorsize;
167 u_int stripesize;
168 u_int stripeoffset;
169 struct devstat *stat;
170 u_int nstart, nend;
171 u_int flags;
172 #define G_PF_CANDELETE 0x1
173 #define G_PF_WITHER 0x2
174 #define G_PF_ORPHAN 0x4
175 };
176
177 /* geom_dev.c */
178 void g_dev_print(void);
179 struct g_provider *g_dev_getprovider(dev_t dev);
180
181 /* geom_dump.c */
182 void g_hexdump(void *ptr, int length);
183 void g_trace(int level, const char *, ...);
184 # define G_T_TOPOLOGY 1
185 # define G_T_BIO 2
186 # define G_T_ACCESS 4
187
188
189 /* geom_event.c */
190 typedef void g_event_t(void *, int flag);
191 #define EV_CANCEL 1
192 int g_post_event(g_event_t *func, void *arg, int flag, ...);
193 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
194 void g_cancel_event(void *ref);
195 void g_orphan_provider(struct g_provider *pp, int error);
196 void g_waitidle(void);
197
198 /* geom_subr.c */
199 int g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl);
200 int g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl);
201 int g_attach(struct g_consumer *cp, struct g_provider *pp);
202 void g_destroy_consumer(struct g_consumer *cp);
203 void g_destroy_geom(struct g_geom *pp);
204 void g_destroy_provider(struct g_provider *pp);
205 void g_detach(struct g_consumer *cp);
206 void g_error_provider(struct g_provider *pp, int error);
207 struct g_provider *g_provider_by_name(char const *arg);
208 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
209 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
210 int g_handleattr(struct bio *bp, const char *attribute, void *val, int len);
211 int g_handleattr_int(struct bio *bp, const char *attribute, int val);
212 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
213 struct g_consumer * g_new_consumer(struct g_geom *gp);
214 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
215 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
216 void g_sanity(void const *ptr);
217 void g_spoil(struct g_provider *pp, struct g_consumer *cp);
218 int g_std_access(struct g_provider *pp, int dr, int dw, int de);
219 void g_std_done(struct bio *bp);
220 void g_std_spoiled(struct g_consumer *cp);
221 void g_wither_geom(struct g_geom *gp, int error);
222
223 int g_modevent(module_t, int, void *);
224
225 /* geom_io.c */
226 struct bio * g_clone_bio(struct bio *);
227 void g_destroy_bio(struct bio *);
228 void g_io_deliver(struct bio *bp, int error);
229 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
230 void g_io_request(struct bio *bp, struct g_consumer *cp);
231 struct bio *g_new_bio(void);
232 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
233 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
234
235 /* geom_kern.c / geom_kernsim.c */
236
237 #ifdef _KERNEL
238
239 struct g_kerneldump {
240 off_t offset;
241 off_t length;
242 };
243
244 MALLOC_DECLARE(M_GEOM);
245
246 static __inline void *
247 g_malloc(int size, int flags)
248 {
249 void *p;
250
251 p = malloc(size, M_GEOM, flags);
252 g_sanity(p);
253 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */
254 return (p);
255 }
256
257 static __inline void
258 g_free(void *ptr)
259 {
260 g_sanity(ptr);
261 /* printf("free(%p)\n", ptr); */
262 free(ptr, M_GEOM);
263 }
264
265 extern struct sx topology_lock;
266
267 #define g_topology_lock() \
268 do { \
269 mtx_assert(&Giant, MA_NOTOWNED); \
270 sx_xlock(&topology_lock); \
271 } while (0)
272
273 #define g_topology_unlock() \
274 do { \
275 g_sanity(NULL); \
276 sx_xunlock(&topology_lock); \
277 } while (0)
278
279 #define g_topology_assert() \
280 do { \
281 g_sanity(NULL); \
282 sx_assert(&topology_lock, SX_XLOCKED); \
283 } while (0)
284
285 #define DECLARE_GEOM_CLASS(class, name) \
286 static moduledata_t name##_mod = { \
287 #name, g_modevent, &class \
288 }; \
289 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
290
291 #endif /* _KERNEL */
292
293 /* geom_ctl.c */
294 void gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
295 void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
296 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
297 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
298 int gctl_error(struct gctl_req *req, const char *fmt, ...);
299 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
300 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg);
301 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
302
303 #endif /* _GEOM_GEOM_H_ */
Cache object: e3affc50a81db0b35c6955b8ad917ae9
|