2 * Copyright (C) 2010-2011 Red Hat Inc.
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.
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.
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
39 #include "ignore-value.h"
43 #include "guestfs-internal.h"
44 #include "guestfs-internal-actions.h"
45 #include "guestfs_protocol.h"
47 #if defined(HAVE_HIVEX)
49 /* Compile all the regular expressions once when the shared library is
50 * loaded. PCRE is thread safe so we're supposedly OK here if
51 * multiple threads call into the libguestfs API functions below
54 static pcre *re_first_partition;
55 static pcre *re_major_minor;
57 static void compile_regexps (void) __attribute__((constructor));
58 static void free_regexps (void) __attribute__((destructor));
61 compile_regexps (void)
66 #define COMPILE(re,pattern,options) \
68 re = pcre_compile ((pattern), (options), &err, &offset, NULL); \
70 ignore_value (write (2, err, strlen (err))); \
75 COMPILE (re_first_partition, "^/dev/(?:h|s|v)d.1$", 0);
76 COMPILE (re_major_minor, "(\\d+)\\.(\\d+)", 0);
82 pcre_free (re_first_partition);
83 pcre_free (re_major_minor);
86 static int check_filesystem (guestfs_h *g, const char *device, int is_block, int is_partnum);
87 static void check_package_format (guestfs_h *g, struct inspect_fs *fs);
88 static void check_package_management (guestfs_h *g, struct inspect_fs *fs);
89 static int extend_fses (guestfs_h *g);
90 static int is_file_nocase (guestfs_h *g, const char *);
91 static int is_dir_nocase (guestfs_h *g, const char *);
93 /* Find out if 'device' contains a filesystem. If it does, add
94 * another entry in g->fses.
97 guestfs___check_for_filesystem_on (guestfs_h *g, const char *device,
98 int is_block, int is_partnum)
100 /* Get vfs-type in order to check if it's a Linux(?) swap device.
101 * If there's an error we should ignore it, so to do that we have to
102 * temporarily replace the error handler with a null one.
104 guestfs_error_handler_cb old_error_cb = g->error_cb;
106 char *vfs_type = guestfs_vfs_type (g, device);
107 g->error_cb = old_error_cb;
109 int is_swap = vfs_type && STREQ (vfs_type, "swap");
111 debug (g, "check_for_filesystem_on: %s %d %d (%s)",
112 device, is_block, is_partnum,
113 vfs_type ? vfs_type : "failed to get vfs type");
117 if (extend_fses (g) == -1)
119 g->fses[g->nr_fses-1].is_swap = 1;
123 /* Try mounting the device. As above, ignore errors. */
125 int r = guestfs_mount_ro (g, device, "/");
126 if (r == -1 && vfs_type && STREQ (vfs_type, "ufs")) /* Hack for the *BSDs. */
127 r = guestfs_mount_vfs (g, "ro,ufstype=ufs2", "ufs", device, "/");
129 g->error_cb = old_error_cb;
133 /* Do the rest of the checks. */
134 r = check_filesystem (g, device, is_block, is_partnum);
136 /* Unmount the filesystem. */
137 if (guestfs_umount_all (g) == -1)
143 /* is_block and is_partnum are just hints: is_block is true if the
144 * filesystem is a whole block device (eg. /dev/sda). is_partnum
145 * is > 0 if the filesystem is a direct partition, and in this case
146 * it is the partition number counting from 1
147 * (eg. /dev/sda1 => is_partnum == 1).
150 check_filesystem (guestfs_h *g, const char *device,
151 int is_block, int is_partnum)
153 if (extend_fses (g) == -1)
156 struct inspect_fs *fs = &g->fses[g->nr_fses-1];
158 fs->device = safe_strdup (g, device);
159 fs->is_mountable = 1;
161 /* Optimize some of the tests by avoiding multiple tests of the same thing. */
162 int is_dir_etc = guestfs_is_dir (g, "/etc") > 0;
163 int is_dir_bin = guestfs_is_dir (g, "/bin") > 0;
164 int is_dir_share = guestfs_is_dir (g, "/share") > 0;
167 if (guestfs_is_file (g, "/grub/menu.lst") > 0 ||
168 guestfs_is_file (g, "/grub/grub.conf") > 0)
169 fs->content = FS_CONTENT_LINUX_BOOT;
171 else if (is_dir_etc &&
173 guestfs_is_file (g, "/etc/freebsd-update.conf") > 0 &&
174 guestfs_is_file (g, "/etc/fstab") > 0) {
175 /* Ignore /dev/sda1 which is a shadow of the real root filesystem
176 * that is probably /dev/sda5 (see:
177 * http://www.freebsd.org/doc/handbook/disk-organization.html)
179 if (match (g, device, re_first_partition))
183 fs->content = FS_CONTENT_FREEBSD_ROOT;
184 fs->format = OS_FORMAT_INSTALLED;
185 if (guestfs___check_freebsd_root (g, fs) == -1)
189 else if (is_dir_etc &&
191 guestfs_is_file (g, "/etc/fstab") > 0) {
193 fs->content = FS_CONTENT_LINUX_ROOT;
194 fs->format = OS_FORMAT_INSTALLED;
195 if (guestfs___check_linux_root (g, fs) == -1)
198 /* Linux /usr/local? */
199 else if (is_dir_etc &&
202 guestfs_exists (g, "/local") == 0 &&
203 guestfs_is_file (g, "/etc/fstab") == 0)
204 fs->content = FS_CONTENT_LINUX_USR_LOCAL;
206 else if (is_dir_etc &&
209 guestfs_exists (g, "/local") > 0 &&
210 guestfs_is_file (g, "/etc/fstab") == 0)
211 fs->content = FS_CONTENT_LINUX_USR;
213 else if (guestfs_is_dir (g, "/log") > 0 &&
214 guestfs_is_dir (g, "/run") > 0 &&
215 guestfs_is_dir (g, "/spool") > 0)
216 fs->content = FS_CONTENT_LINUX_VAR;
218 * Note that if a Windows guest has multiple disks and applications
219 * are installed on those other disks, then those other disks will
220 * contain "/Program Files" and "/System Volume Information". Those
221 * would *not* be Windows root disks. (RHBZ#674130)
223 else if (is_file_nocase (g, "/AUTOEXEC.BAT") > 0 ||
224 is_dir_nocase (g, "/WINDOWS/SYSTEM32") > 0 ||
225 is_dir_nocase (g, "/WIN32/SYSTEM32") > 0 ||
226 is_dir_nocase (g, "/WINNT/SYSTEM32") > 0 ||
227 is_file_nocase (g, "/boot.ini") > 0 ||
228 is_file_nocase (g, "/ntldr") > 0) {
230 fs->content = FS_CONTENT_WINDOWS_ROOT;
231 fs->format = OS_FORMAT_INSTALLED;
232 if (guestfs___check_windows_root (g, fs) == -1)
235 /* Windows volume with installed applications (but not root)? */
236 else if (is_dir_nocase (g, "/System Volume Information") > 0 &&
237 is_dir_nocase (g, "/Program Files") > 0)
238 fs->content = FS_CONTENT_WINDOWS_VOLUME_WITH_APPS;
239 /* Windows volume (but not root)? */
240 else if (is_dir_nocase (g, "/System Volume Information") > 0)
241 fs->content = FS_CONTENT_WINDOWS_VOLUME;
242 /* Install CD/disk? Skip these checks if it's not a whole device
243 * (eg. CD) or the first partition (eg. bootable USB key).
245 else if ((is_block || is_partnum == 1) &&
246 (guestfs_is_file (g, "/isolinux/isolinux.cfg") > 0 ||
247 guestfs_is_dir (g, "/EFI/BOOT") > 0 ||
248 guestfs_is_file (g, "/images/install.img") > 0 ||
249 guestfs_is_dir (g, "/.disk") > 0 ||
250 guestfs_is_file (g, "/.discinfo") > 0 ||
251 guestfs_is_file (g, "/i386/txtsetup.sif") > 0 ||
252 guestfs_is_file (g, "/amd64/txtsetup.sif")) > 0) {
254 fs->content = FS_CONTENT_INSTALLER;
255 fs->format = OS_FORMAT_INSTALLER;
256 if (guestfs___check_installer_root (g, fs) == -1)
260 /* The above code should have set fs->type and fs->distro fields, so
261 * we can now guess the package management system.
263 check_package_format (g, fs);
264 check_package_management (g, fs);
270 extend_fses (guestfs_h *g)
272 size_t n = g->nr_fses + 1;
273 struct inspect_fs *p;
275 p = realloc (g->fses, n * sizeof (struct inspect_fs));
277 perrorf (g, "realloc");
284 memset (&g->fses[n-1], 0, sizeof (struct inspect_fs));
290 is_file_nocase (guestfs_h *g, const char *path)
295 p = guestfs___case_sensitive_path_silently (g, path);
298 r = guestfs_is_file (g, p);
304 is_dir_nocase (guestfs_h *g, const char *path)
309 p = guestfs___case_sensitive_path_silently (g, path);
312 r = guestfs_is_dir (g, p);
317 /* Parse small, unsigned ints, as used in version numbers. */
319 guestfs___parse_unsigned_int (guestfs_h *g, const char *str)
322 int r = xstrtol (str, NULL, 10, &ret, "");
323 if (r != LONGINT_OK) {
324 error (g, _("could not parse integer in version number: %s"), str);
330 /* Like parse_unsigned_int, but ignore trailing stuff. */
332 guestfs___parse_unsigned_int_ignore_trailing (guestfs_h *g, const char *str)
335 int r = xstrtol (str, NULL, 10, &ret, NULL);
336 if (r != LONGINT_OK) {
337 error (g, _("could not parse integer in version number: %s"), str);
343 /* Parse generic MAJOR.MINOR from the fs->product_name string. */
345 guestfs___parse_major_minor (guestfs_h *g, struct inspect_fs *fs)
349 if (match2 (g, fs->product_name, re_major_minor, &major, &minor)) {
350 fs->major_version = guestfs___parse_unsigned_int (g, major);
352 if (fs->major_version == -1) {
356 fs->minor_version = guestfs___parse_unsigned_int (g, minor);
358 if (fs->minor_version == -1)
364 /* At the moment, package format and package management is just a
365 * simple function of the distro and major_version fields, so these
366 * can never return an error. We might be cleverer in future.
369 check_package_format (guestfs_h *g, struct inspect_fs *fs)
371 switch (fs->distro) {
372 case OS_DISTRO_FEDORA:
373 case OS_DISTRO_MEEGO:
374 case OS_DISTRO_REDHAT_BASED:
376 case OS_DISTRO_MANDRIVA:
377 case OS_DISTRO_CENTOS:
378 case OS_DISTRO_SCIENTIFIC_LINUX:
379 fs->package_format = OS_PACKAGE_FORMAT_RPM;
382 case OS_DISTRO_DEBIAN:
383 case OS_DISTRO_UBUNTU:
384 case OS_DISTRO_LINUX_MINT:
385 fs->package_format = OS_PACKAGE_FORMAT_DEB;
388 case OS_DISTRO_ARCHLINUX:
389 fs->package_format = OS_PACKAGE_FORMAT_PACMAN;
391 case OS_DISTRO_GENTOO:
392 fs->package_format = OS_PACKAGE_FORMAT_EBUILD;
394 case OS_DISTRO_PARDUS:
395 fs->package_format = OS_PACKAGE_FORMAT_PISI;
398 case OS_DISTRO_SLACKWARE:
399 case OS_DISTRO_WINDOWS:
400 case OS_DISTRO_UNKNOWN:
402 fs->package_format = OS_PACKAGE_FORMAT_UNKNOWN;
408 check_package_management (guestfs_h *g, struct inspect_fs *fs)
410 switch (fs->distro) {
411 case OS_DISTRO_FEDORA:
412 case OS_DISTRO_MEEGO:
413 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
416 case OS_DISTRO_REDHAT_BASED:
418 case OS_DISTRO_CENTOS:
419 case OS_DISTRO_SCIENTIFIC_LINUX:
420 if (fs->major_version >= 5)
421 fs->package_management = OS_PACKAGE_MANAGEMENT_YUM;
423 fs->package_management = OS_PACKAGE_MANAGEMENT_UP2DATE;
426 case OS_DISTRO_DEBIAN:
427 case OS_DISTRO_UBUNTU:
428 case OS_DISTRO_LINUX_MINT:
429 fs->package_management = OS_PACKAGE_MANAGEMENT_APT;
432 case OS_DISTRO_ARCHLINUX:
433 fs->package_management = OS_PACKAGE_MANAGEMENT_PACMAN;
435 case OS_DISTRO_GENTOO:
436 fs->package_management = OS_PACKAGE_MANAGEMENT_PORTAGE;
438 case OS_DISTRO_PARDUS:
439 fs->package_management = OS_PACKAGE_MANAGEMENT_PISI;
441 case OS_DISTRO_MANDRIVA:
442 fs->package_management = OS_PACKAGE_MANAGEMENT_URPMI;
445 case OS_DISTRO_SLACKWARE:
446 case OS_DISTRO_WINDOWS:
447 case OS_DISTRO_UNKNOWN:
449 fs->package_management = OS_PACKAGE_MANAGEMENT_UNKNOWN;
454 /* Get the first line of a small file, without any trailing newline
458 guestfs___first_line_of_file (guestfs_h *g, const char *filename)
464 /* Don't trust guestfs_head_n not to break with very large files.
465 * Check the file size is something reasonable first.
467 size = guestfs_filesize (g, filename);
469 /* guestfs_filesize failed and has already set error in handle */
471 if (size > MAX_SMALL_FILE_SIZE) {
472 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
477 lines = guestfs_head_n (g, 1, filename);
480 if (lines[0] == NULL) {
481 error (g, _("%s: file is empty"), filename);
482 guestfs___free_string_list (lines);
485 /* lines[1] should be NULL because of '1' argument above ... */
487 ret = lines[0]; /* caller frees */
488 free (lines); /* free the array */
493 /* Get the first matching line (using guestfs_egrep{,i}) of a small file,
494 * without any trailing newline character.
496 * Returns: 1 = returned a line (in *ret)
501 guestfs___first_egrep_of_file (guestfs_h *g, const char *filename,
502 const char *eregex, int iflag, char **ret)
508 /* Don't trust guestfs_egrep not to break with very large files.
509 * Check the file size is something reasonable first.
511 size = guestfs_filesize (g, filename);
513 /* guestfs_filesize failed and has already set error in handle */
515 if (size > MAX_SMALL_FILE_SIZE) {
516 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
521 lines = (!iflag ? guestfs_egrep : guestfs_egrepi) (g, eregex, filename);
524 if (lines[0] == NULL) {
525 guestfs___free_string_list (lines);
529 *ret = lines[0]; /* caller frees */
531 /* free up any other matches and the array itself */
532 for (i = 1; lines[i] != NULL; ++i)
539 #endif /* defined(HAVE_HIVEX) */