Range address mapper that maps a set of original ranges to a set of remapped ranges, where a specific range is of the same size (original and remapped), only with an offset. More...

#include <addr_mapper.hh>

Inheritance diagram for gem5::RangeAddrMapper:

Public Member Functions
	RangeAddrMapper (const RangeAddrMapperParams &p)

	~RangeAddrMapper ()=default

AddrRangeList	getAddrRanges () const override

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

Public Member Functions inherited from gem5::AddrMapper
	AddrMapper (const AddrMapperParams &params)

virtual	~AddrMapper ()=default

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not 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 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

Protected Member Functions
Addr	remapAddr (Addr addr) const override
	This function does the actual remapping of one address to another.

MemBackdoorPtr	getRevertedBackdoor (MemBackdoorPtr &backdoor, const AddrRange &range) override
	This function returns a backdoor that fulfills the initiator request, based on the target backdoor at the first parameter.

void	recvRangeChange () override

Protected Member Functions inherited from gem5::AddrMapper
void	recvFunctional (PacketPtr pkt)

void	recvFunctionalSnoop (PacketPtr pkt)

void	recvMemBackdoorReq (const MemBackdoorReq &req, MemBackdoorPtr &backdoor)

Tick	recvAtomic (PacketPtr pkt)

Tick	recvAtomicSnoop (PacketPtr pkt)

Tick	recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)

bool	recvTimingReq (PacketPtr pkt)

bool	recvTimingResp (PacketPtr pkt)

void	recvTimingSnoopReq (PacketPtr pkt)

bool	recvTimingSnoopResp (PacketPtr pkt)

bool	isSnooping () const

void	recvReqRetry ()

void	recvRespRetry ()

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 Attributes
std::vector< AddrRange >	originalRanges
	This contains a list of ranges the should be remapped.

std::vector< AddrRange >	remappedRanges
	This contains a list of ranges that addresses should be remapped to.

Protected Attributes inherited from gem5::AddrMapper
MapperRequestPort	memSidePort
	Instance of request port, facing the memory side.

MapperResponsePort	cpuSidePort
	Instance of response port, i.e.

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 Attributes
BackdoorManager	backdoorManager

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.

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.

Detailed Description

Range address mapper that maps a set of original ranges to a set of remapped ranges, where a specific range is of the same size (original and remapped), only with an offset.

It's useful for cases where memory is mapped to two different locations

Definition at line 276 of file addr_mapper.hh.

Constructor & Destructor Documentation

◆ RangeAddrMapper()

gem5::RangeAddrMapper::RangeAddrMapper ( const RangeAddrMapperParams & p )

Definition at line 232 of file addr_mapper.cc.

References fatal, originalRanges, remappedRanges, and gem5::RiscvISA::x.

◆ ~RangeAddrMapper()

gem5::RangeAddrMapper::~RangeAddrMapper ( )

default

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::RangeAddrMapper::getAddrRanges ( ) const

overridevirtual

Implements gem5::AddrMapper.

Definition at line 270 of file addr_mapper.cc.

References originalRanges.

◆ getRevertedBackdoor()

MemBackdoorPtr gem5::RangeAddrMapper::getRevertedBackdoor	(	MemBackdoorPtr &	backdoor,
		const AddrRange &	range )

overrideprotectedvirtual

This function returns a backdoor that fulfills the initiator request, based on the target backdoor at the first parameter.

Note that this function should return a backdoor in original address space, while the target backdoor is in remapped address space. Address reverting logic is probably required in this function.

Parameters

backdoor	the backdoor obtained from target
range	the initiator request to be fulfilled

Returns: a backdoor that fulfill the initiator request

Implements gem5::AddrMapper.

Definition at line 263 of file addr_mapper.cc.

References backdoorManager, and gem5::BackdoorManager::getRevertedBackdoor().

◆ init()

void gem5::RangeAddrMapper::init ( )

inlineoverridevirtual

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

Definition at line 286 of file addr_mapper.hh.

References gem5::AddrMapper::cpuSidePort, gem5::AddrMapper::init(), and gem5::ResponsePort::sendRangeChange().

◆ recvRangeChange()

void gem5::RangeAddrMapper::recvRangeChange ( )

inlineoverrideprotectedvirtual

Reimplemented from gem5::AddrMapper.

Definition at line 312 of file addr_mapper.hh.

◆ remapAddr()

Addr gem5::RangeAddrMapper::remapAddr ( Addr addr ) const

overrideprotectedvirtual

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)

Implements gem5::AddrMapper.

Definition at line 250 of file addr_mapper.cc.

References gem5::X86ISA::addr, gem5::ArmISA::i, gem5::ArmISA::offset, originalRanges, and remappedRanges.

Member Data Documentation

◆ backdoorManager

BackdoorManager gem5::RangeAddrMapper::backdoorManager

private

Definition at line 319 of file addr_mapper.hh.

Referenced by getRevertedBackdoor().

◆ originalRanges

std::vector<AddrRange> gem5::RangeAddrMapper::originalRanges

protected

This contains a list of ranges the should be remapped.

It must be the exact same length as remappedRanges which describes what manipulation should be done to each range.

Definition at line 298 of file addr_mapper.hh.

Referenced by getAddrRanges(), RangeAddrMapper(), and remapAddr().

◆ remappedRanges

std::vector<AddrRange> gem5::RangeAddrMapper::remappedRanges

protected

This contains a list of ranges that addresses should be remapped to.

See the description for originalRanges above

Definition at line 304 of file addr_mapper.hh.

Referenced by RangeAddrMapper(), and remapAddr().

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

mem/addr_mapper.hh
mem/addr_mapper.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RangeAddrMapper()

◆ ~RangeAddrMapper()

Member Function Documentation

◆ getAddrRanges()

◆ getRevertedBackdoor()

◆ init()

◆ recvRangeChange()

◆ remapAddr()

Member Data Documentation

◆ backdoorManager

◆ originalRanges

◆ remappedRanges