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"
62 #include "ignore-value.h"
66 #define _(str) dgettext(PACKAGE, (str))
67 #define N_(str) dgettext(PACKAGE, (str))
73 #define error guestfs_error
74 #define perrorf guestfs_perrorf
75 #define safe_malloc guestfs_safe_malloc
76 #define safe_realloc guestfs_safe_realloc
77 #define safe_strdup guestfs_safe_strdup
78 #define safe_memdup guestfs_safe_memdup
80 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
81 static void stdout_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data, int watch, int fd, int events);
82 static void sock_read_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data, int watch, int fd, int events);
83 static void sock_write_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data, int watch, int fd, int events);
85 static void close_handles (void);
87 static int select_add_handle (guestfs_main_loop *ml, guestfs_h *g, int fd, int events, guestfs_handle_event_cb cb, void *data);
88 static int select_remove_handle (guestfs_main_loop *ml, guestfs_h *g, int watch);
89 static int select_add_timeout (guestfs_main_loop *ml, guestfs_h *g, int interval, guestfs_handle_timeout_cb cb, void *data);
90 static int select_remove_timeout (guestfs_main_loop *ml, guestfs_h *g, int timer);
91 static int select_main_loop_run (guestfs_main_loop *ml, guestfs_h *g);
92 static int select_main_loop_quit (guestfs_main_loop *ml, guestfs_h *g);
94 /* Default select-based main loop. */
95 struct select_handle_cb_data {
96 guestfs_handle_event_cb cb;
101 struct select_main_loop {
102 /* NB. These fields must be the same as in struct guestfs_main_loop: */
103 guestfs_add_handle_cb add_handle;
104 guestfs_remove_handle_cb remove_handle;
105 guestfs_add_timeout_cb add_timeout;
106 guestfs_remove_timeout_cb remove_timeout;
107 guestfs_main_loop_run_cb main_loop_run;
108 guestfs_main_loop_quit_cb main_loop_quit;
110 /* Additional private data: */
119 struct select_handle_cb_data *handle_cb_data;
122 /* Default main loop. */
123 static struct select_main_loop default_main_loop = {
124 .add_handle = select_add_handle,
125 .remove_handle = select_remove_handle,
126 .add_timeout = select_add_timeout,
127 .remove_timeout = select_remove_timeout,
128 .main_loop_run = select_main_loop_run,
129 .main_loop_quit = select_main_loop_quit,
131 /* XXX hopefully .rset, .wset, .xset are initialized to the empty
132 * set by the normal action of everything being initialized to zero.
137 .handle_cb_data = NULL,
140 #define UNIX_PATH_MAX 108
142 /* Also in guestfsd.c */
143 #define VMCHANNEL_PORT 6666
144 #define VMCHANNEL_ADDR "10.0.2.4"
146 /* GuestFS handle and connection. */
147 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
151 struct guestfs_h *next; /* Linked list of open handles. */
153 /* State: see the state machine diagram in the man page guestfs(3). */
156 int fd[2]; /* Stdin/stdout of qemu. */
157 int sock; /* Daemon communications socket. */
158 pid_t pid; /* Qemu PID. */
159 pid_t recoverypid; /* Recovery process PID. */
160 time_t start_t; /* The time when we started qemu. */
162 int stdout_watch; /* Watches qemu stdout for log messages. */
163 int sock_watch; /* Watches daemon comm socket. */
165 char *tmpdir; /* Temporary directory containing socket. */
167 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
169 char **cmdline; /* Qemu command line. */
175 char *path; /* Path to kernel, initrd. */
176 char *qemu; /* Qemu binary. */
177 char *append; /* Append to kernel command line. */
179 int memsize; /* Size of RAM (megabytes). */
181 int selinux; /* selinux enabled? */
186 guestfs_abort_cb abort_cb;
187 guestfs_error_handler_cb error_cb;
188 void * error_cb_data;
189 guestfs_send_cb send_cb;
191 guestfs_reply_cb reply_cb;
192 void * reply_cb_data;
193 guestfs_log_message_cb log_message_cb;
194 void * log_message_cb_data;
195 guestfs_subprocess_quit_cb subprocess_quit_cb;
196 void * subprocess_quit_cb_data;
197 guestfs_launch_done_cb launch_done_cb;
198 void * launch_done_cb_data;
200 /* Main loop used by this handle. */
201 guestfs_main_loop *main_loop;
203 /* Messages sent and received from the daemon. */
205 int msg_in_size, msg_in_allocated;
207 int msg_out_size, msg_out_pos;
212 static guestfs_h *handles = NULL;
213 static int atexit_handler_set = 0;
216 guestfs_create (void)
221 g = malloc (sizeof (*g));
224 memset (g, 0, sizeof (*g));
231 g->stdout_watch = -1;
235 g->error_cb = default_error_cb;
236 g->error_cb_data = NULL;
238 str = getenv ("LIBGUESTFS_DEBUG");
239 g->verbose = str != NULL && strcmp (str, "1") == 0;
241 str = getenv ("LIBGUESTFS_PATH");
242 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
243 if (!g->path) goto error;
245 str = getenv ("LIBGUESTFS_QEMU");
246 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
247 if (!g->qemu) goto error;
249 str = getenv ("LIBGUESTFS_APPEND");
251 g->append = strdup (str);
252 if (!g->append) goto error;
255 /* Choose a suitable memory size. Previously we tried to choose
256 * a minimal memory size, but this isn't really necessary since
257 * recent QEMU and KVM don't do anything nasty like locking
258 * memory into core any more. Thus we can safely choose a
259 * large, generous amount of memory, and it'll just get swapped
260 * on smaller systems.
262 str = getenv ("LIBGUESTFS_MEMSIZE");
264 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
265 fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
271 g->main_loop = guestfs_get_default_main_loop ();
273 /* Start with large serial numbers so they are easy to spot
274 * inside the protocol.
276 g->msg_next_serial = 0x00123400;
278 /* Link the handles onto a global list. This is the one area
279 * where the library needs to be made thread-safe. (XXX)
281 /* acquire mutex (XXX) */
284 if (!atexit_handler_set) {
285 atexit (close_handles);
286 atexit_handler_set = 1;
288 /* release mutex (XXX) */
291 fprintf (stderr, "new guestfs handle %p\n", g);
304 guestfs_close (guestfs_h *g)
310 if (g->state == NO_HANDLE) {
311 /* Not safe to call 'error' here, so ... */
312 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
317 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
319 /* Try to sync if autosync flag is set. */
320 if (g->autosync && g->state == READY) {
321 guestfs_umount_all (g);
325 /* Remove any handlers that might be called back before we kill the
328 g->log_message_cb = NULL;
330 if (g->state != CONFIG)
331 guestfs_kill_subprocess (g);
333 /* Close any sockets and deregister any handlers. */
334 if (g->stdout_watch >= 0)
335 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
336 if (g->sock_watch >= 0)
337 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
338 g->stdout_watch = -1;
351 /* Remove tmpfiles. */
353 snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
356 snprintf (filename, sizeof filename, "%s/initrd", g->tmpdir);
359 snprintf (filename, sizeof filename, "%s/kernel", g->tmpdir);
368 for (i = 0; i < g->cmdline_size; ++i)
369 free (g->cmdline[i]);
373 /* Mark the handle as dead before freeing it. */
374 g->state = NO_HANDLE;
376 /* acquire mutex (XXX) */
380 for (gg = handles; gg->next != g; gg = gg->next)
384 /* release mutex (XXX) */
388 free (g->last_error);
393 free (g->qemu_version);
397 /* Close all open handles (called from atexit(3)). */
401 while (handles) guestfs_close (handles);
405 guestfs_last_error (guestfs_h *g)
407 return g->last_error;
411 set_last_error (guestfs_h *g, const char *msg)
413 free (g->last_error);
414 g->last_error = strdup (msg);
418 default_error_cb (guestfs_h *g, void *data, const char *msg)
420 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
424 guestfs_error (guestfs_h *g, const char *fs, ...)
430 int err = vasprintf (&msg, fs, args);
435 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
436 set_last_error (g, msg);
442 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
449 int err = vasprintf (&msg, fs, args);
456 strerror_r (errnum, buf, sizeof buf);
460 buf = strerror_r (errnum, _buf, sizeof _buf);
463 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
467 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
468 set_last_error (g, msg);
474 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
476 void *ptr = malloc (nbytes);
477 if (nbytes > 0 && !ptr) g->abort_cb ();
481 /* Return 1 if an array of N objects, each of size S, cannot exist due
482 to size arithmetic overflow. S must be positive and N must be
483 nonnegative. This is a macro, not an inline function, so that it
484 works correctly even when SIZE_MAX < N.
486 By gnulib convention, SIZE_MAX represents overflow in size
487 calculations, so the conservative dividend to use here is
488 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
489 However, malloc (SIZE_MAX) fails on all known hosts where
490 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
491 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
492 branch when S is known to be 1. */
493 # define xalloc_oversized(n, s) \
494 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
496 /* Technically we should add an autoconf test for this, testing for the desired
497 functionality, like what's done in gnulib, but for now, this is fine. */
498 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
500 /* Allocate zeroed memory for N elements of S bytes, with error
501 checking. S must be nonzero. */
503 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
505 /* From gnulib's calloc function in xmalloc.c. */
507 /* Test for overflow, since some calloc implementations don't have
508 proper overflow checks. But omit overflow and size-zero tests if
509 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
510 returns NULL if successful. */
511 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
512 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
518 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
520 void *p = realloc (ptr, nbytes);
521 if (nbytes > 0 && !p) g->abort_cb ();
526 guestfs_safe_strdup (guestfs_h *g, const char *str)
528 char *s = strdup (str);
529 if (!s) g->abort_cb ();
534 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
536 void *p = malloc (size);
537 if (!p) g->abort_cb ();
538 memcpy (p, ptr, size);
543 xwrite (int fd, const void *buf, size_t len)
548 r = write (fd, buf, len);
560 xread (int fd, void *buf, size_t len)
565 r = read (fd, buf, len);
567 if (errno == EINTR || errno == EAGAIN)
580 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
586 guestfs_get_out_of_memory_handler (guestfs_h *g)
592 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
595 g->error_cb_data = data;
598 guestfs_error_handler_cb
599 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
601 if (data_rtn) *data_rtn = g->error_cb_data;
606 guestfs_set_verbose (guestfs_h *g, int v)
613 guestfs_get_verbose (guestfs_h *g)
619 guestfs_set_autosync (guestfs_h *g, int a)
626 guestfs_get_autosync (guestfs_h *g)
632 guestfs_set_path (guestfs_h *g, const char *path)
639 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
644 guestfs_get_path (guestfs_h *g)
650 guestfs_set_qemu (guestfs_h *g, const char *qemu)
655 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
660 guestfs_get_qemu (guestfs_h *g)
666 guestfs_set_append (guestfs_h *g, const char *append)
671 g->append = append ? safe_strdup (g, append) : NULL;
676 guestfs_get_append (guestfs_h *g)
682 guestfs_set_memsize (guestfs_h *g, int memsize)
684 g->memsize = memsize;
689 guestfs_get_memsize (guestfs_h *g)
695 guestfs_set_selinux (guestfs_h *g, int selinux)
697 g->selinux = selinux;
702 guestfs_get_selinux (guestfs_h *g)
708 guestfs_get_pid (guestfs_h *g)
713 error (g, "get_pid: no qemu subprocess");
718 struct guestfs_version *
719 guestfs_version (guestfs_h *g)
721 struct guestfs_version *r;
723 r = safe_malloc (g, sizeof *r);
724 r->major = PACKAGE_VERSION_MAJOR;
725 r->minor = PACKAGE_VERSION_MINOR;
726 r->release = PACKAGE_VERSION_RELEASE;
727 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
731 /* Add a string to the current command line. */
733 incr_cmdline_size (guestfs_h *g)
735 if (g->cmdline == NULL) {
736 /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
738 g->cmdline = safe_malloc (g, sizeof (char *));
739 g->cmdline[0] = NULL;
743 g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
747 add_cmdline (guestfs_h *g, const char *str)
749 if (g->state != CONFIG) {
751 _("command line cannot be altered after qemu subprocess launched"));
755 incr_cmdline_size (g);
756 g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
761 guestfs_config (guestfs_h *g,
762 const char *qemu_param, const char *qemu_value)
764 if (qemu_param[0] != '-') {
765 error (g, _("guestfs_config: parameter must begin with '-' character"));
769 /* A bit fascist, but the user will probably break the extra
770 * parameters that we add if they try to set any of these.
772 if (strcmp (qemu_param, "-kernel") == 0 ||
773 strcmp (qemu_param, "-initrd") == 0 ||
774 strcmp (qemu_param, "-nographic") == 0 ||
775 strcmp (qemu_param, "-serial") == 0 ||
776 strcmp (qemu_param, "-full-screen") == 0 ||
777 strcmp (qemu_param, "-std-vga") == 0 ||
778 strcmp (qemu_param, "-vnc") == 0) {
779 error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
783 if (add_cmdline (g, qemu_param) != 0) return -1;
785 if (qemu_value != NULL) {
786 if (add_cmdline (g, qemu_value) != 0) return -1;
793 guestfs_add_drive (guestfs_h *g, const char *filename)
795 size_t len = strlen (filename) + 64;
798 if (strchr (filename, ',') != NULL) {
799 error (g, _("filename cannot contain ',' (comma) character"));
803 /* cache=off improves reliability in the event of a host crash.
805 * However this option causes qemu to try to open the file with
806 * O_DIRECT. This fails on some filesystem types (notably tmpfs).
807 * So we check if we can open the file with or without O_DIRECT,
808 * and use cache=off (or not) accordingly.
810 * This test also checks for the presence of the file, which
811 * is a documented semantic of this interface.
813 int fd = open (filename, O_RDONLY|O_DIRECT);
816 snprintf (buf, len, "file=%s,cache=off,if=" DRIVE_IF, filename);
818 fd = open (filename, O_RDONLY);
821 snprintf (buf, len, "file=%s,if=" DRIVE_IF, filename);
823 perrorf (g, "%s", filename);
828 return guestfs_config (g, "-drive", buf);
832 guestfs_add_drive_ro (guestfs_h *g, const char *filename)
834 size_t len = strlen (filename) + 64;
837 if (strchr (filename, ',') != NULL) {
838 error (g, _("filename cannot contain ',' (comma) character"));
842 if (access (filename, F_OK) == -1) {
843 perrorf (g, "%s", filename);
847 snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, DRIVE_IF);
849 return guestfs_config (g, "-drive", buf);
853 guestfs_add_cdrom (guestfs_h *g, const char *filename)
855 if (strchr (filename, ',') != NULL) {
856 error (g, _("filename cannot contain ',' (comma) character"));
860 if (access (filename, F_OK) == -1) {
861 perrorf (g, "%s", filename);
865 return guestfs_config (g, "-cdrom", filename);
868 /* Returns true iff file is contained in dir. */
870 dir_contains_file (const char *dir, const char *file)
872 int dirlen = strlen (dir);
873 int filelen = strlen (file);
874 int len = dirlen+filelen+2;
877 snprintf (path, len, "%s/%s", dir, file);
878 return access (path, F_OK) == 0;
881 /* Returns true iff every listed file is contained in 'dir'. */
883 dir_contains_files (const char *dir, ...)
888 va_start (args, dir);
889 while ((file = va_arg (args, const char *)) != NULL) {
890 if (!dir_contains_file (dir, file)) {
899 static int build_supermin_appliance (guestfs_h *g, const char *path, char **kernel, char **initrd);
900 static int test_qemu (guestfs_h *g);
901 static int qemu_supports (guestfs_h *g, const char *option);
902 static void print_cmdline (guestfs_h *g);
904 static const char *kernel_name = "vmlinuz." REPO "." host_cpu;
905 static const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
906 static const char *supermin_name =
907 "initramfs." REPO "." host_cpu ".supermin.img";
908 static const char *supermin_hostfiles_name =
909 "initramfs." REPO "." host_cpu ".supermin.hostfiles";
912 guestfs_launch (guestfs_h *g)
915 char dir_template[PATH_MAX];
920 char *path, *pelem, *pend;
921 char *kernel = NULL, *initrd = NULL;
923 struct sockaddr_un addr;
931 tmpdir = getenv ("TMPDIR") ? : tmpdir;
932 snprintf (dir_template, sizeof dir_template, "%s/libguestfsXXXXXX", tmpdir);
936 error (g, _("you must call guestfs_add_drive before guestfs_launch"));
940 if (g->state != CONFIG) {
941 error (g, _("qemu has already been launched"));
945 /* Make the temporary directory. */
947 g->tmpdir = safe_strdup (g, dir_template);
948 if (mkdtemp (g->tmpdir) == NULL) {
949 perrorf (g, _("%s: cannot create temporary directory"), dir_template);
954 /* First search g->path for the supermin appliance, and try to
955 * synthesize a kernel and initrd from that. If it fails, we
956 * try the path search again looking for a backup ordinary
959 pelem = path = safe_strdup (g, g->path);
961 pend = strchrnul (pelem, ':');
962 pmore = *pend == ':';
966 /* Empty element of "." means cwd. */
967 if (len == 0 || (len == 1 && *pelem == '.')) {
970 "looking for supermin appliance in current directory\n");
971 if (dir_contains_files (".",
972 supermin_name, supermin_hostfiles_name,
973 "kmod.whitelist", NULL)) {
974 if (build_supermin_appliance (g, ".", &kernel, &initrd) == -1)
979 /* Look at <path>/supermin* etc. */
982 fprintf (stderr, "looking for supermin appliance in %s\n", pelem);
984 if (dir_contains_files (pelem,
985 supermin_name, supermin_hostfiles_name,
986 "kmod.whitelist", NULL)) {
987 if (build_supermin_appliance (g, pelem, &kernel, &initrd) == -1)
998 if (kernel == NULL || initrd == NULL) {
999 /* Search g->path for the kernel and initrd. */
1000 pelem = path = safe_strdup (g, g->path);
1002 pend = strchrnul (pelem, ':');
1003 pmore = *pend == ':';
1007 /* Empty element or "." means cwd. */
1008 if (len == 0 || (len == 1 && *pelem == '.')) {
1011 "looking for appliance in current directory\n");
1012 if (dir_contains_files (".", kernel_name, initrd_name, NULL)) {
1013 kernel = safe_strdup (g, kernel_name);
1014 initrd = safe_strdup (g, initrd_name);
1018 /* Look at <path>/kernel etc. */
1021 fprintf (stderr, "looking for appliance in %s\n", pelem);
1023 if (dir_contains_files (pelem, kernel_name, initrd_name, NULL)) {
1024 kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
1025 initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
1026 sprintf (kernel, "%s/%s", pelem, kernel_name);
1027 sprintf (initrd, "%s/%s", pelem, initrd_name);
1038 if (kernel == NULL || initrd == NULL) {
1039 error (g, _("cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)"),
1040 kernel_name, initrd_name, g->path);
1044 /* Get qemu help text and version. */
1045 if (test_qemu (g) == -1)
1048 /* Make the vmchannel socket. */
1049 snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
1052 if (pipe (wfd) == -1 || pipe (rfd) == -1) {
1053 perrorf (g, "pipe");
1059 perrorf (g, "fork");
1067 if (r == 0) { /* Child (qemu). */
1068 char vmchannel[256];
1070 char memsize_str[256];
1072 /* Set up the full command line. Do this in the subprocess so we
1073 * don't need to worry about cleaning up.
1075 g->cmdline[0] = g->qemu;
1077 #define LINUX_CMDLINE \
1078 "panic=1 " /* force kernel to panic if daemon exits */ \
1079 "console=ttyS0 " /* serial console */ \
1080 "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */ \
1081 "noapic " /* workaround for RHBZ#502058 - ok if not SMP */ \
1082 "acpi=off " /* we don't need ACPI, turn it off */ \
1083 "cgroup_disable=memory " /* saves us about 5 MB of RAM */
1085 /* Linux kernel command line. */
1086 snprintf (append, sizeof append,
1089 "%s" /* (selinux) */
1090 "%s" /* (verbose) */
1091 "%s", /* (append) */
1092 VMCHANNEL_ADDR, VMCHANNEL_PORT,
1093 g->selinux ? "selinux=1 enforcing=0 " : "selinux=0 ",
1094 g->verbose ? "guestfs_verbose=1 " : " ",
1095 g->append ? g->append : "");
1097 snprintf (memsize_str, sizeof memsize_str, "%d", g->memsize);
1099 add_cmdline (g, "-m");
1100 add_cmdline (g, memsize_str);
1101 add_cmdline (g, "-no-reboot"); /* Force exit instead of reboot on panic */
1102 add_cmdline (g, "-kernel");
1103 add_cmdline (g, (char *) kernel);
1104 add_cmdline (g, "-initrd");
1105 add_cmdline (g, (char *) initrd);
1106 add_cmdline (g, "-append");
1107 add_cmdline (g, append);
1108 add_cmdline (g, "-nographic");
1109 add_cmdline (g, "-serial");
1110 add_cmdline (g, "stdio");
1113 /* Doesn't work. See:
1114 * http://lists.gnu.org/archive/html/qemu-devel/2009-07/threads.html
1115 * Subject "guestfwd option doesn't allow supplementary ,server,nowait"
1117 if (qemu_supports (g, "guestfwd")) {
1118 /* New-style -net user,guestfwd=... syntax for vmchannel. See:
1119 * http://git.savannah.gnu.org/cgit/qemu.git/commit/?id=c92ef6a22d3c71538fcc48fb61ad353f7ba03b62
1121 snprintf (vmchannel, sizeof vmchannel,
1122 "user,vlan=0,net=10.0.2.0/8,guestfwd=tcp:%s:%d-unix:%s,server,nowait",
1123 VMCHANNEL_ADDR, VMCHANNEL_PORT, unixsock);
1125 add_cmdline (g, "-net");
1126 add_cmdline (g, vmchannel);
1129 /* Not guestfwd. HOPEFULLY this qemu uses the older -net channel
1130 * syntax, or if not then we'll get a quick failure.
1132 snprintf (vmchannel, sizeof vmchannel,
1133 "channel,%d:unix:%s,server,nowait",
1134 VMCHANNEL_PORT, unixsock);
1136 add_cmdline (g, "-net");
1137 add_cmdline (g, vmchannel);
1138 add_cmdline (g, "-net");
1139 add_cmdline (g, "user,vlan=0,net=10.0.2.0/8");
1143 add_cmdline (g, "-net");
1144 add_cmdline (g, "nic,model=" NET_IF ",vlan=0");
1146 /* These options recommended by KVM developers to improve reliability. */
1147 if (qemu_supports (g, "-no-hpet"))
1148 add_cmdline (g, "-no-hpet");
1150 if (qemu_supports (g, "-rtc-td-hack"))
1151 add_cmdline (g, "-rtc-td-hack");
1153 /* Finish off the command line. */
1154 incr_cmdline_size (g);
1155 g->cmdline[g->cmdline_size-1] = NULL;
1160 /* Set up stdin, stdout. */
1167 fail |= dup (wfd[0]);
1168 fail |= dup (rfd[1]);
1173 perror ("dup failed");
1178 /* Set up a new process group, so we can signal this process
1179 * and all subprocesses (eg. if qemu is really a shell script).
1184 execv (g->qemu, g->cmdline); /* Run qemu. */
1189 /* Parent (library). */
1197 /* Fork the recovery process off which will kill qemu if the parent
1198 * process fails to do so (eg. if the parent segfaults).
1202 pid_t qemu_pid = g->pid;
1203 pid_t parent_pid = getppid ();
1205 /* Writing to argv is hideously complicated and error prone. See:
1206 * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
1209 /* Loop around waiting for one or both of the other processes to
1210 * disappear. It's fair to say this is very hairy. The PIDs that
1211 * we are looking at might be reused by another process. We are
1212 * effectively polling. Is the cure worse than the disease?
1215 if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
1217 if (kill (parent_pid, 0) == -1) {
1218 /* Parent's gone away, qemu still around, so kill qemu. */
1226 /* Don't worry, if the fork failed, this will be -1. The recovery
1227 * process isn't essential.
1231 /* Start the clock ... */
1234 /* Close the other ends of the pipe. */
1238 if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
1239 fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
1240 perrorf (g, "fcntl");
1244 g->fd[0] = wfd[1]; /* stdin of child */
1245 g->fd[1] = rfd[0]; /* stdout of child */
1247 /* Open the Unix socket. The vmchannel implementation that got
1248 * merged with qemu sucks in a number of ways. Both ends do
1249 * connect(2), which means that no one knows what, if anything, is
1250 * connected to the other end, or if it becomes disconnected. Even
1251 * worse, we have to wait some indeterminate time for qemu to create
1252 * the socket and connect to it (which happens very early in qemu's
1253 * start-up), so any code that uses vmchannel is inherently racy.
1254 * Hence this silly loop.
1256 g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
1257 if (g->sock == -1) {
1258 perrorf (g, "socket");
1262 if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
1263 perrorf (g, "fcntl");
1267 addr.sun_family = AF_UNIX;
1268 strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
1269 addr.sun_path[UNIX_PATH_MAX-1] = '\0';
1272 /* Always sleep at least once to give qemu a small chance to start up. */
1275 r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
1276 if ((r == -1 && errno == EINPROGRESS) || r == 0)
1279 if (errno != ENOENT)
1280 perrorf (g, "connect");
1285 error (g, _("failed to connect to vmchannel socket"));
1289 /* Watch the file descriptors. */
1292 g->msg_in_size = g->msg_in_allocated = 0;
1296 g->msg_out_size = 0;
1300 g->main_loop->add_handle (g->main_loop, g, g->fd[1],
1301 GUESTFS_HANDLE_READABLE,
1302 stdout_event, NULL);
1303 if (g->stdout_watch == -1) {
1304 error (g, _("could not watch qemu stdout"));
1308 if (guestfs__switch_to_receiving (g) == -1)
1311 g->state = LAUNCHING;
1315 if (g->stdout_watch >= 0)
1316 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1317 if (g->sock_watch >= 0)
1318 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1327 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1328 waitpid (g->pid, NULL, 0);
1329 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1336 g->stdout_watch = -1;
1345 /* This function is used to print the qemu command line before it gets
1346 * executed, when in verbose mode.
1349 print_cmdline (guestfs_h *g)
1354 while (g->cmdline[i]) {
1355 if (g->cmdline[i][0] == '-') /* -option starts a new line */
1356 fprintf (stderr, " \\\n ");
1358 if (i > 0) fputc (' ', stderr);
1360 /* Does it need shell quoting? This only deals with simple cases. */
1361 needs_quote = strcspn (g->cmdline[i], " ") != strlen (g->cmdline[i]);
1363 if (needs_quote) fputc ('\'', stderr);
1364 fprintf (stderr, "%s", g->cmdline[i]);
1365 if (needs_quote) fputc ('\'', stderr);
1369 fputc ('\n', stderr);
1372 /* This function does the hard work of building the supermin appliance
1373 * on the fly. 'path' is the directory containing the control files.
1374 * 'kernel' and 'initrd' are where we will return the names of the
1375 * kernel and initrd (only initrd is built). The work is done by
1376 * an external script. We just tell it where to put the result.
1379 build_supermin_appliance (guestfs_h *g, const char *path,
1380 char **kernel, char **initrd)
1385 len = strlen (g->tmpdir);
1386 *kernel = safe_malloc (g, len + 8);
1387 snprintf (*kernel, len+8, "%s/kernel", g->tmpdir);
1388 *initrd = safe_malloc (g, len + 8);
1389 snprintf (*initrd, len+8, "%s/initrd", g->tmpdir);
1391 snprintf (cmd, sizeof cmd,
1393 "libguestfs-supermin-helper '%s' %s %s",
1395 path, *kernel, *initrd);
1398 if (r == -1 || WEXITSTATUS(r) != 0) {
1399 error (g, _("external command failed: %s"), cmd);
1402 *kernel = *initrd = NULL;
1409 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1411 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1412 * 'qemu -version' so we know what options this qemu supports and
1416 test_qemu (guestfs_h *g)
1421 free (g->qemu_help);
1422 free (g->qemu_version);
1423 g->qemu_help = NULL;
1424 g->qemu_version = NULL;
1426 snprintf (cmd, sizeof cmd, "'%s' -help", g->qemu);
1428 fp = popen (cmd, "r");
1429 /* qemu -help should always work (qemu -version OTOH wasn't
1430 * supported by qemu 0.9). If this command doesn't work then it
1431 * probably indicates that the qemu binary is missing.
1434 /* XXX This error is never printed, even if the qemu binary
1435 * doesn't exist. Why?
1438 perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1442 if (read_all (g, fp, &g->qemu_help) == -1)
1445 if (pclose (fp) == -1)
1448 snprintf (cmd, sizeof cmd, "'%s' -version 2>/dev/null", g->qemu);
1450 fp = popen (cmd, "r");
1452 /* Intentionally ignore errors. */
1453 read_all (g, fp, &g->qemu_version);
1461 read_all (guestfs_h *g, FILE *fp, char **ret)
1468 *ret = safe_realloc (g, *ret, n + 1);
1473 *ret = safe_realloc (g, *ret, n + BUFSIZ);
1475 r = fread (p, 1, BUFSIZ, fp);
1477 perrorf (g, "read");
1484 /* Test if option is supported by qemu command line (just by grepping
1488 qemu_supports (guestfs_h *g, const char *option)
1490 return g->qemu_help && strstr (g->qemu_help, option) != NULL;
1494 finish_wait_ready (guestfs_h *g, void *vp)
1497 fprintf (stderr, "finish_wait_ready called, %p, vp = %p\n", g, vp);
1500 g->main_loop->main_loop_quit (g->main_loop, g);
1504 guestfs_wait_ready (guestfs_h *g)
1506 int finished = 0, r;
1508 if (g->state == READY) return 0;
1510 if (g->state == BUSY) {
1511 error (g, _("qemu has finished launching already"));
1515 if (g->state != LAUNCHING) {
1516 error (g, _("qemu has not been launched yet"));
1520 g->launch_done_cb = finish_wait_ready;
1521 g->launch_done_cb_data = &finished;
1522 r = g->main_loop->main_loop_run (g->main_loop, g);
1523 g->launch_done_cb = NULL;
1524 g->launch_done_cb_data = NULL;
1526 if (r == -1) return -1;
1528 if (finished != 1) {
1529 error (g, _("guestfs_wait_ready failed, see earlier error messages"));
1533 /* This is possible in some really strange situations, such as
1534 * guestfsd starts up OK but then qemu immediately exits. Check for
1535 * it because the caller is probably expecting to be able to send
1536 * commands after this function returns.
1538 if (g->state != READY) {
1539 error (g, _("qemu launched and contacted daemon, but state != READY"));
1547 guestfs_kill_subprocess (guestfs_h *g)
1549 if (g->state == CONFIG) {
1550 error (g, _("no subprocess to kill"));
1555 fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
1557 kill (g->pid, SIGTERM);
1558 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1563 /* Access current state. */
1565 guestfs_is_config (guestfs_h *g)
1567 return g->state == CONFIG;
1571 guestfs_is_launching (guestfs_h *g)
1573 return g->state == LAUNCHING;
1577 guestfs_is_ready (guestfs_h *g)
1579 return g->state == READY;
1583 guestfs_is_busy (guestfs_h *g)
1585 return g->state == BUSY;
1589 guestfs_get_state (guestfs_h *g)
1595 guestfs_set_ready (guestfs_h *g)
1597 if (g->state != BUSY) {
1598 error (g, _("guestfs_set_ready: called when in state %d != BUSY"),
1607 guestfs_set_busy (guestfs_h *g)
1609 if (g->state != READY) {
1610 error (g, _("guestfs_set_busy: called when in state %d != READY"),
1619 guestfs_end_busy (guestfs_h *g)
1631 error (g, _("guestfs_end_busy: called when in state %d"), g->state);
1637 /* We don't know if stdout_event or sock_read_event will be the
1638 * first to receive EOF if the qemu process dies. This function
1639 * has the common cleanup code for both.
1642 child_cleanup (guestfs_h *g)
1645 fprintf (stderr, "stdout_event: %p: child process died\n", g);
1646 /*kill (g->pid, SIGTERM);*/
1647 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1648 waitpid (g->pid, NULL, 0);
1649 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1650 if (g->stdout_watch >= 0)
1651 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1652 if (g->sock_watch >= 0)
1653 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1663 g->stdout_watch = -1;
1666 if (g->subprocess_quit_cb)
1667 g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
1670 /* This function is called whenever qemu prints something on stdout.
1671 * Qemu's stdout is also connected to the guest's serial console, so
1672 * we see kernel messages here too.
1675 stdout_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1676 int watch, int fd, int events)
1684 "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1685 g, g->state, fd, events);
1688 if (g->fd[1] != fd) {
1689 error (g, _("stdout_event: internal error: %d != %d"), g->fd[1], fd);
1693 n = read (fd, buf, sizeof buf);
1695 /* Hopefully this indicates the qemu child process has died. */
1701 if (errno != EINTR && errno != EAGAIN)
1702 perrorf (g, "read");
1706 /* In verbose mode, copy all log messages to stderr. */
1708 ignore_value (write (STDERR_FILENO, buf, n));
1710 /* It's an actual log message, send it upwards if anyone is listening. */
1711 if (g->log_message_cb)
1712 g->log_message_cb (g, g->log_message_cb_data, buf, n);
1715 /* The function is called whenever we can read something on the
1716 * guestfsd (daemon inside the guest) communication socket.
1719 sock_read_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1720 int watch, int fd, int events)
1728 "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1729 g, g->state, fd, events);
1731 if (g->sock != fd) {
1732 error (g, _("sock_read_event: internal error: %d != %d"), g->sock, fd);
1736 if (g->msg_in_size <= g->msg_in_allocated) {
1737 g->msg_in_allocated += 4096;
1738 g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
1740 n = read (g->sock, g->msg_in + g->msg_in_size,
1741 g->msg_in_allocated - g->msg_in_size);
1749 if (errno != EINTR && errno != EAGAIN)
1750 perrorf (g, "read");
1754 g->msg_in_size += n;
1756 /* Have we got enough of a message to be able to process it yet? */
1758 if (g->msg_in_size < 4) return;
1760 xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
1761 if (!xdr_uint32_t (&xdr, &len)) {
1762 error (g, _("can't decode length word"));
1766 /* Length is normally the length of the message, but when guestfsd
1767 * starts up it sends a "magic" value (longer than any possible
1768 * message). Check for this.
1770 if (len == GUESTFS_LAUNCH_FLAG) {
1771 if (g->state != LAUNCHING)
1772 error (g, _("received magic signature from guestfsd, but in state %d"),
1774 else if (g->msg_in_size != 4)
1775 error (g, _("received magic signature from guestfsd, but msg size is %d"),
1779 if (g->launch_done_cb)
1780 g->launch_done_cb (g, g->launch_done_cb_data);
1786 /* This can happen if a cancellation happens right at the end
1787 * of us sending a FileIn parameter to the daemon. Discard. The
1788 * daemon should send us an error message next.
1790 if (len == GUESTFS_CANCEL_FLAG) {
1791 g->msg_in_size -= 4;
1792 memmove (g->msg_in, g->msg_in+4, g->msg_in_size);
1796 /* If this happens, it's pretty bad and we've probably lost
1799 if (len > GUESTFS_MESSAGE_MAX) {
1800 error (g, _("message length (%u) > maximum possible size (%d)"),
1801 len, GUESTFS_MESSAGE_MAX);
1805 if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1807 /* Got the full message, begin processing it. */
1812 for (i = 0; i < g->msg_in_size; i += 16) {
1813 printf ("%04x: ", i);
1814 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1815 printf ("%02x ", (unsigned char) g->msg_in[j]);
1816 for (; j < i+16; ++j)
1819 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1820 if (isprint (g->msg_in[j]))
1821 printf ("%c", g->msg_in[j]);
1824 for (; j < i+16; ++j)
1831 /* Not in the expected state. */
1832 if (g->state != BUSY)
1833 error (g, _("state %d != BUSY"), g->state);
1835 /* Push the message up to the higher layer. */
1837 g->reply_cb (g, g->reply_cb_data, &xdr);
1839 /* This message (probably) should never be printed. */
1840 fprintf (stderr, "libguesfs: sock_read_event: !!! dropped message !!!\n");
1842 g->msg_in_size -= len + 4;
1843 memmove (g->msg_in, g->msg_in+len+4, g->msg_in_size);
1844 if (g->msg_in_size > 0) goto again;
1847 /* Free the message buffer if it's grown excessively large. */
1848 if (g->msg_in_allocated > 65536) {
1851 g->msg_in_size = g->msg_in_allocated = 0;
1858 /* The function is called whenever we can write something on the
1859 * guestfsd (daemon inside the guest) communication socket.
1862 sock_write_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1863 int watch, int fd, int events)
1869 "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1870 g, g->state, fd, events);
1872 if (g->sock != fd) {
1873 error (g, _("sock_write_event: internal error: %d != %d"), g->sock, fd);
1877 if (g->state != BUSY) {
1878 error (g, _("sock_write_event: state %d != BUSY"), g->state);
1883 fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1884 g->msg_out_size - g->msg_out_pos);
1886 n = write (g->sock, g->msg_out + g->msg_out_pos,
1887 g->msg_out_size - g->msg_out_pos);
1891 perrorf (g, "write");
1892 if (err == EPIPE) /* Disconnected from guest (RHBZ#508713). */
1898 fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1900 g->msg_out_pos += n;
1902 /* More to write? */
1903 if (g->msg_out_pos < g->msg_out_size)
1907 fprintf (stderr, "sock_write_event: done writing, calling send_cb\n");
1911 g->msg_out_pos = g->msg_out_size = 0;
1913 /* Done writing, call the higher layer. */
1915 g->send_cb (g, g->send_cb_data);
1919 guestfs_set_send_callback (guestfs_h *g,
1920 guestfs_send_cb cb, void *opaque)
1923 g->send_cb_data = opaque;
1927 guestfs_set_reply_callback (guestfs_h *g,
1928 guestfs_reply_cb cb, void *opaque)
1931 g->reply_cb_data = opaque;
1935 guestfs_set_log_message_callback (guestfs_h *g,
1936 guestfs_log_message_cb cb, void *opaque)
1938 g->log_message_cb = cb;
1939 g->log_message_cb_data = opaque;
1943 guestfs_set_subprocess_quit_callback (guestfs_h *g,
1944 guestfs_subprocess_quit_cb cb, void *opaque)
1946 g->subprocess_quit_cb = cb;
1947 g->subprocess_quit_cb_data = opaque;
1951 guestfs_set_launch_done_callback (guestfs_h *g,
1952 guestfs_launch_done_cb cb, void *opaque)
1954 g->launch_done_cb = cb;
1955 g->launch_done_cb_data = opaque;
1958 /* Access to the handle's main loop and the default main loop. */
1960 guestfs_set_main_loop (guestfs_h *g, guestfs_main_loop *main_loop)
1962 g->main_loop = main_loop;
1966 guestfs_get_main_loop (guestfs_h *g)
1968 return g->main_loop;
1972 guestfs_get_default_main_loop (void)
1974 return (guestfs_main_loop *) &default_main_loop;
1977 /* Change the daemon socket handler so that we are now writing.
1978 * This sets the handle to sock_write_event.
1981 guestfs__switch_to_sending (guestfs_h *g)
1983 if (g->sock_watch >= 0) {
1984 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1985 error (g, _("remove_handle failed"));
1992 g->main_loop->add_handle (g->main_loop, g, g->sock,
1993 GUESTFS_HANDLE_WRITABLE,
1994 sock_write_event, NULL);
1995 if (g->sock_watch == -1) {
1996 error (g, _("add_handle failed"));
2004 guestfs__switch_to_receiving (guestfs_h *g)
2006 if (g->sock_watch >= 0) {
2007 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
2008 error (g, _("remove_handle failed"));
2015 g->main_loop->add_handle (g->main_loop, g, g->sock,
2016 GUESTFS_HANDLE_READABLE,
2017 sock_read_event, NULL);
2018 if (g->sock_watch == -1) {
2019 error (g, _("add_handle failed"));
2026 /* Dispatch a call (len + header + args) to the remote daemon,
2027 * synchronously (ie. using the guest's main loop to wait until
2028 * it has been sent). Returns -1 for error, or the serial
2029 * number of the message.
2032 send_cb (guestfs_h *g, void *data)
2034 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2037 ml->main_loop_quit (ml, g);
2041 guestfs__send_sync (guestfs_h *g, int proc_nr,
2042 xdrproc_t xdrp, char *args)
2044 struct guestfs_message_header hdr;
2047 int serial = g->msg_next_serial++;
2049 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2051 if (g->state != BUSY) {
2052 error (g, _("guestfs__send_sync: state %d != BUSY"), g->state);
2056 /* This is probably an internal error. Or perhaps we should just
2057 * free the buffer anyway?
2059 if (g->msg_out != NULL) {
2060 error (g, _("guestfs__send_sync: msg_out should be NULL"));
2064 /* We have to allocate this message buffer on the heap because
2065 * it is quite large (although will be mostly unused). We
2066 * can't allocate it on the stack because in some environments
2067 * we have quite limited stack space available, notably when
2068 * running in the JVM.
2070 g->msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
2071 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
2073 /* Serialize the header. */
2074 hdr.prog = GUESTFS_PROGRAM;
2075 hdr.vers = GUESTFS_PROTOCOL_VERSION;
2077 hdr.direction = GUESTFS_DIRECTION_CALL;
2078 hdr.serial = serial;
2079 hdr.status = GUESTFS_STATUS_OK;
2081 if (!xdr_guestfs_message_header (&xdr, &hdr)) {
2082 error (g, _("xdr_guestfs_message_header failed"));
2086 /* Serialize the args. If any, because some message types
2087 * have no parameters.
2090 if (!(*xdrp) (&xdr, args)) {
2091 error (g, _("dispatch failed to marshal args"));
2096 /* Get the actual length of the message, resize the buffer to match
2097 * the actual length, and write the length word at the beginning.
2099 len = xdr_getpos (&xdr);
2102 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2103 g->msg_out_size = len + 4;
2106 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2107 xdr_uint32_t (&xdr, &len);
2109 if (guestfs__switch_to_sending (g) == -1)
2113 guestfs_set_send_callback (g, send_cb, &sent);
2114 if (ml->main_loop_run (ml, g) == -1)
2117 error (g, _("send failed, see earlier error messages"));
2126 g->msg_out_size = 0;
2130 static int cancel = 0; /* XXX Implement file cancellation. */
2131 static int send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t len);
2132 static int send_file_data_sync (guestfs_h *g, const char *buf, size_t len);
2133 static int send_file_cancellation_sync (guestfs_h *g);
2134 static int send_file_complete_sync (guestfs_h *g);
2136 /* Synchronously send a file.
2140 * -2 daemon cancelled (we must read the error message)
2143 guestfs__send_file_sync (guestfs_h *g, const char *filename)
2145 char buf[GUESTFS_MAX_CHUNK_SIZE];
2148 fd = open (filename, O_RDONLY);
2150 perrorf (g, "open: %s", filename);
2151 send_file_cancellation_sync (g);
2152 /* Daemon sees cancellation and won't reply, so caller can
2158 /* Send file in chunked encoding. */
2160 r = read (fd, buf, sizeof buf);
2161 if (r == -1 && (errno == EINTR || errno == EAGAIN))
2164 err = send_file_data_sync (g, buf, r);
2166 if (err == -2) /* daemon sent cancellation */
2167 send_file_cancellation_sync (g);
2172 if (cancel) { /* cancel from either end */
2173 send_file_cancellation_sync (g);
2178 perrorf (g, "read: %s", filename);
2179 send_file_cancellation_sync (g);
2183 /* End of file, but before we send that, we need to close
2184 * the file and check for errors.
2186 if (close (fd) == -1) {
2187 perrorf (g, "close: %s", filename);
2188 send_file_cancellation_sync (g);
2192 return send_file_complete_sync (g);
2195 /* Send a chunk of file data. */
2197 send_file_data_sync (guestfs_h *g, const char *buf, size_t len)
2199 return send_file_chunk_sync (g, 0, buf, len);
2202 /* Send a cancellation message. */
2204 send_file_cancellation_sync (guestfs_h *g)
2206 return send_file_chunk_sync (g, 1, NULL, 0);
2209 /* Send a file complete chunk. */
2211 send_file_complete_sync (guestfs_h *g)
2214 return send_file_chunk_sync (g, 0, buf, 0);
2217 /* Send a chunk, cancellation or end of file, synchronously (ie. wait
2220 static int check_for_daemon_cancellation (guestfs_h *g);
2223 send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t buflen)
2227 guestfs_chunk chunk;
2229 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2231 if (g->state != BUSY) {
2232 error (g, _("send_file_chunk_sync: state %d != READY"), g->state);
2236 /* This is probably an internal error. Or perhaps we should just
2237 * free the buffer anyway?
2239 if (g->msg_out != NULL) {
2240 error (g, _("guestfs__send_sync: msg_out should be NULL"));
2244 /* Did the daemon send a cancellation message? */
2245 if (check_for_daemon_cancellation (g)) {
2247 fprintf (stderr, "got daemon cancellation\n");
2251 /* Allocate the chunk buffer. Don't use the stack to avoid
2252 * excessive stack usage and unnecessary copies.
2254 g->msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
2255 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
2257 /* Serialize the chunk. */
2258 chunk.cancel = cancel;
2259 chunk.data.data_len = buflen;
2260 chunk.data.data_val = (char *) buf;
2262 if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2263 error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
2269 len = xdr_getpos (&xdr);
2272 /* Reduce the size of the outgoing message buffer to the real length. */
2273 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2274 g->msg_out_size = len + 4;
2277 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2278 xdr_uint32_t (&xdr, &len);
2280 if (guestfs__switch_to_sending (g) == -1)
2284 guestfs_set_send_callback (g, send_cb, &sent);
2285 if (ml->main_loop_run (ml, g) == -1)
2288 error (g, _("send file chunk failed, see earlier error messages"));
2297 g->msg_out_size = 0;
2301 /* At this point we are sending FileIn file(s) to the guest, and not
2302 * expecting to read anything, so if we do read anything, it must be
2303 * a cancellation message. This checks for this case without blocking.
2306 check_for_daemon_cancellation (guestfs_h *g)
2316 FD_SET (g->sock, &rset);
2319 r = select (g->sock+1, &rset, NULL, NULL, &tv);
2321 perrorf (g, "select");
2327 /* Read the message from the daemon. */
2328 r = xread (g->sock, buf, sizeof buf);
2330 perrorf (g, "read");
2334 xdrmem_create (&xdr, buf, sizeof buf, XDR_DECODE);
2335 xdr_uint32_t (&xdr, &flag);
2338 if (flag != GUESTFS_CANCEL_FLAG) {
2339 error (g, _("check_for_daemon_cancellation: read 0x%x from daemon, expected 0x%x\n"),
2340 flag, GUESTFS_CANCEL_FLAG);
2347 /* Synchronously receive a file. */
2349 /* Returns -1 = error, 0 = EOF, 1 = more data */
2350 static int receive_file_data_sync (guestfs_h *g, void **buf, size_t *len);
2353 guestfs__receive_file_sync (guestfs_h *g, const char *filename)
2359 fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2361 perrorf (g, "open: %s", filename);
2365 /* Receive the file in chunked encoding. */
2366 while ((r = receive_file_data_sync (g, &buf, &len)) >= 0) {
2367 if (xwrite (fd, buf, len) == -1) {
2368 perrorf (g, "%s: write", filename);
2373 if (r == 0) break; /* End of file. */
2377 error (g, _("%s: error in chunked encoding"), filename);
2381 if (close (fd) == -1) {
2382 perrorf (g, "close: %s", filename);
2389 /* Send cancellation message to daemon, then wait until it
2390 * cancels (just throwing away data).
2394 uint32_t flag = GUESTFS_CANCEL_FLAG;
2397 fprintf (stderr, "%s: waiting for daemon to acknowledge cancellation\n",
2400 xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
2401 xdr_uint32_t (&xdr, &flag);
2404 if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
2405 perrorf (g, _("write to daemon socket"));
2409 while ((r = receive_file_data_sync (g, NULL, NULL)) > 0)
2410 ; /* just discard it */
2415 /* Note that the reply callback can be called multiple times before
2416 * the main loop quits and we get back to the synchronous code. So
2417 * we have to be prepared to save multiple chunks on a list here.
2419 struct receive_file_ctx {
2420 int count; /* 0 if receive_file_cb not called, or
2421 * else count number of chunks.
2423 guestfs_chunk *chunks; /* Array of chunks. */
2427 free_chunks (struct receive_file_ctx *ctx)
2431 for (i = 0; i < ctx->count; ++i)
2432 free (ctx->chunks[i].data.data_val);
2438 receive_file_cb (guestfs_h *g, void *data, XDR *xdr)
2440 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2441 struct receive_file_ctx *ctx = (struct receive_file_ctx *) data;
2442 guestfs_chunk chunk;
2444 if (ctx->count == -1) /* Parse error occurred previously. */
2447 ml->main_loop_quit (ml, g);
2449 memset (&chunk, 0, sizeof chunk);
2451 if (!xdr_guestfs_chunk (xdr, &chunk)) {
2452 error (g, _("failed to parse file chunk"));
2459 /* Copy the chunk to the list. */
2460 ctx->chunks = safe_realloc (g, ctx->chunks,
2461 sizeof (guestfs_chunk) * (ctx->count+1));
2462 ctx->chunks[ctx->count] = chunk;
2466 /* Receive a chunk of file data. */
2467 /* Returns -1 = error, 0 = EOF, 1 = more data */
2469 receive_file_data_sync (guestfs_h *g, void **buf, size_t *len_r)
2471 struct receive_file_ctx ctx;
2472 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2479 guestfs_set_reply_callback (g, receive_file_cb, &ctx);
2480 (void) ml->main_loop_run (ml, g);
2481 guestfs_set_reply_callback (g, NULL, NULL);
2483 if (ctx.count == 0) {
2484 error (g, _("receive_file_data_sync: reply callback not called\n"));
2488 if (ctx.count == -1) {
2489 error (g, _("receive_file_data_sync: parse error in reply callback\n"));
2490 /* callback already freed the chunks */
2495 fprintf (stderr, "receive_file_data_sync: got %d chunks\n", ctx.count);
2497 /* Process each chunk in the list. */
2498 if (buf) *buf = NULL; /* Accumulate data in this buffer. */
2501 for (i = 0; i < ctx.count; ++i) {
2502 if (ctx.chunks[i].cancel) {
2503 error (g, _("file receive cancelled by daemon"));
2505 if (buf) free (*buf);
2506 if (len_r) *len_r = 0;
2510 if (ctx.chunks[i].data.data_len == 0) { /* end of transfer */
2512 if (len_r) *len_r = len;
2517 *buf = safe_realloc (g, *buf, len + ctx.chunks[i].data.data_len);
2518 memcpy (*buf+len, ctx.chunks[i].data.data_val,
2519 ctx.chunks[i].data.data_len);
2521 len += ctx.chunks[i].data.data_len;
2524 if (len_r) *len_r = len;
2529 /* This is the default main loop implementation, using select(2). */
2532 select_add_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd, int events,
2533 guestfs_handle_event_cb cb, void *data)
2535 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2537 if (fd < 0 || fd >= FD_SETSIZE) {
2538 error (g, _("fd %d is out of range"), fd);
2542 if ((events & ~(GUESTFS_HANDLE_READABLE |
2543 GUESTFS_HANDLE_WRITABLE |
2544 GUESTFS_HANDLE_HANGUP |
2545 GUESTFS_HANDLE_ERROR)) != 0) {
2546 error (g, _("set of events (0x%x) contains unknown events"), events);
2551 error (g, _("set of events is empty"));
2555 if (FD_ISSET (fd, &ml->rset) ||
2556 FD_ISSET (fd, &ml->wset) ||
2557 FD_ISSET (fd, &ml->xset)) {
2558 error (g, _("fd %d is already registered"), fd);
2563 error (g, _("callback is NULL"));
2567 if ((events & GUESTFS_HANDLE_READABLE))
2568 FD_SET (fd, &ml->rset);
2569 if ((events & GUESTFS_HANDLE_WRITABLE))
2570 FD_SET (fd, &ml->wset);
2571 if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
2572 FD_SET (fd, &ml->xset);
2574 if (fd > ml->max_fd) {
2576 ml->handle_cb_data =
2577 safe_realloc (g, ml->handle_cb_data,
2578 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2580 ml->handle_cb_data[fd].cb = cb;
2581 ml->handle_cb_data[fd].g = g;
2582 ml->handle_cb_data[fd].data = data;
2586 /* Any integer >= 0 can be the handle, and this is as good as any ... */
2591 select_remove_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd)
2593 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2595 if (fd < 0 || fd >= FD_SETSIZE) {
2596 error (g, _("fd %d is out of range"), fd);
2600 if (!FD_ISSET (fd, &ml->rset) &&
2601 !FD_ISSET (fd, &ml->wset) &&
2602 !FD_ISSET (fd, &ml->xset)) {
2603 error (g, _("fd %d was not registered"), fd);
2607 FD_CLR (fd, &ml->rset);
2608 FD_CLR (fd, &ml->wset);
2609 FD_CLR (fd, &ml->xset);
2611 if (fd == ml->max_fd) {
2613 ml->handle_cb_data =
2614 safe_realloc (g, ml->handle_cb_data,
2615 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2624 select_add_timeout (guestfs_main_loop *mlv, guestfs_h *g, int interval,
2625 guestfs_handle_timeout_cb cb, void *data)
2627 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2629 abort (); /* XXX not implemented yet */
2633 select_remove_timeout (guestfs_main_loop *mlv, guestfs_h *g, int timer)
2635 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2637 abort (); /* XXX not implemented yet */
2640 /* The 'g' parameter is just used for error reporting. Events
2641 * for multiple handles can be dispatched by running the main
2645 select_main_loop_run (guestfs_main_loop *mlv, guestfs_h *g)
2647 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2649 fd_set rset2, wset2, xset2;
2651 if (ml->is_running) {
2652 error (g, _("select_main_loop_run: this cannot be called recursively"));
2658 while (ml->is_running) {
2659 if (ml->nr_fds == 0)
2665 r = select (ml->max_fd+1, &rset2, &wset2, &xset2, NULL);
2667 if (errno == EINTR || errno == EAGAIN)
2669 perrorf (g, "select");
2674 for (fd = 0; r > 0 && fd <= ml->max_fd; ++fd) {
2676 if (FD_ISSET (fd, &rset2))
2677 events |= GUESTFS_HANDLE_READABLE;
2678 if (FD_ISSET (fd, &wset2))
2679 events |= GUESTFS_HANDLE_WRITABLE;
2680 if (FD_ISSET (fd, &xset2))
2681 events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
2684 ml->handle_cb_data[fd].cb ((guestfs_main_loop *) ml,
2685 ml->handle_cb_data[fd].g,
2686 ml->handle_cb_data[fd].data,
2697 select_main_loop_quit (guestfs_main_loop *mlv, guestfs_h *g)
2699 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2701 /* Note that legitimately ml->is_running can be zero when
2702 * this function is called.