ThresholdQueue< T > Class Template Reference

#include <ThresholdQueue.h>

Inheritance diagram for ThresholdQueue< T >:

Collaboration diagram for ThresholdQueue< T >:

Public Types
typedef unsigned long	ulong

Public Member Functions
	ThresholdQueue (ulong queueLen, ulong maxThresh, ulong numChans=1)
	ThresholdQueue (const ThresholdQueueAttr &attr)
T *	GetEnqueuePtr (ulong enqueueThresh, ulong chan=0) const
const T *	GetDequeuePtr (ulong dequeueThresh, ulong chan=0) const
void	Reset (void)
void *	GetRawEnqueuePtr (ulong enqueueThresh, ulong chan=0) const
void	Enqueue (ulong count)
const void *	GetRawDequeuePtr (ulong dequeueThresh, ulong chan=0) const
void	Dequeue (ulong count)
ulong	Count (void) const
ulong	Freespace (void) const
bool	Empty (void) const
bool	Full (void) const
ulong	QueueLength (void) const
ulong	MaxThreshold (void) const
ulong	NumChannels (void) const
ulong	ChannelStride (void) const
ulong	ElementsEnqueued (void) const
ulong	ElementsDequeued (void) const
void	Grow (ulong queueLen, ulong maxThresh)

Protected Member Functions
void	AllocateBuf (ulong queueLen, ulong maxThresh, ulong numChans, bool useMBS)

Protected Attributes
ulong	elementSize
ulong	head
ulong	tail
ulong	queueLength
ulong	maxThreshold
ulong	numChannels
ulong	channelStride
ulong	chanOffset
ulong	baseOffset
ulong	elementsEnqueued
ulong	elementsDequeued
void *	base
MirrorBufferSet *	mbs

Detailed Description

template<class T>
class ThresholdQueue< T >

Definition at line 86 of file ThresholdQueue.h.

Member Typedef Documentation

typedef unsigned long ThresholdQueueBase::ulong

inherited

Definition at line 90 of file ThresholdQueueBase.h.

Constructor & Destructor Documentation

template<class T >

ThresholdQueue< T >::ThresholdQueue ( ulong  queueLen, ulong  maxThresh, ulong  numChans = 1  )

inline

Definition at line 88 of file ThresholdQueue.h.

        : ThresholdQueueBase(sizeof(T), queueLen, maxThresh, numChans) { }

template<class T >

ThresholdQueue< T >::ThresholdQueue ( const ThresholdQueueAttr &  attr )

inline

Definition at line 90 of file ThresholdQueue.h.

        : ThresholdQueueBase(sizeof(T), attr) { }

Member Function Documentation

void ThresholdQueueBase::AllocateBuf ( ulong  queueLen, ulong  maxThresh, ulong  numChans, bool  useMBS  )

protectedinherited

Definition at line 71 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::base, ThresholdQueueBase::baseOffset, MirrorBufferSet::BufferSize(), ThresholdQueueBase::channelStride, ThresholdQueueBase::chanOffset, ThresholdQueueBase::elementSize, ThresholdQueueBase::maxThreshold, ThresholdQueueBase::mbs, MINIMUM_ALIGNMENT, MirrorBufferSet::MirrorSize(), ThresholdQueueBase::numChannels, ThresholdQueueBase::queueLength, ThresholdQueueBase::Reset(), and MirrorBufferSet::Supported().

Referenced by ThresholdQueueBase::Grow(), and ThresholdQueueBase::ThresholdQueueBase().

