src/mem/ruby/network/Network.py

   1 # Copyright (c) 2009 Advanced Micro Devices, Inc.
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 #
  27 # Authors: Steve Reinhardt
  28 #          Brad Beckmann
  29
  30 from m5.params import *
  31 from m5.SimObject import SimObject
  32
  33 class Link(SimObject):
  34     type = 'Link'
  35     latency = Param.Int(1, "")
  36     bw_multiplier = Param.Int("")
  37     weight = Param.Int(1, "")
  38
  39 class ExtLink(Link):
  40     type = 'ExtLink'
  41     ext_node = Param.RubyController("External node")
  42     int_node = Param.Int("ID of internal node")
  43     bw_multiplier = 64
  44
  45 class IntLink(Link):
  46     type = 'IntLink'
  47     node_a = Param.Int("ID of internal node on one end")
  48     node_b = Param.Int("ID of internal node on other end")
  49     bw_multiplier = 16
  50
  51 class Topology(SimObject):
  52     type = 'Topology'
  53     ext_links = VectorParam.ExtLink("Links to external nodes")
  54     int_links = VectorParam.IntLink("Links between internal nodes")
  55     num_int_nodes = Param.Int("Nunber of internal nodes")
  56     print_config = Param.Bool(False,
  57         "display topology config in the stats file")
  58
  59 def makeCrossbar(nodes):
  60     ext_links = [ExtLink(ext_node=n, int_node=i)
  61                  for (i, n) in enumerate(nodes)]
  62     xbar = len(nodes) # node ID for crossbar switch
  63     int_links = [IntLink(node_a=i, node_b=xbar) for i in range(len(nodes))]
  64     return Topology(ext_links=ext_links, int_links=int_links,
  65                     num_int_nodes=len(nodes)+1)
  66
  67 def makeMesh(nodes, num_routers, num_rows):
  68     #
  69     # There must be an evenly divisible number of cntrls to routers
  70     # Also, obviously the number or rows must be <= the number of routers
  71     #
  72     cntrls_per_router, remainder = divmod(len(nodes), num_routers)
  73     assert(num_rows <= num_routers)
  74     num_columns = int(num_routers / num_rows)
  75     assert(num_columns * num_rows == num_routers)
  76
  77     #
  78     # Add all but the remainder nodes to the list of nodes to be uniformly
  79     # distributed across the network.
  80     #
  81     network_nodes = []
  82     remainder_nodes = []
  83     for node_index in xrange(len(nodes)):
  84         if node_index < (len(nodes) - remainder):
  85             network_nodes.append(nodes[node_index])
  86         else:
  87             remainder_nodes.append(nodes[node_index])
  88
  89     #
  90     # Connect each node to the appropriate router
  91     #
  92     ext_links = []
  93     for (i, n) in enumerate(network_nodes):
  94         cntrl_level, router_id = divmod(i, num_routers)
  95         assert(cntrl_level < cntrls_per_router)
  96         ext_links.append(ExtLink(ext_node=n, int_node=router_id))
  97
  98     #
  99     # Connect the remainding nodes to router 0.  These should only be DMA nodes.
 100     #
 101     for (i, node) in enumerate(remainder_nodes):
 102         assert(node.type == 'DMA_Controller')
 103         assert(i < remainder)
 104         ext_links.append(ExtLink(ext_node=node, int_node=0))
 105
 106     #
 107     # Create the mesh links.  First row (east-west) links then column
 108     # (north-south) links
 109     #
 110     int_links = []
 111     for row in xrange(num_rows):
 112         for col in xrange(num_columns):
 113             if (col + 1 < num_columns):
 114                 east_id = col + (row * num_columns)
 115                 west_id = (col + 1) + (row * num_columns)
 116                 int_links.append(IntLink(node_a=east_id,
 117                                          node_b=west_id,
 118                                          weight=1))
 119     for col in xrange(num_columns):
 120         for row in xrange(num_rows):
 121             if (row + 1 < num_rows):
 122                 north_id = col + (row * num_columns)
 123                 south_id = col + ((row + 1) * num_columns)
 124                 int_links.append(IntLink(node_a=north_id,
 125                                          node_b=south_id,
 126                                          weight=2))
 127
 128     return Topology(ext_links=ext_links,
 129                     int_links=int_links,
 130                     num_int_nodes=num_routers)
 131
 132 class RubyNetwork(SimObject):
 133     type = 'RubyNetwork'
 134     cxx_class = 'Network'
 135     abstract = True
 136     number_of_virtual_networks = Param.Int(10, "");
 137     topology = Param.Topology("");
 138     buffer_size = Param.Int(0,
 139         "default buffer size; 0 indicates infinite buffering");
 140     endpoint_bandwidth = Param.Int(10000, "");
 141     adaptive_routing = Param.Bool(True, "");
 142     link_latency = Param.Int(1,
 143         "local memory latency ?? NetworkLinkLatency");
 144     control_msg_size = Param.Int(8, "");