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