gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AddrMapper Class Referenceabstract

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

#include <addr_mapper.hh>

Inheritance diagram for AddrMapper:
MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable RangeAddrMapper

Classes

class  AddrMapperSenderState
 
class  MapperMasterPort
 
class  MapperSlavePort
 

Public Member Functions

 AddrMapper (const AddrMapperParams *params)
 
virtual ~AddrMapper ()
 
virtual BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a master port with a given name and index. More...
 
virtual BaseSlavePortgetSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a slave port with a given name and index. More...
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
- Public Member Functions inherited from MemObject
const Paramsparams () const
 
 MemObject (const Params *params)
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 resetStats ()
 Reset statistics associated with this object. 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 EventManager
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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 Clocked
void updateClockPeriod () const
 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

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 ()
 
void recvRangeChange ()
 
- 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
 
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...
 

Protected Attributes

MapperMasterPort masterPort
 Instance of master port, facing the memory side. More...
 
MapperSlavePort slavePort
 Instance of slave port, i.e. More...
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- Public Types inherited from MemObject
typedef MemObjectParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

An address mapper changes the packet addresses in going from the slave port side of the mapper to the master port side.

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

Definition at line 56 of file addr_mapper.hh.

Constructor & Destructor Documentation

AddrMapper::AddrMapper ( const AddrMapperParams *  params)

Definition at line 42 of file addr_mapper.cc.

virtual AddrMapper::~AddrMapper ( )
inlinevirtual

Definition at line 63 of file addr_mapper.hh.

Member Function Documentation

virtual AddrRangeList AddrMapper::getAddrRanges ( ) const
protectedpure virtual
BaseMasterPort & AddrMapper::getMasterPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
virtual

Get a master port with a given name and index.

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

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

Reimplemented from MemObject.

Definition at line 57 of file addr_mapper.cc.

References MemObject::getMasterPort(), and masterPort.

BaseSlavePort & AddrMapper::getSlavePort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
virtual

Get a slave port with a given name and index.

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

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

Reimplemented from MemObject.

Definition at line 67 of file addr_mapper.cc.

References MemObject::getSlavePort(), and slavePort.

void AddrMapper::init ( )
virtual

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

Definition at line 50 of file addr_mapper.cc.

References fatal, BaseMasterPort::isConnected(), BaseSlavePort::isConnected(), masterPort, and slavePort.

bool AddrMapper::isSnooping ( ) const
protected

Definition at line 188 of file addr_mapper.cc.

References fatal, SlavePort::isSnooping(), and slavePort.

Referenced by AddrMapper::MapperMasterPort::isSnooping().

Tick AddrMapper::recvAtomic ( PacketPtr  pkt)
protected
Tick AddrMapper::recvAtomicSnoop ( PacketPtr  pkt)
protected
void AddrMapper::recvFunctional ( PacketPtr  pkt)
protected
void AddrMapper::recvFunctionalSnoop ( PacketPtr  pkt)
protected
void AddrMapper::recvRangeChange ( )
protected
void AddrMapper::recvReqRetry ( )
protected

Definition at line 196 of file addr_mapper.cc.

References SlavePort::sendRetryReq(), and slavePort.

Referenced by AddrMapper::MapperMasterPort::recvReqRetry().

void AddrMapper::recvRespRetry ( )
protected

Definition at line 202 of file addr_mapper.cc.

References masterPort, and MasterPort::sendRetryResp().

Referenced by AddrMapper::MapperSlavePort::recvRespRetry().

bool AddrMapper::recvTimingReq ( PacketPtr  pkt)
protected
bool AddrMapper::recvTimingResp ( PacketPtr  pkt)
protected
void AddrMapper::recvTimingSnoopReq ( PacketPtr  pkt)
protected
bool AddrMapper::recvTimingSnoopResp ( PacketPtr  pkt)
protected
virtual Addr 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 RangeAddrMapper.

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

Member Data Documentation

MapperMasterPort AddrMapper::masterPort
protected

Instance of master port, facing the memory side.

Definition at line 158 of file addr_mapper.hh.

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

MapperSlavePort AddrMapper::slavePort
protected

Instance of slave port, i.e.

on the CPU side

Definition at line 208 of file addr_mapper.hh.

Referenced by getSlavePort(), init(), isSnooping(), recvAtomicSnoop(), recvFunctionalSnoop(), recvRangeChange(), recvReqRetry(), recvTimingResp(), and recvTimingSnoopReq().


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

Generated on Fri Jun 9 2017 13:04:00 for gem5 by doxygen 1.8.6