2 * Copyright (C) 2009 Red Hat Inc.
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.
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.
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
21 #define _BSD_SOURCE /* for mkdtemp, usleep */
22 #define _GNU_SOURCE /* for vasprintf, GNU strerror_r, strchrnul */
34 #include <sys/select.h>
37 #include <rpc/types.h>
44 #ifdef HAVE_SYS_TYPES_H
45 #include <sys/types.h>
48 #ifdef HAVE_SYS_WAIT_H
52 #ifdef HAVE_SYS_SOCKET_H
53 #include <sys/socket.h>
61 #include "guestfs_protocol.h"
65 #define _(str) dgettext(PACKAGE, (str))
66 #define N_(str) dgettext(PACKAGE, (str))
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
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);
84 static void close_handles (void);
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);
93 /* Default select-based main loop. */
94 struct select_handle_cb_data {
95 guestfs_handle_event_cb cb;
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;
109 /* Additional private data: */
118 struct select_handle_cb_data *handle_cb_data;
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,
130 /* XXX hopefully .rset, .wset, .xset are initialized to the empty
131 * set by the normal action of everything being initialized to zero.
136 .handle_cb_data = NULL,
139 #define UNIX_PATH_MAX 108
141 /* Also in guestfsd.c */
142 #define VMCHANNEL_PORT 6666
143 #define VMCHANNEL_ADDR "10.0.2.4"
145 /* GuestFS handle and connection. */
146 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
150 struct guestfs_h *next; /* Linked list of open handles. */
152 /* State: see the state machine diagram in the man page guestfs(3). */
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. */
161 int stdout_watch; /* Watches qemu stdout for log messages. */
162 int sock_watch; /* Watches daemon comm socket. */
164 char *tmpdir; /* Temporary directory containing socket. */
166 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
168 char **cmdline; /* Qemu command line. */
174 char *path; /* Path to kernel, initrd. */
175 char *qemu; /* Qemu binary. */
176 char *append; /* Append to kernel command line. */
178 int memsize; /* Size of RAM (megabytes). */
183 guestfs_abort_cb abort_cb;
184 guestfs_error_handler_cb error_cb;
185 void * error_cb_data;
186 guestfs_send_cb send_cb;
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;
197 /* Main loop used by this handle. */
198 guestfs_main_loop *main_loop;
200 /* Messages sent and received from the daemon. */
202 int msg_in_size, msg_in_allocated;
204 int msg_out_size, msg_out_pos;
209 static guestfs_h *handles = NULL;
210 static int atexit_handler_set = 0;
213 guestfs_create (void)
218 g = malloc (sizeof (*g));
221 memset (g, 0, sizeof (*g));
228 g->stdout_watch = -1;
232 g->error_cb = default_error_cb;
233 g->error_cb_data = NULL;
235 str = getenv ("LIBGUESTFS_DEBUG");
236 g->verbose = str != NULL && strcmp (str, "1") == 0;
238 str = getenv ("LIBGUESTFS_PATH");
239 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
240 if (!g->path) goto error;
242 str = getenv ("LIBGUESTFS_QEMU");
243 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
244 if (!g->qemu) goto error;
246 str = getenv ("LIBGUESTFS_APPEND");
248 g->append = strdup (str);
249 if (!g->append) goto error;
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.
259 str = getenv ("LIBGUESTFS_MEMSIZE");
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");
268 g->main_loop = guestfs_get_default_main_loop ();
270 /* Start with large serial numbers so they are easy to spot
271 * inside the protocol.
273 g->msg_next_serial = 0x00123400;
275 /* Link the handles onto a global list. This is the one area
276 * where the library needs to be made thread-safe. (XXX)
278 /* acquire mutex (XXX) */
281 if (!atexit_handler_set) {
282 atexit (close_handles);
283 atexit_handler_set = 1;
285 /* release mutex (XXX) */
288 fprintf (stderr, "new guestfs handle %p\n", g);
301 guestfs_close (guestfs_h *g)
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"));
314 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
316 /* Try to sync if autosync flag is set. */
317 if (g->autosync && g->state == READY) {
318 guestfs_umount_all (g);
322 /* Remove any handlers that might be called back before we kill the
325 g->log_message_cb = NULL;
327 if (g->state != CONFIG)
328 guestfs_kill_subprocess (g);
331 snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
334 snprintf (filename, sizeof filename, "%s/initrd", g->tmpdir);
337 snprintf (filename, sizeof filename, "%s/kernel", g->tmpdir);
346 for (i = 0; i < g->cmdline_size; ++i)
347 free (g->cmdline[i]);
351 /* Mark the handle as dead before freeing it. */
352 g->state = NO_HANDLE;
354 /* acquire mutex (XXX) */
358 for (gg = handles; gg->next != g; gg = gg->next)
362 /* release mutex (XXX) */
366 free (g->last_error);
371 free (g->qemu_version);
375 /* Close all open handles (called from atexit(3)). */
379 while (handles) guestfs_close (handles);
383 guestfs_last_error (guestfs_h *g)
385 return g->last_error;
389 set_last_error (guestfs_h *g, const char *msg)
391 free (g->last_error);
392 g->last_error = strdup (msg);
396 default_error_cb (guestfs_h *g, void *data, const char *msg)
398 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
402 guestfs_error (guestfs_h *g, const char *fs, ...)
408 int err = vasprintf (&msg, fs, args);
413 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
414 set_last_error (g, msg);
420 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
427 vasprintf (&msg, fs, args);
432 strerror_r (err, buf, sizeof buf);
436 buf = strerror_r (err, _buf, sizeof _buf);
439 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
443 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
444 set_last_error (g, msg);
450 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
452 void *ptr = malloc (nbytes);
453 if (nbytes > 0 && !ptr) g->abort_cb ();
457 /* Return 1 if an array of N objects, each of size S, cannot exist due
458 to size arithmetic overflow. S must be positive and N must be
459 nonnegative. This is a macro, not an inline function, so that it
460 works correctly even when SIZE_MAX < N.
462 By gnulib convention, SIZE_MAX represents overflow in size
463 calculations, so the conservative dividend to use here is
464 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
465 However, malloc (SIZE_MAX) fails on all known hosts where
466 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
467 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
468 branch when S is known to be 1. */
469 # define xalloc_oversized(n, s) \
470 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
472 /* Technically we should add an autoconf test for this, testing for the desired
473 functionality, like what's done in gnulib, but for now, this is fine. */
474 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
476 /* Allocate zeroed memory for N elements of S bytes, with error
477 checking. S must be nonzero. */
479 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
481 /* From gnulib's calloc function in xmalloc.c. */
483 /* Test for overflow, since some calloc implementations don't have
484 proper overflow checks. But omit overflow and size-zero tests if
485 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
486 returns NULL if successful. */
487 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
488 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
494 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
496 void *p = realloc (ptr, nbytes);
497 if (nbytes > 0 && !p) g->abort_cb ();
502 guestfs_safe_strdup (guestfs_h *g, const char *str)
504 char *s = strdup (str);
505 if (!s) g->abort_cb ();
510 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
512 void *p = malloc (size);
513 if (!p) g->abort_cb ();
514 memcpy (p, ptr, size);
519 xwrite (int fd, const void *buf, size_t len)
524 r = write (fd, buf, len);
536 xread (int fd, void *buf, size_t len)
541 r = read (fd, buf, len);
543 if (errno == EINTR || errno == EAGAIN)
556 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
562 guestfs_get_out_of_memory_handler (guestfs_h *g)
568 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
571 g->error_cb_data = data;
574 guestfs_error_handler_cb
575 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
577 if (data_rtn) *data_rtn = g->error_cb_data;
582 guestfs_set_verbose (guestfs_h *g, int v)
589 guestfs_get_verbose (guestfs_h *g)
595 guestfs_set_autosync (guestfs_h *g, int a)
602 guestfs_get_autosync (guestfs_h *g)
608 guestfs_set_path (guestfs_h *g, const char *path)
615 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
620 guestfs_get_path (guestfs_h *g)
626 guestfs_set_qemu (guestfs_h *g, const char *qemu)
631 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
636 guestfs_get_qemu (guestfs_h *g)
642 guestfs_set_append (guestfs_h *g, const char *append)
647 g->append = append ? safe_strdup (g, append) : NULL;
652 guestfs_get_append (guestfs_h *g)
658 guestfs_set_memsize (guestfs_h *g, int memsize)
660 g->memsize = memsize;
665 guestfs_get_memsize (guestfs_h *g)
670 /* Add a string to the current command line. */
672 incr_cmdline_size (guestfs_h *g)
674 if (g->cmdline == NULL) {
675 /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
677 g->cmdline = safe_malloc (g, sizeof (char *));
678 g->cmdline[0] = NULL;
682 g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
686 add_cmdline (guestfs_h *g, const char *str)
688 if (g->state != CONFIG) {
690 _("command line cannot be altered after qemu subprocess launched"));
694 incr_cmdline_size (g);
695 g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
700 guestfs_config (guestfs_h *g,
701 const char *qemu_param, const char *qemu_value)
703 if (qemu_param[0] != '-') {
704 error (g, _("guestfs_config: parameter must begin with '-' character"));
708 /* A bit fascist, but the user will probably break the extra
709 * parameters that we add if they try to set any of these.
711 if (strcmp (qemu_param, "-kernel") == 0 ||
712 strcmp (qemu_param, "-initrd") == 0 ||
713 strcmp (qemu_param, "-nographic") == 0 ||
714 strcmp (qemu_param, "-serial") == 0 ||
715 strcmp (qemu_param, "-full-screen") == 0 ||
716 strcmp (qemu_param, "-std-vga") == 0 ||
717 strcmp (qemu_param, "-vnc") == 0) {
718 error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
722 if (add_cmdline (g, qemu_param) != 0) return -1;
724 if (qemu_value != NULL) {
725 if (add_cmdline (g, qemu_value) != 0) return -1;
732 guestfs_add_drive (guestfs_h *g, const char *filename)
734 size_t len = strlen (filename) + 64;
737 if (strchr (filename, ',') != NULL) {
738 error (g, _("filename cannot contain ',' (comma) character"));
742 if (access (filename, F_OK) == -1) {
743 perrorf (g, "%s", filename);
747 /* cache=off improves reliability in the event of a host crash. */
748 snprintf (buf, len, "file=%s,cache=off,if=%s", filename, DRIVE_IF);
750 return guestfs_config (g, "-drive", buf);
754 guestfs_add_drive_ro (guestfs_h *g, const char *filename)
756 size_t len = strlen (filename) + 64;
759 if (strchr (filename, ',') != NULL) {
760 error (g, _("filename cannot contain ',' (comma) character"));
764 if (access (filename, F_OK) == -1) {
765 perrorf (g, "%s", filename);
769 snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, DRIVE_IF);
771 return guestfs_config (g, "-drive", buf);
775 guestfs_add_cdrom (guestfs_h *g, const char *filename)
777 if (strchr (filename, ',') != NULL) {
778 error (g, _("filename cannot contain ',' (comma) character"));
782 if (access (filename, F_OK) == -1) {
783 perrorf (g, "%s", filename);
787 return guestfs_config (g, "-cdrom", filename);
790 /* Returns true iff file is contained in dir. */
792 dir_contains_file (const char *dir, const char *file)
794 int dirlen = strlen (dir);
795 int filelen = strlen (file);
796 int len = dirlen+filelen+2;
799 snprintf (path, len, "%s/%s", dir, file);
800 return access (path, F_OK) == 0;
803 /* Returns true iff every listed file is contained in 'dir'. */
805 dir_contains_files (const char *dir, ...)
810 va_start (args, dir);
811 while ((file = va_arg (args, const char *)) != NULL) {
812 if (!dir_contains_file (dir, file)) {
821 static int build_supermin_appliance (guestfs_h *g, const char *path, char **kernel, char **initrd);
822 static int test_qemu (guestfs_h *g);
823 static int qemu_supports (guestfs_h *g, const char *option);
825 static const char *kernel_name = "vmlinuz." REPO "." host_cpu;
826 static const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
827 static const char *supermin_name =
828 "initramfs." REPO "." host_cpu ".supermin.img";
829 static const char *supermin_hostfiles_name =
830 "initramfs." REPO "." host_cpu ".supermin.hostfiles";
833 guestfs_launch (guestfs_h *g)
835 static const char *dir_template = "/tmp/libguestfsXXXXXX";
840 char *path, *pelem, *pend;
841 char *kernel = NULL, *initrd = NULL;
843 struct sockaddr_un addr;
847 error (g, _("you must call guestfs_add_drive before guestfs_launch"));
851 if (g->state != CONFIG) {
852 error (g, _("qemu has already been launched"));
856 /* Make the temporary directory. */
858 g->tmpdir = safe_strdup (g, dir_template);
859 if (mkdtemp (g->tmpdir) == NULL) {
860 perrorf (g, _("%s: cannot create temporary directory"), dir_template);
865 /* First search g->path for the supermin appliance, and try to
866 * synthesize a kernel and initrd from that. If it fails, we
867 * try the path search again looking for a backup ordinary
870 pelem = path = safe_strdup (g, g->path);
872 pend = strchrnul (pelem, ':');
873 pmore = *pend == ':';
877 /* Empty element of "." means cwd. */
878 if (len == 0 || (len == 1 && *pelem == '.')) {
881 "looking for supermin appliance in current directory\n");
882 if (dir_contains_files (".",
883 supermin_name, supermin_hostfiles_name,
884 "kmod.whitelist", NULL)) {
885 if (build_supermin_appliance (g, ".", &kernel, &initrd) == -1)
890 /* Look at <path>/supermin* etc. */
893 fprintf (stderr, "looking for supermin appliance in %s\n", pelem);
895 if (dir_contains_files (pelem,
896 supermin_name, supermin_hostfiles_name,
897 "kmod.whitelist", NULL)) {
898 if (build_supermin_appliance (g, pelem, &kernel, &initrd) == -1)
909 if (kernel == NULL || initrd == NULL) {
910 /* Search g->path for the kernel and initrd. */
911 pelem = path = safe_strdup (g, g->path);
913 pend = strchrnul (pelem, ':');
914 pmore = *pend == ':';
918 /* Empty element or "." means cwd. */
919 if (len == 0 || (len == 1 && *pelem == '.')) {
922 "looking for appliance in current directory\n");
923 if (dir_contains_files (".", kernel_name, initrd_name, NULL)) {
924 kernel = safe_strdup (g, kernel_name);
925 initrd = safe_strdup (g, initrd_name);
929 /* Look at <path>/kernel etc. */
932 fprintf (stderr, "looking for appliance in %s\n", pelem);
934 if (dir_contains_files (pelem, kernel_name, initrd_name, NULL)) {
935 kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
936 initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
937 sprintf (kernel, "%s/%s", pelem, kernel_name);
938 sprintf (initrd, "%s/%s", pelem, initrd_name);
949 if (kernel == NULL || initrd == NULL) {
950 error (g, _("cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)"),
951 kernel_name, initrd_name, g->path);
955 /* Get qemu help text and version. */
956 if (test_qemu (g) == -1)
959 /* Make the vmchannel socket. */
960 snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
963 if (pipe (wfd) == -1 || pipe (rfd) == -1) {
978 if (r == 0) { /* Child (qemu). */
981 char memsize_str[256];
983 /* Set up the full command line. Do this in the subprocess so we
984 * don't need to worry about cleaning up.
986 g->cmdline[0] = g->qemu;
988 /* Construct the -net channel parameter for qemu. */
989 snprintf (vmchannel, sizeof vmchannel,
990 "channel,%d:unix:%s,server,nowait",
991 VMCHANNEL_PORT, unixsock);
993 /* Linux kernel command line. */
994 snprintf (append, sizeof append,
995 "panic=1 console=ttyS0 guestfs=%s:%d%s%s%s",
996 VMCHANNEL_ADDR, VMCHANNEL_PORT,
997 g->verbose ? " guestfs_verbose=1" : "",
998 g->append ? " " : "", g->append ? g->append : "");
1000 snprintf (memsize_str, sizeof memsize_str, "%d", g->memsize);
1002 add_cmdline (g, "-m");
1003 add_cmdline (g, memsize_str);
1004 add_cmdline (g, "-no-reboot"); /* Force exit instead of reboot on panic */
1005 add_cmdline (g, "-kernel");
1006 add_cmdline (g, (char *) kernel);
1007 add_cmdline (g, "-initrd");
1008 add_cmdline (g, (char *) initrd);
1009 add_cmdline (g, "-append");
1010 add_cmdline (g, append);
1011 add_cmdline (g, "-nographic");
1012 add_cmdline (g, "-serial");
1013 add_cmdline (g, "stdio");
1014 add_cmdline (g, "-net");
1015 add_cmdline (g, vmchannel);
1016 add_cmdline (g, "-net");
1017 add_cmdline (g, "user,vlan=0");
1018 add_cmdline (g, "-net");
1019 add_cmdline (g, "nic,model=virtio,vlan=0");
1021 /* These options recommended by KVM developers to improve reliability. */
1022 if (qemu_supports (g, "-no-hpet"))
1023 add_cmdline (g, "-no-hpet");
1025 if (qemu_supports (g, "-rtc-td-hack"))
1026 add_cmdline (g, "-rtc-td-hack");
1028 /* Finish off the command line. */
1029 incr_cmdline_size (g);
1030 g->cmdline[g->cmdline_size-1] = NULL;
1033 fprintf (stderr, "%s", g->qemu);
1034 for (i = 0; g->cmdline[i]; ++i)
1035 fprintf (stderr, " %s", g->cmdline[i]);
1036 fprintf (stderr, "\n");
1039 /* Set up stdin, stdout. */
1050 /* Set up a new process group, so we can signal this process
1051 * and all subprocesses (eg. if qemu is really a shell script).
1056 execv (g->qemu, g->cmdline); /* Run qemu. */
1061 /* Parent (library). */
1069 /* Fork the recovery process off which will kill qemu if the parent
1070 * process fails to do so (eg. if the parent segfaults).
1074 pid_t qemu_pid = g->pid;
1075 pid_t parent_pid = getppid ();
1077 /* Writing to argv is hideously complicated and error prone. See:
1078 * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
1081 /* Loop around waiting for one or both of the other processes to
1082 * disappear. It's fair to say this is very hairy. The PIDs that
1083 * we are looking at might be reused by another process. We are
1084 * effectively polling. Is the cure worse than the disease?
1087 if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
1089 if (kill (parent_pid, 0) == -1) {
1090 /* Parent's gone away, qemu still around, so kill qemu. */
1098 /* Don't worry, if the fork failed, this will be -1. The recovery
1099 * process isn't essential.
1103 /* Start the clock ... */
1106 /* Close the other ends of the pipe. */
1110 if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
1111 fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
1112 perrorf (g, "fcntl");
1116 g->fd[0] = wfd[1]; /* stdin of child */
1117 g->fd[1] = rfd[0]; /* stdout of child */
1119 /* Open the Unix socket. The vmchannel implementation that got
1120 * merged with qemu sucks in a number of ways. Both ends do
1121 * connect(2), which means that no one knows what, if anything, is
1122 * connected to the other end, or if it becomes disconnected. Even
1123 * worse, we have to wait some indeterminate time for qemu to create
1124 * the socket and connect to it (which happens very early in qemu's
1125 * start-up), so any code that uses vmchannel is inherently racy.
1126 * Hence this silly loop.
1128 g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
1129 if (g->sock == -1) {
1130 perrorf (g, "socket");
1134 if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
1135 perrorf (g, "fcntl");
1139 addr.sun_family = AF_UNIX;
1140 strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
1141 addr.sun_path[UNIX_PATH_MAX-1] = '\0';
1144 /* Always sleep at least once to give qemu a small chance to start up. */
1147 r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
1148 if ((r == -1 && errno == EINPROGRESS) || r == 0)
1151 if (errno != ENOENT)
1152 perrorf (g, "connect");
1157 error (g, _("failed to connect to vmchannel socket"));
1161 /* Watch the file descriptors. */
1164 g->msg_in_size = g->msg_in_allocated = 0;
1168 g->msg_out_size = 0;
1172 g->main_loop->add_handle (g->main_loop, g, g->fd[1],
1173 GUESTFS_HANDLE_READABLE,
1174 stdout_event, NULL);
1175 if (g->stdout_watch == -1) {
1176 error (g, _("could not watch qemu stdout"));
1180 if (guestfs__switch_to_receiving (g) == -1)
1183 g->state = LAUNCHING;
1187 if (g->stdout_watch >= 0)
1188 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1189 if (g->sock_watch >= 0)
1190 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1199 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1200 waitpid (g->pid, NULL, 0);
1201 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1208 g->stdout_watch = -1;
1217 /* This function does the hard work of building the supermin appliance
1218 * on the fly. 'path' is the directory containing the control files.
1219 * 'kernel' and 'initrd' are where we will return the names of the
1220 * kernel and initrd (only initrd is built). The work is done by
1221 * an external script. We just tell it where to put the result.
1224 build_supermin_appliance (guestfs_h *g, const char *path,
1225 char **kernel, char **initrd)
1230 len = strlen (g->tmpdir);
1231 *kernel = safe_malloc (g, len + 8);
1232 snprintf (*kernel, len+8, "%s/kernel", g->tmpdir);
1233 *initrd = safe_malloc (g, len + 8);
1234 snprintf (*initrd, len+8, "%s/initrd", g->tmpdir);
1236 snprintf (cmd, sizeof cmd,
1238 "libguestfs-supermin-helper '%s' %s %s",
1240 path, *kernel, *initrd);
1243 if (r == -1 || WEXITSTATUS(r) != 0) {
1244 error (g, _("external command failed: %s"), cmd);
1247 *kernel = *initrd = NULL;
1254 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1256 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1257 * 'qemu -version' so we know what options this qemu supports and
1261 test_qemu (guestfs_h *g)
1266 free (g->qemu_help);
1267 free (g->qemu_version);
1268 g->qemu_help = NULL;
1269 g->qemu_version = NULL;
1271 snprintf (cmd, sizeof cmd, "'%s' -help", g->qemu);
1273 fp = popen (cmd, "r");
1274 /* qemu -help should always work (qemu -version OTOH wasn't
1275 * supported by qemu 0.9). If this command doesn't work then it
1276 * probably indicates that the qemu binary is missing.
1279 /* XXX This error is never printed, even if the qemu binary
1280 * doesn't exist. Why?
1283 perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1287 if (read_all (g, fp, &g->qemu_help) == -1)
1290 if (pclose (fp) == -1)
1293 snprintf (cmd, sizeof cmd, "'%s' -version 2>/dev/null", g->qemu);
1295 fp = popen (cmd, "r");
1297 /* Intentionally ignore errors. */
1298 read_all (g, fp, &g->qemu_version);
1306 read_all (guestfs_h *g, FILE *fp, char **ret)
1313 *ret = safe_realloc (g, *ret, n + 1);
1318 *ret = safe_realloc (g, *ret, n + BUFSIZ);
1320 r = fread (p, 1, BUFSIZ, fp);
1322 perrorf (g, "read");
1329 /* Test if option is supported by qemu command line (just by grepping
1333 qemu_supports (guestfs_h *g, const char *option)
1335 return g->qemu_help && strstr (g->qemu_help, option) != NULL;
1339 finish_wait_ready (guestfs_h *g, void *vp)
1342 fprintf (stderr, "finish_wait_ready called, %p, vp = %p\n", g, vp);
1345 g->main_loop->main_loop_quit (g->main_loop, g);
1349 guestfs_wait_ready (guestfs_h *g)
1351 int finished = 0, r;
1353 if (g->state == READY) return 0;
1355 if (g->state == BUSY) {
1356 error (g, _("qemu has finished launching already"));
1360 if (g->state != LAUNCHING) {
1361 error (g, _("qemu has not been launched yet"));
1365 g->launch_done_cb = finish_wait_ready;
1366 g->launch_done_cb_data = &finished;
1367 r = g->main_loop->main_loop_run (g->main_loop, g);
1368 g->launch_done_cb = NULL;
1369 g->launch_done_cb_data = NULL;
1371 if (r == -1) return -1;
1373 if (finished != 1) {
1374 error (g, _("guestfs_wait_ready failed, see earlier error messages"));
1378 /* This is possible in some really strange situations, such as
1379 * guestfsd starts up OK but then qemu immediately exits. Check for
1380 * it because the caller is probably expecting to be able to send
1381 * commands after this function returns.
1383 if (g->state != READY) {
1384 error (g, _("qemu launched and contacted daemon, but state != READY"));
1392 guestfs_kill_subprocess (guestfs_h *g)
1394 if (g->state == CONFIG) {
1395 error (g, _("no subprocess to kill"));
1400 fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
1402 kill (g->pid, SIGTERM);
1403 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1408 /* Access current state. */
1410 guestfs_is_config (guestfs_h *g)
1412 return g->state == CONFIG;
1416 guestfs_is_launching (guestfs_h *g)
1418 return g->state == LAUNCHING;
1422 guestfs_is_ready (guestfs_h *g)
1424 return g->state == READY;
1428 guestfs_is_busy (guestfs_h *g)
1430 return g->state == BUSY;
1434 guestfs_get_state (guestfs_h *g)
1440 guestfs_set_ready (guestfs_h *g)
1442 if (g->state != BUSY) {
1443 error (g, _("guestfs_set_ready: called when in state %d != BUSY"),
1452 guestfs_set_busy (guestfs_h *g)
1454 if (g->state != READY) {
1455 error (g, _("guestfs_set_busy: called when in state %d != READY"),
1464 guestfs_end_busy (guestfs_h *g)
1476 error (g, _("guestfs_end_busy: called when in state %d"), g->state);
1482 /* Structure-freeing functions. These rely on the fact that the
1483 * structure format is identical to the XDR format. See note in
1487 guestfs_free_int_bool (struct guestfs_int_bool *x)
1493 guestfs_free_lvm_pv_list (struct guestfs_lvm_pv_list *x)
1495 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_pv_list, (char *) x);
1500 guestfs_free_lvm_vg_list (struct guestfs_lvm_vg_list *x)
1502 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_vg_list, (char *) x);
1507 guestfs_free_lvm_lv_list (struct guestfs_lvm_lv_list *x)
1509 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_lv_list, (char *) x);
1514 guestfs_free_dirent_list (struct guestfs_dirent_list *x)
1516 xdr_free ((xdrproc_t) xdr_guestfs_int_dirent_list, (char *) x);
1520 /* We don't know if stdout_event or sock_read_event will be the
1521 * first to receive EOF if the qemu process dies. This function
1522 * has the common cleanup code for both.
1525 child_cleanup (guestfs_h *g)
1528 fprintf (stderr, "stdout_event: %p: child process died\n", g);
1529 /*kill (g->pid, SIGTERM);*/
1530 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1531 waitpid (g->pid, NULL, 0);
1532 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1533 if (g->stdout_watch >= 0)
1534 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1535 if (g->sock_watch >= 0)
1536 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1546 g->stdout_watch = -1;
1549 if (g->subprocess_quit_cb)
1550 g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
1553 /* This function is called whenever qemu prints something on stdout.
1554 * Qemu's stdout is also connected to the guest's serial console, so
1555 * we see kernel messages here too.
1558 stdout_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1559 int watch, int fd, int events)
1567 "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1568 g, g->state, fd, events);
1571 if (g->fd[1] != fd) {
1572 error (g, _("stdout_event: internal error: %d != %d"), g->fd[1], fd);
1576 n = read (fd, buf, sizeof buf);
1578 /* Hopefully this indicates the qemu child process has died. */
1584 if (errno != EINTR && errno != EAGAIN)
1585 perrorf (g, "read");
1589 /* In verbose mode, copy all log messages to stderr. */
1593 /* It's an actual log message, send it upwards if anyone is listening. */
1594 if (g->log_message_cb)
1595 g->log_message_cb (g, g->log_message_cb_data, buf, n);
1598 /* The function is called whenever we can read something on the
1599 * guestfsd (daemon inside the guest) communication socket.
1602 sock_read_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1603 int watch, int fd, int events)
1611 "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1612 g, g->state, fd, events);
1614 if (g->sock != fd) {
1615 error (g, _("sock_read_event: internal error: %d != %d"), g->sock, fd);
1619 if (g->msg_in_size <= g->msg_in_allocated) {
1620 g->msg_in_allocated += 4096;
1621 g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
1623 n = read (g->sock, g->msg_in + g->msg_in_size,
1624 g->msg_in_allocated - g->msg_in_size);
1632 if (errno != EINTR && errno != EAGAIN)
1633 perrorf (g, "read");
1637 g->msg_in_size += n;
1639 /* Have we got enough of a message to be able to process it yet? */
1641 if (g->msg_in_size < 4) return;
1643 xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
1644 if (!xdr_uint32_t (&xdr, &len)) {
1645 error (g, _("can't decode length word"));
1649 /* Length is normally the length of the message, but when guestfsd
1650 * starts up it sends a "magic" value (longer than any possible
1651 * message). Check for this.
1653 if (len == GUESTFS_LAUNCH_FLAG) {
1654 if (g->state != LAUNCHING)
1655 error (g, _("received magic signature from guestfsd, but in state %d"),
1657 else if (g->msg_in_size != 4)
1658 error (g, _("received magic signature from guestfsd, but msg size is %d"),
1662 if (g->launch_done_cb)
1663 g->launch_done_cb (g, g->launch_done_cb_data);
1669 /* This can happen if a cancellation happens right at the end
1670 * of us sending a FileIn parameter to the daemon. Discard. The
1671 * daemon should send us an error message next.
1673 if (len == GUESTFS_CANCEL_FLAG) {
1674 g->msg_in_size -= 4;
1675 memmove (g->msg_in, g->msg_in+4, g->msg_in_size);
1679 /* If this happens, it's pretty bad and we've probably lost
1682 if (len > GUESTFS_MESSAGE_MAX) {
1683 error (g, _("message length (%u) > maximum possible size (%d)"),
1684 len, GUESTFS_MESSAGE_MAX);
1688 if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1690 /* Got the full message, begin processing it. */
1695 for (i = 0; i < g->msg_in_size; i += 16) {
1696 printf ("%04x: ", i);
1697 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1698 printf ("%02x ", (unsigned char) g->msg_in[j]);
1699 for (; j < i+16; ++j)
1702 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1703 if (isprint (g->msg_in[j]))
1704 printf ("%c", g->msg_in[j]);
1707 for (; j < i+16; ++j)
1714 /* Not in the expected state. */
1715 if (g->state != BUSY)
1716 error (g, _("state %d != BUSY"), g->state);
1718 /* Push the message up to the higher layer. */
1720 g->reply_cb (g, g->reply_cb_data, &xdr);
1722 /* This message (probably) should never be printed. */
1723 fprintf (stderr, "libguesfs: sock_read_event: !!! dropped message !!!\n");
1725 g->msg_in_size -= len + 4;
1726 memmove (g->msg_in, g->msg_in+len+4, g->msg_in_size);
1727 if (g->msg_in_size > 0) goto again;
1730 /* Free the message buffer if it's grown excessively large. */
1731 if (g->msg_in_allocated > 65536) {
1734 g->msg_in_size = g->msg_in_allocated = 0;
1741 /* The function is called whenever we can write something on the
1742 * guestfsd (daemon inside the guest) communication socket.
1745 sock_write_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1746 int watch, int fd, int events)
1752 "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1753 g, g->state, fd, events);
1755 if (g->sock != fd) {
1756 error (g, _("sock_write_event: internal error: %d != %d"), g->sock, fd);
1760 if (g->state != BUSY) {
1761 error (g, _("sock_write_event: state %d != BUSY"), g->state);
1766 fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1767 g->msg_out_size - g->msg_out_pos);
1769 n = write (g->sock, g->msg_out + g->msg_out_pos,
1770 g->msg_out_size - g->msg_out_pos);
1774 perrorf (g, "write");
1775 if (err == EPIPE) /* Disconnected from guest (RHBZ#508713). */
1781 fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1783 g->msg_out_pos += n;
1785 /* More to write? */
1786 if (g->msg_out_pos < g->msg_out_size)
1790 fprintf (stderr, "sock_write_event: done writing, calling send_cb\n");
1794 g->msg_out_pos = g->msg_out_size = 0;
1796 /* Done writing, call the higher layer. */
1798 g->send_cb (g, g->send_cb_data);
1802 guestfs_set_send_callback (guestfs_h *g,
1803 guestfs_send_cb cb, void *opaque)
1806 g->send_cb_data = opaque;
1810 guestfs_set_reply_callback (guestfs_h *g,
1811 guestfs_reply_cb cb, void *opaque)
1814 g->reply_cb_data = opaque;
1818 guestfs_set_log_message_callback (guestfs_h *g,
1819 guestfs_log_message_cb cb, void *opaque)
1821 g->log_message_cb = cb;
1822 g->log_message_cb_data = opaque;
1826 guestfs_set_subprocess_quit_callback (guestfs_h *g,
1827 guestfs_subprocess_quit_cb cb, void *opaque)
1829 g->subprocess_quit_cb = cb;
1830 g->subprocess_quit_cb_data = opaque;
1834 guestfs_set_launch_done_callback (guestfs_h *g,
1835 guestfs_launch_done_cb cb, void *opaque)
1837 g->launch_done_cb = cb;
1838 g->launch_done_cb_data = opaque;
1841 /* Access to the handle's main loop and the default main loop. */
1843 guestfs_set_main_loop (guestfs_h *g, guestfs_main_loop *main_loop)
1845 g->main_loop = main_loop;
1849 guestfs_get_main_loop (guestfs_h *g)
1851 return g->main_loop;
1855 guestfs_get_default_main_loop (void)
1857 return (guestfs_main_loop *) &default_main_loop;
1860 /* Change the daemon socket handler so that we are now writing.
1861 * This sets the handle to sock_write_event.
1864 guestfs__switch_to_sending (guestfs_h *g)
1866 if (g->sock_watch >= 0) {
1867 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1868 error (g, _("remove_handle failed"));
1875 g->main_loop->add_handle (g->main_loop, g, g->sock,
1876 GUESTFS_HANDLE_WRITABLE,
1877 sock_write_event, NULL);
1878 if (g->sock_watch == -1) {
1879 error (g, _("add_handle failed"));
1887 guestfs__switch_to_receiving (guestfs_h *g)
1889 if (g->sock_watch >= 0) {
1890 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1891 error (g, _("remove_handle failed"));
1898 g->main_loop->add_handle (g->main_loop, g, g->sock,
1899 GUESTFS_HANDLE_READABLE,
1900 sock_read_event, NULL);
1901 if (g->sock_watch == -1) {
1902 error (g, _("add_handle failed"));
1909 /* Dispatch a call (len + header + args) to the remote daemon,
1910 * synchronously (ie. using the guest's main loop to wait until
1911 * it has been sent). Returns -1 for error, or the serial
1912 * number of the message.
1915 send_cb (guestfs_h *g, void *data)
1917 guestfs_main_loop *ml = guestfs_get_main_loop (g);
1920 ml->main_loop_quit (ml, g);
1924 guestfs__send_sync (guestfs_h *g, int proc_nr,
1925 xdrproc_t xdrp, char *args)
1927 struct guestfs_message_header hdr;
1930 int serial = g->msg_next_serial++;
1932 guestfs_main_loop *ml = guestfs_get_main_loop (g);
1934 if (g->state != BUSY) {
1935 error (g, _("guestfs__send_sync: state %d != BUSY"), g->state);
1939 /* This is probably an internal error. Or perhaps we should just
1940 * free the buffer anyway?
1942 if (g->msg_out != NULL) {
1943 error (g, _("guestfs__send_sync: msg_out should be NULL"));
1947 /* We have to allocate this message buffer on the heap because
1948 * it is quite large (although will be mostly unused). We
1949 * can't allocate it on the stack because in some environments
1950 * we have quite limited stack space available, notably when
1951 * running in the JVM.
1953 g->msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
1954 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
1956 /* Serialize the header. */
1957 hdr.prog = GUESTFS_PROGRAM;
1958 hdr.vers = GUESTFS_PROTOCOL_VERSION;
1960 hdr.direction = GUESTFS_DIRECTION_CALL;
1961 hdr.serial = serial;
1962 hdr.status = GUESTFS_STATUS_OK;
1964 if (!xdr_guestfs_message_header (&xdr, &hdr)) {
1965 error (g, _("xdr_guestfs_message_header failed"));
1969 /* Serialize the args. If any, because some message types
1970 * have no parameters.
1973 if (!(*xdrp) (&xdr, args)) {
1974 error (g, _("dispatch failed to marshal args"));
1979 /* Get the actual length of the message, resize the buffer to match
1980 * the actual length, and write the length word at the beginning.
1982 len = xdr_getpos (&xdr);
1985 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
1986 g->msg_out_size = len + 4;
1989 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
1990 xdr_uint32_t (&xdr, &len);
1992 if (guestfs__switch_to_sending (g) == -1)
1996 guestfs_set_send_callback (g, send_cb, &sent);
1997 if (ml->main_loop_run (ml, g) == -1)
2000 error (g, _("send failed, see earlier error messages"));
2009 g->msg_out_size = 0;
2013 static int cancel = 0; /* XXX Implement file cancellation. */
2014 static int send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t len);
2015 static int send_file_data_sync (guestfs_h *g, const char *buf, size_t len);
2016 static int send_file_cancellation_sync (guestfs_h *g);
2017 static int send_file_complete_sync (guestfs_h *g);
2019 /* Synchronously send a file.
2023 * -2 daemon cancelled (we must read the error message)
2026 guestfs__send_file_sync (guestfs_h *g, const char *filename)
2028 char buf[GUESTFS_MAX_CHUNK_SIZE];
2031 fd = open (filename, O_RDONLY);
2033 perrorf (g, "open: %s", filename);
2034 send_file_cancellation_sync (g);
2035 /* Daemon sees cancellation and won't reply, so caller can
2041 /* Send file in chunked encoding. */
2043 r = read (fd, buf, sizeof buf);
2044 if (r == -1 && (errno == EINTR || errno == EAGAIN))
2047 err = send_file_data_sync (g, buf, r);
2049 if (err == -2) /* daemon sent cancellation */
2050 send_file_cancellation_sync (g);
2055 if (cancel) { /* cancel from either end */
2056 send_file_cancellation_sync (g);
2061 perrorf (g, "read: %s", filename);
2062 send_file_cancellation_sync (g);
2066 /* End of file, but before we send that, we need to close
2067 * the file and check for errors.
2069 if (close (fd) == -1) {
2070 perrorf (g, "close: %s", filename);
2071 send_file_cancellation_sync (g);
2075 return send_file_complete_sync (g);
2078 /* Send a chunk of file data. */
2080 send_file_data_sync (guestfs_h *g, const char *buf, size_t len)
2082 return send_file_chunk_sync (g, 0, buf, len);
2085 /* Send a cancellation message. */
2087 send_file_cancellation_sync (guestfs_h *g)
2089 return send_file_chunk_sync (g, 1, NULL, 0);
2092 /* Send a file complete chunk. */
2094 send_file_complete_sync (guestfs_h *g)
2097 return send_file_chunk_sync (g, 0, buf, 0);
2100 /* Send a chunk, cancellation or end of file, synchronously (ie. wait
2103 static int check_for_daemon_cancellation (guestfs_h *g);
2106 send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t buflen)
2110 guestfs_chunk chunk;
2112 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2114 if (g->state != BUSY) {
2115 error (g, _("send_file_chunk_sync: state %d != READY"), g->state);
2119 /* This is probably an internal error. Or perhaps we should just
2120 * free the buffer anyway?
2122 if (g->msg_out != NULL) {
2123 error (g, _("guestfs__send_sync: msg_out should be NULL"));
2127 /* Did the daemon send a cancellation message? */
2128 if (check_for_daemon_cancellation (g)) {
2130 fprintf (stderr, "got daemon cancellation\n");
2134 /* Allocate the chunk buffer. Don't use the stack to avoid
2135 * excessive stack usage and unnecessary copies.
2137 g->msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
2138 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
2140 /* Serialize the chunk. */
2141 chunk.cancel = cancel;
2142 chunk.data.data_len = buflen;
2143 chunk.data.data_val = (char *) buf;
2145 if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2146 error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
2152 len = xdr_getpos (&xdr);
2155 /* Reduce the size of the outgoing message buffer to the real length. */
2156 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2157 g->msg_out_size = len + 4;
2160 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2161 xdr_uint32_t (&xdr, &len);
2163 if (guestfs__switch_to_sending (g) == -1)
2167 guestfs_set_send_callback (g, send_cb, &sent);
2168 if (ml->main_loop_run (ml, g) == -1)
2171 error (g, _("send file chunk failed, see earlier error messages"));
2180 g->msg_out_size = 0;
2184 /* At this point we are sending FileIn file(s) to the guest, and not
2185 * expecting to read anything, so if we do read anything, it must be
2186 * a cancellation message. This checks for this case without blocking.
2189 check_for_daemon_cancellation (guestfs_h *g)
2199 FD_SET (g->sock, &rset);
2202 r = select (g->sock+1, &rset, NULL, NULL, &tv);
2204 perrorf (g, "select");
2210 /* Read the message from the daemon. */
2211 r = xread (g->sock, buf, sizeof buf);
2213 perrorf (g, "read");
2217 xdrmem_create (&xdr, buf, sizeof buf, XDR_DECODE);
2218 xdr_uint32_t (&xdr, &flag);
2221 if (flag != GUESTFS_CANCEL_FLAG) {
2222 error (g, _("check_for_daemon_cancellation: read 0x%x from daemon, expected 0x%x\n"),
2223 flag, GUESTFS_CANCEL_FLAG);
2230 /* Synchronously receive a file. */
2232 /* Returns -1 = error, 0 = EOF, 1 = more data */
2233 static int receive_file_data_sync (guestfs_h *g, void **buf, size_t *len);
2236 guestfs__receive_file_sync (guestfs_h *g, const char *filename)
2242 fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2244 perrorf (g, "open: %s", filename);
2248 /* Receive the file in chunked encoding. */
2249 while ((r = receive_file_data_sync (g, &buf, &len)) >= 0) {
2250 if (xwrite (fd, buf, len) == -1) {
2251 perrorf (g, "%s: write", filename);
2256 if (r == 0) break; /* End of file. */
2260 error (g, _("%s: error in chunked encoding"), filename);
2264 if (close (fd) == -1) {
2265 perrorf (g, "close: %s", filename);
2272 /* Send cancellation message to daemon, then wait until it
2273 * cancels (just throwing away data).
2277 uint32_t flag = GUESTFS_CANCEL_FLAG;
2279 xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
2280 xdr_uint32_t (&xdr, &flag);
2283 if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
2284 perrorf (g, _("write to daemon socket"));
2288 while ((r = receive_file_data_sync (g, NULL, NULL)) > 0)
2289 ; /* just discard it */
2294 /* Note that the reply callback can be called multiple times before
2295 * the main loop quits and we get back to the synchronous code. So
2296 * we have to be prepared to save multiple chunks on a list here.
2298 struct receive_file_ctx {
2299 int count; /* 0 if receive_file_cb not called, or
2300 * else count number of chunks.
2302 guestfs_chunk *chunks; /* Array of chunks. */
2306 free_chunks (struct receive_file_ctx *ctx)
2310 for (i = 0; i < ctx->count; ++i)
2311 free (ctx->chunks[i].data.data_val);
2317 receive_file_cb (guestfs_h *g, void *data, XDR *xdr)
2319 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2320 struct receive_file_ctx *ctx = (struct receive_file_ctx *) data;
2321 guestfs_chunk chunk;
2323 if (ctx->count == -1) /* Parse error occurred previously. */
2326 ml->main_loop_quit (ml, g);
2328 memset (&chunk, 0, sizeof chunk);
2330 if (!xdr_guestfs_chunk (xdr, &chunk)) {
2331 error (g, _("failed to parse file chunk"));
2338 /* Copy the chunk to the list. */
2339 ctx->chunks = safe_realloc (g, ctx->chunks,
2340 sizeof (guestfs_chunk) * (ctx->count+1));
2341 ctx->chunks[ctx->count] = chunk;
2345 /* Receive a chunk of file data. */
2346 /* Returns -1 = error, 0 = EOF, 1 = more data */
2348 receive_file_data_sync (guestfs_h *g, void **buf, size_t *len_r)
2350 struct receive_file_ctx ctx;
2351 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2358 guestfs_set_reply_callback (g, receive_file_cb, &ctx);
2359 (void) ml->main_loop_run (ml, g);
2360 guestfs_set_reply_callback (g, NULL, NULL);
2362 if (ctx.count == 0) {
2363 error (g, _("receive_file_data_sync: reply callback not called\n"));
2367 if (ctx.count == -1) {
2368 error (g, _("receive_file_data_sync: parse error in reply callback\n"));
2369 /* callback already freed the chunks */
2374 fprintf (stderr, "receive_file_data_sync: got %d chunks\n", ctx.count);
2376 /* Process each chunk in the list. */
2377 if (buf) *buf = NULL; /* Accumulate data in this buffer. */
2380 for (i = 0; i < ctx.count; ++i) {
2381 if (ctx.chunks[i].cancel) {
2382 error (g, _("file receive cancelled by daemon"));
2384 if (buf) free (*buf);
2385 if (len_r) *len_r = 0;
2389 if (ctx.chunks[i].data.data_len == 0) { /* end of transfer */
2391 if (len_r) *len_r = len;
2396 *buf = safe_realloc (g, *buf, len + ctx.chunks[i].data.data_len);
2397 memcpy (*buf+len, ctx.chunks[i].data.data_val,
2398 ctx.chunks[i].data.data_len);
2400 len += ctx.chunks[i].data.data_len;
2403 if (len_r) *len_r = len;
2408 /* This is the default main loop implementation, using select(2). */
2411 select_add_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd, int events,
2412 guestfs_handle_event_cb cb, void *data)
2414 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2416 if (fd < 0 || fd >= FD_SETSIZE) {
2417 error (g, _("fd %d is out of range"), fd);
2421 if ((events & ~(GUESTFS_HANDLE_READABLE |
2422 GUESTFS_HANDLE_WRITABLE |
2423 GUESTFS_HANDLE_HANGUP |
2424 GUESTFS_HANDLE_ERROR)) != 0) {
2425 error (g, _("set of events (0x%x) contains unknown events"), events);
2430 error (g, _("set of events is empty"));
2434 if (FD_ISSET (fd, &ml->rset) ||
2435 FD_ISSET (fd, &ml->wset) ||
2436 FD_ISSET (fd, &ml->xset)) {
2437 error (g, _("fd %d is already registered"), fd);
2442 error (g, _("callback is NULL"));
2446 if ((events & GUESTFS_HANDLE_READABLE))
2447 FD_SET (fd, &ml->rset);
2448 if ((events & GUESTFS_HANDLE_WRITABLE))
2449 FD_SET (fd, &ml->wset);
2450 if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
2451 FD_SET (fd, &ml->xset);
2453 if (fd > ml->max_fd) {
2455 ml->handle_cb_data =
2456 safe_realloc (g, ml->handle_cb_data,
2457 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2459 ml->handle_cb_data[fd].cb = cb;
2460 ml->handle_cb_data[fd].g = g;
2461 ml->handle_cb_data[fd].data = data;
2465 /* Any integer >= 0 can be the handle, and this is as good as any ... */
2470 select_remove_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd)
2472 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2474 if (fd < 0 || fd >= FD_SETSIZE) {
2475 error (g, _("fd %d is out of range"), fd);
2479 if (!FD_ISSET (fd, &ml->rset) &&
2480 !FD_ISSET (fd, &ml->wset) &&
2481 !FD_ISSET (fd, &ml->xset)) {
2482 error (g, _("fd %d was not registered"), fd);
2486 FD_CLR (fd, &ml->rset);
2487 FD_CLR (fd, &ml->wset);
2488 FD_CLR (fd, &ml->xset);
2490 if (fd == ml->max_fd) {
2492 ml->handle_cb_data =
2493 safe_realloc (g, ml->handle_cb_data,
2494 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2503 select_add_timeout (guestfs_main_loop *mlv, guestfs_h *g, int interval,
2504 guestfs_handle_timeout_cb cb, void *data)
2506 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2508 abort (); /* XXX not implemented yet */
2512 select_remove_timeout (guestfs_main_loop *mlv, guestfs_h *g, int timer)
2514 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2516 abort (); /* XXX not implemented yet */
2519 /* The 'g' parameter is just used for error reporting. Events
2520 * for multiple handles can be dispatched by running the main
2524 select_main_loop_run (guestfs_main_loop *mlv, guestfs_h *g)
2526 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2528 fd_set rset2, wset2, xset2;
2530 if (ml->is_running) {
2531 error (g, _("select_main_loop_run: this cannot be called recursively"));
2537 while (ml->is_running) {
2538 if (ml->nr_fds == 0)
2544 r = select (ml->max_fd+1, &rset2, &wset2, &xset2, NULL);
2546 if (errno == EINTR || errno == EAGAIN)
2548 perrorf (g, "select");
2553 for (fd = 0; r > 0 && fd <= ml->max_fd; ++fd) {
2555 if (FD_ISSET (fd, &rset2))
2556 events |= GUESTFS_HANDLE_READABLE;
2557 if (FD_ISSET (fd, &wset2))
2558 events |= GUESTFS_HANDLE_WRITABLE;
2559 if (FD_ISSET (fd, &xset2))
2560 events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
2563 ml->handle_cb_data[fd].cb ((guestfs_main_loop *) ml,
2564 ml->handle_cb_data[fd].g,
2565 ml->handle_cb_data[fd].data,
2576 select_main_loop_quit (guestfs_main_loop *mlv, guestfs_h *g)
2578 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2580 /* Note that legitimately ml->is_running can be zero when
2581 * this function is called.