derek/gem5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stdlib,python: Allow setting of to tick exits via m5

Browse Source 
This commit adds the following functions to the `m5` python module:

- setMaxTick(tick) -> None
- getMaxTick() -> int
- getTicksUntilMax() -> int
- scheduleTickExitFromCurrent(tick, exit_string) -> None
- scheduleTickExitAbsolute(tick, exit_string) -> None

Until this patch the only way to set an exit at a particular tick was
via `simulate.run` which would reschedule the maximum tick. This
functionality has been explicity exposed via the new `setMaxTick`
function. However, as this is only rescheduling the maximum tick, it
stops scheduling exits at multiple different ticks.

To get around this problem the `scheduleTickExit` functions have been
added. These allow a user to schedule multiple exit events. The
functions contain a `exit_string` parameter that provides the string
the simulator is to return when the specified tick is met. By default
this string is "Tick exit reached" which is used by the stdlib
Simulator module to declare a new `SCHEDULED_TICK` exit event (Note:
this has been deliberatly kept seperate from the `MAX_TICK` exit event.
This commit serves as an attempt to decouple these are two concepts).

Tests are provided in this patch to ensure these new functions work as
intended.

Additional notes:
- The `simulate` function has been fixed to match the documentation. If
  the `num_cycles` is -1 then the maximum ticks is set to MaxTicks.
  Otherwise the max ticks is set to `curTicks() + num_cycles`. The
  functionality of this function will remain unchanged to the end-user.
- Full integration into the Simulator module is not complete as of this
  patch. Users must us the m5 python module to set these exit events.

Change-Id: I6c92b31dd409dc866152224600ea8166cfcba38b
Issue-on: https://gem5.atlassian.net/browse/GEM5-1131
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/66231
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/66331
Reviewed-by: Bobby Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>
This commit is contained in:
Bobby R. Bruce
2022-11-30 15:02:05 -08:00
committed by Bobby Bruce
parent ea3f13ff3b
commit 005049f548
14 changed files with 561 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
tests/gem5/to_tick/configs/tick-exit.py Normal file
View File

@@ -0,0 +1,100 @@
# Copyright (c) 2022 The Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# 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.
"""
"""
from gem5.resources.resource import Resource
from gem5.isas import ISA
from gem5.components.memory import SingleChannelDDR3_1600
from gem5.components.boards.simple_board import SimpleBoard
from gem5.components.cachehierarchies.classic.no_cache import NoCache
from gem5.components.processors.simple_processor import SimpleProcessor
from gem5.components.processors.cpu_types import CPUTypes
from gem5.simulate.simulator import Simulator
from gem5.simulate.exit_event import ExitEvent
import m5
import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
"-t",
"--tick-exits",
type=int,
nargs="+",
required=True,
help="Set the tick exits to exit.",
)
parser.add_argument(
"-r",
"--resource-directory",
type=str,
required=False,
help="The directory in which resources will be downloaded or exist.",
)
args = parser.parse_args()
# Setup the system.
motherboard = SimpleBoard(
clk_freq="3GHz",
processor=SimpleProcessor(
cpu_type=CPUTypes.TIMING,
isa=ISA.X86,
num_cores=1,
),
memory=SingleChannelDDR3_1600(),
cache_hierarchy=NoCache(),
)
# Set the workload
binary = Resource(
"x86-hello64-static", resource_directory=args.resource_directory
)
motherboard.set_se_binary_workload(binary)
def scheduled_tick_generator():
while True:
print(f"Exiting at: {m5.curTick()}")
yield False
# Run the simulation
simulator = Simulator(
board=motherboard,
on_exit_event={ExitEvent.SCHEDULED_TICK: scheduled_tick_generator()},
)
for tick in args.tick_exits:
m5.scheduleTickExitFromCurrent(tick)
simulator.run()

123
tests/gem5/to_tick/configs/tick-to-max.py Normal file
View File

