base plugin class that provides access to different plugin functions if present More...

#include <Plugin.h>

Inheritance diagram for etiss::Plugin:

[legend]

Collaboration diagram for etiss::Plugin:

[legend]

Public Member Functions
virtual	~Plugin ()

unsigned	getType ()

InterruptListenerPlugin *	getInterruptListenerPlugin ()

CoroutinePlugin *	getCoroutinePlugin ()

SystemWrapperPlugin *	getSystemWrapperPlugin ()

RegisterDevicePlugin *	getRegisterDevicePlugin ()

TranslationPlugin *	getTranslationPlugin ()

std::string	getPluginName () const

const std::string &	getLastAssignedCoreName ()

std::string	toString () const

Public Member Functions inherited from etiss::ToString
	ToString ()

virtual	~ToString ()

Static Public Attributes
static const unsigned	INTERRUPTLISTENER = 1 << 0
	access to translated code

static const unsigned	COROUTINE = 1 << 1
	callback after execution of each translated block

static const unsigned	SYSTEMWRAPPER = 1 << 2
	can wrap/change ETISS_System structure at execution start

static const unsigned	REGISTERDEVICE
	gets noticed of changes to special registers (e.g. mmu register etc. [depends on architecture])

static const unsigned	TRANSLATION
	access to translated code during translation phase or when instruction tree is built

Protected Member Functions
	Plugin (unsigned type=0)

virtual std::string	_getPluginName () const =0

virtual void	init (ETISS_CPU cpu, ETISS_System system, CPUArch *arch)
	this function is called before the plugin is used in the cpu execution loop (etiss::CPUCore::execute).

virtual void	cleanup ()
	this function is called after cpu execution loop (etiss::CPUCore::execute) finished.

void	setCorrespondingCPUCoreName (std::string name)

virtual void	addedToCPUCore (etiss::CPUCore *core)
	called as soon a plugin has been added to its CPUCore.

virtual void	removedFromCPUCore (etiss::CPUCore *core)
	called as soon a plugin has been removed from its CPUCore.

Protected Attributes
ETISS_CPU *	plugin_cpu_
	holds a pointer to the cpu structure. will be set before init call and after cleanup call

ETISS_System *	plugin_system_
	holds a pointer to the system structure.

CPUArch *	plugin_arch_
	holds a pointer to the CPUArch instance. will be set before init call and after cleanup call

CPUCore *	plugin_core_
	holds a pointer to the associated CPUCore instance.

Private Attributes
unsigned	type_

std::string	name_
	contains a name that is build from the return value of getPluginName_() + the implemented interfaces of a plugin

InterruptListenerPlugin *	tplugin_

SystemWrapperPlugin *	splugin_

CoroutinePlugin *	cplugin_

RegisterDevicePlugin *	rplugin_

TranslationPlugin *	trplugin_

std::string	lastAssignedCoreName_

Friends
class	InterruptListenerPlugin

class	TranslationPlugin

class	CoroutinePlugin

class	SystemWrapperPlugin

class	RegisterDevicePlugin

class	CPUCore

Detailed Description

base plugin class that provides access to different plugin functions if present

See also: InterruptListenerPlugin; CoroutinePlugin; SystemWrapperPlugin; RegisterDevicePlugin

Definition at line 37 of file Plugin.h.

Constructor & Destructor Documentation

◆ Plugin()

Plugin::Plugin ( unsigned type = 0 )

protected

Definition at line 19 of file Plugin.cpp.

◆ ~Plugin()

Plugin::~Plugin ( )

virtual

Definition at line 34 of file Plugin.cpp.

Member Function Documentation

◆ _getPluginName()

virtual std::string etiss::Plugin::_getPluginName ( ) const

protectedpure virtual

Implemented in etiss::CPUArch, etiss::plugin::errorInjection::BlockAccurateHandler, etiss::plugin::InstructionAccurateCallback, etiss::plugin::InstructionSpecificAddressCallback, etiss::plugin::Logger, etiss::plugin::PrintInstruction, etiss::plugin::VariableValueLogger, etiss::InterruptHandler, etiss::mm::DMMUWrapper, etiss::DataSheetAccurateTiming, TracePrinter, and etiss::plugin::gdb::Server.

Referenced by getPluginName().

Here is the caller graph for this function:

◆ addedToCPUCore()

