Options.py revision 9790
19665Sandreas.hansson@arm.com# Copyright (c) 2013 ARM Limited 29665Sandreas.hansson@arm.com# All rights reserved. 39665Sandreas.hansson@arm.com# 49665Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 59665Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 69665Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 79665Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 89665Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 99665Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 109665Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 119665Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 129665Sandreas.hansson@arm.com# 135353Svilas.sridharan@gmail.com# Copyright (c) 2006-2008 The Regents of The University of Michigan 143395Shsul@eecs.umich.edu# All rights reserved. 153395Shsul@eecs.umich.edu# 163395Shsul@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 173395Shsul@eecs.umich.edu# modification, are permitted provided that the following conditions are 183395Shsul@eecs.umich.edu# met: redistributions of source code must retain the above copyright 193395Shsul@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 203395Shsul@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 213395Shsul@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 223395Shsul@eecs.umich.edu# documentation and/or other materials provided with the distribution; 233395Shsul@eecs.umich.edu# neither the name of the copyright holders nor the names of its 243395Shsul@eecs.umich.edu# contributors may be used to endorse or promote products derived from 253395Shsul@eecs.umich.edu# this software without specific prior written permission. 263395Shsul@eecs.umich.edu# 273395Shsul@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 283395Shsul@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 293395Shsul@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 303395Shsul@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 313395Shsul@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 323395Shsul@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 333395Shsul@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 343395Shsul@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 353395Shsul@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 363395Shsul@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 373395Shsul@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 383395Shsul@eecs.umich.edu# 393395Shsul@eecs.umich.edu# Authors: Lisa Hsu 403395Shsul@eecs.umich.edu 418920Snilay@cs.wisc.eduimport m5 428920Snilay@cs.wisc.edufrom m5.defines import buildEnv 438920Snilay@cs.wisc.edufrom m5.objects import * 448920Snilay@cs.wisc.edufrom Benchmarks import * 457025SBrad.Beckmann@amd.com 469520SAndreas.Sandberg@ARM.comimport CpuConfig 479665Sandreas.hansson@arm.comimport MemConfig 489520SAndreas.Sandberg@ARM.com 499520SAndreas.Sandberg@ARM.comdef _listCpuTypes(option, opt, value, parser): 509520SAndreas.Sandberg@ARM.com CpuConfig.print_cpu_list() 519520SAndreas.Sandberg@ARM.com sys.exit(0) 529520SAndreas.Sandberg@ARM.com 539665Sandreas.hansson@arm.comdef _listMemTypes(option, opt, value, parser): 549665Sandreas.hansson@arm.com MemConfig.print_mem_list() 559665Sandreas.hansson@arm.com sys.exit(0) 569665Sandreas.hansson@arm.com 578920Snilay@cs.wisc.edudef addCommonOptions(parser): 588920Snilay@cs.wisc.edu # system options 599520SAndreas.Sandberg@ARM.com parser.add_option("--list-cpu-types", 609520SAndreas.Sandberg@ARM.com action="callback", callback=_listCpuTypes, 619520SAndreas.Sandberg@ARM.com help="List available CPU types") 628920Snilay@cs.wisc.edu parser.add_option("--cpu-type", type="choice", default="atomic", 639520SAndreas.Sandberg@ARM.com choices=CpuConfig.cpu_names(), 648920Snilay@cs.wisc.edu help = "type of cpu to run with") 659665Sandreas.hansson@arm.com parser.add_option("--list-mem-types", 669665Sandreas.hansson@arm.com action="callback", callback=_listMemTypes, 679665Sandreas.hansson@arm.com help="List available memory types") 689665Sandreas.hansson@arm.com parser.add_option("--mem-type", type="choice", default="simple_mem", 699665Sandreas.hansson@arm.com choices=MemConfig.mem_names(), 709665Sandreas.hansson@arm.com help = "type of memory to use") 718920Snilay@cs.wisc.edu parser.add_option("--checker", action="store_true"); 728920Snilay@cs.wisc.edu parser.add_option("-n", "--num-cpus", type="int", default=1) 738920Snilay@cs.wisc.edu parser.add_option("--caches", action="store_true") 748920Snilay@cs.wisc.edu parser.add_option("--l2cache", action="store_true") 758920Snilay@cs.wisc.edu parser.add_option("--fastmem", action="store_true") 769647Sdam.sunwoo@arm.com parser.add_option("--simpoint-profile", action="store_true", 779647Sdam.sunwoo@arm.com help="Enable basic block profiling for SimPoints") 789647Sdam.sunwoo@arm.com parser.add_option("--simpoint-interval", type="int", default=10000000, 799647Sdam.sunwoo@arm.com help="SimPoint interval in num of instructions") 808920Snilay@cs.wisc.edu parser.add_option("--clock", action="store", type="string", default='2GHz') 819790Sakash.bagdia@arm.com parser.add_option("--sys-clock", action="store", type="string", 829790Sakash.bagdia@arm.com default='1GHz', 839790Sakash.bagdia@arm.com help = """Top-level clock for blocks running at system 849790Sakash.bagdia@arm.com speed""") 859789Sakash.bagdia@arm.com parser.add_option("--cpu-clock", action="store", type="string", 869789Sakash.bagdia@arm.com default='2GHz', 879789Sakash.bagdia@arm.com help="Clock for blocks running at CPU speed") 888920Snilay@cs.wisc.edu parser.add_option("--num-dirs", type="int", default=1) 898920Snilay@cs.wisc.edu parser.add_option("--num-l2caches", type="int", default=1) 908920Snilay@cs.wisc.edu parser.add_option("--num-l3caches", type="int", default=1) 918920Snilay@cs.wisc.edu parser.add_option("--l1d_size", type="string", default="64kB") 928920Snilay@cs.wisc.edu parser.add_option("--l1i_size", type="string", default="32kB") 938920Snilay@cs.wisc.edu parser.add_option("--l2_size", type="string", default="2MB") 948920Snilay@cs.wisc.edu parser.add_option("--l3_size", type="string", default="16MB") 958920Snilay@cs.wisc.edu parser.add_option("--l1d_assoc", type="int", default=2) 968920Snilay@cs.wisc.edu parser.add_option("--l1i_assoc", type="int", default=2) 978920Snilay@cs.wisc.edu parser.add_option("--l2_assoc", type="int", default=8) 988920Snilay@cs.wisc.edu parser.add_option("--l3_assoc", type="int", default=16) 998920Snilay@cs.wisc.edu parser.add_option("--cacheline_size", type="int", default=64) 1008920Snilay@cs.wisc.edu parser.add_option("--ruby", action="store_true") 1019197Snilay@cs.wisc.edu parser.add_option("--smt", action="store_true", default=False, 1029197Snilay@cs.wisc.edu help = """ 1039197Snilay@cs.wisc.edu Only used if multiple programs are specified. If true, 1049197Snilay@cs.wisc.edu then the number of threads per cpu is same as the 1059197Snilay@cs.wisc.edu number of programs.""") 1063395Shsul@eecs.umich.edu 1078920Snilay@cs.wisc.edu # Run duration options 1088920Snilay@cs.wisc.edu parser.add_option("-m", "--maxtick", type="int", default=m5.MaxTick, 1098920Snilay@cs.wisc.edu metavar="T", help="Stop after T ticks") 1108920Snilay@cs.wisc.edu parser.add_option("--maxtime", type="float") 1118920Snilay@cs.wisc.edu parser.add_option("-I", "--maxinsts", action="store", type="int", 1128920Snilay@cs.wisc.edu default=None, help="""Total number of instructions to 1138920Snilay@cs.wisc.edu simulate (default: run forever)""") 1148920Snilay@cs.wisc.edu parser.add_option("--work-item-id", action="store", type="int", 1158920Snilay@cs.wisc.edu help="the specific work id for exit & checkpointing") 1168920Snilay@cs.wisc.edu parser.add_option("--work-begin-cpu-id-exit", action="store", type="int", 1178920Snilay@cs.wisc.edu help="exit when work starts on the specified cpu") 1188920Snilay@cs.wisc.edu parser.add_option("--work-end-exit-count", action="store", type="int", 1198920Snilay@cs.wisc.edu help="exit at specified work end count") 1208920Snilay@cs.wisc.edu parser.add_option("--work-begin-exit-count", action="store", type="int", 1218920Snilay@cs.wisc.edu help="exit at specified work begin count") 1228920Snilay@cs.wisc.edu parser.add_option("--init-param", action="store", type="int", default=0, 1238920Snilay@cs.wisc.edu help="""Parameter available in simulation with m5 1248920Snilay@cs.wisc.edu initparam""") 1256776SBrad.Beckmann@amd.com 1268920Snilay@cs.wisc.edu # Checkpointing options 1278920Snilay@cs.wisc.edu ###Note that performing checkpointing via python script files will override 1288920Snilay@cs.wisc.edu ###checkpoint instructions built into binaries. 1298920Snilay@cs.wisc.edu parser.add_option("--take-checkpoints", action="store", type="string", 1309357Sandreas.hansson@arm.com help="<M,N> take checkpoints at tick M and every N ticks thereafter") 1318920Snilay@cs.wisc.edu parser.add_option("--max-checkpoints", action="store", type="int", 1328920Snilay@cs.wisc.edu help="the maximum number of checkpoints to drop", default=5) 1338920Snilay@cs.wisc.edu parser.add_option("--checkpoint-dir", action="store", type="string", 1348920Snilay@cs.wisc.edu help="Place all checkpoints in this absolute directory") 1358920Snilay@cs.wisc.edu parser.add_option("-r", "--checkpoint-restore", action="store", type="int", 1368920Snilay@cs.wisc.edu help="restore from checkpoint <N>") 1378920Snilay@cs.wisc.edu parser.add_option("--checkpoint-at-end", action="store_true", 1388920Snilay@cs.wisc.edu help="take a checkpoint at end of run") 1398920Snilay@cs.wisc.edu parser.add_option("--work-begin-checkpoint-count", action="store", type="int", 1408920Snilay@cs.wisc.edu help="checkpoint at specified work begin count") 1418920Snilay@cs.wisc.edu parser.add_option("--work-end-checkpoint-count", action="store", type="int", 1428920Snilay@cs.wisc.edu help="checkpoint at specified work end count") 1438920Snilay@cs.wisc.edu parser.add_option("--work-cpus-checkpoint-count", action="store", type="int", 1448920Snilay@cs.wisc.edu help="checkpoint and exit when active cpu count is reached") 1458920Snilay@cs.wisc.edu parser.add_option("--restore-with-cpu", action="store", type="choice", 1469736Sandreas@sandberg.pp.se default="atomic", choices=CpuConfig.cpu_names(), 1478920Snilay@cs.wisc.edu help = "cpu type for restoring from a checkpoint") 1483395Shsul@eecs.umich.edu 1495361Srstrong@cs.ucsd.edu 1508920Snilay@cs.wisc.edu # CPU Switching - default switch model goes from a checkpoint 1518920Snilay@cs.wisc.edu # to a timing simple CPU with caches to warm up, then to detailed CPU for 1528920Snilay@cs.wisc.edu # data measurement 1539151Satgutier@umich.edu parser.add_option("--repeat-switch", action="store", type="int", 1549151Satgutier@umich.edu default=None, 1559151Satgutier@umich.edu help="switch back and forth between CPUs with period <N>") 1569151Satgutier@umich.edu parser.add_option("-s", "--standard-switch", action="store", type="int", 1579151Satgutier@umich.edu default=None, 1589151Satgutier@umich.edu help="switch from timing to Detailed CPU after warmup period of <N>") 1599562Ssaidi@eecs.umich.edu parser.add_option("-p", "--prog-interval", type="str", 1608920Snilay@cs.wisc.edu help="CPU Progress Interval") 1618920Snilay@cs.wisc.edu 1628920Snilay@cs.wisc.edu # Fastforwarding and simpoint related materials 1638920Snilay@cs.wisc.edu parser.add_option("-W", "--warmup-insts", action="store", type="int", 1648920Snilay@cs.wisc.edu default=None, 1658920Snilay@cs.wisc.edu help="Warmup period in total instructions (requires --standard-switch)") 1668920Snilay@cs.wisc.edu parser.add_option("--bench", action="store", type="string", default=None, 1678920Snilay@cs.wisc.edu help="base names for --take-checkpoint and --checkpoint-restore") 1688920Snilay@cs.wisc.edu parser.add_option("-F", "--fast-forward", action="store", type="string", 1698920Snilay@cs.wisc.edu default=None, 1708920Snilay@cs.wisc.edu help="Number of instructions to fast forward before switching") 1718920Snilay@cs.wisc.edu parser.add_option("-S", "--simpoint", action="store_true", default=False, 1728920Snilay@cs.wisc.edu help="""Use workload simpoints as an instruction offset for 1738920Snilay@cs.wisc.edu --checkpoint-restore or --take-checkpoint.""") 1748920Snilay@cs.wisc.edu parser.add_option("--at-instruction", action="store_true", default=False, 1758920Snilay@cs.wisc.edu help="""Treat value of --checkpoint-restore or --take-checkpoint as a 1768920Snilay@cs.wisc.edu number of instructions.""") 1778920Snilay@cs.wisc.edu 1788920Snilay@cs.wisc.edudef addSEOptions(parser): 1798920Snilay@cs.wisc.edu # Benchmark options 1808920Snilay@cs.wisc.edu parser.add_option("-c", "--cmd", default="", 1818920Snilay@cs.wisc.edu help="The binary to run in syscall emulation mode.") 1828920Snilay@cs.wisc.edu parser.add_option("-o", "--options", default="", 1838920Snilay@cs.wisc.edu help="""The options to pass to the binary, use " " 1848920Snilay@cs.wisc.edu around the entire string""") 1858920Snilay@cs.wisc.edu parser.add_option("-i", "--input", default="", 1868920Snilay@cs.wisc.edu help="Read stdin from a file.") 1878920Snilay@cs.wisc.edu parser.add_option("--output", default="", 1888920Snilay@cs.wisc.edu help="Redirect stdout to a file.") 1898920Snilay@cs.wisc.edu parser.add_option("--errout", default="", 1908920Snilay@cs.wisc.edu help="Redirect stderr to a file.") 1918920Snilay@cs.wisc.edu 1928920Snilay@cs.wisc.edudef addFSOptions(parser): 1938920Snilay@cs.wisc.edu # Simulation options 1948920Snilay@cs.wisc.edu parser.add_option("--timesync", action="store_true", 1958920Snilay@cs.wisc.edu help="Prevent simulated time from getting ahead of real time") 1968920Snilay@cs.wisc.edu 1978920Snilay@cs.wisc.edu # System options 1988920Snilay@cs.wisc.edu parser.add_option("--kernel", action="store", type="string") 1998920Snilay@cs.wisc.edu parser.add_option("--script", action="store", type="string") 2008920Snilay@cs.wisc.edu parser.add_option("--frame-capture", action="store_true", 2018920Snilay@cs.wisc.edu help="Stores changed frame buffers from the VNC server to compressed "\ 2028920Snilay@cs.wisc.edu "files in the gem5 output directory") 2038920Snilay@cs.wisc.edu 2048920Snilay@cs.wisc.edu if buildEnv['TARGET_ISA'] == "arm": 2058920Snilay@cs.wisc.edu parser.add_option("--bare-metal", action="store_true", 2068920Snilay@cs.wisc.edu help="Provide the raw system without the linux specific bits") 2078920Snilay@cs.wisc.edu parser.add_option("--machine-type", action="store", type="choice", 2088920Snilay@cs.wisc.edu choices=ArmMachineType.map.keys(), default="RealView_PBX") 2099539Satgutier@umich.edu parser.add_option("--dtb-filename", action="store", type="string", 2109539Satgutier@umich.edu help="Specifies device tree blob file to use with device-tree-"\ 2119539Satgutier@umich.edu "enabled kernels") 2128920Snilay@cs.wisc.edu # Benchmark options 2138920Snilay@cs.wisc.edu parser.add_option("--dual", action="store_true", 2148920Snilay@cs.wisc.edu help="Simulate two systems attached with an ethernet link") 2158920Snilay@cs.wisc.edu parser.add_option("-b", "--benchmark", action="store", type="string", 2168920Snilay@cs.wisc.edu dest="benchmark", 2178920Snilay@cs.wisc.edu help="Specify the benchmark to run. Available benchmarks: %s"\ 2188920Snilay@cs.wisc.edu % DefinedBenchmarks) 2198920Snilay@cs.wisc.edu 2208920Snilay@cs.wisc.edu # Metafile options 2218920Snilay@cs.wisc.edu parser.add_option("--etherdump", action="store", type="string", dest="etherdump", 2228920Snilay@cs.wisc.edu help="Specify the filename to dump a pcap capture of the" \ 2238920Snilay@cs.wisc.edu "ethernet traffic") 2248956Sjayneel@cs.wisc.edu 2258956Sjayneel@cs.wisc.edu # Disk Image Options 2268956Sjayneel@cs.wisc.edu parser.add_option("--disk-image", action="store", type="string", default=None, 2278956Sjayneel@cs.wisc.edu help="Path to the disk image to use.") 2288956Sjayneel@cs.wisc.edu 2298956Sjayneel@cs.wisc.edu # Memory Size Options 2308956Sjayneel@cs.wisc.edu parser.add_option("--mem-size", action="store", type="string", default=None, 2318976Sjayneel@cs.wisc.edu help="Specify the physical memory size (single memory)") 232