Throttle.cc revision 9508
16145Snate@binkert.org/*
26145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
36145Snate@binkert.org * All rights reserved.
46145Snate@binkert.org *
56145Snate@binkert.org * Redistribution and use in source and binary forms, with or without
66145Snate@binkert.org * modification, are permitted provided that the following conditions are
76145Snate@binkert.org * met: redistributions of source code must retain the above copyright
86145Snate@binkert.org * notice, this list of conditions and the following disclaimer;
96145Snate@binkert.org * redistributions in binary form must reproduce the above copyright
106145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the
116145Snate@binkert.org * documentation and/or other materials provided with the distribution;
126145Snate@binkert.org * neither the name of the copyright holders nor the names of its
136145Snate@binkert.org * contributors may be used to endorse or promote products derived from
146145Snate@binkert.org * this software without specific prior written permission.
156145Snate@binkert.org *
166145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
176145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
186145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
196145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
206145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
216145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
226145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
236145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
246145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
256145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
266145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
276145Snate@binkert.org */
286145Snate@binkert.org
297832Snate@binkert.org#include <cassert>
307832Snate@binkert.org
318645Snilay@cs.wisc.edu#include "base/cast.hh"
327054Snate@binkert.org#include "base/cprintf.hh"
338232Snate@binkert.org#include "debug/RubyNetwork.hh"
346154Snate@binkert.org#include "mem/ruby/buffers/MessageBuffer.hh"
358229Snate@binkert.org#include "mem/ruby/network/simple/Throttle.hh"
366154Snate@binkert.org#include "mem/ruby/network/Network.hh"
377054Snate@binkert.org#include "mem/ruby/slicc_interface/NetworkMessage.hh"
386154Snate@binkert.org#include "mem/ruby/system/System.hh"
396145Snate@binkert.org
407055Snate@binkert.orgusing namespace std;
417055Snate@binkert.org
426145Snate@binkert.orgconst int HIGH_RANGE = 256;
436145Snate@binkert.orgconst int ADJUST_INTERVAL = 50000;
446145Snate@binkert.orgconst int MESSAGE_SIZE_MULTIPLIER = 1000;
456145Snate@binkert.org//const int BROADCAST_SCALING = 4; // Have a 16p system act like a 64p systems
466145Snate@binkert.orgconst int BROADCAST_SCALING = 1;
476145Snate@binkert.orgconst int PRIORITY_SWITCH_LIMIT = 128;
486145Snate@binkert.org
496145Snate@binkert.orgstatic int network_message_to_size(NetworkMessage* net_msg_ptr);
506145Snate@binkert.org
519499Snilay@cs.wisc.eduThrottle::Throttle(int sID, NodeID node, Cycles link_latency,
529230Snilay@cs.wisc.edu                   int link_bandwidth_multiplier, int endpoint_bandwidth,
539465Snilay@cs.wisc.edu                   ClockedObject *em)
549230Snilay@cs.wisc.edu    : Consumer(em)
556145Snate@binkert.org{
568259SBrad.Beckmann@amd.com    init(node, link_latency, link_bandwidth_multiplier, endpoint_bandwidth);
577054Snate@binkert.org    m_sID = sID;
586145Snate@binkert.org}
596145Snate@binkert.org
609499Snilay@cs.wisc.eduThrottle::Throttle(NodeID node, Cycles link_latency,
619230Snilay@cs.wisc.edu                   int link_bandwidth_multiplier, int endpoint_bandwidth,
629465Snilay@cs.wisc.edu                   ClockedObject *em)
639230Snilay@cs.wisc.edu    : Consumer(em)
646145Snate@binkert.org{
658259SBrad.Beckmann@amd.com    init(node, link_latency, link_bandwidth_multiplier, endpoint_bandwidth);
667054Snate@binkert.org    m_sID = 0;
676145Snate@binkert.org}
686145Snate@binkert.org
697054Snate@binkert.orgvoid
709499Snilay@cs.wisc.eduThrottle::init(NodeID node, Cycles link_latency,
719499Snilay@cs.wisc.edu               int link_bandwidth_multiplier, int endpoint_bandwidth)
726145Snate@binkert.org{
737054Snate@binkert.org    m_node = node;
747054Snate@binkert.org    m_vnets = 0;
756145Snate@binkert.org
767832Snate@binkert.org    assert(link_bandwidth_multiplier > 0);
777054Snate@binkert.org    m_link_bandwidth_multiplier = link_bandwidth_multiplier;
787054Snate@binkert.org    m_link_latency = link_latency;
798259SBrad.Beckmann@amd.com    m_endpoint_bandwidth = endpoint_bandwidth;
806145Snate@binkert.org
817054Snate@binkert.org    m_wakeups_wo_switch = 0;
827054Snate@binkert.org    clearStats();
836145Snate@binkert.org}
846145Snate@binkert.org
857054Snate@binkert.orgvoid
867054Snate@binkert.orgThrottle::clear()
876145Snate@binkert.org{
887054Snate@binkert.org    for (int counter = 0; counter < m_vnets; counter++) {
897054Snate@binkert.org        m_in[counter]->clear();
907054Snate@binkert.org        m_out[counter]->clear();
917054Snate@binkert.org    }
926145Snate@binkert.org}
936145Snate@binkert.org
947054Snate@binkert.orgvoid
957454Snate@binkert.orgThrottle::addLinks(const std::vector<MessageBuffer*>& in_vec,
969508Snilay@cs.wisc.edu    const std::vector<MessageBuffer*>& out_vec)
976145Snate@binkert.org{
987054Snate@binkert.org    assert(in_vec.size() == out_vec.size());
997054Snate@binkert.org    for (int i=0; i<in_vec.size(); i++) {
1009508Snilay@cs.wisc.edu        addVirtualNetwork(in_vec[i], out_vec[i]);
1017054Snate@binkert.org    }
1026145Snate@binkert.org
1037454Snate@binkert.org    m_message_counters.resize(MessageSizeType_NUM);
1047054Snate@binkert.org    for (int i = 0; i < MessageSizeType_NUM; i++) {
1057454Snate@binkert.org        m_message_counters[i].resize(in_vec.size());
1067054Snate@binkert.org        for (int j = 0; j<m_message_counters[i].size(); j++) {
1077054Snate@binkert.org            m_message_counters[i][j] = 0;
1087054Snate@binkert.org        }
1096145Snate@binkert.org    }
1106145Snate@binkert.org}
1116145Snate@binkert.org
1127054Snate@binkert.orgvoid
1139508Snilay@cs.wisc.eduThrottle::addVirtualNetwork(MessageBuffer* in_ptr, MessageBuffer* out_ptr)
1146145Snate@binkert.org{
1157454Snate@binkert.org    m_units_remaining.push_back(0);
1167454Snate@binkert.org    m_in.push_back(in_ptr);
1177454Snate@binkert.org    m_out.push_back(out_ptr);
1186145Snate@binkert.org
1197054Snate@binkert.org    // Set consumer and description
1207054Snate@binkert.org    m_in[m_vnets]->setConsumer(this);
1219465Snilay@cs.wisc.edu
1228608Snilay@cs.wisc.edu    string desc = "[Queue to Throttle " + to_string(m_sID) + " " +
1238608Snilay@cs.wisc.edu        to_string(m_node) + "]";
1247054Snate@binkert.org    m_in[m_vnets]->setDescription(desc);
1257054Snate@binkert.org    m_vnets++;
1266145Snate@binkert.org}
1276145Snate@binkert.org
1287054Snate@binkert.orgvoid
1297054Snate@binkert.orgThrottle::wakeup()
1306145Snate@binkert.org{
1317054Snate@binkert.org    // Limits the number of message sent to a limited number of bytes/cycle.
1327054Snate@binkert.org    assert(getLinkBandwidth() > 0);
1337054Snate@binkert.org    int bw_remaining = getLinkBandwidth();
1346145Snate@binkert.org
1357054Snate@binkert.org    // Give the highest numbered link priority most of the time
1367054Snate@binkert.org    m_wakeups_wo_switch++;
1377054Snate@binkert.org    int highest_prio_vnet = m_vnets-1;
1387054Snate@binkert.org    int lowest_prio_vnet = 0;
1397054Snate@binkert.org    int counter = 1;
1407054Snate@binkert.org    bool schedule_wakeup = false;
1416145Snate@binkert.org
1427054Snate@binkert.org    // invert priorities to avoid starvation seen in the component network
1437054Snate@binkert.org    if (m_wakeups_wo_switch > PRIORITY_SWITCH_LIMIT) {
1447054Snate@binkert.org        m_wakeups_wo_switch = 0;
1457054Snate@binkert.org        highest_prio_vnet = 0;
1467054Snate@binkert.org        lowest_prio_vnet = m_vnets-1;
1477054Snate@binkert.org        counter = -1;
1486145Snate@binkert.org    }
1496145Snate@binkert.org
1507054Snate@binkert.org    for (int vnet = highest_prio_vnet;
1517054Snate@binkert.org         (vnet * counter) >= (counter * lowest_prio_vnet);
1527054Snate@binkert.org         vnet -= counter) {
1537054Snate@binkert.org
1547054Snate@binkert.org        assert(m_out[vnet] != NULL);
1557054Snate@binkert.org        assert(m_in[vnet] != NULL);
1567054Snate@binkert.org        assert(m_units_remaining[vnet] >= 0);
1577054Snate@binkert.org
1587054Snate@binkert.org        while (bw_remaining > 0 &&
1597054Snate@binkert.org            (m_in[vnet]->isReady() || m_units_remaining[vnet] > 0) &&
1607054Snate@binkert.org            m_out[vnet]->areNSlotsAvailable(1)) {
1617054Snate@binkert.org
1627054Snate@binkert.org            // See if we are done transferring the previous message on
1637054Snate@binkert.org            // this virtual network
1647054Snate@binkert.org            if (m_units_remaining[vnet] == 0 && m_in[vnet]->isReady()) {
1657054Snate@binkert.org                // Find the size of the message we are moving
1667054Snate@binkert.org                MsgPtr msg_ptr = m_in[vnet]->peekMsgPtr();
1677054Snate@binkert.org                NetworkMessage* net_msg_ptr =
1687453Snate@binkert.org                    safe_cast<NetworkMessage*>(msg_ptr.get());
1697054Snate@binkert.org                m_units_remaining[vnet] +=
1707054Snate@binkert.org                    network_message_to_size(net_msg_ptr);
1717054Snate@binkert.org
1727780Snilay@cs.wisc.edu                DPRINTF(RubyNetwork, "throttle: %d my bw %d bw spent "
1737780Snilay@cs.wisc.edu                        "enqueueing net msg %d time: %lld.\n",
1747054Snate@binkert.org                        m_node, getLinkBandwidth(), m_units_remaining[vnet],
1759508Snilay@cs.wisc.edu                        g_system_ptr->curCycle());
1767054Snate@binkert.org
1777054Snate@binkert.org                // Move the message
1787054Snate@binkert.org                m_out[vnet]->enqueue(m_in[vnet]->peekMsgPtr(), m_link_latency);
1797054Snate@binkert.org                m_in[vnet]->pop();
1807054Snate@binkert.org
1817054Snate@binkert.org                // Count the message
1827054Snate@binkert.org                m_message_counters[net_msg_ptr->getMessageSize()][vnet]++;
1837054Snate@binkert.org
1847780Snilay@cs.wisc.edu                DPRINTF(RubyNetwork, "%s\n", *m_out[vnet]);
1857054Snate@binkert.org            }
1867054Snate@binkert.org
1877054Snate@binkert.org            // Calculate the amount of bandwidth we spent on this message
1887054Snate@binkert.org            int diff = m_units_remaining[vnet] - bw_remaining;
1897054Snate@binkert.org            m_units_remaining[vnet] = max(0, diff);
1907054Snate@binkert.org            bw_remaining = max(0, -diff);
1917054Snate@binkert.org        }
1927054Snate@binkert.org
1937054Snate@binkert.org        if (bw_remaining > 0 &&
1947054Snate@binkert.org            (m_in[vnet]->isReady() || m_units_remaining[vnet] > 0) &&
1957054Snate@binkert.org            !m_out[vnet]->areNSlotsAvailable(1)) {
1967780Snilay@cs.wisc.edu            DPRINTF(RubyNetwork, "vnet: %d", vnet);
1977054Snate@binkert.org            // schedule me to wakeup again because I'm waiting for my
1987054Snate@binkert.org            // output queue to become available
1997054Snate@binkert.org            schedule_wakeup = true;
2007054Snate@binkert.org        }
2016145Snate@binkert.org    }
2026145Snate@binkert.org
2037054Snate@binkert.org    // We should only wake up when we use the bandwidth
2047054Snate@binkert.org    // This is only mostly true
2057054Snate@binkert.org    // assert(bw_remaining != getLinkBandwidth());
2066145Snate@binkert.org
2077054Snate@binkert.org    // Record that we used some or all of the link bandwidth this cycle
2087054Snate@binkert.org    double ratio = 1.0 - (double(bw_remaining) / double(getLinkBandwidth()));
2096145Snate@binkert.org
2107054Snate@binkert.org    // If ratio = 0, we used no bandwidth, if ratio = 1, we used all
2117054Snate@binkert.org    linkUtilized(ratio);
2127054Snate@binkert.org
2137054Snate@binkert.org    if (bw_remaining > 0 && !schedule_wakeup) {
2147054Snate@binkert.org        // We have extra bandwidth and our output buffer was
2157054Snate@binkert.org        // available, so we must not have anything else to do until
2167054Snate@binkert.org        // another message arrives.
2177780Snilay@cs.wisc.edu        DPRINTF(RubyNetwork, "%s not scheduled again\n", *this);
2187054Snate@binkert.org    } else {
2197780Snilay@cs.wisc.edu        DPRINTF(RubyNetwork, "%s scheduled again\n", *this);
2207054Snate@binkert.org
2217054Snate@binkert.org        // We are out of bandwidth for this cycle, so wakeup next
2227054Snate@binkert.org        // cycle and continue
2239499Snilay@cs.wisc.edu        scheduleEvent(Cycles(1));
2247054Snate@binkert.org    }
2256145Snate@binkert.org}
2266145Snate@binkert.org
2277054Snate@binkert.orgvoid
2287054Snate@binkert.orgThrottle::printStats(ostream& out) const
2296145Snate@binkert.org{
2307054Snate@binkert.org    out << "utilized_percent: " << getUtilization() << endl;
2316145Snate@binkert.org}
2326145Snate@binkert.org
2337054Snate@binkert.orgvoid
2347054Snate@binkert.orgThrottle::clearStats()
2356145Snate@binkert.org{
2369508Snilay@cs.wisc.edu    m_ruby_start = g_system_ptr->curCycle();
2377054Snate@binkert.org    m_links_utilized = 0.0;
2386145Snate@binkert.org
2397054Snate@binkert.org    for (int i = 0; i < m_message_counters.size(); i++) {
2407054Snate@binkert.org        for (int j = 0; j < m_message_counters[i].size(); j++) {
2417054Snate@binkert.org            m_message_counters[i][j] = 0;
2427054Snate@binkert.org        }
2436145Snate@binkert.org    }
2446145Snate@binkert.org}
2456145Snate@binkert.org
2467054Snate@binkert.orgdouble
2477054Snate@binkert.orgThrottle::getUtilization() const
2486145Snate@binkert.org{
2497054Snate@binkert.org    return 100.0 * double(m_links_utilized) /
2509508Snilay@cs.wisc.edu        double(g_system_ptr->curCycle()-m_ruby_start);
2516145Snate@binkert.org}
2526145Snate@binkert.org
2537054Snate@binkert.orgvoid
2547054Snate@binkert.orgThrottle::print(ostream& out) const
2556145Snate@binkert.org{
2568054Sksewell@umich.edu    ccprintf(out,  "[%i bw: %i]", m_node, getLinkBandwidth());
2576145Snate@binkert.org}
2586145Snate@binkert.org
2597054Snate@binkert.orgint
2607054Snate@binkert.orgnetwork_message_to_size(NetworkMessage* net_msg_ptr)
2617054Snate@binkert.org{
2627054Snate@binkert.org    assert(net_msg_ptr != NULL);
2636145Snate@binkert.org
2649275Snilay@cs.wisc.edu    int size = Network::MessageSizeType_to_int(net_msg_ptr->getMessageSize());
2657054Snate@binkert.org    size *=  MESSAGE_SIZE_MULTIPLIER;
2666145Snate@binkert.org
2677054Snate@binkert.org    // Artificially increase the size of broadcast messages
2687054Snate@binkert.org    if (BROADCAST_SCALING > 1 && net_msg_ptr->getDestination().isBroadcast())
2697054Snate@binkert.org        size *= BROADCAST_SCALING;
2707054Snate@binkert.org
2717054Snate@binkert.org    return size;
2726145Snate@binkert.org}
273