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     protocol = buildEnv['PROTOCOL']
  66     exec "import %s" % protocol
  67     try:
  68         (cpu_sequencers, dir_cntrls, all_cntrls) = \
  69              eval("%s.create_system(options, system, piobus, dma_devices)" \
  70                   % protocol)
  71     except:
  72         print "Error: could not create sytem for ruby protocol %s" % protocol
  73         raise
  74
  75     #
  76     # Set the network classes based on the command line options
  77     #
  78     if options.garnet_network == "fixed":
  79         class NetworkClass(GarnetNetwork_d): pass
  80         class IntLinkClass(GarnetIntLink_d): pass
  81         class ExtLinkClass(GarnetExtLink_d): pass
  82         class RouterClass(GarnetRouter_d): pass
  83     elif options.garnet_network == "flexible":
  84         class NetworkClass(GarnetNetwork): pass
  85         class IntLinkClass(GarnetIntLink): pass
  86         class ExtLinkClass(GarnetExtLink): pass
  87         class RouterClass(GarnetRouter): pass
  88     else:
  89         class NetworkClass(SimpleNetwork): pass
  90         class IntLinkClass(BasicIntLink): pass
  91         class ExtLinkClass(BasicExtLink): pass
  92         class RouterClass(BasicRouter): pass
  93
  94     #
  95     # Important: the topology must be created before the network and after the
  96     # controllers.
  97     #
  98     exec "import %s" % options.topology
  99     try:
 100         net_topology = eval("%s.makeTopology(all_cntrls, options, \
 101                                              IntLinkClass, ExtLinkClass, \
 102                                              RouterClass)" \
 103                             % options.topology)
 104     except:
 105         print "Error: could not create topology %s" % options.topology
 106         raise
 107
 108     network = NetworkClass(topology = net_topology)
 109
 110     #
 111     # Loop through the directory controlers.
 112     # Determine the total memory size of the ruby system and verify it is equal
 113     # to physmem.  However, if Ruby memory is using sparse memory in SE
 114     # mode, then the system should not back-up the memory state with
 115     # the Memory Vector and thus the memory size bytes should stay at 0.
 116     # Also set the numa bits to the appropriate values.
 117     #
 118     total_mem_size = MemorySize('0B')
 119
 120     dir_bits = int(math.log(options.num_dirs, 2))
 121
 122     if options.numa_high_bit:
 123         numa_bit = options.numa_high_bit
 124     else:
 125         # if not specified, use the lowest bits above the block offest
 126         if dir_bits > 0:
 127             # add 5 because bits 0-5 are the block offset
 128             numa_bit = dir_bits + 5
 129         else:
 130             numa_bit = 6
 131
 132     for dir_cntrl in dir_cntrls:
 133         total_mem_size.value += dir_cntrl.directory.size.value
 134         dir_cntrl.directory.numa_high_bit = numa_bit
 135
 136     physmem_size = long(system.physmem.range.second) - \
 137                      long(system.physmem.range.first) + 1
 138     assert(total_mem_size.value == physmem_size)
 139
 140     ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
 141
 142     ruby = RubySystem(clock = options.clock,
 143                       network = network,
 144                       profiler = ruby_profiler,
 145                       tracer = RubyTracer(),
 146                       mem_size = total_mem_size)
 147
 148     ruby.cpu_ruby_ports = cpu_sequencers
 149     ruby.random_seed    = options.random_seed
 150
 151     return ruby