#include <lds_state.hh>

Inheritance diagram for gem5::LdsState:

Classes
class	CuSidePort
	CuSidePort is the LDS Port closer to the CU side. More...

class	TickEvent
	an event to allow event-driven execution More...

Public Types
using	Params = LdsStateParams

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

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	LdsState (const Params &params)
	the default constructor that works with SWIG

	LdsState (const LdsState &)=delete

	~LdsState ()

bool	isRetryResp () const

void	setRetryResp (const bool value)

LdsState &	operator= (const LdsState &)=delete

int	increaseRefCounter (const uint32_t dispatchId, const uint32_t wgId)
	use the dynamic wave id to create or just increase the reference count

int	decreaseRefCounter (const uint32_t dispatchId, const uint32_t wgId)
	decrease the reference count after making sure it is in the list give back this chunk if the ref counter has reached 0

int	getRefCounter (const uint32_t dispatchId, const uint32_t wgId) const
	return the current reference count for this workgroup id

LdsChunk *	reserveSpace (const uint32_t dispatchId, const uint32_t wgId, const uint32_t size)
	assign a parent and request this amount of space be set aside for this wgid

LdsChunk *	getLdsChunk (const uint32_t dispatchId, const uint32_t wgId)

bool	returnQueuePush (std::pair< Tick, PacketPtr > thePair)
	add this to the queue of packets to be returned

Tick	earliestReturnTime () const

void	setParent (ComputeUnit *x_parent)
	set the parent and name based on the parent

ComputeUnit *	getParent () const

std::string	getName ()

int	getBanks () const

ComputeUnit *	getComputeUnit () const

int	getBankConflictPenalty () const

std::size_t	ldsSize (const uint32_t x_wgId)
	get the allocated size for this workgroup

AddrRange	getAddrRange () const

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

bool	canReserve (uint32_t x_size) const
	can this much space be reserved for a workgroup?

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
bool	process ()
	look for packets to return at this time

GPUDynInstPtr	getDynInstr (PacketPtr packet)

bool	processPacket (PacketPtr packet)
	process an incoming packet, add it to the return queue

unsigned	countBankConflicts (PacketPtr packet, unsigned *bankAccesses)
	derive the gpu mem packet from the packet and then count the bank conflicts

unsigned	countBankConflicts (GPUDynInstPtr gpuDynInst, unsigned *numBankAccesses)

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
std::unordered_map< uint32_t, std::unordered_map< uint32_t, int32_t > >	refCounter
	the lds reference counter The key is the workgroup ID and dispatch ID The value is the number of wavefronts that reference this LDS, as wavefronts are launched, the counter goes up for that workgroup and when they return it decreases, once it reaches 0 then this chunk of the LDS is returned to the available pool.

std::unordered_map< uint32_t, std::unordered_map< uint32_t, LdsChunk > >	chunkMap

TickEvent	tickEvent

std::queue< std::pair< Tick, PacketPtr > >	returnQueue

bool	retryResp = false

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.

Private Member Functions
bool	releaseSpace (const uint32_t x_dispatchId, const uint32_t x_wgId)
	give back the space

Private Attributes
CuSidePort	cuPort

ComputeUnit *	parent = nullptr

std::string	_name

int	bytesAllocated = 0

int	maximumSize

AddrRange	range

int	bankConflictPenalty = 0

int	banks = 0

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

Definition at line 188 of file lds_state.hh.

Member Typedef Documentation

◆ Params

using gem5::LdsState::Params = LdsStateParams

Definition at line 331 of file lds_state.hh.

Constructor & Destructor Documentation

◆ LdsState() [1/2]

gem5::LdsState::LdsState ( const Params & params )

the default constructor that works with SWIG

Definition at line 48 of file lds_state.cc.

References fatal_if, and gem5::SimObject::params().

◆ LdsState() [2/2]

gem5::LdsState::LdsState ( const LdsState & )

delete

◆ ~LdsState()

gem5::LdsState::~LdsState ( )

inline

Definition at line 338 of file lds_state.hh.

References parent.

Member Function Documentation

◆ canReserve()

