src/guestfs.c

   1 /* libguestfs
   2  * Copyright (C) 2009-2010 Red Hat Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 #include <config.h>
  20
  21 #define _BSD_SOURCE /* for mkdtemp, usleep */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <stdarg.h>
  26 #include <stddef.h>
  27 #include <stdint.h>
  28 #include <inttypes.h>
  29 #include <unistd.h>
  30 #include <string.h>
  31 #include <fcntl.h>
  32 #include <time.h>
  33 #include <sys/stat.h>
  34 #include <sys/select.h>
  35 #include <dirent.h>
  36 #include <assert.h>
  37
  38 #include <rpc/types.h>
  39 #include <rpc/xdr.h>
  40
  41 #ifdef HAVE_ERRNO_H
  42 #include <errno.h>
  43 #endif
  44
  45 #ifdef HAVE_SYS_TYPES_H
  46 #include <sys/types.h>
  47 #endif
  48
  49 #ifdef HAVE_SYS_WAIT_H
  50 #include <sys/wait.h>
  51 #endif
  52
  53 #ifdef HAVE_SYS_SOCKET_H
  54 #include <sys/socket.h>
  55 #endif
  56
  57 #ifdef HAVE_SYS_UN_H
  58 #include <sys/un.h>
  59 #endif
  60
  61 #include <arpa/inet.h>
  62 #include <netinet/in.h>
  63
  64 #include "c-ctype.h"
  65 #include "glthread/lock.h"
  66 #include "hash.h"
  67 #include "hash-pjw.h"
  68
  69 #include "guestfs.h"
  70 #include "guestfs-internal.h"
  71 #include "guestfs-internal-actions.h"
  72 #include "guestfs_protocol.h"
  73
  74 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
  75 static void close_handles (void);
  76
  77 gl_lock_define_initialized (static, handles_lock);
  78 static guestfs_h *handles = NULL;
  79 static int atexit_handler_set = 0;
  80
  81 guestfs_h *
  82 guestfs_create (void)
  83 {
  84   guestfs_h *g;
  85   const char *str;
  86
  87   g = malloc (sizeof (*g));
  88   if (!g) return NULL;
  89
  90   memset (g, 0, sizeof (*g));
  91
  92   g->state = CONFIG;
  93
  94   g->fd[0] = -1;
  95   g->fd[1] = -1;
  96   g->sock = -1;
  97
  98   g->abort_cb = abort;
  99   g->error_cb = default_error_cb;
 100   g->error_cb_data = NULL;
 101
 102   g->recovery_proc = 1;
 103   g->autosync = 1;
 104
 105   str = getenv ("LIBGUESTFS_DEBUG");
 106   g->verbose = str != NULL && STREQ (str, "1");
 107
 108   str = getenv ("LIBGUESTFS_TRACE");
 109   g->trace = str != NULL && STREQ (str, "1");
 110
 111   str = getenv ("LIBGUESTFS_PATH");
 112   g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
 113   if (!g->path) goto error;
 114
 115   str = getenv ("LIBGUESTFS_QEMU");
 116   g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
 117   if (!g->qemu) goto error;
 118
 119   str = getenv ("LIBGUESTFS_APPEND");
 120   if (str) {
 121     g->append = strdup (str);
 122     if (!g->append) goto error;
 123   }
 124
 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.
 131    */
 132   str = getenv ("LIBGUESTFS_MEMSIZE");
 133   if (str) {
 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");
 136       goto error;
 137     }
 138   } else
 139     g->memsize = 500;
 140
 141   /* Start with large serial numbers so they are easy to spot
 142    * inside the protocol.
 143    */
 144   g->msg_next_serial = 0x00123400;
 145
 146   /* Link the handles onto a global list. */
 147   gl_lock_lock (handles_lock);
 148   g->next = handles;
 149   handles = g;
 150   if (!atexit_handler_set) {
 151     atexit (close_handles);
 152     atexit_handler_set = 1;
 153   }
 154   gl_lock_unlock (handles_lock);
 155
 156   if (g->verbose)
 157     fprintf (stderr, "new guestfs handle %p\n", g);
 158
 159   return g;
 160
 161  error:
 162   free (g->path);
 163   free (g->qemu);
 164   free (g->append);
 165   free (g);
 166   return NULL;
 167 }
 168
 169 void
 170 guestfs_close (guestfs_h *g)
 171 {
 172   int i;
 173   char filename[256];
 174   guestfs_h *gg;
 175
 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"));
 179     return;
 180   }
 181
 182   if (g->verbose)
 183     fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
 184
 185   /* Run user close callback before anything else. */
 186   if (g->close_cb)
 187     g->close_cb (g, g->close_cb_data);
 188
 189   guestfs___free_inspect_info (g);
 190
 191   /* Try to sync if autosync flag is set. */
 192   if (g->autosync && g->state == READY) {
 193     guestfs_umount_all (g);
 194     guestfs_sync (g);
 195   }
 196
 197   /* Remove any handlers that might be called back before we kill the
 198    * subprocess.
 199    */
 200   g->log_message_cb = NULL;
 201
 202   if (g->state != CONFIG)
 203     guestfs_kill_subprocess (g);
 204
 205   /* Close sockets. */
 206   if (g->fd[0] >= 0)
 207     close (g->fd[0]);
 208   if (g->fd[1] >= 0)
 209     close (g->fd[1]);
 210   if (g->sock >= 0)
 211     close (g->sock);
 212   g->fd[0] = -1;
 213   g->fd[1] = -1;
 214   g->sock = -1;
 215
 216   /* Wait for subprocess(es) to exit. */
 217   waitpid (g->pid, NULL, 0);
 218   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 219
 220   /* Remove tmpfiles. */
 221   if (g->tmpdir) {
 222     snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
 223     unlink (filename);
 224
 225     rmdir (g->tmpdir);
 226
 227     free (g->tmpdir);
 228   }
 229
 230   if (g->cmdline) {
 231     for (i = 0; i < g->cmdline_size; ++i)
 232       free (g->cmdline[i]);
 233     free (g->cmdline);
 234   }
 235
 236   /* Mark the handle as dead before freeing it. */
 237   g->state = NO_HANDLE;
 238
 239   gl_lock_lock (handles_lock);
 240   if (handles == g)
 241     handles = g->next;
 242   else {
 243     for (gg = handles; gg->next != g; gg = gg->next)
 244       ;
 245     gg->next = g->next;
 246   }
 247   gl_lock_unlock (handles_lock);
 248
 249   if (g->pda)
 250     hash_free (g->pda);
 251   free (g->last_error);
 252   free (g->path);
 253   free (g->qemu);
 254   free (g->append);
 255   free (g->qemu_help);
 256   free (g->qemu_version);
 257   free (g);
 258 }
 259
 260 /* Close all open handles (called from atexit(3)). */
 261 static void
 262 close_handles (void)
 263 {
 264   while (handles) guestfs_close (handles);
 265 }
 266
 267 const char *
 268 guestfs_last_error (guestfs_h *g)
 269 {
 270   return g->last_error;
 271 }
 272
 273 static void
 274 set_last_error (guestfs_h *g, const char *msg)
 275 {
 276   free (g->last_error);
 277   g->last_error = strdup (msg);
 278 }
 279
 280 static void
 281 default_error_cb (guestfs_h *g, void *data, const char *msg)
 282 {
 283   fprintf (stderr, _("libguestfs: error: %s\n"), msg);
 284 }
 285
 286 void
 287 guestfs_error (guestfs_h *g, const char *fs, ...)
 288 {
 289   va_list args;
 290   char *msg;
 291
 292   va_start (args, fs);
 293   int err = vasprintf (&msg, fs, args);
 294   va_end (args);
 295
 296   if (err < 0) return;
 297
 298   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 299   set_last_error (g, msg);
 300
 301   free (msg);
 302 }
 303
 304 void
 305 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
 306 {
 307   va_list args;
 308   char *msg;
 309   int errnum = errno;
 310
 311   va_start (args, fs);
 312   int err = vasprintf (&msg, fs, args);
 313   va_end (args);
 314
 315   if (err < 0) return;
 316
 317 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
 318   char buf[256];
 319   strerror_r (errnum, buf, sizeof buf);
 320 #else
 321   char _buf[256];
 322   char *buf;
 323   buf = strerror_r (errnum, _buf, sizeof _buf);
 324 #endif
 325
 326   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
 327   strcat (msg, ": ");
 328   strcat (msg, buf);
 329
 330   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 331   set_last_error (g, msg);
 332
 333   free (msg);
 334 }
 335
 336 void *
 337 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
 338 {
 339   void *ptr = malloc (nbytes);
 340   if (nbytes > 0 && !ptr) g->abort_cb ();
 341   return ptr;
 342 }
 343
 344 /* Return 1 if an array of N objects, each of size S, cannot exist due
 345    to size arithmetic overflow.  S must be positive and N must be
 346    nonnegative.  This is a macro, not an inline function, so that it
 347    works correctly even when SIZE_MAX < N.
 348
 349    By gnulib convention, SIZE_MAX represents overflow in size
 350    calculations, so the conservative dividend to use here is
 351    SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
 352    However, malloc (SIZE_MAX) fails on all known hosts where
 353    sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
 354    exactly-SIZE_MAX allocations on such hosts; this avoids a test and
 355    branch when S is known to be 1.  */
 356 # define xalloc_oversized(n, s) \
 357     ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
 358
 359 /* Technically we should add an autoconf test for this, testing for the desired
 360    functionality, like what's done in gnulib, but for now, this is fine.  */
 361 #if defined(__GLIBC__)
 362 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
 363 #else
 364 #define HAVE_GNU_CALLOC 0
 365 #endif
 366
 367 /* Allocate zeroed memory for N elements of S bytes, with error
 368    checking.  S must be nonzero.  */
 369 void *
 370 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
 371 {
 372   /* From gnulib's calloc function in xmalloc.c.  */
 373   void *p;
 374   /* Test for overflow, since some calloc implementations don't have
 375      proper overflow checks.  But omit overflow and size-zero tests if
 376      HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
 377      returns NULL if successful.  */
 378   if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
 379       || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
 380     g->abort_cb ();
 381   return p;
 382 }
 383
 384 void *
 385 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
 386 {
 387   void *p = realloc (ptr, nbytes);
 388   if (nbytes > 0 && !p) g->abort_cb ();
 389   return p;
 390 }
 391
 392 char *
 393 guestfs_safe_strdup (guestfs_h *g, const char *str)
 394 {
 395   char *s = strdup (str);
 396   if (!s) g->abort_cb ();
 397   return s;
 398 }
 399
 400 char *
 401 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
 402 {
 403   char *s = strndup (str, n);
 404   if (!s) g->abort_cb ();
 405   return s;
 406 }
 407
 408 void *
 409 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
 410 {
 411   void *p = malloc (size);
 412   if (!p) g->abort_cb ();
 413   memcpy (p, ptr, size);
 414   return p;
 415 }
 416
 417 void
 418 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
 419 {
 420   g->abort_cb = cb;
 421 }
 422
 423 guestfs_abort_cb
 424 guestfs_get_out_of_memory_handler (guestfs_h *g)
 425 {
 426   return g->abort_cb;
 427 }
 428
 429 void
 430 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
 431 {
 432   g->error_cb = cb;
 433   g->error_cb_data = data;
 434 }
 435
 436 guestfs_error_handler_cb
 437 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
 438 {
 439   if (data_rtn) *data_rtn = g->error_cb_data;
 440   return g->error_cb;
 441 }
 442
 443 int
 444 guestfs__set_verbose (guestfs_h *g, int v)
 445 {
 446   g->verbose = !!v;
 447   return 0;
 448 }
 449
 450 int
 451 guestfs__get_verbose (guestfs_h *g)
 452 {
 453   return g->verbose;
 454 }
 455
 456 int
 457 guestfs__set_autosync (guestfs_h *g, int a)
 458 {
 459   g->autosync = !!a;
 460   return 0;
 461 }
 462
 463 int
 464 guestfs__get_autosync (guestfs_h *g)
 465 {
 466   return g->autosync;
 467 }
 468
 469 int
 470 guestfs__set_path (guestfs_h *g, const char *path)
 471 {
 472   free (g->path);
 473   g->path = NULL;
 474
 475   g->path =
 476     path == NULL ?
 477     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
 478   return 0;
 479 }
 480
 481 const char *
 482 guestfs__get_path (guestfs_h *g)
 483 {
 484   return g->path;
 485 }
 486
 487 int
 488 guestfs__set_qemu (guestfs_h *g, const char *qemu)
 489 {
 490   free (g->qemu);
 491   g->qemu = NULL;
 492
 493   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
 494   return 0;
 495 }
 496
 497 const char *
 498 guestfs__get_qemu (guestfs_h *g)
 499 {
 500   return g->qemu;
 501 }
 502
 503 int
 504 guestfs__set_append (guestfs_h *g, const char *append)
 505 {
 506   free (g->append);
 507   g->append = NULL;
 508
 509   g->append = append ? safe_strdup (g, append) : NULL;
 510   return 0;
 511 }
 512
 513 const char *
 514 guestfs__get_append (guestfs_h *g)
 515 {
 516   return g->append;
 517 }
 518
 519 int
 520 guestfs__set_memsize (guestfs_h *g, int memsize)
 521 {
 522   g->memsize = memsize;
 523   return 0;
 524 }
 525
 526 int
 527 guestfs__get_memsize (guestfs_h *g)
 528 {
 529   return g->memsize;
 530 }
 531
 532 int
 533 guestfs__set_selinux (guestfs_h *g, int selinux)
 534 {
 535   g->selinux = selinux;
 536   return 0;
 537 }
 538
 539 int
 540 guestfs__get_selinux (guestfs_h *g)
 541 {
 542   return g->selinux;
 543 }
 544
 545 int
 546 guestfs__get_pid (guestfs_h *g)
 547 {
 548   if (g->pid > 0)
 549     return g->pid;
 550   else {
 551     error (g, "get_pid: no qemu subprocess");
 552     return -1;
 553   }
 554 }
 555
 556 struct guestfs_version *
 557 guestfs__version (guestfs_h *g)
 558 {
 559   struct guestfs_version *r;
 560
 561   r = safe_malloc (g, sizeof *r);
 562   r->major = PACKAGE_VERSION_MAJOR;
 563   r->minor = PACKAGE_VERSION_MINOR;
 564   r->release = PACKAGE_VERSION_RELEASE;
 565   r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
 566   return r;
 567 }
 568
 569 int
 570 guestfs__set_trace (guestfs_h *g, int t)
 571 {
 572   g->trace = !!t;
 573   return 0;
 574 }
 575
 576 int
 577 guestfs__get_trace (guestfs_h *g)
 578 {
 579   return g->trace;
 580 }
 581
 582 int
 583 guestfs__set_direct (guestfs_h *g, int d)
 584 {
 585   g->direct = !!d;
 586   return 0;
 587 }
 588
 589 int
 590 guestfs__get_direct (guestfs_h *g)
 591 {
 592   return g->direct;
 593 }
 594
 595 int
 596 guestfs__set_recovery_proc (guestfs_h *g, int f)
 597 {
 598   g->recovery_proc = !!f;
 599   return 0;
 600 }
 601
 602 int
 603 guestfs__get_recovery_proc (guestfs_h *g)
 604 {
 605   return g->recovery_proc;
 606 }
 607
 608 int
 609 guestfs__set_network (guestfs_h *g, int v)
 610 {
 611   g->enable_network = !!v;
 612   return 0;
 613 }
 614
 615 int
 616 guestfs__get_network (guestfs_h *g)
 617 {
 618   return g->enable_network;
 619 }
 620
 621 void
 622 guestfs_set_log_message_callback (guestfs_h *g,
 623                                   guestfs_log_message_cb cb, void *opaque)
 624 {
 625   g->log_message_cb = cb;
 626   g->log_message_cb_data = opaque;
 627 }
 628
 629 void
 630 guestfs_set_subprocess_quit_callback (guestfs_h *g,
 631                                       guestfs_subprocess_quit_cb cb, void *opaque)
 632 {
 633   g->subprocess_quit_cb = cb;
 634   g->subprocess_quit_cb_data = opaque;
 635 }
 636
 637 void
 638 guestfs_set_launch_done_callback (guestfs_h *g,
 639                                   guestfs_launch_done_cb cb, void *opaque)
 640 {
 641   g->launch_done_cb = cb;
 642   g->launch_done_cb_data = opaque;
 643 }
 644
 645 void
 646 guestfs_set_close_callback (guestfs_h *g,
 647                             guestfs_close_cb cb, void *opaque)
 648 {
 649   g->close_cb = cb;
 650   g->close_cb_data = opaque;
 651 }
 652
 653 void
 654 guestfs_set_progress_callback (guestfs_h *g,
 655                                guestfs_progress_cb cb, void *opaque)
 656 {
 657   g->progress_cb = cb;
 658   g->progress_cb_data = opaque;
 659 }
 660
 661 /* Note the private data area is allocated lazily, since the vast
 662  * majority of callers will never use it.  This means g->pda is
 663  * likely to be NULL.
 664  */
 665 struct pda_entry {
 666   char *key;                    /* key */
 667   void *data;                   /* opaque user data pointer */
 668 };
 669
 670 static size_t
 671 hasher (void const *x, size_t table_size)
 672 {
 673   struct pda_entry const *p = x;
 674   return hash_pjw (p->key, table_size);
 675 }
 676
 677 static bool
 678 comparator (void const *x, void const *y)
 679 {
 680   struct pda_entry const *a = x;
 681   struct pda_entry const *b = y;
 682   return STREQ (a->key, b->key);
 683 }
 684
 685 static void
 686 freer (void *x)
 687 {
 688   if (x) {
 689     struct pda_entry *p = x;
 690     free (p->key);
 691     free (p);
 692   }
 693 }
 694
 695 void
 696 guestfs_set_private (guestfs_h *g, const char *key, void *data)
 697 {
 698   if (g->pda == NULL) {
 699     g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
 700     if (g->pda == NULL)
 701       g->abort_cb ();
 702   }
 703
 704   struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
 705   new_entry->key = safe_strdup (g, key);
 706   new_entry->data = data;
 707
 708   struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
 709   freer (old_entry);
 710
 711   struct pda_entry *entry = hash_insert (g->pda, new_entry);
 712   if (entry == NULL)
 713     g->abort_cb ();
 714   assert (entry == new_entry);
 715 }
 716
 717 static inline char *
 718 bad_cast (char const *s)
 719 {
 720   return (char *) s;
 721 }
 722
 723 void *
 724 guestfs_get_private (guestfs_h *g, const char *key)
 725 {
 726   if (g->pda == NULL)
 727     return NULL;                /* no keys have been set */
 728
 729   const struct pda_entry k = { .key = bad_cast (key) };
 730   struct pda_entry *entry = hash_lookup (g->pda, &k);
 731   if (entry)
 732     return entry->data;
 733   else
 734     return NULL;
 735 }
 736
 737 /* When tracing, be careful how we print BufferIn parameters which
 738  * usually contain large amounts of binary data (RHBZ#646822).
 739  */
 740 void
 741 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
 742 {
 743   size_t i;
 744   size_t orig_size = buf_size;
 745
 746   if (buf_size > 256)
 747     buf_size = 256;
 748
 749   fputc ('"', out);
 750
 751   for (i = 0; i < buf_size; ++i) {
 752     if (c_isprint (buf[i]))
 753       fputc (buf[i], out);
 754     else
 755       fprintf (out, "\\x%02x", (unsigned char) buf[i]);
 756   }
 757
 758   fputc ('"', out);
 759
 760   if (orig_size > buf_size)
 761     fprintf (out,
 762              _("<truncated, original size %zu bytes>"), orig_size);
 763 }