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 common.Benchmarks import *
  45
  46 from common import CpuConfig
  47 from common import MemConfig
  48 from common import PlatformConfig
  49
  50 def _listCpuTypes(option, opt, value, parser):
  51     CpuConfig.print_cpu_list()
  52     sys.exit(0)
  53
  54 def _listMemTypes(option, opt, value, parser):
  55     MemConfig.print_mem_list()
  56     sys.exit(0)
  57
  58 def _listPlatformTypes(option, opt, value, parser):
  59     PlatformConfig.print_platform_list()
  60     sys.exit(0)
  61
  62 # Add the very basic options that work also in the case of the no ISA
  63 # being used, and consequently no CPUs, but rather various types of
  64 # testers and traffic generators.
  65 def addNoISAOptions(parser):
  66     parser.add_option("-n", "--num-cpus", type="int", default=1)
  67     parser.add_option("--sys-voltage", action="store", type="string",
  68                       default='1.0V',
  69                       help = """Top-level voltage for blocks running at system
  70                       power supply""")
  71     parser.add_option("--sys-clock", action="store", type="string",
  72                       default='1GHz',
  73                       help = """Top-level clock for blocks running at system
  74                       speed""")
  75
  76     # Memory Options
  77     parser.add_option("--list-mem-types",
  78                       action="callback", callback=_listMemTypes,
  79                       help="List available memory types")
  80     parser.add_option("--mem-type", type="choice", default="DDR3_1600_x64",
  81                       choices=MemConfig.mem_names(),
  82                       help = "type of memory to use")
  83     parser.add_option("--mem-channels", type="int", default=1,
  84                       help = "number of memory channels")
  85     parser.add_option("--mem-ranks", type="int", default=None,
  86                       help = "number of memory ranks per channel")
  87     parser.add_option("--mem-size", action="store", type="string",
  88                       default="512MB",
  89                       help="Specify the physical memory size (single memory)")
  90
  91
  92     parser.add_option("--memchecker", action="store_true")
  93
  94     # Cache Options
  95     parser.add_option("--external-memory-system", type="string",
  96                       help="use external ports of this port_type for caches")
  97     parser.add_option("--tlm-memory", type="string",
  98                       help="use external port for SystemC TLM cosimulation")
  99     parser.add_option("--caches", action="store_true")
 100     parser.add_option("--l2cache", action="store_true")
 101     parser.add_option("--num-dirs", type="int", default=1)
 102     parser.add_option("--num-l2caches", type="int", default=1)
 103     parser.add_option("--num-l3caches", type="int", default=1)
 104     parser.add_option("--l1d_size", type="string", default="64kB")
 105     parser.add_option("--l1i_size", type="string", default="32kB")
 106     parser.add_option("--l2_size", type="string", default="2MB")
 107     parser.add_option("--l3_size", type="string", default="16MB")
 108     parser.add_option("--l1d_assoc", type="int", default=2)
 109     parser.add_option("--l1i_assoc", type="int", default=2)
 110     parser.add_option("--l2_assoc", type="int", default=8)
 111     parser.add_option("--l3_assoc", type="int", default=16)
 112     parser.add_option("--cacheline_size", type="int", default=64)
 113
 114     # Enable Ruby
 115     parser.add_option("--ruby", action="store_true")
 116
 117     # Run duration options
 118     parser.add_option("-m", "--abs-max-tick", type="int", default=m5.MaxTick,
 119                       metavar="TICKS", help="Run to absolute simulated tick "
 120                       "specified including ticks from a restored checkpoint")
 121     parser.add_option("--rel-max-tick", type="int", default=None,
 122                       metavar="TICKS", help="Simulate for specified number of"
 123                       " ticks relative to the simulation start tick (e.g. if "
 124                       "restoring a checkpoint)")
 125     parser.add_option("--maxtime", type="float", default=None,
 126                       help="Run to the specified absolute simulated time in "
 127                       "seconds")
 128
 129 # Add common options that assume a non-NULL ISA.
 130 def addCommonOptions(parser):
 131     # start by adding the base options that do not assume an ISA
 132     addNoISAOptions(parser)
 133
 134     # system options
 135     parser.add_option("--list-cpu-types",
 136                       action="callback", callback=_listCpuTypes,
 137                       help="List available CPU types")
 138     parser.add_option("--cpu-type", type="choice", default="atomic",
 139                       choices=CpuConfig.cpu_names(),
 140                       help = "type of cpu to run with")
 141     parser.add_option("--checker", action="store_true");
 142     parser.add_option("--cpu-clock", action="store", type="string",
 143                       default='2GHz',
 144                       help="Clock for blocks running at CPU speed")
 145     parser.add_option("--smt", action="store_true", default=False,
 146                       help = """
 147                       Only used if multiple programs are specified. If true,
 148                       then the number of threads per cpu is same as the
 149                       number of programs.""")
 150     parser.add_option("--elastic-trace-en", action="store_true",
 151                       help="""Enable capture of data dependency and instruction
 152                       fetch traces using elastic trace probe.""")
 153     # Trace file paths input to trace probe in a capture simulation and input
 154     # to Trace CPU in a replay simulation
 155     parser.add_option("--inst-trace-file", action="store", type="string",
 156                       help="""Instruction fetch trace file input to
 157                       Elastic Trace probe in a capture simulation and
 158                       Trace CPU in a replay simulation""", default="")
 159     parser.add_option("--data-trace-file", action="store", type="string",
 160                       help="""Data dependency trace file input to
 161                       Elastic Trace probe in a capture simulation and
 162                       Trace CPU in a replay simulation""", default="")
 163
 164     parser.add_option("-l", "--lpae", action="store_true")
 165     parser.add_option("-V", "--virtualisation", action="store_true")
 166
 167     parser.add_option("--fastmem", action="store_true")
 168
 169     # dist-gem5 options
 170     parser.add_option("--dist", action="store_true",
 171                       help="Parallel distributed gem5 simulation.")
 172     parser.add_option("--dist-sync-on-pseudo-op", action="store_true",
 173                       help="Use a pseudo-op to start dist-gem5 synchronization.")
 174     parser.add_option("--is-switch", action="store_true",
 175                       help="Select the network switch simulator process for a"\
 176                       "distributed gem5 run")
 177     parser.add_option("--dist-rank", default=0, action="store", type="int",
 178                       help="Rank of this system within the dist gem5 run.")
 179     parser.add_option("--dist-size", default=0, action="store", type="int",
 180                       help="Number of gem5 processes within the dist gem5 run.")
 181     parser.add_option("--dist-server-name",
 182                       default="127.0.0.1",
 183                       action="store", type="string",
 184                       help="Name of the message server host\nDEFAULT: localhost")
 185     parser.add_option("--dist-server-port",
 186                       default=2200,
 187                       action="store", type="int",
 188                       help="Message server listen port\nDEFAULT: 2200")
 189     parser.add_option("--dist-sync-repeat",
 190                       default="0us",
 191                       action="store", type="string",
 192                       help="Repeat interval for synchronisation barriers among dist-gem5 processes\nDEFAULT: --ethernet-linkdelay")
 193     parser.add_option("--dist-sync-start",
 194                       default="5200000000000t",
 195                       action="store", type="string",
 196                       help="Time to schedule the first dist synchronisation barrier\nDEFAULT:5200000000000t")
 197     parser.add_option("--ethernet-linkspeed", default="10Gbps",
 198                         action="store", type="string",
 199                         help="Link speed in bps\nDEFAULT: 10Gbps")
 200     parser.add_option("--ethernet-linkdelay", default="10us",
 201                       action="store", type="string",
 202                       help="Link delay in seconds\nDEFAULT: 10us")
 203
 204     # Run duration options
 205     parser.add_option("-I", "--maxinsts", action="store", type="int",
 206                       default=None, help="""Total number of instructions to
 207                                             simulate (default: run forever)""")
 208     parser.add_option("--work-item-id", action="store", type="int",
 209                       help="the specific work id for exit & checkpointing")
 210     parser.add_option("--num-work-ids", action="store", type="int",
 211                       help="Number of distinct work item types")
 212     parser.add_option("--work-begin-cpu-id-exit", action="store", type="int",
 213                       help="exit when work starts on the specified cpu")
 214     parser.add_option("--work-end-exit-count", action="store", type="int",
 215                       help="exit at specified work end count")
 216     parser.add_option("--work-begin-exit-count", action="store", type="int",
 217                       help="exit at specified work begin count")
 218     parser.add_option("--init-param", action="store", type="int", default=0,
 219                       help="""Parameter available in simulation with m5
 220                               initparam""")
 221     parser.add_option("--initialize-only", action="store_true", default=False,
 222                       help="""Exit after initialization. Do not simulate time.
 223                               Useful when gem5 is run as a library.""")
 224
 225     # Simpoint options
 226     parser.add_option("--simpoint-profile", action="store_true",
 227                       help="Enable basic block profiling for SimPoints")
 228     parser.add_option("--simpoint-interval", type="int", default=10000000,
 229                       help="SimPoint interval in num of instructions")
 230     parser.add_option("--take-simpoint-checkpoints", action="store", type="string",
 231         help="<simpoint file,weight file,interval-length,warmup-length>")
 232     parser.add_option("--restore-simpoint-checkpoint", action="store_true",
 233         help="restore from a simpoint checkpoint taken with " +
 234              "--take-simpoint-checkpoints")
 235
 236     # Checkpointing options
 237     ###Note that performing checkpointing via python script files will override
 238     ###checkpoint instructions built into binaries.
 239     parser.add_option("--take-checkpoints", action="store", type="string",
 240         help="<M,N> take checkpoints at tick M and every N ticks thereafter")
 241     parser.add_option("--max-checkpoints", action="store", type="int",
 242         help="the maximum number of checkpoints to drop", default=5)
 243     parser.add_option("--checkpoint-dir", action="store", type="string",
 244         help="Place all checkpoints in this absolute directory")
 245     parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
 246         help="restore from checkpoint <N>")
 247     parser.add_option("--checkpoint-at-end", action="store_true",
 248                       help="take a checkpoint at end of run")
 249     parser.add_option("--work-begin-checkpoint-count", action="store", type="int",
 250                       help="checkpoint at specified work begin count")
 251     parser.add_option("--work-end-checkpoint-count", action="store", type="int",
 252                       help="checkpoint at specified work end count")
 253     parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
 254                       help="checkpoint and exit when active cpu count is reached")
 255     parser.add_option("--restore-with-cpu", action="store", type="choice",
 256                       default="atomic", choices=CpuConfig.cpu_names(),
 257                       help = "cpu type for restoring from a checkpoint")
 258
 259
 260     # CPU Switching - default switch model goes from a checkpoint
 261     # to a timing simple CPU with caches to warm up, then to detailed CPU for
 262     # data measurement
 263     parser.add_option("--repeat-switch", action="store", type="int",
 264         default=None,
 265         help="switch back and forth between CPUs with period <N>")
 266     parser.add_option("-s", "--standard-switch", action="store", type="int",
 267         default=None,
 268         help="switch from timing to Detailed CPU after warmup period of <N>")
 269     parser.add_option("-p", "--prog-interval", type="str",
 270         help="CPU Progress Interval")
 271
 272     # Fastforwarding and simpoint related materials
 273     parser.add_option("-W", "--warmup-insts", action="store", type="int",
 274         default=None,
 275         help="Warmup period in total instructions (requires --standard-switch)")
 276     parser.add_option("--bench", action="store", type="string", default=None,
 277         help="base names for --take-checkpoint and --checkpoint-restore")
 278     parser.add_option("-F", "--fast-forward", action="store", type="string",
 279         default=None,
 280         help="Number of instructions to fast forward before switching")
 281     parser.add_option("-S", "--simpoint", action="store_true", default=False,
 282         help="""Use workload simpoints as an instruction offset for
 283                 --checkpoint-restore or --take-checkpoint.""")
 284     parser.add_option("--at-instruction", action="store_true", default=False,
 285         help="""Treat value of --checkpoint-restore or --take-checkpoint as a
 286                 number of instructions.""")
 287     parser.add_option("--spec-input", default="ref", type="choice",
 288                       choices=["ref", "test", "train", "smred", "mdred",
 289                                "lgred"],
 290                       help="Input set size for SPEC CPU2000 benchmarks.")
 291     parser.add_option("--arm-iset", default="arm", type="choice",
 292                       choices=["arm", "thumb", "aarch64"],
 293                       help="ARM instruction set.")
 294
 295
 296 def addSEOptions(parser):
 297     # Benchmark options
 298     parser.add_option("-c", "--cmd", default="",
 299                       help="The binary to run in syscall emulation mode.")
 300     parser.add_option("-o", "--options", default="",
 301                       help="""The options to pass to the binary, use " "
 302                               around the entire string""")
 303     parser.add_option("-e", "--env", default="",
 304                       help="Initialize workload environment from text file.")
 305     parser.add_option("-i", "--input", default="",
 306                       help="Read stdin from a file.")
 307     parser.add_option("--output", default="",
 308                       help="Redirect stdout to a file.")
 309     parser.add_option("--errout", default="",
 310                       help="Redirect stderr to a file.")
 311
 312 def addFSOptions(parser):
 313     from FSConfig import os_types
 314
 315     # Simulation options
 316     parser.add_option("--timesync", action="store_true",
 317             help="Prevent simulated time from getting ahead of real time")
 318
 319     # System options
 320     parser.add_option("--kernel", action="store", type="string")
 321     parser.add_option("--os-type", action="store", type="choice",
 322             choices=os_types[buildEnv['TARGET_ISA']], default="linux",
 323             help="Specifies type of OS to boot")
 324     parser.add_option("--script", action="store", type="string")
 325     parser.add_option("--frame-capture", action="store_true",
 326             help="Stores changed frame buffers from the VNC server to compressed "\
 327             "files in the gem5 output directory")
 328
 329     if buildEnv['TARGET_ISA'] == "arm":
 330         parser.add_option("--bare-metal", action="store_true",
 331                    help="Provide the raw system without the linux specific bits")
 332         parser.add_option("--list-machine-types",
 333                           action="callback", callback=_listPlatformTypes,
 334                       help="List available platform types")
 335         parser.add_option("--machine-type", action="store", type="choice",
 336                 choices=PlatformConfig.platform_names(),
 337                 default="VExpress_EMM")
 338         parser.add_option("--dtb-filename", action="store", type="string",
 339               help="Specifies device tree blob file to use with device-tree-"\
 340               "enabled kernels")
 341         parser.add_option("--enable-context-switch-stats-dump", \
 342                 action="store_true", help="Enable stats dump at context "\
 343                 "switches and dump tasks file (required for Streamline)")
 344
 345     # Benchmark options
 346     parser.add_option("--dual", action="store_true",
 347                       help="Simulate two systems attached with an ethernet link")
 348     parser.add_option("-b", "--benchmark", action="store", type="string",
 349                       dest="benchmark",
 350                       help="Specify the benchmark to run. Available benchmarks: %s"\
 351                       % DefinedBenchmarks)
 352
 353     # Metafile options
 354     parser.add_option("--etherdump", action="store", type="string", dest="etherdump",
 355                       help="Specify the filename to dump a pcap capture of the" \
 356                       "ethernet traffic")
 357
 358     # Disk Image Options
 359     parser.add_option("--disk-image", action="store", type="string", default=None,
 360                       help="Path to the disk image to use.")
 361     parser.add_option("--root-device", action="store", type="string", default=None,
 362                       help="OS device name for root partition")
 363
 364     # Command line options
 365     parser.add_option("--command-line", action="store", type="string",
 366                       default=None,
 367                       help="Template for the kernel command line.")
 368     parser.add_option("--command-line-file", action="store",
 369                       default=None, type="string",
 370                       help="File with a template for the kernel command line")