xref: /freebsd/sys/geom/part/g_part.h (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
1 /*-
2  * Copyright (c) 2006-2008 Marcel Moolenaar
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  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _GEOM_PART_H_
30 #define	_GEOM_PART_H_
31 
32 #define	G_PART_TRACE(args)	g_trace args
33 
34 #define G_PART_PROBE_PRI_LOW	-10
35 #define	G_PART_PROBE_PRI_NORM	-5
36 #define	G_PART_PROBE_PRI_HIGH	0
37 
38 enum g_part_alias {
39 	G_PART_ALIAS_APPLE_BOOT,	/* An Apple boot partition entry. */
40 	G_PART_ALIAS_APPLE_HFS,		/* An HFS+ file system entry. */
41 	G_PART_ALIAS_APPLE_LABEL,	/* An Apple label partition entry. */
42 	G_PART_ALIAS_APPLE_RAID,	/* An Apple RAID partition entry. */
43 	G_PART_ALIAS_APPLE_RAID_OFFLINE,/* An Apple RAID (offline) part entry.*/
44 	G_PART_ALIAS_APPLE_TV_RECOVERY,	/* An Apple TV recovery part entry. */
45 	G_PART_ALIAS_APPLE_UFS,		/* An Apple UFS partition entry. */
46 	G_PART_ALIAS_EFI,		/* A EFI system partition entry. */
47 	G_PART_ALIAS_FREEBSD,		/* A BSD labeled partition entry. */
48 	G_PART_ALIAS_FREEBSD_BOOT,	/* A FreeBSD boot partition entry. */
49 	G_PART_ALIAS_FREEBSD_NANDFS,	/* A FreeBSD nandfs partition entry. */
50 	G_PART_ALIAS_FREEBSD_SWAP,	/* A swap partition entry. */
51 	G_PART_ALIAS_FREEBSD_UFS,	/* A UFS/UFS2 file system entry. */
52 	G_PART_ALIAS_FREEBSD_VINUM,	/* A Vinum partition entry. */
53 	G_PART_ALIAS_FREEBSD_ZFS,	/* A ZFS file system entry. */
54 	G_PART_ALIAS_MBR,		/* A MBR (extended) partition entry. */
55 	G_PART_ALIAS_LINUX_DATA,	/* A Linux data partition entry. */
56 	G_PART_ALIAS_LINUX_LVM,		/* A Linux LVM partition entry. */
57 	G_PART_ALIAS_LINUX_RAID,	/* A Linux RAID partition entry. */
58 	G_PART_ALIAS_LINUX_SWAP,	/* A Linux swap partition entry. */
59 	G_PART_ALIAS_MS_BASIC_DATA,	/* A Microsoft Data part. entry. */
60 	G_PART_ALIAS_MS_LDM_DATA,	/* A Microsoft LDM Data part. entry. */
61 	G_PART_ALIAS_MS_LDM_METADATA,	/* A Microsoft LDM Metadata entry. */
62 	G_PART_ALIAS_MS_RESERVED,	/* A Microsoft Reserved part. entry. */
63 	G_PART_ALIAS_MS_NTFS,		/* A Microsoft NTFS partition entry */
64 	G_PART_ALIAS_NETBSD_CCD,	/* A NetBSD CCD partition entry. */
65 	G_PART_ALIAS_NETBSD_CGD,	/* A NetBSD CGD partition entry. */
66 	G_PART_ALIAS_NETBSD_FFS,	/* A NetBSD FFS partition entry. */
67 	G_PART_ALIAS_NETBSD_RAID,	/* A NetBSD RAID partition entry. */
68 	G_PART_ALIAS_NETBSD_SWAP,	/* A NetBSD swap partition entry. */
69 	G_PART_ALIAS_NETBSD_LFS,	/* A NetBSD LFS partition entry. */
70 	G_PART_ALIAS_EBR,		/* A EBR partition entry. */
71 	G_PART_ALIAS_MS_FAT16,		/* A Microsoft FAT16 partition entry. */
72 	G_PART_ALIAS_MS_FAT32,		/* A Microsoft FAT32 partition entry. */
73 	G_PART_ALIAS_BIOS_BOOT,		/* A GRUB 2 boot partition entry. */
74 	G_PART_ALIAS_VMFS,		/* A VMware VMFS partition entry */
75 	G_PART_ALIAS_VMKDIAG,		/* A VMware vmkDiagnostic partition entry */
76 	G_PART_ALIAS_VMRESERVED,	/* A VMware reserved partition entry */
77 	G_PART_ALIAS_VMVSANHDR,		/* A VMware vSAN header partition entry */
78 	G_PART_ALIAS_DFBSD,		/* A DfBSD label32 partition entry */
79 	G_PART_ALIAS_DFBSD64,		/* A DfBSD label64 partition entry */
80 	G_PART_ALIAS_DFBSD_SWAP,	/* A DfBSD swap partition entry */
81 	G_PART_ALIAS_DFBSD_UFS,		/* A DfBSD UFS partition entry */
82 	G_PART_ALIAS_DFBSD_VINUM,	/* A DfBSD Vinum partition entry */
83 	G_PART_ALIAS_DFBSD_CCD,		/* A DfBSD CCD partition entry */
84 	G_PART_ALIAS_DFBSD_LEGACY,	/* A DfBSD legacy partition entry */
85 	G_PART_ALIAS_DFBSD_HAMMER,	/* A DfBSD HAMMER FS partition entry */
86 	G_PART_ALIAS_DFBSD_HAMMER2,	/* A DfBSD HAMMER2 FS partition entry */
87 	G_PART_ALIAS_PREP_BOOT,		/* A PREP/CHRP boot partition entry. */
88 	/* Keep the following last */
89 	G_PART_ALIAS_COUNT
90 };
91 
92 const char *g_part_alias_name(enum g_part_alias);
93 
94 /* G_PART scheme (KOBJ class). */
95 struct g_part_scheme {
96 	KOBJ_CLASS_FIELDS;
97 	size_t		gps_entrysz;
98 	int		gps_minent;
99 	int		gps_maxent;
100 	int		gps_bootcodesz;
101 	TAILQ_ENTRY(g_part_scheme) scheme_list;
102 };
103 
104 struct g_part_entry {
105 	LIST_ENTRY(g_part_entry) gpe_entry;
106 	struct g_provider *gpe_pp;	/* Corresponding provider. */
107 	off_t		gpe_offset;	/* Byte offset. */
108 	quad_t		gpe_start;	/* First LBA of partition. */
109 	quad_t		gpe_end;	/* Last LBA of partition. */
110 	int		gpe_index;
111 	int		gpe_created:1;	/* Entry is newly created. */
112 	int		gpe_deleted:1;	/* Entry has been deleted. */
113 	int		gpe_modified:1;	/* Entry has been modified. */
114 	int		gpe_internal:1;	/* Entry is not a used entry. */
115 };
116 
117 /* G_PART table (KOBJ instance). */
118 struct g_part_table {
119 	KOBJ_FIELDS;
120 	struct g_part_scheme *gpt_scheme;
121 	struct g_geom	*gpt_gp;
122 	LIST_HEAD(, g_part_entry) gpt_entry;
123 	quad_t		gpt_first;	/* First allocatable LBA */
124 	quad_t		gpt_last;	/* Last allocatable LBA */
125 	int		gpt_entries;
126 	/*
127 	 * gpt_smhead and gpt_smtail are bitmaps representing the first
128 	 * 32 sectors on the disk (gpt_smhead) and the last 32 sectors
129 	 * on the disk (gpt_smtail). These maps are used by the commit
130 	 * verb to clear sectors previously used by a scheme after the
131 	 * partitioning scheme has been destroyed.
132 	 */
133 	uint32_t	gpt_smhead;
134 	uint32_t	gpt_smtail;
135 	/*
136 	 * gpt_sectors and gpt_heads are the fixed or synchesized number
137 	 * of sectors per track and heads (resp) that make up a disks
138 	 * geometry. This is to support partitioning schemes as well as
139 	 * file systems that work on a geometry. The MBR scheme and the
140 	 * MS-DOS (FAT) file system come to mind.
141 	 * We keep track of whether the geometry is fixed or synchesized
142 	 * so that a partitioning scheme can correct the synthesized
143 	 * geometry, based on the on-disk metadata.
144 	 */
145 	uint32_t	gpt_sectors;
146 	uint32_t	gpt_heads;
147 
148 	int		gpt_depth;	/* Sub-partitioning level. */
149 	int		gpt_isleaf:1;	/* Cannot be sub-partitioned. */
150 	int		gpt_created:1;	/* Newly created. */
151 	int		gpt_modified:1;	/* Table changes have been made. */
152 	int		gpt_opened:1;	/* Permissions obtained. */
153 	int		gpt_fixgeom:1;	/* Geometry is fixed. */
154 	int		gpt_corrupt:1;	/* Table is corrupt. */
155 };
156 
157 struct g_part_entry *g_part_new_entry(struct g_part_table *, int, quad_t,
158     quad_t);
159 
160 enum g_part_ctl {
161 	G_PART_CTL_NONE,
162 	G_PART_CTL_ADD,
163 	G_PART_CTL_BOOTCODE,
164 	G_PART_CTL_COMMIT,
165 	G_PART_CTL_CREATE,
166 	G_PART_CTL_DELETE,
167 	G_PART_CTL_DESTROY,
168 	G_PART_CTL_MODIFY,
169 	G_PART_CTL_MOVE,
170 	G_PART_CTL_RECOVER,
171 	G_PART_CTL_RESIZE,
172 	G_PART_CTL_SET,
173 	G_PART_CTL_UNDO,
174 	G_PART_CTL_UNSET
175 };
176 
177 /* G_PART ctlreq parameters. */
178 #define	G_PART_PARM_ENTRIES	0x0001
179 #define	G_PART_PARM_FLAGS	0x0002
180 #define	G_PART_PARM_GEOM	0x0004
181 #define	G_PART_PARM_INDEX	0x0008
182 #define	G_PART_PARM_LABEL	0x0010
183 #define	G_PART_PARM_OUTPUT	0x0020
184 #define	G_PART_PARM_PROVIDER	0x0040
185 #define	G_PART_PARM_SCHEME	0x0080
186 #define	G_PART_PARM_SIZE	0x0100
187 #define	G_PART_PARM_START	0x0200
188 #define	G_PART_PARM_TYPE	0x0400
189 #define	G_PART_PARM_VERSION	0x0800
190 #define	G_PART_PARM_BOOTCODE	0x1000
191 #define	G_PART_PARM_ATTRIB	0x2000
192 #define	G_PART_PARM_FORCE	0x4000
193 
194 struct g_part_parms {
195 	unsigned int	gpp_parms;
196 	unsigned int	gpp_entries;
197 	const char	*gpp_flags;
198 	struct g_geom	*gpp_geom;
199 	unsigned int	gpp_index;
200 	const char	*gpp_label;
201 	struct g_provider *gpp_provider;
202 	struct g_part_scheme *gpp_scheme;
203 	quad_t		gpp_size;
204 	quad_t		gpp_start;
205 	const char	*gpp_type;
206 	unsigned int	gpp_version;
207 	const void	*gpp_codeptr;
208 	unsigned int	gpp_codesize;
209 	const char	*gpp_attrib;
210 	unsigned int	gpp_force;
211 };
212 
213 void g_part_geometry_heads(off_t, u_int, off_t *, u_int *);
214 
215 int g_part_modevent(module_t, int, struct g_part_scheme *);
216 
217 #define	G_PART_SCHEME_DECLARE(name)				\
218     static int name##_modevent(module_t mod, int tp, void *d)	\
219     {								\
220 	return (g_part_modevent(mod, tp, d));			\
221     }								\
222     static moduledata_t name##_mod = {				\
223 	#name,							\
224 	name##_modevent,					\
225 	&name##_scheme						\
226     };								\
227     DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
228     MODULE_DEPEND(name, g_part, 0, 0, 0)
229 
230 #endif /* !_GEOM_PART_H_ */
231