configs/ruby/Ruby.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 m5
  31 from m5.objects import *
  32 from m5.defines import buildEnv
  33 from m5.util import addToPath
  34
  35 import MOESI_hammer
  36 import MESI_CMP_directory
  37 import MOESI_CMP_directory
  38 import MI_example
  39 import MOESI_CMP_token
  40
  41 def create_system(options, physmem, piobus = None, dma_devices = []):
  42
  43     protocol = buildEnv['PROTOCOL']
  44
  45     if protocol == "MOESI_hammer":
  46         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  47             MOESI_hammer.create_system(options, \
  48                                        physmem, \
  49                                        piobus, \
  50                                        dma_devices)
  51     elif protocol == "MESI_CMP_directory":
  52         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  53             MESI_CMP_directory.create_system(options, \
  54                                              physmem, \
  55                                              piobus, \
  56                                              dma_devices)
  57     elif protocol == "MOESI_CMP_directory":
  58         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  59             MOESI_CMP_directory.create_system(options, \
  60                                           physmem, \
  61                                           piobus, \
  62                                           dma_devices)
  63     elif protocol == "MI_example":
  64         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  65             MI_example.create_system(options, \
  66                                      physmem, \
  67                                      piobus, \
  68                                      dma_devices)
  69     elif protocol == "MOESI_CMP_token":
  70         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  71             MOESI_CMP_token.create_system(options, \
  72                                           physmem, \
  73                                           piobus, \
  74                                           dma_devices)
  75     else:
  76          print "Error: unsupported ruby protocol"
  77          sys.exit(1)
  78
  79     #
  80     # Important: the topology constructor must be called before the network
  81     # constructor.
  82     #
  83     if options.topology == "crossbar":
  84         net_topology = makeCrossbar(all_cntrls)
  85     elif options.topology == "mesh":
  86         #
  87         # The uniform mesh topology assumes one router per cpu
  88         #
  89         net_topology = makeMesh(all_cntrls,
  90                                 len(cpu_sequencers),
  91                                 options.mesh_rows)
  92
  93     if options.garnet_network == "fixed":
  94         network = GarnetNetwork_d(topology = net_topology)
  95     elif options.garnet_network == "flexible":
  96         network = GarnetNetwork(topology = net_topology)
  97     else:
  98         network = SimpleNetwork(topology = net_topology)
  99
 100     #
 101     # determine the total memory size of the ruby system and verify it is equal
 102     # to physmem
 103     #
 104     total_mem_size = MemorySize('0B')
 105     for dir_cntrl in dir_cntrls:
 106         total_mem_size.value += dir_cntrl.directory.size.value
 107     physmem_size = long(physmem.range.second) - long(physmem.range.first) + 1
 108     assert(total_mem_size.value == physmem_size)
 109
 110     ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
 111
 112     ruby = RubySystem(clock = options.clock,
 113                       network = network,
 114                       profiler = ruby_profiler,
 115                       tracer = RubyTracer(),
 116                       debug = RubyDebug(filter_string = 'none',
 117                                         verbosity_string = 'none',
 118                                         protocol_trace = False),
 119                       mem_size = total_mem_size)
 120
 121     ruby.cpu_ruby_ports = cpu_sequencers
 122
 123     return ruby