#include <queued.hh>

Inheritance diagram for Prefetcher::Queued:

Classes
struct	DeferredPacket

struct	QueuedStats

Public Types
using	AddrPriority = std::pair< Addr, int32_t >

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from 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

Public Member Functions inherited from Prefetcher::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	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 ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () 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 Params *	params () 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...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (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 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. 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	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...

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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

Protected Types
using	const_iterator = std::list< DeferredPacket >::const_iterator

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

Protected Attributes
std::list< DeferredPacket >	pfq

std::list< DeferredPacket >	pfqMissingTranslation

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

Prefetcher::Queued::QueuedStats	statsQueued

Protected Attributes inherited from Prefetcher::Base
BaseCache *	cache
	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	useVirtualAddresses
	Use Virtual Addresses for prefetching. More...

Prefetcher::Base::StatGroup	prefetchStats

uint64_t	issuedPrefetches
	Total prefetches issued. More...

uint64_t	usefulPrefetches
	Total prefetches that has been useful. More...

BaseTLB *	tlb
	Registered tlb for address translations. 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...

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 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 ()
	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)

Public Attributes inherited from ClockedObject
PowerState *	powerState

Protected Member Functions inherited from Prefetcher::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 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

Clocked &	operator= (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 54 of file queued.hh.

Member Typedef Documentation

◆ AddrPriority

using Prefetcher::Queued::AddrPriority = std::pair<Addr, int32_t>

Definition at line 182 of file queued.hh.

◆ const_iterator

using Prefetcher::Queued::const_iterator = std::list<DeferredPacket>::const_iterator

protected

Definition at line 139 of file queued.hh.

◆ iterator

using Prefetcher::Queued::iterator = std::list<DeferredPacket>::iterator

protected

Definition at line 140 of file queued.hh.

Constructor & Destructor Documentation

◆ Queued()

Prefetcher::Queued::Queued ( const QueuedPrefetcherParams * p )

Definition at line 95 of file queued.cc.

◆ ~Queued()

Prefetcher::Queued::~Queued ( )

virtual

Definition at line 106 of file queued.cc.

References MipsISA::p, and pfq.

Member Function Documentation

◆ addToQueue()

void Prefetcher::Queued::addToQueue	(	std::list< DeferredPacket > &	queue,
		DeferredPacket &	dpp
	)

private

Adds a DeferredPacket to the specified queue.

Parameters

queue	selected queue to use
dpp	DeferredPacket to add

Definition at line 439 of file queued.cc.

References DPRINTF, panic_if, Prefetcher::Queued::QueuedStats::pfRemovedFull, queueSize, and statsQueued.

Referenced by insert(), and translationComplete().

◆ alreadyInQueue()

bool Prefetcher::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

queue	selected queue to check
pfi	information of the prefetch request to be added
priority	priority of the prefetch request to be added

Returns: True if the prefetch request was found in the queue

Definition at line 294 of file queued.cc.

References DPRINTF, Prefetcher::Queued::QueuedStats::pfBufferHit, and statsQueued.

Referenced by insert().

◆ calculatePrefetch()

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

pure virtual

Implemented in Prefetcher::SignaturePath, Prefetcher::AMPM, Prefetcher::IndirectMemory, Prefetcher::STeMS, Prefetcher::SBOOE, Prefetcher::Stride, Prefetcher::BOP, Prefetcher::IrregularStreamBuffer, Prefetcher::DCPT, Prefetcher::SlimAMPM, Prefetcher::Tagged, and Prefetcher::PIF.

Referenced by notify().

◆ createPrefetchRequest()

RequestPtr Prefetcher::Queued::createPrefetchRequest	(	Addr	addr,
		PrefetchInfo const &	pfi,
		PacketPtr	pkt
	)

private

Definition at line 329 of file queued.cc.

References addr, Prefetcher::Base::blkSize, Prefetcher::Base::PrefetchInfo::getPC(), Request::PREFETCH, Packet::req, and Prefetcher::Base::requestorId.

Referenced by insert().

◆ getMaxPermittedPrefetches()

size_t Prefetcher::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

total number 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 115 of file queued.cc.

References Prefetcher::Base::issuedPrefetches, throttleControlPct, Stats::total, and Prefetcher::Base::usefulPrefetches.

Referenced by notify().

◆ getPacket()

PacketPtr Prefetcher::Queued::getPacket ( )

overridevirtual

Implements Prefetcher::Base.

Definition at line 201 of file queued.cc.

References DPRINTF, Packet::getAddr(), Prefetcher::Base::issuedPrefetches, Prefetcher::Base::StatGroup::pfIssued, pfq, Prefetcher::Base::prefetchStats, processMissingTranslations(), and queueSize.

◆ insert()

void Prefetcher::Queued::insert	(	const PacketPtr &	pkt,
		PrefetchInfo &	new_pfi,
		int32_t	priority
	)

◆ nextPrefetchReadyTime()

Tick Prefetcher::Queued::nextPrefetchReadyTime ( ) const

inlineoverridevirtual

Implements Prefetcher::Base.

Definition at line 195 of file queued.hh.

References MaxTick, and pfq.

◆ notify()

void Prefetcher::Queued::notify	(	const PacketPtr &	pkt,
		const PrefetchInfo &	pfi
	)

overridevirtual

Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.)

