#include <base.hh>

Inheritance diagram for Prefetcher::Base:

Classes
class	PrefetchInfo
	Class containing the information needed by the prefetch to train and generate new prefetch requests. More...

class	PrefetchListener

struct	StatGroup

Public Member Functions
	Base (const BasePrefetcherParams *p)

virtual	~Base ()=default

virtual void	setCache (BaseCache *_cache)

virtual void	notify (const PacketPtr &pkt, const PrefetchInfo &pfi)=0
	Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.) More...

virtual void	notifyFill (const PacketPtr &pkt)
	Notify prefetcher of cache fill. More...

virtual PacketPtr	getPacket ()=0

virtual Tick	nextPrefetchReadyTime () const =0

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

Protected Attributes
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 Attributes
std::vector< PrefetchListener * >	listeners

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

Public Types inherited from SimObject
typedef SimObjectParams	Params

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

Detailed Description

Definition at line 65 of file base.hh.

Constructor & Destructor Documentation

◆ Base()

Base::Base ( const BasePrefetcherParams * p )

Definition at line 92 of file base.cc.

◆ ~Base()

virtual Prefetcher::Base::~Base ( )

virtualdefault

Member Function Documentation

◆ addEventProbe()

void Base::addEventProbe	(	SimObject *	obj,
		const char *	name
	)

Add a SimObject and a probe name to listen events from.

Parameters

obj	The SimObject pointer to listen from
name	The probe name

Definition at line 248 of file base.cc.

References SimObject::getProbeManager(), listeners, and SimObject::name().

◆ addTLB()

void Base::addTLB ( BaseTLB * tlb )

Add a BaseTLB object to be used whenever a translation is needed.

This is generally required when the prefetcher is allowed to generate page crossing references and/or uses virtual addresses for training.

Parameters

tlb	pointer to the BaseTLB object to add

Definition at line 255 of file base.cc.

References fatal_if, ArmISA::t, and tlb.

◆ blockAddress()

Addr Base::blockAddress ( Addr a ) const

protected

Determine the address of the block in which a lays.

Definition at line 169 of file base.cc.

References ArmISA::a, and blkSize.

Referenced by Prefetcher::Tagged::calculatePrefetch(), and Prefetcher::Queued::notify().

◆ blockIndex()

Addr Base::blockIndex ( Addr a ) const

protected

Determine the address of a at block granularity.

Definition at line 175 of file base.cc.

References ArmISA::a, and lBlkSize.

Referenced by Prefetcher::IrregularStreamBuffer::calculatePrefetch(), and pageIthBlockAddress().

◆ getPacket()

virtual PacketPtr Prefetcher::Base::getPacket ( )

pure virtual

Implemented in Prefetcher::Queued, and Prefetcher::Multi.

Referenced by BaseCache::getNextQueueEntry().

◆ hasBeenPrefetched()

bool Base::hasBeenPrefetched	(	Addr	addr,
		bool	is_secure
	)		const

protected

Definition at line 157 of file base.cc.

References addr, cache, and BaseCache::hasBeenPrefetched().

Referenced by probeNotify().

◆ inCache()

bool Base::inCache	(	Addr	addr,
		bool	is_secure
	)		const

protected

Determine if address is in cache.

Definition at line 145 of file base.cc.

References addr, cache, and BaseCache::inCache().

Referenced by Prefetcher::STeMS::checkForActiveGenerationsEnd(), Prefetcher::Queued::insert(), and Prefetcher::Queued::translationComplete().

◆ inMissQueue()

bool Base::inMissQueue	(	Addr	addr,
		bool	is_secure
	)		const

protected

Determine if address is in cache miss queue.

Definition at line 151 of file base.cc.

References addr, cache, and BaseCache::inMissQueue().

Referenced by Prefetcher::STeMS::checkForActiveGenerationsEnd(), Prefetcher::Queued::insert(), and Prefetcher::Queued::translationComplete().

◆ nextPrefetchReadyTime()

virtual Tick Prefetcher::Base::nextPrefetchReadyTime ( ) const

pure virtual

Implemented in Prefetcher::Queued, and Prefetcher::Multi.

Referenced by BaseCache::nextQueueReadyTime(), BaseCache::recvTimingReq(), and BaseCache::recvTimingResp().

◆ notify()

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

pure virtual

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

Implemented in Prefetcher::Queued, and Prefetcher::Multi.

Referenced by probeNotify().

◆ notifyFill()

virtual void Prefetcher::Base::notifyFill ( const PacketPtr & pkt )

