2 * Copyright (C) 2009-2010 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 */
34 #include <sys/select.h>
38 #include <rpc/types.h>
45 #ifdef HAVE_SYS_TYPES_H
46 #include <sys/types.h>
49 #ifdef HAVE_SYS_WAIT_H
53 #ifdef HAVE_SYS_SOCKET_H
54 #include <sys/socket.h>
61 #include <arpa/inet.h>
62 #include <netinet/in.h>
65 #include "glthread/lock.h"
70 #include "guestfs-internal.h"
71 #include "guestfs-internal-actions.h"
72 #include "guestfs_protocol.h"
74 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
75 static void close_handles (void);
77 gl_lock_define_initialized (static, handles_lock);
78 static guestfs_h *handles = NULL;
79 static int atexit_handler_set = 0;
87 g = malloc (sizeof (*g));
90 memset (g, 0, sizeof (*g));
99 g->error_cb = default_error_cb;
100 g->error_cb_data = NULL;
102 g->recovery_proc = 1;
105 str = getenv ("LIBGUESTFS_DEBUG");
106 g->verbose = str != NULL && STREQ (str, "1");
108 str = getenv ("LIBGUESTFS_TRACE");
109 g->trace = str != NULL && STREQ (str, "1");
111 str = getenv ("LIBGUESTFS_PATH");
112 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
113 if (!g->path) goto error;
115 str = getenv ("LIBGUESTFS_QEMU");
116 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
117 if (!g->qemu) goto error;
119 str = getenv ("LIBGUESTFS_APPEND");
121 g->append = strdup (str);
122 if (!g->append) goto error;
125 /* Choose a suitable memory size. Previously we tried to choose
126 * a minimal memory size, but this isn't really necessary since
127 * recent QEMU and KVM don't do anything nasty like locking
128 * memory into core any more. Thus we can safely choose a
129 * large, generous amount of memory, and it'll just get swapped
130 * on smaller systems.
132 str = getenv ("LIBGUESTFS_MEMSIZE");
134 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
135 warning (g, "non-numeric or too small value for LIBGUESTFS_MEMSIZE");
141 /* Start with large serial numbers so they are easy to spot
142 * inside the protocol.
144 g->msg_next_serial = 0x00123400;
146 /* Link the handles onto a global list. */
147 gl_lock_lock (handles_lock);
150 if (!atexit_handler_set) {
151 atexit (close_handles);
152 atexit_handler_set = 1;
154 gl_lock_unlock (handles_lock);
156 debug (g, "new guestfs handle %p", g);
169 guestfs_close (guestfs_h *g)
175 if (g->state == NO_HANDLE) {
176 /* Not safe to call ANY callbacks here, so ... */
177 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
181 debug (g, "closing guestfs handle %p (state %d)", g, g->state);
183 /* Try to sync if autosync flag is set. */
184 if (g->autosync && g->state == READY)
185 guestfs_internal_autosync (g);
187 /* Kill the qemu subprocess. */
188 if (g->state != CONFIG)
189 guestfs_kill_subprocess (g);
191 /* Run user close callbacks. */
192 guestfs___call_callbacks_void (g, GUESTFS_EVENT_CLOSE);
194 /* Remove all other registered callbacks. Since we've already
195 * called the close callbacks, we shouldn't call any others.
201 guestfs___free_inspect_info (g);
214 /* Wait for subprocess(es) to exit. */
215 if (g->pid > 0) waitpid (g->pid, NULL, 0);
216 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
218 /* Remove tmpfiles. */
220 snprintf (filename, sizeof filename, "%s/guestfsd.sock", g->tmpdir);
229 for (i = 0; i < g->cmdline_size; ++i)
230 free (g->cmdline[i]);
234 /* Mark the handle as dead before freeing it. */
235 g->state = NO_HANDLE;
237 gl_lock_lock (handles_lock);
241 for (gg = handles; gg->next != g; gg = gg->next)
245 gl_lock_unlock (handles_lock);
249 free (g->last_error);
254 free (g->qemu_version);
258 /* Close all open handles (called from atexit(3)). */
262 while (handles) guestfs_close (handles);
266 guestfs_last_error (guestfs_h *g)
268 return g->last_error;
272 guestfs_last_errno (guestfs_h *g)
274 return g->last_errnum;
278 set_last_error (guestfs_h *g, int errnum, const char *msg)
280 free (g->last_error);
281 g->last_error = strdup (msg);
282 g->last_errnum = errnum;
285 /* Warning are printed unconditionally. We try to make these rare.
286 * Generally speaking, a warning should either be an error, or if it's
287 * not important for end users then it should be a debug message.
290 guestfs___warning (guestfs_h *g, const char *fs, ...)
297 len = vasprintf (&msg, fs, args);
302 len = asprintf (&msg2, _("warning: %s"), msg);
307 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg2, len);
312 /* Debug messages. */
314 guestfs___debug (guestfs_h *g, const char *fs, ...)
320 /* The cpp macro "debug" has already checked that g->verbose is true
321 * before calling this function, but we check it again just in case
322 * anyone calls this function directly.
328 len = vasprintf (&msg, fs, args);
333 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg, len);
336 /* Call trace messages. These are enabled by setting g->trace, and
337 * calls to this function should only happen from the generated code
341 guestfs___trace (guestfs_h *g, const char *fs, ...)
348 len = vasprintf (&msg, fs, args);
353 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, msg, len);
359 default_error_cb (guestfs_h *g, void *data, const char *msg)
361 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
365 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
371 int err = vasprintf (&msg, fs, args);
376 /* set_last_error first so that the callback can access the error
377 * message and errno through the handle if it wishes.
379 set_last_error (g, errnum, msg);
380 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
386 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
393 int err = vasprintf (&msg, fs, args);
398 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
400 strerror_r (errnum, buf, sizeof buf);
404 buf = strerror_r (errnum, _buf, sizeof _buf);
407 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
411 /* set_last_error first so that the callback can access the error
412 * message and errno through the handle if it wishes.
414 set_last_error (g, errnum, msg);
415 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
421 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
423 void *ptr = malloc (nbytes);
424 if (nbytes > 0 && !ptr) g->abort_cb ();
428 /* Return 1 if an array of N objects, each of size S, cannot exist due
429 to size arithmetic overflow. S must be positive and N must be
430 nonnegative. This is a macro, not an inline function, so that it
431 works correctly even when SIZE_MAX < N.
433 By gnulib convention, SIZE_MAX represents overflow in size
434 calculations, so the conservative dividend to use here is
435 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
436 However, malloc (SIZE_MAX) fails on all known hosts where
437 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
438 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
439 branch when S is known to be 1. */
440 # define xalloc_oversized(n, s) \
441 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
443 /* Technically we should add an autoconf test for this, testing for the desired
444 functionality, like what's done in gnulib, but for now, this is fine. */
445 #if defined(__GLIBC__)
446 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
448 #define HAVE_GNU_CALLOC 0
451 /* Allocate zeroed memory for N elements of S bytes, with error
452 checking. S must be nonzero. */
454 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
456 /* From gnulib's calloc function in xmalloc.c. */
458 /* Test for overflow, since some calloc implementations don't have
459 proper overflow checks. But omit overflow and size-zero tests if
460 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
461 returns NULL if successful. */
462 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
463 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
469 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
471 void *p = realloc (ptr, nbytes);
472 if (nbytes > 0 && !p) g->abort_cb ();
477 guestfs_safe_strdup (guestfs_h *g, const char *str)
479 char *s = strdup (str);
480 if (!s) g->abort_cb ();
485 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
487 char *s = strndup (str, n);
488 if (!s) g->abort_cb ();
493 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
495 void *p = malloc (size);
496 if (!p) g->abort_cb ();
497 memcpy (p, ptr, size);
502 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
508 int err = vasprintf (&msg, fs, args);
518 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
524 guestfs_get_out_of_memory_handler (guestfs_h *g)
530 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
533 g->error_cb_data = data;
536 guestfs_error_handler_cb
537 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
539 if (data_rtn) *data_rtn = g->error_cb_data;
544 guestfs__set_verbose (guestfs_h *g, int v)
551 guestfs__get_verbose (guestfs_h *g)
557 guestfs__set_autosync (guestfs_h *g, int a)
564 guestfs__get_autosync (guestfs_h *g)
570 guestfs__set_path (guestfs_h *g, const char *path)
577 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
582 guestfs__get_path (guestfs_h *g)
588 guestfs__set_qemu (guestfs_h *g, const char *qemu)
593 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
598 guestfs__get_qemu (guestfs_h *g)
604 guestfs__set_append (guestfs_h *g, const char *append)
609 g->append = append ? safe_strdup (g, append) : NULL;
614 guestfs__get_append (guestfs_h *g)
620 guestfs__set_memsize (guestfs_h *g, int memsize)
622 g->memsize = memsize;
627 guestfs__get_memsize (guestfs_h *g)
633 guestfs__set_selinux (guestfs_h *g, int selinux)
635 g->selinux = selinux;
640 guestfs__get_selinux (guestfs_h *g)
646 guestfs__get_pid (guestfs_h *g)
651 error (g, "get_pid: no qemu subprocess");
656 struct guestfs_version *
657 guestfs__version (guestfs_h *g)
659 struct guestfs_version *r;
661 r = safe_malloc (g, sizeof *r);
662 r->major = PACKAGE_VERSION_MAJOR;
663 r->minor = PACKAGE_VERSION_MINOR;
664 r->release = PACKAGE_VERSION_RELEASE;
665 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
670 guestfs__set_trace (guestfs_h *g, int t)
677 guestfs__get_trace (guestfs_h *g)
683 guestfs__set_direct (guestfs_h *g, int d)
690 guestfs__get_direct (guestfs_h *g)
696 guestfs__set_recovery_proc (guestfs_h *g, int f)
698 g->recovery_proc = !!f;
703 guestfs__get_recovery_proc (guestfs_h *g)
705 return g->recovery_proc;
709 guestfs__set_network (guestfs_h *g, int v)
711 g->enable_network = !!v;
716 guestfs__get_network (guestfs_h *g)
718 return g->enable_network;
722 guestfs__set_attach_method (guestfs_h *g, const char *method)
724 if (STREQ (method, "appliance")) {
725 g->attach_method = ATTACH_METHOD_APPLIANCE;
726 free (g->attach_method_arg);
727 g->attach_method_arg = NULL;
729 else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
730 g->attach_method = ATTACH_METHOD_UNIX;
731 free (g->attach_method_arg);
732 g->attach_method_arg = safe_strdup (g, method + 5);
733 /* Note that we don't check the path exists until launch is called. */
736 error (g, "invalid attach method: %s", method);
744 guestfs__get_attach_method (guestfs_h *g)
748 switch (g->attach_method) {
749 case ATTACH_METHOD_APPLIANCE:
750 ret = safe_strdup (g, "appliance");
753 case ATTACH_METHOD_UNIX:
754 ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
755 strcpy (ret, "unix:");
756 strcat (ret, g->attach_method_arg);
759 default: /* keep GCC happy - this is not reached */
766 /* Note the private data area is allocated lazily, since the vast
767 * majority of callers will never use it. This means g->pda is
772 void *data; /* opaque user data pointer */
776 hasher (void const *x, size_t table_size)
778 struct pda_entry const *p = x;
779 return hash_pjw (p->key, table_size);
783 comparator (void const *x, void const *y)
785 struct pda_entry const *a = x;
786 struct pda_entry const *b = y;
787 return STREQ (a->key, b->key);
794 struct pda_entry *p = x;
801 guestfs_set_private (guestfs_h *g, const char *key, void *data)
803 if (g->pda == NULL) {
804 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
809 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
810 new_entry->key = safe_strdup (g, key);
811 new_entry->data = data;
813 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
816 struct pda_entry *entry = hash_insert (g->pda, new_entry);
819 assert (entry == new_entry);
823 bad_cast (char const *s)
829 guestfs_get_private (guestfs_h *g, const char *key)
832 return NULL; /* no keys have been set */
834 const struct pda_entry k = { .key = bad_cast (key) };
835 struct pda_entry *entry = hash_lookup (g->pda, &k);
844 guestfs_first_private (guestfs_h *g, const char **key_rtn)
849 g->pda_next = hash_get_first (g->pda);
851 /* Ignore any keys with NULL data pointers. */
852 while (g->pda_next && g->pda_next->data == NULL)
853 g->pda_next = hash_get_next (g->pda, g->pda_next);
855 if (g->pda_next == NULL)
858 *key_rtn = g->pda_next->key;
859 return g->pda_next->data;
863 guestfs_next_private (guestfs_h *g, const char **key_rtn)
868 if (g->pda_next == NULL)
871 /* Walk to the next key with a non-NULL data pointer. */
873 g->pda_next = hash_get_next (g->pda, g->pda_next);
874 } while (g->pda_next && g->pda_next->data == NULL);
876 if (g->pda_next == NULL)
879 *key_rtn = g->pda_next->key;
880 return g->pda_next->data;
883 /* When tracing, be careful how we print BufferIn parameters which
884 * usually contain large amounts of binary data (RHBZ#646822).
887 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
890 size_t orig_size = buf_size;
897 for (i = 0; i < buf_size; ++i) {
898 if (c_isprint (buf[i]))
901 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
906 if (orig_size > buf_size)
908 _("<truncated, original size %zu bytes>"), orig_size);
912 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
914 guestfs___print_BufferIn (out, buf, buf_size);
918 guestfs___free_string_list (char **argv)
921 for (i = 0; argv[i] != NULL; ++i)