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 60 typedef int g_config_t (struct g_configargs *ca); 61 typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb); 62 typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp); 63 typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp); 64 typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb); 65 typedef void g_init_t (struct g_class *mp); 66 typedef void g_fini_t (struct g_class *mp); 67 typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags); 68 typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td); 69 #define G_TF_NORMAL 0 70 #define G_TF_INSIST 1 71 #define G_TF_TRANSPARENT 2 72 typedef int g_access_t (struct g_provider *, int, int, int); 73 /* XXX: not sure about the thread arg */ 74 typedef void g_orphan_t (struct g_consumer *); 75 76 typedef void g_start_t (struct bio *); 77 typedef void g_spoiled_t (struct g_consumer *); 78 typedef void g_attrchanged_t (struct g_consumer *, const char *attr); 79 typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 80 struct g_consumer *, struct g_provider *); 81 82 /* 83 * The g_class structure describes a transformation class. In other words 84 * all BSD disklabel handlers share one g_class, all MBR handlers share 85 * one common g_class and so on. 86 * Certain operations are instantiated on the class, most notably the 87 * taste and config_geom functions. 88 */ 89 struct g_class { 90 const char *name; 91 u_int version; 92 g_taste_t *taste; 93 g_config_t *config; 94 g_ctl_req_t *ctlreq; 95 g_init_t *init; 96 g_fini_t *fini; 97 g_ctl_destroy_geom_t *destroy_geom; 98 /* 99 * Default values for geom methods 100 */ 101 g_start_t *start; 102 g_spoiled_t *spoiled; 103 g_attrchanged_t *attrchanged; 104 g_dumpconf_t *dumpconf; 105 g_access_t *access; 106 g_orphan_t *orphan; 107 g_ioctl_t *ioctl; 108 /* 109 * The remaining elements are private 110 */ 111 LIST_ENTRY(g_class) class; 112 LIST_HEAD(,g_geom) geom; 113 }; 114 115 #define G_VERSION_00 0x19950323 116 #define G_VERSION_01 0x20041207 /* add fflag to g_ioctl_t */ 117 #define G_VERSION G_VERSION_01 118 119 /* 120 * The g_geom is an instance of a g_class. 121 */ 122 struct g_geom { 123 char *name; 124 struct g_class *class; 125 LIST_ENTRY(g_geom) geom; 126 LIST_HEAD(,g_consumer) consumer; 127 LIST_HEAD(,g_provider) provider; 128 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 129 int rank; 130 g_start_t *start; 131 g_spoiled_t *spoiled; 132 g_attrchanged_t *attrchanged; 133 g_dumpconf_t *dumpconf; 134 g_access_t *access; 135 g_orphan_t *orphan; 136 g_ioctl_t *ioctl; 137 void *softc; 138 unsigned flags; 139 #define G_GEOM_WITHER 1 140 #define G_GEOM_VOLATILE_BIO 2 141 }; 142 143 /* 144 * The g_bioq is a queue of struct bio's. 145 * XXX: possibly collection point for statistics. 146 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 147 */ 148 struct g_bioq { 149 TAILQ_HEAD(, bio) bio_queue; 150 struct mtx bio_queue_lock; 151 int bio_queue_length; 152 }; 153 154 /* 155 * A g_consumer is an attachment point for a g_provider. One g_consumer 156 * can only be attached to one g_provider, but multiple g_consumers 157 * can be attached to one g_provider. 158 */ 159 160 struct g_consumer { 161 struct g_geom *geom; 162 LIST_ENTRY(g_consumer) consumer; 163 struct g_provider *provider; 164 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 165 int acr, acw, ace; 166 int spoiled; 167 struct devstat *stat; 168 u_int nstart, nend; 169 170 /* Two fields for the implementing class to use */ 171 void *private; 172 u_int index; 173 }; 174 175 /* 176 * A g_provider is a "logical disk". 177 */ 178 struct g_provider { 179 char *name; 180 LIST_ENTRY(g_provider) provider; 181 struct g_geom *geom; 182 LIST_HEAD(,g_consumer) consumers; 183 int acr, acw, ace; 184 int error; 185 TAILQ_ENTRY(g_provider) orphan; 186 off_t mediasize; 187 u_int sectorsize; 188 u_int stripesize; 189 u_int stripeoffset; 190 struct devstat *stat; 191 u_int nstart, nend; 192 u_int flags; 193 #define G_PF_CANDELETE 0x1 194 #define G_PF_WITHER 0x2 195 #define G_PF_ORPHAN 0x4 196 197 /* Two fields for the implementing class to use */ 198 void *private; 199 u_int index; 200 }; 201 202 /* 203 * Descriptor of a classifier. We can register a function and 204 * an argument, which is called by g_io_request() on bio's 205 * that are not previously classified. 206 */ 207 struct g_classifier_hook { 208 TAILQ_ENTRY(g_classifier_hook) link; 209 int (*func)(void *arg, struct bio *bp); 210 void *arg; 211 }; 212 213 /* BIO_GETATTR("GEOM::setstate") argument values. */ 214 #define G_STATE_FAILED 0 215 #define G_STATE_REBUILD 1 216 #define G_STATE_RESYNC 2 217 #define G_STATE_ACTIVE 3 218 219 /* geom_dev.c */ 220 struct cdev; 221 void g_dev_print(void); 222 void g_dev_physpath_changed(void); 223 struct g_provider *g_dev_getprovider(struct cdev *dev); 224 225 /* geom_dump.c */ 226 void g_trace(int level, const char *, ...); 227 # define G_T_TOPOLOGY 1 228 # define G_T_BIO 2 229 # define G_T_ACCESS 4 230 231 232 /* geom_event.c */ 233 typedef void g_event_t(void *, int flag); 234 #define EV_CANCEL 1 235 int g_post_event(g_event_t *func, void *arg, int flag, ...); 236 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 237 void g_cancel_event(void *ref); 238 int g_attr_changed(struct g_provider *pp, const char *attr, int flag); 239 void g_orphan_provider(struct g_provider *pp, int error); 240 void g_waitidlelock(void); 241 242 /* geom_subr.c */ 243 int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 244 int g_attach(struct g_consumer *cp, struct g_provider *pp); 245 int g_compare_names(const char *namea, const char *nameb); 246 void g_destroy_consumer(struct g_consumer *cp); 247 void g_destroy_geom(struct g_geom *pp); 248 void g_destroy_provider(struct g_provider *pp); 249 void g_detach(struct g_consumer *cp); 250 void g_error_provider(struct g_provider *pp, int error); 251 struct g_provider *g_provider_by_name(char const *arg); 252 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 253 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 254 int g_handleattr(struct bio *bp, const char *attribute, const void *val, 255 int len); 256 int g_handleattr_int(struct bio *bp, const char *attribute, int val); 257 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 258 int g_handleattr_str(struct bio *bp, const char *attribute, const char *str); 259 struct g_consumer * g_new_consumer(struct g_geom *gp); 260 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 261 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 262 int g_retaste(struct g_class *mp); 263 void g_spoil(struct g_provider *pp, struct g_consumer *cp); 264 int g_std_access(struct g_provider *pp, int dr, int dw, int de); 265 void g_std_done(struct bio *bp); 266 void g_std_spoiled(struct g_consumer *cp); 267 void g_wither_geom(struct g_geom *gp, int error); 268 void g_wither_geom_close(struct g_geom *gp, int error); 269 void g_wither_provider(struct g_provider *pp, int error); 270 271 #if defined(DIAGNOSTIC) || defined(DDB) 272 int g_valid_obj(void const *ptr); 273 #endif 274 #ifdef DIAGNOSTIC 275 #define G_VALID_CLASS(foo) \ 276 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 277 #define G_VALID_GEOM(foo) \ 278 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 279 #define G_VALID_CONSUMER(foo) \ 280 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 281 #define G_VALID_PROVIDER(foo) \ 282 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 283 #else 284 #define G_VALID_CLASS(foo) do { } while (0) 285 #define G_VALID_GEOM(foo) do { } while (0) 286 #define G_VALID_CONSUMER(foo) do { } while (0) 287 #define G_VALID_PROVIDER(foo) do { } while (0) 288 #endif 289 290 int g_modevent(module_t, int, void *); 291 292 /* geom_io.c */ 293 struct bio * g_clone_bio(struct bio *); 294 struct bio * g_duplicate_bio(struct bio *); 295 void g_destroy_bio(struct bio *); 296 void g_io_deliver(struct bio *bp, int error); 297 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 298 int g_io_flush(struct g_consumer *cp); 299 int g_register_classifier(struct g_classifier_hook *hook); 300 void g_unregister_classifier(struct g_classifier_hook *hook); 301 void g_io_request(struct bio *bp, struct g_consumer *cp); 302 struct bio *g_new_bio(void); 303 struct bio *g_alloc_bio(void); 304 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 305 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 306 int g_delete_data(struct g_consumer *cp, off_t offset, off_t length); 307 void g_print_bio(struct bio *bp); 308 309 /* geom_kern.c / geom_kernsim.c */ 310 311 #ifdef _KERNEL 312 313 extern struct sx topology_lock; 314 315 struct g_kerneldump { 316 off_t offset; 317 off_t length; 318 struct dumperinfo di; 319 }; 320 321 MALLOC_DECLARE(M_GEOM); 322 323 static __inline void * 324 g_malloc(int size, int flags) 325 { 326 void *p; 327 328 p = malloc(size, M_GEOM, flags); 329 return (p); 330 } 331 332 static __inline void 333 g_free(void *ptr) 334 { 335 336 #ifdef DIAGNOSTIC 337 if (sx_xlocked(&topology_lock)) { 338 KASSERT(g_valid_obj(ptr) == 0, 339 ("g_free(%p) of live object, type %d", ptr, 340 g_valid_obj(ptr))); 341 } 342 #endif 343 free(ptr, M_GEOM); 344 } 345 346 #define g_topology_lock() \ 347 do { \ 348 mtx_assert(&Giant, MA_NOTOWNED); \ 349 sx_xlock(&topology_lock); \ 350 } while (0) 351 352 #define g_topology_try_lock() sx_try_xlock(&topology_lock) 353 354 #define g_topology_unlock() \ 355 do { \ 356 sx_xunlock(&topology_lock); \ 357 } while (0) 358 359 #define g_topology_assert() \ 360 do { \ 361 sx_assert(&topology_lock, SX_XLOCKED); \ 362 } while (0) 363 364 #define g_topology_assert_not() \ 365 do { \ 366 sx_assert(&topology_lock, SX_UNLOCKED); \ 367 } while (0) 368 369 #define g_topology_sleep(chan, timo) \ 370 sx_sleep(chan, &topology_lock, 0, "gtopol", timo) 371 372 #define DECLARE_GEOM_CLASS(class, name) \ 373 static moduledata_t name##_mod = { \ 374 #name, g_modevent, &class \ 375 }; \ 376 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 377 378 #endif /* _KERNEL */ 379 380 /* geom_ctl.c */ 381 int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 382 void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len); 383 void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 384 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 385 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 386 int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3); 387 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 388 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 389 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 390 391 #endif /* _GEOM_GEOM_H_ */ 392