#include <kernel_workload.hh>

Inheritance diagram for gem5::KernelWorkload:

Public Member Functions
	PARAMS (KernelWorkload)

Addr	start () const

Addr	end () const

Addr	loadAddrMask () const

Addr	loadAddrOffset () const

	KernelWorkload (const Params &p)

Addr	getEntry () const override

ByteOrder	byteOrder () const override

loader::Arch	getArch () const override

const loader::SymbolTable &	symtab (ThreadContext *tc) override

bool	insertSymbol (const loader::Symbol &symbol) override

void	initState () override
	initState() is called on each SimObject when not restoring from a checkpoint.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.


template<class T , typename... Args>
T *	addKernelFuncEvent (const char *lbl, Args... args)
	Add a function-based event to a kernel symbol.

template<class T , typename... Args>
T *	addKernelFuncEventOrPanic (const char *lbl, Args... args)

Public Member Functions inherited from gem5::Workload
	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 SimObject *	getSemihosting () const
	Returns the semihosting interface if supported by the current workload.

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	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 Attributes
loader::MemoryImage	image

Addr	_loadAddrMask
	Mask that should be anded for binary/symbol loading.

Addr	_loadAddrOffset
	Offset that should be used for binary/symbol loading.

Addr	_start

Addr	_end

std::vector< loader::ObjectFile * >	extras

loader::ObjectFile *	kernelObj = nullptr

loader::SymbolTable	kernelSymtab

const std::string	commandLine

Protected Attributes inherited from gem5::Workload
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.

Protected Member Functions inherited from gem5::Workload
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.

Detailed Description

Definition at line 45 of file kernel_workload.hh.

Constructor & Destructor Documentation

◆ KernelWorkload()

gem5::KernelWorkload::KernelWorkload ( const Params & p )

Member Function Documentation

◆ addKernelFuncEvent()

template<class T , typename... Args>

T * gem5::KernelWorkload::addKernelFuncEvent	(	const char *	lbl,
		Args...	args )

inline

Add a function-based event to a kernel symbol.

These functions work like their addFuncEvent() and addFuncEventOrPanic() counterparts. The only difference is that they automatically use the kernel symbol table. All arguments are forwarded to the underlying method.

See also: addFuncEvent(); addFuncEventOrPanic()

Parameters

lbl	Function to hook the event to.
args	Arguments to be passed to addFuncEvent

Definition at line 128 of file kernel_workload.hh.

References gem5::Workload::addFuncEvent(), and kernelSymtab.

Referenced by gem5::RiscvISA::FsLinux::addExitOnKernelOopsEvent(), gem5::RiscvISA::FsLinux::addExitOnKernelPanicEvent(), gem5::ArmISA::FsWorkload::addSkipFunc(), and gem5::ArmISA::FsLinux::startup().

◆ addKernelFuncEventOrPanic()

template<class T , typename... Args>

T * gem5::KernelWorkload::addKernelFuncEventOrPanic	(	const char *	lbl,
		Args...	args )

inline

Definition at line 135 of file kernel_workload.hh.

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

Referenced by gem5::ArmISA::FsWorkload::addSkipFuncOrPanic(), and gem5::ArmISA::FsFreebsd::FsFreebsd().

◆ byteOrder()

ByteOrder gem5::KernelWorkload::byteOrder ( ) const

inlineoverridevirtual

Implements gem5::Workload.

Definition at line 87 of file kernel_workload.hh.

References gem5::loader::ObjectFile::getByteOrder(), and kernelObj.

◆ end()

Addr gem5::KernelWorkload::end ( ) const

inline

Definition at line 80 of file kernel_workload.hh.

References _end.

◆ getArch()

loader::Arch gem5::KernelWorkload::getArch ( ) const

inlineoverridevirtual

Implements gem5::Workload.

Definition at line 89 of file kernel_workload.hh.

References gem5::loader::ObjectFile::getArch(), and kernelObj.

◆ getEntry()

Addr gem5::KernelWorkload::getEntry ( ) const

inlineoverridevirtual

Implements gem5::Workload.

Definition at line 86 of file kernel_workload.hh.

References gem5::loader::ObjectFile::entryPoint(), and kernelObj.

◆ initState()

void gem5::KernelWorkload::initState ( )

overridevirtual

initState() is called on each SimObject when not restoring from a checkpoint.

This provides a hook for state initializations that are only required for a "cold start".

Load the kernel code into memory.

Reimplemented from gem5::SimObject.

Definition at line 96 of file kernel_workload.cc.

References _end, _loadAddrMask, _loadAddrOffset, _start, gem5::ArmISA::a, DPRINTF, gem5::loader::ObjectFile::entryPoint(), extras, fatal_if, image, gem5::System::isMemAddr(), kernelObj, gem5::MaxAddr, gem5::loader::MemoryImage::move(), gem5::loader::MemoryImage::offset(), gem5::SimObject::params(), gem5::System::physProxy, gem5::Workload::system, and gem5::loader::MemoryImage::write().

Referenced by gem5::ArmISA::FsWorkload::initState(), gem5::RiscvISA::FsLinux::initState(), and gem5::X86ISA::FsWorkload::initState().

◆ insertSymbol()

bool gem5::KernelWorkload::insertSymbol ( const loader::Symbol & symbol )

inlineoverridevirtual

