DeviceObjectBase: reworked unique identifiers

Author: TheMostDiligent

Graphics/GraphicsEngine/include/DeviceObjectBase.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -60,6 +60,7 @@ class DeviceObjectBase : public ObjectBase<BaseInterface>
         TBase              {pRefCounters},
         m_pDevice          {pDevice          },
         m_Desc             {ObjDesc          },
+        m_UniqueID         {pDevice != nullptr ? pDevice->GenerateUniqueId() : 0},
         m_bIsDeviceInternal{bIsDeviceInternal}
     //clang-format on
     {
@@ -145,14 +146,20 @@ class DeviceObjectBase : public ObjectBase<BaseInterface>
     }
 
     /// Returns unique identifier
+
+    /// \remarks
+    ///     This unique ID is used to unambiguously identify device object for
+    ///     tracking purposes within the device.
+    ///     Neither GL handle nor pointer could be safely used for this purpose
+    ///     as both GL reuses released handles and we pool device objects and reuse
+    ///     released ones.
+    ///
+    /// \note
+    ///      Objects created from different devices may have the same unique ID.
     virtual Int32 DILIGENT_CALL_TYPE GetUniqueID() const override final
     {
-        /// \note
-        /// This unique ID is used to unambiguously identify device object for
-        /// tracking purposes.
-        /// Neither GL handle nor pointer could be safely used for this purpose
-        /// as both GL reuses released handles and the OS reuses released pointers.
-        return m_UniqueID.GetID();
+        VERIFY(m_UniqueID != 0, "Unique ID is not initialized. This indicates that this device object has been created without a device");
+        return m_UniqueID;
     }
 
     /// Implementation of IDeviceObject::SetUserData.
@@ -189,10 +196,11 @@ class DeviceObjectBase : public ObjectBase<BaseInterface>
     /// Object description
     ObjectDescType m_Desc;
 
-    // Template argument is only used to separate counters for
-    // different groups of objects
-    UniqueIdHelper<BaseInterface> m_UniqueID;
-    const bool                    m_bIsDeviceInternal;
+    // WARNING: using static counter for unique ID is not safe
+    //          as there may be different counter instances in different
+    //          executable units (e.g. in different DLLs).
+    const UniqueIdentifier m_UniqueID;
+    const bool             m_bIsDeviceInternal;
 
     RefCntAutoPtr<IObject> m_pUserData;
 };

Graphics/GraphicsEngine/include/RenderDeviceBase.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,6 +30,8 @@
 /// \file
 /// Implementation of the Diligent::RenderDeviceBase template class and related structures
 
+#include <atomic>
+
 #include "RenderDevice.h"
 #include "DeviceObjectBase.hpp"
 #include "Defines.h"
@@ -329,6 +331,11 @@ class RenderDeviceBase : public ObjectBase<typename EngineImplTraits::RenderDevi
         return m_DeviceInfo.Features;
     }
 
+    UniqueIdentifier GenerateUniqueId()
+    {
+        return m_UniqueId.fetch_add(1) + 1;
+    }
+
 protected:
     virtual void TestTextureFormat(TEXTURE_FORMAT TexFormat) = 0;
 
@@ -597,6 +604,8 @@ class RenderDeviceBase : public ObjectBase<typename EngineImplTraits::RenderDevi
     FixedBlockMemoryAllocator m_PipeResSignAllocator; ///< Allocator for pipeline resource signature objects
     FixedBlockMemoryAllocator m_MemObjAllocator;      ///< Allocator for device memory objects
     FixedBlockMemoryAllocator m_PSOCacheAllocator;    ///< Allocator for pipeline state cache objects
+
+    std::atomic<UniqueIdentifier> m_UniqueId{0};
 };
 
 } // namespace Diligent