src/launch.c

   1 /* libguestfs
   2  * Copyright (C) 2009-2010 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
  38 #include <rpc/types.h>
  39 #include <rpc/xdr.h>
  40
  41 #ifdef HAVE_ERRNO_H
  42 #include <errno.h>
  43 #endif
  44
  45 #ifdef HAVE_SYS_TYPES_H
  46 #include <sys/types.h>
  47 #endif
  48
  49 #ifdef HAVE_SYS_WAIT_H
  50 #include <sys/wait.h>
  51 #endif
  52
  53 #ifdef HAVE_SYS_SOCKET_H
  54 #include <sys/socket.h>
  55 #endif
  56
  57 #ifdef HAVE_SYS_UN_H
  58 #include <sys/un.h>
  59 #endif
  60
  61 #include <arpa/inet.h>
  62 #include <netinet/in.h>
  63
  64 #include "glthread/lock.h"
  65
  66 #include "guestfs.h"
  67 #include "guestfs-internal.h"
  68 #include "guestfs-internal-actions.h"
  69 #include "guestfs_protocol.h"
  70
  71 static int qemu_supports (guestfs_h *g, const char *option);
  72
  73 /* Add a string to the current command line. */
  74 static void
  75 incr_cmdline_size (guestfs_h *g)
  76 {
  77   if (g->cmdline == NULL) {
  78     /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
  79     g->cmdline_size = 1;
  80     g->cmdline = safe_malloc (g, sizeof (char *));
  81     g->cmdline[0] = NULL;
  82   }
  83
  84   g->cmdline_size++;
  85   g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
  86 }
  87
  88 static int
  89 add_cmdline (guestfs_h *g, const char *str)
  90 {
  91   if (g->state != CONFIG) {
  92     error (g,
  93         _("command line cannot be altered after qemu subprocess launched"));
  94     return -1;
  95   }
  96
  97   incr_cmdline_size (g);
  98   g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
  99   return 0;
 100 }
 101
 102 int
 103 guestfs__config (guestfs_h *g,
 104                  const char *qemu_param, const char *qemu_value)
 105 {
 106   if (qemu_param[0] != '-') {
 107     error (g, _("guestfs_config: parameter must begin with '-' character"));
 108     return -1;
 109   }
 110
 111   /* A bit fascist, but the user will probably break the extra
 112    * parameters that we add if they try to set any of these.
 113    */
 114   if (STREQ (qemu_param, "-kernel") ||
 115       STREQ (qemu_param, "-initrd") ||
 116       STREQ (qemu_param, "-nographic") ||
 117       STREQ (qemu_param, "-serial") ||
 118       STREQ (qemu_param, "-full-screen") ||
 119       STREQ (qemu_param, "-std-vga") ||
 120       STREQ (qemu_param, "-vnc")) {
 121     error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
 122     return -1;
 123   }
 124
 125   if (add_cmdline (g, qemu_param) != 0) return -1;
 126
 127   if (qemu_value != NULL) {
 128     if (add_cmdline (g, qemu_value) != 0) return -1;
 129   }
 130
 131   return 0;
 132 }
 133
 134 int
 135 guestfs__add_drive_with_if (guestfs_h *g, const char *filename,
 136                             const char *drive_if)
 137 {
 138   size_t len = strlen (filename) + 64;
 139   char buf[len];
 140
 141   if (strchr (filename, ',') != NULL) {
 142     error (g, _("filename cannot contain ',' (comma) character"));
 143     return -1;
 144   }
 145
 146   /* cache=off improves reliability in the event of a host crash.
 147    *
 148    * However this option causes qemu to try to open the file with
 149    * O_DIRECT.  This fails on some filesystem types (notably tmpfs).
 150    * So we check if we can open the file with or without O_DIRECT,
 151    * and use cache=off (or not) accordingly.
 152    *
 153    * This test also checks for the presence of the file, which
 154    * is a documented semantic of this interface.
 155    */
 156   int fd = open (filename, O_RDONLY|O_DIRECT);
 157   if (fd >= 0) {
 158     close (fd);
 159     snprintf (buf, len, "file=%s,cache=off,if=%s", filename, drive_if);
 160   } else {
 161     fd = open (filename, O_RDONLY);
 162     if (fd >= 0) {
 163       close (fd);
 164       snprintf (buf, len, "file=%s,if=%s", filename, drive_if);
 165     } else {
 166       perrorf (g, "%s", filename);
 167       return -1;
 168     }
 169   }
 170
 171   return guestfs__config (g, "-drive", buf);
 172 }
 173
 174 int
 175 guestfs__add_drive_ro_with_if (guestfs_h *g, const char *filename,
 176                                const char *drive_if)
 177 {
 178   if (strchr (filename, ',') != NULL) {
 179     error (g, _("filename cannot contain ',' (comma) character"));
 180     return -1;
 181   }
 182
 183   if (access (filename, F_OK) == -1) {
 184     perrorf (g, "%s", filename);
 185     return -1;
 186   }
 187
 188   size_t len = strlen (filename) + 64;
 189   char buf[len];
 190
 191   snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, drive_if);
 192
 193   return guestfs__config (g, "-drive", buf);
 194 }
 195
 196 int
 197 guestfs__add_drive (guestfs_h *g, const char *filename)
 198 {
 199   return guestfs__add_drive_with_if (g, filename, DRIVE_IF);
 200 }
 201
 202 int
 203 guestfs__add_drive_ro (guestfs_h *g, const char *filename)
 204 {
 205   return guestfs__add_drive_ro_with_if (g, filename, DRIVE_IF);
 206 }
 207
 208 int
 209 guestfs__add_cdrom (guestfs_h *g, const char *filename)
 210 {
 211   if (strchr (filename, ',') != NULL) {
 212     error (g, _("filename cannot contain ',' (comma) character"));
 213     return -1;
 214   }
 215
 216   if (access (filename, F_OK) == -1) {
 217     perrorf (g, "%s", filename);
 218     return -1;
 219   }
 220
 221   return guestfs__config (g, "-cdrom", filename);
 222 }
 223
 224 static int is_openable (guestfs_h *g, const char *path, int flags);
 225 static void print_cmdline (guestfs_h *g);
 226
 227 int
 228 guestfs__launch (guestfs_h *g)
 229 {
 230   int r;
 231   int wfd[2], rfd[2];
 232   int tries;
 233   char unixsock[256];
 234   struct sockaddr_un addr;
 235
 236   /* Configured? */
 237   if (!g->cmdline) {
 238     error (g, _("you must call guestfs_add_drive before guestfs_launch"));
 239     return -1;
 240   }
 241
 242   if (g->state != CONFIG) {
 243     error (g, _("the libguestfs handle has already been launched"));
 244     return -1;
 245   }
 246
 247   /* Start the clock ... */
 248   gettimeofday (&g->launch_t, NULL);
 249
 250   /* Make the temporary directory. */
 251   if (!g->tmpdir) {
 252     const char *tmpdir = guestfs___tmpdir ();
 253     char dir_template[strlen (tmpdir) + 32];
 254     sprintf (dir_template, "%s/libguestfsXXXXXX", tmpdir);
 255
 256     g->tmpdir = safe_strdup (g, dir_template);
 257     if (mkdtemp (g->tmpdir) == NULL) {
 258       perrorf (g, _("%s: cannot create temporary directory"), dir_template);
 259       goto cleanup0;
 260     }
 261   }
 262
 263   /* Allow anyone to read the temporary directory.  The socket in this
 264    * directory won't be readable but anyone can see it exists if they
 265    * want. (RHBZ#610880).
 266    */
 267   if (chmod (g->tmpdir, 0755) == -1)
 268     fprintf (stderr, "chmod: %s: %m (ignored)\n", g->tmpdir);
 269
 270   /* Locate and/or build the appliance. */
 271   char *kernel = NULL, *initrd = NULL, *appliance = NULL;
 272   if (guestfs___build_appliance (g, &kernel, &initrd, &appliance) == -1)
 273     return -1;
 274
 275   if (g->verbose)
 276     guestfs___print_timestamped_message (g, "begin testing qemu features");
 277
 278   /* Get qemu help text and version. */
 279   if (qemu_supports (g, NULL) == -1)
 280     goto cleanup0;
 281
 282   /* Using virtio-serial, we need to create a local Unix domain socket
 283    * for qemu to connect to.
 284    */
 285   snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
 286   unlink (unixsock);
 287
 288   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 289   if (g->sock == -1) {
 290     perrorf (g, "socket");
 291     goto cleanup0;
 292   }
 293
 294   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 295     perrorf (g, "fcntl");
 296     goto cleanup0;
 297   }
 298
 299   addr.sun_family = AF_UNIX;
 300   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
 301   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 302
 303   if (bind (g->sock, &addr, sizeof addr) == -1) {
 304     perrorf (g, "bind");
 305     goto cleanup0;
 306   }
 307
 308   if (listen (g->sock, 1) == -1) {
 309     perrorf (g, "listen");
 310     goto cleanup0;
 311   }
 312
 313   if (!g->direct) {
 314     if (pipe (wfd) == -1 || pipe (rfd) == -1) {
 315       perrorf (g, "pipe");
 316       goto cleanup0;
 317     }
 318   }
 319
 320   if (g->verbose)
 321     guestfs___print_timestamped_message (g, "finished testing qemu features");
 322
 323   r = fork ();
 324   if (r == -1) {
 325     perrorf (g, "fork");
 326     if (!g->direct) {
 327       close (wfd[0]);
 328       close (wfd[1]);
 329       close (rfd[0]);
 330       close (rfd[1]);
 331     }
 332     goto cleanup0;
 333   }
 334
 335   if (r == 0) {                 /* Child (qemu). */
 336     char buf[256];
 337
 338     /* Set up the full command line.  Do this in the subprocess so we
 339      * don't need to worry about cleaning up.
 340      */
 341     g->cmdline[0] = g->qemu;
 342
 343     if (qemu_supports (g, "-nodefconfig"))
 344       add_cmdline (g, "-nodefconfig");
 345
 346     /* qemu sometimes needs this option to enable hardware
 347      * virtualization, but some versions of 'qemu-kvm' will use KVM
 348      * regardless (even where this option appears in the help text).
 349      * It is rumoured that there are versions of qemu where supplying
 350      * this option when hardware virtualization is not available will
 351      * cause qemu to fail, so we we have to check at least that
 352      * /dev/kvm is openable.  That's not reliable, since /dev/kvm
 353      * might be openable by qemu but not by us (think: SELinux) in
 354      * which case the user would not get hardware virtualization,
 355      * although at least shouldn't fail.  A giant clusterfuck with the
 356      * qemu command line, again.
 357      */
 358     if (qemu_supports (g, "-enable-kvm") &&
 359         is_openable (g, "/dev/kvm", O_RDWR))
 360       add_cmdline (g, "-enable-kvm");
 361
 362     /* Newer versions of qemu (from around 2009/12) changed the
 363      * behaviour of monitors so that an implicit '-monitor stdio' is
 364      * assumed if we are in -nographic mode and there is no other
 365      * -monitor option.  Only a single stdio device is allowed, so
 366      * this broke the '-serial stdio' option.  There is a new flag
 367      * called -nodefaults which gets rid of all this default crud, so
 368      * let's use that to avoid this and any future surprises.
 369      */
 370     if (qemu_supports (g, "-nodefaults"))
 371       add_cmdline (g, "-nodefaults");
 372
 373     add_cmdline (g, "-nographic");
 374
 375     snprintf (buf, sizeof buf, "%d", g->memsize);
 376     add_cmdline (g, "-m");
 377     add_cmdline (g, buf);
 378
 379     /* Force exit instead of reboot on panic */
 380     add_cmdline (g, "-no-reboot");
 381
 382     /* These options recommended by KVM developers to improve reliability. */
 383     if (qemu_supports (g, "-no-hpet"))
 384       add_cmdline (g, "-no-hpet");
 385
 386     if (qemu_supports (g, "-rtc-td-hack"))
 387       add_cmdline (g, "-rtc-td-hack");
 388
 389     /* Create the virtio serial bus. */
 390     add_cmdline (g, "-device");
 391     add_cmdline (g, "virtio-serial");
 392
 393 #if 0
 394     /* Use virtio-console (a variant form of virtio-serial) for the
 395      * guest's serial console.
 396      */
 397     add_cmdline (g, "-chardev");
 398     add_cmdline (g, "stdio,id=console");
 399     add_cmdline (g, "-device");
 400     add_cmdline (g, "virtconsole,chardev=console,name=org.libguestfs.console.0");
 401 #else
 402     /* When the above works ...  until then: */
 403     add_cmdline (g, "-serial");
 404     add_cmdline (g, "stdio");
 405 #endif
 406
 407     /* Set up virtio-serial for the communications channel. */
 408     add_cmdline (g, "-chardev");
 409     snprintf (buf, sizeof buf, "socket,path=%s,id=channel0", unixsock);
 410     add_cmdline (g, buf);
 411     add_cmdline (g, "-device");
 412     add_cmdline (g, "virtserialport,chardev=channel0,name=org.libguestfs.channel.0");
 413
 414     /* Enable user networking. */
 415     if (g->enable_network) {
 416       add_cmdline (g, "-netdev");
 417       add_cmdline (g, "user,id=usernet");
 418       add_cmdline (g, "-device");
 419       add_cmdline (g, NET_IF ",netdev=usernet");
 420     }
 421
 422 #define LINUX_CMDLINE                                                   \
 423     "panic=1 "         /* force kernel to panic if daemon exits */      \
 424     "console=ttyS0 "   /* serial console */                             \
 425     "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */   \
 426     "noapic "          /* workaround for RHBZ#502058 - ok if not SMP */ \
 427     "acpi=off "        /* we don't need ACPI, turn it off */            \
 428     "printk.time=1 "   /* display timestamp before kernel messages */   \
 429     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
 430
 431     /* Linux kernel command line. */
 432     snprintf (buf, sizeof buf,
 433               LINUX_CMDLINE
 434               "%s "             /* (selinux) */
 435               "%s "             /* (verbose) */
 436               "TERM=%s "        /* (TERM environment variable) */
 437               "%s",             /* (append) */
 438               g->selinux ? "selinux=1 enforcing=0" : "selinux=0",
 439               g->verbose ? "guestfs_verbose=1" : "",
 440               getenv ("TERM") ? : "linux",
 441               g->append ? g->append : "");
 442
 443     add_cmdline (g, "-kernel");
 444     add_cmdline (g, kernel);
 445     add_cmdline (g, "-initrd");
 446     add_cmdline (g, initrd);
 447     add_cmdline (g, "-append");
 448     add_cmdline (g, buf);
 449
 450     /* Add the ext2 appliance drive (last of all). */
 451     if (appliance) {
 452       const char *cachemode = "";
 453       if (qemu_supports (g, "cache=")) {
 454         if (qemu_supports (g, "unsafe"))
 455           cachemode = ",cache=unsafe";
 456         else if (qemu_supports (g, "writeback"))
 457           cachemode = ",cache=writeback";
 458       }
 459
 460       char buf2[PATH_MAX + 64];
 461       add_cmdline (g, "-drive");
 462       snprintf (buf2, sizeof buf2, "file=%s,snapshot=on,if=" DRIVE_IF "%s",
 463                 appliance, cachemode);
 464       add_cmdline (g, buf2);
 465     }
 466
 467     /* Finish off the command line. */
 468     incr_cmdline_size (g);
 469     g->cmdline[g->cmdline_size-1] = NULL;
 470
 471     if (g->verbose)
 472       print_cmdline (g);
 473
 474     if (!g->direct) {
 475       /* Set up stdin, stdout. */
 476       close (0);
 477       close (1);
 478       close (wfd[1]);
 479       close (rfd[0]);
 480
 481       if (dup (wfd[0]) == -1) {
 482       dup_failed:
 483         perror ("dup failed");
 484         _exit (EXIT_FAILURE);
 485       }
 486       if (dup (rfd[1]) == -1)
 487         goto dup_failed;
 488
 489       close (wfd[0]);
 490       close (rfd[1]);
 491     }
 492
 493 #if 0
 494     /* Set up a new process group, so we can signal this process
 495      * and all subprocesses (eg. if qemu is really a shell script).
 496      */
 497     setpgid (0, 0);
 498 #endif
 499
 500     setenv ("LC_ALL", "C", 1);
 501
 502     execv (g->qemu, g->cmdline); /* Run qemu. */
 503     perror (g->qemu);
 504     _exit (EXIT_FAILURE);
 505   }
 506
 507   /* Parent (library). */
 508   g->pid = r;
 509
 510   free (kernel);
 511   kernel = NULL;
 512   free (initrd);
 513   initrd = NULL;
 514   free (appliance);
 515   appliance = NULL;
 516
 517   /* Fork the recovery process off which will kill qemu if the parent
 518    * process fails to do so (eg. if the parent segfaults).
 519    */
 520   g->recoverypid = -1;
 521   if (g->recovery_proc) {
 522     r = fork ();
 523     if (r == 0) {
 524       pid_t qemu_pid = g->pid;
 525       pid_t parent_pid = getppid ();
 526
 527       /* Writing to argv is hideously complicated and error prone.  See:
 528        * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
 529        */
 530
 531       /* Loop around waiting for one or both of the other processes to
 532        * disappear.  It's fair to say this is very hairy.  The PIDs that
 533        * we are looking at might be reused by another process.  We are
 534        * effectively polling.  Is the cure worse than the disease?
 535        */
 536       for (;;) {
 537         if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
 538           _exit (EXIT_SUCCESS);
 539         if (kill (parent_pid, 0) == -1) {
 540           /* Parent's gone away, qemu still around, so kill qemu. */
 541           kill (qemu_pid, 9);
 542           _exit (EXIT_SUCCESS);
 543         }
 544         sleep (2);
 545       }
 546     }
 547
 548     /* Don't worry, if the fork failed, this will be -1.  The recovery
 549      * process isn't essential.
 550      */
 551     g->recoverypid = r;
 552   }
 553
 554   if (!g->direct) {
 555     /* Close the other ends of the pipe. */
 556     close (wfd[0]);
 557     close (rfd[1]);
 558
 559     if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
 560         fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
 561       perrorf (g, "fcntl");
 562       goto cleanup1;
 563     }
 564
 565     g->fd[0] = wfd[1];          /* stdin of child */
 566     g->fd[1] = rfd[0];          /* stdout of child */
 567   } else {
 568     g->fd[0] = open ("/dev/null", O_RDWR);
 569     if (g->fd[0] == -1) {
 570       perrorf (g, "open /dev/null");
 571       goto cleanup1;
 572     }
 573     g->fd[1] = dup (g->fd[0]);
 574     if (g->fd[1] == -1) {
 575       perrorf (g, "dup");
 576       close (g->fd[0]);
 577       goto cleanup1;
 578     }
 579   }
 580
 581   g->state = LAUNCHING;
 582
 583   /* Wait for qemu to start and to connect back to us via
 584    * virtio-serial and send the GUESTFS_LAUNCH_FLAG message.
 585    */
 586   r = guestfs___accept_from_daemon (g);
 587   if (r == -1)
 588     goto cleanup1;
 589
 590   close (g->sock); /* Close the listening socket. */
 591   g->sock = r; /* This is the accepted data socket. */
 592
 593   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 594     perrorf (g, "fcntl");
 595     goto cleanup1;
 596   }
 597
 598   uint32_t size;
 599   void *buf = NULL;
 600   r = guestfs___recv_from_daemon (g, &size, &buf);
 601   free (buf);
 602
 603   if (r == -1) return -1;
 604
 605   if (size != GUESTFS_LAUNCH_FLAG) {
 606     error (g, _("guestfs_launch failed, see earlier error messages"));
 607     goto cleanup1;
 608   }
 609
 610   if (g->verbose)
 611     guestfs___print_timestamped_message (g, "appliance is up");
 612
 613   /* This is possible in some really strange situations, such as
 614    * guestfsd starts up OK but then qemu immediately exits.  Check for
 615    * it because the caller is probably expecting to be able to send
 616    * commands after this function returns.
 617    */
 618   if (g->state != READY) {
 619     error (g, _("qemu launched and contacted daemon, but state != READY"));
 620     goto cleanup1;
 621   }
 622
 623   return 0;
 624
 625  cleanup1:
 626   if (!g->direct) {
 627     close (wfd[1]);
 628     close (rfd[0]);
 629   }
 630   if (g->pid > 0) kill (g->pid, 9);
 631   if (g->recoverypid > 0) kill (g->recoverypid, 9);
 632   waitpid (g->pid, NULL, 0);
 633   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 634   g->fd[0] = -1;
 635   g->fd[1] = -1;
 636   g->pid = 0;
 637   g->recoverypid = 0;
 638   memset (&g->launch_t, 0, sizeof g->launch_t);
 639
 640  cleanup0:
 641   if (g->sock >= 0) {
 642     close (g->sock);
 643     g->sock = -1;
 644   }
 645   g->state = CONFIG;
 646   free (kernel);
 647   free (initrd);
 648   free (appliance);
 649   return -1;
 650 }
 651
 652 const char *
 653 guestfs___tmpdir (void)
 654 {
 655   const char *tmpdir;
 656
 657 #ifdef P_tmpdir
 658   tmpdir = P_tmpdir;
 659 #else
 660   tmpdir = "/tmp";
 661 #endif
 662
 663   const char *t = getenv ("TMPDIR");
 664   if (t) tmpdir = t;
 665
 666   return tmpdir;
 667 }
 668
 669 /* This function is used to print the qemu command line before it gets
 670  * executed, when in verbose mode.
 671  */
 672 static void
 673 print_cmdline (guestfs_h *g)
 674 {
 675   int i = 0;
 676   int needs_quote;
 677
 678   while (g->cmdline[i]) {
 679     if (g->cmdline[i][0] == '-') /* -option starts a new line */
 680       fprintf (stderr, " \\\n   ");
 681
 682     if (i > 0) fputc (' ', stderr);
 683
 684     /* Does it need shell quoting?  This only deals with simple cases. */
 685     needs_quote = strcspn (g->cmdline[i], " ") != strlen (g->cmdline[i]);
 686
 687     if (needs_quote) fputc ('\'', stderr);
 688     fprintf (stderr, "%s", g->cmdline[i]);
 689     if (needs_quote) fputc ('\'', stderr);
 690     i++;
 691   }
 692
 693   fputc ('\n', stderr);
 694 }
 695
 696 /* Compute Y - X and return the result in milliseconds.
 697  * Approximately the same as this code:
 698  * http://www.mpp.mpg.de/~huber/util/timevaldiff.c
 699  */
 700 static int64_t
 701 timeval_diff (const struct timeval *x, const struct timeval *y)
 702 {
 703   int64_t msec;
 704
 705   msec = (y->tv_sec - x->tv_sec) * 1000;
 706   msec += (y->tv_usec - x->tv_usec) / 1000;
 707   return msec;
 708 }
 709
 710 void
 711 guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...)
 712 {
 713   va_list args;
 714   char *msg;
 715   int err;
 716   struct timeval tv;
 717
 718   va_start (args, fs);
 719   err = vasprintf (&msg, fs, args);
 720   va_end (args);
 721
 722   if (err < 0) return;
 723
 724   gettimeofday (&tv, NULL);
 725
 726   fprintf (stderr, "[%05" PRIi64 "ms] %s\n",
 727            timeval_diff (&g->launch_t, &tv), msg);
 728
 729   free (msg);
 730 }
 731
 732 static int read_all (guestfs_h *g, FILE *fp, char **ret);
 733
 734 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
 735  * 'qemu -version' so we know what options this qemu supports and
 736  * the version.
 737  */
 738 static int
 739 test_qemu (guestfs_h *g)
 740 {
 741   char cmd[1024];
 742   FILE *fp;
 743
 744   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -help", g->qemu);
 745
 746   fp = popen (cmd, "r");
 747   /* qemu -help should always work (qemu -version OTOH wasn't
 748    * supported by qemu 0.9).  If this command doesn't work then it
 749    * probably indicates that the qemu binary is missing.
 750    */
 751   if (!fp) {
 752     /* XXX This error is never printed, even if the qemu binary
 753      * doesn't exist.  Why?
 754      */
 755   error:
 756     perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
 757     return -1;
 758   }
 759
 760   if (read_all (g, fp, &g->qemu_help) == -1)
 761     goto error;
 762
 763   if (pclose (fp) == -1)
 764     goto error;
 765
 766   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -version 2>/dev/null",
 767             g->qemu);
 768
 769   fp = popen (cmd, "r");
 770   if (fp) {
 771     /* Intentionally ignore errors. */
 772     read_all (g, fp, &g->qemu_version);
 773     pclose (fp);
 774   }
 775
 776   return 0;
 777 }
 778
 779 static int
 780 read_all (guestfs_h *g, FILE *fp, char **ret)
 781 {
 782   int r, n = 0;
 783   char *p;
 784
 785  again:
 786   if (feof (fp)) {
 787     *ret = safe_realloc (g, *ret, n + 1);
 788     (*ret)[n] = '\0';
 789     return n;
 790   }
 791
 792   *ret = safe_realloc (g, *ret, n + BUFSIZ);
 793   p = &(*ret)[n];
 794   r = fread (p, 1, BUFSIZ, fp);
 795   if (ferror (fp)) {
 796     perrorf (g, "read");
 797     return -1;
 798   }
 799   n += r;
 800   goto again;
 801 }
 802
 803 /* Test if option is supported by qemu command line (just by grepping
 804  * the help text).
 805  *
 806  * The first time this is used, it has to run the external qemu
 807  * binary.  If that fails, it returns -1.
 808  *
 809  * To just do the first-time run of the qemu binary, call this with
 810  * option == NULL, in which case it will return -1 if there was an
 811  * error doing that.
 812  */
 813 static int
 814 qemu_supports (guestfs_h *g, const char *option)
 815 {
 816   if (!g->qemu_help) {
 817     if (test_qemu (g) == -1)
 818       return -1;
 819   }
 820
 821   if (option == NULL)
 822     return 1;
 823
 824   return strstr (g->qemu_help, option) != NULL;
 825 }
 826
 827 /* Check if a file can be opened. */
 828 static int
 829 is_openable (guestfs_h *g, const char *path, int flags)
 830 {
 831   int fd = open (path, flags);
 832   if (fd == -1) {
 833     if (g->verbose)
 834       perror (path);
 835     return 0;
 836   }
 837   close (fd);
 838   return 1;
 839 }
 840
 841 /* You had to call this function after launch in versions <= 1.0.70,
 842  * but it is now a no-op.
 843  */
 844 int
 845 guestfs__wait_ready (guestfs_h *g)
 846 {
 847   if (g->state != READY)  {
 848     error (g, _("qemu has not been launched yet"));
 849     return -1;
 850   }
 851
 852   return 0;
 853 }
 854
 855 int
 856 guestfs__kill_subprocess (guestfs_h *g)
 857 {
 858   if (g->state == CONFIG) {
 859     error (g, _("no subprocess to kill"));
 860     return -1;
 861   }
 862
 863   if (g->verbose)
 864     fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
 865
 866   if (g->pid > 0) kill (g->pid, SIGTERM);
 867   if (g->recoverypid > 0) kill (g->recoverypid, 9);
 868
 869   return 0;
 870 }
 871
 872 /* Access current state. */
 873 int
 874 guestfs__is_config (guestfs_h *g)
 875 {
 876   return g->state == CONFIG;
 877 }
 878
 879 int
 880 guestfs__is_launching (guestfs_h *g)
 881 {
 882   return g->state == LAUNCHING;
 883 }
 884
 885 int
 886 guestfs__is_ready (guestfs_h *g)
 887 {
 888   return g->state == READY;
 889 }
 890
 891 int
 892 guestfs__is_busy (guestfs_h *g)
 893 {
 894   return g->state == BUSY;
 895 }
 896
 897 int
 898 guestfs__get_state (guestfs_h *g)
 899 {
 900   return g->state;
 901 }