Network.hh revision 9497
16145Snate@binkert.org/* 26145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 36145Snate@binkert.org * All rights reserved. 46145Snate@binkert.org * 56145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 66145Snate@binkert.org * modification, are permitted provided that the following conditions are 76145Snate@binkert.org * met: redistributions of source code must retain the above copyright 86145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 96145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 106145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 116145Snate@binkert.org * documentation and/or other materials provided with the distribution; 126145Snate@binkert.org * neither the name of the copyright holders nor the names of its 136145Snate@binkert.org * contributors may be used to endorse or promote products derived from 146145Snate@binkert.org * this software without specific prior written permission. 156145Snate@binkert.org * 166145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276145Snate@binkert.org */ 286145Snate@binkert.org 296145Snate@binkert.org/* 307054Snate@binkert.org * The Network class is the base class for classes that implement the 317054Snate@binkert.org * interconnection network between components (processor/cache 327054Snate@binkert.org * components and memory/directory components). The interconnection 337054Snate@binkert.org * network as described here is not a physical network, but a 347054Snate@binkert.org * programming concept used to implement all communication between 357054Snate@binkert.org * components. Thus parts of this 'network' will model the on-chip 367054Snate@binkert.org * connections between cache controllers and directory controllers as 377054Snate@binkert.org * well as the links between chip and network switches. 387054Snate@binkert.org */ 396145Snate@binkert.org 407054Snate@binkert.org#ifndef __MEM_RUBY_NETWORK_NETWORK_HH__ 417054Snate@binkert.org#define __MEM_RUBY_NETWORK_NETWORK_HH__ 426145Snate@binkert.org 437055Snate@binkert.org#include <iostream> 447055Snate@binkert.org#include <string> 457454Snate@binkert.org#include <vector> 467055Snate@binkert.org 479302Snilay@cs.wisc.edu#include "mem/packet.hh" 488257SBrad.Beckmann@amd.com#include "mem/protocol/LinkDirection.hh" 497054Snate@binkert.org#include "mem/protocol/MessageSizeType.hh" 508645Snilay@cs.wisc.edu#include "mem/ruby/common/TypeDefines.hh" 517054Snate@binkert.org#include "params/RubyNetwork.hh" 529465Snilay@cs.wisc.edu#include "sim/clocked_object.hh" 536145Snate@binkert.org 546145Snate@binkert.orgclass NetDest; 556145Snate@binkert.orgclass MessageBuffer; 566145Snate@binkert.orgclass Throttle; 576285Snate@binkert.orgclass Topology; 586145Snate@binkert.org 599465Snilay@cs.wisc.educlass Network : public ClockedObject 607054Snate@binkert.org{ 617054Snate@binkert.org public: 626876Ssteve.reinhardt@amd.com typedef RubyNetworkParams Params; 636876Ssteve.reinhardt@amd.com Network(const Params *p); 647054Snate@binkert.org virtual ~Network() {} 656145Snate@binkert.org 667054Snate@binkert.org virtual void init(); 676145Snate@binkert.org 689497Snilay@cs.wisc.edu static uint32_t getNumberOfVirtualNetworks() { return m_virtual_networks; } 699275Snilay@cs.wisc.edu static uint32_t MessageSizeType_to_int(MessageSizeType size_type); 706493STushar.Krishna@amd.com 717054Snate@binkert.org // returns the queue requested for the given component 727054Snate@binkert.org virtual MessageBuffer* getToNetQueue(NodeID id, bool ordered, 738308Stushar@csail.mit.edu int netNumber, std::string vnet_type) = 0; 747054Snate@binkert.org virtual MessageBuffer* getFromNetQueue(NodeID id, bool ordered, 758308Stushar@csail.mit.edu int netNumber, std::string vnet_type) = 0; 767454Snate@binkert.org virtual const std::vector<Throttle*>* getThrottles(NodeID id) const; 777054Snate@binkert.org virtual int getNumNodes() {return 1;} 786145Snate@binkert.org 798257SBrad.Beckmann@amd.com virtual void makeOutLink(SwitchID src, NodeID dest, BasicLink* link, 808257SBrad.Beckmann@amd.com LinkDirection direction, 818257SBrad.Beckmann@amd.com const NetDest& routing_table_entry, 828257SBrad.Beckmann@amd.com bool isReconfiguration) = 0; 838257SBrad.Beckmann@amd.com virtual void makeInLink(NodeID src, SwitchID dest, BasicLink* link, 848257SBrad.Beckmann@amd.com LinkDirection direction, 859302Snilay@cs.wisc.edu const NetDest& routing_table_entry, 868257SBrad.Beckmann@amd.com bool isReconfiguration) = 0; 878257SBrad.Beckmann@amd.com virtual void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link, 888257SBrad.Beckmann@amd.com LinkDirection direction, 898257SBrad.Beckmann@amd.com const NetDest& routing_table_entry, 908257SBrad.Beckmann@amd.com bool isReconfiguration) = 0; 916145Snate@binkert.org 927054Snate@binkert.org virtual void reset() = 0; 936145Snate@binkert.org 947055Snate@binkert.org virtual void printStats(std::ostream& out) const = 0; 957054Snate@binkert.org virtual void clearStats() = 0; 967055Snate@binkert.org virtual void print(std::ostream& out) const = 0; 976145Snate@binkert.org 989302Snilay@cs.wisc.edu /* 999302Snilay@cs.wisc.edu * Virtual functions for functionally reading and writing packets in 1009302Snilay@cs.wisc.edu * the network. Each network needs to implement these for functional 1019302Snilay@cs.wisc.edu * accesses to work correctly. 1029302Snilay@cs.wisc.edu */ 1039302Snilay@cs.wisc.edu virtual bool functionalRead(Packet *pkt) 1049302Snilay@cs.wisc.edu { fatal("Functional read not implemented.\n"); } 1059302Snilay@cs.wisc.edu virtual uint32_t functionalWrite(Packet *pkt) 1069302Snilay@cs.wisc.edu { fatal("Functional write not implemented.\n"); } 1079302Snilay@cs.wisc.edu 1087054Snate@binkert.org protected: 1097054Snate@binkert.org // Private copy constructor and assignment operator 1107054Snate@binkert.org Network(const Network& obj); 1117054Snate@binkert.org Network& operator=(const Network& obj); 1126145Snate@binkert.org 1137054Snate@binkert.org protected: 1147055Snate@binkert.org const std::string m_name; 1157054Snate@binkert.org int m_nodes; 1169275Snilay@cs.wisc.edu static uint32_t m_virtual_networks; 1177054Snate@binkert.org Topology* m_topology_ptr; 1189275Snilay@cs.wisc.edu static uint32_t m_control_msg_size; 1199275Snilay@cs.wisc.edu static uint32_t m_data_msg_size; 1206145Snate@binkert.org}; 1216145Snate@binkert.org 1227055Snate@binkert.orginline std::ostream& 1237055Snate@binkert.orgoperator<<(std::ostream& out, const Network& obj) 1246145Snate@binkert.org{ 1257054Snate@binkert.org obj.print(out); 1267055Snate@binkert.org out << std::flush; 1277054Snate@binkert.org return out; 1286145Snate@binkert.org} 1296145Snate@binkert.org 1307054Snate@binkert.org#endif // __MEM_RUBY_NETWORK_NETWORK_HH__ 131