geom.h revision 224147
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 224147 2011-07-17 20:35:30Z pjd $ 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/conf.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_attrchanged_t (struct g_consumer *, const char *attr); 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 u_int version; 92 u_int spare0; 93 g_taste_t *taste; 94 g_config_t *config; 95 g_ctl_req_t *ctlreq; 96 g_init_t *init; 97 g_fini_t *fini; 98 g_ctl_destroy_geom_t *destroy_geom; 99 /* 100 * Default values for geom methods 101 */ 102 g_start_t *start; 103 g_spoiled_t *spoiled; 104 g_attrchanged_t *attrchanged; 105 g_dumpconf_t *dumpconf; 106 g_access_t *access; 107 g_orphan_t *orphan; 108 g_ioctl_t *ioctl; 109 void *spare1; 110 void *spare2; 111 /* 112 * The remaining elements are private 113 */ 114 LIST_ENTRY(g_class) class; 115 LIST_HEAD(,g_geom) geom; 116}; 117 118#define G_VERSION_00 0x19950323 119#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 120#define G_VERSION G_VERSION_01 121 122/* 123 * The g_geom is an instance of a g_class. 124 */ 125struct g_geom { 126 char *name; 127 struct g_class *class; 128 LIST_ENTRY(g_geom) geom; 129 LIST_HEAD(,g_consumer) consumer; 130 LIST_HEAD(,g_provider) provider; 131 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 132 int rank; 133 g_start_t *start; 134 g_spoiled_t *spoiled; 135 g_attrchanged_t *attrchanged; 136 g_dumpconf_t *dumpconf; 137 g_access_t *access; 138 g_orphan_t *orphan; 139 g_ioctl_t *ioctl; 140 void *spare0; 141 void *spare1; 142 void *softc; 143 unsigned flags; 144#define G_GEOM_WITHER 1 145#define G_GEOM_VOLATILE_BIO 2 146}; 147 148/* 149 * The g_bioq is a queue of struct bio's. 150 * XXX: possibly collection point for statistics. 151 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 152 */ 153struct g_bioq { 154 TAILQ_HEAD(, bio) bio_queue; 155 struct mtx bio_queue_lock; 156 int bio_queue_length; 157}; 158 159/* 160 * A g_consumer is an attachment point for a g_provider. One g_consumer 161 * can only be attached to one g_provider, but multiple g_consumers 162 * can be attached to one g_provider. 163 */ 164 165struct g_consumer { 166 struct g_geom *geom; 167 LIST_ENTRY(g_consumer) consumer; 168 struct g_provider *provider; 169 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 170 int acr, acw, ace; 171 int spoiled; 172 struct devstat *stat; 173 u_int nstart, nend; 174 175 /* Two fields for the implementing class to use */ 176 void *private; 177 u_int index; 178}; 179 180/* 181 * A g_provider is a "logical disk". 182 */ 183struct g_provider { 184 char *name; 185 LIST_ENTRY(g_provider) provider; 186 struct g_geom *geom; 187 LIST_HEAD(,g_consumer) consumers; 188 int acr, acw, ace; 189 int error; 190 TAILQ_ENTRY(g_provider) orphan; 191 off_t mediasize; 192 u_int sectorsize; 193 u_int stripesize; 194 u_int stripeoffset; 195 struct devstat *stat; 196 u_int nstart, nend; 197 u_int flags; 198#define G_PF_CANDELETE 0x1 199#define G_PF_WITHER 0x2 200#define G_PF_ORPHAN 0x4 201 202 /* Two fields for the implementing class to use */ 203 void *private; 204 u_int index; 205}; 206 207/* 208 * Descriptor of a classifier. We can register a function and 209 * an argument, which is called by g_io_request() on bio's 210 * that are not previously classified. 211 */ 212struct g_classifier_hook { 213 TAILQ_ENTRY(g_classifier_hook) link; 214 int (*func)(void *arg, struct bio *bp); 215 void *arg; 216}; 217 218/* BIO_GETATTR("GEOM::setstate") argument values. */ 219#define G_STATE_FAILED 0 220#define G_STATE_REBUILD 1 221#define G_STATE_RESYNC 2 222#define G_STATE_ACTIVE 3 223 224/* geom_dev.c */ 225struct cdev; 226void g_dev_print(void); 227void g_dev_physpath_changed(void); 228struct g_provider *g_dev_getprovider(struct cdev *dev); 229 230/* geom_dump.c */ 231void g_trace(int level, const char *, ...); 232# define G_T_TOPOLOGY 1 233# define G_T_BIO 2 234# define G_T_ACCESS 4 235 236 237/* geom_event.c */ 238typedef void g_event_t(void *, int flag); 239#define EV_CANCEL 1 240int g_post_event(g_event_t *func, void *arg, int flag, ...); 241int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 242void g_cancel_event(void *ref); 243int g_attr_changed(struct g_provider *pp, const char *attr, int flag); 244void g_orphan_provider(struct g_provider *pp, int error); 245void g_waitidlelock(void); 246 247/* geom_subr.c */ 248int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 249int g_attach(struct g_consumer *cp, struct g_provider *pp); 250int g_compare_names(const char *namea, const char *nameb); 251void g_destroy_consumer(struct g_consumer *cp); 252void g_destroy_geom(struct g_geom *pp); 253void g_destroy_provider(struct g_provider *pp); 254void g_detach(struct g_consumer *cp); 255void g_error_provider(struct g_provider *pp, int error); 256struct g_provider *g_provider_by_name(char const *arg); 257int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 258#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 259int g_handleattr(struct bio *bp, const char *attribute, const void *val, 260 int len); 261int g_handleattr_int(struct bio *bp, const char *attribute, int val); 262int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 263int g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 264struct g_consumer * g_new_consumer(struct g_geom *gp); 265struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 266struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 267int g_retaste(struct g_class *mp); 268void g_spoil(struct g_provider *pp, struct g_consumer *cp); 269int g_std_access(struct g_provider *pp, int dr, int dw, int de); 270void g_std_done(struct bio *bp); 271void g_std_spoiled(struct g_consumer *cp); 272void g_wither_geom(struct g_geom *gp, int error); 273void g_wither_geom_close(struct g_geom *gp, int error); 274void g_wither_provider(struct g_provider *pp, int error); 275 276#if defined(DIAGNOSTIC) || defined(DDB) 277int g_valid_obj(void const *ptr); 278#endif 279#ifdef DIAGNOSTIC 280#define G_VALID_CLASS(foo) \ 281 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 282#define G_VALID_GEOM(foo) \ 283 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 284#define G_VALID_CONSUMER(foo) \ 285 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 286#define G_VALID_PROVIDER(foo) \ 287 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 288#else 289#define G_VALID_CLASS(foo) do { } while (0) 290#define G_VALID_GEOM(foo) do { } while (0) 291#define G_VALID_CONSUMER(foo) do { } while (0) 292#define G_VALID_PROVIDER(foo) do { } while (0) 293#endif 294 295int g_modevent(module_t, int, void *); 296 297/* geom_io.c */ 298struct bio * g_clone_bio(struct bio *); 299struct bio * g_duplicate_bio(struct bio *); 300void g_destroy_bio(struct bio *); 301void g_io_deliver(struct bio *bp, int error); 302int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 303int g_io_flush(struct g_consumer *cp); 304int g_register_classifier(struct g_classifier_hook *hook); 305void g_unregister_classifier(struct g_classifier_hook *hook); 306void g_io_request(struct bio *bp, struct g_consumer *cp); 307struct bio *g_new_bio(void); 308struct bio *g_alloc_bio(void); 309void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 310int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 311int g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 312void g_print_bio(struct bio *bp); 313 314/* geom_kern.c / geom_kernsim.c */ 315 316#ifdef _KERNEL 317 318extern struct sx topology_lock; 319 320struct g_kerneldump { 321 off_t offset; 322 off_t length; 323 struct dumperinfo di; 324}; 325 326MALLOC_DECLARE(M_GEOM); 327 328static __inline void * 329g_malloc(int size, int flags) 330{ 331 void *p; 332 333 p = malloc(size, M_GEOM, flags); 334 return (p); 335} 336 337static __inline void 338g_free(void *ptr) 339{ 340 341#ifdef DIAGNOSTIC 342 if (sx_xlocked(&topology_lock)) { 343 KASSERT(g_valid_obj(ptr) == 0, 344 ("g_free(%p) of live object, type %d", ptr, 345 g_valid_obj(ptr))); 346 } 347#endif 348 free(ptr, M_GEOM); 349} 350 351#define g_topology_lock() \ 352 do { \ 353 mtx_assert(&Giant, MA_NOTOWNED); \ 354 sx_xlock(&topology_lock); \ 355 } while (0) 356 357#define g_topology_try_lock() sx_try_xlock(&topology_lock) 358 359#define g_topology_unlock() \ 360 do { \ 361 sx_xunlock(&topology_lock); \ 362 } while (0) 363 364#define g_topology_assert() \ 365 do { \ 366 sx_assert(&topology_lock, SX_XLOCKED); \ 367 } while (0) 368 369#define g_topology_assert_not() \ 370 do { \ 371 sx_assert(&topology_lock, SX_UNLOCKED); \ 372 } while (0) 373 374#define g_topology_sleep(chan, timo) \ 375 sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 376 377#define DECLARE_GEOM_CLASS(class, name) \ 378 static moduledata_t name##_mod = { \ 379 #name, g_modevent, &class \ 380 }; \ 381 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 382 383#endif /* _KERNEL */ 384 385/* geom_ctl.c */ 386int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 387void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 388void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 389char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 390void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 391int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 392struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 393struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 394struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 395 396#endif /* _GEOM_GEOM_H_ */ 397