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 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 /* Default is uniprocessor appliance. */
149 /* Link the handles onto a global list. */
150 gl_lock_lock (handles_lock);
153 if (!atexit_handler_set) {
154 atexit (close_handles);
155 atexit_handler_set = 1;
157 gl_lock_unlock (handles_lock);
159 debug (g, "new guestfs handle %p", g);
172 guestfs_close (guestfs_h *g)
174 if (g->state == NO_HANDLE) {
175 /* Not safe to call ANY callbacks here, so ... */
176 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
181 const char trace_msg[] = "close";
183 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE,
184 trace_msg, strlen (trace_msg));
187 debug (g, "closing guestfs handle %p (state %d)", g, g->state);
189 /* Try to sync if autosync flag is set. */
190 if (g->autosync && g->state == READY)
191 guestfs_internal_autosync (g);
193 /* Kill the qemu subprocess. */
194 if (g->state != CONFIG)
195 guestfs_kill_subprocess (g);
197 /* Run user close callbacks. */
198 guestfs___call_callbacks_void (g, GUESTFS_EVENT_CLOSE);
200 /* Remove all other registered callbacks. Since we've already
201 * called the close callbacks, we shouldn't call any others.
207 guestfs___free_inspect_info (g);
208 guestfs___free_drives (&g->drives);
221 /* Wait for subprocess(es) to exit. */
222 if (g->pid > 0) waitpid (g->pid, NULL, 0);
223 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
225 /* Remove whole temporary directory. */
226 guestfs___remove_tmpdir (g->tmpdir);
232 for (i = 0; i < g->cmdline_size; ++i)
233 free (g->cmdline[i]);
237 /* Mark the handle as dead before freeing it. */
238 g->state = NO_HANDLE;
240 gl_lock_lock (handles_lock);
246 for (gg = handles; gg->next != g; gg = gg->next)
250 gl_lock_unlock (handles_lock);
254 free (g->last_error);
259 free (g->qemu_version);
263 /* Close all open handles (called from atexit(3)). */
267 while (handles) guestfs_close (handles);
271 guestfs_last_error (guestfs_h *g)
273 return g->last_error;
277 guestfs_last_errno (guestfs_h *g)
279 return g->last_errnum;
283 set_last_error (guestfs_h *g, int errnum, const char *msg)
285 free (g->last_error);
286 g->last_error = strdup (msg);
287 g->last_errnum = errnum;
290 /* Warning are printed unconditionally. We try to make these rare.
291 * Generally speaking, a warning should either be an error, or if it's
292 * not important for end users then it should be a debug message.
295 guestfs___warning (guestfs_h *g, const char *fs, ...)
302 len = vasprintf (&msg, fs, args);
307 len = asprintf (&msg2, _("warning: %s"), msg);
312 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg2, len);
317 /* Debug messages. */
319 guestfs___debug (guestfs_h *g, const char *fs, ...)
325 /* The cpp macro "debug" has already checked that g->verbose is true
326 * before calling this function, but we check it again just in case
327 * anyone calls this function directly.
333 len = vasprintf (&msg, fs, args);
338 guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg, len);
343 /* Call trace messages. These are enabled by setting g->trace, and
344 * calls to this function should only happen from the generated code
348 guestfs___trace (guestfs_h *g, const char *fs, ...)
355 len = vasprintf (&msg, fs, args);
360 guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, msg, len);
366 default_error_cb (guestfs_h *g, void *data, const char *msg)
368 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
372 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
378 int err = vasprintf (&msg, fs, args);
383 /* set_last_error first so that the callback can access the error
384 * message and errno through the handle if it wishes.
386 set_last_error (g, errnum, msg);
387 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
393 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
400 int err = vasprintf (&msg, fs, args);
406 strerror_r (errnum, buf, sizeof buf);
408 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
412 /* set_last_error first so that the callback can access the error
413 * message and errno through the handle if it wishes.
415 set_last_error (g, errnum, msg);
416 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
422 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
424 void *ptr = malloc (nbytes);
425 if (nbytes > 0 && !ptr) g->abort_cb ();
429 /* Return 1 if an array of N objects, each of size S, cannot exist due
430 to size arithmetic overflow. S must be positive and N must be
431 nonnegative. This is a macro, not an inline function, so that it
432 works correctly even when SIZE_MAX < N.
434 By gnulib convention, SIZE_MAX represents overflow in size
435 calculations, so the conservative dividend to use here is
436 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
437 However, malloc (SIZE_MAX) fails on all known hosts where
438 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
439 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
440 branch when S is known to be 1. */
441 # define xalloc_oversized(n, s) \
442 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
444 /* Technically we should add an autoconf test for this, testing for the desired
445 functionality, like what's done in gnulib, but for now, this is fine. */
446 #if defined(__GLIBC__)
447 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
449 #define HAVE_GNU_CALLOC 0
452 /* Allocate zeroed memory for N elements of S bytes, with error
453 checking. S must be nonzero. */
455 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
457 /* From gnulib's calloc function in xmalloc.c. */
459 /* Test for overflow, since some calloc implementations don't have
460 proper overflow checks. But omit overflow and size-zero tests if
461 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
462 returns NULL if successful. */
463 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
464 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
470 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
472 void *p = realloc (ptr, nbytes);
473 if (nbytes > 0 && !p) g->abort_cb ();
478 guestfs_safe_strdup (guestfs_h *g, const char *str)
480 char *s = strdup (str);
481 if (!s) g->abort_cb ();
486 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
488 char *s = strndup (str, n);
489 if (!s) g->abort_cb ();
494 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
496 void *p = malloc (size);
497 if (!p) g->abort_cb ();
498 memcpy (p, ptr, size);
503 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
509 int err = vasprintf (&msg, fs, args);
519 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
525 guestfs_get_out_of_memory_handler (guestfs_h *g)
531 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
534 g->error_cb_data = data;
537 guestfs_error_handler_cb
538 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
540 if (data_rtn) *data_rtn = g->error_cb_data;
545 guestfs_user_cancel (guestfs_h *g)
551 guestfs__set_verbose (guestfs_h *g, int v)
558 guestfs__get_verbose (guestfs_h *g)
564 guestfs__set_autosync (guestfs_h *g, int a)
571 guestfs__get_autosync (guestfs_h *g)
577 guestfs__set_path (guestfs_h *g, const char *path)
584 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
589 guestfs__get_path (guestfs_h *g)
595 guestfs__set_qemu (guestfs_h *g, const char *qemu)
600 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
605 guestfs__get_qemu (guestfs_h *g)
611 guestfs__set_append (guestfs_h *g, const char *append)
616 g->append = append ? safe_strdup (g, append) : NULL;
621 guestfs__get_append (guestfs_h *g)
627 guestfs__set_memsize (guestfs_h *g, int memsize)
629 g->memsize = memsize;
634 guestfs__get_memsize (guestfs_h *g)
640 guestfs__set_selinux (guestfs_h *g, int selinux)
642 g->selinux = selinux;
647 guestfs__get_selinux (guestfs_h *g)
653 guestfs__get_pid (guestfs_h *g)
658 error (g, "get_pid: no qemu subprocess");
663 struct guestfs_version *
664 guestfs__version (guestfs_h *g)
666 struct guestfs_version *r;
668 r = safe_malloc (g, sizeof *r);
669 r->major = PACKAGE_VERSION_MAJOR;
670 r->minor = PACKAGE_VERSION_MINOR;
671 r->release = PACKAGE_VERSION_RELEASE;
672 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
677 guestfs__set_trace (guestfs_h *g, int t)
684 guestfs__get_trace (guestfs_h *g)
690 guestfs__set_direct (guestfs_h *g, int d)
697 guestfs__get_direct (guestfs_h *g)
703 guestfs__set_recovery_proc (guestfs_h *g, int f)
705 g->recovery_proc = !!f;
710 guestfs__get_recovery_proc (guestfs_h *g)
712 return g->recovery_proc;
716 guestfs__set_network (guestfs_h *g, int v)
718 g->enable_network = !!v;
723 guestfs__get_network (guestfs_h *g)
725 return g->enable_network;
729 guestfs__set_attach_method (guestfs_h *g, const char *method)
731 if (STREQ (method, "appliance")) {
732 g->attach_method = ATTACH_METHOD_APPLIANCE;
733 free (g->attach_method_arg);
734 g->attach_method_arg = NULL;
736 else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
737 g->attach_method = ATTACH_METHOD_UNIX;
738 free (g->attach_method_arg);
739 g->attach_method_arg = safe_strdup (g, method + 5);
740 /* Note that we don't check the path exists until launch is called. */
743 error (g, "invalid attach method: %s", method);
751 guestfs__get_attach_method (guestfs_h *g)
755 switch (g->attach_method) {
756 case ATTACH_METHOD_APPLIANCE:
757 ret = safe_strdup (g, "appliance");
760 case ATTACH_METHOD_UNIX:
761 ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
762 strcpy (ret, "unix:");
763 strcat (ret, g->attach_method_arg);
766 default: /* keep GCC happy - this is not reached */
774 guestfs__set_pgroup (guestfs_h *g, int v)
781 guestfs__get_pgroup (guestfs_h *g)
787 guestfs__set_smp (guestfs_h *g, int v)
793 error (g, "invalid smp parameter: %d", v);
799 guestfs__get_smp (guestfs_h *g)
804 /* Note the private data area is allocated lazily, since the vast
805 * majority of callers will never use it. This means g->pda is
810 void *data; /* opaque user data pointer */
814 hasher (void const *x, size_t table_size)
816 struct pda_entry const *p = x;
817 return hash_pjw (p->key, table_size);
821 comparator (void const *x, void const *y)
823 struct pda_entry const *a = x;
824 struct pda_entry const *b = y;
825 return STREQ (a->key, b->key);
832 struct pda_entry *p = x;
839 guestfs_set_private (guestfs_h *g, const char *key, void *data)
841 if (g->pda == NULL) {
842 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
847 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
848 new_entry->key = safe_strdup (g, key);
849 new_entry->data = data;
851 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
854 struct pda_entry *entry = hash_insert (g->pda, new_entry);
857 assert (entry == new_entry);
861 bad_cast (char const *s)
867 guestfs_get_private (guestfs_h *g, const char *key)
870 return NULL; /* no keys have been set */
872 const struct pda_entry k = { .key = bad_cast (key) };
873 struct pda_entry *entry = hash_lookup (g->pda, &k);
882 guestfs_first_private (guestfs_h *g, const char **key_rtn)
887 g->pda_next = hash_get_first (g->pda);
889 /* Ignore any keys with NULL data pointers. */
890 while (g->pda_next && g->pda_next->data == NULL)
891 g->pda_next = hash_get_next (g->pda, g->pda_next);
893 if (g->pda_next == NULL)
896 *key_rtn = g->pda_next->key;
897 return g->pda_next->data;
901 guestfs_next_private (guestfs_h *g, const char **key_rtn)
906 if (g->pda_next == NULL)
909 /* Walk to the next key with a non-NULL data pointer. */
911 g->pda_next = hash_get_next (g->pda, g->pda_next);
912 } while (g->pda_next && g->pda_next->data == NULL);
914 if (g->pda_next == NULL)
917 *key_rtn = g->pda_next->key;
918 return g->pda_next->data;
921 /* When tracing, be careful how we print BufferIn parameters which
922 * usually contain large amounts of binary data (RHBZ#646822).
925 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
928 size_t orig_size = buf_size;
935 for (i = 0; i < buf_size; ++i) {
936 if (c_isprint (buf[i]))
939 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
944 if (orig_size > buf_size)
946 _("<truncated, original size %zu bytes>"), orig_size);
950 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
952 guestfs___print_BufferIn (out, buf, buf_size);
956 guestfs___free_string_list (char **argv)
959 for (i = 0; argv[i] != NULL; ++i)
965 guestfs___free_drives (struct drive **drives)
967 struct drive *i = *drives;
971 struct drive *next = i->next;