#include <fdp.hh>

Inheritance diagram for gem5::prefetch::FetchDirectedPrefetcher:

Classes
struct	PrefetchRequest
	The prefetch queue entry objects. More...
struct	Stats

Public Member Functions
	FetchDirectedPrefetcher (const FetchDirectedPrefetcherParams &p)
	~FetchDirectedPrefetcher ()=default
void	regProbeListeners () override
	Base class overrides.
void	setCache (BaseCache *_cache)
PacketPtr	getPacket () override
	Gets a packet from the prefetch queue to be prefetched.
Tick	nextPrefetchReadyTime () const override
void	notify (const CacheAccessProbeArg &acc, const PrefetchInfo &pfi) override
	Notify functions are not used by this prefetcher.
Public Member Functions inherited from gem5::prefetch::Base
	Base (const BasePrefetcherParams &p)
virtual	~Base ()=default
virtual void	setParentInfo (System sys, ProbeManager pm, unsigned blk_size)
virtual void	notifyFill (const CacheAccessProbeArg &acc)
	Notify prefetcher of cache fill.
virtual void	notifyEvict (const EvictionInfo &info)
	Notify prefetcher of cache eviction.
virtual void	prefetchUnused ()
virtual void	incrDemandMhsrMisses ()
void	pfHitInCache ()
void	pfHitInMSHR ()
void	pfHitInWB ()
void	probeNotify (const CacheAccessProbeArg &acc, bool miss)
	Process a notification event from the ProbeListener.
void	addEventProbe (SimObject obj, const char name)
	Add a SimObject and a probe name to listen events from.
void	addMMU (BaseMMU *mmu)
	Add a BaseMMU object to be used whenever a translation is needed.
Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::SimObject
const Params &	params () 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.
virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.
virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.
virtual void	regProbePoints ()
	Register probe points for this object.
ProbeManager *	getProbeManager ()
	Get the probe manager for this object.
virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
virtual void	startup ()
	startup() is the final initialization call before simulation.
DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.
virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.
virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::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.
void	setCurTick (Tick newVal)
	EventManager (EventManager &em)
	Event manger manages events in the event queue.
	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.
void	serializeSection (CheckpointOut &cp, const std::string &name) const
void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.
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.
virtual void	notifyFork ()
	Notify a child process of a fork.
Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.
virtual	~Group ()
virtual void	regStats ()
	Callback to set stat parameters.
virtual void	resetStats ()
	Callback to reset stats.
virtual void	preDumpStats ()
	Callback before stats are dumped.
void	addStat (statistics::Info *info)
	Register a stat with this group.
const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.
const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.
void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.
const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.
void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.
	Group ()=delete
	Group (const Group &)=delete
