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 /* Ubuntu has /etc/lsb-release containing:
 670  *   DISTRIB_ID=Ubuntu                                # Distro
 671  *   DISTRIB_RELEASE=10.04                            # Version
 672  *   DISTRIB_CODENAME=lucid
 673  *   DISTRIB_DESCRIPTION="Ubuntu 10.04.1 LTS"         # Product name
 674  * In theory other distros could have this LSB file, but none do.
 675  */
 676 static int
 677 parse_lsb_release (guestfs_h *g, struct inspect_fs *fs)
 678 {
 679   char **lines;
 680   size_t i;
 681   int r = 0;
 682
 683   lines = guestfs_head_n (g, 10, "/etc/lsb-release");
 684   if (lines == NULL)
 685     return -1;
 686
 687   for (i = 0; lines[i] != NULL; ++i) {
 688     if (fs->distro == 0 &&
 689         STREQ (lines[i], "DISTRIB_ID=Ubuntu")) {
 690       fs->distro = OS_DISTRO_UBUNTU;
 691       r = 1;
 692     }
 693     else if (STRPREFIX (lines[i], "DISTRIB_RELEASE=")) {
 694       char *major, *minor;
 695       if (match2 (g, &lines[i][16], re_major_minor, &major, &minor)) {
 696         fs->major_version = parse_unsigned_int (g, major);
 697         free (major);
 698         if (fs->major_version == -1) {
 699           free (minor);
 700           free_string_list (lines);
 701           return -1;
 702         }
 703         fs->minor_version = parse_unsigned_int (g, minor);
 704         free (minor);
 705         if (fs->minor_version == -1) {
 706           free_string_list (lines);
 707           return -1;
 708         }
 709       }
 710     }
 711     else if (fs->product_name == NULL &&
 712              (STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=\"") ||
 713               STRPREFIX (lines[i], "DISTRIB_DESCRIPTION='"))) {
 714       size_t len = strlen (lines[i]) - 21 - 1;
 715       fs->product_name = safe_strndup (g, &lines[i][21], len);
 716       r = 1;
 717     }
 718     else if (fs->product_name == NULL &&
 719              STRPREFIX (lines[i], "DISTRIB_DESCRIPTION=")) {
 720       size_t len = strlen (lines[i]) - 20;
 721       fs->product_name = safe_strndup (g, &lines[i][20], len);
 722       r = 1;
 723     }
 724   }
 725
 726   free_string_list (lines);
 727   return r;
 728 }
 729
 730 /* The currently mounted device is known to be a Linux root.  Try to
 731  * determine from this the distro, version, etc.  Also parse
 732  * /etc/fstab to determine the arrangement of mountpoints and
 733  * associated devices.
 734  */
 735 static int
 736 check_linux_root (guestfs_h *g, struct inspect_fs *fs)
 737 {
 738   int r;
 739
 740   fs->type = OS_TYPE_LINUX;
 741
 742   if (guestfs_exists (g, "/etc/lsb-release") > 0) {
 743     r = parse_lsb_release (g, fs);
 744     if (r == -1)        /* error */
 745       return -1;
 746     if (r == 1)         /* ok - detected the release from this file */
 747       goto skip_release_checks;
 748   }
 749
 750   if (guestfs_exists (g, "/etc/redhat-release") > 0) {
 751     fs->distro = OS_DISTRO_REDHAT_BASED; /* Something generic Red Hat-like. */
 752
 753     if (parse_release_file (g, fs, "/etc/redhat-release") == -1)
 754       return -1;
 755
 756     char *major, *minor;
 757     if ((major = match1 (g, fs->product_name, re_fedora)) != NULL) {
 758       fs->distro = OS_DISTRO_FEDORA;
 759       fs->major_version = parse_unsigned_int (g, major);
 760       free (major);
 761       if (fs->major_version == -1)
 762         return -1;
 763     }
 764     else if (match2 (g, fs->product_name, re_rhel_old, &major, &minor) ||
 765              match2 (g, fs->product_name, re_rhel, &major, &minor)) {
 766       fs->distro = OS_DISTRO_RHEL;
 767       fs->major_version = parse_unsigned_int (g, major);
 768       free (major);
 769       if (fs->major_version == -1) {
 770         free (minor);
 771         return -1;
 772       }
 773       fs->minor_version = parse_unsigned_int (g, minor);
 774       free (minor);
 775       if (fs->minor_version == -1)
 776         return -1;
 777     }
 778     else if ((major = match1 (g, fs->product_name, re_rhel_no_minor)) != NULL) {
 779       fs->distro = OS_DISTRO_RHEL;
 780       fs->major_version = parse_unsigned_int (g, major);
 781       free (major);
 782       if (fs->major_version == -1)
 783         return -1;
 784       fs->minor_version = 0;
 785     }
 786   }
 787   else if (guestfs_exists (g, "/etc/debian_version") > 0) {
 788     fs->distro = OS_DISTRO_DEBIAN;
 789
 790     if (parse_release_file (g, fs, "/etc/debian_version") == -1)
 791       return -1;
 792
 793     if (parse_major_minor (g, fs) == -1)
 794       return -1;
 795   }
 796   else if (guestfs_exists (g, "/etc/pardus-release") > 0) {
 797     fs->distro = OS_DISTRO_PARDUS;
 798
 799     if (parse_release_file (g, fs, "/etc/pardus-release") == -1)
 800       return -1;
 801
 802     if (parse_major_minor (g, fs) == -1)
 803       return -1;
 804   }
 805   else if (guestfs_exists (g, "/etc/arch-release") > 0) {
 806     fs->distro = OS_DISTRO_ARCHLINUX;
 807
 808     /* /etc/arch-release file is empty and I can't see a way to
 809      * determine the actual release or product string.
 810      */
 811   }
 812   else if (guestfs_exists (g, "/etc/gentoo-release") > 0) {
 813     fs->distro = OS_DISTRO_GENTOO;
 814
 815     if (parse_release_file (g, fs, "/etc/gentoo-release") == -1)
 816       return -1;
 817
 818     if (parse_major_minor (g, fs) == -1)
 819       return -1;
 820   }
 821   else if (guestfs_exists (g, "/etc/meego-release") > 0) {
 822     fs->distro = OS_DISTRO_MEEGO;
 823
 824     if (parse_release_file (g, fs, "/etc/meego-release") == -1)
 825       return -1;
 826
 827     if (parse_major_minor (g, fs) == -1)
 828       return -1;
 829   }
 830
 831  skip_release_checks:;
 832
 833   /* Determine the architecture. */
 834   const char *binaries[] =
 835     { "/bin/bash", "/bin/ls", "/bin/echo", "/bin/rm", "/bin/sh" };
 836   size_t i;
 837   for (i = 0; i < sizeof binaries / sizeof binaries[0]; ++i) {
 838     if (guestfs_is_file (g, binaries[i]) > 0) {
 839       /* Ignore errors from file_architecture call. */
 840       guestfs_error_handler_cb old_error_cb = g->error_cb;
 841       g->error_cb = NULL;
 842       char *arch = guestfs_file_architecture (g, binaries[i]);
 843       g->error_cb = old_error_cb;
 844
 845       if (arch) {
 846         /* String will be owned by handle, freed by
 847          * guestfs___free_inspect_info.
 848          */
 849         fs->arch = arch;
 850         break;
 851       }
 852     }
 853   }
 854
 855   /* We already know /etc/fstab exists because it's part of the test
 856    * for Linux root above.  We must now parse this file to determine
 857    * which filesystems are used by the operating system and how they
 858    * are mounted.
 859    * XXX What if !feature_available (g, "augeas")?
 860    */
 861   if (guestfs_aug_init (g, "/", AUG_NO_LOAD|AUG_SAVE_NOOP) == -1)
 862     return -1;
 863
 864   /* Tell Augeas to only load /etc/fstab (thanks Raphaël Pinson). */
 865   guestfs_aug_rm (g, "/augeas/load//incl[. != \"/etc/fstab\"]");
 866   guestfs_aug_load (g);
 867
 868   r = check_fstab (g, fs);
 869   guestfs_aug_close (g);
 870   if (r == -1)
 871     return -1;
 872
 873   return 0;
 874 }
 875
 876 static int
 877 check_fstab (guestfs_h *g, struct inspect_fs *fs)
 878 {
 879   char **lines = guestfs_aug_ls (g, "/files/etc/fstab");
 880   if (lines == NULL)
 881     return -1;
 882
 883   if (lines[0] == NULL) {
 884     error (g, "could not parse /etc/fstab or empty file");
 885     free_string_list (lines);
 886     return -1;
 887   }
 888
 889   size_t i;
 890   char augpath[256];
 891   for (i = 0; lines[i] != NULL; ++i) {
 892     /* Ignore comments.  Only care about sequence lines which
 893      * match m{/\d+$}.
 894      */
 895     if (match (g, lines[i], re_aug_seq)) {
 896       snprintf (augpath, sizeof augpath, "%s/spec", lines[i]);
 897       char *spec = guestfs_aug_get (g, augpath);
 898       if (spec == NULL) {
 899         free_string_list (lines);
 900         return -1;
 901       }
 902
 903       snprintf (augpath, sizeof augpath, "%s/file", lines[i]);
 904       char *mp = guestfs_aug_get (g, augpath);
 905       if (mp == NULL) {
 906         free_string_list (lines);
 907         free (spec);
 908         return -1;
 909       }
 910
 911       int r = add_fstab_entry (g, fs, spec, mp);
 912       free (spec);
 913       free (mp);
 914
 915       if (r == -1) {
 916         free_string_list (lines);
 917         return -1;
 918       }
 919     }
 920   }
 921
 922   free_string_list (lines);
 923   return 0;
 924 }
 925
 926 /* Add a filesystem and possibly a mountpoint entry for
 927  * the root filesystem 'fs'.
 928  *
 929  * 'spec' is the fstab spec field, which might be a device name or a
 930  * pseudodevice or 'UUID=...' or 'LABEL=...'.
 931  *
 932  * 'mp' is the mount point, which could also be 'swap' or 'none'.
 933  */
 934 static int
 935 add_fstab_entry (guestfs_h *g, struct inspect_fs *fs,
 936                  const char *spec, const char *mp)
 937 {
 938   /* Ignore certain mountpoints. */
 939   if (STRPREFIX (mp, "/dev/") ||
 940       STREQ (mp, "/dev") ||
 941       STRPREFIX (mp, "/media/") ||
 942       STRPREFIX (mp, "/proc/") ||
 943       STREQ (mp, "/proc") ||
 944       STRPREFIX (mp, "/selinux/") ||
 945       STREQ (mp, "/selinux") ||
 946       STRPREFIX (mp, "/sys/") ||
 947       STREQ (mp, "/sys"))
 948     return 0;
 949
 950   /* Ignore /dev/fd (floppy disks) (RHBZ#642929) and CD-ROM drives. */
 951   if ((STRPREFIX (spec, "/dev/fd") && c_isdigit (spec[7])) ||
 952       STREQ (spec, "/dev/floppy") ||
 953       STREQ (spec, "/dev/cdrom"))
 954     return 0;
 955
 956   /* Resolve UUID= and LABEL= to the actual device. */
 957   char *device = NULL;
 958   if (STRPREFIX (spec, "UUID="))
 959     device = guestfs_findfs_uuid (g, &spec[5]);
 960   else if (STRPREFIX (spec, "LABEL="))
 961     device = guestfs_findfs_label (g, &spec[6]);
 962   /* Ignore "/.swap" (Pardus) and pseudo-devices like "tmpfs". */
 963   else if (STRPREFIX (spec, "/dev/"))
 964     /* Resolve guest block device names. */
 965     device = resolve_fstab_device (g, spec);
 966
 967   /* If we haven't resolved the device successfully by this point,
 968    * we don't care, just ignore it.
 969    */
 970   if (device == NULL)
 971     return 0;
 972
 973   char *mountpoint = safe_strdup (g, mp);
 974
 975   /* Add this to the fstab entry in 'fs'.
 976    * Note these are further filtered by guestfs_inspect_get_mountpoints
 977    * and guestfs_inspect_get_filesystems.
 978    */
 979   size_t n = fs->nr_fstab + 1;
 980   struct inspect_fstab_entry *p;
 981
 982   p = realloc (fs->fstab, n * sizeof (struct inspect_fstab_entry));
 983   if (p == NULL) {
 984     perrorf (g, "realloc");
 985     free (device);
 986     free (mountpoint);
 987     return -1;
 988   }
 989
 990   fs->fstab = p;
 991   fs->nr_fstab = n;
 992
 993   /* These are owned by the handle and freed by guestfs___free_inspect_info. */
 994   fs->fstab[n-1].device = device;
 995   fs->fstab[n-1].mountpoint = mountpoint;
 996
 997   if (g->verbose)
 998     fprintf (stderr, "fstab: device=%s mountpoint=%s\n", device, mountpoint);
 999
1000   return 0;
1001 }
1002
1003 /* Resolve block device name to the libguestfs device name, eg.
1004  * /dev/xvdb1 => /dev/vdb1; and /dev/mapper/VG-LV => /dev/VG/LV.  This
1005  * assumes that disks were added in the same order as they appear to
1006  * the real VM, which is a reasonable assumption to make.  Return
1007  * anything we don't recognize unchanged.
1008  */
1009 static char *
1010 resolve_fstab_device (guestfs_h *g, const char *spec)
1011 {
1012   char *a1;
1013   char *device = NULL;
1014
1015   if (STRPREFIX (spec, "/dev/mapper/")) {
1016     /* LVM2 does some strange munging on /dev/mapper paths for VGs and
1017      * LVs which contain '-' character:
1018      *
1019      * ><fs> lvcreate LV--test VG--test 32
1020      * ><fs> debug ls /dev/mapper
1021      * VG----test-LV----test
1022      *
1023      * This makes it impossible to reverse those paths directly, so
1024      * we have implemented lvm_canonical_lv_name in the daemon.
1025      */
1026     device = guestfs_lvm_canonical_lv_name (g, spec);
1027   }
1028   else if ((a1 = match1 (g, spec, re_xdev)) != NULL) {
1029     char **devices = guestfs_list_devices (g);
1030     if (devices == NULL)
1031       return NULL;
1032
1033     size_t count;
1034     for (count = 0; devices[count] != NULL; count++)
1035       ;
1036
1037     size_t i = a1[0] - 'a'; /* a1[0] is always [a-z] because of regex. */
1038     if (i < count) {
1039       size_t len = strlen (devices[i]) + strlen (a1) + 16;
1040       device = safe_malloc (g, len);
1041       snprintf (device, len, "%s%s", devices[i], &a1[1]);
1042     }
1043
1044     free (a1);
1045     free_string_list (devices);
1046   }
1047   else {
1048     /* Didn't match device pattern, return original spec unchanged. */
1049     device = safe_strdup (g, spec);
1050   }
1051
1052   return device;
1053 }
1054
1055 /* XXX Handling of boot.ini in the Perl version was pretty broken.  It
1056  * essentially didn't do anything for modern Windows guests.
1057  * Therefore I've omitted all that code.
1058  */
1059 static int
1060 check_windows_root (guestfs_h *g, struct inspect_fs *fs)
1061 {
1062   fs->type = OS_TYPE_WINDOWS;
1063   fs->distro = OS_DISTRO_WINDOWS;
1064
1065   /* Try to find Windows systemroot using some common locations. */
1066   const char *systemroots[] =
1067     { "/windows", "/winnt", "/win32", "/win" };
1068   size_t i;
1069   char *systemroot = NULL;
1070   for (i = 0;
1071        systemroot == NULL && i < sizeof systemroots / sizeof systemroots[0];
1072        ++i) {
1073     systemroot = resolve_windows_path_silently (g, systemroots[i]);
1074   }
1075
1076   if (!systemroot) {
1077     error (g, _("cannot resolve Windows %%SYSTEMROOT%%"));
1078     return -1;
1079   }
1080
1081   if (g->verbose)
1082     fprintf (stderr, "windows %%SYSTEMROOT%% = %s", systemroot);
1083
1084   /* Freed by guestfs___free_inspect_info. */
1085   fs->windows_systemroot = systemroot;
1086
1087   if (check_windows_arch (g, fs) == -1)
1088     return -1;
1089
1090   if (check_windows_registry (g, fs) == -1)
1091     return -1;
1092
1093   return 0;
1094 }
1095
1096 static int
1097 check_windows_arch (guestfs_h *g, struct inspect_fs *fs)
1098 {
1099   size_t len = strlen (fs->windows_systemroot) + 32;
1100   char cmd_exe[len];
1101   snprintf (cmd_exe, len, "%s/system32/cmd.exe", fs->windows_systemroot);
1102
1103   char *cmd_exe_path = resolve_windows_path_silently (g, cmd_exe);
1104   if (!cmd_exe_path)
1105     return 0;
1106
1107   char *arch = guestfs_file_architecture (g, cmd_exe_path);
1108   free (cmd_exe_path);
1109
1110   if (arch)
1111     fs->arch = arch;        /* freed by guestfs___free_inspect_info */
1112
1113   return 0;
1114 }
1115
1116 /* At the moment, pull just the ProductName and version numbers from
1117  * the registry.  In future there is a case for making many more
1118  * registry fields available to callers.
1119  */
1120 static int
1121 check_windows_registry (guestfs_h *g, struct inspect_fs *fs)
1122 {
1123   TMP_TEMPLATE_ON_STACK (dir);
1124 #define dir_len (strlen (dir))
1125 #define software_hive_len (dir_len + 16)
1126   char software_hive[software_hive_len];
1127 #define cmd_len (dir_len + 16)
1128   char cmd[cmd_len];
1129
1130   size_t len = strlen (fs->windows_systemroot) + 64;
1131   char software[len];
1132   snprintf (software, len, "%s/system32/config/software",
1133             fs->windows_systemroot);
1134
1135   char *software_path = resolve_windows_path_silently (g, software);
1136   if (!software_path)
1137     /* If the software hive doesn't exist, just accept that we cannot
1138      * find product_name etc.
1139      */
1140     return 0;
1141
1142   int ret = -1;
1143   hive_h *h = NULL;
1144   hive_value_h *values = NULL;
1145
1146   if (mkdtemp (dir) == NULL) {
1147     perrorf (g, "mkdtemp");
1148     goto out;
1149   }
1150
1151   snprintf (software_hive, software_hive_len, "%s/software", dir);
1152
1153   if (guestfs_download (g, software_path, software_hive) == -1)
1154     goto out;
1155
1156   h = hivex_open (software_hive, g->verbose ? HIVEX_OPEN_VERBOSE : 0);
1157   if (h == NULL) {
1158     perrorf (g, "hivex_open");
1159     goto out;
1160   }
1161
1162   hive_node_h node = hivex_root (h);
1163   const char *hivepath[] =
1164     { "Microsoft", "Windows NT", "CurrentVersion" };
1165   size_t i;
1166   for (i = 0;
1167        node != 0 && i < sizeof hivepath / sizeof hivepath[0];
1168        ++i) {
1169     node = hivex_node_get_child (h, node, hivepath[i]);
1170   }
1171
1172   if (node == 0) {
1173     perrorf (g, "hivex: cannot locate HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion");
1174     goto out;
1175   }
1176
1177   values = hivex_node_values (h, node);
1178
1179   for (i = 0; values[i] != 0; ++i) {
1180     char *key = hivex_value_key (h, values[i]);
1181     if (key == NULL) {
1182       perrorf (g, "hivex_value_key");
1183       goto out;
1184     }
1185
1186     if (STRCASEEQ (key, "ProductName")) {
1187       fs->product_name = hivex_value_string (h, values[i]);
1188       if (!fs->product_name) {
1189         perrorf (g, "hivex_value_string");
1190         free (key);
1191         goto out;
1192       }
1193     }
1194     else if (STRCASEEQ (key, "CurrentVersion")) {
1195       char *version = hivex_value_string (h, values[i]);
1196       if (!version) {
1197         perrorf (g, "hivex_value_string");
1198         free (key);
1199         goto out;
1200       }
1201       char *major, *minor;
1202       if (match2 (g, version, re_windows_version, &major, &minor)) {
1203         fs->major_version = parse_unsigned_int (g, major);
1204         free (major);
1205         if (fs->major_version == -1) {
1206           free (minor);
1207           free (key);
1208           free (version);
1209           goto out;
1210         }
1211         fs->minor_version = parse_unsigned_int (g, minor);
1212         free (minor);
1213         if (fs->minor_version == -1) {
1214           free (key);
1215           free (version);
1216           return -1;
1217         }
1218       }
1219
1220       free (version);
1221     }
1222
1223     free (key);
1224   }
1225
1226   ret = 0;
1227
1228  out:
1229   if (h) hivex_close (h);
1230   free (values);
1231   free (software_path);
1232
1233   /* Free up the temporary directory.  Note the directory name cannot
1234    * contain shell meta-characters because of the way it was
1235    * constructed above.
1236    */
1237   snprintf (cmd, cmd_len, "rm -rf %s", dir);
1238   ignore_value (system (cmd));
1239 #undef dir_len
1240 #undef software_hive_len
1241 #undef cmd_len
1242
1243   return ret;
1244 }
1245
1246 static char *
1247 resolve_windows_path_silently (guestfs_h *g, const char *path)
1248 {
1249   guestfs_error_handler_cb old_error_cb = g->error_cb;
1250   g->error_cb = NULL;
1251   char *ret = guestfs_case_sensitive_path (g, path);
1252   g->error_cb = old_error_cb;
1253   return ret;
1254 }
1255
1256 static int
1257 extend_fses (guestfs_h *g)
1258 {
1259   size_t n = g->nr_fses + 1;
1260   struct inspect_fs *p;
1261
1262   p = realloc (g->fses, n * sizeof (struct inspect_fs));
1263   if (p == NULL) {
1264     perrorf (g, "realloc");
1265     return -1;
1266   }
1267
1268   g->fses = p;
1269   g->nr_fses = n;
1270
1271   memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
1272
1273   return 0;
1274 }
1275
1276 /* Parse small, unsigned ints, as used in version numbers. */
1277 static int
1278 parse_unsigned_int (guestfs_h *g, const char *str)
1279 {
1280   long ret;
1281   int r = xstrtol (str, NULL, 10, &ret, "");
1282   if (r != LONGINT_OK) {
1283     error (g, "could not parse integer in version number: %s", str);
1284     return -1;
1285   }
1286   return ret;
1287 }
1288
1289 static struct inspect_fs *
1290 search_for_root (guestfs_h *g, const char *root)
1291 {
1292   if (g->nr_fses == 0) {
1293     error (g, _("no inspection data: call guestfs_inspect_os first"));
1294     return NULL;
1295   }
1296
1297   size_t i;
1298   struct inspect_fs *fs;
1299   for (i = 0; i < g->nr_fses; ++i) {
1300     fs = &g->fses[i];
1301     if (fs->is_root && STREQ (root, fs->device))
1302       return fs;
1303   }
1304
1305   error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
1306          root);
1307   return NULL;
1308 }
1309
1310 char *
1311 guestfs__inspect_get_type (guestfs_h *g, const char *root)
1312 {
1313   struct inspect_fs *fs = search_for_root (g, root);
1314   if (!fs)
1315     return NULL;
1316
1317   char *ret;
1318   switch (fs->type) {
1319   case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
1320   case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
1321   case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1322   }
1323
1324   return ret;
1325 }
1326
1327 char *
1328 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
1329 {
1330   struct inspect_fs *fs = search_for_root (g, root);
1331   if (!fs)
1332     return NULL;
1333
1334   return safe_strdup (g, fs->arch ? : "unknown");
1335 }
1336
1337 char *
1338 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
1339 {
1340   struct inspect_fs *fs = search_for_root (g, root);
1341   if (!fs)
1342     return NULL;
1343
1344   char *ret;
1345   switch (fs->distro) {
1346   case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
1347   case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
1348   case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
1349   case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
1350   case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
1351   case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
1352   case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
1353   case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
1354   case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
1355   case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
1356   case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
1357   }
1358
1359   return ret;
1360 }
1361
1362 int
1363 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
1364 {
1365   struct inspect_fs *fs = search_for_root (g, root);
1366   if (!fs)
1367     return -1;
1368
1369   return fs->major_version;
1370 }
1371
1372 int
1373 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
1374 {
1375   struct inspect_fs *fs = search_for_root (g, root);
1376   if (!fs)
1377     return -1;
1378
1379   return fs->minor_version;
1380 }
1381
1382 char *
1383 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
1384 {
1385   struct inspect_fs *fs = search_for_root (g, root);
1386   if (!fs)
1387     return NULL;
1388
1389   return safe_strdup (g, fs->product_name ? : "unknown");
1390 }
1391
1392 char *
1393 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
1394 {
1395   struct inspect_fs *fs = search_for_root (g, root);
1396   if (!fs)
1397     return NULL;
1398
1399   if (!fs->windows_systemroot) {
1400     error (g, _("not a Windows guest, or systemroot could not be determined"));
1401     return NULL;
1402   }
1403
1404   return safe_strdup (g, fs->windows_systemroot);
1405 }
1406
1407 char **
1408 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
1409 {
1410   struct inspect_fs *fs = search_for_root (g, root);
1411   if (!fs)
1412     return NULL;
1413
1414   char **ret;
1415
1416   /* If no fstab information (Windows) return just the root. */
1417   if (fs->nr_fstab == 0) {
1418     ret = calloc (3, sizeof (char *));
1419     ret[0] = safe_strdup (g, "/");
1420     ret[1] = safe_strdup (g, root);
1421     ret[2] = NULL;
1422     return ret;
1423   }
1424
1425 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
1426   size_t i, count = 0;
1427   for (i = 0; i < fs->nr_fstab; ++i)
1428     if (CRITERION)
1429       count++;
1430
1431   /* Hashtables have 2N+1 entries. */
1432   ret = calloc (2*count+1, sizeof (char *));
1433   if (ret == NULL) {
1434     perrorf (g, "calloc");
1435     return NULL;
1436   }
1437
1438   count = 0;
1439   for (i = 0; i < fs->nr_fstab; ++i)
1440     if (CRITERION) {
1441       ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
1442       ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
1443       count++;
1444     }
1445 #undef CRITERION
1446
1447   return ret;
1448 }
1449
1450 char **
1451 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
1452 {
1453   struct inspect_fs *fs = search_for_root (g, root);
1454   if (!fs)
1455     return NULL;
1456
1457   char **ret;
1458
1459   /* If no fstab information (Windows) return just the root. */
1460   if (fs->nr_fstab == 0) {
1461     ret = calloc (2, sizeof (char *));
1462     ret[0] = safe_strdup (g, root);
1463     ret[1] = NULL;
1464     return ret;
1465   }
1466
1467   ret = calloc (fs->nr_fstab + 1, sizeof (char *));
1468   if (ret == NULL) {
1469     perrorf (g, "calloc");
1470     return NULL;
1471   }
1472
1473   size_t i;
1474   for (i = 0; i < fs->nr_fstab; ++i)
1475     ret[i] = safe_strdup (g, fs->fstab[i].device);
1476
1477   return ret;
1478 }
1479
1480 /* List filesystems.
1481  *
1482  * The current implementation just uses guestfs_vfs_type and doesn't
1483  * try mounting anything, but we reserve the right in future to try
1484  * mounting filesystems.
1485  */
1486
1487 static void remove_from_list (char **list, const char *item);
1488 static void check_with_vfs_type (guestfs_h *g, const char *dev, char ***ret, size_t *ret_size);
1489
1490 char **
1491 guestfs__list_filesystems (guestfs_h *g)
1492 {
1493   size_t i;
1494   char **ret;
1495   size_t ret_size;
1496
1497   ret = safe_malloc (g, sizeof (char *));
1498   ret[0] = NULL;
1499   ret_size = 0;
1500
1501   /* Look to see if any devices directly contain filesystems
1502    * (RHBZ#590167).  However vfs-type will fail to tell us anything
1503    * useful about devices which just contain partitions, so we also
1504    * get the list of partitions and exclude the corresponding devices
1505    * by using part-to-dev.
1506    */
1507   char **devices;
1508   devices = guestfs_list_devices (g);
1509   if (devices == NULL) {
1510     free_string_list (ret);
1511     return NULL;
1512   }
1513   char **partitions;
1514   partitions = guestfs_list_partitions (g);
1515   if (partitions == NULL) {
1516     free_string_list (devices);
1517     free_string_list (ret);
1518     return NULL;
1519   }
1520
1521   for (i = 0; partitions[i] != NULL; ++i) {
1522     char *dev = guestfs_part_to_dev (g, partitions[i]);
1523     if (dev)
1524       remove_from_list (devices, dev);
1525     free (dev);
1526   }
1527
1528   /* Use vfs-type to check for filesystems on devices. */
1529   for (i = 0; devices[i] != NULL; ++i)
1530     check_with_vfs_type (g, devices[i], &ret, &ret_size);
1531   free_string_list (devices);
1532
1533   /* Use vfs-type to check for filesystems on partitions. */
1534   for (i = 0; partitions[i] != NULL; ++i)
1535     check_with_vfs_type (g, partitions[i], &ret, &ret_size);
1536   free_string_list (partitions);
1537
1538   if (feature_available (g, "lvm2")) {
1539     /* Use vfs-type to check for filesystems on LVs. */
1540     char **lvs;
1541     lvs = guestfs_lvs (g);
1542     if (lvs == NULL) {
1543       free_string_list (ret);
1544       return NULL;
1545     }
1546
1547     for (i = 0; lvs[i] != NULL; ++i)
1548       check_with_vfs_type (g, lvs[i], &ret, &ret_size);
1549     free_string_list (lvs);
1550   }
1551
1552   return ret;
1553 }
1554
1555 /* If 'item' occurs in 'list', remove and free it. */
1556 static void
1557 remove_from_list (char **list, const char *item)
1558 {
1559   size_t i;
1560
1561   for (i = 0; list[i] != NULL; ++i)
1562     if (STREQ (list[i], item)) {
1563       free (list[i]);
1564       for (; list[i+1] != NULL; ++i)
1565         list[i] = list[i+1];
1566       list[i] = NULL;
1567       return;
1568     }
1569 }
1570
1571 /* Use vfs-type to look for a filesystem of some sort on 'dev'.
1572  * Apart from some types which we ignore, add the result to the
1573  * 'ret' string list.
1574  */
1575 static void
1576 check_with_vfs_type (guestfs_h *g, const char *device,
1577                      char ***ret, size_t *ret_size)
1578 {
1579   char *v;
1580
1581   guestfs_error_handler_cb old_error_cb = g->error_cb;
1582   g->error_cb = NULL;
1583   char *vfs_type = guestfs_vfs_type (g, device);
1584   g->error_cb = old_error_cb;
1585
1586   if (!vfs_type)
1587     v = safe_strdup (g, "unknown");
1588   else {
1589     /* Ignore all "*_member" strings.  In libblkid these are returned
1590      * for things which are members of some RAID or LVM set, most
1591      * importantly "LVM2_member" which is a PV.
1592      */
1593     size_t n = strlen (vfs_type);
1594     if (n >= 7 && STREQ (&vfs_type[n-7], "_member")) {
1595       free (vfs_type);
1596       return;
1597     }
1598
1599     /* Ignore LUKS-encrypted partitions.  These are also containers. */
1600     if (STREQ (vfs_type, "crypto_LUKS")) {
1601       free (vfs_type);
1602       return;
1603     }
1604
1605     v = vfs_type;
1606   }
1607
1608   /* Extend the return array. */
1609   size_t i = *ret_size;
1610   *ret_size += 2;
1611   *ret = safe_realloc (g, *ret, (*ret_size + 1) * sizeof (char *));
1612   (*ret)[i] = safe_strdup (g, device);
1613   (*ret)[i+1] = v;
1614   (*ret)[i+2] = NULL;
1615 }