geom.h revision 157619
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 157619 2006-04-10 03:55:13Z marcel $ 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 49struct g_class; 50struct g_geom; 51struct g_consumer; 52struct g_provider; 53struct g_stat; 54struct thread; 55struct bio; 56struct sbuf; 57struct gctl_req; 58struct g_configargs; 59 60typedef int g_config_t (struct g_configargs *ca); 61typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 62typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 63typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 64typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 65typedef void g_init_t (struct g_class *mp); 66typedef void g_fini_t (struct g_class *mp); 67typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 68typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td); 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 *, 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 */ 88struct g_class { 89 const char *name; 90 u_int version; 91 g_taste_t *taste; 92 g_config_t *config; 93 g_ctl_req_t *ctlreq; 94 g_init_t *init; 95 g_fini_t *fini; 96 g_ctl_destroy_geom_t *destroy_geom; 97 /* 98 * Default values for geom methods 99 */ 100 g_start_t *start; 101 g_spoiled_t *spoiled; 102 g_dumpconf_t *dumpconf; 103 g_access_t *access; 104 g_orphan_t *orphan; 105 g_ioctl_t *ioctl; 106 /* 107 * The remaining elements are private 108 */ 109 LIST_ENTRY(g_class) class; 110 LIST_HEAD(,g_geom) geom; 111}; 112 113#define G_VERSION_00 0x19950323 114#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 115#define G_VERSION G_VERSION_01 116 117/* 118 * The g_geom is an instance of a g_class. 119 */ 120struct g_geom { 121 char *name; 122 struct g_class *class; 123 LIST_ENTRY(g_geom) geom; 124 LIST_HEAD(,g_consumer) consumer; 125 LIST_HEAD(,g_provider) provider; 126 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 127 int rank; 128 g_start_t *start; 129 g_spoiled_t *spoiled; 130 g_dumpconf_t *dumpconf; 131 g_access_t *access; 132 g_orphan_t *orphan; 133 g_ioctl_t *ioctl; 134 void *softc; 135 unsigned flags; 136#define G_GEOM_WITHER 1 137}; 138 139/* 140 * The g_bioq is a queue of struct bio's. 141 * XXX: possibly collection point for statistics. 142 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 143 */ 144struct g_bioq { 145 TAILQ_HEAD(, bio) bio_queue; 146 struct mtx bio_queue_lock; 147 int bio_queue_length; 148}; 149 150/* 151 * A g_consumer is an attachment point for a g_provider. One g_consumer 152 * can only be attached to one g_provider, but multiple g_consumers 153 * can be attached to one g_provider. 154 */ 155 156struct g_consumer { 157 struct g_geom *geom; 158 LIST_ENTRY(g_consumer) consumer; 159 struct g_provider *provider; 160 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 161 int acr, acw, ace; 162 int spoiled; 163 struct devstat *stat; 164 u_int nstart, nend; 165 166 /* Two fields for the implementing class to use */ 167 void *private; 168 u_int index; 169}; 170 171/* 172 * A g_provider is a "logical disk". 173 */ 174struct g_provider { 175 char *name; 176 LIST_ENTRY(g_provider) provider; 177 struct g_geom *geom; 178 LIST_HEAD(,g_consumer) consumers; 179 int acr, acw, ace; 180 int error; 181 TAILQ_ENTRY(g_provider) orphan; 182 off_t mediasize; 183 u_int sectorsize; 184 u_int stripesize; 185 u_int stripeoffset; 186 struct devstat *stat; 187 u_int nstart, nend; 188 u_int flags; 189#define G_PF_CANDELETE 0x1 190#define G_PF_WITHER 0x2 191#define G_PF_ORPHAN 0x4 192 193 /* Two fields for the implementing class to use */ 194 void *private; 195 u_int index; 196}; 197 198/* geom_dev.c */ 199struct cdev; 200void g_dev_print(void); 201struct g_provider *g_dev_getprovider(struct cdev *dev); 202 203/* geom_dump.c */ 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_event_t(void *, int flag); 212#define EV_CANCEL 1 213int g_post_event(g_event_t *func, void *arg, int flag, ...); 214int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 215void g_cancel_event(void *ref); 216void g_orphan_provider(struct g_provider *pp, int error); 217void g_waitidlelock(void); 218 219/* geom_subr.c */ 220int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 221int g_attach(struct g_consumer *cp, struct g_provider *pp); 222void g_destroy_consumer(struct g_consumer *cp); 223void g_destroy_geom(struct g_geom *pp); 224void g_destroy_provider(struct g_provider *pp); 225void g_detach(struct g_consumer *cp); 226void g_error_provider(struct g_provider *pp, int error); 227struct g_provider *g_provider_by_name(char const *arg); 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_spoil(struct g_provider *pp, struct g_consumer *cp); 237int g_std_access(struct g_provider *pp, int dr, int dw, int de); 238void g_std_done(struct bio *bp); 239void g_std_spoiled(struct g_consumer *cp); 240void g_wither_geom(struct g_geom *gp, int error); 241void g_wither_geom_close(struct g_geom *gp, int error); 242void g_wither_provider(struct g_provider *pp, int error); 243 244#ifdef DIAGNOSTIC 245int g_valid_obj(void const *ptr); 246#define G_VALID_CLASS(foo) \ 247 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 248#define G_VALID_GEOM(foo) \ 249 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 250#define G_VALID_CONSUMER(foo) \ 251 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 252#define G_VALID_PROVIDER(foo) \ 253 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 254#else 255#define G_VALID_CLASS(foo) do { } while (0) 256#define G_VALID_GEOM(foo) do { } while (0) 257#define G_VALID_CONSUMER(foo) do { } while (0) 258#define G_VALID_PROVIDER(foo) do { } while (0) 259#endif 260 261int g_modevent(module_t, int, void *); 262 263/* geom_io.c */ 264struct bio * g_clone_bio(struct bio *); 265void g_destroy_bio(struct bio *); 266void g_io_deliver(struct bio *bp, int error); 267int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 268void g_io_request(struct bio *bp, struct g_consumer *cp); 269struct bio *g_new_bio(void); 270struct bio *g_alloc_bio(void); 271void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 272int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 273void g_print_bio(struct bio *bp); 274 275/* geom_kern.c / geom_kernsim.c */ 276 277#ifdef _KERNEL 278 279struct g_kerneldump { 280 off_t offset; 281 off_t length; 282}; 283 284MALLOC_DECLARE(M_GEOM); 285 286static __inline void * 287g_malloc(int size, int flags) 288{ 289 void *p; 290 291 p = malloc(size, M_GEOM, flags); 292 return (p); 293} 294 295static __inline void 296g_free(void *ptr) 297{ 298 299#ifdef DIAGNOSTIC 300 KASSERT(g_valid_obj(ptr) == 0, 301 ("g_free(%p) of live object, type %d", ptr, g_valid_obj(ptr))); 302#endif 303 free(ptr, M_GEOM); 304} 305 306extern struct sx topology_lock; 307 308#define g_topology_lock() \ 309 do { \ 310 mtx_assert(&Giant, MA_NOTOWNED); \ 311 sx_xlock(&topology_lock); \ 312 } while (0) 313 314#define g_topology_try_lock() sx_try_xlock(&topology_lock) 315 316#define g_topology_unlock() \ 317 do { \ 318 sx_xunlock(&topology_lock); \ 319 } while (0) 320 321#define g_topology_assert() \ 322 do { \ 323 sx_assert(&topology_lock, SX_XLOCKED); \ 324 } while (0) 325 326#define g_topology_assert_not() \ 327 do { \ 328 sx_assert(&topology_lock, SX_UNLOCKED); \ 329 } while (0) 330 331#define DECLARE_GEOM_CLASS(class, name) \ 332 static moduledata_t name##_mod = { \ 333 #name, g_modevent, &class \ 334 }; \ 335 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 336 337#endif /* _KERNEL */ 338 339/* geom_ctl.c */ 340int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 341void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 342void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 343char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 344void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 345int gctl_error(struct gctl_req *req, const char *fmt, ...); 346struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 347struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 348struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 349 350#endif /* _GEOM_GEOM_H_ */ 351