@@ -0,0 +1,123 @@
# Copyright (c) 2022 The Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# 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.
"""
This configuration script is used to test running a simulation to a specified
maximum tick. This script was setup to test setting the number of ticks to
run before, at, or after the running of `simulator.run`.
**Note:** There can only ever be one MAX_TICK exit event scheduled at any one
time.
"""
from gem5.resources.resource import Resource
from gem5.isas import ISA
from gem5.components.memory import SingleChannelDDR3_1600
from gem5.components.boards.simple_board import SimpleBoard
from gem5.components.cachehierarchies.classic.no_cache import NoCache
from gem5.components.processors.simple_processor import SimpleProcessor
from gem5.components.processors.cpu_types import CPUTypes
from gem5.simulate.simulator import Simulator
import m5
import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
"-b",
"--set-ticks-before",
type=int,
required=False,
help="Set the number of ticks to run to prior to executing "
"`simulator.run`.",
)
parser.add_argument(
"-e",
"--set-ticks-at-execution",
type=int,
required=False,
help="Set the number of ticks to run via `simulator.run`.",
)
parser.add_argument(
"-a",
"--set-ticks-after",
type=int,
required=False,
help="Set the number of ticks to run after `simulator.run` has ceased "
"execution.",
)
parser.add_argument(
"-r",
"--resource-directory",
type=str,
required=False,
help="The directory in which resources will be downloaded or exist.",
)
args = parser.parse_args()
# Setup the system.
motherboard = SimpleBoard(
clk_freq="3GHz",
processor=SimpleProcessor(
cpu_type=CPUTypes.TIMING,
isa=ISA.X86,
num_cores=1,
),
memory=SingleChannelDDR3_1600(),
cache_hierarchy=NoCache(),
)
# Set the workload
binary = Resource(
"x86-hello64-static", resource_directory=args.resource_directory
)
motherboard.set_se_binary_workload(binary)
# Set the max ticks before setting up the simulation, if applicable.
if args.set_ticks_before:
m5.setMaxTick(args.set_ticks_before)
# Run the simulation
simulator = Simulator(board=motherboard)
if args.set_ticks_at_execution:
simulator.run(max_ticks=args.set_ticks_at_execution)
else:
simulator.run()
# Set the max ticks after the simulator run.
if args.set_ticks_after:
m5.setMaxTick(args.set_ticks_after)
print(f"Current Tick: {m5.curTick()}")
print(f"Current Max Tick: {m5.getMaxTick()}")
print(f"Ticks until max: {m5.getTicksUntilMax()}")

6
tests/gem5/to_tick/ref/tick-exit-10-20-30-40.txt Normal file
View File

@@ -0,0 +1,6 @@
Global frequency set at 1000000000000 ticks per second
Exiting at: 10
Exiting at: 20
Exiting at: 30
Exiting at: 40
Hello world!

3
tests/gem5/to_tick/ref/tick-exit-100.txt Normal file
View File

@@ -0,0 +1,3 @@
Global frequency set at 1000000000000 ticks per second
Exiting at: 100
Hello world!

4
tests/gem5/to_tick/ref/tick-to-max-at-execution-100.txt Normal file
View File

@@ -0,0 +1,4 @@
Global frequency set at 1000000000000 ticks per second
Current Tick: 100
Current Max Tick: 100
Ticks until max: 0

4
tests/gem5/to_tick/ref/tick-to-max-at-execution-and-after-100-200.txt Normal file
View File

@@ -0,0 +1,4 @@
Global frequency set at 1000000000000 ticks per second
Current Tick: 100
Current Max Tick: 200
Ticks until max: 100

4
tests/gem5/to_tick/ref/tick-to-max-before-execution-250.txt Normal file
View File

@@ -0,0 +1,4 @@
Global frequency set at 1000000000000 ticks per second
Current Tick: 250
Current Max Tick: 250
Ticks until max: 0

174
tests/gem5/to_tick/test_to_tick.py Normal file
View File

