Switch.cc revision 9302:c2e70a9bc340 
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/protocol/MessageSizeType.hh"
34#include "mem/ruby/buffers/MessageBuffer.hh"
35#include "mem/ruby/network/simple/PerfectSwitch.hh"
36#include "mem/ruby/network/simple/SimpleNetwork.hh"
37#include "mem/ruby/network/simple/Switch.hh"
38#include "mem/ruby/network/simple/Throttle.hh"
39
40using namespace std;
41using m5::stl_helpers::deletePointers;
42using m5::stl_helpers::operator<<;
43
44Switch::Switch(const Params *p) : BasicRouter(p)
45{
46    m_perfect_switch_ptr = new PerfectSwitch(m_id, this, p->virt_nets);
47}
48
49Switch::~Switch()
50{
51    delete m_perfect_switch_ptr;
52
53    // Delete throttles (one per output port)
54    deletePointers(m_throttles);
55
56    // Delete MessageBuffers
57    deletePointers(m_buffers_to_free);
58}
59
60void
61Switch::init()
62{
63    BasicRouter::init();
64    m_perfect_switch_ptr->init(m_network_ptr);
65}
66
67void
68Switch::addInPort(const vector<MessageBuffer*>& in)
69{
70    m_perfect_switch_ptr->addInPort(in);
71}
72
73void
74Switch::addOutPort(const vector<MessageBuffer*>& out,
75    const NetDest& routing_table_entry, int link_latency, int bw_multiplier)
76{
77    // Create a throttle
78    Throttle* throttle_ptr = new Throttle(m_id, m_throttles.size(),
79        link_latency, bw_multiplier, m_network_ptr->getEndpointBandwidth(),
80        this);
81    m_throttles.push_back(throttle_ptr);
82
83    // Create one buffer per vnet (these are intermediaryQueues)
84    vector<MessageBuffer*> intermediateBuffers;
85    for (int i = 0; i < out.size(); i++) {
86        MessageBuffer* buffer_ptr = new MessageBuffer;
87        // Make these queues ordered
88        buffer_ptr->setOrdering(true);
89        if (m_network_ptr->getBufferSize() > 0) {
90            buffer_ptr->resize(m_network_ptr->getBufferSize());
91        }
92        intermediateBuffers.push_back(buffer_ptr);
93        m_buffers_to_free.push_back(buffer_ptr);
94    }
95
96    // Hook the queues to the PerfectSwitch
97    m_perfect_switch_ptr->addOutPort(intermediateBuffers, routing_table_entry);
98
99    // Hook the queues to the Throttle
100    throttle_ptr->addLinks(intermediateBuffers, out);
101}
102
103void
104Switch::clearRoutingTables()
105{
106    m_perfect_switch_ptr->clearRoutingTables();
107}
108
109void
110Switch::clearBuffers()
111{
112    m_perfect_switch_ptr->clearBuffers();
113    for (int i = 0; i < m_throttles.size(); i++) {
114        if (m_throttles[i] != NULL) {
115            m_throttles[i]->clear();
116        }
117    }
118}
119
120void
121Switch::reconfigureOutPort(const NetDest& routing_table_entry)
122{
123    m_perfect_switch_ptr->reconfigureOutPort(routing_table_entry);
124}
125
126const Throttle*
127Switch::getThrottle(LinkID link_number) const
128{
129    assert(m_throttles[link_number] != NULL);
130    return m_throttles[link_number];
131}
132
133const vector<Throttle*>*
134Switch::getThrottles() const
135{
136    return &m_throttles;
137}
138
139void
140Switch::printStats(std::ostream& out) const
141{
142    ccprintf(out, "switch_%d_inlinks: %d\n", m_id,
143        m_perfect_switch_ptr->getInLinks());
144    ccprintf(out, "switch_%d_outlinks: %d\n", m_id,
145        m_perfect_switch_ptr->getOutLinks());
146
147    // Average link utilizations
148    double average_utilization = 0.0;
149    int throttle_count = 0;
150
151    for (int i = 0; i < m_throttles.size(); i++) {
152        Throttle* throttle_ptr = m_throttles[i];
153        if (throttle_ptr) {
154            average_utilization += throttle_ptr->getUtilization();
155            throttle_count++;
156        }
157    }
158    average_utilization =
159        throttle_count == 0 ? 0 : average_utilization / throttle_count;
160
161    // Individual link utilizations
162    out << "links_utilized_percent_switch_" << m_id << ": "
163        << average_utilization << endl;
164
165    for (int link = 0; link < m_throttles.size(); link++) {
166        Throttle* throttle_ptr = m_throttles[link];
167        if (throttle_ptr != NULL) {
168            out << "  links_utilized_percent_switch_" << m_id
169                << "_link_" << link << ": "
170                << throttle_ptr->getUtilization() << " bw: "
171                << throttle_ptr->getLinkBandwidth()
172                << " base_latency: " << throttle_ptr->getLatency() << endl;
173        }
174    }
175    out << endl;
176
177    // Traffic breakdown
178    for (int link = 0; link < m_throttles.size(); link++) {
179        Throttle* throttle_ptr = m_throttles[link];
180        if (!throttle_ptr)
181            continue;
182
183        const vector<vector<int> >& message_counts =
184            throttle_ptr->getCounters();
185        for (int int_type = 0; int_type < MessageSizeType_NUM; int_type++) {
186            MessageSizeType type = MessageSizeType(int_type);
187            const vector<int> &mct = message_counts[type];
188            int sum = accumulate(mct.begin(), mct.end(), 0);
189            if (sum == 0)
190                continue;
191
192            out << "  outgoing_messages_switch_" << m_id
193                << "_link_" << link << "_" << type << ": " << sum << " "
194                << sum * m_network_ptr->MessageSizeType_to_int(type)
195                << " ";
196            out << mct;
197            out << " base_latency: "
198                << throttle_ptr->getLatency() << endl;
199        }
200    }
201    out << endl;
202}
203
204void
205Switch::clearStats()
206{
207    m_perfect_switch_ptr->clearStats();
208    for (int i = 0; i < m_throttles.size(); i++) {
209        if (m_throttles[i] != NULL)
210            m_throttles[i]->clearStats();
211    }
212}
213
214void
215Switch::print(std::ostream& out) const
216{
217    // FIXME printing
218    out << "[Switch]";
219}
220bool
221Switch::functionalRead(Packet *pkt)
222{
223    // Access the buffers in the switch for performing a functional read
224    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
225        if (m_buffers_to_free[i]->functionalRead(pkt)) {
226            return true;
227        }
228    }
229    return false;
230}
231
232uint32_t
233Switch::functionalWrite(Packet *pkt)
234{
235    // Access the buffers in the switch for performing a functional write
236    uint32_t num_functional_writes = 0;
237    for (unsigned int i = 0; i < m_buffers_to_free.size(); ++i) {
238        num_functional_writes += m_buffers_to_free[i]->functionalWrite(pkt);
239    }
240    return num_functional_writes;
241}
242
243Switch *
244SwitchParams::create()
245{
246    return new Switch(this);
247}
248