{
    if (maxThresh<1)        maxThresh = 1;
    if (maxThresh>queueLen) queueLen = maxThresh;
    numChannels = numChans;

    if ( useMBS && MirrorBufferSet::Supported() ) {
        ulong bufSz = queueLen * elementSize;
        ulong mirSz = maxThresh-1 + baseOffset + (numChannels-1)*chanOffset;
        mirSz *= elementSize;
        mbs = new MirrorBufferSet(bufSz, mirSz, numChannels);
        // MirrorBufferSet may have just resized everything...
        queueLength  = mbs->BufferSize() / elementSize;
        maxThreshold = mbs->MirrorSize() / elementSize + 1;
        channelStride = queueLength + maxThreshold-1 + chanOffset;
        maxThreshold -= baseOffset + (numChannels-1)*chanOffset;
        base = (char*)((void*)(*mbs)) + baseOffset;
        // Corner case of queueLength == maxThreshold
        if (maxThreshold > queueLength) { maxThreshold = queueLength; }
    } else {
        queueLength = queueLen;
        maxThreshold = maxThresh;
        channelStride = queueLength + maxThreshold - 1;
        ulong mod = channelStride%MINIMUM_ALIGNMENT;
        if (mod != 0) {
            channelStride += MINIMUM_ALIGNMENT - mod;
        }
        base = malloc(channelStride * numChannels * elementSize);
    }
    Reset();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ulong ThresholdQueueBase::ChannelStride ( void  ) const

inlineinherited

Definition at line 114 of file ThresholdQueueBase.h.

References ThresholdQueueBase::channelStride.

Referenced by CPN::ThresholdQueue::UnlockedDequeueChannelStride(), and CPN::ThresholdQueue::UnlockedEnqueueChannelStride().

{ return channelStride; }

Here is the caller graph for this function:

ThresholdQueueBase::ulong ThresholdQueueBase::Count ( void  ) const

inherited

Definition at line 217 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::head, ThresholdQueueBase::queueLength, and ThresholdQueueBase::tail.

Referenced by ThresholdQueueBase::Empty(), CPN::RemoteQueue::EnqueuePacket(), ThresholdQueueBase::Freespace(), ThresholdQueueBase::GetRawDequeuePtr(), CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), CPN::RemoteQueue::InternalCheckStatus(), CPN::ThresholdQueue::InternalEnqueue(), CPN::RemoteQueue::ReadBlockPacket(), CPN::RemoteQueue::SendDequeuePacket(), CPN::RemoteQueue::SendEnqueuePacket(), CPN::ThresholdQueue::UnlockedCount(), CPN::RemoteQueue::UnlockedCount(), and CPN::RemoteQueue::WriteBlockPacket().

{
    register ulong count = (2*queueLength - head + tail);
    while (count>=queueLength) count -= queueLength;
    if (count) return count;
    return (head==tail) ? 0 : queueLength;
}

Here is the caller graph for this function:

void ThresholdQueueBase::Dequeue ( ulong  count )

inherited

Definition at line 205 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::elementsDequeued, ThresholdQueueBase::head, and ThresholdQueueBase::queueLength.

Referenced by CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), CPN::ThresholdQueue::InternalDequeue(), and CPN::ThresholdQueue::InternalEnqueue().

{
    register ulong newHead = head+count;
    while (newHead>=2*queueLength) newHead -= 2*queueLength;
    head = newHead;
    elementsDequeued += count;
}

Here is the caller graph for this function:

ulong ThresholdQueueBase::ElementsDequeued ( void  ) const

inlineinherited

Definition at line 118 of file ThresholdQueueBase.h.

References ThresholdQueueBase::elementsDequeued.

Referenced by CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), and CPN::ThresholdQueue::UnlockedNumDequeued().

{ return elementsDequeued; }

Here is the caller graph for this function:

ulong ThresholdQueueBase::ElementsEnqueued ( void  ) const

inlineinherited

Definition at line 117 of file ThresholdQueueBase.h.

References ThresholdQueueBase::elementsEnqueued.

Referenced by CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), and CPN::ThresholdQueue::UnlockedNumEnqueued().

{ return elementsEnqueued; }

Here is the caller graph for this function:

bool ThresholdQueueBase::Empty ( void  ) const

inlineinherited

Definition at line 107 of file ThresholdQueueBase.h.

References ThresholdQueueBase::Count().

Referenced by CPN::RemoteQueue::InternalCheckStatus(), CPN::ThresholdQueue::UnlockedEmpty(), and CPN::RemoteQueue::UnlockedEmpty().

{ return !Count(); }

Here is the call graph for this function:

Here is the caller graph for this function:

void ThresholdQueueBase::Enqueue ( ulong  count )

inherited

Definition at line 162 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::base, ThresholdQueueBase::channelStride, ThresholdQueueBase::elementsEnqueued, ThresholdQueueBase::elementSize, ThresholdQueueBase::maxThreshold, ThresholdQueueBase::mbs, ThresholdQueueBase::numChannels, ThresholdQueueBase::queueLength, and ThresholdQueueBase::tail.

Referenced by ThresholdQueueBase::Grow(), and CPN::ThresholdQueue::InternalEnqueue().

