lib/libgeom/libgeom.h

   1 /*-
   2  * Copyright (c) 2003 Poul-Henning Kamp
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The names of the authors may not be used to endorse or promote
  14  *    products derived from this software without specific prior written
  15  *    permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31 #ifndef _LIBGEOM_H_
  32 #define _LIBGEOM_H_
  33
  34 #include <sys/cdefs.h>
  35
  36 #include <sys/queue.h>
  37 #include <sys/time.h>
  38
  39 #include <geom/geom_ctl.h>
  40
  41 __BEGIN_DECLS
  42
  43 void geom_stats_close(void);
  44 void geom_stats_resync(void);
  45 int geom_stats_open(void);
  46 void *geom_stats_snapshot_get(void);
  47 void geom_stats_snapshot_free(void *);
  48 void geom_stats_snapshot_timestamp(void *, struct timespec *);
  49 void geom_stats_snapshot_reset(void *);
  50 struct devstat *geom_stats_snapshot_next(void *);
  51
  52 char *geom_getxml(void);
  53
  54 /* geom_xml2tree.c */
  55
  56 /*
  57  * These structs are used to build the tree based on the XML.
  58  * they're named as the kernel variant without the first '_'.
  59  */
  60
  61 struct gclass;
  62 struct ggeom;
  63 struct gconsumer;
  64 struct gprovider;
  65
  66 LIST_HEAD(gconf, gconfig);
  67
  68 struct gident {
  69         void                    *lg_id;
  70         void                    *lg_ptr;
  71         enum {  ISCLASS,
  72                 ISGEOM,
  73                 ISPROVIDER,
  74                 ISCONSUMER }    lg_what;
  75 };
  76
  77 struct gmesh {
  78         LIST_HEAD(, gclass)     lg_class;
  79         struct gident           *lg_ident;
  80 };
  81
  82 struct gconfig {
  83         LIST_ENTRY(gconfig)     lg_config;
  84         char                    *lg_name;
  85         char                    *lg_val;
  86 };
  87
  88 struct gclass {
  89         void                    *lg_id;
  90         char                    *lg_name;
  91         LIST_ENTRY(gclass)      lg_class;
  92         LIST_HEAD(, ggeom)      lg_geom;
  93         struct gconf            lg_config;
  94 };
  95
  96 struct ggeom {
  97         void                    *lg_id;
  98         struct gclass           *lg_class;
  99         char                    *lg_name;
 100         u_int                   lg_rank;
 101         LIST_ENTRY(ggeom)       lg_geom;
 102         LIST_HEAD(, gconsumer)  lg_consumer;
 103         LIST_HEAD(, gprovider)  lg_provider;
 104         struct gconf            lg_config;
 105 };
 106
 107 struct gconsumer {
 108         void                    *lg_id;
 109         struct ggeom            *lg_geom;
 110         LIST_ENTRY(gconsumer)   lg_consumer;
 111         struct gprovider        *lg_provider;
 112         LIST_ENTRY(gconsumer)   lg_consumers;
 113         char                    *lg_mode;
 114         struct gconf            lg_config;
 115 };
 116
 117 struct gprovider {
 118         void                    *lg_id;
 119         char                    *lg_name;
 120         struct ggeom            *lg_geom;
 121         LIST_ENTRY(gprovider)   lg_provider;
 122         LIST_HEAD(, gconsumer)  lg_consumers;
 123         char                    *lg_mode;
 124         off_t                   lg_mediasize;
 125         u_int                   lg_sectorsize;
 126         off_t                   lg_stripeoffset;
 127         off_t                   lg_stripesize;
 128         struct gconf            lg_config;
 129 };
 130
 131 struct gident * geom_lookupid(struct gmesh *, const void *);
 132 int geom_xml2tree(struct gmesh *, char *);
 133 int geom_gettree(struct gmesh *);
 134 void geom_deletetree(struct gmesh *);
 135
 136 /* geom_ctl.c */
 137
 138 struct gctl_req;
 139
 140 #ifdef _STDIO_H_                        /* limit #include pollution */
 141 void gctl_dump(struct gctl_req *, FILE *);
 142 #endif
 143 void gctl_free(struct gctl_req *);
 144 struct gctl_req *gctl_get_handle(void);
 145 const char *gctl_issue(struct gctl_req *);
 146 void gctl_ro_param(struct gctl_req *, const char *, int, const void *);
 147 void gctl_rw_param(struct gctl_req *, const char *, int, void *);
 148
 149 /* geom_util.c */
 150 int g_open(const char *, int);
 151 int g_close(int);
 152 off_t g_mediasize(int);
 153 ssize_t g_sectorsize(int);
 154 off_t g_stripeoffset(int);
 155 off_t g_stripesize(int);
 156 int g_flush(int);
 157 int g_delete(int, off_t, off_t);
 158 int g_get_ident(int, char *, size_t);
 159 int g_get_name(const char *, char *, size_t);
 160 int g_open_by_ident(const char *, int, char *, size_t);
 161 char *g_device_path(const char *);
 162 char *g_providername(int);
 163
 164 __END_DECLS
 165
 166 #endif /* _LIBGEOM_H_ */