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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: c754b031ff6f1e88a0193ed73261d061


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