Merged PR 21172: Fixing the shift-left handling to correctly account for overshifting

Fixing the shift-left handling to correctly account for overshifting

Author: tannergooding

src/System.Private.CoreLib/shared/System/Number.BigInteger.cs

@@ -32,7 +32,9 @@ internal unsafe ref struct BigInteger
             private const int MaxBits = BitsForLongestBinaryMantissa + BitsForLongestDigitSequence + BitsPerBlock;
 
             private const int BitsPerBlock = sizeof(int) * 8;
-            private const int MaxBlockCount = (MaxBits + (BitsPerBlock - 1)) / BitsPerBlock;
+
+            // We need one extra block to make our shift left algorithm significantly simpler
+            private const int MaxBlockCount = ((MaxBits + (BitsPerBlock - 1)) / BitsPerBlock) + 1;
 
             private static readonly uint[] s_Pow10UInt32Table = new uint[]
             {
@@ -300,7 +302,8 @@ internal unsafe ref struct BigInteger
                 0xD9D61A05,
                 0x00000325,
 
-                // 9 Trailing blocks to ensure MaxBlockCount
+                // 10 Trailing blocks to ensure MaxBlockCount
+                0x00000000,
                 0x00000000,
                 0x00000000,
                 0x00000000,
@@ -1304,16 +1307,6 @@ public void ShiftLeft(uint shift)
                 int readIndex = (length - 1);
                 int writeIndex = readIndex + (int)(blocksToShift);
 
-                uint remainingBitsInLastBlock = (uint)BitOperations.LeadingZeroCount(_blocks[readIndex]);
-
-                if (remainingBitsToShift > remainingBitsInLastBlock)
-                {
-                    // We need an extra block for the partial shift
-                    writeIndex++;
-                }
-
-                Debug.Assert(unchecked((uint)(writeIndex)) < MaxBlockCount);
-
                 if (unchecked((uint)(writeIndex)) >= MaxBlockCount)
                 {
                     // We shouldn't reach here, and the above assert will help flag this
@@ -1327,6 +1320,18 @@ public void ShiftLeft(uint shift)
                 // Check if the shift is block aligned
                 if (remainingBitsToShift == 0)
                 {
+                    Debug.Assert(unchecked((uint)(length)) < MaxBlockCount);
+
+                    if (unchecked((uint)(length)) >= MaxBlockCount)
+                    {
+                        // We shouldn't reach here, and the above assert will help flag this
+                        // during testing, but we'll ensure that we return a safe value of
+                        // zero in the case we end up overflowing in any way.
+
+                        SetZero();
+                        return;
+                    }
+
                     while (readIndex >= 0)
                     {
                         _blocks[writeIndex] = _blocks[readIndex];
@@ -1340,7 +1345,22 @@ public void ShiftLeft(uint shift)
                     Buffer.ZeroMemory((byte*)(GetBlocksPointer()), (blocksToShift * sizeof(uint)));
                 }
                 else
-                {                    
+                {
+                    // We need an extra block for the partial shift
+
+                    writeIndex++;
+                    Debug.Assert(unchecked((uint)(length)) < MaxBlockCount);
+
+                    if (unchecked((uint)(length)) >= MaxBlockCount)
+                    {
+                        // We shouldn't reach here, and the above assert will help flag this
+                        // during testing, but we'll ensure that we return a safe value of
+                        // zero in the case we end up overflowing in any way.
+
+                        SetZero();
+                        return;
+                    }
+
                     // Set the length to hold the shifted blocks
                     _length = writeIndex + 1;