99f6f4a09b7e392b5984ddbad0f21042c49b2f5e
[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 addToPath('../topologies')
39
40 import Options
41 import Ruby
42
43 # Get paths we might need. It's expected this file is in m5/configs/example.
44 config_path = os.path.dirname(os.path.abspath(__file__))
45 config_root = os.path.dirname(config_path)
46
47 parser = optparse.OptionParser()
48 Options.addCommonOptions(parser)
49
50 parser.add_option("--maxloads", metavar="N", default=0,
51 help="Stop after N loads")
52 parser.add_option("--progress", type="int", default=1000,
53 metavar="NLOADS",
54 help="Progress message interval "
55 "[default: %default]")
56 parser.add_option("--num-dmas", type="int", default=0, help="# of dma testers")
57 parser.add_option("--functional", type="int", default=0,
58 help="percentage of accesses that should be functional")
59 parser.add_option("--suppress-func-warnings", action="store_true",
60 help="suppress warnings when functional accesses fail")
61
62 #
63 # Add the ruby specific and protocol specific options
64 #
65 Ruby.define_options(parser)
66
67 execfile(os.path.join(config_root, "common", "Options.py"))
68
69 (options, args) = parser.parse_args()
70
71 #
72 # Set the default cache size and associativity to be very small to encourage
73 # races between requests and writebacks.
74 #
75 options.l1d_size="256B"
76 options.l1i_size="256B"
77 options.l2_size="512B"
78 options.l3_size="1kB"
79 options.l1d_assoc=2
80 options.l1i_assoc=2
81 options.l2_assoc=2
82 options.l3_assoc=2
83
84 if args:
85 print "Error: script doesn't take any positional arguments"
86 sys.exit(1)
87
88 block_size = 64
89
90 if options.num_cpus > block_size:
91 print "Error: Number of testers %d limited to %d because of false sharing" \
92 % (options.num_cpus, block_size)
93 sys.exit(1)
94
95 #
96 # Currently ruby does not support atomic or uncacheable accesses
97 #
98 cpus = [ MemTest(atomic = False,
99 max_loads = options.maxloads,
100 issue_dmas = False,
101 percent_functional = options.functional,
102 percent_uncacheable = 0,
103 progress_interval = options.progress,
104 suppress_func_warnings = options.suppress_func_warnings) \
105 for i in xrange(options.num_cpus) ]
106
107 system = System(cpu = cpus,
108 funcmem = SimpleMemory(in_addr_map = False),
109 funcbus = NoncoherentBus(),
110 physmem = SimpleMemory(),
111 clk_domain = SrcClockDomain(clock = options.sys_clock),
112 mem_ranges = [AddrRange(options.mem_size)])
113
114 if options.num_dmas > 0:
115 dmas = [ MemTest(atomic = False,
116 max_loads = options.maxloads,
117 issue_dmas = True,
118 percent_functional = 0,
119 percent_uncacheable = 0,
120 progress_interval = options.progress,
121 suppress_func_warnings =
122 not options.suppress_func_warnings) \
123 for i in xrange(options.num_dmas) ]
124 system.dma_devices = dmas
125 else:
126 dmas = []
127
128 dma_ports = []
129 for (i, dma) in enumerate(dmas):
130 dma_ports.append(dma.test)
131 Ruby.create_system(options, system, dma_ports = dma_ports)
132
133 # Create a top-level voltage domain and clock domain
134 system.voltage_domain = VoltageDomain(voltage = options.sys_voltage)
135 system.clk_domain = SrcClockDomain(clock = options.sys_clock,
136 voltage_domain = system.voltage_domain)
137 # Create a seperate clock domain for Ruby
138 system.ruby.clk_domain = SrcClockDomain(clock = options.ruby_clock,
139 voltage_domain = system.voltage_domain)
140
141 #
142 # The tester is most effective when randomization is turned on and
143 # artifical delay is randomly inserted on messages
144 #
145 system.ruby.randomization = True
146
147 assert(len(cpus) == len(system.ruby._cpu_ports))
148
149 for (i, cpu) in enumerate(cpus):
150 #
151 # Tie the cpu memtester ports to the correct system ports
152 #
153 cpu.test = system.ruby._cpu_ports[i].slave
154 cpu.functional = system.funcbus.slave
155
156 #
157 # Since the memtester is incredibly bursty, increase the deadlock
158 # threshold to 5 million cycles
159 #
160 system.ruby._cpu_ports[i].deadlock_threshold = 5000000
161
162 #
163 # Ruby doesn't need the backing image of memory when running with
164 # the tester.
165 #
166 system.ruby._cpu_ports[i].access_phys_mem = False
167
168 for (i, dma) in enumerate(dmas):
169 #
170 # Tie the dma memtester ports to the correct functional port
171 # Note that the test port has already been connected to the dma_sequencer
172 #
173 dma.functional = system.funcbus.slave
174
175 # connect reference memory to funcbus
176 system.funcbus.master = system.funcmem.port
177
178 # -----------------------
179 # run simulation
180 # -----------------------
181
182 root = Root( full_system = False, system = system )
183 root.system.mem_mode = 'timing'
184
185 # Not much point in this being higher than the L1 latency
186 m5.ticks.setGlobalFrequency('1ns')
187
188 # instantiate configuration
189 m5.instantiate()
190
191 # simulate until program terminates
192 exit_event = m5.simulate(options.abs_max_tick)
193
194 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()