src/proto.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
  38 #include <rpc/types.h>
  39 #include <rpc/xdr.h>
  40
  41 #ifdef HAVE_ERRNO_H
  42 #include <errno.h>
  43 #endif
  44
  45 #ifdef HAVE_SYS_TYPES_H
  46 #include <sys/types.h>
  47 #endif
  48
  49 #ifdef HAVE_SYS_WAIT_H
  50 #include <sys/wait.h>
  51 #endif
  52
  53 #ifdef HAVE_SYS_SOCKET_H
  54 #include <sys/socket.h>
  55 #endif
  56
  57 #ifdef HAVE_SYS_UN_H
  58 #include <sys/un.h>
  59 #endif
  60
  61 #include <arpa/inet.h>
  62 #include <netinet/in.h>
  63
  64 #include "c-ctype.h"
  65 #include "glthread/lock.h"
  66 #include "ignore-value.h"
  67
  68 #include "guestfs.h"
  69 #include "guestfs-internal.h"
  70 #include "guestfs-internal-actions.h"
  71 #include "guestfs_protocol.h"
  72
  73 /* Size of guestfs_progress message on the wire. */
  74 #define PROGRESS_MESSAGE_SIZE 24
  75
  76 /* This is the code used to send and receive RPC messages and (for
  77  * certain types of message) to perform file transfers.  This code is
  78  * driven from the generated actions (src/actions.c).  There
  79  * are five different cases to consider:
  80  *
  81  * (1) A non-daemon function.  There is no RPC involved at all, it's
  82  * all handled inside the library.
  83  *
  84  * (2) A simple RPC (eg. "mount").  We write the request, then read
  85  * the reply.  The sequence of calls is:
  86  *
  87  *   guestfs___set_busy
  88  *   guestfs___send
  89  *   guestfs___recv
  90  *   guestfs___end_busy
  91  *
  92  * (3) An RPC with FileOut parameters (eg. "upload").  We write the
  93  * request, then write the file(s), then read the reply.  The sequence
  94  * of calls is:
  95  *
  96  *   guestfs___set_busy
  97  *   guestfs___send
  98  *   guestfs___send_file  (possibly multiple times)
  99  *   guestfs___recv
 100  *   guestfs___end_busy
 101  *
 102  * (4) An RPC with FileIn parameters (eg. "download").  We write the
 103  * request, then read the reply, then read the file(s).  The sequence
 104  * of calls is:
 105  *
 106  *   guestfs___set_busy
 107  *   guestfs___send
 108  *   guestfs___recv
 109  *   guestfs___recv_file  (possibly multiple times)
 110  *   guestfs___end_busy
 111  *
 112  * (5) Both FileOut and FileIn parameters.  There are no calls like
 113  * this in the current API, but they would be implemented as a
 114  * combination of cases (3) and (4).
 115  *
 116  * During all writes and reads, we also select(2) on qemu stdout
 117  * looking for messages (guestfsd stderr and guest kernel dmesg), and
 118  * anything received is passed up through the log_message_cb.  This is
 119  * also the reason why all the sockets are non-blocking.  We also have
 120  * to check for EOF (qemu died).  All of this is handled by the
 121  * functions send_to_daemon and recv_from_daemon.
 122  */
 123
 124 /* This is only used on the debug path, to generate a one-line
 125  * printable summary of a protocol message.  'workspace' is scratch
 126  * space used to format the message, and it must be at least
 127  * MAX_MESSAGE_SUMMARY bytes in size.
 128  */
 129 #define MAX_MESSAGE_SUMMARY 200 /* >= 5 * (4 * 3 + 2) + a few bytes overhead */
 130
 131 static int
 132 xwrite (int fd, const void *v_buf, size_t len)
 133 {
 134   const char *buf = v_buf;
 135   int r;
 136
 137   while (len > 0) {
 138     r = write (fd, buf, len);
 139     if (r == -1)
 140       return -1;
 141
 142     buf += r;
 143     len -= r;
 144   }
 145
 146   return 0;
 147 }
 148
 149 static const char *
 150 message_summary (const void *buf, size_t n, char *workspace)
 151 {
 152   const unsigned char *cbuf = buf;
 153   size_t i = 0;
 154   char *p = workspace;
 155   int truncate = 0;
 156
 157   /* Print only up to 5 x 32 bits of the message.  That is enough to
 158    * cover the message length, and the first four fields of the
 159    * message header (prog, vers, proc, direction).
 160    */
 161   if (n > 5 * 4) {
 162     n = 5 * 4;
 163     truncate = 1;
 164   }
 165
 166   while (n > 0) {
 167     sprintf (p, "%02x ", cbuf[i]);
 168     p += 3;
 169     n--;
 170     i++;
 171
 172     if ((i & 3) == 0) {
 173       strcpy (p, "| ");
 174       p += 2;
 175     }
 176   }
 177
 178   if (truncate)
 179     strcpy (p, "...");
 180
 181   return workspace;
 182 }
 183
 184 int
 185 guestfs___set_busy (guestfs_h *g)
 186 {
 187   if (g->state != READY) {
 188     error (g, _("guestfs_set_busy: called when in state %d != READY"),
 189            g->state);
 190     return -1;
 191   }
 192   g->state = BUSY;
 193   return 0;
 194 }
 195
 196 int
 197 guestfs___end_busy (guestfs_h *g)
 198 {
 199   switch (g->state)
 200     {
 201     case BUSY:
 202       g->state = READY;
 203       break;
 204     case CONFIG:
 205     case READY:
 206       break;
 207
 208     case LAUNCHING:
 209     case NO_HANDLE:
 210     default:
 211       error (g, _("guestfs_end_busy: called when in state %d"), g->state);
 212       return -1;
 213     }
 214   return 0;
 215 }
 216
 217 /* This is called if we detect EOF, ie. qemu died. */
 218 static void
 219 child_cleanup (guestfs_h *g)
 220 {
 221   debug (g, "child_cleanup: %p: child process died", g);
 222
 223   /*if (g->pid > 0) kill (g->pid, SIGTERM);*/
 224   if (g->recoverypid > 0) kill (g->recoverypid, 9);
 225   waitpid (g->pid, NULL, 0);
 226   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 227   if (g->fd[0] >= 0) close (g->fd[0]);
 228   if (g->fd[1] >= 0) close (g->fd[1]);
 229   close (g->sock);
 230   g->fd[0] = -1;
 231   g->fd[1] = -1;
 232   g->sock = -1;
 233   g->pid = 0;
 234   g->recoverypid = 0;
 235   memset (&g->launch_t, 0, sizeof g->launch_t);
 236   g->state = CONFIG;
 237   guestfs___call_callbacks_void (g, GUESTFS_EVENT_SUBPROCESS_QUIT);
 238 }
 239
 240 static int
 241 read_log_message_or_eof (guestfs_h *g, int fd, int error_if_eof)
 242 {
 243   char buf[BUFSIZ];
 244   int n;
 245
 246 #if 0
 247   debug (g, "read_log_message_or_eof: %p g->state = %d, fd = %d",
 248          g, g->state, fd);
 249 #endif
 250
 251   /* QEMU's console emulates a 16550A serial port.  The real 16550A
 252    * device has a small FIFO buffer (16 bytes) which means here we see
 253    * lots of small reads of 1-16 bytes in length, usually single
 254    * bytes.  Sleeping here for a very brief period groups reads
 255    * together (so we usually get a few lines of output at once) and
 256    * improves overall throughput, as well as making the event
 257    * interface a bit more sane for callers.  With a virtio-serial
 258    * based console (not yet implemented) we may be able to remove
 259    * this.  XXX
 260    */
 261   usleep (1000);
 262
 263   n = read (fd, buf, sizeof buf);
 264   if (n == 0) {
 265     /* Hopefully this indicates the qemu child process has died. */
 266     child_cleanup (g);
 267
 268     if (error_if_eof) {
 269       /* We weren't expecting eof here (called from launch) so place
 270        * something in the error buffer.  RHBZ#588851.
 271        */
 272       error (g, "child process died unexpectedly");
 273     }
 274     return -1;
 275   }
 276
 277   if (n == -1) {
 278     if (errno == EINTR || errno == EAGAIN)
 279       return 0;
 280
 281     perrorf (g, "read");
 282     return -1;
 283   }
 284
 285   /* It's an actual log message, send it upwards if anyone is listening. */
 286   guestfs___call_callbacks_message (g, GUESTFS_EVENT_APPLIANCE, buf, n);
 287
 288   /* This is a gross hack.  See the comment above
 289    * guestfs___launch_send_progress.
 290    */
 291   if (g->state == LAUNCHING) {
 292     const char *sentinel;
 293     size_t len;
 294
 295     sentinel = "Linux version"; /* kernel up */
 296     len = strlen (sentinel);
 297     if (memmem (buf, n, sentinel, len) != NULL)
 298       guestfs___launch_send_progress (g, 6);
 299
 300     sentinel = "Starting /init script"; /* /init running */
 301     len = strlen (sentinel);
 302     if (memmem (buf, n, sentinel, len) != NULL)
 303       guestfs___launch_send_progress (g, 9);
 304   }
 305
 306   return 0;
 307 }
 308
 309 /* Read 'n' bytes, setting the socket to blocking temporarily so
 310  * that we really read the number of bytes requested.
 311  * Returns:  0 == EOF while reading
 312  *          -1 == error, error() function has been called
 313  *           n == read 'n' bytes in full
 314  */
 315 static ssize_t
 316 really_read_from_socket (guestfs_h *g, int sock, char *buf, size_t n)
 317 {
 318   long flags;
 319   ssize_t r;
 320   size_t got;
 321
 322   /* Set socket to blocking. */
 323   flags = fcntl (sock, F_GETFL);
 324   if (flags == -1) {
 325     perrorf (g, "fcntl");
 326     return -1;
 327   }
 328   if (fcntl (sock, F_SETFL, flags & ~O_NONBLOCK) == -1) {
 329     perrorf (g, "fcntl");
 330     return -1;
 331   }
 332
 333   got = 0;
 334   while (got < n) {
 335     r = read (sock, &buf[got], n-got);
 336     if (r == -1) {
 337       perrorf (g, "read");
 338       return -1;
 339     }
 340     if (r == 0)
 341       return 0; /* EOF */
 342     got += r;
 343   }
 344
 345   /* Restore original socket flags. */
 346   if (fcntl (sock, F_SETFL, flags) == -1) {
 347     perrorf (g, "fcntl");
 348     return -1;
 349   }
 350
 351   return (ssize_t) got;
 352 }
 353
 354 /* Convenient wrapper to generate a progress message callback. */
 355 void
 356 guestfs___progress_message_callback (guestfs_h *g,
 357                                      const guestfs_progress *message)
 358 {
 359   uint64_t array[4];
 360
 361   array[0] = message->proc;
 362   array[1] = message->serial;
 363   array[2] = message->position;
 364   array[3] = message->total;
 365
 366   guestfs___call_callbacks_array (g, GUESTFS_EVENT_PROGRESS,
 367                                   array, sizeof array / sizeof array[0]);
 368 }
 369
 370 static int
 371 check_for_daemon_cancellation_or_eof (guestfs_h *g, int fd)
 372 {
 373   char summary[MAX_MESSAGE_SUMMARY];
 374   char buf[4];
 375   ssize_t n;
 376   uint32_t flag;
 377   XDR xdr;
 378
 379   n = really_read_from_socket (g, fd, buf, 4);
 380   if (n == -1)
 381     return -1;
 382   if (n == 0) {
 383     /* Hopefully this indicates the qemu child process has died. */
 384     child_cleanup (g);
 385     return -1;
 386   }
 387
 388   debug (g, "check_for_daemon_cancellation_or_eof: %s",
 389          message_summary (buf, 4, summary));
 390
 391   xdrmem_create (&xdr, buf, 4, XDR_DECODE);
 392   xdr_uint32_t (&xdr, &flag);
 393   xdr_destroy (&xdr);
 394
 395   /* Read and process progress messages that happen during FileIn. */
 396   if (flag == GUESTFS_PROGRESS_FLAG) {
 397     char buf[PROGRESS_MESSAGE_SIZE];
 398
 399     n = really_read_from_socket (g, fd, buf, PROGRESS_MESSAGE_SIZE);
 400     if (n == -1)
 401       return -1;
 402     if (n == 0) {
 403       child_cleanup (g);
 404       return -1;
 405     }
 406
 407     if (g->state == BUSY) {
 408       guestfs_progress message;
 409
 410       xdrmem_create (&xdr, buf, PROGRESS_MESSAGE_SIZE, XDR_DECODE);
 411       xdr_guestfs_progress (&xdr, &message);
 412       xdr_destroy (&xdr);
 413
 414       guestfs___progress_message_callback (g, &message);
 415     }
 416
 417     return 0;
 418   }
 419
 420   if (flag != GUESTFS_CANCEL_FLAG) {
 421     error (g, _("check_for_daemon_cancellation_or_eof: read 0x%x from daemon, expected 0x%x\n"),
 422            flag, GUESTFS_CANCEL_FLAG);
 423     return -1;
 424   }
 425
 426   return -2;
 427 }
 428
 429 /* This writes the whole N bytes of BUF to the daemon socket.
 430  *
 431  * If the whole write is successful, it returns 0.
 432  * If there was an error, it returns -1.
 433  * If the daemon sent a cancellation message, it returns -2.
 434  *
 435  * It also checks qemu stdout for log messages and passes those up
 436  * through log_message_cb.
 437  *
 438  * It also checks for EOF (qemu died) and passes that up through the
 439  * child_cleanup function above.
 440  */
 441 int
 442 guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n)
 443 {
 444   const char *buf = v_buf;
 445   fd_set rset, rset2;
 446   fd_set wset, wset2;
 447   char summary[MAX_MESSAGE_SUMMARY];
 448
 449   debug (g, "send_to_daemon: %zu bytes: %s", n,
 450          message_summary (v_buf, n, summary));
 451
 452   FD_ZERO (&rset);
 453   FD_ZERO (&wset);
 454
 455   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 456     FD_SET (g->fd[1], &rset);
 457   FD_SET (g->sock, &rset);      /* Read socket for cancellation & EOF. */
 458   FD_SET (g->sock, &wset);      /* Write to socket to send the data. */
 459
 460   int max_fd = MAX (g->sock, g->fd[1]);
 461
 462   while (n > 0) {
 463     rset2 = rset;
 464     wset2 = wset;
 465     int r = select (max_fd+1, &rset2, &wset2, NULL, NULL);
 466     if (r == -1) {
 467       if (errno == EINTR || errno == EAGAIN)
 468         continue;
 469       perrorf (g, "select");
 470       return -1;
 471     }
 472
 473     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 474       if (read_log_message_or_eof (g, g->fd[1], 0) == -1)
 475         return -1;
 476     }
 477     if (FD_ISSET (g->sock, &rset2)) {
 478       r = check_for_daemon_cancellation_or_eof (g, g->sock);
 479       if (r == -1)
 480         return r;
 481       if (r == -2) {
 482         /* Daemon sent cancel message.  But to maintain
 483          * synchronization we must write out the remainder of the
 484          * write buffer before we return (RHBZ#576879).
 485          */
 486         if (xwrite (g->sock, buf, n) == -1) {
 487           perrorf (g, "write");
 488           return -1;
 489         }
 490         return -2; /* cancelled */
 491       }
 492     }
 493     if (FD_ISSET (g->sock, &wset2)) {
 494       r = write (g->sock, buf, n);
 495       if (r == -1) {
 496         if (errno == EINTR || errno == EAGAIN)
 497           continue;
 498         perrorf (g, "write");
 499         if (errno == EPIPE) /* Disconnected from guest (RHBZ#508713). */
 500           child_cleanup (g);
 501         return -1;
 502       }
 503       buf += r;
 504       n -= r;
 505     }
 506   }
 507
 508   return 0;
 509 }
 510
 511 /* This reads a single message, file chunk, launch flag or
 512  * cancellation flag from the daemon.  If something was read, it
 513  * returns 0, otherwise -1.
 514  *
 515  * Both size_rtn and buf_rtn must be passed by the caller as non-NULL.
 516  *
 517  * *size_rtn returns the size of the returned message or it may be
 518  * GUESTFS_LAUNCH_FLAG or GUESTFS_CANCEL_FLAG.
 519  *
 520  * *buf_rtn is returned containing the message (if any) or will be set
 521  * to NULL.  *buf_rtn must be freed by the caller.
 522  *
 523  * It also checks qemu stdout for log messages and passes those up
 524  * through log_message_cb.
 525  *
 526  * It also checks for EOF (qemu died) and passes that up through the
 527  * child_cleanup function above.
 528  *
 529  * Progress notifications are handled transparently by this function.
 530  * If the callback exists, it is called.  The caller of this function
 531  * will not see GUESTFS_PROGRESS_FLAG.
 532  */
 533
 534 int
 535 guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn)
 536 {
 537   char summary[MAX_MESSAGE_SUMMARY];
 538   fd_set rset, rset2;
 539
 540   FD_ZERO (&rset);
 541
 542   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 543     FD_SET (g->fd[1], &rset);
 544   FD_SET (g->sock, &rset);      /* Read socket for data & EOF. */
 545
 546   int max_fd = MAX (g->sock, g->fd[1]);
 547
 548   *size_rtn = 0;
 549   *buf_rtn = NULL;
 550
 551   char lenbuf[4];
 552   /* nr is the size of the message, but we prime it as -4 because we
 553    * have to read the message length word first.
 554    */
 555   ssize_t nr = -4;
 556
 557   for (;;) {
 558     ssize_t message_size =
 559       *size_rtn != GUESTFS_PROGRESS_FLAG ?
 560       *size_rtn : PROGRESS_MESSAGE_SIZE;
 561     if (nr >= message_size)
 562       break;
 563
 564     rset2 = rset;
 565     int r = select (max_fd+1, &rset2, NULL, NULL, NULL);
 566     if (r == -1) {
 567       if (errno == EINTR || errno == EAGAIN)
 568         continue;
 569       perrorf (g, "select");
 570       free (*buf_rtn);
 571       *buf_rtn = NULL;
 572       return -1;
 573     }
 574
 575     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 576       if (read_log_message_or_eof (g, g->fd[1], 0) == -1) {
 577         free (*buf_rtn);
 578         *buf_rtn = NULL;
 579         return -1;
 580       }
 581     }
 582     if (FD_ISSET (g->sock, &rset2)) {
 583       if (nr < 0) {    /* Have we read the message length word yet? */
 584         r = read (g->sock, lenbuf+nr+4, -nr);
 585         if (r == -1) {
 586           if (errno == EINTR || errno == EAGAIN)
 587             continue;
 588           int err = errno;
 589           perrorf (g, "read");
 590           /* Under some circumstances we see "Connection reset by peer"
 591            * here when the child dies suddenly.  Catch this and call
 592            * the cleanup function, same as for EOF.
 593            */
 594           if (err == ECONNRESET)
 595             child_cleanup (g);
 596           return -1;
 597         }
 598         if (r == 0) {
 599           error (g, _("unexpected end of file when reading from daemon"));
 600           child_cleanup (g);
 601           return -1;
 602         }
 603         nr += r;
 604
 605         if (nr < 0)         /* Still not got the whole length word. */
 606           continue;
 607
 608         XDR xdr;
 609         xdrmem_create (&xdr, lenbuf, 4, XDR_DECODE);
 610         xdr_uint32_t (&xdr, size_rtn);
 611         xdr_destroy (&xdr);
 612
 613         /* *size_rtn changed, recalculate message_size */
 614         message_size =
 615           *size_rtn != GUESTFS_PROGRESS_FLAG ?
 616           *size_rtn : PROGRESS_MESSAGE_SIZE;
 617
 618         if (*size_rtn == GUESTFS_LAUNCH_FLAG) {
 619           if (g->state != LAUNCHING)
 620             error (g, _("received magic signature from guestfsd, but in state %d"),
 621                    g->state);
 622           else {
 623             g->state = READY;
 624             guestfs___call_callbacks_void (g, GUESTFS_EVENT_LAUNCH_DONE);
 625           }
 626           debug (g, "recv_from_daemon: received GUESTFS_LAUNCH_FLAG");
 627           return 0;
 628         }
 629         else if (*size_rtn == GUESTFS_CANCEL_FLAG) {
 630           debug (g, "recv_from_daemon: received GUESTFS_CANCEL_FLAG");
 631           return 0;
 632         }
 633         else if (*size_rtn == GUESTFS_PROGRESS_FLAG)
 634           /*FALLTHROUGH*/;
 635         /* If this happens, it's pretty bad and we've probably lost
 636          * synchronization.
 637          */
 638         else if (*size_rtn > GUESTFS_MESSAGE_MAX) {
 639           error (g, _("message length (%u) > maximum possible size (%d)"),
 640                  (unsigned) *size_rtn, GUESTFS_MESSAGE_MAX);
 641           return -1;
 642         }
 643
 644         /* Allocate the complete buffer, size now known. */
 645         *buf_rtn = safe_malloc (g, message_size);
 646         /*FALLTHROUGH*/
 647       }
 648
 649       size_t sizetoread = message_size - nr;
 650       if (sizetoread > BUFSIZ) sizetoread = BUFSIZ;
 651
 652       r = read (g->sock, (char *) (*buf_rtn) + nr, sizetoread);
 653       if (r == -1) {
 654         if (errno == EINTR || errno == EAGAIN)
 655           continue;
 656         perrorf (g, "read");
 657         free (*buf_rtn);
 658         *buf_rtn = NULL;
 659         return -1;
 660       }
 661       if (r == 0) {
 662         error (g, _("unexpected end of file when reading from daemon"));
 663         child_cleanup (g);
 664         free (*buf_rtn);
 665         *buf_rtn = NULL;
 666         return -1;
 667       }
 668       nr += r;
 669     }
 670   }
 671
 672   /* Got the full message, caller can start processing it. */
 673 #ifdef ENABLE_PACKET_DUMP
 674   if (g->verbose) {
 675     ssize_t i, j;
 676
 677     for (i = 0; i < nr; i += 16) {
 678       printf ("%04zx: ", i);
 679       for (j = i; j < MIN (i+16, nr); ++j)
 680         printf ("%02x ", (*(unsigned char **)buf_rtn)[j]);
 681       for (; j < i+16; ++j)
 682         printf ("   ");
 683       printf ("|");
 684       for (j = i; j < MIN (i+16, nr); ++j)
 685         if (c_isprint ((*(char **)buf_rtn)[j]))
 686           printf ("%c", (*(char **)buf_rtn)[j]);
 687         else
 688           printf (".");
 689       for (; j < i+16; ++j)
 690         printf (" ");
 691       printf ("|\n");
 692     }
 693   }
 694 #endif
 695
 696   if (*size_rtn == GUESTFS_PROGRESS_FLAG) {
 697     if (g->state == BUSY) {
 698       guestfs_progress message;
 699       XDR xdr;
 700       xdrmem_create (&xdr, *buf_rtn, PROGRESS_MESSAGE_SIZE, XDR_DECODE);
 701       xdr_guestfs_progress (&xdr, &message);
 702       xdr_destroy (&xdr);
 703
 704       guestfs___progress_message_callback (g, &message);
 705     }
 706
 707     free (*buf_rtn);
 708     *buf_rtn = NULL;
 709
 710     /* Process next message. */
 711     return guestfs___recv_from_daemon (g, size_rtn, buf_rtn);
 712   }
 713
 714   debug (g, "recv_from_daemon: %" PRIu32 " bytes: %s", *size_rtn,
 715          message_summary (*buf_rtn, *size_rtn, summary));
 716
 717   return 0;
 718 }
 719
 720 /* This is very much like recv_from_daemon above, but g->sock is
 721  * a listening socket and we are accepting a new connection on
 722  * that socket instead of reading anything.  Returns the newly
 723  * accepted socket.
 724  */
 725 int
 726 guestfs___accept_from_daemon (guestfs_h *g)
 727 {
 728   fd_set rset, rset2;
 729
 730   debug (g, "accept_from_daemon: %p g->state = %d", g, g->state);
 731
 732   FD_ZERO (&rset);
 733
 734   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 735     FD_SET (g->fd[1], &rset);
 736   FD_SET (g->sock, &rset);      /* Read socket for accept. */
 737
 738   int max_fd = MAX (g->sock, g->fd[1]);
 739   int sock = -1;
 740
 741   while (sock == -1) {
 742     /* If the qemu process has died, clean up the zombie (RHBZ#579155).
 743      * By partially polling in the select below we ensure that this
 744      * function will be called eventually.
 745      */
 746     waitpid (g->pid, NULL, WNOHANG);
 747
 748     rset2 = rset;
 749
 750     struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
 751     int r = select (max_fd+1, &rset2, NULL, NULL, &tv);
 752     if (r == -1) {
 753       if (errno == EINTR || errno == EAGAIN)
 754         continue;
 755       perrorf (g, "select");
 756       return -1;
 757     }
 758
 759     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 760       if (read_log_message_or_eof (g, g->fd[1], 1) == -1)
 761         return -1;
 762     }
 763     if (FD_ISSET (g->sock, &rset2)) {
 764       sock = accept (g->sock, NULL, NULL);
 765       if (sock == -1) {
 766         if (errno == EINTR || errno == EAGAIN)
 767           continue;
 768         perrorf (g, "accept");
 769         return -1;
 770       }
 771     }
 772   }
 773
 774   return sock;
 775 }
 776
 777 int
 778 guestfs___send (guestfs_h *g, int proc_nr,
 779                 uint64_t progress_hint, uint64_t optargs_bitmask,
 780                 xdrproc_t xdrp, char *args)
 781 {
 782   struct guestfs_message_header hdr;
 783   XDR xdr;
 784   u_int32_t len;
 785   int serial = g->msg_next_serial++;
 786   int r;
 787   char *msg_out;
 788   size_t msg_out_size;
 789
 790   if (g->state != BUSY) {
 791     error (g, _("guestfs___send: state %d != BUSY"), g->state);
 792     return -1;
 793   }
 794
 795   /* We have to allocate this message buffer on the heap because
 796    * it is quite large (although will be mostly unused).  We
 797    * can't allocate it on the stack because in some environments
 798    * we have quite limited stack space available, notably when
 799    * running in the JVM.
 800    */
 801   msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
 802   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
 803
 804   /* Serialize the header. */
 805   hdr.prog = GUESTFS_PROGRAM;
 806   hdr.vers = GUESTFS_PROTOCOL_VERSION;
 807   hdr.proc = proc_nr;
 808   hdr.direction = GUESTFS_DIRECTION_CALL;
 809   hdr.serial = serial;
 810   hdr.status = GUESTFS_STATUS_OK;
 811   hdr.progress_hint = progress_hint;
 812   hdr.optargs_bitmask = optargs_bitmask;
 813
 814   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
 815     error (g, _("xdr_guestfs_message_header failed"));
 816     goto cleanup1;
 817   }
 818
 819   /* Serialize the args.  If any, because some message types
 820    * have no parameters.
 821    */
 822   if (xdrp) {
 823     if (!(*xdrp) (&xdr, args)) {
 824       error (g, _("dispatch failed to marshal args"));
 825       goto cleanup1;
 826     }
 827   }
 828
 829   /* Get the actual length of the message, resize the buffer to match
 830    * the actual length, and write the length word at the beginning.
 831    */
 832   len = xdr_getpos (&xdr);
 833   xdr_destroy (&xdr);
 834
 835   msg_out = safe_realloc (g, msg_out, len + 4);
 836   msg_out_size = len + 4;
 837
 838   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
 839   xdr_uint32_t (&xdr, &len);
 840
 841  again:
 842   r = guestfs___send_to_daemon (g, msg_out, msg_out_size);
 843   if (r == -2)                  /* Ignore stray daemon cancellations. */
 844     goto again;
 845   if (r == -1)
 846     goto cleanup1;
 847   free (msg_out);
 848
 849   return serial;
 850
 851  cleanup1:
 852   free (msg_out);
 853   return -1;
 854 }
 855
 856 static int cancel = 0; /* XXX Implement file cancellation. */
 857 static int send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t len);
 858 static int send_file_data (guestfs_h *g, const char *buf, size_t len);
 859 static int send_file_cancellation (guestfs_h *g);
 860 static int send_file_complete (guestfs_h *g);
 861
 862 /* Send a file.
 863  * Returns:
 864  *   0 OK
 865  *   -1 error
 866  *   -2 daemon cancelled (we must read the error message)
 867  */
 868 int
 869 guestfs___send_file (guestfs_h *g, const char *filename)
 870 {
 871   char buf[GUESTFS_MAX_CHUNK_SIZE];
 872   int fd, r, err;
 873
 874   fd = open (filename, O_RDONLY);
 875   if (fd == -1) {
 876     perrorf (g, "open: %s", filename);
 877     send_file_cancellation (g);
 878     return -1;
 879   }
 880
 881   /* Send file in chunked encoding. */
 882   while (!cancel) {
 883     r = read (fd, buf, sizeof buf);
 884     if (r == -1 && (errno == EINTR || errno == EAGAIN))
 885       continue;
 886     if (r <= 0) break;
 887     err = send_file_data (g, buf, r);
 888     if (err < 0) {
 889       if (err == -2)            /* daemon sent cancellation */
 890         send_file_cancellation (g);
 891       return err;
 892     }
 893   }
 894
 895   if (cancel) {                 /* cancel from either end */
 896     send_file_cancellation (g);
 897     return -1;
 898   }
 899
 900   if (r == -1) {
 901     perrorf (g, "read: %s", filename);
 902     send_file_cancellation (g);
 903     return -1;
 904   }
 905
 906   /* End of file, but before we send that, we need to close
 907    * the file and check for errors.
 908    */
 909   if (close (fd) == -1) {
 910     perrorf (g, "close: %s", filename);
 911     send_file_cancellation (g);
 912     return -1;
 913   }
 914
 915   return send_file_complete (g);
 916 }
 917
 918 /* Send a chunk of file data. */
 919 static int
 920 send_file_data (guestfs_h *g, const char *buf, size_t len)
 921 {
 922   return send_file_chunk (g, 0, buf, len);
 923 }
 924
 925 /* Send a cancellation message. */
 926 static int
 927 send_file_cancellation (guestfs_h *g)
 928 {
 929   return send_file_chunk (g, 1, NULL, 0);
 930 }
 931
 932 /* Send a file complete chunk. */
 933 static int
 934 send_file_complete (guestfs_h *g)
 935 {
 936   char buf[1];
 937   return send_file_chunk (g, 0, buf, 0);
 938 }
 939
 940 static int
 941 send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t buflen)
 942 {
 943   u_int32_t len;
 944   int r;
 945   guestfs_chunk chunk;
 946   XDR xdr;
 947   char *msg_out;
 948   size_t msg_out_size;
 949
 950   if (g->state != BUSY) {
 951     error (g, _("send_file_chunk: state %d != READY"), g->state);
 952     return -1;
 953   }
 954
 955   /* Allocate the chunk buffer.  Don't use the stack to avoid
 956    * excessive stack usage and unnecessary copies.
 957    */
 958   msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
 959   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
 960
 961   /* Serialize the chunk. */
 962   chunk.cancel = cancel;
 963   chunk.data.data_len = buflen;
 964   chunk.data.data_val = (char *) buf;
 965
 966   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
 967     error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
 968            buf, buflen);
 969     xdr_destroy (&xdr);
 970     goto cleanup1;
 971   }
 972
 973   len = xdr_getpos (&xdr);
 974   xdr_destroy (&xdr);
 975
 976   /* Reduce the size of the outgoing message buffer to the real length. */
 977   msg_out = safe_realloc (g, msg_out, len + 4);
 978   msg_out_size = len + 4;
 979
 980   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
 981   xdr_uint32_t (&xdr, &len);
 982
 983   r = guestfs___send_to_daemon (g, msg_out, msg_out_size);
 984
 985   /* Did the daemon send a cancellation message? */
 986   if (r == -2) {
 987     debug (g, "got daemon cancellation");
 988     return -2;
 989   }
 990
 991   if (r == -1)
 992     goto cleanup1;
 993
 994   free (msg_out);
 995
 996   return 0;
 997
 998  cleanup1:
 999   free (msg_out);
