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 3233612 on 2016/12/13 by Ben.Marsh UGS: Fix cases where precompiled binaries are submitted for a content change. Change 3235584 on 2016/12/14 by Ben.Marsh UBT: Deprecate the overridable TargetRules.ShouldUseSharedBuildEnvironment() function; targets should specify which build environment to use by setting the BuildEnvironment field in their constructor instead. Change 3235741 on 2016/12/14 by Ben.Marsh UBT: Deprecate the SetupBinaries() callback on the TargetRules class. Instead of overriding this, targets may override their launch module through the "LaunchModuleName" property in their constructor, and add extra modules to the "ExtraModuleNames" field on the TargetRules object itself. Change 3238176 on 2016/12/16 by Ben.Marsh UBT: New XML config file parser. Now reads once at startup and can be applied to instanced objects rather than global fields, and caches parsed output in a binary form for quicker initialization on subsequent runs. Change 3238249 on 2016/12/16 by Ben.Marsh UBT: Add attribute-driven command line parser. Change 3238462 on 2016/12/16 by Ben.Marsh UBT: Include the Platform, Configuration and Architecture on the TargetRules. Add a constructor which takes the TargetInfo object and deprecate the parameterless one; these fields are currently initialized before invoking the constructor in RulesAssembly. Change 3238564 on 2016/12/16 by Ben.Marsh UBT: Deprecate the ModuleRules constructor which takes a TargetInfo argument. Replace it with a read-only wrapper around the target rules instead, so target-specific configuration options can be read without needing to access global static variables. Also require that it's passed to the base class constructor. Change 3239919 on 2016/12/19 by Ben.Marsh UBT: Remove the "PreferredSubPlatform" property. This is only used for Windows XP support, which is being retired anyway. Having the target define its own architecture is an awkward contractiction to maintain support for, since the target rules are constructed after the architecture already has been determined. Change3240061on 2016/12/19 by Ben.Marsh UBT: Remove ThirdPartyHeaderFinder. I don't think anything is using this any more. Change 3240175 on 2016/12/19 by Ben.Marsh UBT: Add the target name and project file location to the target rules. Change 3240490 on 2016/12/19 by Ben.Marsh UAT: Remove Mac staging code that requires UAT to compile and construct .target.cs files when packaging, to check bUseSteam and bUseCEF3 flags. libsteam_api.dylib is now staged at build time by adding it as a bundle resource, CEF3 is already marked as a runtime dependency by CEF3.build.cs, and UnrealCEFSubProcess.app is already marked as a runtime dependency from WebBrowser.build.cs. Change 3240717 on 2016/12/20 by Ben.Marsh UAT: Allow configuring UAT to run as if on a build machine by passing the -buildmachine argument on the command line. Change 3240718 on 2016/12/20 by Ben.Marsh UAT: Remove target-specific properties that are no longer used by staging (bUsesSlate, bUsesCEF3, etc...). This stuff should all be handled inside UBT. Change 3241002 on 2016/12/20 by Ben.Marsh UBT: Move most target configuration settings from UEBuildConfiguration to TargetRules. This encapsulates target specific settings that will allow instancing multiple targets in the future. To facilitate migration of settings to their new location, "UEBuildConfiguration" is now a property that returns the current target rules instance. Change 3241027 on 2016/12/20 by Ben.Marsh Only copy the Steamworks dylib into the app bundle for monolithic builds. For all other times, just add it as a runtime dependency. Change 3241055 on 2016/12/20 by Ben.Marsh UBT: Only store a ReadOnlyTargetRules object on the instanced build target; finalize the configuration before it's instantiated. Change 3241156 on 2016/12/20 by Ben.Marsh Update SwarmInterface.csproj to .NET framework 4.5, to match what all other C# tools are using. Change 3241205 on 2016/12/20 by Ben.Marsh Replace all uses of TargetRules.TargetType with TargetType. Change 3241881 on 2016/12/21 by Ben.Marsh UBT: Remove project file information from UEBuildContext base class. As configurable properties are moved on to the TargetRules object, it will no longer be a dependency to instantiate the platform with this path. Change 3241895 on 2016/12/21 by Ben.Marsh UBT: Remove toolchain support for Windows XP. Change 3241908 on 2016/12/21 by Ben.Marsh UBT: Move settings for windows targets into a WindowsTargetRules class, which is exposed for targets to modify via the TargetRules.WindowsPlatform field. Change 3242835 on 2016/12/22 by Ben.Marsh UBT: Fix multiple binaries being created if plugins specify module names more than once. MfMedia.uplugin has MfMediaFactory listed twice. Change 3242837 on 2016/12/22 by Ben.Marsh Change UE4EditorServices to include MacSystemIncludes rather than Cocoa.h directly; causes FVector to be defined incorrectly in non-unity builds. Change 3242923 on 2016/12/22 by Ben.Marsh Build: Fixes for conforming incremental workspaces: * P4 have table is now reset before deleting all the files. This prevents Perforce being out of sync if the delete fails for some reason. * Incremental workspaces are skipped when running a clean operation, because they do not have a workspace capture file (causing a full re-sync, always). The "P4 Clean" option is still effective for cleaning these workspaces. Change 3242961 on 2016/12/22 by Ben.Marsh UBT: Move entry points from PreBuildSync() and PostBuildSync() from UEToolChain to UEBuildPlatform, and make the original toolchain versions static. These functions are already at odds with the rest of the data flow within UBT because they rely on global state cached outside the toolchain instance, making assumptions that UBT is only ever going to be invoked with one target that's constructed in the same run and that nothing is being cached (eg. UBT makefiles). Moving them onto UEBuildPlatform simplifies the toolchain lifecycle for other platforms without leaving Mac and IOS any more limited than they were before. Change 3242981 on 2016/12/22 by Ben.Marsh UBT: Remove symbol server handling code into UAT's platform library, since it's never needed from inside UBT. Change 3242999 on 2016/12/22 by Ben.Marsh UBT: Remove the StripSymbols() function from the UEToolChain base class. This functionality is only required by UAT, so it's better suited to being exposed through UAT's modular platform classes. Change 3243022 on 2016/12/22 by Ben.Marsh UBT: Require an instance of the target rules to be able to construct a toolchain in UBT. This will allow configuring toolchain-specific options from the target, using reflection from config files, and the command line. Change 3243083 on 2016/12/22 by Ben.Marsh UBT: Move settings for the Windows compiler version to use onto the Windows-specific target rules. Change 3243090 on 2016/12/22 by Ben.Marsh UBT: Change the third party paths in UEBuildConfiguration to constants. Changing these would not work. Change 3243423 on 2016/12/23 by Ben.Marsh UBT: Move a lot of settings from BuildConfiguration to TargetRules. This allows different targets to have different settings, naturally, and moves converts argument parsing and config to be driven by attributes. Change 3243516 on 2016/12/23 by Ben.Marsh UBT: Remove the ValidateUEBuildConfiguration callback, which is no longer used. (XGE settings validation occurs in XGE.cs) Change 3244020 on 2016/12/28 by Ben.Marsh UBT: Remove the BaseIntermediatePath static property. Precursor to removing RelativeEnginePath and IntermediateFolder properties. Change 3244074 on 2016/12/28 by Ben.Marsh UBT: Remove the RelativeEnginePath variable from BuildConfiguration. UnrealBuildTool.EngineDirectory gives the absolute path, and can be used to construct a relative path when necessary. Change 3244076 on 2016/12/28 by Ben.Marsh UBT: Remove BuildConfiguration.BaseIntermediateFolder; just use a fixed directory everywhere instead. Change 3244083 on 2016/12/28 by Ben.Marsh UBT: Replace FileReference and DirectoryReference instance methods for manipulating files and directories with static methods, to mirror the System.IO.File and System.IO.Directory classes. Change 3244441 on 2016/12/31 by Ben.Marsh UBT: Remove code to force PDBs when building with no debug info under XGE. Verified described symptoms (that it causes PCH generation to be serialized) no longer occur. Change 3244687 on 2017/01/03 by Matthew.Griffin Changed Exception to use FirstInclude.IncludeName as PrecompiledHeaderIncludeFilename can be null when this occurs Change 3246112 on 2017/01/04 by Ben.Marsh UBT: Fix UHT failures building some targets with the -useprecompiled option, due to differences in the order that circularly dependent modules are parsed. Precompiled binaries are now kept in the regular AppBinaries list, but are excluded from the build at the last minute. Also change some checks from IsEngineInstalled() to bUsePrecompiled, to prevent headers being overwritten when running in a non-installed precompiled build. Change 3246223 on 2017/01/04 by Ben.Marsh UBT: Prevent version manifests being overridden if a file is not being built as part of the target. Change 3246387 on 2017/01/04 by Ben.Marsh UBT: Remove BuildConfiguration settings for UnrealCodeAnalyzer. This tool isn't used at the moment, but it's configured using global variables accessed from all over the UBT codebase, making it difficult to refactor the build options into an instanced object. If we bring this tool back from the dead in the future, it should be possible to implement it using the exported JSON target definition or the XGE manifest, similarly to how IncludeTool uses it. Change 3247004 on 2017/01/04 by Ben.Marsh UBT: Simplify the logic for cleaning targets in UBT. Now uses FileReference/DirectoryReference objects everywhere, doesn't require the compile/link environment, and does all the checking to avoid deleting precompiled binaries in one place. Change 3247250 on 2017/01/04 by Ben.Marsh UBT: Prevent precompiled binaries being added to the list of app binaries twice. Change3247594on 2017/01/05 by Ben.Marsh Build: Run sample and template editors on the same agents as the other incremental builds. Remove ProtoStar, which does not have any non-precompiled editor target to build. Change 3247763 on 2017/01/05 by Ben.Marsh UBT: Allow the toolchain to update the list of build products for each module linked into a binary. Allows Mac to add dylibs and bundle resources specified per-module without having to construct a link environment and try to link them. Change 3247775 on 2017/01/05 by Ben.Marsh UBT: Instance the target compile and link environments when they are required during building, and don't persist them on the UEBuildTarget instance. Change 3247811 on 2017/01/05 by Ben.Marsh EC: Add a batch file for testing postp filters. Change 3247839 on 2017/01/05 by Ben.Marsh EC: Include the name of the file being compiled when parsing MSVC errors and warnings. Change 3248101 on 2017/01/05 by Ben.Marsh UBT: Fix Android support for force included headers. Change 3248533 on 2017/01/05 by Ben.Marsh PR #3097: UBT project supports optional platforms (Contributed by PrimalJohnScott) Change 3249205 on 2017/01/06 by Ben.Marsh UAT: Fix ParseTaggedP4Output throwing an exception if the same key name is specified more than once. This can happen when parsing the output from "P4 INFO", where multiple brokers are present. Change 3249249 on 2017/01/06 by Ben.Marsh UBT: Check for the existance of AndroidManifest.xml within extracted AAR directories, rather than just checking for the existance of the directory itself. Perforce does not remove empty directories when cleaning a workspace unless the rmdir option is on the workspace, so this can cause incremental build failures to fail on build machines. Change 3249486 on 2017/01/06 by Ben.Marsh UBT: Use relative paths in unity files when compiling for Mac/IOS, rather than generating a separate local/remote version of the file for gathering include dependencies. Absolute paths are only used to work around the way that MSVC concatenates paths internally; we don't hit the same problems when checking dependencies. Change 3249736 on 2017/01/06 by Ben.Marsh UBT: Rename CPPEnvironment to CppCompileEnvironment, and remove the separate CPPEnvironmentConfiguration object. All settings are now stored directly on the CppCompileEnvironment object. Change 3250179 on 2017/01/07 by Ben.Marsh Fix creating installed build when root directory contains a space in the name. Change 3250181 on 2017/01/07 by Ben.Marsh UBT: Remove some esoteric (and unused, AFAIK) options for orthogonally building different platforms. Change 3250223 on 2017/01/07 by Ben.Marsh UBT: Merge the LinkEnvironment and LinkEnvironmentConfiguration classes together. Change 3250233 on 2017/01/07 by Ben.Marsh UGS: Allow specifying a workspace-specific sync filter, which is applied on top of the standard filter. Also fix filter being cleared if the cancel button is pressed, and help text being stripped out. Change 3250241 on 2017/01/07 by Ben.Marsh UBT: Move the options for specifying additional Android architectures to target onto an Android-specific object on the TargetRules. Change 3250400 on 2017/01/08 by Ben.Marsh UBT: Move executor config settings onto the executor instances. Change 3257708 on 2017/01/13 by Ben.Marsh UBT: Remove the ThirdPartySourceDirectory constant; there are many places which hard-code or assume this location anyway, and it's not going to change. Change 3260535 on 2017/01/17 by Ben.Marsh Add an optional "RequiredSubmittedChange" setting to EC settings files. Allows a scheduled job to run even if there have been no code changes submitted. Test with the utilization capture job. Change 3260875 on 2017/01/17 by Ben.Marsh EC: Fix workspaces getting out of sync wrt. newly added files when jobs are aborted during a sync. In such cases, the P4 have table indicates the new files have been synced locally, but the workspace is forced back to a state before it had them due to the capture file. When a following sync tries to add them again, P4 believes the workspace already has them synced. To work around this, we now write an additional file to the root folder of a workspace containing the last CL that was captured, and sync back to it before doing the reconcile. Change 3261724 on 2017/01/18 by Ben.Marsh Allow filtering job types from the list view in EC. Hide the utilization capture job by default. Also set up notifications for the utilization capture job. Change 3261756 on 2017/01/18 by Ben.Marsh IncludeTool: Prevent matching a full enum declaration as a forward declaration. Change 3261932 on 2017/01/18 by Ben.Marsh EC: Add support for specifying days of the week in schedules. The following syntaxes are supported: "Monday, Tuesday and Wednesday at 10:30" "Daily except Sunday and Wednesday at 14:30" Also tweak display of dates relative to now to handle dates/times in the future, and include the date when specifying a day name. #jira UEB-729 Change 3262676 on 2017/01/18 by Ben.Marsh UBT: Split UBTMakefile into its own file. (From PR #3106) Change 3263893 on 2017/01/19 by Ben.Marsh UBT: Stop exporting platform classes from UBT, as well as all the referenced classes that have to be made public as a result. Any platform-specific functionality that needs to be shared with UAT is now exposed through wrappers in separate public classes, eg. WindowsExports.cs, IOSExports.cs, etc... Change 3264291 on 2017/01/19 by Ben.Marsh UBT: Fix errors generating documentation in UBT, and enable it by default. Will catch more errors with new code being added. Originally in PR #3106, but redone due to conflicts. Change 3264534 on 2017/01/19 by Ben.Marsh UBT: Include plugin config files in generated projects. Change 3264571 on 2017/01/19 by Ben.Marsh UBT: Prevent overwriting .modules files if nothing has changed. On builders, it's common to build multiple editors in the same workspace, and changing the last modified timestamp causes BuildGraph to fail due to tampered files. Change 3265745 on 2017/01/20 by Ben.Marsh UGS: Automatically open UGS when running the launcher for a second time, rather than prompting to close the original instance. Change 3265777 on 2017/01/20 by Ben.Marsh UGS: Automatically close and reopen when UGS is re-ran with the shift key held down to switch into unstable mode. Change 3268314 on 2017/01/23 by Ben.Marsh UBT: Make sure version manifests are stable by sorting the list of build products, so they are only touched if the contents have really changed. Change 3269601 on 2017/01/24 by Ben.Marsh UBT: Fix symbol files being added to manifest for some platforms even though debug info is disabled. Change 3269607 on 2017/01/24 by Ben.Marsh UBT: Fix bug where UBT would need to be invoked when switching between two editors sharing the same engine binaries on Mac. The location of the .modules file cannot be guessed on Mac by looking in the same directory as the primary output executable because it's an .app bundle, and the actual modules are nested several directories below that. Change 3269608 on 2017/01/24 by Ben.Marsh UBT: Fix additional files copied into the app bundle always being updated on Mac. Now uses rsync --checksum to make sure only modified files are updated. Change 3271062 on 2017/01/24 by Ben.Marsh UBT: Fixes for bugs detected by PVS Studio (PR #3161) Change 3272421 on 2017/01/25 by Ben.Marsh Fix commends regarding DDC in BaseEngine.ini #jira UE-41076 Change3272810on 2017/01/25 by Ben.Marsh Fix VS2017 being displayed as 'Visual Studio 15' in the Windows target settings panel. Change 3272935 on 2017/01/25 by Ben.Marsh Fix Metal errors launching on Mac due to use of OSX environment settings before they are initialized. Toolchain settings are now constructed on demand in a separate class, for Mac, iOS and TVOS. Change 3274167 on 2017/01/26 by Ben.Marsh Fix resource files not being compiled in installed builds on Windows. Was causing metadata not to be embedded into executables. #jira UE-36457 Change 3275557 on 2017/01/27 by Ben.Marsh Expand checks for propagation of restricted folder names to include source files, and to ensure that each restricted folder is represented in the output. Also improve messaging to show the dependency chain leading to a restricted folder being referenced, and which folder it is. Change 3275628 on 2017/01/27 by Ben.Marsh UBT: Splitting configuration files into one class per-file. Change 3276784 on 2017/01/29 by Ben.Marsh Add an authoritative list of confidential folder names, and expose it through global BuildGraph properties ($(RestrictedFolderNames) and $(RestrictedFolderFilter)). Also switch existing scripts to use it. Change 3276792 on 2017/01/29 by Ben.Marsh UBT: Use UE4CSharp.prog files to indicate which projects should be included in the solution without having to hard-code a list of them in UBT. Change 3277263 on 2017/01/30 by Ben.Marsh IncludeTool: Merging various fixes. * Fix warnings about #include directives after first code block from parsing monolithic headers. * Fix exception on startup if the intermediate directory does not already exist. * Add a special case for ignoring missing header guards from MonolithicHeaderBoilerplate.h, rather than marking it as an inline header. Marking it as inline prevents parsing include directives, which results in including CoreTypes.h from the wrong location. * Create job objects for spawned compiler instances to prevent them trying allocating more memory than the system can spare. * Remove (unused) code which makes assumptions about files ending with "Classes.h". * Add a verbose per-file output log to aid with debugging. * Negate the MakeStandalone command line option, which was added to allow tweaking forward declarations in already optimized files, so the optimized output does not have missing headers by default. * Fix missing headers when creating standalone files, due to incorrect list of previous files being passed in to the OutputFile constructor. Now passes the original list of included files, not the output list. * Fix initial header for a cpp file sometimes being removed. Forcibly including a header at the start of the file does not use the normal pathway for spidering through includes, so a second include of the same file was being generated. Any includes of that header were being forced into output, and the earlier include was then removed due to being redundant. * Prevent forward declaring enums which have to be parsed by UHT. UHT relies on includes to determine a parse order, and will fail if the enum definition has not been parsed first. * Use a relative path for private includes in the same module if there are any. Fixes some incorrect paths, and makes it clearer that we're doing something we shouldn't. Change 3277307 on 2017/01/30 by Ben.Marsh UBT: Fix private PCHs not using correct header. Causes custom definitions to be excluded from the command line. [CL 3278101 by Ben Marsh in Main branch]
1633 lines
60 KiB
C#
1633 lines
60 KiB
C#
// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Diagnostics;
|
|
using System.Linq;
|
|
using System.Runtime.Serialization;
|
|
|
|
namespace UnrealBuildTool
|
|
{
|
|
/// <summary>
|
|
/// Enumerates build action types.
|
|
/// </summary>
|
|
enum ActionType
|
|
{
|
|
BuildProject,
|
|
|
|
Compile,
|
|
|
|
CreateAppBundle,
|
|
|
|
GenerateDebugInfo,
|
|
|
|
Link,
|
|
}
|
|
|
|
/// <summary>
|
|
/// A build action.
|
|
/// </summary>
|
|
[Serializable]
|
|
class Action : ISerializable
|
|
{
|
|
///
|
|
/// Preparation and Assembly (serialized)
|
|
///
|
|
|
|
/// <summary>
|
|
/// The type of this action (for debugging purposes).
|
|
/// </summary>
|
|
public readonly ActionType ActionType;
|
|
|
|
/// <summary>
|
|
/// Every file this action depends on. These files need to exist and be up to date in order for this action to even be considered
|
|
/// </summary>
|
|
public List<FileItem> PrerequisiteItems = new List<FileItem>();
|
|
|
|
/// <summary>
|
|
/// The files that this action produces after completing
|
|
/// </summary>
|
|
public List<FileItem> ProducedItems = new List<FileItem>();
|
|
|
|
/// <summary>
|
|
/// Directory from which to execute the program to create produced items
|
|
/// </summary>
|
|
public string WorkingDirectory = null;
|
|
|
|
/// <summary>
|
|
/// True if we should log extra information when we run a program to create produced items
|
|
/// </summary>
|
|
public bool bPrintDebugInfo = false;
|
|
|
|
/// <summary>
|
|
/// The command to run to create produced items
|
|
/// </summary>
|
|
public string CommandPath = null;
|
|
|
|
/// <summary>
|
|
/// Command-line parameters to pass to the program
|
|
/// </summary>
|
|
public string CommandArguments = null;
|
|
|
|
/// <summary>
|
|
/// Optional friendly description of the type of command being performed, for example "Compile" or "Link". Displayed by some executors.
|
|
/// </summary>
|
|
public string CommandDescription = null;
|
|
|
|
/// <summary>
|
|
/// Human-readable description of this action that may be displayed as status while invoking the action. This is often the name of the file being compiled, or an executable file name being linked. Displayed by some executors.
|
|
/// </summary>
|
|
public string StatusDescription = "...";
|
|
|
|
/// <summary>
|
|
/// True if this action is allowed to be run on a remote machine when a distributed build system is being used, such as XGE
|
|
/// </summary>
|
|
public bool bCanExecuteRemotely = false;
|
|
|
|
/// <summary>
|
|
/// True if this action is allowed to be run on a remote machine with SNDBS. Files with #import directives must be compiled locally. Also requires bCanExecuteRemotely = true.
|
|
/// </summary>
|
|
public bool bCanExecuteRemotelyWithSNDBS = true;
|
|
|
|
/// <summary>
|
|
/// True if this action is using the GCC compiler. Some build systems may be able to optimize for this case.
|
|
/// </summary>
|
|
public bool bIsGCCCompiler = false;
|
|
|
|
/// <summary>
|
|
/// Whether the action is using a pre-compiled header to speed it up.
|
|
/// </summary>
|
|
public bool bIsUsingPCH = false;
|
|
|
|
/// <summary>
|
|
/// Whether the files in ProducedItems should be deleted before executing this action, when the action is outdated
|
|
/// </summary>
|
|
public bool bShouldDeleteProducedItems = false;
|
|
|
|
/// <summary>
|
|
/// Whether we should log this action, whether executed locally or remotely. This is useful for actions that take time
|
|
/// but invoke tools without any console output.
|
|
/// </summary>
|
|
public bool bShouldOutputStatusDescription = true;
|
|
|
|
/// <summary>
|
|
/// Whether this action includes incremental linking.
|
|
/// </summary>
|
|
public bool bUseIncrementalLinking = false;
|
|
|
|
/// <summary>
|
|
/// True if any libraries produced by this action should be considered 'import libraries'
|
|
/// </summary>
|
|
public bool bProducesImportLibrary = false;
|
|
|
|
/// <summary>
|
|
/// Optional custom event handler for standard output.
|
|
/// </summary>
|
|
public DataReceivedEventHandler OutputEventHandler = null; // @todo ubtmake urgent: Delegate variables are not saved, but we are comparing against this in ExecuteActions() for XGE!
|
|
|
|
/// <summary>
|
|
/// Callback used to perform a special action instead of a generic command line
|
|
/// </summary>
|
|
public delegate void BlockingActionHandler(Action Action, out int ExitCode, out string Output);
|
|
public BlockingActionHandler ActionHandler = null; // @todo ubtmake urgent: Delegate variables are not saved, but we are comparing against this in ExecuteActions() for XGE!
|
|
|
|
|
|
|
|
///
|
|
/// Preparation only (not serialized)
|
|
///
|
|
|
|
/// <summary>
|
|
/// Unique action identifier. Used for displaying helpful info about detected cycles in the graph.
|
|
/// </summary>
|
|
public readonly int UniqueId;
|
|
|
|
/// <summary>
|
|
/// Total number of actions depending on this one.
|
|
/// </summary>
|
|
public int NumTotalDependentActions = 0;
|
|
|
|
/// <summary>
|
|
/// Relative cost of producing items for this action.
|
|
/// </summary>
|
|
public long RelativeCost = 0;
|
|
|
|
|
|
///
|
|
/// Assembly only (not serialized)
|
|
///
|
|
|
|
/// <summary>
|
|
/// Start time of action, optionally set by executor.
|
|
/// </summary>
|
|
public DateTimeOffset StartTime = DateTimeOffset.MinValue;
|
|
|
|
/// <summary>
|
|
/// End time of action, optionally set by executor.
|
|
/// </summary>
|
|
public DateTimeOffset EndTime = DateTimeOffset.MinValue;
|
|
|
|
|
|
public Action(ActionType InActionType, int InUniqueId)
|
|
{
|
|
ActionType = InActionType;
|
|
UniqueId = InUniqueId;
|
|
}
|
|
|
|
public Action(SerializationInfo SerializationInfo, StreamingContext StreamingContext)
|
|
{
|
|
ActionType = (ActionType)SerializationInfo.GetByte("at");
|
|
WorkingDirectory = SerializationInfo.GetString("wd");
|
|
bPrintDebugInfo = SerializationInfo.GetBoolean("di");
|
|
CommandPath = SerializationInfo.GetString("cp");
|
|
CommandArguments = SerializationInfo.GetString("ca");
|
|
CommandDescription = SerializationInfo.GetString("cd");
|
|
StatusDescription = SerializationInfo.GetString("sd");
|
|
bCanExecuteRemotely = SerializationInfo.GetBoolean("ce");
|
|
bCanExecuteRemotelyWithSNDBS = SerializationInfo.GetBoolean("cs");
|
|
bIsGCCCompiler = SerializationInfo.GetBoolean("ig");
|
|
bIsUsingPCH = SerializationInfo.GetBoolean("iu");
|
|
bShouldDeleteProducedItems = SerializationInfo.GetBoolean("dp");
|
|
bShouldOutputStatusDescription = SerializationInfo.GetBoolean("os");
|
|
bUseIncrementalLinking = SerializationInfo.GetBoolean("in");
|
|
bProducesImportLibrary = SerializationInfo.GetBoolean("il");
|
|
PrerequisiteItems = (List<FileItem>)SerializationInfo.GetValue("pr", typeof(List<FileItem>));
|
|
ProducedItems = (List<FileItem>)SerializationInfo.GetValue("pd", typeof(List<FileItem>));
|
|
}
|
|
|
|
/// <summary>
|
|
/// ISerializable: Called when serialized to report additional properties that should be saved
|
|
/// </summary>
|
|
public void GetObjectData(SerializationInfo SerializationInfo, StreamingContext StreamingContext)
|
|
{
|
|
SerializationInfo.AddValue("at", (byte)ActionType);
|
|
SerializationInfo.AddValue("wd", WorkingDirectory);
|
|
SerializationInfo.AddValue("di", bPrintDebugInfo);
|
|
SerializationInfo.AddValue("cp", CommandPath);
|
|
SerializationInfo.AddValue("ca", CommandArguments);
|
|
SerializationInfo.AddValue("cd", CommandDescription);
|
|
SerializationInfo.AddValue("sd", StatusDescription);
|
|
SerializationInfo.AddValue("ce", bCanExecuteRemotely);
|
|
SerializationInfo.AddValue("cs", bCanExecuteRemotelyWithSNDBS);
|
|
SerializationInfo.AddValue("ig", bIsGCCCompiler);
|
|
SerializationInfo.AddValue("iu", bIsUsingPCH);
|
|
SerializationInfo.AddValue("dp", bShouldDeleteProducedItems);
|
|
SerializationInfo.AddValue("os", bShouldOutputStatusDescription);
|
|
SerializationInfo.AddValue("in", bUseIncrementalLinking);
|
|
SerializationInfo.AddValue("il", bProducesImportLibrary);
|
|
SerializationInfo.AddValue("pr", PrerequisiteItems);
|
|
SerializationInfo.AddValue("pd", ProducedItems);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compares two actions based on total number of dependent items, descending.
|
|
/// </summary>
|
|
/// <param name="A">Action to compare</param>
|
|
/// <param name="B">Action to compare</param>
|
|
public static int Compare(Action A, Action B)
|
|
{
|
|
// Primary sort criteria is total number of dependent files, up to max depth.
|
|
if (B.NumTotalDependentActions != A.NumTotalDependentActions)
|
|
{
|
|
return Math.Sign(B.NumTotalDependentActions - A.NumTotalDependentActions);
|
|
}
|
|
// Secondary sort criteria is relative cost.
|
|
if (B.RelativeCost != A.RelativeCost)
|
|
{
|
|
return Math.Sign(B.RelativeCost - A.RelativeCost);
|
|
}
|
|
// Tertiary sort criteria is number of pre-requisites.
|
|
else
|
|
{
|
|
return Math.Sign(B.PrerequisiteItems.Count - A.PrerequisiteItems.Count);
|
|
}
|
|
}
|
|
|
|
public override string ToString()
|
|
{
|
|
string ReturnString = "";
|
|
if (CommandPath != null)
|
|
{
|
|
ReturnString += CommandPath + " - ";
|
|
}
|
|
if (CommandArguments != null)
|
|
{
|
|
ReturnString += CommandArguments;
|
|
}
|
|
return ReturnString;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the amount of time that this action is or has been executing in.
|
|
/// </summary>
|
|
public TimeSpan Duration
|
|
{
|
|
get
|
|
{
|
|
if (EndTime == DateTimeOffset.MinValue)
|
|
{
|
|
return DateTimeOffset.Now - StartTime;
|
|
}
|
|
|
|
return EndTime - StartTime;
|
|
}
|
|
}
|
|
};
|
|
|
|
abstract class ActionExecutor
|
|
{
|
|
public abstract string Name
|
|
{
|
|
get;
|
|
}
|
|
|
|
public abstract bool ExecuteActions(List<Action> ActionsToExecute, bool bLogDetailedActionStats);
|
|
}
|
|
|
|
class ActionGraph
|
|
{
|
|
/// <summary>
|
|
/// Unique Id given to all actions added to this graph
|
|
/// </summary>
|
|
public int NextUniqueId;
|
|
|
|
/// <summary>
|
|
/// List of all the actions
|
|
/// </summary>
|
|
public List<Action> AllActions = new List<Action>();
|
|
|
|
public ActionGraph()
|
|
{
|
|
XmlConfig.ApplyTo(this);
|
|
NextUniqueId = 0;
|
|
}
|
|
|
|
public Action Add(ActionType Type)
|
|
{
|
|
int UniqueId = ++NextUniqueId;
|
|
Action NewAction = new Action(Type, UniqueId);
|
|
AllActions.Add(NewAction);
|
|
return NewAction;
|
|
}
|
|
|
|
public void FinalizeActionGraph()
|
|
{
|
|
// Link producing actions to the items they produce.
|
|
LinkActionsAndItems();
|
|
|
|
// Detect cycles in the action graph.
|
|
DetectActionGraphCycles();
|
|
|
|
// Sort action list by "cost" in descending order to improve parallelism.
|
|
SortActionList();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Builds a list of actions that need to be executed to produce the specified output items.
|
|
/// </summary>
|
|
public List<Action> GetActionsToExecute(BuildConfiguration BuildConfiguration, Action[] PrerequisiteActions, List<UEBuildTarget> Targets, Dictionary<UEBuildTarget, CPPHeaders> TargetToHeaders, out Dictionary<UEBuildTarget, List<FileItem>> TargetToOutdatedPrerequisitesMap)
|
|
{
|
|
DateTime CheckOutdatednessStartTime = DateTime.UtcNow;
|
|
|
|
// Build a set of all actions needed for this target.
|
|
Dictionary<Action, bool> IsActionOutdatedMap = new Dictionary<Action, bool>();
|
|
foreach (Action Action in PrerequisiteActions)
|
|
{
|
|
IsActionOutdatedMap.Add(Action, true);
|
|
}
|
|
|
|
// For all targets, build a set of all actions that are outdated.
|
|
Dictionary<Action, bool> OutdatedActionDictionary = new Dictionary<Action, bool>();
|
|
List<ActionHistory> HistoryList = new List<ActionHistory>();
|
|
HashSet<FileReference> OpenHistoryFiles = new HashSet<FileReference>();
|
|
TargetToOutdatedPrerequisitesMap = new Dictionary<UEBuildTarget, List<FileItem>>();
|
|
foreach (UEBuildTarget BuildTarget in Targets) // @todo ubtmake: Optimization: Ideally we don't even need to know about targets for ubtmake -- everything would come from the files
|
|
{
|
|
FileReference HistoryFilename = ActionHistory.GeneratePathForTarget(BuildTarget);
|
|
if (!OpenHistoryFiles.Contains(HistoryFilename)) // @todo ubtmake: Optimization: We should be able to move the command-line outdatedness and build product deletion over to the 'gather' phase, as the command-lines won't change between assembler runs
|
|
{
|
|
ActionHistory History = new ActionHistory(HistoryFilename.FullName);
|
|
HistoryList.Add(History);
|
|
OpenHistoryFiles.Add(HistoryFilename);
|
|
GatherAllOutdatedActions(BuildConfiguration, BuildTarget, TargetToHeaders[BuildTarget], History, ref OutdatedActionDictionary, TargetToOutdatedPrerequisitesMap);
|
|
}
|
|
}
|
|
|
|
// If we're only compiling a single file, we should always compile and should never link.
|
|
if (!string.IsNullOrEmpty(BuildConfiguration.SingleFileToCompile))
|
|
{
|
|
// Never do anything but compile the target file
|
|
AllActions.RemoveAll(x => x.ActionType != ActionType.Compile);
|
|
|
|
// Check all of the leftover compilation actions for the one we want... that one is always outdated.
|
|
FileItem SingleFileToCompile = FileItem.GetExistingItemByPath(BuildConfiguration.SingleFileToCompile);
|
|
foreach (Action Action in AllActions)
|
|
{
|
|
bool bIsSingleFileAction = Action.PrerequisiteItems.Contains(SingleFileToCompile);
|
|
OutdatedActionDictionary[Action] = bIsSingleFileAction;
|
|
}
|
|
|
|
// Don't save the history of a single file compilation.
|
|
HistoryList.Clear();
|
|
}
|
|
|
|
// Delete produced items that are outdated.
|
|
DeleteOutdatedProducedItems(OutdatedActionDictionary, BuildConfiguration.bShouldDeleteAllOutdatedProducedItems);
|
|
|
|
// Save the action history.
|
|
// This must happen after deleting outdated produced items to ensure that the action history on disk doesn't have
|
|
// command-lines that don't match the produced items on disk.
|
|
foreach (ActionHistory TargetHistory in HistoryList)
|
|
{
|
|
TargetHistory.Save();
|
|
}
|
|
|
|
// Create directories for the outdated produced items.
|
|
CreateDirectoriesForProducedItems(OutdatedActionDictionary);
|
|
|
|
// Build a list of actions that are both needed for this target and outdated.
|
|
HashSet<Action> ActionsToExecute = AllActions.Where(Action => Action.CommandPath != null && IsActionOutdatedMap.ContainsKey(Action) && OutdatedActionDictionary[Action]).ToHashSet();
|
|
|
|
// Delete PDB files for all produced items, since incremental updates are slower than full ones.
|
|
foreach (Action ActionToExecute in ActionsToExecute)
|
|
{
|
|
foreach (FileItem ProducedItem in ActionToExecute.ProducedItems)
|
|
{
|
|
if(ProducedItem.bExists && !ActionToExecute.bUseIncrementalLinking && ProducedItem.Reference.HasExtension(".pdb"))
|
|
{
|
|
Log.TraceVerbose("Deleting outdated pdb: {0}", ProducedItem.AbsolutePath);
|
|
ProducedItem.Delete();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Remove link actions if asked to
|
|
if (BuildConfiguration.bSkipLinkingWhenNothingToCompile)
|
|
{
|
|
// Get all items produced by a compile action
|
|
HashSet<FileItem> ProducedItems = ActionsToExecute.Where(Action => Action.ActionType == ActionType.Compile).SelectMany(x => x.ProducedItems).ToHashSet();
|
|
|
|
// Get all link actions which have no out-of-date prerequisites
|
|
HashSet<Action> UnlinkedActions = ActionsToExecute.Where(Action => Action.ActionType == ActionType.Link && !ProducedItems.Overlaps(Action.PrerequisiteItems)).ToHashSet();
|
|
|
|
// Don't regard an action as unlinked if there is an associated 'failed.hotreload' file.
|
|
UnlinkedActions.RemoveWhere(Action => Action.ProducedItems.Any(Item => File.Exists(Path.Combine(Path.GetDirectoryName(Item.AbsolutePath), "failed.hotreload"))));
|
|
|
|
HashSet<Action> UnlinkedActionsWithFailedHotreload = ActionsToExecute.Where(Action => Action.ActionType == ActionType.Link && !ProducedItems.Overlaps(Action.PrerequisiteItems)).ToHashSet();
|
|
|
|
// Remove unlinked items
|
|
ActionsToExecute.ExceptWith(UnlinkedActions);
|
|
|
|
// Re-add unlinked items which produce things which are dependencies of other actions
|
|
for (;;)
|
|
{
|
|
// Get all prerequisite items of a link action
|
|
HashSet<Action> PrerequisiteLinkActions = ActionsToExecute.Where(Action => Action.ActionType == ActionType.Link).SelectMany(x => x.PrerequisiteItems).Select(Item => Item.ProducingAction).ToHashSet();
|
|
|
|
// Find all unlinked actions that need readding
|
|
HashSet<Action> UnlinkedActionsToReadd = UnlinkedActions.Where(Action => PrerequisiteLinkActions.Contains(Action)).ToHashSet();
|
|
if (UnlinkedActionsToReadd.Count == 0)
|
|
{
|
|
break;
|
|
}
|
|
|
|
ActionsToExecute.UnionWith(UnlinkedActionsToReadd);
|
|
UnlinkedActions.ExceptWith(UnlinkedActionsToReadd);
|
|
|
|
// Break early if there are no more unlinked actions to readd
|
|
if (UnlinkedActions.Count == 0)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Remove actions that are wholly dependent on unlinked actions
|
|
ActionsToExecute = ActionsToExecute.Where(Action => Action.PrerequisiteItems.Count == 0 || !Action.PrerequisiteItems.Select(Item => Item.ProducingAction).ToHashSet().IsSubsetOf(UnlinkedActions)).ToHashSet();
|
|
}
|
|
|
|
if (UnrealBuildTool.bPrintPerformanceInfo)
|
|
{
|
|
double CheckOutdatednessTime = (DateTime.UtcNow - CheckOutdatednessStartTime).TotalSeconds;
|
|
Log.TraceInformation("Checking outdatedness took " + CheckOutdatednessTime + "s");
|
|
}
|
|
|
|
return ActionsToExecute.ToList();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Executes a list of actions.
|
|
/// </summary>
|
|
public static bool ExecuteActions(BuildConfiguration BuildConfiguration, List<Action> ActionsToExecute, bool bIsRemoteCompile, out string ExecutorName, string TargetInfoForTelemetry, bool bIsHotReload = false)
|
|
{
|
|
bool Result = true;
|
|
ExecutorName = "";
|
|
if (ActionsToExecute.Count > 0)
|
|
{
|
|
DateTime StartTime = DateTime.UtcNow;
|
|
|
|
ActionExecutor Executor;
|
|
if(bIsRemoteCompile)
|
|
{
|
|
Executor = new RemoteExecutor();
|
|
}
|
|
else if ((XGE.IsAvailable() && BuildConfiguration.bAllowXGE) || BuildConfiguration.bXGEExport)
|
|
{
|
|
Executor = new XGE();
|
|
}
|
|
else if(BuildConfiguration.bAllowDistcc)
|
|
{
|
|
Executor = new Distcc();
|
|
}
|
|
else if(SNDBS.IsAvailable() && BuildConfiguration.bAllowSNDBS)
|
|
{
|
|
Executor = new SNDBS();
|
|
}
|
|
else
|
|
{
|
|
Executor = new LocalExecutor();
|
|
}
|
|
|
|
ExecutorName = Executor.Name;
|
|
Result = Executor.ExecuteActions(ActionsToExecute, BuildConfiguration.bLogDetailedActionStats);
|
|
|
|
if(Telemetry.IsAvailable() && !BuildConfiguration.bXGEExport)
|
|
{
|
|
Telemetry.SendEvent("BuildTime",
|
|
"ExecutorType", ExecutorName,
|
|
"OS", Environment.OSVersion.ToString(),
|
|
"MachineName", Environment.MachineName,
|
|
"NumLogicalCores", Environment.ProcessorCount.ToString(),
|
|
"Targets", TargetInfoForTelemetry,
|
|
"NumActions", ActionsToExecute.Count.ToString(),
|
|
"NumCompileActions", ActionsToExecute.Count(x => x.ActionType == ActionType.Compile).ToString(),
|
|
"NumPchCompileActions", ActionsToExecute.Count(x => x.ActionType == ActionType.Compile && x.ProducedItems.Any(y => y.Reference.HasExtension(".pch") || y.Reference.HasExtension(".gch"))).ToString(),
|
|
"NumLinkActions", ActionsToExecute.Count(x => x.ActionType == ActionType.Link).ToString(),
|
|
"ElapsedTime", (DateTime.UtcNow - StartTime).TotalSeconds.ToString());
|
|
}
|
|
|
|
if (!BuildConfiguration.bXGEExport)
|
|
{
|
|
// Verify the link outputs were created (seems to happen with Win64 compiles)
|
|
foreach (Action BuildAction in ActionsToExecute)
|
|
{
|
|
if (BuildAction.ActionType == ActionType.Link)
|
|
{
|
|
foreach (FileItem Item in BuildAction.ProducedItems)
|
|
{
|
|
bool bExists;
|
|
if (Item.bIsRemoteFile)
|
|
{
|
|
DateTime UnusedTime;
|
|
long UnusedLength;
|
|
bExists = RPCUtilHelper.GetRemoteFileInfo(Item.AbsolutePath, out UnusedTime, out UnusedLength);
|
|
}
|
|
else
|
|
{
|
|
// allow output to be a directory
|
|
bExists = File.Exists(Item.AbsolutePath) || Directory.Exists(Item.AbsolutePath);
|
|
}
|
|
|
|
if (bIsHotReload)
|
|
{
|
|
string FailedFilename = Path.Combine(Path.GetDirectoryName(Item.AbsolutePath), "failed.hotreload");
|
|
if (!bExists)
|
|
{
|
|
// Create a failed.hotreload file here to indicate that we need to attempt another hotreload link
|
|
// step in future, even though no source files have changed.
|
|
// This is necessary because we also don't want to link a brand new instance of a module every time
|
|
// a user hits the Compile button when nothing has changed.
|
|
FileItem.CreateIntermediateTextFile(new FileReference(FailedFilename), "");
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
File.Delete(FailedFilename);
|
|
}
|
|
catch
|
|
{
|
|
// Ignore but log failed deletions
|
|
Log.TraceVerbose("Failed to delete failed.hotreload file \"{0}\" - this may cause redundant hotreloads", FailedFilename);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!bExists)
|
|
{
|
|
throw new BuildException("UBT ERROR: Failed to produce item: " + Item.AbsolutePath);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Nothing to execute.
|
|
else
|
|
{
|
|
ExecutorName = "NoActionsToExecute";
|
|
Log.TraceInformation("Target is up to date");
|
|
}
|
|
|
|
return Result;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Links actions with their prerequisite and produced items into an action graph.
|
|
/// </summary>
|
|
void LinkActionsAndItems()
|
|
{
|
|
foreach (Action Action in AllActions)
|
|
{
|
|
foreach (FileItem ProducedItem in Action.ProducedItems)
|
|
{
|
|
ProducedItem.ProducingAction = Action;
|
|
Action.RelativeCost += ProducedItem.RelativeCost;
|
|
}
|
|
}
|
|
}
|
|
static string SplitFilename(string Filename, out string PlatformSuffix, out string ConfigSuffix, out string ProducedItemExtension)
|
|
{
|
|
string WorkingString = Filename;
|
|
ProducedItemExtension = Path.GetExtension(WorkingString);
|
|
if (!WorkingString.EndsWith(ProducedItemExtension))
|
|
{
|
|
throw new BuildException("Bogus extension");
|
|
}
|
|
WorkingString = WorkingString.Substring(0, WorkingString.Length - ProducedItemExtension.Length);
|
|
|
|
ConfigSuffix = "";
|
|
foreach (UnrealTargetConfiguration CurConfig in Enum.GetValues(typeof(UnrealTargetConfiguration)))
|
|
{
|
|
if (CurConfig != UnrealTargetConfiguration.Unknown)
|
|
{
|
|
string Test = "-" + CurConfig;
|
|
if (WorkingString.EndsWith(Test))
|
|
{
|
|
WorkingString = WorkingString.Substring(0, WorkingString.Length - Test.Length);
|
|
ConfigSuffix = Test;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
PlatformSuffix = "";
|
|
foreach (object CurPlatform in Enum.GetValues(typeof(UnrealTargetPlatform)))
|
|
{
|
|
string Test = "-" + CurPlatform;
|
|
if (WorkingString.EndsWith(Test))
|
|
{
|
|
WorkingString = WorkingString.Substring(0, WorkingString.Length - Test.Length);
|
|
PlatformSuffix = Test;
|
|
break;
|
|
}
|
|
}
|
|
return WorkingString;
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Finds and deletes stale hot reload DLLs.
|
|
/// </summary>
|
|
public void DeleteStaleHotReloadDLLs()
|
|
{
|
|
DateTime DeleteStartTime = DateTime.UtcNow;
|
|
|
|
foreach (Action BuildAction in AllActions)
|
|
{
|
|
if (BuildAction.ActionType == ActionType.Link)
|
|
{
|
|
foreach (FileItem Item in BuildAction.ProducedItems)
|
|
{
|
|
if (Item.bNeedsHotReloadNumbersDLLCleanUp)
|
|
{
|
|
string PlatformSuffix, ConfigSuffix, ProducedItemExtension;
|
|
string Base = SplitFilename(Item.AbsolutePath, out PlatformSuffix, out ConfigSuffix, out ProducedItemExtension);
|
|
String WildCard = Base + "-*" + PlatformSuffix + ConfigSuffix + ProducedItemExtension;
|
|
// Log.TraceInformation("Deleting old hot reload wildcard: \"{0}\".", WildCard);
|
|
// Wildcard search and delete
|
|
string DirectoryToLookIn = Path.GetDirectoryName(WildCard);
|
|
string FileName = Path.GetFileName(WildCard);
|
|
if (Directory.Exists(DirectoryToLookIn))
|
|
{
|
|
// Delete all files within the specified folder
|
|
string[] FilesToDelete = Directory.GetFiles(DirectoryToLookIn, FileName, SearchOption.TopDirectoryOnly);
|
|
foreach (string JunkFile in FilesToDelete)
|
|
{
|
|
|
|
string JunkPlatformSuffix, JunkConfigSuffix, JunkProducedItemExtension;
|
|
SplitFilename(JunkFile, out JunkPlatformSuffix, out JunkConfigSuffix, out JunkProducedItemExtension);
|
|
// now make sure that this file has the same config and platform
|
|
if (JunkPlatformSuffix == PlatformSuffix && JunkConfigSuffix == ConfigSuffix)
|
|
{
|
|
try
|
|
{
|
|
Log.TraceInformation("Deleting old hot reload file: \"{0}\".", JunkFile);
|
|
File.Delete(JunkFile);
|
|
}
|
|
catch (Exception Ex)
|
|
{
|
|
// Ignore all exceptions
|
|
Log.TraceInformation("Unable to delete old hot reload file: \"{0}\". Error: {1}", JunkFile, Ex.Message);
|
|
}
|
|
|
|
// Delete the PDB file.
|
|
string JunkPDBFile = JunkFile.Replace(ProducedItemExtension, ".pdb");
|
|
if (System.IO.File.Exists(JunkPDBFile))
|
|
{
|
|
try
|
|
{
|
|
Log.TraceInformation("Deleting old hot reload file: \"{0}\".", JunkPDBFile);
|
|
File.Delete(JunkPDBFile);
|
|
}
|
|
catch (Exception Ex)
|
|
{
|
|
// Ignore all exceptions
|
|
Log.TraceInformation("Unable to delete old hot reload file: \"{0}\". Error: {1}", JunkPDBFile, Ex.Message);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (UnrealBuildTool.bPrintPerformanceInfo)
|
|
{
|
|
double DeleteTime = (DateTime.UtcNow - DeleteStartTime).TotalSeconds;
|
|
Log.TraceInformation("Deleting stale hot reload DLLs took " + DeleteTime + "s");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sorts the action list for improved parallelism with local execution.
|
|
/// </summary>
|
|
public void SortActionList()
|
|
{
|
|
// Mapping from action to a list of actions that directly or indirectly depend on it (up to a certain depth).
|
|
Dictionary<Action, HashSet<Action>> ActionToDependentActionsMap = new Dictionary<Action, HashSet<Action>>();
|
|
// Perform multiple passes over all actions to propagate dependencies.
|
|
const int MaxDepth = 5;
|
|
for (int Pass = 0; Pass < MaxDepth; Pass++)
|
|
{
|
|
foreach (Action DependendAction in AllActions)
|
|
{
|
|
foreach (FileItem PrerequisiteItem in DependendAction.PrerequisiteItems)
|
|
{
|
|
Action PrerequisiteAction = PrerequisiteItem.ProducingAction;
|
|
if (PrerequisiteAction != null)
|
|
{
|
|
HashSet<Action> DependentActions = null;
|
|
if (ActionToDependentActionsMap.ContainsKey(PrerequisiteAction))
|
|
{
|
|
DependentActions = ActionToDependentActionsMap[PrerequisiteAction];
|
|
}
|
|
else
|
|
{
|
|
DependentActions = new HashSet<Action>();
|
|
ActionToDependentActionsMap[PrerequisiteAction] = DependentActions;
|
|
}
|
|
// Add dependent action...
|
|
DependentActions.Add(DependendAction);
|
|
// ... and all actions depending on it.
|
|
if (ActionToDependentActionsMap.ContainsKey(DependendAction))
|
|
{
|
|
DependentActions.UnionWith(ActionToDependentActionsMap[DependendAction]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
// At this point we have a list of dependent actions for each action, up to MaxDepth layers deep.
|
|
foreach (KeyValuePair<Action, HashSet<Action>> ActionMap in ActionToDependentActionsMap)
|
|
{
|
|
ActionMap.Key.NumTotalDependentActions = ActionMap.Value.Count;
|
|
}
|
|
// Sort actions by number of actions depending on them, descending. Secondary sort criteria is file size.
|
|
AllActions.Sort(Action.Compare);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks for cycles in the action graph.
|
|
/// </summary>
|
|
void DetectActionGraphCycles()
|
|
{
|
|
// Starting with actions that only depend on non-produced items, iteratively expand a set of actions that are only dependent on
|
|
// non-cyclical actions.
|
|
Dictionary<Action, bool> ActionIsNonCyclical = new Dictionary<Action, bool>();
|
|
Dictionary<Action, List<Action>> CyclicActions = new Dictionary<Action, List<Action>>();
|
|
while (true)
|
|
{
|
|
bool bFoundNewNonCyclicalAction = false;
|
|
|
|
foreach (Action Action in AllActions)
|
|
{
|
|
if (!ActionIsNonCyclical.ContainsKey(Action))
|
|
{
|
|
// Determine if the action depends on only actions that are already known to be non-cyclical.
|
|
bool bActionOnlyDependsOnNonCyclicalActions = true;
|
|
foreach (FileItem PrerequisiteItem in Action.PrerequisiteItems)
|
|
{
|
|
if (PrerequisiteItem.ProducingAction != null)
|
|
{
|
|
if (!ActionIsNonCyclical.ContainsKey(PrerequisiteItem.ProducingAction))
|
|
{
|
|
bActionOnlyDependsOnNonCyclicalActions = false;
|
|
if (!CyclicActions.ContainsKey(Action))
|
|
{
|
|
CyclicActions.Add(Action, new List<Action>());
|
|
}
|
|
|
|
List<Action> CyclicPrereq = CyclicActions[Action];
|
|
if (!CyclicPrereq.Contains(PrerequisiteItem.ProducingAction))
|
|
{
|
|
CyclicPrereq.Add(PrerequisiteItem.ProducingAction);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// If the action only depends on known non-cyclical actions, then add it to the set of known non-cyclical actions.
|
|
if (bActionOnlyDependsOnNonCyclicalActions)
|
|
{
|
|
ActionIsNonCyclical.Add(Action, true);
|
|
bFoundNewNonCyclicalAction = true;
|
|
if (CyclicActions.ContainsKey(Action))
|
|
{
|
|
CyclicActions.Remove(Action);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// If this iteration has visited all actions without finding a new non-cyclical action, then all non-cyclical actions have
|
|
// been found.
|
|
if (!bFoundNewNonCyclicalAction)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
|
|
// If there are any cyclical actions, throw an exception.
|
|
if (ActionIsNonCyclical.Count < AllActions.Count)
|
|
{
|
|
// Describe the cyclical actions.
|
|
string CycleDescription = "";
|
|
foreach (Action Action in AllActions)
|
|
{
|
|
if (!ActionIsNonCyclical.ContainsKey(Action))
|
|
{
|
|
CycleDescription += string.Format("Action #{0}: {1}\n", Action.UniqueId, Action.CommandPath);
|
|
CycleDescription += string.Format("\twith arguments: {0}\n", Action.CommandArguments);
|
|
foreach (FileItem PrerequisiteItem in Action.PrerequisiteItems)
|
|
{
|
|
CycleDescription += string.Format("\tdepends on: {0}\n", PrerequisiteItem.AbsolutePath);
|
|
}
|
|
foreach (FileItem ProducedItem in Action.ProducedItems)
|
|
{
|
|
CycleDescription += string.Format("\tproduces: {0}\n", ProducedItem.AbsolutePath);
|
|
}
|
|
CycleDescription += string.Format("\tDepends on cyclic actions:\n");
|
|
if (CyclicActions.ContainsKey(Action))
|
|
{
|
|
foreach (Action CyclicPrerequisiteAction in CyclicActions[Action])
|
|
{
|
|
if (CyclicPrerequisiteAction.ProducedItems.Count == 1)
|
|
{
|
|
CycleDescription += string.Format("\t\t{0} (produces: {1})\n", CyclicPrerequisiteAction.UniqueId, CyclicPrerequisiteAction.ProducedItems[0].AbsolutePath);
|
|
}
|
|
else
|
|
{
|
|
CycleDescription += string.Format("\t\t{0}\n", CyclicPrerequisiteAction.UniqueId);
|
|
foreach (FileItem CyclicProducedItem in CyclicPrerequisiteAction.ProducedItems)
|
|
{
|
|
CycleDescription += string.Format("\t\t\tproduces: {0}\n", CyclicProducedItem.AbsolutePath);
|
|
}
|
|
}
|
|
}
|
|
CycleDescription += "\n";
|
|
}
|
|
else
|
|
{
|
|
CycleDescription += string.Format("\t\tNone?? Coding error!\n");
|
|
}
|
|
CycleDescription += "\n\n";
|
|
}
|
|
}
|
|
|
|
throw new BuildException("Action graph contains cycle!\n\n{0}", CycleDescription);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determines the full set of actions that must be built to produce an item.
|
|
/// </summary>
|
|
/// <param name="OutputItem">- The item to be built.</param>
|
|
/// <param name="PrerequisiteActions">- The actions that must be built and the root action are</param>
|
|
public void GatherPrerequisiteActions(
|
|
FileItem OutputItem,
|
|
ref HashSet<Action> PrerequisiteActions
|
|
)
|
|
{
|
|
if (OutputItem != null && OutputItem.ProducingAction != null)
|
|
{
|
|
if (!PrerequisiteActions.Contains(OutputItem.ProducingAction))
|
|
{
|
|
PrerequisiteActions.Add(OutputItem.ProducingAction);
|
|
foreach (FileItem PrerequisiteItem in OutputItem.ProducingAction.PrerequisiteItems)
|
|
{
|
|
GatherPrerequisiteActions(PrerequisiteItem, ref PrerequisiteActions);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determines whether an action is outdated based on the modification times for its prerequisite
|
|
/// and produced items.
|
|
/// </summary>
|
|
/// <param name="BuildConfiguration">Build configuration options</param>
|
|
/// <param name="Target"></param>
|
|
/// <param name="Headers"></param>
|
|
/// <param name="RootAction">- The action being considered.</param>
|
|
/// <param name="OutdatedActionDictionary">-</param>
|
|
/// <param name="ActionHistory"></param>
|
|
/// <param name="TargetToOutdatedPrerequisitesMap"></param>
|
|
/// <returns>true if outdated</returns>
|
|
public bool IsActionOutdated(BuildConfiguration BuildConfiguration, UEBuildTarget Target, CPPHeaders Headers, Action RootAction, Dictionary<Action, bool> OutdatedActionDictionary, ActionHistory ActionHistory, Dictionary<UEBuildTarget, List<FileItem>> TargetToOutdatedPrerequisitesMap)
|
|
{
|
|
// Only compute the outdated-ness for actions that don't aren't cached in the outdated action dictionary.
|
|
bool bIsOutdated = false;
|
|
if (!OutdatedActionDictionary.TryGetValue(RootAction, out bIsOutdated))
|
|
{
|
|
// Determine the last time the action was run based on the write times of its produced files.
|
|
string LatestUpdatedProducedItemName = null;
|
|
DateTimeOffset LastExecutionTime = DateTimeOffset.MaxValue;
|
|
foreach (FileItem ProducedItem in RootAction.ProducedItems)
|
|
{
|
|
// Optionally skip the action history check, as this only works for local builds
|
|
if (BuildConfiguration.bUseActionHistory)
|
|
{
|
|
// Check if the command-line of the action previously used to produce the item is outdated.
|
|
string OldProducingCommandLine = "";
|
|
string NewProducingCommandLine = RootAction.CommandPath + " " + RootAction.CommandArguments;
|
|
if (!ActionHistory.GetProducingCommandLine(ProducedItem, out OldProducingCommandLine)
|
|
|| !String.Equals(OldProducingCommandLine, NewProducingCommandLine, StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
Log.TraceVerbose(
|
|
"{0}: Produced item \"{1}\" was produced by outdated command-line.\nOld command-line: {2}\nNew command-line: {3}",
|
|
RootAction.StatusDescription,
|
|
Path.GetFileName(ProducedItem.AbsolutePath),
|
|
OldProducingCommandLine,
|
|
NewProducingCommandLine
|
|
);
|
|
|
|
bIsOutdated = true;
|
|
|
|
// Update the command-line used to produce this item in the action history.
|
|
ActionHistory.SetProducingCommandLine(ProducedItem, NewProducingCommandLine);
|
|
}
|
|
}
|
|
|
|
// If the produced file doesn't exist or has zero size, consider it outdated. The zero size check is to detect cases
|
|
// where aborting an earlier compile produced invalid zero-sized obj files, but that may cause actions where that's
|
|
// legitimate output to always be considered outdated.
|
|
if (ProducedItem.bExists && (ProducedItem.bIsRemoteFile || ProducedItem.Length > 0 || ProducedItem.IsDirectory))
|
|
{
|
|
// When linking incrementally, don't use LIB, EXP pr PDB files when checking for the oldest produced item,
|
|
// as those files aren't always touched.
|
|
if (RootAction.bUseIncrementalLinking)
|
|
{
|
|
String ProducedItemExtension = Path.GetExtension(ProducedItem.AbsolutePath).ToUpperInvariant();
|
|
if (ProducedItemExtension == ".LIB" || ProducedItemExtension == ".EXP" || ProducedItemExtension == ".PDB")
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// Use the oldest produced item's time as the last execution time.
|
|
if (ProducedItem.LastWriteTime < LastExecutionTime)
|
|
{
|
|
LastExecutionTime = ProducedItem.LastWriteTime;
|
|
LatestUpdatedProducedItemName = ProducedItem.AbsolutePath;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// If any of the produced items doesn't exist, the action is outdated.
|
|
Log.TraceVerbose(
|
|
"{0}: Produced item \"{1}\" doesn't exist.",
|
|
RootAction.StatusDescription,
|
|
Path.GetFileName(ProducedItem.AbsolutePath)
|
|
);
|
|
bIsOutdated = true;
|
|
}
|
|
}
|
|
|
|
Log.WriteLineIf(BuildConfiguration.bLogDetailedActionStats && !String.IsNullOrEmpty(LatestUpdatedProducedItemName),
|
|
LogEventType.Verbose, "{0}: Oldest produced item is {1}", RootAction.StatusDescription, LatestUpdatedProducedItemName);
|
|
|
|
bool bCheckIfIncludedFilesAreNewer = false;
|
|
bool bPerformExhaustiveIncludeSearchAndUpdateCache = false;
|
|
if (RootAction.ActionType == ActionType.Compile)
|
|
{
|
|
// Outdated targets don't need their headers scanned yet, because presumably they would already be out of dated based on already-cached
|
|
// includes before getting this far. However, if we find them to be outdated after processing includes, we'll do a deep scan later
|
|
// on and cache all of the includes so that we have them for a quick outdatedness check the next run.
|
|
if (!bIsOutdated &&
|
|
BuildConfiguration.bUseUBTMakefiles &&
|
|
UnrealBuildTool.IsAssemblingBuild)
|
|
{
|
|
bCheckIfIncludedFilesAreNewer = true;
|
|
}
|
|
|
|
// Were we asked to force an update of our cached includes BEFORE we try to build? This may be needed if our cache can no longer
|
|
// be trusted and we need to fill it with perfectly valid data (even if we're in assembler only mode)
|
|
if (BuildConfiguration.bUseUBTMakefiles &&
|
|
UnrealBuildTool.bNeedsFullCPPIncludeRescan)
|
|
{
|
|
// This will be slow!
|
|
bPerformExhaustiveIncludeSearchAndUpdateCache = true;
|
|
}
|
|
}
|
|
|
|
|
|
if (bCheckIfIncludedFilesAreNewer || bPerformExhaustiveIncludeSearchAndUpdateCache)
|
|
{
|
|
// Scan this file for included headers that may be out of date. Note that it's OK if we break out early because we found
|
|
// the action to be outdated. For outdated actions, we kick off a separate include scan in a background thread later on to
|
|
// catch all of the other includes and form an exhaustive set.
|
|
foreach (FileItem PrerequisiteItem in RootAction.PrerequisiteItems)
|
|
{
|
|
// @todo ubtmake: Make sure we are catching RC files here too. Anything that the toolchain would have tried it on. Logic should match the CACHING stuff below
|
|
if (PrerequisiteItem.CachedIncludePaths != null)
|
|
{
|
|
List<FileItem> IncludedFileList = Headers.FindAndCacheAllIncludedFiles(PrerequisiteItem, PrerequisiteItem.CachedIncludePaths, bOnlyCachedDependencies: !bPerformExhaustiveIncludeSearchAndUpdateCache);
|
|
if (IncludedFileList != null)
|
|
{
|
|
foreach (FileItem IncludedFile in IncludedFileList)
|
|
{
|
|
if (IncludedFile.bExists)
|
|
{
|
|
// allow a 1 second slop for network copies
|
|
TimeSpan TimeDifference = IncludedFile.LastWriteTime - LastExecutionTime;
|
|
bool bPrerequisiteItemIsNewerThanLastExecution = TimeDifference.TotalSeconds > 1;
|
|
if (bPrerequisiteItemIsNewerThanLastExecution)
|
|
{
|
|
Log.TraceVerbose(
|
|
"{0}: Included file {1} is newer than the last execution of the action: {2} vs {3}",
|
|
RootAction.StatusDescription,
|
|
Path.GetFileName(IncludedFile.AbsolutePath),
|
|
IncludedFile.LastWriteTime.LocalDateTime,
|
|
LastExecutionTime.LocalDateTime
|
|
);
|
|
bIsOutdated = true;
|
|
|
|
// Don't bother checking every single include if we've found one that is out of date
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (bIsOutdated)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!bIsOutdated)
|
|
{
|
|
// Check if any of the prerequisite items are produced by outdated actions, or have changed more recently than
|
|
// the oldest produced item.
|
|
foreach (FileItem PrerequisiteItem in RootAction.PrerequisiteItems)
|
|
{
|
|
// Only check for outdated import libraries if we were configured to do so. Often, a changed import library
|
|
// won't affect a dependency unless a public header file was also changed, in which case we would be forced
|
|
// to recompile anyway. This just allows for faster iteration when working on a subsystem in a DLL, as we
|
|
// won't have to wait for dependent targets to be relinked after each change.
|
|
bool bIsImportLibraryFile = false;
|
|
if (PrerequisiteItem.ProducingAction != null && PrerequisiteItem.ProducingAction.bProducesImportLibrary)
|
|
{
|
|
bIsImportLibraryFile = PrerequisiteItem.AbsolutePath.EndsWith(".LIB", StringComparison.InvariantCultureIgnoreCase);
|
|
}
|
|
if (!bIsImportLibraryFile || !BuildConfiguration.bIgnoreOutdatedImportLibraries)
|
|
{
|
|
// If the prerequisite is produced by an outdated action, then this action is outdated too.
|
|
if (PrerequisiteItem.ProducingAction != null)
|
|
{
|
|
if (IsActionOutdated(BuildConfiguration, Target, Headers, PrerequisiteItem.ProducingAction, OutdatedActionDictionary, ActionHistory, TargetToOutdatedPrerequisitesMap))
|
|
{
|
|
Log.TraceVerbose(
|
|
"{0}: Prerequisite {1} is produced by outdated action.",
|
|
RootAction.StatusDescription,
|
|
Path.GetFileName(PrerequisiteItem.AbsolutePath)
|
|
);
|
|
bIsOutdated = true;
|
|
}
|
|
}
|
|
|
|
if (PrerequisiteItem.bExists)
|
|
{
|
|
// allow a 1 second slop for network copies
|
|
TimeSpan TimeDifference = PrerequisiteItem.LastWriteTime - LastExecutionTime;
|
|
bool bPrerequisiteItemIsNewerThanLastExecution = TimeDifference.TotalSeconds > 1;
|
|
if (bPrerequisiteItemIsNewerThanLastExecution)
|
|
{
|
|
Log.TraceVerbose(
|
|
"{0}: Prerequisite {1} is newer than the last execution of the action: {2} vs {3}",
|
|
RootAction.StatusDescription,
|
|
Path.GetFileName(PrerequisiteItem.AbsolutePath),
|
|
PrerequisiteItem.LastWriteTime.LocalDateTime,
|
|
LastExecutionTime.LocalDateTime
|
|
);
|
|
bIsOutdated = true;
|
|
}
|
|
}
|
|
|
|
// GatherAllOutdatedActions will ensure all actions are checked for outdated-ness, so we don't need to recurse with
|
|
// all this action's prerequisites once we've determined it's outdated.
|
|
if (bIsOutdated)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// For compile actions, we have C++ files that are actually dependent on header files that could have been changed. We only need to
|
|
// know about the set of header files that are included for files that are already determined to be out of date (such as if the file
|
|
// is missing or was modified.) In the case that the file is out of date, we'll perform a deep scan to update our cached set of
|
|
// includes for this file, so that we'll be able to determine whether it is out of date next time very quickly.
|
|
if (BuildConfiguration.bUseUBTMakefiles)
|
|
{
|
|
DateTime DeepIncludeScanStartTime = DateTime.UtcNow;
|
|
|
|
// @todo ubtmake: we may be scanning more files than we need to here -- indirectly outdated files are bIsOutdated=true by this point (for example basemost includes when deeper includes are dirty)
|
|
if (bIsOutdated && RootAction.ActionType == ActionType.Compile) // @todo ubtmake: Does this work with RC files? See above too.
|
|
{
|
|
Log.TraceVerbose("Outdated action: {0}", RootAction.StatusDescription);
|
|
foreach (FileItem PrerequisiteItem in RootAction.PrerequisiteItems)
|
|
{
|
|
if (PrerequisiteItem.CachedIncludePaths != null)
|
|
{
|
|
if (!IsCPPFile(PrerequisiteItem))
|
|
{
|
|
throw new BuildException("Was only expecting C++ files to have CachedCPPEnvironments!");
|
|
}
|
|
Log.TraceVerbose(" -> DEEP include scan: {0}", PrerequisiteItem.AbsolutePath);
|
|
|
|
List<FileItem> OutdatedPrerequisites;
|
|
if (!TargetToOutdatedPrerequisitesMap.TryGetValue(Target, out OutdatedPrerequisites))
|
|
{
|
|
OutdatedPrerequisites = new List<FileItem>();
|
|
TargetToOutdatedPrerequisitesMap.Add(Target, OutdatedPrerequisites);
|
|
}
|
|
|
|
OutdatedPrerequisites.Add(PrerequisiteItem);
|
|
}
|
|
else if (IsCPPImplementationFile(PrerequisiteItem) || IsCPPResourceFile(PrerequisiteItem))
|
|
{
|
|
Log.TraceVerbose(" -> WARNING: No CachedCPPEnvironment: {0}", PrerequisiteItem.AbsolutePath);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (UnrealBuildTool.bPrintPerformanceInfo)
|
|
{
|
|
double DeepIncludeScanTime = (DateTime.UtcNow - DeepIncludeScanStartTime).TotalSeconds;
|
|
UnrealBuildTool.TotalDeepIncludeScanTime += DeepIncludeScanTime;
|
|
}
|
|
}
|
|
|
|
// Cache the outdated-ness of this action.
|
|
OutdatedActionDictionary.Add(RootAction, bIsOutdated);
|
|
}
|
|
|
|
return bIsOutdated;
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Builds a dictionary containing the actions from AllActions that are outdated by calling
|
|
/// IsActionOutdated.
|
|
/// </summary>
|
|
void GatherAllOutdatedActions(BuildConfiguration BuildConfiguration, UEBuildTarget Target, CPPHeaders Headers, ActionHistory ActionHistory, ref Dictionary<Action, bool> OutdatedActions, Dictionary<UEBuildTarget, List<FileItem>> TargetToOutdatedPrerequisitesMap)
|
|
{
|
|
DateTime CheckOutdatednessStartTime = DateTime.UtcNow;
|
|
|
|
foreach (Action Action in AllActions)
|
|
{
|
|
IsActionOutdated(BuildConfiguration, Target, Headers, Action, OutdatedActions, ActionHistory, TargetToOutdatedPrerequisitesMap);
|
|
}
|
|
|
|
if (UnrealBuildTool.bPrintPerformanceInfo)
|
|
{
|
|
double CheckOutdatednessTime = (DateTime.UtcNow - CheckOutdatednessStartTime).TotalSeconds;
|
|
Log.TraceInformation("Checking actions for " + Target.GetTargetName() + " took " + CheckOutdatednessTime + "s");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Deletes all the items produced by actions in the provided outdated action dictionary.
|
|
/// </summary>
|
|
/// <param name="OutdatedActionDictionary">Dictionary of outdated actions</param>
|
|
/// <param name="bShouldDeleteAllFiles"> Whether to delete all files associated with outdated items or just ones required</param>
|
|
static void DeleteOutdatedProducedItems(Dictionary<Action, bool> OutdatedActionDictionary, bool bShouldDeleteAllFiles)
|
|
{
|
|
foreach (KeyValuePair<Action, bool> OutdatedActionInfo in OutdatedActionDictionary)
|
|
{
|
|
if (OutdatedActionInfo.Value)
|
|
{
|
|
Action OutdatedAction = OutdatedActionInfo.Key;
|
|
foreach (FileItem ProducedItem in OutdatedActionInfo.Key.ProducedItems)
|
|
{
|
|
if (ProducedItem.bExists && (bShouldDeleteAllFiles || OutdatedAction.bShouldDeleteProducedItems))
|
|
{
|
|
Log.TraceVerbose("Deleting outdated item: {0}", ProducedItem.AbsolutePath);
|
|
ProducedItem.Delete();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates directories for all the items produced by actions in the provided outdated action
|
|
/// dictionary.
|
|
/// </summary>
|
|
static void CreateDirectoriesForProducedItems(Dictionary<Action, bool> OutdatedActionDictionary)
|
|
{
|
|
foreach (KeyValuePair<Action, bool> OutdatedActionInfo in OutdatedActionDictionary)
|
|
{
|
|
if (OutdatedActionInfo.Value)
|
|
{
|
|
foreach (FileItem ProducedItem in OutdatedActionInfo.Key.ProducedItems)
|
|
{
|
|
if (ProducedItem.bIsRemoteFile)
|
|
{
|
|
// we don't need to do this in the SSH mode, the action will have an output file, and it will use that to make the directory while executing the command
|
|
if (RemoteToolChain.bUseRPCUtil)
|
|
{
|
|
try
|
|
{
|
|
RPCUtilHelper.MakeDirectory(Path.GetDirectoryName(ProducedItem.AbsolutePath).Replace("\\", "/"));
|
|
}
|
|
catch (System.Exception Ex)
|
|
{
|
|
throw new BuildException(Ex, "Error while creating remote directory for '{0}'. (Exception: {1})", ProducedItem.AbsolutePath, Ex.Message);
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
string DirectoryPath = Path.GetDirectoryName(ProducedItem.AbsolutePath);
|
|
if (!Directory.Exists(DirectoryPath))
|
|
{
|
|
Log.TraceVerbose("Creating directory for produced item: {0}", DirectoryPath);
|
|
Directory.CreateDirectory(DirectoryPath);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
/// Checks if the specified file is a C++ source implementation file (e.g., .cpp)
|
|
/// </summary>
|
|
/// <param name="FileItem">The file to check</param>
|
|
/// <returns>True if this is a C++ source file</returns>
|
|
private static bool IsCPPImplementationFile(FileItem FileItem)
|
|
{
|
|
return (FileItem.AbsolutePath.EndsWith(".cpp", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".c", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".mm", StringComparison.InvariantCultureIgnoreCase));
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Checks if the specified file is a C++ source header file (e.g., .h or .inl)
|
|
/// </summary>
|
|
/// <param name="FileItem">The file to check</param>
|
|
/// <returns>True if this is a C++ source file</returns>
|
|
private static bool IsCPPIncludeFile(FileItem FileItem)
|
|
{
|
|
return (FileItem.AbsolutePath.EndsWith(".h", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".hpp", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".inl", StringComparison.InvariantCultureIgnoreCase));
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Checks if the specified file is a C++ resource file (e.g., .rc)
|
|
/// </summary>
|
|
/// <param name="FileItem">The file to check</param>
|
|
/// <returns>True if this is a C++ source file</returns>
|
|
private static bool IsCPPResourceFile(FileItem FileItem)
|
|
{
|
|
return (FileItem.AbsolutePath.EndsWith(".rc", StringComparison.InvariantCultureIgnoreCase));
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Checks if the specified file is a C++ source file
|
|
/// </summary>
|
|
/// <param name="FileItem">The file to check</param>
|
|
/// <returns>True if this is a C++ source file</returns>
|
|
private static bool IsCPPFile(FileItem FileItem)
|
|
{
|
|
return IsCPPImplementationFile(FileItem) || IsCPPIncludeFile(FileItem) || IsCPPResourceFile(FileItem);
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
/// Types of action graph visualizations that we can emit
|
|
/// </summary>
|
|
public enum ActionGraphVisualizationType
|
|
{
|
|
OnlyActions,
|
|
ActionsWithFiles,
|
|
ActionsWithFilesAndHeaders,
|
|
OnlyFilesAndHeaders,
|
|
OnlyCPlusPlusFilesAndHeaders
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
/// Saves the action graph (and include dependency network) to a graph gile
|
|
/// </summary>
|
|
/// <param name="Headers">Cached header data for this target</param>
|
|
/// <param name="Filename">File name to emit</param>
|
|
/// <param name="Description">Description to be stored in graph metadata</param>
|
|
/// <param name="VisualizationType">Type of graph to create</param>
|
|
/// <param name="Actions">All actions</param>
|
|
/// <param name="IncludeCompileActions">True if we should include compile actions. If disabled, only the static link actions will be shown, which is useful to see module relationships</param>
|
|
public static void SaveActionGraphVisualization(CPPHeaders Headers, string Filename, string Description, ActionGraphVisualizationType VisualizationType, List<Action> Actions, bool IncludeCompileActions = true)
|
|
{
|
|
// True if we should include individual files in the graph network, or false to include only the build actions
|
|
bool IncludeFiles = VisualizationType != ActionGraphVisualizationType.OnlyActions;
|
|
bool OnlyIncludeCPlusPlusFiles = VisualizationType == ActionGraphVisualizationType.OnlyCPlusPlusFilesAndHeaders;
|
|
|
|
// True if want to show actions in the graph, otherwise we're only showing files
|
|
bool IncludeActions = VisualizationType != ActionGraphVisualizationType.OnlyFilesAndHeaders && VisualizationType != ActionGraphVisualizationType.OnlyCPlusPlusFilesAndHeaders;
|
|
|
|
// True if C++ header dependencies should be expanded into the graph, or false to only have .cpp files
|
|
bool ExpandCPPHeaderDependencies = IncludeFiles && (VisualizationType == ActionGraphVisualizationType.ActionsWithFilesAndHeaders || VisualizationType == ActionGraphVisualizationType.OnlyFilesAndHeaders || VisualizationType == ActionGraphVisualizationType.OnlyCPlusPlusFilesAndHeaders);
|
|
|
|
DateTime TimerStartTime = DateTime.UtcNow;
|
|
|
|
List<GraphNode> GraphNodes = new List<GraphNode>();
|
|
|
|
Dictionary<FileItem, GraphNode> FileToGraphNodeMap = new Dictionary<FileItem, GraphNode>();
|
|
|
|
// Filter our list of actions
|
|
List<Action> FilteredActions = new List<Action>();
|
|
{
|
|
for (int ActionIndex = 0; ActionIndex < Actions.Count; ++ActionIndex)
|
|
{
|
|
Action Action = Actions[ActionIndex];
|
|
|
|
if (!IncludeActions || IncludeCompileActions || (Action.ActionType != ActionType.Compile))
|
|
{
|
|
FilteredActions.Add(Action);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
HashSet<FileItem> FilesToCreateNodesFor = new HashSet<FileItem>();
|
|
for (int ActionIndex = 0; ActionIndex < FilteredActions.Count; ++ActionIndex)
|
|
{
|
|
Action Action = FilteredActions[ActionIndex];
|
|
|
|
if (IncludeActions)
|
|
{
|
|
GraphNode GraphNode = new GraphNode()
|
|
{
|
|
Id = GraphNodes.Count,
|
|
|
|
// Don't bother including "Link" text if we're excluding compile actions
|
|
Label = IncludeCompileActions ? (Action.ActionType.ToString() + " " + Action.StatusDescription) : Action.StatusDescription
|
|
};
|
|
|
|
switch (Action.ActionType)
|
|
{
|
|
case ActionType.BuildProject:
|
|
GraphNode.Color = new GraphColor() { R = 0.3f, G = 1.0f, B = 1.0f, A = 1.0f };
|
|
GraphNode.Size = 1.1f;
|
|
break;
|
|
|
|
case ActionType.Compile:
|
|
GraphNode.Color = new GraphColor() { R = 0.3f, G = 1.0f, B = 0.3f, A = 1.0f };
|
|
break;
|
|
|
|
case ActionType.Link:
|
|
GraphNode.Color = new GraphColor() { R = 0.3f, G = 0.3f, B = 1.0f, A = 1.0f };
|
|
GraphNode.Size = 1.2f;
|
|
break;
|
|
}
|
|
|
|
GraphNodes.Add(GraphNode);
|
|
}
|
|
|
|
if (IncludeFiles)
|
|
{
|
|
foreach (FileItem ProducedFileItem in Action.ProducedItems)
|
|
{
|
|
if (!OnlyIncludeCPlusPlusFiles || IsCPPFile(ProducedFileItem))
|
|
{
|
|
FilesToCreateNodesFor.Add(ProducedFileItem);
|
|
}
|
|
}
|
|
|
|
foreach (FileItem PrerequisiteFileItem in Action.PrerequisiteItems)
|
|
{
|
|
if (!OnlyIncludeCPlusPlusFiles || IsCPPFile(PrerequisiteFileItem))
|
|
{
|
|
FilesToCreateNodesFor.Add(PrerequisiteFileItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
Dictionary<FileItem, List<FileItem>> OverriddenPrerequisites = new Dictionary<FileItem, List<FileItem>>();
|
|
|
|
// Determine the average size of all of the C++ source files
|
|
Int64 AverageCPPFileSize;
|
|
{
|
|
Int64 TotalFileSize = 0;
|
|
int CPPFileCount = 0;
|
|
foreach (FileItem FileItem in FilesToCreateNodesFor)
|
|
{
|
|
if (IsCPPFile(FileItem))
|
|
{
|
|
++CPPFileCount;
|
|
TotalFileSize += new FileInfo(FileItem.AbsolutePath).Length;
|
|
}
|
|
}
|
|
|
|
if (CPPFileCount > 0)
|
|
{
|
|
AverageCPPFileSize = TotalFileSize / CPPFileCount;
|
|
}
|
|
else
|
|
{
|
|
AverageCPPFileSize = 1;
|
|
}
|
|
}
|
|
|
|
foreach (FileItem FileItem in FilesToCreateNodesFor)
|
|
{
|
|
GraphNode FileGraphNode = new GraphNode()
|
|
{
|
|
Id = GraphNodes.Count,
|
|
Label = Path.GetFileName(FileItem.AbsolutePath)
|
|
};
|
|
|
|
if (FileItem.AbsolutePath.EndsWith(".h", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".inl", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
// Header file
|
|
FileGraphNode.Color = new GraphColor() { R = 0.9f, G = 0.2f, B = 0.9f, A = 1.0f };
|
|
}
|
|
else if (FileItem.AbsolutePath.EndsWith(".cpp", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".c", StringComparison.InvariantCultureIgnoreCase) ||
|
|
FileItem.AbsolutePath.EndsWith(".mm", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
// C++ file
|
|
FileGraphNode.Color = new GraphColor() { R = 1.0f, G = 1.0f, B = 0.3f, A = 1.0f };
|
|
}
|
|
else
|
|
{
|
|
// Other file
|
|
FileGraphNode.Color = new GraphColor() { R = 0.4f, G = 0.4f, B = 0.1f, A = 1.0f };
|
|
}
|
|
|
|
// Set the size of the file node based on the size of the file on disk
|
|
bool bIsCPPFile = IsCPPFile(FileItem);
|
|
if (bIsCPPFile)
|
|
{
|
|
float MinNodeSize = 0.25f;
|
|
float MaxNodeSize = 2.0f;
|
|
long FileSize = new FileInfo(FileItem.AbsolutePath).Length;
|
|
float FileSizeScale = (float)((double)FileSize / (double)AverageCPPFileSize);
|
|
|
|
float SourceFileSizeScaleFactor = 0.1f; // How much to make nodes for files bigger or larger based on their difference from the average file's size
|
|
FileGraphNode.Size = Math.Min(Math.Max(1.0f + SourceFileSizeScaleFactor * FileSizeScale, MinNodeSize), MaxNodeSize);
|
|
}
|
|
|
|
//@todo: Testing out attribute support. Replace with an attribute that is actually useful!
|
|
//if( FileItem.PrecompiledHeaderIncludeFilename != null )
|
|
//{
|
|
//FileGraphNode.Attributes[ "PCHFile" ] = Path.GetFileNameWithoutExtension( FileItem.PrecompiledHeaderIncludeFilename );
|
|
//}
|
|
|
|
FileToGraphNodeMap[FileItem] = FileGraphNode;
|
|
GraphNodes.Add(FileGraphNode);
|
|
|
|
if (ExpandCPPHeaderDependencies && bIsCPPFile)
|
|
{
|
|
List<DependencyInclude> DirectlyIncludedFilenames = Headers.GetDirectIncludeDependencies(FileItem, bOnlyCachedDependencies: false);
|
|
|
|
// Resolve the included file name to an actual file.
|
|
List<FileItem> DirectlyIncludedFiles =
|
|
DirectlyIncludedFilenames
|
|
.Where(DirectlyIncludedFilename => (DirectlyIncludedFilename.IncludeResolvedNameIfSuccessful != null))
|
|
.Select(DirectlyIncludedFilename => DirectlyIncludedFilename.IncludeResolvedNameIfSuccessful)
|
|
// Skip same include over and over (.inl files)
|
|
.Distinct()
|
|
.Select(FileItem.GetItemByFileReference)
|
|
.ToList();
|
|
|
|
OverriddenPrerequisites[FileItem] = DirectlyIncludedFiles;
|
|
}
|
|
}
|
|
|
|
|
|
// Connect everything together
|
|
List<GraphEdge> GraphEdges = new List<GraphEdge>();
|
|
|
|
if (IncludeActions)
|
|
{
|
|
for (int ActionIndex = 0; ActionIndex < FilteredActions.Count; ++ActionIndex)
|
|
{
|
|
Action Action = FilteredActions[ActionIndex];
|
|
GraphNode ActionGraphNode = GraphNodes[ActionIndex];
|
|
|
|
List<FileItem> ActualPrerequisiteItems = Action.PrerequisiteItems;
|
|
if (IncludeFiles && ExpandCPPHeaderDependencies && Action.ActionType == ActionType.Compile)
|
|
{
|
|
// The first prerequisite is always the .cpp file to compile
|
|
FileItem CPPFile = Action.PrerequisiteItems[0];
|
|
if (!IsCPPFile(CPPFile))
|
|
{
|
|
throw new BuildException("Was expecting a C++ file as the first prerequisite for a Compile action");
|
|
}
|
|
|
|
ActualPrerequisiteItems = new List<FileItem>();
|
|
ActualPrerequisiteItems.Add(CPPFile);
|
|
}
|
|
|
|
|
|
foreach (FileItem PrerequisiteFileItem in ActualPrerequisiteItems)
|
|
{
|
|
if (IncludeFiles)
|
|
{
|
|
GraphNode PrerequisiteFileGraphNode;
|
|
if (FileToGraphNodeMap.TryGetValue(PrerequisiteFileItem, out PrerequisiteFileGraphNode))
|
|
{
|
|
// Connect a file our action is dependent on, to our action itself
|
|
GraphEdge GraphEdge = new GraphEdge()
|
|
{
|
|
Id = GraphEdges.Count,
|
|
Source = PrerequisiteFileGraphNode,
|
|
Target = ActionGraphNode,
|
|
};
|
|
|
|
GraphEdges.Add(GraphEdge);
|
|
}
|
|
else
|
|
{
|
|
// Not a file we were tracking
|
|
// Console.WriteLine( "Unknown file: " + PrerequisiteFileItem.AbsolutePath );
|
|
}
|
|
}
|
|
else if (PrerequisiteFileItem.ProducingAction != null)
|
|
{
|
|
// Not showing files, so connect the actions together
|
|
int ProducingActionIndex = FilteredActions.IndexOf(PrerequisiteFileItem.ProducingAction);
|
|
if (ProducingActionIndex != -1)
|
|
{
|
|
GraphNode SourceGraphNode = GraphNodes[ProducingActionIndex];
|
|
|
|
GraphEdge GraphEdge = new GraphEdge()
|
|
{
|
|
Id = GraphEdges.Count,
|
|
Source = SourceGraphNode,
|
|
Target = ActionGraphNode,
|
|
};
|
|
|
|
GraphEdges.Add(GraphEdge);
|
|
}
|
|
else
|
|
{
|
|
// Our producer action was filtered out
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach (FileItem ProducedFileItem in Action.ProducedItems)
|
|
{
|
|
if (IncludeFiles)
|
|
{
|
|
if (!OnlyIncludeCPlusPlusFiles || IsCPPFile(ProducedFileItem))
|
|
{
|
|
GraphNode ProducedFileGraphNode = FileToGraphNodeMap[ProducedFileItem];
|
|
|
|
GraphEdge GraphEdge = new GraphEdge()
|
|
{
|
|
Id = GraphEdges.Count,
|
|
Source = ActionGraphNode,
|
|
Target = ProducedFileGraphNode,
|
|
};
|
|
|
|
GraphEdges.Add(GraphEdge);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (IncludeFiles && ExpandCPPHeaderDependencies)
|
|
{
|
|
// Fill in overridden prerequisites
|
|
foreach (KeyValuePair<FileItem, List<FileItem>> FileAndPrerequisites in OverriddenPrerequisites)
|
|
{
|
|
FileItem FileItem = FileAndPrerequisites.Key;
|
|
List<FileItem> FilePrerequisites = FileAndPrerequisites.Value;
|
|
|
|
GraphNode FileGraphNode = FileToGraphNodeMap[FileItem];
|
|
foreach (FileItem PrerequisiteFileItem in FilePrerequisites)
|
|
{
|
|
GraphNode PrerequisiteFileGraphNode;
|
|
if (FileToGraphNodeMap.TryGetValue(PrerequisiteFileItem, out PrerequisiteFileGraphNode))
|
|
{
|
|
GraphEdge GraphEdge = new GraphEdge()
|
|
{
|
|
Id = GraphEdges.Count,
|
|
Source = PrerequisiteFileGraphNode,
|
|
Target = FileGraphNode,
|
|
};
|
|
|
|
GraphEdges.Add(GraphEdge);
|
|
}
|
|
else
|
|
{
|
|
// Some other header that we don't track directly
|
|
//Console.WriteLine( "File not known: " + PrerequisiteFileItem.AbsolutePath );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
GraphVisualization.WriteGraphFile(Filename, Description, GraphNodes, GraphEdges);
|
|
|
|
if (UnrealBuildTool.bPrintPerformanceInfo)
|
|
{
|
|
TimeSpan TimerDuration = DateTime.UtcNow - TimerStartTime;
|
|
Log.TraceInformation("Generating and saving ActionGraph took " + TimerDuration.TotalSeconds + "s");
|
|
}
|
|
}
|
|
};
|
|
}
|