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 */
32 #include <sys/select.h>
33 #include <rpc/types.h>
40 #ifdef HAVE_SYS_TYPES_H
41 #include <sys/types.h>
44 #ifdef HAVE_SYS_WAIT_H
48 #ifdef HAVE_SYS_SOCKET_H
49 #include <sys/socket.h>
57 #include "guestfs_protocol.h"
59 static void error (guestfs_h *g, const char *fs, ...);
60 static void perrorf (guestfs_h *g, const char *fs, ...);
61 static void *safe_malloc (guestfs_h *g, size_t nbytes);
62 static void *safe_realloc (guestfs_h *g, void *ptr, int nbytes);
63 static char *safe_strdup (guestfs_h *g, const char *str);
64 static void *safe_memdup (guestfs_h *g, void *ptr, size_t size);
66 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
67 static void stdout_event (void *data, int watch, int fd, int events);
68 static void sock_read_event (void *data, int watch, int fd, int events);
69 static void sock_write_event (void *data, int watch, int fd, int events);
71 static void close_handles (void);
73 static int select_add_handle (guestfs_h *g, int fd, int events, guestfs_handle_event_cb cb, void *data);
74 static int select_remove_handle (guestfs_h *g, int watch);
75 static int select_add_timeout (guestfs_h *g, int interval, guestfs_handle_timeout_cb cb, void *data);
76 static int select_remove_timeout (guestfs_h *g, int timer);
77 static void select_main_loop_run (guestfs_h *g);
78 static void select_main_loop_quit (guestfs_h *g);
80 #define UNIX_PATH_MAX 108
82 /* Also in guestfsd.c */
83 #define VMCHANNEL_PORT 6666
84 #define VMCHANNEL_ADDR "10.0.2.4"
86 /* Current main loop. */
87 static guestfs_main_loop main_loop = {
88 .add_handle = select_add_handle,
89 .remove_handle = select_remove_handle,
90 .add_timeout = select_add_timeout,
91 .remove_timeout = select_remove_timeout,
92 .main_loop_run = select_main_loop_run,
93 .main_loop_quit = select_main_loop_quit,
96 /* GuestFS handle and connection. */
97 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
101 struct guestfs_h *next; /* Linked list of open handles. */
103 /* State: see the state machine diagram in the man page guestfs(3). */
106 int fd[2]; /* Stdin/stdout of qemu. */
107 int sock; /* Daemon communications socket. */
108 int pid; /* Qemu PID. */
109 time_t start_t; /* The time when we started qemu. */
111 int stdout_watch; /* Watches qemu stdout for log messages. */
112 int sock_watch; /* Watches daemon comm socket. */
114 char *tmpdir; /* Temporary directory containing socket. */
116 char **cmdline; /* Qemu command line. */
127 guestfs_abort_cb abort_cb;
128 guestfs_error_handler_cb error_cb;
129 void * error_cb_data;
130 guestfs_reply_cb reply_cb;
131 void * reply_cb_data;
132 guestfs_log_message_cb log_message_cb;
133 void * log_message_cb_data;
134 guestfs_subprocess_quit_cb subprocess_quit_cb;
135 void * subprocess_quit_cb_data;
136 guestfs_launch_done_cb launch_done_cb;
137 void * launch_done_cb_data;
139 /* These callbacks are called before reply_cb and launch_done_cb,
140 * and are used to implement the high-level API without needing to
141 * interfere with callbacks that the user might have set.
143 guestfs_reply_cb reply_cb_internal;
144 void * reply_cb_internal_data;
145 guestfs_launch_done_cb launch_done_cb_internal;
146 void * launch_done_cb_internal_data;
148 /* Messages sent and received from the daemon. */
150 int msg_in_size, msg_in_allocated;
152 int msg_out_size, msg_out_pos;
157 static guestfs_h *handles = NULL;
158 static int atexit_handler_set = 0;
161 guestfs_create (void)
166 g = malloc (sizeof (*g));
169 memset (g, 0, sizeof (*g));
176 g->stdout_watch = -1;
180 g->error_cb = default_error_cb;
181 g->error_cb_data = NULL;
183 str = getenv ("LIBGUESTFS_DEBUG");
184 g->verbose = str != NULL && strcmp (str, "1") == 0;
186 str = getenv ("LIBGUESTFS_PATH");
187 g->path = str != NULL ? str : GUESTFS_DEFAULT_PATH;
188 /* XXX We should probably make QEMU configurable as well. */
190 /* Start with large serial numbers so they are easy to spot
191 * inside the protocol.
193 g->msg_next_serial = 0x00123400;
195 /* Link the handles onto a global list. This is the one area
196 * where the library needs to be made thread-safe. (XXX)
198 /* acquire mutex (XXX) */
201 if (!atexit_handler_set) {
202 atexit (close_handles);
203 atexit_handler_set = 1;
205 /* release mutex (XXX) */
208 fprintf (stderr, "new guestfs handle %p\n", g);
214 guestfs_close (guestfs_h *g)
220 if (g->state == NO_HANDLE) {
221 /* Not safe to call 'error' here, so ... */
222 fprintf (stderr, "guestfs_close: called twice on the same handle\n");
227 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
229 /* Try to sync if autosync flag is set. */
230 if (g->autosync && g->state == READY)
233 /* Remove any handlers that might be called back before we kill the
236 g->log_message_cb = NULL;
238 if (g->state != CONFIG)
239 guestfs_kill_subprocess (g);
242 snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
251 for (i = 0; i < g->cmdline_size; ++i)
252 free (g->cmdline[i]);
256 /* Mark the handle as dead before freeing it. */
257 g->state = NO_HANDLE;
259 /* acquire mutex (XXX) */
263 for (gg = handles; gg->next != g; gg = gg->next)
267 /* release mutex (XXX) */
269 free (g->last_error);
273 /* Close all open handles (called from atexit(3)). */
277 while (handles) guestfs_close (handles);
281 guestfs_last_error (guestfs_h *g)
283 return g->last_error;
287 set_last_error (guestfs_h *g, const char *msg)
289 free (g->last_error);
290 g->last_error = strdup (msg);
294 default_error_cb (guestfs_h *g, void *data, const char *msg)
296 fprintf (stderr, "libguestfs: error: %s\n", msg);
300 error (guestfs_h *g, const char *fs, ...)
306 vasprintf (&msg, fs, args);
309 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
310 set_last_error (g, msg);
316 perrorf (guestfs_h *g, const char *fs, ...)
323 vasprintf (&msg, fs, args);
328 strerror_r (err, buf, sizeof buf);
332 buf = strerror_r (err, _buf, sizeof _buf);
335 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
339 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
340 set_last_error (g, msg);
346 safe_malloc (guestfs_h *g, size_t nbytes)
348 void *ptr = malloc (nbytes);
349 if (!ptr) g->abort_cb ();
354 safe_realloc (guestfs_h *g, void *ptr, int nbytes)
356 void *p = realloc (ptr, nbytes);
357 if (!p) g->abort_cb ();
362 safe_strdup (guestfs_h *g, const char *str)
364 char *s = strdup (str);
365 if (!s) g->abort_cb ();
370 safe_memdup (guestfs_h *g, void *ptr, size_t size)
372 void *p = malloc (size);
373 if (!p) g->abort_cb ();
374 memcpy (p, ptr, size);
379 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
385 guestfs_get_out_of_memory_handler (guestfs_h *g)
391 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
394 g->error_cb_data = data;
397 guestfs_error_handler_cb
398 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
400 if (data_rtn) *data_rtn = g->error_cb_data;
405 guestfs_set_verbose (guestfs_h *g, int v)
412 guestfs_get_verbose (guestfs_h *g)
418 guestfs_set_autosync (guestfs_h *g, int a)
425 guestfs_get_autosync (guestfs_h *g)
431 guestfs_set_path (guestfs_h *g, const char *path)
434 g->path = GUESTFS_DEFAULT_PATH;
441 guestfs_get_path (guestfs_h *g)
446 /* Add a string to the current command line. */
448 incr_cmdline_size (guestfs_h *g)
450 if (g->cmdline == NULL) {
451 /* g->cmdline[0] is reserved for argv[0], set in guestfs_launch. */
453 g->cmdline = safe_malloc (g, sizeof (char *));
454 g->cmdline[0] = NULL;
458 g->cmdline = safe_realloc (g, g->cmdline, sizeof (char *) * g->cmdline_size);
462 add_cmdline (guestfs_h *g, const char *str)
464 if (g->state != CONFIG) {
465 error (g, "command line cannot be altered after qemu subprocess launched");
469 incr_cmdline_size (g);
470 g->cmdline[g->cmdline_size-1] = safe_strdup (g, str);
475 guestfs_config (guestfs_h *g,
476 const char *qemu_param, const char *qemu_value)
478 if (qemu_param[0] != '-') {
479 error (g, "guestfs_config: parameter must begin with '-' character");
483 /* A bit fascist, but the user will probably break the extra
484 * parameters that we add if they try to set any of these.
486 if (strcmp (qemu_param, "-kernel") == 0 ||
487 strcmp (qemu_param, "-initrd") == 0 ||
488 strcmp (qemu_param, "-nographic") == 0 ||
489 strcmp (qemu_param, "-serial") == 0 ||
490 strcmp (qemu_param, "-vnc") == 0 ||
491 strcmp (qemu_param, "-full-screen") == 0 ||
492 strcmp (qemu_param, "-std-vga") == 0 ||
493 strcmp (qemu_param, "-vnc") == 0) {
494 error (g, "guestfs_config: parameter '%s' isn't allowed", qemu_param);
498 if (add_cmdline (g, qemu_param) != 0) return -1;
500 if (qemu_value != NULL) {
501 if (add_cmdline (g, qemu_value) != 0) return -1;
508 guestfs_add_drive (guestfs_h *g, const char *filename)
510 int len = strlen (filename) + 64;
513 if (strchr (filename, ',') != NULL) {
514 error (g, "filename cannot contain ',' (comma) character");
518 if (access (filename, F_OK) == -1) {
519 perrorf (g, "%s", filename);
523 snprintf (buf, len, "file=%s", filename);
525 return guestfs_config (g, "-drive", buf);
529 guestfs_add_cdrom (guestfs_h *g, const char *filename)
531 if (strchr (filename, ',') != NULL) {
532 error (g, "filename cannot contain ',' (comma) character");
536 if (access (filename, F_OK) == -1) {
537 perrorf (g, "%s", filename);
541 return guestfs_config (g, "-cdrom", filename);
545 guestfs_launch (guestfs_h *g)
547 static const char *dir_template = "/tmp/libguestfsXXXXXX";
548 int r, i, len, pmore;
551 const char *kernel_name = "vmlinuz." REPO "." host_cpu;
552 const char *initrd_name = "initramfs." REPO "." host_cpu ".img";
553 char *path, *pelem, *pend;
554 char *kernel = NULL, *initrd = NULL;
556 struct sockaddr_un addr;
560 error (g, "you must call guestfs_add_drive before guestfs_launch");
564 if (g->state != CONFIG) {
565 error (g, "qemu has already been launched");
569 /* Search g->path for the kernel and initrd. */
570 pelem = path = safe_strdup (g, g->path);
572 pend = strchrnul (pelem, ':');
573 pmore = *pend == ':';
577 /* Empty element or "." means cwd. */
578 if (len == 0 || (len == 1 && *pelem == '.')) {
581 "looking for kernel and initrd in current directory\n");
582 if (access (kernel_name, F_OK) == 0 && access (initrd_name, F_OK) == 0) {
583 kernel = safe_strdup (g, kernel_name);
584 initrd = safe_strdup (g, initrd_name);
588 /* Look at <path>/kernel etc. */
590 kernel = safe_malloc (g, len + strlen (kernel_name) + 2);
591 initrd = safe_malloc (g, len + strlen (initrd_name) + 2);
592 sprintf (kernel, "%s/%s", pelem, kernel_name);
593 sprintf (initrd, "%s/%s", pelem, initrd_name);
596 fprintf (stderr, "looking for %s and %s\n", kernel, initrd);
598 if (access (kernel, F_OK) == 0 && access (initrd, F_OK) == 0)
602 kernel = initrd = NULL;
610 if (kernel == NULL || initrd == NULL) {
611 error (g, "cannot find %s or %s on LIBGUESTFS_PATH (current path = %s)",
612 kernel_name, initrd_name, g->path);
616 /* Make the temporary directory containing the socket. */
618 g->tmpdir = safe_strdup (g, dir_template);
619 if (mkdtemp (g->tmpdir) == NULL) {
620 perrorf (g, "%s: cannot create temporary directory", dir_template);
625 snprintf (unixsock, sizeof unixsock, "%s/sock", g->tmpdir);
628 if (pipe (wfd) == -1 || pipe (rfd) == -1) {
643 if (r == 0) { /* Child (qemu). */
647 /* Set up the full command line. Do this in the subprocess so we
648 * don't need to worry about cleaning up.
650 g->cmdline[0] = (char *) QEMU;
652 /* Construct the -net channel parameter for qemu. */
653 snprintf (vmchannel, sizeof vmchannel,
654 "channel,%d:unix:%s,server,nowait",
655 VMCHANNEL_PORT, unixsock);
657 /* Linux kernel command line. */
658 snprintf (append, sizeof append,
659 "console=ttyS0 guestfs=%s:%d", VMCHANNEL_ADDR, VMCHANNEL_PORT);
661 add_cmdline (g, "-m");
662 add_cmdline (g, "384"); /* XXX Choose best size. */
663 add_cmdline (g, "-no-kqemu"); /* Avoids a warning. */
664 add_cmdline (g, "-kernel");
665 add_cmdline (g, (char *) kernel);
666 add_cmdline (g, "-initrd");
667 add_cmdline (g, (char *) initrd);
668 add_cmdline (g, "-append");
669 add_cmdline (g, append);
670 add_cmdline (g, "-nographic");
671 add_cmdline (g, "-serial");
672 add_cmdline (g, "stdio");
673 add_cmdline (g, "-net");
674 add_cmdline (g, vmchannel);
675 add_cmdline (g, "-net");
676 add_cmdline (g, "user,vlan=0");
677 add_cmdline (g, "-net");
678 add_cmdline (g, "nic,vlan=0");
679 incr_cmdline_size (g);
680 g->cmdline[g->cmdline_size-1] = NULL;
683 fprintf (stderr, "%s", QEMU);
684 for (i = 0; g->cmdline[i]; ++i)
685 fprintf (stderr, " %s", g->cmdline[i]);
686 fprintf (stderr, "\n");
689 /* Set up stdin, stdout. */
700 /* Set up a new process group, so we can signal this process
701 * and all subprocesses (eg. if qemu is really a shell script).
706 execv (QEMU, g->cmdline); /* Run qemu. */
711 /* Parent (library). */
714 /* Start the clock ... */
717 /* Close the other ends of the pipe. */
721 if (fcntl (wfd[1], F_SETFL, O_NONBLOCK) == -1 ||
722 fcntl (rfd[0], F_SETFL, O_NONBLOCK) == -1) {
723 perrorf (g, "fcntl");
727 g->fd[0] = wfd[1]; /* stdin of child */
728 g->fd[1] = rfd[0]; /* stdout of child */
730 /* Open the Unix socket. The vmchannel implementation that got
731 * merged with qemu sucks in a number of ways. Both ends do
732 * connect(2), which means that no one knows what, if anything, is
733 * connected to the other end, or if it becomes disconnected. Even
734 * worse, we have to wait some indeterminate time for qemu to create
735 * the socket and connect to it (which happens very early in qemu's
736 * start-up), so any code that uses vmchannel is inherently racy.
737 * Hence this silly loop.
739 g->sock = socket (AF_UNIX, SOCK_STREAM, 0);
741 perrorf (g, "socket");
745 if (fcntl (g->sock, F_SETFL, O_NONBLOCK) == -1) {
746 perrorf (g, "fcntl");
750 addr.sun_family = AF_UNIX;
751 strncpy (addr.sun_path, unixsock, UNIX_PATH_MAX);
752 addr.sun_path[UNIX_PATH_MAX-1] = '\0';
756 /* Always sleep at least once to give qemu a small chance to start up. */
759 r = connect (g->sock, (struct sockaddr *) &addr, sizeof addr);
760 if ((r == -1 && errno == EINPROGRESS) || r == 0)
764 perrorf (g, "connect");
768 error (g, "failed to connect to vmchannel socket");
772 /* Watch the file descriptors. */
775 g->msg_in_size = g->msg_in_allocated = 0;
783 main_loop.add_handle (g, g->fd[1],
784 GUESTFS_HANDLE_READABLE,
786 if (g->stdout_watch == -1) {
787 error (g, "could not watch qemu stdout");
792 main_loop.add_handle (g, g->sock,
793 GUESTFS_HANDLE_READABLE,
795 if (g->sock_watch == -1) {
796 error (g, "could not watch daemon communications socket");
800 g->state = LAUNCHING;
804 if (g->stdout_watch >= 0)
805 main_loop.remove_handle (g, g->stdout_watch);
806 if (g->sock_watch >= 0)
807 main_loop.remove_handle (g, g->sock_watch);
816 waitpid (g->pid, NULL, 0);
822 g->stdout_watch = -1;
832 finish_wait_ready (guestfs_h *g, void *vp)
835 main_loop.main_loop_quit (g);
839 guestfs_wait_ready (guestfs_h *g)
843 if (g->state == READY) return 0;
845 if (g->state == BUSY) {
846 error (g, "qemu has finished launching already");
850 if (g->state != LAUNCHING) {
851 error (g, "qemu has not been launched yet");
855 g->launch_done_cb_internal = finish_wait_ready;
856 g->launch_done_cb_internal_data = &r;
857 main_loop.main_loop_run (g);
858 g->launch_done_cb_internal = NULL;
859 g->launch_done_cb_internal_data = NULL;
862 error (g, "guestfs_wait_ready failed, see earlier error messages");
866 /* This is possible in some really strange situations, such as
867 * guestfsd starts up OK but then qemu immediately exits. Check for
868 * it because the caller is probably expecting to be able to send
869 * commands after this function returns.
871 if (g->state != READY) {
872 error (g, "qemu launched and contacted daemon, but state != READY");
880 guestfs_kill_subprocess (guestfs_h *g)
882 if (g->state == CONFIG) {
883 error (g, "no subprocess to kill");
888 fprintf (stderr, "sending SIGTERM to process %d\n", g->pid);
890 kill (g->pid, SIGTERM);
895 /* This function is called whenever qemu prints something on stdout.
896 * Qemu's stdout is also connected to the guest's serial console, so
897 * we see kernel messages here too.
900 stdout_event (void *data, int watch, int fd, int events)
902 guestfs_h *g = (guestfs_h *) data;
909 "stdout_event: %p g->state = %d, fd = %d, events = 0x%x\n",
910 g, g->state, fd, events);
913 if (g->fd[1] != fd) {
914 error (g, "stdout_event: internal error: %d != %d", g->fd[1], fd);
918 n = read (fd, buf, sizeof buf);
920 /* Hopefully this indicates the qemu child process has died. */
922 fprintf (stderr, "stdout_event: %p: child process died\n", g);
923 /*kill (g->pid, SIGTERM);*/
924 waitpid (g->pid, NULL, 0);
925 if (g->stdout_watch >= 0)
926 main_loop.remove_handle (g, g->stdout_watch);
927 if (g->sock_watch >= 0)
928 main_loop.remove_handle (g, g->sock_watch);
937 g->stdout_watch = -1;
940 if (g->subprocess_quit_cb)
941 g->subprocess_quit_cb (g, g->subprocess_quit_cb_data);
951 /* In verbose mode, copy all log messages to stderr. */
955 /* It's an actual log message, send it upwards if anyone is listening. */
956 if (g->log_message_cb)
957 g->log_message_cb (g, g->log_message_cb_data, buf, n);
960 /* The function is called whenever we can read something on the
961 * guestfsd (daemon inside the guest) communication socket.
964 sock_read_event (void *data, int watch, int fd, int events)
966 guestfs_h *g = (guestfs_h *) data;
973 "sock_read_event: %p g->state = %d, fd = %d, events = 0x%x\n",
974 g, g->state, fd, events);
977 error (g, "sock_read_event: internal error: %d != %d", g->sock, fd);
981 if (g->msg_in_size <= g->msg_in_allocated) {
982 g->msg_in_allocated += 4096;
983 g->msg_in = safe_realloc (g, g->msg_in, g->msg_in_allocated);
985 n = read (g->sock, g->msg_in + g->msg_in_size,
986 g->msg_in_allocated - g->msg_in_size);
988 /* Disconnected? Ignore it because stdout_watch will get called
989 * and will do the cleanup.
1001 /* Have we got enough of a message to be able to process it yet? */
1002 if (g->msg_in_size < 4) return;
1004 xdrmem_create (&xdr, g->msg_in, g->msg_in_size, XDR_DECODE);
1005 if (!xdr_uint32_t (&xdr, &len)) {
1006 error (g, "can't decode length word");
1010 /* Length is normally the length of the message, but when guestfsd
1011 * starts up it sends a "magic" value (longer than any possible
1012 * message). Check for this.
1014 if (len == 0xf5f55ff5) {
1015 if (g->state != LAUNCHING)
1016 error (g, "received magic signature from guestfsd, but in state %d",
1018 else if (g->msg_in_size != 4)
1019 error (g, "received magic signature from guestfsd, but msg size is %d",
1023 if (g->launch_done_cb_internal)
1024 g->launch_done_cb_internal (g, g->launch_done_cb_internal_data);
1025 if (g->launch_done_cb)
1026 g->launch_done_cb (g, g->launch_done_cb_data);
1032 /* If this happens, it's pretty bad and we've probably lost synchronization.*/
1033 if (len > GUESTFS_MESSAGE_MAX) {
1034 error (g, "message length (%u) > maximum possible size (%d)",
1035 len, GUESTFS_MESSAGE_MAX);
1039 if (g->msg_in_size-4 < len) return; /* Need more of this message. */
1041 /* This should not happen, and if it does it probably means we've
1042 * lost all hope of synchronization.
1044 if (g->msg_in_size-4 > len) {
1045 error (g, "len = %d, but msg_in_size-4 = %d", len, g->msg_in_size-4);
1049 /* Got the full message, begin processing it. */
1053 for (i = 0; i < g->msg_in_size; i += 16) {
1054 printf ("%04x: ", i);
1055 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1056 printf ("%02x ", (unsigned char) g->msg_in[j]);
1057 for (; j < i+16; ++j)
1060 for (j = i; j < MIN (i+16, g->msg_in_size); ++j)
1061 if (isprint (g->msg_in[j]))
1062 printf ("%c", g->msg_in[j]);
1065 for (; j < i+16; ++j)
1071 /* Not in the expected state. */
1072 if (g->state != BUSY)
1073 error (g, "state %d != BUSY", g->state);
1075 /* Push the message up to the higher layer. Note that unlike
1076 * launch_done_cb / launch_done_cb_internal, we only call at
1077 * most one of the callback functions here.
1080 if (g->reply_cb_internal)
1081 g->reply_cb_internal (g, g->reply_cb_internal_data, &xdr);
1082 else if (g->reply_cb)
1083 g->reply_cb (g, g->reply_cb, &xdr);
1086 /* Free the message buffer if it's grown excessively large. */
1087 if (g->msg_in_allocated > 65536) {
1090 g->msg_in_size = g->msg_in_allocated = 0;
1097 /* The function is called whenever we can write something on the
1098 * guestfsd (daemon inside the guest) communication socket.
1101 sock_write_event (void *data, int watch, int fd, int events)
1103 guestfs_h *g = (guestfs_h *) data;
1108 "sock_write_event: %p g->state = %d, fd = %d, events = 0x%x\n",
1109 g, g->state, fd, events);
1111 if (g->sock != fd) {
1112 error (g, "sock_write_event: internal error: %d != %d", g->sock, fd);
1116 if (g->state != BUSY) {
1117 error (g, "sock_write_event: state %d != BUSY", g->state);
1122 fprintf (stderr, "sock_write_event: writing %d bytes ...\n",
1123 g->msg_out_size - g->msg_out_pos);
1125 n = write (g->sock, g->msg_out + g->msg_out_pos,
1126 g->msg_out_size - g->msg_out_pos);
1128 if (errno != EAGAIN)
1129 perrorf (g, "write");
1134 fprintf (stderr, "sock_write_event: wrote %d bytes\n", n);
1136 g->msg_out_pos += n;
1138 /* More to write? */
1139 if (g->msg_out_pos < g->msg_out_size)
1143 fprintf (stderr, "sock_write_event: done writing, switching back to reading events\n");
1146 g->msg_out_pos = g->msg_out_size = 0;
1148 if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1149 error (g, "remove_handle failed in sock_write_event");
1153 main_loop.add_handle (g, g->sock,
1154 GUESTFS_HANDLE_READABLE,
1155 sock_read_event, g);
1156 if (g->sock_watch == -1) {
1157 error (g, "add_handle failed in sock_write_event");
1162 /* Dispatch a call to the remote daemon. This function just queues
1163 * the call in msg_out, to be sent when we next enter the main loop.
1164 * Returns -1 for error, or the message serial number.
1167 dispatch (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args)
1169 char buffer[GUESTFS_MESSAGE_MAX];
1170 struct guestfs_message_header hdr;
1173 int serial = g->msg_next_serial++;
1175 if (g->state != READY) {
1176 error (g, "dispatch: state %d != READY", g->state);
1180 /* Serialize the header. */
1181 hdr.prog = GUESTFS_PROGRAM;
1182 hdr.vers = GUESTFS_PROTOCOL_VERSION;
1184 hdr.direction = GUESTFS_DIRECTION_CALL;
1185 hdr.serial = serial;
1186 hdr.status = GUESTFS_STATUS_OK;
1188 xdrmem_create (&xdr, buffer, sizeof buffer, XDR_ENCODE);
1189 if (!xdr_guestfs_message_header (&xdr, &hdr)) {
1190 error (g, "xdr_guestfs_message_header failed");
1194 /* Serialize the args. If any, because some message types
1195 * have no parameters.
1198 if (!(*xdrp) (&xdr, args)) {
1199 error (g, "dispatch failed to marshal args");
1204 len = xdr_getpos (&xdr);
1207 /* Allocate the outgoing message buffer. */
1208 g->msg_out = safe_malloc (g, len + 4);
1210 g->msg_out_size = len + 4;
1214 xdrmem_create (&xdr, g->msg_out, 4, XDR_ENCODE);
1215 if (!xdr_uint32_t (&xdr, &len)) {
1216 error (g, "xdr_uint32_t failed in dispatch");
1220 memcpy (g->msg_out + 4, buffer, len);
1222 /* Change the handle to sock_write_event. */
1223 if (main_loop.remove_handle (g, g->sock_watch) == -1) {
1224 error (g, "remove_handle failed in dispatch");
1228 main_loop.add_handle (g, g->sock,
1229 GUESTFS_HANDLE_WRITABLE,
1230 sock_write_event, g);
1231 if (g->sock_watch == -1) {
1232 error (g, "add_handle failed in dispatch");
1241 g->msg_out_size = 0;
1246 /* Check the return message from a call for validity. */
1248 check_reply_header (guestfs_h *g,
1249 const struct guestfs_message_header *hdr,
1250 int proc_nr, int serial)
1252 if (hdr->prog != GUESTFS_PROGRAM) {
1253 error (g, "wrong program (%d/%d)", hdr->prog, GUESTFS_PROGRAM);
1256 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
1257 error (g, "wrong protocol version (%d/%d)",
1258 hdr->vers, GUESTFS_PROTOCOL_VERSION);
1261 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
1262 error (g, "unexpected message direction (%d/%d)",
1263 hdr->direction, GUESTFS_DIRECTION_REPLY);
1266 if (hdr->proc != proc_nr) {
1267 error (g, "unexpected procedure number (%d/%d)", hdr->proc, proc_nr);
1270 if (hdr->serial != serial) {
1271 error (g, "unexpected serial (%d/%d)", hdr->serial, serial);
1278 /* The high-level actions are autogenerated by generator.ml. Include
1281 #include "guestfs-actions.c"
1283 /* Structure-freeing functions. These rely on the fact that the
1284 * structure format is identical to the XDR format. See note in
1288 guestfs_free_int_bool (struct guestfs_int_bool *x)
1294 guestfs_free_lvm_pv_list (struct guestfs_lvm_pv_list *x)
1296 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_pv_list, (char *) x);
1301 guestfs_free_lvm_vg_list (struct guestfs_lvm_vg_list *x)
1303 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_vg_list, (char *) x);
1308 guestfs_free_lvm_lv_list (struct guestfs_lvm_lv_list *x)
1310 xdr_free ((xdrproc_t) xdr_guestfs_lvm_int_lv_list, (char *) x);
1314 /* This is the default main loop implementation, using select(2). */
1316 struct handle_cb_data {
1317 guestfs_handle_event_cb cb;
1324 static int select_init_done = 0;
1325 static int max_fd = -1;
1326 static int nr_fds = 0;
1327 static struct handle_cb_data *handle_cb_data = NULL;
1332 if (!select_init_done) {
1337 select_init_done = 1;
1342 select_add_handle (guestfs_h *g, int fd, int events,
1343 guestfs_handle_event_cb cb, void *data)
1347 if (fd < 0 || fd >= FD_SETSIZE) {
1348 error (g, "fd %d is out of range", fd);
1352 if ((events & ~(GUESTFS_HANDLE_READABLE |
1353 GUESTFS_HANDLE_WRITABLE |
1354 GUESTFS_HANDLE_HANGUP |
1355 GUESTFS_HANDLE_ERROR)) != 0) {
1356 error (g, "set of events (0x%x) contains unknown events", events);
1361 error (g, "set of events is empty");
1365 if (FD_ISSET (fd, &rset) || FD_ISSET (fd, &wset) || FD_ISSET (fd, &xset)) {
1366 error (g, "fd %d is already registered", fd);
1371 error (g, "callback is NULL");
1375 if ((events & GUESTFS_HANDLE_READABLE))
1377 if ((events & GUESTFS_HANDLE_WRITABLE))
1379 if ((events & GUESTFS_HANDLE_HANGUP) || (events & GUESTFS_HANDLE_ERROR))
1384 handle_cb_data = safe_realloc (g, handle_cb_data,
1385 sizeof (struct handle_cb_data) * (max_fd+1));
1387 handle_cb_data[fd].cb = cb;
1388 handle_cb_data[fd].data = data;
1392 /* Any integer >= 0 can be the handle, and this is as good as any ... */
1397 select_remove_handle (guestfs_h *g, int fd)
1401 if (fd < 0 || fd >= FD_SETSIZE) {
1402 error (g, "fd %d is out of range", fd);
1406 if (!FD_ISSET (fd, &rset) && !FD_ISSET (fd, &wset) && !FD_ISSET (fd, &xset)) {
1407 error (g, "fd %d was not registered", fd);
1417 handle_cb_data = safe_realloc (g, handle_cb_data,
1418 sizeof (struct handle_cb_data) * (max_fd+1));
1427 select_add_timeout (guestfs_h *g, int interval,
1428 guestfs_handle_timeout_cb cb, void *data)
1432 abort (); /* XXX not implemented yet */
1436 select_remove_timeout (guestfs_h *g, int timer)
1440 abort (); /* XXX not implemented yet */
1443 /* Note that main loops can be nested. */
1444 static int level = 0;
1447 select_main_loop_run (guestfs_h *g)
1449 int old_level, fd, r, events;
1450 fd_set rset2, wset2, xset2;
1454 old_level = level++;
1455 while (level > old_level) {
1464 r = select (max_fd+1, &rset2, &wset2, &xset2, NULL);
1466 perrorf (g, "select");
1471 for (fd = 0; r > 0 && fd <= max_fd; ++fd) {
1473 if (FD_ISSET (fd, &rset2))
1474 events |= GUESTFS_HANDLE_READABLE;
1475 if (FD_ISSET (fd, &wset2))
1476 events |= GUESTFS_HANDLE_WRITABLE;
1477 if (FD_ISSET (fd, &xset2))
1478 events |= GUESTFS_HANDLE_ERROR | GUESTFS_HANDLE_HANGUP;
1481 handle_cb_data[fd].cb (handle_cb_data[fd].data,
1489 select_main_loop_quit (guestfs_h *g)
1494 error (g, "cannot quit, we are not in a main loop");