#include <VIPERCoalescer.hh>

Inheritance diagram for gem5::ruby::VIPERCoalescer:

Public Types
typedef VIPERCoalescerParams	Params

Public Types inherited from gem5::ruby::GPUCoalescer
typedef RubyGPUCoalescerParams	Params

Public Types inherited from gem5::ruby::RubyPort
typedef RubyPortParams	Params

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

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	VIPERCoalescer (const Params &)

	~VIPERCoalescer ()

void	writeCompleteCallback (Addr address, uint64_t instSeqNum)

void	invTCPCallback (Addr address)

RequestStatus	makeRequest (PacketPtr pkt) override

void	issueRequest (CoalescedRequest *crequest) override

Public Member Functions inherited from gem5::ruby::GPUCoalescer
	GPUCoalescer (const Params &)

	~GPUCoalescer ()

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

void	wakeup ()

void	printRequestTable (std::stringstream &ss)

void	printProgress (std::ostream &out) const

void	resetStats () override
	Callback to reset stats.

void	collateStats ()

void	writeCallback (Addr address, DataBlock &data)

void	writeCallback (Addr address, MachineType mach, DataBlock &data)

void	writeCallback (Addr address, MachineType mach, DataBlock &data, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime, bool isRegion)

void	writeCallback (Addr address, MachineType mach, DataBlock &data, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime)

void	writeCompleteCallback (Addr address, uint64_t instSeqNum, MachineType mach)

void	readCallback (Addr address, DataBlock &data)

void	readCallback (Addr address, MachineType mach, DataBlock &data)

void	readCallback (Addr address, MachineType mach, DataBlock &data, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime)

void	readCallback (Addr address, MachineType mach, DataBlock &data, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime, bool isRegion)

virtual void	atomicCallback (Addr address, MachineType mach, const DataBlock &data)

RequestStatus	makeRequest (PacketPtr pkt) override

int	outstandingCount () const override

bool	isDeadlockEventScheduled () const override

void	descheduleDeadlockEvent () override

bool	empty () const

void	print (std::ostream &out) const

void	evictionCallback (Addr address)

void	completeIssue ()

void	insertKernel (int wavefront_id, PacketPtr pkt)

GMTokenPort &	getGMTokenPort ()

statistics::Histogram &	getOutstandReqHist ()

statistics::Histogram &	getLatencyHist ()

statistics::Histogram &	getTypeLatencyHist (uint32_t t)

statistics::Histogram &	getMissLatencyHist ()

statistics::Histogram &	getMissTypeLatencyHist (uint32_t t)

statistics::Histogram &	getMissMachLatencyHist (uint32_t t) const

statistics::Histogram &	getMissTypeMachLatencyHist (uint32_t r, uint32_t t) const

statistics::Histogram &	getIssueToInitialDelayHist (uint32_t t) const

statistics::Histogram &	getInitialToForwardDelayHist (const MachineType t) const

statistics::Histogram &	getForwardRequestToFirstResponseHist (const MachineType t) const

statistics::Histogram &	getFirstResponseToCompletionDelayHist (const MachineType t) const

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.

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

virtual RequestStatus	makeRequest (PacketPtr pkt)=0

virtual int	outstandingCount () const =0

virtual bool	isDeadlockEventScheduled () const =0

virtual void	descheduleDeadlockEvent ()=0

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.

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.

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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

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 ()

virtual void	serialize (CheckpointOut &cp) const =0
	Serialize an object.

