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)
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 whole temporary directory. */
222 for (i = 0; i < g->cmdline_size; ++i)
223 free (g->cmdline[i]);
227 /* Mark the handle as dead before freeing it. */
228 g->state = NO_HANDLE;
230 gl_lock_lock (handles_lock);
234 for (gg = handles; gg->next != g; gg = gg->next)
238 gl_lock_unlock (handles_lock);
242 free (g->last_error);
247 free (g->qemu_version);
251 /* g->tmpdir can contain any files (but not subdirectories). Remove
252 * those and the directory itself. Note that errors in this function
253 * aren't really that important: if we end up not deleting temporary
254 * files it's only annoying.
257 remove_tmpdir (guestfs_h *g)
265 dir = opendir (g->tmpdir);
271 while ((d = readdir (dir)) != NULL) {
272 if (STRNEQ (d->d_name, ".") && STRNEQ (d->d_name, "..")) {
273 if (unlinkat (dirfd (dir), d->d_name, 0) == -1)
278 if (closedir (dir) == -1)
281 if (rmdir (g->tmpdir) == -1)
288 /* Close all open handles (called from atexit(3)). */
292 while (handles) guestfs_close (handles);
296 guestfs_last_error (guestfs_h *g)
298 return g->last_error;
302 guestfs_last_errno (guestfs_h *g)
304 return g->last_errnum;
308 set_last_error (guestfs_h *g, int errnum, const char *msg)
310 free (g->last_error);
311 g->last_error = strdup (msg);
312 g->last_errnum = errnum;
315 /* Warning are printed unconditionally. We try to make these rare.
316 * Generally speaking, a warning should either be an error, or if it's
317 * not important for end users then it should be a debug message.
320 guestfs___warning (guestfs_h *g, const char *fs, ...)
327 len = vasprintf (&msg, fs, args);
332 len = asprintf (&msg2, _("warning: %s"), msg);
337 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg2, len);
342 /* Debug messages. */
344 guestfs___debug (guestfs_h *g, const char *fs, ...)
350 /* The cpp macro "debug" has already checked that g->verbose is true
351 * before calling this function, but we check it again just in case
352 * anyone calls this function directly.
358 len = vasprintf (&msg, fs, args);
363 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg, len);
366 /* Call trace messages. These are enabled by setting g->trace, and
367 * calls to this function should only happen from the generated code
371 guestfs___trace (guestfs_h *g, const char *fs, ...)
378 len = vasprintf (&msg, fs, args);
383 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, msg, len);
389 default_error_cb (guestfs_h *g, void *data, const char *msg)
391 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
395 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
401 int err = vasprintf (&msg, fs, args);
406 /* set_last_error first so that the callback can access the error
407 * message and errno through the handle if it wishes.
409 set_last_error (g, errnum, msg);
410 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
416 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
423 int err = vasprintf (&msg, fs, args);
428 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
430 strerror_r (errnum, buf, sizeof buf);
434 buf = strerror_r (errnum, _buf, sizeof _buf);
437 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
441 /* set_last_error first so that the callback can access the error
442 * message and errno through the handle if it wishes.
444 set_last_error (g, errnum, msg);
445 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
451 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
453 void *ptr = malloc (nbytes);
454 if (nbytes > 0 && !ptr) g->abort_cb ();
458 /* Return 1 if an array of N objects, each of size S, cannot exist due
459 to size arithmetic overflow. S must be positive and N must be
460 nonnegative. This is a macro, not an inline function, so that it
461 works correctly even when SIZE_MAX < N.
463 By gnulib convention, SIZE_MAX represents overflow in size
464 calculations, so the conservative dividend to use here is
465 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
466 However, malloc (SIZE_MAX) fails on all known hosts where
467 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
468 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
469 branch when S is known to be 1. */
470 # define xalloc_oversized(n, s) \
471 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
473 /* Technically we should add an autoconf test for this, testing for the desired
474 functionality, like what's done in gnulib, but for now, this is fine. */
475 #if defined(__GLIBC__)
476 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
478 #define HAVE_GNU_CALLOC 0
481 /* Allocate zeroed memory for N elements of S bytes, with error
482 checking. S must be nonzero. */
484 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
486 /* From gnulib's calloc function in xmalloc.c. */
488 /* Test for overflow, since some calloc implementations don't have
489 proper overflow checks. But omit overflow and size-zero tests if
490 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
491 returns NULL if successful. */
492 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
493 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
499 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
501 void *p = realloc (ptr, nbytes);
502 if (nbytes > 0 && !p) g->abort_cb ();
507 guestfs_safe_strdup (guestfs_h *g, const char *str)
509 char *s = strdup (str);
510 if (!s) g->abort_cb ();
515 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
517 char *s = strndup (str, n);
518 if (!s) g->abort_cb ();
523 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
525 void *p = malloc (size);
526 if (!p) g->abort_cb ();
527 memcpy (p, ptr, size);
532 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
538 int err = vasprintf (&msg, fs, args);
548 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
554 guestfs_get_out_of_memory_handler (guestfs_h *g)
560 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
563 g->error_cb_data = data;
566 guestfs_error_handler_cb
567 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
569 if (data_rtn) *data_rtn = g->error_cb_data;
574 guestfs__set_verbose (guestfs_h *g, int v)
581 guestfs__get_verbose (guestfs_h *g)
587 guestfs__set_autosync (guestfs_h *g, int a)
594 guestfs__get_autosync (guestfs_h *g)
600 guestfs__set_path (guestfs_h *g, const char *path)
607 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
612 guestfs__get_path (guestfs_h *g)
618 guestfs__set_qemu (guestfs_h *g, const char *qemu)
623 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
628 guestfs__get_qemu (guestfs_h *g)
634 guestfs__set_append (guestfs_h *g, const char *append)
639 g->append = append ? safe_strdup (g, append) : NULL;
644 guestfs__get_append (guestfs_h *g)
650 guestfs__set_memsize (guestfs_h *g, int memsize)
652 g->memsize = memsize;
657 guestfs__get_memsize (guestfs_h *g)
663 guestfs__set_selinux (guestfs_h *g, int selinux)
665 g->selinux = selinux;
670 guestfs__get_selinux (guestfs_h *g)
676 guestfs__get_pid (guestfs_h *g)
681 error (g, "get_pid: no qemu subprocess");
686 struct guestfs_version *
687 guestfs__version (guestfs_h *g)
689 struct guestfs_version *r;
691 r = safe_malloc (g, sizeof *r);
692 r->major = PACKAGE_VERSION_MAJOR;
693 r->minor = PACKAGE_VERSION_MINOR;
694 r->release = PACKAGE_VERSION_RELEASE;
695 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
700 guestfs__set_trace (guestfs_h *g, int t)
707 guestfs__get_trace (guestfs_h *g)
713 guestfs__set_direct (guestfs_h *g, int d)
720 guestfs__get_direct (guestfs_h *g)
726 guestfs__set_recovery_proc (guestfs_h *g, int f)
728 g->recovery_proc = !!f;
733 guestfs__get_recovery_proc (guestfs_h *g)
735 return g->recovery_proc;
739 guestfs__set_network (guestfs_h *g, int v)
741 g->enable_network = !!v;
746 guestfs__get_network (guestfs_h *g)
748 return g->enable_network;
752 guestfs__set_attach_method (guestfs_h *g, const char *method)
754 if (STREQ (method, "appliance")) {
755 g->attach_method = ATTACH_METHOD_APPLIANCE;
756 free (g->attach_method_arg);
757 g->attach_method_arg = NULL;
759 else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
760 g->attach_method = ATTACH_METHOD_UNIX;
761 free (g->attach_method_arg);
762 g->attach_method_arg = safe_strdup (g, method + 5);
763 /* Note that we don't check the path exists until launch is called. */
766 error (g, "invalid attach method: %s", method);
774 guestfs__get_attach_method (guestfs_h *g)
778 switch (g->attach_method) {
779 case ATTACH_METHOD_APPLIANCE:
780 ret = safe_strdup (g, "appliance");
783 case ATTACH_METHOD_UNIX:
784 ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
785 strcpy (ret, "unix:");
786 strcat (ret, g->attach_method_arg);
789 default: /* keep GCC happy - this is not reached */
796 /* Note the private data area is allocated lazily, since the vast
797 * majority of callers will never use it. This means g->pda is
802 void *data; /* opaque user data pointer */
806 hasher (void const *x, size_t table_size)
808 struct pda_entry const *p = x;
809 return hash_pjw (p->key, table_size);
813 comparator (void const *x, void const *y)
815 struct pda_entry const *a = x;
816 struct pda_entry const *b = y;
817 return STREQ (a->key, b->key);
824 struct pda_entry *p = x;
831 guestfs_set_private (guestfs_h *g, const char *key, void *data)
833 if (g->pda == NULL) {
834 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
839 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
840 new_entry->key = safe_strdup (g, key);
841 new_entry->data = data;
843 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
846 struct pda_entry *entry = hash_insert (g->pda, new_entry);
849 assert (entry == new_entry);
853 bad_cast (char const *s)
859 guestfs_get_private (guestfs_h *g, const char *key)
862 return NULL; /* no keys have been set */
864 const struct pda_entry k = { .key = bad_cast (key) };
865 struct pda_entry *entry = hash_lookup (g->pda, &k);
874 guestfs_first_private (guestfs_h *g, const char **key_rtn)
879 g->pda_next = hash_get_first (g->pda);
881 /* Ignore any keys with NULL data pointers. */
882 while (g->pda_next && g->pda_next->data == NULL)
883 g->pda_next = hash_get_next (g->pda, g->pda_next);
885 if (g->pda_next == NULL)
888 *key_rtn = g->pda_next->key;
889 return g->pda_next->data;
893 guestfs_next_private (guestfs_h *g, const char **key_rtn)
898 if (g->pda_next == NULL)
901 /* Walk to the next key with a non-NULL data pointer. */
903 g->pda_next = hash_get_next (g->pda, g->pda_next);
904 } while (g->pda_next && g->pda_next->data == NULL);
906 if (g->pda_next == NULL)
909 *key_rtn = g->pda_next->key;
910 return g->pda_next->data;
913 /* When tracing, be careful how we print BufferIn parameters which
914 * usually contain large amounts of binary data (RHBZ#646822).
917 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
920 size_t orig_size = buf_size;
927 for (i = 0; i < buf_size; ++i) {
928 if (c_isprint (buf[i]))
931 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
936 if (orig_size > buf_size)
938 _("<truncated, original size %zu bytes>"), orig_size);
942 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
944 guestfs___print_BufferIn (out, buf, buf_size);
948 guestfs___free_string_list (char **argv)
951 for (i = 0; argv[i] != NULL; ++i)