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