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 */
33 #include <sys/select.h>
36 #include <rpc/types.h>
43 #ifdef HAVE_SYS_TYPES_H
44 #include <sys/types.h>
47 #ifdef HAVE_SYS_WAIT_H
51 #ifdef HAVE_SYS_SOCKET_H
52 #include <sys/socket.h>
60 #include "guestfs_protocol.h"
61 #include "ignore-value.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). */
180 int selinux; /* selinux enabled? */
185 guestfs_abort_cb abort_cb;
186 guestfs_error_handler_cb error_cb;
187 void * error_cb_data;
188 guestfs_send_cb send_cb;
190 guestfs_reply_cb reply_cb;
191 void * reply_cb_data;
192 guestfs_log_message_cb log_message_cb;
193 void * log_message_cb_data;
194 guestfs_subprocess_quit_cb subprocess_quit_cb;
195 void * subprocess_quit_cb_data;
196 guestfs_launch_done_cb launch_done_cb;
197 void * launch_done_cb_data;
199 /* Main loop used by this handle. */
200 guestfs_main_loop *main_loop;
202 /* Messages sent and received from the daemon. */
204 unsigned int msg_in_size, msg_in_allocated;
206 unsigned int msg_out_size, msg_out_pos;
211 static guestfs_h *handles = NULL;
212 static int atexit_handler_set = 0;
215 guestfs_create (void)
220 g = malloc (sizeof (*g));
223 memset (g, 0, sizeof (*g));
230 g->stdout_watch = -1;
234 g->error_cb = default_error_cb;
235 g->error_cb_data = NULL;
237 str = getenv ("LIBGUESTFS_DEBUG");
238 g->verbose = str != NULL && strcmp (str, "1") == 0;
240 str = getenv ("LIBGUESTFS_PATH");
241 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
242 if (!g->path) goto error;
244 str = getenv ("LIBGUESTFS_QEMU");
245 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
246 if (!g->qemu) goto error;
248 str = getenv ("LIBGUESTFS_APPEND");
250 g->append = strdup (str);
251 if (!g->append) goto error;
254 /* Choose a suitable memory size. Previously we tried to choose
255 * a minimal memory size, but this isn't really necessary since
256 * recent QEMU and KVM don't do anything nasty like locking
257 * memory into core any more. Thus we can safely choose a
258 * large, generous amount of memory, and it'll just get swapped
259 * on smaller systems.
261 str = getenv ("LIBGUESTFS_MEMSIZE");
263 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
264 fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
270 g->main_loop = guestfs_get_default_main_loop ();
272 /* Start with large serial numbers so they are easy to spot
273 * inside the protocol.
275 g->msg_next_serial = 0x00123400;
277 /* Link the handles onto a global list. This is the one area
278 * where the library needs to be made thread-safe. (XXX)
280 /* acquire mutex (XXX) */
283 if (!atexit_handler_set) {
284 atexit (close_handles);
285 atexit_handler_set = 1;
287 /* release mutex (XXX) */
290 fprintf (stderr, "new guestfs handle %p\n", g);
303 guestfs_close (guestfs_h *g)
309 if (g->state == NO_HANDLE) {
310 /* Not safe to call 'error' here, so ... */
311 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
316 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
318 /* Try to sync if autosync flag is set. */
319 if (g->autosync && g->state == READY) {
320 guestfs_umount_all (g);
324 /* Remove any handlers that might be called back before we kill the
327 g->log_message_cb = NULL;
329 if (g->state != CONFIG)
330 guestfs_kill_subprocess (g);
332 /* Close any sockets and deregister any handlers. */
333 if (g->stdout_watch >= 0)
334 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
335 if (g->sock_watch >= 0)
336 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
337 g->stdout_watch = -1;
350 /* Wait for subprocess(es) to exit. */
351 waitpid (g->pid, NULL, 0);
352 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
354 /* Remove tmpfiles. */
356 snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
359 snprintf (filename, sizeof filename, "%s/initrd", g->tmpdir);
362 snprintf (filename, sizeof filename, "%s/kernel", g->tmpdir);
371 for (i = 0; i < g->cmdline_size; ++i)
372 free (g->cmdline[i]);
376 /* Mark the handle as dead before freeing it. */
377 g->state = NO_HANDLE;
379 /* acquire mutex (XXX) */
383 for (gg = handles; gg->next != g; gg = gg->next)
387 /* release mutex (XXX) */
391 free (g->last_error);
396 free (g->qemu_version);
400 /* Close all open handles (called from atexit(3)). */
404 while (handles) guestfs_close (handles);
408 guestfs_last_error (guestfs_h *g)
410 return g->last_error;
414 set_last_error (guestfs_h *g, const char *msg)
416 free (g->last_error);
417 g->last_error = strdup (msg);
421 default_error_cb (guestfs_h *g, void *data, const char *msg)
423 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
427 guestfs_error (guestfs_h *g, const char *fs, ...)
433 int err = vasprintf (&msg, fs, args);
438 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
439 set_last_error (g, msg);
445 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
452 int err = vasprintf (&msg, fs, args);
459 strerror_r (errnum, buf, sizeof buf);
463 buf = strerror_r (errnum, _buf, sizeof _buf);
466 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
470 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
471 set_last_error (g, msg);
477 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
479 void *ptr = malloc (nbytes);
480 if (nbytes > 0 && !ptr) g->abort_cb ();
484 /* Return 1 if an array of N objects, each of size S, cannot exist due
485 to size arithmetic overflow. S must be positive and N must be
486 nonnegative. This is a macro, not an inline function, so that it
487 works correctly even when SIZE_MAX < N.
489 By gnulib convention, SIZE_MAX represents overflow in size
490 calculations, so the conservative dividend to use here is
491 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
492 However, malloc (SIZE_MAX) fails on all known hosts where
493 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
494 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
495 branch when S is known to be 1. */
496 # define xalloc_oversized(n, s) \
497 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
499 /* Technically we should add an autoconf test for this, testing for the desired
500 functionality, like what's done in gnulib, but for now, this is fine. */
501 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
503 /* Allocate zeroed memory for N elements of S bytes, with error
504 checking. S must be nonzero. */
506 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
508 /* From gnulib's calloc function in xmalloc.c. */
510 /* Test for overflow, since some calloc implementations don't have
511 proper overflow checks. But omit overflow and size-zero tests if
512 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
513 returns NULL if successful. */
514 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
515 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
521 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
523 void *p = realloc (ptr, nbytes);
524 if (nbytes > 0 && !p) g->abort_cb ();
529 guestfs_safe_strdup (guestfs_h *g, const char *str)
531 char *s = strdup (str);
532 if (!s) g->abort_cb ();
537 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
539 void *p = malloc (size);
540 if (!p) g->abort_cb ();
541 memcpy (p, ptr, size);
546 xwrite (int fd, const void *v_buf, size_t len)
548 const char *buf = v_buf;
552 r = write (fd, buf, len);
564 xread (int fd, void *v_buf, size_t len)
570 r = read (fd, buf, len);
572 if (errno == EINTR || errno == EAGAIN)
585 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
591 guestfs_get_out_of_memory_handler (guestfs_h *g)
597 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
600 g->error_cb_data = data;
603 guestfs_error_handler_cb
604 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
606 if (data_rtn) *data_rtn = g->error_cb_data;
611 guestfs_set_verbose (guestfs_h *g, int v)
618 guestfs_get_verbose (guestfs_h *g)
624 guestfs_set_autosync (guestfs_h *g, int a)
631 guestfs_get_autosync (guestfs_h *g)
637 guestfs_set_path (guestfs_h *g, const char *path)
644 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
649 guestfs_get_path (guestfs_h *g)
655 guestfs_set_qemu (guestfs_h *g, const char *qemu)
660 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
665 guestfs_get_qemu (guestfs_h *g)
671 guestfs_set_append (guestfs_h *g, const char *append)
676 g->append = append ? safe_strdup (g, append) : NULL;
681 guestfs_get_append (guestfs_h *g)
687 guestfs_set_memsize (guestfs_h *g, int memsize)
689 g->memsize = memsize;
694 guestfs_get_memsize (guestfs_h *g)
700 guestfs_set_selinux (guestfs_h *g, int selinux)
702 g->selinux = selinux;
707 guestfs_get_selinux (guestfs_h *g)
713 guestfs_get_pid (guestfs_h *g)
718 error (g, "get_pid: no qemu subprocess");
723 struct guestfs_version *
724 guestfs_version (guestfs_h *g)
726 struct guestfs_version *r;
728 r = safe_malloc (g, sizeof *r);
729 r->major = PACKAGE_VERSION_MAJOR;
730 r->minor = PACKAGE_VERSION_MINOR;
731 r->release = PACKAGE_VERSION_RELEASE;
732 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
736 /* Add a string to the current command line. */
738 incr_cmdline_size (guestfs_h *g)
740 if (g->cmdline == NULL) {
741 /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
743 g->cmdline = safe_malloc (g, sizeof (char *));
744 g->cmdline[0] = NULL;
748 g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
752 add_cmdline (guestfs_h *g, const char *str)
754 if (g->state != CONFIG) {
756 _("command line cannot be altered after qemu subprocess launched"));
760 incr_cmdline_size (g);
761 g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
766 guestfs_config (guestfs_h *g,
767 const char *qemu_param, const char *qemu_value)
769 if (qemu_param[0] != '-') {
770 error (g, _("guestfs_config: parameter must begin with '-' character"));
774 /* A bit fascist, but the user will probably break the extra
775 * parameters that we add if they try to set any of these.
777 if (strcmp (qemu_param, "-kernel") == 0 ||
778 strcmp (qemu_param, "-initrd") == 0 ||
779 strcmp (qemu_param, "-nographic") == 0 ||
780 strcmp (qemu_param, "-serial") == 0 ||
781 strcmp (qemu_param, "-full-screen") == 0 ||
782 strcmp (qemu_param, "-std-vga") == 0 ||
783 strcmp (qemu_param, "-vnc") == 0) {
784 error (g, _("guestfs_config: parameter '%s' isn't allowed"), qemu_param);
788 if (add_cmdline (g, qemu_param) != 0) return -1;
790 if (qemu_value != NULL) {
791 if (add_cmdline (g, qemu_value) != 0) return -1;
798 guestfs_add_drive (guestfs_h *g, const char *filename)
800 size_t len = strlen (filename) + 64;
803 if (strchr (filename, ',') != NULL) {
804 error (g, _("filename cannot contain ',' (comma) character"));
808 /* cache=off improves reliability in the event of a host crash.
810 * However this option causes qemu to try to open the file with
811 * O_DIRECT. This fails on some filesystem types (notably tmpfs).
812 * So we check if we can open the file with or without O_DIRECT,
813 * and use cache=off (or not) accordingly.
815 * This test also checks for the presence of the file, which
816 * is a documented semantic of this interface.
818 int fd = open (filename, O_RDONLY|O_DIRECT);
821 snprintf (buf, len, "file=%s,cache=off,if=" DRIVE_IF, filename);
823 fd = open (filename, O_RDONLY);
826 snprintf (buf, len, "file=%s,if=" DRIVE_IF, filename);
828 perrorf (g, "%s", filename);
833 return guestfs_config (g, "-drive", buf);
837 guestfs_add_drive_ro (guestfs_h *g, const char *filename)
839 size_t len = strlen (filename) + 64;
842 if (strchr (filename, ',') != NULL) {
843 error (g, _("filename cannot contain ',' (comma) character"));
847 if (access (filename, F_OK) == -1) {
848 perrorf (g, "%s", filename);
852 snprintf (buf, len, "file=%s,snapshot=on,if=%s", filename, DRIVE_IF);
854 return guestfs_config (g, "-drive", buf);
858 guestfs_add_cdrom (guestfs_h *g, const char *filename)
860 if (strchr (filename, ',') != NULL) {
861 error (g, _("filename cannot contain ',' (comma) character"));
865 if (access (filename, F_OK) == -1) {
866 perrorf (g, "%s", filename);
870 return guestfs_config (g, "-cdrom", filename);
873 /* Returns true iff file is contained in dir. */
875 dir_contains_file (const char *dir, const char *file)
877 int dirlen = strlen (dir);
878 int filelen = strlen (file);
879 int len = dirlen+filelen+2;
882 snprintf (path, len, "%s/%s", dir, file);
883 return access (path, F_OK) == 0;
886 /* Returns true iff every listed file is contained in 'dir'. */
888 dir_contains_files (const char *dir, ...)
893 va_start (args, dir);
894 while ((file = va_arg (args, const char *)) != NULL) {
895 if (!dir_contains_file (dir, file)) {
904 static int build_supermin_appliance (guestfs_h *g, const char *path, char **kernel, char **initrd);
905 static int test_qemu (guestfs_h *g);
906 static int qemu_supports (guestfs_h *g, const char *option);
907 static void print_cmdline (guestfs_h *g);
909 static const char *kernel_name = "vmlinuz." REPO "." host_cpu;
910 static const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
911 static const char *supermin_name =
912 "initramfs." REPO "." host_cpu ".supermin.img";
913 static const char *supermin_hostfiles_name =
914 "initramfs." REPO "." host_cpu ".supermin.hostfiles";
917 guestfs_launch (guestfs_h *g)
920 char dir_template[PATH_MAX];
925 char *path, *pelem, *pend;
926 char *kernel = NULL, *initrd = NULL;
928 struct sockaddr_un addr;
936 tmpdir = getenv ("TMPDIR") ? : tmpdir;
937 snprintf (dir_template, sizeof dir_template, "%s/libguestfsXXXXXX", tmpdir);
941 error (g, _("you must call guestfs_add_drive before guestfs_launch"));
945 if (g->state != CONFIG) {
946 error (g, _("qemu has already been launched"));
950 /* Make the temporary directory. */
952 g->tmpdir = safe_strdup (g, dir_template);
953 if (mkdtemp (g->tmpdir) == NULL) {
954 perrorf (g, _("%s: cannot create temporary directory"), dir_template);
959 /* First search g->path for the supermin appliance, and try to
960 * synthesize a kernel and initrd from that. If it fails, we
961 * try the path search again looking for a backup ordinary
964 pelem = path = safe_strdup (g, g->path);
966 pend = strchrnul (pelem, ':');
967 pmore = *pend == ':';
971 /* Empty element of "." means cwd. */
972 if (len == 0 || (len == 1 && *pelem == '.')) {
975 "looking for supermin appliance in current directory\n");
976 if (dir_contains_files (".",
977 supermin_name, supermin_hostfiles_name,
978 "kmod.whitelist", NULL)) {
979 if (build_supermin_appliance (g, ".", &kernel, &initrd) == -1)
984 /* Look at <path>/supermin* etc. */
987 fprintf (stderr, "looking for supermin appliance in %s\n", pelem);
989 if (dir_contains_files (pelem,
990 supermin_name, supermin_hostfiles_name,
991 "kmod.whitelist", NULL)) {
992 if (build_supermin_appliance (g, pelem, &kernel, &initrd) == -1)
1003 if (kernel == NULL || initrd == NULL) {
1004 /* Search g->path for the kernel and initrd. */
1005 pelem = path = safe_strdup (g, g->path);
1007 pend = strchrnul (pelem, ':');
1008 pmore = *pend == ':';
1012 /* Empty element or "." means cwd. */
1013 if (len == 0 || (len == 1 && *pelem == '.')) {
1016 "looking for appliance in current directory\n");
1017 if (dir_contains_files (".", kernel_name, initrd_name, NULL)) {
1018 kernel = safe_strdup (g, kernel_name);
1019 initrd = safe_strdup (g, initrd_name);
1023 /* Look at <path>/kernel etc. */
1026 fprintf (stderr, "looking for appliance in %s\n", pelem);
1028 if (dir_contains_files (pelem, kernel_name, initrd_name, NULL)) {
1029 kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
1030 initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
1031 sprintf (kernel, "%s/%s", pelem, kernel_name);
1032 sprintf (initrd, "%s/%s", pelem, initrd_name);
1043 if (kernel == NULL || initrd == NULL) {
1044 error (g, _("cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)"),
1045 kernel_name, initrd_name, g->path);
1049 /* Get qemu help text and version. */
1050 if (test_qemu (g) == -1)
1053 /* Make the vmchannel socket. */
1054 snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
1057 if (pipe (wfd) == -1 || pipe (rfd) == -1) {
1058 perrorf (g, "pipe");
1064 perrorf (g, "fork");
1072 if (r == 0) { /* Child (qemu). */
1073 char vmchannel[256];
1075 char memsize_str[256];
1077 /* Set up the full command line. Do this in the subprocess so we
1078 * don't need to worry about cleaning up.
1080 g->cmdline[0] = g->qemu;
1082 #define LINUX_CMDLINE \
1083 "panic=1 " /* force kernel to panic if daemon exits */ \
1084 "console=ttyS0 " /* serial console */ \
1085 "udevtimeout=300 " /* good for very slow systems (RHBZ#480319) */ \
1086 "noapic " /* workaround for RHBZ#502058 - ok if not SMP */ \
1087 "acpi=off " /* we don't need ACPI, turn it off */ \
1088 "cgroup_disable=memory " /* saves us about 5 MB of RAM */
1090 /* Linux kernel command line. */
1091 snprintf (append, sizeof append,
1094 "%s" /* (selinux) */
1095 "%s" /* (verbose) */
1096 "%s", /* (append) */
1097 VMCHANNEL_ADDR, VMCHANNEL_PORT,
1098 g->selinux ? "selinux=1 enforcing=0 " : "selinux=0 ",
1099 g->verbose ? "guestfs_verbose=1 " : " ",
1100 g->append ? g->append : "");
1102 snprintf (memsize_str, sizeof memsize_str, "%d", g->memsize);
1104 add_cmdline (g, "-m");
1105 add_cmdline (g, memsize_str);
1106 add_cmdline (g, "-no-reboot"); /* Force exit instead of reboot on panic */
1107 add_cmdline (g, "-kernel");
1108 add_cmdline (g, (char *) kernel);
1109 add_cmdline (g, "-initrd");
1110 add_cmdline (g, (char *) initrd);
1111 add_cmdline (g, "-append");
1112 add_cmdline (g, append);
1113 add_cmdline (g, "-nographic");
1114 add_cmdline (g, "-serial");
1115 add_cmdline (g, "stdio");
1118 /* Doesn't work. See:
1119 * http://lists.gnu.org/archive/html/qemu-devel/2009-07/threads.html
1120 * Subject "guestfwd option doesn't allow supplementary ,server,nowait"
1122 if (qemu_supports (g, "guestfwd")) {
1123 /* New-style -net user,guestfwd=... syntax for vmchannel. See:
1124 * http://git.savannah.gnu.org/cgit/qemu.git/commit/?id=c92ef6a22d3c71538fcc48fb61ad353f7ba03b62
1126 snprintf (vmchannel, sizeof vmchannel,
1127 "user,vlan=0,net=10.0.2.0/8,guestfwd=tcp:%s:%d-unix:%s,server,nowait",
1128 VMCHANNEL_ADDR, VMCHANNEL_PORT, unixsock);
1130 add_cmdline (g, "-net");
1131 add_cmdline (g, vmchannel);
1134 /* Not guestfwd. HOPEFULLY this qemu uses the older -net channel
1135 * syntax, or if not then we'll get a quick failure.
1137 snprintf (vmchannel, sizeof vmchannel,
1138 "channel,%d:unix:%s,server,nowait",
1139 VMCHANNEL_PORT, unixsock);
1141 add_cmdline (g, "-net");
1142 add_cmdline (g, vmchannel);
1143 add_cmdline (g, "-net");
1144 add_cmdline (g, "user,vlan=0,net=10.0.2.0/8");
1148 add_cmdline (g, "-net");
1149 add_cmdline (g, "nic,model=" NET_IF ",vlan=0");
1151 /* These options recommended by KVM developers to improve reliability. */
1152 if (qemu_supports (g, "-no-hpet"))
1153 add_cmdline (g, "-no-hpet");
1155 if (qemu_supports (g, "-rtc-td-hack"))
1156 add_cmdline (g, "-rtc-td-hack");
1158 /* Finish off the command line. */
1159 incr_cmdline_size (g);
1160 g->cmdline[g->cmdline_size-1] = NULL;
1165 /* Set up stdin, stdout. */
1171 if (dup (wfd[0]) == -1) {
1173 perror ("dup failed");
1176 if (dup (rfd[1]) == -1)
1183 /* Set up a new process group, so we can signal this process
1184 * and all subprocesses (eg. if qemu is really a shell script).
1189 execv (g->qemu, g->cmdline); /* Run qemu. */
1194 /* Parent (library). */
1202 /* Fork the recovery process off which will kill qemu if the parent
1203 * process fails to do so (eg. if the parent segfaults).
1207 pid_t qemu_pid = g->pid;
1208 pid_t parent_pid = getppid ();
1210 /* Writing to argv is hideously complicated and error prone. See:
1211 * http://anoncvs.postgresql.org/cvsweb.cgi/pgsql/src/backend/utils/misc/ps_status.c?rev=1.33.2.1;content-type=text%2Fplain
1214 /* Loop around waiting for one or both of the other processes to
1215 * disappear. It's fair to say this is very hairy. The PIDs that
1216 * we are looking at might be reused by another process. We are
1217 * effectively polling. Is the cure worse than the disease?
1220 if (kill (qemu_pid, 0) == -1) /* qemu's gone away, we aren't needed */
1222 if (kill (parent_pid, 0) == -1) {
1223 /* Parent's gone away, qemu still around, so kill qemu. */
1231 /* Don't worry, if the fork failed, this will be -1. The recovery
1232 * process isn't essential.
1236 /* Start the clock ... */
1239 /* Close the other ends of the pipe. */
1243 if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
1244 fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
1245 perrorf (g, "fcntl");
1249 g->fd[0] = wfd[1]; /* stdin of child */
1250 g->fd[1] = rfd[0]; /* stdout of child */
1252 /* Open the Unix socket. The vmchannel implementation that got
1253 * merged with qemu sucks in a number of ways. Both ends do
1254 * connect(2), which means that no one knows what, if anything, is
1255 * connected to the other end, or if it becomes disconnected. Even
1256 * worse, we have to wait some indeterminate time for qemu to create
1257 * the socket and connect to it (which happens very early in qemu's
1258 * start-up), so any code that uses vmchannel is inherently racy.
1259 * Hence this silly loop.
1261 g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
1262 if (g->sock == -1) {
1263 perrorf (g, "socket");
1267 if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
1268 perrorf (g, "fcntl");
1272 addr.sun_family = AF_UNIX;
1273 strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
1274 addr.sun_path[UNIX_PATH_MAX-1] = '\0';
1277 /* Always sleep at least once to give qemu a small chance to start up. */
1280 r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
1281 if ((r == -1 && errno == EINPROGRESS) || r == 0)
1284 if (errno != ENOENT)
1285 perrorf (g, "connect");
1290 error (g, _("failed to connect to vmchannel socket"));
1294 /* Watch the file descriptors. */
1297 g->msg_in_size = g->msg_in_allocated = 0;
1301 g->msg_out_size = 0;
1305 g->main_loop->add_handle (g->main_loop, g, g->fd[1],
1306 GUESTFS_HANDLE_READABLE,
1307 stdout_event, NULL);
1308 if (g->stdout_watch == -1) {
1309 error (g, _("could not watch qemu stdout"));
1313 if (guestfs__switch_to_receiving (g) == -1)
1316 g->state = LAUNCHING;
1320 if (g->stdout_watch >= 0)
1321 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1322 if (g->sock_watch >= 0)
1323 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1332 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1333 waitpid (g->pid, NULL, 0);
1334 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1341 g->stdout_watch = -1;
1350 /* This function is used to print the qemu command line before it gets
1351 * executed, when in verbose mode.
1354 print_cmdline (guestfs_h *g)
1359 while (g->cmdline[i]) {
1360 if (g->cmdline[i][0] == '-') /* -option starts a new line */
1361 fprintf (stderr, " \\\n ");
1363 if (i > 0) fputc (' ', stderr);
1365 /* Does it need shell quoting? This only deals with simple cases. */
1366 needs_quote = strcspn (g->cmdline[i], " ") != strlen (g->cmdline[i]);
1368 if (needs_quote) fputc ('\'', stderr);
1369 fprintf (stderr, "%s", g->cmdline[i]);
1370 if (needs_quote) fputc ('\'', stderr);
1374 fputc ('\n', stderr);
1377 /* This function does the hard work of building the supermin appliance
1378 * on the fly. 'path' is the directory containing the control files.
1379 * 'kernel' and 'initrd' are where we will return the names of the
1380 * kernel and initrd (only initrd is built). The work is done by
1381 * an external script. We just tell it where to put the result.
1384 build_supermin_appliance (guestfs_h *g, const char *path,
1385 char **kernel, char **initrd)
1390 len = strlen (g->tmpdir);
1391 *kernel = safe_malloc (g, len + 8);
1392 snprintf (*kernel, len+8, "%s/kernel", g->tmpdir);
1393 *initrd = safe_malloc (g, len + 8);
1394 snprintf (*initrd, len+8, "%s/initrd", g->tmpdir);
1396 snprintf (cmd, sizeof cmd,
1398 "libguestfs-supermin-helper '%s' %s %s",
1400 path, *kernel, *initrd);
1403 if (r == -1 || WEXITSTATUS(r) != 0) {
1404 error (g, _("external command failed: %s"), cmd);
1407 *kernel = *initrd = NULL;
1414 static int read_all (guestfs_h *g, FILE *fp, char **ret);
1416 /* Test qemu binary (or wrapper) runs, and do 'qemu -help' and
1417 * 'qemu -version' so we know what options this qemu supports and
1421 test_qemu (guestfs_h *g)
1426 free (g->qemu_help);
1427 free (g->qemu_version);
1428 g->qemu_help = NULL;
1429 g->qemu_version = NULL;
1431 snprintf (cmd, sizeof cmd, "'%s' -help", g->qemu);
1433 fp = popen (cmd, "r");
1434 /* qemu -help should always work (qemu -version OTOH wasn't
1435 * supported by qemu 0.9). If this command doesn't work then it
1436 * probably indicates that the qemu binary is missing.
1439 /* XXX This error is never printed, even if the qemu binary
1440 * doesn't exist. Why?
1443 perrorf (g, _("%s: command failed: If qemu is located on a non-standard path, try setting the LIBGUESTFS_QEMU environment variable."), cmd);
1447 if (read_all (g, fp, &g->qemu_help) == -1)
1450 if (pclose (fp) == -1)
1453 snprintf (cmd, sizeof cmd, "'%s' -version 2>/dev/null", g->qemu);
1455 fp = popen (cmd, "r");
1457 /* Intentionally ignore errors. */
1458 read_all (g, fp, &g->qemu_version);
1466 read_all (guestfs_h *g, FILE *fp, char **ret)
1473 *ret = safe_realloc (g, *ret, n + 1);
1478 *ret = safe_realloc (g, *ret, n + BUFSIZ);
1480 r = fread (p, 1, BUFSIZ, fp);
1482 perrorf (g, "read");
1489 /* Test if option is supported by qemu command line (just by grepping
1493 qemu_supports (guestfs_h *g, const char *option)
1495 return g->qemu_help && strstr (g->qemu_help, option) != NULL;
1499 finish_wait_ready (guestfs_h *g, void *vp)
1502 fprintf (stderr, "finish_wait_ready called, %p, vp = %p\n", g, vp);
1505 g->main_loop->main_loop_quit (g->main_loop, g);
1509 guestfs_wait_ready (guestfs_h *g)
1511 int finished = 0, r;
1513 if (g->state == READY) return 0;
1515 if (g->state == BUSY) {
1516 error (g, _("qemu has finished launching already"));
1520 if (g->state != LAUNCHING) {
1521 error (g, _("qemu has not been launched yet"));
1525 g->launch_done_cb = finish_wait_ready;
1526 g->launch_done_cb_data = &finished;
1527 r = g->main_loop->main_loop_run (g->main_loop, g);
1528 g->launch_done_cb = NULL;
1529 g->launch_done_cb_data = NULL;
1531 if (r == -1) return -1;
1533 if (finished != 1) {
1534 error (g, _("guestfs_wait_ready failed, see earlier error messages"));
1538 /* This is possible in some really strange situations, such as
1539 * guestfsd starts up OK but then qemu immediately exits. Check for
1540 * it because the caller is probably expecting to be able to send
1541 * commands after this function returns.
1543 if (g->state != READY) {
1544 error (g, _("qemu launched and contacted daemon, but state != READY"));
1552 guestfs_kill_subprocess (guestfs_h *g)
1554 if (g->state == CONFIG) {
1555 error (g, _("no subprocess to kill"));
1560 fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
1562 kill (g->pid, SIGTERM);
1563 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1568 /* Access current state. */
1570 guestfs_is_config (guestfs_h *g)
1572 return g->state == CONFIG;
1576 guestfs_is_launching (guestfs_h *g)
1578 return g->state == LAUNCHING;
1582 guestfs_is_ready (guestfs_h *g)
1584 return g->state == READY;
1588 guestfs_is_busy (guestfs_h *g)
1590 return g->state == BUSY;
1594 guestfs_get_state (guestfs_h *g)
1600 guestfs_set_ready (guestfs_h *g)
1602 if (g->state != BUSY) {
1603 error (g, _("guestfs_set_ready: called when in state %d != BUSY"),
1612 guestfs_set_busy (guestfs_h *g)
1614 if (g->state != READY) {
1615 error (g, _("guestfs_set_busy: called when in state %d != READY"),
1624 guestfs_end_busy (guestfs_h *g)
1638 error (g, _("guestfs_end_busy: called when in state %d"), g->state);
1644 /* We don't know if stdout_event or sock_read_event will be the
1645 * first to receive EOF if the qemu process dies. This function
1646 * has the common cleanup code for both.
1649 child_cleanup (guestfs_h *g)
1652 fprintf (stderr, "stdout_event: %p: child process died\n", g);
1653 /*kill (g->pid, SIGTERM);*/
1654 if (g->recoverypid > 0) kill (g->recoverypid, 9);
1655 waitpid (g->pid, NULL, 0);
1656 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
1657 if (g->stdout_watch >= 0)
1658 g->main_loop->remove_handle (g->main_loop, g, g->stdout_watch);
1659 if (g->sock_watch >= 0)
1660 g->main_loop->remove_handle (g->main_loop, g, g->sock_watch);
1670 g->stdout_watch = -1;
1673 if (g->subprocess_quit_cb)
1674 g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
1677 /* This function is called whenever qemu prints something on stdout.
1678 * Qemu's stdout is also connected to the guest's serial console, so
1679 * we see kernel messages here too.
1682 stdout_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1683 int watch, int fd, int events)
1691 "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1692 g, g->state, fd, events);
1695 if (g->fd[1] != fd) {
1696 error (g, _("stdout_event: internal error: %d != %d"), g->fd[1], fd);
1700 n = read (fd, buf, sizeof buf);
1702 /* Hopefully this indicates the qemu child process has died. */
1708 if (errno != EINTR && errno != EAGAIN)
1709 perrorf (g, "read");
1713 /* In verbose mode, copy all log messages to stderr. */
1715 ignore_value (write (STDERR_FILENO, buf, n));
1717 /* It's an actual log message, send it upwards if anyone is listening. */
1718 if (g->log_message_cb)
1719 g->log_message_cb (g, g->log_message_cb_data, buf, n);
1722 /* The function is called whenever we can read something on the
1723 * guestfsd (daemon inside the guest) communication socket.
1726 sock_read_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1727 int watch, int fd, int events)
1735 "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1736 g, g->state, fd, events);
1738 if (g->sock != fd) {
1739 error (g, _("sock_read_event: internal error: %d != %d"), g->sock, fd);
1743 if (g->msg_in_size <= g->msg_in_allocated) {
1744 g->msg_in_allocated += 4096;
1745 g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
1747 n = read (g->sock, g->msg_in + g->msg_in_size,
1748 g->msg_in_allocated - g->msg_in_size);
1756 if (errno != EINTR && errno != EAGAIN)
1757 perrorf (g, "read");
1761 g->msg_in_size += n;
1763 /* Have we got enough of a message to be able to process it yet? */
1765 if (g->msg_in_size < 4) return;
1767 xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
1768 if (!xdr_uint32_t (&xdr, &len)) {
1769 error (g, _("can't decode length word"));
1773 /* Length is normally the length of the message, but when guestfsd
1774 * starts up it sends a "magic" value (longer than any possible
1775 * message). Check for this.
1777 if (len == GUESTFS_LAUNCH_FLAG) {
1778 if (g->state != LAUNCHING)
1779 error (g, _("received magic signature from guestfsd, but in state %d"),
1781 else if (g->msg_in_size != 4)
1782 error (g, _("received magic signature from guestfsd, but msg size is %d"),
1786 if (g->launch_done_cb)
1787 g->launch_done_cb (g, g->launch_done_cb_data);
1793 /* This can happen if a cancellation happens right at the end
1794 * of us sending a FileIn parameter to the daemon. Discard. The
1795 * daemon should send us an error message next.
1797 if (len == GUESTFS_CANCEL_FLAG) {
1798 g->msg_in_size -= 4;
1799 memmove (g->msg_in, g->msg_in+4, g->msg_in_size);
1803 /* If this happens, it's pretty bad and we've probably lost
1806 if (len > GUESTFS_MESSAGE_MAX) {
1807 error (g, _("message length (%u) > maximum possible size (%d)"),
1808 len, GUESTFS_MESSAGE_MAX);
1812 if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1814 /* Got the full message, begin processing it. */
1819 for (i = 0; i < g->msg_in_size; i += 16) {
1820 printf ("%04x: ", i);
1821 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1822 printf ("%02x ", (unsigned char) g->msg_in[j]);
1823 for (; j < i+16; ++j)
1826 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1827 if (isprint (g->msg_in[j]))
1828 printf ("%c", g->msg_in[j]);
1831 for (; j < i+16; ++j)
1838 /* Not in the expected state. */
1839 if (g->state != BUSY)
1840 error (g, _("state %d != BUSY"), g->state);
1842 /* Push the message up to the higher layer. */
1844 g->reply_cb (g, g->reply_cb_data, &xdr);
1846 /* This message (probably) should never be printed. */
1847 fprintf (stderr, "libguesfs: sock_read_event: !!! dropped message !!!\n");
1849 g->msg_in_size -= len + 4;
1850 memmove (g->msg_in, g->msg_in+len+4, g->msg_in_size);
1851 if (g->msg_in_size > 0) goto again;
1854 /* Free the message buffer if it's grown excessively large. */
1855 if (g->msg_in_allocated > 65536) {
1858 g->msg_in_size = g->msg_in_allocated = 0;
1865 /* The function is called whenever we can write something on the
1866 * guestfsd (daemon inside the guest) communication socket.
1869 sock_write_event (struct guestfs_main_loop *ml, guestfs_h *g, void *data,
1870 int watch, int fd, int events)
1876 "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1877 g, g->state, fd, events);
1879 if (g->sock != fd) {
1880 error (g, _("sock_write_event: internal error: %d != %d"), g->sock, fd);
1884 if (g->state != BUSY) {
1885 error (g, _("sock_write_event: state %d != BUSY"), g->state);
1890 fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1891 g->msg_out_size - g->msg_out_pos);
1893 n = write (g->sock, g->msg_out + g->msg_out_pos,
1894 g->msg_out_size - g->msg_out_pos);
1898 perrorf (g, "write");
1899 if (err == EPIPE) /* Disconnected from guest (RHBZ#508713). */
1905 fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1907 g->msg_out_pos += n;
1909 /* More to write? */
1910 if (g->msg_out_pos < g->msg_out_size)
1914 fprintf (stderr, "sock_write_event: done writing, calling send_cb\n");
1918 g->msg_out_pos = g->msg_out_size = 0;
1920 /* Done writing, call the higher layer. */
1922 g->send_cb (g, g->send_cb_data);
1926 guestfs_set_send_callback (guestfs_h *g,
1927 guestfs_send_cb cb, void *opaque)
1930 g->send_cb_data = opaque;
1934 guestfs_set_reply_callback (guestfs_h *g,
1935 guestfs_reply_cb cb, void *opaque)
1938 g->reply_cb_data = opaque;
1942 guestfs_set_log_message_callback (guestfs_h *g,
1943 guestfs_log_message_cb cb, void *opaque)
1945 g->log_message_cb = cb;
1946 g->log_message_cb_data = opaque;
1950 guestfs_set_subprocess_quit_callback (guestfs_h *g,
1951 guestfs_subprocess_quit_cb cb, void *opaque)
1953 g->subprocess_quit_cb = cb;
1954 g->subprocess_quit_cb_data = opaque;
1958 guestfs_set_launch_done_callback (guestfs_h *g,
1959 guestfs_launch_done_cb cb, void *opaque)
1961 g->launch_done_cb = cb;
1962 g->launch_done_cb_data = opaque;
1965 /* Access to the handle's main loop and the default main loop. */
1967 guestfs_set_main_loop (guestfs_h *g, guestfs_main_loop *main_loop)
1969 g->main_loop = main_loop;
1973 guestfs_get_main_loop (guestfs_h *g)
1975 return g->main_loop;
1979 guestfs_get_default_main_loop (void)
1981 return (guestfs_main_loop *) &default_main_loop;
1984 /* Change the daemon socket handler so that we are now writing.
1985 * This sets the handle to sock_write_event.
1988 guestfs__switch_to_sending (guestfs_h *g)
1990 if (g->sock_watch >= 0) {
1991 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
1992 error (g, _("remove_handle failed"));
1999 g->main_loop->add_handle (g->main_loop, g, g->sock,
2000 GUESTFS_HANDLE_WRITABLE,
2001 sock_write_event, NULL);
2002 if (g->sock_watch == -1) {
2003 error (g, _("add_handle failed"));
2011 guestfs__switch_to_receiving (guestfs_h *g)
2013 if (g->sock_watch >= 0) {
2014 if (g->main_loop->remove_handle (g->main_loop, g, g->sock_watch) == -1) {
2015 error (g, _("remove_handle failed"));
2022 g->main_loop->add_handle (g->main_loop, g, g->sock,
2023 GUESTFS_HANDLE_READABLE,
2024 sock_read_event, NULL);
2025 if (g->sock_watch == -1) {
2026 error (g, _("add_handle failed"));
2033 /* Dispatch a call (len + header + args) to the remote daemon,
2034 * synchronously (ie. using the guest's main loop to wait until
2035 * it has been sent). Returns -1 for error, or the serial
2036 * number of the message.
2039 send_cb (guestfs_h *g, void *data)
2041 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2044 ml->main_loop_quit (ml, g);
2048 guestfs__send_sync (guestfs_h *g, int proc_nr,
2049 xdrproc_t xdrp, char *args)
2051 struct guestfs_message_header hdr;
2054 int serial = g->msg_next_serial++;
2056 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2058 if (g->state != BUSY) {
2059 error (g, _("guestfs__send_sync: state %d != BUSY"), g->state);
2063 /* This is probably an internal error. Or perhaps we should just
2064 * free the buffer anyway?
2066 if (g->msg_out != NULL) {
2067 error (g, _("guestfs__send_sync: msg_out should be NULL"));
2071 /* We have to allocate this message buffer on the heap because
2072 * it is quite large (although will be mostly unused). We
2073 * can't allocate it on the stack because in some environments
2074 * we have quite limited stack space available, notably when
2075 * running in the JVM.
2077 g->msg_out = safe_malloc (g, GUESTFS_MESSAGE_MAX + 4);
2078 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MESSAGE_MAX, XDR_ENCODE);
2080 /* Serialize the header. */
2081 hdr.prog = GUESTFS_PROGRAM;
2082 hdr.vers = GUESTFS_PROTOCOL_VERSION;
2084 hdr.direction = GUESTFS_DIRECTION_CALL;
2085 hdr.serial = serial;
2086 hdr.status = GUESTFS_STATUS_OK;
2088 if (!xdr_guestfs_message_header (&xdr, &hdr)) {
2089 error (g, _("xdr_guestfs_message_header failed"));
2093 /* Serialize the args. If any, because some message types
2094 * have no parameters.
2097 if (!(*xdrp) (&xdr, args)) {
2098 error (g, _("dispatch failed to marshal args"));
2103 /* Get the actual length of the message, resize the buffer to match
2104 * the actual length, and write the length word at the beginning.
2106 len = xdr_getpos (&xdr);
2109 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2110 g->msg_out_size = len + 4;
2113 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2114 xdr_uint32_t (&xdr, &len);
2116 if (guestfs__switch_to_sending (g) == -1)
2120 guestfs_set_send_callback (g, send_cb, &sent);
2121 if (ml->main_loop_run (ml, g) == -1)
2124 error (g, _("send failed, see earlier error messages"));
2133 g->msg_out_size = 0;
2137 static int cancel = 0; /* XXX Implement file cancellation. */
2138 static int send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t len);
2139 static int send_file_data_sync (guestfs_h *g, const char *buf, size_t len);
2140 static int send_file_cancellation_sync (guestfs_h *g);
2141 static int send_file_complete_sync (guestfs_h *g);
2143 /* Synchronously send a file.
2147 * -2 daemon cancelled (we must read the error message)
2150 guestfs__send_file_sync (guestfs_h *g, const char *filename)
2152 char buf[GUESTFS_MAX_CHUNK_SIZE];
2155 fd = open (filename, O_RDONLY);
2157 perrorf (g, "open: %s", filename);
2158 send_file_cancellation_sync (g);
2159 /* Daemon sees cancellation and won't reply, so caller can
2165 /* Send file in chunked encoding. */
2167 r = read (fd, buf, sizeof buf);
2168 if (r == -1 && (errno == EINTR || errno == EAGAIN))
2171 err = send_file_data_sync (g, buf, r);
2173 if (err == -2) /* daemon sent cancellation */
2174 send_file_cancellation_sync (g);
2179 if (cancel) { /* cancel from either end */
2180 send_file_cancellation_sync (g);
2185 perrorf (g, "read: %s", filename);
2186 send_file_cancellation_sync (g);
2190 /* End of file, but before we send that, we need to close
2191 * the file and check for errors.
2193 if (close (fd) == -1) {
2194 perrorf (g, "close: %s", filename);
2195 send_file_cancellation_sync (g);
2199 return send_file_complete_sync (g);
2202 /* Send a chunk of file data. */
2204 send_file_data_sync (guestfs_h *g, const char *buf, size_t len)
2206 return send_file_chunk_sync (g, 0, buf, len);
2209 /* Send a cancellation message. */
2211 send_file_cancellation_sync (guestfs_h *g)
2213 return send_file_chunk_sync (g, 1, NULL, 0);
2216 /* Send a file complete chunk. */
2218 send_file_complete_sync (guestfs_h *g)
2221 return send_file_chunk_sync (g, 0, buf, 0);
2224 /* Send a chunk, cancellation or end of file, synchronously (ie. wait
2227 static int check_for_daemon_cancellation (guestfs_h *g);
2230 send_file_chunk_sync (guestfs_h *g, int cancel, const char *buf, size_t buflen)
2234 guestfs_chunk chunk;
2236 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2238 if (g->state != BUSY) {
2239 error (g, _("send_file_chunk_sync: state %d != READY"), g->state);
2243 /* This is probably an internal error. Or perhaps we should just
2244 * free the buffer anyway?
2246 if (g->msg_out != NULL) {
2247 error (g, _("guestfs__send_sync: msg_out should be NULL"));
2251 /* Did the daemon send a cancellation message? */
2252 if (check_for_daemon_cancellation (g)) {
2254 fprintf (stderr, "got daemon cancellation\n");
2258 /* Allocate the chunk buffer. Don't use the stack to avoid
2259 * excessive stack usage and unnecessary copies.
2261 g->msg_out = safe_malloc (g, GUESTFS_MAX_CHUNK_SIZE + 4 + 48);
2262 xdrmem_create (&xdr, g->msg_out + 4, GUESTFS_MAX_CHUNK_SIZE + 48, XDR_ENCODE);
2264 /* Serialize the chunk. */
2265 chunk.cancel = cancel;
2266 chunk.data.data_len = buflen;
2267 chunk.data.data_val = (char *) buf;
2269 if (!xdr_guestfs_chunk (&xdr, &chunk)) {
2270 error (g, _("xdr_guestfs_chunk failed (buf = %p, buflen = %zu)"),
2276 len = xdr_getpos (&xdr);
2279 /* Reduce the size of the outgoing message buffer to the real length. */
2280 g->msg_out = safe_realloc (g, g->msg_out, len + 4);
2281 g->msg_out_size = len + 4;
2284 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
2285 xdr_uint32_t (&xdr, &len);
2287 if (guestfs__switch_to_sending (g) == -1)
2291 guestfs_set_send_callback (g, send_cb, &sent);
2292 if (ml->main_loop_run (ml, g) == -1)
2295 error (g, _("send file chunk failed, see earlier error messages"));
2304 g->msg_out_size = 0;
2308 /* At this point we are sending FileIn file(s) to the guest, and not
2309 * expecting to read anything, so if we do read anything, it must be
2310 * a cancellation message. This checks for this case without blocking.
2313 check_for_daemon_cancellation (guestfs_h *g)
2323 FD_SET (g->sock, &rset);
2326 r = select (g->sock+1, &rset, NULL, NULL, &tv);
2328 perrorf (g, "select");
2334 /* Read the message from the daemon. */
2335 r = xread (g->sock, buf, sizeof buf);
2337 perrorf (g, "read");
2341 xdrmem_create (&xdr, buf, sizeof buf, XDR_DECODE);
2342 xdr_uint32_t (&xdr, &flag);
2345 if (flag != GUESTFS_CANCEL_FLAG) {
2346 error (g, _("check_for_daemon_cancellation: read 0x%x from daemon, expected 0x%x\n"),
2347 flag, GUESTFS_CANCEL_FLAG);
2354 /* Synchronously receive a file. */
2356 /* Returns -1 = error, 0 = EOF, 1 = more data */
2357 static int receive_file_data_sync (guestfs_h *g, void **buf, size_t *len);
2360 guestfs__receive_file_sync (guestfs_h *g, const char *filename)
2366 fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2368 perrorf (g, "open: %s", filename);
2372 /* Receive the file in chunked encoding. */
2373 while ((r = receive_file_data_sync (g, &buf, &len)) >= 0) {
2374 if (xwrite (fd, buf, len) == -1) {
2375 perrorf (g, "%s: write", filename);
2380 if (r == 0) break; /* End of file. */
2384 error (g, _("%s: error in chunked encoding"), filename);
2388 if (close (fd) == -1) {
2389 perrorf (g, "close: %s", filename);
2396 /* Send cancellation message to daemon, then wait until it
2397 * cancels (just throwing away data).
2401 uint32_t flag = GUESTFS_CANCEL_FLAG;
2404 fprintf (stderr, "%s: waiting for daemon to acknowledge cancellation\n",
2407 xdrmem_create (&xdr, fbuf, sizeof fbuf, XDR_ENCODE);
2408 xdr_uint32_t (&xdr, &flag);
2411 if (xwrite (g->sock, fbuf, sizeof fbuf) == -1) {
2412 perrorf (g, _("write to daemon socket"));
2416 while ((r = receive_file_data_sync (g, NULL, NULL)) > 0)
2417 ; /* just discard it */
2422 /* Note that the reply callback can be called multiple times before
2423 * the main loop quits and we get back to the synchronous code. So
2424 * we have to be prepared to save multiple chunks on a list here.
2426 struct receive_file_ctx {
2427 int count; /* 0 if receive_file_cb not called, or
2428 * else count number of chunks.
2430 guestfs_chunk *chunks; /* Array of chunks. */
2434 free_chunks (struct receive_file_ctx *ctx)
2438 for (i = 0; i < ctx->count; ++i)
2439 free (ctx->chunks[i].data.data_val);
2445 receive_file_cb (guestfs_h *g, void *data, XDR *xdr)
2447 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2448 struct receive_file_ctx *ctx = (struct receive_file_ctx *) data;
2449 guestfs_chunk chunk;
2451 if (ctx->count == -1) /* Parse error occurred previously. */
2454 ml->main_loop_quit (ml, g);
2456 memset (&chunk, 0, sizeof chunk);
2458 if (!xdr_guestfs_chunk (xdr, &chunk)) {
2459 error (g, _("failed to parse file chunk"));
2466 /* Copy the chunk to the list. */
2467 ctx->chunks = safe_realloc (g, ctx->chunks,
2468 sizeof (guestfs_chunk) * (ctx->count+1));
2469 ctx->chunks[ctx->count] = chunk;
2473 /* Receive a chunk of file data. */
2474 /* Returns -1 = error, 0 = EOF, 1 = more data */
2476 receive_file_data_sync (guestfs_h *g, void **buf, size_t *len_r)
2478 struct receive_file_ctx ctx;
2479 guestfs_main_loop *ml = guestfs_get_main_loop (g);
2486 guestfs_set_reply_callback (g, receive_file_cb, &ctx);
2487 (void) ml->main_loop_run (ml, g);
2488 guestfs_set_reply_callback (g, NULL, NULL);
2490 if (ctx.count == 0) {
2491 error (g, _("receive_file_data_sync: reply callback not called\n"));
2495 if (ctx.count == -1) {
2496 error (g, _("receive_file_data_sync: parse error in reply callback\n"));
2497 /* callback already freed the chunks */
2502 fprintf (stderr, "receive_file_data_sync: got %d chunks\n", ctx.count);
2504 /* Process each chunk in the list. */
2505 if (buf) *buf = NULL; /* Accumulate data in this buffer. */
2508 for (i = 0; i < ctx.count; ++i) {
2509 if (ctx.chunks[i].cancel) {
2510 error (g, _("file receive cancelled by daemon"));
2512 if (buf) free (*buf);
2513 if (len_r) *len_r = 0;
2517 if (ctx.chunks[i].data.data_len == 0) { /* end of transfer */
2519 if (len_r) *len_r = len;
2524 *buf = safe_realloc (g, *buf, len + ctx.chunks[i].data.data_len);
2525 memcpy (((char *)*buf)+len, ctx.chunks[i].data.data_val,
2526 ctx.chunks[i].data.data_len);
2528 len += ctx.chunks[i].data.data_len;
2531 if (len_r) *len_r = len;
2536 /* This is the default main loop implementation, using select(2). */
2539 select_add_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd, int events,
2540 guestfs_handle_event_cb cb, void *data)
2542 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2544 if (fd < 0 || fd >= FD_SETSIZE) {
2545 error (g, _("fd %d is out of range"), fd);
2549 if ((events & ~(GUESTFS_HANDLE_READABLE |
2550 GUESTFS_HANDLE_WRITABLE |
2551 GUESTFS_HANDLE_HANGUP |
2552 GUESTFS_HANDLE_ERROR)) != 0) {
2553 error (g, _("set of events (0x%x) contains unknown events"), events);
2558 error (g, _("set of events is empty"));
2562 if (FD_ISSET (fd, &ml->rset) ||
2563 FD_ISSET (fd, &ml->wset) ||
2564 FD_ISSET (fd, &ml->xset)) {
2565 error (g, _("fd %d is already registered"), fd);
2570 error (g, _("callback is NULL"));
2574 if ((events & GUESTFS_HANDLE_READABLE))
2575 FD_SET (fd, &ml->rset);
2576 if ((events & GUESTFS_HANDLE_WRITABLE))
2577 FD_SET (fd, &ml->wset);
2578 if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
2579 FD_SET (fd, &ml->xset);
2581 if (fd > ml->max_fd) {
2583 ml->handle_cb_data =
2584 safe_realloc (g, ml->handle_cb_data,
2585 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2587 ml->handle_cb_data[fd].cb = cb;
2588 ml->handle_cb_data[fd].g = g;
2589 ml->handle_cb_data[fd].data = data;
2593 /* Any integer >= 0 can be the handle, and this is as good as any ... */
2598 select_remove_handle (guestfs_main_loop *mlv, guestfs_h *g, int fd)
2600 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2602 if (fd < 0 || fd >= FD_SETSIZE) {
2603 error (g, _("fd %d is out of range"), fd);
2607 if (!FD_ISSET (fd, &ml->rset) &&
2608 !FD_ISSET (fd, &ml->wset) &&
2609 !FD_ISSET (fd, &ml->xset)) {
2610 error (g, _("fd %d was not registered"), fd);
2614 FD_CLR (fd, &ml->rset);
2615 FD_CLR (fd, &ml->wset);
2616 FD_CLR (fd, &ml->xset);
2618 if (fd == ml->max_fd) {
2620 ml->handle_cb_data =
2621 safe_realloc (g, ml->handle_cb_data,
2622 sizeof (struct select_handle_cb_data) * (ml->max_fd+1));
2631 __attribute__((noreturn))
2632 select_add_timeout (guestfs_main_loop *mlv, guestfs_h *g, int interval,
2633 guestfs_handle_timeout_cb cb, void *data)
2635 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2637 abort (); /* XXX not implemented yet */
2641 __attribute__((noreturn))
2642 select_remove_timeout (guestfs_main_loop *mlv, guestfs_h *g, int timer)
2644 //struct select_main_loop *ml = (struct select_main_loop *) mlv;
2646 abort (); /* XXX not implemented yet */
2649 /* The 'g' parameter is just used for error reporting. Events
2650 * for multiple handles can be dispatched by running the main
2654 select_main_loop_run (guestfs_main_loop *mlv, guestfs_h *g)
2656 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2658 fd_set rset2, wset2, xset2;
2660 if (ml->is_running) {
2661 error (g, _("select_main_loop_run: this cannot be called recursively"));
2667 while (ml->is_running) {
2668 if (ml->nr_fds == 0)
2674 r = select (ml->max_fd+1, &rset2, &wset2, &xset2, NULL);
2676 if (errno == EINTR || errno == EAGAIN)
2678 perrorf (g, "select");
2683 for (fd = 0; r > 0 && fd <= ml->max_fd; ++fd) {
2685 if (FD_ISSET (fd, &rset2))
2686 events |= GUESTFS_HANDLE_READABLE;
2687 if (FD_ISSET (fd, &wset2))
2688 events |= GUESTFS_HANDLE_WRITABLE;
2689 if (FD_ISSET (fd, &xset2))
2690 events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
2693 ml->handle_cb_data[fd].cb ((guestfs_main_loop *) ml,
2694 ml->handle_cb_data[fd].g,
2695 ml->handle_cb_data[fd].data,
2706 select_main_loop_quit (guestfs_main_loop *mlv, guestfs_h *g)
2708 struct select_main_loop *ml = (struct select_main_loop *) mlv;
2710 /* Note that legitimately ml->is_running can be zero when
2711 * this function is called.