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 MI_example
  37 import MOESI_CMP_token
  38
  39 def create_system(options, physmem, piobus = None, dma_devices = []):
  40
  41     protocol = buildEnv['PROTOCOL']
  42
  43     if protocol == "MOESI_hammer":
  44         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  45             MOESI_hammer.create_system(options, \
  46                                        physmem, \
  47                                        piobus, \
  48                                        dma_devices)
  49     elif protocol == "MI_example":
  50         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  51             MI_example.create_system(options, \
  52                                      physmem, \
  53                                      piobus, \
  54                                      dma_devices)
  55     elif protocol == "MOESI_CMP_token":
  56         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  57             MOESI_CMP_token.create_system(options, \
  58                                           physmem, \
  59                                           piobus, \
  60                                           dma_devices)
  61     else:
  62          print "Error: unsupported ruby protocol"
  63          sys.exit(1)
  64
  65     #
  66     # Important: the topology constructor must be called before the network
  67     # constructor.
  68     #
  69     network = SimpleNetwork(topology = makeCrossbar(all_cntrls))
  70
  71     #
  72     # determine the total memory size of the ruby system and verify it is equal
  73     # to physmem
  74     #
  75     total_mem_size = MemorySize('0B')
  76     for dir_cntrl in dir_cntrls:
  77         total_mem_size.value += dir_cntrl.directory.size.value
  78     physmem_size = long(physmem.range.second) - long(physmem.range.first) + 1
  79     assert(total_mem_size.value == physmem_size)
  80
  81     ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
  82
  83     ruby = RubySystem(clock = options.clock,
  84                       network = network,
  85                       profiler = ruby_profiler,
  86                       tracer = RubyTracer(),
  87                       debug = RubyDebug(filter_string = 'none',
  88                                         verbosity_string = 'none',
  89                                         protocol_trace = False),
  90                       mem_size = total_mem_size)
  91
  92     ruby.cpu_ruby_ports = cpu_sequencers
  93
  94     return ruby