ec7473ea55e509eb037e64ae66af1734fe00a90b
[libguestfs.git] / 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
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stdarg.h>
26 #include <stddef.h>
27 #include <unistd.h>
28 #include <ctype.h>
29 #include <string.h>
30 #include <fcntl.h>
31 #include <time.h>
32 #include <sys/stat.h>
33 #include <sys/select.h>
34 #include <dirent.h>
35
36 #include <rpc/types.h>
37 #include <rpc/xdr.h>
38
39 #ifdef HAVE_ERRNO_H
40 #include <errno.h>
41 #endif
42
43 #ifdef HAVE_SYS_TYPES_H
44 #include <sys/types.h>
45 #endif
46
47 #ifdef HAVE_SYS_WAIT_H
48 #include <sys/wait.h>
49 #endif
50
51 #ifdef HAVE_SYS_SOCKET_H
52 #include <sys/socket.h>
53 #endif
54
55 #ifdef HAVE_SYS_UN_H
56 #include <sys/un.h>
57 #endif
58
59 #include "guestfs.h"
60 #include "guestfs-internal-actions.h"
61 #include "guestfs_protocol.h"
62 #include "ignore-value.h"
63
64 #ifdef HAVE_GETTEXT
65 #include "gettext.h"
66 #define _(str) dgettext(PACKAGE, (str))
67 //#define N_(str) dgettext(PACKAGE, (str))
68 #else
69 #define _(str) str
70 //#define N_(str) str
71 #endif
72
73 #define error guestfs_error
74 #define perrorf guestfs_perrorf
75 #define safe_malloc guestfs_safe_malloc
76 #define safe_realloc guestfs_safe_realloc
77 #define safe_strdup guestfs_safe_strdup
78 //#define safe_memdup guestfs_safe_memdup
79
80 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
81 static int send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
82 static int recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
83 static void close_handles (void);
84
85 #define UNIX_PATH_MAX 108
86
87 /* Also in guestfsd.c */
88 #define GUESTFWD_ADDR "10.0.2.4"
89 #define GUESTFWD_PORT "6666"
90
91 /* GuestFS handle and connection. */
92 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
93
94 struct guestfs_h
95 {
96   struct guestfs_h *next;       /* Linked list of open handles. */
97
98   /* State: see the state machine diagram in the man page guestfs(3). */
99   enum state state;
100
101   int fd[2];                    /* Stdin/stdout of qemu. */
102   int sock;                     /* Daemon communications socket. */
103   pid_t pid;                    /* Qemu PID. */
104   pid_t recoverypid;            /* Recovery process PID. */
105   time_t start_t;               /* The time when we started qemu. */
106
107   char *tmpdir;                 /* Temporary directory containing socket. */
108
109   char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
110
111   char **cmdline;               /* Qemu command line. */
112   int cmdline_size;
113
114   int verbose;
115   int trace;
116   int autosync;
117
118   char *path;                   /* Path to kernel, initrd. */
119   char *qemu;                   /* Qemu binary. */
120   char *append;                 /* Append to kernel command line. */
121
122   int memsize;                  /* Size of RAM (megabytes). */
123
124   int selinux;                  /* selinux enabled? */
125
126   char *last_error;
127
128   /* Callbacks. */
129   guestfs_abort_cb           abort_cb;
130   guestfs_error_handler_cb   error_cb;
131   void *                     error_cb_data;
132   guestfs_log_message_cb     log_message_cb;
133   void *                     log_message_cb_data;
134   guestfs_subprocess_quit_cb subprocess_quit_cb;
135   void *                     subprocess_quit_cb_data;
136   guestfs_launch_done_cb     launch_done_cb;
137   void *                     launch_done_cb_data;
138
139   int msg_next_serial;
140 };
141
142 static guestfs_h *handles = NULL;
143 static int atexit_handler_set = 0;
144
145 guestfs_h *
146 guestfs_create (void)
147 {
148   guestfs_h *g;
149   const char *str;
150
151   g = malloc (sizeof (*g));
152   if (!g) return NULL;
153
154   memset (g, 0, sizeof (*g));
155
156   g->state = CONFIG;
157
158   g->fd[0] = -1;
159   g->fd[1] = -1;
160   g->sock = -1;
161
162   g->abort_cb = abort;
163   g->error_cb = default_error_cb;
164   g->error_cb_data = NULL;
165
166   str = getenv ("LIBGUESTFS_DEBUG");
167   g->verbose = str != NULL && strcmp (str, "1") == 0;
168
169   str = getenv ("LIBGUESTFS_TRACE");
170   g->trace = str != NULL && strcmp (str, "1") == 0;
171
172   str = getenv ("LIBGUESTFS_PATH");
173   g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
174   if (!g->path) goto error;
175
176   str = getenv ("LIBGUESTFS_QEMU");
177   g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
178   if (!g->qemu) goto error;
179
180   str = getenv ("LIBGUESTFS_APPEND");
181   if (str) {
182     g->append = strdup (str);
183     if (!g->append) goto error;
184   }
185
186   /* Choose a suitable memory size.  Previously we tried to choose
187    * a minimal memory size, but this isn't really necessary since
188    * recent QEMU and KVM don't do anything nasty like locking
189    * memory into core any more.  Thus we can safely choose a
190    * large, generous amount of memory, and it'll just get swapped
191    * on smaller systems.
192    */
193   str = getenv ("LIBGUESTFS_MEMSIZE");
194   if (str) {
195     if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
196       fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
197       goto error;
198     }
199   } else
200     g->memsize = 500;
201
202   /* Start with large serial numbers so they are easy to spot
203    * inside the protocol.
204    */
205   g->msg_next_serial = 0x00123400;
206
207   /* Link the handles onto a global list.  This is the one area
208    * where the library needs to be made thread-safe. (XXX)
209    */
210   /* acquire mutex (XXX) */
211   g->next = handles;
212   handles = g;
213   if (!atexit_handler_set) {
214     atexit (close_handles);
215     atexit_handler_set = 1;
216   }
217   /* release mutex (XXX) */
218
219   if (g->verbose)
220     fprintf (stderr, "new guestfs handle %p\n", g);
221
222   return g;
223
224  error:
225   free (g->path);
226   free (g->qemu);
227   free (g->append);
228   free (g);
229   return NULL;
230 }
231
232 void
233 guestfs_close (guestfs_h *g)
234 {
235   int i;
236   char filename[256];
237   guestfs_h *gg;
238
239   if (g->state == NO_HANDLE) {
240     /* Not safe to call 'error' here, so ... */
241     fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
242     return;
243   }
244
245   if (g->verbose)
246     fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
247
248   /* Try to sync if autosync flag is set. */
249   if (g->autosync && g->state == READY) {
250     guestfs_umount_all (g);
251     guestfs_sync (g);
252   }
253
254   /* Remove any handlers that might be called back before we kill the
255    * subprocess.
256    */
257   g->log_message_cb = NULL;
258
259   if (g->state != CONFIG)
260     guestfs_kill_subprocess (g);
261
262   /* Close sockets. */
263   if (g->fd[0] >= 0)
264     close (g->fd[0]);
265   if (g->fd[1] >= 0)
266     close (g->fd[1]);
267   if (g->sock >= 0)
268     close (g->sock);
269   g->fd[0] = -1;
270   g->fd[1] = -1;
271   g->sock = -1;
272
273   /* Wait for subprocess(es) to exit. */
274   waitpid (g->pid, NULL, 0);
275   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
276
277   /* Remove tmpfiles. */
278   if (g->tmpdir) {
279     snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
280     unlink (filename);
281
282     snprintf (filename, sizeof filename, "%s/initrd", g->tmpdir);
283     unlink (filename);
284
285     snprintf (filename, sizeof filename, "%s/kernel", g->tmpdir);
286     unlink (filename);
287
288     rmdir (g->tmpdir);
289
290     free (g->tmpdir);
291   }
292
293   if (g->cmdline) {
294     for (i = 0; i < g->cmdline_size; ++i)
295       free (g->cmdline[i]);
296     free (g->cmdline);
297   }
298
299   /* Mark the handle as dead before freeing it. */
300   g->state = NO_HANDLE;
301
302   /* acquire mutex (XXX) */
303   if (handles == g)
304     handles = g->next;
305   else {
306     for (gg = handles; gg->next != g; gg = gg->next)
307       ;
308     gg->next = g->next;
309   }
310   /* release mutex (XXX) */
311
312   free (g->last_error);
313   free (g->path);
314   free (g->qemu);
315   free (g->append);
316   free (g->qemu_help);
317   free (g->qemu_version);
318   free (g);
319 }
320
321 /* Close all open handles (called from atexit(3)). */
322 static void
323 close_handles (void)
324 {
325   while (handles) guestfs_close (handles);
326 }
327
328 const char *
329 guestfs_last_error (guestfs_h *g)
330 {
331   return g->last_error;
332 }
333
334 static void
335 set_last_error (guestfs_h *g, const char *msg)
336 {
337   free (g->last_error);
338   g->last_error = strdup (msg);
339 }
340
341 static void
342 default_error_cb (guestfs_h *g, void *data, const char *msg)
343 {
344   fprintf (stderr, _("libguestfs: error: %s\n"), msg);
345 }
346
347 void
348 guestfs_error (guestfs_h *g, const char *fs, ...)
349 {
350   va_list args;
351   char *msg;
352
353   va_start (args, fs);
354   int err = vasprintf (&msg, fs, args);
355   va_end (args);
356
357   if (err < 0) return;
358
359   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
360   set_last_error (g, msg);
361
362   free (msg);
363 }
364
365 void
366 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
367 {
368   va_list args;
369   char *msg;
370   int errnum = errno;
371
372   va_start (args, fs);
373   int err = vasprintf (&msg, fs, args);
374   va_end (args);
375
376   if (err < 0) return;
377
378 #ifndef _GNU_SOURCE
379   char buf[256];
380   strerror_r (errnum, buf, sizeof buf);
381 #else
382   char _buf[256];
383   char *buf;
384   buf = strerror_r (errnum, _buf, sizeof _buf);
385 #endif
386
387   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
388   strcat (msg, ": ");
389   strcat (msg, buf);
390
391   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
392   set_last_error (g, msg);
393
394   free (msg);
395 }
396
397 void *
398 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
399 {
400   void *ptr = malloc (nbytes);
401   if (nbytes > 0 && !ptr) g->abort_cb ();
402   return ptr;
403 }
404
405 /* Return 1 if an array of N objects, each of size S, cannot exist due
406    to size arithmetic overflow.  S must be positive and N must be
407    nonnegative.  This is a macro, not an inline function, so that it
408    works correctly even when SIZE_MAX < N.
409
410    By gnulib convention, SIZE_MAX represents overflow in size
411    calculations, so the conservative dividend to use here is
412    SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
413    However, malloc (SIZE_MAX) fails on all known hosts where
414    sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
415    exactly-SIZE_MAX allocations on such hosts; this avoids a test and
416    branch when S is known to be 1.  */
417 # define xalloc_oversized(n, s) \
418     ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
419
420 /* Technically we should add an autoconf test for this, testing for the desired
421    functionality, like what's done in gnulib, but for now, this is fine.  */
422 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
423
424 /* Allocate zeroed memory for N elements of S bytes, with error
425    checking.  S must be nonzero.  */
426 void *
427 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
428 {
429   /* From gnulib's calloc function in xmalloc.c.  */
430   void *p;
431   /* Test for overflow, since some calloc implementations don't have
432      proper overflow checks.  But omit overflow and size-zero tests if
433      HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
434      returns NULL if successful.  */
435   if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
436       || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
437     g->abort_cb ();
438   return p;
439 }
440
441 void *
442 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
443 {
444   void *p = realloc (ptr, nbytes);
445   if (nbytes > 0 && !p) g->abort_cb ();
446   return p;
447 }
448
449 char *
450 guestfs_safe_strdup (guestfs_h *g, const char *str)
451 {
452   char *s = strdup (str);
453   if (!s) g->abort_cb ();
454   return s;
455 }
456
457 void *
458 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
459 {
460   void *p = malloc (size);
461   if (!p) g->abort_cb ();
462   memcpy (p, ptr, size);
463   return p;
464 }
465
466 static int
467 xwrite (int fd, const void *v_buf, size_t len)
468 {
469   const char *buf = v_buf;
470   int r;
471
472   while (len > 0) {
473     r = write (fd, buf, len);
474     if (r == -1)
475       return -1;
476
477     buf += r;
478     len -= r;
479   }
480
481   return 0;
482 }
483
484 void
485 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
486 {
487   g->abort_cb = cb;
488 }
489
490 guestfs_abort_cb
491 guestfs_get_out_of_memory_handler (guestfs_h *g)
492 {
493   return g->abort_cb;
494 }
495
496 void
497 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
498 {
499   g->error_cb = cb;
500   g->error_cb_data = data;
501 }
502
503 guestfs_error_handler_cb
504 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
505 {
506   if (data_rtn) *data_rtn = g->error_cb_data;
507   return g->error_cb;
508 }
509
510 int
511 guestfs__set_verbose (guestfs_h *g, int v)
512 {
513   g->verbose = !!v;
514   return 0;
515 }
516
517 int
518 guestfs__get_verbose (guestfs_h *g)
519 {
520   return g->verbose;
521 }
522
523 int
524 guestfs__set_autosync (guestfs_h *g, int a)
525 {
526   g->autosync = !!a;
527   return 0;
528 }
529
530 int
531 guestfs__get_autosync (guestfs_h *g)
532 {
533   return g->autosync;
534 }
535
536 int
537 guestfs__set_path (guestfs_h *g, const char *path)
538 {
539   free (g->path);
540   g->path = NULL;
541
542   g->path =
543     path == NULL ?
544     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
545   return 0;
546 }
547
548 const char *
549 guestfs__get_path (guestfs_h *g)
550 {
551   return g->path;
552 }
553
554 int
555 guestfs__set_qemu (guestfs_h *g, const char *qemu)
556 {
557   free (g->qemu);
558   g->qemu = NULL;
559
560   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
561   return 0;
562 }
563
564 const char *
565 guestfs__get_qemu (guestfs_h *g)
566 {
567   return g->qemu;
568 }
569
570 int
571 guestfs__set_append (guestfs_h *g, const char *append)
572 {
573   free (g->append);
574   g->append = NULL;
575
576   g->append = append ? safe_strdup (g, append) : NULL;
577   return 0;
578 }
579
580 const char *
581 guestfs__get_append (guestfs_h *g)
582 {
583   return g->append;
584 }
585
586 int
587 guestfs__set_memsize (guestfs_h *g, int memsize)
588 {
589   g->memsize = memsize;
590   return 0;
591 }
592
593 int
594 guestfs__get_memsize (guestfs_h *g)
595 {
596   return g->memsize;
597 }
598
599 int
600 guestfs__set_selinux (guestfs_h *g, int selinux)
601 {
602   g->selinux = selinux;
603   return 0;
604 }
605
606 int
607 guestfs__get_selinux (guestfs_h *g)
608 {
609   return g->selinux;
610 }
611
612 int
613 guestfs__get_pid (guestfs_h *g)
614 {
615   if (g->pid > 0)
616     return g->pid;
617   else {
618     error (g, "get_pid: no qemu subprocess");
619     return -1;
620   }
621 }
622
623 struct guestfs_version *
624 guestfs__version (guestfs_h *g)
625 {
626   struct guestfs_version *r;
627
628   r = safe_malloc (g, sizeof *r);
629   r->major = PACKAGE_VERSION_MAJOR;
630   r->minor = PACKAGE_VERSION_MINOR;
631   r->release = PACKAGE_VERSION_RELEASE;
632   r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
633   return r;
634 }
635
636 int
637 guestfs__set_trace (guestfs_h *g, int t)
638 {
639   g->trace = !!t;
640   return 0;
641 }
642
643 int
644 guestfs__get_trace (guestfs_h *g)
645 {
646   return g->trace;
647 }
648
649 /* Add a string to the current command line. */
650 static void
651 incr_cmdline_size (guestfs_h *g)
652 {
653   if (g->cmdline == NULL) {
654     /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
655     g->cmdline_size = 1;
656     g->cmdline = safe_malloc (g, sizeof (char *));
657     g->cmdline[0] = NULL;
658   }
659
660   g->cmdline_size++;
661   g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
662 }
663
664 static int
665 add_cmdline (guestfs_h *g, const char *str)
666 {
667   if (g->state != CONFIG) {
668     error (g,
669         _("command line cannot be altered after qemu subprocess launched"));
670     return -1;
671   }
672
673   incr_cmdline_size (g);
674   g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
675   return 0;
676 }
677
678 int
679 guestfs__config (guestfs_h *g,
680                  const char *qemu_param, const char *qemu_value)
681 {
682   if (qemu_param[0] != '-') {
683     error (g, _("guestfs_config: parameter must begin with '-' character"));
684     return -1;
685   }
686
687   /* A bit fascist, but the user will probably break the extra
688    * parameters that we add if they try to set any of these.
689    */
690   if (strcmp (qemu_param, "-kernel") == 0 ||
691       strcmp (qemu_param, "-initrd") == 0 ||
692       strcmp (qemu_param, "-nographic") == 0 ||
693       strcmp (qemu_param, "-serial") == 0 ||
694       strcmp (qemu_param, "-full-screen") == 0 ||
695       strcmp (qemu_param, "-std-vga") == 0 ||
696       strcmp (qemu_param, "-vnc") == 0) {
697     error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
698     return -1;
699   }
700
701   if (add_cmdline (g, qemu_param) != 0) return -1;
702
703   if (qemu_value != NULL) {
704     if (add_cmdline (g, qemu_value) != 0) return -1;
705   }
706
707   return 0;
708 }
709
710 int
711 guestfs__add_drive (guestfs_h *g, const char *filename)
712 {
713   size_t len = strlen (filename) + 64;
714   char buf[len];
715
716   if (strchr (filename, ',') != NULL) {
717     error (g, _("filename cannot contain ',' (comma) character"));
718     return -1;
719   }
720
721   /* cache=off improves reliability in the event of a host crash.
722    *
723    * However this option causes qemu to try to open the file with
724    * O_DIRECT.  This fails on some filesystem types (notably tmpfs).
725    * So we check if we can open the file with or without O_DIRECT,
726    * and use cache=off (or not) accordingly.
727    *
728    * This test also checks for the presence of the file, which
729    * is a documented semantic of this interface.
730    */
731   int fd = open (filename, O_RDONLY|O_DIRECT);
732   if (fd >= 0) {
733     close (fd);
734     snprintf (buf, len, "file=%s,cache=off,if=" DRIVE_IF, filename);
735   } else {
736     fd = open (filename, O_RDONLY);
737     if (fd >= 0) {
738       close (fd);
739       snprintf (buf, len, "file=%s,if=" DRIVE_IF, filename);
740     } else {
741       perrorf (g, "%s", filename);
742       return -1;
743     }
744   }
745
746   return guestfs__config (g, "-drive", buf);
747 }
748
749 int
750 guestfs__add_drive_ro (guestfs_h *g, const char *filename)
751 {
752   size_t len = strlen (filename) + 64;
753   char buf[len];
754
755   if (strchr (filename, ',') != NULL) {
756     error (g, _("filename cannot contain ',' (comma) character"));
757     return -1;
758   }
759
760   if (access (filename, F_OK) == -1) {
761     perrorf (g, "%s", filename);
762     return -1;
763   }
764
765   snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, DRIVE_IF);
766
767   return guestfs__config (g, "-drive", buf);
768 }
769
770 int
771 guestfs__add_cdrom (guestfs_h *g, const char *filename)
772 {
773   if (strchr (filename, ',') != NULL) {
774     error (g, _("filename cannot contain ',' (comma) character"));
775     return -1;
776   }
777
778   if (access (filename, F_OK) == -1) {
779     perrorf (g, "%s", filename);
780     return -1;
781   }
782
783   return guestfs__config (g, "-cdrom", filename);
784 }
785
786 /* Returns true iff file is contained in dir. */
787 static int
788 dir_contains_file (const char *dir, const char *file)
789 {
790   int dirlen = strlen (dir);
791   int filelen = strlen (file);
792   int len = dirlen+filelen+2;
793   char path[len];
794
795   snprintf (path, len, "%s/%s", dir, file);
796   return access (path, F_OK) == 0;
797 }
798
799 /* Returns true iff every listed file is contained in 'dir'. */
800 static int
801 dir_contains_files (const char *dir, ...)
802 {
803   va_list args;
804   const char *file;
805
806   va_start (args, dir);
807   while ((file = va_arg (args, const char *)) != NULL) {
808     if (!dir_contains_file (dir, file)) {
809       va_end (args);
810       return 0;
811     }
812   }
813   va_end (args);
814   return 1;
815 }
816
817 static int build_supermin_appliance (guestfs_h *g, const char *path, char **kernel, char **initrd);
818 static int test_qemu (guestfs_h *g);
819 static int qemu_supports (guestfs_h *g, const char *option);
820 static void print_cmdline (guestfs_h *g);
821
822 static const char *kernel_name = "vmlinuz." REPO "." host_cpu;
823 static const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
824 static const char *supermin_name =
825   "initramfs." REPO "." host_cpu ".supermin.img";
826 static const char *supermin_hostfiles_name =
827   "initramfs." REPO "." host_cpu ".supermin.hostfiles";
828
829 int
830 guestfs__launch (guestfs_h *g)
831 {
832   const char *tmpdir;
833   char dir_template[PATH_MAX];
834   int r, pmore;
835   size_t len;
836   int wfd[2], rfd[2];
837   int tries;
838   char *path, *pelem, *pend;
839   char *kernel = NULL, *initrd = NULL;
840   char unixsock[256];
841   struct sockaddr_un addr;
842
843 #ifdef P_tmpdir
844   tmpdir = P_tmpdir;
845 #else
846   tmpdir = "/tmp";
847 #endif
848
849   tmpdir = getenv ("TMPDIR") ? : tmpdir;
850   snprintf (dir_template, sizeof dir_template, "%s/libguestfsXXXXXX", tmpdir);
851
852   /* Configured? */
853   if (!g->cmdline) {
854     error (g, _("you must call guestfs_add_drive before guestfs_launch"));
855     return -1;
856   }
857
858   if (g->state != CONFIG) {
859     error (g, _("qemu has already been launched"));
860     return -1;
861   }
862
863   /* Make the temporary directory. */
864   if (!g->tmpdir) {
865     g->tmpdir = safe_strdup (g, dir_template);
866     if (mkdtemp (g->tmpdir) == NULL) {
867       perrorf (g, _("%s: cannot create temporary directory"), dir_template);
868       goto cleanup0;
869     }
870   }
871
872   /* First search g->path for the supermin appliance, and try to
873    * synthesize a kernel and initrd from that.  If it fails, we
874    * try the path search again looking for a backup ordinary
875    * appliance.
876    */
877   pelem = path = safe_strdup (g, g->path);
878   do {
879     pend = strchrnul (pelem, ':');
880     pmore = *pend == ':';
881     *pend = '\0';
882     len = pend - pelem;
883
884     /* Empty element of "." means cwd. */
885     if (len == 0 || (len == 1 && *pelem == '.')) {
886       if (g->verbose)
887         fprintf (stderr,
888                  "looking for supermin appliance in current directory\n");
889       if (dir_contains_files (".",
890                               supermin_name, supermin_hostfiles_name,
891                               "kmod.whitelist", NULL)) {
892         if (build_supermin_appliance (g, ".", &kernel, &initrd) == -1)
893           return -1;
894         break;
895       }
896     }
897     /* Look at <path>/supermin* etc. */
898     else {
899       if (g->verbose)
900         fprintf (stderr, "looking for supermin appliance in %s\n", pelem);
901
902       if (dir_contains_files (pelem,
903                               supermin_name, supermin_hostfiles_name,
904                               "kmod.whitelist", NULL)) {
905         if (build_supermin_appliance (g, pelem, &kernel, &initrd) == -1)
906           return -1;
907         break;
908       }
909     }
910
911     pelem = pend + 1;
912   } while (pmore);
913
914   free (path);
915
916   if (kernel == NULL || initrd == NULL) {
917     /* Search g->path for the kernel and initrd. */
918     pelem = path = safe_strdup (g, g->path);
919     do {
920       pend = strchrnul (pelem, ':');
921       pmore = *pend == ':';
922       *pend = '\0';
923       len = pend - pelem;
924
925       /* Empty element or "." means cwd. */
926       if (len == 0 || (len == 1 && *pelem == '.')) {
927         if (g->verbose)
928           fprintf (stderr,
929                    "looking for appliance in current directory\n");
930         if (dir_contains_files (".", kernel_name, initrd_name, NULL)) {
931           kernel = safe_strdup (g, kernel_name);
932           initrd = safe_strdup (g, initrd_name);
933           break;
934         }
935       }
936       /* Look at <path>/kernel etc. */
937       else {
938         if (g->verbose)
939           fprintf (stderr, "looking for appliance in %s\n", pelem);
940
941         if (dir_contains_files (pelem, kernel_name, initrd_name, NULL)) {
942           kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
943           initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
944           sprintf (kernel, "%s/%s", pelem, kernel_name);
945           sprintf (initrd, "%s/%s", pelem, initrd_name);
946           break;
947         }
948       }
949
950       pelem = pend + 1;
951     } while (pmore);
952
953     free (path);
954   }
955
956   if (kernel == NULL || initrd == NULL) {
957     error (g, _("cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)"),
958            kernel_name, initrd_name, g->path);
959     goto cleanup0;
960   }
961
962   /* Get qemu help text and version. */
963   if (test_qemu (g) == -1)
964     goto cleanup0;
965
966   /* Make the vmchannel socket. */
967   snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
968   unlink (unixsock);
969
970   if (pipe (wfd) == -1 || pipe (rfd) == -1) {
971     perrorf (g, "pipe");
972     goto cleanup0;
973   }
974
975   r = fork ();
976   if (r == -1) {
977     perrorf (g, "fork");
978     close (wfd[0]);
979     close (wfd[1]);
980     close (rfd[0]);
981     close (rfd[1]);
982     goto cleanup0;
983   }
984
985   if (r == 0) {                 /* Child (qemu). */
986     char buf[256];
987     const char *vmchannel = NULL;
988
989     /* Set up the full command line.  Do this in the subprocess so we
990      * don't need to worry about cleaning up.
991      */
992     g->cmdline[0] = g->qemu;
993
994     snprintf (buf, sizeof buf, "%d", g->memsize);
995     add_cmdline (g, "-m");
996     add_cmdline (g, buf);
997
998     add_cmdline (g, "-no-reboot"); /* Force exit instead of reboot on panic */
999     add_cmdline (g, "-nographic");
1000     add_cmdline (g, "-serial");
1001     add_cmdline (g, "stdio");
1002
1003     /* These options recommended by KVM developers to improve reliability. */
1004     if (qemu_supports (g, "-no-hpet"))
1005       add_cmdline (g, "-no-hpet");
1006
1007     if (qemu_supports (g, "-rtc-td-hack"))
1008       add_cmdline (g, "-rtc-td-hack");
1009
1010     if (qemu_supports (g, "-chardev") && qemu_supports (g, "guestfwd")) {
1011       /* New-style -net user,guestfwd=... syntax for guestfwd.  See:
1012        *
1013        * http://git.savannah.gnu.org/cgit/qemu.git/commit/?id=c92ef6a22d3c71538fcc48fb61ad353f7ba03b62
1014        *
1015        * The original suggested format doesn't work, see:
1016        *
1017        * http://lists.gnu.org/archive/html/qemu-devel/2009-07/msg01654.html
1018        *
1019        * However Gerd Hoffman privately suggested to me using -chardev
1020        * instead, which does work.
1021        */
1022       snprintf (buf, sizeof buf,
1023                 "socket,id=guestfsvmc,path=%s,server,nowait", unixsock);
1024
1025       add_cmdline (g, "-chardev");
1026       add_cmdline (g, buf);
1027
1028       snprintf (buf, sizeof buf,
1029                 "user,vlan=0,net=10.0.2.0/8,"
1030                 "guestfwd=tcp:" GUESTFWD_ADDR ":" GUESTFWD_PORT
1031                 "-chardev:guestfsvmc");
1032
1033       add_cmdline (g, "-net");
1034       add_cmdline (g, buf);
1035     } else {
1036       /* Not guestfwd.  HOPEFULLY this qemu uses the older -net channel
1037        * syntax, or if not then we'll get a quick failure.
1038        */
1039       snprintf (buf, sizeof buf,
1040                 "channel," GUESTFWD_PORT ":unix:%s,server,nowait", unixsock);
1041
1042       add_cmdline (g, "-net");
1043       add_cmdline (g, buf);
1044       add_cmdline (g, "-net");
1045       add_cmdline (g, "user,vlan=0,net=10.0.2.0/8");
1046     }
1047     add_cmdline (g, "-net");
1048     add_cmdline (g, "nic,model=" NET_IF ",vlan=0");
1049     vmchannel = "guestfs_vmchannel=tcp:" GUESTFWD_ADDR ":" GUESTFWD_PORT " ";
1050
1051 #define LINUX_CMDLINE                                                   \
1052     "panic=1 "         /* force kernel to panic if daemon exits */      \
1053     "console=ttyS0 "   /* serial console */                             \
1054     "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */   \
1055     "noapic "          /* workaround for RHBZ#502058 - ok if not SMP */ \
1056     "acpi=off "        /* we don't need ACPI, turn it off */            \
1057     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
1058
1059     /* Linux kernel command line. */
1060     snprintf (buf, sizeof buf,
1061               LINUX_CMDLINE
1062               "%s"              /* (selinux) */
1063               "%s"              /* (vmchannel) */
1064               "%s"              /* (verbose) */
1065               "%s",             /* (append) */
1066               g->selinux ? "selinux=1 enforcing=0 " : "selinux=0 ",
1067               vmchannel ? vmchannel : "",
1068               g->verbose ? "guestfs_verbose=1 " : "",
1069               g->append ? g->append : "");
1070
1071     add_cmdline (g, "-kernel");
1072     add_cmdline (g, (char *) kernel);
1073     add_cmdline (g, "-initrd");
1074     add_cmdline (g, (char *) initrd);
1075     add_cmdline (g, "-append");
1076     add_cmdline (g, buf);
1077
1078     /* Finish off the command line. */
1079     incr_cmdline_size (g);
1080     g->cmdline[g->cmdline_size-1] = NULL;
1081
1082     if (g->verbose)
1083       print_cmdline (g);
1084
1085     /* Set up stdin, stdout. */
1086     close (0);
1087     close (1);
1088     close (wfd[1]);
1089     close (rfd[0]);
1090
1091     if (dup (wfd[0]) == -1) {
1092     dup_failed:
1093       perror ("dup failed");
1094       _exit (1);
1095     }
1096     if (dup (rfd[1]) == -1)
1097       goto dup_failed;
1098
1099     close (wfd[0]);
1100     close (rfd[1]);
1101
1102 #if 0
1103     /* Set up a new process group, so we can signal this process
1104      * and all subprocesses (eg. if qemu is really a shell script).
1105      */
1106     setpgid (0, 0);
1107 #endif
1108
1109     execv (g->qemu, g->cmdline); /* Run qemu. */
1110     perror (g->qemu);
1111     _exit (1);
1112   }
1113
1114   /* Parent (library). */
1115   g->pid = r;
1116
1117   free (kernel);
1118   kernel = NULL;
1119   free (initrd);
1120   initrd = NULL;
1121
1122   /* Fork the recovery process off which will kill qemu if the parent
1123    * process fails to do so (eg. if the parent segfaults).
1124    */
1125   r = fork ();
1126   if (r == 0) {
1127     pid_t qemu_pid = g->pid;
1128     pid_t parent_pid = getppid ();
1129
1130     /* Writing to argv is hideously complicated and error prone.  See:
1131      * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
1132      */
1133
1134     /* Loop around waiting for one or both of the other processes to
1135      * disappear.  It's fair to say this is very hairy.  The PIDs that
1136      * we are looking at might be reused by another process.  We are
1137      * effectively polling.  Is the cure worse than the disease?
1138      */
1139     for (;;) {
1140       if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
1141         _exit (0);
1142       if (kill (parent_pid, 0) == -1) {
1143         /* Parent's gone away, qemu still around, so kill qemu. */
1144         kill (qemu_pid, 9);
1145         _exit (0);
1146       }
1147       sleep (2);
1148     }
1149   }
1150
1151   /* Don't worry, if the fork failed, this will be -1.  The recovery
1152    * process isn't essential.
1153    */
1154   g->recoverypid = r;
1155
1156   /* Start the clock ... */
1157   time (&g->start_t);
1158
1159   /* Close the other ends of the pipe. */
1160   close (wfd[0]);
1161   close (rfd[1]);
1162
1163   if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
1164       fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
1165     perrorf (g, "fcntl");
1166     goto cleanup1;
1167   }
1168
1169   g->fd[0] = wfd[1];            /* stdin of child */
1170   g->fd[1] = rfd[0];            /* stdout of child */
1171
1172   /* Open the Unix socket.  The vmchannel implementation that got
1173    * merged with qemu sucks in a number of ways.  Both ends do
1174    * connect(2), which means that no one knows what, if anything, is
1175    * connected to the other end, or if it becomes disconnected.  Even
1176    * worse, we have to wait some indeterminate time for qemu to create
1177    * the socket and connect to it (which happens very early in qemu's
1178    * start-up), so any code that uses vmchannel is inherently racy.
1179    * Hence this silly loop.
1180    */
1181   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
1182   if (g->sock == -1) {
1183     perrorf (g, "socket");
1184     goto cleanup1;
1185   }
1186
1187   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
1188     perrorf (g, "fcntl");
1189     goto cleanup2;
1190   }
1191
1192   addr.sun_family = AF_UNIX;
1193   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
1194   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
1195
1196   tries = 100;
1197   /* Always sleep at least once to give qemu a small chance to start up. */
1198   usleep (10000);
1199   while (tries > 0) {
1200     r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
1201     if ((r == -1 && errno == EINPROGRESS) || r == 0)
1202       goto connected;
1203
1204     if (errno != ENOENT)
1205       perrorf (g, "connect");
1206     tries--;
1207     usleep (100000);
1208   }
1209
1210   error (g, _("failed to connect to vmchannel socket"));
1211   goto cleanup2;
1212
1213  connected:
1214   g->state = LAUNCHING;
1215
1216   /* Wait for qemu to start and to connect back to us via vmchannel and
1217    * send the GUESTFS_LAUNCH_FLAG message.
1218    */
1219   uint32_t size;
1220   void *buf = NULL;
1221   r = recv_from_daemon (g, &size, &buf);
1222   free (buf);
1223
1224   if (r == -1) return -1;
1225
1226   if (size != GUESTFS_LAUNCH_FLAG) {
1227     error (g, _("guestfs_launch failed, see earlier error messages"));
1228     goto cleanup2;
1229   }
1230
1231   /* This is possible in some really strange situations, such as
1232    * guestfsd starts up OK but then qemu immediately exits.  Check for
1233    * it because the caller is probably expecting to be able to send
1234    * commands after this function returns.
1235    */
1236   if (g->state != READY) {
1237     error (g, _("qemu launched and contacted daemon, but state != READY"));
1238     goto cleanup2;
1239   }
1240
1241   return 0;
1242
1243  cleanup2:
1244   close (g->sock);
1245
1246  cleanup1:
1247   close (wfd[1]);
1248   close (rfd[0]);
1249   kill (g->pid, 9);
1250   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1251   waitpid (g->pid, NULL, 0);
1252   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1253   g->fd[0] = -1;
1254   g->fd[1] = -1;
1255   g->sock = -1;
1256   g->pid = 0;
1257   g->recoverypid = 0;
1258   g->start_t = 0;
1259
1260  cleanup0:
1261   free (kernel);
1262   free (initrd);
1263   return -1;
1264 }
1265
1266 /* This function is used to print the qemu command line before it gets
1267  * executed, when in verbose mode.
1268  */
1269 static void
1270 print_cmdline (guestfs_h *g)
1271 {
1272   int i = 0;
1273   int needs_quote;
1274
1275   while (g->cmdline[i]) {
1276     if (g->cmdline[i][0] == '-') /* -option starts a new line */
1277       fprintf (stderr, " \\\n   ");
1278
1279     if (i > 0) fputc (' ', stderr);
1280
1281     /* Does it need shell quoting?  This only deals with simple cases. */
1282     needs_quote = strcspn (g->cmdline[i], " ") != strlen (g->cmdline[i]);
1283
1284     if (needs_quote) fputc ('\'', stderr);
1285     fprintf (stderr, "%s", g->cmdline[i]);
1286     if (needs_quote) fputc ('\'', stderr);
1287     i++;
1288   }
1289
1290   fputc ('\n', stderr);
1291 }
1292
1293 /* This function does the hard work of building the supermin appliance
1294  * on the fly.  'path' is the directory containing the control files.
1295  * 'kernel' and 'initrd' are where we will return the names of the
1296  * kernel and initrd (only initrd is built).  The work is done by
1297  * an external script.  We just tell it where to put the result.
1298  */
1299 static int
1300 build_supermin_appliance (guestfs_h *g, const char *path,
1301                           char **kernel, char **initrd)
1302 {
1303   char cmd[4096];
1304   int r, len;
1305
1306   len = strlen (g->tmpdir);
1307   *kernel = safe_malloc (g, len + 8);
1308   snprintf (*kernel, len+8, "%s/kernel", g->tmpdir);
1309   *initrd = safe_malloc (g, len + 8);
1310   snprintf (*initrd, len+8, "%s/initrd", g->tmpdir);
1311
1312   snprintf (cmd, sizeof cmd,
1313             "PATH='%s':$PATH "
1314             "libguestfs-supermin-helper '%s' %s %s",
1315             path,
1316             path, *kernel, *initrd);
1317
1318   r = system (cmd);
1319   if (r == -1 || WEXITSTATUS(r) != 0) {
1320     error (g, _("external command failed: %s"), cmd);
1321     free (*kernel);
1322     free (*initrd);
1323     *kernel = *initrd = NULL;
1324     return -1;
1325   }
1326
1327   return 0;
1328 }
1329
1330 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1331
1332 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1333  * 'qemu -version' so we know what options this qemu supports and
1334  * the version.
1335  */
1336 static int
1337 test_qemu (guestfs_h *g)
1338 {
1339   char cmd[1024];
1340   FILE *fp;
1341
1342   free (g->qemu_help);
1343   free (g->qemu_version);
1344   g->qemu_help = NULL;
1345   g->qemu_version = NULL;
1346
1347   snprintf (cmd, sizeof cmd, "'%s' -help", g->qemu);
1348
1349   fp = popen (cmd, "r");
1350   /* qemu -help should always work (qemu -version OTOH wasn't
1351    * supported by qemu 0.9).  If this command doesn't work then it
1352    * probably indicates that the qemu binary is missing.
1353    */
1354   if (!fp) {
1355     /* XXX This error is never printed, even if the qemu binary
1356      * doesn't exist.  Why?
1357      */
1358   error:
1359     perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1360     return -1;
1361   }
1362
1363   if (read_all (g, fp, &g->qemu_help) == -1)
1364     goto error;
1365
1366   if (pclose (fp) == -1)
1367     goto error;
1368
1369   snprintf (cmd, sizeof cmd, "'%s' -version 2>/dev/null", g->qemu);
1370
1371   fp = popen (cmd, "r");
1372   if (fp) {
1373     /* Intentionally ignore errors. */
1374     read_all (g, fp, &g->qemu_version);
1375     pclose (fp);
1376   }
1377
1378   return 0;
1379 }
1380
1381 static int
1382 read_all (guestfs_h *g, FILE *fp, char **ret)
1383 {
1384   int r, n = 0;
1385   char *p;
1386
1387  again:
1388   if (feof (fp)) {
1389     *ret = safe_realloc (g, *ret, n + 1);
1390     (*ret)[n] = '\0';
1391     return n;
1392   }
1393
1394   *ret = safe_realloc (g, *ret, n + BUFSIZ);
1395   p = &(*ret)[n];
1396   r = fread (p, 1, BUFSIZ, fp);
1397   if (ferror (fp)) {
1398     perrorf (g, "read");
1399     return -1;
1400   }
1401   n += r;
1402   goto again;
1403 }
1404
1405 /* Test if option is supported by qemu command line (just by grepping
1406  * the help text).
1407  */
1408 static int
1409 qemu_supports (guestfs_h *g, const char *option)
1410 {
1411   return g->qemu_help && strstr (g->qemu_help, option) != NULL;
1412 }
1413
1414 /* You had to call this function after launch in versions <= 1.0.70,
1415  * but it is now a no-op.
1416  */
1417 int
1418 guestfs__wait_ready (guestfs_h *g)
1419 {
1420   if (g->state != READY)  {
1421     error (g, _("qemu has not been launched yet"));
1422     return -1;
1423   }
1424
1425   return 0;
1426 }
1427
1428 int
1429 guestfs__kill_subprocess (guestfs_h *g)
1430 {
1431   if (g->state == CONFIG) {
1432     error (g, _("no subprocess to kill"));
1433     return -1;
1434   }
1435
1436   if (g->verbose)
1437     fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
1438
1439   kill (g->pid, SIGTERM);
1440   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1441
1442   return 0;
1443 }
1444
1445 /* Access current state. */
1446 int
1447 guestfs__is_config (guestfs_h *g)
1448 {
1449   return g->state == CONFIG;
1450 }
1451
1452 int
1453 guestfs__is_launching (guestfs_h *g)
1454 {
1455   return g->state == LAUNCHING;
1456 }
1457
1458 int
1459 guestfs__is_ready (guestfs_h *g)
1460 {
1461   return g->state == READY;
1462 }
1463
1464 int
1465 guestfs__is_busy (guestfs_h *g)
1466 {
1467   return g->state == BUSY;
1468 }
1469
1470 int
1471 guestfs__get_state (guestfs_h *g)
1472 {
1473   return g->state;
1474 }
1475
1476 void
1477 guestfs_set_log_message_callback (guestfs_h *g,
1478                                   guestfs_log_message_cb cb, void *opaque)
1479 {
1480   g->log_message_cb = cb;
1481   g->log_message_cb_data = opaque;
1482 }
1483
1484 void
1485 guestfs_set_subprocess_quit_callback (guestfs_h *g,
1486                                       guestfs_subprocess_quit_cb cb, void *opaque)
1487 {
1488   g->subprocess_quit_cb = cb;
1489   g->subprocess_quit_cb_data = opaque;
1490 }
1491
1492 void
1493 guestfs_set_launch_done_callback (guestfs_h *g,
1494                                   guestfs_launch_done_cb cb, void *opaque)
1495 {
1496   g->launch_done_cb = cb;
1497   g->launch_done_cb_data = opaque;
1498 }
1499
1500 /*----------------------------------------------------------------------*/
1501
1502 /* This is the code used to send and receive RPC messages and (for
1503  * certain types of message) to perform file transfers.  This code is
1504  * driven from the generated actions (src/guestfs-actions.c).  There
1505  * are five different cases to consider:
1506  *
1507  * (1) A non-daemon function.  There is no RPC involved at all, it's
1508  * all handled inside the library.
1509  *
1510  * (2) A simple RPC (eg. "mount").  We write the request, then read
1511  * the reply.  The sequence of calls is:
1512  *
1513  *   guestfs___set_busy
1514  *   guestfs___send
1515  *   guestfs___recv
1516  *   guestfs___end_busy
1517  *
1518  * (3) An RPC with FileOut parameters (eg. "upload").  We write the
1519  * request, then write the file(s), then read the reply.  The sequence
1520  * of calls is:
1521  *
1522  *   guestfs___set_busy
1523  *   guestfs___send
1524  *   guestfs___send_file  (possibly multiple times)
1525  *   guestfs___recv
1526  *   guestfs___end_busy
1527  *
1528  * (4) An RPC with FileIn parameters (eg. "download").  We write the
1529  * request, then read the reply, then read the file(s).  The sequence
1530  * of calls is:
1531  *
1532  *   guestfs___set_busy
1533  *   guestfs___send
1534  *   guestfs___recv
1535  *   guestfs___recv_file  (possibly multiple times)
1536  *   guestfs___end_busy
1537  *
1538  * (5) Both FileOut and FileIn parameters.  There are no calls like
1539  * this in the current API, but they would be implemented as a
1540  * combination of cases (3) and (4).
1541  *
1542  * During all writes and reads, we also select(2) on qemu stdout
1543  * looking for messages (guestfsd stderr and guest kernel dmesg), and
1544  * anything received is passed up through the log_message_cb.  This is
1545  * also the reason why all the sockets are non-blocking.  We also have
1546  * to check for EOF (qemu died).  All of this is handled by the
1547  * functions send_to_daemon and recv_from_daemon.
1548  */
1549
1550 int
1551 guestfs___set_busy (guestfs_h *g)
1552 {
1553   if (g->state != READY) {
1554     error (g, _("guestfs_set_busy: called when in state %d != READY"),
1555            g->state);
1556     return -1;
1557   }
1558   g->state = BUSY;
1559   return 0;
1560 }
1561
1562 int
1563 guestfs___end_busy (guestfs_h *g)
1564 {
1565   switch (g->state)
1566     {
1567     case BUSY:
1568       g->state = READY;
1569       break;
1570     case CONFIG:
1571     case READY:
1572       break;
1573
1574     case LAUNCHING:
1575     case NO_HANDLE:
1576     default:
1577       error (g, _("guestfs_end_busy: called when in state %d"), g->state);
1578       return -1;
1579     }
1580   return 0;
1581 }
1582
1583 /* This is called if we detect EOF, ie. qemu died. */
1584 static void
1585 child_cleanup (guestfs_h *g)
1586 {
1587   if (g->verbose)
1588     fprintf (stderr, "child_cleanup: %p: child process died\n", g);
1589
1590   /*kill (g->pid, SIGTERM);*/
1591   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1592   waitpid (g->pid, NULL, 0);
1593   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1594   close (g->fd[0]);
1595   close (g->fd[1]);
1596   close (g->sock);
1597   g->fd[0] = -1;
1598   g->fd[1] = -1;
1599   g->sock = -1;
1600   g->pid = 0;
1601   g->recoverypid = 0;
1602   g->start_t = 0;
1603   g->state = CONFIG;
1604   if (g->subprocess_quit_cb)
1605     g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
1606 }
1607
1608 static int
1609 read_log_message_or_eof (guestfs_h *g, int fd)
1610 {
1611   char buf[BUFSIZ];
1612   int n;
1613
1614 #if 0
1615   if (g->verbose)
1616     fprintf (stderr,
1617              "read_log_message_or_eof: %p g->state = %d, fd = %d\n",
1618              g, g->state, fd);
1619 #endif
1620
1621   /* QEMU's console emulates a 16550A serial port.  The real 16550A
1622    * device has a small FIFO buffer (16 bytes) which means here we see
1623    * lots of small reads of 1-16 bytes in length, usually single
1624    * bytes.
1625    */
1626   n = read (fd, buf, sizeof buf);
1627   if (n == 0) {
1628     /* Hopefully this indicates the qemu child process has died. */
1629     child_cleanup (g);
1630     return -1;
1631   }
1632
1633   if (n == -1) {
1634     if (errno == EINTR || errno == EAGAIN)
1635       return 0;
1636
1637     perrorf (g, "read");
1638     return -1;
1639   }
1640
1641   /* In verbose mode, copy all log messages to stderr. */
1642   if (g->verbose)
1643     ignore_value (write (STDERR_FILENO, buf, n));
1644
1645   /* It's an actual log message, send it upwards if anyone is listening. */
1646   if (g->log_message_cb)
1647     g->log_message_cb (g, g->log_message_cb_data, buf, n);
1648
1649   return 0;
1650 }
1651
1652 static int
1653 check_for_daemon_cancellation_or_eof (guestfs_h *g, int fd)
1654 {
1655   char buf[4];
1656   int n;
1657   uint32_t flag;
1658   XDR xdr;
1659
1660   if (g->verbose)
1661     fprintf (stderr,
1662              "check_for_daemon_cancellation_or_eof: %p g->state = %d, fd = %d\n",
1663              g, g->state, fd);
1664
1665   n = read (fd, buf, 4);
1666   if (n == 0) {
1667     /* Hopefully this indicates the qemu child process has died. */
1668     child_cleanup (g);
1669     return -1;
1670   }
1671
1672   if (n == -1) {
1673     if (errno == EINTR || errno == EAGAIN)
1674       return 0;
1675
1676     perrorf (g, "read");
1677     return -1;
1678   }
1679
1680   xdrmem_create (&xdr, buf, 4, XDR_DECODE);
1681   xdr_uint32_t (&xdr, &flag);
1682   xdr_destroy (&xdr);
1683
1684   if (flag != GUESTFS_CANCEL_FLAG) {
1685     error (g, _("check_for_daemon_cancellation_or_eof: read 0x%x from daemon, expected 0x%x\n"),
1686            flag, GUESTFS_CANCEL_FLAG);
1687     return -1;
1688   }
1689
1690   return -2;
1691 }
1692
1693 /* This writes the whole N bytes of BUF to the daemon socket.
1694  *
1695  * If the whole write is successful, it returns 0.
1696  * If there was an error, it returns -1.
1697  * If the daemon sent a cancellation message, it returns -2.
1698  *
1699  * It also checks qemu stdout for log messages and passes those up
1700  * through log_message_cb.
1701  *
1702  * It also checks for EOF (qemu died) and passes that up through the
1703  * child_cleanup function above.
1704  */
1705 static int
1706 send_to_daemon (guestfs_h *g, const void *v_buf, size_t n)
1707 {
1708   const char *buf = v_buf;
1709   fd_set rset, rset2;
1710   fd_set wset, wset2;
1711
1712   if (g->verbose)
1713     fprintf (stderr,
1714              "send_to_daemon: %p g->state = %d, n = %zu\n", g, g->state, n);
1715
1716   FD_ZERO (&rset);
1717   FD_ZERO (&wset);
1718
1719   FD_SET (g->fd[1], &rset);     /* Read qemu stdout for log messages & EOF. */
1720   FD_SET (g->sock, &rset);      /* Read socket for cancellation & EOF. */
1721   FD_SET (g->sock, &wset);      /* Write to socket to send the data. */
1722
1723   int max_fd = g->sock > g->fd[1] ? g->sock : g->fd[1];
1724
1725   while (n > 0) {
1726     rset2 = rset;
1727     wset2 = wset;
1728     int r = select (max_fd+1, &rset2, &wset2, NULL, NULL);
1729     if (r == -1) {
1730       if (errno == EINTR || errno == EAGAIN)
1731         continue;
1732       perrorf (g, "select");
1733       return -1;
1734     }
1735
1736     if (FD_ISSET (g->fd[1], &rset2)) {
1737       if (read_log_message_or_eof (g, g->fd[1]) == -1)
1738         return -1;
1739     }
1740     if (FD_ISSET (g->sock, &rset2)) {
1741       r = check_for_daemon_cancellation_or_eof (g, g->sock);
1742       if (r < 0)
1743         return r;
1744     }
1745     if (FD_ISSET (g->sock, &wset2)) {
1746       r = write (g->sock, buf, n);
1747       if (r == -1) {
1748         if (errno == EINTR || errno == EAGAIN)
1749           continue;
1750         perrorf (g, "write");
1751         if (errno == EPIPE) /* Disconnected from guest (RHBZ#508713). */
1752           child_cleanup (g);
1753         return -1;
1754       }
1755       buf += r;
1756       n -= r;
1757     }
1758   }
1759
1760   return 0;
1761 }
1762
1763 /* This reads a single message, file chunk, launch flag or
1764  * cancellation flag from the daemon.  If something was read, it
1765  * returns 0, otherwise -1.
1766  *
1767  * Both size_rtn and buf_rtn must be passed by the caller as non-NULL.
1768  *
1769  * *size_rtn returns the size of the returned message or it may be
1770  * GUESTFS_LAUNCH_FLAG or GUESTFS_CANCEL_FLAG.
1771  *
1772  * *buf_rtn is returned containing the message (if any) or will be set
1773  * to NULL.  *buf_rtn must be freed by the caller.
1774  *
1775  * It also checks qemu stdout for log messages and passes those up
1776  * through log_message_cb.
1777  *
1778  * It also checks for EOF (qemu died) and passes that up through the
1779  * child_cleanup function above.
1780  */
1781 static int
1782 recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn)
1783 {
1784   fd_set rset, rset2;
1785
1786   if (g->verbose)
1787     fprintf (stderr,
1788              "recv_from_daemon: %p g->state = %d, size_rtn = %p, buf_rtn = %p\n",
1789              g, g->state, size_rtn, buf_rtn);
1790
1791   FD_ZERO (&rset);
1792
1793   FD_SET (g->fd[1], &rset);     /* Read qemu stdout for log messages & EOF. */
1794   FD_SET (g->sock, &rset);      /* Read socket for data & EOF. */
1795
1796   int max_fd = g->sock > g->fd[1] ? g->sock : g->fd[1];
1797
1798   *size_rtn = 0;
1799   *buf_rtn = NULL;
1800
1801   char lenbuf[4];
1802   /* nr is the size of the message, but we prime it as -4 because we
1803    * have to read the message length word first.
1804    */
1805   ssize_t nr = -4;
1806
1807   while (nr < (ssize_t) *size_rtn) {
1808     rset2 = rset;
1809     int r = select (max_fd+1, &rset2, NULL, NULL, NULL);
1810     if (r == -1) {
1811       if (errno == EINTR || errno == EAGAIN)
1812         continue;
1813       perrorf (g, "select");
1814       free (*buf_rtn);
1815       *buf_rtn = NULL;
1816       return -1;
1817     }
1818
1819     if (FD_ISSET (g->fd[1], &rset2)) {
1820       if (read_log_message_or_eof (g, g->fd[1]) == -1) {
1821         free (*buf_rtn);
1822         *buf_rtn = NULL;
1823         return -1;
1824       }
1825     }
1826     if (FD_ISSET (g->sock, &rset2)) {
1827       if (nr < 0) {    /* Have we read the message length word yet? */
1828         r = read (g->sock, lenbuf+nr+4, -nr);
1829         if (r == -1) {
1830           if (errno == EINTR || errno == EAGAIN)
1831             continue;
1832           int err = errno;
1833           perrorf (g, "read");
1834           /* Under some circumstances we see "Connection reset by peer"
1835            * here when the child dies suddenly.  Catch this and call
1836            * the cleanup function, same as for EOF.
1837            */
1838           if (err == ECONNRESET)
1839             child_cleanup (g);
1840           return -1;
1841         }
1842         if (r == 0) {
1843           error (g, _("unexpected end of file when reading from daemon"));
1844           child_cleanup (g);
1845           return -1;
1846         }
1847         nr += r;
1848
1849         if (nr < 0)         /* Still not got the whole length word. */
1850           continue;
1851
1852         XDR xdr;
1853         xdrmem_create (&xdr, lenbuf, 4, XDR_DECODE);
1854         xdr_uint32_t (&xdr, size_rtn);
1855         xdr_destroy (&xdr);
1856
1857         if (*size_rtn == GUESTFS_LAUNCH_FLAG) {
1858           if (g->state != LAUNCHING)
1859             error (g, _("received magic signature from guestfsd, but in state %d"),
1860                    g->state);
1861           else {
1862             g->state = READY;
1863             if (g->launch_done_cb)
1864               g->launch_done_cb (g, g->launch_done_cb_data);
1865           }
1866           return 0;
1867         }
1868         else if (*size_rtn == GUESTFS_CANCEL_FLAG)
1869           return 0;
1870         /* If this happens, it's pretty bad and we've probably lost
1871          * synchronization.
1872          */
1873         else if (*size_rtn > GUESTFS_MESSAGE_MAX) {
1874           error (g, _("message length (%u) > maximum possible size (%d)"),
1875                  (unsigned) *size_rtn, GUESTFS_MESSAGE_MAX);
1876           return -1;
1877         }
1878
1879         /* Allocate the complete buffer, size now known. */
1880         *buf_rtn = safe_malloc (g, *size_rtn);
1881         /*FALLTHROUGH*/
1882       }
1883
1884       size_t sizetoread = *size_rtn - nr;
1885       if (sizetoread > BUFSIZ) sizetoread = BUFSIZ;
1886
1887       r = read (g->sock, (char *) (*buf_rtn) + nr, sizetoread);
1888       if (r == -1) {
1889         if (errno == EINTR || errno == EAGAIN)
1890           continue;
1891         perrorf (g, "read");
1892         free (*buf_rtn);
1893         *buf_rtn = NULL;
1894         return -1;
1895       }
1896       if (r == 0) {
1897         error (g, _("unexpected end of file when reading from daemon"));
1898         child_cleanup (g);
1899         free (*buf_rtn);
1900         *buf_rtn = NULL;
1901         return -1;
1902       }
1903       nr += r;
1904     }
1905   }
1906
1907   /* Got the full message, caller can start processing it. */
1908 #ifdef ENABLE_PACKET_DUMP
1909   if (g->verbose) {
1910     ssize_t i, j;
1911
1912     for (i = 0; i < nr; i += 16) {
1913       printf ("%04zx: ", i);
1914       for (j = i; j < MIN (i+16, nr); ++j)
1915         printf ("%02x ", (*(unsigned char **)buf_rtn)[j]);
1916       for (; j < i+16; ++j)
1917         printf ("   ");
1918       printf ("|");
1919       for (j = i; j < MIN (i+16, nr); ++j)
1920         if (isprint ((*(char **)buf_rtn)[j]))
1921           printf ("%c", (*(char **)buf_rtn)[j]);
1922         else
1923           printf (".");
1924       for (; j < i+16; ++j)
1925         printf (" ");
1926       printf ("|\n");
1927     }
1928   }
1929 #endif
1930
1931   return 0;
1932 }
1933
1934 int
1935 guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args)
1936 {
1937   struct guestfs_message_header hdr;
1938   XDR xdr;
1939   u_int32_t len;
1940   int serial = g->msg_next_serial++;
1941   int r;
1942   char *msg_out;
1943   size_t msg_out_size;
1944
1945   if (g->state != BUSY) {
1946     error (g, _("guestfs___send: state %d != BUSY"), g->state);
1947     return -1;
1948   }
1949
1950   /* We have to allocate this message buffer on the heap because
1951    * it is quite large (although will be mostly unused).  We
1952    * can't allocate it on the stack because in some environments
1953    * we have quite limited stack space available, notably when
1954    * running in the JVM.
1955    */
1956   msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
1957   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
1958
1959   /* Serialize the header. */
1960   hdr.prog = GUESTFS_PROGRAM;
1961   hdr.vers = GUESTFS_PROTOCOL_VERSION;
1962   hdr.proc = proc_nr;
1963   hdr.direction = GUESTFS_DIRECTION_CALL;
1964   hdr.serial = serial;
1965   hdr.status = GUESTFS_STATUS_OK;
1966
1967   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
1968     error (g, _("xdr_guestfs_message_header failed"));
1969     goto cleanup1;
1970   }
1971
1972   /* Serialize the args.  If any, because some message types
1973    * have no parameters.
1974    */
1975   if (xdrp) {
1976     if (!(*xdrp) (&xdr, args)) {
1977       error (g, _("dispatch failed to marshal args"));
1978       goto cleanup1;
1979     }
1980   }
1981
1982   /* Get the actual length of the message, resize the buffer to match
1983    * the actual length, and write the length word at the beginning.
1984    */
1985   len = xdr_getpos (&xdr);
1986   xdr_destroy (&xdr);
1987
1988   msg_out = safe_realloc (g, msg_out, len + 4);
1989   msg_out_size = len + 4;
1990
1991   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
1992   xdr_uint32_t (&xdr, &len);
1993
1994  again:
1995   r = send_to_daemon (g, msg_out, msg_out_size);
1996   if (r == -2)                  /* Ignore stray daemon cancellations. */
1997     goto again;
1998   if (r == -1)
1999     goto cleanup1;
2000   free (msg_out);
2001
2002   return serial;
2003
2004  cleanup1:
2005   free (msg_out);
2006   return -1;
2007 }
2008
2009 static int cancel = 0; /* XXX Implement file cancellation. */
2010 static int send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t len);
2011 static int send_file_data (guestfs_h *g, const char *buf, size_t len);
2012 static int send_file_cancellation (guestfs_h *g);
2013 static int send_file_complete (guestfs_h *g);
2014
2015 /* Send a file.
2016  * Returns:
2017  *   0 OK
2018  *   -1 error
2019  *   -2 daemon cancelled (we must read the error message)
2020  */
2021 int
2022 guestfs___send_file (guestfs_h *g, const char *filename)
2023 {
2024   char buf[GUESTFS_MAX_CHUNK_SIZE];
2025   int fd, r, err;
2026
2027   fd = open (filename, O_RDONLY);
2028   if (fd == -1) {
2029     perrorf (g, "open: %s", filename);
2030     send_file_cancellation (g);
2031     /* Daemon sees cancellation and won't reply, so caller can
2032      * just return here.
2033      */
2034     return -1;
2035   }
2036
2037   /* Send file in chunked encoding. */
2038   while (!cancel) {
2039     r = read (fd, buf, sizeof buf);
2040     if (r == -1 && (errno == EINTR || errno == EAGAIN))
2041       continue;
2042     if (r <= 0) break;
2043     err = send_file_data (g, buf, r);
2044     if (err < 0) {
2045       if (err == -2)            /* daemon sent cancellation */
2046         send_file_cancellation (g);
2047       return err;
2048     }
2049   }
2050
2051   if (cancel) {                 /* cancel from either end */
2052     send_file_cancellation (g);
2053     return -1;
2054   }
2055
2056   if (r == -1) {
2057     perrorf (g, "read: %s", filename);
2058     send_file_cancellation (g);
2059     return -1;
2060   }
2061
2062   /* End of file, but before we send that, we need to close
2063    * the file and check for errors.
2064    */
2065   if (close (fd) == -1) {
2066     perrorf (g, "close: %s", filename);
2067     send_file_cancellation (g);
2068     return -1;
2069   }
2070
2071   return send_file_complete (g);
2072 }
2073
2074 /* Send a chunk of file data. */
2075 static int
2076 send_file_data (guestfs_h *g, const char *buf, size_t len)
2077 {
2078   return send_file_chunk (g, 0, buf, len);
2079 }
2080
2081 /* Send a cancellation message. */
2082 static int
2083 send_file_cancellation (guestfs_h *g)
2084 {
2085   return send_file_chunk (g, 1, NULL, 0);
2086 }
2087
2088 /* Send a file complete chunk. */
2089 static int
2090 send_file_complete (guestfs_h *g)
2091 {
2092   char buf[1];
2093   return send_file_chunk (g, 0, buf, 0);
2094 }
2095
2096 static int
2097 send_file_chunk (guestfs_h *g, int cancel, const char *buf, size_t buflen)
2098 {
2099   u_int32_t len;
2100   int r;
2101   guestfs_chunk chunk;
2102   XDR xdr;
2103   char *msg_out;
2104   size_t msg_out_size;
2105
2106   if (g->state != BUSY) {
2107     error (g, _("send_file_chunk: state %d != READY"), g->state);
2108     return -1;
2109   }
2110
2111   /* Allocate the chunk buffer.  Don't use the stack to avoid
2112    * excessive stack usage and unnecessary copies.
2113    */
2114   msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
2115   xdrmem_create (&xdr, msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
2116
2117   /* Serialize the chunk. */
2118   chunk.cancel = cancel;
2119   chunk.data.data_len = buflen;
2120   chunk.data.data_val = (char *) buf;
2121
2122   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2123     error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
2124            buf, buflen);
2125     xdr_destroy (&xdr);
2126     goto cleanup1;
2127   }
2128
2129   len = xdr_getpos (&xdr);
2130   xdr_destroy (&xdr);
2131
2132   /* Reduce the size of the outgoing message buffer to the real length. */
2133   msg_out = safe_realloc (g, msg_out, len + 4);
2134   msg_out_size = len + 4;
2135
2136   xdrmem_create (&xdr, msg_out, 4, XDR_ENCODE);
2137   xdr_uint32_t (&xdr, &len);
2138
2139   r = send_to_daemon (g, msg_out, msg_out_size);
2140
2141   /* Did the daemon send a cancellation message? */
2142   if (r == -2) {
2143     if (g->verbose)
2144       fprintf (stderr, "got daemon cancellation\n");
2145     return -2;
2146   }
2147
2148   if (r == -1)
2149     goto cleanup1;
2150
2151   free (msg_out);
2152
2153   return 0;
2154
2155  cleanup1:
2156   free (msg_out);
2157   return -1;
2158 }
2159
2160 /* Receive a reply. */
2161 int
2162 guestfs___recv (guestfs_h *g, const char *fn,
2163                 guestfs_message_header *hdr,
2164                 guestfs_message_error *err,
2165                 xdrproc_t xdrp, char *ret)
2166 {
2167   XDR xdr;
2168   void *buf;
2169   uint32_t size;
2170   int r;
2171
2172  again:
2173   r = recv_from_daemon (g, &size, &buf);
2174   if (r == -1)
2175     return -1;
2176
2177   /* This can happen if a cancellation happens right at the end
2178    * of us sending a FileIn parameter to the daemon.  Discard.  The
2179    * daemon should send us an error message next.
2180    */
2181   if (size == GUESTFS_CANCEL_FLAG)
2182     goto again;
2183
2184   if (size == GUESTFS_LAUNCH_FLAG) {
2185     error (g, "%s: received unexpected launch flag from daemon when expecting reply", fn);
2186     return -1;
2187   }
2188
2189   xdrmem_create (&xdr, buf, size, XDR_DECODE);
2190
2191   if (!xdr_guestfs_message_header (&xdr, hdr)) {
2192     error (g, "%s: failed to parse reply header", fn);
2193     xdr_destroy (&xdr);
2194     free (buf);
2195     return -1;
2196   }
2197   if (hdr->status == GUESTFS_STATUS_ERROR) {
2198     if (!xdr_guestfs_message_error (&xdr, err)) {
2199       error (g, "%s: failed to parse reply error", fn);
2200       xdr_destroy (&xdr);
2201       free (buf);
2202       return -1;
2203     }
2204   } else {
2205     if (xdrp && ret && !xdrp (&xdr, ret)) {
2206       error (g, "%s: failed to parse reply", fn);
2207       xdr_destroy (&xdr);
2208       free (buf);
2209       return -1;
2210     }
2211   }
2212   xdr_destroy (&xdr);
2213   free (buf);
2214
2215   return 0;
2216 }
2217
2218 /* Receive a file. */
2219
2220 /* Returns -1 = error, 0 = EOF, > 0 = more data */
2221 static ssize_t receive_file_data (guestfs_h *g, void **buf);
2222
2223 int
2224 guestfs___recv_file (guestfs_h *g, const char *filename)
2225 {
2226   void *buf;
2227   int fd, r;
2228   size_t len;
2229
2230   fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2231   if (fd == -1) {
2232     perrorf (g, "open: %s", filename);
2233     goto cancel;
2234   }
2235
2236   /* Receive the file in chunked encoding. */
2237   while ((r = receive_file_data (g, &buf)) > 0) {
2238     if (xwrite (fd, buf, r) == -1) {
2239       perrorf (g, "%s: write", filename);
2240       free (buf);
2241       goto cancel;
2242     }
2243     free (buf);
2244   }
2245
2246   if (r == -1) {
2247     error (g, _("%s: error in chunked encoding"), filename);
2248     return -1;
2249   }
2250
2251   if (close (fd) == -1) {
2252     perrorf (g, "close: %s", filename);
2253     return -1;
2254   }
2255
2256   return 0;
2257
2258  cancel: ;
2259   /* Send cancellation message to daemon, then wait until it
2260    * cancels (just throwing away data).
2261    */
2262   XDR xdr;
2263   char fbuf[4];
2264   uint32_t flag = GUESTFS_CANCEL_FLAG;
2265
2266   if (g->verbose)
2267     fprintf (stderr, "%s: waiting for daemon to acknowledge cancellation\n",
2268              __func__);
2269
2270   xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
2271   xdr_uint32_t (&xdr, &flag);
2272   xdr_destroy (&xdr);
2273
2274   if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
2275     perrorf (g, _("write to daemon socket"));
2276     return -1;
2277   }
2278
2279   while (receive_file_data (g, NULL) > 0)
2280     ;                           /* just discard it */
2281
2282   return -1;
2283 }
2284
2285 /* Receive a chunk of file data. */
2286 /* Returns -1 = error, 0 = EOF, > 0 = more data */
2287 static ssize_t
2288 receive_file_data (guestfs_h *g, void **buf_r)
2289 {
2290   int r;
2291   void *buf;
2292   uint32_t len;
2293   XDR xdr;
2294   guestfs_chunk chunk;
2295
2296   r = recv_from_daemon (g, &len, &buf);
2297   if (r == -1) {
2298     error (g, _("receive_file_data: parse error in reply callback"));
2299     return -1;
2300   }
2301
2302   if (len == GUESTFS_LAUNCH_FLAG || len == GUESTFS_CANCEL_FLAG) {
2303     error (g, _("receive_file_data: unexpected flag received when reading file chunks"));
2304     return -1;
2305   }
2306
2307   memset (&chunk, 0, sizeof chunk);
2308
2309   xdrmem_create (&xdr, buf, len, XDR_DECODE);
2310   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2311     error (g, _("failed to parse file chunk"));
2312     free (buf);
2313     return -1;
2314   }
2315   xdr_destroy (&xdr);
2316   /* After decoding, the original buffer is no longer used. */
2317   free (buf);
2318
2319   if (chunk.cancel) {
2320     error (g, _("file receive cancelled by daemon"));
2321     free (chunk.data.data_val);
2322     return -1;
2323   }
2324
2325   if (chunk.data.data_len == 0) { /* end of transfer */
2326     free (chunk.data.data_val);
2327     return 0;
2328   }
2329
2330   if (buf_r) *buf_r = chunk.data.data_val;
2331   else free (chunk.data.data_val); /* else caller frees */
2332
2333   return chunk.data.data_len;
2334 }