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