This component is useful for bundling together a fixed set of hardware counter identifiers which require no runtime configuration. More...

#include "timemory/components/papi/papi_tuple.hpp"

Collaboration diagram for tim::component::papi_tuple< EventTypes >:

Public Types
using	size_type = std::size_t

using	value_type = std::array< long long, sizeof...(EventTypes)>

using	entry_type = typename value_type::value_type

using	this_type = papi_tuple< EventTypes... >

using	base_type = base< this_type, value_type >

using	storage_type = typename base_type::storage_type

using	tracker_type = policy::instance_tracker< papi_tuple< EventTypes... > >

using	common_type = this_type

template<typename Tp >
using	array_t = std::array< Tp, num_events >

Public Member Functions
void	sample ()

void	start ()

void	stop ()

this_type &	operator+= (const this_type &rhs)

this_type &	operator-= (const this_type &rhs)

template<typename Archive >
void	serialize (Archive &ar, const unsigned int)

entry_type	get_display (int evt_type) const

string_t	get_display () const

template<typename Tp = double>
auto	get () const

Static Public Member Functions
static void	configure ()

static void	thread_init ()

static void	thread_finalize ()

static void	initialize ()

static void	finalize ()

static value_type	record ()

static std::string	label ()

static std::string	description ()

static std::string	display_unit ()

static int64_t	unit ()

template<typename Lhs , typename Rhs , size_t N, size_t... Idx>
static void	convert (std::array< Lhs, N > &lhs, const std::array< Rhs, N > &rhs, std::index_sequence< Idx... >)

static array_t< std::string >	label_array ()

static array_t< std::string >	description_array ()

static array_t< std::string >	display_unit_array ()

static array_t< int64_t >	unit_array ()

template<typename... Args>
static opaque	get_opaque (Args &&...)

Static Public Attributes
static const size_type	num_events = sizeof...(EventTypes)

static const short	precision = 3

static const short	width = 12

Friends
struct	operation::record< this_type >

struct	operation::start< this_type >

struct	operation::stop< this_type >

struct	operation::set_started< this_type >

struct	operation::set_stopped< this_type >

class	impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

Detailed Description

template<int... EventTypes>
struct tim::component::papi_tuple< EventTypes >

This component is useful for bundling together a fixed set of hardware counter identifiers which require no runtime configuration.

Template Parameters

EventTypes Compile-time constant list of PAPI event identifiers

// the "Instructions" alias below explicitly collects the total instructions,
// the number of load instructions, the number of store instructions
using Instructions = papi_tuple<PAPI_TOT_INS, PAPI_LD_INS, PAPI_SR_INS>;
 
Instructions inst{};
inst.start();
...
inst.stop();
std::vector<double> data = inst.get();

Definition at line 65 of file papi_tuple.hpp.

Member Typedef Documentation

◆ array_t

template<int... EventTypes>

template<typename Tp >

using tim::component::papi_tuple< EventTypes >::array_t = std::array<Tp, num_events>

Definition at line 81 of file papi_tuple.hpp.

◆ base_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::base_type = base<this_type, value_type>

Definition at line 74 of file papi_tuple.hpp.

◆ common_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::common_type = this_type

Definition at line 77 of file papi_tuple.hpp.

◆ entry_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::entry_type = typename value_type::value_type

Definition at line 72 of file papi_tuple.hpp.

◆ size_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::size_type = std::size_t

Definition at line 70 of file papi_tuple.hpp.

◆ storage_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::storage_type = typename base_type::storage_type

Definition at line 75 of file papi_tuple.hpp.

◆ this_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::this_type = papi_tuple<EventTypes...>

Definition at line 73 of file papi_tuple.hpp.

◆ tracker_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::tracker_type = policy::instance_tracker<papi_tuple<EventTypes...> >

Definition at line 76 of file papi_tuple.hpp.

◆ value_type

template<int... EventTypes>

