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