gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::MemTest Class Reference

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:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  CpuPort
 
struct  MemTestStats
 

Public Types

typedef MemTestParams Params
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 MemTest (const Params &p)
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () 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. 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...
 
ProbeManagergetProbeManager ()
 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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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. 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 gem5::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 gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (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::unordered_set< AddroutstandingAddrs
 
std::unordered_map< Addr, uint8_t > referenceData
 
const unsigned blockSize
 
const Addr blockAddrMask
 
const Addr baseAddr1
 
const Addr baseAddr2
 
const 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
 
gem5::MemTest::MemTestStats stats
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

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
addrAddress to align
Returns
The block aligned address

Definition at line 151 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

◆ 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_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 123 of file memtest.cc.

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

◆ noRequest()

void gem5::MemTest::noRequest ( )
protected

Definition at line 304 of file memtest.cc.

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

◆ noResponse()

void gem5::MemTest::noResponse ( )
protected

Definition at line 310 of file memtest.cc.

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

◆ recvRetry()

void gem5::MemTest::recvRetry ( )
protected

◆ sendPkt()

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

◆ tick()

void gem5::MemTest::tick ( )
protected

Member Data Documentation

◆ atomic

const bool gem5::MemTest::atomic
protected

Definition at line 168 of file memtest.hh.

Referenced by sendPkt().

◆ baseAddr1

const Addr gem5::MemTest::baseAddr1
protected

Definition at line 156 of file memtest.hh.

Referenced by tick().

◆ baseAddr2

const Addr gem5::MemTest::baseAddr2
protected

Definition at line 157 of file memtest.hh.

Referenced by tick().

◆ blockAddrMask

const Addr gem5::MemTest::blockAddrMask
protected

Definition at line 143 of file memtest.hh.

Referenced by blockAlign().

◆ blockSize

const unsigned gem5::MemTest::blockSize
protected

Definition at line 141 of file memtest.hh.

◆ id

unsigned int gem5::MemTest::id
protected

Definition at line 134 of file memtest.hh.

Referenced by tick().

◆ interval

const Cycles gem5::MemTest::interval
protected

Definition at line 125 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ maxLoads

const uint64_t gem5::MemTest::maxLoads
protected

Definition at line 166 of file memtest.hh.

Referenced by completeRequest().

◆ nextProgressMessage

Tick gem5::MemTest::nextProgressMessage
protected

Definition at line 162 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().

◆ numReads

uint64_t gem5::MemTest::numReads
protected

Definition at line 164 of file memtest.hh.

Referenced by completeRequest().

◆ numWrites

uint64_t gem5::MemTest::numWrites
protected

Definition at line 165 of file memtest.hh.

Referenced by completeRequest().

◆ outstandingAddrs

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

Definition at line 136 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ percentFunctional

const unsigned gem5::MemTest::percentFunctional
protected

Definition at line 128 of file memtest.hh.

Referenced by tick().

◆ percentReads

const unsigned gem5::MemTest::percentReads
protected

Definition at line 127 of file memtest.hh.

Referenced by tick().

◆ percentUncacheable

const unsigned gem5::MemTest::percentUncacheable
protected

Definition at line 129 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 161 of file memtest.hh.

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

◆ progressInterval

const unsigned gem5::MemTest::progressInterval
protected

Definition at line 160 of file memtest.hh.

Referenced by completeRequest().

◆ referenceData

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

Definition at line 139 of file memtest.hh.

Referenced by completeRequest(), and tick().

◆ requestorId

RequestorID gem5::MemTest::requestorId
protected

Request id for all generated traffic.

Definition at line 132 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 123 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 170 of file memtest.hh.

Referenced by completeRequest().

◆ tickEvent

EventFunctionWrapper gem5::MemTest::tickEvent
protected

Definition at line 86 of file memtest.hh.

Referenced by recvRetry(), and tick().

◆ uncacheAddr

const Addr gem5::MemTest::uncacheAddr
protected

Definition at line 158 of file memtest.hh.

Referenced by tick().


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

Generated on Tue Sep 21 2021 12:27:47 for gem5 by doxygen 1.8.17