src/guestfs-internal.h

   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 #ifndef GUESTFS_INTERNAL_H_
  20 #define GUESTFS_INTERNAL_H_
  21
  22 #include <rpc/types.h>
  23 #include <rpc/xdr.h>
  24
  25 #ifdef HAVE_PCRE
  26 #include <pcre.h>
  27 #endif
  28
  29 #define STREQ(a,b) (strcmp((a),(b)) == 0)
  30 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
  31 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
  32 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
  33 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
  34 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
  35 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
  36 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
  37 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
  38
  39 #ifdef HAVE_GETTEXT
  40 #include "gettext.h"
  41 #define _(str) dgettext(PACKAGE, (str))
  42 #define N_(str) dgettext(PACKAGE, (str))
  43 #else
  44 #define _(str) str
  45 #define N_(str) str
  46 #endif
  47
  48 #define TMP_TEMPLATE_ON_STACK(var)                        \
  49   const char *ttos_tmpdir = guestfs_tmpdir ();            \
  50   char var[strlen (ttos_tmpdir) + 32];                    \
  51   sprintf (var, "%s/libguestfsXXXXXX", ttos_tmpdir)       \
  52
  53 #define UNIX_PATH_MAX 108
  54
  55 #ifndef MAX
  56 #define MAX(a,b) ((a)>(b)?(a):(b))
  57 #endif
  58
  59 #ifdef __APPLE__
  60 #define xdr_uint32_t xdr_u_int32_t
  61 #endif
  62
  63 /* Network configuration of the appliance.  Note these addresses are
  64  * only meaningful within the context of the running appliance.  QEMU
  65  * translates network connections to these magic addresses into
  66  * userspace calls on the host (eg. connect(2)).  qemu-doc has a nice
  67  * diagram which is also useful to refer to.
  68  *
  69  * NETWORK: The network.
  70  *
  71  * ROUTER: The address of the "host", ie. this library.
  72  *
  73  * [Note: If you change NETWORK and ROUTER then you also have to
  74  * change the network configuration in appliance/init].
  75  *
  76  * GUESTFWD_ADDR, GUESTFWD_PORT: The guestfwd feature of qemu
  77  * magically connects this pseudo-address to the guestfwd channel.  In
  78  * typical Linux configurations of libguestfs, guestfwd is not
  79  * actually used any more.
  80  */
  81 #define NETWORK "169.254.0.0/16"
  82 #define ROUTER "169.254.2.2"
  83
  84 /* GuestFS handle and connection. */
  85 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
  86
  87 /* Attach method. */
  88 enum attach_method { ATTACH_METHOD_APPLIANCE = 0, ATTACH_METHOD_UNIX };
  89
  90 struct guestfs_h
  91 {
  92   struct guestfs_h *next;       /* Linked list of open handles. */
  93
  94   /* State: see the state machine diagram in the man page guestfs(3). */
  95   enum state state;
  96
  97   int fd[2];                    /* Stdin/stdout of qemu. */
  98   int sock;                     /* Daemon communications socket. */
  99   pid_t pid;                    /* Qemu PID. */
 100   pid_t recoverypid;            /* Recovery process PID. */
 101
 102   struct timeval launch_t;      /* The time that we called guestfs_launch. */
 103
 104   char *tmpdir;                 /* Temporary directory containing socket. */
 105
 106   char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
 107
 108   char **cmdline;               /* Qemu command line. */
 109   int cmdline_size;
 110
 111   int verbose;
 112   int trace;
 113   int autosync;
 114   int direct;
 115   int recovery_proc;
 116   int enable_network;
 117
 118   char *path;                   /* Path to kernel, initrd. */
 119   char *qemu;                   /* Qemu binary. */
 120   char *append;                 /* Append to kernel command line. */
 121
 122   enum attach_method attach_method;
 123   char *attach_method_arg;
 124
 125   int memsize;                  /* Size of RAM (megabytes). */
 126
 127   int selinux;                  /* selinux enabled? */
 128
 129   char *last_error;
 130   int last_errnum;              /* errno, or 0 if there was no errno */
 131
 132   /* Callbacks. */
 133   guestfs_abort_cb           abort_cb;
 134   guestfs_error_handler_cb   error_cb;
 135   void *                     error_cb_data;
 136   guestfs_log_message_cb     log_message_cb;
 137   void *                     log_message_cb_data;
 138   guestfs_subprocess_quit_cb subprocess_quit_cb;
 139   void *                     subprocess_quit_cb_data;
 140   guestfs_launch_done_cb     launch_done_cb;
 141   void *                     launch_done_cb_data;
 142   guestfs_close_cb           close_cb;
 143   void *                     close_cb_data;
 144   guestfs_progress_cb        progress_cb;
 145   void *                     progress_cb_data;
 146
 147   int msg_next_serial;
 148
 149   /* Information gathered by inspect_os.  Must be freed by calling
 150    * guestfs___free_inspect_info.
 151    */
 152   struct inspect_fs *fses;
 153   size_t nr_fses;
 154
 155   /* Private data area. */
 156   struct hash_table *pda;
 157   struct pda_entry *pda_next;
 158 };
 159
 160 /* Per-filesystem data stored for inspect_os. */
 161 enum inspect_fs_content {
 162   FS_CONTENT_UNKNOWN = 0,
 163   FS_CONTENT_LINUX_ROOT,
 164   FS_CONTENT_WINDOWS_ROOT,
 165   FS_CONTENT_LINUX_BOOT,
 166   FS_CONTENT_LINUX_USR,
 167   FS_CONTENT_LINUX_USR_LOCAL,
 168   FS_CONTENT_LINUX_VAR,
 169   FS_CONTENT_FREEBSD_ROOT,
 170   FS_CONTENT_INSTALLER,
 171 };
 172
 173 enum inspect_os_format {
 174   OS_FORMAT_UNKNOWN = 0,
 175   OS_FORMAT_INSTALLED,
 176   OS_FORMAT_INSTALLER,
 177   /* in future: supplemental disks */
 178 };
 179
 180 enum inspect_os_type {
 181   OS_TYPE_UNKNOWN = 0,
 182   OS_TYPE_LINUX,
 183   OS_TYPE_WINDOWS,
 184   OS_TYPE_FREEBSD,
 185 };
 186
 187 enum inspect_os_distro {
 188   OS_DISTRO_UNKNOWN = 0,
 189   OS_DISTRO_DEBIAN,
 190   OS_DISTRO_FEDORA,
 191   OS_DISTRO_REDHAT_BASED,
 192   OS_DISTRO_RHEL,
 193   OS_DISTRO_WINDOWS,
 194   OS_DISTRO_PARDUS,
 195   OS_DISTRO_ARCHLINUX,
 196   OS_DISTRO_GENTOO,
 197   OS_DISTRO_UBUNTU,
 198   OS_DISTRO_MEEGO,
 199   OS_DISTRO_LINUX_MINT,
 200   OS_DISTRO_MANDRIVA,
 201 };
 202
 203 enum inspect_os_package_format {
 204   OS_PACKAGE_FORMAT_UNKNOWN = 0,
 205   OS_PACKAGE_FORMAT_RPM,
 206   OS_PACKAGE_FORMAT_DEB,
 207   OS_PACKAGE_FORMAT_PACMAN,
 208   OS_PACKAGE_FORMAT_EBUILD,
 209   OS_PACKAGE_FORMAT_PISI
 210 };
 211
 212 enum inspect_os_package_management {
 213   OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
 214   OS_PACKAGE_MANAGEMENT_YUM,
 215   OS_PACKAGE_MANAGEMENT_UP2DATE,
 216   OS_PACKAGE_MANAGEMENT_APT,
 217   OS_PACKAGE_MANAGEMENT_PACMAN,
 218   OS_PACKAGE_MANAGEMENT_PORTAGE,
 219   OS_PACKAGE_MANAGEMENT_PISI,
 220   OS_PACKAGE_MANAGEMENT_URPMI,
 221 };
 222
 223 struct inspect_fs {
 224   int is_root;
 225   char *device;
 226   int is_mountable;
 227   int is_swap;
 228   enum inspect_fs_content content;
 229   enum inspect_os_type type;
 230   enum inspect_os_distro distro;
 231   enum inspect_os_package_format package_format;
 232   enum inspect_os_package_management package_management;
 233   char *product_name;
 234   int major_version;
 235   int minor_version;
 236   char *arch;
 237   char *hostname;
 238   char *windows_systemroot;
 239   enum inspect_os_format format;
 240   int is_live_disk;
 241   int is_netinst_disk;
 242   int is_multipart_disk;
 243   struct inspect_fstab_entry *fstab;
 244   size_t nr_fstab;
 245 };
 246
 247 struct inspect_fstab_entry {
 248   char *device;
 249   char *mountpoint;
 250 };
 251
 252 struct guestfs_message_header;
 253 struct guestfs_message_error;
 254
 255 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
 256   __attribute__((format (printf,2,3)));
 257 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
 258   __attribute__((format (printf,3,4)));
 259 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
 260   __attribute__((format (printf,2,3)));
 261 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
 262 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
 263 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
 264 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
 265 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
 266   __attribute__((format (printf,2,3)));
 267 extern const char *guestfs___persistent_tmpdir (void);
 268 extern void guestfs___print_timestamped_argv (guestfs_h *g, const char *argv[]);
 269 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
 270 extern void guestfs___free_inspect_info (guestfs_h *g);
 271 extern int guestfs___set_busy (guestfs_h *g);
 272 extern int guestfs___end_busy (guestfs_h *g);
 273 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
 274 extern int guestfs___recv (guestfs_h *g, const char *fn, struct guestfs_message_header *hdr, struct guestfs_message_error *err, xdrproc_t xdrp, char *ret);
 275 extern int guestfs___send_file (guestfs_h *g, const char *filename);
 276 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
 277 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
 278 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
 279 extern int guestfs___accept_from_daemon (guestfs_h *g);
 280 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
 281 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
 282 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
 283 #ifdef HAVE_PCRE
 284 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
 285 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
 286 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
 287 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
 288 #endif
 289 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
 290 extern void guestfs___free_string_list (char **);
 291 extern int guestfs___checkpoint_cmdline (guestfs_h *g);
 292 extern void guestfs___rollback_cmdline (guestfs_h *g, int pos);
 293
 294 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
 295 #define perrorf guestfs_perrorf
 296 #define safe_calloc guestfs_safe_calloc
 297 #define safe_malloc guestfs_safe_malloc
 298 #define safe_realloc guestfs_safe_realloc
 299 #define safe_strdup guestfs_safe_strdup
 300 #define safe_strndup guestfs_safe_strndup
 301 #define safe_memdup guestfs_safe_memdup
 302 #define safe_asprintf guestfs_safe_asprintf
 303 #ifdef HAVE_PCRE
 304 #define match guestfs___match
 305 #define match1 guestfs___match1
 306 #define match2 guestfs___match2
 307 #define match3 guestfs___match3
 308 #endif
 309
 310 #endif /* GUESTFS_INTERNAL_H_ */