2 * Copyright (C) 2010-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
38 #include "ignore-value.h"
42 #include "guestfs-internal.h"
43 #include "guestfs-internal-actions.h"
44 #include "guestfs_protocol.h"
46 #if defined(HAVE_PCRE) && defined(HAVE_HIVEX)
48 /* Some limits on what we will read, for safety. */
50 /* Small text configuration files.
52 * The upper limit is for general files that we grep or download. The
53 * largest such file is probably "txtsetup.sif" from Windows CDs
54 * (~500K). This number has to be larger than any legitimate file and
55 * smaller than the protocol message size.
57 * The lower limit is for files parsed by Augeas on the daemon side,
58 * where Augeas is running in reduced memory and can potentially
59 * create a lot of metadata so we really need to be careful about
62 #define MAX_SMALL_FILE_SIZE (2 * 1000 * 1000)
63 #define MAX_AUGEAS_FILE_SIZE (100 * 1000)
65 /* Maximum Windows Registry hive that we will download to /tmp. Some
66 * registries can be legitimately very large.
68 #define MAX_REGISTRY_SIZE (100 * 1000 * 1000)
70 /* Maximum RPM or dpkg database we will download to /tmp. */
71 #define MAX_PKG_DB_SIZE (10 * 1000 * 1000)
73 /* Compile all the regular expressions once when the shared library is
74 * loaded. PCRE is thread safe so we're supposedly OK here if
75 * multiple threads call into the libguestfs API functions below
78 static pcre *re_fedora;
79 static pcre *re_rhel_old;
81 static pcre *re_rhel_no_minor;
82 static pcre *re_major_minor;
83 static pcre *re_aug_seq;
85 static pcre *re_first_partition;
86 static pcre *re_freebsd;
87 static pcre *re_windows_version;
89 static void compile_regexps (void) __attribute__((constructor));
90 static void free_regexps (void) __attribute__((destructor));
93 compile_regexps (void)
98 #define COMPILE(re,pattern,options) \
100 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
102 ignore_value (write (2, err, strlen (err))); \
107 COMPILE (re_fedora, "Fedora release (\\d+)", 0);
108 COMPILE (re_rhel_old,
109 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
111 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
112 COMPILE (re_rhel_no_minor,
113 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+)", 0);
114 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
115 COMPILE (re_aug_seq, "/\\d+$", 0);
116 COMPILE (re_xdev, "^/dev/(?:h|s|v|xv)d([a-z]\\d*)$", 0);
117 COMPILE (re_first_partition, "^/dev/(?:h|s|v)d.1$", 0);
118 COMPILE (re_freebsd, "^/dev/ad(\\d+)s(\\d+)([a-z])$", 0);
119 COMPILE (re_windows_version, "^(\\d+)\\.(\\d+)", 0);
125 pcre_free (re_fedora);
126 pcre_free (re_rhel_old);
128 pcre_free (re_rhel_no_minor);
129 pcre_free (re_major_minor);
130 pcre_free (re_aug_seq);
132 pcre_free (re_first_partition);
133 pcre_free (re_freebsd);
134 pcre_free (re_windows_version);
137 /* The main inspection code. */
138 static int check_for_filesystem_on (guestfs_h *g, const char *device);
141 guestfs__inspect_os (guestfs_h *g)
143 /* Remove any information previously stored in the handle. */
144 guestfs___free_inspect_info (g);
146 if (guestfs_umount_all (g) == -1)
149 /* Iterate over all possible devices. Try to mount each
150 * (read-only). Examine ones which contain filesystems and add that
151 * information to the handle.
153 /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
155 devices = guestfs_list_devices (g);
160 for (i = 0; devices[i] != NULL; ++i) {
161 if (check_for_filesystem_on (g, devices[i]) == -1) {
162 guestfs___free_string_list (devices);
163 guestfs___free_inspect_info (g);
167 guestfs___free_string_list (devices);
169 /* Look at all partitions. */
171 partitions = guestfs_list_partitions (g);
172 if (partitions == NULL) {
173 guestfs___free_inspect_info (g);
177 for (i = 0; partitions[i] != NULL; ++i) {
178 if (check_for_filesystem_on (g, partitions[i]) == -1) {
179 guestfs___free_string_list (partitions);
180 guestfs___free_inspect_info (g);
184 guestfs___free_string_list (partitions);
186 /* Look at all LVs. */
187 if (guestfs___feature_available (g, "lvm2")) {
189 lvs = guestfs_lvs (g);
191 guestfs___free_inspect_info (g);
195 for (i = 0; lvs[i] != NULL; ++i) {
196 if (check_for_filesystem_on (g, lvs[i]) == -1) {
197 guestfs___free_string_list (lvs);
198 guestfs___free_inspect_info (g);
202 guestfs___free_string_list (lvs);
205 /* At this point we have, in the handle, a list of all filesystems
206 * found and data about each one. Now we assemble the list of
207 * filesystems which are root devices and return that to the user.
208 * Fall through to guestfs__inspect_get_roots to do that.
210 char **ret = guestfs__inspect_get_roots (g);
212 guestfs___free_inspect_info (g);
216 /* Find out if 'device' contains a filesystem. If it does, add
217 * another entry in g->fses.
219 static int check_filesystem (guestfs_h *g, const char *device);
220 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
221 static int check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
222 static void check_architecture (guestfs_h *g, struct inspect_fs *fs);
223 static int check_hostname_unix (guestfs_h *g, struct inspect_fs *fs);
224 static int check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs);
225 static int check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs);
226 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
227 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
228 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
229 static int check_windows_software_registry (guestfs_h *g, struct inspect_fs *fs);
230 static int check_windows_system_registry (guestfs_h *g, struct inspect_fs *fs);
231 static char *case_sensitive_path_silently (guestfs_h *g, const char *);
232 static int is_file_nocase (guestfs_h *g, const char *);
233 static int is_dir_nocase (guestfs_h *g, const char *);
234 static int extend_fses (guestfs_h *g);
235 static int parse_unsigned_int (guestfs_h *g, const char *str);
236 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
237 const char *spec, const char *mp);
238 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
239 static void check_package_format (guestfs_h *g, struct inspect_fs *fs);
240 static void check_package_management (guestfs_h *g, struct inspect_fs *fs);
241 static int download_to_tmp (guestfs_h *g, const char *filename, char *localtmp, int64_t max_size);
242 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
243 static char *first_line_of_file (guestfs_h *g, const char *filename);
246 check_for_filesystem_on (guestfs_h *g, const char *device)
248 /* Get vfs-type in order to check if it's a Linux(?) swap device.
249 * If there's an error we should ignore it, so to do that we have to
250 * temporarily replace the error handler with a null one.
252 guestfs_error_handler_cb old_error_cb = g->error_cb;
254 char *vfs_type = guestfs_vfs_type (g, device);
255 g->error_cb = old_error_cb;
257 int is_swap = vfs_type && STREQ (vfs_type, "swap");
260 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
261 device, vfs_type ? vfs_type : "failed to get vfs type");
265 if (extend_fses (g) == -1)
267 g->fses[g->nr_fses-1].is_swap = 1;
271 /* Try mounting the device. As above, ignore errors. */
273 int r = guestfs_mount_ro (g, device, "/");
274 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
275 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
277 g->error_cb = old_error_cb;
281 /* Do the rest of the checks. */
282 r = check_filesystem (g, device);
284 /* Unmount the filesystem. */
285 if (guestfs_umount_all (g) == -1)
292 check_filesystem (guestfs_h *g, const char *device)
294 if (extend_fses (g) == -1)
297 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
299 fs->device = safe_strdup (g, device);
300 fs->is_mountable = 1;
302 /* Optimize some of the tests by avoiding multiple tests of the same thing. */
303 int is_dir_etc = guestfs_is_dir (g, "/etc") > 0;
304 int is_dir_bin = guestfs_is_dir (g, "/bin") > 0;
305 int is_dir_share = guestfs_is_dir (g, "/share") > 0;
308 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
309 guestfs_is_file (g, "/grub/grub.conf") > 0)
310 fs->content = FS_CONTENT_LINUX_BOOT;
312 else if (is_dir_etc &&
314 guestfs_is_file (g, "/etc/freebsd-update.conf") > 0 &&
315 guestfs_is_file (g, "/etc/fstab") > 0) {
316 /* Ignore /dev/sda1 which is a shadow of the real root filesystem
317 * that is probably /dev/sda5 (see:
318 * http://www.freebsd.org/doc/handbook/disk-organization.html)
320 if (match (g, device, re_first_partition))
324 fs->content = FS_CONTENT_FREEBSD_ROOT;
325 if (check_freebsd_root (g, fs) == -1)
329 else if (is_dir_etc &&
331 guestfs_is_file (g, "/etc/fstab") > 0) {
333 fs->content = FS_CONTENT_LINUX_ROOT;
334 if (check_linux_root (g, fs) == -1)
337 /* Linux /usr/local? */
338 else if (is_dir_etc &&
341 guestfs_exists (g, "/local") == 0 &&
342 guestfs_is_file (g, "/etc/fstab") == 0)
343 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
345 else if (is_dir_etc &&
348 guestfs_exists (g, "/local") > 0 &&
349 guestfs_is_file (g, "/etc/fstab") == 0)
350 fs->content = FS_CONTENT_LINUX_USR;
352 else if (guestfs_is_dir (g, "/log") > 0 &&
353 guestfs_is_dir (g, "/run") > 0 &&
354 guestfs_is_dir (g, "/spool") > 0)
355 fs->content = FS_CONTENT_LINUX_VAR;
357 * Note that if a Windows guest has multiple disks and applications
358 * are installed on those other disks, then those other disks will
359 * contain "/Program Files" and "/System Volume Information". Those
360 * would *not* be Windows root disks. (RHBZ#674130)
362 else if (is_file_nocase (g, "/AUTOEXEC.BAT") > 0 ||
363 is_dir_nocase (g, "/WINDOWS/SYSTEM32") > 0 ||
364 is_dir_nocase (g, "/WIN32/SYSTEM32") > 0 ||
365 is_dir_nocase (g, "/WINNT/SYSTEM32") > 0 ||
366 is_file_nocase (g, "/boot.ini") > 0 ||
367 is_file_nocase (g, "/ntldr") > 0) {
369 fs->content = FS_CONTENT_WINDOWS_ROOT;
370 if (check_windows_root (g, fs) == -1)
373 /* Windows volume with installed applications (but not root)? */
374 else if (is_dir_nocase (g, "/System Volume Information") > 0 &&
375 is_dir_nocase (g, "/Program Files") > 0)
376 fs->content = FS_CONTENT_WINDOWS_VOLUME_WITH_APPS;
377 /* Windows volume (but not root)? */
378 else if (is_dir_nocase (g, "/System Volume Information") > 0)
379 fs->content = FS_CONTENT_WINDOWS_VOLUME;
384 /* Set fs->product_name to the first line of the release file. */
386 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
387 const char *release_filename)
389 fs->product_name = first_line_of_file (g, release_filename);
390 if (fs->product_name == NULL)
395 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
397 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
401 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
402 fs->major_version = parse_unsigned_int (g, major);
404 if (fs->major_version == -1) {
408 fs->minor_version = parse_unsigned_int (g, minor);
410 if (fs->minor_version == -1)
416 /* Ubuntu has /etc/lsb-release containing:
417 * DISTRIB_ID=Ubuntu # Distro
418 * DISTRIB_RELEASE=10.04 # Version
419 * DISTRIB_CODENAME=lucid
420 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
422 * [Ubuntu-derived ...] Linux Mint was found to have this:
423 * DISTRIB_ID=LinuxMint
425 * DISTRIB_CODENAME=julia
426 * DISTRIB_DESCRIPTION="Linux Mint 10 Julia"
427 * Linux Mint also has /etc/linuxmint/info with more information,
428 * but we can use the LSB file.
431 * LSB_VERSION=lsb-4.0-amd64:lsb-4.0-noarch
432 * DISTRIB_ID=MandrivaLinux
433 * DISTRIB_RELEASE=2010.1
434 * DISTRIB_CODENAME=Henry_Farman
435 * DISTRIB_DESCRIPTION="Mandriva Linux 2010.1"
436 * Mandriva also has a normal release file called /etc/mandriva-release.
439 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
441 const char *filename = "/etc/lsb-release";
447 /* Don't trust guestfs_head_n not to break with very large files.
448 * Check the file size is something reasonable first.
450 size = guestfs_filesize (g, filename);
452 /* guestfs_filesize failed and has already set error in handle */
454 if (size > MAX_SMALL_FILE_SIZE) {
455 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
460 lines = guestfs_head_n (g, 10, filename);
464 for (i = 0; lines[i] != NULL; ++i) {
465 if (fs->distro == 0 &&
466 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
467 fs->distro = OS_DISTRO_UBUNTU;
470 else if (fs->distro == 0 &&
471 STREQ (lines[i], "DISTRIB_ID=LinuxMint")) {
472 fs->distro = OS_DISTRO_LINUX_MINT;
475 else if (fs->distro == 0 &&
476 STREQ (lines[i], "DISTRIB_ID=MandrivaLinux")) {
477 fs->distro = OS_DISTRO_MANDRIVA;
480 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
482 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
483 fs->major_version = parse_unsigned_int (g, major);
485 if (fs->major_version == -1) {
487 guestfs___free_string_list (lines);
490 fs->minor_version = parse_unsigned_int (g, minor);
492 if (fs->minor_version == -1) {
493 guestfs___free_string_list (lines);
498 else if (fs->product_name == NULL &&
499 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
500 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
501 size_t len = strlen (lines[i]) - 21 - 1;
502 fs->product_name = safe_strndup (g, &lines[i][21], len);
505 else if (fs->product_name == NULL &&
506 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
507 size_t len = strlen (lines[i]) - 20;
508 fs->product_name = safe_strndup (g, &lines[i][20], len);
513 guestfs___free_string_list (lines);
517 /* The currently mounted device is known to be a Linux root. Try to
518 * determine from this the distro, version, etc. Also parse
519 * /etc/fstab to determine the arrangement of mountpoints and
520 * associated devices.
523 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
527 fs->type = OS_TYPE_LINUX;
529 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
530 r = parse_lsb_release (g, fs);
531 if (r == -1) /* error */
533 if (r == 1) /* ok - detected the release from this file */
534 goto skip_release_checks;
537 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
538 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
540 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
544 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
545 fs->distro = OS_DISTRO_FEDORA;
546 fs->major_version = parse_unsigned_int (g, major);
548 if (fs->major_version == -1)
551 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
552 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
553 fs->distro = OS_DISTRO_RHEL;
554 fs->major_version = parse_unsigned_int (g, major);
556 if (fs->major_version == -1) {
560 fs->minor_version = parse_unsigned_int (g, minor);
562 if (fs->minor_version == -1)
565 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
566 fs->distro = OS_DISTRO_RHEL;
567 fs->major_version = parse_unsigned_int (g, major);
569 if (fs->major_version == -1)
571 fs->minor_version = 0;
574 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
575 fs->distro = OS_DISTRO_DEBIAN;
577 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
580 if (parse_major_minor (g, fs) == -1)
583 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
584 fs->distro = OS_DISTRO_PARDUS;
586 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
589 if (parse_major_minor (g, fs) == -1)
592 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
593 fs->distro = OS_DISTRO_ARCHLINUX;
595 /* /etc/arch-release file is empty and I can't see a way to
596 * determine the actual release or product string.
599 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
600 fs->distro = OS_DISTRO_GENTOO;
602 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
605 if (parse_major_minor (g, fs) == -1)
608 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
609 fs->distro = OS_DISTRO_MEEGO;
611 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
614 if (parse_major_minor (g, fs) == -1)
618 skip_release_checks:;
620 /* If distro test above was successful, work out the package format. */
621 check_package_format (g, fs);
622 check_package_management (g, fs);
624 /* Determine the architecture. */
625 check_architecture (g, fs);
627 /* We already know /etc/fstab exists because it's part of the test
628 * for Linux root above. We must now parse this file to determine
629 * which filesystems are used by the operating system and how they
632 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
635 /* Determine hostname. */
636 if (check_hostname_unix (g, fs) == -1)
642 /* The currently mounted device is known to be a FreeBSD root. */
644 check_freebsd_root (guestfs_h *g, struct inspect_fs *fs)
646 fs->type = OS_TYPE_FREEBSD;
648 /* FreeBSD has no authoritative version file. The version number is
649 * in /etc/motd, which the system administrator might edit, but
650 * we'll use that anyway.
653 if (guestfs_exists (g, "/etc/motd") > 0) {
654 if (parse_release_file (g, fs, "/etc/motd") == -1)
657 if (parse_major_minor (g, fs) == -1)
661 /* Determine the architecture. */
662 check_architecture (g, fs);
664 /* We already know /etc/fstab exists because it's part of the test above. */
665 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
668 /* Determine hostname. */
669 if (check_hostname_unix (g, fs) == -1)
676 check_architecture (guestfs_h *g, struct inspect_fs *fs)
678 const char *binaries[] =
679 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
682 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
683 if (guestfs_is_file (g, binaries[i]) > 0) {
684 /* Ignore errors from file_architecture call. */
685 guestfs_error_handler_cb old_error_cb = g->error_cb;
687 char *arch = guestfs_file_architecture (g, binaries[i]);
688 g->error_cb = old_error_cb;
691 /* String will be owned by handle, freed by
692 * guestfs___free_inspect_info.
701 /* Try several methods to determine the hostname from a Linux or
702 * FreeBSD guest. Note that type and distro have been set, so we can
703 * use that information to direct the search.
706 check_hostname_unix (guestfs_h *g, struct inspect_fs *fs)
710 /* Red Hat-derived would be in /etc/sysconfig/network, and
711 * Debian-derived in the file /etc/hostname. Very old Debian and
712 * SUSE use /etc/HOSTNAME. It's best to just look for each of
713 * these files in turn, rather than try anything clever based on
716 if (guestfs_is_file (g, "/etc/HOSTNAME")) {
717 fs->hostname = first_line_of_file (g, "/etc/HOSTNAME");
718 if (fs->hostname == NULL)
721 else if (guestfs_is_file (g, "/etc/hostname")) {
722 fs->hostname = first_line_of_file (g, "/etc/hostname");
723 if (fs->hostname == NULL)
726 else if (guestfs_is_file (g, "/etc/sysconfig/network")) {
727 if (inspect_with_augeas (g, fs, "/etc/sysconfig/network",
728 check_hostname_redhat) == -1)
733 case OS_TYPE_FREEBSD:
734 /* /etc/rc.conf contains the hostname, but there is no Augeas lens
737 if (guestfs_is_file (g, "/etc/rc.conf")) {
738 if (check_hostname_freebsd (g, fs) == -1)
743 case OS_TYPE_WINDOWS: /* not here, see check_windows_system_registry */
744 case OS_TYPE_UNKNOWN:
746 /* nothing, keep GCC warnings happy */;
752 /* Parse the hostname from /etc/sysconfig/network. This must be called
753 * from the inspect_with_augeas wrapper.
756 check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs)
760 /* Errors here are not fatal (RHBZ#726739), since it could be
761 * just missing HOSTNAME field in the file.
763 guestfs_error_handler_cb old_error_cb = g->error_cb;
765 hostname = guestfs_aug_get (g, "/files/etc/sysconfig/network/HOSTNAME");
766 g->error_cb = old_error_cb;
768 /* This is freed by guestfs___free_inspect_info. Note that hostname
769 * could be NULL because we ignored errors above.
771 fs->hostname = hostname;
775 /* Parse the hostname from /etc/rc.conf. On FreeBSD this file
776 * contains comments, blank lines and:
777 * hostname="freebsd8.example.com"
778 * ifconfig_re0="DHCP"
783 check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs)
785 const char *filename = "/etc/rc.conf";
790 /* Don't trust guestfs_read_lines not to break with very large files.
791 * Check the file size is something reasonable first.
793 size = guestfs_filesize (g, filename);
795 /* guestfs_filesize failed and has already set error in handle */
797 if (size > MAX_SMALL_FILE_SIZE) {
798 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
803 lines = guestfs_read_lines (g, filename);
807 for (i = 0; lines[i] != NULL; ++i) {
808 if (STRPREFIX (lines[i], "hostname=\"") ||
809 STRPREFIX (lines[i], "hostname='")) {
810 size_t len = strlen (lines[i]) - 10 - 1;
811 fs->hostname = safe_strndup (g, &lines[i][10], len);
813 } else if (STRPREFIX (lines[i], "hostname=")) {
814 size_t len = strlen (lines[i]) - 9;
815 fs->hostname = safe_strndup (g, &lines[i][9], len);
820 guestfs___free_string_list (lines);
825 check_fstab (guestfs_h *g, struct inspect_fs *fs)
827 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
831 if (lines[0] == NULL) {
832 error (g, _("could not parse /etc/fstab or empty file"));
833 guestfs___free_string_list (lines);
839 for (i = 0; lines[i] != NULL; ++i) {
840 /* Ignore comments. Only care about sequence lines which
843 if (match (g, lines[i], re_aug_seq)) {
844 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
845 char *spec = guestfs_aug_get (g, augpath);
847 guestfs___free_string_list (lines);
851 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
852 char *mp = guestfs_aug_get (g, augpath);
854 guestfs___free_string_list (lines);
859 int r = add_fstab_entry (g, fs, spec, mp);
864 guestfs___free_string_list (lines);
870 guestfs___free_string_list (lines);
874 /* Add a filesystem and possibly a mountpoint entry for
875 * the root filesystem 'fs'.
877 * 'spec' is the fstab spec field, which might be a device name or a
878 * pseudodevice or 'UUID=...' or 'LABEL=...'.
880 * 'mp' is the mount point, which could also be 'swap' or 'none'.
883 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
884 const char *spec, const char *mp)
886 /* Ignore certain mountpoints. */
887 if (STRPREFIX (mp, "/dev/") ||
888 STREQ (mp, "/dev") ||
889 STRPREFIX (mp, "/media/") ||
890 STRPREFIX (mp, "/proc/") ||
891 STREQ (mp, "/proc") ||
892 STRPREFIX (mp, "/selinux/") ||
893 STREQ (mp, "/selinux") ||
894 STRPREFIX (mp, "/sys/") ||
898 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
899 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
900 STREQ (spec, "/dev/floppy") ||
901 STREQ (spec, "/dev/cdrom"))
904 /* Resolve UUID= and LABEL= to the actual device. */
906 if (STRPREFIX (spec, "UUID="))
907 device = guestfs_findfs_uuid (g, &spec[5]);
908 else if (STRPREFIX (spec, "LABEL="))
909 device = guestfs_findfs_label (g, &spec[6]);
910 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
911 else if (STRPREFIX (spec, "/dev/"))
912 /* Resolve guest block device names. */
913 device = resolve_fstab_device (g, spec);
915 /* If we haven't resolved the device successfully by this point,
916 * we don't care, just ignore it.
921 char *mountpoint = safe_strdup (g, mp);
923 /* Add this to the fstab entry in 'fs'.
924 * Note these are further filtered by guestfs_inspect_get_mountpoints
925 * and guestfs_inspect_get_filesystems.
927 size_t n = fs->nr_fstab + 1;
928 struct inspect_fstab_entry *p;
930 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
932 perrorf (g, "realloc");
941 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
942 fs->fstab[n-1].device = device;
943 fs->fstab[n-1].mountpoint = mountpoint;
946 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
951 /* Resolve block device name to the libguestfs device name, eg.
952 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
953 * assumes that disks were added in the same order as they appear to
954 * the real VM, which is a reasonable assumption to make. Return
955 * anything we don't recognize unchanged.
958 resolve_fstab_device (guestfs_h *g, const char *spec)
962 char *bsddisk, *bsdslice, *bsdpart;
964 if (STRPREFIX (spec, "/dev/mapper/")) {
965 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
966 * LVs which contain '-' character:
968 * ><fs> lvcreate LV--test VG--test 32
969 * ><fs> debug ls /dev/mapper
970 * VG----test-LV----test
972 * This makes it impossible to reverse those paths directly, so
973 * we have implemented lvm_canonical_lv_name in the daemon.
975 device = guestfs_lvm_canonical_lv_name (g, spec);
977 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
978 char **devices = guestfs_list_devices (g);
983 for (count = 0; devices[count] != NULL; count++)
986 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
988 size_t len = strlen (devices[i]) + strlen (a1) + 16;
989 device = safe_malloc (g, len);
990 snprintf (device, len, "%s%s", devices[i], &a1[1]);
994 guestfs___free_string_list (devices);
996 else if (match3 (g, spec, re_freebsd, &bsddisk, &bsdslice, &bsdpart)) {
997 /* FreeBSD disks are organized quite differently. See:
998 * http://www.freebsd.org/doc/handbook/disk-organization.html
999 * FreeBSD "partitions" are exposed as quasi-extended partitions
1000 * numbered from 5 in Linux. I have no idea what happens when you
1001 * have multiple "slices" (the FreeBSD term for MBR partitions).
1003 int disk = parse_unsigned_int (g, bsddisk);
1004 int slice = parse_unsigned_int (g, bsdslice);
1005 int part = bsdpart[0] - 'a' /* counting from 0 */;
1010 if (disk == -1 || disk > 26 ||
1011 slice <= 0 || slice > 1 /* > 4 .. see comment above */ ||
1012 part < 0 || part >= 26)
1015 device = safe_asprintf (g, "/dev/sd%c%d", disk + 'a', part + 5);
1019 /* Didn't match device pattern, return original spec unchanged. */
1021 device = safe_strdup (g, spec);
1026 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
1027 * essentially didn't do anything for modern Windows guests.
1028 * Therefore I've omitted all that code.
1031 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
1033 fs->type = OS_TYPE_WINDOWS;
1034 fs->distro = OS_DISTRO_WINDOWS;
1036 /* Try to find Windows systemroot using some common locations. */
1037 const char *systemroots[] =
1038 { "/windows", "/winnt", "/win32", "/win" };
1040 char *systemroot = NULL;
1042 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
1044 systemroot = case_sensitive_path_silently (g, systemroots[i]);
1048 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
1053 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
1055 /* Freed by guestfs___free_inspect_info. */
1056 fs->windows_systemroot = systemroot;
1058 if (check_windows_arch (g, fs) == -1)
1061 /* Product name and version. */
1062 if (check_windows_software_registry (g, fs) == -1)
1065 check_package_format (g, fs);
1066 check_package_management (g, fs);
1069 if (check_windows_system_registry (g, fs) == -1)
1076 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1078 size_t len = strlen (fs->windows_systemroot) + 32;
1080 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1082 char *cmd_exe_path = case_sensitive_path_silently (g, cmd_exe);
1086 char *arch = guestfs_file_architecture (g, cmd_exe_path);
1087 free (cmd_exe_path);
1090 fs->arch = arch; /* freed by guestfs___free_inspect_info */
1095 /* At the moment, pull just the ProductName and version numbers from
1096 * the registry. In future there is a case for making many more
1097 * registry fields available to callers.
1100 check_windows_software_registry (guestfs_h *g, struct inspect_fs *fs)
1102 TMP_TEMPLATE_ON_STACK (software_local);
1104 size_t len = strlen (fs->windows_systemroot) + 64;
1106 snprintf (software, len, "%s/system32/config/software",
1107 fs->windows_systemroot);
1109 char *software_path = case_sensitive_path_silently (g, software);
1111 /* If the software hive doesn't exist, just accept that we cannot
1112 * find product_name etc.
1118 hive_value_h *values = NULL;
1120 if (download_to_tmp (g, software_path, software_local,
1121 MAX_REGISTRY_SIZE) == -1)
1124 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1126 perrorf (g, "hivex_open");
1130 hive_node_h node = hivex_root (h);
1131 const char *hivepath[] =
1132 { "Microsoft", "Windows NT", "CurrentVersion" };
1135 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1137 node = hivex_node_get_child (h, node, hivepath[i]);
1141 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1145 values = hivex_node_values (h, node);
1147 for (i = 0; values[i] != 0; ++i) {
1148 char *key = hivex_value_key (h, values[i]);
1150 perrorf (g, "hivex_value_key");
1154 if (STRCASEEQ (key, "ProductName")) {
1155 fs->product_name = hivex_value_string (h, values[i]);
1156 if (!fs->product_name) {
1157 perrorf (g, "hivex_value_string");
1162 else if (STRCASEEQ (key, "CurrentVersion")) {
1163 char *version = hivex_value_string (h, values[i]);
1165 perrorf (g, "hivex_value_string");
1169 char *major, *minor;
1170 if (match2 (g, version, re_windows_version, &major, &minor)) {
1171 fs->major_version = parse_unsigned_int (g, major);
1173 if (fs->major_version == -1) {
1179 fs->minor_version = parse_unsigned_int (g, minor);
1181 if (fs->minor_version == -1) {
1197 if (h) hivex_close (h);
1199 free (software_path);
1201 /* Free up the temporary file. */
1202 unlink (software_local);
1203 #undef software_local_len
1209 check_windows_system_registry (guestfs_h *g, struct inspect_fs *fs)
1211 TMP_TEMPLATE_ON_STACK (system_local);
1213 size_t len = strlen (fs->windows_systemroot) + 64;
1215 snprintf (system, len, "%s/system32/config/system",
1216 fs->windows_systemroot);
1218 char *system_path = case_sensitive_path_silently (g, system);
1220 /* If the system hive doesn't exist, just accept that we cannot
1221 * find hostname etc.
1227 hive_value_h *values = NULL;
1229 if (download_to_tmp (g, system_path, system_local, MAX_REGISTRY_SIZE) == -1)
1232 h = hivex_open (system_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1234 perrorf (g, "hivex_open");
1238 hive_node_h node = hivex_root (h);
1239 /* XXX Don't hard-code ControlSet001. The current control set would
1240 * be another good thing to expose up through the inspection API.
1242 const char *hivepath[] =
1243 { "ControlSet001", "Services", "Tcpip", "Parameters" };
1246 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1248 node = hivex_node_get_child (h, node, hivepath[i]);
1252 perrorf (g, "hivex: cannot locate HKLM\\SYSTEM\\ControlSet001\\Services\\Tcpip\\Parameters");
1256 values = hivex_node_values (h, node);
1258 for (i = 0; values[i] != 0; ++i) {
1259 char *key = hivex_value_key (h, values[i]);
1261 perrorf (g, "hivex_value_key");
1265 if (STRCASEEQ (key, "Hostname")) {
1266 fs->hostname = hivex_value_string (h, values[i]);
1267 if (!fs->hostname) {
1268 perrorf (g, "hivex_value_string");
1273 /* many other interesting fields here ... */
1281 if (h) hivex_close (h);
1285 /* Free up the temporary file. */
1286 unlink (system_local);
1287 #undef system_local_len
1293 case_sensitive_path_silently (guestfs_h *g, const char *path)
1295 guestfs_error_handler_cb old_error_cb = g->error_cb;
1297 char *ret = guestfs_case_sensitive_path (g, path);
1298 g->error_cb = old_error_cb;
1303 is_file_nocase (guestfs_h *g, const char *path)
1308 p = case_sensitive_path_silently (g, path);
1311 r = guestfs_is_file (g, p);
1317 is_dir_nocase (guestfs_h *g, const char *path)
1322 p = case_sensitive_path_silently (g, path);
1325 r = guestfs_is_dir (g, p);
1331 extend_fses (guestfs_h *g)
1333 size_t n = g->nr_fses + 1;
1334 struct inspect_fs *p;
1336 p = realloc (g->fses, n * sizeof (struct inspect_fs));
1338 perrorf (g, "realloc");
1345 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1350 /* Parse small, unsigned ints, as used in version numbers. */
1352 parse_unsigned_int (guestfs_h *g, const char *str)
1355 int r = xstrtol (str, NULL, 10, &ret, "");
1356 if (r != LONGINT_OK) {
1357 error (g, _("could not parse integer in version number: %s"), str);
1363 /* At the moment, package format and package management is just a
1364 * simple function of the distro and major_version fields, so these
1365 * can never return an error. We might be cleverer in future.
1368 check_package_format (guestfs_h *g, struct inspect_fs *fs)
1370 switch (fs->distro) {
1371 case OS_DISTRO_FEDORA:
1372 case OS_DISTRO_MEEGO:
1373 case OS_DISTRO_REDHAT_BASED:
1374 case OS_DISTRO_RHEL:
1375 case OS_DISTRO_MANDRIVA:
1376 fs->package_format = OS_PACKAGE_FORMAT_RPM;
1379 case OS_DISTRO_DEBIAN:
1380 case OS_DISTRO_UBUNTU:
1381 case OS_DISTRO_LINUX_MINT:
1382 fs->package_format = OS_PACKAGE_FORMAT_DEB;
1385 case OS_DISTRO_ARCHLINUX:
1386 fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
1388 case OS_DISTRO_GENTOO:
1389 fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
1391 case OS_DISTRO_PARDUS:
1392 fs->package_format = OS_PACKAGE_FORMAT_PISI;
1395 case OS_DISTRO_WINDOWS:
1396 case OS_DISTRO_UNKNOWN:
1398 fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
1404 check_package_management (guestfs_h *g, struct inspect_fs *fs)
1406 switch (fs->distro) {
1407 case OS_DISTRO_FEDORA:
1408 case OS_DISTRO_MEEGO:
1409 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1412 case OS_DISTRO_REDHAT_BASED:
1413 case OS_DISTRO_RHEL:
1414 if (fs->major_version >= 5)
1415 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1417 fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
1420 case OS_DISTRO_DEBIAN:
1421 case OS_DISTRO_UBUNTU:
1422 case OS_DISTRO_LINUX_MINT:
1423 fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
1426 case OS_DISTRO_ARCHLINUX:
1427 fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
1429 case OS_DISTRO_GENTOO:
1430 fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
1432 case OS_DISTRO_PARDUS:
1433 fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
1435 case OS_DISTRO_MANDRIVA:
1436 fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
1439 case OS_DISTRO_WINDOWS:
1440 case OS_DISTRO_UNKNOWN:
1442 fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
1447 static struct inspect_fs *
1448 search_for_root (guestfs_h *g, const char *root)
1450 if (g->nr_fses == 0) {
1451 error (g, _("no inspection data: call guestfs_inspect_os first"));
1456 struct inspect_fs *fs;
1457 for (i = 0; i < g->nr_fses; ++i) {
1459 if (fs->is_root && STREQ (root, fs->device))
1463 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1469 guestfs__inspect_get_roots (guestfs_h *g)
1471 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
1472 * list in this case.
1477 for (i = 0; i < g->nr_fses; ++i)
1478 if (g->fses[i].is_root)
1481 char **ret = calloc (count+1, sizeof (char *));
1483 perrorf (g, "calloc");
1488 for (i = 0; i < g->nr_fses; ++i) {
1489 if (g->fses[i].is_root) {
1490 ret[count] = safe_strdup (g, g->fses[i].device);
1500 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1502 struct inspect_fs *fs = search_for_root (g, root);
1508 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1509 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1510 case OS_TYPE_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
1511 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1518 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1520 struct inspect_fs *fs = search_for_root (g, root);
1524 return safe_strdup (g, fs->arch ? : "unknown");
1528 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1530 struct inspect_fs *fs = search_for_root (g, root);
1535 switch (fs->distro) {
1536 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1537 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1538 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1539 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1540 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
1541 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
1542 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1543 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1544 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1545 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1546 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1547 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1548 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1555 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1557 struct inspect_fs *fs = search_for_root (g, root);
1561 return fs->major_version;
1565 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1567 struct inspect_fs *fs = search_for_root (g, root);
1571 return fs->minor_version;
1575 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1577 struct inspect_fs *fs = search_for_root (g, root);
1581 return safe_strdup (g, fs->product_name ? : "unknown");
1585 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1587 struct inspect_fs *fs = search_for_root (g, root);
1591 if (!fs->windows_systemroot) {
1592 error (g, _("not a Windows guest, or systemroot could not be determined"));
1596 return safe_strdup (g, fs->windows_systemroot);
1600 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1602 struct inspect_fs *fs = search_for_root (g, root);
1608 /* If no fstab information (Windows) return just the root. */
1609 if (fs->nr_fstab == 0) {
1610 ret = calloc (3, sizeof (char *));
1611 ret[0] = safe_strdup (g, "/");
1612 ret[1] = safe_strdup (g, root);
1617 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1618 size_t i, count = 0;
1619 for (i = 0; i < fs->nr_fstab; ++i)
1623 /* Hashtables have 2N+1 entries. */
1624 ret = calloc (2*count+1, sizeof (char *));
1626 perrorf (g, "calloc");
1631 for (i = 0; i < fs->nr_fstab; ++i)
1633 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1634 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1643 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1645 struct inspect_fs *fs = search_for_root (g, root);
1651 /* If no fstab information (Windows) return just the root. */
1652 if (fs->nr_fstab == 0) {
1653 ret = calloc (2, sizeof (char *));
1654 ret[0] = safe_strdup (g, root);
1659 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1661 perrorf (g, "calloc");
1666 for (i = 0; i < fs->nr_fstab; ++i)
1667 ret[i] = safe_strdup (g, fs->fstab[i].device);
1673 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
1675 struct inspect_fs *fs = search_for_root (g, root);
1680 switch (fs->package_format) {
1681 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
1682 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
1683 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1684 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
1685 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
1686 case OS_PACKAGE_FORMAT_UNKNOWN:
1688 ret = safe_strdup (g, "unknown");
1696 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
1698 struct inspect_fs *fs = search_for_root (g, root);
1703 switch (fs->package_management) {
1704 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
1705 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
1706 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
1707 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1708 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
1709 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
1710 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
1711 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
1713 ret = safe_strdup (g, "unknown");
1721 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
1723 struct inspect_fs *fs = search_for_root (g, root);
1727 return safe_strdup (g, fs->hostname ? : "unknown");
1731 static struct guestfs_application_list *list_applications_rpm (guestfs_h *g, struct inspect_fs *fs);
1733 static struct guestfs_application_list *list_applications_deb (guestfs_h *g, struct inspect_fs *fs);
1734 static struct guestfs_application_list *list_applications_windows (guestfs_h *g, struct inspect_fs *fs);
1735 static void add_application (guestfs_h *g, struct guestfs_application_list *, const char *name, const char *display_name, int32_t epoch, const char *version, const char *release, const char *install_path, const char *publisher, const char *url, const char *description);
1736 static void sort_applications (struct guestfs_application_list *);
1738 /* Unlike the simple inspect-get-* calls, this one assumes that the
1739 * disks are mounted up, and reads files from the mounted disks.
1741 struct guestfs_application_list *
1742 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
1744 struct inspect_fs *fs = search_for_root (g, root);
1748 struct guestfs_application_list *ret = NULL;
1752 switch (fs->package_format) {
1753 case OS_PACKAGE_FORMAT_RPM:
1755 ret = list_applications_rpm (g, fs);
1761 case OS_PACKAGE_FORMAT_DEB:
1762 ret = list_applications_deb (g, fs);
1767 case OS_PACKAGE_FORMAT_PACMAN:
1768 case OS_PACKAGE_FORMAT_EBUILD:
1769 case OS_PACKAGE_FORMAT_PISI:
1770 case OS_PACKAGE_FORMAT_UNKNOWN:
1772 /* nothing - keep GCC happy */;
1776 case OS_TYPE_WINDOWS:
1777 ret = list_applications_windows (g, fs);
1782 case OS_TYPE_FREEBSD:
1783 case OS_TYPE_UNKNOWN:
1785 /* nothing - keep GCC happy */;
1789 /* Don't know how to do inspection. Not an error, return an
1792 ret = safe_malloc (g, sizeof *ret);
1797 sort_applications (ret);
1803 static struct guestfs_application_list *
1804 list_applications_rpm (guestfs_h *g, struct inspect_fs *fs)
1806 TMP_TEMPLATE_ON_STACK (tmpfile);
1808 if (download_to_tmp (g, "/var/lib/rpm/Name", tmpfile, MAX_PKG_DB_SIZE) == -1)
1811 struct guestfs_application_list *apps = NULL, *ret = NULL;
1812 #define cmd_len (strlen (tmpfile) + 64)
1818 snprintf (cmd, cmd_len, DB_DUMP " -p '%s'", tmpfile);
1821 fprintf (stderr, "list_applications_rpm: %s\n", cmd);
1823 pp = popen (cmd, "r");
1825 perrorf (g, "popen: %s", cmd);
1829 /* Ignore everything to end-of-header marker. */
1831 if (fgets (line, sizeof line, pp) == NULL) {
1832 error (g, _("unexpected end of output from db_dump command"));
1836 len = strlen (line);
1837 if (len > 0 && line[len-1] == '\n') {
1842 if (STREQ (line, "HEADER=END"))
1846 /* Allocate 'apps' list. */
1847 apps = safe_malloc (g, sizeof *apps);
1851 /* Read alternate lines until end of data marker. */
1853 if (fgets (line, sizeof line, pp) == NULL) {
1854 error (g, _("unexpected end of output from db_dump command"));
1858 len = strlen (line);
1859 if (len > 0 && line[len-1] == '\n') {
1864 if (STREQ (line, "DATA=END"))
1868 if (len > 0 && line[0] == ' ')
1870 /* Ignore any application name that contains non-printable chars.
1871 * In the db_dump output these would be escaped with backslash, so
1872 * we can just ignore any such line.
1874 if (strchr (p, '\\') == NULL)
1875 add_application (g, apps, p, "", 0, "", "", "", "", "", "");
1877 /* Discard next line. */
1878 if (fgets (line, sizeof line, pp) == NULL) {
1879 error (g, _("unexpected end of output from db_dump command"));
1884 /* Catch errors from the db_dump command. */
1885 if (pclose (pp) == -1) {
1886 perrorf (g, "pclose: %s", cmd);
1894 if (ret == NULL && apps != NULL)
1895 guestfs_free_application_list (apps);
1903 #endif /* defined DB_DUMP */
1905 static struct guestfs_application_list *
1906 list_applications_deb (guestfs_h *g, struct inspect_fs *fs)
1908 TMP_TEMPLATE_ON_STACK (tmpfile);
1910 if (download_to_tmp (g, "/var/lib/dpkg/status", tmpfile,
1911 MAX_PKG_DB_SIZE) == -1)
1914 struct guestfs_application_list *apps = NULL, *ret = NULL;
1918 char *name = NULL, *version = NULL, *release = NULL;
1919 int installed_flag = 0;
1921 fp = fopen (tmpfile, "r");
1923 perrorf (g, "fopen: %s", tmpfile);
1927 /* Allocate 'apps' list. */
1928 apps = safe_malloc (g, sizeof *apps);
1932 /* Read the temporary file. Each package entry is separated by
1934 * XXX Strictly speaking this is in mailbox header format, so it
1935 * would be possible for fields to spread across multiple lines,
1936 * although for the short fields that we are concerned about this is
1937 * unlikely and not seen in practice.
1939 while (fgets (line, sizeof line, fp) != NULL) {
1940 len = strlen (line);
1941 if (len > 0 && line[len-1] == '\n') {
1946 if (STRPREFIX (line, "Package: ")) {
1948 name = safe_strdup (g, &line[9]);
1950 else if (STRPREFIX (line, "Status: ")) {
1951 installed_flag = strstr (&line[8], "installed") != NULL;
1953 else if (STRPREFIX (line, "Version: ")) {
1956 char *p = strchr (&line[9], '-');
1959 version = safe_strdup (g, &line[9]);
1960 release = safe_strdup (g, p+1);
1962 version = safe_strdup (g, &line[9]);
1966 else if (STREQ (line, "")) {
1967 if (installed_flag && name && version)
1968 add_application (g, apps, name, "", 0, version, release ? : "",
1973 name = version = release = NULL;
1978 if (fclose (fp) == -1) {
1979 perrorf (g, "fclose: %s", tmpfile);
1987 if (ret == NULL && apps != NULL)
1988 guestfs_free_application_list (apps);
1998 /* XXX We already download the SOFTWARE hive when doing general
1999 * inspection. We could avoid this second download of the same file
2000 * by caching these entries in the handle.
2002 static struct guestfs_application_list *
2003 list_applications_windows (guestfs_h *g, struct inspect_fs *fs)
2005 TMP_TEMPLATE_ON_STACK (software_local);
2007 size_t len = strlen (fs->windows_systemroot) + 64;
2009 snprintf (software, len, "%s/system32/config/software",
2010 fs->windows_systemroot);
2012 char *software_path = case_sensitive_path_silently (g, software);
2013 if (!software_path) {
2014 /* Missing software hive is a problem. */
2015 error (g, "no HKLM\\SOFTWARE hive found in the guest");
2019 struct guestfs_application_list *apps = NULL, *ret = NULL;
2021 hive_node_h *children = NULL;
2023 if (download_to_tmp (g, software_path, software_local,
2024 MAX_REGISTRY_SIZE) == -1)
2027 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
2029 perrorf (g, "hivex_open");
2033 hive_node_h node = hivex_root (h);
2034 const char *hivepath[] =
2035 { "Microsoft", "Windows", "CurrentVersion", "Uninstall" };
2038 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
2040 node = hivex_node_get_child (h, node, hivepath[i]);
2044 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall");
2048 children = hivex_node_children (h, node);
2049 if (children == NULL) {
2050 perrorf (g, "hivex_node_children");
2054 /* Allocate 'apps' list. */
2055 apps = safe_malloc (g, sizeof *apps);
2059 /* Consider any child node that has a DisplayName key.
2061 * http://nsis.sourceforge.net/Add_uninstall_information_to_Add/Remove_Programs#Optional_values
2063 for (i = 0; children[i] != 0; ++i) {
2066 char *display_name = NULL;
2067 char *version = NULL;
2068 char *install_path = NULL;
2069 char *publisher = NULL;
2071 char *comments = NULL;
2073 /* Use the node name as a proxy for the package name in Linux. The
2074 * display name is not language-independent, so it cannot be used.
2076 name = hivex_node_name (h, children[i]);
2078 perrorf (g, "hivex_node_get_name");
2082 value = hivex_node_get_value (h, children[i], "DisplayName");
2084 display_name = hivex_value_string (h, value);
2086 value = hivex_node_get_value (h, children[i], "DisplayVersion");
2088 version = hivex_value_string (h, value);
2089 value = hivex_node_get_value (h, children[i], "InstallLocation");
2091 install_path = hivex_value_string (h, value);
2092 value = hivex_node_get_value (h, children[i], "Publisher");
2094 publisher = hivex_value_string (h, value);
2095 value = hivex_node_get_value (h, children[i], "URLInfoAbout");
2097 url = hivex_value_string (h, value);
2098 value = hivex_node_get_value (h, children[i], "Comments");
2100 comments = hivex_value_string (h, value);
2102 add_application (g, apps, name, display_name, 0,
2105 install_path ? : "",
2113 free (display_name);
2115 free (install_path);
2124 if (ret == NULL && apps != NULL)
2125 guestfs_free_application_list (apps);
2126 if (h) hivex_close (h);
2128 free (software_path);
2130 /* Free up the temporary file. */
2131 unlink (software_local);
2132 #undef software_local_len
2138 add_application (guestfs_h *g, struct guestfs_application_list *apps,
2139 const char *name, const char *display_name, int32_t epoch,
2140 const char *version, const char *release,
2141 const char *install_path,
2142 const char *publisher, const char *url,
2143 const char *description)
2146 apps->val = safe_realloc (g, apps->val,
2147 apps->len * sizeof (struct guestfs_application));
2148 apps->val[apps->len-1].app_name = safe_strdup (g, name);
2149 apps->val[apps->len-1].app_display_name = safe_strdup (g, display_name);
2150 apps->val[apps->len-1].app_epoch = epoch;
2151 apps->val[apps->len-1].app_version = safe_strdup (g, version);
2152 apps->val[apps->len-1].app_release = safe_strdup (g, release);
2153 apps->val[apps->len-1].app_install_path = safe_strdup (g, install_path);
2154 /* XXX Translated path is not implemented yet. */
2155 apps->val[apps->len-1].app_trans_path = safe_strdup (g, "");
2156 apps->val[apps->len-1].app_publisher = safe_strdup (g, publisher);
2157 apps->val[apps->len-1].app_url = safe_strdup (g, url);
2158 /* XXX The next two are not yet implemented for any package
2159 * format, but we could easily support them for rpm and deb.
2161 apps->val[apps->len-1].app_source_package = safe_strdup (g, "");
2162 apps->val[apps->len-1].app_summary = safe_strdup (g, "");
2163 apps->val[apps->len-1].app_description = safe_strdup (g, description);
2166 /* Sort applications by name before returning the list. */
2168 compare_applications (const void *vp1, const void *vp2)
2170 const struct guestfs_application *v1 = vp1;
2171 const struct guestfs_application *v2 = vp2;
2173 return strcmp (v1->app_name, v2->app_name);
2177 sort_applications (struct guestfs_application_list *apps)
2179 if (apps && apps->val)
2180 qsort (apps->val, apps->len, sizeof (struct guestfs_application),
2181 compare_applications);
2184 /* Download to a guest file to a local temporary file. Refuse to
2185 * download the guest file if it is larger than max_size. The caller
2186 * is responsible for deleting the temporary file after use.
2189 download_to_tmp (guestfs_h *g, const char *filename,
2190 char *localtmp, int64_t max_size)
2196 size = guestfs_filesize (g, filename);
2198 /* guestfs_filesize failed and has already set error in handle */
2200 if (size > max_size) {
2201 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2206 fd = mkstemp (localtmp);
2208 perrorf (g, "mkstemp");
2212 snprintf (buf, sizeof buf, "/dev/fd/%d", fd);
2214 if (guestfs_download (g, filename, buf) == -1) {
2220 if (close (fd) == -1) {
2221 perrorf (g, "close: %s", localtmp);
2229 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
2230 * must exist). As a security measure, this bails if the file is too
2231 * large for a reasonable configuration file. After the call to 'f'
2235 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
2236 int (*f) (guestfs_h *, struct inspect_fs *))
2238 /* Security: Refuse to do this if filename is too large. */
2239 int64_t size = guestfs_filesize (g, filename);
2241 /* guestfs_filesize failed and has already set error in handle */
2243 if (size > MAX_AUGEAS_FILE_SIZE) {
2244 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2249 /* If !feature_available (g, "augeas") then the next call will fail.
2250 * Arguably we might want to fall back to a non-Augeas method in
2253 if (guestfs_aug_init (g, "/", 16|32) == -1)
2258 /* Tell Augeas to only load one file (thanks Raphaël Pinson). */
2259 char buf[strlen (filename) + 64];
2260 snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
2262 if (guestfs_aug_rm (g, buf) == -1)
2265 if (guestfs_aug_load (g) == -1)
2271 guestfs_aug_close (g);
2276 /* Get the first line of a small file, without any trailing newline
2280 first_line_of_file (guestfs_h *g, const char *filename)
2286 /* Don't trust guestfs_head_n not to break with very large files.
2287 * Check the file size is something reasonable first.
2289 size = guestfs_filesize (g, filename);
2291 /* guestfs_filesize failed and has already set error in handle */
2293 if (size > MAX_SMALL_FILE_SIZE) {
2294 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2299 lines = guestfs_head_n (g, 1, filename);
2302 if (lines[0] == NULL) {
2303 error (g, _("%s: file is empty"), filename);
2304 guestfs___free_string_list (lines);
2307 /* lines[1] should be NULL because of '1' argument above ... */
2309 ret = lines[0]; /* caller frees */
2310 free (lines); /* free the array */
2315 #else /* no PCRE or hivex at compile time */
2317 /* XXX These functions should be in an optgroup. */
2319 #define NOT_IMPL(r) \
2320 error (g, _("inspection API not available since this version of libguestfs was compiled without PCRE or hivex libraries")); \
2324 guestfs__inspect_os (guestfs_h *g)
2330 guestfs__inspect_get_roots (guestfs_h *g)
2336 guestfs__inspect_get_type (guestfs_h *g, const char *root)
2342 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
2348 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
2354 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
2360 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
2366 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
2372 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
2378 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
2384 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
2390 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
2396 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
2402 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
2407 struct guestfs_application_list *
2408 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
2414 guestfs__inspect_get_format (guestfs_h *g, const char *root)
2420 guestfs__inspect_is_live (guestfs_h *g, const char *root)
2426 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
2432 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
2437 #endif /* no PCRE or hivex at compile time */
2440 guestfs___free_inspect_info (guestfs_h *g)
2443 for (i = 0; i < g->nr_fses; ++i) {
2444 free (g->fses[i].device);
2445 free (g->fses[i].product_name);
2446 free (g->fses[i].arch);
2447 free (g->fses[i].hostname);
2448 free (g->fses[i].windows_systemroot);
2450 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
2451 free (g->fses[i].fstab[j].device);
2452 free (g->fses[i].fstab[j].mountpoint);
2454 free (g->fses[i].fstab);
2461 /* In the Perl code this is a public function. */
2463 guestfs___feature_available (guestfs_h *g, const char *feature)
2465 /* If there's an error we should ignore it, so to do that we have to
2466 * temporarily replace the error handler with a null one.
2468 guestfs_error_handler_cb old_error_cb = g->error_cb;
2471 const char *groups[] = { feature, NULL };
2472 int r = guestfs_available (g, (char * const *) groups);
2474 g->error_cb = old_error_cb;
2476 return r == 0 ? 1 : 0;
2481 /* Match a regular expression which contains no captures. Returns
2482 * true if it matches or false if it doesn't.
2485 guestfs___match (guestfs_h *g, const char *str, const pcre *re)
2487 size_t len = strlen (str);
2490 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2491 if (r == PCRE_ERROR_NOMATCH)
2494 /* Internal error -- should not happen. */
2495 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2496 __FILE__, __func__, r, str);
2503 /* Match a regular expression which contains exactly one capture. If
2504 * the string matches, return the capture, otherwise return NULL. The
2505 * caller must free the result.
2508 guestfs___match1 (guestfs_h *g, const char *str, const pcre *re)
2510 size_t len = strlen (str);
2513 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2514 if (r == PCRE_ERROR_NOMATCH)
2517 /* Internal error -- should not happen. */
2518 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2519 __FILE__, __func__, r, str);
2523 return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2526 /* Match a regular expression which contains exactly two captures. */
2528 guestfs___match2 (guestfs_h *g, const char *str, const pcre *re,
2529 char **ret1, char **ret2)
2531 size_t len = strlen (str);
2534 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
2535 if (r == PCRE_ERROR_NOMATCH)
2538 /* Internal error -- should not happen. */
2539 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2540 __FILE__, __func__, r, str);
2544 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2545 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2550 /* Match a regular expression which contains exactly three captures. */
2552 guestfs___match3 (guestfs_h *g, const char *str, const pcre *re,
2553 char **ret1, char **ret2, char **ret3)
2555 size_t len = strlen (str);
2558 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
2559 if (r == PCRE_ERROR_NOMATCH)
2562 /* Internal error -- should not happen. */
2563 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2564 __FILE__, __func__, r, str);
2568 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2569 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2570 *ret3 = safe_strndup (g, &str[vec[6]], vec[7]-vec[6]);
2575 #endif /* HAVE_PCRE */