Options.py revision 7515:82453f1b46c5 
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("-d", "--detailed", action="store_true")
31parser.add_option("-t", "--timing", action="store_true")
32parser.add_option("--inorder", action="store_true")
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='1GHz')
38parser.add_option("--num-dirs", type="int", default=1)
39parser.add_option("--num-l2caches", type="int", default=1)
40parser.add_option("--topology", type="string", default="Crossbar",
41                  help="check src/mem/ruby/network/topologies for complete set")
42parser.add_option("--mesh-rows", type="int", default=1,
43                  help="the number of rows in the mesh topology")
44parser.add_option("--garnet-network", type="string", default=None,
45                  help="'fixed'|'flexible'")
46parser.add_option("--numa-high-bit", type="int", default=None,
47                  help="high order address bit to use for numa mapping")
48
49# ruby sparse memory options
50parser.add_option("--use-map", action="store_true", default=False)
51parser.add_option("--map-levels", type="int", default=4)
52
53# Run duration options
54parser.add_option("-m", "--maxtick", type="int", default=m5.MaxTick,
55                  metavar="T",
56                  help="Stop after T ticks")
57parser.add_option("--maxtime", type="float")
58parser.add_option("--maxinsts", type="int")
59parser.add_option("--prog_intvl", type="int")
60
61
62# Checkpointing options
63###Note that performing checkpointing via python script files will override
64###checkpoint instructions built into binaries.
65parser.add_option("--take-checkpoints", action="store", type="string",
66    help="<M,N> will take checkpoint at cycle M and every N cycles thereafter")
67parser.add_option("--max-checkpoints", action="store", type="int",
68    help="the maximum number of checkpoints to drop", default=5)
69parser.add_option("--checkpoint-dir", action="store", type="string",
70    help="Place all checkpoints in this absolute directory")
71parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
72    help="restore from checkpoint <N>")
73parser.add_option("--checkpoint-at-end", action="store_true",
74                  help="take a checkpoint at end of run")
75
76
77# CPU Switching - default switch model goes from a checkpoint
78# to a timing simple CPU with caches to warm up, then to detailed CPU for
79# data measurement
80parser.add_option("-s", "--standard-switch", action="store_true",
81    help="switch from timing CPU to Detailed CPU")
82parser.add_option("-w", "--warmup", action="store", type="int",
83    help="if -s, then this is the warmup period.  else, this is ignored",
84    default=5000000000)
85parser.add_option("--profile", help="CPU profile interval")
86
87# Fastforwarding and simpoint related materials
88parser.add_option("-W", "--warmup-insts", action="store", type="int",
89    default=None,
90    help="Warmup period in total instructions (requires --standard-switch)")
91parser.add_option("-I", "--max-inst", action="store", type="int", default=None,
92    help="Total number of instructions to simulate (default: run forever)")
93parser.add_option("--bench", action="store", type="string", default=None,
94    help="base names for --take-checkpoint and --checkpoint-restore")
95parser.add_option("-F", "--fast-forward", action="store", type="string",
96    default=None,
97    help="Number of instructions to fast forward before switching")
98parser.add_option("-S", "--simpoint", action="store_true", default=False,
99    help="""Use workload simpoints as an instruction offset for
100--checkpoint-restore or --take-checkpoint.""")
101parser.add_option("--at-instruction", action="store_true", default=False,
102    help="""Treate value of --checkpoint-restore or --take-checkpoint as a
103number of instructions.""")
104