gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
NetworkLink Class Reference

#include <NetworkLink.hh>

Inheritance diagram for NetworkLink:
ClockedObject Consumer SimObject Clocked EventManager Serializable Drainable CreditLink

Public Types

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

Public Member Functions

 NetworkLink (const Params *p)
 
 ~NetworkLink ()
 
void setLinkConsumer (Consumer *consumer)
 
void setSourceQueue (flitBuffer *srcQueue)
 
void setType (link_type type)
 
link_type getType ()
 
void print (std::ostream &out) const
 
int get_id () const
 
void wakeup ()
 
unsigned int getLinkUtilization () const
 
const std::vector< unsigned int > & getVcLoad () const
 
bool isReady (Cycles curTime)
 
flitpeekLink ()
 
flitconsumeLink ()
 
uint32_t functionalWrite (Packet *)
 
- 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 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 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
 
- Public Member Functions inherited from Consumer
 Consumer (ClockedObject *_em)
 
virtual ~Consumer ()
 
virtual void storeEventInfo (int info)
 
bool alreadyScheduled (Tick time)
 
void insertScheduledWakeupTime (Tick time)
 
void scheduleEventAbsolute (Tick timeAbs)
 

Private Attributes

const int m_id
 
link_type m_type
 
const Cycles m_latency
 
flitBufferlinkBuffer
 
Consumerlink_consumer
 
flitBufferlink_srcQueue
 
unsigned int m_link_utilized
 
std::vector< unsigned int > m_vc_load
 

Additional Inherited Members

- 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)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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 Member Functions inherited from Consumer
void scheduleEvent (Cycles timeDelta)
 
- 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...
 

Detailed Description

Definition at line 48 of file NetworkLink.hh.

Member Typedef Documentation

typedef NetworkLinkParams NetworkLink::Params

Definition at line 51 of file NetworkLink.hh.

Constructor & Destructor Documentation

NetworkLink::NetworkLink ( const Params p)

Definition at line 38 of file NetworkLink.cc.

NetworkLink::~NetworkLink ( )

Definition at line 48 of file NetworkLink.cc.

References linkBuffer.

Member Function Documentation

flit* NetworkLink::consumeLink ( )
inline
uint32_t NetworkLink::functionalWrite ( Packet pkt)

Definition at line 91 of file NetworkLink.cc.

References flitBuffer::functionalWrite(), and linkBuffer.

int NetworkLink::get_id ( ) const
inline

Definition at line 60 of file NetworkLink.hh.

References m_id.

Referenced by InputUnit::get_inlink_id(), and OutputUnit::get_outlink_id().

unsigned int NetworkLink::getLinkUtilization ( ) const
inline

Definition at line 63 of file NetworkLink.hh.

References m_link_utilized.

link_type NetworkLink::getType ( )
inline

Definition at line 58 of file NetworkLink.hh.

References m_type.

const std::vector<unsigned int>& NetworkLink::getVcLoad ( ) const
inline

Definition at line 64 of file NetworkLink.hh.

References m_vc_load.

bool NetworkLink::isReady ( Cycles  curTime)
inline
flit* NetworkLink::peekLink ( )
inline

Definition at line 69 of file NetworkLink.hh.

References linkBuffer, and flitBuffer::peekTopFlit().

void NetworkLink::print ( std::ostream &  out) const
inlinevirtual

Implements Consumer.

Definition at line 59 of file NetworkLink.hh.

void NetworkLink::setLinkConsumer ( Consumer consumer)
void NetworkLink::setSourceQueue ( flitBuffer srcQueue)
void NetworkLink::setType ( link_type  type)
inline
void NetworkLink::wakeup ( )
virtual

Member Data Documentation

Consumer* NetworkLink::link_consumer
private

Definition at line 80 of file NetworkLink.hh.

Referenced by setLinkConsumer(), and wakeup().

flitBuffer* NetworkLink::link_srcQueue
private

Definition at line 81 of file NetworkLink.hh.

Referenced by setSourceQueue(), and wakeup().

flitBuffer* NetworkLink::linkBuffer
private

Definition at line 79 of file NetworkLink.hh.

Referenced by consumeLink(), functionalWrite(), isReady(), peekLink(), wakeup(), and ~NetworkLink().

const int NetworkLink::m_id
private

Definition at line 75 of file NetworkLink.hh.

Referenced by get_id().

const Cycles NetworkLink::m_latency
private

Definition at line 77 of file NetworkLink.hh.

Referenced by wakeup().

unsigned int NetworkLink::m_link_utilized
private

Definition at line 84 of file NetworkLink.hh.

Referenced by getLinkUtilization(), and wakeup().

link_type NetworkLink::m_type
private

Definition at line 76 of file NetworkLink.hh.

Referenced by getType(), and setType().

std::vector<unsigned int> NetworkLink::m_vc_load
private

Definition at line 85 of file NetworkLink.hh.

Referenced by getVcLoad(), and wakeup().


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