Skip to content

Couple of fixes and tweaks to the R2R creation logic #3121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nguerrera merged 2 commits into from
Apr 17, 2019
+134 −23
Merged

Couple of fixes and tweaks to the R2R creation logic #3121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a77ab81
Changing crossgen commands to use response files.
Mar 26, 2019
e60e05e
CR feedback, and removing temp debugging code
Apr 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions src/Tasks/Microsoft.NET.Build.Tasks/PrepareForReadyToRunCompilation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ public class PrepareForReadyToRunCompilation : TaskBase
[Required]
public string OutputPath { get; set; }
[Required]
public string TargetFramework { get; set; }
[Required]
public ITaskItem[] RuntimePacks { get; set; }
[Required]
public ITaskItem[] KnownFrameworkReferences { get; set; }
Expand Down Expand Up @@ -69,9 +67,7 @@ public class PrepareForReadyToRunCompilation : TaskBase
private string _packagePath;
private string _crossgenPath;
private string _clrjitPath;
private string _platformAssembliesPath;
private string _diasymreaderPath;
private string _pathSeparatorCharacter = ";";

private Architecture _targetArchitecture;

Expand Down Expand Up @@ -146,7 +142,6 @@ void ProcessInputFileList(ITaskItem[] inputFiles, List<ITaskItem> imageCompilati
// an input to the ReadyToRunCompiler task
TaskItem r2rCompilationEntry = new TaskItem(file);
r2rCompilationEntry.SetMetadata("OutputR2RImage", outputR2RImage);
r2rCompilationEntry.SetMetadata("PlatformAssembliesPaths", $"{_platformAssembliesPath}{_pathSeparatorCharacter}{Path.GetDirectoryName(file.ItemSpec)}");
r2rCompilationEntry.RemoveMetadata(MetadataKeys.OriginalItemSpec);
imageCompilationList.Add(r2rCompilationEntry);

Expand Down Expand Up @@ -193,7 +188,6 @@ void ProcessInputFileList(ITaskItem[] inputFiles, List<ITaskItem> imageCompilati
pdbCompilationEntry.ItemSpec = outputR2RImage;
pdbCompilationEntry.SetMetadata("OutputPDBImage", outputPDBImage);
pdbCompilationEntry.SetMetadata("CreatePDBCommand", createPDBCommand);
pdbCompilationEntry.SetMetadata("PlatformAssembliesPaths", $"{_platformAssembliesPath}{_pathSeparatorCharacter}{Path.GetDirectoryName(file.ItemSpec)}");
symbolsCompilationList.Add(pdbCompilationEntry);

// This TaskItem corresponds to the output PDB image. It is equivalent to the input TaskItem, only the ItemSpec for it points to the new path
Expand Down Expand Up @@ -386,8 +380,6 @@ bool GetCrossgenComponentsPaths()
}
else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
_pathSeparatorCharacter = ":";

if (_targetArchitecture == Architecture.Arm || _targetArchitecture == Architecture.Arm64)
{
// We only have x64 hosted crossgen for both ARM target architectures
Expand All @@ -406,8 +398,6 @@ bool GetCrossgenComponentsPaths()
}
else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
_pathSeparatorCharacter = ":";

// Only x64 supported for OSX
if (_targetArchitecture != Architecture.X64 || RuntimeInformation.OSArchitecture != Architecture.X64)
return false;
Expand All @@ -421,10 +411,6 @@ bool GetCrossgenComponentsPaths()
return false;
}

_platformAssembliesPath =
Path.Combine(_packagePath, "runtimes", _runtimeIdentifier, "native") + _pathSeparatorCharacter +
Path.Combine(_packagePath, "runtimes", _runtimeIdentifier, "lib", TargetFramework);

return true;
}
}
Expand Down
132 changes: 125 additions & 7 deletions src/Tasks/Microsoft.NET.Build.Tasks/RunReadyToRunCompiler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;
using System.Text;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

Expand All @@ -14,6 +18,8 @@ public class RunReadyToRunCompiler : ToolTask
public ITaskItem CrossgenTool { get; set; }
[Required]
public ITaskItem CompilationEntry { get; set; }
[Required]
public ITaskItem[] ImplementationAssemblies { get; set; }

private string _crossgenPath;
private string _clrjitPath;
Expand All @@ -22,7 +28,6 @@ public class RunReadyToRunCompiler : ToolTask
private string _inputAssembly;
private string _outputR2RImage;
private string _outputPDBImage;
private string _platformAssembliesPaths;
private string _createPDBCommand;

private bool IsPdbCompilation => !String.IsNullOrEmpty(_createPDBCommand);
Expand All @@ -48,7 +53,6 @@ protected override bool ValidateParameters()
}

