tim::component::gperftools_cpu_profiler Struct Reference

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

Collaboration diagram for tim::component::gperftools_cpu_profiler:

Public Types
using	value_type = void
using	this_type = gperftools_cpu_profiler
using	base_type = base< this_type, value_type >
using	storage_type = empty_storage

Public Member Functions
void	start ()
void	stop ()
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
static void	thread_init ()
static void	global_finalize ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

Definition at line 50 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 54 of file components.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

this_type

using tim::component::gperftools_cpu_profiler::this_type = gperftools_cpu_profiler

Definition at line 53 of file components.hpp.

value_type

using tim::component::gperftools_cpu_profiler::value_type = void

Definition at line 52 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 57 of file components.hpp.

    {
        return "Control switch for gperftools CPU profiler";
    }

get()

void tim::component::empty_base::get ( ) const

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

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{};
    }

global_finalize()

static void tim::component::gperftools_cpu_profiler::global_finalize ( )

inlinestatic

Definition at line 65 of file components.hpp.

    {
        if(gperftools::cpu::is_running())
        {
            gperftools::cpu::profiler_flush();
            gperftools::cpu::profiler_stop();
        }
    }

label()

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

inlinestatic

Definition at line 56 of file components.hpp.

{ return "gperftools_cpu_profiler"; }

Referenced by start().

record()

static value_type tim::component::gperftools_cpu_profiler::record ( )

inlinestatic

Definition at line 61 of file components.hpp.

{}

start()

void tim::component::gperftools_cpu_profiler::start ( )

inline

Definition at line 74 of file components.hpp.

    {
        if(!gperftools::cpu::is_running())
        {
            index                 = this_type::get_index()++;
            const auto& _dmp_info = get_dmp_info();
            bool        _dmp_init = std::get<0>(_dmp_info);
            int32_t     _dmp_rank = std::get<1>(_dmp_info);
            auto        fname     = settings::compose_output_filename(
                label() + "_" + std::to_string(index), ".dat", _dmp_init, _dmp_rank);
            auto ret = gperftools::cpu::profiler_start(fname);
            if(ret == 0)
            {
                fprintf(stderr, "[gperftools_cpu_profiler]> Error starting %s...",
                        fname.c_str());
            }
        }
    }

References tim::settings::compose_output_filename(), and label().

stop()

void tim::component::gperftools_cpu_profiler::stop ( )

inline

Definition at line 93 of file components.hpp.

    {
        if(index >= 0)
        {
            gperftools::cpu::profiler_flush();
            gperftools::cpu::profiler_stop();
        }
    }

thread_init()

static void tim::component::gperftools_cpu_profiler::thread_init ( )

inlinestatic

Definition at line 63 of file components.hpp.

{ gperftools::cpu::register_thread(); }

---

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

• timemory/components/gperftools/components.hpp