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_windows_version;
62 static void compile_regexps (void) __attribute__((constructor));
63 static void free_regexps (void) __attribute__((destructor));
66 compile_regexps (void)
71 #define COMPILE(re,pattern,options) \
73 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
75 ignore_value (write (2, err, strlen (err))); \
80 COMPILE (re_fedora, "Fedora release (\\d+)", 0);
82 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
84 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
85 COMPILE (re_rhel_no_minor,
86 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)", 0);
87 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
88 COMPILE (re_aug_seq, "/\\d+$", 0);
89 COMPILE (re_xdev, "^/dev/(?:h|s|v|xv)d([a-z]\\d*)$", 0);
90 COMPILE (re_windows_version, "^(\\d+)\\.(\\d+)", 0);
96 pcre_free (re_fedora);
97 pcre_free (re_rhel_old);
99 pcre_free (re_rhel_no_minor);
100 pcre_free (re_major_minor);
101 pcre_free (re_aug_seq);
103 pcre_free (re_windows_version);
106 /* The main inspection code. */
107 static int check_for_filesystem_on (guestfs_h *g, const char *device);
110 guestfs__inspect_os (guestfs_h *g)
112 /* Remove any information previously stored in the handle. */
113 guestfs___free_inspect_info (g);
115 if (guestfs_umount_all (g) == -1)
118 /* Iterate over all possible devices. Try to mount each
119 * (read-only). Examine ones which contain filesystems and add that
120 * information to the handle.
122 /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
124 devices = guestfs_list_devices (g);
129 for (i = 0; devices[i] != NULL; ++i) {
130 if (check_for_filesystem_on (g, devices[i]) == -1) {
131 guestfs___free_string_list (devices);
132 guestfs___free_inspect_info (g);
136 guestfs___free_string_list (devices);
138 /* Look at all partitions. */
140 partitions = guestfs_list_partitions (g);
141 if (partitions == NULL) {
142 guestfs___free_inspect_info (g);
146 for (i = 0; partitions[i] != NULL; ++i) {
147 if (check_for_filesystem_on (g, partitions[i]) == -1) {
148 guestfs___free_string_list (partitions);
149 guestfs___free_inspect_info (g);
153 guestfs___free_string_list (partitions);
155 /* Look at all LVs. */
156 if (guestfs___feature_available (g, "lvm2")) {
158 lvs = guestfs_lvs (g);
160 guestfs___free_inspect_info (g);
164 for (i = 0; lvs[i] != NULL; ++i) {
165 if (check_for_filesystem_on (g, lvs[i]) == -1) {
166 guestfs___free_string_list (lvs);
167 guestfs___free_inspect_info (g);
171 guestfs___free_string_list (lvs);
174 /* At this point we have, in the handle, a list of all filesystems
175 * found and data about each one. Now we assemble the list of
176 * filesystems which are root devices and return that to the user.
179 for (i = 0; i < g->nr_fses; ++i)
180 if (g->fses[i].is_root)
183 char **ret = calloc (count+1, sizeof (char *));
185 perrorf (g, "calloc");
186 guestfs___free_inspect_info (g);
191 for (i = 0; i < g->nr_fses; ++i) {
192 if (g->fses[i].is_root) {
193 ret[count] = safe_strdup (g, g->fses[i].device);
202 /* Find out if 'device' contains a filesystem. If it does, add
203 * another entry in g->fses.
205 static int check_filesystem (guestfs_h *g, const char *device);
206 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
207 static void check_architecture (guestfs_h *g, struct inspect_fs *fs);
208 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
209 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
210 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
211 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs);
212 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
213 static int extend_fses (guestfs_h *g);
214 static int parse_unsigned_int (guestfs_h *g, const char *str);
215 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
216 const char *spec, const char *mp);
217 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
218 static int download_to_tmp (guestfs_h *g, const char *filename, char *localtmp, int64_t max_size);
219 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
222 check_for_filesystem_on (guestfs_h *g, const char *device)
224 /* Get vfs-type in order to check if it's a Linux(?) swap device.
225 * If there's an error we should ignore it, so to do that we have to
226 * temporarily replace the error handler with a null one.
228 guestfs_error_handler_cb old_error_cb = g->error_cb;
230 char *vfs_type = guestfs_vfs_type (g, device);
231 g->error_cb = old_error_cb;
233 int is_swap = vfs_type && STREQ (vfs_type, "swap");
236 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
237 device, vfs_type ? vfs_type : "failed to get vfs type");
241 if (extend_fses (g) == -1)
243 g->fses[g->nr_fses-1].is_swap = 1;
247 /* Try mounting the device. As above, ignore errors. */
249 int r = guestfs_mount_ro (g, device, "/");
250 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
251 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
253 g->error_cb = old_error_cb;
257 /* Do the rest of the checks. */
258 r = check_filesystem (g, device);
260 /* Unmount the filesystem. */
261 if (guestfs_umount_all (g) == -1)
268 check_filesystem (guestfs_h *g, const char *device)
270 if (extend_fses (g) == -1)
273 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
275 fs->device = safe_strdup (g, device);
276 fs->is_mountable = 1;
279 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
280 guestfs_is_file (g, "/grub/grub.conf") > 0)
281 fs->content = FS_CONTENT_LINUX_BOOT;
283 else if (guestfs_is_dir (g, "/etc") > 0 &&
284 guestfs_is_dir (g, "/bin") > 0 &&
285 guestfs_is_file (g, "/etc/fstab") > 0) {
287 fs->content = FS_CONTENT_LINUX_ROOT;
288 if (check_linux_root (g, fs) == -1)
291 /* Linux /usr/local? */
292 else if (guestfs_is_dir (g, "/etc") > 0 &&
293 guestfs_is_dir (g, "/bin") > 0 &&
294 guestfs_is_dir (g, "/share") > 0 &&
295 guestfs_exists (g, "/local") == 0 &&
296 guestfs_is_file (g, "/etc/fstab") == 0)
297 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
299 else if (guestfs_is_dir (g, "/etc") > 0 &&
300 guestfs_is_dir (g, "/bin") > 0 &&
301 guestfs_is_dir (g, "/share") > 0 &&
302 guestfs_exists (g, "/local") > 0 &&
303 guestfs_is_file (g, "/etc/fstab") == 0)
304 fs->content = FS_CONTENT_LINUX_USR;
306 else if (guestfs_is_dir (g, "/log") > 0 &&
307 guestfs_is_dir (g, "/run") > 0 &&
308 guestfs_is_dir (g, "/spool") > 0)
309 fs->content = FS_CONTENT_LINUX_VAR;
311 else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
312 guestfs_is_file (g, "/autoexec.bat") > 0 ||
313 guestfs_is_dir (g, "/Program Files") > 0 ||
314 guestfs_is_dir (g, "/WINDOWS") > 0 ||
315 guestfs_is_dir (g, "/Windows") > 0 ||
316 guestfs_is_dir (g, "/windows") > 0 ||
317 guestfs_is_dir (g, "/WIN32") > 0 ||
318 guestfs_is_dir (g, "/Win32") > 0 ||
319 guestfs_is_dir (g, "/WINNT") > 0 ||
320 guestfs_is_file (g, "/boot.ini") > 0 ||
321 guestfs_is_file (g, "/ntldr") > 0) {
323 fs->content = FS_CONTENT_WINDOWS_ROOT;
324 if (check_windows_root (g, fs) == -1)
331 /* Set fs->product_name to the first line of the release file. */
333 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
334 const char *release_filename)
336 char **product_name = guestfs_head_n (g, 1, release_filename);
337 if (product_name == NULL)
339 if (product_name[0] == NULL) {
340 error (g, _("%s: file is empty"), release_filename);
341 guestfs___free_string_list (product_name);
345 /* Note that this string becomes owned by the handle and will
346 * be freed by guestfs___free_inspect_info.
348 fs->product_name = product_name[0];
354 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
356 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
360 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
361 fs->major_version = parse_unsigned_int (g, major);
363 if (fs->major_version == -1) {
367 fs->minor_version = parse_unsigned_int (g, minor);
369 if (fs->minor_version == -1)
375 /* Ubuntu has /etc/lsb-release containing:
376 * DISTRIB_ID=Ubuntu # Distro
377 * DISTRIB_RELEASE=10.04 # Version
378 * DISTRIB_CODENAME=lucid
379 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
380 * In theory other distros could have this LSB file, but none do.
383 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
389 lines = guestfs_head_n (g, 10, "/etc/lsb-release");
393 for (i = 0; lines[i] != NULL; ++i) {
394 if (fs->distro == 0 &&
395 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
396 fs->distro = OS_DISTRO_UBUNTU;
399 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
401 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
402 fs->major_version = parse_unsigned_int (g, major);
404 if (fs->major_version == -1) {
406 guestfs___free_string_list (lines);
409 fs->minor_version = parse_unsigned_int (g, minor);
411 if (fs->minor_version == -1) {
412 guestfs___free_string_list (lines);
417 else if (fs->product_name == NULL &&
418 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
419 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
420 size_t len = strlen (lines[i]) - 21 - 1;
421 fs->product_name = safe_strndup (g, &lines[i][21], len);
424 else if (fs->product_name == NULL &&
425 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
426 size_t len = strlen (lines[i]) - 20;
427 fs->product_name = safe_strndup (g, &lines[i][20], len);
432 guestfs___free_string_list (lines);
436 /* The currently mounted device is known to be a Linux root. Try to
437 * determine from this the distro, version, etc. Also parse
438 * /etc/fstab to determine the arrangement of mountpoints and
439 * associated devices.
442 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
446 fs->type = OS_TYPE_LINUX;
448 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
449 r = parse_lsb_release (g, fs);
450 if (r == -1) /* error */
452 if (r == 1) /* ok - detected the release from this file */
453 goto skip_release_checks;
456 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
457 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
459 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
463 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
464 fs->distro = OS_DISTRO_FEDORA;
465 fs->major_version = parse_unsigned_int (g, major);
467 if (fs->major_version == -1)
470 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
471 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
472 fs->distro = OS_DISTRO_RHEL;
473 fs->major_version = parse_unsigned_int (g, major);
475 if (fs->major_version == -1) {
479 fs->minor_version = parse_unsigned_int (g, minor);
481 if (fs->minor_version == -1)
484 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
485 fs->distro = OS_DISTRO_RHEL;
486 fs->major_version = parse_unsigned_int (g, major);
488 if (fs->major_version == -1)
490 fs->minor_version = 0;
493 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
494 fs->distro = OS_DISTRO_DEBIAN;
496 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
499 if (parse_major_minor (g, fs) == -1)
502 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
503 fs->distro = OS_DISTRO_PARDUS;
505 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
508 if (parse_major_minor (g, fs) == -1)
511 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
512 fs->distro = OS_DISTRO_ARCHLINUX;
514 /* /etc/arch-release file is empty and I can't see a way to
515 * determine the actual release or product string.
518 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
519 fs->distro = OS_DISTRO_GENTOO;
521 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
524 if (parse_major_minor (g, fs) == -1)
527 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
528 fs->distro = OS_DISTRO_MEEGO;
530 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
533 if (parse_major_minor (g, fs) == -1)
537 skip_release_checks:;
539 /* Determine the architecture. */
540 check_architecture (g, fs);
542 /* We already know /etc/fstab exists because it's part of the test
543 * for Linux root above. We must now parse this file to determine
544 * which filesystems are used by the operating system and how they
547 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
554 check_architecture (guestfs_h *g, struct inspect_fs *fs)
556 const char *binaries[] =
557 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
560 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
561 if (guestfs_is_file (g, binaries[i]) > 0) {
562 /* Ignore errors from file_architecture call. */
563 guestfs_error_handler_cb old_error_cb = g->error_cb;
565 char *arch = guestfs_file_architecture (g, binaries[i]);
566 g->error_cb = old_error_cb;
569 /* String will be owned by handle, freed by
570 * guestfs___free_inspect_info.
580 check_fstab (guestfs_h *g, struct inspect_fs *fs)
582 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
586 if (lines[0] == NULL) {
587 error (g, _("could not parse /etc/fstab or empty file"));
588 guestfs___free_string_list (lines);
594 for (i = 0; lines[i] != NULL; ++i) {
595 /* Ignore comments. Only care about sequence lines which
598 if (match (g, lines[i], re_aug_seq)) {
599 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
600 char *spec = guestfs_aug_get (g, augpath);
602 guestfs___free_string_list (lines);
606 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
607 char *mp = guestfs_aug_get (g, augpath);
609 guestfs___free_string_list (lines);
614 int r = add_fstab_entry (g, fs, spec, mp);
619 guestfs___free_string_list (lines);
625 guestfs___free_string_list (lines);
629 /* Add a filesystem and possibly a mountpoint entry for
630 * the root filesystem 'fs'.
632 * 'spec' is the fstab spec field, which might be a device name or a
633 * pseudodevice or 'UUID=...' or 'LABEL=...'.
635 * 'mp' is the mount point, which could also be 'swap' or 'none'.
638 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
639 const char *spec, const char *mp)
641 /* Ignore certain mountpoints. */
642 if (STRPREFIX (mp, "/dev/") ||
643 STREQ (mp, "/dev") ||
644 STRPREFIX (mp, "/media/") ||
645 STRPREFIX (mp, "/proc/") ||
646 STREQ (mp, "/proc") ||
647 STRPREFIX (mp, "/selinux/") ||
648 STREQ (mp, "/selinux") ||
649 STRPREFIX (mp, "/sys/") ||
653 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
654 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
655 STREQ (spec, "/dev/floppy") ||
656 STREQ (spec, "/dev/cdrom"))
659 /* Resolve UUID= and LABEL= to the actual device. */
661 if (STRPREFIX (spec, "UUID="))
662 device = guestfs_findfs_uuid (g, &spec[5]);
663 else if (STRPREFIX (spec, "LABEL="))
664 device = guestfs_findfs_label (g, &spec[6]);
665 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
666 else if (STRPREFIX (spec, "/dev/"))
667 /* Resolve guest block device names. */
668 device = resolve_fstab_device (g, spec);
670 /* If we haven't resolved the device successfully by this point,
671 * we don't care, just ignore it.
676 char *mountpoint = safe_strdup (g, mp);
678 /* Add this to the fstab entry in 'fs'.
679 * Note these are further filtered by guestfs_inspect_get_mountpoints
680 * and guestfs_inspect_get_filesystems.
682 size_t n = fs->nr_fstab + 1;
683 struct inspect_fstab_entry *p;
685 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
687 perrorf (g, "realloc");
696 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
697 fs->fstab[n-1].device = device;
698 fs->fstab[n-1].mountpoint = mountpoint;
701 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
706 /* Resolve block device name to the libguestfs device name, eg.
707 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
708 * assumes that disks were added in the same order as they appear to
709 * the real VM, which is a reasonable assumption to make. Return
710 * anything we don't recognize unchanged.
713 resolve_fstab_device (guestfs_h *g, const char *spec)
718 if (STRPREFIX (spec, "/dev/mapper/")) {
719 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
720 * LVs which contain '-' character:
722 * ><fs> lvcreate LV--test VG--test 32
723 * ><fs> debug ls /dev/mapper
724 * VG----test-LV----test
726 * This makes it impossible to reverse those paths directly, so
727 * we have implemented lvm_canonical_lv_name in the daemon.
729 device = guestfs_lvm_canonical_lv_name (g, spec);
731 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
732 char **devices = guestfs_list_devices (g);
737 for (count = 0; devices[count] != NULL; count++)
740 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
742 size_t len = strlen (devices[i]) + strlen (a1) + 16;
743 device = safe_malloc (g, len);
744 snprintf (device, len, "%s%s", devices[i], &a1[1]);
748 guestfs___free_string_list (devices);
751 /* Didn't match device pattern, return original spec unchanged. */
752 device = safe_strdup (g, spec);
758 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
759 * essentially didn't do anything for modern Windows guests.
760 * Therefore I've omitted all that code.
763 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
765 fs->type = OS_TYPE_WINDOWS;
766 fs->distro = OS_DISTRO_WINDOWS;
768 /* Try to find Windows systemroot using some common locations. */
769 const char *systemroots[] =
770 { "/windows", "/winnt", "/win32", "/win" };
772 char *systemroot = NULL;
774 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
776 systemroot = resolve_windows_path_silently (g, systemroots[i]);
780 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
785 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
787 /* Freed by guestfs___free_inspect_info. */
788 fs->windows_systemroot = systemroot;
790 if (check_windows_arch (g, fs) == -1)
793 if (check_windows_registry (g, fs) == -1)
800 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
802 size_t len = strlen (fs->windows_systemroot) + 32;
804 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
806 char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
810 char *arch = guestfs_file_architecture (g, cmd_exe_path);
814 fs->arch = arch; /* freed by guestfs___free_inspect_info */
819 /* At the moment, pull just the ProductName and version numbers from
820 * the registry. In future there is a case for making many more
821 * registry fields available to callers.
824 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
826 TMP_TEMPLATE_ON_STACK (software_local);
828 size_t len = strlen (fs->windows_systemroot) + 64;
830 snprintf (software, len, "%s/system32/config/software",
831 fs->windows_systemroot);
833 char *software_path = resolve_windows_path_silently (g, software);
835 /* If the software hive doesn't exist, just accept that we cannot
836 * find product_name etc.
842 hive_value_h *values = NULL;
844 if (download_to_tmp (g, software_path, software_local, 100000000) == -1)
847 h = hivex_open (software_local, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
849 perrorf (g, "hivex_open");
853 hive_node_h node = hivex_root (h);
854 const char *hivepath[] =
855 { "Microsoft", "Windows NT", "CurrentVersion" };
858 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
860 node = hivex_node_get_child (h, node, hivepath[i]);
864 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
868 values = hivex_node_values (h, node);
870 for (i = 0; values[i] != 0; ++i) {
871 char *key = hivex_value_key (h, values[i]);
873 perrorf (g, "hivex_value_key");
877 if (STRCASEEQ (key, "ProductName")) {
878 fs->product_name = hivex_value_string (h, values[i]);
879 if (!fs->product_name) {
880 perrorf (g, "hivex_value_string");
885 else if (STRCASEEQ (key, "CurrentVersion")) {
886 char *version = hivex_value_string (h, values[i]);
888 perrorf (g, "hivex_value_string");
893 if (match2 (g, version, re_windows_version, &major, &minor)) {
894 fs->major_version = parse_unsigned_int (g, major);
896 if (fs->major_version == -1) {
902 fs->minor_version = parse_unsigned_int (g, minor);
904 if (fs->minor_version == -1) {
920 if (h) hivex_close (h);
922 free (software_path);
924 /* Free up the temporary file. */
925 unlink (software_local);
926 #undef software_local_len
932 resolve_windows_path_silently (guestfs_h *g, const char *path)
934 guestfs_error_handler_cb old_error_cb = g->error_cb;
936 char *ret = guestfs_case_sensitive_path (g, path);
937 g->error_cb = old_error_cb;
942 extend_fses (guestfs_h *g)
944 size_t n = g->nr_fses + 1;
945 struct inspect_fs *p;
947 p = realloc (g->fses, n * sizeof (struct inspect_fs));
949 perrorf (g, "realloc");
956 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
961 /* Parse small, unsigned ints, as used in version numbers. */
963 parse_unsigned_int (guestfs_h *g, const char *str)
966 int r = xstrtol (str, NULL, 10, &ret, "");
967 if (r != LONGINT_OK) {
968 error (g, _("could not parse integer in version number: %s"), str);
974 static struct inspect_fs *
975 search_for_root (guestfs_h *g, const char *root)
977 if (g->nr_fses == 0) {
978 error (g, _("no inspection data: call guestfs_inspect_os first"));
983 struct inspect_fs *fs;
984 for (i = 0; i < g->nr_fses; ++i) {
986 if (fs->is_root && STREQ (root, fs->device))
990 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
996 guestfs__inspect_get_type (guestfs_h *g, const char *root)
998 struct inspect_fs *fs = search_for_root (g, root);
1004 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1005 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1006 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1013 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1015 struct inspect_fs *fs = search_for_root (g, root);
1019 return safe_strdup (g, fs->arch ? : "unknown");
1023 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1025 struct inspect_fs *fs = search_for_root (g, root);
1030 switch (fs->distro) {
1031 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1032 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1033 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1034 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1035 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1036 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1037 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1038 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1039 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1040 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1041 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1048 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1050 struct inspect_fs *fs = search_for_root (g, root);
1054 return fs->major_version;
1058 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1060 struct inspect_fs *fs = search_for_root (g, root);
1064 return fs->minor_version;
1068 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1070 struct inspect_fs *fs = search_for_root (g, root);
1074 return safe_strdup (g, fs->product_name ? : "unknown");
1078 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1080 struct inspect_fs *fs = search_for_root (g, root);
1084 if (!fs->windows_systemroot) {
1085 error (g, _("not a Windows guest, or systemroot could not be determined"));
1089 return safe_strdup (g, fs->windows_systemroot);
1093 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1095 struct inspect_fs *fs = search_for_root (g, root);
1101 /* If no fstab information (Windows) return just the root. */
1102 if (fs->nr_fstab == 0) {
1103 ret = calloc (3, sizeof (char *));
1104 ret[0] = safe_strdup (g, "/");
1105 ret[1] = safe_strdup (g, root);
1110 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1111 size_t i, count = 0;
1112 for (i = 0; i < fs->nr_fstab; ++i)
1116 /* Hashtables have 2N+1 entries. */
1117 ret = calloc (2*count+1, sizeof (char *));
1119 perrorf (g, "calloc");
1124 for (i = 0; i < fs->nr_fstab; ++i)
1126 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1127 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1136 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1138 struct inspect_fs *fs = search_for_root (g, root);
1144 /* If no fstab information (Windows) return just the root. */
1145 if (fs->nr_fstab == 0) {
1146 ret = calloc (2, sizeof (char *));
1147 ret[0] = safe_strdup (g, root);
1152 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1154 perrorf (g, "calloc");
1159 for (i = 0; i < fs->nr_fstab; ++i)
1160 ret[i] = safe_strdup (g, fs->fstab[i].device);
1165 /* Download to a guest file to a local temporary file. Refuse to
1166 * download the guest file if it is larger than max_size. The caller
1167 * is responsible for deleting the temporary file after use.
1170 download_to_tmp (guestfs_h *g, const char *filename,
1171 char *localtmp, int64_t max_size)
1177 size = guestfs_filesize (g, filename);
1179 /* guestfs_filesize failed and has already set error in handle */
1181 if (size > max_size) {
1182 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
1187 fd = mkstemp (localtmp);
1189 perrorf (g, "mkstemp");
1193 snprintf (buf, sizeof buf, "/dev/fd/%d", fd);
1195 if (guestfs_download (g, filename, buf) == -1) {
1201 if (close (fd) == -1) {
1202 perrorf (g, "close: %s", localtmp);
1210 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
1211 * must exist). As a security measure, this bails if the file is too
1212 * large for a reasonable configuration file. After the call to 'f'
1216 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
1217 int (*f) (guestfs_h *, struct inspect_fs *))
1219 /* Security: Refuse to do this if filename is too large. */
1220 int64_t size = guestfs_filesize (g, filename);
1222 /* guestfs_filesize failed and has already set error in handle */
1224 if (size > 100000) {
1225 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
1230 /* If !feature_available (g, "augeas") then the next call will fail.
1231 * Arguably we might want to fall back to a non-Augeas method in
1234 if (guestfs_aug_init (g, "/", 16|32) == -1)
1239 /* Tell Augeas to only load one file (thanks Raphaƫl Pinson). */
1240 char buf[strlen (filename) + 64];
1241 snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
1243 if (guestfs_aug_rm (g, buf) == -1)
1246 if (guestfs_aug_load (g) == -1)
1252 guestfs_aug_close (g);
1257 #else /* no PCRE or hivex at compile time */
1259 /* XXX These functions should be in an optgroup. */
1261 #define NOT_IMPL(r) \
1262 error (g, _("inspection API not available since this version of libguestfs was compiled without PCRE or hivex libraries")); \
1266 guestfs__inspect_os (guestfs_h *g)
1272 guestfs__inspect_get_roots (guestfs_h *g)
1278 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1284 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1290 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1296 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1302 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1308 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1314 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1320 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1326 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1331 #endif /* no PCRE or hivex at compile time */
1334 guestfs___free_inspect_info (guestfs_h *g)
1337 for (i = 0; i < g->nr_fses; ++i) {
1338 free (g->fses[i].device);
1339 free (g->fses[i].product_name);
1340 free (g->fses[i].arch);
1341 free (g->fses[i].windows_systemroot);
1343 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
1344 free (g->fses[i].fstab[j].device);
1345 free (g->fses[i].fstab[j].mountpoint);
1347 free (g->fses[i].fstab);
1354 /* In the Perl code this is a public function. */
1356 guestfs___feature_available (guestfs_h *g, const char *feature)
1358 /* If there's an error we should ignore it, so to do that we have to
1359 * temporarily replace the error handler with a null one.
1361 guestfs_error_handler_cb old_error_cb = g->error_cb;
1364 const char *groups[] = { feature, NULL };
1365 int r = guestfs_available (g, (char * const *) groups);
1367 g->error_cb = old_error_cb;
1369 return r == 0 ? 1 : 0;
1374 /* Match a regular expression which contains no captures. Returns
1375 * true if it matches or false if it doesn't.
1378 guestfs___match (guestfs_h *g, const char *str, const pcre *re)
1380 size_t len = strlen (str);
1383 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
1384 if (r == PCRE_ERROR_NOMATCH)
1387 /* Internal error -- should not happen. */
1388 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
1389 __FILE__, __func__, r, str);
1396 /* Match a regular expression which contains exactly one capture. If
1397 * the string matches, return the capture, otherwise return NULL. The
1398 * caller must free the result.
1401 guestfs___match1 (guestfs_h *g, const char *str, const pcre *re)
1403 size_t len = strlen (str);
1406 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
1407 if (r == PCRE_ERROR_NOMATCH)
1410 /* Internal error -- should not happen. */
1411 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
1412 __FILE__, __func__, r, str);
1416 return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
1419 /* Match a regular expression which contains exactly two captures. */
1421 guestfs___match2 (guestfs_h *g, const char *str, const pcre *re,
1422 char **ret1, char **ret2)
1424 size_t len = strlen (str);
1427 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
1428 if (r == PCRE_ERROR_NOMATCH)
1431 /* Internal error -- should not happen. */
1432 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
1433 __FILE__, __func__, r, str);
1437 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
1438 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
1443 /* Match a regular expression which contains exactly three captures. */
1445 guestfs___match3 (guestfs_h *g, const char *str, const pcre *re,
1446 char **ret1, char **ret2, char **ret3)
1448 size_t len = strlen (str);
1451 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
1452 if (r == PCRE_ERROR_NOMATCH)
1455 /* Internal error -- should not happen. */
1456 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
1457 __FILE__, __func__, r, str);
1461 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
1462 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
1463 *ret3 = safe_strndup (g, &str[vec[6]], vec[7]-vec[6]);
1468 #endif /* HAVE_PCRE */