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.
 255    */
 256   n = read (fd, buf, sizeof buf);
 257   if (n == 0) {
 258     /* Hopefully this indicates the qemu child process has died. */
 259     child_cleanup (g);
 260
 261     if (error_if_eof) {
 262       /* We weren't expecting eof here (called from launch) so place
 263        * something in the error buffer.  RHBZ#588851.
 264        */
 265       error (g, "child process died unexpectedly");
 266     }
 267     return -1;
 268   }
 269
 270   if (n == -1) {
 271     if (errno == EINTR || errno == EAGAIN)
 272       return 0;
 273
 274     perrorf (g, "read");
 275     return -1;
 276   }
 277
 278   /* It's an actual log message, send it upwards if anyone is listening. */
 279   guestfs___call_callbacks_message (g, GUESTFS_EVENT_APPLIANCE, buf, n);
 280
 281   return 0;
 282 }
 283
 284 /* Read 'n' bytes, setting the socket to blocking temporarily so
 285  * that we really read the number of bytes requested.
 286  * Returns:  0 == EOF while reading
 287  *          -1 == error, error() function has been called
 288  *           n == read 'n' bytes in full
 289  */
 290 static ssize_t
 291 really_read_from_socket (guestfs_h *g, int sock, char *buf, size_t n)
 292 {
 293   long flags;
 294   ssize_t r;
 295   size_t got;
 296
 297   /* Set socket to blocking. */
 298   flags = fcntl (sock, F_GETFL);
 299   if (flags == -1) {
 300     perrorf (g, "fcntl");
 301     return -1;
 302   }
 303   if (fcntl (sock, F_SETFL, flags & ~O_NONBLOCK) == -1) {
 304     perrorf (g, "fcntl");
 305     return -1;
 306   }
 307
 308   got = 0;
 309   while (got < n) {
 310     r = read (sock, &buf[got], n-got);
 311     if (r == -1) {
 312       perrorf (g, "read");
 313       return -1;
 314     }
 315     if (r == 0)
 316       return 0; /* EOF */
 317     got += r;
 318   }
 319
 320   /* Restore original socket flags. */
 321   if (fcntl (sock, F_SETFL, flags) == -1) {
 322     perrorf (g, "fcntl");
 323     return -1;
 324   }
 325
 326   return (ssize_t) got;
 327 }
 328
 329 static void
 330 send_progress_message (guestfs_h *g, const guestfs_progress *message)
 331 {
 332   uint64_t array[4];
 333
 334   array[0] = message->proc;
 335   array[1] = message->serial;
 336   array[2] = message->position;
 337   array[3] = message->total;
 338
 339   guestfs___call_callbacks_array (g, GUESTFS_EVENT_PROGRESS,
 340                                   array, sizeof array / sizeof array[0]);
 341 }
 342
 343 static int
 344 check_for_daemon_cancellation_or_eof (guestfs_h *g, int fd)
 345 {
 346   char summary[MAX_MESSAGE_SUMMARY];
 347   char buf[4];
 348   ssize_t n;
 349   uint32_t flag;
 350   XDR xdr;
 351
 352   n = really_read_from_socket (g, fd, buf, 4);
 353   if (n == -1)
 354     return -1;
 355   if (n == 0) {
 356     /* Hopefully this indicates the qemu child process has died. */
 357     child_cleanup (g);
 358     return -1;
 359   }
 360
 361   debug (g, "check_for_daemon_cancellation_or_eof: %s",
 362          message_summary (buf, 4, summary));
 363
 364   xdrmem_create (&xdr, buf, 4, XDR_DECODE);
 365   xdr_uint32_t (&xdr, &flag);
 366   xdr_destroy (&xdr);
 367
 368   /* Read and process progress messages that happen during FileIn. */
 369   if (flag == GUESTFS_PROGRESS_FLAG) {
 370     char buf[PROGRESS_MESSAGE_SIZE];
 371
 372     n = really_read_from_socket (g, fd, buf, PROGRESS_MESSAGE_SIZE);
 373     if (n == -1)
 374       return -1;
 375     if (n == 0) {
 376       child_cleanup (g);
 377       return -1;
 378     }
 379
 380     if (g->state == BUSY) {
 381       guestfs_progress message;
 382
 383       xdrmem_create (&xdr, buf, PROGRESS_MESSAGE_SIZE, XDR_DECODE);
 384       xdr_guestfs_progress (&xdr, &message);
 385       xdr_destroy (&xdr);
 386
 387       send_progress_message (g, &message);
 388     }
 389
 390     return 0;
 391   }
 392
 393   if (flag != GUESTFS_CANCEL_FLAG) {
 394     error (g, _("check_for_daemon_cancellation_or_eof: read 0x%x from daemon, expected 0x%x\n"),
 395            flag, GUESTFS_CANCEL_FLAG);
 396     return -1;
 397   }
 398
 399   return -2;
 400 }
 401
 402 /* This writes the whole N bytes of BUF to the daemon socket.
 403  *
 404  * If the whole write is successful, it returns 0.
 405  * If there was an error, it returns -1.
 406  * If the daemon sent a cancellation message, it returns -2.
 407  *
 408  * It also checks qemu stdout for log messages and passes those up
 409  * through log_message_cb.
 410  *
 411  * It also checks for EOF (qemu died) and passes that up through the
 412  * child_cleanup function above.
 413  */
 414 int
 415 guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n)
 416 {
 417   const char *buf = v_buf;
 418   fd_set rset, rset2;
 419   fd_set wset, wset2;
 420   char summary[MAX_MESSAGE_SUMMARY];
 421
 422   debug (g, "send_to_daemon: %zu bytes: %s", n,
 423          message_summary (v_buf, n, summary));
 424
 425   FD_ZERO (&rset);
 426   FD_ZERO (&wset);
 427
 428   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 429     FD_SET (g->fd[1], &rset);
 430   FD_SET (g->sock, &rset);      /* Read socket for cancellation & EOF. */
 431   FD_SET (g->sock, &wset);      /* Write to socket to send the data. */
 432
 433   int max_fd = MAX (g->sock, g->fd[1]);
 434
 435   while (n > 0) {
 436     rset2 = rset;
 437     wset2 = wset;
 438     int r = select (max_fd+1, &rset2, &wset2, NULL, NULL);
 439     if (r == -1) {
 440       if (errno == EINTR || errno == EAGAIN)
 441         continue;
 442       perrorf (g, "select");
 443       return -1;
 444     }
 445
 446     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 447       if (read_log_message_or_eof (g, g->fd[1], 0) == -1)
 448         return -1;
 449     }
 450     if (FD_ISSET (g->sock, &rset2)) {
 451       r = check_for_daemon_cancellation_or_eof (g, g->sock);
 452       if (r == -1)
 453         return r;
 454       if (r == -2) {
 455         /* Daemon sent cancel message.  But to maintain
 456          * synchronization we must write out the remainder of the
 457          * write buffer before we return (RHBZ#576879).
 458          */
 459         if (xwrite (g->sock, buf, n) == -1) {
 460           perrorf (g, "write");
 461           return -1;
 462         }
 463         return -2; /* cancelled */
 464       }
 465     }
 466     if (FD_ISSET (g->sock, &wset2)) {
 467       r = write (g->sock, buf, n);
 468       if (r == -1) {
 469         if (errno == EINTR || errno == EAGAIN)
 470           continue;
 471         perrorf (g, "write");
 472         if (errno == EPIPE) /* Disconnected from guest (RHBZ#508713). */
 473           child_cleanup (g);
 474         return -1;
 475       }
 476       buf += r;
 477       n -= r;
 478     }
 479   }
 480
 481   return 0;
 482 }
 483
 484 /* This reads a single message, file chunk, launch flag or
 485  * cancellation flag from the daemon.  If something was read, it
 486  * returns 0, otherwise -1.
 487  *
 488  * Both size_rtn and buf_rtn must be passed by the caller as non-NULL.
 489  *
 490  * *size_rtn returns the size of the returned message or it may be
 491  * GUESTFS_LAUNCH_FLAG or GUESTFS_CANCEL_FLAG.
 492  *
 493  * *buf_rtn is returned containing the message (if any) or will be set
 494  * to NULL.  *buf_rtn must be freed by the caller.
 495  *
 496  * It also checks qemu stdout for log messages and passes those up
 497  * through log_message_cb.
 498  *
 499  * It also checks for EOF (qemu died) and passes that up through the
 500  * child_cleanup function above.
 501  *
 502  * Progress notifications are handled transparently by this function.
 503  * If the callback exists, it is called.  The caller of this function
 504  * will not see GUESTFS_PROGRESS_FLAG.
 505  */
 506
 507 int
 508 guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn)
 509 {
 510   char summary[MAX_MESSAGE_SUMMARY];
 511   fd_set rset, rset2;
 512
 513   FD_ZERO (&rset);
 514
 515   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 516     FD_SET (g->fd[1], &rset);
 517   FD_SET (g->sock, &rset);      /* Read socket for data & EOF. */
 518
 519   int max_fd = MAX (g->sock, g->fd[1]);
 520
 521   *size_rtn = 0;
 522   *buf_rtn = NULL;
 523
 524   char lenbuf[4];
 525   /* nr is the size of the message, but we prime it as -4 because we
 526    * have to read the message length word first.
 527    */
 528   ssize_t nr = -4;
 529
 530   for (;;) {
 531     ssize_t message_size =
 532       *size_rtn != GUESTFS_PROGRESS_FLAG ?
 533       *size_rtn : PROGRESS_MESSAGE_SIZE;
 534     if (nr >= message_size)
 535       break;
 536
 537     rset2 = rset;
 538     int r = select (max_fd+1, &rset2, NULL, NULL, NULL);
 539     if (r == -1) {
 540       if (errno == EINTR || errno == EAGAIN)
 541         continue;
 542       perrorf (g, "select");
 543       free (*buf_rtn);
 544       *buf_rtn = NULL;
 545       return -1;
 546     }
 547
 548     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 549       if (read_log_message_or_eof (g, g->fd[1], 0) == -1) {
 550         free (*buf_rtn);
 551         *buf_rtn = NULL;
 552         return -1;
 553       }
 554     }
 555     if (FD_ISSET (g->sock, &rset2)) {
 556       if (nr < 0) {    /* Have we read the message length word yet? */
 557         r = read (g->sock, lenbuf+nr+4, -nr);
 558         if (r == -1) {
 559           if (errno == EINTR || errno == EAGAIN)
 560             continue;
 561           int err = errno;
 562           perrorf (g, "read");
 563           /* Under some circumstances we see "Connection reset by peer"
 564            * here when the child dies suddenly.  Catch this and call
 565            * the cleanup function, same as for EOF.
 566            */
 567           if (err == ECONNRESET)
 568             child_cleanup (g);
 569           return -1;
 570         }
 571         if (r == 0) {
 572           error (g, _("unexpected end of file when reading from daemon"));
 573           child_cleanup (g);
 574           return -1;
 575         }
 576         nr += r;
 577
 578         if (nr < 0)         /* Still not got the whole length word. */
 579           continue;
 580
 581         XDR xdr;
 582         xdrmem_create (&xdr, lenbuf, 4, XDR_DECODE);
 583         xdr_uint32_t (&xdr, size_rtn);
 584         xdr_destroy (&xdr);
 585
 586         /* *size_rtn changed, recalculate message_size */
 587         message_size =
 588           *size_rtn != GUESTFS_PROGRESS_FLAG ?
 589           *size_rtn : PROGRESS_MESSAGE_SIZE;
 590
 591         if (*size_rtn == GUESTFS_LAUNCH_FLAG) {
 592           if (g->state != LAUNCHING)
 593             error (g, _("received magic signature from guestfsd, but in state %d"),
 594                    g->state);
 595           else {
 596             g->state = READY;
 597             guestfs___call_callbacks_void (g, GUESTFS_EVENT_LAUNCH_DONE);
 598           }
 599           debug (g, "recv_from_daemon: received GUESTFS_LAUNCH_FLAG");
 600           return 0;
 601         }
 602         else if (*size_rtn == GUESTFS_CANCEL_FLAG) {
 603           debug (g, "recv_from_daemon: received GUESTFS_CANCEL_FLAG");
 604           return 0;
 605         }
 606         else if (*size_rtn == GUESTFS_PROGRESS_FLAG)
 607           /*FALLTHROUGH*/;
 608         /* If this happens, it's pretty bad and we've probably lost
 609          * synchronization.
 610          */
 611         else if (*size_rtn > GUESTFS_MESSAGE_MAX) {
 612           error (g, _("message length (%u) > maximum possible size (%d)"),
 613                  (unsigned) *size_rtn, GUESTFS_MESSAGE_MAX);
 614           return -1;
 615         }
 616
 617         /* Allocate the complete buffer, size now known. */
 618         *buf_rtn = safe_malloc (g, message_size);
 619         /*FALLTHROUGH*/
 620       }
 621
 622       size_t sizetoread = message_size - nr;
 623       if (sizetoread > BUFSIZ) sizetoread = BUFSIZ;
 624
 625       r = read (g->sock, (char *) (*buf_rtn) + nr, sizetoread);
 626       if (r == -1) {
 627         if (errno == EINTR || errno == EAGAIN)
 628           continue;
 629         perrorf (g, "read");
 630         free (*buf_rtn);
 631         *buf_rtn = NULL;
 632         return -1;
 633       }
 634       if (r == 0) {
 635         error (g, _("unexpected end of file when reading from daemon"));
 636         child_cleanup (g);
 637         free (*buf_rtn);
 638         *buf_rtn = NULL;
 639         return -1;
 640       }
 641       nr += r;
 642     }
 643   }
 644
 645   /* Got the full message, caller can start processing it. */
 646 #ifdef ENABLE_PACKET_DUMP
 647   if (g->verbose) {
 648     ssize_t i, j;
 649
 650     for (i = 0; i < nr; i += 16) {
 651       printf ("%04zx: ", i);
 652       for (j = i; j < MIN (i+16, nr); ++j)
 653         printf ("%02x ", (*(unsigned char **)buf_rtn)[j]);
 654       for (; j < i+16; ++j)
 655         printf ("   ");
 656       printf ("|");
 657       for (j = i; j < MIN (i+16, nr); ++j)
 658         if (c_isprint ((*(char **)buf_rtn)[j]))
 659           printf ("%c", (*(char **)buf_rtn)[j]);
 660         else
 661           printf (".");
 662       for (; j < i+16; ++j)
 663         printf (" ");
 664       printf ("|\n");
 665     }
 666   }
 667 #endif
 668
 669   if (*size_rtn == GUESTFS_PROGRESS_FLAG) {
 670     if (g->state == BUSY) {
 671       guestfs_progress message;
 672       XDR xdr;
 673       xdrmem_create (&xdr, *buf_rtn, PROGRESS_MESSAGE_SIZE, XDR_DECODE);
 674       xdr_guestfs_progress (&xdr, &message);
 675       xdr_destroy (&xdr);
 676
 677       send_progress_message (g, &message);
 678     }
 679
 680     free (*buf_rtn);
 681     *buf_rtn = NULL;
 682
 683     /* Process next message. */
 684     return guestfs___recv_from_daemon (g, size_rtn, buf_rtn);
 685   }
 686
 687   debug (g, "recv_from_daemon: %" PRIu32 " bytes: %s", *size_rtn,
 688          message_summary (*buf_rtn, *size_rtn, summary));
 689
 690   return 0;
 691 }
 692
 693 /* This is very much like recv_from_daemon above, but g->sock is
 694  * a listening socket and we are accepting a new connection on
 695  * that socket instead of reading anything.  Returns the newly
 696  * accepted socket.
 697  */
 698 int
 699 guestfs___accept_from_daemon (guestfs_h *g)
 700 {
 701   fd_set rset, rset2;
 702
 703   debug (g, "accept_from_daemon: %p g->state = %d", g, g->state);
 704
 705   FD_ZERO (&rset);
 706
 707   if (g->fd[1] >= 0)            /* Read qemu stdout for log messages & EOF. */
 708     FD_SET (g->fd[1], &rset);
 709   FD_SET (g->sock, &rset);      /* Read socket for accept. */
 710
 711   int max_fd = MAX (g->sock, g->fd[1]);
 712   int sock = -1;
 713
 714   while (sock == -1) {
 715     /* If the qemu process has died, clean up the zombie (RHBZ#579155).
 716      * By partially polling in the select below we ensure that this
 717      * function will be called eventually.
 718      */
 719     waitpid (g->pid, NULL, WNOHANG);
 720
 721     rset2 = rset;
 722
 723     struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
 724     int r = select (max_fd+1, &rset2, NULL, NULL, &tv);
 725     if (r == -1) {
 726       if (errno == EINTR || errno == EAGAIN)
 727         continue;
 728       perrorf (g, "select");
 729       return -1;
 730     }
 731
 732     if (g->fd[1] >= 0 && FD_ISSET (g->fd[1], &rset2)) {
 733       if (read_log_message_or_eof (g, g->fd[1], 1) == -1)
 734         return -1;
 735     }
 736     if (FD_ISSET (g->sock, &rset2)) {
 737       sock = accept (g->sock, NULL, NULL);
 738       if (sock == -1) {
 739         if (errno == EINTR || errno == EAGAIN)
 740           continue;
 741         perrorf (g, "accept");
 742         return -1;
 743       }
 744     }
 745   }
 746
 747   return sock;
 748 }
 749
 750 int
 751 guestfs___send (guestfs_h *g, int proc_nr,
 752                 uint64_t progress_hint, uint64_t optargs_bitmask,
 753                 xdrproc_t xdrp, char *args)
 754 {
 755   struct guestfs_message_header hdr;
 756   XDR xdr;
 757   u_int32_t len;
 758   int serial = g->msg_next_serial++;
 759   int r;
 760   char *msg_out;
 761   size_t msg_out_size;
 762
 763   if (g->state != BUSY) {
 764     error (g, _("guestfs___send: state %d != BUSY"), g->state);
 765     return -1;
 766   }
 767
 768   /* We have to allocate this message buffer on the heap because
 769    * it is quite large (although will be mostly unused).  We
 770    * can't allocate it on the stack because in some environments
 771    * we have quite limited stack space available, notably when
 772    * running in the JVM.
 773    */
 774   msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
 775   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
 776
 777   /* Serialize the header. */
 778   hdr.prog = GUESTFS_PROGRAM;
 779   hdr.vers = GUESTFS_PROTOCOL_VERSION;
 780   hdr.proc = proc_nr;
 781   hdr.direction = GUESTFS_DIRECTION_CALL;
 782   hdr.serial = serial;
 783   hdr.status = GUESTFS_STATUS_OK;
 784   hdr.progress_hint = progress_hint;
 785   hdr.optargs_bitmask = optargs_bitmask;
 786
 787   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
 788     error (g, _("xdr_guestfs_message_header failed"));
 789     goto cleanup1;
 790   }
 791
 792   /* Serialize the args.  If any, because some message types
 793    * have no parameters.
 794    */
 795   if (xdrp) {
 796     if (!(*xdrp) (&xdr, args)) {
 797       error (g, _("dispatch failed to marshal args"));
 798       goto cleanup1;
 799     }
 800   }
 801
 802   /* Get the actual length of the message, resize the buffer to match
 803    * the actual length, and write the length word at the beginning.
 804    */
 805   len = xdr_getpos (&xdr);
 806   xdr_destroy (&xdr);
 807
 808   msg_out = safe_realloc (g, msg_out, len + 4);
 809   msg_out_size = len + 4;
 810
 811   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
 812   xdr_uint32_t (&xdr, &len);
 813
 814  again:
 815   r = guestfs___send_to_daemon (g, msg_out, msg_out_size);
 816   if (r == -2)                  /* Ignore stray daemon cancellations. */
 817     goto again;
 818   if (r == -1)
 819     goto cleanup1;
 820   free (msg_out);
 821
 822   return serial;
 823
 824  cleanup1:
 825   free (msg_out);
 826   return -1;
 827 }
 828
 829 static int cancel = 0; /* XXX Implement file cancellation. */
 830 static int send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t len);
 831 static int send_file_data (guestfs_h *g, const char *buf, size_t len);
 832 static int send_file_cancellation (guestfs_h *g);
 833 static int send_file_complete (guestfs_h *g);
 834
 835 /* Send a file.
 836  * Returns:
 837  *   0 OK
 838  *   -1 error
 839  *   -2 daemon cancelled (we must read the error message)
 840  */
 841 int
 842 guestfs___send_file (guestfs_h *g, const char *filename)
 843 {
 844   char buf[GUESTFS_MAX_CHUNK_SIZE];
 845   int fd, r, err;
 846
 847   fd = open (filename, O_RDONLY);
 848   if (fd == -1) {
 849     perrorf (g, "open: %s", filename);
 850     send_file_cancellation (g);
 851     /* Daemon sees cancellation and won't reply, so caller can
 852      * just return here.
 853      */
 854     return -1;
 855   }
 856
 857   /* Send file in chunked encoding. */
 858   while (!cancel) {
 859     r = read (fd, buf, sizeof buf);
 860     if (r == -1 && (errno == EINTR || errno == EAGAIN))
 861       continue;
 862     if (r <= 0) break;
 863     err = send_file_data (g, buf, r);
 864     if (err < 0) {
 865       if (err == -2)            /* daemon sent cancellation */
 866         send_file_cancellation (g);
 867       return err;
 868     }
 869   }
 870
 871   if (cancel) {                 /* cancel from either end */
 872     send_file_cancellation (g);
 873     return -1;
 874   }
 875
 876   if (r == -1) {
 877     perrorf (g, "read: %s", filename);
 878     send_file_cancellation (g);
 879     return -1;
 880   }
 881
 882   /* End of file, but before we send that, we need to close
 883    * the file and check for errors.
 884    */
 885   if (close (fd) == -1) {
 886     perrorf (g, "close: %s", filename);
 887     send_file_cancellation (g);
 888     return -1;
 889   }
 890
 891   return send_file_complete (g);
 892 }
 893
 894 /* Send a chunk of file data. */
 895 static int
 896 send_file_data (guestfs_h *g, const char *buf, size_t len)
 897 {
 898   return send_file_chunk (g, 0, buf, len);
 899 }
 900
 901 /* Send a cancellation message. */
 902 static int
 903 send_file_cancellation (guestfs_h *g)
 904 {
 905   return send_file_chunk (g, 1, NULL, 0);
 906 }
 907
 908 /* Send a file complete chunk. */
 909 static int
 910 send_file_complete (guestfs_h *g)
 911 {
 912   char buf[1];
 913   return send_file_chunk (g, 0, buf, 0);
 914 }
 915
 916 static int
 917 send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t buflen)
 918 {
 919   u_int32_t len;
 920   int r;
 921   guestfs_chunk chunk;
 922   XDR xdr;
 923   char *msg_out;
 924   size_t msg_out_size;
 925
 926   if (g->state != BUSY) {
 927     error (g, _("send_file_chunk: state %d != READY"), g->state);
 928     return -1;
 929   }
 930
 931   /* Allocate the chunk buffer.  Don't use the stack to avoid
 932    * excessive stack usage and unnecessary copies.
 933    */
 934   msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
 935   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
 936
 937   /* Serialize the chunk. */
 938   chunk.cancel = cancel;
 939   chunk.data.data_len = buflen;
 940   chunk.data.data_val = (char *) buf;
 941
 942   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
 943     error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
 944            buf, buflen);
 945     xdr_destroy (&xdr);
 946     goto cleanup1;
 947   }
 948
 949   len = xdr_getpos (&xdr);
 950   xdr_destroy (&xdr);
 951
 952   /* Reduce the size of the outgoing message buffer to the real length. */
 953   msg_out = safe_realloc (g, msg_out, len + 4);
 954   msg_out_size = len + 4;
 955
 956   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
 957   xdr_uint32_t (&xdr, &len);
 958
 959   r = guestfs___send_to_daemon (g, msg_out, msg_out_size);
 960
 961   /* Did the daemon send a cancellation message? */
 962   if (r == -2) {
 963     debug (g, "got daemon cancellation");
 964     return -2;
 965   }
 966
 967   if (r == -1)
 968     goto cleanup1;
 969
 970   free (msg_out);
 971
 972   return 0;
 973
 974  cleanup1:
 975   free (msg_out);
 976   return -1;
 977 }
 978
 979 /* Receive a reply. */
 980 int
 981 guestfs___recv (guestfs_h *g, const char *fn,
 982                 guestfs_message_header *hdr,
 983                 guestfs_message_error *err,
 984                 xdrproc_t xdrp, char *ret)
 985 {
 986   XDR xdr;
 987   void *buf;
 988   uint32_t size;
 989   int r;
 990
 991  again:
 992   r = guestfs___recv_from_daemon (g, &size, &buf);
 993   if (r == -1)
 994     return -1;
 995
 996   /* This can happen if a cancellation happens right at the end
 997    * of us sending a FileIn parameter to the daemon.  Discard.  The
 998    * daemon should send us an error message next.
 999    */
1000   if (size == GUESTFS_CANCEL_FLAG)
1001     goto again;
1002
1003   if (size == GUESTFS_LAUNCH_FLAG) {
1004     error (g, "%s: received unexpected launch flag from daemon when expecting reply", fn);
1005     return -1;
1006   }
1007
1008   xdrmem_create (&xdr, buf, size, XDR_DECODE);
1009
1010   if (!xdr_guestfs_message_header (&xdr, hdr)) {
1011     error (g, "%s: failed to parse reply header", fn);
1012     xdr_destroy (&xdr);
1013     free (buf);
1014     return -1;
1015   }
1016   if (hdr->status == GUESTFS_STATUS_ERROR) {
1017     if (!xdr_guestfs_message_error (&xdr, err)) {
1018       error (g, "%s: failed to parse reply error", fn);
1019       xdr_destroy (&xdr);
1020       free (buf);
1021       return -1;
1022     }
1023   } else {
1024     if (xdrp && ret && !xdrp (&xdr, ret)) {
1025       error (g, "%s: failed to parse reply", fn);
1026       xdr_destroy (&xdr);
1027       free (buf);
1028       return -1;
1029     }
1030   }
1031   xdr_destroy (&xdr);
1032   free (buf);
1033
1034   return 0;
1035 }
1036
1037 /* Receive a file. */
1038
1039 /* Returns -1 = error, 0 = EOF, > 0 = more data */
1040 static ssize_t receive_file_data (guestfs_h *g, void **buf);
1041
1042 int
1043 guestfs___recv_file (guestfs_h *g, const char *filename)
1044 {
1045   void *buf;
1046   int fd, r;
1047
1048   fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
1049   if (fd == -1) {
1050     perrorf (g, "open: %s", filename);
1051     goto cancel;
1052   }
1053
1054   /* Receive the file in chunked encoding. */
1055   while ((r = receive_file_data (g, &buf)) > 0) {
1056     if (xwrite (fd, buf, r) == -1) {
1057       perrorf (g, "%s: write", filename);
1058       free (buf);
1059       goto cancel;
1060     }
1061     free (buf);
1062   }
1063
1064   if (r == -1) {
1065     error (g, _("%s: error in chunked encoding"), filename);
1066     return -1;
1067   }
1068
1069   if (close (fd) == -1) {
1070     perrorf (g, "close: %s", filename);
1071     return -1;
1072   }
1073
1074   return 0;
1075
1076  cancel: ;
1077   /* Send cancellation message to daemon, then wait until it
1078    * cancels (just throwing away data).
1079    */
1080   XDR xdr;
1081   char fbuf[4];
1082   uint32_t flag = GUESTFS_CANCEL_FLAG;
1083
1084   debug (g, "%s: waiting for daemon to acknowledge cancellation",
1085          __func__);
1086
1087   xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
1088   xdr_uint32_t (&xdr, &flag);
1089   xdr_destroy (&xdr);
1090
1091   if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
1092     perrorf (g, _("write to daemon socket"));
1093     return -1;
1094   }
1095
1096   while (receive_file_data (g, NULL) > 0)
1097     ;                           /* just discard it */
1098
1099   return -1;
1100 }
1101
1102 /* Receive a chunk of file data. */
1103 /* Returns -1 = error, 0 = EOF, > 0 = more data */
1104 static ssize_t
1105 receive_file_data (guestfs_h *g, void **buf_r)
1106 {
1107   int r;
1108   void *buf;
1109   uint32_t len;
1110   XDR xdr;
1111   guestfs_chunk chunk;
1112
1113   r = guestfs___recv_from_daemon (g, &len, &buf);
1114   if (r == -1) {
1115     error (g, _("receive_file_data: parse error in reply callback"));
1116     return -1;
1117   }
1118
1119   if (len == GUESTFS_LAUNCH_FLAG || len == GUESTFS_CANCEL_FLAG) {
1120     error (g, _("receive_file_data: unexpected flag received when reading file chunks"));
1121     return -1;
1122   }
1123
1124   memset (&chunk, 0, sizeof chunk);
1125
1126   xdrmem_create (&xdr, buf, len, XDR_DECODE);
1127   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
1128     error (g, _("failed to parse file chunk"));
1129     free (buf);
1130     return -1;
1131   }
1132   xdr_destroy (&xdr);
1133   /* After decoding, the original buffer is no longer used. */
1134   free (buf);
1135
1136   if (chunk.cancel) {
1137     error (g, _("file receive cancelled by daemon"));
1138     free (chunk.data.data_val);
1139     return -1;
1140   }
1141
1142   if (chunk.data.data_len == 0) { /* end of transfer */
1143     free (chunk.data.data_val);
1144     return 0;
1145   }
1146
1147   if (buf_r) *buf_r = chunk.data.data_val;
1148   else free (chunk.data.data_val); /* else caller frees */
1149
1150   return chunk.data.data_len;
1151 }