1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Generic;
using System.IO;
using System.IO.MemoryMappedFiles;
using System.Reflection.Metadata;
using System.Reflection.Metadata.Ecma335;
using System.Reflection.PortableExecutable;
using Internal.IL;
namespace Internal.TypeSystem.Ecma
{
/// <summary>
/// Provides PdbSymbolReader for portable PDB via System.Reflection.Metadata
/// </summary>
public sealed class PortablePdbSymbolReader : PdbSymbolReader
{
private static unsafe MetadataReader TryOpenMetadataFile(string filePath, MetadataStringDecoder stringDecoder, out MemoryMappedViewAccessor mappedViewAccessor)
{
FileStream fileStream = null;
MemoryMappedFile mappedFile = null;
MemoryMappedViewAccessor accessor = null;
try
{
// Create stream because CreateFromFile(string, ...) uses FileShare.None which is too strict
fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read, bufferSize: 1);
mappedFile = MemoryMappedFile.CreateFromFile(
fileStream, null, fileStream.Length, MemoryMappedFileAccess.Read, HandleInheritability.None, true);
accessor = mappedFile.CreateViewAccessor(0, 0, MemoryMappedFileAccess.Read);
var safeBuffer = accessor.SafeMemoryMappedViewHandle;
// Check whether this is a real metadata file to avoid thrown and caught exceptions
// for non-portable .pdbs
if (safeBuffer.Read<byte>(0) != 'B' || // COR20MetadataSignature
safeBuffer.Read<byte>(1) != 'S' ||
safeBuffer.Read<byte>(2) != 'J' ||
safeBuffer.Read<byte>(3) != 'B')
{
mappedViewAccessor = null;
return null;
}
var metadataReader = new MetadataReader((byte*)safeBuffer.DangerousGetHandle(), (int)safeBuffer.ByteLength, MetadataReaderOptions.Default, stringDecoder);
// MemoryMappedFile does not need to be kept around. MemoryMappedViewAccessor is enough.
mappedViewAccessor = accessor;
accessor = null;
return metadataReader;
}
finally
{
accessor?.Dispose();
mappedFile?.Dispose();
fileStream?.Dispose();
}
}
public static PdbSymbolReader TryOpen(string pdbFilename, MetadataStringDecoder stringDecoder, BlobContentId expectedContentId)
{
MemoryMappedViewAccessor mappedViewAccessor;
MetadataReader reader = TryOpenMetadataFile(pdbFilename, stringDecoder, out mappedViewAccessor);
if (reader == null)
return null;
var foundContentId = new BlobContentId(reader.DebugMetadataHeader.Id);
if (foundContentId != expectedContentId)
{
mappedViewAccessor.Dispose();
return null;
}
return new PortablePdbSymbolReader(reader, mappedViewAccessor);
}
public static PdbSymbolReader TryOpenEmbedded(PEReader peReader, MetadataStringDecoder stringDecoder)
{
foreach (DebugDirectoryEntry debugEntry in peReader.SafeReadDebugDirectory())
{
if (debugEntry.Type != DebugDirectoryEntryType.EmbeddedPortablePdb)
continue;
MetadataReaderProvider embeddedReaderProvider = peReader.ReadEmbeddedPortablePdbDebugDirectoryData(debugEntry);
MetadataReader reader = embeddedReaderProvider.GetMetadataReader(MetadataReaderOptions.Default, stringDecoder);
return new PortablePdbSymbolReader(reader, mappedViewAccessor: null);
}
return null;
}
private MetadataReader _reader;
private MemoryMappedViewAccessor _mappedViewAccessor;
private PortablePdbSymbolReader(MetadataReader reader, MemoryMappedViewAccessor mappedViewAccessor)
{
_reader = reader;
_mappedViewAccessor = mappedViewAccessor;
}
public override void Dispose()
{
_mappedViewAccessor?.Dispose();
}
public override int GetStateMachineKickoffMethod(int methodToken)
{
var debugInformationHandle = ((MethodDefinitionHandle)MetadataTokens.EntityHandle(methodToken)).ToDebugInformationHandle();
var debugInformation = _reader.GetMethodDebugInformation(debugInformationHandle);
var kickoffMethod = debugInformation.GetStateMachineKickoffMethod();
return kickoffMethod.IsNil ? 0 : MetadataTokens.GetToken(kickoffMethod);
}
public override IEnumerable<ILSequencePoint> GetSequencePointsForMethod(int methodToken)
{
var debugInformationHandle = ((MethodDefinitionHandle)MetadataTokens.EntityHandle(methodToken)).ToDebugInformationHandle();
var debugInformation = _reader.GetMethodDebugInformation(debugInformationHandle);
var sequencePoints = debugInformation.GetSequencePoints();
DocumentHandle previousDocumentHandle = default;
string previousDocumentUrl = null;
foreach (var sequencePoint in sequencePoints)
{
if (sequencePoint.StartLine == SequencePoint.HiddenLine)
continue;
string url;
if (sequencePoint.Document == previousDocumentHandle)
{
url = previousDocumentUrl;
}
else
{
url = _reader.GetString(_reader.GetDocument(sequencePoint.Document).Name);
previousDocumentHandle = sequencePoint.Document;
previousDocumentUrl = url;
}
yield return new ILSequencePoint(sequencePoint.Offset, url, sequencePoint.StartLine);
}
}
//
// Gather the local details in a scope and then recurse to child scopes
//
private void ProbeScopeForLocals(List<ILLocalVariable> variables, LocalScopeHandle localScopeHandle)
{
var localScope = _reader.GetLocalScope(localScopeHandle);
foreach (var localVariableHandle in localScope.GetLocalVariables())
{
var localVariable = _reader.GetLocalVariable(localVariableHandle);
var name = _reader.GetString(localVariable.Name);
bool compilerGenerated = (localVariable.Attributes & LocalVariableAttributes.DebuggerHidden) != 0;
variables.Add(new ILLocalVariable(localVariable.Index, name, compilerGenerated));
}
var children = localScope.GetChildren();
while (children.MoveNext())
{
ProbeScopeForLocals(variables, children.Current);
}
}
//
// Recursively scan the scopes for a method stored in a PDB and gather the local slots
// and names for all of them. This assumes a CSC-like compiler that doesn't re-use
// local slots in the same method across scopes.
//
public override IEnumerable<ILLocalVariable> GetLocalVariableNamesForMethod(int methodToken)
{
var debugInformationHandle = MetadataTokens.MethodDefinitionHandle(methodToken).ToDebugInformationHandle();
var localScopes = _reader.GetLocalScopes(debugInformationHandle);
var variables = new List<ILLocalVariable>();
foreach (var localScopeHandle in localScopes)
{
ProbeScopeForLocals(variables, localScopeHandle);
}
return variables;
}
}
}
|
