#include <workload.hh>

Inheritance diagram for gem5::Workload:

Classes
struct	WorkloadStats

Public Member Functions
	Workload (const WorkloadParams &params)

virtual void	setSystem (System *sys)

void	recordQuiesce ()

void	recordArm ()

bool	trapToGdb (GDBSignal sig, ContextID ctx_id)

bool	sendToGdb (std::string msg)

virtual void	registerThreadContext (ThreadContext *tc)

virtual void	replaceThreadContext (ThreadContext *tc)

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

virtual Addr	getEntry () const =0

virtual ByteOrder	byteOrder () const =0

virtual loader::Arch	getArch () const =0

virtual SimObject *	getSemihosting () const
	Returns the semihosting interface if supported by the current workload.

virtual const loader::SymbolTable &	symtab (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.

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

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

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.

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

Protected Attributes
gem5::Workload::WorkloadStats	stats

BaseRemoteGDB *	gdb = nullptr

bool	waitForRemoteGDB = false

std::set< ThreadContext * >	threads

System *	system = nullptr

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.

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.

Detailed Description

Definition at line 50 of file workload.hh.

Constructor & Destructor Documentation

◆ Workload()

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

inline

Definition at line 84 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 152 of file workload.hh.

References addFuncEvent(), and 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

symtab	Symbol table to use for look up.
lbl	Function to hook the event to.
desc	Description to be passed to the event.
args	Arguments to be forwarded to the event constructor.

Definition at line 139 of file workload.hh.

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

Referenced by gem5::RiscvISA::BootloaderKernelWorkload::addExitOnKernelOopsEvent(), gem5::RiscvISA::BootloaderKernelWorkload::addExitOnKernelPanicEvent(), addFuncEvent(), addFuncEventOrPanic(), gem5::KernelWorkload::addKernelFuncEvent(), and gem5::KernelWorkload::addKernelFuncEventOrPanic().

◆ addFuncEventOrPanic()

template<class T , typename... Args>

T * gem5::Workload::addFuncEventOrPanic	(	const loader::SymbolTable &	symtab,
		const char *	lbl,
		Args...	args )

inline

Definition at line 159 of file workload.hh.

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

◆ byteOrder()

virtual ByteOrder gem5::Workload::byteOrder ( ) const

pure virtual

Implemented in gem5::ArmISA::EmuFreebsd, gem5::ArmISA::EmuLinux, gem5::ArmISA::FsWorkload, gem5::KernelWorkload, gem5::MipsISA::EmuLinux, gem5::PowerISA::EmuLinux, gem5::RiscvISA::BareMetal, gem5::RiscvISA::BootloaderKernelWorkload, gem5::RiscvISA::EmuLinux, gem5::RiscvISA::FsLinux, gem5::SparcISA::EmuLinux, gem5::SparcISA::FsWorkload, gem5::StubWorkload, gem5::X86ISA::BareMetalWorkload, gem5::X86ISA::EmuLinux, and gem5::X86ISA::FsWorkload.

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

◆ event()

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

inlinevirtual

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

Definition at line 119 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 53 of file workload.hh.

References gem5::X86ISA::addr.

Referenced by addFuncEvent().

◆ getArch()

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

pure virtual

Implemented in gem5::ArmISA::FsWorkload, gem5::ArmISA::SEWorkload, gem5::KernelWorkload, gem5::MipsISA::SEWorkload, gem5::PowerISA::SEWorkload, gem5::RiscvISA::BareMetal, gem5::RiscvISA::BootloaderKernelWorkload, gem5::RiscvISA::SEWorkload, gem5::SEWorkload, gem5::SparcISA::EmuLinux, gem5::SparcISA::FsWorkload, gem5::StubWorkload, gem5::X86ISA::BareMetalWorkload, and gem5::X86ISA::EmuLinux.

Referenced by gem5::ArmSystem::ArmSystem().

◆ getEntry()

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

pure virtual

Implemented in gem5::ArmISA::FsWorkload, gem5::KernelWorkload, gem5::RiscvISA::BareMetal, gem5::RiscvISA::BootloaderKernelWorkload, gem5::SEWorkload, gem5::SparcISA::FsWorkload, gem5::StubWorkload, and gem5::X86ISA::BareMetalWorkload.

Referenced by gem5::ArmSystem::ArmSystem().

◆ getSemihosting()

virtual SimObject * gem5::Workload::getSemihosting ( ) const

inlinevirtual

Returns the semihosting interface if supported by the current workload.

Reimplemented in gem5::RiscvISA::BareMetal, gem5::RiscvISA::BootloaderKernelWorkload, and gem5::RiscvISA::FsLinux.

Definition at line 107 of file workload.hh.

Referenced by gem5::RiscvISA::SystemOp::executeEBreakOrSemihosting().

◆ insertSymbol()

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

pure virtual

Implemented in gem5::KernelWorkload, gem5::RiscvISA::BareMetal, gem5::RiscvISA::BootloaderKernelWorkload, gem5::SEWorkload, gem5::SparcISA::FsWorkload, gem5::StubWorkload, and gem5::X86ISA::BareMetalWorkload.

Referenced by gem5::pseudo_inst::addsymbol(), and gem5::pseudo_inst::loadsymbol().

◆ recordArm()

void gem5::Workload::recordArm ( )

inline

Definition at line 91 of file workload.hh.

References gem5::Workload::WorkloadStats::InstStats::arm, gem5::Workload::WorkloadStats::instStats, and stats.

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

◆ recordQuiesce()

void gem5::Workload::recordQuiesce ( )

inline

Definition at line 90 of file workload.hh.

References gem5::Workload::WorkloadStats::instStats, gem5::Workload::WorkloadStats::InstStats::quiesce, and stats.

Referenced by gem5::SparcISA::ISA::setFSReg().

◆ registerThreadContext()

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

virtual

Definition at line 38 of file workload.cc.

References gem5::BaseRemoteGDB::addThreadContext(), gem5::ThreadContext::contextId(), gdb, panic_if, and threads.

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

◆ replaceThreadContext()

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

virtual

Definition at line 51 of file workload.cc.

References gem5::ThreadContext::contextId(), gdb, gem5::ArmISA::id, panic, panic_if, gem5::BaseRemoteGDB::replaceThreadContext(), and threads.

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

◆ sendToGdb()

bool gem5::Workload::sendToGdb ( std::string msg )

Definition at line 84 of file workload.cc.

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

◆ 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 93 of file workload.cc.

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

Referenced by gem5::RiscvISA::BootloaderKernelWorkload::startup().