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 --- ...n_1_1profiling_1_1_mock_profiling_service.xhtml | 603 +++++++++++++++++++++ 1 file changed, 603 insertions(+) create mode 100644 21.02/classarmnn_1_1profiling_1_1_mock_profiling_service.xhtml (limited to '21.02/classarmnn_1_1profiling_1_1_mock_profiling_service.xhtml') diff --git a/21.02/classarmnn_1_1profiling_1_1_mock_profiling_service.xhtml b/21.02/classarmnn_1_1profiling_1_1_mock_profiling_service.xhtml new file mode 100644 index 0000000000..28cb31333c --- /dev/null +++ b/21.02/classarmnn_1_1profiling_1_1_mock_profiling_service.xhtml @@ -0,0 +1,603 @@ + + + + + + + + + + + + + +ArmNN: MockProfilingService Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
MockProfilingService Class Reference
+
+
+ +

#include <ProfilingMocks.hpp>

+
+Inheritance diagram for MockProfilingService:
+
+
+ + +ProfilingService +IReadWriteCounterValues +IProfilingService +INotifyBackends +IReadCounterValues +IWriteCounterValues +IProfilingGuidGenerator +IProfilingServiceStatus + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MockProfilingService (MockBufferManager &mockBufferManager, bool isProfilingEnabled, const CaptureData &captureData)
 
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
 
const ICounterMappings & GetCounterMappings () const override
 
ISendCounterPacket & GetSendCounterPacket () override
 
bool IsProfilingEnabled () const override
 
CaptureData GetCaptureData () override
 
void RegisterMapping (uint16_t globalCounterId, uint16_t backendCounterId, const armnn::BackendId &backendId)
 
void Reset ()
 
- Public Member Functions inherited from ProfilingService
 ProfilingService (Optional< IReportStructure &> reportStructure=EmptyOptional())
 
 ~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)
 
void NotifyBackendsForTimelineReporting () override
 
const ICounterDirectory & GetCounterDirectory () const
 
ICounterRegistry & GetCounterRegistry ()
 
ProfilingState GetCurrentState () const
 
bool IsCounterRegistered (uint16_t counterUid) const override
 
uint32_t GetAbsoluteCounterValue (uint16_t counterUid) const override
 
uint32_t GetDeltaCounterValue (uint16_t counterUid) override
 
uint16_t GetCounterCount () const override
 
IRegisterCounterMapping & GetCounterMappingRegistry ()
 
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
 
void ResetGuidGenerator ()
 
bool IsTimelineReportingEnabled ()
 
void AddLocalPacketHandler (ILocalPacketHandlerSharedPtr localPacketHandler)
 
void NotifyProfilingServiceActive () override
 
void WaitForProfilingServiceActivation (unsigned int timeout) override
 
- 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 ()
 
- Public Member Functions inherited from IProfilingServiceStatus
virtual ~IProfilingServiceStatus ()
 
- Public Member Functions inherited from INotifyBackends
virtual ~INotifyBackends ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- 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 > >
 
using BackendProfilingContext = std::unordered_map< BackendId, std::shared_ptr< armnn::profiling::IBackendProfilingContext > >
 
- Static Public Member Functions inherited from ProfilingService
static ProfilingDynamicGuid GetNextGuid ()
 
static ProfilingStaticGuid GetStaticId (const std::string &str)
 
- Protected Member Functions inherited from 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 627 of file ProfilingMocks.hpp.

+

Constructor & Destructor Documentation

+ +

◆ MockProfilingService()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
MockProfilingService (MockBufferManager & mockBufferManager,
bool isProfilingEnabled,
const CaptureData & captureData 
)
+ 		+inline
+
+ +

Definition at line 630 of file ProfilingMocks.hpp.

+
632  :
633  m_SendCounterPacket(mockBufferManager),
634  m_IsProfilingEnabled(isProfilingEnabled),
635  m_CaptureData(captureData)
636  {}
+
+
+

Member Function Documentation

+ +

◆ GenerateStaticId()

