The MemTest class tests a cache coherent memory system by generating false sharing and verifying the read data against a reference updated on the completion of writes. More...

#include <memtest.hh>

Inheritance diagram for MemTest:

Classes
class	CpuPort

struct	MemTestStats

Public Types
typedef MemTestParams	Params

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

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	MemTest (const Params *p)

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. 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...

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

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

void	noRequest ()

void	noResponse ()

Addr	blockAlign (Addr addr) const
	Get the block aligned address. More...

void	completeRequest (PacketPtr pkt, bool functional=false)
	Complete a request by checking the response. More...

bool	sendPkt (PacketPtr pkt)

void	recvRetry ()

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

EventFunctionWrapper	noRequestEvent

EventFunctionWrapper	noResponseEvent

CpuPort	port

PacketPtr	retryPkt

const unsigned	size

const Cycles	interval

const unsigned	percentReads

const unsigned	percentFunctional

const unsigned	percentUncacheable

RequestorID	requestorId
	Request id for all generated traffic. More...

unsigned int	id

std::set< Addr >	outstandingAddrs

std::unordered_map< Addr, uint8_t >	referenceData

const unsigned	blockSize

const Addr	blockAddrMask

Addr	baseAddr1

Addr	baseAddr2

Addr	uncacheAddr

const unsigned	progressInterval

const Cycles	progressCheck

Tick	nextProgressMessage

uint64_t	numReads

uint64_t	numWrites

const uint64_t	maxLoads

const bool	atomic

const bool	suppressFuncErrors

MemTest::MemTestStats	stats

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

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

Detailed Description

The MemTest class tests a cache coherent memory system by generating false sharing and verifying the read data against a reference updated on the completion of writes.

Each tester reads and writes a specific byte in a cache line, as determined by its unique id. Thus, all requests issued by the MemTest instance are a single byte and a specific address is only ever touched by a single tester.

In addition to verifying the data, the tester also has timeouts for both requests and responses, thus checking that the memory-system is making progress.

Definition at line 67 of file memtest.hh.

Member Typedef Documentation

◆ Params

typedef MemTestParams MemTest::Params

Definition at line 72 of file memtest.hh.

Constructor & Destructor Documentation

◆ MemTest()

MemTest::MemTest ( const Params * p )

Definition at line 82 of file memtest.cc.

References tick().

Member Function Documentation

◆ blockAlign()

Addr MemTest::blockAlign ( Addr addr ) const

inlineprotected

Get the block aligned address.

Parameters

addr	Address to align

Returns: The block aligned address

Definition at line 148 of file memtest.hh.

References addr, and blockAddrMask.

Referenced by completeRequest(), and tick().

◆ completeRequest()

void MemTest::completeRequest	(	PacketPtr	pkt,
		bool	functional = `false`
	)

protected

Complete a request by checking the response.

Parameters

pkt	Response packet
functional	Whether the access was functional or not

Definition at line 131 of file memtest.cc.

References blockAlign(), ccprintf(), Clocked::clockEdge(), curTick(), EventManager::deschedule(), DPRINTF, exitSimLoop(), Packet::getConstPtr(), Packet::isError(), Packet::isRead(), Packet::isWrite(), maxLoads, SimObject::name(), nextProgressMessage, noResponseEvent, numReads, MemTest::MemTestStats::numReads, numWrites, MemTest::MemTestStats::numWrites, outstandingAddrs, panic, progressCheck, progressInterval, referenceData, Packet::req, EventManager::reschedule(), Event::scheduled(), stats, and suppressFuncErrors.

Referenced by tick().

◆ getPort()

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

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

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 122 of file memtest.cc.

References SimObject::getPort(), and port.

◆ noRequest()

void MemTest::noRequest ( )

protected

Definition at line 300 of file memtest.cc.

References SimObject::name(), panic, and progressCheck.

◆ noResponse()

void MemTest::noResponse ( )

protected

Definition at line 306 of file memtest.cc.

References SimObject::name(), panic, and progressCheck.

◆ recvRetry()

void MemTest::recvRetry ( )

protected

Definition at line 312 of file memtest.cc.

References Clocked::clockEdge(), DPRINTF, interval, noRequestEvent, port, progressCheck, EventManager::reschedule(), retryPkt, EventManager::schedule(), RequestPort::sendTimingReq(), and tickEvent.

◆ sendPkt()

bool MemTest::sendPkt ( PacketPtr pkt )

protected

Definition at line 69 of file memtest.cc.

References ArmISA::atomic.

Referenced by tick().

◆ tick()

void MemTest::tick ( )

protected

Member Data Documentation

◆ atomic

