configs/ruby/MOESI_hammer.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: Brad Beckmann
  29
  30 import math
  31 import m5
  32 from m5.objects import *
  33 from m5.defines import buildEnv
  34
  35 #
  36 # Note: the L1 Cache latency is only used by the sequencer on fast path hits
  37 #
  38 class L1Cache(RubyCache):
  39     latency = 2
  40
  41 #
  42 # Note: the L2 Cache latency is not currently used
  43 #
  44 class L2Cache(RubyCache):
  45     latency = 10
  46
  47 #
  48 # Probe filter is a cache, latency is not used
  49 #
  50 class ProbeFilter(RubyCache):
  51     latency = 1
  52
  53 def define_options(parser):
  54     parser.add_option("--allow-atomic-migration", action="store_true",
  55           help="allow migratory sharing for atomic only accessed blocks")
  56     parser.add_option("--pf-on", action="store_true",
  57           help="Hammer: enable Probe Filter")
  58     parser.add_option("--dir-on", action="store_true",
  59           help="Hammer: enable Full-bit Directory")
  60
  61 def create_system(options, system, piobus, dma_devices, ruby_system):
  62
  63     if buildEnv['PROTOCOL'] != 'MOESI_hammer':
  64         panic("This script requires the MOESI_hammer protocol to be built.")
  65
  66     cpu_sequencers = []
  67
  68     #
  69     # The ruby network creation expects the list of nodes in the system to be
  70     # consistent with the NetDest list.  Therefore the l1 controller nodes must be
  71     # listed before the directory nodes and directory nodes before dma nodes, etc.
  72     #
  73     l1_cntrl_nodes = []
  74     dir_cntrl_nodes = []
  75     dma_cntrl_nodes = []
  76
  77     #
  78     # Must create the individual controllers before the network to ensure the
  79     # controller constructors are called before the network constructor
  80     #
  81     block_size_bits = int(math.log(options.cacheline_size, 2))
  82
  83     cntrl_count = 0
  84
  85     for i in xrange(options.num_cpus):
  86         #
  87         # First create the Ruby objects associated with this cpu
  88         #
  89         l1i_cache = L1Cache(size = options.l1i_size,
  90                             assoc = options.l1i_assoc,
  91                             start_index_bit = block_size_bits,
  92                             is_icache = True)
  93         l1d_cache = L1Cache(size = options.l1d_size,
  94                             assoc = options.l1d_assoc,
  95                             start_index_bit = block_size_bits)
  96         l2_cache = L2Cache(size = options.l2_size,
  97                            assoc = options.l2_assoc,
  98                            start_index_bit = block_size_bits)
  99
 100         l1_cntrl = L1Cache_Controller(version = i,
 101                                       cntrl_id = cntrl_count,
 102                                       L1IcacheMemory = l1i_cache,
 103                                       L1DcacheMemory = l1d_cache,
 104                                       L2cacheMemory = l2_cache,
 105                                       no_mig_atomic = not \
 106                                         options.allow_atomic_migration,
 107                                       send_evictions = (
 108                                           options.cpu_type == "detailed"),
 109                                       ruby_system = ruby_system)
 110
 111         cpu_seq = RubySequencer(version = i,
 112                                 icache = l1i_cache,
 113                                 dcache = l1d_cache,
 114                                 physMemPort = system.physmem.port,
 115                                 physmem = system.physmem,
 116                                 ruby_system = ruby_system)
 117
 118         l1_cntrl.sequencer = cpu_seq
 119
 120         if piobus != None:
 121             cpu_seq.pio_port = piobus.slave
 122
 123         if options.recycle_latency:
 124             l1_cntrl.recycle_latency = options.recycle_latency
 125
 126         exec("system.l1_cntrl%d = l1_cntrl" % i)
 127         #
 128         # Add controllers and sequencers to the appropriate lists
 129         #
 130         cpu_sequencers.append(cpu_seq)
 131         l1_cntrl_nodes.append(l1_cntrl)
 132
 133         cntrl_count += 1
 134
 135     phys_mem_size = long(system.physmem.range.second) - \
 136                       long(system.physmem.range.first) + 1
 137     mem_module_size = phys_mem_size / options.num_dirs
 138
 139     #
 140     # determine size and index bits for probe filter
 141     # By default, the probe filter size is configured to be twice the
 142     # size of the L2 cache.
 143     #
 144     pf_size = MemorySize(options.l2_size)
 145     pf_size.value = pf_size.value * 2
 146     dir_bits = int(math.log(options.num_dirs, 2))
 147     pf_bits = int(math.log(pf_size.value, 2))
 148     if options.numa_high_bit:
 149         if options.numa_high_bit > 0:
 150             # if numa high bit explicitly set, make sure it does not overlap
 151             # with the probe filter index
 152             assert(options.numa_high_bit - dir_bits > pf_bits)
 153
 154         # set the probe filter start bit to just above the block offset
 155         pf_start_bit = 6
 156     else:
 157         if dir_bits > 0:
 158             pf_start_bit = dir_bits + 5
 159         else:
 160             pf_start_bit = 6
 161
 162     for i in xrange(options.num_dirs):
 163         #
 164         # Create the Ruby objects associated with the directory controller
 165         #
 166
 167         mem_cntrl = RubyMemoryControl(version = i)
 168
 169         dir_size = MemorySize('0B')
 170         dir_size.value = mem_module_size
 171
 172         pf = ProbeFilter(size = pf_size, assoc = 4,
 173                          start_index_bit = pf_start_bit)
 174
 175         dir_cntrl = Directory_Controller(version = i,
 176                                          cntrl_id = cntrl_count,
 177                                          directory = \
 178                                          RubyDirectoryMemory( \
 179                                                     version = i,
 180                                                     size = dir_size,
 181                                                     use_map = options.use_map,
 182                                                     map_levels = \
 183                                                     options.map_levels,
 184                                                     numa_high_bit = \
 185                                                       options.numa_high_bit),
 186                                          probeFilter = pf,
 187                                          memBuffer = mem_cntrl,
 188                                          probe_filter_enabled = options.pf_on,
 189                                          full_bit_dir_enabled = options.dir_on,
 190                                          ruby_system = ruby_system)
 191
 192         if options.recycle_latency:
 193             dir_cntrl.recycle_latency = options.recycle_latency
 194
 195         exec("system.dir_cntrl%d = dir_cntrl" % i)
 196         dir_cntrl_nodes.append(dir_cntrl)
 197
 198         cntrl_count += 1
 199
 200     for i, dma_device in enumerate(dma_devices):
 201         #
 202         # Create the Ruby objects associated with the dma controller
 203         #
 204         dma_seq = DMASequencer(version = i,
 205                                physMemPort = system.physmem.port,
 206                                physmem = system.physmem,
 207                                ruby_system = ruby_system)
 208
 209         dma_cntrl = DMA_Controller(version = i,
 210                                    cntrl_id = cntrl_count,
 211                                    dma_sequencer = dma_seq,
 212                                    ruby_system = ruby_system)
 213
 214         exec("system.dma_cntrl%d = dma_cntrl" % i)
 215         if dma_device.type == 'MemTest':
 216             exec("system.dma_cntrl%d.dma_sequencer.slave = dma_device.test" % i)
 217         else:
 218             exec("system.dma_cntrl%d.dma_sequencer.slave = dma_device.dma" % i)
 219         dma_cntrl_nodes.append(dma_cntrl)
 220
 221         if options.recycle_latency:
 222             dma_cntrl.recycle_latency = options.recycle_latency
 223
 224         cntrl_count += 1
 225
 226     all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes + dma_cntrl_nodes
 227
 228     return (cpu_sequencers, dir_cntrl_nodes, all_cntrls)