SimpleNetwork.hh revision 6285
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/* 316284Snate@binkert.org * SimpleNetwork.hh 326145Snate@binkert.org * 336145Snate@binkert.org * Description: The SimpleNetwork class implements the interconnection 346145Snate@binkert.org * SimpleNetwork between components (processor/cache components and 356145Snate@binkert.org * memory/directory components). The interconnection network as 366145Snate@binkert.org * described here is not a physical network, but a programming concept 376145Snate@binkert.org * used to implement all communication between components. Thus parts 386145Snate@binkert.org * of this 'network' may model the on-chip connections between cache 396145Snate@binkert.org * controllers and directory controllers as well as the links between 406145Snate@binkert.org * chip and network switches. 416145Snate@binkert.org * 426145Snate@binkert.org * Two conceptual networks, an address and data network, are modeled. 436145Snate@binkert.org * The data network is unordered, where the address network provides 446145Snate@binkert.org * and conforms to a global ordering of all transactions. 456145Snate@binkert.org * 466145Snate@binkert.org * Currently the data network is point-to-point and the address 476145Snate@binkert.org * network is a broadcast network. These two distinct conceptual 486145Snate@binkert.org * network can be modeled as physically separate networks or 496145Snate@binkert.org * multiplexed over a single physical network. 506145Snate@binkert.org * 516145Snate@binkert.org * The network encapsulates all notion of virtual global time and is 526145Snate@binkert.org * responsible for ordering the network transactions received. This 536145Snate@binkert.org * hides all of these ordering details from the processor/cache and 546145Snate@binkert.org * directory/memory modules. 556145Snate@binkert.org * 566145Snate@binkert.org * FIXME: Various flavor of networks are provided as a compiler time 576145Snate@binkert.org * configurable. We currently include this SimpleNetwork in the 586284Snate@binkert.org * makefile's vpath, so that SimpleNetwork.cc can provide an alternative 596145Snate@binkert.org * version constructor for the abstract Network class. It is easy to 606145Snate@binkert.org * modify this to make network a runtime configuable. Just make the 616145Snate@binkert.org * abstract Network class take a enumeration parameter, and based on 626145Snate@binkert.org * that to initial proper network. Or even better, just make the ruby 636145Snate@binkert.org * system initializer choose the proper network to initiate. 646145Snate@binkert.org * 656145Snate@binkert.org * $Id$ 666145Snate@binkert.org * 676145Snate@binkert.org */ 686145Snate@binkert.org 696145Snate@binkert.org#ifndef SIMPLENETWORK_H 706145Snate@binkert.org#define SIMPLENETWORK_H 716145Snate@binkert.org 726154Snate@binkert.org#include "mem/ruby/common/Global.hh" 736154Snate@binkert.org#include "mem/gems_common/Vector.hh" 746154Snate@binkert.org#include "mem/ruby/network/Network.hh" 756154Snate@binkert.org#include "mem/ruby/system/NodeID.hh" 766145Snate@binkert.org 776145Snate@binkert.orgclass NetDest; 786145Snate@binkert.orgclass MessageBuffer; 796145Snate@binkert.orgclass Throttle; 806145Snate@binkert.orgclass Switch; 816145Snate@binkert.orgclass Topology; 826145Snate@binkert.org 836145Snate@binkert.orgclass SimpleNetwork : public Network { 846145Snate@binkert.orgpublic: 856145Snate@binkert.org // Constructors 866285Snate@binkert.org // SimpleNetwork(int nodes); 876285Snate@binkert.org SimpleNetwork(const string & name); 886145Snate@binkert.org 896145Snate@binkert.org // Destructor 906145Snate@binkert.org ~SimpleNetwork(); 916145Snate@binkert.org 926285Snate@binkert.org void init(const vector<string> & argv); 936285Snate@binkert.org 946145Snate@binkert.org // Public Methods 956145Snate@binkert.org void printStats(ostream& out) const; 966145Snate@binkert.org void clearStats(); 976145Snate@binkert.org void printConfig(ostream& out) const; 986145Snate@binkert.org 996145Snate@binkert.org void reset(); 1006145Snate@binkert.org 1016145Snate@binkert.org // returns the queue requested for the given component 1026145Snate@binkert.org MessageBuffer* getToNetQueue(NodeID id, bool ordered, int network_num); 1036145Snate@binkert.org MessageBuffer* getFromNetQueue(NodeID id, bool ordered, int network_num); 1046145Snate@binkert.org virtual const Vector<Throttle*>* getThrottles(NodeID id) const; 1056145Snate@binkert.org 1066145Snate@binkert.org bool isVNetOrdered(int vnet) { return m_ordered[vnet]; } 1076145Snate@binkert.org bool validVirtualNetwork(int vnet) { return m_in_use[vnet]; } 1086145Snate@binkert.org 1096145Snate@binkert.org int getNumNodes() {return m_nodes; } 1106145Snate@binkert.org 1116145Snate@binkert.org // Methods used by Topology to setup the network 1126145Snate@binkert.org void makeOutLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight, int bw_multiplier, bool isReconfiguration); 1136145Snate@binkert.org void makeInLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int bw_multiplier, bool isReconfiguration); 1146145Snate@binkert.org void makeInternalLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight, int bw_multiplier, bool isReconfiguration); 1156145Snate@binkert.org 1166145Snate@binkert.org void print(ostream& out) const; 1176145Snate@binkert.orgprivate: 1186145Snate@binkert.org void checkNetworkAllocation(NodeID id, bool ordered, int network_num); 1196145Snate@binkert.org void addLink(SwitchID src, SwitchID dest, int link_latency); 1206145Snate@binkert.org void makeLink(SwitchID src, SwitchID dest, const NetDest& routing_table_entry, int link_latency); 1216145Snate@binkert.org SwitchID createSwitch(); 1226145Snate@binkert.org void makeTopology(); 1236145Snate@binkert.org void linkTopology(); 1246145Snate@binkert.org 1256145Snate@binkert.org 1266145Snate@binkert.org // Private copy constructor and assignment operator 1276145Snate@binkert.org SimpleNetwork(const SimpleNetwork& obj); 1286145Snate@binkert.org SimpleNetwork& operator=(const SimpleNetwork& obj); 1296145Snate@binkert.org 1306145Snate@binkert.org // Data Members (m_ prefix) 1316145Snate@binkert.org 1326145Snate@binkert.org // vector of queues from the components 1336145Snate@binkert.org Vector<Vector<MessageBuffer*> > m_toNetQueues; 1346145Snate@binkert.org Vector<Vector<MessageBuffer*> > m_fromNetQueues; 1356145Snate@binkert.org 1366145Snate@binkert.org Vector<bool> m_in_use; 1376145Snate@binkert.org Vector<bool> m_ordered; 1386145Snate@binkert.org Vector<Switch*> m_switch_ptr_vector; 1396145Snate@binkert.org Vector<MessageBuffer*> m_buffers_to_free; 1406145Snate@binkert.org Vector<Switch*> m_endpoint_switches; 1416145Snate@binkert.org}; 1426145Snate@binkert.org 1436145Snate@binkert.org// Output operator declaration 1446145Snate@binkert.orgostream& operator<<(ostream& out, const SimpleNetwork& obj); 1456145Snate@binkert.org 1466145Snate@binkert.org// ******************* Definitions ******************* 1476145Snate@binkert.org 1486145Snate@binkert.org// Output operator definition 1496145Snate@binkert.orgextern inline 1506145Snate@binkert.orgostream& operator<<(ostream& out, const SimpleNetwork& obj) 1516145Snate@binkert.org{ 1526145Snate@binkert.org obj.print(out); 1536145Snate@binkert.org out << flush; 1546145Snate@binkert.org return out; 1556145Snate@binkert.org} 1566145Snate@binkert.org 1576145Snate@binkert.org#endif //SIMPLENETWORK_H 158