gem5  v22.0.0.1
Classes | Public Types | Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | List of all members
gem5::prefetch::Queued Class Referenceabstract

#include <queued.hh>

Inheritance diagram for gem5::prefetch::Queued:
gem5::prefetch::Base gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::prefetch::AMPM gem5::prefetch::BOP gem5::prefetch::DCPT gem5::prefetch::IndirectMemory gem5::prefetch::IrregularStreamBuffer gem5::prefetch::PIF gem5::prefetch::SBOOE gem5::prefetch::SignaturePath gem5::prefetch::SlimAMPM gem5::prefetch::STeMS gem5::prefetch::Stride gem5::prefetch::Tagged

Classes

struct  DeferredPacket
 
struct  QueuedStats
 

Public Types

using AddrPriority = std::pair< Addr, int32_t >
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Queued (const QueuedPrefetcherParams &p)
 
virtual ~Queued ()
 
void notify (const PacketPtr &pkt, const PrefetchInfo &pfi) override
 Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.) More...
 
void insert (const PacketPtr &pkt, PrefetchInfo &new_pfi, int32_t priority)
 
virtual void calculatePrefetch (const PrefetchInfo &pfi, std::vector< AddrPriority > &addresses)=0
 
PacketPtr getPacket () override
 
Tick nextPrefetchReadyTime () const override
 
void printQueue (const std::list< DeferredPacket > &queue) const
 
- Public Member Functions inherited from gem5::prefetch::Base
 Base (const BasePrefetcherParams &p)
 
virtual ~Base ()=default
 
virtual void setCache (BaseCache *_cache)
 
virtual void notifyFill (const PacketPtr &pkt)
 Notify prefetcher of cache fill. More...
 
void prefetchUnused ()
 
void incrDemandMhsrMisses ()
 
void pfHitInCache ()
 
void pfHitInMSHR ()
 
void pfHitInWB ()
 
void regProbeListeners () override
 Register probe points for this object. More...
 
void probeNotify (const PacketPtr &pkt, bool miss)
 Process a notification event from the ProbeListener. More...
 
void addEventProbe (SimObject *obj, const char *name)
 Add a SimObject and a probe name to listen events from. More...
 
void addTLB (BaseTLB *tlb)
 Add a BaseTLB object to be used whenever a translation is needed. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
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::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
 
- Public Member Functions inherited from gem5::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
 

Protected Types

using const_iterator = std::list< DeferredPacket >::const_iterator
 
using iterator = std::list< DeferredPacket >::iterator
 

Protected Attributes

std::list< DeferredPacketpfq
 
std::list< DeferredPacketpfqMissingTranslation
 
const unsigned queueSize
 Maximum size of the prefetch queue. More...
 
const unsigned missingTranslationQueueSize
 Maximum size of the queue holding prefetch requests with missing address translations. More...
 
const Cycles latency
 Cycles after generation when a prefetch can first be issued. More...
 
const bool queueSquash
 Squash queued prefetch if demand access observed. More...
 
const bool queueFilter
 Filter prefetches if already queued. More...
 
const bool cacheSnoop
 Snoop the cache before generating prefetch (cheating basically) More...
 
const bool tagPrefetch
 Tag prefetch with PC of generating access? More...
 
const unsigned int throttleControlPct
 Percentage of requests that can be throttled. More...
 
gem5::prefetch::Queued::QueuedStats statsQueued
 
- Protected Attributes inherited from gem5::prefetch::Base
BaseCachecache
 Pointr to the parent cache. More...
 
unsigned blkSize
 The block size of the parent cache. More...
 
unsigned lBlkSize
 log_2(block size of the parent cache). More...
 
const bool onMiss
 Only consult prefetcher on cache misses? More...
 
const bool onRead
 Consult prefetcher on reads? More...
 
const bool onWrite
 Consult prefetcher on reads? More...
 
const bool onData
 Consult prefetcher on data accesses? More...
 
const bool onInst
 Consult prefetcher on instruction accesses? More...
 
const RequestorID requestorId
 Request id for prefetches. More...
 
const Addr pageBytes
 
const bool prefetchOnAccess
 Prefetch on every access, not just misses. More...
 
const bool prefetchOnPfHit
 Prefetch on hit on prefetched lines. More...
 
const bool useVirtualAddresses
 Use Virtual Addresses for prefetching. More...
 
gem5::prefetch::Base::StatGroup prefetchStats
 
uint64_t issuedPrefetches
 Total prefetches issued. More...
 
uint64_t usefulPrefetches
 Total prefetches that has been useful. More...
 
BaseTLBtlb
 Registered tlb for address translations. 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...
 

Private Member Functions

void addToQueue (std::list< DeferredPacket > &queue, DeferredPacket &dpp)
 Adds a DeferredPacket to the specified queue. More...
 
void processMissingTranslations (unsigned max)
 Starts the translations of the queued prefetches with a missing translation. More...
 
