Merge pull request #1 from robertosfield/allocator

Allocator

Author: robertosfield

include/vsg/core/Allocator.h

@@ -0,0 +1,62 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2018 Robert Osfield
+
+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.
+
+</editor-fold> */
+
+#include <vsg/core/Inherit.h>
+#include <vsg/core/ref_ptr.h>
+#include <vsg/utils/stream.h>
+
+namespace vsg
+{
+
+    class Allocator : public Inherit<Object, Allocator>
+    {
+    public:
+        virtual void* allocate(std::size_t n, const void* hint );
+
+        virtual void* allocate(std::size_t size);
+
+        virtual void deallocate(const void* ptr, std::size_t size=0);
+
+        Auxiliary* getOrCreateSharedAuxiliary();
+
+        void detachSharedAuxiliary(Auxiliary* auxiliary);
+
+        template<typename T, typename... Args>
+        ref_ptr<T> create(Args&&... args)
+        {
+            // need to think about alignment...
+            std::size_t size = sizeof(T);
+            void* ptr = allocate(size);
+            T* object = new (ptr) T(std::forward<Args>(args)...);
+            object->setAuxiliary(getOrCreateSharedAuxiliary());
+
+            std::size_t new_size = object->getSizeOf();
+            if (new_size != size)
+            {
+                throw make_string("Warning: Allocator::create(",typeid(T).name(),") mismatch sizeof() = ",size,", ",new_size);
+            }
+            return object;
+        }
+
+    protected:
+        virtual ~Allocator();
+
+        Auxiliary*  _sharedAuxiliary = nullptr;
+        std::size_t _bytesAllocated = 0;
+        std::size_t _countAllocated = 0;
+        std::size_t _bytesDeallocated = 0;
+        std::size_t _countDeallocated = 0;
+    };
+
+}

include/vsg/core/Array.h

@@ -35,6 +35,8 @@ namespace vsg
         Array(std::initializer_list<value_type> l) : _size(l.size()), _data(new value_type[l.size()]) { value_type* ptr = _data; for (value_type const & v : l) { (*ptr++) = v; } }
         Array(const Array& rhs) : _data(rhs.data) {}
 
+        std::size_t getSizeOf() const noexcept override { return sizeof(Data); }
+
         // implementation provided by Visitor.h
         void accept(Visitor& visitor) override ;
 

include/vsg/core/Auxiliary.h

@@ -12,11 +12,10 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 </editor-fold> */
 
-#include <vsg/core/Object.h>
+#include <vsg/core/Allocator.h>
 #include <vsg/core/ref_ptr.h>
 
 #include <map>
