2 * Copyright (c) 2007-2009 Marcel Moolenaar
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/diskmbr.h>
35 #include <sys/endian.h>
36 #include <sys/kernel.h>
38 #include <sys/limits.h>
40 #include <sys/malloc.h>
41 #include <sys/mutex.h>
42 #include <sys/queue.h>
44 #include <sys/systm.h>
45 #include <sys/sysctl.h>
46 #include <geom/geom.h>
47 #include <geom/part/g_part.h>
49 #include "g_part_if.h"
51 FEATURE(geom_part_ebr,
52 "GEOM partitioning class for extended boot records support");
53 #if defined(GEOM_PART_EBR_COMPAT)
54 FEATURE(geom_part_ebr_compat,
55 "GEOM EBR partitioning class: backward-compatible partition names");
60 struct g_part_ebr_table {
61 struct g_part_table base;
62 #ifndef GEOM_PART_EBR_COMPAT
67 struct g_part_ebr_entry {
68 struct g_part_entry base;
69 struct dos_partition ent;
72 static int g_part_ebr_add(struct g_part_table *, struct g_part_entry *,
73 struct g_part_parms *);
74 static int g_part_ebr_create(struct g_part_table *, struct g_part_parms *);
75 static int g_part_ebr_destroy(struct g_part_table *, struct g_part_parms *);
76 static void g_part_ebr_dumpconf(struct g_part_table *, struct g_part_entry *,
77 struct sbuf *, const char *);
78 static int g_part_ebr_dumpto(struct g_part_table *, struct g_part_entry *);
79 #if defined(GEOM_PART_EBR_COMPAT)
80 static void g_part_ebr_fullname(struct g_part_table *, struct g_part_entry *,
81 struct sbuf *, const char *);
83 static int g_part_ebr_modify(struct g_part_table *, struct g_part_entry *,
84 struct g_part_parms *);
85 static const char *g_part_ebr_name(struct g_part_table *, struct g_part_entry *,
87 static int g_part_ebr_precheck(struct g_part_table *, enum g_part_ctl,
88 struct g_part_parms *);
89 static int g_part_ebr_probe(struct g_part_table *, struct g_consumer *);
90 static int g_part_ebr_read(struct g_part_table *, struct g_consumer *);
91 static int g_part_ebr_setunset(struct g_part_table *, struct g_part_entry *,
92 const char *, unsigned int);
93 static const char *g_part_ebr_type(struct g_part_table *, struct g_part_entry *,
95 static int g_part_ebr_write(struct g_part_table *, struct g_consumer *);
96 static int g_part_ebr_resize(struct g_part_table *, struct g_part_entry *,
97 struct g_part_parms *);
99 static kobj_method_t g_part_ebr_methods[] = {
100 KOBJMETHOD(g_part_add, g_part_ebr_add),
101 KOBJMETHOD(g_part_create, g_part_ebr_create),
102 KOBJMETHOD(g_part_destroy, g_part_ebr_destroy),
103 KOBJMETHOD(g_part_dumpconf, g_part_ebr_dumpconf),
104 KOBJMETHOD(g_part_dumpto, g_part_ebr_dumpto),
105 #if defined(GEOM_PART_EBR_COMPAT)
106 KOBJMETHOD(g_part_fullname, g_part_ebr_fullname),
108 KOBJMETHOD(g_part_modify, g_part_ebr_modify),
109 KOBJMETHOD(g_part_name, g_part_ebr_name),
110 KOBJMETHOD(g_part_precheck, g_part_ebr_precheck),
111 KOBJMETHOD(g_part_probe, g_part_ebr_probe),
112 KOBJMETHOD(g_part_read, g_part_ebr_read),
113 KOBJMETHOD(g_part_resize, g_part_ebr_resize),
114 KOBJMETHOD(g_part_setunset, g_part_ebr_setunset),
115 KOBJMETHOD(g_part_type, g_part_ebr_type),
116 KOBJMETHOD(g_part_write, g_part_ebr_write),
120 static struct g_part_scheme g_part_ebr_scheme = {
123 sizeof(struct g_part_ebr_table),
124 .gps_entrysz = sizeof(struct g_part_ebr_entry),
126 .gps_maxent = INT_MAX,
128 G_PART_SCHEME_DECLARE(g_part_ebr);
130 static struct g_part_ebr_alias {
133 } ebr_alias_match[] = {
134 { DOSPTYP_386BSD, G_PART_ALIAS_FREEBSD },
135 { DOSPTYP_NTFS, G_PART_ALIAS_MS_NTFS },
136 { DOSPTYP_FAT32, G_PART_ALIAS_MS_FAT32 },
137 { DOSPTYP_LINSWP, G_PART_ALIAS_LINUX_SWAP },
138 { DOSPTYP_LINUX, G_PART_ALIAS_LINUX_DATA },
139 { DOSPTYP_LINLVM, G_PART_ALIAS_LINUX_LVM },
140 { DOSPTYP_LINRAID, G_PART_ALIAS_LINUX_RAID },
143 static void ebr_set_chs(struct g_part_table *, uint32_t, u_char *, u_char *,
147 ebr_entry_decode(const char *p, struct dos_partition *ent)
151 ent->dp_ssect = p[2];
155 ent->dp_esect = p[6];
157 ent->dp_start = le32dec(p + 8);
158 ent->dp_size = le32dec(p + 12);
162 ebr_entry_link(struct g_part_table *table, uint32_t start, uint32_t end,
166 buf[0] = 0 /* dp_flag */;
167 ebr_set_chs(table, start, &buf[3] /* dp_scyl */, &buf[1] /* dp_shd */,
168 &buf[2] /* dp_ssect */);
169 buf[4] = 5 /* dp_typ */;
170 ebr_set_chs(table, end, &buf[7] /* dp_ecyl */, &buf[5] /* dp_ehd */,
171 &buf[6] /* dp_esect */);
172 le32enc(buf + 8, start);
173 le32enc(buf + 12, end - start + 1);
177 ebr_parse_type(const char *type, u_char *dp_typ)
184 if (type[0] == '!') {
185 lt = strtol(type + 1, &endp, 0);
186 if (type[1] == '\0' || *endp != '\0' || lt <= 0 || lt >= 256)
188 *dp_typ = (u_char)lt;
191 for (i = 0; i < nitems(ebr_alias_match); i++) {
192 alias = g_part_alias_name(ebr_alias_match[i].alias);
193 if (strcasecmp(type, alias) == 0) {
194 *dp_typ = ebr_alias_match[i].typ;
203 ebr_set_chs(struct g_part_table *table, uint32_t lba, u_char *cylp, u_char *hdp,
206 uint32_t cyl, hd, sec;
208 sec = lba % table->gpt_sectors + 1;
209 lba /= table->gpt_sectors;
210 hd = lba % table->gpt_heads;
211 lba /= table->gpt_heads;
218 *secp = (sec & 0x3f) | ((cyl >> 2) & 0xc0);
222 ebr_align(struct g_part_table *basetable, uint32_t *start, uint32_t *size)
226 sectors = basetable->gpt_sectors;
227 if (*size < 2 * sectors)
229 if (*start % sectors) {
230 *size += (*start % sectors) - sectors;
231 *start -= (*start % sectors) - sectors;
234 *size -= (*size % sectors);
235 if (*size < 2 * sectors)
242 g_part_ebr_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
243 struct g_part_parms *gpp)
245 struct g_provider *pp;
246 struct g_part_ebr_entry *entry;
247 uint32_t start, size;
249 if (gpp->gpp_parms & G_PART_PARM_LABEL)
252 pp = LIST_FIRST(&basetable->gpt_gp->consumer)->provider;
253 entry = (struct g_part_ebr_entry *)baseentry;
254 start = gpp->gpp_start;
255 size = gpp->gpp_size;
256 if (ebr_align(basetable, &start, &size) != 0)
258 if (baseentry->gpe_deleted)
259 bzero(&entry->ent, sizeof(entry->ent));
261 KASSERT(baseentry->gpe_start <= start, ("%s", __func__));
262 KASSERT(baseentry->gpe_end >= start + size - 1, ("%s", __func__));
263 baseentry->gpe_index = (start / basetable->gpt_sectors) + 1;
264 baseentry->gpe_offset =
265 (off_t)(start + basetable->gpt_sectors) * pp->sectorsize;
266 baseentry->gpe_start = start;
267 baseentry->gpe_end = start + size - 1;
268 entry->ent.dp_start = basetable->gpt_sectors;
269 entry->ent.dp_size = size - basetable->gpt_sectors;
270 ebr_set_chs(basetable, entry->ent.dp_start, &entry->ent.dp_scyl,
271 &entry->ent.dp_shd, &entry->ent.dp_ssect);
272 ebr_set_chs(basetable, baseentry->gpe_end, &entry->ent.dp_ecyl,
273 &entry->ent.dp_ehd, &entry->ent.dp_esect);
274 return (ebr_parse_type(gpp->gpp_type, &entry->ent.dp_typ));
278 g_part_ebr_create(struct g_part_table *basetable, struct g_part_parms *gpp)
281 struct g_consumer *cp;
282 struct g_provider *pp;
286 pp = gpp->gpp_provider;
288 if (pp->sectorsize < EBRSIZE)
290 if (pp->sectorsize > 4096)
293 /* Check that we have a parent and that it's a MBR. */
294 if (basetable->gpt_depth == 0)
296 cp = LIST_FIRST(&pp->consumers);
297 error = g_getattr("PART::scheme", cp, &type);
300 if (strcmp(type, "MBR") != 0)
302 error = g_getattr("PART::type", cp, &type);
305 if (strcmp(type, "ebr") != 0)
308 msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
309 basetable->gpt_first = 0;
310 basetable->gpt_last = msize - 1;
311 basetable->gpt_entries = msize / basetable->gpt_sectors;
316 g_part_ebr_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
319 /* Wipe the first sector to clear the partitioning. */
320 basetable->gpt_smhead |= 1;
325 g_part_ebr_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
326 struct sbuf *sb, const char *indent)
328 struct g_part_ebr_entry *entry;
330 entry = (struct g_part_ebr_entry *)baseentry;
331 if (indent == NULL) {
332 /* conftxt: libdisk compatibility */
333 sbuf_printf(sb, " xs MBREXT xt %u", entry->ent.dp_typ);
334 } else if (entry != NULL) {
335 /* confxml: partition entry information */
336 sbuf_printf(sb, "%s<rawtype>%u</rawtype>\n", indent,
338 if (entry->ent.dp_flag & 0x80)
339 sbuf_printf(sb, "%s<attrib>active</attrib>\n", indent);
341 /* confxml: scheme information */
346 g_part_ebr_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
348 struct g_part_ebr_entry *entry;
350 /* Allow dumping to a FreeBSD partition or Linux swap partition only. */
351 entry = (struct g_part_ebr_entry *)baseentry;
352 return ((entry->ent.dp_typ == DOSPTYP_386BSD ||
353 entry->ent.dp_typ == DOSPTYP_LINSWP) ? 1 : 0);
356 #if defined(GEOM_PART_EBR_COMPAT)
358 g_part_ebr_fullname(struct g_part_table *table, struct g_part_entry *entry,
359 struct sbuf *sb, const char *pfx)
361 struct g_part_entry *iter;
365 LIST_FOREACH(iter, &table->gpt_entry, gpe_entry) {
370 sbuf_printf(sb, "%.*s%u", (int)strlen(pfx) - 1, pfx, idx);
375 g_part_ebr_modify(struct g_part_table *basetable,
376 struct g_part_entry *baseentry, struct g_part_parms *gpp)
378 struct g_part_ebr_entry *entry;
380 if (gpp->gpp_parms & G_PART_PARM_LABEL)
383 entry = (struct g_part_ebr_entry *)baseentry;
384 if (gpp->gpp_parms & G_PART_PARM_TYPE)
385 return (ebr_parse_type(gpp->gpp_type, &entry->ent.dp_typ));
390 g_part_ebr_resize(struct g_part_table *basetable,
391 struct g_part_entry *baseentry, struct g_part_parms *gpp)
393 struct g_provider *pp;
395 if (baseentry != NULL)
397 pp = LIST_FIRST(&basetable->gpt_gp->consumer)->provider;
398 basetable->gpt_last = MIN(pp->mediasize / pp->sectorsize,
404 g_part_ebr_name(struct g_part_table *table, struct g_part_entry *entry,
405 char *buf, size_t bufsz)
408 snprintf(buf, bufsz, "+%08u", entry->gpe_index);
413 g_part_ebr_precheck(struct g_part_table *table, enum g_part_ctl req,
414 struct g_part_parms *gpp)
416 #if defined(GEOM_PART_EBR_COMPAT)
417 if (req == G_PART_CTL_DESTROY)
422 * The index is a function of the start of the partition.
423 * This is not something the user can override, nor is it
424 * something the common code will do right. We can set the
425 * index now so that we get what we need.
427 if (req == G_PART_CTL_ADD)
428 gpp->gpp_index = (gpp->gpp_start / table->gpt_sectors) + 1;
434 g_part_ebr_probe(struct g_part_table *table, struct g_consumer *cp)
437 struct g_provider *pp;
439 int error, index, res;
444 /* Sanity-check the provider. */
445 if (pp->sectorsize < EBRSIZE || pp->mediasize < pp->sectorsize)
447 if (pp->sectorsize > 4096)
450 /* Check that we have a parent and that it's a MBR. */
451 if (table->gpt_depth == 0)
453 error = g_getattr("PART::scheme", cp, &type);
456 if (strcmp(type, "MBR") != 0)
458 /* Check that partition has type DOSPTYP_EBR. */
459 error = g_getattr("PART::type", cp, &type);
462 if (strcmp(type, "ebr") != 0)
465 /* Check that there's a EBR. */
466 buf = g_read_data(cp, 0L, pp->sectorsize, &error);
470 /* We goto out on mismatch. */
473 magic = le16dec(buf + DOSMAGICOFFSET);
474 if (magic != DOSMAGIC)
477 for (index = 0; index < 2; index++) {
478 p = buf + DOSPARTOFF + index * DOSPARTSIZE;
479 if (p[0] != 0 && p[0] != 0x80)
482 res = G_PART_PROBE_PRI_NORM;
490 g_part_ebr_read(struct g_part_table *basetable, struct g_consumer *cp)
492 struct dos_partition ent[2];
493 struct g_provider *pp;
494 struct g_part_entry *baseentry;
495 struct g_part_ebr_table *table;
496 struct g_part_ebr_entry *entry;
503 table = (struct g_part_ebr_table *)basetable;
504 msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
508 ofs = (off_t)lba * pp->sectorsize;
509 buf = g_read_data(cp, ofs, pp->sectorsize, &error);
513 ebr_entry_decode(buf + DOSPARTOFF + 0 * DOSPARTSIZE, ent + 0);
514 ebr_entry_decode(buf + DOSPARTOFF + 1 * DOSPARTSIZE, ent + 1);
516 /* The 3rd & 4th entries should be zeroes. */
517 if (le64dec(buf + DOSPARTOFF + 2 * DOSPARTSIZE) +
518 le64dec(buf + DOSPARTOFF + 3 * DOSPARTSIZE) != 0) {
519 basetable->gpt_corrupt = 1;
520 printf("GEOM: %s: invalid entries in the EBR ignored.\n",
523 #ifndef GEOM_PART_EBR_COMPAT
524 /* Save the first EBR, it can contain a boot code */
526 bcopy(buf, table->ebr, sizeof(table->ebr));
530 if (ent[0].dp_typ == 0)
533 if (ent[0].dp_typ == 5 && ent[1].dp_typ == 0) {
534 lba = ent[0].dp_start;
538 index = (lba / basetable->gpt_sectors) + 1;
539 baseentry = (struct g_part_entry *)g_part_new_entry(basetable,
540 index, lba, lba + ent[0].dp_start + ent[0].dp_size - 1);
541 baseentry->gpe_offset = (off_t)(lba + ent[0].dp_start) *
543 entry = (struct g_part_ebr_entry *)baseentry;
546 if (ent[1].dp_typ == 0)
549 lba = ent[1].dp_start;
552 basetable->gpt_entries = msize / basetable->gpt_sectors;
553 basetable->gpt_first = 0;
554 basetable->gpt_last = msize - 1;
559 g_part_ebr_setunset(struct g_part_table *table, struct g_part_entry *baseentry,
560 const char *attrib, unsigned int set)
562 struct g_part_entry *iter;
563 struct g_part_ebr_entry *entry;
566 if (baseentry == NULL)
568 if (strcasecmp(attrib, "active") != 0)
571 /* Only one entry can have the active attribute. */
572 LIST_FOREACH(iter, &table->gpt_entry, gpe_entry) {
573 if (iter->gpe_deleted)
576 entry = (struct g_part_ebr_entry *)iter;
577 if (iter == baseentry) {
578 if (set && (entry->ent.dp_flag & 0x80) == 0) {
579 entry->ent.dp_flag |= 0x80;
581 } else if (!set && (entry->ent.dp_flag & 0x80)) {
582 entry->ent.dp_flag &= ~0x80;
586 if (set && (entry->ent.dp_flag & 0x80)) {
587 entry->ent.dp_flag &= ~0x80;
591 if (changed && !iter->gpe_created)
592 iter->gpe_modified = 1;
598 g_part_ebr_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
599 char *buf, size_t bufsz)
601 struct g_part_ebr_entry *entry;
604 entry = (struct g_part_ebr_entry *)baseentry;
605 for (i = 0; i < nitems(ebr_alias_match); i++) {
606 if (ebr_alias_match[i].typ == entry->ent.dp_typ)
607 return (g_part_alias_name(ebr_alias_match[i].alias));
609 snprintf(buf, bufsz, "!%d", entry->ent.dp_typ);
614 g_part_ebr_write(struct g_part_table *basetable, struct g_consumer *cp)
616 #ifndef GEOM_PART_EBR_COMPAT
617 struct g_part_ebr_table *table;
619 struct g_provider *pp;
620 struct g_part_entry *baseentry, *next;
621 struct g_part_ebr_entry *entry;
627 buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO);
628 #ifndef GEOM_PART_EBR_COMPAT
629 table = (struct g_part_ebr_table *)basetable;
630 bcopy(table->ebr, buf, DOSPARTOFF);
632 le16enc(buf + DOSMAGICOFFSET, DOSMAGIC);
634 baseentry = LIST_FIRST(&basetable->gpt_entry);
635 while (baseentry != NULL && baseentry->gpe_deleted)
636 baseentry = LIST_NEXT(baseentry, gpe_entry);
638 /* Wipe-out the first EBR when there are no slices. */
639 if (baseentry == NULL) {
640 error = g_write_data(cp, 0, buf, pp->sectorsize);
645 * If the first partition is not in LBA 0, we need to
646 * put a "link" EBR in LBA 0.
648 if (baseentry->gpe_start != 0) {
649 ebr_entry_link(basetable, (uint32_t)baseentry->gpe_start,
650 (uint32_t)baseentry->gpe_end, buf + DOSPARTOFF);
651 error = g_write_data(cp, 0, buf, pp->sectorsize);
657 entry = (struct g_part_ebr_entry *)baseentry;
659 p = buf + DOSPARTOFF;
660 p[0] = entry->ent.dp_flag;
661 p[1] = entry->ent.dp_shd;
662 p[2] = entry->ent.dp_ssect;
663 p[3] = entry->ent.dp_scyl;
664 p[4] = entry->ent.dp_typ;
665 p[5] = entry->ent.dp_ehd;
666 p[6] = entry->ent.dp_esect;
667 p[7] = entry->ent.dp_ecyl;
668 le32enc(p + 8, entry->ent.dp_start);
669 le32enc(p + 12, entry->ent.dp_size);
671 next = LIST_NEXT(baseentry, gpe_entry);
672 while (next != NULL && next->gpe_deleted)
673 next = LIST_NEXT(next, gpe_entry);
677 ebr_entry_link(basetable, (uint32_t)next->gpe_start,
678 (uint32_t)next->gpe_end, p);
680 bzero(p, DOSPARTSIZE);
682 error = g_write_data(cp, baseentry->gpe_start * pp->sectorsize,
683 buf, pp->sectorsize);
684 #ifndef GEOM_PART_EBR_COMPAT
685 if (baseentry->gpe_start == 0)
686 bzero(buf, DOSPARTOFF);
689 } while (!error && baseentry != NULL);