Options.py revision 9520
15353Svilas.sridharan@gmail.com# Copyright (c) 2006-2008 The Regents of The University of Michigan 23395Shsul@eecs.umich.edu# All rights reserved. 33395Shsul@eecs.umich.edu# 43395Shsul@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 53395Shsul@eecs.umich.edu# modification, are permitted provided that the following conditions are 63395Shsul@eecs.umich.edu# met: redistributions of source code must retain the above copyright 73395Shsul@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 83395Shsul@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 93395Shsul@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 103395Shsul@eecs.umich.edu# documentation and/or other materials provided with the distribution; 113395Shsul@eecs.umich.edu# neither the name of the copyright holders nor the names of its 123395Shsul@eecs.umich.edu# contributors may be used to endorse or promote products derived from 133395Shsul@eecs.umich.edu# this software without specific prior written permission. 143395Shsul@eecs.umich.edu# 153395Shsul@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 163395Shsul@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 173395Shsul@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 183395Shsul@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 193395Shsul@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 203395Shsul@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 213395Shsul@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 223395Shsul@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 233395Shsul@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 243395Shsul@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 253395Shsul@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 263395Shsul@eecs.umich.edu# 273395Shsul@eecs.umich.edu# Authors: Lisa Hsu 283395Shsul@eecs.umich.edu 298920Snilay@cs.wisc.eduimport m5 308920Snilay@cs.wisc.edufrom m5.defines import buildEnv 318920Snilay@cs.wisc.edufrom m5.objects import * 328920Snilay@cs.wisc.edufrom Benchmarks import * 337025SBrad.Beckmann@amd.com 349520SAndreas.Sandberg@ARM.comimport CpuConfig 359520SAndreas.Sandberg@ARM.com 369520SAndreas.Sandberg@ARM.comdef _listCpuTypes(option, opt, value, parser): 379520SAndreas.Sandberg@ARM.com CpuConfig.print_cpu_list() 389520SAndreas.Sandberg@ARM.com sys.exit(0) 399520SAndreas.Sandberg@ARM.com 408920Snilay@cs.wisc.edudef addCommonOptions(parser): 418920Snilay@cs.wisc.edu # system options 429520SAndreas.Sandberg@ARM.com parser.add_option("--list-cpu-types", 439520SAndreas.Sandberg@ARM.com action="callback", callback=_listCpuTypes, 449520SAndreas.Sandberg@ARM.com help="List available CPU types") 458920Snilay@cs.wisc.edu parser.add_option("--cpu-type", type="choice", default="atomic", 469520SAndreas.Sandberg@ARM.com choices=CpuConfig.cpu_names(), 478920Snilay@cs.wisc.edu help = "type of cpu to run with") 488920Snilay@cs.wisc.edu parser.add_option("--checker", action="store_true"); 498920Snilay@cs.wisc.edu parser.add_option("-n", "--num-cpus", type="int", default=1) 508920Snilay@cs.wisc.edu parser.add_option("--caches", action="store_true") 518920Snilay@cs.wisc.edu parser.add_option("--l2cache", action="store_true") 528920Snilay@cs.wisc.edu parser.add_option("--fastmem", action="store_true") 538920Snilay@cs.wisc.edu parser.add_option("--clock", action="store", type="string", default='2GHz') 548920Snilay@cs.wisc.edu parser.add_option("--num-dirs", type="int", default=1) 558920Snilay@cs.wisc.edu parser.add_option("--num-l2caches", type="int", default=1) 568920Snilay@cs.wisc.edu parser.add_option("--num-l3caches", type="int", default=1) 578920Snilay@cs.wisc.edu parser.add_option("--l1d_size", type="string", default="64kB") 588920Snilay@cs.wisc.edu parser.add_option("--l1i_size", type="string", default="32kB") 598920Snilay@cs.wisc.edu parser.add_option("--l2_size", type="string", default="2MB") 608920Snilay@cs.wisc.edu parser.add_option("--l3_size", type="string", default="16MB") 618920Snilay@cs.wisc.edu parser.add_option("--l1d_assoc", type="int", default=2) 628920Snilay@cs.wisc.edu parser.add_option("--l1i_assoc", type="int", default=2) 638920Snilay@cs.wisc.edu parser.add_option("--l2_assoc", type="int", default=8) 648920Snilay@cs.wisc.edu parser.add_option("--l3_assoc", type="int", default=16) 658920Snilay@cs.wisc.edu parser.add_option("--cacheline_size", type="int", default=64) 668920Snilay@cs.wisc.edu parser.add_option("--ruby", action="store_true") 679197Snilay@cs.wisc.edu parser.add_option("--smt", action="store_true", default=False, 689197Snilay@cs.wisc.edu help = """ 699197Snilay@cs.wisc.edu Only used if multiple programs are specified. If true, 709197Snilay@cs.wisc.edu then the number of threads per cpu is same as the 719197Snilay@cs.wisc.edu number of programs.""") 723395Shsul@eecs.umich.edu 738920Snilay@cs.wisc.edu # Run duration options 748920Snilay@cs.wisc.edu parser.add_option("-m", "--maxtick", type="int", default=m5.MaxTick, 758920Snilay@cs.wisc.edu metavar="T", help="Stop after T ticks") 768920Snilay@cs.wisc.edu parser.add_option("--maxtime", type="float") 778920Snilay@cs.wisc.edu parser.add_option("-I", "--maxinsts", action="store", type="int", 788920Snilay@cs.wisc.edu default=None, help="""Total number of instructions to 798920Snilay@cs.wisc.edu simulate (default: run forever)""") 808920Snilay@cs.wisc.edu parser.add_option("--work-item-id", action="store", type="int", 818920Snilay@cs.wisc.edu help="the specific work id for exit & checkpointing") 828920Snilay@cs.wisc.edu parser.add_option("--work-begin-cpu-id-exit", action="store", type="int", 838920Snilay@cs.wisc.edu help="exit when work starts on the specified cpu") 848920Snilay@cs.wisc.edu parser.add_option("--work-end-exit-count", action="store", type="int", 858920Snilay@cs.wisc.edu help="exit at specified work end count") 868920Snilay@cs.wisc.edu parser.add_option("--work-begin-exit-count", action="store", type="int", 878920Snilay@cs.wisc.edu help="exit at specified work begin count") 888920Snilay@cs.wisc.edu parser.add_option("--init-param", action="store", type="int", default=0, 898920Snilay@cs.wisc.edu help="""Parameter available in simulation with m5 908920Snilay@cs.wisc.edu initparam""") 916776SBrad.Beckmann@amd.com 928920Snilay@cs.wisc.edu # Checkpointing options 938920Snilay@cs.wisc.edu ###Note that performing checkpointing via python script files will override 948920Snilay@cs.wisc.edu ###checkpoint instructions built into binaries. 958920Snilay@cs.wisc.edu parser.add_option("--take-checkpoints", action="store", type="string", 969357Sandreas.hansson@arm.com help="<M,N> take checkpoints at tick M and every N ticks thereafter") 978920Snilay@cs.wisc.edu parser.add_option("--max-checkpoints", action="store", type="int", 988920Snilay@cs.wisc.edu help="the maximum number of checkpoints to drop", default=5) 998920Snilay@cs.wisc.edu parser.add_option("--checkpoint-dir", action="store", type="string", 1008920Snilay@cs.wisc.edu help="Place all checkpoints in this absolute directory") 1018920Snilay@cs.wisc.edu parser.add_option("-r", "--checkpoint-restore", action="store", type="int", 1028920Snilay@cs.wisc.edu help="restore from checkpoint <N>") 1038920Snilay@cs.wisc.edu parser.add_option("--checkpoint-at-end", action="store_true", 1048920Snilay@cs.wisc.edu help="take a checkpoint at end of run") 1058920Snilay@cs.wisc.edu parser.add_option("--work-begin-checkpoint-count", action="store", type="int", 1068920Snilay@cs.wisc.edu help="checkpoint at specified work begin count") 1078920Snilay@cs.wisc.edu parser.add_option("--work-end-checkpoint-count", action="store", type="int", 1088920Snilay@cs.wisc.edu help="checkpoint at specified work end count") 1098920Snilay@cs.wisc.edu parser.add_option("--work-cpus-checkpoint-count", action="store", type="int", 1108920Snilay@cs.wisc.edu help="checkpoint and exit when active cpu count is reached") 1118920Snilay@cs.wisc.edu parser.add_option("--restore-with-cpu", action="store", type="choice", 1128920Snilay@cs.wisc.edu default="atomic", choices = ["atomic", "timing", 1138920Snilay@cs.wisc.edu "detailed", "inorder"], 1148920Snilay@cs.wisc.edu help = "cpu type for restoring from a checkpoint") 1153395Shsul@eecs.umich.edu 1165361Srstrong@cs.ucsd.edu 1178920Snilay@cs.wisc.edu # CPU Switching - default switch model goes from a checkpoint 1188920Snilay@cs.wisc.edu # to a timing simple CPU with caches to warm up, then to detailed CPU for 1198920Snilay@cs.wisc.edu # data measurement 1209151Satgutier@umich.edu parser.add_option("--repeat-switch", action="store", type="int", 1219151Satgutier@umich.edu default=None, 1229151Satgutier@umich.edu help="switch back and forth between CPUs with period <N>") 1239151Satgutier@umich.edu parser.add_option("-s", "--standard-switch", action="store", type="int", 1249151Satgutier@umich.edu default=None, 1259151Satgutier@umich.edu help="switch from timing to Detailed CPU after warmup period of <N>") 1268920Snilay@cs.wisc.edu parser.add_option("-p", "--prog-interval", type="int", 1278920Snilay@cs.wisc.edu help="CPU Progress Interval") 1288920Snilay@cs.wisc.edu 1298920Snilay@cs.wisc.edu # Fastforwarding and simpoint related materials 1308920Snilay@cs.wisc.edu parser.add_option("-W", "--warmup-insts", action="store", type="int", 1318920Snilay@cs.wisc.edu default=None, 1328920Snilay@cs.wisc.edu help="Warmup period in total instructions (requires --standard-switch)") 1338920Snilay@cs.wisc.edu parser.add_option("--bench", action="store", type="string", default=None, 1348920Snilay@cs.wisc.edu help="base names for --take-checkpoint and --checkpoint-restore") 1358920Snilay@cs.wisc.edu parser.add_option("-F", "--fast-forward", action="store", type="string", 1368920Snilay@cs.wisc.edu default=None, 1378920Snilay@cs.wisc.edu help="Number of instructions to fast forward before switching") 1388920Snilay@cs.wisc.edu parser.add_option("-S", "--simpoint", action="store_true", default=False, 1398920Snilay@cs.wisc.edu help="""Use workload simpoints as an instruction offset for 1408920Snilay@cs.wisc.edu --checkpoint-restore or --take-checkpoint.""") 1418920Snilay@cs.wisc.edu parser.add_option("--at-instruction", action="store_true", default=False, 1428920Snilay@cs.wisc.edu help="""Treat value of --checkpoint-restore or --take-checkpoint as a 1438920Snilay@cs.wisc.edu number of instructions.""") 1448920Snilay@cs.wisc.edu 1458920Snilay@cs.wisc.edudef addSEOptions(parser): 1468920Snilay@cs.wisc.edu # Benchmark options 1478920Snilay@cs.wisc.edu parser.add_option("-c", "--cmd", default="", 1488920Snilay@cs.wisc.edu help="The binary to run in syscall emulation mode.") 1498920Snilay@cs.wisc.edu parser.add_option("-o", "--options", default="", 1508920Snilay@cs.wisc.edu help="""The options to pass to the binary, use " " 1518920Snilay@cs.wisc.edu around the entire string""") 1528920Snilay@cs.wisc.edu parser.add_option("-i", "--input", default="", 1538920Snilay@cs.wisc.edu help="Read stdin from a file.") 1548920Snilay@cs.wisc.edu parser.add_option("--output", default="", 1558920Snilay@cs.wisc.edu help="Redirect stdout to a file.") 1568920Snilay@cs.wisc.edu parser.add_option("--errout", default="", 1578920Snilay@cs.wisc.edu help="Redirect stderr to a file.") 1588920Snilay@cs.wisc.edu 1598920Snilay@cs.wisc.edudef addFSOptions(parser): 1608920Snilay@cs.wisc.edu # Simulation options 1618920Snilay@cs.wisc.edu parser.add_option("--timesync", action="store_true", 1628920Snilay@cs.wisc.edu help="Prevent simulated time from getting ahead of real time") 1638920Snilay@cs.wisc.edu 1648920Snilay@cs.wisc.edu # System options 1658920Snilay@cs.wisc.edu parser.add_option("--kernel", action="store", type="string") 1668920Snilay@cs.wisc.edu parser.add_option("--script", action="store", type="string") 1678920Snilay@cs.wisc.edu parser.add_option("--frame-capture", action="store_true", 1688920Snilay@cs.wisc.edu help="Stores changed frame buffers from the VNC server to compressed "\ 1698920Snilay@cs.wisc.edu "files in the gem5 output directory") 1708920Snilay@cs.wisc.edu 1718920Snilay@cs.wisc.edu if buildEnv['TARGET_ISA'] == "arm": 1728920Snilay@cs.wisc.edu parser.add_option("--bare-metal", action="store_true", 1738920Snilay@cs.wisc.edu help="Provide the raw system without the linux specific bits") 1748920Snilay@cs.wisc.edu parser.add_option("--machine-type", action="store", type="choice", 1758920Snilay@cs.wisc.edu choices=ArmMachineType.map.keys(), default="RealView_PBX") 1768920Snilay@cs.wisc.edu # Benchmark options 1778920Snilay@cs.wisc.edu parser.add_option("--dual", action="store_true", 1788920Snilay@cs.wisc.edu help="Simulate two systems attached with an ethernet link") 1798920Snilay@cs.wisc.edu parser.add_option("-b", "--benchmark", action="store", type="string", 1808920Snilay@cs.wisc.edu dest="benchmark", 1818920Snilay@cs.wisc.edu help="Specify the benchmark to run. Available benchmarks: %s"\ 1828920Snilay@cs.wisc.edu % DefinedBenchmarks) 1838920Snilay@cs.wisc.edu 1848920Snilay@cs.wisc.edu # Metafile options 1858920Snilay@cs.wisc.edu parser.add_option("--etherdump", action="store", type="string", dest="etherdump", 1868920Snilay@cs.wisc.edu help="Specify the filename to dump a pcap capture of the" \ 1878920Snilay@cs.wisc.edu "ethernet traffic") 1888956Sjayneel@cs.wisc.edu 1898956Sjayneel@cs.wisc.edu # Disk Image Options 1908956Sjayneel@cs.wisc.edu parser.add_option("--disk-image", action="store", type="string", default=None, 1918956Sjayneel@cs.wisc.edu help="Path to the disk image to use.") 1928956Sjayneel@cs.wisc.edu 1938956Sjayneel@cs.wisc.edu # Memory Size Options 1948956Sjayneel@cs.wisc.edu parser.add_option("--mem-size", action="store", type="string", default=None, 1958976Sjayneel@cs.wisc.edu help="Specify the physical memory size (single memory)") 196