2 * Copyright (C) 2009-2011 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 remove_tmpdir (guestfs_h *g);
76 static void close_handles (void);
78 gl_lock_define_initialized (static, handles_lock);
79 static guestfs_h *handles = NULL;
80 static int atexit_handler_set = 0;
88 g = malloc (sizeof (*g));
91 memset (g, 0, sizeof (*g));
100 g->error_cb = default_error_cb;
101 g->error_cb_data = NULL;
103 g->recovery_proc = 1;
106 str = getenv ("LIBGUESTFS_DEBUG");
107 g->verbose = str != NULL && STREQ (str, "1");
109 str = getenv ("LIBGUESTFS_TRACE");
110 g->trace = str != NULL && STREQ (str, "1");
112 str = getenv ("LIBGUESTFS_PATH");
113 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
114 if (!g->path) goto error;
116 str = getenv ("LIBGUESTFS_QEMU");
117 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
118 if (!g->qemu) goto error;
120 str = getenv ("LIBGUESTFS_APPEND");
122 g->append = strdup (str);
123 if (!g->append) goto error;
126 /* Choose a suitable memory size. Previously we tried to choose
127 * a minimal memory size, but this isn't really necessary since
128 * recent QEMU and KVM don't do anything nasty like locking
129 * memory into core any more. Thus we can safely choose a
130 * large, generous amount of memory, and it'll just get swapped
131 * on smaller systems.
133 str = getenv ("LIBGUESTFS_MEMSIZE");
135 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
136 warning (g, "non-numeric or too small value for LIBGUESTFS_MEMSIZE");
142 /* Start with large serial numbers so they are easy to spot
143 * inside the protocol.
145 g->msg_next_serial = 0x00123400;
147 /* Link the handles onto a global list. */
148 gl_lock_lock (handles_lock);
151 if (!atexit_handler_set) {
152 atexit (close_handles);
153 atexit_handler_set = 1;
155 gl_lock_unlock (handles_lock);
157 debug (g, "new guestfs handle %p", g);
170 guestfs_close (guestfs_h *g)
172 if (g->state == NO_HANDLE) {
173 /* Not safe to call ANY callbacks here, so ... */
174 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
179 const char trace_msg[] = "close";
181 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE,
182 trace_msg, strlen (trace_msg));
185 debug (g, "closing guestfs handle %p (state %d)", g, g->state);
187 /* Try to sync if autosync flag is set. */
188 if (g->autosync && g->state == READY)
189 guestfs_internal_autosync (g);
191 /* Kill the qemu subprocess. */
192 if (g->state != CONFIG)
193 guestfs_kill_subprocess (g);
195 /* Run user close callbacks. */
196 guestfs___call_callbacks_void (g, GUESTFS_EVENT_CLOSE);
198 /* Remove all other registered callbacks. Since we've already
199 * called the close callbacks, we shouldn't call any others.
205 guestfs___free_inspect_info (g);
218 /* Wait for subprocess(es) to exit. */
219 if (g->pid > 0) waitpid (g->pid, NULL, 0);
220 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
222 /* Remove whole temporary directory. */
228 for (i = 0; i < g->cmdline_size; ++i)
229 free (g->cmdline[i]);
233 /* Mark the handle as dead before freeing it. */
234 g->state = NO_HANDLE;
236 gl_lock_lock (handles_lock);
242 for (gg = handles; gg->next != g; gg = gg->next)
246 gl_lock_unlock (handles_lock);
250 free (g->last_error);
255 free (g->qemu_version);
259 /* g->tmpdir can contain any files (but not subdirectories). Remove
260 * those and the directory itself. Note that errors in this function
261 * aren't really that important: if we end up not deleting temporary
262 * files it's only annoying.
265 remove_tmpdir (guestfs_h *g)
273 dir = opendir (g->tmpdir);
279 while ((d = readdir (dir)) != NULL) {
280 if (STRNEQ (d->d_name, ".") && STRNEQ (d->d_name, "..")) {
281 if (unlinkat (dirfd (dir), d->d_name, 0) == -1)
286 if (closedir (dir) == -1)
289 if (rmdir (g->tmpdir) == -1)
296 /* Close all open handles (called from atexit(3)). */
300 while (handles) guestfs_close (handles);
304 guestfs_last_error (guestfs_h *g)
306 return g->last_error;
310 guestfs_last_errno (guestfs_h *g)
312 return g->last_errnum;
316 set_last_error (guestfs_h *g, int errnum, const char *msg)
318 free (g->last_error);
319 g->last_error = strdup (msg);
320 g->last_errnum = errnum;
323 /* Warning are printed unconditionally. We try to make these rare.
324 * Generally speaking, a warning should either be an error, or if it's
325 * not important for end users then it should be a debug message.
328 guestfs___warning (guestfs_h *g, const char *fs, ...)
335 len = vasprintf (&msg, fs, args);
340 len = asprintf (&msg2, _("warning: %s"), msg);
345 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg2, len);
350 /* Debug messages. */
352 guestfs___debug (guestfs_h *g, const char *fs, ...)
358 /* The cpp macro "debug" has already checked that g->verbose is true
359 * before calling this function, but we check it again just in case
360 * anyone calls this function directly.
366 len = vasprintf (&msg, fs, args);
371 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg, len);
374 /* Call trace messages. These are enabled by setting g->trace, and
375 * calls to this function should only happen from the generated code
379 guestfs___trace (guestfs_h *g, const char *fs, ...)
386 len = vasprintf (&msg, fs, args);
391 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, msg, len);
397 default_error_cb (guestfs_h *g, void *data, const char *msg)
399 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
403 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
409 int err = vasprintf (&msg, fs, args);
414 /* set_last_error first so that the callback can access the error
415 * message and errno through the handle if it wishes.
417 set_last_error (g, errnum, msg);
418 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
424 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
431 int err = vasprintf (&msg, fs, args);
436 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
438 strerror_r (errnum, buf, sizeof buf);
442 buf = strerror_r (errnum, _buf, sizeof _buf);
445 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
449 /* set_last_error first so that the callback can access the error
450 * message and errno through the handle if it wishes.
452 set_last_error (g, errnum, msg);
453 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
459 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
461 void *ptr = malloc (nbytes);
462 if (nbytes > 0 && !ptr) g->abort_cb ();
466 /* Return 1 if an array of N objects, each of size S, cannot exist due
467 to size arithmetic overflow. S must be positive and N must be
468 nonnegative. This is a macro, not an inline function, so that it
469 works correctly even when SIZE_MAX < N.
471 By gnulib convention, SIZE_MAX represents overflow in size
472 calculations, so the conservative dividend to use here is
473 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
474 However, malloc (SIZE_MAX) fails on all known hosts where
475 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
476 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
477 branch when S is known to be 1. */
478 # define xalloc_oversized(n, s) \
479 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
481 /* Technically we should add an autoconf test for this, testing for the desired
482 functionality, like what's done in gnulib, but for now, this is fine. */
483 #if defined(__GLIBC__)
484 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
486 #define HAVE_GNU_CALLOC 0
489 /* Allocate zeroed memory for N elements of S bytes, with error
490 checking. S must be nonzero. */
492 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
494 /* From gnulib's calloc function in xmalloc.c. */
496 /* Test for overflow, since some calloc implementations don't have
497 proper overflow checks. But omit overflow and size-zero tests if
498 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
499 returns NULL if successful. */
500 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
501 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
507 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
509 void *p = realloc (ptr, nbytes);
510 if (nbytes > 0 && !p) g->abort_cb ();
515 guestfs_safe_strdup (guestfs_h *g, const char *str)
517 char *s = strdup (str);
518 if (!s) g->abort_cb ();
523 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
525 char *s = strndup (str, n);
526 if (!s) g->abort_cb ();
531 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
533 void *p = malloc (size);
534 if (!p) g->abort_cb ();
535 memcpy (p, ptr, size);
540 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
546 int err = vasprintf (&msg, fs, args);
556 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
562 guestfs_get_out_of_memory_handler (guestfs_h *g)
568 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
571 g->error_cb_data = data;
574 guestfs_error_handler_cb
575 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
577 if (data_rtn) *data_rtn = g->error_cb_data;
582 guestfs_user_cancel (guestfs_h *g)
588 guestfs__set_verbose (guestfs_h *g, int v)
595 guestfs__get_verbose (guestfs_h *g)
601 guestfs__set_autosync (guestfs_h *g, int a)
608 guestfs__get_autosync (guestfs_h *g)
614 guestfs__set_path (guestfs_h *g, const char *path)
621 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
626 guestfs__get_path (guestfs_h *g)
632 guestfs__set_qemu (guestfs_h *g, const char *qemu)
637 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
642 guestfs__get_qemu (guestfs_h *g)
648 guestfs__set_append (guestfs_h *g, const char *append)
653 g->append = append ? safe_strdup (g, append) : NULL;
658 guestfs__get_append (guestfs_h *g)
664 guestfs__set_memsize (guestfs_h *g, int memsize)
666 g->memsize = memsize;
671 guestfs__get_memsize (guestfs_h *g)
677 guestfs__set_selinux (guestfs_h *g, int selinux)
679 g->selinux = selinux;
684 guestfs__get_selinux (guestfs_h *g)
690 guestfs__get_pid (guestfs_h *g)
695 error (g, "get_pid: no qemu subprocess");
700 struct guestfs_version *
701 guestfs__version (guestfs_h *g)
703 struct guestfs_version *r;
705 r = safe_malloc (g, sizeof *r);
706 r->major = PACKAGE_VERSION_MAJOR;
707 r->minor = PACKAGE_VERSION_MINOR;
708 r->release = PACKAGE_VERSION_RELEASE;
709 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
714 guestfs__set_trace (guestfs_h *g, int t)
721 guestfs__get_trace (guestfs_h *g)
727 guestfs__set_direct (guestfs_h *g, int d)
734 guestfs__get_direct (guestfs_h *g)
740 guestfs__set_recovery_proc (guestfs_h *g, int f)
742 g->recovery_proc = !!f;
747 guestfs__get_recovery_proc (guestfs_h *g)
749 return g->recovery_proc;
753 guestfs__set_network (guestfs_h *g, int v)
755 g->enable_network = !!v;
760 guestfs__get_network (guestfs_h *g)
762 return g->enable_network;
766 guestfs__set_attach_method (guestfs_h *g, const char *method)
768 if (STREQ (method, "appliance")) {
769 g->attach_method = ATTACH_METHOD_APPLIANCE;
770 free (g->attach_method_arg);
771 g->attach_method_arg = NULL;
773 else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
774 g->attach_method = ATTACH_METHOD_UNIX;
775 free (g->attach_method_arg);
776 g->attach_method_arg = safe_strdup (g, method + 5);
777 /* Note that we don't check the path exists until launch is called. */
780 error (g, "invalid attach method: %s", method);
788 guestfs__get_attach_method (guestfs_h *g)
792 switch (g->attach_method) {
793 case ATTACH_METHOD_APPLIANCE:
794 ret = safe_strdup (g, "appliance");
797 case ATTACH_METHOD_UNIX:
798 ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
799 strcpy (ret, "unix:");
800 strcat (ret, g->attach_method_arg);
803 default: /* keep GCC happy - this is not reached */
811 guestfs__set_pgroup (guestfs_h *g, int v)
818 guestfs__get_pgroup (guestfs_h *g)
823 /* Note the private data area is allocated lazily, since the vast
824 * majority of callers will never use it. This means g->pda is
829 void *data; /* opaque user data pointer */
833 hasher (void const *x, size_t table_size)
835 struct pda_entry const *p = x;
836 return hash_pjw (p->key, table_size);
840 comparator (void const *x, void const *y)
842 struct pda_entry const *a = x;
843 struct pda_entry const *b = y;
844 return STREQ (a->key, b->key);
851 struct pda_entry *p = x;
858 guestfs_set_private (guestfs_h *g, const char *key, void *data)
860 if (g->pda == NULL) {
861 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
866 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
867 new_entry->key = safe_strdup (g, key);
868 new_entry->data = data;
870 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
873 struct pda_entry *entry = hash_insert (g->pda, new_entry);
876 assert (entry == new_entry);
880 bad_cast (char const *s)
886 guestfs_get_private (guestfs_h *g, const char *key)
889 return NULL; /* no keys have been set */
891 const struct pda_entry k = { .key = bad_cast (key) };
892 struct pda_entry *entry = hash_lookup (g->pda, &k);
901 guestfs_first_private (guestfs_h *g, const char **key_rtn)
906 g->pda_next = hash_get_first (g->pda);
908 /* Ignore any keys with NULL data pointers. */
909 while (g->pda_next && g->pda_next->data == NULL)
910 g->pda_next = hash_get_next (g->pda, g->pda_next);
912 if (g->pda_next == NULL)
915 *key_rtn = g->pda_next->key;
916 return g->pda_next->data;
920 guestfs_next_private (guestfs_h *g, const char **key_rtn)
925 if (g->pda_next == NULL)
928 /* Walk to the next key with a non-NULL data pointer. */
930 g->pda_next = hash_get_next (g->pda, g->pda_next);
931 } while (g->pda_next && g->pda_next->data == NULL);
933 if (g->pda_next == NULL)
936 *key_rtn = g->pda_next->key;
937 return g->pda_next->data;
940 /* When tracing, be careful how we print BufferIn parameters which
941 * usually contain large amounts of binary data (RHBZ#646822).
944 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
947 size_t orig_size = buf_size;
954 for (i = 0; i < buf_size; ++i) {
955 if (c_isprint (buf[i]))
958 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
963 if (orig_size > buf_size)
965 _("<truncated, original size %zu bytes>"), orig_size);
969 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
971 guestfs___print_BufferIn (out, buf, buf_size);
975 guestfs___free_string_list (char **argv)
978 for (i = 0; argv[i] != NULL; ++i)