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

#include <buffers.hh>

Inheritance diagram for 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. More...

void	clearReservedSpace ()
	Clear all allocated space. More...

void	freeReservation ()
	Clear a single reserved slot. More...

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

bool	canReserve () const
	Can a slot be reserved? More...

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

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

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

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

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

ElemType &	front ()
	Head value. More...

const ElemType &	front () const

void	pop ()
	Pop the head item. More...

bool	empty () const
	Is the queue empty? More...

void	minorTrace () const

Public Member Functions inherited from Named
	Named (const std::string &name_)

const std::string &	name () const

Public Member Functions inherited from Minor::Reservable
virtual	~Reservable ()

Private Attributes
std::deque< ElemType >	queue

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

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

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

Additional Inherited Members
Protected Attributes inherited from Named
const std::string	_name

Detailed Description

template<typename ElemType, typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>
class 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 397 of file buffers.hh.

Constructor & Destructor Documentation

◆ Queue()

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

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

inline

Definition at line 413 of file buffers.hh.

Member Function Documentation

◆ canReserve()

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

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

inlinevirtual

Can a slot be reserved?

Implements Minor::Reservable.

Definition at line 463 of file buffers.hh.

◆ clearReservedSpace()

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

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

inline

Clear all allocated space.

Be careful how this is used

Definition at line 441 of file buffers.hh.

◆ empty()

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

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

inline

Is the queue empty?

Definition at line 502 of file buffers.hh.

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

◆ freeReservation()

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

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

inlinevirtual

Clear a single reserved slot.

Implements Minor::Reservable.

Definition at line 444 of file buffers.hh.

Referenced by Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::push().

◆ front() [1/2]

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

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

inline

Head value.

Like std::queue::front

Definition at line 494 of file buffers.hh.

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

◆ front() [2/2]

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

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

inline

Definition at line 496 of file buffers.hh.

◆ minorTrace()

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

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

inline

Definition at line 505 of file buffers.hh.

Referenced by Minor::Fetch1::minorTrace(), and Minor::LSQ::minorTrace().

◆ occupiedSpace()

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

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

inline

Number of slots already occupied in this buffer.

Definition at line 469 of file buffers.hh.

Referenced by Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::minorTrace(), and Minor::Fetch1::numInFlightFetches().

◆ pop()

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

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

inline

Pop the head item.

Like std::queue::pop

Definition at line 499 of file buffers.hh.

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

◆ push()

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

void 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 426 of file buffers.hh.

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

◆ remainingSpace()

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

unsigned int 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 477 of file buffers.hh.

◆ reserve()

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

void 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 Minor::Reservable.

Definition at line 454 of file buffers.hh.

Referenced by Minor::Fetch1::fetchLine().

◆ reservedSpace()

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

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

inline

Number of slots which are reserved.

Definition at line 472 of file buffers.hh.

Referenced by Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::minorTrace().

◆ totalSpace()

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

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

inline

Number of slots available in an empty buffer.

Definition at line 466 of file buffers.hh.

Referenced by Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::minorTrace().

◆ unreservedRemainingSpace()

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

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

inline

Like remainingSpace but does not count reserved spaces.

Definition at line 486 of file buffers.hh.

Referenced by Minor::LSQ::canRequest(), Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::canReserve(), Minor::LSQ::moveFromRequestsToTransfers(), Minor::LSQ::needsToTick(), Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::reserve(), and Minor::LSQ::tryToSendToTransfers().

Member Data Documentation

◆ capacity

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

unsigned int Minor::Queue< ElemType, ReportTraits, BubbleTraits >::capacity

private

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

Definition at line 407 of file buffers.hh.

◆ dataName

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

std::string Minor::Queue< ElemType, ReportTraits, BubbleTraits >::dataName

private

Name to use for the data in MinorTrace.

Definition at line 410 of file buffers.hh.

Referenced by Minor::Queue< Minor::ForwardInstData, ReportTraitsAdaptor< Minor::ForwardInstData >, BubbleTraitsAdaptor< Minor::ForwardInstData > >::minorTrace().

◆ numReservedSlots

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

unsigned int Minor::Queue< ElemType, ReportTraits, BubbleTraits >::numReservedSlots

private

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

Definition at line 404 of file buffers.hh.

◆ queue

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

std::deque<ElemType> Minor::Queue< ElemType, ReportTraits, BubbleTraits >::queue

private

Definition at line 400 of file buffers.hh.

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

cpu/minor/buffers.hh

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

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

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