gem5::SpatterGen Class Reference

Spatter Kernel Player. More...

#include <spatter_gen.hh>

Inheritance diagram for gem5::SpatterGen:

Classes
class	SpatterGenEvent
class	SpatterGenPort
struct	SpatterGenStats

Public Member Functions
	PARAMS (SpatterGen)
	SpatterGen (const Params &params)
Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.
virtual void	startup () override
	startup() is the final initialization call before simulation.
void	recvReqRetry ()
bool	recvTimingResp (PacketPtr pkt)
void	addKernel (uint32_t id, uint32_t delta, uint32_t count, SpatterKernelType type, size_t index_size, Addr base_index_addr, size_t value_size, Addr base_value_addr, const std::vector< uint32_t > &indices)
void	proceedPastSyncPoint ()
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.
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

Private Types
enum class	SpatterGenState { WAITING , DRAINING , RUNNING }
typedef enums::SpatterKernelType	SpatterKernelType
typedef enums::SpatterProcessingMode	SpatterProcessingMode

Private Member Functions
void	checkForSimExit ()
bool	initAccessOk (int int_regs, int fp_regs, Tick when) const
bool	interAccessOk (int int_regs, int fp_regs, Tick when) const
bool	ultAccessOk (int int_regs, int fp_regs, Tick when) const
void	processNextGenEvent ()
void	scheduleNextGenEvent (Tick when)
void	processNextSendEvent ()
void	scheduleNextSendEvent (Tick when)

Private Attributes
SpatterGenState	state
std::queue< SpatterKernel >	kernels
std::unordered_map< RequestPtr, Tick >	requestDepartureTime
RequestorID	requestorId
int	numPendingMemRequests
SpatterGenStats	stats
SpatterProcessingMode	mode
SpatterGenPort	port
int	intRegFileSize
int	intRegUsed
int	fpRegFileSize
int	fpRegUsed
int	requestGenLatency
int	requestGenRate
Tick	firstGeneratorAvailableTime
std::vector< Tick >	generatorBusyUntil
SpatterGenEvent	nextGenEvent
int	requestBufferEntries
TimedQueue< PacketPtr >	requestBuffer
int	sendRate
Tick	firstPortAvailableTime
std::vector< Tick >	portBusyUntil
SpatterGenEvent	nextSendEvent
TimedQueue< SpatterAccess * >	receiveBuffer

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

Detailed Description

Spatter Kernel Player.

This class takes Spatter JSON traces and plays them back in gem5. Each trace includes a list of Spatter kernels, which are played in order. Kernels are either of type scatter or gather. At the time of writing, kernels represent accesses to the memory with one level of indirection. Initially, an access is made to an array which we call index from now on. The index array is streamed through with load accesses. In a high level programming language this access will be similar to below. "for (int i = 0; i < n; i++) { idx = index[i]; }". The value at index[i] is then used to access another array which we will call value from now on. For scatter type kernels, a random value is stored in the location and for gather type kernels, the value is read from the location. In a high level programming language this access will be similar to below. Scatter "for (int i = 0; i < n; i++) { idx = index[i]; value[idx] = rand(); }". Gather "for (int i = 0; i < n; i++) { idx = index[i]; val = value[idx]; }". For more information you can take a look at https://github.com/hpcgarage/spatter/blob/main/README.md While the readme mentions MultiScatter and MultiGather kernels, the trace format is not finalized (at the time of writing).

Definition at line 78 of file spatter_gen.hh.

Member Typedef Documentation

SpatterKernelType

typedef enums::SpatterKernelType gem5::SpatterGen::SpatterKernelType

private

Definition at line 81 of file spatter_gen.hh.

SpatterProcessingMode

typedef enums::SpatterProcessingMode gem5::SpatterGen::SpatterProcessingMode

private

Definition at line 82 of file spatter_gen.hh.

Member Enumeration Documentation

SpatterGenState

enum class gem5::SpatterGen::SpatterGenState

strongprivate

Enumerator
WAITING
DRAINING
RUNNING

Definition at line 155 of file spatter_gen.hh.

Constructor & Destructor Documentation

SpatterGen()

gem5::SpatterGen::SpatterGen

(

const Params &

params

)

