tim::component::papi_vector Struct Reference

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

Collaboration diagram for tim::component::papi_vector:

Public Types
template<typename Tp >
using	vector_t = std::vector< Tp >
using	size_type = size_t
using	event_list = vector_t< int >
using	value_type = vector_t< long long >
using	entry_type = typename value_type::value_type
using	this_type = papi_vector
using	base_type = base< this_type, value_type >
using	storage_type = typename base_type::storage_type
using	get_initializer_t = std::function< event_list()>
using	tracker_type = policy::instance_tracker< this_type >
using	common_type = void

Public Member Functions
	papi_vector ()
	~papi_vector ()=default
	papi_vector (const papi_vector &)=default
	papi_vector (papi_vector &&) noexcept=default
papi_vector &	operator= (const papi_vector &)=default
papi_vector &	operator= (papi_vector &&) noexcept=default
size_t	size ()
value_type	record ()
template<typename Tp = double>
vector_t< Tp >	get () const
void	sample ()
void	start ()
void	stop ()
this_type &	operator+= (const this_type &rhs)
this_type &	operator-= (const this_type &rhs)
entry_type	get_display (int evt_type) const
template<typename Archive >
void	load (Archive &ar, const unsigned int)
template<typename Archive >
void	save (Archive &ar, const unsigned int) const
vector_t< std::string >	label_array () const
vector_t< std::string >	description_array () const
vector_t< std::string >	display_unit_array () const
vector_t< int64_t >	unit_array () const
string_t	get_display () const

Static Public Member Functions
static auto &	get_initializer ()
static void	configure ()
static void	initialize ()
static void	thread_finalize ()
static void	finalize ()
static std::string	label ()
static std::string	description ()

Static Public Attributes
static const short	precision = 3
static const short	width = 8

Protected Attributes
event_list	events

Friends
template<typename... T>
struct	cpu_roofline
template<typename... T>
struct	gpu_roofline
std::ostream &	operator<< (std::ostream &os, const this_type &obj)

Detailed Description

Definition at line 52 of file papi_vector.hpp.

Member Typedef Documentation

base_type

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

Definition at line 65 of file papi_vector.hpp.

common_type

using tim::component::papi_vector::common_type = void

Definition at line 69 of file papi_vector.hpp.

entry_type

using tim::component::papi_vector::entry_type = typename value_type::value_type

Definition at line 63 of file papi_vector.hpp.

event_list

using tim::component::papi_vector::event_list = vector_t<int>

Definition at line 61 of file papi_vector.hpp.

get_initializer_t

using tim::component::papi_vector::get_initializer_t = std::function<event_list()>

Definition at line 67 of file papi_vector.hpp.

size_type

using tim::component::papi_vector::size_type = size_t

Definition at line 60 of file papi_vector.hpp.

storage_type

using tim::component::papi_vector::storage_type = typename base_type::storage_type

Definition at line 66 of file papi_vector.hpp.

this_type

using tim::component::papi_vector::this_type = papi_vector

Definition at line 64 of file papi_vector.hpp.

tracker_type

using tim::component::papi_vector::tracker_type = policy::instance_tracker<this_type>

Definition at line 68 of file papi_vector.hpp.

value_type

using tim::component::papi_vector::value_type = vector_t<long long>

Definition at line 62 of file papi_vector.hpp.

vector_t

template<typename Tp >

using tim::component::papi_vector::vector_t = std::vector<Tp>

Definition at line 58 of file papi_vector.hpp.

Constructor & Destructor Documentation

papi_vector() [1/3]

tim::component::papi_vector::papi_vector ( )

inline

Definition at line 100 of file papi_vector.hpp.

    {
        events = get_events<common_type>();
        value.resize(events.size(), 0);
        accum.resize(events.size(), 0);
    }

References events.

~papi_vector()

tim::component::papi_vector::~papi_vector ( )

default

papi_vector() [2/3]

tim::component::papi_vector::papi_vector ( const papi_vector &  )

default

papi_vector() [3/3]

tim::component::papi_vector::papi_vector ( papi_vector &&  )

defaultnoexcept

Member Function Documentation

configure()

static void tim::component::papi_vector::configure ( )

inlinestatic

Definition at line 85 of file papi_vector.hpp.

    {
        if(!is_configured<common_type>())
            papi_common::initialize<common_type>();
    }

