Bus socket converted to use lmq.

This should give significant performance boosts to anyone using this
protocol.  Buffering on both the send and receive side is supported,
with a default buffer size of 16 messages.  This should help provide
a reasonable default case for most users.

While here updated the test for bus to much more complete
NUTS style test framework, with increased coverage.

1 files changed, 423 insertions, 0 deletions

diff --git a/src/sp/protocol/bus0/bus_test.c b/src/sp/protocol/bus0/bus_test.c
new file mode 100644
index 00000000..77d2b4d6
--- /dev/null
+++ b/src/sp/protocol/bus0/bus_test.c
@@ -0,0 +1,423 @@
+//
+// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech>
+//
+// This software is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt).  A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+#include <nuts.h>
+
+#include <nng/protocol/bus0/bus.h>
+
+#define SECOND 1000
+
+void
+test_bus_identity(void)
+{
+	nng_socket s;
+	int        p;
+	char      *n;
+
+	NUTS_PASS(nng_bus0_open(&s));
+	NUTS_PASS(nng_socket_get_int(s, NNG_OPT_PROTO, &p));
+	NUTS_TRUE(p == NNG_BUS0_SELF);
+	NUTS_PASS(nng_socket_get_int(s, NNG_OPT_PEER, &p));
+	NUTS_TRUE(p == NNG_BUS0_PEER); // 49
+	NUTS_PASS(nng_socket_get_string(s, NNG_OPT_PROTONAME, &n));
+	NUTS_MATCH(n, NNG_BUS0_SELF_NAME);
+	nng_strfree(n);
+	NUTS_PASS(nng_socket_get_string(s, NNG_OPT_PEERNAME, &n));
+	NUTS_MATCH(n, NNG_BUS0_PEER_NAME);
+	nng_strfree(n);
+	NUTS_CLOSE(s);
+}
+
+static void
+test_bus_star(void)
+{
+	nng_socket s1, s2, s3;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_PASS(nng_bus0_open(&s3));
+
+	NUTS_PASS(nng_setopt_ms(s1, NNG_OPT_RECVTIMEO, SECOND));
+	NUTS_PASS(nng_setopt_ms(s2, NNG_OPT_RECVTIMEO, SECOND));
+	NUTS_PASS(nng_setopt_ms(s3, NNG_OPT_RECVTIMEO, SECOND));
+
+	NUTS_MARRY(s1, s2);
+	NUTS_MARRY(s1, s3);
+
+	NUTS_SEND(s1, "one");
+	NUTS_RECV(s2, "one");
+	NUTS_RECV(s3, "one");
+
+	NUTS_SEND(s2, "two");
+	NUTS_SEND(s1, "one");
+	NUTS_RECV(s1, "two");
+	NUTS_RECV(s2, "one");
+	NUTS_RECV(s3, "one");
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+	NUTS_CLOSE(s3);
+}
+
+static void
+test_bus_device(void)
+{
+	nng_socket s1, s2, s3;
+	nng_socket none = NNG_SOCKET_INITIALIZER;
+	nng_aio *aio;
+
+	NUTS_PASS(nng_bus0_open_raw(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_PASS(nng_bus0_open(&s3));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+
+	NUTS_PASS(nng_setopt_ms(s1, NNG_OPT_RECVTIMEO, SECOND));
+	NUTS_PASS(nng_setopt_ms(s2, NNG_OPT_RECVTIMEO, SECOND));
+	NUTS_PASS(nng_setopt_ms(s3, NNG_OPT_RECVTIMEO, SECOND));
+
+	NUTS_MARRY(s1, s2);
+	NUTS_MARRY(s1, s3);
+
+	nng_device_aio(aio, s1, none);
+
+	NUTS_SEND(s2, "two");
+	NUTS_SEND(s3, "three");
+	NUTS_RECV(s2, "three");
+	NUTS_RECV(s3, "two");
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+	NUTS_CLOSE(s3);
+
+	nng_aio_free(aio);
+}
+
+static void
+test_bus_validate_peer(void)
+{
+	nng_socket s1, s2;
+	nng_stat  *stats;
+	nng_stat  *reject;
+	char      *addr;
+
+	NUTS_ADDR(addr, "inproc");
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_pair0_open(&s2));
+
+	NUTS_PASS(nng_listen(s1, addr, NULL, 0));
+	NUTS_PASS(nng_dial(s2, addr, NULL, NNG_FLAG_NONBLOCK));
+
+	NUTS_SLEEP(100);
+	NUTS_PASS(nng_stats_get(&stats));
+
+	NUTS_TRUE(stats != NULL);
+	NUTS_TRUE((reject = nng_stat_find_socket(stats, s1)) != NULL);
+	NUTS_TRUE((reject = nng_stat_find(reject, "reject")) != NULL);
+
+	NUTS_TRUE(nng_stat_type(reject) == NNG_STAT_COUNTER);
+	NUTS_TRUE(nng_stat_value(reject) > 0);
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+	nng_stats_free(stats);
+}
+
+static void
+test_bus_no_context(void)
+{
+	nng_socket s;
+	nng_ctx    ctx;
+
+	NUTS_PASS(nng_bus0_open(&s));
+	NUTS_FAIL(nng_ctx_open(&ctx, s), NNG_ENOTSUP);
+	NUTS_CLOSE(s);
+}
+
+static void
+test_bus_recv_cancel(void)
+{
+	nng_socket s1;
+	nng_aio   *aio;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+
+	nng_aio_set_timeout(aio, SECOND);
+	nng_recv_aio(s1, aio);
+	nng_aio_abort(aio, NNG_ECANCELED);
+
+	nng_aio_wait(aio);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECANCELED);
+	NUTS_CLOSE(s1);
+	nng_aio_free(aio);
+}
+
+static void
+test_bus_close_recv_abort(void)
+{
+	nng_socket s1;
+	nng_aio   *aio;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+
+	nng_aio_set_timeout(aio, SECOND);
+	nng_recv_aio(s1, aio);
+	NUTS_CLOSE(s1);
+
+	nng_aio_wait(aio);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECLOSED);
+	nng_aio_free(aio);
+}
+
+static void
+test_bus_aio_stopped(void)
+{
+	nng_socket s1;
+	nng_aio   *aio;
+	nng_msg   *msg;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_msg_alloc(&msg, 0));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	nng_aio_stop(aio);
+
+	nng_recv_aio(s1, aio);
+	nng_aio_wait(aio);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECANCELED);
+
+	nng_aio_set_msg(aio, msg);
+	nng_send_aio(s1, aio);
+	nng_aio_wait(aio);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECANCELED);
+
+	nng_aio_free(aio);
+	nng_msg_free(msg);
+	NUTS_CLOSE(s1);
+}
+
+static void
+test_bus_send_no_pipes(void)
+{
+	nng_socket s1;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_SEND(s1, "DROP1");
+	NUTS_SEND(s1, "DROP2");
+	NUTS_CLOSE(s1);
+}
+
+static void
+test_bus_send_flood(void)
+{
+	nng_socket s1, s2;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_PASS(nng_socket_set_int(s2, NNG_OPT_SENDBUF, 1));
+
+	// Even after connect (no message yet)
+	NUTS_MARRY(s1, s2);
+
+	// Even if we send messages.
+	for (int i = 0; i < 1000; i++) {
+		NUTS_SEND(s2, "one thousand");
+	}
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+}
+
+static void
+test_bus_poll_readable(void)
+{
+	int        fd;
+	nng_socket s1, s2;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_PASS(nng_socket_set_ms(s1, NNG_OPT_RECVTIMEO, 1000));
+	NUTS_PASS(nng_socket_set_ms(s2, NNG_OPT_SENDTIMEO, 1000));
+	NUTS_PASS(nng_socket_get_int(s1, NNG_OPT_RECVFD, &fd));
+	NUTS_TRUE(fd >= 0);
+
+	// Not readable if not connected!
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
+
+	// Even after connect (no message yet)
+	NUTS_MARRY(s2, s1);
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
+
+	// But once we send messages, it is.
+	// We have to send a request, in order to send a reply.
+	NUTS_SEND(s2, "abc");
+	NUTS_SLEEP(100);
+	NUTS_TRUE(nuts_poll_fd(fd));
+
+	// and receiving makes it no longer ready
+	NUTS_RECV(s1, "abc");
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
+
+	NUTS_CLOSE(s2);
+	NUTS_CLOSE(s1);
+}
+
+static void
+test_bus_poll_writeable(void)
+{
+	int        fd;
+	nng_socket s1, s2;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_PASS(nng_socket_set_int(s2, NNG_OPT_SENDBUF, 1));
+	NUTS_PASS(nng_socket_get_int(s2, NNG_OPT_SENDFD, &fd));
+	NUTS_TRUE(fd >= 0);
+
+	// Pub is *always* writeable
+	NUTS_TRUE(nuts_poll_fd(fd));
+
+	// Even after connect (no message yet)
+	NUTS_MARRY(s1, s2);
+	NUTS_TRUE(nuts_poll_fd(fd));
+
+	// Even if we send messages.
+	NUTS_SEND(s2, "abc");
+	NUTS_TRUE(nuts_poll_fd(fd));
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+}
+
+static void
+test_bus_recv_buf_option(void)
+{
+	nng_socket  s;
+	int         v;
+	bool        b;
+	size_t      sz;
+	const char *opt = NNG_OPT_RECVBUF;
+
+	NUTS_PASS(nng_bus0_open(&s));
+
+	NUTS_PASS(nng_socket_set_int(s, opt, 1));
+	NUTS_FAIL(nng_socket_set_int(s, opt, 0), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_int(s, opt, -1), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_int(s, opt, 1000000), NNG_EINVAL);
+	NUTS_PASS(nng_socket_set_int(s, opt, 3));
+	NUTS_PASS(nng_socket_get_int(s, opt, &v));
+	NUTS_TRUE(v == 3);
+	v  = 0;
+	sz = sizeof(v);
+	NUTS_PASS(nng_socket_get(s, opt, &v, &sz));
+	NUTS_TRUE(v == 3);
+	NUTS_TRUE(sz == sizeof(v));
+
+	NUTS_FAIL(nng_socket_set(s, opt, "", 1), NNG_EINVAL);
+	sz = 1;
+	NUTS_FAIL(nng_socket_get(s, opt, &v, &sz), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_bool(s, opt, true), NNG_EBADTYPE);
+	NUTS_FAIL(nng_socket_get_bool(s, opt, &b), NNG_EBADTYPE);
+
+	NUTS_CLOSE(s);
+}
+
+static void
+test_bus_send_buf_option(void)
+{
+	nng_socket  s1;
+	nng_socket  s2;
+	int         v;
+	bool        b;
+	size_t      sz;
+	const char *opt = NNG_OPT_SENDBUF;
+
+	NUTS_PASS(nng_bus0_open(&s1));
+	NUTS_PASS(nng_bus0_open(&s2));
+	NUTS_MARRY(s1, s2);
+
+	NUTS_PASS(nng_socket_set_int(s1, opt, 1));
+	NUTS_FAIL(nng_socket_set_int(s1, opt, 0), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_int(s1, opt, -1), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_int(s1, opt, 1000000), NNG_EINVAL);
+	NUTS_PASS(nng_socket_set_int(s1, opt, 3));
+	NUTS_PASS(nng_socket_get_int(s1, opt, &v));
+	NUTS_TRUE(v == 3);
+	v  = 0;
+	sz = sizeof(v);
+	NUTS_PASS(nng_socket_get(s1, opt, &v, &sz));
+	NUTS_TRUE(v == 3);
+	NUTS_TRUE(sz == sizeof(v));
+
+	NUTS_FAIL(nng_socket_set(s1, opt, "", 1), NNG_EINVAL);
+	sz = 1;
+	NUTS_FAIL(nng_socket_get(s1, opt, &v, &sz), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_bool(s1, opt, true), NNG_EBADTYPE);
+	NUTS_FAIL(nng_socket_get_bool(s1, opt, &b), NNG_EBADTYPE);
+
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
+}
+
+static void
+test_bus_cooked(void)
+{
+	nng_socket s;
+	bool       b;
+
+	NUTS_PASS(nng_bus0_open(&s));
+	NUTS_PASS(nng_socket_get_bool(s, NNG_OPT_RAW, &b));
+	NUTS_TRUE(!b);
+	NUTS_FAIL(nng_socket_set_bool(s, NNG_OPT_RAW, true), NNG_EREADONLY);
+	NUTS_PASS(nng_close(s));
+
+	// raw pub only differs in the option setting
+	NUTS_PASS(nng_bus0_open_raw(&s));
+	NUTS_PASS(nng_socket_get_bool(s, NNG_OPT_RAW, &b));
+	NUTS_TRUE(b);
+	NUTS_CLOSE(s);
+}
+
+static void
+test_bug1247(void)
+{
+	nng_socket bus1, bus2;
+	char      *addr;
+
+	NUTS_ADDR(addr, "tcp");
+
+	NUTS_PASS(nng_bus0_open(&bus1));
+	NUTS_PASS(nng_bus0_open(&bus2));
+
+	NUTS_PASS(nng_listen(bus1, addr, NULL, 0));
+	NUTS_FAIL(nng_listen(bus2, addr, NULL, 0), NNG_EADDRINUSE);
+
+	NUTS_CLOSE(bus2);
+	NUTS_CLOSE(bus1);
+}
+
+TEST_LIST = {
+	{ "bus identity", test_bus_identity },
+	{ "bus star", test_bus_star },
+	{ "bus device", test_bus_device },
+	{ "bus validate peer", test_bus_validate_peer },
+	{ "bus no context", test_bus_no_context },
+	{ "bus poll read", test_bus_poll_readable },
+	{ "bus poll write", test_bus_poll_writeable },
+	{ "bus send no pipes", test_bus_send_no_pipes },
+	{ "bus send flood", test_bus_send_flood },
+	{ "bus recv cancel", test_bus_recv_cancel },
+	{ "bus close recv abort", test_bus_close_recv_abort },
+	{ "bus aio stopped", test_bus_aio_stopped },
+	{ "bus recv buf option", test_bus_recv_buf_option },
+	{ "bus send buf option", test_bus_send_buf_option },
+	{ "bus cooked", test_bus_cooked },
+	{ "bug1247", test_bug1247 },
+	{ NULL, NULL },
+};