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 /* The main inspection code. */
51 guestfs__inspect_os (guestfs_h *g)
53 /* Remove any information previously stored in the handle. */
54 guestfs___free_inspect_info (g);
56 if (guestfs_umount_all (g) == -1)
59 /* Iterate over all possible devices. Try to mount each
60 * (read-only). Examine ones which contain filesystems and add that
61 * information to the handle.
63 /* Look to see if any devices directly contain filesystems (RHBZ#590167). */
65 devices = guestfs_list_devices (g);
70 for (i = 0; devices[i] != NULL; ++i) {
71 if (guestfs___check_for_filesystem_on (g, devices[i], 1, 0) == -1) {
72 guestfs___free_string_list (devices);
73 guestfs___free_inspect_info (g);
77 guestfs___free_string_list (devices);
79 /* Look at all partitions. */
81 partitions = guestfs_list_partitions (g);
82 if (partitions == NULL) {
83 guestfs___free_inspect_info (g);
87 for (i = 0; partitions[i] != NULL; ++i) {
88 if (guestfs___check_for_filesystem_on (g, partitions[i], 0, i+1) == -1) {
89 guestfs___free_string_list (partitions);
90 guestfs___free_inspect_info (g);
94 guestfs___free_string_list (partitions);
96 /* Look at all LVs. */
97 if (guestfs___feature_available (g, "lvm2")) {
99 lvs = guestfs_lvs (g);
101 guestfs___free_inspect_info (g);
105 for (i = 0; lvs[i] != NULL; ++i) {
106 if (guestfs___check_for_filesystem_on (g, lvs[i], 0, 0) == -1) {
107 guestfs___free_string_list (lvs);
108 guestfs___free_inspect_info (g);
112 guestfs___free_string_list (lvs);
115 /* At this point we have, in the handle, a list of all filesystems
116 * found and data about each one. Now we assemble the list of
117 * filesystems which are root devices and return that to the user.
118 * Fall through to guestfs__inspect_get_roots to do that.
120 char **ret = guestfs__inspect_get_roots (g);
122 guestfs___free_inspect_info (g);
127 compare_strings (const void *vp1, const void *vp2)
129 const char *s1 = * (char * const *) vp1;
130 const char *s2 = * (char * const *) vp2;
132 return strcmp (s1, s2);
136 guestfs__inspect_get_roots (guestfs_h *g)
138 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
144 for (i = 0; i < g->nr_fses; ++i)
145 if (g->fses[i].is_root)
148 char **ret = calloc (count+1, sizeof (char *));
150 perrorf (g, "calloc");
155 for (i = 0; i < g->nr_fses; ++i) {
156 if (g->fses[i].is_root) {
157 ret[count] = safe_strdup (g, g->fses[i].device);
163 qsort (ret, count, sizeof (char *), compare_strings);
169 guestfs__inspect_get_type (guestfs_h *g, const char *root)
171 struct inspect_fs *fs = guestfs___search_for_root (g, root);
177 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
178 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
179 case OS_TYPE_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
180 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
187 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
189 struct inspect_fs *fs = guestfs___search_for_root (g, root);
193 return safe_strdup (g, fs->arch ? : "unknown");
197 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
199 struct inspect_fs *fs = guestfs___search_for_root (g, root);
204 switch (fs->distro) {
205 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
206 case OS_DISTRO_CENTOS: ret = safe_strdup (g, "centos"); break;
207 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
208 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
209 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
210 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
211 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
212 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
213 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
214 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
215 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
216 case OS_DISTRO_SCIENTIFIC_LINUX: ret = safe_strdup (g, "scientificlinux"); break;
217 case OS_DISTRO_SLACKWARE: ret = safe_strdup (g, "slackware"); break;
218 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
219 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
220 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
227 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
229 struct inspect_fs *fs = guestfs___search_for_root (g, root);
233 return fs->major_version;
237 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
239 struct inspect_fs *fs = guestfs___search_for_root (g, root);
243 return fs->minor_version;
247 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
249 struct inspect_fs *fs = guestfs___search_for_root (g, root);
253 return safe_strdup (g, fs->product_name ? : "unknown");
257 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
259 struct inspect_fs *fs = guestfs___search_for_root (g, root);
263 return safe_strdup (g, fs->product_variant ? : "unknown");
267 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
269 struct inspect_fs *fs = guestfs___search_for_root (g, root);
273 if (!fs->windows_systemroot) {
274 error (g, _("not a Windows guest, or systemroot could not be determined"));
278 return safe_strdup (g, fs->windows_systemroot);
282 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
285 struct inspect_fs *fs = guestfs___search_for_root (g, root);
289 if (!fs->windows_current_control_set) {
290 error (g, _("not a Windows guest, or CurrentControlSet could not be determined"));
294 return safe_strdup (g, fs->windows_current_control_set);
298 guestfs__inspect_get_format (guestfs_h *g, const char *root)
300 struct inspect_fs *fs = guestfs___search_for_root (g, root);
305 switch (fs->format) {
306 case OS_FORMAT_INSTALLED: ret = safe_strdup (g, "installed"); break;
307 case OS_FORMAT_INSTALLER: ret = safe_strdup (g, "installer"); break;
308 case OS_FORMAT_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
315 guestfs__inspect_is_live (guestfs_h *g, const char *root)
317 struct inspect_fs *fs = guestfs___search_for_root (g, root);
321 return fs->is_live_disk;
325 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
327 struct inspect_fs *fs = guestfs___search_for_root (g, root);
331 return fs->is_netinst_disk;
335 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
337 struct inspect_fs *fs = guestfs___search_for_root (g, root);
341 return fs->is_multipart_disk;
345 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
347 struct inspect_fs *fs = guestfs___search_for_root (g, root);
353 /* If no fstab information (Windows) return just the root. */
354 if (fs->nr_fstab == 0) {
355 ret = calloc (3, sizeof (char *));
356 ret[0] = safe_strdup (g, "/");
357 ret[1] = safe_strdup (g, root);
362 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
364 for (i = 0; i < fs->nr_fstab; ++i)
368 /* Hashtables have 2N+1 entries. */
369 ret = calloc (2*count+1, sizeof (char *));
371 perrorf (g, "calloc");
376 for (i = 0; i < fs->nr_fstab; ++i)
378 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
379 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
388 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
390 struct inspect_fs *fs = guestfs___search_for_root (g, root);
396 /* If no fstab information (Windows) return just the root. */
397 if (fs->nr_fstab == 0) {
398 ret = calloc (2, sizeof (char *));
399 ret[0] = safe_strdup (g, root);
404 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
406 perrorf (g, "calloc");
411 for (i = 0; i < fs->nr_fstab; ++i)
412 ret[i] = safe_strdup (g, fs->fstab[i].device);
418 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
422 struct inspect_fs *fs;
424 fs = guestfs___search_for_root (g, root);
428 /* If no drive mappings, return an empty hashtable. */
429 if (!fs->drive_mappings)
432 for (count = 0; fs->drive_mappings[count] != NULL; count++)
436 ret = calloc (count+1, sizeof (char *));
438 perrorf (g, "calloc");
442 /* We need to make a deep copy of the hashtable since the caller
445 for (i = 0; i < count; ++i)
446 ret[i] = safe_strdup (g, fs->drive_mappings[i]);
454 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
456 struct inspect_fs *fs = guestfs___search_for_root (g, root);
461 switch (fs->package_format) {
462 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
463 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
464 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
465 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
466 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
467 case OS_PACKAGE_FORMAT_UNKNOWN:
469 ret = safe_strdup (g, "unknown");
477 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
479 struct inspect_fs *fs = guestfs___search_for_root (g, root);
484 switch (fs->package_management) {
485 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
486 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
487 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
488 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
489 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
490 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
491 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
492 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
494 ret = safe_strdup (g, "unknown");
502 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
504 struct inspect_fs *fs = guestfs___search_for_root (g, root);
508 return safe_strdup (g, fs->hostname ? : "unknown");
511 #else /* no hivex at compile time */
513 /* XXX These functions should be in an optgroup. */
515 #define NOT_IMPL(r) \
516 error (g, _("inspection API not available since this version of libguestfs was compiled without the hivex library")); \
520 guestfs__inspect_os (guestfs_h *g)
526 guestfs__inspect_get_roots (guestfs_h *g)
532 guestfs__inspect_get_type (guestfs_h *g, const char *root)
538 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
544 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
550 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
556 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
562 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
568 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
574 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
580 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
587 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
593 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
599 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
605 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
611 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
617 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
623 guestfs__inspect_get_format (guestfs_h *g, const char *root)
629 guestfs__inspect_is_live (guestfs_h *g, const char *root)
635 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
641 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
646 #endif /* no hivex at compile time */
649 guestfs___free_inspect_info (guestfs_h *g)
652 for (i = 0; i < g->nr_fses; ++i) {
653 free (g->fses[i].device);
654 free (g->fses[i].product_name);
655 free (g->fses[i].product_variant);
656 free (g->fses[i].arch);
657 free (g->fses[i].hostname);
658 free (g->fses[i].windows_systemroot);
659 free (g->fses[i].windows_current_control_set);
661 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
662 free (g->fses[i].fstab[j].device);
663 free (g->fses[i].fstab[j].mountpoint);
665 free (g->fses[i].fstab);
666 if (g->fses[i].drive_mappings)
667 guestfs___free_string_list (g->fses[i].drive_mappings);
674 /* In the Perl code this is a public function. */
676 guestfs___feature_available (guestfs_h *g, const char *feature)
678 /* If there's an error we should ignore it, so to do that we have to
679 * temporarily replace the error handler with a null one.
681 guestfs_error_handler_cb old_error_cb = g->error_cb;
684 const char *groups[] = { feature, NULL };
685 int r = guestfs_available (g, (char * const *) groups);
687 g->error_cb = old_error_cb;
689 return r == 0 ? 1 : 0;
692 /* Download a guest file to a local temporary file. The file is
693 * cached in the temporary directory, and is not downloaded again.
695 * The name of the temporary (downloaded) file is returned. The
696 * caller must free the pointer, but does *not* need to delete the
697 * temporary file. It will be deleted when the handle is closed.
699 * Refuse to download the guest file if it is larger than max_size.
700 * On this and other errors, NULL is returned.
702 * There is actually one cache per 'struct inspect_fs *' in order
703 * to handle the case of multiple roots.
706 guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs,
707 const char *filename,
708 const char *basename, int64_t max_size)
715 /* Make the basename unique by prefixing it with the fs number. */
716 if (asprintf (&r, "%s/%ld-%s", g->tmpdir, fs - g->fses, basename) == -1) {
717 perrorf (g, "asprintf");
721 /* If the file has already been downloaded, return. */
722 if (access (r, R_OK) == 0)
725 /* Check size of remote file. */
726 size = guestfs_filesize (g, filename);
728 /* guestfs_filesize failed and has already set error in handle */
730 if (size > max_size) {
731 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
736 fd = open (r, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0600);
738 perrorf (g, "open: %s", r);
742 snprintf (devfd, sizeof devfd, "/dev/fd/%d", fd);
744 if (guestfs_download (g, filename, devfd) == -1) {
750 if (close (fd) == -1) {
751 perrorf (g, "close: %s", r);
764 guestfs___search_for_root (guestfs_h *g, const char *root)
766 if (g->nr_fses == 0) {
767 error (g, _("no inspection data: call guestfs_inspect_os first"));
772 struct inspect_fs *fs;
773 for (i = 0; i < g->nr_fses; ++i) {
775 if (fs->is_root && STREQ (root, fs->device))
779 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),