/usr/include/stxxl/bits/containers/queue.h is in libstxxl-dev 1.3.1-5ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | /***************************************************************************
* include/stxxl/bits/containers/queue.h
*
* Part of the STXXL. See http://stxxl.sourceforge.net
*
* Copyright (C) 2005 Roman Dementiev <dementiev@ira.uka.de>
* Copyright (C) 2009, 2010 Andreas Beckmann <beckmann@cs.uni-frankfurt.de>
*
* Distributed under the Boost Software License, Version 1.0.
* (See accompanying file LICENSE_1_0.txt or copy at
* http://www.boost.org/LICENSE_1_0.txt)
**************************************************************************/
#ifndef STXXL_QUEUE_HEADER
#define STXXL_QUEUE_HEADER
#include <vector>
#include <queue>
#include <deque>
#include <stxxl/bits/deprecated.h>
#include <stxxl/bits/mng/mng.h>
#include <stxxl/bits/mng/typed_block.h>
#include <stxxl/bits/common/simple_vector.h>
#include <stxxl/bits/common/tmeta.h>
#include <stxxl/bits/mng/read_write_pool.h>
#include <stxxl/bits/mng/write_pool.h>
#include <stxxl/bits/mng/prefetch_pool.h>
__STXXL_BEGIN_NAMESPACE
#ifndef STXXL_VERBOSE_QUEUE
#define STXXL_VERBOSE_QUEUE STXXL_VERBOSE2
#endif
//! \addtogroup stlcont
//! \{
//! \brief External FIFO queue container
//! \tparam ValTp type of the contained objects (POD with no references to internal memory)
//! \tparam BlkSz size of the external memory block in bytes, default is \c STXXL_DEFAULT_BLOCK_SIZE(ValTp)
//! \tparam AllocStr parallel disk allocation strategy, default is \c STXXL_DEFAULT_ALLOC_STRATEGY
//! \tparam SzTp size data type, default is \c stxxl::uint64
template <class ValTp,
unsigned BlkSz = STXXL_DEFAULT_BLOCK_SIZE(ValTp),
class AllocStr = STXXL_DEFAULT_ALLOC_STRATEGY,
class SzTp = stxxl::uint64>
class queue : private noncopyable
{
public:
typedef ValTp value_type;
typedef AllocStr alloc_strategy_type;
typedef SzTp size_type;
enum {
block_size = BlkSz
};
typedef typed_block<block_size, value_type> block_type;
typedef BID<block_size> bid_type;
private:
typedef read_write_pool<block_type> pool_type;
size_type size_;
bool delete_pool;
pool_type * pool;
block_type * front_block;
block_type * back_block;
value_type * front_element;
value_type * back_element;
alloc_strategy_type alloc_strategy;
unsigned_type alloc_count;
std::deque<bid_type> bids;
block_manager * bm;
unsigned_type blocks2prefetch;
public:
//! \brief Constructs empty queue with own write and prefetch block pool
//! \param w_pool_size number of blocks in the write pool, must be at least 2, recommended at least 3
//! \param p_pool_size number of blocks in the prefetch pool, recommended at least 1
//! \param blocks2prefetch_ defines the number of blocks to prefetch (\c front side),
//! default is number of block in the prefetch pool
explicit queue(unsigned_type w_pool_size = 3, unsigned_type p_pool_size = 1, int blocks2prefetch_ = -1) :
size_(0),
delete_pool(true),
alloc_count(0),
bm(block_manager::get_instance())
{
STXXL_VERBOSE_QUEUE("queue[" << this << "]::queue(sizes)");
pool = new pool_type(p_pool_size, w_pool_size);
init(blocks2prefetch_);
}
//! \brief Constructs empty queue
//! \param w_pool write pool
//! \param p_pool prefetch pool
//! \param blocks2prefetch_ defines the number of blocks to prefetch (\c front side),
//! default is number of blocks in the prefetch pool
//! \warning Number of blocks in the write pool must be at least 2, recommended at least 3
//! \warning Number of blocks in the prefetch pool recommended at least 1
_STXXL_DEPRECATED(
queue(write_pool<block_type> & w_pool, prefetch_pool<block_type> & p_pool, int blocks2prefetch_ = -1)) :
size_(0),
delete_pool(true),
alloc_count(0),
bm(block_manager::get_instance())
{
STXXL_VERBOSE_QUEUE("queue[" << this << "]::queue(pools)");
pool = new pool_type(w_pool, p_pool);
init(blocks2prefetch_);
}
//! \brief Constructs empty queue
//! \param pool_ block write/prefetch pool
//! \param blocks2prefetch_ defines the number of blocks to prefetch (\c front side),
//! default is number of blocks in the prefetch pool
//! \warning Number of blocks in the write pool must be at least 2, recommended at least 3
//! \warning Number of blocks in the prefetch pool recommended at least 1
queue(pool_type & pool_, int blocks2prefetch_ = -1) :
size_(0),
delete_pool(false),
pool(&pool_),
alloc_count(0),
bm(block_manager::get_instance())
{
STXXL_VERBOSE_QUEUE("queue[" << this << "]::queue(pool)");
init(blocks2prefetch_);
}
private:
void init(int blocks2prefetch_)
{
if (pool->size_write() < 2) {
STXXL_ERRMSG("queue: invalid configuration, not enough blocks (" << pool->size_write() <<
") in write pool, at least 2 are needed, resizing to 3");
pool->resize_write(3);
}
if (pool->size_write() < 3) {
STXXL_MSG("queue: inefficient configuration, no blocks for buffered writing available");
}
if (pool->size_prefetch() < 1) {
STXXL_MSG("queue: inefficient configuration, no blocks for prefetching available");
}
front_block = back_block = pool->steal();
back_element = back_block->begin() - 1;
front_element = back_block->begin();
set_prefetch_aggr(blocks2prefetch_);
}
public:
//! \brief Defines the number of blocks to prefetch (\c front side)
//! This method should be called whenever the prefetch pool is resized
//! \param blocks2prefetch_ defines the number of blocks to prefetch (\c front side),
//! a negative value means to use the number of blocks in the prefetch pool
void set_prefetch_aggr(int_type blocks2prefetch_)
{
if (blocks2prefetch_ < 0)
blocks2prefetch = pool->size_prefetch();
else
blocks2prefetch = blocks2prefetch_;
}
//! \brief Returns the number of blocks prefetched from the \c front side
unsigned_type get_prefetch_aggr() const
{
return blocks2prefetch;
}
//! \brief Adds an element in the queue
void push(const value_type & val)
{
if (back_element == back_block->begin() + (block_type::size - 1))
{
// back block is filled
if (front_block == back_block)
{ // can not write the back block because it
// is the same as the front block, must keep it memory
STXXL_VERBOSE1("queue::push Case 1");
}
else
{
STXXL_VERBOSE1("queue::push Case 2");
// write the back block
// need to allocate new block
bid_type newbid;
bm->new_block(alloc_strategy, newbid, alloc_count++);
STXXL_VERBOSE_QUEUE("queue[" << this << "]: push block " << back_block << " @ " << FMT_BID(newbid));
bids.push_back(newbid);
pool->write(back_block, newbid);
if (bids.size() <= blocks2prefetch) {
STXXL_VERBOSE1("queue::push Case Hints");
pool->hint(newbid);
}
}
back_block = pool->steal();
back_element = back_block->begin();
*back_element = val;
++size_;
return;
}
++back_element;
*back_element = val;
++size_;
}
//! \brief Removes element from the queue
void pop()
{
assert(!empty());
if (front_element == front_block->begin() + (block_type::size - 1))
{
// if there is only one block, it implies ...
if (back_block == front_block)
{
STXXL_VERBOSE1("queue::pop Case 3");
assert(size() == 1);
assert(back_element == front_element);
assert(bids.empty());
// reset everything
back_element = back_block->begin() - 1;
front_element = back_block->begin();
size_ = 0;
return;
}
--size_;
if (size_ <= block_type::size)
{
STXXL_VERBOSE1("queue::pop Case 4");
assert(bids.empty());
// the back_block is the next block
pool->add(front_block);
front_block = back_block;
front_element = back_block->begin();
return;
}
STXXL_VERBOSE1("queue::pop Case 5");
assert(!bids.empty());
request_ptr req = pool->read(front_block, bids.front());
STXXL_VERBOSE_QUEUE("queue[" << this << "]: pop block " << front_block << " @ " << FMT_BID(bids.front()));
// give prefetching hints
for (unsigned_type i = 0; i < blocks2prefetch && i < bids.size() - 1; ++i)
{
STXXL_VERBOSE1("queue::pop Case Hints");
pool->hint(bids[i + 1]);
}
front_element = front_block->begin();
req->wait();
bm->delete_block(bids.front());
bids.pop_front();
return;
}
++front_element;
--size_;
}
//! \brief Returns the size of the queue
size_type size() const
{
return size_;
}
//! \brief Returns \c true if queue is empty
bool empty() const
{
return (size_ == 0);
}
//! \brief Returns a mutable reference at the back of the queue
value_type & back()
{
assert(!empty());
return *back_element;
}
//! \brief Returns a const reference at the back of the queue
const value_type & back() const
{
assert(!empty());
return *back_element;
}
//! \brief Returns a mutable reference at the front of the queue
value_type & front()
{
assert(!empty());
return *front_element;
}
//! \brief Returns a const reference at the front of the queue
const value_type & front() const
{
assert(!empty());
return *front_element;
}
~queue()
{
pool->add(front_block);
if (front_block != back_block)
pool->add(back_block);
if (delete_pool)
{
delete pool;
}
if (!bids.empty())
bm->delete_blocks(bids.begin(), bids.end());
}
};
//! \}
__STXXL_END_NAMESPACE
#endif // !STXXL_QUEUE_HEADER
// vim: et:ts=4:sw=4
|