Ruby: Add support for functional accesses
[gem5.git] / configs / example / ruby_random_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
39 import Ruby
40
41 if buildEnv['FULL_SYSTEM']:
42 panic("This script requires system-emulation mode (*_SE).")
43
44 # Get paths we might need. It's expected this file is in m5/configs/example.
45 config_path = os.path.dirname(os.path.abspath(__file__))
46 config_root = os.path.dirname(config_path)
47 m5_root = os.path.dirname(config_root)
48
49 parser = optparse.OptionParser()
50
51 parser.add_option("-l", "--checks", metavar="N", default=100,
52 help="Stop after N checks (loads)")
53 parser.add_option("-f", "--wakeup_freq", metavar="N", default=10,
54 help="Wakeup every N cycles")
55
56 #
57 # Add the ruby specific and protocol specific options
58 #
59 Ruby.define_options(parser)
60
61 execfile(os.path.join(config_root, "common", "Options.py"))
62
63 (options, args) = parser.parse_args()
64
65 #
66 # Set the default cache size and associativity to be very small to encourage
67 # races between requests and writebacks.
68 #
69 options.l1d_size="256B"
70 options.l1i_size="256B"
71 options.l2_size="512B"
72 options.l3_size="1kB"
73 options.l1d_assoc=2
74 options.l1i_assoc=2
75 options.l2_assoc=2
76 options.l3_assoc=2
77
78 if args:
79 print "Error: script doesn't take any positional arguments"
80 sys.exit(1)
81
82 #
83 # Create the ruby random tester
84 #
85
86 # Check the protocol
87 check_flush = False
88 if buildEnv['PROTOCOL'] == 'MOESI_hammer':
89 check_flush = True
90
91 tester = RubyTester(check_flush = check_flush,
92 checks_to_complete = options.checks,
93 wakeup_frequency = options.wakeup_freq)
94
95 #
96 # Create the M5 system. Note that the PhysicalMemory Object isn't
97 # actually used by the rubytester, but is included to support the
98 # M5 memory size == Ruby memory size checks
99 #
100 system = System(tester = tester, physmem = PhysicalMemory())
101
102 Ruby.create_system(options, system)
103
104 assert(options.num_cpus == len(system.ruby._cpu_ruby_ports))
105
106 #
107 # The tester is most effective when randomization is turned on and
108 # artifical delay is randomly inserted on messages
109 #
110 system.ruby.randomization = True
111
112 for ruby_port in system.ruby._cpu_ruby_ports:
113 #
114 # Tie the ruby tester ports to the ruby cpu ports
115 #
116 tester.cpuPort = ruby_port.port
117
118 #
119 # Tell each sequencer this is the ruby tester so that it
120 # copies the subblock back to the checker
121 #
122 ruby_port.using_ruby_tester = True
123
124 #
125 # Ruby doesn't need the backing image of memory when running with
126 # the tester.
127 #
128 ruby_port.access_phys_mem = False
129
130 # -----------------------
131 # run simulation
132 # -----------------------
133
134 root = Root( system = system )
135 root.system.mem_mode = 'timing'
136
137 # Not much point in this being higher than the L1 latency
138 m5.ticks.setGlobalFrequency('1ns')
139
140 # instantiate configuration
141 m5.instantiate()
142
143 # simulate until program terminates
144 exit_event = m5.simulate(options.maxtick)
145
146 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()