fish: Fix test-guestfish-events.sh so it works when LIBGUESTFS_DEBUG=1 is set.
[libguestfs.git] / src / guestfs.c
1 /* libguestfs
2  * Copyright (C) 2009-2011 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 remove_tmpdir (guestfs_h *g);
76 static void close_handles (void);
77
78 gl_lock_define_initialized (static, handles_lock);
79 static guestfs_h *handles = NULL;
80 static int atexit_handler_set = 0;
81
82 guestfs_h *
83 guestfs_create (void)
84 {
85   guestfs_h *g;
86   const char *str;
87
88   g = malloc (sizeof (*g));
89   if (!g) return NULL;
90
91   memset (g, 0, sizeof (*g));
92
93   g->state = CONFIG;
94
95   g->fd[0] = -1;
96   g->fd[1] = -1;
97   g->sock = -1;
98
99   g->abort_cb = abort;
100   g->error_cb = default_error_cb;
101   g->error_cb_data = NULL;
102
103   g->recovery_proc = 1;
104   g->autosync = 1;
105
106   str = getenv ("LIBGUESTFS_DEBUG");
107   g->verbose = str != NULL && STREQ (str, "1");
108
109   str = getenv ("LIBGUESTFS_TRACE");
110   g->trace = str != NULL && STREQ (str, "1");
111
112   str = getenv ("LIBGUESTFS_PATH");
113   g->path = str != NULL ? strdup (str) : strdup (GUESTFS_DEFAULT_PATH);
114   if (!g->path) goto error;
115
116   str = getenv ("LIBGUESTFS_QEMU");
117   g->qemu = str != NULL ? strdup (str) : strdup (QEMU);
118   if (!g->qemu) goto error;
119
120   str = getenv ("LIBGUESTFS_APPEND");
121   if (str) {
122     g->append = strdup (str);
123     if (!g->append) goto error;
124   }
125
126   /* Choose a suitable memory size.  Previously we tried to choose
127    * a minimal memory size, but this isn't really necessary since
128    * recent QEMU and KVM don't do anything nasty like locking
129    * memory into core any more.  Thus we can safely choose a
130    * large, generous amount of memory, and it'll just get swapped
131    * on smaller systems.
132    */
133   str = getenv ("LIBGUESTFS_MEMSIZE");
134   if (str) {
135     if (sscanf (str, "%d", &g->memsize) != 1 || g->memsize <= 256) {
136       warning (g, "non-numeric or too small value for LIBGUESTFS_MEMSIZE");
137       goto error;
138     }
139   } else
140     g->memsize = 500;
141
142   /* Start with large serial numbers so they are easy to spot
143    * inside the protocol.
144    */
145   g->msg_next_serial = 0x00123400;
146
147   /* Default is uniprocessor appliance. */
148   g->smp = 1;
149
150   /* Link the handles onto a global list. */
151   gl_lock_lock (handles_lock);
152   g->next = handles;
153   handles = g;
154   if (!atexit_handler_set) {
155     atexit (close_handles);
156     atexit_handler_set = 1;
157   }
158   gl_lock_unlock (handles_lock);
159
160   debug (g, "new guestfs handle %p", g);
161
162   return g;
163
164  error:
165   free (g->path);
166   free (g->qemu);
167   free (g->append);
168   free (g);
169   return NULL;
170 }
171
172 void
173 guestfs_close (guestfs_h *g)
174 {
175   if (g->state == NO_HANDLE) {
176     /* Not safe to call ANY callbacks here, so ... */
177     fprintf (stderr, _("guestfs_close: called twice on the same handle\n"));
178     return;
179   }
180
181   if (g->trace) {
182     const char trace_msg[] = "close";
183
184     guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE,
185                                       trace_msg, strlen (trace_msg));
186   }
187
188   debug (g, "closing guestfs handle %p (state %d)", g, g->state);
189
190   /* Try to sync if autosync flag is set. */
191   if (g->autosync && g->state == READY)
192     guestfs_internal_autosync (g);
193
194   /* Kill the qemu subprocess. */
195   if (g->state != CONFIG)
196     guestfs_kill_subprocess (g);
197
198   /* Run user close callbacks. */
199   guestfs___call_callbacks_void (g, GUESTFS_EVENT_CLOSE);
200
201   /* Remove all other registered callbacks.  Since we've already
202    * called the close callbacks, we shouldn't call any others.
203    */
204   free (g->events);
205   g->nr_events = 0;
206   g->events = NULL;
207
208   guestfs___free_inspect_info (g);
209   guestfs___free_drives (&g->drives);
210
211   /* Close sockets. */
212   if (g->fd[0] >= 0)
213     close (g->fd[0]);
214   if (g->fd[1] >= 0)
215     close (g->fd[1]);
216   if (g->sock >= 0)
217     close (g->sock);
218   g->fd[0] = -1;
219   g->fd[1] = -1;
220   g->sock = -1;
221
222   /* Wait for subprocess(es) to exit. */
223   if (g->pid > 0) waitpid (g->pid, NULL, 0);
224   if (g->recoverypid > 0) waitpid (g->recoverypid, NULL, 0);
225
226   /* Remove whole temporary directory. */
227   remove_tmpdir (g);
228
229   if (g->cmdline) {
230     size_t i;
231
232     for (i = 0; i < g->cmdline_size; ++i)
233       free (g->cmdline[i]);
234     free (g->cmdline);
235   }
236
237   /* Mark the handle as dead before freeing it. */
238   g->state = NO_HANDLE;
239
240   gl_lock_lock (handles_lock);
241   if (handles == g)
242     handles = g->next;
243   else {
244     guestfs_h *gg;
245
246     for (gg = handles; gg->next != g; gg = gg->next)
247       ;
248     gg->next = g->next;
249   }
250   gl_lock_unlock (handles_lock);
251
252   if (g->pda)
253     hash_free (g->pda);
254   free (g->last_error);
255   free (g->path);
256   free (g->qemu);
257   free (g->append);
258   free (g->qemu_help);
259   free (g->qemu_version);
260   free (g);
261 }
262
263 /* g->tmpdir can contain any files (but not subdirectories).  Remove
264  * those and the directory itself.  Note that errors in this function
265  * aren't really that important: if we end up not deleting temporary
266  * files it's only annoying.
267  */
268 static void
269 remove_tmpdir (guestfs_h *g)
270 {
271   DIR *dir;
272   struct dirent *d;
273
274   if (!g->tmpdir)
275     return;
276
277   dir = opendir (g->tmpdir);
278   if (dir == NULL) {
279     perror (g->tmpdir);
280     return;
281   }
282
283   while ((d = readdir (dir)) != NULL) {
284     if (STRNEQ (d->d_name, ".") && STRNEQ (d->d_name, "..")) {
285       if (unlinkat (dirfd (dir), d->d_name, 0) == -1)
286         perror (d->d_name);
287     }
288   }
289
290   if (closedir (dir) == -1)
291     perror (g->tmpdir);
292
293   if (rmdir (g->tmpdir) == -1)
294     perror (g->tmpdir);
295
296   free (g->tmpdir);
297   g->tmpdir = NULL;
298 }
299
300 /* Close all open handles (called from atexit(3)). */
301 static void
302 close_handles (void)
303 {
304   while (handles) guestfs_close (handles);
305 }
306
307 const char *
308 guestfs_last_error (guestfs_h *g)
309 {
310   return g->last_error;
311 }
312
313 int
314 guestfs_last_errno (guestfs_h *g)
315 {
316   return g->last_errnum;
317 }
318
319 static void
320 set_last_error (guestfs_h *g, int errnum, const char *msg)
321 {
322   free (g->last_error);
323   g->last_error = strdup (msg);
324   g->last_errnum = errnum;
325 }
326
327 /* Warning are printed unconditionally.  We try to make these rare.
328  * Generally speaking, a warning should either be an error, or if it's
329  * not important for end users then it should be a debug message.
330  */
331 void
332 guestfs___warning (guestfs_h *g, const char *fs, ...)
333 {
334   va_list args;
335   char *msg, *msg2;
336   int len;
337
338   va_start (args, fs);
339   len = vasprintf (&msg, fs, args);
340   va_end (args);
341
342   if (len < 0) return;
343
344   len = asprintf (&msg2, _("warning: %s"), msg);
345   free (msg);
346
347   if (len < 0) return;
348
349   guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg2, len);
350
351   free (msg2);
352 }
353
354 /* Debug messages. */
355 void
356 guestfs___debug (guestfs_h *g, const char *fs, ...)
357 {
358   va_list args;
359   char *msg;
360   int len;
361
362   /* The cpp macro "debug" has already checked that g->verbose is true
363    * before calling this function, but we check it again just in case
364    * anyone calls this function directly.
365    */
366   if (!g->verbose)
367     return;
368
369   va_start (args, fs);
370   len = vasprintf (&msg, fs, args);
371   va_end (args);
372
373   if (len < 0) return;
374
375   guestfs___call_callbacks_message (g, GUESTFS_EVENT_LIBRARY, msg, len);
376
377   free (msg);
378 }
379
380 /* Call trace messages.  These are enabled by setting g->trace, and
381  * calls to this function should only happen from the generated code
382  * in src/actions.c
383  */
384 void
385 guestfs___trace (guestfs_h *g, const char *fs, ...)
386 {
387   va_list args;
388   char *msg;
389   int len;
390
391   va_start (args, fs);
392   len = vasprintf (&msg, fs, args);
393   va_end (args);
394
395   if (len < 0) return;
396
397   guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, msg, len);
398
399   free (msg);
400 }
401
402 static void
403 default_error_cb (guestfs_h *g, void *data, const char *msg)
404 {
405   fprintf (stderr, _("libguestfs: error: %s\n"), msg);
406 }
407
408 void
409 guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
410 {
411   va_list args;
412   char *msg;
413
414   va_start (args, fs);
415   int err = vasprintf (&msg, fs, args);
416   va_end (args);
417
418   if (err < 0) return;
419
420   /* set_last_error first so that the callback can access the error
421    * message and errno through the handle if it wishes.
422    */
423   set_last_error (g, errnum, msg);
424   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
425
426   free (msg);
427 }
428
429 void
430 guestfs_perrorf (guestfs_h *g, const char *fs, ...)
431 {
432   va_list args;
433   char *msg;
434   int errnum = errno;
435
436   va_start (args, fs);
437   int err = vasprintf (&msg, fs, args);
438   va_end (args);
439
440   if (err < 0) return;
441
442   char buf[256];
443   strerror_r (errnum, buf, sizeof buf);
444
445   msg = safe_realloc (g, msg, strlen (msg) + 2 + strlen (buf) + 1);
446   strcat (msg, ": ");
447   strcat (msg, buf);
448
449   /* set_last_error first so that the callback can access the error
450    * message and errno through the handle if it wishes.
451    */
452   set_last_error (g, errnum, msg);
453   if (g->error_cb) g->error_cb (g, g->error_cb_data, msg);
454
455   free (msg);
456 }
457
458 void *
459 guestfs_safe_malloc (guestfs_h *g, size_t nbytes)
460 {
461   void *ptr = malloc (nbytes);
462   if (nbytes > 0 && !ptr) g->abort_cb ();
463   return ptr;
464 }
465
466 /* Return 1 if an array of N objects, each of size S, cannot exist due
467    to size arithmetic overflow.  S must be positive and N must be
468    nonnegative.  This is a macro, not an inline function, so that it
469    works correctly even when SIZE_MAX < N.
470
471    By gnulib convention, SIZE_MAX represents overflow in size
472    calculations, so the conservative dividend to use here is
473    SIZE_MAX - 1, since SIZE_MAX might represent an overflowed value.
474    However, malloc (SIZE_MAX) fails on all known hosts where
475    sizeof (ptrdiff_t) <= sizeof (size_t), so do not bother to test for
476    exactly-SIZE_MAX allocations on such hosts; this avoids a test and
477    branch when S is known to be 1.  */
478 # define xalloc_oversized(n, s) \
479     ((size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) < (n))
480
481 /* Technically we should add an autoconf test for this, testing for the desired
482    functionality, like what's done in gnulib, but for now, this is fine.  */
483 #if defined(__GLIBC__)
484 #define HAVE_GNU_CALLOC (__GLIBC__ >= 2)
485 #else
486 #define HAVE_GNU_CALLOC 0
487 #endif
488
489 /* Allocate zeroed memory for N elements of S bytes, with error
490    checking.  S must be nonzero.  */
491 void *
492 guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s)
493 {
494   /* From gnulib's calloc function in xmalloc.c.  */
495   void *p;
496   /* Test for overflow, since some calloc implementations don't have
497      proper overflow checks.  But omit overflow and size-zero tests if
498      HAVE_GNU_CALLOC, since GNU calloc catches overflow and never
499      returns NULL if successful.  */
500   if ((! HAVE_GNU_CALLOC && xalloc_oversized (n, s))
501       || (! (p = calloc (n, s)) && (HAVE_GNU_CALLOC || n != 0)))
502     g->abort_cb ();
503   return p;
504 }
505
506 void *
507 guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes)
508 {
509   void *p = realloc (ptr, nbytes);
510   if (nbytes > 0 && !p) g->abort_cb ();
511   return p;
512 }
513
514 char *
515 guestfs_safe_strdup (guestfs_h *g, const char *str)
516 {
517   char *s = strdup (str);
518   if (!s) g->abort_cb ();
519   return s;
520 }
521
522 char *
523 guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n)
524 {
525   char *s = strndup (str, n);
526   if (!s) g->abort_cb ();
527   return s;
528 }
529
530 void *
531 guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size)
532 {
533   void *p = malloc (size);
534   if (!p) g->abort_cb ();
535   memcpy (p, ptr, size);
536   return p;
537 }
538
539 char *
540 guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
541 {
542   va_list args;
543   char *msg;
544
545   va_start (args, fs);
546   int err = vasprintf (&msg, fs, args);
547   va_end (args);
548
549   if (err == -1)
550     g->abort_cb ();
551
552   return msg;
553 }
554
555 void
556 guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb cb)
557 {
558   g->abort_cb = cb;
559 }
560
561 guestfs_abort_cb
562 guestfs_get_out_of_memory_handler (guestfs_h *g)
563 {
564   return g->abort_cb;
565 }
566
567 void
568 guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data)
569 {
570   g->error_cb = cb;
571   g->error_cb_data = data;
572 }
573
574 guestfs_error_handler_cb
575 guestfs_get_error_handler (guestfs_h *g, void **data_rtn)
576 {
577   if (data_rtn) *data_rtn = g->error_cb_data;
578   return g->error_cb;
579 }
580
581 void
582 guestfs_user_cancel (guestfs_h *g)
583 {
584   g->user_cancel = 1;
585 }
586
587 int
588 guestfs__set_verbose (guestfs_h *g, int v)
589 {
590   g->verbose = !!v;
591   return 0;
592 }
593
594 int
595 guestfs__get_verbose (guestfs_h *g)
596 {
597   return g->verbose;
598 }
599
600 int
601 guestfs__set_autosync (guestfs_h *g, int a)
602 {
603   g->autosync = !!a;
604   return 0;
605 }
606
607 int
608 guestfs__get_autosync (guestfs_h *g)
609 {
610   return g->autosync;
611 }
612
613 int
614 guestfs__set_path (guestfs_h *g, const char *path)
615 {
616   free (g->path);
617   g->path = NULL;
618
619   g->path =
620     path == NULL ?
621     safe_strdup (g, GUESTFS_DEFAULT_PATH) : safe_strdup (g, path);
622   return 0;
623 }
624
625 const char *
626 guestfs__get_path (guestfs_h *g)
627 {
628   return g->path;
629 }
630
631 int
632 guestfs__set_qemu (guestfs_h *g, const char *qemu)
633 {
634   free (g->qemu);
635   g->qemu = NULL;
636
637   g->qemu = qemu == NULL ? safe_strdup (g, QEMU) : safe_strdup (g, qemu);
638   return 0;
639 }
640
641 const char *
642 guestfs__get_qemu (guestfs_h *g)
643 {
644   return g->qemu;
645 }
646
647 int
648 guestfs__set_append (guestfs_h *g, const char *append)
649 {
650   free (g->append);
651   g->append = NULL;
652
653   g->append = append ? safe_strdup (g, append) : NULL;
654   return 0;
655 }
656
657 const char *
658 guestfs__get_append (guestfs_h *g)
659 {
660   return g->append;
661 }
662
663 int
664 guestfs__set_memsize (guestfs_h *g, int memsize)
665 {
666   g->memsize = memsize;
667   return 0;
668 }
669
670 int
671 guestfs__get_memsize (guestfs_h *g)
672 {
673   return g->memsize;
674 }
675
676 int
677 guestfs__set_selinux (guestfs_h *g, int selinux)
678 {
679   g->selinux = selinux;
680   return 0;
681 }
682
683 int
684 guestfs__get_selinux (guestfs_h *g)
685 {
686   return g->selinux;
687 }
688
689 int
690 guestfs__get_pid (guestfs_h *g)
691 {
692   if (g->pid > 0)
693     return g->pid;
694   else {
695     error (g, "get_pid: no qemu subprocess");
696     return -1;
697   }
698 }
699
700 struct guestfs_version *
701 guestfs__version (guestfs_h *g)
702 {
703   struct guestfs_version *r;
704
705   r = safe_malloc (g, sizeof *r);
706   r->major = PACKAGE_VERSION_MAJOR;
707   r->minor = PACKAGE_VERSION_MINOR;
708   r->release = PACKAGE_VERSION_RELEASE;
709   r->extra = safe_strdup (g, PACKAGE_VERSION_EXTRA);
710   return r;
711 }
712
713 int
714 guestfs__set_trace (guestfs_h *g, int t)
715 {
716   g->trace = !!t;
717   return 0;
718 }
719
720 int
721 guestfs__get_trace (guestfs_h *g)
722 {
723   return g->trace;
724 }
725
726 int
727 guestfs__set_direct (guestfs_h *g, int d)
728 {
729   g->direct = !!d;
730   return 0;
731 }
732
733 int
734 guestfs__get_direct (guestfs_h *g)
735 {
736   return g->direct;
737 }
738
739 int
740 guestfs__set_recovery_proc (guestfs_h *g, int f)
741 {
742   g->recovery_proc = !!f;
743   return 0;
744 }
745
746 int
747 guestfs__get_recovery_proc (guestfs_h *g)
748 {
749   return g->recovery_proc;
750 }
751
752 int
753 guestfs__set_network (guestfs_h *g, int v)
754 {
755   g->enable_network = !!v;
756   return 0;
757 }
758
759 int
760 guestfs__get_network (guestfs_h *g)
761 {
762   return g->enable_network;
763 }
764
765 int
766 guestfs__set_attach_method (guestfs_h *g, const char *method)
767 {
768   if (STREQ (method, "appliance")) {
769     g->attach_method = ATTACH_METHOD_APPLIANCE;
770     free (g->attach_method_arg);
771     g->attach_method_arg = NULL;
772   }
773   else if (STRPREFIX (method, "unix:") && strlen (method) > 5) {
774     g->attach_method = ATTACH_METHOD_UNIX;
775     free (g->attach_method_arg);
776     g->attach_method_arg = safe_strdup (g, method + 5);
777     /* Note that we don't check the path exists until launch is called. */
778   }
779   else {
780     error (g, "invalid attach method: %s", method);
781     return -1;
782   }
783
784   return 0;
785 }
786
787 char *
788 guestfs__get_attach_method (guestfs_h *g)
789 {
790   char *ret;
791
792   switch (g->attach_method) {
793   case ATTACH_METHOD_APPLIANCE:
794     ret = safe_strdup (g, "appliance");
795     break;
796
797   case ATTACH_METHOD_UNIX:
798     ret = safe_malloc (g, strlen (g->attach_method_arg) + 5 + 1);
799     strcpy (ret, "unix:");
800     strcat (ret, g->attach_method_arg);
801     break;
802
803   default: /* keep GCC happy - this is not reached */
804     abort ();
805   }
806
807   return ret;
808 }
809
810 int
811 guestfs__set_pgroup (guestfs_h *g, int v)
812 {
813   g->pgroup = !!v;
814   return 0;
815 }
816
817 int
818 guestfs__get_pgroup (guestfs_h *g)
819 {
820   return g->pgroup;
821 }
822
823 int
824 guestfs__set_smp (guestfs_h *g, int v)
825 {
826   if (v >= 1) {
827     g->smp = v;
828     return 0;
829   } else {
830     error (g, "invalid smp parameter: %d", v);
831     return -1;
832   }
833 }
834
835 int
836 guestfs__get_smp (guestfs_h *g)
837 {
838   return g->smp;
839 }
840
841 /* Note the private data area is allocated lazily, since the vast
842  * majority of callers will never use it.  This means g->pda is
843  * likely to be NULL.
844  */
845 struct pda_entry {
846   char *key;                    /* key */
847   void *data;                   /* opaque user data pointer */
848 };
849
850 static size_t
851 hasher (void const *x, size_t table_size)
852 {
853   struct pda_entry const *p = x;
854   return hash_pjw (p->key, table_size);
855 }
856
857 static bool
858 comparator (void const *x, void const *y)
859 {
860   struct pda_entry const *a = x;
861   struct pda_entry const *b = y;
862   return STREQ (a->key, b->key);
863 }
864
865 static void
866 freer (void *x)
867 {
868   if (x) {
869     struct pda_entry *p = x;
870     free (p->key);
871     free (p);
872   }
873 }
874
875 void
876 guestfs_set_private (guestfs_h *g, const char *key, void *data)
877 {
878   if (g->pda == NULL) {
879     g->pda = hash_initialize (16, NULL, hasher, comparator, freer);
880     if (g->pda == NULL)
881       g->abort_cb ();
882   }
883
884   struct pda_entry *new_entry = safe_malloc (g, sizeof *new_entry);
885   new_entry->key = safe_strdup (g, key);
886   new_entry->data = data;
887
888   struct pda_entry *old_entry = hash_delete (g->pda, new_entry);
889   freer (old_entry);
890
891   struct pda_entry *entry = hash_insert (g->pda, new_entry);
892   if (entry == NULL)
893     g->abort_cb ();
894   assert (entry == new_entry);
895 }
896
897 static inline char *
898 bad_cast (char const *s)
899 {
900   return (char *) s;
901 }
902
903 void *
904 guestfs_get_private (guestfs_h *g, const char *key)
905 {
906   if (g->pda == NULL)
907     return NULL;                /* no keys have been set */
908
909   const struct pda_entry k = { .key = bad_cast (key) };
910   struct pda_entry *entry = hash_lookup (g->pda, &k);
911   if (entry)
912     return entry->data;
913   else
914     return NULL;
915 }
916
917 /* Iterator. */
918 void *
919 guestfs_first_private (guestfs_h *g, const char **key_rtn)
920 {
921   if (g->pda == NULL)
922     return NULL;
923
924   g->pda_next = hash_get_first (g->pda);
925
926   /* Ignore any keys with NULL data pointers. */
927   while (g->pda_next && g->pda_next->data == NULL)
928     g->pda_next = hash_get_next (g->pda, g->pda_next);
929
930   if (g->pda_next == NULL)
931     return NULL;
932
933   *key_rtn = g->pda_next->key;
934   return g->pda_next->data;
935 }
936
937 void *
938 guestfs_next_private (guestfs_h *g, const char **key_rtn)
939 {
940   if (g->pda == NULL)
941     return NULL;
942
943   if (g->pda_next == NULL)
944     return NULL;
945
946   /* Walk to the next key with a non-NULL data pointer. */
947   do {
948     g->pda_next = hash_get_next (g->pda, g->pda_next);
949   } while (g->pda_next && g->pda_next->data == NULL);
950
951   if (g->pda_next == NULL)
952     return NULL;
953
954   *key_rtn = g->pda_next->key;
955   return g->pda_next->data;
956 }
957
958 /* When tracing, be careful how we print BufferIn parameters which
959  * usually contain large amounts of binary data (RHBZ#646822).
960  */
961 void
962 guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size)
963 {
964   size_t i;
965   size_t orig_size = buf_size;
966
967   if (buf_size > 256)
968     buf_size = 256;
969
970   fputc ('"', out);
971
972   for (i = 0; i < buf_size; ++i) {
973     if (c_isprint (buf[i]))
974       fputc (buf[i], out);
975     else
976       fprintf (out, "\\x%02x", (unsigned char) buf[i]);
977   }
978
979   fputc ('"', out);
980
981   if (orig_size > buf_size)
982     fprintf (out,
983              _("<truncated, original size %zu bytes>"), orig_size);
984 }
985
986 void
987 guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size)
988 {
989   guestfs___print_BufferIn (out, buf, buf_size);
990 }
991
992 void
993 guestfs___free_string_list (char **argv)
994 {
995   size_t i;
996   for (i = 0; argv[i] != NULL; ++i)
997     free (argv[i]);
998   free (argv);
999 }
1000
1001 void
1002 guestfs___free_drives (struct drive **drives)
1003 {
1004   struct drive *i = *drives;
1005   *drives = NULL;
1006
1007   while (i != NULL) {
1008     struct drive *next = i->next;
1009
1010     free (i->path);
1011     free (i->format);
1012     free (i->iface);
1013     free (i->name);
1014     free (i);
1015
1016     i = next;
1017   }
1018 }