libs/pbd/pbd/pool.h

   1 /*
   2     Copyright (C) 1998-99 Paul Barton-Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __qm_pool_h__
  21 #define __qm_pool_h__
  22
  23 #include <vector>
  24 #include <string>
  25
  26 #include <glibmm/threads.h>
  27
  28 #include "pbd/libpbd_visibility.h"
  29 #include "pbd/ringbuffer.h"
  30
  31 /** A pool of data items that can be allocated, read from and written to
  32  *  without system memory allocation or locking.
  33  */
  34 class LIBPBD_API Pool
  35 {
  36   public:
  37         Pool (std::string name, unsigned long item_size, unsigned long nitems);
  38         virtual ~Pool ();
  39
  40         virtual void *alloc ();
  41         virtual void release (void *);
  42
  43         std::string name() const { return _name; }
  44         guint available() const { return free_list.read_space(); }
  45         guint used() const { return free_list.bufsize() - available(); }
  46         guint total() const { return free_list.bufsize(); }
  47
  48   protected:
  49         RingBuffer<void*> free_list; ///< a list of pointers to free items within block
  50         std::string _name;
  51
  52   private:
  53         void *block; ///< data storage area
  54 };
  55
  56 class LIBPBD_API SingleAllocMultiReleasePool : public Pool
  57 {
  58   public:
  59         SingleAllocMultiReleasePool (std::string name, unsigned long item_size, unsigned long nitems);
  60         ~SingleAllocMultiReleasePool ();
  61
  62         virtual void *alloc ();
  63         virtual void release (void *);
  64
  65   private:
  66         Glib::Threads::Mutex m_lock;
  67 };
  68
  69
  70 class LIBPBD_API MultiAllocSingleReleasePool : public Pool
  71 {
  72   public:
  73         MultiAllocSingleReleasePool (std::string name, unsigned long item_size, unsigned long nitems);
  74         ~MultiAllocSingleReleasePool ();
  75
  76         virtual void *alloc ();
  77         virtual void release (void *);
  78
  79   private:
  80         Glib::Threads::Mutex m_lock;
  81 };
  82
  83 class LIBPBD_API PerThreadPool;
  84
  85 /** Management of a per-thread pool of data that is allocated by one thread and
  86  *  freed by one other thread. Not safe for use when there is more than 1
  87  *  reader and 1 writer.
  88  *
  89  *  This is basically a wrapper around a thread-local storage instance of a
  90  *  ringbuffer, made safe for use in the case where multiple threads allocate
  91  *  from the ringbuffer and a single thread "frees" the allocations.
  92  *
  93  *  Rather than using locks, each thread has its own ringbuffer (and associated
  94  *  data), and so it calls alloc(), passes a pointer to the result of the alloc
  95  *  to another thread, which later calls push() to "free" it.
  96  */
  97 class LIBPBD_API CrossThreadPool : public Pool
  98 {
  99   public:
 100         CrossThreadPool (std::string n, unsigned long isize, unsigned long nitems, PerThreadPool *);
 101
 102         void* alloc ();
 103         void push (void *);
 104
 105         PerThreadPool* parent () const {
 106                 return _parent;
 107         }
 108
 109         bool empty ();
 110         guint pending_size() const { return pending.read_space(); }
 111
 112         void flush_pending ();
 113         void flush_pending_with_ev (void*);
 114
 115   private:
 116         RingBuffer<void*> pending;
 117         PerThreadPool* _parent;
 118 };
 119
 120 /** A class to manage per-thread pools of memory.  One object of this class is instantiated,
 121  *  and then it is used to create per-thread pools for 1 or more threads as required.
 122  */
 123 class LIBPBD_API PerThreadPool
 124 {
 125   public:
 126         PerThreadPool ();
 127
 128         const Glib::Threads::Private<CrossThreadPool>& key() const { return _key; }
 129
 130         void  create_per_thread_pool (std::string name, unsigned long item_size, unsigned long nitems);
 131         CrossThreadPool* per_thread_pool ();
 132
 133         void set_trash (RingBuffer<CrossThreadPool*>* t);
 134         void add_to_trash (CrossThreadPool *);
 135
 136   private:
 137         Glib::Threads::Private<CrossThreadPool> _key;
 138         std::string _name;
 139
 140         /** mutex to protect either changes to the _trash variable, or writes to the RingBuffer */
 141         Glib::Threads::Mutex _trash_mutex;
 142         RingBuffer<CrossThreadPool*>* _trash;
 143 };
 144
 145 #endif // __qm_pool_h__