#include <WireBuffer.hh>

Inheritance diagram for gem5::ruby::WireBuffer:

Public Types
typedef RubyWireBufferParams	Params

Public Types inherited from gem5::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.

	~WireBuffer ()

void	wakeup ()

void	setConsumer (Consumer *consumer_ptr)

Consumer *	getConsumer ()

void	setDescription (const std::string &name)

std::string	getDescription ()

void	enqueue (MsgPtr message, Tick current_time, Tick delta)

void	dequeue (Tick current_time)

const Message *	peek ()

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 gem5::SimObject
const Params &	params () 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.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () 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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

virtual void	serialize (CheckpointOut &cp) const =0
	Serialize an object.

virtual void	unserialize (CheckpointIn &cp)=0
	Unserialize an object.

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Public Attributes
uint64_t	m_msg_counter

Private Member Functions
	WireBuffer (const WireBuffer &obj)

WireBuffer &	operator= (const WireBuffer &obj)

Private Attributes
Consumer *	m_consumer_ptr

std::string	m_description

std::vector< MsgPtr >	m_message_queue

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual DrainState	drain ()=0
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Detailed Description

Definition at line 62 of file WireBuffer.hh.

Member Typedef Documentation

◆ Params

typedef RubyWireBufferParams gem5::ruby::WireBuffer::Params

Definition at line 65 of file WireBuffer.hh.

Constructor & Destructor Documentation

◆ WireBuffer() [1/2]

gem5::ruby::WireBuffer::WireBuffer ( const Params & p )

Definition at line 61 of file WireBuffer.cc.

References m_msg_counter.

◆ ~WireBuffer()

gem5::ruby::WireBuffer::~WireBuffer ( )

Definition at line 72 of file WireBuffer.cc.

◆ WireBuffer() [2/2]

gem5::ruby::WireBuffer::WireBuffer ( const WireBuffer & obj )

private

Member Function Documentation

◆ areNSlotsAvailable()

bool gem5::ruby::WireBuffer::areNSlotsAvailable	(	int	n,
		Tick	current_time
	)

inline

Definition at line 87 of file WireBuffer.hh.

◆ dequeue()

void gem5::ruby::WireBuffer::dequeue ( Tick current_time )

Definition at line 95 of file WireBuffer.cc.

References isReady(), and m_message_queue.

◆ enqueue()

void gem5::ruby::WireBuffer::enqueue	(	MsgPtr	message,
		Tick	current_time,
		Tick	delta
	)

Definition at line 77 of file WireBuffer.cc.

References m_consumer_ptr, m_message_queue, m_msg_counter, panic, and gem5::ruby::Message::setLastEnqueueTime().

◆ getConsumer()

Consumer * gem5::ruby::WireBuffer::getConsumer ( )

inline

Definition at line 77 of file WireBuffer.hh.

References m_consumer_ptr.

◆ getDescription()

std::string gem5::ruby::WireBuffer::getDescription ( )

inline

Definition at line 79 of file WireBuffer.hh.

References m_description.

◆ init()

void gem5::ruby::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 gem5::SimObject.

Definition at line 68 of file WireBuffer.cc.

◆ isReady()

bool gem5::ruby::WireBuffer::isReady ( Tick current_time )

Definition at line 134 of file WireBuffer.cc.

References m_message_queue.

Referenced by dequeue(), and recycle().

◆ operator=()

WireBuffer & gem5::ruby::WireBuffer::operator= ( const WireBuffer & obj )

private

◆ peek()

const Message * gem5::ruby::WireBuffer::peek ( )

Definition at line 104 of file WireBuffer.cc.

References m_message_queue.

◆ print()

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

Definition at line 141 of file WireBuffer.cc.

Referenced by gem5::ruby::operator<<().

◆ recycle()

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

Definition at line 112 of file WireBuffer.cc.

References isReady(), m_consumer_ptr, and m_message_queue.

◆ setConsumer()

void gem5::ruby::WireBuffer::setConsumer ( Consumer * consumer_ptr )

inline

Definition at line 73 of file WireBuffer.hh.

References m_consumer_ptr.

◆ setDescription()

void gem5::ruby::WireBuffer::setDescription ( const std::string & name )

inline

Definition at line 78 of file WireBuffer.hh.

References m_description, and gem5::Named::name().

◆ wakeup()

void gem5::ruby::WireBuffer::wakeup ( )

Definition at line 146 of file WireBuffer.cc.

Member Data Documentation

◆ m_consumer_ptr

Consumer* gem5::ruby::WireBuffer::m_consumer_ptr

private

Definition at line 98 of file WireBuffer.hh.

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

◆ m_description

std::string gem5::ruby::WireBuffer::m_description

private

Definition at line 99 of file WireBuffer.hh.

Referenced by getDescription(), and setDescription().

◆ m_message_queue

std::vector<MsgPtr> gem5::ruby::WireBuffer::m_message_queue

private

Definition at line 102 of file WireBuffer.hh.

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

◆ m_msg_counter

uint64_t gem5::ruby::WireBuffer::m_msg_counter

Definition at line 90 of file WireBuffer.hh.

Referenced by enqueue(), and WireBuffer().

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

mem/ruby/structures/WireBuffer.hh
mem/ruby/structures/WireBuffer.cc

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ WireBuffer() [1/2]

◆ ~WireBuffer()

◆ WireBuffer() [2/2]

Member Function Documentation

◆ areNSlotsAvailable()

◆ dequeue()

◆ enqueue()

◆ getConsumer()

◆ getDescription()

◆ init()

◆ isReady()

◆ operator=()

◆ peek()

◆ print()

◆ recycle()

◆ setConsumer()

◆ setDescription()

◆ wakeup()

Member Data Documentation

◆ m_consumer_ptr

◆ m_description

◆ m_message_queue

◆ m_msg_counter