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

#include <WireBuffer.hh>

Inheritance diagram for WireBuffer:
SimObject EventManager Serializable Drainable

Public Types

typedef RubyWireBufferParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 WireBuffer (const Params *p)
 
void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
 ~WireBuffer ()
 
void wakeup ()
 
void setConsumer (Consumer *consumer_ptr)
 
ConsumergetConsumer ()
 
void setDescription (const std::string &name)
 
std::string getDescription ()
 
void enqueue (MsgPtr message, Tick current_time, Tick delta)
 
void dequeue (Tick current_time)
 
const Messagepeek ()
 
void recycle (Tick current_time, Tick recycle_latency)
 
bool isReady (Tick current_time)
 
bool areNSlotsAvailable (int n, Tick current_time)
 
void print (std::ostream &out) const
 
- 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 regStats ()
 Register statistics for this object. 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 Attributes

uint64_t m_msg_counter
 

Private Member Functions

 WireBuffer (const WireBuffer &obj)
 
WireBufferoperator= (const WireBuffer &obj)
 

Private Attributes

Consumerm_consumer_ptr
 
std::string m_description
 
std::vector< MsgPtrm_message_queue
 

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 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 56 of file WireBuffer.hh.

Member Typedef Documentation

typedef RubyWireBufferParams WireBuffer::Params

Definition at line 59 of file WireBuffer.hh.

Constructor & Destructor Documentation

WireBuffer::WireBuffer ( const Params p)

Definition at line 57 of file WireBuffer.cc.

References m_msg_counter.

WireBuffer::~WireBuffer ( )

Definition at line 68 of file WireBuffer.cc.

WireBuffer::WireBuffer ( const WireBuffer obj)
private

Member Function Documentation

bool WireBuffer::areNSlotsAvailable ( int  n,
Tick  current_time 
)
inline

Definition at line 81 of file WireBuffer.hh.

void WireBuffer::dequeue ( Tick  current_time)

Definition at line 91 of file WireBuffer.cc.

References isReady(), and m_message_queue.

void WireBuffer::enqueue ( MsgPtr  message,
Tick  current_time,
Tick  delta 
)
Consumer* WireBuffer::getConsumer ( )
inline

Definition at line 71 of file WireBuffer.hh.

References m_consumer_ptr.

std::string WireBuffer::getDescription ( )
inline

Definition at line 73 of file WireBuffer.hh.

References m_description.

void WireBuffer::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.

Definition at line 64 of file WireBuffer.cc.

bool WireBuffer::isReady ( Tick  current_time)

Definition at line 129 of file WireBuffer.cc.

References m_message_queue.

Referenced by dequeue(), and recycle().

WireBuffer& WireBuffer::operator= ( const WireBuffer obj)
private
const Message * WireBuffer::peek ( )

Definition at line 100 of file WireBuffer.cc.

References m_message_queue.

void WireBuffer::print ( std::ostream &  out) const

Definition at line 136 of file WireBuffer.cc.

Referenced by operator<<().

void WireBuffer::recycle ( Tick  current_time,
Tick  recycle_latency 
)

Definition at line 108 of file WireBuffer.cc.

References isReady(), m_consumer_ptr, and m_message_queue.

void WireBuffer::setConsumer ( Consumer consumer_ptr)
inline

Definition at line 67 of file WireBuffer.hh.

References m_consumer_ptr.

void WireBuffer::setDescription ( const std::string &  name)
inline

Definition at line 72 of file WireBuffer.hh.

References m_description, and SimObject::name().

void WireBuffer::wakeup ( )

Definition at line 141 of file WireBuffer.cc.

Member Data Documentation

Consumer* WireBuffer::m_consumer_ptr
private

Definition at line 92 of file WireBuffer.hh.

Referenced by enqueue(), getConsumer(), recycle(), and setConsumer().

std::string WireBuffer::m_description
private

Definition at line 93 of file WireBuffer.hh.

Referenced by getDescription(), and setDescription().

std::vector<MsgPtr> WireBuffer::m_message_queue
private

Definition at line 96 of file WireBuffer.hh.

Referenced by dequeue(), enqueue(), isReady(), peek(), and recycle().

uint64_t WireBuffer::m_msg_counter

Definition at line 84 of file WireBuffer.hh.

Referenced by enqueue(), and WireBuffer().


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

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