Generalised point-to-point messaging (faasm#151)

* Skeleton for point to point messaging setup

* More groundwork for point to point

* Tidy up

* formatting

* Test for registry

* Mocked test for sending mappings

* Mappings tests

* Fleshing out rest of implementation

* Test for point to point messaging

* Rename and tidy

* Sleep to enforce asyncness

* Caching sockets

* Naming and general tidy

* Formatting

* Mock tests for broadcast mappings

* Test for send back and forth

* Stop ptp server

* Add failing dist test

* Fix up point-to-point dist test

* Formatting

* Tidy-up

* Review comments

include/faabric/runner/FaabricMain.h

@@ -5,6 +5,7 @@
 #include <faabric/scheduler/Scheduler.h>
 #include <faabric/snapshot/SnapshotServer.h>
 #include <faabric/state/StateServer.h>
+#include <faabric/transport/PointToPointServer.h>
 #include <faabric/util/config.h>
 
 namespace faabric::runner {
@@ -23,11 +24,14 @@ class FaabricMain
 
     void startSnapshotServer();
 
+    void startPointToPointServer();
+
     void shutdown();
 
   private:
     faabric::state::StateServer stateServer;
     faabric::scheduler::FunctionCallServer functionServer;
     faabric::snapshot::SnapshotServer snapshotServer;
+    faabric::transport::PointToPointServer pointToPointServer;
 };
 }

include/faabric/transport/MessageEndpoint.h

@@ -80,7 +80,18 @@ class AsyncSendMessageEndpoint final : public MessageEndpoint
 
     void send(const uint8_t* data, size_t dataSize, bool more = false);
 
-    zmq::socket_t pushSocket;
+    zmq::socket_t socket;
+};
+
+class AsyncInternalSendMessageEndpoint final : public MessageEndpoint
+{
+  public:
+    AsyncInternalSendMessageEndpoint(const std::string& inProcLabel,
+                                     int timeoutMs = DEFAULT_RECV_TIMEOUT_MS);
+
+    void send(const uint8_t* data, size_t dataSize, bool more = false);
+
+    zmq::socket_t socket;
 };
 
 class SyncSendMessageEndpoint final : public MessageEndpoint
@@ -183,6 +194,15 @@ class AsyncRecvMessageEndpoint final : public RecvMessageEndpoint
     std::optional<Message> recv(int size = 0) override;
 };
 
+class AsyncInternalRecvMessageEndpoint final : public RecvMessageEndpoint
+{
+  public:
+    AsyncInternalRecvMessageEndpoint(const std::string& inprocLabel,
+                                     int timeoutMs = DEFAULT_RECV_TIMEOUT_MS);
+
+    std::optional<Message> recv(int size = 0) override;
+};
+
 class SyncRecvMessageEndpoint final : public RecvMessageEndpoint
 {
   public:

include/faabric/transport/MessageEndpointClient.h

@@ -30,7 +30,6 @@ class MessageEndpointClient
   protected:
     const std::string host;
 
-  private:
     const int asyncPort;
 
     const int syncPort;

include/faabric/transport/MessageEndpointServer.h

@@ -56,6 +56,8 @@ class MessageEndpointServer
 
     virtual void stop();
 
+    virtual void onWorkerStop();
+
     void setRequestLatch();
 
     void awaitRequestLatch();

include/faabric/transport/PointToPointBroker.h

@@ -0,0 +1,52 @@
+#pragma once
+
+#include <faabric/scheduler/Scheduler.h>
+#include <faabric/transport/PointToPointClient.h>
+
+#include <set>
+#include <shared_mutex>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+namespace faabric::transport {
+class PointToPointBroker
+{
+  public:
+    PointToPointBroker();
+
+    std::string getHostForReceiver(int appId, int recvIdx);
+
+    void setHostForReceiver(int appId, int recvIdx, const std::string& host);
+
+    void broadcastMappings(int appId);
+
+    void sendMappings(int appId, const std::string& host);
+
+    std::set<int> getIdxsRegisteredForApp(int appId);
+
+    void sendMessage(int appId,
+                     int sendIdx,
+                     int recvIdx,
+                     const uint8_t* buffer,
+                     size_t bufferSize);
+
+    std::vector<uint8_t> recvMessage(int appId, int sendIdx, int recvIdx);
+
+    void clear();
+
+    void resetThreadLocalCache();
+
+  private:
+    std::shared_mutex brokerMutex;
+
+    std::unordered_map<int, std::set<int>> appIdxs;
+    std::unordered_map<std::string, std::string> mappings;
+
+    std::shared_ptr<PointToPointClient> getClient(const std::string& host);
+
+    faabric::scheduler::Scheduler& sch;
+};
+
+PointToPointBroker& getPointToPointBroker();
+}

