g_part_mbr.c revision 256281
1/*-
2 * Copyright (c) 2007, 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
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/10/sys/geom/part/g_part_mbr.c 251588 2013-06-09 23:34:26Z marcel $");
29
30#include <sys/param.h>
31#include <sys/bio.h>
32#include <sys/diskmbr.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
49FEATURE(geom_part_mbr, "GEOM partitioning class for MBR support");
50
51#define	MBRSIZE		512
52
53struct g_part_mbr_table {
54	struct g_part_table	base;
55	u_char		mbr[MBRSIZE];
56};
57
58struct g_part_mbr_entry {
59	struct g_part_entry	base;
60	struct dos_partition ent;
61};
62
63static int g_part_mbr_add(struct g_part_table *, struct g_part_entry *,
64    struct g_part_parms *);
65static int g_part_mbr_bootcode(struct g_part_table *, struct g_part_parms *);
66static int g_part_mbr_create(struct g_part_table *, struct g_part_parms *);
67static int g_part_mbr_destroy(struct g_part_table *, struct g_part_parms *);
68static void g_part_mbr_dumpconf(struct g_part_table *, struct g_part_entry *,
69    struct sbuf *, const char *);
70static int g_part_mbr_dumpto(struct g_part_table *, struct g_part_entry *);
71static int g_part_mbr_modify(struct g_part_table *, struct g_part_entry *,
72    struct g_part_parms *);
73static const char *g_part_mbr_name(struct g_part_table *, struct g_part_entry *,
74    char *, size_t);
75static int g_part_mbr_probe(struct g_part_table *, struct g_consumer *);
76static int g_part_mbr_read(struct g_part_table *, struct g_consumer *);
77static int g_part_mbr_setunset(struct g_part_table *, struct g_part_entry *,
78    const char *, unsigned int);
79static const char *g_part_mbr_type(struct g_part_table *, struct g_part_entry *,
80    char *, size_t);
81static int g_part_mbr_write(struct g_part_table *, struct g_consumer *);
82static int g_part_mbr_resize(struct g_part_table *, struct g_part_entry *,
83    struct g_part_parms *);
84
85static kobj_method_t g_part_mbr_methods[] = {
86	KOBJMETHOD(g_part_add,		g_part_mbr_add),
87	KOBJMETHOD(g_part_bootcode,	g_part_mbr_bootcode),
88	KOBJMETHOD(g_part_create,	g_part_mbr_create),
89	KOBJMETHOD(g_part_destroy,	g_part_mbr_destroy),
90	KOBJMETHOD(g_part_dumpconf,	g_part_mbr_dumpconf),
91	KOBJMETHOD(g_part_dumpto,	g_part_mbr_dumpto),
92	KOBJMETHOD(g_part_modify,	g_part_mbr_modify),
93	KOBJMETHOD(g_part_resize,	g_part_mbr_resize),
94	KOBJMETHOD(g_part_name,		g_part_mbr_name),
95	KOBJMETHOD(g_part_probe,	g_part_mbr_probe),
96	KOBJMETHOD(g_part_read,		g_part_mbr_read),
97	KOBJMETHOD(g_part_setunset,	g_part_mbr_setunset),
98	KOBJMETHOD(g_part_type,		g_part_mbr_type),
99	KOBJMETHOD(g_part_write,	g_part_mbr_write),
100	{ 0, 0 }
101};
102
103static struct g_part_scheme g_part_mbr_scheme = {
104	"MBR",
105	g_part_mbr_methods,
106	sizeof(struct g_part_mbr_table),
107	.gps_entrysz = sizeof(struct g_part_mbr_entry),
108	.gps_minent = NDOSPART,
109	.gps_maxent = NDOSPART,
110	.gps_bootcodesz = MBRSIZE,
111};
112G_PART_SCHEME_DECLARE(g_part_mbr);
113
114static struct g_part_mbr_alias {
115	u_char		typ;
116	int		alias;
117} mbr_alias_match[] = {
118	{ DOSPTYP_386BSD,	G_PART_ALIAS_FREEBSD },
119	{ DOSPTYP_EXT,		G_PART_ALIAS_EBR },
120	{ DOSPTYP_NTFS,		G_PART_ALIAS_MS_NTFS },
121	{ DOSPTYP_FAT16,	G_PART_ALIAS_MS_FAT16 },
122	{ DOSPTYP_FAT32,	G_PART_ALIAS_MS_FAT32 },
123	{ DOSPTYP_EXTLBA,	G_PART_ALIAS_EBR },
124	{ DOSPTYP_LDM,		G_PART_ALIAS_MS_LDM_DATA },
125	{ DOSPTYP_LINSWP,	G_PART_ALIAS_LINUX_SWAP },
126	{ DOSPTYP_LINUX,	G_PART_ALIAS_LINUX_DATA },
127	{ DOSPTYP_LINLVM,	G_PART_ALIAS_LINUX_LVM },
128	{ DOSPTYP_LINRAID,	G_PART_ALIAS_LINUX_RAID },
129	{ DOSPTYP_PPCBOOT,	G_PART_ALIAS_FREEBSD_BOOT },
130	{ DOSPTYP_VMFS,		G_PART_ALIAS_VMFS },
131	{ DOSPTYP_VMKDIAG,	G_PART_ALIAS_VMKDIAG },
132};
133
134static int
135mbr_parse_type(const char *type, u_char *dp_typ)
136{
137	const char *alias;
138	char *endp;
139	long lt;
140	int i;
141
142	if (type[0] == '!') {
143		lt = strtol(type + 1, &endp, 0);
144		if (type[1] == '\0' || *endp != '\0' || lt <= 0 || lt >= 256)
145			return (EINVAL);
146		*dp_typ = (u_char)lt;
147		return (0);
148	}
149	for (i = 0;
150	    i < sizeof(mbr_alias_match) / sizeof(mbr_alias_match[0]); i++) {
151		alias = g_part_alias_name(mbr_alias_match[i].alias);
152		if (strcasecmp(type, alias) == 0) {
153			*dp_typ = mbr_alias_match[i].typ;
154			return (0);
155		}
156	}
157	return (EINVAL);
158}
159
160static int
161mbr_probe_bpb(u_char *bpb)
162{
163	uint16_t secsz;
164	uint8_t clstsz;
165
166#define PO2(x)	((x & (x - 1)) == 0)
167	secsz = le16dec(bpb);
168	if (secsz < 512 || secsz > 4096 || !PO2(secsz))
169		return (0);
170	clstsz = bpb[2];
171	if (clstsz < 1 || clstsz > 128 || !PO2(clstsz))
172		return (0);
173#undef PO2
174
175	return (1);
176}
177
178static void
179mbr_set_chs(struct g_part_table *table, uint32_t lba, u_char *cylp, u_char *hdp,
180    u_char *secp)
181{
182	uint32_t cyl, hd, sec;
183
184	sec = lba % table->gpt_sectors + 1;
185	lba /= table->gpt_sectors;
186	hd = lba % table->gpt_heads;
187	lba /= table->gpt_heads;
188	cyl = lba;
189	if (cyl > 1023)
190		sec = hd = cyl = ~0;
191
192	*cylp = cyl & 0xff;
193	*hdp = hd & 0xff;
194	*secp = (sec & 0x3f) | ((cyl >> 2) & 0xc0);
195}
196
197static int
198g_part_mbr_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
199    struct g_part_parms *gpp)
200{
201	struct g_part_mbr_entry *entry;
202	struct g_part_mbr_table *table;
203	uint32_t start, size, sectors;
204
205	if (gpp->gpp_parms & G_PART_PARM_LABEL)
206		return (EINVAL);
207
208	sectors = basetable->gpt_sectors;
209
210	entry = (struct g_part_mbr_entry *)baseentry;
211	table = (struct g_part_mbr_table *)basetable;
212
213	start = gpp->gpp_start;
214	size = gpp->gpp_size;
215	if (size < sectors)
216		return (EINVAL);
217	if (start % sectors) {
218		size = size - sectors + (start % sectors);
219		start = start - (start % sectors) + sectors;
220	}
221	if (size % sectors)
222		size = size - (size % sectors);
223	if (size < sectors)
224		return (EINVAL);
225
226	if (baseentry->gpe_deleted)
227		bzero(&entry->ent, sizeof(entry->ent));
228
229	KASSERT(baseentry->gpe_start <= start, ("%s", __func__));
230	KASSERT(baseentry->gpe_end >= start + size - 1, ("%s", __func__));
231	baseentry->gpe_start = start;
232	baseentry->gpe_end = start + size - 1;
233	entry->ent.dp_start = start;
234	entry->ent.dp_size = size;
235	mbr_set_chs(basetable, baseentry->gpe_start, &entry->ent.dp_scyl,
236	    &entry->ent.dp_shd, &entry->ent.dp_ssect);
237	mbr_set_chs(basetable, baseentry->gpe_end, &entry->ent.dp_ecyl,
238	    &entry->ent.dp_ehd, &entry->ent.dp_esect);
239	return (mbr_parse_type(gpp->gpp_type, &entry->ent.dp_typ));
240}
241
242static int
243g_part_mbr_bootcode(struct g_part_table *basetable, struct g_part_parms *gpp)
244{
245	struct g_part_mbr_table *table;
246	uint32_t dsn;
247
248	if (gpp->gpp_codesize != MBRSIZE)
249		return (ENODEV);
250
251	table = (struct g_part_mbr_table *)basetable;
252	dsn = *(uint32_t *)(table->mbr + DOSDSNOFF);
253	bcopy(gpp->gpp_codeptr, table->mbr, DOSPARTOFF);
254	if (dsn != 0)
255		*(uint32_t *)(table->mbr + DOSDSNOFF) = dsn;
256	return (0);
257}
258
259static int
260g_part_mbr_create(struct g_part_table *basetable, struct g_part_parms *gpp)
261{
262	struct g_provider *pp;
263	struct g_part_mbr_table *table;
264
265	pp = gpp->gpp_provider;
266	if (pp->sectorsize < MBRSIZE)
267		return (ENOSPC);
268
269	basetable->gpt_first = basetable->gpt_sectors;
270	basetable->gpt_last = MIN(pp->mediasize / pp->sectorsize,
271	    UINT32_MAX) - 1;
272
273	table = (struct g_part_mbr_table *)basetable;
274	le16enc(table->mbr + DOSMAGICOFFSET, DOSMAGIC);
275	return (0);
276}
277
278static int
279g_part_mbr_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
280{
281
282	/* Wipe the first sector to clear the partitioning. */
283	basetable->gpt_smhead |= 1;
284	return (0);
285}
286
287static void
288g_part_mbr_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
289    struct sbuf *sb, const char *indent)
290{
291	struct g_part_mbr_entry *entry;
292
293	entry = (struct g_part_mbr_entry *)baseentry;
294	if (indent == NULL) {
295		/* conftxt: libdisk compatibility */
296		sbuf_printf(sb, " xs MBR xt %u", entry->ent.dp_typ);
297	} else if (entry != NULL) {
298		/* confxml: partition entry information */
299		sbuf_printf(sb, "%s<rawtype>%u</rawtype>\n", indent,
300		    entry->ent.dp_typ);
301		if (entry->ent.dp_flag & 0x80)
302			sbuf_printf(sb, "%s<attrib>active</attrib>\n", indent);
303	} else {
304		/* confxml: scheme information */
305	}
306}
307
308static int
309g_part_mbr_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
310{
311	struct g_part_mbr_entry *entry;
312
313	/* Allow dumping to a FreeBSD partition or Linux swap partition only. */
314	entry = (struct g_part_mbr_entry *)baseentry;
315	return ((entry->ent.dp_typ == DOSPTYP_386BSD ||
316	    entry->ent.dp_typ == DOSPTYP_LINSWP) ? 1 : 0);
317}
318
319static int
320g_part_mbr_modify(struct g_part_table *basetable,
321    struct g_part_entry *baseentry, struct g_part_parms *gpp)
322{
323	struct g_part_mbr_entry *entry;
324
325	if (gpp->gpp_parms & G_PART_PARM_LABEL)
326		return (EINVAL);
327
328	entry = (struct g_part_mbr_entry *)baseentry;
329	if (gpp->gpp_parms & G_PART_PARM_TYPE)
330		return (mbr_parse_type(gpp->gpp_type, &entry->ent.dp_typ));
331	return (0);
332}
333
334static int
335g_part_mbr_resize(struct g_part_table *basetable,
336    struct g_part_entry *baseentry, struct g_part_parms *gpp)
337{
338	struct g_part_mbr_entry *entry;
339	uint32_t size, sectors;
340
341	sectors = basetable->gpt_sectors;
342	size = gpp->gpp_size;
343
344	if (size < sectors)
345		return (EINVAL);
346	if (size % sectors)
347		size = size - (size % sectors);
348	if (size < sectors)
349		return (EINVAL);
350
351	entry = (struct g_part_mbr_entry *)baseentry;
352	baseentry->gpe_end = baseentry->gpe_start + size - 1;
353	entry->ent.dp_size = size;
354	mbr_set_chs(basetable, baseentry->gpe_end, &entry->ent.dp_ecyl,
355	    &entry->ent.dp_ehd, &entry->ent.dp_esect);
356	return (0);
357}
358
359static const char *
360g_part_mbr_name(struct g_part_table *table, struct g_part_entry *baseentry,
361    char *buf, size_t bufsz)
362{
363
364	snprintf(buf, bufsz, "s%d", baseentry->gpe_index);
365	return (buf);
366}
367
368static int
369g_part_mbr_probe(struct g_part_table *table, struct g_consumer *cp)
370{
371	char psn[8];
372	struct g_provider *pp;
373	u_char *buf, *p;
374	int error, index, res, sum;
375	uint16_t magic;
376
377	pp = cp->provider;
378
379	/* Sanity-check the provider. */
380	if (pp->sectorsize < MBRSIZE || pp->mediasize < pp->sectorsize)
381		return (ENOSPC);
382	if (pp->sectorsize > 4096)
383		return (ENXIO);
384
385	/* We don't nest under an MBR (see EBR instead). */
386	error = g_getattr("PART::scheme", cp, &psn);
387	if (error == 0 && strcmp(psn, g_part_mbr_scheme.name) == 0)
388		return (ELOOP);
389
390	/* Check that there's a MBR. */
391	buf = g_read_data(cp, 0L, pp->sectorsize, &error);
392	if (buf == NULL)
393		return (error);
394
395	/* We goto out on mismatch. */
396	res = ENXIO;
397
398	magic = le16dec(buf + DOSMAGICOFFSET);
399	if (magic != DOSMAGIC)
400		goto out;
401
402	for (index = 0; index < NDOSPART; index++) {
403		p = buf + DOSPARTOFF + index * DOSPARTSIZE;
404		if (p[0] != 0 && p[0] != 0x80)
405			goto out;
406	}
407
408	/*
409	 * If the partition table does not consist of all zeroes,
410	 * assume we have a MBR. If it's all zeroes, we could have
411	 * a boot sector. For example, a boot sector that doesn't
412	 * have boot code -- common on non-i386 hardware. In that
413	 * case we check if we have a possible BPB. If so, then we
414	 * assume we have a boot sector instead.
415	 */
416	sum = 0;
417	for (index = 0; index < NDOSPART * DOSPARTSIZE; index++)
418		sum += buf[DOSPARTOFF + index];
419	if (sum != 0 || !mbr_probe_bpb(buf + 0x0b))
420		res = G_PART_PROBE_PRI_NORM;
421
422 out:
423	g_free(buf);
424	return (res);
425}
426
427static int
428g_part_mbr_read(struct g_part_table *basetable, struct g_consumer *cp)
429{
430	struct dos_partition ent;
431	struct g_provider *pp;
432	struct g_part_mbr_table *table;
433	struct g_part_mbr_entry *entry;
434	u_char *buf, *p;
435	off_t chs, msize, first;
436	u_int sectors, heads;
437	int error, index;
438
439	pp = cp->provider;
440	table = (struct g_part_mbr_table *)basetable;
441	first = basetable->gpt_sectors;
442	msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
443
444	buf = g_read_data(cp, 0L, pp->sectorsize, &error);
445	if (buf == NULL)
446		return (error);
447
448	bcopy(buf, table->mbr, sizeof(table->mbr));
449	for (index = NDOSPART - 1; index >= 0; index--) {
450		p = buf + DOSPARTOFF + index * DOSPARTSIZE;
451		ent.dp_flag = p[0];
452		ent.dp_shd = p[1];
453		ent.dp_ssect = p[2];
454		ent.dp_scyl = p[3];
455		ent.dp_typ = p[4];
456		ent.dp_ehd = p[5];
457		ent.dp_esect = p[6];
458		ent.dp_ecyl = p[7];
459		ent.dp_start = le32dec(p + 8);
460		ent.dp_size = le32dec(p + 12);
461		if (ent.dp_typ == 0 || ent.dp_typ == DOSPTYP_PMBR)
462			continue;
463		if (ent.dp_start == 0 || ent.dp_size == 0)
464			continue;
465		sectors = ent.dp_esect & 0x3f;
466		if (sectors > basetable->gpt_sectors &&
467		    !basetable->gpt_fixgeom) {
468			g_part_geometry_heads(msize, sectors, &chs, &heads);
469			if (chs != 0) {
470				basetable->gpt_sectors = sectors;
471				basetable->gpt_heads = heads;
472			}
473		}
474		if (ent.dp_start < first)
475			first = ent.dp_start;
476		entry = (struct g_part_mbr_entry *)g_part_new_entry(basetable,
477		    index + 1, ent.dp_start, ent.dp_start + ent.dp_size - 1);
478		entry->ent = ent;
479	}
480
481	basetable->gpt_entries = NDOSPART;
482	basetable->gpt_first = basetable->gpt_sectors;
483	basetable->gpt_last = msize - 1;
484
485	if (first < basetable->gpt_first)
486		basetable->gpt_first = 1;
487
488	g_free(buf);
489	return (0);
490}
491
492static int
493g_part_mbr_setunset(struct g_part_table *table, struct g_part_entry *baseentry,
494    const char *attrib, unsigned int set)
495{
496	struct g_part_entry *iter;
497	struct g_part_mbr_entry *entry;
498	int changed;
499
500	if (baseentry == NULL)
501		return (ENODEV);
502	if (strcasecmp(attrib, "active") != 0)
503		return (EINVAL);
504
505	/* Only one entry can have the active attribute. */
506	LIST_FOREACH(iter, &table->gpt_entry, gpe_entry) {
507		if (iter->gpe_deleted)
508			continue;
509		changed = 0;
510		entry = (struct g_part_mbr_entry *)iter;
511		if (iter == baseentry) {
512			if (set && (entry->ent.dp_flag & 0x80) == 0) {
513				entry->ent.dp_flag |= 0x80;
514				changed = 1;
515			} else if (!set && (entry->ent.dp_flag & 0x80)) {
516				entry->ent.dp_flag &= ~0x80;
517				changed = 1;
518			}
519		} else {
520			if (set && (entry->ent.dp_flag & 0x80)) {
521				entry->ent.dp_flag &= ~0x80;
522				changed = 1;
523			}
524		}
525		if (changed && !iter->gpe_created)
526			iter->gpe_modified = 1;
527	}
528	return (0);
529}
530
531static const char *
532g_part_mbr_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
533    char *buf, size_t bufsz)
534{
535	struct g_part_mbr_entry *entry;
536	int i;
537
538	entry = (struct g_part_mbr_entry *)baseentry;
539	for (i = 0;
540	    i < sizeof(mbr_alias_match) / sizeof(mbr_alias_match[0]); i++) {
541		if (mbr_alias_match[i].typ == entry->ent.dp_typ)
542			return (g_part_alias_name(mbr_alias_match[i].alias));
543	}
544	snprintf(buf, bufsz, "!%d", entry->ent.dp_typ);
545	return (buf);
546}
547
548static int
549g_part_mbr_write(struct g_part_table *basetable, struct g_consumer *cp)
550{
551	struct g_part_entry *baseentry;
552	struct g_part_mbr_entry *entry;
553	struct g_part_mbr_table *table;
554	u_char *p;
555	int error, index;
556
557	table = (struct g_part_mbr_table *)basetable;
558	baseentry = LIST_FIRST(&basetable->gpt_entry);
559	for (index = 1; index <= basetable->gpt_entries; index++) {
560		p = table->mbr + DOSPARTOFF + (index - 1) * DOSPARTSIZE;
561		entry = (baseentry != NULL && index == baseentry->gpe_index)
562		    ? (struct g_part_mbr_entry *)baseentry : NULL;
563		if (entry != NULL && !baseentry->gpe_deleted) {
564			p[0] = entry->ent.dp_flag;
565			p[1] = entry->ent.dp_shd;
566			p[2] = entry->ent.dp_ssect;
567			p[3] = entry->ent.dp_scyl;
568			p[4] = entry->ent.dp_typ;
569			p[5] = entry->ent.dp_ehd;
570			p[6] = entry->ent.dp_esect;
571			p[7] = entry->ent.dp_ecyl;
572			le32enc(p + 8, entry->ent.dp_start);
573			le32enc(p + 12, entry->ent.dp_size);
574		} else
575			bzero(p, DOSPARTSIZE);
576
577		if (entry != NULL)
578			baseentry = LIST_NEXT(baseentry, gpe_entry);
579	}
580
581	error = g_write_data(cp, 0, table->mbr, cp->provider->sectorsize);
582	return (error);
583}
584