sys/geom/geom.h

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