Replace Debug.Assert(false, with Debug.Fail(

dotnet · Jul 22, 2024 · c7b34c8 · c7b34c8
1 parent d285c82
commit c7b34c8
Show file tree

Hide file tree

Showing 62 changed files with 165 additions and 151 deletions.
diff --git a/src/coreclr/nativeaot/Common/src/Internal/Runtime/MethodTable.cs b/src/coreclr/nativeaot/Common/src/Internal/Runtime/MethodTable.cs
@@ -1362,7 +1362,7 @@ public uint GetFieldOffset(EETypeField eField)
                 return cbOffset;
             }
 
-            Debug.Assert(false, "Unknown MethodTable field type");
+            Debug.Fail("Unknown MethodTable field type");
             return 0;
         }
 

diff --git a/src/coreclr/nativeaot/Runtime.Base/src/System/Diagnostics/Debug.cs b/src/coreclr/nativeaot/Runtime.Base/src/System/Diagnostics/Debug.cs
@@ -27,5 +27,12 @@ internal static void Assert(bool condition)
                 EH.FallbackFailFast(RhFailFastReason.InternalError, null);
             }
         }
+
+        [System.Diagnostics.Conditional("DEBUG")]
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        internal static void Fail(string message)
+        {
+            Assert(false, message);
+        }
     }
 }
diff --git a/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/ExceptionHandling.cs b/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/ExceptionHandling.cs
@@ -200,7 +200,7 @@ private static void OnUnhandledExceptionViaClassLib(object exception)
                 // disallow all exceptions leaking out of callbacks
             }
 #else
-            Debug.Assert(false, "Unhandled exceptions should be processed by the native runtime only");
+            Debug.Fail("Unhandled exceptions should be processed by the native runtime only");
 #endif
         }
 
@@ -429,7 +429,7 @@ public static Exception GetRuntimeException(ExceptionIDs id)
                     return new InvalidCastException();
 
                 default:
-                    Debug.Assert(false, "unexpected ExceptionID");
+                    Debug.Fail("unexpected ExceptionID");
                     FallbackFailFast(RhFailFastReason.InternalError, null);
                     return null;
             }
@@ -696,7 +696,7 @@ public static void RhUnwindAndIntercept(ref ExInfo exInfo, UIntPtr interceptStac
                 InternalCalls.ResumeAtInterceptionLocation(exInfo._frameIter.RegisterSet);
             }
 
-            Debug.Assert(false, "unreachable");
+            Debug.Fail("unreachable");
             FallbackFailFast(RhFailFastReason.InternalError, null);
         }
 #endif // !NATIVEAOT
@@ -903,7 +903,7 @@ private static void DispatchEx(scoped ref StackFrameIterator frameIter, ref ExIn
                     pReversePInvokePropagationContext, pReversePInvokePropagationCallback, frameIter.RegisterSet, ref exInfo, frameIter.PreviousTransitionFrame);
                 // the helper should jump to propagation handler and not return
 #endif
-                Debug.Assert(false, "unreachable");
+                Debug.Fail("unreachable");
                 FallbackFailFast(RhFailFastReason.InternalError, null);
             }
 #endif // FEATURE_OBJCMARSHAL
@@ -926,7 +926,7 @@ private static void DispatchEx(scoped ref StackFrameIterator frameIter, ref ExIn
             }
 #endif // NATIVEAOT
             // currently, RhpCallCatchFunclet will resume after the catch
-            Debug.Assert(false, "unreachable");
+            Debug.Fail("unreachable");
             FallbackFailFast(RhFailFastReason.InternalError, null);
         }
 

diff --git a/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/RuntimeExports.cs b/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/RuntimeExports.cs
@@ -388,7 +388,7 @@ internal static unsafe IntPtr RhGetRuntimeHelperForType(MethodTable* pEEType, Ru
                     return (IntPtr)(delegate*<MethodTable*, int, object>)&InternalCalls.RhpNewArray;
 
                 default:
-                    Debug.Assert(false, "Unknown RuntimeHelperKind");
+                    Debug.Fail("Unknown RuntimeHelperKind");
                     return IntPtr.Zero;
             }
         }

diff --git a/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/TypeCast.cs b/src/coreclr/nativeaot/Runtime.Base/src/System/Runtime/TypeCast.cs
@@ -711,7 +711,7 @@ internal static unsafe bool TypeParametersAreCompatible(int arity,
                         break;
 
                     default:
-                        Debug.Assert(false, "unknown generic variance type");
+                        Debug.Fail("unknown generic variance type");
                         break;
                 }
             }

