Austin Harris has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/50467 )
(
5 is the latest approved patch-set.
No files were changed between the latest approved patch-set and the
submitted one.
)Change subject: tests: Add a test for forking and switching cpus
......................................................................
tests: Add a test for forking and switching cpus
This tests forking gem5 and simulating the child with a different cpu.
The test boots linux with the KVM cpu and then forks gem5. Each child
simulation switches to the specified cpu and simulates to completion
while the parents waits for the children to finish before also
simulating to completion.
Change-Id: I68d7515bf125c855eefc62ba4798cd7c745ef2b0
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/50467
Tested-by: kokoro <[email protected]>
Reviewed-by: Bobby R. Bruce <[email protected]>
Maintainer: Bobby R. Bruce <[email protected]>
---
A tests/gem5/configs/boot_kvm_fork_run.py
A tests/gem5/kvm-fork-tests/test_kvm_fork_run.py
2 files changed, 434 insertions(+), 0 deletions(-)
Approvals:
Bobby R. Bruce: Looks good to me, approved; Looks good to me, approved
kokoro: Regressions pass
diff --git a/tests/gem5/configs/boot_kvm_fork_run.py
b/tests/gem5/configs/boot_kvm_fork_run.py
new file mode 100644
index 0000000..e9f0172
--- /dev/null
+++ b/tests/gem5/configs/boot_kvm_fork_run.py
@@ -0,0 +1,271 @@
+# Copyright (c) 2021 The University of Texas at Austin
+# 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.
+#
+# Author: Austin Harris
+#
+
+"""
+This script tests forking gem5 with the KVM cores and switching cores in
the
+child process. First, the test boots linux with KVM and tests
fast-forwarding
+with instruction exit events. Then the test forks the simulation, waits
for the
+child to simulate until completion, and then simulates to completion in the
+parent process.
+"""
+
+import argparse
+import os
+import sys
+from textwrap import dedent
+
+import m5
+from m5.objects import Root
+
+from gem5.components.boards.x86_board import X86Board
+from gem5.coherence_protocol import CoherenceProtocol
+from gem5.isas import ISA
+from gem5.components.memory.single_channel import SingleChannelDDR3_1600
+from gem5.components.processors.cpu_types import CPUTypes
+from gem5.components.processors.simple_switchable_processor import (
+ SimpleSwitchableProcessor,
+)
+from gem5.resources.resource import Resource
+from gem5.runtime import (
+ get_runtime_coherence_protocol, get_runtime_isa
+)
+from gem5.utils.requires import requires
+
+parser = argparse.ArgumentParser(
+ description="A script to test forking gem5 and switching cpus."
+)
+parser.add_argument(
+ "-m",
+ "--mem-system",
+ type=str,
+ choices=("classic", "mi_example", "mesi_two_level"),
+ required=True,
+ help="The memory system.",
+)
+parser.add_argument(
+ "-n",
+ "--num-cpus",
+ type=int,
+ choices=(1, 2, 4, 8),
+ default=4,
+ help="The number of CPUs.",
+)
+parser.add_argument(
+ "-c",
+ "--cpu",
+ type=str,
+ choices=("kvm", "atomic", "timing", "o3"),
+ required=True,
+ help="The CPU type.",
+)
+parser.add_argument(
+ "-r",
+ "--resource-directory",
+ type=str,
+ required=False,
+ help="The directory in which resources will be downloaded or exist.",
+)
+parser.add_argument(
+ "-o",
+ "--override-download",
+ action="store_true",
+ help="Override a local resource if the hashes do not match.",
+)
+parser.add_argument(
+ "-k",
+ "--kernel-args",
+ type=str,
+ default="init=/root/gem5_init.sh",
+ help="Additional kernel boot arguments.",
+)
+parser.add_argument(
+ "-f",
+ "--num-forks",
+ type=int,
+ default=4,
+ help="The number of times to fork gem5.",
+)
+
+args = parser.parse_args()
+
+coherence_protocol_required = None
+if args.mem_system == "mi_example":
+ coherence_protocol_required = CoherenceProtocol.MI_EXAMPLE
+elif args.mem_system == "mesi_two_level":
+ coherence_protocol_required = CoherenceProtocol.MESI_TWO_LEVEL
+
+requires(
+ isa_required=ISA.X86,
+ coherence_protocol_required=coherence_protocol_required,
+ kvm_required=(args.cpu == "kvm"),
+)
+
+cache_hierarchy = None
+if args.mem_system == "mi_example":
+ from gem5.components.cachehierarchies.ruby.\
+ mi_example_cache_hierarchy import (
+ MIExampleCacheHierarchy,
+ )
+
+ cache_hierarchy = MIExampleCacheHierarchy(size="32kB", assoc=8)
+elif args.mem_system == "mesi_two_level":
+ from gem5.components.cachehierarchies.ruby.\
+ mesi_two_level_cache_hierarchy import (
+ MESITwoLevelCacheHierarchy,
+ )
+
+ cache_hierarchy = MESITwoLevelCacheHierarchy(
+ l1d_size="16kB",
+ l1d_assoc=8,
+ l1i_size="16kB",
+ l1i_assoc=8,
+ l2_size="256kB",
+ l2_assoc=16,
+ num_l2_banks=1,
+ )
+elif args.mem_system == "classic":
+ from gem5.components.cachehierarchies.classic.\
+ private_l1_cache_hierarchy import (
+ PrivateL1CacheHierarchy,
+ )
+
+ cache_hierarchy = PrivateL1CacheHierarchy(l1d_size="16kB",
l1i_size="16kB")
+else:
+ raise NotImplementedError(
+ "Memory system '{}' is not supported in the boot tests.".format(
+ args.mem_system
+ )
+ )
+
+assert cache_hierarchy != None
+
+# Setup the system memory.
+
+memory = SingleChannelDDR3_1600(size="3GB")
+
+# Setup a Processor.
+cpu_type = None
+if args.cpu == "kvm":
+ cpu_type = CPUTypes.KVM
+elif args.cpu == "atomic":
+ cpu_type = CPUTypes.ATOMIC
+elif args.cpu == "timing":
+ cpu_type = CPUTypes.TIMING
+elif args.cpu == "o3":
+ cpu_type = CPUTypes.O3
+else:
+ raise NotImplementedError(
+ "CPU type '{}' is not supported in the boot
tests.".format(args.cpu)
+ )
+
+assert cpu_type != None
+
+processor = SimpleSwitchableProcessor(
+ starting_core_type=CPUTypes.KVM,
+ switch_core_type=cpu_type,
+ num_cores=args.num_cpus,
+)
+
+# Setup the motherboard.
+motherboard = X86Board(
+ clk_freq="3GHz",
+ processor=processor,
+ memory=memory,
+ cache_hierarchy=cache_hierarchy,
+ exit_on_work_items=True,
+)
+
+motherboard.connect_things()
+
+# Set the Full System workload.
+motherboard.set_workload(
+ kernel=Resource(
+ "x86-linux-kernel-5.4.49",
+ override=args.override_download,
+ resource_directory=args.resource_directory,
+ ),
+ disk_image=Resource(
+ "x86-ubuntu-img",
+ override=args.override_download,
+ resource_directory=args.resource_directory,
+ ),
+ command=dedent(
+ """
+ m5 exit # signal end of boot
+ m5 exit # exit in children and parent
+ """
+ ),
+ kernel_args=[args.kernel_args]
+)
+
+
+# Begin running of the simulation. This will exit once the Linux system
boot
+# is complete.
+print("Running with ISA: " + get_runtime_isa().name)
+print("Running with protocol: " + get_runtime_coherence_protocol().name)
+print()
+
+root = Root(full_system=True, system=motherboard)
+
+# TODO: This of annoying. Is there a way to fix this to happen
+# automatically when running KVM?
+root.sim_quantum = int(1e9)
+
+# Disable the gdb ports. Required for forking.
+m5.disableAllListeners()
+
+m5.instantiate()
+
+# Simulate the inital boot with the starting KVM cpu
+exit_event = m5.simulate()
+print("Boot finished", exit_event.getCause())
+
+print("Starting fork and switch processors test")
+pids = []
+for i in range(args.num_forks):
+ pid = m5.fork("%(parent)s/" + str(m5.curTick()))
+ if pid == 0: # in child
+ print(f"Switching processors in child {i}.")
+ processor.switch()
+ exit_event = m5.simulate()
+ if exit_event.getCause() != "m5_exit instruction encountered":
+ raise Exception(f"Expected m5 exit, got
{exit_event.getCause()}")
+ print("Child finished, exiting: ", exit_event.getCause())
+ sys.exit(0)
+ else:
+ pids.append(pid)
+
+print("Waiting for children...")
+for pid in pids:
+ print (os.waitpid(pid, 0))
+
+print("Children finished! Running to completion in parent.")
+exit_event = m5.simulate()
+if exit_event.getCause() != "m5_exit instruction encountered":
+ raise Exception(f"Expected m5 exit, got {exit_event.getCause()}")
diff --git a/tests/gem5/kvm-fork-tests/test_kvm_fork_run.py
b/tests/gem5/kvm-fork-tests/test_kvm_fork_run.py
new file mode 100644
index 0000000..d12f104
--- /dev/null
+++ b/tests/gem5/kvm-fork-tests/test_kvm_fork_run.py
@@ -0,0 +1,144 @@
+# Copyright (c) 2021 The Regents of the University of California
+# Copyright (c) 2021 The University of Texas at Austin
+# 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.
+
+"""
+The purpose of this Suite of tests is to check that the simulator can be
forked
+with the KVM cpu then switch to a different cpu and run in the child.
+"""
+
+import os
+
+from testlib import *
+
+if config.bin_path:
+ resource_path = config.bin_path
+else:
+ resource_path = joinpath(absdirpath(__file__), "..", "resources")
+
+
+def test_kvm_fork_run(cpu: str, num_cpus: int, mem_system: str, length:
str):
+
+ if not os.access("/dev/kvm", mode=os.R_OK | os.W_OK):
+ # Don't run the tests if KVM is unavailable.
+ return
+
+ name = "{}-cpu_{}-cores_{}_kvm-fork-run-test".format(
+ cpu, str(num_cpus), mem_system
+ )
+ verifiers = []
+
+ if mem_system == "mesi_two_level":
+ protocol_to_use = "MESI_Two_Level"
+ isa_to_use = constants.x86_tag
+ elif mem_system == "mi_example":
+ protocol_to_use = None
+ isa_to_use = constants.x86_tag
+ else:
+ protocol_to_use = None
+ isa_to_use = constants.gcn3_x86_tag
+
+ gem5_verify_config(
+ name=name,
+ verifiers=verifiers,
+ fixtures=(),
+ config=joinpath(
+ config.base_dir,
+ "tests",
+ "gem5",
+ "configs",
+ "boot_kvm_fork_run.py",
+ ),
+ config_args=[
+ "--cpu",
+ cpu,
+ "--num-cpus",
+ str(num_cpus),
+ "--num-forks",
+ "4",
+ "--mem-system",
+ mem_system,
+ "--override-download",
+ "--resource-directory",
+ resource_path,
+ "--kernel-args=''",
+ ],
+ valid_isas=(isa_to_use,),
+ valid_hosts=constants.supported_hosts,
+ protocol=protocol_to_use,
+ length=length,
+ )
+
+
+#### The quick (pre-submit/Kokoro) tests ####
+
+test_kvm_fork_run(
+ cpu="atomic", num_cpus=1, mem_system="classic",
length=constants.quick_tag
+)
+test_kvm_fork_run(
+ cpu="timing", num_cpus=1, mem_system="classic",
length=constants.quick_tag
+)
+test_kvm_fork_run(
+ cpu="o3", num_cpus=1, mem_system="classic", length=constants.quick_tag
+)
+test_kvm_fork_run(
+ cpu="timing", num_cpus=4, mem_system="classic",
length=constants.quick_tag
+)
+
+test_kvm_fork_run(
+ cpu="timing",
+ num_cpus=4,
+ mem_system="mi_example",
+ length=constants.quick_tag,
+)
+
+### The long (nightly) tests ####
+
+test_kvm_fork_run(
+ cpu="atomic",
+ num_cpus=1,
+ mem_system="mesi_two_level",
+ length=constants.long_tag,
+)
+test_kvm_fork_run(
+ cpu="timing",
+ num_cpus=1,
+ mem_system="mesi_two_level",
+ length=constants.long_tag,
+)
+test_kvm_fork_run(
+ cpu="o3",
+ num_cpus=8,
+ mem_system="mesi_two_level",
+ length=constants.long_tag,
+)
+
+test_kvm_fork_run(
+ cpu="timing",
+ num_cpus=2,
+ mem_system="mesi_two_level",
+ length=constants.long_tag,
+)
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/50467
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I68d7515bf125c855eefc62ba4798cd7c745ef2b0
Gerrit-Change-Number: 50467
Gerrit-PatchSet: 7
Gerrit-Owner: Austin Harris <[email protected]>
Gerrit-Reviewer: Austin Harris <[email protected]>
Gerrit-Reviewer: Bobby R. Bruce <[email protected]>
Gerrit-Reviewer: Jason Lowe-Power <[email protected]>
Gerrit-Reviewer: kokoro <[email protected]>
Gerrit-CC: Jason Lowe-Power <[email protected]>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
