// Copyright 1998-2016 Epic Games, Inc. All Rights Reserved. #include "PakFilePrivatePCH.h" #include "IPlatformFilePak.h" #include "SecureHash.h" #include "FileManagerGeneric.h" #include "ModuleManager.h" #include "IPlatformFileModule.h" #include "IOBase.h" #include "BigInt.h" #include "SignedArchiveReader.h" #include "PublicKey.inl" #include "AES.h" #include "GenericPlatformChunkInstall.h" #include "AsyncFileHandle.h" DEFINE_LOG_CATEGORY(LogPakFile); DEFINE_STAT(STAT_PakFile_Read); DEFINE_STAT(STAT_PakFile_NumOpenHandles); FFilenameSecurityDelegate& FPakPlatformFile::GetFilenameSecurityDelegate() { static FFilenameSecurityDelegate Delegate; return Delegate; } #if USE_NEW_ASYNC_IO #define USE_PAK_PRECACHE (1) // you can turn this off to use the async IO stuff without the precache #else #define USE_PAK_PRECACHE (0) #endif /** * Precaching */ #if USE_PAK_PRECACHE #include "TaskGraphInterfaces.h" #define PAK_CACHE_GRANULARITY (64 * 1024) #define PAK_CACHE_MAX_REQUEST (1024 * 1024) #define PAK_CACHE_MAX_REQUESTS (8) #define PAK_CACHE_MAX_PRIORITY_DIFFERENCE_MERGE (AIOP_Normal - AIOP_Precache) DECLARE_MEMORY_STAT(TEXT("PakCache Total"), STAT_PakCacheMem, STATGROUP_Memory); static int32 GPakCache_Enable = 1; static FAutoConsoleVariableRef CVar_Enable( TEXT("pakcache.Enable"), GPakCache_Enable, TEXT("If > 0, then enable the pak cache.") ); static int32 GPakCache_MaxRequestsToLowerLevel = 2; static FAutoConsoleVariableRef CVar_MaxRequestsToLowerLevel( TEXT("pakcache.MaxRequestsToLowerLevel"), GPakCache_MaxRequestsToLowerLevel, TEXT("Controls the maximum number of IO requests submitted to the OS filesystem at one time. Limited by PAK_CACHE_MAX_REQUESTS.") ); static int32 GPakCache_MaxRequestSizeToLowerLevelKB = PAK_CACHE_MAX_REQUEST / 1024; static FAutoConsoleVariableRef CVar_MaxRequestSizeToLowerLevelKB( TEXT("pakcache.MaxRequestSizeToLowerLevellKB"), GPakCache_MaxRequestSizeToLowerLevelKB, TEXT("Controls the maximum size (in KB) of IO requests submitted to the OS filesystem. Limited by PAK_CACHE_MAX_REQUEST.") ); static int32 GPakCache_MaxPrecacheMemMB = 0; static FAutoConsoleVariableRef CVar_MaxPrecacheMemMB( TEXT("pakcache.MaxPrecacheMemMB"), GPakCache_MaxPrecacheMemMB, TEXT("Controls the maximum amount of memory (in MB) that will be used for precaching. Total memory use can be higher because not all requests are precache requests. Setting this to zero means unlimited memory.") ); class FPakPrecacher; typedef uint64 FJoinedOffsetAndPakIndex; static FORCEINLINE uint16 GetRequestPakIndexLow(FJoinedOffsetAndPakIndex Joined) { return uint16((Joined >> 48) & 0xffff); } static FORCEINLINE int64 GetRequestOffset(FJoinedOffsetAndPakIndex Joined) { return int64(Joined & 0xffffffffffffll); } static FORCEINLINE FJoinedOffsetAndPakIndex MakeJoinedRequest(uint16 PakIndex, int64 Offset) { check(Offset >= 0); return (FJoinedOffsetAndPakIndex(PakIndex) << 48) | Offset; } enum { IntervalTreeInvalidIndex = 0 }; typedef uint32 TIntervalTreeIndex; // this is the arg type of TSparseArray::operator[] static uint32 GNextSalt = 1; // This is like TSparseArray, only a bit safer and I needed some restrictions on resizing. template class TIntervalTreeAllocator { TArray Items; TArray FreeItems; //@todo make this into a linked list through the existing items uint32 Salt; uint32 SaltMask; public: TIntervalTreeAllocator() { check(GNextSalt < 4); Salt = (GNextSalt++) << 30; SaltMask = MAX_uint32 << 30; verify((Alloc() & ~SaltMask) == IntervalTreeInvalidIndex); // we want this to always have element zero so we can figure out an index from a pointer } inline TIntervalTreeIndex Alloc() { int32 Result; if (FreeItems.Num()) { Result = FreeItems.Pop(); } else { Result = Items.Num(); Items.AddUninitialized(); } new ((void*)&Items[Result]) TItem(); return Result | Salt;; } void EnsureNoRealloc(int32 NeededNewNum) { if (FreeItems.Num() + Items.GetSlack() < NeededNewNum) { Items.Reserve(Items.Num() + NeededNewNum); } } FORCEINLINE TItem& Get(TIntervalTreeIndex InIndex) { TIntervalTreeIndex Index = InIndex & ~SaltMask; check((InIndex & SaltMask) == Salt && Index != IntervalTreeInvalidIndex && Index >= 0 && Index < Items.Num() && !FreeItems.Contains(Index)); return Items[Index]; } FORCEINLINE void Free(TIntervalTreeIndex InIndex) { TIntervalTreeIndex Index = InIndex & ~SaltMask; check((InIndex & SaltMask) == Salt && Index != IntervalTreeInvalidIndex && Index >= 0 && Index < Items.Num() && !FreeItems.Contains(Index)); Items[Index].~TItem(); FreeItems.Push(Index); if (FreeItems.Num() + 1 == Items.Num()) { // get rid everything to restore memory coherence Items.Empty(); FreeItems.Empty(); verify((Alloc() & ~SaltMask) == IntervalTreeInvalidIndex); // we want this to always have element zero so we can figure out an index from a pointer } } FORCEINLINE void CheckIndex(TIntervalTreeIndex InIndex) { TIntervalTreeIndex Index = InIndex & ~SaltMask; check((InIndex & SaltMask) == Salt && Index != IntervalTreeInvalidIndex && Index >= 0 && Index < Items.Num() && !FreeItems.Contains(Index)); } }; class FIntervalTreeNode { public: TIntervalTreeIndex LeftChildOrRootOfLeftList; TIntervalTreeIndex RootOfOnList; TIntervalTreeIndex RightChildOrRootOfRightList; FIntervalTreeNode() : LeftChildOrRootOfLeftList(IntervalTreeInvalidIndex) , RootOfOnList(IntervalTreeInvalidIndex) , RightChildOrRootOfRightList(IntervalTreeInvalidIndex) { } ~FIntervalTreeNode() { check(LeftChildOrRootOfLeftList == IntervalTreeInvalidIndex && RootOfOnList == IntervalTreeInvalidIndex && RightChildOrRootOfRightList == IntervalTreeInvalidIndex); // this routine does not handle recursive destruction } }; static TIntervalTreeAllocator GIntervalTreeNodeNodeAllocator; static FORCEINLINE uint64 HighBit(uint64 x) { return x & (1ull << 63); } static FORCEINLINE bool IntervalsIntersect(uint64 Min1, uint64 Max1, uint64 Min2, uint64 Max2) { return !(Max2 < Min1 || Max1 < Min2); } template // this routine assume that the pointers remain valid even though we are reallocating static void AddToIntervalTree_Dangerous( TIntervalTreeIndex* RootNode, TIntervalTreeAllocator& Allocator, TIntervalTreeIndex Index, uint64 MinInterval, uint64 MaxInterval, uint32 CurrentShift, uint32 MaxShift ) { while (true) { if (*RootNode == IntervalTreeInvalidIndex) { *RootNode = GIntervalTreeNodeNodeAllocator.Alloc(); } int64 MinShifted = HighBit(MinInterval << CurrentShift); int64 MaxShifted = HighBit(MaxInterval << CurrentShift); FIntervalTreeNode& Root = GIntervalTreeNodeNodeAllocator.Get(*RootNode); if (MinShifted == MaxShifted && CurrentShift < MaxShift) { CurrentShift++; RootNode = (!MinShifted) ? &Root.LeftChildOrRootOfLeftList : &Root.RightChildOrRootOfRightList; } else { TItem& Item = Allocator.Get(Index); if (MinShifted != MaxShifted) // crosses middle { Item.Next = Root.RootOfOnList; Root.RootOfOnList = Index; } else // we are at the leaf { if (!MinShifted) { Item.Next = Root.LeftChildOrRootOfLeftList; Root.LeftChildOrRootOfLeftList = Index; } else { Item.Next = Root.RightChildOrRootOfRightList; Root.RightChildOrRootOfRightList = Index; } } return; } } } template static void AddToIntervalTree( TIntervalTreeIndex* RootNode, TIntervalTreeAllocator& Allocator, TIntervalTreeIndex Index, uint32 StartShift, uint32 MaxShift ) { GIntervalTreeNodeNodeAllocator.EnsureNoRealloc(1 + MaxShift - StartShift); TItem& Item = Allocator.Get(Index); check(Item.Next == IntervalTreeInvalidIndex); uint64 MinInterval = GetRequestOffset(Item.OffsetAndPakIndex); uint64 MaxInterval = MinInterval + Item.Size - 1; AddToIntervalTree_Dangerous(RootNode, Allocator, Index, MinInterval, MaxInterval, StartShift, MaxShift); } template static FORCEINLINE bool ScanNodeListForRemoval( TIntervalTreeIndex* Iter, TIntervalTreeAllocator& Allocator, TIntervalTreeIndex Index, uint64 MinInterval, uint64 MaxInterval ) { while (*Iter != IntervalTreeInvalidIndex) { TItem& Item = Allocator.Get(*Iter); if (*Iter == Index) { *Iter = Item.Next; Item.Next = IntervalTreeInvalidIndex; return true; } Iter = &Item.Next; } return false; } template static bool RemoveFromIntervalTree( TIntervalTreeIndex* RootNode, TIntervalTreeAllocator& Allocator, TIntervalTreeIndex Index, uint64 MinInterval, uint64 MaxInterval, uint32 CurrentShift, uint32 MaxShift ) { bool bResult = false; if (*RootNode != IntervalTreeInvalidIndex) { int64 MinShifted = HighBit(MinInterval << CurrentShift); int64 MaxShifted = HighBit(MaxInterval << CurrentShift); FIntervalTreeNode& Root = GIntervalTreeNodeNodeAllocator.Get(*RootNode); if (!MinShifted && !MaxShifted) { if (CurrentShift == MaxShift) { bResult = ScanNodeListForRemoval(&Root.LeftChildOrRootOfLeftList, Allocator, Index, MinInterval, MaxInterval); } else { bResult = RemoveFromIntervalTree(&Root.LeftChildOrRootOfLeftList, Allocator, Index, MinInterval, MaxInterval, CurrentShift + 1, MaxShift); } } else if (!MinShifted && MaxShifted) { bResult = ScanNodeListForRemoval(&Root.RootOfOnList, Allocator, Index, MinInterval, MaxInterval); } else { if (CurrentShift == MaxShift) { bResult = ScanNodeListForRemoval(&Root.RightChildOrRootOfRightList, Allocator, Index, MinInterval, MaxInterval); } else { bResult = RemoveFromIntervalTree(&Root.RightChildOrRootOfRightList, Allocator, Index, MinInterval, MaxInterval, CurrentShift + 1, MaxShift); } } if (bResult) { if (Root.LeftChildOrRootOfLeftList == IntervalTreeInvalidIndex && Root.RootOfOnList == IntervalTreeInvalidIndex && Root.RightChildOrRootOfRightList == IntervalTreeInvalidIndex) { check(&Root == &GIntervalTreeNodeNodeAllocator.Get(*RootNode)); GIntervalTreeNodeNodeAllocator.Free(*RootNode); *RootNode = IntervalTreeInvalidIndex; } } } return bResult; } template static bool RemoveFromIntervalTree( TIntervalTreeIndex* RootNode, TIntervalTreeAllocator& Allocator, TIntervalTreeIndex Index, uint32 StartShift, uint32 MaxShift ) { TItem& Item = Allocator.Get(Index); uint64 MinInterval = GetRequestOffset(Item.OffsetAndPakIndex); uint64 MaxInterval = MinInterval + Item.Size - 1; return RemoveFromIntervalTree(RootNode, Allocator, Index, MinInterval, MaxInterval, StartShift, MaxShift); } template static FORCEINLINE void ScanNodeListForRemovalFunc( TIntervalTreeIndex* Iter, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, TFunctionRef Func ) { while (*Iter != IntervalTreeInvalidIndex) { TItem& Item = Allocator.Get(*Iter); uint64 Offset = uint64(GetRequestOffset(Item.OffsetAndPakIndex)); uint64 LastByte = Offset + uint64(Item.Size) - 1; // save the value and then clear it. TIntervalTreeIndex NextIndex = Item.Next; if (IntervalsIntersect(MinInterval, MaxInterval, Offset, LastByte) && Func(*Iter)) { *Iter = NextIndex; // this may have already be deleted, so cannot rely on the memory block } else { Iter = &Item.Next; } } } template static void MaybeRemoveOverlappingNodesInIntervalTree( TIntervalTreeIndex* RootNode, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, uint64 MinNode, uint64 MaxNode, uint32 CurrentShift, uint32 MaxShift, TFunctionRef Func ) { if (*RootNode != IntervalTreeInvalidIndex) { int64 MinShifted = HighBit(MinInterval << CurrentShift); int64 MaxShifted = HighBit(MaxInterval << CurrentShift); FIntervalTreeNode& Root = GIntervalTreeNodeNodeAllocator.Get(*RootNode); uint64 Center = (MinNode + MaxNode + 1) >> 1; //UE_LOG(LogTemp, Warning, TEXT("Exploring Node %X [%d, %d] %d%d interval %llX %llX node interval %llX %llX center %llX "), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted, MinInterval, MaxInterval, MinNode, MaxNode, Center); if (!MinShifted) { if (CurrentShift == MaxShift) { //UE_LOG(LogTemp, Warning, TEXT("LeftBottom %X [%d, %d] %d%d"), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted); ScanNodeListForRemovalFunc(&Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, MaxInterval, Func); } else { //UE_LOG(LogTemp, Warning, TEXT("LeftRecur %X [%d, %d] %d%d"), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted); MaybeRemoveOverlappingNodesInIntervalTree(&Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, FMath::Min(MaxInterval, Center - 1), MinNode, Center - 1, CurrentShift + 1, MaxShift, Func); } } //UE_LOG(LogTemp, Warning, TEXT("Center %X [%d, %d] %d%d"), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted); ScanNodeListForRemovalFunc(&Root.RootOfOnList, Allocator, MinInterval, MaxInterval, Func); if (MaxShifted) { if (CurrentShift == MaxShift) { //UE_LOG(LogTemp, Warning, TEXT("RightBottom %X [%d, %d] %d%d"), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted); ScanNodeListForRemovalFunc(&Root.RightChildOrRootOfRightList, Allocator, MinInterval, MaxInterval, Func); } else { //UE_LOG(LogTemp, Warning, TEXT("RightRecur %X [%d, %d] %d%d"), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted); MaybeRemoveOverlappingNodesInIntervalTree(&Root.RightChildOrRootOfRightList, Allocator, FMath::Max(MinInterval, Center), MaxInterval, Center, MaxNode, CurrentShift + 1, MaxShift, Func); } } //UE_LOG(LogTemp, Warning, TEXT("Done Exploring Node %X [%d, %d] %d%d interval %llX %llX node interval %llX %llX center %llX "), *RootNode, CurrentShift, MaxShift, !!MinShifted, !!MaxShifted, MinInterval, MaxInterval, MinNode, MaxNode, Center); if (Root.LeftChildOrRootOfLeftList == IntervalTreeInvalidIndex && Root.RootOfOnList == IntervalTreeInvalidIndex && Root.RightChildOrRootOfRightList == IntervalTreeInvalidIndex) { check(&Root == &GIntervalTreeNodeNodeAllocator.Get(*RootNode)); GIntervalTreeNodeNodeAllocator.Free(*RootNode); *RootNode = IntervalTreeInvalidIndex; } } } template static FORCEINLINE bool ScanNodeList( TIntervalTreeIndex Iter, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, TFunctionRef Func ) { while (Iter != IntervalTreeInvalidIndex) { TItem& Item = Allocator.Get(Iter); uint64 Offset = uint64(GetRequestOffset(Item.OffsetAndPakIndex)); uint64 LastByte = Offset + uint64(Item.Size) - 1; if (IntervalsIntersect(MinInterval, MaxInterval, Offset, LastByte)) { if (!Func(Iter)) { return false; } } Iter = Item.Next; } return true; } template static bool OverlappingNodesInIntervalTree( TIntervalTreeIndex RootNode, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, uint64 MinNode, uint64 MaxNode, uint32 CurrentShift, uint32 MaxShift, TFunctionRef Func ) { if (RootNode != IntervalTreeInvalidIndex) { int64 MinShifted = HighBit(MinInterval << CurrentShift); int64 MaxShifted = HighBit(MaxInterval << CurrentShift); FIntervalTreeNode& Root = GIntervalTreeNodeNodeAllocator.Get(RootNode); uint64 Center = (MinNode + MaxNode + 1) >> 1; if (!MinShifted) { if (CurrentShift == MaxShift) { if (!ScanNodeList(Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, MaxInterval, Func)) { return false; } } else { if (!OverlappingNodesInIntervalTree(Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, FMath::Min(MaxInterval, Center - 1), MinNode, Center - 1, CurrentShift + 1, MaxShift, Func)) { return false; } } } if (!ScanNodeList(Root.RootOfOnList, Allocator, MinInterval, MaxInterval, Func)) { return false; } if (MaxShifted) { if (CurrentShift == MaxShift) { if (!ScanNodeList(Root.RightChildOrRootOfRightList, Allocator, MinInterval, MaxInterval, Func)) { return false; } } else { if (!OverlappingNodesInIntervalTree(Root.RightChildOrRootOfRightList, Allocator, FMath::Max(MinInterval, Center), MaxInterval, Center, MaxNode, CurrentShift + 1, MaxShift, Func)) { return false; } } } } return true; } template static bool ScanNodeListWithShrinkingInterval( TIntervalTreeIndex Iter, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64& MaxInterval, TFunctionRef Func ) { while (Iter != IntervalTreeInvalidIndex) { TItem& Item = Allocator.Get(Iter); uint64 Offset = uint64(GetRequestOffset(Item.OffsetAndPakIndex)); uint64 LastByte = Offset + uint64(Item.Size) - 1; //UE_LOG(LogTemp, Warning, TEXT("Test Overlap %llu %llu %llu %llu"), MinInterval, MaxInterval, Offset, LastByte); if (IntervalsIntersect(MinInterval, MaxInterval, Offset, LastByte)) { //UE_LOG(LogTemp, Warning, TEXT("Overlap %llu %llu %llu %llu"), MinInterval, MaxInterval, Offset, LastByte); if (!Func(Iter)) { return false; } } Iter = Item.Next; } return true; } template static bool OverlappingNodesInIntervalTreeWithShrinkingInterval( TIntervalTreeIndex RootNode, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64& MaxInterval, uint64 MinNode, uint64 MaxNode, uint32 CurrentShift, uint32 MaxShift, TFunctionRef Func ) { if (RootNode != IntervalTreeInvalidIndex) { int64 MinShifted = HighBit(MinInterval << CurrentShift); int64 MaxShifted = HighBit(FMath::Min(MaxInterval, MaxNode) << CurrentShift); // since MaxInterval is changing, we cannot clamp it during recursion. FIntervalTreeNode& Root = GIntervalTreeNodeNodeAllocator.Get(RootNode); uint64 Center = (MinNode + MaxNode + 1) >> 1; if (!MinShifted) { if (CurrentShift == MaxShift) { if (!ScanNodeListWithShrinkingInterval(Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, MaxInterval, Func)) { return false; } } else { if (!OverlappingNodesInIntervalTreeWithShrinkingInterval(Root.LeftChildOrRootOfLeftList, Allocator, MinInterval, MaxInterval, MinNode, Center - 1, CurrentShift + 1, MaxShift, Func)) // since MaxInterval is changing, we cannot clamp it during recursion. { return false; } } } if (!ScanNodeListWithShrinkingInterval(Root.RootOfOnList, Allocator, MinInterval, MaxInterval, Func)) { return false; } MaxShifted = HighBit(FMath::Min(MaxInterval, MaxNode) << CurrentShift); // since MaxInterval is changing, we cannot clamp it during recursion. if (MaxShifted) { if (CurrentShift == MaxShift) { if (!ScanNodeListWithShrinkingInterval(Root.RightChildOrRootOfRightList, Allocator, MinInterval, MaxInterval, Func)) { return false; } } else { if (!OverlappingNodesInIntervalTreeWithShrinkingInterval(Root.RightChildOrRootOfRightList, Allocator, FMath::Max(MinInterval, Center), MaxInterval, Center, MaxNode, CurrentShift + 1, MaxShift, Func)) { return false; } } } } return true; } template static void MaskInterval( TIntervalTreeIndex Index, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, uint32 BytesToBitsShift, uint64* Bits ) { TItem& Item = Allocator.Get(Index); uint64 Offset = uint64(GetRequestOffset(Item.OffsetAndPakIndex)); uint64 LastByte = Offset + uint64(Item.Size) - 1; uint64 InterMinInterval = FMath::Max(MinInterval, Offset); uint64 InterMaxInterval = FMath::Min(MaxInterval, LastByte); if (InterMinInterval <= InterMaxInterval) { uint32 FirstBit = uint32((InterMinInterval - MinInterval) >> BytesToBitsShift); uint32 LastBit = uint32((InterMaxInterval - MinInterval) >> BytesToBitsShift); uint32 FirstQWord = FirstBit >> 6; uint32 LastQWord = LastBit >> 6; uint32 FirstBitQWord = FirstBit & 63; uint32 LastBitQWord = LastBit & 63; if (FirstQWord == LastQWord) { Bits[FirstQWord] |= ((MAX_uint64 << FirstBitQWord) & (MAX_uint64 >> (63 - LastBitQWord))); } else { Bits[FirstQWord] |= (MAX_uint64 << FirstBitQWord); for (uint32 QWordIndex = FirstQWord + 1; QWordIndex < LastQWord; QWordIndex++) { Bits[QWordIndex] = MAX_uint64; } Bits[LastQWord] |= (MAX_uint64 >> (63 - LastBitQWord)); } } } template static void OverlappingNodesInIntervalTreeMask( TIntervalTreeIndex RootNode, TIntervalTreeAllocator& Allocator, uint64 MinInterval, uint64 MaxInterval, uint64 MinNode, uint64 MaxNode, uint32 CurrentShift, uint32 MaxShift, uint32 BytesToBitsShift, uint64* Bits ) { OverlappingNodesInIntervalTree( RootNode, Allocator, MinInterval, MaxInterval, MinNode, MaxNode, CurrentShift, MaxShift, [&Allocator, MinInterval, MaxInterval, BytesToBitsShift, Bits](TIntervalTreeIndex Index) -> bool { MaskInterval(Index, Allocator, MinInterval, MaxInterval, BytesToBitsShift, Bits); return true; } ); } class IPakRequestor { friend class FPakPrecacher; FJoinedOffsetAndPakIndex OffsetAndPakIndex; // this is used for searching and filled in when you make the request uint64 UniqueID; TIntervalTreeIndex InRequestIndex; public: IPakRequestor() : OffsetAndPakIndex(MAX_uint64) // invalid value , UniqueID(0) , InRequestIndex(IntervalTreeInvalidIndex) { } virtual ~IPakRequestor() { } virtual void RequestIsComplete() { } }; static FPakPrecacher* PakPrecacherSingleton = nullptr; class FPakPrecacher { enum class EInRequestStatus { Complete, Waiting, InFlight, Num }; enum class EBlockStatus { InFlight, Complete, Num }; IPlatformFile* LowerLevel; FCriticalSection CachedFilesScopeLock; FJoinedOffsetAndPakIndex LastReadRequest; uint64 NextUniqueID; int64 BlockMemory; int64 BlockMemoryHighWater; struct FCacheBlock { FJoinedOffsetAndPakIndex OffsetAndPakIndex; int64 Size; uint8 *Memory; uint32 InRequestRefCount; TIntervalTreeIndex Index; TIntervalTreeIndex Next; EBlockStatus Status; FCacheBlock() : OffsetAndPakIndex(0) , Size(0) , Memory(nullptr) , InRequestRefCount(0) , Index(IntervalTreeInvalidIndex) , Next(IntervalTreeInvalidIndex) , Status(EBlockStatus::InFlight) { } }; struct FPakInRequest { FJoinedOffsetAndPakIndex OffsetAndPakIndex; int64 Size; IPakRequestor* Owner; uint64 UniqueID; TIntervalTreeIndex Index; TIntervalTreeIndex Next; EAsyncIOPriority Priority; EInRequestStatus Status; FPakInRequest() : OffsetAndPakIndex(0) , Size(0) , Owner(nullptr) , UniqueID(0) , Index(IntervalTreeInvalidIndex) , Next(IntervalTreeInvalidIndex) , Priority(AIOP_MIN) , Status(EInRequestStatus::Waiting) { } }; struct FPakData { IAsyncReadFileHandle* Handle; int64 TotalSize; uint64 MaxNode; uint32 StartShift; uint32 MaxShift; uint32 BytesToBitsShift; FName Name; TIntervalTreeIndex InRequests[AIOP_NUM][(int32)EInRequestStatus::Num]; TIntervalTreeIndex CacheBlocks[(int32)EBlockStatus::Num]; FPakData(IAsyncReadFileHandle* InHandle, FName InName, int64 InTotalSize) : Handle(InHandle) , TotalSize(InTotalSize) , StartShift(0) , MaxShift(0) , BytesToBitsShift(0) , Name(InName) { check(Handle && TotalSize > 0 && Name != NAME_None); for (int32 Index = 0; Index < AIOP_NUM; Index++) { for (int32 IndexInner = 0; IndexInner < (int32)EInRequestStatus::Num; IndexInner++) { InRequests[Index][IndexInner] = IntervalTreeInvalidIndex; } } for (int32 IndexInner = 0; IndexInner < (int32)EBlockStatus::Num; IndexInner++) { CacheBlocks[IndexInner] = IntervalTreeInvalidIndex; } uint64 StartingLastByte = FMath::Max((uint64)TotalSize, (uint64)PAK_CACHE_GRANULARITY); StartingLastByte--; { uint64 LastByte = StartingLastByte; while (!HighBit(LastByte)) { LastByte <<= 1; StartShift++; } } { uint64 LastByte = StartingLastByte; uint64 Block = (uint64)PAK_CACHE_GRANULARITY; while (Block) { Block >>= 1; LastByte >>= 1; BytesToBitsShift++; } BytesToBitsShift--; check(1 << BytesToBitsShift == PAK_CACHE_GRANULARITY); MaxShift = StartShift; while (LastByte) { LastByte >>= 1; MaxShift++; } MaxNode = MAX_uint64 >> StartShift; check(MaxNode >= StartingLastByte && (MaxNode >> 1) < StartingLastByte); //UE_LOG(LogTemp, Warning, TEXT("Test %d %llX %llX "), MaxShift, (uint64(PAK_CACHE_GRANULARITY) << (MaxShift + 1)), (uint64(PAK_CACHE_GRANULARITY) << MaxShift)); check(MaxShift && (uint64(PAK_CACHE_GRANULARITY) << (MaxShift + 1)) == 0 && (uint64(PAK_CACHE_GRANULARITY) << MaxShift) != 0); } } }; TMap CachedPaks; TArray CachedPakData; TIntervalTreeAllocator InRequestAllocator; TIntervalTreeAllocator CacheBlockAllocator; TMap OutstandingRequests; struct FRequestToLower { IAsyncReadRequest* RequestHandle; TIntervalTreeIndex BlockIndex; FRequestToLower() : RequestHandle(nullptr) , BlockIndex(IntervalTreeInvalidIndex) { } }; FRequestToLower RequestsToLower[PAK_CACHE_MAX_REQUESTS]; TArray RequestsToDelete; int32 NotifyRecursion; FAsyncFileCallBack CallbackFromLower; uint32 Loads; uint32 Frees; uint64 LoadSize; public: static void Init(IPlatformFile* InLowerLevel) { if (!PakPrecacherSingleton) { verify(!FPlatformAtomics::InterlockedCompareExchangePointer((void**)&PakPrecacherSingleton, new FPakPrecacher(InLowerLevel), NULL)); } check(PakPrecacherSingleton); } static FPakPrecacher& Get() { check(PakPrecacherSingleton); return *PakPrecacherSingleton; } FPakPrecacher(IPlatformFile* InLowerLevel) : LowerLevel(InLowerLevel) , LastReadRequest(0) , NextUniqueID(1) , BlockMemory(0) , BlockMemoryHighWater(0) , NotifyRecursion(0) , Loads(0) , Frees(0) , LoadSize(0) { check(LowerLevel); if (FPlatformProcess::SupportsMultithreading()) { GPakCache_MaxRequestsToLowerLevel = FMath::Max(FMath::Min(FPlatformMisc::NumberOfIOWorkerThreadsToSpawn(), GPakCache_MaxRequestsToLowerLevel), 1); } else { GPakCache_MaxRequestsToLowerLevel = 0; } check(GPakCache_MaxRequestsToLowerLevel <= PAK_CACHE_MAX_REQUESTS); CallbackFromLower = [this](bool bWasCanceled, IAsyncReadRequest* Request) { NewRequestsToLowerComplete(bWasCanceled, Request); }; } IPlatformFile* GetLowerLevelHandle() { check(LowerLevel); return LowerLevel; } int64 MaxMemPrecache() { return GPakCache_MaxPrecacheMemMB * 1024ll * 1024ll; } bool HasEnoughRoomForPrecache() { return GPakCache_MaxPrecacheMemMB == 0 || BlockMemory < MaxMemPrecache(); } private: // below here we assume CachedFilesScopeLock until we get to the next section uint16 GetRequestPakIndex(FJoinedOffsetAndPakIndex OffsetAndPakIndex) { uint16 Result = GetRequestPakIndexLow(OffsetAndPakIndex); check(Result < CachedPakData.Num()); return Result; } FJoinedOffsetAndPakIndex FirstUnfilledBlockForRequest(TIntervalTreeIndex NewIndex, FJoinedOffsetAndPakIndex ReadHead = 0) { // CachedFilesScopeLock is locked FPakInRequest& Request = InRequestAllocator.Get(NewIndex); uint16 PakIndex = GetRequestPakIndex(Request.OffsetAndPakIndex); int64 Offset = GetRequestOffset(Request.OffsetAndPakIndex); int64 Size = Request.Size; FPakData& Pak = CachedPakData[PakIndex]; check(Offset + Request.Size <= Pak.TotalSize && Size > 0 && Request.Priority >= AIOP_MIN && Request.Priority <= AIOP_MAX && Request.Status != EInRequestStatus::Complete && Request.Owner); if (PakIndex != GetRequestPakIndex(ReadHead)) { // this is in a different pak, so we ignore the read head position ReadHead = 0; } if (ReadHead) { // trim to the right of the read head int64 Trim = FMath::Max(Offset, GetRequestOffset(ReadHead)) - Offset; Offset += Trim; Size -= Trim; } static TArray InFlightOrDone; int64 FirstByte = AlignDown(Offset, PAK_CACHE_GRANULARITY); int64 LastByte = Align(Offset + Size, PAK_CACHE_GRANULARITY) - 1; uint32 NumBits = (PAK_CACHE_GRANULARITY + LastByte - FirstByte) / PAK_CACHE_GRANULARITY; uint32 NumQWords = (NumBits + 63) >> 6; InFlightOrDone.Reset(); InFlightOrDone.AddZeroed(NumQWords); if (NumBits != NumQWords * 64) { uint32 Extras = NumQWords * 64 - NumBits; InFlightOrDone[NumQWords - 1] = (MAX_uint64 << (64 - Extras)); } if (Pak.CacheBlocks[(int32)EBlockStatus::Complete] != IntervalTreeInvalidIndex) { OverlappingNodesInIntervalTreeMask( Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, Pak.BytesToBitsShift, &InFlightOrDone[0] ); } if (Request.Status == EInRequestStatus::Waiting && Pak.CacheBlocks[(int32)EBlockStatus::InFlight] != IntervalTreeInvalidIndex) { OverlappingNodesInIntervalTreeMask( Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, Pak.BytesToBitsShift, &InFlightOrDone[0] ); } for (int32 Index = 0; Index < NumQWords; Index++) { if (InFlightOrDone[Index] != MAX_uint64) { uint64 Mask = InFlightOrDone[Index]; int64 FinalOffset = FirstByte + PAK_CACHE_GRANULARITY * 64 * Index; while (Mask & 1) { FinalOffset += PAK_CACHE_GRANULARITY; Mask >>= 1; } return MakeJoinedRequest(PakIndex, FinalOffset); } } return MAX_uint64; } bool AddRequest(TIntervalTreeIndex NewIndex) { // CachedFilesScopeLock is locked FPakInRequest& Request = InRequestAllocator.Get(NewIndex); uint16 PakIndex = GetRequestPakIndex(Request.OffsetAndPakIndex); int64 Offset = GetRequestOffset(Request.OffsetAndPakIndex); FPakData& Pak = CachedPakData[PakIndex]; check(Offset + Request.Size <= Pak.TotalSize && Request.Size > 0 && Request.Priority >= AIOP_MIN && Request.Priority <= AIOP_MAX && Request.Status == EInRequestStatus::Waiting && Request.Owner); static TArray InFlightOrDone; int64 FirstByte = AlignDown(Offset, PAK_CACHE_GRANULARITY); int64 LastByte = Align(Offset + Request.Size, PAK_CACHE_GRANULARITY) - 1; uint32 NumBits = (PAK_CACHE_GRANULARITY + LastByte - FirstByte) / PAK_CACHE_GRANULARITY; uint32 NumQWords = (NumBits + 63) >> 6; InFlightOrDone.Reset(); InFlightOrDone.AddZeroed(NumQWords); if (NumBits != NumQWords * 64) { uint32 Extras = NumQWords * 64 - NumBits; InFlightOrDone[NumQWords - 1] = (MAX_uint64 << (64 - Extras)); } if (Pak.CacheBlocks[(int32)EBlockStatus::Complete] != IntervalTreeInvalidIndex) { Request.Status = EInRequestStatus::Complete; OverlappingNodesInIntervalTree( Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Pak, FirstByte, LastByte](TIntervalTreeIndex Index) -> bool { CacheBlockAllocator.Get(Index).InRequestRefCount++; MaskInterval(Index, CacheBlockAllocator, FirstByte, LastByte, Pak.BytesToBitsShift, &InFlightOrDone[0]); return true; } ); for (int32 Index = 0; Index < NumQWords; Index++) { if (InFlightOrDone[Index] != MAX_uint64) { Request.Status = EInRequestStatus::Waiting; break; } } } if (Request.Status == EInRequestStatus::Waiting) { if (Pak.CacheBlocks[(int32)EBlockStatus::InFlight] != IntervalTreeInvalidIndex) { Request.Status = EInRequestStatus::InFlight; OverlappingNodesInIntervalTree( Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Pak, FirstByte, LastByte](TIntervalTreeIndex Index) -> bool { CacheBlockAllocator.Get(Index).InRequestRefCount++; MaskInterval(Index, CacheBlockAllocator, FirstByte, LastByte, Pak.BytesToBitsShift, &InFlightOrDone[0]); return true; } ); for (int32 Index = 0; Index < NumQWords; Index++) { if (InFlightOrDone[Index] != MAX_uint64) { Request.Status = EInRequestStatus::Waiting; break; } } } } else { #if DO_CHECK OverlappingNodesInIntervalTree( Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Pak, FirstByte, LastByte](TIntervalTreeIndex Index) -> bool { check(0); // if we are complete, then how come there are overlapping in flight blocks? return true; } ); #endif } { AddToIntervalTree( &Pak.InRequests[Request.Priority][(int32)Request.Status], InRequestAllocator, NewIndex, Pak.StartShift, Pak.MaxShift ); } check(&Request == &InRequestAllocator.Get(NewIndex)); if (Request.Status == EInRequestStatus::Complete) { NotifyComplete(NewIndex); return true; } else if (Request.Status == EInRequestStatus::Waiting) { StartNextRequest(); } return false; } void ClearBlock(FCacheBlock &Block) { #if 0 if (GetRequestPakIndex(Block.OffsetAndPakIndex) == 1 && GetRequestOffset(Block.OffsetAndPakIndex) <= 0x22f573d3ll && GetRequestOffset(Block.OffsetAndPakIndex) + Block.Size >= 0x22f573d3ll) { UE_LOG(LogTemp, Error, TEXT("Hi")); } #endif if (Block.Memory) { BlockMemory -= Block.Size; DEC_MEMORY_STAT_BY(STAT_PakCacheMem, Block.Size); FMemory::Free(Block.Memory); Block.Memory = nullptr; } Block.Next = IntervalTreeInvalidIndex; CacheBlockAllocator.Free(Block.Index); } void ClearRequest(FPakInRequest& DoneRequest) { uint64 Id = DoneRequest.UniqueID; TIntervalTreeIndex Index = DoneRequest.Index; DoneRequest.OffsetAndPakIndex = 0; DoneRequest.Size = 0; DoneRequest.Owner = nullptr; DoneRequest.UniqueID = 0; DoneRequest.Index = IntervalTreeInvalidIndex; DoneRequest.Next = IntervalTreeInvalidIndex; DoneRequest.Priority = AIOP_MIN; DoneRequest.Status = EInRequestStatus::Num; verify(OutstandingRequests.Remove(Id) == 1); InRequestAllocator.Free(Index); } void RemoveRequest(TIntervalTreeIndex Index) { // CachedFilesScopeLock is locked FPakInRequest& Request = InRequestAllocator.Get(Index); uint16 PakIndex = GetRequestPakIndex(Request.OffsetAndPakIndex); int64 Offset = GetRequestOffset(Request.OffsetAndPakIndex); int64 Size = Request.Size; FPakData& Pak = CachedPakData[PakIndex]; check(Offset + Request.Size <= Pak.TotalSize && Request.Size > 0 && Request.Priority >= AIOP_MIN && Request.Priority <= AIOP_MAX && int32(Request.Status) >= 0 && int32(Request.Status) < int32(EInRequestStatus::Num)); if (RemoveFromIntervalTree(&Pak.InRequests[Request.Priority][(int32)Request.Status], InRequestAllocator, Index, Pak.StartShift, Pak.MaxShift)) { MaybeRemoveOverlappingNodesInIntervalTree( &Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, Offset, Offset + Size - 1, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this](TIntervalTreeIndex BlockIndex) -> bool { FCacheBlock &Block = CacheBlockAllocator.Get(BlockIndex); check(Block.InRequestRefCount); if (!--Block.InRequestRefCount) { ClearBlock(Block); return true; } return false; } ); OverlappingNodesInIntervalTree( Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, Offset, Offset + Size - 1, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this](TIntervalTreeIndex BlockIndex) -> bool { FCacheBlock &Block = CacheBlockAllocator.Get(BlockIndex); check(Block.InRequestRefCount); Block.InRequestRefCount--; return true; } ); } else { check(0); // not found } ClearRequest(Request); } void NotifyComplete(TIntervalTreeIndex RequestIndex) { // CachedFilesScopeLock is locked FPakInRequest& Request = InRequestAllocator.Get(RequestIndex); uint16 PakIndex = GetRequestPakIndex(Request.OffsetAndPakIndex); int64 Offset = GetRequestOffset(Request.OffsetAndPakIndex); FPakData& Pak = CachedPakData[PakIndex]; check(Offset + Request.Size <= Pak.TotalSize && Request.Size > 0 && Request.Priority >= AIOP_MIN && Request.Priority <= AIOP_MAX && Request.Status == EInRequestStatus::Complete); check(Request.Owner && Request.UniqueID); if (Request.Status == EInRequestStatus::Complete && Request.UniqueID == Request.Owner->UniqueID && RequestIndex == Request.Owner->InRequestIndex && Request.OffsetAndPakIndex == Request.Owner->OffsetAndPakIndex) { UE_LOG(LogPakFile, Verbose, TEXT("FPakReadRequest[%016llX, %016llX) Notify complete"), Request.OffsetAndPakIndex, Request.OffsetAndPakIndex + Request.Size); Request.Owner->RequestIsComplete(); return; } else { check(0); // request should have been found } } FJoinedOffsetAndPakIndex GetNextBlock(EAsyncIOPriority& OutPriority) { bool bAcceptingPrecacheRequests = HasEnoughRoomForPrecache(); // CachedFilesScopeLock is locked uint16 BestPakIndex = 0; FJoinedOffsetAndPakIndex BestNext = MAX_uint64; OutPriority = AIOP_MIN; for (EAsyncIOPriority Priority = AIOP_MAX;; Priority = EAsyncIOPriority(int32(Priority) - 1)) { if (Priority == AIOP_Precache && !bAcceptingPrecacheRequests) { break; } for (int32 Pass = 0; ; Pass++) { FJoinedOffsetAndPakIndex LocalLastReadRequest = Pass ? 0 : LastReadRequest; uint16 PakIndex = GetRequestPakIndex(LocalLastReadRequest); int64 Offset = GetRequestOffset(LocalLastReadRequest); check(Offset <= CachedPakData[PakIndex].TotalSize); for (; BestNext == MAX_uint64 && PakIndex < CachedPakData.Num(); PakIndex++) { FPakData& Pak = CachedPakData[PakIndex]; if (Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting] != IntervalTreeInvalidIndex) { uint64 Limit = uint64(Pak.TotalSize - 1); if (BestNext != MAX_uint64 && GetRequestPakIndex(BestNext) == PakIndex) { Limit = GetRequestOffset(BestNext) - 1; } OverlappingNodesInIntervalTreeWithShrinkingInterval( Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting], InRequestAllocator, uint64(Offset), Limit, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Pak, &BestNext, &BestPakIndex, PakIndex, &Limit, LocalLastReadRequest](TIntervalTreeIndex Index) -> bool { FJoinedOffsetAndPakIndex First = FirstUnfilledBlockForRequest(Index, LocalLastReadRequest); check(LocalLastReadRequest != 0 || First != MAX_uint64); // if there was not trimming, and this thing is in the waiting list, then why was no start block found? if (First < BestNext) { BestNext = First; BestPakIndex = PakIndex; Limit = GetRequestOffset(BestNext) - 1; } return true; // always have to keep going because we want the smallest one } ); } } if (!LocalLastReadRequest) { break; // this was a full pass } } if (Priority == AIOP_MIN || BestNext != MAX_uint64) { OutPriority = Priority; break; } } return BestNext; } bool AddNewBlock() { // CachedFilesScopeLock is locked EAsyncIOPriority RequestPriority; FJoinedOffsetAndPakIndex BestNext = GetNextBlock(RequestPriority); if (BestNext == MAX_uint64) { return false; } uint16 PakIndex = GetRequestPakIndex(BestNext); int64 Offset = GetRequestOffset(BestNext); FPakData& Pak = CachedPakData[PakIndex]; check(Offset < Pak.TotalSize); int64 FirstByte = AlignDown(Offset, PAK_CACHE_GRANULARITY); int64 LastByte = FMath::Min(Align(FirstByte + PAK_CACHE_MAX_REQUEST, PAK_CACHE_GRANULARITY) - 1, Pak.TotalSize - 1); check(FirstByte >= 0 && LastByte < Pak.TotalSize && LastByte >= 0 && LastByte >= FirstByte); uint32 NumBits = (PAK_CACHE_GRANULARITY + LastByte - FirstByte) / PAK_CACHE_GRANULARITY; uint32 NumQWords = (NumBits + 63) >> 6; static TArray InFlightOrDone; InFlightOrDone.Reset(); InFlightOrDone.AddZeroed(NumQWords); if (NumBits != NumQWords * 64) { uint32 Extras = NumQWords * 64 - NumBits; InFlightOrDone[NumQWords - 1] = (MAX_uint64 << (64 - Extras)); } if (Pak.CacheBlocks[(int32)EBlockStatus::Complete] != IntervalTreeInvalidIndex) { OverlappingNodesInIntervalTreeMask( Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, Pak.BytesToBitsShift, &InFlightOrDone[0] ); } if (Pak.CacheBlocks[(int32)EBlockStatus::InFlight] != IntervalTreeInvalidIndex) { OverlappingNodesInIntervalTreeMask( Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, Pak.BytesToBitsShift, &InFlightOrDone[0] ); } static TArray Requested; Requested.Reset(); Requested.AddZeroed(NumQWords); for (EAsyncIOPriority Priority = AIOP_MAX;; Priority = EAsyncIOPriority(int32(Priority) - 1)) { if (Priority + PAK_CACHE_MAX_PRIORITY_DIFFERENCE_MERGE < RequestPriority) { break; } if (Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting] != IntervalTreeInvalidIndex) { OverlappingNodesInIntervalTreeMask( Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting], InRequestAllocator, FirstByte, LastByte, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, Pak.BytesToBitsShift, &Requested[0] ); } if (Priority == AIOP_MIN) { break; } } int64 Size = PAK_CACHE_GRANULARITY * 64 * NumQWords; for (int32 Index = 0; Index < NumQWords; Index++) { uint64 NotAlreadyInFlightAndRequested = ((~InFlightOrDone[Index]) & Requested[Index]); if (NotAlreadyInFlightAndRequested != MAX_uint64) { Size = PAK_CACHE_GRANULARITY * 64 * Index; while (NotAlreadyInFlightAndRequested & 1) { Size += PAK_CACHE_GRANULARITY; NotAlreadyInFlightAndRequested >>= 1; } break; } } check(Size > 0 && Size <= PAK_CACHE_MAX_REQUEST); Size = FMath::Min(FirstByte + Size, LastByte + 1) - FirstByte; TIntervalTreeIndex NewIndex = CacheBlockAllocator.Alloc(); FCacheBlock& Block = CacheBlockAllocator.Get(NewIndex); Block.Index = NewIndex; Block.InRequestRefCount = 0; Block.Memory = nullptr; Block.OffsetAndPakIndex = MakeJoinedRequest(PakIndex, FirstByte); Block.Size = Size; Block.Status = EBlockStatus::InFlight; AddToIntervalTree( &Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, NewIndex, Pak.StartShift, Pak.MaxShift ); TArray Inflights; for (EAsyncIOPriority Priority = AIOP_MAX;; Priority = EAsyncIOPriority(int32(Priority) - 1)) { if (Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting] != IntervalTreeInvalidIndex) { MaybeRemoveOverlappingNodesInIntervalTree( &Pak.InRequests[Priority][(int32)EInRequestStatus::Waiting], InRequestAllocator, uint64(FirstByte), uint64(FirstByte + Size - 1), 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Block, &Inflights](TIntervalTreeIndex RequestIndex) -> bool { Block.InRequestRefCount++; if (FirstUnfilledBlockForRequest(RequestIndex) == MAX_uint64) { InRequestAllocator.Get(RequestIndex).Next = IntervalTreeInvalidIndex; Inflights.Add(RequestIndex); return true; } return false; } ); } #if DO_CHECK OverlappingNodesInIntervalTree( Pak.InRequests[Priority][(int32)EInRequestStatus::InFlight], InRequestAllocator, uint64(FirstByte), uint64(FirstByte + Size - 1), 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [](TIntervalTreeIndex) -> bool { check(0); // if this is in flight, then why does it overlap my new block return false; } ); OverlappingNodesInIntervalTree( Pak.InRequests[Priority][(int32)EInRequestStatus::Complete], InRequestAllocator, uint64(FirstByte), uint64(FirstByte + Size - 1), 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [](TIntervalTreeIndex) -> bool { check(0); // if this is complete, then why does it overlap my new block return false; } ); #endif if (Priority == AIOP_MIN) { break; } } for (TIntervalTreeIndex Fli : Inflights) { FPakInRequest& CompReq = InRequestAllocator.Get(Fli); CompReq.Status = EInRequestStatus::InFlight; AddToIntervalTree(&Pak.InRequests[CompReq.Priority][(int32)EInRequestStatus::InFlight], InRequestAllocator, Fli, Pak.StartShift, Pak.MaxShift); } StartBlockTask(Block); return true; } int32 OpenTaskSlot() { int32 IndexToFill = -1; for (int32 Index = 0; Index < GPakCache_MaxRequestsToLowerLevel; Index++) { if (!RequestsToLower[Index].RequestHandle) { IndexToFill = Index; break; } } return IndexToFill; } bool HasRequestsAtStatus(EInRequestStatus Status) { for (uint16 PakIndex = 0; PakIndex < CachedPakData.Num(); PakIndex++) { FPakData& Pak = CachedPakData[PakIndex]; for (EAsyncIOPriority Priority = AIOP_MAX;; Priority = EAsyncIOPriority(int32(Priority) - 1)) { if (Pak.InRequests[Priority][(int32)Status] != IntervalTreeInvalidIndex) { return true; } if (Priority == AIOP_MIN) { break; } } } return false; } bool CanStartAnotherTask() { if (OpenTaskSlot() < 0) { return false; } return HasRequestsAtStatus(EInRequestStatus::Waiting); } void ClearOldBlockTasks() { if (!NotifyRecursion) { for (IAsyncReadRequest* Elem : RequestsToDelete) { Elem->WaitCompletion(); delete Elem; } RequestsToDelete.Empty(); } } void StartBlockTask(FCacheBlock& Block) { // CachedFilesScopeLock is locked int32 IndexToFill = OpenTaskSlot(); if (IndexToFill < 0) { check(0); return; } EAsyncIOPriority Priority = AIOP_Normal; // the lower level requests are not prioritized at the moment check(Block.Status == EBlockStatus::InFlight); UE_LOG(LogPakFile, Verbose, TEXT("FPakReadRequest[%016llX, %016llX) StartBlockTask"), Block.OffsetAndPakIndex, Block.OffsetAndPakIndex + Block.Size); uint16 PakIndex = GetRequestPakIndex(Block.OffsetAndPakIndex); FPakData& Pak = CachedPakData[PakIndex]; RequestsToLower[IndexToFill].BlockIndex = Block.Index; check(&CacheBlockAllocator.Get(RequestsToLower[IndexToFill].BlockIndex) == &Block); RequestsToLower[IndexToFill].RequestHandle = Pak.Handle->ReadRequest(GetRequestOffset(Block.OffsetAndPakIndex), Block.Size, Priority, &CallbackFromLower); LastReadRequest = Block.OffsetAndPakIndex + Block.Size; Loads++; LoadSize += Block.Size; } void CompleteRequest(bool bWasCanceled, IAsyncReadRequest* Request, TIntervalTreeIndex BlockIndex) { FCacheBlock& Block = CacheBlockAllocator.Get(BlockIndex); uint16 PakIndex = GetRequestPakIndex(Block.OffsetAndPakIndex); int64 Offset = GetRequestOffset(Block.OffsetAndPakIndex); FPakData& Pak = CachedPakData[PakIndex]; check(!Block.Memory && Block.Size); check(!bWasCanceled); // this is doable, but we need to transition requests back to waiting, inflight etc. if (!RemoveFromIntervalTree(&Pak.CacheBlocks[(int32)EBlockStatus::InFlight], CacheBlockAllocator, Block.Index, Pak.StartShift, Pak.MaxShift)) { check(0); } if (Block.InRequestRefCount == 0 || bWasCanceled) { ClearBlock(Block); } else { Block.Memory = Request->GetReadResults(); BlockMemory += Block.Size; INC_MEMORY_STAT_BY(STAT_PakCacheMem, Block.Size); if (BlockMemory > BlockMemoryHighWater) { BlockMemoryHighWater = BlockMemory; static int64 LastPrint = 0; if (BlockMemoryHighWater / 1024 / 1024 != LastPrint) { LastPrint = BlockMemoryHighWater / 1024 / 1024; FPlatformMisc::LowLevelOutputDebugStringf(TEXT("Precache HighWater %dMB\r\n"), int32(LastPrint)); } } Block.Status = EBlockStatus::Complete; AddToIntervalTree( &Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, Block.Index, Pak.StartShift, Pak.MaxShift ); TArray Completeds; for (EAsyncIOPriority Priority = AIOP_MAX;; Priority = EAsyncIOPriority(int32(Priority) - 1)) { if (Pak.InRequests[Priority][(int32)EInRequestStatus::InFlight] != IntervalTreeInvalidIndex) { MaybeRemoveOverlappingNodesInIntervalTree( &Pak.InRequests[Priority][(int32)EInRequestStatus::InFlight], InRequestAllocator, uint64(Offset), uint64(Offset + Block.Size - 1), 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, &Completeds](TIntervalTreeIndex RequestIndex) -> bool { if (FirstUnfilledBlockForRequest(RequestIndex) == MAX_uint64) { InRequestAllocator.Get(RequestIndex).Next = IntervalTreeInvalidIndex; Completeds.Add(RequestIndex); return true; } return false; } ); } if (Priority == AIOP_MIN) { break; } } for (TIntervalTreeIndex Comp : Completeds) { FPakInRequest& CompReq = InRequestAllocator.Get(Comp); CompReq.Status = EInRequestStatus::Complete; AddToIntervalTree(&Pak.InRequests[CompReq.Priority][(int32)EInRequestStatus::Complete], InRequestAllocator, Comp, Pak.StartShift, Pak.MaxShift); NotifyComplete(Comp); // potentially scary recursion here } } } bool StartNextRequest() { if (CanStartAnotherTask()) { return AddNewBlock(); } return false; } uint8* GetCompletedRequestData(FPakInRequest& DoneRequest) { // CachedFilesScopeLock is locked check(DoneRequest.Status == EInRequestStatus::Complete); uint16 PakIndex = GetRequestPakIndex(DoneRequest.OffsetAndPakIndex); int64 Offset = GetRequestOffset(DoneRequest.OffsetAndPakIndex); int64 Size = DoneRequest.Size; FPakData& Pak = CachedPakData[PakIndex]; check(Offset + DoneRequest.Size <= Pak.TotalSize && DoneRequest.Size > 0 && DoneRequest.Priority >= AIOP_MIN && DoneRequest.Priority <= AIOP_MAX && DoneRequest.Status == EInRequestStatus::Complete); uint8* Result = (uint8*)FMemory::Malloc(Size); int64 BytesCopied = 0; #if 0 // this path removes the block in one pass, however, this is not what we want because it wrecks precaching, if we change back GetCompletedRequest needs to maybe start a new request and the logic of the IAsyncFile read needs to change MaybeRemoveOverlappingNodesInIntervalTree( &Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, Offset, Offset + Size - 1, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, Offset, Size, &BytesCopied, Result, &Pak](TIntervalTreeIndex BlockIndex) -> bool { FCacheBlock &Block = CacheBlockAllocator.Get(BlockIndex); int64 BlockOffset = GetRequestOffset(Block.OffsetAndPakIndex); check(Block.Memory && Block.Size && BlockOffset >= 0 && BlockOffset + Block.Size <= Pak.TotalSize); int64 OverlapStart = FMath::Max(Offset, BlockOffset); int64 OverlapEnd = FMath::Min(Offset + Size, BlockOffset + Block.Size); check(OverlapEnd > OverlapStart); BytesCopied += OverlapEnd - OverlapStart; FMemory::Memcpy(Result + OverlapStart - Offset, Block.Memory + OverlapStart - BlockOffset, OverlapEnd - OverlapStart); check(Block.InRequestRefCount); if (!--Block.InRequestRefCount) { ClearBlock(Block); return true; } return false; } ); if (!RemoveFromIntervalTree(&Pak.InRequests[DoneRequest.Priority][(int32)EInRequestStatus::Complete], InRequestAllocator, DoneRequest.Index, Pak.StartShift, Pak.MaxShift)) { check(0); // not found } ClearRequest(DoneRequest); #else OverlappingNodesInIntervalTree( Pak.CacheBlocks[(int32)EBlockStatus::Complete], CacheBlockAllocator, Offset, Offset + Size - 1, 0, Pak.MaxNode, Pak.StartShift, Pak.MaxShift, [this, Offset, Size, &BytesCopied, Result, &Pak](TIntervalTreeIndex BlockIndex) -> bool { FCacheBlock &Block = CacheBlockAllocator.Get(BlockIndex); int64 BlockOffset = GetRequestOffset(Block.OffsetAndPakIndex); check(Block.Memory && Block.Size && BlockOffset >= 0 && BlockOffset + Block.Size <= Pak.TotalSize); int64 OverlapStart = FMath::Max(Offset, BlockOffset); int64 OverlapEnd = FMath::Min(Offset + Size, BlockOffset + Block.Size); check(OverlapEnd > OverlapStart); BytesCopied += OverlapEnd - OverlapStart; FMemory::Memcpy(Result + OverlapStart - Offset, Block.Memory + OverlapStart - BlockOffset, OverlapEnd - OverlapStart); return true; } ); #endif check(BytesCopied == Size); return Result; } ///// Below here are the thread entrypoints void NewRequestsToLowerComplete(bool bWasCanceled, IAsyncReadRequest* Request) { FScopeLock Lock(&CachedFilesScopeLock); ClearOldBlockTasks(); NotifyRecursion++; for (int32 Index = 0; Index < PAK_CACHE_MAX_REQUESTS; Index++) // we loop over them all in case GPakCache_MaxRequestsToLowerLevel is changing { if (RequestsToLower[Index].RequestHandle == Request) { CompleteRequest(bWasCanceled, Request, RequestsToLower[Index].BlockIndex); RequestsToLower[Index].RequestHandle = nullptr; RequestsToDelete.Add(Request); RequestsToLower[Index].BlockIndex = IntervalTreeInvalidIndex; StartNextRequest(); NotifyRecursion--; return; } } StartNextRequest(); NotifyRecursion--; check(0); // not found? } public: bool QueueRequest(IPakRequestor* Owner, FName File, int64 PakFileSize, int64 Offset, int64 Size, EAsyncIOPriority Priority) { check(Owner && File != NAME_None && Size > 0 && Offset >= 0 && Offset < PakFileSize && Priority >= AIOP_MIN && Priority <= AIOP_MAX); FScopeLock Lock(&CachedFilesScopeLock); uint16* PakIndexPtr = CachedPaks.Find(File); if (!PakIndexPtr) { check(CachedPakData.Num() < MAX_uint16); IAsyncReadFileHandle* Handle = LowerLevel->OpenAsyncRead(*File.ToString()); if (!Handle) { return false; } CachedPakData.Add(FPakData(Handle, File, PakFileSize)); PakIndexPtr = &CachedPaks.Add(File, CachedPakData.Num() - 1); } uint16 PakIndex = *PakIndexPtr; FPakData& Pak = CachedPakData[PakIndex]; check(Pak.Name == File && Pak.TotalSize == PakFileSize); TIntervalTreeIndex RequestIndex = InRequestAllocator.Alloc(); FPakInRequest& Request = InRequestAllocator.Get(RequestIndex); FJoinedOffsetAndPakIndex RequestOffsetAndPakIndex = MakeJoinedRequest(PakIndex, Offset); Request.OffsetAndPakIndex = RequestOffsetAndPakIndex; Request.Size = Size; Request.Priority = Priority; Request.Status = EInRequestStatus::Waiting; Request.Owner = Owner; Request.UniqueID = NextUniqueID++; Request.Index = RequestIndex; check(Request.Next == IntervalTreeInvalidIndex); Owner->OffsetAndPakIndex = Request.OffsetAndPakIndex; Owner->UniqueID = Request.UniqueID; Owner->InRequestIndex = RequestIndex; check(!OutstandingRequests.Contains(Request.UniqueID)); OutstandingRequests.Add(Request.UniqueID, RequestIndex); if (AddRequest(RequestIndex)) { UE_LOG(LogPakFile, Verbose, TEXT("FPakReadRequest[%016llX, %016llX) QueueRequest HOT"), RequestOffsetAndPakIndex, RequestOffsetAndPakIndex + Request.Size); } else { UE_LOG(LogPakFile, Verbose, TEXT("FPakReadRequest[%016llX, %016llX) QueueRequest COLD"), RequestOffsetAndPakIndex, RequestOffsetAndPakIndex + Request.Size); } return true; } uint8* GetCompletedRequest(IPakRequestor* Owner) { check(Owner); FScopeLock Lock(&CachedFilesScopeLock); ClearOldBlockTasks(); TIntervalTreeIndex RequestIndex = OutstandingRequests.FindRef(Owner->UniqueID); static_assert(IntervalTreeInvalidIndex == 0, "FindRef will return 0 for something not found"); if (RequestIndex) { FPakInRequest& Request = InRequestAllocator.Get(RequestIndex); check(Owner == Request.Owner && Request.Status == EInRequestStatus::Complete && Request.UniqueID == Request.Owner->UniqueID && RequestIndex == Request.Owner->InRequestIndex && Request.OffsetAndPakIndex == Request.Owner->OffsetAndPakIndex); uint8* Result = GetCompletedRequestData(Request); return Result; } return nullptr; // canceled } void CancelRequest(IPakRequestor* Owner) { check(Owner); FScopeLock Lock(&CachedFilesScopeLock); ClearOldBlockTasks(); TIntervalTreeIndex RequestIndex = OutstandingRequests.FindRef(Owner->UniqueID); static_assert(IntervalTreeInvalidIndex == 0, "FindRef will return 0 for something not found"); if (RequestIndex) { bool bWasOver = !HasEnoughRoomForPrecache(); FPakInRequest& Request = InRequestAllocator.Get(RequestIndex); check(Owner == Request.Owner && Request.UniqueID == Request.Owner->UniqueID && RequestIndex == Request.Owner->InRequestIndex && Request.OffsetAndPakIndex == Request.Owner->OffsetAndPakIndex); RemoveRequest(RequestIndex); bool bNowOver = !HasEnoughRoomForPrecache(); if (bWasOver && !bNowOver) { StartNextRequest(); } } } bool IsProbablyIdle() // nothing to prevent new requests from being made before I return { FScopeLock Lock(&CachedFilesScopeLock); return !HasRequestsAtStatus(EInRequestStatus::Waiting) && !HasRequestsAtStatus(EInRequestStatus::InFlight); } // these are not threadsafe and should only be used for synthetic testing uint64 GetLoadSize() { return LoadSize; } uint32 GetLoads() { return Loads; } uint32 GetFrees() { return Frees; } void DumpBlocks() { while (!FPakPrecacher::Get().IsProbablyIdle()) { QUICK_SCOPE_CYCLE_COUNTER(STAT_WaitDumpBlocks); FPlatformProcess::SleepNoStats(0.001f); } FScopeLock Lock(&CachedFilesScopeLock); bool bDone = !HasRequestsAtStatus(EInRequestStatus::Waiting) && !HasRequestsAtStatus(EInRequestStatus::InFlight) && !HasRequestsAtStatus(EInRequestStatus::Complete); if (!bDone) { UE_LOG(LogPakFile, Log, TEXT("PakCache has outstanding requests with %llu total memory."), BlockMemory); } else { UE_LOG(LogPakFile, Log, TEXT("PakCache has no outstanding requests with %llu total memory."), BlockMemory); } } }; static void WaitPrecache(const TArray& Args) { uint32 Frees = FPakPrecacher::Get().GetFrees(); uint32 Loads = FPakPrecacher::Get().GetLoads(); uint64 LoadSize = FPakPrecacher::Get().GetLoadSize(); double StartTime = FPlatformTime::Seconds(); while (!FPakPrecacher::Get().IsProbablyIdle()) { check(Frees == FPakPrecacher::Get().GetFrees()); // otherwise we are discarding things, which is not what we want for this synthetic test QUICK_SCOPE_CYCLE_COUNTER(STAT_WaitPrecache); FPlatformProcess::SleepNoStats(0.001f); } Loads = FPakPrecacher::Get().GetLoads() - Loads; LoadSize = FPakPrecacher::Get().GetLoadSize() - LoadSize; float TimeSpent = FPlatformTime::Seconds() - StartTime; float LoadSizeMB = float(LoadSize) / (1024.0f * 1024.0f); float MBs = LoadSizeMB / TimeSpent; UE_LOG(LogPakFile, Log, TEXT("Loaded %4d blocks (align %4dKB) totalling %7.2fMB in %4.2fs = %6.2fMB/s"), Loads, PAK_CACHE_GRANULARITY / 1024, LoadSizeMB, TimeSpent, MBs); } static FAutoConsoleCommand WaitPrecacheCmd( TEXT("pak.WaitPrecache"), TEXT("Debug command to wait on the pak precache."), FConsoleCommandWithArgsDelegate::CreateStatic(&WaitPrecache) ); static void FlushPrecache(const TArray& Args) { } static FAutoConsoleCommand FlushPrecacheCmd( TEXT("pak.FlushPrecache"), TEXT("Does nothing (yet)."), FConsoleCommandWithArgsDelegate::CreateStatic(&FlushPrecache) ); static void DumpBlocks(const TArray& Args) { FPakPrecacher::Get().DumpBlocks(); } static FAutoConsoleCommand DumpBlocksCmd( TEXT("pak.DumpBlocks"), TEXT("Debug command to spew the outstanding blocks."), FConsoleCommandWithArgsDelegate::CreateStatic(&DumpBlocks) ); static FCriticalSection FPakReadRequestEvent; class FPakReadRequest : public IAsyncReadRequest, public IPakRequestor { int64 Offset; int64 BytesToRead; FEvent* WaitEvent; EAsyncIOPriority Priority; bool bRequestOutstanding; bool bNeedsRemoval; public: FPakReadRequest(FName InPakFile, int64 PakFileSize, FAsyncFileCallBack* CompleteCallback, int64 InOffset, int64 InBytesToRead, EAsyncIOPriority InPriority) : IAsyncReadRequest(CompleteCallback, false) , Offset(InOffset) , BytesToRead(InBytesToRead) , WaitEvent(nullptr) , Priority(InPriority) , bRequestOutstanding(true) , bNeedsRemoval(true) { check(Offset >= 0 && BytesToRead > 0); if (!FPakPrecacher::Get().QueueRequest(this, InPakFile, PakFileSize, Offset, BytesToRead, Priority)) { bRequestOutstanding = false; SetComplete(); } } virtual ~FPakReadRequest() { if (bNeedsRemoval) { FPakPrecacher::Get().CancelRequest(this); } } // IAsyncReadRequest Interface virtual void WaitCompletionImpl(float TimeLimitSeconds) override { if (bRequestOutstanding) { { FScopeLock Lock(&FPakReadRequestEvent); if (bRequestOutstanding) { check(!WaitEvent); WaitEvent = FPlatformProcess::GetSynchEventFromPool(true); } } if (WaitEvent) { if (TimeLimitSeconds == 0.0f) { WaitEvent->Wait(); check(!bRequestOutstanding); } else { WaitEvent->Wait(TimeLimitSeconds * 1000.0f); } FPlatformProcess::ReturnSynchEventToPool(WaitEvent); WaitEvent = nullptr; } } } virtual void CancelImpl() override { check(!WaitEvent); // you canceled from a different thread that you waited from FPakPrecacher::Get().CancelRequest(this); bNeedsRemoval = false; if (bRequestOutstanding) { bRequestOutstanding = false; SetComplete(); } check(!WaitEvent); // you canceled from a different thread that you waited from } // IPakRequestor Interface virtual void RequestIsComplete() override { check(bRequestOutstanding && !Memory); if (bCanceled || Priority <= AIOP_Precache) { } else { Memory = FPakPrecacher::Get().GetCompletedRequest(this); // Memory could be null here if the request was canceled } SetComplete(); FScopeLock Lock(&FPakReadRequestEvent); bRequestOutstanding = false; if (WaitEvent) { WaitEvent->Trigger(); } } }; class FPakSizeRequest : public IAsyncReadRequest { public: FPakSizeRequest(FAsyncFileCallBack* CompleteCallback, int64 InFileSize) : IAsyncReadRequest(CompleteCallback, true) { Size = InFileSize; SetComplete(); } virtual void WaitCompletionImpl(float TimeLimitSeconds) override { } virtual void CancelImpl() { } }; class FPakAsyncReadFileHandle final : public IAsyncReadFileHandle { FName PakFile; int64 PakFileSize; int64 OffsetInPak; int64 FileSize; public: FPakAsyncReadFileHandle(FName InPakFile, int64 InPakFileSize, int64 InOffsetInPak, int64 InFileSize) : PakFile(InPakFile) , PakFileSize(InPakFileSize) , OffsetInPak(InOffsetInPak) , FileSize(InFileSize) { check(PakFileSize > 0 && OffsetInPak + FileSize <= PakFileSize && OffsetInPak >= 0); } virtual IAsyncReadRequest* SizeRequest(FAsyncFileCallBack* CompleteCallback = nullptr) override { return new FPakSizeRequest(CompleteCallback, FileSize); } virtual IAsyncReadRequest* ReadRequest(int64 Offset, int64 BytesToRead, EAsyncIOPriority Priority = AIOP_Normal, FAsyncFileCallBack* CompleteCallback = nullptr) override { if (BytesToRead == MAX_int64) { BytesToRead = FileSize - Offset; } check(Offset + BytesToRead <= FileSize && Offset >= 0 && Offset + BytesToRead + OffsetInPak <= PakFileSize); return new FPakReadRequest(PakFile, PakFileSize, CompleteCallback, OffsetInPak + Offset, BytesToRead, Priority); } }; #endif #if USE_NEW_ASYNC_IO IAsyncReadFileHandle* FPakPlatformFile::OpenAsyncRead(const TCHAR* Filename) { #if USE_PAK_PRECACHE if (GPakCache_Enable > 0) { FPakFile* PakFile = NULL; const FPakEntry* FileEntry = FindFileInPakFiles(Filename, &PakFile); if (FileEntry && PakFile && PakFile->GetFilenameName() != NAME_None) { int64 OffsetToFile = FileEntry->Offset + FileEntry->GetSerializedSize(PakFile->GetInfo().Version); UE_LOG(LogPakFile, Verbose, TEXT("FPakPlatformFile::OpenAsyncRead[%016llX, %016llX) %s"), OffsetToFile, OffsetToFile + FileEntry->UncompressedSize, Filename); return new FPakAsyncReadFileHandle(PakFile->GetFilenameName(), PakFile->TotalSize(), OffsetToFile, FileEntry->UncompressedSize); } } #endif return IPlatformFile::OpenAsyncRead(Filename); } #endif // USE_NEW_ASYNC_IO /** * Class to handle correctly reading from a compressed file within a compressed package */ class FPakSimpleEncryption { public: enum { Alignment = FAES::AESBlockSize, }; static FORCEINLINE int64 AlignReadRequest(int64 Size) { return Align(Size, Alignment); } static FORCEINLINE void DecryptBlock(void* Data, int64 Size) { #ifdef AES_KEY FAES::DecryptData((uint8*)Data, Size); #endif } }; /** * Thread local class to manage working buffers for file compression */ class FCompressionScratchBuffers : public TThreadSingleton { public: FCompressionScratchBuffers() : TempBufferSize(0) , ScratchBufferSize(0) {} int64 TempBufferSize; TAutoPtr TempBuffer; int64 ScratchBufferSize; TAutoPtr ScratchBuffer; void EnsureBufferSpace(int64 CompressionBlockSize, int64 ScrachSize) { if(TempBufferSize < CompressionBlockSize) { TempBufferSize = CompressionBlockSize; TempBuffer.Reset((uint8*)FMemory::Malloc(TempBufferSize)); } if(ScratchBufferSize < ScrachSize) { ScratchBufferSize = ScrachSize; ScratchBuffer.Reset((uint8*)FMemory::Malloc(ScratchBufferSize)); } } }; /** * Class to handle correctly reading from a compressed file within a pak */ template< typename EncryptionPolicy = FPakNoEncryption > class FPakCompressedReaderPolicy { public: class FPakUncompressTask : public FNonAbandonableTask { public: uint8* UncompressedBuffer; int32 UncompressedSize; uint8* CompressedBuffer; int32 CompressedSize; ECompressionFlags Flags; void* CopyOut; int64 CopyOffset; int64 CopyLength; void DoWork() { // Decrypt and Uncompress from memory to memory. int64 EncryptionSize = EncryptionPolicy::AlignReadRequest(CompressedSize); EncryptionPolicy::DecryptBlock(CompressedBuffer, EncryptionSize); FCompression::UncompressMemory(Flags, UncompressedBuffer, UncompressedSize, CompressedBuffer, CompressedSize, false, FPlatformMisc::GetPlatformCompression()->GetCompressionBitWindow()); if (CopyOut) { FMemory::Memcpy(CopyOut, UncompressedBuffer+CopyOffset, CopyLength); } } FORCEINLINE TStatId GetStatId() const { // TODO: This is called too early in engine startup. return TStatId(); //RETURN_QUICK_DECLARE_CYCLE_STAT(FPakUncompressTask, STATGROUP_ThreadPoolAsyncTasks); } }; FPakCompressedReaderPolicy(const FPakFile& InPakFile, const FPakEntry& InPakEntry, FArchive* InPakReader) : PakFile(InPakFile) , PakEntry(InPakEntry) , PakReader(InPakReader) { } /** Pak file that own this file data */ const FPakFile& PakFile; /** Pak file entry for this file. */ const FPakEntry& PakEntry; /** Pak file archive to read the data from. */ FArchive* PakReader; FORCEINLINE int64 FileSize() const { return PakEntry.UncompressedSize; } void Serialize(int64 DesiredPosition, void* V, int64 Length) { const int32 CompressionBlockSize = PakEntry.CompressionBlockSize; uint32 CompressionBlockIndex = DesiredPosition / CompressionBlockSize; uint8* WorkingBuffers[2]; int64 DirectCopyStart = DesiredPosition % PakEntry.CompressionBlockSize; FAsyncTask UncompressTask; FCompressionScratchBuffers& ScratchSpace = FCompressionScratchBuffers::Get(); bool bStartedUncompress = false; int64 WorkingBufferRequiredSize = FCompression::CompressMemoryBound((ECompressionFlags)PakEntry.CompressionMethod,CompressionBlockSize, FPlatformMisc::GetPlatformCompression()->GetCompressionBitWindow()); WorkingBufferRequiredSize = EncryptionPolicy::AlignReadRequest(WorkingBufferRequiredSize); ScratchSpace.EnsureBufferSpace(CompressionBlockSize, WorkingBufferRequiredSize*2); WorkingBuffers[0] = ScratchSpace.ScratchBuffer; WorkingBuffers[1] = ScratchSpace.ScratchBuffer + WorkingBufferRequiredSize; while (Length > 0) { const FPakCompressedBlock& Block = PakEntry.CompressionBlocks[CompressionBlockIndex]; int64 Pos = CompressionBlockIndex * CompressionBlockSize; int64 CompressedBlockSize = Block.CompressedEnd-Block.CompressedStart; int64 UncompressedBlockSize = FMath::Min(PakEntry.UncompressedSize-Pos, PakEntry.CompressionBlockSize); int64 ReadSize = EncryptionPolicy::AlignReadRequest(CompressedBlockSize); int64 WriteSize = FMath::Min(UncompressedBlockSize - DirectCopyStart, Length); PakReader->Seek(Block.CompressedStart); PakReader->Serialize(WorkingBuffers[CompressionBlockIndex & 1],ReadSize); if (bStartedUncompress) { UncompressTask.EnsureCompletion(); bStartedUncompress = false; } FPakUncompressTask& TaskDetails = UncompressTask.GetTask(); if (DirectCopyStart == 0 && Length >= CompressionBlockSize) { // Block can be decompressed directly into output buffer TaskDetails.Flags = (ECompressionFlags)PakEntry.CompressionMethod; TaskDetails.UncompressedBuffer = (uint8*)V; TaskDetails.UncompressedSize = UncompressedBlockSize; TaskDetails.CompressedBuffer = WorkingBuffers[CompressionBlockIndex & 1]; TaskDetails.CompressedSize = CompressedBlockSize; TaskDetails.CopyOut = nullptr; } else { // Block needs to be copied from a working buffer TaskDetails.Flags = (ECompressionFlags)PakEntry.CompressionMethod; TaskDetails.UncompressedBuffer = (uint8*)ScratchSpace.TempBuffer; TaskDetails.UncompressedSize = UncompressedBlockSize; TaskDetails.CompressedBuffer = WorkingBuffers[CompressionBlockIndex & 1]; TaskDetails.CompressedSize = CompressedBlockSize; TaskDetails.CopyOut = V; TaskDetails.CopyOffset = DirectCopyStart; TaskDetails.CopyLength = WriteSize; } if (Length == WriteSize) { UncompressTask.StartSynchronousTask(); } else { UncompressTask.StartBackgroundTask(); } bStartedUncompress = true; V = (void*)((uint8*)V + WriteSize); Length -= WriteSize; DirectCopyStart = 0; ++CompressionBlockIndex; } if(bStartedUncompress) { UncompressTask.EnsureCompletion(); } } }; bool FPakEntry::VerifyPakEntriesMatch(const FPakEntry& FileEntryA, const FPakEntry& FileEntryB) { bool bResult = true; if (FileEntryA.Size != FileEntryB.Size) { UE_LOG(LogPakFile, Error, TEXT("Pak header file size mismatch, got: %lld, expected: %lld"), FileEntryB.Size, FileEntryA.Size); bResult = false; } if (FileEntryA.UncompressedSize != FileEntryB.UncompressedSize) { UE_LOG(LogPakFile, Error, TEXT("Pak header uncompressed file size mismatch, got: %lld, expected: %lld"), FileEntryB.UncompressedSize, FileEntryA.UncompressedSize); bResult = false; } if (FileEntryA.CompressionMethod != FileEntryB.CompressionMethod) { UE_LOG(LogPakFile, Error, TEXT("Pak header file compression method mismatch, got: %d, expected: %d"), FileEntryB.CompressionMethod, FileEntryA.CompressionMethod); bResult = false; } if (FMemory::Memcmp(FileEntryA.Hash, FileEntryB.Hash, sizeof(FileEntryA.Hash)) != 0) { UE_LOG(LogPakFile, Error, TEXT("Pak file hash does not match its index entry")); bResult = false; } return bResult; } bool FPakPlatformFile::IsNonPakFilenameAllowed(const FString& InFilename) { FFilenameSecurityDelegate& FilenameSecurityDelegate = GetFilenameSecurityDelegate(); if (!FilenameSecurityDelegate.IsBound()) { return true; } if (GetLowerLevel()->FileExists(*InFilename)) { return FilenameSecurityDelegate.Execute(*InFilename); } else { return false; } } FPakFile::FPakFile(const TCHAR* Filename, bool bIsSigned) : PakFilename(Filename) , PakFilenameName(Filename) , CachedTotalSize(0) , bSigned(bIsSigned) , bIsValid(false) { FArchive* Reader = GetSharedReader(NULL); if (Reader) { Timestamp = IFileManager::Get().GetTimeStamp(Filename); Initialize(Reader); } } FPakFile::FPakFile(IPlatformFile* LowerLevel, const TCHAR* Filename, bool bIsSigned) : PakFilename(Filename) , PakFilenameName(Filename) , CachedTotalSize(0) , bSigned(bIsSigned) , bIsValid(false) { FArchive* Reader = GetSharedReader(LowerLevel); if (Reader) { Timestamp = LowerLevel->GetTimeStamp(Filename); Initialize(Reader); } } FPakFile::FPakFile(FArchive* Archive) : bSigned(false) , bIsValid(false) { Initialize(Archive); } FPakFile::~FPakFile() { } FArchive* FPakFile::CreatePakReader(const TCHAR* Filename) { FArchive* ReaderArchive = IFileManager::Get().CreateFileReader(Filename); return SetupSignedPakReader(ReaderArchive, Filename); } FArchive* FPakFile::CreatePakReader(IFileHandle& InHandle, const TCHAR* Filename) { FArchive* ReaderArchive = new FArchiveFileReaderGeneric(&InHandle, Filename, InHandle.Size()); return SetupSignedPakReader(ReaderArchive, Filename); } FArchive* FPakFile::SetupSignedPakReader(FArchive* ReaderArchive, const TCHAR* Filename) { if (FPlatformProperties::RequiresCookedData()) { #if !USING_SIGNED_CONTENT if (bSigned || FParse::Param(FCommandLine::Get(), TEXT("signedpak")) || FParse::Param(FCommandLine::Get(), TEXT("signed"))) #endif { if (!Decryptor.IsValid()) { Decryptor = new FChunkCacheWorker(ReaderArchive, Filename); } ReaderArchive = new FSignedArchiveReader(ReaderArchive, Decryptor); } } return ReaderArchive; } void FPakFile::Initialize(FArchive* Reader) { CachedTotalSize = Reader->TotalSize(); if (CachedTotalSize < Info.GetSerializedSize()) { UE_LOG(LogPakFile, Fatal, TEXT("Corrupted pak file (too short). Verify your installation.")); } else { // Serialize trailer and check if everything is as expected. Reader->Seek(CachedTotalSize - Info.GetSerializedSize()); Info.Serialize(*Reader); UE_CLOG(Info.Magic != FPakInfo::PakFile_Magic, LogPakFile, Fatal, TEXT("Trailing magic number (%ud) is different than the expected one. Verify your installation."), Info.Magic); UE_CLOG(!(Info.Version >= FPakInfo::PakFile_Version_Initial && Info.Version <= FPakInfo::PakFile_Version_Latest), LogPakFile, Fatal, TEXT("Invalid pak file version (%d). Verify your installation."), Info.Version); LoadIndex(Reader); // LoadIndex should crash in case of an error, so just assume everything is ok if we got here. bIsValid = true; if (FParse::Param(FCommandLine::Get(), TEXT("checkpak"))) { ensure(Check()); } } } void FPakFile::LoadIndex(FArchive* Reader) { if (CachedTotalSize < (Info.IndexOffset + Info.IndexSize)) { UE_LOG(LogPakFile, Fatal, TEXT("Corrupted index offset in pak file.")); } else { // Load index into memory first. Reader->Seek(Info.IndexOffset); TArray IndexData; IndexData.AddUninitialized(Info.IndexSize); Reader->Serialize(IndexData.GetData(), Info.IndexSize); FMemoryReader IndexReader(IndexData); // Check SHA1 value. uint8 IndexHash[20]; FSHA1::HashBuffer(IndexData.GetData(), IndexData.Num(), IndexHash); if (FMemory::Memcmp(IndexHash, Info.IndexHash, sizeof(IndexHash)) != 0) { UE_LOG(LogPakFile, Fatal, TEXT("Corrupted index in pak file (CRC mismatch).")); } // Read the default mount point and all entries. int32 NumEntries = 0; IndexReader << MountPoint; IndexReader << NumEntries; MakeDirectoryFromPath(MountPoint); // Allocate enough memory to hold all entries (and not reallocate while they're being added to it). Files.Empty(NumEntries); for (int32 EntryIndex = 0; EntryIndex < NumEntries; EntryIndex++) { // Serialize from memory. FPakEntry Entry; FString Filename; IndexReader << Filename; Entry.Serialize(IndexReader, Info.Version); // Add new file info. Files.Add(Entry); // Construct Index of all directories in pak file. FString Path = FPaths::GetPath(Filename); MakeDirectoryFromPath(Path); FPakDirectory* Directory = Index.Find(Path); if (Directory != NULL) { Directory->Add(Filename, &Files.Last()); } else { FPakDirectory NewDirectory; NewDirectory.Add(Filename, &Files.Last()); Index.Add(Path, NewDirectory); // add the parent directories up to the mount point while (MountPoint != Path) { Path = Path.Left(Path.Len()-1); int32 Offset = 0; if (Path.FindLastChar('/', Offset)) { Path = Path.Left(Offset); MakeDirectoryFromPath(Path); if (Index.Find(Path) == NULL) { FPakDirectory ParentDirectory; Index.Add(Path, ParentDirectory); } } else { Path = MountPoint; } } } } } } bool FPakFile::Check() { UE_LOG(LogPakFile, Display, TEXT("Checking pak file \"%s\". This may take a while..."), *PakFilename); FArchive& PakReader = *GetSharedReader(NULL); int32 ErrorCount = 0; int32 FileCount = 0; for (FPakFile::FFileIterator It(*this); It; ++It, ++FileCount) { const FPakEntry& Entry = It.Info(); void* FileContents = FMemory::Malloc(Entry.Size); PakReader.Seek(Entry.Offset); uint32 SerializedCrcTest = 0; FPakEntry EntryInfo; EntryInfo.Serialize(PakReader, GetInfo().Version); if (EntryInfo != Entry) { UE_LOG(LogPakFile, Error, TEXT("Serialized hash mismatch for \"%s\"."), *It.Filename()); ErrorCount++; } PakReader.Serialize(FileContents, Entry.Size); uint8 TestHash[20]; FSHA1::HashBuffer(FileContents, Entry.Size, TestHash); if (FMemory::Memcmp(TestHash, Entry.Hash, sizeof(TestHash)) != 0) { UE_LOG(LogPakFile, Error, TEXT("Hash mismatch for \"%s\"."), *It.Filename()); ErrorCount++; } else { UE_LOG(LogPakFile, Display, TEXT("\"%s\" OK."), *It.Filename()); } FMemory::Free(FileContents); } if (ErrorCount == 0) { UE_LOG(LogPakFile, Display, TEXT("Pak file \"%s\" healthy, %d files checked."), *PakFilename, FileCount); } else { UE_LOG(LogPakFile, Display, TEXT("Pak file \"%s\" corrupted (%d errors ouf of %d files checked.)."), *PakFilename, ErrorCount, FileCount); } return ErrorCount == 0; } FArchive* FPakFile::GetSharedReader(IPlatformFile* LowerLevel) { uint32 Thread = FPlatformTLS::GetCurrentThreadId(); FArchive* PakReader = NULL; { FScopeLock ScopedLock(&CriticalSection); TAutoPtr* ExistingReader = ReaderMap.Find(Thread); if (ExistingReader) { PakReader = *ExistingReader; } } if (!PakReader) { // Create a new FArchive reader and pass it to the new handle. if (LowerLevel != NULL) { IFileHandle* PakHandle = LowerLevel->OpenRead(*GetFilename()); if (PakHandle) { PakReader = CreatePakReader(*PakHandle, *GetFilename()); } } else { PakReader = CreatePakReader(*GetFilename()); } if (!PakReader) { UE_LOG(LogPakFile, Fatal, TEXT("Unable to create pak \"%s\" handle"), *GetFilename()); } { FScopeLock ScopedLock(&CriticalSection); ReaderMap.Emplace(Thread, PakReader); } } return PakReader; } #if !UE_BUILD_SHIPPING class FPakExec : private FSelfRegisteringExec { FPakPlatformFile& PlatformFile; public: FPakExec(FPakPlatformFile& InPlatformFile) : PlatformFile(InPlatformFile) {} /** Console commands **/ virtual bool Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar ) override { if (FParse::Command(&Cmd, TEXT("Mount"))) { PlatformFile.HandleMountCommand(Cmd, Ar); return true; } if (FParse::Command(&Cmd, TEXT("Unmount"))) { PlatformFile.HandleUnmountCommand(Cmd, Ar); return true; } else if (FParse::Command(&Cmd, TEXT("PakList"))) { PlatformFile.HandlePakListCommand(Cmd, Ar); return true; } return false; } }; static TAutoPtr GPakExec; void FPakPlatformFile::HandleMountCommand(const TCHAR* Cmd, FOutputDevice& Ar) { const FString PakFilename = FParse::Token(Cmd, false); if (!PakFilename.IsEmpty()) { const FString MountPoint = FParse::Token(Cmd, false); Mount(*PakFilename, 0, MountPoint.IsEmpty() ? NULL : *MountPoint); } } void FPakPlatformFile::HandleUnmountCommand(const TCHAR* Cmd, FOutputDevice& Ar) { const FString PakFilename = FParse::Token(Cmd, false); if (!PakFilename.IsEmpty()) { Unmount(*PakFilename); } } void FPakPlatformFile::HandlePakListCommand(const TCHAR* Cmd, FOutputDevice& Ar) { TArray Paks; GetMountedPaks(Paks); for (auto Pak : Paks) { Ar.Logf(TEXT("%s"), *Pak.PakFile->GetFilename()); } } #endif // !UE_BUILD_SHIPPING FPakPlatformFile::FPakPlatformFile() : LowerLevel(NULL) , bSigned(false) { } FPakPlatformFile::~FPakPlatformFile() { FCoreDelegates::OnMountPak.Unbind(); FCoreDelegates::OnUnmountPak.Unbind(); // We need to flush async IO... if it hasn't been shut down already. if (FIOSystem::HasShutdown() == false) { FIOSystem& IOSystem = FIOSystem::Get(); IOSystem.BlockTillAllRequestsFinishedAndFlushHandles(); } { FScopeLock ScopedLock(&PakListCritical); for (int32 PakFileIndex = 0; PakFileIndex < PakFiles.Num(); PakFileIndex++) { delete PakFiles[PakFileIndex].PakFile; PakFiles[PakFileIndex].PakFile = nullptr; } } } void FPakPlatformFile::FindPakFilesInDirectory(IPlatformFile* LowLevelFile, const TCHAR* Directory, TArray& OutPakFiles) { // Helper class to find all pak files. class FPakSearchVisitor : public IPlatformFile::FDirectoryVisitor { TArray& FoundPakFiles; IPlatformChunkInstall* ChunkInstall; public: FPakSearchVisitor(TArray& InFoundPakFiles, IPlatformChunkInstall* InChunkInstall) : FoundPakFiles(InFoundPakFiles) , ChunkInstall(InChunkInstall) {} virtual bool Visit(const TCHAR* FilenameOrDirectory, bool bIsDirectory) { if (bIsDirectory == false) { FString Filename(FilenameOrDirectory); if (FPaths::GetExtension(Filename) == TEXT("pak")) { // if a platform supports chunk style installs, make sure that the chunk a pak file resides in is actually fully installed before accepting pak files from it if (ChunkInstall) { FString ChunkIdentifier(TEXT("pakchunk")); FString BaseFilename = FPaths::GetBaseFilename(Filename); if (BaseFilename.StartsWith(ChunkIdentifier)) { int32 DelimiterIndex = 0; int32 StartOfChunkIndex = ChunkIdentifier.Len(); BaseFilename.FindChar(TEXT('-'), DelimiterIndex); FString ChunkNumberString = BaseFilename.Mid(StartOfChunkIndex, DelimiterIndex-StartOfChunkIndex); int32 ChunkNumber = 0; TTypeFromString::FromString(ChunkNumber, *ChunkNumberString); if (ChunkInstall->GetChunkLocation(ChunkNumber) == EChunkLocation::NotAvailable) { return true; } } } FoundPakFiles.Add(Filename); } } return true; } }; // Find all pak files. FPakSearchVisitor Visitor(OutPakFiles, FPlatformMisc::GetPlatformChunkInstall()); LowLevelFile->IterateDirectoryRecursively(Directory, Visitor); } void FPakPlatformFile::FindAllPakFiles(IPlatformFile* LowLevelFile, const TArray& PakFolders, TArray& OutPakFiles) { // Find pak files from the specified directories. for (int32 FolderIndex = 0; FolderIndex < PakFolders.Num(); ++FolderIndex) { FindPakFilesInDirectory(LowLevelFile, *PakFolders[FolderIndex], OutPakFiles); } } void FPakPlatformFile::GetPakFolders(const TCHAR* CmdLine, TArray& OutPakFolders) { #if !UE_BUILD_SHIPPING // Command line folders FString PakDirs; if (FParse::Value(CmdLine, TEXT("-pakdir="), PakDirs)) { TArray CmdLineFolders; PakDirs.ParseIntoArray(CmdLineFolders, TEXT("*"), true); OutPakFolders.Append(CmdLineFolders); } #endif // @todo plugin urgent: Needs to handle plugin Pak directories, too // Hardcoded locations OutPakFolders.Add(FString::Printf(TEXT("%sPaks/"), *FPaths::GameContentDir())); OutPakFolders.Add(FString::Printf(TEXT("%sPaks/"), *FPaths::GameSavedDir())); OutPakFolders.Add(FString::Printf(TEXT("%sPaks/"), *FPaths::EngineContentDir())); } bool FPakPlatformFile::CheckIfPakFilesExist(IPlatformFile* LowLevelFile, const TArray& PakFolders) { TArray FoundPakFiles; FindAllPakFiles(LowLevelFile, PakFolders, FoundPakFiles); return FoundPakFiles.Num() > 0; } bool FPakPlatformFile::ShouldBeUsed(IPlatformFile* Inner, const TCHAR* CmdLine) const { #if !USING_SIGNED_CONTENT bool Result = FParse::Param(CmdLine, TEXT("Pak")) || FParse::Param(CmdLine, TEXT("Signedpak")) || FParse::Param(CmdLine, TEXT("Signed")); if (FPlatformProperties::RequiresCookedData() && !Result && !FParse::Param(CmdLine, TEXT("NoPak"))) { TArray PakFolders; GetPakFolders(CmdLine, PakFolders); Result = CheckIfPakFilesExist(Inner, PakFolders); } return Result; #else return true; #endif } bool FPakPlatformFile::Initialize(IPlatformFile* Inner, const TCHAR* CmdLine) { // Inner is required. check(Inner != NULL); LowerLevel = Inner; #if !USING_SIGNED_CONTENT bSigned = FParse::Param(CmdLine, TEXT("Signedpak")) || FParse::Param(CmdLine, TEXT("Signed")); if (!bSigned) { // Even if -signed is not provided in the command line, use signed reader if the hardcoded key is non-zero. FEncryptionKey DecryptionKey; DecryptionKey.Exponent.Parse(DECRYPTION_KEY_EXPONENT); DecryptionKey.Modulus.Parse(DECRYPTION_KEY_MODULUS); bSigned = !DecryptionKey.Exponent.IsZero() && !DecryptionKey.Modulus.IsZero(); } #else bSigned = true; #endif bool bMountPaks = true; TArray PaksToLoad; #if !UE_BUILD_SHIPPING // Optionally get a list of pak filenames to load, only these paks will be mounted FString CmdLinePaksToLoad; if (FParse::Value(CmdLine, TEXT("-paklist="), CmdLinePaksToLoad)) { CmdLinePaksToLoad.ParseIntoArray(PaksToLoad, TEXT("+"), true); } //if we are using a fileserver, then dont' mount paks automatically. We only want to read files from the server. FString FileHostIP; const bool bCookOnTheFly = FParse::Value(FCommandLine::Get(), TEXT("filehostip"), FileHostIP); bMountPaks = !bCookOnTheFly; #endif if (bMountPaks) { // Find and mount pak files from the specified directories. TArray PakFolders; GetPakFolders(CmdLine, PakFolders); TArray FoundPakFiles; FindAllPakFiles(LowerLevel, PakFolders, FoundPakFiles); // Sort in descending order. FoundPakFiles.Sort(TGreater()); // Mount all found pak files for (int32 PakFileIndex = 0; PakFileIndex < FoundPakFiles.Num(); PakFileIndex++) { const FString& PakFilename = FoundPakFiles[PakFileIndex]; bool bLoadPak = true; if (PaksToLoad.Num() && !PaksToLoad.Contains(FPaths::GetBaseFilename(PakFilename))) { bLoadPak = false; } if (bLoadPak) { // hardcode default load ordering of game main pak -> game content -> engine content -> saved dir // would be better to make this config but not even the config system is initialized here so we can't do that uint32 PakOrder = 0; if (PakFilename.StartsWith(FString::Printf(TEXT("%sPaks/%s-"), *FPaths::GameContentDir(), FApp::GetGameName()))) { PakOrder = 4; } else if (PakFilename.StartsWith(FPaths::GameContentDir())) { PakOrder = 3; } else if (PakFilename.StartsWith(FPaths::EngineContentDir())) { PakOrder = 2; } else if (PakFilename.StartsWith(FPaths::GameSavedDir())) { PakOrder = 1; } Mount(*PakFilename, PakOrder); } } } #if !UE_BUILD_SHIPPING GPakExec = new FPakExec(*this); #endif // !UE_BUILD_SHIPPING FCoreDelegates::OnMountPak.BindRaw(this, &FPakPlatformFile::HandleMountPakDelegate); FCoreDelegates::OnUnmountPak.BindRaw(this, &FPakPlatformFile::HandleUnmountPakDelegate); #if USE_PAK_PRECACHE FPakPrecacher::Init(LowerLevel); #endif return !!LowerLevel; } bool FPakPlatformFile::Mount(const TCHAR* InPakFilename, uint32 PakOrder, const TCHAR* InPath /*= NULL*/) { bool bSuccess = false; TSharedPtr PakHandle = MakeShareable(LowerLevel->OpenRead(InPakFilename)); if (PakHandle.IsValid()) { FPakFile* Pak = new FPakFile(LowerLevel, InPakFilename, bSigned); if (Pak->IsValid()) { if (InPath != NULL) { Pak->SetMountPoint(InPath); } FString PakFilename = InPakFilename; if ( PakFilename.EndsWith(TEXT("_P.pak")) ) { PakOrder += 100; } { // Add new pak file FScopeLock ScopedLock(&PakListCritical); FPakListEntry Entry; Entry.ReadOrder = PakOrder; Entry.PakFile = Pak; PakFiles.Add(Entry); PakFiles.StableSort(); } bSuccess = true; } else { UE_LOG(LogPakFile, Warning, TEXT("Failed to mount pak \"%s\", pak is invalid."), InPakFilename); } } else { UE_LOG(LogPakFile, Warning, TEXT("Pak \"%s\" does not exist!"), InPakFilename); } return bSuccess; } bool FPakPlatformFile::Unmount(const TCHAR* InPakFilename) { { FScopeLock ScopedLock(&PakListCritical); for (int32 PakIndex = 0; PakIndex < PakFiles.Num(); PakIndex++) { if (PakFiles[PakIndex].PakFile->GetFilename() == InPakFilename) { delete PakFiles[PakIndex].PakFile; PakFiles.RemoveAt(PakIndex); return true; } } } return false; } IFileHandle* FPakPlatformFile::CreatePakFileHandle(const TCHAR* Filename, FPakFile* PakFile, const FPakEntry* FileEntry) { IFileHandle* Result = NULL; bool bNeedsDelete = true; FArchive* PakReader = PakFile->GetSharedReader(LowerLevel); // Create the handle. if (FileEntry->CompressionMethod != COMPRESS_None && PakFile->GetInfo().Version >= FPakInfo::PakFile_Version_CompressionEncryption) { if (FileEntry->bEncrypted) { Result = new FPakFileHandle< FPakCompressedReaderPolicy >(*PakFile, *FileEntry, PakReader, bNeedsDelete); } else { Result = new FPakFileHandle< FPakCompressedReaderPolicy<> >(*PakFile, *FileEntry, PakReader, bNeedsDelete); } } else if (FileEntry->bEncrypted) { Result = new FPakFileHandle< FPakReaderPolicy >(*PakFile, *FileEntry, PakReader, bNeedsDelete); } else { Result = new FPakFileHandle<>(*PakFile, *FileEntry, PakReader, bNeedsDelete); } return Result; } bool FPakPlatformFile::HandleMountPakDelegate(const FString& PakFilePath, uint32 PakOrder, IPlatformFile::FDirectoryVisitor* Visitor) { bool bReturn = Mount(*PakFilePath, PakOrder); if (bReturn && Visitor != nullptr) { TArray Paks; GetMountedPaks(Paks); // Find the single pak we just mounted for (auto Pak : Paks) { if (PakFilePath == Pak.PakFile->GetFilename()) { // Get a list of all of the files in the pak for (FPakFile::FFileIterator It(*Pak.PakFile); It; ++It) { Visitor->Visit(*It.Filename(), false); } return true; } } } return bReturn; } bool FPakPlatformFile::HandleUnmountPakDelegate(const FString& PakFilePath) { return Unmount(*PakFilePath); } IFileHandle* FPakPlatformFile::OpenRead(const TCHAR* Filename, bool bAllowWrite) { IFileHandle* Result = NULL; FPakFile* PakFile = NULL; const FPakEntry* FileEntry = FindFileInPakFiles(Filename, &PakFile); if (FileEntry != NULL) { Result = CreatePakFileHandle(Filename, PakFile, FileEntry); } #if !USING_SIGNED_CONTENT else { if (IsNonPakFilenameAllowed(Filename)) { // Default to wrapped file Result = LowerLevel->OpenRead(Filename, bAllowWrite); } } #endif return Result; } bool FPakPlatformFile::BufferedCopyFile(IFileHandle& Dest, IFileHandle& Source, const int64 FileSize, uint8* Buffer, const int64 BufferSize) const { int64 RemainingSizeToCopy = FileSize; // Continue copying chunks using the buffer while (RemainingSizeToCopy > 0) { const int64 SizeToCopy = FMath::Min(BufferSize, RemainingSizeToCopy); if (Source.Read(Buffer, SizeToCopy) == false) { return false; } if (Dest.Write(Buffer, SizeToCopy) == false) { return false; } RemainingSizeToCopy -= SizeToCopy; } return true; } bool FPakPlatformFile::CopyFile(const TCHAR* To, const TCHAR* From) { bool Result = false; FPakFile* PakFile = NULL; const FPakEntry* FileEntry = FindFileInPakFiles(From, &PakFile); if (FileEntry != NULL) { // Copy from pak to LowerLevel-> // Create handles both files. TAutoPtr DestHandle(LowerLevel->OpenWrite(To)); TAutoPtr SourceHandle(CreatePakFileHandle(From, PakFile, FileEntry)); if (DestHandle.IsValid() && SourceHandle.IsValid()) { const int64 BufferSize = 64 * 1024; // Copy in 64K chunks. uint8* Buffer = (uint8*)FMemory::Malloc(BufferSize); Result = BufferedCopyFile(*DestHandle, *SourceHandle, SourceHandle->Size(), Buffer, BufferSize); FMemory::Free(Buffer); } } else { Result = LowerLevel->CopyFile(To, From); } return Result; } uint32 ComputePakChunkHash(const uint8* InData, const int64 InDataSize) { return FCrc::MemCrc32(InData, InDataSize); } /** * Module for the pak file */ class FPakFileModule : public IPlatformFileModule { public: virtual IPlatformFile* GetPlatformFile() override { static TScopedPointer AutoDestroySingleton(new FPakPlatformFile()); return AutoDestroySingleton.GetOwnedPointer(); } }; IMPLEMENT_MODULE(FPakFileModule, PakFile);