Re: [Qemu-devel] [PATCH v3 1/2] tests: Add test-listen - a stress test for QEMU socket listen

[Daniel P. Berrange]

On Wed, Jun 14, 2017 at 06:53:51PM +0200, Knut Omang wrote:
> There's a potential race condition between multiple bind()'s
> attempting to bind to the same port, which occasionally
> allows more than one bind to succeed against the same port.
> 
> When a subsequent listen() call is made with the same socket
> only one will succeed.
> 
> The current QEMU code does however not take this situation into account
> and the listen will cause the code to break out and fail even
> when there are actually available ports to use.
> 
> This test exposes two subtests:
> 
> /socket/listen-serial
> /socket/listen-compete
> 
> The "compete" subtest creates a number of threads and have them all trying to 
> bind
> to the same port with a large enough offset input to
> allow all threads to get it's own port.
> The "serial" subtest just does the same, except in series in a
> single thread.
> 
> The serial version passes, probably in most versions of QEMU.
> 
> The parallel version exposes the problem in a relatively reliable way,
> eg. it fails a majority of times, but not with a 100% rate, occasional
> passes can be seen. Nevertheless this is quite good given that
> the bug was tricky to reproduce and has been left undetected for
> a while.
> 
> The problem seems to be present in all versions of QEMU.
> 
> The original failure scenario occurred with VNC port allocation
> in a traditional Xen based build, in different code
> but with similar functionality.
> 
> Reported-by: Bhavesh Davda <address@hidden>
> Signed-off-by: Knut Omang <address@hidden>
> Reviewed-by: Yuval Shaia <address@hidden>
> Reviewed-by: Bhavesh Davda <address@hidden>
> Reviewed-by: Girish Moodalbail <address@hidden>
> ---
>  tests/Makefile.include |   2 +-
>  tests/test-listen.c    | 141 ++++++++++++++++++++++++++++++++++++++++++-
>  2 files changed, 143 insertions(+)
>  create mode 100644 tests/test-listen.c
> 
> diff --git a/tests/Makefile.include b/tests/Makefile.include
> index 7180fe4..22bb97e 100644
> --- a/tests/Makefile.include
> +++ b/tests/Makefile.include
> @@ -127,6 +127,7 @@ check-unit-y += tests/test-bufferiszero$(EXESUF)
>  gcov-files-check-bufferiszero-y = util/bufferiszero.c
>  check-unit-y += tests/test-uuid$(EXESUF)
>  check-unit-y += tests/ptimer-test$(EXESUF)
> +#check-unit-y += tests/test-listen$(EXESUF)

Did you really mean to leave this commented out ?

> diff --git a/tests/test-listen.c b/tests/test-listen.c
> new file mode 100644
> index 0000000..45fe9a8
> --- /dev/null
> +++ b/tests/test-listen.c
> @@ -0,0 +1,141 @@
> +/*
> + * Test parallel port listen configuration with
> + * dynamic port allocation
> + */

Should stick a standard license header on this new file

