Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The yank feature allows to recover from hanging qemu by "yanking" at various parts. Other qemu systems can register themselves and multiple yank functions. Then all yank functions for selected instances can be called by the 'yank' out-of-band qmp command. Available instances can be queried by a 'query-yank' oob command. Signed-off-by: Lukas Straub <lukasstraub2@web.de> Acked-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Message-Id: <69934ceacfd33a7dfe53db145ecc630ad39ee47c.1609167865.git.lukasstraub2@web.de> Acked-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
- Loading branch information
Showing
7 changed files
with
433 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
/* | ||
* QEMU yank feature | ||
* | ||
* Copyright (c) Lukas Straub <lukasstraub2@web.de> | ||
* | ||
* This work is licensed under the terms of the GNU GPL, version 2 or later. | ||
* See the COPYING file in the top-level directory. | ||
*/ | ||
|
||
#ifndef YANK_H | ||
#define YANK_H | ||
|
||
#include "qapi/qapi-types-yank.h" | ||
|
||
typedef void (YankFn)(void *opaque); | ||
|
||
/** | ||
* yank_register_instance: Register a new instance. | ||
* | ||
* This registers a new instance for yanking. Must be called before any yank | ||
* function is registered for this instance. | ||
* | ||
* This function is thread-safe. | ||
* | ||
* @instance: The instance. | ||
* @errp: Error object. | ||
* | ||
* Returns true on success or false if an error occured. | ||
*/ | ||
bool yank_register_instance(const YankInstance *instance, Error **errp); | ||
|
||
/** | ||
* yank_unregister_instance: Unregister a instance. | ||
* | ||
* This unregisters a instance. Must be called only after every yank function | ||
* of the instance has been unregistered. | ||
* | ||
* This function is thread-safe. | ||
* | ||
* @instance: The instance. | ||
*/ | ||
void yank_unregister_instance(const YankInstance *instance); | ||
|
||
/** | ||
* yank_register_function: Register a yank function | ||
* | ||
* This registers a yank function. All limitations of qmp oob commands apply | ||
* to the yank function as well. See docs/devel/qapi-code-gen.txt under | ||
* "An OOB-capable command handler must satisfy the following conditions". | ||
* | ||
* This function is thread-safe. | ||
* | ||
* @instance: The instance. | ||
* @func: The yank function. | ||
* @opaque: Will be passed to the yank function. | ||
*/ | ||
void yank_register_function(const YankInstance *instance, | ||
YankFn *func, | ||
void *opaque); | ||
|
||
/** | ||
* yank_unregister_function: Unregister a yank function | ||
* | ||
* This unregisters a yank function. | ||
* | ||
* This function is thread-safe. | ||
* | ||
* @instance: The instance. | ||
* @func: func that was passed to yank_register_function. | ||
* @opaque: opaque that was passed to yank_register_function. | ||
*/ | ||
void yank_unregister_function(const YankInstance *instance, | ||
YankFn *func, | ||
void *opaque); | ||
|
||
/** | ||
* yank_generic_iochannel: Generic yank function for iochannel | ||
* | ||
* This is a generic yank function which will call qio_channel_shutdown on the | ||
* provided QIOChannel. | ||
* | ||
* @opaque: QIOChannel to shutdown | ||
*/ | ||
void yank_generic_iochannel(void *opaque); | ||
|
||
#define BLOCKDEV_YANK_INSTANCE(the_node_name) (&(YankInstance) { \ | ||
.type = YANK_INSTANCE_TYPE_BLOCK_NODE, \ | ||
.u.block_node.node_name = (the_node_name) }) | ||
|
||
#define CHARDEV_YANK_INSTANCE(the_id) (&(YankInstance) { \ | ||
.type = YANK_INSTANCE_TYPE_CHARDEV, \ | ||
.u.chardev.id = (the_id) }) | ||
|
||
#define MIGRATION_YANK_INSTANCE (&(YankInstance) { \ | ||
.type = YANK_INSTANCE_TYPE_MIGRATION }) | ||
|
||
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,6 +47,7 @@ qapi_all_modules = [ | |
'trace', | ||
'transaction', | ||
'ui', | ||
'yank', | ||
] | ||
|
||
qapi_storage_daemon_modules = [ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# -*- Mode: Python -*- | ||
# vim: filetype=python | ||
# | ||
|
||
## | ||
# = Yank feature | ||
## | ||
|
||
## | ||
# @YankInstanceType: | ||
# | ||
# An enumeration of yank instance types. See @YankInstance for more | ||
# information. | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'enum': 'YankInstanceType', | ||
'data': [ 'block-node', 'chardev', 'migration' ] } | ||
|
||
## | ||
# @YankInstanceBlockNode: | ||
# | ||
# Specifies which block graph node to yank. See @YankInstance for more | ||
# information. | ||
# | ||
# @node-name: the name of the block graph node | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'struct': 'YankInstanceBlockNode', | ||
'data': { 'node-name': 'str' } } | ||
|
||
## | ||
# @YankInstanceChardev: | ||
# | ||
# Specifies which character device to yank. See @YankInstance for more | ||
# information. | ||
# | ||
# @id: the chardev's ID | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'struct': 'YankInstanceChardev', | ||
'data': { 'id': 'str' } } | ||
|
||
## | ||
# @YankInstance: | ||
# | ||
# A yank instance can be yanked with the @yank qmp command to recover from a | ||
# hanging QEMU. | ||
# | ||
# Currently implemented yank instances: | ||
# - nbd block device: | ||
# Yanking it will shut down the connection to the nbd server without | ||
# attempting to reconnect. | ||
# - socket chardev: | ||
# Yanking it will shut down the connected socket. | ||
# - migration: | ||
# Yanking it will shut down all migration connections. Unlike | ||
# @migrate_cancel, it will not notify the migration process, so migration | ||
# will go into @failed state, instead of @cancelled state. @yank should be | ||
# used to recover from hangs. | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'union': 'YankInstance', | ||
'base': { 'type': 'YankInstanceType' }, | ||
'discriminator': 'type', | ||
'data': { | ||
'block-node': 'YankInstanceBlockNode', | ||
'chardev': 'YankInstanceChardev' } } | ||
|
||
## | ||
# @yank: | ||
# | ||
# Try to recover from hanging QEMU by yanking the specified instances. See | ||
# @YankInstance for more information. | ||
# | ||
# Takes a list of @YankInstance as argument. | ||
# | ||
# Returns: - Nothing on success | ||
# - @DeviceNotFound error, if any of the YankInstances doesn't exist | ||
# | ||
# Example: | ||
# | ||
# -> { "execute": "yank", | ||
# "arguments": { | ||
# "instances": [ | ||
# { "type": "block-node", | ||
# "node-name": "nbd0" } | ||
# ] } } | ||
# <- { "return": {} } | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'command': 'yank', | ||
'data': { 'instances': ['YankInstance'] }, | ||
'allow-oob': true } | ||
|
||
## | ||
# @query-yank: | ||
# | ||
# Query yank instances. See @YankInstance for more information. | ||
# | ||
# Returns: list of @YankInstance | ||
# | ||
# Example: | ||
# | ||
# -> { "execute": "query-yank" } | ||
# <- { "return": [ | ||
# { "type": "block-node", | ||
# "node-name": "nbd0" } | ||
# ] } | ||
# | ||
# Since: 6.0 | ||
## | ||
{ 'command': 'query-yank', | ||
'returns': ['YankInstance'], | ||
'allow-oob': true } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.