using tim::component::papi_tuple< EventTypes >::value_type = std::array<long long, sizeof...(EventTypes)>

Definition at line 71 of file papi_tuple.hpp.

Member Function Documentation

◆ configure()

template<int... EventTypes>

static void tim::component::papi_tuple< EventTypes >::configure ( )

inlinestatic

Definition at line 92 of file papi_tuple.hpp.

    {
        if(!is_configured<common_type>())
        {
            papi_common::get_initializer<common_type>() = []() {
                return std::vector<int>({ EventTypes... });
            };
            papi_common::get_events<common_type>() = { EventTypes... };
            papi_common::initialize<common_type>();
        }
    }

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::configure(), tim::component::papi_tuple< EventTypes >::initialize(), tim::component::papi_tuple< EventTypes >::sample(), tim::component::papi_tuple< EventTypes >::start(), and tim::component::papi_tuple< EventTypes >::thread_init().

◆ convert()

template<int... EventTypes>

template<typename Lhs , typename Rhs , size_t N, size_t... Idx>

static void tim::component::papi_tuple< EventTypes >::convert	(	std::array< Lhs, N > &	lhs,
		const std::array< Rhs, N > &	rhs,
		std::index_sequence< Idx... >
	)

inlinestatic

Definition at line 294 of file papi_tuple.hpp.

    {
        TIMEMORY_FOLD_EXPRESSION(std::get<Idx>(lhs) =
                                     static_cast<Lhs>(std::get<Idx>(rhs)));
    }

References TIMEMORY_FOLD_EXPRESSION.

Referenced by tim::component::papi_tuple< EventTypes >::get().

◆ description()

template<int... EventTypes>

static std::string tim::component::papi_tuple< EventTypes >::description ( )

inlinestatic

Definition at line 229 of file papi_tuple.hpp.

229{ return ""; }

◆ description_array()

template<int... EventTypes>

static array_t< std::string > tim::component::papi_tuple< EventTypes >::description_array ( )

inlinestatic

Definition at line 323 of file papi_tuple.hpp.

    {
        array_t<std::string> arr;
        for(size_type i = 0; i < num_events; ++i)
            arr[i] = papi::get_event_info(get_events<common_type>().at(i)).long_descr;
        return arr;
    }

References tim::at(), and tim::component::papi_tuple< EventTypes >::num_events.

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::description_array().

◆ display_unit()

template<int... EventTypes>

static std::string tim::component::papi_tuple< EventTypes >::display_unit ( )

inlinestatic

Definition at line 230 of file papi_tuple.hpp.

230{ return ""; }

◆ display_unit_array()

template<int... EventTypes>

static array_t< std::string > tim::component::papi_tuple< EventTypes >::display_unit_array ( )

inlinestatic

Definition at line 334 of file papi_tuple.hpp.

    {
        array_t<std::string> arr;
        for(size_type i = 0; i < num_events; ++i)
            arr[i] = papi::get_event_info(get_events<common_type>().at(i)).units;
        return arr;
    }

References tim::at(), and tim::component::papi_tuple< EventTypes >::num_events.

◆ finalize()

template<int... EventTypes>

static void tim::component::papi_tuple< EventTypes >::finalize ( )

inlinestatic

Definition at line 110 of file papi_tuple.hpp.

110{ papi_common::finalize<common_type>(); }

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::finalize().

◆ get()

template<int... EventTypes>

template<typename Tp = double>

auto tim::component::papi_tuple< EventTypes >::get ( ) const

inline

Definition at line 301 of file papi_tuple.hpp.

    {
        std::array<Tp, num_events> values;
        auto&                      _data = load();
        convert(values, _data, std::make_index_sequence<num_events>{});
        return values;
    }

References tim::component::papi_tuple< EventTypes >::convert(), and tim::component::base< papi_tuple< EventTypes... >, std::array< long long, sizeof...(EventTypes)> >::load().

◆ get_display() [1/2]

template<int... EventTypes>

