src/inspect_fs.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_first_partition;
  55 static pcre *re_major_minor;
  56
  57 static void compile_regexps (void) __attribute__((constructor));
  58 static void free_regexps (void) __attribute__((destructor));
  59
  60 static void
  61 compile_regexps (void)
  62 {
  63   const char *err;
  64   int offset;
  65
  66 #define COMPILE(re,pattern,options)                                     \
  67   do {                                                                  \
  68     re = pcre_compile ((pattern), (options), &err, &offset, NULL);      \
  69     if (re == NULL) {                                                   \
  70       ignore_value (write (2, err, strlen (err)));                      \
  71       abort ();                                                         \
  72     }                                                                   \
  73   } while (0)
  74
  75   COMPILE (re_first_partition, "^/dev/(?:h|s|v)d.1$", 0);
  76   COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
  77 }
  78
  79 static void
  80 free_regexps (void)
  81 {
  82   pcre_free (re_first_partition);
  83   pcre_free (re_major_minor);
  84 }
  85
  86 static int check_filesystem (guestfs_h *g, const char *device, int is_block, int is_partnum);
  87 static void check_package_format (guestfs_h *g, struct inspect_fs *fs);
  88 static void check_package_management (guestfs_h *g, struct inspect_fs *fs);
  89 static int extend_fses (guestfs_h *g);
  90
  91 /* Find out if 'device' contains a filesystem.  If it does, add
  92  * another entry in g->fses.
  93  */
  94 int
  95 guestfs___check_for_filesystem_on (guestfs_h *g, const char *device,
  96                                    int is_block, int is_partnum)
  97 {
  98   /* Get vfs-type in order to check if it's a Linux(?) swap device.
  99    * If there's an error we should ignore it, so to do that we have to
 100    * temporarily replace the error handler with a null one.
 101    */
 102   guestfs_error_handler_cb old_error_cb = g->error_cb;
 103   g->error_cb = NULL;
 104   char *vfs_type = guestfs_vfs_type (g, device);
 105   g->error_cb = old_error_cb;
 106
 107   int is_swap = vfs_type && STREQ (vfs_type, "swap");
 108
 109   debug (g, "check_for_filesystem_on: %s %d %d (%s)",
 110          device, is_block, is_partnum,
 111          vfs_type ? vfs_type : "failed to get vfs type");
 112
 113   if (is_swap) {
 114     free (vfs_type);
 115     if (extend_fses (g) == -1)
 116       return -1;
 117     g->fses[g->nr_fses-1].is_swap = 1;
 118     return 0;
 119   }
 120
 121   /* Try mounting the device.  As above, ignore errors. */
 122   g->error_cb = NULL;
 123   int r;
 124   if (vfs_type && STREQ (vfs_type, "ufs")) { /* Hack for the *BSDs. */
 125     /* FreeBSD fs is a variant of ufs called ufs2 ... */
 126     r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
 127     if (r == -1)
 128       /* while NetBSD and OpenBSD use another variant labeled 44bsd */
 129       r = guestfs_mount_vfs (g, "ro,ufstype=44bsd", "ufs", device, "/");
 130   } else {
 131     r = guestfs_mount_ro (g, device, "/");
 132   }
 133   free (vfs_type);
 134   g->error_cb = old_error_cb;
 135   if (r == -1)
 136     return 0;
 137
 138   /* Do the rest of the checks. */
 139   r = check_filesystem (g, device, is_block, is_partnum);
 140
 141   /* Unmount the filesystem. */
 142   if (guestfs_umount_all (g) == -1)
 143     return -1;
 144
 145   return r;
 146 }
 147
 148 /* is_block and is_partnum are just hints: is_block is true if the
 149  * filesystem is a whole block device (eg. /dev/sda).  is_partnum
 150  * is > 0 if the filesystem is a direct partition, and in this case
 151  * it is the partition number counting from 1
 152  * (eg. /dev/sda1 => is_partnum == 1).
 153  */
 154 static int
 155 check_filesystem (guestfs_h *g, const char *device,
 156                   int is_block, int is_partnum)
 157 {
 158   if (extend_fses (g) == -1)
 159     return -1;
 160
 161   struct inspect_fs *fs = &g->fses[g->nr_fses-1];
 162
 163   fs->device = safe_strdup (g, device);
 164   fs->is_mountable = 1;
 165
 166   /* Optimize some of the tests by avoiding multiple tests of the same thing. */
 167   int is_dir_etc = guestfs_is_dir (g, "/etc") > 0;
 168   int is_dir_bin = guestfs_is_dir (g, "/bin") > 0;
 169   int is_dir_share = guestfs_is_dir (g, "/share") > 0;
 170
 171   /* Grub /boot? */
 172   if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
 173       guestfs_is_file (g, "/grub/grub.conf") > 0)
 174     fs->content = FS_CONTENT_LINUX_BOOT;
 175   /* FreeBSD root? */
 176   else if (is_dir_etc &&
 177            is_dir_bin &&
 178            guestfs_is_file (g, "/etc/freebsd-update.conf") > 0 &&
 179            guestfs_is_file (g, "/etc/fstab") > 0) {
 180     /* Ignore /dev/sda1 which is a shadow of the real root filesystem
 181      * that is probably /dev/sda5 (see:
 182      * http://www.freebsd.org/doc/handbook/disk-organization.html)
 183      */
 184     if (match (g, device, re_first_partition))
 185       return 0;
 186
 187     fs->is_root = 1;
 188     fs->content = FS_CONTENT_FREEBSD_ROOT;
 189     fs->format = OS_FORMAT_INSTALLED;
 190     if (guestfs___check_freebsd_root (g, fs) == -1)
 191       return -1;
 192   }
 193   /* Linux root? */
 194   else if (is_dir_etc &&
 195            is_dir_bin &&
 196            guestfs_is_file (g, "/etc/fstab") > 0) {
 197     fs->is_root = 1;
 198     fs->content = FS_CONTENT_LINUX_ROOT;
 199     fs->format = OS_FORMAT_INSTALLED;
 200     if (guestfs___check_linux_root (g, fs) == -1)
 201       return -1;
 202   }
 203   /* Linux /usr/local? */
 204   else if (is_dir_etc &&
 205            is_dir_bin &&
 206            is_dir_share &&
 207            guestfs_exists (g, "/local") == 0 &&
 208            guestfs_is_file (g, "/etc/fstab") == 0)
 209     fs->content = FS_CONTENT_LINUX_USR_LOCAL;
 210   /* Linux /usr? */
 211   else if (is_dir_etc &&
 212            is_dir_bin &&
 213            is_dir_share &&
 214            guestfs_exists (g, "/local") > 0 &&
 215            guestfs_is_file (g, "/etc/fstab") == 0)
 216     fs->content = FS_CONTENT_LINUX_USR;
 217   /* Linux /var? */
 218   else if (guestfs_is_dir (g, "/log") > 0 &&
 219            guestfs_is_dir (g, "/run") > 0 &&
 220            guestfs_is_dir (g, "/spool") > 0)
 221     fs->content = FS_CONTENT_LINUX_VAR;
 222   /* Windows root? */
 223   else if (guestfs___has_windows_systemroot (g) >= 0) {
 224     fs->is_root = 1;
 225     fs->content = FS_CONTENT_WINDOWS_ROOT;
 226     fs->format = OS_FORMAT_INSTALLED;
 227     if (guestfs___check_windows_root (g, fs) == -1)
 228       return -1;
 229   }
 230   /* Windows volume with installed applications (but not root)? */
 231   else if (guestfs___is_dir_nocase (g, "/System Volume Information") > 0 &&
 232            guestfs___is_dir_nocase (g, "/Program Files") > 0)
 233     fs->content = FS_CONTENT_WINDOWS_VOLUME_WITH_APPS;
 234   /* Windows volume (but not root)? */
 235   else if (guestfs___is_dir_nocase (g, "/System Volume Information") > 0)
 236     fs->content = FS_CONTENT_WINDOWS_VOLUME;
 237   /* Install CD/disk?  Skip these checks if it's not a whole device
 238    * (eg. CD) or the first partition (eg. bootable USB key).
 239    */
 240   else if ((is_block || is_partnum == 1) &&
 241            (guestfs_is_file (g, "/isolinux/isolinux.cfg") > 0 ||
 242             guestfs_is_dir (g, "/EFI/BOOT") > 0 ||
 243             guestfs_is_file (g, "/images/install.img") > 0 ||
 244             guestfs_is_dir (g, "/.disk") > 0 ||
 245             guestfs_is_file (g, "/.discinfo") > 0 ||
 246             guestfs_is_file (g, "/i386/txtsetup.sif") > 0 ||
 247             guestfs_is_file (g, "/amd64/txtsetup.sif")) > 0) {
 248     fs->is_root = 1;
 249     fs->content = FS_CONTENT_INSTALLER;
 250     fs->format = OS_FORMAT_INSTALLER;
 251     if (guestfs___check_installer_root (g, fs) == -1)
 252       return -1;
 253   }
 254
 255   /* The above code should have set fs->type and fs->distro fields, so
 256    * we can now guess the package management system.
 257    */
 258   check_package_format (g, fs);
 259   check_package_management (g, fs);
 260
 261   return 0;
 262 }
 263
 264 static int
 265 extend_fses (guestfs_h *g)
 266 {
 267   size_t n = g->nr_fses + 1;
 268   struct inspect_fs *p;
 269
 270   p = realloc (g->fses, n * sizeof (struct inspect_fs));
 271   if (p == NULL) {
 272     perrorf (g, "realloc");
 273     return -1;
 274   }
 275
 276   g->fses = p;
 277   g->nr_fses = n;
 278
 279   memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
 280
 281   return 0;
 282 }
 283
 284 int
 285 guestfs___is_file_nocase (guestfs_h *g, const char *path)
 286 {
 287   char *p;
 288   int r;
 289
 290   p = guestfs___case_sensitive_path_silently (g, path);
 291   if (!p)
 292     return 0;
 293   r = guestfs_is_file (g, p);
 294   free (p);
 295   return r > 0;
 296 }
 297
 298 int
 299 guestfs___is_dir_nocase (guestfs_h *g, const char *path)
 300 {
 301   char *p;
 302   int r;
 303
 304   p = guestfs___case_sensitive_path_silently (g, path);
 305   if (!p)
 306     return 0;
 307   r = guestfs_is_dir (g, p);
 308   free (p);
 309   return r > 0;
 310 }
 311
 312 /* Parse small, unsigned ints, as used in version numbers. */
 313 int
 314 guestfs___parse_unsigned_int (guestfs_h *g, const char *str)
 315 {
 316   long ret;
 317   int r = xstrtol (str, NULL, 10, &ret, "");
 318   if (r != LONGINT_OK) {
 319     error (g, _("could not parse integer in version number: %s"), str);
 320     return -1;
 321   }
 322   return ret;
 323 }
 324
 325 /* Like parse_unsigned_int, but ignore trailing stuff. */
 326 int
 327 guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str)
 328 {
 329   long ret;
 330   int r = xstrtol (str, NULL, 10, &ret, NULL);
 331   if (r != LONGINT_OK) {
 332     error (g, _("could not parse integer in version number: %s"), str);
 333     return -1;
 334   }
 335   return ret;
 336 }
 337
 338 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
 339 int
 340 guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
 341 {
 342   char *major, *minor;
 343
 344   if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
 345     fs->major_version = guestfs___parse_unsigned_int (g, major);
 346     free (major);
 347     if (fs->major_version == -1) {
 348       free (minor);
 349       return -1;
 350     }
 351     fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 352     free (minor);
 353     if (fs->minor_version == -1)
 354       return -1;
 355   }
 356   return 0;
 357 }
 358
 359 /* At the moment, package format and package management is just a
 360  * simple function of the distro and major_version fields, so these
 361  * can never return an error.  We might be cleverer in future.
 362  */
 363 static void
 364 check_package_format (guestfs_h *g, struct inspect_fs *fs)
 365 {
 366   switch (fs->distro) {
 367   case OS_DISTRO_FEDORA:
 368   case OS_DISTRO_MEEGO:
 369   case OS_DISTRO_REDHAT_BASED:
 370   case OS_DISTRO_RHEL:
 371   case OS_DISTRO_MAGEIA:
 372   case OS_DISTRO_MANDRIVA:
 373   case OS_DISTRO_OPENSUSE:
 374   case OS_DISTRO_CENTOS:
 375   case OS_DISTRO_SCIENTIFIC_LINUX:
 376     fs->package_format = OS_PACKAGE_FORMAT_RPM;
 377     break;
 378
 379   case OS_DISTRO_DEBIAN:
 380   case OS_DISTRO_UBUNTU:
 381   case OS_DISTRO_LINUX_MINT:
 382     fs->package_format = OS_PACKAGE_FORMAT_DEB;
 383     break;
 384
 385   case OS_DISTRO_ARCHLINUX:
 386     fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
 387     break;
 388   case OS_DISTRO_GENTOO:
 389     fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
 390     break;
 391   case OS_DISTRO_PARDUS:
 392     fs->package_format = OS_PACKAGE_FORMAT_PISI;
 393     break;
 394
 395   case OS_DISTRO_SLACKWARE:
 396   case OS_DISTRO_TTYLINUX:
 397   case OS_DISTRO_WINDOWS:
 398   case OS_DISTRO_UNKNOWN:
 399   default:
 400     fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
 401     break;
 402   }
 403 }
 404
 405 static void
 406 check_package_management (guestfs_h *g, struct inspect_fs *fs)
 407 {
 408   switch (fs->distro) {
 409   case OS_DISTRO_FEDORA:
 410   case OS_DISTRO_MEEGO:
 411     fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
 412     break;
 413
 414   case OS_DISTRO_REDHAT_BASED:
 415   case OS_DISTRO_RHEL:
 416   case OS_DISTRO_CENTOS:
 417   case OS_DISTRO_SCIENTIFIC_LINUX:
 418     if (fs->major_version >= 5)
 419       fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
 420     else
 421       fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
 422     break;
 423
 424   case OS_DISTRO_DEBIAN:
 425   case OS_DISTRO_UBUNTU:
 426   case OS_DISTRO_LINUX_MINT:
 427     fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
 428     break;
 429
 430   case OS_DISTRO_ARCHLINUX:
 431     fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
 432     break;
 433   case OS_DISTRO_GENTOO:
 434     fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
 435     break;
 436   case OS_DISTRO_PARDUS:
 437     fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
 438     break;
 439   case OS_DISTRO_MAGEIA:
 440   case OS_DISTRO_MANDRIVA:
 441     fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
 442     break;
 443
 444   case OS_DISTRO_OPENSUSE:
 445     fs->package_management = OS_PACKAGE_MANAGEMENT_ZYPPER;
 446     break;
 447
 448   case OS_DISTRO_SLACKWARE:
 449   case OS_DISTRO_TTYLINUX:
 450   case OS_DISTRO_WINDOWS:
 451   case OS_DISTRO_UNKNOWN:
 452   default:
 453     fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
 454     break;
 455   }
 456 }
 457
 458 /* Get the first line of a small file, without any trailing newline
 459  * character.
 460  */
 461 char *
 462 guestfs___first_line_of_file (guestfs_h *g, const char *filename)
 463 {
 464   char **lines;
 465   int64_t size;
 466   char *ret;
 467
 468   /* Don't trust guestfs_head_n not to break with very large files.
 469    * Check the file size is something reasonable first.
 470    */
 471   size = guestfs_filesize (g, filename);
 472   if (size == -1)
 473     /* guestfs_filesize failed and has already set error in handle */
 474     return NULL;
 475   if (size > MAX_SMALL_FILE_SIZE) {
 476     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 477            filename, size);
 478     return NULL;
 479   }
 480
 481   lines = guestfs_head_n (g, 1, filename);
 482   if (lines == NULL)
 483     return NULL;
 484   if (lines[0] == NULL) {
 485     error (g, _("%s: file is empty"), filename);
 486     guestfs___free_string_list (lines);
 487     return NULL;
 488   }
 489   /* lines[1] should be NULL because of '1' argument above ... */
 490
 491   ret = lines[0];               /* caller frees */
 492   free (lines);                 /* free the array */
 493
 494   return ret;
 495 }
 496
 497 /* Get the first matching line (using guestfs_egrep{,i}) of a small file,
 498  * without any trailing newline character.
 499  *
 500  * Returns: 1 = returned a line (in *ret)
 501  *          0 = no match
 502  *          -1 = error
 503  */
 504 int
 505 guestfs___first_egrep_of_file (guestfs_h *g, const char *filename,
 506                                const char *eregex, int iflag, char **ret)
 507 {
 508   char **lines;
 509   int64_t size;
 510   size_t i;
 511
 512   /* Don't trust guestfs_egrep not to break with very large files.
 513    * Check the file size is something reasonable first.
 514    */
 515   size = guestfs_filesize (g, filename);
 516   if (size == -1)
 517     /* guestfs_filesize failed and has already set error in handle */
 518     return -1;
 519   if (size > MAX_SMALL_FILE_SIZE) {
 520     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 521            filename, size);
 522     return -1;
 523   }
 524
 525   lines = (!iflag ? guestfs_egrep : guestfs_egrepi) (g, eregex, filename);
 526   if (lines == NULL)
 527     return -1;
 528   if (lines[0] == NULL) {
 529     guestfs___free_string_list (lines);
 530     return 0;
 531   }
 532
 533   *ret = lines[0];              /* caller frees */
 534
 535   /* free up any other matches and the array itself */
 536   for (i = 1; lines[i] != NULL; ++i)
 537     free (lines[i]);
 538   free (lines);
 539
 540   return 1;
 541 }
 542
 543 #endif /* defined(HAVE_HIVEX) */