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:

Classes
struct	MemStats

Public Types
typedef AbstractMemoryParams	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	initState () override
	initState() is called on each SimObject when not restoring from a checkpoint. 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...

uint8_t *	toHostAddr (Addr addr) const
	Transform a gem5 address space address into its physical counterpart in the host address space. 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...

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...

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

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. 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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index. 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
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)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue. More...

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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 Stats::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::Info *info)
	Register a stat with this group. More...

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object. More...

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object. More...

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block. More...

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from Clocked
void	updateClockPeriod ()
	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...

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...

Protected Attributes
AddrRange	range

uint8_t *	pmemAddr

MemBackdoor	backdoor

const bool	confTableReported

const bool	inAddrMap

const bool	kvmMap

std::list< LockedAddr >	lockedAddrList

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

AbstractMemory::MemStats	stats

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 ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes inherited from ClockedObject
PowerState *	powerState

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 ClockedObject since subclasses may need timing information.

Definition at line 104 of file abstract_mem.hh.

Member Typedef Documentation

◆ Params

typedef AbstractMemoryParams AbstractMemory::Params

Definition at line 207 of file abstract_mem.hh.

Constructor & Destructor Documentation

◆ AbstractMemory() [1/2]

AbstractMemory::AbstractMemory ( const AbstractMemory & )

private

◆ AbstractMemory() [2/2]

AbstractMemory::AbstractMemory ( const Params * p )

Definition at line 57 of file abstract_mem.cc.

References panic_if, range, AddrRange::size(), AddrRange::to_string(), and AddrRange::valid().

◆ ~AbstractMemory()

virtual AbstractMemory::~AbstractMemory ( )

inlinevirtual

Definition at line 210 of file abstract_mem.hh.

Member Function Documentation

◆ access()

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 373 of file abstract_mem.cc.

References AbstractMemory::MemStats::bytesInstRead, AbstractMemory::MemStats::bytesRead, AbstractMemory::MemStats::bytesWritten, Packet::cacheResponding(), MemCmd::CleanEvict, Packet::cmd, DPRINTF, Packet::fromCache(), Packet::getAddr(), Packet::getAddrRange(), Packet::getAtomicOp(), Packet::getSize(), Packet::isAtomicOp(), Packet::isClean(), Packet::isInvalidate(), Packet::isLLSC(), Packet::isRead(), AddrRange::isSubset(), Packet::isWrite(), Packet::makeResponse(), Packet::needsResponse(), AbstractMemory::MemStats::numOther, AbstractMemory::MemStats::numReads, AbstractMemory::MemStats::numWrites, panic, panic_if, pmemAddr, Packet::print(), range, Packet::req, Packet::setData(), stats, MemCmd::SwapReq, toHostAddr(), TRACE_PACKET, trackLoadLocked(), MemCmd::WritebackClean, Packet::writeData(), and writeOK().

Referenced by DRAMSim2::accessAndRespond(), DRAMsim3::accessAndRespond(), MemCtrl::accessAndRespond(), RubyPort::MemResponsePort::hitCallback(), QoS::MemSinkCtrl::processNextReqEvent(), SimpleMemory::recvAtomic(), DRAMSim2::recvAtomic(), DRAMsim3::recvAtomic(), QoS::MemSinkCtrl::recvAtomic(), and MemCtrl::recvAtomic().

◆ addLockedAddr()

void AbstractMemory::addLockedAddr ( LockedAddr addr )

inline

Add a locked address to allow for checkpointing.

Definition at line 239 of file abstract_mem.hh.

References addr, and lockedAddrList.

◆ checkLockedAddrList()

bool AbstractMemory::checkLockedAddrList ( PacketPtr pkt )

protected

Definition at line 281 of file abstract_mem.cc.

References DPRINTF, ArmISA::globalClearExclusive(), ArmISA::i, InvalidContextID, Packet::isLLSC(), lockedAddrList, LockedAddr::mask(), Packet::req, system(), and System::threads.

Referenced by writeOK().

◆ functionalAccess()

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 475 of file abstract_mem.cc.

References ccprintf(), Packet::cmdString(), Packet::PrintReqState::curPrefix(), Packet::getAddr(), Packet::getAddrRange(), Packet::isPrint(), Packet::isRead(), AddrRange::isSubset(), Packet::isWrite(), Packet::makeResponse(), Packet::PrintReqState::os, panic, pmemAddr, Packet::PrintReqState::printLabels(), range, Packet::senderState, Packet::setData(), toHostAddr(), TRACE_PACKET, and Packet::writeData().

Referenced by initState(), SimpleMemory::recvFunctional(), DRAMSim2::recvFunctional(), DRAMsim3::recvFunctional(), QoS::MemSinkCtrl::recvFunctional(), and MemCtrl::recvFunctional().

◆ getAddrRange()

AddrRange AbstractMemory::getAddrRange ( ) const

Get the address range.

Returns: a single contigous address range

Definition at line 242 of file abstract_mem.cc.

References range.

Referenced by MemCtrl::accessAndRespond(), MemCtrl::recvAtomic(), MemCtrl::recvFunctional(), and MemCtrl::recvTimingReq().

◆ getLockedAddrList()

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

inline

Get the list of locked addresses to allow checkpointing.

Definition at line 233 of file abstract_mem.hh.

References lockedAddrList.

◆ initState()

void AbstractMemory::initState ( )

overridevirtual

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

This provides a hook for state initializations that are only required for a "cold start".

Reimplemented from SimObject.

Definition at line 72 of file abstract_mem.cc.

