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