xref: /freebsd/sys/geom/label/g_label.h (revision 6ae1554a5d9b318f8ad53ccc39fa5a961403da73)
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_LABEL_H_
30 #define	_G_LABEL_H_
31 
32 #include <sys/endian.h>
33 #ifdef _KERNEL
34 #include <sys/sysctl.h>
35 #endif
36 
37 #define	G_LABEL_CLASS_NAME	"LABEL"
38 
39 #define	G_LABEL_MAGIC		"GEOM::LABEL"
40 /*
41  * Version history:
42  * 1 - Initial version number.
43  * 2 - Added md_provsize field to metadata.
44  */
45 #define	G_LABEL_VERSION		2
46 #define	G_LABEL_DIR		"label"
47 
48 #ifdef _KERNEL
49 extern u_int g_label_debug;
50 
51 #define	G_LABEL_DEBUG(lvl, ...)	do {					\
52 	if (g_label_debug >= (lvl)) {					\
53 		printf("GEOM_LABEL");					\
54 		if (g_label_debug > 0)					\
55 			printf("[%u]", lvl);				\
56 		printf(": ");						\
57 		printf(__VA_ARGS__);					\
58 		printf("\n");						\
59 	}								\
60 } while (0)
61 
62 SYSCTL_DECL(_kern_geom_label);
63 
64 #define	G_LABEL_INIT(kind, label, descr) 				\
65 	SYSCTL_NODE(_kern_geom_label, OID_AUTO, kind, CTLFLAG_RD,	\
66 	    NULL, "");							\
67 	SYSCTL_INT(_kern_geom_label_##kind, OID_AUTO, enable, 		\
68 	    CTLFLAG_RWTUN, &label.ld_enabled, 1, descr)
69 
70 typedef void g_label_taste_t (struct g_consumer *cp, char *label, size_t size);
71 
72 struct g_label_desc {
73 	g_label_taste_t	*ld_taste;
74 	char		*ld_dir;
75 	int		 ld_enabled;
76 };
77 
78 /* Supported labels. */
79 extern struct g_label_desc g_label_ufs_id;
80 extern struct g_label_desc g_label_ufs_volume;
81 extern struct g_label_desc g_label_iso9660;
82 extern struct g_label_desc g_label_msdosfs;
83 extern struct g_label_desc g_label_ext2fs;
84 extern struct g_label_desc g_label_reiserfs;
85 extern struct g_label_desc g_label_ntfs;
86 extern struct g_label_desc g_label_gpt;
87 extern struct g_label_desc g_label_gpt_uuid;
88 extern struct g_label_desc g_label_disk_ident;
89 
90 extern void g_label_rtrim(char *label, size_t size);
91 #endif	/* _KERNEL */
92 
93 struct g_label_metadata {
94 	char		md_magic[16];	/* Magic value. */
95 	uint32_t	md_version;	/* Version number. */
96 	char		md_label[16];	/* Label. */
97 	uint64_t	md_provsize;	/* Provider's size. */
98 };
99 static __inline void
100 label_metadata_encode(const struct g_label_metadata *md, u_char *data)
101 {
102 
103 	bcopy(md->md_magic, data, sizeof(md->md_magic));
104 	le32enc(data + 16, md->md_version);
105 	bcopy(md->md_label, data + 20, sizeof(md->md_label));
106 	le64enc(data + 36, md->md_provsize);
107 }
108 static __inline void
109 label_metadata_decode(const u_char *data, struct g_label_metadata *md)
110 {
111 
112 	bcopy(data, md->md_magic, sizeof(md->md_magic));
113 	md->md_version = le32dec(data + 16);
114 	bcopy(data + 20, md->md_label, sizeof(md->md_label));
115 	md->md_provsize = le64dec(data + 36);
116 }
117 #endif	/* _G_LABEL_H_ */
118