> +
> +#include "qemu/osdep.h"
> +#include "libqtest.h"
> +#include "qemu-common.h"
> +#include "qemu/thread.h"
> +#include "qemu/sockets.h"
> +#include "qapi/error.h"
> +
> +#define NAME_LEN 1024
> +#define PORT_LEN 16
> +
> +struct thr_info {
> +    QemuThread thread;
> +    int to_port;
> +    int got_port;
> +    int eno;
> +    int fd;
> +    const char *errstr;
> +};
> +
> +static char hostname[NAME_LEN + 1];
> +static char port[PORT_LEN + 1];
> +
> +static void *listener_thread(void *arg)
> +{
> +    struct thr_info *thr = (struct thr_info *)arg;
> +    SocketAddress addr = {
> +        .type = SOCKET_ADDRESS_TYPE_INET,
> +        .u = {
> +            .inet = {
> +                .host = hostname,
> +                .port = port,
> +                .ipv4 = true,

.ipv4 is ignored unless you set  .has_ipv4 too.

I'd inclined to allow ipv6 too though, since that's normal
usage scenario out of the box.

Or repeat the test multiple times, with ipv4 only, ipv6
only and ipv4/ipv6 automatic.

> +                .has_to = true,
> +                .to = thr->to_port,
> +            },
> +        },
> +    };
> +    Error *err = NULL;
> +    int fd;
> +
> +    fd = socket_listen(&addr, &err);
> +    if (fd < 0) {
> +        thr->eno = errno;
> +        thr->errstr = error_get_pretty(err);
> +    } else {
> +        struct sockaddr_in a;
> +        socklen_t a_len = sizeof(a);
> +        g_assert_cmpint(getsockname(fd, (struct sockaddr *)&a, &a_len), ==, 
> 0);
> +        thr->got_port = ntohs(a.sin_port);
> +        thr->fd = fd;
> +    }
> +    return arg;
> +}
> +
> +
> +static void listen_compete_nthr(bool threaded, int nthreads,
> +                                int start_port, int max_offset)
> +{
> +    int i;
> +    int failed_listens = 0;
> +    size_t alloc_sz = sizeof(struct thr_info) * nthreads;
> +    struct thr_info *thr = g_malloc(alloc_sz);

These two lines are reinventing g_new - just do

  struct thr_info *thr = g_new0(struct thr_info, nthreads);

> +    int used[max_offset + 1];
> +    memset(used, 0, sizeof(used));
> +    g_assert_nonnull(thr);

It is already guaranteed non-null by g_new

> +    g_assert_cmpint(gethostname(hostname, NAME_LEN), == , 0);
> +    snprintf(port, PORT_LEN, "%d", start_port);

Just use "localhost" instead of the public hostname

Also, storing data in global variables is going to fail if
the test harness runs both tests in parallel. Better to
pass the required data into the thread main method via
the thr_info struct.

> +    memset(thr, 0, alloc_sz);

g_new0 will set it to zeros

> +
> +    for (i = 0; i < nthreads; i++) {
> +        thr[i].to_port = start_port + max_offset;
> +        if (threaded) {
> +            qemu_thread_create(&thr[i].thread, "listener",
> +                               listener_thread, &thr[i],
> +                               QEMU_THREAD_JOINABLE);
> +        } else {
> +            listener_thread(&thr[i]);
> +        }
> +    }
> +
> +    if (threaded) {
> +        for (i = 0; i < nthreads; i++) {
> +            qemu_thread_join(&thr[i].thread);
> +        }
> +    }
> +    for (i = 0; i < nthreads; i++) {
> +        if (thr[i].got_port) {
> +            closesocket(thr[i].fd);
> +        }
> +    }
> +
> +    for (i = 0; i < nthreads; i++) {
> +        if (thr[i].eno != 0) {
> +            const char *m;
> +            printf("** Failed to assign a port to thread %d (errno = %d)\n",
> +                   i, thr[i].eno);

I'd suggest  g_printerr() instead so it gets to stderr without buffering

> +            /* This is what we are interested in capturing -
> +             * catch and report details if something unexpected happens:
> +             */
> +            m = strstr(thr[i].errstr, "Failed to listen on socket");
> +            if (m != NULL) {
> +                g_assert_cmpstr(thr[i].errstr, ==,
> +                    "Failed to listen on socket: Address already in use");
> +            }
> +            failed_listens++;
> +        } else {
> +            int assigned_port = thr[i].got_port;
> +            g_assert_cmpint(assigned_port, <= , thr[i].to_port);
> +            g_assert_cmpint(used[assigned_port - start_port], == , 0);
> +        }
> +    }
> +    g_assert_cmpint(failed_listens, ==, 0);
> +    free(thr);

Needs to be g_free, not free

> +}
> +
> +
> +static void listen_compete(void)
> +{
> +    listen_compete_nthr(true, 200, 5920, 300);
> +}
> +
> +static void listen_serial(void)
> +{
> +    listen_compete_nthr(false, 200, 6300, 300);
> +}
> +
> +
> +int main(int argc, char **argv)
> +{
> +    g_test_init(&argc, &argv, NULL);
> +
> +    g_test_add_func("/socket/listen-serial", listen_serial);
> +    g_test_add_func("/socket/listen-compete", listen_compete);

Not all our CI systems have network access. You'll want todo a check for
access first, and exit if not available. See check_protocol_support() in
test-io-channel-socket.c for example.

> +
> +    return g_test_run();
> +}
> -- 
> git-series 0.9.1

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|