#include <IdealSRAM.hh>

Inheritance diagram for IdealSRAM:

Collaboration diagram for IdealSRAM:

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

virtual	~IdealSRAM ()

virtual void	write (ULongWord address, MAU data) override

virtual Memory::MAU	read (ULongWord address) override

virtual void	fillWithZeros ()

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	advanceClock ()

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

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 void	reset ()

virtual ULongWord	start ()

virtual ULongWord	end ()

virtual ULongWord	MAUSize ()

bool	isLittleEndian ()

Private Member Functions
	IdealSRAM (const IdealSRAM &)
	Copying not allowed.

IdealSRAM &	operator= (const IdealSRAM &)
	Assignment not allowed.

Private Attributes
UIntWord	start_
	Starting point of the address space.

UIntWord	end_
	End point of the address space.

Word	MAUSize_
	Size of the minimum adressable unit.

MemoryContents *	data_
	Container for holding read/write requests.

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.

An ideal memory is defined as a memory with read latency zero. The data is available at the same cycle in which the load is initiated. Also, after a store is initiated, data is written into memory as soon as the clock advances.

This implementation uses a "paged array" as the storage structure which avoids unnecessary allocation while providing O(1) access time. See PagedArray for more details.

Definition at line 55 of file IdealSRAM.hh.

Constructor & Destructor Documentation

◆ IdealSRAM() [1/2]

IdealSRAM::IdealSRAM	(	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.
wordSize	Number of MAUs that make up a natural word.
align	Alignment of natural words, expressed in number of MAUs.

Definition at line 56 of file IdealSRAM.cc.

                                                                                    :
    Memory(start, end, MAUSize, littleEndian), start_(start), end_(end), 
    MAUSize_(MAUSize) {
    data_ = new MemoryContents(end_ - start_);
}

References data_, end_, and start_.

◆ ~IdealSRAM()

IdealSRAM::~IdealSRAM ( )

virtual

Destructor.

The storage reserved for the memory contents is deallocated. Any data about pending access requests is freed, too.

Definition at line 69 of file IdealSRAM.cc.

                      {
    delete data_;
    data_ = NULL;
}

References data_.

◆ IdealSRAM() [2/2]

IdealSRAM::IdealSRAM ( const IdealSRAM & )

private

Copying not allowed.

Member Function Documentation

◆ fillWithZeros()

void IdealSRAM::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 107 of file IdealSRAM.cc.

                         {
    data_->clear();
}

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

Here is the call graph for this function:

◆ operator=()

IdealSRAM & IdealSRAM::operator= ( const IdealSRAM & )

private

Assignment not allowed.

◆ read() [1/5]

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

overridevirtual

Reads a single memory location.

The fastest way to read the memory.

Parameters

address The address to read.

Returns: The data read.

Implements Memory.

Definition at line 96 of file IdealSRAM.cc.

                                 {
    return data_->readData(address - start_);
}

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

Here is the call graph for this function:

◆ read() [2/5]

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

virtual

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.

Implements Memory.

Definition at line 85 of file Memory.cc.

                        {
    return 0;
}

◆ read() [3/5]

void Memory::read	(	ULongWord	address,
		DoubleWord &	data
	)

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 97 of file Memory.cc.

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

◆ read() [4/5]

void Memory::read	(	ULongWord	address,
		FloatWord &	data
	)

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 98 of file Memory.cc.

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

◆ read() [5/5]

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

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 96 of file Memory.cc.

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

◆ write() [1/5]

void Memory::write	(	ULongWord	address,
		DoubleWord	data
	)

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 95 of file Memory.cc.

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

◆ write() [2/5]

void Memory::write	(	ULongWord	address,
		FloatWord	data
	)

◆ write() [3/5]

void Memory::write	(	ULongWord	address,
		int	count,
		ULongWord	data
	)

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 89 of file Memory.cc.

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

◆ write() [4/5]

void IdealSRAM::write	(	ULongWord	address,
		MAU	data
	)

overridevirtual

Writes a single memory location.

The fastest way to write to the memory.

Parameters

address	The target address.
data	The data to write.

Implements Memory.

Definition at line 83 of file IdealSRAM.cc.

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

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

Here is the call graph for this function:

◆ write() [5/5]

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

virtual

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.

Implements Memory.

Definition at line 84 of file Memory.cc.

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

Member Data Documentation

◆ data_

MemoryContents* IdealSRAM::data_

private

Container for holding read/write requests.

Definition at line 81 of file IdealSRAM.hh.

Referenced by fillWithZeros(), IdealSRAM(), read(), write(), and ~IdealSRAM().

◆ end_

UIntWord IdealSRAM::end_

private

End point of the address space.

Definition at line 77 of file IdealSRAM.hh.

Referenced by IdealSRAM().

◆ MAUSize_

Word IdealSRAM::MAUSize_

private

Size of the minimum adressable unit.

Definition at line 79 of file IdealSRAM.hh.

◆ start_

UIntWord IdealSRAM::start_

private

Starting point of the address space.

Definition at line 75 of file IdealSRAM.hh.

Referenced by IdealSRAM(), read(), and write().

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

◆ IdealSRAM() [1/2]

◆ ~IdealSRAM()

◆ IdealSRAM() [2/2]

Member Function Documentation

◆ fillWithZeros()

◆ operator=()

◆ read() [1/5]

◆ read() [2/5]

◆ read() [3/5]

◆ read() [4/5]

◆ read() [5/5]

◆ write() [1/5]

◆ write() [2/5]

◆ write() [3/5]

◆ write() [4/5]

◆ write() [5/5]

Member Data Documentation

◆ data_

◆ end_

◆ MAUSize_

◆ start_