gem5  v20.1.0.0
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Workload Class Referenceabstract

#include <workload.hh>

Inheritance diagram for Workload:
SimObject EventManager Serializable Drainable Stats::Group KernelWorkload RiscvISA::FsWorkload SparcISA::FsWorkload ArmISA::FsWorkload X86ISA::FsWorkload RiscvISA::BareMetal ArmISA::FsFreebsd ArmISA::FsLinux X86ISA::FsLinux

Classes

struct  WorkloadStats
 

Public Member Functions

 Workload (const WorkloadParams *_params)
 
void recordQuiesce ()
 
void recordArm ()
 
virtual Addr getEntry () const =0
 
virtual Loader::Arch getArch () const =0
 
virtual const Loader::SymbolTablesymtab (ThreadContext *tc)=0
 
virtual bool insertSymbol (const Loader::Symbol &symbol)=0
 
template<class T , typename... Args>
T * addFuncEvent (const Loader::SymbolTable &symtab, const char *lbl, const std::string &desc, Args... args)
 Add a function-based event to the given function, to be looked up in the specified symbol table. More...
 
template<class T >
T * addFuncEvent (const Loader::SymbolTable &symtab, const char *lbl)
 
template<class T , typename... Args>
T * addFuncEventOrPanic (const Loader::SymbolTable &symtab, const char *lbl, Args... args)
 
- 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 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 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 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 Stats::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 (Stats::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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Public Attributes

Systemsystem = nullptr
 

Protected Member Functions

virtual Addr fixFuncEventAddr (Addr addr) const
 
- 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

Workload::WorkloadStats stats
 
- 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...
 

Additional Inherited Members

- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- 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 ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 

Detailed Description

Definition at line 40 of file workload.hh.

Constructor & Destructor Documentation

◆ Workload()

Workload::Workload ( const WorkloadParams *  _params)
inline

Definition at line 58 of file workload.hh.

Member Function Documentation

◆ addFuncEvent() [1/2]

template<class T >
T* Workload::addFuncEvent ( const Loader::SymbolTable symtab,
const char *  lbl 
)
inline

Definition at line 100 of file workload.hh.

References symtab().

◆ addFuncEvent() [2/2]

template<class T , typename... Args>
T* Workload::addFuncEvent ( const Loader::SymbolTable symtab,
const char *  lbl,
const std::string &  desc,
Args...  args 
)
inline

Add a function-based event to the given function, to be looked up in the specified symbol table.

The ...OrPanic flavor of the method causes the simulator to panic if the symbol can't be found.

Parameters
symtabSymbol table to use for look up.
lblFunction to hook the event to.
descDescription to be passed to the event.
argsArguments to be forwarded to the event constructor.

Definition at line 87 of file workload.hh.

References Loader::SymbolTable::end(), Loader::SymbolTable::find(), fixFuncEventAddr(), symtab(), and system.

◆ addFuncEventOrPanic()

template<class T , typename... Args>
T* Workload::addFuncEventOrPanic ( const Loader::SymbolTable symtab,
const char *  lbl,
Args...  args 
)
inline

Definition at line 107 of file workload.hh.

References ArmISA::e, panic_if, and symtab().

◆ fixFuncEventAddr()

virtual Addr Workload::fixFuncEventAddr ( Addr  addr) const
inlineprotectedvirtual

Reimplemented in ArmISA::FsWorkload.

Definition at line 43 of file workload.hh.

References addr.

Referenced by addFuncEvent().

◆ getArch()

virtual Loader::Arch Workload::getArch ( ) const
pure virtual

◆ getEntry()

virtual Addr Workload::getEntry ( ) const
pure virtual

◆ insertSymbol()

virtual bool Workload::insertSymbol ( const Loader::Symbol symbol)
pure virtual

◆ recordArm()

void Workload::recordArm ( )
inline

Definition at line 62 of file workload.hh.

References Workload::WorkloadStats::arm, and stats.

Referenced by PseudoInst::arm().

◆ recordQuiesce()

void Workload::recordQuiesce ( )
inline

Definition at line 61 of file workload.hh.

References Workload::WorkloadStats::quiesce, and stats.

◆ symtab()

virtual const Loader::SymbolTable& Workload::symtab ( ThreadContext tc)
pure virtual

Member Data Documentation

◆ stats

Workload::WorkloadStats Workload::stats
protected

Referenced by recordArm(), and recordQuiesce().

◆ system

System* Workload::system = nullptr

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

Generated on Wed Sep 30 2020 14:02:34 for gem5 by doxygen 1.8.17