xref: /freebsd/sys/geom/shsec/g_shsec.h (revision f0a75d274af375d15b97b830966b99a02b7db911)
1 /*-
2  * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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 #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, ...)	do {					\
48 	if (g_shsec_debug >= (lvl)) {					\
49 		printf("GEOM_SHSEC");					\
50 		if (g_shsec_debug > 0)					\
51 			printf("[%u]", lvl);				\
52 		printf(": ");						\
53 		printf(__VA_ARGS__);					\
54 		printf("\n");						\
55 	}								\
56 } while (0)
57 #define	G_SHSEC_LOGREQ(lvl, bp, ...)	do {				\
58 	if (g_shsec_debug >= (lvl)) {					\
59 		printf("GEOM_SHSEC");					\
60 		if (g_shsec_debug > 0)					\
61 			printf("[%u]", lvl);				\
62 		printf(": ");						\
63 		printf(__VA_ARGS__);					\
64 		printf(" ");						\
65 		g_print_bio(bp);					\
66 		printf("\n");						\
67 	}								\
68 } while (0)
69 
70 struct g_shsec_softc {
71 	u_int		 sc_type;	/* provider type */
72 	struct g_geom	*sc_geom;
73 	struct g_provider *sc_provider;
74 	uint32_t	 sc_id;		/* device unique ID */
75 	struct g_consumer **sc_disks;
76 	uint16_t	 sc_ndisks;
77 };
78 #define	sc_name	sc_geom->name
79 #endif	/* _KERNEL */
80 
81 struct g_shsec_metadata {
82 	char		md_magic[16];	/* Magic value. */
83 	uint32_t	md_version;	/* Version number. */
84 	char		md_name[16];	/* Stripe name. */
85 	uint32_t	md_id;		/* Unique ID. */
86 	uint16_t	md_no;		/* Disk number. */
87 	uint16_t	md_all;		/* Number of all disks. */
88 	char		md_provider[16]; /* Hardcoded provider. */
89 	uint64_t	md_provsize;	/* Provider's size. */
90 };
91 static __inline void
92 shsec_metadata_encode(const struct g_shsec_metadata *md, u_char *data)
93 {
94 
95 	bcopy(md->md_magic, data, sizeof(md->md_magic));
96 	le32enc(data + 16, md->md_version);
97 	bcopy(md->md_name, data + 20, sizeof(md->md_name));
98 	le32enc(data + 36, md->md_id);
99 	le16enc(data + 40, md->md_no);
100 	le16enc(data + 42, md->md_all);
101 	bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
102 	le64enc(data + 60, md->md_provsize);
103 }
104 static __inline void
105 shsec_metadata_decode(const u_char *data, struct g_shsec_metadata *md)
106 {
107 
108 	bcopy(data, md->md_magic, sizeof(md->md_magic));
109 	md->md_version = le32dec(data + 16);
110 	bcopy(data + 20, md->md_name, sizeof(md->md_name));
111 	md->md_id = le32dec(data + 36);
112 	md->md_no = le16dec(data + 40);
113 	md->md_all = le16dec(data + 42);
114 	bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
115 	md->md_provsize = le64dec(data + 60);
116 }
117 #endif	/* _G_SHSEC_H_ */
118