void translationComplete (DeferredPacket *dp, bool failed)
 Indicates that the translation of the address of the provided deferred packet has been successfully completed, and it can be enqueued as a new prefetch request. More...
 
bool alreadyInQueue (std::list< DeferredPacket > &queue, const PrefetchInfo &pfi, int32_t priority)
 Checks whether the specified prefetch request is already in the specified queue. More...
 
size_t getMaxPermittedPrefetches (size_t total) const
 Returns the maxmimum number of prefetch requests that are allowed to be created from the number of prefetch candidates provided. More...
 
RequestPtr createPrefetchRequest (Addr addr, PrefetchInfo const &pfi, PacketPtr pkt)
 

Additional Inherited Members

- 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::prefetch::Base
bool observeAccess (const PacketPtr &pkt, bool miss) const
 Determine if this access should be observed. More...
 
bool inCache (Addr addr, bool is_secure) const
 Determine if address is in cache. More...
 
bool inMissQueue (Addr addr, bool is_secure) const
 Determine if address is in cache miss queue. More...
 
bool hasBeenPrefetched (Addr addr, bool is_secure) const
 
bool samePage (Addr a, Addr b) const
 Determine if addresses are on the same page. More...
 
Addr blockAddress (Addr a) const
 Determine the address of the block in which a lays. More...
 
Addr blockIndex (Addr a) const
 Determine the address of a at block granularity. More...
 
Addr pageAddress (Addr a) const
 Determine the address of the page in which a lays. More...
 
Addr pageOffset (Addr a) const
 Determine the page-offset of a
More...
 
Addr pageIthBlockAddress (Addr page, uint32_t i) const
 Build the address of the i-th block inside the page. More...
 
- 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 Member Functions inherited from gem5::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...
 

Detailed Description

Definition at line 60 of file queued.hh.

Member Typedef Documentation

◆ AddrPriority

Definition at line 191 of file queued.hh.

◆ const_iterator

Definition at line 146 of file queued.hh.

◆ iterator

Definition at line 147 of file queued.hh.

Constructor & Destructor Documentation

◆ Queued()

gem5::prefetch::Queued::Queued ( const QueuedPrefetcherParams &  p)

Definition at line 101 of file queued.cc.

◆ ~Queued()

gem5::prefetch::Queued::~Queued ( )
virtual

Definition at line 112 of file queued.cc.

References gem5::VegaISA::p, and pfq.

Member Function Documentation

◆ addToQueue()

void gem5::prefetch::Queued::addToQueue ( std::list< DeferredPacket > &  queue,
DeferredPacket dpp 
)
private

Adds a DeferredPacket to the specified queue.

Parameters
queueselected queue to use
dppDeferredPacket to add

Definition at line 484 of file queued.cc.

References DPRINTF, panic_if, gem5::prefetch::Queued::QueuedStats::pfRemovedFull, printQueue(), queueSize, and statsQueued.

Referenced by insert(), and translationComplete().

◆ alreadyInQueue()

bool gem5::prefetch::Queued::alreadyInQueue ( std::list< DeferredPacket > &  queue,
const PrefetchInfo pfi,
int32_t  priority 
)
private

Checks whether the specified prefetch request is already in the specified queue.

If the request is found, its priority is updated.

Parameters
queueselected queue to check
pfiinformation of the prefetch request to be added
prioritypriority of the prefetch request to be added
Returns
True if the prefetch request was found in the queue

Definition at line 339 of file queued.cc.

References DPRINTF, gem5::prefetch::Queued::QueuedStats::pfBufferHit, and statsQueued.

Referenced by insert().

◆ calculatePrefetch()

virtual void gem5::prefetch::Queued::calculatePrefetch ( const PrefetchInfo pfi,
std::vector< AddrPriority > &  addresses 
)
pure virtual

◆ createPrefetchRequest()

RequestPtr gem5::prefetch::Queued::createPrefetchRequest ( Addr  addr,
PrefetchInfo const &  pfi,
PacketPtr  pkt 
)
private

◆ getMaxPermittedPrefetches()

size_t gem5::prefetch::Queued::getMaxPermittedPrefetches ( size_t  total) const
private

Returns the maxmimum number of prefetch requests that are allowed to be created from the number of prefetch candidates provided.

The behavior of this service is controlled with the throttleControlPct parameter.

Parameters
totalnumber of prefetch candidates generated by the prefetcher
Returns
the number of these request candidates are allowed to be created

Throttle generated prefetches based in the accuracy of the prefetcher. Accuracy is computed based in the ratio of useful prefetches with respect to the number of issued prefetches.

The throttleControlPct controls how many of the candidate addresses generated by the prefetcher will be finally turned into prefetch requests

  • If set to 100, all candidates can be discarded (one request will always be allowed to be generated)
  • Setting it to 0 will disable the throttle control, so requests are created for all candidates
  • If set to 60, 40% of candidates will generate a request, and the remaining 60% will be generated depending on the current accuracy

