A very simple cache object. More...

#include <simple_cache.hh>

Inheritance diagram for SimpleCache:

Classes
class	CPUSidePort
	Port on the CPU-side that receives requests. More...

class	MemSidePort
	Port on the memory-side that receives responses. More...

Public Member Functions
	SimpleCache (SimpleCacheParams *params)
	constructor More...

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. More...

void	regStats () override
	Register the stats. 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
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...

ProbeManager *	getProbeManager ()
	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...

const Params *	params () const

	SimObject (const Params *_params)

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)

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)

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

Private Member Functions
bool	handleRequest (PacketPtr pkt, int port_id)
	Handle the request from the CPU side. More...

bool	handleResponse (PacketPtr pkt)
	Handle the respone from the memory side. More...

void	sendResponse (PacketPtr pkt)
	Send the packet to the CPU side. More...

void	handleFunctional (PacketPtr pkt)
	Handle a packet functionally. More...

void	accessTiming (PacketPtr pkt)
	Access the cache for a timing access. More...

bool	accessFunctional (PacketPtr pkt)
	This is where we actually update / read from the cache. More...

void	insert (PacketPtr pkt)
	Insert a block into the cache. More...

AddrRangeList	getAddrRanges () const
	Return the address ranges this cache is responsible for. More...

void	sendRangeChange () const
	Tell the CPU side to ask for our memory ranges. More...

Private Attributes
const Cycles	latency
	Latency to check the cache. Number of cycles for both hit and miss. More...

const unsigned	blockSize
	The block size for the cache. More...

const unsigned	capacity
	Number of blocks in the cache (size of cache / block size) More...

std::vector< CPUSidePort >	cpuPorts
	Instantiation of the CPU-side port. More...

MemSidePort	memPort
	Instantiation of the memory-side port. More...

bool	blocked
	True if this cache is currently blocked waiting for a response. More...

PacketPtr	originalPacket
	Packet that we are currently handling. More...

int	waitingPortId
	The port to send the response when we recieve it back. More...

Tick	missTime
	For tracking the miss latency. More...

std::unordered_map< Addr, uint8_t * >	cacheStore
	An incredibly simple cache storage. Maps block addresses to data. More...

Stats::Scalar	hits
	Cache statistics. More...

Stats::Scalar	misses

Stats::Histogram	missLatency

Stats::Formula	hitRatio

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)

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes inherited from ClockedObject
PowerState *	powerState

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

Detailed Description

A very simple cache object.

Has a fully-associative data store with random replacement. This cache is fully blocking (not non-blocking). Only a single request can be outstanding at a time. This cache is a writeback cache.

Definition at line 46 of file simple_cache.hh.

Constructor & Destructor Documentation

◆ SimpleCache()

SimpleCache::SimpleCache ( SimpleCacheParams * params )

constructor

Definition at line 35 of file simple_cache.cc.

References cpuPorts, csprintf(), ArmISA::i, and SimObject::name().

Referenced by regStats().

Member Function Documentation

◆ accessFunctional()

bool SimpleCache::accessFunctional ( PacketPtr pkt )

private

This is where we actually update / read from the cache.

This function is executed on both timing and functional accesses.

Returns: true if a hit, false otherwise

Definition at line 338 of file simple_cache.cc.

References blockSize, cacheStore, Packet::getBlockAddr(), Packet::isRead(), Packet::isWrite(), panic, Packet::setDataFromBlock(), and Packet::writeDataToBlock().

Referenced by accessTiming(), handleFunctional(), handleResponse(), and SimpleCache::MemSidePort::MemSidePort().

◆ accessTiming()

void SimpleCache::accessTiming ( PacketPtr pkt )

private

Access the cache for a timing access.

This is called after the cache access latency has already elapsed.

Definition at line 280 of file simple_cache.cc.

