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/sbuf.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, 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_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *, 79 struct g_consumer *, struct g_provider *); 80 81 /* 82 * The g_class structure describes a transformation class. In other words 83 * all BSD disklabel handlers share one g_class, all MBR handlers share 84 * one common g_class and so on. 85 * Certain operations are instantiated on the class, most notably the 86 * taste and config_geom functions. 87 */ 88 struct g_class { 89 const char *name; 90 g_taste_t *taste; 91 g_config_t *config; 92 g_ctl_req_t *ctlreq; 93 g_init_t *init; 94 g_fini_t *fini; 95 g_ctl_destroy_geom_t *destroy_geom; 96 /* 97 * The remaining elements are private 98 */ 99 LIST_ENTRY(g_class) class; 100 LIST_HEAD(,g_geom) geom; 101 }; 102 103 /* 104 * The g_geom is an instance of a g_class. 105 */ 106 struct g_geom { 107 char *name; 108 struct g_class *class; 109 LIST_ENTRY(g_geom) geom; 110 LIST_HEAD(,g_consumer) consumer; 111 LIST_HEAD(,g_provider) provider; 112 TAILQ_ENTRY(g_geom) geoms; /* XXX: better name */ 113 int rank; 114 g_start_t *start; 115 g_spoiled_t *spoiled; 116 g_dumpconf_t *dumpconf; 117 g_access_t *access; 118 g_orphan_t *orphan; 119 g_ioctl_t *ioctl; 120 void *softc; 121 unsigned flags; 122 #define G_GEOM_WITHER 1 123 }; 124 125 /* 126 * The g_bioq is a queue of struct bio's. 127 * XXX: possibly collection point for statistics. 128 * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head. 129 */ 130 struct g_bioq { 131 TAILQ_HEAD(, bio) bio_queue; 132 struct mtx bio_queue_lock; 133 int bio_queue_length; 134 }; 135 136 /* 137 * A g_consumer is an attachment point for a g_provider. One g_consumer 138 * can only be attached to one g_provider, but multiple g_consumers 139 * can be attached to one g_provider. 140 */ 141 142 struct g_consumer { 143 struct g_geom *geom; 144 LIST_ENTRY(g_consumer) consumer; 145 struct g_provider *provider; 146 LIST_ENTRY(g_consumer) consumers; /* XXX: better name */ 147 int acr, acw, ace; 148 int spoiled; 149 struct devstat *stat; 150 u_int nstart, nend; 151 152 /* Two fields for the implementing class to use */ 153 void *private; 154 u_int index; 155 }; 156 157 /* 158 * A g_provider is a "logical disk". 159 */ 160 struct g_provider { 161 char *name; 162 LIST_ENTRY(g_provider) provider; 163 struct g_geom *geom; 164 LIST_HEAD(,g_consumer) consumers; 165 int acr, acw, ace; 166 int error; 167 TAILQ_ENTRY(g_provider) orphan; 168 off_t mediasize; 169 u_int sectorsize; 170 u_int stripesize; 171 u_int stripeoffset; 172 struct devstat *stat; 173 u_int nstart, nend; 174 u_int flags; 175 #define G_PF_CANDELETE 0x1 176 #define G_PF_WITHER 0x2 177 #define G_PF_ORPHAN 0x4 178 179 /* Two fields for the implementing class to use */ 180 void *private; 181 u_int index; 182 }; 183 184 /* geom_dev.c */ 185 void g_dev_print(void); 186 struct g_provider *g_dev_getprovider(dev_t dev); 187 188 /* geom_dump.c */ 189 void g_trace(int level, const char *, ...); 190 # define G_T_TOPOLOGY 1 191 # define G_T_BIO 2 192 # define G_T_ACCESS 4 193 194 195 /* geom_event.c */ 196 typedef void g_event_t(void *, int flag); 197 #define EV_CANCEL 1 198 int g_post_event(g_event_t *func, void *arg, int flag, ...); 199 int g_waitfor_event(g_event_t *func, void *arg, int flag, ...); 200 void g_cancel_event(void *ref); 201 void g_orphan_provider(struct g_provider *pp, int error); 202 void g_waitidle(void); 203 204 /* geom_subr.c */ 205 int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl); 206 #ifndef BURN_BRIDGES 207 #define g_access_rel(a, b, c, d) g_access(a, b, c, d) 208 #endif 209 int g_attach(struct g_consumer *cp, struct g_provider *pp); 210 void g_destroy_consumer(struct g_consumer *cp); 211 void g_destroy_geom(struct g_geom *pp); 212 void g_destroy_provider(struct g_provider *pp); 213 void g_detach(struct g_consumer *cp); 214 void g_error_provider(struct g_provider *pp, int error); 215 struct g_provider *g_provider_by_name(char const *arg); 216 int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len); 217 #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v)) 218 int g_handleattr(struct bio *bp, const char *attribute, void *val, int len); 219 int g_handleattr_int(struct bio *bp, const char *attribute, int val); 220 int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val); 221 struct g_consumer * g_new_consumer(struct g_geom *gp); 222 struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...); 223 struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...); 224 void g_spoil(struct g_provider *pp, struct g_consumer *cp); 225 int g_std_access(struct g_provider *pp, int dr, int dw, int de); 226 void g_std_done(struct bio *bp); 227 void g_std_spoiled(struct g_consumer *cp); 228 void g_wither_geom(struct g_geom *gp, int error); 229 230 #ifdef DIAGNOSTIC 231 int g_valid_obj(void const *ptr); 232 #define G_VALID_CLASS(foo) \ 233 KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo)) 234 #define G_VALID_GEOM(foo) \ 235 KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo)) 236 #define G_VALID_CONSUMER(foo) \ 237 KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo)) 238 #define G_VALID_PROVIDER(foo) \ 239 KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo)) 240 #else 241 #define G_VALID_CLASS(foo) do { } while (0) 242 #define G_VALID_GEOM(foo) do { } while (0) 243 #define G_VALID_CONSUMER(foo) do { } while (0) 244 #define G_VALID_PROVIDER(foo) do { } while (0) 245 #endif 246 247 int g_modevent(module_t, int, void *); 248 249 /* geom_io.c */ 250 struct bio * g_clone_bio(struct bio *); 251 void g_destroy_bio(struct bio *); 252 void g_io_deliver(struct bio *bp, int error); 253 int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr); 254 void g_io_request(struct bio *bp, struct g_consumer *cp); 255 struct bio *g_new_bio(void); 256 void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error); 257 int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length); 258 void g_print_bio(struct bio *bp); 259 260 /* geom_kern.c / geom_kernsim.c */ 261 262 #ifdef _KERNEL 263 264 struct g_kerneldump { 265 off_t offset; 266 off_t length; 267 }; 268 269 MALLOC_DECLARE(M_GEOM); 270 271 static __inline void * 272 g_malloc(int size, int flags) 273 { 274 void *p; 275 276 p = malloc(size, M_GEOM, flags); 277 return (p); 278 } 279 280 static __inline void 281 g_free(void *ptr) 282 { 283 284 #ifdef DIAGNOSTIC 285 KASSERT(g_valid_obj(ptr) == 0, 286 ("g_free(%p) of live object, type %d", ptr, g_valid_obj(ptr))); 287 #endif 288 free(ptr, M_GEOM); 289 } 290 291 extern struct sx topology_lock; 292 293 #define g_topology_lock() \ 294 do { \ 295 mtx_assert(&Giant, MA_NOTOWNED); \ 296 sx_xlock(&topology_lock); \ 297 } while (0) 298 299 #define g_topology_unlock() \ 300 do { \ 301 sx_xunlock(&topology_lock); \ 302 } while (0) 303 304 #define g_topology_assert() \ 305 do { \ 306 sx_assert(&topology_lock, SX_XLOCKED); \ 307 } while (0) 308 309 #define g_topology_assert_not() \ 310 do { \ 311 sx_assert(&topology_lock, SX_UNLOCKED); \ 312 } while (0) 313 314 #define DECLARE_GEOM_CLASS(class, name) \ 315 static moduledata_t name##_mod = { \ 316 #name, g_modevent, &class \ 317 }; \ 318 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 319 320 #endif /* _KERNEL */ 321 322 /* geom_ctl.c */ 323 void gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len); 324 void *gctl_get_param(struct gctl_req *req, const char *param, int *len); 325 char const *gctl_get_asciiparam(struct gctl_req *req, const char *param); 326 void *gctl_get_paraml(struct gctl_req *req, const char *param, int len); 327 int gctl_error(struct gctl_req *req, const char *fmt, ...); 328 struct g_class *gctl_get_class(struct gctl_req *req, char const *arg); 329 struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mpr, char const *arg); 330 struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg); 331 332 #endif /* _GEOM_GEOM_H_ */ 333