sys/geom/part/g_part_gpt.c

   1 /*-
   2  * Copyright (c) 2002, 2005, 2006, 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/diskmbr.h>
  33 #include <sys/endian.h>
  34 #include <sys/gpt.h>
  35 #include <sys/kernel.h>
  36 #include <sys/kobj.h>
  37 #include <sys/limits.h>
  38 #include <sys/lock.h>
  39 #include <sys/malloc.h>
  40 #include <sys/mutex.h>
  41 #include <sys/queue.h>
  42 #include <sys/sbuf.h>
  43 #include <sys/systm.h>
  44 #include <sys/uuid.h>
  45 #include <geom/geom.h>
  46 #include <geom/part/g_part.h>
  47
  48 #include "g_part_if.h"
  49
  50 CTASSERT(offsetof(struct gpt_hdr, padding) == 92);
  51 CTASSERT(sizeof(struct gpt_ent) == 128);
  52
  53 #define EQUUID(a,b)     (memcmp(a, b, sizeof(struct uuid)) == 0)
  54
  55 #define MBRSIZE         512
  56
  57 enum gpt_elt {
  58         GPT_ELT_PRIHDR,
  59         GPT_ELT_PRITBL,
  60         GPT_ELT_SECHDR,
  61         GPT_ELT_SECTBL,
  62         GPT_ELT_COUNT
  63 };
  64
  65 enum gpt_state {
  66         GPT_STATE_UNKNOWN,      /* Not determined. */
  67         GPT_STATE_MISSING,      /* No signature found. */
  68         GPT_STATE_CORRUPT,      /* Checksum mismatch. */
  69         GPT_STATE_INVALID,      /* Nonconformant/invalid. */
  70         GPT_STATE_OK            /* Perfectly fine. */
  71 };
  72
  73 struct g_part_gpt_table {
  74         struct g_part_table     base;
  75         u_char                  mbr[MBRSIZE];
  76         struct gpt_hdr          hdr;
  77         quad_t                  lba[GPT_ELT_COUNT];
  78         enum gpt_state          state[GPT_ELT_COUNT];
  79 };
  80
  81 struct g_part_gpt_entry {
  82         struct g_part_entry     base;
  83         struct gpt_ent          ent;
  84 };
  85
  86 static void g_gpt_printf_utf16(struct sbuf *, uint16_t *, size_t);
  87 static void g_gpt_utf8_to_utf16(const uint8_t *, uint16_t *, size_t);
  88
  89 static int g_part_gpt_add(struct g_part_table *, struct g_part_entry *,
  90     struct g_part_parms *);
  91 static int g_part_gpt_bootcode(struct g_part_table *, struct g_part_parms *);
  92 static int g_part_gpt_create(struct g_part_table *, struct g_part_parms *);
  93 static int g_part_gpt_destroy(struct g_part_table *, struct g_part_parms *);
  94 static int g_part_gpt_dumpconf(struct g_part_table *, struct g_part_entry *,
  95     struct sbuf *, const char *);
  96 static int g_part_gpt_dumpto(struct g_part_table *, struct g_part_entry *);
  97 static int g_part_gpt_modify(struct g_part_table *, struct g_part_entry *,
  98     struct g_part_parms *);
  99 static char *g_part_gpt_name(struct g_part_table *, struct g_part_entry *,
 100     char *, size_t);
 101 static int g_part_gpt_probe(struct g_part_table *, struct g_consumer *);
 102 static int g_part_gpt_read(struct g_part_table *, struct g_consumer *);
 103 static const char *g_part_gpt_type(struct g_part_table *, struct g_part_entry *,
 104     char *, size_t);
 105 static int g_part_gpt_write(struct g_part_table *, struct g_consumer *);
 106
 107 static kobj_method_t g_part_gpt_methods[] = {
 108         KOBJMETHOD(g_part_add,          g_part_gpt_add),
 109         KOBJMETHOD(g_part_bootcode,     g_part_gpt_bootcode),
 110         KOBJMETHOD(g_part_create,       g_part_gpt_create),
 111         KOBJMETHOD(g_part_destroy,      g_part_gpt_destroy),
 112         KOBJMETHOD(g_part_dumpconf,     g_part_gpt_dumpconf),
 113         KOBJMETHOD(g_part_dumpto,       g_part_gpt_dumpto),
 114         KOBJMETHOD(g_part_modify,       g_part_gpt_modify),
 115         KOBJMETHOD(g_part_name,         g_part_gpt_name),
 116         KOBJMETHOD(g_part_probe,        g_part_gpt_probe),
 117         KOBJMETHOD(g_part_read,         g_part_gpt_read),
 118         KOBJMETHOD(g_part_type,         g_part_gpt_type),
 119         KOBJMETHOD(g_part_write,        g_part_gpt_write),
 120         { 0, 0 }
 121 };
 122
 123 static struct g_part_scheme g_part_gpt_scheme = {
 124         "GPT",
 125         g_part_gpt_methods,
 126         sizeof(struct g_part_gpt_table),
 127         .gps_entrysz = sizeof(struct g_part_gpt_entry),
 128         .gps_minent = 128,
 129         .gps_maxent = INT_MAX,
 130         .gps_bootcodesz = MBRSIZE,
 131 };
 132 G_PART_SCHEME_DECLARE(g_part_gpt);
 133
 134 static struct uuid gpt_uuid_apple_hfs = GPT_ENT_TYPE_APPLE_HFS;
 135 static struct uuid gpt_uuid_efi = GPT_ENT_TYPE_EFI;
 136 static struct uuid gpt_uuid_freebsd = GPT_ENT_TYPE_FREEBSD;
 137 static struct uuid gpt_uuid_freebsd_boot = GPT_ENT_TYPE_FREEBSD_BOOT;
 138 static struct uuid gpt_uuid_freebsd_swap = GPT_ENT_TYPE_FREEBSD_SWAP;
 139 static struct uuid gpt_uuid_freebsd_ufs = GPT_ENT_TYPE_FREEBSD_UFS;
 140 static struct uuid gpt_uuid_freebsd_vinum = GPT_ENT_TYPE_FREEBSD_VINUM;
 141 static struct uuid gpt_uuid_freebsd_zfs = GPT_ENT_TYPE_FREEBSD_ZFS;
 142 static struct uuid gpt_uuid_linux_swap = GPT_ENT_TYPE_LINUX_SWAP;
 143 static struct uuid gpt_uuid_mbr = GPT_ENT_TYPE_MBR;
 144 static struct uuid gpt_uuid_unused = GPT_ENT_TYPE_UNUSED;
 145
 146 static void
 147 gpt_read_hdr(struct g_part_gpt_table *table, struct g_consumer *cp,
 148     enum gpt_elt elt, struct gpt_hdr *hdr)
 149 {
 150         struct uuid uuid;
 151         struct g_provider *pp;
 152         char *buf;
 153         quad_t lba, last;
 154         int error;
 155         uint32_t crc, sz;
 156
 157         pp = cp->provider;
 158         last = (pp->mediasize / pp->sectorsize) - 1;
 159         table->lba[elt] = (elt == GPT_ELT_PRIHDR) ? 1 : last;
 160         table->state[elt] = GPT_STATE_MISSING;
 161         buf = g_read_data(cp, table->lba[elt] * pp->sectorsize, pp->sectorsize,
 162             &error);
 163         if (buf == NULL)
 164                 return;
 165         bcopy(buf, hdr, sizeof(*hdr));
 166         if (memcmp(hdr->hdr_sig, GPT_HDR_SIG, sizeof(hdr->hdr_sig)) != 0)
 167                 return;
 168
 169         table->state[elt] = GPT_STATE_CORRUPT;
 170         sz = le32toh(hdr->hdr_size);
 171         if (sz < 92 || sz > pp->sectorsize)
 172                 return;
 173         crc = le32toh(hdr->hdr_crc_self);
 174         hdr->hdr_crc_self = 0;
 175         if (crc32(hdr, sz) != crc)
 176                 return;
 177         hdr->hdr_size = sz;
 178         hdr->hdr_crc_self = crc;
 179
 180         table->state[elt] = GPT_STATE_INVALID;
 181         hdr->hdr_revision = le32toh(hdr->hdr_revision);
 182         if (hdr->hdr_revision < 0x00010000)
 183                 return;
 184         hdr->hdr_lba_self = le64toh(hdr->hdr_lba_self);
 185         if (hdr->hdr_lba_self != table->lba[elt])
 186                 return;
 187         hdr->hdr_lba_alt = le64toh(hdr->hdr_lba_alt);
 188
 189         /* Check the managed area. */
 190         hdr->hdr_lba_start = le64toh(hdr->hdr_lba_start);
 191         if (hdr->hdr_lba_start < 2 || hdr->hdr_lba_start >= last)
 192                 return;
 193         hdr->hdr_lba_end = le64toh(hdr->hdr_lba_end);
 194         if (hdr->hdr_lba_end < hdr->hdr_lba_start || hdr->hdr_lba_end >= last)
 195                 return;
 196
 197         /* Check the table location and size of the table. */
 198         hdr->hdr_entries = le32toh(hdr->hdr_entries);
 199         hdr->hdr_entsz = le32toh(hdr->hdr_entsz);
 200         if (hdr->hdr_entries == 0 || hdr->hdr_entsz < 128 ||
 201             (hdr->hdr_entsz & 7) != 0)
 202                 return;
 203         hdr->hdr_lba_table = le64toh(hdr->hdr_lba_table);
 204         if (hdr->hdr_lba_table < 2 || hdr->hdr_lba_table >= last)
 205                 return;
 206         if (hdr->hdr_lba_table >= hdr->hdr_lba_start &&
 207             hdr->hdr_lba_table <= hdr->hdr_lba_end)
 208                 return;
 209         lba = hdr->hdr_lba_table +
 210             (hdr->hdr_entries * hdr->hdr_entsz + pp->sectorsize - 1) /
 211             pp->sectorsize - 1;
 212         if (lba >= last)
 213                 return;
 214         if (lba >= hdr->hdr_lba_start && lba <= hdr->hdr_lba_end)
 215                 return;
 216
 217         table->state[elt] = GPT_STATE_OK;
 218         le_uuid_dec(&hdr->hdr_uuid, &uuid);
 219         hdr->hdr_uuid = uuid;
 220         hdr->hdr_crc_table = le32toh(hdr->hdr_crc_table);
 221 }
 222
 223 static struct gpt_ent *
 224 gpt_read_tbl(struct g_part_gpt_table *table, struct g_consumer *cp,
 225     enum gpt_elt elt, struct gpt_hdr *hdr)
 226 {
 227         struct g_provider *pp;
 228         struct gpt_ent *ent, *tbl;
 229         char *buf, *p;
 230         unsigned int idx, sectors, tblsz;
 231         int error;
 232
 233         pp = cp->provider;
 234         table->lba[elt] = hdr->hdr_lba_table;
 235
 236         table->state[elt] = GPT_STATE_MISSING;
 237         tblsz = hdr->hdr_entries * hdr->hdr_entsz;
 238         sectors = (tblsz + pp->sectorsize - 1) / pp->sectorsize;
 239         buf = g_read_data(cp, table->lba[elt] * pp->sectorsize,
 240             sectors * pp->sectorsize, &error);
 241         if (buf == NULL)
 242                 return (NULL);
 243
 244         table->state[elt] = GPT_STATE_CORRUPT;
 245         if (crc32(buf, tblsz) != hdr->hdr_crc_table) {
 246                 g_free(buf);
 247                 return (NULL);
 248         }
 249
 250         table->state[elt] = GPT_STATE_OK;
 251         tbl = g_malloc(hdr->hdr_entries * sizeof(struct gpt_ent),
 252             M_WAITOK | M_ZERO);
 253
 254         for (idx = 0, ent = tbl, p = buf;
 255              idx < hdr->hdr_entries;
 256              idx++, ent++, p += hdr->hdr_entsz) {
 257                 le_uuid_dec(p, &ent->ent_type);
 258                 le_uuid_dec(p + 16, &ent->ent_uuid);
 259                 ent->ent_lba_start = le64dec(p + 32);
 260                 ent->ent_lba_end = le64dec(p + 40);
 261                 ent->ent_attr = le64dec(p + 48);
 262                 /* Keep UTF-16 in little-endian. */
 263                 bcopy(p + 56, ent->ent_name, sizeof(ent->ent_name));
 264         }
 265
 266         g_free(buf);
 267         return (tbl);
 268 }
 269
 270 static int
 271 gpt_matched_hdrs(struct gpt_hdr *pri, struct gpt_hdr *sec)
 272 {
 273
 274         if (!EQUUID(&pri->hdr_uuid, &sec->hdr_uuid))
 275                 return (0);
 276         return ((pri->hdr_revision == sec->hdr_revision &&
 277             pri->hdr_size == sec->hdr_size &&
 278             pri->hdr_lba_start == sec->hdr_lba_start &&
 279             pri->hdr_lba_end == sec->hdr_lba_end &&
 280             pri->hdr_entries == sec->hdr_entries &&
 281             pri->hdr_entsz == sec->hdr_entsz &&
 282             pri->hdr_crc_table == sec->hdr_crc_table) ? 1 : 0);
 283 }
 284
 285 static int
 286 gpt_parse_type(const char *type, struct uuid *uuid)
 287 {
 288         struct uuid tmp;
 289         const char *alias;
 290         int error;
 291
 292         if (type[0] == '!') {
 293                 error = parse_uuid(type + 1, &tmp);
 294                 if (error)
 295                         return (error);
 296                 if (EQUUID(&tmp, &gpt_uuid_unused))
 297                         return (EINVAL);
 298                 *uuid = tmp;
 299                 return (0);
 300         }
 301         alias = g_part_alias_name(G_PART_ALIAS_EFI);
 302         if (!strcasecmp(type, alias)) {
 303                 *uuid = gpt_uuid_efi;
 304                 return (0);
 305         }
 306         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD);
 307         if (!strcasecmp(type, alias)) {
 308                 *uuid = gpt_uuid_freebsd;
 309                 return (0);
 310         }
 311         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_BOOT);
 312         if (!strcasecmp(type, alias)) {
 313                 *uuid = gpt_uuid_freebsd_boot;
 314                 return (0);
 315         }
 316         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP);
 317         if (!strcasecmp(type, alias)) {
 318                 *uuid = gpt_uuid_freebsd_swap;
 319                 return (0);
 320         }
 321         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS);
 322         if (!strcasecmp(type, alias)) {
 323                 *uuid = gpt_uuid_freebsd_ufs;
 324                 return (0);
 325         }
 326         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM);
 327         if (!strcasecmp(type, alias)) {
 328                 *uuid = gpt_uuid_freebsd_vinum;
 329                 return (0);
 330         }
 331         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS);
 332         if (!strcasecmp(type, alias)) {
 333                 *uuid = gpt_uuid_freebsd_zfs;
 334                 return (0);
 335         }
 336         alias = g_part_alias_name(G_PART_ALIAS_MBR);
 337         if (!strcasecmp(type, alias)) {
 338                 *uuid = gpt_uuid_mbr;
 339                 return (0);
 340         }
 341         alias = g_part_alias_name(G_PART_ALIAS_APPLE_HFS);
 342         if (!strcasecmp(type, alias)) {
 343                 *uuid = gpt_uuid_apple_hfs;
 344                 return (0);
 345         }
 346         return (EINVAL);
 347 }
 348
 349 static int
 350 g_part_gpt_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
 351     struct g_part_parms *gpp)
 352 {
 353         struct g_part_gpt_entry *entry;
 354         int error;
 355
 356         entry = (struct g_part_gpt_entry *)baseentry;
 357         error = gpt_parse_type(gpp->gpp_type, &entry->ent.ent_type);
 358         if (error)
 359                 return (error);
 360         kern_uuidgen(&entry->ent.ent_uuid, 1);
 361         entry->ent.ent_lba_start = baseentry->gpe_start;
 362         entry->ent.ent_lba_end = baseentry->gpe_end;
 363         if (baseentry->gpe_deleted) {
 364                 entry->ent.ent_attr = 0;
 365                 bzero(entry->ent.ent_name, sizeof(entry->ent.ent_name));
 366         }
 367         if (gpp->gpp_parms & G_PART_PARM_LABEL)
 368                 g_gpt_utf8_to_utf16(gpp->gpp_label, entry->ent.ent_name,
 369                     sizeof(entry->ent.ent_name));
 370         return (0);
 371 }
 372
 373 static int
 374 g_part_gpt_bootcode(struct g_part_table *basetable, struct g_part_parms *gpp)
 375 {
 376         struct g_part_gpt_table *table;
 377
 378         table = (struct g_part_gpt_table *)basetable;
 379         bcopy(gpp->gpp_codeptr, table->mbr, DOSPARTOFF);
 380         return (0);
 381 }
 382
 383 static int
 384 g_part_gpt_create(struct g_part_table *basetable, struct g_part_parms *gpp)
 385 {
 386         struct g_provider *pp;
 387         struct g_part_gpt_table *table;
 388         quad_t last;
 389         size_t tblsz;
 390
 391         table = (struct g_part_gpt_table *)basetable;
 392         pp = gpp->gpp_provider;
 393         tblsz = (basetable->gpt_entries * sizeof(struct gpt_ent) +
 394             pp->sectorsize - 1) / pp->sectorsize;
 395         if (pp->sectorsize < MBRSIZE ||
 396             pp->mediasize < (3 + 2 * tblsz + basetable->gpt_entries) *
 397             pp->sectorsize)
 398                 return (ENOSPC);
 399
 400         last = (pp->mediasize / pp->sectorsize) - 1;
 401
 402         le16enc(table->mbr + DOSMAGICOFFSET, DOSMAGIC);
 403         table->mbr[DOSPARTOFF + 1] = 0xff;              /* shd */
 404         table->mbr[DOSPARTOFF + 2] = 0xff;              /* ssect */
 405         table->mbr[DOSPARTOFF + 3] = 0xff;              /* scyl */
 406         table->mbr[DOSPARTOFF + 4] = 0xee;              /* typ */
 407         table->mbr[DOSPARTOFF + 5] = 0xff;              /* ehd */
 408         table->mbr[DOSPARTOFF + 6] = 0xff;              /* esect */
 409         table->mbr[DOSPARTOFF + 7] = 0xff;              /* ecyl */
 410         le32enc(table->mbr + DOSPARTOFF + 8, 1);        /* start */
 411         le32enc(table->mbr + DOSPARTOFF + 12, MIN(last, 0xffffffffLL));
 412
 413         table->lba[GPT_ELT_PRIHDR] = 1;
 414         table->lba[GPT_ELT_PRITBL] = 2;
 415         table->lba[GPT_ELT_SECHDR] = last;
 416         table->lba[GPT_ELT_SECTBL] = last - tblsz;
 417
 418         bcopy(GPT_HDR_SIG, table->hdr.hdr_sig, sizeof(table->hdr.hdr_sig));
 419         table->hdr.hdr_revision = GPT_HDR_REVISION;
 420         table->hdr.hdr_size = offsetof(struct gpt_hdr, padding);
 421         table->hdr.hdr_lba_start = 2 + tblsz;
 422         table->hdr.hdr_lba_end = last - tblsz - 1;
 423         kern_uuidgen(&table->hdr.hdr_uuid, 1);
 424         table->hdr.hdr_entries = basetable->gpt_entries;
 425         table->hdr.hdr_entsz = sizeof(struct gpt_ent);
 426
 427         basetable->gpt_first = table->hdr.hdr_lba_start;
 428         basetable->gpt_last = table->hdr.hdr_lba_end;
 429         return (0);
 430 }
 431
 432 static int
 433 g_part_gpt_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
 434 {
 435
 436         /*
 437          * Wipe the first 2 sectors as well as the last to clear the
 438          * partitioning.
 439          */
 440         basetable->gpt_smhead |= 3;
 441         basetable->gpt_smtail |= 1;
 442         return (0);
 443 }
 444
 445 static int
 446 g_part_gpt_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
 447     struct sbuf *sb, const char *indent)
 448 {
 449         struct g_part_gpt_entry *entry;
 450
 451         entry = (struct g_part_gpt_entry *)baseentry;
 452         if (indent == NULL) {
 453                 /* conftxt: libdisk compatibility */
 454                 sbuf_printf(sb, " xs GPT xt ");
 455                 sbuf_printf_uuid(sb, &entry->ent.ent_type);
 456         } else if (entry != NULL) {
 457                 /* confxml: partition entry information */
 458                 sbuf_printf(sb, "%s<label>", indent);
 459                 g_gpt_printf_utf16(sb, entry->ent.ent_name,
 460                     sizeof(entry->ent.ent_name) >> 1);
 461                 sbuf_printf(sb, "</label>\n");
 462                 sbuf_printf(sb, "%s<rawtype>", indent);
 463                 sbuf_printf_uuid(sb, &entry->ent.ent_type);
 464                 sbuf_printf(sb, "</rawtype>\n");
 465         } else {
 466                 /* confxml: scheme information */
 467         }
 468         return (0);
 469 }
 470
 471 static int
 472 g_part_gpt_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
 473 {
 474         struct g_part_gpt_entry *entry;
 475
 476         entry = (struct g_part_gpt_entry *)baseentry;
 477         return ((EQUUID(&entry->ent.ent_type, &gpt_uuid_freebsd_swap) ||
 478             EQUUID(&entry->ent.ent_type, &gpt_uuid_linux_swap)) ? 1 : 0);
 479 }
 480
 481 static int
 482 g_part_gpt_modify(struct g_part_table *basetable,
 483     struct g_part_entry *baseentry, struct g_part_parms *gpp)
 484 {
 485         struct g_part_gpt_entry *entry;
 486         int error;
 487
 488         entry = (struct g_part_gpt_entry *)baseentry;
 489         if (gpp->gpp_parms & G_PART_PARM_TYPE) {
 490                 error = gpt_parse_type(gpp->gpp_type, &entry->ent.ent_type);
 491                 if (error)
 492                         return (error);
 493         }
 494         if (gpp->gpp_parms & G_PART_PARM_LABEL)
 495                 g_gpt_utf8_to_utf16(gpp->gpp_label, entry->ent.ent_name,
 496                     sizeof(entry->ent.ent_name));
 497         return (0);
 498 }
 499
 500 static char *
 501 g_part_gpt_name(struct g_part_table *table, struct g_part_entry *baseentry,
 502     char *buf, size_t bufsz)
 503 {
 504         struct g_part_gpt_entry *entry;
 505         char c;
 506
 507         entry = (struct g_part_gpt_entry *)baseentry;
 508         c = (EQUUID(&entry->ent.ent_type, &gpt_uuid_freebsd)) ? 's' : 'p';
 509         snprintf(buf, bufsz, "%c%d", c, baseentry->gpe_index);
 510         return (buf);
 511 }
 512
 513 static int
 514 g_part_gpt_probe(struct g_part_table *table, struct g_consumer *cp)
 515 {
 516         struct g_provider *pp;
 517         char *buf;
 518         int error, res;
 519
 520         /* We don't nest, which means that our depth should be 0. */
 521         if (table->gpt_depth != 0)
 522                 return (ENXIO);
 523
 524         pp = cp->provider;
 525
 526         /*
 527          * Sanity-check the provider. Since the first sector on the provider
 528          * must be a PMBR and a PMBR is 512 bytes large, the sector size
 529          * must be at least 512 bytes.  Also, since the theoretical minimum
 530          * number of sectors needed by GPT is 6, any medium that has less
 531          * than 6 sectors is never going to be able to hold a GPT. The
 532          * number 6 comes from:
 533          *      1 sector for the PMBR
 534          *      2 sectors for the GPT headers (each 1 sector)
 535          *      2 sectors for the GPT tables (each 1 sector)
 536          *      1 sector for an actual partition
 537          * It's better to catch this pathological case early than behaving
 538          * pathologically later on...
 539          */
 540         if (pp->sectorsize < MBRSIZE || pp->mediasize < 6 * pp->sectorsize)
 541                 return (ENOSPC);
 542
 543         /* Check that there's a MBR. */
 544         buf = g_read_data(cp, 0L, pp->sectorsize, &error);
 545         if (buf == NULL)
 546                 return (error);
 547         res = le16dec(buf + DOSMAGICOFFSET);
 548         g_free(buf);
 549         if (res != DOSMAGIC)
 550                 return (ENXIO);
 551
 552         /* Check that there's a primary header. */
 553         buf = g_read_data(cp, pp->sectorsize, pp->sectorsize, &error);
 554         if (buf == NULL)
 555                 return (error);
 556         res = memcmp(buf, GPT_HDR_SIG, 8);
 557         g_free(buf);
 558         if (res == 0)
 559                 return (G_PART_PROBE_PRI_HIGH);
 560
 561         /* No primary? Check that there's a secondary. */
 562         buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
 563             &error);
 564         if (buf == NULL)
 565                 return (error);
 566         res = memcmp(buf, GPT_HDR_SIG, 8);
 567         g_free(buf);
 568         return ((res == 0) ? G_PART_PROBE_PRI_HIGH : ENXIO);
 569 }
 570
 571 static int
 572 g_part_gpt_read(struct g_part_table *basetable, struct g_consumer *cp)
 573 {
 574         struct gpt_hdr prihdr, sechdr;
 575         struct gpt_ent *tbl, *pritbl, *sectbl;
 576         struct g_provider *pp;
 577         struct g_part_gpt_table *table;
 578         struct g_part_gpt_entry *entry;
 579         u_char *buf;
 580         int error, index;
 581
 582         table = (struct g_part_gpt_table *)basetable;
 583         pp = cp->provider;
 584
 585         /* Read the PMBR */
 586         buf = g_read_data(cp, 0, pp->sectorsize, &error);
 587         if (buf == NULL)
 588                 return (error);
 589         bcopy(buf, table->mbr, MBRSIZE);
 590         g_free(buf);
 591
 592         /* Read the primary header and table. */
 593         gpt_read_hdr(table, cp, GPT_ELT_PRIHDR, &prihdr);
 594         if (table->state[GPT_ELT_PRIHDR] == GPT_STATE_OK) {
 595                 pritbl = gpt_read_tbl(table, cp, GPT_ELT_PRITBL, &prihdr);
 596         } else {
 597                 table->state[GPT_ELT_PRITBL] = GPT_STATE_MISSING;
 598                 pritbl = NULL;
 599         }
 600
 601         /* Read the secondary header and table. */
 602         gpt_read_hdr(table, cp, GPT_ELT_SECHDR, &sechdr);
 603         if (table->state[GPT_ELT_SECHDR] == GPT_STATE_OK) {
 604                 sectbl = gpt_read_tbl(table, cp, GPT_ELT_SECTBL, &sechdr);
 605         } else {
 606                 table->state[GPT_ELT_SECTBL] = GPT_STATE_MISSING;
 607                 sectbl = NULL;
 608         }
 609
 610         /* Fail if we haven't got any good tables at all. */
 611         if (table->state[GPT_ELT_PRITBL] != GPT_STATE_OK &&
 612             table->state[GPT_ELT_SECTBL] != GPT_STATE_OK) {
 613                 printf("GEOM: %s: corrupt or invalid GPT detected.\n",
 614                     pp->name);
 615                 printf("GEOM: %s: GPT rejected -- may not be recoverable.\n",
 616                     pp->name);
 617                 return (EINVAL);
 618         }
 619
 620         /*
 621          * If both headers are good but they disagree with each other,
 622          * then invalidate one. We prefer to keep the primary header,
 623          * unless the primary table is corrupt.
 624          */
 625         if (table->state[GPT_ELT_PRIHDR] == GPT_STATE_OK &&
 626             table->state[GPT_ELT_SECHDR] == GPT_STATE_OK &&
 627             !gpt_matched_hdrs(&prihdr, &sechdr)) {
 628                 if (table->state[GPT_ELT_PRITBL] == GPT_STATE_OK)
 629                         table->state[GPT_ELT_SECHDR] = GPT_STATE_INVALID;
 630                 else
 631                         table->state[GPT_ELT_PRIHDR] = GPT_STATE_INVALID;
 632         }
 633
 634         if (table->state[GPT_ELT_PRIHDR] != GPT_STATE_OK) {
 635                 printf("GEOM: %s: the primary GPT table is corrupt or "
 636                     "invalid.\n", pp->name);
 637                 printf("GEOM: %s: using the secondary instead -- recovery "
 638                     "strongly advised.\n", pp->name);
 639                 table->hdr = sechdr;
 640                 tbl = sectbl;
 641                 if (pritbl != NULL)
 642                         g_free(pritbl);
 643         } else {
 644                 if (table->state[GPT_ELT_SECHDR] != GPT_STATE_OK) {
 645                         printf("GEOM: %s: the secondary GPT table is corrupt "
 646                             "or invalid.\n", pp->name);
 647                         printf("GEOM: %s: using the primary only -- recovery "
 648                             "suggested.\n", pp->name);
 649                 }
 650                 table->hdr = prihdr;
 651                 tbl = pritbl;
 652                 if (sectbl != NULL)
 653                         g_free(sectbl);
 654         }
 655
 656         basetable->gpt_first = table->hdr.hdr_lba_start;
 657         basetable->gpt_last = table->hdr.hdr_lba_end;
 658         basetable->gpt_entries = table->hdr.hdr_entries;
 659
 660         for (index = basetable->gpt_entries - 1; index >= 0; index--) {
 661                 if (EQUUID(&tbl[index].ent_type, &gpt_uuid_unused))
 662                         continue;
 663                 entry = (struct g_part_gpt_entry *)g_part_new_entry(basetable,
 664                     index+1, tbl[index].ent_lba_start, tbl[index].ent_lba_end);
 665                 entry->ent = tbl[index];
 666         }
 667
 668         g_free(tbl);
 669         return (0);
 670 }
 671
 672 static const char *
 673 g_part_gpt_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
 674     char *buf, size_t bufsz)
 675 {
 676         struct g_part_gpt_entry *entry;
 677         struct uuid *type;
 678
 679         entry = (struct g_part_gpt_entry *)baseentry;
 680         type = &entry->ent.ent_type;
 681         if (EQUUID(type, &gpt_uuid_efi))
 682                 return (g_part_alias_name(G_PART_ALIAS_EFI));
 683         if (EQUUID(type, &gpt_uuid_freebsd))
 684                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD));
 685         if (EQUUID(type, &gpt_uuid_freebsd_boot))
 686                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_BOOT));
 687         if (EQUUID(type, &gpt_uuid_freebsd_swap))
 688                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP));
 689         if (EQUUID(type, &gpt_uuid_freebsd_ufs))
 690                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS));
 691         if (EQUUID(type, &gpt_uuid_freebsd_vinum))
 692                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM));
 693         if (EQUUID(type, &gpt_uuid_freebsd_zfs))
 694                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS));
 695         if (EQUUID(type, &gpt_uuid_mbr))
 696                 return (g_part_alias_name(G_PART_ALIAS_MBR));
 697         buf[0] = '!';
 698         snprintf_uuid(buf + 1, bufsz - 1, type);
 699         return (buf);
 700 }
 701
 702 static int
 703 g_part_gpt_write(struct g_part_table *basetable, struct g_consumer *cp)
 704 {
 705         unsigned char *buf, *bp;
 706         struct g_provider *pp;
 707         struct g_part_entry *baseentry;
 708         struct g_part_gpt_entry *entry;
 709         struct g_part_gpt_table *table;
 710         size_t tlbsz;
 711         uint32_t crc;
 712         int error, index;
 713
 714         pp = cp->provider;
 715         table = (struct g_part_gpt_table *)basetable;
 716         tlbsz = (table->hdr.hdr_entries * table->hdr.hdr_entsz +
 717             pp->sectorsize - 1) / pp->sectorsize;
 718
 719         /* Write the PMBR */
 720         buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO);
 721         bcopy(table->mbr, buf, MBRSIZE);
 722         error = g_write_data(cp, 0, buf, pp->sectorsize);
 723         g_free(buf);
 724         if (error)
 725                 return (error);
 726
 727         /* Allocate space for the header and entries. */
 728         buf = g_malloc((tlbsz + 1) * pp->sectorsize, M_WAITOK | M_ZERO);
 729
 730         memcpy(buf, table->hdr.hdr_sig, sizeof(table->hdr.hdr_sig));
 731         le32enc(buf + 8, table->hdr.hdr_revision);
 732         le32enc(buf + 12, table->hdr.hdr_size);
 733         le64enc(buf + 40, table->hdr.hdr_lba_start);
 734         le64enc(buf + 48, table->hdr.hdr_lba_end);
 735         le_uuid_enc(buf + 56, &table->hdr.hdr_uuid);
 736         le32enc(buf + 80, table->hdr.hdr_entries);
 737         le32enc(buf + 84, table->hdr.hdr_entsz);
 738
 739         LIST_FOREACH(baseentry, &basetable->gpt_entry, gpe_entry) {
 740                 if (baseentry->gpe_deleted)
 741                         continue;
 742                 entry = (struct g_part_gpt_entry *)baseentry;
 743                 index = baseentry->gpe_index - 1;
 744                 bp = buf + pp->sectorsize + table->hdr.hdr_entsz * index;
 745                 le_uuid_enc(bp, &entry->ent.ent_type);
 746                 le_uuid_enc(bp + 16, &entry->ent.ent_uuid);
 747                 le64enc(bp + 32, entry->ent.ent_lba_start);
 748                 le64enc(bp + 40, entry->ent.ent_lba_end);
 749                 le64enc(bp + 48, entry->ent.ent_attr);
 750                 memcpy(bp + 56, entry->ent.ent_name,
 751                     sizeof(entry->ent.ent_name));
 752         }
 753
 754         crc = crc32(buf + pp->sectorsize,
 755             table->hdr.hdr_entries * table->hdr.hdr_entsz);
 756         le32enc(buf + 88, crc);
 757
 758         /* Write primary meta-data. */
 759         le32enc(buf + 16, 0);   /* hdr_crc_self. */
 760         le64enc(buf + 24, table->lba[GPT_ELT_PRIHDR]);  /* hdr_lba_self. */
 761         le64enc(buf + 32, table->lba[GPT_ELT_SECHDR]);  /* hdr_lba_alt. */
 762         le64enc(buf + 72, table->lba[GPT_ELT_PRITBL]);  /* hdr_lba_table. */
 763         crc = crc32(buf, table->hdr.hdr_size);
 764         le32enc(buf + 16, crc);
 765
 766         error = g_write_data(cp, table->lba[GPT_ELT_PRITBL] * pp->sectorsize,
 767             buf + pp->sectorsize, tlbsz * pp->sectorsize);
 768         if (error)
 769                 goto out;
 770         error = g_write_data(cp, table->lba[GPT_ELT_PRIHDR] * pp->sectorsize,
 771             buf, pp->sectorsize);
 772         if (error)
 773                 goto out;
 774
 775         /* Write secondary meta-data. */
 776         le32enc(buf + 16, 0);   /* hdr_crc_self. */
 777         le64enc(buf + 24, table->lba[GPT_ELT_SECHDR]);  /* hdr_lba_self. */
 778         le64enc(buf + 32, table->lba[GPT_ELT_PRIHDR]);  /* hdr_lba_alt. */
 779         le64enc(buf + 72, table->lba[GPT_ELT_SECTBL]);  /* hdr_lba_table. */
 780         crc = crc32(buf, table->hdr.hdr_size);
 781         le32enc(buf + 16, crc);
 782
 783         error = g_write_data(cp, table->lba[GPT_ELT_SECTBL] * pp->sectorsize,
 784             buf + pp->sectorsize, tlbsz * pp->sectorsize);
 785         if (error)
 786                 goto out;
 787         error = g_write_data(cp, table->lba[GPT_ELT_SECHDR] * pp->sectorsize,
 788             buf, pp->sectorsize);
 789
 790  out:
 791         g_free(buf);
 792         return (error);
 793 }
 794
 795 static void
 796 g_gpt_printf_utf16(struct sbuf *sb, uint16_t *str, size_t len)
 797 {
 798         u_int bo;
 799         uint32_t ch;
 800         uint16_t c;
 801
 802         bo = LITTLE_ENDIAN;     /* GPT is little-endian */
 803         while (len > 0 && *str != 0) {
 804                 ch = (bo == BIG_ENDIAN) ? be16toh(*str) : le16toh(*str);
 805                 str++, len--;
 806                 if ((ch & 0xf800) == 0xd800) {
 807                         if (len > 0) {
 808                                 c = (bo == BIG_ENDIAN) ? be16toh(*str)
 809                                     : le16toh(*str);
 810                                 str++, len--;
 811                         } else
 812                                 c = 0xfffd;
 813                         if ((ch & 0x400) == 0 && (c & 0xfc00) == 0xdc00) {
 814                                 ch = ((ch & 0x3ff) << 10) + (c & 0x3ff);
 815                                 ch += 0x10000;
 816                         } else
 817                                 ch = 0xfffd;
 818                 } else if (ch == 0xfffe) { /* BOM (U+FEFF) swapped. */
 819                         bo = (bo == BIG_ENDIAN) ? LITTLE_ENDIAN : BIG_ENDIAN;
 820                         continue;
 821                 } else if (ch == 0xfeff) /* BOM (U+FEFF) unswapped. */
 822                         continue;
 823
 824                 /* Write the Unicode character in UTF-8 */
 825                 if (ch < 0x80)
 826                         sbuf_printf(sb, "%c", ch);
 827                 else if (ch < 0x800)
 828                         sbuf_printf(sb, "%c%c", 0xc0 | (ch >> 6),
 829                             0x80 | (ch & 0x3f));
 830                 else if (ch < 0x10000)
 831                         sbuf_printf(sb, "%c%c%c", 0xe0 | (ch >> 12),
 832                             0x80 | ((ch >> 6) & 0x3f), 0x80 | (ch & 0x3f));
 833                 else if (ch < 0x200000)
 834                         sbuf_printf(sb, "%c%c%c%c", 0xf0 | (ch >> 18),
 835                             0x80 | ((ch >> 12) & 0x3f),
 836                             0x80 | ((ch >> 6) & 0x3f), 0x80 | (ch & 0x3f));
 837         }
 838 }
 839
 840 static void
 841 g_gpt_utf8_to_utf16(const uint8_t *s8, uint16_t *s16, size_t s16len)
 842 {
 843         size_t s16idx, s8idx;
 844         uint32_t utfchar;
 845         unsigned int c, utfbytes;
 846
 847         s8idx = s16idx = 0;
 848         utfchar = 0;
 849         utfbytes = 0;
 850         bzero(s16, s16len << 1);
 851         while (s8[s8idx] != 0 && s16idx < s16len) {
 852                 c = s8[s8idx++];
 853                 if ((c & 0xc0) != 0x80) {
 854                         /* Initial characters. */
 855                         if (utfbytes != 0) {
 856                                 /* Incomplete encoding of previous char. */
 857                                 s16[s16idx++] = htole16(0xfffd);
 858                         }
 859                         if ((c & 0xf8) == 0xf0) {
 860                                 utfchar = c & 0x07;
 861                                 utfbytes = 3;
 862                         } else if ((c & 0xf0) == 0xe0) {
 863                                 utfchar = c & 0x0f;
 864                                 utfbytes = 2;
 865                         } else if ((c & 0xe0) == 0xc0) {
 866                                 utfchar = c & 0x1f;
 867                                 utfbytes = 1;
 868                         } else {
 869                                 utfchar = c & 0x7f;
 870                                 utfbytes = 0;
 871                         }
 872                 } else {
 873                         /* Followup characters. */
 874                         if (utfbytes > 0) {
 875                                 utfchar = (utfchar << 6) + (c & 0x3f);
 876                                 utfbytes--;
 877                         } else if (utfbytes == 0)
 878                                 utfbytes = ~0;
 879                 }
 880                 /*
 881                  * Write the complete Unicode character as UTF-16 when we
 882                  * have all the UTF-8 charactars collected.
 883                  */
 884                 if (utfbytes == 0) {
 885                         /*
 886                          * If we need to write 2 UTF-16 characters, but
 887                          * we only have room for 1, then we truncate the
 888                          * string by writing a 0 instead.
 889                          */
 890                         if (utfchar >= 0x10000 && s16idx < s16len - 1) {
 891                                 s16[s16idx++] =
 892                                     htole16(0xd800 | ((utfchar >> 10) - 0x40));
 893                                 s16[s16idx++] =
 894                                     htole16(0xdc00 | (utfchar & 0x3ff));
 895                         } else
 896                                 s16[s16idx++] = (utfchar >= 0x10000) ? 0 :
 897                                     htole16(utfchar);
 898                 }
 899         }
 900         /*
 901          * If our input string was truncated, append an invalid encoding
 902          * character to the output string.
 903          */
 904         if (utfbytes != 0 && s16idx < s16len)
 905                 s16[s16idx++] = htole16(0xfffd);
 906 }