#include <DirectAccessMemory.hh>

Inheritance diagram for DirectAccessMemory:

Collaboration diagram for DirectAccessMemory:

Public Member Functions
	DirectAccessMemory (ULongWord start, ULongWord end, Word MAUSize, bool littleEndian)

virtual	~DirectAccessMemory ()

void	write (ULongWord address, Memory::MAU data) override

void	fastWriteMAU (ULongWord address, ULongWord data)

void	fastWrite2MAUsBE (ULongWord address, ULongWord data)

void	fastWrite4MAUsBE (ULongWord address, ULongWord data)

void	fastWrite2MAUsLE (ULongWord address, ULongWord data)

void	fastWrite4MAUsLE (ULongWord address, ULongWord data)

Memory::MAU	read (ULongWord address) override

void	fastReadMAU (ULongWord address, ULongWord &data)

void	fastRead2MAUsBE (ULongWord address, ULongWord &data)

void	fastRead4MAUsBE (ULongWord address, ULongWord &data)

void	fastRead2MAUsLE (ULongWord address, ULongWord &data)

void	fastRead4MAUsLE (ULongWord address, ULongWord &data)

virtual void	advanceClock ()

virtual void	reset ()

virtual void	fillWithZeros ()

void	writeBE (ULongWord address, int count, ULongWord data) override

virtual void	write (ULongWord address, MAU data)=0

void	write (ULongWord address, int size, ULongWord data)

void	write (ULongWord address, FloatWord data)

void	write (ULongWord address, DoubleWord data)

virtual Memory::MAU	read (ULongWord address)=0

void	read (ULongWord address, int size, ULongWord &data)

void	read (ULongWord address, DoubleWord &data)

void	read (ULongWord address, FloatWord &data)

Public Member Functions inherited from Memory
	Memory (ULongWord start, ULongWord end, ULongWord MAUSize, bool littleEndian_)

virtual	~Memory ()

virtual void	writeLE (ULongWord address, int size, ULongWord data)

void	write (ULongWord address, int size, ULongWord data)

virtual void	writeDirectlyBE (ULongWord address, int size, ULongWord data)

virtual void	writeDirectlyLE (ULongWord address, int size, ULongWord data)

void	write (ULongWord address, FloatWord data)

void	write (ULongWord address, DoubleWord data)

void	read (ULongWord address, int size, ULongWord &data)

void	read (ULongWord address, DoubleWord &data)

void	read (ULongWord address, FloatWord &data)

virtual void	writeBE (ULongWord address, FloatWord data)

virtual void	writeBE (ULongWord address, DoubleWord data)

virtual void	writeLE (ULongWord address, FloatWord data)

virtual void	writeLE (ULongWord address, DoubleWord data)

virtual void	readBE (ULongWord address, int size, ULongWord &data)

virtual void	readLE (ULongWord address, int size, ULongWord &data)

virtual void	readBE (ULongWord address, FloatWord &data)

virtual void	readBE (ULongWord address, DoubleWord &data)

virtual void	readLE (ULongWord address, FloatWord &data)

virtual void	readLE (ULongWord address, DoubleWord &data)

virtual ULongWord	start ()

virtual ULongWord	end ()

virtual ULongWord	MAUSize ()

bool	isLittleEndian ()

Private Member Functions
	DirectAccessMemory (const DirectAccessMemory &)
	Copying not allowed. More...

DirectAccessMemory &	operator= (const DirectAccessMemory &)
	Assignment not allowed. More...

Private Attributes
Word	start_
	Starting point of the address space. More...

Word	end_
	End point of the address space. More...

Word	MAUSize_
	Size of the minimum adressable unit. More...

Word	MAUSize3_
	precalculated MAUSize_ * 3 More...

Word	MAUSize2_
	precalculated MAUSize_ * 2 More...

Word	wordSize_
	Size of the natural word as MAUs. More...

Word	mask_
	Mask bit pattern for unpacking IntWord to MAUs. More...

MemoryContents *	data_
	Contains MAUs of the memory model, that is, the actual data of the memory. More...

Additional Inherited Members
Public Types inherited from Memory
typedef MinimumAddressableUnit	MAU

typedef MAU *	MAUTable

Protected Member Functions inherited from Memory
void	packBE (const Memory::MAUTable data, int size, ULongWord &value)

void	unpackBE (const ULongWord &value, int size, Memory::MAUTable data)

void	packLE (const Memory::MAUTable data, int size, ULongWord &value)

void	unpackLE (const ULongWord &value, int size, Memory::MAUTable data)

Protected Attributes inherited from Memory
bool	littleEndian_

