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