Throttle.hh revision 9508:dde110931867
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/System.hh" 49 50class MessageBuffer; 51 52class Throttle : public Consumer 53{ 54 public: 55 Throttle(int sID, NodeID node, Cycles link_latency, 56 int link_bandwidth_multiplier, int endpoint_bandwidth, 57 ClockedObject *em); 58 Throttle(NodeID node, Cycles link_latency, int link_bandwidth_multiplier, 59 int endpoint_bandwidth, ClockedObject *em); 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 // The average utilization (a percent) since last clearStats() 72 double getUtilization() const; 73 int getLinkBandwidth() const 74 { return m_endpoint_bandwidth * m_link_bandwidth_multiplier; } 75 76 Cycles getLatency() const { return m_link_latency; } 77 const std::vector<std::vector<int> >& 78 getCounters() const 79 { 80 return m_message_counters; 81 } 82 83 void clear(); 84 85 void print(std::ostream& out) const; 86 87 private: 88 void init(NodeID node, Cycles link_latency, int link_bandwidth_multiplier, 89 int endpoint_bandwidth); 90 void addVirtualNetwork(MessageBuffer* in_ptr, MessageBuffer* out_ptr); 91 void linkUtilized(double ratio) { m_links_utilized += ratio; } 92 93 // Private copy constructor and assignment operator 94 Throttle(const Throttle& obj); 95 Throttle& operator=(const Throttle& obj); 96 97 std::vector<MessageBuffer*> m_in; 98 std::vector<MessageBuffer*> m_out; 99 std::vector<std::vector<int> > m_message_counters; 100 int m_vnets; 101 std::vector<int> m_units_remaining; 102 int m_sID; 103 NodeID m_node; 104 int m_link_bandwidth_multiplier; 105 Cycles m_link_latency; 106 int m_wakeups_wo_switch; 107 int m_endpoint_bandwidth; 108 109 // For tracking utilization 110 Cycles m_ruby_start; 111 double m_links_utilized; 112}; 113 114inline std::ostream& 115operator<<(std::ostream& out, const Throttle& obj) 116{ 117 obj.print(out); 118 out << std::flush; 119 return out; 120} 121 122#endif // __MEM_RUBY_NETWORK_SIMPLE_THROTTLE_HH__ 123