sys/geom/concat/g_concat.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_CONCAT_H_
  32 #define _G_CONCAT_H_
  33
  34 #include <sys/endian.h>
  35
  36 #define G_CONCAT_CLASS_NAME     "CONCAT"
  37
  38 #define G_CONCAT_MAGIC          "GEOM::CONCAT"
  39 /*
  40  * Version history:
  41  * 1 - Initial version number.
  42  * 2 - Added 'stop' command to gconcat(8).
  43  * 3 - Added md_provider field to metadata and '-h' option to gconcat(8).
  44  * 4 - Added md_provsize field to metadata.
  45  */
  46 #define G_CONCAT_VERSION        4
  47
  48 #ifdef _KERNEL
  49 #define G_CONCAT_TYPE_MANUAL    0
  50 #define G_CONCAT_TYPE_AUTOMATIC 1
  51
  52 #define G_CONCAT_DEBUG(lvl, ...) \
  53     _GEOM_DEBUG("GEOM_CONCAT", g_concat_debug, (lvl), NULL, __VA_ARGS__)
  54 #define G_CONCAT_LOGREQ(bp, ...) \
  55     _GEOM_DEBUG("GEOM_CONCAT", g_concat_debug, 2, (bp), __VA_ARGS__)
  56
  57 struct g_concat_disk {
  58         TAILQ_ENTRY(g_concat_disk) d_next;
  59         struct g_consumer       *d_consumer;
  60         struct g_concat_softc   *d_softc;
  61         off_t                    d_start;
  62         off_t                    d_end;
  63         int                      d_candelete;
  64         int                      d_removed;
  65         bool                     d_hardcoded;
  66 };
  67
  68 struct g_concat_softc {
  69         u_int            sc_type;       /* provider type */
  70         struct g_geom   *sc_geom;
  71         struct g_provider *sc_provider;
  72         uint32_t         sc_id;         /* concat unique ID */
  73
  74         uint16_t         sc_ndisks;
  75         TAILQ_HEAD(g_concat_disks, g_concat_disk) sc_disks;
  76
  77         struct mtx       sc_completion_lock; /* synchronizes cross-boundary IOs */
  78         struct sx        sc_disks_lock; /* synchronizes modification of sc_disks */
  79 };
  80 #define sc_name sc_geom->name
  81 #endif  /* _KERNEL */
  82
  83 struct g_concat_metadata {
  84         char            md_magic[16];   /* Magic value. */
  85         uint32_t        md_version;     /* Version number. */
  86         char            md_name[16];    /* Concat name. */
  87         uint32_t        md_id;          /* Unique ID. */
  88         uint16_t        md_no;          /* Disk number. */
  89         uint16_t        md_all;         /* Number of all disks. */
  90         char            md_provider[16]; /* Hardcoded provider. */
  91         uint64_t        md_provsize;    /* Provider's size. */
  92 };
  93 static __inline void
  94 concat_metadata_encode(const struct g_concat_metadata *md, u_char *data)
  95 {
  96
  97         bcopy(md->md_magic, data, sizeof(md->md_magic));
  98         le32enc(data + 16, md->md_version);
  99         bcopy(md->md_name, data + 20, sizeof(md->md_name));
 100         le32enc(data + 36, md->md_id);
 101         le16enc(data + 40, md->md_no);
 102         le16enc(data + 42, md->md_all);
 103         bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
 104         le64enc(data + 60, md->md_provsize);
 105 }
 106 static __inline void
 107 concat_metadata_decode(const u_char *data, struct g_concat_metadata *md)
 108 {
 109
 110         bcopy(data, md->md_magic, sizeof(md->md_magic));
 111         md->md_version = le32dec(data + 16);
 112         bcopy(data + 20, md->md_name, sizeof(md->md_name));
 113         md->md_id = le32dec(data + 36);
 114         md->md_no = le16dec(data + 40);
 115         md->md_all = le16dec(data + 42);
 116         bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
 117         md->md_provsize = le64dec(data + 60);
 118 }
 119 #endif  /* _G_CONCAT_H_ */