xref: /freebsd/sys/geom/stripe/g_stripe.h (revision 84dfba8d183d31e3412639ecb4b8ad4433cf7e80)
1 /*-
2  * Copyright (c) 2004-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_STRIPE_H_
30 #define	_G_STRIPE_H_
31 
32 #include <sys/endian.h>
33 
34 #define	G_STRIPE_CLASS_NAME	"STRIPE"
35 
36 #define	G_STRIPE_MAGIC		"GEOM::STRIPE"
37 /*
38  * Version history:
39  * 0 - Initial version number.
40  * 1 - Added 'stop' command for gstripe(8).
41  * 2 - Added md_provider field to metadata and '-h' option for gstripe(8).
42  * 3 - Added md_provsize field to metadata.
43  */
44 #define	G_STRIPE_VERSION	3
45 
46 #ifdef _KERNEL
47 #define	G_STRIPE_TYPE_MANUAL	0
48 #define	G_STRIPE_TYPE_AUTOMATIC	1
49 
50 #define	G_STRIPE_DEBUG(lvl, ...)	do {				\
51 	if (g_stripe_debug >= (lvl)) {					\
52 		printf("GEOM_STRIPE");					\
53 		if (g_stripe_debug > 0)					\
54 			printf("[%u]", lvl);				\
55 		printf(": ");						\
56 		printf(__VA_ARGS__);					\
57 		printf("\n");						\
58 	}								\
59 } while (0)
60 #define	G_STRIPE_LOGREQ(bp, ...)	do {				\
61 	if (g_stripe_debug >= 2) {					\
62 		printf("GEOM_STRIPE[2]: ");				\
63 		printf(__VA_ARGS__);					\
64 		printf(" ");						\
65 		g_print_bio(bp);					\
66 		printf("\n");						\
67 	}								\
68 } while (0)
69 
70 struct g_stripe_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;		/* stripe unique ID */
75 	struct g_consumer **sc_disks;
76 	uint16_t	 sc_ndisks;
77 	uint32_t	 sc_stripesize;
78 	uint32_t	 sc_stripebits;
79 	struct mtx	 sc_lock;
80 };
81 #define	sc_name	sc_geom->name
82 #endif	/* _KERNEL */
83 
84 struct g_stripe_metadata {
85 	char		md_magic[16];	/* Magic value. */
86 	uint32_t	md_version;	/* Version number. */
87 	char		md_name[16];	/* Stripe name. */
88 	uint32_t	md_id;		/* Unique ID. */
89 	uint16_t	md_no;		/* Disk number. */
90 	uint16_t	md_all;		/* Number of all disks. */
91 	uint32_t	md_stripesize;	/* Stripe size. */
92 	char		md_provider[16]; /* Hardcoded provider. */
93 	uint64_t	md_provsize;	/* Provider's size. */
94 };
95 static __inline void
96 stripe_metadata_encode(const struct g_stripe_metadata *md, u_char *data)
97 {
98 
99 	bcopy(md->md_magic, data, sizeof(md->md_magic));
100 	le32enc(data + 16, md->md_version);
101 	bcopy(md->md_name, data + 20, sizeof(md->md_name));
102 	le32enc(data + 36, md->md_id);
103 	le16enc(data + 40, md->md_no);
104 	le16enc(data + 42, md->md_all);
105 	le32enc(data + 44, md->md_stripesize);
106 	bcopy(md->md_provider, data + 48, sizeof(md->md_provider));
107 	le64enc(data + 64, md->md_provsize);
108 }
109 static __inline void
110 stripe_metadata_decode(const u_char *data, struct g_stripe_metadata *md)
111 {
112 
113 	bcopy(data, md->md_magic, sizeof(md->md_magic));
114 	md->md_version = le32dec(data + 16);
115 	bcopy(data + 20, md->md_name, sizeof(md->md_name));
116 	md->md_id = le32dec(data + 36);
117 	md->md_no = le16dec(data + 40);
118 	md->md_all = le16dec(data + 42);
119 	md->md_stripesize = le32dec(data + 44);
120 	bcopy(data + 48, md->md_provider, sizeof(md->md_provider));
121 	md->md_provsize = le64dec(data + 64);
122 }
123 
124 #endif	/* _G_STRIPE_H_ */
125