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 #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 */ 130 struct 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 1 152 #define G_GEOM_VOLATILE_BIO 2 153 }; 154 155 /* 156 * The g_bioq is a queue of struct bio's. 157 * XXX: possibly collection point for statistics. 158 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 159 */ 160 struct g_bioq { 161 TAILQ_HEAD(, bio) bio_queue; 162 struct mtx bio_queue_lock; 163 int bio_queue_length; 164 }; 165 166 /* 167 * A g_consumer is an attachment point for a g_provider. One g_consumer 168 * can only be attached to one g_provider, but multiple g_consumers 169 * can be attached to one g_provider. 170 */ 171 172 struct g_consumer { 173 struct g_geom *geom; 174 LIST_ENTRY(g_consumer) consumer; 175 struct g_provider *provider; 176 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 177 int acr, acw, ace; 178 int flags; 179 #define G_CF_SPOILED 0x1 180 #define G_CF_ORPHAN 0x4 181 #define G_CF_DIRECT_SEND 0x10 182 #define G_CF_DIRECT_RECEIVE 0x20 183 struct devstat *stat; 184 u_int nstart, nend; 185 186 /* Two fields for the implementing class to use */ 187 void *private; 188 u_int index; 189 }; 190 191 /* 192 * A g_provider is a "logical disk". 193 */ 194 struct g_provider { 195 char *name; 196 LIST_ENTRY(g_provider) provider; 197 struct g_geom *geom; 198 LIST_HEAD(,g_consumer) consumers; 199 int acr, acw, ace; 200 int error; 201 TAILQ_ENTRY(g_provider) orphan; 202 off_t mediasize; 203 u_int sectorsize; 204 u_int stripesize; 205 u_int stripeoffset; 206 struct devstat *stat; 207 u_int nstart, nend; 208 u_int flags; 209 #define G_PF_WITHER 0x2 210 #define G_PF_ORPHAN 0x4 211 #define G_PF_ACCEPT_UNMAPPED 0x8 212 #define G_PF_DIRECT_SEND 0x10 213 #define G_PF_DIRECT_RECEIVE 0x20 214 215 /* Two fields for the implementing class to use */ 216 void *private; 217 u_int index; 218 }; 219 220 /* 221 * Descriptor of a classifier. We can register a function and 222 * an argument, which is called by g_io_request() on bio's 223 * that are not previously classified. 224 */ 225 struct g_classifier_hook { 226 TAILQ_ENTRY(g_classifier_hook) link; 227 int (*func)(void *arg, struct bio *bp); 228 void *arg; 229 }; 230 231 /* BIO_GETATTR("GEOM::setstate") argument values. */ 232 #define G_STATE_FAILED 0 233 #define G_STATE_REBUILD 1 234 #define G_STATE_RESYNC 2 235 #define G_STATE_ACTIVE 3 236 237 /* geom_dev.c */ 238 struct cdev; 239 void g_dev_print(void); 240 void g_dev_physpath_changed(void); 241 struct g_provider *g_dev_getprovider(struct cdev *dev); 242 243 /* geom_dump.c */ 244 void g_trace(int level, const char *, ...); 245 # define G_T_TOPOLOGY 1 246 # define G_T_BIO 2 247 # define G_T_ACCESS 4 248 249 250 /* geom_event.c */ 251 typedef void g_event_t(void *, int flag); 252 #define EV_CANCEL 1 253 int g_post_event(g_event_t *func, void *arg, int flag, ...); 254 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 255 void g_cancel_event(void *ref); 256 int g_attr_changed(struct g_provider *pp, const char *attr, int flag); 257 int g_media_changed(struct g_provider *pp, int flag); 258 int g_media_gone(struct g_provider *pp, int flag); 259 void g_orphan_provider(struct g_provider *pp, int error); 260 void g_waitidlelock(void); 261 262 /* geom_subr.c */ 263 int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 264 int g_attach(struct g_consumer *cp, struct g_provider *pp); 265 int g_compare_names(const char *namea, const char *nameb); 266 void g_destroy_consumer(struct g_consumer *cp); 267 void g_destroy_geom(struct g_geom *pp); 268 void g_destroy_provider(struct g_provider *pp); 269 void g_detach(struct g_consumer *cp); 270 void g_error_provider(struct g_provider *pp, int error); 271 struct g_provider *g_provider_by_name(char const *arg); 272 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 273 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 274 int g_handleattr(struct bio *bp, const char *attribute, const void *val, 275 int len); 276 int g_handleattr_int(struct bio *bp, const char *attribute, int val); 277 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 278 int g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val); 279 int g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 280 struct g_consumer * g_new_consumer(struct g_geom *gp); 281 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...) 282 __printflike(2, 3); 283 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...) 284 __printflike(2, 3); 285 void g_resize_provider(struct g_provider *pp, off_t size); 286 int g_retaste(struct g_class *mp); 287 void g_spoil(struct g_provider *pp, struct g_consumer *cp); 288 int g_std_access(struct g_provider *pp, int dr, int dw, int de); 289 void g_std_done(struct bio *bp); 290 void g_std_spoiled(struct g_consumer *cp); 291 void g_wither_geom(struct g_geom *gp, int error); 292 void g_wither_geom_close(struct g_geom *gp, int error); 293 void g_wither_provider(struct g_provider *pp, int error); 294 295 #if defined(DIAGNOSTIC) || defined(DDB) 296 int g_valid_obj(void const *ptr); 297 #endif 298 #ifdef DIAGNOSTIC 299 #define G_VALID_CLASS(foo) \ 300 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 301 #define G_VALID_GEOM(foo) \ 302 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 303 #define G_VALID_CONSUMER(foo) \ 304 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 305 #define G_VALID_PROVIDER(foo) \ 306 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 307 #else 308 #define G_VALID_CLASS(foo) do { } while (0) 309 #define G_VALID_GEOM(foo) do { } while (0) 310 #define G_VALID_CONSUMER(foo) do { } while (0) 311 #define G_VALID_PROVIDER(foo) do { } while (0) 312 #endif 313 314 int g_modevent(module_t, int, void *); 315 316 /* geom_io.c */ 317 struct bio * g_clone_bio(struct bio *); 318 struct bio * g_duplicate_bio(struct bio *); 319 void g_destroy_bio(struct bio *); 320 void g_io_deliver(struct bio *bp, int error); 321 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 322 int g_io_zonecmd(struct disk_zone_args *zone_args, struct g_consumer *cp); 323 int g_io_flush(struct g_consumer *cp); 324 int g_register_classifier(struct g_classifier_hook *hook); 325 void g_unregister_classifier(struct g_classifier_hook *hook); 326 void g_io_request(struct bio *bp, struct g_consumer *cp); 327 struct bio *g_new_bio(void); 328 struct bio *g_alloc_bio(void); 329 void g_reset_bio(struct bio *); 330 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 331 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 332 int g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 333 void g_print_bio(struct bio *bp); 334 335 /* geom_kern.c / geom_kernsim.c */ 336 337 #ifdef _KERNEL 338 339 extern struct sx topology_lock; 340 341 struct g_kerneldump { 342 off_t offset; 343 off_t length; 344 struct dumperinfo di; 345 }; 346 347 MALLOC_DECLARE(M_GEOM); 348 349 static __inline void * 350 g_malloc(int size, int flags) 351 { 352 void *p; 353 354 p = malloc(size, M_GEOM, flags); 355 return (p); 356 } 357 358 static __inline void 359 g_free(void *ptr) 360 { 361 362 #ifdef DIAGNOSTIC 363 if (sx_xlocked(&topology_lock)) { 364 KASSERT(g_valid_obj(ptr) == 0, 365 ("g_free(%p) of live object, type %d", ptr, 366 g_valid_obj(ptr))); 367 } 368 #endif 369 free(ptr, M_GEOM); 370 } 371 372 #define g_topology_lock() \ 373 do { \ 374 sx_xlock(&topology_lock); \ 375 } while (0) 376 377 #define g_topology_try_lock() sx_try_xlock(&topology_lock) 378 379 #define g_topology_unlock() \ 380 do { \ 381 sx_xunlock(&topology_lock); \ 382 } while (0) 383 384 #define g_topology_assert() \ 385 do { \ 386 sx_assert(&topology_lock, SX_XLOCKED); \ 387 } while (0) 388 389 #define g_topology_assert_not() \ 390 do { \ 391 sx_assert(&topology_lock, SX_UNLOCKED); \ 392 } while (0) 393 394 #define g_topology_sleep(chan, timo) \ 395 sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 396 397 #define DECLARE_GEOM_CLASS(class, name) \ 398 static moduledata_t name##_mod = { \ 399 #name, g_modevent, &class \ 400 }; \ 401 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 402 403 int g_is_geom_thread(struct thread *td); 404 405 #endif /* _KERNEL */ 406 407 /* geom_ctl.c */ 408 int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 409 void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 410 void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 411 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 412 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 413 int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 414 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 415 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 416 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 417 418 #endif /* _GEOM_GEOM_H_ */ 419