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/simple/SimpleNetwork.hh"
30
31#include <cassert>
32#include <numeric>
33
34#include "base/cast.hh"
35#include "base/stl_helpers.hh"
36#include "mem/ruby/common/NetDest.hh"
37#include "mem/ruby/network/MessageBuffer.hh"
38#include "mem/ruby/network/simple/SimpleLink.hh"
39#include "mem/ruby/network/simple/Switch.hh"
40#include "mem/ruby/network/simple/Throttle.hh"
41#include "mem/ruby/profiler/Profiler.hh"
42
43using namespace std;
44using m5::stl_helpers::deletePointers;
45
46SimpleNetwork::SimpleNetwork(const Params *p)
47    : Network(p), m_buffer_size(p->buffer_size),
48      m_endpoint_bandwidth(p->endpoint_bandwidth),
49      m_adaptive_routing(p->adaptive_routing)
50{
51    // record the routers
52    for (vector<BasicRouter*>::const_iterator i = p->routers.begin();
53         i != p->routers.end(); ++i) {
54        Switch* s = safe_cast<Switch*>(*i);
55        m_switches.push_back(s);
56        s->init_net_ptr(this);
57    }
58
59    m_int_link_buffers = p->int_link_buffers;
60    m_num_connected_buffers = 0;
61}
62
63void
64SimpleNetwork::init()
65{
66    Network::init();
67
68    // The topology pointer should have already been initialized in
69    // the parent class network constructor.
70    assert(m_topology_ptr != NULL);
71    m_topology_ptr->createLinks(this);
72}
73
74SimpleNetwork::~SimpleNetwork()
75{
76    deletePointers(m_switches);
77    deletePointers(m_int_link_buffers);
78}
79
80// From a switch to an endpoint node
81void
82SimpleNetwork::makeExtOutLink(SwitchID src, NodeID dest, BasicLink* link,
83                           const NetDest& routing_table_entry)
84{
85    assert(dest < m_nodes);
86    assert(src < m_switches.size());
87    assert(m_switches[src] != NULL);
88
89    SimpleExtLink *simple_link = safe_cast<SimpleExtLink*>(link);
90
91    m_switches[src]->addOutPort(m_fromNetQueues[dest], routing_table_entry,
92                                simple_link->m_latency,
93                                simple_link->m_bw_multiplier);
94}
95
96// From an endpoint node to a switch
97void
98SimpleNetwork::makeExtInLink(NodeID src, SwitchID dest, BasicLink* link,
99                          const NetDest& routing_table_entry)
100{
101    assert(src < m_nodes);
102    m_switches[dest]->addInPort(m_toNetQueues[src]);
103}
104
105// From a switch to a switch
106void
107SimpleNetwork::makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
108                                const NetDest& routing_table_entry,
109                                PortDirection src_outport,
110                                PortDirection dst_inport)
111{
112    // Create a set of new MessageBuffers
113    std::vector<MessageBuffer*> queues(m_virtual_networks);
114
115    for (int i = 0; i < m_virtual_networks; i++) {
116        // allocate a buffer
117        assert(m_num_connected_buffers < m_int_link_buffers.size());
118        MessageBuffer* buffer_ptr = m_int_link_buffers[m_num_connected_buffers];
119        m_num_connected_buffers++;
120        queues[i] = buffer_ptr;
121    }
122
123    // Connect it to the two switches
124    SimpleIntLink *simple_link = safe_cast<SimpleIntLink*>(link);
125
126    m_switches[dest]->addInPort(queues);
127    m_switches[src]->addOutPort(queues, routing_table_entry,
128                                simple_link->m_latency,
129                                simple_link->m_bw_multiplier);
130}
131
132void
133SimpleNetwork::regStats()
134{
135    Network::regStats();
136
137    for (MessageSizeType type = MessageSizeType_FIRST;
138         type < MessageSizeType_NUM; ++type) {
139        m_msg_counts[(unsigned int) type]
140            .name(name() + ".msg_count." + MessageSizeType_to_string(type))
141            .flags(Stats::nozero)
142            ;
143        m_msg_bytes[(unsigned int) type]
144            .name(name() + ".msg_byte." + MessageSizeType_to_string(type))
145            .flags(Stats::nozero)
146            ;
147
148        // Now state what the formula is.
149        for (int i = 0; i < m_switches.size(); i++) {
150            m_msg_counts[(unsigned int) type] +=
151                sum(m_switches[i]->getMsgCount(type));
152        }
153
154        m_msg_bytes[(unsigned int) type] =
155            m_msg_counts[(unsigned int) type] * Stats::constant(
156                    Network::MessageSizeType_to_int(type));
157    }
158}
159
160void
161SimpleNetwork::collateStats()
162{
163    for (int i = 0; i < m_switches.size(); i++) {
164        m_switches[i]->collateStats();
165    }
166}
167
168void
169SimpleNetwork::print(ostream& out) const
170{
171    out << "[SimpleNetwork]";
172}
173
174SimpleNetwork *
175SimpleNetworkParams::create()
176{
177    return new SimpleNetwork(this);
178}
179
180/*
181 * The simple network has an array of switches. These switches have buffers
182 * that need to be accessed for functional reads and writes. Also the links
183 * between different switches have buffers that need to be accessed.
184 */
185bool
186SimpleNetwork::functionalRead(Packet *pkt)
187{
188    for (unsigned int i = 0; i < m_switches.size(); i++) {
189        if (m_switches[i]->functionalRead(pkt)) {
190            return true;
191        }
192    }
193
194    return false;
195}
196
197uint32_t
198SimpleNetwork::functionalWrite(Packet *pkt)
199{
200    uint32_t num_functional_writes = 0;
201
202    for (unsigned int i = 0; i < m_switches.size(); i++) {
203        num_functional_writes += m_switches[i]->functionalWrite(pkt);
204    }
205
206    for (unsigned int i = 0; i < m_int_link_buffers.size(); ++i) {
207        num_functional_writes += m_int_link_buffers[i]->functionalWrite(pkt);
208    }
209    return num_functional_writes;
210}
211