ruby_mem_test.py revision 12564:2778478ca882 
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
31from __future__ import print_function
32
33import m5
34from m5.objects import *
35from m5.defines import buildEnv
36from m5.util import addToPath
37import os, optparse, sys
38
39addToPath('../')
40
41from common import Options
42from ruby import Ruby
43
44# Get paths we might need.  It's expected this file is in m5/configs/example.
45config_path = os.path.dirname(os.path.abspath(__file__))
46config_root = os.path.dirname(config_path)
47
48parser = optparse.OptionParser()
49Options.addNoISAOptions(parser)
50
51parser.add_option("--maxloads", metavar="N", default=0,
52                  help="Stop after N loads")
53parser.add_option("--progress", type="int", default=1000,
54                  metavar="NLOADS",
55                  help="Progress message interval "
56                  "[default: %default]")
57parser.add_option("--num-dmas", type="int", default=0, help="# of dma testers")
58parser.add_option("--functional", type="int", default=0,
59                  help="percentage of accesses that should be functional")
60parser.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#
66Ruby.define_options(parser)
67
68execfile(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#
76options.l1d_size="256B"
77options.l1i_size="256B"
78options.l2_size="512B"
79options.l3_size="1kB"
80options.l1d_assoc=2
81options.l1i_assoc=2
82options.l2_assoc=2
83options.l3_assoc=2
84
85if args:
86     print("Error: script doesn't take any positional arguments")
87     sys.exit(1)
88
89block_size = 64
90
91if 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#
99cpus = [ 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
108system = System(cpu = cpus,
109                funcmem = SimpleMemory(in_addr_map = False),
110                funcbus = IOXBar(),
111                clk_domain = SrcClockDomain(clock = options.sys_clock),
112                mem_ranges = [AddrRange(options.mem_size)])
113
114if 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
125else:
126    dmas = []
127
128dma_ports = []
129for (i, dma) in enumerate(dmas):
130    dma_ports.append(dma.test)
131Ruby.create_system(options, False, system, dma_ports = dma_ports)
132
133# Create a top-level voltage domain and clock domain
134system.voltage_domain = VoltageDomain(voltage = options.sys_voltage)
135system.clk_domain = SrcClockDomain(clock = options.sys_clock,
136                                   voltage_domain = system.voltage_domain)
137# Create a seperate clock domain for Ruby
138system.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#
145system.ruby.randomization = True
146
147assert(len(cpus) == len(system.ruby._cpu_ports))
148
149for (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
162for (i, dma) in enumerate(dmas):
163    #
164    # Tie the dma memtester ports to the correct functional port
165    # Note that the test port has already been connected to the dma_sequencer
166    #
167    dma.functional = system.funcbus.slave
168
169# connect reference memory to funcbus
170system.funcbus.master = system.funcmem.port
171
172# -----------------------
173# run simulation
174# -----------------------
175
176root = Root( full_system = False, system = system )
177root.system.mem_mode = 'timing'
178
179# Not much point in this being higher than the L1 latency
180m5.ticks.setGlobalFrequency('1ns')
181
182# instantiate configuration
183m5.instantiate()
184
185# simulate until program terminates
186exit_event = m5.simulate(options.abs_max_tick)
187
188print('Exiting @ tick', m5.curTick(), 'because', exit_event.getCause())
189