#include <NullRegisterFile.hh>

Inheritance diagram for TTAMachine::NullRegisterFile:

Collaboration diagram for TTAMachine::NullRegisterFile:

Public Member Functions
virtual Machine *	machine () const

virtual void	ensureRegistration (const Component &component) const

virtual bool	isRegistered () const

virtual bool	hasPort (const std::string &name) const

virtual int	portCount () const

virtual void	setMachine (Machine &mach)

virtual void	unsetMachine ()

virtual int	numberOfRegisters () const

virtual int	width () const

virtual void	setNumberOfRegisters (int registers)

virtual void	setWidth (int width)

virtual int	maxReads () const

virtual int	maxWrites () const

virtual RegisterFile::Type	type () const

virtual bool	isNormal () const

virtual bool	isVolatile () const

virtual bool	isReserved () const

virtual TCEString	name () const

virtual void	setName (const std::string &name)

virtual void	setMaxReads (int reads)

virtual void	setMaxWrites (int maxWrites)

virtual void	setType (RegisterFile::Type type)

virtual int	guardLatency () const

virtual void	setGuardLatency (int latency)

virtual ObjectState *	saveState () const

virtual void	loadState (const ObjectState *state)

Public Member Functions inherited from TTAMachine::RegisterFile
	RegisterFile (const std::string &name, unsigned int size, unsigned int width, unsigned int maxReads, unsigned int maxwrites, unsigned int guardLatency, Type type, bool zeroRegister=false)

	RegisterFile (const ObjectState *state)

virtual	~RegisterFile ()

virtual RegisterFile *	copy () const

virtual bool	isArchitectureEqual (const RegisterFile &rf) const

virtual bool	isUsedAsGuard () const

virtual bool	zeroRegister () const

virtual void	setZeroRegister (const bool &value)

Port *	firstReadPort () const

Port *	firstWritePort () const

Public Member Functions inherited from TTAMachine::BaseRegisterFile
virtual	~BaseRegisterFile ()

virtual int	size () const

virtual RFPort *	port (const std::string &name) const

virtual RFPort *	port (int index) const

Public Member Functions inherited from TTAMachine::Unit
virtual	~Unit ()

virtual int	outputPortCount (bool countBidir=false) const

virtual int	inputPortCount (bool countBidir=false) const

virtual int	bidirPortCount () const

Public Member Functions inherited from TTAMachine::Component
virtual	~Component ()

Public Member Functions inherited from Serializable
virtual	~Serializable ()

Static Public Member Functions
static NullRegisterFile &	instance ()

Private Member Functions
	NullRegisterFile ()

virtual	~NullRegisterFile ()

Static Private Attributes
static NullRegisterFile	instance_
	The only instance.

Additional Inherited Members
Public Types inherited from TTAMachine::RegisterFile
enum	Type { NORMAL , RESERVED , VOLATILE }
	Type of the register file indicates how the RF is used. More...

Static Public Attributes inherited from TTAMachine::RegisterFile
static const std::string	OSNAME_REGISTER_FILE = "reg_file"
	ObjectState name for RegisterFile.

static const std::string	OSKEY_TYPE = "type"
	ObjectState attribute key for register file type.

static const std::string	OSVALUE_NORMAL = "normal"
	ObjectState attribute value for normal register file type.

static const std::string	OSVALUE_RESERVED = "reserved"
	ObjectState attribute value for reserved register file type.

static const std::string	OSVALUE_VOLATILE = "volatile"
	ObjectState attribute value for volatile register file type.

static const std::string	OSKEY_MAX_READS = "max_r"
	ObjectState attribute key for maximum simultaneous readers.

static const std::string	OSKEY_MAX_WRITES = "max_w"
	ObjectState attribute key for maximum simultaneous writers.

static const std::string	OSKEY_GUARD_LATENCY = "g_latency"
	ObjectState attribute key for the guard latency.

static const std::string	OSKEY_ZERO_REGISTER = "zero_register"
	ObjectState attribute key for zero register flag.

Static Public Attributes inherited from TTAMachine::BaseRegisterFile
static const std::string	OSNAME_BASE_REGISTER_FILE = "baseregfile"
	ObjectState name for BaseRegisterFile.

static const std::string	OSKEY_SIZE = "size"
	ObjectState attribute key for the number of registers.

static const std::string	OSKEY_WIDTH = "width"
	ObjectState attribute key for bit width of the registers.

Static Public Attributes inherited from TTAMachine::Unit
static const std::string	OSNAME_UNIT = "unit"
	ObjectState name for Unit.

Static Public Attributes inherited from TTAMachine::Component
static const std::string	OSNAME_COMPONENT = "component"
	ObjectState name for component.

static const std::string	OSKEY_NAME = "name"
	ObjectState attribute key for the name of the component.

