Throttle.hh revision 6154
16145Snate@binkert.org 26145Snate@binkert.org/* 36145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 46145Snate@binkert.org * All rights reserved. 56145Snate@binkert.org * 66145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 76145Snate@binkert.org * modification, are permitted provided that the following conditions are 86145Snate@binkert.org * met: redistributions of source code must retain the above copyright 96145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 106145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 116145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 126145Snate@binkert.org * documentation and/or other materials provided with the distribution; 136145Snate@binkert.org * neither the name of the copyright holders nor the names of its 146145Snate@binkert.org * contributors may be used to endorse or promote products derived from 156145Snate@binkert.org * this software without specific prior written permission. 166145Snate@binkert.org * 176145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 186145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 196145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 206145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 216145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 226145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 236145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 246145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 256145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 266145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 276145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 286145Snate@binkert.org */ 296145Snate@binkert.org 306145Snate@binkert.org/* 316145Snate@binkert.org * $Id$ 326145Snate@binkert.org * 336145Snate@binkert.org * Description: The class to implement bandwidth and latency throttle. An 346145Snate@binkert.org * instance of consumer class that can be woke up. It is only used 356145Snate@binkert.org * to control bandwidth at output port of a switch. And the 366145Snate@binkert.org * throttle is added *after* the output port, means the message is 376145Snate@binkert.org * put in the output port of the PerfectSwitch (a 386145Snate@binkert.org * intermediateBuffers) first, then go through the Throttle. 396145Snate@binkert.org * 406145Snate@binkert.org */ 416145Snate@binkert.org 426145Snate@binkert.org#ifndef THROTTLE_H 436145Snate@binkert.org#define THROTTLE_H 446145Snate@binkert.org 456154Snate@binkert.org#include "mem/ruby/common/Global.hh" 466154Snate@binkert.org#include "mem/gems_common/Vector.hh" 476154Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 486154Snate@binkert.org#include "mem/ruby/system/NodeID.hh" 496154Snate@binkert.org#include "mem/ruby/config/RubyConfig.hh" 506145Snate@binkert.org 516145Snate@binkert.orgclass MessageBuffer; 526145Snate@binkert.org 536145Snate@binkert.orgclass Throttle : public Consumer { 546145Snate@binkert.orgpublic: 556145Snate@binkert.org // Constructors 566145Snate@binkert.org Throttle(int sID, NodeID node, int link_latency, int link_bandwidth_multiplier); 576145Snate@binkert.org Throttle(NodeID node, int link_latency, int link_bandwidth_multiplier); 586145Snate@binkert.org 596145Snate@binkert.org // Destructor 606145Snate@binkert.org ~Throttle() {} 616145Snate@binkert.org 626145Snate@binkert.org // Public Methods 636145Snate@binkert.org void addLinks(const Vector<MessageBuffer*>& in_vec, const Vector<MessageBuffer*>& out_vec); 646145Snate@binkert.org void wakeup(); 656145Snate@binkert.org bool broadcastBandwidthAvailable(int rand) const; 666145Snate@binkert.org 676145Snate@binkert.org void printStats(ostream& out) const; 686145Snate@binkert.org void clearStats(); 696145Snate@binkert.org void printConfig(ostream& out) const; 706145Snate@binkert.org double getUtilization() const; // The average utilization (a percent) since last clearStats() 716145Snate@binkert.org int getLinkBandwidth() const { return g_endpoint_bandwidth * m_link_bandwidth_multiplier; } 726145Snate@binkert.org int getLatency() const { return m_link_latency; } 736145Snate@binkert.org 746145Snate@binkert.org const Vector<Vector<int> >& getCounters() const { return m_message_counters; } 756145Snate@binkert.org 766145Snate@binkert.org void clear(); 776145Snate@binkert.org 786145Snate@binkert.org void print(ostream& out) const; 796145Snate@binkert.org 806145Snate@binkert.orgprivate: 816145Snate@binkert.org // Private Methods 826145Snate@binkert.org void init(NodeID node, int link_latency, int link_bandwidth_multiplier); 836145Snate@binkert.org void addVirtualNetwork(MessageBuffer* in_ptr, MessageBuffer* out_ptr); 846145Snate@binkert.org void linkUtilized(double ratio) { m_links_utilized += ratio; } 856145Snate@binkert.org 866145Snate@binkert.org // Private copy constructor and assignment operator 876145Snate@binkert.org Throttle(const Throttle& obj); 886145Snate@binkert.org Throttle& operator=(const Throttle& obj); 896145Snate@binkert.org 906145Snate@binkert.org // Data Members (m_ prefix) 916145Snate@binkert.org Vector<MessageBuffer*> m_in; 926145Snate@binkert.org Vector<MessageBuffer*> m_out; 936145Snate@binkert.org Vector<Vector<int> > m_message_counters; 946145Snate@binkert.org int m_vnets; 956145Snate@binkert.org Vector<int> m_units_remaining; 966145Snate@binkert.org int m_sID; 976145Snate@binkert.org NodeID m_node; 986145Snate@binkert.org int m_bash_counter; 996145Snate@binkert.org int m_bandwidth_since_sample; 1006145Snate@binkert.org Time m_last_bandwidth_sample; 1016145Snate@binkert.org int m_link_bandwidth_multiplier; 1026145Snate@binkert.org int m_link_latency; 1036145Snate@binkert.org int m_wakeups_wo_switch; 1046145Snate@binkert.org 1056145Snate@binkert.org // For tracking utilization 1066145Snate@binkert.org Time m_ruby_start; 1076145Snate@binkert.org double m_links_utilized; 1086145Snate@binkert.org}; 1096145Snate@binkert.org 1106145Snate@binkert.org// Output operator declaration 1116145Snate@binkert.orgostream& operator<<(ostream& out, const Throttle& obj); 1126145Snate@binkert.org 1136145Snate@binkert.org// ******************* Definitions ******************* 1146145Snate@binkert.org 1156145Snate@binkert.org// Output operator definition 1166145Snate@binkert.orgextern inline 1176145Snate@binkert.orgostream& operator<<(ostream& out, const Throttle& obj) 1186145Snate@binkert.org{ 1196145Snate@binkert.org obj.print(out); 1206145Snate@binkert.org out << flush; 1216145Snate@binkert.org return out; 1226145Snate@binkert.org} 1236145Snate@binkert.org 1246145Snate@binkert.org#endif //THROTTLE_H 125