SimpleNetwork.cc revision 9593:9441ca79f3c8 
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    // record the routers
83    for (vector<BasicRouter*>::const_iterator i = p->routers.begin();
84         i != p->routers.end(); ++i) {
85        Switch* s = safe_cast<Switch*>(*i);
86        m_switch_ptr_vector.push_back(s);
87        s->init_net_ptr(this);
88    }
89}
90
91void
92SimpleNetwork::init()
93{
94    Network::init();
95
96    // The topology pointer should have already been initialized in
97    // the parent class network constructor.
98    assert(m_topology_ptr != NULL);
99    // false because this isn't a reconfiguration
100    m_topology_ptr->createLinks(this, false);
101}
102
103void
104SimpleNetwork::reset()
105{
106    for (int node = 0; node < m_nodes; node++) {
107        for (int j = 0; j < m_virtual_networks; j++) {
108            m_toNetQueues[node][j]->clear();
109            m_fromNetQueues[node][j]->clear();
110        }
111    }
112
113    for(int i = 0; i < m_switch_ptr_vector.size(); i++){
114        m_switch_ptr_vector[i]->clearBuffers();
115    }
116}
117
118SimpleNetwork::~SimpleNetwork()
119{
120    for (int i = 0; i < m_nodes; i++) {
121        deletePointers(m_toNetQueues[i]);
122        deletePointers(m_fromNetQueues[i]);
123    }
124    deletePointers(m_switch_ptr_vector);
125    deletePointers(m_buffers_to_free);
126    // delete m_topology_ptr;
127}
128
129// From a switch to an endpoint node
130void
131SimpleNetwork::makeOutLink(SwitchID src, NodeID dest, BasicLink* link,
132                           LinkDirection direction,
133                           const NetDest& routing_table_entry,
134                           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    SimpleExtLink *simple_link = safe_cast<SimpleExtLink*>(link);
146
147    m_switch_ptr_vector[src]->addOutPort(m_fromNetQueues[dest],
148                                         routing_table_entry,
149                                         simple_link->m_latency,
150                                         simple_link->m_bw_multiplier);
151
152    m_endpoint_switches[dest] = m_switch_ptr_vector[src];
153}
154
155// From an endpoint node to a switch
156void
157SimpleNetwork::makeInLink(NodeID src, SwitchID dest, BasicLink* link,
158                          LinkDirection direction,
159                          const NetDest& routing_table_entry,
160                          bool isReconfiguration)
161{
162    assert(src < m_nodes);
163    if (isReconfiguration) {
164        // do nothing
165        return;
166    }
167
168    m_switch_ptr_vector[dest]->addInPort(m_toNetQueues[src]);
169}
170
171// From a switch to a switch
172void
173SimpleNetwork::makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
174                                LinkDirection direction,
175                                const NetDest& routing_table_entry,
176                                bool isReconfiguration)
177{
178    if (isReconfiguration) {
179        m_switch_ptr_vector[src]->reconfigureOutPort(routing_table_entry);
180        return;
181    }
182
183    // Create a set of new MessageBuffers
184    std::vector<MessageBuffer*> queues;
185    for (int i = 0; i < m_virtual_networks; i++) {
186        // allocate a buffer
187        MessageBuffer* buffer_ptr = new MessageBuffer;
188        buffer_ptr->setOrdering(true);
189        if (m_buffer_size > 0) {
190            buffer_ptr->resize(m_buffer_size);
191        }
192        queues.push_back(buffer_ptr);
193        // remember to deallocate it
194        m_buffers_to_free.push_back(buffer_ptr);
195    }
196    // Connect it to the two switches
197    SimpleIntLink *simple_link = safe_cast<SimpleIntLink*>(link);
198
199    m_switch_ptr_vector[dest]->addInPort(queues);
200    m_switch_ptr_vector[src]->addOutPort(queues, routing_table_entry,
201                                         simple_link->m_latency,
202                                         simple_link->m_bw_multiplier);
203}
204
205void
206SimpleNetwork::checkNetworkAllocation(NodeID id, bool ordered, int network_num)
207{
208    assert(id < m_nodes);
209    assert(network_num < m_virtual_networks);
210
211    if (ordered) {
212        m_ordered[network_num] = true;
213    }
214    m_in_use[network_num] = true;
215}
216
217MessageBuffer*
218SimpleNetwork::getToNetQueue(NodeID id, bool ordered, int network_num,
219                             std::string vnet_type)
220{
221    checkNetworkAllocation(id, ordered, network_num);
222    return m_toNetQueues[id][network_num];
223}
224
225MessageBuffer*
226SimpleNetwork::getFromNetQueue(NodeID id, bool ordered, int network_num,
227                               std::string vnet_type)
228{
229    checkNetworkAllocation(id, ordered, network_num);
230    return m_fromNetQueues[id][network_num];
231}
232
233const std::vector<Throttle*>*
234SimpleNetwork::getThrottles(NodeID id) const
235{
236    assert(id >= 0);
237    assert(id < m_nodes);
238    assert(m_endpoint_switches[id] != NULL);
239    return m_endpoint_switches[id]->getThrottles();
240}
241
242void
243SimpleNetwork::printStats(ostream& out) const
244{
245    out << endl;
246    out << "Network Stats" << endl;
247    out << "-------------" << endl;
248    out << endl;
249
250    //
251    // Determine total counts before printing out each switch's stats
252    //
253    std::vector<uint64> total_msg_counts;
254    total_msg_counts.resize(MessageSizeType_NUM);
255    for (MessageSizeType type = MessageSizeType_FIRST;
256         type < MessageSizeType_NUM;
257         ++type) {
258        total_msg_counts[type] = 0;
259    }
260
261    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
262        const std::vector<Throttle*>* throttles =
263            m_switch_ptr_vector[i]->getThrottles();
264
265        for (int p = 0; p < throttles->size(); p++) {
266
267            const std::vector<std::vector<int> >& message_counts =
268                ((*throttles)[p])->getCounters();
269
270            for (MessageSizeType type = MessageSizeType_FIRST;
271                 type < MessageSizeType_NUM;
272                 ++type) {
273
274                const std::vector<int> &mct = message_counts[type];
275                int sum = accumulate(mct.begin(), mct.end(), 0);
276                total_msg_counts[type] += uint64(sum);
277            }
278        }
279    }
280    uint64 total_msgs = 0;
281    uint64 total_bytes = 0;
282    for (MessageSizeType type = MessageSizeType_FIRST;
283         type < MessageSizeType_NUM;
284         ++type) {
285
286        if (total_msg_counts[type] > 0) {
287            out << "total_msg_count_" << type << ": " << total_msg_counts[type]
288                << " " << total_msg_counts[type] *
289                uint64(MessageSizeType_to_int(type))
290                << endl;
291
292            total_msgs += total_msg_counts[type];
293
294            total_bytes += total_msg_counts[type] *
295                uint64(MessageSizeType_to_int(type));
296        }
297    }
298
299    out << "total_msgs: " << total_msgs
300        << " total_bytes: " << total_bytes << endl;
301
302    out << endl;
303    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
304        m_switch_ptr_vector[i]->printStats(out);
305    }
306}
307
308void
309SimpleNetwork::clearStats()
310{
311    for (int i = 0; i < m_switch_ptr_vector.size(); i++) {
312        m_switch_ptr_vector[i]->clearStats();
313    }
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
328/*
329 * The simple network has an array of switches. These switches have buffers
330 * that need to be accessed for functional reads and writes. Also the links
331 * between different switches have buffers that need to be accessed.
332 */
333bool
334SimpleNetwork::functionalRead(Packet *pkt)
335{
336    for (unsigned int i = 0; i < m_switch_ptr_vector.size(); i++) {
337        if (m_switch_ptr_vector[i]->functionalRead(pkt)) {
338            return true;
339        }
340    }
341
342    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
343        if (m_buffers_to_free[i]->functionalRead(pkt)) {
344            return true;
345        }
346    }
347
348    return false;
349}
350
351uint32_t
352SimpleNetwork::functionalWrite(Packet *pkt)
353{
354    uint32_t num_functional_writes = 0;
355
356    for (unsigned int i = 0; i < m_switch_ptr_vector.size(); i++) {
357        num_functional_writes += m_switch_ptr_vector[i]->functionalWrite(pkt);
358    }
359
360    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
361        num_functional_writes += m_buffers_to_free[i]->functionalWrite(pkt);
362    }
363    return num_functional_writes;
364}
365