virtual void	unserialize (CheckpointIn &cp)=0
	Unserialize an object.

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 (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 Member Functions
void	invTCP ()
	Invalidate TCP.

void	makeWriteCompletePkts (CoalescedRequest *crequest)

Private Attributes
PacketPtr	m_cache_inv_pkt

int	m_num_pending_invs

std::unordered_map< uint64_t, std::vector< PacketPtr > >	m_writeCompletePktMap

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

Protected Member Functions inherited from gem5::ruby::GPUCoalescer
bool	tryCacheAccess (Addr addr, RubyRequestType type, Addr pc, RubyAccessMode access_mode, int size, DataBlock *&data_ptr)

virtual void	issueRequest (CoalescedRequest *crequest)=0

virtual void	issueMemSyncRequest (PacketPtr pkt)

void	kernelCallback (int wavefront_id)

void	hitCallback (CoalescedRequest *crequest, MachineType mach, DataBlock &data, bool success, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime, bool isRegion)

void	recordMissLatency (CoalescedRequest *crequest, MachineType mach, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime, bool success, bool isRegion)

void	completeHitCallback (std::vector< PacketPtr > &mylist)

virtual RubyRequestType	getRequestType (PacketPtr pkt)

GPUDynInstPtr	getDynInst (PacketPtr pkt) const

bool	coalescePacket (PacketPtr pkt)

Protected Member Functions inherited from gem5::ruby::RubyPort
void	trySendRetries ()

void	ruby_hit_callback (PacketPtr pkt)

void	ruby_unaddressed_callback (PacketPtr pkt)

void	ruby_stale_translation_callback (Addr txnId)

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.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual DrainState	drain ()=0
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

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::ruby::GPUCoalescer
EventFunctionWrapper	issueEvent

int	m_max_outstanding_requests

Cycles	m_deadlock_threshold

CacheMemory *	m_dataCache_ptr

CacheMemory *	m_instCache_ptr

int	coalescingWindow

UncoalescedTable	uncoalescedTable

std::map< Addr, std::deque< CoalescedRequest * > >	coalescedTable

std::unordered_map< uint64_t, std::deque< CoalescedRequest * > >	coalescedReqs

std::unordered_map< uint64_t, PendingWriteInst >	pendingWriteInsts

int	m_outstanding_count

bool	m_deadlock_check_scheduled

std::unordered_map< int, PacketPtr >	kernelEndList

std::vector< int >	newKernelEnds

int	m_store_waiting_on_load_cycles

int	m_store_waiting_on_store_cycles

int	m_load_waiting_on_store_cycles

int	m_load_waiting_on_load_cycles

bool	m_runningGarnetStandalone

EventFunctionWrapper	deadlockCheckEvent

bool	assumingRfOCoherence

statistics::Histogram	m_outstandReqHist
	Histogram for number of outstanding requests per cycle.

statistics::Histogram	m_latencyHist
	Histogram for holding latency profile of all requests.

std::vector< statistics::Histogram * >	m_typeLatencyHist

statistics::Histogram	m_missLatencyHist
	Histogram for holding latency profile of all requests that miss in the controller connected to this sequencer.

std::vector< statistics::Histogram * >	m_missTypeLatencyHist

std::vector< statistics::Histogram * >	m_missMachLatencyHist
	Histograms for profiling the latencies for requests that required external messages.

std::vector< std::vector< statistics::Histogram * > >	m_missTypeMachLatencyHist

std::vector< statistics::Histogram * >	m_IssueToInitialDelayHist
	Histograms for recording the breakdown of miss latency.

std::vector< statistics::Histogram * >	m_InitialToForwardDelayHist

std::vector< statistics::Histogram * >	m_ForwardToFirstResponseDelayHist

std::vector< statistics::Histogram * >	m_FirstResponseToCompletionDelayHist

Protected Attributes inherited from gem5::ruby::RubyPort
RubySystem *	m_ruby_system

uint32_t	m_version

AbstractController *	m_controller

MessageBuffer *	m_mandatory_q_ptr

bool	m_usingRubyTester

System *	system

std::vector< MemResponsePort * >	response_ports

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

Definition at line 58 of file VIPERCoalescer.hh.

Member Typedef Documentation

◆ Params

typedef VIPERCoalescerParams gem5::ruby::VIPERCoalescer::Params

Definition at line 61 of file VIPERCoalescer.hh.

Constructor & Destructor Documentation

◆ VIPERCoalescer()

gem5::ruby::VIPERCoalescer::VIPERCoalescer ( const Params & p )

Definition at line 57 of file VIPERCoalescer.cc.

◆ ~VIPERCoalescer()

gem5::ruby::VIPERCoalescer::~VIPERCoalescer ( )

Definition at line 64 of file VIPERCoalescer.cc.

Member Function Documentation

◆ invTCP()

void gem5::ruby::VIPERCoalescer::invTCP ( )

private

Invalidate TCP.

Definition at line 280 of file VIPERCoalescer.cc.

References gem5::X86ISA::addr, gem5::Clocked::clockEdge(), gem5::Clocked::cyclesToTicks(), DPRINTF, gem5::ruby::MessageBuffer::enqueue(), gem5::ruby::CacheMemory::getAddressAtIdx(), gem5::ruby::CacheMemory::getNumBlocks(), gem5::ArmISA::i, gem5::ruby::RubyPort::m_controller, gem5::ruby::GPUCoalescer::m_dataCache_ptr, gem5::ruby::RubyPort::m_mandatory_q_ptr, m_num_pending_invs, and gem5::ruby::AbstractController::mandatoryQueueLatency().

Referenced by makeRequest().

◆ invTCPCallback()

void gem5::ruby::VIPERCoalescer::invTCPCallback ( Addr address )

Definition at line 263 of file VIPERCoalescer.cc.

References gem5::ruby::GPUCoalescer::completeHitCallback(), m_cache_inv_pkt, and m_num_pending_invs.

◆ issueRequest()

void gem5::ruby::VIPERCoalescer::issueRequest ( CoalescedRequest * crequest )

overridevirtual

Implements gem5::ruby::GPUCoalescer.

Definition at line 111 of file VIPERCoalescer.cc.

References gem5::ruby::DataBlock::clear(), gem5::Clocked::clockEdge(), gem5::Clocked::clockPeriod(), gem5::Packet::cmd, gem5::curTick(), gem5::Clocked::cyclesToTicks(), gem5::ruby::GPUCoalescer::deadlockCheckEvent, DPRINTFR, gem5::ruby::MessageBuffer::enqueue(), fatal_if, gem5::Packet::getAddr(), gem5::Packet::getAtomicOp(), gem5::ruby::RubySystem::getBlockSizeBytes(), gem5::ruby::CoalescedRequest::getFirstPkt(), gem5::ruby::CoalescedRequest::getPackets(), gem5::Packet::getPtr(), gem5::ruby::CoalescedRequest::getRubyType(), gem5::ruby::CoalescedRequest::getSeqNum(), gem5::Packet::getSize(), gem5::ArmISA::i, gem5::Packet::isAtomicOp(), gem5::Packet::isWrite(), gem5::ArmISA::j, gem5::ruby::RubyPort::m_controller, gem5::ruby::GPUCoalescer::m_deadlock_threshold, gem5::ruby::RubyPort::m_mandatory_q_ptr, gem5::ruby::RubyPort::m_version, gem5::ruby::makeLineAddress(), makeWriteCompletePkts(), gem5::ruby::AbstractController::mandatoryQueueLatency(), gem5::MipsISA::pc, gem5::ruby::printAddress(), gem5::Packet::req, gem5::EventManager::schedule(), gem5::Event::scheduled(), gem5::ruby::DataBlock::setData(), and gem5::MemCmd::WriteReq.

◆ makeRequest()

RequestStatus gem5::ruby::VIPERCoalescer::makeRequest ( PacketPtr pkt )

overridevirtual

Reimplemented from gem5::ruby::GPUCoalescer.

Definition at line 71 of file VIPERCoalescer.cc.

References gem5::Packet::cmd, invTCP(), gem5::Packet::isAtomicOp(), m_cache_inv_pkt, gem5::ruby::GPUCoalescer::makeRequest(), gem5::MemCmd::MemSyncReq, gem5::MemCmd::ReadReq, gem5::Packet::req, and gem5::MemCmd::WriteReq.

◆ makeWriteCompletePkts()

void gem5::ruby::VIPERCoalescer::makeWriteCompletePkts ( CoalescedRequest * crequest )

private

Definition at line 195 of file VIPERCoalescer.cc.

References DPRINTF, gem5::ruby::CoalescedRequest::getPackets(), gem5::ruby::CoalescedRequest::getSeqNum(), m_writeCompletePktMap, gem5::Packet::senderState, gem5::Packet::setAddr(), gem5::MemCmd::WriteCompleteResp, and gem5::MemCmd::WriteReq.

Referenced by issueRequest().

◆ writeCompleteCallback()

void gem5::ruby::VIPERCoalescer::writeCompleteCallback	(	Addr	address,
		uint64_t	instSeqNum
	)

Definition at line 224 of file VIPERCoalescer.cc.

References gem5::X86ISA::addr, DPRINTF, gem5::ruby::GPUCoalescer::empty(), gem5::Packet::getAddr(), m_writeCompletePktMap, gem5::ruby::makeLineAddress(), and gem5::ruby::RubyPort::trySendRetries().

Member Data Documentation

◆ m_cache_inv_pkt

PacketPtr gem5::ruby::VIPERCoalescer::m_cache_inv_pkt

private

Definition at line 77 of file VIPERCoalescer.hh.

Referenced by invTCPCallback(), and makeRequest().

◆ m_num_pending_invs

int gem5::ruby::VIPERCoalescer::m_num_pending_invs

private

Definition at line 80 of file VIPERCoalescer.hh.

Referenced by invTCP(), and invTCPCallback().

◆ m_writeCompletePktMap

std::unordered_map<uint64_t, std::vector<PacketPtr> > gem5::ruby::VIPERCoalescer::m_writeCompletePktMap

private

Definition at line 89 of file VIPERCoalescer.hh.

Referenced by makeWriteCompletePkts(), and writeCompleteCallback().

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

mem/ruby/system/VIPERCoalescer.hh
mem/ruby/system/VIPERCoalescer.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ VIPERCoalescer()

◆ ~VIPERCoalescer()

Member Function Documentation

◆ invTCP()

◆ invTCPCallback()

◆ issueRequest()

◆ makeRequest()

◆ makeWriteCompletePkts()

◆ writeCompleteCallback()

Member Data Documentation

◆ m_cache_inv_pkt

◆ m_num_pending_invs

◆ m_writeCompletePktMap