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