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>
27 #define STREQ(a,b) (strcmp((a),(b)) == 0)
28 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
29 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
30 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
31 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
32 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
33 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
34 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
35 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
39 #define _(str) dgettext(PACKAGE, (str))
40 #define N_(str) dgettext(PACKAGE, (str))
48 /* NB: The 'name' parameter is a literal identifier, NOT a string! */
49 #define TRACE0(name) DTRACE_PROBE(guestfs, name)
50 #define TRACE1(name, arg1) \
51 DTRACE_PROBE(guestfs, name, (arg1))
52 #define TRACE2(name, arg1, arg2) \
53 DTRACE_PROBE(guestfs, name, (arg1), (arg2))
54 #define TRACE3(name, arg1, arg2, arg3) \
55 DTRACE_PROBE(guestfs, name, (arg1), (arg2), (arg3))
56 #define TRACE4(name, arg1, arg2, arg3, arg4) \
57 DTRACE_PROBE(guestfs, name, (arg1), (arg2), (arg3), (arg4))
60 #define TRACE1(name, arg1)
61 #define TRACE2(name, arg1, arg2)
62 #define TRACE3(name, arg1, arg2, arg3)
63 #define TRACE4(name, arg1, arg2, arg3, arg4)
66 #define TMP_TEMPLATE_ON_STACK(var) \
67 const char *ttos_tmpdir = guestfs_tmpdir (); \
68 char var[strlen (ttos_tmpdir) + 32]; \
69 sprintf (var, "%s/libguestfsXXXXXX", ttos_tmpdir) \
71 #define UNIX_PATH_MAX 108
74 #define MAX(a,b) ((a)>(b)?(a):(b))
78 #define xdr_uint32_t xdr_u_int32_t
81 /* Some limits on what the inspection code will read, for safety. */
83 /* Small text configuration files.
85 * The upper limit is for general files that we grep or download. The
86 * largest such file is probably "txtsetup.sif" from Windows CDs
87 * (~500K). This number has to be larger than any legitimate file and
88 * smaller than the protocol message size.
90 * The lower limit is for files parsed by Augeas on the daemon side,
91 * where Augeas is running in reduced memory and can potentially
92 * create a lot of metadata so we really need to be careful about
95 #define MAX_SMALL_FILE_SIZE (2 * 1000 * 1000)
96 #define MAX_AUGEAS_FILE_SIZE (100 * 1000)
98 /* Maximum Windows Registry hive that we will download to /tmp. Some
99 * registries can be legitimately very large.
101 #define MAX_REGISTRY_SIZE (100 * 1000 * 1000)
103 /* Maximum RPM or dpkg database we will download to /tmp. RPM
104 * 'Packages' database can get very large: 70 MB is roughly the
105 * standard size for a new Fedora install, and after lots of package
106 * installation/removal I have seen well over 100 MB databases.
108 #define MAX_PKG_DB_SIZE (300 * 1000 * 1000)
110 /* Maximum size of Windows explorer.exe. 2.6MB on Windows 7. */
111 #define MAX_WINDOWS_EXPLORER_SIZE (4 * 1000 * 1000)
113 /* Network configuration of the appliance. Note these addresses are
114 * only meaningful within the context of the running appliance. QEMU
115 * translates network connections to these magic addresses into
116 * userspace calls on the host (eg. connect(2)). qemu-doc has a nice
117 * diagram which is also useful to refer to.
119 * NETWORK: The network.
121 * ROUTER: The address of the "host", ie. this library.
123 * [Note: If you change NETWORK and ROUTER then you also have to
124 * change the network configuration in appliance/init].
126 * GUESTFWD_ADDR, GUESTFWD_PORT: The guestfwd feature of qemu
127 * magically connects this pseudo-address to the guestfwd channel. In
128 * typical Linux configurations of libguestfs, guestfwd is not
129 * actually used any more.
131 #define NETWORK "169.254.0.0/16"
132 #define ROUTER "169.254.2.2"
134 /* GuestFS handle and connection. */
135 enum state { CONFIG, LAUNCHING, READY, BUSY, NO_HANDLE };
138 enum attach_method { ATTACH_METHOD_APPLIANCE = 0, ATTACH_METHOD_UNIX };
142 uint64_t event_bitmask;
143 guestfs_event_callback cb;
146 /* opaque2 is not exposed through the API, but is used internally to
147 * emulate the old-style callback API.
152 /* Linked list of drives added to the handle. */
167 struct guestfs_h *next; /* Linked list of open handles. */
169 /* State: see the state machine diagram in the man page guestfs(3). */
172 struct drive *drives; /* Drives added by add-drive* APIs. */
174 int fd[2]; /* Stdin/stdout of qemu. */
175 int sock; /* Daemon communications socket. */
176 pid_t pid; /* Qemu PID. */
177 pid_t recoverypid; /* Recovery process PID. */
179 struct timeval launch_t; /* The time that we called guestfs_launch. */
181 char *tmpdir; /* Temporary directory containing socket. */
183 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
185 char **cmdline; /* Qemu command line. */
195 char *path; /* Path to kernel, initrd. */
196 char *qemu; /* Qemu binary. */
197 char *append; /* Append to kernel command line. */
199 enum attach_method attach_method;
200 char *attach_method_arg;
202 int memsize; /* Size of RAM (megabytes). */
204 int selinux; /* selinux enabled? */
206 int pgroup; /* Create process group for children? */
208 int smp; /* If > 1, -smp flag passed to qemu. */
211 int last_errnum; /* errno, or 0 if there was no errno */
214 guestfs_abort_cb abort_cb;
215 guestfs_error_handler_cb error_cb;
216 void * error_cb_data;
219 struct event *events;
224 /* Information gathered by inspect_os. Must be freed by calling
225 * guestfs___free_inspect_info.
227 struct inspect_fs *fses;
230 /* Private data area. */
231 struct hash_table *pda;
232 struct pda_entry *pda_next;
234 /* Used by src/actions.c:trace_* functions. */
239 /* User cancelled transfer. Not signal-atomic, but it doesn't
240 * matter for this case because we only care if it is != 0.
245 /* Per-filesystem data stored for inspect_os. */
246 enum inspect_fs_content {
247 FS_CONTENT_UNKNOWN = 0,
248 FS_CONTENT_LINUX_ROOT,
249 FS_CONTENT_WINDOWS_ROOT,
250 FS_CONTENT_WINDOWS_VOLUME_WITH_APPS,
251 FS_CONTENT_WINDOWS_VOLUME,
252 FS_CONTENT_LINUX_BOOT,
253 FS_CONTENT_LINUX_USR,
254 FS_CONTENT_LINUX_USR_LOCAL,
255 FS_CONTENT_LINUX_VAR,
256 FS_CONTENT_FREEBSD_ROOT,
257 FS_CONTENT_NETBSD_ROOT,
258 FS_CONTENT_INSTALLER,
259 FS_CONTENT_HURD_ROOT,
262 enum inspect_os_format {
263 OS_FORMAT_UNKNOWN = 0,
266 /* in future: supplemental disks */
269 enum inspect_os_type {
278 enum inspect_os_distro {
279 OS_DISTRO_UNKNOWN = 0,
282 OS_DISTRO_REDHAT_BASED,
290 OS_DISTRO_LINUX_MINT,
294 OS_DISTRO_SCIENTIFIC_LINUX,
300 enum inspect_os_package_format {
301 OS_PACKAGE_FORMAT_UNKNOWN = 0,
302 OS_PACKAGE_FORMAT_RPM,
303 OS_PACKAGE_FORMAT_DEB,
304 OS_PACKAGE_FORMAT_PACMAN,
305 OS_PACKAGE_FORMAT_EBUILD,
306 OS_PACKAGE_FORMAT_PISI,
307 OS_PACKAGE_FORMAT_PKGSRC,
310 enum inspect_os_package_management {
311 OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
312 OS_PACKAGE_MANAGEMENT_YUM,
313 OS_PACKAGE_MANAGEMENT_UP2DATE,
314 OS_PACKAGE_MANAGEMENT_APT,
315 OS_PACKAGE_MANAGEMENT_PACMAN,
316 OS_PACKAGE_MANAGEMENT_PORTAGE,
317 OS_PACKAGE_MANAGEMENT_PISI,
318 OS_PACKAGE_MANAGEMENT_URPMI,
319 OS_PACKAGE_MANAGEMENT_ZYPPER,
327 enum inspect_fs_content content;
328 enum inspect_os_type type;
329 enum inspect_os_distro distro;
330 enum inspect_os_package_format package_format;
331 enum inspect_os_package_management package_management;
333 char *product_variant;
338 char *windows_systemroot;
339 char *windows_current_control_set;
340 char **drive_mappings;
341 enum inspect_os_format format;
344 int is_multipart_disk;
345 struct inspect_fstab_entry *fstab;
349 struct inspect_fstab_entry {
354 struct guestfs_message_header;
355 struct guestfs_message_error;
356 struct guestfs_progress;
358 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
359 __attribute__((format (printf,2,3)));
360 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
361 __attribute__((format (printf,3,4)));
362 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
363 __attribute__((format (printf,2,3)));
364 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
365 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
366 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
367 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
368 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
369 __attribute__((format (printf,2,3)));
370 extern void guestfs___warning (guestfs_h *g, const char *fs, ...)
371 __attribute__((format (printf,2,3)));
372 extern void guestfs___debug (guestfs_h *g, const char *fs, ...)
373 __attribute__((format (printf,2,3)));
374 extern void guestfs___trace (guestfs_h *g, const char *fs, ...)
375 __attribute__((format (printf,2,3)));
376 extern const char *guestfs___persistent_tmpdir (void);
377 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
378 extern void guestfs___free_inspect_info (guestfs_h *g);
379 extern void guestfs___free_drives (struct drive **drives);
380 extern int guestfs___set_busy (guestfs_h *g);
381 extern int guestfs___end_busy (guestfs_h *g);
382 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
383 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);
384 extern int guestfs___recv_discard (guestfs_h *g, const char *fn);
385 extern int guestfs___send_file (guestfs_h *g, const char *filename);
386 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
387 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
388 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
389 extern int guestfs___accept_from_daemon (guestfs_h *g);
390 extern void guestfs___progress_message_callback (guestfs_h *g, const struct guestfs_progress *message);
391 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
392 extern void guestfs___launch_send_progress (guestfs_h *g, int perdozen);
393 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
394 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
395 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
396 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
397 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
398 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
399 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
400 extern void guestfs___free_string_list (char **);
401 extern struct drive ** guestfs___checkpoint_drives (guestfs_h *g);
402 extern void guestfs___rollback_drives (guestfs_h *g, struct drive **i);
403 extern void guestfs___call_callbacks_void (guestfs_h *g, uint64_t event);
404 extern void guestfs___call_callbacks_message (guestfs_h *g, uint64_t event, const char *buf, size_t buf_len);
405 extern void guestfs___call_callbacks_array (guestfs_h *g, uint64_t event, const uint64_t *array, size_t array_len);
406 extern int guestfs___is_file_nocase (guestfs_h *g, const char *);
407 extern int guestfs___is_dir_nocase (guestfs_h *g, const char *);
408 extern char *guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs, const char *filename, const char *basename, int64_t max_size);
409 extern char *guestfs___case_sensitive_path_silently (guestfs_h *g, const char *);
410 extern struct inspect_fs *guestfs___search_for_root (guestfs_h *g, const char *root);
412 #if defined(HAVE_HIVEX)
413 extern int guestfs___check_for_filesystem_on (guestfs_h *g, const char *device, int is_block, int is_partnum);
414 extern int guestfs___parse_unsigned_int (guestfs_h *g, const char *str);
415 extern int guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str);
416 extern int guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs);
417 extern char *guestfs___first_line_of_file (guestfs_h *g, const char *filename);
418 extern int guestfs___first_egrep_of_file (guestfs_h *g, const char *filename, const char *eregex, int iflag, char **ret);
419 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);
420 extern int guestfs___read_db_dump (guestfs_h *g, const char *dumpfile, void *opaque, guestfs___db_dump_callback callback);
421 extern int guestfs___check_installer_root (guestfs_h *g, struct inspect_fs *fs);
422 extern int guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs);
423 extern int guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
424 extern int guestfs___check_netbsd_root (guestfs_h *g, struct inspect_fs *fs);
425 extern int guestfs___check_hurd_root (guestfs_h *g, struct inspect_fs *fs);
426 extern int guestfs___has_windows_systemroot (guestfs_h *g);
427 extern int guestfs___check_windows_root (guestfs_h *g, struct inspect_fs *fs);
430 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
431 #define perrorf guestfs_perrorf
432 #define warning(g,...) guestfs___warning((g),__VA_ARGS__)
433 #define debug(g,...) \
434 do { if ((g)->verbose) guestfs___debug ((g),__VA_ARGS__); } while (0)
435 #define safe_calloc guestfs_safe_calloc
436 #define safe_malloc guestfs_safe_malloc
437 #define safe_realloc guestfs_safe_realloc
438 #define safe_strdup guestfs_safe_strdup
439 #define safe_strndup guestfs_safe_strndup
440 #define safe_memdup guestfs_safe_memdup
441 #define safe_asprintf guestfs_safe_asprintf
442 #define match guestfs___match
443 #define match1 guestfs___match1
444 #define match2 guestfs___match2
445 #define match3 guestfs___match3
447 #endif /* GUESTFS_INTERNAL_H_ */