From 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Thu, 19 Mar 2020 17:03:14 +0000 Subject: Creating gh-pages documentation for ArmNN Signed-off-by: Jim Flynn --- ..._swap_profiling_connection_factory_helper.xhtml | 467 +++++++++++++++++++++ 1 file changed, 467 insertions(+) create mode 100644 Documentation/classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml (limited to 'Documentation/classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml') diff --git a/Documentation/classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml b/Documentation/classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml new file mode 100644 index 0000000000..4e90678a89 --- /dev/null +++ b/Documentation/classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml @@ -0,0 +1,467 @@ + + + + + + + + + + + + + +ArmNN: SwapProfilingConnectionFactoryHelper Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
+
SwapProfilingConnectionFactoryHelper Class Reference
+
+
+ +

#include <ProfilingTests.hpp>

+
+Inheritance diagram for SwapProfilingConnectionFactoryHelper:
+
+
+ + +ProfilingService +IReadWriteCounterValues +IProfilingService +IReadCounterValues +IWriteCounterValues +IProfilingGuidGenerator + +
+ + + + + + + + + + + + + + + +

+Public Types

using MockProfilingConnectionFactoryPtr = std::unique_ptr< MockProfilingConnectionFactory >
 
- Public Types inherited from ProfilingService
using ExternalProfilingOptions = IRuntime::CreationOptions::ExternalProfilingOptions
 
using IProfilingConnectionFactoryPtr = std::unique_ptr< IProfilingConnectionFactory >
 
using IProfilingConnectionPtr = std::unique_ptr< IProfilingConnection >
 
using CounterIndices = std::vector< std::atomic< uint32_t > * >
 
using CounterValues = std::list< std::atomic< uint32_t > >
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 SwapProfilingConnectionFactoryHelper ()
 
 ~SwapProfilingConnectionFactoryHelper ()
 
MockProfilingConnection * GetMockProfilingConnection ()
 
void ForceTransitionToState (ProfilingState newState)
 
long WaitForPacketsSent (MockProfilingConnection *mockProfilingConnection, MockProfilingConnection::PacketType packetType, uint32_t length=0, uint32_t timeout=1000)
 
- Public Member Functions inherited from ProfilingService
void ResetExternalProfilingOptions (const ExternalProfilingOptions &options, bool resetProfilingService=false)
 
ProfilingState ConfigureProfilingService (const ExternalProfilingOptions &options, bool resetProfilingService=false)
 
void Update ()
 
void Disconnect ()
 
void AddBackendProfilingContext (const BackendId backendId, std::shared_ptr< armnn::profiling::IBackendProfilingContext > profilingContext)
 
const ICounterDirectory & GetCounterDirectory () const
 
ICounterRegistry & GetCounterRegistry ()
 
ProfilingState GetCurrentState () const
 
bool IsCounterRegistered (uint16_t counterUid) const override
 
uint32_t GetCounterValue (uint16_t counterUid) const override
 
uint16_t GetCounterCount () const override
 
const ICounterMappings & GetCounterMappings () const override
 
IRegisterCounterMapping & GetCounterMappingRegistry ()
 
bool IsProfilingEnabled () const override
 
CaptureData GetCaptureData () override
 
void SetCaptureData (uint32_t capturePeriod, const std::vector< uint16_t > &counterIds, const std::set< BackendId > &activeBackends)
 
void SetCounterValue (uint16_t counterUid, uint32_t value) override
 
uint32_t AddCounterValue (uint16_t counterUid, uint32_t value) override
 
uint32_t SubtractCounterValue (uint16_t counterUid, uint32_t value) override
 
uint32_t IncrementCounterValue (uint16_t counterUid) override
 
ProfilingDynamicGuid NextGuid () override
 Return the next random Guid in the sequence. More...
 
ProfilingStaticGuid GenerateStaticId (const std::string &str) override
 Create a ProfilingStaticGuid based on a hash of the string. More...
 
std::unique_ptr< ISendTimelinePacket > GetSendTimelinePacket () const override
 
