1/*-
2 * Copyright (c) 2007 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
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD$");
29
30#include <sys/param.h>
31#include <sys/bio.h>
32#include <sys/disklabel.h>
33#include <sys/endian.h>
34#include <sys/kernel.h>
35#include <sys/kobj.h>
36#include <sys/limits.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/queue.h>
41#include <sys/sbuf.h>
42#include <sys/systm.h>
43#include <sys/sysctl.h>
44#include <geom/geom.h>
45#include <geom/part/g_part.h>
46
47#include "g_part_if.h"
48
49#define	BOOT1_SIZE	512
50#define	LABEL_SIZE	512
51#define	BOOT2_OFF	(BOOT1_SIZE + LABEL_SIZE)
52#define	BOOT2_SIZE	(BBSIZE - BOOT2_OFF)
53
54FEATURE(geom_part_bsd, "GEOM partitioning class for BSD disklabels");
55
56struct g_part_bsd_table {
57	struct g_part_table	base;
58	u_char			*bbarea;
59	uint32_t		offset;
60};
61
62struct g_part_bsd_entry {
63	struct g_part_entry	base;
64	struct partition	part;
65};
66
67static int g_part_bsd_add(struct g_part_table *, struct g_part_entry *,
68    struct g_part_parms *);
69static int g_part_bsd_bootcode(struct g_part_table *, struct g_part_parms *);
70static int g_part_bsd_create(struct g_part_table *, struct g_part_parms *);
71static int g_part_bsd_destroy(struct g_part_table *, struct g_part_parms *);
72static void g_part_bsd_dumpconf(struct g_part_table *, struct g_part_entry *,
73    struct sbuf *, const char *);
74static int g_part_bsd_dumpto(struct g_part_table *, struct g_part_entry *);
75static int g_part_bsd_modify(struct g_part_table *, struct g_part_entry *,
76    struct g_part_parms *);
77static const char *g_part_bsd_name(struct g_part_table *, struct g_part_entry *,
78    char *, size_t);
79static int g_part_bsd_probe(struct g_part_table *, struct g_consumer *);
80static int g_part_bsd_read(struct g_part_table *, struct g_consumer *);
81static const char *g_part_bsd_type(struct g_part_table *, struct g_part_entry *,
82    char *, size_t);
83static int g_part_bsd_write(struct g_part_table *, struct g_consumer *);
84static int g_part_bsd_resize(struct g_part_table *, struct g_part_entry *,
85    struct g_part_parms *);
86
87static kobj_method_t g_part_bsd_methods[] = {
88	KOBJMETHOD(g_part_add,		g_part_bsd_add),
89	KOBJMETHOD(g_part_bootcode,	g_part_bsd_bootcode),
90	KOBJMETHOD(g_part_create,	g_part_bsd_create),
91	KOBJMETHOD(g_part_destroy,	g_part_bsd_destroy),
92	KOBJMETHOD(g_part_dumpconf,	g_part_bsd_dumpconf),
93	KOBJMETHOD(g_part_dumpto,	g_part_bsd_dumpto),
94	KOBJMETHOD(g_part_modify,	g_part_bsd_modify),
95	KOBJMETHOD(g_part_resize,	g_part_bsd_resize),
96	KOBJMETHOD(g_part_name,		g_part_bsd_name),
97	KOBJMETHOD(g_part_probe,	g_part_bsd_probe),
98	KOBJMETHOD(g_part_read,		g_part_bsd_read),
99	KOBJMETHOD(g_part_type,		g_part_bsd_type),
100	KOBJMETHOD(g_part_write,	g_part_bsd_write),
101	{ 0, 0 }
102};
103
104static struct g_part_scheme g_part_bsd_scheme = {
105	"BSD",
106	g_part_bsd_methods,
107	sizeof(struct g_part_bsd_table),
108	.gps_entrysz = sizeof(struct g_part_bsd_entry),
109	.gps_minent = 8,
110	.gps_maxent = 20,	/* Only 22 entries fit in 512 byte sectors */
111	.gps_bootcodesz = BBSIZE,
112};
113G_PART_SCHEME_DECLARE(g_part_bsd);
114
115static int
116bsd_parse_type(const char *type, uint8_t *fstype)
117{
118	const char *alias;
119	char *endp;
120	long lt;
121
122	if (type[0] == '!') {
123		lt = strtol(type + 1, &endp, 0);
124		if (type[1] == '\0' || *endp != '\0' || lt <= 0 || lt >= 256)
125			return (EINVAL);
126		*fstype = (u_int)lt;
127		return (0);
128	}
129	alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_NANDFS);
130	if (!strcasecmp(type, alias)) {
131		*fstype = FS_NANDFS;
132		return (0);
133	}
134	alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP);
135	if (!strcasecmp(type, alias)) {
136		*fstype = FS_SWAP;
137		return (0);
138	}
139	alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS);
140	if (!strcasecmp(type, alias)) {
141		*fstype = FS_BSDFFS;
142		return (0);
143	}
144	alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM);
145	if (!strcasecmp(type, alias)) {
146		*fstype = FS_VINUM;
147		return (0);
148	}
149	alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS);
150	if (!strcasecmp(type, alias)) {
151		*fstype = FS_ZFS;
152		return (0);
153	}
154	return (EINVAL);
155}
156
157static int
158g_part_bsd_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
159    struct g_part_parms *gpp)
160{
161	struct g_part_bsd_entry *entry;
162	struct g_part_bsd_table *table;
163
164	if (gpp->gpp_parms & G_PART_PARM_LABEL)
165		return (EINVAL);
166
167	entry = (struct g_part_bsd_entry *)baseentry;
168	table = (struct g_part_bsd_table *)basetable;
169
170	entry->part.p_size = gpp->gpp_size;
171	entry->part.p_offset = gpp->gpp_start + table->offset;
172	entry->part.p_fsize = 0;
173	entry->part.p_frag = 0;
174	entry->part.p_cpg = 0;
175	return (bsd_parse_type(gpp->gpp_type, &entry->part.p_fstype));
176}
177
178static int
179g_part_bsd_bootcode(struct g_part_table *basetable, struct g_part_parms *gpp)
180{
181	struct g_part_bsd_table *table;
182	const u_char *codeptr;
183
184	if (gpp->gpp_codesize != BOOT1_SIZE && gpp->gpp_codesize != BBSIZE)
185		return (ENODEV);
186
187	table = (struct g_part_bsd_table *)basetable;
188	codeptr = gpp->gpp_codeptr;
189	bcopy(codeptr, table->bbarea, BOOT1_SIZE);
190	if (gpp->gpp_codesize == BBSIZE)
191		bcopy(codeptr + BOOT2_OFF, table->bbarea + BOOT2_OFF,
192		    BOOT2_SIZE);
193	return (0);
194}
195
196static int
197g_part_bsd_create(struct g_part_table *basetable, struct g_part_parms *gpp)
198{
199	struct g_provider *pp;
200	struct g_part_entry *baseentry;
201	struct g_part_bsd_entry *entry;
202	struct g_part_bsd_table *table;
203	u_char *ptr;
204	uint32_t msize, ncyls, secpercyl;
205
206	pp = gpp->gpp_provider;
207
208	if (pp->sectorsize < sizeof(struct disklabel))
209		return (ENOSPC);
210	if (BBSIZE % pp->sectorsize)
211		return (ENOTBLK);
212
213	msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
214	secpercyl = basetable->gpt_sectors * basetable->gpt_heads;
215	ncyls = msize / secpercyl;
216
217	table = (struct g_part_bsd_table *)basetable;
218	table->bbarea = g_malloc(BBSIZE, M_WAITOK | M_ZERO);
219	ptr = table->bbarea + pp->sectorsize;
220
221	le32enc(ptr + 0, DISKMAGIC);			/* d_magic */
222	le32enc(ptr + 40, pp->sectorsize);		/* d_secsize */
223	le32enc(ptr + 44, basetable->gpt_sectors);	/* d_nsectors */
224	le32enc(ptr + 48, basetable->gpt_heads);	/* d_ntracks */
225	le32enc(ptr + 52, ncyls);			/* d_ncylinders */
226	le32enc(ptr + 56, secpercyl);			/* d_secpercyl */
227	le32enc(ptr + 60, msize);			/* d_secperunit */
228	le16enc(ptr + 72, 3600);			/* d_rpm */
229	le32enc(ptr + 132, DISKMAGIC);			/* d_magic2 */
230	le16enc(ptr + 138, basetable->gpt_entries);	/* d_npartitions */
231	le32enc(ptr + 140, BBSIZE);			/* d_bbsize */
232
233	basetable->gpt_first = 0;
234	basetable->gpt_last = msize - 1;
235	basetable->gpt_isleaf = 1;
236
237	baseentry = g_part_new_entry(basetable, RAW_PART + 1,
238	    basetable->gpt_first, basetable->gpt_last);
239	baseentry->gpe_internal = 1;
240	entry = (struct g_part_bsd_entry *)baseentry;
241	entry->part.p_size = basetable->gpt_last + 1;
242	entry->part.p_offset = table->offset;
243
244	return (0);
245}
246
247static int
248g_part_bsd_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
249{
250	struct g_part_bsd_table *table;
251
252	table = (struct g_part_bsd_table *)basetable;
253	if (table->bbarea != NULL)
254		g_free(table->bbarea);
255	table->bbarea = NULL;
256
257	/* Wipe the second sector to clear the partitioning. */
258	basetable->gpt_smhead |= 2;
259	return (0);
260}
261
262static void
263g_part_bsd_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
264    struct sbuf *sb, const char *indent)
265{
266	struct g_part_bsd_entry *entry;
267
268	entry = (struct g_part_bsd_entry *)baseentry;
269	if (indent == NULL) {
270		/* conftxt: libdisk compatibility */
271		sbuf_printf(sb, " xs BSD xt %u", entry->part.p_fstype);
272	} else if (entry != NULL) {
273		/* confxml: partition entry information */
274		sbuf_printf(sb, "%s<rawtype>%u</rawtype>\n", indent,
275		    entry->part.p_fstype);
276	} else {
277		/* confxml: scheme information */
278	}
279}
280
281static int
282g_part_bsd_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
283{
284	struct g_part_bsd_entry *entry;
285
286	/* Allow dumping to a swap partition or an unused partition. */
287	entry = (struct g_part_bsd_entry *)baseentry;
288	return ((entry->part.p_fstype == FS_UNUSED ||
289	    entry->part.p_fstype == FS_SWAP) ? 1 : 0);
290}
291
292static int
293g_part_bsd_modify(struct g_part_table *basetable,
294    struct g_part_entry *baseentry, struct g_part_parms *gpp)
295{
296	struct g_part_bsd_entry *entry;
297
298	if (gpp->gpp_parms & G_PART_PARM_LABEL)
299		return (EINVAL);
300
301	entry = (struct g_part_bsd_entry *)baseentry;
302	if (gpp->gpp_parms & G_PART_PARM_TYPE)
303		return (bsd_parse_type(gpp->gpp_type, &entry->part.p_fstype));
304	return (0);
305}
306
307static int
308g_part_bsd_resize(struct g_part_table *basetable,
309    struct g_part_entry *baseentry, struct g_part_parms *gpp)
310{
311	struct g_part_bsd_entry *entry;
312
313	entry = (struct g_part_bsd_entry *)baseentry;
314	baseentry->gpe_end = baseentry->gpe_start + gpp->gpp_size - 1;
315	entry->part.p_size = gpp->gpp_size;
316
317	return (0);
318}
319
320static const char *
321g_part_bsd_name(struct g_part_table *table, struct g_part_entry *baseentry,
322    char *buf, size_t bufsz)
323{
324
325	snprintf(buf, bufsz, "%c", 'a' + baseentry->gpe_index - 1);
326	return (buf);
327}
328
329static int
330g_part_bsd_probe(struct g_part_table *table, struct g_consumer *cp)
331{
332	struct g_provider *pp;
333	u_char *buf;
334	uint32_t magic1, magic2;
335	int error;
336
337	pp = cp->provider;
338
339	/* Sanity-check the provider. */
340	if (pp->sectorsize < sizeof(struct disklabel) ||
341	    pp->mediasize < BBSIZE)
342		return (ENOSPC);
343	if (BBSIZE % pp->sectorsize)
344		return (ENOTBLK);
345
346	/* Check that there's a disklabel. */
347	buf = g_read_data(cp, pp->sectorsize, pp->sectorsize, &error);
348	if (buf == NULL)
349		return (error);
350	magic1 = le32dec(buf + 0);
351	magic2 = le32dec(buf + 132);
352	g_free(buf);
353	return ((magic1 == DISKMAGIC && magic2 == DISKMAGIC)
354	    ? G_PART_PROBE_PRI_HIGH : ENXIO);
355}
356
357static int
358g_part_bsd_read(struct g_part_table *basetable, struct g_consumer *cp)
359{
360	struct g_provider *pp;
361	struct g_part_bsd_table *table;
362	struct g_part_entry *baseentry;
363	struct g_part_bsd_entry *entry;
364	struct partition part;
365	u_char *buf, *p;
366	off_t chs, msize;
367	u_int sectors, heads;
368	int error, index;
369
370	pp = cp->provider;
371	table = (struct g_part_bsd_table *)basetable;
372	msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
373
374	table->bbarea = g_read_data(cp, 0, BBSIZE, &error);
375	if (table->bbarea == NULL)
376		return (error);
377
378	buf = table->bbarea + pp->sectorsize;
379
380	if (le32dec(buf + 40) != pp->sectorsize)
381		goto invalid_label;
382	sectors = le32dec(buf + 44);
383	if (sectors < 1 || sectors > 255)
384		goto invalid_label;
385	if (sectors != basetable->gpt_sectors && !basetable->gpt_fixgeom) {
386		g_part_geometry_heads(msize, sectors, &chs, &heads);
387		if (chs != 0) {
388			basetable->gpt_sectors = sectors;
389			basetable->gpt_heads = heads;
390		}
391	}
392	heads = le32dec(buf + 48);
393	if (heads < 1 || heads > 255)
394		goto invalid_label;
395	if (heads != basetable->gpt_heads && !basetable->gpt_fixgeom)
396		basetable->gpt_heads = heads;
397
398	chs = le32dec(buf + 60);
399	if (chs < 1)
400		goto invalid_label;
401	/* Fix-up a sysinstall bug. */
402	if (chs > msize) {
403		chs = msize;
404		le32enc(buf + 60, msize);
405	}
406
407	basetable->gpt_first = 0;
408	basetable->gpt_last = msize - 1;
409	basetable->gpt_isleaf = 1;
410
411	basetable->gpt_entries = le16dec(buf + 138);
412	if (basetable->gpt_entries < g_part_bsd_scheme.gps_minent ||
413	    basetable->gpt_entries > g_part_bsd_scheme.gps_maxent)
414		goto invalid_label;
415
416	table->offset = le32dec(buf + 148 + RAW_PART * 16 + 4);
417	for (index = basetable->gpt_entries - 1; index >= 0; index--) {
418		p = buf + 148 + index * 16;
419		part.p_size = le32dec(p + 0);
420		part.p_offset = le32dec(p + 4);
421		part.p_fsize = le32dec(p + 8);
422		part.p_fstype = p[12];
423		part.p_frag = p[13];
424		part.p_cpg = le16dec(p + 14);
425		if (part.p_size == 0)
426			continue;
427		if (part.p_offset < table->offset)
428			continue;
429		if (part.p_offset - table->offset > basetable->gpt_last)
430			goto invalid_label;
431		baseentry = g_part_new_entry(basetable, index + 1,
432		    part.p_offset - table->offset,
433		    part.p_offset - table->offset + part.p_size - 1);
434		entry = (struct g_part_bsd_entry *)baseentry;
435		entry->part = part;
436		if (index == RAW_PART)
437			baseentry->gpe_internal = 1;
438	}
439
440	return (0);
441
442 invalid_label:
443	printf("GEOM: %s: invalid disklabel.\n", pp->name);
444	g_free(table->bbarea);
445	table->bbarea = NULL;
446	return (EINVAL);
447}
448
449static const char *
450g_part_bsd_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
451    char *buf, size_t bufsz)
452{
453	struct g_part_bsd_entry *entry;
454	int type;
455
456	entry = (struct g_part_bsd_entry *)baseentry;
457	type = entry->part.p_fstype;
458	if (type == FS_NANDFS)
459		return (g_part_alias_name(G_PART_ALIAS_FREEBSD_NANDFS));
460	if (type == FS_SWAP)
461		return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP));
462	if (type == FS_BSDFFS)
463		return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS));
464	if (type == FS_VINUM)
465		return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM));
466	if (type == FS_ZFS)
467		return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS));
468	snprintf(buf, bufsz, "!%d", type);
469	return (buf);
470}
471
472static int
473g_part_bsd_write(struct g_part_table *basetable, struct g_consumer *cp)
474{
475	struct g_provider *pp;
476	struct g_part_entry *baseentry;
477	struct g_part_bsd_entry *entry;
478	struct g_part_bsd_table *table;
479	uint16_t sum;
480	u_char *label, *p, *pe;
481	int error, index;
482
483	pp = cp->provider;
484	table = (struct g_part_bsd_table *)basetable;
485	baseentry = LIST_FIRST(&basetable->gpt_entry);
486	label = table->bbarea + pp->sectorsize;
487	for (index = 1; index <= basetable->gpt_entries; index++) {
488		p = label + 148 + (index - 1) * 16;
489		entry = (baseentry != NULL && index == baseentry->gpe_index)
490		    ? (struct g_part_bsd_entry *)baseentry : NULL;
491		if (entry != NULL && !baseentry->gpe_deleted) {
492			le32enc(p + 0, entry->part.p_size);
493			le32enc(p + 4, entry->part.p_offset);
494			le32enc(p + 8, entry->part.p_fsize);
495			p[12] = entry->part.p_fstype;
496			p[13] = entry->part.p_frag;
497			le16enc(p + 14, entry->part.p_cpg);
498		} else
499			bzero(p, 16);
500
501		if (entry != NULL)
502			baseentry = LIST_NEXT(baseentry, gpe_entry);
503	}
504
505	/* Calculate checksum. */
506	le16enc(label + 136, 0);
507	pe = label + 148 + basetable->gpt_entries * 16;
508	sum = 0;
509	for (p = label; p < pe; p += 2)
510		sum ^= le16dec(p);
511	le16enc(label + 136, sum);
512
513	error = g_write_data(cp, 0, table->bbarea, BBSIZE);
514	return (error);
515}
516