Enable recycling in the GL Object pool

gwaldron · Feb 23, 2024 · 2dbba5a · 2dbba5a
1 parent ae287e9
commit 2dbba5a
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/src/osgEarth/GLUtils b/src/osgEarth/GLUtils
@@ -572,6 +572,9 @@ namespace osgEarth
         //! construct an object pool under the given graphics context ID
         GLObjectPool(unsigned contextID);
 
+        //! Whether to support recycling of GL objects with identical properties
+        static void setEnableRecycling(bool value) { _enableRecycling = value; }
+
         //! Fetch the object pool for the graphics context represented
         //! by the state object
         static GLObjectPool* get(osg::State& state);
@@ -600,7 +603,8 @@ namespace osgEarth
 
         template<typename T>
         typename T::Ptr recycle(const GLObject::Compatible& compatible) {
-            std::unique_lock<std::mutex> lock(_mutex);
+            if (!_enableRecycling) return {};
+            std::lock_guard<std::mutex> lock(_mutex);
             typename T::Ptr result;
             for (auto& object : _objects) {
                 if (object.use_count() == 1 && compatible(object.get())) {
@@ -628,6 +632,7 @@ namespace osgEarth
         mutable std::mutex _mutex;
         Collection _objects; // objects being monitored
         GLsizeiptr _totalBytes;
+        static bool _enableRecycling;
         unsigned _hits;
         unsigned _misses;
         unsigned _avarice;

diff --git a/src/osgEarth/GLUtils.cpp b/src/osgEarth/GLUtils.cpp
@@ -44,7 +44,7 @@ using namespace osgEarth;
 
 #define LC "[GLUtils] "
 
-//#define USE_RECYCLING
+#define USE_RECYCLING
 
 #define OE_DEVEL OE_DEBUG
 
@@ -525,6 +525,7 @@ namespace
     std::mutex s_pools_mutex;
     std::vector<GLObjectPool*> s_pools;
 }
+bool GLObjectPool::_enableRecycling = true;
 
 
 GLObjectPool*
@@ -544,7 +545,7 @@ std::unordered_map<int, GLObjectPool*>
 GLObjectPool::getAll()
 {
     std::unordered_map<int, GLObjectPool*> result;
-    std::unique_lock<std::mutex> lock(s_pools_mutex);
+    std::lock_guard<std::mutex> lock(s_pools_mutex);
     for (auto& pool : s_pools)
         result[pool->getContextID()] = pool;
     return result;
@@ -559,7 +560,7 @@ GLObjectPool::GLObjectPool(unsigned cxid) :
 {
     _gcs.resize(256);
 
-    std::unique_lock<std::mutex> lock(s_pools_mutex);
+    std::lock_guard<std::mutex> lock(s_pools_mutex);
     s_pools.emplace_back(this);
 
     char* value = ::getenv("OSGEARTH_GL_OBJECT_POOL_DELAY");
@@ -605,7 +606,7 @@ GLObjectPool::track(osg::GraphicsContext* gc)
 void
 GLObjectPool::watch(GLObject::Ptr object)
 {
-    std::unique_lock<std::mutex> lock(_mutex);
+    std::lock_guard<std::mutex> lock(_mutex);
     _objects.emplace_back(object);
 }
 
@@ -663,7 +664,7 @@ GLObjectPool::discardAllGLObjects()
 void
 GLObjectPool::releaseAll(const osg::GraphicsContext* gc)
 {
-    std::unique_lock<std::mutex> lock(_mutex);
+    std::lock_guard<std::mutex> lock(_mutex);
 
     GLsizeiptr bytes = 0;
     GLObjectPool::Collection keepers;
@@ -688,7 +689,7 @@ GLObjectPool::releaseAll(const osg::GraphicsContext* gc)
 void
 GLObjectPool::releaseOrphans(const osg::GraphicsContext* gc)
 {
-    std::unique_lock<std::mutex> lock(_mutex);
+    std::lock_guard<std::mutex> lock(_mutex);
 
     unsigned maxNumToRelease = std::max(1u, (unsigned)pow(4.0f, _avarice));
     unsigned numReleased = 0u;
@@ -1755,6 +1756,16 @@ namespace
 
 std::atomic_int GLObjectsCompiler::_jobsActive;
 
+namespace
+{
+    struct StateToCompileEx : public osgUtil::StateToCompile
+    {
+        void apply(osg::StateSet& stateSet) override
+        {
+        }
+    };
+}
+
 osg::ref_ptr<osgUtil::StateToCompile>
 GLObjectsCompiler::collectState(osg::Node* node) const
 {

diff --git a/src/osgEarth/ImGui/RenderingGUI b/src/osgEarth/ImGui/RenderingGUI
@@ -408,6 +408,13 @@ namespace osgEarth
                             }
                             if (pools.size() > 1)
                                 ImGui::Separator();
+
+                            auto recycle_attempts = glpool->recycleHits() + glpool->recycleMisses();
+                            if (recycle_attempts > 0)
+                            {
+                                float re = (float)glpool->recycleHits() / (float)recycle_attempts;
+                                ImGui::Text("Recycle Efficiency: %.0f%%", 100.0f * re);
+                            }
                         }
                     }
                 }