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>
64 #include "glthread/lock.h"
69 #include "guestfs-internal.h"
70 #include "guestfs-internal-actions.h"
71 #include "guestfs_protocol.h"
73 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
74 static void close_handles (void);
76 gl_lock_define_initialized (static, handles_lock);
77 static guestfs_h *handles = NULL;
78 static int atexit_handler_set = 0;
86 g = malloc (sizeof (*g));
89 memset (g, 0, sizeof (*g));
98 g->error_cb = default_error_cb;
99 g->error_cb_data = NULL;
101 g->recovery_proc = 1;
103 str = getenv ("LIBGUESTFS_DEBUG");
104 g->verbose = str != NULL && STREQ (str, "1");
106 str = getenv ("LIBGUESTFS_TRACE");
107 g->trace = str != NULL && STREQ (str, "1");
109 str = getenv ("LIBGUESTFS_PATH");
110 g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
111 if (!g->path) goto error;
113 str = getenv ("LIBGUESTFS_QEMU");
114 g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
115 if (!g->qemu) goto error;
117 str = getenv ("LIBGUESTFS_APPEND");
119 g->append = strdup (str);
120 if (!g->append) goto error;
123 /* Choose a suitable memory size. Previously we tried to choose
124 * a minimal memory size, but this isn't really necessary since
125 * recent QEMU and KVM don't do anything nasty like locking
126 * memory into core any more. Thus we can safely choose a
127 * large, generous amount of memory, and it'll just get swapped
128 * on smaller systems.
130 str = getenv ("LIBGUESTFS_MEMSIZE");
132 if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
133 fprintf (stderr, "libguestfs: non-numeric or too small value for LIBGUESTFS_MEMSIZE\n");
139 /* Start with large serial numbers so they are easy to spot
140 * inside the protocol.
142 g->msg_next_serial = 0x00123400;
144 /* Link the handles onto a global list. */
145 gl_lock_lock (handles_lock);
148 if (!atexit_handler_set) {
149 atexit (close_handles);
150 atexit_handler_set = 1;
152 gl_lock_unlock (handles_lock);
155 fprintf (stderr, "new guestfs handle %p\n", g);
168 guestfs_close (guestfs_h *g)
174 if (g->state == NO_HANDLE) {
175 /* Not safe to call 'error' here, so ... */
176 fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
181 fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
183 /* Run user close callback before anything else. */
185 g->close_cb (g, g->close_cb_data);
187 guestfs___free_inspect_info (g);
189 /* Try to sync if autosync flag is set. */
190 if (g->autosync && g->state == READY) {
191 guestfs_umount_all (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 set_last_error (guestfs_h *g, const char *msg)
274 free (g->last_error);
275 g->last_error = strdup (msg);
279 default_error_cb (guestfs_h *g, void *data, const char *msg)
281 fprintf (stderr, _("libguestfs: error: %s\n"), msg);
285 guestfs_error (guestfs_h *g, const char *fs, ...)
291 int err = vasprintf (&msg, fs, args);
296 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
297 set_last_error (g, msg);
303 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
310 int err = vasprintf (&msg, fs, args);
315 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
317 strerror_r (errnum, buf, sizeof buf);
321 buf = strerror_r (errnum, _buf, sizeof _buf);
324 msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
328 if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
329 set_last_error (g, msg);
335 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
337 void *ptr = malloc (nbytes);
338 if (nbytes > 0 && !ptr) g->abort_cb ();
342 /* Return 1 if an array of N objects, each of size S, cannot exist due
343 to size arithmetic overflow. S must be positive and N must be
344 nonnegative. This is a macro, not an inline function, so that it
345 works correctly even when SIZE_MAX < N.
347 By gnulib convention, SIZE_MAX represents overflow in size
348 calculations, so the conservative dividend to use here is
349 SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
350 However, malloc (SIZE_MAX) fails on all known hosts where
351 sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
352 exactly-SIZE_MAX allocations on such hosts; this avoids a test and
353 branch when S is known to be 1. */
354 # define xalloc_oversized(n, s) \
355 ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
357 /* Technically we should add an autoconf test for this, testing for the desired
358 functionality, like what's done in gnulib, but for now, this is fine. */
359 #if defined(__GLIBC__)
360 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
362 #define HAVE_GNU_CALLOC 0
365 /* Allocate zeroed memory for N elements of S bytes, with error
366 checking. S must be nonzero. */
368 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
370 /* From gnulib's calloc function in xmalloc.c. */
372 /* Test for overflow, since some calloc implementations don't have
373 proper overflow checks. But omit overflow and size-zero tests if
374 HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
375 returns NULL if successful. */
376 if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
377 || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
383 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
385 void *p = realloc (ptr, nbytes);
386 if (nbytes > 0 && !p) g->abort_cb ();
391 guestfs_safe_strdup (guestfs_h *g, const char *str)
393 char *s = strdup (str);
394 if (!s) g->abort_cb ();
399 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
401 char *s = strndup (str, n);
402 if (!s) g->abort_cb ();
407 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
409 void *p = malloc (size);
410 if (!p) g->abort_cb ();
411 memcpy (p, ptr, size);
416 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
422 guestfs_get_out_of_memory_handler (guestfs_h *g)
428 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
431 g->error_cb_data = data;
434 guestfs_error_handler_cb
435 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
437 if (data_rtn) *data_rtn = g->error_cb_data;
442 guestfs__set_verbose (guestfs_h *g, int v)
449 guestfs__get_verbose (guestfs_h *g)
455 guestfs__set_autosync (guestfs_h *g, int a)
462 guestfs__get_autosync (guestfs_h *g)
468 guestfs__set_path (guestfs_h *g, const char *path)
475 safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
480 guestfs__get_path (guestfs_h *g)
486 guestfs__set_qemu (guestfs_h *g, const char *qemu)
491 g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
496 guestfs__get_qemu (guestfs_h *g)
502 guestfs__set_append (guestfs_h *g, const char *append)
507 g->append = append ? safe_strdup (g, append) : NULL;
512 guestfs__get_append (guestfs_h *g)
518 guestfs__set_memsize (guestfs_h *g, int memsize)
520 g->memsize = memsize;
525 guestfs__get_memsize (guestfs_h *g)
531 guestfs__set_selinux (guestfs_h *g, int selinux)
533 g->selinux = selinux;
538 guestfs__get_selinux (guestfs_h *g)
544 guestfs__get_pid (guestfs_h *g)
549 error (g, "get_pid: no qemu subprocess");
554 struct guestfs_version *
555 guestfs__version (guestfs_h *g)
557 struct guestfs_version *r;
559 r = safe_malloc (g, sizeof *r);
560 r->major = PACKAGE_VERSION_MAJOR;
561 r->minor = PACKAGE_VERSION_MINOR;
562 r->release = PACKAGE_VERSION_RELEASE;
563 r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
568 guestfs__set_trace (guestfs_h *g, int t)
575 guestfs__get_trace (guestfs_h *g)
581 guestfs__set_direct (guestfs_h *g, int d)
588 guestfs__get_direct (guestfs_h *g)
594 guestfs__set_recovery_proc (guestfs_h *g, int f)
596 g->recovery_proc = !!f;
601 guestfs__get_recovery_proc (guestfs_h *g)
603 return g->recovery_proc;
607 guestfs__set_network (guestfs_h *g, int v)
609 g->enable_network = !!v;
614 guestfs__get_network (guestfs_h *g)
616 return g->enable_network;
620 guestfs_set_log_message_callback (guestfs_h *g,
621 guestfs_log_message_cb cb, void *opaque)
623 g->log_message_cb = cb;
624 g->log_message_cb_data = opaque;
628 guestfs_set_subprocess_quit_callback (guestfs_h *g,
629 guestfs_subprocess_quit_cb cb, void *opaque)
631 g->subprocess_quit_cb = cb;
632 g->subprocess_quit_cb_data = opaque;
636 guestfs_set_launch_done_callback (guestfs_h *g,
637 guestfs_launch_done_cb cb, void *opaque)
639 g->launch_done_cb = cb;
640 g->launch_done_cb_data = opaque;
644 guestfs_set_close_callback (guestfs_h *g,
645 guestfs_close_cb cb, void *opaque)
648 g->close_cb_data = opaque;
652 guestfs_set_progress_callback (guestfs_h *g,
653 guestfs_progress_cb cb, void *opaque)
656 g->progress_cb_data = opaque;
659 /* Note the private data area is allocated lazily, since the vast
660 * majority of callers will never use it. This means g->pda is
665 void *data; /* opaque user data pointer */
669 hasher (void const *x, size_t table_size)
671 struct pda_entry const *p = x;
672 return hash_pjw (p->key, table_size);
676 comparator (void const *x, void const *y)
678 struct pda_entry const *a = x;
679 struct pda_entry const *b = y;
680 return STREQ (a->key, b->key);
687 struct pda_entry *p = x;
694 guestfs_set_private (guestfs_h *g, const char *key, void *data)
696 if (g->pda == NULL) {
697 g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
702 struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
703 new_entry->key = safe_strdup (g, key);
704 new_entry->data = data;
706 struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
709 struct pda_entry *entry = hash_insert (g->pda, new_entry);
712 assert (entry == new_entry);
716 bad_cast (char const *s)
722 guestfs_get_private (guestfs_h *g, const char *key)
725 return NULL; /* no keys have been set */
727 const struct pda_entry k = { .key = bad_cast (key) };
728 struct pda_entry *entry = hash_lookup (g->pda, &k);