sys/geom/virstor/g_virstor_md.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2005 Ivan Voras <ivoras@gmail.com>
   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
  32 #ifndef _G_VIRSTOR_MD_H_
  33 #define _G_VIRSTOR_MD_H_
  34
  35 /*
  36  * Metadata declaration
  37  */
  38
  39 #define G_VIRSTOR_MAGIC         "GEOM::VIRSTOR"
  40 #define G_VIRSTOR_VERSION       1
  41
  42 /* flag: provider is allocated */
  43 #define VIRSTOR_PROVIDER_ALLOCATED      1
  44 /* flag: provider is currently being filled (usually it's the last
  45  * provider with VIRSTOR_PROVIDER_ALLOCATED flag */
  46 #define VIRSTOR_PROVIDER_CURRENT        2
  47
  48 struct g_virstor_metadata {
  49         /* Data global to the virstor device */
  50         char            md_magic[16];           /* Magic value. */
  51         uint32_t        md_version;             /* Version number. */
  52         char            md_name[16];            /* Device name (e.g. "mydata") */
  53         uint32_t        md_id;                  /* Unique ID. */
  54         uint64_t        md_virsize;             /* Virtual device's size */
  55         uint32_t        md_chunk_size;          /* Chunk size in bytes */
  56         uint16_t        md_count;               /* Total number of providers */
  57
  58         /* Data local to this provider */
  59         char            provider[16];           /* Hardcoded provider name */
  60         uint16_t        no;                     /* Provider number/index */
  61         uint64_t        provsize;               /* Provider's size */
  62         uint32_t        chunk_count;            /* Number of chunks in this pr. */
  63         uint32_t        chunk_next;             /* Next chunk to allocate */
  64         uint16_t        chunk_reserved;         /* Count of "reserved" chunks */
  65         uint16_t        flags;                  /* Provider's flags */
  66 };
  67
  68 void virstor_metadata_encode(struct g_virstor_metadata *md, unsigned char *data);
  69 void virstor_metadata_decode(unsigned char *data, struct g_virstor_metadata *md);
  70
  71 #endif  /* !_G_VIRSTOR_H_ */