Detailed Description

Class that models an "ideal" memory to which updates are visible immediately.

This model is used in compiled simulation. It does not require an advance clock call: all writes to it are visible immediately. Thus, one has to make sure that all reads in the same cycle are executed before writes in order for the reads to read the old values.

Note that all range checking is disabled for fastest possible simulation model. In case you are unsure of your simulated input correctness, use the old simulation engine for verification.

Definition at line 55 of file DirectAccessMemory.hh.

Constructor & Destructor Documentation

◆ DirectAccessMemory() [1/2]

DirectAccessMemory::DirectAccessMemory	(	ULongWord	start,
		ULongWord	end,
		Word	MAUSize,
		bool	littleEndian
	)

Constructor. Create a model for a given memory.

The created memory model is empty. No data is allocated for its contents.

Parameters

start	First address of the memory.
end	Last address of the memory.
MAUSize	Bit width of the minimum addressable unit of the memory.

Note: In C++, when shifting more bits than there are in integer, the result is undefined. Thus, we just set the mask to ~0 in this case. We should probably give user a warning if MAUSize is larger than the integer size!

Definition at line 55 of file DirectAccessMemory.cc.

                                                                      :
     Memory(start, end, MAUSize, littleEndian), 
     start_(start), end_(end), MAUSize_(MAUSize),
     MAUSize3_(MAUSize_ * 3), MAUSize2_(MAUSize_ * 2) {
         
     /// @note In C++, when shifting more bits than there are in integer, the
     /// result is undefined. Thus, we just set the mask to ~0 in this case.
     /// We should probably give user a warning if MAUSize is larger than 
     /// the integer size!
     if (MAUSize_ >= static_cast<Word>(std::numeric_limits<Word>::digits)) {
         mask_ = ~0u;
     } else {
         mask_ = ~(~0u << MAUSize_);
     }
  
     data_ = new MemoryContents(end_ - start_);
 }

References data_, end_, mask_, MAUSize_, and start_.

◆ ~DirectAccessMemory()

DirectAccessMemory::~DirectAccessMemory ( )

virtual

Destructor.

Definition at line 78 of file DirectAccessMemory.cc.

                                         {
     delete data_;
     data_ = NULL;
 }

References data_.

◆ DirectAccessMemory() [2/2]

DirectAccessMemory::DirectAccessMemory ( const DirectAccessMemory & )

private

Copying not allowed.

Member Function Documentation

◆ advanceClock()

virtual void DirectAccessMemory::advanceClock ( )

inlinevirtual

Advances clock for one cycle.

Commits all pending write requests to the memory. Cannot throw an exception, request legality is checked when request is initiated.

Reimplemented from Memory.

Definition at line 108 of file DirectAccessMemory.hh.

108 {}

◆ fastRead2MAUsBE()

void DirectAccessMemory::fastRead2MAUsBE	(	ULongWord	address,
		ULongWord &	data
	)

Reads 2 MAUs from the memory as fast as possible in BE

Parameters

address	address to read
data	reference to the read data

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 236 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data = data_->readData(index) << MAUSize_;
     data |= data_->readData(index + 1);
 }

References data_, MAUSize_, PagedArray< ValueType, PageSize, DefaultValue >::readData(), and start_.

Here is the call graph for this function:

◆ fastRead2MAUsLE()

void DirectAccessMemory::fastRead2MAUsLE	(	ULongWord	address,
		ULongWord &	data
	)

Reads 2 MAUs from the memory as fast as possible in LE

Parameters

address	address to read
data	reference to the read data

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 251 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data = data_->readData(index +1) << MAUSize_;
     data |= data_->readData(index);
 }

References data_, MAUSize_, PagedArray< ValueType, PageSize, DefaultValue >::readData(), and start_.

Here is the call graph for this function:

◆ fastRead4MAUsBE()

void DirectAccessMemory::fastRead4MAUsBE	(	ULongWord	address,
		ULongWord &	data
	)

Reads 4 MAUs from the memory as fast as possible in BE

Parameters

address	address to read
data	reference to the read data

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 266 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data = data_->readData(index) << MAUSize3_;
     data |= data_->readData(index + 1) << MAUSize2_;
     data |= data_->readData(index + 2) << MAUSize_;
     data |= data_->readData(index + 3);
 }

References data_, MAUSize2_, MAUSize3_, MAUSize_, PagedArray< ValueType, PageSize, DefaultValue >::readData(), and start_.

Here is the call graph for this function:

◆ fastRead4MAUsLE()

void DirectAccessMemory::fastRead4MAUsLE	(	ULongWord	address,
		ULongWord &	data
	)

