git.gag.com Git - debian/gnuradio/blob - gruel/src/include/gruel/pmt_pool.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007,2009 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21 #ifndef INCLUDED_PMT_POOL_H
  22 #define INCLUDED_PMT_POOL_H
  23
  24 #include <cstddef>
  25 #include <vector>
  26 #include <boost/thread.hpp>
  27
  28 namespace pmt {
  29
  30 /*!
  31  * \brief very simple thread-safe fixed-size allocation pool
  32  *
  33  * FIXME may want to go to global allocation with per-thread free list.
  34  * This would eliminate virtually all lock contention.
  35  */
  36 class pmt_pool {
  37
  38   struct item {
  39     struct item *d_next;
  40   };
  41
  42   typedef boost::unique_lock<boost::mutex>  scoped_lock;
  43   mutable boost::mutex          d_mutex;
  44   boost::condition_variable     d_cond;
  45
  46   size_t              d_itemsize;
  47   size_t              d_alignment;
  48   size_t              d_allocation_size;
  49   size_t              d_max_items;
  50   size_t              d_n_items;
  51   item               *d_freelist;
  52   std::vector<char *> d_allocations;
  53
  54 public:
  55   /*!
  56    * \param itemsize size in bytes of the items to be allocated.
  57    * \param alignment alignment in bytes of all objects to be allocated (must be power-of-2).
  58    * \param allocation_size number of bytes to allocate at a time from the underlying allocator.
  59    * \param max_items is the maximum number of items to allocate.  If this number is exceeded,
  60    *          the allocate blocks.  0 implies no limit.
  61    */
  62   pmt_pool(size_t itemsize, size_t alignment = 16,
  63            size_t allocation_size = 4096, size_t max_items = 0);
  64   ~pmt_pool();
  65
  66   void *malloc();
  67   void free(void *p);
  68 };
  69
  70 } /* namespace pmt */
  71
  72 #endif /* INCLUDED_PMT_POOL_H */