Wrapper for a queue type to act as a pipeline stage input queue. More...

#include <buffers.hh>

Inheritance diagram for gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >:

Public Member Functions
	Queue (const std::string &name, const std::string &data_name, unsigned int capacity_)

void	push (ElemType &data)
	Push an element into the buffer if it isn't a bubble.

void	clearReservedSpace ()
	Clear all allocated space.

void	freeReservation ()
	Clear a single reserved slot.

void	reserve ()
	Reserve space in the queue for future pushes.

bool	canReserve () const
	Can a slot be reserved?

unsigned int	totalSpace () const
	Number of slots available in an empty buffer.

unsigned int	occupiedSpace () const
	Number of slots already occupied in this buffer.

unsigned int	reservedSpace () const
	Number of slots which are reserved.

unsigned int	remainingSpace () const
	Number of slots yet to fill in this buffer.

unsigned int	unreservedRemainingSpace () const
	Like remainingSpace but does not count reserved spaces.

ElemType &	front ()
	Head value.

const ElemType &	front () const

void	pop ()
	Pop the head item.

bool	empty () const
	Is the queue empty?

void	minorTrace () const

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::minor::Reservable
virtual	~Reservable ()

Private Attributes
std::deque< ElemType >	queue

unsigned int	numReservedSlots
	Number of slots currently reserved for future (reservation respecting) pushes.

unsigned int	capacity
	Need this here as queues usually don't have a limited capacity.

std::string	dataName
	Name to use for the data in MinorTrace.

Detailed Description

template<typename ElemType, typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>
class gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >

Wrapper for a queue type to act as a pipeline stage input queue.

Handles capacity management, bubble value suppression and provides reporting.

In an ideal world, ElemType would be derived from ReportIF and BubbleIF, but here we use traits and allow the Adaptors ReportTraitsAdaptor and BubbleTraitsAdaptor to work on data which does directly implement those interfaces.

Definition at line 403 of file buffers.hh.

Constructor & Destructor Documentation

◆ Queue()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::Queue	(	const std::string &	name,
		const std::string &	data_name,
		unsigned int	capacity_ )

inline

Definition at line 419 of file buffers.hh.

Member Function Documentation

◆ canReserve()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

bool gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::canReserve ( ) const

inlinevirtual

Can a slot be reserved?

Implements gem5::minor::Reservable.

Definition at line 469 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::unreservedRemainingSpace().

◆ clearReservedSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::clearReservedSpace ( )

inline

Clear all allocated space.

Be careful how this is used

Definition at line 447 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots.

◆ empty()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

bool gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::empty ( ) const

inline

Is the queue empty?

Definition at line 508 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

Referenced by gem5::minor::Fetch1::evaluate(), gem5::minor::LSQ::findResponse(), gem5::minor::LSQ::isDrained(), gem5::minor::Fetch1::moveFromRequestsToTransfers(), gem5::minor::LSQ::moveFromRequestsToTransfers(), gem5::minor::LSQ::needsToTick(), gem5::minor::Fetch1::popAndDiscard(), gem5::minor::LSQ::popResponse(), gem5::minor::Fetch1::recvReqRetry(), gem5::minor::LSQ::step(), gem5::minor::Fetch1::stepQueues(), gem5::minor::Fetch1::tryToSendToTransfers(), and gem5::minor::LSQ::tryToSendToTransfers().

◆ freeReservation()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::freeReservation ( )

inlinevirtual

Clear a single reserved slot.

Implements gem5::minor::Reservable.

Definition at line 450 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::push().

◆ front() [1/2]

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

ElemType & gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::front ( )

inline

Head value.

Like std::queue::front

Definition at line 500 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

Referenced by gem5::minor::Fetch1::evaluate(), gem5::minor::LSQ::findResponse(), gem5::minor::Fetch1::moveFromRequestsToTransfers(), gem5::minor::LSQ::moveFromRequestsToTransfers(), gem5::minor::LSQ::needsToTick(), gem5::minor::Fetch1::popAndDiscard(), gem5::minor::LSQ::popResponse(), gem5::minor::Fetch1::recvReqRetry(), gem5::minor::LSQ::step(), gem5::minor::Fetch1::stepQueues(), gem5::minor::Fetch1::tryToSendToTransfers(), and gem5::minor::LSQ::tryToSendToTransfers().

◆ front() [2/2]

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

const ElemType & gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::front ( ) const

