Network.cc revision 10303:71e0934af9f1 
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
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    for (int node = 0; node < m_nodes; node++) {
61        // Setting number of virtual message buffers per Network Queue
62        m_toNetQueues[node].resize(m_virtual_networks);
63        m_fromNetQueues[node].resize(m_virtual_networks);
64
65        // Instantiating the Message Buffers that
66        // interact with the coherence protocol
67        for (int j = 0; j < m_virtual_networks; j++) {
68            m_toNetQueues[node][j] = new MessageBuffer();
69            m_fromNetQueues[node][j] = new MessageBuffer();
70        }
71    }
72
73    m_in_use.resize(m_virtual_networks);
74    m_ordered.resize(m_virtual_networks);
75
76    for (int i = 0; i < m_virtual_networks; i++) {
77        m_in_use[i] = false;
78        m_ordered[i] = false;
79    }
80
81    p->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    }
90
91    // Register a callback function for combining the statistics
92    Stats::registerDumpCallback(new StatsCallback(this));
93}
94
95Network::~Network()
96{
97    for (int node = 0; node < m_nodes; node++) {
98        // Delete the Message Buffers
99        for (int j = 0; j < m_virtual_networks; j++) {
100            delete m_toNetQueues[node][j];
101            delete m_fromNetQueues[node][j];
102        }
103    }
104
105    delete m_topology_ptr;
106}
107
108void
109Network::init()
110{
111    m_data_msg_size = RubySystem::getBlockSizeBytes() + m_control_msg_size;
112}
113
114uint32_t
115Network::MessageSizeType_to_int(MessageSizeType size_type)
116{
117    switch(size_type) {
118      case MessageSizeType_Control:
119      case MessageSizeType_Request_Control:
120      case MessageSizeType_Reissue_Control:
121      case MessageSizeType_Response_Control:
122      case MessageSizeType_Writeback_Control:
123      case MessageSizeType_Broadcast_Control:
124      case MessageSizeType_Multicast_Control:
125      case MessageSizeType_Forwarded_Control:
126      case MessageSizeType_Invalidate_Control:
127      case MessageSizeType_Unblock_Control:
128      case MessageSizeType_Persistent_Control:
129      case MessageSizeType_Completion_Control:
130        return m_control_msg_size;
131      case MessageSizeType_Data:
132      case MessageSizeType_Response_Data:
133      case MessageSizeType_ResponseLocal_Data:
134      case MessageSizeType_ResponseL2hit_Data:
135      case MessageSizeType_Writeback_Data:
136        return m_data_msg_size;
137      default:
138        panic("Invalid range for type MessageSizeType");
139        break;
140    }
141}
142