Fix bug when blocking due to no free registers.

[gem5.git] / src / sim / sim_exit.hh

diff --git a/src/sim/sim_exit.hh b/src/sim/sim_exit.hh
index f14256933bfb83b049d33a7700828783d987bba1..d4b31d1eaf2d731eb6176077b0eb4508341c3a52 100644 (file)
--- a/src/sim/sim_exit.hh
+++ b/src/sim/sim_exit.hh
@@ -24,6 +24,9 @@
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Nathan Binkert
+ *          Steve Reinhardt
  */
 
 #ifndef __SIM_EXIT_HH__
@@ -33,12 +36,27 @@
 
 #include "sim/host.hh"
 
+// forward declaration
 class Callback;
+class EventQueue;
+class SimLoopExitEvent;
 
+/// Register a callback to be called when Python exits.  Defined in
+/// sim/main.cc.
 void registerExitCallback(Callback *);
 
-void exitNow(const std::string &cause, int exit_code);
-void exitNow(const char *cause, int exit_code);
-void SimExit(Tick when, const char *message);
+/// Schedule an event to exit the simulation loop (returning to
+/// Python) at the indicated tick.  The message and exit_code
+/// parameters are saved in the SimLoopExitEvent to indicate why the
+/// exit occurred.
+SimLoopExitEvent *schedExitSimLoop(const std::string &message, Tick when,
+                                   Tick repeat = 0, EventQueue *q = NULL,
+                                   int exit_code = 0);
+
+/// Schedule an event to exit the simulation loop (returning to
+/// Python) at the end of the current cycle (curTick).  The message
+/// and exit_code parameters are saved in the SimLoopExitEvent to
+/// indicate why the exit occurred.
+void exitSimLoop(const std::string &message, int exit_code = 0);
 
 #endif // __SIM_EXIT_HH__