gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gem5::ruby::garnet::NetworkInterface Class Reference

#include <NetworkInterface.hh>

Inheritance diagram for gem5::ruby::garnet::NetworkInterface:
gem5::ClockedObject gem5::ruby::Consumer gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  InputPort
 
class  OutputPort
 

Public Types

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

Public Member Functions

 NetworkInterface (const Params &p)
 
 ~NetworkInterface ()=default
 
void addInPort (NetworkLink *in_link, CreditLink *credit_link)
 
void addOutPort (NetworkLink *out_link, CreditLink *credit_link, SwitchID router_id, uint32_t consumerVcs)
 
void dequeueCallback ()
 
void wakeup ()
 
void addNode (std::vector< MessageBuffer * > &inNode, std::vector< MessageBuffer * > &outNode)
 
void print (std::ostream &out) const
 
int get_vnet (int vc)
 
void init_net_ptr (GarnetNetwork *net_ptr)
 
uint32_t functionalWrite (Packet *)
 
void scheduleFlit (flit *t_flit)
 
int get_router_id (int vnet)
 
- 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 PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
 
- Public Member Functions inherited from gem5::ruby::Consumer
 Consumer (ClockedObject *_em)
 
virtual ~Consumer ()
 
virtual void storeEventInfo (int info)
 
bool alreadyScheduled (Tick time)
 
ClockedObjectgetObject ()
 
void scheduleEventAbsolute (Tick timeAbs)
 
void scheduleEvent (Cycles timeDelta)
 

Private Member Functions

void checkStallQueue ()
 
bool flitisizeMessage (MsgPtr msg_ptr, int vnet)
 
int calculateVC (int vnet)
 
void scheduleOutputPort (OutputPort *oPort)
 
void scheduleOutputLink ()
 This function looks at the NI buffers if some buffer has flits which are ready to traverse the link in the next cycle, and the downstream output vc associated with this flit has buffers left, the link is scheduled for the next cycle. More...
 
void checkReschedule ()
 
void incrementStats (flit *t_flit)
 
InputPortgetInportForVnet (int vnet)
 
OutputPortgetOutportForVnet (int vnet)
 

Private Attributes

GarnetNetworkm_net_ptr
 
const NodeID m_id
 
const int m_virtual_networks
 
int m_vc_per_vnet
 
std::vector< int > m_vc_allocator
 
std::vector< OutputPort * > outPorts
 
std::vector< InputPort * > inPorts
 
int m_deadlock_threshold
 
std::vector< OutVcStateoutVcState
 
std::vector< int > m_stall_count
 
std::vector< flitBufferniOutVcs
 
std::vector< Tickm_ni_out_vcs_enqueue_time
 
std::vector< MessageBuffer * > inNode_ptr
 
std::vector< MessageBuffer * > outNode_ptr
 
std::vector< int > vc_busy_counter
 

Additional Inherited Members

- 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- 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 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...
 

Detailed Description

Definition at line 62 of file NetworkInterface.hh.

Member Typedef Documentation

◆ Params

typedef GarnetNetworkInterfaceParams gem5::ruby::garnet::NetworkInterface::Params

Definition at line 65 of file NetworkInterface.hh.

Constructor & Destructor Documentation

◆ NetworkInterface()

gem5::ruby::garnet::NetworkInterface::NetworkInterface ( const Params p)

Definition at line 54 of file NetworkInterface.cc.

References m_stall_count, m_virtual_networks, and niOutVcs.

◆ ~NetworkInterface()

gem5::ruby::garnet::NetworkInterface::~NetworkInterface ( )
default

Member Function Documentation

◆ addInPort()

void gem5::ruby::garnet::NetworkInterface::addInPort ( NetworkLink in_link,
CreditLink credit_link 
)

◆ addNode()

void gem5::ruby::garnet::NetworkInterface::addNode ( std::vector< MessageBuffer * > &  inNode,
std::vector< MessageBuffer * > &  outNode 
)

Definition at line 130 of file NetworkInterface.cc.

References inNode_ptr, and outNode_ptr.

◆ addOutPort()

void gem5::ruby::garnet::NetworkInterface::addOutPort ( NetworkLink out_link,
CreditLink credit_link,
SwitchID  router_id,
uint32_t  consumerVcs 
)

◆ calculateVC()

int gem5::ruby::garnet::NetworkInterface::calculateVC ( int  vnet)
private

◆ checkReschedule()

void gem5::ruby::garnet::NetworkInterface::checkReschedule ( )
private

◆ checkStallQueue()

void gem5::ruby::garnet::NetworkInterface::checkStallQueue ( )
private

◆ dequeueCallback()

void gem5::ruby::garnet::NetworkInterface::dequeueCallback ( )

◆ flitisizeMessage()

bool gem5::ruby::garnet::NetworkInterface::flitisizeMessage ( MsgPtr  msg_ptr,
int  vnet 
)
private

◆ functionalWrite()

uint32_t gem5::ruby::garnet::NetworkInterface::functionalWrite ( Packet pkt)

Definition at line 670 of file NetworkInterface.cc.

References niOutVcs, and outPorts.

◆ get_router_id()

int gem5::ruby::garnet::NetworkInterface::get_router_id ( int  vnet)
inline

◆ get_vnet()

