xref: /freebsd/sys/geom/label/g_label.h (revision 6fd05b64b5b65dd4ba9b86482a0634a5f0b96c29)
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_LABEL_H_
30 #define	_G_LABEL_H_
31 
32 #include <sys/endian.h>
33 
34 #define	G_LABEL_CLASS_NAME	"LABEL"
35 
36 #define	G_LABEL_MAGIC		"GEOM::LABEL"
37 #define	G_LABEL_VERSION		1
38 #define	G_LABEL_DIR		"label"
39 
40 #ifdef _KERNEL
41 extern u_int g_label_debug;
42 
43 #define	G_LABEL_DEBUG(lvl, ...)	do {					\
44 	if (g_label_debug >= (lvl)) {					\
45 		printf("GEOM_LABEL");					\
46 		if (g_label_debug > 0)					\
47 			printf("[%u]", lvl);				\
48 		printf(": ");						\
49 		printf(__VA_ARGS__);					\
50 		printf("\n");						\
51 	}								\
52 } while (0)
53 
54 typedef void g_label_taste_t (struct g_consumer *cp, char *label, size_t size);
55 
56 struct g_label_desc {
57 	g_label_taste_t	*ld_taste;
58 	char		*ld_dir;
59 };
60 
61 /* Supported labels. */
62 extern const struct g_label_desc g_label_ufs;
63 extern const struct g_label_desc g_label_iso9660;
64 extern const struct g_label_desc g_label_msdosfs;
65 #endif	/* _KERNEL */
66 
67 struct g_label_metadata {
68 	char		md_magic[16];	/* Magic value. */
69 	uint32_t	md_version;	/* Version number. */
70 	char		md_label[16];	/* Label. */
71 };
72 static __inline void
73 label_metadata_encode(const struct g_label_metadata *md, u_char *data)
74 {
75 
76 	bcopy(md->md_magic, data, sizeof(md->md_magic));
77 	le32enc(data + 16, md->md_version);
78 	bcopy(md->md_label, data + 20, sizeof(md->md_label));
79 }
80 static __inline void
81 label_metadata_decode(const u_char *data, struct g_label_metadata *md)
82 {
83 
84 	bcopy(data, md->md_magic, sizeof(md->md_magic));
85 	md->md_version = le32dec(data + 16);
86 	bcopy(data + 20, md->md_label, sizeof(md->md_label));
87 }
88 #endif	/* _G_LABEL_H_ */
89