geom.h revision 105124
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 105124 2002-10-14 20:20:17Z jake $ 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; 64struct g_createargs; 65 66typedef int g_create_geom_t (struct g_createargs *ca); 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/* 175 * This gadget is used by userland to pinpoint a particular instance of 176 * something in the kernel. The name is unreadable on purpose, people 177 * should not encounter it directly but use library functions to deal 178 * with it. 179 * If len is zero, "id" contains a cast of the kernel pointer where the 180 * entity is located, (likely derived from the "id=" attribute in the 181 * XML config) and the g_id*() functions will validate this before allowing 182 * it to be used. 183 * If len is non-zero, it is the strlen() of the name which is pointed to 184 * by "name". 185 */ 186struct geomidorname { 187 u_int len; 188 union { 189 const char *name; 190 uintptr_t id; 191 } u; 192}; 193 194/* geom_dump.c */ 195void g_hexdump(void *ptr, int length); 196void g_trace(int level, char *, ...); 197# define G_T_TOPOLOGY 1 198# define G_T_BIO 2 199# define G_T_ACCESS 4 200 201 202/* geom_event.c */ 203typedef void g_call_me_t(void *); 204int g_call_me(g_call_me_t *func, void *arg); 205void g_orphan_provider(struct g_provider *pp, int error); 206void g_silence(void); 207void g_waitidle(void); 208 209/* geom_subr.c */ 210int g_access_abs(struct g_consumer *cp, int read, int write, int exclusive); 211int g_access_rel(struct g_consumer *cp, int read, int write, int exclusive); 212void g_add_class(struct g_class *mp); 213int g_attach(struct g_consumer *cp, struct g_provider *pp); 214void g_destroy_consumer(struct g_consumer *cp); 215void g_destroy_geom(struct g_geom *pp); 216void g_destroy_provider(struct g_provider *pp); 217void g_detach(struct g_consumer *cp); 218void g_error_provider(struct g_provider *pp, int error); 219int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 220#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 221int g_handleattr(struct bio *bp, char *attribute, void *val, int len); 222int g_handleattr_int(struct bio *bp, char *attribute, int val); 223int g_handleattr_off_t(struct bio *bp, char *attribute, off_t val); 224struct g_geom * g_insert_geom(char *class, struct g_consumer *cp); 225struct g_consumer * g_new_consumer(struct g_geom *gp); 226struct g_geom * g_new_geomf(struct g_class *mp, char *fmt, ...); 227struct g_provider * g_new_providerf(struct g_geom *gp, char *fmt, ...); 228void g_sanity(void *ptr); 229void g_spoil(struct g_provider *pp, struct g_consumer *cp); 230int g_std_access(struct g_provider *pp, int dr, int dw, int de); 231void g_std_done(struct bio *bp); 232void g_std_spoiled(struct g_consumer *cp); 233struct g_class *g_idclass(struct geomidorname *); 234struct g_geom *g_idgeom(struct geomidorname *); 235struct g_provider *g_idprovider(struct geomidorname *); 236 237 238/* geom_io.c */ 239struct bio * g_clone_bio(struct bio *); 240void g_destroy_bio(struct bio *); 241void g_io_deliver(struct bio *bp, int error); 242int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 243void g_io_request(struct bio *bp, struct g_consumer *cp); 244int g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr); 245struct bio *g_new_bio(void); 246void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 247int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 248 249/* geom_kern.c / geom_kernsim.c */ 250 251#ifndef _SYS_CONF_H_ 252typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data, 253 int fflag, struct thread *td); 254#endif 255 256struct g_ioctl { 257 u_long cmd; 258 void *data; 259 int fflag; 260 struct thread *td; 261 d_ioctl_t *func; 262 dev_t dev; 263}; 264 265#ifdef _KERNEL 266 267struct g_kerneldump { 268 off_t offset; 269 off_t length; 270}; 271 272MALLOC_DECLARE(M_GEOM); 273 274static __inline void * 275g_malloc(int size, int flags) 276{ 277 void *p; 278 279 p = malloc(size, M_GEOM, flags); 280 g_sanity(p); 281 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 282 return (p); 283} 284 285static __inline void 286g_free(void *ptr) 287{ 288 g_sanity(ptr); 289 /* printf("free(%p)\n", ptr); */ 290 free(ptr, M_GEOM); 291} 292 293extern struct sx topology_lock; 294 295#define g_topology_lock() \ 296 do { \ 297 mtx_assert(&Giant, MA_NOTOWNED); \ 298 sx_xlock(&topology_lock); \ 299 } while (0) 300 301#define g_topology_unlock() \ 302 do { \ 303 g_sanity(NULL); \ 304 sx_xunlock(&topology_lock); \ 305 } while (0) 306 307#define g_topology_assert() \ 308 do { \ 309 g_sanity(NULL); \ 310 sx_assert(&topology_lock, SX_XLOCKED); \ 311 } while (0) 312 313#define DECLARE_GEOM_CLASS_INIT(class, name, init) \ 314 SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL); 315 316#define DECLARE_GEOM_CLASS(class, name) \ 317 static void \ 318 name##init(void) \ 319 { \ 320 mtx_unlock(&Giant); \ 321 g_add_class(&class); \ 322 mtx_lock(&Giant); \ 323 } \ 324 DECLARE_GEOM_CLASS_INIT(class, name, name##init); 325 326#endif /* _KERNEL */ 327 328/* 329 * IOCTLS for talking to the geom.ctl device. 330 */ 331 332struct geomgetconf { 333 char *ptr; 334 u_int len; 335}; 336#define GEOMGETCONF _IOW('G', 0, struct geomgetconf) 337 338struct g_createargs { 339 /* Valid on call */ 340 struct g_class *class; 341 struct g_provider *provider; 342 u_int flag; 343 u_int len; 344 void *ptr; 345 /* Valid on return */ 346 struct g_geom *geom; 347}; 348 349struct geomconfiggeom { 350 /* Valid on call */ 351 struct geomidorname class; 352 struct geomidorname provider; 353 u_int flag; 354 u_int len; 355 void *ptr; 356 /* Valid on return */ 357 uintptr_t geom; 358}; 359#define GEOMCONFIGGEOM _IOW('G', 0, struct geomconfiggeom) 360 361 362/* geom_enc.c */ 363uint16_t g_dec_be2(u_char *p); 364uint32_t g_dec_be4(u_char *p); 365uint16_t g_dec_le2(u_char *p); 366uint32_t g_dec_le4(u_char *p); 367uint64_t g_dec_le8(u_char *p); 368void g_enc_le2(u_char *p, uint16_t u); 369void g_enc_le4(u_char *p, uint32_t u); 370void g_enc_le8(u_char *p, uint64_t u); 371 372#endif /* _GEOM_GEOM_H_ */ 373