Commit 2959fb7f authored by Peter Maydell's avatar Peter Maydell
Browse files

Merge remote-tracking branch 'remotes/elmarco/tags/chrdev-pull-request' into staging 



- add websocket support
- socket: make 'fd' incompatible with 'reconnect'
- fix a websocket leak
- unrelated editorconfig patch that missed -trivial (included for
  convenience)
- v2: fix commit author field

# gpg: Signature made Thu 01 Nov 2018 08:23:39 GMT
# gpg:                using RSA key DAE8E10975969CE5
# gpg: Good signature from "Marc-André Lureau <marcandre.lureau@redhat.com>"
# gpg:                 aka "Marc-André Lureau <marcandre.lureau@gmail.com>"
# Primary key fingerprint: 87A9 BD93 3F87 C606 D276  F62D DAE8 E109 7596 9CE5

* remotes/elmarco/tags/chrdev-pull-request:
  editorconfig: set emacs mode
  tests/test-char: Check websocket chardev functionality
  chardev: Add websocket support
  chardev/char-socket: Function headers refactoring
  char-socket: make 'fd' incompatible with 'reconnect'
  char-socket: correctly set has_reconnect when parsing QemuOpts
  websock: fix handshake leak

Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
parents 4cb890b8 1ad723e9

.editorconfig

+20 −1
Original line number Diff line number Diff line 
# http://editorconfig.org

# EditorConfig is a file format and collection of text editor plugins

# for maintaining consistent coding styles between different editors

# and IDEs. Most popular editors support this either natively or via

# plugin.

#

# Check https://editorconfig.org for details.



root = true



[*]
@@ -6,10 +12,23 @@ end_of_line = lf 
insert_final_newline = true

charset = utf-8



[*.mak]

indent_style = tab

indent_size = 8

file_type_emacs = makefile



[Makefile*]

indent_style = tab

indent_size = 8

file_type_emacs = makefile



[*.{c,h}]

indent_style = space

indent_size = 4



[*.{vert,frag}]

file_type_emacs = glsl



[*.json]

indent_style = space

file_type_emacs = python

chardev/char-socket.c

+91 −32
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ 
#include "chardev/char.h"

#include "io/channel-socket.h"

#include "io/channel-tls.h"

#include "io/channel-websock.h"

#include "io/net-listener.h"

#include "qemu/error-report.h"

#include "qemu/option.h"
@@ -68,6 +69,8 @@ typedef struct { 
    GSource *telnet_source;

    TCPChardevTelnetInit *telnet_init;



    bool is_websock;



    GSource *reconnect_timer;

    int64_t reconnect_time;

    bool connect_err_reported;
@@ -389,30 +392,37 @@ static void tcp_chr_free_connection(Chardev *chr) 
    s->connected = 0;

}



static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,

                                  bool is_listen, bool is_telnet)

static const char *qemu_chr_socket_protocol(SocketChardev *s)

{

    if (s->is_telnet) {

        return "telnet";

    }

    return s->is_websock ? "websocket" : "tcp";

}



static char *qemu_chr_socket_address(SocketChardev *s, const char *prefix)

{

    switch (addr->type) {

    switch (s->addr->type) {

    case SOCKET_ADDRESS_TYPE_INET:

        return g_strdup_printf("%s%s:%s:%s%s", prefix,

                               is_telnet ? "telnet" : "tcp",

                               addr->u.inet.host,

                               addr->u.inet.port,

                               is_listen ? ",server" : "");

                               qemu_chr_socket_protocol(s),

                               s->addr->u.inet.host,

                               s->addr->u.inet.port,

                               s->is_listen ? ",server" : "");

        break;

    case SOCKET_ADDRESS_TYPE_UNIX:

        return g_strdup_printf("%sunix:%s%s", prefix,

                               addr->u.q_unix.path,

                               is_listen ? ",server" : "");

                               s->addr->u.q_unix.path,

                               s->is_listen ? ",server" : "");

        break;

    case SOCKET_ADDRESS_TYPE_FD:

        return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.str,

                               is_listen ? ",server" : "");

        return g_strdup_printf("%sfd:%s%s", prefix, s->addr->u.fd.str,

                               s->is_listen ? ",server" : "");

        break;

    case SOCKET_ADDRESS_TYPE_VSOCK:

        return g_strdup_printf("%svsock:%s:%s", prefix,

                               addr->u.vsock.cid,

                               addr->u.vsock.port);

                               s->addr->u.vsock.cid,

                               s->addr->u.vsock.port);

    default:

        abort();

    }
