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

Collaboration diagram for tim::component::malloc_gotcha:

Public Types
using	value_type = double

using	this_type = malloc_gotcha

using	base_type = base< this_type, value_type >

using	storage_type = typename base_type::storage_type

using	string_hash = std::hash< std::string >

template<typename Tp >
using	gotcha_component_type = push_back_t< Tp, this_type >

template<typename Tp >
using	gotcha_type = gotcha< data_size, push_back_t< Tp, this_type >, type_list< this_type > >

template<typename Tp >
using	component_type = push_back_t< Tp, gotcha_type< Tp > >

Public Member Functions
void	start ()

void	stop ()

double	get () const

double	get_display () const

void	set_prefix ()

void	audit (audit::incoming, size_t nbytes)
	nbytes is passed to malloc More...

void	audit (audit::incoming, size_t nmemb, size_t size)
	nmemb and size is passed to calloc More...

void	audit (audit::outgoing, void *ptr)
	void* is returned from malloc and calloc More...

void	audit (audit::incoming, void *ptr)
	void* is passed to free More...

void	set_prefix (const char *_prefix)

this_type &	operator+= (const this_type &rhs)

this_type &	operator-= (const this_type &rhs)

Static Public Member Functions
static std::string	label ()

static std::string	description ()

static void	global_finalize ()

template<typename Tp >
static void	configure ()

template<typename Tp >
static void	tear_down ()

template<typename... Args>
static opaque	get_opaque (Args &&...)

Static Public Attributes
static constexpr size_t	data_size = 3

Detailed Description

Definition at line 53 of file memory_allocations.hpp.

Member Typedef Documentation

◆ base_type

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

Definition at line 65 of file memory_allocations.hpp.

◆ component_type

template<typename Tp >

using tim::component::malloc_gotcha::component_type = push_back_t<Tp, gotcha_type<Tp> >

Definition at line 99 of file memory_allocations.hpp.

◆ gotcha_component_type

template<typename Tp >

using tim::component::malloc_gotcha::gotcha_component_type = push_back_t<Tp, this_type>

Definition at line 92 of file memory_allocations.hpp.

◆ gotcha_type

template<typename Tp >

using tim::component::malloc_gotcha::gotcha_type = gotcha<data_size, push_back_t<Tp, this_type>, type_list<this_type> >

Definition at line 95 of file memory_allocations.hpp.

◆ storage_type

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

Definition at line 66 of file memory_allocations.hpp.

◆ string_hash

using tim::component::malloc_gotcha::string_hash = std::hash<std::string>

Definition at line 67 of file memory_allocations.hpp.

◆ this_type

using tim::component::malloc_gotcha::this_type = malloc_gotcha

Definition at line 64 of file memory_allocations.hpp.

◆ value_type

using tim::component::malloc_gotcha::value_type = double

Definition at line 63 of file memory_allocations.hpp.

Member Function Documentation

◆ audit() [1/4]

void tim::component::malloc_gotcha::audit	(	audit::incoming	,
		size_t	nbytes
	)

inline

nbytes is passed to malloc

Definition at line 134 of file memory_allocations.hpp.

    {
        DEBUG_PRINT_HERE("%s(%i)", m_prefix, (int) nbytes);
        // malloc
        value = (nbytes);
        DEBUG_PRINT_HERE("value: %12.8f, accum: %12.8f", value, accum);
    }

References DEBUG_PRINT_HERE.

◆ audit() [2/4]

void tim::component::malloc_gotcha::audit	(	audit::incoming	,
		size_t	nmemb,
		size_t	size
	)

inline

nmemb and size is passed to calloc

Definition at line 143 of file memory_allocations.hpp.

    {
        DEBUG_PRINT_HERE("%s(%i, %i)", m_prefix, (int) nmemb, (int) size);
        // calloc
        value = (nmemb * size);
        DEBUG_PRINT_HERE("value: %12.8f, accum: %12.8f", value, accum);
    }

References DEBUG_PRINT_HERE.

◆ audit() [3/4]

void tim::component::malloc_gotcha::audit	(	audit::incoming	,
		void *	ptr
	)

inline

void* is passed to free

Definition at line 163 of file memory_allocations.hpp.

    {
        DEBUG_PRINT_HERE("%s(%p)", m_prefix, ptr);
        auto itr = get_allocation_map().find(ptr);
        if(itr != get_allocation_map().end())
        {
            value = itr->second;
            DEBUG_PRINT_HERE("value: %12.8f, accum: %12.8f", value, accum);
            get_allocation_map().erase(itr);
        }
        else
        {
            if(settings::verbose() > 1 || settings::debug())
            {
                printf("[%s]> free of unknown pointer size: %p\n",
                       this_type::get_label().c_str(), ptr);
            }
        }
    }

