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