Source-build symbols repackaging #17454
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.Collections; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Reflection.Metadata; | ||
| using System.Reflection.PortableExecutable; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
|
|
||
| namespace Microsoft.DotNet.Build.Tasks | ||
| { | ||
| // Creates a symbols layout that matches the SDK layout | ||
| public class CreateSdkSymbolsLayout : Task | ||
| { | ||
| /// <summary> | ||
| /// Path to SDK layout. | ||
| /// </summary> | ||
| [Required] | ||
| public string SdkLayoutPath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Path to all source-built symbols, flat or with folder hierarchy. | ||
| /// </summary> | ||
| [Required] | ||
| public string AllSymbolsPath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Path to SDK symbols layout - will be created if it doesn't exist. | ||
| /// </summary> | ||
| [Required] | ||
| public string SdkSymbolsLayoutPath { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// If true, fails the build if any PDBs are missing. | ||
| /// </summary> | ||
| public bool FailOnMissingPDBs { get; set; } | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| IList<string> filesWithoutPDBs = GenerateSymbolsLayout(IndexAllSymbols()); | ||
| if (filesWithoutPDBs.Count > 0) | ||
| { | ||
| LogErrorOrWarning(FailOnMissingPDBs, $"Did not find PDBs for the following SDK files:"); | ||
| foreach (string file in filesWithoutPDBs) | ||
| { | ||
| LogErrorOrWarning(FailOnMissingPDBs, file); | ||
| } | ||
| } | ||
|
|
||
| return !Log.HasLoggedErrors; | ||
| } | ||
|
|
||
| private void LogErrorOrWarning(bool isError, string message) | ||
| { | ||
| if (FailOnMissingPDBs) | ||
| { | ||
| Log.LogError(message); | ||
| } | ||
| else | ||
| { | ||
| Log.LogWarning(message); | ||
| } | ||
| } | ||
|
|
||
| private IList<string> GenerateSymbolsLayout(Hashtable allPdbGuids) | ||
| { | ||
| List<string> filesWithoutPDBs = new List<string>(); | ||
|
|
||
| if (Directory.Exists(SdkSymbolsLayoutPath)) | ||
| { | ||
| Directory.Delete(SdkSymbolsLayoutPath, true); | ||
| } | ||
|
|
||
| foreach (string file in Directory.GetFiles(SdkLayoutPath, "*", SearchOption.AllDirectories)) | ||
| { | ||
| if (file.EndsWith(".dll", StringComparison.InvariantCultureIgnoreCase) && | ||
| !file.EndsWith(".resources.dll", StringComparison.InvariantCultureIgnoreCase)) | ||
| { | ||
| string guid = string.Empty; | ||
| using var pdbStream = File.OpenRead(file); | ||
| using var peReader = new PEReader(pdbStream); | ||
| try | ||
| { | ||
| // Check if pdb is embedded | ||
| if (peReader.ReadDebugDirectory().Any(entry => entry.Type == DebugDirectoryEntryType.EmbeddedPortablePdb)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var debugDirectory = peReader.ReadDebugDirectory().First(entry => entry.Type == DebugDirectoryEntryType.CodeView); | ||
| var codeViewData = peReader.ReadCodeViewDebugDirectoryData(debugDirectory); | ||
| guid = $"{codeViewData.Guid.ToString("N").Replace("-", string.Empty)}"; | ||
| } | ||
| catch (Exception e) when (e is BadImageFormatException || e is InvalidOperationException) | ||
| { | ||
| // Ignore binaries without debug info | ||
| continue; | ||
| } | ||
|
|
||
| if (guid != string.Empty) | ||
| { | ||
| if (!allPdbGuids.ContainsKey(guid)) | ||
| { | ||
| filesWithoutPDBs.Add(file.Substring(SdkLayoutPath.Length + 1)); | ||
| } | ||
| else | ||
| { | ||
| // Copy matching pdb to symbols path, preserving sdk binary's hierarchy | ||
| string sourcePath = (string)allPdbGuids[guid]!; | ||
| string destinationPath = | ||
| file.Replace(SdkLayoutPath, SdkSymbolsLayoutPath) | ||
| .Replace(Path.GetFileName(file), Path.GetFileName(sourcePath)); | ||
|
|
||
| Directory.CreateDirectory(Path.GetDirectoryName(destinationPath)!); | ||
| File.Copy(sourcePath, destinationPath, true); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return filesWithoutPDBs; | ||
| } | ||
|
|
||
| public Hashtable IndexAllSymbols() | ||
| { | ||
| Hashtable allPdbGuids = new Hashtable(); | ||
|
|
||
| foreach (string file in Directory.GetFiles(AllSymbolsPath, "*.pdb", SearchOption.AllDirectories)) | ||
| { | ||
| using var pdbFileStream = File.OpenRead(file); | ||
| var metadataProvider = MetadataReaderProvider.FromPortablePdbStream(pdbFileStream); | ||
| var metadataReader = metadataProvider.GetMetadataReader(); | ||
| if (metadataReader.DebugMetadataHeader == null) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var id = new BlobContentId(metadataReader.DebugMetadataHeader.Id); | ||
| string guid = $"{id.Guid:N}"; | ||
| if (!string.IsNullOrEmpty(guid) && !allPdbGuids.ContainsKey(guid)) | ||
| { | ||
| allPdbGuids.Add(guid, file); | ||
| } | ||
| } | ||
|
|
||
| return allPdbGuids; | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.