1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2002 Poul-Henning Kamp 5 * Copyright (c) 2002 Networks Associates Technology, Inc. 6 * All rights reserved. 7 * 8 * This software was developed for the FreeBSD Project by Poul-Henning Kamp 9 * and NAI Labs, the Security Research Division of Network Associates, Inc. 10 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 11 * DARPA CHATS research program. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. The names of the authors may not be used to endorse or promote 22 * products derived from this software without specific prior written 23 * permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 * 37 * $FreeBSD$ 38 */ 39 40#ifndef _GEOM_GEOM_H_ 41#define _GEOM_GEOM_H_ 42 43#include <sys/lock.h> 44#include <sys/mutex.h> 45#include <sys/sx.h> 46#include <sys/queue.h> 47#include <sys/ioccom.h> 48#include <sys/conf.h> 49#include <sys/module.h> 50 51struct g_class; 52struct g_geom; 53struct g_consumer; 54struct g_provider; 55struct g_stat; 56struct thread; 57struct bio; 58struct sbuf; 59struct gctl_req; 60struct g_configargs; 61struct disk_zone_args; 62 63typedef int g_config_t (struct g_configargs *ca); 64typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 65typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 66typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 67typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 68typedef void g_init_t (struct g_class *mp); 69typedef void g_fini_t (struct g_class *mp); 70typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 71typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td); 72#define G_TF_NORMAL 0 73#define G_TF_INSIST 1 74#define G_TF_TRANSPARENT 2 75typedef int g_access_t (struct g_provider *, int, int, int); 76/* XXX: not sure about the thread arg */ 77typedef void g_orphan_t (struct g_consumer *); 78 79typedef void g_start_t (struct bio *); 80typedef void g_spoiled_t (struct g_consumer *); 81typedef void g_attrchanged_t (struct g_consumer *, const char *attr); 82typedef void g_provgone_t (struct g_provider *); 83typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 84 struct g_consumer *, struct g_provider *); 85typedef void g_resize_t(struct g_consumer *cp); 86 87/* 88 * The g_class structure describes a transformation class. In other words 89 * all BSD disklabel handlers share one g_class, all MBR handlers share 90 * one common g_class and so on. 91 * Certain operations are instantiated on the class, most notably the 92 * taste and config_geom functions. 93 */ 94struct g_class { 95 const char *name; 96 u_int version; 97 u_int spare0; 98 g_taste_t *taste; 99 g_config_t *config; 100 g_ctl_req_t *ctlreq; 101 g_init_t *init; 102 g_fini_t *fini; 103 g_ctl_destroy_geom_t *destroy_geom; 104 /* 105 * Default values for geom methods 106 */ 107 g_start_t *start; 108 g_spoiled_t *spoiled; 109 g_attrchanged_t *attrchanged; 110 g_dumpconf_t *dumpconf; 111 g_access_t *access; 112 g_orphan_t *orphan; 113 g_ioctl_t *ioctl; 114 g_provgone_t *providergone; 115 g_resize_t *resize; 116 void *spare1; 117 void *spare2; 118 /* 119 * The remaining elements are private 120 */ 121 LIST_ENTRY(g_class) class; 122 LIST_HEAD(,g_geom) geom; 123}; 124 125/* 126 * The g_geom_alias is a list node for aliases for the geom name 127 * for device node creation. 128 */ 129struct g_geom_alias { 130 LIST_ENTRY(g_geom_alias) ga_next; 131 const char *ga_alias; 132}; 133 134#define G_VERSION_00 0x19950323 135#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 136#define G_VERSION G_VERSION_01 137 138/* 139 * The g_geom is an instance of a g_class. 140 */ 141struct g_geom { 142 char *name; 143 struct g_class *class; 144 LIST_ENTRY(g_geom) geom; 145 LIST_HEAD(,g_consumer) consumer; 146 LIST_HEAD(,g_provider) provider; 147 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 148 int rank; 149 g_start_t *start; 150 g_spoiled_t *spoiled; 151 g_attrchanged_t *attrchanged; 152 g_dumpconf_t *dumpconf; 153 g_access_t *access; 154 g_orphan_t *orphan; 155 g_ioctl_t *ioctl; 156 g_provgone_t *providergone; 157 g_resize_t *resize; 158 void *spare0; 159 void *spare1; 160 void *softc; 161 unsigned flags; 162#define G_GEOM_WITHER 0x01 163#define G_GEOM_VOLATILE_BIO 0x02 164#define G_GEOM_IN_ACCESS 0x04 165#define G_GEOM_ACCESS_WAIT 0x08 166 LIST_HEAD(,g_geom_alias) aliases; 167}; 168 169/* 170 * The g_bioq is a queue of struct bio's. 171 * XXX: possibly collection point for statistics. 172 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 173 */ 174struct g_bioq { 175 TAILQ_HEAD(, bio) bio_queue; 176 struct mtx bio_queue_lock; 177 int bio_queue_length; 178}; 179 180/* 181 * A g_consumer is an attachment point for a g_provider. One g_consumer 182 * can only be attached to one g_provider, but multiple g_consumers 183 * can be attached to one g_provider. 184 */ 185 186struct g_consumer { 187 struct g_geom *geom; 188 LIST_ENTRY(g_consumer) consumer; 189 struct g_provider *provider; 190 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 191 int acr, acw, ace; 192 int flags; 193#define G_CF_SPOILED 0x1 194#define G_CF_ORPHAN 0x4 195#define G_CF_DIRECT_SEND 0x10 196#define G_CF_DIRECT_RECEIVE 0x20 197 struct devstat *stat; 198 u_int nstart, nend; 199 200 /* Two fields for the implementing class to use */ 201 void *private; 202 u_int index; 203}; 204 205/* 206 * A g_provider is a "logical disk". 207 */ 208struct g_provider { 209 char *name; 210 LIST_ENTRY(g_provider) provider; 211 struct g_geom *geom; 212 LIST_HEAD(,g_consumer) consumers; 213 int acr, acw, ace; 214 int error; 215 TAILQ_ENTRY(g_provider) orphan; 216 off_t mediasize; 217 u_int sectorsize; 218 u_int stripesize; 219 u_int stripeoffset; 220 struct devstat *stat; 221 u_int nstart, nend; 222 u_int flags; 223#define G_PF_WITHER 0x2 224#define G_PF_ORPHAN 0x4 225#define G_PF_ACCEPT_UNMAPPED 0x8 226#define G_PF_DIRECT_SEND 0x10 227#define G_PF_DIRECT_RECEIVE 0x20 228 229 /* Two fields for the implementing class to use */ 230 void *private; 231 u_int index; 232}; 233 234/* 235 * Descriptor of a classifier. We can register a function and 236 * an argument, which is called by g_io_request() on bio's 237 * that are not previously classified. 238 */ 239struct g_classifier_hook { 240 TAILQ_ENTRY(g_classifier_hook) link; 241 int (*func)(void *arg, struct bio *bp); 242 void *arg; 243}; 244 245/* BIO_GETATTR("GEOM::setstate") argument values. */ 246#define G_STATE_FAILED 0 247#define G_STATE_REBUILD 1 248#define G_STATE_RESYNC 2 249#define G_STATE_ACTIVE 3 250 251/* geom_dev.c */ 252struct cdev; 253void g_dev_print(void); 254void g_dev_physpath_changed(void); 255struct g_provider *g_dev_getprovider(struct cdev *dev); 256 257/* geom_dump.c */ 258void (g_trace)(int level, const char *, ...) __printflike(2, 3); 259#define G_T_TOPOLOGY 0x01 260#define G_T_BIO 0x02 261#define G_T_ACCESS 0x04 262extern int g_debugflags; 263#define G_F_FOOTSHOOTING 0x10 264#define G_F_DISKIOCTL 0x40 265#define G_F_CTLDUMP 0x80 266#define g_trace(level, fmt, ...) do { \ 267 if (__predict_false(g_debugflags & (level))) \ 268 (g_trace)(level, fmt, ## __VA_ARGS__); \ 269} while (0) 270 271/* geom_event.c */ 272typedef void g_event_t(void *, int flag); 273#define EV_CANCEL 1 274int g_post_event(g_event_t *func, void *arg, int flag, ...); 275int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 276void g_cancel_event(void *ref); 277int g_attr_changed(struct g_provider *pp, const char *attr, int flag); 278int g_media_changed(struct g_provider *pp, int flag); 279int g_media_gone(struct g_provider *pp, int flag); 280void g_orphan_provider(struct g_provider *pp, int error); 281void g_waitidlelock(void); 282 283/* geom_subr.c */ 284int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 285int g_attach(struct g_consumer *cp, struct g_provider *pp); 286int g_compare_names(const char *namea, const char *nameb); 287void g_destroy_consumer(struct g_consumer *cp); 288void g_destroy_geom(struct g_geom *pp); 289void g_destroy_provider(struct g_provider *pp); 290void g_detach(struct g_consumer *cp); 291void g_error_provider(struct g_provider *pp, int error); 292struct g_provider *g_provider_by_name(char const *arg); 293void g_geom_add_alias(struct g_geom *gp, const char *alias); 294int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 295#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 296int g_handleattr(struct bio *bp, const char *attribute, const void *val, 297 int len); 298int g_handleattr_int(struct bio *bp, const char *attribute, int val); 299int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 300int g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val); 301int g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 302struct g_consumer * g_new_consumer(struct g_geom *gp); 303struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...) 304 __printflike(2, 3); 305struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...) 306 __printflike(2, 3); 307void g_resize_provider(struct g_provider *pp, off_t size); 308int g_retaste(struct g_class *mp); 309void g_spoil(struct g_provider *pp, struct g_consumer *cp); 310int g_std_access(struct g_provider *pp, int dr, int dw, int de); 311void g_std_done(struct bio *bp); 312void g_std_spoiled(struct g_consumer *cp); 313void g_wither_geom(struct g_geom *gp, int error); 314void g_wither_geom_close(struct g_geom *gp, int error); 315void g_wither_provider(struct g_provider *pp, int error); 316 317#if defined(DIAGNOSTIC) || defined(DDB) 318int g_valid_obj(void const *ptr); 319#endif 320#ifdef DIAGNOSTIC 321#define G_VALID_CLASS(foo) \ 322 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 323#define G_VALID_GEOM(foo) \ 324 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 325#define G_VALID_CONSUMER(foo) \ 326 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 327#define G_VALID_PROVIDER(foo) \ 328 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 329#else 330#define G_VALID_CLASS(foo) do { } while (0) 331#define G_VALID_GEOM(foo) do { } while (0) 332#define G_VALID_CONSUMER(foo) do { } while (0) 333#define G_VALID_PROVIDER(foo) do { } while (0) 334#endif 335 336int g_modevent(module_t, int, void *); 337 338/* geom_io.c */ 339struct bio * g_clone_bio(struct bio *); 340struct bio * g_duplicate_bio(struct bio *); 341void g_destroy_bio(struct bio *); 342void g_io_deliver(struct bio *bp, int error); 343int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 344int g_io_zonecmd(struct disk_zone_args *zone_args, struct g_consumer *cp); 345int g_io_flush(struct g_consumer *cp); 346int g_register_classifier(struct g_classifier_hook *hook); 347void g_unregister_classifier(struct g_classifier_hook *hook); 348void g_io_request(struct bio *bp, struct g_consumer *cp); 349struct bio *g_new_bio(void); 350struct bio *g_alloc_bio(void); 351void g_reset_bio(struct bio *); 352void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 353int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 354int g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 355void g_print_bio(struct bio *bp); 356int g_use_g_read_data(void *, off_t, void **, int); 357int g_use_g_write_data(void *, off_t, void *, int); 358 359/* geom_kern.c / geom_kernsim.c */ 360 361#ifdef _KERNEL 362 363extern struct sx topology_lock; 364 365struct g_kerneldump { 366 off_t offset; 367 off_t length; 368 struct dumperinfo di; 369}; 370 371MALLOC_DECLARE(M_GEOM); 372 373static __inline void * 374g_malloc(int size, int flags) 375{ 376 void *p; 377 378 p = malloc(size, M_GEOM, flags); 379 return (p); 380} 381 382static __inline void 383g_free(void *ptr) 384{ 385 386#ifdef DIAGNOSTIC 387 if (sx_xlocked(&topology_lock)) { 388 KASSERT(g_valid_obj(ptr) == 0, 389 ("g_free(%p) of live object, type %d", ptr, 390 g_valid_obj(ptr))); 391 } 392#endif 393 free(ptr, M_GEOM); 394} 395 396#define g_topology_lock() \ 397 do { \ 398 sx_xlock(&topology_lock); \ 399 } while (0) 400 401#define g_topology_try_lock() sx_try_xlock(&topology_lock) 402 403#define g_topology_unlock() \ 404 do { \ 405 sx_xunlock(&topology_lock); \ 406 } while (0) 407 408#define g_topology_assert() \ 409 do { \ 410 sx_assert(&topology_lock, SX_XLOCKED); \ 411 } while (0) 412 413#define g_topology_assert_not() \ 414 do { \ 415 sx_assert(&topology_lock, SX_UNLOCKED); \ 416 } while (0) 417 418#define g_topology_sleep(chan, timo) \ 419 sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 420 421#define DECLARE_GEOM_CLASS(class, name) \ 422 static moduledata_t name##_mod = { \ 423 #name, g_modevent, &class \ 424 }; \ 425 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND); 426 427int g_is_geom_thread(struct thread *td); 428 429#endif /* _KERNEL */ 430 431/* geom_ctl.c */ 432int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 433void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 434void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 435char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 436void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 437int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 438struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 439struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 440struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 441 442#endif /* _GEOM_GEOM_H_ */ 443