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. */
166 struct guestfs_h *next; /* Linked list of open handles. */
168 /* State: see the state machine diagram in the man page guestfs(3). */
171 struct drive *drives; /* Drives added by add-drive* APIs. */
173 int fd[2]; /* Stdin/stdout of qemu. */
174 int sock; /* Daemon communications socket. */
175 pid_t pid; /* Qemu PID. */
176 pid_t recoverypid; /* Recovery process PID. */
178 struct timeval launch_t; /* The time that we called guestfs_launch. */
180 char *tmpdir; /* Temporary directory containing socket. */
182 char *qemu_help, *qemu_version; /* Output of qemu -help, qemu -version. */
184 char **cmdline; /* Qemu command line. */
194 char *path; /* Path to kernel, initrd. */
195 char *qemu; /* Qemu binary. */
196 char *append; /* Append to kernel command line. */
198 enum attach_method attach_method;
199 char *attach_method_arg;
201 int memsize; /* Size of RAM (megabytes). */
203 int selinux; /* selinux enabled? */
205 int pgroup; /* Create process group for children? */
207 int smp; /* If > 1, -smp flag passed to qemu. */
210 int last_errnum; /* errno, or 0 if there was no errno */
213 guestfs_abort_cb abort_cb;
214 guestfs_error_handler_cb error_cb;
215 void * error_cb_data;
218 struct event *events;
223 /* Information gathered by inspect_os. Must be freed by calling
224 * guestfs___free_inspect_info.
226 struct inspect_fs *fses;
229 /* Private data area. */
230 struct hash_table *pda;
231 struct pda_entry *pda_next;
233 /* Used by src/actions.c:trace_* functions. */
238 /* User cancelled transfer. Not signal-atomic, but it doesn't
239 * matter for this case because we only care if it is != 0.
244 /* Per-filesystem data stored for inspect_os. */
245 enum inspect_fs_content {
246 FS_CONTENT_UNKNOWN = 0,
247 FS_CONTENT_LINUX_ROOT,
248 FS_CONTENT_WINDOWS_ROOT,
249 FS_CONTENT_WINDOWS_VOLUME_WITH_APPS,
250 FS_CONTENT_WINDOWS_VOLUME,
251 FS_CONTENT_LINUX_BOOT,
252 FS_CONTENT_LINUX_USR,
253 FS_CONTENT_LINUX_USR_LOCAL,
254 FS_CONTENT_LINUX_VAR,
255 FS_CONTENT_FREEBSD_ROOT,
256 FS_CONTENT_NETBSD_ROOT,
257 FS_CONTENT_INSTALLER,
260 enum inspect_os_format {
261 OS_FORMAT_UNKNOWN = 0,
264 /* in future: supplemental disks */
267 enum inspect_os_type {
275 enum inspect_os_distro {
276 OS_DISTRO_UNKNOWN = 0,
279 OS_DISTRO_REDHAT_BASED,
287 OS_DISTRO_LINUX_MINT,
291 OS_DISTRO_SCIENTIFIC_LINUX,
297 enum inspect_os_package_format {
298 OS_PACKAGE_FORMAT_UNKNOWN = 0,
299 OS_PACKAGE_FORMAT_RPM,
300 OS_PACKAGE_FORMAT_DEB,
301 OS_PACKAGE_FORMAT_PACMAN,
302 OS_PACKAGE_FORMAT_EBUILD,
303 OS_PACKAGE_FORMAT_PISI,
304 OS_PACKAGE_FORMAT_PKGSRC,
307 enum inspect_os_package_management {
308 OS_PACKAGE_MANAGEMENT_UNKNOWN = 0,
309 OS_PACKAGE_MANAGEMENT_YUM,
310 OS_PACKAGE_MANAGEMENT_UP2DATE,
311 OS_PACKAGE_MANAGEMENT_APT,
312 OS_PACKAGE_MANAGEMENT_PACMAN,
313 OS_PACKAGE_MANAGEMENT_PORTAGE,
314 OS_PACKAGE_MANAGEMENT_PISI,
315 OS_PACKAGE_MANAGEMENT_URPMI,
316 OS_PACKAGE_MANAGEMENT_ZYPPER,
324 enum inspect_fs_content content;
325 enum inspect_os_type type;
326 enum inspect_os_distro distro;
327 enum inspect_os_package_format package_format;
328 enum inspect_os_package_management package_management;
330 char *product_variant;
335 char *windows_systemroot;
336 char *windows_current_control_set;
337 char **drive_mappings;
338 enum inspect_os_format format;
341 int is_multipart_disk;
342 struct inspect_fstab_entry *fstab;
346 struct inspect_fstab_entry {
351 struct guestfs_message_header;
352 struct guestfs_message_error;
353 struct guestfs_progress;
355 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
356 __attribute__((format (printf,2,3)));
357 extern void guestfs_error_errno (guestfs_h *g, int errnum, const char *fs, ...)
358 __attribute__((format (printf,3,4)));
359 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
360 __attribute__((format (printf,2,3)));
361 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
362 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
363 extern char *guestfs_safe_strndup (guestfs_h *g, const char *str, size_t n);
364 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
365 extern char *guestfs_safe_asprintf (guestfs_h *g, const char *fs, ...)
366 __attribute__((format (printf,2,3)));
367 extern void guestfs___warning (guestfs_h *g, const char *fs, ...)
368 __attribute__((format (printf,2,3)));
369 extern void guestfs___debug (guestfs_h *g, const char *fs, ...)
370 __attribute__((format (printf,2,3)));
371 extern void guestfs___trace (guestfs_h *g, const char *fs, ...)
372 __attribute__((format (printf,2,3)));
373 extern const char *guestfs___persistent_tmpdir (void);
374 extern void guestfs___print_timestamped_message (guestfs_h *g, const char *fs, ...);
375 extern void guestfs___free_inspect_info (guestfs_h *g);
376 extern void guestfs___free_drives (struct drive **drives);
377 extern int guestfs___set_busy (guestfs_h *g);
378 extern int guestfs___end_busy (guestfs_h *g);
379 extern int guestfs___send (guestfs_h *g, int proc_nr, uint64_t progress_hint, uint64_t optargs_bitmask, xdrproc_t xdrp, char *args);
380 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);
381 extern int guestfs___recv_discard (guestfs_h *g, const char *fn);
382 extern int guestfs___send_file (guestfs_h *g, const char *filename);
383 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
384 extern int guestfs___send_to_daemon (guestfs_h *g, const void *v_buf, size_t n);
385 extern int guestfs___recv_from_daemon (guestfs_h *g, uint32_t *size_rtn, void **buf_rtn);
386 extern int guestfs___accept_from_daemon (guestfs_h *g);
387 extern void guestfs___progress_message_callback (guestfs_h *g, const struct guestfs_progress *message);
388 extern int guestfs___build_appliance (guestfs_h *g, char **kernel, char **initrd, char **appliance);
389 extern void guestfs___launch_send_progress (guestfs_h *g, int perdozen);
390 extern void guestfs___print_BufferIn (FILE *out, const char *buf, size_t buf_size);
391 extern void guestfs___print_BufferOut (FILE *out, const char *buf, size_t buf_size);
392 extern int guestfs___match (guestfs_h *g, const char *str, const pcre *re);
393 extern char *guestfs___match1 (guestfs_h *g, const char *str, const pcre *re);
394 extern int guestfs___match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2);
395 extern int guestfs___match3 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2, char **ret3);
396 extern int guestfs___feature_available (guestfs_h *g, const char *feature);
397 extern void guestfs___free_string_list (char **);
398 extern struct drive ** guestfs___checkpoint_drives (guestfs_h *g);
399 extern void guestfs___rollback_drives (guestfs_h *g, struct drive **i);
400 extern void guestfs___call_callbacks_void (guestfs_h *g, uint64_t event);
401 extern void guestfs___call_callbacks_message (guestfs_h *g, uint64_t event, const char *buf, size_t buf_len);
402 extern void guestfs___call_callbacks_array (guestfs_h *g, uint64_t event, const uint64_t *array, size_t array_len);
403 extern int guestfs___is_file_nocase (guestfs_h *g, const char *);
404 extern int guestfs___is_dir_nocase (guestfs_h *g, const char *);
405 #if defined(HAVE_HIVEX)
406 extern int guestfs___check_for_filesystem_on (guestfs_h *g, const char *device, int is_block, int is_partnum);
407 extern char *guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs, const char *filename, const char *basename, int64_t max_size);
408 extern char *guestfs___case_sensitive_path_silently (guestfs_h *g, const char *);
409 extern struct inspect_fs *guestfs___search_for_root (guestfs_h *g, const char *root);
410 extern int guestfs___parse_unsigned_int (guestfs_h *g, const char *str);
411 extern int guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str);
412 extern int guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs);
413 extern char *guestfs___first_line_of_file (guestfs_h *g, const char *filename);
414 extern int guestfs___first_egrep_of_file (guestfs_h *g, const char *filename, const char *eregex, int iflag, char **ret);
415 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);
416 extern int guestfs___read_db_dump (guestfs_h *g, const char *dumpfile, void *opaque, guestfs___db_dump_callback callback);
417 extern int guestfs___check_installer_root (guestfs_h *g, struct inspect_fs *fs);
418 extern int guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs);
419 extern int guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
420 extern int guestfs___check_netbsd_root (guestfs_h *g, struct inspect_fs *fs);
421 extern int guestfs___has_windows_systemroot (guestfs_h *g);
422 extern int guestfs___check_windows_root (guestfs_h *g, struct inspect_fs *fs);
425 #define error(g,...) guestfs_error_errno((g),0,__VA_ARGS__)
426 #define perrorf guestfs_perrorf
427 #define warning(g,...) guestfs___warning((g),__VA_ARGS__)
428 #define debug(g,...) \
429 do { if ((g)->verbose) guestfs___debug ((g),__VA_ARGS__); } while (0)
430 #define safe_calloc guestfs_safe_calloc
431 #define safe_malloc guestfs_safe_malloc
432 #define safe_realloc guestfs_safe_realloc
433 #define safe_strdup guestfs_safe_strdup
434 #define safe_strndup guestfs_safe_strndup
435 #define safe_memdup guestfs_safe_memdup
436 #define safe_asprintf guestfs_safe_asprintf
437 #define match guestfs___match
438 #define match1 guestfs___match1
439 #define match2 guestfs___match2
440 #define match3 guestfs___match3
442 #endif /* GUESTFS_INTERNAL_H_ */