timemory  3.2.1
Modular C++ Toolkit for Performance Analysis and Logging. Profiling API and Tools for C, C++, CUDA, Fortran, and Python. The C++ template API is essentially a framework to creating tools: it is designed to provide a unifying interface for recording various performance measurements alongside data logging and interfaces to other tools.
tim::component::likwid_marker Struct Reference

Provides likwid perfmon marker forwarding. Requires. More...

#include "timemory/components/likwid/components.hpp"

+ Collaboration diagram for tim::component::likwid_marker:

Public Types

using value_type = void
 
using this_type = likwid_marker
 
using base_type = base< this_type, value_type >
 

Public Member Functions

void start ()
 
void stop ()
 
void reset_region ()
 
void register_marker ()
 
likwid_data get () const
 
void set_prefix (const char *_prefix)
 

Static Public Member Functions

static std::string label ()
 
static std::string description ()
 
static value_type record ()
 
static void global_init ()
 
static void thread_init ()
 
static void next ()
 

Detailed Description

Provides likwid perfmon marker forwarding. Requires.

Definition at line 56 of file components.hpp.

Member Typedef Documentation

◆ base_type

◆ this_type

◆ value_type

Definition at line 59 of file components.hpp.

Member Function Documentation

◆ description()

static std::string tim::component::likwid_marker::description ( )
inlinestatic

Definition at line 64 of file components.hpp.

64 { return "LIKWID perfmon (CPU) marker forwarding"; }

◆ get()

likwid_data tim::component::likwid_marker::get ( ) const
inline

Definition at line 118 of file components.hpp.

119  {
120  likwid_data _data{};
121 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
122  likwid_markerGetRegion(m_prefix, &_data.nevents, _data.events.data(), &_data.time,
123  &_data.count);
124  _data.events.resize(_data.nevents);
125 #endif
126  return _data;
127  }

◆ global_init()

static void tim::component::likwid_marker::global_init ( )
inlinestatic

Definition at line 67 of file components.hpp.

68  {
69 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
70  likwid_markerInit();
71 #endif
72  }

◆ label()

static std::string tim::component::likwid_marker::label ( )
inlinestatic

Definition at line 63 of file components.hpp.

63 { return "likwid_marker"; }

◆ next()

static void tim::component::likwid_marker::next ( )
inlinestatic

Definition at line 81 of file components.hpp.

82  {
83 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
84  likwid_markerNextGroup();
85 #endif
86  }

◆ record()

static value_type tim::component::likwid_marker::record ( )
inlinestatic

Definition at line 65 of file components.hpp.

65 {}

◆ register_marker()

void tim::component::likwid_marker::register_marker ( )
inline

Definition at line 111 of file components.hpp.

112  {
113 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
114  likwid_markerRegisterRegion(m_prefix);
115 #endif
116  }

Referenced by set_prefix().

◆ reset_region()

void tim::component::likwid_marker::reset_region ( )
inline

Definition at line 104 of file components.hpp.

105  {
106 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
107  likwid_markerResetRegion(m_prefix);
108 #endif
109  }

◆ set_prefix()

void tim::component::likwid_marker::set_prefix ( const char *  _prefix)
inline

Definition at line 129 of file components.hpp.

130  {
131  m_prefix = _prefix;
132  register_marker();
133  }
char const std::string & _prefix
Definition: definition.hpp:59

References tim::_prefix, and register_marker().

◆ start()

void tim::component::likwid_marker::start ( )
inline

Definition at line 90 of file components.hpp.

91  {
92 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
93  likwid_markerStartRegion(m_prefix);
94 #endif
95  }

◆ stop()

void tim::component::likwid_marker::stop ( )
inline

Definition at line 97 of file components.hpp.

98  {
99 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
100  likwid_markerStopRegion(m_prefix);
101 #endif
102  }

◆ thread_init()

static void tim::component::likwid_marker::thread_init ( )
inlinestatic

Definition at line 74 of file components.hpp.

75  {
76 #if defined(TIMEMORY_USE_LIKWID_PERFMON)
77  likwid_markerThreadInit();
78 #endif
79  }

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