sys/geom/geom.h

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