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. RPM
86 * 'Packages' database can get very large: 70 MB is roughly the
87 * standard size for a new Fedora install, and after lots of package
88 * installation/removal I have seen well over 100 MB databases.
90 #define MAX_PKG_DB_SIZE (300 * 1000 * 1000)
92 /* Maximum size of Windows explorer.exe. 2.6MB on Windows 7. */
93 #define MAX_WINDOWS_EXPLORER_SIZE (4 * 1000 * 1000)
95 /* Network configuration of the appliance. Note these addresses are
96 * only meaningful within the context of the running appliance. QEMU
97 * translates network connections to these magic addresses into
98 * userspace calls on the host (eg. connect(2)). qemu-doc has a nice
99 * diagram which is also useful to refer to.
101 * NETWORK: The network.
103 * ROUTER: The address of the "host", ie. this library.
105 * [Note: If you change NETWORK and ROUTER then you also have to
106 * change the network configuration in appliance/init].
108 * GUESTFWD_ADDR, GUESTFWD_PORT: The guestfwd feature of qemu
109 * magically connects this pseudo-address to the guestfwd channel. In
110 * typical Linux configurations of libguestfs, guestfwd is not
111 * actually used any more.
113 #define NETWORK "169.254.0.0/16"
114 #define ROUTER "169.254.2.2"
116 /* GuestFS handle and connection. */
117 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
120 enum attach_method { ATTACH_METHOD_APPLIANCE = 0, ATTACH_METHOD_UNIX };
124 uint64_t event_bitmask;
125 guestfs_event_callback cb;
128 /* opaque2 is not exposed through the API, but is used internally to
129 * emulate the old-style callback API.
136 struct guestfs_h *next; /* Linked list of open handles. */
138 /* State: see the state machine diagram in the man page guestfs(3). */
141 int fd[2]; /* Stdin/stdout of qemu. */
142 int sock; /* Daemon communications socket. */
143 pid_t pid; /* Qemu PID. */
144 pid_t recoverypid; /* Recovery process PID. */
146 struct timeval launch_t; /* The time that we called guestfs_launch. */
148 char *tmpdir; /* Temporary directory containing socket. */
150 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
152 char **cmdline; /* Qemu command line. */
162 char *path; /* Path to kernel, initrd. */
163 char *qemu; /* Qemu binary. */
164 char *append; /* Append to kernel command line. */
166 enum attach_method attach_method;
167 char *attach_method_arg;
169 int memsize; /* Size of RAM (megabytes). */
171 int selinux; /* selinux enabled? */
173 int pgroup; /* Create process group for children? */
176 int last_errnum; /* errno, or 0 if there was no errno */
179 guestfs_abort_cb abort_cb;
180 guestfs_error_handler_cb error_cb;
181 void * error_cb_data;
184 struct event *events;
189 /* Information gathered by inspect_os. Must be freed by calling
190 * guestfs___free_inspect_info.
192 struct inspect_fs *fses;
195 /* Private data area. */
196 struct hash_table *pda;
197 struct pda_entry *pda_next;
199 /* Used by src/actions.c:trace_* functions. */
204 /* User cancelled transfer. Not signal-atomic, but it doesn't
205 * matter for this case because we only care if it is != 0.
210 /* Per-filesystem data stored for inspect_os. */
211 enum inspect_fs_content {
212 FS_CONTENT_UNKNOWN = 0,
213 FS_CONTENT_LINUX_ROOT,
214 FS_CONTENT_WINDOWS_ROOT,
215 FS_CONTENT_WINDOWS_VOLUME_WITH_APPS,
216 FS_CONTENT_WINDOWS_VOLUME,
217 FS_CONTENT_LINUX_BOOT,
218 FS_CONTENT_LINUX_USR,
219 FS_CONTENT_LINUX_USR_LOCAL,
220 FS_CONTENT_LINUX_VAR,
221 FS_CONTENT_FREEBSD_ROOT,
222 FS_CONTENT_INSTALLER,
225 enum inspect_os_format {
226 OS_FORMAT_UNKNOWN = 0,
229 /* in future: supplemental disks */
232 enum inspect_os_type {
239 enum inspect_os_distro {
240 OS_DISTRO_UNKNOWN = 0,
243 OS_DISTRO_REDHAT_BASED,
251 OS_DISTRO_LINUX_MINT,
255 OS_DISTRO_SCIENTIFIC_LINUX,
258 enum inspect_os_package_format {
259 OS_PACKAGE_FORMAT_UNKNOWN = 0,
260 OS_PACKAGE_FORMAT_RPM,
261 OS_PACKAGE_FORMAT_DEB,
262 OS_PACKAGE_FORMAT_PACMAN,
263 OS_PACKAGE_FORMAT_EBUILD,
264 OS_PACKAGE_FORMAT_PISI
267 enum inspect_os_package_management {
268 OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
269 OS_PACKAGE_MANAGEMENT_YUM,
270 OS_PACKAGE_MANAGEMENT_UP2DATE,
271 OS_PACKAGE_MANAGEMENT_APT,
272 OS_PACKAGE_MANAGEMENT_PACMAN,
273 OS_PACKAGE_MANAGEMENT_PORTAGE,
274 OS_PACKAGE_MANAGEMENT_PISI,
275 OS_PACKAGE_MANAGEMENT_URPMI,
283 enum inspect_fs_content content;
284 enum inspect_os_type type;
285 enum inspect_os_distro distro;
286 enum inspect_os_package_format package_format;
287 enum inspect_os_package_management package_management;
289 char *product_variant;
294 char *windows_systemroot;
295 char *windows_current_control_set;
296 char **drive_mappings;
297 enum inspect_os_format format;
300 int is_multipart_disk;
301 struct inspect_fstab_entry *fstab;
305 struct inspect_fstab_entry {
310 struct guestfs_message_header;
311 struct guestfs_message_error;
312 struct guestfs_progress;
314 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
315 __attribute__((format (printf,2,3)));
316 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
317 __attribute__((format (printf,3,4)));
318 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
319 __attribute__((format (printf,2,3)));
320 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
321 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
322 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
323 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
324 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
325 __attribute__((format (printf,2,3)));
326 extern void guestfs___warning (guestfs_h *g, const char *fs, ...)
327 __attribute__((format (printf,2,3)));
328 extern void guestfs___debug (guestfs_h *g, const char *fs, ...)
329 __attribute__((format (printf,2,3)));
330 extern void guestfs___trace (guestfs_h *g, const char *fs, ...)
331 __attribute__((format (printf,2,3)));
332 extern const char *guestfs___persistent_tmpdir (void);
333 extern void guestfs___print_timestamped_argv (guestfs_h *g, const char *argv[]);
334 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
335 extern void guestfs___free_inspect_info (guestfs_h *g);
336 extern int guestfs___set_busy (guestfs_h *g);
337 extern int guestfs___end_busy (guestfs_h *g);
338 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
339 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);
340 extern int guestfs___recv_discard (guestfs_h *g, const char *fn);
341 extern int guestfs___send_file (guestfs_h *g, const char *filename);
342 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
343 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
344 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
345 extern int guestfs___accept_from_daemon (guestfs_h *g);
346 extern void guestfs___progress_message_callback (guestfs_h *g, const struct guestfs_progress *message);
347 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
348 extern void guestfs___launch_send_progress (guestfs_h *g, int perdozen);
349 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
350 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
352 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
353 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
354 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
355 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
357 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
358 extern void guestfs___free_string_list (char **);
359 extern size_t guestfs___checkpoint_cmdline (guestfs_h *g);
360 extern void guestfs___rollback_cmdline (guestfs_h *g, size_t pos);
361 extern void guestfs___call_callbacks_void (guestfs_h *g, uint64_t event);
362 extern void guestfs___call_callbacks_message (guestfs_h *g, uint64_t event, const char *buf, size_t buf_len);
363 extern void guestfs___call_callbacks_array (guestfs_h *g, uint64_t event, const uint64_t *array, size_t array_len);
364 #if defined(HAVE_PCRE) && defined(HAVE_HIVEX)
365 extern int guestfs___check_for_filesystem_on (guestfs_h *g, const char *device, int is_block, int is_partnum);
366 extern char *guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs, const char *filename, const char *basename, int64_t max_size);
367 extern char *guestfs___case_sensitive_path_silently (guestfs_h *g, const char *);
368 extern struct inspect_fs *guestfs___search_for_root (guestfs_h *g, const char *root);
369 extern int guestfs___parse_unsigned_int (guestfs_h *g, const char *str);
370 extern int guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str);
371 extern int guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs);
372 extern char *guestfs___first_line_of_file (guestfs_h *g, const char *filename);
373 extern int guestfs___first_egrep_of_file (guestfs_h *g, const char *filename, const char *eregex, int iflag, char **ret);
374 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);
375 extern int guestfs___read_db_dump (guestfs_h *g, const char *dumpfile, void *opaque, guestfs___db_dump_callback callback);
376 extern int guestfs___check_installer_root (guestfs_h *g, struct inspect_fs *fs);
377 extern int guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs);
378 extern int guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
379 extern int guestfs___check_windows_root (guestfs_h *g, struct inspect_fs *fs);
382 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
383 #define perrorf guestfs_perrorf
384 #define warning(g,...) guestfs___warning((g),__VA_ARGS__)
385 #define debug(g,...) \
386 do { if ((g)->verbose) guestfs___debug ((g),__VA_ARGS__); } while (0)
387 #define safe_calloc guestfs_safe_calloc
388 #define safe_malloc guestfs_safe_malloc
389 #define safe_realloc guestfs_safe_realloc
390 #define safe_strdup guestfs_safe_strdup
391 #define safe_strndup guestfs_safe_strndup
392 #define safe_memdup guestfs_safe_memdup
393 #define safe_asprintf guestfs_safe_asprintf
395 #define match guestfs___match
396 #define match1 guestfs___match1
397 #define match2 guestfs___match2
398 #define match3 guestfs___match3
401 #endif /* GUESTFS_INTERNAL_H_ */