gem5::GoodbyeObject Class Reference

#include <goodbye_object.hh>

Inheritance diagram for gem5::GoodbyeObject:

Public Member Functions
	GoodbyeObject (const GoodbyeObjectParams &p)
	~GoodbyeObject ()
void	sayGoodbye (std::string name)
	Called by an outside object.
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 ()
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 ()=delete
	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

Private Member Functions
void	processEvent ()
	Fill the buffer with the next chunk of data.
void	fillBuffer ()
	Fills the buffer for one iteration.

Private Attributes
EventFunctionWrapper	event
	An event that wraps the above function.
float	bandwidth
	The bytes processed per tick.
int	bufferSize
	The size of the buffer we are going to fill.
char *	buffer
	The buffer we are putting our message in.
std::string	message
	The message to put into the buffer.
int	bufferUsed
	The amount of the buffer we've used so far.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params
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 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 40 of file goodbye_object.hh.

Constructor & Destructor Documentation

GoodbyeObject()

gem5::GoodbyeObject::GoodbyeObject

(

const GoodbyeObjectParams &

p

)

Definition at line 38 of file goodbye_object.cc.

References processEvent().

~GoodbyeObject()

gem5::GoodbyeObject::~GoodbyeObject

(

)

Definition at line 47 of file goodbye_object.cc.

References buffer.

Member Function Documentation

fillBuffer()

void gem5::GoodbyeObject::fillBuffer ( )

private

Fills the buffer for one iteration.

If the buffer isn't full, this function will enqueue another event to continue filling.

Definition at line 75 of file goodbye_object.cc.

References bandwidth, buffer, bufferSize, bufferUsed, gem5::curTick(), DPRINTF, event, gem5::exitSimLoop(), message, and gem5::EventManager::schedule().

Referenced by processEvent(), and sayGoodbye().

processEvent()

void gem5::GoodbyeObject::processEvent ( )

private

Fill the buffer with the next chunk of data.

Definition at line 53 of file goodbye_object.cc.

References DPRINTF, and fillBuffer().

Referenced by GoodbyeObject().

sayGoodbye()

void gem5::GoodbyeObject::sayGoodbye

(

std::string

name

)

Called by an outside object.

Starts off the events to fill the buffer with a goodbye message.

Parameters

name	the name of the object we are saying goodbye to.

Definition at line 62 of file goodbye_object.cc.

References DPRINTF, fillBuffer(), and message.

Referenced by gem5::HelloObject::processEvent().

Member Data Documentation

bandwidth

float gem5::GoodbyeObject::bandwidth

private

The bytes processed per tick.

Definition at line 58 of file goodbye_object.hh.

Referenced by fillBuffer().

buffer

char* gem5::GoodbyeObject::buffer

private

The buffer we are putting our message in.

Definition at line 64 of file goodbye_object.hh.

Referenced by fillBuffer(), and ~GoodbyeObject().

bufferSize

int gem5::GoodbyeObject::bufferSize

private

The size of the buffer we are going to fill.

Definition at line 61 of file goodbye_object.hh.

Referenced by fillBuffer().

bufferUsed

int gem5::GoodbyeObject::bufferUsed

private

The amount of the buffer we've used so far.

Definition at line 70 of file goodbye_object.hh.

Referenced by fillBuffer().

event

EventFunctionWrapper gem5::GoodbyeObject::event

private

An event that wraps the above function.

Definition at line 49 of file goodbye_object.hh.

Referenced by fillBuffer().

message

std::string gem5::GoodbyeObject::message

private

The message to put into the buffer.

Definition at line 67 of file goodbye_object.hh.

Referenced by fillBuffer(), and sayGoodbye().

---

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

• learning_gem5/part2/goodbye_object.hh
• learning_gem5/part2/goodbye_object.cc