Throttle.hh revision 9866
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 296145Snate@binkert.org/* 307054Snate@binkert.org * The class to implement bandwidth and latency throttle. An instance 317054Snate@binkert.org * of consumer class that can be woke up. It is only used to control 327054Snate@binkert.org * bandwidth at output port of a switch. And the throttle is added 337054Snate@binkert.org * *after* the output port, means the message is put in the output 347054Snate@binkert.org * port of the PerfectSwitch (a intermediateBuffers) first, then go 357054Snate@binkert.org * through the Throttle. 366145Snate@binkert.org */ 376145Snate@binkert.org 387054Snate@binkert.org#ifndef __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 397054Snate@binkert.org#define __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 406145Snate@binkert.org 417055Snate@binkert.org#include <iostream> 428229Snate@binkert.org#include <string> 437454Snate@binkert.org#include <vector> 447055Snate@binkert.org 456154Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 467054Snate@binkert.org#include "mem/ruby/common/Global.hh" 477054Snate@binkert.org#include "mem/ruby/network/Network.hh" 486285Snate@binkert.org#include "mem/ruby/system/System.hh" 496145Snate@binkert.org 506145Snate@binkert.orgclass MessageBuffer; 516145Snate@binkert.org 527054Snate@binkert.orgclass Throttle : public Consumer 537054Snate@binkert.org{ 547054Snate@binkert.org public: 559499Snilay@cs.wisc.edu Throttle(int sID, NodeID node, Cycles link_latency, 569230Snilay@cs.wisc.edu int link_bandwidth_multiplier, int endpoint_bandwidth, 579465Snilay@cs.wisc.edu ClockedObject *em); 589499Snilay@cs.wisc.edu Throttle(NodeID node, Cycles link_latency, int link_bandwidth_multiplier, 599465Snilay@cs.wisc.edu int endpoint_bandwidth, ClockedObject *em); 607054Snate@binkert.org ~Throttle() {} 616145Snate@binkert.org 628054Sksewell@umich.edu std::string name() 638054Sksewell@umich.edu { return csprintf("Throttle-%i", m_sID); } 648054Sksewell@umich.edu 657454Snate@binkert.org void addLinks(const std::vector<MessageBuffer*>& in_vec, 669863Snilay@cs.wisc.edu const std::vector<MessageBuffer*>& out_vec); 677054Snate@binkert.org void wakeup(); 686145Snate@binkert.org 699863Snilay@cs.wisc.edu // The average utilization (a fraction) since last clearStats() 709863Snilay@cs.wisc.edu const Stats::Scalar & getUtilization() const 719863Snilay@cs.wisc.edu { return m_link_utilization; } 729863Snilay@cs.wisc.edu const Stats::Vector & getMsgCount(unsigned int type) const 739863Snilay@cs.wisc.edu { return m_msg_counts[type]; } 749863Snilay@cs.wisc.edu 759499Snilay@cs.wisc.edu int getLinkBandwidth() const 769499Snilay@cs.wisc.edu { return m_endpoint_bandwidth * m_link_bandwidth_multiplier; } 776145Snate@binkert.org 789499Snilay@cs.wisc.edu Cycles getLatency() const { return m_link_latency; } 796145Snate@binkert.org 809863Snilay@cs.wisc.edu void clearStats(); 819863Snilay@cs.wisc.edu void collateStats(); 829863Snilay@cs.wisc.edu void regStats(std::string name); 837055Snate@binkert.org void print(std::ostream& out) const; 846145Snate@binkert.org 857054Snate@binkert.org private: 869499Snilay@cs.wisc.edu void init(NodeID node, Cycles link_latency, int link_bandwidth_multiplier, 878259SBrad.Beckmann@amd.com int endpoint_bandwidth); 889508Snilay@cs.wisc.edu void addVirtualNetwork(MessageBuffer* in_ptr, MessageBuffer* out_ptr); 896145Snate@binkert.org 907054Snate@binkert.org // Private copy constructor and assignment operator 917054Snate@binkert.org Throttle(const Throttle& obj); 927054Snate@binkert.org Throttle& operator=(const Throttle& obj); 936145Snate@binkert.org 947454Snate@binkert.org std::vector<MessageBuffer*> m_in; 957454Snate@binkert.org std::vector<MessageBuffer*> m_out; 969863Snilay@cs.wisc.edu unsigned int m_vnets; 977454Snate@binkert.org std::vector<int> m_units_remaining; 987054Snate@binkert.org int m_sID; 997054Snate@binkert.org NodeID m_node; 1007054Snate@binkert.org int m_link_bandwidth_multiplier; 1019499Snilay@cs.wisc.edu Cycles m_link_latency; 1027054Snate@binkert.org int m_wakeups_wo_switch; 1038259SBrad.Beckmann@amd.com int m_endpoint_bandwidth; 1046145Snate@binkert.org 1059863Snilay@cs.wisc.edu // Statistical variables 1069863Snilay@cs.wisc.edu Stats::Scalar m_link_utilization; 1079866Sjthestness@gmail.com Stats::Vector m_msg_counts[MessageSizeType_NUM]; 1089866Sjthestness@gmail.com Stats::Formula m_msg_bytes[MessageSizeType_NUM]; 1099863Snilay@cs.wisc.edu 1109863Snilay@cs.wisc.edu double m_link_utilization_proxy; 1116145Snate@binkert.org}; 1126145Snate@binkert.org 1137055Snate@binkert.orginline std::ostream& 1147055Snate@binkert.orgoperator<<(std::ostream& out, const Throttle& obj) 1156145Snate@binkert.org{ 1167054Snate@binkert.org obj.print(out); 1177055Snate@binkert.org out << std::flush; 1187054Snate@binkert.org return out; 1196145Snate@binkert.org} 1206145Snate@binkert.org 1217054Snate@binkert.org#endif // __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 122