xref: /freebsd/sys/geom/part/g_part.h (revision 4a5216a6dc0c3ce4cf5f2d3ee8af0c3ff3402c4f)
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_HFS,		/* An HFS file system entry. */
40 	G_PART_ALIAS_EFI,		/* A EFI system partition entry. */
41 	G_PART_ALIAS_FREEBSD,		/* A BSD labeled partition entry. */
42 	G_PART_ALIAS_FREEBSD_BOOT,	/* A FreeBSD boot partition entry. */
43 	G_PART_ALIAS_FREEBSD_SWAP,	/* A swap partition entry. */
44 	G_PART_ALIAS_FREEBSD_UFS,	/* A UFS/UFS2 file system entry. */
45 	G_PART_ALIAS_FREEBSD_VINUM,	/* A Vinum partition entry. */
46 	G_PART_ALIAS_FREEBSD_ZFS,	/* A ZFS file system entry. */
47 	G_PART_ALIAS_MBR,		/* A MBR (extended) partition entry. */
48 	/* Keep the following last */
49 	G_PART_ALIAS_COUNT
50 };
51 
52 const char *g_part_alias_name(enum g_part_alias);
53 
54 /* G_PART scheme (KOBJ class). */
55 struct g_part_scheme {
56 	KOBJ_CLASS_FIELDS;
57 	size_t		gps_entrysz;
58 	int		gps_minent;
59 	int		gps_maxent;
60 	int		gps_bootcodesz;
61 	TAILQ_ENTRY(g_part_scheme) scheme_list;
62 };
63 
64 struct g_part_entry {
65 	LIST_ENTRY(g_part_entry) gpe_entry;
66 	struct g_provider *gpe_pp;	/* Corresponding provider. */
67 	off_t		gpe_offset;	/* Byte offset. */
68 	quad_t		gpe_start;	/* First LBA of partition. */
69 	quad_t		gpe_end;	/* Last LBA of partition. */
70 	int		gpe_index;
71 	int		gpe_created:1;	/* Entry is newly created. */
72 	int		gpe_deleted:1;	/* Entry has been deleted. */
73 	int		gpe_modified:1;	/* Entry has been modified. */
74 	int		gpe_internal:1;	/* Entry is not a used entry. */
75 };
76 
77 /* G_PART table (KOBJ instance). */
78 struct g_part_table {
79 	KOBJ_FIELDS;
80 	struct g_part_scheme *gpt_scheme;
81 	struct g_geom	*gpt_gp;
82 	LIST_HEAD(, g_part_entry) gpt_entry;
83 	quad_t		gpt_first;	/* First allocatable LBA */
84 	quad_t		gpt_last;	/* Last allocatable LBA */
85 	int		gpt_entries;
86 	/*
87 	 * gpt_smhead and gpt_smtail are bitmaps representing the first
88 	 * 32 sectors on the disk (gpt_smhead) and the last 32 sectors
89 	 * on the disk (gpt_smtail). These maps are used by the commit
90 	 * verb to clear sectors previously used by a scheme after the
91 	 * partitioning scheme has been destroyed.
92 	 */
93 	uint32_t	gpt_smhead;
94 	uint32_t	gpt_smtail;
95 	/*
96 	 * gpt_sectors and gpt_heads are the fixed or synchesized number
97 	 * of sectors per track and heads (resp) that make up a disks
98 	 * geometry. This is to support partitioning schemes as well as
99 	 * file systems that work on a geometry. The MBR scheme and the
100 	 * MS-DOS (FAT) file system come to mind.
101 	 * We keep track of whether the geometry is fixed or synchesized
102 	 * so that a partitioning scheme can correct the synthesized
103 	 * geometry, based on the on-disk metadata.
104 	 */
105 	uint32_t	gpt_sectors;
106 	uint32_t	gpt_heads;
107 	/*
108 	 * gpt_offset holds the absolute block address of the scheme
109 	 * on disk. Some partitioning schemes (historically) use
110 	 * absolute addressing. Relative addresses are obtained by
111 	 * subtracting gpt_offset from the absolute addresses.
112 	 */
113 	uint64_t	gpt_offset;
114 
115 	int		gpt_depth;	/* Sub-partitioning level. */
116 	int		gpt_isleaf:1;	/* Cannot be sub-partitioned. */
117 	int		gpt_created:1;	/* Newly created. */
118 	int		gpt_modified:1;	/* Table changes have been made. */
119 	int		gpt_opened:1;	/* Permissions obtained. */
120 	int		gpt_fixgeom:1;	/* Geometry is fixed. */
121 };
122 
123 struct g_part_entry *g_part_new_entry(struct g_part_table *, int, quad_t,
124     quad_t);
125 
126 /* G_PART ctlreq parameters. */
127 #define	G_PART_PARM_ENTRIES	0x0001
128 #define	G_PART_PARM_FLAGS	0x0002
129 #define	G_PART_PARM_GEOM	0x0004
130 #define	G_PART_PARM_INDEX	0x0008
131 #define	G_PART_PARM_LABEL	0x0010
132 #define	G_PART_PARM_OUTPUT	0x0020
133 #define	G_PART_PARM_PROVIDER	0x0040
134 #define	G_PART_PARM_SCHEME	0x0080
135 #define	G_PART_PARM_SIZE	0x0100
136 #define	G_PART_PARM_START	0x0200
137 #define	G_PART_PARM_TYPE	0x0400
138 #define	G_PART_PARM_VERSION	0x0800
139 #define	G_PART_PARM_BOOTCODE	0x1000
140 #define	G_PART_PARM_ATTRIB	0x2000
141 
142 struct g_part_parms {
143 	unsigned int	gpp_parms;
144 	unsigned int	gpp_entries;
145 	const char	*gpp_flags;
146 	struct g_geom	*gpp_geom;
147 	unsigned int	gpp_index;
148 	const char	*gpp_label;
149 	struct g_provider *gpp_provider;
150 	struct g_part_scheme *gpp_scheme;
151 	quad_t		gpp_size;
152 	quad_t		gpp_start;
153 	const char	*gpp_type;
154 	unsigned int	gpp_version;
155 	const void	*gpp_codeptr;
156 	unsigned int	gpp_codesize;
157 	const char	*gpp_attrib;
158 };
159 
160 void g_part_geometry_heads(off_t, u_int, off_t *, u_int *);
161 
162 int g_part_modevent(module_t, int, struct g_part_scheme *);
163 
164 #define	G_PART_SCHEME_DECLARE(name)				\
165     static int name##_modevent(module_t mod, int tp, void *d)	\
166     {								\
167 	return (g_part_modevent(mod, tp, d));			\
168     }								\
169     static moduledata_t name##_mod = {				\
170 	#name,							\
171 	name##_modevent,					\
172 	&name##_scheme						\
173     };								\
174     DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY)
175 
176 #endif /* !_GEOM_PART_H_ */
177