SimpleNetwork.cc revision 9117:49116b947194 
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 <cassert>
30#include <numeric>
31
32#include "base/cast.hh"
33#include "base/stl_helpers.hh"
34#include "mem/ruby/buffers/MessageBuffer.hh"
35#include "mem/ruby/common/NetDest.hh"
36#include "mem/ruby/network/BasicLink.hh"
37#include "mem/ruby/network/simple/SimpleLink.hh"
38#include "mem/ruby/network/simple/SimpleNetwork.hh"
39#include "mem/ruby/network/simple/Switch.hh"
40#include "mem/ruby/network/simple/Throttle.hh"
41#include "mem/ruby/network/Topology.hh"
42#include "mem/ruby/profiler/Profiler.hh"
43#include "mem/ruby/system/System.hh"
44
45using namespace std;
46using m5::stl_helpers::deletePointers;
47
48SimpleNetwork::SimpleNetwork(const Params *p)
49    : Network(p)
50{
51    m_buffer_size = p->buffer_size;
52    m_endpoint_bandwidth = p->endpoint_bandwidth;
53    m_adaptive_routing = p->adaptive_routing;
54
55    // Note: the parent Network Object constructor is called before the
56    // SimpleNetwork child constructor.  Therefore, the member variables
57    // used below should already be initialized.
58
59    m_endpoint_switches.resize(m_nodes);
60
61    m_in_use.resize(m_virtual_networks);
62    m_ordered.resize(m_virtual_networks);
63    for (int i = 0; i < m_virtual_networks; i++) {
64        m_in_use[i] = false;
65        m_ordered[i] = false;
66    }
67
68    // Allocate to and from queues
69    m_toNetQueues.resize(m_nodes);
70    m_fromNetQueues.resize(m_nodes);
71    for (int node = 0; node < m_nodes; node++) {
72        m_toNetQueues[node].resize(m_virtual_networks);
73        m_fromNetQueues[node].resize(m_virtual_networks);
74        for (int j = 0; j < m_virtual_networks; j++) {
75            m_toNetQueues[node][j] =
76                new MessageBuffer(csprintf("toNet node %d j %d", node, j));
77            m_fromNetQueues[node][j] =
78                new MessageBuffer(csprintf("fromNet node %d j %d", node, j));
79        }
80    }
81}
82
83void
84SimpleNetwork::init()
85{
86    Network::init();
87
88    // The topology pointer should have already been initialized in
89    // the parent class network constructor.
90    assert(m_topology_ptr != NULL);
91    int number_of_switches = m_topology_ptr->numSwitches();
92    for (int i = 0; i < number_of_switches; i++) {
93        m_switch_ptr_vector.push_back(new Switch(i, this));
94    }
95
96    // false because this isn't a reconfiguration
97    m_topology_ptr->createLinks(this, false);
98}
99
100void
101SimpleNetwork::reset()
102{
103    for (int node = 0; node < m_nodes; node++) {
104        for (int j = 0; j < m_virtual_networks; j++) {
105            m_toNetQueues[node][j]->clear();
106            m_fromNetQueues[node][j]->clear();
107        }
108    }
109
110    for(int i = 0; i < m_switch_ptr_vector.size(); i++){
111        m_switch_ptr_vector[i]->clearBuffers();
112    }
113}
114
115SimpleNetwork::~SimpleNetwork()
116{
117    for (int i = 0; i < m_nodes; i++) {
118        deletePointers(m_toNetQueues[i]);
119        deletePointers(m_fromNetQueues[i]);
120    }
121    deletePointers(m_switch_ptr_vector);
122    deletePointers(m_buffers_to_free);
123    // delete m_topology_ptr;
124}
125
126// From a switch to an endpoint node
127void
128SimpleNetwork::makeOutLink(SwitchID src, NodeID dest, BasicLink* link,
129                           LinkDirection direction,
130                           const NetDest& routing_table_entry,
131                           bool isReconfiguration)
132{
133    assert(dest < m_nodes);
134    assert(src < m_switch_ptr_vector.size());
135    assert(m_switch_ptr_vector[src] != NULL);
136
137    if (isReconfiguration) {
138        m_switch_ptr_vector[src]->reconfigureOutPort(routing_table_entry);
139        return;
140    }
141
142    SimpleExtLink *simple_link = safe_cast<SimpleExtLink*>(link);
143
144    m_switch_ptr_vector[src]->addOutPort(m_fromNetQueues[dest],
145                                         routing_table_entry,
146                                         simple_link->m_latency,
147                                         simple_link->m_bw_multiplier);
148
149    m_endpoint_switches[dest] = m_switch_ptr_vector[src];
150}
151
152// From an endpoint node to a switch
153void
154SimpleNetwork::makeInLink(NodeID src, SwitchID dest, BasicLink* link,
155                          LinkDirection direction,
156                          const NetDest& routing_table_entry,
157                          bool isReconfiguration)
158{
159    assert(src < m_nodes);
160    if (isReconfiguration) {
161        // do nothing
162        return;
163    }
164
165    m_switch_ptr_vector[dest]->addInPort(m_toNetQueues[src]);
166}
167
168// From a switch to a switch
169void
170SimpleNetwork::makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
171                                LinkDirection direction,
172                                const NetDest& routing_table_entry,
173                                bool isReconfiguration)
174{
175    if (isReconfiguration) {
176        m_switch_ptr_vector[src]->reconfigureOutPort(routing_table_entry);
177        return;
178    }
179
180    // Create a set of new MessageBuffers
181    std::vector<MessageBuffer*> queues;
182    for (int i = 0; i < m_virtual_networks; i++) {
183        // allocate a buffer
184        MessageBuffer* buffer_ptr = new MessageBuffer;
185        buffer_ptr->setOrdering(true);
186        if (m_buffer_size > 0) {
187            buffer_ptr->resize(m_buffer_size);
188        }
189        queues.push_back(buffer_ptr);
190        // remember to deallocate it
191        m_buffers_to_free.push_back(buffer_ptr);
192    }
193    // Connect it to the two switches
194    SimpleIntLink *simple_link = safe_cast<SimpleIntLink*>(link);
195
196    m_switch_ptr_vector[dest]->addInPort(queues);
197    m_switch_ptr_vector[src]->addOutPort(queues, routing_table_entry,
198                                         simple_link->m_latency,
199                                         simple_link->m_bw_multiplier);
200}
201
202void
203SimpleNetwork::checkNetworkAllocation(NodeID id, bool ordered, int network_num)
204{
205    assert(id < m_nodes);
206    assert(network_num < m_virtual_networks);
207
208    if (ordered) {
209        m_ordered[network_num] = true;
210    }
211    m_in_use[network_num] = true;
212}
213
214MessageBuffer*
215SimpleNetwork::getToNetQueue(NodeID id, bool ordered, int network_num,
216                             std::string vnet_type)
217{
218    checkNetworkAllocation(id, ordered, network_num);
219    return m_toNetQueues[id][network_num];
220}
221
222MessageBuffer*
223SimpleNetwork::getFromNetQueue(NodeID id, bool ordered, int network_num,
224                               std::string vnet_type)
225{
226    checkNetworkAllocation(id, ordered, network_num);
227    return m_fromNetQueues[id][network_num];
228}
229
230const std::vector<Throttle*>*
231SimpleNetwork::getThrottles(NodeID id) const
232{
233    assert(id >= 0);
234    assert(id < m_nodes);
235    assert(m_endpoint_switches[id] != NULL);
236    return m_endpoint_switches[id]->getThrottles();
237}
238
239void
240SimpleNetwork::printStats(ostream& out) const
241{
242    out << endl;
243    out << "Network Stats" << endl;
244    out << "-------------" << endl;
245    out << endl;
246
247    //
248    // Determine total counts before printing out each switch's stats
249    //
250    std::vector<uint64> total_msg_counts;
251    total_msg_counts.resize(MessageSizeType_NUM);
252    for (MessageSizeType type = MessageSizeType_FIRST;
253         type < MessageSizeType_NUM;
254         ++type) {
255        total_msg_counts[type] = 0;
256    }
257
258    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
259        const std::vector<Throttle*>* throttles =
260            m_switch_ptr_vector[i]->getThrottles();
261
262        for (int p = 0; p < throttles->size(); p++) {
263
264            const std::vector<std::vector<int> >& message_counts =
265                ((*throttles)[p])->getCounters();
266
267            for (MessageSizeType type = MessageSizeType_FIRST;
268                 type < MessageSizeType_NUM;
269                 ++type) {
270
271                const std::vector<int> &mct = message_counts[type];
272                int sum = accumulate(mct.begin(), mct.end(), 0);
273                total_msg_counts[type] += uint64(sum);
274            }
275        }
276    }
277    uint64 total_msgs = 0;
278    uint64 total_bytes = 0;
279    for (MessageSizeType type = MessageSizeType_FIRST;
280         type < MessageSizeType_NUM;
281         ++type) {
282
283        if (total_msg_counts[type] > 0) {
284            out << "total_msg_count_" << type << ": " << total_msg_counts[type]
285                << " " << total_msg_counts[type] *
286                uint64(RubySystem::getNetwork()->MessageSizeType_to_int(type))
287                << endl;
288
289            total_msgs += total_msg_counts[type];
290
291            total_bytes += total_msg_counts[type] *
292                uint64(RubySystem::getNetwork()->MessageSizeType_to_int(type));
293
294        }
295    }
296
297    out << "total_msgs: " << total_msgs
298        << " total_bytes: " << total_bytes << endl;
299
300    out << endl;
301    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
302        m_switch_ptr_vector[i]->printStats(out);
303    }
304    m_topology_ptr->printStats(out);
305}
306
307void
308SimpleNetwork::clearStats()
309{
310    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
311        m_switch_ptr_vector[i]->clearStats();
312    }
313    m_topology_ptr->clearStats();
314}
315
316void
317SimpleNetwork::print(ostream& out) const
318{
319    out << "[SimpleNetwork]";
320}
321
322SimpleNetwork *
323SimpleNetworkParams::create()
324{
325    return new SimpleNetwork(this);
326}
327