Enhance memory reading and COM object management with error handling …

…and platform checks
microsoft · Jan 20, 2025 · 8c0ae1d · 8c0ae1d
1 parent 990a79d
commit 8c0ae1d
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 22 deletions.
diff --git a/src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs b/src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs
@@ -121,13 +121,20 @@ public ulong ReadLength(out bool is64bit)
         /// <summary>
         /// Reads the string from the current position in the stream.
         /// </summary>
-        [HandleProcessCorruptedStateExceptions]
         public string ReadString()
         {
-            string result = Marshal.PtrToStringAnsi(pointer + Position);
-
-            Position += result.Length + 1;
-            return result;
+            try
+            {
+                string result = Marshal.PtrToStringAnsi(pointer + Position);
+                Position += result.Length + 1;
+                return result;
+            }
+            catch (Exception ex)
+            {
+                // Handle the exception as needed, for example, log it or rethrow
+                // For now, we will just rethrow it
+                throw new InvalidOperationException("Failed to read string from memory.", ex);
+            }
         }
 
         /// <summary>

diff --git a/src/BinaryParsers/PEBinary/PEBinary.cs b/src/BinaryParsers/PEBinary/PEBinary.cs
@@ -80,7 +80,7 @@ public static void ClearLocalSymbolDirectoriesCache()
 
         public PE PE { get; private set; }
 
-        public Pdb Pdb => this.pdb?.Value;
+        public Pdb Pdb => this.pdb?.Value ?? null;
 
         public StringBuilder PdbLoadTrace { get; set; }
 

diff --git a/src/BinaryParsers/PEBinary/ProgramDatabase/MSDiaComWrapper.cs b/src/BinaryParsers/PEBinary/ProgramDatabase/MSDiaComWrapper.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 
 using Dia2Lib;
 
@@ -23,6 +24,7 @@ private static extern int DllGetClassObject(
             [In, MarshalAs(UnmanagedType.LPStruct)] Guid riid,
             out IntPtr ppvObject);
 
