fixes #823 Define public IPC (#824)

This introduces a basic IPC API, modeled on the TCP API, for direct access.
Only connection options are exposed at present -- we need to add options
for dialers and listeners (and particularly listener settings for
permissions and security attributes.)  Documentation is still outstanding,
but a very limited test suite exists.

1 files changed, 145 insertions, 0 deletions

diff --git a/tests/ipcsupp.c b/tests/ipcsupp.c
new file mode 100644
index 00000000..6ea0639a
--- /dev/null
+++ b/tests/ipcsupp.c
@@ -0,0 +1,145 @@
+//
+// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2018 Capitar IT Group BV <info@capitar.com>
+// Copyright 2018 Devolutions <infos@devolutions.net>
+//
+// 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 <string.h>
+
+#include <nng/nng.h>
+#include <nng/supplemental/ipc/ipc.h>
+
+#include "convey.h"
+#include "stubs.h"
+
+static uint8_t loopback[4] = { 127, 0, 0, 1 };
+
+TestMain("Supplemental IPC", {
+	atexit(nng_fini);
+	Convey("We can create a dialer and listener", {
+		nng_ipc_dialer *  d;
+		nng_ipc_listener *l;
+		So(nng_ipc_dialer_alloc(&d) == 0);
+		So(nng_ipc_listener_alloc(&l) == 0);
+		Reset({
+			nng_ipc_listener_close(l);
+			nng_ipc_dialer_close(d);
+			nng_ipc_listener_free(l);
+			nng_ipc_dialer_free(d);
+		});
+		Convey("Listener listens (wildcard)", {
+			nng_sockaddr sa;
+			uint32_t     ip;
+
+			memcpy(&ip, loopback, 4);
+
+			sa.s_ipc.sa_family = NNG_AF_IPC;
+			snprintf(sa.s_ipc.sa_path, sizeof(sa.s_ipc.sa_path),
+			    "%s", "/tmp/ipc_supp_test");
+
+			So(nng_ipc_listener_listen(l, &sa) == 0);
+
+			Convey("We can dial it", {
+				nng_aio *daio = NULL;
+				nng_aio *laio = NULL;
+				nng_aio *maio = NULL;
+				nng_ipc *c1   = NULL;
+				nng_ipc *c2   = NULL;
+
+				So(nng_aio_alloc(&daio, NULL, NULL) == 0);
+				So(nng_aio_alloc(&laio, NULL, NULL) == 0);
+				So(nng_aio_alloc(&maio, NULL, NULL) == 0);
+
+				Reset({
+					nng_aio_free(daio);
+					nng_aio_free(laio);
+					if (c1 != NULL) {
+						nng_ipc_close(c1);
+						nng_ipc_free(c1);
+					}
+					if (c2 != NULL) {
+						nng_ipc_close(c2);
+						nng_ipc_free(c2);
+					}
+				});
+
+				nng_ipc_dialer_dial(d, &sa, daio);
+				nng_ipc_listener_accept(l, laio);
+
+				nng_aio_wait(daio);
+				nng_aio_wait(laio);
+
+				So(nng_aio_result(daio) == 0);
+				So(nng_aio_result(laio) == 0);
+
+				c1 = nng_aio_get_output(daio, 0);
+				c2 = nng_aio_get_output(laio, 0);
+				So(c1 != NULL);
+				So(c2 != NULL);
+
+				Convey("They exchange messages", {
+					nng_aio *    aio1;
+					nng_aio *    aio2;
+					nng_iov      iov;
+					nng_sockaddr sa2;
+					char         buf1[5];
+					char         buf2[5];
+
+					So(nng_aio_alloc(&aio1, NULL, NULL) ==
+					    0);
+					So(nng_aio_alloc(&aio2, NULL, NULL) ==
+					    0);
+
+					Reset({
+						nng_aio_free(aio1);
+						nng_aio_free(aio2);
+					});
+
+					// This relies on send completing for
+					// for just 5 bytes, and on recv doing
+					// the same.  Technically this isn't
+					// guaranteed, but it would be weird
+					// to split such a small payload.
+					memcpy(buf1, "TEST", 5);
+					memset(buf2, 0, 5);
+					iov.iov_buf = buf1;
+					iov.iov_len = 5;
+
+					nng_aio_set_iov(aio1, 1, &iov);
+
+					iov.iov_buf = buf2;
+					iov.iov_len = 5;
+					nng_aio_set_iov(aio2, 1, &iov);
+					nng_ipc_send(c1, aio1);
+					nng_ipc_recv(c2, aio2);
+					nng_aio_wait(aio1);
+					nng_aio_wait(aio2);
+
+					So(nng_aio_result(aio1) == 0);
+					So(nng_aio_count(aio1) == 5);
+
+					So(nng_aio_result(aio2) == 0);
+					So(nng_aio_count(aio2) == 5);
+
+					So(memcmp(buf1, buf2, 5) == 0);
+
+					Convey("Socket name matches", {
+						size_t rsz = sizeof(sa2);
+						So(nng_ipc_getopt(c2,
+						       NNG_OPT_LOCADDR, &sa2,
+						       &rsz) == 0);
+						So(sa2.s_ipc.sa_family ==
+						    NNG_AF_IPC);
+						So(strcmp(sa2.s_ipc.sa_path,
+						       sa.s_ipc.sa_path) == 0);
+					});
+				});
+			});
+		});
+	});
+})