StateObjectsRegistry.h

/*     Copyright 2015-2018 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  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 OF ANY PROPRIETARY RIGHTS.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once


#include "DeviceObject.h"
#include <unordered_map>
#include "STDAllocator.h"

namespace Diligent
{
    
    template<typename ResourceDescType>
    class StateObjectsRegistry
    {
    public:
        static constexpr int DeletedObjectsToPurge = 32;

        StateObjectsRegistry(IMemoryAllocator &RawAllocator, const Char* RegistryName) :
            m_RegistryName( RegistryName ),
            m_DescToObjHashMap(STD_ALLOCATOR_RAW_MEM(HashMapElem, RawAllocator, "Allocator for unordered_map<ResourceDescType, RefCntWeakPtr<IDeviceObject> >") )
        {}
        
        ~StateObjectsRegistry()
        {
            // Object registry is part of the device, and every device
            // object holds a strong reference to the device. So device
            // is destroyed after all device objects are destroyed, and there
            // may only be expired references in the registry. After we
            // purge it, the registry must be empty.
            Purge();
            VERIFY( m_DescToObjHashMap.empty(), "DescToObjHashMap is not empty" );
        }


        void Add( const ResourceDescType& ObjectDesc, IDeviceObject *pObject )
        {
            ThreadingTools::LockHelper Lock( m_LockFlag );

            // If the number of outstanding deleted objects reached the threshold value,
            // purge the registry. Since we have exclusive access now, it is safe
            // to do.
            if( m_NumDeletedObjects >= DeletedObjectsToPurge )
            {
                Purge();
                m_NumDeletedObjects = 0;
            }

            // Try to construct the new element in place
            auto Elems = m_DescToObjHashMap.emplace( std::make_pair( ObjectDesc, Diligent::RefCntWeakPtr<IDeviceObject>(pObject) ) );
            // It is theorertically possible that the same object can be found
            // in the registry. This might happen if two threads try to create
            // the same object at the same time. They both will not find the
            // object and then will create and try to add it.
            //
            // If the object already exists, we replace the existing reference.
            // This is safer as there might be scenarios where existing reference
            // might be expired. For instance, two threads try to create the same
            // object which is not in the registry. The first thread creates
            // the object, adds it to the registry and then releases it. After that
            // the second thread creates the same object and tries to add it to
            // the registry. It will find an existing expired reference to the 
            // object.
            if( !Elems.second )
            {
                VERIFY( Elems.first->first == ObjectDesc, "Incorrect object description" );
                LOG_WARNING_MESSAGE( "Object named \"", Elems.first->first.Name, "\" with the same description already exists in the registry."
                                     "Replacing with the new object named \"", ObjectDesc.Name ? ObjectDesc.Name : "", "\".");
                Elems.first->second = pObject;
            }
        }

        void Find( const ResourceDescType &Desc, IDeviceObject **ppObject )
        {
            VERIFY( *ppObject == nullptr, "Overwriting reference to existing object may cause memory leaks" );
            *ppObject = nullptr;
            ThreadingTools::LockHelper Lock( m_LockFlag );

            auto It = m_DescToObjHashMap.find( Desc );
            if( It != m_DescToObjHashMap.end() )
            {
                // Try to obtain strong reference to the object.
                // This is an atomic operation and we either get
                // a new strong reference or object has been destroyed
                // and we get null.
                auto pObject = It->second.Lock();
                if( pObject )
                {
                    *ppObject = pObject.Detach();
                    LOG_INFO_MESSAGE( "Equivalent of the requested state object named \"", Desc.Name ? Desc.Name : "", "\" found in the ", m_RegistryName, " registry. Reusing existing object.");
                }
                else
                {
                    // Expired object found: remove it from the map
                    m_DescToObjHashMap.erase(It);
                    Atomics::AtomicDecrement(m_NumDeletedObjects);
                }
            }
        }

        void Purge()
        {
            Uint32 NumPurgedObjects = 0;
            auto It = m_DescToObjHashMap.begin();
            while(  It != m_DescToObjHashMap.end() )
            {
                auto NextIt = It;
                ++NextIt;
                // Note that IsValid() is not a thread-safe function in the sense that it 
                // can give false positive results. The only thread-safe way to check if the
                // object is alive is to lock the weak pointer, but that requires thread 
                // synchronization. We will immediately unlock the pointer anyway, so we
                // want to detect 100% expired pointers. IsValid() does provide that information
                // because once a weak pointer becomes invalid, it will be invalid
                // until it is destroyed. It is not a problem if we miss an expired weak
                // pointer as it will definitiely be removed next time.
                if( !It->second.IsValid() )
                {
                    m_DescToObjHashMap.erase( It );
                    ++NumPurgedObjects;
                }

                It = NextIt;
            }
            LOG_INFO_MESSAGE( "Purged ", NumPurgedObjects, " deleted objects from the ", m_RegistryName, " registry" );
        }

        void ReportDeletedObject()
        {
            Atomics::AtomicIncrement(m_NumDeletedObjects);
        }

    private:
        ThreadingTools::LockFlag m_LockFlag;
        
        Atomics::AtomicLong m_NumDeletedObjects;

        typedef std::pair< const ResourceDescType, RefCntWeakPtr<IDeviceObject> > HashMapElem;
        std::unordered_map<ResourceDescType, RefCntWeakPtr<IDeviceObject>, std::hash<ResourceDescType>, std::equal_to<ResourceDescType>, STDAllocatorRawMem<HashMapElem> > m_DescToObjHashMap;

        const String m_RegistryName;
    };
}