bool gem5::LdsState::canReserve ( uint32_t x_size ) const

inline

can this much space be reserved for a workgroup?

Definition at line 549 of file lds_state.hh.

References bytesAllocated, and maximumSize.

Referenced by gem5::ComputeUnit::hasDispResources().

◆ countBankConflicts() [1/2]

unsigned gem5::LdsState::countBankConflicts	(	GPUDynInstPtr	gpuDynInst,
		unsigned *	numBankAccesses )

protected

Definition at line 105 of file lds_state.cc.

References banks, gem5::ArmISA::i, panic_if, parent, and gem5::ComputeUnit::wfSize().

◆ countBankConflicts() [2/2]

unsigned gem5::LdsState::countBankConflicts	(	PacketPtr	packet,
		unsigned *	bankAccesses )

protected

derive the gpu mem packet from the packet and then count the bank conflicts

Definition at line 86 of file lds_state.cc.

References countBankConflicts(), fatal_if, gem5::ComputeUnit::LDSPort::SenderState::getMemInst(), gem5::Packet::SenderState::predecessor, and gem5::Packet::senderState.

Referenced by countBankConflicts(), and processPacket().

◆ decreaseRefCounter()

int gem5::LdsState::decreaseRefCounter	(	const uint32_t	dispatchId,
		const uint32_t	wgId )

inline

decrease the reference count after making sure it is in the list give back this chunk if the ref counter has reached 0

Definition at line 376 of file lds_state.hh.

References fatal_if, getRefCounter(), refCounter, and releaseSpace().

Referenced by gem5::VegaISA::Inst_SOPP__S_ENDPGM::execute().

◆ earliestReturnTime()

Tick gem5::LdsState::earliestReturnTime ( ) const

inline

Definition at line 479 of file lds_state.hh.

References gem5::curTick(), and returnQueue.

Referenced by processPacket().

◆ getAddrRange()

AddrRange gem5::LdsState::getAddrRange ( ) const

inline

Definition at line 529 of file lds_state.hh.

References range.

Referenced by gem5::LdsState::CuSidePort::getAddrRanges(), and gem5::GPUDynInst::resolveFlatSegment().

◆ getBankConflictPenalty()

int gem5::LdsState::getBankConflictPenalty ( ) const

inline

Definition at line 514 of file lds_state.hh.

References bankConflictPenalty.

◆ getBanks()

int gem5::LdsState::getBanks ( ) const

inline

Definition at line 502 of file lds_state.hh.

References banks.

◆ getComputeUnit()

ComputeUnit * gem5::LdsState::getComputeUnit ( ) const

inline

Definition at line 508 of file lds_state.hh.

References parent.

◆ getDynInstr()

GPUDynInstPtr gem5::LdsState::getDynInstr ( PacketPtr packet )

protected

Definition at line 175 of file lds_state.cc.

References gem5::ComputeUnit::LDSPort::SenderState::getMemInst(), gem5::Packet::senderState, and gem5::ArmISA::ss.

Referenced by processPacket().

◆ getLdsChunk()

LdsChunk * gem5::LdsState::getLdsChunk	(	const uint32_t	dispatchId,
		const uint32_t	wgId )

inline

Definition at line 463 of file lds_state.hh.

References chunkMap, fatal_if, and gem5::SimObject::find().

◆ getName()

std::string gem5::LdsState::getName ( )

inline

Definition at line 496 of file lds_state.hh.

References _name.

◆ getParent()

ComputeUnit * gem5::LdsState::getParent ( ) const

inline

Definition at line 490 of file lds_state.hh.

References parent.

◆ getPort()

Port & gem5::LdsState::getPort	(	const std::string &	if_name,
		PortID	idx )

inlinevirtual

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 535 of file lds_state.hh.

References cuPort, and fatal.

◆ getRefCounter()

int gem5::LdsState::getRefCounter	(	const uint32_t	dispatchId,
		const uint32_t	wgId ) const

inline

return the current reference count for this workgroup id

Definition at line 398 of file lds_state.hh.

References chunkMap, fatal, fatal_if, and refCounter.