string_t tim::component::papi_tuple< EventTypes >::get_display ( ) const

inline

Definition at line 255 of file papi_tuple.hpp.

    {
        auto val          = load();
        auto _get_display = [&](std::ostream& os, size_type idx) {
            auto     _obj_value = val[idx];
            auto     _evt_type  = std::vector<int>({ EventTypes... }).at(idx);
            string_t _label     = papi::get_event_info(_evt_type).short_descr;
            string_t _disp      = papi::get_event_info(_evt_type).units;
            auto     _prec      = base_type::get_precision();
            auto     _width     = base_type::get_width();
            auto     _flags     = base_type::get_format_flags();
 
            std::stringstream ss;
            std::stringstream ssv;
            std::stringstream ssi;
            ssv.setf(_flags);
            ssv << std::setw(_width) << std::setprecision(_prec) << _obj_value;
            if(!_disp.empty())
            {
                ssv << " " << _disp;
            }
            else if(!_label.empty())
            {
                ssi << " " << _label;
            }
            ss << ssv.str() << ssi.str();
            os << ss.str();
        };
        std::stringstream ss;
        for(size_type i = 0; i < num_events; ++i)
        {
            _get_display(ss, i);
            if(i + 1 < num_events)
                ss << ", ";
        }
        return ss.str();
    }

References tim::at(), tim::component::base< Tp, Value >::get_format_flags(), tim::component::base< Tp, Value >::get_precision(), tim::component::base< Tp, Value >::get_width(), tim::component::base< papi_tuple< EventTypes... >, std::array< long long, sizeof...(EventTypes)> >::load(), tim::component::papi_tuple< EventTypes >::num_events, and tim::os.

Referenced by tim::component::papi_tuple< EventTypes >::serialize().

◆ get_display() [2/2]

template<int... EventTypes>

entry_type tim::component::papi_tuple< EventTypes >::get_display ( int evt_type ) const

inline

Definition at line 253 of file papi_tuple.hpp.

253{ return accum[evt_type]; }

◆ get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args && ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

◆ initialize()

template<int... EventTypes>

static void tim::component::papi_tuple< EventTypes >::initialize ( )

inlinestatic

Definition at line 109 of file papi_tuple.hpp.

109{ configure(); }

tim::component::papi_tuple::configure

static void configure()

Definition: papi_tuple.hpp:92

References tim::component::papi_tuple< EventTypes >::configure().

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::initialize().

◆ label()

template<int... EventTypes>

static std::string tim::component::papi_tuple< EventTypes >::label ( )

inlinestatic

Definition at line 225 of file papi_tuple.hpp.

    {
        return "papi" + std::to_string(event_set<common_type>());
    }

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::label().

◆ label_array()

template<int... EventTypes>

static array_t< std::string > tim::component::papi_tuple< EventTypes >::label_array ( )

inlinestatic

Definition at line 312 of file papi_tuple.hpp.

    {
        array_t<std::string> arr;
        for(size_type i = 0; i < num_events; ++i)
            arr[i] = papi::get_event_info(get_events<common_type>().at(i)).short_descr;
        return arr;
    }

References tim::at(), and tim::component::papi_tuple< EventTypes >::num_events.

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::display_unit_array(), and tim::component::papi_rate_tuple< RateT, EventTypes >::label_array().

◆ operator+=()

template<int... EventTypes>

this_type & tim::component::papi_tuple< EventTypes >::operator+= ( const this_type & rhs )

inline

Definition at line 197 of file papi_tuple.hpp.

    {
        for(size_type i = 0; i < num_events; ++i)
            accum[i] += rhs.accum[i];
        for(size_type i = 0; i < num_events; ++i)
            value[i] += rhs.value[i];
        return *this;
    }

References tim::component::papi_tuple< EventTypes >::num_events.

◆ operator-=()

template<int... EventTypes>

this_type & tim::component::papi_tuple< EventTypes >::operator-= ( const this_type & rhs )

inline