diff --git a/.../System.Private.StackTraceMetadata/src/Internal/StackTraceMetadata/MethodNameFormatter.cs b/.../System.Private.StackTraceMetadata/src/Internal/StackTraceMetadata/MethodNameFormatter.cs
@@ -263,7 +263,7 @@ private void EmitTypeName(Handle typeHandle, Flags flags)
                     break;
 
                 default:
-                    Debug.Assert(false, $"Type handle {typeHandle.HandleType} was not handled");
+                    Debug.Fail($"Type handle {typeHandle.HandleType} was not handled");
                     _outputBuilder.Append("???");
                     break;
             }

diff --git a/src/coreclr/nativeaot/Test.CoreLib/src/System/Diagnostics/Debug.cs b/src/coreclr/nativeaot/Test.CoreLib/src/System/Diagnostics/Debug.cs
@@ -27,5 +27,12 @@ internal static void Assert(bool condition)
                 RuntimeImports.RhpFallbackFailFast();
             }
         }
+
+        [System.Diagnostics.Conditional("DEBUG")]
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        internal static void Fail(string message)
+        {
+            Assert(false, message);
+        }
     }
 }
diff --git a/src/coreclr/nativeaot/Test.CoreLib/src/System/RuntimeExceptionHelpers.cs b/src/coreclr/nativeaot/Test.CoreLib/src/System/RuntimeExceptionHelpers.cs
@@ -69,7 +69,7 @@ public static Exception GetRuntimeException(ExceptionIDs id)
                         return new PlatformNotSupportedException();
 
                     default:
-                        Debug.Assert(false, "unexpected ExceptionID");
+                        Debug.Fail("unexpected ExceptionID");
                         RuntimeImports.RhpFallbackFailFast();
                         return null;
                 }

diff --git a/src/coreclr/tools/Common/JitInterface/SystemVStructClassificator.cs b/src/coreclr/tools/Common/JitInterface/SystemVStructClassificator.cs
@@ -260,7 +260,7 @@ private static bool ClassifyEightBytes(TypeDesc typeDesc,
                 // The field can't span past the end of the struct.
                 if ((normalizedFieldOffset + fieldSize) > helper.StructSize)
                 {
-                    Debug.Assert(false, "Invalid struct size. The size of fields and overall size don't agree");
+                    Debug.Fail("Invalid struct size. The size of fields and overall size don't agree");
                     return false;
                 }
 

diff --git a/src/coreclr/tools/Common/TypeSystem/Common/FieldLayoutIntervalCalculator.cs b/src/coreclr/tools/Common/TypeSystem/Common/FieldLayoutIntervalCalculator.cs
@@ -73,7 +73,7 @@ private int GetFieldSize(TypeDesc fieldType)
             }
             else
             {
-                Debug.Assert(false, fieldType.ToString());
+                Debug.Fail(fieldType.ToString());
                 return fieldType.GetElementSize().AsInt;
             }
         }

diff --git a/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/Dataflow/CompilerGeneratedState.cs b/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/Dataflow/CompilerGeneratedState.cs
@@ -378,7 +378,7 @@ void MapGeneratedTypeTypeParameters(
                                     }
                                     else
                                     {
-                                        Debug.Assert(false, "This should be impossible in valid code");
+                                        Debug.Fail("This should be impossible in valid code");
                                     }
                                 }
                             }

diff --git a/...lr/tools/aot/ILCompiler.MetadataTransform/ILCompiler/Metadata/Transform.TypeForwarders.cs b/...lr/tools/aot/ILCompiler.MetadataTransform/ILCompiler/Metadata/Transform.TypeForwarders.cs
@@ -39,7 +39,7 @@ private void HandleTypeForwarders(Cts.Ecma.EcmaModule module)
                 }
                 else
                 {
-                    Debug.Assert(false, "Multi-module assemblies");
+                    Debug.Fail("Multi-module assemblies");
                 }
             }
         }

diff --git a/...Compiler.ReadyToRun/Compiler/DependencyAnalysis/ReadyToRun/AttributePresenceFilterNode.cs b/...Compiler.ReadyToRun/Compiler/DependencyAnalysis/ReadyToRun/AttributePresenceFilterNode.cs
@@ -383,7 +383,7 @@ public override ObjectData GetData(NodeFactory factory, bool relocsOnly = false)
                                 return;
                             }
                         }