References accessFunctional(), addr, Packet::allocate(), blockSize, curTick(), DDUMP, DPRINTF, Packet::getAddr(), Packet::getBlockAddr(), Packet::getConstPtr(), Packet::getSize(), hits, Packet::isRead(), Packet::isWrite(), Packet::makeResponse(), memPort, misses, missTime, Packet::needsResponse(), originalPacket, panic, panic_if, Packet::print(), MemCmd::ReadReq, Packet::req, SimpleCache::MemSidePort::sendPacket(), and sendResponse().

Referenced by handleRequest(), and SimpleCache::MemSidePort::MemSidePort().

◆ getAddrRanges()

AddrRangeList SimpleCache::getAddrRanges ( ) const

private

Return the address ranges this cache is responsible for.

Just use the same as the next upper level of the hierarchy.

Returns: the address ranges this cache is responsible for

Definition at line 409 of file simple_cache.cc.

References DPRINTF, MasterPort::getAddrRanges(), and memPort.

◆ getPort()

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

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from SimObject.

Definition at line 53 of file simple_cache.cc.

References cpuPorts, SimObject::getPort(), InvalidPortID, memPort, and panic_if.

◆ handleFunctional()

void SimpleCache::handleFunctional ( PacketPtr pkt )

private

Handle a packet functionally.

Update the data on a write and get the data on a read. Called from CPU port on a recv functional.

Parameters

packet to functionally handle

Definition at line 270 of file simple_cache.cc.

References accessFunctional(), Packet::makeResponse(), memPort, and MasterPort::sendFunctional().

Referenced by SimpleCache::MemSidePort::MemSidePort().

◆ handleRequest()

bool SimpleCache::handleRequest	(	PacketPtr	pkt,
		int	port_id
	)

private

Handle the request from the CPU side.

Called from the CPU port on a timing request.

Parameters

requesting	packet
id	of the port to send the response

Returns: true if we can handle the request this cycle, false if the requestor needs to retry later

Definition at line 190 of file simple_cache.cc.

References accessTiming(), blocked, Clocked::clockEdge(), DPRINTF, Packet::getAddr(), latency, SimObject::name(), EventManager::schedule(), and waitingPortId.

Referenced by SimpleCache::MemSidePort::MemSidePort().

◆ handleResponse()

bool SimpleCache::handleResponse ( PacketPtr pkt )

private

Handle the respone from the memory side.

Called from the memory port on a timing response.

Parameters

responding packet

Returns: true if we can handle the response this cycle, false if the responder needs to retry later

Definition at line 215 of file simple_cache.cc.

References accessFunctional(), blocked, curTick(), DPRINTF, Packet::getAddr(), insert(), Packet::makeResponse(), missLatency, missTime, originalPacket, panic_if, Stats::DistBase< Derived, Stor >::sample(), and sendResponse().

Referenced by SimpleCache::MemSidePort::MemSidePort().

◆ insert()

void SimpleCache::insert ( PacketPtr pkt )

private

Insert a block into the cache.

If there is no room left in the cache, then this function evicts a random entry t make room for the new block.

Parameters

packet with the data (and address) to insert into the cache

Definition at line 358 of file simple_cache.cc.

References blockSize, cacheStore, capacity, data, DDUMP, DPRINTF, Packet::getAddr(), Packet::getBlockAddr(), Packet::getConstPtr(), Packet::isResponse(), memPort, Packet::print(), Random::random(), random_mt, SimpleCache::MemSidePort::sendPacket(), MemCmd::WritebackDirty, and Packet::writeDataToBlock().

Referenced by handleResponse(), and SimpleCache::MemSidePort::MemSidePort().

◆ regStats()

void SimpleCache::regStats ( )

overridevirtual

Register the stats.

Reimplemented from Stats::Group.

Definition at line 425 of file simple_cache.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), hitRatio, hits, Stats::Histogram::init(), misses, missLatency, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::Group::regStats(), and SimpleCache().

◆ sendRangeChange()

void SimpleCache::sendRangeChange ( ) const

private

Tell the CPU side to ask for our memory ranges.

Definition at line 417 of file simple_cache.cc.

References cpuPorts.

◆ sendResponse()

void SimpleCache::sendResponse ( PacketPtr pkt )

private

Send the packet to the CPU side.

