Bobby Bruce has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/62691?usp=email )
Change subject: stdlib: Allow passing of func list as exit_event generator
......................................................................
stdlib: Allow passing of func list as exit_event generator
Allows for a passing of functions to specify actions to execute on an
exit event via the Simulator module in the stdlib.
The list of functions must have no manditory arguments and return True
if the Simulation is to exit upon the function call's completion.
Issue-on: https://gem5.atlassian.net/browse/GEM5-1126
Change-Id: Ia88caf2975227e78243763627acab9e9f89e2a7d
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/62691
Reviewed-by: Jason Lowe-Power <power...@gmail.com>
Maintainer: Jason Lowe-Power <power...@gmail.com>
Tested-by: kokoro <noreply+kok...@google.com>
---
M src/python/gem5/simulate/simulator.py
1 file changed, 76 insertions(+), 8 deletions(-)
Approvals:
kokoro: Regressions pass
Jason Lowe-Power: Looks good to me, approved; Looks good to me, approved
diff --git a/src/python/gem5/simulate/simulator.py
b/src/python/gem5/simulate/simulator.py
index 0551745..4947b46 100644
--- a/src/python/gem5/simulate/simulator.py
+++ b/src/python/gem5/simulate/simulator.py
@@ -34,7 +34,7 @@
import os
import sys
from pathlib import Path
-from typing import Optional, List, Tuple, Dict, Generator, Union
+from typing import Optional, List, Tuple, Dict, Generator, Union, Callable
from .exit_event_generators import (
warn_default_decorator,
@@ -83,7 +83,10 @@
board: AbstractBoard,
full_system: Optional[bool] = None,
on_exit_event: Optional[
- Dict[ExitEvent, Generator[Optional[bool], None, None]]
+ Dict[
+ ExitEvent,
+ Union[Generator[Optional[bool], None, None],
List[Callable]],
+ ]
] = None,
expected_execution_order: Optional[List[ExitEvent]] = None,
checkpoint_path: Optional[Path] = None,
@@ -96,7 +99,9 @@
`is_fullsystem()` function.
:param on_exit_event: An optional map to specify the generator to
execute on each exit event. The generator may yield a boolean
which,
- if True, will have the Simulator exit the run loop.
+ if True, will have the Simulator exit the run loop. A List of
functions
+ may also be used. Each function must be callable with no arguments
and
+ return a boolean specifying if the Simulation should exit the run
loop.
:param expected_execution_order: May be specified to check the exit
events come in a specified order. If the order specified is not
encountered (e.g., 'Workbegin', 'Workend', then 'Exit'), an
Exception
@@ -111,6 +116,9 @@
`on_exit_event` usage notes
---------------------------
+ With Generators
+ ===============
+
The `on_exit_event` parameter specifies a Python generator for each
exit event. `next(<generator>)` is run each time an exit event. The
generator may yield a boolean. If this value of this boolean is
True
@@ -142,6 +150,54 @@
encountered, will dump gem5 statistics the second time an exit
event is
encountered, and will terminate the Simulator run loop the third
time.
+ With a list of functions
+ ========================
+
+ Alternatively, instead of passing a generator per exit event, a
list of
+ functions may be passed. Each function must take no mandatory
arguments
+ and return True if the simulator is to exit after being called.
+
+ An example:
+
+ ```
+ def stop_simulation() -> bool:
+ return True
+
+ def switch_cpus() -> bool:
+ processor.switch()
+ return False
+
+ def print_hello() -> None:
+ # Here we don't explicitly return a boolean, but the simulator
+ # treats a None return as False. Ergo the Simulation loop is
not
+ # terminated.
+ print("Hello")
+
+
+ simulator = Simulator(
+ board=board,
+ on_exit_event = {
+ ExitEvent.Exit : [
+ print_hello,
+ switch_cpus,
+ print_hello,
+ stop_simulation
+ ],
+ },
+ )
+ ```
+
+ Upon each `EXIT` type exit event the list will function as a queue,
+ with the top function of the list popped and executed. Therefore,
in
+ this example, the first `EXIT` type exit event will cause
`print_hello`
+ to be executed, and the second `EXIT` type exit event will cause
the
+ `switch_cpus` function to run. The third will execute `print_hello`
+ again before finally, on the forth exit event will call
+ `stop_simulation` which will stop the simulation as it returns
False.
+
+ Exit Event defaults
+ ===================
+
Each exit event has a default behavior if none is specified by the
user. These are as follows:
@@ -202,7 +258,19 @@
}
if on_exit_event:
- self._on_exit_event = on_exit_event
+ self._on_exit_event = {}
+ for key, value in on_exit_event.items():
+ if isinstance(value, Generator):
+ self._on_exit_event[key] = value
+ elif isinstance(value, List):
+ # In instances where we have a list of functions, we
+ # convert this to a generator.
+ self._on_exit_event[key] = (func() for func in value)
+ else:
+ raise Exception(
+ f"`on_exit_event` for '{key.value}' event is "
+ "not a Generator or List[Callable]."
+ )
else:
self._on_exit_event = self._default_on_exit_dict
@@ -475,12 +543,12 @@
# If the user has specified their own generator for this
exit
# event, use it.
exit_on_completion = next(self._on_exit_event[exit_enum])
- except StopIteration:
+ except (StopIteration):
# If the user's generator has ended, throw a warning and
use
# the default generator for this exit event.
warn(
- "User-specified generator for the exit event "
- f"'{exit_enum.value}' has ended. Using the default "
+ "User-specified generator/function list for the exit "
+ f"event'{exit_enum.value}' has ended. Using the
default "
"generator."
)
exit_on_completion = next(
@@ -496,7 +564,7 @@
self._exit_event_count += 1
# If the generator returned True we will return from the
Simulator
- # run loop.
+ # run loop. In the case of a function: if it returned True.
if exit_on_completion:
return
--
To view, visit
https://gem5-review.googlesource.com/c/public/gem5/+/62691?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Ia88caf2975227e78243763627acab9e9f89e2a7d
Gerrit-Change-Number: 62691
Gerrit-PatchSet: 15
Gerrit-Owner: Bobby Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Bobby Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: Melissa Jost <mkj...@ucdavis.edu>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
