tim::component::gperftools_heap_profiler Struct Reference

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

Collaboration diagram for tim::component::gperftools_heap_profiler:

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

Public Member Functions
void	start ()
void	stop ()
void	set_prefix (const std::string &_prefix)
void	get () const

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

Protected Attributes
std::string	prefix
int32_t	index = -1

Detailed Description

Definition at line 124 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 128 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_heap_profiler::this_type = gperftools_heap_profiler

Definition at line 127 of file components.hpp.

value_type

using tim::component::gperftools_heap_profiler::value_type = void

Definition at line 126 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 131 of file components.hpp.

    {
        return "Control switch for the gperftools heap 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_heap_profiler::global_finalize ( )

inlinestatic

Definition at line 137 of file components.hpp.

    {
        if(gperftools::heap::is_running())
        {
            gperftools::heap::profiler_flush("global_finalize");
            gperftools::heap::profiler_stop();
        }
    }

label()

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

inlinestatic

Definition at line 130 of file components.hpp.

{ return "gperftools_heap_profiler"; }

Referenced by start().

record()

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

inlinestatic

Definition at line 135 of file components.hpp.

{}

set_prefix()

void tim::component::gperftools_heap_profiler::set_prefix ( const std::string &  _prefix )

inline

Definition at line 170 of file components.hpp.

{ prefix = _prefix; }

References tim::_prefix, and prefix.

start()

void tim::component::gperftools_heap_profiler::start ( )

inline

Definition at line 146 of file components.hpp.

    {
        if(!gperftools::heap::is_running())
        {
            index      = this_type::get_index()++;
            auto fname = settings::compose_output_filename(label(), ".dat");
            auto ret   = gperftools::heap::profiler_start(fname);
            if(ret > 0)
            {
                fprintf(stderr, "[gperftools_heap_profiler]> Error starting %s...",
                        prefix.c_str());
            }
        }
    }

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

stop()

void tim::component::gperftools_heap_profiler::stop ( )

inline

Definition at line 161 of file components.hpp.

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

References index, and prefix.

Member Data Documentation

index

int32_t tim::component::gperftools_heap_profiler::index = -1

protected

Definition at line 174 of file components.hpp.

Referenced by start(), and stop().

prefix

std::string tim::component::gperftools_heap_profiler::prefix

protected

Definition at line 173 of file components.hpp.

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

---

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

• timemory/components/gperftools/components.hpp