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:

Classes
class	AddrMapperSenderState

class	MapperMasterPort

class	MapperSlavePort

Public Member Functions
	AddrMapper (const AddrMapperParams *params)

virtual	~AddrMapper ()

Port &	getPort (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 SimObject
const Params *	params () 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	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	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)

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)

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 Stats::Group
	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

	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 (Stats::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...

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 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 SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Additional Inherited Members
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 SimObject *	find (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 57 of file addr_mapper.hh.

Constructor & Destructor Documentation

◆ AddrMapper()

AddrMapper::AddrMapper ( const AddrMapperParams * params )

Definition at line 42 of file addr_mapper.cc.

◆ ~AddrMapper()

virtual AddrMapper::~AddrMapper ( )

inlinevirtual

Definition at line 64 of file addr_mapper.hh.

References addr, getPort(), init(), InvalidPortID, and remapAddr().

Member Function Documentation

◆ getAddrRanges()

virtual AddrRangeList AddrMapper::getAddrRanges ( ) const

protectedpure virtual

Implemented in RangeAddrMapper.

Referenced by RangeAddrMapper::~RangeAddrMapper().

◆ getPort()

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

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from SimObject.

Definition at line 57 of file addr_mapper.cc.

References SimObject::getPort(), masterPort, and slavePort.

Referenced by ~AddrMapper().

◆ init()

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

Definition at line 50 of file addr_mapper.cc.

References fatal, Port::isConnected(), masterPort, and slavePort.

Referenced by ~AddrMapper().

◆ isSnooping()

bool AddrMapper::isSnooping ( ) const

protected

Definition at line 180 of file addr_mapper.cc.

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

◆ recvAtomic()

Tick AddrMapper::recvAtomic ( PacketPtr pkt )

protected

Definition at line 87 of file addr_mapper.cc.

References Packet::getAddr(), masterPort, remapAddr(), MasterPort::sendAtomic(), and Packet::setAddr().

◆ recvAtomicSnoop()

Tick AddrMapper::recvAtomicSnoop ( PacketPtr pkt )

protected

Definition at line 97 of file addr_mapper.cc.

References Packet::getAddr(), remapAddr(), SlavePort::sendAtomicSnoop(), Packet::setAddr(), and slavePort.

◆ recvFunctional()

void AddrMapper::recvFunctional ( PacketPtr pkt )

protected

Definition at line 69 of file addr_mapper.cc.

References Packet::getAddr(), masterPort, remapAddr(), MasterPort::sendFunctional(), and Packet::setAddr().

◆ recvFunctionalSnoop()

void AddrMapper::recvFunctionalSnoop ( PacketPtr pkt )

protected

Definition at line 78 of file addr_mapper.cc.

References Packet::getAddr(), remapAddr(), SlavePort::sendFunctionalSnoop(), Packet::setAddr(), and slavePort.

◆ recvRangeChange()

void AddrMapper::recvRangeChange ( )

protected

Definition at line 200 of file addr_mapper.cc.

References SlavePort::sendRangeChange(), and slavePort.

◆ recvReqRetry()

void AddrMapper::recvReqRetry ( )

protected

Definition at line 188 of file addr_mapper.cc.

References SlavePort::sendRetryReq(), and slavePort.

◆ recvRespRetry()

void AddrMapper::recvRespRetry ( )

protected

Definition at line 194 of file addr_mapper.cc.

References masterPort, and MasterPort::sendRetryResp().

◆ recvTimingReq()

bool AddrMapper::recvTimingReq ( PacketPtr pkt )

protected

Definition at line 107 of file addr_mapper.cc.

References Packet::cacheResponding(), Packet::getAddr(), masterPort, Packet::needsResponse(), Packet::popSenderState(), Packet::pushSenderState(), remapAddr(), MasterPort::sendTimingReq(), and Packet::setAddr().

◆ recvTimingResp()

bool AddrMapper::recvTimingResp ( PacketPtr pkt )

protected

Definition at line 135 of file addr_mapper.cc.

References Packet::getAddr(), SimObject::name(), AddrMapper::AddrMapperSenderState::origAddr, panic, Packet::SenderState::predecessor, Packet::senderState, SlavePort::sendTimingResp(), Packet::setAddr(), and slavePort.

◆ recvTimingSnoopReq()

void AddrMapper::recvTimingSnoopReq ( PacketPtr pkt )

protected

Definition at line 168 of file addr_mapper.cc.

References SlavePort::sendTimingSnoopReq(), and slavePort.

◆ recvTimingSnoopResp()

bool AddrMapper::recvTimingSnoopResp ( PacketPtr pkt )

protected

Definition at line 174 of file addr_mapper.cc.

References masterPort, and MasterPort::sendTimingSnoopResp().

◆ remapAddr()

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

addr	the address to remap

Returns: the new address (can be unchanged)

Implemented in RangeAddrMapper.

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

Member Data Documentation

◆ masterPort

MapperMasterPort AddrMapper::masterPort

protected

Instance of master port, facing the memory side.

Definition at line 156 of file addr_mapper.hh.

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

◆ slavePort

MapperSlavePort AddrMapper::slavePort

protected

Instance of slave port, i.e.

on the CPU side

Definition at line 206 of file addr_mapper.hh.

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

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

mem/addr_mapper.hh
mem/addr_mapper.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AddrMapper()

◆ ~AddrMapper()

Member Function Documentation

◆ getAddrRanges()

◆ getPort()

◆ init()

◆ isSnooping()

◆ recvAtomic()

◆ recvAtomicSnoop()

◆ recvFunctional()

◆ recvFunctionalSnoop()

◆ recvRangeChange()

◆ recvReqRetry()

◆ recvRespRetry()

◆ recvTimingReq()

◆ recvTimingResp()

◆ recvTimingSnoopReq()

◆ recvTimingSnoopResp()

◆ remapAddr()

Member Data Documentation

◆ masterPort

◆ slavePort