xref: /freebsd/sys/geom/concat/g_concat.h (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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 #define	G_CONCAT_VERSION	2
38 
39 #ifdef _KERNEL
40 #define	G_CONCAT_TYPE_MANUAL	0
41 #define	G_CONCAT_TYPE_AUTOMATIC	1
42 
43 #define	G_CONCAT_DEBUG(lvl, ...)	do {				\
44 	if (g_concat_debug >= (lvl)) {					\
45 		printf("GEOM_CONCAT");					\
46 		if (g_concat_debug > 0)					\
47 			printf("[%u]", lvl);				\
48 		printf(": ");						\
49 		printf(__VA_ARGS__);					\
50 		printf("\n");						\
51 	}								\
52 } while (0)
53 #define	G_CONCAT_LOGREQ(bp, ...)	do {				\
54 	if (g_concat_debug >= 2) {					\
55 		printf("GEOM_CONCAT[2]: ");				\
56 		printf(__VA_ARGS__);					\
57 		printf(" ");						\
58 		g_print_bio(bp);					\
59 		printf("\n");						\
60 	}								\
61 } while (0)
62 
63 struct g_concat_disk {
64 	struct g_consumer	*d_consumer;
65 	struct g_concat_softc	*d_softc;
66 	off_t			 d_start;
67 	off_t			 d_end;
68 };
69 
70 struct g_concat_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;		/* concat unique ID */
75 
76 	struct g_concat_disk *sc_disks;
77 	uint16_t	 sc_ndisks;
78 };
79 #define	sc_name	sc_geom->name
80 #endif	/* _KERNEL */
81 
82 struct g_concat_metadata {
83 	char		md_magic[16];	/* Magic value. */
84 	uint32_t	md_version;	/* Version number. */
85 	char		md_name[16];	/* Concat name. */
86 	uint32_t	md_id;		/* Unique ID. */
87 	uint16_t	md_no;		/* Disk number. */
88 	uint16_t	md_all;		/* Number of all disks. */
89 };
90 static __inline void
91 concat_metadata_encode(const struct g_concat_metadata *md, u_char *data)
92 {
93 
94 	bcopy(md->md_magic, data, sizeof(md->md_magic));
95 	le32enc(data + 16, md->md_version);
96 	bcopy(md->md_name, data + 20, sizeof(md->md_name));
97 	le32enc(data + 36, md->md_id);
98 	le16enc(data + 40, md->md_no);
99 	le16enc(data + 42, md->md_all);
100 }
101 static __inline void
102 concat_metadata_decode(const u_char *data, struct g_concat_metadata *md)
103 {
104 
105 	bcopy(data, md->md_magic, sizeof(md->md_magic));
106 	md->md_version = le32dec(data + 16);
107 	bcopy(data + 20, md->md_name, sizeof(md->md_name));
108 	md->md_id = le32dec(data + 36);
109 	md->md_no = le16dec(data + 40);
110 	md->md_all = le16dec(data + 42);
111 }
112 #endif	/* _G_CONCAT_H_ */
113