MemoryUsage

class MemoryUsage

Bases: MemoryHook

This class is used strictly for debugging purposes, specifically for tracking memory leaks of reference-counted objects: it keeps a record of every such object currently allocated.

When compiled with NDEBUG set, this entire class does nothing and compiles to a stub.

Inheritance diagram

MemoryUsage(MemoryUsage const&) = default

void freeze(void)

‘Freezes’ all pointers currently stored so that they are no longer reported; only newly allocate pointers from this point on will appear in future information requests. This makes it easier to differentiate between continuous leaks and one-time memory allocations.

std::size_t get_current_cpp_size(void)

Returns the total number of bytes of allocated memory consumed by C++ objects, not including the memory previously frozen.

std::size_t get_external_size(void)

Returns the total number of bytes of allocated memory in the heap that Panda didn’t seem to be responsible for. This includes a few bytes for very low-level objects (like ConfigVariables) that cannot use Panda memory tracking because they are so very low-level.

This also includes all of the memory that might have been allocated by a high-level interpreter, like Python.

This number is only available if Panda is able to hook into the actual heap callback.

int get_num_pointers(void)

Returns the number of pointers currently active.

std::size_t get_panda_heap_array_size(void)

Returns the total number of bytes allocated from the heap from code within Panda, for arrays.

std::size_t get_panda_heap_overhead(void)

Returns the extra bytes allocated from the system that are not immediately used for holding allocated objects. This can only be determined if ALTERNATIVE_MALLOC is enabled.

std::size_t get_panda_heap_single_size(void)

Returns the total number of bytes allocated from the heap from code within Panda, for individual objects.

std::size_t get_panda_mmap_size(void)

Returns the total number of bytes allocated from the virtual memory pool from code within Panda.

void get_pointers(MemoryUsagePointers &result)

Fills the indicated MemoryUsagePointers with the set of all pointers currently active.

void get_pointers_of_age(MemoryUsagePointers &result, double from, double to)

Fills the indicated MemoryUsagePointers with the set of all pointers that were allocated within the range of the indicated number of seconds ago.

void get_pointers_of_type(MemoryUsagePointers &result, TypeHandle type)

Fills the indicated MemoryUsagePointers with the set of all pointers of the indicated type currently active.

void get_pointers_with_zero_count(MemoryUsagePointers &result)

Fills the indicated MemoryUsagePointers with the set of all currently active pointers (that is, pointers allocated since the last call to freeze(), and not yet freed) that have a zero reference count.

Generally, an undeleted pointer with a zero reference count means its reference count has never been incremented beyond zero (since once it has been incremented, the only way it can return to zero would free the pointer). This may include objects that are allocated statically or on the stack, which are never intended to be deleted. Or, it might represent a programmer or compiler error.

This function has the side-effect of incrementing each of their reference counts by one, thus preventing them from ever being freed–but since they hadn’t been freed anyway, probably no additional harm is done.

std::size_t get_total_cpp_size(void)

Returns the total number of bytes of allocated memory consumed by C++ objects, including the memory previously frozen.

std::size_t get_total_size(void)

Returns the total size of allocated memory consumed by the process, as nearly as can be determined.

bool is_counting(void)

Returns true if the MemoryUsage object is currently at least counting memory (e.g. this is a Windows debug build), even if it’s not fully tracking it.

bool is_tracking(void)

Returns true if the MemoryUsage object is currently tracking memory (e.g. track-memory-usage is configured #t).

void show_current_ages(void)

Shows the breakdown of ages of all of the active pointers.

void show_current_types(void)

Shows the breakdown of types of all of the active pointers.

void show_trend_ages(void)

Shows the breakdown of ages of all of the pointers allocated and freed since the last call to freeze().

void show_trend_types(void)

Shows the breakdown of types of all of the pointers allocated and freed since the last call to freeze().