Implements Prefetcher::Base.

Definition at line 145 of file queued.cc.

References Prefetcher::Base::blockAddress(), calculatePrefetch(), DPRINTF, Prefetcher::Base::PrefetchInfo::getAddr(), getMaxPermittedPrefetches(), insert(), Prefetcher::Base::PrefetchInfo::isSecure(), Prefetcher::Queued::QueuedStats::pfIdentified, pfq, Prefetcher::Queued::QueuedStats::pfSpanPage, queueSquash, Prefetcher::Base::samePage(), statsQueued, and Prefetcher::Base::tlb.

◆ processMissingTranslations()

void Prefetcher::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

max	maximum number of translations to perform

Definition at line 242 of file queued.cc.

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

Referenced by getPacket().

◆ translationComplete()

void Prefetcher::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

dp	the deferred packet that has completed the translation request
failed	whether the translation was successful

Definition at line 257 of file queued.cc.

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

Member Data Documentation

◆ cacheSnoop

const bool Prefetcher::Queued::cacheSnoop

protected

Snoop the cache before generating prefetch (cheating basically)

Definition at line 163 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ latency

const Cycles Prefetcher::Queued::latency

protected

Cycles after generation when a prefetch can first be issued.

Definition at line 154 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ missingTranslationQueueSize

const unsigned Prefetcher::Queued::missingTranslationQueueSize

protected

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

Definition at line 151 of file queued.hh.

◆ pfq

std::list<DeferredPacket> Prefetcher::Queued::pfq

protected

Definition at line 136 of file queued.hh.

Referenced by getPacket(), insert(), nextPrefetchReadyTime(), notify(), translationComplete(), and ~Queued().

◆ pfqMissingTranslation

std::list<DeferredPacket> Prefetcher::Queued::pfqMissingTranslation

protected

Definition at line 137 of file queued.hh.

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

◆ queueFilter

const bool Prefetcher::Queued::queueFilter

protected

Filter prefetches if already queued.

Definition at line 160 of file queued.hh.

Referenced by insert().

◆ queueSize

const unsigned Prefetcher::Queued::queueSize

protected

Maximum size of the prefetch queue.

Definition at line 145 of file queued.hh.

Referenced by addToQueue(), and getPacket().

◆ queueSquash

const bool Prefetcher::Queued::queueSquash

protected

Squash queued prefetch if demand access observed.

Definition at line 157 of file queued.hh.

Referenced by notify().

◆ statsQueued

Prefetcher::Queued::QueuedStats Prefetcher::Queued::statsQueued

protected

Referenced by addToQueue(), alreadyInQueue(), insert(), notify(), and translationComplete().

◆ tagPrefetch

const bool Prefetcher::Queued::tagPrefetch

protected

Tag prefetch with PC of generating access?

Definition at line 166 of file queued.hh.

Referenced by insert(), and translationComplete().

◆ throttleControlPct

const unsigned int Prefetcher::Queued::throttleControlPct

protected

Percentage of requests that can be throttled.

Definition at line 169 of file queued.hh.

Referenced by getMaxPermittedPrefetches().

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

mem/cache/prefetch/queued.hh
mem/cache/prefetch/queued.cc

Classes

Public Types

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AddrPriority

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ Queued()

◆ ~Queued()

Member Function Documentation

◆ addToQueue()

◆ alreadyInQueue()

◆ calculatePrefetch()

◆ createPrefetchRequest()

◆ getMaxPermittedPrefetches()

◆ getPacket()

◆ insert()

◆ nextPrefetchReadyTime()

◆ notify()

◆ processMissingTranslations()

◆ translationComplete()

Member Data Documentation

◆ cacheSnoop

◆ latency

◆ missingTranslationQueueSize

◆ pfq

◆ pfqMissingTranslation

◆ queueFilter

◆ queueSize

◆ queueSquash

◆ statsQueued

◆ tagPrefetch

◆ throttleControlPct