include/faabric/transport/PointToPointCall.h

@@ -0,0 +1,10 @@
+#pragma once
+
+namespace faabric::transport {
+
+enum PointToPointCall
+{
+    MAPPING = 0,
+    MESSAGE = 1
+};
+}

include/faabric/transport/PointToPointClient.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include <faabric/proto/faabric.pb.h>
+#include <faabric/transport/MessageEndpointClient.h>
+
+namespace faabric::transport {
+
+std::vector<std::pair<std::string, faabric::PointToPointMappings>>
+getSentMappings();
+
+std::vector<std::pair<std::string, faabric::PointToPointMessage>>
+getSentPointToPointMessages();
+
+void clearSentMessages();
+
+class PointToPointClient : public faabric::transport::MessageEndpointClient
+{
+  public:
+    PointToPointClient(const std::string& hostIn);
+
+    void sendMappings(faabric::PointToPointMappings& mappings);
+
+    void sendMessage(faabric::PointToPointMessage& msg);
+};
+}

include/faabric/transport/PointToPointServer.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include <faabric/transport/MessageEndpointServer.h>
+#include <faabric/transport/PointToPointBroker.h>
+
+namespace faabric::transport {
+
+class PointToPointServer final : public MessageEndpointServer
+{
+  public:
+    PointToPointServer();
+
+  private:
+    PointToPointBroker& reg;
+
+    void doAsyncRecv(int header,
+                     const uint8_t* buffer,
+                     size_t bufferSize) override;
+
+    std::unique_ptr<google::protobuf::Message>
+    doSyncRecv(int header, const uint8_t* buffer, size_t bufferSize) override;
+
+    void onWorkerStop() override;
+
+    std::unique_ptr<google::protobuf::Message> doRecvMappings(
+      const uint8_t* buffer,
+      size_t bufferSize);
+};
+}

include/faabric/transport/common.h

@@ -15,3 +15,7 @@
 #define SNAPSHOT_ASYNC_PORT 8007
 #define SNAPSHOT_SYNC_PORT 8008
 #define SNAPSHOT_INPROC_LABEL "snapshot"
+
+#define POINT_TO_POINT_ASYNC_PORT 8009
+#define POINT_TO_POINT_SYNC_PORT 8010
+#define POINT_TO_POINT_INPROC_LABEL "ptp"

include/faabric/util/bytes.h

@@ -12,6 +12,8 @@ std::vector<uint8_t> stringToBytes(const std::string& str);
 
 std::string bytesToString(const std::vector<uint8_t>& bytes);
 
+std::string formatByteArrayToIntString(const std::vector<uint8_t>& bytes);
+
 void trimTrailingZeros(std::vector<uint8_t>& vectorIn);
 
 int safeCopyToBuffer(const std::vector<uint8_t>& dataIn,

include/faabric/util/config.h

@@ -47,6 +47,7 @@ class SystemConfig
     int functionServerThreads;
     int stateServerThreads;
     int snapshotServerThreads;
+    int pointToPointServerThreads;
 
     SystemConfig();
 

src/proto/faabric.proto

@@ -200,3 +200,24 @@ message StateAppendedResponse {
     string key = 2;
     repeated AppendedValue values = 3;
 }
+
+// ---------------------------------------------
+// POINT-TO-POINT
+// ---------------------------------------------
+
+message PointToPointMessage {
+    int32 appId = 1;
+    int32 sendIdx = 2;
+    int32 recvIdx = 3;
+
+    bytes data = 4;
+}
+
+message PointToPointMappings {
+    message PointToPointMapping {
+        int32 appId = 1;
+        int32 recvIdx = 2;
+        string host = 3;
+    }
+    repeated PointToPointMapping mappings = 1;
+}

src/runner/FaabricMain.cpp

@@ -34,6 +34,9 @@ void FaabricMain::startBackground()
     // Snapshots
     startSnapshotServer();
 
+    // Point-to-point messaging
+    startPointToPointServer();
+
     // Work sharing
     startFunctionCallServer();
 }
@@ -60,6 +63,12 @@ void FaabricMain::startSnapshotServer()
     snapshotServer.start();
 }
 