@@ -424,8 +434,7 @@ static void update_disconnected_filename(SocketChardev *s) 


    g_free(chr->filename);

    if (s->addr) {

        chr->filename = SocketAddress_to_str("disconnected:", s->addr,

                                             s->is_listen, s->is_telnet);

        chr->filename = qemu_chr_socket_address(s, "disconnected:");

    } else {

        chr->filename = g_strdup("disconnected:socket");

    }
@@ -514,10 +523,12 @@ static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len) 
    return size;

}



static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,

                             struct sockaddr_storage *ps, socklen_t ps_len,

                             bool is_listen, bool is_telnet)

static char *qemu_chr_compute_filename(SocketChardev *s)

{

    struct sockaddr_storage *ss = &s->sioc->localAddr;

    struct sockaddr_storage *ps = &s->sioc->remoteAddr;

    socklen_t ss_len = s->sioc->localAddrLen;

    socklen_t ps_len = s->sioc->remoteAddrLen;

    char shost[NI_MAXHOST], sserv[NI_MAXSERV];

    char phost[NI_MAXHOST], pserv[NI_MAXSERV];

    const char *left = "", *right = "";
@@ -527,7 +538,7 @@ static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len, 
    case AF_UNIX:

        return g_strdup_printf("unix:%s%s",

                               ((struct sockaddr_un *)(ss))->sun_path,

                               is_listen ? ",server" : "");

                               s->is_listen ? ",server" : "");

#endif

    case AF_INET6:

        left  = "[";
@@ -539,9 +550,9 @@ static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len, 
        getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),

                    pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);

        return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",

                               is_telnet ? "telnet" : "tcp",

                               qemu_chr_socket_protocol(s),

                               left, shost, right, sserv,

                               is_listen ? ",server" : "",

                               s->is_listen ? ",server" : "",

                               left, phost, right, pserv);



    default:
@@ -576,10 +587,7 @@ static void tcp_chr_connect(void *opaque) 
    SocketChardev *s = SOCKET_CHARDEV(opaque);



    g_free(chr->filename);

    chr->filename = sockaddr_to_str(

        &s->sioc->localAddr, s->sioc->localAddrLen,

        &s->sioc->remoteAddr, s->sioc->remoteAddrLen,

        s->is_listen, s->is_telnet);

    chr->filename = qemu_chr_compute_filename(s);



    s->connected = 1;

    update_ioc_handlers(s);
@@ -709,6 +717,41 @@ cont: 
}





static void tcp_chr_websock_handshake(QIOTask *task, gpointer user_data)

{

    Chardev *chr = user_data;

    SocketChardev *s = user_data;



    if (qio_task_propagate_error(task, NULL)) {

        tcp_chr_disconnect(chr);

    } else {

        if (s->do_telnetopt) {

            tcp_chr_telnet_init(chr);

        } else {

            tcp_chr_connect(chr);

        }

    }

}





static void tcp_chr_websock_init(Chardev *chr)

{

    SocketChardev *s = SOCKET_CHARDEV(chr);

    QIOChannelWebsock *wioc = NULL;

    gchar *name;



    wioc = qio_channel_websock_new_server(s->ioc);



    name = g_strdup_printf("chardev-websocket-server-%s", chr->label);

    qio_channel_set_name(QIO_CHANNEL(wioc), name);

    g_free(name);

    object_unref(OBJECT(s->ioc));

    s->ioc = QIO_CHANNEL(wioc);



    qio_channel_websock_handshake(wioc, tcp_chr_websock_handshake, chr, NULL);

}





static void tcp_chr_tls_handshake(QIOTask *task,

                                  gpointer user_data)