Definition at line 46 of file spatter_gen.cc.

References processNextGenEvent().

Member Function Documentation

addKernel()

void gem5::SpatterGen::addKernel	(	uint32_t	id,
		uint32_t	delta,
		uint32_t	count,
		SpatterKernelType	type,
		size_t	index_size,
		Addr	base_index_addr,
		size_t	value_size,
		Addr	base_value_addr,
		const std::vector< uint32_t > &	indices )

Definition at line 205 of file spatter_gen.cc.

References gem5::X86ISA::count, DPRINTF, kernels, requestorId, gem5::SpatterKernel::setIndices(), and gem5::X86ISA::type.

checkForSimExit()

void gem5::SpatterGen::checkForSimExit ( )

private

Definition at line 238 of file spatter_gen.cc.

References gem5::csprintf(), gem5::curTick(), DRAINING, gem5::exitSimLoop(), fpRegFileSize, fpRegUsed, initAccessOk(), interAccessOk(), intRegFileSize, intRegUsed, mode, gem5::Named::name(), gem5::Clocked::nextCycle(), numPendingMemRequests, requestBuffer, state, ultAccessOk(), and WAITING.

Referenced by recvTimingResp().

getPort()

Port & gem5::SpatterGen::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 78 of file spatter_gen.cc.

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

initAccessOk()

bool gem5::SpatterGen::initAccessOk ( int int_regs, int fp_regs, Tick when ) const

private

Definition at line 265 of file spatter_gen.cc.

References kernels, RUNNING, and state.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

interAccessOk()

bool gem5::SpatterGen::interAccessOk ( int int_regs, int fp_regs, Tick when ) const

private

Definition at line 278 of file spatter_gen.cc.

References receiveBuffer.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

PARAMS()

gem5::SpatterGen::PARAMS

(

SpatterGen

)

proceedPastSyncPoint()

void gem5::SpatterGen::proceedPastSyncPoint

(

)

Definition at line 229 of file spatter_gen.cc.

References mode, gem5::Clocked::nextCycle(), RUNNING, scheduleNextGenEvent(), state, and WAITING.

processNextGenEvent()

void gem5::SpatterGen::processNextGenEvent ( )

private

Definition at line 311 of file spatter_gen.cc.

References gem5::Clocked::clockEdge(), gem5::curTick(), gem5::SpatterKernel::done(), DPRINTF, DRAINING, firstGeneratorAvailableTime, fpRegFileSize, fpRegUsed, generatorBusyUntil, gem5::ArmISA::i, gem5::SpatterKernel::id(), initAccessOk(), interAccessOk(), intRegFileSize, intRegUsed, kernels, mode, gem5::Clocked::nextCycle(), nextGenEvent, gem5::SpatterAccess::nextPacket(), nextSendEvent, gem5::SpatterKernel::nextSpatterAccess(), gem5::SpatterGen::SpatterGenEvent::pending(), gem5::Packet::print(), gem5::Packet::pushSenderState(), receiveBuffer, requestBuffer, requestBufferEntries, requestGenLatency, requestGenRate, scheduleNextGenEvent(), scheduleNextSendEvent(), gem5::SpatterGen::SpatterGenEvent::sleep(), state, gem5::SpatterKernel::type(), and ultAccessOk().

Referenced by SpatterGen().

processNextSendEvent()

void gem5::SpatterGen::processNextSendEvent ( )

private

Definition at line 475 of file spatter_gen.cc.

References gem5::SpatterGen::SpatterGenPort::blocked(), gem5::Clocked::clockEdge(), gem5::curTick(), DPRINTF, firstPortAvailableTime, gem5::ArmISA::i, gem5::Clocked::nextCycle(), nextGenEvent, nextSendEvent, numPendingMemRequests, gem5::SpatterGen::SpatterGenEvent::pending(), port, portBusyUntil, gem5::Packet::print(), gem5::Packet::req, requestBuffer, requestDepartureTime, scheduleNextGenEvent(), scheduleNextSendEvent(), gem5::SpatterGen::SpatterGenPort::sendPacket(), sendRate, gem5::SpatterGen::SpatterGenEvent::sleep(), and gem5::SpatterGen::SpatterGenEvent::wake().

