src/mem/ruby/network/Network.cc

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "base/misc.hh"
  30 #include "mem/ruby/network/BasicLink.hh"
  31 #include "mem/ruby/network/Network.hh"
  32 #include "mem/ruby/system/System.hh"
  33
  34 uint32_t Network::m_virtual_networks;
  35 uint32_t Network::m_control_msg_size;
  36 uint32_t Network::m_data_msg_size;
  37
  38 Network::Network(const Params *p)
  39     : ClockedObject(p)
  40 {
  41     m_virtual_networks = p->number_of_virtual_networks;
  42     m_control_msg_size = p->control_msg_size;
  43
  44     // Total nodes/controllers in network
  45     // Must make sure this is called after the State Machine constructors
  46     m_nodes = MachineType_base_number(MachineType_NUM);
  47     assert(m_nodes != 0);
  48     assert(m_virtual_networks != 0);
  49
  50     m_topology_ptr = new Topology(p->routers.size(), p->ext_links,
  51                                   p->int_links);
  52
  53     // Allocate to and from queues
  54     // Queues that are getting messages from protocol
  55     m_toNetQueues.resize(m_nodes);
  56
  57     // Queues that are feeding the protocol
  58     m_fromNetQueues.resize(m_nodes);
  59
  60     m_in_use.resize(m_virtual_networks);
  61     m_ordered.resize(m_virtual_networks);
  62
  63     for (int i = 0; i < m_virtual_networks; i++) {
  64         m_in_use[i] = false;
  65         m_ordered[i] = false;
  66     }
  67
  68     p->ruby_system->registerNetwork(this);
  69
  70     // Initialize the controller's network pointers
  71     for (std::vector<BasicExtLink*>::const_iterator i = p->ext_links.begin();
  72          i != p->ext_links.end(); ++i) {
  73         BasicExtLink *ext_link = (*i);
  74         AbstractController *abs_cntrl = ext_link->params()->ext_node;
  75         abs_cntrl->initNetworkPtr(this);
  76     }
  77
  78     // Register a callback function for combining the statistics
  79     Stats::registerDumpCallback(new StatsCallback(this));
  80 }
  81
  82 Network::~Network()
  83 {
  84     for (int node = 0; node < m_nodes; node++) {
  85
  86         // Delete the Message Buffers
  87         for (auto& it : m_toNetQueues[node]) {
  88             delete it.second;
  89         }
  90
  91         for (auto& it : m_fromNetQueues[node]) {
  92             delete it.second;
  93         }
  94     }
  95
  96     delete m_topology_ptr;
  97 }
  98
  99 void
 100 Network::init()
 101 {
 102     m_data_msg_size = RubySystem::getBlockSizeBytes() + m_control_msg_size;
 103 }
 104
 105 uint32_t
 106 Network::MessageSizeType_to_int(MessageSizeType size_type)
 107 {
 108     switch(size_type) {
 109       case MessageSizeType_Control:
 110       case MessageSizeType_Request_Control:
 111       case MessageSizeType_Reissue_Control:
 112       case MessageSizeType_Response_Control:
 113       case MessageSizeType_Writeback_Control:
 114       case MessageSizeType_Broadcast_Control:
 115       case MessageSizeType_Multicast_Control:
 116       case MessageSizeType_Forwarded_Control:
 117       case MessageSizeType_Invalidate_Control:
 118       case MessageSizeType_Unblock_Control:
 119       case MessageSizeType_Persistent_Control:
 120       case MessageSizeType_Completion_Control:
 121         return m_control_msg_size;
 122       case MessageSizeType_Data:
 123       case MessageSizeType_Response_Data:
 124       case MessageSizeType_ResponseLocal_Data:
 125       case MessageSizeType_ResponseL2hit_Data:
 126       case MessageSizeType_Writeback_Data:
 127         return m_data_msg_size;
 128       default:
 129         panic("Invalid range for type MessageSizeType");
 130         break;
 131     }
 132 }