This function assumes the pkt is already a response packet and forwards it to the correct port. This function also unblocks this object and cleans up the whole request.

Parameters

the	packet to send to the cpu side

Definition at line 245 of file simple_cache.cc.

References blocked, cpuPorts, DPRINTF, Packet::getAddr(), and waitingPortId.

Referenced by accessTiming(), handleResponse(), and SimpleCache::MemSidePort::MemSidePort().

Member Data Documentation

◆ blocked

bool SimpleCache::blocked

private

True if this cache is currently blocked waiting for a response.

Definition at line 279 of file simple_cache.hh.

Referenced by handleRequest(), handleResponse(), and sendResponse().

◆ blockSize

const unsigned SimpleCache::blockSize

private

The block size for the cache.

Definition at line 267 of file simple_cache.hh.

Referenced by accessFunctional(), accessTiming(), and insert().

◆ cacheStore

std::unordered_map<Addr, uint8_t*> SimpleCache::cacheStore

private

An incredibly simple cache storage. Maps block addresses to data.

Definition at line 292 of file simple_cache.hh.

Referenced by accessFunctional(), and insert().

◆ capacity

const unsigned SimpleCache::capacity

private

Number of blocks in the cache (size of cache / block size)

Definition at line 270 of file simple_cache.hh.

Referenced by insert().

◆ cpuPorts

std::vector<CPUSidePort> SimpleCache::cpuPorts

private

Instantiation of the CPU-side port.

Definition at line 273 of file simple_cache.hh.

Referenced by getPort(), sendRangeChange(), sendResponse(), and SimpleCache().

◆ hitRatio

Stats::Formula SimpleCache::hitRatio

private

Definition at line 298 of file simple_cache.hh.

Referenced by regStats().

◆ hits

Stats::Scalar SimpleCache::hits

private

Cache statistics.

Definition at line 295 of file simple_cache.hh.

Referenced by accessTiming(), and regStats().

◆ latency

const Cycles SimpleCache::latency

private

Latency to check the cache. Number of cycles for both hit and miss.

Definition at line 264 of file simple_cache.hh.

Referenced by handleRequest().

◆ memPort

MemSidePort SimpleCache::memPort

private

Instantiation of the memory-side port.

Definition at line 276 of file simple_cache.hh.

Referenced by accessTiming(), getAddrRanges(), getPort(), handleFunctional(), and insert().

◆ misses

Stats::Scalar SimpleCache::misses

private

Definition at line 296 of file simple_cache.hh.

Referenced by accessTiming(), and regStats().

◆ missLatency

Stats::Histogram SimpleCache::missLatency

private

Definition at line 297 of file simple_cache.hh.

Referenced by handleResponse(), and regStats().

◆ missTime

Tick SimpleCache::missTime

private

For tracking the miss latency.

Definition at line 289 of file simple_cache.hh.

Referenced by accessTiming(), and handleResponse().

◆ originalPacket

PacketPtr SimpleCache::originalPacket

private

Packet that we are currently handling.

Used for upgrading to larger cache line sizes

Definition at line 283 of file simple_cache.hh.

Referenced by accessTiming(), and handleResponse().

◆ waitingPortId

int SimpleCache::waitingPortId

private

The port to send the response when we recieve it back.

Definition at line 286 of file simple_cache.hh.

Referenced by handleRequest(), and sendResponse().

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

learning_gem5/part2/simple_cache.hh
learning_gem5/part2/simple_cache.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimpleCache()

Member Function Documentation

◆ accessFunctional()

◆ accessTiming()

◆ getAddrRanges()

◆ getPort()

◆ handleFunctional()

◆ handleRequest()

◆ handleResponse()

◆ insert()

◆ regStats()

◆ sendRangeChange()

◆ sendResponse()

Member Data Documentation

◆ blocked

◆ blockSize

◆ cacheStore

◆ capacity

◆ cpuPorts

◆ hitRatio

◆ hits

◆ latency

◆ memPort

◆ misses

◆ missLatency

◆ missTime

◆ originalPacket

◆ waitingPortId