MOESI_hammer.py revision 11266:452e10b868ea
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: Brad Beckmann 29 30import math 31import m5 32from m5.objects import * 33from m5.defines import buildEnv 34from Ruby import create_topology 35from Ruby import send_evicts 36 37# 38# Declare caches used by the protocol 39# 40class L1Cache(RubyCache): pass 41class L2Cache(RubyCache): pass 42# 43# Probe filter is a cache 44# 45class ProbeFilter(RubyCache): pass 46 47def define_options(parser): 48 parser.add_option("--allow-atomic-migration", action="store_true", 49 help="allow migratory sharing for atomic only accessed blocks") 50 parser.add_option("--pf-on", action="store_true", 51 help="Hammer: enable Probe Filter") 52 parser.add_option("--dir-on", action="store_true", 53 help="Hammer: enable Full-bit Directory") 54 55def create_system(options, full_system, system, dma_ports, ruby_system): 56 57 if buildEnv['PROTOCOL'] != 'MOESI_hammer': 58 panic("This script requires the MOESI_hammer protocol to be built.") 59 60 cpu_sequencers = [] 61 62 # 63 # The ruby network creation expects the list of nodes in the system to be 64 # consistent with the NetDest list. Therefore the l1 controller nodes must be 65 # listed before the directory nodes and directory nodes before dma nodes, etc. 66 # 67 l1_cntrl_nodes = [] 68 dir_cntrl_nodes = [] 69 dma_cntrl_nodes = [] 70 71 # 72 # Must create the individual controllers before the network to ensure the 73 # controller constructors are called before the network constructor 74 # 75 block_size_bits = int(math.log(options.cacheline_size, 2)) 76 77 for i in xrange(options.num_cpus): 78 # 79 # First create the Ruby objects associated with this cpu 80 # 81 l1i_cache = L1Cache(size = options.l1i_size, 82 assoc = options.l1i_assoc, 83 start_index_bit = block_size_bits, 84 is_icache = True) 85 l1d_cache = L1Cache(size = options.l1d_size, 86 assoc = options.l1d_assoc, 87 start_index_bit = block_size_bits) 88 l2_cache = L2Cache(size = options.l2_size, 89 assoc = options.l2_assoc, 90 start_index_bit = block_size_bits) 91 92 # the ruby random tester reuses num_cpus to specify the 93 # number of cpu ports connected to the tester object, which 94 # is stored in system.cpu. because there is only ever one 95 # tester object, num_cpus is not necessarily equal to the 96 # size of system.cpu; therefore if len(system.cpu) == 1 97 # we use system.cpu[0] to set the clk_domain, thereby ensuring 98 # we don't index off the end of the cpu list. 99 if len(system.cpu) == 1: 100 clk_domain = system.cpu[0].clk_domain 101 else: 102 clk_domain = system.cpu[i].clk_domain 103 104 l1_cntrl = L1Cache_Controller(version=i, L1Icache=l1i_cache, 105 L1Dcache=l1d_cache, L2cache=l2_cache, 106 no_mig_atomic=not \ 107 options.allow_atomic_migration, 108 send_evictions=send_evicts(options), 109 transitions_per_cycle=options.ports, 110 clk_domain=clk_domain, 111 ruby_system=ruby_system) 112 113 cpu_seq = RubySequencer(version=i, icache=l1i_cache, 114 dcache=l1d_cache,clk_domain=clk_domain, 115 ruby_system=ruby_system) 116 117 l1_cntrl.sequencer = cpu_seq 118 if options.recycle_latency: 119 l1_cntrl.recycle_latency = options.recycle_latency 120 121 exec("ruby_system.l1_cntrl%d = l1_cntrl" % i) 122 123 # Add controllers and sequencers to the appropriate lists 124 cpu_sequencers.append(cpu_seq) 125 l1_cntrl_nodes.append(l1_cntrl) 126 127 # Connect the L1 controller and the network 128 # Connect the buffers from the controller to network 129 l1_cntrl.requestFromCache = MessageBuffer() 130 l1_cntrl.requestFromCache.master = ruby_system.network.slave 131 l1_cntrl.responseFromCache = MessageBuffer() 132 l1_cntrl.responseFromCache.master = ruby_system.network.slave 133 l1_cntrl.unblockFromCache = MessageBuffer() 134 l1_cntrl.unblockFromCache.master = ruby_system.network.slave 135 136 l1_cntrl.triggerQueue = MessageBuffer() 137 138 # Connect the buffers from the network to the controller 139 l1_cntrl.mandatoryQueue = MessageBuffer() 140 l1_cntrl.forwardToCache = MessageBuffer() 141 l1_cntrl.forwardToCache.slave = ruby_system.network.master 142 l1_cntrl.responseToCache = MessageBuffer() 143 l1_cntrl.responseToCache.slave = ruby_system.network.master 144 145 146 phys_mem_size = sum(map(lambda r: r.size(), system.mem_ranges)) 147 assert(phys_mem_size % options.num_dirs == 0) 148 mem_module_size = phys_mem_size / options.num_dirs 149 150 # 151 # determine size and index bits for probe filter 152 # By default, the probe filter size is configured to be twice the 153 # size of the L2 cache. 154 # 155 pf_size = MemorySize(options.l2_size) 156 pf_size.value = pf_size.value * 2 157 dir_bits = int(math.log(options.num_dirs, 2)) 158 pf_bits = int(math.log(pf_size.value, 2)) 159 if options.numa_high_bit: 160 if options.pf_on or options.dir_on: 161 # if numa high bit explicitly set, make sure it does not overlap 162 # with the probe filter index 163 assert(options.numa_high_bit - dir_bits > pf_bits) 164 165 # set the probe filter start bit to just above the block offset 166 pf_start_bit = block_size_bits 167 else: 168 if dir_bits > 0: 169 pf_start_bit = dir_bits + block_size_bits - 1 170 else: 171 pf_start_bit = block_size_bits 172 173 # Run each of the ruby memory controllers at a ratio of the frequency of 174 # the ruby system 175 # clk_divider value is a fix to pass regression. 176 ruby_system.memctrl_clk_domain = DerivedClockDomain( 177 clk_domain=ruby_system.clk_domain, 178 clk_divider=3) 179 180 for i in xrange(options.num_dirs): 181 dir_size = MemorySize('0B') 182 dir_size.value = mem_module_size 183 184 pf = ProbeFilter(size = pf_size, assoc = 4, 185 start_index_bit = pf_start_bit) 186 187 dir_cntrl = Directory_Controller(version = i, 188 directory = RubyDirectoryMemory( 189 version = i, size = dir_size), 190 probeFilter = pf, 191 probe_filter_enabled = options.pf_on, 192 full_bit_dir_enabled = options.dir_on, 193 transitions_per_cycle = options.ports, 194 ruby_system = ruby_system) 195 196 if options.recycle_latency: 197 dir_cntrl.recycle_latency = options.recycle_latency 198 199 exec("ruby_system.dir_cntrl%d = dir_cntrl" % i) 200 dir_cntrl_nodes.append(dir_cntrl) 201 202 # Connect the directory controller to the network 203 dir_cntrl.forwardFromDir = MessageBuffer() 204 dir_cntrl.forwardFromDir.master = ruby_system.network.slave 205 dir_cntrl.responseFromDir = MessageBuffer() 206 dir_cntrl.responseFromDir.master = ruby_system.network.slave 207 dir_cntrl.dmaResponseFromDir = MessageBuffer(ordered = True) 208 dir_cntrl.dmaResponseFromDir.master = ruby_system.network.slave 209 210 dir_cntrl.triggerQueue = MessageBuffer(ordered = True) 211 212 dir_cntrl.unblockToDir = MessageBuffer() 213 dir_cntrl.unblockToDir.slave = ruby_system.network.master 214 dir_cntrl.responseToDir = MessageBuffer() 215 dir_cntrl.responseToDir.slave = ruby_system.network.master 216 dir_cntrl.requestToDir = MessageBuffer() 217 dir_cntrl.requestToDir.slave = ruby_system.network.master 218 dir_cntrl.dmaRequestToDir = MessageBuffer(ordered = True) 219 dir_cntrl.dmaRequestToDir.slave = ruby_system.network.master 220 dir_cntrl.responseFromMemory = MessageBuffer() 221 222 223 for i, dma_port in enumerate(dma_ports): 224 # 225 # Create the Ruby objects associated with the dma controller 226 # 227 dma_seq = DMASequencer(version = i, 228 ruby_system = ruby_system, 229 slave = dma_port) 230 231 dma_cntrl = DMA_Controller(version = i, 232 dma_sequencer = dma_seq, 233 transitions_per_cycle = options.ports, 234 ruby_system = ruby_system) 235 236 exec("ruby_system.dma_cntrl%d = dma_cntrl" % i) 237 dma_cntrl_nodes.append(dma_cntrl) 238 239 if options.recycle_latency: 240 dma_cntrl.recycle_latency = options.recycle_latency 241 242 # Connect the dma controller to the network 243 dma_cntrl.responseFromDir = MessageBuffer(ordered = True) 244 dma_cntrl.responseFromDir.slave = ruby_system.network.master 245 dma_cntrl.requestToDir = MessageBuffer() 246 dma_cntrl.requestToDir.master = ruby_system.network.slave 247 dma_cntrl.mandatoryQueue = MessageBuffer() 248 249 all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes + dma_cntrl_nodes 250 251 # Create the io controller and the sequencer 252 if full_system: 253 io_seq = DMASequencer(version=len(dma_ports), ruby_system=ruby_system) 254 ruby_system._io_port = io_seq 255 io_controller = DMA_Controller(version = len(dma_ports), 256 dma_sequencer = io_seq, 257 ruby_system = ruby_system) 258 ruby_system.io_controller = io_controller 259 260 # Connect the dma controller to the network 261 io_controller.responseFromDir = MessageBuffer(ordered = True) 262 io_controller.responseFromDir.slave = ruby_system.network.master 263 io_controller.requestToDir = MessageBuffer() 264 io_controller.requestToDir.master = ruby_system.network.slave 265 io_controller.mandatoryQueue = MessageBuffer() 266 267 all_cntrls = all_cntrls + [io_controller] 268 269 ruby_system.network.number_of_virtual_networks = 6 270 topology = create_topology(all_cntrls, options) 271 return (cpu_sequencers, dir_cntrl_nodes, topology) 272