ruby: Added a mesh network with directories at the corners

The patch creates a specific mesh network where directories are at the corners.
The patch is a good example of how to create an arbitrary network, similar to
the old file specified network, while leveraging scripts and loops when
possible.

2 files changed, 128 insertions, 0 deletions

diff --git a/configs/ruby/Ruby.py b/configs/ruby/Ruby.py
index d6889ef1a..22d56f9a1 100644
--- a/configs/ruby/Ruby.py
+++ b/configs/ruby/Ruby.py
@@ -31,6 +31,8 @@ import m5
 from m5.objects import *
 from m5.defines import buildEnv
 from m5.util import addToPath
+addToPath('../ruby/networks')
+from MeshDirCorners import *
 
 protocol = buildEnv['PROTOCOL']
 
@@ -59,6 +61,14 @@ def create_system(options, physmem, piobus = None, dma_devices = []):
         net_topology = makeMesh(all_cntrls,
                                 len(cpu_sequencers),
                                 options.mesh_rows)
+        
+    elif options.topology == "mesh_dir_corner":
+        #
+        # The uniform mesh topology assumes one router per cpu
+        #
+        net_topology = makeMeshDirCorners(all_cntrls,
+                                          len(cpu_sequencers),
+                                          options.mesh_rows)
 
     if options.garnet_network == "fixed":
         network = GarnetNetwork_d(topology = net_topology)
diff --git a/configs/ruby/networks/MeshDirCorners.py b/configs/ruby/networks/MeshDirCorners.py
new file mode 100644
index 000000000..381deeec6
--- /dev/null
+++ b/configs/ruby/networks/MeshDirCorners.py
@@ -0,0 +1,118 @@
+# Copyright (c) 2010 Advanced Micro Devices, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Brad Beckmann
+
+from m5.params import *
+from m5.objects import *
+
+#
+# This file contains a special network creation function.  This networks is not
+# general and will only work with specific system configurations.  The network
+# specified is similar to GEMS old file specified network.
+#
+
+def makeMeshDirCorners(nodes, num_routers, num_rows):
+    #
+    # First determine which nodes are cache cntrls vs. dirs vs. dma
+    #
+    cache_nodes = []
+    dir_nodes = []
+    dma_nodes = []
+    for node in nodes:
+        if node.type == 'L1Cache_Controller' or \
+           node.type == 'L2Cache_Controller':
+            cache_nodes.append(node)
+        elif node.type == 'Directory_Controller':
+            dir_nodes.append(node)
+        elif node.type == 'DMA_Controller':
+            dma_nodes.append(node)
+            
+    #
+    # Obviously the number or rows must be <= the number of routers and evenly
+    # divisible.  Also the number of caches must be a multiple of the number of
+    # routers and the number of directories must be four.
+    #
+    assert(num_rows <= num_routers)
+    num_columns = int(num_routers / num_rows)
+    assert(num_columns * num_rows == num_routers)
+    caches_per_router, remainder = divmod(len(cache_nodes), num_routers)
+    assert(remainder == 0)
+    assert(len(dir_nodes) == 4)
+
+    #
+    # Connect each cache controller to the appropriate router
+    #
+    ext_links = []
+    for (i, n) in enumerate(cache_nodes):
+        cntrl_level, router_id = divmod(i, num_routers)
+        assert(cntrl_level < caches_per_router)
+        ext_links.append(ExtLink(ext_node=n, int_node=router_id))
+
+    #
+    # Connect the dir nodes to the corners.
+    #
+    ext_links.append(ExtLink(ext_node=dir_nodes[0], int_node=0))
+    ext_links.append(ExtLink(ext_node=dir_nodes[1], int_node=(num_columns - 1)))
+
+    ext_links.append(ExtLink(ext_node=dir_nodes[2],
+                             int_node=(num_routers - num_columns)))
+
+    ext_links.append(ExtLink(ext_node=dir_nodes[3], int_node=(num_routers - 1)))
+
+    #
+    # Connect the dma nodes to router 0.  These should only be DMA nodes.
+    #
+    for (i, node) in enumerate(dma_nodes):
+        assert(node.type == 'DMA_Controller')
+        ext_links.append(ExtLink(ext_node=node, int_node=0))
+    
+    #
+    # Create the mesh links.  First row (east-west) links then column
+    # (north-south) links
+    #
+    int_links = []
+    for row in xrange(num_rows):
+        for col in xrange(num_columns):
+            if (col + 1 < num_columns):
+                east_id = col + (row * num_columns)
+                west_id = (col + 1) + (row * num_columns)
+                int_links.append(IntLink(node_a=east_id,
+                                         node_b=west_id,
+                                         weight=1))
+    for col in xrange(num_columns):
+        for row in xrange(num_rows):
+            if (row + 1 < num_rows):
+                north_id = col + (row * num_columns)
+                south_id = col + ((row + 1) * num_columns)
+                int_links.append(IntLink(node_a=north_id,
+                                         node_b=south_id,
+                                         weight=2))
+
+    return Topology(ext_links=ext_links,
+                    int_links=int_links,
+                    num_int_nodes=num_routers)
+