inlinevirtual

Notify prefetcher of cache fill.

Reimplemented in Prefetcher::SBOOE, Prefetcher::BOP, and Prefetcher::Multi.

Definition at line 347 of file base.hh.

◆ observeAccess()

bool Base::observeAccess	(	const PacketPtr &	pkt,
		bool	miss
	)		const

protected

Determine if this access should be observed.

Parameters

pkt	The memory request causing the event
miss	whether this event comes from a cache miss

Definition at line 123 of file base.cc.

References MemCmd::CleanEvict, Packet::cmd, X86ISA::inv, Packet::isInvalidate(), Packet::isRead(), onData, onInst, onMiss, onRead, onWrite, and Packet::req.

Referenced by probeNotify().

◆ pageAddress()

Addr Base::pageAddress ( Addr a ) const

protected

Determine the address of the page in which a lays.

Definition at line 181 of file base.cc.

References ArmISA::a, pageBytes, and roundDown().

◆ pageIthBlockAddress()

Addr Base::pageIthBlockAddress	(	Addr	page,
		uint32_t	i
	)		const

protected

Build the address of the i-th block inside the page.

Definition at line 193 of file base.cc.

References blockIndex(), and lBlkSize.

◆ pageOffset()

Addr Base::pageOffset ( Addr a ) const

protected

Determine the page-offset of a

Definition at line 187 of file base.cc.

References ArmISA::a, and pageBytes.

◆ probeNotify()

void Base::probeNotify	(	const PacketPtr &	pkt,
		bool	miss
	)

Process a notification event from the ProbeListener.

Parameters

pkt	The memory request causing the event
miss	whether this event comes from a cache miss

Definition at line 199 of file base.cc.

References cache, Packet::cmd, BaseCache::coalesce(), Packet::getAddr(), hasBeenPrefetched(), Packet::isSecure(), MemCmd::isSWPrefetch(), Packet::isWrite(), notify(), observeAccess(), panic, Packet::req, usefulPrefetches, and useVirtualAddresses.

◆ regProbeListeners()

void Base::regProbeListeners ( )

overridevirtual

Register probe points for this object.

If no probes were added by the configuration scripts, connect to the parent cache using the probe "Miss". Also connect to "Hit", if the cache is configured to prefetch on accesses.

Reimplemented from SimObject.

Definition at line 227 of file base.cc.

References cache, SimObject::getProbeManager(), listeners, and prefetchOnAccess.

◆ samePage()

bool Base::samePage	(	Addr	a,
		Addr	b
	)		const

protected

Determine if addresses are on the same page.

Definition at line 163 of file base.cc.

References ArmISA::a, ArmISA::b, pageBytes, and roundDown().

Referenced by Prefetcher::Queued::insert(), and Prefetcher::Queued::notify().

◆ setCache()

void Base::setCache ( BaseCache * _cache )

virtual

Reimplemented in Prefetcher::Multi.

Definition at line 106 of file base.cc.

References blkSize, cache, floorLog2(), BaseCache::getBlockSize(), and lBlkSize.

Member Data Documentation

◆ blkSize

unsigned Prefetcher::Base::blkSize

protected

The block size of the parent cache.

Definition at line 262 of file base.hh.

Referenced by Prefetcher::SignaturePath::addPrefetch(), blockAddress(), Prefetcher::Tagged::calculatePrefetch(), Prefetcher::Stride::calculatePrefetch(), Prefetcher::STeMS::calculatePrefetch(), Prefetcher::SignaturePath::calculatePrefetch(), Prefetcher::STeMS::checkForActiveGenerationsEnd(), Prefetcher::Queued::createPrefetchRequest(), Prefetcher::Queued::insert(), setCache(), Prefetcher::BOP::tag(), and Prefetcher::Queued::translationComplete().

◆ cache

BaseCache* Prefetcher::Base::cache

protected

Pointr to the parent cache.

Definition at line 259 of file base.hh.

Referenced by hasBeenPrefetched(), inCache(), inMissQueue(), Prefetcher::Queued::insert(), probeNotify(), regProbeListeners(), and setCache().

◆ issuedPrefetches

uint64_t Prefetcher::Base::issuedPrefetches

protected

Total prefetches issued.

Definition at line 327 of file base.hh.

Referenced by Prefetcher::SignaturePathV2::calculateLookaheadConfidence(), Prefetcher::Queued::getMaxPermittedPrefetches(), and Prefetcher::Queued::getPacket().

◆ lBlkSize

unsigned Prefetcher::Base::lBlkSize

