gem5 v24.0.0.0
|
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>
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. | |
bool | isNull () const |
See if this is a null memory that should never store data and always return zero. | |
void | setBackingStore (uint8_t *pmem_addr) |
Set the host memory backing store to be used by this memory controller. | |
void | getBackdoor (MemBackdoorPtr &bd_ptr) |
const std::list< LockedAddr > & | getLockedAddrList () const |
Get the list of locked addresses to allow checkpointing. | |
void | addLockedAddr (LockedAddr addr) |
Add a locked address to allow for checkpointing. | |
System * | system () const |
read the system pointer Implemented for completeness with the setter | |
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. | |
AddrRange | getAddrRange () const |
Get the address range. | |
uint8_t * | toHostAddr (Addr addr) const |
Transform a gem5 address space address into its physical counterpart in the host address space. | |
uint64_t | size () const |
Get the memory size. | |
Addr | start () const |
Get the start address. | |
bool | isConfReported () const |
Should this memory be passed to the kernel and part of the OS physical memory layout. | |
bool | isInAddrMap () const |
Some memories are used as shadow memories or should for other reasons not be part of the global address map. | |
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. | |
void | access (PacketPtr pkt) |
Perform an untimed memory access and update all the state (e.g. | |
void | functionalAccess (PacketPtr pkt) |
Perform an untimed memory read or write without changing anything but the memory itself. | |
Public Member Functions inherited from gem5::ClockedObject | |
ClockedObject (const ClockedObjectParams &p) | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
Public Member Functions inherited from gem5::SimObject | |
const Params & | params () 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. | |
virtual void | loadState (CheckpointIn &cp) |
loadState() is called on each SimObject when restoring from a checkpoint. | |
virtual void | regProbePoints () |
Register probe points for this object. | |
virtual void | regProbeListeners () |
Register probe listeners for this object. | |
ProbeManager * | getProbeManager () |
Get the probe manager for this object. | |
virtual Port & | getPort (const std::string &if_name, PortID idx=InvalidPortID) |
Get a port with a given name and index. | |
virtual void | startup () |
startup() is the final initialization call before simulation. | |
DrainState | drain () override |
Provide a default implementation of the drain interface for objects that don't need draining. | |
virtual void | memWriteback () |
Write back dirty buffers to memory using functional writes. | |
virtual void | memInvalidate () |
Invalidate the contents of memory buffers. | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
Public Member Functions inherited from gem5::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. | |
void | setCurTick (Tick newVal) |
EventManager (EventManager &em) | |
Event manger manages events in the event queue. | |
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. | |
void | serializeSection (CheckpointOut &cp, const std::string &name) const |
void | unserializeSection (CheckpointIn &cp, const char *name) |
Unserialize an a child object. | |
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. | |
virtual void | notifyFork () |
Notify a child process of a fork. | |
Public Member Functions inherited from gem5::statistics::Group | |
Group (Group *parent, const char *name=nullptr) | |
Construct a new statistics group. | |
virtual | ~Group () |
virtual void | regStats () |
Callback to set stat parameters. | |
virtual void | resetStats () |
Callback to reset stats. | |
virtual void | preDumpStats () |
Callback before stats are dumped. | |
void | addStat (statistics::Info *info) |
Register a stat with this group. | |
const std::map< std::string, Group * > & | getStatGroups () const |
Get all child groups associated with this object. | |
const std::vector< Info * > & | getStats () const |
Get all stats associated with this object. | |
void | addStatGroup (const char *name, Group *block) |
Add a stat block as a child of this block. | |
const Info * | resolveStat (std::string name) const |
Resolve a stat by its name within this group. | |
void | mergeStatGroup (Group *block) |
Merge the contents (stats & children) of a block to this block. | |
Group ()=delete | |
Group (const Group &)=delete | |
Group & | operator= (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. | |
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. | |
Cycles | curCycle () const |
Determine the current cycle, corresponding to a tick aligned to a clock edge. | |
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. | |
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. | |
void | signalDrainDone () const |
Signal that an object is drained. | |
Protected Member Functions inherited from gem5::Clocked | |
Clocked (ClockDomain &clk_domain) | |
Create a clocked object and set the clock domain based on the parameters. | |
Clocked (Clocked &)=delete | |
Clocked & | operator= (Clocked &)=delete |
virtual | ~Clocked () |
Virtual destructor due to inheritance. | |
void | resetClock () const |
Reset the object's clock using the current global tick value. | |
virtual void | clockPeriodUpdated () |
A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. | |
Protected Attributes | |
AddrRange | range |
uint8_t * | pmemAddr |
MemBackdoor | backdoor |
const bool | confTableReported |
const bool | inAddrMap |
const bool | kvmMap |
const bool | writeable |
const bool | collectStats |
std::list< LockedAddr > | lockedAddrList |
System * | _system |
Pointer to the System object. | |
gem5::memory::AbstractMemory::MemStats | stats |
Protected Attributes inherited from gem5::SimObject | |
const SimObjectParams & | _params |
Cached copy of the object parameters. | |
Protected Attributes inherited from gem5::EventManager | |
EventQueue * | eventq |
A pointer to this object's event queue. | |
Private Member Functions | |
AbstractMemory (const AbstractMemory &) | |
AbstractMemory & | operator= (const AbstractMemory &) |
Additional Inherited Members | |
Public Types inherited from gem5::ClockedObject | |
using | Params = ClockedObjectParams |
Parameters of ClockedObject. | |
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. | |
static SimObject * | find (const char *name) |
Find the SimObject with the given name and return a pointer to it. | |
static void | setSimObjectResolver (SimObjectResolver *resolver) |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
static SimObjectResolver * | getSimObjectResolver () |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
Static Public Member Functions inherited from gem5::Serializable | |
static const std::string & | currentSection () |
Gets the fully-qualified name of the active section. | |
static void | generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream) |
Generate a checkpoint file so that the serialization can be routed to it. | |
Public Attributes inherited from gem5::ClockedObject | |
PowerState * | powerState |
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.
|
private |
gem5::memory::AbstractMemory::AbstractMemory | ( | const Params & | p | ) |
Definition at line 59 of file abstract_mem.cc.
References panic_if, range, gem5::AddrRange::size(), gem5::AddrRange::to_string(), and gem5::AddrRange::valid().
|
inlinevirtual |
Definition at line 227 of file abstract_mem.hh.
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.
pkt | Packet 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, collectStats, 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::AMDGPUDevice::readFrame(), gem5::memory::DRAMSim2::recvAtomic(), gem5::memory::DRAMsim3::recvAtomic(), gem5::memory::qos::MemSinkCtrl::recvAtomic(), gem5::memory::SimpleMemory::recvAtomic(), gem5::memory::MemCtrl::recvAtomicLogic(), gem5::GPUCommandProcessor::submitDispatchPkt(), gem5::memory::CfiMemory::write(), and gem5::AMDGPUDevice::writeFrame().
|
inline |
Add a locked address to allow for checkpointing.
Definition at line 267 of file abstract_mem.hh.
References gem5::X86ISA::addr, backdoor, gem5::MemBackdoor::invalidate(), and lockedAddrList.
|
protected |
Definition at line 290 of file abstract_mem.cc.
References DPRINTF, gem5::ThreadContext::getIsaPtr(), gem5::BaseISA::globalClearExclusive(), gem5::ArmISA::i, gem5::InvalidContextID, gem5::Packet::isLLSC(), lockedAddrList, gem5::memory::LockedAddr::mask(), gem5::Packet::req, system(), and gem5::System::threads.
Referenced by writeOK().
void gem5::memory::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.
pkt | Packet performing the access |
Definition at line 489 of file abstract_mem.cc.
References gem5::ccprintf(), gem5::Packet::cmdString(), gem5::Packet::PrintReqState::curPrefix(), gem5::Packet::getAddr(), gem5::Packet::getAddrRange(), gem5::Packet::isPrint(), gem5::Packet::isRead(), gem5::AddrRange::isSubset(), gem5::Packet::isWrite(), gem5::Packet::makeResponse(), gem5::Packet::PrintReqState::os, panic, pmemAddr, gem5::Packet::PrintReqState::printLabels(), range, gem5::Packet::senderState, gem5::Packet::setData(), toHostAddr(), TRACE_PACKET, and gem5::Packet::writeData().
Referenced by initState(), gem5::memory::CfiMemory::recvFunctional(), gem5::memory::DRAMSim2::recvFunctional(), gem5::memory::DRAMsim3::recvFunctional(), gem5::memory::qos::MemSinkCtrl::recvFunctional(), gem5::memory::SimpleMemory::recvFunctional(), and gem5::memory::MemCtrl::recvFunctionalLogic().
AddrRange gem5::memory::AbstractMemory::getAddrRange | ( | ) | const |
Get the address range.
Definition at line 250 of file abstract_mem.cc.
References range.
Referenced by gem5::memory::MemCtrl::accessAndRespond(), gem5::memory::HeteroMemCtrl::burstAlign(), gem5::memory::HBMCtrl::getAddrRanges(), gem5::memory::HeteroMemCtrl::getAddrRanges(), gem5::memory::MemCtrl::getAddrRanges(), gem5::memory::HBMCtrl::recvAtomic(), gem5::memory::HeteroMemCtrl::recvAtomic(), gem5::memory::MemCtrl::recvAtomic(), gem5::memory::HBMCtrl::recvAtomicBackdoor(), gem5::memory::MemCtrl::recvFunctionalLogic(), gem5::memory::HBMCtrl::recvMemBackdoorReq(), gem5::memory::MemCtrl::recvMemBackdoorReq(), gem5::memory::HeteroMemCtrl::recvTimingReq(), and gem5::memory::MemCtrl::recvTimingReq().
|
inline |
Definition at line 248 of file abstract_mem.hh.
References backdoor, lockedAddrList, and gem5::MemBackdoor::ptr().
Referenced by gem5::memory::HBMCtrl::recvAtomicBackdoor(), gem5::memory::MemCtrl::recvAtomicBackdoor(), gem5::memory::SimpleMemory::recvAtomicBackdoor(), gem5::memory::HBMCtrl::recvMemBackdoorReq(), gem5::memory::MemCtrl::recvMemBackdoorReq(), and gem5::memory::SimpleMemory::recvMemBackdoorReq().
|
inline |
Get the list of locked addresses to allow checkpointing.
Definition at line 258 of file abstract_mem.hh.
References lockedAddrList.
|
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 gem5::SimObject.
Definition at line 75 of file abstract_mem.cc.
References gem5::System::cacheLineSize(), gem5::AddrRange::contains(), gem5::loader::createObjectFile(), gem5::loader::debugSymbolTable, fatal_if, functionalAccess(), gem5::SimObject::initState(), gem5::loader::SymbolTable::insert(), gem5::AddrRange::isSubset(), gem5::loader::MemoryImage::maxAddr(), gem5::loader::MemoryImage::minAddr(), gem5::Named::name(), gem5::loader::MemoryImage::offset(), panic_if, gem5::SimObject::params(), range, gem5::AddrRange::start(), system(), gem5::AddrRange::to_string(), warn, and gem5::loader::MemoryImage::write().
|
inline |
Should this memory be passed to the kernel and part of the OS physical memory layout.
Definition at line 326 of file abstract_mem.hh.
References confTableReported.
|
inline |
Some memories are used as shadow memories or should for other reasons not be part of the global address map.
Definition at line 334 of file abstract_mem.hh.
References inAddrMap.
|
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.
Definition at line 342 of file abstract_mem.hh.
References kvmMap.
|
inline |
See if this is a null memory that should never store data and always return zero.
Definition at line 237 of file abstract_mem.hh.
References gem5::SimObject::params().
|
private |
gem5::memory::AbstractMemory::PARAMS | ( | AbstractMemory | ) |
void gem5::memory::AbstractMemory::setBackingStore | ( | uint8_t * | pmem_addr | ) |
Set the host memory backing store to be used by this memory controller.
pmem_addr | Pointer 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.
|
inline |
Get the memory size.
Definition at line 311 of file abstract_mem.hh.
References range, and gem5::AddrRange::size().
Referenced by gem5::memory::DRAMInterface::decodePacket(), gem5::memory::NVMInterface::decodePacket(), gem5::memory::DRAMInterface::DRAMInterface(), gem5::memory::DRAMSim2::sendResponse(), gem5::memory::DRAMsim3::sendResponse(), and gem5::memory::CfiMemory::ProgramBuffer::write().
|
inline |
Get the start address.
Definition at line 318 of file abstract_mem.hh.
References range, and gem5::AddrRange::start().
Referenced by gem5::memory::CfiMemory::read(), and gem5::memory::CfiMemory::write().
|
inline |
read the system pointer Implemented for completeness with the setter
Definition at line 276 of file abstract_mem.hh.
References _system.
Referenced by checkLockedAddrList(), gem5::memory::DRAMInterface::init(), gem5::memory::DRAMSim2::init(), gem5::memory::DRAMsim3::init(), initState(), gem5::memory::DRAMInterface::startup(), and gem5::memory::DRAMsim3::tick().
|
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.
sys | system pointer to set |
Definition at line 284 of file abstract_mem.hh.
References _system.
|
inline |
Transform a gem5 address space address into its physical counterpart in the host address space.
addr | Address in gem5's address space. |
Definition at line 301 of file abstract_mem.hh.
References gem5::X86ISA::addr, pmemAddr, range, and gem5::AddrRange::start().
Referenced by access(), and functionalAccess().
|
protected |
Definition at line 258 of file abstract_mem.cc.
References backdoor, DPRINTF, gem5::ArmISA::i, gem5::MemBackdoor::invalidate(), lockedAddrList, gem5::memory::LockedAddr::mask(), and gem5::Packet::req.
Referenced by access().
|
inlineprotected |
Definition at line 159 of file abstract_mem.hh.
References checkLockedAddrList(), gem5::Packet::isLLSC(), lockedAddrList, gem5::Packet::req, and writeable.
Referenced by access().
|
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 181 of file abstract_mem.hh.
|
protected |
Definition at line 121 of file abstract_mem.hh.
Referenced by addLockedAddr(), getBackdoor(), gem5::memory::CfiMemory::recvAtomicBackdoor(), gem5::memory::CfiMemory::recvMemBackdoorReq(), gem5::memory::SimpleMemory::MemoryPort::recvMemBackdoorReq(), setBackingStore(), and trackLoadLocked().
|
protected |
Definition at line 136 of file abstract_mem.hh.
Referenced by access().
|
protected |
Definition at line 124 of file abstract_mem.hh.
Referenced by isConfReported().
|
protected |
Definition at line 127 of file abstract_mem.hh.
Referenced by isInAddrMap().
|
protected |
Definition at line 130 of file abstract_mem.hh.
Referenced by isKvmMap().
|
protected |
Definition at line 138 of file abstract_mem.hh.
Referenced by addLockedAddr(), checkLockedAddrList(), getBackdoor(), getLockedAddrList(), trackLoadLocked(), and writeOK().
|
protected |
Definition at line 118 of file abstract_mem.hh.
Referenced by access(), functionalAccess(), setBackingStore(), and toHostAddr().
|
protected |
Definition at line 115 of file abstract_mem.hh.
Referenced by AbstractMemory(), access(), functionalAccess(), getAddrRange(), gem5::memory::MemInterface::getCtrlAddr(), gem5::memory::DRAMInterface::init(), initState(), setBackingStore(), size(), start(), and toHostAddr().
|
protected |
Referenced by access().
|
protected |
Definition at line 133 of file abstract_mem.hh.
Referenced by writeOK().