virtual void etiss::Plugin::addedToCPUCore ( etiss::CPUCore * core )

inlineprotectedvirtual

called as soon a plugin has been added to its CPUCore.

this method explicitly allows to configure/manipulate the cpu core and doesn't run into deadlock if a synchronized CPUCore function is called.

Definition at line 170 of file Plugin.h.

◆ cleanup()

void Plugin::cleanup ( )

protectedvirtual

this function is called after cpu execution loop (etiss::CPUCore::execute) finished.

Only the SystemWrapperPlugin::unwrap function is called AFTER Plugin::cleanup

Reimplemented in etiss::plugin::errorInjection::BlockAccurateHandler, TracePrinter, and etiss::plugin::gdb::Server.

Definition at line 37 of file Plugin.cpp.

◆ getCoroutinePlugin()

CoroutinePlugin * etiss::Plugin::getCoroutinePlugin ( )

inline

Returns: a pointer to an implemented CoroutinePlugin

Definition at line 73 of file Plugin.h.

References cplugin_.

◆ getInterruptListenerPlugin()

InterruptListenerPlugin * etiss::Plugin::getInterruptListenerPlugin ( )

inline

Returns: a pointer to an implemented InterruptListenerPlugin

Definition at line 69 of file Plugin.h.

References tplugin_.

Referenced by etiss::CPUCore::InterruptVectorWrapper::setBit().

Here is the caller graph for this function:

◆ getLastAssignedCoreName()

const std::string & etiss::Plugin::getLastAssignedCoreName ( )

inline

Note: Every Plugin is assigned to an CPUCore. When the CPUCore is destructed this Function can be used to get the CoreName again. Especially for needed for Core Specific Configurations

Returns: Name of the Core which was last assigned to this Plugin

Definition at line 135 of file Plugin.h.

References lastAssignedCoreName_.

◆ getPluginName()

std::string etiss::Plugin::getPluginName ( ) const

inline

Returns: a plugin name consisting of the value returned by Plugin::_getPluginName and a list of implemented interfaces

Definition at line 91 of file Plugin.h.

References _getPluginName(), COROUTINE, INTERRUPTLISTENER, name_, REGISTERDEVICE, SYSTEMWRAPPER, TRANSLATION, and type_.

Referenced by etiss::CPUCore::execute(), and toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegisterDevicePlugin()

RegisterDevicePlugin * etiss::Plugin::getRegisterDevicePlugin ( )

inline

Returns: a pointer to an implemented RegisterDevicePlugin

Definition at line 81 of file Plugin.h.

References rplugin_.

◆ getSystemWrapperPlugin()

SystemWrapperPlugin * etiss::Plugin::getSystemWrapperPlugin ( )

inline

Returns: a pointer to an implemented SystemWrapperPlugin

Definition at line 77 of file Plugin.h.

References splugin_.

◆ getTranslationPlugin()

TranslationPlugin * etiss::Plugin::getTranslationPlugin ( )

inline

Returns: a pointer to an implemented RegisterDevicePlugin

Definition at line 86 of file Plugin.h.

References trplugin_.

Referenced by etiss::Translation::init().

Here is the caller graph for this function:

◆ getType()

unsigned etiss::Plugin::getType ( )

inline

Returns: an integer that has the appropriate bits set for its implemented plugin types (Plugin::INTERRUPTLISTENER,Plugin::COROUTINE,Plugin::SYSTEMWRAPPER,Plugin::REGISTERDEVICE)

Definition at line 65 of file Plugin.h.

References type_.

◆ init()

void Plugin::init	(	ETISS_CPU *	cpu,
		ETISS_System *	system,
		CPUArch *	arch
	)

protectedvirtual

this function is called before the plugin is used in the cpu execution loop (etiss::CPUCore::execute).

Only exception is the SystemWrapperPlugin whose SystemWrapperPlugin::wrap function is called BEFORE Plugin::init

Reimplemented in etiss::plugin::errorInjection::BlockAccurateHandler, etiss::plugin::gdb::Server, and TracePrinter.

Definition at line 36 of file Plugin.cpp.

◆ removedFromCPUCore()

virtual void etiss::Plugin::removedFromCPUCore ( etiss::CPUCore * core )

inlineprotectedvirtual

called as soon a plugin has been removed from its CPUCore.

