From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- ...profiling_1_1_socket_profiling_connection.xhtml | 309 +++++++++++++++++++++ 1 file changed, 309 insertions(+) create mode 100644 21.02/classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml (limited to '21.02/classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml') diff --git a/21.02/classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml b/21.02/classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml new file mode 100644 index 0000000000..f48f853c1a --- /dev/null +++ b/21.02/classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml @@ -0,0 +1,309 @@ + + + + + + + + + + + + + +ArmNN: SocketProfilingConnection Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
SocketProfilingConnection Class Reference
+
+
+ +

#include <SocketProfilingConnection.hpp>

+
+Inheritance diagram for SocketProfilingConnection:
+
+
+ + +IProfilingConnection + +
+ + + + + + + + + + + + + + + +

+Public Member Functions

 SocketProfilingConnection ()
 
bool IsOpen () const final
 
void Close () final
 
bool WritePacket (const unsigned char *buffer, uint32_t length) final
 
arm::pipe::Packet ReadPacket (uint32_t timeout) final
 
- Public Member Functions inherited from IProfilingConnection
virtual ~IProfilingConnection ()
 
+

Detailed Description

+
+

Definition at line 18 of file SocketProfilingConnection.hpp.

+

Constructor & Destructor Documentation

+ +

◆ SocketProfilingConnection()

+ +
+
+ + + + + + + +
SocketProfilingConnection ()
+
+ +

Definition at line 20 of file SocketProfilingConnection.cpp.

+ +

References SocketProfilingConnection::Close().

+
21 {
22  arm::pipe::Initialize();
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  {
28  throw arm::pipe::SocketConnectionException(
29  std::string("SocketProfilingConnection: Socket construction failed: ") + strerror(errno),
30  m_Socket[0].fd,
31  errno);
32  }
33 
34  // Connect to the named unix domain socket.
35  sockaddr_un server{};
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  {
42  Close();
43  throw arm::pipe::SocketConnectionException(
44  std::string("SocketProfilingConnection: Cannot connect to stream socket: ") + strerror(errno),
45  m_Socket[0].fd,
46  errno);
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.
53  if (!arm::pipe::SetNonBlocking(m_Socket[0].fd))
54  {
55  Close();
56  throw arm::pipe::SocketConnectionException(
57  std::string("SocketProfilingConnection: Failed to set socket as non blocking: ") + strerror(errno),
58  m_Socket[0].fd,
59  errno);
60  }
61 }
+
+
+
+

Member Function Documentation

+ +

◆ Close()

+ +
+
+ + + + + +
+ + + + + + + +
void Close ()
+ 		+finalvirtual
+
+ +

Implements IProfilingConnection.

+ +

Definition at line 68 of file SocketProfilingConnection.cpp.

+ +

Referenced by SocketProfilingConnection::ReadPacket(), and SocketProfilingConnection::SocketProfilingConnection().

+
69 {
70  if (arm::pipe::Close(m_Socket[0].fd) != 0)
71  {
72  throw arm::pipe::SocketConnectionException(
73  std::string("SocketProfilingConnection: Cannot close stream socket: ") + strerror(errno),
74  m_Socket[0].fd,
75  errno);
76  }
77 
78  memset(m_Socket, 0, sizeof(m_Socket));
79 }
+
+
+ +

◆ IsOpen()

+ +
+
+ + + + + +
+ + + + + + + +
bool IsOpen () const
+ 		+finalvirtual
+
+ +

Implements IProfilingConnection.

+ +

Definition at line 63 of file SocketProfilingConnection.cpp.

+
64 {
65  return m_Socket[0].fd > 0;
66 }
+
+
+ +

◆ ReadPacket()

+ +
+
+ + + + + +
+ + + + + + + + +
arm::pipe::Packet ReadPacket (uint32_t timeout)
+ 		+finalvirtual
+
+ +

Implements IProfilingConnection.

+ +

Definition at line 91 of file SocketProfilingConnection.cpp.

+ +

References SocketProfilingConnection::Close().

+
92 {
93  // Is there currently at least a header worth of data waiting to be read?
94  int bytes_available = 0;
95  arm::pipe::Ioctl(m_Socket[0].fd, FIONREAD, &bytes_available);
96  if (bytes_available >= 8)
97  {
98  // Yes there is. Read it:
99  return ReceivePacket();
100  }
101 
102  // Poll for data on the socket or until timeout occurs
103  int pollResult = arm::pipe::Poll(&m_Socket[0], 1, static_cast<int>(timeout));
104 
105  switch (pollResult)
106  {
107  case -1: // Error
108  throw arm::pipe::SocketConnectionException(
109  std::string("SocketProfilingConnection: Error occured while reading from socket: ") + strerror(errno),
110  m_Socket[0].fd,
111  errno);
112 
113  case 0: // Timeout
114  throw arm::pipe::TimeoutException("SocketProfilingConnection: Timeout while reading from socket");
115 
116  default: // Normal poll return but it could still contain an error signal
117  // Check if the socket reported an error
118  if (m_Socket[0].revents & (POLLNVAL | POLLERR | POLLHUP))
119  {
120  if (m_Socket[0].revents == POLLNVAL)
121  {
122  // This is an unrecoverable error.
123  Close();
124  throw arm::pipe::SocketConnectionException(
125  std::string("SocketProfilingConnection: Error occured while polling receiving socket: POLLNVAL."),
126  m_Socket[0].fd);
127  }
128  if (m_Socket[0].revents == POLLERR)
129  {
130  throw arm::pipe::SocketConnectionException(
131  std::string(
132  "SocketProfilingConnection: Error occured while polling receiving socket: POLLERR: ")
133  + strerror(errno),
134  m_Socket[0].fd,
135  errno);
136  }
137  if (m_Socket[0].revents == POLLHUP)
138  {
139  // This is an unrecoverable error.
140  Close();
141  throw arm::pipe::SocketConnectionException(
142  std::string("SocketProfilingConnection: Connection closed by remote client: POLLHUP."),
143  m_Socket[0].fd);
144  }
145  }
146 
147  // Check if there is data to read
148  if (!(m_Socket[0].revents & (POLLIN)))
149  {
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.
152  throw armnn::TimeoutException(
153  "SocketProfilingConnection: File descriptor was polled but no data was available to receive.");
154  }
155 
156  return ReceivePacket();
157  }
158 }
+ +
+
+
+ +

◆ WritePacket()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool WritePacket (const unsigned char * buffer,
uint32_t length 
)
+ 		+finalvirtual
+
+ +

Implements IProfilingConnection.

+ +

Definition at line 81 of file SocketProfilingConnection.cpp.

+
82 {
83  if (buffer == nullptr || length == 0)
84  {
85  return false;
86  }
87 
88  return arm::pipe::Write(m_Socket[0].fd, buffer, length) != -1;
89 }
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1