ISendCounterPacket & GetSendCounterPacket () override
 
bool IsEnabled ()
 Check if the profiling is enabled. More...
 
- Public Member Functions inherited from IReadWriteCounterValues
virtual ~IReadWriteCounterValues ()
 
- Public Member Functions inherited from IReadCounterValues
virtual ~IReadCounterValues ()
 
- Public Member Functions inherited from IWriteCounterValues
virtual ~IWriteCounterValues ()
 
- Public Member Functions inherited from IProfilingService
virtual ~IProfilingService ()
 
- Public Member Functions inherited from IProfilingGuidGenerator
virtual ~IProfilingGuidGenerator ()
 
+ + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from ProfilingService
static ProfilingService & Instance ()
 
- Protected Member Functions inherited from ProfilingService
 ProfilingService ()
 
 ~ProfilingService ()
 
void SwapProfilingConnectionFactory (ProfilingService &instance, IProfilingConnectionFactory *other, IProfilingConnectionFactory *&backup)
 
IProfilingConnection * GetProfilingConnection (ProfilingService &instance)
 
void TransitionToState (ProfilingService &instance, ProfilingState newState)
 
bool WaitForPacketSent (ProfilingService &instance, uint32_t timeout=1000)
 
BufferManager & GetBufferManager (ProfilingService &instance)
 
+

Detailed Description

+
+

Definition at line 202 of file ProfilingTests.hpp.

+

Member Typedef Documentation

+ +

◆ MockProfilingConnectionFactoryPtr

+ +
+
+ + + + +
using MockProfilingConnectionFactoryPtr = std::unique_ptr<MockProfilingConnectionFactory>
+
+ +

Definition at line 205 of file ProfilingTests.hpp.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ SwapProfilingConnectionFactoryHelper()

+ +
+
+ + + + + +
+ + + + + + + +
SwapProfilingConnectionFactoryHelper ()
+ 		+inline
+
+ +

Definition at line 207 of file ProfilingTests.hpp.

+ +

References BOOST_CHECK(), and ProfilingService::Instance().

+
208  : ProfilingService()
209  , m_MockProfilingConnectionFactory(new MockProfilingConnectionFactory())
210  , m_BackupProfilingConnectionFactory(nullptr)
211  {
212  BOOST_CHECK(m_MockProfilingConnectionFactory);
213  SwapProfilingConnectionFactory(ProfilingService::Instance(),
214  m_MockProfilingConnectionFactory.get(),
215  m_BackupProfilingConnectionFactory);
216  BOOST_CHECK(m_BackupProfilingConnectionFactory);
217  }
armnn::profiling::ProfilingService::Instance
static ProfilingService & Instance()
Definition: ProfilingService.hpp:52
+
BOOST_CHECK
BOOST_CHECK(profilingService.GetCurrentState()==ProfilingState::WaitingForAck)
+ +
armnn::profiling::ProfilingService::SwapProfilingConnectionFactory
void SwapProfilingConnectionFactory(ProfilingService &instance, IProfilingConnectionFactory *other, IProfilingConnectionFactory *&backup)
Definition: ProfilingService.hpp:226
+
+
+
+ +

◆ ~SwapProfilingConnectionFactoryHelper()

+ +
+
+ + + + + +
+ + + + + + + +
~SwapProfilingConnectionFactoryHelper ()
+ 		+inline
+
+ +

Definition at line 218 of file ProfilingTests.hpp.

+ +

References BOOST_CHECK(), and ProfilingService::Instance().

+
219  {
220  BOOST_CHECK(m_BackupProfilingConnectionFactory);
221  IProfilingConnectionFactory* temp = nullptr;
222  SwapProfilingConnectionFactory(ProfilingService::Instance(),
223  m_BackupProfilingConnectionFactory,
224  temp);
225  }
armnn::profiling::ProfilingService::Instance
static ProfilingService & Instance()
Definition: ProfilingService.hpp:52
+
BOOST_CHECK
BOOST_CHECK(profilingService.GetCurrentState()==ProfilingState::WaitingForAck)
+
armnn::profiling::ProfilingService::SwapProfilingConnectionFactory
void SwapProfilingConnectionFactory(ProfilingService &instance, IProfilingConnectionFactory *other, IProfilingConnectionFactory *&backup)
Definition: ProfilingService.hpp:226
+
+
+
+

