gem5  v21.1.0.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::Workload Class Referenceabstract

#include <workload.hh>

Inheritance diagram for gem5::Workload:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::KernelWorkload gem5::RiscvISA::BareMetal gem5::SEWorkload gem5::SparcISA::FsWorkload gem5::ArmISA::FsWorkload gem5::RiscvISA::FsLinux gem5::X86ISA::FsWorkload gem5::ArmISA::SEWorkload gem5::ArmISA::FsFreebsd gem5::ArmISA::FsLinux gem5::X86ISA::FsLinux gem5::ArmISA::EmuFreebsd gem5::ArmISA::EmuLinux gem5::MipsISA::SEWorkload gem5::PowerISA::SEWorkload gem5::RiscvISA::SEWorkload gem5::SparcISA::SEWorkload gem5::X86ISA::EmuLinux

Classes

struct  WorkloadStats
 

Public Member Functions

 Workload (const WorkloadParams &params)
 
virtual void setSystem (System *sys)
 
void recordQuiesce ()
 
void recordArm ()
 
bool trapToGdb (int signal, ContextID ctx_id)
 
virtual void registerThreadContext (ThreadContext *tc)
 
virtual void replaceThreadContext (ThreadContext *tc)
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
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
 
virtual void syscall (ThreadContext *tc)
 
virtual void event (ThreadContext *tc)
 
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 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...
 
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
 

Protected Member Functions

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

gem5::Workload::WorkloadStats stats
 
BaseRemoteGDBgdb = nullptr
 
bool waitForRemoteGDB = false
 
std::set< ThreadContext * > threads
 
Systemsystem = nullptr
 
- 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...
 

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

Detailed Description

Definition at line 47 of file workload.hh.

Constructor & Destructor Documentation

◆ Workload()

gem5::Workload::Workload ( const WorkloadParams &  params)
inline

Definition at line 81 of file workload.hh.

Member Function Documentation

◆ addFuncEvent() [1/2]

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

Definition at line 145 of file workload.hh.

References symtab().

◆ addFuncEvent() [2/2]

template<class T , typename... Args>
T* gem5::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 132 of file workload.hh.

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

◆ addFuncEventOrPanic()

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

Definition at line 152 of file workload.hh.

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

◆ event()

virtual void gem5::Workload::event ( ThreadContext tc)
inlinevirtual

Reimplemented in gem5::SEWorkload, and gem5::X86ISA::EmuLinux.

Definition at line 112 of file workload.hh.

References warn.

Referenced by gem5::pseudo_inst::triggerWorkloadEvent().

◆ fixFuncEventAddr()

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

Reimplemented in gem5::ArmISA::FsWorkload.

Definition at line 50 of file workload.hh.

References gem5::X86ISA::addr.

Referenced by addFuncEvent().

◆ getArch()

virtual loader::Arch gem5::Workload::getArch ( ) const
pure virtual

◆ getEntry()

virtual Addr gem5::Workload::getEntry ( ) const
pure virtual

◆ insertSymbol()

virtual bool gem5::Workload::insertSymbol ( const loader::Symbol symbol)
pure virtual

◆ recordArm()

void gem5::Workload::recordArm ( )
inline

◆ recordQuiesce()

void gem5::Workload::recordQuiesce ( )
inline

◆ registerThreadContext()

void gem5::Workload::registerThreadContext ( ThreadContext tc)
virtual

◆ replaceThreadContext()

void gem5::Workload::replaceThreadContext ( ThreadContext tc)
virtual

◆ setSystem()

virtual void gem5::Workload::setSystem ( System sys)
inlinevirtual

◆ startup()

void gem5::Workload::startup ( )
overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 92 of file workload.cc.

References gem5::BaseRemoteGDB::connect(), gdb, inform, gem5::Named::name(), gem5::BaseRemoteGDB::port(), gem5::SimObject::startup(), and waitForRemoteGDB.

Referenced by gem5::ArmISA::FsLinux::startup().

◆ symtab()

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

◆ syscall()

virtual void gem5::Workload::syscall ( ThreadContext tc)
inlinevirtual

◆ trapToGdb()

bool gem5::Workload::trapToGdb ( int  signal,
ContextID  ctx_id 
)

Definition at line 80 of file workload.cc.

References gdb, and gem5::BaseRemoteGDB::trap().

Referenced by gem5::System::trapToGdb().

Member Data Documentation

◆ gdb

BaseRemoteGDB* gem5::Workload::gdb = nullptr
protected

◆ stats

gem5::Workload::WorkloadStats gem5::Workload::stats
protected

Referenced by recordArm(), and recordQuiesce().

◆ system

System* gem5::Workload::system = nullptr
protected

◆ threads

std::set<ThreadContext *> gem5::Workload::threads
protected

Definition at line 76 of file workload.hh.

Referenced by registerThreadContext(), and replaceThreadContext().

◆ waitForRemoteGDB

bool gem5::Workload::waitForRemoteGDB = false
protected

Definition at line 75 of file workload.hh.

Referenced by startup().


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

Generated on Tue Sep 21 2021 12:28:25 for gem5 by doxygen 1.8.17