Protected Member Functions inherited from TTAMachine::BaseRegisterFile
	BaseRegisterFile (const std::string &name, int size, int width)

	BaseRegisterFile (const ObjectState *state)

Protected Member Functions inherited from TTAMachine::Unit
	Unit (const std::string &name)

	Unit (const ObjectState *state)

virtual void	removePort (Port &port)

Protected Member Functions inherited from TTAMachine::Component
	Component (const std::string &name)

	Component (const ObjectState *state)

void	internalSetMachine (Machine &machine)

void	internalUnsetMachine ()

Protected Member Functions inherited from TTAMachine::MachinePart
	MachinePart ()

virtual	~MachinePart ()

Detailed Description

Null version of RegisterFile class. This is a singleton class.

Definition at line 43 of file NullRegisterFile.hh.

Constructor & Destructor Documentation

◆ NullRegisterFile()

TTAMachine::NullRegisterFile::NullRegisterFile ( )

private

The constructor.

Definition at line 42 of file NullRegisterFile.cc.

                                   :
    RegisterFile("NULL", 1, 1, 1, 1, 0, RegisterFile::NORMAL) {
}

◆ ~NullRegisterFile()

TTAMachine::NullRegisterFile::~NullRegisterFile ( )

privatevirtual

The destructor.

Definition at line 50 of file NullRegisterFile.cc.

50 {

51}

Member Function Documentation

◆ ensureRegistration()

void TTAMachine::NullRegisterFile::ensureRegistration ( const Component & component ) const

virtual

Aborts the program with error message.

Exceptions

IllegalRegistration Never thrown.

Reimplemented from TTAMachine::Component.

Definition at line 81 of file NullRegisterFile.cc.

                                                           {
    abortWithError("ensureRegistration()");
}

References abortWithError.

◆ guardLatency()

int TTAMachine::NullRegisterFile::guardLatency ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 314 of file NullRegisterFile.cc.

                                     {
    abortWithError("guardLatency()");
    return 0;
}

References abortWithError.

◆ hasPort()

