geom.h revision 109972
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 109972 2003-01-28 09:47:50Z 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 4895362Sphk#ifdef KERNELSIM 4992108Sphk/* 5092108Sphk * The GEOM subsystem makes a few concessions in order to be able to run as a 5192108Sphk * user-land simulation as well as a kernel component. 5292108Sphk */ 5392514Sphk#include <geom_sim.h> 5492108Sphk#endif 5592108Sphk 5693248Sphkstruct g_class; 5792108Sphkstruct g_geom; 5892108Sphkstruct g_consumer; 5992108Sphkstruct g_provider; 6092108Sphkstruct g_event; 6192108Sphkstruct thread; 6292108Sphkstruct bio; 6392108Sphkstruct sbuf; 64106518Sphkstruct g_configargs; 6592108Sphk 66106518Sphktypedef int g_config_t (struct g_configargs *ca); 6793248Sphktypedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, 6893250Sphk int flags); 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; 9293776Sphk /* 9393776Sphk * The remaning elements are private and classes should use 9498066Sphk * the G_CLASS_INITIALIZER macro to initialize them. 9593776Sphk */ 9693248Sphk LIST_ENTRY(g_class) class; 9792108Sphk LIST_HEAD(,g_geom) geom; 9892108Sphk struct g_event *event; 9995310Sphk u_int protect; 10092108Sphk}; 10192108Sphk 10298066Sphk#define G_CLASS_INITIALIZER { 0, 0 }, { 0 }, 0, 0 10393776Sphk 10492108Sphk/* 10593248Sphk * The g_geom is an instance of a g_class. 10692108Sphk */ 10792108Sphkstruct g_geom { 10895310Sphk u_int protect; 10992108Sphk char *name; 11093248Sphk struct g_class *class; 11192108Sphk LIST_ENTRY(g_geom) geom; 11292108Sphk LIST_HEAD(,g_consumer) consumer; 11392108Sphk LIST_HEAD(,g_provider) provider; 11492108Sphk TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 11592108Sphk int rank; 11692108Sphk g_start_t *start; 11792108Sphk g_spoiled_t *spoiled; 11892108Sphk g_dumpconf_t *dumpconf; 11993776Sphk g_access_t *access; 12093776Sphk g_orphan_t *orphan; 12192108Sphk void *softc; 12292108Sphk struct g_event *event; 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 struct g_event *event; 15292108Sphk 15392108Sphk int biocount; 15492108Sphk int spoiled; 15592108Sphk}; 15692108Sphk 15792108Sphk/* 15892108Sphk * A g_provider is a "logical disk". 15992108Sphk */ 16092108Sphkstruct g_provider { 16195310Sphk u_int protect; 16292108Sphk char *name; 16392108Sphk LIST_ENTRY(g_provider) provider; 16492108Sphk struct g_geom *geom; 16592108Sphk LIST_HEAD(,g_consumer) consumers; 16692108Sphk int acr, acw, ace; 16792108Sphk int error; 16892108Sphk struct g_event *event; 16992108Sphk TAILQ_ENTRY(g_provider) orphan; 170107953Sphk u_int index; 17193778Sphk off_t mediasize; 172105542Sphk u_int sectorsize; 17392108Sphk}; 17492108Sphk 175105092Sphk/* 176105092Sphk * This gadget is used by userland to pinpoint a particular instance of 177105092Sphk * something in the kernel. The name is unreadable on purpose, people 178105092Sphk * should not encounter it directly but use library functions to deal 179105092Sphk * with it. 180105092Sphk * If len is zero, "id" contains a cast of the kernel pointer where the 181105092Sphk * entity is located, (likely derived from the "id=" attribute in the 182105092Sphk * XML config) and the g_id*() functions will validate this before allowing 183105092Sphk * it to be used. 184105092Sphk * If len is non-zero, it is the strlen() of the name which is pointed to 185105092Sphk * by "name". 186105092Sphk */ 187105092Sphkstruct geomidorname { 188105092Sphk u_int len; 189105092Sphk union { 190105092Sphk const char *name; 191105092Sphk uintptr_t id; 192105092Sphk } u; 193105092Sphk}; 194105092Sphk 195105947Sphk/* geom_dev.c */ 196105947Sphkint g_dev_print(void); 197105947Sphk 19892108Sphk/* geom_dump.c */ 19992108Sphkvoid g_hexdump(void *ptr, int length); 200107953Sphkvoid g_trace(int level, const char *, ...); 20192108Sphk# define G_T_TOPOLOGY 1 20292108Sphk# define G_T_BIO 2 20392108Sphk# define G_T_ACCESS 4 20492108Sphk 20593090Sphk 20692108Sphk/* geom_event.c */ 207104056Sphktypedef void g_call_me_t(void *); 208104056Sphkint g_call_me(g_call_me_t *func, void *arg); 20992108Sphkvoid g_orphan_provider(struct g_provider *pp, int error); 21098066Sphkvoid g_waitidle(void); 21192108Sphk 21292108Sphk/* geom_subr.c */ 213107453Sphkint g_access_abs(struct g_consumer *cp, int nread, int nwrite, int nexcl); 214107453Sphkint g_access_rel(struct g_consumer *cp, int nread, int nwrite, int nexcl); 21593248Sphkvoid g_add_class(struct g_class *mp); 21692108Sphkint g_attach(struct g_consumer *cp, struct g_provider *pp); 21792108Sphkvoid g_destroy_consumer(struct g_consumer *cp); 21892108Sphkvoid g_destroy_geom(struct g_geom *pp); 21992108Sphkvoid g_destroy_provider(struct g_provider *pp); 22098066Sphkvoid g_detach(struct g_consumer *cp); 22192108Sphkvoid g_error_provider(struct g_provider *pp, int error); 22294284Sphkint g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 22394284Sphk#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 224107953Sphkint g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 225107953Sphkint g_handleattr_int(struct bio *bp, const char *attribute, int val); 226107953Sphkint g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 227107953Sphkstruct g_geom * g_insert_geom(const char *class, struct g_consumer *cp); 22892108Sphkstruct g_consumer * g_new_consumer(struct g_geom *gp); 229107953Sphkstruct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 230107953Sphkstruct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 23195310Sphkvoid g_sanity(void *ptr); 23292108Sphkvoid g_spoil(struct g_provider *pp, struct g_consumer *cp); 23392108Sphkint g_std_access(struct g_provider *pp, int dr, int dw, int de); 23492108Sphkvoid g_std_done(struct bio *bp); 23592108Sphkvoid g_std_spoiled(struct g_consumer *cp); 236105092Sphkstruct g_class *g_idclass(struct geomidorname *); 237105092Sphkstruct g_geom *g_idgeom(struct geomidorname *); 238105092Sphkstruct g_provider *g_idprovider(struct geomidorname *); 23992108Sphk 240105092Sphk 24192108Sphk/* geom_io.c */ 24292108Sphkstruct bio * g_clone_bio(struct bio *); 24392108Sphkvoid g_destroy_bio(struct bio *); 244104195Sphkvoid g_io_deliver(struct bio *bp, int error); 24594283Sphkint g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 24692108Sphkvoid g_io_request(struct bio *bp, struct g_consumer *cp); 24794283Sphkint g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr); 24892108Sphkstruct bio *g_new_bio(void); 24992108Sphkvoid * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 250104194Sphkint g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 25192108Sphk 25292108Sphk/* geom_kern.c / geom_kernsim.c */ 25392108Sphk 254104602Sphk#ifndef _SYS_CONF_H_ 255104602Sphktypedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data, 256104602Sphk int fflag, struct thread *td); 257104602Sphk#endif 258104602Sphk 25992403Sphkstruct g_ioctl { 26092403Sphk u_long cmd; 26192403Sphk void *data; 26292403Sphk int fflag; 26392403Sphk struct thread *td; 264104602Sphk d_ioctl_t *func; 265109972Sphk void *dev; 26692403Sphk}; 26792108Sphk 26892108Sphk#ifdef _KERNEL 26992108Sphk 27095038Sphkstruct g_kerneldump { 27195038Sphk off_t offset; 27295038Sphk off_t length; 27395038Sphk}; 27495038Sphk 27592108SphkMALLOC_DECLARE(M_GEOM); 27692108Sphk 27792108Sphkstatic __inline void * 27892108Sphkg_malloc(int size, int flags) 27992108Sphk{ 28092108Sphk void *p; 28192108Sphk 28292108Sphk p = malloc(size, M_GEOM, flags); 28395310Sphk g_sanity(p); 28495310Sphk /* printf("malloc(%d, %x) -> %p\n", size, flags, p); */ 28592108Sphk return (p); 28692108Sphk} 28792108Sphk 28892108Sphkstatic __inline void 28992108Sphkg_free(void *ptr) 29092108Sphk{ 29195310Sphk g_sanity(ptr); 29295310Sphk /* printf("free(%p)\n", ptr); */ 29392108Sphk free(ptr, M_GEOM); 29492108Sphk} 29592108Sphk 29692108Sphkextern struct sx topology_lock; 29792108Sphk 29896987Sphk#define g_topology_lock() \ 29996987Sphk do { \ 30096987Sphk mtx_assert(&Giant, MA_NOTOWNED); \ 30196987Sphk sx_xlock(&topology_lock); \ 30296987Sphk } while (0) 30396987Sphk 30496987Sphk#define g_topology_unlock() \ 30596987Sphk do { \ 30696987Sphk g_sanity(NULL); \ 30796987Sphk sx_xunlock(&topology_lock); \ 30896987Sphk } while (0) 30996987Sphk 31096987Sphk#define g_topology_assert() \ 31196987Sphk do { \ 31296987Sphk g_sanity(NULL); \ 31396987Sphk sx_assert(&topology_lock, SX_XLOCKED); \ 31496987Sphk } while (0) 31596987Sphk 316105061Sphk#define DECLARE_GEOM_CLASS_INIT(class, name, init) \ 317105124Sjake SYSINIT(name, SI_SUB_DRIVERS, SI_ORDER_FIRST, init, NULL); 318105061Sphk 31993248Sphk#define DECLARE_GEOM_CLASS(class, name) \ 32092108Sphk static void \ 32192108Sphk name##init(void) \ 32292108Sphk { \ 32392108Sphk mtx_unlock(&Giant); \ 32493248Sphk g_add_class(&class); \ 32592108Sphk mtx_lock(&Giant); \ 32692108Sphk } \ 327105061Sphk DECLARE_GEOM_CLASS_INIT(class, name, name##init); 32892108Sphk 32995310Sphk#endif /* _KERNEL */ 33092108Sphk 331105068Sphk/* 332105068Sphk * IOCTLS for talking to the geom.ctl device. 333105068Sphk */ 334105092Sphk 335106518Sphk/* 336106518Sphk * This is the structure used internally in the kernel, it is created and 337106518Sphk * populated by geom_ctl.c. 338106518Sphk */ 339106518Sphkstruct g_configargs { 340105092Sphk /* Valid on call */ 341105092Sphk struct g_class *class; 342105504Sphk struct g_geom *geom; 343105092Sphk struct g_provider *provider; 344105092Sphk u_int flag; 345105092Sphk u_int len; 346105092Sphk void *ptr; 347105092Sphk}; 348105092Sphk 349106518Sphk/* 350106518Sphk * This is the structure used to communicate with userland. 351106518Sphk */ 352105092Sphkstruct geomconfiggeom { 353105092Sphk /* Valid on call */ 354105092Sphk struct geomidorname class; 355105504Sphk struct geomidorname geom; 356105092Sphk struct geomidorname provider; 357105092Sphk u_int flag; 358105092Sphk u_int len; 359105092Sphk void *ptr; 360105092Sphk}; 361106518Sphk 362105092Sphk#define GEOMCONFIGGEOM _IOW('G', 0, struct geomconfiggeom) 363105092Sphk 364106518Sphk#define GCFG_GENERIC0 0x00000000 365106518Sphk /* 366106518Sphk * Generic requests suitable for all classes. 367106518Sphk */ 368106518Sphk#define GCFG_CLASS0 0x10000000 369106518Sphk /* 370106518Sphk * Class specific verbs. Allocations in this part of the numberspace 371106518Sphk * can only be done after review and approval of phk@FreeBSD.org. 372106518Sphk * All allocations in this space will be listed in this file. 373106518Sphk */ 374106518Sphk#define GCFG_PRIVATE0 0x20000000 375106518Sphk /* 376106518Sphk * Lowest allocation for private flag definitions. 377106518Sphk * If you define you own private "verbs", please express them in 378106518Sphk * your code as (GCFG_PRIVATE0 + somenumber), where somenumber is 379106518Sphk * a magic number in the range [0x0 ... 0xfffffff] chosen the way 380106518Sphk * magic numbers are chosen. Such allocation SHALL NOT be listed 381106518Sphk * here but SHOULD be listed in some suitable .h file. 382106518Sphk */ 383106518Sphk#define GCFG_RESERVED0 0x30000000 384106518Sphk#define GCFG_RESERVEDN 0xffffffff 385106518Sphk /* 386106518Sphk * This area is reserved for the future. 387106518Sphk */ 388106518Sphk 389106518Sphk#define GCFG_CREATE (GCFG_GENERIC0 + 0x0) 390106518Sphk /* 391106518Sphk * Request geom construction. 392106518Sphk * ptr/len is class-specific. 393106518Sphk */ 394106518Sphk#define GCFG_DISMANTLE (GCFG_GENERIC0 + 0x1) 395106518Sphk /* 396106518Sphk * Request orderly geom dismantling. 397106518Sphk * ptr/len is class-specific. 398106518Sphk */ 399106518Sphk 400106518Sphk 401106518Sphkstruct gcfg_magicrw { 402106518Sphk off_t offset; 403106518Sphk u_int len; 404106518Sphk}; 405106518Sphk 406106518Sphk#define GCFG_MAGICREAD (GCFG_GENERIC0 + 0x100) 407106518Sphk /* 408106518Sphk * Read of magic spaces. 409106518Sphk * ptr/len is gcfgmagicrw structure followed by bufferspace 410106518Sphk * for data to be read. 411106518Sphk */ 412106518Sphk#define GCFG_MAGICWRITE (GCFG_GENERIC0 + 0x101) 413106518Sphk /* 414106518Sphk * Write of magic spaces. 415106518Sphk * as above, only the other way. 416106518Sphk */ 417106518Sphk 418106518Sphk 419103279Sphk/* geom_enc.c */ 420105163Sphkuint16_t g_dec_be2(const u_char *p); 421105163Sphkuint32_t g_dec_be4(const u_char *p); 422105163Sphkuint16_t g_dec_le2(const u_char *p); 423105163Sphkuint32_t g_dec_le4(const u_char *p); 424105163Sphkuint64_t g_dec_le8(const u_char *p); 425104193Sphkvoid g_enc_le2(u_char *p, uint16_t u); 426103279Sphkvoid g_enc_le4(u_char *p, uint32_t u); 427103279Sphkvoid g_enc_le8(u_char *p, uint64_t u); 428103279Sphk 42995276Sphk#endif /* _GEOM_GEOM_H_ */ 430