similar to addedToCPUCore() it is possible to modify the CPUCore

Definition at line 175 of file Plugin.h.

Referenced by etiss::CPUCore::removePlugin().

Here is the caller graph for this function:

◆ setCorrespondingCPUCoreName()

void etiss::Plugin::setCorrespondingCPUCoreName ( std::string name )

inlineprotected

Definition at line 164 of file Plugin.h.

References lastAssignedCoreName_.

Referenced by etiss::CPUArch::CPUArch().

Here is the caller graph for this function:

◆ toString()

std::string etiss::Plugin::toString ( ) const

inline

Definition at line 137 of file Plugin.h.

References getPluginName().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ CoroutinePlugin

friend class CoroutinePlugin

friend

Definition at line 41 of file Plugin.h.

◆ CPUCore

friend class CPUCore

friend

Definition at line 44 of file Plugin.h.

◆ InterruptListenerPlugin

friend class InterruptListenerPlugin

friend

Definition at line 39 of file Plugin.h.

◆ RegisterDevicePlugin

friend class RegisterDevicePlugin

friend

Definition at line 43 of file Plugin.h.

◆ SystemWrapperPlugin

friend class SystemWrapperPlugin

friend

Definition at line 42 of file Plugin.h.

◆ TranslationPlugin

friend class TranslationPlugin

friend

Definition at line 40 of file Plugin.h.

Member Data Documentation

◆ COROUTINE

const unsigned etiss::Plugin::COROUTINE = 1 << 1

static

callback after execution of each translated block

Definition at line 54 of file Plugin.h.

Referenced by etiss::CoroutinePlugin::CoroutinePlugin(), and getPluginName().

◆ cplugin_

CoroutinePlugin* etiss::Plugin::cplugin_

private

Definition at line 183 of file Plugin.h.

Referenced by etiss::CoroutinePlugin::CoroutinePlugin(), and getCoroutinePlugin().

◆ INTERRUPTLISTENER

const unsigned etiss::Plugin::INTERRUPTLISTENER = 1 << 0

static

access to translated code

Definition at line 53 of file Plugin.h.

Referenced by getPluginName(), and etiss::InterruptListenerPlugin::InterruptListenerPlugin().

◆ lastAssignedCoreName_

std::string etiss::Plugin::lastAssignedCoreName_

private

Definition at line 186 of file Plugin.h.

Referenced by getLastAssignedCoreName(), and setCorrespondingCPUCoreName().

◆ name_

std::string etiss::Plugin::name_

mutableprivate

contains a name that is build from the return value of getPluginName_() + the implemented interfaces of a plugin

Definition at line 179 of file Plugin.h.

Referenced by getPluginName().

◆ plugin_arch_

CPUArch* etiss::Plugin::plugin_arch_

protected

holds a pointer to the CPUArch instance. will be set before init call and after cleanup call

Definition at line 159 of file Plugin.h.

◆ plugin_core_

CPUCore* etiss::Plugin::plugin_core_

protected

holds a pointer to the associated CPUCore instance.

this pointer is valid as long a plugin is associtated with a cpu core. use with caution since this pointer may change in a non threadsafe manner.

Definition at line 160 of file Plugin.h.

Referenced by etiss::plugin::InstructionAccurateCallback::call_on_entry(), etiss::plugin::errorInjection::BlockAccurateHandler::execute(), etiss::plugin::VariableValueLogger::finalizeInstrSet(), etiss::plugin::gdb::Server::handlePacket(), etiss::CPUCore::removePlugin(), and etiss::plugin::VariableValueLogger::writeValue().

◆ plugin_cpu_

ETISS_CPU* etiss::Plugin::plugin_cpu_

protected

holds a pointer to the cpu structure. will be set before init call and after cleanup call

Definition at line 155 of file Plugin.h.

Referenced by etiss::plugin::InstructionAccurateCallback::call_on_entry(), etiss::plugin::fault::SwitchSystem::dread(), etiss::plugin::fault::SwitchSystem::dwrite(), etiss::InterruptHandler::execute(), etiss::plugin::fault::SwitchSystem::iread(), etiss::plugin::fault::SwitchSystem::iwrite(), and etiss::plugin::VariableValueLogger::writeValue().

◆ plugin_system_

ETISS_System* etiss::Plugin::plugin_system_