{
    if (!mbs) { // the mbs maintains circularity
    
        // we must mirror by ourselves
        register ulong idx = tail;
        while (idx>=queueLength) idx -= queueLength;

        // elems to copy from queue area to mirror area
        register ulong countUp = 0;
        if (idx<maxThreshold-1) countUp = maxThreshold-1-idx;   // to mirror's lower edge
        if (idx+count<maxThreshold-1) countUp = count;

        // elems to copy from mirror area to queue area
        register ulong countDn = 0;
        if (idx+count>queueLength) countDn = idx+count-queueLength;
        
        if (countUp || countDn)
            for (ulong chan=0; chan<numChannels; chan++) {
                char* chanBase = (char*)base + (chan*channelStride) * elementSize;

                // move data in the queue (below the threshold) to the mirror area
                char* dst = chanBase + (idx + queueLength) * elementSize;
                char* src = chanBase + idx * elementSize;
                memcpy(dst,src,countUp*elementSize);
                
                // move data from the mirror area to the queue (below the threshold)
                src = chanBase + queueLength * elementSize;
                memcpy(chanBase,src,countDn*elementSize);
            }
    }
    
    // update the tail pointer
    register ulong newTail = tail+count;
    while (newTail>=2*queueLength) newTail -= 2*queueLength;
    tail = newTail;
    elementsEnqueued += count;
}

Here is the caller graph for this function:

ThresholdQueueBase::ulong ThresholdQueueBase::Freespace ( void  ) const

inherited

Definition at line 229 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::Count(), and ThresholdQueueBase::queueLength.

Referenced by CPN::RemoteQueue::EnqueuePacket(), ThresholdQueueBase::Full(), ThresholdQueueBase::GetRawEnqueuePtr(), CPN::RemoteQueue::InternalCheckStatus(), and CPN::ThresholdQueue::UnlockedFreespace().

{
    return queueLength - Count();
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool ThresholdQueueBase::Full ( void  ) const

inlineinherited

Definition at line 108 of file ThresholdQueueBase.h.

References ThresholdQueueBase::Freespace().

Referenced by CPN::ThresholdQueue::UnlockedFull().

{ return !Freespace(); }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

const T* ThresholdQueue< T >::GetDequeuePtr ( ulong  dequeueThresh, ulong  chan = 0  ) const

inline

Definition at line 96 of file ThresholdQueue.h.

References ThresholdQueueBase::GetRawDequeuePtr().

        { return (const T*) GetRawDequeuePtr(dequeueThresh,chan); }

Here is the call graph for this function:

template<class T >

T* ThresholdQueue< T >::GetEnqueuePtr ( ulong  enqueueThresh, ulong  chan = 0  ) const

inline

Definition at line 93 of file ThresholdQueue.h.

References ThresholdQueueBase::GetRawEnqueuePtr().

        { return (T*) GetRawEnqueuePtr(enqueueThresh,chan); }

Here is the call graph for this function:

const void * ThresholdQueueBase::GetRawDequeuePtr ( ulong  dequeueThresh, ulong  chan = 0  ) const

inherited

Definition at line 148 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::base, ThresholdQueueBase::channelStride, ThresholdQueueBase::Count(), ThresholdQueueBase::elementSize, ThresholdQueueBase::head, ThresholdQueueBase::MaxThreshold(), and ThresholdQueueBase::queueLength.

Referenced by ThresholdQueue< T >::GetDequeuePtr(), CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), CPN::ThresholdQueue::InternalEnqueue(), and CPN::ThresholdQueue::InternalGetRawDequeuePtr().