Reads 4 MAUs from the memory as fast as possible in LE

Parameters

address	address to read
data	reference to the read data

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 283 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data = data_->readData(index + 3) << MAUSize3_;
     data |= data_->readData(index + 2) << MAUSize2_;
     data |= data_->readData(index + 1) << MAUSize_;
     data |= data_->readData(index);
 }

References data_, MAUSize2_, MAUSize3_, MAUSize_, PagedArray< ValueType, PageSize, DefaultValue >::readData(), and start_.

Here is the call graph for this function:

◆ fastReadMAU()

void DirectAccessMemory::fastReadMAU	(	ULongWord	address,
		ULongWord &	data
	)

Reads 1 MAU from the memory as fast as possible

Parameters

address	address to read
data	reference to the read data

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 223 of file DirectAccessMemory.cc.

                                                                   {
     data = data_->readData(address - start_);
 }

References data_, PagedArray< ValueType, PageSize, DefaultValue >::readData(), and start_.

Referenced by read().

Here is the call graph for this function:

◆ fastWrite2MAUsBE()

void DirectAccessMemory::fastWrite2MAUsBE	(	ULongWord	address,
		ULongWord	data
	)

Writes 2 MAUs to the memory as fast as possible

Parameters

address	address to write
data	data to be written

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 159 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data_->writeData(index, (int)((data >> MAUSize_) & mask_));
     data_->writeData(index + 1, (int)(data & mask_));
 }

References data_, mask_, MAUSize_, start_, and PagedArray< ValueType, PageSize, DefaultValue >::writeData().

Here is the call graph for this function:

◆ fastWrite2MAUsLE()

void DirectAccessMemory::fastWrite2MAUsLE	(	ULongWord	address,
		ULongWord	data
	)

Writes 2 MAUs to the memory as fast as possible in little Endian

Parameters

address	address to write
data	data to be written

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 174 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data_->writeData(index + 1, (int)((data >> MAUSize_) & mask_));
     data_->writeData(index, (int)(data & mask_));
 }

References data_, mask_, MAUSize_, start_, and PagedArray< ValueType, PageSize, DefaultValue >::writeData().

Here is the call graph for this function:

◆ fastWrite4MAUsBE()

void DirectAccessMemory::fastWrite4MAUsBE	(	ULongWord	address,
		ULongWord	data
	)

Writes 4 MAUs to the memory as fast as possible in BE.

Parameters

address	address to write
data	data to be written

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 189 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data_->writeData(index, (int)((data >> MAUSize3_) & mask_));
     data_->writeData(index + 1, (int)((data >> MAUSize2_) & mask_));
     data_->writeData(index + 2, (int)((data >> MAUSize_) & mask_));
     data_->writeData(index + 3, (int)(data & mask_));
 }

References data_, mask_, MAUSize2_, MAUSize3_, MAUSize_, start_, and PagedArray< ValueType, PageSize, DefaultValue >::writeData().

Here is the call graph for this function:

◆ fastWrite4MAUsLE()

void DirectAccessMemory::fastWrite4MAUsLE	(	ULongWord	address,
		ULongWord	data
	)

Writes 4 MAUs to the memory as fast as possible in LE

Parameters

address	address to write
data	data to be written

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 206 of file DirectAccessMemory.cc.

                                                                       {
     const Word index = address - start_;
     data_->writeData(index + 3, (int)((data >> MAUSize3_) & mask_));
     data_->writeData(index + 2, (int)((data >> MAUSize2_) & mask_));
     data_->writeData(index + 1, (int)((data >> MAUSize_) & mask_));
     data_->writeData(index, (int)(data & mask_));
 }

References data_, mask_, MAUSize2_, MAUSize3_, MAUSize_, start_, and PagedArray< ValueType, PageSize, DefaultValue >::writeData().

Here is the call graph for this function:

◆ fastWriteMAU()

void DirectAccessMemory::fastWriteMAU	(	ULongWord	address,
		ULongWord	data
	)

Writes 1 MAU to the memory as fast as possible

Parameters

address	address to write
data	data to be written

Note: No bounds checking is made so the address is assumed to be in range.; On a cycle with read and write, make sure the read is done first !

Definition at line 146 of file DirectAccessMemory.cc.

                                                                   {
     data_->writeData(address - start_, (int)(data & mask_));
 }

References data_, mask_, start_, and PagedArray< ValueType, PageSize, DefaultValue >::writeData().

Referenced by write().

Here is the call graph for this function:

◆ fillWithZeros()

void DirectAccessMemory::fillWithZeros ( )