-                        Debug.Assert(false, "Not possible to reach here");
+                        Debug.Fail("Not possible to reach here");
                     };
                     // Scan for pre-existing fingerprint entry in buckets
                     if (hasEntryInBucket(bucketAIndex, fingerprint) || hasEntryInBucket(bucketBIndex, fingerprint))

diff --git a/src/coreclr/tools/aot/ILCompiler.ReadyToRun/Compiler/ReadyToRunCompilationModuleGroupBase.cs b/src/coreclr/tools/aot/ILCompiler.ReadyToRun/Compiler/ReadyToRunCompilationModuleGroupBase.cs
@@ -860,7 +860,7 @@ private bool ComputeTypeReferenceVersionsWithCode(TypeDesc type)
                 return true;
             }
 
-            Debug.Assert(false, "Unhandled form of type in VersionsWithTypeReference");
+            Debug.Fail("Unhandled form of type in VersionsWithTypeReference");
             return false;
         }
 

diff --git a/src/coreclr/tools/aot/ILCompiler.ReadyToRun/ObjectWriter/R2RPEBuilder.cs b/src/coreclr/tools/aot/ILCompiler.ReadyToRun/ObjectWriter/R2RPEBuilder.cs
@@ -545,7 +545,7 @@ private int RelocateRVA(int rva)
                     return rva + sectionRvaDelta.DeltaRVA;
                 }
             }
-            Debug.Assert(false, "RVA is not within any of the input sections - output PE may be inconsistent");
+            Debug.Fail("RVA is not within any of the input sections - output PE may be inconsistent");
             return rva;
         }
 

diff --git a/src/coreclr/tools/r2rdump/TextDumper.cs b/src/coreclr/tools/r2rdump/TextDumper.cs
@@ -549,7 +549,7 @@ public override void DumpSectionContents(ReadyToRunSection section)
                         if (curMethod != (countMethods + 1))
                         {
                             Program.WriteWarning("MethodIsGenericMap malformed");
-                            System.Diagnostics.Debug.Assert(false, "MethodIsGenericMap malformed");
+                            System.Diagnostics.Debug.Fail("MethodIsGenericMap malformed");
                         }
                         break;
                     }
@@ -561,7 +561,7 @@ public override void DumpSectionContents(ReadyToRunSection section)
                         if (countTypes != NativeReader.ReadUInt16(_r2r.Image, ref mapOffset))
                         {
                             Program.WriteWarning("EnclosingTypeMap malformed");
-                            System.Diagnostics.Debug.Assert(false, "EnclosingTypeMap malformed");
+                            System.Diagnostics.Debug.Fail("EnclosingTypeMap malformed");
                         }
                         int curType = 1;
                         while (curType <= (countTypes + 1))
@@ -594,7 +594,7 @@ public override void DumpSectionContents(ReadyToRunSection section)
                         if (curType != (countTypes + 1))
                         {
                             Program.WriteWarning("TypeGenericInfoMap malformed");
-                            System.Diagnostics.Debug.Assert(false, "TypeGenericInfoMap malformed");
+                            System.Diagnostics.Debug.Fail("TypeGenericInfoMap malformed");
                         }
                         break;
                     }

diff --git a/src/installer/managed/Microsoft.NET.HostModel/ComHost/ClsidMap.cs b/src/installer/managed/Microsoft.NET.HostModel/ComHost/ClsidMap.cs
@@ -236,7 +236,7 @@ private static bool IsTargetAttribute(MetadataReader reader, CustomAttribute att
                     break;
 
                 default:
-                    Debug.Assert(false, "Unknown attribute constructor kind");
+                    Debug.Fail("Unknown attribute constructor kind");
                     return false;
             }
 

diff --git a/src/libraries/Common/tests/System/Collections/TestBase.Generic.cs b/src/libraries/Common/tests/System/Collections/TestBase.Generic.cs
@@ -110,7 +110,7 @@ protected IEnumerable<T> CreateEnumerable(EnumerableType type, IEnumerable<T> en
                 case EnumerableType.Lazy:
                     return CreateLazyEnumerable(enumerableToMatchTo, count, numberOfMatchingElements, numberOfDuplicateElements);
                 default:
-                    Debug.Assert(false, "Check that the 'EnumerableType' Enum returns only types that are special-cased in the CreateEnumerable function within the Iset_Generic_Tests class");
+                    Debug.Fail("Check that the 'EnumerableType' Enum returns only types that are special-cased in the CreateEnumerable function within the Iset_Generic_Tests class");
                     return null;
             }
         }

