geom.h revision 113937
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 113937 2003-04-23 20:46:12Z phk $ 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> 4792108Sphk 4893248Sphkstruct g_class; 4992108Sphkstruct g_geom; 5092108Sphkstruct g_consumer; 5192108Sphkstruct g_provider; 52110541Sphkstruct g_stat; 5392108Sphkstruct thread; 5492108Sphkstruct bio; 5592108Sphkstruct sbuf; 56112709Sphkstruct gctl_req; 57106518Sphkstruct g_configargs; 5892108Sphk 59106518Sphktypedef int g_config_t (struct g_configargs *ca); 60112709Sphktypedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 61112709Sphktypedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 62113876Sphktypedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 6393248Sphktypedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, 6493250Sphk int flags); 6592108Sphk#define G_TF_NORMAL 0 6692108Sphk#define G_TF_INSIST 1 6792108Sphk#define G_TF_TRANSPARENT 2 6892108Sphktypedef int g_access_t (struct g_provider *, int, int, int); 6992108Sphk/* XXX: not sure about the thread arg */ 7093250Sphktypedef void g_orphan_t (struct g_consumer *); 7192108Sphk 7292108Sphktypedef void g_start_t (struct bio *); 7392108Sphktypedef void g_spoiled_t (struct g_consumer *); 74107953Sphktypedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 7592108Sphk struct g_consumer *, struct g_provider *); 7692108Sphk 7792108Sphk/* 7893248Sphk * The g_class structure describes a transformation class. In other words 7993248Sphk * all BSD disklabel handlers share one g_class, all MBR handlers share 8093248Sphk * one common g_class and so on. 8193248Sphk * Certain operations are instantiated on the class, most notably the 82106518Sphk * taste and config_geom functions. 8392108Sphk */ 8493248Sphkstruct g_class { 85107953Sphk const char *name; 8692108Sphk g_taste_t *taste; 87106518Sphk g_config_t *config; 88112709Sphk g_ctl_create_geom_t *create_geom; 89112709Sphk g_ctl_destroy_geom_t *destroy_geom; 90113876Sphk g_ctl_config_geom_t *config_geom; 9193776Sphk /* 9293776Sphk * The remaning elements are private and classes should use 9398066Sphk * the G_CLASS_INITIALIZER macro to initialize them. 9493776Sphk */ 9593248Sphk LIST_ENTRY(g_class) class; 9692108Sphk LIST_HEAD(,g_geom) geom; 9795310Sphk u_int protect; 9892108Sphk}; 9992108Sphk 100112552Sphk#define G_CLASS_INITIALIZER \ 101112552Sphk .class = { 0, 0 }, \ 102112552Sphk .geom = { 0 }, \ 103112552Sphk .protect = 0 10493776Sphk 10592108Sphk/* 10693248Sphk * The g_geom is an instance of a g_class. 10792108Sphk */ 10892108Sphkstruct g_geom { 10995310Sphk u_int protect; 11092108Sphk char *name; 11193248Sphk struct g_class *class; 11292108Sphk LIST_ENTRY(g_geom) geom; 11392108Sphk LIST_HEAD(,g_consumer) consumer; 11492108Sphk LIST_HEAD(,g_provider) provider; 11592108Sphk TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 11692108Sphk int rank; 11792108Sphk g_start_t *start; 11892108Sphk g_spoiled_t *spoiled; 11992108Sphk g_dumpconf_t *dumpconf; 12093776Sphk g_access_t *access; 12193776Sphk g_orphan_t *orphan; 12292108Sphk void *softc; 12392108Sphk unsigned flags; 12492108Sphk#define G_GEOM_WITHER 1 12592108Sphk}; 12692108Sphk 12792108Sphk/* 12892108Sphk * The g_bioq is a queue of struct bio's. 12992108Sphk * XXX: possibly collection point for statistics. 13092108Sphk * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 13192108Sphk */ 13292108Sphkstruct g_bioq { 13392108Sphk TAILQ_HEAD(, bio) bio_queue; 13492108Sphk struct mtx bio_queue_lock; 13592108Sphk int bio_queue_length; 13692108Sphk}; 13792108Sphk 13892108Sphk/* 13992108Sphk * A g_consumer is an attachment point for a g_provider. One g_consumer 14092108Sphk * can only be attached to one g_provider, but multiple g_consumers 14192108Sphk * can be attached to one g_provider. 14292108Sphk */ 14392108Sphk 14492108Sphkstruct g_consumer { 14595310Sphk u_int protect; 14692108Sphk struct g_geom *geom; 14792108Sphk LIST_ENTRY(g_consumer) consumer; 14892108Sphk struct g_provider *provider; 14992108Sphk LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 15092108Sphk int acr, acw, ace; 15192108Sphk int spoiled; 152112370Sphk struct devstat *stat; 153112026Sphk u_int nstart, nend; 15492108Sphk}; 15592108Sphk 15692108Sphk/* 15792108Sphk * A g_provider is a "logical disk". 15892108Sphk */ 15992108Sphkstruct g_provider { 16095310Sphk u_int protect; 16192108Sphk char *name; 16292108Sphk LIST_ENTRY(g_provider) provider; 16392108Sphk struct g_geom *geom; 16492108Sphk LIST_HEAD(,g_consumer) consumers; 16592108Sphk int acr, acw, ace; 16692108Sphk int error; 16792108Sphk TAILQ_ENTRY(g_provider) orphan; 168107953Sphk u_int index; 16993778Sphk off_t mediasize; 170105542Sphk u_int sectorsize; 171110710Sphk u_int stripesize; 172110710Sphk u_int stripeoffset; 173112370Sphk struct devstat *stat; 174112026Sphk u_int nstart, nend; 175110690Sphk u_int flags; 176110690Sphk#define G_PF_CANDELETE 0x1 17792108Sphk}; 17892108Sphk 179105092Sphk/* 180105092Sphk * This gadget is used by userland to pinpoint a particular instance of 181105092Sphk * something in the kernel. The name is unreadable on purpose, people 182105092Sphk * should not encounter it directly but use library functions to deal 183105092Sphk * with it. 184105092Sphk * If len is zero, "id" contains a cast of the kernel pointer where the 185105092Sphk * entity is located, (likely derived from the "id=" attribute in the 186105092Sphk * XML config) and the g_id*() functions will validate this before allowing 187105092Sphk * it to be used. 188105092Sphk * If len is non-zero, it is the strlen() of the name which is pointed to 189105092Sphk * by "name". 190105092Sphk */ 191105092Sphkstruct geomidorname { 192105092Sphk u_int len; 193105092Sphk union { 194105092Sphk const char *name; 195105092Sphk uintptr_t id; 196105092Sphk } u; 197105092Sphk}; 198105092Sphk 199105947Sphk/* geom_dev.c */ 200105947Sphkint g_dev_print(void); 201105947Sphk 20292108Sphk/* geom_dump.c */ 20392108Sphkvoid g_hexdump(void *ptr, int length); 204107953Sphkvoid g_trace(int level, const char *, ...); 20592108Sphk# define G_T_TOPOLOGY 1 20692108Sphk# define G_T_BIO 2 20792108Sphk# define G_T_ACCESS 4 20892108Sphk 20993090Sphk 21092108Sphk/* geom_event.c */ 211113937Sphktypedef void g_event_t(void *, int flag); 212112989Sphk#define EV_CANCEL 1 213113937Sphkint g_post_event(g_event_t *func, void *arg, int flag, ...); 214112989Sphkvoid g_cancel_event(void *ref); 21592108Sphkvoid g_orphan_provider(struct g_provider *pp, int error); 21698066Sphkvoid g_waitidle(void); 21792108Sphk 21892108Sphk/* geom_subr.c */ 219107453Sphkint g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl); 220107453Sphkint g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl); 22193248Sphkvoid g_add_class(struct g_class *mp); 22292108Sphkint g_attach(struct g_consumer *cp, struct g_provider *pp); 22392108Sphkvoid g_destroy_consumer(struct g_consumer *cp); 22492108Sphkvoid g_destroy_geom(struct g_geom *pp); 22592108Sphkvoid g_destroy_provider(struct g_provider *pp); 22698066Sphkvoid g_detach(struct g_consumer *cp); 22792108Sphkvoid g_error_provider(struct g_provider *pp, int error); 22894284Sphkint g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 22994284Sphk#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 230107953Sphkint g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 231107953Sphkint g_handleattr_int(struct bio *bp, const char *attribute, int val); 232107953Sphkint g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 23392108Sphkstruct g_consumer * g_new_consumer(struct g_geom *gp); 234107953Sphkstruct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 235107953Sphkstruct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 23695310Sphkvoid g_sanity(void *ptr); 23792108Sphkvoid g_spoil(struct g_provider *pp, struct g_consumer *cp); 23892108Sphkint g_std_access(struct g_provider *pp, int dr, int dw, int de); 23992108Sphkvoid g_std_done(struct bio *bp); 24092108Sphkvoid g_std_spoiled(struct g_consumer *cp); 241105092Sphkstruct g_class *g_idclass(struct geomidorname *); 242105092Sphkstruct g_geom *g_idgeom(struct geomidorname *); 243105092Sphkstruct g_provider *g_idprovider(struct geomidorname *); 24492108Sphk 245105092Sphk 24692108Sphk/* geom_io.c */ 24792108Sphkstruct bio * g_clone_bio(struct bio *); 24892108Sphkvoid g_destroy_bio(struct bio *); 249104195Sphkvoid g_io_deliver(struct bio *bp, int error); 25094283Sphkint g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 25192108Sphkvoid g_io_request(struct bio *bp, struct g_consumer *cp); 25292108Sphkstruct bio *g_new_bio(void); 25392108Sphkvoid * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 254104194Sphkint g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 25592108Sphk 25692108Sphk/* geom_kern.c / geom_kernsim.c */ 25792108Sphk 258104602Sphk#ifndef _SYS_CONF_H_ 259104602Sphktypedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data, 260104602Sphk int fflag, struct thread *td); 261104602Sphk#endif 262104602Sphk 26392403Sphkstruct g_ioctl { 26492403Sphk u_long cmd; 26592403Sphk void *data; 26692403Sphk int fflag; 26792403Sphk struct thread *td; 268104602Sphk d_ioctl_t *func; 269109972Sphk void *dev; 27092403Sphk}; 27192108Sphk 27292108Sphk#ifdef _KERNEL 27392108Sphk 27495038Sphkstruct g_kerneldump { 27595038Sphk off_t offset; 27695038Sphk off_t length; 27795038Sphk}; 27895038Sphk 27992108SphkMALLOC_DECLARE(M_GEOM); 28092108Sphk 28192108Sphkstatic __inline void * 28292108Sphkg_malloc(int size, int flags) 28392108Sphk{ 28492108Sphk void *p; 28592108Sphk 28692108Sphk p = malloc(size, M_GEOM, flags); 28795310Sphk g_sanity(p); 28895310Sphk /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 28992108Sphk return (p); 29092108Sphk} 29192108Sphk 29292108Sphkstatic __inline void 29392108Sphkg_free(void *ptr) 29492108Sphk{ 29595310Sphk g_sanity(ptr); 29695310Sphk /* printf("free(%p)\n", ptr); */ 29792108Sphk free(ptr, M_GEOM); 29892108Sphk} 29992108Sphk 30092108Sphkextern struct sx topology_lock; 30192108Sphk 30296987Sphk#define g_topology_lock() \ 30396987Sphk do { \ 30496987Sphk mtx_assert(&Giant, MA_NOTOWNED); \ 30596987Sphk sx_xlock(&topology_lock); \ 30696987Sphk } while (0) 30796987Sphk 30896987Sphk#define g_topology_unlock() \ 30996987Sphk do { \ 31096987Sphk g_sanity(NULL); \ 31196987Sphk sx_xunlock(&topology_lock); \ 31296987Sphk } while (0) 31396987Sphk 31496987Sphk#define g_topology_assert() \ 31596987Sphk do { \ 31696987Sphk g_sanity(NULL); \ 31796987Sphk sx_assert(&topology_lock, SX_XLOCKED); \ 31896987Sphk } while (0) 31996987Sphk 320105061Sphk#define DECLARE_GEOM_CLASS_INIT(class, name, init) \ 321105124Sjake SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL); 322105061Sphk 32393248Sphk#define DECLARE_GEOM_CLASS(class, name) \ 32492108Sphk static void \ 32592108Sphk name##init(void) \ 32692108Sphk { \ 32792108Sphk mtx_unlock(&Giant); \ 32893248Sphk g_add_class(&class); \ 32992108Sphk mtx_lock(&Giant); \ 33092108Sphk } \ 331105061Sphk DECLARE_GEOM_CLASS_INIT(class, name, name##init); 33292108Sphk 33395310Sphk#endif /* _KERNEL */ 33492108Sphk 335112709Sphk/* geom_ctl.c */ 336112709Sphkvoid *gctl_get_param(struct gctl_req *req, const char *param, int *len); 337113892Sphkvoid *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 338113892Sphkint gctl_error(struct gctl_req *req, const char *fmt, ...); 339112709Sphk 34095276Sphk#endif /* _GEOM_GEOM_H_ */ 341