2 * Copyright (C) 2009-2011 Red Hat Inc.
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.
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.
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
19 #ifndef GUESTFS_INTERNAL_H_
20 #define GUESTFS_INTERNAL_H_
22 #include <rpc/types.h>
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)
41 #define _(str) dgettext(PACKAGE, (str))
42 #define N_(str) dgettext(PACKAGE, (str))
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) \
53 #define UNIX_PATH_MAX 108
56 #define MAX(a,b) ((a)>(b)?(a):(b))
60 #define xdr_uint32_t xdr_u_int32_t
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.
69 * NETWORK: The network.
71 * ROUTER: The address of the "host", ie. this library.
73 * [Note: If you change NETWORK and ROUTER then you also have to
74 * change the network configuration in appliance/init].
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.
81 #define NETWORK "169.254.0.0/16"
82 #define ROUTER "169.254.2.2"
84 /* GuestFS handle and connection. */
85 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
88 enum attach_method { ATTACH_METHOD_APPLIANCE = 0, ATTACH_METHOD_UNIX };
92 uint64_t event_bitmask;
93 guestfs_event_callback cb;
96 /* opaque2 is not exposed through the API, but is used internally to
97 * emulate the old-style callback API.
104 struct guestfs_h *next; /* Linked list of open handles. */
106 /* State: see the state machine diagram in the man page guestfs(3). */
109 int fd[2]; /* Stdin/stdout of qemu. */
110 int sock; /* Daemon communications socket. */
111 pid_t pid; /* Qemu PID. */
112 pid_t recoverypid; /* Recovery process PID. */
114 struct timeval launch_t; /* The time that we called guestfs_launch. */
116 char *tmpdir; /* Temporary directory containing socket. */
118 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
120 char **cmdline; /* Qemu command line. */
130 char *path; /* Path to kernel, initrd. */
131 char *qemu; /* Qemu binary. */
132 char *append; /* Append to kernel command line. */
134 enum attach_method attach_method;
135 char *attach_method_arg;
137 int memsize; /* Size of RAM (megabytes). */
139 int selinux; /* selinux enabled? */
142 int last_errnum; /* errno, or 0 if there was no errno */
145 guestfs_abort_cb abort_cb;
146 guestfs_error_handler_cb error_cb;
147 void * error_cb_data;
150 struct event *events;
155 /* Information gathered by inspect_os. Must be freed by calling
156 * guestfs___free_inspect_info.
158 struct inspect_fs *fses;
161 /* Private data area. */
162 struct hash_table *pda;
163 struct pda_entry *pda_next;
165 /* Used by src/actions.c:trace_* functions. */
171 /* Per-filesystem data stored for inspect_os. */
172 enum inspect_fs_content {
173 FS_CONTENT_UNKNOWN = 0,
174 FS_CONTENT_LINUX_ROOT,
175 FS_CONTENT_WINDOWS_ROOT,
176 FS_CONTENT_WINDOWS_VOLUME_WITH_APPS,
177 FS_CONTENT_WINDOWS_VOLUME,
178 FS_CONTENT_LINUX_BOOT,
179 FS_CONTENT_LINUX_USR,
180 FS_CONTENT_LINUX_USR_LOCAL,
181 FS_CONTENT_LINUX_VAR,
182 FS_CONTENT_FREEBSD_ROOT,
183 FS_CONTENT_INSTALLER,
186 enum inspect_os_format {
187 OS_FORMAT_UNKNOWN = 0,
190 /* in future: supplemental disks */
193 enum inspect_os_type {
200 enum inspect_os_distro {
201 OS_DISTRO_UNKNOWN = 0,
204 OS_DISTRO_REDHAT_BASED,
212 OS_DISTRO_LINUX_MINT,
217 enum inspect_os_package_format {
218 OS_PACKAGE_FORMAT_UNKNOWN = 0,
219 OS_PACKAGE_FORMAT_RPM,
220 OS_PACKAGE_FORMAT_DEB,
221 OS_PACKAGE_FORMAT_PACMAN,
222 OS_PACKAGE_FORMAT_EBUILD,
223 OS_PACKAGE_FORMAT_PISI
226 enum inspect_os_package_management {
227 OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
228 OS_PACKAGE_MANAGEMENT_YUM,
229 OS_PACKAGE_MANAGEMENT_UP2DATE,
230 OS_PACKAGE_MANAGEMENT_APT,
231 OS_PACKAGE_MANAGEMENT_PACMAN,
232 OS_PACKAGE_MANAGEMENT_PORTAGE,
233 OS_PACKAGE_MANAGEMENT_PISI,
234 OS_PACKAGE_MANAGEMENT_URPMI,
242 enum inspect_fs_content content;
243 enum inspect_os_type type;
244 enum inspect_os_distro distro;
245 enum inspect_os_package_format package_format;
246 enum inspect_os_package_management package_management;
248 char *product_variant;
253 char *windows_systemroot;
254 enum inspect_os_format format;
257 int is_multipart_disk;
258 struct inspect_fstab_entry *fstab;
262 struct inspect_fstab_entry {
267 struct guestfs_message_header;
268 struct guestfs_message_error;
269 struct guestfs_progress;
271 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
272 __attribute__((format (printf,2,3)));
273 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
274 __attribute__((format (printf,3,4)));
275 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
276 __attribute__((format (printf,2,3)));
277 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
278 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
279 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
280 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
281 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
282 __attribute__((format (printf,2,3)));
283 extern void guestfs___warning (guestfs_h *g, const char *fs, ...)
284 __attribute__((format (printf,2,3)));
285 extern void guestfs___debug (guestfs_h *g, const char *fs, ...)
286 __attribute__((format (printf,2,3)));
287 extern void guestfs___trace (guestfs_h *g, const char *fs, ...)
288 __attribute__((format (printf,2,3)));
289 extern const char *guestfs___persistent_tmpdir (void);
290 extern void guestfs___print_timestamped_argv (guestfs_h *g, const char *argv[]);
291 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
292 extern void guestfs___free_inspect_info (guestfs_h *g);
293 extern int guestfs___set_busy (guestfs_h *g);
294 extern int guestfs___end_busy (guestfs_h *g);
295 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
296 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);
297 extern int guestfs___recv_discard (guestfs_h *g, const char *fn);
298 extern int guestfs___send_file (guestfs_h *g, const char *filename);
299 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
300 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
301 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
302 extern int guestfs___accept_from_daemon (guestfs_h *g);
303 extern void guestfs___progress_message_callback (guestfs_h *g, const struct guestfs_progress *message);
304 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
305 extern void guestfs___launch_send_progress (guestfs_h *g, int perdozen);
306 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
307 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
309 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
310 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
311 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
312 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
314 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
315 extern void guestfs___free_string_list (char **);
316 extern int guestfs___checkpoint_cmdline (guestfs_h *g);
317 extern void guestfs___rollback_cmdline (guestfs_h *g, int pos);
318 extern void guestfs___call_callbacks_void (guestfs_h *g, uint64_t event);
319 extern void guestfs___call_callbacks_message (guestfs_h *g, uint64_t event, const char *buf, size_t buf_len);
320 extern void guestfs___call_callbacks_array (guestfs_h *g, uint64_t event, const uint64_t *array, size_t array_len);
322 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
323 #define perrorf guestfs_perrorf
324 #define warning(g,...) guestfs___warning((g),__VA_ARGS__)
325 #define debug(g,...) \
326 do { if ((g)->verbose) guestfs___debug ((g),__VA_ARGS__); } while (0)
327 #define safe_calloc guestfs_safe_calloc
328 #define safe_malloc guestfs_safe_malloc
329 #define safe_realloc guestfs_safe_realloc
330 #define safe_strdup guestfs_safe_strdup
331 #define safe_strndup guestfs_safe_strndup
332 #define safe_memdup guestfs_safe_memdup
333 #define safe_asprintf guestfs_safe_asprintf
335 #define match guestfs___match
336 #define match1 guestfs___match1
337 #define match2 guestfs___match2
338 #define match3 guestfs___match3
341 #endif /* GUESTFS_INTERNAL_H_ */