+        [SupportedOSPlatform("windows")]
         private static void CoCreateFromMsdia(Guid clsidOfServer, Guid riid, out IntPtr pvObject)
         {
             IntPtr pClassFactory = IntPtr.Zero;
@@ -40,6 +42,7 @@ private static void CoCreateFromMsdia(Guid clsidOfServer, Guid riid, out IntPtr
         private const string IDiaDataSourceRiid = "79F1BB5F-B66E-48E5-B6A9-1545C323CA3D";
         private const string DiaSourceClsid = "E6756135-1E65-4D17-8576-610761398C3C";
 
+        [SupportedOSPlatform("windows")]
         public static IDiaDataSource GetDiaSource()
         {
             IntPtr diaSourcePtr = IntPtr.Zero;

diff --git a/src/BinaryParsers/PEBinary/ProgramDatabase/Pdb.cs b/src/BinaryParsers/PEBinary/ProgramDatabase/Pdb.cs
@@ -8,6 +8,7 @@
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Text;
 using System.Threading;
 
@@ -72,10 +73,7 @@ public Pdb(
 
         public string LoadTrace
         {
-            get
-            {
-                return $"{this.loadTrace}";
-            }
+            get => $"{this.loadTrace}";
             set
             {
                 // We make this settable to allow the tool to clear the trace. This
@@ -203,7 +201,7 @@ private IEnumerable<SourceFile> CreateSourceFileIteratorImpl(IDiaSymbol inObject
             {
                 if (sourceFilesEnum != null)
                 {
-                    Marshal.ReleaseComObject(sourceFilesEnum);
+                    ReleaseComObject(sourceFilesEnum);
                 }
             }
         }
@@ -239,9 +237,9 @@ private T CreateDiaTable<T>() where T : class
                 for (int i = 0; i < enumTables.Count; i++)
                 {
                     IDiaTable table = enumTables.Item(i);
-                    if (!(table is T result))
+                    if (table is not T result)
                     {
-                        Marshal.ReleaseComObject(table);
+                        ReleaseComObject(table);
                     }
                     else
                     {
@@ -253,7 +251,7 @@ private T CreateDiaTable<T>() where T : class
             {
                 if (enumTables != null)
                 {
-                    Marshal.ReleaseComObject(enumTables);
+                    ReleaseComObject(enumTables);
                 }
             }
 
@@ -288,15 +286,15 @@ private HashSet<uint> GenerateWritableSegmentSet()
                     }
                     finally
                     {
-                        Marshal.ReleaseComObject(segment);
+                        ReleaseComObject(segment);
                     }
                 }
             }
             finally
             {
                 if (enumSegments != null)
                 {
-                    Marshal.ReleaseComObject(enumSegments);
+                    ReleaseComObject(enumSegments);
                 }
             }
 
@@ -341,15 +339,15 @@ private HashSet<uint> GenerateExecutableSectionContribIds()
                     }
                     finally
                     {
-                        Marshal.ReleaseComObject(sectionContrib);
+                        ReleaseComObject(sectionContrib);
                     }
                 }
             }
             finally
             {
                 if (enumSectionContribs != null)
                 {
-                    Marshal.ReleaseComObject(enumSectionContribs);
+                    ReleaseComObject(enumSectionContribs);
                 }
             }
             return result;
@@ -397,12 +395,12 @@ public void Dispose()
 
             if (this.session != null)
             {
-                Marshal.ReleaseComObject(this.session);
+                ReleaseComObject(this.session);
             }
 
             if (this.dataSource != null)
             {
-                Marshal.ReleaseComObject(this.dataSource);
+                ReleaseComObject(this.dataSource);
             }
         }
 
@@ -416,7 +414,9 @@ private void Init(string pePath, string symbolPath, string localSymbolDirectorie
             try
             {
                 PlatformSpecificHelpers.ThrowIfNotOnWindows();
+#if WINDOWS
                 this.WindowsNativeLoadPdbFromPEUsingDia(pePath, symbolPath, localSymbolDirectories);
+#endif
             }
             catch (PlatformNotSupportedException ex)
             {
@@ -448,7 +448,9 @@ private void Init(string pdbPath)
             try
             {
                 PlatformSpecificHelpers.ThrowIfNotOnWindows();
+#if WINDOWS
                 this.WindowsNativeLoadPdbUsingDia(pdbPath);
+#endif
             }
             catch (PlatformNotSupportedException ex)
             {
@@ -457,13 +459,14 @@ private void Init(string pdbPath)
             }
         }
 
+        [SupportedOSPlatform("windows")]
         private void WindowsNativeLoadPdbFromPEUsingDia(string peOrPdbPath, string symbolPath, string localSymbolDirectories)
         {
             IDiaDataSource diaSource = null;
             Environment.SetEnvironmentVariable("_NT_SYMBOL_PATH", "");
             Environment.SetEnvironmentVariable("_NT_ALT_SYMBOL_PATH", "");
 
-            object pCallback = this.loadTrace != null ? this : (object)IntPtr.Zero;
+            object pCallback = this.loadTrace != null ? this : nint.Zero;
 
             if (!string.IsNullOrEmpty(localSymbolDirectories))
             {
@@ -501,6 +504,7 @@ private void WindowsNativeLoadPdbFromPEUsingDia(string peOrPdbPath, string symbo
             this.dataSource = diaSource;
         }
 
+        [SupportedOSPlatform("windows")]
         private void WindowsNativeLoadPdbUsingDia(string pdbPath)
         {
             this.restrictReferenceAndOriginalPathAccess = false;
@@ -647,5 +651,18 @@ public bool RestrictSystemRootAccess()
         {
             return true;
         }
+        /// <summary>
+        /// Releases the COM object if running on Windows.
+        /// </summary>
+        /// <param name="comObject">The COM object to release.</param>
+        private void ReleaseComObject(object comObject)
+        {
+#if WINDOWS
+            if (comObject != null)
+            {
+                Marshal.ReleaseComObject(comObject);
+            }
+#endif
+        }
     }
 }
diff --git a/src/BinaryParsers/PEBinary/ProgramDatabase/SourceFile.cs b/src/BinaryParsers/PEBinary/ProgramDatabase/SourceFile.cs
@@ -86,7 +86,9 @@ public void Dispose()
         {
             if (!this.disposed)
             {
+#if WINDOWS
                 Marshal.ReleaseComObject(this.sourceFile);
+#endif
             }
 
             this.disposed = true;

diff --git a/src/BinaryParsers/PEBinary/ProgramDatabase/Symbol.cs b/src/BinaryParsers/PEBinary/ProgramDatabase/Symbol.cs
@@ -364,9 +364,11 @@ public void Dispose()
         {
             if (!this.disposed)
             {
+#if WINDOWS
                 Marshal.ReleaseComObject(this.sym);
-            }
+#endif
 
+            }
             this.disposed = true;
         }
 
@@ -505,7 +507,9 @@ private IEnumerable<Symbol> CreateChildrenImpl(SymTagEnum symbolTagType, string
             {
                 if (enumSymbols != null)
                 {
+#if WINDOWS
                     Marshal.ReleaseComObject(enumSymbols);
+#endif
                 }
             }
         }

diff --git a/src/Test.UnitTests.BinaryParsers/PEBinary/PEBinaryTests.cs b/src/Test.UnitTests.BinaryParsers/PEBinary/PEBinaryTests.cs
@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.Versioning;
 
 using Dia2Lib;
 
@@ -212,6 +213,7 @@ public void PEBinary_IsDotNetNativeBootstrapExe()
         }
 
         [Fact]
+        [SupportedOSPlatform("windows")]
         public void PEBinary_CanCreateIDiaSourceFromMsdia()
         {
             if (!PlatformSpecificHelpers.RunningOnWindows()) { return; }