Add full support for PE writing

Author: xoofx

src/Directory.Packages.props

@@ -6,6 +6,7 @@
   <ItemGroup>
     <PackageVersion Include="MinVer" Version="6.0.0" />
     <PackageVersion Include="MSTest" Version="3.6.0" />
+    <PackageVersion Include="System.Text.Encoding.CodePages" Version="8.0.0" />
     <PackageVersion Include="Verify.DiffPlex" Version="3.1.0" />
     <PackageVersion Include="Verify.MSTest" Version="26.6.0" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />

src/LibObjectFile.Tests/PE/PEReaderTests.cs

@@ -3,6 +3,8 @@
 // See the license.txt file in the project root for more information.
 
 using System;
+using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using System.Threading.Tasks;
 using LibObjectFile.Diagnostics;
@@ -25,7 +27,7 @@ public async Task TestPrinter(string name)
 
         var sourceFile = Path.Combine(AppContext.BaseDirectory, "PE", name);
         await using var stream = File.OpenRead(sourceFile);
-        var peImage = PEFile.Read(stream);
+        var peImage = PEFile.Read(stream, new() { EnableStackTrace = true });
         var afterReadWriter = new StringWriter();
         peImage.Print(afterReadWriter);
 
@@ -64,7 +66,86 @@ public async Task TestPrinter(string name)
         // Compare the input and output buffer
         CollectionAssert.AreEqual(inputBuffer, outputBuffer);
     }
+    
+    [DataTestMethod]
+    [DynamicData(nameof(GetWindowsExeAndDlls), DynamicDataSourceType.Method)]
+    public async Task TestWindows(string sourceFile)
+    {
+        if (!OperatingSystem.IsWindows())
+        {
+            Assert.Inconclusive("This test can only run on Windows");
+            return;
+        }
+
+        TestContext.WriteLine($"Testing {sourceFile}");
+        await using var stream = File.OpenRead(sourceFile);
+        var peImage = PEFile.Read(stream, new() { EnableStackTrace = true });
+
+        if (peImage.CoffHeader.PointerToSymbolTable != 0)
+        {
+            Assert.Inconclusive($"The file {sourceFile} contains a non supported symbol table");
+            return;
+        }
+
+        var sizeOfInitializedData = peImage.OptionalHeader.SizeOfInitializedData;
 
+        // Read in input as raw bytes
+        stream.Position = 0;
+        var inputBuffer = new byte[stream.Length];
+        stream.ReadExactly(inputBuffer);
+
+        peImage.UpdateLayout(new DiagnosticBag());
+
+        var newSizeOfInitializedData = peImage.OptionalHeader.SizeOfInitializedData;
+
+        if (newSizeOfInitializedData != sizeOfInitializedData)
+        {
+            TestContext.WriteLine($"SizeOfInitializedData changed from {sizeOfInitializedData} to {newSizeOfInitializedData}. Trying to reuse old size");
+            peImage.ForceSizeOfInitializedData = sizeOfInitializedData;
+        }
+
+
+        // Write the PE back to a byte buffer
+        var output = new MemoryStream();
+        peImage.Write(output);
+        output.Position = 0;
+        var outputBuffer = output.ToArray();
+
+        if (!inputBuffer.AsSpan().SequenceEqual(outputBuffer))
+        {
+            // Uncomment the following code to save the output file to compare it with the original file
+            //{
+            //    var dir = Path.Combine(AppContext.BaseDirectory, "Errors");
+            //    Directory.CreateDirectory(dir);
+
+            //    var sourceFileName = Path.GetFileName(sourceFile);
+            //    var outputFileName = Path.Combine(dir, $"{sourceFileName}.new");
+
+            //    await File.WriteAllBytesAsync(outputFileName, outputBuffer);
+            //}
+
+            CollectionAssert.AreEqual(inputBuffer, outputBuffer);
+        }
+    }
+
+    public static IEnumerable<object[]> GetWindowsExeAndDlls()
+    {
+        if (!OperatingSystem.IsWindows())
+        {
+            yield break;
+        }
+
+        foreach (var file in Directory.EnumerateFiles(Environment.SystemDirectory, "*.exe", SearchOption.TopDirectoryOnly))
+        {
+            yield return [file];
+        }
+
+        foreach (var file in Directory.EnumerateFiles(Environment.SystemDirectory, "*.dll", SearchOption.TopDirectoryOnly))
+        {
+            yield return [file];
+        }
+    }
+    
     [TestMethod]
     public async Task TestTinyExe97Bytes()
     {

src/LibObjectFile.Tests/Verified/PEReaderTests.TestPrinter_name=NativeConsole2Win64.exe.verified.txt

@@ -526,7 +526,11 @@ Sections
             [02] PEResourceDataEntry              Position = 0x00002E48, Size = 0x00000010, RVA = 0x00007048, VirtualSize = 0x00000010
                 > CodePage = null, Data = PEResourceData { RVA = 0x7060, VirtualSize = 0x17D, Position = 0x2E60, Size = 0x17D }
 
-            [03] PEResourceData                   Position = 0x00002E60, Size = 0x0000017D, RVA = 0x00007060, VirtualSize = 0x0000017D
+            [03] PEStreamSectionData              Position = 0x00002E58, Size = 0x00000008, RVA = 0x00007058, VirtualSize = 0x00000008
+            
+            [04] PEResourceData                   Position = 0x00002E60, Size = 0x0000017D, RVA = 0x00007060, VirtualSize = 0x0000017D
+            
+            [05] PEStreamSectionData              Position = 0x00002FDD, Size = 0x00000003, RVA = 0x000071DD, VirtualSize = 0x00000003
 
 
     --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

src/LibObjectFile.Tests/Verified/PEReaderTests.TestPrinter_name=NativeConsoleWin64.exe.verified.txt

@@ -450,9 +450,11 @@ Sections
             [02] PEResourceDataEntry              Position = 0x00002648, Size = 0x00000010, RVA = 0x00005048, VirtualSize = 0x00000010
                 > CodePage = null, Data = PEResourceData { RVA = 0x5060, VirtualSize = 0x91, Position = 0x2660, Size = 0x91 }
 
-            [03] PEResourceData                   Position = 0x00002660, Size = 0x00000091, RVA = 0x00005060, VirtualSize = 0x00000091
+            [03] PEStreamSectionData              Position = 0x00002658, Size = 0x00000008, RVA = 0x00005058, VirtualSize = 0x00000008
 
-            [04] PEStreamSectionData              Position = 0x000026F4, Size = 0x00000004, RVA = 0x000050F4, VirtualSize = 0x00000004
+            [04] PEResourceData                   Position = 0x00002660, Size = 0x00000091, RVA = 0x00005060, VirtualSize = 0x00000091
+            
+            [05] PEStreamSectionData              Position = 0x000026F1, Size = 0x00000007, RVA = 0x000050F1, VirtualSize = 0x00000007
 
 
     --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

src/LibObjectFile.Tests/Verified/PEReaderTests.TestPrinter_name=NativeLibraryWin64.dll.verified.txt

@@ -325,7 +325,7 @@ public void Write(Stream stream)
         writer.Write();
     }
 
