src/mem/ruby/network/Network.cc

   1 /*
   2  * Copyright (c) 2017 ARM Limited
   3  * All rights reserved.
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 #include "mem/ruby/network/Network.hh"
  42
  43 #include "base/misc.hh"
  44 #include "mem/ruby/common/MachineID.hh"
  45 #include "mem/ruby/network/BasicLink.hh"
  46 #include "mem/ruby/system/RubySystem.hh"
  47
  48 uint32_t Network::m_virtual_networks;
  49 uint32_t Network::m_control_msg_size;
  50 uint32_t Network::m_data_msg_size;
  51
  52 Network::Network(const Params *p)
  53     : ClockedObject(p)
  54 {
  55     m_virtual_networks = p->number_of_virtual_networks;
  56     m_control_msg_size = p->control_msg_size;
  57
  58     // Total nodes/controllers in network
  59     // Must make sure this is called after the State Machine constructors
  60     m_nodes = MachineType_base_number(MachineType_NUM);
  61     assert(m_nodes != 0);
  62     assert(m_virtual_networks != 0);
  63
  64     m_topology_ptr = new Topology(p->routers.size(), p->ext_links,
  65                                   p->int_links);
  66
  67     // Allocate to and from queues
  68     // Queues that are getting messages from protocol
  69     m_toNetQueues.resize(m_nodes);
  70
  71     // Queues that are feeding the protocol
  72     m_fromNetQueues.resize(m_nodes);
  73
  74     m_ordered.resize(m_virtual_networks);
  75     m_vnet_type_names.resize(m_virtual_networks);
  76
  77     for (int i = 0; i < m_virtual_networks; i++) {
  78         m_ordered[i] = false;
  79     }
  80
  81     params()->ruby_system->registerNetwork(this);
  82
  83     // Initialize the controller's network pointers
  84     for (std::vector<BasicExtLink*>::const_iterator i = p->ext_links.begin();
  85          i != p->ext_links.end(); ++i) {
  86         BasicExtLink *ext_link = (*i);
  87         AbstractController *abs_cntrl = ext_link->params()->ext_node;
  88         abs_cntrl->initNetworkPtr(this);
  89         const AddrRangeList &ranges = abs_cntrl->getAddrRanges();
  90         if (!ranges.empty()) {
  91             MachineID mid = abs_cntrl->getMachineID();
  92             AddrMapNode addr_map_node = {
  93                 .id = mid.getNum(),
  94                 .ranges = ranges
  95             };
  96             addrMap.emplace(mid.getType(), addr_map_node);
  97         }
  98     }
  99
 100     // Register a callback function for combining the statistics
 101     Stats::registerDumpCallback(new StatsCallback(this));
 102
 103     for (auto &it : dynamic_cast<Network *>(this)->params()->ext_links) {
 104         it->params()->ext_node->initNetQueues();
 105     }
 106 }
 107
 108 Network::~Network()
 109 {
 110     for (int node = 0; node < m_nodes; node++) {
 111
 112         // Delete the Message Buffers
 113         for (auto& it : m_toNetQueues[node]) {
 114             delete it;
 115         }
 116
 117         for (auto& it : m_fromNetQueues[node]) {
 118             delete it;
 119         }
 120     }
 121
 122     delete m_topology_ptr;
 123 }
 124
 125 void
 126 Network::init()
 127 {
 128     m_data_msg_size = RubySystem::getBlockSizeBytes() + m_control_msg_size;
 129 }
 130
 131 uint32_t
 132 Network::MessageSizeType_to_int(MessageSizeType size_type)
 133 {
 134     switch(size_type) {
 135       case MessageSizeType_Control:
 136       case MessageSizeType_Request_Control:
 137       case MessageSizeType_Reissue_Control:
 138       case MessageSizeType_Response_Control:
 139       case MessageSizeType_Writeback_Control:
 140       case MessageSizeType_Broadcast_Control:
 141       case MessageSizeType_Multicast_Control:
 142       case MessageSizeType_Forwarded_Control:
 143       case MessageSizeType_Invalidate_Control:
 144       case MessageSizeType_Unblock_Control:
 145       case MessageSizeType_Persistent_Control:
 146       case MessageSizeType_Completion_Control:
 147         return m_control_msg_size;
 148       case MessageSizeType_Data:
 149       case MessageSizeType_Response_Data:
 150       case MessageSizeType_ResponseLocal_Data:
 151       case MessageSizeType_ResponseL2hit_Data:
 152       case MessageSizeType_Writeback_Data:
 153         return m_data_msg_size;
 154       default:
 155         panic("Invalid range for type MessageSizeType");
 156         break;
 157     }
 158 }
 159
 160 void
 161 Network::checkNetworkAllocation(NodeID id, bool ordered,
 162                                         int network_num,
 163                                         std::string vnet_type)
 164 {
 165     fatal_if(id >= m_nodes, "Node ID is out of range");
 166     fatal_if(network_num >= m_virtual_networks, "Network id is out of range");
 167
 168     if (ordered) {
 169         m_ordered[network_num] = true;
 170     }
 171
 172     m_vnet_type_names[network_num] = vnet_type;
 173 }
 174
 175
 176 void
 177 Network::setToNetQueue(NodeID id, bool ordered, int network_num,
 178                                  std::string vnet_type, MessageBuffer *b)
 179 {
 180     checkNetworkAllocation(id, ordered, network_num, vnet_type);
 181     while (m_toNetQueues[id].size() <= network_num) {
 182         m_toNetQueues[id].push_back(nullptr);
 183     }
 184     m_toNetQueues[id][network_num] = b;
 185 }
 186
 187 void
 188 Network::setFromNetQueue(NodeID id, bool ordered, int network_num,
 189                                    std::string vnet_type, MessageBuffer *b)
 190 {
 191     checkNetworkAllocation(id, ordered, network_num, vnet_type);
 192     while (m_fromNetQueues[id].size() <= network_num) {
 193         m_fromNetQueues[id].push_back(nullptr);
 194     }
 195     m_fromNetQueues[id][network_num] = b;
 196 }
 197
 198 NodeID
 199 Network::addressToNodeID(Addr addr, MachineType mtype)
 200 {
 201     // Look through the address maps for entries with matching machine
 202     // type to get the responsible node for this address.
 203     const auto &matching_ranges = addrMap.equal_range(mtype);
 204     for (auto it = matching_ranges.first; it != matching_ranges.second; it++) {
 205         AddrMapNode &node = it->second;
 206         auto &ranges = node.ranges;
 207         for (AddrRange &range: ranges) {
 208             if (range.contains(addr)) {
 209                 return node.id;
 210             }
 211         }
 212     }
 213     return MachineType_base_count(mtype);
 214 }