Definition at line 206 of file papi_tuple.hpp.

    {
        for(size_type i = 0; i < num_events; ++i)
            accum[i] -= rhs.accum[i];
        for(size_type i = 0; i < num_events; ++i)
            value[i] -= rhs.value[i];
        return *this;
    }

References tim::component::papi_tuple< EventTypes >::num_events.

◆ record()

template<int... EventTypes>

static value_type tim::component::papi_tuple< EventTypes >::record ( )

inlinestatic

Definition at line 114 of file papi_tuple.hpp.

    {
        if(is_configured<common_type>())
            tim::papi::read(event_set<common_type>(), get_read_values().data());
        return get_read_values();
    }

References tim::component::papi_common::data().

Referenced by tim::component::papi_tuple< EventTypes >::sample(), tim::component::papi_tuple< EventTypes >::start(), and tim::component::papi_tuple< EventTypes >::stop().

◆ sample()

template<int... EventTypes>

void tim::component::papi_tuple< EventTypes >::sample ( )

inline

Definition at line 157 of file papi_tuple.hpp.

    {
        if(tracker_type::get_thread_started() == 0)
            configure();
        if(events.empty())
            events = get_events<common_type>();
 
        tracker_type::start();
        value = record();
    }

References tim::component::papi_tuple< EventTypes >::configure(), tim::component::papi_common::events, tim::component::papi_tuple< EventTypes >::record(), and tim::invoke::start().

◆ serialize()

template<int... EventTypes>

template<typename Archive >

void tim::component::papi_tuple< EventTypes >::serialize	(	Archive &	ar,
		const unsigned int
	)

inline

Definition at line 237 of file papi_tuple.hpp.

    {
        array_t<double> _disp;
        array_t<double> _value;
        array_t<double> _accum;
        for(size_type i = 0; i < num_events; ++i)
        {
            _disp[i]  = get_display(i);
            _value[i] = value[i];
            _accum[i] = accum[i];
        }
        ar(cereal::make_nvp("laps", laps), cereal::make_nvp("repr_data", _disp),
           cereal::make_nvp("value", _value), cereal::make_nvp("accum", _accum),
           cereal::make_nvp("display", _disp));
    }

References tim::component::papi_tuple< EventTypes >::get_display(), tim::component::base< papi_tuple< EventTypes... >, std::array< long long, sizeof...(EventTypes)> >::laps, and tim::component::papi_tuple< EventTypes >::num_events.

◆ start()

template<int... EventTypes>

void tim::component::papi_tuple< EventTypes >::start ( )

inline

Definition at line 171 of file papi_tuple.hpp.

    {
        if(tracker_type::get_thread_started() == 0 || events.size() == 0)
        {
            configure();
            events = get_events<common_type>();
        }
 
        tracker_type::start();
        value = record();
    }

References tim::component::papi_tuple< EventTypes >::configure(), tim::component::papi_common::events, tim::component::papi_tuple< EventTypes >::record(), and tim::invoke::start().

◆ stop()

template<int... EventTypes>

void tim::component::papi_tuple< EventTypes >::stop ( )

inline

Definition at line 186 of file papi_tuple.hpp.

    {
        tracker_type::stop();
        using namespace tim::component::operators;
        value = (record() - value);
        accum += value;
    }

References tim::component::papi_tuple< EventTypes >::record(), and tim::invoke::stop().

◆ thread_finalize()

template<int... EventTypes>

static void tim::component::papi_tuple< EventTypes >::thread_finalize ( )

inlinestatic

Definition at line 104 of file papi_tuple.hpp.

    {
        papi_common::finalize<common_type>();
        papi_common::finalize_papi();
    }

References tim::component::papi_common::finalize_papi().

◆ thread_init()

template<int... EventTypes>

static void tim::component::papi_tuple< EventTypes >::thread_init ( )

inlinestatic

Definition at line 103 of file papi_tuple.hpp.

103{ this_type::configure(); }

