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

#include <hsa_packet_processor.hh>

Inheritance diagram for gem5::HSAPacketProcessor:
gem5::DmaVirtDevice gem5::DmaDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  dma_series_ctx
 Calls getCurrentEntry once the queueEntry has been dmaRead. More...
 
class  QueueProcessEvent
 
class  RQLEntry
 
class  SignalState
 

Public Types

typedef HSAPacketProcessorParams Params
 
- Public Types inherited from gem5::DmaVirtDevice
typedef void(DmaDevice::* DmaFnPtr) (Addr, int, Event *, uint8_t *, Tick)
 
- Public Types inherited from gem5::DmaDevice
typedef DmaDeviceParams Params
 
- Public Types inherited from gem5::PioDevice
using Params = PioDeviceParams
 
- 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

HSAQueueDescriptorgetQueueDesc (uint32_t queId)
 
class RQLEntrygetRegdListEntry (uint32_t queId)
 
uint64_t inFlightPkts (uint32_t queId)
 
 HSAPacketProcessor (const Params &p)
 
 ~HSAPacketProcessor ()
 
void translateOrDie (Addr vaddr, Addr &paddr) override
 Function used to translate from virtual to physical addresses. More...
 
void setDeviceQueueDesc (uint64_t hostReadIndexPointer, uint64_t basePointer, uint64_t queue_id, uint32_t size, int doorbellSize)
 
void unsetDeviceQueueDesc (uint64_t queue_id, int doorbellSize)
 
void setDevice (GPUCommandProcessor *dev)
 
void updateReadIndex (int, uint32_t)
 
void getCommandsFromHost (int pid, uint32_t rl_idx)
 
virtual Tick read (Packet *) override
 
virtual Tick write (Packet *) override
 
virtual AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
void finishPkt (void *pkt, uint32_t rl_idx)
 
void finishPkt (void *pkt)
 
void schedAQLProcessing (uint32_t rl_idx)
 
void schedAQLProcessing (uint32_t rl_idx, Tick delay)
 
void sendAgentDispatchCompletionSignal (void *pkt, hsa_signal_value_t signal)
 
void sendCompletionSignal (hsa_signal_value_t signal)
 
void updateReadDispIdDma ()
 this event is used to update the read_disp_id field (the read pointer) of the MQD, which is how the host code knows the status of the HQD's read pointer More...
 
void cmdQueueCmdDma (HSAPacketProcessor *hsaPP, int pid, bool isRead, uint32_t ix_start, unsigned num_pkts, dma_series_ctx *series_ctx, void *dest_4debug)
 
void handleReadDMA ()
 
- Public Member Functions inherited from gem5::DmaVirtDevice
 DmaVirtDevice (const Params &p)
 
virtual ~DmaVirtDevice ()
 
void dmaReadVirt (Addr host_addr, unsigned size, DmaCallback *cb, void *data, Tick delay=0)
 Initiate a DMA read from virtual address host_addr. More...
 
void dmaWriteVirt (Addr host_addr, unsigned size, DmaCallback *b, void *data, Tick delay=0)
 Initiate a DMA write from virtual address host_addr. More...
 
void dmaVirt (DmaFnPtr dmaFn, Addr host_addr, unsigned size, DmaCallback *cb, void *data, Tick delay=0)
 Initiate a call to DmaDevice using DmaFnPtr do a DMA starting from virtual address host_addr for size number of bytes on the data. More...
 
- Public Member Functions inherited from gem5::DmaDevice
 DmaDevice (const Params &p)
 
virtual ~DmaDevice ()=default
 
void dmaWrite (Addr addr, int size, Event *event, uint8_t *data, uint32_t sid, uint32_t ssid, Tick delay=0)
 
void dmaWrite (Addr addr, int size, Event *event, uint8_t *data, Tick delay=0)
 
void dmaRead (Addr addr, int size, Event *event, uint8_t *data, uint32_t sid, uint32_t ssid, Tick delay=0)
 
void dmaRead (Addr addr, int size, Event *event, uint8_t *data, Tick delay=0)
 
bool dmaPending () const
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
unsigned int cacheBlockSize () const
 
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::PioDevice
 PioDevice (const Params &p)
 
virtual ~PioDevice ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 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
 

Public Attributes

int numHWQueues
 
Addr pioAddr
 
Addr pioSize
 
Tick pioDelay
 
const Tick pktProcessDelay
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Protected Types

typedef void(DmaDevice::* DmaFnPtr) (Addr, int, Event *, uint8_t *, Tick)
 