Member Function Documentation

+ +

◆ ForceTransitionToState()

+ +
+
+ + + + + +
+ + + + + + + + +
void ForceTransitionToState (ProfilingState newState)
+ 		+inline
+
+ +

Definition at line 233 of file ProfilingTests.hpp.

+ +

References ProfilingService::Instance().

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
234  {
235  TransitionToState(ProfilingService::Instance(), newState);
236  }
armnn::profiling::ProfilingService::Instance
static ProfilingService & Instance()
Definition: ProfilingService.hpp:52
+
armnn::profiling::ProfilingService::TransitionToState
void TransitionToState(ProfilingService &instance, ProfilingState newState)
Definition: ProfilingService.hpp:240
+
+
+
+ +

◆ GetMockProfilingConnection()

+ +
+
+ + + + + +
+ + + + + + + +
MockProfilingConnection* GetMockProfilingConnection ()
+ 		+inline
+
+ +

Definition at line 227 of file ProfilingTests.hpp.

+ +

References ProfilingService::Instance().

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
228  {
229  IProfilingConnection* profilingConnection = GetProfilingConnection(ProfilingService::Instance());
230  return boost::polymorphic_downcast<MockProfilingConnection*>(profilingConnection);
231  }
armnn::profiling::ProfilingService::Instance
static ProfilingService & Instance()
Definition: ProfilingService.hpp:52
+
armnn::profiling::ProfilingService::GetProfilingConnection
IProfilingConnection * GetProfilingConnection(ProfilingService &instance)
Definition: ProfilingService.hpp:236
+
+
+
+ +

◆ WaitForPacketsSent()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
long WaitForPacketsSent (MockProfilingConnection * mockProfilingConnection,
MockProfilingConnection::PacketType packetType,
uint32_t length = 0,
uint32_t timeout = 1000 
)
+ 		+inline
+
+ +

Definition at line 238 of file ProfilingTests.hpp.

+ +

References MockProfilingConnection::CheckForPacket(), ProfilingService::Instance(), packetCount, and ProfilingService::WaitForPacketSent().

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
242  {
243  long packetCount = mockProfilingConnection->CheckForPacket({packetType, length});
244  // The first packet we receive may not be the one we are looking for, so keep looping until till we find it,
245  // or until WaitForPacketsSent times out
246  while(packetCount == 0 && timeout != 0)
247  {
248  std::chrono::steady_clock::time_point start = std::chrono::steady_clock::now();
249  // Wait for a notification from the send thread
250  ProfilingService::WaitForPacketSent(ProfilingService::Instance(), timeout);
251 
252  std::chrono::steady_clock::time_point end = std::chrono::steady_clock::now();
253 
254  // We need to make sure the timeout does not reset each time we call WaitForPacketsSent
255  uint32_t elapsedTime = static_cast<uint32_t>(
256  std::chrono::duration_cast<std::chrono::milliseconds>(end - start).count());
257 
258  packetCount = mockProfilingConnection->CheckForPacket({packetType, length});
259 
260  if (elapsedTime > timeout)
261  {
262  break;
263  }
264 
265  timeout -= elapsedTime;
266  }
267  return packetCount;
268  }
armnn::profiling::ProfilingService::Instance
static ProfilingService & Instance()
Definition: ProfilingService.hpp:52
+
packetCount
uint32_t packetCount
Definition: FileOnlyProfilingDecoratorTests.cpp:68
+
armnn::profiling::ProfilingService::WaitForPacketSent
bool WaitForPacketSent(ProfilingService &instance, uint32_t timeout=1000)
Definition: ProfilingService.hpp:244
+
+
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1