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/stl_helpers.hh"
30#include "mem/protocol/MachineType.hh"
31#include "mem/protocol/Protocol.hh"
32#include "mem/protocol/TopologyType.hh"
33#include "mem/ruby/buffers/MessageBuffer.hh"
34#include "mem/ruby/common/NetDest.hh"
35#include "mem/ruby/network/simple/SimpleNetwork.hh"
36#include "mem/ruby/network/simple/Switch.hh"
37#include "mem/ruby/network/simple/Topology.hh"
38#include "mem/ruby/profiler/Profiler.hh"
39#include "mem/ruby/system/System.hh"
40
41using namespace std;
42using m5::stl_helpers::deletePointers;
43
44#if 0
45// ***BIG HACK*** - This is actually code that _should_ be in Network.cc
46
47// Note: Moved to Princeton Network
48// calls new to abstract away from the network
49Network*
50Network::createNetwork(int nodes)
51{
52 return new SimpleNetwork(nodes);
53}
54#endif
55
56SimpleNetwork::SimpleNetwork(const Params *p)
57 : Network(p)
58{
59 // Note: the parent Network Object constructor is called before the
60 // SimpleNetwork child constructor. Therefore, the member variables
61 // used below should already be initialized.
62
63 m_endpoint_switches.resize(m_nodes);
64
65 m_in_use.resize(m_virtual_networks);
66 m_ordered.resize(m_virtual_networks);
67 for (int i = 0; i < m_virtual_networks; i++) {
68 m_in_use[i] = false;
69 m_ordered[i] = false;
70 }
71
72 // Allocate to and from queues
73 m_toNetQueues.resize(m_nodes);
74 m_fromNetQueues.resize(m_nodes);
75 for (int node = 0; node < m_nodes; node++) {
76 m_toNetQueues[node].resize(m_virtual_networks);
77 m_fromNetQueues[node].resize(m_virtual_networks);
78 for (int j = 0; j < m_virtual_networks; j++) {
79 m_toNetQueues[node][j] =
80 new MessageBuffer(csprintf("toNet node %d j %d", node, j));
81 m_fromNetQueues[node][j] =
82 new MessageBuffer(csprintf("fromNet node %d j %d", node, j));
83 }
84 }
85}
86
87void
88SimpleNetwork::init()
89{
90 Network::init();
91
92 // The topology pointer should have already been initialized in
93 // the parent class network constructor.
94 assert(m_topology_ptr != NULL);
95 int number_of_switches = m_topology_ptr->numSwitches();
96 for (int i = 0; i < number_of_switches; i++) {
97 m_switch_ptr_vector.push_back(new Switch(i, this));
98 }
99
100 // false because this isn't a reconfiguration
101 m_topology_ptr->createLinks(this, false);
102}
103
104void
105SimpleNetwork::reset()
106{
107 for (int node = 0; node < m_nodes; node++) {
108 for (int j = 0; j < m_virtual_networks; j++) {
109 m_toNetQueues[node][j]->clear();
110 m_fromNetQueues[node][j]->clear();
111 }
112 }
113
114 for(int i = 0; i < m_switch_ptr_vector.size(); i++){
115 m_switch_ptr_vector[i]->clearBuffers();
116 }
117}
118
119SimpleNetwork::~SimpleNetwork()
120{
121 for (int i = 0; i < m_nodes; i++) {
122 deletePointers(m_toNetQueues[i]);
123 deletePointers(m_fromNetQueues[i]);
124 }
125 deletePointers(m_switch_ptr_vector);
126 deletePointers(m_buffers_to_free);
127 // delete m_topology_ptr;
128}
129
130// From a switch to an endpoint node
131void
132SimpleNetwork::makeOutLink(SwitchID src, NodeID dest,
133 const NetDest& routing_table_entry, int link_latency, int link_weight,
134 int bw_multiplier, bool isReconfiguration)
135{
136 assert(dest < m_nodes);
137 assert(src < m_switch_ptr_vector.size());
138 assert(m_switch_ptr_vector[src] != NULL);
139
140 if (isReconfiguration) {
141 m_switch_ptr_vector[src]->reconfigureOutPort(routing_table_entry);
142 return;
143 }
144
145 m_switch_ptr_vector[src]->addOutPort(m_fromNetQueues[dest],
146 routing_table_entry, link_latency, bw_multiplier);
147 m_endpoint_switches[dest] = m_switch_ptr_vector[src];
148}
149
150// From an endpoint node to a switch
151void
152SimpleNetwork::makeInLink(NodeID src, SwitchID dest,
153 const NetDest& routing_table_entry, int link_latency, int bw_multiplier,
154 bool isReconfiguration)
155{
156 assert(src < m_nodes);
157 if (isReconfiguration) {
158 // do nothing
159 return;
160 }
161
162 m_switch_ptr_vector[dest]->addInPort(m_toNetQueues[src]);
163}
164
165// From a switch to a switch
166void
167SimpleNetwork::makeInternalLink(SwitchID src, SwitchID dest,
168 const NetDest& routing_table_entry, int link_latency, int link_weight,
169 int bw_multiplier, bool isReconfiguration)
170{
171 if (isReconfiguration) {
172 m_switch_ptr_vector[src]->reconfigureOutPort(routing_table_entry);
173 return;
174 }
175
176 // Create a set of new MessageBuffers
177 std::vector<MessageBuffer*> queues;
178 for (int i = 0; i < m_virtual_networks; i++) {
179 // allocate a buffer
180 MessageBuffer* buffer_ptr = new MessageBuffer;
181 buffer_ptr->setOrdering(true);
182 if (m_buffer_size > 0) {
183 buffer_ptr->resize(m_buffer_size);
184 }
185 queues.push_back(buffer_ptr);
186 // remember to deallocate it
187 m_buffers_to_free.push_back(buffer_ptr);
188 }
189 // Connect it to the two switches
190 m_switch_ptr_vector[dest]->addInPort(queues);
191 m_switch_ptr_vector[src]->addOutPort(queues, routing_table_entry,
192 link_latency, bw_multiplier);
193}
194
195void
196SimpleNetwork::checkNetworkAllocation(NodeID id, bool ordered, int network_num)
197{
198 ASSERT(id < m_nodes);
199 ASSERT(network_num < m_virtual_networks);
200
201 if (ordered) {
202 m_ordered[network_num] = true;
203 }
204 m_in_use[network_num] = true;
205}
206
207MessageBuffer*
208SimpleNetwork::getToNetQueue(NodeID id, bool ordered, int network_num)
209{
210 checkNetworkAllocation(id, ordered, network_num);
211 return m_toNetQueues[id][network_num];
212}
213
214MessageBuffer*
215SimpleNetwork::getFromNetQueue(NodeID id, bool ordered, int network_num)
216{
217 checkNetworkAllocation(id, ordered, network_num);
218 return m_fromNetQueues[id][network_num];
219}
220
221const std::vector<Throttle*>*
222SimpleNetwork::getThrottles(NodeID id) const
223{
224 assert(id >= 0);
225 assert(id < m_nodes);
226 assert(m_endpoint_switches[id] != NULL);
227 return m_endpoint_switches[id]->getThrottles();
228}
229
230void
231SimpleNetwork::printStats(ostream& out) const
232{
233 out << endl;
234 out << "Network Stats" << endl;
235 out << "-------------" << endl;
236 out << endl;
237 for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
238 m_switch_ptr_vector[i]->printStats(out);
239 }
240 m_topology_ptr->printStats(out);
241}
242
243void
244SimpleNetwork::clearStats()
245{
246 for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
247 m_switch_ptr_vector[i]->clearStats();
248 }
249 m_topology_ptr->clearStats();
250}
251
252void
253SimpleNetwork::printConfig(ostream& out) const
254{
255 out << endl;
256 out << "Network Configuration" << endl;
257 out << "---------------------" << endl;
258 out << "network: SIMPLE_NETWORK" << endl;
259 out << "topology: " << m_topology_ptr->getName() << endl;
260 out << endl;
261
262 for (int i = 0; i < m_virtual_networks; i++) {
263 out << "virtual_net_" << i << ": ";
264 if (m_in_use[i]) {
265 out << "active, ";
266 if (m_ordered[i]) {
267 out << "ordered" << endl;
268 } else {
269 out << "unordered" << endl;
270 }
271 } else {
272 out << "inactive" << endl;
273 }
274 }
275 out << endl;
276
277 for(int i = 0; i < m_switch_ptr_vector.size(); i++) {
278 m_switch_ptr_vector[i]->printConfig(out);
279 }
280
281 m_topology_ptr->printConfig(out);
282}
283
284void
285SimpleNetwork::print(ostream& out) const
286{
287 out << "[SimpleNetwork]";
288}
289
290
291SimpleNetwork *
292SimpleNetworkParams::create()
293{
294 return new SimpleNetwork(this);
295}