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 def _listCpuTypes(option, opt, value, parser):
  50     CpuConfig.print_cpu_list()
  51     sys.exit(0)
  52
  53 def _listMemTypes(option, opt, value, parser):
  54     MemConfig.print_mem_list()
  55     sys.exit(0)
  56
  57 def addCommonOptions(parser):
  58     # system options
  59     parser.add_option("--list-cpu-types",
  60                       action="callback", callback=_listCpuTypes,
  61                       help="List available CPU types")
  62     parser.add_option("--cpu-type", type="choice", default="atomic",
  63                       choices=CpuConfig.cpu_names(),
  64                       help = "type of cpu to run with")
  65     parser.add_option("--checker", action="store_true");
  66     parser.add_option("-n", "--num-cpus", type="int", default=1)
  67     parser.add_option("--sys-clock", action="store", type="string",
  68                       default='1GHz',
  69                       help = """Top-level clock for blocks running at system
  70                       speed""")
  71     parser.add_option("--cpu-clock", action="store", type="string",
  72                       default='2GHz',
  73                       help="Clock for blocks running at CPU speed")
  74     parser.add_option("--smt", action="store_true", default=False,
  75                       help = """
  76                       Only used if multiple programs are specified. If true,
  77                       then the number of threads per cpu is same as the
  78                       number of programs.""")
  79
  80     # Memory Options
  81     parser.add_option("--list-mem-types",
  82                       action="callback", callback=_listMemTypes,
  83                       help="List available memory types")
  84     parser.add_option("--mem-type", type="choice", default="simple_mem",
  85                       choices=MemConfig.mem_names(),
  86                       help = "type of memory to use")
  87     parser.add_option("--mem-size", action="store", type="string",
  88                       default="512MB",
  89                       help="Specify the physical memory size (single memory)")
  90
  91     # Cache Options
  92     parser.add_option("--caches", action="store_true")
  93     parser.add_option("--l2cache", action="store_true")
  94     parser.add_option("--fastmem", action="store_true")
  95     parser.add_option("--num-dirs", type="int", default=1)
  96     parser.add_option("--num-l2caches", type="int", default=1)
  97     parser.add_option("--num-l3caches", type="int", default=1)
  98     parser.add_option("--l1d_size", type="string", default="64kB")
  99     parser.add_option("--l1i_size", type="string", default="32kB")
 100     parser.add_option("--l2_size", type="string", default="2MB")
 101     parser.add_option("--l3_size", type="string", default="16MB")
 102     parser.add_option("--l1d_assoc", type="int", default=2)
 103     parser.add_option("--l1i_assoc", type="int", default=2)
 104     parser.add_option("--l2_assoc", type="int", default=8)
 105     parser.add_option("--l3_assoc", type="int", default=16)
 106     parser.add_option("--cacheline_size", type="int", default=64)
 107
 108     # Enable Ruby
 109     parser.add_option("--ruby", action="store_true")
 110
 111     # Run duration options
 112     parser.add_option("-m", "--abs-max-tick", type="int", default=None,
 113                       metavar="TICKS", help="Run to absolute simulated tick " \
 114                       "specified including ticks from a restored checkpoint")
 115     parser.add_option("--rel-max-tick", type="int", default=None,
 116                       metavar="TICKS", help="Simulate for specified number of" \
 117                       " ticks relative to the simulation start tick (e.g. if " \
 118                       "restoring a checkpoint)")
 119     parser.add_option("--maxtime", type="float", default=None,
 120                       help="Run to the specified absolute simulated time in " \
 121                       "seconds")
 122     parser.add_option("-I", "--maxinsts", action="store", type="int",
 123                       default=None, help="""Total number of instructions to
 124                                             simulate (default: run forever)""")
 125     parser.add_option("--work-item-id", action="store", type="int",
 126                       help="the specific work id for exit & checkpointing")
 127     parser.add_option("--work-begin-cpu-id-exit", action="store", type="int",
 128                       help="exit when work starts on the specified cpu")
 129     parser.add_option("--work-end-exit-count", action="store", type="int",
 130                       help="exit at specified work end count")
 131     parser.add_option("--work-begin-exit-count", action="store", type="int",
 132                       help="exit at specified work begin count")
 133     parser.add_option("--init-param", action="store", type="int", default=0,
 134                       help="""Parameter available in simulation with m5
 135                               initparam""")
 136
 137     # Simpoint options
 138     parser.add_option("--simpoint-profile", action="store_true",
 139                       help="Enable basic block profiling for SimPoints")
 140     parser.add_option("--simpoint-interval", type="int", default=10000000,
 141                       help="SimPoint interval in num of instructions")
 142
 143     # Checkpointing options
 144     ###Note that performing checkpointing via python script files will override
 145     ###checkpoint instructions built into binaries.
 146     parser.add_option("--take-checkpoints", action="store", type="string",
 147         help="<M,N> take checkpoints at tick M and every N ticks thereafter")
 148     parser.add_option("--max-checkpoints", action="store", type="int",
 149         help="the maximum number of checkpoints to drop", default=5)
 150     parser.add_option("--checkpoint-dir", action="store", type="string",
 151         help="Place all checkpoints in this absolute directory")
 152     parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
 153         help="restore from checkpoint <N>")
 154     parser.add_option("--checkpoint-at-end", action="store_true",
 155                       help="take a checkpoint at end of run")
 156     parser.add_option("--work-begin-checkpoint-count", action="store", type="int",
 157                       help="checkpoint at specified work begin count")
 158     parser.add_option("--work-end-checkpoint-count", action="store", type="int",
 159                       help="checkpoint at specified work end count")
 160     parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
 161                       help="checkpoint and exit when active cpu count is reached")
 162     parser.add_option("--restore-with-cpu", action="store", type="choice",
 163                       default="atomic", choices=CpuConfig.cpu_names(),
 164                       help = "cpu type for restoring from a checkpoint")
 165
 166
 167     # CPU Switching - default switch model goes from a checkpoint
 168     # to a timing simple CPU with caches to warm up, then to detailed CPU for
 169     # data measurement
 170     parser.add_option("--repeat-switch", action="store", type="int",
 171         default=None,
 172         help="switch back and forth between CPUs with period <N>")
 173     parser.add_option("-s", "--standard-switch", action="store", type="int",
 174         default=None,
 175         help="switch from timing to Detailed CPU after warmup period of <N>")
 176     parser.add_option("-p", "--prog-interval", type="str",
 177         help="CPU Progress Interval")
 178
 179     # Fastforwarding and simpoint related materials
 180     parser.add_option("-W", "--warmup-insts", action="store", type="int",
 181         default=None,
 182         help="Warmup period in total instructions (requires --standard-switch)")
 183     parser.add_option("--bench", action="store", type="string", default=None,
 184         help="base names for --take-checkpoint and --checkpoint-restore")
 185     parser.add_option("-F", "--fast-forward", action="store", type="string",
 186         default=None,
 187         help="Number of instructions to fast forward before switching")
 188     parser.add_option("-S", "--simpoint", action="store_true", default=False,
 189         help="""Use workload simpoints as an instruction offset for
 190                 --checkpoint-restore or --take-checkpoint.""")
 191     parser.add_option("--at-instruction", action="store_true", default=False,
 192         help="""Treat value of --checkpoint-restore or --take-checkpoint as a
 193                 number of instructions.""")
 194
 195 def addSEOptions(parser):
 196     # Benchmark options
 197     parser.add_option("-c", "--cmd", default="",
 198                       help="The binary to run in syscall emulation mode.")
 199     parser.add_option("-o", "--options", default="",
 200                       help="""The options to pass to the binary, use " "
 201                               around the entire string""")
 202     parser.add_option("-i", "--input", default="",
 203                       help="Read stdin from a file.")
 204     parser.add_option("--output", default="",
 205                       help="Redirect stdout to a file.")
 206     parser.add_option("--errout", default="",
 207                       help="Redirect stderr to a file.")
 208
 209 def addFSOptions(parser):
 210     # Simulation options
 211     parser.add_option("--timesync", action="store_true",
 212             help="Prevent simulated time from getting ahead of real time")
 213
 214     # System options
 215     parser.add_option("--kernel", action="store", type="string")
 216     parser.add_option("--script", action="store", type="string")
 217     parser.add_option("--frame-capture", action="store_true",
 218             help="Stores changed frame buffers from the VNC server to compressed "\
 219             "files in the gem5 output directory")
 220
 221     if buildEnv['TARGET_ISA'] == "arm":
 222         parser.add_option("--bare-metal", action="store_true",
 223                    help="Provide the raw system without the linux specific bits")
 224         parser.add_option("--machine-type", action="store", type="choice",
 225                 choices=ArmMachineType.map.keys(), default="RealView_PBX")
 226         parser.add_option("--dtb-filename", action="store", type="string",
 227               help="Specifies device tree blob file to use with device-tree-"\
 228               "enabled kernels")
 229     # Benchmark options
 230     parser.add_option("--dual", action="store_true",
 231                       help="Simulate two systems attached with an ethernet link")
 232     parser.add_option("-b", "--benchmark", action="store", type="string",
 233                       dest="benchmark",
 234                       help="Specify the benchmark to run. Available benchmarks: %s"\
 235                       % DefinedBenchmarks)
 236
 237     # Metafile options
 238     parser.add_option("--etherdump", action="store", type="string", dest="etherdump",
 239                       help="Specify the filename to dump a pcap capture of the" \
 240                       "ethernet traffic")
 241
 242     # Disk Image Options
 243     parser.add_option("--disk-image", action="store", type="string", default=None,
 244                       help="Path to the disk image to use.")