src/sim/drain.hh

52  * An object starts out in the Running state. When the simulator
55  * or Drained state. If any object enters the Draining state
57  * all objects have entered the Drained state.
60  * transfer the object to the Running state. This in turn results in a
63  * such cases, the new objects will be created in the Resuming state
66  * \note Even though the state of an object (visible to the rest of
68  * if all objects have entered the Drained state, the protocol is
75     Resuming, /** Transient state while the simulator is resuming */
83  * state before declaring the operation to be successful. This class
86  * state, it exits the simulation loop.
109      * the Drained state at which point the whole simulator is in a
110      * consistent state and ready for checkpointing or CPU
127      * Run state fixups before a checkpoint restore operation
129      * The drain state of an object isn't stored in a checkpoint since
130      * the whole system is always going to be in the Drained state
133      * state since the state isn't stored in checkpoints. This method
134      * performs state fixups on all Drainable objects and the
142     /** Get the simulators global drain state */
143     DrainState state() const { return _state; }
158      * specific state.
160     bool allInState(DrainState state) const;
181     /** Global simulator drain state */
192  * An object's internal state needs to be drained when creating a
194  * timing models. Once the internal state has been drained from
207  *     internal state, it calls DrainManager::signalDrainDone() on the
232      * Notify an object that it needs to drain its state.
236      * automatically switches to the Drained state. If the object
238      * automatically enters the Draining state. Other return values
241      * @note An object that has entered the Drained state can be
244      * state. The simulator therefore repeats the draining process
263      * into a state where it is ready to be drained. The method is
281     /** Return the current drain state of an object. */
308      * Current drain state of the object. Needs to be mutable since
310      * into a Drained state even if the calling method is const.