merge
[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
38 # Run duration options
39 parser.add_option("-m", "--maxtick", type="int")
40 parser.add_option("--maxtime", type="float")
41 parser.add_option("--maxinsts", type="int")
42 parser.add_option("--prog_intvl", type="int")
43
44
45 # Checkpointing options
46 ###Note that performing checkpointing via python script files will override
47 ###checkpoint instructions built into binaries.
48 parser.add_option("--take-checkpoints", action="store", type="string",
49 help="<M,N> will take checkpoint at cycle M and every N cycles thereafter")
50 parser.add_option("--max-checkpoints", action="store", type="int",
51 help="the maximum number of checkpoints to drop", default=5)
52 parser.add_option("--checkpoint-dir", action="store", type="string",
53 help="Place all checkpoints in this absolute directory")
54 parser.add_option("-r", "--checkpoint-restore", action="store", type="int",
55 help="restore from checkpoint <N>")
56 parser.add_option("--checkpoint-at-end", action="store_true",
57 help="take a checkpoint at end of run")
58
59
60 # CPU Switching - default switch model goes from a checkpoint
61 # to a timing simple CPU with caches to warm up, then to detailed CPU for
62 # data measurement
63 parser.add_option("-s", "--standard-switch", action="store_true",
64 help="switch from timing CPU to Detailed CPU")
65 parser.add_option("-w", "--warmup", action="store", type="int",
66 help="if -s, then this is the warmup period. else, this is ignored",
67 default=5000000000)
68 parser.add_option("--profile", help="CPU profile interval")
69
70 # Fastforwarding and simpoint related materials
71 parser.add_option("-W", "--warmup-insts", action="store", type="int",
72 default=None,
73 help="Warmup period in total instructions (requires --standard-switch)")
74 parser.add_option("-I", "--max-inst", action="store", type="int", default=None,
75 help="Total number of instructions to simulate (default: run forever)")
76 parser.add_option("--bench", action="store", type="string", default=None,
77 help="base names for --take-checkpoint and --checkpoint-restore")
78 parser.add_option("-F", "--fast-forward", action="store", type="string",
79 default=None,
80 help="Number of instructions to fast forward before switching")
81 parser.add_option("-S", "--simpoint", action="store_true", default=False,
82 help="""Use workload simpoints as an instruction offset for
83 --checkpoint-restore or --take-checkpoint.""")
84 parser.add_option("--at-instruction", action="store_true", default=False,
85 help="""Treate value of --checkpoint-restore or --take-checkpoint as a
86 number of instructions.""")