Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 1 | // |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 2 | // Copyright © 2019 Arm Ltd and Contributors. All rights reserved. |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #pragma once |
| 7 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 8 | // local includes |
| 9 | #include "PeriodicCounterCaptureCommandHandler.hpp" |
| 10 | #include "StreamMetadataCommandHandler.hpp" |
| 11 | #include "StubCommandHandler.hpp" |
| 12 | |
| 13 | #include <common/include/CommandHandlerRegistry.hpp> |
| 14 | #include <common/include/Packet.hpp> |
| 15 | #include <common/include/PacketVersionResolver.hpp> |
| 16 | |
| 17 | #include <server/include/basePipeServer/BasePipeServer.hpp> |
| 18 | |
Jim Flynn | c454ac9 | 2022-03-16 18:43:18 +0000 | [diff] [blame] | 19 | #include <server/include/timelineDecoder/DirectoryCaptureCommandHandler.hpp> |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 20 | #include <server/include/timelineDecoder/TimelineDecoder.hpp> |
| 21 | #include <server/include/timelineDecoder/TimelineCaptureCommandHandler.hpp> |
| 22 | #include <server/include/timelineDecoder/TimelineDirectoryCaptureCommandHandler.hpp> |
| 23 | |
Colm Donelan | b682d84 | 2019-10-16 12:24:20 +0100 | [diff] [blame] | 24 | #include <atomic> |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 25 | #include <string> |
| 26 | #include <thread> |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 27 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 28 | namespace armnn |
| 29 | { |
| 30 | |
| 31 | namespace gatordmock |
| 32 | { |
| 33 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 34 | /// A class that implements a Mock Gatord server. It will listen on a specified Unix domain socket (UDS) |
Matthew Bentham | 6ae43c4 | 2022-01-10 13:34:12 +0000 | [diff] [blame] | 35 | /// namespace for client connections. It will then allow opertaions to manage counters while receiving counter data. |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 36 | class GatordMockService |
| 37 | { |
| 38 | public: |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 39 | /// @param registry reference to a command handler registry. |
| 40 | /// @param echoPackets if true the raw packets will be printed to stdout. |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 41 | GatordMockService(std::unique_ptr<arm::pipe::BasePipeServer> clientConnection, bool echoPackets) |
Finn Williams | 2ed809c | 2020-04-20 21:21:07 +0100 | [diff] [blame] | 42 | : m_BasePipeServer(std::move(clientConnection)) |
Finn Williams | e6a2ccd | 2020-02-27 16:21:41 +0000 | [diff] [blame] | 43 | , m_EchoPackets(echoPackets) |
| 44 | , m_CloseReceivingThread(false) |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 45 | , m_PacketVersionResolver() |
| 46 | , m_HandlerRegistry() |
| 47 | , m_TimelineDecoder() |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 48 | , m_CounterCaptureCommandHandler( |
Finn Williams | fe5a24b | 2020-04-09 16:05:28 +0100 | [diff] [blame] | 49 | 0, 4, m_PacketVersionResolver.ResolvePacketVersion(0, 4).GetEncodedValue(), !echoPackets) |
Finn Williams | d7fcafa | 2020-04-23 17:55:18 +0100 | [diff] [blame] | 50 | , m_StreamMetadataCommandHandler( |
| 51 | 0, 0, m_PacketVersionResolver.ResolvePacketVersion(0, 0).GetEncodedValue(), !echoPackets) |
| 52 | // This stub lets us ignore any counter capture packets we receive without throwing an error |
| 53 | , m_StubCommandHandler(3, 0, m_PacketVersionResolver.ResolvePacketVersion(0, 3).GetEncodedValue()) |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 54 | , m_DirectoryCaptureCommandHandler( |
Jim Flynn | 4a96211 | 2022-03-13 20:18:58 +0000 | [diff] [blame] | 55 | "ARMNN", 0, 2, m_PacketVersionResolver.ResolvePacketVersion(0, 2).GetEncodedValue(), !echoPackets) |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 56 | , m_TimelineCaptureCommandHandler( |
| 57 | 1, 1, m_PacketVersionResolver.ResolvePacketVersion(1, 1).GetEncodedValue(), m_TimelineDecoder) |
| 58 | , m_TimelineDirectoryCaptureCommandHandler( |
| 59 | 1, 0, m_PacketVersionResolver.ResolvePacketVersion(1, 0).GetEncodedValue(), |
Finn Williams | fe5a24b | 2020-04-09 16:05:28 +0100 | [diff] [blame] | 60 | m_TimelineCaptureCommandHandler, !echoPackets) |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 61 | { |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 62 | m_TimelineDecoder.SetDefaultCallbacks(); |
| 63 | |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 64 | m_HandlerRegistry.RegisterFunctor(&m_CounterCaptureCommandHandler); |
Finn Williams | d7fcafa | 2020-04-23 17:55:18 +0100 | [diff] [blame] | 65 | m_HandlerRegistry.RegisterFunctor(&m_StreamMetadataCommandHandler); |
| 66 | m_HandlerRegistry.RegisterFunctor(&m_StubCommandHandler); |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 67 | m_HandlerRegistry.RegisterFunctor(&m_DirectoryCaptureCommandHandler); |
| 68 | m_HandlerRegistry.RegisterFunctor(&m_TimelineDirectoryCaptureCommandHandler); |
| 69 | m_HandlerRegistry.RegisterFunctor(&m_TimelineCaptureCommandHandler); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 70 | } |
| 71 | |
Finn Williams | 2ed809c | 2020-04-20 21:21:07 +0100 | [diff] [blame] | 72 | GatordMockService(const GatordMockService&) = delete; |
| 73 | GatordMockService& operator=(const GatordMockService&) = delete; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 74 | |
Finn Williams | 2ed809c | 2020-04-20 21:21:07 +0100 | [diff] [blame] | 75 | GatordMockService(GatordMockService&&) = delete; |
| 76 | GatordMockService& operator=(GatordMockService&&) = delete; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 77 | |
| 78 | /// Once the connection is open wait to receive the stream meta data packet from the client. Reading this |
| 79 | /// packet differs from others as we need to determine endianness. |
| 80 | /// @return true only if a valid stream met data packet has been received. |
| 81 | bool WaitForStreamMetaData(); |
| 82 | |
| 83 | /// Send a connection acknowledged packet back to the client. |
| 84 | void SendConnectionAck(); |
| 85 | |
Finn Williams | 15db745 | 2019-10-15 14:22:13 +0100 | [diff] [blame] | 86 | /// Send a request counter directory packet back to the client. |
| 87 | void SendRequestCounterDir(); |
| 88 | |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 89 | /// Send a activate timeline packet back to the client. |
| 90 | void SendActivateTimelinePacket(); |
| 91 | |
| 92 | /// Send a deactivate timeline packet back to the client. |
| 93 | void SendDeactivateTimelinePacket(); |
| 94 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 95 | /// Start the thread that will receive all packets and print them nicely to stdout. |
| 96 | bool LaunchReceivingThread(); |
| 97 | |
| 98 | /// Return the total number of periodic counter capture packets received since the receive thread started. |
| 99 | /// @return number of periodic counter capture packets received. |
| 100 | uint32_t GetPacketsReceivedCount() |
| 101 | { |
| 102 | return m_PacketsReceivedCount.load(std::memory_order_acquire); |
| 103 | } |
| 104 | |
| 105 | /// This is a placeholder method to prevent main exiting. It can be removed once the |
| 106 | /// command handling code is added. |
| 107 | void WaitForReceivingThread(); |
| 108 | |
Colm Donelan | 0270524 | 2019-11-14 14:19:07 +0000 | [diff] [blame] | 109 | // @return true only if the receive thread is closed or closing. |
| 110 | bool ReceiveThreadRunning() |
| 111 | { |
| 112 | return !m_CloseReceivingThread.load(); |
| 113 | } |
| 114 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 115 | /// Send the counter list to ArmNN. |
Colm Donelan | b682d84 | 2019-10-16 12:24:20 +0100 | [diff] [blame] | 116 | void SendPeriodicCounterSelectionList(uint32_t period, std::vector<uint16_t> counters); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 117 | |
| 118 | /// Execute the WAIT command from the comamnd file. |
Rob Hughes | 270233f | 2019-11-13 11:53:48 +0000 | [diff] [blame] | 119 | void WaitCommand(uint32_t timeout); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 120 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 121 | arm::pipe::DirectoryCaptureCommandHandler& GetDirectoryCaptureCommandHandler() |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 122 | { |
| 123 | return m_DirectoryCaptureCommandHandler; |
| 124 | } |
| 125 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 126 | arm::pipe::TimelineDecoder& GetTimelineDecoder() |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 127 | { |
| 128 | return m_TimelineDecoder; |
| 129 | } |
| 130 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 131 | arm::pipe::TimelineDirectoryCaptureCommandHandler& GetTimelineDirectoryCaptureCommandHandler() |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 132 | { |
| 133 | return m_TimelineDirectoryCaptureCommandHandler; |
| 134 | } |
| 135 | |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 136 | private: |
Finn Williams | 2ed809c | 2020-04-20 21:21:07 +0100 | [diff] [blame] | 137 | void ReceiveLoop(); |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 138 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 139 | std::unique_ptr<arm::pipe::BasePipeServer> m_BasePipeServer; |
Finn Williams | e6a2ccd | 2020-02-27 16:21:41 +0000 | [diff] [blame] | 140 | |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 141 | std::atomic<uint32_t> m_PacketsReceivedCount; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 142 | |
| 143 | bool m_EchoPackets; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 144 | std::thread m_ListeningThread; |
| 145 | std::atomic<bool> m_CloseReceivingThread; |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 146 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 147 | arm::pipe::PacketVersionResolver m_PacketVersionResolver; |
| 148 | arm::pipe::CommandHandlerRegistry m_HandlerRegistry; |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 149 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 150 | arm::pipe::TimelineDecoder m_TimelineDecoder; |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 151 | |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 152 | gatordmock::PeriodicCounterCaptureCommandHandler m_CounterCaptureCommandHandler; |
Finn Williams | d7fcafa | 2020-04-23 17:55:18 +0100 | [diff] [blame] | 153 | gatordmock::StreamMetadataCommandHandler m_StreamMetadataCommandHandler; |
| 154 | gatordmock::StubCommandHandler m_StubCommandHandler; |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 155 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 156 | arm::pipe::DirectoryCaptureCommandHandler m_DirectoryCaptureCommandHandler; |
Keith Davis | 33ed221 | 2020-03-30 10:43:41 +0100 | [diff] [blame] | 157 | |
Jim Flynn | bbfe603 | 2020-07-20 16:57:44 +0100 | [diff] [blame] | 158 | arm::pipe::TimelineCaptureCommandHandler m_TimelineCaptureCommandHandler; |
| 159 | arm::pipe::TimelineDirectoryCaptureCommandHandler m_TimelineDirectoryCaptureCommandHandler; |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 160 | }; |
Colm Donelan | b682d84 | 2019-10-16 12:24:20 +0100 | [diff] [blame] | 161 | } // namespace gatordmock |
Colm Donelan | a21620d | 2019-10-11 13:09:49 +0100 | [diff] [blame] | 162 | |
Colm Donelan | b682d84 | 2019-10-16 12:24:20 +0100 | [diff] [blame] | 163 | } // namespace armnn |