A class that implements a Mock Gatord server. More...

#include <GatordMockService.hpp>

Public Member Functions
	GatordMockService (std::unique_ptr< arm::pipe::BasePipeServer > clientConnection, bool echoPackets)

	GatordMockService (const GatordMockService &)=delete

GatordMockService &	operator= (const GatordMockService &)=delete

	GatordMockService (GatordMockService &&)=delete

GatordMockService &	operator= (GatordMockService &&)=delete

bool	WaitForStreamMetaData ()
	Once the connection is open wait to receive the stream meta data packet from the client. More...

void	SendConnectionAck ()
	Send a connection acknowledged packet back to the client. More...

void	SendRequestCounterDir ()
	Send a request counter directory packet back to the client. More...

void	SendActivateTimelinePacket ()
	Send a activate timeline packet back to the client. More...

void	SendDeactivateTimelinePacket ()
	Send a deactivate timeline packet back to the client. More...

bool	LaunchReceivingThread ()
	Start the thread that will receive all packets and print them nicely to stdout. More...

uint32_t	GetPacketsReceivedCount ()
	Return the total number of periodic counter capture packets received since the receive thread started. More...

void	WaitForReceivingThread ()
	This is a placeholder method to prevent main exiting. More...

bool	ReceiveThreadRunning ()

void	SendPeriodicCounterSelectionList (uint32_t period, std::vector< uint16_t > counters)
	Send the counter list to ArmNN. More...

void	WaitCommand (uint32_t timeout)
	Execute the WAIT command from the comamnd file. More...

profiling::DirectoryCaptureCommandHandler &	GetDirectoryCaptureCommandHandler ()

arm::pipe::TimelineDecoder &	GetTimelineDecoder ()

arm::pipe::TimelineDirectoryCaptureCommandHandler &	GetTimelineDirectoryCaptureCommandHandler ()

Detailed Description

A class that implements a Mock Gatord server.

It will listen on a specified Unix domain socket (UDS) namespace for client connections. It will then allow opertaions to manage coutners while receiving counter data.

Definition at line 38 of file GatordMockService.hpp.

Constructor & Destructor Documentation

◆ GatordMockService() [1/3]

GatordMockService	(	std::unique_ptr< arm::pipe::BasePipeServer >	clientConnection,
		bool	echoPackets
	)

inline

Parameters

registry	reference to a command handler registry.
echoPackets	if true the raw packets will be printed to stdout.

Definition at line 43 of file GatordMockService.hpp.

References GatordMockService::LaunchReceivingThread(), GatordMockService::operator=(), GatordMockService::SendActivateTimelinePacket(), GatordMockService::SendConnectionAck(), GatordMockService::SendDeactivateTimelinePacket(), GatordMockService::SendRequestCounterDir(), and GatordMockService::WaitForStreamMetaData().

             : m_BasePipeServer(std::move(clientConnection))
             , m_EchoPackets(echoPackets)
             , m_CloseReceivingThread(false)
             , m_PacketVersionResolver()
             , m_HandlerRegistry()
             , m_TimelineDecoder()
             , m_CounterCaptureCommandHandler(
                     0, 4, m_PacketVersionResolver.ResolvePacketVersion(0, 4).GetEncodedValue(), !echoPackets)
             , m_StreamMetadataCommandHandler(
                     0, 0, m_PacketVersionResolver.ResolvePacketVersion(0, 0).GetEncodedValue(), !echoPackets)
             // This stub lets us ignore any counter capture packets we receive without throwing an error
             , m_StubCommandHandler(3, 0, m_PacketVersionResolver.ResolvePacketVersion(0, 3).GetEncodedValue())
             , m_DirectoryCaptureCommandHandler(
                     0, 2, m_PacketVersionResolver.ResolvePacketVersion(0, 2).GetEncodedValue(), !echoPackets)
             , m_TimelineCaptureCommandHandler(
                     1, 1, m_PacketVersionResolver.ResolvePacketVersion(1, 1).GetEncodedValue(), m_TimelineDecoder)
             , m_TimelineDirectoryCaptureCommandHandler(
                     1, 0, m_PacketVersionResolver.ResolvePacketVersion(1, 0).GetEncodedValue(),
                     m_TimelineCaptureCommandHandler, !echoPackets)
     {
         m_TimelineDecoder.SetDefaultCallbacks();
 
         m_HandlerRegistry.RegisterFunctor(&m_CounterCaptureCommandHandler);
         m_HandlerRegistry.RegisterFunctor(&m_StreamMetadataCommandHandler);
         m_HandlerRegistry.RegisterFunctor(&m_StubCommandHandler);
         m_HandlerRegistry.RegisterFunctor(&m_DirectoryCaptureCommandHandler);
         m_HandlerRegistry.RegisterFunctor(&m_TimelineDirectoryCaptureCommandHandler);
         m_HandlerRegistry.RegisterFunctor(&m_TimelineCaptureCommandHandler);
     }

