The Sparta Modeling Framework
Loading...
Searching...
No Matches
sparta::MemoryProfiler Class Reference

Utility used to periodically collect heap usage statistics throughout a simulation. Supported phases for inspection include Build, Configure, Bind, and Simulate. More...

#include <MemoryProfiler.hpp>

Public Types

enum class  Phase { Build , Configure , Bind , Simulate }
 

Public Member Functions

 MemoryProfiler (const std::string &def_file, TreeNode *context, app::Simulation *sim)
 
void enteringPhase (const Phase phase)
 
void exitingPhase (const Phase phase)
 
void saveReport ()
 
void saveReportToStream (std::ostream &os)
 

Detailed Description

Utility used to periodically collect heap usage statistics throughout a simulation. Supported phases for inspection include Build, Configure, Bind, and Simulate.

See the command line option '–log-memory-usage' for more information. Simulation must be built with tcmalloc.

Definition at line 30 of file MemoryProfiler.hpp.

Member Enumeration Documentation

◆ Phase

enum class sparta::MemoryProfiler::Phase
strong

Definition at line 37 of file MemoryProfiler.hpp.


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