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_FREEBSD: ret = safe_strdup (g, "freebsd"); break;
167 case OS_TYPE_LINUX: ret = safe_strdup (g, "linux"); break;
168 case OS_TYPE_NETBSD: ret = safe_strdup (g, "netbsd"); break;
169 case OS_TYPE_WINDOWS: ret = safe_strdup (g, "windows"); break;
170 case OS_TYPE_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
177 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
179 struct inspect_fs *fs = guestfs___search_for_root (g, root);
183 return safe_strdup (g, fs->arch ? : "unknown");
187 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
189 struct inspect_fs *fs = guestfs___search_for_root (g, root);
194 switch (fs->distro) {
195 case OS_DISTRO_ARCHLINUX: ret = safe_strdup (g, "archlinux"); break;
196 case OS_DISTRO_CENTOS: ret = safe_strdup (g, "centos"); break;
197 case OS_DISTRO_DEBIAN: ret = safe_strdup (g, "debian"); break;
198 case OS_DISTRO_FEDORA: ret = safe_strdup (g, "fedora"); break;
199 case OS_DISTRO_GENTOO: ret = safe_strdup (g, "gentoo"); break;
200 case OS_DISTRO_LINUX_MINT: ret = safe_strdup (g, "linuxmint"); break;
201 case OS_DISTRO_MAGEIA: ret = safe_strdup (g, "mageia"); break;
202 case OS_DISTRO_MANDRIVA: ret = safe_strdup (g, "mandriva"); break;
203 case OS_DISTRO_MEEGO: ret = safe_strdup (g, "meego"); break;
204 case OS_DISTRO_OPENSUSE: ret = safe_strdup (g, "opensuse"); break;
205 case OS_DISTRO_PARDUS: ret = safe_strdup (g, "pardus"); break;
206 case OS_DISTRO_REDHAT_BASED: ret = safe_strdup (g, "redhat-based"); break;
207 case OS_DISTRO_RHEL: ret = safe_strdup (g, "rhel"); break;
208 case OS_DISTRO_SCIENTIFIC_LINUX: ret = safe_strdup (g, "scientificlinux"); break;
209 case OS_DISTRO_SLACKWARE: ret = safe_strdup (g, "slackware"); break;
210 case OS_DISTRO_TTYLINUX: ret = safe_strdup (g, "ttylinux"); break;
211 case OS_DISTRO_WINDOWS: ret = safe_strdup (g, "windows"); break;
212 case OS_DISTRO_UBUNTU: ret = safe_strdup (g, "ubuntu"); break;
213 case OS_DISTRO_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
220 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
222 struct inspect_fs *fs = guestfs___search_for_root (g, root);
226 return fs->major_version;
230 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
232 struct inspect_fs *fs = guestfs___search_for_root (g, root);
236 return fs->minor_version;
240 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
242 struct inspect_fs *fs = guestfs___search_for_root (g, root);
246 return safe_strdup (g, fs->product_name ? : "unknown");
250 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
252 struct inspect_fs *fs = guestfs___search_for_root (g, root);
256 return safe_strdup (g, fs->product_variant ? : "unknown");
260 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
262 struct inspect_fs *fs = guestfs___search_for_root (g, root);
266 if (!fs->windows_systemroot) {
267 error (g, _("not a Windows guest, or systemroot could not be determined"));
271 return safe_strdup (g, fs->windows_systemroot);
275 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
278 struct inspect_fs *fs = guestfs___search_for_root (g, root);
282 if (!fs->windows_current_control_set) {
283 error (g, _("not a Windows guest, or CurrentControlSet could not be determined"));
287 return safe_strdup (g, fs->windows_current_control_set);
291 guestfs__inspect_get_format (guestfs_h *g, const char *root)
293 struct inspect_fs *fs = guestfs___search_for_root (g, root);
298 switch (fs->format) {
299 case OS_FORMAT_INSTALLED: ret = safe_strdup (g, "installed"); break;
300 case OS_FORMAT_INSTALLER: ret = safe_strdup (g, "installer"); break;
301 case OS_FORMAT_UNKNOWN: default: ret = safe_strdup (g, "unknown"); break;
308 guestfs__inspect_is_live (guestfs_h *g, const char *root)
310 struct inspect_fs *fs = guestfs___search_for_root (g, root);
314 return fs->is_live_disk;
318 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
320 struct inspect_fs *fs = guestfs___search_for_root (g, root);
324 return fs->is_netinst_disk;
328 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
330 struct inspect_fs *fs = guestfs___search_for_root (g, root);
334 return fs->is_multipart_disk;
338 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
340 struct inspect_fs *fs = guestfs___search_for_root (g, root);
346 /* If no fstab information (Windows) return just the root. */
347 if (fs->nr_fstab == 0) {
348 ret = calloc (3, sizeof (char *));
349 ret[0] = safe_strdup (g, "/");
350 ret[1] = safe_strdup (g, root);
355 #define CRITERION fs->fstab[i].mountpoint[0] == '/'
357 for (i = 0; i < fs->nr_fstab; ++i)
361 /* Hashtables have 2N+1 entries. */
362 ret = calloc (2*count+1, sizeof (char *));
364 perrorf (g, "calloc");
369 for (i = 0; i < fs->nr_fstab; ++i)
371 ret[2*count] = safe_strdup (g, fs->fstab[i].mountpoint);
372 ret[2*count+1] = safe_strdup (g, fs->fstab[i].device);
381 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
383 struct inspect_fs *fs = guestfs___search_for_root (g, root);
389 /* If no fstab information (Windows) return just the root. */
390 if (fs->nr_fstab == 0) {
391 ret = calloc (2, sizeof (char *));
392 ret[0] = safe_strdup (g, root);
397 ret = calloc (fs->nr_fstab + 1, sizeof (char *));
399 perrorf (g, "calloc");
404 for (i = 0; i < fs->nr_fstab; ++i)
405 ret[i] = safe_strdup (g, fs->fstab[i].device);
411 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
415 struct inspect_fs *fs;
417 fs = guestfs___search_for_root (g, root);
421 /* If no drive mappings, return an empty hashtable. */
422 if (!fs->drive_mappings)
425 for (count = 0; fs->drive_mappings[count] != NULL; count++)
429 ret = calloc (count+1, sizeof (char *));
431 perrorf (g, "calloc");
435 /* We need to make a deep copy of the hashtable since the caller
438 for (i = 0; i < count; ++i)
439 ret[i] = safe_strdup (g, fs->drive_mappings[i]);
447 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
449 struct inspect_fs *fs = guestfs___search_for_root (g, root);
454 switch (fs->package_format) {
455 case OS_PACKAGE_FORMAT_RPM: ret = safe_strdup (g, "rpm"); break;
456 case OS_PACKAGE_FORMAT_DEB: ret = safe_strdup (g, "deb"); break;
457 case OS_PACKAGE_FORMAT_PACMAN: ret = safe_strdup (g, "pacman"); break;
458 case OS_PACKAGE_FORMAT_EBUILD: ret = safe_strdup (g, "ebuild"); break;
459 case OS_PACKAGE_FORMAT_PISI: ret = safe_strdup (g, "pisi"); break;
460 case OS_PACKAGE_FORMAT_PKGSRC: ret = safe_strdup (g, "pkgsrc"); break;
461 case OS_PACKAGE_FORMAT_UNKNOWN:
463 ret = safe_strdup (g, "unknown");
471 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
473 struct inspect_fs *fs = guestfs___search_for_root (g, root);
478 switch (fs->package_management) {
479 case OS_PACKAGE_MANAGEMENT_YUM: ret = safe_strdup (g, "yum"); break;
480 case OS_PACKAGE_MANAGEMENT_UP2DATE: ret = safe_strdup (g, "up2date"); break;
481 case OS_PACKAGE_MANAGEMENT_APT: ret = safe_strdup (g, "apt"); break;
482 case OS_PACKAGE_MANAGEMENT_PACMAN: ret = safe_strdup (g, "pacman"); break;
483 case OS_PACKAGE_MANAGEMENT_PORTAGE: ret = safe_strdup (g, "portage"); break;
484 case OS_PACKAGE_MANAGEMENT_PISI: ret = safe_strdup (g, "pisi"); break;
485 case OS_PACKAGE_MANAGEMENT_URPMI: ret = safe_strdup (g, "urpmi"); break;
486 case OS_PACKAGE_MANAGEMENT_ZYPPER: ret = safe_strdup (g, "zypper"); break;
487 case OS_PACKAGE_MANAGEMENT_UNKNOWN:
489 ret = safe_strdup (g, "unknown");
497 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
499 struct inspect_fs *fs = guestfs___search_for_root (g, root);
503 return safe_strdup (g, fs->hostname ? : "unknown");
506 /* Download a guest file to a local temporary file. The file is
507 * cached in the temporary directory, and is not downloaded again.
509 * The name of the temporary (downloaded) file is returned. The
510 * caller must free the pointer, but does *not* need to delete the
511 * temporary file. It will be deleted when the handle is closed.
513 * Refuse to download the guest file if it is larger than max_size.
514 * On this and other errors, NULL is returned.
516 * There is actually one cache per 'struct inspect_fs *' in order
517 * to handle the case of multiple roots.
520 guestfs___download_to_tmp (guestfs_h *g, struct inspect_fs *fs,
521 const char *filename,
522 const char *basename, int64_t max_size)
529 /* Make the basename unique by prefixing it with the fs number. */
530 if (asprintf (&r, "%s/%ld-%s", g->tmpdir, fs - g->fses, basename) == -1) {
531 perrorf (g, "asprintf");
535 /* If the file has already been downloaded, return. */
536 if (access (r, R_OK) == 0)
539 /* Check size of remote file. */
540 size = guestfs_filesize (g, filename);
542 /* guestfs_filesize failed and has already set error in handle */
544 if (size > max_size) {
545 error (g, _("size of %s is unreasonably large (%" PRIi64 " bytes)"),
550 fd = open (r, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0600);
552 perrorf (g, "open: %s", r);
556 snprintf (devfd, sizeof devfd, "/dev/fd/%d", fd);
558 if (guestfs_download (g, filename, devfd) == -1) {
564 if (close (fd) == -1) {
565 perrorf (g, "close: %s", r);
578 guestfs___search_for_root (guestfs_h *g, const char *root)
580 if (g->nr_fses == 0) {
581 error (g, _("no inspection data: call guestfs_inspect_os first"));
586 struct inspect_fs *fs;
587 for (i = 0; i < g->nr_fses; ++i) {
589 if (fs->is_root && STREQ (root, fs->device))
593 error (g, _("%s: root device not found: only call this function with a root device previously returned by guestfs_inspect_os"),
598 #else /* no hivex at compile time */
600 /* XXX These functions should be in an optgroup. */
602 #define NOT_IMPL(r) \
603 error (g, _("inspection API not available since this version of libguestfs was compiled without the hivex library")); \
607 guestfs__inspect_os (guestfs_h *g)
613 guestfs__inspect_get_roots (guestfs_h *g)
619 guestfs__inspect_get_type (guestfs_h *g, const char *root)
625 guestfs__inspect_get_arch (guestfs_h *g, const char *root)
631 guestfs__inspect_get_distro (guestfs_h *g, const char *root)
637 guestfs__inspect_get_major_version (guestfs_h *g, const char *root)
643 guestfs__inspect_get_minor_version (guestfs_h *g, const char *root)
649 guestfs__inspect_get_product_name (guestfs_h *g, const char *root)
655 guestfs__inspect_get_product_variant (guestfs_h *g, const char *root)
661 guestfs__inspect_get_windows_systemroot (guestfs_h *g, const char *root)
667 guestfs__inspect_get_windows_current_control_set (guestfs_h *g,
674 guestfs__inspect_get_mountpoints (guestfs_h *g, const char *root)
680 guestfs__inspect_get_filesystems (guestfs_h *g, const char *root)
686 guestfs__inspect_get_drive_mappings (guestfs_h *g, const char *root)
692 guestfs__inspect_get_package_format (guestfs_h *g, const char *root)
698 guestfs__inspect_get_package_management (guestfs_h *g, const char *root)
704 guestfs__inspect_get_hostname (guestfs_h *g, const char *root)
710 guestfs__inspect_get_format (guestfs_h *g, const char *root)
716 guestfs__inspect_is_live (guestfs_h *g, const char *root)
722 guestfs__inspect_is_netinst (guestfs_h *g, const char *root)
728 guestfs__inspect_is_multipart (guestfs_h *g, const char *root)
733 #endif /* no hivex at compile time */
736 guestfs___free_inspect_info (guestfs_h *g)
739 for (i = 0; i < g->nr_fses; ++i) {
740 free (g->fses[i].device);
741 free (g->fses[i].product_name);
742 free (g->fses[i].product_variant);
743 free (g->fses[i].arch);
744 free (g->fses[i].hostname);
745 free (g->fses[i].windows_systemroot);
746 free (g->fses[i].windows_current_control_set);
748 for (j = 0; j < g->fses[i].nr_fstab; ++j) {
749 free (g->fses[i].fstab[j].device);
750 free (g->fses[i].fstab[j].mountpoint);
752 free (g->fses[i].fstab);
753 if (g->fses[i].drive_mappings)
754 guestfs___free_string_list (g->fses[i].drive_mappings);
761 /* In the Perl code this is a public function. */
763 guestfs___feature_available (guestfs_h *g, const char *feature)
765 /* If there's an error we should ignore it, so to do that we have to
766 * temporarily replace the error handler with a null one.
768 guestfs_error_handler_cb old_error_cb = g->error_cb;
771 const char *groups[] = { feature, NULL };
772 int r = guestfs_available (g, (char * const *) groups);
774 g->error_cb = old_error_cb;
776 return r == 0 ? 1 : 0;