sys/geom/stripe/g_stripe.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _G_STRIPE_H_
  32 #define _G_STRIPE_H_
  33
  34 #include <sys/endian.h>
  35
  36 #define G_STRIPE_CLASS_NAME     "STRIPE"
  37
  38 #define G_STRIPE_MAGIC          "GEOM::STRIPE"
  39 /*
  40  * Version history:
  41  * 0 - Initial version number.
  42  * 1 - Added 'stop' command for gstripe(8).
  43  * 2 - Added md_provider field to metadata and '-h' option for gstripe(8).
  44  * 3 - Added md_provsize field to metadata.
  45  */
  46 #define G_STRIPE_VERSION        3
  47
  48 #ifdef _KERNEL
  49 #define G_STRIPE_TYPE_MANUAL    0
  50 #define G_STRIPE_TYPE_AUTOMATIC 1
  51
  52 #define G_STRIPE_DEBUG(lvl, ...)        do {                            \
  53         if (g_stripe_debug >= (lvl)) {                                  \
  54                 printf("GEOM_STRIPE");                                  \
  55                 if (g_stripe_debug > 0)                                 \
  56                         printf("[%u]", lvl);                            \
  57                 printf(": ");                                           \
  58                 printf(__VA_ARGS__);                                    \
  59                 printf("\n");                                           \
  60         }                                                               \
  61 } while (0)
  62 #define G_STRIPE_LOGREQ(bp, ...)        do {                            \
  63         if (g_stripe_debug >= 2) {                                      \
  64                 printf("GEOM_STRIPE[2]: ");                             \
  65                 printf(__VA_ARGS__);                                    \
  66                 printf(" ");                                            \
  67                 g_print_bio(bp);                                        \
  68                 printf("\n");                                           \
  69         }                                                               \
  70 } while (0)
  71
  72 struct g_stripe_softc {
  73         u_int            sc_type;       /* provider type */
  74         struct g_geom   *sc_geom;
  75         struct g_provider *sc_provider;
  76         uint32_t         sc_id;         /* stripe unique ID */
  77         struct g_consumer **sc_disks;
  78         uint16_t         sc_ndisks;
  79         uint32_t         sc_stripesize;
  80         uint32_t         sc_stripebits;
  81         struct mtx       sc_lock;
  82 };
  83 #define sc_name sc_geom->name
  84 #endif  /* _KERNEL */
  85
  86 struct g_stripe_metadata {
  87         char            md_magic[16];   /* Magic value. */
  88         uint32_t        md_version;     /* Version number. */
  89         char            md_name[16];    /* Stripe name. */
  90         uint32_t        md_id;          /* Unique ID. */
  91         uint16_t        md_no;          /* Disk number. */
  92         uint16_t        md_all;         /* Number of all disks. */
  93         uint32_t        md_stripesize;  /* Stripe size. */
  94         char            md_provider[16]; /* Hardcoded provider. */
  95         uint64_t        md_provsize;    /* Provider's size. */
  96 };
  97 static __inline void
  98 stripe_metadata_encode(const struct g_stripe_metadata *md, u_char *data)
  99 {
 100
 101         bcopy(md->md_magic, data, sizeof(md->md_magic));
 102         le32enc(data + 16, md->md_version);
 103         bcopy(md->md_name, data + 20, sizeof(md->md_name));
 104         le32enc(data + 36, md->md_id);
 105         le16enc(data + 40, md->md_no);
 106         le16enc(data + 42, md->md_all);
 107         le32enc(data + 44, md->md_stripesize);
 108         bcopy(md->md_provider, data + 48, sizeof(md->md_provider));
 109         le64enc(data + 64, md->md_provsize);
 110 }
 111 static __inline void
 112 stripe_metadata_decode(const u_char *data, struct g_stripe_metadata *md)
 113 {
 114
 115         bcopy(data, md->md_magic, sizeof(md->md_magic));
 116         md->md_version = le32dec(data + 16);
 117         bcopy(data + 20, md->md_name, sizeof(md->md_name));
 118         md->md_id = le32dec(data + 36);
 119         md->md_no = le16dec(data + 40);
 120         md->md_all = le16dec(data + 42);
 121         md->md_stripesize = le32dec(data + 44);
 122         bcopy(data + 48, md->md_provider, sizeof(md->md_provider));
 123         md->md_provsize = le64dec(data + 64);
 124 }
 125
 126 #endif  /* _G_STRIPE_H_ */