LinkerManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    LinkerManager.h: Unreal object linker manager
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/CoreMisc.h"
#include "Misc/ScopeLock.h"
#include "HAL/ThreadSafeBool.h"
 
class FLinkerManager : private FSelfRegisteringExec
{
public:
    FLinkerManager();
    ~FLinkerManager();
 
    static FLinkerManager& Get();
 
    FORCEINLINE void GetLoaders(TSet<FLinkerLoad*>& OutLoaders)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&ObjectLoadersCritical);
#endif
        OutLoaders = ObjectLoaders;
    }
 
    FORCEINLINE void GetLoadersAndEmpty(TSet<FLinkerLoad*>& OutLoaders)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&ObjectLoadersCritical);
#endif
        OutLoaders = MoveTemp(ObjectLoaders);
        check(ObjectLoaders.Num() == 0);
    }
 
    FORCEINLINE void AddLoader(FLinkerLoad* LinkerLoad)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&ObjectLoadersCritical);
#endif
        ObjectLoaders.Add(LinkerLoad);
    }
 
    FORCEINLINE void RemoveLoaderFromObjectLoadersAndLoadersWithNewImports(FLinkerLoad* LinkerLoad)
    {
        {
#if THREADSAFE_UOBJECTS
            FScopeLock ObjectLoadersLock(&ObjectLoadersCritical);
#endif
            ObjectLoaders.Remove(LinkerLoad);
        }
        {
#if THREADSAFE_UOBJECTS
            FScopeLock ObjectLoadersLock(&LoadersWithNewImportsCritical);
#endif
            LoadersWithNewImports.Remove(LinkerLoad);
        }
    }
 
    FORCEINLINE void GetLoadersWithNewImportsAndEmpty(TSet<FLinkerLoad*>& OutLoaders)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&LoadersWithNewImportsCritical);
#endif
        OutLoaders = MoveTemp(LoadersWithNewImports);
    }
 
    FORCEINLINE void AddLoaderWithNewImports(FLinkerLoad* LinkerLoad)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&LoadersWithNewImportsCritical);
#endif
        LoadersWithNewImports.Add(LinkerLoad);
    }
 
    FORCEINLINE void GetLoadersWithForcedExportsAndEmpty(TSet<FLinkerLoad*>& OutLoaders)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&LoadersWithForcedExportsCritical);
#endif
        OutLoaders = MoveTemp(LoadersWithForcedExports);
    }
 
    FORCEINLINE void AddLoaderWithForcedExports(FLinkerLoad* LinkerLoad)
    {
#if THREADSAFE_UOBJECTS
        FScopeLock ObjectLoadersLock(&LoadersWithForcedExportsCritical);
#endif
        LoadersWithForcedExports.Add(LinkerLoad);
    }
 
#if !UE_BUILD_SHIPPING && !UE_BUILD_TEST
    FORCEINLINE void AddLiveLinker(FLinkerLoad* Linker)
    {
        FScopeLock LiveLinkersLock(&LiveLinkersCritical);
        LiveLinkers.Add(Linker);
    }
 
    FORCEINLINE void RemoveLiveLinker(FLinkerLoad* Linker)
    {
        FScopeLock LiveLinkersLock(&LiveLinkersCritical);
        LiveLinkers.Remove(Linker);
    }
#endif
 
    void ResetLinkerExports(UPackage* InPackage);
 
    void ResetLoaders(UObject* InPkg);
 
    void ResetLoaders(TConstArrayView<FLinkerLoad*> InLinkerLoad);
 
    void ResetLoaders(const TSet<FLinkerLoad*>& InLinkerLoadSet);
 
    void EnsureLoadingComplete(UPackage* Package);
 
    void DissociateImportsAndForcedExports();
 
    void DeleteLinkers();
 
    void RemoveLinker(FLinkerLoad* Linker);
 
protected:
    // FSelfRegisteringExec interface
    virtual bool Exec_Dev(class UWorld* InWorld,const TCHAR* Cmd,FOutputDevice& Ar) override;
 
private:
 
    TSet<FLinkerLoad*> ObjectLoaders;
#if THREADSAFE_UOBJECTS
    FCriticalSection ObjectLoadersCritical;
#endif
 
    TSet<FLinkerLoad*> LoadersWithNewImports;
#if THREADSAFE_UOBJECTS
    FCriticalSection LoadersWithNewImportsCritical;
#endif
#if !UE_BUILD_SHIPPING && !UE_BUILD_TEST
    FCriticalSection LiveLinkersCritical;
    TSet<FLinkerLoad*> LiveLinkers;
#endif
    
    TSet<FLinkerLoad*> LoadersWithForcedExports;
#if THREADSAFE_UOBJECTS
    FCriticalSection LoadersWithForcedExportsCritical;
#endif
 
    TSet<FLinkerLoad*>  PendingCleanupList;
#if THREADSAFE_UOBJECTS
    FCriticalSection PendingCleanupListCritical;
#endif
    FThreadSafeBool bHasPendingCleanup;
};