Protected Member Functions

Q_STATE processPkt (void *pkt, uint32_t rl_idx, Addr host_pkt_addr)
 
void displayQueueDescriptor (int pid, uint32_t rl_idx)
 
- Protected Member Functions inherited from gem5::PioDevice
virtual Tick read (PacketPtr pkt)=0
 Pure virtual function that the device must implement. More...
 
virtual Tick write (PacketPtr pkt)=0
 Pure virtual function that the device must implement. More...
 
- 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

GPUCommandProcessorgpu_device
 
HWSchedulerhwSchdlr
 
std::vector< class RQLEntry * > regdQList
 
- Protected Attributes inherited from gem5::DmaDevice
DmaPort dmaPort
 
- Protected Attributes inherited from gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- 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...
 

Friends

class HWScheduler
 

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

Detailed Description

Definition at line 224 of file hsa_packet_processor.hh.

Member Typedef Documentation

◆ DmaFnPtr

typedef void(DmaDevice::* gem5::HSAPacketProcessor::DmaFnPtr) (Addr, int, Event *, uint8_t *, Tick)
protected

Definition at line 228 of file hsa_packet_processor.hh.

◆ Params

typedef HSAPacketProcessorParams gem5::HSAPacketProcessor::Params

Definition at line 321 of file hsa_packet_processor.hh.

Constructor & Destructor Documentation

◆ HSAPacketProcessor()

gem5::HSAPacketProcessor::HSAPacketProcessor ( const Params p)

Definition at line 74 of file hsa_packet_processor.cc.

References DPRINTF, gem5::ArmISA::i, and gem5::MipsISA::p.

◆ ~HSAPacketProcessor()

gem5::HSAPacketProcessor::~HSAPacketProcessor ( )

Definition at line 86 of file hsa_packet_processor.cc.

References regdQList.

Member Function Documentation

◆ cmdQueueCmdDma()

void gem5::HSAPacketProcessor::cmdQueueCmdDma ( HSAPacketProcessor hsaPP,
int  pid,
bool  isRead,
uint32_t  ix_start,
unsigned  num_pkts,
dma_series_ctx series_ctx,
void *  dest_4debug 
)

◆ displayQueueDescriptor()

void gem5::HSAPacketProcessor::displayQueueDescriptor ( int  pid,
uint32_t  rl_idx 
)
protected

Definition at line 560 of file hsa_packet_processor.cc.

References DPRINTF, and regdQList.

◆ finishPkt() [1/2]

void gem5::HSAPacketProcessor::finishPkt ( void *  pkt)
inline

Definition at line 339 of file hsa_packet_processor.hh.

References finishPkt().

Referenced by finishPkt().

◆ finishPkt() [2/2]

void gem5::HSAPacketProcessor::finishPkt ( void *  pkt,
uint32_t  rl_idx 
)

◆ getAddrRanges()

AddrRangeList gem5::HSAPacketProcessor::getAddrRanges ( ) const
overridevirtual

Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Returns
a list of non-overlapping address ranges

Implements gem5::PioDevice.

Definition at line 113 of file hsa_packet_processor.cc.

References pioAddr, pioSize, and gem5::RangeSize().

◆ getCommandsFromHost()

void gem5::HSAPacketProcessor::getCommandsFromHost ( int  pid,
uint32_t  rl_idx 
)

◆ getQueueDesc()

HSAQueueDescriptor* gem5::HSAPacketProcessor::getQueueDesc ( uint32_t  queId)
inline

◆ getRegdListEntry()

class RQLEntry* gem5::HSAPacketProcessor::getRegdListEntry ( uint32_t  queId)
inline

◆ handleReadDMA()

void gem5::HSAPacketProcessor::handleReadDMA ( )

◆ inFlightPkts()

uint64_t gem5::HSAPacketProcessor::inFlightPkts ( uint32_t  queId)
inline

◆ processPkt()

Q_STATE gem5::HSAPacketProcessor::processPkt ( void *  pkt,
uint32_t  rl_idx,
Addr  host_pkt_addr 
)
protected

◆ read()

Tick gem5::HSAPacketProcessor::read ( Packet pkt)
overridevirtual

◆ schedAQLProcessing() [1/2]

void gem5::HSAPacketProcessor::schedAQLProcessing ( uint32_t  rl_idx)

◆ schedAQLProcessing() [2/2]

void gem5::HSAPacketProcessor::schedAQLProcessing ( uint32_t  rl_idx,
Tick  delay 
)

◆ sendAgentDispatchCompletionSignal()

