Skip to content
/ cecil Public
forked from jbevain/cecil
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

Jump to bottom

Fix deterministic MVID and add PdbChecksum #31

Merged
merged 5 commits into from
Nov 11, 2021
Merged

Fix deterministic MVID and add PdbChecksum #31

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e440a16
Fix deterministic MVID and add PdbChecksum
vitek-karas Oct 26, 2021
667978b
Revert some formatting-only changes
vitek-karas Nov 8, 2021
a0c9601
Portable PDBs can now write into write-only streams.
vitek-karas Nov 10, 2021
b915e15
Revert changes to ISymbolWriter as it's a public interface.
vitek-karas Nov 10, 2021
f1b68d7
Formatting
vitek-karas Nov 10, 2021
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
177 changes: 119 additions & 58 deletions Mono.Cecil.Cil/PortablePdb.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;

using System.Security.Cryptography;
using Mono.Cecil.Metadata;
using Mono.Cecil.PE;

Expand All @@ -39,7 +39,7 @@ public ISymbolReader GetSymbolReader (ModuleDefinition module, Stream symbolStre

ISymbolReader GetSymbolReader (ModuleDefinition module, Disposable<Stream> symbolStream, string fileName)
{
return new PortablePdbReader (ImageReader.ReadPortablePdb (symbolStream, fileName), module);
return new PortablePdbReader (ImageReader.ReadPortablePdb (symbolStream, fileName, out _), module);
}
}

Expand Down Expand Up @@ -171,7 +171,7 @@ public ISymbolReader GetSymbolReader (ModuleDefinition module, string fileName)
throw new InvalidOperationException ();

return new EmbeddedPortablePdbReader (
(PortablePdbReader) new PortablePdbReaderProvider ().GetSymbolReader (module, GetPortablePdbStream (entry)));
(PortablePdbReader)new PortablePdbReaderProvider ().GetSymbolReader (module, GetPortablePdbStream (entry)));
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please undo any line damage or formating changes, they make upstream merges pain

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently I hit something in VS which reformatted the entire file. I'm so glad we have lint in dotnet/linker 😉.
Anyway - hopefully I was able to revert all of these now.

}

static Stream GetPortablePdbStream (ImageDebugHeaderEntry entry)
Expand All @@ -194,8 +194,7 @@ public ISymbolReader GetSymbolReader (ModuleDefinition module, Stream symbolStre
}
}

public sealed class EmbeddedPortablePdbReader : ISymbolReader
{
public sealed class EmbeddedPortablePdbReader : ISymbolReader {
private readonly PortablePdbReader reader;

internal EmbeddedPortablePdbReader (PortablePdbReader reader)
Expand Down Expand Up @@ -227,14 +226,13 @@ public void Dispose ()
}
}