virtual

Fills the whole memory with zeros.

This is needed due to some buggy simulated programs which expect uninitialized data to be zero.

Reimplemented from Memory.

Definition at line 90 of file DirectAccessMemory.cc.

                                   {
     data_->clear();
 }

References PagedArray< ValueType, PageSize, DefaultValue >::clear(), and data_.

Here is the call graph for this function:

◆ operator=()

DirectAccessMemory& DirectAccessMemory::operator= ( const DirectAccessMemory & )

private

Assignment not allowed.

◆ read() [1/5]

Memory::MAU DirectAccessMemory::read ( ULongWord address )

overridevirtual

Reads a single MAU using the fastest possible method.

Parameters

address The address.

Returns: Data.

Implements Memory.

Definition at line 131 of file DirectAccessMemory.cc.

                                           {
     ULongWord data = 0;
     fastReadMAU(address, data);
     return data;
 }

References fastReadMAU().

Here is the call graph for this function:

◆ read() [2/5]

Memory::MAU Memory::read

Reads a single memory location.

Must be implemented in the derived class. No range checking. The fastest way to read the memory.

Parameters

address The address to read.

Returns: The data read.

Definition at line 160 of file Memory.cc.

                         {
     return 0;
 }

◆ read() [3/5]

void Memory::read

A convenience method for reading data from the memory and interpreting it as a DoubleWord in order set by endian bit of memory.

Note: Currently works only if MAU == 8 bits. asserts otherwise.

Parameters

address	The address to read.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Definition at line 513 of file Memory.cc.

                                                 {
     if (littleEndian_) {
         readLE(address, data);
     } else {
         readBE(address, data);
     }
 }

◆ read() [4/5]

void Memory::read

A convenience method for reading data from the memory and interpreting it as a FloatWord in order set by the memory.

Note: Currently works only if MAU == 8 bits. asserts otherwise.

Parameters

address	The address to read.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Definition at line 329 of file Memory.cc.

                                                {
     if (littleEndian_) {
         readLE(address, data);
     } else {
         readBE(address, data);
     }
 }

◆ read() [5/5]

void Memory::read

A convenience method for reading units of data from the memory.

The data is written to an UIntWord.

Parameters

address	The address to read.
count	Number of MAUs to read.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Definition at line 663 of file Memory.cc.

                                                          {
     if (littleEndian_) {
         readLE(address, size, data);
     } else {
         readBE(address, size, data);
     }
 }

◆ reset()

virtual void DirectAccessMemory::reset ( )

inlinevirtual

Resets the memory.

Clears any pending write requests.

Reimplemented from Memory.

Definition at line 109 of file DirectAccessMemory.hh.

109 {}

◆ write() [1/5]

void Memory::write

A convenience method for writing a DoubleWord to the memory.

Note: Currently works only if MAU == 8 bits. asserts otherwise.

Parameters

address	The address to write.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Definition at line 531 of file Memory.cc.

                                                 {
     if (littleEndian_) {
         writeLE(address, data);
     } else {
         writeBE(address, data);
     }
 }

◆ write() [2/5]

void Memory::write

◆ write() [3/5]

void Memory::write

A convenience method for writing units of data to the memory.

The data is stored in an UIntWord.

Parameters

address	The address to write.
count	Number of MAUs to write.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Definition at line 175 of file Memory.cc.

                                                           {
     if (littleEndian_) {
         writeLE(address, count, data);
     } else {
         writeBE(address, count, data);
     }
 }

◆ write() [4/5]

void Memory::write

Writes a single memory location.

Must be implemented in the derived class. No range checking. The fastest way to write to the memory.

Parameters

address	The target address.
data	The data to write.

Definition at line 95 of file Memory.cc.

                             {
     abortWithError("Must be implemented in the derived class.");
 }

◆ write() [5/5]

void DirectAccessMemory::write	(	ULongWord	address,
		Memory::MAU	data
	)

overridevirtual

Writes a single MAU using the fastest possible method.

Parameters

address	The address.
data	The data.

Implements Memory.

Definition at line 101 of file DirectAccessMemory.cc.

                                                            {
     fastWriteMAU(address, data);
 }

References fastWriteMAU().

Here is the call graph for this function:

◆ writeBE()

void DirectAccessMemory::writeBE	(	ULongWord	address,
		int	count,
		ULongWord	data
	)

overridevirtual

A convenience method for writing units of data to the memory.

The data is stored in an UIntWord.

Parameters

address	The address to write.
count	Number of MAUs to write.
data	The data to write.

Exceptions

OutOfRange in case the address is out of range of the memory.