References tim::debug, DEBUG_PRINT_HERE, tim::component::base< malloc_gotcha, double >::get_label(), and tim::verbose.

◆ audit() [4/4]

void tim::component::malloc_gotcha::audit	(	audit::outgoing	,
		void *	ptr
	)

inline

void* is returned from malloc and calloc

Definition at line 152 of file memory_allocations.hpp.

    {
        DEBUG_PRINT_HERE("%s(%p)", m_prefix, ptr);
        if(ptr)
        {
            get_allocation_map()[ptr] = value;
            DEBUG_PRINT_HERE("value: %12.8f, accum: %12.8f", value, accum);
        }
    }

References DEBUG_PRINT_HERE.

◆ configure()

template<typename Tp >

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

static

◆ description()

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

inlinestatic

Definition at line 71 of file memory_allocations.hpp.

    {
#if defined(TIMEMORY_USE_CUDA)
        return "GOTCHA wrapper for memory allocation functions: malloc, calloc, free, "
               "cudaMalloc, cudaMallocHost, cudaMallocManaged, cudaHostAlloc, cudaFree, "
               "cudaFreeHost";
#elif defined(TIMEMORY_USE_HIP)
        return "GOTCHA wrapper for memory allocation functions: malloc, calloc, free, "
               "hipMalloc, hipMallocHost, hipMallocManaged, hipHostAlloc, hipFree, "
               "hipFreeHost";
#else
        return "GOTCHA wrapper for memory allocation functions: malloc, calloc, free";
#endif
    }

◆ get()

double tim::component::malloc_gotcha::get ( ) const

inline

Definition at line 127 of file memory_allocations.hpp.

127{ return accum / base_type::get_unit(); }

tim::component::base::get_unit

static int64_t get_unit()

References tim::component::base< Tp, Value >::get_unit().

Referenced by get_display().

◆ get_display()

double tim::component::malloc_gotcha::get_display ( ) const

inline

Definition at line 129 of file memory_allocations.hpp.

129{ return get(); }

tim::component::malloc_gotcha::get

double get() const

Definition: memory_allocations.hpp:127

References get().

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

inlinestatic

Definition at line 101 of file memory_allocations.hpp.

    {
        for(auto& itr : get_cleanup_list())
            itr();
        get_cleanup_list().clear();
    }

◆ label()

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

inlinestatic

Definition at line 70 of file memory_allocations.hpp.

70{ return "malloc_gotcha"; }

◆ operator+=()

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

inline

Definition at line 236 of file memory_allocations.hpp.

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

◆ operator-=()

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

inline

Definition at line 245 of file memory_allocations.hpp.

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

◆ set_prefix() [1/2]

void tim::component::malloc_gotcha::set_prefix ( )

◆ set_prefix() [2/2]

void tim::component::malloc_gotcha::set_prefix ( const char * _prefix )

inline

Definition at line 232 of file memory_allocations.hpp.

232{ m_prefix = _prefix; }

tim::_prefix

char const std::string & _prefix

Definition: config.cpp:55

References tim::_prefix.

◆ start()

void tim::component::malloc_gotcha::start ( )

inline

Definition at line 119 of file memory_allocations.hpp.

119{ value = 0; }

◆ stop()

void tim::component::malloc_gotcha::stop ( )

inline

Definition at line 121 of file memory_allocations.hpp.

    {
        // value should be updated via audit in-between start() and stop()
        accum += value;
    }

◆ tear_down()

template<typename Tp >

static void tim::component::malloc_gotcha::tear_down ( )

static

Member Data Documentation

◆ data_size

constexpr size_t tim::component::malloc_gotcha::data_size = 3

staticconstexpr

Definition at line 60 of file memory_allocations.hpp.

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

timemory/components/gotcha/memory_allocations.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ base_type

◆ component_type

◆ gotcha_component_type

◆ gotcha_type

◆ storage_type

◆ string_hash

◆ this_type

◆ value_type

Member Function Documentation

◆ audit() [1/4]

◆ audit() [2/4]

◆ audit() [3/4]

◆ audit() [4/4]

◆ configure()

◆ description()

◆ get()

◆ get_display()

◆ get_opaque()

◆ global_finalize()

◆ label()

◆ operator+=()

◆ operator-=()

◆ set_prefix() [1/2]

◆ set_prefix() [2/2]

◆ start()

◆ stop()

◆ tear_down()

Member Data Documentation

◆ data_size