_createPDBCommand = CompilationEntry.GetMetadata("CreatePDBCommand");
_platformAssembliesPaths = CompilationEntry.GetMetadata("PlatformAssembliesPaths");

if (IsPdbCompilation)
{
Expand Down Expand Up @@ -80,18 +84,132 @@ protected override bool ValidateParameters()
return true;
}

protected override string GenerateCommandLineCommands()
// TEMP LOGIC - SDK Should provide correct list - When fixing https://github.com/dotnet/sdk/issues/3110, delete
// both IsManagedAssemblyToUseAsCrossgenReference and IsReferenceAssembly
bool IsManagedAssemblyToUseAsCrossgenReference(ITaskItem file)
{
// Reference only managed assemblies that will be published to the root directory.
string relativeOutputPath = file.GetMetadata(MetadataKeys.RelativePath);
if (!String.IsNullOrEmpty(Path.GetDirectoryName(relativeOutputPath)))
{
return false;
}

using (FileStream fs = new FileStream(file.ItemSpec, FileMode.Open, FileAccess.Read))
{
try
{
using (var pereader = new PEReader(fs))
{
if (!pereader.HasMetadata)
return false;

MetadataReader mdReader = pereader.GetMetadataReader();
if (!mdReader.IsAssembly)
return false;

// Reference assemblies should never be given to crossgen
if (IsReferenceAssembly(mdReader))
return false;
}
}
catch (BadImageFormatException)
{
// Not a valid assembly file
return false;
}
}

return true;
}

private bool IsReferenceAssembly(MetadataReader mdReader)
{
foreach (var attributeHandle in mdReader.GetAssemblyDefinition().GetCustomAttributes())
{
StringHandle attributeTypeName = default;
StringHandle attributeTypeNamespace = default;
EntityHandle attributeCtor = mdReader.GetCustomAttribute(attributeHandle).Constructor;

if (attributeCtor.Kind == HandleKind.MemberReference)
{
EntityHandle attributeMemberParent = mdReader.GetMemberReference((MemberReferenceHandle)attributeCtor).Parent;
if (attributeMemberParent.Kind == HandleKind.TypeReference)
{
TypeReference attributeTypeRef = mdReader.GetTypeReference((TypeReferenceHandle)attributeMemberParent);
attributeTypeName = attributeTypeRef.Name;
attributeTypeNamespace = attributeTypeRef.Namespace;
}
}
else if (attributeCtor.Kind == HandleKind.MethodDefinition)
{
TypeDefinitionHandle attributeTypeDefHandle = mdReader.GetMethodDefinition((MethodDefinitionHandle)attributeCtor).GetDeclaringType();
TypeDefinition attributeTypeDef = mdReader.GetTypeDefinition(attributeTypeDefHandle);
attributeTypeName = attributeTypeDef.Name;
attributeTypeNamespace = attributeTypeDef.Namespace;
}

if (!attributeTypeName.IsNil &&
!attributeTypeNamespace.IsNil &&
mdReader.StringComparer.Equals(attributeTypeName, "ReferenceAssemblyAttribute") &&
mdReader.StringComparer.Equals(attributeTypeNamespace, "System.Runtime.CompilerServices"))
{
return true;
}
}

return false;
}

private string GetAssemblyReferencesCommands()
{
StringBuilder result = new StringBuilder();

// Add all runtime libraries to the list of references passed to crossgen
foreach (var runtimeAssembly in ImplementationAssemblies)
{
// When generating PDBs, we must not add a reference to the IL version of the R2R image for which we're trying to generate a PDB
if (IsPdbCompilation && String.Equals(Path.GetFileName(runtimeAssembly.ItemSpec), Path.GetFileName(_outputR2RImage), StringComparison.OrdinalIgnoreCase))
continue;

// TODO: Delete check when fixing https://github.com/dotnet/sdk/issues/3110
if (!IsManagedAssemblyToUseAsCrossgenReference(runtimeAssembly))
continue;

result.AppendLine($"/r \"{runtimeAssembly}\"");
}

return result.ToString();
}

protected override string GenerateResponseFileCommands()
{
StringBuilder result = new StringBuilder();

result.AppendLine("/nologo");

if (IsPdbCompilation)
{
return String.IsNullOrEmpty(_diasymreaderPath) ?
$"/nologo /Platform_Assemblies_Paths \"{_platformAssembliesPaths}\" {_createPDBCommand} \"{_outputR2RImage}\"" :
$"/nologo /Platform_Assemblies_Paths \"{_platformAssembliesPaths}\" /DiasymreaderPath \"{_diasymreaderPath}\" {_createPDBCommand} \"{_outputR2RImage}\"";
result.Append(GetAssemblyReferencesCommands());

if (!String.IsNullOrEmpty(_diasymreaderPath))
{
result.AppendLine($"/DiasymreaderPath \"{_diasymreaderPath}\"");
}

result.AppendLine(_createPDBCommand);
result.AppendLine($"\"{_outputR2RImage}\"");
}
else
{
return $"/nologo /MissingDependenciesOK /JITPath \"{_clrjitPath}\" /Platform_Assemblies_Paths \"{_platformAssembliesPaths}\" /out \"{_outputR2RImage}\" \"{_inputAssembly}\"";
result.AppendLine("/MissingDependenciesOK");
result.AppendLine($"/JITPath \"{_clrjitPath}\"");
result.Append(GetAssemblyReferencesCommands());
result.AppendLine($"/out \"{_outputR2RImage}\"");
result.AppendLine($"\"{_inputAssembly}\"");
}

return result.ToString();
}

