gem5  v21.1.0.2
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
gem5::ruby::Network Class Referenceabstract

#include <Network.hh>

Inheritance diagram for gem5::ruby::Network:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::ruby::garnet::GarnetNetwork gem5::ruby::SimpleNetwork

Classes

struct  AddrMapNode
 

Public Member Functions

 PARAMS (RubyNetwork)
 
 Network (const Params &p)
 
virtual ~Network ()
 
int getNumNodes () const
 
void setToNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void setFromNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void checkNetworkAllocation (NodeID local_id, bool ordered, int network_num, std::string vnet_type)
 
virtual void makeExtOutLink (SwitchID src, NodeID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)=0
 
virtual void makeExtInLink (NodeID src, SwitchID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)=0
 
virtual void makeInternalLink (SwitchID src, SwitchID dest, BasicLink *link, std::vector< 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 bool functionalRead (Packet *pkt, WriteMask &mask)
 
virtual uint32_t functionalWrite (Packet *pkt)
 
NodeID addressToNodeID (Addr addr, MachineType mtype)
 Map an address to the correct NodeID. More...
 
PortgetPort (const std::string &, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
NodeID getLocalNodeID (NodeID global_id) const
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 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 gem5::EventManager
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)
 This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from gem5::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 gem5::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 gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 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 gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing 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 void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 

Protected Member Functions

 Network (const Network &obj)
 
Networkoperator= (const Network &obj)
 
- Protected Member Functions inherited from gem5::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 gem5::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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. 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 gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::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
 

Private Attributes

std::unordered_multimap< MachineType, AddrMapNodeaddrMap
 
std::unordered_map< NodeID, NodeIDglobalToLocalMap
 

Additional Inherited Members

- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 82 of file Network.hh.

Constructor & Destructor Documentation

◆ Network() [1/2]

gem5::ruby::Network::Network ( const Params p)

◆ ~Network()

gem5::ruby::Network::~Network ( )
virtual

Definition at line 146 of file Network.cc.

References m_fromNetQueues, m_nodes, m_toNetQueues, and m_topology_ptr.

◆ Network() [2/2]

gem5::ruby::Network::Network ( const Network obj)
protected

Member Function Documentation

◆ addressToNodeID()

NodeID gem5::ruby::Network::addressToNodeID ( Addr  addr,
MachineType  mtype 
)

Map an address to the correct NodeID.

This function traverses the global address map to find the NodeID that corresponds to the given address and the type of the destination. For example for a request to a directory this function will return the NodeID of the right directory.

Parameters
thedestination address
thetype of the destination
Returns
the NodeID of the destination

Definition at line 235 of file Network.cc.

References gem5::X86ISA::addr, addrMap, gem5::ruby::Network::AddrMapNode::id, and gem5::ruby::Network::AddrMapNode::ranges.

Referenced by gem5::ruby::AbstractController::mapAddressToMachine().

◆ checkNetworkAllocation()

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

Definition at line 193 of file Network.cc.

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

Referenced by setFromNetQueue(), and setToNetQueue().

◆ collateStats()

virtual void gem5::ruby::Network::collateStats ( )
pure virtual

◆ functionalRead() [1/2]

virtual bool gem5::ruby::Network::functionalRead ( Packet pkt)
inlinevirtual

Reimplemented in gem5::ruby::SimpleNetwork.

Definition at line 121 of file Network.hh.

References fatal.

◆ functionalRead() [2/2]

virtual bool gem5::ruby::Network::functionalRead ( Packet pkt,
WriteMask mask 
)
inlinevirtual

Reimplemented in gem5::ruby::SimpleNetwork.

Definition at line 123 of file Network.hh.

References fatal.

◆ functionalWrite()

virtual uint32_t gem5::ruby::Network::functionalWrite ( Packet pkt)
inlinevirtual

Reimplemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Definition at line 125 of file Network.hh.

References fatal.

◆ getLocalNodeID()

NodeID gem5::ruby::Network::getLocalNodeID ( NodeID  global_id) const

◆ getNumberOfVirtualNetworks()

static uint32_t gem5::ruby::Network::getNumberOfVirtualNetworks ( )
inlinestatic

◆ getNumNodes()

int gem5::ruby::Network::getNumNodes ( ) const
inline

Definition at line 91 of file Network.hh.

References m_nodes.

◆ getPort()

Port& gem5::ruby::Network::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
inlineoverridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 143 of file Network.hh.

References gem5::ruby::RubyDummyPort::instance().

◆ makeExtInLink()

virtual void gem5::ruby::Network::makeExtInLink ( NodeID  src,
SwitchID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry 
)
pure virtual

◆ makeExtOutLink()

virtual void gem5::ruby::Network::makeExtOutLink ( SwitchID  src,
NodeID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry 
)
pure virtual

◆ makeInternalLink()

virtual void gem5::ruby::Network::makeInternalLink ( SwitchID  src,
SwitchID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry,
PortDirection  src_outport,
PortDirection  dst_inport 
)
pure virtual

◆ MessageSizeType_to_int()

uint32_t gem5::ruby::Network::MessageSizeType_to_int ( MessageSizeType  size_type)
static

◆ operator=()

Network& gem5::ruby::Network::operator= ( const Network obj)
protected

◆ PARAMS()

gem5::ruby::Network::PARAMS ( RubyNetwork  )

◆ print()

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

◆ setFromNetQueue()

void gem5::ruby::Network::setFromNetQueue ( NodeID  global_id,
bool  ordered,
int  netNumber,
std::string  vnet_type,
MessageBuffer b 
)
virtual

◆ setToNetQueue()

void gem5::ruby::Network::setToNetQueue ( NodeID  global_id,
bool  ordered,
int  netNumber,
std::string  vnet_type,
MessageBuffer b 
)

Definition at line 209 of file Network.cc.

References gem5::ArmISA::b, checkNetworkAllocation(), getLocalNodeID(), and m_toNetQueues.

Member Data Documentation

◆ addrMap

std::unordered_multimap<MachineType, AddrMapNode> gem5::ruby::Network::addrMap
private

Definition at line 174 of file Network.hh.

Referenced by addressToNodeID(), and Network().

◆ globalToLocalMap

std::unordered_map<NodeID, NodeID> gem5::ruby::Network::globalToLocalMap
private

Definition at line 178 of file Network.hh.

Referenced by getLocalNodeID(), and Network().

◆ m_control_msg_size

uint32_t gem5::ruby::Network::m_control_msg_size
staticprotected

Definition at line 159 of file Network.hh.

Referenced by MessageSizeType_to_int(), and Network().

◆ m_data_msg_size

uint32_t gem5::ruby::Network::m_data_msg_size
staticprotected

Definition at line 160 of file Network.hh.

Referenced by MessageSizeType_to_int(), and Network().

◆ m_fromNetQueues

std::vector<std::vector<MessageBuffer*> > gem5::ruby::Network::m_fromNetQueues
protected

◆ m_nodes

uint32_t gem5::ruby::Network::m_nodes
protected

◆ m_ordered

std::vector<bool> gem5::ruby::Network::m_ordered
protected

◆ m_toNetQueues

std::vector<std::vector<MessageBuffer*> > gem5::ruby::Network::m_toNetQueues
protected

◆ m_topology_ptr

Topology* gem5::ruby::Network::m_topology_ptr
protected

◆ m_virtual_networks

uint32_t gem5::ruby::Network::m_virtual_networks
staticprotected

◆ m_vnet_type_names

std::vector<std::string> gem5::ruby::Network::m_vnet_type_names
protected

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

Generated on Tue Sep 21 2021 12:32:09 for gem5 by doxygen 1.8.17