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