public sealed class PortablePdbWriterProvider : ISymbolWriterProvider
{
public sealed class PortablePdbWriterProvider : ISymbolWriterProvider {
public ISymbolWriter GetSymbolWriter (ModuleDefinition module, string fileName)
{
Mixin.CheckModule (module);
Mixin.CheckFileName (fileName);

var file = File.OpenWrite (Mixin.GetPdbFileName (fileName));
var file = File.Open (Mixin.GetPdbFileName (fileName), FileMode.OpenOrCreate, FileAccess.ReadWrite);
return GetSymbolWriter (module, Disposable.Owned (file as Stream));
}

Expand Down Expand Up @@ -263,6 +261,10 @@ public sealed class PortablePdbWriter : ISymbolWriter {

MetadataBuilder module_metadata;

internal byte [] pdb_checksum;
internal Guid pdb_id_guid;
internal uint pdb_id_age;

bool IsEmbedded { get { return writer == null; } }

internal PortablePdbWriter (MetadataBuilder pdb_metadata, ModuleDefinition module)
Expand All @@ -289,45 +291,76 @@ public ISymbolReaderProvider GetReaderProvider ()
return new PortablePdbReaderProvider ();
}

public ImageDebugHeader GetDebugHeader ()
public void Write (MethodDebugInformation info)
{
CheckMethodDebugInformationTable ();

pdb_metadata.AddMethodDebugInformation (info);
}

public ImageDebugHeader WriteSymbolsAndGetDebugHeader ()
{
if (IsEmbedded)
return new ImageDebugHeader ();

var directory = new ImageDebugDirectory () {
MajorVersion = 256,
MinorVersion = 20557,
Type = ImageDebugType.CodeView,
TimeDateStamp = (int) module.timestamp,
};
WritePdbFile ();

var buffer = new ByteBuffer ();
// RSDS
buffer.WriteUInt32 (0x53445352);
// Module ID
buffer.WriteBytes (module.Mvid.ToByteArray ());
// PDB Age
buffer.WriteUInt32 (1);
// PDB Path
var fileName = writer.BaseStream.GetFileName ();
if (string.IsNullOrEmpty (fileName)) {
fileName = module.Assembly.Name.Name + ".pdb";
ImageDebugHeaderEntry codeViewEntry;
{
var codeViewDirectory = new ImageDebugDirectory () {
MajorVersion = 256,
MinorVersion = 20557,
Type = ImageDebugType.CodeView,
TimeDateStamp = (int)module.timestamp,
};

var buffer = new ByteBuffer ();
// RSDS
buffer.WriteUInt32 (0x53445352);
// Module ID
buffer.WriteBytes (pdb_id_guid.ToByteArray ());
// PDB Age
buffer.WriteUInt32 (pdb_id_age);
// PDB Path
var fileName = writer.BaseStream.GetFileName ();
if (string.IsNullOrEmpty (fileName)) {
fileName = module.Assembly.Name.Name + ".pdb";
}
buffer.WriteBytes (System.Text.Encoding.UTF8.GetBytes (fileName));
buffer.WriteByte (0);

var data = new byte [buffer.length];
Buffer.BlockCopy (buffer.buffer, 0, data, 0, buffer.length);
codeViewDirectory.SizeOfData = data.Length;

codeViewEntry = new ImageDebugHeaderEntry (codeViewDirectory, data);
}
buffer.WriteBytes (System.Text.Encoding.UTF8.GetBytes (fileName));
buffer.WriteByte (0);

var data = new byte [buffer.length];
Buffer.BlockCopy (buffer.buffer, 0, data, 0, buffer.length);
directory.SizeOfData = data.Length;
ImageDebugHeaderEntry pdbChecksumEntry;
{
var pdbChecksumDirectory = new ImageDebugDirectory () {
MajorVersion = 1,
MinorVersion = 0,
Type = ImageDebugType.PdbChecksum,
TimeDateStamp = 0
};

return new ImageDebugHeader (new ImageDebugHeaderEntry (directory, data));
}
var buffer = new ByteBuffer ();
// SHA256 - Algorithm name
buffer.WriteBytes (System.Text.Encoding.UTF8.GetBytes ("SHA256"));
buffer.WriteByte (0);

public void Write (MethodDebugInformation info)
{
CheckMethodDebugInformationTable ();
// Checksum - 32 bytes
buffer.WriteBytes (pdb_checksum);

pdb_metadata.AddMethodDebugInformation (info);
var data = new byte [buffer.length];
Buffer.BlockCopy (buffer.buffer, 0, data, 0, buffer.length);
pdbChecksumDirectory.SizeOfData = data.Length;

pdbChecksumEntry = new ImageDebugHeaderEntry (pdbChecksumDirectory, data);
}

return new ImageDebugHeader (new ImageDebugHeaderEntry [] { codeViewEntry, pdbChecksumEntry });
}

void CheckMethodDebugInformationTable ()
Expand All @@ -343,10 +376,7 @@ void CheckMethodDebugInformationTable ()

public void Dispose ()
{
if (IsEmbedded)
return;

WritePdbFile ();
writer.stream.Dispose ();
}

void WritePdbFile ()
Expand All @@ -360,15 +390,18 @@ void WritePdbFile ()
writer.WriteMetadata ();

writer.Flush ();
writer.stream.Dispose ();

ComputeChecksumAndPdbId ();

WritePdbId ();
}

void WritePdbHeap ()
{
var pdb_heap = pdb_metadata.pdb_heap;

pdb_heap.WriteBytes (module.Mvid.ToByteArray ());
pdb_heap.WriteUInt32 (module_metadata.timestamp);
// PDB ID ( GUID + TimeStamp ) are left zeroed out for now. Will be filled at the end with a hash.
pdb_heap.WriteBytes (20);

pdb_heap.WriteUInt32 (module_metadata.entry_point.ToUInt32 ());

Expand All @@ -389,7 +422,7 @@ void WritePdbHeap ()
if (tables [i] == null || tables [i].Length == 0)
continue;

pdb_heap.WriteUInt32 ((uint) tables [i].Length);
pdb_heap.WriteUInt32 ((uint)tables [i].Length);
}
}

Expand All @@ -399,6 +432,32 @@ void WriteTableHeap ()
pdb_metadata.table_heap.ComputeTableInformations ();
pdb_metadata.table_heap.WriteTableHeap ();
}

void ComputeChecksumAndPdbId ()
{
var buffer = new byte [8192];

// Compute the has of the entire file - PDB ID is zeroes still
writer.BaseStream.Seek (0, SeekOrigin.Begin);
var sha256 = SHA256.Create ();
using (var crypto_stream = new CryptoStream (Stream.Null, sha256, CryptoStreamMode.Write)) {
CryptoService.CopyStreamChunk (writer.BaseStream, crypto_stream, buffer, (int)writer.BaseStream.Length);
}

pdb_checksum = sha256.Hash;

var hashBytes = new ByteBuffer (pdb_checksum);
pdb_id_guid = new Guid (hashBytes.ReadBytes (16));
pdb_id_age = hashBytes.ReadUInt32 ();
}

void WritePdbId ()
{
// PDB ID is the first 20 bytes of the PdbHeap
writer.MoveToRVA (TextSegment.PdbHeap);
writer.WriteBytes (pdb_id_guid.ToByteArray ());
writer.WriteUInt32 (pdb_id_age);
}
}

