Network.cc revision 11793:ef606668d247 
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 "mem/ruby/network/Network.hh"
30
31#include "base/misc.hh"
32#include "mem/ruby/network/BasicLink.hh"
33#include "mem/ruby/system/RubySystem.hh"
34
35uint32_t Network::m_virtual_networks;
36uint32_t Network::m_control_msg_size;
37uint32_t Network::m_data_msg_size;
38
39Network::Network(const Params *p)
40    : ClockedObject(p)
41{
42    m_virtual_networks = p->number_of_virtual_networks;
43    m_control_msg_size = p->control_msg_size;
44
45    // Total nodes/controllers in network
46    // Must make sure this is called after the State Machine constructors
47    m_nodes = MachineType_base_number(MachineType_NUM);
48    assert(m_nodes != 0);
49    assert(m_virtual_networks != 0);
50
51    m_topology_ptr = new Topology(p->routers.size(), p->ext_links,
52                                  p->int_links);
53
54    // Allocate to and from queues
55    // Queues that are getting messages from protocol
56    m_toNetQueues.resize(m_nodes);
57
58    // Queues that are feeding the protocol
59    m_fromNetQueues.resize(m_nodes);
60
61    m_ordered.resize(m_virtual_networks);
62    m_vnet_type_names.resize(m_virtual_networks);
63
64    for (int i = 0; i < m_virtual_networks; i++) {
65        m_ordered[i] = false;
66    }
67
68    params()->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    for (auto &it : dynamic_cast<Network *>(this)->params()->ext_links) {
82        it->params()->ext_node->initNetQueues();
83    }
84}
85
86Network::~Network()
87{
88    for (int node = 0; node < m_nodes; node++) {
89
90        // Delete the Message Buffers
91        for (auto& it : m_toNetQueues[node]) {
92            delete it;
93        }
94
95        for (auto& it : m_fromNetQueues[node]) {
96            delete it;
97        }
98    }
99
100    delete m_topology_ptr;
101}
102
103void
104Network::init()
105{
106    m_data_msg_size = RubySystem::getBlockSizeBytes() + m_control_msg_size;
107}
108
109uint32_t
110Network::MessageSizeType_to_int(MessageSizeType size_type)
111{
112    switch(size_type) {
113      case MessageSizeType_Control:
114      case MessageSizeType_Request_Control:
115      case MessageSizeType_Reissue_Control:
116      case MessageSizeType_Response_Control:
117      case MessageSizeType_Writeback_Control:
118      case MessageSizeType_Broadcast_Control:
119      case MessageSizeType_Multicast_Control:
120      case MessageSizeType_Forwarded_Control:
121      case MessageSizeType_Invalidate_Control:
122      case MessageSizeType_Unblock_Control:
123      case MessageSizeType_Persistent_Control:
124      case MessageSizeType_Completion_Control:
125        return m_control_msg_size;
126      case MessageSizeType_Data:
127      case MessageSizeType_Response_Data:
128      case MessageSizeType_ResponseLocal_Data:
129      case MessageSizeType_ResponseL2hit_Data:
130      case MessageSizeType_Writeback_Data:
131        return m_data_msg_size;
132      default:
133        panic("Invalid range for type MessageSizeType");
134        break;
135    }
136}
137
138void
139Network::checkNetworkAllocation(NodeID id, bool ordered,
140                                        int network_num,
141                                        std::string vnet_type)
142{
143    fatal_if(id >= m_nodes, "Node ID is out of range");
144    fatal_if(network_num >= m_virtual_networks, "Network id is out of range");
145
146    if (ordered) {
147        m_ordered[network_num] = true;
148    }
149
150    m_vnet_type_names[network_num] = vnet_type;
151}
152
153
154void
155Network::setToNetQueue(NodeID id, bool ordered, int network_num,
156                                 std::string vnet_type, MessageBuffer *b)
157{
158    checkNetworkAllocation(id, ordered, network_num, vnet_type);
159    while (m_toNetQueues[id].size() <= network_num) {
160        m_toNetQueues[id].push_back(nullptr);
161    }
162    m_toNetQueues[id][network_num] = b;
163}
164
165void
166Network::setFromNetQueue(NodeID id, bool ordered, int network_num,
167                                   std::string vnet_type, MessageBuffer *b)
168{
169    checkNetworkAllocation(id, ordered, network_num, vnet_type);
170    while (m_fromNetQueues[id].size() <= network_num) {
171        m_fromNetQueues[id].push_back(nullptr);
172    }
173    m_fromNetQueues[id][network_num] = b;
174}
175