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

#include <lds_state.hh>

Inheritance diagram for gem5::LdsState:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

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. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 LdsState (const Params &params)
 the default constructor that works with SWIG More...
 
 LdsState (const LdsState &)=delete
 
 ~LdsState ()
 
bool isRetryResp () const
 
void setRetryResp (const bool value)
 
LdsStateoperator= (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 More...
 
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 More...
 
int getRefCounter (const uint32_t dispatchId, const uint32_t wgId) const
 return the current reference count for this workgroup id More...
 
LdsChunkreserveSpace (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 More...
 
LdsChunkgetLdsChunk (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 More...
 
Tick earliestReturnTime () const
 
void setParent (ComputeUnit *x_parent)
 set the parent and name based on the parent More...
 
ComputeUnitgetParent () const
 
std::string getName ()
 
int getBanks () const
 
ComputeUnitgetComputeUnit () const
 
int getBankConflictPenalty () const
 
std::size_t ldsSize (const uint32_t x_wgId)
 get the allocated size for this workgroup More...
 
AddrRange getAddrRange () const
 
PortgetPort (const std::string &if_name, PortID idx)
 Get a port with a given name and index. More...
 
bool canReserve (uint32_t x_size) const
 can this much space be reserved for a workgroup? 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

bool process ()
 look for packets to return at this time More...
 
GPUDynInstPtr getDynInstr (PacketPtr packet)
 
bool processPacket (PacketPtr packet)
 process an incoming packet, add it to the return queue More...
 
unsigned countBankConflicts (PacketPtr packet, unsigned *bankAccesses)
 derive the gpu mem packet from the packet and then count the bank conflicts More...
 
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. 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

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. More...
 
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. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Member Functions

bool releaseSpace (const uint32_t x_dispatchId, const uint32_t x_wgId)
 give back the space More...
 

Private Attributes

CuSidePort cuPort
 
ComputeUnitparent = 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. 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

Definition at line 122 of file lds_state.hh.

Member Typedef Documentation

◆ Params

using gem5::LdsState::Params = LdsStateParams

Definition at line 265 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 50 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 272 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 480 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

◆ 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 88 of file lds_state.cc.

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

Referenced by 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 310 of file lds_state.hh.

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

Referenced by gem5::Gcn3ISA::Inst_SOPP__S_ENDPGM::execute(), and gem5::VegaISA::Inst_SOPP__S_ENDPGM::execute().

◆ earliestReturnTime()

Tick gem5::LdsState::earliestReturnTime ( ) const
inline

Definition at line 410 of file lds_state.hh.

References gem5::curTick(), and returnQueue.

Referenced by processPacket().

◆ getAddrRange()

AddrRange gem5::LdsState::getAddrRange ( ) const
inline

◆ getBankConflictPenalty()

int gem5::LdsState::getBankConflictPenalty ( ) const
inline

Definition at line 445 of file lds_state.hh.

References bankConflictPenalty.

◆ getBanks()

int gem5::LdsState::getBanks ( ) const
inline

Definition at line 433 of file lds_state.hh.

References banks.

◆ getComputeUnit()

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

Definition at line 439 of file lds_state.hh.

References parent.

◆ getDynInstr()

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

Definition at line 177 of file lds_state.cc.

References gem5::Packet::senderState, and ss.

Referenced by processPacket().

◆ getLdsChunk()

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

Definition at line 394 of file lds_state.hh.

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

◆ getName()

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

Definition at line 427 of file lds_state.hh.

References _name.

◆ getParent()

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

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

Reimplemented from gem5::SimObject.

Definition at line 466 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 332 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 297 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 278 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 454 of file lds_state.hh.

References chunkMap.

◆ operator=()

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

◆ process()

bool gem5::LdsState::process ( )
protected

◆ processPacket()

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

◆ releaseSpace()

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

give back the space

Definition at line 490 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 365 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 220 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 73 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 284 of file lds_state.hh.

References retryResp.

Member Data Documentation

◆ _name

std::string gem5::LdsState::_name
private

Definition at line 517 of file lds_state.hh.

Referenced by getName(), and setParent().

◆ bankConflictPenalty

int gem5::LdsState::bankConflictPenalty = 0
private

Definition at line 529 of file lds_state.hh.

Referenced by getBankConflictPenalty(), and processPacket().

◆ banks

int gem5::LdsState::banks = 0
private

Definition at line 532 of file lds_state.hh.

Referenced by countBankConflicts(), and getBanks().

◆ bytesAllocated

int gem5::LdsState::bytesAllocated = 0
private

Definition at line 520 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 235 of file lds_state.hh.

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

◆ cuPort

CuSidePort gem5::LdsState::cuPort
private

Definition at line 513 of file lds_state.hh.

Referenced by getPort(), and process().

◆ maximumSize

int gem5::LdsState::maximumSize
private

Definition at line 523 of file lds_state.hh.

Referenced by canReserve(), and reserveSpace().

◆ parent

ComputeUnit* gem5::LdsState::parent = nullptr
private

◆ range

AddrRange gem5::LdsState::range
private

Definition at line 526 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 231 of file lds_state.hh.

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

◆ retryResp

bool gem5::LdsState::retryResp = false
protected

Definition at line 246 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 243 of file lds_state.hh.

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

◆ tickEvent

TickEvent gem5::LdsState::tickEvent
protected

Definition at line 238 of file lds_state.hh.

Referenced by process(), and returnQueuePush().


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

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