{
@@ -718,7 +761,9 @@ static void tcp_chr_tls_handshake(QIOTask *task, 
    if (qio_task_propagate_error(task, NULL)) {

        tcp_chr_disconnect(chr);

    } else {

        if (s->do_telnetopt) {

        if (s->is_websock) {

            tcp_chr_websock_init(chr);

        } else if (s->do_telnetopt) {

            tcp_chr_telnet_init(chr);

        } else {

            tcp_chr_connect(chr);
@@ -804,13 +849,13 @@ static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc) 


    if (s->tls_creds) {

        tcp_chr_tls_init(chr);

    } else {

        if (s->do_telnetopt) {

    } else if (s->is_websock) {

        tcp_chr_websock_init(chr);

    } else if (s->do_telnetopt) {

        tcp_chr_telnet_init(chr);

    } else {

        tcp_chr_connect(chr);

    }

    }



    return 0;

}
@@ -954,13 +999,20 @@ static void qmp_chardev_open_socket(Chardev *chr, 
    bool is_telnet      = sock->has_telnet  ? sock->telnet  : false;

    bool is_tn3270      = sock->has_tn3270  ? sock->tn3270  : false;

    bool is_waitconnect = sock->has_wait    ? sock->wait    : false;

    bool is_websock     = sock->has_websocket ? sock->websocket : false;

    int64_t reconnect   = sock->has_reconnect ? sock->reconnect : 0;

    QIOChannelSocket *sioc = NULL;

    SocketAddress *addr;



    if (!is_listen && is_websock) {

        error_setg(errp, "%s", "Websocket client is not implemented");

        goto error;

    }



    s->is_listen = is_listen;

    s->is_telnet = is_telnet;

    s->is_tn3270 = is_tn3270;

    s->is_websock = is_websock;

    s->do_nodelay = do_nodelay;

    if (sock->tls_creds) {

        Object *creds;
@@ -997,6 +1049,10 @@ static void qmp_chardev_open_socket(Chardev *chr, 


    s->addr = addr = socket_address_flatten(sock->addr);



    if (sock->has_reconnect && addr->type == SOCKET_ADDRESS_TYPE_FD) {

        error_setg(errp, "'reconnect' option is incompatible with 'fd'");

        goto error;

    }

    qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);

    /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */

    if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
@@ -1067,6 +1123,7 @@ static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend, 
    bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);

    bool is_telnet      = qemu_opt_get_bool(opts, "telnet", false);

    bool is_tn3270      = qemu_opt_get_bool(opts, "tn3270", false);

    bool is_websock     = qemu_opt_get_bool(opts, "websocket", false);

    bool do_nodelay     = !qemu_opt_get_bool(opts, "delay", true);

    int64_t reconnect   = qemu_opt_get_number(opts, "reconnect", 0);

    const char *path = qemu_opt_get(opts, "path");
@@ -1115,9 +1172,11 @@ static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend, 
    sock->telnet = is_telnet;

    sock->has_tn3270 = true;

    sock->tn3270 = is_tn3270;

    sock->has_websocket = true;

    sock->websocket = is_websock;

    sock->has_wait = true;

    sock->wait = is_waitconnect;

    sock->has_reconnect = true;

    sock->has_reconnect = qemu_opt_find(opts, "reconnect");

    sock->reconnect = reconnect;

    sock->tls_creds = g_strdup(tls_creds);

chardev/char.c

+7 −1
Original line number Diff line number Diff line
@@ -409,7 +409,8 @@ QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename, 
    }

    if (strstart(filename, "tcp:", &p) ||

        strstart(filename, "telnet:", &p) ||

        strstart(filename, "tn3270:", &p)) {

        strstart(filename, "tn3270:", &p) ||

        strstart(filename, "websocket:", &p)) {

        if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {

            host[0] = 0;

            if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
@@ -429,6 +430,8 @@ QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename, 
            qemu_opt_set(opts, "telnet", "on", &error_abort);

        } else if (strstart(filename, "tn3270:", &p)) {

            qemu_opt_set(opts, "tn3270", "on", &error_abort);

        } else if (strstart(filename, "websocket:", &p)) {

            qemu_opt_set(opts, "websocket", "on", &error_abort);

        }

        return opts;

    }
@@ -860,6 +863,9 @@ QemuOptsList qemu_chardev_opts = { 
        },{

            .name = "tls-creds",

            .type = QEMU_OPT_STRING,

        },{

            .name = "websocket",

            .type = QEMU_OPT_BOOL,

        },{

            .name = "width",

            .type = QEMU_OPT_NUMBER,

io/channel-websock.c

+1 −0
Original line number Diff line number Diff line
@@ -163,6 +163,7 @@ qio_channel_websock_handshake_send_res(QIOChannelWebsock *ioc, 
    responselen = strlen(response);

    buffer_reserve(&ioc->encoutput, responselen);

    buffer_append(&ioc->encoutput, response, responselen);

    g_free(response);

    va_end(vargs);

}

qapi/char.json

+3 −0
Original line number Diff line number Diff line
@@ -251,6 +251,8 @@ 
#          sockets (default: false)

# @tn3270: enable tn3270 protocol on server

#          sockets (default: false) (Since: 2.10)

# @websocket: enable websocket protocol on server

#           sockets (default: false) (Since: 3.1)

# @reconnect: For a client socket, if a socket is disconnected,

#          then attempt a reconnect after the given number of seconds.

#          Setting this to zero disables this function. (default: 0)
@@ -265,6 +267,7 @@ 
                                     '*nodelay'   : 'bool',

                                     '*telnet'    : 'bool',

                                     '*tn3270'    : 'bool',

                                     '*websocket' : 'bool',

                                     '*reconnect' : 'int' },

  'base': 'ChardevCommon' }