const bool MemTest::atomic

protected

Definition at line 165 of file memtest.hh.

◆ baseAddr1

Addr MemTest::baseAddr1

protected

Definition at line 153 of file memtest.hh.

Referenced by tick().

◆ baseAddr2

Addr MemTest::baseAddr2

protected

Definition at line 154 of file memtest.hh.

Referenced by tick().

◆ blockAddrMask

const Addr MemTest::blockAddrMask

protected

Definition at line 140 of file memtest.hh.

Referenced by blockAlign().

◆ blockSize

const unsigned MemTest::blockSize

protected

Definition at line 138 of file memtest.hh.

◆ id

unsigned int MemTest::id

protected

Definition at line 131 of file memtest.hh.

Referenced by tick().

◆ interval

const Cycles MemTest::interval

protected

Definition at line 122 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ maxLoads

const uint64_t MemTest::maxLoads

protected

Definition at line 163 of file memtest.hh.

Referenced by completeRequest().

◆ nextProgressMessage

Tick MemTest::nextProgressMessage

protected

Definition at line 159 of file memtest.hh.

Referenced by completeRequest().

◆ noRequestEvent

EventFunctionWrapper MemTest::noRequestEvent

protected

Definition at line 87 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ noResponseEvent

EventFunctionWrapper MemTest::noResponseEvent

protected

Definition at line 91 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ numReads

uint64_t MemTest::numReads

protected

Definition at line 161 of file memtest.hh.

Referenced by completeRequest().

◆ numWrites

uint64_t MemTest::numWrites

protected

Definition at line 162 of file memtest.hh.

Referenced by completeRequest().

◆ outstandingAddrs

std::set<Addr> MemTest::outstandingAddrs

protected

Definition at line 133 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ percentFunctional

const unsigned MemTest::percentFunctional

protected

Definition at line 125 of file memtest.hh.

Referenced by tick().

◆ percentReads

const unsigned MemTest::percentReads

protected

Definition at line 124 of file memtest.hh.

Referenced by tick().

◆ percentUncacheable

const unsigned MemTest::percentUncacheable

protected

Definition at line 126 of file memtest.hh.

Referenced by tick().

◆ port

CpuPort MemTest::port

protected

Definition at line 116 of file memtest.hh.

Referenced by getPort(), recvRetry(), and tick().

◆ progressCheck

const Cycles MemTest::progressCheck

protected

Definition at line 158 of file memtest.hh.

Referenced by completeRequest(), noRequest(), noResponse(), recvRetry(), and tick().

◆ progressInterval

const unsigned MemTest::progressInterval

protected

Definition at line 157 of file memtest.hh.

Referenced by completeRequest().

◆ referenceData

std::unordered_map<Addr, uint8_t> MemTest::referenceData

protected

Definition at line 136 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ requestorId

RequestorID MemTest::requestorId

protected

Request id for all generated traffic.

Definition at line 129 of file memtest.hh.

Referenced by tick().

◆ retryPkt

PacketPtr MemTest::retryPkt

protected

Definition at line 118 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ size

const unsigned MemTest::size

protected

Definition at line 120 of file memtest.hh.

Referenced by tick().

◆ stats

MemTest::MemTestStats MemTest::stats

protected

Referenced by completeRequest().

◆ suppressFuncErrors

const bool MemTest::suppressFuncErrors

protected

Definition at line 167 of file memtest.hh.

Referenced by completeRequest().

◆ tickEvent

EventFunctionWrapper MemTest::tickEvent

protected

Definition at line 83 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ uncacheAddr

Addr MemTest::uncacheAddr

protected

Definition at line 155 of file memtest.hh.

Referenced by tick().

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

cpu/testers/memtest/memtest.hh
cpu/testers/memtest/memtest.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ MemTest()

Member Function Documentation

◆ blockAlign()

◆ completeRequest()

◆ getPort()

◆ noRequest()

◆ noResponse()

◆ recvRetry()

◆ sendPkt()

◆ tick()

Member Data Documentation

◆ atomic

◆ baseAddr1

◆ baseAddr2

◆ blockAddrMask

◆ blockSize

◆ id

◆ interval

◆ maxLoads

◆ nextProgressMessage

◆ noRequestEvent

◆ noResponseEvent

◆ numReads

◆ numWrites

◆ outstandingAddrs

◆ percentFunctional

◆ percentReads

◆ percentUncacheable

◆ port

◆ progressCheck

◆ progressInterval

◆ referenceData

◆ requestorId

◆ retryPkt

◆ size

◆ stats

◆ suppressFuncErrors

◆ tickEvent

◆ uncacheAddr