SST 16.0.0
Structural Simulation Toolkit
SST::CheckpointRealTimeAction Class Reference
Inheritance diagram for SST::CheckpointRealTimeAction:
SST::RealTimeAction

Public Member Functions

 SST_ELI_REGISTER_REALTIMEACTION (CheckpointRealTimeAction, "sst", "rt.checkpoint", SST_ELI_ELEMENT_VERSION(0, 1, 0), "Signal handler that causes SST to generate a checkpoint. This is the default action for the " "'--checkpoint-wall-period' option.") CheckpointRealTimeAction()
virtual void execute () override
virtual void begin (time_t scheduled_time) override
bool canInitiateCheckpoint () override
 Let's the core know if this action may trigger a checkpoint so that all the checkpoint infrastructure can be initialized.
Public Member Functions inherited from SST::RealTimeAction
virtual void begin (time_t UNUSED(scheduled_time))
virtual bool canInitiateInteractive ()
 Lets the core know if this action may trigger an interactive console.
virtual bool isValidSigalrmAction ()
UnitAlgebra getCoreTimeBase () const
 Get the core timebase.
SimTime_t getCurrentSimCycle () const
 Return the current simulation time as a cycle count.
UnitAlgebra getElapsedSimTime () const
 Return the elapsed simulation time as a time.
SimTime_t getEndSimCycle () const
 Return the end simulation time as a cycle count.
UnitAlgebra getEndSimTime () const
 Return the end simulation time as a time.
RankInfo getRank () const
 Get this instance's parallel rank.
RankInfo getNumRanks () const
 Get the number of parallel ranks in the simulation.
Output & getSimulationOutput () const
 Return the base simulation Output class instance.
uint64_t getTimeVortexMaxDepth () const
 Return the max depth of the TimeVortex.
uint64_t getSyncQueueDataSize () const
 Return the size of the SyncQueue - per-rank.
void getMemPoolUsage (int64_t &bytes, int64_t &active_entries)
 Return MemPool usage information - per-rank.
void simulationPrintStatus (bool component_status)
 Invokes printStatus on the simulation instance component_status indicates whether printStatus should also be called on all components.
void simulationSignalShutdown (bool abnormal)
 Inform the simulation that a signal requires a shutdown abnormal indicates whether emergencyShutdown() should be called.
void simulationCheckpoint ()
 Generate a checkpoint.
void initiateInteractive (const std::string &msg)

Member Function Documentation

◆ canInitiateCheckpoint()

bool SST::CheckpointRealTimeAction::canInitiateCheckpoint ( )
inlineoverridevirtual

Let's the core know if this action may trigger a checkpoint so that all the checkpoint infrastructure can be initialized.

Reimplemented from SST::RealTimeAction.

◆ execute()

void SST::CheckpointRealTimeAction::execute ( )
overridevirtual

Implements SST::RealTimeAction.


The documentation for this class was generated from the following files:
  • src/sst/core/realtime.h
  • src/sst/core/realtime.cc