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 fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
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);
157 fprintf (stderr, "new guestfs handle %p\n", g);
170 guestfs_close (guestfs_h *g)
176 if (g->state == NO_HANDLE) {
177 /* Not safe to call 'error' here, so ... */
178 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
183 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
185 /* Run user close callback before anything else. */
187 g->close_cb (g, g->close_cb_data);
189 guestfs___free_inspect_info (g);
191 /* Try to sync if autosync flag is set. */
192 if (g->autosync && g->state == READY)
193 guestfs_internal_autosync (g);
195 /* Remove any handlers that might be called back before we kill the
198 g->log_message_cb = NULL;
200 if (g->state != CONFIG)
201 guestfs_kill_subprocess (g);
214 /* Wait for subprocess(es) to exit. */
215 waitpid (g->pid, NULL, 0);
216 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
218 /* Remove tmpfiles. */
220 snprintf (filename, sizeof filename, "%s/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;
286 default_error_cb (guestfs_h *g, void *data, const char *msg)
288 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
292 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
298 int err = vasprintf (&msg, fs, args);
303 /* set_last_error first so that the callback can access the error
304 * message and errno through the handle if it wishes.
306 set_last_error (g, errnum, msg);
307 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
313 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
320 int err = vasprintf (&msg, fs, args);
325 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
327 strerror_r (errnum, buf, sizeof buf);
331 buf = strerror_r (errnum, _buf, sizeof _buf);
334 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
338 /* set_last_error first so that the callback can access the error
339 * message and errno through the handle if it wishes.
341 set_last_error (g, errnum, msg);
342 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
348 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
350 void *ptr = malloc (nbytes);
351 if (nbytes > 0 && !ptr) g->abort_cb ();
355 /* Return 1 if an array of N objects, each of size S, cannot exist due
356 to size arithmetic overflow. S must be positive and N must be
357 nonnegative. This is a macro, not an inline function, so that it
358 works correctly even when SIZE_MAX < N.
360 By gnulib convention, SIZE_MAX represents overflow in size
361 calculations, so the conservative dividend to use here is
362 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
363 However, malloc (SIZE_MAX) fails on all known hosts where
364 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
365 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
366 branch when S is known to be 1. */
367 # define xalloc_oversized(n, s) \
368 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
370 /* Technically we should add an autoconf test for this, testing for the desired
371 functionality, like what's done in gnulib, but for now, this is fine. */
372 #if defined(__GLIBC__)
373 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
375 #define HAVE_GNU_CALLOC 0
378 /* Allocate zeroed memory for N elements of S bytes, with error
379 checking. S must be nonzero. */
381 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
383 /* From gnulib's calloc function in xmalloc.c. */
385 /* Test for overflow, since some calloc implementations don't have
386 proper overflow checks. But omit overflow and size-zero tests if
387 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
388 returns NULL if successful. */
389 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
390 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
396 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
398 void *p = realloc (ptr, nbytes);
399 if (nbytes > 0 && !p) g->abort_cb ();
404 guestfs_safe_strdup (guestfs_h *g, const char *str)
406 char *s = strdup (str);
407 if (!s) g->abort_cb ();
412 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
414 char *s = strndup (str, n);
415 if (!s) g->abort_cb ();
420 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
422 void *p = malloc (size);
423 if (!p) g->abort_cb ();
424 memcpy (p, ptr, size);
429 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
435 int err = vasprintf (&msg, fs, args);
445 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
451 guestfs_get_out_of_memory_handler (guestfs_h *g)
457 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
460 g->error_cb_data = data;
463 guestfs_error_handler_cb
464 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
466 if (data_rtn) *data_rtn = g->error_cb_data;
471 guestfs__set_verbose (guestfs_h *g, int v)
478 guestfs__get_verbose (guestfs_h *g)
484 guestfs__set_autosync (guestfs_h *g, int a)
491 guestfs__get_autosync (guestfs_h *g)
497 guestfs__set_path (guestfs_h *g, const char *path)
504 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
509 guestfs__get_path (guestfs_h *g)
515 guestfs__set_qemu (guestfs_h *g, const char *qemu)
520 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
525 guestfs__get_qemu (guestfs_h *g)
531 guestfs__set_append (guestfs_h *g, const char *append)
536 g->append = append ? safe_strdup (g, append) : NULL;
541 guestfs__get_append (guestfs_h *g)
547 guestfs__set_memsize (guestfs_h *g, int memsize)
549 g->memsize = memsize;
554 guestfs__get_memsize (guestfs_h *g)
560 guestfs__set_selinux (guestfs_h *g, int selinux)
562 g->selinux = selinux;
567 guestfs__get_selinux (guestfs_h *g)
573 guestfs__get_pid (guestfs_h *g)
578 error (g, "get_pid: no qemu subprocess");
583 struct guestfs_version *
584 guestfs__version (guestfs_h *g)
586 struct guestfs_version *r;
588 r = safe_malloc (g, sizeof *r);
589 r->major = PACKAGE_VERSION_MAJOR;
590 r->minor = PACKAGE_VERSION_MINOR;
591 r->release = PACKAGE_VERSION_RELEASE;
592 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
597 guestfs__set_trace (guestfs_h *g, int t)
604 guestfs__get_trace (guestfs_h *g)
610 guestfs__set_direct (guestfs_h *g, int d)
617 guestfs__get_direct (guestfs_h *g)
623 guestfs__set_recovery_proc (guestfs_h *g, int f)
625 g->recovery_proc = !!f;
630 guestfs__get_recovery_proc (guestfs_h *g)
632 return g->recovery_proc;
636 guestfs__set_network (guestfs_h *g, int v)
638 g->enable_network = !!v;
643 guestfs__get_network (guestfs_h *g)
645 return g->enable_network;
649 guestfs_set_log_message_callback (guestfs_h *g,
650 guestfs_log_message_cb cb, void *opaque)
652 g->log_message_cb = cb;
653 g->log_message_cb_data = opaque;
657 guestfs_set_subprocess_quit_callback (guestfs_h *g,
658 guestfs_subprocess_quit_cb cb, void *opaque)
660 g->subprocess_quit_cb = cb;
661 g->subprocess_quit_cb_data = opaque;
665 guestfs_set_launch_done_callback (guestfs_h *g,
666 guestfs_launch_done_cb cb, void *opaque)
668 g->launch_done_cb = cb;
669 g->launch_done_cb_data = opaque;
673 guestfs_set_close_callback (guestfs_h *g,
674 guestfs_close_cb cb, void *opaque)
677 g->close_cb_data = opaque;
681 guestfs_set_progress_callback (guestfs_h *g,
682 guestfs_progress_cb cb, void *opaque)
685 g->progress_cb_data = opaque;
688 /* Note the private data area is allocated lazily, since the vast
689 * majority of callers will never use it. This means g->pda is
694 void *data; /* opaque user data pointer */
698 hasher (void const *x, size_t table_size)
700 struct pda_entry const *p = x;
701 return hash_pjw (p->key, table_size);
705 comparator (void const *x, void const *y)
707 struct pda_entry const *a = x;
708 struct pda_entry const *b = y;
709 return STREQ (a->key, b->key);
716 struct pda_entry *p = x;
723 guestfs_set_private (guestfs_h *g, const char *key, void *data)
725 if (g->pda == NULL) {
726 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
731 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
732 new_entry->key = safe_strdup (g, key);
733 new_entry->data = data;
735 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
738 struct pda_entry *entry = hash_insert (g->pda, new_entry);
741 assert (entry == new_entry);
745 bad_cast (char const *s)
751 guestfs_get_private (guestfs_h *g, const char *key)
754 return NULL; /* no keys have been set */
756 const struct pda_entry k = { .key = bad_cast (key) };
757 struct pda_entry *entry = hash_lookup (g->pda, &k);
764 /* When tracing, be careful how we print BufferIn parameters which
765 * usually contain large amounts of binary data (RHBZ#646822).
768 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
771 size_t orig_size = buf_size;
778 for (i = 0; i < buf_size; ++i) {
779 if (c_isprint (buf[i]))
782 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
787 if (orig_size > buf_size)
789 _("<truncated, original size %zu bytes>"), orig_size);
793 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
795 guestfs___print_BufferIn (out, buf, buf_size);
799 guestfs___free_string_list (char **argv)
802 for (i = 0; argv[i] != NULL; ++i)