1000   return -1;
1001 }
1002
1003 /* Receive a reply. */
1004 int
1005 guestfs___recv (guestfs_h *g, const char *fn,
1006                 guestfs_message_header *hdr,
1007                 guestfs_message_error *err,
1008                 xdrproc_t xdrp, char *ret)
1009 {
1010   XDR xdr;
1011   void *buf;
1012   uint32_t size;
1013   int r;
1014
1015  again:
1016   r = guestfs___recv_from_daemon (g, &size, &buf);
1017   if (r == -1)
1018     return -1;
1019
1020   /* This can happen if a cancellation happens right at the end
1021    * of us sending a FileIn parameter to the daemon.  Discard.  The
1022    * daemon should send us an error message next.
1023    */
1024   if (size == GUESTFS_CANCEL_FLAG)
1025     goto again;
1026
1027   if (size == GUESTFS_LAUNCH_FLAG) {
1028     error (g, "%s: received unexpected launch flag from daemon when expecting reply", fn);
1029     return -1;
1030   }
1031
1032   xdrmem_create (&xdr, buf, size, XDR_DECODE);
1033
1034   if (!xdr_guestfs_message_header (&xdr, hdr)) {
1035     error (g, "%s: failed to parse reply header", fn);
1036     xdr_destroy (&xdr);
1037     free (buf);
1038     return -1;
1039   }
1040   if (hdr->status == GUESTFS_STATUS_ERROR) {
1041     if (!xdr_guestfs_message_error (&xdr, err)) {
1042       error (g, "%s: failed to parse reply error", fn);
1043       xdr_destroy (&xdr);
1044       free (buf);
1045       return -1;
1046     }
1047   } else {
1048     if (xdrp && ret && !xdrp (&xdr, ret)) {
1049       error (g, "%s: failed to parse reply", fn);
1050       xdr_destroy (&xdr);
1051       free (buf);
1052       return -1;
1053     }
1054   }
1055   xdr_destroy (&xdr);
1056   free (buf);
1057
1058   return 0;
1059 }
1060
1061 /* Same as guestfs___recv, but it discards the reply message. */
1062 int
1063 guestfs___recv_discard (guestfs_h *g, const char *fn)
1064 {
1065   void *buf;
1066   uint32_t size;
1067   int r;
1068
1069  again:
1070   r = guestfs___recv_from_daemon (g, &size, &buf);
1071   if (r == -1)
1072     return -1;
1073
1074   /* This can happen if a cancellation happens right at the end
1075    * of us sending a FileIn parameter to the daemon.  Discard.  The
1076    * daemon should send us an error message next.
1077    */
1078   if (size == GUESTFS_CANCEL_FLAG)
1079     goto again;
1080
1081   if (size == GUESTFS_LAUNCH_FLAG) {
1082     error (g, "%s: received unexpected launch flag from daemon when expecting reply", fn);
1083     return -1;
1084   }
1085
1086   return 0;
1087 }
1088
1089 /* Receive a file. */
1090
1091 /* Returns -1 = error, 0 = EOF, > 0 = more data */
1092 static ssize_t receive_file_data (guestfs_h *g, void **buf);
1093
1094 int
1095 guestfs___recv_file (guestfs_h *g, const char *filename)
1096 {
1097   void *buf;
1098   int fd, r;
1099
1100   fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
1101   if (fd == -1) {
1102     perrorf (g, "open: %s", filename);
1103     goto cancel;
1104   }
1105
1106   /* Receive the file in chunked encoding. */
1107   while ((r = receive_file_data (g, &buf)) > 0) {
1108     if (xwrite (fd, buf, r) == -1) {
1109       perrorf (g, "%s: write", filename);
1110       free (buf);
1111       goto cancel;
1112     }
1113     free (buf);
1114   }
1115
1116   if (r == -1) {
1117     error (g, _("%s: error in chunked encoding"), filename);
1118     return -1;
1119   }
1120
1121   if (close (fd) == -1) {
1122     perrorf (g, "close: %s", filename);
1123     return -1;
1124   }
1125
1126   return 0;
1127
1128  cancel: ;
1129   /* Send cancellation message to daemon, then wait until it
1130    * cancels (just throwing away data).
1131    */
1132   XDR xdr;
1133   char fbuf[4];
1134   uint32_t flag = GUESTFS_CANCEL_FLAG;
1135
1136   debug (g, "%s: waiting for daemon to acknowledge cancellation",
1137          __func__);
1138
1139   xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
1140   xdr_uint32_t (&xdr, &flag);
1141   xdr_destroy (&xdr);
1142
1143   if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
1144     perrorf (g, _("write to daemon socket"));
1145     return -1;
1146   }
1147
1148   while (receive_file_data (g, NULL) > 0)
1149     ;                           /* just discard it */
1150
1151   return -1;
1152 }
1153
1154 /* Receive a chunk of file data. */
1155 /* Returns -1 = error, 0 = EOF, > 0 = more data */
1156 static ssize_t
1157 receive_file_data (guestfs_h *g, void **buf_r)
1158 {
1159   int r;
1160   void *buf;
1161   uint32_t len;
1162   XDR xdr;
1163   guestfs_chunk chunk;
1164
1165   r = guestfs___recv_from_daemon (g, &len, &buf);
1166   if (r == -1) {
1167     error (g, _("receive_file_data: parse error in reply callback"));
1168     return -1;
1169   }
1170
1171   if (len == GUESTFS_LAUNCH_FLAG || len == GUESTFS_CANCEL_FLAG) {
1172     error (g, _("receive_file_data: unexpected flag received when reading file chunks"));
1173     return -1;
1174   }
1175
1176   memset (&chunk, 0, sizeof chunk);
1177
1178   xdrmem_create (&xdr, buf, len, XDR_DECODE);
1179   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
1180     error (g, _("failed to parse file chunk"));
1181     free (buf);
1182     return -1;
1183   }
1184   xdr_destroy (&xdr);
1185   /* After decoding, the original buffer is no longer used. */
1186   free (buf);
1187
1188   if (chunk.cancel) {
1189     error (g, _("file receive cancelled by daemon"));
1190     free (chunk.data.data_val);
1191     return -1;
1192   }
1193
1194   if (chunk.data.data_len == 0) { /* end of transfer */
1195     free (chunk.data.data_val);
1196     return 0;
1197   }
1198
1199   if (buf_r) *buf_r = chunk.data.data_val;
1200   else free (chunk.data.data_val); /* else caller frees */
1201
1202   return chunk.data.data_len;
1203 }