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 <signal.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 "ignore-value.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   /* Try to sync if autosync flag is set. */
 188   if (g->autosync && g->state == READY) {
 189     guestfs_umount_all (g);
 190     guestfs_sync (g);
 191   }
 192
 193   /* Remove any handlers that might be called back before we kill the
 194    * subprocess.
 195    */
 196   g->log_message_cb = NULL;
 197
 198   if (g->state != CONFIG)
 199     guestfs_kill_subprocess (g);
 200
 201   /* Close sockets. */
 202   if (g->fd[0] >= 0)
 203     close (g->fd[0]);
 204   if (g->fd[1] >= 0)
 205     close (g->fd[1]);
 206   if (g->sock >= 0)
 207     close (g->sock);
 208   g->fd[0] = -1;
 209   g->fd[1] = -1;
 210   g->sock = -1;
 211
 212   /* Wait for subprocess(es) to exit. */
 213   waitpid (g->pid, NULL, 0);
 214   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
 215
 216   /* Remove tmpfiles. */
 217   if (g->tmpdir) {
 218     snprintf (filename, sizeof filename, "%s/sock", g->tmpdir);
 219     unlink (filename);
 220
 221     snprintf (filename, sizeof filename, "%s/initrd", g->tmpdir);
 222     unlink (filename);
 223
 224     snprintf (filename, sizeof filename, "%s/kernel", g->tmpdir);
 225     unlink (filename);
 226
 227     rmdir (g->tmpdir);
 228
 229     free (g->tmpdir);
 230   }
 231
 232   if (g->cmdline) {
 233     for (i = 0; i < g->cmdline_size; ++i)
 234       free (g->cmdline[i]);
 235     free (g->cmdline);
 236   }
 237
 238   /* Mark the handle as dead before freeing it. */
 239   g->state = NO_HANDLE;
 240
 241   gl_lock_lock (handles_lock);
 242   if (handles == g)
 243     handles = g->next;
 244   else {
 245     for (gg = handles; gg->next != g; gg = gg->next)
 246       ;
 247     gg->next = g->next;
 248   }
 249   gl_lock_unlock (handles_lock);
 250
 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 void *
 401 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
 402 {
 403   void *p = malloc (size);
 404   if (!p) g->abort_cb ();
 405   memcpy (p, ptr, size);
 406   return p;
 407 }
 408
 409 void
 410 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
 411 {
 412   g->abort_cb = cb;
 413 }
 414
 415 guestfs_abort_cb
 416 guestfs_get_out_of_memory_handler (guestfs_h *g)
 417 {
 418   return g->abort_cb;
 419 }
 420
 421 void
 422 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
 423 {
 424   g->error_cb = cb;
 425   g->error_cb_data = data;
 426 }
 427
 428 guestfs_error_handler_cb
 429 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
 430 {
 431   if (data_rtn) *data_rtn = g->error_cb_data;
 432   return g->error_cb;
 433 }
 434
 435 int
 436 guestfs__set_verbose (guestfs_h *g, int v)
 437 {
 438   g->verbose = !!v;
 439   return 0;
 440 }
 441
 442 int
 443 guestfs__get_verbose (guestfs_h *g)
 444 {
 445   return g->verbose;
 446 }
 447
 448 int
 449 guestfs__set_autosync (guestfs_h *g, int a)
 450 {
 451   g->autosync = !!a;
 452   return 0;
 453 }
 454
 455 int
 456 guestfs__get_autosync (guestfs_h *g)
 457 {
 458   return g->autosync;
 459 }
 460
 461 int
 462 guestfs__set_path (guestfs_h *g, const char *path)
 463 {
 464   free (g->path);
 465   g->path = NULL;
 466
 467   g->path =
 468     path == NULL ?
 469     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
 470   return 0;
 471 }
 472
 473 const char *
 474 guestfs__get_path (guestfs_h *g)
 475 {
 476   return g->path;
 477 }
 478
 479 int
 480 guestfs__set_qemu (guestfs_h *g, const char *qemu)
 481 {
 482   free (g->qemu);
 483   g->qemu = NULL;
 484
 485   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
 486   return 0;
 487 }
 488
 489 const char *
 490 guestfs__get_qemu (guestfs_h *g)
 491 {
 492   return g->qemu;
 493 }
 494
 495 int
 496 guestfs__set_append (guestfs_h *g, const char *append)
 497 {
 498   free (g->append);
 499   g->append = NULL;
 500
 501   g->append = append ? safe_strdup (g, append) : NULL;
 502   return 0;
 503 }
 504
 505 const char *
 506 guestfs__get_append (guestfs_h *g)
 507 {
 508   return g->append;
 509 }
 510
 511 int
 512 guestfs__set_memsize (guestfs_h *g, int memsize)
 513 {
 514   g->memsize = memsize;
 515   return 0;
 516 }
 517
 518 int
 519 guestfs__get_memsize (guestfs_h *g)
 520 {
 521   return g->memsize;
 522 }
 523
 524 int
 525 guestfs__set_selinux (guestfs_h *g, int selinux)
 526 {
 527   g->selinux = selinux;
 528   return 0;
 529 }
 530
 531 int
 532 guestfs__get_selinux (guestfs_h *g)
 533 {
 534   return g->selinux;
 535 }
 536
 537 int
 538 guestfs__get_pid (guestfs_h *g)
 539 {
 540   if (g->pid > 0)
 541     return g->pid;
 542   else {
 543     error (g, "get_pid: no qemu subprocess");
 544     return -1;
 545   }
 546 }
 547
 548 struct guestfs_version *
 549 guestfs__version (guestfs_h *g)
 550 {
 551   struct guestfs_version *r;
 552
 553   r = safe_malloc (g, sizeof *r);
 554   r->major = PACKAGE_VERSION_MAJOR;
 555   r->minor = PACKAGE_VERSION_MINOR;
 556   r->release = PACKAGE_VERSION_RELEASE;
 557   r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
 558   return r;
 559 }
 560
 561 int
 562 guestfs__set_trace (guestfs_h *g, int t)
 563 {
 564   g->trace = !!t;
 565   return 0;
 566 }
 567
 568 int
 569 guestfs__get_trace (guestfs_h *g)
 570 {
 571   return g->trace;
 572 }
 573
 574 int
 575 guestfs__set_direct (guestfs_h *g, int d)
 576 {
 577   g->direct = !!d;
 578   return 0;
 579 }
 580
 581 int
 582 guestfs__get_direct (guestfs_h *g)
 583 {
 584   return g->direct;
 585 }
 586
 587 int
 588 guestfs__set_recovery_proc (guestfs_h *g, int f)
 589 {
 590   g->recovery_proc = !!f;
 591   return 0;
 592 }
 593
 594 int
 595 guestfs__get_recovery_proc (guestfs_h *g)
 596 {
 597   return g->recovery_proc;
 598 }
 599
 600 void
 601 guestfs_set_log_message_callback (guestfs_h *g,
 602                                   guestfs_log_message_cb cb, void *opaque)
 603 {
 604   g->log_message_cb = cb;
 605   g->log_message_cb_data = opaque;
 606 }
 607
 608 void
 609 guestfs_set_subprocess_quit_callback (guestfs_h *g,
 610                                       guestfs_subprocess_quit_cb cb, void *opaque)
 611 {
 612   g->subprocess_quit_cb = cb;
 613   g->subprocess_quit_cb_data = opaque;
 614 }
 615
 616 void
 617 guestfs_set_launch_done_callback (guestfs_h *g,
 618                                   guestfs_launch_done_cb cb, void *opaque)
 619 {
 620   g->launch_done_cb = cb;
 621   g->launch_done_cb_data = opaque;
 622 }
 623
 624 void
 625 guestfs_set_close_callback (guestfs_h *g,
 626                             guestfs_close_cb cb, void *opaque)
 627 {
 628   g->close_cb = cb;
 629   g->close_cb_data = opaque;
 630 }