src/inspect_fs_unix.c

   1 /* libguestfs
   2  * Copyright (C) 2010-2011 Red Hat Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 #include <config.h>
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <stdint.h>
  24 #include <inttypes.h>
  25 #include <unistd.h>
  26 #include <fcntl.h>
  27 #include <string.h>
  28 #include <sys/stat.h>
  29 #include <errno.h>
  30 #include <endian.h>
  31
  32 #include <pcre.h>
  33
  34 #ifdef HAVE_HIVEX
  35 #include <hivex.h>
  36 #endif
  37
  38 #include "c-ctype.h"
  39 #include "ignore-value.h"
  40 #include "xstrtol.h"
  41
  42 #include "guestfs.h"
  43 #include "guestfs-internal.h"
  44 #include "guestfs-internal-actions.h"
  45 #include "guestfs_protocol.h"
  46
  47 #if defined(HAVE_HIVEX)
  48
  49 /* Compile all the regular expressions once when the shared library is
  50  * loaded.  PCRE is thread safe so we're supposedly OK here if
  51  * multiple threads call into the libguestfs API functions below
  52  * simultaneously.
  53  */
  54 static pcre *re_fedora;
  55 static pcre *re_rhel_old;
  56 static pcre *re_rhel;
  57 static pcre *re_rhel_no_minor;
  58 static pcre *re_centos_old;
  59 static pcre *re_centos;
  60 static pcre *re_centos_no_minor;
  61 static pcre *re_scientific_linux_old;
  62 static pcre *re_scientific_linux;
  63 static pcre *re_scientific_linux_no_minor;
  64 static pcre *re_major_minor;
  65 static pcre *re_aug_seq;
  66 static pcre *re_xdev;
  67 static pcre *re_cciss;
  68 static pcre *re_first_partition;
  69 static pcre *re_freebsd;
  70 static pcre *re_netbsd;
  71
  72 static void compile_regexps (void) __attribute__((constructor));
  73 static void free_regexps (void) __attribute__((destructor));
  74
  75 static void
  76 compile_regexps (void)
  77 {
  78   const char *err;
  79   int offset;
  80
  81 #define COMPILE(re,pattern,options)                                     \
  82   do {                                                                  \
  83     re = pcre_compile ((pattern), (options), &err, &offset, NULL);      \
  84     if (re == NULL) {                                                   \
  85       ignore_value (write (2, err, strlen (err)));                      \
  86       abort ();                                                         \
  87     }                                                                   \
  88   } while (0)
  89
  90   COMPILE (re_fedora, "Fedora release (\\d+)", 0);
  91   COMPILE (re_rhel_old,
  92            "Red Hat.*release (\\d+).*Update (\\d+)", 0);
  93   COMPILE (re_rhel,
  94            "Red Hat.*release (\\d+)\\.(\\d+)", 0);
  95   COMPILE (re_rhel_no_minor,
  96            "Red Hat.*release (\\d+)", 0);
  97   COMPILE (re_centos_old,
  98            "CentOS.*release (\\d+).*Update (\\d+)", 0);
  99   COMPILE (re_centos,
 100            "CentOS.*release (\\d+)\\.(\\d+)", 0);
 101   COMPILE (re_centos_no_minor,
 102            "CentOS.*release (\\d+)", 0);
 103   COMPILE (re_scientific_linux_old,
 104            "Scientific Linux.*release (\\d+).*Update (\\d+)", 0);
 105   COMPILE (re_scientific_linux,
 106            "Scientific Linux.*release (\\d+)\\.(\\d+)", 0);
 107   COMPILE (re_scientific_linux_no_minor,
 108            "Scientific Linux.*release (\\d+)", 0);
 109   COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
 110   COMPILE (re_aug_seq, "/\\d+$", 0);
 111   COMPILE (re_xdev, "^/dev/(h|s|v|xv)d([a-z]+)(\\d*)$", 0);
 112   COMPILE (re_cciss, "^/dev/(cciss/c\\d+d\\d+)(?:p(\\d+))?$", 0);
 113   COMPILE (re_freebsd, "^/dev/ad(\\d+)s(\\d+)([a-z])$", 0);
 114   COMPILE (re_netbsd, "^NetBSD (\\d+)\\.(\\d+)", 0);
 115 }
 116
 117 static void
 118 free_regexps (void)
 119 {
 120   pcre_free (re_fedora);
 121   pcre_free (re_rhel_old);
 122   pcre_free (re_rhel);
 123   pcre_free (re_rhel_no_minor);
 124   pcre_free (re_centos_old);
 125   pcre_free (re_centos);
 126   pcre_free (re_centos_no_minor);
 127   pcre_free (re_scientific_linux_old);
 128   pcre_free (re_scientific_linux);
 129   pcre_free (re_scientific_linux_no_minor);
 130   pcre_free (re_major_minor);
 131   pcre_free (re_aug_seq);
 132   pcre_free (re_xdev);
 133   pcre_free (re_cciss);
 134   pcre_free (re_freebsd);
 135   pcre_free (re_netbsd);
 136 }
 137
 138 static void check_architecture (guestfs_h *g, struct inspect_fs *fs);
 139 static int check_hostname_unix (guestfs_h *g, struct inspect_fs *fs);
 140 static int check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs);
 141 static int check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs);
 142 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
 143 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 144                             const char *spec, const char *mp);
 145 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
 146 static int inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename, int (*f) (guestfs_h *, struct inspect_fs *));
 147
 148 /* Set fs->product_name to the first line of the release file. */
 149 static int
 150 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
 151                     const char *release_filename)
 152 {
 153   fs->product_name = guestfs___first_line_of_file (g, release_filename);
 154   if (fs->product_name == NULL)
 155     return -1;
 156   return 0;
 157 }
 158
 159 /* Ubuntu has /etc/lsb-release containing:
 160  *   DISTRIB_ID=Ubuntu                                # Distro
 161  *   DISTRIB_RELEASE=10.04                            # Version
 162  *   DISTRIB_CODENAME=lucid
 163  *   DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS"         # Product name
 164  *
 165  * [Ubuntu-derived ...] Linux Mint was found to have this:
 166  *   DISTRIB_ID=LinuxMint
 167  *   DISTRIB_RELEASE=10
 168  *   DISTRIB_CODENAME=julia
 169  *   DISTRIB_DESCRIPTION="Linux Mint 10 Julia"
 170  * Linux Mint also has /etc/linuxmint/info with more information,
 171  * but we can use the LSB file.
 172  *
 173  * Mandriva has:
 174  *   LSB_VERSION=lsb-4.0-amd64:lsb-4.0-noarch
 175  *   DISTRIB_ID=MandrivaLinux
 176  *   DISTRIB_RELEASE=2010.1
 177  *   DISTRIB_CODENAME=Henry_Farman
 178  *   DISTRIB_DESCRIPTION="Mandriva Linux 2010.1"
 179  * Mandriva also has a normal release file called /etc/mandriva-release.
 180  */
 181 static int
 182 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
 183 {
 184   const char *filename = "/etc/lsb-release";
 185   int64_t size;
 186   char **lines;
 187   size_t i;
 188   int r = 0;
 189
 190   /* Don't trust guestfs_head_n not to break with very large files.
 191    * Check the file size is something reasonable first.
 192    */
 193   size = guestfs_filesize (g, filename);
 194   if (size == -1)
 195     /* guestfs_filesize failed and has already set error in handle */
 196     return -1;
 197   if (size > MAX_SMALL_FILE_SIZE) {
 198     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 199            filename, size);
 200     return -1;
 201   }
 202
 203   lines = guestfs_head_n (g, 10, filename);
 204   if (lines == NULL)
 205     return -1;
 206
 207   for (i = 0; lines[i] != NULL; ++i) {
 208     if (fs->distro == 0 &&
 209         STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
 210       fs->distro = OS_DISTRO_UBUNTU;
 211       r = 1;
 212     }
 213     else if (fs->distro == 0 &&
 214              STREQ (lines[i], "DISTRIB_ID=LinuxMint")) {
 215       fs->distro = OS_DISTRO_LINUX_MINT;
 216       r = 1;
 217     }
 218     else if (fs->distro == 0 &&
 219              STREQ (lines[i], "DISTRIB_ID=MandrivaLinux")) {
 220       fs->distro = OS_DISTRO_MANDRIVA;
 221       r = 1;
 222     }
 223     else if (fs->distro == 0 &&
 224              STREQ (lines[i], "DISTRIB_ID=\"Mageia\"")) {
 225       fs->distro = OS_DISTRO_MAGEIA;
 226       r = 1;
 227     }
 228     else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
 229       char *major, *minor;
 230       if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
 231         fs->major_version = guestfs___parse_unsigned_int (g, major);
 232         free (major);
 233         if (fs->major_version == -1) {
 234           free (minor);
 235           guestfs___free_string_list (lines);
 236           return -1;
 237         }
 238         fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 239         free (minor);
 240         if (fs->minor_version == -1) {
 241           guestfs___free_string_list (lines);
 242           return -1;
 243         }
 244       }
 245     }
 246     else if (fs->product_name == NULL &&
 247              (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
 248               STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
 249       size_t len = strlen (lines[i]) - 21 - 1;
 250       fs->product_name = safe_strndup (g, &lines[i][21], len);
 251       r = 1;
 252     }
 253     else if (fs->product_name == NULL &&
 254              STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
 255       size_t len = strlen (lines[i]) - 20;
 256       fs->product_name = safe_strndup (g, &lines[i][20], len);
 257       r = 1;
 258     }
 259   }
 260
 261   guestfs___free_string_list (lines);
 262   return r;
 263 }
 264
 265 /* The currently mounted device is known to be a Linux root.  Try to
 266  * determine from this the distro, version, etc.  Also parse
 267  * /etc/fstab to determine the arrangement of mountpoints and
 268  * associated devices.
 269  */
 270 int
 271 guestfs___check_linux_root (guestfs_h *g, struct inspect_fs *fs)
 272 {
 273   int r;
 274
 275   fs->type = OS_TYPE_LINUX;
 276
 277   if (guestfs_exists (g, "/etc/lsb-release") > 0) {
 278     r = parse_lsb_release (g, fs);
 279     if (r == -1)        /* error */
 280       return -1;
 281     if (r == 1)         /* ok - detected the release from this file */
 282       goto skip_release_checks;
 283   }
 284
 285   if (guestfs_exists (g, "/etc/redhat-release") > 0) {
 286     fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
 287
 288     if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
 289       return -1;
 290
 291     char *major, *minor;
 292     if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
 293       fs->distro = OS_DISTRO_FEDORA;
 294       fs->major_version = guestfs___parse_unsigned_int (g, major);
 295       free (major);
 296       if (fs->major_version == -1)
 297         return -1;
 298     }
 299     else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
 300              match2 (g, fs->product_name, re_rhel, &major, &minor)) {
 301       fs->distro = OS_DISTRO_RHEL;
 302       fs->major_version = guestfs___parse_unsigned_int (g, major);
 303       free (major);
 304       if (fs->major_version == -1) {
 305         free (minor);
 306         return -1;
 307       }
 308       fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 309       free (minor);
 310       if (fs->minor_version == -1)
 311         return -1;
 312     }
 313     else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
 314       fs->distro = OS_DISTRO_RHEL;
 315       fs->major_version = guestfs___parse_unsigned_int (g, major);
 316       free (major);
 317       if (fs->major_version == -1)
 318         return -1;
 319       fs->minor_version = 0;
 320     }
 321     else if (match2 (g, fs->product_name, re_centos_old, &major, &minor) ||
 322              match2 (g, fs->product_name, re_centos, &major, &minor)) {
 323       fs->distro = OS_DISTRO_CENTOS;
 324       fs->major_version = guestfs___parse_unsigned_int (g, major);
 325       free (major);
 326       if (fs->major_version == -1) {
 327         free (minor);
 328         return -1;
 329       }
 330       fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 331       free (minor);
 332       if (fs->minor_version == -1)
 333         return -1;
 334     }
 335     else if ((major = match1 (g, fs->product_name, re_centos_no_minor)) != NULL) {
 336       fs->distro = OS_DISTRO_CENTOS;
 337       fs->major_version = guestfs___parse_unsigned_int (g, major);
 338       free (major);
 339       if (fs->major_version == -1)
 340         return -1;
 341       fs->minor_version = 0;
 342     }
 343     else if (match2 (g, fs->product_name, re_scientific_linux_old, &major, &minor) ||
 344              match2 (g, fs->product_name, re_scientific_linux, &major, &minor)) {
 345       fs->distro = OS_DISTRO_SCIENTIFIC_LINUX;
 346       fs->major_version = guestfs___parse_unsigned_int (g, major);
 347       free (major);
 348       if (fs->major_version == -1) {
 349         free (minor);
 350         return -1;
 351       }
 352       fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 353       free (minor);
 354       if (fs->minor_version == -1)
 355         return -1;
 356     }
 357     else if ((major = match1 (g, fs->product_name, re_scientific_linux_no_minor)) != NULL) {
 358       fs->distro = OS_DISTRO_SCIENTIFIC_LINUX;
 359       fs->major_version = guestfs___parse_unsigned_int (g, major);
 360       free (major);
 361       if (fs->major_version == -1)
 362         return -1;
 363       fs->minor_version = 0;
 364     }
 365   }
 366   else if (guestfs_exists (g, "/etc/debian_version") > 0) {
 367     fs->distro = OS_DISTRO_DEBIAN;
 368
 369     if (parse_release_file (g, fs, "/etc/debian_version") == -1)
 370       return -1;
 371
 372     if (guestfs___parse_major_minor (g, fs) == -1)
 373       return -1;
 374   }
 375   else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
 376     fs->distro = OS_DISTRO_PARDUS;
 377
 378     if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
 379       return -1;
 380
 381     if (guestfs___parse_major_minor (g, fs) == -1)
 382       return -1;
 383   }
 384   else if (guestfs_exists (g, "/etc/arch-release") > 0) {
 385     fs->distro = OS_DISTRO_ARCHLINUX;
 386
 387     /* /etc/arch-release file is empty and I can't see a way to
 388      * determine the actual release or product string.
 389      */
 390   }
 391   else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
 392     fs->distro = OS_DISTRO_GENTOO;
 393
 394     if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
 395       return -1;
 396
 397     if (guestfs___parse_major_minor (g, fs) == -1)
 398       return -1;
 399   }
 400   else if (guestfs_exists (g, "/etc/meego-release") > 0) {
 401     fs->distro = OS_DISTRO_MEEGO;
 402
 403     if (parse_release_file (g, fs, "/etc/meego-release") == -1)
 404       return -1;
 405
 406     if (guestfs___parse_major_minor (g, fs) == -1)
 407       return -1;
 408   }
 409   else if (guestfs_exists (g, "/etc/slackware-version") > 0) {
 410     fs->distro = OS_DISTRO_SLACKWARE;
 411
 412     if (parse_release_file (g, fs, "/etc/slackware-version") == -1)
 413       return -1;
 414
 415     if (guestfs___parse_major_minor (g, fs) == -1)
 416       return -1;
 417   }
 418   else if (guestfs_exists (g, "/etc/ttylinux-target") > 0) {
 419     fs->distro = OS_DISTRO_TTYLINUX;
 420
 421     fs->product_name = guestfs___first_line_of_file (g, "/etc/ttylinux-target");
 422     if (fs->product_name == NULL)
 423       return -1;
 424
 425     if (guestfs___parse_major_minor (g, fs) == -1)
 426       return -1;
 427   }
 428   else if (guestfs_exists (g, "/etc/SuSE-release") > 0) {
 429     fs->distro = OS_DISTRO_OPENSUSE;
 430
 431     if (parse_release_file (g, fs, "/etc/SuSE-release") == -1)
 432       return -1;
 433
 434     if (guestfs___parse_major_minor (g, fs) == -1)
 435       return -1;
 436   }
 437
 438
 439  skip_release_checks:;
 440
 441   /* Determine the architecture. */
 442   check_architecture (g, fs);
 443
 444   /* We already know /etc/fstab exists because it's part of the test
 445    * for Linux root above.  We must now parse this file to determine
 446    * which filesystems are used by the operating system and how they
 447    * are mounted.
 448    */
 449   if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
 450     return -1;
 451
 452   /* Determine hostname. */
 453   if (check_hostname_unix (g, fs) == -1)
 454     return -1;
 455
 456   return 0;
 457 }
 458
 459 /* The currently mounted device is known to be a FreeBSD root. */
 460 int
 461 guestfs___check_freebsd_root (guestfs_h *g, struct inspect_fs *fs)
 462 {
 463   fs->type = OS_TYPE_FREEBSD;
 464
 465   /* FreeBSD has no authoritative version file.  The version number is
 466    * in /etc/motd, which the system administrator might edit, but
 467    * we'll use that anyway.
 468    */
 469
 470   if (guestfs_exists (g, "/etc/motd") > 0) {
 471     if (parse_release_file (g, fs, "/etc/motd") == -1)
 472       return -1;
 473
 474     if (guestfs___parse_major_minor (g, fs) == -1)
 475       return -1;
 476   }
 477
 478   /* Determine the architecture. */
 479   check_architecture (g, fs);
 480
 481   /* We already know /etc/fstab exists because it's part of the test above. */
 482   if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
 483     return -1;
 484
 485   /* Determine hostname. */
 486   if (check_hostname_unix (g, fs) == -1)
 487     return -1;
 488
 489   return 0;
 490 }
 491
 492 /* The currently mounted device is maybe to be a *BSD root. */
 493 int
 494 guestfs___check_netbsd_root (guestfs_h *g, struct inspect_fs *fs)
 495 {
 496
 497   if (guestfs_exists (g, "/etc/release") > 0) {
 498     char *major, *minor;
 499     if (parse_release_file (g, fs, "/etc/release") == -1)
 500       return -1;
 501
 502     if (match2 (g, fs->product_name, re_netbsd, &major, &minor)) {
 503       fs->type = OS_TYPE_NETBSD;
 504       fs->major_version = guestfs___parse_unsigned_int (g, major);
 505       free (major);
 506       if (fs->major_version == -1) {
 507         free (minor);
 508         return -1;
 509       }
 510       fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 511       free (minor);
 512       if (fs->minor_version == -1)
 513         return -1;
 514     }
 515   } else {
 516     return -1;
 517   }
 518
 519   /* Determine the architecture. */
 520   check_architecture (g, fs);
 521
 522   /* We already know /etc/fstab exists because it's part of the test above. */
 523   if (inspect_with_augeas (g, fs, "/etc/fstab", check_fstab) == -1)
 524     return -1;
 525
 526   /* Determine hostname. */
 527   if (check_hostname_unix (g, fs) == -1)
 528     return -1;
 529
 530   return 0;
 531 }
 532
 533
 534 static void
 535 check_architecture (guestfs_h *g, struct inspect_fs *fs)
 536 {
 537   const char *binaries[] =
 538     { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
 539   size_t i;
 540
 541   for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
 542     if (guestfs_is_file (g, binaries[i]) > 0) {
 543       /* Ignore errors from file_architecture call. */
 544       guestfs_error_handler_cb old_error_cb = g->error_cb;
 545       g->error_cb = NULL;
 546       char *arch = guestfs_file_architecture (g, binaries[i]);
 547       g->error_cb = old_error_cb;
 548
 549       if (arch) {
 550         /* String will be owned by handle, freed by
 551          * guestfs___free_inspect_info.
 552          */
 553         fs->arch = arch;
 554         break;
 555       }
 556     }
 557   }
 558 }
 559
 560 /* Try several methods to determine the hostname from a Linux or
 561  * FreeBSD guest.  Note that type and distro have been set, so we can
 562  * use that information to direct the search.
 563  */
 564 static int
 565 check_hostname_unix (guestfs_h *g, struct inspect_fs *fs)
 566 {
 567   switch (fs->type) {
 568   case OS_TYPE_LINUX:
 569     /* Red Hat-derived would be in /etc/sysconfig/network, and
 570      * Debian-derived in the file /etc/hostname.  Very old Debian and
 571      * SUSE use /etc/HOSTNAME.  It's best to just look for each of
 572      * these files in turn, rather than try anything clever based on
 573      * distro.
 574      */
 575     if (guestfs_is_file (g, "/etc/HOSTNAME")) {
 576       fs->hostname = guestfs___first_line_of_file (g, "/etc/HOSTNAME");
 577       if (fs->hostname == NULL)
 578         return -1;
 579     }
 580     else if (guestfs_is_file (g, "/etc/hostname")) {
 581       fs->hostname = guestfs___first_line_of_file (g, "/etc/hostname");
 582       if (fs->hostname == NULL)
 583         return -1;
 584     }
 585     else if (guestfs_is_file (g, "/etc/sysconfig/network")) {
 586       if (inspect_with_augeas (g, fs, "/etc/sysconfig/network",
 587                                check_hostname_redhat) == -1)
 588         return -1;
 589     }
 590     break;
 591
 592   case OS_TYPE_FREEBSD:
 593   case OS_TYPE_NETBSD:
 594     /* /etc/rc.conf contains the hostname, but there is no Augeas lens
 595      * for this file.
 596      */
 597     if (guestfs_is_file (g, "/etc/rc.conf")) {
 598       if (check_hostname_freebsd (g, fs) == -1)
 599         return -1;
 600     }
 601     break;
 602
 603   case OS_TYPE_WINDOWS: /* not here, see check_windows_system_registry */
 604   case OS_TYPE_UNKNOWN:
 605   default:
 606     /* nothing, keep GCC warnings happy */;
 607   }
 608
 609   return 0;
 610 }
 611
 612 /* Parse the hostname from /etc/sysconfig/network.  This must be called
 613  * from the inspect_with_augeas wrapper.
 614  */
 615 static int
 616 check_hostname_redhat (guestfs_h *g, struct inspect_fs *fs)
 617 {
 618   char *hostname;
 619
 620   /* Errors here are not fatal (RHBZ#726739), since it could be
 621    * just missing HOSTNAME field in the file.
 622    */
 623   guestfs_error_handler_cb old_error_cb = g->error_cb;
 624   g->error_cb = NULL;
 625   hostname = guestfs_aug_get (g, "/files/etc/sysconfig/network/HOSTNAME");
 626   g->error_cb = old_error_cb;
 627
 628   /* This is freed by guestfs___free_inspect_info.  Note that hostname
 629    * could be NULL because we ignored errors above.
 630    */
 631   fs->hostname = hostname;
 632   return 0;
 633 }
 634
 635 /* Parse the hostname from /etc/rc.conf.  On FreeBSD this file
 636  * contains comments, blank lines and:
 637  *   hostname="freebsd8.example.com"
 638  *   ifconfig_re0="DHCP"
 639  *   keymap="uk.iso"
 640  *   sshd_enable="YES"
 641  */
 642 static int
 643 check_hostname_freebsd (guestfs_h *g, struct inspect_fs *fs)
 644 {
 645   const char *filename = "/etc/rc.conf";
 646   int64_t size;
 647   char **lines;
 648   size_t i;
 649
 650   /* Don't trust guestfs_read_lines not to break with very large files.
 651    * Check the file size is something reasonable first.
 652    */
 653   size = guestfs_filesize (g, filename);
 654   if (size == -1)
 655     /* guestfs_filesize failed and has already set error in handle */
 656     return -1;
 657   if (size > MAX_SMALL_FILE_SIZE) {
 658     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 659            filename, size);
 660     return -1;
 661   }
 662
 663   lines = guestfs_read_lines (g, filename);
 664   if (lines == NULL)
 665     return -1;
 666
 667   for (i = 0; lines[i] != NULL; ++i) {
 668     if (STRPREFIX (lines[i], "hostname=\"") ||
 669         STRPREFIX (lines[i], "hostname='")) {
 670       size_t len = strlen (lines[i]) - 10 - 1;
 671       fs->hostname = safe_strndup (g, &lines[i][10], len);
 672       break;
 673     } else if (STRPREFIX (lines[i], "hostname=")) {
 674       size_t len = strlen (lines[i]) - 9;
 675       fs->hostname = safe_strndup (g, &lines[i][9], len);
 676       break;
 677     }
 678   }
 679
 680   guestfs___free_string_list (lines);
 681   return 0;
 682 }
 683
 684 static int
 685 check_fstab (guestfs_h *g, struct inspect_fs *fs)
 686 {
 687   char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
 688   if (lines == NULL) goto error;
 689
 690   if (lines[0] == NULL) {
 691     error (g, _("could not parse /etc/fstab or empty file"));
 692     goto error;
 693   }
 694
 695   size_t i;
 696   char augpath[256];
 697   for (i = 0; lines[i] != NULL; ++i) {
 698     /* Ignore comments.  Only care about sequence lines which
 699      * match m{/\d+$}.
 700      */
 701     if (match (g, lines[i], re_aug_seq)) {
 702       snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
 703       char *spec = guestfs_aug_get (g, augpath);
 704       if (spec == NULL) goto error;
 705
 706       snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
 707       char *mp = guestfs_aug_get (g, augpath);
 708       if (mp == NULL) {
 709         free (spec);
 710         goto error;
 711       }
 712
 713       int r = add_fstab_entry (g, fs, spec, mp);
 714       free (spec);
 715       free (mp);
 716
 717       if (r == -1) goto error;
 718     }
 719   }
 720
 721   guestfs___free_string_list (lines);
 722   return 0;
 723
 724 error:
 725   if (lines) guestfs___free_string_list (lines);
 726   return -1;
 727 }
 728
 729 /* Add a filesystem and possibly a mountpoint entry for
 730  * the root filesystem 'fs'.
 731  *
 732  * 'spec' is the fstab spec field, which might be a device name or a
 733  * pseudodevice or 'UUID=...' or 'LABEL=...'.
 734  *
 735  * 'mp' is the mount point, which could also be 'swap' or 'none'.
 736  */
 737 static int
 738 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 739                  const char *spec, const char *mp)
 740 {
 741   /* Ignore certain mountpoints. */
 742   if (STRPREFIX (mp, "/dev/") ||
 743       STREQ (mp, "/dev") ||
 744       STRPREFIX (mp, "/media/") ||
 745       STRPREFIX (mp, "/proc/") ||
 746       STREQ (mp, "/proc") ||
 747       STRPREFIX (mp, "/selinux/") ||
 748       STREQ (mp, "/selinux") ||
 749       STRPREFIX (mp, "/sys/") ||
 750       STREQ (mp, "/sys"))
 751     return 0;
 752
 753   /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
 754   if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
 755       STREQ (spec, "/dev/floppy") ||
 756       STREQ (spec, "/dev/cdrom"))
 757     return 0;
 758
 759   /* Resolve UUID= and LABEL= to the actual device. */
 760   char *device = NULL;
 761   if (STRPREFIX (spec, "UUID="))
 762     device = guestfs_findfs_uuid (g, &spec[5]);
 763   else if (STRPREFIX (spec, "LABEL="))
 764     device = guestfs_findfs_label (g, &spec[6]);
 765   /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
 766   else if (STREQ (spec, "/dev/root"))
 767     /* Resolve /dev/root to the current device. */
 768     device = safe_strdup (g, fs->device);
 769   else if (STRPREFIX (spec, "/dev/"))
 770     /* Resolve guest block device names. */
 771     device = resolve_fstab_device (g, spec);
 772
 773   /* If we haven't resolved the device successfully by this point,
 774    * we don't care, just ignore it.
 775    */
 776   if (device == NULL)
 777     return 0;
 778
 779   char *mountpoint = safe_strdup (g, mp);
 780
 781   /* Add this to the fstab entry in 'fs'.
 782    * Note these are further filtered by guestfs_inspect_get_mountpoints
 783    * and guestfs_inspect_get_filesystems.
 784    */
 785   size_t n = fs->nr_fstab + 1;
 786   struct inspect_fstab_entry *p;
 787
 788   p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
 789   if (p == NULL) {
 790     perrorf (g, "realloc");
 791     free (device);
 792     free (mountpoint);
 793     return -1;
 794   }
 795
 796   fs->fstab = p;
 797   fs->nr_fstab = n;
 798
 799   /* These are owned by the handle and freed by guestfs___free_inspect_info. */
 800   fs->fstab[n-1].device = device;
 801   fs->fstab[n-1].mountpoint = mountpoint;
 802
 803   debug (g, "fstab: device=%s mountpoint=%s", device, mountpoint);
 804
 805   return 0;
 806 }
 807
 808 /* Resolve block device name to the libguestfs device name, eg.
 809  * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV.  This
 810  * assumes that disks were added in the same order as they appear to
 811  * the real VM, which is a reasonable assumption to make.  Return
 812  * anything we don't recognize unchanged.
 813  */
 814 static char *
 815 resolve_fstab_device (guestfs_h *g, const char *spec)
 816 {
 817   char *device = NULL;
 818   char *type, *slice, *disk, *part;
 819
 820   if (STRPREFIX (spec, "/dev/mapper/")) {
 821     /* LVM2 does some strange munging on /dev/mapper paths for VGs and
 822      * LVs which contain '-' character:
 823      *
 824      * ><fs> lvcreate LV--test VG--test 32
 825      * ><fs> debug ls /dev/mapper
 826      * VG----test-LV----test
 827      *
 828      * This makes it impossible to reverse those paths directly, so
 829      * we have implemented lvm_canonical_lv_name in the daemon.
 830      */
 831     device = guestfs_lvm_canonical_lv_name (g, spec);
 832   }
 833   else if (match3 (g, spec, re_xdev, &type, &disk, &part)) {
 834     /* type: (h|s|v|xv)
 835      * disk: ([a-z]+)
 836      * part: (\d*) */
 837     char **devices = guestfs_list_devices (g);
 838     if (devices == NULL)
 839       return NULL;
 840
 841     /* Check any hints we were passed for a non-heuristic mapping */
 842     char *name = safe_asprintf (g, "%sd%s", type, disk);
 843     size_t i = 0;
 844     struct drive *drive = g->drives;
 845     while (drive) {
 846       if (drive->name && STREQ(drive->name, name)) {
 847         device = safe_asprintf (g, "%s%s", devices[i], part);
 848         break;
 849       }
 850
 851       i++; drive = drive->next;
 852     }
 853     free (name);
 854
 855     /* Guess the appliance device name if we didn't find a matching hint */
 856     if (!device) {
 857       /* Count how many disks the libguestfs appliance has */
 858       size_t count;
 859       for (count = 0; devices[count] != NULL; count++)
 860         ;
 861
 862       /* Calculate the numerical index of the disk */
 863       i = disk[0] - 'a';
 864       for (char *p = disk + 1; *p != '\0'; p++) {
 865         i += 1; i *= 26;
 866         i += *p - 'a';
 867       }
 868
 869       /* Check the index makes sense wrt the number of disks the appliance has.
 870        * If it does, map it to an appliance disk. */
 871       if (i < count) {
 872         device = safe_asprintf (g, "%s%s", devices[i], part);
 873       }
 874     }
 875
 876     free (type);
 877     free (disk);
 878     free (part);
 879     guestfs___free_string_list (devices);
 880   }
 881   else if (match2 (g, spec, re_cciss, &disk, &part)) {
 882     /* disk: (cciss/c\d+d\d+)
 883      * part: (\d+)? */
 884     char **devices = guestfs_list_devices (g);
 885     if (devices == NULL)
 886       return NULL;
 887
 888     /* Check any hints we were passed for a non-heuristic mapping */
 889     size_t i = 0;
 890     struct drive *drive = g->drives;
 891     while (drive) {
 892       if (drive->name && STREQ(drive->name, disk)) {
 893         if (part) {
 894           device = safe_asprintf (g, "%s%s", devices[i], part);
 895         } else {
 896           device = safe_strdup (g, devices[i]);
 897         }
 898         break;
 899       }
 900
 901       i++; drive = drive->next;
 902     }
 903
 904     /* We don't try to guess mappings for cciss devices */
 905
 906     free (disk);
 907     free (part);
 908     guestfs___free_string_list (devices);
 909   }
 910   else if (match3 (g, spec, re_freebsd, &disk, &slice, &part)) {
 911     /* FreeBSD disks are organized quite differently.  See:
 912      * http://www.freebsd.org/doc/handbook/disk-organization.html
 913      * FreeBSD "partitions" are exposed as quasi-extended partitions
 914      * numbered from 5 in Linux.  I have no idea what happens when you
 915      * have multiple "slices" (the FreeBSD term for MBR partitions).
 916      */
 917     int disk_i = guestfs___parse_unsigned_int (g, disk);
 918     int slice_i = guestfs___parse_unsigned_int (g, slice);
 919     int part_i = part[0] - 'a' /* counting from 0 */;
 920     free (disk);
 921     free (slice);
 922     free (part);
 923
 924     if (disk_i != -1 && disk_i <= 26 &&
 925         slice_i > 0 && slice_i <= 1 /* > 4 .. see comment above */ &&
 926         part_i >= 0 && part_i < 26) {
 927       device = safe_asprintf (g, "/dev/sd%c%d", disk_i + 'a', part_i + 5);
 928     }
 929   }
 930
 931   /* Didn't match device pattern, return original spec unchanged. */
 932   if (device == NULL)
 933     device = safe_strdup (g, spec);
 934
 935   return device;
 936 }
 937
 938 /* Call 'f' with Augeas opened and having parsed 'filename' (this file
 939  * must exist).  As a security measure, this bails if the file is too
 940  * large for a reasonable configuration file.  After the call to 'f'
 941  * Augeas is closed.
 942  */
 943 static int
 944 inspect_with_augeas (guestfs_h *g, struct inspect_fs *fs, const char *filename,
 945                      int (*f) (guestfs_h *, struct inspect_fs *))
 946 {
 947   /* Security: Refuse to do this if filename is too large. */
 948   int64_t size = guestfs_filesize (g, filename);
 949   if (size == -1)
 950     /* guestfs_filesize failed and has already set error in handle */
 951     return -1;
 952   if (size > MAX_AUGEAS_FILE_SIZE) {
 953     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 954            filename, size);
 955     return -1;
 956   }
 957
 958   /* If !feature_available (g, "augeas") then the next call will fail.
 959    * Arguably we might want to fall back to a non-Augeas method in
 960    * this case.
 961    */
 962   if (guestfs_aug_init (g, "/", 16|32) == -1)
 963     return -1;
 964
 965   int r = -1;
 966
 967   /* Tell Augeas to only load one file (thanks Raphaël Pinson). */
 968   char buf[strlen (filename) + 64];
 969   snprintf (buf, strlen (filename) + 64, "/augeas/load//incl[. != \"%s\"]",
 970             filename);
 971   if (guestfs_aug_rm (g, buf) == -1)
 972     goto out;
 973
 974   if (guestfs_aug_load (g) == -1)
 975     goto out;
 976
 977   r = f (g, fs);
 978
 979  out:
 980   guestfs_aug_close (g);
 981
 982   return r;
 983 }
 984
 985 #endif /* defined(HAVE_HIVEX) */