Switch.cc revision 10311:ad9c042dce54 
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 <numeric>
30
31#include "base/cast.hh"
32#include "base/stl_helpers.hh"
33#include "mem/ruby/network/MessageBuffer.hh"
34#include "mem/ruby/network/simple/PerfectSwitch.hh"
35#include "mem/ruby/network/simple/SimpleNetwork.hh"
36#include "mem/ruby/network/simple/Switch.hh"
37#include "mem/ruby/network/simple/Throttle.hh"
38
39using namespace std;
40using m5::stl_helpers::deletePointers;
41using m5::stl_helpers::operator<<;
42
43Switch::Switch(const Params *p) : BasicRouter(p)
44{
45    m_perfect_switch = new PerfectSwitch(m_id, this, p->virt_nets);
46}
47
48Switch::~Switch()
49{
50    delete m_perfect_switch;
51
52    // Delete throttles (one per output port)
53    deletePointers(m_throttles);
54
55    // Delete MessageBuffers
56    deletePointers(m_buffers_to_free);
57}
58
59void
60Switch::init()
61{
62    BasicRouter::init();
63    m_perfect_switch->init(m_network_ptr);
64}
65
66void
67Switch::addInPort(const map<int, MessageBuffer*>& in)
68{
69    m_perfect_switch->addInPort(in);
70
71    for (auto& it : in) {
72        it.second->setReceiver(this);
73    }
74}
75
76void
77Switch::addOutPort(const map<int, MessageBuffer*>& out,
78                   const NetDest& routing_table_entry,
79                   Cycles link_latency, int bw_multiplier)
80{
81    // Create a throttle
82    Throttle* throttle_ptr = new Throttle(m_id, m_throttles.size(),
83                                          link_latency, bw_multiplier,
84                                          m_network_ptr->getEndpointBandwidth(),
85                                          this);
86
87    m_throttles.push_back(throttle_ptr);
88
89    // Create one buffer per vnet (these are intermediaryQueues)
90    map<int, MessageBuffer*> intermediateBuffers;
91
92    for (auto& it : out) {
93        it.second->setSender(this);
94
95        MessageBuffer* buffer_ptr = new MessageBuffer;
96        // Make these queues ordered
97        buffer_ptr->setOrdering(true);
98        if (m_network_ptr->getBufferSize() > 0) {
99            buffer_ptr->resize(m_network_ptr->getBufferSize());
100        }
101
102        intermediateBuffers[it.first] = buffer_ptr;
103        m_buffers_to_free.push_back(buffer_ptr);
104
105        buffer_ptr->setSender(this);
106        buffer_ptr->setReceiver(this);
107    }
108
109    // Hook the queues to the PerfectSwitch
110    m_perfect_switch->addOutPort(intermediateBuffers, routing_table_entry);
111
112    // Hook the queues to the Throttle
113    throttle_ptr->addLinks(intermediateBuffers, out);
114}
115
116const Throttle*
117Switch::getThrottle(LinkID link_number) const
118{
119    assert(m_throttles[link_number] != NULL);
120    return m_throttles[link_number];
121}
122
123void
124Switch::regStats()
125{
126    for (int link = 0; link < m_throttles.size(); link++) {
127        m_throttles[link]->regStats(name());
128    }
129
130    m_avg_utilization.name(name() + ".percent_links_utilized");
131    for (unsigned int i = 0; i < m_throttles.size(); i++) {
132        m_avg_utilization += m_throttles[i]->getUtilization();
133    }
134    m_avg_utilization /= Stats::constant(m_throttles.size());
135
136    for (unsigned int type = MessageSizeType_FIRST;
137         type < MessageSizeType_NUM; ++type) {
138        m_msg_counts[type]
139            .name(name() + ".msg_count." +
140                MessageSizeType_to_string(MessageSizeType(type)))
141            .flags(Stats::nozero)
142            ;
143        m_msg_bytes[type]
144            .name(name() + ".msg_bytes." +
145                MessageSizeType_to_string(MessageSizeType(type)))
146            .flags(Stats::nozero)
147            ;
148
149        for (unsigned int i = 0; i < m_throttles.size(); i++) {
150            m_msg_counts[type] += m_throttles[i]->getMsgCount(type);
151        }
152        m_msg_bytes[type] = m_msg_counts[type] * Stats::constant(
153                Network::MessageSizeType_to_int(MessageSizeType(type)));
154    }
155}
156
157void
158Switch::resetStats()
159{
160    m_perfect_switch->clearStats();
161    for (int i = 0; i < m_throttles.size(); i++) {
162        m_throttles[i]->clearStats();
163    }
164}
165
166void
167Switch::collateStats()
168{
169    m_perfect_switch->collateStats();
170    for (int i = 0; i < m_throttles.size(); i++) {
171        m_throttles[i]->collateStats();
172    }
173}
174
175void
176Switch::print(std::ostream& out) const
177{
178    // FIXME printing
179    out << "[Switch]";
180}
181
182bool
183Switch::functionalRead(Packet *pkt)
184{
185    // Access the buffers in the switch for performing a functional read
186    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
187        if (m_buffers_to_free[i]->functionalRead(pkt)) {
188            return true;
189        }
190    }
191    return false;
192}
193
194uint32_t
195Switch::functionalWrite(Packet *pkt)
196{
197    // Access the buffers in the switch for performing a functional write
198    uint32_t num_functional_writes = 0;
199    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
200        num_functional_writes += m_buffers_to_free[i]->functionalWrite(pkt);
201    }
202    return num_functional_writes;
203}
204
205Switch *
206SwitchParams::create()
207{
208    return new Switch(this);
209}
210