You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
#lockdown Nick.Penwarden #rb none ============================ MAJOR FEATURES & CHANGES ============================ Change 3550452 by Ben.Marsh UAT: Improve readability of error message when an editor commandlet fails with an error code. Change 3551179 by Ben.Marsh Add methods for reading text files into an array of strings. Change 3551260 by Ben.Marsh Core: Change FFileHelper routines to use enum classes for flags. Change 3555697 by Gil.Gribb Fixed a rare crash when the asset registry scanner found old cooked files with package level compression. #jira UE-47668 Change 3556464 by Ben.Marsh UGS: If working in a virtual stream, use the name of the first non-virtual ancestor for writing version files. Change 3557630 by Ben.Marsh Allow the network version to be set via Build.version if it's not overriden from Version.h. Change 3561357 by Gil.Gribb Fixed crashes related to loading old unversioned files in the editor. #jira UE-47806 Change 3565711 by Graeme.Thornton PR #3839: Make non-encoding specific Base64 functions accessible (Contributed by stfx) Change 3565864 by Robert.Manuszewski Temp fix for a race condition with the async loading thread enabled - caching the linker in case it gets removed (but not deleted) from super class object. Change 3569022 by Ben.Marsh PR #3849: Update gitignore (Contributed by mhutch) Change 3569113 by Ben.Marsh Fix Japanese errors not displaying correctly in the cook output log. #jira UE-47746 Change 3569486 by Ben.Marsh UGS: Always sync the Enterprise folder if the selected .uproject file has the "Enterprise" flag set. Change 3570483 by Graeme.Thornton Minor C# cleanups. Removing some redundant "using" calls which also cause dotnetcore compile errors Change 3570513 by Robert.Manuszewski Fix for a race condition with async loading thread enabled. Change 3570664 by Ben.Marsh UBT: Use P/Invoke to determine number of physical processors on Windows rather than using WMI. Starting up WMIC adds 2.5 seconds to build times, and is not compatible with .NET core. Change 3570708 by Robert.Manuszewski Added ENABLE_GC_OBJECT_CHECKS macro to be able to quickly toggle UObject pointer checks in shipping builds when the garbage collector is running. Change 3571592 by Ben.Marsh UBT: Allow running with -installed without creating [InstalledPlatforms] entries in BaseEngine.ini. If there is no HasInstalledPlatformInfo=true setting, assume that all platforms are still available. Change 3572215 by Graeme.Thornton UBT - Remove some unnecessary using directives - Point SN-DBS code at the new Utils.GetPhysicalProcessorCount call, rather than trying to calculate it itself Change 3572437 by Robert.Manuszewski Game-specific fix for lazy object pointer issues in one of the test levels. The previous fix had to be partially reverted due to side-effects. #jira UE-44996 Change 3572480 by Robert.Manuszewski MaterialInstanceCollections will no longer be added to GC clusters to prevent materials staying around in memory for too long Change 3573547 by Ben.Marsh Add support for displaying log timestamps in local time. Set LogTimes=Local in *Engine.ini, or pass -LocalLogTimes on the command line. Change 3574562 by Robert.Manuszewski PR #3847: Add GC callbacks for script integrations (Contributed by mhutch) Change 3575017 by Ben.Marsh Move some functions related to generating window resolutions out of Core (FParse::Resolution, GenerateConvenientWindowedResolutions). Also remove a few headers from shared PCHs prior to splitting application functionality out of Core. Change 3575689 by Ben.Marsh Add a fixed URL for opening the API documentation, so it works correctly in "internal" and "perforce" builds. Change 3575934 by Steve.Robb Fix for nested preprocessor definitions. Change 3575961 by Steve.Robb Fix for nested zeros. Change 3576297 by Robert.Manuszewski Material resources will now be discarded in PostLoad (Game Thread) instead of in Serialize (potentially Async Loading Thread) so that shader deregistration doesn't assert when done from a different thread than the game thread. #jira FORT-38977 Change 3576366 by Ben.Marsh Add shim functions to allow redirecting FPlatformMisc::ClipboardCopy()/ClipboardPaste() to FPlatformApplicationMisc::ClipboardCopy()/ClipboardPaste() while they are deprecated. Change 3578290 by Graeme.Thornton Changes to Ionic zip library to allow building on dot net core Change 3578291 by Graeme.Thornton Ionic zip library binaries built for .NET Core Change 3578354 by Graeme.Thornton Added FBase64::GetDecodedDataSize() to determine the size of bytes of a decoded base64 string Change 3578674 by Robert.Manuszewski After loading packages flush linker cache on uncooked platforms to free precache memory Change 3579068 by Steve.Robb Fix for CLASS_Intrinsic getting stomped. Fix to EClassFlags so that they are visible in the debugger. Re-added mysteriously-removed comments. Change 3579228 by Steve.Robb BOM removed. Change 3579297 by Ben.Marsh Fix exception if a plugin lists the same module twice. #jira UE-48232 Change 3579898 by Robert.Manuszewski When creating GC clusters and asserting due to objects still being pending load, the object name and cluster name will now be logged with the assert. Change 3579983 by Robert.Manuszewski More fixes for freeing linker cache memory in the editor. Change 3580012 by Graeme.Thornton Remove redundant copy of FileReference.cs Change 3580408 by Ben.Marsh Validate that arguments passed to the checkf macro are valid sprintf types, and fix up a few places which are currently incorrect. Change 3582104 by Graeme.Thornton Added a dynamic compilation path that uses the latest roslyn apis. Currently only used by the .NET Core path. Change 3582131 by Graeme.Thornton #define out some PerformanceCounter calls that don't exist in .NET Core. They're only used by mono-specific calls anyway. Change 3582645 by Ben.Marsh PR #3879: fix bug when creating a new VS2017 C++ project (Contributed by mnannola) #jira UE-48192 Change 3583955 by Robert.Manuszewski Support for EDL cooked packages in the editor Change 3584035 by Graeme.Thornton Split RunExternalExecutable into RunExternaNativelExecutable and RunExternalDotNETExecutable. When running under .NET Core, externally launched DotNET utilities must be launched via the 'dotnet' proxy to work correctly. Change 3584177 by Robert.Manuszewski Removed unused member variable (FArchiveAsync2::bKeepRestOfFilePrecached) Change 3584315 by Ben.Marsh Move Android JNI accessor functions into separate header, to decouple it from the FAndroidApplication class. Change 3584370 by Ben.Marsh Move hooks which allow platforms to load any modules into the FPlatformApplicationMisc classes. Change 3584498 by Ben.Marsh Move functions for getting and setting the hardware window pointer onto the appropriate platform window classes. Change 3585003 by Steve.Robb Fix for TChunkedArray ranged-for iteration. #jira UE-48297 Change 3585235 by Ben.Marsh Remove LogEngine extern from Core; use the platform log channels instead. Change 3585942 by Ben.Marsh Move MessageBoxExt() implementation into application layer for platforms that require it. Change 3587071 by Ben.Marsh Move Linux's UngrabAllInput() function into a callback, so DebugBreak still works without SDL. Change 3587161 by Ben.Marsh Remove headers which will be stripped out of the Core module from Core.h and PlatformIncludes.h. Change 3587579 by Steve.Robb Fix for Children list not being rebuilt after hot reload. Change 3587584 by Graeme.Thornton Logging improvements for pak signature check failures - Added "PakCorrupt" console command which corrupts the master signature table - Added some extra log information about which block failed - Re-hash the master signature table and to make sure that it hasn't changed since startup - Moved the ensure around so that some extra logging messages can make it out before the ensure is hit - Added PAK_SIGNATURE_CHECK_FAILS_ARE_FATAL to IPlatformFilePak.h so we have a single place to make signature check failures fatal again Change 3587586 by Graeme.Thornton Changes to make UBT build and run on .NET Core - Added *_DNC csproj files for DotNETUtilities and UnrealBuildTool projects which contain the .NET Core build setups - VCSharpProjectFile can no be asked for the CsProjectInfo for a particular configuration, which is cached for future use - After loading VCSharpProjectFiles, .NET Core based projects will be excluded unless generating VSCode projects Change 3587953 by Steve.Robb Allow arbitrary UENUM initializers for enumerators. Editor-only data UENUM support. Enumerators named MAX are now treated as the UENUM's maximum, and will not cause a MAX+1 value to be generated. #jira UE-46274 Change 3589827 by Graeme.Thornton More fixes for VSCode project generation and for UBT running on .NET Core - Use a different file extension for rules assemblies when build on .NET Core, so they never get used by their counterparts - UEConsoleTraceListener supports stdout/stderror constructor parameter and outputs to the appropriate channel - Added documentation for UEConsoleTraceListener - All platforms .NET project compilation tasks/launch configs now use "dotnet" and not the normal batch files - Restored the default UBT log verbosity to "Log" rather than "VeryVeryVerbose" - Renamed assemblies for .NETCore versions of DotNETUtilities and UnrealBuildTool so they don't conflict with the output of the existing .NET Desktop Framework stuff Change 3589868 by Graeme.Thornton Separate .NET Core projects for UBT and DotNETCommon out into their own directories so that their intermediates don't overlap with the standard .NET builds, causing failures. UBT registers ONLY .NET Core C# projects when generating VSCode solutions, and ONLY standard C# projects in all other cases Change 3589919 by Robert.Manuszewski Fixing crash when cooking textures that have already been cooked for EDL (support for cooked content in the editor) Change 3589940 by Graeme.Thornton Force UBT to think it's running on mono when actually running on .NET Core. Disables a lot of windows specific code paths. Change 3590078 by Graeme.Thornton Fully disable automatic assembly info generation in .NET Core projects Change 3590534 by Robert.Manuszewski Marking UObject as intrinsic clas to fix a crash on UFE startup. Change 3591498 by Gil.Gribb UE4 - Fixed several edge cases in the low level async loading code, especially around cancellation. Also PakFileTest is a console command which can be used to stress test pak file loading. Change 3591605 by Gil.Gribb UE4 - Follow up to fixing several edge cases in the low level async loading code. Change 3592577 by Graeme.Thornton .NET Core C# projects now reference source files explicitly, to stop it accidentally compiling various intermediates Change 3592684 by Steve.Robb Fix for EObjectFlags being passed as the wrong argument to csgCopyBrush. Change 3592710 by Steve.Robb Fix for invalid casts in ListProps command. Some name changes in command output. Change 3592715 by Ben.Marsh Move Windows event log code into cpp file, and expose it to other modules even if it's not enabled by default. Change 3592767 by Gil.Gribb UE4 - Changed the logic so that engine UObjects boot before anything else. The engine classes are known to be cycle-free, so we will get them done before moving onto game modules. Change 3592770 by Gil.Gribb UE4 - Fixed a race condition with async read completion in the prescence of cancels. Change 3593090 by Steve.Robb Better error message when there two clashing type names are found. Change 3593697 by Steve.Robb VisitTupleElements function, which calls a functor for each element in the tuple. Change 3595206 by Ben.Marsh Include additional diagnostics for missing imports when a module load fails. Change 3596140 by Graeme.Thornton Batch file for running MSBuild Change 3596267 by Steve.Robb Thread safety fix to FPaths::GetProjectFilePath(). Change 3596271 by Robert.Manuszewski Added code to verify compression flags in package file summary to avoid cases where corrupt packages are crashing the editor #jira UE-47535 Change 3596283 by Steve.Robb Redundant casts removed from UHT. Change 3596303 by Ben.Marsh EC: Improve parsing of Android Clang errors and warnings, which are formatted as MSVC diagnostics to allow go-to-line clicking in the Output Window. Change 3596337 by Ben.Marsh UBT: Format messages about incorrect headers in a way that makes them clickable from Visual Studio. Change 3596367 by Steve.Robb Iterator checks in ranged-for on TMap, TSet and TSparseArray. Change 3596410 by Gil.Gribb UE4 - Improved some error messages on runtime failures in the EDL. Change3596532by Ben.Marsh UnrealVS: Fix setting command line to empty not affecting property sheet. Also remove support for VS2013. #jira UE-48119 Change 3596631 by Steve.Robb Tool which takes a .map file and a .objmap file (from UBT) and creates a report which shows the size of all the symbols contributed by the source code per-folder. Change 3596807 by Ben.Marsh Improve Intellisense when generated headers are missing or out of date (eg. line numbers changed, etc...). These errors seem to be masked by VAX, but are present when using the default Visual Studio Intellisense. * UCLASS macro is defined to empty when __INTELLISENSE__ is defined. Previous macro was preventing any following class declaration being parsed correctly if generated code was out of date, causing squiggles over all class methods/variables. * Insert a semicolon after each expanded GENERATED_BODY macro, so that if it parses incorrectly, the compiler can still continue parsing the next declaration. Change 3596957 by Steve.Robb UBT can be used to write out an .objsrcmap file for use with the MapFileParser. Renaming of ObjMap to ObjSrcMap in MapFileParser. Change 3597213 by Ben.Marsh Remove AutoReporter. We don't support this any more. Change 3597558 by Ben.Marsh UGS: Allow adding custom actions to the context menu for right clicking on a changelist. Actions are specified in the project's UnrealEngine.ini file, with the following syntax: +ContextMenu=(Label="This is the menu item", Execute="foo.exe", Arguments="bar") The standard set of variables for custom tools is expanded in each parameter (eg. $(ProjectDir), $(EditorConfig), etc...), plus the $(Change) variable. Change 3597982 by Ben.Marsh Add an option to allow overriding the local DDC path from the editor (under Editor Preferences > Global > Local Derived Data Cache). #jira UE-47173 Change 3598045 by Ben.Marsh UGS: Add variables for stream and client name, and the ability to escape any variables for URIs using the syntax $(VariableName:URI). Change 3599214 by Ben.Marsh Avoid string duplication when comparing extensions. Change 3600038 by Steve.Robb Fix for maps being modified during iteration in cache compaction. Change 3600136 by Steve.Robb GitHub #3538 : Fixed a bug with the handling of 'TMap' key/value types in the UnrealHeaderTool Change 3600214 by Steve.Robb More accurate error message when unsupported template parameters are provided in a TSet property. Change 3600232 by Ben.Marsh UBT: Force UHT to run again if the .build.cs file for a module has changed. #jira UE-46119 Change 3600246 by Steve.Robb GitHub #3045 : allow multiple interface definition in a file Change 3600645 by Ben.Marsh Convert QAGame to Include-What-You-Use. Change 3600897 by Ben.Marsh Fix invalid path (multiple slashes) in LibCurl.build.cs. Causes exception when scanning for includes. Change 3601558 by Graeme.Thornton Simple first pass VSCode editor integration plugin Change 3601658 by Graeme.Thornton Enable intellisense generation for VS Code project files and setup include paths properly Change 3601762 by Ben.Marsh UBT: Add support for adaptive non-unity builds when working from a Git repository. The ISourceFileWorkingSet interface is now used to query files belonging to the working set, and has separate implementations for Perforce (PerforceSourceFileWorkingSet) and Git (GitSourceFileWorkingSet). The Git implementation is used if a .git directory is found in the directory containing the Engine folder, the directory containing the project file, or the parent directory of the project file, and spawns a "git status" process in the background to determine which files are untracked or staged. Several new settings are supported in BuildConfiguration.xml to allow modifying default behavior: <SourceFileWorkingSet> <Provider>Default</Provider> <!-- May be None, Default, Git or Perforce --> <RepositoryPath></RepositoryPath> <!-- Specifies the path to the repository, relative to the directory containing the Engine folder. If not set, tries to find a .git directory in the locations listed above. --> <GitPath>git</GitPath> <!-- Specifies the path to the Git executable. Defaults to "git", which assumes that it will be on the PATH --> </SourceFileWorkingSet> Change 3604032 by Graeme.Thornton First attempt at automatically detecting the existance and location of visual studio code in the source code accessor module. Only works for windows. Change 3604038 by Graeme.Thornton Added FSourceCodeNavigation::GetSelectedSourceCodeIDE() which returns the name of the selected source code accessor. Replaced all usages of FSourceCodeNavigation::GetSuggestedSourceCodeIDE() with GetSelectedSourceCodeIDE(), where the message is referring to the opening or editing of code. Change 3604106 by Steve.Robb GitHub #3561 : UE-44950: Don't see all caps struct constructor as macro Change 3604192 by Steve.Robb GitHub #3911 : Improving ToUpper/ToLower efficiency Change 3604273 by Graeme.Thornton IWYU build fixes when malloc profiler is enabled Change 3605457 by Ben.Marsh Fix race for intiialization of ThreadID variable on FRunnableThreadWin, and restore a previous check that was working around it. Change 3606720 by James.Hopkin Dave Ratti's fix to character base recursion protection code - was missing a GetOwner call, instead attempting to cast a component to a pawn. Change 3606807 by Graeme.Thornton Disabled optimizations around FShooterStyle::Create(), which was crashing in Win64 shipping game builds due to some known compiler issue. Same variety of fix as BenZ did in CL 3567741. Change 3607026 by James.Hopkin Fixed incorrect ABrush cast - was attempting to cast a UModel to ABrush, which can never succeed Change 3607142 by Graeme.Thornton UBT - Minor refactor of BackgroundProcess shutdown in SourceFileWorkingSet. Check whether the process has already exited before trying to kill it during Dispose. Change 3607146 by Ben.Marsh UGS: Fix exception due to formatting string when Perforce throws an error. Change 3607147 by Steve.Robb Efficiency fix for integer properties, which were causing a property mismatch and thus a tag lookup every time. Float and double conversion support added to int properties. NAME_DoubleProperty added. Fix for converting enum class enumerators > 255 to int properties. Change 3607516 by Ben.Marsh PR #3935: Fix DECLARE_DELEGATE_NineParams, DECLARE_MULTICAST_DELEGATE_NineParams. (Contributed by enginevividgames) Change 3610421 by Ben.Marsh UAT: Move help for RebuildLightMapsCommand into attributes, so they display when running with -help. Change 3610657 by Ben.Marsh UAT: Unify initialization of command environment for build machines and local execution. Always derive parameters which aren't manually set via environment variables. Change 3611000 by Ben.Marsh UAT: Remove the -ForceLocal command line option. Settings are now determined automatically, independently of the -Buildmachine argument. Change 3612471 by Ben.Marsh UBT: Move FastJSON into DotNETUtilities. Change 3613479 by Ben.Marsh UBT: Remove the bIsCodeProject flag from UProjectInfo. This was only really being used to determine which projects to generate an IDE project for, so it is now checked in the project file generator. Change 3613910 by Ben.Marsh UBT: Remove unnecessary code to guess a project from the target name; doesn't work due to init order, actual project is determined later. Change 3614075 by Ben.Marsh UBT: Remove hacks for testing project file attributes by name. Change 3614090 by Ben.Marsh UBT: Remove global lookup of project by name. Projects should be explicitly specified by path when necessary. Change 3614488 by Ben.Marsh UBT: Prevent annoying (but handled) exception when constructing SQLiteModuleSupport objects with -precompile enabled. Change 3614490 by Ben.Marsh UBT: Simplify generation of arguments for building intellisense; determine the platform/configuration to build from the project file generation code, rather than inside the target itself. Change 3614962 by Ben.Marsh UBT: Move the VS2017 strict conformance mode (/permissive-) behind a command line option (-Strict), and disable it by default. Building with this mode is not guaranteed to work correctly without updated Windows headers. Change 3615416 by Ben.Marsh EC: Include an icon showing the overall status of a build in the grid view. Change 3615713 by Ben.Marsh UBT: Delete any files in output directories which match output files in other directories. Allows automatically deleting build products which are moved into another folder. #jira UE-48987 Change 3616652 by Ben.Marsh Plugins: Fix incorrect dialog when binaries for a plugin are missing. Should only prompt to disable if starting a content-only project. #jira UE-49007 Change 3616680 by Ben.Marsh Add the CodeAPI-HTML.tgz file into the installed engine build. Change 3616767 by Ben.Marsh Plugins: Tweak error message if the FModuleManager::IsUpToDate() function returns false for a plugin module; the module may be missing, not just incompatible. Change 3616864 by Ben.Marsh Cap the length of the temporary package name during save, to prevent excessively long filenames going over the limit once a GUID is appended. #jira UE-48711 Change 3619964 by Ben.Marsh UnrealVS: Fix single file compile for foreign projects, where the command line contains $(SolutionDir) and $(ProjectName) variables. Change 3548930 by Ben.Marsh UBT: Remove UEBuildModuleCSDLL; there is no codepath that still supports creating them. Remove the remaining UEBuildModule/UEBuildModuleCPP abstraction. Change 3558056 by Ben.Marsh Deprecate FString::Trim() and FString::TrimTrailing(), and replace them with separate versions to mutate (TrimStartInline(), TrimEndInline()) or return by copy (TrimStart(), TrimEnd()). Also add a functions to trim whitespace from both ends of a string (TrimStartAndEnd(), TrimStartAndEndInline()). Change 3563309 by Graeme.Thornton Moved some common C# classes into the DotNETCommon assembly Change 3570283 by Graeme.Thornton Move some code out of RPCUtility and into DotNETCommon, removing the dependency between the two projects Added UEConsoleTraceListener to replace ConsoleTraceListener, which doesn't exist in DotNetCore Change 3572811 by Ben.Marsh UBT: Add -enableasan / -enabletsan command line options and bEnableAddressSanitizer / bEnableThreadSanitizer settings in BuildConfiguration.xml (and remove environment variables). Change 3573397 by Ben.Marsh UBT: Create a <ExeName>.version file for every target built by UBT, in the same JSON format as Engine/Build/Build.version. This allows monolithic targets to read a version number at runtime, unlike when it's embedded in a modules file, and allows creating versioned client executables that will work with versioned servers when syncing through UGS. Change 3575659 by Ben.Marsh Remove CHM API documentation. Change 3582103 by Graeme.Thornton Simple ResX writer implemetation that the xbox deloyment code can use instead of the one from the windows forms assembly, which isn't supported on .NET Core Removed reference to System.Windows.Form from UBT. Change 3584113 by Ben.Marsh Move key-mapping functionality into the InputCore module. Change 3584278 by Ben.Marsh Move FPlatformMisc::RequestMinimize() into FPlatformApplicationMisc. Change 3584453 by Ben.Marsh Move functionality for querying device display density to FApplicationMisc, due to dependence on application-level functionality on mobile platforms. Change 3585301 by Ben.Marsh Move PlatformPostInit() into an FPlatformApplicationMisc function. Change 3587050 by Ben.Marsh Move IsThisApplicationForeground() into FPlatformApplicationMisc. Change 3587059 by Ben.Marsh Move RequiresVirtualKeyboard() into FPlatformApplicationMisc. Change3587119by Ben.Marsh Move GetAbsoluteLogFilename() into FPlatformMisc. Change 3587800 by Steve.Robb Fixes to container visualizers for types whose pointer type isn't simply Type*. Change 3588393 by Ben.Marsh Move platform output devices into their own headers. Change 3588868 by Ben.Marsh Move creation of console, error and warning output devices int PlatformApplicationMisc. Change 3589879 by Graeme.Thornton All automation projects now have a reference to DotNETUtilities Fixed a build error in the WEX automation library Change 3590034 by Ben.Marsh Move functionality related to windowing and input out of the Core module and into an ApplicationCore module, so it is possible to build utilities with Core without adding dependencies on XInput (Windows), SDL (Linux), and OpenGL (Mac). Change 3593754 by Steve.Robb Fix for tuple debugger visualization. Change 3597208 by Ben.Marsh Move CrashReporter out of a public folder; it's not in a form that is usable by subscribers and licensees. Change 3600163 by Ben.Marsh UBT: Simplify how targets are cleaned. Delete all intermediate folders for a platform/configuration, and delete any build products matching the UE4 naming convention for that target, rather than relying on the current build configuration or list of previous build products. This will ensure that build products which are no longer being generated will also be cleaned. #jira UE-46725 Change 3604279 by Graeme.Thornton Move pre/post garbage collection delegates into accessor functions so they can be used by globally constructed objects Change 3606685 by James.Hopkin Removed redundant 'Cast's (casting to either the same type or a base). In SClassViewer, replaced cast with TAssetPtr::operator* call to get the wrapped UClass. Also removed redundant 'IsA's from AnimationRetargetContent::AddRemappedAsset in EditorAnimUtils.cpp. Change 3610950 by Ben.Marsh UAT: Simplify logic for detecting Perforce settings, using environment variables if they are set, otherwise falling back to detecting them. Removes special cases for build machines, and makes it simpler to set up UAT commands on builders outside Epic. Change 3610991 by Ben.Marsh UAT: Use the correct P4 settings to detect settings if only some parameters are specified on the command line. Change 3612342 by Ben.Marsh UBT: Change JsonObject.Read() to take a FileReference parameter. Change 3612362 by Ben.Marsh UBT: Remove some more cases of paths being passed as strings rather than using FileReference objects. Change 3619128 by Ben.Marsh Include builder warnings and errors in the notification emails for automated tests, otherwise it's difficult to track down non-test failures. [CL 3620189 by Ben Marsh in Main branch]
1314 lines
50 KiB
C#
1314 lines
50 KiB
C#
// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
|
|
|
|
using System;
|
|
using System.Collections.Concurrent;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
using System.IO;
|
|
using System.IO.Compression;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using System.Xml.Serialization;
|
|
using UnrealBuildTool;
|
|
using AutomationTool;
|
|
using Tools.DotNETCommon;
|
|
|
|
namespace AutomationTool
|
|
{
|
|
/// <summary>
|
|
/// Stores the name of a temp storage block
|
|
/// </summary>
|
|
public class TempStorageBlock
|
|
{
|
|
/// <summary>
|
|
/// Name of the node
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public string NodeName;
|
|
|
|
/// <summary>
|
|
/// Name of the output from this node
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public string OutputName;
|
|
|
|
/// <summary>
|
|
/// Default constructor, for XML serialization.
|
|
/// </summary>
|
|
private TempStorageBlock()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Construct a temp storage block
|
|
/// </summary>
|
|
/// <param name="InNodeName">Name of the node</param>
|
|
/// <param name="InOutputName">Name of the node's output</param>
|
|
public TempStorageBlock(string InNodeName, string InOutputName)
|
|
{
|
|
NodeName = InNodeName;
|
|
OutputName = InOutputName;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests whether two temp storage blocks are equal
|
|
/// </summary>
|
|
/// <param name="Other">The object to compare against</param>
|
|
/// <returns>True if the blocks are equivalent</returns>
|
|
public override bool Equals(object Other)
|
|
{
|
|
TempStorageBlock OtherBlock = Other as TempStorageBlock;
|
|
return OtherBlock != null && NodeName == OtherBlock.NodeName && OutputName == OtherBlock.OutputName;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns a hash code for this block name
|
|
/// </summary>
|
|
/// <returns>Hash code for the block</returns>
|
|
public override int GetHashCode()
|
|
{
|
|
return ToString().GetHashCode();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the name of this block for debugging purposes
|
|
/// </summary>
|
|
/// <returns>Name of this block as a string</returns>
|
|
public override string ToString()
|
|
{
|
|
return String.Format("{0}/{1}", NodeName, OutputName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Information about a single file in temp storage
|
|
/// </summary>
|
|
[DebuggerDisplay("{RelativePath}")]
|
|
public class TempStorageFile
|
|
{
|
|
/// <summary>
|
|
/// The path of the file, relative to the engine root. Stored using forward slashes.
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public string RelativePath;
|
|
|
|
/// <summary>
|
|
/// The last modified time of the file, in UTC ticks since the Epoch.
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public long LastWriteTimeUtcTicks;
|
|
|
|
/// <summary>
|
|
/// Length of the file
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public long Length;
|
|
|
|
/// <summary>
|
|
/// Default constructor, for XML serialization.
|
|
/// </summary>
|
|
private TempStorageFile()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Constructor
|
|
/// </summary>
|
|
/// <param name="FileInfo">File to be added</param>
|
|
/// <param name="RootDir">Root directory to store paths relative to</param>
|
|
public TempStorageFile(FileInfo FileInfo, DirectoryReference RootDir)
|
|
{
|
|
// Check the file exists and is in the right location
|
|
FileReference File = new FileReference(FileInfo);
|
|
if(!File.IsUnderDirectory(RootDir))
|
|
{
|
|
throw new AutomationException("Attempt to add file to temp storage manifest that is outside the root directory ({0})", File.FullName);
|
|
}
|
|
if(!FileInfo.Exists)
|
|
{
|
|
throw new AutomationException("Attempt to add file to temp storage manifest that does not exist ({0})", File.FullName);
|
|
}
|
|
|
|
RelativePath = File.MakeRelativeTo(RootDir).Replace(Path.DirectorySeparatorChar, '/');
|
|
LastWriteTimeUtcTicks = FileInfo.LastWriteTimeUtc.Ticks;
|
|
Length = FileInfo.Length;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compare stored for this file with the one on disk, and output an error if they differ.
|
|
/// </summary>
|
|
/// <param name="RootDir">Root directory for this branch</param>
|
|
/// <returns>True if the files are identical, false otherwise</returns>
|
|
public bool Compare(DirectoryReference RootDir)
|
|
{
|
|
string Message;
|
|
if(Compare(RootDir, out Message))
|
|
{
|
|
if(Message != null)
|
|
{
|
|
CommandUtils.Log(Message);
|
|
}
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
if(Message != null)
|
|
{
|
|
CommandUtils.LogError(Message);
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compare stored for this file with the one on disk, and output an error if they differ.
|
|
/// </summary>
|
|
/// <param name="RootDir">Root directory for this branch</param>
|
|
/// <param name="Message">Message describing the difference</param>
|
|
/// <returns>True if the files are identical, false otherwise</returns>
|
|
public bool Compare(DirectoryReference RootDir, out string Message)
|
|
{
|
|
FileReference LocalFile = ToFileReference(RootDir);
|
|
|
|
// Get the local file info, and check it exists
|
|
FileInfo Info = new FileInfo(LocalFile.FullName);
|
|
if(!Info.Exists)
|
|
{
|
|
Message = String.Format("Missing file from manifest - {0}", RelativePath);
|
|
return false;
|
|
}
|
|
|
|
// Check the size matches
|
|
if(Info.Length != Length)
|
|
{
|
|
Message = String.Format("File size differs from manifest - {0} is {1} bytes, expected {2} bytes", RelativePath, Info.Length, Length);
|
|
return false;
|
|
}
|
|
|
|
// Check the timestamp of the file matches. On FAT filesystems writetime has a two seconds resolution (see http://msdn.microsoft.com/en-us/library/windows/desktop/ms724290%28v=vs.85%29.aspx)
|
|
TimeSpan TimeDifference = new TimeSpan(Info.LastWriteTimeUtc.Ticks - LastWriteTimeUtcTicks);
|
|
if(TimeDifference.TotalSeconds < -2 || TimeDifference.TotalSeconds > +2)
|
|
{
|
|
DateTime ExpectedLocal = new DateTime(LastWriteTimeUtcTicks, DateTimeKind.Utc).ToLocalTime();
|
|
if(RequireMatchingTimestamps())
|
|
{
|
|
Message = String.Format("File date/time mismatch for {0} - was {1}, expected {2}, TimeDifference {3}", RelativePath, Info.LastWriteTime, ExpectedLocal, TimeDifference);
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
Message = String.Format("Ignored file date/time mismatch for {0} - was {1}, expected {2}, TimeDifference {3}", RelativePath, Info.LastWriteTime, ExpectedLocal, TimeDifference);
|
|
return true;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
Message = null;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Whether we should compare timestamps for this file. Some build products are harmlessly overwritten as part of the build process, so we flag those here.
|
|
/// </summary>
|
|
/// <returns>True if we should compare the file's timestamp, false otherwise</returns>
|
|
bool RequireMatchingTimestamps()
|
|
{
|
|
return RelativePath.IndexOf("/Binaries/DotNET/", StringComparison.InvariantCultureIgnoreCase) == -1 && RelativePath.IndexOf("/Binaries/Mac/", StringComparison.InvariantCultureIgnoreCase) == -1;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a local file reference for this file, given a root directory to base it from.
|
|
/// </summary>
|
|
/// <param name="RootDir">The local root directory</param>
|
|
/// <returns>Reference to the file</returns>
|
|
public FileReference ToFileReference(DirectoryReference RootDir)
|
|
{
|
|
return FileReference.Combine(RootDir, RelativePath.Replace('/', Path.DirectorySeparatorChar));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Information about a single file in temp storage
|
|
/// </summary>
|
|
[DebuggerDisplay("{Name}")]
|
|
public class TempStorageZipFile
|
|
{
|
|
/// <summary>
|
|
/// Name of this file, including extension
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public string Name;
|
|
|
|
/// <summary>
|
|
/// Length of the file in bytes
|
|
/// </summary>
|
|
[XmlAttribute]
|
|
public long Length;
|
|
|
|
/// <summary>
|
|
/// Default constructor, for XML serialization
|
|
/// </summary>
|
|
private TempStorageZipFile()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Constructor
|
|
/// </summary>
|
|
/// <param name="Info">FileInfo for the zip file</param>
|
|
public TempStorageZipFile(FileInfo Info)
|
|
{
|
|
Name = Info.Name;
|
|
Length = Info.Length;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// A manifest storing information about build products for a node's output
|
|
/// </summary>
|
|
public class TempStorageManifest
|
|
{
|
|
/// <summary>
|
|
/// List of output files
|
|
/// </summary>
|
|
[XmlArray]
|
|
[XmlArrayItem("File")]
|
|
public TempStorageFile[] Files;
|
|
|
|
/// <summary>
|
|
/// List of compressed archives containing the given files
|
|
/// </summary>
|
|
[XmlArray]
|
|
[XmlArrayItem("ZipFile")]
|
|
public TempStorageZipFile[] ZipFiles;
|
|
|
|
/// <summary>
|
|
/// Construct a static Xml serializer to avoid throwing an exception searching for the reflection info at runtime
|
|
/// </summary>
|
|
static XmlSerializer Serializer = XmlSerializer.FromTypes(new Type[]{ typeof(TempStorageManifest) })[0];
|
|
|
|
/// <summary>
|
|
/// Construct an empty temp storage manifest
|
|
/// </summary>
|
|
private TempStorageManifest()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a manifest from a flat list of files (in many folders) and a BaseFolder from which they are rooted.
|
|
/// </summary>
|
|
/// <param name="InFiles">List of full file paths</param>
|
|
/// <param name="RootDir">Root folder for all the files. All files must be relative to this RootDir.</param>
|
|
public TempStorageManifest(FileInfo[] InFiles, DirectoryReference RootDir)
|
|
{
|
|
Files = InFiles.Select(x => new TempStorageFile(x, RootDir)).ToArray();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the total size of the files stored in this manifest
|
|
/// </summary>
|
|
/// <returns>The total size of all files</returns>
|
|
public long GetTotalSize()
|
|
{
|
|
long Result = 0;
|
|
foreach(TempStorageFile File in Files)
|
|
{
|
|
Result += File.Length;
|
|
}
|
|
return Result;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Load a manifest from disk
|
|
/// </summary>
|
|
/// <param name="File">File to load</param>
|
|
static public TempStorageManifest Load(FileReference File)
|
|
{
|
|
using(StreamReader Reader = new StreamReader(File.FullName))
|
|
{
|
|
return (TempStorageManifest)Serializer.Deserialize(Reader);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Saves a manifest to disk
|
|
/// </summary>
|
|
/// <param name="File">File to save</param>
|
|
public void Save(FileReference File)
|
|
{
|
|
using(StreamWriter Writer = new StreamWriter(File.FullName))
|
|
{
|
|
Serializer.Serialize(Writer, this);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Stores the contents of a tagged file set
|
|
/// </summary>
|
|
public class TempStorageFileList
|
|
{
|
|
/// <summary>
|
|
/// List of files that are in this tag set, relative to the root directory
|
|
/// </summary>
|
|
[XmlArray]
|
|
[XmlArrayItem("LocalFile")]
|
|
public string[] LocalFiles;
|
|
|
|
/// <summary>
|
|
/// List of files that are in this tag set, but not relative to the root directory
|
|
/// </summary>
|
|
[XmlArray]
|
|
[XmlArrayItem("LocalFile")]
|
|
public string[] ExternalFiles;
|
|
|
|
/// <summary>
|
|
/// List of referenced storage blocks
|
|
/// </summary>
|
|
[XmlArray]
|
|
[XmlArrayItem("Block")]
|
|
public TempStorageBlock[] Blocks;
|
|
|
|
/// <summary>
|
|
/// Construct a static Xml serializer to avoid throwing an exception searching for the reflection info at runtime
|
|
/// </summary>
|
|
static XmlSerializer Serializer = XmlSerializer.FromTypes(new Type[]{ typeof(TempStorageFileList) })[0];
|
|
|
|
/// <summary>
|
|
/// Construct an empty file list for deserialization
|
|
/// </summary>
|
|
private TempStorageFileList()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a manifest from a flat list of files (in many folders) and a BaseFolder from which they are rooted.
|
|
/// </summary>
|
|
/// <param name="InFiles">List of full file paths</param>
|
|
/// <param name="RootDir">Root folder for all the files. All files must be relative to this RootDir.</param>
|
|
/// <param name="InBlocks">Referenced storage blocks required for these files</param>
|
|
public TempStorageFileList(IEnumerable<FileReference> InFiles, DirectoryReference RootDir, IEnumerable<TempStorageBlock> InBlocks)
|
|
{
|
|
List<string> NewLocalFiles = new List<string>();
|
|
List<string> NewExternalFiles = new List<string>();
|
|
foreach(FileReference File in InFiles)
|
|
{
|
|
if(File.IsUnderDirectory(RootDir))
|
|
{
|
|
NewLocalFiles.Add(File.MakeRelativeTo(RootDir).Replace(Path.DirectorySeparatorChar, '/'));
|
|
}
|
|
else
|
|
{
|
|
NewExternalFiles.Add(File.FullName.Replace(Path.DirectorySeparatorChar, '/'));
|
|
}
|
|
}
|
|
LocalFiles = NewLocalFiles.ToArray();
|
|
ExternalFiles = NewExternalFiles.ToArray();
|
|
|
|
Blocks = InBlocks.ToArray();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Load this list of files from disk
|
|
/// </summary>
|
|
/// <param name="File">File to load</param>
|
|
static public TempStorageFileList Load(FileReference File)
|
|
{
|
|
using(StreamReader Reader = new StreamReader(File.FullName))
|
|
{
|
|
return (TempStorageFileList)Serializer.Deserialize(Reader);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Saves this list of files to disk
|
|
/// </summary>
|
|
/// <param name="File">File to save</param>
|
|
public void Save(FileReference File)
|
|
{
|
|
using(StreamWriter Writer = new StreamWriter(File.FullName))
|
|
{
|
|
Serializer.Serialize(Writer, this);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Converts this file list into a set of FileReference objects
|
|
/// </summary>
|
|
/// <param name="RootDir">The root directory to rebase local files</param>
|
|
/// <returns>Set of files</returns>
|
|
public HashSet<FileReference> ToFileSet(DirectoryReference RootDir)
|
|
{
|
|
HashSet<FileReference> Files = new HashSet<FileReference>();
|
|
Files.UnionWith(LocalFiles.Select(x => FileReference.Combine(RootDir, x)));
|
|
Files.UnionWith(ExternalFiles.Select(x => new FileReference(x)));
|
|
return Files;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tracks the state of the current build job using the filesystem, allowing jobs to be restarted after a failure or expanded to include larger targets, and
|
|
/// providing a proxy for different machines executing parts of the build in parallel to transfer build products and share state as part of a build system.
|
|
///
|
|
/// If a shared temp storage directory is provided - typically a mounted path on a network share - all build products potentially needed as inputs by another node
|
|
/// are compressed and copied over, along with metadata for them (see TempStorageFile) and flags for build events that have occurred (see TempStorageEvent).
|
|
///
|
|
/// The local temp storage directory contains the same information, with the exception of the archived build products. Metadata is still kept to detect modified
|
|
/// build products between runs. If data is not present in local temp storage, it's retrieved from shared temp storage and cached in local storage.
|
|
/// </summary>
|
|
class TempStorage
|
|
{
|
|
/// <summary>
|
|
/// Root directory for this branch.
|
|
/// </summary>
|
|
DirectoryReference RootDir;
|
|
|
|
/// <summary>
|
|
/// The local temp storage directory (typically somewhere under /Engine/Saved directory).
|
|
/// </summary>
|
|
DirectoryReference LocalDir;
|
|
|
|
/// <summary>
|
|
/// The shared temp storage directory; typically a network location. May be null.
|
|
/// </summary>
|
|
DirectoryReference SharedDir;
|
|
|
|
/// <summary>
|
|
/// Whether to allow writes to shared storage
|
|
/// </summary>
|
|
bool bWriteToSharedStorage;
|
|
|
|
/// <summary>
|
|
/// Constructor
|
|
/// </summary>
|
|
/// <param name="InRootDir">Root directory for this branch</param>
|
|
/// <param name="InLocalDir">The local temp storage directory.</param>
|
|
/// <param name="InSharedDir">The shared temp storage directory. May be null.</param>
|
|
/// <param name="bInWriteToSharedStorage">Whether to write to shared storage, or only permit reads from it</param>
|
|
public TempStorage(DirectoryReference InRootDir, DirectoryReference InLocalDir, DirectoryReference InSharedDir, bool bInWriteToSharedStorage)
|
|
{
|
|
RootDir = InRootDir;
|
|
LocalDir = InLocalDir;
|
|
SharedDir = InSharedDir;
|
|
bWriteToSharedStorage = bInWriteToSharedStorage;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Cleans all cached local state. We never remove shared storage.
|
|
/// </summary>
|
|
public void CleanLocal()
|
|
{
|
|
CommandUtils.DeleteDirectoryContents(LocalDir.FullName);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Cleans local build products for a given node. Does not modify shared storage.
|
|
/// </summary>
|
|
/// <param name="NodeName">Name of the node</param>
|
|
public void CleanLocalNode(string NodeName)
|
|
{
|
|
DirectoryReference NodeDir = GetDirectoryForNode(LocalDir, NodeName);
|
|
if(DirectoryReference.Exists(NodeDir))
|
|
{
|
|
CommandUtils.DeleteDirectoryContents(NodeDir.FullName);
|
|
CommandUtils.DeleteDirectory_NoExceptions(NodeDir.FullName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check whether the given node is complete
|
|
/// </summary>
|
|
/// <param name="NodeName">Name of the node</param>
|
|
/// <returns>True if the node is complete</returns>
|
|
public bool IsComplete(string NodeName)
|
|
{
|
|
// Check if it already exists locally
|
|
FileReference LocalFile = GetCompleteMarkerFile(LocalDir, NodeName);
|
|
if(FileReference.Exists(LocalFile))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
// Check if it exists in shared storage
|
|
if(SharedDir != null)
|
|
{
|
|
FileReference SharedFile = GetCompleteMarkerFile(SharedDir, NodeName);
|
|
if(FileReference.Exists(SharedFile))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// Otherwise we don't have any data
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mark the given node as complete
|
|
/// </summary>
|
|
/// <param name="NodeName">Name of the node</param>
|
|
public void MarkAsComplete(string NodeName)
|
|
{
|
|
// Create the marker locally
|
|
FileReference LocalFile = GetCompleteMarkerFile(LocalDir, NodeName);
|
|
DirectoryReference.CreateDirectory(LocalFile.Directory);
|
|
File.OpenWrite(LocalFile.FullName).Close();
|
|
|
|
// Create the marker in the shared directory
|
|
if(SharedDir != null && bWriteToSharedStorage)
|
|
{
|
|
FileReference SharedFile = GetCompleteMarkerFile(SharedDir, NodeName);
|
|
DirectoryReference.CreateDirectory(SharedFile.Directory);
|
|
File.OpenWrite(SharedFile.FullName).Close();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks the integrity of the give node's local build products.
|
|
/// </summary>
|
|
/// <param name="NodeName">The node to retrieve build products for</param>
|
|
/// <param name="TagNames">List of tag names from this node.</param>
|
|
/// <returns>True if the node is complete and valid, false if not (and typically followed by a call to CleanNode()).</returns>
|
|
public bool CheckLocalIntegrity(string NodeName, IEnumerable<string> TagNames)
|
|
{
|
|
// If the node is not locally complete, fail immediately.
|
|
FileReference CompleteMarkerFile = GetCompleteMarkerFile(LocalDir, NodeName);
|
|
if(!FileReference.Exists(CompleteMarkerFile))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check that each of the tags exist
|
|
HashSet<TempStorageBlock> Blocks = new HashSet<TempStorageBlock>();
|
|
foreach(string TagName in TagNames)
|
|
{
|
|
// Check the local manifest exists
|
|
FileReference LocalFileListLocation = GetTaggedFileListLocation(LocalDir, NodeName, TagName);
|
|
if(!FileReference.Exists(LocalFileListLocation))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check the local manifest matches the shared manifest
|
|
if(SharedDir != null)
|
|
{
|
|
// Check the shared manifest exists
|
|
FileReference SharedFileListLocation = GetManifestLocation(SharedDir, NodeName, TagName);
|
|
if(!FileReference.Exists(SharedFileListLocation))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check the manifests are identical, byte by byte
|
|
byte[] LocalManifestBytes = File.ReadAllBytes(LocalFileListLocation.FullName);
|
|
byte[] SharedManifestBytes = File.ReadAllBytes(SharedFileListLocation.FullName);
|
|
if(!LocalManifestBytes.SequenceEqual(SharedManifestBytes))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Read the manifest and add the referenced blocks to be checked
|
|
TempStorageFileList LocalFileList = TempStorageFileList.Load(LocalFileListLocation);
|
|
Blocks.UnionWith(LocalFileList.Blocks);
|
|
}
|
|
|
|
// Check that each of the outputs match
|
|
foreach(TempStorageBlock Block in Blocks)
|
|
{
|
|
// Check the local manifest exists
|
|
FileReference LocalManifestFile = GetManifestLocation(LocalDir, Block.NodeName, Block.OutputName);
|
|
if(!FileReference.Exists(LocalManifestFile))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check the local manifest matches the shared manifest
|
|
if(SharedDir != null)
|
|
{
|
|
// Check the shared manifest exists
|
|
FileReference SharedManifestFile = GetManifestLocation(SharedDir, Block.NodeName, Block.OutputName);
|
|
if(!FileReference.Exists(SharedManifestFile))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check the manifests are identical, byte by byte
|
|
byte[] LocalManifestBytes = File.ReadAllBytes(LocalManifestFile.FullName);
|
|
byte[] SharedManifestBytes = File.ReadAllBytes(SharedManifestFile.FullName);
|
|
if(!LocalManifestBytes.SequenceEqual(SharedManifestBytes))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Read the manifest and check the files
|
|
TempStorageManifest LocalManifest = TempStorageManifest.Load(LocalManifestFile);
|
|
|
|
|
|
|
|
if(LocalManifest.Files.Any(x => !x.Compare(RootDir)))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Reads a set of tagged files from disk
|
|
/// </summary>
|
|
/// <param name="NodeName">Name of the node which produced the tag set</param>
|
|
/// <param name="TagName">Name of the tag, with a '#' prefix</param>
|
|
/// <returns>The set of files</returns>
|
|
public TempStorageFileList ReadFileList(string NodeName, string TagName)
|
|
{
|
|
TempStorageFileList FileList;
|
|
|
|
// Try to read the tag set from the local directory
|
|
FileReference LocalFileListLocation = GetTaggedFileListLocation(LocalDir, NodeName, TagName);
|
|
if(FileReference.Exists(LocalFileListLocation))
|
|
{
|
|
CommandUtils.Log("Reading local file list from {0}", LocalFileListLocation.FullName);
|
|
FileList = TempStorageFileList.Load(LocalFileListLocation);
|
|
}
|
|
else
|
|
{
|
|
// Check we have shared storage
|
|
if(SharedDir == null)
|
|
{
|
|
throw new AutomationException("Missing local file list - {0}", LocalFileListLocation.FullName);
|
|
}
|
|
|
|
// Make sure the manifest exists
|
|
FileReference SharedFileListLocation = GetTaggedFileListLocation(SharedDir, NodeName, TagName);
|
|
if(!FileReference.Exists(SharedFileListLocation))
|
|
{
|
|
throw new AutomationException("Missing local or shared file list - {0}", SharedFileListLocation.FullName);
|
|
}
|
|
|
|
// Read the shared manifest
|
|
CommandUtils.Log("Copying shared tag set from {0} to {1}", SharedFileListLocation.FullName, LocalFileListLocation.FullName);
|
|
FileList = TempStorageFileList.Load(SharedFileListLocation);
|
|
|
|
// Save the manifest locally
|
|
DirectoryReference.CreateDirectory(LocalFileListLocation.Directory);
|
|
FileList.Save(LocalFileListLocation);
|
|
}
|
|
return FileList;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Writes a list of tagged files to disk
|
|
/// </summary>
|
|
/// <param name="NodeName">Name of the node which produced the tag set</param>
|
|
/// <param name="TagName">Name of the tag, with a '#' prefix</param>
|
|
/// <param name="Files">List of files in this set</param>
|
|
/// <param name="Blocks">List of referenced storage blocks</param>
|
|
/// <returns>The set of files</returns>
|
|
public void WriteFileList(string NodeName, string TagName, IEnumerable<FileReference> Files, IEnumerable<TempStorageBlock> Blocks)
|
|
{
|
|
// Create the file list
|
|
TempStorageFileList FileList = new TempStorageFileList(Files, RootDir, Blocks);
|
|
|
|
// Save the set of files to the local and shared locations
|
|
FileReference LocalFileListLocation = GetTaggedFileListLocation(LocalDir, NodeName, TagName);
|
|
if(SharedDir != null && bWriteToSharedStorage)
|
|
{
|
|
FileReference SharedFileListLocation = GetTaggedFileListLocation(SharedDir, NodeName, TagName);
|
|
CommandUtils.Log("Saving file list to {0} and {1}", LocalFileListLocation.FullName, SharedFileListLocation.FullName);
|
|
|
|
DirectoryReference.CreateDirectory(SharedFileListLocation.Directory);
|
|
FileList.Save(SharedFileListLocation);
|
|
}
|
|
else
|
|
{
|
|
CommandUtils.Log("Saving file list to {0}", LocalFileListLocation.FullName);
|
|
}
|
|
|
|
// Save the local file list
|
|
DirectoryReference.CreateDirectory(LocalFileListLocation.Directory);
|
|
FileList.Save(LocalFileListLocation);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Saves the given files (that should be rooted at the branch root) to a shared temp storage manifest with the given temp storage node and game.
|
|
/// </summary>
|
|
/// <param name="NodeName">The node which created the storage block</param>
|
|
/// <param name="BlockName">Name of the block to retrieve. May be null or empty.</param>
|
|
/// <param name="BuildProducts">Array of build products to be archived</param>
|
|
/// <param name="bPushToRemote">Allow skipping the copying of this manifest to shared storage, because it's not required by any other agent</param>
|
|
/// <returns>The created manifest instance (which has already been saved to disk).</returns>
|
|
public TempStorageManifest Archive(string NodeName, string BlockName, FileReference[] BuildProducts, bool bPushToRemote = true)
|
|
{
|
|
using(TelemetryStopwatch TelemetryStopwatch = new TelemetryStopwatch("StoreToTempStorage"))
|
|
{
|
|
// Create a manifest for the given build products
|
|
FileInfo[] Files = BuildProducts.Select(x => new FileInfo(x.FullName)).ToArray();
|
|
TempStorageManifest Manifest = new TempStorageManifest(Files, RootDir);
|
|
|
|
// Create the local directory for this node
|
|
DirectoryReference LocalNodeDir = GetDirectoryForNode(LocalDir, NodeName);
|
|
DirectoryReference.CreateDirectory(LocalNodeDir);
|
|
|
|
// Compress the files and copy to shared storage if necessary
|
|
bool bRemote = SharedDir != null && bPushToRemote && bWriteToSharedStorage;
|
|
if(bRemote)
|
|
{
|
|
// Create the shared directory for this node
|
|
FileReference SharedManifestFile = GetManifestLocation(SharedDir, NodeName, BlockName);
|
|
DirectoryReference.CreateDirectory(SharedManifestFile.Directory);
|
|
|
|
// Zip all the build products
|
|
FileInfo[] ZipFiles = ParallelZipFiles(Files, RootDir, SharedManifestFile.Directory, LocalNodeDir, SharedManifestFile.GetFileNameWithoutExtension());
|
|
Manifest.ZipFiles = ZipFiles.Select(x => new TempStorageZipFile(x)).ToArray();
|
|
|
|
// Save the shared manifest
|
|
CommandUtils.Log("Saving shared manifest to {0}", SharedManifestFile.FullName);
|
|
Manifest.Save(SharedManifestFile);
|
|
}
|
|
|
|
// Save the local manifest
|
|
FileReference LocalManifestFile = GetManifestLocation(LocalDir, NodeName, BlockName);
|
|
CommandUtils.Log("Saving local manifest to {0}", LocalManifestFile.FullName);
|
|
Manifest.Save(LocalManifestFile);
|
|
|
|
// Update the stats
|
|
long ZipFilesTotalSize = (Manifest.ZipFiles == null)? 0 : Manifest.ZipFiles.Sum(x => x.Length);
|
|
TelemetryStopwatch.Finish(string.Format("StoreToTempStorage.{0}.{1}.{2}.{3}.{4}.{5}.{6}", Files.Length, Manifest.GetTotalSize(), ZipFilesTotalSize, bRemote? "Remote" : "Local", 0, 0, BlockName));
|
|
return Manifest;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieve an output of the given node. Fetches and decompresses the files from shared storage if necessary, or validates the local files.
|
|
/// </summary>
|
|
/// <param name="NodeName">The node which created the storage block</param>
|
|
/// <param name="OutputName">Name of the block to retrieve. May be null or empty.</param>
|
|
/// <returns>Manifest of the files retrieved</returns>
|
|
public TempStorageManifest Retreive(string NodeName, string OutputName)
|
|
{
|
|
using(var TelemetryStopwatch = new TelemetryStopwatch("RetrieveFromTempStorage"))
|
|
{
|
|
// Get the path to the local manifest
|
|
FileReference LocalManifestFile = GetManifestLocation(LocalDir, NodeName, OutputName);
|
|
bool bLocal = FileReference.Exists(LocalManifestFile);
|
|
|
|
// Read the manifest, either from local storage or shared storage
|
|
TempStorageManifest Manifest;
|
|
if(bLocal)
|
|
{
|
|
CommandUtils.Log("Reading shared manifest from {0}", LocalManifestFile.FullName);
|
|
Manifest = TempStorageManifest.Load(LocalManifestFile);
|
|
}
|
|
else
|
|
{
|
|
// Check we have shared storage
|
|
if(SharedDir == null)
|
|
{
|
|
throw new AutomationException("Missing local manifest for node - {0}", LocalManifestFile.FullName);
|
|
}
|
|
|
|
// Get the shared directory for this node
|
|
FileReference SharedManifestFile = GetManifestLocation(SharedDir, NodeName, OutputName);
|
|
|
|
// Make sure the manifest exists
|
|
if(!FileReference.Exists(SharedManifestFile))
|
|
{
|
|
throw new AutomationException("Missing local or shared manifest for node - {0}", SharedManifestFile.FullName);
|
|
}
|
|
|
|
// Read the shared manifest
|
|
CommandUtils.Log("Copying shared manifest from {0} to {1}", SharedManifestFile.FullName, LocalManifestFile.FullName);
|
|
Manifest = TempStorageManifest.Load(SharedManifestFile);
|
|
|
|
// Unzip all the build products
|
|
DirectoryReference SharedNodeDir = GetDirectoryForNode(SharedDir, NodeName);
|
|
FileInfo[] ZipFiles = Manifest.ZipFiles.Select(x => new FileInfo(FileReference.Combine(SharedNodeDir, x.Name).FullName)).ToArray();
|
|
ParallelUnzipFiles(ZipFiles, RootDir);
|
|
|
|
// Fix any Unix permissions/chmod issues, and update the timestamps to match the manifest. Zip files only use local time, and there's no guarantee it matches the local clock.
|
|
foreach(TempStorageFile ManifestFile in Manifest.Files)
|
|
{
|
|
FileReference File = ManifestFile.ToFileReference(RootDir);
|
|
if (Utils.IsRunningOnMono)
|
|
{
|
|
CommandUtils.FixUnixFilePermissions(File.FullName);
|
|
}
|
|
System.IO.File.SetLastWriteTimeUtc(File.FullName, new DateTime(ManifestFile.LastWriteTimeUtcTicks, DateTimeKind.Utc));
|
|
}
|
|
|
|
// Save the manifest locally
|
|
DirectoryReference.CreateDirectory(LocalManifestFile.Directory);
|
|
Manifest.Save(LocalManifestFile);
|
|
}
|
|
|
|
// Check all the local files are as expected
|
|
bool bAllMatch = true;
|
|
foreach(TempStorageFile File in Manifest.Files)
|
|
{
|
|
bAllMatch &= File.Compare(RootDir);
|
|
}
|
|
if(!bAllMatch)
|
|
{
|
|
throw new AutomationException("Files have been modified");
|
|
}
|
|
|
|
// Update the stats and return
|
|
TelemetryStopwatch.Finish(string.Format("RetrieveFromTempStorage.{0}.{1}.{2}.{3}.{4}.{5}.{6}", Manifest.Files.Length, Manifest.Files.Sum(x => x.Length), bLocal? 0 : Manifest.ZipFiles.Sum(x => x.Length), bLocal? "Local" : "Remote", 0, 0, OutputName));
|
|
return Manifest;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Zips a set of files (that must be rooted at the given RootDir) to a set of zip files in the given OutputDir. The files will be prefixed with the given basename.
|
|
/// </summary>
|
|
/// <param name="InputFiles">Fully qualified list of files to zip (must be rooted at RootDir).</param>
|
|
/// <param name="RootDir">Root Directory where all files will be extracted.</param>
|
|
/// <param name="OutputDir">Location to place the set of zip files created.</param>
|
|
/// <param name="StagingDir">Location to create zip files before copying them to the OutputDir. If the OutputDir is on a remote file share, staging may be more efficient. Use null to avoid using a staging copy.</param>
|
|
/// <param name="ZipBaseName">The basename of the set of zip files.</param>
|
|
/// <returns>Some metrics about the zip process.</returns>
|
|
/// <remarks>
|
|
/// This function tries to zip the files in parallel as fast as it can. It makes no guarantees about how many zip files will be created or which files will be in which zip,
|
|
/// but it does try to reasonably balance the file sizes.
|
|
/// </remarks>
|
|
private static FileInfo[] ParallelZipFiles(FileInfo[] InputFiles, DirectoryReference RootDir, DirectoryReference OutputDir, DirectoryReference StagingDir, string ZipBaseName)
|
|
{
|
|
// First get the sizes of all the files. We won't parallelize if there isn't enough data to keep the number of zips down.
|
|
var FilesInfo = InputFiles
|
|
.Select(InputFile => new { File = new FileReference(InputFile), FileSize = InputFile.Length })
|
|
.ToList();
|
|
|
|
// Profiling results show that we can zip 100MB quite fast and it is not worth parallelizing that case and creating a bunch of zips that are relatively small.
|
|
const long MinFileSizeToZipInParallel = 1024 * 1024 * 100L;
|
|
var bZipInParallel = FilesInfo.Sum(FileInfo => FileInfo.FileSize) >= MinFileSizeToZipInParallel;
|
|
|
|
// order the files in descending order so our threads pick up the biggest ones first.
|
|
// We want to end with the smaller files to more effectively fill in the gaps
|
|
var FilesToZip = new ConcurrentQueue<FileReference>(FilesInfo.OrderByDescending(FileInfo => FileInfo.FileSize).Select(FileInfo => FileInfo.File));
|
|
|
|
// We deliberately avoid Parallel.ForEach here because profiles have shown that dynamic partitioning creates
|
|
// too many zip files, and they can be of too varying size, creating uneven work when unzipping later,
|
|
// as ZipFile cannot unzip files in parallel from a single archive.
|
|
// We can safely assume the build system will not be doing more important things at the same time, so we simply use all our logical cores,
|
|
// which has shown to be optimal via profiling, and limits the number of resulting zip files to the number of logical cores.
|
|
//
|
|
// Sadly, mono implementation of System.IO.Compression is really poor (as of 2015/Aug), causing OOM when parallel zipping a large set of files.
|
|
// However, Ionic is MUCH slower than .NET's native implementation (2x+ slower in our build farm), so we stick to the faster solution on PC.
|
|
// The code duplication in the threadprocs is unfortunate here, and hopefully we can settle on .NET's implementation on both platforms eventually.
|
|
List<Thread> ZipThreads;
|
|
|
|
ConcurrentBag<FileInfo> ZipFiles = new ConcurrentBag<FileInfo>();
|
|
|
|
DirectoryReference ZipDir = StagingDir ?? OutputDir;
|
|
if (Utils.IsRunningOnMono)
|
|
{
|
|
ZipThreads = (
|
|
from CoreNum in Enumerable.Range(0, bZipInParallel ? Environment.ProcessorCount : 1)
|
|
let ZipFileName = FileReference.Combine(ZipDir, string.Format("{0}{1}.zip", ZipBaseName, bZipInParallel ? "-" + CoreNum.ToString("00") : ""))
|
|
select new Thread(() =>
|
|
{
|
|
// don't create the zip unless we have at least one file to add
|
|
FileReference File;
|
|
if (FilesToZip.TryDequeue(out File))
|
|
{
|
|
// Create one zip per thread using the given basename
|
|
using (var ZipArchive = new Ionic.Zip.ZipFile(ZipFileName.FullName) { CompressionLevel = Ionic.Zlib.CompressionLevel.BestSpeed })
|
|
{
|
|
|
|
// pull from the queue until we are out of files.
|
|
do
|
|
{
|
|
// use fastest compression. In our best case we are CPU bound, so this is a good tradeoff,
|
|
// cutting overall time by 2/3 while only modestly increasing the compression ratio (22.7% -> 23.8% for RootEditor PDBs).
|
|
// This is in cases of a super hot cache, so the operation was largely CPU bound.
|
|
ZipArchive.AddFile(File.FullName, CommandUtils.ConvertSeparators(PathSeparator.Slash, File.Directory.MakeRelativeTo(RootDir)));
|
|
} while (FilesToZip.TryDequeue(out File));
|
|
ZipArchive.Save();
|
|
}
|
|
// if we are using a staging dir, copy to the final location and delete the staged copy.
|
|
FileInfo ZipFile = new FileInfo(ZipFileName.FullName);
|
|
if (StagingDir != null)
|
|
{
|
|
FileInfo NewZipFile = ZipFile.CopyTo(CommandUtils.MakeRerootedFilePath(ZipFile.FullName, StagingDir.FullName, OutputDir.FullName));
|
|
ZipFile.Delete();
|
|
ZipFile = NewZipFile;
|
|
}
|
|
ZipFiles.Add(ZipFile);
|
|
}
|
|
})).ToList();
|
|
}
|
|
else
|
|
{
|
|
ZipThreads = (
|
|
from CoreNum in Enumerable.Range(0, bZipInParallel ? Environment.ProcessorCount : 1)
|
|
let ZipFileName = FileReference.Combine(ZipDir, string.Format("{0}{1}.zip", ZipBaseName, bZipInParallel ? "-" + CoreNum.ToString("00") : ""))
|
|
select new Thread(() =>
|
|
{
|
|
// don't create the zip unless we have at least one file to add
|
|
FileReference File;
|
|
if (FilesToZip.TryDequeue(out File))
|
|
{
|
|
// Create one zip per thread using the given basename
|
|
using (var ZipArchive = System.IO.Compression.ZipFile.Open(ZipFileName.FullName, System.IO.Compression.ZipArchiveMode.Create))
|
|
{
|
|
|
|
// pull from the queue until we are out of files.
|
|
do
|
|
{
|
|
// use fastest compression. In our best case we are CPU bound, so this is a good tradeoff,
|
|
// cutting overall time by 2/3 while only modestly increasing the compression ratio (22.7% -> 23.8% for RootEditor PDBs).
|
|
// This is in cases of a super hot cache, so the operation was largely CPU bound.
|
|
// Also, sadly, mono appears to have a bug where nothing you can do will properly set the LastWriteTime on the created entry,
|
|
// so we have to ignore timestamps on files extracted from a zip, since it may have been created on a Mac.
|
|
ZipFileExtensions.CreateEntryFromFile(ZipArchive, File.FullName, CommandUtils.ConvertSeparators(PathSeparator.Slash, File.MakeRelativeTo(RootDir)), System.IO.Compression.CompressionLevel.Fastest);
|
|
} while (FilesToZip.TryDequeue(out File));
|
|
}
|
|
// if we are using a staging dir, copy to the final location and delete the staged copy.
|
|
FileInfo ZipFile = new FileInfo(ZipFileName.FullName);
|
|
if (StagingDir != null)
|
|
{
|
|
FileInfo NewZipFile = ZipFile.CopyTo(CommandUtils.MakeRerootedFilePath(ZipFile.FullName, StagingDir.FullName, OutputDir.FullName));
|
|
ZipFile.Delete();
|
|
ZipFile = NewZipFile;
|
|
}
|
|
ZipFiles.Add(ZipFile);
|
|
}
|
|
})).ToList();
|
|
}
|
|
ZipThreads.ForEach(thread => thread.Start());
|
|
ZipThreads.ForEach(thread => thread.Join());
|
|
|
|
return ZipFiles.OrderBy(x => x.Name).ToArray();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Unzips a set of zip files with a given basename in a given folder to a given RootDir.
|
|
/// </summary>
|
|
/// <param name="ZipFiles">Files to extract</param>
|
|
/// <param name="RootDir">Root Directory where all files will be extracted.</param>
|
|
/// <returns>Some metrics about the unzip process.</returns>
|
|
/// <remarks>
|
|
/// The code is expected to be the used as the symmetrical inverse of <see cref="ParallelZipFiles"/>, but could be used independently, as long as the files in the zip do not overlap.
|
|
/// </remarks>
|
|
private static void ParallelUnzipFiles(FileInfo[] ZipFiles, DirectoryReference RootDir)
|
|
{
|
|
// Sadly, mono implemention of System.IO.Compression is really poor (as of 2015/Aug), causing OOM when parallel zipping a large set of files.
|
|
// However, Ionic is MUCH slower than .NET's native implementation (2x+ slower in our build farm), so we stick to the faster solution on PC.
|
|
// The code duplication in the threadprocs is unfortunate here, and hopefully we can settle on .NET's implementation on both platforms eventually.
|
|
if (Utils.IsRunningOnMono)
|
|
{
|
|
Parallel.ForEach(ZipFiles,
|
|
(ZipFile) =>
|
|
{
|
|
using (var ZipArchive = Ionic.Zip.ZipFile.Read(ZipFile.FullName))
|
|
{
|
|
ZipArchive.ExtractAll(RootDir.FullName, Ionic.Zip.ExtractExistingFileAction.OverwriteSilently);
|
|
}
|
|
});
|
|
}
|
|
else
|
|
{
|
|
Parallel.ForEach(ZipFiles,
|
|
(ZipFile) =>
|
|
{
|
|
// unzip the files manually instead of caling ZipFile.ExtractToDirectory() because we need to overwrite readonly files. Because of this, creating the directories is up to us as well.
|
|
using (var ZipArchive = System.IO.Compression.ZipFile.OpenRead(ZipFile.FullName))
|
|
{
|
|
foreach (var Entry in ZipArchive.Entries)
|
|
{
|
|
// Use CommandUtils.CombinePaths to ensure directory separators get converted correctly. On mono on *nix, if the path has backslashes it will not convert it.
|
|
var ExtractedFilename = CommandUtils.CombinePaths(RootDir.FullName, Entry.FullName);
|
|
// Zips can contain empty dirs. Ours usually don't have them, but we should support it.
|
|
if (Path.GetFileName(ExtractedFilename).Length == 0)
|
|
{
|
|
Directory.CreateDirectory(ExtractedFilename);
|
|
}
|
|
else
|
|
{
|
|
// We must delete any existing file, even if it's readonly. .Net does not do this by default.
|
|
if (File.Exists(ExtractedFilename))
|
|
{
|
|
InternalUtils.SafeDeleteFile(ExtractedFilename, true);
|
|
}
|
|
else
|
|
{
|
|
Directory.CreateDirectory(Path.GetDirectoryName(ExtractedFilename));
|
|
}
|
|
Entry.ExtractToFile(ExtractedFilename, true);
|
|
}
|
|
}
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the directory used to store data for the given node
|
|
/// </summary>
|
|
/// <param name="BaseDir">A local or shared temp storage root directory.</param>
|
|
/// <param name="NodeName">Name of the node</param>
|
|
/// <returns>Directory to contain a node's data</returns>
|
|
static DirectoryReference GetDirectoryForNode(DirectoryReference BaseDir, string NodeName)
|
|
{
|
|
return DirectoryReference.Combine(BaseDir, NodeName);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path to the manifest created for a node's output.
|
|
/// </summary>
|
|
/// <param name="BaseDir">A local or shared temp storage root directory.</param>
|
|
/// <param name="NodeName">Name of the node to get the file for</param>
|
|
/// <param name="BlockName">Name of the output block to get the manifest for</param>
|
|
static FileReference GetManifestLocation(DirectoryReference BaseDir, string NodeName, string BlockName)
|
|
{
|
|
return FileReference.Combine(BaseDir, NodeName, String.IsNullOrEmpty(BlockName)? "Manifest.xml" : String.Format("Manifest-{0}.xml", BlockName));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path to the file created to store a tag manifest for a node
|
|
/// </summary>
|
|
/// <param name="BaseDir">A local or shared temp storage root directory.</param>
|
|
/// <param name="NodeName">Name of the node to get the file for</param>
|
|
/// <param name="TagName">Name of the tag to get the manifest for</param>
|
|
static FileReference GetTaggedFileListLocation(DirectoryReference BaseDir, string NodeName, string TagName)
|
|
{
|
|
Debug.Assert(TagName.StartsWith("#"));
|
|
return FileReference.Combine(BaseDir, NodeName, String.Format("Tag-{0}.xml", TagName.Substring(1)));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path to a file created to indicate that a node is complete, under the given base directory.
|
|
/// </summary>
|
|
/// <param name="BaseDir">A local or shared temp storage root directory.</param>
|
|
/// <param name="NodeName">Name of the node to get the file for</param>
|
|
static FileReference GetCompleteMarkerFile(DirectoryReference BaseDir, string NodeName)
|
|
{
|
|
return FileReference.Combine(GetDirectoryForNode(BaseDir, NodeName), "Complete");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Automated tests for temp storage
|
|
/// </summary>
|
|
class TempStorageTests : BuildCommand
|
|
{
|
|
/// <summary>
|
|
/// Run the automated tests
|
|
/// </summary>
|
|
public override void ExecuteBuild()
|
|
{
|
|
// Get all the shared directories
|
|
DirectoryReference RootDir = new DirectoryReference(CommandUtils.CmdEnv.LocalRoot);
|
|
|
|
DirectoryReference LocalDir = DirectoryReference.Combine(RootDir, "Engine", "Saved", "TestTempStorage-Local");
|
|
CommandUtils.CreateDirectory_NoExceptions(LocalDir.FullName);
|
|
CommandUtils.DeleteDirectoryContents(LocalDir.FullName);
|
|
|
|
DirectoryReference SharedDir = DirectoryReference.Combine(RootDir, "Engine", "Saved", "TestTempStorage-Shared");
|
|
CommandUtils.CreateDirectory_NoExceptions(SharedDir.FullName);
|
|
CommandUtils.DeleteDirectoryContents(SharedDir.FullName);
|
|
|
|
DirectoryReference WorkingDir = DirectoryReference.Combine(RootDir, "Engine", "Saved", "TestTempStorage-Working");
|
|
CommandUtils.CreateDirectory_NoExceptions(WorkingDir.FullName);
|
|
CommandUtils.DeleteDirectoryContents(WorkingDir.FullName);
|
|
|
|
// Create the temp storage object
|
|
TempStorage TempStore = new TempStorage(WorkingDir, LocalDir, SharedDir, true);
|
|
|
|
// Create a working directory, and copy some source files into it
|
|
DirectoryReference SourceDir = DirectoryReference.Combine(RootDir, "Engine", "Source", "Runtime");
|
|
if(!CommandUtils.CopyDirectory_NoExceptions(SourceDir.FullName, WorkingDir.FullName, true))
|
|
{
|
|
throw new AutomationException("Couldn't copy {0} to {1}", SourceDir.FullName, WorkingDir.FullName);
|
|
}
|
|
|
|
// Save the default output
|
|
Dictionary<FileReference, DateTime> DefaultOutput = SelectFiles(WorkingDir, 'a', 'f');
|
|
TempStore.Archive("TestNode", null, DefaultOutput.Keys.ToArray(), false);
|
|
|
|
Dictionary<FileReference, DateTime> NamedOutput = SelectFiles(WorkingDir, 'g', 'i');
|
|
TempStore.Archive("TestNode", "NamedOutput", NamedOutput.Keys.ToArray(), true);
|
|
|
|
// Check both outputs are still ok
|
|
TempStorageManifest DefaultManifest = TempStore.Retreive("TestNode", null);
|
|
CheckManifest(WorkingDir, DefaultManifest, DefaultOutput);
|
|
|
|
TempStorageManifest NamedManifest = TempStore.Retreive("TestNode", "NamedOutput");
|
|
CheckManifest(WorkingDir, NamedManifest, NamedOutput);
|
|
|
|
// Delete local temp storage and the working directory and try again
|
|
CommandUtils.Log("Clearing local folders...");
|
|
CommandUtils.DeleteDirectoryContents(WorkingDir.FullName);
|
|
CommandUtils.DeleteDirectoryContents(LocalDir.FullName);
|
|
|
|
// First output should fail
|
|
CommandUtils.Log("Checking default manifest is now unavailable...");
|
|
bool bGotManifest = false;
|
|
try
|
|
{
|
|
TempStore.Retreive("TestNode", null);
|
|
bGotManifest = true;
|
|
}
|
|
catch
|
|
{
|
|
bGotManifest = false;
|
|
}
|
|
if(bGotManifest)
|
|
{
|
|
throw new AutomationException("Did not expect shared temp storage manifest to exist");
|
|
}
|
|
|
|
// Second one should be fine
|
|
TempStorageManifest NamedManifestFromShared = TempStore.Retreive("TestNode", "NamedOutput");
|
|
CheckManifest(WorkingDir, NamedManifestFromShared, NamedOutput);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Enumerate all the files beginning with a letter within a certain range
|
|
/// </summary>
|
|
/// <param name="SourceDir">The directory to read from</param>
|
|
/// <param name="CharRangeBegin">First character in the range to files to return</param>
|
|
/// <param name="CharRangeEnd">Last character (inclusive) in the range of files to return</param>
|
|
/// <returns>Mapping from filename to timestamp</returns>
|
|
static Dictionary<FileReference, DateTime> SelectFiles(DirectoryReference SourceDir, char CharRangeBegin, char CharRangeEnd)
|
|
{
|
|
Dictionary<FileReference, DateTime> ArchiveFileToTime = new Dictionary<FileReference,DateTime>();
|
|
foreach(FileInfo FileInfo in new DirectoryInfo(SourceDir.FullName).EnumerateFiles("*", SearchOption.AllDirectories))
|
|
{
|
|
char FirstCharacter = Char.ToLower(FileInfo.Name[0]);
|
|
if(FirstCharacter >= CharRangeBegin && FirstCharacter <= CharRangeEnd)
|
|
{
|
|
ArchiveFileToTime.Add(new FileReference(FileInfo), FileInfo.LastWriteTimeUtc);
|
|
}
|
|
}
|
|
return ArchiveFileToTime;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks that a manifest matches the files on disk
|
|
/// </summary>
|
|
/// <param name="RootDir">Root directory for relative paths in the manifest</param>
|
|
/// <param name="Manifest">Manifest to check</param>
|
|
/// <param name="Files">Mapping of filename to timestamp as expected in the manifest</param>
|
|
static void CheckManifest(DirectoryReference RootDir, TempStorageManifest Manifest, Dictionary<FileReference, DateTime> Files)
|
|
{
|
|
if(Files.Count != Manifest.Files.Length)
|
|
{
|
|
throw new AutomationException("Number of files in manifest does not match");
|
|
}
|
|
foreach(TempStorageFile ManifestFile in Manifest.Files)
|
|
{
|
|
FileReference File = ManifestFile.ToFileReference(RootDir);
|
|
if(!FileReference.Exists(File))
|
|
{
|
|
throw new AutomationException("File in manifest does not exist");
|
|
}
|
|
|
|
DateTime OriginalTime;
|
|
if(!Files.TryGetValue(File, out OriginalTime))
|
|
{
|
|
throw new AutomationException("File in manifest did not exist previously");
|
|
}
|
|
|
|
double DiffSeconds = (new FileInfo(File.FullName).LastWriteTimeUtc - OriginalTime).TotalSeconds;
|
|
if(Math.Abs(DiffSeconds) > 2)
|
|
{
|
|
throw new AutomationException("Incorrect timestamp for {0}", ManifestFile.RelativePath);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
/// <summary>
|
|
/// Commandlet to clean up all folders under a temp storage root that are older than a given number of days
|
|
/// </summary>
|
|
[Help("Removes folders in a given temp storage directory that are older than a certain time.")]
|
|
[Help("TempStorageDir=<Directory>", "Path to the root temp storage directory")]
|
|
[Help("Days=<N>", "Number of days to keep in temp storage")]
|
|
class CleanTempStorage : BuildCommand
|
|
{
|
|
/// <summary>
|
|
/// Entry point for the commandlet
|
|
/// </summary>
|
|
public override void ExecuteBuild()
|
|
{
|
|
string TempStorageDir = ParseParamValue("TempStorageDir", null);
|
|
if (TempStorageDir == null)
|
|
{
|
|
throw new AutomationException("Missing -TempStorageDir parameter");
|
|
}
|
|
|
|
string Days = ParseParamValue("Days", null);
|
|
if (Days == null)
|
|
{
|
|
throw new AutomationException("Missing -Days parameter");
|
|
}
|
|
|
|
double DaysValue;
|
|
if (!Double.TryParse(Days, out DaysValue))
|
|
{
|
|
throw new AutomationException("'{0}' is not a valid value for the -Days parameter", Days);
|
|
}
|
|
|
|
DateTime RetainTime = DateTime.UtcNow - TimeSpan.FromDays(DaysValue);
|
|
|
|
// Enumerate all the build directories
|
|
CommandUtils.Log("Scanning {0}...", TempStorageDir);
|
|
int NumBuilds = 0;
|
|
List<DirectoryInfo> BuildsToDelete = new List<DirectoryInfo>();
|
|
foreach (DirectoryInfo StreamDirectory in new DirectoryInfo(TempStorageDir).EnumerateDirectories().OrderBy(x => x.Name))
|
|
{
|
|
CommandUtils.Log("Scanning {0}...", StreamDirectory.FullName);
|
|
foreach (DirectoryInfo BuildDirectory in StreamDirectory.EnumerateDirectories())
|
|
{
|
|
if(!BuildDirectory.EnumerateFiles("*", SearchOption.AllDirectories).Any(x => x.LastWriteTimeUtc > RetainTime))
|
|
{
|
|
BuildsToDelete.Add(BuildDirectory);
|
|
}
|
|
NumBuilds++;
|
|
}
|
|
}
|
|
CommandUtils.Log("Found {0} builds; {1} to delete.", NumBuilds, BuildsToDelete.Count);
|
|
|
|
// Loop through them all, checking for files older than the delete time
|
|
for (int Idx = 0; Idx < BuildsToDelete.Count; Idx++)
|
|
{
|
|
try
|
|
{
|
|
CommandUtils.Log("[{0}/{1}] Deleting {2}...", Idx + 1, BuildsToDelete.Count, BuildsToDelete[Idx].FullName);
|
|
BuildsToDelete[Idx].Delete(true);
|
|
}
|
|
catch (Exception Ex)
|
|
{
|
|
CommandUtils.LogWarning("Failed to delete old manifest folder; will try one file at a time: {0}", Ex);
|
|
CommandUtils.DeleteDirectory_NoExceptions(true, BuildsToDelete[Idx].FullName);
|
|
}
|
|
}
|
|
|
|
// Try to delete any empty branch folders
|
|
foreach (DirectoryInfo StreamDirectory in new DirectoryInfo(TempStorageDir).EnumerateDirectories())
|
|
{
|
|
if(StreamDirectory.EnumerateDirectories().Count() == 0 && StreamDirectory.EnumerateFiles().Count() == 0)
|
|
{
|
|
try
|
|
{
|
|
StreamDirectory.Delete();
|
|
}
|
|
catch (IOException)
|
|
{
|
|
// only catch "directory is not empty type exceptions, if possible. Best we can do is check for IOException.
|
|
}
|
|
catch (Exception Ex)
|
|
{
|
|
CommandUtils.LogWarning("Unexpected failure trying to delete (potentially empty) stream directory {0}: {1}", StreamDirectory.FullName, Ex);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|