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