Throttle.hh revision 8259:36987780169e
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/* 30 * The class to implement bandwidth and latency throttle. An instance 31 * of consumer class that can be woke up. It is only used to control 32 * bandwidth at output port of a switch. And the throttle is added 33 * *after* the output port, means the message is put in the output 34 * port of the PerfectSwitch (a intermediateBuffers) first, then go 35 * through the Throttle. 36 */ 37 38#ifndef __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 39#define __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 40 41#include <iostream> 42#include <string> 43#include <vector> 44 45#include "mem/ruby/common/Consumer.hh" 46#include "mem/ruby/common/Global.hh" 47#include "mem/ruby/network/Network.hh" 48#include "mem/ruby/system/NodeID.hh" 49#include "mem/ruby/system/System.hh" 50 51class MessageBuffer; 52 53class Throttle : public Consumer 54{ 55 public: 56 Throttle(int sID, NodeID node, int link_latency, 57 int link_bandwidth_multiplier, int endpoint_bandwidth); 58 Throttle(NodeID node, int link_latency, int link_bandwidth_multiplier, 59 int endpoint_bandwidth); 60 ~Throttle() {} 61 62 std::string name() 63 { return csprintf("Throttle-%i", m_sID); } 64 65 void addLinks(const std::vector<MessageBuffer*>& in_vec, 66 const std::vector<MessageBuffer*>& out_vec); 67 void wakeup(); 68 69 void printStats(std::ostream& out) const; 70 void clearStats(); 71 void printConfig(std::ostream& out) const; 72 // The average utilization (a percent) since last clearStats() 73 double getUtilization() const; 74 int 75 getLinkBandwidth() const 76 { 77 return m_endpoint_bandwidth * m_link_bandwidth_multiplier; 78 } 79 int getLatency() const { return m_link_latency; } 80 81 const std::vector<std::vector<int> >& 82 getCounters() const 83 { 84 return m_message_counters; 85 } 86 87 void clear(); 88 89 void print(std::ostream& out) const; 90 91 private: 92 void init(NodeID node, int link_latency, int link_bandwidth_multiplier, 93 int endpoint_bandwidth); 94 void addVirtualNetwork(MessageBuffer* in_ptr, MessageBuffer* out_ptr); 95 void linkUtilized(double ratio) { m_links_utilized += ratio; } 96 97 // Private copy constructor and assignment operator 98 Throttle(const Throttle& obj); 99 Throttle& operator=(const Throttle& obj); 100 101 std::vector<MessageBuffer*> m_in; 102 std::vector<MessageBuffer*> m_out; 103 std::vector<std::vector<int> > m_message_counters; 104 int m_vnets; 105 std::vector<int> m_units_remaining; 106 int m_sID; 107 NodeID m_node; 108 int m_link_bandwidth_multiplier; 109 int m_link_latency; 110 int m_wakeups_wo_switch; 111 int m_endpoint_bandwidth; 112 113 // For tracking utilization 114 Time m_ruby_start; 115 double m_links_utilized; 116}; 117 118inline std::ostream& 119operator<<(std::ostream& out, const Throttle& obj) 120{ 121 obj.print(out); 122 out << std::flush; 123 return out; 124} 125 126#endif // __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 127