ChunkDbChunkSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Installer/ChunkSource.h"
#include "Installer/Controllable.h"
#include "Containers/Set.h"
#include "Common/SpeedRecorder.h"
 
class IBuildInstallerSharedContext;
 
namespace BuildPatchServices
{
    class IFileSystem;
    class IChunkReferenceTracker;
    class IChunkDataSerialization;
    class IChunkDbChunkSourceStat;
    class IBuildManifestSet;
 
    
    struct FChunkDbSourceConfig
    {
        // An array of chunkdb full file paths.
        TArray<FString> ChunkDbFiles;
 
        // If true, once we complete a file we delete all the chunkdbs used to create it.
        bool bDeleteChunkDBAfterUse = false;
 
        FChunkDbSourceConfig(const TArray<FString>& InChunkDbFiles)
        : ChunkDbFiles(InChunkDbFiles)
        {}
    };
 
    class IConstructorChunkDbChunkSource : public IConstructorChunkSource
    {
    public:
        virtual ~IConstructorChunkDbChunkSource() {}
 
        virtual const TSet<FGuid>& GetAvailableChunks() const = 0;
 
        // Fill out how many bytes of chunkdbs are left if we delete all the ones that
        // are no longer necessary at the given FileCompletionIndexes in to ChunkAccessOrderedList
        static uint64 GetChunkDbSizesAtIndexes(const TArray<FString>& ChunkDbFiles, IFileSystem* FileSystem, const TArray<FGuid>& ChunkAccessOrderedList, const TArray<int32>& FileCompletionIndexes, TArray<uint64>& OutChunkDbSizesAtCompletion);
 
        // As above, except use the remaining open chunkdbs for progressive disk space checking.        
        virtual uint64 GetChunkDbSizesAtIndexes(const TArray<int32>& FileCompletionIndexes, TArray<uint64>& OutChunkDbSizesAtCompletion) const = 0;
 
        virtual void ReportFileCompletion(int32 RemainingChunkCount) =0;
 
        static IConstructorChunkDbChunkSource* CreateChunkDbSource(FChunkDbSourceConfig&& Configuration, IFileSystem* FileSystem, const TArray<FGuid>& ChunkAccessOrderList, 
            IChunkDataSerialization* ChunkDataSerialization, IChunkDbChunkSourceStat* ChunkDbChunkSourceStat);
    };
    
    class IChunkDbChunkSourceStat
    {
    public:
        enum class ELoadResult : uint8
        {
            Success = 0,
 
            // The hash information was missing.
            MissingHashInfo_DEPRECATED,
 
            // The expected data hash for the chunk did not match.
            HashCheckFailed_DEPRECATED,
 
            // The chunkdb header specified an invalid chunk location offset or size.
            LocationOutOfBounds_DEPRECATED,
 
            // An unexpected error during serialization. This includes header validation
            // checks like whether the hash is present.
            SerializationError,
            
            // Either the hash didn't match or the decompression call failed.
            CorruptedData
        };
 
    public:
        virtual ~IChunkDbChunkSourceStat() {}
 
        UE_DEPRECATED(5.6, "No longer batch loaded")
        virtual void OnBatchStarted(const TArray<FGuid>& ChunkIds) {};
 
        virtual void OnLoadStarted(const FGuid& ChunkId) = 0;
 
        virtual void OnLoadComplete(const FGuid& ChunkId, ELoadResult Result) = 0;
 
        // Called when the read for the load is complete and we're moving on to decompression/hashing.
        virtual void OnReadComplete(const ISpeedRecorder::FRecord& Record) = 0;
    };
    
    const TCHAR* ToString(const IChunkDbChunkSourceStat::ELoadResult& LoadResult);
}