int gem5::ruby::garnet::NetworkInterface::get_vnet ( int  vc)

Definition at line 606 of file NetworkInterface.cc.

References fatal, gem5::ArmISA::i, m_vc_per_vnet, and m_virtual_networks.

Referenced by scheduleOutputPort().

◆ getInportForVnet()

NetworkInterface::InputPort * gem5::ruby::garnet::NetworkInterface::getInportForVnet ( int  vnet)
private

Definition at line 559 of file NetworkInterface.cc.

References inPorts.

◆ getOutportForVnet()

NetworkInterface::OutputPort * gem5::ruby::garnet::NetworkInterface::getOutportForVnet ( int  vnet)
private

Definition at line 577 of file NetworkInterface.cc.

References outPorts.

Referenced by flitisizeMessage(), get_router_id(), and scheduleFlit().

◆ incrementStats()

void gem5::ruby::garnet::NetworkInterface::incrementStats ( flit t_flit)
private

◆ init_net_ptr()

void gem5::ruby::garnet::NetworkInterface::init_net_ptr ( GarnetNetwork net_ptr)
inline

Definition at line 80 of file NetworkInterface.hh.

References m_net_ptr.

◆ print()

void gem5::ruby::garnet::NetworkInterface::print ( std::ostream &  out) const
virtual

Implements gem5::ruby::Consumer.

Definition at line 664 of file NetworkInterface.cc.

◆ scheduleFlit()

void gem5::ruby::garnet::NetworkInterface::scheduleFlit ( flit t_flit)

◆ scheduleOutputLink()

void gem5::ruby::garnet::NetworkInterface::scheduleOutputLink ( )
private

This function looks at the NI buffers if some buffer has flits which are ready to traverse the link in the next cycle, and the downstream output vc associated with this flit has buffers left, the link is scheduled for the next cycle.

Definition at line 550 of file NetworkInterface.cc.

References outPorts, and scheduleOutputPort().

Referenced by wakeup().

◆ scheduleOutputPort()

void gem5::ruby::garnet::NetworkInterface::scheduleOutputPort ( OutputPort oPort)
private

◆ wakeup()

void gem5::ruby::garnet::NetworkInterface::wakeup ( )
virtual

Member Data Documentation

◆ inNode_ptr

std::vector<MessageBuffer *> gem5::ruby::garnet::NetworkInterface::inNode_ptr
private

Definition at line 289 of file NetworkInterface.hh.

Referenced by addNode(), checkReschedule(), and wakeup().

◆ inPorts

std::vector<InputPort *> gem5::ruby::garnet::NetworkInterface::inPorts
private

◆ m_deadlock_threshold

int gem5::ruby::garnet::NetworkInterface::m_deadlock_threshold
private

Definition at line 278 of file NetworkInterface.hh.

Referenced by calculateVC().

◆ m_id

const NodeID gem5::ruby::garnet::NetworkInterface::m_id
private

Definition at line 272 of file NetworkInterface.hh.

Referenced by flitisizeMessage(), and wakeup().

◆ m_net_ptr

GarnetNetwork* gem5::ruby::garnet::NetworkInterface::m_net_ptr
private

◆ m_ni_out_vcs_enqueue_time

std::vector<Tick> gem5::ruby::garnet::NetworkInterface::m_ni_out_vcs_enqueue_time
private

Definition at line 286 of file NetworkInterface.hh.

Referenced by addOutPort(), flitisizeMessage(), and scheduleOutputPort().

◆ m_stall_count

std::vector<int> gem5::ruby::garnet::NetworkInterface::m_stall_count
private

Definition at line 281 of file NetworkInterface.hh.

Referenced by checkStallQueue(), NetworkInterface(), and wakeup().

◆ m_vc_allocator

std::vector<int> gem5::ruby::garnet::NetworkInterface::m_vc_allocator
private

Definition at line 275 of file NetworkInterface.hh.

Referenced by calculateVC().

◆ m_vc_per_vnet

int gem5::ruby::garnet::NetworkInterface::m_vc_per_vnet
private

Definition at line 274 of file NetworkInterface.hh.

Referenced by addInPort(), addOutPort(), calculateVC(), get_vnet(), and scheduleOutputPort().

◆ m_virtual_networks

const int gem5::ruby::garnet::NetworkInterface::m_virtual_networks
private

Definition at line 273 of file NetworkInterface.hh.

Referenced by addOutPort(), get_vnet(), and NetworkInterface().

◆ niOutVcs

std::vector<flitBuffer> gem5::ruby::garnet::NetworkInterface::niOutVcs
private

◆ outNode_ptr

std::vector<MessageBuffer *> gem5::ruby::garnet::NetworkInterface::outNode_ptr
private

Definition at line 291 of file NetworkInterface.hh.

Referenced by addNode(), checkStallQueue(), and wakeup().

◆ outPorts

std::vector<OutputPort *> gem5::ruby::garnet::NetworkInterface::outPorts
private

◆ outVcState

std::vector<OutVcState> gem5::ruby::garnet::NetworkInterface::outVcState
private

◆ vc_busy_counter

std::vector<int> gem5::ruby::garnet::NetworkInterface::vc_busy_counter
private

Definition at line 293 of file NetworkInterface.hh.

Referenced by calculateVC().


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

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