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   else if (is_dir_etc &&
 194            is_dir_bin &&
 195            guestfs_is_file (g, "/etc/fstab") > 0 &&
 196            guestfs_is_file (g, "/etc/release") > 0) {
 197     /* Ignore /dev/sda1 which is a shadow of the real root filesystem
 198      * that is probably /dev/sda5 (see:
 199      * http://www.freebsd.org/doc/handbook/disk-organization.html)
 200      */
 201     if (match (g, device, re_first_partition))
 202       return 0;
 203
 204     fs->is_root = 1;
 205     fs->content = FS_CONTENT_NETBSD_ROOT;
 206     fs->format = OS_FORMAT_INSTALLED;
 207     if (guestfs___check_netbsd_root (g, fs) == -1)
 208       return -1;
 209   }
 210   /* Linux root? */
 211   else if (is_dir_etc &&
 212            is_dir_bin &&
 213            guestfs_is_file (g, "/etc/fstab") > 0) {
 214     fs->is_root = 1;
 215     fs->content = FS_CONTENT_LINUX_ROOT;
 216     fs->format = OS_FORMAT_INSTALLED;
 217     if (guestfs___check_linux_root (g, fs) == -1)
 218       return -1;
 219   }
 220   /* Linux /usr/local? */
 221   else if (is_dir_etc &&
 222            is_dir_bin &&
 223            is_dir_share &&
 224            guestfs_exists (g, "/local") == 0 &&
 225            guestfs_is_file (g, "/etc/fstab") == 0)
 226     fs->content = FS_CONTENT_LINUX_USR_LOCAL;
 227   /* Linux /usr? */
 228   else if (is_dir_etc &&
 229            is_dir_bin &&
 230            is_dir_share &&
 231            guestfs_exists (g, "/local") > 0 &&
 232            guestfs_is_file (g, "/etc/fstab") == 0)
 233     fs->content = FS_CONTENT_LINUX_USR;
 234   /* Linux /var? */
 235   else if (guestfs_is_dir (g, "/log") > 0 &&
 236            guestfs_is_dir (g, "/run") > 0 &&
 237            guestfs_is_dir (g, "/spool") > 0)
 238     fs->content = FS_CONTENT_LINUX_VAR;
 239   /* Windows root? */
 240   else if (guestfs___has_windows_systemroot (g) >= 0) {
 241     fs->is_root = 1;
 242     fs->content = FS_CONTENT_WINDOWS_ROOT;
 243     fs->format = OS_FORMAT_INSTALLED;
 244     if (guestfs___check_windows_root (g, fs) == -1)
 245       return -1;
 246   }
 247   /* Windows volume with installed applications (but not root)? */
 248   else if (guestfs___is_dir_nocase (g, "/System Volume Information") > 0 &&
 249            guestfs___is_dir_nocase (g, "/Program Files") > 0)
 250     fs->content = FS_CONTENT_WINDOWS_VOLUME_WITH_APPS;
 251   /* Windows volume (but not root)? */
 252   else if (guestfs___is_dir_nocase (g, "/System Volume Information") > 0)
 253     fs->content = FS_CONTENT_WINDOWS_VOLUME;
 254   /* Install CD/disk?  Skip these checks if it's not a whole device
 255    * (eg. CD) or the first partition (eg. bootable USB key).
 256    */
 257   else if ((is_block || is_partnum == 1) &&
 258            (guestfs_is_file (g, "/isolinux/isolinux.cfg") > 0 ||
 259             guestfs_is_dir (g, "/EFI/BOOT") > 0 ||
 260             guestfs_is_file (g, "/images/install.img") > 0 ||
 261             guestfs_is_dir (g, "/.disk") > 0 ||
 262             guestfs_is_file (g, "/.discinfo") > 0 ||
 263             guestfs_is_file (g, "/i386/txtsetup.sif") > 0 ||
 264             guestfs_is_file (g, "/amd64/txtsetup.sif")) > 0) {
 265     fs->is_root = 1;
 266     fs->content = FS_CONTENT_INSTALLER;
 267     fs->format = OS_FORMAT_INSTALLER;
 268     if (guestfs___check_installer_root (g, fs) == -1)
 269       return -1;
 270   }
 271
 272   /* The above code should have set fs->type and fs->distro fields, so
 273    * we can now guess the package management system.
 274    */
 275   check_package_format (g, fs);
 276   check_package_management (g, fs);
 277
 278   return 0;
 279 }
 280
 281 static int
 282 extend_fses (guestfs_h *g)
 283 {
 284   size_t n = g->nr_fses + 1;
 285   struct inspect_fs *p;
 286
 287   p = realloc (g->fses, n * sizeof (struct inspect_fs));
 288   if (p == NULL) {
 289     perrorf (g, "realloc");
 290     return -1;
 291   }
 292
 293   g->fses = p;
 294   g->nr_fses = n;
 295
 296   memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
 297
 298   return 0;
 299 }
 300
 301 int
 302 guestfs___is_file_nocase (guestfs_h *g, const char *path)
 303 {
 304   char *p;
 305   int r;
 306
 307   p = guestfs___case_sensitive_path_silently (g, path);
 308   if (!p)
 309     return 0;
 310   r = guestfs_is_file (g, p);
 311   free (p);
 312   return r > 0;
 313 }
 314
 315 int
 316 guestfs___is_dir_nocase (guestfs_h *g, const char *path)
 317 {
 318   char *p;
 319   int r;
 320
 321   p = guestfs___case_sensitive_path_silently (g, path);
 322   if (!p)
 323     return 0;
 324   r = guestfs_is_dir (g, p);
 325   free (p);
 326   return r > 0;
 327 }
 328
 329 /* Parse small, unsigned ints, as used in version numbers. */
 330 int
 331 guestfs___parse_unsigned_int (guestfs_h *g, const char *str)
 332 {
 333   long ret;
 334   int r = xstrtol (str, NULL, 10, &ret, "");
 335   if (r != LONGINT_OK) {
 336     error (g, _("could not parse integer in version number: %s"), str);
 337     return -1;
 338   }
 339   return ret;
 340 }
 341
 342 /* Like parse_unsigned_int, but ignore trailing stuff. */
 343 int
 344 guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str)
 345 {
 346   long ret;
 347   int r = xstrtol (str, NULL, 10, &ret, NULL);
 348   if (r != LONGINT_OK) {
 349     error (g, _("could not parse integer in version number: %s"), str);
 350     return -1;
 351   }
 352   return ret;
 353 }
 354
 355 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
 356 int
 357 guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
 358 {
 359   char *major, *minor;
 360
 361   if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
 362     fs->major_version = guestfs___parse_unsigned_int (g, major);
 363     free (major);
 364     if (fs->major_version == -1) {
 365       free (minor);
 366       return -1;
 367     }
 368     fs->minor_version = guestfs___parse_unsigned_int (g, minor);
 369     free (minor);
 370     if (fs->minor_version == -1)
 371       return -1;
 372   }
 373   return 0;
 374 }
 375
 376 /* At the moment, package format and package management is just a
 377  * simple function of the distro and major_version fields, so these
 378  * can never return an error.  We might be cleverer in future.
 379  */
 380 static void
 381 check_package_format (guestfs_h *g, struct inspect_fs *fs)
 382 {
 383   switch (fs->distro) {
 384   case OS_DISTRO_FEDORA:
 385   case OS_DISTRO_MEEGO:
 386   case OS_DISTRO_REDHAT_BASED:
 387   case OS_DISTRO_RHEL:
 388   case OS_DISTRO_MAGEIA:
 389   case OS_DISTRO_MANDRIVA:
 390   case OS_DISTRO_OPENSUSE:
 391   case OS_DISTRO_CENTOS:
 392   case OS_DISTRO_SCIENTIFIC_LINUX:
 393     fs->package_format = OS_PACKAGE_FORMAT_RPM;
 394     break;
 395
 396   case OS_DISTRO_DEBIAN:
 397   case OS_DISTRO_UBUNTU:
 398   case OS_DISTRO_LINUX_MINT:
 399     fs->package_format = OS_PACKAGE_FORMAT_DEB;
 400     break;
 401
 402   case OS_DISTRO_ARCHLINUX:
 403     fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
 404     break;
 405   case OS_DISTRO_GENTOO:
 406     fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
 407     break;
 408   case OS_DISTRO_PARDUS:
 409     fs->package_format = OS_PACKAGE_FORMAT_PISI;
 410     break;
 411
 412   case OS_DISTRO_SLACKWARE:
 413   case OS_DISTRO_TTYLINUX:
 414   case OS_DISTRO_WINDOWS:
 415   case OS_DISTRO_UNKNOWN:
 416   default:
 417     fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
 418     break;
 419   }
 420 }
 421
 422 static void
 423 check_package_management (guestfs_h *g, struct inspect_fs *fs)
 424 {
 425   switch (fs->distro) {
 426   case OS_DISTRO_FEDORA:
 427   case OS_DISTRO_MEEGO:
 428     fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
 429     break;
 430
 431   case OS_DISTRO_REDHAT_BASED:
 432   case OS_DISTRO_RHEL:
 433   case OS_DISTRO_CENTOS:
 434   case OS_DISTRO_SCIENTIFIC_LINUX:
 435     if (fs->major_version >= 5)
 436       fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
 437     else
 438       fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
 439     break;
 440
 441   case OS_DISTRO_DEBIAN:
 442   case OS_DISTRO_UBUNTU:
 443   case OS_DISTRO_LINUX_MINT:
 444     fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
 445     break;
 446
 447   case OS_DISTRO_ARCHLINUX:
 448     fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
 449     break;
 450   case OS_DISTRO_GENTOO:
 451     fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
 452     break;
 453   case OS_DISTRO_PARDUS:
 454     fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
 455     break;
 456   case OS_DISTRO_MAGEIA:
 457   case OS_DISTRO_MANDRIVA:
 458     fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
 459     break;
 460
 461   case OS_DISTRO_OPENSUSE:
 462     fs->package_management = OS_PACKAGE_MANAGEMENT_ZYPPER;
 463     break;
 464
 465   case OS_DISTRO_SLACKWARE:
 466   case OS_DISTRO_TTYLINUX:
 467   case OS_DISTRO_WINDOWS:
 468   case OS_DISTRO_UNKNOWN:
 469   default:
 470     fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
 471     break;
 472   }
 473 }
 474
 475 /* Get the first line of a small file, without any trailing newline
 476  * character.
 477  */
 478 char *
 479 guestfs___first_line_of_file (guestfs_h *g, const char *filename)
 480 {
 481   char **lines;
 482   int64_t size;
 483   char *ret;
 484
 485   /* Don't trust guestfs_head_n not to break with very large files.
 486    * Check the file size is something reasonable first.
 487    */
 488   size = guestfs_filesize (g, filename);
 489   if (size == -1)
 490     /* guestfs_filesize failed and has already set error in handle */
 491     return NULL;
 492   if (size > MAX_SMALL_FILE_SIZE) {
 493     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 494            filename, size);
 495     return NULL;
 496   }
 497
 498   lines = guestfs_head_n (g, 1, filename);
 499   if (lines == NULL)
 500     return NULL;
 501   if (lines[0] == NULL) {
 502     error (g, _("%s: file is empty"), filename);
 503     guestfs___free_string_list (lines);
 504     return NULL;
 505   }
 506   /* lines[1] should be NULL because of '1' argument above ... */
 507
 508   ret = lines[0];               /* caller frees */
 509   free (lines);                 /* free the array */
 510
 511   return ret;
 512 }
 513
 514 /* Get the first matching line (using guestfs_egrep{,i}) of a small file,
 515  * without any trailing newline character.
 516  *
 517  * Returns: 1 = returned a line (in *ret)
 518  *          0 = no match
 519  *          -1 = error
 520  */
 521 int
 522 guestfs___first_egrep_of_file (guestfs_h *g, const char *filename,
 523                                const char *eregex, int iflag, char **ret)
 524 {
 525   char **lines;
 526   int64_t size;
 527   size_t i;
 528
 529   /* Don't trust guestfs_egrep not to break with very large files.
 530    * Check the file size is something reasonable first.
 531    */
 532   size = guestfs_filesize (g, filename);
 533   if (size == -1)
 534     /* guestfs_filesize failed and has already set error in handle */
 535     return -1;
 536   if (size > MAX_SMALL_FILE_SIZE) {
 537     error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
 538            filename, size);
 539     return -1;
 540   }
 541
 542   lines = (!iflag ? guestfs_egrep : guestfs_egrepi) (g, eregex, filename);
 543   if (lines == NULL)
 544     return -1;
 545   if (lines[0] == NULL) {
 546     guestfs___free_string_list (lines);
 547     return 0;
 548   }
 549
 550   *ret = lines[0];              /* caller frees */
 551
 552   /* free up any other matches and the array itself */
 553   for (i = 1; lines[i] != NULL; ++i)
 554     free (lines[i]);
 555   free (lines);
 556
 557   return 1;
 558 }
 559
 560 #endif /* defined(HAVE_HIVEX) */