src/launch.c

   1 /* libguestfs
   2  * Copyright (C) 2009-2011 Red Hat Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library 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 GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include <config.h>
  20
  21 #define _BSD_SOURCE /* for mkdtemp, usleep */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <stdarg.h>
  26 #include <stddef.h>
  27 #include <stdint.h>
  28 #include <inttypes.h>
  29 #include <unistd.h>
  30 #include <string.h>
  31 #include <fcntl.h>
  32 #include <time.h>
  33 #include <sys/stat.h>
  34 #include <sys/select.h>
  35 #include <dirent.h>
  36 #include <signal.h>
  37 #include <assert.h>
  38
  39 #include <rpc/types.h>
  40 #include <rpc/xdr.h>
  41
  42 #ifdef HAVE_ERRNO_H
  43 #include <errno.h>
  44 #endif
  45
  46 #ifdef HAVE_SYS_TYPES_H
  47 #include <sys/types.h>
  48 #endif
  49
  50 #ifdef HAVE_SYS_WAIT_H
  51 #include <sys/wait.h>
  52 #endif
  53
  54 #ifdef HAVE_SYS_SOCKET_H
  55 #include <sys/socket.h>
  56 #endif
  57
  58 #ifdef HAVE_SYS_UN_H
  59 #include <sys/un.h>
  60 #endif
  61
  62 #include <arpa/inet.h>
  63 #include <netinet/in.h>
  64
  65 #include "c-ctype.h"
  66 #include "ignore-value.h"
  67 #include "glthread/lock.h"
  68
  69 #include "guestfs.h"
  70 #include "guestfs-internal.h"
  71 #include "guestfs-internal-actions.h"
  72 #include "guestfs_protocol.h"
  73
  74 static int launch_appliance (guestfs_h *g);
  75 static int64_t timeval_diff (const struct timeval *x, const struct timeval *y);
  76 static void print_qemu_command_line (guestfs_h *g, char **argv);
  77 static int connect_unix_socket (guestfs_h *g, const char *sock);
  78 static int qemu_supports (guestfs_h *g, const char *option);
  79 static char *qemu_drive_param (guestfs_h *g, const struct drive *drv);
  80
  81 #if 0
  82 static int qemu_supports_re (guestfs_h *g, const pcre *option_regex);
  83
  84 static void compile_regexps (void) __attribute__((constructor));
  85 static void free_regexps (void) __attribute__((destructor));
  86
  87 static void
  88 compile_regexps (void)
  89 {
  90   const char *err;
  91   int offset;
  92
  93 #define COMPILE(re,pattern,options)                                     \
  94   do {                                                                  \
  95     re = pcre_compile ((pattern), (options), &err, &offset, NULL);      \
  96     if (re == NULL) {                                                   \
  97       ignore_value (write (2, err, strlen (err)));                      \
  98       abort ();                                                         \
  99     }                                                                   \
 100   } while (0)
 101 }
 102
 103 static void
 104 free_regexps (void)
 105 {
 106 }
 107 #endif
 108
 109 /* Functions to add a string to the current command line. */
 110 static void
 111 alloc_cmdline (guestfs_h *g)
 112 {
 113   if (g->cmdline == NULL) {
 114     /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
 115     g->cmdline_size = 1;
 116     g->cmdline = safe_malloc (g, sizeof (char *));
 117     g->cmdline[0] = NULL;
 118   }
 119 }
 120
 121 static void
 122 incr_cmdline_size (guestfs_h *g)
 123 {
 124   alloc_cmdline (g);
 125   g->cmdline_size++;
 126   g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
 127 }
 128
 129 static int
 130 add_cmdline (guestfs_h *g, const char *str)
 131 {
 132   if (g->state != CONFIG) {
 133     error (g,
 134         _("command line cannot be altered after qemu subprocess launched"));
 135     return -1;
 136   }
 137
 138   incr_cmdline_size (g);
 139   g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
 140   return 0;
 141 }
 142
 143 struct drive **
 144 guestfs___checkpoint_drives (guestfs_h *g)
 145 {
 146   struct drive **i = &g->drives;
 147   while (*i != NULL) i = &((*i)->next);
 148   return i;
 149 }
 150
 151 void
 152 guestfs___rollback_drives (guestfs_h *g, struct drive **i)
 153 {
 154   guestfs___free_drives(i);
 155 }
 156
 157 /* Internal command to return the command line. */
 158 char **
 159 guestfs__debug_cmdline (guestfs_h *g)
 160 {
 161   size_t i;
 162   char **r;
 163
 164   alloc_cmdline (g);
 165
 166   r = safe_malloc (g, sizeof (char *) * (g->cmdline_size + 1));
 167   r[0] = safe_strdup (g, g->qemu); /* g->cmdline[0] is always NULL */
 168
 169   for (i = 1; i < g->cmdline_size; ++i)
 170     r[i] = safe_strdup (g, g->cmdline[i]);
 171
 172   r[g->cmdline_size] = NULL;
 173
 174   return r;                     /* caller frees */
 175 }
 176
 177 /* Internal command to return the list of drives. */
 178 char **
 179 guestfs__debug_drives (guestfs_h *g)
 180 {
 181   size_t i, count;
 182   char **ret;
 183   struct drive *drv;
 184
 185   for (count = 0, drv = g->drives; drv; count++, drv = drv->next)
 186     ;
 187
 188   ret = safe_malloc (g, sizeof (char *) * (count + 1));
 189
 190   for (i = 0, drv = g->drives; drv; i++, drv = drv->next)
 191     ret[i] = qemu_drive_param (g, drv);
 192
 193   ret[count] = NULL;
 194
 195   return ret;                   /* caller frees */
 196 }
 197
 198 int
 199 guestfs__config (guestfs_h *g,
 200                  const char *qemu_param, const char *qemu_value)
 201 {
 202   if (qemu_param[0] != '-') {
 203     error (g, _("guestfs_config: parameter must begin with '-' character"));
 204     return -1;
 205   }
 206
 207   /* A bit fascist, but the user will probably break the extra
 208    * parameters that we add if they try to set any of these.
 209    */
 210   if (STREQ (qemu_param, "-kernel") ||
 211       STREQ (qemu_param, "-initrd") ||
 212       STREQ (qemu_param, "-nographic") ||
 213       STREQ (qemu_param, "-serial") ||
 214       STREQ (qemu_param, "-full-screen") ||
 215       STREQ (qemu_param, "-std-vga") ||
 216       STREQ (qemu_param, "-vnc")) {
 217     error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
 218     return -1;
 219   }
 220
 221   if (add_cmdline (g, qemu_param) != 0) return -1;
 222
 223   if (qemu_value != NULL) {
 224     if (add_cmdline (g, qemu_value) != 0) return -1;
 225   }
 226
 227   return 0;
 228 }
 229
 230 /* cache=off improves reliability in the event of a host crash.
 231  *
 232  * However this option causes qemu to try to open the file with
 233  * O_DIRECT.  This fails on some filesystem types (notably tmpfs).
 234  * So we check if we can open the file with or without O_DIRECT,
 235  * and use cache=off (or not) accordingly.
 236  *
 237  * NB: This function is only called on the !readonly path.  We must
 238  * try to open with O_RDWR to test that the file is readable and
 239  * writable here.
 240  */
 241 static int
 242 test_cache_off (guestfs_h *g, const char *filename)
 243 {
 244   int fd = open (filename, O_RDWR|O_DIRECT);
 245   if (fd >= 0) {
 246     close (fd);
 247     return 1;
 248   }
 249
 250   fd = open (filename, O_RDWR);
 251   if (fd >= 0) {
 252     close (fd);
 253     return 0;
 254   }
 255
 256   perrorf (g, "%s", filename);
 257   return -1;
 258 }
 259
 260 /* Check string parameter matches ^[-_[:alnum:]]+$ (in C locale). */
 261 static int
 262 valid_format_iface (const char *str)
 263 {
 264   size_t len = strlen (str);
 265
 266   if (len == 0)
 267     return 0;
 268
 269   while (len > 0) {
 270     char c = *str++;
 271     len--;
 272     if (c != '-' && c != '_' && !c_isalnum (c))
 273       return 0;
 274   }
 275   return 1;
 276 }
 277
 278 int
 279 guestfs__add_drive_opts (guestfs_h *g, const char *filename,
 280                          const struct guestfs_add_drive_opts_argv *optargs)
 281 {
 282   int readonly;
 283   char *format;
 284   char *iface;
 285   char *name;
 286   int use_cache_off;
 287
 288   if (strchr (filename, ',') != NULL) {
 289     error (g, _("filename cannot contain ',' (comma) character"));
 290     return -1;
 291   }
 292
 293   readonly = optargs->bitmask & GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK
 294              ? optargs->readonly : 0;
 295   format = optargs->bitmask & GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK
 296            ? safe_strdup (g, optargs->format) : NULL;
 297   iface = optargs->bitmask & GUESTFS_ADD_DRIVE_OPTS_IFACE_BITMASK
 298           ? safe_strdup (g, optargs->iface) : safe_strdup (g, DRIVE_IF);
 299   name = optargs->bitmask & GUESTFS_ADD_DRIVE_OPTS_NAME_BITMASK
 300           ? safe_strdup (g, optargs->name) : NULL;
 301
 302   if (format && !valid_format_iface (format)) {
 303     error (g, _("%s parameter is empty or contains disallowed characters"),
 304            "format");
 305     free (format);
 306     free (iface);
 307     free (name);
 308     return -1;
 309   }
 310   if (!valid_format_iface (iface)) {
 311     error (g, _("%s parameter is empty or contains disallowed characters"),
 312            "iface");
 313     free (format);
 314     free (iface);
 315     free (name);
 316     return -1;
 317   }
 318
 319   /* For writable files, see if we can use cache=off.  This also
 320    * checks for the existence of the file.  For readonly we have
 321    * to do the check explicitly.
 322    */
 323   use_cache_off = readonly ? 0 : test_cache_off (g, filename);
 324   if (use_cache_off == -1) {
 325     free (format);
 326     free (iface);
 327     free (name);
 328     return -1;
 329   }
 330
 331   if (readonly) {
 332     if (access (filename, R_OK) == -1) {
 333       perrorf (g, "%s", filename);
 334       free (format);
 335       free (iface);
 336       free (name);
 337       return -1;
 338     }
 339   }
 340
 341   struct drive **i = &(g->drives);
 342   while (*i != NULL) i = &((*i)->next);
 343
 344   *i = safe_malloc (g, sizeof (struct drive));
 345   (*i)->next = NULL;
 346   (*i)->path = safe_strdup (g, filename);
 347   (*i)->readonly = readonly;
 348   (*i)->format = format;
 349   (*i)->iface = iface;
 350   (*i)->name = name;
 351   (*i)->use_cache_off = use_cache_off;
 352
 353   return 0;
 354 }
 355
 356 int
 357 guestfs__add_drive (guestfs_h *g, const char *filename)
 358 {
 359   struct guestfs_add_drive_opts_argv optargs = {
 360     .bitmask = 0,
 361   };
 362
 363   return guestfs__add_drive_opts (g, filename, &optargs);
 364 }
 365
 366 int
 367 guestfs__add_drive_ro (guestfs_h *g, const char *filename)
 368 {
 369   struct guestfs_add_drive_opts_argv optargs = {
 370     .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK,
 371     .readonly = 1,
 372   };
 373
 374   return guestfs__add_drive_opts (g, filename, &optargs);
 375 }
 376
 377 int
 378 guestfs__add_drive_with_if (guestfs_h *g, const char *filename,
 379                             const char *iface)
 380 {
 381   struct guestfs_add_drive_opts_argv optargs = {
 382     .bitmask = GUESTFS_ADD_DRIVE_OPTS_IFACE_BITMASK,
 383     .iface = iface,
 384   };
 385
 386   return guestfs__add_drive_opts (g, filename, &optargs);
 387 }
 388
 389 int
 390 guestfs__add_drive_ro_with_if (guestfs_h *g, const char *filename,
 391                                const char *iface)
 392 {
 393   struct guestfs_add_drive_opts_argv optargs = {
 394     .bitmask = GUESTFS_ADD_DRIVE_OPTS_IFACE_BITMASK
 395              | GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK,
 396     .iface = iface,
 397     .readonly = 1,
 398   };
 399
 400   return guestfs__add_drive_opts (g, filename, &optargs);
 401 }
 402
 403 int
 404 guestfs__add_cdrom (guestfs_h *g, const char *filename)
 405 {
 406   if (strchr (filename, ',') != NULL) {
 407     error (g, _("filename cannot contain ',' (comma) character"));
 408     return -1;
 409   }
 410
 411   if (access (filename, F_OK) == -1) {
 412     perrorf (g, "%s", filename);
 413     return -1;
 414   }
 415
 416   return guestfs__config (g, "-cdrom", filename);
 417 }
 418
 419 static int is_openable (guestfs_h *g, const char *path, int flags);
 420
 421 int
 422 guestfs__launch (guestfs_h *g)
 423 {
 424   /* Configured? */
 425   if (g->state != CONFIG) {
 426     error (g, _("the libguestfs handle has already been launched"));
 427     return -1;
 428   }
 429
 430   TRACE0 (launch_start);
 431
 432   /* Make the temporary directory. */
 433   if (!g->tmpdir) {
 434     TMP_TEMPLATE_ON_STACK (dir_template);
 435     g->tmpdir = safe_strdup (g, dir_template);
 436     if (mkdtemp (g->tmpdir) == NULL) {
 437       perrorf (g, _("%s: cannot create temporary directory"), dir_template);
 438       return -1;
 439     }
 440   }
 441
 442   /* Allow anyone to read the temporary directory.  The socket in this
 443    * directory won't be readable but anyone can see it exists if they
 444    * want. (RHBZ#610880).
 445    */
 446   if (chmod (g->tmpdir, 0755) == -1)
 447     warning (g, "chmod: %s: %m (ignored)", g->tmpdir);
 448
 449   /* Launch the appliance or attach to an existing daemon. */
 450   switch (g->attach_method) {
 451   case ATTACH_METHOD_APPLIANCE:
 452     return launch_appliance (g);
 453
 454   case ATTACH_METHOD_UNIX:
 455     return connect_unix_socket (g, g->attach_method_arg);
 456
 457   default:
 458     abort ();
 459   }
 460 }
 461
 462 static int
 463 launch_appliance (guestfs_h *g)
 464 {
 465   int r;
 466   int wfd[2], rfd[2];
 467   char guestfsd_sock[256];
 468   struct sockaddr_un addr;
 469
 470   /* At present you must add drives before starting the appliance.  In
 471    * future when we enable hotplugging you won't need to do this.
 472    */
 473   if (!g->drives) {
 474     error (g, _("you must call guestfs_add_drive before guestfs_launch"));
 475     return -1;
 476   }
 477
 478   /* Start the clock ... */
 479   gettimeofday (&g->launch_t, NULL);
 480   guestfs___launch_send_progress (g, 0);
 481
 482   TRACE0 (launch_build_appliance_start);
 483
 484   /* Locate and/or build the appliance. */
 485   char *kernel = NULL, *initrd = NULL, *appliance = NULL;
 486   if (guestfs___build_appliance (g, &kernel, &initrd, &appliance) == -1)
 487     return -1;
 488
 489   TRACE0 (launch_build_appliance_end);
 490
 491   guestfs___launch_send_progress (g, 3);
 492
 493   if (g->verbose)
 494     guestfs___print_timestamped_message (g, "begin testing qemu features");
 495
 496   /* Get qemu help text and version. */
 497   if (qemu_supports (g, NULL) == -1)
 498     goto cleanup0;
 499
 500   /* Using virtio-serial, we need to create a local Unix domain socket
 501    * for qemu to connect to.
 502    */
 503   snprintf (guestfsd_sock, sizeof guestfsd_sock, "%s/guestfsd.sock", g->tmpdir);
 504   unlink (guestfsd_sock);
 505
 506   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 507   if (g->sock == -1) {
 508     perrorf (g, "socket");
 509     goto cleanup0;
 510   }
 511
 512   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 513     perrorf (g, "fcntl");
 514     goto cleanup0;
 515   }
 516
 517   addr.sun_family = AF_UNIX;
 518   strncpy (addr.sun_path, guestfsd_sock, UNIX_PATH_MAX);
 519   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 520
 521   if (bind (g->sock, &addr, sizeof addr) == -1) {
 522     perrorf (g, "bind");
 523     goto cleanup0;
 524   }
 525
 526   if (listen (g->sock, 1) == -1) {
 527     perrorf (g, "listen");
 528     goto cleanup0;
 529   }
 530
 531   if (!g->direct) {
 532     if (pipe (wfd) == -1 || pipe (rfd) == -1) {
 533       perrorf (g, "pipe");
 534       goto cleanup0;
 535     }
 536   }
 537
 538   if (g->verbose)
 539     guestfs___print_timestamped_message (g, "finished testing qemu features");
 540
 541   r = fork ();
 542   if (r == -1) {
 543     perrorf (g, "fork");
 544     if (!g->direct) {
 545       close (wfd[0]);
 546       close (wfd[1]);
 547       close (rfd[0]);
 548       close (rfd[1]);
 549     }
 550     goto cleanup0;
 551   }
 552
 553   if (r == 0) {                 /* Child (qemu). */
 554     char buf[256];
 555
 556     /* Set up the full command line.  Do this in the subprocess so we
 557      * don't need to worry about cleaning up.
 558      */
 559
 560     /* Set g->cmdline[0] to the name of the qemu process.  However
 561      * it is possible that no g->cmdline has been allocated yet so
 562      * we must do that first.
 563      */
 564     alloc_cmdline (g);
 565     g->cmdline[0] = g->qemu;
 566
 567     /* Add drives */
 568     struct drive *drv = g->drives;
 569     while (drv != NULL) {
 570       /* Construct the final -drive parameter. */
 571       char *buf = qemu_drive_param (g, drv);
 572
 573       add_cmdline (g, "-drive");
 574       add_cmdline (g, buf);
 575       free (buf);
 576
 577       drv = drv->next;
 578     }
 579
 580     if (qemu_supports (g, "-nodefconfig"))
 581       add_cmdline (g, "-nodefconfig");
 582
 583     /* The qemu -machine option (added 2010-12) is a bit more sane
 584      * since it falls back through various different acceleration
 585      * modes, so try that first (thanks Markus Armbruster).
 586      */
 587     if (qemu_supports (g, "-machine")) {
 588       add_cmdline (g, "-machine");
 589 #if QEMU_MACHINE_TYPE_IS_BROKEN
 590       /* Workaround for qemu 0.15: We have to add the '[type=]pc'
 591        * since there is no default.  This is not a permanent solution
 592        * because this only works on PC-like hardware.  Other platforms
 593        * like ppc would need a different machine type.
 594        *
 595        * This bug is fixed in qemu commit 2645c6dcaf6ea2a51a, and was
 596        * not a problem in qemu < 0.15.
 597        */
 598       add_cmdline (g, "pc,accel=kvm:tcg");
 599 #else
 600       add_cmdline (g, "accel=kvm:tcg");
 601 #endif
 602     } else {
 603       /* qemu sometimes needs this option to enable hardware
 604        * virtualization, but some versions of 'qemu-kvm' will use KVM
 605        * regardless (even where this option appears in the help text).
 606        * It is rumoured that there are versions of qemu where supplying
 607        * this option when hardware virtualization is not available will
 608        * cause qemu to fail, so we we have to check at least that
 609        * /dev/kvm is openable.  That's not reliable, since /dev/kvm
 610        * might be openable by qemu but not by us (think: SELinux) in
 611        * which case the user would not get hardware virtualization,
 612        * although at least shouldn't fail.  A giant clusterfuck with the
 613        * qemu command line, again.
 614        */
 615       if (qemu_supports (g, "-enable-kvm") &&
 616           is_openable (g, "/dev/kvm", O_RDWR))
 617         add_cmdline (g, "-enable-kvm");
 618     }
 619
 620     /* Newer versions of qemu (from around 2009/12) changed the
 621      * behaviour of monitors so that an implicit '-monitor stdio' is
 622      * assumed if we are in -nographic mode and there is no other
 623      * -monitor option.  Only a single stdio device is allowed, so
 624      * this broke the '-serial stdio' option.  There is a new flag
 625      * called -nodefaults which gets rid of all this default crud, so
 626      * let's use that to avoid this and any future surprises.
 627      */
 628     if (qemu_supports (g, "-nodefaults"))
 629       add_cmdline (g, "-nodefaults");
 630
 631     add_cmdline (g, "-nographic");
 632
 633     if (g->smp > 1) {
 634       snprintf (buf, sizeof buf, "%d", g->smp);
 635       add_cmdline (g, "-smp");
 636       add_cmdline (g, buf);
 637     }
 638
 639     snprintf (buf, sizeof buf, "%d", g->memsize);
 640     add_cmdline (g, "-m");
 641     add_cmdline (g, buf);
 642
 643     /* Force exit instead of reboot on panic */
 644     add_cmdline (g, "-no-reboot");
 645
 646     /* These options recommended by KVM developers to improve reliability. */
 647     if (qemu_supports (g, "-no-hpet"))
 648       add_cmdline (g, "-no-hpet");
 649
 650     if (qemu_supports (g, "-rtc-td-hack"))
 651       add_cmdline (g, "-rtc-td-hack");
 652
 653     /* Create the virtio serial bus. */
 654     add_cmdline (g, "-device");
 655     add_cmdline (g, "virtio-serial");
 656
 657 #if 0
 658     /* Use virtio-console (a variant form of virtio-serial) for the
 659      * guest's serial console.
 660      */
 661     add_cmdline (g, "-chardev");
 662     add_cmdline (g, "stdio,id=console");
 663     add_cmdline (g, "-device");
 664     add_cmdline (g, "virtconsole,chardev=console,name=org.libguestfs.console.0");
 665 #else
 666     /* When the above works ...  until then: */
 667     add_cmdline (g, "-serial");
 668     add_cmdline (g, "stdio");
 669 #endif
 670
 671     /* Set up virtio-serial for the communications channel. */
 672     add_cmdline (g, "-chardev");
 673     snprintf (buf, sizeof buf, "socket,path=%s,id=channel0", guestfsd_sock);
 674     add_cmdline (g, buf);
 675     add_cmdline (g, "-device");
 676     add_cmdline (g, "virtserialport,chardev=channel0,name=org.libguestfs.channel.0");
 677
 678     /* Enable user networking. */
 679     if (g->enable_network) {
 680       add_cmdline (g, "-netdev");
 681       add_cmdline (g, "user,id=usernet,net=169.254.0.0/16");
 682       add_cmdline (g, "-device");
 683       add_cmdline (g, NET_IF ",netdev=usernet");
 684     }
 685
 686 #define LINUX_CMDLINE                                                   \
 687     "panic=1 "         /* force kernel to panic if daemon exits */      \
 688     "console=ttyS0 "   /* serial console */                             \
 689     "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */   \
 690     "no_timer_check "  /* fix for RHBZ#502058 */                        \
 691     "acpi=off "        /* we don't need ACPI, turn it off */            \
 692     "printk.time=1 "   /* display timestamp before kernel messages */   \
 693     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
 694
 695     /* Linux kernel command line. */
 696     snprintf (buf, sizeof buf,
 697               LINUX_CMDLINE
 698               "%s "             /* (selinux) */
 699               "%s "             /* (verbose) */
 700               "TERM=%s "        /* (TERM environment variable) */
 701               "%s",             /* (append) */
 702               g->selinux ? "selinux=1 enforcing=0" : "selinux=0",
 703               g->verbose ? "guestfs_verbose=1" : "",
 704               getenv ("TERM") ? : "linux",
 705               g->append ? g->append : "");
 706
 707     add_cmdline (g, "-kernel");
 708     add_cmdline (g, kernel);
 709     add_cmdline (g, "-initrd");
 710     add_cmdline (g, initrd);
 711     add_cmdline (g, "-append");
 712     add_cmdline (g, buf);
 713
 714     /* Add the ext2 appliance drive (last of all). */
 715     if (appliance) {
 716       const char *cachemode = "";
 717       if (qemu_supports (g, "cache=")) {
 718         if (qemu_supports (g, "unsafe"))
 719           cachemode = ",cache=unsafe";
 720         else if (qemu_supports (g, "writeback"))
 721           cachemode = ",cache=writeback";
 722       }
 723
 724       char buf2[PATH_MAX + 64];
 725       add_cmdline (g, "-drive");
 726       snprintf (buf2, sizeof buf2, "file=%s,snapshot=on,if=" DRIVE_IF "%s",
 727                 appliance, cachemode);
 728       add_cmdline (g, buf2);
 729     }
 730
 731     /* Finish off the command line. */
 732     incr_cmdline_size (g);
 733     g->cmdline[g->cmdline_size-1] = NULL;
 734
 735     if (!g->direct) {
 736       /* Set up stdin, stdout, stderr. */
 737       close (0);
 738       close (1);
 739       close (wfd[1]);
 740       close (rfd[0]);
 741
 742       /* Stdin. */
 743       if (dup (wfd[0]) == -1) {
 744       dup_failed:
 745         perror ("dup failed");
 746         _exit (EXIT_FAILURE);
 747       }
 748       /* Stdout. */
 749       if (dup (rfd[1]) == -1)
 750         goto dup_failed;
 751
 752       /* Particularly since qemu 0.15, qemu spews all sorts of debug
 753        * information on stderr.  It is useful to both capture this and
 754        * not confuse casual users, so send stderr to the pipe as well.
 755        */
 756       close (2);
 757       if (dup (rfd[1]) == -1)
 758         goto dup_failed;
 759
 760       close (wfd[0]);
 761       close (rfd[1]);
 762     }
 763
 764     /* Dump the command line (after setting up stderr above). */
 765     if (g->verbose)
 766       print_qemu_command_line (g, g->cmdline);
 767
 768     /* Put qemu in a new process group. */
 769     if (g->pgroup)
 770       setpgid (0, 0);
 771
 772     setenv ("LC_ALL", "C", 1);
 773
 774     TRACE0 (launch_run_qemu);
 775
 776     execv (g->qemu, g->cmdline); /* Run qemu. */
 777     perror (g->qemu);
 778     _exit (EXIT_FAILURE);
 779   }
 780
 781   /* Parent (library). */
 782   g->pid = r;
 783
 784   free (kernel);
 785   kernel = NULL;
 786   free (initrd);
 787   initrd = NULL;
 788   free (appliance);
 789   appliance = NULL;
 790
 791   /* Fork the recovery process off which will kill qemu if the parent
 792    * process fails to do so (eg. if the parent segfaults).
 793    */
 794   g->recoverypid = -1;
 795   if (g->recovery_proc) {
 796     r = fork ();
 797     if (r == 0) {
 798       pid_t qemu_pid = g->pid;
 799       pid_t parent_pid = getppid ();
 800
 801       /* It would be nice to be able to put this in the same process
 802        * group as qemu (ie. setpgid (0, qemu_pid)).  However this is
 803        * not possible because we don't have any guarantee here that
 804        * the qemu process has started yet.
 805        */
 806       if (g->pgroup)
 807         setpgid (0, 0);
 808
 809       /* Writing to argv is hideously complicated and error prone.  See:
 810        * http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/misc/ps_status.c;hb=HEAD
 811        */
 812
 813       /* Loop around waiting for one or both of the other processes to
 814        * disappear.  It's fair to say this is very hairy.  The PIDs that
 815        * we are looking at might be reused by another process.  We are
 816        * effectively polling.  Is the cure worse than the disease?
 817        */
 818       for (;;) {
 819         if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
 820           _exit (EXIT_SUCCESS);
 821         if (kill (parent_pid, 0) == -1) {
 822           /* Parent's gone away, qemu still around, so kill qemu. */
 823           kill (qemu_pid, 9);
 824           _exit (EXIT_SUCCESS);
 825         }
 826         sleep (2);
 827       }
 828     }
 829
 830     /* Don't worry, if the fork failed, this will be -1.  The recovery
 831      * process isn't essential.
 832      */
 833     g->recoverypid = r;
 834   }
 835
 836   if (!g->direct) {
 837     /* Close the other ends of the pipe. */
 838     close (wfd[0]);
 839     close (rfd[1]);
 840
 841     if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
 842         fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
 843       perrorf (g, "fcntl");
 844       goto cleanup1;
 845     }
 846
 847     g->fd[0] = wfd[1];          /* stdin of child */
 848     g->fd[1] = rfd[0];          /* stdout of child */
 849   } else {
 850     g->fd[0] = open ("/dev/null", O_RDWR);
 851     if (g->fd[0] == -1) {
 852       perrorf (g, "open /dev/null");
 853       goto cleanup1;
 854     }
 855     g->fd[1] = dup (g->fd[0]);
 856     if (g->fd[1] == -1) {
 857       perrorf (g, "dup");
 858       close (g->fd[0]);
 859       goto cleanup1;
 860     }
 861   }
 862
 863   g->state = LAUNCHING;
 864
 865   /* Wait for qemu to start and to connect back to us via
 866    * virtio-serial and send the GUESTFS_LAUNCH_FLAG message.
 867    */
 868   r = guestfs___accept_from_daemon (g);
 869   if (r == -1)
 870     goto cleanup1;
 871
 872   /* NB: We reach here just because qemu has opened the socket.  It
 873    * does not mean the daemon is up until we read the
 874    * GUESTFS_LAUNCH_FLAG below.  Failures in qemu startup can still
 875    * happen even if we reach here, even early failures like not being
 876    * able to open a drive.
 877    */
 878
 879   close (g->sock); /* Close the listening socket. */
 880   g->sock = r; /* This is the accepted data socket. */
 881
 882   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 883     perrorf (g, "fcntl");
 884     goto cleanup1;
 885   }
 886
 887   uint32_t size;
 888   void *buf = NULL;
 889   r = guestfs___recv_from_daemon (g, &size, &buf);
 890   free (buf);
 891
 892   if (r == -1) return -1;
 893
 894   if (size != GUESTFS_LAUNCH_FLAG) {
 895     error (g, _("guestfs_launch failed, see earlier error messages"));
 896     goto cleanup1;
 897   }
 898
 899   if (g->verbose)
 900     guestfs___print_timestamped_message (g, "appliance is up");
 901
 902   /* This is possible in some really strange situations, such as
 903    * guestfsd starts up OK but then qemu immediately exits.  Check for
 904    * it because the caller is probably expecting to be able to send
 905    * commands after this function returns.
 906    */
 907   if (g->state != READY) {
 908     error (g, _("qemu launched and contacted daemon, but state != READY"));
 909     goto cleanup1;
 910   }
 911
 912   TRACE0 (launch_end);
 913
 914   guestfs___launch_send_progress (g, 12);
 915
 916   return 0;
 917
 918  cleanup1:
 919   if (!g->direct) {
 920     close (wfd[1]);
 921     close (rfd[0]);
 922   }
 923   if (g->pid > 0) kill (g->pid, 9);
 924   if (g->recoverypid > 0) kill (g->recoverypid, 9);
 925   if (g->pid > 0) waitpid (g->pid, NULL, 0);
 926   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 927   g->fd[0] = -1;
 928   g->fd[1] = -1;
 929   g->pid = 0;
 930   g->recoverypid = 0;
 931   memset (&g->launch_t, 0, sizeof g->launch_t);
 932
 933  cleanup0:
 934   if (g->sock >= 0) {
 935     close (g->sock);
 936     g->sock = -1;
 937   }
 938   g->state = CONFIG;
 939   free (kernel);
 940   free (initrd);
 941   free (appliance);
 942   return -1;
 943 }
 944
 945 /* Alternate attach method: instead of launching the appliance,
 946  * connect to an existing unix socket.
 947  */
 948 static int
 949 connect_unix_socket (guestfs_h *g, const char *sockpath)
 950 {
 951   int r;
 952   struct sockaddr_un addr;
 953
 954   /* Start the clock ... */
 955   gettimeofday (&g->launch_t, NULL);
 956
 957   /* Set these to nothing so we don't try to kill random processes or
 958    * read from random file descriptors.
 959    */
 960   g->pid = 0;
 961   g->recoverypid = 0;
 962   g->fd[0] = -1;
 963   g->fd[1] = -1;
 964
 965   if (g->verbose)
 966     guestfs___print_timestamped_message (g, "connecting to %s", sockpath);
 967
 968   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 969   if (g->sock == -1) {
 970     perrorf (g, "socket");
 971     return -1;
 972   }
 973
 974   addr.sun_family = AF_UNIX;
 975   strncpy (addr.sun_path, sockpath, UNIX_PATH_MAX);
 976   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 977
 978   g->state = LAUNCHING;
 979
 980   if (connect (g->sock, &addr, sizeof addr) == -1) {
 981     perrorf (g, "bind");
 982     goto cleanup;
 983   }
 984
 985   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 986     perrorf (g, "fcntl");
 987     goto cleanup;
 988   }
 989
 990   uint32_t size;
 991   void *buf = NULL;
 992   r = guestfs___recv_from_daemon (g, &size, &buf);
 993   free (buf);
 994
 995   if (r == -1) return -1;
 996
 997   if (size != GUESTFS_LAUNCH_FLAG) {
 998     error (g, _("guestfs_launch failed, unexpected initial message from guestfsd"));
 999     goto cleanup;
1000   }
1001
1002   if (g->verbose)
1003     guestfs___print_timestamped_message (g, "connected");
1004
1005   if (g->state != READY) {
1006     error (g, _("contacted guestfsd, but state != READY"));
1007     goto cleanup;
1008   }
1009
1010   return 0;
1011
1012  cleanup:
1013   close (g->sock);
1014   return -1;
1015 }
1016
1017 /* launch (of the ordinary appliance) generates approximate progress
1018  * messages.  Currently these are defined as follows:
1019  *
1020  *    0 / 12: launch clock starts
1021  *    3 / 12: appliance created
1022  *    6 / 12: detected that guest kernel started
1023  *    9 / 12: detected that /init script is running
1024  *   12 / 12: launch completed successfully
1025  *
1026  * Notes:
1027  * (1) This is not a documented ABI and the behaviour may be changed
1028  * or removed in future.
1029  * (2) Messages are only sent if more than 5 seconds has elapsed
1030  * since the launch clock started.
1031  * (3) There is a gross hack in proto.c to make this work.
1032  */
1033 void
1034 guestfs___launch_send_progress (guestfs_h *g, int perdozen)
1035 {
1036   struct timeval tv;
1037
1038   gettimeofday (&tv, NULL);
1039   if (timeval_diff (&g->launch_t, &tv) >= 5000) {
1040     guestfs_progress progress_message =
1041       { .proc = 0, .serial = 0, .position = perdozen, .total = 12 };
1042
1043     guestfs___progress_message_callback (g, &progress_message);
1044   }
1045 }
1046
1047 /* Return the location of the tmpdir (eg. "/tmp") and allow users
1048  * to override it at runtime using $TMPDIR.
1049  * http://www.pathname.com/fhs/pub/fhs-2.3.html#TMPTEMPORARYFILES
1050  */
1051 const char *
1052 guestfs_tmpdir (void)
1053 {
1054   const char *tmpdir;
1055
1056 #ifdef P_tmpdir
1057   tmpdir = P_tmpdir;
1058 #else
1059   tmpdir = "/tmp";
1060 #endif
1061
1062   const char *t = getenv ("TMPDIR");
1063   if (t) tmpdir = t;
1064
1065   return tmpdir;
1066 }
1067
1068 /* Return the location of the persistent tmpdir (eg. "/var/tmp") and
1069  * allow users to override it at runtime using $TMPDIR.
1070  * http://www.pathname.com/fhs/pub/fhs-2.3.html#VARTMPTEMPORARYFILESPRESERVEDBETWEE
1071  */
1072 const char *
1073 guestfs___persistent_tmpdir (void)
1074 {
1075   const char *tmpdir;
1076
1077   tmpdir = "/var/tmp";
1078
1079   const char *t = getenv ("TMPDIR");
1080   if (t) tmpdir = t;
1081
1082   return tmpdir;
1083 }
1084
1085 /* Compute Y - X and return the result in milliseconds.
1086  * Approximately the same as this code:
1087  * http://www.mpp.mpg.de/~huber/util/timevaldiff.c
1088  */
1089 static int64_t
1090 timeval_diff (const struct timeval *x, const struct timeval *y)
1091 {
1092   int64_t msec;
1093
1094   msec = (y->tv_sec - x->tv_sec) * 1000;
1095   msec += (y->tv_usec - x->tv_usec) / 1000;
1096   return msec;
1097 }
1098
1099 /* Note that since this calls 'debug' it should only be called
1100  * from the parent process.
1101  */
1102 void
1103 guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...)
1104 {
1105   va_list args;
1106   char *msg;
1107   int err;
1108   struct timeval tv;
1109
1110   va_start (args, fs);
1111   err = vasprintf (&msg, fs, args);
1112   va_end (args);
1113
1114   if (err < 0) return;
1115
1116   gettimeofday (&tv, NULL);
1117
1118   debug (g, "[%05" PRIi64 "ms] %s", timeval_diff (&g->launch_t, &tv), msg);
1119
1120   free (msg);
1121 }
1122
1123 /* This is called from the forked subprocess just before qemu runs, so
1124  * it can just print the message straight to stderr, where it will be
1125  * picked up and funnelled through the usual appliance event API.
1126  */
1127 static void
1128 print_qemu_command_line (guestfs_h *g, char **argv)
1129 {
1130   int i = 0;
1131   int needs_quote;
1132
1133   struct timeval tv;
1134   gettimeofday (&tv, NULL);
1135   fprintf (stderr, "[%05" PRIi64 "ms] ", timeval_diff (&g->launch_t, &tv));
1136
1137   while (argv[i]) {
1138     if (argv[i][0] == '-') /* -option starts a new line */
1139       fprintf (stderr, " \\\n   ");
1140
1141     if (i > 0) fputc (' ', stderr);
1142
1143     /* Does it need shell quoting?  This only deals with simple cases. */
1144     needs_quote = strcspn (argv[i], " ") != strlen (argv[i]);
1145
1146     if (needs_quote) fputc ('\'', stderr);
1147     fprintf (stderr, "%s", argv[i]);
1148     if (needs_quote) fputc ('\'', stderr);
1149     i++;
1150   }
1151 }
1152
1153 static int test_qemu_cmd (guestfs_h *g, const char *cmd, char **ret);
1154 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1155
1156 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1157  * 'qemu -version' so we know what options this qemu supports and
1158  * the version.
1159  */
1160 static int
1161 test_qemu (guestfs_h *g)
1162 {
1163   char cmd[1024];
1164   FILE *fp;
1165
1166   free (g->qemu_help);
1167   g->qemu_help = NULL;
1168   free (g->qemu_version);
1169   g->qemu_version = NULL;
1170
1171   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -help", g->qemu);
1172
1173   /* qemu -help should always work (qemu -version OTOH wasn't
1174    * supported by qemu 0.9).  If this command doesn't work then it
1175    * probably indicates that the qemu binary is missing.
1176    */
1177   if (test_qemu_cmd (g, cmd, &g->qemu_help) == -1) {
1178     error (g, _("command failed: %s\n\nIf qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU\nenvironment variable.  There may also be errors printed above."),
1179            cmd);
1180     return -1;
1181   }
1182
1183   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -version 2>/dev/null",
1184             g->qemu);
1185
1186   /* Intentionally ignore errors from qemu -version. */
1187   ignore_value (test_qemu_cmd (g, cmd, &g->qemu_version));
1188
1189   return 0;
1190 }
1191
1192 static int
1193 test_qemu_cmd (guestfs_h *g, const char *cmd, char **ret)
1194 {
1195   FILE *fp;
1196
1197   fp = popen (cmd, "r");
1198   if (fp == NULL)
1199     return -1;
1200
1201   if (read_all (g, fp, ret) == -1) {
1202     pclose (fp);
1203     return -1;
1204   }
1205
1206   if (pclose (fp) != 0)
1207     return -1;
1208
1209   return 0;
1210 }
1211
1212 static int
1213 read_all (guestfs_h *g, FILE *fp, char **ret)
1214 {
1215   int r, n = 0;
1216   char *p;
1217
1218  again:
1219   if (feof (fp)) {
1220     *ret = safe_realloc (g, *ret, n + 1);
1221     (*ret)[n] = '\0';
1222     return n;
1223   }
1224
1225   *ret = safe_realloc (g, *ret, n + BUFSIZ);
1226   p = &(*ret)[n];
1227   r = fread (p, 1, BUFSIZ, fp);
1228   if (ferror (fp)) {
1229     perrorf (g, "read");
1230     return -1;
1231   }
1232   n += r;
1233   goto again;
1234 }
1235
1236 /* Test if option is supported by qemu command line (just by grepping
1237  * the help text).
1238  *
1239  * The first time this is used, it has to run the external qemu
1240  * binary.  If that fails, it returns -1.
1241  *
1242  * To just do the first-time run of the qemu binary, call this with
1243  * option == NULL, in which case it will return -1 if there was an
1244  * error doing that.
1245  */
1246 static int
1247 qemu_supports (guestfs_h *g, const char *option)
1248 {
1249   if (!g->qemu_help) {
1250     if (test_qemu (g) == -1)
1251       return -1;
1252   }
1253
1254   if (option == NULL)
1255     return 1;
1256
1257   return strstr (g->qemu_help, option) != NULL;
1258 }
1259
1260 #if 0
1261 /* As above but using a regex instead of a fixed string. */
1262 static int
1263 qemu_supports_re (guestfs_h *g, const pcre *option_regex)
1264 {
1265   if (!g->qemu_help) {
1266     if (test_qemu (g) == -1)
1267       return -1;
1268   }
1269
1270   return match (g, g->qemu_help, option_regex);
1271 }
1272 #endif
1273
1274 /* Check if a file can be opened. */
1275 static int
1276 is_openable (guestfs_h *g, const char *path, int flags)
1277 {
1278   int fd = open (path, flags);
1279   if (fd == -1) {
1280     debug (g, "is_openable: %s: %m", path);
1281     return 0;
1282   }
1283   close (fd);
1284   return 1;
1285 }
1286
1287 static char *
1288 qemu_drive_param (guestfs_h *g, const struct drive *drv)
1289 {
1290   size_t len = 64;
1291   char *r;
1292
1293   len += strlen (drv->path);
1294   len += strlen (drv->iface);
1295   if (drv->format)
1296     len += strlen (drv->format);
1297
1298   r = safe_malloc (g, len);
1299
1300   snprintf (r, len, "file=%s%s%s%s%s,if=%s",
1301             drv->path,
1302             drv->readonly ? ",snapshot=on" : "",
1303             drv->use_cache_off ? ",cache=off" : "",
1304             drv->format ? ",format=" : "",
1305             drv->format ? drv->format : "",
1306             drv->iface);
1307
1308   return r;                     /* caller frees */
1309 }
1310
1311 /* You had to call this function after launch in versions <= 1.0.70,
1312  * but it is now a no-op.
1313  */
1314 int
1315 guestfs__wait_ready (guestfs_h *g)
1316 {
1317   if (g->state != READY)  {
1318     error (g, _("qemu has not been launched yet"));
1319     return -1;
1320   }
1321
1322   return 0;
1323 }
1324
1325 int
1326 guestfs__kill_subprocess (guestfs_h *g)
1327 {
1328   if (g->state == CONFIG) {
1329     error (g, _("no subprocess to kill"));
1330     return -1;
1331   }
1332
1333   debug (g, "sending SIGTERM to process %d", g->pid);
1334
1335   if (g->pid > 0) kill (g->pid, SIGTERM);
1336   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1337
1338   return 0;
1339 }
1340
1341 /* Access current state. */
1342 int
1343 guestfs__is_config (guestfs_h *g)
1344 {
1345   return g->state == CONFIG;
1346 }
1347
1348 int
1349 guestfs__is_launching (guestfs_h *g)
1350 {
1351   return g->state == LAUNCHING;
1352 }
1353
1354 int
1355 guestfs__is_ready (guestfs_h *g)
1356 {
1357   return g->state == READY;
1358 }
1359
1360 int
1361 guestfs__is_busy (guestfs_h *g)
1362 {
1363   return g->state == BUSY;
1364 }
1365
1366 int
1367 guestfs__get_state (guestfs_h *g)
1368 {
1369   return g->state;
1370 }