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