Referenced by decreaseRefCounter(), gem5::ComputeUnit::getRefCounter(), and increaseRefCounter().

◆ increaseRefCounter()

int gem5::LdsState::increaseRefCounter	(	const uint32_t	dispatchId,
		const uint32_t	wgId )

inline

use the dynamic wave id to create or just increase the reference count

Definition at line 363 of file lds_state.hh.

References fatal_if, getRefCounter(), and refCounter.

Referenced by gem5::ComputeUnit::startWavefront().

◆ isRetryResp()

bool gem5::LdsState::isRetryResp ( ) const

inline

Definition at line 344 of file lds_state.hh.

References retryResp.

◆ ldsSize()

std::size_t gem5::LdsState::ldsSize ( const uint32_t x_wgId )

inline

get the allocated size for this workgroup

Definition at line 523 of file lds_state.hh.

References chunkMap.

◆ operator=()

LdsState & gem5::LdsState::operator= ( const LdsState & )

delete

◆ process()

bool gem5::LdsState::process ( )

protected

look for packets to return at this time

Definition at line 266 of file lds_state.cc.

References gem5::Clocked::clockEdge(), cuPort, gem5::LdsState::TickEvent::deschedule(), gem5::ComputeUnit::LDSPort::SenderState::getMemInst(), gem5::Packet::makeTimingResponse(), panic, retryResp, returnQueue, gem5::LdsState::TickEvent::schedule(), gem5::Event::scheduled(), gem5::Packet::senderState, gem5::ResponsePort::sendTimingResp(), gem5::ArmISA::ss, tickEvent, and gem5::Event::when().

Referenced by returnQueuePush().

◆ processPacket()

bool gem5::LdsState::processPacket ( PacketPtr packet )

protected

process an incoming packet, add it to the return queue

Definition at line 187 of file lds_state.cc.

References bankConflictPenalty, countBankConflicts(), gem5::Clocked::cyclesToTicks(), earliestReturnTime(), getDynInstr(), gem5::ComputeUnit::ComputeUnitStats::ldsBankAccesses, gem5::ComputeUnit::ComputeUnitStats::ldsBankConflictDist, gem5::ComputeUnit::loadBusLength(), parent, returnQueuePush(), gem5::statistics::DistBase< Derived, Stor >::sample(), gem5::ComputeUnit::stats, and gem5::ComputeUnit::storeBusLength().

Referenced by gem5::LdsState::CuSidePort::recvTimingReq().

◆ releaseSpace()

bool gem5::LdsState::releaseSpace	(	const uint32_t	x_dispatchId,
		const uint32_t	x_wgId )

inlineprivate

give back the space

Definition at line 559 of file lds_state.hh.

References bytesAllocated, chunkMap, fatal, fatal_if, and gem5::SimObject::find().

Referenced by decreaseRefCounter().

◆ reserveSpace()

LdsChunk * gem5::LdsState::reserveSpace	(	const uint32_t	dispatchId,
		const uint32_t	wgId,
		const uint32_t	size )

inline

assign a parent and request this amount of space be set aside for this wgid

Definition at line 431 of file lds_state.hh.

References bytesAllocated, chunkMap, gem5::SimObject::find(), maximumSize, panic_if, and refCounter.

Referenced by gem5::ComputeUnit::dispWorkgroup().

◆ returnQueuePush()

bool gem5::LdsState::returnQueuePush ( std::pair< Tick, PacketPtr > thePair )

add this to the queue of packets to be returned

Definition at line 218 of file lds_state.cc.

References process(), returnQueue, gem5::Event::scheduled(), and tickEvent.

Referenced by processPacket().

◆ setParent()

void gem5::LdsState::setParent ( ComputeUnit * x_parent )

set the parent and name based on the parent

Definition at line 71 of file lds_state.cc.

References _name, fatal_if, gem5::Named::name(), and parent.

◆ setRetryResp()

void gem5::LdsState::setRetryResp ( const bool value )

inline

Definition at line 350 of file lds_state.hh.

References retryResp.

Member Data Documentation

◆ _name

std::string gem5::LdsState::_name

private

Definition at line 586 of file lds_state.hh.

