The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/geom/geom.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 07e5ba65faced913065d6a8112da5b17


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.