Definition at line 143 of file queued.cc.

References gem5::prefetch::Base::issuedPrefetches, throttleControlPct, gem5::statistics::total, and gem5::prefetch::Base::usefulPrefetches.

Referenced by notify().

◆ getPacket()

PacketPtr gem5::prefetch::Queued::getPacket ( )
overridevirtual

◆ insert()

void gem5::prefetch::Queued::insert ( const PacketPtr pkt,
PrefetchInfo new_pfi,
int32_t  priority 
)

◆ nextPrefetchReadyTime()

Tick gem5::prefetch::Queued::nextPrefetchReadyTime ( ) const
inlineoverridevirtual

Implements gem5::prefetch::Base.

Definition at line 204 of file queued.hh.

References gem5::MaxTick, and pfq.

◆ notify()

void gem5::prefetch::Queued::notify ( const PacketPtr pkt,
const PrefetchInfo pfi 
)
overridevirtual

◆ printQueue()

void gem5::prefetch::Queued::printQueue ( const std::list< DeferredPacket > &  queue) const

Definition at line 121 of file queued.cc.

References DPRINTF, pfq, pfqMissingTranslation, and gem5::MipsISA::vaddr.

Referenced by addToQueue().

◆ processMissingTranslations()

void gem5::prefetch::Queued::processMissingTranslations ( unsigned  max)
private

Starts the translations of the queued prefetches with a missing translation.

It performs a maximum specified number of translations. Successful translations cause the prefetch request to be queued in the queue of ready requests.

Parameters
maxmaximum number of translations to perform

Definition at line 287 of file queued.cc.

References gem5::X86ISA::count, gem5::ArmISA::dp, pfqMissingTranslation, and gem5::prefetch::Base::tlb.

Referenced by getPacket().

◆ translationComplete()

void gem5::prefetch::Queued::translationComplete ( DeferredPacket dp,
bool  failed 
)
private

Indicates that the translation of the address of the provided deferred packet has been successfully completed, and it can be enqueued as a new prefetch request.

Parameters
dpthe deferred packet that has completed the translation request
failedwhether the translation was successful

Definition at line 302 of file queued.cc.

References addToQueue(), gem5::prefetch::Base::blkSize, cacheSnoop, gem5::Clocked::clockPeriod(), gem5::curTick(), gem5::ArmISA::dp, DPRINTF, gem5::prefetch::Base::inCache(), gem5::prefetch::Base::inMissQueue(), latency, gem5::Named::name(), gem5::prefetch::Queued::QueuedStats::pfInCache, pfq, pfqMissingTranslation, gem5::prefetch::Base::requestorId, statsQueued, tagPrefetch, and gem5::prefetch::Base::tlb.

Member Data Documentation

◆ cacheSnoop

const bool gem5::prefetch::Queued::cacheSnoop
protected

Snoop the cache before generating prefetch (cheating basically)

Definition at line 170 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ latency

const Cycles gem5::prefetch::Queued::latency
protected

Cycles after generation when a prefetch can first be issued.

Definition at line 161 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ missingTranslationQueueSize

const unsigned gem5::prefetch::Queued::missingTranslationQueueSize
protected

Maximum size of the queue holding prefetch requests with missing address translations.

Definition at line 158 of file queued.hh.

◆ pfq

std::list<DeferredPacket> gem5::prefetch::Queued::pfq
protected

◆ pfqMissingTranslation

std::list<DeferredPacket> gem5::prefetch::Queued::pfqMissingTranslation
protected

Definition at line 144 of file queued.hh.

Referenced by insert(), printQueue(), processMissingTranslations(), and translationComplete().

◆ queueFilter

const bool gem5::prefetch::Queued::queueFilter
protected

Filter prefetches if already queued.

Definition at line 167 of file queued.hh.

Referenced by insert().

◆ queueSize

const unsigned gem5::prefetch::Queued::queueSize
protected

Maximum size of the prefetch queue.

Definition at line 152 of file queued.hh.

Referenced by addToQueue(), and getPacket().

◆ queueSquash

const bool gem5::prefetch::Queued::queueSquash
protected

Squash queued prefetch if demand access observed.

Definition at line 164 of file queued.hh.

Referenced by notify().

◆ statsQueued

gem5::prefetch::Queued::QueuedStats gem5::prefetch::Queued::statsQueued
protected

◆ tagPrefetch

const bool gem5::prefetch::Queued::tagPrefetch
protected

Tag prefetch with PC of generating access?

Definition at line 173 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ throttleControlPct

const unsigned int gem5::prefetch::Queued::throttleControlPct
protected

Percentage of requests that can be throttled.

Definition at line 176 of file queued.hh.

Referenced by getMaxPermittedPrefetches().


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

Generated on Sat Jun 18 2022 08:14:29 for gem5 by doxygen 1.8.17