From c1299484def0a5282dcdbe53da79454aafd949ba Mon Sep 17 00:00:00 2001 From: Daan Leijen Date: Sun, 27 Nov 2022 13:00:15 -0800 Subject: [PATCH] refactor C++ STL allocator definitions (pr #651) --- include/mimalloc.h | 60 ++++++++++++++++++++---------------------- test/main-override.cpp | 4 +-- 2 files changed, 30 insertions(+), 34 deletions(-) diff --git a/include/mimalloc.h b/include/mimalloc.h index 8fd2eedd..d70d28ed 100644 --- a/include/mimalloc.h +++ b/include/mimalloc.h @@ -441,6 +441,8 @@ template struct _mi_stl_allocator_common { template struct mi_stl_allocator : public _mi_stl_allocator_common { using typename _mi_stl_allocator_common::size_type; + using typename _mi_stl_allocator_common::value_type; + using typename _mi_stl_allocator_common::pointer; template struct rebind { typedef mi_stl_allocator other; }; mi_stl_allocator() mi_attr_noexcept = default; @@ -464,19 +466,17 @@ template struct mi_stl_allocator : public _mi_stl_allocator_common { template bool operator==(const mi_stl_allocator& , const mi_stl_allocator& ) mi_attr_noexcept { return true; } template bool operator!=(const mi_stl_allocator& , const mi_stl_allocator& ) mi_attr_noexcept { return false; } + #if (__cplusplus >= 201103L) || (_MSC_VER > 1900) // C++11 #include // std::shared_ptr +// Common base class for STL allocators in a specific heap template struct _mi_heap_stl_allocator_common : public _mi_stl_allocator_common { using typename _mi_stl_allocator_common::size_type; + using typename _mi_stl_allocator_common::value_type; + using typename _mi_stl_allocator_common::pointer; - _mi_heap_stl_allocator_common() { - mi_heap_t* hp = mi_heap_new(); - this->heap.reset(hp, heap_delete); - } _mi_heap_stl_allocator_common(mi_heap_t* hp) : heap(hp) { } /* will not delete or destroy the passed in heap */ - _mi_heap_stl_allocator_common(const _mi_heap_stl_allocator_common& x) mi_attr_noexcept : heap(x.heap) { } - template _mi_heap_stl_allocator_common(const _mi_heap_stl_allocator_common& x) mi_attr_noexcept : heap(x.heap) { } #if (__cplusplus >= 201703L) // C++17 mi_decl_nodiscard T* allocate(size_type count) { return static_cast(mi_heap_alloc_new_n(this->heap.get(), count, sizeof(T))); } @@ -490,58 +490,54 @@ template struct _mi_heap_stl_allocator_common : public _mi_stl_allocato #endif void collect(bool force) { mi_heap_collect(this->heap.get(), force); } + template bool is_equal(const _mi_heap_stl_allocator_common& x) { return (this->heap == x.heap); } protected: std::shared_ptr heap; + template friend struct _mi_heap_stl_allocator_common; + + _mi_heap_stl_allocator_common(bool destroy) { + mi_heap_t* hp = mi_heap_new(); + this->heap.reset(hp, (destroy ? &heap_destroy : &heap_delete)); /* calls heap_delete/destroy when the refcount drops to zero */ + } + _mi_heap_stl_allocator_common(const _mi_heap_stl_allocator_common& x) mi_attr_noexcept : heap(x.heap) { } + template _mi_heap_stl_allocator_common(const _mi_heap_stl_allocator_common& x) mi_attr_noexcept : heap(x.heap) { } +private: static void heap_delete(mi_heap_t* hp) { if (hp != NULL) { mi_heap_delete(hp); } } + static void heap_destroy(mi_heap_t* hp) { if (hp != NULL) { mi_heap_destroy(hp); } } }; // STL allocator allocation in a specific heap template struct mi_heap_stl_allocator : public _mi_heap_stl_allocator_common { using typename _mi_heap_stl_allocator_common::size_type; + mi_heap_stl_allocator() : _mi_heap_stl_allocator_common(false) { } /* delete on destruction */ + mi_heap_stl_allocator(mi_heap_t* hp) : _mi_heap_stl_allocator_common(hp) { } /* no delete or destroy on the passed in heap */ + template mi_heap_stl_allocator(const mi_heap_stl_allocator& x) mi_attr_noexcept : _mi_heap_stl_allocator_common(x) { } - template struct rebind { typedef mi_heap_stl_allocator other; }; - - using _mi_heap_stl_allocator_common::_mi_heap_stl_allocator_common; mi_heap_stl_allocator select_on_container_copy_construction() const { return *this; } void deallocate(T* p, size_type) { mi_free(p); } - -protected: - template - friend struct mi_heap_stl_allocator; - template - friend bool operator==(const mi_heap_stl_allocator& first, const mi_heap_stl_allocator& second) mi_attr_noexcept; - template - friend bool operator!=(const mi_heap_stl_allocator& first, const mi_heap_stl_allocator& second) mi_attr_noexcept; + template struct rebind { typedef mi_heap_stl_allocator other; }; }; -template bool operator==(const mi_heap_stl_allocator& x, const mi_heap_stl_allocator& y) mi_attr_noexcept { return (x.heap == y.heap); } -template bool operator!=(const mi_heap_stl_allocator& x, const mi_heap_stl_allocator& y) mi_attr_noexcept { return (x.heap != y.heap); } +template bool operator==(const mi_heap_stl_allocator& x, const mi_heap_stl_allocator& y) mi_attr_noexcept { return (x.is_equal(y)); } +template bool operator!=(const mi_heap_stl_allocator& x, const mi_heap_stl_allocator& y) mi_attr_noexcept { return (!x.is_equal(y)); } // STL allocator allocation in a specific heap, where `free` does nothing and // the heap is destroyed in one go on destruction -- use with care! template struct mi_heap_destroy_stl_allocator : public _mi_heap_stl_allocator_common { using typename _mi_heap_stl_allocator_common::size_type; + mi_heap_destroy_stl_allocator() : _mi_heap_stl_allocator_common(true) { } /* destroy on destruction */ + template mi_heap_destroy_stl_allocator(const mi_heap_destroy_stl_allocator& x) mi_attr_noexcept : _mi_heap_stl_allocator_common(x) { } - template struct rebind { typedef mi_heap_destroy_stl_allocator other; }; - - using _mi_heap_stl_allocator_common::_mi_heap_stl_allocator_common; mi_heap_destroy_stl_allocator select_on_container_copy_construction() const { return *this; } void deallocate(T* p, size_type) { /* do nothing as we destroy the heap on destruct. */ } - -protected: - template - friend struct mi_heap_destroy_stl_allocator; - template - friend bool operator==(const mi_heap_destroy_stl_allocator& first, const mi_heap_destroy_stl_allocator& second) mi_attr_noexcept; - template - friend bool operator!=(const mi_heap_destroy_stl_allocator& first, const mi_heap_destroy_stl_allocator& second) mi_attr_noexcept; + template struct rebind { typedef mi_heap_destroy_stl_allocator other; }; }; -template bool operator==(const mi_heap_destroy_stl_allocator& x, const mi_heap_destroy_stl_allocator& y) mi_attr_noexcept { return (x.heap == y.heap); } -template bool operator!=(const mi_heap_destroy_stl_allocator& x, const mi_heap_destroy_stl_allocator& y) mi_attr_noexcept { return (x.heap != y.heap); } +template bool operator==(const mi_heap_destroy_stl_allocator& x, const mi_heap_destroy_stl_allocator& y) mi_attr_noexcept { return (x.is_equal(y)); } +template bool operator!=(const mi_heap_destroy_stl_allocator& x, const mi_heap_destroy_stl_allocator& y) mi_attr_noexcept { return (!x.is_equal(y)); } #endif // C++11 diff --git a/test/main-override.cpp b/test/main-override.cpp index 81f57298..63bf20d8 100644 --- a/test/main-override.cpp +++ b/test/main-override.cpp @@ -181,7 +181,7 @@ static void strdup_test() { // Issue #202 static void heap_no_delete_worker() { mi_heap_t* heap = mi_heap_new(); - void* q = mi_heap_malloc(heap, 1024); + void* q = mi_heap_malloc(heap, 1024); (void)(q); // mi_heap_delete(heap); // uncomment to prevent assertion } @@ -245,7 +245,7 @@ static void heap_thread_free_huge_worker() { static void heap_thread_free_huge() { for (int i = 0; i < 10; i++) { shared_p = mi_malloc(1024 * 1024 * 1024); - auto t1 = std::thread(heap_thread_free_large_worker); + auto t1 = std::thread(heap_thread_free_huge_worker); t1.join(); } }