geom.h revision 119660
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 119660 2003-09-01 20:45:32Z 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 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, 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 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 */ 106struct 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 */ 130struct 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 142struct 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 */ 156struct 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}; 174 175/* geom_dev.c */ 176void g_dev_print(void); 177struct g_provider *g_dev_getprovider(dev_t dev); 178 179/* geom_dump.c */ 180void g_hexdump(void *ptr, int length); 181void g_trace(int level, const char *, ...); 182# define G_T_TOPOLOGY 1 183# define G_T_BIO 2 184# define G_T_ACCESS 4 185 186 187/* geom_event.c */ 188typedef void g_event_t(void *, int flag); 189#define EV_CANCEL 1 190int g_post_event(g_event_t *func, void *arg, int flag, ...); 191int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 192void g_cancel_event(void *ref); 193void g_orphan_provider(struct g_provider *pp, int error); 194void g_waitidle(void); 195 196/* geom_subr.c */ 197int g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl); 198int g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl); 199int g_attach(struct g_consumer *cp, struct g_provider *pp); 200void g_destroy_consumer(struct g_consumer *cp); 201void g_destroy_geom(struct g_geom *pp); 202void g_destroy_provider(struct g_provider *pp); 203void g_detach(struct g_consumer *cp); 204void g_error_provider(struct g_provider *pp, int error); 205struct g_provider *g_provider_by_name(char const *arg); 206int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 207#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 208int g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 209int g_handleattr_int(struct bio *bp, const char *attribute, int val); 210int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 211struct g_consumer * g_new_consumer(struct g_geom *gp); 212struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 213struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 214void g_sanity(void const *ptr); 215void g_spoil(struct g_provider *pp, struct g_consumer *cp); 216int g_std_access(struct g_provider *pp, int dr, int dw, int de); 217void g_std_done(struct bio *bp); 218void g_std_spoiled(struct g_consumer *cp); 219void g_wither_geom(struct g_geom *gp, int error); 220 221int g_modevent(module_t, int, void *); 222 223/* geom_io.c */ 224struct bio * g_clone_bio(struct bio *); 225void g_destroy_bio(struct bio *); 226void g_io_deliver(struct bio *bp, int error); 227int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 228void g_io_request(struct bio *bp, struct g_consumer *cp); 229struct bio *g_new_bio(void); 230void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 231int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 232 233/* geom_kern.c / geom_kernsim.c */ 234 235#ifdef _KERNEL 236 237struct g_kerneldump { 238 off_t offset; 239 off_t length; 240}; 241 242MALLOC_DECLARE(M_GEOM); 243 244static __inline void * 245g_malloc(int size, int flags) 246{ 247 void *p; 248 249 p = malloc(size, M_GEOM, flags); 250 g_sanity(p); 251 /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 252 return (p); 253} 254 255static __inline void 256g_free(void *ptr) 257{ 258 g_sanity(ptr); 259 /* printf("free(%p)\n", ptr); */ 260 free(ptr, M_GEOM); 261} 262 263extern struct sx topology_lock; 264 265#define g_topology_lock() \ 266 do { \ 267 mtx_assert(&Giant, MA_NOTOWNED); \ 268 sx_xlock(&topology_lock); \ 269 } while (0) 270 271#define g_topology_unlock() \ 272 do { \ 273 g_sanity(NULL); \ 274 sx_xunlock(&topology_lock); \ 275 } while (0) 276 277#define g_topology_assert() \ 278 do { \ 279 g_sanity(NULL); \ 280 sx_assert(&topology_lock, SX_XLOCKED); \ 281 } while (0) 282 283#define DECLARE_GEOM_CLASS(class, name) \ 284 static moduledata_t name##_mod = { \ 285 #name, g_modevent, &class \ 286 }; \ 287 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 288 289#endif /* _KERNEL */ 290 291/* geom_ctl.c */ 292void gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 293void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 294char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 295void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 296int gctl_error(struct gctl_req *req, const char *fmt, ...); 297struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 298struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 299struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 300 301#endif /* _GEOM_GEOM_H_ */ 302