Merge zizzer:/bk/newmem
[gem5.git] / configs / splash2 / run.py
1 # Copyright (c) 2005-2006 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: Ron Dreslinski
28
29 # Splash2 Run Script
30 #
31
32 import m5
33 from m5.objects import *
34 import os, optparse, sys
35 m5.AddToPath('../common')
36
37 # --------------------
38 # Define Command Line Options
39 # ====================
40
41 parser = optparse.OptionParser()
42
43 parser.add_option("-d", "--detailed", action="store_true")
44 parser.add_option("-t", "--timing", action="store_true")
45 parser.add_option("-m", "--maxtick", type="int")
46 parser.add_option("-n", "--numcpus",
47 help="Number of cpus in total", type="int")
48 parser.add_option("-f", "--frequency",
49 default = "1GHz",
50 help="Frequency of each CPU")
51 parser.add_option("-p", "--protocol",
52 default="moesi",
53 help="The coherence protocol to use for the L1'a (i.e. MOESI, MOSI)")
54 parser.add_option("--l1size",
55 default = "32kB")
56 parser.add_option("--l1latency",
57 default = 1)
58 parser.add_option("--l2size",
59 default = "256kB")
60 parser.add_option("--l2latency",
61 default = 10)
62 parser.add_option("--rootdir",
63 help="ROot directory of Splash2",
64 default="/dist/splash2/codes")
65 parser.add_option("-b", "--benchmark",
66 help="Splash 2 benchmark to run")
67
68 (options, args) = parser.parse_args()
69
70 if args:
71 print "Error: script doesn't take any positional arguments"
72 sys.exit(1)
73
74 if not options.numcpus:
75 print "Specify the number of cpus with -n"
76 sys.exit(1)
77
78 # --------------------
79 # Define Splash2 Benchmarks
80 # ====================
81 class Cholesky(LiveProcess):
82 executable = options.rootdir + '/kernels/cholesky/CHOLESKY'
83 cmd = 'CHOLESKY -p' + str(options.numcpus) + ' '\
84 + options.rootdir + '/kernels/cholesky/inputs/tk23.O'
85
86 class FFT(LiveProcess):
87 executable = options.rootdir + '/kernels/fft/FFT'
88 cmd = 'FFT -p' + str(options.numcpus) + ' -m18'
89
90 class LU_contig(LiveProcess):
91 executable = options.rootdir + '/kernels/lu/contiguous_blocks/LU'
92 cmd = 'LU -p' + str(options.numcpus)
93
94 class LU_noncontig(LiveProcess):
95 executable = options.rootdir + '/kernels/lu/non_contiguous_blocks/LU'
96 cmd = 'LU -p' + str(options.numcpus)
97
98 class Radix(LiveProcess):
99 executable = options.rootdir + '/kernels/radix/RADIX'
100 cmd = 'RADIX -n524288 -p' + str(options.numcpus)
101
102 class Barnes(LiveProcess):
103 executable = options.rootdir + '/apps/barnes/BARNES'
104 cmd = 'BARNES'
105 input = options.rootdir + '/apps/barnes/input.p' + str(options.numcpus)
106
107 class FMM(LiveProcess):
108 executable = options.rootdir + '/apps/fmm/FMM'
109 cmd = 'FMM'
110 input = options.rootdir + '/apps/fmm/inputs/input.2048.p' + str(options.numcpus)
111
112 class Ocean_contig(LiveProcess):
113 executable = options.rootdir + '/apps/ocean/contiguous_partitions/OCEAN'
114 cmd = 'OCEAN -p' + str(options.numcpus)
115
116 class Ocean_noncontig(LiveProcess):
117 executable = options.rootdir + '/apps/ocean/non_contiguous_partitions/OCEAN'
118 cmd = 'OCEAN -p' + str(options.numcpus)
119
120 class Raytrace(LiveProcess):
121 executable = options.rootdir + '/apps/raytrace/RAYTRACE'
122 cmd = 'RAYTRACE -p' + str(options.numcpus) + ' ' \
123 + options.rootdir + 'apps/raytrace/inputs/teapot.env'
124
125 class Water_nsquared(LiveProcess):
126 executable = options.rootdir + '/apps/water-nsquared/WATER-NSQUARED'
127 cmd = 'WATER-NSQUARED'
128 input = options.rootdir + '/apps/water-nsquared/input.p' + str(options.numcpus)
129
130 class Water_spatial(LiveProcess):
131 executable = options.rootdir + '/apps/water-spatial/WATER-SPATIAL'
132 cmd = 'WATER-SPATIAL'
133 input = options.rootdir + '/apps/water-spatial/input.p' + str(options.numcpus)
134
135
136 # --------------------
137 # Base L1 Cache Definition
138 # ====================
139
140 class L1(BaseCache):
141 latency = options.l1latency
142 block_size = 64
143 mshrs = 12
144 tgts_per_mshr = 8
145 protocol = CoherenceProtocol(protocol=options.protocol)
146
147 # ----------------------
148 # Base L2 Cache Definition
149 # ----------------------
150
151 class L2(BaseCache):
152 block_size = 64
153 latency = options.l2latency
154 mshrs = 92
155 tgts_per_mshr = 16
156 write_buffers = 8
157
158 # ----------------------
159 # Define the cpus
160 # ----------------------
161
162 busFrequency = Frequency(options.frequency)
163
164 if options.timing:
165 cpus = [TimingSimpleCPU(cpu_id = i,
166 clock=options.frequency)
167 for i in xrange(options.numcpus)]
168 elif options.detailed:
169 cpus = [DerivO3CPU(cpu_id = i,
170 clock=options.frequency)
171 for i in xrange(options.numcpus)]
172 else:
173 cpus = [AtomicSimpleCPU(cpu_id = i,
174 clock=options.frequency)
175 for i in xrange(options.numcpus)]
176
177 # ----------------------
178 # Create a system, and add system wide objects
179 # ----------------------
180 system = System(cpu = cpus, physmem = PhysicalMemory(),
181 membus = Bus(clock = busFrequency))
182
183 system.toL2bus = Bus(clock = busFrequency)
184 system.l2 = L2(size = options.l2size, assoc = 8)
185
186 # ----------------------
187 # Connect the L2 cache and memory together
188 # ----------------------
189
190 system.physmem.port = system.membus.port
191 system.l2.cpu_side = system.toL2bus.port
192 system.l2.mem_side = system.membus.port
193
194 # ----------------------
195 # Connect the L2 cache and clusters together
196 # ----------------------
197 for cpu in cpus:
198 cpu.addPrivateSplitL1Caches(L1(size = options.l1size, assoc = 1),
199 L1(size = options.l1size, assoc = 4))
200 cpu.mem = cpu.dcache
201 # connect cpu level-1 caches to shared level-2 cache
202 cpu.connectMemPorts(system.toL2bus)
203
204
205 # ----------------------
206 # Define the root
207 # ----------------------
208
209 root = Root(system = system)
210
211 # --------------------
212 # Pick the correct Splash2 Benchmarks
213 # ====================
214 if options.benchmark == 'Cholesky':
215 root.workload = Cholesky()
216 elif options.benchmark == 'FFT':
217 root.workload = FFT()
218 elif options.benchmark == 'LUContig':
219 root.workload = LU_contig()
220 elif options.benchmark == 'LUNoncontig':
221 root.workload = LU_noncontig()
222 elif options.benchmark == 'Radix':
223 root.workload = Radix()
224 elif options.benchmark == 'Barnes':
225 root.workload = Barnes()
226 elif options.benchmark == 'FMM':
227 root.workload = FMM()
228 elif options.benchmark == 'OceanContig':
229 root.workload = Ocean_contig()
230 elif options.benchmark == 'OceanNoncontig':
231 root.workload = Ocean_noncontig()
232 elif options.benchmark == 'Raytrace':
233 root.workload = Raytrace()
234 elif options.benchmark == 'WaterNSquared':
235 root.workload = Water_nsquared()
236 elif options.benchmark == 'WaterSpatial':
237 root.workload = Water_spatial()
238 else:
239 panic("The --benchmark environment variable was set to something" \
240 +" improper.\nUse Cholesky, FFT, LUContig, LUNoncontig, Radix" \
241 +", Barnes, FMM, OceanContig,\nOceanNoncontig, Raytrace," \
242 +" WaterNSquared, or WaterSpatial\n")
243
244 # --------------------
245 # Assign the workload to the cpus
246 # ====================
247
248 for cpu in cpus:
249 cpu.workload = root.workload
250
251 # ----------------------
252 # Run the simulation
253 # ----------------------
254
255 if options.timing or options.detailed:
256 root.system.mem_mode = 'timing'
257
258 # instantiate configuration
259 m5.instantiate(root)
260
261 # simulate until program terminates
262 if options.maxtick:
263 exit_event = m5.simulate(options.maxtick)
264 else:
265 exit_event = m5.simulate(m5.MaxTick)
266
267 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()
268