An abstract memory represents a contiguous block of physical memory, with an associated address range, and also provides basic functionality for reading and writing this memory without any timing information. More...

#include <abstract_mem.hh>

Inheritance diagram for AbstractMemory:

Public Types
typedef AbstractMemoryParams	Params

Public Types inherited from MemObject
typedef MemObjectParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	AbstractMemory (const Params *p)

virtual	~AbstractMemory ()

void	init () override
	Initialise this memory. More...

bool	isNull () const
	See if this is a null memory that should never store data and always return zero. More...

void	setBackingStore (uint8_t *pmem_addr)
	Set the host memory backing store to be used by this memory controller. More...

const std::list< LockedAddr > &	getLockedAddrList () const
	Get the list of locked addresses to allow checkpointing. More...

void	addLockedAddr (LockedAddr addr)
	Add a locked address to allow for checkpointing. More...

System *	system () const
	read the system pointer Implemented for completeness with the setter More...

void	system (System *sys)
	Set the system pointer on this memory This can't be done via a python parameter because the system needs pointers to all the memories and the reverse would create a cycle in the object graph. More...

const Params *	params () const

AddrRange	getAddrRange () const
	Get the address range. More...

uint64_t	size () const
	Get the memory size. More...

Addr	start () const
	Get the start address. More...

bool	isConfReported () const
	Should this memory be passed to the kernel and part of the OS physical memory layout. More...

bool	isInAddrMap () const
	Some memories are used as shadow memories or should for other reasons not be part of the global address map. More...

bool	isKvmMap () const
	When shadow memories are in use, KVM may want to make one or the other, but cannot map both into the guest address space. More...

