A thread safe, fast but simple doubled-ended queue. More...
#include <dqueue.h>
Public Member Functions | |
| DQueue (size_t hint=200000) | |
| virtual | ~DQueue () |
| bool | empty () const |
| const DQStats & | get_stats () const |
| void | lock_and_flush_prebuf () |
| std::pair< T, bool > | pop_front (bool wait) |
| Pop value off the front of queue. More... | |
| int | pop_front (int nmax, T *r, bool wait) |
| Pop multiple values off the front of queue ... returns number popped ... might be zero. More... | |
| void | push_back (const T &value, int ncopy=1) |
| Insert element at back of queue (default is just one copy) More... | |
| void | push_front (const T &value) |
| Insert value at front of queue. More... | |
| template<typename opT > | |
| void | scan (opT &op) |
| void | set_wait_policy (WaitPolicy p, int us=0) |
| size_t | size () const |
Private Member Functions | |
| size_t n | __attribute__ ((aligned(64))) |
| Number of elements in the buffer. More... | |
| void | flush_prebuf () |
| void | grow () |
| void | push_back_with_lock (const T &value) |
| void | push_front_with_lock (const T &value) |
| void | sanity_check () const |
 Private Member Functions inherited from madness::PthreadConditionVariable | |
| PthreadConditionVariable () | |
| virtual | ~PthreadConditionVariable () |
| void | broadcast () const |
| pthread_mutex_t & | get_pthread_mutex () |
| void | lock () const |
| void | signal () const |
| void | unlock () const |
| void | wait () const |
| You should have acquired the mutex before entering here. More... | |
Private Attributes | |
| int | _back |
| Index of element at back of buffer. More... | |
| int | _front |
| Index of element at front of buffer. More... | |
| T * | buf |
| Actual buffer. More... | |
| char | pad [64] |
| To put the lock and the data in separate cache lines. More... | |
| DQStats | stats |
| size_t | sz |
| Current capacity. More... | |
Detailed Description
template<typename T>
class madness::DQueue< T >
A thread safe, fast but simple doubled-ended queue.
Since the point is speed, the implementation is a circular buffer rather than a linked list so as to avoid the new/del overhead. It will grow as needed, but presently will not shrink. Had to modify STL API to make things thread safe.
It is now rather heavily specialized to its only use.
Constructor & Destructor Documentation
◆ DQueue()
|
inline |
◆ ~DQueue()
|
inlinevirtual |
References madness::DQueue< T >::buf.
Member Function Documentation
◆ __attribute__()
|
private |
Number of elements in the buffer.
◆ empty()
| bool madness::DQueue< T >::empty |
◆ flush_prebuf()
|
inlineprivate |
References madness::DQueue< T >::push_back_with_lock(), and madness::DQueue< T >::push_front_with_lock().
Referenced by madness::DQueue< T >::pop_front().
◆ get_stats()
|
inline |
References madness::DQueue< T >::stats.
◆ grow()
|
inlineprivate |
References madness::DQueue< T >::_back, madness::DQueue< T >::_front, madness::DQueue< T >::buf, lo, MADNESS_EXCEPTION, madness::DQStats::ngrow, madness::DQueue< T >::stats, madness::DQueue< T >::sz, and T().
Referenced by madness::DQueue< T >::push_back_with_lock(), and madness::DQueue< T >::push_front_with_lock().
◆ lock_and_flush_prebuf()
| void madness::DQueue< T >::lock_and_flush_prebuf |
◆ pop_front() [1/2]
|
inline |
Pop value off the front of queue.
References madness::DQueue< T >::pop_front(), T(), and madness::PthreadConditionVariable::wait().
◆ pop_front() [2/2]
|
inline |
Pop multiple values off the front of queue ... returns number popped ... might be zero.
r must refer to an array of dimension at least nmax ... you are presently given no more than max(size()/64,1) values ... arbitrary choice.
multi-threaded tasks might cause fewer tasks to be taken
References madness::DQueue< T >::_front, madness::DQueue< T >::buf, madness::f, madness::DQueue< T >::flush_prebuf(), max, madness::DQStats::npop_front, madness::DQueue< T >::stats, madness::DQueue< T >::sz, T(), and madness::PthreadConditionVariable::wait().
Referenced by madness::DQueue< T >::pop_front().
◆ push_back()
| void madness::DQueue< T >::push_back | ( | const T & | value, |
| int | ncopy = 1 |
||
| ) |
Insert element at back of queue (default is just one copy)
References madness::is_madness_thread().
◆ push_back_with_lock()
|
inlineprivate |
References madness::DQueue< T >::_back, b, madness::DQueue< T >::buf, madness::DQueue< T >::grow(), madness::DQStats::nmax, madness::DQStats::npush_back, madness::PthreadConditionVariable::signal(), madness::DQueue< T >::stats, and madness::DQueue< T >::sz.
Referenced by madness::DQueue< T >::flush_prebuf().
◆ push_front()
| void madness::DQueue< T >::push_front | ( | const T & | value | ) |
Insert value at front of queue.
References madness::is_madness_thread().
◆ push_front_with_lock()
|
inlineprivate |
References madness::DQueue< T >::_front, madness::DQueue< T >::buf, madness::f, madness::DQueue< T >::grow(), madness::DQStats::nmax, madness::DQStats::npush_front, madness::PthreadConditionVariable::signal(), madness::DQueue< T >::stats, and madness::DQueue< T >::sz.
Referenced by madness::DQueue< T >::flush_prebuf().
◆ sanity_check()
|
inlineprivate |
◆ scan()
◆ set_wait_policy()
|
inline |
References p(), and madness::ConditionVariable::set_wait_policy().
◆ size()
|
inline |
Referenced by madness::DQueue< T >::scan().
Member Data Documentation
◆ _back
|
private |
Index of element at back of buffer.
Referenced by madness::DQueue< T >::grow(), madness::DQueue< T >::push_back_with_lock(), and madness::DQueue< T >::sanity_check().
◆ _front
|
private |
Index of element at front of buffer.
Referenced by madness::DQueue< T >::grow(), madness::DQueue< T >::pop_front(), madness::DQueue< T >::push_front_with_lock(), madness::DQueue< T >::sanity_check(), and madness::DQueue< T >::scan().
◆ buf
|
private |
◆ pad
|
private |
To put the lock and the data in separate cache lines.
◆ stats
|
private |
◆ sz
|
private |
The documentation for this class was generated from the following file:
