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