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
 382     /* If "loop" return an error (RHBZ#634246). */
 383     if (STREQ (r, "loop")) {
 384       free (r);
 385       reply_with_error ("not a partitioned device");
 386       return NULL;
 387     }
 388
 389     return r;
 390   }
 391   else {
 392     /* Old-style.  Look for "\nPartition Table: <str>\n". */
 393     char *p = strstr (out, "\nPartition Table: ");
 394     if (!p) {
 395       reply_with_error ("parted didn't return Partition Table line");
 396       free (out);
 397       return NULL;
 398     }
 399
 400     p += 18;
 401     char *q = strchr (p, '\n');
 402     if (!q) {
 403       reply_with_error ("parted Partition Table has no end of line char");
 404       free (out);
 405       return NULL;
 406     }
 407
 408     *q = '\0';
 409
 410     p = strdup (p);
 411     free (out);
 412     if (!p) {
 413       reply_with_perror ("strdup");
 414       return NULL;
 415     }
 416
 417     /* If "loop" return an error (RHBZ#634246). */
 418     if (STREQ (p, "loop")) {
 419       free (p);
 420       reply_with_error ("not a partitioned device");
 421       return NULL;
 422     }
 423
 424     return p;                   /* caller frees */
 425   }
 426 }
 427
 428 guestfs_int_partition_list *
 429 do_part_list (const char *device)
 430 {
 431   int parted_has_m_opt = test_parted_m_opt ();
 432   if (parted_has_m_opt == -1)
 433     return NULL;
 434
 435   char *out = print_partition_table (device, parted_has_m_opt);
 436   if (!out)
 437     return NULL;
 438
 439   char **lines = split_lines (out);
 440   free (out);
 441
 442   if (!lines)
 443     return NULL;
 444
 445   guestfs_int_partition_list *r;
 446
 447   if (parted_has_m_opt) {
 448     /* New-style parsing using the "machine-readable" format from
 449      * 'parted -m'.
 450      *
 451      * lines[0] is "BYT;", lines[1] is the device line which we ignore,
 452      * lines[2..] are the partitions themselves.  Count how many.
 453      */
 454     size_t nr_rows = 0, row;
 455     for (row = 2; lines[row] != NULL; ++row)
 456       ++nr_rows;
 457
 458     r = malloc (sizeof *r);
 459     if (r == NULL) {
 460       reply_with_perror ("malloc");
 461       goto error1;
 462     }
 463     r->guestfs_int_partition_list_len = nr_rows;
 464     r->guestfs_int_partition_list_val =
 465       malloc (nr_rows * sizeof (guestfs_int_partition));
 466     if (r->guestfs_int_partition_list_val == NULL) {
 467       reply_with_perror ("malloc");
 468       goto error2;
 469     }
 470
 471     /* Now parse the lines. */
 472     size_t i;
 473     for (i = 0, row = 2; lines[row] != NULL; ++i, ++row) {
 474       if (sscanf (lines[row], "%d:%" SCNi64 "B:%" SCNi64 "B:%" SCNi64 "B",
 475                   &r->guestfs_int_partition_list_val[i].part_num,
 476                   &r->guestfs_int_partition_list_val[i].part_start,
 477                   &r->guestfs_int_partition_list_val[i].part_end,
 478                   &r->guestfs_int_partition_list_val[i].part_size) != 4) {
 479         reply_with_error ("could not parse row from output of parted print command: %s", lines[row]);
 480         goto error3;
 481       }
 482     }
 483   }
 484   else {
 485     /* Old-style.  Start at the line following "^Number", up to the
 486      * next blank line.
 487      */
 488     size_t start = 0, end = 0, row;
 489
 490     for (row = 0; lines[row] != NULL; ++row)
 491       if (STRPREFIX (lines[row], "Number")) {
 492         start = row+1;
 493         break;
 494       }
 495
 496     if (start == 0) {
 497       reply_with_error ("parted output has no \"Number\" line");
 498       goto error1;
 499     }
 500
 501     for (row = start; lines[row] != NULL; ++row)
 502       if (STREQ (lines[row], "")) {
 503         end = row;
 504         break;
 505       }
 506
 507     if (end == 0) {
 508       reply_with_error ("parted output has no blank after end of table");
 509       goto error1;
 510     }
 511
 512     size_t nr_rows = end - start;
 513
 514     r = malloc (sizeof *r);
 515     if (r == NULL) {
 516       reply_with_perror ("malloc");
 517       goto error1;
 518     }
 519     r->guestfs_int_partition_list_len = nr_rows;
 520     r->guestfs_int_partition_list_val =
 521       malloc (nr_rows * sizeof (guestfs_int_partition));
 522     if (r->guestfs_int_partition_list_val == NULL) {
 523       reply_with_perror ("malloc");
 524       goto error2;
 525     }
 526
 527     /* Now parse the lines. */
 528     size_t i;
 529     for (i = 0, row = start; row < end; ++i, ++row) {
 530       if (sscanf (lines[row], " %d %" SCNi64 "B %" SCNi64 "B %" SCNi64 "B",
 531                   &r->guestfs_int_partition_list_val[i].part_num,
 532                   &r->guestfs_int_partition_list_val[i].part_start,
 533                   &r->guestfs_int_partition_list_val[i].part_end,
 534                   &r->guestfs_int_partition_list_val[i].part_size) != 4) {
 535         reply_with_error ("could not parse row from output of parted print command: %s", lines[row]);
 536         goto error3;
 537       }
 538     }
 539   }
 540
 541   free_strings (lines);
 542   return r;
 543
 544  error3:
 545   free (r->guestfs_int_partition_list_val);
 546  error2:
 547   free (r);
 548  error1:
 549   free_strings (lines);
 550   return NULL;
 551 }
 552
 553 int
 554 do_part_get_bootable (const char *device, int partnum)
 555 {
 556   if (partnum <= 0) {
 557     reply_with_error ("partition number must be >= 1");
 558     return -1;
 559   }
 560
 561   int parted_has_m_opt = test_parted_m_opt ();
 562   if (parted_has_m_opt == -1)
 563     return -1;
 564
 565   char *out = print_partition_table (device, parted_has_m_opt);
 566   if (!out)
 567     return -1;
 568
 569   char **lines = split_lines (out);
 570   free (out);
 571
 572   if (!lines)
 573     return -1;
 574
 575   if (parted_has_m_opt) {
 576     /* New-style parsing using the "machine-readable" format from
 577      * 'parted -m'.
 578      *
 579      * We want lines[1+partnum].
 580      */
 581     if (count_strings (lines) < (size_t) 1+partnum) {
 582       reply_with_error ("partition number out of range: %d", partnum);
 583       free_strings (lines);
 584       return -1;
 585     }
 586
 587     char *boot = get_table_field (lines[1+partnum], 6);
 588     if (boot == NULL) {
 589       free_strings (lines);
 590       return -1;
 591     }
 592
 593     int r = STREQ (boot, "boot");
 594
 595     free (boot);
 596     free_strings (lines);
 597
 598     return r;
 599   }
 600   else {
 601     /* Old-style: First look for the line matching "^Number". */
 602     size_t start = 0, header, row;
 603
 604     for (row = 0; lines[row] != NULL; ++row)
 605       if (STRPREFIX (lines[row], "Number")) {
 606         start = row+1;
 607         header = row;
 608         break;
 609       }
 610
 611     if (start == 0) {
 612       reply_with_error ("parted output has no \"Number\" line");
 613       free_strings (lines);
 614       return -1;
 615     }
 616
 617     /* Now we have to look at the column number of the "Flags" field.
 618      * This is because parted's output has no way to represent a
 619      * missing field except as whitespace, so we cannot just count
 620      * fields from the left.  eg. The "File system" field is often
 621      * missing in the output.
 622      */
 623     char *p = strstr (lines[header], "Flags");
 624     if (!p) {
 625       reply_with_error ("parted output has no \"Flags\" field");
 626       free_strings (lines);
 627       return -1;
 628     }
 629     size_t col = p - lines[header];
 630
 631     /* Look for the line corresponding to this partition number. */
 632     row = start + partnum - 1;
 633     if (row >= count_strings (lines) || !STRPREFIX (lines[row], " ")) {
 634       reply_with_error ("partition number out of range: %d", partnum);
 635       free_strings (lines);
 636       return -1;
 637     }
 638
 639     int r = STRPREFIX (&lines[row][col], "boot");
 640     free_strings (lines);
 641     return r;
 642   }
 643 }
 644
 645 /* Currently we use sfdisk for getting and setting the ID byte.  In
 646  * future, extend parted to provide this functionality.  As a result
 647  * of using sfdisk, this won't work for non-MBR-style partitions, but
 648  * that limitation is noted in the documentation and we can extend it
 649  * later without breaking the ABI.
 650  */
 651 int
 652 do_part_get_mbr_id (const char *device, int partnum)
 653 {
 654   if (partnum <= 0) {
 655     reply_with_error ("partition number must be >= 1");
 656     return -1;
 657   }
 658
 659   char partnum_str[16];
 660   snprintf (partnum_str, sizeof partnum_str, "%d", partnum);
 661
 662   char *out, *err;
 663   int r;
 664
 665   r = command (&out, &err, "sfdisk", "--print-id", device, partnum_str, NULL);
 666   if (r == -1) {
 667     reply_with_error ("sfdisk --print-id: %s", err);
 668     free (out);
 669     free (err);
 670     return -1;
 671   }
 672
 673   free (err);
 674
 675   /* It's printed in hex ... */
 676   int id;
 677   if (sscanf (out, "%x", &id) != 1) {
 678     reply_with_error ("sfdisk --print-id: cannot parse output: %s", out);
 679     free (out);
 680     return -1;
 681   }
 682
 683   free (out);
 684   return id;
 685 }
 686
 687 int
 688 do_part_set_mbr_id (const char *device, int partnum, int idbyte)
 689 {
 690   if (partnum <= 0) {
 691     reply_with_error ("partition number must be >= 1");
 692     return -1;
 693   }
 694
 695   char partnum_str[16];
 696   snprintf (partnum_str, sizeof partnum_str, "%d", partnum);
 697
 698   char idbyte_str[16];
 699   snprintf (idbyte_str, sizeof partnum_str, "%x", idbyte); /* NB: hex */
 700
 701   char *err;
 702   int r;
 703
 704   r = command (NULL, &err, "sfdisk",
 705                "--change-id", device, partnum_str, idbyte_str, NULL);
 706   if (r == -1) {
 707     reply_with_error ("sfdisk --change-id: %s", err);
 708     free (err);
 709     return -1;
 710   }
 711
 712   free (err);
 713   return 0;
 714 }