gem5  v20.1.0.0
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
TLBCoalescer Class Reference

The TLBCoalescer is a ClockedObject sitting on the front side (CPUSide) of each TLB. More...

#include <tlb_coalescer.hh>

Inheritance diagram for TLBCoalescer:
ClockedObject SimObject Clocked EventManager Serializable Drainable Stats::Group

Classes

class  CpuSidePort
 
class  MemSidePort
 

Public Types

typedef TLBCoalescerParams Params
 
typedef std::vector< PacketPtrcoalescedReq
 
typedef std::unordered_map< int64_t, std::vector< coalescedReq > > CoalescingFIFO
 
typedef std::unordered_map< Addr, coalescedReqCoalescingTable
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 TLBCoalescer (const Params *p)
 
 ~TLBCoalescer ()
 
bool canCoalesce (PacketPtr pkt1, PacketPtr pkt2)
 
void updatePhysAddresses (PacketPtr pkt)
 
void regStats () override
 Callback to set stat parameters. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
void processProbeTLBEvent ()
 
void processCleanupEvent ()
 
- 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...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 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 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 (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
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...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from Clocked
void updateClockPeriod ()
 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
 

Public Attributes

int TLBProbesPerCycle
 
int coalescingWindow
 
bool disableCoalescing
 
CoalescingFIFO coalescerFIFO
 
CoalescingTable issuedTranslationsTable
 
Stats::Scalar uncoalescedAccesses
 
Stats::Scalar coalescedAccesses
 
Stats::Scalar queuingCycles
 
Stats::Scalar localqueuingCycles
 
Stats::Formula localLatency
 
std::vector< CpuSidePort * > cpuSidePort
 
std::vector< MemSidePort * > memSidePort
 
EventFunctionWrapper probeTLBEvent
 This event issues the TLB probes. More...
 
EventFunctionWrapper cleanupEvent
 The cleanupEvent is scheduled after a TLBEvent triggers in order to free memory and do the required clean-up. More...
 
std::queue< AddrcleanupQueue
 
- Public Attributes inherited from ClockedObject
PowerStatepowerState
 

Additional Inherited Members

- 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 ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- 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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 
- 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...
 

Detailed Description

The TLBCoalescer is a ClockedObject sitting on the front side (CPUSide) of each TLB.

It receives packets and issues coalesced requests to the TLB below it. It controls how requests are coalesced (the rules) and the permitted number of TLB probes per cycle (i.e., how many coalesced requests it feeds the TLB per cycle).

Definition at line 65 of file tlb_coalescer.hh.

Member Typedef Documentation

◆ coalescedReq

Definition at line 81 of file tlb_coalescer.hh.

◆ CoalescingFIFO

typedef std::unordered_map<int64_t, std::vector<coalescedReq> > TLBCoalescer::CoalescingFIFO

Definition at line 101 of file tlb_coalescer.hh.

◆ CoalescingTable

typedef std::unordered_map<Addr, coalescedReq> TLBCoalescer::CoalescingTable

Definition at line 114 of file tlb_coalescer.hh.

◆ Params

typedef TLBCoalescerParams TLBCoalescer::Params

Definition at line 68 of file tlb_coalescer.hh.

Constructor & Destructor Documentation

◆ TLBCoalescer()

TLBCoalescer::TLBCoalescer ( const Params p)

Definition at line 43 of file tlb_coalescer.cc.

References processProbeTLBEvent().

◆ ~TLBCoalescer()

TLBCoalescer::~TLBCoalescer ( )
inline

Definition at line 70 of file tlb_coalescer.hh.

Member Function Documentation

◆ canCoalesce()

bool TLBCoalescer::canCoalesce ( PacketPtr  pkt1,
PacketPtr  pkt2 
)

◆ getPort()

Port & TLBCoalescer::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 SimObject.

Definition at line 69 of file tlb_coalescer.cc.

References cpuSidePort, memSidePort, and panic.

◆ processCleanupEvent()

void TLBCoalescer::processCleanupEvent ( )

Definition at line 511 of file tlb_coalescer.cc.

References cleanupQueue, DPRINTF, and issuedTranslationsTable.

◆ processProbeTLBEvent()

void TLBCoalescer::processProbeTLBEvent ( )

◆ regStats()

void TLBCoalescer::regStats ( )
overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 524 of file tlb_coalescer.cc.

References coalescedAccesses, Stats::DataWrap< Derived, InfoProxyType >::desc(), localLatency, localqueuingCycles, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), queuingCycles, Stats::Group::regStats(), and uncoalescedAccesses.

◆ updatePhysAddresses()

void TLBCoalescer::updatePhysAddresses ( PacketPtr  pkt)

Member Data Documentation

◆ cleanupEvent

EventFunctionWrapper TLBCoalescer::cleanupEvent

The cleanupEvent is scheduled after a TLBEvent triggers in order to free memory and do the required clean-up.

Definition at line 209 of file tlb_coalescer.hh.

Referenced by updatePhysAddresses().

◆ cleanupQueue

std::queue<Addr> TLBCoalescer::cleanupQueue

Definition at line 213 of file tlb_coalescer.hh.

Referenced by processCleanupEvent(), and updatePhysAddresses().

◆ coalescedAccesses

Stats::Scalar TLBCoalescer::coalescedAccesses

Definition at line 121 of file tlb_coalescer.hh.

Referenced by TLBCoalescer::CpuSidePort::recvTimingReq(), and regStats().

◆ coalescerFIFO

CoalescingFIFO TLBCoalescer::coalescerFIFO

◆ coalescingWindow

int TLBCoalescer::coalescingWindow

Definition at line 77 of file tlb_coalescer.hh.

Referenced by TLBCoalescer::CpuSidePort::recvTimingReq().

◆ cpuSidePort

std::vector<CpuSidePort*> TLBCoalescer::cpuSidePort

Definition at line 195 of file tlb_coalescer.hh.

Referenced by getPort().

◆ disableCoalescing

bool TLBCoalescer::disableCoalescing

Definition at line 84 of file tlb_coalescer.hh.

Referenced by canCoalesce().

◆ issuedTranslationsTable

CoalescingTable TLBCoalescer::issuedTranslationsTable

◆ localLatency

Stats::Formula TLBCoalescer::localLatency

Definition at line 133 of file tlb_coalescer.hh.

Referenced by regStats().

◆ localqueuingCycles

Stats::Scalar TLBCoalescer::localqueuingCycles

◆ memSidePort

std::vector<MemSidePort*> TLBCoalescer::memSidePort

Definition at line 197 of file tlb_coalescer.hh.

Referenced by getPort(), and processProbeTLBEvent().

◆ probeTLBEvent

EventFunctionWrapper TLBCoalescer::probeTLBEvent

This event issues the TLB probes.

Definition at line 204 of file tlb_coalescer.hh.

Referenced by TLBCoalescer::CpuSidePort::recvTimingReq().

◆ queuingCycles

Stats::Scalar TLBCoalescer::queuingCycles

◆ TLBProbesPerCycle

int TLBCoalescer::TLBProbesPerCycle

Definition at line 73 of file tlb_coalescer.hh.

Referenced by processProbeTLBEvent().

◆ uncoalescedAccesses

Stats::Scalar TLBCoalescer::uncoalescedAccesses

Definition at line 119 of file tlb_coalescer.hh.

Referenced by TLBCoalescer::CpuSidePort::recvTimingReq(), and regStats().


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

Generated on Wed Sep 30 2020 14:02:33 for gem5 by doxygen 1.8.17