[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v8 6/8] io: Document qmp oob suitability of qio_channel_shutdown
From: |
Lukas Straub |
Subject: |
[PATCH v8 6/8] io: Document qmp oob suitability of qio_channel_shutdown and io_shutdown |
Date: |
Tue, 1 Sep 2020 11:15:25 +0200 |
Migration and yank code assume that qio_channel_shutdown is thread
-safe and can be called from qmp oob handler. Document this after
checking the code.
Signed-off-by: Lukas Straub <lukasstraub2@web.de>
Acked-by: Stefan Hajnoczi <stefanha@redhat.com>
---
include/io/channel.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/io/channel.h b/include/io/channel.h
index d4557f0930..46156d84f5 100644
--- a/include/io/channel.h
+++ b/include/io/channel.h
@@ -98,7 +98,8 @@ struct QIOChannel {
* provide additional optional features.
*
* Consult the corresponding public API docs for a description
- * of the semantics of each callback
+ * of the semantics of each callback. io_shutdown in particular
+ * must be thread-safe, terminate quickly and must not block.
*/
struct QIOChannelClass {
ObjectClass parent;
@@ -516,6 +517,8 @@ int qio_channel_close(QIOChannel *ioc,
* QIO_CHANNEL_FEATURE_SHUTDOWN prior to calling
* this method.
*
+ * This function is thread-safe, terminates quickly and does not block.
+ *
* Returns: 0 on success, -1 on error
*/
int qio_channel_shutdown(QIOChannel *ioc,
--
2.20.1
pgpatxUldueBN.pgp
Description: OpenPGP digital signature
- [PATCH v8 1/8] Introduce yank feature, (continued)
- [PATCH v8 2/8] block/nbd.c: Add yank feature, Lukas Straub, 2020/09/01
- [PATCH v8 3/8] chardev/char-socket.c: Add yank feature, Lukas Straub, 2020/09/01
- [PATCH v8 4/8] migration: Add yank feature, Lukas Straub, 2020/09/01
- [PATCH v8 6/8] io: Document qmp oob suitability of qio_channel_shutdown and io_shutdown,
Lukas Straub <=
- [PATCH v8 5/8] io/channel-tls.c: make qio_channel_tls_shutdown thread-safe, Lukas Straub, 2020/09/01
- [PATCH v8 7/8] MAINTAINERS: Add myself as maintainer for yank feature, Lukas Straub, 2020/09/01
- [PATCH v8 8/8] tests/test-char.c: Wait for the chardev to connect in char_socket_client_dupid_test, Lukas Straub, 2020/09/01