public sealed class EmbeddedPortablePdbWriterProvider : ISymbolWriterProvider {
Expand All @@ -409,7 +468,7 @@ public ISymbolWriter GetSymbolWriter (ModuleDefinition module, string fileName)
Mixin.CheckFileName (fileName);

var stream = new MemoryStream ();
var pdb_writer = (PortablePdbWriter) new PortablePdbWriterProvider ().GetSymbolWriter (module, stream);
var pdb_writer = (PortablePdbWriter)new PortablePdbWriterProvider ().GetSymbolWriter (module, stream);
return new EmbeddedPortablePdbWriter (stream, pdb_writer);
}

Expand All @@ -435,9 +494,14 @@ public ISymbolReaderProvider GetReaderProvider ()
return new EmbeddedPortablePdbReaderProvider ();
}

public ImageDebugHeader GetDebugHeader ()
public void Write (MethodDebugInformation info)
{
writer.Dispose ();
writer.Write (info);
}

public ImageDebugHeader WriteSymbolsAndGetDebugHeader ()
{
ImageDebugHeader pdbDebugHeader = writer.WriteSymbolsAndGetDebugHeader ();

var directory = new ImageDebugDirectory {
Type = ImageDebugType.EmbeddedPortablePdb,
Expand All @@ -453,24 +517,21 @@ public ImageDebugHeader GetDebugHeader ()
w.WriteByte (0x44);
w.WriteByte (0x42);

w.WriteInt32 ((int) stream.Length);
w.WriteInt32 ((int)stream.Length);

stream.Position = 0;

using (var compress_stream = new DeflateStream (data, CompressionMode.Compress, leaveOpen: true))
stream.CopyTo (compress_stream);

directory.SizeOfData = (int) data.Length;
directory.SizeOfData = (int)data.Length;

return new ImageDebugHeader (new [] {
writer.GetDebugHeader ().Entries [0],
new ImageDebugHeaderEntry (directory, data.ToArray ())
});
}
var debugHeaderEntries = new ImageDebugHeaderEntry [pdbDebugHeader.Entries.Length + 1];
for (int i = 0; i < pdbDebugHeader.Entries.Length; i++)
debugHeaderEntries [i] = pdbDebugHeader.Entries [i];
debugHeaderEntries [debugHeaderEntries.Length - 1] = new ImageDebugHeaderEntry (directory, data.ToArray ());

public void Write (MethodDebugInformation info)
{
writer.Write (info);
return new ImageDebugHeader (debugHeaderEntries);
}

public void Dispose ()
Expand Down
10 changes: 9 additions & 1 deletion Mono.Cecil.Cil/Symbols.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ public enum ImageDebugType {
CodeView = 2,
Deterministic = 16,
EmbeddedPortablePdb = 17,
PdbChecksum = 19,
}

public sealed class ImageDebugHeader {
Expand Down Expand Up @@ -1112,8 +1113,10 @@ static string GetSymbolNamespace (SymbolKind kind)
public interface ISymbolWriter : IDisposable {

ISymbolReaderProvider GetReaderProvider ();
ImageDebugHeader GetDebugHeader ();

void Write (MethodDebugInformation info);

ImageDebugHeader WriteSymbolsAndGetDebugHeader ();
}

public interface ISymbolWriterProvider {
Expand Down Expand Up @@ -1174,6 +1177,11 @@ public static ImageDebugHeaderEntry GetEmbeddedPortablePdbEntry (this ImageDebug
return GetEntry (header, ImageDebugType.EmbeddedPortablePdb);
}

public static ImageDebugHeaderEntry GetPdbChecksumEntry (this ImageDebugHeader header)
{
return GetEntry (header, ImageDebugType.PdbChecksum);
}

private static ImageDebugHeaderEntry GetEntry (this ImageDebugHeader header, ImageDebugType type)
{
if (!header.HasEntries)
Expand Down
5 changes: 4 additions & 1 deletion Mono.Cecil.PE/ImageReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ sealed class ImageReader : BinaryStreamReader {
DataDirectory metadata;

uint table_heap_offset;
uint pdb_heap_offset;

public ImageReader (Disposable<Stream> stream, string file_name)
: base (stream.value)
Expand Down Expand Up @@ -400,6 +401,7 @@ void ReadMetadataStream (Section section)
break;
case "#Pdb":
image.PdbHeap = new PdbHeap (data);
pdb_heap_offset = offset;
break;
}
}
Expand Down Expand Up @@ -768,7 +770,7 @@ public static Image ReadImage (Disposable<Stream> stream, string file_name)
}
}

public static Image ReadPortablePdb (Disposable<Stream> stream, string file_name)
public static Image ReadPortablePdb (Disposable<Stream> stream, string file_name, out uint pdb_heap_offset)
{
try {
var reader = new ImageReader (stream, file_name);
Expand All @@ -785,6 +787,7 @@ public static Image ReadPortablePdb (Disposable<Stream> stream, string file_name

reader.metadata = new DataDirectory (0, length);
reader.ReadMetadata ();
pdb_heap_offset = reader.pdb_heap_offset;
return reader.image;
} catch (EndOfStreamException e) {
throw new BadImageFormatException (stream.value.GetFileName (), e);
Expand Down
Loading