Options.py revision 9647:5b6b315472e7 
1# Copyright (c) 2006-2008 The Regents of The University of Michigan
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Lisa Hsu
28
29import m5
30from m5.defines import buildEnv
31from m5.objects import *
32from Benchmarks import *
33
34import CpuConfig
35
36def _listCpuTypes(option, opt, value, parser):
37    CpuConfig.print_cpu_list()
38    sys.exit(0)
39
40def addCommonOptions(parser):
41    # system options
42    parser.add_option("--list-cpu-types",
43                      action="callback", callback=_listCpuTypes,
44                      help="List available CPU types")
45    parser.add_option("--cpu-type", type="choice", default="atomic",
46                      choices=CpuConfig.cpu_names(),
47                      help = "type of cpu to run with")
48    parser.add_option("--checker", action="store_true");
49    parser.add_option("-n", "--num-cpus", type="int", default=1)
50    parser.add_option("--caches", action="store_true")
51    parser.add_option("--l2cache", action="store_true")
52    parser.add_option("--fastmem", action="store_true")
53    parser.add_option("--simpoint-profile", action="store_true",
54                      help="Enable basic block profiling for SimPoints")
55    parser.add_option("--simpoint-interval", type="int", default=10000000,
56                      help="SimPoint interval in num of instructions")
57    parser.add_option("--clock", action="store", type="string", default='2GHz')
58    parser.add_option("--num-dirs", type="int", default=1)
59    parser.add_option("--num-l2caches", type="int", default=1)
60    parser.add_option("--num-l3caches", type="int", default=1)
61    parser.add_option("--l1d_size", type="string", default="64kB")
62    parser.add_option("--l1i_size", type="string", default="32kB")
63    parser.add_option("--l2_size", type="string", default="2MB")
64    parser.add_option("--l3_size", type="string", default="16MB")
65    parser.add_option("--l1d_assoc", type="int", default=2)
66    parser.add_option("--l1i_assoc", type="int", default=2)
67    parser.add_option("--l2_assoc", type="int", default=8)
68    parser.add_option("--l3_assoc", type="int", default=16)
69    parser.add_option("--cacheline_size", type="int", default=64)
70    parser.add_option("--ruby", action="store_true")
71    parser.add_option("--smt", action="store_true", default=False,
72                      help = """
73                      Only used if multiple programs are specified. If true,
74                      then the number of threads per cpu is same as the
75                      number of programs.""")
76
77    # Run duration options
78    parser.add_option("-m", "--maxtick", type="int", default=m5.MaxTick,
79                      metavar="T", help="Stop after T ticks")
80    parser.add_option("--maxtime", type="float")
81    parser.add_option("-I", "--maxinsts", action="store", type="int",
82                      default=None, help="""Total number of instructions to
83                                            simulate (default: run forever)""")
84    parser.add_option("--work-item-id", action="store", type="int",
85                      help="the specific work id for exit & checkpointing")
86    parser.add_option("--work-begin-cpu-id-exit", action="store", type="int",
87                      help="exit when work starts on the specified cpu")
88    parser.add_option("--work-end-exit-count", action="store", type="int",
89                      help="exit at specified work end count")
90    parser.add_option("--work-begin-exit-count", action="store", type="int",
91                      help="exit at specified work begin count")
92    parser.add_option("--init-param", action="store", type="int", default=0,
93                      help="""Parameter available in simulation with m5
94                              initparam""")
95
96    # Checkpointing options
97    ###Note that performing checkpointing via python script files will override
98    ###checkpoint instructions built into binaries.
99    parser.add_option("--take-checkpoints", action="store", type="string",
100        help="<M,N> take checkpoints at tick M and every N ticks thereafter")
101    parser.add_option("--max-checkpoints", action="store", type="int",
102        help="the maximum number of checkpoints to drop", default=5)
103    parser.add_option("--checkpoint-dir", action="store", type="string",
104        help="Place all checkpoints in this absolute directory")
105    parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
106        help="restore from checkpoint <N>")
107    parser.add_option("--checkpoint-at-end", action="store_true",
108                      help="take a checkpoint at end of run")
109    parser.add_option("--work-begin-checkpoint-count", action="store", type="int",
110                      help="checkpoint at specified work begin count")
111    parser.add_option("--work-end-checkpoint-count", action="store", type="int",
112                      help="checkpoint at specified work end count")
113    parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
114                      help="checkpoint and exit when active cpu count is reached")
115    parser.add_option("--restore-with-cpu", action="store", type="choice",
116                      default="atomic", choices = ["atomic", "timing",
117                                                   "detailed", "inorder"],
118                      help = "cpu type for restoring from a checkpoint")
119
120
121    # CPU Switching - default switch model goes from a checkpoint
122    # to a timing simple CPU with caches to warm up, then to detailed CPU for
123    # data measurement
124    parser.add_option("--repeat-switch", action="store", type="int",
125        default=None,
126        help="switch back and forth between CPUs with period <N>")
127    parser.add_option("-s", "--standard-switch", action="store", type="int",
128        default=None,
129        help="switch from timing to Detailed CPU after warmup period of <N>")
130    parser.add_option("-p", "--prog-interval", type="str",
131        help="CPU Progress Interval")
132
133    # Fastforwarding and simpoint related materials
134    parser.add_option("-W", "--warmup-insts", action="store", type="int",
135        default=None,
136        help="Warmup period in total instructions (requires --standard-switch)")
137    parser.add_option("--bench", action="store", type="string", default=None,
138        help="base names for --take-checkpoint and --checkpoint-restore")
139    parser.add_option("-F", "--fast-forward", action="store", type="string",
140        default=None,
141        help="Number of instructions to fast forward before switching")
142    parser.add_option("-S", "--simpoint", action="store_true", default=False,
143        help="""Use workload simpoints as an instruction offset for
144                --checkpoint-restore or --take-checkpoint.""")
145    parser.add_option("--at-instruction", action="store_true", default=False,
146        help="""Treat value of --checkpoint-restore or --take-checkpoint as a
147                number of instructions.""")
148
149def addSEOptions(parser):
150    # Benchmark options
151    parser.add_option("-c", "--cmd", default="",
152                      help="The binary to run in syscall emulation mode.")
153    parser.add_option("-o", "--options", default="",
154                      help="""The options to pass to the binary, use " "
155                              around the entire string""")
156    parser.add_option("-i", "--input", default="",
157                      help="Read stdin from a file.")
158    parser.add_option("--output", default="",
159                      help="Redirect stdout to a file.")
160    parser.add_option("--errout", default="",
161                      help="Redirect stderr to a file.")
162
163def addFSOptions(parser):
164    # Simulation options
165    parser.add_option("--timesync", action="store_true",
166            help="Prevent simulated time from getting ahead of real time")
167
168    # System options
169    parser.add_option("--kernel", action="store", type="string")
170    parser.add_option("--script", action="store", type="string")
171    parser.add_option("--frame-capture", action="store_true",
172            help="Stores changed frame buffers from the VNC server to compressed "\
173            "files in the gem5 output directory")
174
175    if buildEnv['TARGET_ISA'] == "arm":
176        parser.add_option("--bare-metal", action="store_true",
177                   help="Provide the raw system without the linux specific bits")
178        parser.add_option("--machine-type", action="store", type="choice",
179                choices=ArmMachineType.map.keys(), default="RealView_PBX")
180        parser.add_option("--dtb-filename", action="store", type="string",
181              help="Specifies device tree blob file to use with device-tree-"\
182              "enabled kernels")
183    # Benchmark options
184    parser.add_option("--dual", action="store_true",
185                      help="Simulate two systems attached with an ethernet link")
186    parser.add_option("-b", "--benchmark", action="store", type="string",
187                      dest="benchmark",
188                      help="Specify the benchmark to run. Available benchmarks: %s"\
189                      % DefinedBenchmarks)
190
191    # Metafile options
192    parser.add_option("--etherdump", action="store", type="string", dest="etherdump",
193                      help="Specify the filename to dump a pcap capture of the" \
194                      "ethernet traffic")
195
196    # Disk Image Options
197    parser.add_option("--disk-image", action="store", type="string", default=None,
198                      help="Path to the disk image to use.")
199
200    # Memory Size Options
201    parser.add_option("--mem-size", action="store", type="string", default=None,
202                      help="Specify the physical memory size (single memory)")
203