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 /* Some limits on what the inspection code will read, for safety. */
65 /* Small text configuration files.
67 * The upper limit is for general files that we grep or download. The
68 * largest such file is probably "txtsetup.sif" from Windows CDs
69 * (~500K). This number has to be larger than any legitimate file and
70 * smaller than the protocol message size.
72 * The lower limit is for files parsed by Augeas on the daemon side,
73 * where Augeas is running in reduced memory and can potentially
74 * create a lot of metadata so we really need to be careful about
77 #define MAX_SMALL_FILE_SIZE (2 * 1000 * 1000)
78 #define MAX_AUGEAS_FILE_SIZE (100 * 1000)
80 /* Maximum Windows Registry hive that we will download to /tmp. Some
81 * registries can be legitimately very large.
83 #define MAX_REGISTRY_SIZE (100 * 1000 * 1000)
85 /* Maximum RPM or dpkg database we will download to /tmp. */
86 #define MAX_PKG_DB_SIZE (10 * 1000 * 1000)
88 /* Network configuration of the appliance. Note these addresses are
89 * only meaningful within the context of the running appliance. QEMU
90 * translates network connections to these magic addresses into
91 * userspace calls on the host (eg. connect(2)). qemu-doc has a nice
92 * diagram which is also useful to refer to.
94 * NETWORK: The network.
96 * ROUTER: The address of the "host", ie. this library.
98 * [Note: If you change NETWORK and ROUTER then you also have to
99 * change the network configuration in appliance/init].
101 * GUESTFWD_ADDR, GUESTFWD_PORT: The guestfwd feature of qemu
102 * magically connects this pseudo-address to the guestfwd channel. In
103 * typical Linux configurations of libguestfs, guestfwd is not
104 * actually used any more.
106 #define NETWORK "169.254.0.0/16"
107 #define ROUTER "169.254.2.2"
109 /* GuestFS handle and connection. */
110 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
113 enum attach_method { ATTACH_METHOD_APPLIANCE = 0, ATTACH_METHOD_UNIX };
117 uint64_t event_bitmask;
118 guestfs_event_callback cb;
121 /* opaque2 is not exposed through the API, but is used internally to
122 * emulate the old-style callback API.
129 struct guestfs_h *next; /* Linked list of open handles. */
131 /* State: see the state machine diagram in the man page guestfs(3). */
134 int fd[2]; /* Stdin/stdout of qemu. */
135 int sock; /* Daemon communications socket. */
136 pid_t pid; /* Qemu PID. */
137 pid_t recoverypid; /* Recovery process PID. */
139 struct timeval launch_t; /* The time that we called guestfs_launch. */
141 char *tmpdir; /* Temporary directory containing socket. */
143 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
145 char **cmdline; /* Qemu command line. */
155 char *path; /* Path to kernel, initrd. */
156 char *qemu; /* Qemu binary. */
157 char *append; /* Append to kernel command line. */
159 enum attach_method attach_method;
160 char *attach_method_arg;
162 int memsize; /* Size of RAM (megabytes). */
164 int selinux; /* selinux enabled? */
167 int last_errnum; /* errno, or 0 if there was no errno */
170 guestfs_abort_cb abort_cb;
171 guestfs_error_handler_cb error_cb;
172 void * error_cb_data;
175 struct event *events;
180 /* Information gathered by inspect_os. Must be freed by calling
181 * guestfs___free_inspect_info.
183 struct inspect_fs *fses;
186 /* Private data area. */
187 struct hash_table *pda;
188 struct pda_entry *pda_next;
190 /* Used by src/actions.c:trace_* functions. */
196 /* Per-filesystem data stored for inspect_os. */
197 enum inspect_fs_content {
198 FS_CONTENT_UNKNOWN = 0,
199 FS_CONTENT_LINUX_ROOT,
200 FS_CONTENT_WINDOWS_ROOT,
201 FS_CONTENT_WINDOWS_VOLUME_WITH_APPS,
202 FS_CONTENT_WINDOWS_VOLUME,
203 FS_CONTENT_LINUX_BOOT,
204 FS_CONTENT_LINUX_USR,
205 FS_CONTENT_LINUX_USR_LOCAL,
206 FS_CONTENT_LINUX_VAR,
207 FS_CONTENT_FREEBSD_ROOT,
208 FS_CONTENT_INSTALLER,
211 enum inspect_os_format {
212 OS_FORMAT_UNKNOWN = 0,
215 /* in future: supplemental disks */
218 enum inspect_os_type {
225 enum inspect_os_distro {
226 OS_DISTRO_UNKNOWN = 0,
229 OS_DISTRO_REDHAT_BASED,
237 OS_DISTRO_LINUX_MINT,
241 OS_DISTRO_SCIENTIFIC_LINUX,
244 enum inspect_os_package_format {
245 OS_PACKAGE_FORMAT_UNKNOWN = 0,
246 OS_PACKAGE_FORMAT_RPM,
247 OS_PACKAGE_FORMAT_DEB,
248 OS_PACKAGE_FORMAT_PACMAN,
249 OS_PACKAGE_FORMAT_EBUILD,
250 OS_PACKAGE_FORMAT_PISI
253 enum inspect_os_package_management {
254 OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
255 OS_PACKAGE_MANAGEMENT_YUM,
256 OS_PACKAGE_MANAGEMENT_UP2DATE,
257 OS_PACKAGE_MANAGEMENT_APT,
258 OS_PACKAGE_MANAGEMENT_PACMAN,
259 OS_PACKAGE_MANAGEMENT_PORTAGE,
260 OS_PACKAGE_MANAGEMENT_PISI,
261 OS_PACKAGE_MANAGEMENT_URPMI,
269 enum inspect_fs_content content;
270 enum inspect_os_type type;
271 enum inspect_os_distro distro;
272 enum inspect_os_package_format package_format;
273 enum inspect_os_package_management package_management;
275 char *product_variant;
280 char *windows_systemroot;
281 char *windows_current_control_set;
282 char **drive_mappings;
283 enum inspect_os_format format;
286 int is_multipart_disk;
287 struct inspect_fstab_entry *fstab;
291 struct inspect_fstab_entry {
296 struct guestfs_message_header;
297 struct guestfs_message_error;
298 struct guestfs_progress;
300 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
301 __attribute__((format (printf,2,3)));
302 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
303 __attribute__((format (printf,3,4)));
304 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
305 __attribute__((format (printf,2,3)));
306 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
307 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
308 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
309 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
310 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
311 __attribute__((format (printf,2,3)));
312 extern void guestfs___warning (guestfs_h *g, const char *fs, ...)
313 __attribute__((format (printf,2,3)));
314 extern void guestfs___debug (guestfs_h *g, const char *fs, ...)
315 __attribute__((format (printf,2,3)));
316 extern void guestfs___trace (guestfs_h *g, const char *fs, ...)
317 __attribute__((format (printf,2,3)));
318 extern const char *guestfs___persistent_tmpdir (void);
319 extern void guestfs___print_timestamped_argv (guestfs_h *g, const char *argv[]);
320 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
321 extern void guestfs___free_inspect_info (guestfs_h *g);
322 extern int guestfs___set_busy (guestfs_h *g);
323 extern int guestfs___end_busy (guestfs_h *g);
324 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
325 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);
326 extern int guestfs___recv_discard (guestfs_h *g, const char *fn);
327 extern int guestfs___send_file (guestfs_h *g, const char *filename);
328 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
329 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
330 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
331 extern int guestfs___accept_from_daemon (guestfs_h *g);
332 extern void guestfs___progress_message_callback (guestfs_h *g, const struct guestfs_progress *message);
333 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
334 extern void guestfs___launch_send_progress (guestfs_h *g, int perdozen);
335 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
336 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
338 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
339 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
340 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
341 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
343 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
344 extern void guestfs___free_string_list (char **);
345 extern size_t guestfs___checkpoint_cmdline (guestfs_h *g);
346 extern void guestfs___rollback_cmdline (guestfs_h *g, size_t pos);
347 extern void guestfs___call_callbacks_void (guestfs_h *g, uint64_t event);
348 extern void guestfs___call_callbacks_message (guestfs_h *g, uint64_t event, const char *buf, size_t buf_len);
349 extern void guestfs___call_callbacks_array (guestfs_h *g, uint64_t event, const uint64_t *array, size_t array_len);
350 #if defined(HAVE_PCRE) && defined(HAVE_HIVEX)
351 extern int guestfs___check_for_filesystem_on (guestfs_h *g, const char *device, int is_block, int is_partnum);
352 extern char *guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs, const char *filename, const char *basename, int64_t max_size);
353 extern char *guestfs___case_sensitive_path_silently (guestfs_h *g, const char *);
354 extern struct inspect_fs *guestfs___search_for_root (guestfs_h *g, const char *root);
355 extern int guestfs___parse_unsigned_int (guestfs_h *g, const char *str);
356 extern int guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str);
357 extern int guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs);
358 extern char *guestfs___first_line_of_file (guestfs_h *g, const char *filename);
359 extern int guestfs___first_egrep_of_file (guestfs_h *g, const char *filename, const char *eregex, int iflag, char **ret);
360 typedef int (*guestfs___db_dump_callback) (guestfs_h *g, const unsigned char *key, size_t keylen, const unsigned char *value, size_t valuelen, void *opaque);
361 extern int guestfs___read_db_dump (guestfs_h *g, const char *dumpfile, void *opaque, guestfs___db_dump_callback callback);
362 extern int guestfs___check_installer_root (guestfs_h *g, struct inspect_fs *fs);
363 extern int guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs);
364 extern int guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
365 extern int guestfs___check_windows_root (guestfs_h *g, struct inspect_fs *fs);
368 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
369 #define perrorf guestfs_perrorf
370 #define warning(g,...) guestfs___warning((g),__VA_ARGS__)
371 #define debug(g,...) \
372 do { if ((g)->verbose) guestfs___debug ((g),__VA_ARGS__); } while (0)
373 #define safe_calloc guestfs_safe_calloc
374 #define safe_malloc guestfs_safe_malloc
375 #define safe_realloc guestfs_safe_realloc
376 #define safe_strdup guestfs_safe_strdup
377 #define safe_strndup guestfs_safe_strndup
378 #define safe_memdup guestfs_safe_memdup
379 #define safe_asprintf guestfs_safe_asprintf
381 #define match guestfs___match
382 #define match1 guestfs___match1
383 #define match2 guestfs___match2
384 #define match3 guestfs___match3
387 #endif /* GUESTFS_INTERNAL_H_ */