Merge branch 'release-staging-v20.0.0.0' into develop
[gem5.git] / configs / example / ruby_gpu_random_test.py
1 # Copyright (c) 2010-2015 Advanced Micro Devices, Inc.
2 # All rights reserved.
3 #
4 # For use for simulation and test purposes only
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are met:
8 #
9 # 1. Redistributions of source code must retain the above copyright notice,
10 # this list of conditions and the following disclaimer.
11 #
12 # 2. Redistributions in binary form must reproduce the above copyright notice,
13 # this list of conditions and the following disclaimer in the documentation
14 # and/or other materials provided with the distribution.
15 #
16 # 3. Neither the name of the copyright holder nor the names of its
17 # contributors may be used to endorse or promote products derived from this
18 # software without specific prior written permission.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 # POSSIBILITY OF SUCH DAMAGE.
31
32 from __future__ import print_function
33 from __future__ import absolute_import
34
35 import m5
36 from m5.objects import *
37 from m5.defines import buildEnv
38 from m5.util import addToPath
39 import os, optparse, sys
40
41 addToPath('../')
42
43 from common import Options
44 from ruby import Ruby
45
46 # Get paths we might need.
47 config_path = os.path.dirname(os.path.abspath(__file__))
48 config_root = os.path.dirname(config_path)
49 m5_root = os.path.dirname(config_root)
50
51 parser = optparse.OptionParser()
52 Options.addNoISAOptions(parser)
53
54 parser.add_option("--maxloads", metavar="N", default=100,
55 help="Stop after N loads")
56 parser.add_option("-f", "--wakeup_freq", metavar="N", default=10,
57 help="Wakeup every N cycles")
58 parser.add_option("-u", "--num-compute-units", type="int", default=1,
59 help="number of compute units in the GPU")
60 parser.add_option("--num-cp", type="int", default=0,
61 help="Number of GPU Command Processors (CP)")
62 # not super important now, but to avoid putting the number 4 everywhere, make
63 # it an option/knob
64 parser.add_option("--cu-per-sqc", type="int", default=4, help="number of CUs \
65 sharing an SQC (icache, and thus icache TLB)")
66 parser.add_option("--simds-per-cu", type="int", default=4, help="SIMD units" \
67 "per CU")
68 parser.add_option("--wf-size", type="int", default=64,
69 help="Wavefront size(in workitems)")
70 parser.add_option("--wfs-per-simd", type="int", default=10, help="Number of " \
71 "WF slots per SIMD")
72
73 #
74 # Add the ruby specific and protocol specific options
75 #
76 Ruby.define_options(parser)
77
78 exec(compile( \
79 open(os.path.join(config_root, "common", "Options.py")).read(), \
80 os.path.join(config_root, "common", "Options.py"), 'exec'))
81
82 (options, args) = parser.parse_args()
83
84 #
85 # Set the default cache size and associativity to be very small to encourage
86 # races between requests and writebacks.
87 #
88 options.l1d_size="256B"
89 options.l1i_size="256B"
90 options.l2_size="512B"
91 options.l3_size="1kB"
92 options.l1d_assoc=2
93 options.l1i_assoc=2
94 options.l2_assoc=2
95 options.l3_assoc=2
96
97 # This file can support multiple compute units
98 assert(options.num_compute_units >= 1)
99 n_cu = options.num_compute_units
100
101 options.num_sqc = int((n_cu + options.cu_per_sqc - 1) // options.cu_per_sqc)
102
103 if args:
104 print("Error: script doesn't take any positional arguments")
105 sys.exit(1)
106
107 #
108 # Create the ruby random tester
109 #
110
111 # Check to for the GPU_RfO protocol. Other GPU protocols are non-SC and will
112 # not work with the Ruby random tester.
113 assert(buildEnv['PROTOCOL'] == 'GPU_RfO')
114
115 # The GPU_RfO protocol does not support cache flushes
116 check_flush = False
117
118 tester = RubyTester(check_flush=check_flush,
119 checks_to_complete=options.maxloads,
120 wakeup_frequency=options.wakeup_freq,
121 deadlock_threshold=1000000)
122
123 #
124 # Create the M5 system. Note that the Memory Object isn't
125 # actually used by the rubytester, but is included to support the
126 # M5 memory size == Ruby memory size checks
127 #
128 system = System(cpu=tester, mem_ranges=[AddrRange(options.mem_size)])
129
130 # Create a top-level voltage domain and clock domain
131 system.voltage_domain = VoltageDomain(voltage=options.sys_voltage)
132
133 system.clk_domain = SrcClockDomain(clock=options.sys_clock,
134 voltage_domain=system.voltage_domain)
135
136 Ruby.create_system(options, False, system)
137
138 # Create a seperate clock domain for Ruby
139 system.ruby.clk_domain = SrcClockDomain(clock=options.ruby_clock,
140 voltage_domain=system.voltage_domain)
141
142 tester.num_cpus = len(system.ruby._cpu_ports)
143
144 #
145 # The tester is most effective when randomization is turned on and
146 # artifical delay is randomly inserted on messages
147 #
148 system.ruby.randomization = True
149
150 for ruby_port in system.ruby._cpu_ports:
151
152 #
153 # Tie the ruby tester ports to the ruby cpu read and write ports
154 #
155 if ruby_port.support_data_reqs and ruby_port.support_inst_reqs:
156 tester.cpuInstDataPort = ruby_port.slave
157 elif ruby_port.support_data_reqs:
158 tester.cpuDataPort = ruby_port.slave
159 elif ruby_port.support_inst_reqs:
160 tester.cpuInstPort = ruby_port.slave
161
162 # Do not automatically retry stalled Ruby requests
163 ruby_port.no_retry_on_stall = True
164
165 #
166 # Tell each sequencer this is the ruby tester so that it
167 # copies the subblock back to the checker
168 #
169 ruby_port.using_ruby_tester = True
170
171 # -----------------------
172 # run simulation
173 # -----------------------
174
175 root = Root( full_system = False, system = system )
176 root.system.mem_mode = 'timing'
177
178 # Not much point in this being higher than the L1 latency
179 m5.ticks.setGlobalFrequency('1ns')
180
181 # instantiate configuration
182 m5.instantiate()
183
184 # simulate until program terminates
185 exit_event = m5.simulate(options.abs_max_tick)
186
187 print('Exiting @ tick', m5.curTick(), 'because', exit_event.getCause())