-#include <algorithm>
 
 namespace vsg
 {
@@ -25,11 +24,11 @@ namespace vsg
     class VSG_EXPORT Auxiliary
     {
     public:
-        Auxiliary();
-
         Object* getConnectedObject() { return _connectedObject; }
         const Object* getConnectedObject() const { return _connectedObject; }
 
+        virtual std::size_t getSizeOf() const { return sizeof(Auxiliary); }
+
         void ref() const;
         void unref() const;
         void unref_nodelete() const;
@@ -43,23 +42,29 @@ namespace vsg
         ObjectMap& getObjectMap() { return _objectMap; }
         const ObjectMap& getObjectMap() const { return _objectMap; }
 
+        void setAllocator(Allocator* allocator) { _allocator = allocator; }
+        Allocator* getAllocator() { return _allocator; }
+
     protected:
 
-        virtual ~Auxiliary();
+        Auxiliary(Allocator* allocator);
+        Auxiliary(Object* object, Allocator* allocator=nullptr);
 
-        void setConnectedObject(Object* object);
+        virtual ~Auxiliary();
 
         /// reset the ConnectedObject pointer to 0 unless the ConnectedObject referenceCount goes back above 0,
         /// return true if ConnectedObject should still be deleted, or false if the object should be kept.
         bool signalConnectedObjectToBeDeleted();
 
-        friend class Object;
-
-        mutable std::atomic_uint _referenceCount;
+        void resetConnectedObject();
 
-        std::atomic<Object*> _connectedObject;
+        friend class Object;
+        friend class Allocator;
 
-        ObjectMap _objectMap;
+        mutable std::atomic_uint    _referenceCount;
+        std::atomic<Object*>        _connectedObject;
+        ref_ptr<Allocator>          _allocator;
+        ObjectMap                   _objectMap;
 
     };
 

include/vsg/core/Data.h

@@ -22,6 +22,8 @@ namespace vsg
 
         Data() {};
 
+        std::size_t getSizeOf() const noexcept override { return sizeof(Data); }
+
         virtual std::size_t valueSize() const = 0;
         virtual std::size_t valueCount() const = 0;
 

include/vsg/core/Inherit.h

@@ -0,0 +1,35 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2018 Robert Osfield
+
+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.
+
+</editor-fold> */
+
+#include <vsg/core/Visitor.h>
+#include <vsg/traversals/DispatchTraversal.h>
+
+namespace vsg
+{
+
+    // Use the Curiously Reacurring Template Pattern
+    // to provide the classes versions of accept(..) and getSizeOf()
+    template<class ParentClass, class Subclass>
+    class Inherit : public ParentClass
+    {
+    public:
+        template<typename... Args>
+        Inherit(Args&&... args) : ParentClass(std::forward<Args>(args)...) {}
+
+        void accept(Visitor& visitor) override { visitor.apply(static_cast<Subclass&>(*this)); }
+        void accept(DispatchTraversal& visitor) const override { visitor.apply(static_cast<const Subclass&>(*this)); }
+        std::size_t getSizeOf() const noexcept override { return sizeof(Subclass); }
+    };
+
+}

include/vsg/core/Object.h

@@ -26,6 +26,7 @@ namespace vsg
     class Auxiliary;
     class Visitor;
     class DispatchTraversal;
+    class Allocator;
 
     class VSG_EXPORT Object
     {
@@ -35,6 +36,8 @@ namespace vsg
         Object(const Object&) = delete;
         Object& operator = (const Object&) = delete;
 
+        virtual std::size_t getSizeOf() const noexcept { return sizeof(Object); }
+
         virtual void accept(Visitor& visitor);
         virtual void traverse(Visitor&) {}
 
@@ -78,16 +81,23 @@ namespace vsg
         Object* getObject(const Key& key);
         const Object* getObject(const Key& key) const;
 
-        Auxiliary* getOrCreateAuxiliary();
+        Auxiliary* getOrCreateUniqueAuxiliary();
         Auxiliary* getAuxiliary() { return _auxiliary; }
         const Auxiliary* getAuxiliary() const { return _auxiliary; }
 
+        Allocator* getAllocator() const;
+
     protected:
         virtual ~Object();
 
     private:
         virtual void _delete() const;
 
+        void setAuxiliary(Auxiliary* auxiliary);
+
+        friend class Allocator;
+        friend class Auxiliary;
+
         mutable std::atomic_uint _referenceCount;
 
         Auxiliary* _auxiliary;

include/vsg/core/Value.h

@@ -31,6 +31,8 @@ namespace vsg
         Value(const value_type& in_value) : _value(in_value) {}
         Value(const Value& rhs) : _value(rhs._value) {}
 
+        std::size_t getSizeOf() const noexcept override { return sizeof(Value); }
+
         // implementation provided by Visitor.h
         void accept(Visitor& visitor) override;
 

include/vsg/core/observer_ptr.h

@@ -31,7 +31,7 @@ namespace vsg
 
         template<class R>
         observer_ptr(R* ptr):
-            _auxiliary(ptr ? ptr->getOrCreateAuxiliary() : nullptr)
+            _auxiliary(ptr ? ptr->getOrCreateUniqueAuxiliary() : nullptr)
         {
         }
 
@@ -43,7 +43,7 @@ namespace vsg
 
         template<class R>
         observer_ptr(const ref_ptr<R>& ptr):
-            _auxiliary(ptr.valid() ? ptr->getOrCreateAuxiliary() : nullptr)
+            _auxiliary(ptr.valid() ? ptr->getOrCreateUniqueAuxiliary() : nullptr)
         {
         }
 
@@ -54,7 +54,7 @@ namespace vsg
         template<class R>
         observer_ptr& operator = (R* ptr)
         {
-            _auxiliary = ptr ? ptr->getOrCreateAuxiliary() : nullptr;
+            _auxiliary = ptr ? ptr->getOrCreateUniqueAuxiliary() : nullptr;
             return *this;
         }
 
@@ -74,7 +74,7 @@ namespace vsg
         template<class R>
         observer_ptr& operator = (const ref_ptr<R>& rhs)
         {
-            _auxiliary = rhs.valid() ? rhs->getOrCreateAuxiliary() : nullptr;
+            _auxiliary = rhs.valid() ? rhs->getOrCreateUniqueAuxiliary() : nullptr;
             return *this;
         }
 

include/vsg/nodes/FixedGroup.h

@@ -21,17 +21,14 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 namespace vsg
 {
     template<int NUM_CHILDREN>
-    class FixedGroup : public vsg::Node
+    class FixedGroup : public Inherit<Node, FixedGroup<NUM_CHILDREN>>
     {
     public:
         FixedGroup() {}
 
         template<class N, class V> static void t_traverse(N& node, V& visitor) { for (auto& child : node._children) child->accept(visitor); }
 
-        void accept(Visitor& visitor) override { visitor.apply(*this); }
         void traverse(Visitor& visitor) override { t_traverse(*this, visitor); }
-
-        void accept(DispatchTraversal& visitor) const override { visitor.apply(*this); }
         void traverse(DispatchTraversal& visitor) const override { t_traverse(*this, visitor); }
 
         void setChild(std::size_t pos, vsg::Node* node) { _children[pos] = node; }

include/vsg/nodes/Group.h

@@ -21,17 +21,14 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 namespace vsg
 {
-    class VSG_EXPORT Group : public vsg::Node
+    class VSG_EXPORT Group : public Inherit<Node, Group>
     {
     public:
         Group(size_t numChildren=0);
 
         template<class N, class V> static void t_traverse(N& node, V& visitor) { for (auto& child : node._children) child->accept(visitor); }
 
-        void accept(Visitor& visitor) override { visitor.apply(*this); }
         void traverse(Visitor& visitor) override { t_traverse(*this, visitor); }
-
-        void accept(DispatchTraversal& visitor) const override { visitor.apply(*this); }
         void traverse(DispatchTraversal& visitor) const override { t_traverse(*this, visitor); }
 
         std::size_t addChild(vsg::Node* child) { std::size_t pos = _children.size(); _children.push_back(child); return pos; }
@@ -55,4 +52,5 @@ namespace vsg
 
         Children _children;
     };
+
 }