References System::cacheLineSize(), AddrRange::contains(), Loader::createObjectFile(), Loader::debugSymbolTable, fatal_if, functionalAccess(), SimObject::initState(), Loader::SymbolTable::insert(), AddrRange::isSubset(), Loader::MemoryImage::maxAddr(), Loader::MemoryImage::minAddr(), SimObject::name(), Loader::MemoryImage::offset(), panic_if, params(), range, AddrRange::start(), system(), AddrRange::to_string(), warn, and Loader::MemoryImage::write().

◆ isConfReported()

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 300 of file abstract_mem.hh.

References confTableReported.

◆ isInAddrMap()

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 308 of file abstract_mem.hh.

References inAddrMap.

◆ isKvmMap()

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 316 of file abstract_mem.hh.

References kvmMap.

◆ isNull()

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 220 of file abstract_mem.hh.

References params().

◆ operator=()

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

private

◆ params()

const Params* AbstractMemory::params ( ) const

inline

Definition at line 255 of file abstract_mem.hh.

References SimObject::_params.

Referenced by initState(), and isNull().

◆ setBackingStore()

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 103 of file abstract_mem.cc.

References backdoor, AddrRange::interleaved(), MemBackdoor::invalidate(), pmemAddr, MemBackdoor::ptr(), and range.

◆ size()

uint64_t AbstractMemory::size ( ) const

inline

Get the memory size.

Returns: the size of the memory

Definition at line 285 of file abstract_mem.hh.

References range, and AddrRange::size().

Referenced by MemInterface::decodePacket(), and DRAMInterface::DRAMInterface().

◆ start()

Addr AbstractMemory::start ( ) const

inline

Get the start address.

Returns: the start address of the memory

Definition at line 292 of file abstract_mem.hh.

References range, and AddrRange::start().

◆ system() [1/2]

System* AbstractMemory::system ( ) const

inline

read the system pointer Implemented for completeness with the setter

Returns: pointer to the system object

Definition at line 244 of file abstract_mem.hh.

References _system.

Referenced by checkLockedAddrList(), DRAMSim2::init(), DRAMsim3::init(), DRAMInterface::init(), initState(), DRAMInterface::startup(), and DRAMsim3::tick().

◆ system() [2/2]

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 252 of file abstract_mem.hh.

References _system.

◆ toHostAddr()

uint8_t* AbstractMemory::toHostAddr ( Addr addr ) const

inline

Transform a gem5 address space address into its physical counterpart in the host address space.

Parameters

addr	Address in gem5's address space.

Returns: Pointer to the corresponding memory address of the host.

Definition at line 275 of file abstract_mem.hh.

References addr, pmemAddr, range, and AddrRange::start().

Referenced by access(), and functionalAccess().

◆ trackLoadLocked()

void AbstractMemory::trackLoadLocked ( PacketPtr pkt )

protected

Definition at line 250 of file abstract_mem.cc.

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

Referenced by access().

◆ writeOK()

bool AbstractMemory::writeOK ( PacketPtr pkt )

inlineprotected

Definition at line 146 of file abstract_mem.hh.

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

Referenced by access().

Member Data Documentation

◆ _system

System* AbstractMemory::_system

protected

Pointer to the System object.

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

Definition at line 165 of file abstract_mem.hh.

Referenced by system().

◆ backdoor

MemBackdoor AbstractMemory::backdoor

protected

Definition at line 115 of file abstract_mem.hh.

Referenced by SimpleMemory::recvAtomicBackdoor(), and setBackingStore().

◆ confTableReported

const bool AbstractMemory::confTableReported

protected

Definition at line 118 of file abstract_mem.hh.

Referenced by isConfReported().

◆ inAddrMap

const bool AbstractMemory::inAddrMap

protected

Definition at line 121 of file abstract_mem.hh.

Referenced by isInAddrMap().

◆ kvmMap

const bool AbstractMemory::kvmMap

protected

Definition at line 124 of file abstract_mem.hh.

Referenced by isKvmMap().

◆ lockedAddrList

std::list<LockedAddr> AbstractMemory::lockedAddrList

protected

Definition at line 126 of file abstract_mem.hh.

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

◆ pmemAddr

uint8_t* AbstractMemory::pmemAddr

protected

Definition at line 112 of file abstract_mem.hh.

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

◆ range

AddrRange AbstractMemory::range

protected

Definition at line 109 of file abstract_mem.hh.

Referenced by AbstractMemory(), access(), functionalAccess(), getAddrRange(), MemInterface::getCtrlAddr(), DRAMInterface::init(), initState(), setBackingStore(), size(), start(), and toHostAddr().

◆ stats

AbstractMemory::MemStats AbstractMemory::stats

protected

Referenced by access().

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

mem/abstract_mem.hh
mem/abstract_mem.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ AbstractMemory() [1/2]

◆ AbstractMemory() [2/2]

◆ ~AbstractMemory()

Member Function Documentation

◆ access()

◆ addLockedAddr()

◆ checkLockedAddrList()

◆ functionalAccess()

◆ getAddrRange()

◆ getLockedAddrList()

◆ initState()

◆ isConfReported()

◆ isInAddrMap()

◆ isKvmMap()

◆ isNull()

◆ operator=()

◆ params()

◆ setBackingStore()

◆ size()

◆ start()

◆ system() [1/2]

◆ system() [2/2]

◆ toHostAddr()

◆ trackLoadLocked()

◆ writeOK()

Member Data Documentation

◆ _system

◆ backdoor

◆ confTableReported

◆ inAddrMap

◆ kvmMap

◆ lockedAddrList

◆ pmemAddr

◆ range

◆ stats