g_part_gpt.c revision 188429
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: head/sys/geom/part/g_part_gpt.c 188429 2009-02-10 02:43:07Z imp $"); 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 50CTASSERT(offsetof(struct gpt_hdr, padding) == 92); 51CTASSERT(sizeof(struct gpt_ent) == 128); 52 53#define EQUUID(a,b) (memcmp(a, b, sizeof(struct uuid)) == 0) 54 55#define MBRSIZE 512 56 57enum gpt_elt { 58 GPT_ELT_PRIHDR, 59 GPT_ELT_PRITBL, 60 GPT_ELT_SECHDR, 61 GPT_ELT_SECTBL, 62 GPT_ELT_COUNT 63}; 64 65enum 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 73struct 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 81struct g_part_gpt_entry { 82 struct g_part_entry base; 83 struct gpt_ent ent; 84}; 85 86static void g_gpt_printf_utf16(struct sbuf *, uint16_t *, size_t); 87static void g_gpt_utf8_to_utf16(const uint8_t *, uint16_t *, size_t); 88 89static int g_part_gpt_add(struct g_part_table *, struct g_part_entry *, 90 struct g_part_parms *); 91static int g_part_gpt_bootcode(struct g_part_table *, struct g_part_parms *); 92static int g_part_gpt_create(struct g_part_table *, struct g_part_parms *); 93static int g_part_gpt_destroy(struct g_part_table *, struct g_part_parms *); 94static void g_part_gpt_dumpconf(struct g_part_table *, struct g_part_entry *, 95 struct sbuf *, const char *); 96static int g_part_gpt_dumpto(struct g_part_table *, struct g_part_entry *); 97static int g_part_gpt_modify(struct g_part_table *, struct g_part_entry *, 98 struct g_part_parms *); 99static const char *g_part_gpt_name(struct g_part_table *, struct g_part_entry *, 100 char *, size_t); 101static int g_part_gpt_probe(struct g_part_table *, struct g_consumer *); 102static int g_part_gpt_read(struct g_part_table *, struct g_consumer *); 103static const char *g_part_gpt_type(struct g_part_table *, struct g_part_entry *, 104 char *, size_t); 105static int g_part_gpt_write(struct g_part_table *, struct g_consumer *); 106 107static 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 123static 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}; 132G_PART_SCHEME_DECLARE(g_part_gpt); 133 134static struct uuid gpt_uuid_apple_hfs = GPT_ENT_TYPE_APPLE_HFS; 135static struct uuid gpt_uuid_efi = GPT_ENT_TYPE_EFI; 136static struct uuid gpt_uuid_freebsd = GPT_ENT_TYPE_FREEBSD; 137static struct uuid gpt_uuid_freebsd_boot = GPT_ENT_TYPE_FREEBSD_BOOT; 138static struct uuid gpt_uuid_freebsd_swap = GPT_ENT_TYPE_FREEBSD_SWAP; 139static struct uuid gpt_uuid_freebsd_ufs = GPT_ENT_TYPE_FREEBSD_UFS; 140static struct uuid gpt_uuid_freebsd_vinum = GPT_ENT_TYPE_FREEBSD_VINUM; 141static struct uuid gpt_uuid_freebsd_zfs = GPT_ENT_TYPE_FREEBSD_ZFS; 142static struct uuid gpt_uuid_linux_swap = GPT_ENT_TYPE_LINUX_SWAP; 143static struct uuid gpt_uuid_mbr = GPT_ENT_TYPE_MBR; 144static struct uuid gpt_uuid_unused = GPT_ENT_TYPE_UNUSED; 145 146static void 147gpt_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 223static struct gpt_ent * 224gpt_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 270static int 271gpt_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 285static int 286gpt_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 349static int 350g_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 373static int 374g_part_gpt_bootcode(struct g_part_table *basetable, struct g_part_parms *gpp) 375{ 376 struct g_part_gpt_table *table; 377 size_t codesz; 378 379 codesz = DOSPARTOFF; 380 table = (struct g_part_gpt_table *)basetable; 381 bzero(table->mbr, codesz); 382 codesz = MIN(codesz, gpp->gpp_codesize); 383 if (codesz > 0) 384 bcopy(gpp->gpp_codeptr, table->mbr, codesz); 385 return (0); 386} 387 388static int 389g_part_gpt_create(struct g_part_table *basetable, struct g_part_parms *gpp) 390{ 391 struct g_provider *pp; 392 struct g_part_gpt_table *table; 393 quad_t last; 394 size_t tblsz; 395 396 table = (struct g_part_gpt_table *)basetable; 397 pp = gpp->gpp_provider; 398 tblsz = (basetable->gpt_entries * sizeof(struct gpt_ent) + 399 pp->sectorsize - 1) / pp->sectorsize; 400 if (pp->sectorsize < MBRSIZE || 401 pp->mediasize < (3 + 2 * tblsz + basetable->gpt_entries) * 402 pp->sectorsize) 403 return (ENOSPC); 404 405 last = (pp->mediasize / pp->sectorsize) - 1; 406 407 le16enc(table->mbr + DOSMAGICOFFSET, DOSMAGIC); 408 table->mbr[DOSPARTOFF + 1] = 0xff; /* shd */ 409 table->mbr[DOSPARTOFF + 2] = 0xff; /* ssect */ 410 table->mbr[DOSPARTOFF + 3] = 0xff; /* scyl */ 411 table->mbr[DOSPARTOFF + 4] = 0xee; /* typ */ 412 table->mbr[DOSPARTOFF + 5] = 0xff; /* ehd */ 413 table->mbr[DOSPARTOFF + 6] = 0xff; /* esect */ 414 table->mbr[DOSPARTOFF + 7] = 0xff; /* ecyl */ 415 le32enc(table->mbr + DOSPARTOFF + 8, 1); /* start */ 416 le32enc(table->mbr + DOSPARTOFF + 12, MIN(last, 0xffffffffLL)); 417 418 table->lba[GPT_ELT_PRIHDR] = 1; 419 table->lba[GPT_ELT_PRITBL] = 2; 420 table->lba[GPT_ELT_SECHDR] = last; 421 table->lba[GPT_ELT_SECTBL] = last - tblsz; 422 423 bcopy(GPT_HDR_SIG, table->hdr.hdr_sig, sizeof(table->hdr.hdr_sig)); 424 table->hdr.hdr_revision = GPT_HDR_REVISION; 425 table->hdr.hdr_size = offsetof(struct gpt_hdr, padding); 426 table->hdr.hdr_lba_start = 2 + tblsz; 427 table->hdr.hdr_lba_end = last - tblsz - 1; 428 kern_uuidgen(&table->hdr.hdr_uuid, 1); 429 table->hdr.hdr_entries = basetable->gpt_entries; 430 table->hdr.hdr_entsz = sizeof(struct gpt_ent); 431 432 basetable->gpt_first = table->hdr.hdr_lba_start; 433 basetable->gpt_last = table->hdr.hdr_lba_end; 434 return (0); 435} 436 437static int 438g_part_gpt_destroy(struct g_part_table *basetable, struct g_part_parms *gpp) 439{ 440 441 /* 442 * Wipe the first 2 sectors as well as the last to clear the 443 * partitioning. 444 */ 445 basetable->gpt_smhead |= 3; 446 basetable->gpt_smtail |= 1; 447 return (0); 448} 449 450static void 451g_part_gpt_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry, 452 struct sbuf *sb, const char *indent) 453{ 454 struct g_part_gpt_entry *entry; 455 456 entry = (struct g_part_gpt_entry *)baseentry; 457 if (indent == NULL) { 458 /* conftxt: libdisk compatibility */ 459 sbuf_printf(sb, " xs GPT xt "); 460 sbuf_printf_uuid(sb, &entry->ent.ent_type); 461 } else if (entry != NULL) { 462 /* confxml: partition entry information */ 463 sbuf_printf(sb, "%s<label>", indent); 464 g_gpt_printf_utf16(sb, entry->ent.ent_name, 465 sizeof(entry->ent.ent_name) >> 1); 466 sbuf_printf(sb, "</label>\n"); 467 sbuf_printf(sb, "%s<rawtype>", indent); 468 sbuf_printf_uuid(sb, &entry->ent.ent_type); 469 sbuf_printf(sb, "</rawtype>\n"); 470 } else { 471 /* confxml: scheme information */ 472 } 473} 474 475static int 476g_part_gpt_dumpto(struct g_part_table *table, struct g_part_entry *baseentry) 477{ 478 struct g_part_gpt_entry *entry; 479 480 entry = (struct g_part_gpt_entry *)baseentry; 481 return ((EQUUID(&entry->ent.ent_type, &gpt_uuid_freebsd_swap) || 482 EQUUID(&entry->ent.ent_type, &gpt_uuid_linux_swap)) ? 1 : 0); 483} 484 485static int 486g_part_gpt_modify(struct g_part_table *basetable, 487 struct g_part_entry *baseentry, struct g_part_parms *gpp) 488{ 489 struct g_part_gpt_entry *entry; 490 int error; 491 492 entry = (struct g_part_gpt_entry *)baseentry; 493 if (gpp->gpp_parms & G_PART_PARM_TYPE) { 494 error = gpt_parse_type(gpp->gpp_type, &entry->ent.ent_type); 495 if (error) 496 return (error); 497 } 498 if (gpp->gpp_parms & G_PART_PARM_LABEL) 499 g_gpt_utf8_to_utf16(gpp->gpp_label, entry->ent.ent_name, 500 sizeof(entry->ent.ent_name)); 501 return (0); 502} 503 504static const char * 505g_part_gpt_name(struct g_part_table *table, struct g_part_entry *baseentry, 506 char *buf, size_t bufsz) 507{ 508 struct g_part_gpt_entry *entry; 509 char c; 510 511 entry = (struct g_part_gpt_entry *)baseentry; 512 c = (EQUUID(&entry->ent.ent_type, &gpt_uuid_freebsd)) ? 's' : 'p'; 513 snprintf(buf, bufsz, "%c%d", c, baseentry->gpe_index); 514 return (buf); 515} 516 517static int 518g_part_gpt_probe(struct g_part_table *table, struct g_consumer *cp) 519{ 520 struct g_provider *pp; 521 char *buf; 522 int error, res; 523 524 /* We don't nest, which means that our depth should be 0. */ 525 if (table->gpt_depth != 0) 526 return (ENXIO); 527 528 pp = cp->provider; 529 530 /* 531 * Sanity-check the provider. Since the first sector on the provider 532 * must be a PMBR and a PMBR is 512 bytes large, the sector size 533 * must be at least 512 bytes. Also, since the theoretical minimum 534 * number of sectors needed by GPT is 6, any medium that has less 535 * than 6 sectors is never going to be able to hold a GPT. The 536 * number 6 comes from: 537 * 1 sector for the PMBR 538 * 2 sectors for the GPT headers (each 1 sector) 539 * 2 sectors for the GPT tables (each 1 sector) 540 * 1 sector for an actual partition 541 * It's better to catch this pathological case early than behaving 542 * pathologically later on... 543 */ 544 if (pp->sectorsize < MBRSIZE || pp->mediasize < 6 * pp->sectorsize) 545 return (ENOSPC); 546 547 /* Check that there's a MBR. */ 548 buf = g_read_data(cp, 0L, pp->sectorsize, &error); 549 if (buf == NULL) 550 return (error); 551 res = le16dec(buf + DOSMAGICOFFSET); 552 g_free(buf); 553 if (res != DOSMAGIC) 554 return (ENXIO); 555 556 /* Check that there's a primary header. */ 557 buf = g_read_data(cp, pp->sectorsize, pp->sectorsize, &error); 558 if (buf == NULL) 559 return (error); 560 res = memcmp(buf, GPT_HDR_SIG, 8); 561 g_free(buf); 562 if (res == 0) 563 return (G_PART_PROBE_PRI_HIGH); 564 565 /* No primary? Check that there's a secondary. */ 566 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize, 567 &error); 568 if (buf == NULL) 569 return (error); 570 res = memcmp(buf, GPT_HDR_SIG, 8); 571 g_free(buf); 572 return ((res == 0) ? G_PART_PROBE_PRI_HIGH : ENXIO); 573} 574 575static int 576g_part_gpt_read(struct g_part_table *basetable, struct g_consumer *cp) 577{ 578 struct gpt_hdr prihdr, sechdr; 579 struct gpt_ent *tbl, *pritbl, *sectbl; 580 struct g_provider *pp; 581 struct g_part_gpt_table *table; 582 struct g_part_gpt_entry *entry; 583 u_char *buf; 584 int error, index; 585 586 table = (struct g_part_gpt_table *)basetable; 587 pp = cp->provider; 588 589 /* Read the PMBR */ 590 buf = g_read_data(cp, 0, pp->sectorsize, &error); 591 if (buf == NULL) 592 return (error); 593 bcopy(buf, table->mbr, MBRSIZE); 594 g_free(buf); 595 596 /* Read the primary header and table. */ 597 gpt_read_hdr(table, cp, GPT_ELT_PRIHDR, &prihdr); 598 if (table->state[GPT_ELT_PRIHDR] == GPT_STATE_OK) { 599 pritbl = gpt_read_tbl(table, cp, GPT_ELT_PRITBL, &prihdr); 600 } else { 601 table->state[GPT_ELT_PRITBL] = GPT_STATE_MISSING; 602 pritbl = NULL; 603 } 604 605 /* Read the secondary header and table. */ 606 gpt_read_hdr(table, cp, GPT_ELT_SECHDR, &sechdr); 607 if (table->state[GPT_ELT_SECHDR] == GPT_STATE_OK) { 608 sectbl = gpt_read_tbl(table, cp, GPT_ELT_SECTBL, &sechdr); 609 } else { 610 table->state[GPT_ELT_SECTBL] = GPT_STATE_MISSING; 611 sectbl = NULL; 612 } 613 614 /* Fail if we haven't got any good tables at all. */ 615 if (table->state[GPT_ELT_PRITBL] != GPT_STATE_OK && 616 table->state[GPT_ELT_SECTBL] != GPT_STATE_OK) { 617 printf("GEOM: %s: corrupt or invalid GPT detected.\n", 618 pp->name); 619 printf("GEOM: %s: GPT rejected -- may not be recoverable.\n", 620 pp->name); 621 return (EINVAL); 622 } 623 624 /* 625 * If both headers are good but they disagree with each other, 626 * then invalidate one. We prefer to keep the primary header, 627 * unless the primary table is corrupt. 628 */ 629 if (table->state[GPT_ELT_PRIHDR] == GPT_STATE_OK && 630 table->state[GPT_ELT_SECHDR] == GPT_STATE_OK && 631 !gpt_matched_hdrs(&prihdr, &sechdr)) { 632 if (table->state[GPT_ELT_PRITBL] == GPT_STATE_OK) { 633 table->state[GPT_ELT_SECHDR] = GPT_STATE_INVALID; 634 table->state[GPT_ELT_SECTBL] = GPT_STATE_MISSING; 635 } else { 636 table->state[GPT_ELT_PRIHDR] = GPT_STATE_INVALID; 637 table->state[GPT_ELT_PRITBL] = GPT_STATE_MISSING; 638 } 639 } 640 641 if (table->state[GPT_ELT_PRITBL] != GPT_STATE_OK) { 642 printf("GEOM: %s: the primary GPT table is corrupt or " 643 "invalid.\n", pp->name); 644 printf("GEOM: %s: using the secondary instead -- recovery " 645 "strongly advised.\n", pp->name); 646 table->hdr = sechdr; 647 tbl = sectbl; 648 if (pritbl != NULL) 649 g_free(pritbl); 650 } else { 651 if (table->state[GPT_ELT_SECTBL] != GPT_STATE_OK) { 652 printf("GEOM: %s: the secondary GPT table is corrupt " 653 "or invalid.\n", pp->name); 654 printf("GEOM: %s: using the primary only -- recovery " 655 "suggested.\n", pp->name); 656 } 657 table->hdr = prihdr; 658 tbl = pritbl; 659 if (sectbl != NULL) 660 g_free(sectbl); 661 } 662 663 basetable->gpt_first = table->hdr.hdr_lba_start; 664 basetable->gpt_last = table->hdr.hdr_lba_end; 665 basetable->gpt_entries = table->hdr.hdr_entries; 666 667 for (index = basetable->gpt_entries - 1; index >= 0; index--) { 668 if (EQUUID(&tbl[index].ent_type, &gpt_uuid_unused)) 669 continue; 670 entry = (struct g_part_gpt_entry *)g_part_new_entry(basetable, 671 index+1, tbl[index].ent_lba_start, tbl[index].ent_lba_end); 672 entry->ent = tbl[index]; 673 } 674 675 g_free(tbl); 676 return (0); 677} 678 679static const char * 680g_part_gpt_type(struct g_part_table *basetable, struct g_part_entry *baseentry, 681 char *buf, size_t bufsz) 682{ 683 struct g_part_gpt_entry *entry; 684 struct uuid *type; 685 686 entry = (struct g_part_gpt_entry *)baseentry; 687 type = &entry->ent.ent_type; 688 if (EQUUID(type, &gpt_uuid_efi)) 689 return (g_part_alias_name(G_PART_ALIAS_EFI)); 690 if (EQUUID(type, &gpt_uuid_freebsd)) 691 return (g_part_alias_name(G_PART_ALIAS_FREEBSD)); 692 if (EQUUID(type, &gpt_uuid_freebsd_boot)) 693 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_BOOT)); 694 if (EQUUID(type, &gpt_uuid_freebsd_swap)) 695 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP)); 696 if (EQUUID(type, &gpt_uuid_freebsd_ufs)) 697 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS)); 698 if (EQUUID(type, &gpt_uuid_freebsd_vinum)) 699 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM)); 700 if (EQUUID(type, &gpt_uuid_freebsd_zfs)) 701 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS)); 702 if (EQUUID(type, &gpt_uuid_mbr)) 703 return (g_part_alias_name(G_PART_ALIAS_MBR)); 704 buf[0] = '!'; 705 snprintf_uuid(buf + 1, bufsz - 1, type); 706 return (buf); 707} 708 709static int 710g_part_gpt_write(struct g_part_table *basetable, struct g_consumer *cp) 711{ 712 unsigned char *buf, *bp; 713 struct g_provider *pp; 714 struct g_part_entry *baseentry; 715 struct g_part_gpt_entry *entry; 716 struct g_part_gpt_table *table; 717 size_t tlbsz; 718 uint32_t crc; 719 int error, index; 720 721 pp = cp->provider; 722 table = (struct g_part_gpt_table *)basetable; 723 tlbsz = (table->hdr.hdr_entries * table->hdr.hdr_entsz + 724 pp->sectorsize - 1) / pp->sectorsize; 725 726 /* Write the PMBR */ 727 buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO); 728 bcopy(table->mbr, buf, MBRSIZE); 729 error = g_write_data(cp, 0, buf, pp->sectorsize); 730 g_free(buf); 731 if (error) 732 return (error); 733 734 /* Allocate space for the header and entries. */ 735 buf = g_malloc((tlbsz + 1) * pp->sectorsize, M_WAITOK | M_ZERO); 736 737 memcpy(buf, table->hdr.hdr_sig, sizeof(table->hdr.hdr_sig)); 738 le32enc(buf + 8, table->hdr.hdr_revision); 739 le32enc(buf + 12, table->hdr.hdr_size); 740 le64enc(buf + 40, table->hdr.hdr_lba_start); 741 le64enc(buf + 48, table->hdr.hdr_lba_end); 742 le_uuid_enc(buf + 56, &table->hdr.hdr_uuid); 743 le32enc(buf + 80, table->hdr.hdr_entries); 744 le32enc(buf + 84, table->hdr.hdr_entsz); 745 746 LIST_FOREACH(baseentry, &basetable->gpt_entry, gpe_entry) { 747 if (baseentry->gpe_deleted) 748 continue; 749 entry = (struct g_part_gpt_entry *)baseentry; 750 index = baseentry->gpe_index - 1; 751 bp = buf + pp->sectorsize + table->hdr.hdr_entsz * index; 752 le_uuid_enc(bp, &entry->ent.ent_type); 753 le_uuid_enc(bp + 16, &entry->ent.ent_uuid); 754 le64enc(bp + 32, entry->ent.ent_lba_start); 755 le64enc(bp + 40, entry->ent.ent_lba_end); 756 le64enc(bp + 48, entry->ent.ent_attr); 757 memcpy(bp + 56, entry->ent.ent_name, 758 sizeof(entry->ent.ent_name)); 759 } 760 761 crc = crc32(buf + pp->sectorsize, 762 table->hdr.hdr_entries * table->hdr.hdr_entsz); 763 le32enc(buf + 88, crc); 764 765 /* Write primary meta-data. */ 766 le32enc(buf + 16, 0); /* hdr_crc_self. */ 767 le64enc(buf + 24, table->lba[GPT_ELT_PRIHDR]); /* hdr_lba_self. */ 768 le64enc(buf + 32, table->lba[GPT_ELT_SECHDR]); /* hdr_lba_alt. */ 769 le64enc(buf + 72, table->lba[GPT_ELT_PRITBL]); /* hdr_lba_table. */ 770 crc = crc32(buf, table->hdr.hdr_size); 771 le32enc(buf + 16, crc); 772 773 error = g_write_data(cp, table->lba[GPT_ELT_PRITBL] * pp->sectorsize, 774 buf + pp->sectorsize, tlbsz * pp->sectorsize); 775 if (error) 776 goto out; 777 error = g_write_data(cp, table->lba[GPT_ELT_PRIHDR] * pp->sectorsize, 778 buf, pp->sectorsize); 779 if (error) 780 goto out; 781 782 /* Write secondary meta-data. */ 783 le32enc(buf + 16, 0); /* hdr_crc_self. */ 784 le64enc(buf + 24, table->lba[GPT_ELT_SECHDR]); /* hdr_lba_self. */ 785 le64enc(buf + 32, table->lba[GPT_ELT_PRIHDR]); /* hdr_lba_alt. */ 786 le64enc(buf + 72, table->lba[GPT_ELT_SECTBL]); /* hdr_lba_table. */ 787 crc = crc32(buf, table->hdr.hdr_size); 788 le32enc(buf + 16, crc); 789 790 error = g_write_data(cp, table->lba[GPT_ELT_SECTBL] * pp->sectorsize, 791 buf + pp->sectorsize, tlbsz * pp->sectorsize); 792 if (error) 793 goto out; 794 error = g_write_data(cp, table->lba[GPT_ELT_SECHDR] * pp->sectorsize, 795 buf, pp->sectorsize); 796 797 out: 798 g_free(buf); 799 return (error); 800} 801 802static void 803g_gpt_printf_utf16(struct sbuf *sb, uint16_t *str, size_t len) 804{ 805 u_int bo; 806 uint32_t ch; 807 uint16_t c; 808 809 bo = LITTLE_ENDIAN; /* GPT is little-endian */ 810 while (len > 0 && *str != 0) { 811 ch = (bo == BIG_ENDIAN) ? be16toh(*str) : le16toh(*str); 812 str++, len--; 813 if ((ch & 0xf800) == 0xd800) { 814 if (len > 0) { 815 c = (bo == BIG_ENDIAN) ? be16toh(*str) 816 : le16toh(*str); 817 str++, len--; 818 } else 819 c = 0xfffd; 820 if ((ch & 0x400) == 0 && (c & 0xfc00) == 0xdc00) { 821 ch = ((ch & 0x3ff) << 10) + (c & 0x3ff); 822 ch += 0x10000; 823 } else 824 ch = 0xfffd; 825 } else if (ch == 0xfffe) { /* BOM (U+FEFF) swapped. */ 826 bo = (bo == BIG_ENDIAN) ? LITTLE_ENDIAN : BIG_ENDIAN; 827 continue; 828 } else if (ch == 0xfeff) /* BOM (U+FEFF) unswapped. */ 829 continue; 830 831 /* Write the Unicode character in UTF-8 */ 832 if (ch < 0x80) 833 sbuf_printf(sb, "%c", ch); 834 else if (ch < 0x800) 835 sbuf_printf(sb, "%c%c", 0xc0 | (ch >> 6), 836 0x80 | (ch & 0x3f)); 837 else if (ch < 0x10000) 838 sbuf_printf(sb, "%c%c%c", 0xe0 | (ch >> 12), 839 0x80 | ((ch >> 6) & 0x3f), 0x80 | (ch & 0x3f)); 840 else if (ch < 0x200000) 841 sbuf_printf(sb, "%c%c%c%c", 0xf0 | (ch >> 18), 842 0x80 | ((ch >> 12) & 0x3f), 843 0x80 | ((ch >> 6) & 0x3f), 0x80 | (ch & 0x3f)); 844 } 845} 846 847static void 848g_gpt_utf8_to_utf16(const uint8_t *s8, uint16_t *s16, size_t s16len) 849{ 850 size_t s16idx, s8idx; 851 uint32_t utfchar; 852 unsigned int c, utfbytes; 853 854 s8idx = s16idx = 0; 855 utfchar = 0; 856 utfbytes = 0; 857 bzero(s16, s16len << 1); 858 while (s8[s8idx] != 0 && s16idx < s16len) { 859 c = s8[s8idx++]; 860 if ((c & 0xc0) != 0x80) { 861 /* Initial characters. */ 862 if (utfbytes != 0) { 863 /* Incomplete encoding of previous char. */ 864 s16[s16idx++] = htole16(0xfffd); 865 } 866 if ((c & 0xf8) == 0xf0) { 867 utfchar = c & 0x07; 868 utfbytes = 3; 869 } else if ((c & 0xf0) == 0xe0) { 870 utfchar = c & 0x0f; 871 utfbytes = 2; 872 } else if ((c & 0xe0) == 0xc0) { 873 utfchar = c & 0x1f; 874 utfbytes = 1; 875 } else { 876 utfchar = c & 0x7f; 877 utfbytes = 0; 878 } 879 } else { 880 /* Followup characters. */ 881 if (utfbytes > 0) { 882 utfchar = (utfchar << 6) + (c & 0x3f); 883 utfbytes--; 884 } else if (utfbytes == 0) 885 utfbytes = ~0; 886 } 887 /* 888 * Write the complete Unicode character as UTF-16 when we 889 * have all the UTF-8 charactars collected. 890 */ 891 if (utfbytes == 0) { 892 /* 893 * If we need to write 2 UTF-16 characters, but 894 * we only have room for 1, then we truncate the 895 * string by writing a 0 instead. 896 */ 897 if (utfchar >= 0x10000 && s16idx < s16len - 1) { 898 s16[s16idx++] = 899 htole16(0xd800 | ((utfchar >> 10) - 0x40)); 900 s16[s16idx++] = 901 htole16(0xdc00 | (utfchar & 0x3ff)); 902 } else 903 s16[s16idx++] = (utfchar >= 0x10000) ? 0 : 904 htole16(utfchar); 905 } 906 } 907 /* 908 * If our input string was truncated, append an invalid encoding 909 * character to the output string. 910 */ 911 if (utfbytes != 0 && s16idx < s16len) 912 s16[s16idx++] = htole16(0xfffd); 913} 914