geom.h revision 125656
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 125656 2004-02-10 15:53:28Z pjd $ 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> 4695323Sphk#include <sys/sbuf.h> 47115473Sphk#include <sys/module.h> 4892108Sphk 4993248Sphkstruct g_class; 5092108Sphkstruct g_geom; 5192108Sphkstruct g_consumer; 5292108Sphkstruct g_provider; 53110541Sphkstruct g_stat; 5492108Sphkstruct thread; 5592108Sphkstruct bio; 5692108Sphkstruct sbuf; 57112709Sphkstruct gctl_req; 58106518Sphkstruct g_configargs; 5992108Sphk 60106518Sphktypedef int g_config_t (struct g_configargs *ca); 61115624Sphktypedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 62112709Sphktypedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 63112709Sphktypedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 64113876Sphktypedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 65115473Sphktypedef void g_init_t (struct g_class *mp); 66115473Sphktypedef void g_fini_t (struct g_class *mp); 67119660Sphktypedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 68119660Sphktypedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, struct thread *td); 6992108Sphk#define G_TF_NORMAL 0 7092108Sphk#define G_TF_INSIST 1 7192108Sphk#define G_TF_TRANSPARENT 2 7292108Sphktypedef int g_access_t (struct g_provider *, int, int, int); 7392108Sphk/* XXX: not sure about the thread arg */ 7493250Sphktypedef void g_orphan_t (struct g_consumer *); 7592108Sphk 7692108Sphktypedef void g_start_t (struct bio *); 7792108Sphktypedef void g_spoiled_t (struct g_consumer *); 78107953Sphktypedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 7992108Sphk struct g_consumer *, struct g_provider *); 8092108Sphk 8192108Sphk/* 8293248Sphk * The g_class structure describes a transformation class. In other words 8393248Sphk * all BSD disklabel handlers share one g_class, all MBR handlers share 8493248Sphk * one common g_class and so on. 8593248Sphk * Certain operations are instantiated on the class, most notably the 86106518Sphk * taste and config_geom functions. 8792108Sphk */ 8893248Sphkstruct g_class { 89107953Sphk const char *name; 9092108Sphk g_taste_t *taste; 91106518Sphk g_config_t *config; 92115624Sphk g_ctl_req_t *ctlreq; 93115473Sphk g_init_t *init; 94115473Sphk g_fini_t *fini; 95112709Sphk g_ctl_destroy_geom_t *destroy_geom; 9693776Sphk /* 97115468Sphk * The remaining elements are private 98115468Sphk */ 9993248Sphk LIST_ENTRY(g_class) class; 10092108Sphk LIST_HEAD(,g_geom) geom; 10192108Sphk}; 10292108Sphk 10392108Sphk/* 10493248Sphk * The g_geom is an instance of a g_class. 10592108Sphk */ 10692108Sphkstruct g_geom { 10792108Sphk char *name; 10893248Sphk struct g_class *class; 10992108Sphk LIST_ENTRY(g_geom) geom; 11092108Sphk LIST_HEAD(,g_consumer) consumer; 11192108Sphk LIST_HEAD(,g_provider) provider; 11292108Sphk TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 11392108Sphk int rank; 11492108Sphk g_start_t *start; 11592108Sphk g_spoiled_t *spoiled; 11692108Sphk g_dumpconf_t *dumpconf; 11793776Sphk g_access_t *access; 11893776Sphk g_orphan_t *orphan; 119119660Sphk g_ioctl_t *ioctl; 12092108Sphk void *softc; 12192108Sphk unsigned flags; 12292108Sphk#define G_GEOM_WITHER 1 12392108Sphk}; 12492108Sphk 12592108Sphk/* 12692108Sphk * The g_bioq is a queue of struct bio's. 12792108Sphk * XXX: possibly collection point for statistics. 12892108Sphk * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 12992108Sphk */ 13092108Sphkstruct g_bioq { 13192108Sphk TAILQ_HEAD(, bio) bio_queue; 13292108Sphk struct mtx bio_queue_lock; 13392108Sphk int bio_queue_length; 13492108Sphk}; 13592108Sphk 13692108Sphk/* 13792108Sphk * A g_consumer is an attachment point for a g_provider. One g_consumer 13892108Sphk * can only be attached to one g_provider, but multiple g_consumers 13992108Sphk * can be attached to one g_provider. 14092108Sphk */ 14192108Sphk 14292108Sphkstruct g_consumer { 14392108Sphk struct g_geom *geom; 14492108Sphk LIST_ENTRY(g_consumer) consumer; 14592108Sphk struct g_provider *provider; 14692108Sphk LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 14792108Sphk int acr, acw, ace; 14892108Sphk int spoiled; 149112370Sphk struct devstat *stat; 150112026Sphk u_int nstart, nend; 15192108Sphk}; 15292108Sphk 15392108Sphk/* 15492108Sphk * A g_provider is a "logical disk". 15592108Sphk */ 15692108Sphkstruct g_provider { 15792108Sphk char *name; 15892108Sphk LIST_ENTRY(g_provider) provider; 15992108Sphk struct g_geom *geom; 16092108Sphk LIST_HEAD(,g_consumer) consumers; 16192108Sphk int acr, acw, ace; 16292108Sphk int error; 16392108Sphk TAILQ_ENTRY(g_provider) orphan; 164107953Sphk u_int index; 16593778Sphk off_t mediasize; 166105542Sphk u_int sectorsize; 167110710Sphk u_int stripesize; 168110710Sphk u_int stripeoffset; 169112370Sphk struct devstat *stat; 170112026Sphk u_int nstart, nend; 171110690Sphk u_int flags; 172110690Sphk#define G_PF_CANDELETE 0x1 173120851Sphk#define G_PF_WITHER 0x2 174123233Sphk#define G_PF_ORPHAN 0x4 17592108Sphk}; 17692108Sphk 177105947Sphk/* geom_dev.c */ 178115960Sphkvoid g_dev_print(void); 179119593Sphkstruct g_provider *g_dev_getprovider(dev_t dev); 180105947Sphk 18192108Sphk/* geom_dump.c */ 182107953Sphkvoid g_trace(int level, const char *, ...); 18392108Sphk# define G_T_TOPOLOGY 1 18492108Sphk# define G_T_BIO 2 18592108Sphk# define G_T_ACCESS 4 18692108Sphk 18793090Sphk 18892108Sphk/* geom_event.c */ 189113937Sphktypedef void g_event_t(void *, int flag); 190112989Sphk#define EV_CANCEL 1 191113937Sphkint g_post_event(g_event_t *func, void *arg, int flag, ...); 192113940Sphkint g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 193112989Sphkvoid g_cancel_event(void *ref); 19492108Sphkvoid g_orphan_provider(struct g_provider *pp, int error); 19598066Sphkvoid g_waitidle(void); 19692108Sphk 19792108Sphk/* geom_subr.c */ 198107453Sphkint g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl); 199107453Sphkint g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl); 20092108Sphkint g_attach(struct g_consumer *cp, struct g_provider *pp); 20192108Sphkvoid g_destroy_consumer(struct g_consumer *cp); 20292108Sphkvoid g_destroy_geom(struct g_geom *pp); 20392108Sphkvoid g_destroy_provider(struct g_provider *pp); 20498066Sphkvoid g_detach(struct g_consumer *cp); 20592108Sphkvoid g_error_provider(struct g_provider *pp, int error); 206115850Sphkstruct g_provider *g_provider_by_name(char const *arg); 20794284Sphkint g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 20894284Sphk#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 209107953Sphkint g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 210107953Sphkint g_handleattr_int(struct bio *bp, const char *attribute, int val); 211107953Sphkint g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 21292108Sphkstruct g_consumer * g_new_consumer(struct g_geom *gp); 213107953Sphkstruct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 214107953Sphkstruct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 215115623Sphkvoid g_sanity(void const *ptr); 21692108Sphkvoid g_spoil(struct g_provider *pp, struct g_consumer *cp); 21792108Sphkint g_std_access(struct g_provider *pp, int dr, int dw, int de); 21892108Sphkvoid g_std_done(struct bio *bp); 21992108Sphkvoid g_std_spoiled(struct g_consumer *cp); 220114495Sphkvoid g_wither_geom(struct g_geom *gp, int error); 22192108Sphk 222115473Sphkint g_modevent(module_t, int, void *); 223115473Sphk 22492108Sphk/* geom_io.c */ 22592108Sphkstruct bio * g_clone_bio(struct bio *); 22692108Sphkvoid g_destroy_bio(struct bio *); 227104195Sphkvoid g_io_deliver(struct bio *bp, int error); 22894283Sphkint g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 22992108Sphkvoid g_io_request(struct bio *bp, struct g_consumer *cp); 23092108Sphkstruct bio *g_new_bio(void); 23192108Sphkvoid * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 232104194Sphkint g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 23392108Sphk 23492108Sphk/* geom_kern.c / geom_kernsim.c */ 23592108Sphk 23692108Sphk#ifdef _KERNEL 23792108Sphk 23895038Sphkstruct g_kerneldump { 23995038Sphk off_t offset; 24095038Sphk off_t length; 24195038Sphk}; 24295038Sphk 24392108SphkMALLOC_DECLARE(M_GEOM); 24492108Sphk 24592108Sphkstatic __inline void * 24692108Sphkg_malloc(int size, int flags) 24792108Sphk{ 24892108Sphk void *p; 24992108Sphk 25092108Sphk p = malloc(size, M_GEOM, flags); 25195310Sphk g_sanity(p); 25295310Sphk /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 25392108Sphk return (p); 25492108Sphk} 25592108Sphk 25692108Sphkstatic __inline void 25792108Sphkg_free(void *ptr) 25892108Sphk{ 25995310Sphk g_sanity(ptr); 26095310Sphk /* printf("free(%p)\n", ptr); */ 26192108Sphk free(ptr, M_GEOM); 26292108Sphk} 26392108Sphk 26492108Sphkextern struct sx topology_lock; 26592108Sphk 26696987Sphk#define g_topology_lock() \ 26796987Sphk do { \ 26896987Sphk mtx_assert(&Giant, MA_NOTOWNED); \ 26996987Sphk sx_xlock(&topology_lock); \ 27096987Sphk } while (0) 27196987Sphk 27296987Sphk#define g_topology_unlock() \ 27396987Sphk do { \ 27496987Sphk g_sanity(NULL); \ 27596987Sphk sx_xunlock(&topology_lock); \ 27696987Sphk } while (0) 27796987Sphk 27896987Sphk#define g_topology_assert() \ 27996987Sphk do { \ 28096987Sphk g_sanity(NULL); \ 28196987Sphk sx_assert(&topology_lock, SX_XLOCKED); \ 28296987Sphk } while (0) 28396987Sphk 284125656Spjd#define g_topology_assert_not() \ 285125656Spjd do { \ 286125656Spjd g_sanity(NULL); \ 287125656Spjd sx_assert(&topology_lock, SX_UNLOCKED); \ 288125656Spjd } while (0) 289125656Spjd 290115473Sphk#define DECLARE_GEOM_CLASS(class, name) \ 291115473Sphk static moduledata_t name##_mod = { \ 292115473Sphk #name, g_modevent, &class \ 293115473Sphk }; \ 294115473Sphk DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 295105061Sphk 29695310Sphk#endif /* _KERNEL */ 29792108Sphk 298112709Sphk/* geom_ctl.c */ 299115624Sphkvoid gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 300112709Sphkvoid *gctl_get_param(struct gctl_req *req, const char *param, int *len); 301115624Sphkchar const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 302113892Sphkvoid *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 303113892Sphkint gctl_error(struct gctl_req *req, const char *fmt, ...); 304115624Sphkstruct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 305115624Sphkstruct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 306115624Sphkstruct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 307112709Sphk 30895276Sphk#endif /* _GEOM_GEOM_H_ */ 309