void gem5::HSAPacketProcessor::sendAgentDispatchCompletionSignal ( void *  pkt,
hsa_signal_value_t  signal 
)

HACK: The semantics of the HSA signal is to decrement the current signal value. I'm going to cheat here and read out the value from main memory using functional access, and then just DMA the decremented value. The reason for this is that the DMASequencer does not support atomic operations.

Definition at line 672 of file hsa_packet_processor.cc.

References gem5::DmaVirtDevice::dmaWriteVirt(), DPRINTF, gem5::PioDevice::sys, and gem5::System::threads.

Referenced by processPkt().

◆ sendCompletionSignal()

void gem5::HSAPacketProcessor::sendCompletionSignal ( hsa_signal_value_t  signal)

HACK: The semantics of the HSA signal is to decrement the current signal value. I'm going to cheat here and read out the value from main memory using functional access, and then just DMA the decremented value. The reason for this is that the DMASequencer does not support atomic operations.

Definition at line 702 of file hsa_packet_processor.cc.

References gem5::DmaVirtDevice::dmaWriteVirt(), DPRINTF, gem5::PioDevice::sys, and gem5::System::threads.

◆ setDevice()

void gem5::HSAPacketProcessor::setDevice ( GPUCommandProcessor dev)

Definition at line 605 of file hsa_packet_processor.cc.

References gpu_device.

Referenced by gem5::GPUCommandProcessor::GPUCommandProcessor().

◆ setDeviceQueueDesc()

void gem5::HSAPacketProcessor::setDeviceQueueDesc ( uint64_t  hostReadIndexPointer,
uint64_t  basePointer,
uint64_t  queue_id,
uint32_t  size,
int  doorbellSize 
)

◆ translateOrDie()

void gem5::HSAPacketProcessor::translateOrDie ( Addr  vaddr,
Addr paddr 
)
overridevirtual

Function used to translate from virtual to physical addresses.

All classes inheriting from DmaVirtDevice must define this.

Parameters
vaddrInput virtual address
paddrOutput physical address written by reference

Implements gem5::DmaVirtDevice.

Definition at line 163 of file hsa_packet_processor.cc.

References fatal, gem5::PioDevice::sys, gem5::System::threads, and gem5::MipsISA::vaddr.

◆ unsetDeviceQueueDesc()

void gem5::HSAPacketProcessor::unsetDeviceQueueDesc ( uint64_t  queue_id,
int  doorbellSize 
)

◆ updateReadDispIdDma()

void gem5::HSAPacketProcessor::updateReadDispIdDma ( )

this event is used to update the read_disp_id field (the read pointer) of the MQD, which is how the host code knows the status of the HQD's read pointer

Definition at line 180 of file hsa_packet_processor.cc.

References DPRINTF.

Referenced by updateReadIndex().

◆ updateReadIndex()

void gem5::HSAPacketProcessor::updateReadIndex ( int  pid,
uint32_t  rl_idx 
)

◆ write()

Tick gem5::HSAPacketProcessor::write ( Packet pkt)
overridevirtual

Friends And Related Function Documentation

◆ HWScheduler

friend class HWScheduler
friend

Definition at line 226 of file hsa_packet_processor.hh.

Member Data Documentation

◆ gpu_device

GPUCommandProcessor* gem5::HSAPacketProcessor::gpu_device
protected

Definition at line 229 of file hsa_packet_processor.hh.

Referenced by processPkt(), setDevice(), and write().

◆ hwSchdlr

HWScheduler* gem5::HSAPacketProcessor::hwSchdlr
protected

Definition at line 230 of file hsa_packet_processor.hh.

Referenced by setDeviceQueueDesc(), unsetDeviceQueueDesc(), and write().

◆ numHWQueues

int gem5::HSAPacketProcessor::numHWQueues

◆ pioAddr

Addr gem5::HSAPacketProcessor::pioAddr

◆ pioDelay

Tick gem5::HSAPacketProcessor::pioDelay

Definition at line 318 of file hsa_packet_processor.hh.

Referenced by read(), and write().

◆ pioSize

Addr gem5::HSAPacketProcessor::pioSize

Definition at line 317 of file hsa_packet_processor.hh.

Referenced by getAddrRanges(), and write().

◆ pktProcessDelay

const Tick gem5::HSAPacketProcessor::pktProcessDelay

Definition at line 319 of file hsa_packet_processor.hh.

Referenced by schedAQLProcessing().

◆ regdQList

std::vector<class RQLEntry *> gem5::HSAPacketProcessor::regdQList
protected

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

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