From bbfe603e5ae42317a2b67d713d00882bea341c88 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Mon, 20 Jul 2020 16:57:44 +0100 Subject: IVGCVSW-5166 Pull out the common and server side code into standalone libraries Change-Id: I180f84c493a9b2be4b93b25d312ebdd9e71b1735 Signed-off-by: Jim Flynn --- .../include/basePipeServer/BasePipeServer.hpp | 120 +++++++++++++++++++++ .../include/basePipeServer/ConnectionHandler.hpp | 48 +++++++++ 2 files changed, 168 insertions(+) create mode 100644 profiling/server/include/basePipeServer/BasePipeServer.hpp create mode 100644 profiling/server/include/basePipeServer/ConnectionHandler.hpp (limited to 'profiling/server/include/basePipeServer') diff --git a/profiling/server/include/basePipeServer/BasePipeServer.hpp b/profiling/server/include/basePipeServer/BasePipeServer.hpp new file mode 100644 index 0000000000..1b6dec54ff --- /dev/null +++ b/profiling/server/include/basePipeServer/BasePipeServer.hpp @@ -0,0 +1,120 @@ +// +// Copyright © 2020 Arm Ltd and Contributors. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#pragma once + +#include +#include +#include + +#include +#include + +namespace arm +{ + +namespace pipe +{ + +enum class TargetEndianness +{ + BeWire, + LeWire +}; + +enum class PacketDirection +{ + Sending, + ReceivedHeader, + ReceivedData +}; +class ConnectionHandler; + +class BasePipeServer +{ + +public: + + BasePipeServer(arm::pipe::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. + arm::pipe::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 arm::pipe::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 arm::pipe::SetNonBlocking(m_ClientConnection); + } + + /// Block on the client connection until a complete packet has been received. + /// @return true if a valid packet has been received. + arm::pipe::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]); + + arm::pipe::Packet ReceivePacket(); + + uint32_t ToUint32(uint8_t* data, TargetEndianness endianness); + void InsertU32(uint32_t value, uint8_t* data, TargetEndianness endianness); + + arm::pipe::Socket m_ClientConnection; + bool m_EchoPackets; + TargetEndianness m_Endianness; + + uint32_t m_StreamMetaDataVersion; + uint32_t m_StreamMetaDataMaxDataLen; + uint32_t m_StreamMetaDataPid; +}; + +} // namespace pipe +} // namespace arm diff --git a/profiling/server/include/basePipeServer/ConnectionHandler.hpp b/profiling/server/include/basePipeServer/ConnectionHandler.hpp new file mode 100644 index 0000000000..4859fced0d --- /dev/null +++ b/profiling/server/include/basePipeServer/ConnectionHandler.hpp @@ -0,0 +1,48 @@ +// +// Copyright © 2020 Arm Ltd and Contributors. All rights reserved. +// SPDX-License-Identifier: MIT +// + +#pragma once + +#include "BasePipeServer.hpp" +#include + +namespace arm +{ + +namespace pipe +{ + +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. + arm::pipe::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: + + arm::pipe::Socket m_ListeningSocket; +}; + +} // namespace pipe +} // namespace arm -- cgit v1.2.1