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;
104 str = getenv ("LIBGUESTFS_DEBUG");
105 g->verbose = str != NULL && STREQ (str, "1");
107 str = getenv ("LIBGUESTFS_TRACE");
108 g->trace = str != NULL && STREQ (str, "1");
110 str = getenv ("LIBGUESTFS_PATH");
111 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
112 if (!g->path) goto error;
114 str = getenv ("LIBGUESTFS_QEMU");
115 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
116 if (!g->qemu) goto error;
118 str = getenv ("LIBGUESTFS_APPEND");
120 g->append = strdup (str);
121 if (!g->append) goto error;
124 /* Choose a suitable memory size. Previously we tried to choose
125 * a minimal memory size, but this isn't really necessary since
126 * recent QEMU and KVM don't do anything nasty like locking
127 * memory into core any more. Thus we can safely choose a
128 * large, generous amount of memory, and it'll just get swapped
129 * on smaller systems.
131 str = getenv ("LIBGUESTFS_MEMSIZE");
133 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
134 fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
140 /* Start with large serial numbers so they are easy to spot
141 * inside the protocol.
143 g->msg_next_serial = 0x00123400;
145 /* Link the handles onto a global list. */
146 gl_lock_lock (handles_lock);
149 if (!atexit_handler_set) {
150 atexit (close_handles);
151 atexit_handler_set = 1;
153 gl_lock_unlock (handles_lock);
156 fprintf (stderr, "new guestfs handle %p\n", g);
169 guestfs_close (guestfs_h *g)
175 if (g->state == NO_HANDLE) {
176 /* Not safe to call 'error' here, so ... */
177 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
182 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
184 /* Run user close callback before anything else. */
186 g->close_cb (g, g->close_cb_data);
188 guestfs___free_inspect_info (g);
190 /* Try to sync if autosync flag is set. */
191 if (g->autosync && g->state == READY) {
192 guestfs_umount_all (g);
196 /* Remove any handlers that might be called back before we kill the
199 g->log_message_cb = NULL;
201 if (g->state != CONFIG)
202 guestfs_kill_subprocess (g);
215 /* Wait for subprocess(es) to exit. */
216 waitpid (g->pid, NULL, 0);
217 if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
219 /* Remove tmpfiles. */
221 snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
230 for (i = 0; i < g->cmdline_size; ++i)
231 free (g->cmdline[i]);
235 /* Mark the handle as dead before freeing it. */
236 g->state = NO_HANDLE;
238 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 /* Close all open handles (called from atexit(3)). */
263 while (handles) guestfs_close (handles);
267 guestfs_last_error (guestfs_h *g)
269 return g->last_error;
273 set_last_error (guestfs_h *g, const char *msg)
275 free (g->last_error);
276 g->last_error = strdup (msg);
280 default_error_cb (guestfs_h *g, void *data, const char *msg)
282 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
286 guestfs_error (guestfs_h *g, const char *fs, ...)
292 int err = vasprintf (&msg, fs, args);
297 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
298 set_last_error (g, msg);
304 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
311 int err = vasprintf (&msg, fs, args);
316 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
318 strerror_r (errnum, buf, sizeof buf);
322 buf = strerror_r (errnum, _buf, sizeof _buf);
325 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
329 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
330 set_last_error (g, msg);
336 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
338 void *ptr = malloc (nbytes);
339 if (nbytes > 0 && !ptr) g->abort_cb ();
343 /* Return 1 if an array of N objects, each of size S, cannot exist due
344 to size arithmetic overflow. S must be positive and N must be
345 nonnegative. This is a macro, not an inline function, so that it
346 works correctly even when SIZE_MAX < N.
348 By gnulib convention, SIZE_MAX represents overflow in size
349 calculations, so the conservative dividend to use here is
350 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
351 However, malloc (SIZE_MAX) fails on all known hosts where
352 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
353 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
354 branch when S is known to be 1. */
355 # define xalloc_oversized(n, s) \
356 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
358 /* Technically we should add an autoconf test for this, testing for the desired
359 functionality, like what's done in gnulib, but for now, this is fine. */
360 #if defined(__GLIBC__)
361 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
363 #define HAVE_GNU_CALLOC 0
366 /* Allocate zeroed memory for N elements of S bytes, with error
367 checking. S must be nonzero. */
369 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
371 /* From gnulib's calloc function in xmalloc.c. */
373 /* Test for overflow, since some calloc implementations don't have
374 proper overflow checks. But omit overflow and size-zero tests if
375 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
376 returns NULL if successful. */
377 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
378 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
384 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
386 void *p = realloc (ptr, nbytes);
387 if (nbytes > 0 && !p) g->abort_cb ();
392 guestfs_safe_strdup (guestfs_h *g, const char *str)
394 char *s = strdup (str);
395 if (!s) g->abort_cb ();
400 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
402 char *s = strndup (str, n);
403 if (!s) g->abort_cb ();
408 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
410 void *p = malloc (size);
411 if (!p) g->abort_cb ();
412 memcpy (p, ptr, size);
417 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
423 guestfs_get_out_of_memory_handler (guestfs_h *g)
429 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
432 g->error_cb_data = data;
435 guestfs_error_handler_cb
436 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
438 if (data_rtn) *data_rtn = g->error_cb_data;
443 guestfs__set_verbose (guestfs_h *g, int v)
450 guestfs__get_verbose (guestfs_h *g)
456 guestfs__set_autosync (guestfs_h *g, int a)
463 guestfs__get_autosync (guestfs_h *g)
469 guestfs__set_path (guestfs_h *g, const char *path)
476 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
481 guestfs__get_path (guestfs_h *g)
487 guestfs__set_qemu (guestfs_h *g, const char *qemu)
492 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
497 guestfs__get_qemu (guestfs_h *g)
503 guestfs__set_append (guestfs_h *g, const char *append)
508 g->append = append ? safe_strdup (g, append) : NULL;
513 guestfs__get_append (guestfs_h *g)
519 guestfs__set_memsize (guestfs_h *g, int memsize)
521 g->memsize = memsize;
526 guestfs__get_memsize (guestfs_h *g)
532 guestfs__set_selinux (guestfs_h *g, int selinux)
534 g->selinux = selinux;
539 guestfs__get_selinux (guestfs_h *g)
545 guestfs__get_pid (guestfs_h *g)
550 error (g, "get_pid: no qemu subprocess");
555 struct guestfs_version *
556 guestfs__version (guestfs_h *g)
558 struct guestfs_version *r;
560 r = safe_malloc (g, sizeof *r);
561 r->major = PACKAGE_VERSION_MAJOR;
562 r->minor = PACKAGE_VERSION_MINOR;
563 r->release = PACKAGE_VERSION_RELEASE;
564 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
569 guestfs__set_trace (guestfs_h *g, int t)
576 guestfs__get_trace (guestfs_h *g)
582 guestfs__set_direct (guestfs_h *g, int d)
589 guestfs__get_direct (guestfs_h *g)
595 guestfs__set_recovery_proc (guestfs_h *g, int f)
597 g->recovery_proc = !!f;
602 guestfs__get_recovery_proc (guestfs_h *g)
604 return g->recovery_proc;
608 guestfs__set_network (guestfs_h *g, int v)
610 g->enable_network = !!v;
615 guestfs__get_network (guestfs_h *g)
617 return g->enable_network;
621 guestfs_set_log_message_callback (guestfs_h *g,
622 guestfs_log_message_cb cb, void *opaque)
624 g->log_message_cb = cb;
625 g->log_message_cb_data = opaque;
629 guestfs_set_subprocess_quit_callback (guestfs_h *g,
630 guestfs_subprocess_quit_cb cb, void *opaque)
632 g->subprocess_quit_cb = cb;
633 g->subprocess_quit_cb_data = opaque;
637 guestfs_set_launch_done_callback (guestfs_h *g,
638 guestfs_launch_done_cb cb, void *opaque)
640 g->launch_done_cb = cb;
641 g->launch_done_cb_data = opaque;
645 guestfs_set_close_callback (guestfs_h *g,
646 guestfs_close_cb cb, void *opaque)
649 g->close_cb_data = opaque;
653 guestfs_set_progress_callback (guestfs_h *g,
654 guestfs_progress_cb cb, void *opaque)
657 g->progress_cb_data = opaque;
660 /* Note the private data area is allocated lazily, since the vast
661 * majority of callers will never use it. This means g->pda is
666 void *data; /* opaque user data pointer */
670 hasher (void const *x, size_t table_size)
672 struct pda_entry const *p = x;
673 return hash_pjw (p->key, table_size);
677 comparator (void const *x, void const *y)
679 struct pda_entry const *a = x;
680 struct pda_entry const *b = y;
681 return STREQ (a->key, b->key);
688 struct pda_entry *p = x;
695 guestfs_set_private (guestfs_h *g, const char *key, void *data)
697 if (g->pda == NULL) {
698 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
703 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
704 new_entry->key = safe_strdup (g, key);
705 new_entry->data = data;
707 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
710 struct pda_entry *entry = hash_insert (g->pda, new_entry);
713 assert (entry == new_entry);
717 bad_cast (char const *s)
723 guestfs_get_private (guestfs_h *g, const char *key)
726 return NULL; /* no keys have been set */
728 const struct pda_entry k = { .key = bad_cast (key) };
729 struct pda_entry *entry = hash_lookup (g->pda, &k);
736 /* When tracing, be careful how we print BufferIn parameters which
737 * usually contain large amounts of binary data (RHBZ#646822).
740 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
743 size_t orig_size = buf_size;
750 for (i = 0; i < buf_size; ++i) {
751 if (c_isprint (buf[i]))
754 fprintf (out, "\\x%02x", (unsigned char) buf[i]);
759 if (orig_size > buf_size)
761 _("<truncated, original size %zu bytes>"), orig_size);