diff --git a/src/libraries/Common/tests/System/Xml/XmlDiff/XmlDiff.cs b/src/libraries/Common/tests/System/Xml/XmlDiff/XmlDiff.cs
@@ -354,7 +354,7 @@ private bool CompareChildren(XmlDiffNode sourceNode, XmlDiffNode targetNode)
                 else
                 {
                     //Both SourceRead and TargetRead is NULL
-                    Debug.Assert(false, "Impossible Situation for comparison");
+                    Debug.Fail("Impossible Situation for comparison");
                 }
             }
             return flag;

diff --git a/src/libraries/Common/tests/System/Xml/XmlDiff/XmlDiffDocument.cs b/src/libraries/Common/tests/System/Xml/XmlDiff/XmlDiffDocument.cs
@@ -201,7 +201,7 @@ internal NodePosition ComparePosition(XmlDiffNode node1, XmlDiffNode node2)
             else
             {
                 //something really wrong here, what should we do???
-                Debug.Assert(false, "ComparePosition meets an indecision situation.");
+                Debug.Fail("ComparePosition meets an indecision situation.");
                 return NodePosition.Unknown;
             }
         }
@@ -747,7 +747,7 @@ public string GetAttribute(string localName, string namespaceURI)
 
         public string GetNamespace(string name)
         {
-            Debug.Assert(false, "GetNamespace is NYI");
+            Debug.Fail("GetNamespace is NYI");
             return "";
         }
 
@@ -835,12 +835,12 @@ public bool MoveToFirstChild()
         }
         public bool MoveToId(string id)
         {
-            Debug.Assert(false, "MoveToId is NYI");
+            Debug.Fail("MoveToId is NYI");
             return false;
         }
         public bool MoveToNamespace(string name)
         {
-            Debug.Assert(false, "MoveToNamespace is NYI");
+            Debug.Fail("MoveToNamespace is NYI");
             return false;
         }
         public bool MoveToNext()
@@ -1000,15 +1000,15 @@ public string BaseURI
         {
             get
             {
-                Debug.Assert(false, "BaseURI is NYI");
+                Debug.Fail("BaseURI is NYI");
                 return "";
             }
         }
         public string XmlLang
         {
             get
             {
-                Debug.Assert(false, "XmlLang not supported");
+                Debug.Fail("XmlLang not supported");
                 return "";
             }
         }
@@ -1594,7 +1594,7 @@ public override void WriteTo(XmlWriter w)
                     w.WriteString(Value);
                     break;
                 default:
-                    Debug.Assert(false, $"Wrong type for text-like node : {this._nodetype}");
+                    Debug.Fail($"Wrong type for text-like node : {this._nodetype}");
                     break;
             }
         }

diff --git a/...ibraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/VariantBuilder.cs b/...ibraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/VariantBuilder.cs
@@ -95,7 +95,7 @@ internal Expression InitializeArgumentVariant(MemberExpression variant, Expressi
                     return Expression.Assign(variant, Expression.Property(null, typeof(ComVariant).GetProperty(nameof(ComVariant.Null), BindingFlags.Public | BindingFlags.Static)));
 
                 default:
-                    Debug.Assert(false, "Unexpected VarEnum");
+                    Debug.Fail("Unexpected VarEnum");
                     return null;
             }
         }

diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceDescriptor.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceDescriptor.cs
@@ -330,7 +330,7 @@ internal Type GetImplementationType()
                 }
             }
 
-            Debug.Assert(false, "ImplementationType, ImplementationInstance, ImplementationFactory or KeyedImplementationFactory must be non null");
+            Debug.Fail("ImplementationType, ImplementationInstance, ImplementationFactory or KeyedImplementationFactory must be non null");
             return null;
         }
 

diff --git a/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ListenerSubscription.cs b/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ListenerSubscription.cs
@@ -52,7 +52,7 @@ private void InstrumentPublished(Instrument instrument, MeterListener _)
 
                 if (_instruments.ContainsKey(instrument))
                 {
-                    Debug.Assert(false, "InstrumentPublished called for an instrument we're already listening to.");
+                    Debug.Fail("InstrumentPublished called for an instrument we're already listening to.");
                     return;
                 }
 

diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/gen/LoggerMessageGenerator.Parser.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/gen/LoggerMessageGenerator.Parser.cs
@@ -181,7 +181,7 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
                                                     break;
 
                                                 default:
-                                                    Debug.Assert(false, "Unexpected number of arguments in attribute constructor.");
+                                                    Debug.Fail("Unexpected number of arguments in attribute constructor.");
                                                     break;
                                             }
                                         }