aboutsummaryrefslogtreecommitdiff
path: root/src/profiling/SocketProfilingConnection.cpp
blob: c231045b1088ab9aff019b7afdec4c4ad62b74b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
//
// Copyright © 2019 Arm Ltd and Contributors. All rights reserved.
// SPDX-License-Identifier: MIT
//

#include "SocketProfilingConnection.hpp"

#include "common/include/SocketConnectionException.hpp"

#include <cerrno>
#include <fcntl.h>
#include <string>

using namespace armnnUtils;

namespace armnn
{
namespace profiling
{

SocketProfilingConnection::SocketProfilingConnection()
{
    Sockets::Initialize();
    memset(m_Socket, 0, sizeof(m_Socket));
    // Note: we're using Linux specific SOCK_CLOEXEC flag.
    m_Socket[0].fd = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0);
    if (m_Socket[0].fd == -1)
    {
        throw armnnProfiling::SocketConnectionException(
            std::string("SocketProfilingConnection: Socket construction failed: ")  + strerror(errno),
            m_Socket[0].fd,
            errno);
    }

    // Connect to the named unix domain socket.
    sockaddr_un server{};
    memset(&server, 0, sizeof(sockaddr_un));
    // As m_GatorNamespace begins with a null character we need to ignore that when getting its length.
    memcpy(server.sun_path, m_GatorNamespace, strlen(m_GatorNamespace + 1) + 1);
    server.sun_family = AF_UNIX;
    if (0 != connect(m_Socket[0].fd, reinterpret_cast<const sockaddr*>(&server), sizeof(sockaddr_un)))
    {
        Close();
        throw armnnProfiling::SocketConnectionException(
            std::string("SocketProfilingConnection: Cannot connect to stream socket: ")  + strerror(errno),
            m_Socket[0].fd,
            errno);
    }

    // Our socket will only be interested in polling reads.
    m_Socket[0].events = POLLIN;

    // Make the socket non blocking.
    if (!Sockets::SetNonBlocking(m_Socket[0].fd))
    {
        Close();
        throw armnnProfiling::SocketConnectionException(
            std::string("SocketProfilingConnection: Failed to set socket as non blocking: ")  + strerror(errno),
            m_Socket[0].fd,
            errno);
    }
}

bool SocketProfilingConnection::IsOpen() const
{
    return m_Socket[0].fd > 0;
}

void SocketProfilingConnection::Close()
{
    if (Sockets::Close(m_Socket[0].fd) != 0)
    {
        throw armnnProfiling::SocketConnectionException(
            std::string("SocketProfilingConnection: Cannot close stream socket: ")  + strerror(errno),
            m_Socket[0].fd,
            errno);
    }

    memset(m_Socket, 0, sizeof(m_Socket));
}

bool SocketProfilingConnection::WritePacket(const unsigned char* buffer, uint32_t length)
{
    if (buffer == nullptr || length == 0)
    {
        return false;
    }

    return Sockets::Write(m_Socket[0].fd, buffer, length) != -1;
}

Packet SocketProfilingConnection::ReadPacket(uint32_t timeout)
{
    // Is there currently at least a header worth of data waiting to be read?
    int bytes_available = 0;
    Sockets::Ioctl(m_Socket[0].fd, FIONREAD, &bytes_available);
    if (bytes_available >= 8)
    {
        // Yes there is. Read it:
        return ReceivePacket();
    }

    // Poll for data on the socket or until timeout occurs
    int pollResult = Sockets::Poll(&m_Socket[0], 1, static_cast<int>(timeout));

    switch (pollResult)
    {
    case -1: // Error
        throw armnnProfiling::SocketConnectionException(
            std::string("SocketProfilingConnection: Error occured while reading from socket: ") + strerror(errno),
            m_Socket[0].fd,
            errno);

    case 0: // Timeout
        throw TimeoutException("SocketProfilingConnection: Timeout while reading from socket");

    default: // Normal poll return but it could still contain an error signal
        // Check if the socket reported an error
        if (m_Socket[0].revents & (POLLNVAL | POLLERR | POLLHUP))
        {
            if (m_Socket[0].revents == POLLNVAL)
            {
                // This is an unrecoverable error.
                Close();
                throw armnnProfiling::SocketConnectionException(
                    std::string("SocketProfilingConnection: Error occured while polling receiving socket: POLLNVAL."),
                    m_Socket[0].fd);
            }
            if (m_Socket[0].revents == POLLERR)
            {
                throw armnnProfiling::SocketConnectionException(
                    std::string(
                        "SocketProfilingConnection: Error occured while polling receiving socket: POLLERR: ")
                        + strerror(errno),
                    m_Socket[0].fd,
                    errno);
            }
            if (m_Socket[0].revents == POLLHUP)
            {
                // This is an unrecoverable error.
                Close();
                throw armnnProfiling::SocketConnectionException(
                    std::string("SocketProfilingConnection: Connection closed by remote client: POLLHUP."),
                    m_Socket[0].fd);
            }
        }

        // Check if there is data to read
        if (!(m_Socket[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(
                "SocketProfilingConnection: File descriptor was polled but no data was available to receive.");
        }

        return ReceivePacket();
    }
}

Packet SocketProfilingConnection::ReceivePacket()
{
    char header[8] = {};
    long receiveResult = Sockets::Read(m_Socket[0].fd, &header, sizeof(header));
    // We expect 8 as the result here. 0 means EOF, socket is closed. -1 means there been some other kind of error.
    switch( receiveResult )
    {
        case 0:
            // Socket has closed.
            Close();
            throw armnnProfiling::SocketConnectionException(
                std::string("SocketProfilingConnection: Remote socket has closed the connection."),
                m_Socket[0].fd);
        case -1:
            // There's been a socket error. We will presume it's unrecoverable.
            Close();
            throw armnnProfiling::SocketConnectionException(
                std::string("SocketProfilingConnection: Error occured while reading the packet: ") + strerror(errno),
                m_Socket[0].fd,
                errno);
        default:
            if (receiveResult < 8)
            {
                 throw armnnProfiling::SocketConnectionException(
                     std::string(
                         "SocketProfilingConnection: The received packet did not contains a valid PIPE header."),
                     m_Socket[0].fd);
            }
            break;
    }

    // stream_metadata_identifier is the first 4 bytes
    uint32_t metadataIdentifier = 0;
    std::memcpy(&metadataIdentifier, header, sizeof(metadataIdentifier));

    // data_length is the next 4 bytes
    uint32_t dataLength = 0;
    std::memcpy(&dataLength, header + 4u, sizeof(dataLength));

    std::unique_ptr<unsigned char[]> packetData;
    if (dataLength > 0)
    {
        packetData = std::make_unique<unsigned char[]>(dataLength);
        long receivedLength = Sockets::Read(m_Socket[0].fd, packetData.get(), dataLength);
        if (receivedLength < 0)
        {
            throw armnnProfiling::SocketConnectionException(
                std::string("SocketProfilingConnection: Error occured while reading the packet: ")  + strerror(errno),
                m_Socket[0].fd,
                errno);
        }
        if (dataLength != static_cast<uint32_t>(receivedLength))
        {
            // What do we do here if we can't read in a full packet?
            throw armnnProfiling::SocketConnectionException(
                std::string("SocketProfilingConnection: Invalid PIPE packet."),
                m_Socket[0].fd);
        }
    }

    return Packet(metadataIdentifier, dataLength, packetData);
}

} // namespace profiling
} // namespace armnn