@@ -0,0 +1,174 @@
# Copyright (c) 2022 The Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# 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.
from testlib import *
if config.bin_path:
resource_path = config.bin_path
else:
resource_path = joinpath(absdirpath(__file__), "..", "resources")
# This test sets the tick to max tick via the `simulator.run` function. This is
# set to 100. Therefore, at the end of the execution the expected current tick
# should be 100, with the max tick still 100. The number of expected ticks to
# max is therefore 0.
gem5_verify_config(
name="test-to-max-tick-at-execution-100",
verifiers=[
verifier.MatchStdoutNoPerf(
joinpath(getcwd(), "ref", "tick-to-max-at-execution-100.txt")
)
],
fixtures=(),
config=joinpath(
config.base_dir,
"tests",
"gem5",
"to_tick",
"configs",
"tick-to-max.py",
),
config_args=[
"--resource-directory",
resource_path,
"--set-ticks-at-execution",
"100",
],
valid_isas=(constants.all_compiled_tag,),
valid_hosts=constants.supported_hosts,
length=constants.quick_tag,
)
# This test sets the max tick via the `simulator.run` function at tick 100.
# The `m5.setMaxTick` function is then called after, passing the value 200 .
# This means at the end of execution the current tick is 100, and the max tick
# is 200. The number of expected ticks to max is therefore 100.
gem5_verify_config(
name="test-to-max-tick-at-execution-and-after-100-200",
verifiers=[
verifier.MatchStdoutNoPerf(
joinpath(
getcwd(),
"ref",
"tick-to-max-at-execution-and-after-100-200.txt",
)
)
],
fixtures=(),
config=joinpath(
config.base_dir,
"tests",
"gem5",
"to_tick",
"configs",
"tick-to-max.py",
),
config_args=[
"--resource-directory",
resource_path,
"--set-ticks-at-execution",
"100",
"--set-ticks-after",
"200",
],
valid_isas=(constants.all_compiled_tag,),
valid_hosts=constants.supported_hosts,
length=constants.quick_tag,
)
# This test sets the max tick to 250 via the `m5.setMaxTick` prior to running
# `simulator.run`. This means at the end of execution the current tick is 250
# and the max tick is 250. The expected number of ticks to max is therefore 0.
gem5_verify_config(
name="test-to-max-tick-before-execution-250",
verifiers=[
verifier.MatchStdoutNoPerf(
joinpath(getcwd(), "ref", "tick-to-max-before-execution-250.txt")
)
],
fixtures=(),
config=joinpath(
config.base_dir,
"tests",
"gem5",
"to_tick",
"configs",
"tick-to-max.py",
),
config_args=[
"--resource-directory",
resource_path,
"--set-ticks-before",
"250",
],
valid_isas=(constants.all_compiled_tag,),
valid_hosts=constants.supported_hosts,
length=constants.quick_tag,
)
# Tests the scheduling of a tick exit event at tick 100.
gem5_verify_config(
name="test-to-tick-exit-100",
verifiers=[
verifier.MatchStdoutNoPerf(
joinpath(getcwd(), "ref", "tick-exit-100.txt")
)
],
fixtures=(),
config=joinpath(
config.base_dir, "tests", "gem5", "to_tick", "configs", "tick-exit.py"
),
config_args=["--resource-directory", resource_path, "--tick-exits", "100"],
valid_isas=(constants.all_compiled_tag,),
valid_hosts=constants.supported_hosts,
length=constants.quick_tag,
)
# Tests the scheduling of a tick exit event at tick 10, 20, 30, and 40.
gem5_verify_config(
name="test-to-tick-exit-10-20-30-40",
verifiers=[
verifier.MatchStdoutNoPerf(
joinpath(getcwd(), "ref", "tick-exit-10-20-30-40.txt")
)
],
fixtures=(),
config=joinpath(
config.base_dir, "tests", "gem5", "to_tick", "configs", "tick-exit.py"
),
config_args=[
"--resource-directory",
resource_path,
"--tick-exits",
"10",
"20",
"30",
"40",
],
valid_isas=(constants.all_compiled_tag,),
valid_hosts=constants.supported_hosts,
length=constants.quick_tag,
)