private static void VerifyPdb(
this CompilationDifference diff,
IEnumerable <int> methodTokens,
string expectedPdb,
DebugInformationFormat format,
int expectedValueSourceLine,
string expectedValueSourcePath,
bool expectedIsXmlLiteral)
{
Assert.NotEqual(default(DebugInformationFormat), format);
Assert.NotEqual(DebugInformationFormat.Embedded, format);
// Include module custom debug info, specifically compilation options and references.
// These shouldn't be emitted in EnC deltas and we want to validate that.
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(new ImmutableMemoryStream(diff.PdbDelta), methodTokens, PdbToXmlOptions.IncludeTokens | PdbToXmlOptions.IncludeModuleDebugInfo);
var(actual, expected) = AdjustToPdbFormat(actualPdb, expectedPdb, actualIsPortable: diff.NextGeneration.InitialBaseline.HasPortablePdb, actualIsConverted: false);
AssertEx.AssertLinesEqual(
expected,
actual,
$"PDB format: {format}{Environment.NewLine}",
expectedValueSourcePath,
expectedValueSourceLine,
escapeQuotes: !expectedIsXmlLiteral);
}
private static void VerifyPdb(
this CompilationDifference diff,
IEnumerable <int> methodTokens,
string expectedPdb,
DebugInformationFormat format,
int expectedValueSourceLine,
string expectedValueSourcePath,
bool expectedIsXmlLiteral
)
{
Assert.NotEqual(default(DebugInformationFormat), format);
Assert.NotEqual(DebugInformationFormat.Embedded, format);
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(
new ImmutableMemoryStream(diff.PdbDelta),
methodTokens
);
var(actual, expected) = AdjustToPdbFormat(
actualPdb,
expectedPdb,
actualIsPortable: diff.NextGeneration.InitialBaseline.HasPortablePdb,
actualIsConverted: false
);
AssertEx.AssertLinesEqual(
expected,
actual,
$"PDB format: {format}{Environment.NewLine}",
expectedValueSourcePath,
expectedValueSourceLine,
escapeQuotes: !expectedIsXmlLiteral
);
}
public static void GenXmlFromDeltaPdb(string pdbPath, string outPath)
{
using var deltaPdb = new FileStream(pdbPath, FileMode.Open, FileAccess.Read);
// There is no easy way to enumerate all method tokens that are present in the PDB.
// So dump the first 255 method tokens (the ones that are not present will be skipped):
File.WriteAllText(outPath, PdbToXmlConverter.DeltaPdbToXml(deltaPdb, Enumerable.Range(0x06000001, 255)));
}
protected override void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
{
StringBuilder sb = new StringBuilder();
var pdb = (PdbDelta)objectProvider.GetObject();
string xml = PdbToXmlConverter.DeltaPdbToXml(pdb.Stream, Enumerable.Range(0x06000001, 0xff));
var viewer = new TextViewer(xml, "PDB");
viewer.ShowDialog();
}
public void VerifyPdb(
IEnumerable <int> methodTokens,
XElement expectedPdb,
[CallerLineNumber] int expectedValueSourceLine = 0,
[CallerFilePath] string expectedValueSourcePath = null)
{
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(PdbDelta, methodTokens);
AssertXml.Equal(expectedPdb, XElement.Parse(actualPdb), expectedValueSourcePath, expectedValueSourceLine, expectedIsXmlLiteral: true);
}
public override void GetData(object target, Stream outgoingData)
{
var pdbDelta = (PdbDelta)target;
var text = PdbToXmlConverter.DeltaPdbToXml(pdbDelta.Stream, Enumerable.Range(0x06000001, 0xff));
var writer = new StreamWriter(outgoingData);
writer.Write(text);
writer.Flush();
}
private void VerifyPdb(
IEnumerable <int> methodTokens,
string expectedPdb,
DebugInformationFormat format,
int expectedValueSourceLine,
string expectedValueSourcePath,
bool expectedIsXmlLiteral)
{
Assert.NotEqual(default(DebugInformationFormat), format);
Assert.NotEqual(DebugInformationFormat.Embedded, format);
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(new ImmutableMemoryStream(PdbDelta), methodTokens);
var(actualXml, expectedXml) = PdbValidation.AdjustToPdbFormat(actualPdb, expectedPdb, actualIsPortable: NextGeneration.InitialBaseline.HasPortablePdb);
AssertXml.Equal(expectedXml, actualXml, $"Format: {format}{Environment.NewLine}", expectedValueSourcePath, expectedValueSourceLine, expectedIsXmlLiteral);
}
private void VerifyPdb(
IEnumerable <int> methodTokens,
XElement expectedPdb,
DebugInformationFormat format,
int expectedValueSourceLine,
string expectedValueSourcePath,
bool expectedIsXmlLiteral)
{
Assert.NotEqual(DebugInformationFormat.Embedded, format);
var actualXml = XElement.Parse(PdbToXmlConverter.DeltaPdbToXml(new ImmutableMemoryStream(PdbDelta), methodTokens));
PdbValidation.AdjustToPdbFormat(
actualPdb: actualXml,
actualIsPortable: NextGeneration.InitialBaseline.HasPortablePdb,
expectedPdb: expectedPdb,
expectedIsPortable: format != DebugInformationFormat.Pdb);
AssertXml.Equal(expectedPdb, actualXml, expectedValueSourcePath, expectedValueSourceLine, expectedIsXmlLiteral);
}
internal void VerifyIL(
string qualifiedMethodName,
string expectedIL,
Func <Cci.ILocalDefinition, ILVisualizer.LocalInfo> mapLocal = null,
MethodDefinitionHandle methodToken = default,
[CallerFilePath] string callerPath = null,
[CallerLineNumber] int callerLine = 0
)
{
var ilBuilder = TestData.GetMethodData(qualifiedMethodName).ILBuilder;
Dictionary <int, string> sequencePointMarkers = null;
if (!methodToken.IsNil)
{
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(
new ImmutableMemoryStream(PdbDelta),
new[] { MetadataTokens.GetToken(methodToken) }
);
sequencePointMarkers = ILValidation.GetSequencePointMarkers(actualPdb);
Assert.True(
sequencePointMarkers.Count > 0,
$"No sequence points found in:{Environment.NewLine}{actualPdb}"
);
}
string actualIL = ILBuilderVisualizer.ILBuilderToString(
ilBuilder,
mapLocal ?? ToLocalInfo,
sequencePointMarkers
);
AssertEx.AssertEqualToleratingWhitespaceDifferences(
expectedIL,
actualIL,
escapeQuotes: true,
expectedValueSourcePath: callerPath,
expectedValueSourceLine: callerLine
);
}
public void VerifyIL(
string qualifiedMethodName,
string expectedIL,
Func <Cci.ILocalDefinition, ILVisualizer.LocalInfo> mapLocal = null,
MethodDefinitionHandle methodToken = default(MethodDefinitionHandle),
[CallerFilePath] string callerPath = null,
[CallerLineNumber] int callerLine = 0)
{
var ilBuilder = TestData.GetMethodData(qualifiedMethodName).ILBuilder;
Dictionary <int, string> sequencePointMarkers = null;
if (!methodToken.IsNil)
{
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(PdbDelta, new[] { MetadataTokens.GetToken(methodToken) });
sequencePointMarkers = TestBase.GetMarkers(actualPdb);
}
string actualIL = ILBuilderVisualizer.ILBuilderToString(ilBuilder, mapLocal ?? ToLocalInfo, sequencePointMarkers);
AssertEx.AssertEqualToleratingWhitespaceDifferences(expectedIL, actualIL, escapeQuotes: true, expectedValueSourcePath: callerPath, expectedValueSourceLine: callerLine);
}
public void AddIteratorMethod()
{
var source0 =
@"using System.Collections.Generic;
class C
{
static IEnumerable<object> F()
{
yield return 0;
}
static void M()
{
}
}";
var source1 =
@"using System.Collections.Generic;
class C
{
static IEnumerable<object> F()
{
yield return 0;
}
static IEnumerable<int> G()
{
yield return 1;
}
static void M()
{
}
}";
var compilation0 = CreateCompilationWithMscorlib(Parse(source0, "a.cs"), options: TestOptions.DebugDll);
var compilation1 = CreateCompilationWithMscorlib(Parse(source1, "a.cs"), options: TestOptions.DebugDll);
var bytes0 = compilation0.EmitToArray();
var generation0 = EmitBaseline.CreateInitialBaseline(ModuleMetadata.CreateFromImage(bytes0), EmptyLocalsProvider);
var diff1 = compilation1.EmitDifference(
generation0,
ImmutableArray.Create(new SemanticEdit(SemanticEditKind.Insert, null, compilation1.GetMember <MethodSymbol>("C.G"))));
using (var md1 = diff1.GetMetadata())
{
var reader1 = md1.Reader;
CheckEncLog(reader1,
Row(2, TableIndex.AssemblyRef, EditAndContinueOperation.Default),
Row(17, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(18, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(19, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(20, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(21, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(22, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(23, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(24, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(25, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(26, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(27, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(28, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(29, TableIndex.MemberRef, EditAndContinueOperation.Default),
Row(16, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(17, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(18, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(19, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(20, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(21, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(22, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(23, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(24, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(25, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(26, TableIndex.TypeRef, EditAndContinueOperation.Default),
Row(3, TableIndex.TypeSpec, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeSpec, EditAndContinueOperation.Default),
Row(4, TableIndex.StandAloneSig, EditAndContinueOperation.Default),
Row(5, TableIndex.StandAloneSig, EditAndContinueOperation.Default),
Row(6, TableIndex.StandAloneSig, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.Default),
Row(2, TableIndex.PropertyMap, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddField),
Row(4, TableIndex.Field, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddField),
Row(5, TableIndex.Field, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddField),
Row(6, TableIndex.Field, EditAndContinueOperation.Default),
Row(2, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(12, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(13, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(14, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(15, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(16, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(17, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(18, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(19, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(4, TableIndex.TypeDef, EditAndContinueOperation.AddMethod),
Row(20, TableIndex.MethodDef, EditAndContinueOperation.Default),
Row(2, TableIndex.PropertyMap, EditAndContinueOperation.AddProperty),
Row(3, TableIndex.Property, EditAndContinueOperation.Default),
Row(2, TableIndex.PropertyMap, EditAndContinueOperation.AddProperty),
Row(4, TableIndex.Property, EditAndContinueOperation.Default),
Row(13, TableIndex.MethodDef, EditAndContinueOperation.AddParameter),
Row(2, TableIndex.Param, EditAndContinueOperation.Default),
Row(12, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(13, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(14, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(15, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(16, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(17, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(18, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(19, TableIndex.CustomAttribute, EditAndContinueOperation.Default),
Row(3, TableIndex.MethodSemantics, EditAndContinueOperation.Default),
Row(4, TableIndex.MethodSemantics, EditAndContinueOperation.Default),
Row(8, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(9, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(10, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(11, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(12, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(13, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(14, TableIndex.MethodImpl, EditAndContinueOperation.Default),
Row(2, TableIndex.NestedClass, EditAndContinueOperation.Default),
Row(6, TableIndex.InterfaceImpl, EditAndContinueOperation.Default),
Row(7, TableIndex.InterfaceImpl, EditAndContinueOperation.Default),
Row(8, TableIndex.InterfaceImpl, EditAndContinueOperation.Default),
Row(9, TableIndex.InterfaceImpl, EditAndContinueOperation.Default),
Row(10, TableIndex.InterfaceImpl, EditAndContinueOperation.Default));
CheckEncMap(reader1,
Handle(16, TableIndex.TypeRef),
Handle(17, TableIndex.TypeRef),
Handle(18, TableIndex.TypeRef),
Handle(19, TableIndex.TypeRef),
Handle(20, TableIndex.TypeRef),
Handle(21, TableIndex.TypeRef),
Handle(22, TableIndex.TypeRef),
Handle(23, TableIndex.TypeRef),
Handle(24, TableIndex.TypeRef),
Handle(25, TableIndex.TypeRef),
Handle(26, TableIndex.TypeRef),
Handle(4, TableIndex.TypeDef),
Handle(4, TableIndex.Field),
Handle(5, TableIndex.Field),
Handle(6, TableIndex.Field),
Handle(12, TableIndex.MethodDef),
Handle(13, TableIndex.MethodDef),
Handle(14, TableIndex.MethodDef),
Handle(15, TableIndex.MethodDef),
Handle(16, TableIndex.MethodDef),
Handle(17, TableIndex.MethodDef),
Handle(18, TableIndex.MethodDef),
Handle(19, TableIndex.MethodDef),
Handle(20, TableIndex.MethodDef),
Handle(2, TableIndex.Param),
Handle(6, TableIndex.InterfaceImpl),
Handle(7, TableIndex.InterfaceImpl),
Handle(8, TableIndex.InterfaceImpl),
Handle(9, TableIndex.InterfaceImpl),
Handle(10, TableIndex.InterfaceImpl),
Handle(17, TableIndex.MemberRef),
Handle(18, TableIndex.MemberRef),
Handle(19, TableIndex.MemberRef),
Handle(20, TableIndex.MemberRef),
Handle(21, TableIndex.MemberRef),
Handle(22, TableIndex.MemberRef),
Handle(23, TableIndex.MemberRef),
Handle(24, TableIndex.MemberRef),
Handle(25, TableIndex.MemberRef),
Handle(26, TableIndex.MemberRef),
Handle(27, TableIndex.MemberRef),
Handle(28, TableIndex.MemberRef),
Handle(29, TableIndex.MemberRef),
Handle(12, TableIndex.CustomAttribute),
Handle(13, TableIndex.CustomAttribute),
Handle(14, TableIndex.CustomAttribute),
Handle(15, TableIndex.CustomAttribute),
Handle(16, TableIndex.CustomAttribute),
Handle(17, TableIndex.CustomAttribute),
Handle(18, TableIndex.CustomAttribute),
Handle(19, TableIndex.CustomAttribute),
Handle(4, TableIndex.StandAloneSig),
Handle(5, TableIndex.StandAloneSig),
Handle(6, TableIndex.StandAloneSig),
Handle(2, TableIndex.PropertyMap),
Handle(3, TableIndex.Property),
Handle(4, TableIndex.Property),
Handle(3, TableIndex.MethodSemantics),
Handle(4, TableIndex.MethodSemantics),
Handle(8, TableIndex.MethodImpl),
Handle(9, TableIndex.MethodImpl),
Handle(10, TableIndex.MethodImpl),
Handle(11, TableIndex.MethodImpl),
Handle(12, TableIndex.MethodImpl),
Handle(13, TableIndex.MethodImpl),
Handle(14, TableIndex.MethodImpl),
Handle(3, TableIndex.TypeSpec),
Handle(4, TableIndex.TypeSpec),
Handle(2, TableIndex.AssemblyRef),
Handle(2, TableIndex.NestedClass));
}
string actualPdb1 = PdbToXmlConverter.DeltaPdbToXml(diff1.PdbDelta, Enumerable.Range(1, 100).Select(rid => 0x06000000U | (uint)rid));
// TODO (tomat): bug in SymWriter.
// The PDB is missing debug info for G method. The info is written to the PDB but the native SymWriter
// seems to ignore it. If another method is added to the class all information is written.
// This happens regardless of whether we emit just the delta or full PDB.
string expectedPdb1 = @"
<symbols>
<files>
<file id=""1"" name=""a.cs"" language=""3f5162f8-07c6-11d3-9053-00c04fa302a1"" languageVendor=""994b45c4-e6e9-11d2-903f-00c04fa302a1"" documentType=""5a869d0b-6611-11d3-bd2a-0000f80849bd"" checkSumAlgorithmId=""ff1816ec-aa5e-4d10-87f7-6f4963833460"" checkSum=""6E, 19, 36, 2B, 9A, 28, AB, E3, A2, DA, EB, 51, C1, 37, 1, 10, B0, 4F, CA, 84, "" />
</files>
<methods>
<method token=""0x600000f"">
<customDebugInfo version=""4"" count=""1"">
<using version=""4"" kind=""UsingInfo"" size=""12"" namespaceCount=""1"">
<namespace usingCount=""1"" />
</using>
</customDebugInfo>
<sequencepoints total=""5"">
<entry il_offset=""0x0"" hidden=""true"" start_row=""16707566"" start_column=""0"" end_row=""16707566"" end_column=""0"" file_ref=""1"" />
<entry il_offset=""0x21"" start_row=""9"" start_column=""5"" end_row=""9"" end_column=""6"" file_ref=""1"" />
<entry il_offset=""0x22"" start_row=""10"" start_column=""9"" end_row=""10"" end_column=""24"" file_ref=""1"" />
<entry il_offset=""0x34"" hidden=""true"" start_row=""16707566"" start_column=""0"" end_row=""16707566"" end_column=""0"" file_ref=""1"" />
<entry il_offset=""0x3b"" start_row=""11"" start_column=""5"" end_row=""11"" end_column=""6"" file_ref=""1"" />
</sequencepoints>
<locals>
<local name=""CS$524$0000"" il_index=""0"" il_start=""0x0"" il_end=""0x3f"" attributes=""0"" />
</locals>
<scope startOffset=""0x0"" endOffset=""0x3f"">
<namespace name=""System.Collections.Generic"" />
<local name=""CS$524$0000"" il_index=""0"" il_start=""0x0"" il_end=""0x3f"" attributes=""0"" />
</scope>
</method>
</methods>
</symbols>";
AssertXmlEqual(expectedPdb1, actualPdb1);
}
public void VerifyPdb(IEnumerable <uint> methodTokens, string expectedPdb)
{
string actualPdb = PdbToXmlConverter.DeltaPdbToXml(PdbDelta, methodTokens);
TestBase.AssertXmlEqual(expectedPdb, actualPdb);
}