Merged features/inband -r4812:5218 into trunk. This group of changes
[debian/gnuradio] / pmt / src / lib / pmt_pool.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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 2, 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 <omnithread.h>
26 #include <vector>
27
28 /*!
29  * \brief very simple thread-safe fixed-size allocation pool
30  *
31  * FIXME may want to go to global allocation with per-thread free list.
32  * This would eliminate virtually all lock contention.
33  */
34 class pmt_pool {
35
36   struct item {
37     struct item *d_next;
38   };
39   
40   omni_mutex          d_mutex;
41   
42   size_t              d_itemsize;
43   size_t              d_alignment;
44   size_t              d_allocation_size;
45   item               *d_freelist;
46   std::vector<char *> d_allocations;
47
48 public:
49   /*!
50    * \param itemsize size in bytes of the items to be allocated.
51    * \param alignment alignment in bytes of all objects to be allocated (must be power-of-2).
52    * \param allocation_size number of bytes to allocate at a time from the underlying allocator.
53    */
54   pmt_pool(size_t itemsize, size_t alignment = 16, size_t allocation_size = 4096);
55   ~pmt_pool();
56
57   void *malloc();
58   void free(void *p);
59 };
60
61 #endif /* INCLUDED_PMT_POOL_H */