recvReqRetry()

void gem5::SpatterGen::recvReqRetry

(

)

Definition at line 128 of file spatter_gen.cc.

References gem5::Clocked::nextCycle(), nextSendEvent, gem5::SpatterGen::SpatterGenEvent::pending(), scheduleNextSendEvent(), and gem5::SpatterGen::SpatterGenEvent::wake().

recvTimingResp()

bool gem5::SpatterGen::recvTimingResp

(

PacketPtr

pkt

)

Definition at line 142 of file spatter_gen.cc.

References checkForSimExit(), gem5::curTick(), DPRINTF, gem5::Packet::findNextSenderState(), fpRegUsed, gem5::Packet::getSize(), gem5::SpatterGen::SpatterGenStats::indexAccessLatency, gem5::SpatterGen::SpatterGenStats::indexBytesRead, gem5::Packet::isResponse(), gem5::Clocked::nextCycle(), nextGenEvent, gem5::SpatterGen::SpatterGenStats::numIndexReads, numPendingMemRequests, gem5::SpatterGen::SpatterGenStats::numValueReads, gem5::SpatterGen::SpatterGenStats::numValueWrites, panic, gem5::SpatterGen::SpatterGenEvent::pending(), gem5::Packet::print(), receiveBuffer, gem5::SpatterAccess::recordTripTime(), gem5::Packet::req, requestDepartureTime, gem5::statistics::DistBase< Derived, Stor >::sample(), scheduleNextGenEvent(), stats, gem5::SpatterGen::SpatterGenStats::totalIndexReadLatency, gem5::SpatterGen::SpatterGenStats::totalIndirectAccessLatency, gem5::SpatterGen::SpatterGenStats::totalValueReadLatency, gem5::SpatterGen::SpatterGenStats::totalValueWriteLatency, gem5::SpatterAccess::tripsLeft(), gem5::SpatterAccess::tripTimeSoFar(), gem5::SpatterAccess::type(), gem5::SpatterGen::SpatterGenStats::valueAccessLatency, gem5::SpatterGen::SpatterGenStats::valueBytesRead, and gem5::SpatterGen::SpatterGenStats::valueBytesWritten.

scheduleNextGenEvent()

void gem5::SpatterGen::scheduleNextGenEvent ( Tick when )

private

Definition at line 296 of file spatter_gen.cc.

References gem5::curTick(), firstGeneratorAvailableTime, fpRegFileSize, fpRegUsed, initAccessOk(), interAccessOk(), intRegFileSize, intRegUsed, gem5::MaxTick, nextGenEvent, gem5::EventManager::schedule(), gem5::Event::scheduled(), and ultAccessOk().

Referenced by proceedPastSyncPoint(), processNextGenEvent(), processNextSendEvent(), recvTimingResp(), and startup().

scheduleNextSendEvent()

void gem5::SpatterGen::scheduleNextSendEvent ( Tick when )

private

Definition at line 464 of file spatter_gen.cc.

References firstPortAvailableTime, gem5::MaxTick, nextSendEvent, requestBuffer, gem5::EventManager::schedule(), and gem5::Event::scheduled().

Referenced by processNextGenEvent(), processNextSendEvent(), and recvReqRetry().

startup()

void gem5::SpatterGen::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 88 of file spatter_gen.cc.

References gem5::curTick(), and scheduleNextGenEvent().

ultAccessOk()

bool gem5::SpatterGen::ultAccessOk ( int int_regs, int fp_regs, Tick when ) const

private

Definition at line 287 of file spatter_gen.cc.

References receiveBuffer.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

Member Data Documentation

firstGeneratorAvailableTime

Tick gem5::SpatterGen::firstGeneratorAvailableTime

private

Definition at line 195 of file spatter_gen.hh.

Referenced by processNextGenEvent(), and scheduleNextGenEvent().

firstPortAvailableTime

Tick gem5::SpatterGen::firstPortAvailableTime

private

Definition at line 212 of file spatter_gen.hh.

Referenced by processNextSendEvent(), and scheduleNextSendEvent().

fpRegFileSize

int gem5::SpatterGen::fpRegFileSize

private

Definition at line 188 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

fpRegUsed

