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