geom.h revision 113892
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 113892 2003-04-23 07:50:01Z 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 48struct g_class; 49struct g_geom; 50struct g_consumer; 51struct g_provider; 52struct g_stat; 53struct thread; 54struct bio; 55struct sbuf; 56struct gctl_req; 57struct g_configargs; 58 59typedef int g_config_t (struct g_configargs *ca); 60typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 61typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 62typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 63typedef 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 68typedef int g_access_t (struct g_provider *, int, int, int); 69/* XXX: not sure about the thread arg */ 70typedef void g_orphan_t (struct g_consumer *); 71 72typedef void g_start_t (struct bio *); 73typedef void g_spoiled_t (struct g_consumer *); 74typedef 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 */ 84struct 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 */ 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 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 int spoiled; 152 struct devstat *stat; 153 u_int nstart, nend; 154}; 155 156/* 157 * A g_provider is a "logical disk". 158 */ 159struct 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/* 180 * This gadget is used by userland to pinpoint a particular instance of 181 * something in the kernel. The name is unreadable on purpose, people 182 * should not encounter it directly but use library functions to deal 183 * with it. 184 * If len is zero, "id" contains a cast of the kernel pointer where the 185 * entity is located, (likely derived from the "id=" attribute in the 186 * XML config) and the g_id*() functions will validate this before allowing 187 * it to be used. 188 * If len is non-zero, it is the strlen() of the name which is pointed to 189 * by "name". 190 */ 191struct geomidorname { 192 u_int len; 193 union { 194 const char *name; 195 uintptr_t id; 196 } u; 197}; 198 199/* geom_dev.c */ 200int g_dev_print(void); 201 202/* geom_dump.c */ 203void g_hexdump(void *ptr, int length); 204void g_trace(int level, const char *, ...); 205# define G_T_TOPOLOGY 1 206# define G_T_BIO 2 207# define G_T_ACCESS 4 208 209 210/* geom_event.c */ 211typedef void g_call_me_t(void *, int flag); 212#define EV_CANCEL 1 213int g_call_me(g_call_me_t *func, void *arg, ...); 214void g_cancel_event(void *ref); 215void g_orphan_provider(struct g_provider *pp, int error); 216void g_waitidle(void); 217 218/* geom_subr.c */ 219int g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl); 220int g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl); 221void g_add_class(struct g_class *mp); 222int g_attach(struct g_consumer *cp, struct g_provider *pp); 223void g_destroy_consumer(struct g_consumer *cp); 224void g_destroy_geom(struct g_geom *pp); 225void g_destroy_provider(struct g_provider *pp); 226void g_detach(struct g_consumer *cp); 227void g_error_provider(struct g_provider *pp, int error); 228int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 229#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 230int g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 231int g_handleattr_int(struct bio *bp, const char *attribute, int val); 232int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 233struct g_consumer * g_new_consumer(struct g_geom *gp); 234struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 235struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 236void g_sanity(void *ptr); 237void g_spoil(struct g_provider *pp, struct g_consumer *cp); 238int g_std_access(struct g_provider *pp, int dr, int dw, int de); 239void g_std_done(struct bio *bp); 240void g_std_spoiled(struct g_consumer *cp); 241struct g_class *g_idclass(struct geomidorname *); 242struct g_geom *g_idgeom(struct geomidorname *); 243struct g_provider *g_idprovider(struct geomidorname *); 244 245 246/* geom_io.c */ 247struct bio * g_clone_bio(struct bio *); 248void g_destroy_bio(struct bio *); 249void g_io_deliver(struct bio *bp, int error); 250int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 251void g_io_request(struct bio *bp, struct g_consumer *cp); 252struct bio *g_new_bio(void); 253void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 254int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 255 256/* geom_kern.c / geom_kernsim.c */ 257 258#ifndef _SYS_CONF_H_ 259typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data, 260 int fflag, struct thread *td); 261#endif 262 263struct g_ioctl { 264 u_long cmd; 265 void *data; 266 int fflag; 267 struct thread *td; 268 d_ioctl_t *func; 269 void *dev; 270}; 271 272#ifdef _KERNEL 273 274struct g_kerneldump { 275 off_t offset; 276 off_t length; 277}; 278 279MALLOC_DECLARE(M_GEOM); 280 281static __inline void * 282g_malloc(int size, int flags) 283{ 284 void *p; 285 286 p = malloc(size, M_GEOM, flags); 287 g_sanity(p); 288 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 289 return (p); 290} 291 292static __inline void 293g_free(void *ptr) 294{ 295 g_sanity(ptr); 296 /* printf("free(%p)\n", ptr); */ 297 free(ptr, M_GEOM); 298} 299 300extern struct sx topology_lock; 301 302#define g_topology_lock() \ 303 do { \ 304 mtx_assert(&Giant, MA_NOTOWNED); \ 305 sx_xlock(&topology_lock); \ 306 } while (0) 307 308#define g_topology_unlock() \ 309 do { \ 310 g_sanity(NULL); \ 311 sx_xunlock(&topology_lock); \ 312 } while (0) 313 314#define g_topology_assert() \ 315 do { \ 316 g_sanity(NULL); \ 317 sx_assert(&topology_lock, SX_XLOCKED); \ 318 } while (0) 319 320#define DECLARE_GEOM_CLASS_INIT(class, name, init) \ 321 SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL); 322 323#define DECLARE_GEOM_CLASS(class, name) \ 324 static void \ 325 name##init(void) \ 326 { \ 327 mtx_unlock(&Giant); \ 328 g_add_class(&class); \ 329 mtx_lock(&Giant); \ 330 } \ 331 DECLARE_GEOM_CLASS_INIT(class, name, name##init); 332 333#endif /* _KERNEL */ 334 335/* geom_ctl.c */ 336void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 337void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 338int gctl_error(struct gctl_req *req, const char *fmt, ...); 339 340#endif /* _GEOM_GEOM_H_ */ 341