2 * Copyright (C) 2010 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 Enterprise Linux|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
111 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
112 COMPILE (re_rhel_no_minor,
113 "(?:Red Hat Enterprise Linux|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 *resolve_windows_path_silently (guestfs_h *g, const char *);
232 static int extend_fses (guestfs_h *g);
233 static int parse_unsigned_int (guestfs_h *g, const char *str);
234 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
235 const char *spec, const char *mp);
236 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
237 static void check_package_format (guestfs_h *g, struct inspect_fs *fs);
238 static void check_package_management (guestfs_h *g, struct inspect_fs *fs);
239 static int download_to_tmp (guestfs_h *g, const char *filename, char *localtmp, int64_t max_size);
240 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
241 static char *first_line_of_file (guestfs_h *g, const char *filename);
244 check_for_filesystem_on (guestfs_h *g, const char *device)
246 /* Get vfs-type in order to check if it's a Linux(?) swap device.
247 * If there's an error we should ignore it, so to do that we have to
248 * temporarily replace the error handler with a null one.
250 guestfs_error_handler_cb old_error_cb = g->error_cb;
252 char *vfs_type = guestfs_vfs_type (g, device);
253 g->error_cb = old_error_cb;
255 int is_swap = vfs_type && STREQ (vfs_type, "swap");
258 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
259 device, vfs_type ? vfs_type : "failed to get vfs type");
263 if (extend_fses (g) == -1)
265 g->fses[g->nr_fses-1].is_swap = 1;
269 /* Try mounting the device. As above, ignore errors. */
271 int r = guestfs_mount_ro (g, device, "/");
272 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
273 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
275 g->error_cb = old_error_cb;
279 /* Do the rest of the checks. */
280 r = check_filesystem (g, device);
282 /* Unmount the filesystem. */
283 if (guestfs_umount_all (g) == -1)
290 check_filesystem (guestfs_h *g, const char *device)
292 if (extend_fses (g) == -1)
295 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
297 fs->device = safe_strdup (g, device);
298 fs->is_mountable = 1;
300 /* Optimize some of the tests by avoiding multiple tests of the same thing. */
301 int is_dir_etc = guestfs_is_dir (g, "/etc") > 0;
302 int is_dir_bin = guestfs_is_dir (g, "/bin") > 0;
303 int is_dir_share = guestfs_is_dir (g, "/share") > 0;
306 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
307 guestfs_is_file (g, "/grub/grub.conf") > 0)
308 fs->content = FS_CONTENT_LINUX_BOOT;
310 else if (is_dir_etc &&
312 guestfs_is_file (g, "/etc/freebsd-update.conf") > 0 &&
313 guestfs_is_file (g, "/etc/fstab") > 0) {
314 /* Ignore /dev/sda1 which is a shadow of the real root filesystem
315 * that is probably /dev/sda5 (see:
316 * http://www.freebsd.org/doc/handbook/disk-organization.html)
318 if (match (g, device, re_first_partition))
322 fs->content = FS_CONTENT_FREEBSD_ROOT;
323 if (check_freebsd_root (g, fs) == -1)
327 else if (is_dir_etc &&
329 guestfs_is_file (g, "/etc/fstab") > 0) {
331 fs->content = FS_CONTENT_LINUX_ROOT;
332 if (check_linux_root (g, fs) == -1)
335 /* Linux /usr/local? */
336 else if (is_dir_etc &&
339 guestfs_exists (g, "/local") == 0 &&
340 guestfs_is_file (g, "/etc/fstab") == 0)
341 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
343 else if (is_dir_etc &&
346 guestfs_exists (g, "/local") > 0 &&
347 guestfs_is_file (g, "/etc/fstab") == 0)
348 fs->content = FS_CONTENT_LINUX_USR;
350 else if (guestfs_is_dir (g, "/log") > 0 &&
351 guestfs_is_dir (g, "/run") > 0 &&
352 guestfs_is_dir (g, "/spool") > 0)
353 fs->content = FS_CONTENT_LINUX_VAR;
355 else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
356 guestfs_is_file (g, "/autoexec.bat") > 0 ||
357 guestfs_is_dir (g, "/Program Files") > 0 ||
358 guestfs_is_dir (g, "/WINDOWS") > 0 ||
359 guestfs_is_dir (g, "/Windows") > 0 ||
360 guestfs_is_dir (g, "/windows") > 0 ||
361 guestfs_is_dir (g, "/WIN32") > 0 ||
362 guestfs_is_dir (g, "/Win32") > 0 ||
363 guestfs_is_dir (g, "/WINNT") > 0 ||
364 guestfs_is_file (g, "/boot.ini") > 0 ||
365 guestfs_is_file (g, "/ntldr") > 0) {
367 fs->content = FS_CONTENT_WINDOWS_ROOT;
368 if (check_windows_root (g, fs) == -1)
375 /* Set fs->product_name to the first line of the release file. */
377 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
378 const char *release_filename)
380 fs->product_name = first_line_of_file (g, release_filename);
381 if (fs->product_name == NULL)
386 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
388 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
392 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
393 fs->major_version = parse_unsigned_int (g, major);
395 if (fs->major_version == -1) {
399 fs->minor_version = parse_unsigned_int (g, minor);
401 if (fs->minor_version == -1)
407 /* Ubuntu has /etc/lsb-release containing:
408 * DISTRIB_ID=Ubuntu # Distro
409 * DISTRIB_RELEASE=10.04 # Version
410 * DISTRIB_CODENAME=lucid
411 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
413 * [Ubuntu-derived ...] Linux Mint was found to have this:
414 * DISTRIB_ID=LinuxMint
416 * DISTRIB_CODENAME=julia
417 * DISTRIB_DESCRIPTION="Linux Mint 10 Julia"
418 * Linux Mint also has /etc/linuxmint/info with more information,
419 * but we can use the LSB file.
422 * LSB_VERSION=lsb-4.0-amd64:lsb-4.0-noarch
423 * DISTRIB_ID=MandrivaLinux
424 * DISTRIB_RELEASE=2010.1
425 * DISTRIB_CODENAME=Henry_Farman
426 * DISTRIB_DESCRIPTION="Mandriva Linux 2010.1"
427 * Mandriva also has a normal release file called /etc/mandriva-release.
430 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
432 const char *filename = "/etc/lsb-release";
438 /* Don't trust guestfs_head_n not to break with very large files.
439 * Check the file size is something reasonable first.
441 size = guestfs_filesize (g, filename);
443 /* guestfs_filesize failed and has already set error in handle */
445 if (size > MAX_SMALL_FILE_SIZE) {
446 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
451 lines = guestfs_head_n (g, 10, filename);
455 for (i = 0; lines[i] != NULL; ++i) {
456 if (fs->distro == 0 &&
457 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
458 fs->distro = OS_DISTRO_UBUNTU;
461 else if (fs->distro == 0 &&
462 STREQ (lines[i], "DISTRIB_ID=LinuxMint")) {
463 fs->distro = OS_DISTRO_LINUX_MINT;
466 else if (fs->distro == 0 &&
467 STREQ (lines[i], "DISTRIB_ID=MandrivaLinux")) {
468 fs->distro = OS_DISTRO_MANDRIVA;
471 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
473 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
474 fs->major_version = parse_unsigned_int (g, major);
476 if (fs->major_version == -1) {
478 guestfs___free_string_list (lines);
481 fs->minor_version = parse_unsigned_int (g, minor);
483 if (fs->minor_version == -1) {
484 guestfs___free_string_list (lines);
489 else if (fs->product_name == NULL &&
490 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
491 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
492 size_t len = strlen (lines[i]) - 21 - 1;
493 fs->product_name = safe_strndup (g, &lines[i][21], len);
496 else if (fs->product_name == NULL &&
497 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
498 size_t len = strlen (lines[i]) - 20;
499 fs->product_name = safe_strndup (g, &lines[i][20], len);
504 guestfs___free_string_list (lines);
508 /* The currently mounted device is known to be a Linux root. Try to
509 * determine from this the distro, version, etc. Also parse
510 * /etc/fstab to determine the arrangement of mountpoints and
511 * associated devices.
514 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
518 fs->type = OS_TYPE_LINUX;
520 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
521 r = parse_lsb_release (g, fs);
522 if (r == -1) /* error */
524 if (r == 1) /* ok - detected the release from this file */
525 goto skip_release_checks;
528 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
529 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
531 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
535 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
536 fs->distro = OS_DISTRO_FEDORA;
537 fs->major_version = parse_unsigned_int (g, major);
539 if (fs->major_version == -1)
542 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
543 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
544 fs->distro = OS_DISTRO_RHEL;
545 fs->major_version = parse_unsigned_int (g, major);
547 if (fs->major_version == -1) {
551 fs->minor_version = parse_unsigned_int (g, minor);
553 if (fs->minor_version == -1)
556 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
557 fs->distro = OS_DISTRO_RHEL;
558 fs->major_version = parse_unsigned_int (g, major);
560 if (fs->major_version == -1)
562 fs->minor_version = 0;
565 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
566 fs->distro = OS_DISTRO_DEBIAN;
568 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
571 if (parse_major_minor (g, fs) == -1)
574 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
575 fs->distro = OS_DISTRO_PARDUS;
577 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
580 if (parse_major_minor (g, fs) == -1)
583 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
584 fs->distro = OS_DISTRO_ARCHLINUX;
586 /* /etc/arch-release file is empty and I can't see a way to
587 * determine the actual release or product string.
590 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
591 fs->distro = OS_DISTRO_GENTOO;
593 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
596 if (parse_major_minor (g, fs) == -1)
599 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
600 fs->distro = OS_DISTRO_MEEGO;
602 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
605 if (parse_major_minor (g, fs) == -1)
609 skip_release_checks:;
611 /* If distro test above was successful, work out the package format. */
612 check_package_format (g, fs);
613 check_package_management (g, fs);
615 /* Determine the architecture. */
616 check_architecture (g, fs);
618 /* We already know /etc/fstab exists because it's part of the test
619 * for Linux root above. We must now parse this file to determine
620 * which filesystems are used by the operating system and how they
623 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
626 /* Determine hostname. */
627 if (check_hostname_unix (g, fs) == -1)
633 /* The currently mounted device is known to be a FreeBSD root. */
635 check_freebsd_root (guestfs_h *g, struct inspect_fs *fs)
637 fs->type = OS_TYPE_FREEBSD;
639 /* FreeBSD has no authoritative version file. The version number is
640 * in /etc/motd, which the system administrator might edit, but
641 * we'll use that anyway.
644 if (guestfs_exists (g, "/etc/motd") > 0) {
645 if (parse_release_file (g, fs, "/etc/motd") == -1)
648 if (parse_major_minor (g, fs) == -1)
652 /* Determine the architecture. */
653 check_architecture (g, fs);
655 /* We already know /etc/fstab exists because it's part of the test above. */
656 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
659 /* Determine hostname. */
660 if (check_hostname_unix (g, fs) == -1)
667 check_architecture (guestfs_h *g, struct inspect_fs *fs)
669 const char *binaries[] =
670 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
673 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
674 if (guestfs_is_file (g, binaries[i]) > 0) {
675 /* Ignore errors from file_architecture call. */
676 guestfs_error_handler_cb old_error_cb = g->error_cb;
678 char *arch = guestfs_file_architecture (g, binaries[i]);
679 g->error_cb = old_error_cb;
682 /* String will be owned by handle, freed by
683 * guestfs___free_inspect_info.
692 /* Try several methods to determine the hostname from a Linux or
693 * FreeBSD guest. Note that type and distro have been set, so we can
694 * use that information to direct the search.
697 check_hostname_unix (guestfs_h *g, struct inspect_fs *fs)
701 /* Red Hat-derived would be in /etc/sysconfig/network, and
702 * Debian-derived in the file /etc/hostname. Very old Debian and
703 * SUSE use /etc/HOSTNAME. It's best to just look for each of
704 * these files in turn, rather than try anything clever based on
707 if (guestfs_is_file (g, "/etc/HOSTNAME")) {
708 fs->hostname = first_line_of_file (g, "/etc/HOSTNAME");
709 if (fs->hostname == NULL)
712 else if (guestfs_is_file (g, "/etc/hostname")) {
713 fs->hostname = first_line_of_file (g, "/etc/hostname");
714 if (fs->hostname == NULL)
717 else if (guestfs_is_file (g, "/etc/sysconfig/network")) {
718 if (inspect_with_augeas (g, fs, "/etc/sysconfig/network",
719 check_hostname_redhat) == -1)
724 case OS_TYPE_FREEBSD:
725 /* /etc/rc.conf contains the hostname, but there is no Augeas lens
728 if (guestfs_is_file (g, "/etc/rc.conf")) {
729 if (check_hostname_freebsd (g, fs) == -1)
734 case OS_TYPE_WINDOWS: /* not here, see check_windows_system_registry */
735 case OS_TYPE_UNKNOWN:
737 /* nothing, keep GCC warnings happy */;
743 /* Parse the hostname from /etc/sysconfig/network. This must be called
744 * from the inspect_with_augeas wrapper.
747 check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs)
751 hostname = guestfs_aug_get (g, "/files/etc/sysconfig/network/HOSTNAME");
755 fs->hostname = hostname; /* freed by guestfs___free_inspect_info */
759 /* Parse the hostname from /etc/rc.conf. On FreeBSD this file
760 * contains comments, blank lines and:
761 * hostname="freebsd8.example.com"
762 * ifconfig_re0="DHCP"
767 check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs)
769 const char *filename = "/etc/rc.conf";
774 /* Don't trust guestfs_read_lines not to break with very large files.
775 * Check the file size is something reasonable first.
777 size = guestfs_filesize (g, filename);
779 /* guestfs_filesize failed and has already set error in handle */
781 if (size > MAX_SMALL_FILE_SIZE) {
782 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
787 lines = guestfs_read_lines (g, filename);
791 for (i = 0; lines[i] != NULL; ++i) {
792 if (STRPREFIX (lines[i], "hostname=\"") ||
793 STRPREFIX (lines[i], "hostname='")) {
794 size_t len = strlen (lines[i]) - 10 - 1;
795 fs->hostname = safe_strndup (g, &lines[i][10], len);
797 } else if (STRPREFIX (lines[i], "hostname=")) {
798 size_t len = strlen (lines[i]) - 9;
799 fs->hostname = safe_strndup (g, &lines[i][9], len);
804 guestfs___free_string_list (lines);
809 check_fstab (guestfs_h *g, struct inspect_fs *fs)
811 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
815 if (lines[0] == NULL) {
816 error (g, _("could not parse /etc/fstab or empty file"));
817 guestfs___free_string_list (lines);
823 for (i = 0; lines[i] != NULL; ++i) {
824 /* Ignore comments. Only care about sequence lines which
827 if (match (g, lines[i], re_aug_seq)) {
828 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
829 char *spec = guestfs_aug_get (g, augpath);
831 guestfs___free_string_list (lines);
835 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
836 char *mp = guestfs_aug_get (g, augpath);
838 guestfs___free_string_list (lines);
843 int r = add_fstab_entry (g, fs, spec, mp);
848 guestfs___free_string_list (lines);
854 guestfs___free_string_list (lines);
858 /* Add a filesystem and possibly a mountpoint entry for
859 * the root filesystem 'fs'.
861 * 'spec' is the fstab spec field, which might be a device name or a
862 * pseudodevice or 'UUID=...' or 'LABEL=...'.
864 * 'mp' is the mount point, which could also be 'swap' or 'none'.
867 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
868 const char *spec, const char *mp)
870 /* Ignore certain mountpoints. */
871 if (STRPREFIX (mp, "/dev/") ||
872 STREQ (mp, "/dev") ||
873 STRPREFIX (mp, "/media/") ||
874 STRPREFIX (mp, "/proc/") ||
875 STREQ (mp, "/proc") ||
876 STRPREFIX (mp, "/selinux/") ||
877 STREQ (mp, "/selinux") ||
878 STRPREFIX (mp, "/sys/") ||
882 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
883 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
884 STREQ (spec, "/dev/floppy") ||
885 STREQ (spec, "/dev/cdrom"))
888 /* Resolve UUID= and LABEL= to the actual device. */
890 if (STRPREFIX (spec, "UUID="))
891 device = guestfs_findfs_uuid (g, &spec[5]);
892 else if (STRPREFIX (spec, "LABEL="))
893 device = guestfs_findfs_label (g, &spec[6]);
894 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
895 else if (STRPREFIX (spec, "/dev/"))
896 /* Resolve guest block device names. */
897 device = resolve_fstab_device (g, spec);
899 /* If we haven't resolved the device successfully by this point,
900 * we don't care, just ignore it.
905 char *mountpoint = safe_strdup (g, mp);
907 /* Add this to the fstab entry in 'fs'.
908 * Note these are further filtered by guestfs_inspect_get_mountpoints
909 * and guestfs_inspect_get_filesystems.
911 size_t n = fs->nr_fstab + 1;
912 struct inspect_fstab_entry *p;
914 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
916 perrorf (g, "realloc");
925 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
926 fs->fstab[n-1].device = device;
927 fs->fstab[n-1].mountpoint = mountpoint;
930 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
935 /* Resolve block device name to the libguestfs device name, eg.
936 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
937 * assumes that disks were added in the same order as they appear to
938 * the real VM, which is a reasonable assumption to make. Return
939 * anything we don't recognize unchanged.
942 resolve_fstab_device (guestfs_h *g, const char *spec)
946 char *bsddisk, *bsdslice, *bsdpart;
948 if (STRPREFIX (spec, "/dev/mapper/")) {
949 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
950 * LVs which contain '-' character:
952 * ><fs> lvcreate LV--test VG--test 32
953 * ><fs> debug ls /dev/mapper
954 * VG----test-LV----test
956 * This makes it impossible to reverse those paths directly, so
957 * we have implemented lvm_canonical_lv_name in the daemon.
959 device = guestfs_lvm_canonical_lv_name (g, spec);
961 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
962 char **devices = guestfs_list_devices (g);
967 for (count = 0; devices[count] != NULL; count++)
970 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
972 size_t len = strlen (devices[i]) + strlen (a1) + 16;
973 device = safe_malloc (g, len);
974 snprintf (device, len, "%s%s", devices[i], &a1[1]);
978 guestfs___free_string_list (devices);
980 else if (match3 (g, spec, re_freebsd, &bsddisk, &bsdslice, &bsdpart)) {
981 /* FreeBSD disks are organized quite differently. See:
982 * http://www.freebsd.org/doc/handbook/disk-organization.html
983 * FreeBSD "partitions" are exposed as quasi-extended partitions
984 * numbered from 5 in Linux. I have no idea what happens when you
985 * have multiple "slices" (the FreeBSD term for MBR partitions).
987 int disk = parse_unsigned_int (g, bsddisk);
988 int slice = parse_unsigned_int (g, bsdslice);
989 int part = bsdpart[0] - 'a' /* counting from 0 */;
994 if (disk == -1 || disk > 26 ||
995 slice <= 0 || slice > 1 /* > 4 .. see comment above */ ||
996 part < 0 || part >= 26)
999 device = safe_asprintf (g, "/dev/sd%c%d", disk + 'a', part + 5);
1003 /* Didn't match device pattern, return original spec unchanged. */
1005 device = safe_strdup (g, spec);
1010 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
1011 * essentially didn't do anything for modern Windows guests.
1012 * Therefore I've omitted all that code.
1015 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
1017 fs->type = OS_TYPE_WINDOWS;
1018 fs->distro = OS_DISTRO_WINDOWS;
1020 /* Try to find Windows systemroot using some common locations. */
1021 const char *systemroots[] =
1022 { "/windows", "/winnt", "/win32", "/win" };
1024 char *systemroot = NULL;
1026 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
1028 systemroot = resolve_windows_path_silently (g, systemroots[i]);
1032 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
1037 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
1039 /* Freed by guestfs___free_inspect_info. */
1040 fs->windows_systemroot = systemroot;
1042 if (check_windows_arch (g, fs) == -1)
1045 /* Product name and version. */
1046 if (check_windows_software_registry (g, fs) == -1)
1049 check_package_format (g, fs);
1050 check_package_management (g, fs);
1053 if (check_windows_system_registry (g, fs) == -1)
1060 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1062 size_t len = strlen (fs->windows_systemroot) + 32;
1064 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1066 char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
1070 char *arch = guestfs_file_architecture (g, cmd_exe_path);
1071 free (cmd_exe_path);
1074 fs->arch = arch; /* freed by guestfs___free_inspect_info */
1079 /* At the moment, pull just the ProductName and version numbers from
1080 * the registry. In future there is a case for making many more
1081 * registry fields available to callers.
1084 check_windows_software_registry (guestfs_h *g, struct inspect_fs *fs)
1086 TMP_TEMPLATE_ON_STACK (software_local);
1088 size_t len = strlen (fs->windows_systemroot) + 64;
1090 snprintf (software, len, "%s/system32/config/software",
1091 fs->windows_systemroot);
1093 char *software_path = resolve_windows_path_silently (g, software);
1095 /* If the software hive doesn't exist, just accept that we cannot
1096 * find product_name etc.
1102 hive_value_h *values = NULL;
1104 if (download_to_tmp (g, software_path, software_local,
1105 MAX_REGISTRY_SIZE) == -1)
1108 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1110 perrorf (g, "hivex_open");
1114 hive_node_h node = hivex_root (h);
1115 const char *hivepath[] =
1116 { "Microsoft", "Windows NT", "CurrentVersion" };
1119 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1121 node = hivex_node_get_child (h, node, hivepath[i]);
1125 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1129 values = hivex_node_values (h, node);
1131 for (i = 0; values[i] != 0; ++i) {
1132 char *key = hivex_value_key (h, values[i]);
1134 perrorf (g, "hivex_value_key");
1138 if (STRCASEEQ (key, "ProductName")) {
1139 fs->product_name = hivex_value_string (h, values[i]);
1140 if (!fs->product_name) {
1141 perrorf (g, "hivex_value_string");
1146 else if (STRCASEEQ (key, "CurrentVersion")) {
1147 char *version = hivex_value_string (h, values[i]);
1149 perrorf (g, "hivex_value_string");
1153 char *major, *minor;
1154 if (match2 (g, version, re_windows_version, &major, &minor)) {
1155 fs->major_version = parse_unsigned_int (g, major);
1157 if (fs->major_version == -1) {
1163 fs->minor_version = parse_unsigned_int (g, minor);
1165 if (fs->minor_version == -1) {
1181 if (h) hivex_close (h);
1183 free (software_path);
1185 /* Free up the temporary file. */
1186 unlink (software_local);
1187 #undef software_local_len
1193 check_windows_system_registry (guestfs_h *g, struct inspect_fs *fs)
1195 TMP_TEMPLATE_ON_STACK (system_local);
1197 size_t len = strlen (fs->windows_systemroot) + 64;
1199 snprintf (system, len, "%s/system32/config/system",
1200 fs->windows_systemroot);
1202 char *system_path = resolve_windows_path_silently (g, system);
1204 /* If the system hive doesn't exist, just accept that we cannot
1205 * find hostname etc.
1211 hive_value_h *values = NULL;
1213 if (download_to_tmp (g, system_path, system_local, MAX_REGISTRY_SIZE) == -1)
1216 h = hivex_open (system_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1218 perrorf (g, "hivex_open");
1222 hive_node_h node = hivex_root (h);
1223 /* XXX Don't hard-code ControlSet001. The current control set would
1224 * be another good thing to expose up through the inspection API.
1226 const char *hivepath[] =
1227 { "ControlSet001", "Services", "Tcpip", "Parameters" };
1230 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1232 node = hivex_node_get_child (h, node, hivepath[i]);
1236 perrorf (g, "hivex: cannot locate HKLM\\SYSTEM\\ControlSet001\\Services\\Tcpip\\Parameters");
1240 values = hivex_node_values (h, node);
1242 for (i = 0; values[i] != 0; ++i) {
1243 char *key = hivex_value_key (h, values[i]);
1245 perrorf (g, "hivex_value_key");
1249 if (STRCASEEQ (key, "Hostname")) {
1250 fs->hostname = hivex_value_string (h, values[i]);
1251 if (!fs->hostname) {
1252 perrorf (g, "hivex_value_string");
1257 /* many other interesting fields here ... */
1265 if (h) hivex_close (h);
1269 /* Free up the temporary file. */
1270 unlink (system_local);
1271 #undef system_local_len
1277 resolve_windows_path_silently (guestfs_h *g, const char *path)
1279 guestfs_error_handler_cb old_error_cb = g->error_cb;
1281 char *ret = guestfs_case_sensitive_path (g, path);
1282 g->error_cb = old_error_cb;
1287 extend_fses (guestfs_h *g)
1289 size_t n = g->nr_fses + 1;
1290 struct inspect_fs *p;
1292 p = realloc (g->fses, n * sizeof (struct inspect_fs));
1294 perrorf (g, "realloc");
1301 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1306 /* Parse small, unsigned ints, as used in version numbers. */
1308 parse_unsigned_int (guestfs_h *g, const char *str)
1311 int r = xstrtol (str, NULL, 10, &ret, "");
1312 if (r != LONGINT_OK) {
1313 error (g, _("could not parse integer in version number: %s"), str);
1319 /* At the moment, package format and package management is just a
1320 * simple function of the distro and major_version fields, so these
1321 * can never return an error. We might be cleverer in future.
1324 check_package_format (guestfs_h *g, struct inspect_fs *fs)
1326 switch (fs->distro) {
1327 case OS_DISTRO_FEDORA:
1328 case OS_DISTRO_MEEGO:
1329 case OS_DISTRO_REDHAT_BASED:
1330 case OS_DISTRO_RHEL:
1331 case OS_DISTRO_MANDRIVA:
1332 fs->package_format = OS_PACKAGE_FORMAT_RPM;
1335 case OS_DISTRO_DEBIAN:
1336 case OS_DISTRO_UBUNTU:
1337 case OS_DISTRO_LINUX_MINT:
1338 fs->package_format = OS_PACKAGE_FORMAT_DEB;
1341 case OS_DISTRO_ARCHLINUX:
1342 fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
1344 case OS_DISTRO_GENTOO:
1345 fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
1347 case OS_DISTRO_PARDUS:
1348 fs->package_format = OS_PACKAGE_FORMAT_PISI;
1351 case OS_DISTRO_WINDOWS:
1352 case OS_DISTRO_UNKNOWN:
1354 fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
1360 check_package_management (guestfs_h *g, struct inspect_fs *fs)
1362 switch (fs->distro) {
1363 case OS_DISTRO_FEDORA:
1364 case OS_DISTRO_MEEGO:
1365 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1368 case OS_DISTRO_REDHAT_BASED:
1369 case OS_DISTRO_RHEL:
1370 if (fs->major_version >= 5)
1371 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1373 fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
1376 case OS_DISTRO_DEBIAN:
1377 case OS_DISTRO_UBUNTU:
1378 case OS_DISTRO_LINUX_MINT:
1379 fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
1382 case OS_DISTRO_ARCHLINUX:
1383 fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
1385 case OS_DISTRO_GENTOO:
1386 fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
1388 case OS_DISTRO_PARDUS:
1389 fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
1391 case OS_DISTRO_MANDRIVA:
1392 fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
1395 case OS_DISTRO_WINDOWS:
1396 case OS_DISTRO_UNKNOWN:
1398 fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
1403 static struct inspect_fs *
1404 search_for_root (guestfs_h *g, const char *root)
1406 if (g->nr_fses == 0) {
1407 error (g, _("no inspection data: call guestfs_inspect_os first"));
1412 struct inspect_fs *fs;
1413 for (i = 0; i < g->nr_fses; ++i) {
1415 if (fs->is_root && STREQ (root, fs->device))
1419 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1425 guestfs__inspect_get_roots (guestfs_h *g)
1427 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
1428 * list in this case.
1433 for (i = 0; i < g->nr_fses; ++i)
1434 if (g->fses[i].is_root)
1437 char **ret = calloc (count+1, sizeof (char *));
1439 perrorf (g, "calloc");
1444 for (i = 0; i < g->nr_fses; ++i) {
1445 if (g->fses[i].is_root) {
1446 ret[count] = safe_strdup (g, g->fses[i].device);
1456 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1458 struct inspect_fs *fs = search_for_root (g, root);
1464 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1465 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1466 case OS_TYPE_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
1467 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1474 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1476 struct inspect_fs *fs = search_for_root (g, root);
1480 return safe_strdup (g, fs->arch ? : "unknown");
1484 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1486 struct inspect_fs *fs = search_for_root (g, root);
1491 switch (fs->distro) {
1492 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1493 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1494 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1495 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1496 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
1497 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
1498 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1499 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1500 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1501 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1502 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1503 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1504 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1511 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1513 struct inspect_fs *fs = search_for_root (g, root);
1517 return fs->major_version;
1521 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1523 struct inspect_fs *fs = search_for_root (g, root);
1527 return fs->minor_version;
1531 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1533 struct inspect_fs *fs = search_for_root (g, root);
1537 return safe_strdup (g, fs->product_name ? : "unknown");
1541 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1543 struct inspect_fs *fs = search_for_root (g, root);
1547 if (!fs->windows_systemroot) {
1548 error (g, _("not a Windows guest, or systemroot could not be determined"));
1552 return safe_strdup (g, fs->windows_systemroot);
1556 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1558 struct inspect_fs *fs = search_for_root (g, root);
1564 /* If no fstab information (Windows) return just the root. */
1565 if (fs->nr_fstab == 0) {
1566 ret = calloc (3, sizeof (char *));
1567 ret[0] = safe_strdup (g, "/");
1568 ret[1] = safe_strdup (g, root);
1573 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1574 size_t i, count = 0;
1575 for (i = 0; i < fs->nr_fstab; ++i)
1579 /* Hashtables have 2N+1 entries. */
1580 ret = calloc (2*count+1, sizeof (char *));
1582 perrorf (g, "calloc");
1587 for (i = 0; i < fs->nr_fstab; ++i)
1589 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1590 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1599 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1601 struct inspect_fs *fs = search_for_root (g, root);
1607 /* If no fstab information (Windows) return just the root. */
1608 if (fs->nr_fstab == 0) {
1609 ret = calloc (2, sizeof (char *));
1610 ret[0] = safe_strdup (g, root);
1615 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1617 perrorf (g, "calloc");
1622 for (i = 0; i < fs->nr_fstab; ++i)
1623 ret[i] = safe_strdup (g, fs->fstab[i].device);
1629 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
1631 struct inspect_fs *fs = search_for_root (g, root);
1636 switch (fs->package_format) {
1637 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
1638 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
1639 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1640 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
1641 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
1642 case OS_PACKAGE_FORMAT_UNKNOWN:
1644 ret = safe_strdup (g, "unknown");
1652 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
1654 struct inspect_fs *fs = search_for_root (g, root);
1659 switch (fs->package_management) {
1660 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
1661 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
1662 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
1663 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1664 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
1665 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
1666 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
1667 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
1669 ret = safe_strdup (g, "unknown");
1677 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
1679 struct inspect_fs *fs = search_for_root (g, root);
1683 return safe_strdup (g, fs->hostname ? : "unknown");
1687 static struct guestfs_application_list *list_applications_rpm (guestfs_h *g, struct inspect_fs *fs);
1689 static struct guestfs_application_list *list_applications_deb (guestfs_h *g, struct inspect_fs *fs);
1690 static struct guestfs_application_list *list_applications_windows (guestfs_h *g, struct inspect_fs *fs);
1691 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);
1692 static void sort_applications (struct guestfs_application_list *);
1694 /* Unlike the simple inspect-get-* calls, this one assumes that the
1695 * disks are mounted up, and reads files from the mounted disks.
1697 struct guestfs_application_list *
1698 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
1700 struct inspect_fs *fs = search_for_root (g, root);
1704 struct guestfs_application_list *ret = NULL;
1708 switch (fs->package_format) {
1709 case OS_PACKAGE_FORMAT_RPM:
1711 ret = list_applications_rpm (g, fs);
1717 case OS_PACKAGE_FORMAT_DEB:
1718 ret = list_applications_deb (g, fs);
1723 case OS_PACKAGE_FORMAT_PACMAN:
1724 case OS_PACKAGE_FORMAT_EBUILD:
1725 case OS_PACKAGE_FORMAT_PISI:
1726 case OS_PACKAGE_FORMAT_UNKNOWN:
1728 /* nothing - keep GCC happy */;
1732 case OS_TYPE_WINDOWS:
1733 ret = list_applications_windows (g, fs);
1738 case OS_TYPE_FREEBSD:
1739 case OS_TYPE_UNKNOWN:
1741 /* nothing - keep GCC happy */;
1745 /* Don't know how to do inspection. Not an error, return an
1748 ret = safe_malloc (g, sizeof *ret);
1753 sort_applications (ret);
1759 static struct guestfs_application_list *
1760 list_applications_rpm (guestfs_h *g, struct inspect_fs *fs)
1762 TMP_TEMPLATE_ON_STACK (tmpfile);
1764 if (download_to_tmp (g, "/var/lib/rpm/Name", tmpfile, MAX_PKG_DB_SIZE) == -1)
1767 struct guestfs_application_list *apps = NULL, *ret = NULL;
1768 #define cmd_len (strlen (tmpfile) + 64)
1774 snprintf (cmd, cmd_len, DB_DUMP " -p '%s'", tmpfile);
1777 fprintf (stderr, "list_applications_rpm: %s\n", cmd);
1779 pp = popen (cmd, "r");
1781 perrorf (g, "popen: %s", cmd);
1785 /* Ignore everything to end-of-header marker. */
1787 if (fgets (line, sizeof line, pp) == NULL) {
1788 error (g, _("unexpected end of output from db_dump command"));
1792 len = strlen (line);
1793 if (len > 0 && line[len-1] == '\n') {
1798 if (STREQ (line, "HEADER=END"))
1802 /* Allocate 'apps' list. */
1803 apps = safe_malloc (g, sizeof *apps);
1807 /* Read alternate lines until end of data marker. */
1809 if (fgets (line, sizeof line, pp) == NULL) {
1810 error (g, _("unexpected end of output from db_dump command"));
1814 len = strlen (line);
1815 if (len > 0 && line[len-1] == '\n') {
1820 if (STREQ (line, "DATA=END"))
1824 if (len > 0 && line[0] == ' ')
1826 /* Ignore any application name that contains non-printable chars.
1827 * In the db_dump output these would be escaped with backslash, so
1828 * we can just ignore any such line.
1830 if (strchr (p, '\\') == NULL)
1831 add_application (g, apps, p, "", 0, "", "", "", "", "", "");
1833 /* Discard next line. */
1834 if (fgets (line, sizeof line, pp) == NULL) {
1835 error (g, _("unexpected end of output from db_dump command"));
1840 /* Catch errors from the db_dump command. */
1841 if (pclose (pp) == -1) {
1842 perrorf (g, "pclose: %s", cmd);
1850 if (ret == NULL && apps != NULL)
1851 guestfs_free_application_list (apps);
1859 #endif /* defined DB_DUMP */
1861 static struct guestfs_application_list *
1862 list_applications_deb (guestfs_h *g, struct inspect_fs *fs)
1864 TMP_TEMPLATE_ON_STACK (tmpfile);
1866 if (download_to_tmp (g, "/var/lib/dpkg/status", tmpfile,
1867 MAX_PKG_DB_SIZE) == -1)
1870 struct guestfs_application_list *apps = NULL, *ret = NULL;
1874 char *name = NULL, *version = NULL, *release = NULL;
1875 int installed_flag = 0;
1877 fp = fopen (tmpfile, "r");
1879 perrorf (g, "fopen: %s", tmpfile);
1883 /* Allocate 'apps' list. */
1884 apps = safe_malloc (g, sizeof *apps);
1888 /* Read the temporary file. Each package entry is separated by
1890 * XXX Strictly speaking this is in mailbox header format, so it
1891 * would be possible for fields to spread across multiple lines,
1892 * although for the short fields that we are concerned about this is
1893 * unlikely and not seen in practice.
1895 while (fgets (line, sizeof line, fp) != NULL) {
1896 len = strlen (line);
1897 if (len > 0 && line[len-1] == '\n') {
1902 if (STRPREFIX (line, "Package: ")) {
1904 name = safe_strdup (g, &line[9]);
1906 else if (STRPREFIX (line, "Status: ")) {
1907 installed_flag = strstr (&line[8], "installed") != NULL;
1909 else if (STRPREFIX (line, "Version: ")) {
1912 char *p = strchr (&line[9], '-');
1915 version = safe_strdup (g, &line[9]);
1916 release = safe_strdup (g, p+1);
1918 version = safe_strdup (g, &line[9]);
1922 else if (STREQ (line, "")) {
1923 if (installed_flag && name && version)
1924 add_application (g, apps, name, "", 0, version, release ? : "",
1929 name = version = release = NULL;
1934 if (fclose (fp) == -1) {
1935 perrorf (g, "fclose: %s", tmpfile);
1943 if (ret == NULL && apps != NULL)
1944 guestfs_free_application_list (apps);
1954 /* XXX We already download the SOFTWARE hive when doing general
1955 * inspection. We could avoid this second download of the same file
1956 * by caching these entries in the handle.
1958 static struct guestfs_application_list *
1959 list_applications_windows (guestfs_h *g, struct inspect_fs *fs)
1961 TMP_TEMPLATE_ON_STACK (software_local);
1963 size_t len = strlen (fs->windows_systemroot) + 64;
1965 snprintf (software, len, "%s/system32/config/software",
1966 fs->windows_systemroot);
1968 char *software_path = resolve_windows_path_silently (g, software);
1970 /* If the software hive doesn't exist, just accept that we cannot
1971 * find product_name etc.
1975 struct guestfs_application_list *apps = NULL, *ret = NULL;
1977 hive_node_h *children = NULL;
1979 if (download_to_tmp (g, software_path, software_local,
1980 MAX_REGISTRY_SIZE) == -1)
1983 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1985 perrorf (g, "hivex_open");
1989 hive_node_h node = hivex_root (h);
1990 const char *hivepath[] =
1991 { "Microsoft", "Windows", "CurrentVersion", "Uninstall" };
1994 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1996 node = hivex_node_get_child (h, node, hivepath[i]);
2000 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall");
2004 children = hivex_node_children (h, node);
2005 if (children == NULL) {
2006 perrorf (g, "hivex_node_children");
2010 /* Allocate 'apps' list. */
2011 apps = safe_malloc (g, sizeof *apps);
2015 /* Consider any child node that has a DisplayName key.
2017 * http://nsis.sourceforge.net/Add_uninstall_information_to_Add/Remove_Programs#Optional_values
2019 for (i = 0; children[i] != 0; ++i) {
2022 char *display_name = NULL;
2023 char *version = NULL;
2024 char *install_path = NULL;
2025 char *publisher = NULL;
2027 char *comments = NULL;
2029 /* Use the node name as a proxy for the package name in Linux. The
2030 * display name is not language-independent, so it cannot be used.
2032 name = hivex_node_name (h, children[i]);
2034 perrorf (g, "hivex_node_get_name");
2038 value = hivex_node_get_value (h, children[i], "DisplayName");
2040 display_name = hivex_value_string (h, value);
2042 value = hivex_node_get_value (h, children[i], "DisplayVersion");
2044 version = hivex_value_string (h, value);
2045 value = hivex_node_get_value (h, children[i], "InstallLocation");
2047 install_path = hivex_value_string (h, value);
2048 value = hivex_node_get_value (h, children[i], "Publisher");
2050 publisher = hivex_value_string (h, value);
2051 value = hivex_node_get_value (h, children[i], "URLInfoAbout");
2053 url = hivex_value_string (h, value);
2054 value = hivex_node_get_value (h, children[i], "Comments");
2056 comments = hivex_value_string (h, value);
2058 add_application (g, apps, name, display_name, 0,
2061 install_path ? : "",
2069 free (display_name);
2071 free (install_path);
2080 if (ret == NULL && apps != NULL)
2081 guestfs_free_application_list (apps);
2082 if (h) hivex_close (h);
2084 free (software_path);
2086 /* Free up the temporary file. */
2087 unlink (software_local);
2088 #undef software_local_len
2094 add_application (guestfs_h *g, struct guestfs_application_list *apps,
2095 const char *name, const char *display_name, int32_t epoch,
2096 const char *version, const char *release,
2097 const char *install_path,
2098 const char *publisher, const char *url,
2099 const char *description)
2102 apps->val = safe_realloc (g, apps->val,
2103 apps->len * sizeof (struct guestfs_application));
2104 apps->val[apps->len-1].app_name = safe_strdup (g, name);
2105 apps->val[apps->len-1].app_display_name = safe_strdup (g, display_name);
2106 apps->val[apps->len-1].app_epoch = epoch;
2107 apps->val[apps->len-1].app_version = safe_strdup (g, version);
2108 apps->val[apps->len-1].app_release = safe_strdup (g, release);
2109 apps->val[apps->len-1].app_install_path = safe_strdup (g, install_path);
2110 /* XXX Translated path is not implemented yet. */
2111 apps->val[apps->len-1].app_trans_path = safe_strdup (g, "");
2112 apps->val[apps->len-1].app_publisher = safe_strdup (g, publisher);
2113 apps->val[apps->len-1].app_url = safe_strdup (g, url);
2114 /* XXX The next two are not yet implemented for any package
2115 * format, but we could easily support them for rpm and deb.
2117 apps->val[apps->len-1].app_source_package = safe_strdup (g, "");
2118 apps->val[apps->len-1].app_summary = safe_strdup (g, "");
2119 apps->val[apps->len-1].app_description = safe_strdup (g, description);
2122 /* Sort applications by name before returning the list. */
2124 compare_applications (const void *vp1, const void *vp2)
2126 const struct guestfs_application *v1 = vp1;
2127 const struct guestfs_application *v2 = vp2;
2129 return strcmp (v1->app_name, v2->app_name);
2133 sort_applications (struct guestfs_application_list *apps)
2135 if (apps && apps->val)
2136 qsort (apps->val, apps->len, sizeof (struct guestfs_application),
2137 compare_applications);
2140 /* Download to a guest file to a local temporary file. Refuse to
2141 * download the guest file if it is larger than max_size. The caller
2142 * is responsible for deleting the temporary file after use.
2145 download_to_tmp (guestfs_h *g, const char *filename,
2146 char *localtmp, int64_t max_size)
2152 size = guestfs_filesize (g, filename);
2154 /* guestfs_filesize failed and has already set error in handle */
2156 if (size > max_size) {
2157 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2162 fd = mkstemp (localtmp);
2164 perrorf (g, "mkstemp");
2168 snprintf (buf, sizeof buf, "/dev/fd/%d", fd);
2170 if (guestfs_download (g, filename, buf) == -1) {
2176 if (close (fd) == -1) {
2177 perrorf (g, "close: %s", localtmp);
2185 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
2186 * must exist). As a security measure, this bails if the file is too
2187 * large for a reasonable configuration file. After the call to 'f'
2191 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
2192 int (*f) (guestfs_h *, struct inspect_fs *))
2194 /* Security: Refuse to do this if filename is too large. */
2195 int64_t size = guestfs_filesize (g, filename);
2197 /* guestfs_filesize failed and has already set error in handle */
2199 if (size > MAX_AUGEAS_FILE_SIZE) {
2200 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2205 /* If !feature_available (g, "augeas") then the next call will fail.
2206 * Arguably we might want to fall back to a non-Augeas method in
2209 if (guestfs_aug_init (g, "/", 16|32) == -1)
2214 /* Tell Augeas to only load one file (thanks Raphaël Pinson). */
2215 char buf[strlen (filename) + 64];
2216 snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
2218 if (guestfs_aug_rm (g, buf) == -1)
2221 if (guestfs_aug_load (g) == -1)
2227 guestfs_aug_close (g);
2232 /* Get the first line of a small file, without any trailing newline
2236 first_line_of_file (guestfs_h *g, const char *filename)
2242 /* Don't trust guestfs_head_n not to break with very large files.
2243 * Check the file size is something reasonable first.
2245 size = guestfs_filesize (g, filename);
2247 /* guestfs_filesize failed and has already set error in handle */
2249 if (size > MAX_SMALL_FILE_SIZE) {
2250 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
2255 lines = guestfs_head_n (g, 1, filename);
2258 if (lines[0] == NULL) {
2259 error (g, _("%s: file is empty"), filename);
2260 guestfs___free_string_list (lines);
2263 /* lines[1] should be NULL because of '1' argument above ... */
2265 ret = lines[0]; /* caller frees */
2266 free (lines); /* free the array */
2271 #else /* no PCRE or hivex at compile time */
2273 /* XXX These functions should be in an optgroup. */
2275 #define NOT_IMPL(r) \
2276 error (g, _("inspection API not available since this version of libguestfs was compiled without PCRE or hivex libraries")); \
2280 guestfs__inspect_os (guestfs_h *g)
2286 guestfs__inspect_get_roots (guestfs_h *g)
2292 guestfs__inspect_get_type (guestfs_h *g, const char *root)
2298 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
2304 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
2310 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
2316 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
2322 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
2328 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
2334 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
2340 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
2346 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
2352 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
2358 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
2363 struct guestfs_application_list *
2364 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
2369 #endif /* no PCRE or hivex at compile time */
2372 guestfs___free_inspect_info (guestfs_h *g)
2375 for (i = 0; i < g->nr_fses; ++i) {
2376 free (g->fses[i].device);
2377 free (g->fses[i].product_name);
2378 free (g->fses[i].arch);
2379 free (g->fses[i].hostname);
2380 free (g->fses[i].windows_systemroot);
2382 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
2383 free (g->fses[i].fstab[j].device);
2384 free (g->fses[i].fstab[j].mountpoint);
2386 free (g->fses[i].fstab);
2393 /* In the Perl code this is a public function. */
2395 guestfs___feature_available (guestfs_h *g, const char *feature)
2397 /* If there's an error we should ignore it, so to do that we have to
2398 * temporarily replace the error handler with a null one.
2400 guestfs_error_handler_cb old_error_cb = g->error_cb;
2403 const char *groups[] = { feature, NULL };
2404 int r = guestfs_available (g, (char * const *) groups);
2406 g->error_cb = old_error_cb;
2408 return r == 0 ? 1 : 0;
2413 /* Match a regular expression which contains no captures. Returns
2414 * true if it matches or false if it doesn't.
2417 guestfs___match (guestfs_h *g, const char *str, const pcre *re)
2419 size_t len = strlen (str);
2422 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2423 if (r == PCRE_ERROR_NOMATCH)
2426 /* Internal error -- should not happen. */
2427 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2428 __FILE__, __func__, r, str);
2435 /* Match a regular expression which contains exactly one capture. If
2436 * the string matches, return the capture, otherwise return NULL. The
2437 * caller must free the result.
2440 guestfs___match1 (guestfs_h *g, const char *str, const pcre *re)
2442 size_t len = strlen (str);
2445 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2446 if (r == PCRE_ERROR_NOMATCH)
2449 /* Internal error -- should not happen. */
2450 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2451 __FILE__, __func__, r, str);
2455 return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2458 /* Match a regular expression which contains exactly two captures. */
2460 guestfs___match2 (guestfs_h *g, const char *str, const pcre *re,
2461 char **ret1, char **ret2)
2463 size_t len = strlen (str);
2466 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
2467 if (r == PCRE_ERROR_NOMATCH)
2470 /* Internal error -- should not happen. */
2471 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2472 __FILE__, __func__, r, str);
2476 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2477 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2482 /* Match a regular expression which contains exactly three captures. */
2484 guestfs___match3 (guestfs_h *g, const char *str, const pcre *re,
2485 char **ret1, char **ret2, char **ret3)
2487 size_t len = strlen (str);
2490 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
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);
2500 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2501 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2502 *ret3 = safe_strndup (g, &str[vec[6]], vec[7]-vec[6]);
2507 #endif /* HAVE_PCRE */