Options.py revision 13883
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 4113774Sandreas.sandberg@arm.comfrom __future__ import print_function 4213774Sandreas.sandberg@arm.comfrom __future__ import absolute_import 4313774Sandreas.sandberg@arm.com 448920Snilay@cs.wisc.eduimport m5 458920Snilay@cs.wisc.edufrom m5.defines import buildEnv 468920Snilay@cs.wisc.edufrom m5.objects import * 477025SBrad.Beckmann@amd.com 4813774Sandreas.sandberg@arm.comfrom .Benchmarks import * 4913774Sandreas.sandberg@arm.comfrom . import CpuConfig 5013774Sandreas.sandberg@arm.comfrom . import BPConfig 5113876Sjavier.bueno@metempsy.comfrom . import HWPConfig 5213774Sandreas.sandberg@arm.comfrom . import MemConfig 5313774Sandreas.sandberg@arm.comfrom . import PlatformConfig 5410747SChris.Emmons@arm.com 559520SAndreas.Sandberg@ARM.comdef _listCpuTypes(option, opt, value, parser): 569520SAndreas.Sandberg@ARM.com CpuConfig.print_cpu_list() 579520SAndreas.Sandberg@ARM.com sys.exit(0) 589520SAndreas.Sandberg@ARM.com 5913432Spau.cabre@metempsy.comdef _listBPTypes(option, opt, value, parser): 6013432Spau.cabre@metempsy.com BPConfig.print_bp_list() 6113432Spau.cabre@metempsy.com sys.exit(0) 6213432Spau.cabre@metempsy.com 6313876Sjavier.bueno@metempsy.comdef _listHWPTypes(option, opt, value, parser): 6413876Sjavier.bueno@metempsy.com HWPConfig.print_hwp_list() 6513876Sjavier.bueno@metempsy.com sys.exit(0) 6613876Sjavier.bueno@metempsy.com 679665Sandreas.hansson@arm.comdef _listMemTypes(option, opt, value, parser): 689665Sandreas.hansson@arm.com MemConfig.print_mem_list() 699665Sandreas.hansson@arm.com sys.exit(0) 709665Sandreas.hansson@arm.com 7111238Sandreas.sandberg@arm.comdef _listPlatformTypes(option, opt, value, parser): 7211238Sandreas.sandberg@arm.com PlatformConfig.print_platform_list() 7311238Sandreas.sandberg@arm.com sys.exit(0) 7411238Sandreas.sandberg@arm.com 7511688Sandreas.hansson@arm.com# Add the very basic options that work also in the case of the no ISA 7611688Sandreas.hansson@arm.com# being used, and consequently no CPUs, but rather various types of 7711688Sandreas.hansson@arm.com# testers and traffic generators. 7811688Sandreas.hansson@arm.comdef addNoISAOptions(parser): 798920Snilay@cs.wisc.edu parser.add_option("-n", "--num-cpus", type="int", default=1) 809827Sakash.bagdia@arm.com parser.add_option("--sys-voltage", action="store", type="string", 819827Sakash.bagdia@arm.com default='1.0V', 829827Sakash.bagdia@arm.com help = """Top-level voltage for blocks running at system 839827Sakash.bagdia@arm.com power supply""") 849790Sakash.bagdia@arm.com parser.add_option("--sys-clock", action="store", type="string", 859790Sakash.bagdia@arm.com default='1GHz', 869790Sakash.bagdia@arm.com help = """Top-level clock for blocks running at system 879790Sakash.bagdia@arm.com speed""") 8811688Sandreas.hansson@arm.com 8911688Sandreas.hansson@arm.com # Memory Options 9011688Sandreas.hansson@arm.com parser.add_option("--list-mem-types", 9111688Sandreas.hansson@arm.com action="callback", callback=_listMemTypes, 9211688Sandreas.hansson@arm.com help="List available memory types") 9311837Swendy.elsasser@arm.com parser.add_option("--mem-type", type="choice", default="DDR3_1600_8x8", 9411688Sandreas.hansson@arm.com choices=MemConfig.mem_names(), 9511688Sandreas.hansson@arm.com help = "type of memory to use") 9611688Sandreas.hansson@arm.com parser.add_option("--mem-channels", type="int", default=1, 9711688Sandreas.hansson@arm.com help = "number of memory channels") 9811688Sandreas.hansson@arm.com parser.add_option("--mem-ranks", type="int", default=None, 9911688Sandreas.hansson@arm.com help = "number of memory ranks per channel") 10011688Sandreas.hansson@arm.com parser.add_option("--mem-size", action="store", type="string", 10111688Sandreas.hansson@arm.com default="512MB", 10211688Sandreas.hansson@arm.com help="Specify the physical memory size (single memory)") 10311688Sandreas.hansson@arm.com 10411688Sandreas.hansson@arm.com 10511688Sandreas.hansson@arm.com parser.add_option("--memchecker", action="store_true") 10611688Sandreas.hansson@arm.com 10711688Sandreas.hansson@arm.com # Cache Options 10811688Sandreas.hansson@arm.com parser.add_option("--external-memory-system", type="string", 10911688Sandreas.hansson@arm.com help="use external ports of this port_type for caches") 11011688Sandreas.hansson@arm.com parser.add_option("--tlm-memory", type="string", 11111688Sandreas.hansson@arm.com help="use external port for SystemC TLM cosimulation") 11211688Sandreas.hansson@arm.com parser.add_option("--caches", action="store_true") 11311688Sandreas.hansson@arm.com parser.add_option("--l2cache", action="store_true") 11411688Sandreas.hansson@arm.com parser.add_option("--num-dirs", type="int", default=1) 11511688Sandreas.hansson@arm.com parser.add_option("--num-l2caches", type="int", default=1) 11611688Sandreas.hansson@arm.com parser.add_option("--num-l3caches", type="int", default=1) 11711688Sandreas.hansson@arm.com parser.add_option("--l1d_size", type="string", default="64kB") 11811688Sandreas.hansson@arm.com parser.add_option("--l1i_size", type="string", default="32kB") 11911688Sandreas.hansson@arm.com parser.add_option("--l2_size", type="string", default="2MB") 12011688Sandreas.hansson@arm.com parser.add_option("--l3_size", type="string", default="16MB") 12111688Sandreas.hansson@arm.com parser.add_option("--l1d_assoc", type="int", default=2) 12211688Sandreas.hansson@arm.com parser.add_option("--l1i_assoc", type="int", default=2) 12311688Sandreas.hansson@arm.com parser.add_option("--l2_assoc", type="int", default=8) 12411688Sandreas.hansson@arm.com parser.add_option("--l3_assoc", type="int", default=16) 12511688Sandreas.hansson@arm.com parser.add_option("--cacheline_size", type="int", default=64) 12611688Sandreas.hansson@arm.com 12711688Sandreas.hansson@arm.com # Enable Ruby 12811688Sandreas.hansson@arm.com parser.add_option("--ruby", action="store_true") 12911688Sandreas.hansson@arm.com 13011688Sandreas.hansson@arm.com # Run duration options 13111688Sandreas.hansson@arm.com parser.add_option("-m", "--abs-max-tick", type="int", default=m5.MaxTick, 13211688Sandreas.hansson@arm.com metavar="TICKS", help="Run to absolute simulated tick " 13311688Sandreas.hansson@arm.com "specified including ticks from a restored checkpoint") 13411688Sandreas.hansson@arm.com parser.add_option("--rel-max-tick", type="int", default=None, 13511688Sandreas.hansson@arm.com metavar="TICKS", help="Simulate for specified number of" 13611688Sandreas.hansson@arm.com " ticks relative to the simulation start tick (e.g. if " 13711688Sandreas.hansson@arm.com "restoring a checkpoint)") 13811688Sandreas.hansson@arm.com parser.add_option("--maxtime", type="float", default=None, 13911688Sandreas.hansson@arm.com help="Run to the specified absolute simulated time in " 14011688Sandreas.hansson@arm.com "seconds") 14113357Sciro.santilli@arm.com parser.add_option("-P", "--param", action="append", default=[], 14213357Sciro.santilli@arm.com help="Set a SimObject parameter relative to the root node. " 14313357Sciro.santilli@arm.com "An extended Python multi range slicing syntax can be used " 14413357Sciro.santilli@arm.com "for arrays. For example: " 14513357Sciro.santilli@arm.com "'system.cpu[0,1,3:8:2].max_insts_all_threads = 42' " 14613357Sciro.santilli@arm.com "sets max_insts_all_threads for cpus 0, 1, 3, 5 and 7 " 14713357Sciro.santilli@arm.com "Direct parameters of the root object are not accessible, " 14813357Sciro.santilli@arm.com "only parameters of its children.") 14911688Sandreas.hansson@arm.com 15011688Sandreas.hansson@arm.com# Add common options that assume a non-NULL ISA. 15111688Sandreas.hansson@arm.comdef addCommonOptions(parser): 15211688Sandreas.hansson@arm.com # start by adding the base options that do not assume an ISA 15311688Sandreas.hansson@arm.com addNoISAOptions(parser) 15411688Sandreas.hansson@arm.com 15511688Sandreas.hansson@arm.com # system options 15611688Sandreas.hansson@arm.com parser.add_option("--list-cpu-types", 15711688Sandreas.hansson@arm.com action="callback", callback=_listCpuTypes, 15811688Sandreas.hansson@arm.com help="List available CPU types") 15911995Sgabeblack@google.com parser.add_option("--cpu-type", type="choice", default="AtomicSimpleCPU", 16011688Sandreas.hansson@arm.com choices=CpuConfig.cpu_names(), 16111688Sandreas.hansson@arm.com help = "type of cpu to run with") 16213432Spau.cabre@metempsy.com parser.add_option("--list-bp-types", 16313432Spau.cabre@metempsy.com action="callback", callback=_listBPTypes, 16413432Spau.cabre@metempsy.com help="List available branch predictor types") 16513432Spau.cabre@metempsy.com parser.add_option("--bp-type", type="choice", default=None, 16613432Spau.cabre@metempsy.com choices=BPConfig.bp_names(), 16713432Spau.cabre@metempsy.com help = """ 16813432Spau.cabre@metempsy.com type of branch predictor to run with 16913432Spau.cabre@metempsy.com (if not set, use the default branch predictor of 17013432Spau.cabre@metempsy.com the selected CPU)""") 17113876Sjavier.bueno@metempsy.com parser.add_option("--list-hwp-types", 17213876Sjavier.bueno@metempsy.com action="callback", callback=_listHWPTypes, 17313876Sjavier.bueno@metempsy.com help="List available hardware prefetcher types") 17413876Sjavier.bueno@metempsy.com parser.add_option("--l1i-hwp-type", type="choice", default=None, 17513876Sjavier.bueno@metempsy.com choices=HWPConfig.hwp_names(), 17613876Sjavier.bueno@metempsy.com help = """ 17713876Sjavier.bueno@metempsy.com type of hardware prefetcher to use with the L1 17813876Sjavier.bueno@metempsy.com instruction cache. 17913876Sjavier.bueno@metempsy.com (if not set, use the default prefetcher of 18013876Sjavier.bueno@metempsy.com the selected cache)""") 18113876Sjavier.bueno@metempsy.com parser.add_option("--l1d-hwp-type", type="choice", default=None, 18213876Sjavier.bueno@metempsy.com choices=HWPConfig.hwp_names(), 18313876Sjavier.bueno@metempsy.com help = """ 18413876Sjavier.bueno@metempsy.com type of hardware prefetcher to use with the L1 18513876Sjavier.bueno@metempsy.com data cache. 18613876Sjavier.bueno@metempsy.com (if not set, use the default prefetcher of 18713876Sjavier.bueno@metempsy.com the selected cache)""") 18813876Sjavier.bueno@metempsy.com parser.add_option("--l2-hwp-type", type="choice", default=None, 18913876Sjavier.bueno@metempsy.com choices=HWPConfig.hwp_names(), 19013876Sjavier.bueno@metempsy.com help = """ 19113876Sjavier.bueno@metempsy.com type of hardware prefetcher to use with the L2 cache. 19213876Sjavier.bueno@metempsy.com (if not set, use the default prefetcher of 19313876Sjavier.bueno@metempsy.com the selected cache)""") 19411688Sandreas.hansson@arm.com parser.add_option("--checker", action="store_true"); 1959789Sakash.bagdia@arm.com parser.add_option("--cpu-clock", action="store", type="string", 1969789Sakash.bagdia@arm.com default='2GHz', 1979789Sakash.bagdia@arm.com help="Clock for blocks running at CPU speed") 1989800Snilay@cs.wisc.edu parser.add_option("--smt", action="store_true", default=False, 1999800Snilay@cs.wisc.edu help = """ 2009800Snilay@cs.wisc.edu Only used if multiple programs are specified. If true, 2019800Snilay@cs.wisc.edu then the number of threads per cpu is same as the 2029800Snilay@cs.wisc.edu number of programs.""") 20311251Sradhika.jagtap@ARM.com parser.add_option("--elastic-trace-en", action="store_true", 20411251Sradhika.jagtap@ARM.com help="""Enable capture of data dependency and instruction 20511251Sradhika.jagtap@ARM.com fetch traces using elastic trace probe.""") 20611251Sradhika.jagtap@ARM.com # Trace file paths input to trace probe in a capture simulation and input 20711251Sradhika.jagtap@ARM.com # to Trace CPU in a replay simulation 20811251Sradhika.jagtap@ARM.com parser.add_option("--inst-trace-file", action="store", type="string", 20911251Sradhika.jagtap@ARM.com help="""Instruction fetch trace file input to 21011251Sradhika.jagtap@ARM.com Elastic Trace probe in a capture simulation and 21111251Sradhika.jagtap@ARM.com Trace CPU in a replay simulation""", default="") 21211251Sradhika.jagtap@ARM.com parser.add_option("--data-trace-file", action="store", type="string", 21311251Sradhika.jagtap@ARM.com help="""Data dependency trace file input to 21411251Sradhika.jagtap@ARM.com Elastic Trace probe in a capture simulation and 21511251Sradhika.jagtap@ARM.com Trace CPU in a replay simulation""", default="") 2169800Snilay@cs.wisc.edu 21710037SARM gem5 Developers parser.add_option("-l", "--lpae", action="store_true") 21810037SARM gem5 Developers parser.add_option("-V", "--virtualisation", action="store_true") 21910037SARM gem5 Developers 22011626Smichael.lebeane@amd.com # dist-gem5 options 22111626Smichael.lebeane@amd.com parser.add_option("--dist", action="store_true", 22211626Smichael.lebeane@amd.com help="Parallel distributed gem5 simulation.") 22311703Smichael.lebeane@amd.com parser.add_option("--dist-sync-on-pseudo-op", action="store_true", 22411703Smichael.lebeane@amd.com help="Use a pseudo-op to start dist-gem5 synchronization.") 22511626Smichael.lebeane@amd.com parser.add_option("--is-switch", action="store_true", 22611626Smichael.lebeane@amd.com help="Select the network switch simulator process for a"\ 22711626Smichael.lebeane@amd.com "distributed gem5 run") 22811626Smichael.lebeane@amd.com parser.add_option("--dist-rank", default=0, action="store", type="int", 22911626Smichael.lebeane@amd.com help="Rank of this system within the dist gem5 run.") 23011626Smichael.lebeane@amd.com parser.add_option("--dist-size", default=0, action="store", type="int", 23111626Smichael.lebeane@amd.com help="Number of gem5 processes within the dist gem5 run.") 23211626Smichael.lebeane@amd.com parser.add_option("--dist-server-name", 23311626Smichael.lebeane@amd.com default="127.0.0.1", 23411626Smichael.lebeane@amd.com action="store", type="string", 23511626Smichael.lebeane@amd.com help="Name of the message server host\nDEFAULT: localhost") 23611626Smichael.lebeane@amd.com parser.add_option("--dist-server-port", 23711626Smichael.lebeane@amd.com default=2200, 23811626Smichael.lebeane@amd.com action="store", type="int", 23911626Smichael.lebeane@amd.com help="Message server listen port\nDEFAULT: 2200") 24011626Smichael.lebeane@amd.com parser.add_option("--dist-sync-repeat", 24111626Smichael.lebeane@amd.com default="0us", 24211626Smichael.lebeane@amd.com action="store", type="string", 24311626Smichael.lebeane@amd.com help="Repeat interval for synchronisation barriers among dist-gem5 processes\nDEFAULT: --ethernet-linkdelay") 24411626Smichael.lebeane@amd.com parser.add_option("--dist-sync-start", 24511626Smichael.lebeane@amd.com default="5200000000000t", 24611626Smichael.lebeane@amd.com action="store", type="string", 24711626Smichael.lebeane@amd.com help="Time to schedule the first dist synchronisation barrier\nDEFAULT:5200000000000t") 24811626Smichael.lebeane@amd.com parser.add_option("--ethernet-linkspeed", default="10Gbps", 24911626Smichael.lebeane@amd.com action="store", type="string", 25011626Smichael.lebeane@amd.com help="Link speed in bps\nDEFAULT: 10Gbps") 25111626Smichael.lebeane@amd.com parser.add_option("--ethernet-linkdelay", default="10us", 25211626Smichael.lebeane@amd.com action="store", type="string", 25311626Smichael.lebeane@amd.com help="Link delay in seconds\nDEFAULT: 10us") 25411626Smichael.lebeane@amd.com 2558920Snilay@cs.wisc.edu # Run duration options 2568920Snilay@cs.wisc.edu parser.add_option("-I", "--maxinsts", action="store", type="int", 2578920Snilay@cs.wisc.edu default=None, help="""Total number of instructions to 2588920Snilay@cs.wisc.edu simulate (default: run forever)""") 2598920Snilay@cs.wisc.edu parser.add_option("--work-item-id", action="store", type="int", 2608920Snilay@cs.wisc.edu help="the specific work id for exit & checkpointing") 26110159Sgedare@rtems.org parser.add_option("--num-work-ids", action="store", type="int", 26210159Sgedare@rtems.org help="Number of distinct work item types") 2638920Snilay@cs.wisc.edu parser.add_option("--work-begin-cpu-id-exit", action="store", type="int", 2648920Snilay@cs.wisc.edu help="exit when work starts on the specified cpu") 2658920Snilay@cs.wisc.edu parser.add_option("--work-end-exit-count", action="store", type="int", 2668920Snilay@cs.wisc.edu help="exit at specified work end count") 2678920Snilay@cs.wisc.edu parser.add_option("--work-begin-exit-count", action="store", type="int", 2688920Snilay@cs.wisc.edu help="exit at specified work begin count") 2698920Snilay@cs.wisc.edu parser.add_option("--init-param", action="store", type="int", default=0, 2708920Snilay@cs.wisc.edu help="""Parameter available in simulation with m5 2718920Snilay@cs.wisc.edu initparam""") 27210757SCurtis.Dunham@arm.com parser.add_option("--initialize-only", action="store_true", default=False, 27310757SCurtis.Dunham@arm.com help="""Exit after initialization. Do not simulate time. 27410757SCurtis.Dunham@arm.com Useful when gem5 is run as a library.""") 2756776SBrad.Beckmann@amd.com 2769800Snilay@cs.wisc.edu # Simpoint options 2779800Snilay@cs.wisc.edu parser.add_option("--simpoint-profile", action="store_true", 2789800Snilay@cs.wisc.edu help="Enable basic block profiling for SimPoints") 2799800Snilay@cs.wisc.edu parser.add_option("--simpoint-interval", type="int", default=10000000, 2809800Snilay@cs.wisc.edu help="SimPoint interval in num of instructions") 28110608Sdam.sunwoo@arm.com parser.add_option("--take-simpoint-checkpoints", action="store", type="string", 28210608Sdam.sunwoo@arm.com help="<simpoint file,weight file,interval-length,warmup-length>") 28310608Sdam.sunwoo@arm.com parser.add_option("--restore-simpoint-checkpoint", action="store_true", 28410608Sdam.sunwoo@arm.com help="restore from a simpoint checkpoint taken with " + 28510608Sdam.sunwoo@arm.com "--take-simpoint-checkpoints") 2869800Snilay@cs.wisc.edu 2878920Snilay@cs.wisc.edu # Checkpointing options 2888920Snilay@cs.wisc.edu ###Note that performing checkpointing via python script files will override 2898920Snilay@cs.wisc.edu ###checkpoint instructions built into binaries. 2908920Snilay@cs.wisc.edu parser.add_option("--take-checkpoints", action="store", type="string", 2919357Sandreas.hansson@arm.com help="<M,N> take checkpoints at tick M and every N ticks thereafter") 2928920Snilay@cs.wisc.edu parser.add_option("--max-checkpoints", action="store", type="int", 2938920Snilay@cs.wisc.edu help="the maximum number of checkpoints to drop", default=5) 2948920Snilay@cs.wisc.edu parser.add_option("--checkpoint-dir", action="store", type="string", 2958920Snilay@cs.wisc.edu help="Place all checkpoints in this absolute directory") 2968920Snilay@cs.wisc.edu parser.add_option("-r", "--checkpoint-restore", action="store", type="int", 2978920Snilay@cs.wisc.edu help="restore from checkpoint <N>") 2988920Snilay@cs.wisc.edu parser.add_option("--checkpoint-at-end", action="store_true", 2998920Snilay@cs.wisc.edu help="take a checkpoint at end of run") 3008920Snilay@cs.wisc.edu parser.add_option("--work-begin-checkpoint-count", action="store", type="int", 3018920Snilay@cs.wisc.edu help="checkpoint at specified work begin count") 3028920Snilay@cs.wisc.edu parser.add_option("--work-end-checkpoint-count", action="store", type="int", 3038920Snilay@cs.wisc.edu help="checkpoint at specified work end count") 3048920Snilay@cs.wisc.edu parser.add_option("--work-cpus-checkpoint-count", action="store", type="int", 3058920Snilay@cs.wisc.edu help="checkpoint and exit when active cpu count is reached") 3068920Snilay@cs.wisc.edu parser.add_option("--restore-with-cpu", action="store", type="choice", 30711995Sgabeblack@google.com default="AtomicSimpleCPU", choices=CpuConfig.cpu_names(), 3088920Snilay@cs.wisc.edu help = "cpu type for restoring from a checkpoint") 3093395Shsul@eecs.umich.edu 3105361Srstrong@cs.ucsd.edu 3118920Snilay@cs.wisc.edu # CPU Switching - default switch model goes from a checkpoint 3128920Snilay@cs.wisc.edu # to a timing simple CPU with caches to warm up, then to detailed CPU for 3138920Snilay@cs.wisc.edu # data measurement 3149151Satgutier@umich.edu parser.add_option("--repeat-switch", action="store", type="int", 3159151Satgutier@umich.edu default=None, 3169151Satgutier@umich.edu help="switch back and forth between CPUs with period <N>") 3179151Satgutier@umich.edu parser.add_option("-s", "--standard-switch", action="store", type="int", 3189151Satgutier@umich.edu default=None, 3199151Satgutier@umich.edu help="switch from timing to Detailed CPU after warmup period of <N>") 3209562Ssaidi@eecs.umich.edu parser.add_option("-p", "--prog-interval", type="str", 3218920Snilay@cs.wisc.edu help="CPU Progress Interval") 3228920Snilay@cs.wisc.edu 3238920Snilay@cs.wisc.edu # Fastforwarding and simpoint related materials 3248920Snilay@cs.wisc.edu parser.add_option("-W", "--warmup-insts", action="store", type="int", 3258920Snilay@cs.wisc.edu default=None, 3268920Snilay@cs.wisc.edu help="Warmup period in total instructions (requires --standard-switch)") 3278920Snilay@cs.wisc.edu parser.add_option("--bench", action="store", type="string", default=None, 3288920Snilay@cs.wisc.edu help="base names for --take-checkpoint and --checkpoint-restore") 3298920Snilay@cs.wisc.edu parser.add_option("-F", "--fast-forward", action="store", type="string", 3308920Snilay@cs.wisc.edu default=None, 3318920Snilay@cs.wisc.edu help="Number of instructions to fast forward before switching") 3328920Snilay@cs.wisc.edu parser.add_option("-S", "--simpoint", action="store_true", default=False, 3338920Snilay@cs.wisc.edu help="""Use workload simpoints as an instruction offset for 3348920Snilay@cs.wisc.edu --checkpoint-restore or --take-checkpoint.""") 3358920Snilay@cs.wisc.edu parser.add_option("--at-instruction", action="store_true", default=False, 3368920Snilay@cs.wisc.edu help="""Treat value of --checkpoint-restore or --take-checkpoint as a 3378920Snilay@cs.wisc.edu number of instructions.""") 33810037SARM gem5 Developers parser.add_option("--spec-input", default="ref", type="choice", 33910037SARM gem5 Developers choices=["ref", "test", "train", "smred", "mdred", 34010037SARM gem5 Developers "lgred"], 34110037SARM gem5 Developers help="Input set size for SPEC CPU2000 benchmarks.") 34210037SARM gem5 Developers parser.add_option("--arm-iset", default="arm", type="choice", 34310037SARM gem5 Developers choices=["arm", "thumb", "aarch64"], 34410037SARM gem5 Developers help="ARM instruction set.") 34510037SARM gem5 Developers 3468920Snilay@cs.wisc.edu 3478920Snilay@cs.wisc.edudef addSEOptions(parser): 3488920Snilay@cs.wisc.edu # Benchmark options 3498920Snilay@cs.wisc.edu parser.add_option("-c", "--cmd", default="", 3508920Snilay@cs.wisc.edu help="The binary to run in syscall emulation mode.") 3518920Snilay@cs.wisc.edu parser.add_option("-o", "--options", default="", 3528920Snilay@cs.wisc.edu help="""The options to pass to the binary, use " " 3538920Snilay@cs.wisc.edu around the entire string""") 35410803Sbrandon.potter@amd.com parser.add_option("-e", "--env", default="", 35510803Sbrandon.potter@amd.com help="Initialize workload environment from text file.") 3568920Snilay@cs.wisc.edu parser.add_option("-i", "--input", default="", 3578920Snilay@cs.wisc.edu help="Read stdin from a file.") 3588920Snilay@cs.wisc.edu parser.add_option("--output", default="", 3598920Snilay@cs.wisc.edu help="Redirect stdout to a file.") 3608920Snilay@cs.wisc.edu parser.add_option("--errout", default="", 3618920Snilay@cs.wisc.edu help="Redirect stderr to a file.") 36213883Sdavid.hashe@amd.com parser.add_option("--chroot", action="store", type="string", default="/", 36313883Sdavid.hashe@amd.com help="The chroot option allows a user to alter the " \ 36413883Sdavid.hashe@amd.com "search path for processes running in SE mode. " \ 36513883Sdavid.hashe@amd.com "Normally, the search path would begin at the " \ 36613883Sdavid.hashe@amd.com "root of the filesystem (i.e. /). With chroot, " \ 36713883Sdavid.hashe@amd.com "a user can force the process to begin looking at" \ 36813883Sdavid.hashe@amd.com "some other location (i.e. /home/user/rand_dir)." \ 36913883Sdavid.hashe@amd.com "The intended use is to trick sophisticated " \ 37013883Sdavid.hashe@amd.com "software which queries the __HOST__ filesystem " \ 37113883Sdavid.hashe@amd.com "for information or functionality. Instead of " \ 37213883Sdavid.hashe@amd.com "finding files on the __HOST__ filesystem, the " \ 37313883Sdavid.hashe@amd.com "process will find the user's replacment files.") 37413883Sdavid.hashe@amd.com 3758920Snilay@cs.wisc.edu 3768920Snilay@cs.wisc.edudef addFSOptions(parser): 37713774Sandreas.sandberg@arm.com from .FSConfig import os_types 37811688Sandreas.hansson@arm.com 3798920Snilay@cs.wisc.edu # Simulation options 3808920Snilay@cs.wisc.edu parser.add_option("--timesync", action="store_true", 3818920Snilay@cs.wisc.edu help="Prevent simulated time from getting ahead of real time") 3828920Snilay@cs.wisc.edu 3838920Snilay@cs.wisc.edu # System options 3848920Snilay@cs.wisc.edu parser.add_option("--kernel", action="store", type="string") 38510747SChris.Emmons@arm.com parser.add_option("--os-type", action="store", type="choice", 38613731Sandreas.sandberg@arm.com choices=os_types[str(buildEnv['TARGET_ISA'])], 38713731Sandreas.sandberg@arm.com default="linux", 38813731Sandreas.sandberg@arm.com help="Specifies type of OS to boot") 3898920Snilay@cs.wisc.edu parser.add_option("--script", action="store", type="string") 3908920Snilay@cs.wisc.edu parser.add_option("--frame-capture", action="store_true", 3918920Snilay@cs.wisc.edu help="Stores changed frame buffers from the VNC server to compressed "\ 3928920Snilay@cs.wisc.edu "files in the gem5 output directory") 3938920Snilay@cs.wisc.edu 3948920Snilay@cs.wisc.edu if buildEnv['TARGET_ISA'] == "arm": 3958920Snilay@cs.wisc.edu parser.add_option("--bare-metal", action="store_true", 3968920Snilay@cs.wisc.edu help="Provide the raw system without the linux specific bits") 39711238Sandreas.sandberg@arm.com parser.add_option("--list-machine-types", 39811238Sandreas.sandberg@arm.com action="callback", callback=_listPlatformTypes, 39911238Sandreas.sandberg@arm.com help="List available platform types") 4008920Snilay@cs.wisc.edu parser.add_option("--machine-type", action="store", type="choice", 40111238Sandreas.sandberg@arm.com choices=PlatformConfig.platform_names(), 40211238Sandreas.sandberg@arm.com default="VExpress_EMM") 4039539Satgutier@umich.edu parser.add_option("--dtb-filename", action="store", type="string", 4049539Satgutier@umich.edu help="Specifies device tree blob file to use with device-tree-"\ 4059539Satgutier@umich.edu "enabled kernels") 40612079Sgedare@rtems.org parser.add_option("--enable-security-extensions", action="store_true", 40712079Sgedare@rtems.org help="Turn on the ARM Security Extensions") 4089935Sdam.sunwoo@arm.com parser.add_option("--enable-context-switch-stats-dump", \ 4099935Sdam.sunwoo@arm.com action="store_true", help="Enable stats dump at context "\ 4109935Sdam.sunwoo@arm.com "switches and dump tasks file (required for Streamline)") 4119935Sdam.sunwoo@arm.com 4128920Snilay@cs.wisc.edu # Benchmark options 4138920Snilay@cs.wisc.edu parser.add_option("--dual", action="store_true", 4148920Snilay@cs.wisc.edu help="Simulate two systems attached with an ethernet link") 4158920Snilay@cs.wisc.edu parser.add_option("-b", "--benchmark", action="store", type="string", 4168920Snilay@cs.wisc.edu dest="benchmark", 4178920Snilay@cs.wisc.edu help="Specify the benchmark to run. Available benchmarks: %s"\ 4188920Snilay@cs.wisc.edu % DefinedBenchmarks) 4198920Snilay@cs.wisc.edu 4208920Snilay@cs.wisc.edu # Metafile options 4218920Snilay@cs.wisc.edu parser.add_option("--etherdump", action="store", type="string", dest="etherdump", 4228920Snilay@cs.wisc.edu help="Specify the filename to dump a pcap capture of the" \ 4238920Snilay@cs.wisc.edu "ethernet traffic") 4248956Sjayneel@cs.wisc.edu 4258956Sjayneel@cs.wisc.edu # Disk Image Options 4268956Sjayneel@cs.wisc.edu parser.add_option("--disk-image", action="store", type="string", default=None, 4278956Sjayneel@cs.wisc.edu help="Path to the disk image to use.") 42810697SCurtis.Dunham@arm.com parser.add_option("--root-device", action="store", type="string", default=None, 42910697SCurtis.Dunham@arm.com help="OS device name for root partition") 43010594Sgabeblack@google.com 43110594Sgabeblack@google.com # Command line options 43210594Sgabeblack@google.com parser.add_option("--command-line", action="store", type="string", 43310594Sgabeblack@google.com default=None, 43410594Sgabeblack@google.com help="Template for the kernel command line.") 43510594Sgabeblack@google.com parser.add_option("--command-line-file", action="store", 43610594Sgabeblack@google.com default=None, type="string", 43710594Sgabeblack@google.com help="File with a template for the kernel command line") 438