diff --git a/Mono.Cecil.Cil/PortablePdb.cs b/Mono.Cecil.Cil/PortablePdb.cs index aff6b2937..6664bee32 100644 --- a/Mono.Cecil.Cil/PortablePdb.cs +++ b/Mono.Cecil.Cil/PortablePdb.cs @@ -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; @@ -39,7 +39,7 @@ public ISymbolReader GetSymbolReader (ModuleDefinition module, Stream symbolStre ISymbolReader GetSymbolReader (ModuleDefinition module, Disposable symbolStream, string fileName) { - return new PortablePdbReader (ImageReader.ReadPortablePdb (symbolStream, fileName), module); + return new PortablePdbReader (ImageReader.ReadPortablePdb (symbolStream, fileName, out _), module); } } @@ -234,8 +234,8 @@ public ISymbolWriter GetSymbolWriter (ModuleDefinition module, string fileName) Mixin.CheckModule (module); Mixin.CheckFileName (fileName); - var file = File.OpenWrite (Mixin.GetPdbFileName (fileName)); - return GetSymbolWriter (module, Disposable.Owned (file as Stream)); + var file = File.Open (Mixin.GetPdbFileName (fileName), FileMode.OpenOrCreate, FileAccess.ReadWrite); + return GetSymbolWriter (module, Disposable.Owned (file as Stream), Disposable.NotOwned ((Stream)null)); } public ISymbolWriter GetSymbolWriter (ModuleDefinition module, Stream symbolStream) @@ -243,15 +243,18 @@ public ISymbolWriter GetSymbolWriter (ModuleDefinition module, Stream symbolStre Mixin.CheckModule (module); Mixin.CheckStream (symbolStream); - return GetSymbolWriter (module, Disposable.NotOwned (symbolStream)); + // In order to compute the PDB checksum, the stream we're writing to needs to be able to + // seek and read as well. We can't assume this about a stream provided by the user. + // So in this case, create a memory stream to cache the PDB. + return GetSymbolWriter (module, Disposable.Owned (new MemoryStream() as Stream), Disposable.NotOwned (symbolStream)); } - ISymbolWriter GetSymbolWriter (ModuleDefinition module, Disposable stream) + ISymbolWriter GetSymbolWriter (ModuleDefinition module, Disposable stream, Disposable final_stream) { var metadata = new MetadataBuilder (module, this); var writer = ImageWriter.CreateDebugWriter (module, metadata, stream); - return new PortablePdbWriter (metadata, module, writer); + return new PortablePdbWriter (metadata, module, writer, final_stream); } } @@ -260,9 +263,14 @@ public sealed class PortablePdbWriter : ISymbolWriter { readonly MetadataBuilder pdb_metadata; readonly ModuleDefinition module; readonly ImageWriter writer; + readonly Disposable final_stream; MetadataBuilder module_metadata; + internal byte [] pdb_checksum; + internal Guid pdb_id_guid; + internal uint pdb_id_stamp; + bool IsEmbedded { get { return writer == null; } } internal PortablePdbWriter (MetadataBuilder pdb_metadata, ModuleDefinition module) @@ -278,10 +286,11 @@ internal PortablePdbWriter (MetadataBuilder pdb_metadata, ModuleDefinition modul pdb_metadata.AddCustomDebugInformations (module); } - internal PortablePdbWriter (MetadataBuilder pdb_metadata, ModuleDefinition module, ImageWriter writer) + internal PortablePdbWriter (MetadataBuilder pdb_metadata, ModuleDefinition module, ImageWriter writer, Disposable final_stream) : this (pdb_metadata, module) { this.writer = writer; + this.final_stream = final_stream; } public ISymbolReaderProvider GetReaderProvider () @@ -289,45 +298,88 @@ public ISymbolReaderProvider GetReaderProvider () return new PortablePdbReaderProvider (); } + public void Write (MethodDebugInformation info) + { + CheckMethodDebugInformationTable (); + + pdb_metadata.AddMethodDebugInformation (info); + } + + public void Write () + { + if (IsEmbedded) + return; + + WritePdbFile (); + + if (final_stream.value != null) { + writer.BaseStream.Seek (0, SeekOrigin.Begin); + var buffer = new byte [8192]; + CryptoService.CopyStreamChunk (writer.BaseStream, final_stream.value, buffer, (int)writer.BaseStream.Length); + } + } + public ImageDebugHeader GetDebugHeader () { if (IsEmbedded) return new ImageDebugHeader (); - var directory = 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 (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)pdb_id_stamp, + }; + + var buffer = new ByteBuffer (); + // RSDS + buffer.WriteUInt32 (0x53445352); + // Module ID + buffer.WriteBytes (pdb_id_guid.ToByteArray ()); + // PDB Age + buffer.WriteUInt32 (1); + // 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 () @@ -343,10 +395,8 @@ void CheckMethodDebugInformationTable () public void Dispose () { - if (IsEmbedded) - return; - - WritePdbFile (); + writer.stream.Dispose (); + final_stream.Dispose (); } void WritePdbFile () @@ -360,15 +410,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 ()); @@ -399,6 +452,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_stamp = 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_stamp); + } } public sealed class EmbeddedPortablePdbWriterProvider : ISymbolWriterProvider { @@ -435,9 +514,14 @@ public ISymbolReaderProvider GetReaderProvider () return new EmbeddedPortablePdbReaderProvider (); } + public void Write (MethodDebugInformation info) + { + writer.Write (info); + } + public ImageDebugHeader GetDebugHeader () { - writer.Dispose (); + ImageDebugHeader pdbDebugHeader = writer.GetDebugHeader (); var directory = new ImageDebugDirectory { Type = ImageDebugType.EmbeddedPortablePdb, @@ -462,19 +546,22 @@ public ImageDebugHeader GetDebugHeader () 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 ()); + + return new ImageDebugHeader (debugHeaderEntries); } - public void Write (MethodDebugInformation info) + public void Write () { - writer.Write (info); + writer.Write (); } public void Dispose () { + writer.Dispose (); } } diff --git a/Mono.Cecil.Cil/Symbols.cs b/Mono.Cecil.Cil/Symbols.cs index 5e92b67fa..744e7a82b 100644 --- a/Mono.Cecil.Cil/Symbols.cs +++ b/Mono.Cecil.Cil/Symbols.cs @@ -39,6 +39,7 @@ public enum ImageDebugType { CodeView = 2, Deterministic = 16, EmbeddedPortablePdb = 17, + PdbChecksum = 19, } public sealed class ImageDebugHeader { @@ -1114,6 +1115,7 @@ public interface ISymbolWriter : IDisposable { ISymbolReaderProvider GetReaderProvider (); ImageDebugHeader GetDebugHeader (); void Write (MethodDebugInformation info); + void Write (); } public interface ISymbolWriterProvider { @@ -1174,6 +1176,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) diff --git a/Mono.Cecil.PE/ImageReader.cs b/Mono.Cecil.PE/ImageReader.cs index 535812924..a34e64d36 100644 --- a/Mono.Cecil.PE/ImageReader.cs +++ b/Mono.Cecil.PE/ImageReader.cs @@ -27,6 +27,7 @@ sealed class ImageReader : BinaryStreamReader { DataDirectory metadata; uint table_heap_offset; + uint pdb_heap_offset; public ImageReader (Disposable stream, string file_name) : base (stream.value) @@ -400,6 +401,7 @@ void ReadMetadataStream (Section section) break; case "#Pdb": image.PdbHeap = new PdbHeap (data); + pdb_heap_offset = offset; break; } } @@ -768,7 +770,7 @@ public static Image ReadImage (Disposable stream, string file_name) } } - public static Image ReadPortablePdb (Disposable stream, string file_name) + public static Image ReadPortablePdb (Disposable stream, string file_name, out uint pdb_heap_offset) { try { var reader = new ImageReader (stream, file_name); @@ -785,6 +787,7 @@ public static Image ReadPortablePdb (Disposable 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); diff --git a/Mono.Cecil.PE/ImageWriter.cs b/Mono.Cecil.PE/ImageWriter.cs index d6fb36335..c2eb97a17 100644 --- a/Mono.Cecil.PE/ImageWriter.cs +++ b/Mono.Cecil.PE/ImageWriter.cs @@ -48,6 +48,8 @@ sealed class ImageWriter : BinaryStreamWriter { ushort sections; + internal long debug_header_entries_position; + ImageWriter (ModuleDefinition module, string runtime_version, MetadataBuilder metadata, Disposable stream, bool metadataOnly = false) : base (stream.value) { @@ -64,7 +66,7 @@ sealed class ImageWriter : BinaryStreamWriter { this.GetDebugHeader (); this.GetWin32Resources (); this.BuildTextMap (); - this.sections = (ushort) (has_reloc ? 2 : 1); // text + reloc? + this.sections = (ushort)(has_reloc ? 2 : 1); // text + reloc? } void GetDebugHeader () @@ -98,7 +100,7 @@ void GetWin32Resources () public static ImageWriter CreateWriter (ModuleDefinition module, MetadataBuilder metadata, Disposable stream) { - var writer = new ImageWriter (module, module.runtime_version, metadata, stream); + var writer = new ImageWriter (module, module.runtime_version, metadata, stream, metadataOnly: false); writer.BuildSections (); return writer; } @@ -379,7 +381,7 @@ void MoveToRVA (Section section, RVA rva) BaseStream.Seek (GetRVAFileOffset (section, rva), SeekOrigin.Begin); } - void MoveToRVA (TextSegment segment) + internal void MoveToRVA (TextSegment segment) { MoveToRVA (text, text_map.GetRVA (segment)); } @@ -600,7 +602,9 @@ void WriteDebugDirectory () data_start += entry.Data.Length; } - + + debug_header_entries_position = BaseStream.Position; + for (var i = 0; i < debug_header.Entries.Length; i++) { var entry = debug_header.Entries [i]; WriteBytes (entry.Data); diff --git a/Mono.Cecil/AssemblyWriter.cs b/Mono.Cecil/AssemblyWriter.cs index 65151517f..25076ff32 100644 --- a/Mono.Cecil/AssemblyWriter.cs +++ b/Mono.Cecil/AssemblyWriter.cs @@ -118,13 +118,16 @@ static void Write (ModuleDefinition module, Disposable stream, WriterPar metadata.SetSymbolWriter (symbol_writer); BuildMetadata (module, metadata); - if (parameters.DeterministicMvid) - metadata.ComputeDeterministicMvid (); + if (symbol_writer != null) + symbol_writer.Write (); var writer = ImageWriter.CreateWriter (module, metadata, stream); stream.value.SetLength (0); writer.WriteImage (); + if (parameters.DeterministicMvid) + ComputeDeterministicMvid (writer, module); + if (parameters.HasStrongNameKey) CryptoService.StrongName (stream.value, writer, parameters); } @@ -156,6 +159,26 @@ static ISymbolWriter GetSymbolWriter (ModuleDefinition module, string fq_name, I return symbol_writer_provider.GetSymbolWriter (module, fq_name); } + + static void ComputeDeterministicMvid (ImageWriter writer, ModuleDefinition module) + { + long previousPosition = writer.BaseStream.Position; + writer.BaseStream.Seek(0, SeekOrigin.Begin); + + // The hash should be computed with the MVID set to all zeroes + // which it is - we explicitly write all zeroes GUID into the heap + // as the MVID. + // Same goes for strong name signature, which also already in the image but all zeroes right now. + Guid guid = CryptoService.ComputeGuid (CryptoService.ComputeHash (writer.BaseStream)); + + // The MVID GUID is always the first GUID in the GUID heap + writer.MoveToRVA (TextSegment.GuidHeap); + writer.WriteBytes (guid.ToByteArray ()); + writer.Flush (); + module.Mvid = guid; + + writer.BaseStream.Seek(previousPosition, SeekOrigin.Begin); + } } abstract class MetadataTable { @@ -2649,25 +2672,6 @@ void AddSequencePoints (MethodDebugInformation info) method_debug_information_table.rows [rid - 1].Col2 = GetBlobIndex (signature); } - - public void ComputeDeterministicMvid () - { - var guid = CryptoService.ComputeGuid (CryptoService.ComputeHash ( - data, - resources, - string_heap, - user_string_heap, - blob_heap, - table_heap, - code)); - - var position = guid_heap.position; - guid_heap.position = 0; - guid_heap.WriteBytes (guid.ToByteArray ()); - guid_heap.position = position; - - module.Mvid = guid; - } } sealed class SignatureWriter : ByteBuffer { diff --git a/Mono.Security.Cryptography/CryptoService.cs b/Mono.Security.Cryptography/CryptoService.cs index dd9613fe0..3877debfa 100644 --- a/Mono.Security.Cryptography/CryptoService.cs +++ b/Mono.Security.Cryptography/CryptoService.cs @@ -109,7 +109,7 @@ static byte [] HashStream (Stream stream, ImageWriter writer, out int strong_nam return sha1.Hash; } - static void CopyStreamChunk (Stream stream, Stream dest_stream, byte [] buffer, int length) + public static void CopyStreamChunk (Stream stream, Stream dest_stream, byte [] buffer, int length) { while (length > 0) { int read = stream.Read (buffer, 0, System.Math.Min (buffer.Length, length)); diff --git a/Test/Mono.Cecil.Tests/ImageReadTests.cs b/Test/Mono.Cecil.Tests/ImageReadTests.cs index ef6ab06ff..f663b60ca 100644 --- a/Test/Mono.Cecil.Tests/ImageReadTests.cs +++ b/Test/Mono.Cecil.Tests/ImageReadTests.cs @@ -237,9 +237,16 @@ public void ExternalPdbDeterministicAssembly () var header = module.GetDebugHeader (); - Assert.AreEqual (2, header.Entries.Length); + Assert.IsTrue (header.Entries.Length >= 2); Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.CodeView)); Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.Deterministic)); + + // If read directly from a file the PdbChecksum may not be persent (in this test case it isn't) + // but when written through Cecil it will always be there. + if (header.Entries.Length > 2) { + Assert.AreEqual (3, header.Entries.Length); + Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.PdbChecksum)); + } }, symbolReaderProvider: typeof (PortablePdbReaderProvider), symbolWriterProvider: typeof (PortablePdbWriterProvider)); } @@ -251,10 +258,17 @@ public void EmbeddedPdbDeterministicAssembly () var header = module.GetDebugHeader (); - Assert.AreEqual (3, header.Entries.Length); + Assert.IsTrue (header.Entries.Length >= 3); Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.CodeView)); Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.Deterministic)); Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.EmbeddedPortablePdb)); + + // If read directly from a file the PdbChecksum may not be persent (in this test case it isn't) + // but when written through Cecil it will always be there. + if (header.Entries.Length > 3) { + Assert.AreEqual (4, header.Entries.Length); + Assert.IsTrue (header.Entries.Any (e => e.Directory.Type == ImageDebugType.PdbChecksum)); + } }, symbolReaderProvider: typeof (EmbeddedPortablePdbReaderProvider), symbolWriterProvider: typeof (EmbeddedPortablePdbWriterProvider)); } } diff --git a/Test/Mono.Cecil.Tests/PortablePdbTests.cs b/Test/Mono.Cecil.Tests/PortablePdbTests.cs index d9786cb37..bd524fd14 100644 --- a/Test/Mono.Cecil.Tests/PortablePdbTests.cs +++ b/Test/Mono.Cecil.Tests/PortablePdbTests.cs @@ -1,6 +1,8 @@ using System; using System.IO; +using System.IO.Compression; using System.Linq; +using System.Security.Cryptography; using System.Text; using NUnit.Framework; @@ -357,15 +359,23 @@ public void EmbeddedCompressedPortablePdb () var header = module.GetDebugHeader (); Assert.IsNotNull (header); - Assert.AreEqual (2, header.Entries.Length); + Assert.IsTrue (header.Entries.Length >= 2); - var cv = header.Entries [0]; + int i = 0; + var cv = header.Entries [i++]; Assert.AreEqual (ImageDebugType.CodeView, cv.Directory.Type); - var eppdb = header.Entries [1]; + if (header.Entries.Length > 2) { + Assert.AreEqual (3, header.Entries.Length); + var pdbChecksum = header.Entries [i++]; + Assert.AreEqual (ImageDebugType.PdbChecksum, pdbChecksum.Directory.Type); + } + + var eppdb = header.Entries [i++]; Assert.AreEqual (ImageDebugType.EmbeddedPortablePdb, eppdb.Directory.Type); Assert.AreEqual (0x0100, eppdb.Directory.MajorVersion); Assert.AreEqual (0x0100, eppdb.Directory.MinorVersion); + }, symbolReaderProvider: typeof (EmbeddedPortablePdbReaderProvider), symbolWriterProvider: typeof (EmbeddedPortablePdbWriterProvider)); } @@ -400,7 +410,7 @@ void TestPortablePdbModule (Action test) { TestModule ("PdbTarget.exe", test, symbolReaderProvider: typeof (PortablePdbReaderProvider), symbolWriterProvider: typeof (PortablePdbWriterProvider)); TestModule ("EmbeddedPdbTarget.exe", test, verify: !Platform.OnMono); - TestModule ("EmbeddedCompressedPdbTarget.exe", test, symbolReaderProvider: typeof(EmbeddedPortablePdbReaderProvider), symbolWriterProvider: typeof(EmbeddedPortablePdbWriterProvider)); + TestModule ("EmbeddedCompressedPdbTarget.exe", test, symbolReaderProvider: typeof(EmbeddedPortablePdbReaderProvider), symbolWriterProvider: typeof (EmbeddedPortablePdbWriterProvider)); } [Test] @@ -604,7 +614,7 @@ static EmbeddedSourceDebugInformation GetSourceDebugInfo (Document document) } [Test] - public void PortablePdbLineInfo () + public void PortablePdbLineInfo() { TestModule ("line.exe", module => { var type = module.GetType ("Tests"); @@ -698,6 +708,11 @@ public void Write (MethodDebugInformation info) symbol_writer.Write (info); } + public void Write () + { + symbol_writer.Write (); + } + public void Dispose () { symbol_writer.Dispose (); @@ -809,5 +824,310 @@ public void ClearSequencePoints () } }); } + + [Test] + public void DoubleWriteAndReadWithDeterministicMvidAndVariousChanges () + { + Guid mvidIn, mvidARM64Out, mvidX64Out; + + const string resource = "mylib.dll"; + { + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + mvidIn = module.Mvid; + module.Architecture = TargetArchitecture.ARM64; // Can't use I386 as it writes different import table size -> differnt MVID + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + mvidARM64Out = module.Mvid; + } + + Assert.AreNotEqual (mvidIn, mvidARM64Out); + } + + { + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + Assert.AreEqual (mvidIn, module.Mvid); + module.Architecture = TargetArchitecture.AMD64; + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + mvidX64Out = module.Mvid; + } + + Assert.AreNotEqual (mvidARM64Out, mvidX64Out); + } + + { + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + Assert.AreEqual (mvidIn, module.Mvid); + module.Architecture = TargetArchitecture.AMD64; + module.timestamp = 42; + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + Guid mvidDifferentTimeStamp; + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + mvidDifferentTimeStamp = module.Mvid; + } + + Assert.AreNotEqual (mvidX64Out, mvidDifferentTimeStamp); + } + } + + [Test] + public void ReadPortablePdbChecksum () + { + const string resource = "PdbChecksumLib.dll"; + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + GetPdbChecksumData (module.GetDebugHeader (), out string algorithmName, out byte [] checksum); + Assert.AreEqual ("SHA256", algorithmName); + GetCodeViewPdbId (module, out byte[] pdbId); + + string pdbPath = Mixin.GetPdbFileName (module.FileName); + CalculatePdbChecksumAndId (pdbPath, out byte [] expectedChecksum, out byte [] expectedPdbId); + + CollectionAssert.AreEqual (expectedChecksum, checksum); + CollectionAssert.AreEqual (expectedPdbId, pdbId); + } + } + + [Test] + public void ReadEmbeddedPortablePdbChecksum () + { + const string resource = "EmbeddedPdbChecksumLib.dll"; + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + var debugHeader = module.GetDebugHeader (); + GetPdbChecksumData (debugHeader, out string algorithmName, out byte [] checksum); + Assert.AreEqual ("SHA256", algorithmName); + GetCodeViewPdbId (module, out byte [] pdbId); + + GetEmbeddedPdb (debugHeader, out byte [] embeddedPdb); + CalculatePdbChecksumAndId (embeddedPdb, out byte [] expectedChecksum, out byte [] expectedPdbId); + + CollectionAssert.AreEqual (expectedChecksum, checksum); + CollectionAssert.AreEqual (expectedPdbId, pdbId); + } + } + + [Test] + public void WritePortablePdbChecksum () + { + const string resource = "PdbChecksumLib.dll"; + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + GetPdbChecksumData (module.GetDebugHeader (), out string algorithmName, out byte [] checksum); + Assert.AreEqual ("SHA256", algorithmName); + GetCodeViewPdbId (module, out byte [] pdbId); + + string pdbPath = Mixin.GetPdbFileName (module.FileName); + CalculatePdbChecksumAndId (pdbPath, out byte [] expectedChecksum, out byte [] expectedPdbId); + + CollectionAssert.AreEqual (expectedChecksum, checksum); + CollectionAssert.AreEqual (expectedPdbId, pdbId); + } + } + + [Test] + public void WritePortablePdbToWriteOnlyStream () + { + const string resource = "PdbChecksumLib.dll"; + string destination = Path.GetTempFileName (); + + // Note that the module stream already requires read access even on writing to be able to compute strong name + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) + using (var pdbStream = new FileStream (destination + ".pdb", FileMode.Create, FileAccess.Write)) { + module.Write (destination, new WriterParameters { + DeterministicMvid = true, + WriteSymbols = true, + SymbolWriterProvider = new PortablePdbWriterProvider (), + SymbolStream = pdbStream + }); + } + } + + [Test] + public void DoubleWritePortablePdbDeterministicPdbId () + { + const string resource = "PdbChecksumLib.dll"; + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + byte [] pdbIdOne; + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + string pdbPath = Mixin.GetPdbFileName (module.FileName); + CalculatePdbChecksumAndId (pdbPath, out byte [] expectedChecksum, out pdbIdOne); + } + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + byte [] pdbIdTwo; + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + string pdbPath = Mixin.GetPdbFileName (module.FileName); + CalculatePdbChecksumAndId (pdbPath, out byte [] expectedChecksum, out pdbIdTwo); + } + + CollectionAssert.AreEqual (pdbIdOne, pdbIdTwo); + } + + [Test] + public void WriteEmbeddedPortablePdbChecksum () + { + const string resource = "EmbeddedPdbChecksumLib.dll"; + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + var debugHeader = module.GetDebugHeader (); + GetPdbChecksumData (debugHeader, out string algorithmName, out byte [] checksum); + Assert.AreEqual ("SHA256", algorithmName); + GetCodeViewPdbId (module, out byte [] pdbId); + + GetEmbeddedPdb (debugHeader, out byte [] embeddedPdb); + CalculatePdbChecksumAndId (embeddedPdb, out byte [] expectedChecksum, out byte [] expectedPdbId); + + CollectionAssert.AreEqual (expectedChecksum, checksum); + CollectionAssert.AreEqual (expectedPdbId, pdbId); + } + } + + [Test] + public void DoubleWriteEmbeddedPortablePdbChecksum () + { + const string resource = "EmbeddedPdbChecksumLib.dll"; + string destination = Path.GetTempFileName (); + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + byte [] pdbIdOne; + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + var debugHeader = module.GetDebugHeader (); + GetEmbeddedPdb (debugHeader, out byte [] embeddedPdb); + CalculatePdbChecksumAndId (embeddedPdb, out byte [] expectedChecksum, out pdbIdOne); + } + + using (var module = GetResourceModule (resource, new ReaderParameters { ReadSymbols = true })) { + module.Write (destination, new WriterParameters { DeterministicMvid = true, WriteSymbols = true }); + } + + byte [] pdbIdTwo; + using (var module = ModuleDefinition.ReadModule (destination, new ReaderParameters { ReadSymbols = true })) { + var debugHeader = module.GetDebugHeader (); + GetEmbeddedPdb (debugHeader, out byte [] embeddedPdb); + CalculatePdbChecksumAndId (embeddedPdb, out byte [] expectedChecksum, out pdbIdTwo); + } + + CollectionAssert.AreEqual (pdbIdOne, pdbIdTwo); + } + + private void GetEmbeddedPdb (ImageDebugHeader debugHeader, out byte [] embeddedPdb) + { + var entry = Mixin.GetEmbeddedPortablePdbEntry (debugHeader); + Assert.IsNotNull (entry); + + var compressed_stream = new MemoryStream (entry.Data); + var reader = new BinaryStreamReader (compressed_stream); + Assert.AreEqual (0x4244504D, reader.ReadInt32 ()); + var length = reader.ReadInt32 (); + var decompressed_stream = new MemoryStream (length); + + using (var deflate = new DeflateStream (compressed_stream, CompressionMode.Decompress, leaveOpen: true)) + deflate.CopyTo (decompressed_stream); + + embeddedPdb = decompressed_stream.ToArray (); + } + + private void GetPdbChecksumData (ImageDebugHeader debugHeader, out string algorithmName, out byte [] checksum) + { + var entry = Mixin.GetPdbChecksumEntry (debugHeader); + Assert.IsNotNull (entry); + + var length = Array.IndexOf (entry.Data, (byte)0, 0); + var bytes = new byte [length]; + Buffer.BlockCopy (entry.Data, 0, bytes, 0, length); + algorithmName = Encoding.UTF8.GetString (bytes); + int checksumSize = 0; + switch (algorithmName) { + case "SHA256": checksumSize = 32; break; + case "SHA384": checksumSize = 48; break; + case "SHA512": checksumSize = 64; break; + } + checksum = new byte [checksumSize]; + Buffer.BlockCopy (entry.Data, length + 1, checksum, 0, checksumSize); + } + + private void CalculatePdbChecksumAndId (string filePath, out byte [] pdbChecksum, out byte [] pdbId) + { + using (var fs = File.OpenRead (filePath)) + CalculatePdbChecksumAndId (fs, out pdbChecksum, out pdbId); + } + + private void CalculatePdbChecksumAndId (byte [] data, out byte [] pdbChecksum, out byte [] pdbId) + { + using (var pdb = new MemoryStream (data)) + CalculatePdbChecksumAndId (pdb, out pdbChecksum, out pdbId); + } + + private void CalculatePdbChecksumAndId (Stream pdbStream, out byte [] pdbChecksum, out byte [] pdbId) + { + // Get the offset of the PDB heap (this requires parsing several headers + // so it's easier to use the ImageReader directly for this) + Image image = ImageReader.ReadPortablePdb (new Disposable (pdbStream, false), "test.pdb", out uint pdbHeapOffset); + pdbId = new byte [20]; + Array.Copy (image.PdbHeap.data, 0, pdbId, 0, 20); + + pdbStream.Seek (0, SeekOrigin.Begin); + byte [] rawBytes = pdbStream.ReadAll (); + + var bytes = new byte [rawBytes.Length]; + + Array.Copy (rawBytes, 0, bytes, 0, pdbHeapOffset); + + // Zero out the PDB ID (20 bytes) + for (int i = 0; i < 20; bytes [i + pdbHeapOffset] = 0, i++) ; + + Array.Copy (rawBytes, pdbHeapOffset + 20, bytes, pdbHeapOffset + 20, rawBytes.Length - pdbHeapOffset - 20); + + var sha256 = SHA256.Create (); + pdbChecksum = sha256.ComputeHash (bytes); + } + + static void GetCodeViewPdbId (ModuleDefinition module, out byte[] pdbId) + { + var header = module.GetDebugHeader (); + var cv = Mixin.GetCodeViewEntry (header); + Assert.IsNotNull (cv); + + CollectionAssert.AreEqual (new byte [] { 0x52, 0x53, 0x44, 0x53 }, cv.Data.Take (4)); + + ByteBuffer buffer = new ByteBuffer (20); + buffer.WriteBytes (cv.Data.Skip (4).Take (16).ToArray ()); + buffer.WriteInt32 (cv.Directory.TimeDateStamp); + pdbId = buffer.buffer; + } } } diff --git a/Test/Resources/assemblies/EmbeddedPdbChecksumLib.dll b/Test/Resources/assemblies/EmbeddedPdbChecksumLib.dll new file mode 100644 index 000000000..2de939b9b Binary files /dev/null and b/Test/Resources/assemblies/EmbeddedPdbChecksumLib.dll differ diff --git a/Test/Resources/assemblies/PdbChecksumLib.dll b/Test/Resources/assemblies/PdbChecksumLib.dll new file mode 100644 index 000000000..9c28db704 Binary files /dev/null and b/Test/Resources/assemblies/PdbChecksumLib.dll differ diff --git a/Test/Resources/assemblies/PdbChecksumLib.pdb b/Test/Resources/assemblies/PdbChecksumLib.pdb new file mode 100644 index 000000000..81975e75a Binary files /dev/null and b/Test/Resources/assemblies/PdbChecksumLib.pdb differ diff --git a/symbols/mdb/Mono.Cecil.Mdb/MdbWriter.cs b/symbols/mdb/Mono.Cecil.Mdb/MdbWriter.cs index 9b565187d..4d4ce933b 100644 --- a/symbols/mdb/Mono.Cecil.Mdb/MdbWriter.cs +++ b/symbols/mdb/Mono.Cecil.Mdb/MdbWriter.cs @@ -167,6 +167,12 @@ public ImageDebugHeader GetDebugHeader () return new ImageDebugHeader (); } + public void Write () + { + // Can't write it here since we need the final module MVID - which is only computed + // after the entire image of the assembly is written (since it's computed from the hash of that) + } + public void Dispose () { writer.WriteSymbolFile (module.Mvid); diff --git a/symbols/pdb/Mono.Cecil.Pdb/NativePdbWriter.cs b/symbols/pdb/Mono.Cecil.Pdb/NativePdbWriter.cs index 01b6c7a51..7bb9c6f15 100644 --- a/symbols/pdb/Mono.Cecil.Pdb/NativePdbWriter.cs +++ b/symbols/pdb/Mono.Cecil.Pdb/NativePdbWriter.cs @@ -28,6 +28,9 @@ public class NativePdbWriter : ISymbolWriter { readonly Dictionary documents; readonly Dictionary import_info_to_parent; + ImageDebugDirectory debug_directory; + byte [] debug_info; + internal NativePdbWriter (ModuleDefinition module, SymWriter writer) { this.module = module; @@ -44,10 +47,7 @@ public ISymbolReaderProvider GetReaderProvider () public ImageDebugHeader GetDebugHeader () { - ImageDebugDirectory directory; - var data = writer.GetDebugInfo (out directory); - directory.TimeDateStamp = (int) module.timestamp; - return new ImageDebugHeader (new ImageDebugHeaderEntry (directory, data)); + return new ImageDebugHeader (new ImageDebugHeaderEntry (debug_directory, debug_info)); } public void Write (MethodDebugInformation info) @@ -253,14 +253,21 @@ SymDocumentWriter GetDocument (Document document) return doc_writer; } - public void Dispose () + public void Write () { var entry_point = module.EntryPoint; if (entry_point != null) writer.SetUserEntryPoint (entry_point.MetadataToken.ToInt32 ()); + debug_info = writer.GetDebugInfo (out debug_directory); + debug_directory.TimeDateStamp = (int)module.timestamp; + writer.Close (); } + + public void Dispose () + { + } } enum CustomMetadataType : byte {