src/guestfs.c

   1 /* libguestfs
   2  * Copyright (C) 2009 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 #define _GNU_SOURCE /* for vasprintf, GNU strerror_r, strchrnul */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <stdarg.h>
  27 #include <unistd.h>
  28 #include <ctype.h>
  29 #include <string.h>
  30 #include <fcntl.h>
  31 #include <time.h>
  32 #include <sys/select.h>
  33 #include <rpc/types.h>
  34 #include <rpc/xdr.h>
  35
  36 #ifdef HAVE_ERRNO_H
  37 #include <errno.h>
  38 #endif
  39
  40 #ifdef HAVE_SYS_TYPES_H
  41 #include <sys/types.h>
  42 #endif
  43
  44 #ifdef HAVE_SYS_WAIT_H
  45 #include <sys/wait.h>
  46 #endif
  47
  48 #ifdef HAVE_SYS_SOCKET_H
  49 #include <sys/socket.h>
  50 #endif
  51
  52 #ifdef HAVE_SYS_UN_H
  53 #include <sys/un.h>
  54 #endif
  55
  56 #include "guestfs.h"
  57 #include "guestfs_protocol.h"
  58
  59 static void error (guestfs_h *g, const char *fs, ...);
  60 static void perrorf (guestfs_h *g, const char *fs, ...);
  61 static void *safe_malloc (guestfs_h *g, int nbytes);
  62 static void *safe_realloc (guestfs_h *g, void *ptr, int nbytes);
  63 static char *safe_strdup (guestfs_h *g, const char *str);
  64
  65 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
  66 static void stdout_event (void *data, int watch, int fd, int events);
  67 static void sock_read_event (void *data, int watch, int fd, int events);
  68 static void sock_write_event (void *data, int watch, int fd, int events);
  69
  70 static void close_handles (void);
  71
  72 static int select_add_handle (guestfs_h *g, int fd, int events, guestfs_handle_event_cb cb, void *data);
  73 static int select_remove_handle (guestfs_h *g, int watch);
  74 static int select_add_timeout (guestfs_h *g, int interval, guestfs_handle_timeout_cb cb, void *data);
  75 static int select_remove_timeout (guestfs_h *g, int timer);
  76 static void select_main_loop_run (guestfs_h *g);
  77 static void select_main_loop_quit (guestfs_h *g);
  78
  79 #define UNIX_PATH_MAX 108
  80
  81 /* Also in guestfsd.c */
  82 #define VMCHANNEL_PORT 6666
  83 #define VMCHANNEL_ADDR "10.0.2.4"
  84
  85 /* Current main loop. */
  86 static guestfs_main_loop main_loop = {
  87   .add_handle = select_add_handle,
  88   .remove_handle = select_remove_handle,
  89   .add_timeout = select_add_timeout,
  90   .remove_timeout = select_remove_timeout,
  91   .main_loop_run = select_main_loop_run,
  92   .main_loop_quit = select_main_loop_quit,
  93 };
  94
  95 /* GuestFS handle and connection. */
  96 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
  97
  98 struct guestfs_h
  99 {
 100   struct guestfs_h *next;       /* Linked list of open handles. */
 101
 102   /* State: see the state machine diagram in the man page guestfs(3). */
 103   enum state state;
 104
 105   int fd[2];                    /* Stdin/stdout of qemu. */
 106   int sock;                     /* Daemon communications socket. */
 107   int pid;                      /* Qemu PID. */
 108   time_t start_t;               /* The time when we started qemu. */
 109
 110   int stdout_watch;             /* Watches qemu stdout for log messages. */
 111   int sock_watch;               /* Watches daemon comm socket. */
 112
 113   char *tmpdir;                 /* Temporary directory containing socket. */
 114
 115   char **cmdline;               /* Qemu command line. */
 116   int cmdline_size;
 117
 118   int verbose;
 119   int autosync;
 120
 121   const char *path;
 122
 123   /* Callbacks. */
 124   guestfs_abort_cb           abort_cb;
 125   guestfs_error_handler_cb   error_cb;
 126   void *                     error_cb_data;
 127   guestfs_reply_cb           reply_cb;
 128   void *                     reply_cb_data;
 129   guestfs_log_message_cb     log_message_cb;
 130   void *                     log_message_cb_data;
 131   guestfs_subprocess_quit_cb subprocess_quit_cb;
 132   void *                     subprocess_quit_cb_data;
 133   guestfs_launch_done_cb     launch_done_cb;
 134   void *                     launch_done_cb_data;
 135
 136   /* These callbacks are called before reply_cb and launch_done_cb,
 137    * and are used to implement the high-level API without needing to
 138    * interfere with callbacks that the user might have set.
 139    */
 140   guestfs_reply_cb           reply_cb_internal;
 141   void *                     reply_cb_internal_data;
 142   guestfs_launch_done_cb     launch_done_cb_internal;
 143   void *                     launch_done_cb_internal_data;
 144
 145   /* Messages sent and received from the daemon. */
 146   char *msg_in;
 147   int msg_in_size, msg_in_allocated;
 148   char *msg_out;
 149   int msg_out_size, msg_out_pos;
 150
 151   int msg_next_serial;
 152 };
 153
 154 static guestfs_h *handles = NULL;
 155 static int atexit_handler_set = 0;
 156
 157 guestfs_h *
 158 guestfs_create (void)
 159 {
 160   guestfs_h *g;
 161   const char *str;
 162
 163   g = malloc (sizeof (*g));
 164   if (!g) return NULL;
 165
 166   memset (g, 0, sizeof (*g));
 167
 168   g->state = CONFIG;
 169
 170   g->fd[0] = -1;
 171   g->fd[1] = -1;
 172   g->sock = -1;
 173   g->stdout_watch = -1;
 174   g->sock_watch = -1;
 175
 176   g->abort_cb = abort;
 177   g->error_cb = default_error_cb;
 178   g->error_cb_data = NULL;
 179
 180   str = getenv ("LIBGUESTFS_DEBUG");
 181   g->verbose = str != NULL && strcmp (str, "1") == 0;
 182
 183   str = getenv ("LIBGUESTFS_PATH");
 184   g->path = str != NULL ? str : GUESTFS_DEFAULT_PATH;
 185   /* XXX We should probably make QEMU configurable as well. */
 186
 187   /* Start with large serial numbers so they are easy to spot
 188    * inside the protocol.
 189    */
 190   g->msg_next_serial = 0x00123400;
 191
 192   /* Link the handles onto a global list.  This is the one area
 193    * where the library needs to be made thread-safe. (XXX)
 194    */
 195   /* acquire mutex (XXX) */
 196   g->next = handles;
 197   handles = g;
 198   if (!atexit_handler_set) {
 199     atexit (close_handles);
 200     atexit_handler_set = 1;
 201   }
 202   /* release mutex (XXX) */
 203
 204   if (g->verbose)
 205     fprintf (stderr, "new guestfs handle %p\n", g);
 206
 207   return g;
 208 }
 209
 210 void
 211 guestfs_close (guestfs_h *g)
 212 {
 213   int i;
 214   char filename[256];
 215   guestfs_h *gg;
 216
 217   if (g->state == NO_HANDLE) {
 218     /* Not safe to call 'error' here, so ... */
 219     fprintf (stderr, "guestfs_close: called twice on the same handle\n");
 220     return;
 221   }
 222
 223   if (g->verbose)
 224     fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
 225
 226   /* Try to sync if autosync flag is set. */
 227   if (g->autosync && g->state == READY)
 228     guestfs_sync (g);
 229
 230   /* Remove any handlers that might be called back before we kill the
 231    * subprocess.
 232    */
 233   g->log_message_cb = NULL;
 234
 235   if (g->state != CONFIG)
 236     guestfs_kill_subprocess (g);
 237
 238   if (g->tmpdir) {
 239     snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
 240     unlink (filename);
 241
 242     rmdir (g->tmpdir);
 243
 244     free (g->tmpdir);
 245   }
 246
 247   if (g->cmdline) {
 248     for (i = 0; i < g->cmdline_size; ++i)
 249       free (g->cmdline[i]);
 250     free (g->cmdline);
 251   }
 252
 253   /* Mark the handle as dead before freeing it. */
 254   g->state = NO_HANDLE;
 255
 256   /* acquire mutex (XXX) */
 257   if (handles == g)
 258     handles = g->next;
 259   else {
 260     for (gg = handles; gg->next != g; gg = gg->next)
 261       ;
 262     gg->next = g->next;
 263   }
 264   /* release mutex (XXX) */
 265
 266   free (g);
 267 }
 268
 269 /* Close all open handles (called from atexit(3)). */
 270 static void
 271 close_handles (void)
 272 {
 273   while (handles) guestfs_close (handles);
 274 }
 275
 276 static void
 277 default_error_cb (guestfs_h *g, void *data, const char *msg)
 278 {
 279   fprintf (stderr, "libguestfs: error: %s\n", msg);
 280 }
 281
 282 static void
 283 error (guestfs_h *g, const char *fs, ...)
 284 {
 285   va_list args;
 286   char *msg;
 287
 288   if (!g->error_cb) return;
 289
 290   va_start (args, fs);
 291   vasprintf (&msg, fs, args);
 292   va_end (args);
 293
 294   g->error_cb (g, g->error_cb_data, msg);
 295
 296   free (msg);
 297 }
 298
 299 static void
 300 perrorf (guestfs_h *g, const char *fs, ...)
 301 {
 302   va_list args;
 303   char *msg;
 304   int err = errno;
 305
 306   if (!g->error_cb) return;
 307
 308   va_start (args, fs);
 309   vasprintf (&msg, fs, args);
 310   va_end (args);
 311
 312 #ifndef _GNU_SOURCE
 313   char buf[256];
 314   strerror_r (err, buf, sizeof buf);
 315 #else
 316   char _buf[256];
 317   char *buf;
 318   buf = strerror_r (err, _buf, sizeof _buf);
 319 #endif
 320
 321   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
 322   strcat (msg, ": ");
 323   strcat (msg, buf);
 324
 325   g->error_cb (g, g->error_cb_data, msg);
 326
 327   free (msg);
 328 }
 329
 330 static void *
 331 safe_malloc (guestfs_h *g, int nbytes)
 332 {
 333   void *ptr = malloc (nbytes);
 334   if (!ptr) g->abort_cb ();
 335   return ptr;
 336 }
 337
 338 static void *
 339 safe_realloc (guestfs_h *g, void *ptr, int nbytes)
 340 {
 341   void *p = realloc (ptr, nbytes);
 342   if (!p) g->abort_cb ();
 343   return p;
 344 }
 345
 346 static char *
 347 safe_strdup (guestfs_h *g, const char *str)
 348 {
 349   char *s = strdup (str);
 350   if (!s) g->abort_cb ();
 351   return s;
 352 }
 353
 354 void
 355 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
 356 {
 357   g->abort_cb = cb;
 358 }
 359
 360 guestfs_abort_cb
 361 guestfs_get_out_of_memory_handler (guestfs_h *g)
 362 {
 363   return g->abort_cb;
 364 }
 365
 366 void
 367 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
 368 {
 369   g->error_cb = cb;
 370   g->error_cb_data = data;
 371 }
 372
 373 guestfs_error_handler_cb
 374 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
 375 {
 376   if (data_rtn) *data_rtn = g->error_cb_data;
 377   return g->error_cb;
 378 }
 379
 380 void
 381 guestfs_set_verbose (guestfs_h *g, int v)
 382 {
 383   g->verbose = v;
 384 }
 385
 386 int
 387 guestfs_get_verbose (guestfs_h *g)
 388 {
 389   return g->verbose;
 390 }
 391
 392 void
 393 guestfs_set_autosync (guestfs_h *g, int a)
 394 {
 395   g->autosync = a;
 396 }
 397
 398 int
 399 guestfs_get_autosync (guestfs_h *g)
 400 {
 401   return g->autosync;
 402 }
 403
 404 void
 405 guestfs_set_path (guestfs_h *g, const char *path)
 406 {
 407   if (path == NULL)
 408     g->path = GUESTFS_DEFAULT_PATH;
 409   else
 410     g->path = path;
 411 }
 412
 413 const char *
 414 guestfs_get_path (guestfs_h *g)
 415 {
 416   return g->path;
 417 }
 418
 419 /* Add a string to the current command line. */
 420 static void
 421 incr_cmdline_size (guestfs_h *g)
 422 {
 423   if (g->cmdline == NULL) {
 424     /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
 425     g->cmdline_size = 1;
 426     g->cmdline = safe_malloc (g, sizeof (char *));
 427     g->cmdline[0] = NULL;
 428   }
 429
 430   g->cmdline_size++;
 431   g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
 432 }
 433
 434 static int
 435 add_cmdline (guestfs_h *g, const char *str)
 436 {
 437   if (g->state != CONFIG) {
 438     error (g, "command line cannot be altered after qemu subprocess launched");
 439     return -1;
 440   }
 441
 442   incr_cmdline_size (g);
 443   g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
 444   return 0;
 445 }
 446
 447 int
 448 guestfs_config (guestfs_h *g,
 449                 const char *qemu_param, const char *qemu_value)
 450 {
 451   if (qemu_param[0] != '-') {
 452     error (g, "guestfs_config: parameter must begin with '-' character");
 453     return -1;
 454   }
 455
 456   /* A bit fascist, but the user will probably break the extra
 457    * parameters that we add if they try to set any of these.
 458    */
 459   if (strcmp (qemu_param, "-kernel") == 0 ||
 460       strcmp (qemu_param, "-initrd") == 0 ||
 461       strcmp (qemu_param, "-nographic") == 0 ||
 462       strcmp (qemu_param, "-serial") == 0 ||
 463       strcmp (qemu_param, "-vnc") == 0 ||
 464       strcmp (qemu_param, "-full-screen") == 0 ||
 465       strcmp (qemu_param, "-std-vga") == 0 ||
 466       strcmp (qemu_param, "-vnc") == 0) {
 467     error (g, "guestfs_config: parameter '%s' isn't allowed", qemu_param);
 468     return -1;
 469   }
 470
 471   if (add_cmdline (g, qemu_param) != 0) return -1;
 472
 473   if (qemu_value != NULL) {
 474     if (add_cmdline (g, qemu_value) != 0) return -1;
 475   }
 476
 477   return 0;
 478 }
 479
 480 int
 481 guestfs_add_drive (guestfs_h *g, const char *filename)
 482 {
 483   int len = strlen (filename) + 64;
 484   char buf[len];
 485
 486   if (strchr (filename, ',') != NULL) {
 487     error (g, "filename cannot contain ',' (comma) character");
 488     return -1;
 489   }
 490
 491   snprintf (buf, len, "file=%s", filename);
 492
 493   return guestfs_config (g, "-drive", buf);
 494 }
 495
 496 int
 497 guestfs_add_cdrom (guestfs_h *g, const char *filename)
 498 {
 499   if (strchr (filename, ',') != NULL) {
 500     error (g, "filename cannot contain ',' (comma) character");
 501     return -1;
 502   }
 503
 504   return guestfs_config (g, "-cdrom", filename);
 505 }
 506
 507 int
 508 guestfs_launch (guestfs_h *g)
 509 {
 510   static const char *dir_template = "/tmp/libguestfsXXXXXX";
 511   int r, i, len, pmore;
 512   int wfd[2], rfd[2];
 513   int tries;
 514   const char *kernel_name = "vmlinuz." REPO "." host_cpu;
 515   const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
 516   char *path, *pelem, *pend;
 517   char *kernel = NULL, *initrd = NULL;
 518   char unixsock[256];
 519   struct sockaddr_un addr;
 520
 521   /* Configured? */
 522   if (!g->cmdline) {
 523     error (g, "you must call guestfs_add_drive before guestfs_launch");
 524     return -1;
 525   }
 526
 527   if (g->state != CONFIG) {
 528     error (g, "qemu has already been launched");
 529     return -1;
 530   }
 531
 532   /* Search g->path for the kernel and initrd. */
 533   pelem = path = safe_strdup (g, g->path);
 534   do {
 535     pend = strchrnul (pelem, ':');
 536     pmore = *pend == ':';
 537     *pend = '\0';
 538     len = pend - pelem;
 539
 540     /* Empty element or "." means cwd. */
 541     if (len == 0 || (len == 1 && *pelem == '.')) {
 542       if (g->verbose)
 543         fprintf (stderr,
 544                  "looking for kernel and initrd in current directory\n");
 545       if (access (kernel_name, F_OK) == 0 && access (initrd_name, F_OK) == 0) {
 546         kernel = safe_strdup (g, kernel_name);
 547         initrd = safe_strdup (g, initrd_name);
 548         break;
 549       }
 550     }
 551     /* Look at <path>/kernel etc. */
 552     else {
 553       kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
 554       initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
 555       sprintf (kernel, "%s/%s", pelem, kernel_name);
 556       sprintf (initrd, "%s/%s", pelem, initrd_name);
 557
 558       if (g->verbose)
 559         fprintf (stderr, "looking for %s and %s\n", kernel, initrd);
 560
 561       if (access (kernel, F_OK) == 0 && access (initrd, F_OK) == 0)
 562         break;
 563       free (kernel);
 564       free (initrd);
 565       kernel = initrd = NULL;
 566     }
 567
 568     pelem = pend + 1;
 569   } while (pmore);
 570
 571   free (path);
 572
 573   if (kernel == NULL || initrd == NULL) {
 574     error (g, "cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)",
 575            kernel_name, initrd_name, g->path);
 576     goto cleanup0;
 577   }
 578
 579   /* Make the temporary directory containing the socket. */
 580   if (!g->tmpdir) {
 581     g->tmpdir = safe_strdup (g, dir_template);
 582     if (mkdtemp (g->tmpdir) == NULL) {
 583       perrorf (g, "%s: cannot create temporary directory", dir_template);
 584       goto cleanup0;
 585     }
 586   }
 587
 588   snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
 589   unlink (unixsock);
 590
 591   if (pipe (wfd) == -1 || pipe (rfd) == -1) {
 592     perrorf (g, "pipe");
 593     goto cleanup0;
 594   }
 595
 596   r = fork ();
 597   if (r == -1) {
 598     perrorf (g, "fork");
 599     close (wfd[0]);
 600     close (wfd[1]);
 601     close (rfd[0]);
 602     close (rfd[1]);
 603     goto cleanup0;
 604   }
 605
 606   if (r == 0) {                 /* Child (qemu). */
 607     char vmchannel[256];
 608     char append[256];
 609
 610     /* Set up the full command line.  Do this in the subprocess so we
 611      * don't need to worry about cleaning up.
 612      */
 613     g->cmdline[0] = (char *) QEMU;
 614
 615     /* Construct the -net channel parameter for qemu. */
 616     snprintf (vmchannel, sizeof vmchannel,
 617               "channel,%d:unix:%s,server,nowait",
 618               VMCHANNEL_PORT, unixsock);
 619
 620     /* Linux kernel command line. */
 621     snprintf (append, sizeof append,
 622               "console=ttyS0 guestfs=%s:%d", VMCHANNEL_ADDR, VMCHANNEL_PORT);
 623
 624     add_cmdline (g, "-m");
 625     add_cmdline (g, "384");       /* XXX Choose best size. */
 626     add_cmdline (g, "-no-kqemu"); /* Avoids a warning. */
 627     add_cmdline (g, "-kernel");
 628     add_cmdline (g, (char *) kernel);
 629     add_cmdline (g, "-initrd");
 630     add_cmdline (g, (char *) initrd);
 631     add_cmdline (g, "-append");
 632     add_cmdline (g, append);
 633     add_cmdline (g, "-nographic");
 634     add_cmdline (g, "-serial");
 635     add_cmdline (g, "stdio");
 636     add_cmdline (g, "-net");
 637     add_cmdline (g, vmchannel);
 638     add_cmdline (g, "-net");
 639     add_cmdline (g, "user,vlan=0");
 640     add_cmdline (g, "-net");
 641     add_cmdline (g, "nic,vlan=0");
 642     incr_cmdline_size (g);
 643     g->cmdline[g->cmdline_size-1] = NULL;
 644
 645     if (g->verbose) {
 646       fprintf (stderr, "%s", QEMU);
 647       for (i = 0; g->cmdline[i]; ++i)
 648         fprintf (stderr, " %s", g->cmdline[i]);
 649       fprintf (stderr, "\n");
 650     }
 651
 652     /* Set up stdin, stdout. */
 653     close (0);
 654     close (1);
 655     close (wfd[1]);
 656     close (rfd[0]);
 657     dup (wfd[0]);
 658     dup (rfd[1]);
 659     close (wfd[0]);
 660     close (rfd[1]);
 661
 662 #if 0
 663     /* Set up a new process group, so we can signal this process
 664      * and all subprocesses (eg. if qemu is really a shell script).
 665      */
 666     setpgid (0, 0);
 667 #endif
 668
 669     execv (QEMU, g->cmdline);   /* Run qemu. */
 670     perror (QEMU);
 671     _exit (1);
 672   }
 673
 674   /* Parent (library). */
 675   g->pid = r;
 676
 677   /* Start the clock ... */
 678   time (&g->start_t);
 679
 680   /* Close the other ends of the pipe. */
 681   close (wfd[0]);
 682   close (rfd[1]);
 683
 684   if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
 685       fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
 686     perrorf (g, "fcntl");
 687     goto cleanup1;
 688   }
 689
 690   g->fd[0] = wfd[1];            /* stdin of child */
 691   g->fd[1] = rfd[0];            /* stdout of child */
 692
 693   /* Open the Unix socket.  The vmchannel implementation that got
 694    * merged with qemu sucks in a number of ways.  Both ends do
 695    * connect(2), which means that no one knows what, if anything, is
 696    * connected to the other end, or if it becomes disconnected.  Even
 697    * worse, we have to wait some indeterminate time for qemu to create
 698    * the socket and connect to it (which happens very early in qemu's
 699    * start-up), so any code that uses vmchannel is inherently racy.
 700    * Hence this silly loop.
 701    */
 702   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 703   if (g->sock == -1) {
 704     perrorf (g, "socket");
 705     goto cleanup1;
 706   }
 707
 708   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 709     perrorf (g, "fcntl");
 710     goto cleanup2;
 711   }
 712
 713   addr.sun_family = AF_UNIX;
 714   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
 715   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 716
 717   tries = 100;
 718   while (tries > 0) {
 719     /* Always sleep at least once to give qemu a small chance to start up. */
 720     usleep (10000);
 721
 722     r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
 723     if ((r == -1 && errno == EINPROGRESS) || r == 0)
 724       goto connected;
 725
 726     if (errno != ENOENT)
 727       perrorf (g, "connect");
 728     tries--;
 729   }
 730
 731   error (g, "failed to connect to vmchannel socket");
 732   goto cleanup2;
 733
 734  connected:
 735   /* Watch the file descriptors. */
 736   free (g->msg_in);
 737   g->msg_in = NULL;
 738   g->msg_in_size = g->msg_in_allocated = 0;
 739
 740   free (g->msg_out);
 741   g->msg_out = NULL;
 742   g->msg_out_size = 0;
 743   g->msg_out_pos = 0;
 744
 745   g->stdout_watch =
 746     main_loop.add_handle (g, g->fd[1],
 747                           GUESTFS_HANDLE_READABLE,
 748                           stdout_event, g);
 749   if (g->stdout_watch == -1) {
 750     error (g, "could not watch qemu stdout");
 751     goto cleanup3;
 752   }
 753
 754   g->sock_watch =
 755     main_loop.add_handle (g, g->sock,
 756                           GUESTFS_HANDLE_READABLE,
 757                           sock_read_event, g);
 758   if (g->sock_watch == -1) {
 759     error (g, "could not watch daemon communications socket");
 760     goto cleanup3;
 761   }
 762
 763   g->state = LAUNCHING;
 764   return 0;
 765
 766  cleanup3:
 767   if (g->stdout_watch >= 0)
 768     main_loop.remove_handle (g, g->stdout_watch);
 769   if (g->sock_watch >= 0)
 770     main_loop.remove_handle (g, g->sock_watch);
 771
 772  cleanup2:
 773   close (g->sock);
 774
 775  cleanup1:
 776   close (wfd[1]);
 777   close (rfd[0]);
 778   kill (g->pid, 9);
 779   waitpid (g->pid, NULL, 0);
 780   g->fd[0] = -1;
 781   g->fd[1] = -1;
 782   g->sock = -1;
 783   g->pid = 0;
 784   g->start_t = 0;
 785   g->stdout_watch = -1;
 786   g->sock_watch = -1;
 787
 788  cleanup0:
 789   free (kernel);
 790   free (initrd);
 791   return -1;
 792 }
 793
 794 static void
 795 finish_wait_ready (guestfs_h *g, void *vp)
 796 {
 797   *((int *)vp) = 1;
 798   main_loop.main_loop_quit (g);
 799 }
 800
 801 int
 802 guestfs_wait_ready (guestfs_h *g)
 803 {
 804   int r = 0;
 805
 806   if (g->state == READY) return 0;
 807
 808   if (g->state == BUSY) {
 809     error (g, "qemu has finished launching already");
 810     return -1;
 811   }
 812
 813   if (g->state != LAUNCHING) {
 814     error (g, "qemu has not been launched yet");
 815     return -1;
 816   }
 817
 818   g->launch_done_cb_internal = finish_wait_ready;
 819   g->launch_done_cb_internal_data = &r;
 820   main_loop.main_loop_run (g);
 821   g->launch_done_cb_internal = NULL;
 822   g->launch_done_cb_internal_data = NULL;
 823
 824   if (r != 1) {
 825     error (g, "guestfs_wait_ready failed, see earlier error messages");
 826     return -1;
 827   }
 828
 829   /* This is possible in some really strange situations, such as
 830    * guestfsd starts up OK but then qemu immediately exits.  Check for
 831    * it because the caller is probably expecting to be able to send
 832    * commands after this function returns.
 833    */
 834   if (g->state != READY) {
 835     error (g, "qemu launched and contacted daemon, but state != READY");
 836     return -1;
 837   }
 838
 839   return 0;
 840 }
 841
 842 int
 843 guestfs_kill_subprocess (guestfs_h *g)
 844 {
 845   if (g->state == CONFIG) {
 846     error (g, "no subprocess to kill");
 847     return -1;
 848   }
 849
 850   if (g->verbose)
 851     fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
 852
 853   kill (g->pid, SIGTERM);
 854
 855   return 0;
 856 }
 857
 858 /* This function is called whenever qemu prints something on stdout.
 859  * Qemu's stdout is also connected to the guest's serial console, so
 860  * we see kernel messages here too.
 861  */
 862 static void
 863 stdout_event (void *data, int watch, int fd, int events)
 864 {
 865   guestfs_h *g = (guestfs_h *) data;
 866   char buf[4096];
 867   int n;
 868
 869 #if 0
 870   if (g->verbose)
 871     fprintf (stderr,
 872              "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
 873              g, g->state, fd, events);
 874 #endif
 875
 876   if (g->fd[1] != fd) {
 877     error (g, "stdout_event: internal error: %d != %d", g->fd[1], fd);
 878     return;
 879   }
 880
 881   n = read (fd, buf, sizeof buf);
 882   if (n == 0) {
 883     /* Hopefully this indicates the qemu child process has died. */
 884     if (g->verbose)
 885       fprintf (stderr, "stdout_event: %p: child process died\n", g);
 886     /*kill (g->pid, SIGTERM);*/
 887     waitpid (g->pid, NULL, 0);
 888     if (g->stdout_watch >= 0)
 889       main_loop.remove_handle (g, g->stdout_watch);
 890     if (g->sock_watch >= 0)
 891       main_loop.remove_handle (g, g->sock_watch);
 892     close (g->fd[0]);
 893     close (g->fd[1]);
 894     close (g->sock);
 895     g->fd[0] = -1;
 896     g->fd[1] = -1;
 897     g->sock = -1;
 898     g->pid = 0;
 899     g->start_t = 0;
 900     g->stdout_watch = -1;
 901     g->sock_watch = -1;
 902     g->state = CONFIG;
 903     if (g->subprocess_quit_cb)
 904       g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
 905     return;
 906   }
 907
 908   if (n == -1) {
 909     if (errno != EAGAIN)
 910       perrorf (g, "read");
 911     return;
 912   }
 913
 914   /* In verbose mode, copy all log messages to stderr. */
 915   if (g->verbose)
 916     write (2, buf, n);
 917
 918   /* It's an actual log message, send it upwards if anyone is listening. */
 919   if (g->log_message_cb)
 920     g->log_message_cb (g, g->log_message_cb_data, buf, n);
 921 }
 922
 923 /* The function is called whenever we can read something on the
 924  * guestfsd (daemon inside the guest) communication socket.
 925  */
 926 static void
 927 sock_read_event (void *data, int watch, int fd, int events)
 928 {
 929   guestfs_h *g = (guestfs_h *) data;
 930   XDR xdr;
 931   unsigned len;
 932   int n;
 933
 934   if (g->verbose)
 935     fprintf (stderr,
 936              "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
 937              g, g->state, fd, events);
 938
 939   if (g->sock != fd) {
 940     error (g, "sock_read_event: internal error: %d != %d", g->sock, fd);
 941     return;
 942   }
 943
 944   if (g->msg_in_size <= g->msg_in_allocated) {
 945     g->msg_in_allocated += 4096;
 946     g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
 947   }
 948   n = read (g->sock, g->msg_in + g->msg_in_size,
 949             g->msg_in_allocated - g->msg_in_size);
 950   if (n == 0)
 951     /* Disconnected?  Ignore it because stdout_watch will get called
 952      * and will do the cleanup.
 953      */
 954     return;
 955
 956   if (n == -1) {
 957     if (errno != EAGAIN)
 958       perrorf (g, "read");
 959     return;
 960   }
 961
 962   g->msg_in_size += n;
 963
 964   /* Have we got enough of a message to be able to process it yet? */
 965   if (g->msg_in_size < 4) return;
 966
 967   xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
 968   if (!xdr_uint32_t (&xdr, &len)) {
 969     error (g, "can't decode length word");
 970     goto cleanup;
 971   }
 972
 973   /* Length is normally the length of the message, but when guestfsd
 974    * starts up it sends a "magic" value (longer than any possible
 975    * message).  Check for this.
 976    */
 977   if (len == 0xf5f55ff5) {
 978     if (g->state != LAUNCHING)
 979       error (g, "received magic signature from guestfsd, but in state %d",
 980              g->state);
 981     else if (g->msg_in_size != 4)
 982       error (g, "received magic signature from guestfsd, but msg size is %d",
 983              g->msg_in_size);
 984     else {
 985       g->state = READY;
 986       if (g->launch_done_cb_internal)
 987         g->launch_done_cb_internal (g, g->launch_done_cb_internal_data);
 988       if (g->launch_done_cb)
 989         g->launch_done_cb (g, g->launch_done_cb_data);
 990     }
 991
 992     goto cleanup;
 993   }
 994
 995   /* If this happens, it's pretty bad and we've probably lost synchronization.*/
 996   if (len > GUESTFS_MESSAGE_MAX) {
 997     error (g, "message length (%u) > maximum possible size (%d)",
 998            len, GUESTFS_MESSAGE_MAX);
 999     goto cleanup;
1000   }
1001
1002   if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1003
1004   /* This should not happen, and if it does it probably means we've
1005    * lost all hope of synchronization.
1006    */
1007   if (g->msg_in_size-4 > len) {
1008     error (g, "len = %d, but msg_in_size-4 = %d", len, g->msg_in_size-4);
1009     goto cleanup;
1010   }
1011
1012   /* Not in the expected state. */
1013   if (g->state != BUSY)
1014     error (g, "state %d != BUSY", g->state);
1015
1016   /* Push the message up to the higher layer.  Note that unlike
1017    * launch_done_cb / launch_done_cb_internal, we only call at
1018    * most one of the callback functions here.
1019    */
1020   g->state = READY;
1021   if (g->reply_cb_internal)
1022     g->reply_cb_internal (g, g->reply_cb_internal_data, &xdr);
1023   else if (g->reply_cb)
1024     g->reply_cb (g, g->reply_cb, &xdr);
1025
1026  cleanup:
1027   /* Free the message buffer if it's grown excessively large. */
1028   if (g->msg_in_allocated > 65536) {
1029     free (g->msg_in);
1030     g->msg_in = NULL;
1031     g->msg_in_size = g->msg_in_allocated = 0;
1032   } else
1033     g->msg_in_size = 0;
1034
1035   xdr_destroy (&xdr);
1036 }
1037
1038 /* The function is called whenever we can write something on the
1039  * guestfsd (daemon inside the guest) communication socket.
1040  */
1041 static void
1042 sock_write_event (void *data, int watch, int fd, int events)
1043 {
1044   guestfs_h *g = (guestfs_h *) data;
1045   int n;
1046
1047   if (g->verbose)
1048     fprintf (stderr,
1049              "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1050              g, g->state, fd, events);
1051
1052   if (g->sock != fd) {
1053     error (g, "sock_write_event: internal error: %d != %d", g->sock, fd);
1054     return;
1055   }
1056
1057   if (g->state != BUSY) {
1058     error (g, "sock_write_event: state %d != BUSY", g->state);
1059     return;
1060   }
1061
1062   if (g->verbose)
1063     fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1064              g->msg_out_size - g->msg_out_pos);
1065
1066   n = write (g->sock, g->msg_out + g->msg_out_pos,
1067              g->msg_out_size - g->msg_out_pos);
1068   if (n == -1) {
1069     if (errno != EAGAIN)
1070       perrorf (g, "write");
1071     return;
1072   }
1073
1074   if (g->verbose)
1075     fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1076
1077   g->msg_out_pos += n;
1078
1079   /* More to write? */
1080   if (g->msg_out_pos < g->msg_out_size)
1081     return;
1082
1083   if (g->verbose)
1084     fprintf (stderr, "sock_write_event: done writing, switching back to reading events\n");
1085
1086   free (g->msg_out);
1087   g->msg_out_pos = g->msg_out_size = 0;
1088
1089   if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1090     error (g, "remove_handle failed in sock_write_event");
1091     return;
1092   }
1093   g->sock_watch =
1094     main_loop.add_handle (g, g->sock,
1095                           GUESTFS_HANDLE_READABLE,
1096                           sock_read_event, g);
1097   if (g->sock_watch == -1) {
1098     error (g, "add_handle failed in sock_write_event");
1099     return;
1100   }
1101 }
1102
1103 /* Dispatch a call to the remote daemon.  This function just queues
1104  * the call in msg_out, to be sent when we next enter the main loop.
1105  * Returns -1 for error, or the message serial number.
1106  */
1107 static int
1108 dispatch (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args)
1109 {
1110   char buffer[GUESTFS_MESSAGE_MAX];
1111   struct guestfs_message_header hdr;
1112   XDR xdr;
1113   unsigned len;
1114   int serial = g->msg_next_serial++;
1115
1116   if (g->state != READY) {
1117     error (g, "dispatch: state %d != READY", g->state);
1118     return -1;
1119   }
1120
1121   /* Serialize the header. */
1122   hdr.prog = GUESTFS_PROGRAM;
1123   hdr.vers = GUESTFS_PROTOCOL_VERSION;
1124   hdr.proc = proc_nr;
1125   hdr.direction = GUESTFS_DIRECTION_CALL;
1126   hdr.serial = serial;
1127   hdr.status = GUESTFS_STATUS_OK;
1128
1129   xdrmem_create (&xdr, buffer, sizeof buffer, XDR_ENCODE);
1130   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
1131     error (g, "xdr_guestfs_message_header failed");
1132     return -1;
1133   }
1134
1135   /* Serialize the args.  If any, because some message types
1136    * have no parameters.
1137    */
1138   if (xdrp) {
1139     if (!(*xdrp) (&xdr, args)) {
1140       error (g, "dispatch failed to marshal args");
1141       return -1;
1142     }
1143   }
1144
1145   len = xdr_getpos (&xdr);
1146   xdr_destroy (&xdr);
1147
1148   /* Allocate the outgoing message buffer. */
1149   g->msg_out = safe_malloc (g, len + 4);
1150
1151   g->msg_out_size = len + 4;
1152   g->msg_out_pos = 0;
1153   g->state = BUSY;
1154
1155   xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
1156   if (!xdr_uint32_t (&xdr, &len)) {
1157     error (g, "xdr_uint32_t failed in dispatch");
1158     goto cleanup1;
1159   }
1160
1161   memcpy (g->msg_out + 4, buffer, len);
1162
1163   /* Change the handle to sock_write_event. */
1164   if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1165     error (g, "remove_handle failed in dispatch");
1166     goto cleanup1;
1167   }
1168   g->sock_watch =
1169     main_loop.add_handle (g, g->sock,
1170                           GUESTFS_HANDLE_WRITABLE,
1171                           sock_write_event, g);
1172   if (g->sock_watch == -1) {
1173     error (g, "add_handle failed in dispatch");
1174     goto cleanup1;
1175   }
1176
1177   return serial;
1178
1179  cleanup1:
1180   free (g->msg_out);
1181   g->msg_out = NULL;
1182   g->msg_out_size = 0;
1183   g->state = READY;
1184   return -1;
1185 }
1186
1187 /* Check the return message from a call for validity. */
1188 static int
1189 check_reply_header (guestfs_h *g,
1190                     const struct guestfs_message_header *hdr,
1191                     int proc_nr, int serial)
1192 {
1193   if (hdr->prog != GUESTFS_PROGRAM) {
1194     error (g, "wrong program (%d/%d)", hdr->prog, GUESTFS_PROGRAM);
1195     return -1;
1196   }
1197   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
1198     error (g, "wrong protocol version (%d/%d)",
1199            hdr->vers, GUESTFS_PROTOCOL_VERSION);
1200     return -1;
1201   }
1202   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
1203     error (g, "unexpected message direction (%d/%d)",
1204            hdr->direction, GUESTFS_DIRECTION_REPLY);
1205     return -1;
1206   }
1207   if (hdr->proc != proc_nr) {
1208     error (g, "unexpected procedure number (%d/%d)", hdr->proc, proc_nr);
1209     return -1;
1210   }
1211   if (hdr->serial != serial) {
1212     error (g, "unexpected serial (%d/%d)", hdr->serial, serial);
1213     return -1;
1214   }
1215
1216   return 0;
1217 }
1218
1219 /* The high-level actions are autogenerated by generator.ml.  Include
1220  * them here.
1221  */
1222 #include "guestfs-actions.c"
1223
1224 /* This is the default main loop implementation, using select(2). */
1225
1226 struct handle_cb_data {
1227   guestfs_handle_event_cb cb;
1228   void *data;
1229 };
1230
1231 static fd_set rset;
1232 static fd_set wset;
1233 static fd_set xset;
1234 static int select_init_done = 0;
1235 static int max_fd = -1;
1236 static int nr_fds = 0;
1237 static struct handle_cb_data *handle_cb_data = NULL;
1238
1239 static void
1240 select_init (void)
1241 {
1242   if (!select_init_done) {
1243     FD_ZERO (&rset);
1244     FD_ZERO (&wset);
1245     FD_ZERO (&xset);
1246
1247     select_init_done = 1;
1248   }
1249 }
1250
1251 static int
1252 select_add_handle (guestfs_h *g, int fd, int events,
1253                    guestfs_handle_event_cb cb, void *data)
1254 {
1255   select_init ();
1256
1257   if (fd < 0 || fd >= FD_SETSIZE) {
1258     error (g, "fd %d is out of range", fd);
1259     return -1;
1260   }
1261
1262   if ((events & ~(GUESTFS_HANDLE_READABLE |
1263                   GUESTFS_HANDLE_WRITABLE |
1264                   GUESTFS_HANDLE_HANGUP |
1265                   GUESTFS_HANDLE_ERROR)) != 0) {
1266     error (g, "set of events (0x%x) contains unknown events", events);
1267     return -1;
1268   }
1269
1270   if (events == 0) {
1271     error (g, "set of events is empty");
1272     return -1;
1273   }
1274
1275   if (FD_ISSET (fd, &rset) || FD_ISSET (fd, &wset) || FD_ISSET (fd, &xset)) {
1276     error (g, "fd %d is already registered", fd);
1277     return -1;
1278   }
1279
1280   if (cb == NULL) {
1281     error (g, "callback is NULL");
1282     return -1;
1283   }
1284
1285   if ((events & GUESTFS_HANDLE_READABLE))
1286     FD_SET (fd, &rset);
1287   if ((events & GUESTFS_HANDLE_WRITABLE))
1288     FD_SET (fd, &wset);
1289   if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
1290     FD_SET (fd, &xset);
1291
1292   if (fd > max_fd) {
1293     max_fd = fd;
1294     handle_cb_data = safe_realloc (g, handle_cb_data,
1295                                    sizeof (struct handle_cb_data) * (max_fd+1));
1296   }
1297   handle_cb_data[fd].cb = cb;
1298   handle_cb_data[fd].data = data;
1299
1300   nr_fds++;
1301
1302   /* Any integer >= 0 can be the handle, and this is as good as any ... */
1303   return fd;
1304 }
1305
1306 static int
1307 select_remove_handle (guestfs_h *g, int fd)
1308 {
1309   select_init ();
1310
1311   if (fd < 0 || fd >= FD_SETSIZE) {
1312     error (g, "fd %d is out of range", fd);
1313     return -1;
1314   }
1315
1316   if (!FD_ISSET (fd, &rset) && !FD_ISSET (fd, &wset) && !FD_ISSET (fd, &xset)) {
1317     error (g, "fd %d was not registered", fd);
1318     return -1;
1319   }
1320
1321   FD_CLR (fd, &rset);
1322   FD_CLR (fd, &wset);
1323   FD_CLR (fd, &xset);
1324
1325   if (fd == max_fd) {
1326     max_fd--;
1327     handle_cb_data = safe_realloc (g, handle_cb_data,
1328                                    sizeof (struct handle_cb_data) * (max_fd+1));
1329   }
1330
1331   nr_fds--;
1332
1333   return 0;
1334 }
1335
1336 static int
1337 select_add_timeout (guestfs_h *g, int interval,
1338                     guestfs_handle_timeout_cb cb, void *data)
1339 {
1340   select_init ();
1341
1342   abort ();                     /* XXX not implemented yet */
1343 }
1344
1345 static int
1346 select_remove_timeout (guestfs_h *g, int timer)
1347 {
1348   select_init ();
1349
1350   abort ();                     /* XXX not implemented yet */
1351 }
1352
1353 /* Note that main loops can be nested. */
1354 static int level = 0;
1355
1356 static void
1357 select_main_loop_run (guestfs_h *g)
1358 {
1359   int old_level, fd, r, events;
1360   fd_set rset2, wset2, xset2;
1361
1362   select_init ();
1363
1364   old_level = level++;
1365   while (level > old_level) {
1366     if (nr_fds == 0) {
1367       level = old_level;
1368       break;
1369     }
1370
1371     rset2 = rset;
1372     wset2 = wset;
1373     xset2 = xset;
1374     r = select (max_fd+1, &rset2, &wset2, &xset2, NULL);
1375     if (r == -1) {
1376       perrorf (g, "select");
1377       level = old_level;
1378       break;
1379     }
1380
1381     for (fd = 0; r > 0 && fd <= max_fd; ++fd) {
1382       events = 0;
1383       if (FD_ISSET (fd, &rset2))
1384         events |= GUESTFS_HANDLE_READABLE;
1385       if (FD_ISSET (fd, &wset2))
1386         events |= GUESTFS_HANDLE_WRITABLE;
1387       if (FD_ISSET (fd, &xset2))
1388         events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
1389       if (events) {
1390         r--;
1391         handle_cb_data[fd].cb (handle_cb_data[fd].data,
1392                                fd, fd, events);
1393       }
1394     }
1395   }
1396 }
1397
1398 static void
1399 select_main_loop_quit (guestfs_h *g)
1400 {
1401   select_init ();
1402
1403   if (level == 0) {
1404     error (g, "cannot quit, we are not in a main loop");
1405     return;
1406   }
1407
1408   level--;
1409 }