protected override int ExecuteTool(string pathToTool, string responseFileCommands, string commandLineCommands)
Expand Down
11 changes: 9 additions & 2 deletions src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,7 @@ Copyright (c) .NET Foundation. All rights reserved.

<MakeDir Directories="$(_ReadyToRunOutputPath)" />

<PrepareForReadyToRunCompilation TargetFramework="$(TargetFramework)"
RuntimePacks="@(ResolvedRuntimePack)"
<PrepareForReadyToRunCompilation RuntimePacks="@(ResolvedRuntimePack)"
RuntimeGraphPath="$(BundledRuntimeIdentifierGraphFile)"
KnownFrameworkReferences="@(KnownFrameworkReference)"
NETCoreSdkRuntimeIdentifier="$(NETCoreSdkRuntimeIdentifier)"
Expand Down Expand Up @@ -263,7 +262,9 @@ Copyright (c) .NET Foundation. All rights reserved.
Inputs="@(_ReadyToRunCompileListPreserveNewest)"
Outputs="%(_ReadyToRunCompileListPreserveNewest.OutputR2RImage)">

<!-- TODO: BUG - FIX ImplementationAssemblies to take managed implementation assemblies to use as crossgen references -->
<RunReadyToRunCompiler CrossgenTool="@(_CrossgenTool)"
ImplementationAssemblies="@(ResolvedFileToPublish)"
CompilationEntry="@(_ReadyToRunCompileListPreserveNewest)"
ContinueOnError="ErrorAndContinue">
<Output TaskParameter="ExitCode" PropertyName="_ReadyToRunCompilerExitCode" />
Expand All @@ -286,7 +287,9 @@ Copyright (c) .NET Foundation. All rights reserved.
Inputs="@(_ReadyToRunSymbolsCompileListPreserveNewest)"
Outputs="%(_ReadyToRunSymbolsCompileListPreserveNewest.OutputPDBImage)">

<!-- TODO: BUG - FIX ImplementationAssemblies to take managed implementation assemblies to use as crossgen references -->
<RunReadyToRunCompiler CrossgenTool="@(_CrossgenTool)"
ImplementationAssemblies="@(ResolvedFileToPublish)"
CompilationEntry="@(_ReadyToRunSymbolsCompileListPreserveNewest)"
ContinueOnError="ErrorAndContinue">
<Output TaskParameter="ExitCode" PropertyName="_ReadyToRunCompilerExitCode" />
Expand All @@ -309,7 +312,9 @@ Copyright (c) .NET Foundation. All rights reserved.
Inputs="@(_ReadyToRunCompileListPublishAlways)"
Outputs="%(_ReadyToRunCompileListPublishAlways.OutputR2RImage)">

<!-- TODO: BUG - FIX ImplementationAssemblies to take managed implementation assemblies to use as crossgen references -->
<RunReadyToRunCompiler CrossgenTool="@(_CrossgenTool)"
ImplementationAssemblies="@(ResolvedFileToPublish)"
CompilationEntry="@(_ReadyToRunCompileListPublishAlways)"
ContinueOnError="ErrorAndContinue">
<Output TaskParameter="ExitCode" PropertyName="_ReadyToRunCompilerExitCode" />
Expand All @@ -332,7 +337,9 @@ Copyright (c) .NET Foundation. All rights reserved.
Inputs="@(_ReadyToRunSymbolsCompileListPublishAlways)"
Outputs="%(_ReadyToRunSymbolsCompileListPublishAlways.OutputPDBImage)">

<!-- TODO: BUG - FIX ImplementationAssemblies to take managed implementation assemblies to use as crossgen references -->
<RunReadyToRunCompiler CrossgenTool="@(_CrossgenTool)"
ImplementationAssemblies="@(ResolvedFileToPublish)"
CompilationEntry="@(_ReadyToRunSymbolsCompileListPublishAlways)"
ContinueOnError="ErrorAndContinue">
<Output TaskParameter="ExitCode" PropertyName="_ReadyToRunCompilerExitCode" />
Expand Down