xref: /freebsd/sys/geom/concat/g_concat.h (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
1 /*-
2  * Copyright (c) 2004 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_CONCAT_H_
30 #define	_G_CONCAT_H_
31 
32 #include <sys/endian.h>
33 
34 #define	G_CONCAT_CLASS_NAME	"CONCAT"
35 
36 #define	G_CONCAT_MAGIC		"GEOM::CONCAT"
37 /*
38  * Version history:
39  * 1 - Initial version number.
40  * 2 - Added 'stop' command to gconcat(8).
41  * 3 - Added md_provider field to metadata and '-h' option to gconcat(8).
42  */
43 #define	G_CONCAT_VERSION	3
44 
45 #ifdef _KERNEL
46 #define	G_CONCAT_TYPE_MANUAL	0
47 #define	G_CONCAT_TYPE_AUTOMATIC	1
48 
49 #define	G_CONCAT_DEBUG(lvl, ...)	do {				\
50 	if (g_concat_debug >= (lvl)) {					\
51 		printf("GEOM_CONCAT");					\
52 		if (g_concat_debug > 0)					\
53 			printf("[%u]", lvl);				\
54 		printf(": ");						\
55 		printf(__VA_ARGS__);					\
56 		printf("\n");						\
57 	}								\
58 } while (0)
59 #define	G_CONCAT_LOGREQ(bp, ...)	do {				\
60 	if (g_concat_debug >= 2) {					\
61 		printf("GEOM_CONCAT[2]: ");				\
62 		printf(__VA_ARGS__);					\
63 		printf(" ");						\
64 		g_print_bio(bp);					\
65 		printf("\n");						\
66 	}								\
67 } while (0)
68 
69 struct g_concat_disk {
70 	struct g_consumer	*d_consumer;
71 	struct g_concat_softc	*d_softc;
72 	off_t			 d_start;
73 	off_t			 d_end;
74 };
75 
76 struct g_concat_softc {
77 	u_int		 sc_type;	/* provider type */
78 	struct g_geom	*sc_geom;
79 	struct g_provider *sc_provider;
80 	uint32_t	 sc_id;		/* concat unique ID */
81 
82 	struct g_concat_disk *sc_disks;
83 	uint16_t	 sc_ndisks;
84 };
85 #define	sc_name	sc_geom->name
86 #endif	/* _KERNEL */
87 
88 struct g_concat_metadata {
89 	char		md_magic[16];	/* Magic value. */
90 	uint32_t	md_version;	/* Version number. */
91 	char		md_name[16];	/* Concat name. */
92 	uint32_t	md_id;		/* Unique ID. */
93 	uint16_t	md_no;		/* Disk number. */
94 	uint16_t	md_all;		/* Number of all disks. */
95 	char		md_provider[16]; /* Hardcoded provider. */
96 };
97 static __inline void
98 concat_metadata_encode(const struct g_concat_metadata *md, u_char *data)
99 {
100 
101 	bcopy(md->md_magic, data, sizeof(md->md_magic));
102 	le32enc(data + 16, md->md_version);
103 	bcopy(md->md_name, data + 20, sizeof(md->md_name));
104 	le32enc(data + 36, md->md_id);
105 	le16enc(data + 40, md->md_no);
106 	le16enc(data + 42, md->md_all);
107 	bcopy(md->md_provider, data + 44, sizeof(md->md_provider));
108 }
109 static __inline void
110 concat_metadata_decode(const u_char *data, struct g_concat_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 	bcopy(data + 44, md->md_provider, sizeof(md->md_provider));
120 }
121 #endif	/* _G_CONCAT_H_ */
122