+ +
+
+ + + + + +
+ + + + + + + + +
ProfilingStaticGuid GenerateStaticId (const std::string & str)
+ 		+inlineoverridevirtual
+
+ +

Create a ProfilingStaticGuid based on a hash of the string.

+ +

Reimplemented from ProfilingService.

+ +

Definition at line 645 of file ProfilingMocks.hpp.

+
646  {
647  return m_GuidGenerator.GenerateStaticId(str);
648  }
armnn::profiling::ProfilingGuidGenerator::GenerateStaticId
ProfilingStaticGuid GenerateStaticId(const std::string &str) override
Create a ProfilingStaticGuid based on a hash of the string.
Definition: ProfilingGuidGenerator.hpp:40
+
+
+
+ +

◆ GetCaptureData()

+ +
+
+ + + + + +
+ + + + + + + +
CaptureData GetCaptureData ()
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from ProfilingService.

+ +

Definition at line 670 of file ProfilingMocks.hpp.

+
671  {
672  CaptureData copy(m_CaptureData);
673  return copy;
674  }
+
+
+ +

◆ GetCounterMappings()

+ +
+
+ + + + + +
+ + + + + + + +
const ICounterMappings& GetCounterMappings () const
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from ProfilingService.

+ +

Definition at line 655 of file ProfilingMocks.hpp.

+
656  {
657  return m_CounterMapping;
658  }
+
+
+ +

◆ GetSendCounterPacket()

+ +
+
+ + + + + +
+ + + + + + + +
ISendCounterPacket& GetSendCounterPacket ()
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from ProfilingService.

+ +

Definition at line 660 of file ProfilingMocks.hpp.

+
661  {
662  return m_SendCounterPacket;
663  }
+
+
+ +

◆ GetSendTimelinePacket()

+ +
+
+ + + + + +
+ + + + + + + +
std::unique_ptr<ISendTimelinePacket> GetSendTimelinePacket () const
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from ProfilingService.

+ +

Definition at line 650 of file ProfilingMocks.hpp.

+
651  {
652  return nullptr;
653  }
+
+
+ +

◆ IsProfilingEnabled()

+ +
+
+ + + + + +
+ + + + + + + +
bool IsProfilingEnabled () const
+ 		+inlineoverridevirtual
+
+ +

Reimplemented from ProfilingService.

+ +

Definition at line 665 of file ProfilingMocks.hpp.

+
666  {
667  return m_IsProfilingEnabled;
668  }
+
+
+ +

◆ NextGuid()

+ +
+
+ + + + + +
+ + + + + + + +
ProfilingDynamicGuid NextGuid ()
+ 		+inlineoverridevirtual
+
+ +

Return the next random Guid in the sequence.

+ +

Reimplemented from ProfilingService.

+ +

Definition at line 639 of file ProfilingMocks.hpp.

+
640  {
641  return m_GuidGenerator.NextGuid();
642  }
armnn::profiling::ProfilingGuidGenerator::NextGuid
ProfilingDynamicGuid NextGuid() override
Return the next random Guid in the sequence.
Definition: ProfilingGuidGenerator.hpp:26
+
+
+
+ +

◆ RegisterMapping()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void RegisterMapping (uint16_t globalCounterId,
uint16_t backendCounterId,
const armnn::BackendId & backendId 
)
+ 		+inline
+
+ +

Definition at line 676 of file ProfilingMocks.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
679  {
680  m_CounterMapping.RegisterMapping(globalCounterId, backendCounterId, backendId);
681  }
armnn::profiling::CounterIdMap::RegisterMapping
void RegisterMapping(uint16_t globalCounterId, uint16_t backendCounterId, const armnn::BackendId &backendId) override
Definition: CounterIdMap.cpp:15
+
+
+
+ +

◆ Reset()

+ +
+
+ + + + + +
+ + + + + + + +
void Reset ()
+ 		+inline
+
+ +

Definition at line 683 of file ProfilingMocks.hpp.

+
684  {
685  m_CounterMapping.Reset();
686  }
+
+
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1