You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
9a3fb45cb4
Note that up until VS 16.9, according to the MSVC blog, ASan requires explcit helper libraries to be added to the linker line, which requires knowledge of what type of CRT we're compiling with on the link side. #jira UE-70239 #rb Ben.Marsh [CL 15574618 by halfdan ingvarsson in ue5-main branch]
388 lines
13 KiB
C#
388 lines
13 KiB
C#
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
using System;
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using EpicGames.Core;
|
|
|
|
namespace UnrealBuildTool
|
|
{
|
|
/// <summary>
|
|
/// Encapsulates the environment that is used to link object files.
|
|
/// </summary>
|
|
class LinkEnvironment
|
|
{
|
|
/// <summary>
|
|
/// The platform to be compiled/linked for.
|
|
/// </summary>
|
|
public readonly UnrealTargetPlatform Platform;
|
|
|
|
/// <summary>
|
|
/// The configuration to be compiled/linked for.
|
|
/// </summary>
|
|
public readonly CppConfiguration Configuration;
|
|
|
|
/// <summary>
|
|
/// The architecture that is being compiled/linked (empty string by default)
|
|
/// </summary>
|
|
public readonly string Architecture;
|
|
|
|
/// <summary>
|
|
/// On Mac, indicates the path to the target's application bundle
|
|
/// </summary>
|
|
public DirectoryReference? BundleDirectory;
|
|
|
|
/// <summary>
|
|
/// The directory to put the non-executable files in (PDBs, import library, etc)
|
|
/// </summary>
|
|
public DirectoryReference? OutputDirectory;
|
|
|
|
/// <summary>
|
|
/// Intermediate file directory
|
|
/// </summary>
|
|
public DirectoryReference? IntermediateDirectory;
|
|
|
|
/// <summary>
|
|
/// The directory to shadow source files in for syncing to remote compile servers
|
|
/// </summary>
|
|
public DirectoryReference? LocalShadowDirectory = null;
|
|
|
|
/// <summary>
|
|
/// The file path for the executable file that is output by the linker.
|
|
/// </summary>
|
|
public List<FileReference> OutputFilePaths = new List<FileReference>();
|
|
|
|
/// <summary>
|
|
/// Returns the OutputFilePath is there is only one entry in OutputFilePaths
|
|
/// </summary>
|
|
public FileReference OutputFilePath
|
|
{
|
|
get
|
|
{
|
|
if (OutputFilePaths.Count != 1)
|
|
{
|
|
throw new BuildException("Attempted to use LinkEnvironmentConfiguration.OutputFilePath property, but there are multiple (or no) OutputFilePaths. You need to handle multiple in the code that called this (size = {0})", OutputFilePaths.Count);
|
|
}
|
|
return OutputFilePaths[0];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// List of libraries to link in
|
|
/// </summary>
|
|
public List<FileReference> Libraries = new List<FileReference>();
|
|
|
|
/// <summary>
|
|
/// A list of additional libraries to link in (using the list of library search paths)
|
|
/// </summary>
|
|
public List<string> SystemLibraries = new List<string>();
|
|
|
|
/// <summary>
|
|
/// A list of the paths used to find libraries.
|
|
/// </summary>
|
|
public List<DirectoryReference> SystemLibraryPaths = new List<DirectoryReference>();
|
|
|
|
/// <summary>
|
|
/// A list of libraries to exclude from linking.
|
|
/// </summary>
|
|
public List<string> ExcludedLibraries = new List<string>();
|
|
|
|
/// <summary>
|
|
/// Paths to add as search paths for runtime libraries
|
|
/// </summary>
|
|
public List<string> RuntimeLibraryPaths = new List<string>();
|
|
|
|
/// <summary>
|
|
/// A list of additional frameworks to link in.
|
|
/// </summary>
|
|
public List<UEBuildFramework> AdditionalFrameworks = new List<UEBuildFramework>();
|
|
|
|
/// <summary>
|
|
/// The iOS/Mac frameworks to link in
|
|
/// </summary>
|
|
public List<string> Frameworks = new List<string>();
|
|
public List<string> WeakFrameworks = new List<string>();
|
|
|
|
/// <summary>
|
|
/// iOS/Mac resources that should be copied to the app bundle
|
|
/// </summary>
|
|
public List<UEBuildBundleResource> AdditionalBundleResources = new List<UEBuildBundleResource>();
|
|
|
|
/// <summary>
|
|
/// A list of the dynamically linked libraries that shouldn't be loaded until they are first called
|
|
/// into.
|
|
/// </summary>
|
|
public List<string> DelayLoadDLLs = new List<string>();
|
|
|
|
/// <summary>
|
|
/// Additional arguments to pass to the linker.
|
|
/// </summary>
|
|
public string AdditionalArguments = "";
|
|
|
|
/// <summary>
|
|
/// True if debug info should be created.
|
|
/// </summary>
|
|
public bool bCreateDebugInfo = true;
|
|
|
|
/// <summary>
|
|
/// True if runtime symbols files should be generated as a post build step for some platforms.
|
|
/// These files are used by the engine to resolve symbol names of callstack backtraces in logs.
|
|
/// </summary>
|
|
public bool bGenerateRuntimeSymbolFiles = true;
|
|
|
|
/// <summary>
|
|
/// True if debug symbols that are cached for some platforms should not be created.
|
|
/// </summary>
|
|
public bool bDisableSymbolCache = false;
|
|
|
|
/// <summary>
|
|
/// True if we're compiling .cpp files that will go into a library (.lib file)
|
|
/// </summary>
|
|
public bool bIsBuildingLibrary = false;
|
|
|
|
/// <summary>
|
|
/// True if we're compiling a DLL
|
|
/// </summary>
|
|
public bool bIsBuildingDLL = false;
|
|
|
|
/// <summary>
|
|
/// Whether we should compile using the statically-linked CRT. This is not widely supported for the whole engine, but is required for programs that need to run without dependencies.
|
|
/// </summary>
|
|
public bool bUseStaticCRT = false;
|
|
|
|
/// <summary>
|
|
/// Whether to use the debug CRT in debug configurations
|
|
/// </summary>
|
|
public bool bUseDebugCRT = false;
|
|
|
|
/// <summary>
|
|
/// True if this is a console application that's being build
|
|
/// </summary>
|
|
public bool bIsBuildingConsoleApplication = false;
|
|
|
|
/// <summary>
|
|
/// This setting is replaced by UEBuildBinaryConfiguration.bBuildAdditionalConsoleApp.
|
|
/// </summary>
|
|
[Obsolete("This setting is replaced by UEBuildBinaryConfiguration.bBuildAdditionalConsoleApp. It is explicitly set to true for editor targets, and defaults to false otherwise.")]
|
|
public bool bBuildAdditionalConsoleApplication { set { } }
|
|
|
|
/// <summary>
|
|
/// If set, overrides the program entry function on Windows platform. This is used by the base UE4
|
|
/// program so we can link in either command-line mode or windowed mode without having to recompile the Launch module.
|
|
/// </summary>
|
|
public string WindowsEntryPointOverride = String.Empty;
|
|
|
|
/// <summary>
|
|
/// True if we're building a EXE/DLL target with an import library, and that library is needed by a dependency that
|
|
/// we're directly dependent on.
|
|
/// </summary>
|
|
public bool bIsCrossReferenced = false;
|
|
|
|
/// <summary>
|
|
/// True if the application we're linking has any exports, and we should be expecting the linker to
|
|
/// generate a .lib and/or .exp file along with the target output file
|
|
/// </summary>
|
|
public bool bHasExports = true;
|
|
|
|
/// <summary>
|
|
/// True if we're building a .NET assembly (e.g. C# project)
|
|
/// </summary>
|
|
public bool bIsBuildingDotNetAssembly = false;
|
|
|
|
/// <summary>
|
|
/// The default stack memory size allocation
|
|
/// </summary>
|
|
public int DefaultStackSize = 5000000;
|
|
|
|
/// <summary>
|
|
/// The amount of the default stack size to commit initially. Set to 0 to allow the OS to decide.
|
|
/// </summary>
|
|
public int DefaultStackSizeCommit = 0;
|
|
|
|
/// <summary>
|
|
/// Whether to optimize for minimal code size
|
|
/// </summary>
|
|
public bool bOptimizeForSize = false;
|
|
|
|
/// <summary>
|
|
/// Whether to omit frame pointers or not. Disabling is useful for e.g. memory profiling on the PC
|
|
/// </summary>
|
|
public bool bOmitFramePointers = true;
|
|
|
|
/// <summary>
|
|
/// Whether to support edit and continue. Only works on Microsoft compilers in 32-bit compiles.
|
|
/// </summary>
|
|
public bool bSupportEditAndContinue;
|
|
|
|
/// <summary>
|
|
/// Whether to use incremental linking or not.
|
|
/// </summary>
|
|
public bool bUseIncrementalLinking;
|
|
|
|
/// <summary>
|
|
/// Whether to allow the use of LTCG (link time code generation)
|
|
/// </summary>
|
|
public bool bAllowLTCG;
|
|
|
|
/// <summary>
|
|
/// Whether to enable Profile Guided Optimization (PGO) instrumentation in this build.
|
|
/// </summary>
|
|
public bool bPGOProfile;
|
|
|
|
/// <summary>
|
|
/// Whether to optimize this build with Profile Guided Optimization (PGO).
|
|
/// </summary>
|
|
public bool bPGOOptimize;
|
|
|
|
/// <summary>
|
|
/// Platform specific directory where PGO profiling data is stored.
|
|
/// </summary>
|
|
public string? PGODirectory;
|
|
|
|
/// <summary>
|
|
/// Platform specific filename where PGO profiling data is saved.
|
|
/// </summary>
|
|
public string? PGOFilenamePrefix;
|
|
|
|
/// <summary>
|
|
/// Whether to request the linker create a map file as part of the build
|
|
/// </summary>
|
|
public bool bCreateMapFile;
|
|
|
|
/// <summary>
|
|
/// Whether PDB files should be used for Visual C++ builds.
|
|
/// </summary>
|
|
public bool bUsePDBFiles;
|
|
|
|
/// <summary>
|
|
/// Whether to use the :FASTLINK option when building with /DEBUG to create local PDBs
|
|
/// </summary>
|
|
public bool bUseFastPDBLinking;
|
|
|
|
/// <summary>
|
|
/// Whether to ignore dangling (i.e. unresolved external) symbols in modules
|
|
/// </summary>
|
|
public bool bIgnoreUnresolvedSymbols;
|
|
|
|
/// <summary>
|
|
/// Whether to log detailed timing information
|
|
/// </summary>
|
|
public bool bPrintTimingInfo;
|
|
|
|
/// <summary>
|
|
/// Bundle version for Mac apps
|
|
/// </summary>
|
|
public string? BundleVersion;
|
|
|
|
/// <summary>
|
|
/// When building a dynamic library on Apple platforms, specifies the installed name for other binaries that link against it.
|
|
/// </summary>
|
|
public string? InstallName;
|
|
|
|
/// <summary>
|
|
/// A list of the object files to be linked.
|
|
/// </summary>
|
|
public List<FileItem> InputFiles = new List<FileItem>();
|
|
|
|
/// <summary>
|
|
/// The default resource file to link in to every binary if a custom one is not provided
|
|
/// </summary>
|
|
public List<FileItem> DefaultResourceFiles = new List<FileItem>();
|
|
|
|
/// <summary>
|
|
/// Resource files which should be compiled into every binary
|
|
/// </summary>
|
|
public List<FileItem> CommonResourceFiles = new List<FileItem>();
|
|
|
|
/// <summary>
|
|
/// List of functions that should be exported from this module
|
|
/// </summary>
|
|
public List<string> IncludeFunctions = new List<string>();
|
|
|
|
/// <summary>
|
|
/// Provides a Module Definition File (.def) to the linker to describe various attributes of a DLL.
|
|
/// Necessary when exporting functions by ordinal values instead of by name.
|
|
/// </summary>
|
|
public string? ModuleDefinitionFile;
|
|
|
|
/// <summary>
|
|
/// All the additional properties from the modules linked into this binary
|
|
/// </summary>
|
|
public List<ReceiptProperty> AdditionalProperties = new List<ReceiptProperty>();
|
|
|
|
/// <summary>
|
|
/// Default constructor.
|
|
/// </summary>
|
|
public LinkEnvironment(UnrealTargetPlatform Platform, CppConfiguration Configuration, string Architecture)
|
|
{
|
|
this.Platform = Platform;
|
|
this.Configuration = Configuration;
|
|
this.Architecture = Architecture;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Copy constructor.
|
|
/// </summary>
|
|
public LinkEnvironment(LinkEnvironment Other)
|
|
{
|
|
Platform = Other.Platform;
|
|
Configuration = Other.Configuration;
|
|
Architecture = Other.Architecture;
|
|
BundleDirectory = Other.BundleDirectory;
|
|
OutputDirectory = Other.OutputDirectory;
|
|
IntermediateDirectory = Other.IntermediateDirectory;
|
|
LocalShadowDirectory = Other.LocalShadowDirectory;
|
|
OutputFilePaths = Other.OutputFilePaths.ToList();
|
|
Libraries.AddRange(Other.Libraries);
|
|
SystemLibraries.AddRange(Other.SystemLibraries);
|
|
SystemLibraryPaths.AddRange(Other.SystemLibraryPaths);
|
|
ExcludedLibraries.AddRange(Other.ExcludedLibraries);
|
|
RuntimeLibraryPaths.AddRange(Other.RuntimeLibraryPaths);
|
|
Frameworks.AddRange(Other.Frameworks);
|
|
AdditionalFrameworks.AddRange(Other.AdditionalFrameworks);
|
|
WeakFrameworks.AddRange(Other.WeakFrameworks);
|
|
AdditionalBundleResources.AddRange(Other.AdditionalBundleResources);
|
|
DelayLoadDLLs.AddRange(Other.DelayLoadDLLs);
|
|
AdditionalArguments = Other.AdditionalArguments;
|
|
bCreateDebugInfo = Other.bCreateDebugInfo;
|
|
bGenerateRuntimeSymbolFiles = Other.bGenerateRuntimeSymbolFiles;
|
|
bIsBuildingLibrary = Other.bIsBuildingLibrary;
|
|
bDisableSymbolCache = Other.bDisableSymbolCache;
|
|
bIsBuildingDLL = Other.bIsBuildingDLL;
|
|
bUseStaticCRT = Other.bUseStaticCRT;
|
|
bUseDebugCRT = Other.bUseDebugCRT;
|
|
bIsBuildingConsoleApplication = Other.bIsBuildingConsoleApplication;
|
|
WindowsEntryPointOverride = Other.WindowsEntryPointOverride;
|
|
bIsCrossReferenced = Other.bIsCrossReferenced;
|
|
bHasExports = Other.bHasExports;
|
|
bIsBuildingDotNetAssembly = Other.bIsBuildingDotNetAssembly;
|
|
DefaultStackSize = Other.DefaultStackSize;
|
|
DefaultStackSizeCommit = Other.DefaultStackSizeCommit;
|
|
bOptimizeForSize = Other.bOptimizeForSize;
|
|
bOmitFramePointers = Other.bOmitFramePointers;
|
|
bSupportEditAndContinue = Other.bSupportEditAndContinue;
|
|
bUseIncrementalLinking = Other.bUseIncrementalLinking;
|
|
bAllowLTCG = Other.bAllowLTCG;
|
|
bPGOOptimize = Other.bPGOOptimize;
|
|
bPGOProfile = Other.bPGOProfile;
|
|
PGODirectory = Other.PGODirectory;
|
|
PGOFilenamePrefix = Other.PGOFilenamePrefix;
|
|
bCreateMapFile = Other.bCreateMapFile;
|
|
bUsePDBFiles = Other.bUsePDBFiles;
|
|
bUseFastPDBLinking = Other.bUseFastPDBLinking;
|
|
bIgnoreUnresolvedSymbols = Other.bIgnoreUnresolvedSymbols;
|
|
bPrintTimingInfo = Other.bPrintTimingInfo;
|
|
BundleVersion = Other.BundleVersion;
|
|
InstallName = Other.InstallName;
|
|
InputFiles.AddRange(Other.InputFiles);
|
|
DefaultResourceFiles.AddRange(Other.DefaultResourceFiles);
|
|
CommonResourceFiles.AddRange(Other.CommonResourceFiles);
|
|
IncludeFunctions.AddRange(Other.IncludeFunctions);
|
|
ModuleDefinitionFile = Other.ModuleDefinitionFile;
|
|
AdditionalProperties.AddRange(Other.AdditionalProperties);
|
|
}
|
|
}
|
|
}
|