tim::component::memory_allocations Struct Reference

This component wraps malloc, calloc, free, CUDA/HIP malloc/free via GOTCHA and tracks the number of bytes requested/freed in each call. This component is useful for detecting the locations where memory re-use would provide a performance benefit. More...

#include "timemory/components/gotcha/memory_allocations.hpp"

Collaboration diagram for tim::component::memory_allocations:

Public Types
using	value_type = void
using	this_type = memory_allocations
using	base_type = base< this_type, value_type >
using	tracker_type = policy::instance_tracker< memory_allocations, true >
using	malloc_gotcha_t = typename malloc_gotcha::gotcha_type< component_tuple_t<> >
using	malloc_bundle_t = component_tuple_t< malloc_gotcha_t >
using	data_pointer_t = std::unique_ptr< malloc_bundle_t >
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 void	global_init ()
static void	global_finalize ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

This component wraps malloc, calloc, free, CUDA/HIP malloc/free via GOTCHA and tracks the number of bytes requested/freed in each call. This component is useful for detecting the locations where memory re-use would provide a performance benefit.

Definition at line 347 of file memory_allocations.hpp.

Member Typedef Documentation

base_type

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

Definition at line 354 of file memory_allocations.hpp.

data_pointer_t

using tim::component::memory_allocations::data_pointer_t = std::unique_ptr<malloc_bundle_t>

Definition at line 359 of file memory_allocations.hpp.

malloc_bundle_t

using tim::component::memory_allocations::malloc_bundle_t = component_tuple_t<malloc_gotcha_t>

Definition at line 358 of file memory_allocations.hpp.

malloc_gotcha_t

using tim::component::memory_allocations::malloc_gotcha_t = typename malloc_gotcha::gotcha_type<component_tuple_t<> >

Definition at line 357 of file memory_allocations.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::memory_allocations::this_type = memory_allocations

Definition at line 353 of file memory_allocations.hpp.

tracker_type

using tim::component::memory_allocations::tracker_type = policy::instance_tracker<memory_allocations, true>

Definition at line 355 of file memory_allocations.hpp.

value_type

using tim::component::memory_allocations::value_type = void

Definition at line 352 of file memory_allocations.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 362 of file memory_allocations.hpp.

    {
        return "Number of bytes allocated/freed instead of peak/current memory usage: "
               "free(malloc(10)) + free(malloc(10)) would use 10 bytes but this would "
               "report 20 bytes";
    }

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::memory_allocations::global_finalize ( )

inlinestatic

Definition at line 370 of file memory_allocations.hpp.

{ malloc_gotcha::tear_down<component_tuple_t<>>(); }

global_init()

static void tim::component::memory_allocations::global_init ( )

inlinestatic

Definition at line 369 of file memory_allocations.hpp.

{ malloc_gotcha::configure<component_tuple_t<>>(); }

label()

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

inlinestatic

Definition at line 361 of file memory_allocations.hpp.

{ return "memory_allocations"; }

start()

void tim::component::memory_allocations::start ( )

inline

Definition at line 372 of file memory_allocations.hpp.

    {
        auto _cnt = tracker_type::start();
        if(_cnt.first == 0 && _cnt.second == 0 && !get_data())
        {
            get_data() = std::make_unique<malloc_bundle_t>();
            get_data()->start();
        }
    }

References tim::invoke::start().

stop()

void tim::component::memory_allocations::stop ( )

inline

Definition at line 382 of file memory_allocations.hpp.

    {
        auto _cnt = tracker_type::stop();
        if(_cnt.first == 0 && _cnt.second == 0 && get_data())
        {
            get_data()->stop();
            get_data().reset(nullptr);
        }
    }

References tim::invoke::stop().

---

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

• timemory/components/gotcha/memory_allocations.hpp