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.
426 * Fall through to guestfs__inspect_get_roots to do that.
428 char **ret = guestfs__inspect_get_roots (g);
430 guestfs___free_inspect_info (g);
435 guestfs___free_inspect_info (guestfs_h *g)
438 for (i = 0; i < g->nr_fses; ++i) {
439 free (g->fses[i].device);
440 free (g->fses[i].product_name);
441 free (g->fses[i].arch);
442 free (g->fses[i].windows_systemroot);
444 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
445 free (g->fses[i].fstab[j].device);
446 free (g->fses[i].fstab[j].mountpoint);
448 free (g->fses[i].fstab);
456 free_string_list (char **argv)
459 for (i = 0; argv[i] != NULL; ++i)
464 /* In the Perl code this is a public function. */
466 feature_available (guestfs_h *g, const char *feature)
468 /* If there's an error we should ignore it, so to do that we have to
469 * temporarily replace the error handler with a null one.
471 guestfs_error_handler_cb old_error_cb = g->error_cb;
474 const char *groups[] = { feature, NULL };
475 int r = guestfs_available (g, (char * const *) groups);
477 g->error_cb = old_error_cb;
479 return r == 0 ? 1 : 0;
482 /* Find out if 'device' contains a filesystem. If it does, add
483 * another entry in g->fses.
485 static int check_filesystem (guestfs_h *g, const char *device);
486 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
487 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
488 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
489 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
490 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs);
491 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
492 static int extend_fses (guestfs_h *g);
493 static int parse_unsigned_int (guestfs_h *g, const char *str);
494 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
495 const char *spec, const char *mp);
496 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
499 check_for_filesystem_on (guestfs_h *g, const char *device)
501 /* Get vfs-type in order to check if it's a Linux(?) swap device.
502 * If there's an error we should ignore it, so to do that we have to
503 * temporarily replace the error handler with a null one.
505 guestfs_error_handler_cb old_error_cb = g->error_cb;
507 char *vfs_type = guestfs_vfs_type (g, device);
508 g->error_cb = old_error_cb;
510 int is_swap = vfs_type && STREQ (vfs_type, "swap");
513 fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
514 device, vfs_type ? vfs_type : "failed to get vfs type");
518 if (extend_fses (g) == -1)
520 g->fses[g->nr_fses-1].is_swap = 1;
524 /* Try mounting the device. As above, ignore errors. */
526 int r = guestfs_mount_ro (g, device, "/");
527 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
528 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
530 g->error_cb = old_error_cb;
534 /* Do the rest of the checks. */
535 r = check_filesystem (g, device);
537 /* Unmount the filesystem. */
538 if (guestfs_umount_all (g) == -1)
545 check_filesystem (guestfs_h *g, const char *device)
547 if (extend_fses (g) == -1)
550 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
552 fs->device = safe_strdup (g, device);
553 fs->is_mountable = 1;
556 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
557 guestfs_is_file (g, "/grub/grub.conf") > 0)
558 fs->content = FS_CONTENT_LINUX_BOOT;
560 else if (guestfs_is_dir (g, "/etc") > 0 &&
561 guestfs_is_dir (g, "/bin") > 0 &&
562 guestfs_is_file (g, "/etc/fstab") > 0) {
564 fs->content = FS_CONTENT_LINUX_ROOT;
565 if (check_linux_root (g, fs) == -1)
568 /* Linux /usr/local? */
569 else if (guestfs_is_dir (g, "/etc") > 0 &&
570 guestfs_is_dir (g, "/bin") > 0 &&
571 guestfs_is_dir (g, "/share") > 0 &&
572 guestfs_exists (g, "/local") == 0 &&
573 guestfs_is_file (g, "/etc/fstab") == 0)
574 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
576 else if (guestfs_is_dir (g, "/etc") > 0 &&
577 guestfs_is_dir (g, "/bin") > 0 &&
578 guestfs_is_dir (g, "/share") > 0 &&
579 guestfs_exists (g, "/local") > 0 &&
580 guestfs_is_file (g, "/etc/fstab") == 0)
581 fs->content = FS_CONTENT_LINUX_USR;
583 else if (guestfs_is_dir (g, "/log") > 0 &&
584 guestfs_is_dir (g, "/run") > 0 &&
585 guestfs_is_dir (g, "/spool") > 0)
586 fs->content = FS_CONTENT_LINUX_VAR;
588 else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
589 guestfs_is_file (g, "/autoexec.bat") > 0 ||
590 guestfs_is_dir (g, "/Program Files") > 0 ||
591 guestfs_is_dir (g, "/WINDOWS") > 0 ||
592 guestfs_is_dir (g, "/Windows") > 0 ||
593 guestfs_is_dir (g, "/windows") > 0 ||
594 guestfs_is_dir (g, "/WIN32") > 0 ||
595 guestfs_is_dir (g, "/Win32") > 0 ||
596 guestfs_is_dir (g, "/WINNT") > 0 ||
597 guestfs_is_file (g, "/boot.ini") > 0 ||
598 guestfs_is_file (g, "/ntldr") > 0) {
600 fs->content = FS_CONTENT_WINDOWS_ROOT;
601 if (check_windows_root (g, fs) == -1)
608 /* Set fs->product_name to the first line of the release file. */
610 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
611 const char *release_filename)
613 char **product_name = guestfs_head_n (g, 1, release_filename);
614 if (product_name == NULL)
616 if (product_name[0] == NULL) {
617 error (g, "%s: file is empty", release_filename);
618 free_string_list (product_name);
622 /* Note that this string becomes owned by the handle and will
623 * be freed by guestfs___free_inspect_info.
625 fs->product_name = product_name[0];
631 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
633 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
637 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
638 fs->major_version = parse_unsigned_int (g, major);
640 if (fs->major_version == -1) {
644 fs->minor_version = parse_unsigned_int (g, minor);
646 if (fs->minor_version == -1)
652 /* Ubuntu has /etc/lsb-release containing:
653 * DISTRIB_ID=Ubuntu # Distro
654 * DISTRIB_RELEASE=10.04 # Version
655 * DISTRIB_CODENAME=lucid
656 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
657 * In theory other distros could have this LSB file, but none do.
660 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
666 lines = guestfs_head_n (g, 10, "/etc/lsb-release");
670 for (i = 0; lines[i] != NULL; ++i) {
671 if (fs->distro == 0 &&
672 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
673 fs->distro = OS_DISTRO_UBUNTU;
676 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
678 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
679 fs->major_version = parse_unsigned_int (g, major);
681 if (fs->major_version == -1) {
683 free_string_list (lines);
686 fs->minor_version = parse_unsigned_int (g, minor);
688 if (fs->minor_version == -1) {
689 free_string_list (lines);
694 else if (fs->product_name == NULL &&
695 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
696 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
697 size_t len = strlen (lines[i]) - 21 - 1;
698 fs->product_name = safe_strndup (g, &lines[i][21], len);
701 else if (fs->product_name == NULL &&
702 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
703 size_t len = strlen (lines[i]) - 20;
704 fs->product_name = safe_strndup (g, &lines[i][20], len);
709 free_string_list (lines);
713 /* The currently mounted device is known to be a Linux root. Try to
714 * determine from this the distro, version, etc. Also parse
715 * /etc/fstab to determine the arrangement of mountpoints and
716 * associated devices.
719 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
723 fs->type = OS_TYPE_LINUX;
725 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
726 r = parse_lsb_release (g, fs);
727 if (r == -1) /* error */
729 if (r == 1) /* ok - detected the release from this file */
730 goto skip_release_checks;
733 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
734 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
736 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
740 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
741 fs->distro = OS_DISTRO_FEDORA;
742 fs->major_version = parse_unsigned_int (g, major);
744 if (fs->major_version == -1)
747 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
748 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
749 fs->distro = OS_DISTRO_RHEL;
750 fs->major_version = parse_unsigned_int (g, major);
752 if (fs->major_version == -1) {
756 fs->minor_version = parse_unsigned_int (g, minor);
758 if (fs->minor_version == -1)
761 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
762 fs->distro = OS_DISTRO_RHEL;
763 fs->major_version = parse_unsigned_int (g, major);
765 if (fs->major_version == -1)
767 fs->minor_version = 0;
770 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
771 fs->distro = OS_DISTRO_DEBIAN;
773 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
776 if (parse_major_minor (g, fs) == -1)
779 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
780 fs->distro = OS_DISTRO_PARDUS;
782 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
785 if (parse_major_minor (g, fs) == -1)
788 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
789 fs->distro = OS_DISTRO_ARCHLINUX;
791 /* /etc/arch-release file is empty and I can't see a way to
792 * determine the actual release or product string.
795 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
796 fs->distro = OS_DISTRO_GENTOO;
798 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
801 if (parse_major_minor (g, fs) == -1)
804 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
805 fs->distro = OS_DISTRO_MEEGO;
807 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
810 if (parse_major_minor (g, fs) == -1)
814 skip_release_checks:;
816 /* Determine the architecture. */
817 const char *binaries[] =
818 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
820 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
821 if (guestfs_is_file (g, binaries[i]) > 0) {
822 /* Ignore errors from file_architecture call. */
823 guestfs_error_handler_cb old_error_cb = g->error_cb;
825 char *arch = guestfs_file_architecture (g, binaries[i]);
826 g->error_cb = old_error_cb;
829 /* String will be owned by handle, freed by
830 * guestfs___free_inspect_info.
838 /* We already know /etc/fstab exists because it's part of the test
839 * for Linux root above. We must now parse this file to determine
840 * which filesystems are used by the operating system and how they
842 * XXX What if !feature_available (g, "augeas")?
844 if (guestfs_aug_init (g, "/", AUG_NO_LOAD|AUG_SAVE_NOOP) == -1)
847 /* Tell Augeas to only load /etc/fstab (thanks Raphaël Pinson). */
848 guestfs_aug_rm (g, "/augeas/load//incl[. != \"/etc/fstab\"]");
849 guestfs_aug_load (g);
851 r = check_fstab (g, fs);
852 guestfs_aug_close (g);
860 check_fstab (guestfs_h *g, struct inspect_fs *fs)
862 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
866 if (lines[0] == NULL) {
867 error (g, "could not parse /etc/fstab or empty file");
868 free_string_list (lines);
874 for (i = 0; lines[i] != NULL; ++i) {
875 /* Ignore comments. Only care about sequence lines which
878 if (match (g, lines[i], re_aug_seq)) {
879 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
880 char *spec = guestfs_aug_get (g, augpath);
882 free_string_list (lines);
886 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
887 char *mp = guestfs_aug_get (g, augpath);
889 free_string_list (lines);
894 int r = add_fstab_entry (g, fs, spec, mp);
899 free_string_list (lines);
905 free_string_list (lines);
909 /* Add a filesystem and possibly a mountpoint entry for
910 * the root filesystem 'fs'.
912 * 'spec' is the fstab spec field, which might be a device name or a
913 * pseudodevice or 'UUID=...' or 'LABEL=...'.
915 * 'mp' is the mount point, which could also be 'swap' or 'none'.
918 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
919 const char *spec, const char *mp)
921 /* Ignore certain mountpoints. */
922 if (STRPREFIX (mp, "/dev/") ||
923 STREQ (mp, "/dev") ||
924 STRPREFIX (mp, "/media/") ||
925 STRPREFIX (mp, "/proc/") ||
926 STREQ (mp, "/proc") ||
927 STRPREFIX (mp, "/selinux/") ||
928 STREQ (mp, "/selinux") ||
929 STRPREFIX (mp, "/sys/") ||
933 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
934 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
935 STREQ (spec, "/dev/floppy") ||
936 STREQ (spec, "/dev/cdrom"))
939 /* Resolve UUID= and LABEL= to the actual device. */
941 if (STRPREFIX (spec, "UUID="))
942 device = guestfs_findfs_uuid (g, &spec[5]);
943 else if (STRPREFIX (spec, "LABEL="))
944 device = guestfs_findfs_label (g, &spec[6]);
945 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
946 else if (STRPREFIX (spec, "/dev/"))
947 /* Resolve guest block device names. */
948 device = resolve_fstab_device (g, spec);
950 /* If we haven't resolved the device successfully by this point,
951 * we don't care, just ignore it.
956 char *mountpoint = safe_strdup (g, mp);
958 /* Add this to the fstab entry in 'fs'.
959 * Note these are further filtered by guestfs_inspect_get_mountpoints
960 * and guestfs_inspect_get_filesystems.
962 size_t n = fs->nr_fstab + 1;
963 struct inspect_fstab_entry *p;
965 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
967 perrorf (g, "realloc");
976 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
977 fs->fstab[n-1].device = device;
978 fs->fstab[n-1].mountpoint = mountpoint;
981 fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
986 /* Resolve block device name to the libguestfs device name, eg.
987 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
988 * assumes that disks were added in the same order as they appear to
989 * the real VM, which is a reasonable assumption to make. Return
990 * anything we don't recognize unchanged.
993 resolve_fstab_device (guestfs_h *g, const char *spec)
998 if (STRPREFIX (spec, "/dev/mapper/")) {
999 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
1000 * LVs which contain '-' character:
1002 * ><fs> lvcreate LV--test VG--test 32
1003 * ><fs> debug ls /dev/mapper
1004 * VG----test-LV----test
1006 * This makes it impossible to reverse those paths directly, so
1007 * we have implemented lvm_canonical_lv_name in the daemon.
1009 device = guestfs_lvm_canonical_lv_name (g, spec);
1011 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
1012 char **devices = guestfs_list_devices (g);
1013 if (devices == NULL)
1017 for (count = 0; devices[count] != NULL; count++)
1020 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
1022 size_t len = strlen (devices[i]) + strlen (a1) + 16;
1023 device = safe_malloc (g, len);
1024 snprintf (device, len, "%s%s", devices[i], &a1[1]);
1028 free_string_list (devices);
1031 /* Didn't match device pattern, return original spec unchanged. */
1032 device = safe_strdup (g, spec);
1038 /* XXX Handling of boot.ini in the Perl version was pretty broken. It
1039 * essentially didn't do anything for modern Windows guests.
1040 * Therefore I've omitted all that code.
1043 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
1045 fs->type = OS_TYPE_WINDOWS;
1046 fs->distro = OS_DISTRO_WINDOWS;
1048 /* Try to find Windows systemroot using some common locations. */
1049 const char *systemroots[] =
1050 { "/windows", "/winnt", "/win32", "/win" };
1052 char *systemroot = NULL;
1054 systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
1056 systemroot = resolve_windows_path_silently (g, systemroots[i]);
1060 error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
1065 fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
1067 /* Freed by guestfs___free_inspect_info. */
1068 fs->windows_systemroot = systemroot;
1070 if (check_windows_arch (g, fs) == -1)
1073 if (check_windows_registry (g, fs) == -1)
1080 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1082 size_t len = strlen (fs->windows_systemroot) + 32;
1084 snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1086 char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
1090 char *arch = guestfs_file_architecture (g, cmd_exe_path);
1091 free (cmd_exe_path);
1094 fs->arch = arch; /* freed by guestfs___free_inspect_info */
1099 /* At the moment, pull just the ProductName and version numbers from
1100 * the registry. In future there is a case for making many more
1101 * registry fields available to callers.
1104 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
1106 TMP_TEMPLATE_ON_STACK (dir);
1107 #define dir_len (strlen (dir))
1108 #define software_hive_len (dir_len + 16)
1109 char software_hive[software_hive_len];
1110 #define cmd_len (dir_len + 16)
1113 size_t len = strlen (fs->windows_systemroot) + 64;
1115 snprintf (software, len, "%s/system32/config/software",
1116 fs->windows_systemroot);
1118 char *software_path = resolve_windows_path_silently (g, software);
1120 /* If the software hive doesn't exist, just accept that we cannot
1121 * find product_name etc.
1127 hive_value_h *values = NULL;
1129 if (mkdtemp (dir) == NULL) {
1130 perrorf (g, "mkdtemp");
1134 snprintf (software_hive, software_hive_len, "%s/software", dir);
1136 if (guestfs_download (g, software_path, software_hive) == -1)
1139 h = hivex_open (software_hive, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1141 perrorf (g, "hivex_open");
1145 hive_node_h node = hivex_root (h);
1146 const char *hivepath[] =
1147 { "Microsoft", "Windows NT", "CurrentVersion" };
1150 node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1152 node = hivex_node_get_child (h, node, hivepath[i]);
1156 perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1160 values = hivex_node_values (h, node);
1162 for (i = 0; values[i] != 0; ++i) {
1163 char *key = hivex_value_key (h, values[i]);
1165 perrorf (g, "hivex_value_key");
1169 if (STRCASEEQ (key, "ProductName")) {
1170 fs->product_name = hivex_value_string (h, values[i]);
1171 if (!fs->product_name) {
1172 perrorf (g, "hivex_value_string");
1177 else if (STRCASEEQ (key, "CurrentVersion")) {
1178 char *version = hivex_value_string (h, values[i]);
1180 perrorf (g, "hivex_value_string");
1184 char *major, *minor;
1185 if (match2 (g, version, re_windows_version, &major, &minor)) {
1186 fs->major_version = parse_unsigned_int (g, major);
1188 if (fs->major_version == -1) {
1194 fs->minor_version = parse_unsigned_int (g, minor);
1196 if (fs->minor_version == -1) {
1212 if (h) hivex_close (h);
1214 free (software_path);
1216 /* Free up the temporary directory. Note the directory name cannot
1217 * contain shell meta-characters because of the way it was
1218 * constructed above.
1220 snprintf (cmd, cmd_len, "rm -rf %s", dir);
1221 ignore_value (system (cmd));
1223 #undef software_hive_len
1230 resolve_windows_path_silently (guestfs_h *g, const char *path)
1232 guestfs_error_handler_cb old_error_cb = g->error_cb;
1234 char *ret = guestfs_case_sensitive_path (g, path);
1235 g->error_cb = old_error_cb;
1240 extend_fses (guestfs_h *g)
1242 size_t n = g->nr_fses + 1;
1243 struct inspect_fs *p;
1245 p = realloc (g->fses, n * sizeof (struct inspect_fs));
1247 perrorf (g, "realloc");
1254 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1259 /* Parse small, unsigned ints, as used in version numbers. */
1261 parse_unsigned_int (guestfs_h *g, const char *str)
1264 int r = xstrtol (str, NULL, 10, &ret, "");
1265 if (r != LONGINT_OK) {
1266 error (g, "could not parse integer in version number: %s", str);
1272 static struct inspect_fs *
1273 search_for_root (guestfs_h *g, const char *root)
1275 if (g->nr_fses == 0) {
1276 error (g, _("no inspection data: call guestfs_inspect_os first"));
1281 struct inspect_fs *fs;
1282 for (i = 0; i < g->nr_fses; ++i) {
1284 if (fs->is_root && STREQ (root, fs->device))
1288 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1294 guestfs__inspect_get_roots (guestfs_h *g)
1296 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
1297 * list in this case.
1302 for (i = 0; i < g->nr_fses; ++i)
1303 if (g->fses[i].is_root)
1306 char **ret = calloc (count+1, sizeof (char *));
1308 perrorf (g, "calloc");
1313 for (i = 0; i < g->nr_fses; ++i) {
1314 if (g->fses[i].is_root) {
1315 ret[count] = safe_strdup (g, g->fses[i].device);
1325 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1327 struct inspect_fs *fs = search_for_root (g, root);
1333 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1334 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1335 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1342 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1344 struct inspect_fs *fs = search_for_root (g, root);
1348 return safe_strdup (g, fs->arch ? : "unknown");
1352 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1354 struct inspect_fs *fs = search_for_root (g, root);
1359 switch (fs->distro) {
1360 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1361 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1362 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1363 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1364 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1365 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1366 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1367 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1368 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1369 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1370 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1377 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1379 struct inspect_fs *fs = search_for_root (g, root);
1383 return fs->major_version;
1387 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1389 struct inspect_fs *fs = search_for_root (g, root);
1393 return fs->minor_version;
1397 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1399 struct inspect_fs *fs = search_for_root (g, root);
1403 return safe_strdup (g, fs->product_name ? : "unknown");
1407 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1409 struct inspect_fs *fs = search_for_root (g, root);
1413 if (!fs->windows_systemroot) {
1414 error (g, _("not a Windows guest, or systemroot could not be determined"));
1418 return safe_strdup (g, fs->windows_systemroot);
1422 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1424 struct inspect_fs *fs = search_for_root (g, root);
1430 /* If no fstab information (Windows) return just the root. */
1431 if (fs->nr_fstab == 0) {
1432 ret = calloc (3, sizeof (char *));
1433 ret[0] = safe_strdup (g, "/");
1434 ret[1] = safe_strdup (g, root);
1439 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1440 size_t i, count = 0;
1441 for (i = 0; i < fs->nr_fstab; ++i)
1445 /* Hashtables have 2N+1 entries. */
1446 ret = calloc (2*count+1, sizeof (char *));
1448 perrorf (g, "calloc");
1453 for (i = 0; i < fs->nr_fstab; ++i)
1455 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1456 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1465 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1467 struct inspect_fs *fs = search_for_root (g, root);
1473 /* If no fstab information (Windows) return just the root. */
1474 if (fs->nr_fstab == 0) {
1475 ret = calloc (2, sizeof (char *));
1476 ret[0] = safe_strdup (g, root);
1481 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1483 perrorf (g, "calloc");
1488 for (i = 0; i < fs->nr_fstab; ++i)
1489 ret[i] = safe_strdup (g, fs->fstab[i].device);
1494 /* List filesystems.
1496 * The current implementation just uses guestfs_vfs_type and doesn't
1497 * try mounting anything, but we reserve the right in future to try
1498 * mounting filesystems.
1501 static void remove_from_list (char **list, const char *item);
1502 static void check_with_vfs_type (guestfs_h *g, const char *dev, char ***ret, size_t *ret_size);
1505 guestfs__list_filesystems (guestfs_h *g)
1511 ret = safe_malloc (g, sizeof (char *));
1515 /* Look to see if any devices directly contain filesystems
1516 * (RHBZ#590167). However vfs-type will fail to tell us anything
1517 * useful about devices which just contain partitions, so we also
1518 * get the list of partitions and exclude the corresponding devices
1519 * by using part-to-dev.
1522 devices = guestfs_list_devices (g);
1523 if (devices == NULL) {
1524 free_string_list (ret);
1528 partitions = guestfs_list_partitions (g);
1529 if (partitions == NULL) {
1530 free_string_list (devices);
1531 free_string_list (ret);
1535 for (i = 0; partitions[i] != NULL; ++i) {
1536 char *dev = guestfs_part_to_dev (g, partitions[i]);
1538 remove_from_list (devices, dev);
1542 /* Use vfs-type to check for filesystems on devices. */
1543 for (i = 0; devices[i] != NULL; ++i)
1544 check_with_vfs_type (g, devices[i], &ret, &ret_size);
1545 free_string_list (devices);
1547 /* Use vfs-type to check for filesystems on partitions. */
1548 for (i = 0; partitions[i] != NULL; ++i)
1549 check_with_vfs_type (g, partitions[i], &ret, &ret_size);
1550 free_string_list (partitions);
1552 if (feature_available (g, "lvm2")) {
1553 /* Use vfs-type to check for filesystems on LVs. */
1555 lvs = guestfs_lvs (g);
1557 free_string_list (ret);
1561 for (i = 0; lvs[i] != NULL; ++i)
1562 check_with_vfs_type (g, lvs[i], &ret, &ret_size);
1563 free_string_list (lvs);
1569 /* If 'item' occurs in 'list', remove and free it. */
1571 remove_from_list (char **list, const char *item)
1575 for (i = 0; list[i] != NULL; ++i)
1576 if (STREQ (list[i], item)) {
1578 for (; list[i+1] != NULL; ++i)
1579 list[i] = list[i+1];
1585 /* Use vfs-type to look for a filesystem of some sort on 'dev'.
1586 * Apart from some types which we ignore, add the result to the
1587 * 'ret' string list.
1590 check_with_vfs_type (guestfs_h *g, const char *device,
1591 char ***ret, size_t *ret_size)
1595 guestfs_error_handler_cb old_error_cb = g->error_cb;
1597 char *vfs_type = guestfs_vfs_type (g, device);
1598 g->error_cb = old_error_cb;
1601 v = safe_strdup (g, "unknown");
1603 /* Ignore all "*_member" strings. In libblkid these are returned
1604 * for things which are members of some RAID or LVM set, most
1605 * importantly "LVM2_member" which is a PV.
1607 size_t n = strlen (vfs_type);
1608 if (n >= 7 && STREQ (&vfs_type[n-7], "_member")) {
1613 /* Ignore LUKS-encrypted partitions. These are also containers. */
1614 if (STREQ (vfs_type, "crypto_LUKS")) {
1622 /* Extend the return array. */
1623 size_t i = *ret_size;
1625 *ret = safe_realloc (g, *ret, (*ret_size + 1) * sizeof (char *));
1626 (*ret)[i] = safe_strdup (g, device);