gem5  v21.1.0.2
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gem5::GoodbyeObject Class Reference

#include <goodbye_object.hh>

Inheritance diagram for gem5::GoodbyeObject:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 GoodbyeObject (const GoodbyeObjectParams &p)
 
 ~GoodbyeObject ()
 
void sayGoodbye (std::string name)
 Called by an outside 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
 

Private Member Functions

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

Private Attributes

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

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. 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...
 
- 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 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 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
namethe 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:

Generated on Tue Sep 21 2021 12:27:38 for gem5 by doxygen 1.8.17