g_part.h revision 268091
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: stable/10/sys/geom/part/g_part.h 268091 2014-07-01 13:29:17Z ae $
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
38enum 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	/* Keep the following last */
88	G_PART_ALIAS_COUNT
89};
90
91const char *g_part_alias_name(enum g_part_alias);
92
93/* G_PART scheme (KOBJ class). */
94struct g_part_scheme {
95	KOBJ_CLASS_FIELDS;
96	size_t		gps_entrysz;
97	int		gps_minent;
98	int		gps_maxent;
99	int		gps_bootcodesz;
100	TAILQ_ENTRY(g_part_scheme) scheme_list;
101};
102
103struct g_part_entry {
104	LIST_ENTRY(g_part_entry) gpe_entry;
105	struct g_provider *gpe_pp;	/* Corresponding provider. */
106	off_t		gpe_offset;	/* Byte offset. */
107	quad_t		gpe_start;	/* First LBA of partition. */
108	quad_t		gpe_end;	/* Last LBA of partition. */
109	int		gpe_index;
110	int		gpe_created:1;	/* Entry is newly created. */
111	int		gpe_deleted:1;	/* Entry has been deleted. */
112	int		gpe_modified:1;	/* Entry has been modified. */
113	int		gpe_internal:1;	/* Entry is not a used entry. */
114};
115
116/* G_PART table (KOBJ instance). */
117struct g_part_table {
118	KOBJ_FIELDS;
119	struct g_part_scheme *gpt_scheme;
120	struct g_geom	*gpt_gp;
121	LIST_HEAD(, g_part_entry) gpt_entry;
122	quad_t		gpt_first;	/* First allocatable LBA */
123	quad_t		gpt_last;	/* Last allocatable LBA */
124	int		gpt_entries;
125	/*
126	 * gpt_smhead and gpt_smtail are bitmaps representing the first
127	 * 32 sectors on the disk (gpt_smhead) and the last 32 sectors
128	 * on the disk (gpt_smtail). These maps are used by the commit
129	 * verb to clear sectors previously used by a scheme after the
130	 * partitioning scheme has been destroyed.
131	 */
132	uint32_t	gpt_smhead;
133	uint32_t	gpt_smtail;
134	/*
135	 * gpt_sectors and gpt_heads are the fixed or synchesized number
136	 * of sectors per track and heads (resp) that make up a disks
137	 * geometry. This is to support partitioning schemes as well as
138	 * file systems that work on a geometry. The MBR scheme and the
139	 * MS-DOS (FAT) file system come to mind.
140	 * We keep track of whether the geometry is fixed or synchesized
141	 * so that a partitioning scheme can correct the synthesized
142	 * geometry, based on the on-disk metadata.
143	 */
144	uint32_t	gpt_sectors;
145	uint32_t	gpt_heads;
146
147	int		gpt_depth;	/* Sub-partitioning level. */
148	int		gpt_isleaf:1;	/* Cannot be sub-partitioned. */
149	int		gpt_created:1;	/* Newly created. */
150	int		gpt_modified:1;	/* Table changes have been made. */
151	int		gpt_opened:1;	/* Permissions obtained. */
152	int		gpt_fixgeom:1;	/* Geometry is fixed. */
153	int		gpt_corrupt:1;	/* Table is corrupt. */
154};
155
156struct g_part_entry *g_part_new_entry(struct g_part_table *, int, quad_t,
157    quad_t);
158
159enum g_part_ctl {
160	G_PART_CTL_NONE,
161	G_PART_CTL_ADD,
162	G_PART_CTL_BOOTCODE,
163	G_PART_CTL_COMMIT,
164	G_PART_CTL_CREATE,
165	G_PART_CTL_DELETE,
166	G_PART_CTL_DESTROY,
167	G_PART_CTL_MODIFY,
168	G_PART_CTL_MOVE,
169	G_PART_CTL_RECOVER,
170	G_PART_CTL_RESIZE,
171	G_PART_CTL_SET,
172	G_PART_CTL_UNDO,
173	G_PART_CTL_UNSET
174};
175
176/* G_PART ctlreq parameters. */
177#define	G_PART_PARM_ENTRIES	0x0001
178#define	G_PART_PARM_FLAGS	0x0002
179#define	G_PART_PARM_GEOM	0x0004
180#define	G_PART_PARM_INDEX	0x0008
181#define	G_PART_PARM_LABEL	0x0010
182#define	G_PART_PARM_OUTPUT	0x0020
183#define	G_PART_PARM_PROVIDER	0x0040
184#define	G_PART_PARM_SCHEME	0x0080
185#define	G_PART_PARM_SIZE	0x0100
186#define	G_PART_PARM_START	0x0200
187#define	G_PART_PARM_TYPE	0x0400
188#define	G_PART_PARM_VERSION	0x0800
189#define	G_PART_PARM_BOOTCODE	0x1000
190#define	G_PART_PARM_ATTRIB	0x2000
191#define	G_PART_PARM_FORCE	0x4000
192
193struct g_part_parms {
194	unsigned int	gpp_parms;
195	unsigned int	gpp_entries;
196	const char	*gpp_flags;
197	struct g_geom	*gpp_geom;
198	unsigned int	gpp_index;
199	const char	*gpp_label;
200	struct g_provider *gpp_provider;
201	struct g_part_scheme *gpp_scheme;
202	quad_t		gpp_size;
203	quad_t		gpp_start;
204	const char	*gpp_type;
205	unsigned int	gpp_version;
206	const void	*gpp_codeptr;
207	unsigned int	gpp_codesize;
208	const char	*gpp_attrib;
209	unsigned int	gpp_force;
210};
211
212void g_part_geometry_heads(off_t, u_int, off_t *, u_int *);
213
214int g_part_modevent(module_t, int, struct g_part_scheme *);
215
216#define	G_PART_SCHEME_DECLARE(name)				\
217    static int name##_modevent(module_t mod, int tp, void *d)	\
218    {								\
219	return (g_part_modevent(mod, tp, d));			\
220    }								\
221    static moduledata_t name##_mod = {				\
222	#name,							\
223	name##_modevent,					\
224	&name##_scheme						\
225    };								\
226    DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
227    MODULE_DEPEND(name, g_part, 0, 0, 0)
228
229#endif /* !_GEOM_PART_H_ */
230