Switch.hh revision 7002
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 actual modelled switch. It use the perfect switch and a 346145Snate@binkert.org * Throttle object to control and bandwidth and timing *only for 356145Snate@binkert.org * the output port*. So here we have un-realistic modelling, 366145Snate@binkert.org * since the order of PerfectSwitch and Throttle objects get 376145Snate@binkert.org * woke up affect the message timing. A more accurate model would 386145Snate@binkert.org * be having two set of system states, one for this cycle, one for 396145Snate@binkert.org * next cycle. And on the cycle boundary swap the two set of 406145Snate@binkert.org * states. 416145Snate@binkert.org * 426145Snate@binkert.org */ 436145Snate@binkert.org 446145Snate@binkert.org#ifndef Switch_H 456145Snate@binkert.org#define Switch_H 466145Snate@binkert.org 477002Snate@binkert.org#include <iostream> 487002Snate@binkert.org 496154Snate@binkert.org#include "mem/ruby/common/Global.hh" 506154Snate@binkert.org#include "mem/gems_common/Vector.hh" 516145Snate@binkert.org 526145Snate@binkert.orgclass MessageBuffer; 536145Snate@binkert.orgclass PerfectSwitch; 546145Snate@binkert.orgclass NetDest; 556145Snate@binkert.orgclass SimpleNetwork; 566145Snate@binkert.orgclass Throttle; 576285Snate@binkert.orgclass Network; 586145Snate@binkert.org 596145Snate@binkert.orgclass Switch { 606145Snate@binkert.orgpublic: 616145Snate@binkert.org // Constructors 626145Snate@binkert.org 636145Snate@binkert.org // constructor specifying the number of ports 646145Snate@binkert.org Switch(SwitchID sid, SimpleNetwork* network_ptr); 656145Snate@binkert.org void addInPort(const Vector<MessageBuffer*>& in); 666145Snate@binkert.org void addOutPort(const Vector<MessageBuffer*>& out, const NetDest& routing_table_entry, int link_latency, int bw_multiplier); 676145Snate@binkert.org const Throttle* getThrottle(LinkID link_number) const; 686145Snate@binkert.org const Vector<Throttle*>* getThrottles() const; 696145Snate@binkert.org void clearRoutingTables(); 706145Snate@binkert.org void clearBuffers(); 716145Snate@binkert.org void reconfigureOutPort(const NetDest& routing_table_entry); 726145Snate@binkert.org 737002Snate@binkert.org void printStats(std::ostream& out) const; 746145Snate@binkert.org void clearStats(); 757002Snate@binkert.org void printConfig(std::ostream& out) const; 766145Snate@binkert.org 776145Snate@binkert.org // Destructor 786145Snate@binkert.org ~Switch(); 796145Snate@binkert.org 807002Snate@binkert.org void print(std::ostream& out) const; 816145Snate@binkert.orgprivate: 826145Snate@binkert.org 836145Snate@binkert.org // Private copy constructor and assignment operator 846145Snate@binkert.org Switch(const Switch& obj); 856145Snate@binkert.org Switch& operator=(const Switch& obj); 866145Snate@binkert.org 876145Snate@binkert.org // Data Members (m_ prefix) 886145Snate@binkert.org PerfectSwitch* m_perfect_switch_ptr; 896285Snate@binkert.org Network* m_network_ptr; 906145Snate@binkert.org Vector<Throttle*> m_throttles; 916145Snate@binkert.org Vector<MessageBuffer*> m_buffers_to_free; 926145Snate@binkert.org SwitchID m_switch_id; 936145Snate@binkert.org}; 946145Snate@binkert.org 956145Snate@binkert.org// Output operator declaration 967002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const Switch& obj); 976145Snate@binkert.org 986145Snate@binkert.org// ******************* Definitions ******************* 996145Snate@binkert.org 1006145Snate@binkert.org// Output operator definition 1016145Snate@binkert.orgextern inline 1027002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const Switch& obj) 1036145Snate@binkert.org{ 1046145Snate@binkert.org obj.print(out); 1057002Snate@binkert.org out << std::flush; 1066145Snate@binkert.org return out; 1076145Snate@binkert.org} 1086145Snate@binkert.org 1096145Snate@binkert.org#endif //Switch_H 110