EmulatedDriver is an abstract base class for fake SE-mode device drivers. More...

#include <emul_driver.hh>

Inheritance diagram for gem5::EmulatedDriver:

Public Member Functions
	EmulatedDriver (const EmulatedDriverParams &p)

bool	match (const std::string &s) const
	Check for a match with this driver's filename.

virtual int	open (ThreadContext *tc, int mode, int flags)=0
	Abstract method, invoked when the user program calls open() on the device driver.

virtual int	ioctl (ThreadContext *tc, unsigned req, Addr buf)=0
	Abstract method, invoked when the user program calls ioctl() on the file descriptor returned by a previous open().

virtual Addr	mmap (ThreadContext *tc, Addr start, uint64_t length, int prot, int tgtFlags, int tgtFd, off_t offset)
	Virtual method, invoked when the user program calls mmap() on the file descriptor returned by a previous open().

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.

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

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
const std::string &	filename
	filename for opening this driver (under /dev)

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::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

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

Detailed Description

EmulatedDriver is an abstract base class for fake SE-mode device drivers.

Specific drivers that allow applications to communicate with simulated hardware inside gem5 can be created by deriving from this class and overriding the abstract virtual methods.

Currently only open(), ioctl(), and mmap() calls are supported, but other calls (e.g., read(), write()) could be added as needed.

Definition at line 55 of file emul_driver.hh.

Constructor & Destructor Documentation

◆ EmulatedDriver()

gem5::EmulatedDriver::EmulatedDriver ( const EmulatedDriverParams & p )

inline

Definition at line 64 of file emul_driver.hh.

Member Function Documentation

◆ ioctl()

virtual int gem5::EmulatedDriver::ioctl	(	ThreadContext *	tc,
		unsigned	req,
		Addr	buf )

pure virtual

Abstract method, invoked when the user program calls ioctl() on the file descriptor returned by a previous open().

The parameters are the same as those passed in to ioctlFunc() (q.v.).

Returns: The return code for the ioctl, or the negation of the errno (see the SyscallReturn class).

Implemented in gem5::GPUComputeDriver, and gem5::GPURenderDriver.

Referenced by gem5::ioctlFunc().

◆ match()

bool gem5::EmulatedDriver::match ( const std::string & s ) const

inline

Check for a match with this driver's filename.

Definition at line 72 of file emul_driver.hh.

References filename, and gem5::ArmISA::s.

◆ mmap()

virtual Addr gem5::EmulatedDriver::mmap	(	ThreadContext *	tc,
		Addr	start,
		uint64_t	length,
		int	prot,
		int	tgtFlags,
		int	tgtFd,
		off_t	offset )

inlinevirtual

Virtual method, invoked when the user program calls mmap() on the file descriptor returned by a previous open().

The parameters are the same as those passed in to mmapFunc() (q.v.).

Returns: The return ptr for the mmap, or the negation of the errno (see the SyscallReturn class).

Reimplemented in gem5::GPUComputeDriver, and gem5::GPURenderDriver.

Definition at line 98 of file emul_driver.hh.

Referenced by gem5::mmapFunc().

◆ open()

virtual int gem5::EmulatedDriver::open	(	ThreadContext *	tc,
		int	mode,
		int	flags )

pure virtual

Abstract method, invoked when the user program calls open() on the device driver.

The parameters are the same as those passed to openFunc() (q.v.).

Returns: A newly allocated target fd, or -1 on error.

Implemented in gem5::GPUComputeDriver, and gem5::GPURenderDriver.

Referenced by gem5::openatFunc().

Member Data Documentation

◆ filename

const std::string& gem5::EmulatedDriver::filename

protected

filename for opening this driver (under /dev)

Definition at line 61 of file emul_driver.hh.

Referenced by match(), gem5::GPUComputeDriver::open(), and gem5::GPURenderDriver::open().

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

sim/emul_driver.hh

Public Member Functions

Protected Attributes

Additional Inherited Members