Implement '*grep*' family of commands.
[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 #define LINUX_CMDLINE                                                   \
1042     "panic=1 "         /* force kernel to panic if daemon exits */      \
1043     "console=ttyS0 "   /* serial console */                             \
1044     "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */   \
1045     "noapic "          /* workaround for RHBZ#502058 - ok if not SMP */ \
1046     "acpi=off "        /* we don't need ACPI, turn it off */            \
1047     "cgroup_disable=memory " /* saves us about 5 MB of RAM */
1048
1049     /* Linux kernel command line. */
1050     snprintf (append, sizeof append,
1051               LINUX_CMDLINE "guestfs=%s:%d%s%s%s",
1052               VMCHANNEL_ADDR, VMCHANNEL_PORT,
1053               g->verbose ? " guestfs_verbose=1" : "",
1054               g->append ? " " : "", g->append ? g->append : "");
1055
1056     snprintf (memsize_str, sizeof memsize_str, "%d", g->memsize);
1057
1058     add_cmdline (g, "-m");
1059     add_cmdline (g, memsize_str);
1060     add_cmdline (g, "-no-reboot"); /* Force exit instead of reboot on panic */
1061     add_cmdline (g, "-kernel");
1062     add_cmdline (g, (char *) kernel);
1063     add_cmdline (g, "-initrd");
1064     add_cmdline (g, (char *) initrd);
1065     add_cmdline (g, "-append");
1066     add_cmdline (g, append);
1067     add_cmdline (g, "-nographic");
1068     add_cmdline (g, "-serial");
1069     add_cmdline (g, "stdio");
1070
1071 #if 0
1072     /* Doesn't work.  See:
1073      * http://lists.gnu.org/archive/html/qemu-devel/2009-07/threads.html
1074      * Subject "guestfwd option doesn't allow supplementary ,server,nowait"
1075      */
1076     if (qemu_supports (g, "guestfwd")) {
1077       /* New-style -net user,guestfwd=... syntax for vmchannel.  See:
1078        * http://git.savannah.gnu.org/cgit/qemu.git/commit/?id=c92ef6a22d3c71538fcc48fb61ad353f7ba03b62
1079        */
1080       snprintf (vmchannel, sizeof vmchannel,
1081                 "user,vlan=0,guestfwd=tcp:%s:%d-unix:%s,server,nowait",
1082                 VMCHANNEL_ADDR, VMCHANNEL_PORT, unixsock);
1083
1084       add_cmdline (g, "-net");
1085       add_cmdline (g, vmchannel);
1086     } else {
1087 #endif
1088       /* Not guestfwd.  HOPEFULLY this qemu uses the older -net channel
1089        * syntax, or if not then we'll get a quick failure.
1090        */
1091       snprintf (vmchannel, sizeof vmchannel,
1092                 "channel,%d:unix:%s,server,nowait",
1093                 VMCHANNEL_PORT, unixsock);
1094
1095       add_cmdline (g, "-net");
1096       add_cmdline (g, vmchannel);
1097       add_cmdline (g, "-net");
1098       add_cmdline (g, "user,vlan=0");
1099 #if 0
1100     }
1101 #endif
1102     add_cmdline (g, "-net");
1103     add_cmdline (g, "nic,model=virtio,vlan=0");
1104
1105     /* These options recommended by KVM developers to improve reliability. */
1106     if (qemu_supports (g, "-no-hpet"))
1107       add_cmdline (g, "-no-hpet");
1108
1109     if (qemu_supports (g, "-rtc-td-hack"))
1110       add_cmdline (g, "-rtc-td-hack");
1111
1112     /* Finish off the command line. */
1113     incr_cmdline_size (g);
1114     g->cmdline[g->cmdline_size-1] = NULL;
1115
1116     if (g->verbose) {
1117       fprintf (stderr, "%s", g->qemu);
1118       for (i = 0; g->cmdline[i]; ++i)
1119         fprintf (stderr, " %s", g->cmdline[i]);
1120       fprintf (stderr, "\n");
1121     }
1122
1123     /* Set up stdin, stdout. */
1124     close (0);
1125     close (1);
1126     close (wfd[1]);
1127     close (rfd[0]);
1128     dup (wfd[0]);
1129     dup (rfd[1]);
1130     close (wfd[0]);
1131     close (rfd[1]);
1132
1133 #if 0
1134     /* Set up a new process group, so we can signal this process
1135      * and all subprocesses (eg. if qemu is really a shell script).
1136      */
1137     setpgid (0, 0);
1138 #endif
1139
1140     execv (g->qemu, g->cmdline); /* Run qemu. */
1141     perror (g->qemu);
1142     _exit (1);
1143   }
1144
1145   /* Parent (library). */
1146   g->pid = r;
1147
1148   free (kernel);
1149   kernel = NULL;
1150   free (initrd);
1151   initrd = NULL;
1152
1153   /* Fork the recovery process off which will kill qemu if the parent
1154    * process fails to do so (eg. if the parent segfaults).
1155    */
1156   r = fork ();
1157   if (r == 0) {
1158     pid_t qemu_pid = g->pid;
1159     pid_t parent_pid = getppid ();
1160
1161     /* Writing to argv is hideously complicated and error prone.  See:
1162      * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
1163      */
1164
1165     /* Loop around waiting for one or both of the other processes to
1166      * disappear.  It's fair to say this is very hairy.  The PIDs that
1167      * we are looking at might be reused by another process.  We are
1168      * effectively polling.  Is the cure worse than the disease?
1169      */
1170     for (;;) {
1171       if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
1172         _exit (0);
1173       if (kill (parent_pid, 0) == -1) {
1174         /* Parent's gone away, qemu still around, so kill qemu. */
1175         kill (qemu_pid, 9);
1176         _exit (0);
1177       }
1178       sleep (2);
1179     }
1180   }
1181
1182   /* Don't worry, if the fork failed, this will be -1.  The recovery
1183    * process isn't essential.
1184    */
1185   g->recoverypid = r;
1186
1187   /* Start the clock ... */
1188   time (&g->start_t);
1189
1190   /* Close the other ends of the pipe. */
1191   close (wfd[0]);
1192   close (rfd[1]);
1193
1194   if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
1195       fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
1196     perrorf (g, "fcntl");
1197     goto cleanup1;
1198   }
1199
1200   g->fd[0] = wfd[1];            /* stdin of child */
1201   g->fd[1] = rfd[0];            /* stdout of child */
1202
1203   /* Open the Unix socket.  The vmchannel implementation that got
1204    * merged with qemu sucks in a number of ways.  Both ends do
1205    * connect(2), which means that no one knows what, if anything, is
1206    * connected to the other end, or if it becomes disconnected.  Even
1207    * worse, we have to wait some indeterminate time for qemu to create
1208    * the socket and connect to it (which happens very early in qemu's
1209    * start-up), so any code that uses vmchannel is inherently racy.
1210    * Hence this silly loop.
1211    */
1212   g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
1213   if (g->sock == -1) {
1214     perrorf (g, "socket");
1215     goto cleanup1;
1216   }
1217
1218   if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
1219     perrorf (g, "fcntl");
1220     goto cleanup2;
1221   }
1222
1223   addr.sun_family = AF_UNIX;
1224   strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
1225   addr.sun_path[UNIX_PATH_MAX-1] = '\0';
1226
1227   tries = 100;
1228   /* Always sleep at least once to give qemu a small chance to start up. */
1229   usleep (10000);
1230   while (tries > 0) {
1231     r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
1232     if ((r == -1 && errno == EINPROGRESS) || r == 0)
1233       goto connected;
1234
1235     if (errno != ENOENT)
1236       perrorf (g, "connect");
1237     tries--;
1238     usleep (100000);
1239   }
1240
1241   error (g, _("failed to connect to vmchannel socket"));
1242   goto cleanup2;
1243
1244  connected:
1245   /* Watch the file descriptors. */
1246   free (g->msg_in);
1247   g->msg_in = NULL;
1248   g->msg_in_size = g->msg_in_allocated = 0;
1249
1250   free (g->msg_out);
1251   g->msg_out = NULL;
1252   g->msg_out_size = 0;
1253   g->msg_out_pos = 0;
1254
1255   g->stdout_watch =
1256     g->main_loop->add_handle (g->main_loop, g, g->fd[1],
1257                               GUESTFS_HANDLE_READABLE,
1258                               stdout_event, NULL);
1259   if (g->stdout_watch == -1) {
1260     error (g, _("could not watch qemu stdout"));
1261     goto cleanup3;
1262   }
1263
1264   if (guestfs__switch_to_receiving (g) == -1)
1265     goto cleanup3;
1266
1267   g->state = LAUNCHING;
1268   return 0;
1269
1270  cleanup3:
1271   if (g->stdout_watch >= 0)
1272     g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1273   if (g->sock_watch >= 0)
1274     g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1275
1276  cleanup2:
1277   close (g->sock);
1278
1279  cleanup1:
1280   close (wfd[1]);
1281   close (rfd[0]);
1282   kill (g->pid, 9);
1283   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1284   waitpid (g->pid, NULL, 0);
1285   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1286   g->fd[0] = -1;
1287   g->fd[1] = -1;
1288   g->sock = -1;
1289   g->pid = 0;
1290   g->recoverypid = 0;
1291   g->start_t = 0;
1292   g->stdout_watch = -1;
1293   g->sock_watch = -1;
1294
1295  cleanup0:
1296   free (kernel);
1297   free (initrd);
1298   return -1;
1299 }
1300
1301 /* This function does the hard work of building the supermin appliance
1302  * on the fly.  'path' is the directory containing the control files.
1303  * 'kernel' and 'initrd' are where we will return the names of the
1304  * kernel and initrd (only initrd is built).  The work is done by
1305  * an external script.  We just tell it where to put the result.
1306  */
1307 static int
1308 build_supermin_appliance (guestfs_h *g, const char *path,
1309                           char **kernel, char **initrd)
1310 {
1311   char cmd[4096];
1312   int r, len;
1313
1314   len = strlen (g->tmpdir);
1315   *kernel = safe_malloc (g, len + 8);
1316   snprintf (*kernel, len+8, "%s/kernel", g->tmpdir);
1317   *initrd = safe_malloc (g, len + 8);
1318   snprintf (*initrd, len+8, "%s/initrd", g->tmpdir);
1319
1320   snprintf (cmd, sizeof cmd,
1321             "PATH='%s':$PATH "
1322             "libguestfs-supermin-helper '%s' %s %s",
1323             path,
1324             path, *kernel, *initrd);
1325
1326   r = system (cmd);
1327   if (r == -1 || WEXITSTATUS(r) != 0) {
1328     error (g, _("external command failed: %s"), cmd);
1329     free (*kernel);
1330     free (*initrd);
1331     *kernel = *initrd = NULL;
1332     return -1;
1333   }
1334
1335   return 0;
1336 }
1337
1338 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1339
1340 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1341  * 'qemu -version' so we know what options this qemu supports and
1342  * the version.
1343  */
1344 static int
1345 test_qemu (guestfs_h *g)
1346 {
1347   char cmd[1024];
1348   FILE *fp;
1349
1350   free (g->qemu_help);
1351   free (g->qemu_version);
1352   g->qemu_help = NULL;
1353   g->qemu_version = NULL;
1354
1355   snprintf (cmd, sizeof cmd, "'%s' -help", g->qemu);
1356
1357   fp = popen (cmd, "r");
1358   /* qemu -help should always work (qemu -version OTOH wasn't
1359    * supported by qemu 0.9).  If this command doesn't work then it
1360    * probably indicates that the qemu binary is missing.
1361    */
1362   if (!fp) {
1363     /* XXX This error is never printed, even if the qemu binary
1364      * doesn't exist.  Why?
1365      */
1366   error:
1367     perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1368     return -1;
1369   }
1370
1371   if (read_all (g, fp, &g->qemu_help) == -1)
1372     goto error;
1373
1374   if (pclose (fp) == -1)
1375     goto error;
1376
1377   snprintf (cmd, sizeof cmd, "'%s' -version 2>/dev/null", g->qemu);
1378
1379   fp = popen (cmd, "r");
1380   if (fp) {
1381     /* Intentionally ignore errors. */
1382     read_all (g, fp, &g->qemu_version);
1383     pclose (fp);
1384   }
1385
1386   return 0;
1387 }
1388
1389 static int
1390 read_all (guestfs_h *g, FILE *fp, char **ret)
1391 {
1392   int r, n = 0;
1393   char *p;
1394
1395  again:
1396   if (feof (fp)) {
1397     *ret = safe_realloc (g, *ret, n + 1);
1398     (*ret)[n] = '\0';
1399     return n;
1400   }
1401
1402   *ret = safe_realloc (g, *ret, n + BUFSIZ);
1403   p = &(*ret)[n];
1404   r = fread (p, 1, BUFSIZ, fp);
1405   if (ferror (fp)) {
1406     perrorf (g, "read");
1407     return -1;
1408   }
1409   n += r;
1410   goto again;
1411 }
1412
1413 /* Test if option is supported by qemu command line (just by grepping
1414  * the help text).
1415  */
1416 static int
1417 qemu_supports (guestfs_h *g, const char *option)
1418 {
1419   return g->qemu_help && strstr (g->qemu_help, option) != NULL;
1420 }
1421
1422 static void
1423 finish_wait_ready (guestfs_h *g, void *vp)
1424 {
1425   if (g->verbose)
1426     fprintf (stderr, "finish_wait_ready called, %p, vp = %p\n", g, vp);
1427
1428   *((int *)vp) = 1;
1429   g->main_loop->main_loop_quit (g->main_loop, g);
1430 }
1431
1432 int
1433 guestfs_wait_ready (guestfs_h *g)
1434 {
1435   int finished = 0, r;
1436
1437   if (g->state == READY) return 0;
1438
1439   if (g->state == BUSY) {
1440     error (g, _("qemu has finished launching already"));
1441     return -1;
1442   }
1443
1444   if (g->state != LAUNCHING) {
1445     error (g, _("qemu has not been launched yet"));
1446     return -1;
1447   }
1448
1449   g->launch_done_cb = finish_wait_ready;
1450   g->launch_done_cb_data = &finished;
1451   r = g->main_loop->main_loop_run (g->main_loop, g);
1452   g->launch_done_cb = NULL;
1453   g->launch_done_cb_data = NULL;
1454
1455   if (r == -1) return -1;
1456
1457   if (finished != 1) {
1458     error (g, _("guestfs_wait_ready failed, see earlier error messages"));
1459     return -1;
1460   }
1461
1462   /* This is possible in some really strange situations, such as
1463    * guestfsd starts up OK but then qemu immediately exits.  Check for
1464    * it because the caller is probably expecting to be able to send
1465    * commands after this function returns.
1466    */
1467   if (g->state != READY) {
1468     error (g, _("qemu launched and contacted daemon, but state != READY"));
1469     return -1;
1470   }
1471
1472   return 0;
1473 }
1474
1475 int
1476 guestfs_kill_subprocess (guestfs_h *g)
1477 {
1478   if (g->state == CONFIG) {
1479     error (g, _("no subprocess to kill"));
1480     return -1;
1481   }
1482
1483   if (g->verbose)
1484     fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
1485
1486   kill (g->pid, SIGTERM);
1487   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1488
1489   return 0;
1490 }
1491
1492 /* Access current state. */
1493 int
1494 guestfs_is_config (guestfs_h *g)
1495 {
1496   return g->state == CONFIG;
1497 }
1498
1499 int
1500 guestfs_is_launching (guestfs_h *g)
1501 {
1502   return g->state == LAUNCHING;
1503 }
1504
1505 int
1506 guestfs_is_ready (guestfs_h *g)
1507 {
1508   return g->state == READY;
1509 }
1510
1511 int
1512 guestfs_is_busy (guestfs_h *g)
1513 {
1514   return g->state == BUSY;
1515 }
1516
1517 int
1518 guestfs_get_state (guestfs_h *g)
1519 {
1520   return g->state;
1521 }
1522
1523 int
1524 guestfs_set_ready (guestfs_h *g)
1525 {
1526   if (g->state != BUSY) {
1527     error (g, _("guestfs_set_ready: called when in state %d != BUSY"),
1528            g->state);
1529     return -1;
1530   }
1531   g->state = READY;
1532   return 0;
1533 }
1534
1535 int
1536 guestfs_set_busy (guestfs_h *g)
1537 {
1538   if (g->state != READY) {
1539     error (g, _("guestfs_set_busy: called when in state %d != READY"),
1540            g->state);
1541     return -1;
1542   }
1543   g->state = BUSY;
1544   return 0;
1545 }
1546
1547 int
1548 guestfs_end_busy (guestfs_h *g)
1549 {
1550   switch (g->state)
1551     {
1552     case BUSY:
1553       g->state = READY;
1554       break;
1555     case CONFIG:
1556     case READY:
1557       break;
1558     case LAUNCHING:
1559     case NO_HANDLE:
1560       error (g, _("guestfs_end_busy: called when in state %d"), g->state);
1561       return -1;
1562     }
1563   return 0;
1564 }
1565
1566 /* We don't know if stdout_event or sock_read_event will be the
1567  * first to receive EOF if the qemu process dies.  This function
1568  * has the common cleanup code for both.
1569  */
1570 static void
1571 child_cleanup (guestfs_h *g)
1572 {
1573   if (g->verbose)
1574     fprintf (stderr, "stdout_event: %p: child process died\n", g);
1575   /*kill (g->pid, SIGTERM);*/
1576   if (g->recoverypid > 0) kill (g->recoverypid, 9);
1577   waitpid (g->pid, NULL, 0);
1578   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1579   if (g->stdout_watch >= 0)
1580     g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1581   if (g->sock_watch >= 0)
1582     g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1583   close (g->fd[0]);
1584   close (g->fd[1]);
1585   close (g->sock);
1586   g->fd[0] = -1;
1587   g->fd[1] = -1;
1588   g->sock = -1;
1589   g->pid = 0;
1590   g->recoverypid = 0;
1591   g->start_t = 0;
1592   g->stdout_watch = -1;
1593   g->sock_watch = -1;
1594   g->state = CONFIG;
1595   if (g->subprocess_quit_cb)
1596     g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
1597 }
1598
1599 /* This function is called whenever qemu prints something on stdout.
1600  * Qemu's stdout is also connected to the guest's serial console, so
1601  * we see kernel messages here too.
1602  */
1603 static void
1604 stdout_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1605               int watch, int fd, int events)
1606 {
1607   char buf[4096];
1608   int n;
1609
1610 #if 0
1611   if (g->verbose)
1612     fprintf (stderr,
1613              "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1614              g, g->state, fd, events);
1615 #endif
1616
1617   if (g->fd[1] != fd) {
1618     error (g, _("stdout_event: internal error: %d != %d"), g->fd[1], fd);
1619     return;
1620   }
1621
1622   n = read (fd, buf, sizeof buf);
1623   if (n == 0) {
1624     /* Hopefully this indicates the qemu child process has died. */
1625     child_cleanup (g);
1626     return;
1627   }
1628
1629   if (n == -1) {
1630     if (errno != EINTR && errno != EAGAIN)
1631       perrorf (g, "read");
1632     return;
1633   }
1634
1635   /* In verbose mode, copy all log messages to stderr. */
1636   if (g->verbose)
1637     write (2, buf, n);
1638
1639   /* It's an actual log message, send it upwards if anyone is listening. */
1640   if (g->log_message_cb)
1641     g->log_message_cb (g, g->log_message_cb_data, buf, n);
1642 }
1643
1644 /* The function is called whenever we can read something on the
1645  * guestfsd (daemon inside the guest) communication socket.
1646  */
1647 static void
1648 sock_read_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1649                  int watch, int fd, int events)
1650 {
1651   XDR xdr;
1652   u_int32_t len;
1653   int n;
1654
1655   if (g->verbose)
1656     fprintf (stderr,
1657              "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1658              g, g->state, fd, events);
1659
1660   if (g->sock != fd) {
1661     error (g, _("sock_read_event: internal error: %d != %d"), g->sock, fd);
1662     return;
1663   }
1664
1665   if (g->msg_in_size <= g->msg_in_allocated) {
1666     g->msg_in_allocated += 4096;
1667     g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
1668   }
1669   n = read (g->sock, g->msg_in + g->msg_in_size,
1670             g->msg_in_allocated - g->msg_in_size);
1671   if (n == 0) {
1672     /* Disconnected. */
1673     child_cleanup (g);
1674     return;
1675   }
1676
1677   if (n == -1) {
1678     if (errno != EINTR && errno != EAGAIN)
1679       perrorf (g, "read");
1680     return;
1681   }
1682
1683   g->msg_in_size += n;
1684
1685   /* Have we got enough of a message to be able to process it yet? */
1686  again:
1687   if (g->msg_in_size < 4) return;
1688
1689   xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
1690   if (!xdr_uint32_t (&xdr, &len)) {
1691     error (g, _("can't decode length word"));
1692     goto cleanup;
1693   }
1694
1695   /* Length is normally the length of the message, but when guestfsd
1696    * starts up it sends a "magic" value (longer than any possible
1697    * message).  Check for this.
1698    */
1699   if (len == GUESTFS_LAUNCH_FLAG) {
1700     if (g->state != LAUNCHING)
1701       error (g, _("received magic signature from guestfsd, but in state %d"),
1702              g->state);
1703     else if (g->msg_in_size != 4)
1704       error (g, _("received magic signature from guestfsd, but msg size is %d"),
1705              g->msg_in_size);
1706     else {
1707       g->state = READY;
1708       if (g->launch_done_cb)
1709         g->launch_done_cb (g, g->launch_done_cb_data);
1710     }
1711
1712     goto cleanup;
1713   }
1714
1715   /* This can happen if a cancellation happens right at the end
1716    * of us sending a FileIn parameter to the daemon.  Discard.  The
1717    * daemon should send us an error message next.
1718    */
1719   if (len == GUESTFS_CANCEL_FLAG) {
1720     g->msg_in_size -= 4;
1721     memmove (g->msg_in, g->msg_in+4, g->msg_in_size);
1722     goto again;
1723   }
1724
1725   /* If this happens, it's pretty bad and we've probably lost
1726    * synchronization.
1727    */
1728   if (len > GUESTFS_MESSAGE_MAX) {
1729     error (g, _("message length (%u) > maximum possible size (%d)"),
1730            len, GUESTFS_MESSAGE_MAX);
1731     goto cleanup;
1732   }
1733
1734   if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1735
1736   /* Got the full message, begin processing it. */
1737 #if 0
1738   if (g->verbose) {
1739     int i, j;
1740
1741     for (i = 0; i < g->msg_in_size; i += 16) {
1742       printf ("%04x: ", i);
1743       for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1744         printf ("%02x ", (unsigned char) g->msg_in[j]);
1745       for (; j < i+16; ++j)
1746         printf ("   ");
1747       printf ("|");
1748       for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1749         if (isprint (g->msg_in[j]))
1750           printf ("%c", g->msg_in[j]);
1751         else
1752           printf (".");
1753       for (; j < i+16; ++j)
1754         printf (" ");
1755       printf ("|\n");
1756     }
1757   }
1758 #endif
1759
1760   /* Not in the expected state. */
1761   if (g->state != BUSY)
1762     error (g, _("state %d != BUSY"), g->state);
1763
1764   /* Push the message up to the higher layer. */
1765   if (g->reply_cb)
1766     g->reply_cb (g, g->reply_cb_data, &xdr);
1767   else
1768     /* This message (probably) should never be printed. */
1769     fprintf (stderr, "libguesfs: sock_read_event: !!! dropped message !!!\n");
1770
1771   g->msg_in_size -= len + 4;
1772   memmove (g->msg_in, g->msg_in+len+4, g->msg_in_size);
1773   if (g->msg_in_size > 0) goto again;
1774
1775  cleanup:
1776   /* Free the message buffer if it's grown excessively large. */
1777   if (g->msg_in_allocated > 65536) {
1778     free (g->msg_in);
1779     g->msg_in = NULL;
1780     g->msg_in_size = g->msg_in_allocated = 0;
1781   } else
1782     g->msg_in_size = 0;
1783
1784   xdr_destroy (&xdr);
1785 }
1786
1787 /* The function is called whenever we can write something on the
1788  * guestfsd (daemon inside the guest) communication socket.
1789  */
1790 static void
1791 sock_write_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1792                   int watch, int fd, int events)
1793 {
1794   int n, err;
1795
1796   if (g->verbose)
1797     fprintf (stderr,
1798              "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1799              g, g->state, fd, events);
1800
1801   if (g->sock != fd) {
1802     error (g, _("sock_write_event: internal error: %d != %d"), g->sock, fd);
1803     return;
1804   }
1805
1806   if (g->state != BUSY) {
1807     error (g, _("sock_write_event: state %d != BUSY"), g->state);
1808     return;
1809   }
1810
1811   if (g->verbose)
1812     fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1813              g->msg_out_size - g->msg_out_pos);
1814
1815   n = write (g->sock, g->msg_out + g->msg_out_pos,
1816              g->msg_out_size - g->msg_out_pos);
1817   if (n == -1) {
1818     err = errno;
1819     if (err != EAGAIN)
1820       perrorf (g, "write");
1821     if (err == EPIPE)   /* Disconnected from guest (RHBZ#508713). */
1822       child_cleanup (g);
1823     return;
1824   }
1825
1826   if (g->verbose)
1827     fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1828
1829   g->msg_out_pos += n;
1830
1831   /* More to write? */
1832   if (g->msg_out_pos < g->msg_out_size)
1833     return;
1834
1835   if (g->verbose)
1836     fprintf (stderr, "sock_write_event: done writing, calling send_cb\n");
1837
1838   free (g->msg_out);
1839   g->msg_out = NULL;
1840   g->msg_out_pos = g->msg_out_size = 0;
1841
1842   /* Done writing, call the higher layer. */
1843   if (g->send_cb)
1844     g->send_cb (g, g->send_cb_data);
1845 }
1846
1847 void
1848 guestfs_set_send_callback (guestfs_h *g,
1849                            guestfs_send_cb cb, void *opaque)
1850 {
1851   g->send_cb = cb;
1852   g->send_cb_data = opaque;
1853 }
1854
1855 void
1856 guestfs_set_reply_callback (guestfs_h *g,
1857                             guestfs_reply_cb cb, void *opaque)
1858 {
1859   g->reply_cb = cb;
1860   g->reply_cb_data = opaque;
1861 }
1862
1863 void
1864 guestfs_set_log_message_callback (guestfs_h *g,
1865                                   guestfs_log_message_cb cb, void *opaque)
1866 {
1867   g->log_message_cb = cb;
1868   g->log_message_cb_data = opaque;
1869 }
1870
1871 void
1872 guestfs_set_subprocess_quit_callback (guestfs_h *g,
1873                                       guestfs_subprocess_quit_cb cb, void *opaque)
1874 {
1875   g->subprocess_quit_cb = cb;
1876   g->subprocess_quit_cb_data = opaque;
1877 }
1878
1879 void
1880 guestfs_set_launch_done_callback (guestfs_h *g,
1881                                   guestfs_launch_done_cb cb, void *opaque)
1882 {
1883   g->launch_done_cb = cb;
1884   g->launch_done_cb_data = opaque;
1885 }
1886
1887 /* Access to the handle's main loop and the default main loop. */
1888 void
1889 guestfs_set_main_loop (guestfs_h *g, guestfs_main_loop *main_loop)
1890 {
1891   g->main_loop = main_loop;
1892 }
1893
1894 guestfs_main_loop *
1895 guestfs_get_main_loop (guestfs_h *g)
1896 {
1897   return g->main_loop;
1898 }
1899
1900 guestfs_main_loop *
1901 guestfs_get_default_main_loop (void)
1902 {
1903   return (guestfs_main_loop *) &default_main_loop;
1904 }
1905
1906 /* Change the daemon socket handler so that we are now writing.
1907  * This sets the handle to sock_write_event.
1908  */
1909 int
1910 guestfs__switch_to_sending (guestfs_h *g)
1911 {
1912   if (g->sock_watch >= 0) {
1913     if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1914       error (g, _("remove_handle failed"));
1915       g->sock_watch = -1;
1916       return -1;
1917     }
1918   }
1919
1920   g->sock_watch =
1921     g->main_loop->add_handle (g->main_loop, g, g->sock,
1922                               GUESTFS_HANDLE_WRITABLE,
1923                               sock_write_event, NULL);
1924   if (g->sock_watch == -1) {
1925     error (g, _("add_handle failed"));
1926     return -1;
1927   }
1928
1929   return 0;
1930 }
1931
1932 int
1933 guestfs__switch_to_receiving (guestfs_h *g)
1934 {
1935   if (g->sock_watch >= 0) {
1936     if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1937       error (g, _("remove_handle failed"));
1938       g->sock_watch = -1;
1939       return -1;
1940     }
1941   }
1942
1943   g->sock_watch =
1944     g->main_loop->add_handle (g->main_loop, g, g->sock,
1945                               GUESTFS_HANDLE_READABLE,
1946                               sock_read_event, NULL);
1947   if (g->sock_watch == -1) {
1948     error (g, _("add_handle failed"));
1949     return -1;
1950   }
1951
1952   return 0;
1953 }
1954
1955 /* Dispatch a call (len + header + args) to the remote daemon,
1956  * synchronously (ie. using the guest's main loop to wait until
1957  * it has been sent).  Returns -1 for error, or the serial
1958  * number of the message.
1959  */
1960 static void
1961 send_cb (guestfs_h *g, void *data)
1962 {
1963   guestfs_main_loop *ml = guestfs_get_main_loop (g);
1964
1965   *((int *)data) = 1;
1966   ml->main_loop_quit (ml, g);
1967 }
1968
1969 int
1970 guestfs__send_sync (guestfs_h *g, int proc_nr,
1971                     xdrproc_t xdrp, char *args)
1972 {
1973   struct guestfs_message_header hdr;
1974   XDR xdr;
1975   u_int32_t len;
1976   int serial = g->msg_next_serial++;
1977   int sent;
1978   guestfs_main_loop *ml = guestfs_get_main_loop (g);
1979
1980   if (g->state != BUSY) {
1981     error (g, _("guestfs__send_sync: state %d != BUSY"), g->state);
1982     return -1;
1983   }
1984
1985   /* This is probably an internal error.  Or perhaps we should just
1986    * free the buffer anyway?
1987    */
1988   if (g->msg_out != NULL) {
1989     error (g, _("guestfs__send_sync: msg_out should be NULL"));
1990     return -1;
1991   }
1992
1993   /* We have to allocate this message buffer on the heap because
1994    * it is quite large (although will be mostly unused).  We
1995    * can't allocate it on the stack because in some environments
1996    * we have quite limited stack space available, notably when
1997    * running in the JVM.
1998    */
1999   g->msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
2000   xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
2001
2002   /* Serialize the header. */
2003   hdr.prog = GUESTFS_PROGRAM;
2004   hdr.vers = GUESTFS_PROTOCOL_VERSION;
2005   hdr.proc = proc_nr;
2006   hdr.direction = GUESTFS_DIRECTION_CALL;
2007   hdr.serial = serial;
2008   hdr.status = GUESTFS_STATUS_OK;
2009
2010   if (!xdr_guestfs_message_header (&xdr, &hdr)) {
2011     error (g, _("xdr_guestfs_message_header failed"));
2012     goto cleanup1;
2013   }
2014
2015   /* Serialize the args.  If any, because some message types
2016    * have no parameters.
2017    */
2018   if (xdrp) {
2019     if (!(*xdrp) (&xdr, args)) {
2020       error (g, _("dispatch failed to marshal args"));
2021       goto cleanup1;
2022     }
2023   }
2024
2025   /* Get the actual length of the message, resize the buffer to match
2026    * the actual length, and write the length word at the beginning.
2027    */
2028   len = xdr_getpos (&xdr);
2029   xdr_destroy (&xdr);
2030
2031   g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2032   g->msg_out_size = len + 4;
2033   g->msg_out_pos = 0;
2034
2035   xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2036   xdr_uint32_t (&xdr, &len);
2037
2038   if (guestfs__switch_to_sending (g) == -1)
2039     goto cleanup1;
2040
2041   sent = 0;
2042   guestfs_set_send_callback (g, send_cb, &sent);
2043   if (ml->main_loop_run (ml, g) == -1)
2044     goto cleanup1;
2045   if (sent != 1) {
2046     error (g, _("send failed, see earlier error messages"));
2047     goto cleanup1;
2048   }
2049
2050   return serial;
2051
2052  cleanup1:
2053   free (g->msg_out);
2054   g->msg_out = NULL;
2055   g->msg_out_size = 0;
2056   return -1;
2057 }
2058
2059 static int cancel = 0; /* XXX Implement file cancellation. */
2060 static int send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t len);
2061 static int send_file_data_sync (guestfs_h *g, const char *buf, size_t len);
2062 static int send_file_cancellation_sync (guestfs_h *g);
2063 static int send_file_complete_sync (guestfs_h *g);
2064
2065 /* Synchronously send a file.
2066  * Returns:
2067  *   0 OK
2068  *   -1 error
2069  *   -2 daemon cancelled (we must read the error message)
2070  */
2071 int
2072 guestfs__send_file_sync (guestfs_h *g, const char *filename)
2073 {
2074   char buf[GUESTFS_MAX_CHUNK_SIZE];
2075   int fd, r, err;
2076
2077   fd = open (filename, O_RDONLY);
2078   if (fd == -1) {
2079     perrorf (g, "open: %s", filename);
2080     send_file_cancellation_sync (g);
2081     /* Daemon sees cancellation and won't reply, so caller can
2082      * just return here.
2083      */
2084     return -1;
2085   }
2086
2087   /* Send file in chunked encoding. */
2088   while (!cancel) {
2089     r = read (fd, buf, sizeof buf);
2090     if (r == -1 && (errno == EINTR || errno == EAGAIN))
2091       continue;
2092     if (r <= 0) break;
2093     err = send_file_data_sync (g, buf, r);
2094     if (err < 0) {
2095       if (err == -2)            /* daemon sent cancellation */
2096         send_file_cancellation_sync (g);
2097       return err;
2098     }
2099   }
2100
2101   if (cancel) {                 /* cancel from either end */
2102     send_file_cancellation_sync (g);
2103     return -1;
2104   }
2105
2106   if (r == -1) {
2107     perrorf (g, "read: %s", filename);
2108     send_file_cancellation_sync (g);
2109     return -1;
2110   }
2111
2112   /* End of file, but before we send that, we need to close
2113    * the file and check for errors.
2114    */
2115   if (close (fd) == -1) {
2116     perrorf (g, "close: %s", filename);
2117     send_file_cancellation_sync (g);
2118     return -1;
2119   }
2120
2121   return send_file_complete_sync (g);
2122 }
2123
2124 /* Send a chunk of file data. */
2125 static int
2126 send_file_data_sync (guestfs_h *g, const char *buf, size_t len)
2127 {
2128   return send_file_chunk_sync (g, 0, buf, len);
2129 }
2130
2131 /* Send a cancellation message. */
2132 static int
2133 send_file_cancellation_sync (guestfs_h *g)
2134 {
2135   return send_file_chunk_sync (g, 1, NULL, 0);
2136 }
2137
2138 /* Send a file complete chunk. */
2139 static int
2140 send_file_complete_sync (guestfs_h *g)
2141 {
2142   char buf[1];
2143   return send_file_chunk_sync (g, 0, buf, 0);
2144 }
2145
2146 /* Send a chunk, cancellation or end of file, synchronously (ie. wait
2147  * for it to go).
2148  */
2149 static int check_for_daemon_cancellation (guestfs_h *g);
2150
2151 static int
2152 send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t buflen)
2153 {
2154   u_int32_t len;
2155   int sent;
2156   guestfs_chunk chunk;
2157   XDR xdr;
2158   guestfs_main_loop *ml = guestfs_get_main_loop (g);
2159
2160   if (g->state != BUSY) {
2161     error (g, _("send_file_chunk_sync: state %d != READY"), g->state);
2162     return -1;
2163   }
2164
2165   /* This is probably an internal error.  Or perhaps we should just
2166    * free the buffer anyway?
2167    */
2168   if (g->msg_out != NULL) {
2169     error (g, _("guestfs__send_sync: msg_out should be NULL"));
2170     return -1;
2171   }
2172
2173   /* Did the daemon send a cancellation message? */
2174   if (check_for_daemon_cancellation (g)) {
2175     if (g->verbose)
2176       fprintf (stderr, "got daemon cancellation\n");
2177     return -2;
2178   }
2179
2180   /* Allocate the chunk buffer.  Don't use the stack to avoid
2181    * excessive stack usage and unnecessary copies.
2182    */
2183   g->msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
2184   xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
2185
2186   /* Serialize the chunk. */
2187   chunk.cancel = cancel;
2188   chunk.data.data_len = buflen;
2189   chunk.data.data_val = (char *) buf;
2190
2191   if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2192     error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
2193            buf, buflen);
2194     xdr_destroy (&xdr);
2195     goto cleanup1;
2196   }
2197
2198   len = xdr_getpos (&xdr);
2199   xdr_destroy (&xdr);
2200
2201   /* Reduce the size of the outgoing message buffer to the real length. */
2202   g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2203   g->msg_out_size = len + 4;
2204   g->msg_out_pos = 0;
2205
2206   xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2207   xdr_uint32_t (&xdr, &len);
2208
2209   if (guestfs__switch_to_sending (g) == -1)
2210     goto cleanup1;
2211
2212   sent = 0;
2213   guestfs_set_send_callback (g, send_cb, &sent);
2214   if (ml->main_loop_run (ml, g) == -1)
2215     goto cleanup1;
2216   if (sent != 1) {
2217     error (g, _("send file chunk failed, see earlier error messages"));
2218     goto cleanup1;
2219   }
2220
2221   return 0;
2222
2223  cleanup1:
2224   free (g->msg_out);
2225   g->msg_out = NULL;
2226   g->msg_out_size = 0;
2227   return -1;
2228 }
2229
2230 /* At this point we are sending FileIn file(s) to the guest, and not
2231  * expecting to read anything, so if we do read anything, it must be
2232  * a cancellation message.  This checks for this case without blocking.
2233  */
2234 static int
2235 check_for_daemon_cancellation (guestfs_h *g)
2236 {
2237   fd_set rset;
2238   struct timeval tv;
2239   int r;
2240   char buf[4];
2241   uint32_t flag;
2242   XDR xdr;
2243
2244   FD_ZERO (&rset);
2245   FD_SET (g->sock, &rset);
2246   tv.tv_sec = 0;
2247   tv.tv_usec = 0;
2248   r = select (g->sock+1, &rset, NULL, NULL, &tv);
2249   if (r == -1) {
2250     perrorf (g, "select");
2251     return 0;
2252   }
2253   if (r == 0)
2254     return 0;
2255
2256   /* Read the message from the daemon. */
2257   r = xread (g->sock, buf, sizeof buf);
2258   if (r == -1) {
2259     perrorf (g, "read");
2260     return 0;
2261   }
2262
2263   xdrmem_create (&xdr, buf, sizeof buf, XDR_DECODE);
2264   xdr_uint32_t (&xdr, &flag);
2265   xdr_destroy (&xdr);
2266
2267   if (flag != GUESTFS_CANCEL_FLAG) {
2268     error (g, _("check_for_daemon_cancellation: read 0x%x from daemon, expected 0x%x\n"),
2269            flag, GUESTFS_CANCEL_FLAG);
2270     return 0;
2271   }
2272
2273   return 1;
2274 }
2275
2276 /* Synchronously receive a file. */
2277
2278 /* Returns -1 = error, 0 = EOF, 1 = more data */
2279 static int receive_file_data_sync (guestfs_h *g, void **buf, size_t *len);
2280
2281 int
2282 guestfs__receive_file_sync (guestfs_h *g, const char *filename)
2283 {
2284   void *buf;
2285   int fd, r;
2286   size_t len;
2287
2288   fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2289   if (fd == -1) {
2290     perrorf (g, "open: %s", filename);
2291     goto cancel;
2292   }
2293
2294   /* Receive the file in chunked encoding. */
2295   while ((r = receive_file_data_sync (g, &buf, &len)) >= 0) {
2296     if (xwrite (fd, buf, len) == -1) {
2297       perrorf (g, "%s: write", filename);
2298       free (buf);
2299       goto cancel;
2300     }
2301     free (buf);
2302     if (r == 0) break; /* End of file. */
2303   }
2304
2305   if (r == -1) {
2306     error (g, _("%s: error in chunked encoding"), filename);
2307     return -1;
2308   }
2309
2310   if (close (fd) == -1) {
2311     perrorf (g, "close: %s", filename);
2312     return -1;
2313   }
2314
2315   return 0;
2316
2317  cancel: ;
2318   /* Send cancellation message to daemon, then wait until it
2319    * cancels (just throwing away data).
2320    */
2321   XDR xdr;
2322   char fbuf[4];
2323   uint32_t flag = GUESTFS_CANCEL_FLAG;
2324
2325   if (g->verbose)
2326     fprintf (stderr, "%s: waiting for daemon to acknowledge cancellation\n",
2327              __func__);
2328
2329   xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
2330   xdr_uint32_t (&xdr, &flag);
2331   xdr_destroy (&xdr);
2332
2333   if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
2334     perrorf (g, _("write to daemon socket"));
2335     return -1;
2336   }
2337
2338   while ((r = receive_file_data_sync (g, NULL, NULL)) > 0)
2339     ;                           /* just discard it */
2340
2341   return -1;
2342 }
2343
2344 /* Note that the reply callback can be called multiple times before
2345  * the main loop quits and we get back to the synchronous code.  So
2346  * we have to be prepared to save multiple chunks on a list here.
2347  */
2348 struct receive_file_ctx {
2349   int count;                    /* 0 if receive_file_cb not called, or
2350                                  * else count number of chunks.
2351                                  */
2352   guestfs_chunk *chunks;        /* Array of chunks. */
2353 };
2354
2355 static void
2356 free_chunks (struct receive_file_ctx *ctx)
2357 {
2358   int i;
2359
2360   for (i = 0; i < ctx->count; ++i)
2361     free (ctx->chunks[i].data.data_val);
2362
2363   free (ctx->chunks);
2364 }
2365
2366 static void
2367 receive_file_cb (guestfs_h *g, void *data, XDR *xdr)
2368 {
2369   guestfs_main_loop *ml = guestfs_get_main_loop (g);
2370   struct receive_file_ctx *ctx = (struct receive_file_ctx *) data;
2371   guestfs_chunk chunk;
2372
2373   if (ctx->count == -1)         /* Parse error occurred previously. */
2374     return;
2375
2376   ml->main_loop_quit (ml, g);
2377
2378   memset (&chunk, 0, sizeof chunk);
2379
2380   if (!xdr_guestfs_chunk (xdr, &chunk)) {
2381     error (g, _("failed to parse file chunk"));
2382     free_chunks (ctx);
2383     ctx->chunks = NULL;
2384     ctx->count = -1;
2385     return;
2386   }
2387
2388   /* Copy the chunk to the list. */
2389   ctx->chunks = safe_realloc (g, ctx->chunks,
2390                               sizeof (guestfs_chunk) * (ctx->count+1));
2391   ctx->chunks[ctx->count] = chunk;
2392   ctx->count++;
2393 }
2394
2395 /* Receive a chunk of file data. */
2396 /* Returns -1 = error, 0 = EOF, 1 = more data */
2397 static int
2398 receive_file_data_sync (guestfs_h *g, void **buf, size_t *len_r)
2399 {
2400   struct receive_file_ctx ctx;
2401   guestfs_main_loop *ml = guestfs_get_main_loop (g);
2402   int i;
2403   size_t len;
2404
2405   ctx.count = 0;
2406   ctx.chunks = NULL;
2407
2408   guestfs_set_reply_callback (g, receive_file_cb, &ctx);
2409   (void) ml->main_loop_run (ml, g);
2410   guestfs_set_reply_callback (g, NULL, NULL);
2411
2412   if (ctx.count == 0) {
2413     error (g, _("receive_file_data_sync: reply callback not called\n"));
2414     return -1;
2415   }
2416
2417   if (ctx.count == -1) {
2418     error (g, _("receive_file_data_sync: parse error in reply callback\n"));
2419     /* callback already freed the chunks */
2420     return -1;
2421   }
2422
2423   if (g->verbose)
2424     fprintf (stderr, "receive_file_data_sync: got %d chunks\n", ctx.count);
2425
2426   /* Process each chunk in the list. */
2427   if (buf) *buf = NULL;         /* Accumulate data in this buffer. */
2428   len = 0;
2429
2430   for (i = 0; i < ctx.count; ++i) {
2431     if (ctx.chunks[i].cancel) {
2432       error (g, _("file receive cancelled by daemon"));
2433       free_chunks (&ctx);
2434       if (buf) free (*buf);
2435       if (len_r) *len_r = 0;
2436       return -1;
2437     }
2438
2439     if (ctx.chunks[i].data.data_len == 0) { /* end of transfer */
2440       free_chunks (&ctx);
2441       if (len_r) *len_r = len;
2442       return 0;
2443     }
2444
2445     if (buf) {
2446       *buf = safe_realloc (g, *buf, len + ctx.chunks[i].data.data_len);
2447       memcpy (*buf+len, ctx.chunks[i].data.data_val,
2448               ctx.chunks[i].data.data_len);
2449     }
2450     len += ctx.chunks[i].data.data_len;
2451   }
2452
2453   if (len_r) *len_r = len;
2454   free_chunks (&ctx);
2455   return 1;
2456 }
2457
2458 /* This is the default main loop implementation, using select(2). */
2459
2460 static int
2461 select_add_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd, int events,
2462                    guestfs_handle_event_cb cb, void *data)
2463 {
2464   struct select_main_loop *ml = (struct select_main_loop *) mlv;
2465
2466   if (fd < 0 || fd >= FD_SETSIZE) {
2467     error (g, _("fd %d is out of range"), fd);
2468     return -1;
2469   }
2470
2471   if ((events & ~(GUESTFS_HANDLE_READABLE |
2472                   GUESTFS_HANDLE_WRITABLE |
2473                   GUESTFS_HANDLE_HANGUP |
2474                   GUESTFS_HANDLE_ERROR)) != 0) {
2475     error (g, _("set of events (0x%x) contains unknown events"), events);
2476     return -1;
2477   }
2478
2479   if (events == 0) {
2480     error (g, _("set of events is empty"));
2481     return -1;
2482   }
2483
2484   if (FD_ISSET (fd, &ml->rset) ||
2485       FD_ISSET (fd, &ml->wset) ||
2486       FD_ISSET (fd, &ml->xset)) {
2487     error (g, _("fd %d is already registered"), fd);
2488     return -1;
2489   }
2490
2491   if (cb == NULL) {
2492     error (g, _("callback is NULL"));
2493     return -1;
2494   }
2495
2496   if ((events & GUESTFS_HANDLE_READABLE))
2497     FD_SET (fd, &ml->rset);
2498   if ((events & GUESTFS_HANDLE_WRITABLE))
2499     FD_SET (fd, &ml->wset);
2500   if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
2501     FD_SET (fd, &ml->xset);
2502
2503   if (fd > ml->max_fd) {
2504     ml->max_fd = fd;
2505     ml->handle_cb_data =
2506       safe_realloc (g, ml->handle_cb_data,
2507                     sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2508   }
2509   ml->handle_cb_data[fd].cb = cb;
2510   ml->handle_cb_data[fd].g = g;
2511   ml->handle_cb_data[fd].data = data;
2512
2513   ml->nr_fds++;
2514
2515   /* Any integer >= 0 can be the handle, and this is as good as any ... */
2516   return fd;
2517 }
2518
2519 static int
2520 select_remove_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd)
2521 {
2522   struct select_main_loop *ml = (struct select_main_loop *) mlv;
2523
2524   if (fd < 0 || fd >= FD_SETSIZE) {
2525     error (g, _("fd %d is out of range"), fd);
2526     return -1;
2527   }
2528
2529   if (!FD_ISSET (fd, &ml->rset) &&
2530       !FD_ISSET (fd, &ml->wset) &&
2531       !FD_ISSET (fd, &ml->xset)) {
2532     error (g, _("fd %d was not registered"), fd);
2533     return -1;
2534   }
2535
2536   FD_CLR (fd, &ml->rset);
2537   FD_CLR (fd, &ml->wset);
2538   FD_CLR (fd, &ml->xset);
2539
2540   if (fd == ml->max_fd) {
2541     ml->max_fd--;
2542     ml->handle_cb_data =
2543       safe_realloc (g, ml->handle_cb_data,
2544                     sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2545   }
2546
2547   ml->nr_fds--;
2548
2549   return 0;
2550 }
2551
2552 static int
2553 select_add_timeout (guestfs_main_loop *mlv, guestfs_h *g, int interval,
2554                     guestfs_handle_timeout_cb cb, void *data)
2555 {
2556   //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2557
2558   abort ();                     /* XXX not implemented yet */
2559 }
2560
2561 static int
2562 select_remove_timeout (guestfs_main_loop *mlv, guestfs_h *g, int timer)
2563 {
2564   //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2565
2566   abort ();                     /* XXX not implemented yet */
2567 }
2568
2569 /* The 'g' parameter is just used for error reporting.  Events
2570  * for multiple handles can be dispatched by running the main
2571  * loop.
2572  */
2573 static int
2574 select_main_loop_run (guestfs_main_loop *mlv, guestfs_h *g)
2575 {
2576   struct select_main_loop *ml = (struct select_main_loop *) mlv;
2577   int fd, r, events;
2578   fd_set rset2, wset2, xset2;
2579
2580   if (ml->is_running) {
2581     error (g, _("select_main_loop_run: this cannot be called recursively"));
2582     return -1;
2583   }
2584
2585   ml->is_running = 1;
2586
2587   while (ml->is_running) {
2588     if (ml->nr_fds == 0)
2589       break;
2590
2591     rset2 = ml->rset;
2592     wset2 = ml->wset;
2593     xset2 = ml->xset;
2594     r = select (ml->max_fd+1, &rset2, &wset2, &xset2, NULL);
2595     if (r == -1) {
2596       if (errno == EINTR || errno == EAGAIN)
2597         continue;
2598       perrorf (g, "select");
2599       ml->is_running = 0;
2600       return -1;
2601     }
2602
2603     for (fd = 0; r > 0 && fd <= ml->max_fd; ++fd) {
2604       events = 0;
2605       if (FD_ISSET (fd, &rset2))
2606         events |= GUESTFS_HANDLE_READABLE;
2607       if (FD_ISSET (fd, &wset2))
2608         events |= GUESTFS_HANDLE_WRITABLE;
2609       if (FD_ISSET (fd, &xset2))
2610         events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
2611       if (events) {
2612         r--;
2613         ml->handle_cb_data[fd].cb ((guestfs_main_loop *) ml,
2614                                    ml->handle_cb_data[fd].g,
2615                                    ml->handle_cb_data[fd].data,
2616                                    fd, fd, events);
2617       }
2618     }
2619   }
2620
2621   ml->is_running = 0;
2622   return 0;
2623 }
2624
2625 static int
2626 select_main_loop_quit (guestfs_main_loop *mlv, guestfs_h *g)
2627 {
2628   struct select_main_loop *ml = (struct select_main_loop *) mlv;
2629
2630   /* Note that legitimately ml->is_running can be zero when
2631    * this function is called.
2632    */
2633
2634   ml->is_running = 0;
2635   return 0;
2636 }