protected

holds a pointer to the system structure.

will be set before init call and after cleanup call

Definition at line 156 of file Plugin.h.

Referenced by etiss::plugin::fault::SwitchSystem::dread(), etiss::plugin::fault::SwitchSystem::dwrite(), etiss::plugin::fault::SwitchSystem::iread(), and etiss::plugin::fault::SwitchSystem::iwrite().

◆ REGISTERDEVICE

const unsigned etiss::Plugin::REGISTERDEVICE

static

Initial value:

=

1 << 3

gets noticed of changes to special registers (e.g. mmu register etc. [depends on architecture])

Definition at line 56 of file Plugin.h.

Referenced by getPluginName(), and etiss::RegisterDevicePlugin::RegisterDevicePlugin().

◆ rplugin_

RegisterDevicePlugin* etiss::Plugin::rplugin_

private

Definition at line 184 of file Plugin.h.

Referenced by getRegisterDevicePlugin(), and etiss::RegisterDevicePlugin::RegisterDevicePlugin().

◆ splugin_

SystemWrapperPlugin* etiss::Plugin::splugin_

private

Definition at line 182 of file Plugin.h.

Referenced by getSystemWrapperPlugin(), and etiss::SystemWrapperPlugin::SystemWrapperPlugin().

◆ SYSTEMWRAPPER

const unsigned etiss::Plugin::SYSTEMWRAPPER = 1 << 2

static

can wrap/change ETISS_System structure at execution start

Definition at line 55 of file Plugin.h.

Referenced by getPluginName(), and etiss::SystemWrapperPlugin::SystemWrapperPlugin().

◆ tplugin_

InterruptListenerPlugin* etiss::Plugin::tplugin_

private

Definition at line 181 of file Plugin.h.

Referenced by getInterruptListenerPlugin(), and etiss::InterruptListenerPlugin::InterruptListenerPlugin().

◆ TRANSLATION

const unsigned etiss::Plugin::TRANSLATION

static

Initial value:

=

1 << 4

access to translated code during translation phase or when instruction tree is built

Definition at line 58 of file Plugin.h.

Referenced by getPluginName(), and etiss::TranslationPlugin::TranslationPlugin().

◆ trplugin_

TranslationPlugin* etiss::Plugin::trplugin_

private

Definition at line 185 of file Plugin.h.

Referenced by getTranslationPlugin(), and etiss::TranslationPlugin::TranslationPlugin().

◆ type_

unsigned etiss::Plugin::type_

private

Definition at line 178 of file Plugin.h.

Referenced by etiss::CoroutinePlugin::CoroutinePlugin(), getPluginName(), getType(), etiss::InterruptListenerPlugin::InterruptListenerPlugin(), etiss::RegisterDevicePlugin::RegisterDevicePlugin(), etiss::SystemWrapperPlugin::SystemWrapperPlugin(), and etiss::TranslationPlugin::TranslationPlugin().

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

/home/runner/work/etiss/etiss/include/etiss/Plugin.h
/home/runner/work/etiss/etiss/src/Plugin.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Plugin()

◆ ~Plugin()

Member Function Documentation

◆ _getPluginName()

◆ addedToCPUCore()

◆ cleanup()

◆ getCoroutinePlugin()

◆ getInterruptListenerPlugin()

◆ getLastAssignedCoreName()

◆ getPluginName()

◆ getRegisterDevicePlugin()

◆ getSystemWrapperPlugin()

◆ getTranslationPlugin()

◆ getType()

◆ init()

◆ removedFromCPUCore()

◆ setCorrespondingCPUCoreName()

◆ toString()

Friends And Related Symbol Documentation

◆ CoroutinePlugin

◆ CPUCore

◆ InterruptListenerPlugin

◆ RegisterDevicePlugin

◆ SystemWrapperPlugin

◆ TranslationPlugin

Member Data Documentation

◆ COROUTINE

◆ cplugin_

◆ INTERRUPTLISTENER

◆ lastAssignedCoreName_

◆ name_

◆ plugin_arch_

◆ plugin_core_

◆ plugin_cpu_

◆ plugin_system_

◆ REGISTERDEVICE

◆ rplugin_

◆ splugin_

◆ SYSTEMWRAPPER

◆ tplugin_

◆ TRANSLATION

◆ trplugin_

◆ type_