{
    if (thresh>Count() || thresh>MaxThreshold()) return 0;
//  if (chan>=numChannels) return 0;
//  assert(chan<numChannels);   
    register ulong idx = head;
    while (idx>=queueLength) idx -= queueLength;
    return (char*) base + (chan*channelStride + idx) * elementSize;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void * ThresholdQueueBase::GetRawEnqueuePtr ( ulong  enqueueThresh, ulong  chan = 0  ) const

inherited

Definition at line 134 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::base, ThresholdQueueBase::channelStride, ThresholdQueueBase::elementSize, ThresholdQueueBase::Freespace(), ThresholdQueueBase::MaxThreshold(), ThresholdQueueBase::queueLength, and ThresholdQueueBase::tail.

Referenced by ThresholdQueue< T >::GetEnqueuePtr(), ThresholdQueueBase::Grow(), CPN::ThresholdQueue::InternalEnqueue(), and CPN::ThresholdQueue::InternalGetRawEnqueuePtr().

{
    if (thresh>Freespace() || thresh>MaxThreshold()) return 0;
//  if (chan>=numChannels) return 0;
//  assert(chan<numChannels);
    register ulong idx = tail;
    while (idx>=queueLength) idx -= queueLength;
    return (char*) base + (chan*channelStride + idx) * elementSize;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ThresholdQueueBase::Grow ( ulong  queueLen, ulong  maxThresh  )

inherited

Definition at line 242 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Count(), ThresholdQueueBase::Dequeue(), ThresholdQueueBase::ElementsDequeued(), ThresholdQueueBase::elementsDequeued, ThresholdQueueBase::ElementsEnqueued(), ThresholdQueueBase::elementsEnqueued, ThresholdQueueBase::elementSize, ThresholdQueueBase::Enqueue(), ThresholdQueueBase::GetRawDequeuePtr(), ThresholdQueueBase::GetRawEnqueuePtr(), ThresholdQueueBase::MaxThreshold(), ThresholdQueueBase::mbs, ThresholdQueueBase::numChannels, and ThresholdQueueBase::QueueLength().

{
    fprintf(stderr, "ThresholdQueueBase::Grow(%lu,%lu)\n", queueLen, maxThresh);

    // handle the default parameter case
    if (!maxThresh) maxThresh = MaxThreshold();
    
    // ignore the do-nothing case
    if (queueLen <= QueueLength() && maxThresh <= MaxThreshold()) return;
    
    // we don't do any shrinking
    if (maxThresh <= MaxThreshold()) maxThresh = MaxThreshold();
    if (queueLen <= QueueLength()) queueLen = QueueLength();
    
    // keep our old info around
    ThresholdQueueBase  oldQueue(*this);    // just duplicate the pointers
    
    // allocate a new buffer (or MirrorBufferSet)
    AllocateBuf(queueLen,maxThresh,numChannels,mbs?1:0);
    
    // growth should not affect this member
    elementsDequeued = oldQueue.ElementsDequeued();

    // copy all in oldQueue to our new buffer with existing mechanisms
    ulong count;
    while ((count = oldQueue.Count()) != 0) {
        if (count>oldQueue.MaxThreshold())
            count = oldQueue.MaxThreshold();
        for (ulong chan=0; chan<numChannels; chan++) {
            const void* src = oldQueue.GetRawDequeuePtr(count,chan);
            void* dst = GetRawEnqueuePtr(count,chan);
            assert(src && dst);
            memcpy(dst,src,count*elementSize);
        }
        Enqueue(count);
        oldQueue.Dequeue(count);
    }
    
    // growth should not affect this member
    elementsEnqueued = oldQueue.ElementsEnqueued();
    
    // when oldQueue gets destructed, it will deallocate the old buffers
}

Here is the call graph for this function:

ulong ThresholdQueueBase::MaxThreshold ( void  ) const

inlineinherited

Definition at line 111 of file ThresholdQueueBase.h.

References ThresholdQueueBase::maxThreshold.

Referenced by CPN::RemoteQueue::EnqueuePacket(), ThresholdQueueBase::GetRawDequeuePtr(), ThresholdQueueBase::GetRawEnqueuePtr(), CPN::ThresholdQueue::TQImpl::Grow(), ThresholdQueueBase::Grow(), CPN::RemoteQueue::GrowPacket(), CPN::ThresholdQueue::InternalEnqueue(), CPN::RemoteQueue::SendEnqueuePacket(), CPN::RemoteQueue::SendGrowPacket(), CPN::RemoteQueue::UnlockedGrow(), and CPN::ThresholdQueue::UnlockedMaxThreshold().

{ return maxThreshold; }

Here is the caller graph for this function:

ulong ThresholdQueueBase::NumChannels ( void  ) const

inlineinherited

Definition at line 113 of file ThresholdQueueBase.h.

References ThresholdQueueBase::numChannels.

Referenced by CPN::RemoteQueue::EnqueuePacket(), CPN::ThresholdQueue::InternalEnqueue(), CPN::RemoteQueue::SendEnqueuePacket(), and CPN::ThresholdQueue::UnlockedNumChannels().

{ return numChannels; }

Here is the caller graph for this function:

ulong ThresholdQueueBase::QueueLength ( void  ) const

inlineinherited

Definition at line 110 of file ThresholdQueueBase.h.

References ThresholdQueueBase::queueLength.

Referenced by CPN::RemoteQueue::EnqueuePacket(), ThresholdQueueBase::Grow(), and CPN::ThresholdQueue::UnlockedQueueLength().

{ return queueLength; }

Here is the caller graph for this function:

void ThresholdQueueBase::Reset ( void  )

inherited

Definition at line 108 of file ThresholdQueueBase.cc.

References ThresholdQueueBase::elementsDequeued, ThresholdQueueBase::elementsEnqueued, ThresholdQueueBase::head, and ThresholdQueueBase::tail.

Referenced by ThresholdQueueBase::AllocateBuf(), CPN::ThresholdQueue::InternalReset(), CPN::RemoteQueue::ResetPacket(), and ThresholdQueueBase::ThresholdQueueBase().

{
    elementsEnqueued = 0;
    elementsDequeued = 0;

    head = 0;
    tail = 0;
}

Here is the caller graph for this function:

Member Data Documentation

void* ThresholdQueueBase::base

protectedinherited

Definition at line 129 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::GetRawDequeuePtr(), ThresholdQueueBase::GetRawEnqueuePtr(), and ThresholdQueueBase::~ThresholdQueueBase().

ulong ThresholdQueueBase::baseOffset

protectedinherited

Definition at line 127 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), and ThresholdQueueBase::ThresholdQueueBase().

ulong ThresholdQueueBase::channelStride

protectedinherited

Definition at line 126 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::ChannelStride(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::GetRawDequeuePtr(), and ThresholdQueueBase::GetRawEnqueuePtr().

ulong ThresholdQueueBase::chanOffset

protectedinherited

Definition at line 127 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), and ThresholdQueueBase::ThresholdQueueBase().

ulong ThresholdQueueBase::elementsDequeued

protectedinherited

Definition at line 128 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::Dequeue(), ThresholdQueueBase::ElementsDequeued(), ThresholdQueueBase::Grow(), and ThresholdQueueBase::Reset().

ulong ThresholdQueueBase::elementsEnqueued

protectedinherited

Definition at line 128 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::ElementsEnqueued(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::Grow(), and ThresholdQueueBase::Reset().

ulong ThresholdQueueBase::elementSize

protectedinherited

Definition at line 123 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::GetRawDequeuePtr(), ThresholdQueueBase::GetRawEnqueuePtr(), ThresholdQueueBase::Grow(), and ThresholdQueueBase::ThresholdQueueBase().

ulong ThresholdQueueBase::head

protectedinherited

Definition at line 124 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::Count(), ThresholdQueueBase::Dequeue(), ThresholdQueueBase::GetRawDequeuePtr(), CPN::ThresholdQueue::TQImpl::Grow(), and ThresholdQueueBase::Reset().

ulong ThresholdQueueBase::maxThreshold

protectedinherited

Definition at line 125 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::MaxThreshold(), and ThresholdQueueBase::ThresholdQueueBase().

MirrorBufferSet* ThresholdQueueBase::mbs

protectedinherited

Definition at line 130 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::Grow(), and ThresholdQueueBase::~ThresholdQueueBase().

ulong ThresholdQueueBase::numChannels

protectedinherited

Definition at line 126 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::Grow(), ThresholdQueueBase::NumChannels(), and ThresholdQueueBase::ThresholdQueueBase().

ulong ThresholdQueueBase::queueLength

protectedinherited

Definition at line 125 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::AllocateBuf(), ThresholdQueueBase::Count(), ThresholdQueueBase::Dequeue(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::Freespace(), ThresholdQueueBase::GetRawDequeuePtr(), ThresholdQueueBase::GetRawEnqueuePtr(), ThresholdQueueBase::QueueLength(), and ThresholdQueueBase::ThresholdQueueBase().

ulong ThresholdQueueBase::tail

protectedinherited

Definition at line 124 of file ThresholdQueueBase.h.

Referenced by ThresholdQueueBase::Count(), ThresholdQueueBase::Enqueue(), ThresholdQueueBase::GetRawEnqueuePtr(), CPN::ThresholdQueue::TQImpl::Grow(), and ThresholdQueueBase::Reset().

---

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

• lib/ThresholdQueue.h