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 "glthread/lock.h"
  65 #include "hash.h"
  66 #include "hash-pjw.h"
  67
  68 #include "guestfs.h"
  69 #include "guestfs-internal.h"
  70 #include "guestfs-internal-actions.h"
  71 #include "guestfs_protocol.h"
  72
  73 static void default_error_cb (guestfs_h *g, void *data, const char *msg);
  74 static void close_handles (void);
  75
  76 gl_lock_define_initialized (static, handles_lock);
  77 static guestfs_h *handles = NULL;
  78 static int atexit_handler_set = 0;
  79
  80 guestfs_h *
  81 guestfs_create (void)
  82 {
  83   guestfs_h *g;
  84   const char *str;
  85
  86   g = malloc (sizeof (*g));
  87   if (!g) return NULL;
  88
  89   memset (g, 0, sizeof (*g));
  90
  91   g->state = CONFIG;
  92
  93   g->fd[0] = -1;
  94   g->fd[1] = -1;
  95   g->sock = -1;
  96
  97   g->abort_cb = abort;
  98   g->error_cb = default_error_cb;
  99   g->error_cb_data = NULL;
 100
 101   g->recovery_proc = 1;
 102
 103   str = getenv ("LIBGUESTFS_DEBUG");
 104   g->verbose = str != NULL && STREQ (str, "1");
 105
 106   str = getenv ("LIBGUESTFS_TRACE");
 107   g->trace = str != NULL && STREQ (str, "1");
 108
 109   str = getenv ("LIBGUESTFS_PATH");
 110   g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
 111   if (!g->path) goto error;
 112
 113   str = getenv ("LIBGUESTFS_QEMU");
 114   g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
 115   if (!g->qemu) goto error;
 116
 117   str = getenv ("LIBGUESTFS_APPEND");
 118   if (str) {
 119     g->append = strdup (str);
 120     if (!g->append) goto error;
 121   }
 122
 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.
 129    */
 130   str = getenv ("LIBGUESTFS_MEMSIZE");
 131   if (str) {
 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");
 134       goto error;
 135     }
 136   } else
 137     g->memsize = 500;
 138
 139   /* Start with large serial numbers so they are easy to spot
 140    * inside the protocol.
 141    */
 142   g->msg_next_serial = 0x00123400;
 143
 144   /* Link the handles onto a global list. */
 145   gl_lock_lock (handles_lock);
 146   g->next = handles;
 147   handles = g;
 148   if (!atexit_handler_set) {
 149     atexit (close_handles);
 150     atexit_handler_set = 1;
 151   }
 152   gl_lock_unlock (handles_lock);
 153
 154   if (g->verbose)
 155     fprintf (stderr, "new guestfs handle %p\n", g);
 156
 157   return g;
 158
 159  error:
 160   free (g->path);
 161   free (g->qemu);
 162   free (g->append);
 163   free (g);
 164   return NULL;
 165 }
 166
 167 void
 168 guestfs_close (guestfs_h *g)
 169 {
 170   int i;
 171   char filename[256];
 172   guestfs_h *gg;
 173
 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"));
 177     return;
 178   }
 179
 180   if (g->verbose)
 181     fprintf (stderr, "closing guestfs handle %p (state %d)\n", g, g->state);
 182
 183   /* Run user close callback before anything else. */
 184   if (g->close_cb)
 185     g->close_cb (g, g->close_cb_data);
 186
 187   guestfs___free_inspect_info (g);
 188
 189   /* Try to sync if autosync flag is set. */
 190   if (g->autosync && g->state == READY) {
 191     guestfs_umount_all (g);
 192     guestfs_sync (g);
 193   }
 194
 195   /* Remove any handlers that might be called back before we kill the
 196    * subprocess.
 197    */
 198   g->log_message_cb = NULL;
 199
 200   if (g->state != CONFIG)
 201     guestfs_kill_subprocess (g);
 202
 203   /* Close sockets. */
 204   if (g->fd[0] >= 0)
 205     close (g->fd[0]);
 206   if (g->fd[1] >= 0)
 207     close (g->fd[1]);
 208   if (g->sock >= 0)
 209     close (g->sock);
 210   g->fd[0] = -1;
 211   g->fd[1] = -1;
 212   g->sock = -1;
 213
 214   /* Wait for subprocess(es) to exit. */
 215   waitpid (g->pid, NULL, 0);
 216   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 217
 218   /* Remove tmpfiles. */
 219   if (g->tmpdir) {
 220     snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
 221     unlink (filename);
 222
 223     rmdir (g->tmpdir);
 224
 225     free (g->tmpdir);
 226   }
 227
 228   if (g->cmdline) {
 229     for (i = 0; i < g->cmdline_size; ++i)
 230       free (g->cmdline[i]);
 231     free (g->cmdline);
 232   }
 233
 234   /* Mark the handle as dead before freeing it. */
 235   g->state = NO_HANDLE;
 236
 237   gl_lock_lock (handles_lock);
 238   if (handles == g)
 239     handles = g->next;
 240   else {
 241     for (gg = handles; gg->next != g; gg = gg->next)
 242       ;
 243     gg->next = g->next;
 244   }
 245   gl_lock_unlock (handles_lock);
 246
 247   if (g->pda)
 248     hash_free (g->pda);
 249   free (g->last_error);
 250   free (g->path);
 251   free (g->qemu);
 252   free (g->append);
 253   free (g->qemu_help);
 254   free (g->qemu_version);
 255   free (g);
 256 }
 257
 258 /* Close all open handles (called from atexit(3)). */
 259 static void
 260 close_handles (void)
 261 {
 262   while (handles) guestfs_close (handles);
 263 }
 264
 265 const char *
 266 guestfs_last_error (guestfs_h *g)
 267 {
 268   return g->last_error;
 269 }
 270
 271 static void
 272 set_last_error (guestfs_h *g, const char *msg)
 273 {
 274   free (g->last_error);
 275   g->last_error = strdup (msg);
 276 }
 277
 278 static void
 279 default_error_cb (guestfs_h *g, void *data, const char *msg)
 280 {
 281   fprintf (stderr, _("libguestfs: error: %s\n"), msg);
 282 }
 283
 284 void
 285 guestfs_error (guestfs_h *g, const char *fs, ...)
 286 {
 287   va_list args;
 288   char *msg;
 289
 290   va_start (args, fs);
 291   int err = vasprintf (&msg, fs, args);
 292   va_end (args);
 293
 294   if (err < 0) return;
 295
 296   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 297   set_last_error (g, msg);
 298
 299   free (msg);
 300 }
 301
 302 void
 303 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
 304 {
 305   va_list args;
 306   char *msg;
 307   int errnum = errno;
 308
 309   va_start (args, fs);
 310   int err = vasprintf (&msg, fs, args);
 311   va_end (args);
 312
 313   if (err < 0) return;
 314
 315 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
 316   char buf[256];
 317   strerror_r (errnum, buf, sizeof buf);
 318 #else
 319   char _buf[256];
 320   char *buf;
 321   buf = strerror_r (errnum, _buf, sizeof _buf);
 322 #endif
 323
 324   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
 325   strcat (msg, ": ");
 326   strcat (msg, buf);
 327
 328   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 329   set_last_error (g, msg);
 330
 331   free (msg);
 332 }
 333
 334 void *
 335 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
 336 {
 337   void *ptr = malloc (nbytes);
 338   if (nbytes > 0 && !ptr) g->abort_cb ();
 339   return ptr;
 340 }
 341
 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.
 346
 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))
 356
 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)
 361 #else
 362 #define HAVE_GNU_CALLOC 0
 363 #endif
 364
 365 /* Allocate zeroed memory for N elements of S bytes, with error
 366    checking.  S must be nonzero.  */
 367 void *
 368 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
 369 {
 370   /* From gnulib's calloc function in xmalloc.c.  */
 371   void *p;
 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)))
 378     g->abort_cb ();
 379   return p;
 380 }
 381
 382 void *
 383 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
 384 {
 385   void *p = realloc (ptr, nbytes);
 386   if (nbytes > 0 && !p) g->abort_cb ();
 387   return p;
 388 }
 389
 390 char *
 391 guestfs_safe_strdup (guestfs_h *g, const char *str)
 392 {
 393   char *s = strdup (str);
 394   if (!s) g->abort_cb ();
 395   return s;
 396 }
 397
 398 char *
 399 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
 400 {
 401   char *s = strndup (str, n);
 402   if (!s) g->abort_cb ();
 403   return s;
 404 }
 405
 406 void *
 407 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
 408 {
 409   void *p = malloc (size);
 410   if (!p) g->abort_cb ();
 411   memcpy (p, ptr, size);
 412   return p;
 413 }
 414
 415 void
 416 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
 417 {
 418   g->abort_cb = cb;
 419 }
 420
 421 guestfs_abort_cb
 422 guestfs_get_out_of_memory_handler (guestfs_h *g)
 423 {
 424   return g->abort_cb;
 425 }
 426
 427 void
 428 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
 429 {
 430   g->error_cb = cb;
 431   g->error_cb_data = data;
 432 }
 433
 434 guestfs_error_handler_cb
 435 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
 436 {
 437   if (data_rtn) *data_rtn = g->error_cb_data;
 438   return g->error_cb;
 439 }
 440
 441 int
 442 guestfs__set_verbose (guestfs_h *g, int v)
 443 {
 444   g->verbose = !!v;
 445   return 0;
 446 }
 447
 448 int
 449 guestfs__get_verbose (guestfs_h *g)
 450 {
 451   return g->verbose;
 452 }
 453
 454 int
 455 guestfs__set_autosync (guestfs_h *g, int a)
 456 {
 457   g->autosync = !!a;
 458   return 0;
 459 }
 460
 461 int
 462 guestfs__get_autosync (guestfs_h *g)
 463 {
 464   return g->autosync;
 465 }
 466
 467 int
 468 guestfs__set_path (guestfs_h *g, const char *path)
 469 {
 470   free (g->path);
 471   g->path = NULL;
 472
 473   g->path =
 474     path == NULL ?
 475     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
 476   return 0;
 477 }
 478
 479 const char *
 480 guestfs__get_path (guestfs_h *g)
 481 {
 482   return g->path;
 483 }
 484
 485 int
 486 guestfs__set_qemu (guestfs_h *g, const char *qemu)
 487 {
 488   free (g->qemu);
 489   g->qemu = NULL;
 490
 491   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
 492   return 0;
 493 }
 494
 495 const char *
 496 guestfs__get_qemu (guestfs_h *g)
 497 {
 498   return g->qemu;
 499 }
 500
 501 int
 502 guestfs__set_append (guestfs_h *g, const char *append)
 503 {
 504   free (g->append);
 505   g->append = NULL;
 506
 507   g->append = append ? safe_strdup (g, append) : NULL;
 508   return 0;
 509 }
 510
 511 const char *
 512 guestfs__get_append (guestfs_h *g)
 513 {
 514   return g->append;
 515 }
 516
 517 int
 518 guestfs__set_memsize (guestfs_h *g, int memsize)
 519 {
 520   g->memsize = memsize;
 521   return 0;
 522 }
 523
 524 int
 525 guestfs__get_memsize (guestfs_h *g)
 526 {
 527   return g->memsize;
 528 }
 529
 530 int
 531 guestfs__set_selinux (guestfs_h *g, int selinux)
 532 {
 533   g->selinux = selinux;
 534   return 0;
 535 }
 536
 537 int
 538 guestfs__get_selinux (guestfs_h *g)
 539 {
 540   return g->selinux;
 541 }
 542
 543 int
 544 guestfs__get_pid (guestfs_h *g)
 545 {
 546   if (g->pid > 0)
 547     return g->pid;
 548   else {
 549     error (g, "get_pid: no qemu subprocess");
 550     return -1;
 551   }
 552 }
 553
 554 struct guestfs_version *
 555 guestfs__version (guestfs_h *g)
 556 {
 557   struct guestfs_version *r;
 558
 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);
 564   return r;
 565 }
 566
 567 int
 568 guestfs__set_trace (guestfs_h *g, int t)
 569 {
 570   g->trace = !!t;
 571   return 0;
 572 }
 573
 574 int
 575 guestfs__get_trace (guestfs_h *g)
 576 {
 577   return g->trace;
 578 }
 579
 580 int
 581 guestfs__set_direct (guestfs_h *g, int d)
 582 {
 583   g->direct = !!d;
 584   return 0;
 585 }
 586
 587 int
 588 guestfs__get_direct (guestfs_h *g)
 589 {
 590   return g->direct;
 591 }
 592
 593 int
 594 guestfs__set_recovery_proc (guestfs_h *g, int f)
 595 {
 596   g->recovery_proc = !!f;
 597   return 0;
 598 }
 599
 600 int
 601 guestfs__get_recovery_proc (guestfs_h *g)
 602 {
 603   return g->recovery_proc;
 604 }
 605
 606 int
 607 guestfs__set_network (guestfs_h *g, int v)
 608 {
 609   g->enable_network = !!v;
 610   return 0;
 611 }
 612
 613 int
 614 guestfs__get_network (guestfs_h *g)
 615 {
 616   return g->enable_network;
 617 }
 618
 619 void
 620 guestfs_set_log_message_callback (guestfs_h *g,
 621                                   guestfs_log_message_cb cb, void *opaque)
 622 {
 623   g->log_message_cb = cb;
 624   g->log_message_cb_data = opaque;
 625 }
 626
 627 void
 628 guestfs_set_subprocess_quit_callback (guestfs_h *g,
 629                                       guestfs_subprocess_quit_cb cb, void *opaque)
 630 {
 631   g->subprocess_quit_cb = cb;
 632   g->subprocess_quit_cb_data = opaque;
 633 }
 634
 635 void
 636 guestfs_set_launch_done_callback (guestfs_h *g,
 637                                   guestfs_launch_done_cb cb, void *opaque)
 638 {
 639   g->launch_done_cb = cb;
 640   g->launch_done_cb_data = opaque;
 641 }
 642
 643 void
 644 guestfs_set_close_callback (guestfs_h *g,
 645                             guestfs_close_cb cb, void *opaque)
 646 {
 647   g->close_cb = cb;
 648   g->close_cb_data = opaque;
 649 }
 650
 651 void
 652 guestfs_set_progress_callback (guestfs_h *g,
 653                                guestfs_progress_cb cb, void *opaque)
 654 {
 655   g->progress_cb = cb;
 656   g->progress_cb_data = opaque;
 657 }
 658
 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
 661  * likely to be NULL.
 662  */
 663 struct pda_entry {
 664   char *key;                    /* key */
 665   void *data;                   /* opaque user data pointer */
 666 };
 667
 668 static size_t
 669 hasher (void const *x, size_t table_size)
 670 {
 671   struct pda_entry const *p = x;
 672   return hash_pjw (p->key, table_size);
 673 }
 674
 675 static bool
 676 comparator (void const *x, void const *y)
 677 {
 678   struct pda_entry const *a = x;
 679   struct pda_entry const *b = y;
 680   return STREQ (a->key, b->key);
 681 }
 682
 683 static void
 684 freer (void *x)
 685 {
 686   if (x) {
 687     struct pda_entry *p = x;
 688     free (p->key);
 689     free (p);
 690   }
 691 }
 692
 693 void
 694 guestfs_set_private (guestfs_h *g, const char *key, void *data)
 695 {
 696   if (g->pda == NULL) {
 697     g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
 698     if (g->pda == NULL)
 699       g->abort_cb ();
 700   }
 701
 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;
 705
 706   struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
 707   freer (old_entry);
 708
 709   struct pda_entry *entry = hash_insert (g->pda, new_entry);
 710   if (entry == NULL)
 711     g->abort_cb ();
 712   assert (entry == new_entry);
 713 }
 714
 715 static inline char *
 716 bad_cast (char const *s)
 717 {
 718   return (char *) s;
 719 }
 720
 721 void *
 722 guestfs_get_private (guestfs_h *g, const char *key)
 723 {
 724   if (g->pda == NULL)
 725     return NULL;                /* no keys have been set */
 726
 727   const struct pda_entry k = { .key = bad_cast (key) };
 728   struct pda_entry *entry = hash_lookup (g->pda, &k);
 729   if (entry)
 730     return entry->data;
 731   else
 732     return NULL;
 733 }