PMUCounter Class Reference

Implementation of an instrument to count CPU cycles. More...

#include <PMUCounter.h>

Collaboration diagram for PMUCounter:

Public Member Functions
	PMUCounter (ScaleFactor scale_factor)
	Construct a PMU counter. More...
std::string	id () const override
	Identifier for the instrument. More...
void	start () override
	Start measuring. More...
void	stop () override
	Stop measuring. More...
MeasurementsMap	measurements () const override
	Return the latest measurements. More...
Public Member Functions inherited from Instrument
	Instrument ()=default
	Default constructor. More...
	Instrument (const Instrument &)=default
	Allow instances of this class to be copy constructed. More...
	Instrument (Instrument &&)=default
	Allow instances of this class to be move constructed. More...
Instrument &	operator= (const Instrument &)=default
	Allow instances of this class to be copied. More...
Instrument &	operator= (Instrument &&)=default
	Allow instances of this class to be moved. More...
virtual	~Instrument ()=default
	Default destructor. More...
virtual void	test_start ()
	Start of the test. More...
virtual void	test_stop ()
	End of the test. More...
virtual std::string	instrument_header () const
	Return JSON formatted instrument header string. More...
virtual MeasurementsMap	test_measurements () const
	Return the latest test measurements. More...

Additional Inherited Members
Public Types inherited from Instrument
using	MeasurementsMap = std::map< std::string, Measurement >
	Map of measurements. More...
Static Public Member Functions inherited from Instrument
template<typename T , ScaleFactor scale>
static std::unique_ptr< Instrument >	make_instrument ()
	Helper function to create an instrument of the given type. More...

Detailed Description

Implementation of an instrument to count CPU cycles.

Definition at line 37 of file PMUCounter.h.

Constructor & Destructor Documentation

PMUCounter()

PMUCounter ( ScaleFactor  scale_factor )

inline

Construct a PMU counter.

Parameters

[in]

scale_factor

Measurement scale factor.

Definition at line 44 of file PMUCounter.h.

    {
        switch(scale_factor)
        {
            case ScaleFactor::NONE:
                _scale_factor = 1;
                _unit         = "";
                break;
            case ScaleFactor::SCALE_1K:
                _scale_factor = 1000;
                _unit         = "K ";
                break;
            case ScaleFactor::SCALE_1M:
                _scale_factor = 1000000;
                _unit         = "M ";
                break;
            default:
                ARM_COMPUTE_ERROR("Invalid scale");
        }
    };

References ARM_COMPUTE_ERROR, arm_compute::test::framework::NONE, arm_compute::test::framework::SCALE_1K, and arm_compute::test::framework::SCALE_1M.

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Identifier for the instrument.

Implements Instrument.

Definition at line 32 of file PMUCounter.cpp.

{
    return "PMU Counter";
}

measurements()

Instrument::MeasurementsMap measurements ( ) const

overridevirtual

Return the latest measurements.

Returns

the latest measurements.

Reimplemented from Instrument.

Definition at line 64 of file PMUCounter.cpp.

{
    return MeasurementsMap
    {
        { "CPU cycles", Measurement(_cycles / _scale_factor, _unit + "cycles") },
        { "CPU instructions", Measurement(_instructions / _scale_factor, _unit + "instructions") },
    };
}

start()

void start ( )

overridevirtual

Start measuring.

Called just before the run of the test starts

Reimplemented from Instrument.

Definition at line 37 of file PMUCounter.cpp.

{
    _pmu_cycles.reset();
    _pmu_instructions.reset();
}

References PMU::reset().

stop()

void stop ( )

overridevirtual

Stop measuring.

Called just after the run of the test ends

Reimplemented from Instrument.

Definition at line 43 of file PMUCounter.cpp.

{
    try
    {
        _cycles = _pmu_cycles.get_value<long long>();
    }
    catch(const std::runtime_error &)
    {
        _cycles = 0;
    }
 
    try
    {
        _instructions = _pmu_instructions.get_value<long long>();
    }
    catch(const std::runtime_error &)
    {
        _instructions = 0;
    }
}

References PMU::get_value().

---

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

• tests/framework/instruments/PMUCounter.h
• tests/framework/instruments/PMUCounter.cpp