configs/common/Options.py

   1 # Copyright (c) 2013 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Copyright (c) 2006-2008 The Regents of The University of Michigan
  14 # All rights reserved.
  15 #
  16 # Redistribution and use in source and binary forms, with or without
  17 # modification, are permitted provided that the following conditions are
  18 # met: redistributions of source code must retain the above copyright
  19 # notice, this list of conditions and the following disclaimer;
  20 # redistributions in binary form must reproduce the above copyright
  21 # notice, this list of conditions and the following disclaimer in the
  22 # documentation and/or other materials provided with the distribution;
  23 # neither the name of the copyright holders nor the names of its
  24 # contributors may be used to endorse or promote products derived from
  25 # this software without specific prior written permission.
  26 #
  27 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38 #
  39 # Authors: Lisa Hsu
  40
  41 import m5
  42 from m5.defines import buildEnv
  43 from m5.objects import *
  44 from Benchmarks import *
  45
  46 import CpuConfig
  47 import MemConfig
  48
  49 from FSConfig import os_types
  50
  51 def _listCpuTypes(option, opt, value, parser):
  52     CpuConfig.print_cpu_list()
  53     sys.exit(0)
  54
  55 def _listMemTypes(option, opt, value, parser):
  56     MemConfig.print_mem_list()
  57     sys.exit(0)
  58
  59 def addCommonOptions(parser):
  60     # system options
  61     parser.add_option("--list-cpu-types",
  62                       action="callback", callback=_listCpuTypes,
  63                       help="List available CPU types")
  64     parser.add_option("--cpu-type", type="choice", default="atomic",
  65                       choices=CpuConfig.cpu_names(),
  66                       help = "type of cpu to run with")
  67     parser.add_option("--checker", action="store_true");
  68     parser.add_option("-n", "--num-cpus", type="int", default=1)
  69     parser.add_option("--sys-voltage", action="store", type="string",
  70                       default='1.0V',
  71                       help = """Top-level voltage for blocks running at system
  72                       power supply""")
  73     parser.add_option("--sys-clock", action="store", type="string",
  74                       default='1GHz',
  75                       help = """Top-level clock for blocks running at system
  76                       speed""")
  77     parser.add_option("--cpu-clock", action="store", type="string",
  78                       default='2GHz',
  79                       help="Clock for blocks running at CPU speed")
  80     parser.add_option("--smt", action="store_true", default=False,
  81                       help = """
  82                       Only used if multiple programs are specified. If true,
  83                       then the number of threads per cpu is same as the
  84                       number of programs.""")
  85
  86     # Memory Options
  87     parser.add_option("--list-mem-types",
  88                       action="callback", callback=_listMemTypes,
  89                       help="List available memory types")
  90     parser.add_option("--mem-type", type="choice", default="DDR3_1600_x64",
  91                       choices=MemConfig.mem_names(),
  92                       help = "type of memory to use")
  93     parser.add_option("--mem-channels", type="int", default=1,
  94                       help = "number of memory channels")
  95     parser.add_option("--mem-ranks", type="int", default=None,
  96                       help = "number of memory ranks per channel")
  97     parser.add_option("--mem-size", action="store", type="string",
  98                       default="512MB",
  99                       help="Specify the physical memory size (single memory)")
 100
 101     parser.add_option("-l", "--lpae", action="store_true")
 102     parser.add_option("-V", "--virtualisation", action="store_true")
 103
 104     parser.add_option("--memchecker", action="store_true")
 105
 106     # Cache Options
 107     parser.add_option("--external-memory-system", type="string",
 108                       help="use external ports of this port_type for caches")
 109     parser.add_option("--caches", action="store_true")
 110     parser.add_option("--l2cache", action="store_true")
 111     parser.add_option("--fastmem", action="store_true")
 112     parser.add_option("--num-dirs", type="int", default=1)
 113     parser.add_option("--num-l2caches", type="int", default=1)
 114     parser.add_option("--num-l3caches", type="int", default=1)
 115     parser.add_option("--l1d_size", type="string", default="64kB")
 116     parser.add_option("--l1i_size", type="string", default="32kB")
 117     parser.add_option("--l2_size", type="string", default="2MB")
 118     parser.add_option("--l3_size", type="string", default="16MB")
 119     parser.add_option("--l1d_assoc", type="int", default=2)
 120     parser.add_option("--l1i_assoc", type="int", default=2)
 121     parser.add_option("--l2_assoc", type="int", default=8)
 122     parser.add_option("--l3_assoc", type="int", default=16)
 123     parser.add_option("--cacheline_size", type="int", default=64)
 124
 125     # Enable Ruby
 126     parser.add_option("--ruby", action="store_true")
 127
 128     # Run duration options
 129     parser.add_option("-m", "--abs-max-tick", type="int", default=m5.MaxTick,
 130                       metavar="TICKS", help="Run to absolute simulated tick " \
 131                       "specified including ticks from a restored checkpoint")
 132     parser.add_option("--rel-max-tick", type="int", default=None,
 133                       metavar="TICKS", help="Simulate for specified number of" \
 134                       " ticks relative to the simulation start tick (e.g. if " \
 135                       "restoring a checkpoint)")
 136     parser.add_option("--maxtime", type="float", default=None,
 137                       help="Run to the specified absolute simulated time in " \
 138                       "seconds")
 139     parser.add_option("-I", "--maxinsts", action="store", type="int",
 140                       default=None, help="""Total number of instructions to
 141                                             simulate (default: run forever)""")
 142     parser.add_option("--work-item-id", action="store", type="int",
 143                       help="the specific work id for exit & checkpointing")
 144     parser.add_option("--num-work-ids", action="store", type="int",
 145                       help="Number of distinct work item types")
 146     parser.add_option("--work-begin-cpu-id-exit", action="store", type="int",
 147                       help="exit when work starts on the specified cpu")
 148     parser.add_option("--work-end-exit-count", action="store", type="int",
 149                       help="exit at specified work end count")
 150     parser.add_option("--work-begin-exit-count", action="store", type="int",
 151                       help="exit at specified work begin count")
 152     parser.add_option("--init-param", action="store", type="int", default=0,
 153                       help="""Parameter available in simulation with m5
 154                               initparam""")
 155     parser.add_option("--initialize-only", action="store_true", default=False,
 156                       help="""Exit after initialization. Do not simulate time.
 157                               Useful when gem5 is run as a library.""")
 158
 159     # Simpoint options
 160     parser.add_option("--simpoint-profile", action="store_true",
 161                       help="Enable basic block profiling for SimPoints")
 162     parser.add_option("--simpoint-interval", type="int", default=10000000,
 163                       help="SimPoint interval in num of instructions")
 164     parser.add_option("--take-simpoint-checkpoints", action="store", type="string",
 165         help="<simpoint file,weight file,interval-length,warmup-length>")
 166     parser.add_option("--restore-simpoint-checkpoint", action="store_true",
 167         help="restore from a simpoint checkpoint taken with " +
 168              "--take-simpoint-checkpoints")
 169
 170     # Checkpointing options
 171     ###Note that performing checkpointing via python script files will override
 172     ###checkpoint instructions built into binaries.
 173     parser.add_option("--take-checkpoints", action="store", type="string",
 174         help="<M,N> take checkpoints at tick M and every N ticks thereafter")
 175     parser.add_option("--max-checkpoints", action="store", type="int",
 176         help="the maximum number of checkpoints to drop", default=5)
 177     parser.add_option("--checkpoint-dir", action="store", type="string",
 178         help="Place all checkpoints in this absolute directory")
 179     parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
 180         help="restore from checkpoint <N>")
 181     parser.add_option("--checkpoint-at-end", action="store_true",
 182                       help="take a checkpoint at end of run")
 183     parser.add_option("--work-begin-checkpoint-count", action="store", type="int",
 184                       help="checkpoint at specified work begin count")
 185     parser.add_option("--work-end-checkpoint-count", action="store", type="int",
 186                       help="checkpoint at specified work end count")
 187     parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
 188                       help="checkpoint and exit when active cpu count is reached")
 189     parser.add_option("--restore-with-cpu", action="store", type="choice",
 190                       default="atomic", choices=CpuConfig.cpu_names(),
 191                       help = "cpu type for restoring from a checkpoint")
 192
 193
 194     # CPU Switching - default switch model goes from a checkpoint
 195     # to a timing simple CPU with caches to warm up, then to detailed CPU for
 196     # data measurement
 197     parser.add_option("--repeat-switch", action="store", type="int",
 198         default=None,
 199         help="switch back and forth between CPUs with period <N>")
 200     parser.add_option("-s", "--standard-switch", action="store", type="int",
 201         default=None,
 202         help="switch from timing to Detailed CPU after warmup period of <N>")
 203     parser.add_option("-p", "--prog-interval", type="str",
 204         help="CPU Progress Interval")
 205
 206     # Fastforwarding and simpoint related materials
 207     parser.add_option("-W", "--warmup-insts", action="store", type="int",
 208         default=None,
 209         help="Warmup period in total instructions (requires --standard-switch)")
 210     parser.add_option("--bench", action="store", type="string", default=None,
 211         help="base names for --take-checkpoint and --checkpoint-restore")
 212     parser.add_option("-F", "--fast-forward", action="store", type="string",
 213         default=None,
 214         help="Number of instructions to fast forward before switching")
 215     parser.add_option("-S", "--simpoint", action="store_true", default=False,
 216         help="""Use workload simpoints as an instruction offset for
 217                 --checkpoint-restore or --take-checkpoint.""")
 218     parser.add_option("--at-instruction", action="store_true", default=False,
 219         help="""Treat value of --checkpoint-restore or --take-checkpoint as a
 220                 number of instructions.""")
 221     parser.add_option("--spec-input", default="ref", type="choice",
 222                       choices=["ref", "test", "train", "smred", "mdred",
 223                                "lgred"],
 224                       help="Input set size for SPEC CPU2000 benchmarks.")
 225     parser.add_option("--arm-iset", default="arm", type="choice",
 226                       choices=["arm", "thumb", "aarch64"],
 227                       help="ARM instruction set.")
 228
 229
 230 def addSEOptions(parser):
 231     # Benchmark options
 232     parser.add_option("-c", "--cmd", default="",
 233                       help="The binary to run in syscall emulation mode.")
 234     parser.add_option("-o", "--options", default="",
 235                       help="""The options to pass to the binary, use " "
 236                               around the entire string""")
 237     parser.add_option("-i", "--input", default="",
 238                       help="Read stdin from a file.")
 239     parser.add_option("--output", default="",
 240                       help="Redirect stdout to a file.")
 241     parser.add_option("--errout", default="",
 242                       help="Redirect stderr to a file.")
 243
 244 def addFSOptions(parser):
 245     # Simulation options
 246     parser.add_option("--timesync", action="store_true",
 247             help="Prevent simulated time from getting ahead of real time")
 248
 249     # System options
 250     parser.add_option("--kernel", action="store", type="string")
 251     parser.add_option("--os-type", action="store", type="choice",
 252             choices=os_types[buildEnv['TARGET_ISA']], default="linux",
 253             help="Specifies type of OS to boot")
 254     parser.add_option("--script", action="store", type="string")
 255     parser.add_option("--frame-capture", action="store_true",
 256             help="Stores changed frame buffers from the VNC server to compressed "\
 257             "files in the gem5 output directory")
 258
 259     if buildEnv['TARGET_ISA'] == "arm":
 260         parser.add_option("--bare-metal", action="store_true",
 261                    help="Provide the raw system without the linux specific bits")
 262         parser.add_option("--machine-type", action="store", type="choice",
 263                 choices=ArmMachineType.map.keys(), default="VExpress_EMM")
 264         parser.add_option("--dtb-filename", action="store", type="string",
 265               help="Specifies device tree blob file to use with device-tree-"\
 266               "enabled kernels")
 267         parser.add_option("--enable-context-switch-stats-dump", \
 268                 action="store_true", help="Enable stats dump at context "\
 269                 "switches and dump tasks file (required for Streamline)")
 270
 271     # Benchmark options
 272     parser.add_option("--dual", action="store_true",
 273                       help="Simulate two systems attached with an ethernet link")
 274     parser.add_option("-b", "--benchmark", action="store", type="string",
 275                       dest="benchmark",
 276                       help="Specify the benchmark to run. Available benchmarks: %s"\
 277                       % DefinedBenchmarks)
 278
 279     # Metafile options
 280     parser.add_option("--etherdump", action="store", type="string", dest="etherdump",
 281                       help="Specify the filename to dump a pcap capture of the" \
 282                       "ethernet traffic")
 283
 284     # Disk Image Options
 285     parser.add_option("--disk-image", action="store", type="string", default=None,
 286                       help="Path to the disk image to use.")
 287     parser.add_option("--root-device", action="store", type="string", default=None,
 288                       help="OS device name for root partition")
 289
 290     # Command line options
 291     parser.add_option("--command-line", action="store", type="string",
 292                       default=None,
 293                       help="Template for the kernel command line.")
 294     parser.add_option("--command-line-file", action="store",
 295                       default=None, type="string",
 296                       help="File with a template for the kernel command line")