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 "c-ctype.h"
  65 #include "glthread/lock.h"
  66 #include "ignore-value.h"
  67
  68 #include "guestfs.h"
  69 #include "guestfs-internal.h"
  70 #include "guestfs-internal-actions.h"
  71 #include "guestfs_protocol.h"
  72
  73 static int qemu_supports (guestfs_h *g, const char *option);
  74
  75 /* Add a string to the current command line. */
  76 static void
  77 incr_cmdline_size (guestfs_h *g)
  78 {
  79   if (g->cmdline == NULL) {
  80     /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
  81     g->cmdline_size = 1;
  82     g->cmdline = safe_malloc (g, sizeof (char *));
  83     g->cmdline[0] = NULL;
  84   }
  85
  86   g->cmdline_size++;
  87   g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
  88 }
  89
  90 static int
  91 add_cmdline (guestfs_h *g, const char *str)
  92 {
  93   if (g->state != CONFIG) {
  94     error (g,
  95         _("command line cannot be altered after qemu subprocess launched"));
  96     return -1;
  97   }
  98
  99   incr_cmdline_size (g);
 100   g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
 101   return 0;
 102 }
 103
 104 int
 105 guestfs__config (guestfs_h *g,
 106                  const char *qemu_param, const char *qemu_value)
 107 {
 108   if (qemu_param[0] != '-') {
 109     error (g, _("guestfs_config: parameter must begin with '-' character"));
 110     return -1;
 111   }
 112
 113   /* A bit fascist, but the user will probably break the extra
 114    * parameters that we add if they try to set any of these.
 115    */
 116   if (STREQ (qemu_param, "-kernel") ||
 117       STREQ (qemu_param, "-initrd") ||
 118       STREQ (qemu_param, "-nographic") ||
 119       STREQ (qemu_param, "-serial") ||
 120       STREQ (qemu_param, "-full-screen") ||
 121       STREQ (qemu_param, "-std-vga") ||
 122       STREQ (qemu_param, "-vnc")) {
 123     error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
 124     return -1;
 125   }
 126
 127   if (add_cmdline (g, qemu_param) != 0) return -1;
 128
 129   if (qemu_value != NULL) {
 130     if (add_cmdline (g, qemu_value) != 0) return -1;
 131   }
 132
 133   return 0;
 134 }
 135
 136 int
 137 guestfs__add_drive_with_if (guestfs_h *g, const char *filename,
 138                             const char *drive_if)
 139 {
 140   size_t len = strlen (filename) + 64;
 141   char buf[len];
 142
 143   if (strchr (filename, ',') != NULL) {
 144     error (g, _("filename cannot contain ',' (comma) character"));
 145     return -1;
 146   }
 147
 148   /* cache=off improves reliability in the event of a host crash.
 149    *
 150    * However this option causes qemu to try to open the file with
 151    * O_DIRECT.  This fails on some filesystem types (notably tmpfs).
 152    * So we check if we can open the file with or without O_DIRECT,
 153    * and use cache=off (or not) accordingly.
 154    *
 155    * This test also checks for the presence of the file, which
 156    * is a documented semantic of this interface.
 157    */
 158   int fd = open (filename, O_RDONLY|O_DIRECT);
 159   if (fd >= 0) {
 160     close (fd);
 161     snprintf (buf, len, "file=%s,cache=off,if=%s", filename, drive_if);
 162   } else {
 163     fd = open (filename, O_RDONLY);
 164     if (fd >= 0) {
 165       close (fd);
 166       snprintf (buf, len, "file=%s,if=%s", filename, drive_if);
 167     } else {
 168       perrorf (g, "%s", filename);
 169       return -1;
 170     }
 171   }
 172
 173   return guestfs__config (g, "-drive", buf);
 174 }
 175
 176 int
 177 guestfs__add_drive_ro_with_if (guestfs_h *g, const char *filename,
 178                                const char *drive_if)
 179 {
 180   if (strchr (filename, ',') != NULL) {
 181     error (g, _("filename cannot contain ',' (comma) character"));
 182     return -1;
 183   }
 184
 185   if (access (filename, F_OK) == -1) {
 186     perrorf (g, "%s", filename);
 187     return -1;
 188   }
 189
 190   size_t len = strlen (filename) + 64;
 191   char buf[len];
 192
 193   snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, drive_if);
 194
 195   return guestfs__config (g, "-drive", buf);
 196 }
 197
 198 int
 199 guestfs__add_drive (guestfs_h *g, const char *filename)
 200 {
 201   return guestfs__add_drive_with_if (g, filename, DRIVE_IF);
 202 }
 203
 204 int
 205 guestfs__add_drive_ro (guestfs_h *g, const char *filename)
 206 {
 207   return guestfs__add_drive_ro_with_if (g, filename, DRIVE_IF);
 208 }
 209
 210 int
 211 guestfs__add_cdrom (guestfs_h *g, const char *filename)
 212 {
 213   if (strchr (filename, ',') != NULL) {
 214     error (g, _("filename cannot contain ',' (comma) character"));
 215     return -1;
 216   }
 217
 218   if (access (filename, F_OK) == -1) {
 219     perrorf (g, "%s", filename);
 220     return -1;
 221   }
 222
 223   return guestfs__config (g, "-cdrom", filename);
 224 }
 225
 226 static int is_openable (guestfs_h *g, const char *path, int flags);
 227 static void print_cmdline (guestfs_h *g);
 228
 229 int
 230 guestfs__launch (guestfs_h *g)
 231 {
 232   int r;
 233   int wfd[2], rfd[2];
 234   int tries;
 235   char unixsock[256];
 236   struct sockaddr_un addr;
 237
 238   /* Configured? */
 239   if (!g->cmdline) {
 240     error (g, _("you must call guestfs_add_drive before guestfs_launch"));
 241     return -1;
 242   }
 243
 244   if (g->state != CONFIG) {
 245     error (g, _("the libguestfs handle has already been launched"));
 246     return -1;
 247   }
 248
 249   /* Start the clock ... */
 250   gettimeofday (&g->launch_t, NULL);
 251
 252   /* Make the temporary directory. */
 253   if (!g->tmpdir) {
 254     const char *tmpdir = guestfs___tmpdir ();
 255     char dir_template[strlen (tmpdir) + 32];
 256     sprintf (dir_template, "%s/libguestfsXXXXXX", tmpdir);
 257
 258     g->tmpdir = safe_strdup (g, dir_template);
 259     if (mkdtemp (g->tmpdir) == NULL) {
 260       perrorf (g, _("%s: cannot create temporary directory"), dir_template);
 261       goto cleanup0;
 262     }
 263   }
 264
 265   /* Allow anyone to read the temporary directory.  The socket in this
 266    * directory won't be readable but anyone can see it exists if they
 267    * want. (RHBZ#610880).
 268    */
 269   if (chmod (g->tmpdir, 0755) == -1)
 270     fprintf (stderr, "chmod: %s: %m (ignored)\n", g->tmpdir);
 271
 272   /* Locate and/or build the appliance. */
 273   char *kernel = NULL, *initrd = NULL, *appliance = NULL;
 274   if (guestfs___build_appliance (g, &kernel, &initrd, &appliance) == -1)
 275     return -1;
 276
 277   if (g->verbose)
 278     guestfs___print_timestamped_message (g, "begin testing qemu features");
 279
 280   /* Get qemu help text and version. */
 281   if (qemu_supports (g, NULL) == -1)
 282     goto cleanup0;
 283
 284   /* Using virtio-serial, we need to create a local Unix domain socket
 285    * for qemu to connect to.
 286    */
 287   snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
 288   unlink (unixsock);
 289
 290   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 291   if (g->sock == -1) {
 292     perrorf (g, "socket");
 293     goto cleanup0;
 294   }
 295
 296   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 297     perrorf (g, "fcntl");
 298     goto cleanup0;
 299   }
 300
 301   addr.sun_family = AF_UNIX;
 302   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
 303   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 304
 305   if (bind (g->sock, &addr, sizeof addr) == -1) {
 306     perrorf (g, "bind");
 307     goto cleanup0;
 308   }
 309
 310   if (listen (g->sock, 1) == -1) {
 311     perrorf (g, "listen");
 312     goto cleanup0;
 313   }
 314
 315   if (!g->direct) {
 316     if (pipe (wfd) == -1 || pipe (rfd) == -1) {
 317       perrorf (g, "pipe");
 318       goto cleanup0;
 319     }
 320   }
 321
 322   if (g->verbose)
 323     guestfs___print_timestamped_message (g, "finished testing qemu features");
 324
 325   r = fork ();
 326   if (r == -1) {
 327     perrorf (g, "fork");
 328     if (!g->direct) {
 329       close (wfd[0]);
 330       close (wfd[1]);
 331       close (rfd[0]);
 332       close (rfd[1]);
 333     }
 334     goto cleanup0;
 335   }
 336
 337   if (r == 0) {                 /* Child (qemu). */
 338     char buf[256];
 339
 340     /* Set up the full command line.  Do this in the subprocess so we
 341      * don't need to worry about cleaning up.
 342      */
 343     g->cmdline[0] = g->qemu;
 344
 345     if (qemu_supports (g, "-nodefconfig"))
 346       add_cmdline (g, "-nodefconfig");
 347
 348     /* qemu sometimes needs this option to enable hardware
 349      * virtualization, but some versions of 'qemu-kvm' will use KVM
 350      * regardless (even where this option appears in the help text).
 351      * It is rumoured that there are versions of qemu where supplying
 352      * this option when hardware virtualization is not available will
 353      * cause qemu to fail, so we we have to check at least that
 354      * /dev/kvm is openable.  That's not reliable, since /dev/kvm
 355      * might be openable by qemu but not by us (think: SELinux) in
 356      * which case the user would not get hardware virtualization,
 357      * although at least shouldn't fail.  A giant clusterfuck with the
 358      * qemu command line, again.
 359      */
 360     if (qemu_supports (g, "-enable-kvm") &&
 361         is_openable (g, "/dev/kvm", O_RDWR))
 362       add_cmdline (g, "-enable-kvm");
 363
 364     /* Newer versions of qemu (from around 2009/12) changed the
 365      * behaviour of monitors so that an implicit '-monitor stdio' is
 366      * assumed if we are in -nographic mode and there is no other
 367      * -monitor option.  Only a single stdio device is allowed, so
 368      * this broke the '-serial stdio' option.  There is a new flag
 369      * called -nodefaults which gets rid of all this default crud, so
 370      * let's use that to avoid this and any future surprises.
 371      */
 372     if (qemu_supports (g, "-nodefaults"))
 373       add_cmdline (g, "-nodefaults");
 374
 375     add_cmdline (g, "-nographic");
 376
 377     snprintf (buf, sizeof buf, "%d", g->memsize);
 378     add_cmdline (g, "-m");
 379     add_cmdline (g, buf);
 380
 381     /* Force exit instead of reboot on panic */
 382     add_cmdline (g, "-no-reboot");
 383
 384     /* These options recommended by KVM developers to improve reliability. */
 385     if (qemu_supports (g, "-no-hpet"))
 386       add_cmdline (g, "-no-hpet");
 387
 388     if (qemu_supports (g, "-rtc-td-hack"))
 389       add_cmdline (g, "-rtc-td-hack");
 390
 391     /* Create the virtio serial bus. */
 392     add_cmdline (g, "-device");
 393     add_cmdline (g, "virtio-serial");
 394
 395 #if 0
 396     /* Use virtio-console (a variant form of virtio-serial) for the
 397      * guest's serial console.
 398      */
 399     add_cmdline (g, "-chardev");
 400     add_cmdline (g, "stdio,id=console");
 401     add_cmdline (g, "-device");
 402     add_cmdline (g, "virtconsole,chardev=console,name=org.libguestfs.console.0");
 403 #else
 404     /* When the above works ...  until then: */
 405     add_cmdline (g, "-serial");
 406     add_cmdline (g, "stdio");
 407 #endif
 408
 409     /* Set up virtio-serial for the communications channel. */
 410     add_cmdline (g, "-chardev");
 411     snprintf (buf, sizeof buf, "socket,path=%s,id=channel0", unixsock);
 412     add_cmdline (g, buf);
 413     add_cmdline (g, "-device");
 414     add_cmdline (g, "virtserialport,chardev=channel0,name=org.libguestfs.channel.0");
 415
 416     /* Enable user networking. */
 417     if (g->enable_network) {
 418       add_cmdline (g, "-netdev");
 419       add_cmdline (g, "user,id=usernet");
 420       add_cmdline (g, "-device");
 421       add_cmdline (g, NET_IF ",netdev=usernet");
 422     }
 423
 424 #define LINUX_CMDLINE                                                   \
 425     "panic=1 "         /* force kernel to panic if daemon exits */      \
 426     "console=ttyS0 "   /* serial console */                             \
 427     "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */   \
 428     "noapic "          /* workaround for RHBZ#502058 - ok if not SMP */ \
 429     "acpi=off "        /* we don't need ACPI, turn it off */            \
 430     "printk.time=1 "   /* display timestamp before kernel messages */   \
 431     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
 432
 433     /* Linux kernel command line. */
 434     snprintf (buf, sizeof buf,
 435               LINUX_CMDLINE
 436               "%s "             /* (selinux) */
 437               "%s "             /* (verbose) */
 438               "TERM=%s "        /* (TERM environment variable) */
 439               "%s",             /* (append) */
 440               g->selinux ? "selinux=1 enforcing=0" : "selinux=0",
 441               g->verbose ? "guestfs_verbose=1" : "",
 442               getenv ("TERM") ? : "linux",
 443               g->append ? g->append : "");
 444
 445     add_cmdline (g, "-kernel");
 446     add_cmdline (g, kernel);
 447     add_cmdline (g, "-initrd");
 448     add_cmdline (g, initrd);
 449     add_cmdline (g, "-append");
 450     add_cmdline (g, buf);
 451
 452     /* Add the ext2 appliance drive (last of all). */
 453     if (appliance) {
 454       const char *cachemode = "";
 455       if (qemu_supports (g, "cache=")) {
 456         if (qemu_supports (g, "unsafe"))
 457           cachemode = ",cache=unsafe";
 458         else if (qemu_supports (g, "writeback"))
 459           cachemode = ",cache=writeback";
 460       }
 461
 462       char buf2[PATH_MAX + 64];
 463       add_cmdline (g, "-drive");
 464       snprintf (buf2, sizeof buf2, "file=%s,snapshot=on,if=" DRIVE_IF "%s",
 465                 appliance, cachemode);
 466       add_cmdline (g, buf2);
 467     }
 468
 469     /* Finish off the command line. */
 470     incr_cmdline_size (g);
 471     g->cmdline[g->cmdline_size-1] = NULL;
 472
 473     if (g->verbose)
 474       print_cmdline (g);
 475
 476     if (!g->direct) {
 477       /* Set up stdin, stdout. */
 478       close (0);
 479       close (1);
 480       close (wfd[1]);
 481       close (rfd[0]);
 482
 483       if (dup (wfd[0]) == -1) {
 484       dup_failed:
 485         perror ("dup failed");
 486         _exit (EXIT_FAILURE);
 487       }
 488       if (dup (rfd[1]) == -1)
 489         goto dup_failed;
 490
 491       close (wfd[0]);
 492       close (rfd[1]);
 493     }
 494
 495 #if 0
 496     /* Set up a new process group, so we can signal this process
 497      * and all subprocesses (eg. if qemu is really a shell script).
 498      */
 499     setpgid (0, 0);
 500 #endif
 501
 502     setenv ("LC_ALL", "C", 1);
 503
 504     execv (g->qemu, g->cmdline); /* Run qemu. */
 505     perror (g->qemu);
 506     _exit (EXIT_FAILURE);
 507   }
 508
 509   /* Parent (library). */
 510   g->pid = r;
 511
 512   free (kernel);
 513   kernel = NULL;
 514   free (initrd);
 515   initrd = 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 }