sbin/gpt/gpt.c

   1 /*
   2  * Copyright (c) 2002 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  * CRC32 code derived from work by Gary S. Brown.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/types.h>
  34 #include <sys/disk.h>
  35 #include <sys/stat.h>
  36 #include <sys/uuid.h>
  37 #include <sys/gpt.h>
  38
  39 #include <err.h>
  40 #include <errno.h>
  41 #include <fcntl.h>
  42 #include <stddef.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <unistd.h>
  47
  48 #include "map.h"
  49 #include "gpt.h"
  50
  51 char    device_name[MAXPATHLEN];
  52
  53 off_t   mediasz;
  54
  55 u_int   parts;
  56 u_int   secsz;
  57
  58 int     readonly, verbose;
  59
  60 static uint32_t crc32_tab[] = {
  61         0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
  62         0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
  63         0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
  64         0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
  65         0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
  66         0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
  67         0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
  68         0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
  69         0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
  70         0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
  71         0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
  72         0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
  73         0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
  74         0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
  75         0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
  76         0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
  77         0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
  78         0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
  79         0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
  80         0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
  81         0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
  82         0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
  83         0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
  84         0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
  85         0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
  86         0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
  87         0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
  88         0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
  89         0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
  90         0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
  91         0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
  92         0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
  93         0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
  94         0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
  95         0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
  96         0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
  97         0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
  98         0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
  99         0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
 100         0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
 101         0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
 102         0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
 103         0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
 104 };
 105
 106 uint32_t
 107 crc32(const void *buf, size_t size)
 108 {
 109         const uint8_t *p;
 110         uint32_t crc;
 111
 112         p = buf;
 113         crc = ~0U;
 114
 115         while (size--)
 116                 crc = crc32_tab[(crc ^ *p++) & 0xFF] ^ (crc >> 8);
 117
 118         return crc ^ ~0U;
 119 }
 120
 121 void
 122 unicode16(short *dst, const wchar_t *src, size_t len)
 123 {
 124         while (len-- && *src != 0)
 125                 *dst++ = *src++;
 126         if (len)
 127                 *dst = 0;
 128 }
 129
 130 static char *
 131 uuid_string(uuid_t *uuid)
 132 {
 133         static char buf[48];
 134
 135         sprintf(buf, "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
 136             uuid->time_low, uuid->time_mid, uuid->time_hi_and_version,
 137             uuid->clock_seq_hi_and_reserved, uuid->clock_seq_low,
 138             uuid->node[0], uuid->node[1], uuid->node[2], uuid->node[3],
 139             uuid->node[4], uuid->node[5]);
 140         return buf;
 141 }
 142
 143 void*
 144 gpt_read(int fd, off_t lba, size_t count)
 145 {
 146         off_t ofs;
 147         void *buf;
 148
 149         count *= secsz;
 150         buf = malloc(count);
 151         if (buf == NULL)
 152                 return (NULL);
 153
 154         ofs = lba * secsz;
 155         if (lseek(fd, ofs, SEEK_SET) == ofs &&
 156             read(fd, buf, count) == (ssize_t)count)
 157                 return (buf);
 158
 159         free(buf);
 160         return (NULL);
 161 }
 162
 163 int
 164 gpt_write(int fd, map_t *map)
 165 {
 166         off_t ofs;
 167         size_t count;
 168
 169         count = map->map_size * secsz;
 170         ofs = map->map_start * secsz;
 171         if (lseek(fd, ofs, SEEK_SET) == ofs &&
 172             write(fd, map->map_data, count) == (ssize_t)count)
 173                 return (0);
 174         return (-1);
 175 }
 176
 177 static int
 178 gpt_gpt(int fd, off_t lba)
 179 {
 180         off_t size;
 181         struct gpt_ent *ent;
 182         struct gpt_hdr *hdr;
 183         char *p;
 184         map_t *m;
 185         size_t blocks, tblsz;
 186         unsigned int i;
 187         uint32_t crc;
 188
 189         hdr = gpt_read(fd, lba, 1);
 190         if (hdr == NULL)
 191                 return (-1);
 192
 193         if (memcmp(hdr->hdr_sig, GPT_HDR_SIG, sizeof(hdr->hdr_sig)))
 194                 goto fail_hdr;
 195
 196         crc = hdr->hdr_crc_self;
 197         hdr->hdr_crc_self = 0;
 198         if (crc32(hdr, hdr->hdr_size) != crc) {
 199                 if (verbose)
 200                         warnx("%s: Bad CRC in GPT header at sector %llu",
 201                             device_name, (long long)lba);
 202                 goto fail_hdr;
 203         }
 204
 205         tblsz = hdr->hdr_entries * hdr->hdr_entsz;
 206         blocks = tblsz / secsz + ((tblsz % secsz) ? 1 : 0);
 207
 208         /* Use generic pointer to deal with hdr->hdr_entsz != sizeof(*ent). */
 209         p = gpt_read(fd, hdr->hdr_lba_table, blocks);
 210         if (p == NULL)
 211                 return (-1);
 212
 213         if (crc32(p, tblsz) != hdr->hdr_crc_table) {
 214                 if (verbose)
 215                         warnx("%s: Bad CRC in GPT table at sector %llu",
 216                             device_name, (long long)hdr->hdr_lba_table);
 217                 goto fail_ent;
 218         }
 219
 220         if (verbose > 1)
 221                 warnx("%s: %s GPT at sector %llu", device_name,
 222                     (lba == 1) ? "Pri" : "Sec", (long long)lba);
 223
 224         m = map_add(lba, 1, (lba == 1)
 225             ? MAP_TYPE_PRI_GPT_HDR : MAP_TYPE_SEC_GPT_HDR, hdr);
 226         if (m == NULL)
 227                 return (-1);
 228
 229         m = map_add(hdr->hdr_lba_table, blocks, (lba == 1)
 230             ? MAP_TYPE_PRI_GPT_TBL : MAP_TYPE_SEC_GPT_TBL, p);
 231         if (m == NULL)
 232                 return (-1);
 233
 234         if (lba != 1)
 235                 return (0);
 236
 237         for (i = 0; i < hdr->hdr_entries; i++) {
 238                 uuid_t unused = GPT_ENT_TYPE_UNUSED;
 239
 240                 ent = (void*)(p + i * hdr->hdr_entsz);
 241                 if (!memcmp(&ent->ent_type, &unused, sizeof(uuid_t)))
 242                         continue;
 243
 244                 size = ent->ent_lba_end - ent->ent_lba_start + 1LL;
 245
 246                 if (verbose > 2)
 247                         warnx(
 248         "%s: GPT partition: type=%s, start=%llu, size=%llu",
 249                             device_name, uuid_string(&ent->ent_type),
 250                             (long long)ent->ent_lba_start, (long long)size);
 251                 m = map_add(ent->ent_lba_start, size, MAP_TYPE_GPT_PART, NULL);
 252                 if (m == NULL)
 253                         return (-1);
 254         }
 255         return (0);
 256
 257  fail_ent:
 258         free(p);
 259
 260  fail_hdr:
 261         free(hdr);
 262         return (0);
 263 }
 264
 265 int
 266 gpt_open(const char *dev)
 267 {
 268         struct stat sb;
 269         struct mbr *mbr;
 270         map_t *m;
 271         uint32_t size, start;
 272         unsigned int i;
 273         int fd;
 274
 275         if (!stat(dev, &sb)) {
 276                 strlcpy(device_name, dev, sizeof(device_name));
 277                 goto found;
 278         }
 279
 280         snprintf(device_name, sizeof(device_name), "/dev/%s", dev);
 281         if (!stat(device_name, &sb))
 282                 goto found;
 283
 284         strlcpy(device_name, dev, sizeof(device_name));
 285         return (-1);
 286
 287  found:
 288         fd = open(device_name, (readonly) ? O_RDONLY : O_RDWR|O_EXCL);
 289         if (fd == -1)
 290                 return (-1);
 291
 292         if ((sb.st_mode & S_IFMT) != S_IFREG) {
 293                 if (ioctl(fd, DIOCGSECTORSIZE, &secsz) == -1 ||
 294                     ioctl(fd, DIOCGMEDIASIZE, &mediasz) == -1)
 295                         goto close;
 296         } else {
 297                 secsz = 512;    /* Fixed size for files. */
 298                 if (sb.st_size % secsz) {
 299                         errno = EINVAL;
 300                         goto close;
 301                 }
 302                 mediasz = sb.st_size;
 303         }
 304
 305         /*
 306          * We require an absolute minimum of 6 sectors. One for the MBR,
 307          * 2 for the GPT header, 2 for the GPT table and one to hold some
 308          * user data. Let's catch this extreme border case here so that
 309          * we don't have to worry about it later.
 310          */
 311         if (mediasz / secsz < 6) {
 312                 errno = ENODEV;
 313                 goto close;
 314         }
 315
 316         if (verbose)
 317                 warnx("%s: mediasize=%llu; sectorsize=%u; blocks=%llu",
 318                     device_name, (long long)mediasz, secsz,
 319                     (long long)(mediasz / secsz));
 320
 321         map_init(mediasz / secsz);
 322
 323         /*
 324          * MBR
 325          */
 326         mbr = gpt_read(fd, 0LL, 1);
 327         if (mbr == NULL)
 328                 goto close;
 329
 330         if (mbr->mbr_sig == MBR_SIG) {
 331                 if (verbose > 1)
 332                         warnx("%s: MBR at sector 0", device_name);
 333                 m = map_add(0LL, 1LL, MAP_TYPE_MBR, mbr);
 334                 if (m == NULL)
 335                         goto close;
 336                 for (i = 0; i < 4; i++) {
 337                         start = mbr->mbr_part[i].part_start_hi;
 338                         start = (start << 16) + mbr->mbr_part[i].part_start_lo;
 339                         size = mbr->mbr_part[i].part_size_hi;
 340                         size = (size << 16) + mbr->mbr_part[i].part_size_lo;
 341                         if (start != 0 || size != 0) {
 342                                 if (verbose > 2)
 343                                         warnx(
 344         "%s: MBR partition: type=%d, start=%llu, size=%llu", device_name,
 345                                             mbr->mbr_part[i].part_typ,
 346                                             (long long)start, (long long)size);
 347                                 if (mbr->mbr_part[i].part_typ != 0xee) {
 348                                         m = map_add(start, size,
 349                                             MAP_TYPE_MBR_PART, NULL);
 350                                         if (m == NULL)
 351                                                 goto close;
 352                                 }
 353                         }
 354                 }
 355         } else {
 356                 if (verbose)
 357                         warnx("%s: MBR not found", device_name);
 358                 free(mbr);
 359         }
 360
 361         /*
 362          * GPT
 363          */
 364         if (gpt_gpt(fd, 1LL) == -1)
 365                 goto close;
 366         if (gpt_gpt(fd, mediasz / secsz - 1LL) == -1)
 367                 goto close;
 368
 369         return (fd);
 370
 371  close:
 372         close(fd);
 373         return (-1);
 374 }
 375
 376 void
 377 gpt_close(int fd)
 378 {
 379         /* XXX post processing? */
 380         close(fd);
 381 }
 382
 383 static struct {
 384         int (*fptr)(int, char *[]);
 385         const char *name;
 386 } cmdsw[] = {
 387         { NULL, "add" },
 388         { NULL, "create" },
 389         { NULL, "delete" },
 390         { cmd_destroy, "destroy" },
 391         { NULL, "help" },
 392         { cmd_migrate, "migrate" },
 393         { cmd_recover, "recover" },
 394         { NULL, "rename" },
 395         { cmd_show, "show" },
 396         { NULL, "verify" },
 397         { NULL, NULL }
 398 };
 399
 400 static void
 401 usage(void)
 402 {
 403
 404         fprintf(stderr,
 405             "usage: %s [-rv] [-p nparts] command [options] device\n",
 406             getprogname());
 407         exit(1);
 408 }
 409
 410 static void
 411 prefix(const char *cmd)
 412 {
 413         char *pfx;
 414         const char *prg;
 415
 416         prg = getprogname();
 417         pfx = malloc(strlen(prg) + strlen(cmd) + 2);
 418         /* Don't bother failing. It's not important */
 419         if (pfx == NULL)
 420                 return;
 421
 422         sprintf(pfx, "%s %s", prg, cmd);
 423         setprogname(pfx);
 424 }
 425
 426 int
 427 main(int argc, char *argv[])
 428 {
 429         char *cmd, *p;
 430         int ch, i;
 431
 432         /* Get the generic options */
 433         while ((ch = getopt(argc, argv, "p:rv")) != -1) {
 434                 switch(ch) {
 435                 case 'p':
 436                         if (parts > 0)
 437                                 usage();
 438                         parts = strtol(optarg, &p, 10);
 439                         if (*p != 0 || parts < 1)
 440                                 usage();
 441                         break;
 442                 case 'r':
 443                         readonly = 1;
 444                         break;
 445                 case 'v':
 446                         verbose++;
 447                         break;
 448                 default:
 449                         usage();
 450                 }
 451         }
 452         if (!parts)
 453                 parts = 128;
 454
 455         if (argc == optind)
 456                 usage();
 457
 458         cmd = argv[optind++];
 459         for (i = 0; cmdsw[i].name != NULL && strcmp(cmd, cmdsw[i].name); i++);
 460
 461         if (cmdsw[i].fptr == NULL)
 462                 errx(1, "unknown command: %s", cmd);
 463
 464         prefix(cmd);
 465         return ((*cmdsw[i].fptr)(argc, argv));
 466 }