MeshDirCorners_XY.py revision 11663
110743Sandreas.hansson@arm.com# Copyright (c) 2010 Advanced Micro Devices, Inc.
210139Sandreas.hansson@arm.com# All rights reserved.
310139Sandreas.hansson@arm.com#
410139Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without
510139Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are
610139Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright
710139Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer;
810139Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright
910139Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the
1010139Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution;
1110139Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its
1210139Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from
1310139Sandreas.hansson@arm.com# this software without specific prior written permission.
1410139Sandreas.hansson@arm.com#
1510139Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1610139Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1710139Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1810139Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1910139Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2010139Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2110139Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2210139Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2310139Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2410139Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2510139Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2610139Sandreas.hansson@arm.com#
2710139Sandreas.hansson@arm.com# Authors: Brad Beckmann
2810139Sandreas.hansson@arm.com
2910139Sandreas.hansson@arm.comfrom m5.params import *
3010139Sandreas.hansson@arm.comfrom m5.objects import *
3110139Sandreas.hansson@arm.com
3210139Sandreas.hansson@arm.comfrom BaseTopology import SimpleTopology
3310139Sandreas.hansson@arm.com
3410139Sandreas.hansson@arm.com# Creates a Mesh topology with 4 directories, one at each corner.
3510139Sandreas.hansson@arm.com# One L1 (and L2, depending on the protocol) are connected to each router.
3610139Sandreas.hansson@arm.com# XY routing is enforced (using link weights) to guarantee deadlock freedom.
3710139Sandreas.hansson@arm.com
3810139Sandreas.hansson@arm.comclass MeshDirCorners_XY(SimpleTopology):
3910139Sandreas.hansson@arm.com    description='MeshDirCorners_XY'
4010139Sandreas.hansson@arm.com
4110139Sandreas.hansson@arm.com    def __init__(self, controllers):
4210139Sandreas.hansson@arm.com        self.nodes = controllers
4310139Sandreas.hansson@arm.com
4410139Sandreas.hansson@arm.com    def makeTopology(self, options, network, IntLink, ExtLink, Router):
4511682Sandreas.hansson@arm.com        nodes = self.nodes
4610139Sandreas.hansson@arm.com
4711682Sandreas.hansson@arm.com        num_routers = options.num_cpus
4810139Sandreas.hansson@arm.com        num_rows = options.mesh_rows
4910139Sandreas.hansson@arm.com
5010139Sandreas.hansson@arm.com        # First determine which nodes are cache cntrls vs. dirs vs. dma
5110139Sandreas.hansson@arm.com        cache_nodes = []
5210139Sandreas.hansson@arm.com        dir_nodes = []
5310139Sandreas.hansson@arm.com        dma_nodes = []
5410139Sandreas.hansson@arm.com        for node in nodes:
5510139Sandreas.hansson@arm.com            if node.type == 'L1Cache_Controller' or \
5610139Sandreas.hansson@arm.com            node.type == 'L2Cache_Controller':
5710789Sandreas.hansson@arm.com                cache_nodes.append(node)
5810139Sandreas.hansson@arm.com            elif node.type == 'Directory_Controller':
5910139Sandreas.hansson@arm.com                dir_nodes.append(node)
6010139Sandreas.hansson@arm.com            elif node.type == 'DMA_Controller':
6110743Sandreas.hansson@arm.com                dma_nodes.append(node)
6210392Swendy.elsasser@arm.com
6310392Swendy.elsasser@arm.com        # Obviously the number or rows must be <= the number of routers
6410392Swendy.elsasser@arm.com        # and evenly divisible.  Also the number of caches must be a
6510392Swendy.elsasser@arm.com        # multiple of the number of routers and the number of directories
6610392Swendy.elsasser@arm.com        # must be four.
6710392Swendy.elsasser@arm.com        assert(num_rows <= num_routers)
6810392Swendy.elsasser@arm.com        num_columns = int(num_routers / num_rows)
6910392Swendy.elsasser@arm.com        assert(num_columns * num_rows == num_routers)
7010392Swendy.elsasser@arm.com        caches_per_router, remainder = divmod(len(cache_nodes), num_routers)
7110392Swendy.elsasser@arm.com        assert(remainder == 0)
7210392Swendy.elsasser@arm.com        assert(len(dir_nodes) == 4)
7310392Swendy.elsasser@arm.com
7410392Swendy.elsasser@arm.com        # Create the routers in the mesh
7510139Sandreas.hansson@arm.com        routers = [Router(router_id=i) for i in range(num_routers)]
7610139Sandreas.hansson@arm.com        network.routers = routers
7710139Sandreas.hansson@arm.com
7810139Sandreas.hansson@arm.com        # link counter to set unique link ids
7910139Sandreas.hansson@arm.com        link_count = 0
8010139Sandreas.hansson@arm.com
8110139Sandreas.hansson@arm.com        # Connect each cache controller to the appropriate router
8210139Sandreas.hansson@arm.com        ext_links = []
8310139Sandreas.hansson@arm.com        for (i, n) in enumerate(cache_nodes):
8411125Sandreas.hansson@arm.com            cntrl_level, router_id = divmod(i, num_routers)
8511125Sandreas.hansson@arm.com            assert(cntrl_level < caches_per_router)
8611125Sandreas.hansson@arm.com            ext_links.append(ExtLink(link_id=link_count, ext_node=n,
8711125Sandreas.hansson@arm.com                                    int_node=routers[router_id]))
8811125Sandreas.hansson@arm.com            link_count += 1
8910139Sandreas.hansson@arm.com
9010139Sandreas.hansson@arm.com        # Connect the dir nodes to the corners.
9110139Sandreas.hansson@arm.com        ext_links.append(ExtLink(link_id=link_count, ext_node=dir_nodes[0],
9210139Sandreas.hansson@arm.com                                int_node=routers[0]))
9310139Sandreas.hansson@arm.com        link_count += 1
9410139Sandreas.hansson@arm.com        ext_links.append(ExtLink(link_id=link_count, ext_node=dir_nodes[1],
9510139Sandreas.hansson@arm.com                                int_node=routers[num_columns - 1]))
9610833Sandreas.hansson@arm.com        link_count += 1
9711223Sandreas.hansson@arm.com        ext_links.append(ExtLink(link_id=link_count, ext_node=dir_nodes[2],
9810833Sandreas.hansson@arm.com                                int_node=routers[num_routers - num_columns]))
9910139Sandreas.hansson@arm.com        link_count += 1
10010139Sandreas.hansson@arm.com        ext_links.append(ExtLink(link_id=link_count, ext_node=dir_nodes[3],
10110139Sandreas.hansson@arm.com                                int_node=routers[num_routers - 1]))
10210832Swendy.elsasser@arm.com        link_count += 1
10311125Sandreas.hansson@arm.com
10411251Sradhika.jagtap@ARM.com        # Connect the dma nodes to router 0.  These should only be DMA nodes.
10510139Sandreas.hansson@arm.com        for (i, node) in enumerate(dma_nodes):
10610139Sandreas.hansson@arm.com            assert(node.type == 'DMA_Controller')
10710139Sandreas.hansson@arm.com            ext_links.append(ExtLink(link_id=link_count, ext_node=node,
10810139Sandreas.hansson@arm.com                                     int_node=routers[0]))
10910146Sandreas.hansson@arm.com
11010146Sandreas.hansson@arm.com        network.ext_links = ext_links
11110139Sandreas.hansson@arm.com
11210833Sandreas.hansson@arm.com        # Create the mesh links.
11310833Sandreas.hansson@arm.com        int_links = []
11410833Sandreas.hansson@arm.com
11510392Swendy.elsasser@arm.com        # East output to West input links (weight = 1)
11610392Swendy.elsasser@arm.com        for row in xrange(num_rows):
11710392Swendy.elsasser@arm.com            for col in xrange(num_columns):
11810392Swendy.elsasser@arm.com                if (col + 1 < num_columns):
11910392Swendy.elsasser@arm.com                    east_out = col + (row * num_columns)
12010392Swendy.elsasser@arm.com                    west_in = (col + 1) + (row * num_columns)
12110392Swendy.elsasser@arm.com                    int_links.append(IntLink(link_id=link_count,
12210392Swendy.elsasser@arm.com                                             src_node=routers[east_out],
12310139Sandreas.hansson@arm.com                                             dst_node=routers[west_in],
12410139Sandreas.hansson@arm.com                                             weight=1))
12510139Sandreas.hansson@arm.com                    link_count += 1
12610139Sandreas.hansson@arm.com
12710139Sandreas.hansson@arm.com        # West output to East input links (weight = 1)
12810139Sandreas.hansson@arm.com        for row in xrange(num_rows):
12910139Sandreas.hansson@arm.com            for col in xrange(num_columns):
13010139Sandreas.hansson@arm.com                if (col + 1 < num_columns):
13110139Sandreas.hansson@arm.com                    east_in = col + (row * num_columns)
13210139Sandreas.hansson@arm.com                    west_out = (col + 1) + (row * num_columns)
13310139Sandreas.hansson@arm.com                    int_links.append(IntLink(link_id=link_count,
13410139Sandreas.hansson@arm.com                                             src_node=routers[west_out],
13510139Sandreas.hansson@arm.com                                             dst_node=routers[east_in],
13610139Sandreas.hansson@arm.com                                             weight=1))
13710139Sandreas.hansson@arm.com                    link_count += 1
13810139Sandreas.hansson@arm.com
13910139Sandreas.hansson@arm.com        # North output to South input links (weight = 2)
14010139Sandreas.hansson@arm.com        for col in xrange(num_columns):
14110139Sandreas.hansson@arm.com            for row in xrange(num_rows):
14210139Sandreas.hansson@arm.com                if (row + 1 < num_rows):
14310139Sandreas.hansson@arm.com                    north_out = col + (row * num_columns)
14410139Sandreas.hansson@arm.com                    south_in = col + ((row + 1) * num_columns)
14510139Sandreas.hansson@arm.com                    int_links.append(IntLink(link_id=link_count,
14610139Sandreas.hansson@arm.com                                             src_node=routers[north_out],
14710139Sandreas.hansson@arm.com                                             dst_node=routers[south_in],
14810139Sandreas.hansson@arm.com                                             weight=2))
14911223Sandreas.hansson@arm.com                    link_count += 1
15011223Sandreas.hansson@arm.com
15110139Sandreas.hansson@arm.com        # South output to North input links (weight = 2)
15210139Sandreas.hansson@arm.com        for col in xrange(num_columns):
15310139Sandreas.hansson@arm.com            for row in xrange(num_rows):
15410139Sandreas.hansson@arm.com                if (row + 1 < num_rows):
15510139Sandreas.hansson@arm.com                    north_in = col + (row * num_columns)
15610323Sandreas.hansson@arm.com                    south_out = col + ((row + 1) * num_columns)
15710323Sandreas.hansson@arm.com                    int_links.append(IntLink(link_id=link_count,
15810323Sandreas.hansson@arm.com                                             src_node=routers[south_out],
15910323Sandreas.hansson@arm.com                                             dst_node=routers[north_in],
16010139Sandreas.hansson@arm.com                                             weight=2))
16110323Sandreas.hansson@arm.com                    link_count += 1
16210323Sandreas.hansson@arm.com
16310139Sandreas.hansson@arm.com
16410139Sandreas.hansson@arm.com        network.int_links = int_links
16510323Sandreas.hansson@arm.com