Network.cc revision 11113:5a2e1b1b5c43 
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/RubySystem.hh"
33
34uint32_t Network::m_virtual_networks;
35uint32_t Network::m_control_msg_size;
36uint32_t Network::m_data_msg_size;
37
38Network::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_ordered.resize(m_virtual_networks);
61    m_vnet_type_names.resize(m_virtual_networks);
62
63    for (int i = 0; i < m_virtual_networks; i++) {
64        m_ordered[i] = false;
65    }
66
67    params()->ruby_system->registerNetwork(this);
68
69    // Initialize the controller's network pointers
70    for (std::vector<BasicExtLink*>::const_iterator i = p->ext_links.begin();
71         i != p->ext_links.end(); ++i) {
72        BasicExtLink *ext_link = (*i);
73        AbstractController *abs_cntrl = ext_link->params()->ext_node;
74        abs_cntrl->initNetworkPtr(this);
75    }
76
77    // Register a callback function for combining the statistics
78    Stats::registerDumpCallback(new StatsCallback(this));
79
80    for (auto &it : dynamic_cast<Network *>(this)->params()->ext_links) {
81        it->params()->ext_node->initNetQueues();
82    }
83}
84
85Network::~Network()
86{
87    for (int node = 0; node < m_nodes; node++) {
88
89        // Delete the Message Buffers
90        for (auto& it : m_toNetQueues[node]) {
91            delete it;
92        }
93
94        for (auto& it : m_fromNetQueues[node]) {
95            delete it;
96        }
97    }
98
99    delete m_topology_ptr;
100}
101
102void
103Network::init()
104{
105    m_data_msg_size = RubySystem::getBlockSizeBytes() + m_control_msg_size;
106}
107
108uint32_t
109Network::MessageSizeType_to_int(MessageSizeType size_type)
110{
111    switch(size_type) {
112      case MessageSizeType_Control:
113      case MessageSizeType_Request_Control:
114      case MessageSizeType_Reissue_Control:
115      case MessageSizeType_Response_Control:
116      case MessageSizeType_Writeback_Control:
117      case MessageSizeType_Broadcast_Control:
118      case MessageSizeType_Multicast_Control:
119      case MessageSizeType_Forwarded_Control:
120      case MessageSizeType_Invalidate_Control:
121      case MessageSizeType_Unblock_Control:
122      case MessageSizeType_Persistent_Control:
123      case MessageSizeType_Completion_Control:
124        return m_control_msg_size;
125      case MessageSizeType_Data:
126      case MessageSizeType_Response_Data:
127      case MessageSizeType_ResponseLocal_Data:
128      case MessageSizeType_ResponseL2hit_Data:
129      case MessageSizeType_Writeback_Data:
130        return m_data_msg_size;
131      default:
132        panic("Invalid range for type MessageSizeType");
133        break;
134    }
135}
136
137void
138Network::checkNetworkAllocation(NodeID id, bool ordered,
139                                        int network_num,
140                                        std::string vnet_type)
141{
142    fatal_if(id >= m_nodes, "Node ID is out of range");
143    fatal_if(network_num >= m_virtual_networks, "Network id is out of range");
144
145    if (ordered) {
146        m_ordered[network_num] = true;
147    }
148
149    m_vnet_type_names[network_num] = vnet_type;
150}
151
152
153void
154Network::setToNetQueue(NodeID id, bool ordered, int network_num,
155                                 std::string vnet_type, MessageBuffer *b)
156{
157    checkNetworkAllocation(id, ordered, network_num, vnet_type);
158    while (m_toNetQueues[id].size() <= network_num) {
159        m_toNetQueues[id].push_back(nullptr);
160    }
161    m_toNetQueues[id][network_num] = b;
162}
163
164void
165Network::setFromNetQueue(NodeID id, bool ordered, int network_num,
166                                   std::string vnet_type, MessageBuffer *b)
167{
168    checkNetworkAllocation(id, ordered, network_num, vnet_type);
169    while (m_fromNetQueues[id].size() <= network_num) {
170        m_fromNetQueues[id].push_back(nullptr);
171    }
172    m_fromNetQueues[id][network_num] = b;
173}
174