geom.h revision 219950
192108Sphk/*- 292108Sphk * Copyright (c) 2002 Poul-Henning Kamp 392108Sphk * Copyright (c) 2002 Networks Associates Technology, Inc. 492108Sphk * All rights reserved. 592108Sphk * 692108Sphk * This software was developed for the FreeBSD Project by Poul-Henning Kamp 792108Sphk * and NAI Labs, the Security Research Division of Network Associates, Inc. 892108Sphk * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 992108Sphk * DARPA CHATS research program. 1092108Sphk * 1192108Sphk * Redistribution and use in source and binary forms, with or without 1292108Sphk * modification, are permitted provided that the following conditions 1392108Sphk * are met: 1492108Sphk * 1. Redistributions of source code must retain the above copyright 1592108Sphk * notice, this list of conditions and the following disclaimer. 1692108Sphk * 2. Redistributions in binary form must reproduce the above copyright 1792108Sphk * notice, this list of conditions and the following disclaimer in the 1892108Sphk * documentation and/or other materials provided with the distribution. 1992108Sphk * 3. The names of the authors may not be used to endorse or promote 2092108Sphk * products derived from this software without specific prior written 2192108Sphk * permission. 2292108Sphk * 2392108Sphk * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 2492108Sphk * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2592108Sphk * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2692108Sphk * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2792108Sphk * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2892108Sphk * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2992108Sphk * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 3092108Sphk * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 3192108Sphk * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3292108Sphk * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3392108Sphk * SUCH DAMAGE. 3492108Sphk * 3592108Sphk * $FreeBSD: head/sys/geom/geom.h 219950 2011-03-24 08:37:48Z mav $ 3692108Sphk */ 3792108Sphk 3895276Sphk#ifndef _GEOM_GEOM_H_ 3995276Sphk#define _GEOM_GEOM_H_ 4095276Sphk 4192108Sphk#include <sys/lock.h> 4292108Sphk#include <sys/mutex.h> 4392108Sphk#include <sys/sx.h> 4492108Sphk#include <sys/queue.h> 4595323Sphk#include <sys/ioccom.h> 46219950Smav#include <sys/conf.h> 4795323Sphk#include <sys/sbuf.h> 48115473Sphk#include <sys/module.h> 4992108Sphk 5093248Sphkstruct g_class; 5192108Sphkstruct g_geom; 5292108Sphkstruct g_consumer; 5392108Sphkstruct g_provider; 54110541Sphkstruct g_stat; 5592108Sphkstruct thread; 5692108Sphkstruct bio; 5792108Sphkstruct sbuf; 58112709Sphkstruct gctl_req; 59106518Sphkstruct g_configargs; 6092108Sphk 61106518Sphktypedef int g_config_t (struct g_configargs *ca); 62115624Sphktypedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 63112709Sphktypedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 64112709Sphktypedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 65113876Sphktypedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 66115473Sphktypedef void g_init_t (struct g_class *mp); 67115473Sphktypedef void g_fini_t (struct g_class *mp); 68119660Sphktypedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 69138732Sphktypedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td); 7092108Sphk#define G_TF_NORMAL 0 7192108Sphk#define G_TF_INSIST 1 7292108Sphk#define G_TF_TRANSPARENT 2 7392108Sphktypedef int g_access_t (struct g_provider *, int, int, int); 7492108Sphk/* XXX: not sure about the thread arg */ 7593250Sphktypedef void g_orphan_t (struct g_consumer *); 7692108Sphk 7792108Sphktypedef void g_start_t (struct bio *); 7892108Sphktypedef void g_spoiled_t (struct g_consumer *); 79107953Sphktypedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 8092108Sphk struct g_consumer *, struct g_provider *); 8192108Sphk 8292108Sphk/* 8393248Sphk * The g_class structure describes a transformation class. In other words 8493248Sphk * all BSD disklabel handlers share one g_class, all MBR handlers share 8593248Sphk * one common g_class and so on. 8693248Sphk * Certain operations are instantiated on the class, most notably the 87106518Sphk * taste and config_geom functions. 8892108Sphk */ 8993248Sphkstruct g_class { 90107953Sphk const char *name; 91133312Sphk u_int version; 9292108Sphk g_taste_t *taste; 93106518Sphk g_config_t *config; 94115624Sphk g_ctl_req_t *ctlreq; 95115473Sphk g_init_t *init; 96115473Sphk g_fini_t *fini; 97112709Sphk g_ctl_destroy_geom_t *destroy_geom; 9893776Sphk /* 99149757Sphk * Default values for geom methods 100133312Sphk */ 101133312Sphk g_start_t *start; 102133312Sphk g_spoiled_t *spoiled; 103133312Sphk g_dumpconf_t *dumpconf; 104133312Sphk g_access_t *access; 105133312Sphk g_orphan_t *orphan; 106133312Sphk g_ioctl_t *ioctl; 107133312Sphk /* 108115468Sphk * The remaining elements are private 109115468Sphk */ 11093248Sphk LIST_ENTRY(g_class) class; 11192108Sphk LIST_HEAD(,g_geom) geom; 11292108Sphk}; 11392108Sphk 114133312Sphk#define G_VERSION_00 0x19950323 115138732Sphk#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 116138732Sphk#define G_VERSION G_VERSION_01 117133312Sphk 11892108Sphk/* 11993248Sphk * The g_geom is an instance of a g_class. 12092108Sphk */ 12192108Sphkstruct g_geom { 12292108Sphk char *name; 12393248Sphk struct g_class *class; 12492108Sphk LIST_ENTRY(g_geom) geom; 12592108Sphk LIST_HEAD(,g_consumer) consumer; 12692108Sphk LIST_HEAD(,g_provider) provider; 12792108Sphk TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 12892108Sphk int rank; 12992108Sphk g_start_t *start; 13092108Sphk g_spoiled_t *spoiled; 13192108Sphk g_dumpconf_t *dumpconf; 13293776Sphk g_access_t *access; 13393776Sphk g_orphan_t *orphan; 134119660Sphk g_ioctl_t *ioctl; 13592108Sphk void *softc; 13692108Sphk unsigned flags; 13792108Sphk#define G_GEOM_WITHER 1 138195195Strasz#define G_GEOM_VOLATILE_BIO 2 13992108Sphk}; 14092108Sphk 14192108Sphk/* 14292108Sphk * The g_bioq is a queue of struct bio's. 14392108Sphk * XXX: possibly collection point for statistics. 14492108Sphk * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 14592108Sphk */ 14692108Sphkstruct g_bioq { 14792108Sphk TAILQ_HEAD(, bio) bio_queue; 14892108Sphk struct mtx bio_queue_lock; 14992108Sphk int bio_queue_length; 15092108Sphk}; 15192108Sphk 15292108Sphk/* 15392108Sphk * A g_consumer is an attachment point for a g_provider. One g_consumer 15492108Sphk * can only be attached to one g_provider, but multiple g_consumers 15592108Sphk * can be attached to one g_provider. 15692108Sphk */ 15792108Sphk 15892108Sphkstruct g_consumer { 15992108Sphk struct g_geom *geom; 16092108Sphk LIST_ENTRY(g_consumer) consumer; 16192108Sphk struct g_provider *provider; 16292108Sphk LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 16392108Sphk int acr, acw, ace; 16492108Sphk int spoiled; 165112370Sphk struct devstat *stat; 166112026Sphk u_int nstart, nend; 167125743Sphk 168125743Sphk /* Two fields for the implementing class to use */ 169125743Sphk void *private; 170125743Sphk u_int index; 17192108Sphk}; 17292108Sphk 17392108Sphk/* 17492108Sphk * A g_provider is a "logical disk". 17592108Sphk */ 17692108Sphkstruct g_provider { 17792108Sphk char *name; 17892108Sphk LIST_ENTRY(g_provider) provider; 17992108Sphk struct g_geom *geom; 18092108Sphk LIST_HEAD(,g_consumer) consumers; 18192108Sphk int acr, acw, ace; 18292108Sphk int error; 18392108Sphk TAILQ_ENTRY(g_provider) orphan; 18493778Sphk off_t mediasize; 185105542Sphk u_int sectorsize; 186110710Sphk u_int stripesize; 187110710Sphk u_int stripeoffset; 188112370Sphk struct devstat *stat; 189112026Sphk u_int nstart, nend; 190110690Sphk u_int flags; 191110690Sphk#define G_PF_CANDELETE 0x1 192120851Sphk#define G_PF_WITHER 0x2 193123233Sphk#define G_PF_ORPHAN 0x4 194125743Sphk 195125743Sphk /* Two fields for the implementing class to use */ 196125743Sphk void *private; 197125743Sphk u_int index; 19892108Sphk}; 19992108Sphk 200193981Sluigi/* 201193981Sluigi * Descriptor of a classifier. We can register a function and 202193981Sluigi * an argument, which is called by g_io_request() on bio's 203193981Sluigi * that are not previously classified. 204193981Sluigi */ 205193981Sluigistruct g_classifier_hook { 206193981Sluigi TAILQ_ENTRY(g_classifier_hook) link; 207193981Sluigi int (*func)(void *arg, struct bio *bp); 208193981Sluigi void *arg; 209193981Sluigi}; 210193981Sluigi 211105947Sphk/* geom_dev.c */ 212130585Sphkstruct cdev; 213115960Sphkvoid g_dev_print(void); 214130585Sphkstruct g_provider *g_dev_getprovider(struct cdev *dev); 215105947Sphk 21692108Sphk/* geom_dump.c */ 217107953Sphkvoid g_trace(int level, const char *, ...); 21892108Sphk# define G_T_TOPOLOGY 1 21992108Sphk# define G_T_BIO 2 22092108Sphk# define G_T_ACCESS 4 22192108Sphk 22293090Sphk 22392108Sphk/* geom_event.c */ 224113937Sphktypedef void g_event_t(void *, int flag); 225112989Sphk#define EV_CANCEL 1 226113937Sphkint g_post_event(g_event_t *func, void *arg, int flag, ...); 227113940Sphkint g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 228112989Sphkvoid g_cancel_event(void *ref); 22992108Sphkvoid g_orphan_provider(struct g_provider *pp, int error); 230137489Spjdvoid g_waitidlelock(void); 23192108Sphk 23292108Sphk/* geom_subr.c */ 233125755Sphkint g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 23492108Sphkint g_attach(struct g_consumer *cp, struct g_provider *pp); 23592108Sphkvoid g_destroy_consumer(struct g_consumer *cp); 23692108Sphkvoid g_destroy_geom(struct g_geom *pp); 23792108Sphkvoid g_destroy_provider(struct g_provider *pp); 23898066Sphkvoid g_detach(struct g_consumer *cp); 23992108Sphkvoid g_error_provider(struct g_provider *pp, int error); 240115850Sphkstruct g_provider *g_provider_by_name(char const *arg); 24194284Sphkint g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 24294284Sphk#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 243187973Smarcelint g_handleattr(struct bio *bp, const char *attribute, const void *val, 244187973Smarcel int len); 245107953Sphkint g_handleattr_int(struct bio *bp, const char *attribute, int val); 246107953Sphkint g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 247187973Smarcelint g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 24892108Sphkstruct g_consumer * g_new_consumer(struct g_geom *gp); 249107953Sphkstruct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 250107953Sphkstruct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 251177509Smarcelint g_retaste(struct g_class *mp); 25292108Sphkvoid g_spoil(struct g_provider *pp, struct g_consumer *cp); 25392108Sphkint g_std_access(struct g_provider *pp, int dr, int dw, int de); 25492108Sphkvoid g_std_done(struct bio *bp); 25592108Sphkvoid g_std_spoiled(struct g_consumer *cp); 256114495Sphkvoid g_wither_geom(struct g_geom *gp, int error); 257137032Sphkvoid g_wither_geom_close(struct g_geom *gp, int error); 258157619Smarcelvoid g_wither_provider(struct g_provider *pp, int error); 25992108Sphk 260162326Spjd#if defined(DIAGNOSTIC) || defined(DDB) 261162326Spjdint g_valid_obj(void const *ptr); 262162326Spjd#endif 263126798Sphk#ifdef DIAGNOSTIC 264126798Sphk#define G_VALID_CLASS(foo) \ 265126798Sphk KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 266126798Sphk#define G_VALID_GEOM(foo) \ 267126798Sphk KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 268126798Sphk#define G_VALID_CONSUMER(foo) \ 269126798Sphk KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 270126798Sphk#define G_VALID_PROVIDER(foo) \ 271126798Sphk KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 272126798Sphk#else 273126798Sphk#define G_VALID_CLASS(foo) do { } while (0) 274126798Sphk#define G_VALID_GEOM(foo) do { } while (0) 275126798Sphk#define G_VALID_CONSUMER(foo) do { } while (0) 276126798Sphk#define G_VALID_PROVIDER(foo) do { } while (0) 277126798Sphk#endif 278126798Sphk 279115473Sphkint g_modevent(module_t, int, void *); 280115473Sphk 28192108Sphk/* geom_io.c */ 28292108Sphkstruct bio * g_clone_bio(struct bio *); 283159304Spjdstruct bio * g_duplicate_bio(struct bio *); 28492108Sphkvoid g_destroy_bio(struct bio *); 285104195Sphkvoid g_io_deliver(struct bio *bp, int error); 28694283Sphkint g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 287163832Spjdint g_io_flush(struct g_consumer *cp); 288193981Sluigiint g_register_classifier(struct g_classifier_hook *hook); 289193981Sluigivoid g_unregister_classifier(struct g_classifier_hook *hook); 29092108Sphkvoid g_io_request(struct bio *bp, struct g_consumer *cp); 29192108Sphkstruct bio *g_new_bio(void); 292134379Sphkstruct bio *g_alloc_bio(void); 29392108Sphkvoid * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 294104194Sphkint g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 295169283Spjdint g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 296125713Spjdvoid g_print_bio(struct bio *bp); 29792108Sphk 29892108Sphk/* geom_kern.c / geom_kernsim.c */ 29992108Sphk 30092108Sphk#ifdef _KERNEL 30192108Sphk 302160301Spjdextern struct sx topology_lock; 303160301Spjd 30495038Sphkstruct g_kerneldump { 30595038Sphk off_t offset; 30695038Sphk off_t length; 307219950Smav struct dumperinfo di; 30895038Sphk}; 30995038Sphk 31092108SphkMALLOC_DECLARE(M_GEOM); 31192108Sphk 31292108Sphkstatic __inline void * 31392108Sphkg_malloc(int size, int flags) 31492108Sphk{ 31592108Sphk void *p; 31692108Sphk 31792108Sphk p = malloc(size, M_GEOM, flags); 31892108Sphk return (p); 31992108Sphk} 32092108Sphk 32192108Sphkstatic __inline void 32292108Sphkg_free(void *ptr) 32392108Sphk{ 324126798Sphk 325126798Sphk#ifdef DIAGNOSTIC 326160301Spjd if (sx_xlocked(&topology_lock)) { 327160301Spjd KASSERT(g_valid_obj(ptr) == 0, 328160301Spjd ("g_free(%p) of live object, type %d", ptr, 329160301Spjd g_valid_obj(ptr))); 330160301Spjd } 331126798Sphk#endif 33292108Sphk free(ptr, M_GEOM); 33392108Sphk} 33492108Sphk 33596987Sphk#define g_topology_lock() \ 33696987Sphk do { \ 33796987Sphk mtx_assert(&Giant, MA_NOTOWNED); \ 33896987Sphk sx_xlock(&topology_lock); \ 33996987Sphk } while (0) 34096987Sphk 341139139Spjd#define g_topology_try_lock() sx_try_xlock(&topology_lock) 342139139Spjd 34396987Sphk#define g_topology_unlock() \ 34496987Sphk do { \ 34596987Sphk sx_xunlock(&topology_lock); \ 34696987Sphk } while (0) 34796987Sphk 34896987Sphk#define g_topology_assert() \ 34996987Sphk do { \ 35096987Sphk sx_assert(&topology_lock, SX_XLOCKED); \ 35196987Sphk } while (0) 35296987Sphk 353125656Spjd#define g_topology_assert_not() \ 354125656Spjd do { \ 355125656Spjd sx_assert(&topology_lock, SX_UNLOCKED); \ 356125656Spjd } while (0) 357125656Spjd 358207671Sjh#define g_topology_sleep(chan, timo) \ 359207671Sjh sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 360207671Sjh 361115473Sphk#define DECLARE_GEOM_CLASS(class, name) \ 362115473Sphk static moduledata_t name##_mod = { \ 363115473Sphk #name, g_modevent, &class \ 364115473Sphk }; \ 365115473Sphk DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 366105061Sphk 36795310Sphk#endif /* _KERNEL */ 36892108Sphk 369112709Sphk/* geom_ctl.c */ 370157581Smarcelint gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 371157581Smarcelvoid gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 372112709Sphkvoid *gctl_get_param(struct gctl_req *req, const char *param, int *len); 373115624Sphkchar const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 374113892Sphkvoid *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 375162352Spjdint gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 376115624Sphkstruct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 377115624Sphkstruct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 378115624Sphkstruct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 379112709Sphk 38095276Sphk#endif /* _GEOM_GEOM_H_ */ 381