OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qemu-ga patch queue for soft-freeze 

* add guest-get-disks for w32/linux
 * add guest-{add,remove,get}-authorized-keys
 * fix API violations and schema documentation inconsistencies with
   recently-added guest-get-devices
 
 v3:
 - fix checkpatch errors regarding disallowed usages of g_assert*
   macros and other warnings
 
 v2:
 - fix BSD build error due to missing stub for guest_get_disks
 - fix clang build error on linux due to unused variable
 - disable qga-ssh-test for now due to a memory leak within GLib when
   G_TEST_OPTION_ISOLATE_DIRS is passed to g_test_init() since it
   break Gitlab CI build-oss-fuzz test
 - rebased and re-tested on master
 -----BEGIN PGP SIGNATURE-----
 
 iQFJBAABCgAzFiEEzqzJ4VU066u4LT+gM1PJzvEItYQFAl+gwNoVHG1pY2hhZWwu
 cm90aEBhbWQuY29tAAoJEDNTyc7xCLWEWK0H/1ThOQTqLEy7jKqQI5t2mcJxqMqS
 4B8Ob7BnoMuiLqzsFJBSajf9LzbYYiuyVg/1jintffpCd6ygQLL97PPX2ZL9FS1Q
 ZJanFxVDcYcqcnpr5zEnc97IieVt3h6kHTo4Gw7exxzzQaofTdc+JcCaxyMy1rGH
 fagNyk9CZDxdfqm71b2ZAT/y9Oylg4rkkZEP7QuQpFLkUwRjbmfH7z0emIoNMoVJ
 I0NCRnVIGmn8CrCOttO4lmlLyty5xR9s996MvA4uyZ26F/tTzw7ybfa8fHLVIHgg
 LLO2VDL63pnD6G9D+szkwI+2pkTaTLyMsqVK+c63BNnj4RPYM+iU4ziD43Y=
 =M/ca
 -----END PGP SIGNATURE-----

Merge remote-tracking branch 'remotes/mdroth/tags/qga-pull-2020-10-27-v3-tag' into staging

qemu-ga patch queue for soft-freeze

* add guest-get-disks for w32/linux
* add guest-{add,remove,get}-authorized-keys
* fix API violations and schema documentation inconsistencies with
  recently-added guest-get-devices

v3:
- fix checkpatch errors regarding disallowed usages of g_assert*
  macros and other warnings

v2:
- fix BSD build error due to missing stub for guest_get_disks
- fix clang build error on linux due to unused variable
- disable qga-ssh-test for now due to a memory leak within GLib when
  G_TEST_OPTION_ISOLATE_DIRS is passed to g_test_init() since it
  break Gitlab CI build-oss-fuzz test
- rebased and re-tested on master

# gpg: Signature made Tue 03 Nov 2020 02:30:50 GMT
# gpg:                using RSA key CEACC9E15534EBABB82D3FA03353C9CEF108B584
# gpg:                issuer "michael.roth@amd.com"
# gpg: Good signature from "Michael Roth <flukshun@gmail.com>" [full]
# gpg:                 aka "Michael Roth <mdroth@utexas.edu>" [full]
# gpg:                 aka "Michael Roth <mdroth@linux.vnet.ibm.com>" [full]
# Primary key fingerprint: CEAC C9E1 5534 EBAB B82D  3FA0 3353 C9CE F108 B584

* remotes/mdroth/tags/qga-pull-2020-10-27-v3-tag:
  qga: add ssh-get-authorized-keys
  meson: minor simplification
  qga: add *reset argument to ssh-add-authorized-keys
  qga: add ssh-{add,remove}-authorized-keys
  glib-compat: add g_unix_get_passwd_entry_qemu()
  qga: add implementation of guest-get-disks for Windows
  qga: add implementation of guest-get-disks for Linux
  qga: add command guest-get-disks
  qga: Flatten simple union GuestDeviceId
  qga-win: Fix guest-get-devices error API violations
  qga: Use common time encoding for guest-get-devices 'driver-date'
  qga: Rename guest-get-devices return member 'address' to 'id'

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
Peter Maydell 2020-11-03 12:47:58 +00:00
parent c7a7a877b7 cad97c08a1
commit 83851c7c60
6 changed files with 1107 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
include/glib-compat.h
View File

@ -30,6 +30,11 @@
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#include <glib.h>
#if defined(G_OS_UNIX)
#include <glib-unix.h>
#include <sys/types.h>
#include <pwd.h>
#endif
/*
* Note that because of the GLIB_VERSION_MAX_ALLOWED constant above, allowing
@ -72,6 +77,29 @@
gint g_poll_fixed(GPollFD *fds, guint nfds, gint timeout);
#endif
#if defined(G_OS_UNIX)
/*
* Note: The fallback implementation is not MT-safe, and it returns a copy of
* the libc passwd (must be g_free() after use) but not the content. Because of
* these important differences the caller must be aware of, it's not #define for
* GLib API substitution.
*/
static inline struct passwd *
g_unix_get_passwd_entry_qemu(const gchar *user_name, GError **error)
{
#if GLIB_CHECK_VERSION(2, 64, 0)
return g_unix_get_passwd_entry(user_name, error);
#else
struct passwd *p = getpwnam(user_name);
if (!p) {
g_set_error_literal(error, G_UNIX_ERROR, 0, g_strerror(errno));
return NULL;
}
return (struct passwd *)g_memdup(p, sizeof(*p));
#endif
}
#endif /* G_OS_UNIX */
#pragma GCC diagnostic pop
#endif