-    public override void UpdateLayout(ArVisitorContext context)
+    protected override void UpdateLayoutCore(ArVisitorContext context)
     {
 
     }

src/LibObjectFile/Ar/ArArchiveFile.cs

@@ -29,7 +29,7 @@ public override void Write(ArArchiveFileWriter writer)
         }
     }
 
-    public override void UpdateLayout(ArVisitorContext context)
+    protected override void UpdateLayoutCore(ArVisitorContext context)
     {
         Size = Stream != null ? (ulong) Stream.Length : 0;
     }

src/LibObjectFile/Ar/ArBinaryFile.cs

@@ -43,7 +43,7 @@ public override void Write(ArArchiveFileWriter writer)
         }
     }
 
-    public override void UpdateLayout(ArVisitorContext context)
+    protected override void UpdateLayoutCore(ArVisitorContext context)
     {
         Size = 0;
 

src/LibObjectFile/Ar/ArElfFile.cs

@@ -108,7 +108,7 @@ public override void Write(ArArchiveFileWriter writer)
         ArrayPool<byte>.Shared.Return(buffer);
     }
 
-    public override void UpdateLayout(ArVisitorContext context)
+    protected override void UpdateLayoutCore(ArVisitorContext context)
     {
         Size = 0;
 

src/LibObjectFile/Ar/ArLongNamesTable.cs

@@ -205,7 +205,7 @@ protected override bool PrintMembers(StringBuilder builder)
     }
 
 
-    public override void UpdateLayout(ArVisitorContext context)
+    protected override void UpdateLayoutCore(ArVisitorContext context)
     {
         if (Parent == null) return;