gem5  v21.1.0.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::AddrMapper Class Referenceabstract

An address mapper changes the packet addresses in going from the response port side of the mapper to the request port side. More...

#include <addr_mapper.hh>

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

Classes

class  AddrMapperSenderState
 
class  MapperRequestPort
 
class  MapperResponsePort
 

Public Member Functions

 AddrMapper (const AddrMapperParams &params)
 
virtual ~AddrMapper ()=default
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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
 

Protected Member Functions

virtual Addr remapAddr (Addr addr) const =0
 This function does the actual remapping of one address to another. More...
 
void recvFunctional (PacketPtr pkt)
 
void recvFunctionalSnoop (PacketPtr pkt)
 
Tick recvAtomic (PacketPtr pkt)
 
Tick recvAtomicSnoop (PacketPtr pkt)
 
bool recvTimingReq (PacketPtr pkt)
 
bool recvTimingResp (PacketPtr pkt)
 
void recvTimingSnoopReq (PacketPtr pkt)
 
bool recvTimingSnoopResp (PacketPtr pkt)
 
virtual AddrRangeList getAddrRanges () const =0
 
bool isSnooping () const
 
void recvReqRetry ()
 
void recvRespRetry ()
 
virtual void recvRangeChange ()
 
- 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

MapperRequestPort memSidePort
 Instance of request port, facing the memory side. More...
 
MapperResponsePort cpuSidePort
 Instance of response port, i.e. 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...
 

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

Detailed Description

An address mapper changes the packet addresses in going from the response port side of the mapper to the request port side.

When the response port is queried for the address ranges, it also performs the necessary range updates. Note that snoop requests that travel from the request port (i.e. the memory side) to the response port are currently not modified.

Definition at line 58 of file addr_mapper.hh.

Constructor & Destructor Documentation

◆ AddrMapper()

gem5::AddrMapper::AddrMapper ( const AddrMapperParams &  params)

Definition at line 43 of file addr_mapper.cc.

◆ ~AddrMapper()

virtual gem5::AddrMapper::~AddrMapper ( )
virtualdefault

Member Function Documentation

◆ getAddrRanges()

virtual AddrRangeList gem5::AddrMapper::getAddrRanges ( ) const
protectedpure virtual

◆ getPort()

Port & gem5::AddrMapper::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.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

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 58 of file addr_mapper.cc.

References cpuSidePort, gem5::SimObject::getPort(), and memSidePort.

◆ init()

void gem5::AddrMapper::init ( )
overridevirtual

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

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Reimplemented in gem5::RangeAddrMapper.

Definition at line 51 of file addr_mapper.cc.

References cpuSidePort, fatal, gem5::Port::isConnected(), and memSidePort.

Referenced by gem5::RangeAddrMapper::init().

◆ isSnooping()

bool gem5::AddrMapper::isSnooping ( ) const
protected

◆ recvAtomic()

Tick gem5::AddrMapper::recvAtomic ( PacketPtr  pkt)
protected

◆ recvAtomicSnoop()

Tick gem5::AddrMapper::recvAtomicSnoop ( PacketPtr  pkt)
protected

◆ recvFunctional()

void gem5::AddrMapper::recvFunctional ( PacketPtr  pkt)
protected

◆ recvFunctionalSnoop()

void gem5::AddrMapper::recvFunctionalSnoop ( PacketPtr  pkt)
protected

◆ recvRangeChange()

void gem5::AddrMapper::recvRangeChange ( )
protectedvirtual

◆ recvReqRetry()

void gem5::AddrMapper::recvReqRetry ( )
protected

◆ recvRespRetry()

void gem5::AddrMapper::recvRespRetry ( )
protected

◆ recvTimingReq()

bool gem5::AddrMapper::recvTimingReq ( PacketPtr  pkt)
protected

◆ recvTimingResp()

bool gem5::AddrMapper::recvTimingResp ( PacketPtr  pkt)
protected

◆ recvTimingSnoopReq()

void gem5::AddrMapper::recvTimingSnoopReq ( PacketPtr  pkt)
protected

◆ recvTimingSnoopResp()

bool gem5::AddrMapper::recvTimingSnoopResp ( PacketPtr  pkt)
protected

◆ remapAddr()

virtual Addr gem5::AddrMapper::remapAddr ( Addr  addr) const
protectedpure virtual

This function does the actual remapping of one address to another.

It is pure virtual in this case to to allow any implementation required.

Parameters
addrthe address to remap
Returns
the new address (can be unchanged)

Implemented in gem5::RangeAddrMapper.

Referenced by recvAtomic(), recvAtomicSnoop(), recvFunctional(), recvFunctionalSnoop(), and recvTimingReq().

Member Data Documentation

◆ cpuSidePort

MapperResponsePort gem5::AddrMapper::cpuSidePort
protected

◆ memSidePort

MapperRequestPort gem5::AddrMapper::memSidePort
protected

Instance of request port, facing the memory side.

Definition at line 155 of file addr_mapper.hh.

Referenced by getPort(), init(), recvAtomic(), recvFunctional(), recvRespRetry(), recvTimingReq(), and recvTimingSnoopResp().


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

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