int gem5::SpatterGen::fpRegUsed

private

Definition at line 189 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextGenEvent(), recvTimingResp(), and scheduleNextGenEvent().

generatorBusyUntil

std::vector<Tick> gem5::SpatterGen::generatorBusyUntil

private

Definition at line 197 of file spatter_gen.hh.

Referenced by processNextGenEvent().

intRegFileSize

int gem5::SpatterGen::intRegFileSize

private

Definition at line 186 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

intRegUsed

int gem5::SpatterGen::intRegUsed

private

Definition at line 187 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextGenEvent(), and scheduleNextGenEvent().

kernels

std::queue<SpatterKernel> gem5::SpatterGen::kernels

private

Definition at line 167 of file spatter_gen.hh.

Referenced by addKernel(), initAccessOk(), and processNextGenEvent().

mode

SpatterProcessingMode gem5::SpatterGen::mode

private

Definition at line 182 of file spatter_gen.hh.

Referenced by checkForSimExit(), proceedPastSyncPoint(), and processNextGenEvent().

nextGenEvent

SpatterGenEvent gem5::SpatterGen::nextGenEvent

private

Definition at line 198 of file spatter_gen.hh.

Referenced by processNextGenEvent(), processNextSendEvent(), recvTimingResp(), and scheduleNextGenEvent().

nextSendEvent

SpatterGenEvent gem5::SpatterGen::nextSendEvent

private

Definition at line 214 of file spatter_gen.hh.

Referenced by processNextGenEvent(), processNextSendEvent(), recvReqRetry(), and scheduleNextSendEvent().

numPendingMemRequests

int gem5::SpatterGen::numPendingMemRequests

private

Definition at line 171 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextSendEvent(), and recvTimingResp().

port

SpatterGenPort gem5::SpatterGen::port

private

Definition at line 183 of file spatter_gen.hh.

Referenced by getPort(), and processNextSendEvent().

portBusyUntil

std::vector<Tick> gem5::SpatterGen::portBusyUntil

private

Definition at line 213 of file spatter_gen.hh.

Referenced by processNextSendEvent().

receiveBuffer

TimedQueue<SpatterAccess*> gem5::SpatterGen::receiveBuffer

private

Definition at line 224 of file spatter_gen.hh.

Referenced by interAccessOk(), processNextGenEvent(), recvTimingResp(), and ultAccessOk().

requestBuffer

TimedQueue<PacketPtr> gem5::SpatterGen::requestBuffer

private

Definition at line 203 of file spatter_gen.hh.

Referenced by checkForSimExit(), processNextGenEvent(), processNextSendEvent(), and scheduleNextSendEvent().

requestBufferEntries

int gem5::SpatterGen::requestBufferEntries

private

Definition at line 201 of file spatter_gen.hh.

Referenced by processNextGenEvent().

requestDepartureTime

std::unordered_map<RequestPtr, Tick> gem5::SpatterGen::requestDepartureTime

private

Definition at line 168 of file spatter_gen.hh.

Referenced by processNextSendEvent(), and recvTimingResp().

requestGenLatency

int gem5::SpatterGen::requestGenLatency

private

Definition at line 191 of file spatter_gen.hh.

Referenced by processNextGenEvent().

requestGenRate

int gem5::SpatterGen::requestGenRate

private

Definition at line 193 of file spatter_gen.hh.

Referenced by processNextGenEvent().

requestorId

RequestorID gem5::SpatterGen::requestorId

private

Definition at line 170 of file spatter_gen.hh.

Referenced by addKernel().

sendRate

int gem5::SpatterGen::sendRate

private

Definition at line 211 of file spatter_gen.hh.

Referenced by processNextSendEvent().

state

SpatterGenState gem5::SpatterGen::state

private

Definition at line 166 of file spatter_gen.hh.

Referenced by checkForSimExit(), initAccessOk(), proceedPastSyncPoint(), and processNextGenEvent().

stats

SpatterGenStats gem5::SpatterGen::stats

private

Definition at line 173 of file spatter_gen.hh.

Referenced by recvTimingResp().

---

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

• cpu/testers/spatter_gen/spatter_gen.hh
• cpu/testers/spatter_gen/spatter_gen.cc