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 math
  31 import m5
  32 from m5.objects import *
  33 from m5.defines import buildEnv
  34
  35 def define_options(parser):
  36     # ruby network options
  37     parser.add_option("--topology", type="string", default="Crossbar",
  38                  help="check src/mem/ruby/network/topologies for complete set")
  39     parser.add_option("--mesh-rows", type="int", default=1,
  40                       help="the number of rows in the mesh topology")
  41     parser.add_option("--garnet-network", type="string", default=None,
  42                       help="'fixed'|'flexible'")
  43
  44     # ruby mapping options
  45     parser.add_option("--numa-high-bit", type="int", default=0,
  46                       help="high order address bit to use for numa mapping. " \
  47                            "0 = highest bit, not specified = lowest bit")
  48
  49     # ruby sparse memory options
  50     parser.add_option("--use-map", action="store_true", default=False)
  51     parser.add_option("--map-levels", type="int", default=4)
  52
  53     parser.add_option("--recycle-latency", type="int", default=10,
  54                       help="Recycle latency for ruby controller input buffers")
  55
  56     parser.add_option("--random_seed", type="int", default=1234,
  57                       help="Used for seeding the random number generator")
  58
  59     protocol = buildEnv['PROTOCOL']
  60     exec "import %s" % protocol
  61     eval("%s.define_options(parser)" % protocol)
  62
  63 def create_system(options, system, piobus = None, dma_devices = []):
  64
  65     system.ruby = RubySystem(clock = options.clock)
  66     ruby = system.ruby
  67
  68     protocol = buildEnv['PROTOCOL']
  69     exec "import %s" % protocol
  70     try:
  71         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  72              eval("%s.create_system(options, system, piobus, \
  73                                     dma_devices, ruby)" \
  74                   % protocol)
  75     except:
  76         print "Error: could not create sytem for ruby protocol %s" % protocol
  77         raise
  78
  79     #
  80     # Set the network classes based on the command line options
  81     #
  82     if options.garnet_network == "fixed":
  83         class NetworkClass(GarnetNetwork_d): pass
  84         class IntLinkClass(GarnetIntLink_d): pass
  85         class ExtLinkClass(GarnetExtLink_d): pass
  86         class RouterClass(GarnetRouter_d): pass
  87     elif options.garnet_network == "flexible":
  88         class NetworkClass(GarnetNetwork): pass
  89         class IntLinkClass(GarnetIntLink): pass
  90         class ExtLinkClass(GarnetExtLink): pass
  91         class RouterClass(GarnetRouter): pass
  92     else:
  93         class NetworkClass(SimpleNetwork): pass
  94         class IntLinkClass(SimpleIntLink): pass
  95         class ExtLinkClass(SimpleExtLink): pass
  96         class RouterClass(BasicRouter): pass
  97
  98     #
  99     # Important: the topology must be created before the network and after the
 100     # controllers.
 101     #
 102     exec "import %s" % options.topology
 103     try:
 104         net_topology = eval("%s.makeTopology(all_cntrls, options, \
 105                                              IntLinkClass, ExtLinkClass, \
 106                                              RouterClass)" \
 107                             % options.topology)
 108     except:
 109         print "Error: could not create topology %s" % options.topology
 110         raise
 111
 112     network = NetworkClass(ruby_system = ruby, topology = net_topology)
 113
 114     #
 115     # Loop through the directory controlers.
 116     # Determine the total memory size of the ruby system and verify it is equal
 117     # to physmem.  However, if Ruby memory is using sparse memory in SE
 118     # mode, then the system should not back-up the memory state with
 119     # the Memory Vector and thus the memory size bytes should stay at 0.
 120     # Also set the numa bits to the appropriate values.
 121     #
 122     total_mem_size = MemorySize('0B')
 123
 124     dir_bits = int(math.log(options.num_dirs, 2))
 125
 126     if options.numa_high_bit:
 127         numa_bit = options.numa_high_bit
 128     else:
 129         # if not specified, use the lowest bits above the block offest
 130         if dir_bits > 0:
 131             # add 5 because bits 0-5 are the block offset
 132             numa_bit = dir_bits + 5
 133         else:
 134             numa_bit = 6
 135
 136     for dir_cntrl in dir_cntrls:
 137         total_mem_size.value += dir_cntrl.directory.size.value
 138         dir_cntrl.directory.numa_high_bit = numa_bit
 139
 140     physmem_size = long(system.physmem.range.second) - \
 141                      long(system.physmem.range.first) + 1
 142     assert(total_mem_size.value == physmem_size)
 143
 144     ruby_profiler = RubyProfiler(ruby_system = ruby,
 145                                  num_of_sequencers = len(cpu_sequencers))
 146     ruby_tracer   = RubyTracer(ruby_system = ruby)
 147
 148     ruby.network = network
 149     ruby.profiler = ruby_profiler
 150     ruby.tracer = ruby_tracer
 151     ruby.mem_size = total_mem_size
 152     ruby._cpu_ruby_ports = cpu_sequencers
 153     ruby.random_seed    = options.random_seed