src/inspect.c

   1 /* libguestfs
   2  * Copyright (C) 2010 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 <string.h>
  27 #include <sys/stat.h>
  28
  29 #include <pcre.h>
  30 #include <magic.h>
  31 #include <hivex.h>
  32 #include <augeas.h>
  33
  34 #include "c-ctype.h"
  35 #include "ignore-value.h"
  36 #include "xstrtol.h"
  37
  38 #include "guestfs.h"
  39 #include "guestfs-internal.h"
  40 #include "guestfs-internal-actions.h"
  41 #include "guestfs_protocol.h"
  42
  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
  46  * simultaneously.
  47  */
  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;
  53 static pcre *re_rhel;
  54 static pcre *re_rhel_no_minor;
  55 static pcre *re_debian;
  56 static pcre *re_aug_seq;
  57 static pcre *re_xdev;
  58 static pcre *re_windows_version;
  59
  60 static void compile_regexps (void) __attribute__((constructor));
  61 static void free_regexps (void) __attribute__((destructor));
  62
  63 static void
  64 compile_regexps (void)
  65 {
  66   const char *err;
  67   int offset;
  68
  69 #define COMPILE(re,pattern,options)                                     \
  70   do {                                                                  \
  71     re = pcre_compile ((pattern), (options), &err, &offset, NULL);      \
  72     if (re == NULL) {                                                   \
  73       ignore_value (write (2, err, strlen (err)));                      \
  74       abort ();                                                         \
  75     }                                                                   \
  76   } while (0)
  77
  78   COMPILE (re_file_elf,
  79            "ELF.*(?:executable|shared object|relocatable), (.+?),", 0);
  80   COMPILE (re_elf_ppc64, "64.*PowerPC", 0);
  81   COMPILE (re_fedora, "Fedora release (\\d+)", 0);
  82   COMPILE (re_rhel_old,
  83            "(?:Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\\d+).*Update (\\d+)", 0);
  84   COMPILE (re_rhel,
  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_debian, "(\\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);
  92 }
  93
  94 static void
  95 free_regexps (void)
  96 {
  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);
 102   pcre_free (re_rhel);
 103   pcre_free (re_rhel_no_minor);
 104   pcre_free (re_debian);
 105   pcre_free (re_aug_seq);
 106   pcre_free (re_xdev);
 107   pcre_free (re_windows_version);
 108 }
 109
 110 /* Match a regular expression which contains no captures.  Returns
 111  * true if it matches or false if it doesn't.
 112  */
 113 static int
 114 match (guestfs_h *g, const char *str, const pcre *re)
 115 {
 116   size_t len = strlen (str);
 117   int vec[30], r;
 118
 119   r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
 120   if (r == PCRE_ERROR_NOMATCH)
 121     return 0;
 122   if (r != 1) {
 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);
 126     return 0;
 127   }
 128
 129   return 1;
 130 }
 131
 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.
 135  */
 136 static char *
 137 match1 (guestfs_h *g, const char *str, const pcre *re)
 138 {
 139   size_t len = strlen (str);
 140   int vec[30], r;
 141
 142   r = pcre_exec (re, NULL, str, len, 0, 0, vec, sizeof vec / sizeof vec[0]);
 143   if (r == PCRE_ERROR_NOMATCH)
 144     return NULL;
 145   if (r != 2) {
 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);
 149     return NULL;
 150   }
 151
 152   return safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
 153 }
 154
 155 /* Match a regular expression which contains exactly two captures. */
 156 static int
 157 match2 (guestfs_h *g, const char *str, const pcre *re, char **ret1, char **ret2)
 158 {
 159   size_t len = strlen (str);
 160   int vec[30], r;
 161
 162   r = pcre_exec (re, NULL, str, len, 0, 0, vec, 30);
 163   if (r == PCRE_ERROR_NOMATCH)
 164     return 0;
 165   if (r != 3) {
 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);
 169     return 0;
 170   }
 171
 172   *ret1 = safe_strndup (g, &str[vec[2]], vec[3]-vec[2]);
 173   *ret2 = safe_strndup (g, &str[vec[4]], vec[5]-vec[4]);
 174
 175   return 1;
 176 }
 177
 178 /* Convert output from 'file' command on ELF files to the canonical
 179  * architecture string.  Caller must free the result.
 180  */
 181 static char *
 182 canonical_elf_arch (guestfs_h *g, const char *elf_arch)
 183 {
 184   const char *r;
 185
 186   if (strstr (elf_arch, "Intel 80386"))
 187     r = "i386";
 188   else if (strstr (elf_arch, "Intel 80486"))
 189     r = "i486";
 190   else if (strstr (elf_arch, "x86-64"))
 191     r = "x86_64";
 192   else if (strstr (elf_arch, "AMD x86-64"))
 193     r = "x86_64";
 194   else if (strstr (elf_arch, "SPARC32"))
 195     r = "sparc";
 196   else if (strstr (elf_arch, "SPARC V9"))
 197     r = "sparc64";
 198   else if (strstr (elf_arch, "IA-64"))
 199     r = "ia64";
 200   else if (match (g, elf_arch, re_elf_ppc64))
 201     r = "ppc64";
 202   else if (strstr (elf_arch, "PowerPC"))
 203     r = "ppc";
 204   else
 205     r = elf_arch;
 206
 207   char *ret = safe_strdup (g, r);
 208   return ret;
 209 }
 210
 211 static int
 212 is_regular_file (const char *filename)
 213 {
 214   struct stat statbuf;
 215
 216   return lstat (filename, &statbuf) == 0 && S_ISREG (statbuf.st_mode);
 217 }
 218
 219 /* Download and uncompress the cpio file to find binaries within.
 220  * Notes:
 221  * (1) Two lists must be identical.
 222  * (2) Implicit limit of 31 bytes for length of each element (see code
 223  * below).
 224  */
 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"}
 227
 228 static char *
 229 cpio_arch (guestfs_h *g, const char *file, const char *path)
 230 {
 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)
 236   char cmd[cmd_len];
 237 #define bin_len (dir_len + 32)
 238   char bin[bin_len];
 239
 240   char *ret = NULL;
 241
 242   const char *method;
 243   if (strstr (file, "gzip"))
 244     method = "zcat";
 245   else if (strstr (file, "bzip2"))
 246     method = "bzcat";
 247   else
 248     method = "cat";
 249
 250   if (mkdtemp (dir) == NULL) {
 251     perrorf (g, "mkdtemp");
 252     goto out;
 253   }
 254
 255   snprintf (initrd, initrd_len, "%s/initrd", dir);
 256   if (guestfs_download (g, path, initrd) == -1)
 257     goto out;
 258
 259   snprintf (cmd, cmd_len,
 260             "cd %s && %s initrd | cpio --quiet -id " INITRD_BINARIES1,
 261             dir, method);
 262   int r = system (cmd);
 263   if (r == -1 || WEXITSTATUS (r) != 0) {
 264     perrorf (g, "cpio command failed");
 265     goto out;
 266   }
 267
 268   const char *bins[] = INITRD_BINARIES2;
 269   size_t i;
 270   for (i = 0; i < sizeof bins / sizeof bins[0]; ++i) {
 271     snprintf (bin, bin_len, "%s/%s", dir, bins[i]);
 272
 273     if (is_regular_file (bin)) {
 274       int flags = g->verbose ? MAGIC_DEBUG : 0;
 275       flags |= MAGIC_ERROR | MAGIC_RAW;
 276
 277       magic_t m = magic_open (flags);
 278       if (m == NULL) {
 279         perrorf (g, "magic_open");
 280         goto out;
 281       }
 282
 283       if (magic_load (m, NULL) == -1) {
 284         perrorf (g, "magic_load: default magic database file");
 285         magic_close (m);
 286         goto out;
 287       }
 288
 289       const char *line = magic_file (m, bin);
 290       if (line == NULL) {
 291         perrorf (g, "magic_file: %s", bin);
 292         magic_close (m);
 293         goto out;
 294       }
 295
 296       char *elf_arch;
 297       if ((elf_arch = match1 (g, line, re_file_elf)) != NULL) {
 298         ret = canonical_elf_arch (g, elf_arch);
 299         free (elf_arch);
 300         magic_close (m);
 301         goto out;
 302       }
 303       magic_close (m);
 304     }
 305   }
 306   error (g, "file_architecture: could not determine architecture of cpio archive");
 307
 308  out:
 309   /* Free up the temporary directory.  Note the directory name cannot
 310    * contain shell meta-characters because of the way it was
 311    * constructed above.
 312    */
 313   snprintf (cmd, cmd_len, "rm -rf %s", dir);
 314   ignore_value (system (cmd));
 315
 316   return ret;
 317 #undef dir_len
 318 #undef initrd_len
 319 #undef cmd_len
 320 #undef bin_len
 321 }
 322
 323 char *
 324 guestfs__file_architecture (guestfs_h *g, const char *path)
 325 {
 326   char *file = NULL;
 327   char *elf_arch = NULL;
 328   char *ret = NULL;
 329
 330   /* Get the output of the "file" command.  Note that because this
 331    * runs in the daemon, LANG=C so it's in English.
 332    */
 333   file = guestfs_file (g, path);
 334   if (file == NULL)
 335     return NULL;
 336
 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);
 345   else
 346     error (g, "file_architecture: unknown architecture: %s", path);
 347
 348   free (file);
 349   free (elf_arch);
 350   return ret;                   /* caller frees */
 351 }
 352
 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);
 357
 358 char **
 359 guestfs__inspect_os (guestfs_h *g)
 360 {
 361   /* Remove any information previously stored in the handle. */
 362   guestfs___free_inspect_info (g);
 363
 364   if (guestfs_umount_all (g) == -1)
 365     return NULL;
 366
 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.
 370    */
 371   /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
 372   char **devices;
 373   devices = guestfs_list_devices (g);
 374   if (devices == NULL)
 375     return NULL;
 376
 377   size_t i;
 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);
 382       return NULL;
 383     }
 384   }
 385   free_string_list (devices);
 386
 387   /* Look at all partitions. */
 388   char **partitions;
 389   partitions = guestfs_list_partitions (g);
 390   if (partitions == NULL) {
 391     guestfs___free_inspect_info (g);
 392     return NULL;
 393   }
 394
 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);
 399       return NULL;
 400     }
 401   }
 402   free_string_list (partitions);
 403
 404   /* Look at all LVs. */
 405   if (feature_available (g, "lvm2")) {
 406     char **lvs;
 407     lvs = guestfs_lvs (g);
 408     if (lvs == NULL) {
 409       guestfs___free_inspect_info (g);
 410       return NULL;
 411     }
 412
 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);
 417         return NULL;
 418       }
 419     }
 420     free_string_list (lvs);
 421   }
 422
 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    */
 427   size_t count = 0;
 428   for (i = 0; i < g->nr_fses; ++i)
 429     if (g->fses[i].is_root)
 430       count++;
 431
 432   char **ret = calloc (count+1, sizeof (char *));
 433   if (ret == NULL) {
 434     perrorf (g, "calloc");
 435     guestfs___free_inspect_info (g);
 436     return NULL;
 437   }
 438
 439   count = 0;
 440   for (i = 0; i < g->nr_fses; ++i) {
 441     if (g->fses[i].is_root) {
 442       ret[count] = safe_strdup (g, g->fses[i].device);
 443       count++;
 444     }
 445   }
 446   ret[count] = NULL;
 447
 448   return ret;
 449 }
 450
 451 void
 452 guestfs___free_inspect_info (guestfs_h *g)
 453 {
 454   size_t i;
 455   for (i = 0; i < g->nr_fses; ++i) {
 456     free (g->fses[i].device);
 457     free (g->fses[i].product_name);
 458     free (g->fses[i].arch);
 459     size_t j;
 460     for (j = 0; j < g->fses[i].nr_fstab; ++j) {
 461       free (g->fses[i].fstab[j].device);
 462       free (g->fses[i].fstab[j].mountpoint);
 463     }
 464     free (g->fses[i].fstab);
 465   }
 466   free (g->fses);
 467   g->nr_fses = 0;
 468   g->fses = NULL;
 469 }
 470
 471 static void
 472 free_string_list (char **argv)
 473 {
 474   size_t i;
 475   for (i = 0; argv[i] != NULL; ++i)
 476     free (argv[i]);
 477   free (argv);
 478 }
 479
 480 /* In the Perl code this is a public function. */
 481 static int
 482 feature_available (guestfs_h *g, const char *feature)
 483 {
 484   /* If there's an error we should ignore it, so to do that we have to
 485    * temporarily replace the error handler with a null one.
 486    */
 487   guestfs_error_handler_cb old_error_cb = g->error_cb;
 488   g->error_cb = NULL;
 489
 490   const char *groups[] = { feature, NULL };
 491   int r = guestfs_available (g, (char * const *) groups);
 492
 493   g->error_cb = old_error_cb;
 494
 495   return r == 0 ? 1 : 0;
 496 }
 497
 498 /* Find out if 'device' contains a filesystem.  If it does, add
 499  * another entry in g->fses.
 500  */
 501 static int check_filesystem (guestfs_h *g, const char *device);
 502 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
 503 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
 504 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
 505 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs,
 506                                const char *systemroot);
 507 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs,
 508                                    const char *systemroot);
 509 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
 510 static int extend_fses (guestfs_h *g);
 511 static int parse_unsigned_int (guestfs_h *g, const char *str);
 512 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 513                             const char *spec, const char *mp);
 514 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
 515
 516 static int
 517 check_for_filesystem_on (guestfs_h *g, const char *device)
 518 {
 519   /* Get vfs-type in order to check if it's a Linux(?) swap device.
 520    * If there's an error we should ignore it, so to do that we have to
 521    * temporarily replace the error handler with a null one.
 522    */
 523   guestfs_error_handler_cb old_error_cb = g->error_cb;
 524   g->error_cb = NULL;
 525   char *vfs_type = guestfs_vfs_type (g, device);
 526   g->error_cb = old_error_cb;
 527
 528   int is_swap = vfs_type && STREQ (vfs_type, "swap");
 529
 530   if (g->verbose)
 531     fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
 532              device, vfs_type ? vfs_type : "failed to get vfs type");
 533
 534   if (is_swap) {
 535     free (vfs_type);
 536     if (extend_fses (g) == -1)
 537       return -1;
 538     g->fses[g->nr_fses-1].is_swap = 1;
 539     return 0;
 540   }
 541
 542   /* Try mounting the device.  As above, ignore errors. */
 543   g->error_cb = NULL;
 544   int r = guestfs_mount_ro (g, device, "/");
 545   if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
 546     r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
 547   free (vfs_type);
 548   g->error_cb = old_error_cb;
 549   if (r == -1)
 550     return 0;
 551
 552   /* Do the rest of the checks. */
 553   r = check_filesystem (g, device);
 554
 555   /* Unmount the filesystem. */
 556   if (guestfs_umount_all (g) == -1)
 557     return -1;
 558
 559   return r;
 560 }
 561
 562 static int
 563 check_filesystem (guestfs_h *g, const char *device)
 564 {
 565   if (extend_fses (g) == -1)
 566     return -1;
 567
 568   struct inspect_fs *fs = &g->fses[g->nr_fses-1];
 569
 570   fs->device = safe_strdup (g, device);
 571   fs->is_mountable = 1;
 572
 573   /* Grub /boot? */
 574   if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
 575       guestfs_is_file (g, "/grub/grub.conf") > 0)
 576     fs->content = FS_CONTENT_LINUX_BOOT;
 577   /* Linux root? */
 578   else if (guestfs_is_dir (g, "/etc") > 0 &&
 579            guestfs_is_dir (g, "/bin") > 0 &&
 580            guestfs_is_file (g, "/etc/fstab") > 0) {
 581     fs->is_root = 1;
 582     fs->content = FS_CONTENT_LINUX_ROOT;
 583     if (check_linux_root (g, fs) == -1)
 584       return -1;
 585   }
 586   /* Linux /usr/local? */
 587   else if (guestfs_is_dir (g, "/etc") > 0 &&
 588            guestfs_is_dir (g, "/bin") > 0 &&
 589            guestfs_is_dir (g, "/share") > 0 &&
 590            guestfs_exists (g, "/local") == 0 &&
 591            guestfs_is_file (g, "/etc/fstab") == 0)
 592     fs->content = FS_CONTENT_LINUX_USR_LOCAL;
 593   /* Linux /usr? */
 594   else if (guestfs_is_dir (g, "/etc") > 0 &&
 595            guestfs_is_dir (g, "/bin") > 0 &&
 596            guestfs_is_dir (g, "/share") > 0 &&
 597            guestfs_exists (g, "/local") > 0 &&
 598            guestfs_is_file (g, "/etc/fstab") == 0)
 599     fs->content = FS_CONTENT_LINUX_USR;
 600   /* Linux /var? */
 601   else if (guestfs_is_dir (g, "/log") > 0 &&
 602            guestfs_is_dir (g, "/run") > 0 &&
 603            guestfs_is_dir (g, "/spool") > 0)
 604     fs->content = FS_CONTENT_LINUX_VAR;
 605   /* Windows root? */
 606   else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
 607            guestfs_is_file (g, "/autoexec.bat") > 0 ||
 608            guestfs_is_dir (g, "/Program Files") > 0 ||
 609            guestfs_is_dir (g, "/WINDOWS") > 0 ||
 610            guestfs_is_dir (g, "/Windows") > 0 ||
 611            guestfs_is_dir (g, "/windows") > 0 ||
 612            guestfs_is_dir (g, "/WIN32") > 0 ||
 613            guestfs_is_dir (g, "/Win32") > 0 ||
 614            guestfs_is_dir (g, "/WINNT") > 0 ||
 615            guestfs_is_file (g, "/boot.ini") > 0 ||
 616            guestfs_is_file (g, "/ntldr") > 0) {
 617     fs->is_root = 1;
 618     fs->content = FS_CONTENT_WINDOWS_ROOT;
 619     if (check_windows_root (g, fs) == -1)
 620       return -1;
 621   }
 622
 623   return 0;
 624 }
 625
 626 /* The currently mounted device is known to be a Linux root.  Try to
 627  * determine from this the distro, version, etc.  Also parse
 628  * /etc/fstab to determine the arrangement of mountpoints and
 629  * associated devices.
 630  */
 631 static int
 632 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
 633 {
 634   fs->type = OS_TYPE_LINUX;
 635
 636   if (guestfs_exists (g, "/etc/redhat-release") > 0) {
 637     fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
 638
 639     char **product_name = guestfs_head_n (g, 1, "/etc/redhat-release");
 640     if (product_name == NULL)
 641       return -1;
 642     if (product_name[0] == NULL) {
 643       error (g, "/etc/redhat-release file is empty");
 644       free_string_list (product_name);
 645       return -1;
 646     }
 647
 648     /* Note that this string becomes owned by the handle and will
 649      * be freed by guestfs___free_inspect_info.
 650      */
 651     fs->product_name = product_name[0];
 652     free (product_name);
 653
 654     char *major, *minor;
 655     if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
 656       fs->distro = OS_DISTRO_FEDORA;
 657       fs->major_version = parse_unsigned_int (g, major);
 658       free (major);
 659       if (fs->major_version == -1)
 660         return -1;
 661     }
 662     else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
 663              match2 (g, fs->product_name, re_rhel, &major, &minor)) {
 664       fs->distro = OS_DISTRO_RHEL;
 665       fs->major_version = parse_unsigned_int (g, major);
 666       free (major);
 667       if (fs->major_version == -1) {
 668         free (minor);
 669         return -1;
 670       }
 671       fs->minor_version = parse_unsigned_int (g, minor);
 672       free (minor);
 673       if (fs->minor_version == -1)
 674         return -1;
 675     }
 676     else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
 677       fs->distro = OS_DISTRO_RHEL;
 678       fs->major_version = parse_unsigned_int (g, major);
 679       free (major);
 680       if (fs->major_version == -1)
 681         return -1;
 682       fs->minor_version = 0;
 683     }
 684   }
 685   else if (guestfs_exists (g, "/etc/debian_version") > 0) {
 686     fs->distro = OS_DISTRO_DEBIAN;
 687
 688     char **product_name = guestfs_head_n (g, 1, "/etc/debian_version");
 689     if (product_name == NULL)
 690       return -1;
 691     if (product_name[0] == NULL) {
 692       error (g, "/etc/debian_version file is empty");
 693       free_string_list (product_name);
 694       return -1;
 695     }
 696
 697     /* Note that this string becomes owned by the handle and will
 698      * be freed by guestfs___free_inspect_info.
 699      */
 700     fs->product_name = product_name[0];
 701     free (product_name);
 702
 703     char *major, *minor;
 704     if (match2 (g, fs->product_name, re_debian, &major, &minor)) {
 705       fs->major_version = parse_unsigned_int (g, major);
 706       free (major);
 707       if (fs->major_version == -1) {
 708         free (minor);
 709         return -1;
 710       }
 711       fs->minor_version = parse_unsigned_int (g, minor);
 712       free (minor);
 713       if (fs->minor_version == -1)
 714         return -1;
 715     }
 716   }
 717
 718   /* Determine the architecture. */
 719   const char *binaries[] =
 720     { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
 721   size_t i;
 722   for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
 723     if (guestfs_is_file (g, binaries[i]) > 0) {
 724       /* Ignore errors from file_architecture call. */
 725       guestfs_error_handler_cb old_error_cb = g->error_cb;
 726       g->error_cb = NULL;
 727       char *arch = guestfs_file_architecture (g, binaries[i]);
 728       g->error_cb = old_error_cb;
 729
 730       if (arch) {
 731         /* String will be owned by handle, freed by
 732          * guestfs___free_inspect_info.
 733          */
 734         fs->arch = arch;
 735         break;
 736       }
 737     }
 738   }
 739
 740   /* We already know /etc/fstab exists because it's part of the test
 741    * for Linux root above.  We must now parse this file to determine
 742    * which filesystems are used by the operating system and how they
 743    * are mounted.
 744    * XXX What if !feature_available (g, "augeas")?
 745    */
 746   if (guestfs_aug_init (g, "/", AUG_NO_LOAD|AUG_SAVE_NOOP) == -1)
 747     return -1;
 748
 749   /* Tell Augeas to only load /etc/fstab (thanks Raphaël Pinson). */
 750   guestfs_aug_rm (g, "/augeas/load//incl[. != \"/etc/fstab\"]");
 751   guestfs_aug_load (g);
 752
 753   int r = check_fstab (g, fs);
 754   guestfs_aug_close (g);
 755   if (r == -1)
 756     return -1;
 757
 758   return 0;
 759 }
 760
 761 static int
 762 check_fstab (guestfs_h *g, struct inspect_fs *fs)
 763 {
 764   char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
 765   if (lines == NULL)
 766     return -1;
 767
 768   if (lines[0] == NULL) {
 769     error (g, "could not parse /etc/fstab or empty file");
 770     free_string_list (lines);
 771     return -1;
 772   }
 773
 774   size_t i;
 775   char augpath[256];
 776   for (i = 0; lines[i] != NULL; ++i) {
 777     /* Ignore comments.  Only care about sequence lines which
 778      * match m{/\d+$}.
 779      */
 780     if (match (g, lines[i], re_aug_seq)) {
 781       snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
 782       char *spec = guestfs_aug_get (g, augpath);
 783       if (spec == NULL) {
 784         free_string_list (lines);
 785         return -1;
 786       }
 787
 788       snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
 789       char *mp = guestfs_aug_get (g, augpath);
 790       if (mp == NULL) {
 791         free_string_list (lines);
 792         free (spec);
 793         return -1;
 794       }
 795
 796       int r = add_fstab_entry (g, fs, spec, mp);
 797       free (spec);
 798       free (mp);
 799
 800       if (r == -1) {
 801         free_string_list (lines);
 802         return -1;
 803       }
 804     }
 805   }
 806
 807   free_string_list (lines);
 808   return 0;
 809 }
 810
 811 /* Add a filesystem and possibly a mountpoint entry for
 812  * the root filesystem 'fs'.
 813  *
 814  * 'spec' is the fstab spec field, which might be a device name or a
 815  * pseudodevice or 'UUID=...' or 'LABEL=...'.
 816  *
 817  * 'mp' is the mount point, which could also be 'swap' or 'none'.
 818  */
 819 static int
 820 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 821                  const char *spec, const char *mp)
 822 {
 823   /* Ignore certain mountpoints. */
 824   if (STRPREFIX (mp, "/dev/") ||
 825       STREQ (mp, "/dev") ||
 826       STRPREFIX (mp, "/media/") ||
 827       STRPREFIX (mp, "/proc/") ||
 828       STREQ (mp, "/proc") ||
 829       STRPREFIX (mp, "/selinux/") ||
 830       STREQ (mp, "/selinux") ||
 831       STRPREFIX (mp, "/sys/") ||
 832       STREQ (mp, "/sys"))
 833     return 0;
 834
 835   /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
 836   if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
 837       STREQ (spec, "/dev/floppy") ||
 838       STREQ (spec, "/dev/cdrom"))
 839     return 0;
 840
 841   /* Resolve UUID= and LABEL= to the actual device. */
 842   char *device = NULL;
 843   if (STRPREFIX (spec, "UUID="))
 844     device = guestfs_findfs_uuid (g, &spec[5]);
 845   else if (STRPREFIX (spec, "LABEL="))
 846     device = guestfs_findfs_label (g, &spec[6]);
 847   /* Resolve guest block device names. */
 848   else if (spec[0] == '/')
 849     device = resolve_fstab_device (g, spec);
 850   /* Also ignore pseudo-devices completely, like spec == "tmpfs".
 851    * If we haven't resolved the device successfully by this point,
 852    * we don't care, just ignore it.
 853    */
 854   if (device == NULL)
 855     return 0;
 856
 857   char *mountpoint = safe_strdup (g, mp);
 858
 859   /* Add this to the fstab entry in 'fs'.
 860    * Note these are further filtered by guestfs_inspect_get_mountpoints
 861    * and guestfs_inspect_get_filesystems.
 862    */
 863   size_t n = fs->nr_fstab + 1;
 864   struct inspect_fstab_entry *p;
 865
 866   p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
 867   if (p == NULL) {
 868     perrorf (g, "realloc");
 869     free (device);
 870     free (mountpoint);
 871     return -1;
 872   }
 873
 874   fs->fstab = p;
 875   fs->nr_fstab = n;
 876
 877   /* These are owned by the handle and freed by guestfs___free_inspect_info. */
 878   fs->fstab[n-1].device = device;
 879   fs->fstab[n-1].mountpoint = mountpoint;
 880
 881   if (g->verbose)
 882     fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
 883
 884   return 0;
 885 }
 886
 887 /* Resolve block device name to the libguestfs device name, eg.
 888  * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV.  This
 889  * assumes that disks were added in the same order as they appear to
 890  * the real VM, which is a reasonable assumption to make.  Return
 891  * anything we don't recognize unchanged.
 892  */
 893 static char *
 894 resolve_fstab_device (guestfs_h *g, const char *spec)
 895 {
 896   char *a1;
 897   char *device = NULL;
 898
 899   if (STRPREFIX (spec, "/dev/mapper/")) {
 900     /* LVM2 does some strange munging on /dev/mapper paths for VGs and
 901      * LVs which contain '-' character:
 902      *
 903      * ><fs> lvcreate LV--test VG--test 32
 904      * ><fs> debug ls /dev/mapper
 905      * VG----test-LV----test
 906      *
 907      * This makes it impossible to reverse those paths directly, so
 908      * we have implemented lvm_canonical_lv_name in the daemon.
 909      */
 910     device = guestfs_lvm_canonical_lv_name (g, spec);
 911   }
 912   else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
 913     char **devices = guestfs_list_devices (g);
 914     if (devices == NULL)
 915       return NULL;
 916
 917     size_t count;
 918     for (count = 0; devices[count] != NULL; count++)
 919       ;
 920
 921     size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
 922     if (i < count) {
 923       size_t len = strlen (devices[i]) + strlen (a1) + 16;
 924       device = safe_malloc (g, len);
 925       snprintf (device, len, "%s%s", devices[i], &a1[1]);
 926     }
 927
 928     free (a1);
 929     free_string_list (devices);
 930   }
 931   else {
 932     /* Didn't match device pattern, return original spec unchanged. */
 933     device = safe_strdup (g, spec);
 934   }
 935
 936   return device;
 937 }
 938
 939 /* XXX Handling of boot.ini in the Perl version was pretty broken.  It
 940  * essentially didn't do anything for modern Windows guests.
 941  * Therefore I've omitted all that code.
 942  */
 943 static int
 944 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
 945 {
 946   fs->type = OS_TYPE_WINDOWS;
 947   fs->distro = OS_DISTRO_WINDOWS;
 948
 949   /* Try to find Windows systemroot using some common locations. */
 950   const char *systemroots[] =
 951     { "/windows", "/winnt", "/win32", "/win" };
 952   size_t i;
 953   char *systemroot = NULL;
 954   for (i = 0;
 955        systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
 956        ++i) {
 957     systemroot = resolve_windows_path_silently (g, systemroots[i]);
 958   }
 959
 960   if (!systemroot) {
 961     error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
 962     return -1;
 963   }
 964
 965   /* XXX There is a case for exposing systemroot and many variables
 966    * from the registry through the libguestfs API.
 967    */
 968
 969   if (g->verbose)
 970     fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
 971
 972   if (check_windows_arch (g, fs, systemroot) == -1) {
 973     free (systemroot);
 974     return -1;
 975   }
 976
 977   if (check_windows_registry (g, fs, systemroot) == -1) {
 978     free (systemroot);
 979     return -1;
 980   }
 981
 982   free (systemroot);
 983   return 0;
 984 }
 985
 986 static int
 987 check_windows_arch (guestfs_h *g, struct inspect_fs *fs,
 988                     const char *systemroot)
 989 {
 990   size_t len = strlen (systemroot) + 32;
 991   char cmd_exe[len];
 992   snprintf (cmd_exe, len, "%s/system32/cmd.exe", systemroot);
 993
 994   char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
 995   if (!cmd_exe_path)
 996     return 0;
 997
 998   char *arch = guestfs_file_architecture (g, cmd_exe_path);
 999   free (cmd_exe_path);
1000
1001   if (arch)
1002     fs->arch = arch;        /* freed by guestfs___free_inspect_info */
1003
1004   return 0;
1005 }
1006
1007 /* At the moment, pull just the ProductName and version numbers from
1008  * the registry.  In future there is a case for making many more
1009  * registry fields available to callers.
1010  */
1011 static int
1012 check_windows_registry (guestfs_h *g, struct inspect_fs *fs,
1013                         const char *systemroot)
1014 {
1015   TMP_TEMPLATE_ON_STACK (dir);
1016 #define dir_len (strlen (dir))
1017 #define software_hive_len (dir_len + 16)
1018   char software_hive[software_hive_len];
1019 #define cmd_len (dir_len + 16)
1020   char cmd[cmd_len];
1021
1022   size_t len = strlen (systemroot) + 64;
1023   char software[len];
1024   snprintf (software, len, "%s/system32/config/software", systemroot);
1025
1026   char *software_path = resolve_windows_path_silently (g, software);
1027   if (!software_path)
1028     /* If the software hive doesn't exist, just accept that we cannot
1029      * find product_name etc.
1030      */
1031     return 0;
1032
1033   int ret = -1;
1034   hive_h *h = NULL;
1035   hive_value_h *values = NULL;
1036
1037   if (mkdtemp (dir) == NULL) {
1038     perrorf (g, "mkdtemp");
1039     goto out;
1040   }
1041
1042   snprintf (software_hive, software_hive_len, "%s/software", dir);
1043
1044   if (guestfs_download (g, software_path, software_hive) == -1)
1045     goto out;
1046
1047   h = hivex_open (software_hive, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1048   if (h == NULL) {
1049     perrorf (g, "hivex_open");
1050     goto out;
1051   }
1052
1053   hive_node_h node = hivex_root (h);
1054   const char *hivepath[] =
1055     { "Microsoft", "Windows NT", "CurrentVersion" };
1056   size_t i;
1057   for (i = 0;
1058        node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1059        ++i) {
1060     node = hivex_node_get_child (h, node, hivepath[i]);
1061   }
1062
1063   if (node == 0) {
1064     perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1065     goto out;
1066   }
1067
1068   values = hivex_node_values (h, node);
1069
1070   for (i = 0; values[i] != 0; ++i) {
1071     char *key = hivex_value_key (h, values[i]);
1072     if (key == NULL) {
1073       perrorf (g, "hivex_value_key");
1074       goto out;
1075     }
1076
1077     if (STRCASEEQ (key, "ProductName")) {
1078       fs->product_name = hivex_value_string (h, values[i]);
1079       if (!fs->product_name) {
1080         perrorf (g, "hivex_value_string");
1081         free (key);
1082         goto out;
1083       }
1084     }
1085     else if (STRCASEEQ (key, "CurrentVersion")) {
1086       char *version = hivex_value_string (h, values[i]);
1087       if (!version) {
1088         perrorf (g, "hivex_value_string");
1089         free (key);
1090         goto out;
1091       }
1092       char *major, *minor;
1093       if (match2 (g, version, re_windows_version, &major, &minor)) {
1094         fs->major_version = parse_unsigned_int (g, major);
1095         free (major);
1096         if (fs->major_version == -1) {
1097           free (minor);
1098           free (key);
1099           free (version);
1100           goto out;
1101         }
1102         fs->minor_version = parse_unsigned_int (g, minor);
1103         free (minor);
1104         if (fs->minor_version == -1) {
1105           free (key);
1106           free (version);
1107           return -1;
1108         }
1109       }
1110
1111       free (version);
1112     }
1113
1114     free (key);
1115   }
1116
1117   ret = 0;
1118
1119  out:
1120   if (h) hivex_close (h);
1121   free (values);
1122   free (software_path);
1123
1124   /* Free up the temporary directory.  Note the directory name cannot
1125    * contain shell meta-characters because of the way it was
1126    * constructed above.
1127    */
1128   snprintf (cmd, cmd_len, "rm -rf %s", dir);
1129   ignore_value (system (cmd));
1130 #undef dir_len
1131 #undef software_hive_len
1132 #undef cmd_len
1133
1134   return ret;
1135 }
1136
1137 static char *
1138 resolve_windows_path_silently (guestfs_h *g, const char *path)
1139 {
1140   guestfs_error_handler_cb old_error_cb = g->error_cb;
1141   g->error_cb = NULL;
1142   char *ret = guestfs_case_sensitive_path (g, path);
1143   g->error_cb = old_error_cb;
1144   return ret;
1145 }
1146
1147 static int
1148 extend_fses (guestfs_h *g)
1149 {
1150   size_t n = g->nr_fses + 1;
1151   struct inspect_fs *p;
1152
1153   p = realloc (g->fses, n * sizeof (struct inspect_fs));
1154   if (p == NULL) {
1155     perrorf (g, "realloc");
1156     return -1;
1157   }
1158
1159   g->fses = p;
1160   g->nr_fses = n;
1161
1162   memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1163
1164   return 0;
1165 }
1166
1167 /* Parse small, unsigned ints, as used in version numbers. */
1168 static int
1169 parse_unsigned_int (guestfs_h *g, const char *str)
1170 {
1171   long ret;
1172   int r = xstrtol (str, NULL, 10, &ret, "");
1173   if (r != LONGINT_OK) {
1174     error (g, "could not parse integer in version number: %s", str);
1175     return -1;
1176   }
1177   return ret;
1178 }
1179
1180 static struct inspect_fs *
1181 search_for_root (guestfs_h *g, const char *root)
1182 {
1183   if (g->nr_fses == 0) {
1184     error (g, _("no inspection data: call guestfs_inspect_os first"));
1185     return NULL;
1186   }
1187
1188   size_t i;
1189   struct inspect_fs *fs;
1190   for (i = 0; i < g->nr_fses; ++i) {
1191     fs = &g->fses[i];
1192     if (fs->is_root && STREQ (root, fs->device))
1193       return fs;
1194   }
1195
1196   error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1197          root);
1198   return NULL;
1199 }
1200
1201 char *
1202 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1203 {
1204   struct inspect_fs *fs = search_for_root (g, root);
1205   if (!fs)
1206     return NULL;
1207
1208   char *ret;
1209   switch (fs->type) {
1210   case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1211   case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1212   case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1213   }
1214
1215   return ret;
1216 }
1217
1218 char *
1219 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1220 {
1221   struct inspect_fs *fs = search_for_root (g, root);
1222   if (!fs)
1223     return NULL;
1224
1225   return safe_strdup (g, fs->arch ? : "unknown");
1226 }
1227
1228 char *
1229 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1230 {
1231   struct inspect_fs *fs = search_for_root (g, root);
1232   if (!fs)
1233     return NULL;
1234
1235   char *ret;
1236   switch (fs->distro) {
1237   case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1238   case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1239   case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1240   case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1241   case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1242   case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1243   }
1244
1245   return ret;
1246 }
1247
1248 int
1249 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1250 {
1251   struct inspect_fs *fs = search_for_root (g, root);
1252   if (!fs)
1253     return -1;
1254
1255   return fs->major_version;
1256 }
1257
1258 int
1259 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1260 {
1261   struct inspect_fs *fs = search_for_root (g, root);
1262   if (!fs)
1263     return -1;
1264
1265   return fs->minor_version;
1266 }
1267
1268 char *
1269 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1270 {
1271   struct inspect_fs *fs = search_for_root (g, root);
1272   if (!fs)
1273     return NULL;
1274
1275   return safe_strdup (g, fs->product_name ? : "unknown");
1276 }
1277
1278 char **
1279 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1280 {
1281   struct inspect_fs *fs = search_for_root (g, root);
1282   if (!fs)
1283     return NULL;
1284
1285   char **ret;
1286
1287   /* If no fstab information (Windows) return just the root. */
1288   if (fs->nr_fstab == 0) {
1289     ret = calloc (3, sizeof (char *));
1290     ret[0] = safe_strdup (g, "/");
1291     ret[1] = safe_strdup (g, root);
1292     ret[2] = NULL;
1293     return ret;
1294   }
1295
1296 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1297   size_t i, count = 0;
1298   for (i = 0; i < fs->nr_fstab; ++i)
1299     if (CRITERION)
1300       count++;
1301
1302   /* Hashtables have 2N+1 entries. */
1303   ret = calloc (2*count+1, sizeof (char *));
1304   if (ret == NULL) {
1305     perrorf (g, "calloc");
1306     return NULL;
1307   }
1308
1309   count = 0;
1310   for (i = 0; i < fs->nr_fstab; ++i)
1311     if (CRITERION) {
1312       ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1313       ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1314       count++;
1315     }
1316 #undef CRITERION
1317
1318   return ret;
1319 }
1320
1321 char **
1322 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1323 {
1324   struct inspect_fs *fs = search_for_root (g, root);
1325   if (!fs)
1326     return NULL;
1327
1328   char **ret;
1329
1330   /* If no fstab information (Windows) return just the root. */
1331   if (fs->nr_fstab == 0) {
1332     ret = calloc (2, sizeof (char *));
1333     ret[0] = safe_strdup (g, root);
1334     ret[1] = NULL;
1335     return ret;
1336   }
1337
1338   ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1339   if (ret == NULL) {
1340     perrorf (g, "calloc");
1341     return NULL;
1342   }
1343
1344   size_t i;
1345   for (i = 0; i < fs->nr_fstab; ++i)
1346     ret[i] = safe_strdup (g, fs->fstab[i].device);
1347
1348   return ret;
1349 }
1350
1351 /* List filesystems.
1352  *
1353  * The current implementation just uses guestfs_vfs_type and doesn't
1354  * try mounting anything, but we reserve the right in future to try
1355  * mounting filesystems.
1356  */
1357
1358 static void remove_from_list (char **list, const char *item);
1359 static void check_with_vfs_type (guestfs_h *g, const char *dev, char ***ret, size_t *ret_size);
1360
1361 char **
1362 guestfs__list_filesystems (guestfs_h *g)
1363 {
1364   size_t i;
1365   char **ret;
1366   size_t ret_size;
1367
1368   ret = safe_malloc (g, sizeof (char *));
1369   ret[0] = NULL;
1370   ret_size = 0;
1371
1372   /* Look to see if any devices directly contain filesystems
1373    * (RHBZ#590167).  However vfs-type will fail to tell us anything
1374    * useful about devices which just contain partitions, so we also
1375    * get the list of partitions and exclude the corresponding devices
1376    * by using part-to-dev.
1377    */
1378   char **devices;
1379   devices = guestfs_list_devices (g);
1380   if (devices == NULL) {
1381     free_string_list (ret);
1382     return NULL;
1383   }
1384   char **partitions;
1385   partitions = guestfs_list_partitions (g);
1386   if (partitions == NULL) {
1387     free_string_list (devices);
1388     free_string_list (ret);
1389     return NULL;
1390   }
1391
1392   for (i = 0; partitions[i] != NULL; ++i) {
1393     char *dev = guestfs_part_to_dev (g, partitions[i]);
1394     if (dev)
1395       remove_from_list (devices, dev);
1396     free (dev);
1397   }
1398
1399   /* Use vfs-type to check for filesystems on devices. */
1400   for (i = 0; devices[i] != NULL; ++i)
1401     check_with_vfs_type (g, devices[i], &ret, &ret_size);
1402   free_string_list (devices);
1403
1404   /* Use vfs-type to check for filesystems on partitions. */
1405   for (i = 0; partitions[i] != NULL; ++i)
1406     check_with_vfs_type (g, partitions[i], &ret, &ret_size);
1407   free_string_list (partitions);
1408
1409   if (feature_available (g, "lvm2")) {
1410     /* Use vfs-type to check for filesystems on LVs. */
1411     char **lvs;
1412     lvs = guestfs_lvs (g);
1413     if (lvs == NULL) {
1414       free_string_list (ret);
1415       return NULL;
1416     }
1417
1418     for (i = 0; lvs[i] != NULL; ++i)
1419       check_with_vfs_type (g, lvs[i], &ret, &ret_size);
1420     free_string_list (lvs);
1421   }
1422
1423   return ret;
1424 }
1425
1426 /* If 'item' occurs in 'list', remove and free it. */
1427 static void
1428 remove_from_list (char **list, const char *item)
1429 {
1430   size_t i;
1431
1432   for (i = 0; list[i] != NULL; ++i)
1433     if (STREQ (list[i], item)) {
1434       free (list[i]);
1435       for (; list[i+1] != NULL; ++i)
1436         list[i] = list[i+1];
1437       list[i] = NULL;
1438       return;
1439     }
1440 }
1441
1442 /* Use vfs-type to look for a filesystem of some sort on 'dev'.
1443  * Apart from some types which we ignore, add the result to the
1444  * 'ret' string list.
1445  */
1446 static void
1447 check_with_vfs_type (guestfs_h *g, const char *device,
1448                      char ***ret, size_t *ret_size)
1449 {
1450   char *v;
1451
1452   guestfs_error_handler_cb old_error_cb = g->error_cb;
1453   g->error_cb = NULL;
1454   char *vfs_type = guestfs_vfs_type (g, device);
1455   g->error_cb = old_error_cb;
1456
1457   if (!vfs_type)
1458     v = safe_strdup (g, "unknown");
1459   else {
1460     /* Ignore all "*_member" strings.  In libblkid these are returned
1461      * for things which are members of some RAID or LVM set, most
1462      * importantly "LVM2_member" which is a PV.
1463      */
1464     size_t n = strlen (vfs_type);
1465     if (n >= 7 && STREQ (&vfs_type[n-7], "_member")) {
1466       free (vfs_type);
1467       return;
1468     }
1469
1470     /* Ignore LUKS-encrypted partitions.  These are also containers. */
1471     if (STREQ (vfs_type, "crypto_LUKS")) {
1472       free (vfs_type);
1473       return;
1474     }
1475
1476     v = vfs_type;
1477   }
1478
1479   /* Extend the return array. */
1480   size_t i = *ret_size;
1481   *ret_size += 2;
1482   *ret = safe_realloc (g, *ret, (*ret_size + 1) * sizeof (char *));
1483   (*ret)[i] = safe_strdup (g, device);
1484   (*ret)[i+1] = v;
1485   (*ret)[i+2] = NULL;
1486 }