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;
 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     *pend = '\0';
 537     len = pend - pelem;
 538
 539     /* Empty element or "." means cwd. */
 540     if (len == 0 || (len == 1 && *pelem == '.')) {
 541       if (g->verbose)
 542         fprintf (stderr,
 543                  "looking for kernel and initrd in current directory\n");
 544       if (access (kernel_name, F_OK) == 0 && access (initrd_name, F_OK) == 0) {
 545         kernel = safe_strdup (g, kernel_name);
 546         initrd = safe_strdup (g, initrd_name);
 547         break;
 548       }
 549     }
 550     /* Look at <path>/kernel etc. */
 551     else {
 552       kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
 553       initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
 554       sprintf (kernel, "%s/%s", pelem, kernel_name);
 555       sprintf (initrd, "%s/%s", pelem, initrd_name);
 556
 557       if (g->verbose)
 558         fprintf (stderr, "looking for %s and %s\n", kernel, initrd);
 559
 560       if (access (kernel, F_OK) == 0 && access (initrd, F_OK) == 0)
 561         break;
 562       free (kernel);
 563       free (initrd);
 564       kernel = initrd = NULL;
 565     }
 566
 567     pelem = pend;
 568   } while (*pelem++ != '\0');
 569
 570   free (path);
 571
 572   if (kernel == NULL || initrd == NULL) {
 573     error (g, "cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)",
 574            kernel_name, initrd_name, g->path);
 575     goto cleanup0;
 576   }
 577
 578   /* Make the temporary directory containing the socket. */
 579   if (!g->tmpdir) {
 580     g->tmpdir = safe_strdup (g, dir_template);
 581     if (mkdtemp (g->tmpdir) == NULL) {
 582       perrorf (g, "%s: cannot create temporary directory", dir_template);
 583       goto cleanup0;
 584     }
 585   }
 586
 587   snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
 588   unlink (unixsock);
 589
 590   if (pipe (wfd) == -1 || pipe (rfd) == -1) {
 591     perrorf (g, "pipe");
 592     goto cleanup0;
 593   }
 594
 595   r = fork ();
 596   if (r == -1) {
 597     perrorf (g, "fork");
 598     close (wfd[0]);
 599     close (wfd[1]);
 600     close (rfd[0]);
 601     close (rfd[1]);
 602     goto cleanup0;
 603   }
 604
 605   if (r == 0) {                 /* Child (qemu). */
 606     char vmchannel[256];
 607     char append[256];
 608
 609     /* Set up the full command line.  Do this in the subprocess so we
 610      * don't need to worry about cleaning up.
 611      */
 612     g->cmdline[0] = (char *) QEMU;
 613
 614     /* Construct the -net channel parameter for qemu. */
 615     snprintf (vmchannel, sizeof vmchannel,
 616               "channel,%d:unix:%s,server,nowait",
 617               VMCHANNEL_PORT, unixsock);
 618
 619     /* Linux kernel command line. */
 620     snprintf (append, sizeof append,
 621               "console=ttyS0 guestfs=%s:%d", VMCHANNEL_ADDR, VMCHANNEL_PORT);
 622
 623     add_cmdline (g, "-m");
 624     add_cmdline (g, "384");       /* XXX Choose best size. */
 625     add_cmdline (g, "-no-kqemu"); /* Avoids a warning. */
 626     add_cmdline (g, "-kernel");
 627     add_cmdline (g, (char *) kernel);
 628     add_cmdline (g, "-initrd");
 629     add_cmdline (g, (char *) initrd);
 630     add_cmdline (g, "-append");
 631     add_cmdline (g, append);
 632     add_cmdline (g, "-nographic");
 633     add_cmdline (g, "-serial");
 634     add_cmdline (g, "stdio");
 635     add_cmdline (g, "-net");
 636     add_cmdline (g, vmchannel);
 637     add_cmdline (g, "-net");
 638     add_cmdline (g, "user,vlan=0");
 639     add_cmdline (g, "-net");
 640     add_cmdline (g, "nic,vlan=0");
 641     incr_cmdline_size (g);
 642     g->cmdline[g->cmdline_size-1] = NULL;
 643
 644     if (g->verbose) {
 645       fprintf (stderr, "%s", QEMU);
 646       for (i = 0; g->cmdline[i]; ++i)
 647         fprintf (stderr, " %s", g->cmdline[i]);
 648       fprintf (stderr, "\n");
 649     }
 650
 651     /* Set up stdin, stdout. */
 652     close (0);
 653     close (1);
 654     close (wfd[1]);
 655     close (rfd[0]);
 656     dup (wfd[0]);
 657     dup (rfd[1]);
 658     close (wfd[0]);
 659     close (rfd[1]);
 660
 661 #if 0
 662     /* Set up a new process group, so we can signal this process
 663      * and all subprocesses (eg. if qemu is really a shell script).
 664      */
 665     setpgid (0, 0);
 666 #endif
 667
 668     execv (QEMU, g->cmdline);   /* Run qemu. */
 669     perror (QEMU);
 670     _exit (1);
 671   }
 672
 673   /* Parent (library). */
 674   g->pid = r;
 675
 676   /* Start the clock ... */
 677   time (&g->start_t);
 678
 679   /* Close the other ends of the pipe. */
 680   close (wfd[0]);
 681   close (rfd[1]);
 682
 683   if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
 684       fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
 685     perrorf (g, "fcntl");
 686     goto cleanup1;
 687   }
 688
 689   g->fd[0] = wfd[1];            /* stdin of child */
 690   g->fd[1] = rfd[0];            /* stdout of child */
 691
 692   /* Open the Unix socket.  The vmchannel implementation that got
 693    * merged with qemu sucks in a number of ways.  Both ends do
 694    * connect(2), which means that no one knows what, if anything, is
 695    * connected to the other end, or if it becomes disconnected.  Even
 696    * worse, we have to wait some indeterminate time for qemu to create
 697    * the socket and connect to it (which happens very early in qemu's
 698    * start-up), so any code that uses vmchannel is inherently racy.
 699    * Hence this silly loop.
 700    */
 701   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
 702   if (g->sock == -1) {
 703     perrorf (g, "socket");
 704     goto cleanup1;
 705   }
 706
 707   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
 708     perrorf (g, "fcntl");
 709     goto cleanup2;
 710   }
 711
 712   addr.sun_family = AF_UNIX;
 713   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
 714   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
 715
 716   tries = 100;
 717   while (tries > 0) {
 718     /* Always sleep at least once to give qemu a small chance to start up. */
 719     usleep (10000);
 720
 721     r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
 722     if ((r == -1 && errno == EINPROGRESS) || r == 0)
 723       goto connected;
 724
 725     if (errno != ENOENT)
 726       perrorf (g, "connect");
 727     tries--;
 728   }
 729
 730   error (g, "failed to connect to vmchannel socket");
 731   goto cleanup2;
 732
 733  connected:
 734   /* Watch the file descriptors. */
 735   free (g->msg_in);
 736   g->msg_in = NULL;
 737   g->msg_in_size = g->msg_in_allocated = 0;
 738
 739   free (g->msg_out);
 740   g->msg_out = NULL;
 741   g->msg_out_size = 0;
 742   g->msg_out_pos = 0;
 743
 744   g->stdout_watch =
 745     main_loop.add_handle (g, g->fd[1],
 746                           GUESTFS_HANDLE_READABLE,
 747                           stdout_event, g);
 748   if (g->stdout_watch == -1) {
 749     error (g, "could not watch qemu stdout");
 750     goto cleanup3;
 751   }
 752
 753   g->sock_watch =
 754     main_loop.add_handle (g, g->sock,
 755                           GUESTFS_HANDLE_READABLE,
 756                           sock_read_event, g);
 757   if (g->sock_watch == -1) {
 758     error (g, "could not watch daemon communications socket");
 759     goto cleanup3;
 760   }
 761
 762   g->state = LAUNCHING;
 763   return 0;
 764
 765  cleanup3:
 766   if (g->stdout_watch >= 0)
 767     main_loop.remove_handle (g, g->stdout_watch);
 768   if (g->sock_watch >= 0)
 769     main_loop.remove_handle (g, g->sock_watch);
 770
 771  cleanup2:
 772   close (g->sock);
 773
 774  cleanup1:
 775   close (wfd[1]);
 776   close (rfd[0]);
 777   kill (g->pid, 9);
 778   waitpid (g->pid, NULL, 0);
 779   g->fd[0] = -1;
 780   g->fd[1] = -1;
 781   g->sock = -1;
 782   g->pid = 0;
 783   g->start_t = 0;
 784   g->stdout_watch = -1;
 785   g->sock_watch = -1;
 786
 787  cleanup0:
 788   free (kernel);
 789   free (initrd);
 790   return -1;
 791 }
 792
 793 static void
 794 finish_wait_ready (guestfs_h *g, void *vp)
 795 {
 796   *((int *)vp) = 1;
 797   main_loop.main_loop_quit (g);
 798 }
 799
 800 int
 801 guestfs_wait_ready (guestfs_h *g)
 802 {
 803   int r = 0;
 804
 805   if (g->state == READY) return 0;
 806
 807   if (g->state == BUSY) {
 808     error (g, "qemu has finished launching already");
 809     return -1;
 810   }
 811
 812   if (g->state != LAUNCHING) {
 813     error (g, "qemu has not been launched yet");
 814     return -1;
 815   }
 816
 817   g->launch_done_cb_internal = finish_wait_ready;
 818   g->launch_done_cb_internal_data = &r;
 819   main_loop.main_loop_run (g);
 820   g->launch_done_cb_internal = NULL;
 821   g->launch_done_cb_internal_data = NULL;
 822
 823   if (r != 1) {
 824     error (g, "guestfs_wait_ready failed, see earlier error messages");
 825     return -1;
 826   }
 827
 828   /* This is possible in some really strange situations, such as
 829    * guestfsd starts up OK but then qemu immediately exits.  Check for
 830    * it because the caller is probably expecting to be able to send
 831    * commands after this function returns.
 832    */
 833   if (g->state != READY) {
 834     error (g, "qemu launched and contacted daemon, but state != READY");
 835     return -1;
 836   }
 837
 838   return 0;
 839 }
 840
 841 int
 842 guestfs_kill_subprocess (guestfs_h *g)
 843 {
 844   if (g->state == CONFIG) {
 845     error (g, "no subprocess to kill");
 846     return -1;
 847   }
 848
 849   if (g->verbose)
 850     fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
 851
 852   kill (g->pid, SIGTERM);
 853
 854   return 0;
 855 }
 856
 857 /* This function is called whenever qemu prints something on stdout.
 858  * Qemu's stdout is also connected to the guest's serial console, so
 859  * we see kernel messages here too.
 860  */
 861 static void
 862 stdout_event (void *data, int watch, int fd, int events)
 863 {
 864   guestfs_h *g = (guestfs_h *) data;
 865   char buf[4096];
 866   int n;
 867
 868 #if 0
 869   if (g->verbose)
 870     fprintf (stderr,
 871              "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
 872              g, g->state, fd, events);
 873 #endif
 874
 875   if (g->fd[1] != fd) {
 876     error (g, "stdout_event: internal error: %d != %d", g->fd[1], fd);
 877     return;
 878   }
 879
 880   n = read (fd, buf, sizeof buf);
 881   if (n == 0) {
 882     /* Hopefully this indicates the qemu child process has died. */
 883     if (g->verbose)
 884       fprintf (stderr, "stdout_event: %p: child process died\n", g);
 885     /*kill (g->pid, SIGTERM);*/
 886     waitpid (g->pid, NULL, 0);
 887     if (g->stdout_watch >= 0)
 888       main_loop.remove_handle (g, g->stdout_watch);
 889     if (g->sock_watch >= 0)
 890       main_loop.remove_handle (g, g->sock_watch);
 891     close (g->fd[0]);
 892     close (g->fd[1]);
 893     close (g->sock);
 894     g->fd[0] = -1;
 895     g->fd[1] = -1;
 896     g->sock = -1;
 897     g->pid = 0;
 898     g->start_t = 0;
 899     g->stdout_watch = -1;
 900     g->sock_watch = -1;
 901     g->state = CONFIG;
 902     if (g->subprocess_quit_cb)
 903       g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
 904     return;
 905   }
 906
 907   if (n == -1) {
 908     if (errno != EAGAIN)
 909       perrorf (g, "read");
 910     return;
 911   }
 912
 913   /* In verbose mode, copy all log messages to stderr. */
 914   if (g->verbose)
 915     write (2, buf, n);
 916
 917   /* It's an actual log message, send it upwards if anyone is listening. */
 918   if (g->log_message_cb)
 919     g->log_message_cb (g, g->log_message_cb_data, buf, n);
 920 }
 921
 922 /* The function is called whenever we can read something on the
 923  * guestfsd (daemon inside the guest) communication socket.
 924  */
 925 static void
 926 sock_read_event (void *data, int watch, int fd, int events)
 927 {
 928   guestfs_h *g = (guestfs_h *) data;
 929   XDR xdr;
 930   unsigned len;
 931   int n;
 932
 933   if (g->verbose)
 934     fprintf (stderr,
 935              "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
 936              g, g->state, fd, events);
 937
 938   if (g->sock != fd) {
 939     error (g, "sock_read_event: internal error: %d != %d", g->sock, fd);
 940     return;
 941   }
 942
 943   if (g->msg_in_size <= g->msg_in_allocated) {
 944     g->msg_in_allocated += 4096;
 945     g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
 946   }
 947   n = read (g->sock, g->msg_in + g->msg_in_size,
 948             g->msg_in_allocated - g->msg_in_size);
 949   if (n == 0)
 950     /* Disconnected?  Ignore it because stdout_watch will get called
 951      * and will do the cleanup.
 952      */
 953     return;
 954
 955   if (n == -1) {
 956     if (errno != EAGAIN)
 957       perrorf (g, "read");
 958     return;
 959   }
 960
 961   g->msg_in_size += n;
 962
 963   /* Have we got enough of a message to be able to process it yet? */
 964   if (g->msg_in_size < 4) return;
 965
 966   xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
 967   if (!xdr_uint32_t (&xdr, &len)) {
 968     error (g, "can't decode length word");
 969     goto cleanup;
 970   }
 971
 972   /* Length is normally the length of the message, but when guestfsd
 973    * starts up it sends a "magic" value (longer than any possible
 974    * message).  Check for this.
 975    */
 976   if (len == 0xf5f55ff5) {
 977     if (g->state != LAUNCHING)
 978       error (g, "received magic signature from guestfsd, but in state %d",
 979              g->state);
 980     else if (g->msg_in_size != 4)
 981       error (g, "received magic signature from guestfsd, but msg size is %d",
 982              g->msg_in_size);
 983     else {
 984       g->state = READY;
 985       if (g->launch_done_cb_internal)
 986         g->launch_done_cb_internal (g, g->launch_done_cb_internal_data);
 987       if (g->launch_done_cb)
 988         g->launch_done_cb (g, g->launch_done_cb_data);
 989     }
 990
 991     goto cleanup;
 992   }
 993
 994   /* If this happens, it's pretty bad and we've probably lost synchronization.*/
 995   if (len > GUESTFS_MESSAGE_MAX) {
 996     error (g, "message length (%u) > maximum possible size (%d)",
 997            len, GUESTFS_MESSAGE_MAX);
 998     goto cleanup;
 999   }
1000
1001   if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1002
1003   /* This should not happen, and if it does it probably means we've
1004    * lost all hope of synchronization.
1005    */
1006   if (g->msg_in_size-4 > len) {
1007     error (g, "len = %d, but msg_in_size-4 = %d", len, g->msg_in_size-4);
1008     goto cleanup;
1009   }
1010
1011   /* Not in the expected state. */
1012   if (g->state != BUSY)
1013     error (g, "state %d != BUSY", g->state);
1014
1015   /* Push the message up to the higher layer.  Note that unlike
1016    * launch_done_cb / launch_done_cb_internal, we only call at
1017    * most one of the callback functions here.
1018    */
1019   g->state = READY;
1020   if (g->reply_cb_internal)
1021     g->reply_cb_internal (g, g->reply_cb_internal_data, &xdr);
1022   else if (g->reply_cb)
1023     g->reply_cb (g, g->reply_cb, &xdr);
1024
1025  cleanup:
1026   /* Free the message buffer if it's grown excessively large. */
1027   if (g->msg_in_allocated > 65536) {
1028     free (g->msg_in);
1029     g->msg_in = NULL;
1030     g->msg_in_size = g->msg_in_allocated = 0;
1031   } else
1032     g->msg_in_size = 0;
1033
1034   xdr_destroy (&xdr);
1035 }
1036
1037 /* The function is called whenever we can write something on the
1038  * guestfsd (daemon inside the guest) communication socket.
1039  */
1040 static void
1041 sock_write_event (void *data, int watch, int fd, int events)
1042 {
1043   guestfs_h *g = (guestfs_h *) data;
1044   int n;
1045
1046   if (g->verbose)
1047     fprintf (stderr,
1048              "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1049              g, g->state, fd, events);
1050
1051   if (g->sock != fd) {
1052     error (g, "sock_write_event: internal error: %d != %d", g->sock, fd);
1053     return;
1054   }
1055
1056   if (g->state != BUSY) {
1057     error (g, "sock_write_event: state %d != BUSY", g->state);
1058     return;
1059   }
1060
1061   if (g->verbose)
1062     fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1063              g->msg_out_size - g->msg_out_pos);
1064
1065   n = write (g->sock, g->msg_out + g->msg_out_pos,
1066              g->msg_out_size - g->msg_out_pos);
1067   if (n == -1) {
1068     if (errno != EAGAIN)
1069       perrorf (g, "write");
1070     return;
1071   }
1072
1073   if (g->verbose)
1074     fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1075
1076   g->msg_out_pos += n;
1077
1078   /* More to write? */
1079   if (g->msg_out_pos < g->msg_out_size)
1080     return;
1081
1082   if (g->verbose)
1083     fprintf (stderr, "sock_write_event: done writing, switching back to reading events\n");
1084
1085   free (g->msg_out);
1086   g->msg_out_pos = g->msg_out_size = 0;
1087
1088   if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1089     error (g, "remove_handle failed in sock_write_event");
1090     return;
1091   }
1092   g->sock_watch =
1093     main_loop.add_handle (g, g->sock,
1094                           GUESTFS_HANDLE_READABLE,
1095                           sock_read_event, g);
1096   if (g->sock_watch == -1) {
1097     error (g, "add_handle failed in sock_write_event");
1098     return;
1099   }
1100 }
1101
1102 /* Dispatch a call to the remote daemon.  This function just queues
1103  * the call in msg_out, to be sent when we next enter the main loop.
1104  * Returns -1 for error, or the message serial number.
1105  */
1106 static int
1107 dispatch (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args)
1108 {
1109   char buffer[GUESTFS_MESSAGE_MAX];
1110   struct guestfs_message_header hdr;
1111   XDR xdr;
1112   unsigned len;
1113   int serial = g->msg_next_serial++;
1114
1115   if (g->state != READY) {
1116     error (g, "dispatch: state %d != READY", g->state);
1117     return -1;
1118   }
1119
1120   /* Serialize the header. */
1121   hdr.prog = GUESTFS_PROGRAM;
1122   hdr.vers = GUESTFS_PROTOCOL_VERSION;
1123   hdr.proc = proc_nr;
1124   hdr.direction = GUESTFS_DIRECTION_CALL;
1125   hdr.serial = serial;
1126   hdr.status = GUESTFS_STATUS_OK;
1127
1128   xdrmem_create (&xdr, buffer, sizeof buffer, XDR_ENCODE);
1129   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
1130     error (g, "xdr_guestfs_message_header failed");
1131     return -1;
1132   }
1133
1134   /* Serialize the args.  If any, because some message types
1135    * have no parameters.
1136    */
1137   if (xdrp) {
1138     if (!(*xdrp) (&xdr, args)) {
1139       error (g, "dispatch failed to marshal args");
1140       return -1;
1141     }
1142   }
1143
1144   len = xdr_getpos (&xdr);
1145   xdr_destroy (&xdr);
1146
1147   /* Allocate the outgoing message buffer. */
1148   g->msg_out = safe_malloc (g, len + 4);
1149
1150   g->msg_out_size = len + 4;
1151   g->msg_out_pos = 0;
1152   g->state = BUSY;
1153
1154   xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
1155   if (!xdr_uint32_t (&xdr, &len)) {
1156     error (g, "xdr_uint32_t failed in dispatch");
1157     goto cleanup1;
1158   }
1159
1160   memcpy (g->msg_out + 4, buffer, len);
1161
1162   /* Change the handle to sock_write_event. */
1163   if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1164     error (g, "remove_handle failed in dispatch");
1165     goto cleanup1;
1166   }
1167   g->sock_watch =
1168     main_loop.add_handle (g, g->sock,
1169                           GUESTFS_HANDLE_WRITABLE,
1170                           sock_write_event, g);
1171   if (g->sock_watch == -1) {
1172     error (g, "add_handle failed in dispatch");
1173     goto cleanup1;
1174   }
1175
1176   return serial;
1177
1178  cleanup1:
1179   free (g->msg_out);
1180   g->msg_out = NULL;
1181   g->msg_out_size = 0;
1182   g->state = READY;
1183   return -1;
1184 }
1185
1186 /* Check the return message from a call for validity. */
1187 static int
1188 check_reply_header (guestfs_h *g,
1189                     const struct guestfs_message_header *hdr,
1190                     int proc_nr, int serial)
1191 {
1192   if (hdr->prog != GUESTFS_PROGRAM) {
1193     error (g, "wrong program (%d/%d)", hdr->prog, GUESTFS_PROGRAM);
1194     return -1;
1195   }
1196   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
1197     error (g, "wrong protocol version (%d/%d)",
1198            hdr->vers, GUESTFS_PROTOCOL_VERSION);
1199     return -1;
1200   }
1201   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
1202     error (g, "unexpected message direction (%d/%d)",
1203            hdr->direction, GUESTFS_DIRECTION_REPLY);
1204     return -1;
1205   }
1206   if (hdr->proc != proc_nr) {
1207     error (g, "unexpected procedure number (%d/%d)", hdr->proc, proc_nr);
1208     return -1;
1209   }
1210   if (hdr->serial != serial) {
1211     error (g, "unexpected serial (%d/%d)", hdr->serial, serial);
1212     return -1;
1213   }
1214
1215   return 0;
1216 }
1217
1218 /* The high-level actions are autogenerated by generator.ml.  Include
1219  * them here.
1220  */
1221 #include "guestfs-actions.c"
1222
1223 /* This is the default main loop implementation, using select(2). */
1224
1225 struct handle_cb_data {
1226   guestfs_handle_event_cb cb;
1227   void *data;
1228 };
1229
1230 static fd_set rset;
1231 static fd_set wset;
1232 static fd_set xset;
1233 static int select_init_done = 0;
1234 static int max_fd = -1;
1235 static int nr_fds = 0;
1236 static struct handle_cb_data *handle_cb_data = NULL;
1237
1238 static void
1239 select_init (void)
1240 {
1241   if (!select_init_done) {
1242     FD_ZERO (&rset);
1243     FD_ZERO (&wset);
1244     FD_ZERO (&xset);
1245
1246     select_init_done = 1;
1247   }
1248 }
1249
1250 static int
1251 select_add_handle (guestfs_h *g, int fd, int events,
1252                    guestfs_handle_event_cb cb, void *data)
1253 {
1254   select_init ();
1255
1256   if (fd < 0 || fd >= FD_SETSIZE) {
1257     error (g, "fd %d is out of range", fd);
1258     return -1;
1259   }
1260
1261   if ((events & ~(GUESTFS_HANDLE_READABLE |
1262                   GUESTFS_HANDLE_WRITABLE |
1263                   GUESTFS_HANDLE_HANGUP |
1264                   GUESTFS_HANDLE_ERROR)) != 0) {
1265     error (g, "set of events (0x%x) contains unknown events", events);
1266     return -1;
1267   }
1268
1269   if (events == 0) {
1270     error (g, "set of events is empty");
1271     return -1;
1272   }
1273
1274   if (FD_ISSET (fd, &rset) || FD_ISSET (fd, &wset) || FD_ISSET (fd, &xset)) {
1275     error (g, "fd %d is already registered", fd);
1276     return -1;
1277   }
1278
1279   if (cb == NULL) {
1280     error (g, "callback is NULL");
1281     return -1;
1282   }
1283
1284   if ((events & GUESTFS_HANDLE_READABLE))
1285     FD_SET (fd, &rset);
1286   if ((events & GUESTFS_HANDLE_WRITABLE))
1287     FD_SET (fd, &wset);
1288   if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
1289     FD_SET (fd, &xset);
1290
1291   if (fd > max_fd) {
1292     max_fd = fd;
1293     handle_cb_data = safe_realloc (g, handle_cb_data,
1294                                    sizeof (struct handle_cb_data) * (max_fd+1));
1295   }
1296   handle_cb_data[fd].cb = cb;
1297   handle_cb_data[fd].data = data;
1298
1299   nr_fds++;
1300
1301   /* Any integer >= 0 can be the handle, and this is as good as any ... */
1302   return fd;
1303 }
1304
1305 static int
1306 select_remove_handle (guestfs_h *g, int fd)
1307 {
1308   select_init ();
1309
1310   if (fd < 0 || fd >= FD_SETSIZE) {
1311     error (g, "fd %d is out of range", fd);
1312     return -1;
1313   }
1314
1315   if (!FD_ISSET (fd, &rset) && !FD_ISSET (fd, &wset) && !FD_ISSET (fd, &xset)) {
1316     error (g, "fd %d was not registered", fd);
1317     return -1;
1318   }
1319
1320   FD_CLR (fd, &rset);
1321   FD_CLR (fd, &wset);
1322   FD_CLR (fd, &xset);
1323
1324   if (fd == max_fd) {
1325     max_fd--;
1326     handle_cb_data = safe_realloc (g, handle_cb_data,
1327                                    sizeof (struct handle_cb_data) * (max_fd+1));
1328   }
1329
1330   nr_fds--;
1331
1332   return 0;
1333 }
1334
1335 static int
1336 select_add_timeout (guestfs_h *g, int interval,
1337                     guestfs_handle_timeout_cb cb, void *data)
1338 {
1339   select_init ();
1340
1341   abort ();                     /* XXX not implemented yet */
1342 }
1343
1344 static int
1345 select_remove_timeout (guestfs_h *g, int timer)
1346 {
1347   select_init ();
1348
1349   abort ();                     /* XXX not implemented yet */
1350 }
1351
1352 /* Note that main loops can be nested. */
1353 static int level = 0;
1354
1355 static void
1356 select_main_loop_run (guestfs_h *g)
1357 {
1358   int old_level, fd, r, events;
1359   fd_set rset2, wset2, xset2;
1360
1361   select_init ();
1362
1363   old_level = level++;
1364   while (level > old_level) {
1365     if (nr_fds == 0) {
1366       level = old_level;
1367       break;
1368     }
1369
1370     rset2 = rset;
1371     wset2 = wset;
1372     xset2 = xset;
1373     r = select (max_fd+1, &rset2, &wset2, &xset2, NULL);
1374     if (r == -1) {
1375       perrorf (g, "select");
1376       level = old_level;
1377       break;
1378     }
1379
1380     for (fd = 0; r > 0 && fd <= max_fd; ++fd) {
1381       events = 0;
1382       if (FD_ISSET (fd, &rset2))
1383         events |= GUESTFS_HANDLE_READABLE;
1384       if (FD_ISSET (fd, &wset2))
1385         events |= GUESTFS_HANDLE_WRITABLE;
1386       if (FD_ISSET (fd, &xset2))
1387         events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
1388       if (events) {
1389         r--;
1390         handle_cb_data[fd].cb (handle_cb_data[fd].data,
1391                                fd, fd, events);
1392       }
1393     }
1394   }
1395 }
1396
1397 static void
1398 select_main_loop_quit (guestfs_h *g)
1399 {
1400   select_init ();
1401
1402   if (level == 0) {
1403     error (g, "cannot quit, we are not in a main loop");
1404     return;
1405   }
1406
1407   level--;
1408 }