Reimplemented from Memory.

Definition at line 116 of file DirectAccessMemory.cc.

                                                                         {
     Memory::writeBE(address, count,  data);
     // compiled simulator does not call advance clock of
     // memories at every cycle for efficiency, so we have
     // to "flush" the writes right away
     Memory::advanceClock();
 }

References Memory::advanceClock(), and Memory::writeBE().

Here is the call graph for this function:

Member Data Documentation

◆ data_

MemoryContents* DirectAccessMemory::data_

private

Contains MAUs of the memory model, that is, the actual data of the memory.

Definition at line 140 of file DirectAccessMemory.hh.

Referenced by DirectAccessMemory(), fastRead2MAUsBE(), fastRead2MAUsLE(), fastRead4MAUsBE(), fastRead4MAUsLE(), fastReadMAU(), fastWrite2MAUsBE(), fastWrite2MAUsLE(), fastWrite4MAUsBE(), fastWrite4MAUsLE(), fastWriteMAU(), fillWithZeros(), and ~DirectAccessMemory().

◆ end_

Word DirectAccessMemory::end_

private

End point of the address space.

Definition at line 127 of file DirectAccessMemory.hh.

Referenced by DirectAccessMemory().

◆ mask_

Word DirectAccessMemory::mask_

private

Mask bit pattern for unpacking IntWord to MAUs.

Definition at line 137 of file DirectAccessMemory.hh.

Referenced by DirectAccessMemory(), fastWrite2MAUsBE(), fastWrite2MAUsLE(), fastWrite4MAUsBE(), fastWrite4MAUsLE(), and fastWriteMAU().

◆ MAUSize2_

Word DirectAccessMemory::MAUSize2_

private

precalculated MAUSize_ * 2

Definition at line 133 of file DirectAccessMemory.hh.

Referenced by fastRead4MAUsBE(), fastRead4MAUsLE(), fastWrite4MAUsBE(), and fastWrite4MAUsLE().

◆ MAUSize3_

Word DirectAccessMemory::MAUSize3_

private

precalculated MAUSize_ * 3

Definition at line 131 of file DirectAccessMemory.hh.

Referenced by fastRead4MAUsBE(), fastRead4MAUsLE(), fastWrite4MAUsBE(), and fastWrite4MAUsLE().

◆ MAUSize_

Word DirectAccessMemory::MAUSize_

private

Size of the minimum adressable unit.

Definition at line 129 of file DirectAccessMemory.hh.

Referenced by DirectAccessMemory(), fastRead2MAUsBE(), fastRead2MAUsLE(), fastRead4MAUsBE(), fastRead4MAUsLE(), fastWrite2MAUsBE(), fastWrite2MAUsLE(), fastWrite4MAUsBE(), and fastWrite4MAUsLE().

◆ start_

Word DirectAccessMemory::start_

private

Starting point of the address space.

Definition at line 125 of file DirectAccessMemory.hh.

Referenced by DirectAccessMemory(), fastRead2MAUsBE(), fastRead2MAUsLE(), fastRead4MAUsBE(), fastRead4MAUsLE(), fastReadMAU(), fastWrite2MAUsBE(), fastWrite2MAUsLE(), fastWrite4MAUsBE(), fastWrite4MAUsLE(), and fastWriteMAU().

◆ wordSize_

Word DirectAccessMemory::wordSize_

private

Size of the natural word as MAUs.

Definition at line 135 of file DirectAccessMemory.hh.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirectAccessMemory() [1/2]

◆ ~DirectAccessMemory()

◆ DirectAccessMemory() [2/2]

Member Function Documentation

◆ advanceClock()

◆ fastRead2MAUsBE()

◆ fastRead2MAUsLE()

◆ fastRead4MAUsBE()

◆ fastRead4MAUsLE()

◆ fastReadMAU()

◆ fastWrite2MAUsBE()

◆ fastWrite2MAUsLE()

◆ fastWrite4MAUsBE()

◆ fastWrite4MAUsLE()

◆ fastWriteMAU()

◆ fillWithZeros()

◆ operator=()

◆ read() [1/5]

◆ read() [2/5]

◆ read() [3/5]

◆ read() [4/5]

◆ read() [5/5]

◆ reset()

◆ write() [1/5]

◆ write() [2/5]

◆ write() [3/5]

◆ write() [4/5]

◆ write() [5/5]

◆ writeBE()

Member Data Documentation

◆ data_

◆ end_

◆ mask_

◆ MAUSize2_

◆ MAUSize3_

◆ MAUSize_

◆ start_

◆ wordSize_