+void FaabricMain::startPointToPointServer()
+{
+    SPDLOG_INFO("Starting point-to-point server");
+    pointToPointServer.start();
+}
+
 void FaabricMain::startStateServer()
 {
     // Skip state server if not in inmemory mode
@@ -88,6 +97,9 @@ void FaabricMain::shutdown()
     SPDLOG_INFO("Waiting for the snapshot server to finish");
     snapshotServer.stop();
 
+    SPDLOG_INFO("Waiting for the point-to-point server to finish");
+    pointToPointServer.stop();
+
     auto& sch = faabric::scheduler::getScheduler();
     sch.shutdown();
 

src/transport/CMakeLists.txt

@@ -11,6 +11,9 @@ set(HEADERS
     "${FAABRIC_INCLUDE_DIR}/faabric/transport/MessageEndpointClient.h"
     "${FAABRIC_INCLUDE_DIR}/faabric/transport/MessageEndpointServer.h"
     "${FAABRIC_INCLUDE_DIR}/faabric/transport/MpiMessageEndpoint.h"
+    "${FAABRIC_INCLUDE_DIR}/faabric/transport/PointToPointBroker.h"
+    "${FAABRIC_INCLUDE_DIR}/faabric/transport/PointToPointClient.h"
+    "${FAABRIC_INCLUDE_DIR}/faabric/transport/PointToPointServer.h"
 )
 
 set(LIB_FILES
@@ -20,6 +23,9 @@ set(LIB_FILES
     MessageEndpointClient.cpp
     MessageEndpointServer.cpp
     MpiMessageEndpoint.cpp
+    PointToPointBroker.cpp
+    PointToPointClient.cpp
+    PointToPointServer.cpp
     ${HEADERS}
 )
 

src/transport/MessageEndpoint.cpp

@@ -313,22 +313,39 @@ AsyncSendMessageEndpoint::AsyncSendMessageEndpoint(const std::string& hostIn,
                                                    int timeoutMs)
   : MessageEndpoint(hostIn, portIn, timeoutMs)
 {
-    pushSocket =
+    socket =
       setUpSocket(zmq::socket_type::push, MessageEndpointConnectType::CONNECT);
 }
 
 void AsyncSendMessageEndpoint::sendHeader(int header)
 {
     uint8_t headerBytes = static_cast<uint8_t>(header);
-    doSend(pushSocket, &headerBytes, sizeof(headerBytes), true);
+    doSend(socket, &headerBytes, sizeof(headerBytes), true);
 }
 
 void AsyncSendMessageEndpoint::send(const uint8_t* data,
                                     size_t dataSize,
                                     bool more)
 {
     SPDLOG_TRACE("PUSH {} ({} bytes, more {})", address, dataSize, more);
-    doSend(pushSocket, data, dataSize, more);
+    doSend(socket, data, dataSize, more);
+}
+
+AsyncInternalSendMessageEndpoint::AsyncInternalSendMessageEndpoint(
+  const std::string& inprocLabel,
+  int timeoutMs)
+  : MessageEndpoint("inproc://" + inprocLabel, timeoutMs)
+{
+    socket =
+      setUpSocket(zmq::socket_type::push, MessageEndpointConnectType::CONNECT);
+}
+
+void AsyncInternalSendMessageEndpoint::send(const uint8_t* data,
+                                            size_t dataSize,
+                                            bool more)
+{
+    SPDLOG_TRACE("PUSH {} ({} bytes, more {})", address, dataSize, more);
+    doSend(socket, data, dataSize, more);
 }
 
 // ----------------------------------------------
@@ -495,6 +512,21 @@ std::optional<Message> AsyncRecvMessageEndpoint::recv(int size)
     return RecvMessageEndpoint::recv(size);
 }
 
+AsyncInternalRecvMessageEndpoint::AsyncInternalRecvMessageEndpoint(
+  const std::string& inprocLabel,
+  int timeoutMs)
+  : RecvMessageEndpoint(inprocLabel,
+                        timeoutMs,
+                        zmq::socket_type::pull,
+                        MessageEndpointConnectType::BIND)
+{}
+
+std::optional<Message> AsyncInternalRecvMessageEndpoint::recv(int size)
+{
+    SPDLOG_TRACE("PULL {} ({} bytes)", address, size);
+    return RecvMessageEndpoint::recv(size);
+}
+
 // ----------------------------------------------
 // SYNC RECV ENDPOINT
 // ----------------------------------------------

src/transport/MessageEndpointServer.cpp

@@ -157,6 +157,9 @@ void MessageEndpointServerHandler::start(
                     }
                 }
 
+                // Perform the tidy-up
+                server->onWorkerStop();
+
                 // Just before the thread dies, check if there's something
                 // waiting on the shutdown latch
                 if (server->shutdownLatch != nullptr) {
@@ -295,6 +298,11 @@ void MessageEndpointServer::stop()
     started = false;
 }
 
+void MessageEndpointServer::onWorkerStop()
+{
+    // Nothing to do by default
+}
+
 void MessageEndpointServer::setRequestLatch()
 {
     requestLatch = faabric::util::Latch::create(2);