sys/geom/shsec/g_shsec.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 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
  29 #ifndef _G_SHSEC_H_
  30 #define _G_SHSEC_H_
  31
  32 #include <sys/endian.h>
  33
  34 #define G_SHSEC_CLASS_NAME      "SHSEC"
  35
  36 #define G_SHSEC_MAGIC           "GEOM::SHSEC"
  37 /*
  38  * Version history:
  39  * 0 - Initial version number.
  40  * 1 - Added md_provsize field to metadata.
  41  */
  42 #define G_SHSEC_VERSION 1
  43
  44 #ifdef _KERNEL
  45 #define G_SHSEC_BFLAG_FIRST     0x1
  46
  47 #define G_SHSEC_DEBUG(lvl, ...) \
  48     _GEOM_DEBUG("GEOM_SHSEC", g_shsec_debug, (lvl), NULL, __VA_ARGS__)
  49 #define G_SHSEC_LOGREQ(lvl, bp, ...) \
  50     _GEOM_DEBUG("GEOM_SHSEC", g_shsec_debug, (lvl), (bp), __VA_ARGS__)
  51
  52 struct g_shsec_softc {
  53         u_int            sc_type;       /* provider type */
  54         struct g_geom   *sc_geom;
  55         struct g_provider *sc_provider;
  56         uint32_t         sc_id;         /* device unique ID */
  57         struct g_consumer **sc_disks;
  58         uint16_t         sc_ndisks;
  59 };
  60 #define sc_name sc_geom->name
  61 #endif  /* _KERNEL */
  62
  63 struct g_shsec_metadata {
  64         char            md_magic[16];   /* Magic value. */
  65         uint32_t        md_version;     /* Version number. */
  66         char            md_name[16];    /* Stripe name. */
  67         uint32_t        md_id;          /* Unique ID. */
  68         uint16_t        md_no;          /* Disk number. */
  69         uint16_t        md_all;         /* Number of all disks. */
  70         char            md_provider[16]; /* Hardcoded provider. */
  71         uint64_t        md_provsize;    /* Provider's size. */
  72 };
  73 static __inline void
  74 shsec_metadata_encode(const struct g_shsec_metadata *md, u_char *data)
  75 {
  76
  77         bcopy(md->md_magic, data, sizeof(md->md_magic));
  78         le32enc(data + 16, md->md_version);
  79         bcopy(md->md_name, data + 20, sizeof(md->md_name));
  80         le32enc(data + 36, md->md_id);
  81         le16enc(data + 40, md->md_no);
  82         le16enc(data + 42, md->md_all);
  83         bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
  84         le64enc(data + 60, md->md_provsize);
  85 }
  86 static __inline void
  87 shsec_metadata_decode(const u_char *data, struct g_shsec_metadata *md)
  88 {
  89
  90         bcopy(data, md->md_magic, sizeof(md->md_magic));
  91         md->md_version = le32dec(data + 16);
  92         bcopy(data + 20, md->md_name, sizeof(md->md_name));
  93         md->md_id = le32dec(data + 36);
  94         md->md_no = le16dec(data + 40);
  95         md->md_all = le16dec(data + 42);
  96         bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
  97         md->md_provsize = le64dec(data + 60);
  98 }
  99 #endif  /* _G_SHSEC_H_ */