gem5  v21.1.0.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
gem5::memory::AbstractMemory Class Reference

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 gem5::memory::AbstractMemory:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::memory::CfiMemory gem5::memory::DRAMSim2 gem5::memory::DRAMsim3 gem5::memory::MemInterface gem5::memory::qos::MemSinkInterface gem5::memory::SimpleMemory gem5::memory::DRAMInterface gem5::memory::NVMInterface

Classes

struct  MemStats
 

Public Member Functions

 PARAMS (AbstractMemory)
 
 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...
 
void getBackdoor (MemBackdoorPtr &bd_ptr)
 
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...
 
Systemsystem () 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...
 
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 gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::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 gem5::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 gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (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< LockedAddrlockedAddrList
 
System_system
 Pointer to the System object. More...
 
gem5::memory::AbstractMemory::MemStats stats
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Member Functions

 AbstractMemory (const AbstractMemory &)
 
AbstractMemoryoperator= (const AbstractMemory &)
 

Additional Inherited Members

- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

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

Constructor & Destructor Documentation

◆ AbstractMemory() [1/2]

gem5::memory::AbstractMemory::AbstractMemory ( const AbstractMemory )
private

◆ AbstractMemory() [2/2]

gem5::memory::AbstractMemory::AbstractMemory ( const Params p)

◆ ~AbstractMemory()

virtual gem5::memory::AbstractMemory::~AbstractMemory ( )
inlinevirtual

Definition at line 217 of file abstract_mem.hh.

Member Function Documentation

◆ access()

void gem5::memory::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
pktPacket performing the access

Definition at line 380 of file abstract_mem.cc.

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

Referenced by gem5::memory::DRAMSim2::accessAndRespond(), gem5::memory::DRAMsim3::accessAndRespond(), gem5::memory::MemCtrl::accessAndRespond(), gem5::ruby::RubyPort::MemResponsePort::hitCallback(), gem5::memory::qos::MemSinkCtrl::processNextReqEvent(), gem5::memory::CfiMemory::read(), gem5::memory::SimpleMemory::recvAtomic(), gem5::memory::DRAMSim2::recvAtomic(), gem5::memory::DRAMsim3::recvAtomic(), gem5::memory::qos::MemSinkCtrl::recvAtomic(), gem5::memory::MemCtrl::recvAtomic(), and gem5::memory::CfiMemory::write().

◆ addLockedAddr()

void gem5::memory::AbstractMemory::addLockedAddr ( LockedAddr  addr)
inline

Add a locked address to allow for checkpointing.

Definition at line 257 of file abstract_mem.hh.

References gem5::X86ISA::addr, backdoor, gem5::MemBackdoor::invalidate(), and lockedAddrList.

◆ checkLockedAddrList()

bool gem5::memory::AbstractMemory::checkLockedAddrList ( PacketPtr  pkt)
protected

◆ functionalAccess()

void gem5::memory::AbstractMemory::functionalAccess ( PacketPtr  pkt)

◆ getAddrRange()

AddrRange gem5::memory::AbstractMemory::getAddrRange ( ) const

Get the address range.

Returns
a single contigous address range

Definition at line 250 of file abstract_mem.cc.

References range.

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

◆ getBackdoor()

void gem5::memory::AbstractMemory::getBackdoor ( MemBackdoorPtr bd_ptr)
inline

◆ getLockedAddrList()

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

Get the list of locked addresses to allow checkpointing.

Definition at line 248 of file abstract_mem.hh.

References lockedAddrList.

◆ initState()

void gem5::memory::AbstractMemory::initState ( )
overridevirtual

◆ isConfReported()

bool gem5::memory::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 316 of file abstract_mem.hh.

References confTableReported.

◆ isInAddrMap()

bool gem5::memory::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 324 of file abstract_mem.hh.

References inAddrMap.

◆ isKvmMap()

bool gem5::memory::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 332 of file abstract_mem.hh.

References kvmMap.

◆ isNull()

bool gem5::memory::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 227 of file abstract_mem.hh.

References gem5::SimObject::params().

◆ operator=()

AbstractMemory& gem5::memory::AbstractMemory::operator= ( const AbstractMemory )
private

◆ PARAMS()

gem5::memory::AbstractMemory::PARAMS ( AbstractMemory  )

◆ setBackingStore()

void gem5::memory::AbstractMemory::setBackingStore ( uint8_t *  pmem_addr)

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

Parameters
pmem_addrPointer to a segment of host memory

Definition at line 106 of file abstract_mem.cc.

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

◆ size()

uint64_t gem5::memory::AbstractMemory::size ( ) const
inline

Get the memory size.

Returns
the size of the memory

Definition at line 301 of file abstract_mem.hh.

References range, and gem5::AddrRange::size().

Referenced by gem5::memory::MemInterface::decodePacket(), gem5::memory::DRAMInterface::DRAMInterface(), and gem5::memory::CfiMemory::ProgramBuffer::write().

◆ start()

Addr gem5::memory::AbstractMemory::start ( ) const
inline

Get the start address.

Returns
the start address of the memory

Definition at line 308 of file abstract_mem.hh.

References range, and gem5::AddrRange::start().

Referenced by gem5::memory::CfiMemory::read(), and gem5::memory::CfiMemory::write().

◆ system() [1/2]

System* gem5::memory::AbstractMemory::system ( ) const
inline

read the system pointer Implemented for completeness with the setter

Returns
pointer to the system object

Definition at line 266 of file abstract_mem.hh.

References _system.

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

◆ system() [2/2]

void gem5::memory::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
syssystem pointer to set

Definition at line 274 of file abstract_mem.hh.

References _system.

◆ toHostAddr()

uint8_t* gem5::memory::AbstractMemory::toHostAddr ( Addr  addr) const
inline

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

Parameters
addrAddress in gem5's address space.
Returns
Pointer to the corresponding memory address of the host.

Definition at line 291 of file abstract_mem.hh.

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

Referenced by access(), and functionalAccess().

◆ trackLoadLocked()

void gem5::memory::AbstractMemory::trackLoadLocked ( PacketPtr  pkt)
protected

◆ writeOK()

bool gem5::memory::AbstractMemory::writeOK ( PacketPtr  pkt)
inlineprotected

Definition at line 152 of file abstract_mem.hh.

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

Referenced by access().

Member Data Documentation

◆ _system

System* gem5::memory::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 171 of file abstract_mem.hh.

Referenced by system().

◆ backdoor

MemBackdoor gem5::memory::AbstractMemory::backdoor
protected

◆ confTableReported

const bool gem5::memory::AbstractMemory::confTableReported
protected

Definition at line 124 of file abstract_mem.hh.

Referenced by isConfReported().

◆ inAddrMap

const bool gem5::memory::AbstractMemory::inAddrMap
protected

Definition at line 127 of file abstract_mem.hh.

Referenced by isInAddrMap().

◆ kvmMap

const bool gem5::memory::AbstractMemory::kvmMap
protected

Definition at line 130 of file abstract_mem.hh.

Referenced by isKvmMap().

◆ lockedAddrList

std::list<LockedAddr> gem5::memory::AbstractMemory::lockedAddrList
protected

◆ pmemAddr

uint8_t* gem5::memory::AbstractMemory::pmemAddr
protected

Definition at line 118 of file abstract_mem.hh.

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

◆ range

AddrRange gem5::memory::AbstractMemory::range
protected

◆ stats

gem5::memory::AbstractMemory::MemStats gem5::memory::AbstractMemory::stats
protected

Referenced by access().


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

Generated on Tue Sep 21 2021 12:31:27 for gem5 by doxygen 1.8.17