void	access (PacketPtr pkt)
	Perform an untimed memory access and update all the state (e.g. More...

void	functionalAccess (PacketPtr pkt)
	Perform an untimed memory read or write without changing anything but the memory itself. More...

void	regStats () override
	Register Statistics. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

virtual BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a master port with a given name and index. More...

virtual BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...

virtual void	resetStats ()
	Reset statistics associated with this object. More...

virtual void	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

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

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

Public Member Functions inherited from Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section. More...

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object. More...

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...

virtual void	notifyFork ()
	Notify a child process of a fork. More...

Public Member Functions inherited from Clocked
void	updateClockPeriod () const
	Update the tick to the current tick. More...

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
bool	checkLockedAddrList (PacketPtr pkt)

void	trackLoadLocked (PacketPtr pkt)

bool	writeOK (PacketPtr pkt)

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

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

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

Protected Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

Protected Attributes
AddrRange	range

uint8_t *	pmemAddr

const bool	confTableReported

const bool	inAddrMap

const bool	kvmMap

std::list< LockedAddr >	lockedAddrList

Stats::Vector	bytesRead
	Number of total bytes read from this memory. More...

Stats::Vector	bytesInstRead
	Number of instruction bytes read from this memory. More...

Stats::Vector	bytesWritten
	Number of bytes written to this memory. More...

Stats::Vector	numReads
	Number of read requests. More...

Stats::Vector	numWrites
	Number of write requests. More...

Stats::Vector	numOther
	Number of other requests. More...

Stats::Formula	bwRead
	Read bandwidth from this memory. More...

Stats::Formula	bwInstRead
	Read bandwidth from this memory. More...

Stats::Formula	bwWrite
	Write bandwidth from this memory. More...

Stats::Formula	bwTotal
	Total bandwidth from this memory. More...

System *	_system
	Pointor to the System object. More...

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Private Member Functions
	AbstractMemory (const AbstractMemory &)

AbstractMemory &	operator= (const AbstractMemory &)

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Detailed Description

An abstract memory represents a contiguous block of physical memory, with an associated address range, and also provides basic functionality for reading and writing this memory without any timing information.

It is a MemObject since any subclass must have at least one slave port.

Definition at line 103 of file abstract_mem.hh.

Member Typedef Documentation

typedef AbstractMemoryParams AbstractMemory::Params

Definition at line 195 of file abstract_mem.hh.

Constructor & Destructor Documentation

AbstractMemory::AbstractMemory ( const AbstractMemory & )

private

AbstractMemory::AbstractMemory ( const Params * p )

Definition at line 58 of file abstract_mem.cc.

virtual AbstractMemory::~AbstractMemory ( )

inlinevirtual

Definition at line 198 of file abstract_mem.hh.

Member Function Documentation

void AbstractMemory::access ( PacketPtr pkt )

Perform an untimed memory access and update all the state (e.g.

locked addresses) and statistics accordingly. The packet is turned into a response if required.

Parameters

pkt	Packet performing the access

Definition at line 327 of file abstract_mem.cc.

References bytesInstRead, bytesRead, bytesWritten, Packet::cacheResponding(), MemCmd::CleanEvict, Packet::cmd, DPRINTF, Packet::getAddr(), Packet::getAtomicOp(), Packet::getConstPtr(), Request::getExtraData(), Packet::getPtr(), Packet::getSize(), Packet::isAtomicOp(), Request::isCondSwap(), Request::isInstFetch(), Packet::isInvalidate(), Packet::isLLSC(), Packet::isRead(), AddrRange::isSubset(), Packet::isWrite(), Packet::makeResponse(), Request::masterId(), Packet::needsResponse(), numOther, numReads, numWrites, panic, pmemAddr, range, Packet::req, AddrRange::start(), MemCmd::SwapReq, TRACE_PACKET, trackLoadLocked(), MemCmd::WritebackClean, and writeOK().

Referenced by DRAMSim2::accessAndRespond(), DRAMCtrl::accessAndRespond(), RubyPort::MemSlavePort::hitCallback(), SimpleMemory::recvAtomic(), DRAMSim2::recvAtomic(), and DRAMCtrl::recvAtomic().

void AbstractMemory::addLockedAddr ( LockedAddr addr )

inline

Add a locked address to allow for checkpointing.

Definition at line 230 of file abstract_mem.hh.

References lockedAddrList.

bool AbstractMemory::checkLockedAddrList ( PacketPtr pkt )

protected

Definition at line 230 of file abstract_mem.cc.

References Request::contextId(), DPRINTF, ThreadContext::getCpuPtr(), Request::getPaddr(), System::getThreadContext(), ArmISA::i, Packet::isLLSC(), lockedAddrList, LockedAddr::mask(), Packet::req, Request::setExtraData(), system(), ThreadContext::threadId(), and BaseCPU::wakeup().

Referenced by writeOK().

void AbstractMemory::functionalAccess ( PacketPtr pkt )

Perform an untimed memory read or write without changing anything but the memory itself.

No stats are affected by this access. In addition to normal accesses this also facilitates print requests.

Parameters

pkt	Packet performing the access

Definition at line 428 of file abstract_mem.cc.

References ccprintf(), Packet::cmdString(), Packet::PrintReqState::curPrefix(), Packet::getAddr(), Packet::getConstPtr(), Packet::getPtr(), Packet::getSize(), Packet::isPrint(), Packet::isRead(), Packet::isWrite(), Packet::makeResponse(), Packet::PrintReqState::os, panic, pmemAddr, Packet::PrintReqState::printLabels(), range, Packet::senderState, AddrRange::start(), and TRACE_PACKET.

Referenced by RubyPort::MemSlavePort::recvFunctional(), SimpleMemory::recvFunctional(), DRAMSim2::recvFunctional(), and DRAMCtrl::recvFunctional().

AddrRange AbstractMemory::getAddrRange ( ) const

Get the address range.

Returns: a single contigous address range

Definition at line 191 of file abstract_mem.cc.

References range.

const std::list<LockedAddr>& AbstractMemory::getLockedAddrList ( ) const

inline

Get the list of locked addresses to allow checkpointing.

Definition at line 224 of file abstract_mem.hh.

References lockedAddrList.

void AbstractMemory::init ( )

overridevirtual

Initialise this memory.

Reimplemented from SimObject.

Reimplemented in DRAMCtrl, DRAMSim2, and SimpleMemory.

Definition at line 66 of file abstract_mem.cc.

References _system, System::getPageBytes(), panic, size(), and system().

Referenced by SimpleMemory::init(), DRAMSim2::init(), and DRAMCtrl::init().

bool AbstractMemory::isConfReported ( ) const

inline

Should this memory be passed to the kernel and part of the OS physical memory layout.

Returns: if this memory is reported

Definition at line 278 of file abstract_mem.hh.

References confTableReported.

bool AbstractMemory::isInAddrMap ( ) const

inline

Some memories are used as shadow memories or should for other reasons not be part of the global address map.

Returns: if this memory is part of the address map

Definition at line 286 of file abstract_mem.hh.

References inAddrMap.

bool AbstractMemory::isKvmMap ( ) const

inline

When shadow memories are in use, KVM may want to make one or the other, but cannot map both into the guest address space.

Returns: if this memory should be mapped into the KVM guest address space

Definition at line 294 of file abstract_mem.hh.

References kvmMap.

bool AbstractMemory::isNull ( ) const

inline

See if this is a null memory that should never store data and always return zero.

Returns: true if null

Definition at line 211 of file abstract_mem.hh.

References params().

AbstractMemory& AbstractMemory::operator= ( const AbstractMemory & )

private

const Params* AbstractMemory::params ( ) const

inline

Definition at line 246 of file abstract_mem.hh.

References SimObject::_params.

Referenced by isNull().

void AbstractMemory::regStats ( )

overridevirtual

Register Statistics.

Reimplemented from SimObject.

Reimplemented in DRAMCtrl.

Definition at line 81 of file abstract_mem.cc.

References bwInstRead, bwRead, bwTotal, bwWrite, bytesInstRead, bytesRead, bytesWritten, Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::DataWrap< Derived, InfoProxyType >::flags(), ArmISA::i, Stats::VectorBase< Derived, Stor >::init(), System::maxMasters(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::nonan, Stats::nozero, numOther, numReads, numWrites, Stats::DataWrap< Derived, InfoProxyType >::precision(), Stats::DataWrap< Derived, InfoProxyType >::prereq(), ClockedObject::regStats(), simSeconds, Stats::DataWrapVec< Derived, InfoProxyType >::subname(), system(), and Stats::total.

Referenced by DRAMCtrl::regStats().

void AbstractMemory::setBackingStore ( uint8_t * pmem_addr )

Set the host memory backing store to be used by this memory controller.

Parameters

pmem_addr Pointer to a segment of host memory

Definition at line 75 of file abstract_mem.cc.

References pmemAddr.

uint64_t AbstractMemory::size ( ) const

inline

Get the memory size.

Returns: the size of the memory

Definition at line 263 of file abstract_mem.hh.

References range, and AddrRange::size().

Referenced by DRAMCtrl::addToReadQueue(), DRAMCtrl::addToWriteQueue(), DRAMCtrl::DRAMCtrl(), init(), and DRAMCtrl::recvTimingReq().

Addr AbstractMemory::start ( ) const

inline

Get the start address.

Returns: the start address of the memory

Definition at line 270 of file abstract_mem.hh.

References range, and AddrRange::start().

System* AbstractMemory::system ( ) const

inline

read the system pointer Implemented for completeness with the setter

Returns: pointer to the system object

Definition at line 235 of file abstract_mem.hh.

References _system.

Referenced by checkLockedAddrList(), DRAMCtrl::drainResume(), DRAMSim2::init(), init(), DRAMCtrl::init(), regStats(), and DRAMCtrl::startup().

void AbstractMemory::system ( System * sys )

inline

Set the system pointer on this memory This can't be done via a python parameter because the system needs pointers to all the memories and the reverse would create a cycle in the object graph.

An init() this is set.

Parameters

sys	system pointer to set

Definition at line 243 of file abstract_mem.hh.

References _system.

void AbstractMemory::trackLoadLocked ( PacketPtr pkt )

protected

Definition at line 199 of file abstract_mem.cc.

References Request::contextId(), DPRINTF, Request::getPaddr(), ArmISA::i, lockedAddrList, LockedAddr::mask(), and Packet::req.

Referenced by access().

bool AbstractMemory::writeOK ( PacketPtr pkt )

inlineprotected

Definition at line 142 of file abstract_mem.hh.

References checkLockedAddrList(), Packet::isLLSC(), lockedAddrList, Packet::req, and Request::setExtraData().

Referenced by access().

Member Data Documentation

System* AbstractMemory::_system

protected

Pointor to the System object.

This is used for getting the number of masters in the system which is needed when registering stats

Definition at line 182 of file abstract_mem.hh.

Referenced by init(), and system().

Stats::Formula AbstractMemory::bwInstRead

protected

Read bandwidth from this memory.

Definition at line 172 of file abstract_mem.hh.

Referenced by regStats().

Stats::Formula AbstractMemory::bwRead

protected

Read bandwidth from this memory.

Definition at line 170 of file abstract_mem.hh.

Referenced by regStats().

Stats::Formula AbstractMemory::bwTotal

protected

Total bandwidth from this memory.

Definition at line 176 of file abstract_mem.hh.

Referenced by regStats().

Stats::Formula AbstractMemory::bwWrite

protected

Write bandwidth from this memory.

Definition at line 174 of file abstract_mem.hh.

Referenced by regStats().

Stats::Vector AbstractMemory::bytesInstRead

protected

Number of instruction bytes read from this memory.

Definition at line 160 of file abstract_mem.hh.

Referenced by access(), and regStats().

Stats::Vector AbstractMemory::bytesRead

protected

Number of total bytes read from this memory.

Definition at line 158 of file abstract_mem.hh.

Referenced by access(), and regStats().

Stats::Vector AbstractMemory::bytesWritten

protected

Number of bytes written to this memory.

Definition at line 162 of file abstract_mem.hh.

Referenced by access(), and regStats().

const bool AbstractMemory::confTableReported

protected

Definition at line 114 of file abstract_mem.hh.

Referenced by isConfReported().

const bool AbstractMemory::inAddrMap

protected

Definition at line 117 of file abstract_mem.hh.

Referenced by isInAddrMap().

const bool AbstractMemory::kvmMap

protected

Definition at line 120 of file abstract_mem.hh.

Referenced by isKvmMap().

std::list<LockedAddr> AbstractMemory::lockedAddrList

protected

Definition at line 122 of file abstract_mem.hh.

Referenced by addLockedAddr(), checkLockedAddrList(), getLockedAddrList(), trackLoadLocked(), and writeOK().

Stats::Vector AbstractMemory::numOther

protected

Number of other requests.

Definition at line 168 of file abstract_mem.hh.

Referenced by access(), and regStats().

Stats::Vector AbstractMemory::numReads

protected

Number of read requests.

Definition at line 164 of file abstract_mem.hh.

Referenced by access(), and regStats().

Stats::Vector AbstractMemory::numWrites

protected

Number of write requests.

Definition at line 166 of file abstract_mem.hh.

Referenced by access(), and regStats().

uint8_t* AbstractMemory::pmemAddr

protected

Definition at line 111 of file abstract_mem.hh.

Referenced by access(), functionalAccess(), and setBackingStore().

AddrRange AbstractMemory::range

protected

Definition at line 108 of file abstract_mem.hh.

Referenced by access(), functionalAccess(), getAddrRange(), DRAMCtrl::init(), size(), and start().

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

mem/abstract_mem.hh
mem/abstract_mem.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation