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_major_minor;
  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_major_minor, "(\\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_major_minor);
 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     free (g->fses[i].windows_systemroot);
 460     size_t j;
 461     for (j = 0; j < g->fses[i].nr_fstab; ++j) {
 462       free (g->fses[i].fstab[j].device);
 463       free (g->fses[i].fstab[j].mountpoint);
 464     }
 465     free (g->fses[i].fstab);
 466   }
 467   free (g->fses);
 468   g->nr_fses = 0;
 469   g->fses = NULL;
 470 }
 471
 472 static void
 473 free_string_list (char **argv)
 474 {
 475   size_t i;
 476   for (i = 0; argv[i] != NULL; ++i)
 477     free (argv[i]);
 478   free (argv);
 479 }
 480
 481 /* In the Perl code this is a public function. */
 482 static int
 483 feature_available (guestfs_h *g, const char *feature)
 484 {
 485   /* If there's an error we should ignore it, so to do that we have to
 486    * temporarily replace the error handler with a null one.
 487    */
 488   guestfs_error_handler_cb old_error_cb = g->error_cb;
 489   g->error_cb = NULL;
 490
 491   const char *groups[] = { feature, NULL };
 492   int r = guestfs_available (g, (char * const *) groups);
 493
 494   g->error_cb = old_error_cb;
 495
 496   return r == 0 ? 1 : 0;
 497 }
 498
 499 /* Find out if 'device' contains a filesystem.  If it does, add
 500  * another entry in g->fses.
 501  */
 502 static int check_filesystem (guestfs_h *g, const char *device);
 503 static int check_linux_root (guestfs_h *g, struct inspect_fs *fs);
 504 static int check_fstab (guestfs_h *g, struct inspect_fs *fs);
 505 static int check_windows_root (guestfs_h *g, struct inspect_fs *fs);
 506 static int check_windows_arch (guestfs_h *g, struct inspect_fs *fs);
 507 static int check_windows_registry (guestfs_h *g, struct inspect_fs *fs);
 508 static char *resolve_windows_path_silently (guestfs_h *g, const char *);
 509 static int extend_fses (guestfs_h *g);
 510 static int parse_unsigned_int (guestfs_h *g, const char *str);
 511 static int add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 512                             const char *spec, const char *mp);
 513 static char *resolve_fstab_device (guestfs_h *g, const char *spec);
 514
 515 static int
 516 check_for_filesystem_on (guestfs_h *g, const char *device)
 517 {
 518   /* Get vfs-type in order to check if it's a Linux(?) swap device.
 519    * If there's an error we should ignore it, so to do that we have to
 520    * temporarily replace the error handler with a null one.
 521    */
 522   guestfs_error_handler_cb old_error_cb = g->error_cb;
 523   g->error_cb = NULL;
 524   char *vfs_type = guestfs_vfs_type (g, device);
 525   g->error_cb = old_error_cb;
 526
 527   int is_swap = vfs_type && STREQ (vfs_type, "swap");
 528
 529   if (g->verbose)
 530     fprintf (stderr, "check_for_filesystem_on: %s (%s)\n",
 531              device, vfs_type ? vfs_type : "failed to get vfs type");
 532
 533   if (is_swap) {
 534     free (vfs_type);
 535     if (extend_fses (g) == -1)
 536       return -1;
 537     g->fses[g->nr_fses-1].is_swap = 1;
 538     return 0;
 539   }
 540
 541   /* Try mounting the device.  As above, ignore errors. */
 542   g->error_cb = NULL;
 543   int r = guestfs_mount_ro (g, device, "/");
 544   if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
 545     r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
 546   free (vfs_type);
 547   g->error_cb = old_error_cb;
 548   if (r == -1)
 549     return 0;
 550
 551   /* Do the rest of the checks. */
 552   r = check_filesystem (g, device);
 553
 554   /* Unmount the filesystem. */
 555   if (guestfs_umount_all (g) == -1)
 556     return -1;
 557
 558   return r;
 559 }
 560
 561 static int
 562 check_filesystem (guestfs_h *g, const char *device)
 563 {
 564   if (extend_fses (g) == -1)
 565     return -1;
 566
 567   struct inspect_fs *fs = &g->fses[g->nr_fses-1];
 568
 569   fs->device = safe_strdup (g, device);
 570   fs->is_mountable = 1;
 571
 572   /* Grub /boot? */
 573   if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
 574       guestfs_is_file (g, "/grub/grub.conf") > 0)
 575     fs->content = FS_CONTENT_LINUX_BOOT;
 576   /* Linux root? */
 577   else if (guestfs_is_dir (g, "/etc") > 0 &&
 578            guestfs_is_dir (g, "/bin") > 0 &&
 579            guestfs_is_file (g, "/etc/fstab") > 0) {
 580     fs->is_root = 1;
 581     fs->content = FS_CONTENT_LINUX_ROOT;
 582     if (check_linux_root (g, fs) == -1)
 583       return -1;
 584   }
 585   /* Linux /usr/local? */
 586   else if (guestfs_is_dir (g, "/etc") > 0 &&
 587            guestfs_is_dir (g, "/bin") > 0 &&
 588            guestfs_is_dir (g, "/share") > 0 &&
 589            guestfs_exists (g, "/local") == 0 &&
 590            guestfs_is_file (g, "/etc/fstab") == 0)
 591     fs->content = FS_CONTENT_LINUX_USR_LOCAL;
 592   /* Linux /usr? */
 593   else if (guestfs_is_dir (g, "/etc") > 0 &&
 594            guestfs_is_dir (g, "/bin") > 0 &&
 595            guestfs_is_dir (g, "/share") > 0 &&
 596            guestfs_exists (g, "/local") > 0 &&
 597            guestfs_is_file (g, "/etc/fstab") == 0)
 598     fs->content = FS_CONTENT_LINUX_USR;
 599   /* Linux /var? */
 600   else if (guestfs_is_dir (g, "/log") > 0 &&
 601            guestfs_is_dir (g, "/run") > 0 &&
 602            guestfs_is_dir (g, "/spool") > 0)
 603     fs->content = FS_CONTENT_LINUX_VAR;
 604   /* Windows root? */
 605   else if (guestfs_is_file (g, "/AUTOEXEC.BAT") > 0 ||
 606            guestfs_is_file (g, "/autoexec.bat") > 0 ||
 607            guestfs_is_dir (g, "/Program Files") > 0 ||
 608            guestfs_is_dir (g, "/WINDOWS") > 0 ||
 609            guestfs_is_dir (g, "/Windows") > 0 ||
 610            guestfs_is_dir (g, "/windows") > 0 ||
 611            guestfs_is_dir (g, "/WIN32") > 0 ||
 612            guestfs_is_dir (g, "/Win32") > 0 ||
 613            guestfs_is_dir (g, "/WINNT") > 0 ||
 614            guestfs_is_file (g, "/boot.ini") > 0 ||
 615            guestfs_is_file (g, "/ntldr") > 0) {
 616     fs->is_root = 1;
 617     fs->content = FS_CONTENT_WINDOWS_ROOT;
 618     if (check_windows_root (g, fs) == -1)
 619       return -1;
 620   }
 621
 622   return 0;
 623 }
 624
 625 /* Set fs->product_name to the first line of the release file. */
 626 static int
 627 parse_release_file (guestfs_h *g, struct inspect_fs *fs,
 628                     const char *release_filename)
 629 {
 630   char **product_name = guestfs_head_n (g, 1, release_filename);
 631   if (product_name == NULL)
 632     return -1;
 633   if (product_name[0] == NULL) {
 634     error (g, "%s: file is empty", release_filename);
 635     free_string_list (product_name);
 636     return -1;
 637   }
 638
 639   /* Note that this string becomes owned by the handle and will
 640    * be freed by guestfs___free_inspect_info.
 641    */
 642   fs->product_name = product_name[0];
 643   free (product_name);
 644
 645   return 0;
 646 }
 647
 648 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
 649 static int
 650 parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
 651 {
 652   char *major, *minor;
 653
 654   if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
 655     fs->major_version = parse_unsigned_int (g, major);
 656     free (major);
 657     if (fs->major_version == -1) {
 658       free (minor);
 659       return -1;
 660     }
 661     fs->minor_version = parse_unsigned_int (g, minor);
 662     free (minor);
 663     if (fs->minor_version == -1)
 664       return -1;
 665   }
 666   return 0;
 667 }
 668
 669 /* The currently mounted device is known to be a Linux root.  Try to
 670  * determine from this the distro, version, etc.  Also parse
 671  * /etc/fstab to determine the arrangement of mountpoints and
 672  * associated devices.
 673  */
 674 static int
 675 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
 676 {
 677   fs->type = OS_TYPE_LINUX;
 678
 679   if (guestfs_exists (g, "/etc/redhat-release") > 0) {
 680     fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
 681
 682     if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
 683       return -1;
 684
 685     char *major, *minor;
 686     if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
 687       fs->distro = OS_DISTRO_FEDORA;
 688       fs->major_version = parse_unsigned_int (g, major);
 689       free (major);
 690       if (fs->major_version == -1)
 691         return -1;
 692     }
 693     else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
 694              match2 (g, fs->product_name, re_rhel, &major, &minor)) {
 695       fs->distro = OS_DISTRO_RHEL;
 696       fs->major_version = parse_unsigned_int (g, major);
 697       free (major);
 698       if (fs->major_version == -1) {
 699         free (minor);
 700         return -1;
 701       }
 702       fs->minor_version = parse_unsigned_int (g, minor);
 703       free (minor);
 704       if (fs->minor_version == -1)
 705         return -1;
 706     }
 707     else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
 708       fs->distro = OS_DISTRO_RHEL;
 709       fs->major_version = parse_unsigned_int (g, major);
 710       free (major);
 711       if (fs->major_version == -1)
 712         return -1;
 713       fs->minor_version = 0;
 714     }
 715   }
 716   else if (guestfs_exists (g, "/etc/debian_version") > 0) {
 717     fs->distro = OS_DISTRO_DEBIAN;
 718
 719     if (parse_release_file (g, fs, "/etc/debian_version") == -1)
 720       return -1;
 721
 722     if (parse_major_minor (g, fs) == -1)
 723       return -1;
 724   }
 725   else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
 726     fs->distro = OS_DISTRO_PARDUS;
 727
 728     if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
 729       return -1;
 730
 731     if (parse_major_minor (g, fs) == -1)
 732       return -1;
 733   }
 734   else if (guestfs_exists (g, "/etc/arch-release") > 0) {
 735     fs->distro = OS_DISTRO_ARCHLINUX;
 736
 737     /* /etc/arch-release file is empty and I can't see a way to
 738      * determine the actual release or product string.
 739      */
 740   }
 741
 742   /* Determine the architecture. */
 743   const char *binaries[] =
 744     { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
 745   size_t i;
 746   for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
 747     if (guestfs_is_file (g, binaries[i]) > 0) {
 748       /* Ignore errors from file_architecture call. */
 749       guestfs_error_handler_cb old_error_cb = g->error_cb;
 750       g->error_cb = NULL;
 751       char *arch = guestfs_file_architecture (g, binaries[i]);
 752       g->error_cb = old_error_cb;
 753
 754       if (arch) {
 755         /* String will be owned by handle, freed by
 756          * guestfs___free_inspect_info.
 757          */
 758         fs->arch = arch;
 759         break;
 760       }
 761     }
 762   }
 763
 764   /* We already know /etc/fstab exists because it's part of the test
 765    * for Linux root above.  We must now parse this file to determine
 766    * which filesystems are used by the operating system and how they
 767    * are mounted.
 768    * XXX What if !feature_available (g, "augeas")?
 769    */
 770   if (guestfs_aug_init (g, "/", AUG_NO_LOAD|AUG_SAVE_NOOP) == -1)
 771     return -1;
 772
 773   /* Tell Augeas to only load /etc/fstab (thanks Raphaël Pinson). */
 774   guestfs_aug_rm (g, "/augeas/load//incl[. != \"/etc/fstab\"]");
 775   guestfs_aug_load (g);
 776
 777   int r = check_fstab (g, fs);
 778   guestfs_aug_close (g);
 779   if (r == -1)
 780     return -1;
 781
 782   return 0;
 783 }
 784
 785 static int
 786 check_fstab (guestfs_h *g, struct inspect_fs *fs)
 787 {
 788   char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
 789   if (lines == NULL)
 790     return -1;
 791
 792   if (lines[0] == NULL) {
 793     error (g, "could not parse /etc/fstab or empty file");
 794     free_string_list (lines);
 795     return -1;
 796   }
 797
 798   size_t i;
 799   char augpath[256];
 800   for (i = 0; lines[i] != NULL; ++i) {
 801     /* Ignore comments.  Only care about sequence lines which
 802      * match m{/\d+$}.
 803      */
 804     if (match (g, lines[i], re_aug_seq)) {
 805       snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
 806       char *spec = guestfs_aug_get (g, augpath);
 807       if (spec == NULL) {
 808         free_string_list (lines);
 809         return -1;
 810       }
 811
 812       snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
 813       char *mp = guestfs_aug_get (g, augpath);
 814       if (mp == NULL) {
 815         free_string_list (lines);
 816         free (spec);
 817         return -1;
 818       }
 819
 820       int r = add_fstab_entry (g, fs, spec, mp);
 821       free (spec);
 822       free (mp);
 823
 824       if (r == -1) {
 825         free_string_list (lines);
 826         return -1;
 827       }
 828     }
 829   }
 830
 831   free_string_list (lines);
 832   return 0;
 833 }
 834
 835 /* Add a filesystem and possibly a mountpoint entry for
 836  * the root filesystem 'fs'.
 837  *
 838  * 'spec' is the fstab spec field, which might be a device name or a
 839  * pseudodevice or 'UUID=...' or 'LABEL=...'.
 840  *
 841  * 'mp' is the mount point, which could also be 'swap' or 'none'.
 842  */
 843 static int
 844 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 845                  const char *spec, const char *mp)
 846 {
 847   /* Ignore certain mountpoints. */
 848   if (STRPREFIX (mp, "/dev/") ||
 849       STREQ (mp, "/dev") ||
 850       STRPREFIX (mp, "/media/") ||
 851       STRPREFIX (mp, "/proc/") ||
 852       STREQ (mp, "/proc") ||
 853       STRPREFIX (mp, "/selinux/") ||
 854       STREQ (mp, "/selinux") ||
 855       STRPREFIX (mp, "/sys/") ||
 856       STREQ (mp, "/sys"))
 857     return 0;
 858
 859   /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
 860   if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
 861       STREQ (spec, "/dev/floppy") ||
 862       STREQ (spec, "/dev/cdrom"))
 863     return 0;
 864
 865   /* Resolve UUID= and LABEL= to the actual device. */
 866   char *device = NULL;
 867   if (STRPREFIX (spec, "UUID="))
 868     device = guestfs_findfs_uuid (g, &spec[5]);
 869   else if (STRPREFIX (spec, "LABEL="))
 870     device = guestfs_findfs_label (g, &spec[6]);
 871   /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
 872   else if (STRPREFIX (spec, "/dev/"))
 873     /* Resolve guest block device names. */
 874     device = resolve_fstab_device (g, spec);
 875
 876   /* If we haven't resolved the device successfully by this point,
 877    * we don't care, just ignore it.
 878    */
 879   if (device == NULL)
 880     return 0;
 881
 882   char *mountpoint = safe_strdup (g, mp);
 883
 884   /* Add this to the fstab entry in 'fs'.
 885    * Note these are further filtered by guestfs_inspect_get_mountpoints
 886    * and guestfs_inspect_get_filesystems.
 887    */
 888   size_t n = fs->nr_fstab + 1;
 889   struct inspect_fstab_entry *p;
 890
 891   p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
 892   if (p == NULL) {
 893     perrorf (g, "realloc");
 894     free (device);
 895     free (mountpoint);
 896     return -1;
 897   }
 898
 899   fs->fstab = p;
 900   fs->nr_fstab = n;
 901
 902   /* These are owned by the handle and freed by guestfs___free_inspect_info. */
 903   fs->fstab[n-1].device = device;
 904   fs->fstab[n-1].mountpoint = mountpoint;
 905
 906   if (g->verbose)
 907     fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
 908
 909   return 0;
 910 }
 911
 912 /* Resolve block device name to the libguestfs device name, eg.
 913  * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV.  This
 914  * assumes that disks were added in the same order as they appear to
 915  * the real VM, which is a reasonable assumption to make.  Return
 916  * anything we don't recognize unchanged.
 917  */
 918 static char *
 919 resolve_fstab_device (guestfs_h *g, const char *spec)
 920 {
 921   char *a1;
 922   char *device = NULL;
 923
 924   if (STRPREFIX (spec, "/dev/mapper/")) {
 925     /* LVM2 does some strange munging on /dev/mapper paths for VGs and
 926      * LVs which contain '-' character:
 927      *
 928      * ><fs> lvcreate LV--test VG--test 32
 929      * ><fs> debug ls /dev/mapper
 930      * VG----test-LV----test
 931      *
 932      * This makes it impossible to reverse those paths directly, so
 933      * we have implemented lvm_canonical_lv_name in the daemon.
 934      */
 935     device = guestfs_lvm_canonical_lv_name (g, spec);
 936   }
 937   else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
 938     char **devices = guestfs_list_devices (g);
 939     if (devices == NULL)
 940       return NULL;
 941
 942     size_t count;
 943     for (count = 0; devices[count] != NULL; count++)
 944       ;
 945
 946     size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
 947     if (i < count) {
 948       size_t len = strlen (devices[i]) + strlen (a1) + 16;
 949       device = safe_malloc (g, len);
 950       snprintf (device, len, "%s%s", devices[i], &a1[1]);
 951     }
 952
 953     free (a1);
 954     free_string_list (devices);
 955   }
 956   else {
 957     /* Didn't match device pattern, return original spec unchanged. */
 958     device = safe_strdup (g, spec);
 959   }
 960
 961   return device;
 962 }
 963
 964 /* XXX Handling of boot.ini in the Perl version was pretty broken.  It
 965  * essentially didn't do anything for modern Windows guests.
 966  * Therefore I've omitted all that code.
 967  */
 968 static int
 969 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
 970 {
 971   fs->type = OS_TYPE_WINDOWS;
 972   fs->distro = OS_DISTRO_WINDOWS;
 973
 974   /* Try to find Windows systemroot using some common locations. */
 975   const char *systemroots[] =
 976     { "/windows", "/winnt", "/win32", "/win" };
 977   size_t i;
 978   char *systemroot = NULL;
 979   for (i = 0;
 980        systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
 981        ++i) {
 982     systemroot = resolve_windows_path_silently (g, systemroots[i]);
 983   }
 984
 985   if (!systemroot) {
 986     error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
 987     return -1;
 988   }
 989
 990   if (g->verbose)
 991     fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
 992
 993   /* Freed by guestfs___free_inspect_info. */
 994   fs->windows_systemroot = systemroot;
 995
 996   if (check_windows_arch (g, fs) == -1)
 997     return -1;
 998
 999   if (check_windows_registry (g, fs) == -1)
1000     return -1;
1001
1002   return 0;
1003 }
1004
1005 static int
1006 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1007 {
1008   size_t len = strlen (fs->windows_systemroot) + 32;
1009   char cmd_exe[len];
1010   snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1011
1012   char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
1013   if (!cmd_exe_path)
1014     return 0;
1015
1016   char *arch = guestfs_file_architecture (g, cmd_exe_path);
1017   free (cmd_exe_path);
1018
1019   if (arch)
1020     fs->arch = arch;        /* freed by guestfs___free_inspect_info */
1021
1022   return 0;
1023 }
1024
1025 /* At the moment, pull just the ProductName and version numbers from
1026  * the registry.  In future there is a case for making many more
1027  * registry fields available to callers.
1028  */
1029 static int
1030 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
1031 {
1032   TMP_TEMPLATE_ON_STACK (dir);
1033 #define dir_len (strlen (dir))
1034 #define software_hive_len (dir_len + 16)
1035   char software_hive[software_hive_len];
1036 #define cmd_len (dir_len + 16)
1037   char cmd[cmd_len];
1038
1039   size_t len = strlen (fs->windows_systemroot) + 64;
1040   char software[len];
1041   snprintf (software, len, "%s/system32/config/software",
1042             fs->windows_systemroot);
1043
1044   char *software_path = resolve_windows_path_silently (g, software);
1045   if (!software_path)
1046     /* If the software hive doesn't exist, just accept that we cannot
1047      * find product_name etc.
1048      */
1049     return 0;
1050
1051   int ret = -1;
1052   hive_h *h = NULL;
1053   hive_value_h *values = NULL;
1054
1055   if (mkdtemp (dir) == NULL) {
1056     perrorf (g, "mkdtemp");
1057     goto out;
1058   }
1059
1060   snprintf (software_hive, software_hive_len, "%s/software", dir);
1061
1062   if (guestfs_download (g, software_path, software_hive) == -1)
1063     goto out;
1064
1065   h = hivex_open (software_hive, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1066   if (h == NULL) {
1067     perrorf (g, "hivex_open");
1068     goto out;
1069   }
1070
1071   hive_node_h node = hivex_root (h);
1072   const char *hivepath[] =
1073     { "Microsoft", "Windows NT", "CurrentVersion" };
1074   size_t i;
1075   for (i = 0;
1076        node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1077        ++i) {
1078     node = hivex_node_get_child (h, node, hivepath[i]);
1079   }
1080
1081   if (node == 0) {
1082     perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1083     goto out;
1084   }
1085
1086   values = hivex_node_values (h, node);
1087
1088   for (i = 0; values[i] != 0; ++i) {
1089     char *key = hivex_value_key (h, values[i]);
1090     if (key == NULL) {
1091       perrorf (g, "hivex_value_key");
1092       goto out;
1093     }
1094
1095     if (STRCASEEQ (key, "ProductName")) {
1096       fs->product_name = hivex_value_string (h, values[i]);
1097       if (!fs->product_name) {
1098         perrorf (g, "hivex_value_string");
1099         free (key);
1100         goto out;
1101       }
1102     }
1103     else if (STRCASEEQ (key, "CurrentVersion")) {
1104       char *version = hivex_value_string (h, values[i]);
1105       if (!version) {
1106         perrorf (g, "hivex_value_string");
1107         free (key);
1108         goto out;
1109       }
1110       char *major, *minor;
1111       if (match2 (g, version, re_windows_version, &major, &minor)) {
1112         fs->major_version = parse_unsigned_int (g, major);
1113         free (major);
1114         if (fs->major_version == -1) {
1115           free (minor);
1116           free (key);
1117           free (version);
1118           goto out;
1119         }
1120         fs->minor_version = parse_unsigned_int (g, minor);
1121         free (minor);
1122         if (fs->minor_version == -1) {
1123           free (key);
1124           free (version);
1125           return -1;
1126         }
1127       }
1128
1129       free (version);
1130     }
1131
1132     free (key);
1133   }
1134
1135   ret = 0;
1136
1137  out:
1138   if (h) hivex_close (h);
1139   free (values);
1140   free (software_path);
1141
1142   /* Free up the temporary directory.  Note the directory name cannot
1143    * contain shell meta-characters because of the way it was
1144    * constructed above.
1145    */
1146   snprintf (cmd, cmd_len, "rm -rf %s", dir);
1147   ignore_value (system (cmd));
1148 #undef dir_len
1149 #undef software_hive_len
1150 #undef cmd_len
1151
1152   return ret;
1153 }
1154
1155 static char *
1156 resolve_windows_path_silently (guestfs_h *g, const char *path)
1157 {
1158   guestfs_error_handler_cb old_error_cb = g->error_cb;
1159   g->error_cb = NULL;
1160   char *ret = guestfs_case_sensitive_path (g, path);
1161   g->error_cb = old_error_cb;
1162   return ret;
1163 }
1164
1165 static int
1166 extend_fses (guestfs_h *g)
1167 {
1168   size_t n = g->nr_fses + 1;
1169   struct inspect_fs *p;
1170
1171   p = realloc (g->fses, n * sizeof (struct inspect_fs));
1172   if (p == NULL) {
1173     perrorf (g, "realloc");
1174     return -1;
1175   }
1176
1177   g->fses = p;
1178   g->nr_fses = n;
1179
1180   memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1181
1182   return 0;
1183 }
1184
1185 /* Parse small, unsigned ints, as used in version numbers. */
1186 static int
1187 parse_unsigned_int (guestfs_h *g, const char *str)
1188 {
1189   long ret;
1190   int r = xstrtol (str, NULL, 10, &ret, "");
1191   if (r != LONGINT_OK) {
1192     error (g, "could not parse integer in version number: %s", str);
1193     return -1;
1194   }
1195   return ret;
1196 }
1197
1198 static struct inspect_fs *
1199 search_for_root (guestfs_h *g, const char *root)
1200 {
1201   if (g->nr_fses == 0) {
1202     error (g, _("no inspection data: call guestfs_inspect_os first"));
1203     return NULL;
1204   }
1205
1206   size_t i;
1207   struct inspect_fs *fs;
1208   for (i = 0; i < g->nr_fses; ++i) {
1209     fs = &g->fses[i];
1210     if (fs->is_root && STREQ (root, fs->device))
1211       return fs;
1212   }
1213
1214   error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1215          root);
1216   return NULL;
1217 }
1218
1219 char *
1220 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1221 {
1222   struct inspect_fs *fs = search_for_root (g, root);
1223   if (!fs)
1224     return NULL;
1225
1226   char *ret;
1227   switch (fs->type) {
1228   case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1229   case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1230   case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1231   }
1232
1233   return ret;
1234 }
1235
1236 char *
1237 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1238 {
1239   struct inspect_fs *fs = search_for_root (g, root);
1240   if (!fs)
1241     return NULL;
1242
1243   return safe_strdup (g, fs->arch ? : "unknown");
1244 }
1245
1246 char *
1247 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1248 {
1249   struct inspect_fs *fs = search_for_root (g, root);
1250   if (!fs)
1251     return NULL;
1252
1253   char *ret;
1254   switch (fs->distro) {
1255   case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1256   case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1257   case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1258   case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1259   case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1260   case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1261   case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1262   case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1263   }
1264
1265   return ret;
1266 }
1267
1268 int
1269 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1270 {
1271   struct inspect_fs *fs = search_for_root (g, root);
1272   if (!fs)
1273     return -1;
1274
1275   return fs->major_version;
1276 }
1277
1278 int
1279 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1280 {
1281   struct inspect_fs *fs = search_for_root (g, root);
1282   if (!fs)
1283     return -1;
1284
1285   return fs->minor_version;
1286 }
1287
1288 char *
1289 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1290 {
1291   struct inspect_fs *fs = search_for_root (g, root);
1292   if (!fs)
1293     return NULL;
1294
1295   return safe_strdup (g, fs->product_name ? : "unknown");
1296 }
1297
1298 char *
1299 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1300 {
1301   struct inspect_fs *fs = search_for_root (g, root);
1302   if (!fs)
1303     return NULL;
1304
1305   if (!fs->windows_systemroot) {
1306     error (g, _("not a Windows guest, or systemroot could not be determined"));
1307     return NULL;
1308   }
1309
1310   return safe_strdup (g, fs->windows_systemroot);
1311 }
1312
1313 char **
1314 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1315 {
1316   struct inspect_fs *fs = search_for_root (g, root);
1317   if (!fs)
1318     return NULL;
1319
1320   char **ret;
1321
1322   /* If no fstab information (Windows) return just the root. */
1323   if (fs->nr_fstab == 0) {
1324     ret = calloc (3, sizeof (char *));
1325     ret[0] = safe_strdup (g, "/");
1326     ret[1] = safe_strdup (g, root);
1327     ret[2] = NULL;
1328     return ret;
1329   }
1330
1331 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1332   size_t i, count = 0;
1333   for (i = 0; i < fs->nr_fstab; ++i)
1334     if (CRITERION)
1335       count++;
1336
1337   /* Hashtables have 2N+1 entries. */
1338   ret = calloc (2*count+1, sizeof (char *));
1339   if (ret == NULL) {
1340     perrorf (g, "calloc");
1341     return NULL;
1342   }
1343
1344   count = 0;
1345   for (i = 0; i < fs->nr_fstab; ++i)
1346     if (CRITERION) {
1347       ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1348       ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1349       count++;
1350     }
1351 #undef CRITERION
1352
1353   return ret;
1354 }
1355
1356 char **
1357 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1358 {
1359   struct inspect_fs *fs = search_for_root (g, root);
1360   if (!fs)
1361     return NULL;
1362
1363   char **ret;
1364
1365   /* If no fstab information (Windows) return just the root. */
1366   if (fs->nr_fstab == 0) {
1367     ret = calloc (2, sizeof (char *));
1368     ret[0] = safe_strdup (g, root);
1369     ret[1] = NULL;
1370     return ret;
1371   }
1372
1373   ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1374   if (ret == NULL) {
1375     perrorf (g, "calloc");
1376     return NULL;
1377   }
1378
1379   size_t i;
1380   for (i = 0; i < fs->nr_fstab; ++i)
1381     ret[i] = safe_strdup (g, fs->fstab[i].device);
1382
1383   return ret;
1384 }
1385
1386 /* List filesystems.
1387  *
1388  * The current implementation just uses guestfs_vfs_type and doesn't
1389  * try mounting anything, but we reserve the right in future to try
1390  * mounting filesystems.
1391  */
1392
1393 static void remove_from_list (char **list, const char *item);
1394 static void check_with_vfs_type (guestfs_h *g, const char *dev, char ***ret, size_t *ret_size);
1395
1396 char **
1397 guestfs__list_filesystems (guestfs_h *g)
1398 {
1399   size_t i;
1400   char **ret;
1401   size_t ret_size;
1402
1403   ret = safe_malloc (g, sizeof (char *));
1404   ret[0] = NULL;
1405   ret_size = 0;
1406
1407   /* Look to see if any devices directly contain filesystems
1408    * (RHBZ#590167).  However vfs-type will fail to tell us anything
1409    * useful about devices which just contain partitions, so we also
1410    * get the list of partitions and exclude the corresponding devices
1411    * by using part-to-dev.
1412    */
1413   char **devices;
1414   devices = guestfs_list_devices (g);
1415   if (devices == NULL) {
1416     free_string_list (ret);
1417     return NULL;
1418   }
1419   char **partitions;
1420   partitions = guestfs_list_partitions (g);
1421   if (partitions == NULL) {
1422     free_string_list (devices);
1423     free_string_list (ret);
1424     return NULL;
1425   }
1426
1427   for (i = 0; partitions[i] != NULL; ++i) {
1428     char *dev = guestfs_part_to_dev (g, partitions[i]);
1429     if (dev)
1430       remove_from_list (devices, dev);
1431     free (dev);
1432   }
1433
1434   /* Use vfs-type to check for filesystems on devices. */
1435   for (i = 0; devices[i] != NULL; ++i)
1436     check_with_vfs_type (g, devices[i], &ret, &ret_size);
1437   free_string_list (devices);
1438
1439   /* Use vfs-type to check for filesystems on partitions. */
1440   for (i = 0; partitions[i] != NULL; ++i)
1441     check_with_vfs_type (g, partitions[i], &ret, &ret_size);
1442   free_string_list (partitions);
1443
1444   if (feature_available (g, "lvm2")) {
1445     /* Use vfs-type to check for filesystems on LVs. */
1446     char **lvs;
1447     lvs = guestfs_lvs (g);
1448     if (lvs == NULL) {
1449       free_string_list (ret);
1450       return NULL;
1451     }
1452
1453     for (i = 0; lvs[i] != NULL; ++i)
1454       check_with_vfs_type (g, lvs[i], &ret, &ret_size);
1455     free_string_list (lvs);
1456   }
1457
1458   return ret;
1459 }
1460
1461 /* If 'item' occurs in 'list', remove and free it. */
1462 static void
1463 remove_from_list (char **list, const char *item)
1464 {
1465   size_t i;
1466
1467   for (i = 0; list[i] != NULL; ++i)
1468     if (STREQ (list[i], item)) {
1469       free (list[i]);
1470       for (; list[i+1] != NULL; ++i)
1471         list[i] = list[i+1];
1472       list[i] = NULL;
1473       return;
1474     }
1475 }
1476
1477 /* Use vfs-type to look for a filesystem of some sort on 'dev'.
1478  * Apart from some types which we ignore, add the result to the
1479  * 'ret' string list.
1480  */
1481 static void
1482 check_with_vfs_type (guestfs_h *g, const char *device,
1483                      char ***ret, size_t *ret_size)
1484 {
1485   char *v;
1486
1487   guestfs_error_handler_cb old_error_cb = g->error_cb;
1488   g->error_cb = NULL;
1489   char *vfs_type = guestfs_vfs_type (g, device);
1490   g->error_cb = old_error_cb;
1491
1492   if (!vfs_type)
1493     v = safe_strdup (g, "unknown");
1494   else {
1495     /* Ignore all "*_member" strings.  In libblkid these are returned
1496      * for things which are members of some RAID or LVM set, most
1497      * importantly "LVM2_member" which is a PV.
1498      */
1499     size_t n = strlen (vfs_type);
1500     if (n >= 7 && STREQ (&vfs_type[n-7], "_member")) {
1501       free (vfs_type);
1502       return;
1503     }
1504
1505     /* Ignore LUKS-encrypted partitions.  These are also containers. */
1506     if (STREQ (vfs_type, "crypto_LUKS")) {
1507       free (vfs_type);
1508       return;
1509     }
1510
1511     v = vfs_type;
1512   }
1513
1514   /* Extend the return array. */
1515   size_t i = *ret_size;
1516   *ret_size += 2;
1517   *ret = safe_realloc (g, *ret, (*ret_size + 1) * sizeof (char *));
1518   (*ret)[i] = safe_strdup (g, device);
1519   (*ret)[i+1] = v;
1520   (*ret)[i+2] = NULL;
1521 }