Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 1 | // |
Jim Flynn | 6da6a45 | 2020-07-14 14:26:27 +0100 | [diff] [blame] | 2 | // Copyright © 2019 Arm Ltd and Contributors. All rights reserved. |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #include "SocketProfilingConnection.hpp" |
| 7 | |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 8 | #include "common/include/SocketConnectionException.hpp" |
| 9 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 10 | #include <cerrno> |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 11 | #include <fcntl.h> |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 12 | #include <string> |
| 13 | |
Rob Hughes | 25b7436 | 2020-01-13 11:14:59 +0000 | [diff] [blame] | 14 | |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 15 | namespace armnn |
| 16 | { |
| 17 | namespace profiling |
| 18 | { |
| 19 | |
| 20 | SocketProfilingConnection::SocketProfilingConnection() |
| 21 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 22 | arm::pipe::Initialize(); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 23 | memset(m_Socket, 0, sizeof(m_Socket)); |
| 24 | // Note: we're using Linux specific SOCK_CLOEXEC flag. |
| 25 | m_Socket[0].fd = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0); |
| 26 | if (m_Socket[0].fd == -1) |
| 27 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 28 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 29 | std::string("SocketProfilingConnection: Socket construction failed: ") + strerror(errno), |
| 30 | m_Socket[0].fd, |
| 31 | errno); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 32 | } |
| 33 | |
| 34 | // Connect to the named unix domain socket. |
Rob Hughes | 25b7436 | 2020-01-13 11:14:59 +0000 | [diff] [blame] | 35 | sockaddr_un server{}; |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 36 | memset(&server, 0, sizeof(sockaddr_un)); |
| 37 | // As m_GatorNamespace begins with a null character we need to ignore that when getting its length. |
| 38 | memcpy(server.sun_path, m_GatorNamespace, strlen(m_GatorNamespace + 1) + 1); |
| 39 | server.sun_family = AF_UNIX; |
| 40 | if (0 != connect(m_Socket[0].fd, reinterpret_cast<const sockaddr*>(&server), sizeof(sockaddr_un))) |
| 41 | { |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 42 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 43 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 44 | std::string("SocketProfilingConnection: Cannot connect to stream socket: ") + strerror(errno), |
| 45 | m_Socket[0].fd, |
| 46 | errno); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | // Our socket will only be interested in polling reads. |
| 50 | m_Socket[0].events = POLLIN; |
| 51 | |
| 52 | // Make the socket non blocking. |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 53 | if (!arm::pipe::SetNonBlocking(m_Socket[0].fd)) |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 54 | { |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 55 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 56 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 57 | std::string("SocketProfilingConnection: Failed to set socket as non blocking: ") + strerror(errno), |
| 58 | m_Socket[0].fd, |
| 59 | errno); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 60 | } |
| 61 | } |
| 62 | |
Matteo Martincigh | 54fb957 | 2019-10-02 12:50:57 +0100 | [diff] [blame] | 63 | bool SocketProfilingConnection::IsOpen() const |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 64 | { |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 65 | return m_Socket[0].fd > 0; |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 66 | } |
| 67 | |
| 68 | void SocketProfilingConnection::Close() |
| 69 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 70 | if (arm::pipe::Close(m_Socket[0].fd) != 0) |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 71 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 72 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 73 | std::string("SocketProfilingConnection: Cannot close stream socket: ") + strerror(errno), |
| 74 | m_Socket[0].fd, |
| 75 | errno); |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 76 | } |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 77 | |
| 78 | memset(m_Socket, 0, sizeof(m_Socket)); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 79 | } |
| 80 | |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 81 | bool SocketProfilingConnection::WritePacket(const unsigned char* buffer, uint32_t length) |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 82 | { |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 83 | if (buffer == nullptr || length == 0) |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 84 | { |
| 85 | return false; |
| 86 | } |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 87 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 88 | return arm::pipe::Write(m_Socket[0].fd, buffer, length) != -1; |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 89 | } |
| 90 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 91 | arm::pipe::Packet SocketProfilingConnection::ReadPacket(uint32_t timeout) |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 92 | { |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 93 | // Is there currently at least a header worth of data waiting to be read? |
| 94 | int bytes_available = 0; |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 95 | arm::pipe::Ioctl(m_Socket[0].fd, FIONREAD, &bytes_available); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 96 | if (bytes_available >= 8) |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 97 | { |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 98 | // Yes there is. Read it: |
| 99 | return ReceivePacket(); |
| 100 | } |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 101 | |
| 102 | // Poll for data on the socket or until timeout occurs |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 103 | int pollResult = arm::pipe::Poll(&m_Socket[0], 1, static_cast<int>(timeout)); |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 104 | |
| 105 | switch (pollResult) |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 106 | { |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 107 | case -1: // Error |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 108 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 109 | std::string("SocketProfilingConnection: Error occured while reading from socket: ") + strerror(errno), |
| 110 | m_Socket[0].fd, |
| 111 | errno); |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 112 | |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 113 | case 0: // Timeout |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 114 | throw arm::pipe::TimeoutException("SocketProfilingConnection: Timeout while reading from socket"); |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 115 | |
| 116 | default: // Normal poll return but it could still contain an error signal |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 117 | // Check if the socket reported an error |
| 118 | if (m_Socket[0].revents & (POLLNVAL | POLLERR | POLLHUP)) |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 119 | { |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 120 | if (m_Socket[0].revents == POLLNVAL) |
| 121 | { |
| 122 | // This is an unrecoverable error. |
| 123 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 124 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 125 | std::string("SocketProfilingConnection: Error occured while polling receiving socket: POLLNVAL."), |
| 126 | m_Socket[0].fd); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 127 | } |
| 128 | if (m_Socket[0].revents == POLLERR) |
| 129 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 130 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 131 | std::string( |
| 132 | "SocketProfilingConnection: Error occured while polling receiving socket: POLLERR: ") |
| 133 | + strerror(errno), |
| 134 | m_Socket[0].fd, |
| 135 | errno); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 136 | } |
| 137 | if (m_Socket[0].revents == POLLHUP) |
| 138 | { |
| 139 | // This is an unrecoverable error. |
| 140 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 141 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 142 | std::string("SocketProfilingConnection: Connection closed by remote client: POLLHUP."), |
| 143 | m_Socket[0].fd); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 144 | } |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 145 | } |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 146 | |
| 147 | // Check if there is data to read |
| 148 | if (!(m_Socket[0].revents & (POLLIN))) |
| 149 | { |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 150 | // This is a corner case. The socket as been woken up but not with any data. |
| 151 | // We'll throw a timeout exception to loop around again. |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 152 | throw armnn::TimeoutException( |
| 153 | "SocketProfilingConnection: File descriptor was polled but no data was available to receive."); |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | return ReceivePacket(); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 157 | } |
| 158 | } |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 159 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 160 | arm::pipe::Packet SocketProfilingConnection::ReceivePacket() |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 161 | { |
| 162 | char header[8] = {}; |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 163 | long receiveResult = arm::pipe::Read(m_Socket[0].fd, &header, sizeof(header)); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 164 | // We expect 8 as the result here. 0 means EOF, socket is closed. -1 means there been some other kind of error. |
| 165 | switch( receiveResult ) |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 166 | { |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 167 | case 0: |
| 168 | // Socket has closed. |
| 169 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 170 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 171 | std::string("SocketProfilingConnection: Remote socket has closed the connection."), |
| 172 | m_Socket[0].fd); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 173 | case -1: |
| 174 | // There's been a socket error. We will presume it's unrecoverable. |
| 175 | Close(); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 176 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 177 | std::string("SocketProfilingConnection: Error occured while reading the packet: ") + strerror(errno), |
| 178 | m_Socket[0].fd, |
| 179 | errno); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 180 | default: |
| 181 | if (receiveResult < 8) |
| 182 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 183 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 184 | std::string( |
| 185 | "SocketProfilingConnection: The received packet did not contains a valid PIPE header."), |
| 186 | m_Socket[0].fd); |
Colm Donelan | 9ea7700 | 2019-10-17 14:02:44 +0100 | [diff] [blame] | 187 | } |
| 188 | break; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 189 | } |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 190 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 191 | // stream_metadata_identifier is the first 4 bytes |
| 192 | uint32_t metadataIdentifier = 0; |
| 193 | std::memcpy(&metadataIdentifier, header, sizeof(metadataIdentifier)); |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 194 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 195 | // data_length is the next 4 bytes |
| 196 | uint32_t dataLength = 0; |
| 197 | std::memcpy(&dataLength, header + 4u, sizeof(dataLength)); |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 198 | |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 199 | std::unique_ptr<unsigned char[]> packetData; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 200 | if (dataLength > 0) |
| 201 | { |
Matteo Martincigh | 8d9590e | 2019-10-15 09:35:29 +0100 | [diff] [blame] | 202 | packetData = std::make_unique<unsigned char[]>(dataLength); |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 203 | long receivedLength = arm::pipe::Read(m_Socket[0].fd, packetData.get(), dataLength); |
Jim Flynn | e11ff89 | 2019-10-04 04:25:43 -0700 | [diff] [blame] | 204 | if (receivedLength < 0) |
| 205 | { |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 206 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 207 | std::string("SocketProfilingConnection: Error occured while reading the packet: ") + strerror(errno), |
| 208 | m_Socket[0].fd, |
| 209 | errno); |
Jim Flynn | e11ff89 | 2019-10-04 04:25:43 -0700 | [diff] [blame] | 210 | } |
| 211 | if (dataLength != static_cast<uint32_t>(receivedLength)) |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 212 | { |
| 213 | // What do we do here if we can't read in a full packet? |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 214 | throw arm::pipe::SocketConnectionException( |
Sadik Armagan | a97a0be | 2020-03-03 10:44:56 +0000 | [diff] [blame] | 215 | std::string("SocketProfilingConnection: Invalid PIPE packet."), |
| 216 | m_Socket[0].fd); |
Matteo Martincigh | 24e8f92 | 2019-09-19 11:57:46 +0100 | [diff] [blame] | 217 | } |
FinnWilliamsArm | a0c7871 | 2019-09-16 12:06:47 +0100 | [diff] [blame] | 218 | } |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 219 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 220 | return arm::pipe::Packet(metadataIdentifier, dataLength, packetData); |
Teresa Charlin | 9bab496 | 2019-09-06 12:28:35 +0100 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | } // namespace profiling |
| 224 | } // namespace armnn |