gem5/src/mem/ruby/network/simple/SimpleNetwork.hh

158 lines
6 KiB
C++
Raw Normal View History

/*
* Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* SimpleNetwork.hh
*
* Description: The SimpleNetwork class implements the interconnection
* SimpleNetwork between components (processor/cache components and
* memory/directory components). The interconnection network as
* described here is not a physical network, but a programming concept
* used to implement all communication between components. Thus parts
* of this 'network' may model the on-chip connections between cache
* controllers and directory controllers as well as the links between
* chip and network switches.
*
* Two conceptual networks, an address and data network, are modeled.
* The data network is unordered, where the address network provides
* and conforms to a global ordering of all transactions.
*
* Currently the data network is point-to-point and the address
* network is a broadcast network. These two distinct conceptual
* network can be modeled as physically separate networks or
* multiplexed over a single physical network.
*
* The network encapsulates all notion of virtual global time and is
* responsible for ordering the network transactions received. This
* hides all of these ordering details from the processor/cache and
* directory/memory modules.
*
* FIXME: Various flavor of networks are provided as a compiler time
* configurable. We currently include this SimpleNetwork in the
* makefile's vpath, so that SimpleNetwork.cc can provide an alternative
* version constructor for the abstract Network class. It is easy to
* modify this to make network a runtime configuable. Just make the
* abstract Network class take a enumeration parameter, and based on
* that to initial proper network. Or even better, just make the ruby
* system initializer choose the proper network to initiate.
*
* $Id$
*
*/
#ifndef SIMPLENETWORK_H
#define SIMPLENETWORK_H
#include "mem/ruby/common/Global.hh"
#include "mem/gems_common/Vector.hh"
#include "mem/ruby/network/Network.hh"
#include "mem/ruby/system/NodeID.hh"
class NetDest;
class MessageBuffer;
class Throttle;
class Switch;
class Topology;
class SimpleNetwork : public Network {
public:
// Constructors
// SimpleNetwork(int nodes);
SimpleNetwork(const string & name);
// Destructor
~SimpleNetwork();
void init(const vector<string> & argv);
// Public Methods
void printStats(ostream& out) const;
void clearStats();
void printConfig(ostream& out) const;
void reset();
// returns the queue requested for the given component
MessageBuffer* getToNetQueue(NodeID id, bool ordered, int network_num);
MessageBuffer* getFromNetQueue(NodeID id, bool ordered, int network_num);
virtual const Vector<Throttle*>* getThrottles(NodeID id) const;
bool isVNetOrdered(int vnet) { return m_ordered[vnet]; }
bool validVirtualNetwork(int vnet) { return m_in_use[vnet]; }
int getNumNodes() {return m_nodes; }
// Methods used by Topology to setup the network
void makeOutLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight, int bw_multiplier, bool isReconfiguration);
void makeInLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int bw_multiplier, bool isReconfiguration);
void makeInternalLink(SwitchID src, NodeID dest, const NetDest& routing_table_entry, int link_latency, int link_weight, int bw_multiplier, bool isReconfiguration);
void print(ostream& out) const;
private:
void checkNetworkAllocation(NodeID id, bool ordered, int network_num);
void addLink(SwitchID src, SwitchID dest, int link_latency);
void makeLink(SwitchID src, SwitchID dest, const NetDest& routing_table_entry, int link_latency);
SwitchID createSwitch();
void makeTopology();
void linkTopology();
// Private copy constructor and assignment operator
SimpleNetwork(const SimpleNetwork& obj);
SimpleNetwork& operator=(const SimpleNetwork& obj);
// Data Members (m_ prefix)
// vector of queues from the components
Vector<Vector<MessageBuffer*> > m_toNetQueues;
Vector<Vector<MessageBuffer*> > m_fromNetQueues;
Vector<bool> m_in_use;
Vector<bool> m_ordered;
Vector<Switch*> m_switch_ptr_vector;
Vector<MessageBuffer*> m_buffers_to_free;
Vector<Switch*> m_endpoint_switches;
};
// Output operator declaration
ostream& operator<<(ostream& out, const SimpleNetwork& obj);
// ******************* Definitions *******************
// Output operator definition
extern inline
ostream& operator<<(ostream& out, const SimpleNetwork& obj)
{
obj.print(out);
out << flush;
return out;
}
#endif //SIMPLENETWORK_H