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