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     "acpi=off "        /* we don't need ACPI, turn it off */            \
 611     "printk.time=1 "   /* display timestamp before kernel messages */   \
 612     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
 613
 614     /* Linux kernel command line. */
 615     snprintf (buf, sizeof buf,
 616               LINUX_CMDLINE
 617               "%s "             /* (selinux) */
 618               "%s "             /* (verbose) */
 619               "TERM=%s "        /* (TERM environment variable) */
 620               "%s",             /* (append) */
 621               g->selinux ? "selinux=1 enforcing=0" : "selinux=0",
 622               g->verbose ? "guestfs_verbose=1" : "",
 623               getenv ("TERM") ? : "linux",
 624               g->append ? g->append : "");
 625
 626     add_cmdline (g, "-kernel");
 627     add_cmdline (g, kernel);
 628     add_cmdline (g, "-initrd");
 629     add_cmdline (g, initrd);
 630     add_cmdline (g, "-append");
 631     add_cmdline (g, buf);
 632
 633     /* Add the ext2 appliance drive (last of all). */
 634     if (appliance) {
 635       const char *cachemode = "";
 636       if (qemu_supports (g, "cache=")) {
 637         if (qemu_supports (g, "unsafe"))
 638           cachemode = ",cache=unsafe";
 639         else if (qemu_supports (g, "writeback"))
 640           cachemode = ",cache=writeback";
 641       }
 642
 643       char buf2[PATH_MAX + 64];
 644       add_cmdline (g, "-drive");
 645       snprintf (buf2, sizeof buf2, "file=%s,snapshot=on,if=" DRIVE_IF "%s",
 646                 appliance, cachemode);
 647       add_cmdline (g, buf2);
 648     }
 649
 650     /* Finish off the command line. */
 651     incr_cmdline_size (g);
 652     g->cmdline[g->cmdline_size-1] = NULL;
 653
 654     if (!g->direct) {
 655       /* Set up stdin, stdout, stderr. */
 656       close (0);
 657       close (1);
 658       close (wfd[1]);
 659       close (rfd[0]);
 660
 661       /* Stdin. */
 662       if (dup (wfd[0]) == -1) {
 663       dup_failed:
 664         perror ("dup failed");
 665         _exit (EXIT_FAILURE);
 666       }
 667       /* Stdout. */
 668       if (dup (rfd[1]) == -1)
 669         goto dup_failed;
 670
 671       /* Particularly since qemu 0.15, qemu spews all sorts of debug
 672        * information on stderr.  It is useful to both capture this and
 673        * not confuse casual users, so send stderr to the pipe as well.
 674        */
 675       close (2);
 676       if (dup (rfd[1]) == -1)
 677         goto dup_failed;
 678
 679       close (wfd[0]);
 680       close (rfd[1]);
 681     }
 682
 683     /* Dump the command line (after setting up stderr above). */
 684     if (g->verbose)
 685       print_qemu_command_line (g, g->cmdline);
 686
 687     /* Put qemu in a new process group. */
 688     if (g->pgroup)
 689       setpgid (0, 0);
 690
 691     setenv ("LC_ALL", "C", 1);
 692
 693     execv (g->qemu, g->cmdline); /* Run qemu. */
 694     perror (g->qemu);
 695     _exit (EXIT_FAILURE);
 696   }
 697
 698   /* Parent (library). */
 699   g->pid = r;
 700
 701   free (kernel);
 702   kernel = NULL;
 703   free (initrd);
 704   initrd = NULL;
 705   free (appliance);
 706   appliance = NULL;
 707
 708   /* Fork the recovery process off which will kill qemu if the parent
 709    * process fails to do so (eg. if the parent segfaults).
 710    */
 711   g->recoverypid = -1;
 712   if (g->recovery_proc) {
 713     r = fork ();
 714     if (r == 0) {
 715       pid_t qemu_pid = g->pid;
 716       pid_t parent_pid = getppid ();
 717
 718       /* It would be nice to be able to put this in the same process
 719        * group as qemu (ie. setpgid (0, qemu_pid)).  However this is
 720        * not possible because we don't have any guarantee here that
 721        * the qemu process has started yet.
 722        */
 723       if (g->pgroup)
 724         setpgid (0, 0);
 725
 726       /* Writing to argv is hideously complicated and error prone.  See:
 727        * http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/misc/ps_status.c;hb=HEAD
 728        */
 729
 730       /* Loop around waiting for one or both of the other processes to
 731        * disappear.  It's fair to say this is very hairy.  The PIDs that
 732        * we are looking at might be reused by another process.  We are
 733        * effectively polling.  Is the cure worse than the disease?
 734        */
 735       for (;;) {
 736         if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
 737           _exit (EXIT_SUCCESS);
 738         if (kill (parent_pid, 0) == -1) {
 739           /* Parent's gone away, qemu still around, so kill qemu. */
 740           kill (qemu_pid, 9);
 741           _exit (EXIT_SUCCESS);
 742         }
 743         sleep (2);
 744       }
 745     }
 746
 747     /* Don't worry, if the fork failed, this will be -1.  The recovery
 748      * process isn't essential.
 749      */
 750     g->recoverypid = r;
 751   }
 752
 753   if (!g->direct) {
 754     /* Close the other ends of the pipe. */
 755     close (wfd[0]);
 756     close (rfd[1]);
 757
 758     if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
 759         fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
 760       perrorf (g, "fcntl");
 761       goto cleanup1;
 762     }
 763
 764     g->fd[0] = wfd[1];          /* stdin of child */
 765     g->fd[1] = rfd[0];          /* stdout of child */
 766   } else {
 767     g->fd[0] = open ("/dev/null", O_RDWR);
 768     if (g->fd[0] == -1) {
 769       perrorf (g, "open /dev/null");
 770       goto cleanup1;
 771     }
 772     g->fd[1] = dup (g->fd[0]);
 773     if (g->fd[1] == -1) {
 774       perrorf (g, "dup");
 775       close (g->fd[0]);
 776       goto cleanup1;
 777     }
 778   }
 779
 780   g->state = LAUNCHING;
 781
 782   /* Wait for qemu to start and to connect back to us via
 783    * virtio-serial and send the GUESTFS_LAUNCH_FLAG message.
 784    */
 785   r = guestfs___accept_from_daemon (g);
 786   if (r == -1)
 787     goto cleanup1;
 788
 789   close (g->sock); /* Close the listening socket. */
 790   g->sock = r; /* This is the accepted data socket. */
 791
 792   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 793     perrorf (g, "fcntl");
 794     goto cleanup1;
 795   }
 796
 797   uint32_t size;
 798   void *buf = NULL;
 799   r = guestfs___recv_from_daemon (g, &size, &buf);
 800   free (buf);
 801
 802   if (r == -1) return -1;
 803
 804   if (size != GUESTFS_LAUNCH_FLAG) {
 805     error (g, _("guestfs_launch failed, see earlier error messages"));
 806     goto cleanup1;
 807   }
 808
 809   if (g->verbose)
 810     guestfs___print_timestamped_message (g, "appliance is up");
 811
 812   /* This is possible in some really strange situations, such as
 813    * guestfsd starts up OK but then qemu immediately exits.  Check for
 814    * it because the caller is probably expecting to be able to send
 815    * commands after this function returns.
 816    */
 817   if (g->state != READY) {
 818     error (g, _("qemu launched and contacted daemon, but state != READY"));
 819     goto cleanup1;
 820   }
 821
 822   guestfs___launch_send_progress (g, 12);
 823
 824   return 0;
 825
 826  cleanup1:
 827   if (!g->direct) {
 828     close (wfd[1]);
 829     close (rfd[0]);
 830   }
 831   if (g->pid > 0) kill (g->pid, 9);
 832   if (g->recoverypid > 0) kill (g->recoverypid, 9);
 833   if (g->pid > 0) waitpid (g->pid, NULL, 0);
 834   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 835   g->fd[0] = -1;
 836   g->fd[1] = -1;
 837   g->pid = 0;
 838   g->recoverypid = 0;
 839   memset (&g->launch_t, 0, sizeof g->launch_t);
 840
 841  cleanup0:
 842   if (g->sock >= 0) {
 843     close (g->sock);
 844     g->sock = -1;
 845   }
 846   g->state = CONFIG;
 847   free (kernel);
 848   free (initrd);
 849   free (appliance);
 850   return -1;
 851 }
 852
 853 /* Alternate attach method: instead of launching the appliance,
 854  * connect to an existing unix socket.
 855  */
 856 static int
 857 connect_unix_socket (guestfs_h *g, const char *sockpath)
 858 {
 859   int r;
 860   struct sockaddr_un addr;
 861
 862   /* Start the clock ... */
 863   gettimeofday (&g->launch_t, NULL);
 864
 865   /* Set these to nothing so we don't try to kill random processes or
 866    * read from random file descriptors.
 867    */
 868   g->pid = 0;
 869   g->recoverypid = 0;
 870   g->fd[0] = -1;
 871   g->fd[1] = -1;
 872
 873   if (g->verbose)
 874     guestfs___print_timestamped_message (g, "connecting to %s", sockpath);
 875
 876   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 877   if (g->sock == -1) {
 878     perrorf (g, "socket");
 879     return -1;
 880   }
 881
 882   addr.sun_family = AF_UNIX;
 883   strncpy (addr.sun_path, sockpath, UNIX_PATH_MAX);
 884   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 885
 886   g->state = LAUNCHING;
 887
 888   if (connect (g->sock, &addr, sizeof addr) == -1) {
 889     perrorf (g, "bind");
 890     goto cleanup;
 891   }
 892
 893   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 894     perrorf (g, "fcntl");
 895     goto cleanup;
 896   }
 897
 898   uint32_t size;
 899   void *buf = NULL;
 900   r = guestfs___recv_from_daemon (g, &size, &buf);
 901   free (buf);
 902
 903   if (r == -1) return -1;
 904
 905   if (size != GUESTFS_LAUNCH_FLAG) {
 906     error (g, _("guestfs_launch failed, unexpected initial message from guestfsd"));
 907     goto cleanup;
 908   }
 909
 910   if (g->verbose)
 911     guestfs___print_timestamped_message (g, "connected");
 912
 913   if (g->state != READY) {
 914     error (g, _("contacted guestfsd, but state != READY"));
 915     goto cleanup;
 916   }
 917
 918   return 0;
 919
 920  cleanup:
 921   close (g->sock);
 922   return -1;
 923 }
 924
 925 /* launch (of the ordinary appliance) generates approximate progress
 926  * messages.  Currently these are defined as follows:
 927  *
 928  *    0 / 12: launch clock starts
 929  *    3 / 12: appliance created
 930  *    6 / 12: detected that guest kernel started
 931  *    9 / 12: detected that /init script is running
 932  *   12 / 12: launch completed successfully
 933  *
 934  * Notes:
 935  * (1) This is not a documented ABI and the behaviour may be changed
 936  * or removed in future.
 937  * (2) Messages are only sent if more than 5 seconds has elapsed
 938  * since the launch clock started.
 939  * (3) There is a gross hack in proto.c to make this work.
 940  */
 941 void
 942 guestfs___launch_send_progress (guestfs_h *g, int perdozen)
 943 {
 944   struct timeval tv;
 945
 946   gettimeofday (&tv, NULL);
 947   if (timeval_diff (&g->launch_t, &tv) >= 5000) {
 948     guestfs_progress progress_message =
 949       { .proc = 0, .serial = 0, .position = perdozen, .total = 12 };
 950
 951     guestfs___progress_message_callback (g, &progress_message);
 952   }
 953 }
 954
 955 /* Return the location of the tmpdir (eg. "/tmp") and allow users
 956  * to override it at runtime using $TMPDIR.
 957  * http://www.pathname.com/fhs/pub/fhs-2.3.html#TMPTEMPORARYFILES
 958  */
 959 const char *
 960 guestfs_tmpdir (void)
 961 {
 962   const char *tmpdir;
 963
 964 #ifdef P_tmpdir
 965   tmpdir = P_tmpdir;
 966 #else
 967   tmpdir = "/tmp";
 968 #endif
 969
 970   const char *t = getenv ("TMPDIR");
 971   if (t) tmpdir = t;
 972
 973   return tmpdir;
 974 }
 975
 976 /* Return the location of the persistent tmpdir (eg. "/var/tmp") and
 977  * allow users to override it at runtime using $TMPDIR.
 978  * http://www.pathname.com/fhs/pub/fhs-2.3.html#VARTMPTEMPORARYFILESPRESERVEDBETWEE
 979  */
 980 const char *
 981 guestfs___persistent_tmpdir (void)
 982 {
 983   const char *tmpdir;
 984
 985   tmpdir = "/var/tmp";
 986
 987   const char *t = getenv ("TMPDIR");
 988   if (t) tmpdir = t;
 989
 990   return tmpdir;
 991 }
 992
 993 /* Compute Y - X and return the result in milliseconds.
 994  * Approximately the same as this code:
 995  * http://www.mpp.mpg.de/~huber/util/timevaldiff.c
 996  */
 997 static int64_t
 998 timeval_diff (const struct timeval *x, const struct timeval *y)
 999 {
1000   int64_t msec;
1001
1002   msec = (y->tv_sec - x->tv_sec) * 1000;
1003   msec += (y->tv_usec - x->tv_usec) / 1000;
1004   return msec;
1005 }
1006
1007 /* Note that since this calls 'debug' it should only be called
1008  * from the parent process.
1009  */
1010 void
1011 guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...)
1012 {
1013   va_list args;
1014   char *msg;
1015   int err;
1016   struct timeval tv;
1017
1018   va_start (args, fs);
1019   err = vasprintf (&msg, fs, args);
1020   va_end (args);
1021
1022   if (err < 0) return;
1023
1024   gettimeofday (&tv, NULL);
1025
1026   debug (g, "[%05" PRIi64 "ms] %s", timeval_diff (&g->launch_t, &tv), msg);
1027
1028   free (msg);
1029 }
1030
1031 /* This is called from the forked subprocess just before qemu runs, so
1032  * it can just print the message straight to stderr, where it will be
1033  * picked up and funnelled through the usual appliance event API.
1034  */
1035 static void
1036 print_qemu_command_line (guestfs_h *g, char **argv)
1037 {
1038   int i = 0;
1039   int needs_quote;
1040
1041   struct timeval tv;
1042   gettimeofday (&tv, NULL);
1043   fprintf (stderr, "[%05" PRIi64 "ms] ", timeval_diff (&g->launch_t, &tv));
1044
1045   while (argv[i]) {
1046     if (argv[i][0] == '-') /* -option starts a new line */
1047       fprintf (stderr, " \\\n   ");
1048
1049     if (i > 0) fputc (' ', stderr);
1050
1051     /* Does it need shell quoting?  This only deals with simple cases. */
1052     needs_quote = strcspn (argv[i], " ") != strlen (argv[i]);
1053
1054     if (needs_quote) fputc ('\'', stderr);
1055     fprintf (stderr, "%s", argv[i]);
1056     if (needs_quote) fputc ('\'', stderr);
1057     i++;
1058   }
1059 }
1060
1061 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1062
1063 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1064  * 'qemu -version' so we know what options this qemu supports and
1065  * the version.
1066  */
1067 static int
1068 test_qemu (guestfs_h *g)
1069 {
1070   char cmd[1024];
1071   FILE *fp;
1072
1073   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -help", g->qemu);
1074
1075   fp = popen (cmd, "r");
1076   /* qemu -help should always work (qemu -version OTOH wasn't
1077    * supported by qemu 0.9).  If this command doesn't work then it
1078    * probably indicates that the qemu binary is missing.
1079    */
1080   if (!fp) {
1081     /* XXX This error is never printed, even if the qemu binary
1082      * doesn't exist.  Why?
1083      */
1084   error:
1085     perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1086     return -1;
1087   }
1088
1089   if (read_all (g, fp, &g->qemu_help) == -1)
1090     goto error;
1091
1092   if (pclose (fp) == -1)
1093     goto error;
1094
1095   snprintf (cmd, sizeof cmd, "LC_ALL=C '%s' -nographic -version 2>/dev/null",
1096             g->qemu);
1097
1098   fp = popen (cmd, "r");
1099   if (fp) {
1100     /* Intentionally ignore errors. */
1101     read_all (g, fp, &g->qemu_version);
1102     pclose (fp);
1103   }
1104
1105   return 0;
1106 }
1107
1108 static int
1109 read_all (guestfs_h *g, FILE *fp, char **ret)
1110 {
1111   int r, n = 0;
1112   char *p;
1113
1114  again:
1115   if (feof (fp)) {
1116     *ret = safe_realloc (g, *ret, n + 1);
1117     (*ret)[n] = '\0';
1118     return n;
1119   }
1120
1121   *ret = safe_realloc (g, *ret, n + BUFSIZ);
1122   p = &(*ret)[n];
1123   r = fread (p, 1, BUFSIZ, fp);
1124   if (ferror (fp)) {
1125     perrorf (g, "read");
1126     return -1;
1127   }
1128   n += r;
1129   goto again;
1130 }
1131
1132 /* Test if option is supported by qemu command line (just by grepping
1133  * the help text).
1134  *
1135  * The first time this is used, it has to run the external qemu
1136  * binary.  If that fails, it returns -1.
1137  *
1138  * To just do the first-time run of the qemu binary, call this with
1139  * option == NULL, in which case it will return -1 if there was an
1140  * error doing that.
1141  */
1142 static int
1143 qemu_supports (guestfs_h *g, const char *option)
1144 {
1145   if (!g->qemu_help) {
1146     if (test_qemu (g) == -1)
1147       return -1;
1148   }
1149
1150   if (option == NULL)
1151     return 1;
1152
1153   return strstr (g->qemu_help, option) != NULL;
1154 }
1155
1156 #if 0
1157 /* As above but using a regex instead of a fixed string. */
1158 static int
1159 qemu_supports_re (guestfs_h *g, const pcre *option_regex)
1160 {
1161   if (!g->qemu_help) {
1162     if (test_qemu (g) == -1)
1163       return -1;
1164   }
1165
1166   return match (g, g->qemu_help, option_regex);
1167 }
1168 #endif
1169
1170 /* Check if a file can be opened. */
1171 static int
1172 is_openable (guestfs_h *g, const char *path, int flags)
1173 {
1174   int fd = open (path, flags);
1175   if (fd == -1) {
1176     debug (g, "is_openable: %s: %m", path);
1177     return 0;
1178   }
1179   close (fd);
1180   return 1;
1181 }
1182
1183 /* You had to call this function after launch in versions <= 1.0.70,
1184  * but it is now a no-op.
1185  */
1186 int
1187 guestfs__wait_ready (guestfs_h *g)
1188 {
1189   if (g->state != READY)  {
1190     error (g, _("qemu has not been launched yet"));
1191     return -1;
1192   }
1193
1194   return 0;
1195 }
1196
1197 int
1198 guestfs__kill_subprocess (guestfs_h *g)
1199 {
1200   if (g->state == CONFIG) {
1201     error (g, _("no subprocess to kill"));
1202     return -1;
1203   }
1204
1205   debug (g, "sending SIGTERM to process %d", g->pid);
1206
1207   if (g->pid > 0) kill (g->pid, SIGTERM);
1208   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1209
1210   return 0;
1211 }
1212
1213 /* Access current state. */
1214 int
1215 guestfs__is_config (guestfs_h *g)
1216 {
1217   return g->state == CONFIG;
1218 }
1219
1220 int
1221 guestfs__is_launching (guestfs_h *g)
1222 {
1223   return g->state == LAUNCHING;
1224 }
1225
1226 int
1227 guestfs__is_ready (guestfs_h *g)
1228 {
1229   return g->state == READY;
1230 }
1231
1232 int
1233 guestfs__is_busy (guestfs_h *g)
1234 {
1235   return g->state == BUSY;
1236 }
1237
1238 int
1239 guestfs__get_state (guestfs_h *g)
1240 {
1241   return g->state;
1242 }