summaryrefslogtreecommitdiff
path: root/ucoo
diff options
context:
space:
mode:
authorNicolas Schodet2015-10-09 11:41:28 +0200
committerNicolas Schodet2019-10-07 00:44:50 +0200
commit6beda3cc5fe33c656aae030033747825ca0211a3 (patch)
treed8e3785d121b3172a10acc655cc30bbb0a8cf8c4 /ucoo
parent381c4d1886ec72364e0e62ad0f08a2511a0c8304 (diff)
ucoo/utils: add Pool allocator
Diffstat (limited to 'ucoo')
-rw-r--r--ucoo/utils/pool.hh71
-rw-r--r--ucoo/utils/pool.tcc75
-rw-r--r--ucoo/utils/test/Makefile3
-rw-r--r--ucoo/utils/test/test_pool.cc87
4 files changed, 235 insertions, 1 deletions
diff --git a/ucoo/utils/pool.hh b/ucoo/utils/pool.hh
new file mode 100644
index 0000000..d1af167
--- /dev/null
+++ b/ucoo/utils/pool.hh
@@ -0,0 +1,71 @@
+#ifndef ucoo_utils_pool_hh
+#define ucoo_utils_pool_hh
+// ucoolib - Microcontroller object oriented library. {{{
+//
+// Copyright (C) 2015 Nicolas Schodet
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// }}}
+#include <array>
+#include <memory>
+
+namespace ucoo {
+
+/// Store an object, or a pointer to next free storage.
+template<typename T>
+union PoolStorage
+{
+ /// Object in pool.
+ T object;
+ /// If object is not allocated, this is a pointer to the next free object,
+ /// or nullptr if this is the last one.
+ PoolStorage *next_free;
+ /// Due to union, constructor must be explicit.
+ PoolStorage () { }
+ /// Due to union, destructor must be explicit.
+ ~PoolStorage () { }
+};
+
+/// Pool of statically allocated object.
+template<typename T, int size>
+class Pool
+{
+ public:
+ /// Constructor, initialise the pool.
+ Pool ();
+ /// Destructor, check that all objects are destroyed.
+ ~Pool ();
+ /// Create and construct a new object.
+ template<typename... Args>
+ T *construct (Args&&... args);
+ /// Destroy an object created from this pool and call its destructor.
+ void destroy (T *object);
+ private:
+ /// Pool storage.
+ std::array<PoolStorage<T>, size> pool_;
+ /// Pointer to the next free storage, or nullptr if pool is full.
+ PoolStorage<T> *next_free_;
+};
+
+} // namespace ucoo
+
+#include "pool.tcc"
+
+#endif // ucoo_utils_pool_hh
diff --git a/ucoo/utils/pool.tcc b/ucoo/utils/pool.tcc
new file mode 100644
index 0000000..83c0380
--- /dev/null
+++ b/ucoo/utils/pool.tcc
@@ -0,0 +1,75 @@
+#ifndef ucoo_utils_pool_tcc
+#define ucoo_utils_pool_tcc
+// ucoolib - Microcontroller object oriented library. {{{
+//
+// Copyright (C) 2015 Nicolas Schodet
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// }}}
+#include "ucoo/common.hh"
+
+namespace ucoo {
+
+template<typename T, int size>
+Pool<T, size>::Pool ()
+{
+ for (int i = 0; i < size - 1; i++)
+ pool_[i].next_free = &pool_[i + 1];
+ pool_[size - 1].next_free = nullptr;
+ next_free_ = &pool_[0];
+}
+
+template<typename T, int size>
+Pool<T, size>::~Pool ()
+{
+ int free = 0;
+ for (PoolStorage<T> *s = next_free_; s; s = s->next_free)
+ free++;
+ assert (free == size);
+}
+
+template<typename T, int size>
+template<typename... Args>
+T *
+Pool<T, size>::construct (Args&&... args)
+{
+ PoolStorage<T> *p = next_free_;
+ if (p)
+ {
+ next_free_ = p->next_free;
+ return new (&p->object) T (args...);
+ }
+ else
+ return nullptr;
+}
+
+template<typename T, int size>
+void
+Pool<T, size>::destroy (T *object)
+{
+ object->~T ();
+ PoolStorage<T> *s = reinterpret_cast<PoolStorage<T> *> (object);
+ s->next_free = next_free_;
+ next_free_ = s;
+}
+
+} // namespace ucoo
+
+#endif // ucoo_utils_pool_tcc
diff --git a/ucoo/utils/test/Makefile b/ucoo/utils/test/Makefile
index e1eb3b2..6f2094e 100644
--- a/ucoo/utils/test/Makefile
+++ b/ucoo/utils/test/Makefile
@@ -1,12 +1,13 @@
BASE = ../../..
TARGETS = host stm32f4
-PROGS = test_fifo test_crc test_function
+PROGS = test_fifo test_crc test_function test_pool
stm32f4_PROGS = test_delay
test_fifo_SOURCES = test_fifo.cc
test_delay_SOURCES = test_delay.cc
test_crc_SOURCES = test_crc.cc
test_function_SOURCES = test_function.cc
+test_pool_SOURCES = test_pool.cc
MODULES = ucoo/utils ucoo/base/test ucoo/hal/usb
diff --git a/ucoo/utils/test/test_pool.cc b/ucoo/utils/test/test_pool.cc
new file mode 100644
index 0000000..baa7276
--- /dev/null
+++ b/ucoo/utils/test/test_pool.cc
@@ -0,0 +1,87 @@
+// ucoolib - Microcontroller object oriented library. {{{
+//
+// Copyright (C) 2015 Nicolas Schodet
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// }}}
+#include "ucoo/utils/pool.hh"
+#include "ucoo/arch/arch.hh"
+#include "ucoo/base/test/test.hh"
+#include "ucoo/common.hh"
+
+struct A
+{
+ A () { n++; };
+ ~A () { n--; };
+ static int n;
+};
+
+int A::n = 0;
+
+int
+main (int argc, const char **argv)
+{
+ ucoo::arch_init (argc, argv);
+ ucoo::TestSuite tsuite ("pool");
+ do {
+ ucoo::Test test (tsuite, "int pool");
+ ucoo::Pool<int, 4> pool;
+ int *ar[5];
+ for (int i = 0; i < ucoo::lengthof (ar); i++)
+ ar[i] = pool.construct (i);
+ test_fail_break_unless (test, ar[0] && *ar[0] == 0);
+ test_fail_break_unless (test, ar[1] && *ar[1] == 1);
+ test_fail_break_unless (test, ar[2] && *ar[2] == 2);
+ test_fail_break_unless (test, ar[3] && *ar[3] == 3);
+ test_fail_break_unless (test, !ar[4]);
+ for (int i = 0; i < ucoo::lengthof (ar) - 1; i++)
+ pool.destroy (ar[i]);
+ for (int i = 0; i < ucoo::lengthof (ar); i++)
+ ar[i] = pool.construct (i);
+ test_fail_break_unless (test, ar[0] && *ar[0] == 0);
+ test_fail_break_unless (test, ar[1] && *ar[1] == 1);
+ test_fail_break_unless (test, ar[2] && *ar[2] == 2);
+ test_fail_break_unless (test, ar[3] && *ar[3] == 3);
+ test_fail_break_unless (test, !ar[4]);
+ for (int i = 0; i < ucoo::lengthof (ar) - 1; i++)
+ pool.destroy (ar[i]);
+ } while (0);
+ do {
+ ucoo::Test test (tsuite, "object pool");
+ ucoo::Pool<A, 4> pool;
+ A *ar[5];
+ for (int i = 0; i < ucoo::lengthof (ar); i++)
+ ar[i] = pool.construct ();
+ test_fail_break_unless (test, A::n == 4);
+ test_fail_break_unless (test, ar[0] && ar[1] && ar[2] && ar[3]);
+ test_fail_break_unless (test, !ar[4]);
+ for (int i = 0; i < ucoo::lengthof (ar) - 1; i++)
+ pool.destroy (ar[i]);
+ test_fail_break_unless (test, A::n == 0);
+ for (int i = 0; i < ucoo::lengthof (ar); i++)
+ ar[i] = pool.construct ();
+ test_fail_break_unless (test, A::n == 4);
+ test_fail_break_unless (test, ar[0] && ar[1] && ar[2] && ar[3]);
+ test_fail_break_unless (test, !ar[4]);
+ for (int i = 0; i < ucoo::lengthof (ar) - 1; i++)
+ pool.destroy (ar[i]);
+ } while (0);
+ return tsuite.report () ? 0 : 1;
+}