Kaustav Goswami has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/53023 )
Change subject: stdlib,configs: Adding a config to run GAPBS using stdlib.
......................................................................
stdlib,configs: Adding a config to run GAPBS using stdlib.
This change adds a config file to execute GAPBS benchmarks using
gem5 stdlib. It also adds a new test for the same.
Signed-off-by: Kaustav Goswami <[email protected]>
Change-Id: I10326cace4e6fa160e02e479fb4443277af3966f
---
A configs/example/gem5_library/x86-gapbs-benchmarks.py
M tests/gem5/gem5_library_example_tests/test_gem5_library_examples.py
2 files changed, 349 insertions(+), 2 deletions(-)
diff --git a/configs/example/gem5_library/x86-gapbs-benchmarks.py
b/configs/example/gem5_library/x86-gapbs-benchmarks.py
new file mode 100644
index 0000000..64b0dad
--- /dev/null
+++ b/configs/example/gem5_library/x86-gapbs-benchmarks.py
@@ -0,0 +1,314 @@
+# Copyright (c) 2021 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.
+
+"""
+Script to run GAPBS benchmarks with gem5. The script expects the
+benchmark program and the simulation size to run. The input is in the
format
+<benchmark_prog> <size> <synthetic>
+The system is fixed with 2 CPU cores, MESI Two Level system cache and 3 GB
+DDR4 memory. It uses the x86 board.
+
+This script will count the total number of instructions executed
+in the ROI. It also tracks how much wallclock and simulated time.
+
+Usage:
+------
+
+```
+scons build/X86_MESI_Two_Level/gem5.opt
+./build/X86_MESI_Two_Level/gem5.opt \
+ configs/example/gem5_library/x86-gabps-benchmarks.py \
+ --benchmark <benchmark_name> \
+ --synthetic <synthetic> \
+ --size <simulation_size/graph_name>
+```
+"""
+
+import argparse
+import time
+import json
+import sys
+
+import m5
+from m5.objects import Root
+
+from gem5.utils.requires import requires
+from gem5.components.boards.x86_board import X86Board
+from gem5.components.memory.single_channel import SingleChannelDDR4_2400
+from gem5.components.processors.simple_switchable_processor import (
+ SimpleSwitchableProcessor,
+)
+from gem5.components.processors.cpu_types import CPUTypes
+from gem5.isas import ISA
+from gem5.coherence_protocol import CoherenceProtocol
+from gem5.resources.resource import Resource
+
+from m5.stats.gem5stats import get_simstat
+
+requires(
+ isa_required=ISA.X86,
+ coherence_protocol_required=CoherenceProtocol.MESI_TWO_LEVEL,
+ kvm_required=True,
+)
+
+# Following are the list of benchmark programs for gapbs
+
+benchmark_choices = ["cc", "bc", "tc", "pr", "bfs"]
+
+synthetic_choices = ["0", "1"]
+
+size_choices =
["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
+ "13", "14", "15", "16", "USA-road-d.NY.gr"]
+
+parser = argparse.ArgumentParser(
+ description="An example configuration script to run the gapbs
benchmarks."
+)
+
+# The only positional argument accepted is the benchmark name in this
script.
+
+parser.add_argument(
+ "--benchmark",
+ type=str,
+ required=True,
+ help="Input the benchmark program to execute.",
+ choices=benchmark_choices,
+)
+
+parser.add_argument(
+ "--synthetic",
+ type=str,
+ required=True,
+ help="Synthetic Graph:: 1: synthetic graph is True; 0: real graph",
+ choices=synthetic_choices,
+)
+
+parser.add_argument(
+ "--size",
+ type=str,
+ required=True,
+ help="Graph Size:: If synthetic is True, then specify a size [1 ..
15]. \
+ Otherwise, specify a graph name [USA-road-d.NY.gr]",
+ choices=size_choices,
+)
+
+args = parser.parse_args()
+
+# Setting up all the fixed system parameters here
+# Caches: MESI Two Level Cache Hierarchy
+
+from gem5.components.cachehierarchies.ruby.\
+ mesi_two_level_cache_hierarchy import(
+ MESITwoLevelCacheHierarchy,
+)
+
+cache_hierarchy = MESITwoLevelCacheHierarchy(
+ l1d_size="32kB",
+ l1d_assoc=8,
+ l1i_size="32kB",
+ l1i_assoc=8,
+ l2_size="256kB",
+ l2_assoc=16,
+ num_l2_banks=2,
+)
+# Memory: Single Channel DDR4 2400 DRAM device.
+# The X86 board only supports 3 GB of main memory.
+# We will replace single channel memory in the future.
+# Right now, multichannel memories does not work properly
+# with the x86 I/O hole.
+
+memory = SingleChannelDDR4_2400(size="3GB")
+
+# Here we setup the processor. This is a special switchable processor in
which
+# a starting core type and a switch core type must be specified. Once a
+# configuration is instantiated a user may call `processor.switch()` to
switch
+# from the starting core types to the switch core types. In this simulation
+# we start with KVM cores to simulate the OS boot, then switch to the
Timing
+# cores for the command we wish to run after boot.
+
+processor = SimpleSwitchableProcessor(
+ starting_core_type=CPUTypes.KVM,
+ switch_core_type=CPUTypes.TIMING,
+ num_cores=2,
+)
+
+# Here we setup the board. The X86Board allows for Full-System X86
simulations
+
+board = X86Board(
+ clk_freq="3GHz",
+ processor=processor,
+ memory=memory,
+ cache_hierarchy=cache_hierarchy,
+)
+
+# Here we set the FS workload, i.e., gapbs benchmark program
+# After simulation has ended you may inspect
+# `m5out/system.pc.com_1.device` to the stdout, if any.
+
+# After the system boots, we execute the benchmark program and wait till
the
+# ROI `workbegin` annotation is reached. We start collecting the number of
+# committed instructions till ROI ends (marked by `workend`). We then
finish
+# executing the rest of the benchmark.
+
+# GAPBS benchmarks can be run using a synthetic graph
+
+if args.synthetic == "1":
+ if args.size == "USA-road-d.NY.gr":
+ print("fatal: cannot use a real graph with --synthetic 1",
+ file=sys.stderr)
+ exit(-1)
+
+ command = "./{} -g {}\n".format(args.benchmark, args.size)
+else:
+ command = "./{} -sf ../{}".format(args.benchmark, args.size)
+
+board.set_kernel_disk_workload(
+ # The x86 linux kernel will be automatically downloaded to the
+ # `~/.cache/gem5` directory if not already present.
+ # gapbs benchamarks was tested with kernel version 4.19.83
+ kernel=Resource(
+ "x86-linux-kernel-4.19.83",
+ ),
+ # The x86-gapbs image will be automatically downloaded to the
+ # `~/.cache/gem5` directory if not already present.
+ disk_image=Resource(
+ "x86-gapbs",
+ ),
+ readfile_contents=command,
+)
+
+root = Root(full_system=True, system=board)
+
+# sim_quantum must be set when KVM cores are used.
+
+root.sim_quantum = int(1e9)
+
+m5.instantiate()
+
+# We maintain the wall clock time.
+
+globalStart = time.time()
+
+print("Running the simulation")
+print("Using KVM cpu")
+
+# There are a few thihngs to note regarding the gapbs benchamrks. The
first is
+# that there are several ROI annotations in the code present in the disk
image.
+# These ROI begin and end calls are inside a loop. Therefore, we only
simulate
+# the first ROI annotation in details. The X86Board currently does not
support
+# `work items started count reached`.
+
+exit_event = m5.simulate()
+
+# The first exit_event ends with a `workbegin` cause. This means that the
+# system started successfully and the execution on the program started. The
+# ROI begin is encountered.
+
+if exit_event.getCause() == "workbegin":
+
+ print("Done booting Linux")
+ print("Resetting stats at the start of ROI!")
+
+ m5.stats.reset()
+ start_tick = m5.curTick()
+
+ # We have completed up to this step using KVM cpu. Now we switch to
timing
+ # cpu for detailed simulation.
+
+ processor.switch()
+else:
+ print("Unexpected termination of simulation before ROI was reached!")
+ print(
+ "Exiting @ tick {} because {}.".format(
+ m5.curTick(),
+ exit_event.getCause()
+ )
+ )
+ exit(-1)
+
+# The next exit_event is to simulate the ROI. It should be exited with a
cause
+# marked by `workend`. This implies that the first annotation is
successfully
+# completed.
+
+exit_event = m5.simulate()
+
+# Reached the end of first ROI.
+# We dump the stats here.
+
+# We exepect that ROI ends with `workend`. Otherwise the simulation ended
+# unexpectedly.
+if exit_event.getCause() == "workend":
+ print("Dump stats at the end of the ROI!")
+
+ m5.stats.dump()
+ end_tick = m5.curTick()
+else:
+ print("Unexpected termination of simulation while ROI was being
executed!")
+ print(
+ "Exiting @ tick {} because {}.".format(
+ m5.curTick(),
+ exit_event.getCause()
+ )
+ )
+ exit(-1)
+
+# We get simInsts using get_simstat and output it in the final print
statement.
+
+gem5stats = get_simstat(root)
+
+# We get the number of committed instructions from the timing cores. We
then
+# sum and print them at the end.
+
+roi_insts = float(
+ json.loads(gem5stats.dumps())["system"]["processor"]["cores2"]["core"][
+ "exec_context.thread_0"
+ ]["numInsts"]["value"]
+) + float(
+ json.loads(gem5stats.dumps())["system"]["processor"]["cores3"]["core"][
+ "exec_context.thread_0"
+ ]["numInsts"]["value"]
+)
+
+# Since we simulated the ROI in details, therefore, simulation is over at
this
+# point.
+
+# Simulation is over at this point. We acknowledge that all the simulation
+# events were successful.
+print("All simulation events were successful.")
+
+# We print the final simulation statistics.
+print("Done with the simulation")
+print()
+print("Performance statistics:")
+
+print("Simulated time in ROI: %.2fs" % ((end_tick - start_tick) / 1e12))
+print("Instructions executed in ROI: %d" % ((roi_insts)))
+print("Ran a total of", m5.curTick() / 1e12, "simulated seconds")
+print(
+ "Total wallclock time: %.2fs, %.2f min"
+ % (time.time() - globalStart, (time.time() - globalStart) / 60)
+)
+exit(0)
+
diff --git
a/tests/gem5/gem5_library_example_tests/test_gem5_library_examples.py
b/tests/gem5/gem5_library_example_tests/test_gem5_library_examples.py
index abcc589..f48f85c 100644
--- a/tests/gem5/gem5_library_example_tests/test_gem5_library_examples.py
+++ b/tests/gem5/gem5_library_example_tests/test_gem5_library_examples.py
@@ -87,7 +87,7 @@
"gem5_library",
"x86-parsec-benchmarks.py",
),
- config_args=["--benchmark","blackscholes", "--size","simsmall"],
+ config_args=["--benchmark","blackscholes","--size","simsmall"],
valid_isas=(constants.x86_tag,),
protocol="MESI_Two_Level",
valid_hosts=constants.supported_hosts,
@@ -108,10 +108,30 @@
"gem5_library",
"x86-npb-benchmarks.py",
),
- config_args=["--benchmark","bt", "--size","A"],
+ config_args=["--benchmark","bt","--size","A"],
valid_isas=(constants.x86_tag,),
protocol="MESI_Two_Level",
valid_hosts=constants.supported_hosts,
length=constants.long_tag,
)
+if os.access("/dev/kvm", mode=os.R_OK | os.W_OK):
+ # The x86-ubuntu-run uses KVM cores, this test will therefore only be
run
+ # on systems that support KVM.
+ gem5_verify_config(
+ name="test-gem5-library-example-x86-gapbs-benchmarks",
+ fixtures=(),
+ verifiers=(),
+ config=joinpath(
+ config.base_dir,
+ "configs",
+ "example",
+ "gem5_library",
+ "x86-gapbs-benchmarks.py",
+ ),
+ config_args=["--benchmark","bfs","--synthetic","1","--size","1"],
+ valid_isas=(constants.x86_tag,),
+ protocol="MESI_Two_Level",
+ valid_hosts=constants.supported_hosts,
+ length=constants.long_tag,
+ )
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/53023
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: I10326cace4e6fa160e02e479fb4443277af3966f
Gerrit-Change-Number: 53023
Gerrit-PatchSet: 1
Gerrit-Owner: Kaustav Goswami <[email protected]>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