516
qga/commands-posix-ssh.c Normal file
View File

@ -0,0 +1,516 @@
/*
* This work is licensed under the terms of the GNU GPL, version 2 or later.
* See the COPYING file in the top-level directory.
*/
#include "qemu/osdep.h"
#include <glib-unix.h>
#include <glib/gstdio.h>
#include <locale.h>
#include <pwd.h>
#include "qapi/error.h"
#include "qga-qapi-commands.h"
#ifdef QGA_BUILD_UNIT_TEST
static struct passwd *
test_get_passwd_entry(const gchar *user_name, GError **error)
{
struct passwd *p;
int ret;
if (!user_name || g_strcmp0(user_name, g_get_user_name())) {
g_set_error(error, G_UNIX_ERROR, 0, "Invalid user name");
return NULL;
}
p = g_new0(struct passwd, 1);
p->pw_dir = (char *)g_get_home_dir();
p->pw_uid = geteuid();
p->pw_gid = getegid();
ret = g_mkdir_with_parents(p->pw_dir, 0700);
g_assert(ret == 0);
return p;
}
#define g_unix_get_passwd_entry_qemu(username, err) \
test_get_passwd_entry(username, err)
#endif
static struct passwd *
get_passwd_entry(const char *username, Error **errp)
{
g_autoptr(GError) err = NULL;
struct passwd *p;
ERRP_GUARD();
p = g_unix_get_passwd_entry_qemu(username, &err);
if (p == NULL) {
error_setg(errp, "failed to lookup user '%s': %s",
username, err->message);
return NULL;
}
return p;
}
static bool
mkdir_for_user(const char *path, const struct passwd *p,
mode_t mode, Error **errp)
{
ERRP_GUARD();
if (g_mkdir(path, mode) == -1) {
error_setg(errp, "failed to create directory '%s': %s",
path, g_strerror(errno));
return false;
}
if (chown(path, p->pw_uid, p->pw_gid) == -1) {
error_setg(errp, "failed to set ownership of directory '%s': %s",
path, g_strerror(errno));
return false;
}
if (chmod(path, mode) == -1) {
error_setg(errp, "failed to set permissions of directory '%s': %s",
path, g_strerror(errno));
return false;
}
return true;
}
static bool
check_openssh_pub_key(const char *key, Error **errp)
{
ERRP_GUARD();
/* simple sanity-check, we may want more? */
if (!key || key[0] == '#' || strchr(key, '\n')) {
error_setg(errp, "invalid OpenSSH public key: '%s'", key);
return false;
}
return true;
}
static bool
check_openssh_pub_keys(strList *keys, size_t *nkeys, Error **errp)
{
size_t n = 0;
strList *k;
ERRP_GUARD();
for (k = keys; k != NULL; k = k->next) {
if (!check_openssh_pub_key(k->value, errp)) {
return false;
}
n++;
}
if (nkeys) {
*nkeys = n;
}
return true;
}
static bool
write_authkeys(const char *path, const GStrv keys,
const struct passwd *p, Error **errp)
{
g_autofree char *contents = NULL;
g_autoptr(GError) err = NULL;
ERRP_GUARD();
contents = g_strjoinv("\n", keys);
if (!g_file_set_contents(path, contents, -1, &err)) {
error_setg(errp, "failed to write to '%s': %s", path, err->message);
return false;
}
if (chown(path, p->pw_uid, p->pw_gid) == -1) {
error_setg(errp, "failed to set ownership of directory '%s': %s",
path, g_strerror(errno));
return false;
}
if (chmod(path, 0600) == -1) {
error_setg(errp, "failed to set permissions of '%s': %s",
path, g_strerror(errno));
return false;
}
return true;
}
static GStrv
read_authkeys(const char *path, Error **errp)
{
g_autoptr(GError) err = NULL;
g_autofree char *contents = NULL;
ERRP_GUARD();
if (!g_file_get_contents(path, &contents, NULL, &err)) {
error_setg(errp, "failed to read '%s': %s", path, err->message);
return NULL;
}
return g_strsplit(contents, "\n", -1);
}
void
qmp_guest_ssh_add_authorized_keys(const char *username, strList *keys,
bool has_reset, bool reset,
Error **errp)
{
g_autofree struct passwd *p = NULL;
g_autofree char *ssh_path = NULL;
g_autofree char *authkeys_path = NULL;
g_auto(GStrv) authkeys = NULL;
strList *k;
size_t nkeys, nauthkeys;
ERRP_GUARD();
reset = has_reset && reset;
if (!check_openssh_pub_keys(keys, &nkeys, errp)) {
return;
}
p = get_passwd_entry(username, errp);
if (p == NULL) {
return;
}
ssh_path = g_build_filename(p->pw_dir, ".ssh", NULL);
authkeys_path = g_build_filename(ssh_path, "authorized_keys", NULL);
if (!reset) {
authkeys = read_authkeys(authkeys_path, NULL);
}
if (authkeys == NULL) {
if (!g_file_test(ssh_path, G_FILE_TEST_IS_DIR) &&
!mkdir_for_user(ssh_path, p, 0700, errp)) {
return;
}
}
nauthkeys = authkeys ? g_strv_length(authkeys) : 0;
authkeys = g_realloc_n(authkeys, nauthkeys + nkeys + 1, sizeof(char *));
memset(authkeys + nauthkeys, 0, (nkeys + 1) * sizeof(char *));
for (k = keys; k != NULL; k = k->next) {
if (g_strv_contains((const gchar * const *)authkeys, k->value)) {
continue;
}
authkeys[nauthkeys++] = g_strdup(k->value);
}
write_authkeys(authkeys_path, authkeys, p, errp);
}
void
qmp_guest_ssh_remove_authorized_keys(const char *username, strList *keys,
Error **errp)
{
g_autofree struct passwd *p = NULL;
g_autofree char *authkeys_path = NULL;
g_autofree GStrv new_keys = NULL; /* do not own the strings */
g_auto(GStrv) authkeys = NULL;
GStrv a;
size_t nkeys = 0;
ERRP_GUARD();
if (!check_openssh_pub_keys(keys, NULL, errp)) {
return;
}
p = get_passwd_entry(username, errp);
if (p == NULL) {
return;
}
authkeys_path = g_build_filename(p->pw_dir, ".ssh",
"authorized_keys", NULL);
if (!g_file_test(authkeys_path, G_FILE_TEST_EXISTS)) {
return;
}
authkeys = read_authkeys(authkeys_path, errp);
if (authkeys == NULL) {
return;
}
new_keys = g_new0(char *, g_strv_length(authkeys) + 1);
for (a = authkeys; *a != NULL; a++) {
strList *k;
for (k = keys; k != NULL; k = k->next) {
if (g_str_equal(k->value, *a)) {
break;
}
}
if (k != NULL) {
continue;
}
new_keys[nkeys++] = *a;
}
write_authkeys(authkeys_path, new_keys, p, errp);
}
GuestAuthorizedKeys *
qmp_guest_ssh_get_authorized_keys(const char *username, Error **errp)
{
g_autofree struct passwd *p = NULL;
g_autofree char *authkeys_path = NULL;
g_auto(GStrv) authkeys = NULL;
g_autoptr(GuestAuthorizedKeys) ret = NULL;
int i;
ERRP_GUARD();
p = get_passwd_entry(username, errp);
if (p == NULL) {
return NULL;
}
authkeys_path = g_build_filename(p->pw_dir, ".ssh",
"authorized_keys", NULL);
authkeys = read_authkeys(authkeys_path, errp);
if (authkeys == NULL) {
return NULL;
}
ret = g_new0(GuestAuthorizedKeys, 1);
for (i = 0; authkeys[i] != NULL; i++) {
strList *new;
g_strstrip(authkeys[i]);
if (!authkeys[i][0] || authkeys[i][0] == '#') {
continue;
}
new = g_new0(strList, 1);
new->value = g_strdup(authkeys[i]);
new->next = ret->keys;
ret->keys = new;
}
return g_steal_pointer(&ret);
}
#ifdef QGA_BUILD_UNIT_TEST
#if GLIB_CHECK_VERSION(2, 60, 0)
static const strList test_key2 = {
.value = (char *)"algo key2 comments"
};
static const strList test_key1_2 = {
.value = (char *)"algo key1 comments",
.next = (strList *)&test_key2,
};
static char *
test_get_authorized_keys_path(void)
{
return g_build_filename(g_get_home_dir(), ".ssh", "authorized_keys", NULL);
}
static void
test_authorized_keys_set(const char *contents)
{
g_autoptr(GError) err = NULL;
g_autofree char *path = NULL;
int ret;
path = g_build_filename(g_get_home_dir(), ".ssh", NULL);
ret = g_mkdir_with_parents(path, 0700);
g_assert(ret == 0);
g_free(path);
path = test_get_authorized_keys_path();
g_file_set_contents(path, contents, -1, &err);
g_assert(err == NULL);
}
static void
test_authorized_keys_equal(const char *expected)
{
g_autoptr(GError) err = NULL;
g_autofree char *path = NULL;
g_autofree char *contents = NULL;
path = test_get_authorized_keys_path();
g_file_get_contents(path, &contents, NULL, &err);
g_assert(err == NULL);
g_assert(g_strcmp0(contents, expected) == 0);
}
static void
test_invalid_user(void)
{
Error *err = NULL;
qmp_guest_ssh_add_authorized_keys("", NULL, FALSE, FALSE, &err);
error_free_or_abort(&err);
qmp_guest_ssh_remove_authorized_keys("", NULL, &err);
error_free_or_abort(&err);
}
static void
test_invalid_key(void)
{
strList key = {
.value = (char *)"not a valid\nkey"
};
Error *err = NULL;
qmp_guest_ssh_add_authorized_keys(g_get_user_name(), &key,
FALSE, FALSE, &err);
error_free_or_abort(&err);
qmp_guest_ssh_remove_authorized_keys(g_get_user_name(), &key, &err);
error_free_or_abort(&err);
}
static void
test_add_keys(void)
{
Error *err = NULL;
qmp_guest_ssh_add_authorized_keys(g_get_user_name(),
(strList *)&test_key2,
FALSE, FALSE,
&err);
g_assert(err == NULL);
test_authorized_keys_equal("algo key2 comments");
qmp_guest_ssh_add_authorized_keys(g_get_user_name(),
(strList *)&test_key1_2,
FALSE, FALSE,
&err);
g_assert(err == NULL);
/* key2 came first, and should'nt be duplicated */
test_authorized_keys_equal("algo key2 comments\n"
"algo key1 comments");
}
static void
test_add_reset_keys(void)
{
Error *err = NULL;
qmp_guest_ssh_add_authorized_keys(g_get_user_name(),
(strList *)&test_key1_2,
FALSE, FALSE,
&err);
g_assert(err == NULL);
/* reset with key2 only */
test_authorized_keys_equal("algo key1 comments\n"
"algo key2 comments");
qmp_guest_ssh_add_authorized_keys(g_get_user_name(),
(strList *)&test_key2,
TRUE, TRUE,
&err);
g_assert(err == NULL);
test_authorized_keys_equal("algo key2 comments");
/* empty should clear file */
qmp_guest_ssh_add_authorized_keys(g_get_user_name(),
(strList *)NULL,
TRUE, TRUE,
&err);
g_assert(err == NULL);
test_authorized_keys_equal("");
}
static void
test_remove_keys(void)
{
Error *err = NULL;
static const char *authkeys =
"algo key1 comments\n"
/* originally duplicated */
"algo key1 comments\n"
"# a commented line\n"
"algo some-key another\n";
test_authorized_keys_set(authkeys);
qmp_guest_ssh_remove_authorized_keys(g_get_user_name(),
(strList *)&test_key2, &err);
g_assert(err == NULL);
test_authorized_keys_equal(authkeys);
qmp_guest_ssh_remove_authorized_keys(g_get_user_name(),
(strList *)&test_key1_2, &err);
g_assert(err == NULL);
test_authorized_keys_equal("# a commented line\n"
"algo some-key another\n");
}
static void
test_get_keys(void)
{
Error *err = NULL;
static const char *authkeys =
"algo key1 comments\n"
"# a commented line\n"
"algo some-key another\n";
g_autoptr(GuestAuthorizedKeys) ret = NULL;
strList *k;
size_t len = 0;
test_authorized_keys_set(authkeys);
ret = qmp_guest_ssh_get_authorized_keys(g_get_user_name(), &err);
g_assert(err == NULL);
for (len = 0, k = ret->keys; k != NULL; k = k->next) {
g_assert(g_str_has_prefix(k->value, "algo "));
len++;
}
g_assert(len == 2);
}
int main(int argc, char *argv[])
{
setlocale(LC_ALL, "");
g_test_init(&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
g_test_add_func("/qga/ssh/invalid_user", test_invalid_user);
g_test_add_func("/qga/ssh/invalid_key", test_invalid_key);
g_test_add_func("/qga/ssh/add_keys", test_add_keys);
g_test_add_func("/qga/ssh/add_reset_keys", test_add_reset_keys);
g_test_add_func("/qga/ssh/remove_keys", test_remove_keys);
g_test_add_func("/qga/ssh/get_keys", test_get_keys);
return g_test_run();
}
#else
int main(int argc, char *argv[])
{
g_test_message("test skipped, needs glib >= 2.60");
return 0;
}
#endif /* GLIB_2_60 */
#endif /* BUILD_UNIT_TEST */

299
qga/commands-posix.c
View File

@ -1150,13 +1150,27 @@ static void build_guest_fsinfo_for_virtual_device(char const *syspath,
closedir(dir);
}
static bool is_disk_virtual(const char *devpath, Error **errp)
{
g_autofree char *syspath = realpath(devpath, NULL);
if (!syspath) {
error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
return false;
}
return strstr(syspath, "/devices/virtual/block/") != NULL;
}
/* Dispatch to functions for virtual/real device */
static void build_guest_fsinfo_for_device(char const *devpath,
GuestFilesystemInfo *fs,
Error **errp)
{
char *syspath = realpath(devpath, NULL);
ERRP_GUARD();
g_autofree char *syspath = NULL;
bool is_virtual = false;
syspath = realpath(devpath, NULL);
if (!syspath) {
error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
return;
@ -1167,16 +1181,281 @@ static void build_guest_fsinfo_for_device(char const *devpath,
}
g_debug(" parse sysfs path '%s'", syspath);
if (strstr(syspath, "/devices/virtual/block/")) {
is_virtual = is_disk_virtual(syspath, errp);
if (*errp != NULL) {
return;
}
if (is_virtual) {
build_guest_fsinfo_for_virtual_device(syspath, fs, errp);
} else {
build_guest_fsinfo_for_real_device(syspath, fs, errp);
}
free(syspath);
}
#ifdef CONFIG_LIBUDEV
/*
* Wrapper around build_guest_fsinfo_for_device() for getting just
* the disk address.
*/
static GuestDiskAddress *get_disk_address(const char *syspath, Error **errp)
{
g_autoptr(GuestFilesystemInfo) fs = NULL;
fs = g_new0(GuestFilesystemInfo, 1);
build_guest_fsinfo_for_device(syspath, fs, errp);
if (fs->disk != NULL) {
return g_steal_pointer(&fs->disk->value);
}
return NULL;
}
static char *get_alias_for_syspath(const char *syspath)
{
struct udev *udev = NULL;
struct udev_device *udevice = NULL;
char *ret = NULL;
udev = udev_new();
if (udev == NULL) {
g_debug("failed to query udev");
goto out;
}
udevice = udev_device_new_from_syspath(udev, syspath);
if (udevice == NULL) {
g_debug("failed to query udev for path: %s", syspath);
goto out;
} else {
const char *alias = udev_device_get_property_value(
udevice, "DM_NAME");
/*
* NULL means there was an error and empty string means there is no
* alias. In case of no alias we return NULL instead of empty string.
*/
if (alias == NULL) {
g_debug("failed to query udev for device alias for: %s",
syspath);
} else if (*alias != 0) {
ret = g_strdup(alias);
}
}
out:
udev_unref(udev);
udev_device_unref(udevice);
return ret;
}
static char *get_device_for_syspath(const char *syspath)
{
struct udev *udev = NULL;
struct udev_device *udevice = NULL;
char *ret = NULL;
udev = udev_new();
if (udev == NULL) {
g_debug("failed to query udev");
goto out;
}
udevice = udev_device_new_from_syspath(udev, syspath);
if (udevice == NULL) {
g_debug("failed to query udev for path: %s", syspath);
goto out;
} else {
ret = g_strdup(udev_device_get_devnode(udevice));
}
out:
udev_unref(udev);
udev_device_unref(udevice);
return ret;
}
static void get_disk_deps(const char *disk_dir, GuestDiskInfo *disk)
{
g_autofree char *deps_dir = NULL;
const gchar *dep;
GDir *dp_deps = NULL;
/* List dependent disks */
deps_dir = g_strdup_printf("%s/slaves", disk_dir);
g_debug(" listing entries in: %s", deps_dir);
dp_deps = g_dir_open(deps_dir, 0, NULL);
if (dp_deps == NULL) {
g_debug("failed to list entries in %s", deps_dir);
return;
}
while ((dep = g_dir_read_name(dp_deps)) != NULL) {
g_autofree char *dep_dir = NULL;
strList *dep_item = NULL;
char *dev_name;
/* Add dependent disks */
dep_dir = g_strdup_printf("%s/%s", deps_dir, dep);
dev_name = get_device_for_syspath(dep_dir);
if (dev_name != NULL) {
g_debug(" adding dependent device: %s", dev_name);
dep_item = g_new0(strList, 1);
dep_item->value = dev_name;
dep_item->next = disk->dependents;
disk->dependents = dep_item;
}
}
g_dir_close(dp_deps);
}
/*
* Detect partitions subdirectory, name is "<disk_name><number>" or
* "<disk_name>p<number>"
*
* @disk_name -- last component of /sys path (e.g. sda)
* @disk_dir -- sys path of the disk (e.g. /sys/block/sda)
* @disk_dev -- device node of the disk (e.g. /dev/sda)
*/
static GuestDiskInfoList *get_disk_partitions(
GuestDiskInfoList *list,
const char *disk_name, const char *disk_dir,
const char *disk_dev)
{
GuestDiskInfoList *item, *ret = list;
struct dirent *de_disk;
DIR *dp_disk = NULL;
size_t len = strlen(disk_name);
dp_disk = opendir(disk_dir);
while ((de_disk = readdir(dp_disk)) != NULL) {
g_autofree char *partition_dir = NULL;
char *dev_name;
GuestDiskInfo *partition;
if (!(de_disk->d_type & DT_DIR)) {
continue;
}
if (!(strncmp(disk_name, de_disk->d_name, len) == 0 &&
((*(de_disk->d_name + len) == 'p' &&
isdigit(*(de_disk->d_name + len + 1))) ||
isdigit(*(de_disk->d_name + len))))) {
continue;
}
partition_dir = g_strdup_printf("%s/%s",
disk_dir, de_disk->d_name);
dev_name = get_device_for_syspath(partition_dir);
if (dev_name == NULL) {
g_debug("Failed to get device name for syspath: %s",
disk_dir);
continue;
}
partition = g_new0(GuestDiskInfo, 1);
partition->name = dev_name;
partition->partition = true;
/* Add parent disk as dependent for easier tracking of hierarchy */
partition->dependents = g_new0(strList, 1);
partition->dependents->value = g_strdup(disk_dev);
item = g_new0(GuestDiskInfoList, 1);
item->value = partition;
item->next = ret;
ret = item;
}
closedir(dp_disk);
return ret;
}
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
GuestDiskInfoList *item, *ret = NULL;
GuestDiskInfo *disk;
DIR *dp = NULL;
struct dirent *de = NULL;
g_debug("listing /sys/block directory");
dp = opendir("/sys/block");
if (dp == NULL) {
error_setg_errno(errp, errno, "Can't open directory \"/sys/block\"");
return NULL;
}
while ((de = readdir(dp)) != NULL) {
g_autofree char *disk_dir = NULL, *line = NULL,
*size_path = NULL;
char *dev_name;
Error *local_err = NULL;
if (de->d_type != DT_LNK) {
g_debug(" skipping entry: %s", de->d_name);
continue;
}
/* Check size and skip zero-sized disks */
g_debug(" checking disk size");
size_path = g_strdup_printf("/sys/block/%s/size", de->d_name);
if (!g_file_get_contents(size_path, &line, NULL, NULL)) {
g_debug(" failed to read disk size");
continue;
}
if (g_strcmp0(line, "0\n") == 0) {
g_debug(" skipping zero-sized disk");
continue;
}
g_debug(" adding %s", de->d_name);
disk_dir = g_strdup_printf("/sys/block/%s", de->d_name);
dev_name = get_device_for_syspath(disk_dir);
if (dev_name == NULL) {
g_debug("Failed to get device name for syspath: %s",
disk_dir);
continue;
}
disk = g_new0(GuestDiskInfo, 1);
disk->name = dev_name;
disk->partition = false;
disk->alias = get_alias_for_syspath(disk_dir);
disk->has_alias = (disk->alias != NULL);
item = g_new0(GuestDiskInfoList, 1);
item->value = disk;
item->next = ret;
ret = item;
/* Get address for non-virtual devices */
bool is_virtual = is_disk_virtual(disk_dir, &local_err);
if (local_err != NULL) {
g_debug(" failed to check disk path, ignoring error: %s",
error_get_pretty(local_err));
error_free(local_err);
local_err = NULL;
/* Don't try to get the address */
is_virtual = true;
}
if (!is_virtual) {
disk->address = get_disk_address(disk_dir, &local_err);
if (local_err != NULL) {
g_debug(" failed to get device info, ignoring error: %s",
error_get_pretty(local_err));
error_free(local_err);
local_err = NULL;
} else if (disk->address != NULL) {
disk->has_address = true;
}
}
get_disk_deps(disk_dir, disk);
ret = get_disk_partitions(ret, de->d_name, disk_dir, dev_name);
}
return ret;
}
#else
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif
/* Return a list of the disk device(s)' info which @mount lies on */
static GuestFilesystemInfo *build_guest_fsinfo(struct FsMount *mount,
Error **errp)
@ -2773,6 +3052,13 @@ int64_t qmp_guest_fsfreeze_thaw(Error **errp)
return 0;
}
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif /* CONFIG_FSFREEZE */
#if !defined(CONFIG_FSTRIM)
@ -2809,7 +3095,8 @@ GList *ga_command_blacklist_init(GList *blacklist)
const char *list[] = {
"guest-get-fsinfo", "guest-fsfreeze-status",
"guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list",
"guest-fsfreeze-thaw", "guest-get-fsinfo", NULL};
"guest-fsfreeze-thaw", "guest-get-fsinfo",
"guest-get-disks", NULL};
char **p = (char **)list;
while (*p) {

140
qga/commands-win32.c
View File

@ -979,6 +979,101 @@ out:
return list;
}
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
ERRP_GUARD();
GuestDiskInfoList *new = NULL, *ret = NULL;
HDEVINFO dev_info;
SP_DEVICE_INTERFACE_DATA dev_iface_data;
int i;
dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
if (dev_info == INVALID_HANDLE_VALUE) {
error_setg_win32(errp, GetLastError(), "failed to get device tree");
return NULL;
}
g_debug("enumerating devices");
dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
for (i = 0;
SetupDiEnumDeviceInterfaces(dev_info, NULL, &GUID_DEVINTERFACE_DISK,
i, &dev_iface_data);
i++) {
GuestDiskAddress *address = NULL;
GuestDiskInfo *disk = NULL;
Error *local_err = NULL;
g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
pdev_iface_detail_data = NULL;
STORAGE_DEVICE_NUMBER sdn;
HANDLE dev_file;
DWORD size = 0;
BOOL result;
int attempt;
g_debug(" getting device path");
for (attempt = 0, result = FALSE; attempt < 2 && !result; attempt++) {
result = SetupDiGetDeviceInterfaceDetail(dev_info,
&dev_iface_data, pdev_iface_detail_data, size, &size, NULL);
if (result) {
break;
}
if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
pdev_iface_detail_data = g_realloc(pdev_iface_detail_data,
size);
pdev_iface_detail_data->cbSize =
sizeof(*pdev_iface_detail_data);
} else {
g_debug("failed to get device interface details");
break;
}
}
if (!result) {
g_debug("skipping device");
continue;
}
g_debug(" device: %s", pdev_iface_detail_data->DevicePath);
dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
CloseHandle(dev_file);
debug_error("failed to get storage device number");
continue;
}
CloseHandle(dev_file);
disk = g_new0(GuestDiskInfo, 1);
disk->name = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
sdn.DeviceNumber);
g_debug(" number: %lu", sdn.DeviceNumber);
address = g_malloc0(sizeof(GuestDiskAddress));
address->has_dev = true;
address->dev = g_strdup(disk->name);
get_single_disk_info(sdn.DeviceNumber, address, &local_err);
if (local_err) {
g_debug("failed to get disk info: %s",
error_get_pretty(local_err));
error_free(local_err);
qapi_free_GuestDiskAddress(address);
address = NULL;
} else {
disk->address = address;
disk->has_address = true;
}
new = g_malloc0(sizeof(GuestDiskInfoList));
new->value = disk;
new->next = ret;
ret = new;
}
SetupDiDestroyDeviceInfoList(dev_info);
return ret;
}
#else
static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
@ -986,6 +1081,12 @@ static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
return NULL;
}
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif /* CONFIG_QGA_NTDDSCSI */
static GuestFilesystemInfo *build_guest_fsinfo(char *guid, Error **errp)
@ -1641,6 +1742,12 @@ out:
return head;
}
static int64_t filetime_to_ns(const FILETIME *tf)
{
return ((((int64_t)tf->dwHighDateTime << 32) | tf->dwLowDateTime)
- W32_FT_OFFSET) * 100;
}
int64_t qmp_guest_get_time(Error **errp)
{
SYSTEMTIME ts = {0};
@ -1657,8 +1764,7 @@ int64_t qmp_guest_get_time(Error **errp)
return -1;
}
return ((((int64_t)tf.dwHighDateTime << 32) | tf.dwLowDateTime)
- W32_FT_OFFSET) * 100;
return filetime_to_ns(&tf);
}
void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
@ -2363,7 +2469,6 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
slog("enumerating devices");
for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
bool skip = true;
SYSTEMTIME utc_date;
g_autofree LPWSTR name = NULL;
g_autofree LPFILETIME date = NULL;
g_autofree LPWSTR version = NULL;
@ -2381,7 +2486,7 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
device->driver_name = g_utf16_to_utf8(name, -1, NULL, NULL, NULL);
if (device->driver_name == NULL) {
error_setg(errp, "conversion to utf8 failed (driver name)");
continue;
return NULL;
}
slog("querying device: %s", device->driver_name);
hw_ids = ga_get_hardware_ids(dev_info_data.DevInst);
@ -2390,22 +2495,21 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
}
for (j = 0; hw_ids[j] != NULL; j++) {
GMatchInfo *match_info;
GuestDeviceAddressPCI *address;
GuestDeviceIdPCI *id;
if (!g_regex_match(device_pci_re, hw_ids[j], 0, &match_info)) {
continue;
}
skip = false;
address = g_new0(GuestDeviceAddressPCI, 1);
vendor_id = g_match_info_fetch(match_info, 1);
device_id = g_match_info_fetch(match_info, 2);
address->vendor_id = g_ascii_strtoull(vendor_id, NULL, 16);
address->device_id = g_ascii_strtoull(device_id, NULL, 16);
device->address = g_new0(GuestDeviceAddress, 1);
device->has_address = true;
device->address->type = GUEST_DEVICE_ADDRESS_KIND_PCI;
device->address->u.pci.data = address;
device->id = g_new0(GuestDeviceId, 1);
device->has_id = true;
device->id->type = GUEST_DEVICE_TYPE_PCI;
id = &device->id->u.pci;
id->vendor_id = g_ascii_strtoull(vendor_id, NULL, 16);
id->device_id = g_ascii_strtoull(device_id, NULL, 16);
g_match_info_free(match_info);
break;
@ -2424,7 +2528,7 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
NULL, NULL);
if (device->driver_version == NULL) {
error_setg(errp, "conversion to utf8 failed (driver version)");
continue;
return NULL;
}
device->has_driver_version = true;
@ -2434,13 +2538,12 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
slog("failed to get driver date");
continue;
}
FileTimeToSystemTime(date, &utc_date);
device->driver_date = g_strdup_printf("%04d-%02d-%02d",
utc_date.wYear, utc_date.wMonth, utc_date.wDay);
device->driver_date = filetime_to_ns(date);
device->has_driver_date = true;
slog("driver: %s\ndriver version: %s,%s\n", device->driver_name,
device->driver_date, device->driver_version);
slog("driver: %s\ndriver version: %" PRId64 ",%s\n",
device->driver_name, device->driver_date,
device->driver_version);
item = g_new0(GuestDeviceInfoList, 1);
item->value = g_steal_pointer(&device);
if (!cur_item) {
@ -2449,7 +2552,6 @@ GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
cur_item->next = item;
cur_item = item;
}
continue;
}
if (dev_info != INVALID_HANDLE_VALUE) {

39
qga/meson.build
View File

@ -22,12 +22,7 @@ qga_qapi_files = custom_target('QGA QAPI files',
depend_files: qapi_gen_depends)
qga_ss = ss.source_set()
i = 0
foreach output: qga_qapi_outputs
qga_ss.add(qga_qapi_files[i])
i = i + 1
endforeach
qga_ss.add(qga_qapi_files.to_list())
qga_ss.add(files(
'commands.c',
'guest-agent-command-state.c',
@ -35,7 +30,9 @@ qga_ss.add(files(
))
qga_ss.add(when: 'CONFIG_POSIX', if_true: files(
'channel-posix.c',
'commands-posix.c'))
'commands-posix.c',
'commands-posix-ssh.c',
))
qga_ss.add(when: 'CONFIG_WIN32', if_true: files(
'channel-win32.c',
'commands-win32.c',
@ -87,3 +84,31 @@ else
endif
alias_target('qemu-ga', all_qga)
test_env = environment()
test_env.set('G_TEST_SRCDIR', meson.current_source_dir())
test_env.set('G_TEST_BUILDDIR', meson.current_build_dir())
# disable qga-ssh-test for now. glib's G_TEST_OPTION_ISOLATE_DIRS triggers
# the leak detector in build-oss-fuzz Gitlab CI test. we should re-enable
# this when an alternative is implemented or when the underlying glib
# issue is identified/fix
#if 'CONFIG_POSIX' in config_host
if false
srcs = [files('commands-posix-ssh.c')]
i = 0
foreach output: qga_qapi_outputs
if output.startswith('qga-qapi-types') or output.startswith('qga-qapi-visit')
srcs += qga_qapi_files[i]
endif
i = i + 1
endforeach
qga_ssh_test = executable('qga-ssh-test', srcs,
dependencies: [qemuutil],
c_args: ['-DQGA_BUILD_UNIT_TEST'])
test('qga-ssh-test',
qga_ssh_test,
env: test_env,
suite: ['unit', 'qga'])
endif

127
qga/qapi-schema.json
View File

@ -865,6 +865,37 @@
'bus': 'int', 'target': 'int', 'unit': 'int',
'*serial': 'str', '*dev': 'str'} }
##
# @GuestDiskInfo:
#
# @name: device node (Linux) or device UNC (Windows)
# @partition: whether this is a partition or disk
# @dependents: list of dependent devices; e.g. for LVs of the LVM this will
# hold the list of PVs, for LUKS encrypted volume this will
# contain the disk where the volume is placed. (Linux)
# @address: disk address information (only for non-virtual devices)
# @alias: optional alias assigned to the disk, on Linux this is a name assigned
# by device mapper
#
# Since 5.2
##
{ 'struct': 'GuestDiskInfo',
'data': {'name': 'str', 'partition': 'bool', 'dependents': ['str'],
'*address': 'GuestDiskAddress', '*alias': 'str'} }
##
# @guest-get-disks:
#
# Returns: The list of disks in the guest. For Windows these are only the
# physical disks. On Linux these are all root block devices of
# non-zero size including e.g. removable devices, loop devices,
# NBD, etc.
#
# Since: 5.2
##
{ 'command': 'guest-get-disks',
'returns': ['GuestDiskInfo'] }
##
# @GuestFilesystemInfo:
#
@ -1257,42 +1288,51 @@
'returns': 'GuestOSInfo' }
##
# @GuestDeviceAddressPCI:
# @GuestDeviceType:
##
{ 'enum': 'GuestDeviceType',
'data': [ 'pci' ] }
##
# @GuestDeviceIdPCI:
#
# @vendor-id: vendor ID
# @device-id: device ID
#
# Since: 5.2
##
{ 'struct': 'GuestDeviceAddressPCI',
{ 'struct': 'GuestDeviceIdPCI',
'data': { 'vendor-id': 'uint16', 'device-id': 'uint16' } }
##
# @GuestDeviceAddress:
# @GuestDeviceId:
#
# Address of the device
# - @pci: address of PCI device, since: 5.2
# Id of the device
# - @pci: PCI ID, since: 5.2
#
# Since: 5.2
##
{ 'union': 'GuestDeviceAddress',
'data': { 'pci': 'GuestDeviceAddressPCI' } }
{ 'union': 'GuestDeviceId',
'base': { 'type': 'GuestDeviceType' },
'discriminator': 'type',
'data': { 'pci': 'GuestDeviceIdPCI' } }
##
# @GuestDeviceInfo:
#
# @driver-name: name of the associated driver
# @driver-date: driver release date in format YYYY-MM-DD
# @driver-date: driver release date, in nanoseconds since the epoch
# @driver-version: driver version
# @id: device ID
#
# Since: 5.2
##
{ 'struct': 'GuestDeviceInfo',
'data': {
'driver-name': 'str',
'*driver-date': 'str',
'*driver-date': 'int',
'*driver-version': 'str',
'*address': 'GuestDeviceAddress'
'*id': 'GuestDeviceId'
} }
##
@ -1306,3 +1346,70 @@
##
{ 'command': 'guest-get-devices',
'returns': ['GuestDeviceInfo'] }
##
# @GuestAuthorizedKeys:
#
# @keys: public keys (in OpenSSH/sshd(8) authorized_keys format)
#
# Since: 5.2
##
{ 'struct': 'GuestAuthorizedKeys',
'data': {
'keys': ['str']
},
'if': 'defined(CONFIG_POSIX)' }
##
# @guest-ssh-get-authorized-keys:
#
# @username: the user account to add the authorized keys
#
# Return the public keys from user .ssh/authorized_keys on Unix systems (not
# implemented for other systems).
#
# Returns: @GuestAuthorizedKeys
#
# Since: 5.2
##
{ 'command': 'guest-ssh-get-authorized-keys',
'data': { 'username': 'str' },
'returns': 'GuestAuthorizedKeys',
'if': 'defined(CONFIG_POSIX)' }
##
# @guest-ssh-add-authorized-keys:
#
# @username: the user account to add the authorized keys
# @keys: the public keys to add (in OpenSSH/sshd(8) authorized_keys format)
# @reset: ignore the existing content, set it with the given keys only
#
# Append public keys to user .ssh/authorized_keys on Unix systems (not
# implemented for other systems).
#
# Returns: Nothing on success.
#
# Since: 5.2
##
{ 'command': 'guest-ssh-add-authorized-keys',
'data': { 'username': 'str', 'keys': ['str'], '*reset': 'bool' },
'if': 'defined(CONFIG_POSIX)' }
##
# @guest-ssh-remove-authorized-keys:
#
# @username: the user account to remove the authorized keys
# @keys: the public keys to remove (in OpenSSH/sshd(8) authorized_keys format)
#
# Remove public keys from the user .ssh/authorized_keys on Unix systems (not
# implemented for other systems). It's not an error if the key is already
# missing.
#
# Returns: Nothing on success.
#
# Since: 5.2
##
{ 'command': 'guest-ssh-remove-authorized-keys',
'data': { 'username': 'str', 'keys': ['str'] },
'if': 'defined(CONFIG_POSIX)' }