Referenced by tim::component::cpu_roofline< Types >::configure(), initialize(), sample(), and start().

description()

static std::string tim::component::papi_vector::description ( )

inlinestatic

Definition at line 221 of file papi_vector.hpp.

    {
        return "Dynamically allocated array of PAPI HW counters";
    }

description_array()

vector_t<std::string> tim::component::papi_vector::description_array ( ) const

inline

Definition at line 297 of file papi_vector.hpp.

    {
        vector_t<std::string> arr(events.size(), "");
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).long_descr;
        return arr;
    }

References events.

display_unit_array()

vector_t<std::string> tim::component::papi_vector::display_unit_array ( ) const

inline

Definition at line 308 of file papi_vector.hpp.

    {
        vector_t<std::string> arr(events.size(), "");
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).units;
        return arr;
    }

References events.

finalize()

static void tim::component::papi_vector::finalize ( )

inlinestatic

Definition at line 96 of file papi_vector.hpp.

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

get()

template<typename Tp = double>

vector_t<Tp> tim::component::papi_vector::get ( ) const

inline

Definition at line 132 of file papi_vector.hpp.

    {
        std::vector<Tp> values;
        const auto&     _data = load();
        for(const auto& itr : _data)
            values.push_back(itr);
        values.resize(events.size());
        return values;
    }

References events, and tim::component::base< papi_vector, std::vector< long long > >::load().

get_display() [1/2]

string_t tim::component::papi_vector::get_display ( ) const

inline

Definition at line 329 of file papi_vector.hpp.

    {
        if(events.empty())
            return "";
        auto val          = load();
        auto _get_display = [&](std::ostream& os, size_type idx) {
            auto     _obj_value = val.at(idx);
            auto     _evt_type  = events.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;
            if(!_label.empty())
                ssi << " " << _label;
            ss << ssv.str() << ssi.str();
            os << ss.str();
        };
 
        std::stringstream ss;
        for(size_type i = 0; i < events.size(); ++i)
        {
            _get_display(ss, i);
            if(i + 1 < events.size())
                ss << ", ";
        }
        return ss.str();
    }

References events, tim::component::base< Tp, Value >::get_format_flags(), tim::component::base< Tp, Value >::get_precision(), tim::component::base< Tp, Value >::get_width(), and tim::component::base< papi_vector, std::vector< long long > >::load().

Referenced by save().

get_display() [2/2]

entry_type tim::component::papi_vector::get_display ( int  evt_type ) const

inline

Definition at line 226 of file papi_vector.hpp.

    {
        return accum.at(evt_type);
    }

get_initializer()

static auto& tim::component::papi_vector::get_initializer ( )

inlinestatic

Definition at line 84 of file papi_vector.hpp.

{ return papi_common::get_initializer<common_type>(); }

initialize()

static void tim::component::papi_vector::initialize ( )

inlinestatic

Definition at line 90 of file papi_vector.hpp.

{ configure(); }

References configure().

label()

static std::string tim::component::papi_vector::label ( )

inlinestatic

Definition at line 214 of file papi_vector.hpp.

    {
        return "papi_vector" + std::to_string((event_set<common_type>() < 0)
                                                  ? 0
                                                  : event_set<common_type>());
    }

label_array()

vector_t<std::string> tim::component::papi_vector::label_array ( ) const

inline

Definition at line 261 of file papi_vector.hpp.

    {
        vector_t<std::string> arr(events.size(), "");
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).short_descr;
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find("L/S")) != std::string::npos)
                itr.replace(n, 3, "Loads_Stores");
        }
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find('/')) != std::string::npos)
                itr.replace(n, 1, "_per_");
        }
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find(' ')) != std::string::npos)
                itr.replace(n, 1, "_");
 
            while((n = itr.find("__")) != std::string::npos)
                itr.replace(n, 2, "_");
        }
 
        return arr;
    }

References events.

load()

template<typename Archive >

void tim::component::papi_vector::load ( Archive &  ar, const unsigned int    )

inline

Definition at line 235 of file papi_vector.hpp.

    {
        ar(cereal::make_nvp("laps", laps), cereal::make_nvp("value", value),
           cereal::make_nvp("accum", accum), cereal::make_nvp("events", events));
    }

References events, and tim::component::base< papi_vector, std::vector< long long > >::laps.

operator+=()

