FileOnlyProfilingConnection Class Reference

#include <FileOnlyProfilingConnection.hpp>

Inheritance diagram for FileOnlyProfilingConnection:

Public Member Functions
	FileOnlyProfilingConnection (const Runtime::CreationOptions::ExternalProfilingOptions &options)
	~FileOnlyProfilingConnection () override
bool	IsOpen () const override
void	Close () override
bool	WritePacket (const unsigned char *buffer, uint32_t length) override
arm::pipe::Packet	ReadPacket (uint32_t timeout) override
void	SetEndianess (const TargetEndianness &endianness) override
void	ReturnPacket (arm::pipe::Packet &packet) override
Public Member Functions inherited from IProfilingConnection
virtual	~IProfilingConnection ()
Public Member Functions inherited from IInternalProfilingConnection
virtual	~IInternalProfilingConnection ()

Detailed Description

Definition at line 50 of file FileOnlyProfilingConnection.hpp.

Constructor & Destructor Documentation

FileOnlyProfilingConnection()

FileOnlyProfilingConnection ( const Runtime::CreationOptions::ExternalProfilingOptions &  options )

inlineexplicit

Definition at line 53 of file FileOnlyProfilingConnection.hpp.

        : m_Options(options)
        , m_Endianness(TargetEndianness::LeWire)    // Set a sensible default.
                                                    // StreamMetaDataProcessor will set a real value.
        , m_IsRunning(false)
        , m_KeepRunning(false)
        , m_Timeout(1000)
    {
        // add the StreamMetaDataProcessor
        auto streamMetaDataProcessor = std::make_shared<StreamMetaDataProcessor>(this);
        AddLocalPacketHandler(streamMetaDataProcessor);
        // and any additional ones added by the users
        for (const ILocalPacketHandlerSharedPtr& localPacketHandler : options.m_LocalPacketHandlers)
        {
            AddLocalPacketHandler(localPacketHandler);
        }
        if (!m_PacketHandlers.empty())
        {
            StartProcessingThread();
        }
        // NOTE: could add timeout to the external profiling options
    };

~FileOnlyProfilingConnection()

~FileOnlyProfilingConnection ( )

override

Definition at line 74 of file FileOnlyProfilingConnection.cpp.

{
    try
    {
        Close();
    }
    catch (...)
    {
        // do nothing
    }
}

Member Function Documentation

Close()

void Close ( )

overridevirtual

Implements IInternalProfilingConnection.

Definition at line 92 of file FileOnlyProfilingConnection.cpp.

{
    // Dump any unread packets out of the queue.
    size_t initialSize = m_PacketQueue.size();
    for (size_t i = 0; i < initialSize; ++i)
    {
        m_PacketQueue.pop();
    }
    // dispose of the processing thread
    m_KeepRunning.store(false);
    if (m_LocalHandlersThread.joinable())
    {
        // make sure the thread wakes up and sees it has to stop
        m_ConditionPacketReadable.notify_one();
        m_LocalHandlersThread.join();
    }
}

IsOpen()

bool IsOpen ( ) const

overridevirtual

Implements IProfilingConnection.

Definition at line 86 of file FileOnlyProfilingConnection.cpp.

{
    // This type of connection is always open.
    return true;
}

ReadPacket()

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

overridevirtual

Implements IProfilingConnection.

Definition at line 127 of file FileOnlyProfilingConnection.cpp.

{
    std::unique_lock<std::mutex> lck(m_PacketAvailableMutex);

    // Here we are using m_PacketQueue.empty() as a predicate variable
    // The conditional variable will wait until packetQueue is not empty or until a timeout
    if (!m_ConditionPacketAvailable.wait_for(lck,
                                             std::chrono::milliseconds(timeout),
                                             [&]{return !m_PacketQueue.empty();}))
    {
        arm::pipe::Packet empty;
        return empty;
    }

    arm::pipe::Packet returnedPacket = std::move(m_PacketQueue.front());
    m_PacketQueue.pop();
    return returnedPacket;
}

ReturnPacket()

void ReturnPacket ( arm::pipe::Packet &  packet )

overridevirtual

Implements IInternalProfilingConnection.

Definition at line 118 of file FileOnlyProfilingConnection.cpp.

Referenced by StreamMetaDataProcessor::HandlePacket().

{
    {
        std::lock_guard<std::mutex> lck(m_PacketAvailableMutex);
        m_PacketQueue.push(std::move(packet));
    }
    m_ConditionPacketAvailable.notify_one();
}

SetEndianess()

void SetEndianess ( const TargetEndianness &  endianness )

inlineoverridevirtual

Implements IInternalProfilingConnection.

Definition at line 88 of file FileOnlyProfilingConnection.hpp.

Referenced by StreamMetaDataProcessor::HandlePacket().

    {
        m_Endianness = endianness;
    }

WritePacket()

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

overridevirtual

Implements IProfilingConnection.

Definition at line 110 of file FileOnlyProfilingConnection.cpp.

References ARMNN_ASSERT, and armnn::profiling::ReceivePacket().

{
    ARMNN_ASSERT(buffer);
    arm::pipe::Packet packet = ReceivePacket(buffer, length);
    ForwardPacketToHandlers(packet);
    return true;
}

---

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

• src/profiling/FileOnlyProfilingConnection.hpp
• src/profiling/FileOnlyProfilingConnection.cpp