daemon/parted.c

   1 /* libguestfs - the guestfsd daemon
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <config.h>
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <stdint.h>
  24 #include <inttypes.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27
  28 #include "daemon.h"
  29 #include "actions.h"
  30
  31 /* Notes:
  32  *
  33  * Parted 1.9 sends error messages to stdout, hence use of the
  34  * COMMAND_FLAG_FOLD_STDOUT_ON_STDERR flag.
  35  *
  36  * parted occasionally fails to do ioctl(BLKRRPART) on the device,
  37  * apparently because of some internal race in the code.  We attempt
  38  * to detect and recover from this error if we can.
  39  */
  40 static int
  41 recover_blkrrpart (const char *device, const char *err)
  42 {
  43   int r;
  44
  45   if (!strstr (err,
  46                "Error informing the kernel about modifications to partition"))
  47     return -1;
  48
  49   r = command (NULL, NULL, "blockdev", "--rereadpt", device, NULL);
  50   if (r == -1)
  51     return -1;
  52
  53   udev_settle ();
  54
  55   return 0;
  56 }
  57
  58 #define RUN_PARTED(error,device,...)                                    \
  59   do {                                                                  \
  60     int r;                                                              \
  61     char *err;                                                          \
  62                                                                         \
  63     r = commandf (NULL, &err, COMMAND_FLAG_FOLD_STDOUT_ON_STDERR,       \
  64                   "parted", "-s", "--", (device), __VA_ARGS__);   \
  65     if (r == -1) {                                                      \
  66       if (recover_blkrrpart ((device), err) == -1) {                    \
  67         reply_with_error ("%s: parted: %s: %s", __func__, (device), err); \
  68         free (err);                                                     \
  69         error;                                                          \
  70       }                                                                 \
  71     }                                                                   \
  72                                                                         \
  73     free (err);                                                         \
  74   } while (0)
  75
  76 static const char *
  77 check_parttype (const char *parttype)
  78 {
  79   /* Check and translate parttype. */
  80   if (STREQ (parttype, "aix") ||
  81       STREQ (parttype, "amiga") ||
  82       STREQ (parttype, "bsd") ||
  83       STREQ (parttype, "dasd") ||
  84       STREQ (parttype, "dvh") ||
  85       STREQ (parttype, "gpt") ||
  86       STREQ (parttype, "mac") ||
  87       STREQ (parttype, "msdos") ||
  88       STREQ (parttype, "pc98") ||
  89       STREQ (parttype, "sun"))
  90     return parttype;
  91   else if (STREQ (parttype, "rdb"))
  92     return "amiga";
  93   else if (STREQ (parttype, "efi"))
  94     return "gpt";
  95   else if (STREQ (parttype, "mbr"))
  96     return "msdos";
  97   else
  98     return NULL;
  99 }
 100
 101 int
 102 do_part_init (const char *device, const char *parttype)
 103 {
 104   parttype = check_parttype (parttype);
 105   if (!parttype) {
 106     reply_with_error ("unknown partition type: common choices are \"gpt\" and \"msdos\"");
 107     return -1;
 108   }
 109
 110   RUN_PARTED (return -1, device, "mklabel", parttype, NULL);
 111
 112   udev_settle ();
 113
 114   return 0;
 115 }
 116
 117 int
 118 do_part_add (const char *device, const char *prlogex,
 119              int64_t startsect, int64_t endsect)
 120 {
 121   char startstr[32];
 122   char endstr[32];
 123
 124   /* Check and translate prlogex. */
 125   if (STREQ (prlogex, "primary") ||
 126       STREQ (prlogex, "logical") ||
 127       STREQ (prlogex, "extended"))
 128     ;
 129   else if (STREQ (prlogex, "p"))
 130     prlogex = "primary";
 131   else if (STREQ (prlogex, "l"))
 132     prlogex = "logical";
 133   else if (STREQ (prlogex, "e"))
 134     prlogex = "extended";
 135   else {
 136     reply_with_error ("unknown partition type: %s: this should be \"primary\", \"logical\" or \"extended\"", prlogex);
 137     return -1;
 138   }
 139
 140   if (startsect < 0) {
 141     reply_with_error ("startsect cannot be negative");
 142     return -1;
 143   }
 144   /* but endsect can be negative */
 145
 146   snprintf (startstr, sizeof startstr, "%" PRIi64 "s", startsect);
 147   snprintf (endstr, sizeof endstr, "%" PRIi64 "s", endsect);
 148
 149   /* XXX Bug: If the partition table type (which we don't know in this
 150    * function) is GPT, then this parted command sets the _partition
 151    * name_ to prlogex, eg. "primary".  I would essentially describe
 152    * this as a bug in the parted mkpart command.
 153    */
 154   RUN_PARTED (return -1, device, "mkpart", prlogex, startstr, endstr, NULL);
 155
 156   udev_settle ();
 157
 158   return 0;
 159 }
 160
 161 int
 162 do_part_del (const char *device, int partnum)
 163 {
 164   if (partnum <= 0) {
 165     reply_with_error ("partition number must be >= 1");
 166     return -1;
 167   }
 168
 169   char partnum_str[16];
 170   snprintf (partnum_str, sizeof partnum_str, "%d", partnum);
 171
 172   RUN_PARTED (return -1, device, "rm", partnum_str, NULL);
 173
 174   udev_settle ();
 175   return 0;
 176 }
 177
 178 int
 179 do_part_disk (const char *device, const char *parttype)
 180 {
 181   parttype = check_parttype (parttype);
 182   if (!parttype) {
 183     reply_with_error ("unknown partition type: common choices are \"gpt\" and \"msdos\"");
 184     return -1;
 185   }
 186
 187   /* Align all partitions created this way to 64 sectors, and leave
 188    * the last 64 sectors at the end of the disk free.  This wastes
 189    * 32K+32K = 64K on 512-byte sector disks.  The rationale is:
 190    *
 191    * - aligned operations are faster
 192    * - GPT requires at least 34 sectors at the end of the disk.
 193    */
 194   const char *startstr = "64s";
 195   const char *endstr = "-64s";
 196
 197   RUN_PARTED (return -1,
 198               device,
 199               "mklabel", parttype,
 200               /* See comment about about the parted mkpart command. */
 201               "mkpart", STREQ (parttype, "gpt") ? "p1" : "primary",
 202               startstr, endstr, NULL);
 203
 204   udev_settle ();
 205
 206   return 0;
 207 }
 208
 209 int
 210 do_part_set_bootable (const char *device, int partnum, int bootable)
 211 {
 212   if (partnum <= 0) {
 213     reply_with_error ("partition number must be >= 1");
 214     return -1;
 215   }
 216
 217   char partstr[16];
 218
 219   snprintf (partstr, sizeof partstr, "%d", partnum);
 220
 221   RUN_PARTED (return -1,
 222               device, "set", partstr, "boot", bootable ? "on" : "off", NULL);
 223
 224   udev_settle ();
 225
 226   return 0;
 227 }
 228
 229 int
 230 do_part_set_name (const char *device, int partnum, const char *name)
 231 {
 232   if (partnum <= 0) {
 233     reply_with_error ("partition number must be >= 1");
 234     return -1;
 235   }
 236
 237   char partstr[16];
 238
 239   snprintf (partstr, sizeof partstr, "%d", partnum);
 240
 241   RUN_PARTED (return -1, device, "name", partstr, name, NULL);
 242
 243   udev_settle ();
 244
 245   return 0;
 246 }
 247
 248 /* Return the nth field from a string of ':'/';'-delimited strings.
 249  * Useful for parsing the return value from 'parted -m'.
 250  */
 251 static char *
 252 get_table_field (const char *line, int n)
 253 {
 254   const char *p = line;
 255
 256   while (*p && n > 0) {
 257     p += strcspn (p, ":;") + 1;
 258     n--;
 259   }
 260
 261   if (n > 0) {
 262     reply_with_error ("not enough fields in output of parted print command: %s",
 263                       line);
 264     return NULL;
 265   }
 266
 267   size_t len = strcspn (p, ":;");
 268   char *q = strndup (p, len);
 269   if (q == NULL) {
 270     reply_with_perror ("strndup");
 271     return NULL;
 272   }
 273
 274   return q;
 275 }
 276
 277 /* RHEL 5 parted doesn't have the -m (machine readable) option so we
 278  * must do a lot more work to parse the output in
 279  * print_partition_table below.  Test for this option the first time
 280  * this function is called.
 281  */
 282 static int
 283 test_parted_m_opt (void)
 284 {
 285   static int result = -1;
 286
 287   if (result >= 0)
 288     return result;
 289
 290   if (verbose)
 291     fprintf (stderr, "Testing if this parted supports '-m' option.\n");
 292
 293   char *err = NULL;
 294   int r = commandr (NULL, &err, "parted", "-s", "-m", "/dev/null", NULL);
 295   if (r == -1) {
 296     /* Test failed, eg. missing or completely unusable parted binary. */
 297     reply_with_error ("could not run 'parted' command");
 298     return -1;
 299   }
 300
 301   if (err && strstr (err, "invalid option -- m"))
 302     return result = 0;
 303
 304   return result = 1;
 305 }
 306
 307 static char *
 308 print_partition_table (const char *device, int parted_has_m_opt)
 309 {
 310   char *out, *err;
 311   int r;
 312
 313   if (parted_has_m_opt)
 314     r = command (&out, &err, "parted", "-m", "--", device,
 315                  "unit", "b",
 316                  "print", NULL);
 317   else
 318     r = command (&out, &err, "parted", "-s", "--", device,
 319                  "unit", "b",
 320                  "print", NULL);
 321   if (r == -1) {
 322     reply_with_error ("parted print: %s: %s", device,
 323                       /* Hack for parted 1.x which sends errors to stdout. */
 324                       *err ? err : out);
 325     free (out);
 326     free (err);
 327     return NULL;
 328   }
 329   free (err);
 330
 331   if (verbose)
 332     fprintf (stderr, "parted output:\n%s<END>\n", out);
 333
 334   return out;
 335 }
 336
 337 char *
 338 do_part_get_parttype (const char *device)
 339 {
 340   int parted_has_m_opt = test_parted_m_opt ();
 341   if (parted_has_m_opt == -1)
 342     return NULL;
 343
 344   char *out = print_partition_table (device, parted_has_m_opt);
 345   if (!out)
 346     return NULL;
 347
 348   if (parted_has_m_opt) {
 349     /* New-style parsing using the "machine-readable" format from
 350      * 'parted -m'.
 351      */
 352     char **lines = split_lines (out);
 353     free (out);
 354
 355     if (!lines)
 356       return NULL;
 357
 358     if (lines[0] == NULL || STRNEQ (lines[0], "BYT;")) {
 359       reply_with_error ("unknown signature, expected \"BYT;\" as first line of the output: %s",
 360                         lines[0] ? lines[0] : "(signature was null)");
 361       free_strings (lines);
 362       return NULL;
 363     }
 364
 365     if (lines[1] == NULL) {
 366       reply_with_error ("parted didn't return a line describing the device");
 367       free_strings (lines);
 368       return NULL;
 369     }
 370
 371     /* lines[1] is something like:
 372      * "/dev/sda:1953525168s:scsi:512:512:msdos:ATA Hitachi HDT72101;"
 373      */
 374     char *r = get_table_field (lines[1], 5);
 375     if (r == NULL) {
 376       free_strings (lines);
 377       return NULL;
 378     }
 379
 380     free_strings (lines);
 381     return r;
 382   }
 383   else {
 384     /* Old-style.  Look for "\nPartition Table: <str>\n". */
 385     char *p = strstr (out, "\nPartition Table: ");
 386     if (!p) {
 387       reply_with_error ("parted didn't return Partition Table line");
 388       free (out);
 389       return NULL;
 390     }
 391
 392     p += 18;
 393     char *q = strchr (p, '\n');
 394     if (!q) {
 395       reply_with_error ("parted Partition Table has no end of line char");
 396       free (out);
 397       return NULL;
 398     }
 399
 400     *q = '\0';
 401
 402     p = strdup (p);
 403     free (out);
 404     if (!p) {
 405       reply_with_perror ("strdup");
 406       return NULL;
 407     }
 408
 409     return p;                   /* caller frees */
 410   }
 411 }
 412
 413 guestfs_int_partition_list *
 414 do_part_list (const char *device)
 415 {
 416   int parted_has_m_opt = test_parted_m_opt ();
 417   if (parted_has_m_opt == -1)
 418     return NULL;
 419
 420   char *out = print_partition_table (device, parted_has_m_opt);
 421   if (!out)
 422     return NULL;
 423
 424   char **lines = split_lines (out);
 425   free (out);
 426
 427   if (!lines)
 428     return NULL;
 429
 430   guestfs_int_partition_list *r;
 431
 432   if (parted_has_m_opt) {
 433     /* New-style parsing using the "machine-readable" format from
 434      * 'parted -m'.
 435      *
 436      * lines[0] is "BYT;", lines[1] is the device line which we ignore,
 437      * lines[2..] are the partitions themselves.  Count how many.
 438      */
 439     size_t nr_rows = 0, row;
 440     for (row = 2; lines[row] != NULL; ++row)
 441       ++nr_rows;
 442
 443     r = malloc (sizeof *r);
 444     if (r == NULL) {
 445       reply_with_perror ("malloc");
 446       goto error1;
 447     }
 448     r->guestfs_int_partition_list_len = nr_rows;
 449     r->guestfs_int_partition_list_val =
 450       malloc (nr_rows * sizeof (guestfs_int_partition));
 451     if (r->guestfs_int_partition_list_val == NULL) {
 452       reply_with_perror ("malloc");
 453       goto error2;
 454     }
 455
 456     /* Now parse the lines. */
 457     size_t i;
 458     for (i = 0, row = 2; lines[row] != NULL; ++i, ++row) {
 459       if (sscanf (lines[row], "%d:%" SCNi64 "B:%" SCNi64 "B:%" SCNi64 "B",
 460                   &r->guestfs_int_partition_list_val[i].part_num,
 461                   &r->guestfs_int_partition_list_val[i].part_start,
 462                   &r->guestfs_int_partition_list_val[i].part_end,
 463                   &r->guestfs_int_partition_list_val[i].part_size) != 4) {
 464         reply_with_error ("could not parse row from output of parted print command: %s", lines[row]);
 465         goto error3;
 466       }
 467     }
 468   }
 469   else {
 470     /* Old-style.  Start at the line following "^Number", up to the
 471      * next blank line.
 472      */
 473     size_t start = 0, end = 0, row;
 474
 475     for (row = 0; lines[row] != NULL; ++row)
 476       if (STRPREFIX (lines[row], "Number")) {
 477         start = row+1;
 478         break;
 479       }
 480
 481     if (start == 0) {
 482       reply_with_error ("parted output has no \"Number\" line");
 483       goto error1;
 484     }
 485
 486     for (row = start; lines[row] != NULL; ++row)
 487       if (STREQ (lines[row], "")) {
 488         end = row;
 489         break;
 490       }
 491
 492     if (end == 0) {
 493       reply_with_error ("parted output has no blank after end of table");
 494       goto error1;
 495     }
 496
 497     size_t nr_rows = end - start;
 498
 499     r = malloc (sizeof *r);
 500     if (r == NULL) {
 501       reply_with_perror ("malloc");
 502       goto error1;
 503     }
 504     r->guestfs_int_partition_list_len = nr_rows;
 505     r->guestfs_int_partition_list_val =
 506       malloc (nr_rows * sizeof (guestfs_int_partition));
 507     if (r->guestfs_int_partition_list_val == NULL) {
 508       reply_with_perror ("malloc");
 509       goto error2;
 510     }
 511
 512     /* Now parse the lines. */
 513     size_t i;
 514     for (i = 0, row = start; row < end; ++i, ++row) {
 515       if (sscanf (lines[row], " %d %" SCNi64 "B %" SCNi64 "B %" SCNi64 "B",
 516                   &r->guestfs_int_partition_list_val[i].part_num,
 517                   &r->guestfs_int_partition_list_val[i].part_start,
 518                   &r->guestfs_int_partition_list_val[i].part_end,
 519                   &r->guestfs_int_partition_list_val[i].part_size) != 4) {
 520         reply_with_error ("could not parse row from output of parted print command: %s", lines[row]);
 521         goto error3;
 522       }
 523     }
 524   }
 525
 526   free_strings (lines);
 527   return r;
 528
 529  error3:
 530   free (r->guestfs_int_partition_list_val);
 531  error2:
 532   free (r);
 533  error1:
 534   free_strings (lines);
 535   return NULL;
 536 }
 537
 538 int
 539 do_part_get_bootable (const char *device, int partnum)
 540 {
 541   if (partnum <= 0) {
 542     reply_with_error ("partition number must be >= 1");
 543     return -1;
 544   }
 545
 546   int parted_has_m_opt = test_parted_m_opt ();
 547   if (parted_has_m_opt == -1)
 548     return -1;
 549
 550   char *out = print_partition_table (device, parted_has_m_opt);
 551   if (!out)
 552     return -1;
 553
 554   char **lines = split_lines (out);
 555   free (out);
 556
 557   if (!lines)
 558     return -1;
 559
 560   if (parted_has_m_opt) {
 561     /* New-style parsing using the "machine-readable" format from
 562      * 'parted -m'.
 563      *
 564      * We want lines[1+partnum].
 565      */
 566     if (count_strings (lines) < (size_t) 1+partnum) {
 567       reply_with_error ("partition number out of range: %d", partnum);
 568       free_strings (lines);
 569       return -1;
 570     }
 571
 572     char *boot = get_table_field (lines[1+partnum], 6);
 573     if (boot == NULL) {
 574       free_strings (lines);
 575       return -1;
 576     }
 577
 578     int r = STREQ (boot, "boot");
 579
 580     free (boot);
 581     free_strings (lines);
 582
 583     return r;
 584   }
 585   else {
 586     /* Old-style: First look for the line matching "^Number". */
 587     size_t start = 0, header, row;
 588
 589     for (row = 0; lines[row] != NULL; ++row)
 590       if (STRPREFIX (lines[row], "Number")) {
 591         start = row+1;
 592         header = row;
 593         break;
 594       }
 595
 596     if (start == 0) {
 597       reply_with_error ("parted output has no \"Number\" line");
 598       free_strings (lines);
 599       return -1;
 600     }
 601
 602     /* Now we have to look at the column number of the "Flags" field.
 603      * This is because parted's output has no way to represent a
 604      * missing field except as whitespace, so we cannot just count
 605      * fields from the left.  eg. The "File system" field is often
 606      * missing in the output.
 607      */
 608     char *p = strstr (lines[header], "Flags");
 609     if (!p) {
 610       reply_with_error ("parted output has no \"Flags\" field");
 611       free_strings (lines);
 612       return -1;
 613     }
 614     size_t col = p - lines[header];
 615
 616     /* Look for the line corresponding to this partition number. */
 617     row = start + partnum - 1;
 618     if (row >= count_strings (lines) || !STRPREFIX (lines[row], " ")) {
 619       reply_with_error ("partition number out of range: %d", partnum);
 620       free_strings (lines);
 621       return -1;
 622     }
 623
 624     int r = STRPREFIX (&lines[row][col], "boot");
 625     free_strings (lines);
 626     return r;
 627   }
 628 }
 629
 630 /* Currently we use sfdisk for getting and setting the ID byte.  In
 631  * future, extend parted to provide this functionality.  As a result
 632  * of using sfdisk, this won't work for non-MBR-style partitions, but
 633  * that limitation is noted in the documentation and we can extend it
 634  * later without breaking the ABI.
 635  */
 636 int
 637 do_part_get_mbr_id (const char *device, int partnum)
 638 {
 639   if (partnum <= 0) {
 640     reply_with_error ("partition number must be >= 1");
 641     return -1;
 642   }
 643
 644   char partnum_str[16];
 645   snprintf (partnum_str, sizeof partnum_str, "%d", partnum);
 646
 647   char *out, *err;
 648   int r;
 649
 650   r = command (&out, &err, "sfdisk", "--print-id", device, partnum_str, NULL);
 651   if (r == -1) {
 652     reply_with_error ("sfdisk --print-id: %s", err);
 653     free (out);
 654     free (err);
 655     return -1;
 656   }
 657
 658   free (err);
 659
 660   /* It's printed in hex ... */
 661   int id;
 662   if (sscanf (out, "%x", &id) != 1) {
 663     reply_with_error ("sfdisk --print-id: cannot parse output: %s", out);
 664     free (out);
 665     return -1;
 666   }
 667
 668   free (out);
 669   return id;
 670 }
 671
 672 int
 673 do_part_set_mbr_id (const char *device, int partnum, int idbyte)
 674 {
 675   if (partnum <= 0) {
 676     reply_with_error ("partition number must be >= 1");
 677     return -1;
 678   }
 679
 680   char partnum_str[16];
 681   snprintf (partnum_str, sizeof partnum_str, "%d", partnum);
 682
 683   char idbyte_str[16];
 684   snprintf (idbyte_str, sizeof partnum_str, "%x", idbyte); /* NB: hex */
 685
 686   char *err;
 687   int r;
 688
 689   r = command (NULL, &err, "sfdisk",
 690                "--change-id", device, partnum_str, idbyte_str, NULL);
 691   if (r == -1) {
 692     reply_with_error ("sfdisk --change-id: %s", err);
 693     free (err);
 694     return -1;
 695   }
 696
 697   free (err);
 698   return 0;
 699 }