 |
Top-down memory tagging system. More...
Classes | |
| class | Auto |
| Scoped (i.e. More... | |
| class | Auto2 |
| Scoped (i.e. More... | |
| struct | CallStackInfo |
| This struct is used to represent a call stack taken for an allocation that was billed under a specific malloc tag. More... | |
| struct | CallTree |
Summary data structure for malloc statistics. More... | |
Static Public Member Functions | |
| static TF_API bool | Initialize (std::string *errMsg) |
| Initialize the memory tagging system. More... | |
| static bool | IsInitialized () |
| Return true if the tagging system is active. More... | |
| static TF_API size_t | GetTotalBytes () |
| Return total number of allocated bytes. More... | |
| static TF_API size_t | GetMaxTotalBytes () |
| Return the maximum total number of bytes that have ever been allocated at one time. More... | |
| static TF_API bool | GetCallTree (CallTree *tree, bool skipRepeated=true) |
| Return a snapshot of memory usage. More... | |
| static void | Push (const std::string &name) |
| Manually push a tag onto the stack. More... | |
| static void | Push (const char *name) |
| static TF_API void | Pop (const char *name=NULL) |
| Manually pop a tag from the stack. More... | |
| static void | Pop (const std::string &name) |
| static TF_API void | SetDebugMatchList (const std::string &matchList) |
| Sets the tags to trap in the debugger. More... | |
| static TF_API void | SetCapturedMallocStacksMatchList (const std::string &matchList) |
| Sets the tags to trace. More... | |
| static TF_API std::vector < std::vector< uintptr_t > > | GetCapturedMallocStacks () |
| Returns the captured malloc stack traces for allocations billed to the malloc tags passed to SetCapturedMallocStacksMatchList(). More... | |
Friends | |
| class | TfMallocTag::Auto |
| class | TfMallocTag::Tls |
Top-down memory tagging system.
See The TfMallocTag Memory Tagging System for a detailed description.
Definition at line 49 of file mallocTag.h.
| struct TfMallocTag::CallStackInfo |
This struct is used to represent a call stack taken for an allocation that was billed under a specific malloc tag.
Definition at line 162 of file mallocTag.h.
|
static |
Return a snapshot of memory usage.
Returns a snapshot by writing into *tree. See the C *tree structure for documentation. If Initialize() has not been called, \ *tree is set to a rather blank structure (empty vectors, empty strings, zero in all integral fields) and false is returned; otherwise, *tree is set with the contents of the current memory snapshot and true is returned. It is fine to call this function on the same *tree instance; each call simply overwrites the data from the last call. If /p skipRepeated is true, then any repeated callsite is skipped. See the CallTree documentation for more details.
|
static |
Returns the captured malloc stack traces for allocations billed to the malloc tags passed to SetCapturedMallocStacksMatchList().
|
static |
Return the maximum total number of bytes that have ever been allocated at one time.
This is simply the maximum value of GetTotalBytes() since Initialize() was called.
|
static |
Return total number of allocated bytes.
The current total memory that has been allocated and not freed is returned. Memory allocated before calling Initialize() is not accounted for.
|
static |
Initialize the memory tagging system.
This function returns true if the memory tagging system can be successfully initialized or it has already been initialized. Otherwise, *errMsg is set with an explanation for the failure.
Until the system is initialized, the various memory reporting calls will indicate that no memory has been allocated. Note also that memory allocated prior to calling Initialize() is not tracked i.e. all data refers to allocations that happen subsequent to calling Initialize().
|
inlinestatic |
Return true if the tagging system is active.
If Initialize() has been successfully called, this function returns true.
Definition at line 193 of file mallocTag.h.
|
static |
Manually pop a tag from the stack.
This call has the same effect as the destructor for TfMallocTag::Auto; it must properly nest with a matching call to Push(), of course.
If name is supplied and does not match the tag at the top of the stack, a warning message is issued.
|
inlinestatic |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 413 of file mallocTag.h.
|
inlinestatic |
Manually push a tag onto the stack.
This call has the same effect as the constructor for TfMallocTag::Auto (aka TfAutoMallocTag), however a matching call to Pop() is required.
Note that initializing the tagging system between matching calls to Push() and Pop() is ill-advised, which is yet another reason to prefer using TfAutoMallocTag whenever possible.
Definition at line 391 of file mallocTag.h.
|
inlinestatic |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 397 of file mallocTag.h.
|
static |
Sets the tags to trace.
When memory is allocated for any tag that matches matchList a stack trace is recorded. When that memory is released the stack trace is discarded. Clients can call GetCapturedMallocStacks() to get a list of all recorded stack traces. This is useful for finding leaks.
Traces recorded for any tag that will no longer be matched are discarded by this call. Traces recorded for tags that continue to be matched are retained.
matchList is a comma, tab or newline separated list of malloc tag names. The names can have internal spaces but leading and trailing spaces are stripped. If a name ends in '*' then the suffix is wildcarded. A name can have a leading '-' or '+' to prevent or allow a match. Each name is considered in order and later matches override earlier matches. For example, 'Csd*, -CsdScene::_Populate*, +CsdScene::_PopulatePrimCacheLocal' matches any malloc tag starting with 'Csd' but nothing starting with 'CsdScene::_Populate' except 'CsdScene::_PopulatePrimCacheLocal'. Use the empty string to disable stack capturing.
|
static |
Sets the tags to trap in the debugger.
When memory is allocated or freed for any tag that matches matchList the debugger trap is invoked. If a debugger is attached the program will stop in the debugger, otherwise the program will continue to run. See ArchDebuggerTrap() and ArchDebuggerWait().
matchList is a comma, tab or newline separated list of malloc tag names. The names can have internal spaces but leading and trailing spaces are stripped. If a name ends in '*' then the suffix is wildcarded. A name can have a leading '-' or '+' to prevent or allow a match. Each name is considered in order and later matches override earlier matches. For example, 'Csd*, -CsdScene::_Populate*, +CsdScene::_PopulatePrimCacheLocal' matches any malloc tag starting with 'Csd' but nothing starting with 'CsdScene::_Populate' except 'CsdScene::_PopulatePrimCacheLocal'. Use the empty string to disable debugging traps.
1.8.5 
