chardev: add tracing of socket error conditions

This adds trace points to every error scenario in the chardev socket
backend that can lead to termination of the connection.

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2024-03-15 13:04:44 +00:00
parent 48fc887436
commit 6ffade7974
2 changed files with 36 additions and 11 deletions

View File

@ -33,6 +33,7 @@
#include "qapi/clone-visitor.h" #include "qapi/clone-visitor.h"
#include "qapi/qapi-visit-sockets.h" #include "qapi/qapi-visit-sockets.h"
#include "qemu/yank.h" #include "qemu/yank.h"
#include "trace.h"
#include "chardev/char-io.h" #include "chardev/char-io.h"
#include "chardev/char-socket.h" #include "chardev/char-socket.h"
@ -126,6 +127,7 @@ static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
if (ret < 0 && errno != EAGAIN) { if (ret < 0 && errno != EAGAIN) {
if (tcp_chr_read_poll(chr) <= 0) { if (tcp_chr_read_poll(chr) <= 0) {
/* Perform disconnect and return error. */ /* Perform disconnect and return error. */
trace_chr_socket_poll_err(chr, chr->label);
tcp_chr_disconnect_locked(chr); tcp_chr_disconnect_locked(chr);
} /* else let the read handler finish it properly */ } /* else let the read handler finish it properly */
} }
@ -279,15 +281,16 @@ static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
size_t i; size_t i;
int *msgfds = NULL; int *msgfds = NULL;
size_t msgfds_num = 0; size_t msgfds_num = 0;
Error *err = NULL;
if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) { if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
ret = qio_channel_readv_full(s->ioc, &iov, 1, ret = qio_channel_readv_full(s->ioc, &iov, 1,
&msgfds, &msgfds_num, &msgfds, &msgfds_num,
0, NULL); 0, &err);
} else { } else {
ret = qio_channel_readv_full(s->ioc, &iov, 1, ret = qio_channel_readv_full(s->ioc, &iov, 1,
NULL, NULL, NULL, NULL,
0, NULL); 0, &err);
} }
if (msgfds_num) { if (msgfds_num) {
@ -322,7 +325,11 @@ static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
errno = EAGAIN; errno = EAGAIN;
ret = -1; ret = -1;
} else if (ret == -1) { } else if (ret == -1) {
trace_chr_socket_recv_err(chr, chr->label, error_get_pretty(err));
error_free(err);
errno = EIO; errno = EIO;
} else if (ret == 0) {
trace_chr_socket_recv_eof(chr, chr->label);
} }
return ret; return ret;
@ -463,6 +470,7 @@ static void tcp_chr_disconnect_locked(Chardev *chr)
SocketChardev *s = SOCKET_CHARDEV(chr); SocketChardev *s = SOCKET_CHARDEV(chr);
bool emit_close = s->state == TCP_CHARDEV_STATE_CONNECTED; bool emit_close = s->state == TCP_CHARDEV_STATE_CONNECTED;
trace_chr_socket_disconnect(chr, chr->label);
tcp_chr_free_connection(chr); tcp_chr_free_connection(chr);
if (s->listener) { if (s->listener) {
@ -521,6 +529,7 @@ static gboolean tcp_chr_hup(QIOChannel *channel,
void *opaque) void *opaque)
{ {
Chardev *chr = CHARDEV(opaque); Chardev *chr = CHARDEV(opaque);
trace_chr_socket_hangup(chr, chr->label);
tcp_chr_disconnect(chr); tcp_chr_disconnect(chr);
return G_SOURCE_REMOVE; return G_SOURCE_REMOVE;
} }
@ -672,15 +681,18 @@ static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
SocketChardev *s = user_data; SocketChardev *s = user_data;
Chardev *chr = CHARDEV(s); Chardev *chr = CHARDEV(s);
TCPChardevTelnetInit *init = s->telnet_init; TCPChardevTelnetInit *init = s->telnet_init;
Error *err = NULL;
ssize_t ret; ssize_t ret;
assert(init); assert(init);
ret = qio_channel_write(ioc, init->buf, init->buflen, NULL); ret = qio_channel_write(ioc, init->buf, init->buflen, &err);
if (ret < 0) { if (ret < 0) {
if (ret == QIO_CHANNEL_ERR_BLOCK) { if (ret == QIO_CHANNEL_ERR_BLOCK) {
ret = 0; ret = 0;
} else { } else {
trace_chr_socket_write_err(chr, chr->label, error_get_pretty(err));
error_free(err);
tcp_chr_disconnect(chr); tcp_chr_disconnect(chr);
goto end; goto end;
} }
@ -765,9 +777,9 @@ static void tcp_chr_websock_handshake(QIOTask *task, gpointer user_data)
Error *err = NULL; Error *err = NULL;
if (qio_task_propagate_error(task, &err)) { if (qio_task_propagate_error(task, &err)) {
error_reportf_err(err, trace_chr_socket_ws_handshake_err(chr, chr->label,
"websock handshake of character device %s failed: ", error_get_pretty(err));
chr->label); error_free(err);
tcp_chr_disconnect(chr); tcp_chr_disconnect(chr);
} else { } else {
if (s->do_telnetopt) { if (s->do_telnetopt) {
@ -805,9 +817,9 @@ static void tcp_chr_tls_handshake(QIOTask *task,
Error *err = NULL; Error *err = NULL;
if (qio_task_propagate_error(task, &err)) { if (qio_task_propagate_error(task, &err)) {
error_reportf_err(err, trace_chr_socket_tls_handshake_err(chr, chr->label,
"TLS handshake of character device %s failed: ", error_get_pretty(err));
chr->label); error_free(err);
tcp_chr_disconnect(chr); tcp_chr_disconnect(chr);
} else { } else {
if (s->is_websock) { if (s->is_websock) {
@ -826,19 +838,22 @@ static void tcp_chr_tls_init(Chardev *chr)
SocketChardev *s = SOCKET_CHARDEV(chr); SocketChardev *s = SOCKET_CHARDEV(chr);
QIOChannelTLS *tioc; QIOChannelTLS *tioc;
gchar *name; gchar *name;
Error *err = NULL;
if (s->is_listen) { if (s->is_listen) {
tioc = qio_channel_tls_new_server( tioc = qio_channel_tls_new_server(
s->ioc, s->tls_creds, s->ioc, s->tls_creds,
s->tls_authz, s->tls_authz,
NULL); &err);
} else { } else {
tioc = qio_channel_tls_new_client( tioc = qio_channel_tls_new_client(
s->ioc, s->tls_creds, s->ioc, s->tls_creds,
s->addr->u.inet.host, s->addr->u.inet.host,
NULL); &err);
} }
if (tioc == NULL) { if (tioc == NULL) {
trace_chr_socket_tls_init_err(chr, chr->label, error_get_pretty(err));
error_free(err);
tcp_chr_disconnect(chr); tcp_chr_disconnect(chr);
return; return;
} }

View File

@ -17,3 +17,13 @@ spice_vmc_register_interface(void *scd) "spice vmc registered interface %p"
spice_vmc_unregister_interface(void *scd) "spice vmc unregistered interface %p" spice_vmc_unregister_interface(void *scd) "spice vmc unregistered interface %p"
spice_vmc_event(int event) "spice vmc event %d" spice_vmc_event(int event) "spice vmc event %d"
# char-socket.c
chr_socket_poll_err(void *chrdev, const char *label) "chardev socket poll error %p (%s)"
chr_socket_recv_err(void *chrdev, const char *label, const char *err) "chardev socket recv error %p (%s): %s"
chr_socket_recv_eof(void *chrdev, const char *label) "chardev socket recv end-of-file %p (%s)"
chr_socket_write_err(void *chrdev, const char *label, const char *err) "chardev socket write error %p (%s): %s"
chr_socket_disconnect(void *chrdev, const char *label) "chardev socket disconnect %p (%s)"
chr_socket_hangup(void *chrdev, const char *label) "chardev socket hangup %p (%s)"
chr_socket_ws_handshake_err(void *chrdev, const char *label, const char *err) "chardev socket websock handshake error %p (%s): %s"
chr_socket_tls_handshake_err(void *chrdev, const char *label, const char *err) "chardev socket TLS handshake error %p (%s): %s"
chr_socket_tls_init_err(void *chrdev, const char *label, const char *err) "chardev socket TLS init error %p (%s): %s"