qga: conditionalize schema for commands requiring fstrim

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 filesystem trimming commands
on POSIX platforms lacking required APIs.

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.

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Message-ID: <20240712132459.3974109-15-berrange@redhat.com>
Signed-off-by: Konstantin Kostiuk <kkostiuk@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2024-07-12 14:24:51 +01:00 committed by Konstantin Kostiuk
parent 49d8c8e237
commit 21ca6854d8
2 changed files with 6 additions and 16 deletions

View File

@ -1144,22 +1144,9 @@ error:
#endif /* HAVE_GETIFADDRS */ #endif /* HAVE_GETIFADDRS */
#if !defined(CONFIG_FSTRIM)
GuestFilesystemTrimResponse *
qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
{
error_setg(errp, QERR_UNSUPPORTED);
return NULL;
}
#endif
/* add unsupported commands to the list of blocked RPCs */ /* add unsupported commands to the list of blocked RPCs */
GList *ga_command_init_blockedrpcs(GList *blockedrpcs) GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
{ {
#if !defined(CONFIG_FSTRIM)
blockedrpcs = g_list_append(blockedrpcs, g_strdup("guest-fstrim"));
#endif
return blockedrpcs; return blockedrpcs;
} }

View File

@ -510,7 +510,8 @@
## ##
{ 'struct': 'GuestFilesystemTrimResult', { 'struct': 'GuestFilesystemTrimResult',
'data': {'path': 'str', 'data': {'path': 'str',
'*trimmed': 'int', '*minimum': 'int', '*error': 'str'} } '*trimmed': 'int', '*minimum': 'int', '*error': 'str'},
'if': { 'any': ['CONFIG_WIN32', 'CONFIG_FSTRIM'] } }
## ##
# @GuestFilesystemTrimResponse: # @GuestFilesystemTrimResponse:
@ -520,7 +521,8 @@
# Since: 2.4 # Since: 2.4
## ##
{ 'struct': 'GuestFilesystemTrimResponse', { 'struct': 'GuestFilesystemTrimResponse',
'data': {'paths': ['GuestFilesystemTrimResult']} } 'data': {'paths': ['GuestFilesystemTrimResult']},
'if': { 'any': ['CONFIG_WIN32', 'CONFIG_FSTRIM'] } }
## ##
# @guest-fstrim: # @guest-fstrim:
@ -542,7 +544,8 @@
## ##
{ 'command': 'guest-fstrim', { 'command': 'guest-fstrim',
'data': { '*minimum': 'int' }, 'data': { '*minimum': 'int' },
'returns': 'GuestFilesystemTrimResponse' } 'returns': 'GuestFilesystemTrimResponse',
'if': { 'any': ['CONFIG_WIN32', 'CONFIG_FSTRIM'] } }
## ##
# @guest-suspend-disk: # @guest-suspend-disk: