6b1a46776f9e3719f2226336696204b546b3a4d8
[gem5.git] / configs / example / ruby_mem_test.py
1 # Copyright (c) 2006-2007 The Regents of The University of Michigan
2 # Copyright (c) 2009 Advanced Micro Devices, Inc.
3 # All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
7 # met: redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer;
9 # redistributions in binary form must reproduce the above copyright
10 # notice, this list of conditions and the following disclaimer in the
11 # documentation and/or other materials provided with the distribution;
12 # neither the name of the copyright holders nor the names of its
13 # contributors may be used to endorse or promote products derived from
14 # this software without specific prior written permission.
15 #
16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #
28 # Authors: Ron Dreslinski
29 # Brad Beckmann
30
31 import m5
32 from m5.objects import *
33 from m5.defines import buildEnv
34 from m5.util import addToPath
35 import os, optparse, sys
36 addToPath('../common')
37 addToPath('../ruby')
38
39 import Ruby
40
41 if buildEnv['FULL_SYSTEM']:
42 panic("This script requires system-emulation mode (*_SE).")
43
44 # Get paths we might need. It's expected this file is in m5/configs/example.
45 config_path = os.path.dirname(os.path.abspath(__file__))
46 config_root = os.path.dirname(config_path)
47 m5_root = os.path.dirname(config_root)
48
49 parser = optparse.OptionParser()
50
51 parser.add_option("-l", "--maxloads", metavar="N", default=0,
52 help="Stop after N loads")
53 parser.add_option("--progress", type="int", default=1000,
54 metavar="NLOADS",
55 help="Progress message interval "
56 "[default: %default]")
57 parser.add_option("--num-dmas", type="int", default=0, help="# of dma testers")
58 parser.add_option("--functional", type="int", default=0,
59 help="percentage of accesses that should be functional")
60 parser.add_option("--suppress-func-warnings", action="store_true",
61 help="suppress warnings when functional accesses fail")
62
63 #
64 # Add the ruby specific and protocol specific options
65 #
66 Ruby.define_options(parser)
67
68 execfile(os.path.join(config_root, "common", "Options.py"))
69
70 (options, args) = parser.parse_args()
71
72 #
73 # Set the default cache size and associativity to be very small to encourage
74 # races between requests and writebacks.
75 #
76 options.l1d_size="256B"
77 options.l1i_size="256B"
78 options.l2_size="512B"
79 options.l3_size="1kB"
80 options.l1d_assoc=2
81 options.l1i_assoc=2
82 options.l2_assoc=2
83 options.l3_assoc=2
84
85 if args:
86 print "Error: script doesn't take any positional arguments"
87 sys.exit(1)
88
89 block_size = 64
90
91 if options.num_cpus > block_size:
92 print "Error: Number of testers %d limited to %d because of false sharing" \
93 % (options.num_cpus, block_size)
94 sys.exit(1)
95
96 #
97 # Currently ruby does not support atomic or uncacheable accesses
98 #
99 cpus = [ MemTest(atomic = False,
100 max_loads = options.maxloads,
101 issue_dmas = False,
102 percent_functional = options.functional,
103 percent_uncacheable = 0,
104 progress_interval = options.progress,
105 suppress_func_warnings = options.suppress_func_warnings) \
106 for i in xrange(options.num_cpus) ]
107
108 system = System(cpu = cpus,
109 funcmem = PhysicalMemory(),
110 physmem = PhysicalMemory())
111
112 if options.num_dmas > 0:
113 dmas = [ MemTest(atomic = False,
114 max_loads = options.maxloads,
115 issue_dmas = True,
116 percent_functional = 0,
117 percent_uncacheable = 0,
118 progress_interval = options.progress,
119 warn_on_failure = options.warn_on_failure) \
120 for i in xrange(options.num_dmas) ]
121 system.dma_devices = dmas
122 else:
123 dmas = []
124
125 Ruby.create_system(options, system, dma_devices = dmas)
126
127 #
128 # The tester is most effective when randomization is turned on and
129 # artifical delay is randomly inserted on messages
130 #
131 system.ruby.randomization = True
132
133 assert(len(cpus) == len(system.ruby._cpu_ruby_ports))
134
135 for (i, cpu) in enumerate(cpus):
136 #
137 # Tie the cpu memtester ports to the correct system ports
138 #
139 cpu.test = system.ruby._cpu_ruby_ports[i].port
140 cpu.functional = system.funcmem.port
141
142 #
143 # Since the memtester is incredibly bursty, increase the deadlock
144 # threshold to 5 million cycles
145 #
146 system.ruby._cpu_ruby_ports[i].deadlock_threshold = 5000000
147
148 #
149 # Ruby doesn't need the backing image of memory when running with
150 # the tester.
151 #
152 system.ruby._cpu_ruby_ports[i].access_phys_mem = False
153
154 for (i, dma) in enumerate(dmas):
155 #
156 # Tie the dma memtester ports to the correct functional port
157 # Note that the test port has already been connected to the dma_sequencer
158 #
159 dma.functional = system.funcmem.port
160
161 # -----------------------
162 # run simulation
163 # -----------------------
164
165 root = Root( system = system )
166 root.system.mem_mode = 'timing'
167
168 # Not much point in this being higher than the L1 latency
169 m5.ticks.setGlobalFrequency('1ns')
170
171 # instantiate configuration
172 m5.instantiate()
173
174 # simulate until program terminates
175 exit_event = m5.simulate(options.maxtick)
176
177 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()