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