[release/8.0] Fix NaN handling (#4365)

dotnet · Sep 7, 2023 · e464d05 · e464d05
1 parent 9ad2b7e
commit e464d05
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 7 deletions.
diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Internal/Calculator.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Internal/Calculator.cs
@@ -27,6 +27,12 @@ public static Utilization CalculateUtilization(in ResourceUtilizationSnapshot fi
         // Compute the total number of ticks available on the machine during that interval
         double totalSystemTicks = runtimeTickDelta * systemResources.GuaranteedCpuUnits;
 
+        // fudge to avoid divide by zero
+        if (totalSystemTicks <= 0)
+        {
+            totalSystemTicks = 1;
+        }
+
         // Now, compute the amount of usage between the intervals
         long oldUsageTicks = first.KernelTimeSinceStart.Ticks + first.UserTimeSinceStart.Ticks;
         long newUsageTicks = second.KernelTimeSinceStart.Ticks + second.UserTimeSinceStart.Ticks;

diff --git a/src/Shared/Throw/Throw.cs b/src/Shared/Throw/Throw.cs
@@ -870,7 +870,10 @@ public static ulong IfZero(ulong argument, [CallerArgumentExpression(nameof(argu
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static double IfLessThan(double argument, double min, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
-        if (argument < min)
+        // strange conditional needed in order to handle NaN values correctly
+#pragma warning disable S1940 // Boolean checks should not be inverted
+        if (!(argument >= min))
+#pragma warning restore S1940 // Boolean checks should not be inverted
         {
             ArgumentOutOfRangeException(paramName, argument, $"Argument less than minimum value {min}");
         }
@@ -888,7 +891,10 @@ public static double IfLessThan(double argument, double min, [CallerArgumentExpr
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static double IfGreaterThan(double argument, double max, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
-        if (argument > max)
+        // strange conditional needed in order to handle NaN values correctly
+#pragma warning disable S1940 // Boolean checks should not be inverted
+        if (!(argument <= max))
+#pragma warning restore S1940 // Boolean checks should not be inverted
         {
             ArgumentOutOfRangeException(paramName, argument, $"Argument greater than maximum value {max}");
         }
@@ -906,7 +912,10 @@ public static double IfGreaterThan(double argument, double max, [CallerArgumentE
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static double IfLessThanOrEqual(double argument, double min, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
-        if (argument <= min)
+        // strange conditional needed in order to handle NaN values correctly
+#pragma warning disable S1940 // Boolean checks should not be inverted
+        if (!(argument > min))
+#pragma warning restore S1940 // Boolean checks should not be inverted
         {
             ArgumentOutOfRangeException(paramName, argument, $"Argument less or equal than minimum value {min}");
         }
@@ -924,7 +933,10 @@ public static double IfLessThanOrEqual(double argument, double min, [CallerArgum
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static double IfGreaterThanOrEqual(double argument, double max, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
-        if (argument >= max)
+        // strange conditional needed in order to handle NaN values correctly
+#pragma warning disable S1940 // Boolean checks should not be inverted
+        if (!(argument < max))
+#pragma warning restore S1940 // Boolean checks should not be inverted
         {
             ArgumentOutOfRangeException(paramName, argument, $"Argument greater or equal than maximum value {max}");
         }
@@ -943,7 +955,8 @@ public static double IfGreaterThanOrEqual(double argument, double max, [CallerAr
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static double IfOutOfRange(double argument, double min, double max, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
-        if (argument < min || argument > max)
+        // strange conditional needed in order to handle NaN values correctly
+        if (!(min <= argument && argument <= max))
         {
             ArgumentOutOfRangeException(paramName, argument, $"Argument not in the range [{min}..{max}]");
         }
@@ -961,7 +974,7 @@ public static double IfOutOfRange(double argument, double min, double max, [Call
     public static double IfZero(double argument, [CallerArgumentExpression(nameof(argument))] string paramName = "")
     {
 #pragma warning disable S1244 // Floating point numbers should not be tested for equality
-        if (Math.Abs(argument) == 0.0)
+        if (argument == 0.0)
 #pragma warning restore S1244 // Floating point numbers should not be tested for equality
         {
             ArgumentOutOfRangeException(paramName, "Argument is zero");

diff --git a/test/Shared/Throw/DoubleTests.cs b/test/Shared/Throw/DoubleTests.cs
@@ -18,6 +18,10 @@ public void IfDoubleLessThan_ThrowWhenLessThan()
         var exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfLessThan(0.0, 1.0, "paramName"));
         Assert.Equal("paramName", exception.ParamName);
         Assert.StartsWith("Argument less than minimum value 1", exception.Message);
+
+        exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfLessThan(double.NaN, 1.0, "paramName"));
+        Assert.Equal("paramName", exception.ParamName);
+        Assert.StartsWith("Argument less than minimum value 1", exception.Message);
     }
 
     [Fact]
@@ -33,6 +37,10 @@ public void IfDoubleGreaterThan_ThrowWhenGreaterThan()
         var exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfGreaterThan(1.4, 0.0, "paramName"));
         Assert.Equal("paramName", exception.ParamName);
         Assert.StartsWith("Argument greater than maximum value 0", exception.Message);
+
+        exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfGreaterThan(double.NaN, 0.0, "paramName"));
+        Assert.Equal("paramName", exception.ParamName);
+        Assert.StartsWith("Argument greater than maximum value 0", exception.Message);
     }
 
     [Fact]
@@ -48,6 +56,10 @@ public void IfDoubleLessThanOrEqual_ThrowWhenEqual()
         var exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfLessThanOrEqual(1.2, 1.2, "paramName"));
         Assert.Equal("paramName", exception.ParamName);
         Assert.StartsWith("Argument less or equal than minimum value 1.2", exception.Message);
+
+        exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfLessThanOrEqual(double.NaN, 1.2, "paramName"));
+        Assert.Equal("paramName", exception.ParamName);
+        Assert.StartsWith("Argument less or equal than minimum value 1.2", exception.Message);
     }
 
     [Fact]
@@ -63,6 +75,10 @@ public void IfDoubleGreaterThanOrEqual_ThrowWhenEqual()
         var exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfGreaterThanOrEqual(1.22, 1.22, "paramName"));
         Assert.Equal("paramName", exception.ParamName);
         Assert.StartsWith("Argument greater or equal than maximum value 1.22", exception.Message);
+
+        exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfGreaterThanOrEqual(double.NaN, 1.22, "paramName"));
+        Assert.Equal("paramName", exception.ParamName);
+        Assert.StartsWith("Argument greater or equal than maximum value 1.22", exception.Message);
     }
 
     [Fact]
@@ -86,14 +102,15 @@ public void IfDoubleZero_ThrowWhenZero(double zero)
     [InlineData(0.001)]
     [InlineData(-0.010)]
     [InlineData(1.1)]
+    [InlineData(double.NaN)]
     public void IfDoubleZero_DoesntThrow_WhenNotZero(double notZero)
     {
         var exception = Record.Exception(() => Throw.IfZero(notZero, "paramName"));
         Assert.Null(exception);
     }
 
     [Fact]
-    public void Double_OUtOfRange()
+    public void Double_OutOfRange()
     {
         var exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfOutOfRange(-1.0, 0, 1, "foo"));
         Assert.Equal("foo", exception.ParamName);
@@ -105,6 +122,10 @@ public void Double_OUtOfRange()
 
         Assert.Equal(0, Throw.IfOutOfRange(0.0, 0, 1, "foo"));
         Assert.Equal(1, Throw.IfOutOfRange(1.0, 0, 1, "foo"));
+
+        exception = Assert.Throws<ArgumentOutOfRangeException>(() => Throw.IfOutOfRange(double.NaN, 0, 1, "foo"));
+        Assert.Equal("foo", exception.ParamName);
+        Assert.StartsWith("Argument not in the range", exception.Message);
     }
 
     [Fact]