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 110690 2003-02-11 11:55: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
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 g_stat;
62struct thread;
63struct bio;
64struct sbuf;
65struct g_configargs;
66
67typedef int g_config_t (struct g_configargs *ca);
68typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *,
69 int flags);
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 g_taste_t *taste;
92 g_config_t *config;
93 /*
94 * The remaning elements are private and classes should use
95 * the G_CLASS_INITIALIZER macro to initialize them.
96 */
97 LIST_ENTRY(g_class) class;
98 LIST_HEAD(,g_geom) geom;
99 struct g_event *event;
100 u_int protect;
101};
102
103#define G_CLASS_INITIALIZER { 0, 0 }, { 0 }, 0, 0
104
105/*
106 * The g_geom is an instance of a g_class.
107 */
108struct 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 struct g_event *event;
124 unsigned flags;
125#define G_GEOM_WITHER 1
126};
127
128/*
129 * The g_bioq is a queue of struct bio's.
130 * XXX: possibly collection point for statistics.
131 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
132 */
133struct g_bioq {
134 TAILQ_HEAD(, bio) bio_queue;
135 struct mtx bio_queue_lock;
136 int bio_queue_length;
137};
138
139/*
140 * A g_consumer is an attachment point for a g_provider. One g_consumer
141 * can only be attached to one g_provider, but multiple g_consumers
142 * can be attached to one g_provider.
143 */
144
145struct g_consumer {
146 u_int protect;
147 struct g_geom *geom;
148 LIST_ENTRY(g_consumer) consumer;
149 struct g_provider *provider;
150 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */
151 int acr, acw, ace;
152 struct g_event *event;
153 int spoiled;
154 struct g_stat *stat;
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 u_int index;
171 off_t mediasize;
172 u_int sectorsize;
173 struct g_stat *stat;
174 u_int flags;
175#define G_PF_CANDELETE 0x1
176};
177
178/*
179 * This gadget is used by userland to pinpoint a particular instance of
180 * something in the kernel. The name is unreadable on purpose, people
181 * should not encounter it directly but use library functions to deal
182 * with it.
183 * If len is zero, "id" contains a cast of the kernel pointer where the
184 * entity is located, (likely derived from the "id=" attribute in the
185 * XML config) and the g_id*() functions will validate this before allowing
186 * it to be used.
187 * If len is non-zero, it is the strlen() of the name which is pointed to
188 * by "name".
189 */
190struct geomidorname {
191 u_int len;
192 union {
193 const char *name;
194 uintptr_t id;
195 } u;
196};
197
198/* geom_dev.c */
199int g_dev_print(void);
200
201/* geom_dump.c */
202void g_hexdump(void *ptr, int length);
203void g_trace(int level, const char *, ...);
204# define G_T_TOPOLOGY 1
205# define G_T_BIO 2
206# define G_T_ACCESS 4
207
208
209/* geom_event.c */
210typedef void g_call_me_t(void *);
211int g_call_me(g_call_me_t *func, void *arg);
212void g_orphan_provider(struct g_provider *pp, int error);
213void g_waitidle(void);
214
215/* geom_subr.c */
216int g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl);
217int g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl);
218void g_add_class(struct g_class *mp);
219int g_attach(struct g_consumer *cp, struct g_provider *pp);
220void g_destroy_consumer(struct g_consumer *cp);
221void g_destroy_geom(struct g_geom *pp);
222void g_destroy_provider(struct g_provider *pp);
223void g_detach(struct g_consumer *cp);
224void g_error_provider(struct g_provider *pp, int error);
225int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
226#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
227int g_handleattr(struct bio *bp, const char *attribute, void *val, int len);
228int g_handleattr_int(struct bio *bp, const char *attribute, int val);
229int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
230struct g_geom * g_insert_geom(const char *class, struct g_consumer *cp);
231struct g_consumer * g_new_consumer(struct g_geom *gp);
232struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...);
233struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...);
234void g_sanity(void *ptr);
235void g_spoil(struct g_provider *pp, struct g_consumer *cp);
236int g_std_access(struct g_provider *pp, int dr, int dw, int de);
237void g_std_done(struct bio *bp);
238void g_std_spoiled(struct g_consumer *cp);
239struct g_class *g_idclass(struct geomidorname *);
240struct g_geom *g_idgeom(struct geomidorname *);
241struct g_provider *g_idprovider(struct geomidorname *);
242
243
244/* geom_io.c */
245struct bio * g_clone_bio(struct bio *);
246void g_destroy_bio(struct bio *);
247void g_io_deliver(struct bio *bp, int error);
248int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
249void g_io_request(struct bio *bp, struct g_consumer *cp);
250int g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr);
251struct bio *g_new_bio(void);
252void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
253int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
254
255/* geom_kern.c / geom_kernsim.c */
256
257#ifndef _SYS_CONF_H_
258typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
259 int fflag, struct thread *td);
260#endif
261
262struct g_ioctl {
263 u_long cmd;
264 void *data;
265 int fflag;
266 struct thread *td;
267 d_ioctl_t *func;
268 void *dev;
269};
270
271#ifdef _KERNEL
272
273struct g_kerneldump {
274 off_t offset;
275 off_t length;
276};
277
278MALLOC_DECLARE(M_GEOM);
279
280static __inline void *
281g_malloc(int size, int flags)
282{
283 void *p;
284
285 p = malloc(size, M_GEOM, flags);
286 g_sanity(p);
287 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */
288 return (p);
289}
290
291static __inline void
292g_free(void *ptr)
293{
294 g_sanity(ptr);
295 /* printf("free(%p)\n", ptr); */
296 free(ptr, M_GEOM);
297}
298
299extern struct sx topology_lock;
300
301#define g_topology_lock() \
302 do { \
303 mtx_assert(&Giant, MA_NOTOWNED); \
304 sx_xlock(&topology_lock); \
305 } while (0)
306
307#define g_topology_unlock() \
308 do { \
309 g_sanity(NULL); \
310 sx_xunlock(&topology_lock); \
311 } while (0)
312
313#define g_topology_assert() \
314 do { \
315 g_sanity(NULL); \
316 sx_assert(&topology_lock, SX_XLOCKED); \
317 } while (0)
318
319#define DECLARE_GEOM_CLASS_INIT(class, name, init) \
320 SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL);
321
322#define DECLARE_GEOM_CLASS(class, name) \
323 static void \
324 name##init(void) \
325 { \
326 mtx_unlock(&Giant); \
327 g_add_class(&class); \
328 mtx_lock(&Giant); \
329 } \
330 DECLARE_GEOM_CLASS_INIT(class, name, name##init);
331
332#endif /* _KERNEL */
333
334/*
335 * IOCTLS for talking to the geom.ctl device.
336 */
337
338/*
339 * This is the structure used internally in the kernel, it is created and
340 * populated by geom_ctl.c.
341 */
342struct g_configargs {
343 /* Valid on call */
344 struct g_class *class;
345 struct g_geom *geom;
346 struct g_provider *provider;
347 u_int flag;
348 u_int len;
349 void *ptr;
350};
351
352/*
353 * This is the structure used to communicate with userland.
354 */
355struct geomconfiggeom {
356 /* Valid on call */
357 struct geomidorname class;
358 struct geomidorname geom;
359 struct geomidorname provider;
360 u_int flag;
361 u_int len;
362 void *ptr;
363};
364
365#define GEOMCONFIGGEOM _IOW('G', 0, struct geomconfiggeom)
366
367#define GCFG_GENERIC0 0x00000000
368 /*
369 * Generic requests suitable for all classes.
370 */
371#define GCFG_CLASS0 0x10000000
372 /*
373 * Class specific verbs. Allocations in this part of the numberspace
374 * can only be done after review and approval of phk@FreeBSD.org.
375 * All allocations in this space will be listed in this file.
376 */
377#define GCFG_PRIVATE0 0x20000000
378 /*
379 * Lowest allocation for private flag definitions.
380 * If you define you own private "verbs", please express them in
381 * your code as (GCFG_PRIVATE0 + somenumber), where somenumber is
382 * a magic number in the range [0x0 ... 0xfffffff] chosen the way
383 * magic numbers are chosen. Such allocation SHALL NOT be listed
384 * here but SHOULD be listed in some suitable .h file.
385 */
386#define GCFG_RESERVED0 0x30000000
387#define GCFG_RESERVEDN 0xffffffff
388 /*
389 * This area is reserved for the future.
390 */
391
392#define GCFG_CREATE (GCFG_GENERIC0 + 0x0)
393 /*
394 * Request geom construction.
395 * ptr/len is class-specific.
396 */
397#define GCFG_DISMANTLE (GCFG_GENERIC0 + 0x1)
398 /*
399 * Request orderly geom dismantling.
400 * ptr/len is class-specific.
401 */
402
403
404struct gcfg_magicrw {
405 off_t offset;
406 u_int len;
407};
408
409#define GCFG_MAGICREAD (GCFG_GENERIC0 + 0x100)
410 /*
411 * Read of magic spaces.
412 * ptr/len is gcfgmagicrw structure followed by bufferspace
413 * for data to be read.
414 */
415#define GCFG_MAGICWRITE (GCFG_GENERIC0 + 0x101)
416 /*
417 * Write of magic spaces.
418 * as above, only the other way.
419 */
420
421
422/* geom_enc.c */
423uint16_t g_dec_be2(const u_char *p);
424uint32_t g_dec_be4(const u_char *p);
425uint16_t g_dec_le2(const u_char *p);
426uint32_t g_dec_le4(const u_char *p);
427uint64_t g_dec_le8(const u_char *p);
428void g_enc_le2(u_char *p, uint16_t u);
429void g_enc_le4(u_char *p, uint32_t u);
430void g_enc_le8(u_char *p, uint64_t u);
431
432#endif /* _GEOM_GEOM_H_ */