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
30from m5.params import *
31from m5.proxy import *
32
33from m5.objects.Network import RubyNetwork
34from m5.objects.BasicRouter import BasicRouter
35from m5.objects.MessageBuffer import MessageBuffer
36
37class SimpleNetwork(RubyNetwork):
38    type = 'SimpleNetwork'
39    cxx_header = "mem/ruby/network/simple/SimpleNetwork.hh"
40    buffer_size = Param.Int(0,
41        "default buffer size; 0 indicates infinite buffering");
42    endpoint_bandwidth = Param.Int(1000, "bandwidth adjustment factor");
43    adaptive_routing = Param.Bool(False, "enable adaptive routing");
44    int_link_buffers = VectorParam.MessageBuffer("Buffers for int_links")
45
46    def setup_buffers(self):
47        # Note that all SimpleNetwork MessageBuffers are currently ordered
48        network_buffers = []
49        for link in self.int_links:
50            # The network needs number_of_virtual_networks buffers per
51            # int_link port
52            for i in range(int(self.number_of_virtual_networks)):
53                network_buffers.append(MessageBuffer(ordered = True))
54                network_buffers.append(MessageBuffer(ordered = True))
55        self.int_link_buffers = network_buffers
56
57        # Also add buffers for all router-link connections
58        for router in self.routers:
59            router_buffers = []
60            # Add message buffers to routers at the end of each
61            # unidirectional internal link
62            for link in self.int_links:
63                if link.dst_node == router:
64                    for i in range(int(self.number_of_virtual_networks)):
65                        router_buffers.append(MessageBuffer(ordered = True))
66
67            # Add message buffers to routers for each external link connection
68            for link in self.ext_links:
69                # Routers can only be int_nodes on ext_links
70                if link.int_node in self.routers:
71                    for i in range(int(self.number_of_virtual_networks)):
72                        router_buffers.append(MessageBuffer(ordered = True))
73            router.port_buffers = router_buffers
74
75class Switch(BasicRouter):
76    type = 'Switch'
77    cxx_header = 'mem/ruby/network/simple/Switch.hh'
78    virt_nets = Param.Int(Parent.number_of_virtual_networks,
79                          "number of virtual networks")
80    port_buffers = VectorParam.MessageBuffer("Port buffers")
81