gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Network Class Referenceabstract

#include <Network.hh>

Inheritance diagram for Network:
ClockedObject SimObject Clocked EventManager Serializable Drainable GarnetNetwork SimpleNetwork

Classes

class  StatsCallback
 Callback class used for collating statistics from all the controller of this type. More...
 

Public Types

typedef RubyNetworkParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Network (const Params *p)
 
const Paramsparams () const
 
virtual ~Network ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
int getNumNodes () const
 
void setToNetQueue (NodeID id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void setFromNetQueue (NodeID id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void checkNetworkAllocation (NodeID id, bool ordered, int network_num, std::string vnet_type)
 
virtual void makeExtOutLink (SwitchID src, NodeID dest, BasicLink *link, const NetDest &routing_table_entry)=0
 
virtual void makeExtInLink (NodeID src, SwitchID dest, BasicLink *link, const NetDest &routing_table_entry)=0
 
virtual void makeInternalLink (SwitchID src, SwitchID dest, BasicLink *link, const NetDest &routing_table_entry, PortDirection src_outport, PortDirection dst_inport)=0
 
virtual void collateStats ()=0
 
virtual void print (std::ostream &out) const =0
 
virtual bool functionalRead (Packet *pkt)
 
virtual uint32_t functionalWrite (Packet *pkt)
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void resetStats ()
 Reset statistics associated with this object. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from EventManager
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
EventQueueeventQueue () const
 
void schedule (Event &event, Tick when)
 
void deschedule (Event &event)
 
void reschedule (Event &event, Tick when, bool always=false)
 
void schedule (Event *event, Tick when)
 
void deschedule (Event *event)
 
void reschedule (Event *event, Tick when, bool always=false)
 
void wakeupEventQueue (Tick when=(Tick)-1)
 
void setCurTick (Tick newVal)
 
- Public Member Functions inherited from Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Static Public Member Functions

static uint32_t getNumberOfVirtualNetworks ()
 
static uint32_t MessageSizeType_to_int (MessageSizeType size_type)
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
- Static Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 

Protected Member Functions

 Network (const Network &obj)
 
Networkoperator= (const Network &obj)
 
- Protected Member Functions inherited from Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 

Protected Attributes

uint32_t m_nodes
 
std::vector< std::string > m_vnet_type_names
 
Topologym_topology_ptr
 
std::vector< std::vector
< MessageBuffer * > > 
m_toNetQueues
 
std::vector< std::vector
< MessageBuffer * > > 
m_fromNetQueues
 
std::vector< bool > m_ordered
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Static Protected Attributes

static uint32_t m_virtual_networks
 
static uint32_t m_control_msg_size
 
static uint32_t m_data_msg_size
 

Additional Inherited Members

- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

Definition at line 58 of file Network.hh.

Member Typedef Documentation

typedef RubyNetworkParams Network::Params

Definition at line 61 of file Network.hh.

Constructor & Destructor Documentation

Network::Network ( const Params p)
Network::~Network ( )
virtual

Definition at line 86 of file Network.cc.

References m_fromNetQueues, m_nodes, m_toNetQueues, and m_topology_ptr.

Network::Network ( const Network obj)
protected

Member Function Documentation

void Network::checkNetworkAllocation ( NodeID  id,
bool  ordered,
int  network_num,
std::string  vnet_type 
)
virtual

Definition at line 139 of file Network.cc.

References fatal_if(), m_nodes, m_ordered, m_virtual_networks, and m_vnet_type_names.

Referenced by setFromNetQueue(), and setToNetQueue().

virtual void Network::collateStats ( )
pure virtual

Implemented in GarnetNetwork, and SimpleNetwork.

Referenced by Network::StatsCallback::process().

virtual bool Network::functionalRead ( Packet pkt)
inlinevirtual

Reimplemented in SimpleNetwork.

Definition at line 100 of file Network.hh.

References fatal.

virtual uint32_t Network::functionalWrite ( Packet pkt)
inlinevirtual

Reimplemented in GarnetNetwork, and SimpleNetwork.

Definition at line 102 of file Network.hh.

References fatal.

Referenced by RubySystem::functionalWrite().

static uint32_t Network::getNumberOfVirtualNetworks ( )
inlinestatic
int Network::getNumNodes ( ) const
inline

Definition at line 70 of file Network.hh.

References m_nodes.

void Network::init ( )
virtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from SimObject.

Reimplemented in GarnetNetwork, and SimpleNetwork.

Definition at line 104 of file Network.cc.

References RubySystem::getBlockSizeBytes(), m_control_msg_size, and m_data_msg_size.

Referenced by SimpleNetwork::init(), and GarnetNetwork::init().

virtual void Network::makeExtInLink ( NodeID  src,
SwitchID  dest,
BasicLink link,
const NetDest routing_table_entry 
)
pure virtual

Implemented in GarnetNetwork, and SimpleNetwork.

Referenced by Topology::makeLink().

virtual void Network::makeExtOutLink ( SwitchID  src,
NodeID  dest,
BasicLink link,
const NetDest routing_table_entry 
)
pure virtual

Implemented in GarnetNetwork, and SimpleNetwork.

Referenced by Topology::makeLink().

virtual void Network::makeInternalLink ( SwitchID  src,
SwitchID  dest,
BasicLink link,
const NetDest routing_table_entry,
PortDirection  src_outport,
PortDirection  dst_inport 
)
pure virtual

Implemented in GarnetNetwork, and SimpleNetwork.

Referenced by Topology::makeLink().

uint32_t Network::MessageSizeType_to_int ( MessageSizeType  size_type)
static
Network& Network::operator= ( const Network obj)
protected
const Params* Network::params ( ) const
inline

Definition at line 63 of file Network.hh.

References SimObject::_params.

Referenced by Switch::addOutPort(), GarnetNetwork::collateStats(), and Network().

virtual void Network::print ( std::ostream &  out) const
pure virtual

Implemented in GarnetNetwork, and SimpleNetwork.

Referenced by operator<<().

void Network::setFromNetQueue ( NodeID  id,
bool  ordered,
int  netNumber,
std::string  vnet_type,
MessageBuffer b 
)
virtual
void Network::setToNetQueue ( NodeID  id,
bool  ordered,
int  netNumber,
std::string  vnet_type,
MessageBuffer b 
)

Member Data Documentation

uint32_t Network::m_control_msg_size
staticprotected

Definition at line 114 of file Network.hh.

Referenced by init(), MessageSizeType_to_int(), and Network().

uint32_t Network::m_data_msg_size
staticprotected

Definition at line 115 of file Network.hh.

Referenced by init(), and MessageSizeType_to_int().

std::vector<std::vector<MessageBuffer*> > Network::m_fromNetQueues
protected
uint32_t Network::m_nodes
protected
std::vector<bool> Network::m_ordered
protected
std::vector<std::vector<MessageBuffer*> > Network::m_toNetQueues
protected
Topology* Network::m_topology_ptr
protected

Definition at line 113 of file Network.hh.

Referenced by SimpleNetwork::init(), GarnetNetwork::init(), Network(), and ~Network().

uint32_t Network::m_virtual_networks
staticprotected
std::vector<std::string> Network::m_vnet_type_names
protected

Definition at line 112 of file Network.hh.

Referenced by checkNetworkAllocation(), GarnetNetwork::GarnetNetwork(), and Network().


The documentation for this class was generated from the following files:

Generated on Fri Jun 9 2017 13:04:15 for gem5 by doxygen 1.8.6