Referenced by getName(), and setParent().

◆ bankConflictPenalty

int gem5::LdsState::bankConflictPenalty = 0

private

Definition at line 598 of file lds_state.hh.

Referenced by getBankConflictPenalty(), and processPacket().

◆ banks

int gem5::LdsState::banks = 0

private

Definition at line 601 of file lds_state.hh.

Referenced by countBankConflicts(), and getBanks().

◆ bytesAllocated

int gem5::LdsState::bytesAllocated = 0

private

Definition at line 589 of file lds_state.hh.

Referenced by canReserve(), releaseSpace(), and reserveSpace().

◆ chunkMap

std::unordered_map<uint32_t, std::unordered_map<uint32_t, LdsChunk> > gem5::LdsState::chunkMap

protected

Definition at line 301 of file lds_state.hh.

Referenced by getLdsChunk(), getRefCounter(), ldsSize(), releaseSpace(), and reserveSpace().

◆ cuPort

CuSidePort gem5::LdsState::cuPort

private

Definition at line 582 of file lds_state.hh.

Referenced by getPort(), and process().

◆ maximumSize

int gem5::LdsState::maximumSize

private

Definition at line 592 of file lds_state.hh.

Referenced by canReserve(), and reserveSpace().

◆ parent

ComputeUnit* gem5::LdsState::parent = nullptr

private

Definition at line 584 of file lds_state.hh.

Referenced by countBankConflicts(), getComputeUnit(), getParent(), processPacket(), setParent(), and ~LdsState().

◆ range

AddrRange gem5::LdsState::range

private

Definition at line 595 of file lds_state.hh.

Referenced by getAddrRange().

◆ refCounter

std::unordered_map<uint32_t, std::unordered_map<uint32_t, int32_t> > gem5::LdsState::refCounter

protected

the lds reference counter The key is the workgroup ID and dispatch ID The value is the number of wavefronts that reference this LDS, as wavefronts are launched, the counter goes up for that workgroup and when they return it decreases, once it reaches 0 then this chunk of the LDS is returned to the available pool.

However,it is deallocated on the 1->0 transition, not whenever the counter is 0 as it always starts with 0 when the workgroup asks for space

Definition at line 297 of file lds_state.hh.

Referenced by decreaseRefCounter(), getRefCounter(), increaseRefCounter(), and reserveSpace().

◆ retryResp

bool gem5::LdsState::retryResp = false

protected

Definition at line 312 of file lds_state.hh.

Referenced by isRetryResp(), process(), and setRetryResp().

◆ returnQueue

std::queue<std::pair<Tick, PacketPtr> > gem5::LdsState::returnQueue

protected

Definition at line 309 of file lds_state.hh.

Referenced by earliestReturnTime(), process(), and returnQueuePush().

◆ tickEvent

TickEvent gem5::LdsState::tickEvent

protected

Definition at line 304 of file lds_state.hh.

Referenced by process(), and returnQueuePush().

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

gpu-compute/lds_state.hh
gpu-compute/lds_state.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ LdsState() [1/2]

◆ LdsState() [2/2]

◆ ~LdsState()

Member Function Documentation

◆ canReserve()

◆ countBankConflicts() [1/2]

◆ countBankConflicts() [2/2]

◆ decreaseRefCounter()

◆ earliestReturnTime()

◆ getAddrRange()

◆ getBankConflictPenalty()

◆ getBanks()

◆ getComputeUnit()

◆ getDynInstr()

◆ getLdsChunk()

◆ getName()

◆ getParent()

◆ getPort()

◆ getRefCounter()

◆ increaseRefCounter()

◆ isRetryResp()

◆ ldsSize()

◆ operator=()

◆ process()

◆ processPacket()

◆ releaseSpace()

◆ reserveSpace()

◆ returnQueuePush()

◆ setParent()

◆ setRetryResp()

Member Data Documentation

◆ _name

◆ bankConflictPenalty

◆ banks

◆ bytesAllocated

◆ chunkMap

◆ cuPort

◆ maximumSize

◆ parent

◆ range

◆ refCounter

◆ retryResp

◆ returnQueue

◆ tickEvent