-# Copyright (c) 2013 ARM Limited
+# Copyright (c) 2013-2020 ARM Limited
# All rights reserved.
#
# The license below extends only to copyright in the software and shall
# 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.
-#
-# Authors: Lisa Hsu
+
+from __future__ import print_function
+from __future__ import absolute_import
import m5
from m5.defines import buildEnv
from m5.objects import *
-from Benchmarks import *
-import CpuConfig
-import MemConfig
+from common.Benchmarks import *
+from common import ObjectList
+
+vio_9p_help = """\
+Enable the Virtio 9P device and set the path to share. The default 9p path is
+m5ou5/9p/share, and it can be changed by setting VirtIO9p.root with --param. A
+sample guest mount command is: "mount -t 9p -o
+trans=virtio,version=9p2000.L,aname=<host-full-path> gem5 /mnt/9p" where
+"<host-full-path>" is the full path being shared on the host, and "gem5" is a
+fixed mount tag. This option requires the diod 9P server to be installed in the
+host PATH or selected with with: VirtIO9PDiod.diod.
+"""
def _listCpuTypes(option, opt, value, parser):
- CpuConfig.print_cpu_list()
+ ObjectList.cpu_list.print()
+ sys.exit(0)
+
+def _listBPTypes(option, opt, value, parser):
+ ObjectList.bp_list.print()
+ sys.exit(0)
+
+def _listHWPTypes(option, opt, value, parser):
+ ObjectList.hwp_list.print()
+ sys.exit(0)
+
+def _listIndirectBPTypes(option, opt, value, parser):
+ ObjectList.indirect_bp_list.print()
sys.exit(0)
def _listMemTypes(option, opt, value, parser):
- MemConfig.print_mem_list()
+ ObjectList.mem_list.print()
sys.exit(0)
-def addCommonOptions(parser):
- # system options
- parser.add_option("--list-cpu-types",
- action="callback", callback=_listCpuTypes,
- help="List available CPU types")
- parser.add_option("--cpu-type", type="choice", default="atomic",
- choices=CpuConfig.cpu_names(),
- help = "type of cpu to run with")
- parser.add_option("--checker", action="store_true");
+def _listPlatformTypes(option, opt, value, parser):
+ ObjectList.platform_list.print()
+ sys.exit(0)
+
+# Add the very basic options that work also in the case of the no ISA
+# being used, and consequently no CPUs, but rather various types of
+# testers and traffic generators.
+def addNoISAOptions(parser):
parser.add_option("-n", "--num-cpus", type="int", default=1)
parser.add_option("--sys-voltage", action="store", type="string",
default='1.0V',
default='1GHz',
help = """Top-level clock for blocks running at system
speed""")
- parser.add_option("--cpu-clock", action="store", type="string",
- default='2GHz',
- help="Clock for blocks running at CPU speed")
- parser.add_option("--smt", action="store_true", default=False,
- help = """
- Only used if multiple programs are specified. If true,
- then the number of threads per cpu is same as the
- number of programs.""")
# Memory Options
parser.add_option("--list-mem-types",
action="callback", callback=_listMemTypes,
help="List available memory types")
- parser.add_option("--mem-type", type="choice", default="ddr3_1600_x64",
- choices=MemConfig.mem_names(),
+ parser.add_option("--mem-type", type="choice", default="DDR3_1600_8x8",
+ choices=ObjectList.mem_list.get_names(),
help = "type of memory to use")
parser.add_option("--mem-channels", type="int", default=1,
help = "number of memory channels")
+ parser.add_option("--mem-ranks", type="int", default=None,
+ help = "number of memory ranks per channel")
parser.add_option("--mem-size", action="store", type="string",
default="512MB",
help="Specify the physical memory size (single memory)")
+ parser.add_option("--enable-dram-powerdown", action="store_true",
+ help="Enable low-power states in DRAMInterface")
+ parser.add_option("--mem-channels-intlv", type="int", default=0,
+ help="Memory channels interleave")
- parser.add_option("-l", "--lpae", action="store_true")
- parser.add_option("-V", "--virtualisation", action="store_true")
+
+ parser.add_option("--memchecker", action="store_true")
# Cache Options
+ parser.add_option("--external-memory-system", type="string",
+ help="use external ports of this port_type for caches")
+ parser.add_option("--tlm-memory", type="string",
+ help="use external port for SystemC TLM cosimulation")
parser.add_option("--caches", action="store_true")
parser.add_option("--l2cache", action="store_true")
- parser.add_option("--fastmem", action="store_true")
parser.add_option("--num-dirs", type="int", default=1)
parser.add_option("--num-l2caches", type="int", default=1)
parser.add_option("--num-l3caches", type="int", default=1)
# Run duration options
parser.add_option("-m", "--abs-max-tick", type="int", default=m5.MaxTick,
- metavar="TICKS", help="Run to absolute simulated tick " \
+ metavar="TICKS", help="Run to absolute simulated tick "
"specified including ticks from a restored checkpoint")
parser.add_option("--rel-max-tick", type="int", default=None,
- metavar="TICKS", help="Simulate for specified number of" \
- " ticks relative to the simulation start tick (e.g. if " \
+ metavar="TICKS", help="Simulate for specified number of"
+ " ticks relative to the simulation start tick (e.g. if "
"restoring a checkpoint)")
parser.add_option("--maxtime", type="float", default=None,
- help="Run to the specified absolute simulated time in " \
+ help="Run to the specified absolute simulated time in "
"seconds")
+ parser.add_option("-P", "--param", action="append", default=[],
+ help="Set a SimObject parameter relative to the root node. "
+ "An extended Python multi range slicing syntax can be used "
+ "for arrays. For example: "
+ "'system.cpu[0,1,3:8:2].max_insts_all_threads = 42' "
+ "sets max_insts_all_threads for cpus 0, 1, 3, 5 and 7 "
+ "Direct parameters of the root object are not accessible, "
+ "only parameters of its children.")
+
+# Add common options that assume a non-NULL ISA.
+def addCommonOptions(parser):
+ # start by adding the base options that do not assume an ISA
+ addNoISAOptions(parser)
+
+ # system options
+ parser.add_option("--list-cpu-types",
+ action="callback", callback=_listCpuTypes,
+ help="List available CPU types")
+ parser.add_option("--cpu-type", type="choice", default="AtomicSimpleCPU",
+ choices=ObjectList.cpu_list.get_names(),
+ help = "type of cpu to run with")
+ parser.add_option("--list-bp-types",
+ action="callback", callback=_listBPTypes,
+ help="List available branch predictor types")
+ parser.add_option("--list-indirect-bp-types",
+ action="callback", callback=_listIndirectBPTypes,
+ help="List available indirect branch predictor types")
+ parser.add_option("--bp-type", type="choice", default=None,
+ choices=ObjectList.bp_list.get_names(),
+ help = """
+ type of branch predictor to run with
+ (if not set, use the default branch predictor of
+ the selected CPU)""")
+ parser.add_option("--indirect-bp-type", type="choice", default=None,
+ choices=ObjectList.indirect_bp_list.get_names(),
+ help = "type of indirect branch predictor to run with")
+ parser.add_option("--list-hwp-types",
+ action="callback", callback=_listHWPTypes,
+ help="List available hardware prefetcher types")
+ parser.add_option("--l1i-hwp-type", type="choice", default=None,
+ choices=ObjectList.hwp_list.get_names(),
+ help = """
+ type of hardware prefetcher to use with the L1
+ instruction cache.
+ (if not set, use the default prefetcher of
+ the selected cache)""")
+ parser.add_option("--l1d-hwp-type", type="choice", default=None,
+ choices=ObjectList.hwp_list.get_names(),
+ help = """
+ type of hardware prefetcher to use with the L1
+ data cache.
+ (if not set, use the default prefetcher of
+ the selected cache)""")
+ parser.add_option("--l2-hwp-type", type="choice", default=None,
+ choices=ObjectList.hwp_list.get_names(),
+ help = """
+ type of hardware prefetcher to use with the L2 cache.
+ (if not set, use the default prefetcher of
+ the selected cache)""")
+ parser.add_option("--checker", action="store_true");
+ parser.add_option("--cpu-clock", action="store", type="string",
+ default='2GHz',
+ help="Clock for blocks running at CPU speed")
+ parser.add_option("--smt", action="store_true", default=False,
+ help = """
+ Only used if multiple programs are specified. If true,
+ then the number of threads per cpu is same as the
+ number of programs.""")
+ parser.add_option("--elastic-trace-en", action="store_true",
+ help="""Enable capture of data dependency and instruction
+ fetch traces using elastic trace probe.""")
+ # Trace file paths input to trace probe in a capture simulation and input
+ # to Trace CPU in a replay simulation
+ parser.add_option("--inst-trace-file", action="store", type="string",
+ help="""Instruction fetch trace file input to
+ Elastic Trace probe in a capture simulation and
+ Trace CPU in a replay simulation""", default="")
+ parser.add_option("--data-trace-file", action="store", type="string",
+ help="""Data dependency trace file input to
+ Elastic Trace probe in a capture simulation and
+ Trace CPU in a replay simulation""", default="")
+
+ parser.add_option("-l", "--lpae", action="store_true")
+ parser.add_option("-V", "--virtualisation", action="store_true")
+
+ # dist-gem5 options
+ parser.add_option("--dist", action="store_true",
+ help="Parallel distributed gem5 simulation.")
+ parser.add_option("--dist-sync-on-pseudo-op", action="store_true",
+ help="Use a pseudo-op to start dist-gem5 synchronization.")
+ parser.add_option("--is-switch", action="store_true",
+ help="Select the network switch simulator process for a"\
+ "distributed gem5 run")
+ parser.add_option("--dist-rank", default=0, action="store", type="int",
+ help="Rank of this system within the dist gem5 run.")
+ parser.add_option("--dist-size", default=0, action="store", type="int",
+ help="Number of gem5 processes within the dist gem5 run.")
+ parser.add_option("--dist-server-name",
+ default="127.0.0.1",
+ action="store", type="string",
+ help="Name of the message server host\nDEFAULT: localhost")
+ parser.add_option("--dist-server-port",
+ default=2200,
+ action="store", type="int",
+ help="Message server listen port\nDEFAULT: 2200")
+ parser.add_option("--dist-sync-repeat",
+ default="0us",
+ action="store", type="string",
+ help="Repeat interval for synchronisation barriers among dist-gem5 processes\nDEFAULT: --ethernet-linkdelay")
+ parser.add_option("--dist-sync-start",
+ default="5200000000000t",
+ action="store", type="string",
+ help="Time to schedule the first dist synchronisation barrier\nDEFAULT:5200000000000t")
+ parser.add_option("--ethernet-linkspeed", default="10Gbps",
+ action="store", type="string",
+ help="Link speed in bps\nDEFAULT: 10Gbps")
+ parser.add_option("--ethernet-linkdelay", default="10us",
+ action="store", type="string",
+ help="Link delay in seconds\nDEFAULT: 10us")
+
+ # Run duration options
parser.add_option("-I", "--maxinsts", action="store", type="int",
default=None, help="""Total number of instructions to
simulate (default: run forever)""")
parser.add_option("--init-param", action="store", type="int", default=0,
help="""Parameter available in simulation with m5
initparam""")
+ parser.add_option("--initialize-only", action="store_true", default=False,
+ help="""Exit after initialization. Do not simulate time.
+ Useful when gem5 is run as a library.""")
# Simpoint options
parser.add_option("--simpoint-profile", action="store_true",
parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
help="checkpoint and exit when active cpu count is reached")
parser.add_option("--restore-with-cpu", action="store", type="choice",
- default="atomic", choices=CpuConfig.cpu_names(),
+ default="AtomicSimpleCPU",
+ choices=ObjectList.cpu_list.get_names(),
help = "cpu type for restoring from a checkpoint")
parser.add_option("--arm-iset", default="arm", type="choice",
choices=["arm", "thumb", "aarch64"],
help="ARM instruction set.")
+ parser.add_option("--stats-root", action="append", default=[], help=
+ "If given, dump only stats of objects under the given SimObject. "
+ "SimObjects are identified with Python notation as in: "
+ "system.cpu[0].mmu. All elements of an array can be selected at "
+ "once with: system.cpu[:].mmu. If given multiple times, dump stats "
+ "that are present under any of the roots. If not given, dump all "
+ "stats. "
+ )
def addSEOptions(parser):
parser.add_option("-o", "--options", default="",
help="""The options to pass to the binary, use " "
around the entire string""")
+ parser.add_option("-e", "--env", default="",
+ help="Initialize workload environment from text file.")
parser.add_option("-i", "--input", default="",
help="Read stdin from a file.")
parser.add_option("--output", default="",
help="Redirect stdout to a file.")
parser.add_option("--errout", default="",
help="Redirect stderr to a file.")
+ parser.add_option("--chroot", action="store", type="string", default=None,
+ help="The chroot option allows a user to alter the " \
+ "search path for processes running in SE mode. " \
+ "Normally, the search path would begin at the " \
+ "root of the filesystem (i.e. /). With chroot, " \
+ "a user can force the process to begin looking at" \
+ "some other location (i.e. /home/user/rand_dir)." \
+ "The intended use is to trick sophisticated " \
+ "software which queries the __HOST__ filesystem " \
+ "for information or functionality. Instead of " \
+ "finding files on the __HOST__ filesystem, the " \
+ "process will find the user's replacment files.")
+ parser.add_option("--interp-dir", action="store", type="string",
+ default=None,
+ help="The interp-dir option is used for "
+ "setting the interpreter's path. This will "
+ "allow to load the guest dynamic linker/loader "
+ "itself from the elf binary. The option points to "
+ "the parent folder of the guest /lib in the "
+ "host fs")
+
+ parser.add_option("--redirects", action="append", type="string",
+ default=[],
+ help="A collection of one or more redirect paths "
+ "to be used in syscall emulation."
+ "Usage: gem5.opt [...] --redirects /dir1=/path/"
+ "to/host/dir1 --redirects /dir2=/path/to/host/dir2")
+ parser.add_option("--wait-gdb", default=False,
+ help="Wait for remote GDB to connect.")
+
+
def addFSOptions(parser):
+ from common.FSConfig import os_types
+
# Simulation options
parser.add_option("--timesync", action="store_true",
help="Prevent simulated time from getting ahead of real time")
# System options
parser.add_option("--kernel", action="store", type="string")
+ parser.add_option("--os-type", action="store", type="choice",
+ choices=os_types[str(buildEnv['TARGET_ISA'])],
+ default="linux",
+ help="Specifies type of OS to boot")
parser.add_option("--script", action="store", type="string")
parser.add_option("--frame-capture", action="store_true",
help="Stores changed frame buffers from the VNC server to compressed "\
if buildEnv['TARGET_ISA'] == "arm":
parser.add_option("--bare-metal", action="store_true",
help="Provide the raw system without the linux specific bits")
+ parser.add_option("--list-machine-types",
+ action="callback", callback=_listPlatformTypes,
+ help="List available platform types")
parser.add_option("--machine-type", action="store", type="choice",
- choices=ArmMachineType.map.keys(), default="VExpress_EMM")
+ choices=ObjectList.platform_list.get_names(),
+ default="VExpress_GEM5_V1")
parser.add_option("--dtb-filename", action="store", type="string",
help="Specifies device tree blob file to use with device-tree-"\
"enabled kernels")
+ parser.add_option("--enable-security-extensions", action="store_true",
+ help="Turn on the ARM Security Extensions")
parser.add_option("--enable-context-switch-stats-dump", \
action="store_true", help="Enable stats dump at context "\
"switches and dump tasks file (required for Streamline)")
+ parser.add_option("--vio-9p", action="store_true", help=vio_9p_help)
+ parser.add_option("--bootloader", action='append',
+ help="executable file that runs before the --kernel")
# Benchmark options
parser.add_option("--dual", action="store_true",
"ethernet traffic")
# Disk Image Options
- parser.add_option("--disk-image", action="store", type="string", default=None,
- help="Path to the disk image to use.")
+ parser.add_option("--disk-image", action="append", type="string",
+ default=[], help="Path to the disk images to use.")
+ parser.add_option("--root-device", action="store", type="string",
+ default=None, help="OS device name for root partition")
# Command line options
parser.add_option("--command-line", action="store", type="string",
projects / gem5.git / blobdiff