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 38#ifndef _GEOM_GEOM_H_ 39#define _GEOM_GEOM_H_ 40 41#include <sys/lock.h> 42#include <sys/mutex.h> 43#include <sys/sx.h> 44#include <sys/queue.h> 45#include <sys/ioccom.h> 46#include <sys/conf.h> 47#include <sys/module.h> 48 49struct g_class; 50struct g_geom; 51struct g_consumer; 52struct g_provider; 53struct g_stat; 54struct thread; 55struct bio; 56struct sbuf; 57struct gctl_req; 58struct g_configargs; 59struct disk_zone_args; 60struct thread; 61 62typedef int g_config_t (struct g_configargs *ca); 63typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 64typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 65typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 66typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 67typedef void g_init_t (struct g_class *mp); 68typedef void g_fini_t (struct g_class *mp); 69typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 70typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td); 71#define G_TF_NORMAL 0 72#define G_TF_INSIST 1 73#define G_TF_TRANSPARENT 2 74typedef int g_access_t (struct g_provider *, int, int, int); 75/* XXX: not sure about the thread arg */ 76typedef void g_orphan_t (struct g_consumer *); 77 78typedef void g_start_t (struct bio *); 79typedef void g_spoiled_t (struct g_consumer *); 80typedef void g_attrchanged_t (struct g_consumer *, const char *attr); 81typedef void g_provgone_t (struct g_provider *); 82typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 83 struct g_consumer *, struct g_provider *); 84typedef void g_resize_t(struct g_consumer *cp); 85 86/* 87 * The g_class structure describes a transformation class. In other words 88 * all BSD disklabel handlers share one g_class, all MBR handlers share 89 * one common g_class and so on. 90 * Certain operations are instantiated on the class, most notably the 91 * taste and config_geom functions. 92 */ 93struct g_class { 94 const char *name; 95 u_int version; 96 u_int spare0; 97 g_taste_t *taste; 98 g_ctl_req_t *ctlreq; 99 g_init_t *init; 100 g_fini_t *fini; 101 g_ctl_destroy_geom_t *destroy_geom; 102 /* 103 * Default values for geom methods 104 */ 105 g_start_t *start; 106 g_spoiled_t *spoiled; 107 g_attrchanged_t *attrchanged; 108 g_dumpconf_t *dumpconf; 109 g_access_t *access; 110 g_orphan_t *orphan; 111 g_ioctl_t *ioctl; 112 g_provgone_t *providergone; 113 g_resize_t *resize; 114 void *spare1; 115 void *spare2; 116 /* 117 * The remaining elements are private 118 */ 119 LIST_ENTRY(g_class) class; 120 LIST_HEAD(,g_geom) geom; 121}; 122 123#define G_VERSION_00 0x19950323 124#define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 125#define G_VERSION G_VERSION_01 126 127/* 128 * The g_geom is an instance of a g_class. 129 */ 130struct g_geom { 131 char *name; 132 struct g_class *class; 133 LIST_ENTRY(g_geom) geom; 134 LIST_HEAD(,g_consumer) consumer; 135 LIST_HEAD(,g_provider) provider; 136 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 137 int rank; 138 g_start_t *start; 139 g_spoiled_t *spoiled; 140 g_attrchanged_t *attrchanged; 141 g_dumpconf_t *dumpconf; 142 g_access_t *access; 143 g_orphan_t *orphan; 144 g_ioctl_t *ioctl; 145 g_provgone_t *providergone; 146 g_resize_t *resize; 147 void *spare0; 148 void *spare1; 149 void *softc; 150 unsigned flags; 151#define G_GEOM_WITHER 0x01 152#define G_GEOM_VOLATILE_BIO 0x02 153#define G_GEOM_IN_ACCESS 0x04 154#define G_GEOM_ACCESS_WAIT 0x08 155}; 156 157/* 158 * The g_bioq is a queue of struct bio's. 159 * XXX: possibly collection point for statistics. 160 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 161 */ 162struct g_bioq { 163 TAILQ_HEAD(, bio) bio_queue; 164 struct mtx bio_queue_lock; 165 int bio_queue_length; 166}; 167 168/* 169 * A g_consumer is an attachment point for a g_provider. One g_consumer 170 * can only be attached to one g_provider, but multiple g_consumers 171 * can be attached to one g_provider. 172 */ 173 174struct g_consumer { 175 struct g_geom *geom; 176 LIST_ENTRY(g_consumer) consumer; 177 struct g_provider *provider; 178 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 179 int acr, acw, ace; 180 int flags; 181#define G_CF_SPOILED 0x1 182#define G_CF_ORPHAN 0x4 183#define G_CF_DIRECT_SEND 0x10 184#define G_CF_DIRECT_RECEIVE 0x20 185 struct devstat *stat; 186 u_int nstart, nend; 187 188 /* Two fields for the implementing class to use */ 189 void *private; 190 u_int index; 191}; 192 193/* 194 * The g_geom_alias is a list node for aliases for the provider name for device 195 * node creation. 196 */ 197struct g_geom_alias { 198 LIST_ENTRY(g_geom_alias) ga_next; 199 const char *ga_alias; 200}; 201 202/* 203 * A g_provider is a "logical disk". 204 */ 205struct g_provider { 206 char *name; 207 LIST_ENTRY(g_provider) provider; 208 struct g_geom *geom; 209 LIST_HEAD(,g_consumer) consumers; 210 int acr, acw, ace; 211 int error; 212 TAILQ_ENTRY(g_provider) orphan; 213 off_t mediasize; 214 u_int sectorsize; 215 off_t stripesize; 216 off_t stripeoffset; 217 struct devstat *stat; 218 u_int spare1; 219 u_int spare2; 220 u_int flags; 221#define G_PF_WITHER 0x2 222#define G_PF_ORPHAN 0x4 223#define G_PF_ACCEPT_UNMAPPED 0x8 224#define G_PF_DIRECT_SEND 0x10 225#define G_PF_DIRECT_RECEIVE 0x20 226 LIST_HEAD(,g_geom_alias) aliases; 227 228 /* Two fields for the implementing class to use */ 229 void *private; 230 u_int index; 231}; 232 233/* BIO_GETATTR("GEOM::setstate") argument values. */ 234#define G_STATE_FAILED 0 235#define G_STATE_REBUILD 1 236#define G_STATE_RESYNC 2 237#define G_STATE_ACTIVE 3 238 239/* geom_dev.c */ 240struct cdev; 241void g_dev_print(void); 242void g_dev_physpath_changed(void); 243struct g_provider *g_dev_getprovider(struct cdev *dev); 244 245/* geom_dump.c */ 246void (g_trace)(int level, const char *, ...) __printflike(2, 3); 247#define G_T_TOPOLOGY 0x01 248#define G_T_BIO 0x02 249#define G_T_ACCESS 0x04 250extern int g_debugflags; 251#define G_F_FOOTSHOOTING 0x10 252#define G_F_DISKIOCTL 0x40 253#define G_F_CTLDUMP 0x80 254#define g_trace(level, fmt, ...) do { \ 255 if (__predict_false(g_debugflags & (level))) \ 256 (g_trace)(level, fmt, ## __VA_ARGS__); \ 257} while (0) 258 259/* geom_event.c */ 260typedef void g_event_t(void *, int flag); 261struct g_event; 262#define EV_CANCEL 1 263int g_post_event(g_event_t *func, void *arg, int flag, ...); 264int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 265void g_cancel_event(void *ref); 266int g_attr_changed(struct g_provider *pp, const char *attr, int flag); 267int g_media_changed(struct g_provider *pp, int flag); 268int g_media_gone(struct g_provider *pp, int flag); 269void g_orphan_provider(struct g_provider *pp, int error); 270struct g_event *g_alloc_event(int flag); 271void g_post_event_ep(g_event_t *func, void *arg, struct g_event *ep, ...); 272void g_waitidle(struct thread *td); 273 274/* geom_subr.c */ 275int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 276int g_attach(struct g_consumer *cp, struct g_provider *pp); 277int g_compare_names(const char *namea, const char *nameb); 278void g_destroy_consumer(struct g_consumer *cp); 279void g_destroy_geom(struct g_geom *pp); 280void g_destroy_provider(struct g_provider *pp); 281void g_detach(struct g_consumer *cp); 282void g_error_provider(struct g_provider *pp, int error); 283struct g_provider *g_provider_by_name(char const *arg); 284int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 285#define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 286int g_handleattr(struct bio *bp, const char *attribute, const void *val, 287 int len); 288int g_handleattr_int(struct bio *bp, const char *attribute, int val); 289int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 290int g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val); 291int g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 292struct g_consumer * g_new_consumer(struct g_geom *gp); 293struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...) 294 __printflike(2, 3); 295struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...) 296 __printflike(2, 3); 297void g_provider_add_alias(struct g_provider *pp, const char *fmt, ...) 298 __printflike(2, 3); 299void g_resize_provider(struct g_provider *pp, off_t size); 300int g_retaste(struct g_class *mp); 301void g_spoil(struct g_provider *pp, struct g_consumer *cp); 302int g_std_access(struct g_provider *pp, int dr, int dw, int de); 303void g_std_done(struct bio *bp); 304void g_std_spoiled(struct g_consumer *cp); 305void g_wither_geom(struct g_geom *gp, int error); 306void g_wither_geom_close(struct g_geom *gp, int error); 307void g_wither_provider(struct g_provider *pp, int error); 308 309#if defined(DIAGNOSTIC) || defined(DDB) 310int g_valid_obj(void const *ptr); 311#endif 312#ifdef DIAGNOSTIC 313#define G_VALID_CLASS(foo) \ 314 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 315#define G_VALID_GEOM(foo) \ 316 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 317#define G_VALID_CONSUMER(foo) \ 318 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 319#define G_VALID_PROVIDER(foo) \ 320 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 321#else 322#define G_VALID_CLASS(foo) do { } while (0) 323#define G_VALID_GEOM(foo) do { } while (0) 324#define G_VALID_CONSUMER(foo) do { } while (0) 325#define G_VALID_PROVIDER(foo) do { } while (0) 326#endif 327 328int g_modevent(module_t, int, void *); 329 330/* geom_io.c */ 331struct bio * g_clone_bio(struct bio *); 332struct bio * g_duplicate_bio(struct bio *); 333void g_destroy_bio(struct bio *); 334void g_io_deliver(struct bio *bp, int error); 335int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 336int g_io_zonecmd(struct disk_zone_args *zone_args, struct g_consumer *cp); 337int g_io_flush(struct g_consumer *cp); 338int g_io_speedup(off_t shortage, u_int flags, size_t *resid, 339 struct g_consumer *cp); 340void g_io_request(struct bio *bp, struct g_consumer *cp); 341struct bio *g_new_bio(void); 342struct bio *g_alloc_bio(void); 343void g_reset_bio(struct bio *); 344void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 345int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 346int g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 347void g_format_bio(struct sbuf *, const struct bio *bp); 348void g_print_bio(const char *prefix, const struct bio *bp, const char *fmtsuffix, ...) __printflike(3, 4); 349int g_use_g_read_data(void *, off_t, void **, int); 350int g_use_g_write_data(void *, off_t, void *, int); 351 352/* geom_kern.c / geom_kernsim.c */ 353 354#ifdef _KERNEL 355 356extern struct sx topology_lock; 357 358struct g_kerneldump { 359 off_t offset; 360 off_t length; 361 struct dumperinfo di; 362}; 363 364MALLOC_DECLARE(M_GEOM); 365 366static __inline void * 367g_malloc(int size, int flags) 368{ 369 void *p; 370 371 p = malloc(size, M_GEOM, flags); 372 return (p); 373} 374 375static __inline void 376g_free(void *ptr) 377{ 378 379#ifdef DIAGNOSTIC 380 if (sx_xlocked(&topology_lock)) { 381 KASSERT(g_valid_obj(ptr) == 0, 382 ("g_free(%p) of live object, type %d", ptr, 383 g_valid_obj(ptr))); 384 } 385#endif 386 free(ptr, M_GEOM); 387} 388 389#define g_topology_lock() \ 390 do { \ 391 sx_xlock(&topology_lock); \ 392 } while (0) 393 394#define g_topology_try_lock() sx_try_xlock(&topology_lock) 395 396#define g_topology_unlock() \ 397 do { \ 398 sx_xunlock(&topology_lock); \ 399 } while (0) 400 401#define g_topology_locked() sx_xlocked(&topology_lock) 402 403#define g_topology_assert() \ 404 do { \ 405 sx_assert(&topology_lock, SX_XLOCKED); \ 406 } while (0) 407 408#define g_topology_assert_not() \ 409 do { \ 410 sx_assert(&topology_lock, SX_UNLOCKED); \ 411 } while (0) 412 413#define g_topology_sleep(chan, timo) \ 414 sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 415 416#define DECLARE_GEOM_CLASS(class, name) \ 417 static moduledata_t name##_mod = { \ 418 #name, g_modevent, &class \ 419 }; \ 420 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND); 421 422int g_is_geom_thread(struct thread *td); 423 424#ifndef _PATH_DEV 425#define _PATH_DEV "/dev/" 426#endif 427 428#endif /* _KERNEL */ 429 430/* geom_ctl.c */ 431int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 432void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 433void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 434void *gctl_get_param_flags(struct gctl_req *req, const char *param, int flags, 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); 437void *gctl_get_paraml_opt(struct gctl_req *req, const char *param, int len); 438int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 439void gctl_msg(struct gctl_req *req, int, const char *fmt, ...) __printflike(3, 4); 440void gctl_post_messages(struct gctl_req *req); 441struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 442struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mp, char const *arg); 443struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 444 445#endif /* _GEOM_GEOM_H_ */ 446