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 /* Compile all the regular expressions once when the shared library is
49 * loaded. PCRE is thread safe so we're supposedly OK here if
50 * multiple threads call into the libguestfs API functions below
53 static pcre *re_fedora;
54 static pcre *re_rhel_old;
56 static pcre *re_rhel_no_minor;
57 static pcre *re_major_minor;
58 static pcre *re_aug_seq;
60 static pcre *re_first_partition;
61 static pcre *re_freebsd;
62 static pcre *re_windows_version;
64 static void compile_regexps (void) __attribute__((constructor));
65 static void free_regexps (void) __attribute__((destructor));
68 compile_regexps (void)
73 #define COMPILE(re,pattern,options) \
75 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
77 ignore_value (write (2, err, strlen (err))); \
82 COMPILE (re_fedora, "Fedora release (\\d+)", 0);
84 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
86 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
87 COMPILE (re_rhel_no_minor,
88 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)", 0);
89 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
90 COMPILE (re_aug_seq, "/\\d+$", 0);
91 COMPILE (re_xdev, "^/dev/(?:h|s|v|xv)d([a-z]\\d*)$", 0);
92 COMPILE (re_first_partition, "^/dev/(?:h|s|v)d.1$", 0);
93 COMPILE (re_freebsd, "^/dev/ad(\\d+)s(\\d+)([a-z])$", 0);
94 COMPILE (re_windows_version, "^(\\d+)\\.(\\d+)", 0);
100 pcre_free (re_fedora);
101 pcre_free (re_rhel_old);
103 pcre_free (re_rhel_no_minor);
104 pcre_free (re_major_minor);
105 pcre_free (re_aug_seq);
107 pcre_free (re_first_partition);
108 pcre_free (re_freebsd);
109 pcre_free (re_windows_version);
112 /* The main inspection code. */
113 static int check_for_filesystem_on (guestfs_h *g, const char *device);
116 guestfs__inspect_os (guestfs_h *g)
118 /* Remove any information previously stored in the handle. */
119 guestfs___free_inspect_info (g);
121 if (guestfs_umount_all (g) == -1)
124 /* Iterate over all possible devices. Try to mount each
125 * (read-only). Examine ones which contain filesystems and add that
126 * information to the handle.
128 /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
130 devices = guestfs_list_devices (g);
135 for (i = 0; devices[i] != NULL; ++i) {
136 if (check_for_filesystem_on (g, devices[i]) == -1) {
137 guestfs___free_string_list (devices);
138 guestfs___free_inspect_info (g);
142 guestfs___free_string_list (devices);
144 /* Look at all partitions. */
146 partitions = guestfs_list_partitions (g);
147 if (partitions == NULL) {
148 guestfs___free_inspect_info (g);
152 for (i = 0; partitions[i] != NULL; ++i) {
153 if (check_for_filesystem_on (g, partitions[i]) == -1) {
154 guestfs___free_string_list (partitions);
155 guestfs___free_inspect_info (g);
159 guestfs___free_string_list (partitions);
161 /* Look at all LVs. */
162 if (guestfs___feature_available (g, "lvm2")) {
164 lvs = guestfs_lvs (g);
166 guestfs___free_inspect_info (g);
170 for (i = 0; lvs[i] != NULL; ++i) {
171 if (check_for_filesystem_on (g, lvs[i]) == -1) {
172 guestfs___free_string_list (lvs);
173 guestfs___free_inspect_info (g);
177 guestfs___free_string_list (lvs);
180 /* At this point we have, in the handle, a list of all filesystems
181 * found and data about each one. Now we assemble the list of
182 * filesystems which are root devices and return that to the user.
183 * Fall through to guestfs__inspect_get_roots to do that.
185 char **ret = guestfs__inspect_get_roots (g);
187 guestfs___free_inspect_info (g);
191 /* Find out if 'device' contains a filesystem. If it does, add
192 * another entry in g->fses.
194 static int check_filesystem (guestfs_h *g, const char *device);
195 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
196 static int check_freebsd_root (guestfs_h *g, struct inspect_fs *fs);
197 static void check_architecture (guestfs_h *g, struct inspect_fs *fs);
198 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
199 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
200 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
201 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs);
202 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
203 static int extend_fses (guestfs_h *g);
204 static int parse_unsigned_int (guestfs_h *g, const char *str);
205 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
206 const char *spec, const char *mp);
207 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
208 static void check_package_format (guestfs_h *g, struct inspect_fs *fs);
209 static void check_package_management (guestfs_h *g, struct inspect_fs *fs);
210 static int download_to_tmp (guestfs_h *g, const char *filename, char *localtmp, int64_t max_size);
211 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
212 static char *first_line_of_file (guestfs_h *g, const char *filename);
215 check_for_filesystem_on (guestfs_h *g, const char *device)
217 /* Get vfs-type in order to check if it's a Linux(?) swap device.
218 * If there's an error we should ignore it, so to do that we have to
219 * temporarily replace the error handler with a null one.
221 guestfs_error_handler_cb old_error_cb = g->error_cb;
223 char *vfs_type = guestfs_vfs_type (g, device);
224 g->error_cb = old_error_cb;
226 int is_swap = vfs_type && STREQ (vfs_type, "swap");
229 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
230 device, vfs_type ? vfs_type : "failed to get vfs type");
234 if (extend_fses (g) == -1)
236 g->fses[g->nr_fses-1].is_swap = 1;
240 /* Try mounting the device. As above, ignore errors. */
242 int r = guestfs_mount_ro (g, device, "/");
243 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
244 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
246 g->error_cb = old_error_cb;
250 /* Do the rest of the checks. */
251 r = check_filesystem (g, device);
253 /* Unmount the filesystem. */
254 if (guestfs_umount_all (g) == -1)
261 check_filesystem (guestfs_h *g, const char *device)
263 if (extend_fses (g) == -1)
266 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
268 fs->device = safe_strdup (g, device);
269 fs->is_mountable = 1;
271 /* Optimize some of the tests by avoiding multiple tests of the same thing. */
272 int is_dir_etc = guestfs_is_dir (g, "/etc") > 0;
273 int is_dir_bin = guestfs_is_dir (g, "/bin") > 0;
274 int is_dir_share = guestfs_is_dir (g, "/share") > 0;
277 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
278 guestfs_is_file (g, "/grub/grub.conf") > 0)
279 fs->content = FS_CONTENT_LINUX_BOOT;
281 else if (is_dir_etc &&
283 guestfs_is_file (g, "/etc/freebsd-update.conf") > 0 &&
284 guestfs_is_file (g, "/etc/fstab") > 0) {
285 /* Ignore /dev/sda1 which is a shadow of the real root filesystem
286 * that is probably /dev/sda5 (see:
287 * http://www.freebsd.org/doc/handbook/disk-organization.html)
289 if (match (g, device, re_first_partition))
293 fs->content = FS_CONTENT_FREEBSD_ROOT;
294 if (check_freebsd_root (g, fs) == -1)
298 else if (is_dir_etc &&
300 guestfs_is_file (g, "/etc/fstab") > 0) {
302 fs->content = FS_CONTENT_LINUX_ROOT;
303 if (check_linux_root (g, fs) == -1)
306 /* Linux /usr/local? */
307 else if (is_dir_etc &&
310 guestfs_exists (g, "/local") == 0 &&
311 guestfs_is_file (g, "/etc/fstab") == 0)
312 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
314 else if (is_dir_etc &&
317 guestfs_exists (g, "/local") > 0 &&
318 guestfs_is_file (g, "/etc/fstab") == 0)
319 fs->content = FS_CONTENT_LINUX_USR;
321 else if (guestfs_is_dir (g, "/log") > 0 &&
322 guestfs_is_dir (g, "/run") > 0 &&
323 guestfs_is_dir (g, "/spool") > 0)
324 fs->content = FS_CONTENT_LINUX_VAR;
326 else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
327 guestfs_is_file (g, "/autoexec.bat") > 0 ||
328 guestfs_is_dir (g, "/Program Files") > 0 ||
329 guestfs_is_dir (g, "/WINDOWS") > 0 ||
330 guestfs_is_dir (g, "/Windows") > 0 ||
331 guestfs_is_dir (g, "/windows") > 0 ||
332 guestfs_is_dir (g, "/WIN32") > 0 ||
333 guestfs_is_dir (g, "/Win32") > 0 ||
334 guestfs_is_dir (g, "/WINNT") > 0 ||
335 guestfs_is_file (g, "/boot.ini") > 0 ||
336 guestfs_is_file (g, "/ntldr") > 0) {
338 fs->content = FS_CONTENT_WINDOWS_ROOT;
339 if (check_windows_root (g, fs) == -1)
346 /* Set fs->product_name to the first line of the release file. */
348 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
349 const char *release_filename)
351 fs->product_name = first_line_of_file (g, release_filename);
352 if (fs->product_name == NULL)
357 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
359 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
363 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
364 fs->major_version = parse_unsigned_int (g, major);
366 if (fs->major_version == -1) {
370 fs->minor_version = parse_unsigned_int (g, minor);
372 if (fs->minor_version == -1)
378 /* Ubuntu has /etc/lsb-release containing:
379 * DISTRIB_ID=Ubuntu # Distro
380 * DISTRIB_RELEASE=10.04 # Version
381 * DISTRIB_CODENAME=lucid
382 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
384 * [Ubuntu-derived ...] Linux Mint was found to have this:
385 * DISTRIB_ID=LinuxMint
387 * DISTRIB_CODENAME=julia
388 * DISTRIB_DESCRIPTION="Linux Mint 10 Julia"
389 * Linux Mint also has /etc/linuxmint/info with more information,
390 * but we can use the LSB file.
393 * LSB_VERSION=lsb-4.0-amd64:lsb-4.0-noarch
394 * DISTRIB_ID=MandrivaLinux
395 * DISTRIB_RELEASE=2010.1
396 * DISTRIB_CODENAME=Henry_Farman
397 * DISTRIB_DESCRIPTION="Mandriva Linux 2010.1"
398 * Mandriva also has a normal release file called /etc/mandriva-release.
401 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
403 const char *filename = "/etc/lsb-release";
409 /* Don't trust guestfs_head_n not to break with very large files.
410 * Check the file size is something reasonable first.
412 size = guestfs_filesize (g, filename);
414 /* guestfs_filesize failed and has already set error in handle */
416 if (size > 1000000) {
417 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
422 lines = guestfs_head_n (g, 10, filename);
426 for (i = 0; lines[i] != NULL; ++i) {
427 if (fs->distro == 0 &&
428 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
429 fs->distro = OS_DISTRO_UBUNTU;
432 else if (fs->distro == 0 &&
433 STREQ (lines[i], "DISTRIB_ID=LinuxMint")) {
434 fs->distro = OS_DISTRO_LINUX_MINT;
437 else if (fs->distro == 0 &&
438 STREQ (lines[i], "DISTRIB_ID=MandrivaLinux")) {
439 fs->distro = OS_DISTRO_MANDRIVA;
442 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
444 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
445 fs->major_version = parse_unsigned_int (g, major);
447 if (fs->major_version == -1) {
449 guestfs___free_string_list (lines);
452 fs->minor_version = parse_unsigned_int (g, minor);
454 if (fs->minor_version == -1) {
455 guestfs___free_string_list (lines);
460 else if (fs->product_name == NULL &&
461 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
462 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
463 size_t len = strlen (lines[i]) - 21 - 1;
464 fs->product_name = safe_strndup (g, &lines[i][21], len);
467 else if (fs->product_name == NULL &&
468 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
469 size_t len = strlen (lines[i]) - 20;
470 fs->product_name = safe_strndup (g, &lines[i][20], len);
475 guestfs___free_string_list (lines);
479 /* The currently mounted device is known to be a Linux root. Try to
480 * determine from this the distro, version, etc. Also parse
481 * /etc/fstab to determine the arrangement of mountpoints and
482 * associated devices.
485 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
489 fs->type = OS_TYPE_LINUX;
491 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
492 r = parse_lsb_release (g, fs);
493 if (r == -1) /* error */
495 if (r == 1) /* ok - detected the release from this file */
496 goto skip_release_checks;
499 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
500 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
502 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
506 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
507 fs->distro = OS_DISTRO_FEDORA;
508 fs->major_version = parse_unsigned_int (g, major);
510 if (fs->major_version == -1)
513 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
514 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
515 fs->distro = OS_DISTRO_RHEL;
516 fs->major_version = parse_unsigned_int (g, major);
518 if (fs->major_version == -1) {
522 fs->minor_version = parse_unsigned_int (g, minor);
524 if (fs->minor_version == -1)
527 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
528 fs->distro = OS_DISTRO_RHEL;
529 fs->major_version = parse_unsigned_int (g, major);
531 if (fs->major_version == -1)
533 fs->minor_version = 0;
536 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
537 fs->distro = OS_DISTRO_DEBIAN;
539 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
542 if (parse_major_minor (g, fs) == -1)
545 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
546 fs->distro = OS_DISTRO_PARDUS;
548 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
551 if (parse_major_minor (g, fs) == -1)
554 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
555 fs->distro = OS_DISTRO_ARCHLINUX;
557 /* /etc/arch-release file is empty and I can't see a way to
558 * determine the actual release or product string.
561 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
562 fs->distro = OS_DISTRO_GENTOO;
564 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
567 if (parse_major_minor (g, fs) == -1)
570 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
571 fs->distro = OS_DISTRO_MEEGO;
573 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
576 if (parse_major_minor (g, fs) == -1)
580 skip_release_checks:;
582 /* If distro test above was successful, work out the package format. */
583 check_package_format (g, fs);
584 check_package_management (g, fs);
586 /* Determine the architecture. */
587 check_architecture (g, fs);
589 /* We already know /etc/fstab exists because it's part of the test
590 * for Linux root above. We must now parse this file to determine
591 * which filesystems are used by the operating system and how they
594 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
600 /* The currently mounted device is known to be a FreeBSD root. */
602 check_freebsd_root (guestfs_h *g, struct inspect_fs *fs)
606 fs->type = OS_TYPE_FREEBSD;
608 /* FreeBSD has no authoritative version file. The version number is
609 * in /etc/motd, which the system administrator might edit, but
610 * we'll use that anyway.
613 if (guestfs_exists (g, "/etc/motd") > 0) {
614 if (parse_release_file (g, fs, "/etc/motd") == -1)
617 if (parse_major_minor (g, fs) == -1)
621 /* Determine the architecture. */
622 check_architecture (g, fs);
624 /* We already know /etc/fstab exists because it's part of the test above. */
625 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
632 check_architecture (guestfs_h *g, struct inspect_fs *fs)
634 const char *binaries[] =
635 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
638 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
639 if (guestfs_is_file (g, binaries[i]) > 0) {
640 /* Ignore errors from file_architecture call. */
641 guestfs_error_handler_cb old_error_cb = g->error_cb;
643 char *arch = guestfs_file_architecture (g, binaries[i]);
644 g->error_cb = old_error_cb;
647 /* String will be owned by handle, freed by
648 * guestfs___free_inspect_info.
658 check_fstab (guestfs_h *g, struct inspect_fs *fs)
660 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
664 if (lines[0] == NULL) {
665 error (g, _("could not parse /etc/fstab or empty file"));
666 guestfs___free_string_list (lines);
672 for (i = 0; lines[i] != NULL; ++i) {
673 /* Ignore comments. Only care about sequence lines which
676 if (match (g, lines[i], re_aug_seq)) {
677 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
678 char *spec = guestfs_aug_get (g, augpath);
680 guestfs___free_string_list (lines);
684 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
685 char *mp = guestfs_aug_get (g, augpath);
687 guestfs___free_string_list (lines);
692 int r = add_fstab_entry (g, fs, spec, mp);
697 guestfs___free_string_list (lines);
703 guestfs___free_string_list (lines);
707 /* Add a filesystem and possibly a mountpoint entry for
708 * the root filesystem 'fs'.
710 * 'spec' is the fstab spec field, which might be a device name or a
711 * pseudodevice or 'UUID=...' or 'LABEL=...'.
713 * 'mp' is the mount point, which could also be 'swap' or 'none'.
716 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
717 const char *spec, const char *mp)
719 /* Ignore certain mountpoints. */
720 if (STRPREFIX (mp, "/dev/") ||
721 STREQ (mp, "/dev") ||
722 STRPREFIX (mp, "/media/") ||
723 STRPREFIX (mp, "/proc/") ||
724 STREQ (mp, "/proc") ||
725 STRPREFIX (mp, "/selinux/") ||
726 STREQ (mp, "/selinux") ||
727 STRPREFIX (mp, "/sys/") ||
731 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
732 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
733 STREQ (spec, "/dev/floppy") ||
734 STREQ (spec, "/dev/cdrom"))
737 /* Resolve UUID= and LABEL= to the actual device. */
739 if (STRPREFIX (spec, "UUID="))
740 device = guestfs_findfs_uuid (g, &spec[5]);
741 else if (STRPREFIX (spec, "LABEL="))
742 device = guestfs_findfs_label (g, &spec[6]);
743 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
744 else if (STRPREFIX (spec, "/dev/"))
745 /* Resolve guest block device names. */
746 device = resolve_fstab_device (g, spec);
748 /* If we haven't resolved the device successfully by this point,
749 * we don't care, just ignore it.
754 char *mountpoint = safe_strdup (g, mp);
756 /* Add this to the fstab entry in 'fs'.
757 * Note these are further filtered by guestfs_inspect_get_mountpoints
758 * and guestfs_inspect_get_filesystems.
760 size_t n = fs->nr_fstab + 1;
761 struct inspect_fstab_entry *p;
763 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
765 perrorf (g, "realloc");
774 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
775 fs->fstab[n-1].device = device;
776 fs->fstab[n-1].mountpoint = mountpoint;
779 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
784 /* Resolve block device name to the libguestfs device name, eg.
785 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
786 * assumes that disks were added in the same order as they appear to
787 * the real VM, which is a reasonable assumption to make. Return
788 * anything we don't recognize unchanged.
791 resolve_fstab_device (guestfs_h *g, const char *spec)
795 char *bsddisk, *bsdslice, *bsdpart;
797 if (STRPREFIX (spec, "/dev/mapper/")) {
798 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
799 * LVs which contain '-' character:
801 * ><fs> lvcreate LV--test VG--test 32
802 * ><fs> debug ls /dev/mapper
803 * VG----test-LV----test
805 * This makes it impossible to reverse those paths directly, so
806 * we have implemented lvm_canonical_lv_name in the daemon.
808 device = guestfs_lvm_canonical_lv_name (g, spec);
810 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
811 char **devices = guestfs_list_devices (g);
816 for (count = 0; devices[count] != NULL; count++)
819 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
821 size_t len = strlen (devices[i]) + strlen (a1) + 16;
822 device = safe_malloc (g, len);
823 snprintf (device, len, "%s%s", devices[i], &a1[1]);
827 guestfs___free_string_list (devices);
829 else if (match3 (g, spec, re_freebsd, &bsddisk, &bsdslice, &bsdpart)) {
830 /* FreeBSD disks are organized quite differently. See:
831 * http://www.freebsd.org/doc/handbook/disk-organization.html
832 * FreeBSD "partitions" are exposed as quasi-extended partitions
833 * numbered from 5 in Linux. I have no idea what happens when you
834 * have multiple "slices" (the FreeBSD term for MBR partitions).
836 int disk = parse_unsigned_int (g, bsddisk);
837 int slice = parse_unsigned_int (g, bsdslice);
838 int part = bsdpart[0] - 'a' /* counting from 0 */;
843 if (disk == -1 || disk > 26 ||
844 slice <= 0 || slice > 1 /* > 4 .. see comment above */ ||
845 part < 0 || part >= 26)
848 device = safe_asprintf (g, "/dev/sd%c%d", disk + 'a', part + 5);
852 /* Didn't match device pattern, return original spec unchanged. */
854 device = safe_strdup (g, spec);
859 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
860 * essentially didn't do anything for modern Windows guests.
861 * Therefore I've omitted all that code.
864 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
866 fs->type = OS_TYPE_WINDOWS;
867 fs->distro = OS_DISTRO_WINDOWS;
869 /* Try to find Windows systemroot using some common locations. */
870 const char *systemroots[] =
871 { "/windows", "/winnt", "/win32", "/win" };
873 char *systemroot = NULL;
875 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
877 systemroot = resolve_windows_path_silently (g, systemroots[i]);
881 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
886 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
888 /* Freed by guestfs___free_inspect_info. */
889 fs->windows_systemroot = systemroot;
891 if (check_windows_arch (g, fs) == -1)
894 if (check_windows_registry (g, fs) == -1)
897 check_package_format (g, fs);
898 check_package_management (g, fs);
904 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
906 size_t len = strlen (fs->windows_systemroot) + 32;
908 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
910 char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
914 char *arch = guestfs_file_architecture (g, cmd_exe_path);
918 fs->arch = arch; /* freed by guestfs___free_inspect_info */
923 /* At the moment, pull just the ProductName and version numbers from
924 * the registry. In future there is a case for making many more
925 * registry fields available to callers.
928 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
930 TMP_TEMPLATE_ON_STACK (software_local);
932 size_t len = strlen (fs->windows_systemroot) + 64;
934 snprintf (software, len, "%s/system32/config/software",
935 fs->windows_systemroot);
937 char *software_path = resolve_windows_path_silently (g, software);
939 /* If the software hive doesn't exist, just accept that we cannot
940 * find product_name etc.
946 hive_value_h *values = NULL;
948 if (download_to_tmp (g, software_path, software_local, 100000000) == -1)
951 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
953 perrorf (g, "hivex_open");
957 hive_node_h node = hivex_root (h);
958 const char *hivepath[] =
959 { "Microsoft", "Windows NT", "CurrentVersion" };
962 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
964 node = hivex_node_get_child (h, node, hivepath[i]);
968 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
972 values = hivex_node_values (h, node);
974 for (i = 0; values[i] != 0; ++i) {
975 char *key = hivex_value_key (h, values[i]);
977 perrorf (g, "hivex_value_key");
981 if (STRCASEEQ (key, "ProductName")) {
982 fs->product_name = hivex_value_string (h, values[i]);
983 if (!fs->product_name) {
984 perrorf (g, "hivex_value_string");
989 else if (STRCASEEQ (key, "CurrentVersion")) {
990 char *version = hivex_value_string (h, values[i]);
992 perrorf (g, "hivex_value_string");
997 if (match2 (g, version, re_windows_version, &major, &minor)) {
998 fs->major_version = parse_unsigned_int (g, major);
1000 if (fs->major_version == -1) {
1006 fs->minor_version = parse_unsigned_int (g, minor);
1008 if (fs->minor_version == -1) {
1024 if (h) hivex_close (h);
1026 free (software_path);
1028 /* Free up the temporary file. */
1029 unlink (software_local);
1030 #undef software_local_len
1036 resolve_windows_path_silently (guestfs_h *g, const char *path)
1038 guestfs_error_handler_cb old_error_cb = g->error_cb;
1040 char *ret = guestfs_case_sensitive_path (g, path);
1041 g->error_cb = old_error_cb;
1046 extend_fses (guestfs_h *g)
1048 size_t n = g->nr_fses + 1;
1049 struct inspect_fs *p;
1051 p = realloc (g->fses, n * sizeof (struct inspect_fs));
1053 perrorf (g, "realloc");
1060 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1065 /* Parse small, unsigned ints, as used in version numbers. */
1067 parse_unsigned_int (guestfs_h *g, const char *str)
1070 int r = xstrtol (str, NULL, 10, &ret, "");
1071 if (r != LONGINT_OK) {
1072 error (g, _("could not parse integer in version number: %s"), str);
1078 /* At the moment, package format and package management is just a
1079 * simple function of the distro and major_version fields, so these
1080 * can never return an error. We might be cleverer in future.
1083 check_package_format (guestfs_h *g, struct inspect_fs *fs)
1085 switch (fs->distro) {
1086 case OS_DISTRO_FEDORA:
1087 case OS_DISTRO_MEEGO:
1088 case OS_DISTRO_REDHAT_BASED:
1089 case OS_DISTRO_RHEL:
1090 case OS_DISTRO_MANDRIVA:
1091 fs->package_format = OS_PACKAGE_FORMAT_RPM;
1094 case OS_DISTRO_DEBIAN:
1095 case OS_DISTRO_UBUNTU:
1096 case OS_DISTRO_LINUX_MINT:
1097 fs->package_format = OS_PACKAGE_FORMAT_DEB;
1100 case OS_DISTRO_ARCHLINUX:
1101 fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
1103 case OS_DISTRO_GENTOO:
1104 fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
1106 case OS_DISTRO_PARDUS:
1107 fs->package_format = OS_PACKAGE_FORMAT_PISI;
1110 case OS_DISTRO_WINDOWS:
1111 case OS_DISTRO_UNKNOWN:
1113 fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
1119 check_package_management (guestfs_h *g, struct inspect_fs *fs)
1121 switch (fs->distro) {
1122 case OS_DISTRO_FEDORA:
1123 case OS_DISTRO_MEEGO:
1124 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1127 case OS_DISTRO_REDHAT_BASED:
1128 case OS_DISTRO_RHEL:
1129 if (fs->major_version >= 5)
1130 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
1132 fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
1135 case OS_DISTRO_DEBIAN:
1136 case OS_DISTRO_UBUNTU:
1137 case OS_DISTRO_LINUX_MINT:
1138 fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
1141 case OS_DISTRO_ARCHLINUX:
1142 fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
1144 case OS_DISTRO_GENTOO:
1145 fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
1147 case OS_DISTRO_PARDUS:
1148 fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
1150 case OS_DISTRO_MANDRIVA:
1151 fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
1154 case OS_DISTRO_WINDOWS:
1155 case OS_DISTRO_UNKNOWN:
1157 fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
1162 static struct inspect_fs *
1163 search_for_root (guestfs_h *g, const char *root)
1165 if (g->nr_fses == 0) {
1166 error (g, _("no inspection data: call guestfs_inspect_os first"));
1171 struct inspect_fs *fs;
1172 for (i = 0; i < g->nr_fses; ++i) {
1174 if (fs->is_root && STREQ (root, fs->device))
1178 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1184 guestfs__inspect_get_roots (guestfs_h *g)
1186 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
1187 * list in this case.
1192 for (i = 0; i < g->nr_fses; ++i)
1193 if (g->fses[i].is_root)
1196 char **ret = calloc (count+1, sizeof (char *));
1198 perrorf (g, "calloc");
1203 for (i = 0; i < g->nr_fses; ++i) {
1204 if (g->fses[i].is_root) {
1205 ret[count] = safe_strdup (g, g->fses[i].device);
1215 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1217 struct inspect_fs *fs = search_for_root (g, root);
1223 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1224 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1225 case OS_TYPE_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
1226 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1233 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1235 struct inspect_fs *fs = search_for_root (g, root);
1239 return safe_strdup (g, fs->arch ? : "unknown");
1243 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1245 struct inspect_fs *fs = search_for_root (g, root);
1250 switch (fs->distro) {
1251 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1252 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1253 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1254 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1255 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
1256 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
1257 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1258 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1259 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1260 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1261 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1262 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1263 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1270 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1272 struct inspect_fs *fs = search_for_root (g, root);
1276 return fs->major_version;
1280 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1282 struct inspect_fs *fs = search_for_root (g, root);
1286 return fs->minor_version;
1290 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1292 struct inspect_fs *fs = search_for_root (g, root);
1296 return safe_strdup (g, fs->product_name ? : "unknown");
1300 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1302 struct inspect_fs *fs = search_for_root (g, root);
1306 if (!fs->windows_systemroot) {
1307 error (g, _("not a Windows guest, or systemroot could not be determined"));
1311 return safe_strdup (g, fs->windows_systemroot);
1315 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1317 struct inspect_fs *fs = search_for_root (g, root);
1323 /* If no fstab information (Windows) return just the root. */
1324 if (fs->nr_fstab == 0) {
1325 ret = calloc (3, sizeof (char *));
1326 ret[0] = safe_strdup (g, "/");
1327 ret[1] = safe_strdup (g, root);
1332 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1333 size_t i, count = 0;
1334 for (i = 0; i < fs->nr_fstab; ++i)
1338 /* Hashtables have 2N+1 entries. */
1339 ret = calloc (2*count+1, sizeof (char *));
1341 perrorf (g, "calloc");
1346 for (i = 0; i < fs->nr_fstab; ++i)
1348 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1349 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1358 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1360 struct inspect_fs *fs = search_for_root (g, root);
1366 /* If no fstab information (Windows) return just the root. */
1367 if (fs->nr_fstab == 0) {
1368 ret = calloc (2, sizeof (char *));
1369 ret[0] = safe_strdup (g, root);
1374 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1376 perrorf (g, "calloc");
1381 for (i = 0; i < fs->nr_fstab; ++i)
1382 ret[i] = safe_strdup (g, fs->fstab[i].device);
1388 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
1390 struct inspect_fs *fs = search_for_root (g, root);
1395 switch (fs->package_format) {
1396 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
1397 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
1398 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1399 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
1400 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
1401 case OS_PACKAGE_FORMAT_UNKNOWN:
1403 ret = safe_strdup (g, "unknown");
1411 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
1413 struct inspect_fs *fs = search_for_root (g, root);
1418 switch (fs->package_management) {
1419 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
1420 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
1421 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
1422 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
1423 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
1424 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
1425 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
1426 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
1428 ret = safe_strdup (g, "unknown");
1435 static struct guestfs_application_list *list_applications_rpm (guestfs_h *g, struct inspect_fs *fs);
1436 static struct guestfs_application_list *list_applications_deb (guestfs_h *g, struct inspect_fs *fs);
1437 static struct guestfs_application_list *list_applications_windows (guestfs_h *g, struct inspect_fs *fs);
1438 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);
1439 static void sort_applications (struct guestfs_application_list *);
1441 /* Unlike the simple inspect-get-* calls, this one assumes that the
1442 * disks are mounted up, and reads files from the mounted disks.
1444 struct guestfs_application_list *
1445 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
1447 struct inspect_fs *fs = search_for_root (g, root);
1451 struct guestfs_application_list *ret = NULL;
1455 switch (fs->package_format) {
1456 case OS_PACKAGE_FORMAT_RPM:
1457 ret = list_applications_rpm (g, fs);
1462 case OS_PACKAGE_FORMAT_DEB:
1463 ret = list_applications_deb (g, fs);
1468 case OS_PACKAGE_FORMAT_PACMAN:
1469 case OS_PACKAGE_FORMAT_EBUILD:
1470 case OS_PACKAGE_FORMAT_PISI:
1471 case OS_PACKAGE_FORMAT_UNKNOWN:
1473 /* nothing - keep GCC happy */;
1477 case OS_TYPE_WINDOWS:
1478 ret = list_applications_windows (g, fs);
1483 case OS_TYPE_FREEBSD:
1484 case OS_TYPE_UNKNOWN:
1486 /* nothing - keep GCC happy */;
1490 /* Don't know how to do inspection. Not an error, return an
1493 ret = safe_malloc (g, sizeof *ret);
1498 sort_applications (ret);
1503 static struct guestfs_application_list *
1504 list_applications_rpm (guestfs_h *g, struct inspect_fs *fs)
1506 TMP_TEMPLATE_ON_STACK (tmpfile);
1508 if (download_to_tmp (g, "/var/lib/rpm/Name", tmpfile, 10000000) == -1)
1511 struct guestfs_application_list *apps = NULL, *ret = NULL;
1512 #define cmd_len (strlen (tmpfile) + 64)
1518 snprintf (cmd, cmd_len, "db_dump -p '%s'", tmpfile);
1521 fprintf (stderr, "list_applications_rpm: %s\n", cmd);
1523 pp = popen (cmd, "r");
1525 perrorf (g, "popen: %s", cmd);
1529 /* Ignore everything to end-of-header marker. */
1531 if (fgets (line, sizeof line, pp) == NULL) {
1532 error (g, _("unexpected end of output from db_dump command"));
1536 len = strlen (line);
1537 if (len > 0 && line[len-1] == '\n') {
1542 if (STREQ (line, "HEADER=END"))
1546 /* Allocate 'apps' list. */
1547 apps = safe_malloc (g, sizeof *apps);
1551 /* Read alternate lines until end of data marker. */
1553 if (fgets (line, sizeof line, pp) == NULL) {
1554 error (g, _("unexpected end of output from db_dump command"));
1558 len = strlen (line);
1559 if (len > 0 && line[len-1] == '\n') {
1564 if (STREQ (line, "DATA=END"))
1568 if (len > 0 && line[0] == ' ')
1570 /* Ignore any application name that contains non-printable chars.
1571 * In the db_dump output these would be escaped with backslash, so
1572 * we can just ignore any such line.
1574 if (strchr (p, '\\') == NULL)
1575 add_application (g, apps, p, "", 0, "", "", "", "", "", "");
1577 /* Discard next line. */
1578 if (fgets (line, sizeof line, pp) == NULL) {
1579 error (g, _("unexpected end of output from db_dump command"));
1584 /* Catch errors from the db_dump command. */
1585 if (pclose (pp) == -1) {
1586 perrorf (g, "pclose: %s", cmd);
1594 if (ret == NULL && apps != NULL)
1595 guestfs_free_application_list (apps);
1604 static struct guestfs_application_list *
1605 list_applications_deb (guestfs_h *g, struct inspect_fs *fs)
1607 TMP_TEMPLATE_ON_STACK (tmpfile);
1609 if (download_to_tmp (g, "/var/lib/dpkg/status", tmpfile, 10000000) == -1)
1612 struct guestfs_application_list *apps = NULL, *ret = NULL;
1616 char *name = NULL, *version = NULL, *release = NULL;
1617 int installed_flag = 0;
1619 fp = fopen (tmpfile, "r");
1621 perrorf (g, "fopen: %s", tmpfile);
1625 /* Allocate 'apps' list. */
1626 apps = safe_malloc (g, sizeof *apps);
1630 /* Read the temporary file. Each package entry is separated by
1632 * XXX Strictly speaking this is in mailbox header format, so it
1633 * would be possible for fields to spread across multiple lines,
1634 * although for the short fields that we are concerned about this is
1635 * unlikely and not seen in practice.
1637 while (fgets (line, sizeof line, fp) != NULL) {
1638 len = strlen (line);
1639 if (len > 0 && line[len-1] == '\n') {
1644 if (STRPREFIX (line, "Package: ")) {
1646 name = safe_strdup (g, &line[9]);
1648 else if (STRPREFIX (line, "Status: ")) {
1649 installed_flag = strstr (&line[8], "installed") != NULL;
1651 else if (STRPREFIX (line, "Version: ")) {
1654 char *p = strchr (&line[9], '-');
1657 version = safe_strdup (g, &line[9]);
1658 release = safe_strdup (g, p+1);
1660 version = safe_strdup (g, &line[9]);
1664 else if (STREQ (line, "")) {
1665 if (installed_flag && name && version)
1666 add_application (g, apps, name, "", 0, version, release ? : "",
1671 name = version = release = NULL;
1676 if (fclose (fp) == -1) {
1677 perrorf (g, "fclose: %s", tmpfile);
1685 if (ret == NULL && apps != NULL)
1686 guestfs_free_application_list (apps);
1696 /* XXX We already download the SOFTWARE hive when doing general
1697 * inspection. We could avoid this second download of the same file
1698 * by caching these entries in the handle.
1700 static struct guestfs_application_list *
1701 list_applications_windows (guestfs_h *g, struct inspect_fs *fs)
1703 TMP_TEMPLATE_ON_STACK (software_local);
1705 size_t len = strlen (fs->windows_systemroot) + 64;
1707 snprintf (software, len, "%s/system32/config/software",
1708 fs->windows_systemroot);
1710 char *software_path = resolve_windows_path_silently (g, software);
1712 /* If the software hive doesn't exist, just accept that we cannot
1713 * find product_name etc.
1717 struct guestfs_application_list *apps = NULL, *ret = NULL;
1719 hive_node_h *children = NULL;
1721 if (download_to_tmp (g, software_path, software_local, 100000000) == -1)
1724 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1726 perrorf (g, "hivex_open");
1730 hive_node_h node = hivex_root (h);
1731 const char *hivepath[] =
1732 { "Microsoft", "Windows", "CurrentVersion", "Uninstall" };
1735 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1737 node = hivex_node_get_child (h, node, hivepath[i]);
1741 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall");
1745 children = hivex_node_children (h, node);
1746 if (children == NULL) {
1747 perrorf (g, "hivex_node_children");
1751 /* Allocate 'apps' list. */
1752 apps = safe_malloc (g, sizeof *apps);
1756 /* Consider any child node that has a DisplayName key.
1758 * http://nsis.sourceforge.net/Add_uninstall_information_to_Add/Remove_Programs#Optional_values
1760 for (i = 0; children[i] != 0; ++i) {
1763 char *display_name = NULL;
1764 char *version = NULL;
1765 char *install_path = NULL;
1766 char *publisher = NULL;
1768 char *comments = NULL;
1770 /* Use the node name as a proxy for the package name in Linux. The
1771 * display name is not language-independent, so it cannot be used.
1773 name = hivex_node_name (h, children[i]);
1775 perrorf (g, "hivex_node_get_name");
1779 value = hivex_node_get_value (h, children[i], "DisplayName");
1781 display_name = hivex_value_string (h, value);
1783 value = hivex_node_get_value (h, children[i], "DisplayVersion");
1785 version = hivex_value_string (h, value);
1786 value = hivex_node_get_value (h, children[i], "InstallLocation");
1788 install_path = hivex_value_string (h, value);
1789 value = hivex_node_get_value (h, children[i], "Publisher");
1791 publisher = hivex_value_string (h, value);
1792 value = hivex_node_get_value (h, children[i], "URLInfoAbout");
1794 url = hivex_value_string (h, value);
1795 value = hivex_node_get_value (h, children[i], "Comments");
1797 comments = hivex_value_string (h, value);
1799 add_application (g, apps, name, display_name, 0,
1802 install_path ? : "",
1810 free (display_name);
1812 free (install_path);
1821 if (ret == NULL && apps != NULL)
1822 guestfs_free_application_list (apps);
1823 if (h) hivex_close (h);
1825 free (software_path);
1827 /* Free up the temporary file. */
1828 unlink (software_local);
1829 #undef software_local_len
1835 add_application (guestfs_h *g, struct guestfs_application_list *apps,
1836 const char *name, const char *display_name, int32_t epoch,
1837 const char *version, const char *release,
1838 const char *install_path,
1839 const char *publisher, const char *url,
1840 const char *description)
1843 apps->val = safe_realloc (g, apps->val,
1844 apps->len * sizeof (struct guestfs_application));
1845 apps->val[apps->len-1].app_name = safe_strdup (g, name);
1846 apps->val[apps->len-1].app_display_name = safe_strdup (g, display_name);
1847 apps->val[apps->len-1].app_epoch = epoch;
1848 apps->val[apps->len-1].app_version = safe_strdup (g, version);
1849 apps->val[apps->len-1].app_release = safe_strdup (g, release);
1850 apps->val[apps->len-1].app_install_path = safe_strdup (g, install_path);
1851 /* XXX Translated path is not implemented yet. */
1852 apps->val[apps->len-1].app_trans_path = safe_strdup (g, "");
1853 apps->val[apps->len-1].app_publisher = safe_strdup (g, publisher);
1854 apps->val[apps->len-1].app_url = safe_strdup (g, url);
1855 /* XXX The next two are not yet implemented for any package
1856 * format, but we could easily support them for rpm and deb.
1858 apps->val[apps->len-1].app_source_package = safe_strdup (g, "");
1859 apps->val[apps->len-1].app_summary = safe_strdup (g, "");
1860 apps->val[apps->len-1].app_description = safe_strdup (g, description);
1863 /* Sort applications by name before returning the list. */
1865 compare_applications (const void *vp1, const void *vp2)
1867 const struct guestfs_application *v1 = vp1;
1868 const struct guestfs_application *v2 = vp2;
1870 return strcmp (v1->app_name, v2->app_name);
1874 sort_applications (struct guestfs_application_list *apps)
1876 if (apps && apps->val)
1877 qsort (apps->val, apps->len, sizeof (struct guestfs_application),
1878 compare_applications);
1881 /* Download to a guest file to a local temporary file. Refuse to
1882 * download the guest file if it is larger than max_size. The caller
1883 * is responsible for deleting the temporary file after use.
1886 download_to_tmp (guestfs_h *g, const char *filename,
1887 char *localtmp, int64_t max_size)
1893 size = guestfs_filesize (g, filename);
1895 /* guestfs_filesize failed and has already set error in handle */
1897 if (size > max_size) {
1898 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
1903 fd = mkstemp (localtmp);
1905 perrorf (g, "mkstemp");
1909 snprintf (buf, sizeof buf, "/dev/fd/%d", fd);
1911 if (guestfs_download (g, filename, buf) == -1) {
1917 if (close (fd) == -1) {
1918 perrorf (g, "close: %s", localtmp);
1926 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
1927 * must exist). As a security measure, this bails if the file is too
1928 * large for a reasonable configuration file. After the call to 'f'
1932 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
1933 int (*f) (guestfs_h *, struct inspect_fs *))
1935 /* Security: Refuse to do this if filename is too large. */
1936 int64_t size = guestfs_filesize (g, filename);
1938 /* guestfs_filesize failed and has already set error in handle */
1940 if (size > 100000) {
1941 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
1946 /* If !feature_available (g, "augeas") then the next call will fail.
1947 * Arguably we might want to fall back to a non-Augeas method in
1950 if (guestfs_aug_init (g, "/", 16|32) == -1)
1955 /* Tell Augeas to only load one file (thanks Raphaƫl Pinson). */
1956 char buf[strlen (filename) + 64];
1957 snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
1959 if (guestfs_aug_rm (g, buf) == -1)
1962 if (guestfs_aug_load (g) == -1)
1968 guestfs_aug_close (g);
1973 /* Get the first line of a small file, without any trailing newline
1977 first_line_of_file (guestfs_h *g, const char *filename)
1983 /* Don't trust guestfs_head_n not to break with very large files.
1984 * Check the file size is something reasonable first.
1986 size = guestfs_filesize (g, filename);
1988 /* guestfs_filesize failed and has already set error in handle */
1990 if (size > 1000000) {
1991 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
1996 lines = guestfs_head_n (g, 1, filename);
1999 if (lines[0] == NULL) {
2000 error (g, _("%s: file is empty"), filename);
2001 guestfs___free_string_list (lines);
2004 /* lines[1] should be NULL because of '1' argument above ... */
2006 ret = lines[0]; /* caller frees */
2007 free (lines); /* free the array */
2012 #else /* no PCRE or hivex at compile time */
2014 /* XXX These functions should be in an optgroup. */
2016 #define NOT_IMPL(r) \
2017 error (g, _("inspection API not available since this version of libguestfs was compiled without PCRE or hivex libraries")); \
2021 guestfs__inspect_os (guestfs_h *g)
2027 guestfs__inspect_get_roots (guestfs_h *g)
2033 guestfs__inspect_get_type (guestfs_h *g, const char *root)
2039 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
2045 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
2051 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
2057 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
2063 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
2069 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
2075 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
2081 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
2087 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
2093 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
2098 struct guestfs_application_list *
2099 guestfs__inspect_list_applications (guestfs_h *g, const char *root)
2104 #endif /* no PCRE or hivex at compile time */
2107 guestfs___free_inspect_info (guestfs_h *g)
2110 for (i = 0; i < g->nr_fses; ++i) {
2111 free (g->fses[i].device);
2112 free (g->fses[i].product_name);
2113 free (g->fses[i].arch);
2114 free (g->fses[i].windows_systemroot);
2116 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
2117 free (g->fses[i].fstab[j].device);
2118 free (g->fses[i].fstab[j].mountpoint);
2120 free (g->fses[i].fstab);
2127 /* In the Perl code this is a public function. */
2129 guestfs___feature_available (guestfs_h *g, const char *feature)
2131 /* If there's an error we should ignore it, so to do that we have to
2132 * temporarily replace the error handler with a null one.
2134 guestfs_error_handler_cb old_error_cb = g->error_cb;
2137 const char *groups[] = { feature, NULL };
2138 int r = guestfs_available (g, (char * const *) groups);
2140 g->error_cb = old_error_cb;
2142 return r == 0 ? 1 : 0;
2147 /* Match a regular expression which contains no captures. Returns
2148 * true if it matches or false if it doesn't.
2151 guestfs___match (guestfs_h *g, const char *str, const pcre *re)
2153 size_t len = strlen (str);
2156 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2157 if (r == PCRE_ERROR_NOMATCH)
2160 /* Internal error -- should not happen. */
2161 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2162 __FILE__, __func__, r, str);
2169 /* Match a regular expression which contains exactly one capture. If
2170 * the string matches, return the capture, otherwise return NULL. The
2171 * caller must free the result.
2174 guestfs___match1 (guestfs_h *g, const char *str, const pcre *re)
2176 size_t len = strlen (str);
2179 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
2180 if (r == PCRE_ERROR_NOMATCH)
2183 /* Internal error -- should not happen. */
2184 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2185 __FILE__, __func__, r, str);
2189 return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2192 /* Match a regular expression which contains exactly two captures. */
2194 guestfs___match2 (guestfs_h *g, const char *str, const pcre *re,
2195 char **ret1, char **ret2)
2197 size_t len = strlen (str);
2200 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
2201 if (r == PCRE_ERROR_NOMATCH)
2204 /* Internal error -- should not happen. */
2205 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2206 __FILE__, __func__, r, str);
2210 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2211 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2216 /* Match a regular expression which contains exactly three captures. */
2218 guestfs___match3 (guestfs_h *g, const char *str, const pcre *re,
2219 char **ret1, char **ret2, char **ret3)
2221 size_t len = strlen (str);
2224 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
2225 if (r == PCRE_ERROR_NOMATCH)
2228 /* Internal error -- should not happen. */
2229 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
2230 __FILE__, __func__, r, str);
2234 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
2235 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
2236 *ret3 = safe_strndup (g, &str[vec[6]], vec[7]-vec[6]);
2241 #endif /* HAVE_PCRE */