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 guestfs__inspect_get_roots (guestfs_h *g)
129 /* NB. Doesn't matter if g->nr_fses == 0. We just return an empty
135 for (i = 0; i < g->nr_fses; ++i)
136 if (g->fses[i].is_root)
139 char **ret = calloc (count+1, sizeof (char *));
141 perrorf (g, "calloc");
146 for (i = 0; i < g->nr_fses; ++i) {
147 if (g->fses[i].is_root) {
148 ret[count] = safe_strdup (g, g->fses[i].device);
158 guestfs__inspect_get_type (guestfs_h *g, const char *root)
160 struct inspect_fs *fs = guestfs___search_for_root (g, root);
166 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
167 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
168 case OS_TYPE_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
169 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
176 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
178 struct inspect_fs *fs = guestfs___search_for_root (g, root);
182 return safe_strdup (g, fs->arch ? : "unknown");
186 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
188 struct inspect_fs *fs = guestfs___search_for_root (g, root);
193 switch (fs->distro) {
194 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
195 case OS_DISTRO_CENTOS: ret = safe_strdup (g, "centos"); break;
196 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
197 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
198 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
199 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
200 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
201 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
202 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
203 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
204 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
205 case OS_DISTRO_SCIENTIFIC_LINUX: ret = safe_strdup (g, "scientificlinux"); break;
206 case OS_DISTRO_SLACKWARE: ret = safe_strdup (g, "slackware"); break;
207 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
208 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
209 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
216 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
218 struct inspect_fs *fs = guestfs___search_for_root (g, root);
222 return fs->major_version;
226 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
228 struct inspect_fs *fs = guestfs___search_for_root (g, root);
232 return fs->minor_version;
236 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
238 struct inspect_fs *fs = guestfs___search_for_root (g, root);
242 return safe_strdup (g, fs->product_name ? : "unknown");
246 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
248 struct inspect_fs *fs = guestfs___search_for_root (g, root);
252 return safe_strdup (g, fs->product_variant ? : "unknown");
256 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
258 struct inspect_fs *fs = guestfs___search_for_root (g, root);
262 if (!fs->windows_systemroot) {
263 error (g, _("not a Windows guest, or systemroot could not be determined"));
267 return safe_strdup (g, fs->windows_systemroot);
271 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
274 struct inspect_fs *fs = guestfs___search_for_root (g, root);
278 if (!fs->windows_current_control_set) {
279 error (g, _("not a Windows guest, or CurrentControlSet could not be determined"));
283 return safe_strdup (g, fs->windows_current_control_set);
287 guestfs__inspect_get_format (guestfs_h *g, const char *root)
289 struct inspect_fs *fs = guestfs___search_for_root (g, root);
294 switch (fs->format) {
295 case OS_FORMAT_INSTALLED: ret = safe_strdup (g, "installed"); break;
296 case OS_FORMAT_INSTALLER: ret = safe_strdup (g, "installer"); break;
297 case OS_FORMAT_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
304 guestfs__inspect_is_live (guestfs_h *g, const char *root)
306 struct inspect_fs *fs = guestfs___search_for_root (g, root);
310 return fs->is_live_disk;
314 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
316 struct inspect_fs *fs = guestfs___search_for_root (g, root);
320 return fs->is_netinst_disk;
324 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
326 struct inspect_fs *fs = guestfs___search_for_root (g, root);
330 return fs->is_multipart_disk;
334 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
336 struct inspect_fs *fs = guestfs___search_for_root (g, root);
342 /* If no fstab information (Windows) return just the root. */
343 if (fs->nr_fstab == 0) {
344 ret = calloc (3, sizeof (char *));
345 ret[0] = safe_strdup (g, "/");
346 ret[1] = safe_strdup (g, root);
351 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
353 for (i = 0; i < fs->nr_fstab; ++i)
357 /* Hashtables have 2N+1 entries. */
358 ret = calloc (2*count+1, sizeof (char *));
360 perrorf (g, "calloc");
365 for (i = 0; i < fs->nr_fstab; ++i)
367 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
368 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
377 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
379 struct inspect_fs *fs = guestfs___search_for_root (g, root);
385 /* If no fstab information (Windows) return just the root. */
386 if (fs->nr_fstab == 0) {
387 ret = calloc (2, sizeof (char *));
388 ret[0] = safe_strdup (g, root);
393 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
395 perrorf (g, "calloc");
400 for (i = 0; i < fs->nr_fstab; ++i)
401 ret[i] = safe_strdup (g, fs->fstab[i].device);
407 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
411 struct inspect_fs *fs;
413 fs = guestfs___search_for_root (g, root);
417 /* If no drive mappings, return an empty hashtable. */
418 if (!fs->drive_mappings)
421 for (count = 0; fs->drive_mappings[count] != NULL; count++)
425 ret = calloc (count+1, sizeof (char *));
427 perrorf (g, "calloc");
431 /* We need to make a deep copy of the hashtable since the caller
434 for (i = 0; i < count; ++i)
435 ret[i] = safe_strdup (g, fs->drive_mappings[i]);
443 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
445 struct inspect_fs *fs = guestfs___search_for_root (g, root);
450 switch (fs->package_format) {
451 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
452 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
453 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
454 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
455 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
456 case OS_PACKAGE_FORMAT_UNKNOWN:
458 ret = safe_strdup (g, "unknown");
466 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
468 struct inspect_fs *fs = guestfs___search_for_root (g, root);
473 switch (fs->package_management) {
474 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
475 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
476 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
477 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
478 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
479 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
480 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
481 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
483 ret = safe_strdup (g, "unknown");
491 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
493 struct inspect_fs *fs = guestfs___search_for_root (g, root);
497 return safe_strdup (g, fs->hostname ? : "unknown");
500 /* Download a guest file to a local temporary file. The file is
501 * cached in the temporary directory, and is not downloaded again.
503 * The name of the temporary (downloaded) file is returned. The
504 * caller must free the pointer, but does *not* need to delete the
505 * temporary file. It will be deleted when the handle is closed.
507 * Refuse to download the guest file if it is larger than max_size.
508 * On this and other errors, NULL is returned.
510 * There is actually one cache per 'struct inspect_fs *' in order
511 * to handle the case of multiple roots.
514 guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs,
515 const char *filename,
516 const char *basename, int64_t max_size)
523 /* Make the basename unique by prefixing it with the fs number. */
524 if (asprintf (&r, "%s/%ld-%s", g->tmpdir, fs - g->fses, basename) == -1) {
525 perrorf (g, "asprintf");
529 /* If the file has already been downloaded, return. */
530 if (access (r, R_OK) == 0)
533 /* Check size of remote file. */
534 size = guestfs_filesize (g, filename);
536 /* guestfs_filesize failed and has already set error in handle */
538 if (size > max_size) {
539 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
544 fd = open (r, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0600);
546 perrorf (g, "open: %s", r);
550 snprintf (devfd, sizeof devfd, "/dev/fd/%d", fd);
552 if (guestfs_download (g, filename, devfd) == -1) {
558 if (close (fd) == -1) {
559 perrorf (g, "close: %s", r);
572 guestfs___search_for_root (guestfs_h *g, const char *root)
574 if (g->nr_fses == 0) {
575 error (g, _("no inspection data: call guestfs_inspect_os first"));
580 struct inspect_fs *fs;
581 for (i = 0; i < g->nr_fses; ++i) {
583 if (fs->is_root && STREQ (root, fs->device))
587 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
592 #else /* no hivex at compile time */
594 /* XXX These functions should be in an optgroup. */
596 #define NOT_IMPL(r) \
597 error (g, _("inspection API not available since this version of libguestfs was compiled without the hivex library")); \
601 guestfs__inspect_os (guestfs_h *g)
607 guestfs__inspect_get_roots (guestfs_h *g)
613 guestfs__inspect_get_type (guestfs_h *g, const char *root)
619 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
625 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
631 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
637 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
643 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
649 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
655 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
661 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
668 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
674 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
680 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
686 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
692 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
698 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
704 guestfs__inspect_get_format (guestfs_h *g, const char *root)
710 guestfs__inspect_is_live (guestfs_h *g, const char *root)
716 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
722 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
727 #endif /* no hivex at compile time */
730 guestfs___free_inspect_info (guestfs_h *g)
733 for (i = 0; i < g->nr_fses; ++i) {
734 free (g->fses[i].device);
735 free (g->fses[i].product_name);
736 free (g->fses[i].product_variant);
737 free (g->fses[i].arch);
738 free (g->fses[i].hostname);
739 free (g->fses[i].windows_systemroot);
740 free (g->fses[i].windows_current_control_set);
742 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
743 free (g->fses[i].fstab[j].device);
744 free (g->fses[i].fstab[j].mountpoint);
746 free (g->fses[i].fstab);
747 if (g->fses[i].drive_mappings)
748 guestfs___free_string_list (g->fses[i].drive_mappings);
755 /* In the Perl code this is a public function. */
757 guestfs___feature_available (guestfs_h *g, const char *feature)
759 /* If there's an error we should ignore it, so to do that we have to
760 * temporarily replace the error handler with a null one.
762 guestfs_error_handler_cb old_error_cb = g->error_cb;
765 const char *groups[] = { feature, NULL };
766 int r = guestfs_available (g, (char * const *) groups);
768 g->error_cb = old_error_cb;
770 return r == 0 ? 1 : 0;