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_internal_autosync (g);
 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 int
 272 guestfs_last_errno (guestfs_h *g)
 273 {
 274   return g->last_errnum;
 275 }
 276
 277 static void
 278 set_last_error (guestfs_h *g, int errnum, const char *msg)
 279 {
 280   free (g->last_error);
 281   g->last_error = strdup (msg);
 282   g->last_errnum = errnum;
 283 }
 284
 285 static void
 286 default_error_cb (guestfs_h *g, void *data, const char *msg)
 287 {
 288   fprintf (stderr, _("libguestfs: error: %s\n"), msg);
 289 }
 290
 291 void
 292 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
 293 {
 294   va_list args;
 295   char *msg;
 296
 297   va_start (args, fs);
 298   int err = vasprintf (&msg, fs, args);
 299   va_end (args);
 300
 301   if (err < 0) return;
 302
 303   /* set_last_error first so that the callback can access the error
 304    * message and errno through the handle if it wishes.
 305    */
 306   set_last_error (g, errnum, msg);
 307   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 308
 309   free (msg);
 310 }
 311
 312 void
 313 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
 314 {
 315   va_list args;
 316   char *msg;
 317   int errnum = errno;
 318
 319   va_start (args, fs);
 320   int err = vasprintf (&msg, fs, args);
 321   va_end (args);
 322
 323   if (err < 0) return;
 324
 325 #if !defined(_GNU_SOURCE) || defined(__APPLE__)
 326   char buf[256];
 327   strerror_r (errnum, buf, sizeof buf);
 328 #else
 329   char _buf[256];
 330   char *buf;
 331   buf = strerror_r (errnum, _buf, sizeof _buf);
 332 #endif
 333
 334   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
 335   strcat (msg, ": ");
 336   strcat (msg, buf);
 337
 338   /* set_last_error first so that the callback can access the error
 339    * message and errno through the handle if it wishes.
 340    */
 341   set_last_error (g, errnum, msg);
 342   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
 343
 344   free (msg);
 345 }
 346
 347 void *
 348 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
 349 {
 350   void *ptr = malloc (nbytes);
 351   if (nbytes > 0 && !ptr) g->abort_cb ();
 352   return ptr;
 353 }
 354
 355 /* Return 1 if an array of N objects, each of size S, cannot exist due
 356    to size arithmetic overflow.  S must be positive and N must be
 357    nonnegative.  This is a macro, not an inline function, so that it
 358    works correctly even when SIZE_MAX < N.
 359
 360    By gnulib convention, SIZE_MAX represents overflow in size
 361    calculations, so the conservative dividend to use here is
 362    SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
 363    However, malloc (SIZE_MAX) fails on all known hosts where
 364    sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
 365    exactly-SIZE_MAX allocations on such hosts; this avoids a test and
 366    branch when S is known to be 1.  */
 367 # define xalloc_oversized(n, s) \
 368     ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
 369
 370 /* Technically we should add an autoconf test for this, testing for the desired
 371    functionality, like what's done in gnulib, but for now, this is fine.  */
 372 #if defined(__GLIBC__)
 373 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
 374 #else
 375 #define HAVE_GNU_CALLOC 0
 376 #endif
 377
 378 /* Allocate zeroed memory for N elements of S bytes, with error
 379    checking.  S must be nonzero.  */
 380 void *
 381 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
 382 {
 383   /* From gnulib's calloc function in xmalloc.c.  */
 384   void *p;
 385   /* Test for overflow, since some calloc implementations don't have
 386      proper overflow checks.  But omit overflow and size-zero tests if
 387      HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
 388      returns NULL if successful.  */
 389   if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
 390       || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
 391     g->abort_cb ();
 392   return p;
 393 }
 394
 395 void *
 396 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
 397 {
 398   void *p = realloc (ptr, nbytes);
 399   if (nbytes > 0 && !p) g->abort_cb ();
 400   return p;
 401 }
 402
 403 char *
 404 guestfs_safe_strdup (guestfs_h *g, const char *str)
 405 {
 406   char *s = strdup (str);
 407   if (!s) g->abort_cb ();
 408   return s;
 409 }
 410
 411 char *
 412 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
 413 {
 414   char *s = strndup (str, n);
 415   if (!s) g->abort_cb ();
 416   return s;
 417 }
 418
 419 void *
 420 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
 421 {
 422   void *p = malloc (size);
 423   if (!p) g->abort_cb ();
 424   memcpy (p, ptr, size);
 425   return p;
 426 }
 427
 428 char *
 429 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
 430 {
 431   va_list args;
 432   char *msg;
 433
 434   va_start (args, fs);
 435   int err = vasprintf (&msg, fs, args);
 436   va_end (args);
 437
 438   if (err == -1)
 439     g->abort_cb ();
 440
 441   return msg;
 442 }
 443
 444 void
 445 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
 446 {
 447   g->abort_cb = cb;
 448 }
 449
 450 guestfs_abort_cb
 451 guestfs_get_out_of_memory_handler (guestfs_h *g)
 452 {
 453   return g->abort_cb;
 454 }
 455
 456 void
 457 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
 458 {
 459   g->error_cb = cb;
 460   g->error_cb_data = data;
 461 }
 462
 463 guestfs_error_handler_cb
 464 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
 465 {
 466   if (data_rtn) *data_rtn = g->error_cb_data;
 467   return g->error_cb;
 468 }
 469
 470 int
 471 guestfs__set_verbose (guestfs_h *g, int v)
 472 {
 473   g->verbose = !!v;
 474   return 0;
 475 }
 476
 477 int
 478 guestfs__get_verbose (guestfs_h *g)
 479 {
 480   return g->verbose;
 481 }
 482
 483 int
 484 guestfs__set_autosync (guestfs_h *g, int a)
 485 {
 486   g->autosync = !!a;
 487   return 0;
 488 }
 489
 490 int
 491 guestfs__get_autosync (guestfs_h *g)
 492 {
 493   return g->autosync;
 494 }
 495
 496 int
 497 guestfs__set_path (guestfs_h *g, const char *path)
 498 {
 499   free (g->path);
 500   g->path = NULL;
 501
 502   g->path =
 503     path == NULL ?
 504     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
 505   return 0;
 506 }
 507
 508 const char *
 509 guestfs__get_path (guestfs_h *g)
 510 {
 511   return g->path;
 512 }
 513
 514 int
 515 guestfs__set_qemu (guestfs_h *g, const char *qemu)
 516 {
 517   free (g->qemu);
 518   g->qemu = NULL;
 519
 520   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
 521   return 0;
 522 }
 523
 524 const char *
 525 guestfs__get_qemu (guestfs_h *g)
 526 {
 527   return g->qemu;
 528 }
 529
 530 int
 531 guestfs__set_append (guestfs_h *g, const char *append)
 532 {
 533   free (g->append);
 534   g->append = NULL;
 535
 536   g->append = append ? safe_strdup (g, append) : NULL;
 537   return 0;
 538 }
 539
 540 const char *
 541 guestfs__get_append (guestfs_h *g)
 542 {
 543   return g->append;
 544 }
 545
 546 int
 547 guestfs__set_memsize (guestfs_h *g, int memsize)
 548 {
 549   g->memsize = memsize;
 550   return 0;
 551 }
 552
 553 int
 554 guestfs__get_memsize (guestfs_h *g)
 555 {
 556   return g->memsize;
 557 }
 558
 559 int
 560 guestfs__set_selinux (guestfs_h *g, int selinux)
 561 {
 562   g->selinux = selinux;
 563   return 0;
 564 }
 565
 566 int
 567 guestfs__get_selinux (guestfs_h *g)
 568 {
 569   return g->selinux;
 570 }
 571
 572 int
 573 guestfs__get_pid (guestfs_h *g)
 574 {
 575   if (g->pid > 0)
 576     return g->pid;
 577   else {
 578     error (g, "get_pid: no qemu subprocess");
 579     return -1;
 580   }
 581 }
 582
 583 struct guestfs_version *
 584 guestfs__version (guestfs_h *g)
 585 {
 586   struct guestfs_version *r;
 587
 588   r = safe_malloc (g, sizeof *r);
 589   r->major = PACKAGE_VERSION_MAJOR;
 590   r->minor = PACKAGE_VERSION_MINOR;
 591   r->release = PACKAGE_VERSION_RELEASE;
 592   r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
 593   return r;
 594 }
 595
 596 int
 597 guestfs__set_trace (guestfs_h *g, int t)
 598 {
 599   g->trace = !!t;
 600   return 0;
 601 }
 602
 603 int
 604 guestfs__get_trace (guestfs_h *g)
 605 {
 606   return g->trace;
 607 }
 608
 609 int
 610 guestfs__set_direct (guestfs_h *g, int d)
 611 {
 612   g->direct = !!d;
 613   return 0;
 614 }
 615
 616 int
 617 guestfs__get_direct (guestfs_h *g)
 618 {
 619   return g->direct;
 620 }
 621
 622 int
 623 guestfs__set_recovery_proc (guestfs_h *g, int f)
 624 {
 625   g->recovery_proc = !!f;
 626   return 0;
 627 }
 628
 629 int
 630 guestfs__get_recovery_proc (guestfs_h *g)
 631 {
 632   return g->recovery_proc;
 633 }
 634
 635 int
 636 guestfs__set_network (guestfs_h *g, int v)
 637 {
 638   g->enable_network = !!v;
 639   return 0;
 640 }
 641
 642 int
 643 guestfs__get_network (guestfs_h *g)
 644 {
 645   return g->enable_network;
 646 }
 647
 648 int
 649 guestfs__set_attach_method (guestfs_h *g, const char *method)
 650 {
 651   if (STREQ (method, "appliance")) {
 652     g->attach_method = ATTACH_METHOD_APPLIANCE;
 653     free (g->attach_method_arg);
 654     g->attach_method_arg = NULL;
 655   }
 656   else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
 657     g->attach_method = ATTACH_METHOD_UNIX;
 658     free (g->attach_method_arg);
 659     g->attach_method_arg = safe_strdup (g, method + 5);
 660     /* Note that we don't check the path exists until launch is called. */
 661   }
 662   else {
 663     error (g, "invalid attach method: %s", method);
 664     return -1;
 665   }
 666
 667   return 0;
 668 }
 669
 670 char *
 671 guestfs__get_attach_method (guestfs_h *g)
 672 {
 673   char *ret;
 674
 675   switch (g->attach_method) {
 676   case ATTACH_METHOD_APPLIANCE:
 677     ret = safe_strdup (g, "appliance");
 678     break;
 679
 680   case ATTACH_METHOD_UNIX:
 681     ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
 682     strcpy (ret, "unix:");
 683     strcat (ret, g->attach_method_arg);
 684     break;
 685
 686   default: /* keep GCC happy - this is not reached */
 687     abort ();
 688   }
 689
 690   return ret;
 691 }
 692
 693 void
 694 guestfs_set_log_message_callback (guestfs_h *g,
 695                                   guestfs_log_message_cb cb, void *opaque)
 696 {
 697   g->log_message_cb = cb;
 698   g->log_message_cb_data = opaque;
 699 }
 700
 701 void
 702 guestfs_set_subprocess_quit_callback (guestfs_h *g,
 703                                       guestfs_subprocess_quit_cb cb, void *opaque)
 704 {
 705   g->subprocess_quit_cb = cb;
 706   g->subprocess_quit_cb_data = opaque;
 707 }
 708
 709 void
 710 guestfs_set_launch_done_callback (guestfs_h *g,
 711                                   guestfs_launch_done_cb cb, void *opaque)
 712 {
 713   g->launch_done_cb = cb;
 714   g->launch_done_cb_data = opaque;
 715 }
 716
 717 void
 718 guestfs_set_close_callback (guestfs_h *g,
 719                             guestfs_close_cb cb, void *opaque)
 720 {
 721   g->close_cb = cb;
 722   g->close_cb_data = opaque;
 723 }
 724
 725 void
 726 guestfs_set_progress_callback (guestfs_h *g,
 727                                guestfs_progress_cb cb, void *opaque)
 728 {
 729   g->progress_cb = cb;
 730   g->progress_cb_data = opaque;
 731 }
 732
 733 /* Note the private data area is allocated lazily, since the vast
 734  * majority of callers will never use it.  This means g->pda is
 735  * likely to be NULL.
 736  */
 737 struct pda_entry {
 738   char *key;                    /* key */
 739   void *data;                   /* opaque user data pointer */
 740 };
 741
 742 static size_t
 743 hasher (void const *x, size_t table_size)
 744 {
 745   struct pda_entry const *p = x;
 746   return hash_pjw (p->key, table_size);
 747 }
 748
 749 static bool
 750 comparator (void const *x, void const *y)
 751 {
 752   struct pda_entry const *a = x;
 753   struct pda_entry const *b = y;
 754   return STREQ (a->key, b->key);
 755 }
 756
 757 static void
 758 freer (void *x)
 759 {
 760   if (x) {
 761     struct pda_entry *p = x;
 762     free (p->key);
 763     free (p);
 764   }
 765 }
 766
 767 void
 768 guestfs_set_private (guestfs_h *g, const char *key, void *data)
 769 {
 770   if (g->pda == NULL) {
 771     g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
 772     if (g->pda == NULL)
 773       g->abort_cb ();
 774   }
 775
 776   struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
 777   new_entry->key = safe_strdup (g, key);
 778   new_entry->data = data;
 779
 780   struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
 781   freer (old_entry);
 782
 783   struct pda_entry *entry = hash_insert (g->pda, new_entry);
 784   if (entry == NULL)
 785     g->abort_cb ();
 786   assert (entry == new_entry);
 787 }
 788
 789 static inline char *
 790 bad_cast (char const *s)
 791 {
 792   return (char *) s;
 793 }
 794
 795 void *
 796 guestfs_get_private (guestfs_h *g, const char *key)
 797 {
 798   if (g->pda == NULL)
 799     return NULL;                /* no keys have been set */
 800
 801   const struct pda_entry k = { .key = bad_cast (key) };
 802   struct pda_entry *entry = hash_lookup (g->pda, &k);
 803   if (entry)
 804     return entry->data;
 805   else
 806     return NULL;
 807 }
 808
 809 /* When tracing, be careful how we print BufferIn parameters which
 810  * usually contain large amounts of binary data (RHBZ#646822).
 811  */
 812 void
 813 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
 814 {
 815   size_t i;
 816   size_t orig_size = buf_size;
 817
 818   if (buf_size > 256)
 819     buf_size = 256;
 820
 821   fputc ('"', out);
 822
 823   for (i = 0; i < buf_size; ++i) {
 824     if (c_isprint (buf[i]))
 825       fputc (buf[i], out);
 826     else
 827       fprintf (out, "\\x%02x", (unsigned char) buf[i]);
 828   }
 829
 830   fputc ('"', out);
 831
 832   if (orig_size > buf_size)
 833     fprintf (out,
 834              _("<truncated, original size %zu bytes>"), orig_size);
 835 }
 836
 837 void
 838 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
 839 {
 840   guestfs___print_BufferIn (out, buf, buf_size);
 841 }
 842
 843 void
 844 guestfs___free_string_list (char **argv)
 845 {
 846   size_t i;
 847   for (i = 0; argv[i] != NULL; ++i)
 848     free (argv[i]);
 849   free (argv);
 850 }