gem5  v21.1.0.2
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gem5::ruby::DMASequencer Class Reference

#include <DMASequencer.hh>

Inheritance diagram for gem5::ruby::DMASequencer:
gem5::ruby::RubyPort gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef DMASequencerParams Params
 
- Public Types inherited from gem5::ruby::RubyPort
typedef RubyPortParams 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

 DMASequencer (const Params &)
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
RequestStatus makeRequest (PacketPtr pkt) override
 
bool busy ()
 
int outstandingCount () const override
 
bool isDeadlockEventScheduled () const override
 
void descheduleDeadlockEvent () override
 
void dataCallback (const DataBlock &dblk, const Addr &addr)
 
void ackCallback (const Addr &addr)
 
void atomicCallback (const DataBlock &dblk, const Addr &addr)
 
void recordRequestType (DMASequencerRequestType requestType)
 
- Public Member Functions inherited from gem5::ruby::RubyPort
 RubyPort (const Params &p)
 
virtual ~RubyPort ()
 
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...
 
void setController (AbstractController *_cntrl)
 
uint32_t getId ()
 
DrainState drain () override
 Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight. More...
 
bool isCPUSequencer ()
 
virtual int functionalWrite (Packet *func_pkt)
 
- 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
 

Private Types

typedef std::unordered_map< Addr, DMARequestRequestTable
 

Private Member Functions

void issueNext (const Addr &addr)
 

Private Attributes

uint64_t m_data_block_mask
 
RequestTable m_RequestTable
 
int m_outstanding_count
 
int m_max_outstanding_requests
 

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
 
- Protected Member Functions inherited from gem5::ruby::RubyPort
void trySendRetries ()
 
void ruby_hit_callback (PacketPtr pkt)
 
void testDrainComplete ()
 
void ruby_eviction_callback (Addr address)
 
bool recvTimingResp (PacketPtr pkt, PortID request_port_id)
 Called by the PIO port when receiving a timing response. 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 inherited from gem5::ruby::RubyPort
RubySystemm_ruby_system
 
uint32_t m_version
 
AbstractControllerm_controller
 
MessageBufferm_mandatory_q_ptr
 
bool m_usingRubyTester
 
Systemsystem
 
std::vector< MemResponsePort * > response_ports
 
- 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...
 

Detailed Description

Definition at line 62 of file DMASequencer.hh.

Member Typedef Documentation

◆ Params

typedef DMASequencerParams gem5::ruby::DMASequencer::Params

Definition at line 65 of file DMASequencer.hh.

◆ RequestTable

typedef std::unordered_map<Addr, DMARequest> gem5::ruby::DMASequencer::RequestTable
private

Definition at line 88 of file DMASequencer.hh.

Constructor & Destructor Documentation

◆ DMASequencer()

gem5::ruby::DMASequencer::DMASequencer ( const Params p)

Definition at line 66 of file DMASequencer.cc.

Member Function Documentation

◆ ackCallback()

void gem5::ruby::DMASequencer::ackCallback ( const Addr addr)

Definition at line 239 of file DMASequencer.cc.

References issueNext(), and m_RequestTable.

◆ atomicCallback()

void gem5::ruby::DMASequencer::atomicCallback ( const DataBlock dblk,
const Addr addr 
)

◆ busy()

bool gem5::ruby::DMASequencer::busy ( )
inline

Definition at line 71 of file DMASequencer.hh.

References m_outstanding_count.

◆ dataCallback()

void gem5::ruby::DMASequencer::dataCallback ( const DataBlock dblk,
const Addr addr 
)

◆ descheduleDeadlockEvent()

void gem5::ruby::DMASequencer::descheduleDeadlockEvent ( )
inlineoverridevirtual

Implements gem5::ruby::RubyPort.

Definition at line 74 of file DMASequencer.hh.

◆ init()

void gem5::ruby::DMASequencer::init ( )
overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 73 of file DMASequencer.cc.

References gem5::ruby::RubySystem::getBlockSizeBits(), gem5::ruby::RubyPort::init(), m_data_block_mask, and gem5::mask().

◆ isDeadlockEventScheduled()

bool gem5::ruby::DMASequencer::isDeadlockEventScheduled ( ) const
inlineoverridevirtual

Implements gem5::ruby::RubyPort.

Definition at line 73 of file DMASequencer.hh.

◆ issueNext()

void gem5::ruby::DMASequencer::issueNext ( const Addr addr)
private

◆ makeRequest()

RequestStatus gem5::ruby::DMASequencer::makeRequest ( PacketPtr  pkt)
overridevirtual

◆ outstandingCount()

int gem5::ruby::DMASequencer::outstandingCount ( ) const
inlineoverridevirtual

Implements gem5::ruby::RubyPort.

Definition at line 72 of file DMASequencer.hh.

References m_outstanding_count.

◆ recordRequestType()

void gem5::ruby::DMASequencer::recordRequestType ( DMASequencerRequestType  requestType)

Definition at line 265 of file DMASequencer.cc.

References DPRINTF.

Member Data Documentation

◆ m_data_block_mask

uint64_t gem5::ruby::DMASequencer::m_data_block_mask
private

Definition at line 86 of file DMASequencer.hh.

Referenced by atomicCallback(), dataCallback(), init(), issueNext(), and makeRequest().

◆ m_max_outstanding_requests

int gem5::ruby::DMASequencer::m_max_outstanding_requests
private

Definition at line 92 of file DMASequencer.hh.

Referenced by issueNext(), and makeRequest().

◆ m_outstanding_count

int gem5::ruby::DMASequencer::m_outstanding_count
private

Definition at line 91 of file DMASequencer.hh.

Referenced by atomicCallback(), busy(), issueNext(), makeRequest(), and outstandingCount().

◆ m_RequestTable

RequestTable gem5::ruby::DMASequencer::m_RequestTable
private

Definition at line 89 of file DMASequencer.hh.

Referenced by ackCallback(), atomicCallback(), dataCallback(), issueNext(), and makeRequest().


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

Generated on Tue Sep 21 2021 12:32:04 for gem5 by doxygen 1.8.17