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

Cache object: 008f97a8bd9c53e087e2534c640a60b8


[ 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.