1 # Copyright (c) 2013 ARM Limited
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.
13 # Copyright (c) 2006-2008 The Regents of The University of Michigan
14 # All rights reserved.
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.
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.
42 from m5
.defines
import buildEnv
43 from m5
.objects
import *
44 from Benchmarks
import *
49 def _listCpuTypes(option
, opt
, value
, parser
):
50 CpuConfig
.print_cpu_list()
53 def _listMemTypes(option
, opt
, value
, parser
):
54 MemConfig
.print_mem_list()
57 def addCommonOptions(parser
):
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-voltage", action
="store", type="string",
69 help = """Top-level voltage for blocks running at system
71 parser
.add_option("--sys-clock", action
="store", type="string",
73 help = """Top-level clock for blocks running at system
75 parser
.add_option("--cpu-clock", action
="store", type="string",
77 help="Clock for blocks running at CPU speed")
78 parser
.add_option("--smt", action
="store_true", default
=False,
80 Only used if multiple programs are specified. If true,
81 then the number of threads per cpu is same as the
82 number of programs.""")
85 parser
.add_option("--list-mem-types",
86 action
="callback", callback
=_listMemTypes
,
87 help="List available memory types")
88 parser
.add_option("--mem-type", type="choice", default
="simple_mem",
89 choices
=MemConfig
.mem_names(),
90 help = "type of memory to use")
91 parser
.add_option("--mem-channels", type="int", default
=1,
92 help = "number of memory channels")
93 parser
.add_option("--mem-size", action
="store", type="string",
95 help="Specify the physical memory size (single memory)")
97 parser
.add_option("-l", "--lpae", action
="store_true")
98 parser
.add_option("-V", "--virtualisation", action
="store_true")
101 parser
.add_option("--caches", action
="store_true")
102 parser
.add_option("--l2cache", action
="store_true")
103 parser
.add_option("--fastmem", action
="store_true")
104 parser
.add_option("--num-dirs", type="int", default
=1)
105 parser
.add_option("--num-l2caches", type="int", default
=1)
106 parser
.add_option("--num-l3caches", type="int", default
=1)
107 parser
.add_option("--l1d_size", type="string", default
="64kB")
108 parser
.add_option("--l1i_size", type="string", default
="32kB")
109 parser
.add_option("--l2_size", type="string", default
="2MB")
110 parser
.add_option("--l3_size", type="string", default
="16MB")
111 parser
.add_option("--l1d_assoc", type="int", default
=2)
112 parser
.add_option("--l1i_assoc", type="int", default
=2)
113 parser
.add_option("--l2_assoc", type="int", default
=8)
114 parser
.add_option("--l3_assoc", type="int", default
=16)
115 parser
.add_option("--cacheline_size", type="int", default
=64)
118 parser
.add_option("--ruby", action
="store_true")
120 # Run duration options
121 parser
.add_option("-m", "--abs-max-tick", type="int", default
=m5
.MaxTick
,
122 metavar
="TICKS", help="Run to absolute simulated tick " \
123 "specified including ticks from a restored checkpoint")
124 parser
.add_option("--rel-max-tick", type="int", default
=None,
125 metavar
="TICKS", help="Simulate for specified number of" \
126 " ticks relative to the simulation start tick (e.g. if " \
127 "restoring a checkpoint)")
128 parser
.add_option("--maxtime", type="float", default
=None,
129 help="Run to the specified absolute simulated time in " \
131 parser
.add_option("-I", "--maxinsts", action
="store", type="int",
132 default
=None, help="""Total number of instructions to
133 simulate (default: run forever)""")
134 parser
.add_option("--work-item-id", action
="store", type="int",
135 help="the specific work id for exit & checkpointing")
136 parser
.add_option("--work-begin-cpu-id-exit", action
="store", type="int",
137 help="exit when work starts on the specified cpu")
138 parser
.add_option("--work-end-exit-count", action
="store", type="int",
139 help="exit at specified work end count")
140 parser
.add_option("--work-begin-exit-count", action
="store", type="int",
141 help="exit at specified work begin count")
142 parser
.add_option("--init-param", action
="store", type="int", default
=0,
143 help="""Parameter available in simulation with m5
147 parser
.add_option("--simpoint-profile", action
="store_true",
148 help="Enable basic block profiling for SimPoints")
149 parser
.add_option("--simpoint-interval", type="int", default
=10000000,
150 help="SimPoint interval in num of instructions")
152 # Checkpointing options
153 ###Note that performing checkpointing via python script files will override
154 ###checkpoint instructions built into binaries.
155 parser
.add_option("--take-checkpoints", action
="store", type="string",
156 help="<M,N> take checkpoints at tick M and every N ticks thereafter")
157 parser
.add_option("--max-checkpoints", action
="store", type="int",
158 help="the maximum number of checkpoints to drop", default
=5)
159 parser
.add_option("--checkpoint-dir", action
="store", type="string",
160 help="Place all checkpoints in this absolute directory")
161 parser
.add_option("-r", "--checkpoint-restore", action
="store", type="int",
162 help="restore from checkpoint <N>")
163 parser
.add_option("--checkpoint-at-end", action
="store_true",
164 help="take a checkpoint at end of run")
165 parser
.add_option("--work-begin-checkpoint-count", action
="store", type="int",
166 help="checkpoint at specified work begin count")
167 parser
.add_option("--work-end-checkpoint-count", action
="store", type="int",
168 help="checkpoint at specified work end count")
169 parser
.add_option("--work-cpus-checkpoint-count", action
="store", type="int",
170 help="checkpoint and exit when active cpu count is reached")
171 parser
.add_option("--restore-with-cpu", action
="store", type="choice",
172 default
="atomic", choices
=CpuConfig
.cpu_names(),
173 help = "cpu type for restoring from a checkpoint")
176 # CPU Switching - default switch model goes from a checkpoint
177 # to a timing simple CPU with caches to warm up, then to detailed CPU for
179 parser
.add_option("--repeat-switch", action
="store", type="int",
181 help="switch back and forth between CPUs with period <N>")
182 parser
.add_option("-s", "--standard-switch", action
="store", type="int",
184 help="switch from timing to Detailed CPU after warmup period of <N>")
185 parser
.add_option("-p", "--prog-interval", type="str",
186 help="CPU Progress Interval")
188 # Fastforwarding and simpoint related materials
189 parser
.add_option("-W", "--warmup-insts", action
="store", type="int",
191 help="Warmup period in total instructions (requires --standard-switch)")
192 parser
.add_option("--bench", action
="store", type="string", default
=None,
193 help="base names for --take-checkpoint and --checkpoint-restore")
194 parser
.add_option("-F", "--fast-forward", action
="store", type="string",
196 help="Number of instructions to fast forward before switching")
197 parser
.add_option("-S", "--simpoint", action
="store_true", default
=False,
198 help="""Use workload simpoints as an instruction offset for
199 --checkpoint-restore or --take-checkpoint.""")
200 parser
.add_option("--at-instruction", action
="store_true", default
=False,
201 help="""Treat value of --checkpoint-restore or --take-checkpoint as a
202 number of instructions.""")
203 parser
.add_option("--spec-input", default
="ref", type="choice",
204 choices
=["ref", "test", "train", "smred", "mdred",
206 help="Input set size for SPEC CPU2000 benchmarks.")
207 parser
.add_option("--arm-iset", default
="arm", type="choice",
208 choices
=["arm", "thumb", "aarch64"],
209 help="ARM instruction set.")
212 def addSEOptions(parser
):
214 parser
.add_option("-c", "--cmd", default
="",
215 help="The binary to run in syscall emulation mode.")
216 parser
.add_option("-o", "--options", default
="",
217 help="""The options to pass to the binary, use " "
218 around the entire string""")
219 parser
.add_option("-i", "--input", default
="",
220 help="Read stdin from a file.")
221 parser
.add_option("--output", default
="",
222 help="Redirect stdout to a file.")
223 parser
.add_option("--errout", default
="",
224 help="Redirect stderr to a file.")
226 def addFSOptions(parser
):
228 parser
.add_option("--timesync", action
="store_true",
229 help="Prevent simulated time from getting ahead of real time")
232 parser
.add_option("--kernel", action
="store", type="string")
233 parser
.add_option("--script", action
="store", type="string")
234 parser
.add_option("--frame-capture", action
="store_true",
235 help="Stores changed frame buffers from the VNC server to compressed "\
236 "files in the gem5 output directory")
238 if buildEnv
['TARGET_ISA'] == "arm":
239 parser
.add_option("--bare-metal", action
="store_true",
240 help="Provide the raw system without the linux specific bits")
241 parser
.add_option("--machine-type", action
="store", type="choice",
242 choices
=ArmMachineType
.map.keys(), default
="RealView_PBX")
243 parser
.add_option("--dtb-filename", action
="store", type="string",
244 help="Specifies device tree blob file to use with device-tree-"\
246 parser
.add_option("--enable-context-switch-stats-dump", \
247 action
="store_true", help="Enable stats dump at context "\
248 "switches and dump tasks file (required for Streamline)")
251 parser
.add_option("--dual", action
="store_true",
252 help="Simulate two systems attached with an ethernet link")
253 parser
.add_option("-b", "--benchmark", action
="store", type="string",
255 help="Specify the benchmark to run. Available benchmarks: %s"\
259 parser
.add_option("--etherdump", action
="store", type="string", dest
="etherdump",
260 help="Specify the filename to dump a pcap capture of the" \
264 parser
.add_option("--disk-image", action
="store", type="string", default
=None,
265 help="Path to the disk image to use.")