bool TTAMachine::NullRegisterFile::hasPort ( const std::string & name ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::Unit.

Definition at line 103 of file NullRegisterFile.cc.

                                                {
    abortWithError("hasPort()");
    return false;
}

References abortWithError.

◆ instance()

NullRegisterFile & TTAMachine::NullRegisterFile::instance ( )

static

Returns the only instance of NullRegisterFile.

Definition at line 58 of file NullRegisterFile.cc.

                           {
    return instance_;
}

References instance_.

◆ isNormal()

bool TTAMachine::NullRegisterFile::isNormal ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 226 of file NullRegisterFile.cc.

                                 {
    abortWithError("isNormal()");
    return false;
}

References abortWithError.

◆ isRegistered()

bool TTAMachine::NullRegisterFile::isRegistered ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::Component.

Definition at line 91 of file NullRegisterFile.cc.

                                     {
    abortWithError("isRegistered()");
    return false;
}

References abortWithError.

◆ isReserved()

bool TTAMachine::NullRegisterFile::isReserved ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 250 of file NullRegisterFile.cc.

                                   {
    abortWithError("isReserved()");
    return false;
}

References abortWithError.

◆ isVolatile()

bool TTAMachine::NullRegisterFile::isVolatile ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 238 of file NullRegisterFile.cc.

                                   {
    abortWithError("isVolatile()");
    return false;
}

References abortWithError.

◆ loadState()

void TTAMachine::NullRegisterFile::loadState ( const ObjectState * state )

virtual

Aborts the program with error message.

Exceptions

ObjectStateLoadingException Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 348 of file NullRegisterFile.cc.

                                              {
    abortWithError("loadState()");
}

References abortWithError.

◆ machine()

Machine * TTAMachine::NullRegisterFile::machine ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::Component.

Definition at line 69 of file NullRegisterFile.cc.

                                {
    abortWithError("machine()");
    return NULL;
}

References abortWithError.

◆ maxReads()

int TTAMachine::NullRegisterFile::maxReads ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 190 of file NullRegisterFile.cc.

                                 {
    abortWithError("maxReads()");
    return 0;
}

References abortWithError.

◆ maxWrites()

int TTAMachine::NullRegisterFile::maxWrites ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 202 of file NullRegisterFile.cc.

                                  {
    abortWithError("maxWrites()");
    return 0;
}

References abortWithError.

◆ name()

TCEString TTAMachine::NullRegisterFile::name ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::Component.

Definition at line 262 of file NullRegisterFile.cc.

                             {
    abortWithError("name()");
    return "";
}

References abortWithError.

◆ numberOfRegisters()

int TTAMachine::NullRegisterFile::numberOfRegisters ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::BaseRegisterFile.

Definition at line 146 of file NullRegisterFile.cc.

                                          {
    abortWithError("numberOfRegisters()");
    return 0;
}

References abortWithError.

◆ portCount()

int TTAMachine::NullRegisterFile::portCount ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::Unit.

Definition at line 115 of file NullRegisterFile.cc.

                                  {
    abortWithError("portCount()");
    return 0;
}

References abortWithError.

◆ saveState()

ObjectState * TTAMachine::NullRegisterFile::saveState ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 336 of file NullRegisterFile.cc.

                                  {
    abortWithError("saveState()");
    return NULL;
}

References abortWithError.

◆ setGuardLatency()

void TTAMachine::NullRegisterFile::setGuardLatency ( int latency )

virtual

Aborts the program with error message.

Exceptions

OutOfRange Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 326 of file NullRegisterFile.cc.

                                     {
    abortWithError("setGuardLatency()");
}

References abortWithError.

◆ setMachine()

void TTAMachine::NullRegisterFile::setMachine ( Machine & mach )

virtual

Aborts the program with error message.

Exceptions

ComponentAlreadyExists Never thrown.

Reimplemented from TTAMachine::Unit.

Definition at line 127 of file NullRegisterFile.cc.

                                     {
    abortWithError("setMachine");
}

References abortWithError.

◆ setMaxReads()

void TTAMachine::NullRegisterFile::setMaxReads ( int reads )

virtual

Aborts the program with error message.

Exceptions

OutOfRange Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 285 of file NullRegisterFile.cc.

                                 {
    abortWithError("setMaxReads()");
}

References abortWithError.

◆ setMaxWrites()

void TTAMachine::NullRegisterFile::setMaxWrites ( int maxWrites )

virtual

Aborts the program with error message.

Exceptions

OutOfRange Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 295 of file NullRegisterFile.cc.

                                  {
    abortWithError("setMaxWrites()");
}

References abortWithError.

◆ setName()

void TTAMachine::NullRegisterFile::setName ( const std::string & name )

virtual

Aborts the program with error message.

Exceptions

ComponentAlreadyExists	Never thrown.
InvalidName	Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 275 of file NullRegisterFile.cc.

                                          {
    abortWithError("setName()");
}

References abortWithError.

◆ setNumberOfRegisters()

void TTAMachine::NullRegisterFile::setNumberOfRegisters ( int registers )

virtual

Aborts the program with error message.

Exceptions

OutOfRange Never thrown.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 170 of file NullRegisterFile.cc.

                                          {
    abortWithError("setNumberOfRegisters()");
}

References abortWithError.

◆ setType()

void TTAMachine::NullRegisterFile::setType ( RegisterFile::Type type )

virtual

Aborts the program with error message.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 303 of file NullRegisterFile.cc.

                                          {
    abortWithError("setType()");
}

References abortWithError.

◆ setWidth()

void TTAMachine::NullRegisterFile::setWidth ( int width )

virtual

Aborts the program with error message.

Exceptions

OutOfRange Never thrown.

Reimplemented from TTAMachine::BaseRegisterFile.

Definition at line 180 of file NullRegisterFile.cc.

                              {
    abortWithError("setWidth()");
}

References abortWithError.

◆ type()

RegisterFile::Type TTAMachine::NullRegisterFile::type ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 214 of file NullRegisterFile.cc.

                             {
    abortWithError("type()");
    return RegisterFile::NORMAL;
}

References abortWithError, and TTAMachine::RegisterFile::NORMAL.

◆ unsetMachine()

void TTAMachine::NullRegisterFile::unsetMachine ( )

virtual

Aborts the program with error message.

Reimplemented from TTAMachine::RegisterFile.

Definition at line 135 of file NullRegisterFile.cc.

                               {
    abortWithError("unsetMachine()");
}

References abortWithError.

◆ width()

int TTAMachine::NullRegisterFile::width ( ) const

virtual

Aborts the program with error message.

Returns: Never returns.

Reimplemented from TTAMachine::BaseRegisterFile.

Definition at line 158 of file NullRegisterFile.cc.

                              {
    abortWithError("width()");
    return 0;
}

References abortWithError.

Member Data Documentation

◆ instance_

NullRegisterFile TTAMachine::NullRegisterFile::instance_

staticprivate

The only instance.

Definition at line 88 of file NullRegisterFile.hh.

Referenced by instance().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NullRegisterFile()

◆ ~NullRegisterFile()

Member Function Documentation

◆ ensureRegistration()

◆ guardLatency()

◆ hasPort()

◆ instance()

◆ isNormal()

◆ isRegistered()

◆ isReserved()

◆ isVolatile()

◆ loadState()

◆ machine()

◆ maxReads()

◆ maxWrites()

◆ name()

◆ numberOfRegisters()

◆ portCount()

◆ saveState()

◆ setGuardLatency()

◆ setMachine()

◆ setMaxReads()

◆ setMaxWrites()

◆ setName()

◆ setNumberOfRegisters()

◆ setType()

◆ setWidth()

◆ type()

◆ unsetMachine()

◆ width()

Member Data Documentation

◆ instance_