Group &	operator= (const Group &)=delete
Public Member Functions inherited from gem5::Named
	Named (std::string_view 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.
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.
Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.
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.
uint64_t	frequency () const
Tick	clockPeriod () const
double	voltage () const
Cycles	ticksToCycles (Tick t) const
Tick	cyclesToTicks (Cycles c) const

Protected Attributes
gem5::prefetch::FetchDirectedPrefetcher::Stats	stats
Protected Attributes inherited from gem5::prefetch::Base
System *	system
	Pointer to the parent system.
ProbeManager *	probeManager
	Pointer to the parent cache's probe manager.
unsigned	blkSize
	The block size of the parent cache.
unsigned	lBlkSize
	log_2(block size of the parent cache).
const bool	onMiss
	Only consult prefetcher on cache misses?
const bool	onRead
	Consult prefetcher on reads?
const bool	onWrite
	Consult prefetcher on reads?
const bool	onData
	Consult prefetcher on data accesses?
const bool	onInst
	Consult prefetcher on instruction accesses?
const RequestorID	requestorId
	Request id for prefetches.
const Addr	pageBytes
const bool	prefetchOnAccess
	Prefetch on every access, not just misses.
const bool	prefetchOnPfHit
	Prefetch on hit on prefetched lines.
const bool	useVirtualAddresses
	Use Virtual Addresses for prefetching.
gem5::prefetch::Base::StatGroup	prefetchStats
uint64_t	issuedPrefetches
	Total prefetches issued.
uint64_t	usefulPrefetches
	Total prefetches that has been useful.
BaseMMU *	mmu
	Registered mmu for address translations.
Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.
Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Private Member Functions
void	notifyFTQInsert (const o3::FetchTargetPtr &ft)
	Notifies the prefetcher that a new fetch target was inserted into the FTQ.
void	notifyFTQRemove (const o3::FetchTargetPtr &ft)
	Notifies the prefetcher that a fetch target was removed from the FTQ.
void	translationComplete (PrefetchRequest *pf_req, const bool failed)
	A translation has completed and can now be added to the PFQ.

Private Attributes
std::vector< ProbeListenerPtr<> >	listeners
	Array of probe listeners.
BaseCPU *	cpu
	Pointer to the CPU object that contains the FTQ.
BaseCache *	cache
	Pointer to the cache it is attached to.
const bool	markReqAsPrefetch
	Mark memory requests as prefetches.
const bool	squashPrefetches
	Squash prefetches in case its fetch target is removed from the FTQ.
const unsigned int	latency
	The latency of the prefetcher.
const unsigned int	pfqSize
	Prefetch queue size: Maximum number of queued prefetches.
const unsigned int	tqSize
	Translation queue size: Maximum number of outstanding translations.
const bool	cacheSnoop
	Probe the cache before a prefetch gets inserted into the PFQ.
std::list< PrefetchRequest >	pfq
	The prefetch queue.
std::list< PrefetchRequest >	translationq

Additional Inherited Members
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
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.
static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.
static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.
static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
Protected Member Functions inherited from gem5::prefetch::Base
bool	observeAccess (const PacketPtr &pkt, bool miss, bool prefetched) const
	Determine if this access should be observed.
bool	samePage (Addr a, Addr b) const
	Determine if addresses are on the same page.
Addr	blockAddress (Addr a) const
	Determine the address of the block in which a lays.
Addr	blockIndex (Addr a) const
	Determine the address of a at block granularity.
Addr	pageAddress (Addr a) const
	Determine the address of the page in which a lays.
Addr	pageOffset (Addr a) const
	Determine the page-offset of a.
Addr	pageIthBlockAddress (Addr page, uint32_t i) const
	Build the address of the i-th block inside the page.
Protected Member Functions inherited from gem5::Drainable
	Drainable ()
virtual	~Drainable ()
virtual void	drainResume ()
	Resume execution after a successful drain.
void	signalDrainDone () const
	Signal that an object is drained.
Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.
	Clocked (Clocked &)=delete
Clocked &	operator= (Clocked &)=delete
virtual	~Clocked ()
	Virtual destructor due to inheritance.
void	resetClock () const
	Reset the object's clock using the current global tick value.
virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Detailed Description

Definition at line 62 of file fdp.hh.

Constructor & Destructor Documentation

◆ FetchDirectedPrefetcher()

gem5::prefetch::FetchDirectedPrefetcher::FetchDirectedPrefetcher ( const FetchDirectedPrefetcherParams & p )

Definition at line 53 of file fdp.cc.

References gem5::prefetch::Base::Base(), cache, cacheSnoop, cpu, gem5::Clocked::cyclesToTicks(), latency, markReqAsPrefetch, gem5::MipsISA::p, pfqSize, squashPrefetches, stats, and tqSize.

Referenced by gem5::prefetch::FetchDirectedPrefetcher::PrefetchRequest::PrefetchRequest().

◆ ~FetchDirectedPrefetcher()

gem5::prefetch::FetchDirectedPrefetcher::~FetchDirectedPrefetcher ( )

default

Member Function Documentation

◆ getPacket()

PacketPtr gem5::prefetch::FetchDirectedPrefetcher::getPacket ( )

overridevirtual

Gets a packet from the prefetch queue to be prefetched.

Implements gem5::prefetch::Base.

Definition at line 204 of file fdp.cc.

References DPRINTF, gem5::Packet::getAddr(), pfq, gem5::prefetch::Base::prefetchStats, and stats.

◆ nextPrefetchReadyTime()

Tick gem5::prefetch::FetchDirectedPrefetcher::nextPrefetchReadyTime ( ) const

inlineoverridevirtual

Implements gem5::prefetch::Base.

Definition at line 81 of file fdp.hh.

References gem5::MaxTick, and pfq.

◆ notify()

void gem5::prefetch::FetchDirectedPrefetcher::notify	(	const CacheAccessProbeArg &	acc,
		const PrefetchInfo &	pfi )

inlineoverridevirtual

Notify functions are not used by this prefetcher.

Implements gem5::prefetch::Base.

Definition at line 87 of file fdp.hh.

◆ notifyFTQInsert()

void gem5::prefetch::FetchDirectedPrefetcher::notifyFTQInsert ( const o3::FetchTargetPtr & ft )

private

Notifies the prefetcher that a new fetch target was inserted into the FTQ.

Definition at line 68 of file fdp.cc.

References gem5::prefetch::Base::blkSize, gem5::prefetch::Base::blockAddress(), DPRINTF, pfq, stats, tqSize, and translationq.

◆ notifyFTQRemove()

void gem5::prefetch::FetchDirectedPrefetcher::notifyFTQRemove ( const o3::FetchTargetPtr & ft )

private

Notifies the prefetcher that a fetch target was removed from the FTQ.

Definition at line 114 of file fdp.cc.

References pfq, gem5::PowerISA::pr, squashPrefetches, stats, and translationq.

◆ regProbeListeners()

void gem5::prefetch::FetchDirectedPrefetcher::regProbeListeners ( )

overridevirtual

Base class overrides.

Reimplemented from gem5::prefetch::Base.

Definition at line 268 of file fdp.cc.

References cpu, listeners, gem5::prefetch::Base::regProbeListeners(), and warn.

◆ setCache()

void gem5::prefetch::FetchDirectedPrefetcher::setCache ( BaseCache * _cache )

inline

Definition at line 72 of file fdp.hh.

References cache.

◆ translationComplete()

void gem5::prefetch::FetchDirectedPrefetcher::translationComplete	(	PrefetchRequest *	pf_req,
		const bool	failed )

private

A translation has completed and can now be added to the PFQ.

Definition at line 147 of file fdp.cc.

References cache, cacheSnoop, gem5::curTick(), DPRINTF, latency, pfq, pfqSize, stats, translationq, and warn_if_once.

Member Data Documentation

◆ cache

BaseCache* gem5::prefetch::FetchDirectedPrefetcher::cache

private

Pointer to the cache it is attached to.

Definition at line 98 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), setCache(), and translationComplete().