protected

log_2(block size of the parent cache).

Definition at line 265 of file base.hh.

Referenced by blockIndex(), Prefetcher::IrregularStreamBuffer::calculatePrefetch(), Prefetcher::BOP::calculatePrefetch(), Prefetcher::SBOOE::calculatePrefetch(), Prefetcher::PIF::calculatePrefetch(), Prefetcher::PIF::notifyRetiredInst(), pageIthBlockAddress(), and setCache().

◆ listeners

std::vector<PrefetchListener *> Prefetcher::Base::listeners

private

Definition at line 82 of file base.hh.

Referenced by addEventProbe(), and regProbeListeners().

◆ onData

const bool Prefetcher::Base::onData

protected

Consult prefetcher on data accesses?

Definition at line 277 of file base.hh.

Referenced by observeAccess().

◆ onInst

const bool Prefetcher::Base::onInst

protected

Consult prefetcher on instruction accesses?

Definition at line 280 of file base.hh.

Referenced by observeAccess().

◆ onMiss

const bool Prefetcher::Base::onMiss

protected

Only consult prefetcher on cache misses?

Definition at line 268 of file base.hh.

Referenced by observeAccess().

◆ onRead

const bool Prefetcher::Base::onRead

protected

Consult prefetcher on reads?

Definition at line 271 of file base.hh.

Referenced by observeAccess().

◆ onWrite

const bool Prefetcher::Base::onWrite

protected

Consult prefetcher on reads?

Definition at line 274 of file base.hh.

Referenced by observeAccess().

◆ pageBytes

const Addr Prefetcher::Base::pageBytes

protected

Definition at line 285 of file base.hh.

Referenced by Prefetcher::SignaturePath::addPrefetch(), Prefetcher::SignaturePath::calculatePrefetch(), pageAddress(), pageOffset(), and samePage().

◆ prefetchOnAccess

const bool Prefetcher::Base::prefetchOnAccess

protected

Prefetch on every access, not just misses.

Definition at line 288 of file base.hh.

Referenced by regProbeListeners().

◆ prefetchStats

Prefetcher::Base::StatGroup Prefetcher::Base::prefetchStats

protected

Referenced by Prefetcher::Queued::getPacket().

◆ requestorId

const RequestorID Prefetcher::Base::requestorId

protected

Request id for prefetches.

Definition at line 283 of file base.hh.

Referenced by Prefetcher::Queued::createPrefetchRequest(), Prefetcher::Queued::insert(), and Prefetcher::Queued::translationComplete().

◆ tlb

BaseTLB* Prefetcher::Base::tlb

protected

Registered tlb for address translations.

Definition at line 332 of file base.hh.

Referenced by addTLB(), Prefetcher::Queued::notify(), Prefetcher::Queued::processMissingTranslations(), Prefetcher::Queued::DeferredPacket::startTranslation(), and Prefetcher::Queued::translationComplete().

◆ usefulPrefetches

uint64_t Prefetcher::Base::usefulPrefetches

protected

Total prefetches that has been useful.

Definition at line 329 of file base.hh.

Referenced by Prefetcher::SignaturePathV2::calculateLookaheadConfidence(), Prefetcher::Queued::getMaxPermittedPrefetches(), and probeNotify().

◆ useVirtualAddresses

const bool Prefetcher::Base::useVirtualAddresses

protected

Use Virtual Addresses for prefetching.

Definition at line 291 of file base.hh.

Referenced by Prefetcher::Queued::insert(), and probeNotify().

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

mem/cache/prefetch/base.hh
mem/cache/prefetch/base.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Base()

◆ ~Base()

Member Function Documentation

◆ addEventProbe()

◆ addTLB()

◆ blockAddress()

◆ blockIndex()

◆ getPacket()

◆ hasBeenPrefetched()

◆ inCache()

◆ inMissQueue()

◆ nextPrefetchReadyTime()

◆ notify()

◆ notifyFill()

◆ observeAccess()

◆ pageAddress()

◆ pageIthBlockAddress()

◆ pageOffset()

◆ probeNotify()

◆ regProbeListeners()

◆ samePage()

◆ setCache()

Member Data Documentation

◆ blkSize

◆ cache

◆ issuedPrefetches

◆ lBlkSize

◆ listeners

◆ onData

◆ onInst

◆ onMiss

◆ onRead

◆ onWrite

◆ pageBytes

◆ prefetchOnAccess

◆ prefetchStats

◆ requestorId

◆ tlb

◆ usefulPrefetches

◆ useVirtualAddresses