A high-level queue interface, to be used by both the MSHR queue and the write buffer. More...

#include <queue.hh>

Inheritance diagram for gem5::Queue< Entry >:

Public Member Functions
	Queue (const std::string &_label, int num_entries, int reserve, const std::string &name)
	Create a queue with a given number of entries.

bool	isEmpty () const

bool	isFull () const

int	numInService () const

Entry *	findMatch (Addr blk_addr, bool is_secure, bool ignore_uncacheable=true) const
	Find the first entry that matches the provided address.

bool	trySatisfyFunctional (PacketPtr pkt)

Entry *	findPending (const QueueEntry *entry) const
	Find any pending requests that overlap the given request of a different queue.

Entry *	getNext () const
	Returns the WriteQueueEntry at the head of the readyList.

Tick	nextReadyTime () const

virtual void	deallocate (Entry *entry)
	Removes the given entry from the queue.

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.

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::Named
	Named (std::string_view name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Member Functions
Entry::Iterator	addToReadyList (Entry *entry)

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 Attributes
const std::string	label
	Local label (for functional print requests)

const int	numEntries
	The total number of entries in this queue.

const int	numReserve
	The number of entries to hold as a temporary overflow space.

std::vector< Entry >	entries
	Actual storage.

Entry::List	allocatedList
	Holds pointers to all allocated entries.

Entry::List	readyList
	Holds pointers to entries that haven't been sent downstream.

Entry::List	freeList
	Holds non allocated entries.

int	_numInService
	The number of entries that are in service.

int	allocated
	The number of currently allocated entries.

Detailed Description

template<class Entry>
class gem5::Queue< Entry >

A high-level queue interface, to be used by both the MSHR queue and the write buffer.

Definition at line 70 of file queue.hh.

Constructor & Destructor Documentation

◆ Queue()

template<class Entry>

gem5::Queue< Entry >::Queue	(	const std::string &	_label,
		int	num_entries,
		int	reserve,
		const std::string &	name )

inline

Create a queue with a given number of entries.

Parameters

num_entries	The number of entries in this queue.
reserve	The extra overflow entries needed.

Definition at line 133 of file queue.hh.

References _numInService, allocated, entries, freeList, gem5::ArmISA::i, label, gem5::Named::name(), gem5::Named::Named(), numEntries, and numReserve.

Member Function Documentation

◆ addToReadyList()

template<class Entry>

Entry::Iterator gem5::Queue< Entry >::addToReadyList ( Entry * entry )

inlineprotected

Definition at line 104 of file queue.hh.

References gem5::ArmISA::i, panic, and readyList.

◆ deallocate()

template<class Entry>

virtual void gem5::Queue< Entry >::deallocate ( Entry * entry )

inlinevirtual

Removes the given entry from the queue.

This places the entry on the free list.

Parameters

entry

Reimplemented in gem5::MSHRQueue.

Definition at line 241 of file queue.hh.

References _numInService, allocated, allocatedList, DPRINTF, gem5::Draining, gem5::Drainable::drainState(), freeList, readyList, and gem5::Drainable::signalDrainDone().

Referenced by gem5::MSHRQueue::deallocate().

◆ drain()

template<class Entry>

DrainState gem5::Queue< Entry >::drain ( )

inlineoverridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note: An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().

Returns: DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements gem5::Drainable.

Definition at line 261 of file queue.hh.

References allocated, gem5::Drained, and gem5::Draining.

◆ findMatch()

template<class Entry>

Entry * gem5::Queue< Entry >::findMatch	(	Addr	blk_addr,
		bool	is_secure,
		bool	ignore_uncacheable = true ) const

inline

Find the first entry that matches the provided address.

Parameters

blk_addr	The block address to find.
is_secure	True if the target memory space is secure.
ignore_uncacheable	Should uncacheables be ignored or not

Returns: Pointer to the matching WriteQueueEntry, null if not found.

Definition at line 168 of file queue.hh.

References allocatedList.

◆ findPending()

template<class Entry>

Entry * gem5::Queue< Entry >::findPending ( const QueueEntry * entry ) const

inline

Find any pending requests that overlap the given request of a different queue.

Parameters

entry The entry to be compared against.

Returns: A pointer to the earliest matching entry.

Definition at line 207 of file queue.hh.

References readyList.

◆ getNext()

template<class Entry>

Entry * gem5::Queue< Entry >::getNext ( ) const

inline

Returns the WriteQueueEntry at the head of the readyList.

Returns: The next request to service.

Definition at line 221 of file queue.hh.

References gem5::curTick(), and readyList.

◆ isEmpty()

template<class Entry>

bool gem5::Queue< Entry >::isEmpty ( ) const

inline

Definition at line 145 of file queue.hh.

References allocated.

◆ isFull()

template<class Entry>

bool gem5::Queue< Entry >::isFull ( ) const

inline

Definition at line 150 of file queue.hh.

References allocated, numEntries, and numReserve.

◆ nextReadyTime()

template<class Entry>

Tick gem5::Queue< Entry >::nextReadyTime ( ) const

inline

Definition at line 229 of file queue.hh.

References gem5::MaxTick, and readyList.

◆ numInService()

template<class Entry>

int gem5::Queue< Entry >::numInService ( ) const

inline

Definition at line 155 of file queue.hh.

References _numInService.

◆ trySatisfyFunctional()

template<class Entry>

bool gem5::Queue< Entry >::trySatisfyFunctional ( PacketPtr pkt )

inline

Definition at line 186 of file queue.hh.

References allocatedList, label, gem5::Packet::popLabel(), and gem5::Packet::pushLabel().

Member Data Documentation

◆ _numInService

template<class Entry>

int gem5::Queue< Entry >::_numInService

protected

The number of entries that are in service.

Definition at line 120 of file queue.hh.

Referenced by deallocate(), numInService(), and Queue().

◆ allocated

template<class Entry>

int gem5::Queue< Entry >::allocated

protected

The number of currently allocated entries.

Definition at line 123 of file queue.hh.

Referenced by deallocate(), drain(), isEmpty(), isFull(), and Queue().

◆ allocatedList

template<class Entry>

Entry::List gem5::Queue< Entry >::allocatedList

protected

Holds pointers to all allocated entries.

Definition at line 98 of file queue.hh.

Referenced by deallocate(), findMatch(), and trySatisfyFunctional().

◆ entries

template<class Entry>

std::vector<Entry> gem5::Queue< Entry >::entries

protected

Actual storage.

Definition at line 96 of file queue.hh.

Referenced by Queue().

◆ freeList

template<class Entry>

Entry::List gem5::Queue< Entry >::freeList

protected

Holds non allocated entries.

Definition at line 102 of file queue.hh.

Referenced by deallocate(), and Queue().

◆ label

template<class Entry>

const std::string gem5::Queue< Entry >::label

protected

Local label (for functional print requests)

Definition at line 77 of file queue.hh.

Referenced by Queue(), and trySatisfyFunctional().

◆ numEntries

template<class Entry>

const int gem5::Queue< Entry >::numEntries

protected

The total number of entries in this queue.

This number is set as the number of entries requested plus any reserve. This allows for the same number of effective entries while still maintaining an overflow reserve.

Definition at line 85 of file queue.hh.

Referenced by isFull(), and Queue().

◆ numReserve

template<class Entry>

const int gem5::Queue< Entry >::numReserve

protected

The number of entries to hold as a temporary overflow space.

This is used to allow temporary overflow of the number of entries as we only check the full condition under certain conditions.

Definition at line 93 of file queue.hh.

Referenced by isFull(), and Queue().

◆ readyList

template<class Entry>

Entry::List gem5::Queue< Entry >::readyList

protected

Holds pointers to entries that haven't been sent downstream.

Definition at line 100 of file queue.hh.

Referenced by addToReadyList(), deallocate(), findPending(), getNext(), and nextReadyTime().

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

mem/cache/queue.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Queue()

Member Function Documentation

◆ addToReadyList()

◆ deallocate()

◆ drain()

◆ findMatch()

◆ findPending()

◆ getNext()

◆ isEmpty()

◆ isFull()

◆ nextReadyTime()

◆ numInService()

◆ trySatisfyFunctional()

Member Data Documentation

◆ _numInService

◆ allocated

◆ allocatedList

◆ entries

◆ freeList

◆ label

◆ numEntries

◆ numReserve

◆ readyList