fix: do not initialize properties by default when evaluating SafeFileHandleEx.ToString()

This issue was causing the debugger to unpause threads or sometimes crash the debuggee process.

Author: BinToss

deadlock-dotnet-sdk/Domain/SafeFileHandleEx.cs

@@ -462,42 +462,49 @@ public enum FileType : uint
         Pipe = FILE_TYPE.FILE_TYPE_PIPE,
     }
 
-    public override string ToString() => ToString(true);
+    public override string ToString() => ToString(false, false);
 
     /// <summary>
     /// Get the string representation of this SafeFileHandleEx object.
     /// </summary>
-    /// <param name="init">If TRUE, get values from Properties. If FALSE, get values from Properties' backing fields.</param>
+    /// <param name="initProps">If TRUE, get values from Properties. If FALSE, get values from Properties' backing fields.</param>
     /// <returns>The string representation of this SafeFileHandleEx object.</returns>
-    public string ToString(bool init)
+    public string ToString(bool initProps, bool initProcessInfo)
     {
-        string[] exLog = ExceptionLog.ConvertAll(ex => ex.ToString()).ToArray();
-        for (int i = 0; i < exLog.Length; i++)
+        try
         {
-            exLog[i] = $" {exLog[i]}".Replace("\n", "\n    ") + "\r\n";
-        }
+            string[] exLog = ExceptionLog.ConvertAll(ex => ex.ToString()).ToArray();
+            for (int i = 0; i < exLog.Length; i++)
+            {
+                exLog[i] = $" {exLog[i]}".Replace("\n", "\n    ") + "\r\n";
+            }
 
-        return @$"{nameof(SafeFileHandleEx)} hash:{GetHashCode()}
+            return @$"{nameof(SafeFileHandleEx)} hash:{GetHashCode()}
         {nameof(CreatorBackTraceIndex)}             : {CreatorBackTraceIndex}
-        {nameof(FileFullPath)}                      : {(init ? (FileFullPath.v ?? FileFullPath.ex?.ToString()) : (fileFullPath.v ?? fileFullPath.ex?.ToString()))}
-        {nameof(FileHandleType)}                    : {(init ? (FileHandleType.v?.ToString() ?? FileFullPath.ex?.ToString()) : (fileHandleType.v?.ToString() ?? fileHandleType.ex?.ToString()))}
-        {nameof(FileName)}                          : {(init ? (FileName.v ?? FileName.ex?.ToString()) : (fileName.v ?? fileName.ex?.ToString()))}
+        {nameof(FileFullPath)}                      : {(initProps ? (FileFullPath.v ?? FileFullPath.ex?.ToString()) : (fileFullPath.v ?? fileFullPath.ex?.ToString()))}
+        {nameof(FileHandleType)}                    : {(initProps ? (FileHandleType.v?.ToString() ?? FileFullPath.ex?.ToString()) : (fileHandleType.v?.ToString() ?? fileHandleType.ex?.ToString()))}
+        {nameof(FileName)}                          : {(initProps ? (FileName.v ?? FileName.ex?.ToString()) : (fileName.v ?? fileName.ex?.ToString()))}
         {nameof(GrantedAccess)}                     : {SysHandleEx.GrantedAccessString}
-        {nameof(HandleObjectType)}                  : {(init ? (HandleObjectType.v ?? HandleObjectType.ex?.ToString()) : (handleObjectType.v ?? handleObjectType.ex?.ToString()))}
+        {nameof(HandleObjectType)}                  : {(initProps ? (HandleObjectType.v ?? HandleObjectType.ex?.ToString()) : (handleObjectType.v ?? handleObjectType.ex?.ToString()))}
         {nameof(HandleValue)}                       : {HandleValue} (0x{HandleValue:X})
         {nameof(IsClosed)}                          : {IsClosed}
-        {nameof(IsDirectory)}                       : {(init ? (IsDirectory.v?.ToString() ?? IsDirectory.ex?.ToString()) : (isDirectory.v?.ToString() ?? isDirectory.ex?.ToString()))}
-        {nameof(IsFileHandle)}                      : {(init ? (IsFileHandle.v?.ToString() ?? IsFileHandle.ex?.ToString()) : (isFileHandle.v?.ToString() ?? isFileHandle.ex?.ToString()))}
+        {nameof(IsDirectory)}                       : {(initProps ? (IsDirectory.v?.ToString() ?? IsDirectory.ex?.ToString()) : (isDirectory.v?.ToString() ?? isDirectory.ex?.ToString()))}
+        {nameof(IsFileHandle)}                      : {(initProps ? (IsFileHandle.v?.ToString() ?? IsFileHandle.ex?.ToString()) : (isFileHandle.v?.ToString() ?? isFileHandle.ex?.ToString()))}
         {nameof(IsInvalid)}                         : {IsInvalid}
         {nameof(ObjectAddress)}                     : {ObjectAddress} (0x{ObjectAddress:X})
-        {nameof(ObjectName)}                        : {(init ? (ObjectName.v ?? ObjectName.ex?.ToString()) : (objectName.v ?? objectName.ex?.ToString()))}
+        {nameof(ObjectName)}                        : {(initProps ? (ObjectName.v ?? ObjectName.ex?.ToString()) : (objectName.v ?? objectName.ex?.ToString()))}
         {nameof(ProcessId)}                         : {ProcessId}
-        {nameof(ProcessInfo.ParentId)}              : {ProcessInfo.ParentId.v?.ToString() ?? ProcessInfo.ParentId.ex?.ToString() ?? string.Empty}
-        {nameof(ProcessInfo.ProcessCommandLine)}    : {ProcessInfo.ProcessCommandLine.v ?? ProcessInfo.ProcessCommandLine.ex?.ToString()}
-        {nameof(ProcessInfo.ProcessMainModulePath)} : {ProcessInfo.ProcessMainModulePath.v ?? ProcessInfo.ProcessMainModulePath.ex?.ToString()}
-        {nameof(ProcessInfo.ProcessName)}           : {ProcessInfo.ProcessName.v ?? ProcessInfo.ProcessName.ex?.ToString()}
-        {nameof(ProcessInfo.ProcessProtection)}     : {ProcessInfo.ProcessProtection.v?.ToString() ?? ProcessInfo.ProcessProtection.ex?.ToString() ?? string.Empty}
+        {nameof(ProcessInfo.ParentId)}              : {(initProcessInfo ? (ProcessInfo.ParentId.v?.ToString() ?? ProcessInfo.ParentId.ex?.ToString()) : (processInfo?.ParentId.v?.ToString() ?? processInfo?.ParentId.ex?.ToString() ?? string.Empty))}
+        {nameof(ProcessInfo.ProcessCommandLine)}    : {(initProcessInfo ? (ProcessInfo.ProcessCommandLine.v ?? ProcessInfo.ProcessCommandLine.ex?.ToString()) : (processInfo?.ProcessCommandLine.v ?? processInfo?.ProcessCommandLine.ex?.ToString() ?? string.Empty))}
+        {nameof(ProcessInfo.ProcessMainModulePath)} : {(initProcessInfo ? (ProcessInfo.ProcessMainModulePath.v ?? ProcessInfo.ProcessMainModulePath.ex?.ToString()) : (processInfo?.ProcessMainModulePath.v ?? processInfo?.ProcessMainModulePath.ex?.ToString() ?? string.Empty))}
+        {nameof(ProcessInfo.ProcessName)}           : {(initProcessInfo ? (ProcessInfo.ProcessName.v ?? ProcessInfo.ProcessName.ex?.ToString()) : (processInfo?.ProcessName.v ?? processInfo?.ProcessName.ex?.ToString() ?? string.Empty))}
+        {nameof(ProcessInfo.ProcessProtection)}     : {(initProcessInfo ? (ProcessInfo.ProcessProtection.v?.ToString() ?? ProcessInfo.ProcessProtection.ex?.ToString()) : (processInfo?.ProcessProtection.v?.ToString() ?? processInfo?.ProcessProtection.ex?.ToString() ?? string.Empty))}
         {nameof(ExceptionLog)}                      : ...
         " + string.Concat(exLog);
+        }
+        catch (Exception ex)
+        {
+            return $"Error while evaluating properties for SafeFileHandleEx.ToString(): {ex}";
+        }
     }
 }

deadlock-dotnet-sdk/Domain/SafeHandleEx.cs

@@ -28,7 +28,7 @@ public class SafeHandleEx : SafeHandleZeroOrMinusOneIsInvalid
     protected (string? v, Exception? ex) handleObjectType;
     private bool isClosed;
     protected (string? v, Exception? ex) objectName;
-    private ProcessInfo? processInfo;
+    protected ProcessInfo? processInfo;
 
     public SafeHandleEx(SafeHandleEx safeHandleEx) : this(safeHandleEx.SysHandleEx)
     { }