inline

Definition at line 502 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

◆ minorTrace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::minorTrace ( ) const

inline

Definition at line 511 of file buffers.hh.

References data, gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::dataName, gem5::minor::minorTrace(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::occupiedSpace(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue, gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reservedSpace(), and gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::totalSpace().

Referenced by gem5::minor::Fetch1::minorTrace(), and gem5::minor::LSQ::minorTrace().

◆ occupiedSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::occupiedSpace ( ) const

inline

Number of slots already occupied in this buffer.

Definition at line 475 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::minorTrace(), and gem5::minor::Fetch1::numInFlightFetches().

◆ pop()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::pop ( )

inline

Pop the head item.

Like std::queue::pop

Definition at line 505 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

Referenced by gem5::minor::Fetch1::moveFromRequestsToTransfers(), gem5::minor::LSQ::moveFromRequestsToTransfers(), gem5::minor::Fetch1::popAndDiscard(), and gem5::minor::LSQ::popResponse().

◆ push()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::push ( ElemType & data )

inline

Push an element into the buffer if it isn't a bubble.

Bubbles are just discarded. It is assummed that any push into a queue with reserved space intends to take that space

Definition at line 432 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity, data, gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::freeReservation(), gem5::Named::name(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue, and warn.

Referenced by gem5::minor::Fetch1::fetchLine(), gem5::minor::Fetch1::moveFromRequestsToTransfers(), gem5::minor::LSQ::moveFromRequestsToTransfers(), gem5::minor::LSQ::pushFailedRequest(), and gem5::minor::LSQ::pushRequest().

◆ remainingSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::remainingSpace ( ) const

inline

Number of slots yet to fill in this buffer.

This doesn't include reservation.

Definition at line 483 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity, and gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

◆ reserve()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

void gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reserve ( )

inlinevirtual

Reserve space in the queue for future pushes.

Enquiries about space in the queue using unreservedRemainingSpace will only tell about space which is not full and not reserved.

Implements gem5::minor::Reservable.

Definition at line 460 of file buffers.hh.

References gem5::Named::name(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots, gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::unreservedRemainingSpace(), and warn.

Referenced by gem5::minor::Fetch1::fetchLine().

◆ reservedSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reservedSpace ( ) const

inline

Number of slots which are reserved.

Definition at line 478 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::minorTrace().

◆ totalSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::totalSpace ( ) const

inline

Number of slots available in an empty buffer.

Definition at line 472 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::minorTrace().

◆ unreservedRemainingSpace()

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::unreservedRemainingSpace ( ) const

inline

Like remainingSpace but does not count reserved spaces.

Definition at line 492 of file buffers.hh.

References gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity, gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots, and gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue.

Referenced by gem5::minor::LSQ::canRequest(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::canReserve(), gem5::minor::LSQ::moveFromRequestsToTransfers(), gem5::minor::LSQ::needsToTick(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reserve(), and gem5::minor::LSQ::tryToSendToTransfers().

Member Data Documentation

◆ capacity

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity

private

Need this here as queues usually don't have a limited capacity.

Definition at line 413 of file buffers.hh.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::push(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::remainingSpace(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::totalSpace(), and gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::unreservedRemainingSpace().

◆ dataName

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

std::string gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::dataName

private

Name to use for the data in MinorTrace.

Definition at line 416 of file buffers.hh.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::minorTrace().

◆ numReservedSlots

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

unsigned int gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots

private

Number of slots currently reserved for future (reservation respecting) pushes.

Definition at line 410 of file buffers.hh.

Referenced by gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::clearReservedSpace(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::freeReservation(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reserve(), gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::reservedSpace(), and gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::unreservedRemainingSpace().

◆ queue

template<typename ElemType , typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>

std::deque<ElemType> gem5::minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue

private

Definition at line 406 of file buffers.hh.

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

cpu/minor/buffers.hh

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Queue()

Member Function Documentation

◆ canReserve()

◆ clearReservedSpace()

◆ empty()

◆ freeReservation()

◆ front() [1/2]

◆ front() [2/2]

◆ minorTrace()

◆ occupiedSpace()

◆ pop()

◆ push()

◆ remainingSpace()

◆ reserve()

◆ reservedSpace()

◆ totalSpace()

◆ unreservedRemainingSpace()

Member Data Documentation

◆ capacity

◆ dataName

◆ numReservedSlots

◆ queue