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