todo: Add notes on inspecting ISO images.
[libguestfs.git] / 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 struct guestfs_h
88 {
89   struct guestfs_h *next;       /* Linked list of open handles. */
90
91   /* State: see the state machine diagram in the man page guestfs(3). */
92   enum state state;
93
94   int fd[2];                    /* Stdin/stdout of qemu. */
95   int sock;                     /* Daemon communications socket. */
96   pid_t pid;                    /* Qemu PID. */
97   pid_t recoverypid;            /* Recovery process PID. */
98
99   struct timeval launch_t;      /* The time that we called guestfs_launch. */
100
101   char *tmpdir;                 /* Temporary directory containing socket. */
102
103   char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
104
105   char **cmdline;               /* Qemu command line. */
106   int cmdline_size;
107
108   int verbose;
109   int trace;
110   int autosync;
111   int direct;
112   int recovery_proc;
113   int enable_network;
114
115   char *path;                   /* Path to kernel, initrd. */
116   char *qemu;                   /* Qemu binary. */
117   char *append;                 /* Append to kernel command line. */
118
119   int memsize;                  /* Size of RAM (megabytes). */
120
121   int selinux;                  /* selinux enabled? */
122
123   char *last_error;
124   int last_errnum;              /* errno, or 0 if there was no errno */
125
126   /* Callbacks. */
127   guestfs_abort_cb           abort_cb;
128   guestfs_error_handler_cb   error_cb;
129   void *                     error_cb_data;
130   guestfs_log_message_cb     log_message_cb;
131   void *                     log_message_cb_data;
132   guestfs_subprocess_quit_cb subprocess_quit_cb;
133   void *                     subprocess_quit_cb_data;
134   guestfs_launch_done_cb     launch_done_cb;
135   void *                     launch_done_cb_data;
136   guestfs_close_cb           close_cb;
137   void *                     close_cb_data;
138   guestfs_progress_cb        progress_cb;
139   void *                     progress_cb_data;
140
141   int msg_next_serial;
142
143   /* Information gathered by inspect_os.  Must be freed by calling
144    * guestfs___free_inspect_info.
145    */
146   struct inspect_fs *fses;
147   size_t nr_fses;
148
149   /* Private data area. */
150   struct hash_table *pda;
151 };
152
153 /* Per-filesystem data stored for inspect_os. */
154 enum inspect_fs_content {
155   FS_CONTENT_UNKNOWN = 0,
156   FS_CONTENT_LINUX_ROOT,
157   FS_CONTENT_WINDOWS_ROOT,
158   FS_CONTENT_LINUX_BOOT,
159   FS_CONTENT_LINUX_USR,
160   FS_CONTENT_LINUX_USR_LOCAL,
161   FS_CONTENT_LINUX_VAR,
162   FS_CONTENT_FREEBSD_ROOT,
163 };
164
165 enum inspect_os_type {
166   OS_TYPE_UNKNOWN = 0,
167   OS_TYPE_LINUX,
168   OS_TYPE_WINDOWS,
169   OS_TYPE_FREEBSD,
170 };
171
172 enum inspect_os_distro {
173   OS_DISTRO_UNKNOWN = 0,
174   OS_DISTRO_DEBIAN,
175   OS_DISTRO_FEDORA,
176   OS_DISTRO_REDHAT_BASED,
177   OS_DISTRO_RHEL,
178   OS_DISTRO_WINDOWS,
179   OS_DISTRO_PARDUS,
180   OS_DISTRO_ARCHLINUX,
181   OS_DISTRO_GENTOO,
182   OS_DISTRO_UBUNTU,
183   OS_DISTRO_MEEGO,
184   OS_DISTRO_LINUX_MINT,
185   OS_DISTRO_MANDRIVA,
186 };
187
188 enum inspect_os_package_format {
189   OS_PACKAGE_FORMAT_UNKNOWN = 0,
190   OS_PACKAGE_FORMAT_RPM,
191   OS_PACKAGE_FORMAT_DEB,
192   OS_PACKAGE_FORMAT_PACMAN,
193   OS_PACKAGE_FORMAT_EBUILD,
194   OS_PACKAGE_FORMAT_PISI
195 };
196
197 enum inspect_os_package_management {
198   OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
199   OS_PACKAGE_MANAGEMENT_YUM,
200   OS_PACKAGE_MANAGEMENT_UP2DATE,
201   OS_PACKAGE_MANAGEMENT_APT,
202   OS_PACKAGE_MANAGEMENT_PACMAN,
203   OS_PACKAGE_MANAGEMENT_PORTAGE,
204   OS_PACKAGE_MANAGEMENT_PISI,
205   OS_PACKAGE_MANAGEMENT_URPMI,
206 };
207
208 struct inspect_fs {
209   int is_root;
210   char *device;
211   int is_mountable;
212   int is_swap;
213   enum inspect_fs_content content;
214   enum inspect_os_type type;
215   enum inspect_os_distro distro;
216   enum inspect_os_package_format package_format;
217   enum inspect_os_package_management package_management;
218   char *product_name;
219   int major_version;
220   int minor_version;
221   char *arch;
222   char *hostname;
223   char *windows_systemroot;
224   struct inspect_fstab_entry *fstab;
225   size_t nr_fstab;
226 };
227
228 struct inspect_fstab_entry {
229   char *device;
230   char *mountpoint;
231 };
232
233 struct guestfs_message_header;
234 struct guestfs_message_error;
235
236 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
237   __attribute__((format (printf,2,3)));
238 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
239   __attribute__((format (printf,3,4)));
240 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
241   __attribute__((format (printf,2,3)));
242 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
243 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
244 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
245 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
246 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
247   __attribute__((format (printf,2,3)));
248 extern void guestfs___print_timestamped_argv (guestfs_h *g, const char *argv[]);
249 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
250 extern void guestfs___free_inspect_info (guestfs_h *g);
251 extern int guestfs___set_busy (guestfs_h *g);
252 extern int guestfs___end_busy (guestfs_h *g);
253 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
254 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);
255 extern int guestfs___send_file (guestfs_h *g, const char *filename);
256 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
257 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
258 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
259 extern int guestfs___accept_from_daemon (guestfs_h *g);
260 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
261 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
262 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
263 #ifdef HAVE_PCRE
264 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
265 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
266 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
267 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
268 #endif
269 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
270 extern void guestfs___free_string_list (char **);
271 extern int guestfs___checkpoint_cmdline (guestfs_h *g);
272 extern void guestfs___rollback_cmdline (guestfs_h *g, int pos);
273
274 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
275 #define perrorf guestfs_perrorf
276 #define safe_calloc guestfs_safe_calloc
277 #define safe_malloc guestfs_safe_malloc
278 #define safe_realloc guestfs_safe_realloc
279 #define safe_strdup guestfs_safe_strdup
280 #define safe_strndup guestfs_safe_strndup
281 #define safe_memdup guestfs_safe_memdup
282 #define safe_asprintf guestfs_safe_asprintf
283 #ifdef HAVE_PCRE
284 #define match guestfs___match
285 #define match1 guestfs___match1
286 #define match2 guestfs___match2
287 #define match3 guestfs___match3
288 #endif
289
290 #endif /* GUESTFS_INTERNAL_H_ */