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

A very simple memory object. More...

#include <simple_memobj.hh>

Inheritance diagram for gem5::SimpleMemobj:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  CPUSidePort
 Port on the CPU-side that receives requests. More...
 
class  MemSidePort
 Port on the memory-side that receives responses. More...
 

Public Member Functions

 SimpleMemobj (const SimpleMemobjParams &params)
 constructor More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. 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 initState ()
 initState() is called on each SimObject when not 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 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
 

Private Member Functions

bool handleRequest (PacketPtr pkt)
 Handle the request from the CPU side. More...
 
bool handleResponse (PacketPtr pkt)
 Handle the respone from the memory side. More...
 
void handleFunctional (PacketPtr pkt)
 Handle a packet functionally. More...
 
AddrRangeList getAddrRanges () const
 Return the address ranges this memobj is responsible for. More...
 
void sendRangeChange ()
 Tell the CPU side to ask for our memory ranges. More...
 

Private Attributes

CPUSidePort instPort
 Instantiation of the CPU-side ports. More...
 
CPUSidePort dataPort
 
MemSidePort memPort
 Instantiation of the memory-side port. More...
 
bool blocked
 True if this is currently blocked waiting for a response. More...
 

Additional Inherited Members

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

Detailed Description

A very simple memory object.

Current implementation doesn't even cache anything it just forwards requests and responses. This memobj is fully blocking (not non-blocking). Only a single request can be outstanding at a time.

Definition at line 45 of file simple_memobj.hh.

Constructor & Destructor Documentation

◆ SimpleMemobj()

gem5::SimpleMemobj::SimpleMemobj ( const SimpleMemobjParams &  params)

constructor

Definition at line 37 of file simple_memobj.cc.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::SimpleMemobj::getAddrRanges ( ) const
private

Return the address ranges this memobj is responsible for.

Just use the same as the next upper level of the hierarchy.

Returns
the address ranges this memobj is responsible for

Definition at line 221 of file simple_memobj.cc.

References DPRINTF, gem5::RequestPort::getAddrRanges(), and memPort.

◆ getPort()

Port & gem5::SimpleMemobj::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
overridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

Parameters
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 47 of file simple_memobj.cc.

References dataPort, gem5::SimObject::getPort(), instPort, gem5::InvalidPortID, memPort, and panic_if.

◆ handleFunctional()

void gem5::SimpleMemobj::handleFunctional ( PacketPtr  pkt)
private

Handle a packet functionally.

Update the data on a write and get the data on a read.

Parameters
packetto functionally handle

Definition at line 214 of file simple_memobj.cc.

References memPort, and gem5::RequestPort::sendFunctional().

◆ handleRequest()

bool gem5::SimpleMemobj::handleRequest ( PacketPtr  pkt)
private

Handle the request from the CPU side.

Parameters
requestingpacket
Returns
true if we can handle the request this cycle, false if the requestor needs to retry later

Definition at line 168 of file simple_memobj.cc.

References blocked, DPRINTF, gem5::Packet::getAddr(), memPort, and gem5::SimpleMemobj::MemSidePort::sendPacket().

◆ handleResponse()

bool gem5::SimpleMemobj::handleResponse ( PacketPtr  pkt)
private

Handle the respone from the memory side.

Parameters
respondingpacket
Returns
true if we can handle the response this cycle, false if the responder needs to retry later

Definition at line 187 of file simple_memobj.cc.

References blocked, dataPort, DPRINTF, gem5::Packet::getAddr(), instPort, gem5::Packet::req, gem5::SimpleMemobj::CPUSidePort::sendPacket(), and gem5::SimpleMemobj::CPUSidePort::trySendRetry().

◆ sendRangeChange()

void gem5::SimpleMemobj::sendRangeChange ( )
private

Tell the CPU side to ask for our memory ranges.

Definition at line 229 of file simple_memobj.cc.

References dataPort, instPort, and gem5::ResponsePort::sendRangeChange().

Member Data Documentation

◆ blocked

bool gem5::SimpleMemobj::blocked
private

True if this is currently blocked waiting for a response.

Definition at line 231 of file simple_memobj.hh.

Referenced by handleRequest(), and handleResponse().

◆ dataPort

CPUSidePort gem5::SimpleMemobj::dataPort
private

Definition at line 225 of file simple_memobj.hh.

Referenced by getPort(), handleResponse(), and sendRangeChange().

◆ instPort

CPUSidePort gem5::SimpleMemobj::instPort
private

Instantiation of the CPU-side ports.

Definition at line 224 of file simple_memobj.hh.

Referenced by getPort(), handleResponse(), and sendRangeChange().

◆ memPort

MemSidePort gem5::SimpleMemobj::memPort
private

Instantiation of the memory-side port.

Definition at line 228 of file simple_memobj.hh.

Referenced by getAddrRanges(), getPort(), handleFunctional(), and handleRequest().


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

Generated on Tue Sep 21 2021 12:28:10 for gem5 by doxygen 1.8.17