◆ GatordMockService() [2/3]

GatordMockService ( const GatordMockService & )

delete

◆ GatordMockService() [3/3]

GatordMockService ( GatordMockService && )

delete

Member Function Documentation

◆ GetDirectoryCaptureCommandHandler()

profiling::DirectoryCaptureCommandHandler& GetDirectoryCaptureCommandHandler ( )

inline

Definition at line 123 of file GatordMockService.hpp.

     {
         return m_DirectoryCaptureCommandHandler;
     }

◆ GetPacketsReceivedCount()

uint32_t GetPacketsReceivedCount ( )

inline

Return the total number of periodic counter capture packets received since the receive thread started.

Returns: number of periodic counter capture packets received.

Definition at line 102 of file GatordMockService.hpp.

References GatordMockService::WaitForReceivingThread().

     {
         return m_PacketsReceivedCount.load(std::memory_order_acquire);
     }

◆ GetTimelineDecoder()

arm::pipe::TimelineDecoder& GetTimelineDecoder ( )

inline

Definition at line 128 of file GatordMockService.hpp.

     {
         return m_TimelineDecoder;
     }

◆ GetTimelineDirectoryCaptureCommandHandler()

arm::pipe::TimelineDirectoryCaptureCommandHandler& GetTimelineDirectoryCaptureCommandHandler ( )

inline

Definition at line 133 of file GatordMockService.hpp.

     {
         return m_TimelineDirectoryCaptureCommandHandler;
     }

◆ LaunchReceivingThread()

bool LaunchReceivingThread ( )

Start the thread that will receive all packets and print them nicely to stdout.

Definition at line 64 of file GatordMockService.cpp.

Referenced by CreateMockService(), and GatordMockService::GatordMockService().

 {
     if (m_EchoPackets)
     {
         std::cout << "Launching receiving thread." << std::endl;
     }
     // At this point we want to make the socket non blocking.
     if (!m_BasePipeServer.get()->SetNonBlocking())
     {
         m_BasePipeServer.get()->Close();
         std::cerr << "Failed to set socket as non blocking: " << strerror(errno) << std::endl;
         return false;
     }
     m_ListeningThread = std::thread(&GatordMockService::ReceiveLoop, this);
     return true;
 }

◆ operator=() [1/2]

GatordMockService& operator= ( const GatordMockService & )

delete

Referenced by GatordMockService::GatordMockService().

◆ operator=() [2/2]

GatordMockService& operator= ( GatordMockService && )

delete

◆ ReceiveThreadRunning()

bool ReceiveThreadRunning ( )

inline

Definition at line 112 of file GatordMockService.hpp.

References GatordMockService::SendPeriodicCounterSelectionList(), and GatordMockService::WaitCommand().

Referenced by CommandFileParser::ParseFile(), and GatordMockService::WaitCommand().

     {
         return !m_CloseReceivingThread.load();
     }

◆ SendActivateTimelinePacket()

void SendActivateTimelinePacket ( )

Send a activate timeline packet back to the client.

Definition at line 44 of file GatordMockService.cpp.

Referenced by GatordMockService::GatordMockService(), and CommandFileParser::ParseFile().

 {
     if (m_EchoPackets)
     {
         std::cout << "Sending activate timeline packet." << std::endl;
     }
     // The activate timeline packet is an empty data packet with packetId == 6.
     m_BasePipeServer.get()->SendPacket(0, 6, nullptr, 0);
 }

◆ SendConnectionAck()

void SendConnectionAck ( )

Send a connection acknowledged packet back to the client.

Definition at line 24 of file GatordMockService.cpp.

Referenced by CreateMockService(), and GatordMockService::GatordMockService().

 {
     if (m_EchoPackets)
     {
         std::cout << "Sending connection acknowledgement." << std::endl;
     }
     // The connection ack packet is an empty data packet with packetId == 1.
     m_BasePipeServer.get()->SendPacket(0, 1, nullptr, 0);
 }

◆ SendDeactivateTimelinePacket()

void SendDeactivateTimelinePacket ( )

Send a deactivate timeline packet back to the client.

Definition at line 54 of file GatordMockService.cpp.

Referenced by GatordMockService::GatordMockService(), and CommandFileParser::ParseFile().

 {
     if (m_EchoPackets)
     {
         std::cout << "Sending deactivate timeline packet." << std::endl;
     }
     // The deactivate timeline packet is an empty data packet with packetId == 7.
     m_BasePipeServer.get()->SendPacket(0, 7, nullptr, 0);
 }

◆ SendPeriodicCounterSelectionList()

void SendPeriodicCounterSelectionList	(	uint32_t	period,
		std::vector< uint16_t >	counters
	)

Send the counter list to ArmNN.

Definition at line 106 of file GatordMockService.cpp.

References armnn::profiling::WriteUint16(), and armnn::profiling::WriteUint32().

