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: stable/11/sys/geom/geom.h 347378 2019-05-09 03:51:34Z kevans $ 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> 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; 59300207Skenstruct disk_zone_args; 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 *); 79223089Sgibbstypedef void g_attrchanged_t (struct g_consumer *, const char *attr); 80237518Skentypedef void g_provgone_t (struct g_provider *); 81107953Sphktypedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 8292108Sphk struct g_consumer *, struct g_provider *); 83238213Strasztypedef void g_resize_t(struct g_consumer *cp); 8492108Sphk 8592108Sphk/* 8693248Sphk * The g_class structure describes a transformation class. In other words 8793248Sphk * all BSD disklabel handlers share one g_class, all MBR handlers share 8893248Sphk * one common g_class and so on. 8993248Sphk * Certain operations are instantiated on the class, most notably the 90106518Sphk * taste and config_geom functions. 9192108Sphk */ 9293248Sphkstruct g_class { 93107953Sphk const char *name; 94133312Sphk u_int version; 95224147Spjd u_int spare0; 9692108Sphk g_taste_t *taste; 97106518Sphk g_config_t *config; 98115624Sphk g_ctl_req_t *ctlreq; 99115473Sphk g_init_t *init; 100115473Sphk g_fini_t *fini; 101112709Sphk g_ctl_destroy_geom_t *destroy_geom; 10293776Sphk /* 103149757Sphk * Default values for geom methods 104133312Sphk */ 105133312Sphk g_start_t *start; 106133312Sphk g_spoiled_t *spoiled; 107223089Sgibbs g_attrchanged_t *attrchanged; 108133312Sphk g_dumpconf_t *dumpconf; 109133312Sphk g_access_t *access; 110133312Sphk g_orphan_t *orphan; 111133312Sphk g_ioctl_t *ioctl; 112237545Sken g_provgone_t *providergone; 113238213Strasz g_resize_t *resize; 114238559Sken void *spare1; 115238533Strasz void *spare2; 116133312Sphk /* 117115468Sphk * The remaining elements are private 118115468Sphk */ 11993248Sphk LIST_ENTRY(g_class) class; 12092108Sphk LIST_HEAD(,g_geom) geom; 12192108Sphk}; 12292108Sphk 123133312Sphk#define G_VERSION_00 0x19950323 124138732Sphk#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 125138732Sphk#define G_VERSION G_VERSION_01 126133312Sphk 12792108Sphk/* 12893248Sphk * The g_geom is an instance of a g_class. 12992108Sphk */ 13092108Sphkstruct g_geom { 13192108Sphk char *name; 13293248Sphk struct g_class *class; 13392108Sphk LIST_ENTRY(g_geom) geom; 13492108Sphk LIST_HEAD(,g_consumer) consumer; 13592108Sphk LIST_HEAD(,g_provider) provider; 13692108Sphk TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 13792108Sphk int rank; 13892108Sphk g_start_t *start; 13992108Sphk g_spoiled_t *spoiled; 140223089Sgibbs g_attrchanged_t *attrchanged; 14192108Sphk g_dumpconf_t *dumpconf; 14293776Sphk g_access_t *access; 14393776Sphk g_orphan_t *orphan; 144119660Sphk g_ioctl_t *ioctl; 145237545Sken g_provgone_t *providergone; 146238213Strasz g_resize_t *resize; 147238559Sken void *spare0; 148238533Strasz void *spare1; 14992108Sphk void *softc; 15092108Sphk unsigned flags; 151332095Savg#define G_GEOM_WITHER 0x01 152332095Savg#define G_GEOM_VOLATILE_BIO 0x02 153332095Savg#define G_GEOM_IN_ACCESS 0x04 154332095Savg#define G_GEOM_ACCESS_WAIT 0x08 15592108Sphk}; 15692108Sphk 15792108Sphk/* 15892108Sphk * The g_bioq is a queue of struct bio's. 15992108Sphk * XXX: possibly collection point for statistics. 16092108Sphk * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 16192108Sphk */ 16292108Sphkstruct g_bioq { 16392108Sphk TAILQ_HEAD(, bio) bio_queue; 16492108Sphk struct mtx bio_queue_lock; 16592108Sphk int bio_queue_length; 16692108Sphk}; 16792108Sphk 16892108Sphk/* 16992108Sphk * A g_consumer is an attachment point for a g_provider. One g_consumer 17092108Sphk * can only be attached to one g_provider, but multiple g_consumers 17192108Sphk * can be attached to one g_provider. 17292108Sphk */ 17392108Sphk 17492108Sphkstruct g_consumer { 17592108Sphk struct g_geom *geom; 17692108Sphk LIST_ENTRY(g_consumer) consumer; 17792108Sphk struct g_provider *provider; 17892108Sphk LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 17992108Sphk int acr, acw, ace; 180238886Smav int flags; 181238886Smav#define G_CF_SPOILED 0x1 182238886Smav#define G_CF_ORPHAN 0x4 183256880Smav#define G_CF_DIRECT_SEND 0x10 184256880Smav#define G_CF_DIRECT_RECEIVE 0x20 185112370Sphk struct devstat *stat; 186112026Sphk u_int nstart, nend; 187125743Sphk 188125743Sphk /* Two fields for the implementing class to use */ 189125743Sphk void *private; 190125743Sphk u_int index; 19192108Sphk}; 19292108Sphk 19392108Sphk/* 19492108Sphk * A g_provider is a "logical disk". 19592108Sphk */ 19692108Sphkstruct g_provider { 19792108Sphk char *name; 19892108Sphk LIST_ENTRY(g_provider) provider; 19992108Sphk struct g_geom *geom; 20092108Sphk LIST_HEAD(,g_consumer) consumers; 20192108Sphk int acr, acw, ace; 20292108Sphk int error; 20392108Sphk TAILQ_ENTRY(g_provider) orphan; 20493778Sphk off_t mediasize; 205105542Sphk u_int sectorsize; 206110710Sphk u_int stripesize; 207110710Sphk u_int stripeoffset; 208112370Sphk struct devstat *stat; 209112026Sphk u_int nstart, nend; 210110690Sphk u_int flags; 211120851Sphk#define G_PF_WITHER 0x2 212123233Sphk#define G_PF_ORPHAN 0x4 213248508Skib#define G_PF_ACCEPT_UNMAPPED 0x8 214256880Smav#define G_PF_DIRECT_SEND 0x10 215256880Smav#define G_PF_DIRECT_RECEIVE 0x20 216125743Sphk 217125743Sphk /* Two fields for the implementing class to use */ 218125743Sphk void *private; 219125743Sphk u_int index; 22092108Sphk}; 22192108Sphk 222193981Sluigi/* 223193981Sluigi * Descriptor of a classifier. We can register a function and 224193981Sluigi * an argument, which is called by g_io_request() on bio's 225193981Sluigi * that are not previously classified. 226193981Sluigi */ 227193981Sluigistruct g_classifier_hook { 228193981Sluigi TAILQ_ENTRY(g_classifier_hook) link; 229193981Sluigi int (*func)(void *arg, struct bio *bp); 230193981Sluigi void *arg; 231193981Sluigi}; 232193981Sluigi 233219970Smav/* BIO_GETATTR("GEOM::setstate") argument values. */ 234219970Smav#define G_STATE_FAILED 0 235219970Smav#define G_STATE_REBUILD 1 236219970Smav#define G_STATE_RESYNC 2 237219970Smav#define G_STATE_ACTIVE 3 238219970Smav 239105947Sphk/* geom_dev.c */ 240130585Sphkstruct cdev; 241115960Sphkvoid g_dev_print(void); 242223089Sgibbsvoid g_dev_physpath_changed(void); 243130585Sphkstruct g_provider *g_dev_getprovider(struct cdev *dev); 244105947Sphk 24592108Sphk/* geom_dump.c */ 246107953Sphkvoid g_trace(int level, const char *, ...); 24792108Sphk# define G_T_TOPOLOGY 1 24892108Sphk# define G_T_BIO 2 24992108Sphk# define G_T_ACCESS 4 25092108Sphk 25193090Sphk 25292108Sphk/* geom_event.c */ 253113937Sphktypedef void g_event_t(void *, int flag); 254112989Sphk#define EV_CANCEL 1 255113937Sphkint g_post_event(g_event_t *func, void *arg, int flag, ...); 256113940Sphkint g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 257112989Sphkvoid g_cancel_event(void *ref); 258223089Sgibbsint g_attr_changed(struct g_provider *pp, const char *attr, int flag); 259238886Smavint g_media_changed(struct g_provider *pp, int flag); 260238886Smavint g_media_gone(struct g_provider *pp, int flag); 26192108Sphkvoid g_orphan_provider(struct g_provider *pp, int error); 262137489Spjdvoid g_waitidlelock(void); 26392108Sphk 26492108Sphk/* geom_subr.c */ 265125755Sphkint g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 26692108Sphkint g_attach(struct g_consumer *cp, struct g_provider *pp); 267221101Smavint g_compare_names(const char *namea, const char *nameb); 26892108Sphkvoid g_destroy_consumer(struct g_consumer *cp); 26992108Sphkvoid g_destroy_geom(struct g_geom *pp); 27092108Sphkvoid g_destroy_provider(struct g_provider *pp); 27198066Sphkvoid g_detach(struct g_consumer *cp); 27292108Sphkvoid g_error_provider(struct g_provider *pp, int error); 273115850Sphkstruct g_provider *g_provider_by_name(char const *arg); 27494284Sphkint g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 27594284Sphk#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 276187973Smarcelint g_handleattr(struct bio *bp, const char *attribute, const void *val, 277187973Smarcel int len); 278107953Sphkint g_handleattr_int(struct bio *bp, const char *attribute, int val); 279107953Sphkint g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 280256956Ssmhint g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val); 281187973Smarcelint g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 28292108Sphkstruct g_consumer * g_new_consumer(struct g_geom *gp); 283243333Sjhstruct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...) 284243333Sjh __printflike(2, 3); 285243333Sjhstruct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...) 286243333Sjh __printflike(2, 3); 287238213Straszvoid g_resize_provider(struct g_provider *pp, off_t size); 288177509Smarcelint g_retaste(struct g_class *mp); 28992108Sphkvoid g_spoil(struct g_provider *pp, struct g_consumer *cp); 29092108Sphkint g_std_access(struct g_provider *pp, int dr, int dw, int de); 29192108Sphkvoid g_std_done(struct bio *bp); 29292108Sphkvoid g_std_spoiled(struct g_consumer *cp); 293114495Sphkvoid g_wither_geom(struct g_geom *gp, int error); 294137032Sphkvoid g_wither_geom_close(struct g_geom *gp, int error); 295157619Smarcelvoid g_wither_provider(struct g_provider *pp, int error); 29692108Sphk 297162326Spjd#if defined(DIAGNOSTIC) || defined(DDB) 298162326Spjdint g_valid_obj(void const *ptr); 299162326Spjd#endif 300126798Sphk#ifdef DIAGNOSTIC 301126798Sphk#define G_VALID_CLASS(foo) \ 302126798Sphk KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 303126798Sphk#define G_VALID_GEOM(foo) \ 304126798Sphk KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 305126798Sphk#define G_VALID_CONSUMER(foo) \ 306126798Sphk KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 307126798Sphk#define G_VALID_PROVIDER(foo) \ 308126798Sphk KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 309126798Sphk#else 310126798Sphk#define G_VALID_CLASS(foo) do { } while (0) 311126798Sphk#define G_VALID_GEOM(foo) do { } while (0) 312126798Sphk#define G_VALID_CONSUMER(foo) do { } while (0) 313126798Sphk#define G_VALID_PROVIDER(foo) do { } while (0) 314126798Sphk#endif 315126798Sphk 316115473Sphkint g_modevent(module_t, int, void *); 317115473Sphk 31892108Sphk/* geom_io.c */ 31992108Sphkstruct bio * g_clone_bio(struct bio *); 320159304Spjdstruct bio * g_duplicate_bio(struct bio *); 32192108Sphkvoid g_destroy_bio(struct bio *); 322104195Sphkvoid g_io_deliver(struct bio *bp, int error); 32394283Sphkint g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 324300207Skenint g_io_zonecmd(struct disk_zone_args *zone_args, struct g_consumer *cp); 325163832Spjdint g_io_flush(struct g_consumer *cp); 326193981Sluigiint g_register_classifier(struct g_classifier_hook *hook); 327193981Sluigivoid g_unregister_classifier(struct g_classifier_hook *hook); 32892108Sphkvoid g_io_request(struct bio *bp, struct g_consumer *cp); 32992108Sphkstruct bio *g_new_bio(void); 330134379Sphkstruct bio *g_alloc_bio(void); 331295707Simpvoid g_reset_bio(struct bio *); 33292108Sphkvoid * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 333104194Sphkint g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 334169283Spjdint g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 335125713Spjdvoid g_print_bio(struct bio *bp); 33692108Sphk 33792108Sphk/* geom_kern.c / geom_kernsim.c */ 33892108Sphk 33992108Sphk#ifdef _KERNEL 34092108Sphk 341160301Spjdextern struct sx topology_lock; 342160301Spjd 34395038Sphkstruct g_kerneldump { 34495038Sphk off_t offset; 34595038Sphk off_t length; 346219950Smav struct dumperinfo di; 34795038Sphk}; 34895038Sphk 34992108SphkMALLOC_DECLARE(M_GEOM); 35092108Sphk 35192108Sphkstatic __inline void * 35292108Sphkg_malloc(int size, int flags) 35392108Sphk{ 35492108Sphk void *p; 35592108Sphk 35692108Sphk p = malloc(size, M_GEOM, flags); 35792108Sphk return (p); 35892108Sphk} 35992108Sphk 36092108Sphkstatic __inline void 36192108Sphkg_free(void *ptr) 36292108Sphk{ 363126798Sphk 364126798Sphk#ifdef DIAGNOSTIC 365160301Spjd if (sx_xlocked(&topology_lock)) { 366160301Spjd KASSERT(g_valid_obj(ptr) == 0, 367160301Spjd ("g_free(%p) of live object, type %d", ptr, 368160301Spjd g_valid_obj(ptr))); 369160301Spjd } 370126798Sphk#endif 37192108Sphk free(ptr, M_GEOM); 37292108Sphk} 37392108Sphk 37496987Sphk#define g_topology_lock() \ 37596987Sphk do { \ 37696987Sphk sx_xlock(&topology_lock); \ 37796987Sphk } while (0) 37896987Sphk 379139139Spjd#define g_topology_try_lock() sx_try_xlock(&topology_lock) 380139139Spjd 38196987Sphk#define g_topology_unlock() \ 38296987Sphk do { \ 38396987Sphk sx_xunlock(&topology_lock); \ 38496987Sphk } while (0) 38596987Sphk 38696987Sphk#define g_topology_assert() \ 38796987Sphk do { \ 38896987Sphk sx_assert(&topology_lock, SX_XLOCKED); \ 38996987Sphk } while (0) 39096987Sphk 391125656Spjd#define g_topology_assert_not() \ 392125656Spjd do { \ 393125656Spjd sx_assert(&topology_lock, SX_UNLOCKED); \ 394125656Spjd } while (0) 395125656Spjd 396207671Sjh#define g_topology_sleep(chan, timo) \ 397207671Sjh sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 398207671Sjh 399115473Sphk#define DECLARE_GEOM_CLASS(class, name) \ 400115473Sphk static moduledata_t name##_mod = { \ 401115473Sphk #name, g_modevent, &class \ 402115473Sphk }; \ 403347378Skevans DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND); 404105061Sphk 405256880Smavint g_is_geom_thread(struct thread *td); 406256880Smav 40795310Sphk#endif /* _KERNEL */ 40892108Sphk 409112709Sphk/* geom_ctl.c */ 410157581Smarcelint gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 411157581Smarcelvoid gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 412112709Sphkvoid *gctl_get_param(struct gctl_req *req, const char *param, int *len); 413115624Sphkchar const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 414113892Sphkvoid *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 415162352Spjdint gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 416115624Sphkstruct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 417115624Sphkstruct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 418115624Sphkstruct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 419112709Sphk 42095276Sphk#endif /* _GEOM_GEOM_H_ */ 421