private void WriteLocalsHelper(ISymUnmanagedScope scope, Dictionary <int, ImmutableArray <string> > slotNames, bool includeChildScopes)
{
foreach (ISymUnmanagedVariable l in scope.GetLocals())
{
writer.WriteStartElement("local");
{
writer.WriteAttributeString("name", l.GetName());
// Each local maps to a "IL Index" or "slot" number.
// The index is not necessarily unique. Several locals may refer to the same slot.
// It just means that the same local is known under different names inside the same or different scopes.
// This index is what you pass to ICorDebugILFrame::GetLocalVariable() to get
// a specific local variable.
// NOTE: VB emits "fake" locals for resumable locals which are actually backed by fields.
// These locals always map to the slot #0 which is just a valid number that is
// not used. Only scoping information is used by EE in this case.
int slot = l.GetSlot();
writer.WriteAttributeString("il_index", CultureInvariantToString(slot));
bool reusingSlot = false;
// collect slot names so that we can verify ISymUnmanagedReader APIs
if (slotNames != null)
{
ImmutableArray <string> existingNames;
if (slotNames.TryGetValue(slot, out existingNames))
{
slotNames[slot] = existingNames.Add(l.GetName());
reusingSlot = true;
}
else
{
slotNames.Add(slot, ImmutableArray.Create(l.GetName()));
}
}
// Provide scope range
writer.WriteAttributeString("il_start", AsILOffset(scope.GetStartOffset()));
writer.WriteAttributeString("il_end", AsILOffset(scope.GetEndOffset()));
writer.WriteAttributeString("attributes", l.GetAttributes().ToString());
if (reusingSlot)
{
writer.WriteAttributeString("reusingslot", reusingSlot.ToString(CultureInfo.InvariantCulture));
}
}
writer.WriteEndElement(); // </local>
}
foreach (ISymUnmanagedConstant c in scope.GetConstants())
{
// Note: We can retrieve constant tokens by saving it into signature blob
// in our implementation of IMetadataImport.GetSigFromToken.
writer.WriteStartElement("constant");
{
writer.WriteAttributeString("name", c.GetName());
object value = c.GetValue();
string typeName = value.GetType().Name;
// certain Unicode characters will give Xml writers fits...in order to avoid this, we'll replace
// problematic characters/sequences with their hexadecimal equivalents, like U+0000, etc...
var chars = value as string;
if (chars != null)
{
PooledStringBuilder pooled = PooledStringBuilder.GetInstance();
var valueWithPlaceholders = pooled.Builder;
foreach (var ch in chars)
{
// if we end up with more, we can add them here
if (0 == (int)ch)
{
valueWithPlaceholders.AppendFormat("U+{0:X4}", (int)ch);
}
else
{
valueWithPlaceholders.Append(ch);
}
}
if (valueWithPlaceholders.Length > chars.Length)
{
value = valueWithPlaceholders.ToString();
}
pooled.Free();
}
writer.WriteAttributeString("value", value.ToString());
writer.WriteAttributeString("type", typeName);
}
writer.WriteEndElement(); // </constant>
}
if (includeChildScopes)
{
foreach (ISymUnmanagedScope childScope in scope.GetScopes())
{
WriteLocalsHelper(childScope, slotNames, includeChildScopes);
}
}
}
private static void SerializeScope(
MetadataBuilder metadataBuilder,
MetadataModel metadataModel,
MethodDefinitionHandle methodHandle,
ImportScopeHandle importScopeHandle,
ISymUnmanagedScope symScope,
Dictionary <int, DynamicLocalInfo> dynamicSlots,
Dictionary <string, DynamicLocalInfo> dynamicNames,
bool vbSemantics,
ref LocalVariableHandle lastLocalVariableHandle,
ref LocalConstantHandle lastLocalConstantHandle)
{
// VB Windows PDB encode the range as end-inclusive,
// all Portable PDBs use end-exclusive encoding.
int start = symScope.GetStartOffset();
int end = symScope.GetEndOffset() + (vbSemantics ? 1 : 0);
metadataBuilder.AddLocalScope(
method: methodHandle,
importScope: importScopeHandle,
variableList: NextHandle(lastLocalVariableHandle),
constantList: NextHandle(lastLocalConstantHandle),
startOffset: start,
length: end - start);
foreach (var symLocal in symScope.GetLocals())
{
int slot = symLocal.GetSlot();
string name = symLocal.GetName();
lastLocalVariableHandle = metadataBuilder.AddLocalVariable(
attributes: (LocalVariableAttributes)symLocal.GetAttributes(),
index: slot,
name: metadataBuilder.GetOrAddString(name));
DynamicLocalInfo dynamicInfo;
if (slot > 0 && dynamicSlots.TryGetValue(slot, out dynamicInfo) ||
slot == 0 && dynamicNames.TryGetValue(name, out dynamicInfo))
{
metadataBuilder.AddCustomDebugInformation(
parent: lastLocalVariableHandle,
kind: metadataBuilder.GetOrAddGuid(PortableCustomDebugInfoKinds.DynamicLocalVariables),
value: SerializeDynamicLocalBlob(metadataBuilder, dynamicInfo));
}
}
foreach (var symConstant in symScope.GetConstants())
{
string name = symConstant.GetName();
object value = symConstant.GetValue();
lastLocalConstantHandle = metadataBuilder.AddLocalConstant(
name: metadataBuilder.GetOrAddString(name),
signature: SerializeConstantSignature(metadataBuilder, metadataModel, symConstant.GetSignature(), value));
DynamicLocalInfo dynamicInfo;
if (dynamicNames.TryGetValue(name, out dynamicInfo))
{
metadataBuilder.AddCustomDebugInformation(
parent: lastLocalConstantHandle,
kind: metadataBuilder.GetOrAddGuid(PortableCustomDebugInfoKinds.DynamicLocalVariables),
value: SerializeDynamicLocalBlob(metadataBuilder, dynamicInfo));
}
}
int previousChildScopeEnd = start;
foreach (ISymUnmanagedScope child in symScope.GetChildren())
{
int childScopeStart = child.GetStartOffset();
int childScopeEnd = child.GetEndOffset();
// scopes are properly nested:
if (childScopeStart < previousChildScopeEnd || childScopeEnd > end)
{
// TODO: loc/warning
throw new BadImageFormatException($"Invalid scope IL offset range: [{childScopeStart}, {childScopeEnd}), method 0x{MetadataTokens.GetToken(methodHandle):x}.");
}
previousChildScopeEnd = childScopeEnd;
SerializeScope(metadataBuilder, metadataModel, methodHandle, importScopeHandle, child, dynamicSlots, dynamicNames, vbSemantics, ref lastLocalVariableHandle, ref lastLocalConstantHandle);
}
}
private void WriteLocals(ISymUnmanagedScope scope)
{
foreach (ISymUnmanagedVariable l in scope.GetLocals())
{
_writer.WriteStartElement("local");
_writer.WriteAttributeString("name", l.GetName());
// NOTE: VB emits "fake" locals for resumable locals which are actually backed by fields.
// These locals always map to the slot #0 which is just a valid number that is
// not used. Only scoping information is used by EE in this case.
_writer.WriteAttributeString("il_index", CultureInvariantToString(l.GetSlot()));
_writer.WriteAttributeString("il_start", AsILOffset(scope.GetStartOffset()));
_writer.WriteAttributeString("il_end", AsILOffset(scope.GetEndOffset()));
_writer.WriteAttributeString("attributes", CultureInvariantToString(l.GetAttributes()));
_writer.WriteEndElement();
}
foreach (ISymUnmanagedConstant constant in scope.GetConstants())
{
string name = constant.GetName();
var signature = constant.GetSignature();
object value = constant.GetValue();
_writer.WriteStartElement("constant");
_writer.WriteAttributeString("name", name);
if (value is int &&
(int)value == 0 &&
(signature[0] == (byte)ConstantTypeCode.NullReference ||
signature[0] == (int)SignatureTypeCode.Object ||
signature[0] == (int)SignatureTypeCode.String ||
signature[0] == (int)SignatureTypeCode.GenericTypeInstance))
{
// TODO: 0 for enums nested in a generic class, null for reference type
// We need to decode the signature and see if the target type is enum.
_writer.WriteAttributeString("value", "null");
if (signature[0] == (int)SignatureTypeCode.String)
{
_writer.WriteAttributeString("type", "String");
}
else if (signature[0] == (int)SignatureTypeCode.Object)
{
_writer.WriteAttributeString("type", "Object");
}
else
{
// TODO:
// A null reference, the type is encoded in the signature.
// Ideally we would parse the signature and display the target type name.
// That requires MetadataReader vNext though.
_writer.WriteAttributeString("signature", BitConverter.ToString(signature.ToArray()));
}
}
else if (value == null)
{
// empty string
if (signature[0] == (byte)SignatureTypeCode.String)
{
_writer.WriteAttributeString("value", "");
_writer.WriteAttributeString("type", "String");
}
else
{
_writer.WriteAttributeString("value", "null");
_writer.WriteAttributeString("unknown-signature", BitConverter.ToString(signature.ToArray()));
}
}
else if (value is decimal)
{
// TODO: check that the signature is a TypeRef
_writer.WriteAttributeString("value", ((decimal)value).ToString(CultureInfo.InvariantCulture));
_writer.WriteAttributeString("type", value.GetType().Name);
}
else if (value is double && signature[0] != (byte)SignatureTypeCode.Double)
{
// TODO: check that the signature is a TypeRef
_writer.WriteAttributeString("value", DateTimeUtilities.ToDateTime((double)value).ToString(CultureInfo.InvariantCulture));
_writer.WriteAttributeString("type", "DateTime");
}
else
{
_writer.WriteAttributeString("value", (value as string)?.Replace("\0", "U+0000") ?? string.Format(CultureInfo.InvariantCulture, "{0}", value));
var runtimeType = GetConstantRuntimeType(signature);
if (runtimeType == null &&
(value is sbyte || value is byte || value is short || value is ushort ||
value is int || value is uint || value is long || value is ulong))
{
// TODO:
// Enum.
// Ideally we would parse the signature and display the target type name.
// That requires MetadataReader vNext though.
_writer.WriteAttributeString("signature", BitConverter.ToString(signature.ToArray()));
}
else if (runtimeType == value.GetType())
{
_writer.WriteAttributeString("type", ((SignatureTypeCode)signature[0]).ToString());
}
else
{
_writer.WriteAttributeString("runtime-type", value.GetType().Name);
_writer.WriteAttributeString("unknown-signature", BitConverter.ToString(signature.ToArray()));
}
}
_writer.WriteEndElement();
}
}
private void WriteLocals(ISymUnmanagedScope scope)
{
foreach (ISymUnmanagedVariable l in scope.GetLocals())
{
_writer.WriteStartElement("local");
_writer.WriteAttributeString("name", l.GetName());
// NOTE: VB emits "fake" locals for resumable locals which are actually backed by fields.
// These locals always map to the slot #0 which is just a valid number that is
// not used. Only scoping information is used by EE in this case.
_writer.WriteAttributeString("il_index", CultureInvariantToString(l.GetSlot()));
_writer.WriteAttributeString("il_start", AsILOffset(scope.GetStartOffset()));
_writer.WriteAttributeString("il_end", AsILOffset(scope.GetEndOffset()));
_writer.WriteAttributeString("attributes", CultureInvariantToString(l.GetAttributes()));
_writer.WriteEndElement();
}
foreach (ISymUnmanagedConstant constant in scope.GetConstants())
{
string name = constant.GetName();
var signature = constant.GetSignature();
object value = constant.GetValue();
_writer.WriteStartElement("constant");
_writer.WriteAttributeString("name", name);
if (value is int &&
(int)value == 0 &&
(signature[0] == (byte)ConstantTypeCode.NullReference ||
signature[0] == (int)SignatureTypeCode.Object ||
signature[0] == (int)SignatureTypeCode.String ||
(signature.Length > 2 && signature[0] == (int)SignatureTypeCode.GenericTypeInstance && signature[1] == (byte)ConstantTypeCode.NullReference)))
{
_writer.WriteAttributeString("value", "null");
if (signature[0] == (int)SignatureTypeCode.String)
{
_writer.WriteAttributeString("type", "String");
}
else if (signature[0] == (int)SignatureTypeCode.Object)
{
_writer.WriteAttributeString("type", "Object");
}
else
{
_writer.WriteAttributeString("signature", FormatSignature(signature));
}
}
else if (value == null)
{
// empty string
if (signature[0] == (byte)SignatureTypeCode.String)
{
_writer.WriteAttributeString("value", "");
_writer.WriteAttributeString("type", "String");
}
else
{
_writer.WriteAttributeString("value", "null");
_writer.WriteAttributeString("unknown-signature", BitConverter.ToString(signature.ToArray()));
}
}
else if (value is decimal)
{
// TODO: check that the signature is a TypeRef
_writer.WriteAttributeString("value", ((decimal)value).ToString(CultureInfo.InvariantCulture));
_writer.WriteAttributeString("type", value.GetType().Name);
}
else if (value is double && signature[0] != (byte)SignatureTypeCode.Double)
{
// TODO: check that the signature is a TypeRef
_writer.WriteAttributeString("value", DateTimeUtilities.ToDateTime((double)value).ToString(CultureInfo.InvariantCulture));
_writer.WriteAttributeString("type", "DateTime");
}
else
{
string str = value as string;
if (str != null)
{
_writer.WriteAttributeString("value", StringUtilities.EscapeNonPrintableCharacters(str));
}
else
{
_writer.WriteAttributeString("value", string.Format(CultureInfo.InvariantCulture, "{0}", value));
}
var runtimeType = GetConstantRuntimeType(signature);
if (runtimeType == null &&
(value is sbyte || value is byte || value is short || value is ushort ||
value is int || value is uint || value is long || value is ulong))
{
_writer.WriteAttributeString("signature", FormatSignature(signature));
}
else if (runtimeType == value.GetType())
{
_writer.WriteAttributeString("type", ((SignatureTypeCode)signature[0]).ToString());
}
else
{
_writer.WriteAttributeString("runtime-type", value.GetType().Name);
_writer.WriteAttributeString("unknown-signature", BitConverter.ToString(signature.ToArray()));
}
}
_writer.WriteEndElement();
}
}
private void WriteScopes(ISymUnmanagedScope rootScope)
{
// The root scope is always empty. The first scope opened by SymWriter is the child of the root scope.
if (rootScope.GetNamespaces().IsEmpty && rootScope.GetLocals().IsEmpty && rootScope.GetConstants().IsEmpty)
{
foreach (ISymUnmanagedScope child in rootScope.GetScopes())
{
WriteScope(child, isRoot: false);
}
}
else
{
// This shouldn't be executed for PDBs generated via SymWriter.
WriteScope(rootScope, isRoot: true);
}
}
private void WriteLocalsHelper(ISymUnmanagedScope scope, Dictionary<int, ImmutableArray<string>> slotNames, bool includeChildScopes)
{
foreach (ISymUnmanagedVariable l in scope.GetLocals())
{
writer.WriteStartElement("local");
{
writer.WriteAttributeString("name", l.GetName());
// Each local maps to a "IL Index" or "slot" number.
// The index is not necessarily unique. Several locals may refer to the same slot.
// It just means that the same local is known under different names inside the same or different scopes.
// This index is what you pass to ICorDebugILFrame::GetLocalVariable() to get
// a specific local variable.
// NOTE: VB emits "fake" locals for resumable locals which are actually backed by fields.
// These locals always map to the slot #0 which is just a valid number that is
// not used. Only scoping information is used by EE in this case.
int slot = l.GetSlot();
writer.WriteAttributeString("il_index", CultureInvariantToString(slot));
bool reusingSlot = false;
// collect slot names so that we can verify ISymUnmanagedReader APIs
if (slotNames != null)
{
ImmutableArray<string> existingNames;
if (slotNames.TryGetValue(slot, out existingNames))
{
slotNames[slot] = existingNames.Add(l.GetName());
reusingSlot = true;
}
else
{
slotNames.Add(slot, ImmutableArray.Create(l.GetName()));
}
}
// Provide scope range
writer.WriteAttributeString("il_start", AsILOffset(scope.GetStartOffset()));
writer.WriteAttributeString("il_end", AsILOffset(scope.GetEndOffset()));
writer.WriteAttributeString("attributes", l.GetAttributes().ToString());
if (reusingSlot)
{
writer.WriteAttributeString("reusingslot", reusingSlot.ToString(CultureInfo.InvariantCulture));
}
}
writer.WriteEndElement(); // </local>
}
foreach (ISymUnmanagedConstant c in scope.GetConstants())
{
// Note: We can retrieve constant tokens by saving it into signature blob
// in our implementation of IMetadataImport.GetSigFromToken.
writer.WriteStartElement("constant");
{
writer.WriteAttributeString("name", c.GetName());
object value = c.GetValue();
string typeName = value.GetType().Name;
// certain Unicode characters will give Xml writers fits...in order to avoid this, we'll replace
// problematic characters/sequences with their hexadecimal equivalents, like U+0000, etc...
var chars = value as string;
if (chars != null)
{
PooledStringBuilder pooled = PooledStringBuilder.GetInstance();
var valueWithPlaceholders = pooled.Builder;
foreach (var ch in chars)
{
// if we end up with more, we can add them here
if (0 == (int)ch)
{
valueWithPlaceholders.AppendFormat("U+{0:X4}", (int)ch);
}
else
{
valueWithPlaceholders.Append(ch);
}
}
if (valueWithPlaceholders.Length > chars.Length)
{
value = valueWithPlaceholders.ToString();
}
pooled.Free();
}
writer.WriteAttributeString("value", value.ToString());
writer.WriteAttributeString("type", typeName);
}
writer.WriteEndElement(); // </constant>
}
if (includeChildScopes)
{
foreach (ISymUnmanagedScope childScope in scope.GetScopes())
{
WriteLocalsHelper(childScope, slotNames, includeChildScopes);
}
}
}