this_type& tim::component::papi_vector::operator+= ( const this_type &  rhs )

inline

Definition at line 185 of file papi_vector.hpp.

    {
        value += rhs.value;
        accum += rhs.accum;
        return *this;
    }

operator-=()

this_type& tim::component::papi_vector::operator-= ( const this_type &  rhs )

inline

Definition at line 194 of file papi_vector.hpp.

    {
        value -= rhs.value;
        accum -= rhs.accum;
        return *this;
    }

operator=() [1/2]

papi_vector& tim::component::papi_vector::operator= ( const papi_vector &  )

default

operator=() [2/2]

papi_vector& tim::component::papi_vector::operator= ( papi_vector &&  )

defaultnoexcept

record()

value_type tim::component::papi_vector::record ( )

inline

Definition at line 121 of file papi_vector.hpp.

    {
        value_type read_value(events.size(), 0);
        if(is_configured<common_type>())
            papi::read(event_set<common_type>(), read_value.data());
        return read_value;
    }

References events.

Referenced by sample(), start(), and stop().

sample()

void tim::component::papi_vector::sample ( )

inline

Definition at line 145 of file papi_vector.hpp.

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

References configure(), events, record(), and tim::invoke::start().

save()

template<typename Archive >

void tim::component::papi_vector::save ( Archive &  ar, const unsigned int    ) const

inline

Definition at line 245 of file papi_vector.hpp.

    {
        auto             sz = events.size();
        vector_t<double> _disp(sz, 0.0);
        for(size_type i = 0; i < sz; ++i)
        {
            _disp[i] = get_display(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), cereal::make_nvp("events", events));
    }

References events, get_display(), and tim::component::base< papi_vector, std::vector< long long > >::laps.

size()

size_t tim::component::papi_vector::size ( )

inline

Definition at line 117 of file papi_vector.hpp.

{ return events.size(); }

References events.

start()

void tim::component::papi_vector::start ( )

inline

Definition at line 159 of file papi_vector.hpp.

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

References configure(), events, record(), and tim::invoke::start().

stop()

void tim::component::papi_vector::stop ( )

inline

Definition at line 175 of file papi_vector.hpp.

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

References record(), and tim::invoke::stop().

thread_finalize()

static void tim::component::papi_vector::thread_finalize ( )

inlinestatic

Definition at line 91 of file papi_vector.hpp.

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

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

unit_array()

vector_t<int64_t> tim::component::papi_vector::unit_array ( ) const

inline

Definition at line 319 of file papi_vector.hpp.

    {
        vector_t<int64_t> arr(events.size(), 0);
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = 1;
        return arr;
    }

References events.

Friends And Related Function Documentation

cpu_roofline

template<typename... T>

friend struct cpu_roofline

friend

Definition at line 77 of file papi_vector.hpp.

gpu_roofline

template<typename... T>

friend struct gpu_roofline

friend

Definition at line 80 of file papi_vector.hpp.

operator<<

std::ostream& operator<< ( std::ostream &  os, const this_type &  obj  )

friend

Definition at line 368 of file papi_vector.hpp.

    {
        if(obj.events.empty())
            return os;
        // output the metrics
        auto _value = obj.get_display();
        auto _label = this_type::get_label();
        auto _disp  = this_type::display_unit();
        auto _prec  = this_type::get_precision();
        auto _width = this_type::get_width();
        auto _flags = this_type::get_format_flags();
 
        std::stringstream ss_value;
        std::stringstream ss_extra;
        ss_value.setf(_flags);
        ss_value << std::setw(_width) << std::setprecision(_prec) << _value;
        if(!_disp.empty())
        {
            ss_extra << " " << _disp;
        }
        else if(!_label.empty())
        {
            ss_extra << " " << _label;
        }
        os << ss_value.str() << ss_extra.str();
        return os;
    }

Member Data Documentation

events

event_list tim::component::papi_common::events

protected

Definition at line 352 of file papi_common.hpp.

Referenced by papi_vector(), description_array(), display_unit_array(), get(), get_display(), label_array(), load(), record(), sample(), save(), size(), start(), and unit_array().

precision

const short tim::component::papi_vector::precision = 3

static

Definition at line 73 of file papi_vector.hpp.

width

const short tim::component::papi_vector::width = 8

static

Definition at line 74 of file papi_vector.hpp.

---

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

• timemory/components/papi/papi_vector.hpp