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 gem5::MemTest:

Classes
class	CpuPort

struct	MemTestStats

Public Types
typedef MemTestParams	Params

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

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

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.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

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

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 (const std::string &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 Member Functions
void	tick ()

void	noRequest ()

void	noResponse ()

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

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

bool	sendPkt (PacketPtr pkt)

void	recvRetry ()

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.

Protected Attributes
EventFunctionWrapper	tickEvent

EventFunctionWrapper	noRequestEvent

EventFunctionWrapper	noResponseEvent

CpuPort	port

PacketPtr	retryPkt

bool	waitResponse

const unsigned	size

const Cycles	interval

const unsigned	percentReads

const unsigned	percentFunctional

const unsigned	percentUncacheable

const unsigned	percentAtomic

RequestorID	requestorId
	Request id for all generated traffic.

unsigned int	id

std::unordered_set< Addr >	outstandingAddrs

std::unordered_map< Addr, uint8_t >	atomicPendingData

std::unordered_map< Addr, uint8_t >	referenceData

const Addr	blockSize

const Addr	blockAddrMask

const unsigned	sizeBlocks

const Addr	baseAddr1

const Addr	baseAddr2

const Addr	uncacheAddr

const unsigned	progressInterval

const Cycles	progressCheck

Tick	nextProgressMessage

uint64_t	numReads

uint64_t	numWrites

uint64_t	numAtomics

const uint64_t	maxLoads

const bool	atomic

const bool	suppressFuncErrors

gem5::MemTest::MemTestStats	stats

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.

Additional Inherited Members
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

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 70 of file memtest.hh.

Member Typedef Documentation

◆ Params

typedef MemTestParams gem5::MemTest::Params

Definition at line 75 of file memtest.hh.

Constructor & Destructor Documentation

◆ MemTest()

gem5::MemTest::MemTest ( const Params & p )

Definition at line 84 of file memtest.cc.

References tick().

Member Function Documentation

◆ blockAlign()

Addr gem5::MemTest::blockAlign ( Addr addr ) const

inlineprotected

Get the block aligned address.

Parameters

addr	Address to align

Returns: The block aligned address

Definition at line 159 of file memtest.hh.

References gem5::X86ISA::addr, and blockAddrMask.

Referenced by completeRequest(), and tick().

◆ completeRequest()

void gem5::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 136 of file memtest.cc.

References atomicPendingData, blockAlign(), gem5::ccprintf(), gem5::Clocked::clockEdge(), gem5::curTick(), gem5::EventManager::deschedule(), DPRINTF, gem5::exitSimLoop(), gem5::Packet::getConstPtr(), interval, gem5::Packet::isAtomicOp(), gem5::Packet::isError(), gem5::Packet::isRead(), gem5::Packet::isWrite(), maxLoads, gem5::Named::name(), nextProgressMessage, noResponseEvent, gem5::MemTest::MemTestStats::numAtomics, numAtomics, gem5::MemTest::MemTestStats::numReads, numReads, gem5::MemTest::MemTestStats::numWrites, numWrites, outstandingAddrs, panic, progressCheck, progressInterval, referenceData, gem5::Packet::req, gem5::EventManager::reschedule(), gem5::EventManager::schedule(), gem5::Event::scheduled(), stats, gem5::Packet::suppressFuncError(), suppressFuncErrors, tickEvent, and waitResponse.

Referenced by gem5::MemTest::CpuPort::recvTimingResp(), sendPkt(), and tick().

◆ getPort()

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

Definition at line 127 of file memtest.cc.

References gem5::SimObject::getPort(), and port.

◆ noRequest()

void gem5::MemTest::noRequest ( )

protected

Definition at line 368 of file memtest.cc.

References gem5::Named::name(), panic, and progressCheck.

◆ noResponse()

void gem5::MemTest::noResponse ( )

protected

Definition at line 374 of file memtest.cc.

References gem5::Named::name(), panic, and progressCheck.

◆ recvRetry()

void gem5::MemTest::recvRetry ( )

protected

Definition at line 380 of file memtest.cc.

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

◆ sendPkt()

bool gem5::MemTest::sendPkt ( PacketPtr pkt )

protected

Definition at line 71 of file memtest.cc.

References atomic, completeRequest(), port, retryPkt, gem5::RequestPort::sendAtomic(), and gem5::RequestPort::sendTimingReq().

Referenced by tick().

◆ tick()

void gem5::MemTest::tick ( )

protected

Definition at line 237 of file memtest.cc.

References gem5::ArmISA::a, gem5::Request::ATOMIC_RETURN_OP, atomicPendingData, gem5::ArmISA::b, gem5::X86ISA::base, baseAddr1, baseAddr2, blockAlign(), gem5::ArmISA::c, gem5::Clocked::clockEdge(), completeRequest(), data, gem5::Packet::dataDynamic(), DPRINTF, flags, id, interval, gem5::Named::name(), noRequestEvent, noResponseEvent, gem5::ArmISA::offset, outstandingAddrs, panic_if, percentAtomic, percentFunctional, percentReads, percentUncacheable, port, progressCheck, gem5::Random::random(), gem5::random_mt, gem5::MemCmd::ReadReq, referenceData, requestorId, gem5::EventManager::reschedule(), retryPkt, gem5::EventManager::schedule(), gem5::Event::scheduled(), gem5::RequestPort::sendFunctional(), sendPkt(), gem5::Packet::setSuppressFuncError(), size, sizeBlocks, tickEvent, gem5::Request::UNCACHEABLE, uncacheAddr, waitResponse, and gem5::MemCmd::WriteReq.

Referenced by MemTest().

Member Data Documentation

◆ atomic

const bool gem5::MemTest::atomic

protected

Definition at line 177 of file memtest.hh.

Referenced by sendPkt().

◆ atomicPendingData

std::unordered_map<Addr, uint8_t> gem5::MemTest::atomicPendingData

protected

Definition at line 142 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ baseAddr1

const Addr gem5::MemTest::baseAddr1

protected

Definition at line 164 of file memtest.hh.

Referenced by tick().

◆ baseAddr2

const Addr gem5::MemTest::baseAddr2

protected

Definition at line 165 of file memtest.hh.

Referenced by tick().

◆ blockAddrMask

const Addr gem5::MemTest::blockAddrMask

protected

Definition at line 149 of file memtest.hh.

Referenced by blockAlign().

◆ blockSize

const Addr gem5::MemTest::blockSize

protected

Definition at line 147 of file memtest.hh.

◆ id

unsigned int gem5::MemTest::id

protected

Definition at line 139 of file memtest.hh.

Referenced by tick().

◆ interval

const Cycles gem5::MemTest::interval

protected

Definition at line 129 of file memtest.hh.

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

◆ maxLoads

const uint64_t gem5::MemTest::maxLoads

protected

Definition at line 175 of file memtest.hh.

Referenced by completeRequest().

◆ nextProgressMessage

Tick gem5::MemTest::nextProgressMessage

protected

Definition at line 170 of file memtest.hh.

Referenced by completeRequest().

◆ noRequestEvent

EventFunctionWrapper gem5::MemTest::noRequestEvent

protected

Definition at line 90 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ noResponseEvent

EventFunctionWrapper gem5::MemTest::noResponseEvent

protected

Definition at line 94 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ numAtomics

uint64_t gem5::MemTest::numAtomics

protected

Definition at line 174 of file memtest.hh.

Referenced by completeRequest().

◆ numReads

uint64_t gem5::MemTest::numReads

protected

Definition at line 172 of file memtest.hh.

Referenced by completeRequest().

◆ numWrites

uint64_t gem5::MemTest::numWrites

protected

Definition at line 173 of file memtest.hh.

Referenced by completeRequest().

◆ outstandingAddrs

std::unordered_set<Addr> gem5::MemTest::outstandingAddrs

protected

Definition at line 141 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ percentAtomic

const unsigned gem5::MemTest::percentAtomic

protected

Definition at line 134 of file memtest.hh.

Referenced by tick().

◆ percentFunctional

const unsigned gem5::MemTest::percentFunctional

protected

Definition at line 132 of file memtest.hh.

Referenced by tick().

◆ percentReads

const unsigned gem5::MemTest::percentReads

protected

Definition at line 131 of file memtest.hh.

Referenced by tick().

◆ percentUncacheable

const unsigned gem5::MemTest::percentUncacheable

protected

Definition at line 133 of file memtest.hh.

Referenced by tick().

◆ port

CpuPort gem5::MemTest::port

protected

Definition at line 119 of file memtest.hh.

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

◆ progressCheck

const Cycles gem5::MemTest::progressCheck

protected

Definition at line 169 of file memtest.hh.

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

◆ progressInterval

const unsigned gem5::MemTest::progressInterval

protected

Definition at line 168 of file memtest.hh.

Referenced by completeRequest().

◆ referenceData

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

protected

Definition at line 145 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ requestorId

RequestorID gem5::MemTest::requestorId

protected

Request id for all generated traffic.

Definition at line 137 of file memtest.hh.

Referenced by tick().

◆ retryPkt

PacketPtr gem5::MemTest::retryPkt

protected

Definition at line 121 of file memtest.hh.

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

◆ size

const unsigned gem5::MemTest::size

protected

Definition at line 127 of file memtest.hh.

Referenced by tick().

◆ sizeBlocks

const unsigned gem5::MemTest::sizeBlocks

protected

Definition at line 151 of file memtest.hh.

Referenced by tick().

◆ stats

gem5::MemTest::MemTestStats gem5::MemTest::stats

protected

Referenced by completeRequest().

◆ suppressFuncErrors

const bool gem5::MemTest::suppressFuncErrors

protected

Definition at line 179 of file memtest.hh.

Referenced by completeRequest().

◆ tickEvent

EventFunctionWrapper gem5::MemTest::tickEvent

protected

Definition at line 86 of file memtest.hh.

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

◆ uncacheAddr

const Addr gem5::MemTest::uncacheAddr

protected

Definition at line 166 of file memtest.hh.

Referenced by tick().

◆ waitResponse

bool gem5::MemTest::waitResponse

protected

Definition at line 125 of file memtest.hh.

Referenced by completeRequest(), and 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

◆ atomicPendingData

◆ baseAddr1

◆ baseAddr2

◆ blockAddrMask

◆ blockSize

◆ id

◆ interval

◆ maxLoads

◆ nextProgressMessage

◆ noRequestEvent

◆ noResponseEvent

◆ numAtomics

◆ numReads

◆ numWrites

◆ outstandingAddrs

◆ percentAtomic

◆ percentFunctional

◆ percentReads

◆ percentUncacheable

◆ port

◆ progressCheck

◆ progressInterval

◆ referenceData

◆ requestorId

◆ retryPkt

◆ size

◆ sizeBlocks

◆ stats

◆ suppressFuncErrors

◆ tickEvent

◆ uncacheAddr

◆ waitResponse