◆ cacheSnoop

const bool gem5::prefetch::FetchDirectedPrefetcher::cacheSnoop

private

Probe the cache before a prefetch gets inserted into the PFQ.

Definition at line 116 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and translationComplete().

◆ cpu

BaseCPU* gem5::prefetch::FetchDirectedPrefetcher::cpu

private

Pointer to the CPU object that contains the FTQ.

Definition at line 95 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and regProbeListeners().

◆ latency

const unsigned int gem5::prefetch::FetchDirectedPrefetcher::latency

private

The latency of the prefetcher.

Definition at line 107 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and translationComplete().

◆ listeners

std::vector<ProbeListenerPtr<> > gem5::prefetch::FetchDirectedPrefetcher::listeners

private

Array of probe listeners.

Definition at line 92 of file fdp.hh.

Referenced by regProbeListeners().

◆ markReqAsPrefetch

const bool gem5::prefetch::FetchDirectedPrefetcher::markReqAsPrefetch

private

Mark memory requests as prefetches.

Definition at line 101 of file fdp.hh.

Referenced by FetchDirectedPrefetcher().

◆ pfq

std::list<PrefetchRequest> gem5::prefetch::FetchDirectedPrefetcher::pfq

private

The prefetch queue.

Definition at line 178 of file fdp.hh.

Referenced by getPacket(), nextPrefetchReadyTime(), notifyFTQInsert(), notifyFTQRemove(), and translationComplete().

◆ pfqSize

const unsigned int gem5::prefetch::FetchDirectedPrefetcher::pfqSize

private

Prefetch queue size: Maximum number of queued prefetches.

Definition at line 110 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and translationComplete().

◆ squashPrefetches

const bool gem5::prefetch::FetchDirectedPrefetcher::squashPrefetches

private

Squash prefetches in case its fetch target is removed from the FTQ.

Definition at line 104 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and notifyFTQRemove().

◆ stats

gem5::prefetch::FetchDirectedPrefetcher::Stats gem5::prefetch::FetchDirectedPrefetcher::stats

protected

Referenced by FetchDirectedPrefetcher(), getPacket(), notifyFTQInsert(), notifyFTQRemove(), and translationComplete().

◆ tqSize

const unsigned int gem5::prefetch::FetchDirectedPrefetcher::tqSize

private

Translation queue size: Maximum number of outstanding translations.

Definition at line 113 of file fdp.hh.

Referenced by FetchDirectedPrefetcher(), and notifyFTQInsert().

◆ translationq

std::list<PrefetchRequest> gem5::prefetch::FetchDirectedPrefetcher::translationq

private

Definition at line 179 of file fdp.hh.

Referenced by notifyFTQInsert(), notifyFTQRemove(), and translationComplete().

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

mem/cache/prefetch/fdp.hh
mem/cache/prefetch/fdp.cc

Classes

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FetchDirectedPrefetcher()

◆ ~FetchDirectedPrefetcher()

Member Function Documentation

◆ getPacket()

◆ nextPrefetchReadyTime()

◆ notify()

◆ notifyFTQInsert()

◆ notifyFTQRemove()

◆ regProbeListeners()

◆ setCache()

◆ translationComplete()

Member Data Documentation

◆ cache

◆ cacheSnoop

◆ cpu

◆ latency

◆ listeners

◆ markReqAsPrefetch

◆ pfq

◆ pfqSize

◆ squashPrefetches

◆ stats

◆ tqSize

◆ translationq