mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qga: conditionalize schema for commands requiring linux/win32

Browse Source 
Some commands were blocked based on CONFIG_FSFREEZE, but their
impl had nothing todo with CONFIG_FSFREEZE, and were instead
either Linux-only, or Win+Linux-only.

Rather than creating stubs for every command that just return
QERR_UNSUPPORTED, use 'if' conditions in the QAPI schema to
fully exclude generation of the stats and fsinfo commands on
platforms that can't support them.

The command will be rejected at QMP dispatch time instead,
avoiding reimplementing rejection by blocking the stub commands.
This changes the error message for affected commands from

    {"class": "CommandNotFound", "desc": "Command FOO has been disabled"}

to

    {"class": "CommandNotFound", "desc": "The command FOO has not been found"}

This has the additional benefit that the QGA protocol reference
now documents what conditions enable use of the command.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Message-ID: <20240712132459.3974109-12-berrange@redhat.com>
Signed-off-by: Konstantin Kostiuk <kkostiuk@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2024-07-12 14:24:48 +01:00 committed by Konstantin Kostiuk
parent f8edff9b77
commit 83a7a1ab9a
3 changed files with 30 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
qga/commands-bsd.c
View File

@ -149,30 +149,6 @@ int qmp_guest_fsfreeze_do_thaw(Error **errp)
} }
return ret; return ret;
} }
GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestDiskStatsInfoList *qmp_guest_get_diskstats(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif /* CONFIG_FSFREEZE */ #endif /* CONFIG_FSFREEZE */
#ifdef HAVE_GETIFADDRS #ifdef HAVE_GETIFADDRS

30
qga/commands-posix.c
View File

@ -1146,12 +1146,6 @@ error:
#if !defined(CONFIG_FSFREEZE) #if !defined(CONFIG_FSFREEZE)
GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp) GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
{ {
error_setg(errp, QERR_UNSUPPORTED); error_setg(errp, QERR_UNSUPPORTED);
@ -1181,25 +1175,6 @@ int64_t qmp_guest_fsfreeze_thaw(Error **errp)
return 0; return 0;
} }
GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestDiskStatsInfoList *qmp_guest_get_diskstats(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif /* CONFIG_FSFREEZE */ #endif /* CONFIG_FSFREEZE */
#if !defined(CONFIG_FSTRIM) #if !defined(CONFIG_FSTRIM)
@ -1217,10 +1192,9 @@ GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
#if !defined(CONFIG_FSFREEZE) #if !defined(CONFIG_FSFREEZE)
{ {
const char *list[] = { const char *list[] = {
"guest-get-fsinfo", "guest-fsfreeze-status", "guest-fsfreeze-status",
"guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list", "guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list",
"guest-fsfreeze-thaw", "guest-get-fsinfo", "guest-fsfreeze-thaw", NULL};
"guest-get-disks", NULL};
char **p = (char **)list; char **p = (char **)list;
while (*p) { while (*p) {

45
qga/qapi-schema.json
View File

@ -870,7 +870,8 @@
{ 'enum': 'GuestDiskBusType', { 'enum': 'GuestDiskBusType',
'data': [ 'ide', 'fdc', 'scsi', 'virtio', 'xen', 'usb', 'uml', 'sata', 'data': [ 'ide', 'fdc', 'scsi', 'virtio', 'xen', 'usb', 'uml', 'sata',
'sd', 'unknown', 'ieee1394', 'ssa', 'fibre', 'raid', 'iscsi', 'sd', 'unknown', 'ieee1394', 'ssa', 'fibre', 'raid', 'iscsi',
'sas', 'mmc', 'virtual', 'file-backed-virtual', 'nvme' ] } 'sas', 'mmc', 'virtual', 'file-backed-virtual', 'nvme' ],
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
@ -888,7 +889,8 @@
## ##
{ 'struct': 'GuestPCIAddress', { 'struct': 'GuestPCIAddress',
'data': {'domain': 'int', 'bus': 'int', 'data': {'domain': 'int', 'bus': 'int',
'slot': 'int', 'function': 'int'} } 'slot': 'int', 'function': 'int'},
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestCCWAddress: # @GuestCCWAddress:
@ -907,7 +909,8 @@
'data': {'cssid': 'int', 'data': {'cssid': 'int',
'ssid': 'int', 'ssid': 'int',
'subchno': 'int', 'subchno': 'int',
'devno': 'int'} } 'devno': 'int'},
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestDiskAddress: # @GuestDiskAddress:
@ -936,7 +939,8 @@
'bus-type': 'GuestDiskBusType', 'bus-type': 'GuestDiskBusType',
'bus': 'int', 'target': 'int', 'unit': 'int', 'bus': 'int', 'target': 'int', 'unit': 'int',
'*serial': 'str', '*dev': 'str', '*serial': 'str', '*dev': 'str',
'*ccw-address': 'GuestCCWAddress'} } '*ccw-address': 'GuestCCWAddress'},
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestNVMeSmart: # @GuestNVMeSmart:
@ -973,7 +977,8 @@
'media-errors-lo': 'uint64', 'media-errors-lo': 'uint64',
'media-errors-hi': 'uint64', 'media-errors-hi': 'uint64',
'number-of-error-log-entries-lo': 'uint64', 'number-of-error-log-entries-lo': 'uint64',
'number-of-error-log-entries-hi': 'uint64' } } 'number-of-error-log-entries-hi': 'uint64' },
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestDiskSmart: # @GuestDiskSmart:
@ -987,7 +992,8 @@
{ 'union': 'GuestDiskSmart', { 'union': 'GuestDiskSmart',
'base': { 'type': 'GuestDiskBusType' }, 'base': { 'type': 'GuestDiskBusType' },
'discriminator': 'type', 'discriminator': 'type',
'data': { 'nvme': 'GuestNVMeSmart' } } 'data': { 'nvme': 'GuestNVMeSmart' },
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestDiskInfo: # @GuestDiskInfo:
@ -1012,7 +1018,8 @@
{ 'struct': 'GuestDiskInfo', { 'struct': 'GuestDiskInfo',
'data': {'name': 'str', 'partition': 'bool', '*dependencies': ['str'], 'data': {'name': 'str', 'partition': 'bool', '*dependencies': ['str'],
'*address': 'GuestDiskAddress', '*alias': 'str', '*address': 'GuestDiskAddress', '*alias': 'str',
'*smart': 'GuestDiskSmart'} } '*smart': 'GuestDiskSmart'},
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @guest-get-disks: # @guest-get-disks:
@ -1025,7 +1032,8 @@
# Since: 5.2 # Since: 5.2
## ##
{ 'command': 'guest-get-disks', { 'command': 'guest-get-disks',
'returns': ['GuestDiskInfo'] } 'returns': ['GuestDiskInfo'],
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @GuestFilesystemInfo: # @GuestFilesystemInfo:
@ -1051,7 +1059,8 @@
{ 'struct': 'GuestFilesystemInfo', { 'struct': 'GuestFilesystemInfo',
'data': {'name': 'str', 'mountpoint': 'str', 'type': 'str', 'data': {'name': 'str', 'mountpoint': 'str', 'type': 'str',
'*used-bytes': 'uint64', '*total-bytes': 'uint64', '*used-bytes': 'uint64', '*total-bytes': 'uint64',
'*total-bytes-privileged': 'uint64', 'disk': ['GuestDiskAddress']} } '*total-bytes-privileged': 'uint64', 'disk': ['GuestDiskAddress']},
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @guest-get-fsinfo: # @guest-get-fsinfo:
@ -1064,7 +1073,8 @@
# Since: 2.2 # Since: 2.2
## ##
{ 'command': 'guest-get-fsinfo', { 'command': 'guest-get-fsinfo',
'returns': ['GuestFilesystemInfo'] } 'returns': ['GuestFilesystemInfo'],
'if': { 'any': [ 'CONFIG_WIN32', 'CONFIG_LINUX' ] } }
## ##
# @guest-set-user-password: # @guest-set-user-password:
@ -1703,7 +1713,8 @@
'*ios-pgr': 'uint64', '*ios-pgr': 'uint64',
'*total-ticks': 'uint64', '*total-ticks': 'uint64',
'*weight-ticks': 'uint64' '*weight-ticks': 'uint64'
} } },
'if': 'CONFIG_LINUX' }
## ##
# @GuestDiskStatsInfo: # @GuestDiskStatsInfo:
@ -1721,7 +1732,7 @@
'major': 'uint64', 'major': 'uint64',
'minor': 'uint64', 'minor': 'uint64',
'stats': 'GuestDiskStats' }, 'stats': 'GuestDiskStats' },
'if': 'CONFIG_POSIX' } 'if': 'CONFIG_LINUX' }
## ##
# @guest-get-diskstats: # @guest-get-diskstats:
@ -1734,7 +1745,7 @@
## ##
{ 'command': 'guest-get-diskstats', { 'command': 'guest-get-diskstats',
'returns': ['GuestDiskStatsInfo'], 'returns': ['GuestDiskStatsInfo'],
'if': 'CONFIG_POSIX' 'if': 'CONFIG_LINUX'
} }
## ##
@ -1748,7 +1759,7 @@
## ##
{ 'enum': 'GuestCpuStatsType', { 'enum': 'GuestCpuStatsType',
'data': [ 'linux' ], 'data': [ 'linux' ],
'if': 'CONFIG_POSIX' } 'if': 'CONFIG_LINUX' }
## ##
@ -1794,7 +1805,7 @@
'*guest': 'uint64', '*guest': 'uint64',
'*guestnice': 'uint64' '*guestnice': 'uint64'
}, },
'if': 'CONFIG_POSIX' } 'if': 'CONFIG_LINUX' }
## ##
# @GuestCpuStats: # @GuestCpuStats:
@ -1809,7 +1820,7 @@
'base': { 'type': 'GuestCpuStatsType' }, 'base': { 'type': 'GuestCpuStatsType' },
'discriminator': 'type', 'discriminator': 'type',
'data': { 'linux': 'GuestLinuxCpuStats' }, 'data': { 'linux': 'GuestLinuxCpuStats' },
'if': 'CONFIG_POSIX' } 'if': 'CONFIG_LINUX' }
## ##
# @guest-get-cpustats: # @guest-get-cpustats:
@ -1822,5 +1833,5 @@
## ##
{ 'command': 'guest-get-cpustats', { 'command': 'guest-get-cpustats',
'returns': ['GuestCpuStats'], 'returns': ['GuestCpuStats'],
'if': 'CONFIG_POSIX' 'if': 'CONFIG_LINUX'
} }