xref: /freebsd/sys/geom/virstor/g_virstor_md.h (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1 /*-
2  * Copyright (c) 2005 Ivan Voras <ivoras@gmail.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 
30 #ifndef _G_VIRSTOR_MD_H_
31 #define _G_VIRSTOR_MD_H_
32 
33 /*
34  * Metadata declaration
35  */
36 
37 #define	G_VIRSTOR_MAGIC		"GEOM::VIRSTOR"
38 #define	G_VIRSTOR_VERSION	1
39 
40 /* flag: provider is allocated */
41 #define	VIRSTOR_PROVIDER_ALLOCATED	1
42 /* flag: provider is currently being filled (usually it's the last
43  * provider with VIRSTOR_PROVIDER_ALLOCATED flag */
44 #define VIRSTOR_PROVIDER_CURRENT	2
45 
46 struct g_virstor_metadata {
47 	/* Data global to the virstor device */
48 	char		md_magic[16];		/* Magic value. */
49 	uint32_t	md_version;		/* Version number. */
50 	char		md_name[16];		/* Device name (e.g. "mydata") */
51 	uint32_t	md_id;			/* Unique ID. */
52 	uint64_t	md_virsize;		/* Virtual device's size */
53 	uint32_t	md_chunk_size;		/* Chunk size in bytes */
54 	uint16_t	md_count;		/* Total number of providers */
55 
56 	/* Data local to this provider */
57 	char		provider[16];		/* Hardcoded provider name */
58 	uint16_t	no;			/* Provider number/index */
59 	uint64_t	provsize;		/* Provider's size */
60 	uint32_t	chunk_count;		/* Number of chunks in this pr. */
61 	uint32_t	chunk_next;		/* Next chunk to allocate */
62 	uint16_t	chunk_reserved;		/* Count of "reserved" chunks */
63 	uint16_t	flags;			/* Provider's flags */
64 };
65 
66 void virstor_metadata_encode(struct g_virstor_metadata *md, unsigned char *data);
67 void virstor_metadata_decode(unsigned char *data, struct g_virstor_metadata *md);
68 
69 #endif	/* !_G_VIRSTOR_H_ */
70