commit 1e73beb620913e0088fdeacc0fa5787de03cd867
author Bobby R. Bruce <bbruce@ucdavis.edu> Mon Dec 05 15:28:00 2022 -0800
committer Bobby Bruce <bbruce@ucdavis.edu> Tue Dec 06 22:41:58 2022 +0000
tree f2ed98c5cf807140dd1a0c48bfb609dc04213b28
parent e200ea1510e337a001754bcf299c6dea74e36186

python: Remove 'scheduleTickExit' in favor of 'exitSimLoop'

The commit https://gem5-review.googlesource.com/c/public/gem5/+/66231
added an API to m5 for scheduling to-tick exit events. This added the
function `schedule_tick_exit`. It was later pointed out that this
`schedule_tick_exit` event is redundant given the existance of
`exitSimLoop`. This patch therefore removes `schedule_tick_exit` in
favor of `exitSimLoop`.

Change-Id: Ibecf00b98256a5da2868427d766bdc93f03c3f97
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/66511
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Bobby Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>

src/python/m5/simulate.py

diff --git a/src/python/m5/simulate.py b/src/python/m5/simulate.py
index 744d95f..18fb1d6 100644
--- a/src/python/m5/simulate.py
+++ b/src/python/m5/simulate.py
@@ -259,7 +259,7 @@
     """
     if tick <= curTick():
         warn("Tick exit scheduled for the past. This will not be triggered.")
-    _m5.event.scheduleTickExit(tick=tick, exit_string=exit_string)
+    _m5.event.exitSimLoop(exit_string, 0, tick, 0, False)
 
 
 def drain():

src/python/pybind11/event.cc

diff --git a/src/python/pybind11/event.cc b/src/python/pybind11/event.cc
index 827768f..95e6ddb 100644
--- a/src/python/pybind11/event.cc
+++ b/src/python/pybind11/event.cc
@@ -109,8 +109,6 @@
           py::arg("ticks") = MaxTick);
     m.def("setMaxTick", &set_max_tick, py::arg("tick"));
     m.def("getMaxTick", &get_max_tick, py::return_value_policy::copy);
-    m.def("scheduleTickExit", &schedule_tick_exit, py::arg("tick"),
-        py::arg("exit_string"));
     m.def("terminateEventQueueThreads", &terminateEventQueueThreads);
     m.def("exitSimLoop", &exitSimLoop);
     m.def("getEventQueue", []() { return curEventQueue(); },

src/sim/simulate.cc

diff --git a/src/sim/simulate.cc b/src/sim/simulate.cc
index 4993859..95b2c05 100644
--- a/src/sim/simulate.cc
+++ b/src/sim/simulate.cc
@@ -263,11 +263,6 @@
     return simulate_limit_event->when();
 }
 
-void schedule_tick_exit(Tick tick, std::string exit_string)
-{
-    new GlobalSimLoopExitEvent(tick, exit_string, 0);
-}
-
 void
 terminateEventQueueThreads()
 {

src/sim/simulate.hh

diff --git a/src/sim/simulate.hh b/src/sim/simulate.hh
index e7c4fa6..eacf67c 100644
--- a/src/sim/simulate.hh
+++ b/src/sim/simulate.hh
@@ -68,16 +68,6 @@
 Tick get_max_tick();
 
 /**
- * @brief Schedule an exit event at a particular tick.
- *
- * Schedule a tick with a particular exit string.
- *
- * @param tick The tick at which the simulation loop should exit.
- * @param exit_string The exit string explaining the exit.
- */
-void schedule_tick_exit(Tick tick, std::string exit_string);
-
-/**
  * Terminate helper threads when running in parallel mode.
  *
  * @pre Simulator must have returned from simulate() to service a