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
35 #include "ignore-value.h"
39 #include "guestfs-internal.h"
40 #include "guestfs-internal-actions.h"
41 #include "guestfs_protocol.h"
43 /* Compile all the regular expressions once when the shared library is
44 * loaded. PCRE is thread safe so we're supposedly OK here if
45 * multiple threads call into the libguestfs API functions below
48 static pcre *re_file_elf;
49 static pcre *re_file_win64;
50 static pcre *re_elf_ppc64;
51 static pcre *re_fedora;
52 static pcre *re_rhel_old;
54 static pcre *re_rhel_no_minor;
55 static pcre *re_major_minor;
56 static pcre *re_aug_seq;
58 static pcre *re_windows_version;
60 static void compile_regexps (void) __attribute__((constructor));
61 static void free_regexps (void) __attribute__((destructor));
64 compile_regexps (void)
69 #define COMPILE(re,pattern,options) \
71 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
73 ignore_value (write (2, err, strlen (err))); \
79 "ELF.*(?:executable|shared object|relocatable), (.+?),", 0);
80 COMPILE (re_elf_ppc64, "64.*PowerPC", 0);
81 COMPILE (re_fedora, "Fedora release (\\d+)", 0);
83 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
85 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
86 COMPILE (re_rhel_no_minor,
87 "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+)", 0);
88 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
89 COMPILE (re_aug_seq, "/\\d+$", 0);
90 COMPILE (re_xdev, "^/dev/(?:h|s|v|xv)d([a-z]\\d*)$", 0);
91 COMPILE (re_windows_version, "^(\\d+)\\.(\\d+)", 0);
97 pcre_free (re_file_elf);
98 pcre_free (re_file_win64);
99 pcre_free (re_elf_ppc64);
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_windows_version);
110 /* Match a regular expression which contains no captures. Returns
111 * true if it matches or false if it doesn't.
114 match (guestfs_h *g, const char *str, const pcre *re)
116 size_t len = strlen (str);
119 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
120 if (r == PCRE_ERROR_NOMATCH)
123 /* Internal error -- should not happen. */
124 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
125 __FILE__, __func__, r, str);
132 /* Match a regular expression which contains exactly one capture. If
133 * the string matches, return the capture, otherwise return NULL. The
134 * caller must free the result.
137 match1 (guestfs_h *g, const char *str, const pcre *re)
139 size_t len = strlen (str);
142 r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
143 if (r == PCRE_ERROR_NOMATCH)
146 /* Internal error -- should not happen. */
147 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
148 __FILE__, __func__, r, str);
152 return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
155 /* Match a regular expression which contains exactly two captures. */
157 match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2)
159 size_t len = strlen (str);
162 r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
163 if (r == PCRE_ERROR_NOMATCH)
166 /* Internal error -- should not happen. */
167 fprintf (stderr, "libguestfs: %s: %s: internal error: pcre_exec returned unexpected error code %d when matching against the string \"%s\"\n",
168 __FILE__, __func__, r, str);
172 *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
173 *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
178 /* Convert output from 'file' command on ELF files to the canonical
179 * architecture string. Caller must free the result.
182 canonical_elf_arch (guestfs_h *g, const char *elf_arch)
186 if (strstr (elf_arch, "Intel 80386"))
188 else if (strstr (elf_arch, "Intel 80486"))
190 else if (strstr (elf_arch, "x86-64"))
192 else if (strstr (elf_arch, "AMD x86-64"))
194 else if (strstr (elf_arch, "SPARC32"))
196 else if (strstr (elf_arch, "SPARC V9"))
198 else if (strstr (elf_arch, "IA-64"))
200 else if (match (g, elf_arch, re_elf_ppc64))
202 else if (strstr (elf_arch, "PowerPC"))
207 char *ret = safe_strdup (g, r);
212 is_regular_file (const char *filename)
216 return lstat (filename, &statbuf) == 0 && S_ISREG (statbuf.st_mode);
219 /* Download and uncompress the cpio file to find binaries within.
221 * (1) Two lists must be identical.
222 * (2) Implicit limit of 31 bytes for length of each element (see code
225 #define INITRD_BINARIES1 "bin/ls bin/rm bin/modprobe sbin/modprobe bin/sh bin/bash bin/dash bin/nash"
226 #define INITRD_BINARIES2 {"bin/ls", "bin/rm", "bin/modprobe", "sbin/modprobe", "bin/sh", "bin/bash", "bin/dash", "bin/nash"}
229 cpio_arch (guestfs_h *g, const char *file, const char *path)
231 TMP_TEMPLATE_ON_STACK (dir);
232 #define dir_len (strlen (dir))
233 #define initrd_len (dir_len + 16)
234 char initrd[initrd_len];
235 #define cmd_len (dir_len + 256)
237 #define bin_len (dir_len + 32)
243 if (strstr (file, "gzip"))
245 else if (strstr (file, "bzip2"))
250 if (mkdtemp (dir) == NULL) {
251 perrorf (g, "mkdtemp");
255 snprintf (initrd, initrd_len, "%s/initrd", dir);
256 if (guestfs_download (g, path, initrd) == -1)
259 snprintf (cmd, cmd_len,
260 "cd %s && %s initrd | cpio --quiet -id " INITRD_BINARIES1,
262 int r = system (cmd);
263 if (r == -1 || WEXITSTATUS (r) != 0) {
264 perrorf (g, "cpio command failed");
268 const char *bins[] = INITRD_BINARIES2;
270 for (i = 0; i < sizeof bins / sizeof bins[0]; ++i) {
271 snprintf (bin, bin_len, "%s/%s", dir, bins[i]);
273 if (is_regular_file (bin)) {
274 int flags = g->verbose ? MAGIC_DEBUG : 0;
275 flags |= MAGIC_ERROR | MAGIC_RAW;
277 magic_t m = magic_open (flags);
279 perrorf (g, "magic_open");
283 if (magic_load (m, NULL) == -1) {
284 perrorf (g, "magic_load: default magic database file");
289 const char *line = magic_file (m, bin);
291 perrorf (g, "magic_file: %s", bin);
297 if ((elf_arch = match1 (g, line, re_file_elf)) != NULL) {
298 ret = canonical_elf_arch (g, elf_arch);
306 error (g, "file_architecture: could not determine architecture of cpio archive");
309 /* Free up the temporary directory. Note the directory name cannot
310 * contain shell meta-characters because of the way it was
313 snprintf (cmd, cmd_len, "rm -rf %s", dir);
314 ignore_value (system (cmd));
324 guestfs__file_architecture (guestfs_h *g, const char *path)
327 char *elf_arch = NULL;
330 /* Get the output of the "file" command. Note that because this
331 * runs in the daemon, LANG=C so it's in English.
333 file = guestfs_file (g, path);
337 if ((elf_arch = match1 (g, file, re_file_elf)) != NULL)
338 ret = canonical_elf_arch (g, elf_arch);
339 else if (strstr (file, "PE32 executable"))
340 ret = safe_strdup (g, "i386");
341 else if (strstr (file, "PE32+ executable"))
342 ret = safe_strdup (g, "x86_64");
343 else if (strstr (file, "cpio archive"))
344 ret = cpio_arch (g, file, path);
346 error (g, "file_architecture: unknown architecture: %s", path);
350 return ret; /* caller frees */
353 /* The main inspection code. */
354 static int feature_available (guestfs_h *g, const char *feature);
355 static void free_string_list (char **);
356 static int check_for_filesystem_on (guestfs_h *g, const char *device);
359 guestfs__inspect_os (guestfs_h *g)
361 /* Remove any information previously stored in the handle. */
362 guestfs___free_inspect_info (g);
364 if (guestfs_umount_all (g) == -1)
367 /* Iterate over all possible devices. Try to mount each
368 * (read-only). Examine ones which contain filesystems and add that
369 * information to the handle.
371 /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
373 devices = guestfs_list_devices (g);
378 for (i = 0; devices[i] != NULL; ++i) {
379 if (check_for_filesystem_on (g, devices[i]) == -1) {
380 free_string_list (devices);
381 guestfs___free_inspect_info (g);
385 free_string_list (devices);
387 /* Look at all partitions. */
389 partitions = guestfs_list_partitions (g);
390 if (partitions == NULL) {
391 guestfs___free_inspect_info (g);
395 for (i = 0; partitions[i] != NULL; ++i) {
396 if (check_for_filesystem_on (g, partitions[i]) == -1) {
397 free_string_list (partitions);
398 guestfs___free_inspect_info (g);
402 free_string_list (partitions);
404 /* Look at all LVs. */
405 if (feature_available (g, "lvm2")) {
407 lvs = guestfs_lvs (g);
409 guestfs___free_inspect_info (g);
413 for (i = 0; lvs[i] != NULL; ++i) {
414 if (check_for_filesystem_on (g, lvs[i]) == -1) {
415 free_string_list (lvs);
416 guestfs___free_inspect_info (g);
420 free_string_list (lvs);
423 /* At this point we have, in the handle, a list of all filesystems
424 * found and data about each one. Now we assemble the list of
425 * filesystems which are root devices and return that to the user.
428 for (i = 0; i < g->nr_fses; ++i)
429 if (g->fses[i].is_root)
432 char **ret = calloc (count+1, sizeof (char *));
434 perrorf (g, "calloc");
435 guestfs___free_inspect_info (g);
440 for (i = 0; i < g->nr_fses; ++i) {
441 if (g->fses[i].is_root) {
442 ret[count] = safe_strdup (g, g->fses[i].device);
452 guestfs___free_inspect_info (guestfs_h *g)
455 for (i = 0; i < g->nr_fses; ++i) {
456 free (g->fses[i].device);
457 free (g->fses[i].product_name);
458 free (g->fses[i].arch);
459 free (g->fses[i].windows_systemroot);
461 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
462 free (g->fses[i].fstab[j].device);
463 free (g->fses[i].fstab[j].mountpoint);
465 free (g->fses[i].fstab);
473 free_string_list (char **argv)
476 for (i = 0; argv[i] != NULL; ++i)
481 /* In the Perl code this is a public function. */
483 feature_available (guestfs_h *g, const char *feature)
485 /* If there's an error we should ignore it, so to do that we have to
486 * temporarily replace the error handler with a null one.
488 guestfs_error_handler_cb old_error_cb = g->error_cb;
491 const char *groups[] = { feature, NULL };
492 int r = guestfs_available (g, (char * const *) groups);
494 g->error_cb = old_error_cb;
496 return r == 0 ? 1 : 0;
499 /* Find out if 'device' contains a filesystem. If it does, add
500 * another entry in g->fses.
502 static int check_filesystem (guestfs_h *g, const char *device);
503 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
504 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
505 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
506 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
507 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs);
508 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
509 static int extend_fses (guestfs_h *g);
510 static int parse_unsigned_int (guestfs_h *g, const char *str);
511 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
512 const char *spec, const char *mp);
513 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
516 check_for_filesystem_on (guestfs_h *g, const char *device)
518 /* Get vfs-type in order to check if it's a Linux(?) swap device.
519 * If there's an error we should ignore it, so to do that we have to
520 * temporarily replace the error handler with a null one.
522 guestfs_error_handler_cb old_error_cb = g->error_cb;
524 char *vfs_type = guestfs_vfs_type (g, device);
525 g->error_cb = old_error_cb;
527 int is_swap = vfs_type && STREQ (vfs_type, "swap");
530 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
531 device, vfs_type ? vfs_type : "failed to get vfs type");
535 if (extend_fses (g) == -1)
537 g->fses[g->nr_fses-1].is_swap = 1;
541 /* Try mounting the device. As above, ignore errors. */
543 int r = guestfs_mount_ro (g, device, "/");
544 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
545 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
547 g->error_cb = old_error_cb;
551 /* Do the rest of the checks. */
552 r = check_filesystem (g, device);
554 /* Unmount the filesystem. */
555 if (guestfs_umount_all (g) == -1)
562 check_filesystem (guestfs_h *g, const char *device)
564 if (extend_fses (g) == -1)
567 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
569 fs->device = safe_strdup (g, device);
570 fs->is_mountable = 1;
573 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
574 guestfs_is_file (g, "/grub/grub.conf") > 0)
575 fs->content = FS_CONTENT_LINUX_BOOT;
577 else if (guestfs_is_dir (g, "/etc") > 0 &&
578 guestfs_is_dir (g, "/bin") > 0 &&
579 guestfs_is_file (g, "/etc/fstab") > 0) {
581 fs->content = FS_CONTENT_LINUX_ROOT;
582 if (check_linux_root (g, fs) == -1)
585 /* Linux /usr/local? */
586 else if (guestfs_is_dir (g, "/etc") > 0 &&
587 guestfs_is_dir (g, "/bin") > 0 &&
588 guestfs_is_dir (g, "/share") > 0 &&
589 guestfs_exists (g, "/local") == 0 &&
590 guestfs_is_file (g, "/etc/fstab") == 0)
591 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
593 else if (guestfs_is_dir (g, "/etc") > 0 &&
594 guestfs_is_dir (g, "/bin") > 0 &&
595 guestfs_is_dir (g, "/share") > 0 &&
596 guestfs_exists (g, "/local") > 0 &&
597 guestfs_is_file (g, "/etc/fstab") == 0)
598 fs->content = FS_CONTENT_LINUX_USR;
600 else if (guestfs_is_dir (g, "/log") > 0 &&
601 guestfs_is_dir (g, "/run") > 0 &&
602 guestfs_is_dir (g, "/spool") > 0)
603 fs->content = FS_CONTENT_LINUX_VAR;
605 else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
606 guestfs_is_file (g, "/autoexec.bat") > 0 ||
607 guestfs_is_dir (g, "/Program Files") > 0 ||
608 guestfs_is_dir (g, "/WINDOWS") > 0 ||
609 guestfs_is_dir (g, "/Windows") > 0 ||
610 guestfs_is_dir (g, "/windows") > 0 ||
611 guestfs_is_dir (g, "/WIN32") > 0 ||
612 guestfs_is_dir (g, "/Win32") > 0 ||
613 guestfs_is_dir (g, "/WINNT") > 0 ||
614 guestfs_is_file (g, "/boot.ini") > 0 ||
615 guestfs_is_file (g, "/ntldr") > 0) {
617 fs->content = FS_CONTENT_WINDOWS_ROOT;
618 if (check_windows_root (g, fs) == -1)
625 /* Set fs->product_name to the first line of the release file. */
627 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
628 const char *release_filename)
630 char **product_name = guestfs_head_n (g, 1, release_filename);
631 if (product_name == NULL)
633 if (product_name[0] == NULL) {
634 error (g, "%s: file is empty", release_filename);
635 free_string_list (product_name);
639 /* Note that this string becomes owned by the handle and will
640 * be freed by guestfs___free_inspect_info.
642 fs->product_name = product_name[0];
648 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
650 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
654 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
655 fs->major_version = parse_unsigned_int (g, major);
657 if (fs->major_version == -1) {
661 fs->minor_version = parse_unsigned_int (g, minor);
663 if (fs->minor_version == -1)
669 /* Ubuntu has /etc/lsb-release containing:
670 * DISTRIB_ID=Ubuntu # Distro
671 * DISTRIB_RELEASE=10.04 # Version
672 * DISTRIB_CODENAME=lucid
673 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
674 * In theory other distros could have this LSB file, but none do.
677 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
683 lines = guestfs_head_n (g, 10, "/etc/lsb-release");
687 for (i = 0; lines[i] != NULL; ++i) {
688 if (fs->distro == 0 &&
689 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
690 fs->distro = OS_DISTRO_UBUNTU;
693 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
695 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
696 fs->major_version = parse_unsigned_int (g, major);
698 if (fs->major_version == -1) {
700 free_string_list (lines);
703 fs->minor_version = parse_unsigned_int (g, minor);
705 if (fs->minor_version == -1) {
706 free_string_list (lines);
711 else if (fs->product_name == NULL &&
712 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
713 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
714 size_t len = strlen (lines[i]) - 21 - 1;
715 fs->product_name = safe_strndup (g, &lines[i][21], len);
718 else if (fs->product_name == NULL &&
719 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
720 size_t len = strlen (lines[i]) - 20;
721 fs->product_name = safe_strndup (g, &lines[i][20], len);
726 free_string_list (lines);
730 /* The currently mounted device is known to be a Linux root. Try to
731 * determine from this the distro, version, etc. Also parse
732 * /etc/fstab to determine the arrangement of mountpoints and
733 * associated devices.
736 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
740 fs->type = OS_TYPE_LINUX;
742 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
743 r = parse_lsb_release (g, fs);
744 if (r == -1) /* error */
746 if (r == 1) /* ok - detected the release from this file */
747 goto skip_release_checks;
750 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
751 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
753 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
757 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
758 fs->distro = OS_DISTRO_FEDORA;
759 fs->major_version = parse_unsigned_int (g, major);
761 if (fs->major_version == -1)
764 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
765 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
766 fs->distro = OS_DISTRO_RHEL;
767 fs->major_version = parse_unsigned_int (g, major);
769 if (fs->major_version == -1) {
773 fs->minor_version = parse_unsigned_int (g, minor);
775 if (fs->minor_version == -1)
778 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
779 fs->distro = OS_DISTRO_RHEL;
780 fs->major_version = parse_unsigned_int (g, major);
782 if (fs->major_version == -1)
784 fs->minor_version = 0;
787 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
788 fs->distro = OS_DISTRO_DEBIAN;
790 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
793 if (parse_major_minor (g, fs) == -1)
796 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
797 fs->distro = OS_DISTRO_PARDUS;
799 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
802 if (parse_major_minor (g, fs) == -1)
805 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
806 fs->distro = OS_DISTRO_ARCHLINUX;
808 /* /etc/arch-release file is empty and I can't see a way to
809 * determine the actual release or product string.
812 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
813 fs->distro = OS_DISTRO_GENTOO;
815 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
818 if (parse_major_minor (g, fs) == -1)
821 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
822 fs->distro = OS_DISTRO_MEEGO;
824 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
827 if (parse_major_minor (g, fs) == -1)
831 skip_release_checks:;
833 /* Determine the architecture. */
834 const char *binaries[] =
835 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
837 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
838 if (guestfs_is_file (g, binaries[i]) > 0) {
839 /* Ignore errors from file_architecture call. */
840 guestfs_error_handler_cb old_error_cb = g->error_cb;
842 char *arch = guestfs_file_architecture (g, binaries[i]);
843 g->error_cb = old_error_cb;
846 /* String will be owned by handle, freed by
847 * guestfs___free_inspect_info.
855 /* We already know /etc/fstab exists because it's part of the test
856 * for Linux root above. We must now parse this file to determine
857 * which filesystems are used by the operating system and how they
859 * XXX What if !feature_available (g, "augeas")?
861 if (guestfs_aug_init (g, "/", AUG_NO_LOAD|AUG_SAVE_NOOP) == -1)
864 /* Tell Augeas to only load /etc/fstab (thanks Raphaël Pinson). */
865 guestfs_aug_rm (g, "/augeas/load//incl[. != \"/etc/fstab\"]");
866 guestfs_aug_load (g);
868 r = check_fstab (g, fs);
869 guestfs_aug_close (g);
877 check_fstab (guestfs_h *g, struct inspect_fs *fs)
879 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
883 if (lines[0] == NULL) {
884 error (g, "could not parse /etc/fstab or empty file");
885 free_string_list (lines);
891 for (i = 0; lines[i] != NULL; ++i) {
892 /* Ignore comments. Only care about sequence lines which
895 if (match (g, lines[i], re_aug_seq)) {
896 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
897 char *spec = guestfs_aug_get (g, augpath);
899 free_string_list (lines);
903 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
904 char *mp = guestfs_aug_get (g, augpath);
906 free_string_list (lines);
911 int r = add_fstab_entry (g, fs, spec, mp);
916 free_string_list (lines);
922 free_string_list (lines);
926 /* Add a filesystem and possibly a mountpoint entry for
927 * the root filesystem 'fs'.
929 * 'spec' is the fstab spec field, which might be a device name or a
930 * pseudodevice or 'UUID=...' or 'LABEL=...'.
932 * 'mp' is the mount point, which could also be 'swap' or 'none'.
935 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
936 const char *spec, const char *mp)
938 /* Ignore certain mountpoints. */
939 if (STRPREFIX (mp, "/dev/") ||
940 STREQ (mp, "/dev") ||
941 STRPREFIX (mp, "/media/") ||
942 STRPREFIX (mp, "/proc/") ||
943 STREQ (mp, "/proc") ||
944 STRPREFIX (mp, "/selinux/") ||
945 STREQ (mp, "/selinux") ||
946 STRPREFIX (mp, "/sys/") ||
950 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
951 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
952 STREQ (spec, "/dev/floppy") ||
953 STREQ (spec, "/dev/cdrom"))
956 /* Resolve UUID= and LABEL= to the actual device. */
958 if (STRPREFIX (spec, "UUID="))
959 device = guestfs_findfs_uuid (g, &spec[5]);
960 else if (STRPREFIX (spec, "LABEL="))
961 device = guestfs_findfs_label (g, &spec[6]);
962 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
963 else if (STRPREFIX (spec, "/dev/"))
964 /* Resolve guest block device names. */
965 device = resolve_fstab_device (g, spec);
967 /* If we haven't resolved the device successfully by this point,
968 * we don't care, just ignore it.
973 char *mountpoint = safe_strdup (g, mp);
975 /* Add this to the fstab entry in 'fs'.
976 * Note these are further filtered by guestfs_inspect_get_mountpoints
977 * and guestfs_inspect_get_filesystems.
979 size_t n = fs->nr_fstab + 1;
980 struct inspect_fstab_entry *p;
982 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
984 perrorf (g, "realloc");
993 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
994 fs->fstab[n-1].device = device;
995 fs->fstab[n-1].mountpoint = mountpoint;
998 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
1003 /* Resolve block device name to the libguestfs device name, eg.
1004 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
1005 * assumes that disks were added in the same order as they appear to
1006 * the real VM, which is a reasonable assumption to make. Return
1007 * anything we don't recognize unchanged.
1010 resolve_fstab_device (guestfs_h *g, const char *spec)
1013 char *device = NULL;
1015 if (STRPREFIX (spec, "/dev/mapper/")) {
1016 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
1017 * LVs which contain '-' character:
1019 * ><fs> lvcreate LV--test VG--test 32
1020 * ><fs> debug ls /dev/mapper
1021 * VG----test-LV----test
1023 * This makes it impossible to reverse those paths directly, so
1024 * we have implemented lvm_canonical_lv_name in the daemon.
1026 device = guestfs_lvm_canonical_lv_name (g, spec);
1028 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
1029 char **devices = guestfs_list_devices (g);
1030 if (devices == NULL)
1034 for (count = 0; devices[count] != NULL; count++)
1037 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
1039 size_t len = strlen (devices[i]) + strlen (a1) + 16;
1040 device = safe_malloc (g, len);
1041 snprintf (device, len, "%s%s", devices[i], &a1[1]);
1045 free_string_list (devices);
1048 /* Didn't match device pattern, return original spec unchanged. */
1049 device = safe_strdup (g, spec);
1055 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
1056 * essentially didn't do anything for modern Windows guests.
1057 * Therefore I've omitted all that code.
1060 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
1062 fs->type = OS_TYPE_WINDOWS;
1063 fs->distro = OS_DISTRO_WINDOWS;
1065 /* Try to find Windows systemroot using some common locations. */
1066 const char *systemroots[] =
1067 { "/windows", "/winnt", "/win32", "/win" };
1069 char *systemroot = NULL;
1071 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
1073 systemroot = resolve_windows_path_silently (g, systemroots[i]);
1077 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
1082 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
1084 /* Freed by guestfs___free_inspect_info. */
1085 fs->windows_systemroot = systemroot;
1087 if (check_windows_arch (g, fs) == -1)
1090 if (check_windows_registry (g, fs) == -1)
1097 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1099 size_t len = strlen (fs->windows_systemroot) + 32;
1101 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1103 char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
1107 char *arch = guestfs_file_architecture (g, cmd_exe_path);
1108 free (cmd_exe_path);
1111 fs->arch = arch; /* freed by guestfs___free_inspect_info */
1116 /* At the moment, pull just the ProductName and version numbers from
1117 * the registry. In future there is a case for making many more
1118 * registry fields available to callers.
1121 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
1123 TMP_TEMPLATE_ON_STACK (dir);
1124 #define dir_len (strlen (dir))
1125 #define software_hive_len (dir_len + 16)
1126 char software_hive[software_hive_len];
1127 #define cmd_len (dir_len + 16)
1130 size_t len = strlen (fs->windows_systemroot) + 64;
1132 snprintf (software, len, "%s/system32/config/software",
1133 fs->windows_systemroot);
1135 char *software_path = resolve_windows_path_silently (g, software);
1137 /* If the software hive doesn't exist, just accept that we cannot
1138 * find product_name etc.
1144 hive_value_h *values = NULL;
1146 if (mkdtemp (dir) == NULL) {
1147 perrorf (g, "mkdtemp");
1151 snprintf (software_hive, software_hive_len, "%s/software", dir);
1153 if (guestfs_download (g, software_path, software_hive) == -1)
1156 h = hivex_open (software_hive, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1158 perrorf (g, "hivex_open");
1162 hive_node_h node = hivex_root (h);
1163 const char *hivepath[] =
1164 { "Microsoft", "Windows NT", "CurrentVersion" };
1167 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1169 node = hivex_node_get_child (h, node, hivepath[i]);
1173 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1177 values = hivex_node_values (h, node);
1179 for (i = 0; values[i] != 0; ++i) {
1180 char *key = hivex_value_key (h, values[i]);
1182 perrorf (g, "hivex_value_key");
1186 if (STRCASEEQ (key, "ProductName")) {
1187 fs->product_name = hivex_value_string (h, values[i]);
1188 if (!fs->product_name) {
1189 perrorf (g, "hivex_value_string");
1194 else if (STRCASEEQ (key, "CurrentVersion")) {
1195 char *version = hivex_value_string (h, values[i]);
1197 perrorf (g, "hivex_value_string");
1201 char *major, *minor;
1202 if (match2 (g, version, re_windows_version, &major, &minor)) {
1203 fs->major_version = parse_unsigned_int (g, major);
1205 if (fs->major_version == -1) {
1211 fs->minor_version = parse_unsigned_int (g, minor);
1213 if (fs->minor_version == -1) {
1229 if (h) hivex_close (h);
1231 free (software_path);
1233 /* Free up the temporary directory. Note the directory name cannot
1234 * contain shell meta-characters because of the way it was
1235 * constructed above.
1237 snprintf (cmd, cmd_len, "rm -rf %s", dir);
1238 ignore_value (system (cmd));
1240 #undef software_hive_len
1247 resolve_windows_path_silently (guestfs_h *g, const char *path)
1249 guestfs_error_handler_cb old_error_cb = g->error_cb;
1251 char *ret = guestfs_case_sensitive_path (g, path);
1252 g->error_cb = old_error_cb;
1257 extend_fses (guestfs_h *g)
1259 size_t n = g->nr_fses + 1;
1260 struct inspect_fs *p;
1262 p = realloc (g->fses, n * sizeof (struct inspect_fs));
1264 perrorf (g, "realloc");
1271 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1276 /* Parse small, unsigned ints, as used in version numbers. */
1278 parse_unsigned_int (guestfs_h *g, const char *str)
1281 int r = xstrtol (str, NULL, 10, &ret, "");
1282 if (r != LONGINT_OK) {
1283 error (g, "could not parse integer in version number: %s", str);
1289 static struct inspect_fs *
1290 search_for_root (guestfs_h *g, const char *root)
1292 if (g->nr_fses == 0) {
1293 error (g, _("no inspection data: call guestfs_inspect_os first"));
1298 struct inspect_fs *fs;
1299 for (i = 0; i < g->nr_fses; ++i) {
1301 if (fs->is_root && STREQ (root, fs->device))
1305 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1311 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1313 struct inspect_fs *fs = search_for_root (g, root);
1319 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1320 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1321 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1328 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1330 struct inspect_fs *fs = search_for_root (g, root);
1334 return safe_strdup (g, fs->arch ? : "unknown");
1338 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1340 struct inspect_fs *fs = search_for_root (g, root);
1345 switch (fs->distro) {
1346 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1347 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1348 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1349 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1350 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1351 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1352 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1353 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1354 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1355 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1356 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1363 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1365 struct inspect_fs *fs = search_for_root (g, root);
1369 return fs->major_version;
1373 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1375 struct inspect_fs *fs = search_for_root (g, root);
1379 return fs->minor_version;
1383 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1385 struct inspect_fs *fs = search_for_root (g, root);
1389 return safe_strdup (g, fs->product_name ? : "unknown");
1393 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1395 struct inspect_fs *fs = search_for_root (g, root);
1399 if (!fs->windows_systemroot) {
1400 error (g, _("not a Windows guest, or systemroot could not be determined"));
1404 return safe_strdup (g, fs->windows_systemroot);
1408 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1410 struct inspect_fs *fs = search_for_root (g, root);
1416 /* If no fstab information (Windows) return just the root. */
1417 if (fs->nr_fstab == 0) {
1418 ret = calloc (3, sizeof (char *));
1419 ret[0] = safe_strdup (g, "/");
1420 ret[1] = safe_strdup (g, root);
1425 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1426 size_t i, count = 0;
1427 for (i = 0; i < fs->nr_fstab; ++i)
1431 /* Hashtables have 2N+1 entries. */
1432 ret = calloc (2*count+1, sizeof (char *));
1434 perrorf (g, "calloc");
1439 for (i = 0; i < fs->nr_fstab; ++i)
1441 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1442 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1451 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1453 struct inspect_fs *fs = search_for_root (g, root);
1459 /* If no fstab information (Windows) return just the root. */
1460 if (fs->nr_fstab == 0) {
1461 ret = calloc (2, sizeof (char *));
1462 ret[0] = safe_strdup (g, root);
1467 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1469 perrorf (g, "calloc");
1474 for (i = 0; i < fs->nr_fstab; ++i)
1475 ret[i] = safe_strdup (g, fs->fstab[i].device);
1480 /* List filesystems.
1482 * The current implementation just uses guestfs_vfs_type and doesn't
1483 * try mounting anything, but we reserve the right in future to try
1484 * mounting filesystems.
1487 static void remove_from_list (char **list, const char *item);
1488 static void check_with_vfs_type (guestfs_h *g, const char *dev, char ***ret, size_t *ret_size);
1491 guestfs__list_filesystems (guestfs_h *g)
1497 ret = safe_malloc (g, sizeof (char *));
1501 /* Look to see if any devices directly contain filesystems
1502 * (RHBZ#590167). However vfs-type will fail to tell us anything
1503 * useful about devices which just contain partitions, so we also
1504 * get the list of partitions and exclude the corresponding devices
1505 * by using part-to-dev.
1508 devices = guestfs_list_devices (g);
1509 if (devices == NULL) {
1510 free_string_list (ret);
1514 partitions = guestfs_list_partitions (g);
1515 if (partitions == NULL) {
1516 free_string_list (devices);
1517 free_string_list (ret);
1521 for (i = 0; partitions[i] != NULL; ++i) {
1522 char *dev = guestfs_part_to_dev (g, partitions[i]);
1524 remove_from_list (devices, dev);
1528 /* Use vfs-type to check for filesystems on devices. */
1529 for (i = 0; devices[i] != NULL; ++i)
1530 check_with_vfs_type (g, devices[i], &ret, &ret_size);
1531 free_string_list (devices);
1533 /* Use vfs-type to check for filesystems on partitions. */
1534 for (i = 0; partitions[i] != NULL; ++i)
1535 check_with_vfs_type (g, partitions[i], &ret, &ret_size);
1536 free_string_list (partitions);
1538 if (feature_available (g, "lvm2")) {
1539 /* Use vfs-type to check for filesystems on LVs. */
1541 lvs = guestfs_lvs (g);
1543 free_string_list (ret);
1547 for (i = 0; lvs[i] != NULL; ++i)
1548 check_with_vfs_type (g, lvs[i], &ret, &ret_size);
1549 free_string_list (lvs);
1555 /* If 'item' occurs in 'list', remove and free it. */
1557 remove_from_list (char **list, const char *item)
1561 for (i = 0; list[i] != NULL; ++i)
1562 if (STREQ (list[i], item)) {
1564 for (; list[i+1] != NULL; ++i)
1565 list[i] = list[i+1];
1571 /* Use vfs-type to look for a filesystem of some sort on 'dev'.
1572 * Apart from some types which we ignore, add the result to the
1573 * 'ret' string list.
1576 check_with_vfs_type (guestfs_h *g, const char *device,
1577 char ***ret, size_t *ret_size)
1581 guestfs_error_handler_cb old_error_cb = g->error_cb;
1583 char *vfs_type = guestfs_vfs_type (g, device);
1584 g->error_cb = old_error_cb;
1587 v = safe_strdup (g, "unknown");
1589 /* Ignore all "*_member" strings. In libblkid these are returned
1590 * for things which are members of some RAID or LVM set, most
1591 * importantly "LVM2_member" which is a PV.
1593 size_t n = strlen (vfs_type);
1594 if (n >= 7 && STREQ (&vfs_type[n-7], "_member")) {
1599 /* Ignore LUKS-encrypted partitions. These are also containers. */
1600 if (STREQ (vfs_type, "crypto_LUKS")) {
1608 /* Extend the return array. */
1609 size_t i = *ret_size;
1611 *ret = safe_realloc (g, *ret, (*ret_size + 1) * sizeof (char *));
1612 (*ret)[i] = safe_strdup (g, device);