xref: /freebsd/sys/geom/concat/g_concat.h (revision e858faa9bb929e040dfa2ee6f9e4806cec4d685d)
1 /*-
2  * Copyright (c) 2003 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	0
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[%u]: ", lvl);			\
46 		printf(__VA_ARGS__);					\
47 		printf("\n");						\
48 	}								\
49 } while (0)
50 #define	G_CONCAT_LOGREQ(bp, ...)	do {				\
51 	if (g_concat_debug >= 2) {					\
52 		printf("GEOM_CONCAT[2]: ");				\
53 		printf(__VA_ARGS__);					\
54 		g_print_bio(bp);					\
55 		printf("\n");						\
56 	}								\
57 } while (0)
58 
59 extern struct sysctl_oid_list sysctl__kern_geom_children;
60 
61 struct g_concat_disk {
62 	struct g_consumer	*d_consumer;
63 	struct g_concat_softc	*d_softc;
64 	off_t			 d_start;
65 	off_t			 d_end;
66 	off_t			 d_length;
67 	boolean_t		 d_valid;
68 	LIST_ENTRY(g_concat_path) d_next;
69 };
70 
71 struct g_concat_softc {
72 	int		sc_flags;	/* flags */
73 	u_int		sc_type;	/* provider type */
74 	struct g_provider *sc_provider;
75 	char		sc_name[16];	/* concat name */
76 	uint32_t	sc_id;		/* concat unique ID */
77 
78 	struct g_concat_disk *sc_disks;
79 	uint16_t	sc_ndisks;
80 };
81 #endif	/* _KERNEL */
82 
83 struct g_concat_metadata {
84 	char		md_magic[16];	/* Magic value. */
85 	uint32_t	md_version;	/* Version number. */
86 	char		md_name[16];	/* Concat name. */
87 	uint32_t	md_id;		/* Unique ID. */
88 	uint16_t	md_no;		/* Disk number. */
89 	uint16_t	md_all;		/* Number of all disks. */
90 };
91 static __inline void
92 concat_metadata_encode(const struct g_concat_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 }
102 static __inline void
103 concat_metadata_decode(const u_char *data, struct g_concat_metadata *md)
104 {
105 
106 	bcopy(data, md->md_magic, sizeof(md->md_magic));
107 	md->md_version = le32dec(data + 16);
108 	bcopy(data + 20, md->md_name, sizeof(md->md_name));
109 	md->md_id = le32dec(data + 36);
110 	md->md_no = le16dec(data + 40);
111 	md->md_all = le16dec(data + 42);
112 }
113 #endif	/* _G_CONCAT_H_ */
114