Options.py revision 8724:7b4d80b26e35 
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
29# system options
30parser.add_option("--cpu-type", type="choice", default="atomic",
31                  choices = ["atomic", "timing", "detailed", "inorder",
32                             "arm_detailed"],
33                  help = "type of cpu to run with")
34parser.add_option("-n", "--num-cpus", type="int", default=1)
35parser.add_option("--caches", action="store_true")
36parser.add_option("--l2cache", action="store_true")
37parser.add_option("--fastmem", action="store_true")
38parser.add_option("--clock", action="store", type="string", default='2GHz')
39parser.add_option("--num-dirs", type="int", default=1)
40parser.add_option("--num-l2caches", type="int", default=1)
41parser.add_option("--num-l3caches", type="int", default=1)
42parser.add_option("--l1d_size", type="string", default="64kB")
43parser.add_option("--l1i_size", type="string", default="32kB")
44parser.add_option("--l2_size", type="string", default="2MB")
45parser.add_option("--l3_size", type="string", default="16MB")
46parser.add_option("--l1d_assoc", type="int", default=2)
47parser.add_option("--l1i_assoc", type="int", default=2)
48parser.add_option("--l2_assoc", type="int", default=8)
49parser.add_option("--l3_assoc", type="int", default=16)
50parser.add_option("--cacheline_size", type="int", default=64)
51
52# Run duration options
53parser.add_option("-m", "--maxtick", type="int", default=m5.MaxTick,
54                  metavar="T",
55                  help="Stop after T ticks")
56parser.add_option("--maxtime", type="float")
57parser.add_option("-I", "--maxinsts", action="store", type="int", default=None,
58                  help="Total number of instructions to simulate (default: run forever)")
59parser.add_option("--work-item-id", action="store", type="int",
60                  help="the specific work id for exit & checkpointing")
61parser.add_option("--work-begin-cpu-id-exit", action="store", type="int",
62                  help="exit when work starts on the specified cpu")
63parser.add_option("--work-end-exit-count", action="store", type="int",
64                  help="exit at specified work end count")
65parser.add_option("--work-begin-exit-count", action="store", type="int",
66                  help="exit at specified work begin count")
67parser.add_option("--init-param", action="store", type="int", default=0,
68                  help="Parameter available in simulation with m5 initparam")
69
70# Checkpointing options
71###Note that performing checkpointing via python script files will override
72###checkpoint instructions built into binaries.
73parser.add_option("--take-checkpoints", action="store", type="string",
74    help="<M,N> will take checkpoint at cycle M and every N cycles thereafter")
75parser.add_option("--max-checkpoints", action="store", type="int",
76    help="the maximum number of checkpoints to drop", default=5)
77parser.add_option("--checkpoint-dir", action="store", type="string",
78    help="Place all checkpoints in this absolute directory")
79parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
80    help="restore from checkpoint <N>")
81parser.add_option("--checkpoint-at-end", action="store_true",
82                  help="take a checkpoint at end of run")
83parser.add_option("--work-begin-checkpoint-count", action="store", type="int",
84                  help="checkpoint at specified work begin count")
85parser.add_option("--work-end-checkpoint-count", action="store", type="int",
86                  help="checkpoint at specified work end count")
87parser.add_option("--work-cpus-checkpoint-count", action="store", type="int",
88                  help="checkpoint and exit when active cpu count is reached")
89parser.add_option("--restore-with-cpu", action="store", type="choice",
90                  default="atomic", choices = ["atomic", "timing",
91                                               "detailed", "inorder"],
92                  help = "cpu type for restoring from a checkpoint")
93
94
95# CPU Switching - default switch model goes from a checkpoint
96# to a timing simple CPU with caches to warm up, then to detailed CPU for
97# data measurement
98parser.add_option("-s", "--standard-switch", action="store_true",
99    help="switch from timing CPU to Detailed CPU")
100parser.add_option("-w", "--warmup", action="store", type="int",
101    help="if -s, then this is the warmup period.  else, this is ignored",
102    default=5000000000)
103parser.add_option("-p", "--prog-interval", type="int", help="CPU Progress Interval")
104
105# Fastforwarding and simpoint related materials
106parser.add_option("-W", "--warmup-insts", action="store", type="int",
107    default=None,
108    help="Warmup period in total instructions (requires --standard-switch)")
109parser.add_option("--bench", action="store", type="string", default=None,
110    help="base names for --take-checkpoint and --checkpoint-restore")
111parser.add_option("-F", "--fast-forward", action="store", type="string",
112    default=None,
113    help="Number of instructions to fast forward before switching")
114parser.add_option("-S", "--simpoint", action="store_true", default=False,
115    help="""Use workload simpoints as an instruction offset for
116--checkpoint-restore or --take-checkpoint.""")
117parser.add_option("--at-instruction", action="store_true", default=False,
118    help="""Treate value of --checkpoint-restore or --take-checkpoint as a
119number of instructions.""")
120