Referenced by CommandFileParser::ParseFile(), and GatordMockService::ReceiveThreadRunning().

 {
     // The packet body consists of a UINT32 representing the period following by zero or more
     // UINT16's representing counter UID's. If the list is empty it implies all counters are to
     // be disabled.
 
     if (m_EchoPackets)
     {
         std::cout << "SendPeriodicCounterSelectionList: Period=" << std::dec << period << "uSec" << std::endl;
         std::cout << "List length=" << counters.size() << std::endl;
     }
     // Start by calculating the length of the packet body in bytes. This will be at least 4.
     uint32_t dataLength = static_cast<uint32_t>(4 + (counters.size() * 2));
 
     std::unique_ptr<unsigned char[]> uniqueData = std::make_unique<unsigned char[]>(dataLength);
     unsigned char* data                         = reinterpret_cast<unsigned char*>(uniqueData.get());
 
     uint32_t offset = 0;
     arm::pipe::WriteUint32(data, offset, period);
     offset += 4;
     for (std::vector<uint16_t>::iterator it = counters.begin(); it != counters.end(); ++it)
     {
         arm::pipe::WriteUint16(data, offset, *it);
         offset += 2;
     }
 
     // Send the packet.
     m_BasePipeServer.get()->SendPacket(0, 4, data, dataLength);
     // There will be an echo response packet sitting in the receive thread. PeriodicCounterSelectionResponseHandler
     // should deal with it.
 }

◆ SendRequestCounterDir()

void SendRequestCounterDir ( )

Send a request counter directory packet back to the client.

Definition at line 34 of file GatordMockService.cpp.

Referenced by GatordMockService::GatordMockService(), and CommandFileParser::ParseFile().

 {
     if (m_EchoPackets)
     {
         std::cout << "Sending connection acknowledgement." << std::endl;
     }
     // The request counter directory packet is an empty data packet with packetId == 3.
     m_BasePipeServer.get()->SendPacket(0, 3, nullptr, 0);
 }

◆ WaitCommand()

void WaitCommand ( uint32_t timeout )

Execute the WAIT command from the comamnd file.

Definition at line 138 of file GatordMockService.cpp.

References GatordMockService::ReceiveThreadRunning().

Referenced by CommandFileParser::ParseFile(), and GatordMockService::ReceiveThreadRunning().

 {
     // Wait for a maximum of timeout microseconds or if the receive thread has closed.
     // There is a certain level of rounding involved in this timing.
     uint32_t iterations = timeout / 1000;
     std::cout << std::dec << "Wait command with timeout of " << timeout << " iterations =  " << iterations << std::endl;
     uint32_t count = 0;
     while ((this->ReceiveThreadRunning() && (count < iterations)))
     {
         std::this_thread::sleep_for(std::chrono::microseconds(1000));
         ++count;
     }
     if (m_EchoPackets)
     {
         std::cout << std::dec << "Wait command with timeout of " << timeout << " microseconds completed. " << std::endl;
     }
 }

◆ WaitForReceivingThread()

void WaitForReceivingThread ( )

This is a placeholder method to prevent main exiting.

It can be removed once the command handling code is added.

Definition at line 81 of file GatordMockService.cpp.

Referenced by CreateMockService(), and GatordMockService::GetPacketsReceivedCount().

 {
     // The receiving thread may already have died.
     if (m_CloseReceivingThread != true)
     {
         m_CloseReceivingThread.store(true);
     }
     // Check that the receiving thread is running
     if (m_ListeningThread.joinable())
     {
         // Wait for the receiving thread to complete operations
         m_ListeningThread.join();
     }
 
     if(m_EchoPackets)
     {
         m_TimelineDecoder.print();
     }
 }

◆ WaitForStreamMetaData()

bool WaitForStreamMetaData ( )

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.

Returns: true only if a valid stream met data packet has been received.

Definition at line 101 of file GatordMockService.cpp.

Referenced by CreateMockService(), and GatordMockService::GatordMockService().

 {
     return m_BasePipeServer->WaitForStreamMetaData();
 }

The documentation for this class was generated from the following files:

tests/profiling/gatordmock/GatordMockService.hpp
tests/profiling/gatordmock/GatordMockService.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GatordMockService() [1/3]

◆ GatordMockService() [2/3]

◆ GatordMockService() [3/3]

Member Function Documentation

◆ GetDirectoryCaptureCommandHandler()

◆ GetPacketsReceivedCount()

◆ GetTimelineDecoder()

◆ GetTimelineDirectoryCaptureCommandHandler()

◆ LaunchReceivingThread()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReceiveThreadRunning()

◆ SendActivateTimelinePacket()

◆ SendConnectionAck()

◆ SendDeactivateTimelinePacket()

◆ SendPeriodicCounterSelectionList()

◆ SendRequestCounterDir()

◆ WaitCommand()

◆ WaitForReceivingThread()

◆ WaitForStreamMetaData()