2 * Copyright (C) 2010-2011 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
41 #include "ignore-value.h"
45 #include "guestfs-internal.h"
46 #include "guestfs-internal-actions.h"
47 #include "guestfs_protocol.h"
49 #if defined(HAVE_PCRE) && defined(HAVE_HIVEX)
51 /* Compile all the regular expressions once when the shared library is
52 * loaded. PCRE is thread safe so we're supposedly OK here if
53 * multiple threads call into the libguestfs API functions below
56 static pcre *re_fedora;
57 static pcre *re_rhel_old;
59 static pcre *re_rhel_no_minor;
60 static pcre *re_major_minor;
61 static pcre *re_aug_seq;
63 static pcre *re_first_partition;
64 static pcre *re_freebsd;
66 static void compile_regexps (void) __attribute__((constructor));
67 static void free_regexps (void) __attribute__((destructor));
70 compile_regexps (void)
75 #define COMPILE(re,pattern,options) \
77 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
79 ignore_value (write (2, err, strlen (err))); \
84 COMPILE (re_fedora, "Fedora release (\\d+)", 0);
86 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
88 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+)\\.(\\d+)", 0);
89 COMPILE (re_rhel_no_minor,
90 "(?:Red Hat|CentOS|Scientific Linux).*release (\\d+)", 0);
91 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
92 COMPILE (re_aug_seq, "/\\d+$", 0);
93 COMPILE (re_xdev, "^/dev/(?:h|s|v|xv)d([a-z]\\d*)$", 0);
94 COMPILE (re_freebsd, "^/dev/ad(\\d+)s(\\d+)([a-z])$", 0);
100 pcre_free (re_fedora);
101 pcre_free (re_rhel_old);
103 pcre_free (re_rhel_no_minor);
104 pcre_free (re_major_minor);
105 pcre_free (re_aug_seq);
107 pcre_free (re_freebsd);
110 static void check_architecture (guestfs_h *g, struct inspect_fs *fs);
111 static int check_hostname_unix (guestfs_h *g, struct inspect_fs *fs);
112 static int check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs);
113 static int check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs);
114 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
115 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
116 const char *spec, const char *mp);
117 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
118 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
120 /* Set fs->product_name to the first line of the release file. */
122 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
123 const char *release_filename)
125 fs->product_name = guestfs___first_line_of_file (g, release_filename);
126 if (fs->product_name == NULL)
131 /* Ubuntu has /etc/lsb-release containing:
132 * DISTRIB_ID=Ubuntu # Distro
133 * DISTRIB_RELEASE=10.04 # Version
134 * DISTRIB_CODENAME=lucid
135 * DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS" # Product name
137 * [Ubuntu-derived ...] Linux Mint was found to have this:
138 * DISTRIB_ID=LinuxMint
140 * DISTRIB_CODENAME=julia
141 * DISTRIB_DESCRIPTION="Linux Mint 10 Julia"
142 * Linux Mint also has /etc/linuxmint/info with more information,
143 * but we can use the LSB file.
146 * LSB_VERSION=lsb-4.0-amd64:lsb-4.0-noarch
147 * DISTRIB_ID=MandrivaLinux
148 * DISTRIB_RELEASE=2010.1
149 * DISTRIB_CODENAME=Henry_Farman
150 * DISTRIB_DESCRIPTION="Mandriva Linux 2010.1"
151 * Mandriva also has a normal release file called /etc/mandriva-release.
154 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
156 const char *filename = "/etc/lsb-release";
162 /* Don't trust guestfs_head_n not to break with very large files.
163 * Check the file size is something reasonable first.
165 size = guestfs_filesize (g, filename);
167 /* guestfs_filesize failed and has already set error in handle */
169 if (size > MAX_SMALL_FILE_SIZE) {
170 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
175 lines = guestfs_head_n (g, 10, filename);
179 for (i = 0; lines[i] != NULL; ++i) {
180 if (fs->distro == 0 &&
181 STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
182 fs->distro = OS_DISTRO_UBUNTU;
185 else if (fs->distro == 0 &&
186 STREQ (lines[i], "DISTRIB_ID=LinuxMint")) {
187 fs->distro = OS_DISTRO_LINUX_MINT;
190 else if (fs->distro == 0 &&
191 STREQ (lines[i], "DISTRIB_ID=MandrivaLinux")) {
192 fs->distro = OS_DISTRO_MANDRIVA;
195 else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
197 if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
198 fs->major_version = guestfs___parse_unsigned_int (g, major);
200 if (fs->major_version == -1) {
202 guestfs___free_string_list (lines);
205 fs->minor_version = guestfs___parse_unsigned_int (g, minor);
207 if (fs->minor_version == -1) {
208 guestfs___free_string_list (lines);
213 else if (fs->product_name == NULL &&
214 (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
215 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
216 size_t len = strlen (lines[i]) - 21 - 1;
217 fs->product_name = safe_strndup (g, &lines[i][21], len);
220 else if (fs->product_name == NULL &&
221 STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
222 size_t len = strlen (lines[i]) - 20;
223 fs->product_name = safe_strndup (g, &lines[i][20], len);
228 guestfs___free_string_list (lines);
232 /* The currently mounted device is known to be a Linux root. Try to
233 * determine from this the distro, version, etc. Also parse
234 * /etc/fstab to determine the arrangement of mountpoints and
235 * associated devices.
238 guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs)
242 fs->type = OS_TYPE_LINUX;
244 if (guestfs_exists (g, "/etc/lsb-release") > 0) {
245 r = parse_lsb_release (g, fs);
246 if (r == -1) /* error */
248 if (r == 1) /* ok - detected the release from this file */
249 goto skip_release_checks;
252 if (guestfs_exists (g, "/etc/redhat-release") > 0) {
253 fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
255 if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
259 if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
260 fs->distro = OS_DISTRO_FEDORA;
261 fs->major_version = guestfs___parse_unsigned_int (g, major);
263 if (fs->major_version == -1)
266 else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
267 match2 (g, fs->product_name, re_rhel, &major, &minor)) {
268 fs->distro = OS_DISTRO_RHEL;
269 fs->major_version = guestfs___parse_unsigned_int (g, major);
271 if (fs->major_version == -1) {
275 fs->minor_version = guestfs___parse_unsigned_int (g, minor);
277 if (fs->minor_version == -1)
280 else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
281 fs->distro = OS_DISTRO_RHEL;
282 fs->major_version = guestfs___parse_unsigned_int (g, major);
284 if (fs->major_version == -1)
286 fs->minor_version = 0;
289 else if (guestfs_exists (g, "/etc/debian_version") > 0) {
290 fs->distro = OS_DISTRO_DEBIAN;
292 if (parse_release_file (g, fs, "/etc/debian_version") == -1)
295 if (guestfs___parse_major_minor (g, fs) == -1)
298 else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
299 fs->distro = OS_DISTRO_PARDUS;
301 if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
304 if (guestfs___parse_major_minor (g, fs) == -1)
307 else if (guestfs_exists (g, "/etc/arch-release") > 0) {
308 fs->distro = OS_DISTRO_ARCHLINUX;
310 /* /etc/arch-release file is empty and I can't see a way to
311 * determine the actual release or product string.
314 else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
315 fs->distro = OS_DISTRO_GENTOO;
317 if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
320 if (guestfs___parse_major_minor (g, fs) == -1)
323 else if (guestfs_exists (g, "/etc/meego-release") > 0) {
324 fs->distro = OS_DISTRO_MEEGO;
326 if (parse_release_file (g, fs, "/etc/meego-release") == -1)
329 if (guestfs___parse_major_minor (g, fs) == -1)
332 else if (guestfs_exists (g, "/etc/slackware-version") > 0) {
333 fs->distro = OS_DISTRO_SLACKWARE;
335 if (parse_release_file (g, fs, "/etc/slackware-version") == -1)
338 if (guestfs___parse_major_minor (g, fs) == -1)
342 skip_release_checks:;
344 /* Determine the architecture. */
345 check_architecture (g, fs);
347 /* We already know /etc/fstab exists because it's part of the test
348 * for Linux root above. We must now parse this file to determine
349 * which filesystems are used by the operating system and how they
352 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
355 /* Determine hostname. */
356 if (check_hostname_unix (g, fs) == -1)
362 /* The currently mounted device is known to be a FreeBSD root. */
364 guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs)
366 fs->type = OS_TYPE_FREEBSD;
368 /* FreeBSD has no authoritative version file. The version number is
369 * in /etc/motd, which the system administrator might edit, but
370 * we'll use that anyway.
373 if (guestfs_exists (g, "/etc/motd") > 0) {
374 if (parse_release_file (g, fs, "/etc/motd") == -1)
377 if (guestfs___parse_major_minor (g, fs) == -1)
381 /* Determine the architecture. */
382 check_architecture (g, fs);
384 /* We already know /etc/fstab exists because it's part of the test above. */
385 if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
388 /* Determine hostname. */
389 if (check_hostname_unix (g, fs) == -1)
396 check_architecture (guestfs_h *g, struct inspect_fs *fs)
398 const char *binaries[] =
399 { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
402 for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
403 if (guestfs_is_file (g, binaries[i]) > 0) {
404 /* Ignore errors from file_architecture call. */
405 guestfs_error_handler_cb old_error_cb = g->error_cb;
407 char *arch = guestfs_file_architecture (g, binaries[i]);
408 g->error_cb = old_error_cb;
411 /* String will be owned by handle, freed by
412 * guestfs___free_inspect_info.
421 /* Try several methods to determine the hostname from a Linux or
422 * FreeBSD guest. Note that type and distro have been set, so we can
423 * use that information to direct the search.
426 check_hostname_unix (guestfs_h *g, struct inspect_fs *fs)
430 /* Red Hat-derived would be in /etc/sysconfig/network, and
431 * Debian-derived in the file /etc/hostname. Very old Debian and
432 * SUSE use /etc/HOSTNAME. It's best to just look for each of
433 * these files in turn, rather than try anything clever based on
436 if (guestfs_is_file (g, "/etc/HOSTNAME")) {
437 fs->hostname = guestfs___first_line_of_file (g, "/etc/HOSTNAME");
438 if (fs->hostname == NULL)
441 else if (guestfs_is_file (g, "/etc/hostname")) {
442 fs->hostname = guestfs___first_line_of_file (g, "/etc/hostname");
443 if (fs->hostname == NULL)
446 else if (guestfs_is_file (g, "/etc/sysconfig/network")) {
447 if (inspect_with_augeas (g, fs, "/etc/sysconfig/network",
448 check_hostname_redhat) == -1)
453 case OS_TYPE_FREEBSD:
454 /* /etc/rc.conf contains the hostname, but there is no Augeas lens
457 if (guestfs_is_file (g, "/etc/rc.conf")) {
458 if (check_hostname_freebsd (g, fs) == -1)
463 case OS_TYPE_WINDOWS: /* not here, see check_windows_system_registry */
464 case OS_TYPE_UNKNOWN:
466 /* nothing, keep GCC warnings happy */;
472 /* Parse the hostname from /etc/sysconfig/network. This must be called
473 * from the inspect_with_augeas wrapper.
476 check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs)
480 hostname = guestfs_aug_get (g, "/files/etc/sysconfig/network/HOSTNAME");
484 fs->hostname = hostname; /* freed by guestfs___free_inspect_info */
488 /* Parse the hostname from /etc/rc.conf. On FreeBSD this file
489 * contains comments, blank lines and:
490 * hostname="freebsd8.example.com"
491 * ifconfig_re0="DHCP"
496 check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs)
498 const char *filename = "/etc/rc.conf";
503 /* Don't trust guestfs_read_lines not to break with very large files.
504 * Check the file size is something reasonable first.
506 size = guestfs_filesize (g, filename);
508 /* guestfs_filesize failed and has already set error in handle */
510 if (size > MAX_SMALL_FILE_SIZE) {
511 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
516 lines = guestfs_read_lines (g, filename);
520 for (i = 0; lines[i] != NULL; ++i) {
521 if (STRPREFIX (lines[i], "hostname=\"") ||
522 STRPREFIX (lines[i], "hostname='")) {
523 size_t len = strlen (lines[i]) - 10 - 1;
524 fs->hostname = safe_strndup (g, &lines[i][10], len);
526 } else if (STRPREFIX (lines[i], "hostname=")) {
527 size_t len = strlen (lines[i]) - 9;
528 fs->hostname = safe_strndup (g, &lines[i][9], len);
533 guestfs___free_string_list (lines);
538 check_fstab (guestfs_h *g, struct inspect_fs *fs)
540 char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
544 if (lines[0] == NULL) {
545 error (g, _("could not parse /etc/fstab or empty file"));
546 guestfs___free_string_list (lines);
552 for (i = 0; lines[i] != NULL; ++i) {
553 /* Ignore comments. Only care about sequence lines which
556 if (match (g, lines[i], re_aug_seq)) {
557 snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
558 char *spec = guestfs_aug_get (g, augpath);
560 guestfs___free_string_list (lines);
564 snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
565 char *mp = guestfs_aug_get (g, augpath);
567 guestfs___free_string_list (lines);
572 int r = add_fstab_entry (g, fs, spec, mp);
577 guestfs___free_string_list (lines);
583 guestfs___free_string_list (lines);
587 /* Add a filesystem and possibly a mountpoint entry for
588 * the root filesystem 'fs'.
590 * 'spec' is the fstab spec field, which might be a device name or a
591 * pseudodevice or 'UUID=...' or 'LABEL=...'.
593 * 'mp' is the mount point, which could also be 'swap' or 'none'.
596 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
597 const char *spec, const char *mp)
599 /* Ignore certain mountpoints. */
600 if (STRPREFIX (mp, "/dev/") ||
601 STREQ (mp, "/dev") ||
602 STRPREFIX (mp, "/media/") ||
603 STRPREFIX (mp, "/proc/") ||
604 STREQ (mp, "/proc") ||
605 STRPREFIX (mp, "/selinux/") ||
606 STREQ (mp, "/selinux") ||
607 STRPREFIX (mp, "/sys/") ||
611 /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
612 if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
613 STREQ (spec, "/dev/floppy") ||
614 STREQ (spec, "/dev/cdrom"))
617 /* Resolve UUID= and LABEL= to the actual device. */
619 if (STRPREFIX (spec, "UUID="))
620 device = guestfs_findfs_uuid (g, &spec[5]);
621 else if (STRPREFIX (spec, "LABEL="))
622 device = guestfs_findfs_label (g, &spec[6]);
623 /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
624 else if (STRPREFIX (spec, "/dev/"))
625 /* Resolve guest block device names. */
626 device = resolve_fstab_device (g, spec);
628 /* If we haven't resolved the device successfully by this point,
629 * we don't care, just ignore it.
634 char *mountpoint = safe_strdup (g, mp);
636 /* Add this to the fstab entry in 'fs'.
637 * Note these are further filtered by guestfs_inspect_get_mountpoints
638 * and guestfs_inspect_get_filesystems.
640 size_t n = fs->nr_fstab + 1;
641 struct inspect_fstab_entry *p;
643 p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
645 perrorf (g, "realloc");
654 /* These are owned by the handle and freed by guestfs___free_inspect_info. */
655 fs->fstab[n-1].device = device;
656 fs->fstab[n-1].mountpoint = mountpoint;
658 debug (g, "fstab: device=%s mountpoint=%s", device, mountpoint);
663 /* Resolve block device name to the libguestfs device name, eg.
664 * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV. This
665 * assumes that disks were added in the same order as they appear to
666 * the real VM, which is a reasonable assumption to make. Return
667 * anything we don't recognize unchanged.
670 resolve_fstab_device (guestfs_h *g, const char *spec)
674 char *bsddisk, *bsdslice, *bsdpart;
676 if (STRPREFIX (spec, "/dev/mapper/")) {
677 /* LVM2 does some strange munging on /dev/mapper paths for VGs and
678 * LVs which contain '-' character:
680 * ><fs> lvcreate LV--test VG--test 32
681 * ><fs> debug ls /dev/mapper
682 * VG----test-LV----test
684 * This makes it impossible to reverse those paths directly, so
685 * we have implemented lvm_canonical_lv_name in the daemon.
687 device = guestfs_lvm_canonical_lv_name (g, spec);
689 else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
690 char **devices = guestfs_list_devices (g);
695 for (count = 0; devices[count] != NULL; count++)
698 size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
700 size_t len = strlen (devices[i]) + strlen (a1) + 16;
701 device = safe_malloc (g, len);
702 snprintf (device, len, "%s%s", devices[i], &a1[1]);
706 guestfs___free_string_list (devices);
708 else if (match3 (g, spec, re_freebsd, &bsddisk, &bsdslice, &bsdpart)) {
709 /* FreeBSD disks are organized quite differently. See:
710 * http://www.freebsd.org/doc/handbook/disk-organization.html
711 * FreeBSD "partitions" are exposed as quasi-extended partitions
712 * numbered from 5 in Linux. I have no idea what happens when you
713 * have multiple "slices" (the FreeBSD term for MBR partitions).
715 int disk = guestfs___parse_unsigned_int (g, bsddisk);
716 int slice = guestfs___parse_unsigned_int (g, bsdslice);
717 int part = bsdpart[0] - 'a' /* counting from 0 */;
722 if (disk == -1 || disk > 26 ||
723 slice <= 0 || slice > 1 /* > 4 .. see comment above */ ||
724 part < 0 || part >= 26)
727 device = safe_asprintf (g, "/dev/sd%c%d", disk + 'a', part + 5);
731 /* Didn't match device pattern, return original spec unchanged. */
733 device = safe_strdup (g, spec);
738 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
739 * must exist). As a security measure, this bails if the file is too
740 * large for a reasonable configuration file. After the call to 'f'
744 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
745 int (*f) (guestfs_h *, struct inspect_fs *))
747 /* Security: Refuse to do this if filename is too large. */
748 int64_t size = guestfs_filesize (g, filename);
750 /* guestfs_filesize failed and has already set error in handle */
752 if (size > MAX_AUGEAS_FILE_SIZE) {
753 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
758 /* If !feature_available (g, "augeas") then the next call will fail.
759 * Arguably we might want to fall back to a non-Augeas method in
762 if (guestfs_aug_init (g, "/", 16|32) == -1)
767 /* Tell Augeas to only load one file (thanks Raphaƫl Pinson). */
768 char buf[strlen (filename) + 64];
769 snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
771 if (guestfs_aug_rm (g, buf) == -1)
774 if (guestfs_aug_load (g) == -1)
780 guestfs_aug_close (g);
785 #endif /* defined(HAVE_PCRE) && defined(HAVE_HIVEX) */