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 #define STREQ(a,b) (strcmp((a),(b)) == 0)
  23 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
  24 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
  25 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
  26 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
  27 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
  28 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
  29 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
  30 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
  31
  32 #ifdef HAVE_GETTEXT
  33 #include "gettext.h"
  34 #define _(str) dgettext(PACKAGE, (str))
  35 #define N_(str) dgettext(PACKAGE, (str))
  36 #else
  37 #define _(str) str
  38 #define N_(str) str
  39 #endif
  40
  41 #ifdef __linux__
  42 #define CAN_CHECK_PEER_EUID 1
  43 #else
  44 #define CAN_CHECK_PEER_EUID 0
  45 #endif
  46
  47 #define UNIX_PATH_MAX 108
  48
  49 #ifndef MAX
  50 #define MAX(a,b) ((a)>(b)?(a):(b))
  51 #endif
  52
  53 #ifdef __APPLE__
  54 #define xdr_uint32_t xdr_u_int32_t
  55 #endif
  56
  57 /* Network configuration of the appliance.  Note these addresses are
  58  * only meaningful within the context of the running appliance.  QEMU
  59  * translates network connections to these magic addresses into
  60  * userspace calls on the host (eg. connect(2)).  qemu-doc has a nice
  61  * diagram which is also useful to refer to.
  62  *
  63  * NETWORK: The network.
  64  *
  65  * ROUTER: The address of the "host", ie. this library.
  66  *
  67  * [Note: If you change NETWORK and ROUTER then you also have to
  68  * change the network configuration in appliance/init].
  69  *
  70  * GUESTFWD_ADDR, GUESTFWD_PORT: The guestfwd feature of qemu
  71  * magically connects this pseudo-address to the guestfwd channel.  In
  72  * typical Linux configurations of libguestfs, guestfwd is not
  73  * actually used any more.
  74  */
  75 #define NETWORK "169.254.0.0/16"
  76 #define ROUTER "169.254.2.2"
  77 #define GUESTFWD_ADDR "169.254.2.4"
  78 #define GUESTFWD_PORT "6666"
  79
  80 /* GuestFS handle and connection. */
  81 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
  82
  83 struct guestfs_h
  84 {
  85   struct guestfs_h *next;       /* Linked list of open handles. */
  86
  87   /* State: see the state machine diagram in the man page guestfs(3). */
  88   enum state state;
  89
  90   int fd[2];                    /* Stdin/stdout of qemu. */
  91   int sock;                     /* Daemon communications socket. */
  92   pid_t pid;                    /* Qemu PID. */
  93   pid_t recoverypid;            /* Recovery process PID. */
  94
  95   struct timeval launch_t;      /* The time that we called guestfs_launch. */
  96
  97   char *tmpdir;                 /* Temporary directory containing socket. */
  98
  99   char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
 100
 101   char **cmdline;               /* Qemu command line. */
 102   int cmdline_size;
 103
 104   int verbose;
 105   int trace;
 106   int autosync;
 107   int direct;
 108   int recovery_proc;
 109
 110   char *path;                   /* Path to kernel, initrd. */
 111   char *qemu;                   /* Qemu binary. */
 112   char *append;                 /* Append to kernel command line. */
 113
 114   int memsize;                  /* Size of RAM (megabytes). */
 115
 116   int selinux;                  /* selinux enabled? */
 117
 118   char *last_error;
 119
 120   /* Callbacks. */
 121   guestfs_abort_cb           abort_cb;
 122   guestfs_error_handler_cb   error_cb;
 123   void *                     error_cb_data;
 124   guestfs_log_message_cb     log_message_cb;
 125   void *                     log_message_cb_data;
 126   guestfs_subprocess_quit_cb subprocess_quit_cb;
 127   void *                     subprocess_quit_cb_data;
 128   guestfs_launch_done_cb     launch_done_cb;
 129   void *                     launch_done_cb_data;
 130   guestfs_close_cb           close_cb;
 131   void *                     close_cb_data;
 132
 133   int msg_next_serial;
 134
 135   /* Information gathered by inspect_os.  Must be freed by calling
 136    * guestfs___free_inspect_info.
 137    */
 138   struct inspect_fs *fses;
 139   size_t nr_fses;
 140 };
 141
 142 /* Per-filesystem data stored for inspect_os. */
 143 enum inspect_fs_content {
 144   FS_CONTENT_UNKNOWN = 0,
 145   FS_CONTENT_LINUX_ROOT,
 146   FS_CONTENT_WINDOWS_ROOT,
 147   FS_CONTENT_LINUX_BOOT,
 148   FS_CONTENT_LINUX_USR,
 149   FS_CONTENT_LINUX_USR_LOCAL,
 150   FS_CONTENT_LINUX_VAR,
 151 };
 152
 153 enum inspect_os_type {
 154   OS_TYPE_UNKNOWN = 0,
 155   OS_TYPE_LINUX,
 156   OS_TYPE_WINDOWS,
 157 };
 158
 159 enum inspect_os_distro {
 160   OS_DISTRO_UNKNOWN = 0,
 161   OS_DISTRO_DEBIAN,
 162   OS_DISTRO_FEDORA,
 163   OS_DISTRO_REDHAT_BASED,
 164   OS_DISTRO_RHEL,
 165   OS_DISTRO_WINDOWS,
 166 };
 167
 168 struct inspect_fs {
 169   int is_root;
 170   char *device;
 171   int is_mountable;
 172   int is_swap;
 173   enum inspect_fs_content content;
 174   enum inspect_os_type type;
 175   enum inspect_os_distro distro;
 176   char *product_name;
 177   int major_version;
 178   int minor_version;
 179   char *arch;
 180   struct inspect_fstab_entry *fstab;
 181   size_t nr_fstab;
 182 };
 183
 184 struct inspect_fstab_entry {
 185   char *device;
 186   char *mountpoint;
 187 };
 188
 189 struct guestfs_message_header;
 190 struct guestfs_message_error;
 191
 192 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
 193   __attribute__((format (printf,2,3)));
 194 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
 195   __attribute__((format (printf,2,3)));
 196 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
 197 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
 198 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
 199 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
 200 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
 201 extern const char *guestfs___tmpdir (void);
 202 extern void guestfs___free_inspect_info (guestfs_h *g);
 203 extern int guestfs___set_busy (guestfs_h *g);
 204 extern int guestfs___end_busy (guestfs_h *g);
 205 extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args);
 206 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);
 207 extern int guestfs___send_file (guestfs_h *g, const char *filename);
 208 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
 209 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
 210 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
 211 extern int guestfs___accept_from_daemon (guestfs_h *g);
 212
 213 #define error guestfs_error
 214 #define perrorf guestfs_perrorf
 215 #define safe_malloc guestfs_safe_malloc
 216 #define safe_realloc guestfs_safe_realloc
 217 #define safe_strdup guestfs_safe_strdup
 218 #define safe_strndup guestfs_safe_strndup
 219 #define safe_memdup guestfs_safe_memdup
 220
 221 #endif /* GUESTFS_INTERNAL_H_ */