From 2ed809cb4765306b7af9b6968e2ec609d143979b Mon Sep 17 00:00:00 2001 From: Finn Williams Date: Mon, 20 Apr 2020 21:21:07 +0100 Subject: IVGCVSW-4594 Refactor the GatordMockService and GatordMockMain to extract a BasePipeServer Signed-off-by: Finn Williams Change-Id: I03c1b46104dadc491dba6075865e486f78aa60fa --- .../server/src/basePipeServer/BasePipeServer.cpp | 293 +++++++++++++++++++++ .../server/src/basePipeServer/BasePipeServer.hpp | 117 ++++++++ profiling/server/src/basePipeServer/CMakeLists.txt | 25 ++ .../src/basePipeServer/ConnectionHandler.cpp | 55 ++++ .../src/basePipeServer/ConnectionHandler.hpp | 45 ++++ .../basePipeServer/tests/BasePipeServerTests.cpp | 99 +++++++ 6 files changed, 634 insertions(+) create mode 100644 profiling/server/src/basePipeServer/BasePipeServer.cpp create mode 100644 profiling/server/src/basePipeServer/BasePipeServer.hpp create mode 100644 profiling/server/src/basePipeServer/CMakeLists.txt create mode 100644 profiling/server/src/basePipeServer/ConnectionHandler.cpp create mode 100644 profiling/server/src/basePipeServer/ConnectionHandler.hpp create mode 100644 profiling/server/src/basePipeServer/tests/BasePipeServerTests.cpp (limited to 'profiling/server/src') diff --git a/profiling/server/src/basePipeServer/BasePipeServer.cpp b/profiling/server/src/basePipeServer/BasePipeServer.cpp new file mode 100644 index 0000000000..fde5684160 --- /dev/null +++ b/profiling/server/src/basePipeServer/BasePipeServer.cpp @@ -0,0 +1,293 @@ +// +// Copyright © 2020 Arm Ltd. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#include +#include +#include +#include +#include "BasePipeServer.hpp" + +using namespace armnnUtils; + +namespace armnnProfiling +{ + +bool BasePipeServer::ReadFromSocket(uint8_t* packetData, uint32_t expectedLength) +{ + // This is a blocking read until either expectedLength has been received or an error is detected. + long totalBytesRead = 0; + while (boost::numeric_cast(totalBytesRead) < expectedLength) + { + long bytesRead = Sockets::Read(m_ClientConnection, packetData, expectedLength); + if (bytesRead < 0) + { + std::cerr << ": Failure when reading from client socket: " << strerror(errno) << std::endl; + return false; + } + if (bytesRead == 0) + { + std::cerr << ": EOF while reading from client socket." << std::endl; + return false; + } + totalBytesRead += bytesRead; + } + return true; +}; + +bool BasePipeServer::WaitForStreamMetaData() +{ + if (m_EchoPackets) + { + std::cout << "Waiting for stream meta data..." << std::endl; + } + // The start of the stream metadata is 2x32bit words, 0 and packet length. + uint8_t header[8]; + if (!ReadFromSocket(header, 8)) + { + return false; + } + EchoPacket(PacketDirection::ReceivedHeader, header, 8); + // The first word, stream_metadata_identifer, should always be 0. + if (ToUint32(&header[0], TargetEndianness::BeWire) != 0) + { + std::cerr << ": Protocol error. The stream_metadata_identifer was not 0." << std::endl; + return false; + } + + uint8_t pipeMagic[4]; + if (!ReadFromSocket(pipeMagic, 4)) + { + return false; + } + EchoPacket(PacketDirection::ReceivedData, pipeMagic, 4); + + // Before we interpret the length we need to read the pipe_magic word to determine endianness. + if (ToUint32(&pipeMagic[0], TargetEndianness::BeWire) == PIPE_MAGIC) + { + m_Endianness = TargetEndianness::BeWire; + } + else if (ToUint32(&pipeMagic[0], TargetEndianness::LeWire) == PIPE_MAGIC) + { + m_Endianness = TargetEndianness::LeWire; + } + else + { + std::cerr << ": Protocol read error. Unable to read PIPE_MAGIC value." << std::endl; + return false; + } + // Now we know the endianness we can get the length from the header. + // Remember we already read the pipe magic 4 bytes. + uint32_t metaDataLength = ToUint32(&header[4], m_Endianness) - 4; + // Read the entire packet. + std::vector packetData(metaDataLength); + if (metaDataLength != + boost::numeric_cast(Sockets::Read(m_ClientConnection, packetData.data(), metaDataLength))) + { + std::cerr << ": Protocol read error. Data length mismatch." << std::endl; + return false; + } + EchoPacket(PacketDirection::ReceivedData, packetData.data(), metaDataLength); + m_StreamMetaDataVersion = ToUint32(&packetData[0], m_Endianness); + m_StreamMetaDataMaxDataLen = ToUint32(&packetData[4], m_Endianness); + m_StreamMetaDataPid = ToUint32(&packetData[8], m_Endianness); + + return true; +} + +armnn::profiling::Packet BasePipeServer::WaitForPacket(uint32_t timeoutMs) +{ + // Is there currently more than a headers worth of data waiting to be read? + int bytes_available; + Sockets::Ioctl(m_ClientConnection, FIONREAD, &bytes_available); + if (bytes_available > 8) + { + // Yes there is. Read it: + return ReceivePacket(); + } + else + { + // No there's not. Poll for more data. + struct pollfd pollingFd[1]{}; + pollingFd[0].fd = m_ClientConnection; + int pollResult = Sockets::Poll(pollingFd, 1, static_cast(timeoutMs)); + + switch (pollResult) + { + // Error + case -1: + throw armnn::RuntimeException(std::string("File descriptor reported an error during polling: ") + + strerror(errno)); + + // Timeout + case 0: + throw armnn::TimeoutException("Timeout while waiting to receive packet."); + + // Normal poll return. It could still contain an error signal + default: + // Check if the socket reported an error + if (pollingFd[0].revents & (POLLNVAL | POLLERR | POLLHUP)) + { + if (pollingFd[0].revents == POLLNVAL) + { + throw armnn::RuntimeException(std::string("Error while polling receiving socket: POLLNVAL")); + } + if (pollingFd[0].revents == POLLERR) + { + throw armnn::RuntimeException(std::string("Error while polling receiving socket: POLLERR: ") + + strerror(errno)); + } + if (pollingFd[0].revents == POLLHUP) + { + throw armnn::RuntimeException(std::string("Connection closed by remote client: POLLHUP")); + } + } + + // Check if there is data to read + if (!(pollingFd[0].revents & (POLLIN))) + { + // This is a corner case. The socket as been woken up but not with any data. + // We'll throw a timeout exception to loop around again. + throw armnn::TimeoutException("File descriptor was polled but no data was available to receive."); + } + return ReceivePacket(); + } + } +} + +armnn::profiling::Packet BasePipeServer::ReceivePacket() +{ + uint32_t header[2]; + if (!ReadHeader(header)) + { + return armnn::profiling::Packet(); + } + // Read data_length bytes from the socket. + std::unique_ptr uniquePacketData = std::make_unique(header[1]); + unsigned char* packetData = reinterpret_cast(uniquePacketData.get()); + + if (!ReadFromSocket(packetData, header[1])) + { + return armnn::profiling::Packet(); + } + + EchoPacket(PacketDirection::ReceivedData, packetData, header[1]); + + // Construct received packet + armnn::profiling::Packet packetRx = armnn::profiling::Packet(header[0], header[1], uniquePacketData); + if (m_EchoPackets) + { + std::cout << "Processing packet ID= " << packetRx.GetPacketId() << " Length=" << packetRx.GetLength() + << std::endl; + } + + return packetRx; +} + +bool BasePipeServer::SendPacket(uint32_t packetFamily, uint32_t packetId, const uint8_t* data, uint32_t dataLength) +{ + // Construct a packet from the id and data given and send it to the client. + // Encode the header. + uint32_t header[2]; + header[0] = packetFamily << 26 | packetId << 16; + header[1] = dataLength; + // Add the header to the packet. + std::vector packet(8 + dataLength); + InsertU32(header[0], packet.data(), m_Endianness); + InsertU32(header[1], packet.data() + 4, m_Endianness); + // And the rest of the data if there is any. + if (dataLength > 0) + { + memcpy((packet.data() + 8), data, dataLength); + } + EchoPacket(PacketDirection::Sending, packet.data(), packet.size()); + if (-1 == armnnUtils::Sockets::Write(m_ClientConnection, packet.data(), packet.size())) + { + std::cerr << ": Failure when writing to client socket: " << strerror(errno) << std::endl; + return false; + } + return true; +} + +bool BasePipeServer::ReadHeader(uint32_t headerAsWords[2]) +{ + // The header will always be 2x32bit words. + uint8_t header[8]; + if (!ReadFromSocket(header, 8)) + { + return false; + } + EchoPacket(PacketDirection::ReceivedHeader, header, 8); + headerAsWords[0] = ToUint32(&header[0], m_Endianness); + headerAsWords[1] = ToUint32(&header[4], m_Endianness); + return true; +} + +void BasePipeServer::EchoPacket(PacketDirection direction, uint8_t* packet, size_t lengthInBytes) +{ + // If enabled print the contents of the data packet to the console. + if (m_EchoPackets) + { + if (direction == PacketDirection::Sending) + { + std::cout << "TX " << std::dec << lengthInBytes << " bytes : "; + } + else if (direction == PacketDirection::ReceivedHeader) + { + std::cout << "RX Header " << std::dec << lengthInBytes << " bytes : "; + } + else + { + std::cout << "RX Data " << std::dec << lengthInBytes << " bytes : "; + } + for (unsigned int i = 0; i < lengthInBytes; i++) + { + if ((i % 10) == 0) + { + std::cout << std::endl; + } + std::cout << "0x" << std::setfill('0') << std::setw(2) << std::hex << static_cast(packet[i]) + << " "; + } + std::cout << std::endl; + } +} + +uint32_t BasePipeServer::ToUint32(uint8_t* data, TargetEndianness endianness) +{ + // Extract the first 4 bytes starting at data and push them into a 32bit integer based on the + // specified endianness. + if (endianness == TargetEndianness::BeWire) + { + return static_cast(data[0]) << 24 | static_cast(data[1]) << 16 | + static_cast(data[2]) << 8 | static_cast(data[3]); + } + else + { + return static_cast(data[3]) << 24 | static_cast(data[2]) << 16 | + static_cast(data[1]) << 8 | static_cast(data[0]); + } +} + +void BasePipeServer::InsertU32(uint32_t value, uint8_t* data, TargetEndianness endianness) +{ + // Take the bytes of a 32bit integer and copy them into char array starting at data considering + // the endianness value. + if (endianness == TargetEndianness::BeWire) + { + *data = static_cast((value >> 24) & 0xFF); + *(data + 1) = static_cast((value >> 16) & 0xFF); + *(data + 2) = static_cast((value >> 8) & 0xFF); + *(data + 3) = static_cast(value & 0xFF); + } + else + { + *(data + 3) = static_cast((value >> 24) & 0xFF); + *(data + 2) = static_cast((value >> 16) & 0xFF); + *(data + 1) = static_cast((value >> 8) & 0xFF); + *data = static_cast(value & 0xFF); + } +} + +} // namespace armnnProfiling \ No newline at end of file diff --git a/profiling/server/src/basePipeServer/BasePipeServer.hpp b/profiling/server/src/basePipeServer/BasePipeServer.hpp new file mode 100644 index 0000000000..a150d76278 --- /dev/null +++ b/profiling/server/src/basePipeServer/BasePipeServer.hpp @@ -0,0 +1,117 @@ +// +// Copyright © 2020 Arm Ltd. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#pragma once + +//#include +#include +#include +#include "../../../../src/armnnUtils/NetworkSockets.hpp" +#include "../../../../src/profiling/Packet.hpp" +#include "common/include/SocketConnectionException.hpp" + +namespace armnnProfiling +{ + +enum class TargetEndianness +{ + BeWire, + LeWire +}; + +enum class PacketDirection +{ + Sending, + ReceivedHeader, + ReceivedData +}; +class ConnectionHandler; + +class BasePipeServer +{ + +public: + + BasePipeServer(armnnUtils::Sockets::Socket clientConnection, bool echoPackets) + : m_ClientConnection(clientConnection) + , m_EchoPackets(echoPackets) + {} + + ~BasePipeServer() + { + // We have set SOCK_CLOEXEC on this socket but we'll close it to be good citizens. + armnnUtils::Sockets::Close(m_ClientConnection); + } + + BasePipeServer(const BasePipeServer&) = delete; + BasePipeServer& operator=(const BasePipeServer&) = delete; + + BasePipeServer(BasePipeServer&&) = delete; + BasePipeServer& operator=(BasePipeServer&&) = delete; + + /// Close the client connection + /// @return 0 if successful + int Close() + { + return armnnUtils::Sockets::Close(m_ClientConnection); + } + + /// Send a packet to the client + /// @return true if a valid packet has been sent. + bool SendPacket(uint32_t packetFamily, uint32_t packetId, const uint8_t* data, uint32_t dataLength); + + /// Set the client socket to nonblocking + /// @return true if successful. + bool SetNonBlocking() + { + return armnnUtils::Sockets::SetNonBlocking(m_ClientConnection); + } + + /// Block on the client connection until a complete packet has been received. + /// @return true if a valid packet has been received. + armnn::profiling::Packet WaitForPacket(uint32_t timeoutMs); + + /// Once the connection is open wait to receive the stream meta data packet from the client. Reading this + /// packet differs from others as we need to determine endianness. + /// @return true only if a valid stream meta data packet has been received. + bool WaitForStreamMetaData(); + + uint32_t GetStreamMetadataVersion() + { + return m_StreamMetaDataVersion; + } + + uint32_t GetStreamMetadataMaxDataLen() + { + return m_StreamMetaDataMaxDataLen; + } + + uint32_t GetStreamMetadataPid() + { + return m_StreamMetaDataPid; + } + +private: + + void EchoPacket(PacketDirection direction, uint8_t* packet, size_t lengthInBytes); + bool ReadFromSocket(uint8_t* packetData, uint32_t expectedLength); + bool ReadHeader(uint32_t headerAsWords[2]); + + armnn::profiling::Packet ReceivePacket(); + + uint32_t ToUint32(uint8_t* data, TargetEndianness endianness); + void InsertU32(uint32_t value, uint8_t* data, TargetEndianness endianness); + + armnnUtils::Sockets::Socket m_ClientConnection; + bool m_EchoPackets; + TargetEndianness m_Endianness; + static const uint32_t PIPE_MAGIC = 0x45495434; + + uint32_t m_StreamMetaDataVersion; + uint32_t m_StreamMetaDataMaxDataLen; + uint32_t m_StreamMetaDataPid; +}; + +} // namespace armnnProfiling \ No newline at end of file diff --git a/profiling/server/src/basePipeServer/CMakeLists.txt b/profiling/server/src/basePipeServer/CMakeLists.txt new file mode 100644 index 0000000000..e535cf2e66 --- /dev/null +++ b/profiling/server/src/basePipeServer/CMakeLists.txt @@ -0,0 +1,25 @@ +# +# Copyright © 2020 Arm Ltd. All rights reserved. +# SPDX-License-Identifier: MIT +# + +if(BUILD_BASE_PIPE_SERVER) + set(BasePipeServer_sources) + list(APPEND BasePipeServer_sources + BasePipeServer.cpp + BasePipeServer.hpp + ConnectionHandler.cpp + ConnectionHandler.hpp + ) + + include_directories(src/armnnUtils src/profiling) + + add_library_ex(armnnBasePipeServer SHARED ${BasePipeServer_sources}) + set_target_properties(armnnBasePipeServer PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}) + set_target_properties(armnnBasePipeServer PROPERTIES VERSION ${GENERIC_LIB_VERSION} + SOVERSION ${GENERIC_LIB_SOVERSION}) + + install(TARGETS armnnBasePipeServer + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) +endif() \ No newline at end of file diff --git a/profiling/server/src/basePipeServer/ConnectionHandler.cpp b/profiling/server/src/basePipeServer/ConnectionHandler.cpp new file mode 100644 index 0000000000..69ccd01050 --- /dev/null +++ b/profiling/server/src/basePipeServer/ConnectionHandler.cpp @@ -0,0 +1,55 @@ +// +// Copyright © 2020 Arm Ltd. All rights reserved. +// SPDX-License-Identifier: MIT +// +#include "ConnectionHandler.hpp" + +using namespace armnnUtils; + +namespace armnnProfiling +{ +ConnectionHandler::ConnectionHandler(const std::string& udsNamespace, const bool setNonBlocking) +{ + Sockets::Initialize(); + m_ListeningSocket = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0); + + if (-1 == m_ListeningSocket) + { + throw SocketConnectionException(": Socket construction failed: ", 1, 1); + } + + sockaddr_un udsAddress; + memset(&udsAddress, 0, sizeof(sockaddr_un)); + // We've set the first element of sun_path to be 0, skip over it and copy the namespace after it. + memcpy(udsAddress.sun_path + 1, udsNamespace.c_str(), strlen(udsNamespace.c_str())); + udsAddress.sun_family = AF_UNIX; + + // Bind the socket to the UDS namespace. + if (-1 == bind(m_ListeningSocket, reinterpret_cast(&udsAddress), sizeof(sockaddr_un))) + { + throw SocketConnectionException(": Binding on socket failed: ", m_ListeningSocket, errno); + } + // Listen for connections. + if (-1 == listen(m_ListeningSocket, 1)) + { + throw SocketConnectionException(": Listen call on socket failed: ", m_ListeningSocket, errno); + } + + if (setNonBlocking) + { + Sockets::SetNonBlocking(m_ListeningSocket); + } +} + +std::unique_ptr ConnectionHandler::GetNewBasePipeServer(const bool echoPackets) +{ + armnnUtils::Sockets::Socket clientConnection = armnnUtils::Sockets::Accept(m_ListeningSocket, nullptr, nullptr, + SOCK_CLOEXEC); + if (clientConnection < 1) + { + return nullptr; + } + return std::make_unique(clientConnection, echoPackets); +} + +} // namespace armnnProfiling \ No newline at end of file diff --git a/profiling/server/src/basePipeServer/ConnectionHandler.hpp b/profiling/server/src/basePipeServer/ConnectionHandler.hpp new file mode 100644 index 0000000000..e7317dc355 --- /dev/null +++ b/profiling/server/src/basePipeServer/ConnectionHandler.hpp @@ -0,0 +1,45 @@ +// +// Copyright © 2020 Arm Ltd. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#pragma once + +#include "../../../../src/armnnUtils/NetworkSockets.hpp" +#include "BasePipeServer.hpp" +#include + +namespace armnnProfiling +{ + +class ConnectionHandler +{ +public: + /// Constructor establishes the Unix domain socket and sets it to listen for connections. + /// @param udsNamespace the namespace (socket address) associated with the listener. + /// @throws SocketConnectionException if the socket has been incorrectly setup. + ConnectionHandler(const std::string& udsNamespace, const bool setNonBlocking); + + ~ConnectionHandler() + { + // We have set SOCK_CLOEXEC on this socket but we'll close it to be good citizens. + armnnUtils::Sockets::Close(m_ListeningSocket); + } + + ConnectionHandler(const ConnectionHandler&) = delete; + ConnectionHandler& operator=(const ConnectionHandler&) = delete; + + ConnectionHandler(ConnectionHandler&&) = delete; + ConnectionHandler& operator=(ConnectionHandler&&) = delete; + + /// Attempt to open a new socket to the client and use it to construct a new basePipeServer + /// @param echoPackets if true the raw packets will be printed to stdout. + /// @return if successful a unique_ptr to a basePipeServer otherwise a nullptr + std::unique_ptr GetNewBasePipeServer(const bool echoPackets); + +private: + + armnnUtils::Sockets::Socket m_ListeningSocket; +}; + +} // namespace armnnProfiling \ No newline at end of file diff --git a/profiling/server/src/basePipeServer/tests/BasePipeServerTests.cpp b/profiling/server/src/basePipeServer/tests/BasePipeServerTests.cpp new file mode 100644 index 0000000000..c85bbe72d3 --- /dev/null +++ b/profiling/server/src/basePipeServer/tests/BasePipeServerTests.cpp @@ -0,0 +1,99 @@ +// +// Copyright © 2020 Arm Ltd. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#include "../ConnectionHandler.hpp" + +#include +#include + +#include +#include + + +BOOST_AUTO_TEST_SUITE(BasePipeServerTests) + +using namespace armnn; +using namespace armnnProfiling; + +BOOST_AUTO_TEST_CASE(BasePipeServerTest) +{ + // Setup the mock service to bind to the UDS. + std::string udsNamespace = "gatord_namespace"; + + // Try to initialize a listening socket through the ConnectionHandler + BOOST_CHECK_NO_THROW(ConnectionHandler connectionHandler(udsNamespace, true)); + + // The socket should close once we leave the scope of BOOST_CHECK_NO_THROW + // and socketProfilingConnection should fail to connect + BOOST_CHECK_THROW(profiling::SocketProfilingConnection socketProfilingConnection, + armnnProfiling::SocketConnectionException); + + // Try to initialize a listening socket through the ConnectionHandler again + ConnectionHandler connectionHandler(udsNamespace, true); + // socketProfilingConnection should connect now + profiling::SocketProfilingConnection socketProfilingConnection; + BOOST_TEST(socketProfilingConnection.IsOpen()); + + auto basePipeServer = connectionHandler.GetNewBasePipeServer(false); + // GetNewBasePipeServer will return null if it fails to create a socket + BOOST_TEST(basePipeServer.get()); + + profiling::BufferManager bufferManager; + profiling::SendCounterPacket sendCounterPacket(bufferManager); + + // Check that we can receive a StreamMetaDataPacket + sendCounterPacket.SendStreamMetaDataPacket(); + + auto packetBuffer = bufferManager.GetReadableBuffer(); + const unsigned char* readBuffer = packetBuffer->GetReadableData(); + unsigned int readBufferSize = packetBuffer->GetSize(); + + BOOST_TEST(readBuffer); + BOOST_TEST(readBufferSize > 0); + + socketProfilingConnection.WritePacket(readBuffer,readBufferSize); + bufferManager.MarkRead(packetBuffer); + + BOOST_TEST(basePipeServer.get()->WaitForStreamMetaData()); + BOOST_TEST(basePipeServer.get()->GetStreamMetadataPid() == armnnUtils::Processes::GetCurrentId()); + BOOST_TEST(basePipeServer.get()->GetStreamMetadataMaxDataLen() == MAX_METADATA_PACKET_LENGTH); + + // Now try a simple PeriodicCounterSelectionPacket + sendCounterPacket.SendPeriodicCounterSelectionPacket(50, {1,2,3,4,5}); + + packetBuffer = bufferManager.GetReadableBuffer(); + readBuffer = packetBuffer->GetReadableData(); + readBufferSize = packetBuffer->GetSize(); + + BOOST_TEST(readBuffer); + BOOST_TEST(readBufferSize > 0); + + socketProfilingConnection.WritePacket(readBuffer,readBufferSize); + bufferManager.MarkRead(packetBuffer); + + auto packet1 = basePipeServer.get()->WaitForPacket(500); + + BOOST_TEST(!packet1.IsEmpty()); + BOOST_TEST(packet1.GetPacketFamily() == 0); + BOOST_TEST(packet1.GetPacketId() == 4); + BOOST_TEST(packet1.GetLength() == 14); + + // Try and send the packet back to the client + basePipeServer.get()->SendPacket(packet1.GetPacketFamily(), + packet1.GetPacketId(), + packet1.GetData(), + packet1.GetLength()); + + auto packet2 = socketProfilingConnection.ReadPacket(500); + + BOOST_TEST(!packet2.IsEmpty()); + BOOST_TEST(packet2.GetPacketFamily() == 0); + BOOST_TEST(packet2.GetPacketId() == 4); + BOOST_TEST(packet2.GetLength() == 14); + + socketProfilingConnection.Close(); +} + +BOOST_AUTO_TEST_SUITE_END() \ No newline at end of file -- cgit v1.2.1