Implements gem5::Workload.

Definition at line 101 of file kernel_workload.hh.

References gem5::loader::SymbolTable::insert(), and kernelSymtab.

◆ loadAddrMask()

Addr gem5::KernelWorkload::loadAddrMask ( ) const

inline

Definition at line 81 of file kernel_workload.hh.

References _loadAddrMask.

Referenced by gem5::ArmISA::FsWorkload::FsWorkload().

◆ loadAddrOffset()

Addr gem5::KernelWorkload::loadAddrOffset ( ) const

inline

Definition at line 82 of file kernel_workload.hh.

References _loadAddrOffset.

Referenced by gem5::ArmISA::FsWorkload::FsWorkload().

◆ PARAMS()

gem5::KernelWorkload::PARAMS ( KernelWorkload )

◆ serialize()

void gem5::KernelWorkload::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 138 of file kernel_workload.cc.

References kernelSymtab, and gem5::loader::SymbolTable::serialize().

◆ start()

Addr gem5::KernelWorkload::start ( ) const

inline

Definition at line 79 of file kernel_workload.hh.

References _start.

◆ symtab()

const loader::SymbolTable & gem5::KernelWorkload::symtab ( ThreadContext * tc )

inlineoverridevirtual

Implements gem5::Workload.

Definition at line 95 of file kernel_workload.hh.

References kernelSymtab.

◆ unserialize()

void gem5::KernelWorkload::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 144 of file kernel_workload.cc.

References kernelSymtab, and gem5::loader::SymbolTable::unserialize().

Member Data Documentation

◆ _end

Addr gem5::KernelWorkload::_end

protected

Definition at line 65 of file kernel_workload.hh.

Referenced by end(), initState(), and KernelWorkload().

◆ _loadAddrMask

Addr gem5::KernelWorkload::_loadAddrMask

protected

Mask that should be anded for binary/symbol loading.

This allows one two different OS requirements for the same ISA to be handled. Some OSes are compiled for a virtual address and need to be loaded into physical memory that starts at address 0, while other bare metal tools generate images that start at address 0.

Definition at line 56 of file kernel_workload.hh.

Referenced by gem5::ArmISA::FsFreebsd::initState(), gem5::ArmISA::FsLinux::initState(), initState(), KernelWorkload(), and loadAddrMask().

◆ _loadAddrOffset

Addr gem5::KernelWorkload::_loadAddrOffset

protected

Offset that should be used for binary/symbol loading.

This further allows more flexibility than the loadAddrMask allows alone in loading kernels and similar. The loadAddrOffset is applied after the loadAddrMask.

Definition at line 63 of file kernel_workload.hh.

Referenced by initState(), KernelWorkload(), and loadAddrOffset().

◆ _start

Addr gem5::KernelWorkload::_start

protected

Definition at line 65 of file kernel_workload.hh.

Referenced by initState(), KernelWorkload(), and start().

◆ commandLine

const std::string gem5::KernelWorkload::commandLine

protected

Definition at line 74 of file kernel_workload.hh.

Referenced by gem5::ArmISA::FsFreebsd::initState(), gem5::ArmISA::FsLinux::initState(), gem5::RiscvISA::FsLinux::initState(), and gem5::X86ISA::FsLinux::initState().

◆ extras

std::vector<loader::ObjectFile *> gem5::KernelWorkload::extras

protected

Definition at line 67 of file kernel_workload.hh.

Referenced by initState(), and KernelWorkload().

◆ image

loader::MemoryImage gem5::KernelWorkload::image

protected

Definition at line 48 of file kernel_workload.hh.

Referenced by initState(), and KernelWorkload().

◆ kernelObj

loader::ObjectFile* gem5::KernelWorkload::kernelObj = nullptr

protected

Definition at line 69 of file kernel_workload.hh.

Referenced by byteOrder(), gem5::ArmISA::FsWorkload::FsWorkload(), gem5::ArmISA::FsWorkload::getArch(), getArch(), getEntry(), gem5::ArmISA::FsFreebsd::initState(), gem5::ArmISA::FsLinux::initState(), gem5::ArmISA::FsWorkload::initState(), initState(), gem5::X86ISA::FsWorkload::initState(), and KernelWorkload().

◆ kernelSymtab

loader::SymbolTable gem5::KernelWorkload::kernelSymtab

protected

Definition at line 72 of file kernel_workload.hh.

Referenced by addKernelFuncEvent(), addKernelFuncEventOrPanic(), gem5::ArmISA::FsFreebsd::initState(), gem5::ArmISA::FsLinux::initState(), insertSymbol(), KernelWorkload(), serialize(), symtab(), and unserialize().

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

sim/kernel_workload.hh
sim/kernel_workload.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KernelWorkload()

Member Function Documentation

◆ addKernelFuncEvent()

◆ addKernelFuncEventOrPanic()

◆ byteOrder()

◆ end()

◆ getArch()

◆ getEntry()

◆ initState()

◆ insertSymbol()

◆ loadAddrMask()

◆ loadAddrOffset()

◆ PARAMS()

◆ serialize()

◆ start()

◆ symtab()

◆ unserialize()

Member Data Documentation

◆ _end

◆ _loadAddrMask

◆ _loadAddrOffset

◆ _start

◆ commandLine

◆ extras

◆ image

◆ kernelObj

◆ kernelSymtab