References tim::component::papi_tuple< EventTypes >::configure().

◆ unit()

template<int... EventTypes>

static int64_t tim::component::papi_tuple< EventTypes >::unit ( )

inlinestatic

Definition at line 231 of file papi_tuple.hpp.

231{ return 1; }

◆ unit_array()

template<int... EventTypes>

static array_t< int64_t > tim::component::papi_tuple< EventTypes >::unit_array ( )

inlinestatic

Definition at line 345 of file papi_tuple.hpp.

    {
        array_t<int64_t> arr;
        for(size_type i = 0; i < num_events; ++i)
            arr[i] = 1;
        return arr;
    }

References tim::component::papi_tuple< EventTypes >::num_events.

Referenced by tim::component::papi_rate_tuple< RateT, EventTypes >::unit_array().

Friends And Related Function Documentation

◆ impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

template<int... EventTypes>

friend class impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

friend

Definition at line 122 of file papi_tuple.hpp.

◆ operation::record< this_type >

template<int... EventTypes>

friend struct operation::record< this_type >

friend

Definition at line 79 of file papi_tuple.hpp.

◆ operation::set_started< this_type >

template<int... EventTypes>

friend struct operation::set_started< this_type >

friend

Definition at line 79 of file papi_tuple.hpp.

◆ operation::set_stopped< this_type >

template<int... EventTypes>

friend struct operation::set_stopped< this_type >

friend

Definition at line 79 of file papi_tuple.hpp.

◆ operation::start< this_type >

template<int... EventTypes>

friend struct operation::start< this_type >

friend

Definition at line 79 of file papi_tuple.hpp.

◆ operation::stop< this_type >

template<int... EventTypes>

friend struct operation::stop< this_type >

friend

Definition at line 79 of file papi_tuple.hpp.

Member Data Documentation

◆ num_events

template<int... EventTypes>

const size_type tim::component::papi_tuple< EventTypes >::num_events = sizeof...(EventTypes)

static

Definition at line 79 of file papi_tuple.hpp.

Referenced by tim::component::papi_tuple< EventTypes >::description_array(), tim::component::papi_tuple< EventTypes >::display_unit_array(), tim::component::papi_tuple< EventTypes >::get_display(), tim::component::papi_tuple< EventTypes >::label_array(), tim::component::papi_tuple< EventTypes >::operator+=(), tim::component::papi_tuple< EventTypes >::operator-=(), tim::component::papi_tuple< EventTypes >::serialize(), and tim::component::papi_tuple< EventTypes >::unit_array().

◆ precision

template<int... EventTypes>

const short tim::component::papi_tuple< EventTypes >::precision = 3

static

Definition at line 221 of file papi_tuple.hpp.

◆ width

template<int... EventTypes>

const short tim::component::papi_tuple< EventTypes >::width = 12

static

Definition at line 222 of file papi_tuple.hpp.

The documentation for this struct was generated from the following file:

timemory/components/papi/papi_tuple.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ array_t

◆ base_type

◆ common_type

◆ entry_type

◆ size_type

◆ storage_type

◆ this_type

◆ tracker_type

◆ value_type

Member Function Documentation

◆ configure()

◆ convert()

◆ description()

◆ description_array()

◆ display_unit()

◆ display_unit_array()

◆ finalize()

◆ get()

◆ get_display() [1/2]

◆ get_display() [2/2]

◆ get_opaque()

◆ initialize()

◆ label()

◆ label_array()

◆ operator+=()

◆ operator-=()

◆ record()

◆ sample()

◆ serialize()

◆ start()

◆ stop()

◆ thread_finalize()

◆ thread_init()

◆ unit()

◆ unit_array()

Friends And Related Function Documentation

◆ impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

◆ operation::record< this_type >

◆ operation::set_started< this_type >

◆ operation::set_stopped< this_type >

◆ operation::start< this_type >

◆ operation::stop< this_type >

Member Data Documentation

◆ num_events

◆ precision

◆ width