gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::RangeAddrMapper Class Reference

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:
gem5::AddrMapper gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

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. More...
 
- Public Member Functions inherited from gem5::AddrMapper
 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...
 
- 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

Addr remapAddr (Addr addr) const override
 This function does the actual remapping of one address to another. More...
 
void recvRangeChange () override
 
- Protected Member Functions inherited from gem5::AddrMapper
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)
 
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. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Protected Attributes

std::vector< AddrRangeoriginalRanges
 This contains a list of ranges the should be remapped. More...
 
std::vector< AddrRangeremappedRanges
 This contains a list of ranges that addresses should be remapped to. More...
 
- Protected Attributes inherited from gem5::AddrMapper
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

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 241 of file addr_mapper.hh.

Constructor & Destructor Documentation

◆ RangeAddrMapper()

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

Definition at line 206 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 236 of file addr_mapper.cc.

References originalRanges.

◆ 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 251 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 273 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
addrthe address to remap
Returns
the new address (can be unchanged)

Implements gem5::AddrMapper.

Definition at line 223 of file addr_mapper.cc.

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

Member Data Documentation

◆ 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 263 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 269 of file addr_mapper.hh.

Referenced by RangeAddrMapper(), and remapAddr().


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

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