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