using System.Numerics; using System.Runtime.CompilerServices; using ILGPU.Algorithms; namespace PerfectNumbers.Core.Gpu; public struct GpuUInt128 : IComparable, IEquatable { public ulong High; public ulong Low; private const int NativeModuloChunkBits = 8; private const int NativeModuloChunkBitsMinusOne = NativeModuloChunkBits - 1; private const ulong NativeModuloChunkMask = (1UL << NativeModuloChunkBits) - 1UL; private const int Pow2WindowSizeBits = 8; private const int Pow2WindowOddPowerCount = 1 << (Pow2WindowSizeBits - 1); private const int Pow2WindowMaxExponent = (1 << Pow2WindowSizeBits) - 1; [MethodImpl(MethodImplOptions.AggressiveInlining)] private static int GetScalarBitLength(ulong value) => value == 0UL ? 0 : 64 - XMath.LeadingZeroCount(value); public static readonly GpuUInt128 Zero = new(); public static readonly GpuUInt128 One = new(1UL); [MethodImpl(MethodImplOptions.AggressiveInlining)] public GpuUInt128() { } [MethodImpl(MethodImplOptions.AggressiveInlining)] public GpuUInt128(ulong high, ulong low) { High = high; Low = low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public GpuUInt128(ulong low) { Low = low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public GpuUInt128(UInt128 value) { High = (ulong)(value >> 64); Low = (ulong)value; } public readonly bool IsZero { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => High == 0UL && Low == 0UL; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly int GetBitLength() { ulong temp = High; if (temp != 0UL) { return 64 + (64 - BitOperations.LeadingZeroCount(temp)); } temp = Low; if (temp == 0UL) { return 0; } return 64 - BitOperations.LeadingZeroCount(temp); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static implicit operator GpuUInt128(UInt128 value) => new(value); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static implicit operator GpuUInt128(ulong value) => new(value); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static implicit operator GpuUInt128(ReadOnlyGpuUInt128 value) => new(value.High, value.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static implicit operator UInt128(GpuUInt128 value) => ((UInt128)value.High << 64) | value.Low; [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ReadOnlyGpuUInt128 AsReadOnly() => new(this); // Operators must return fresh instances so callers never rely on accidental in-place mutation. Prefer the mutating helpers when state updates are required. [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator +(GpuUInt128 left, GpuUInt128 right) { GpuUInt128 result = new(left.High, left.Low); result.Add(right); return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator -(GpuUInt128 left, GpuUInt128 right) { GpuUInt128 result = new(left.High, left.Low); result.Sub(right); return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator ^(GpuUInt128 left, GpuUInt128 right) => new(left.High ^ right.High, left.Low ^ right.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator *(GpuUInt128 left, GpuUInt128 right) { Multiply(left, right, out var high, out var low); return new GpuUInt128(high, low); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator <<(GpuUInt128 value, int shift) { shift &= 127; GpuUInt128 result = new(value.High, value.Low); if (shift == 0) { return result; } ulong high = result.High; ulong low = result.Low; int shiftedValue; if (shift >= 64) { shiftedValue = shift - 64; result.High = low << shiftedValue; result.Low = 0UL; return result; } shiftedValue = 64 - shift; result.High = (high << shift) | (low >> shiftedValue); result.Low = low << shift; return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator >>(GpuUInt128 value, int shift) { shift &= 127; GpuUInt128 result = new(value.High, value.Low); if (shift == 0) { return result; } ulong high = result.High; ulong low = result.Low; int shiftedValue; if (shift >= 64) { shiftedValue = shift - 64; result.Low = shiftedValue == 0 ? high : high >> shiftedValue; result.High = 0UL; return result; } shiftedValue = 64 - shift; result.Low = (low >> shift) | (high << shiftedValue); result.High = high >> shift; return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator ==(GpuUInt128 left, GpuUInt128 right) => left.Equals(right); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator !=(GpuUInt128 left, GpuUInt128 right) => !left.Equals(right); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator <(GpuUInt128 left, GpuUInt128 right) => left.CompareTo(right) < 0; [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator >(GpuUInt128 left, GpuUInt128 right) => left.CompareTo(right) > 0; [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator <=(GpuUInt128 left, GpuUInt128 right) => left.CompareTo(right) <= 0; [MethodImpl(MethodImplOptions.AggressiveInlining)] public static bool operator >=(GpuUInt128 left, GpuUInt128 right) => left.CompareTo(right) >= 0; [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 operator ++(GpuUInt128 value) { GpuUInt128 result = new(value.High, value.Low); result.Add(1UL); return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly int CompareTo(GpuUInt128 other) { if (High < other.High) { return -1; } if (High > other.High) { return 1; } if (Low < other.Low) { return -1; } if (Low > other.Low) { return 1; } return 0; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly int CompareTo(in ReadOnlyGpuUInt128 other) { if (High < other.High) { return -1; } if (High > other.High) { return 1; } ulong otherLow = other.Low; if (Low < otherLow) { return -1; } if (Low > otherLow) { return 1; } return 0; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly bool Equals(GpuUInt128 other) => High == other.High && Low == other.Low; [MethodImpl(MethodImplOptions.AggressiveInlining)] public override readonly bool Equals(object? obj) => obj is GpuUInt128 value && Equals(value); [MethodImpl(MethodImplOptions.AggressiveInlining)] public override readonly int GetHashCode() => HashCode.Combine(High, Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Add(in ReadOnlyGpuUInt128 other) => AddInternal(other.High, other.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Add(GpuUInt128 other) => AddInternal(other.High, other.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] private void AddInternal(ulong otherHigh, ulong otherLow) { ulong originalLow = Low; // We're reusing originalLow for carry to avoid an extra local. ulong low = originalLow + otherLow; originalLow = low < originalLow ? 1UL : 0UL; Low = low; // We're reusing low for the final sum to avoid an extra local and to keep max stack frame at 3 instead of 4 with one statement. low = High + otherHigh; High = low + originalLow; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Add(ulong value) { ulong low = Low + value; High += low < Low ? 1UL : 0UL; Low = low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(in ReadOnlyGpuUInt128 value, in ReadOnlyGpuUInt128 modulus) => AddModInternal(value.High, value.Low, in modulus); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(GpuUInt128 value, in ReadOnlyGpuUInt128 modulus) => AddModInternal(value.High, value.Low, in modulus); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(in ReadOnlyGpuUInt128 value, GpuUInt128 modulus) { ReadOnlyGpuUInt128 readOnlyMod = modulus.AsReadOnly(); AddModInternal(value.High, value.Low, in readOnlyMod); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(GpuUInt128 value, GpuUInt128 modulus) { ReadOnlyGpuUInt128 readOnlyMod = modulus.AsReadOnly(); AddModInternal(value.High, value.Low, in readOnlyMod); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private void AddModInternal(ulong valueHigh, ulong valueLow, in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { AddMod(valueLow, modulus.Low); return; } AddInternal(valueHigh, valueLow); if (CompareTo(in modulus) >= 0) { Sub(in modulus); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(ulong value, in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { AddMod(value, modulus.Low); return; } Add(value); if (CompareTo(in modulus) >= 0) { Sub(in modulus); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 Pow2Minus1Mod(ulong exponent, in ReadOnlyGpuUInt128 modulus) { // This should never happen in production code // if (modulus.IsZero) // { // return Zero; // } GpuUInt128 pow = Pow2Mod(exponent, modulus); if (pow.IsZero) { pow = modulus; } pow.Sub(One); return pow; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Pow2Minus1ModBatch(in ReadOnlyGpuUInt128 modulus, ReadOnlySpan exponents, Span results) { int count = exponents.Length; for (int i = 0; i < count; i++) { results[i] = Pow2Minus1Mod(exponents[i], modulus); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(in ReadOnlyGpuUInt128 value, ulong modulus) { // TODO: Pre-reduce the operands via the Montgomery ladder used in MulMod64Benchmarks so the GPU // compatible shim stops paying for `%` on every call; the InlineUInt128 helper ran 6–82× faster on // large 64-bit workloads while preserving compatibility with the CPU scanner. ulong a = Low % modulus; ulong b = value.Low % modulus; ulong sum = a + b; if (sum >= modulus || sum < a) { sum -= modulus; } High = 0UL; Low = sum; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(GpuUInt128 value, ulong modulus) => AddMod(value.Low, modulus); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AddMod(ulong value, ulong modulus) { // TODO: Fold these operands with the ImmediateModulo helper once the GPU shim exposes it, avoiding // repeated `%` reductions that the benchmarks showed are far slower than the Montgomery-based path // for dense operands. ulong a = Low % modulus; ulong b = value % modulus; ulong sum = a + b; if (sum >= modulus || sum < a) { sum -= modulus; } High = 0UL; Low = sum; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Sub(in ReadOnlyGpuUInt128 other) => SubInternal(other.High, other.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Sub(GpuUInt128 other) => SubInternal(other.High, other.Low); [MethodImpl(MethodImplOptions.AggressiveInlining)] private void SubInternal(ulong otherHigh, ulong otherLow) { ulong borrow = Low < otherLow ? 1UL : 0UL; High = High - otherHigh - borrow; Low -= otherLow; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static ulong MulHigh(ulong x, ulong y) { // TODO: Review if we can reuse any other existing variables to reduce registry pressure. ulong xLow = (uint)x; ulong yLow = (uint)y; ulong lowProduct = xLow * yLow; ulong yHigh = y >> 32; // We're reusing xLow for the cross product to avoid an extra local. xLow *= yHigh; ulong xHigh = x >> 32; // We're reusing yHigh for the result to void an extra local. yHigh *= xHigh; // We're reusing yLow for the other cross product to avoid an extra local. yLow *= xHigh; // Keeping the wide partial sum in a dedicated local prevents the JIT from // materialising it on the stack before the final carry propagation. The // additional store looks redundant in C#, but it shortens the generated // instruction sequence by avoiding an extra temporary and results in a // measurable throughput win in the MulHigh benchmarks. yHigh += (xLow >> 32); // We've more instructions with this but the max method stack frame is 3 instead of 4. yHigh += (yLow >> 32); lowProduct >>= 32; lowProduct += (uint)xLow + (uint)yLow; yHigh += lowProduct >> 32; return yHigh; } [MethodImpl(MethodImplOptions.AggressiveInlining)] // Kept by-value to coexist with the ref readonly overload below while still signaling read-only intent. public void MulMod(ReadOnlyGpuUInt128 value, in ReadOnlyGpuUInt128 modulus) { GpuUInt128 multiplicand = this; GpuUInt128 multiplier = value.ToMutable(); GpuUInt128 result = new(); while (!multiplier.IsZero) { if ((multiplier.Low & 1UL) != 0UL) { result.Add(multiplicand); if (result.CompareTo(modulus) >= 0) { result.Sub(modulus); } } // Using the in-place shifts keeps the benchmarked throughput on par with the allocating operator overloads // (HighWordModulus 4.34 -> 4.21 us, LowWordHeavy 3.18 -> 2.48 us, MixedMagnitude 3.74 -> 3.58 us, TinyOperands 0.212 -> 0.260 us; InvocationCount=16, IterationCount=3). multiplicand.ShiftLeft(1); if (multiplicand.CompareTo(modulus) >= 0) { multiplicand.Sub(modulus); } multiplier.ShiftRight(1); } High = result.High; Low = result.Low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 Pow2Mod(ulong exponent, in ReadOnlyGpuUInt128 modulus) { // This should never happen in production code. // if (modulus.IsZero || modulus == One) // { // return new(); // } // This should never happen in production code. // if (exponent == 0UL) // { // return new GpuUInt128(1UL); // } GpuUInt128[] oddPowers = new GpuUInt128[PerfectNumberConstants.MaxOddPowersCount]; GpuUInt128 power = new(1UL); int oddIndex = 0; for (int bit = 1; bit <= Pow2WindowMaxExponent; bit++) { power.Add(power); if (power.CompareTo(modulus) >= 0) { power.Sub(modulus); } if ((bit & 1) != 0) { oddPowers[oddIndex] = power; oddIndex++; } } GpuUInt128 result = GpuUInt128.One; int bitLength = GetScalarBitLength(exponent); int index = bitLength - 1; while (index >= 0) { if (((exponent >> index) & 1UL) == 0UL) { result.SquareMod(modulus); index--; continue; } int windowStart = index - Pow2WindowSizeBits + 1; if (windowStart < 0) { windowStart = 0; } while (((exponent >> windowStart) & 1UL) == 0UL) { windowStart++; } int windowBitCount = index - windowStart + 1; for (int square = 0; square < windowBitCount; square++) { result.SquareMod(modulus); } ulong mask = (1UL << windowBitCount) - 1UL; ulong windowValue = (exponent >> windowStart) & mask; int tableIndex = (int)((windowValue - 1UL) >> 1); GpuUInt128 factor = oddPowers[tableIndex]; result.MulMod(factor, modulus); index = windowStart - 1; } return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static int TrailingZeroCount(in ReadOnlyGpuUInt128 value) { if (value.Low != 0UL) { return BitOperations.TrailingZeroCount(value.Low); } return 64 + BitOperations.TrailingZeroCount(value.High); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static int TrailingZeroCount(GpuUInt128 value) { if (value.Low != 0UL) { return BitOperations.TrailingZeroCount(value.Low); } return 64 + BitOperations.TrailingZeroCount(value.High); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 BinaryGcd(GpuUInt128 u, GpuUInt128 v) { // TODO: Replace this scalar binary GCD with the branchless reduction from // GpuUInt128BinaryGcdBenchmarks so CPU fallbacks stay aligned with the GPU kernel // performance when resolving large divisor residues. if (u.IsZero) { return v; } if (v.IsZero) { return u; } int shift = TrailingZeroCount(new GpuUInt128(u.High | v.High, u.Low | v.Low)); int zu = TrailingZeroCount(u); u >>= zu; do { int zv = TrailingZeroCount(v); v >>= zv; if (u > v) { (u, v) = (v, u); } v -= u; } while (!v.IsZero); return u << shift; } public void Sub(ulong value) { ulong borrow = Low < value ? 1UL : 0UL; High -= borrow; Low -= value; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SubMod(in ReadOnlyGpuUInt128 value, in ReadOnlyGpuUInt128 modulus) => SubModInternal(value.High, value.Low, in modulus); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SubMod(GpuUInt128 value, in ReadOnlyGpuUInt128 modulus) => SubModInternal(value.High, value.Low, in modulus); [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SubMod(in ReadOnlyGpuUInt128 value, GpuUInt128 modulus) { ReadOnlyGpuUInt128 readOnlyMod = modulus.AsReadOnly(); SubModInternal(value.High, value.Low, in readOnlyMod); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SubMod(GpuUInt128 value, GpuUInt128 modulus) { ReadOnlyGpuUInt128 readOnlyMod = modulus.AsReadOnly(); SubModInternal(value.High, value.Low, in readOnlyMod); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private void SubModInternal(ulong valueHigh, ulong valueLow, in ReadOnlyGpuUInt128 modulus) { if (CompareToRaw(valueHigh, valueLow) >= 0) { SubInternal(valueHigh, valueLow); return; } Add(in modulus); SubInternal(valueHigh, valueLow); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private readonly int CompareToRaw(ulong otherHigh, ulong otherLow) { if (High < otherHigh) { return -1; } if (High > otherHigh) { return 1; } if (Low < otherLow) { return -1; } if (Low > otherLow) { return 1; } return 0; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SubMod(ulong value, in ReadOnlyGpuUInt128 modulus) { ulong low = Low; ulong high = High; if (high == 0UL && low < value) { low += modulus.Low; high = modulus.High + (low < modulus.Low ? 1UL : 0UL); } ulong borrow = low < value ? 1UL : 0UL; High = high - borrow; Low = low - value; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Mul(in ReadOnlyGpuUInt128 other) { ReadOnlyGpuUInt128 readOnlyThis = AsReadOnly(); Multiply(readOnlyThis, other, out var high, out var low); High = high; Low = low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Mul(GpuUInt128 other) { ReadOnlyGpuUInt128 readOnlyThis = AsReadOnly(); ReadOnlyGpuUInt128 readOnlyOther = other.AsReadOnly(); Multiply(readOnlyThis, readOnlyOther, out var high, out var low); High = high; Low = low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Mul(ulong value) { var (highPart, lowPart) = Mul64(Low, value); High = highPart + High * value; Low = lowPart; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Mul64(ref GpuUInt128 value, ulong otherHigh, ulong otherLow) { ulong operand = value.Low; value.Low = operand * otherLow; ulong highProduct = operand * otherHigh; value.High = highProduct + MulHigh(operand, otherLow); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static GpuUInt128 DivideExact(in ReadOnlyGpuUInt128 dividend, in ReadOnlyGpuUInt128 divisor) { int divisorBits = divisor.GetBitLength(); int shift = dividend.GetBitLength() - divisorBits; GpuUInt128 quotient = Zero; GpuUInt128 remainder = dividend; GpuUInt128 shiftedDivisor = divisor; shiftedDivisor.ShiftLeft(shift); GpuUInt128 quotientBit = One; quotientBit.ShiftLeft(shift); while (true) { if (remainder.CompareTo(shiftedDivisor) >= 0) { remainder.Sub(shiftedDivisor); quotient.Add(quotientBit); } if (shift == 0) { break; } shift--; shiftedDivisor.ShiftRight(1); quotientBit.ShiftRight(1); } if (!remainder.IsZero) { throw new InvalidOperationException("DivideExact requires divisible operands."); } return quotient; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Xor(in ReadOnlyGpuUInt128 other) { High ^= other.High; Low ^= other.Low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Xor(ulong value) { Low ^= value; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void ShiftLeft(int shift) { shift &= 127; if (shift == 0) { return; } ulong high = High; ulong low = Low; if (shift >= 64) { High = low << (shift - 64); Low = 0UL; return; } int inverseShift = 64 - shift; High = (high << shift) | (low >> inverseShift); Low = low << shift; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void ShiftRight(int shift) { shift &= 127; if (shift == 0) { return; } ulong high = High; ulong low = Low; if (shift >= 64) { Low = shift == 64 ? high : high >> (shift - 64); High = 0UL; return; } int inverseShift = 64 - shift; Low = (low >> shift) | (high << inverseShift); High = high >> shift; } public void MulMod(in ReadOnlyGpuUInt128 other, in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { Low = MulMod(other, modulus.Low); High = 0UL; return; } MultiplyFull(this, other, out var p3, out var p2, out var p1, out var p0); ReduceProductBitwise(p3, p2, p1, p0, modulus); // TODO(MOD-OPT): Replace this bitwise long-division style reduction // with a faster algorithm suitable for GPU kernels without '%' support. // Options: // - Montgomery reduction for 128-bit moduli (R=2^128), requires pre- // computed modulus-dependent constants (n' and R^2 mod n). This is // ideal for NTT primes (odd modulus). Cache per-modulus constants. // - Barrett reduction with a 256/128 quotient approximation using only // multiplies and shifts. Cache mu = floor(2^k / n) for k=256. // Implement a fast path for common 64-bit NTT moduli and a separate // path for 128-bit moduli. This will significantly reduce the cost of // each butterfly in NTT and LL steps. // TODO(MOD-OPT): Plumb constants through caches in NttGpuMath.SquareCacheEntry // (e.g., Montgomery n', R2) and provide device-friendly accessors. } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void MulMod(ulong value, in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { Low = MulMod(value, modulus.Low); High = 0UL; return; } MultiplyFull(this, value, out var p3, out var p2, out var p1, out var p0); ReduceProductBitwise(p3, p2, p1, p0, modulus); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ulong MulMod(in ReadOnlyGpuUInt128 other, ulong modulus) { ulong modulusLocal = modulus; ulong a = Low % modulusLocal; ulong b = other.Low % modulusLocal; if (a == 0UL || b == 0UL) { return 0UL; } return b <= ulong.MaxValue / a ? (a * b) % modulusLocal : MulMod64(a, b, modulusLocal); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ulong MulMod(ulong value, ulong modulus) { ulong modulusLocal = modulus; ulong a = Low % modulusLocal; ulong b = value % modulusLocal; if (a == 0UL || b == 0UL) { return 0UL; } return MulMod64(a, b, modulusLocal); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ulong MulModWithNativeModulo(ulong value, ulong modulus) { // TODO: Drop this native-modulo path from production after migrating callers to MulMod, // which benchmarked 4-8× faster on dense operands and still wins on mixed workloads. ulong multiplicand = Low % modulus; var remainder = value % modulus; if (multiplicand == 0UL || remainder == 0UL) { return 0UL; } ulong result = 0UL; while (true) { ulong chunk = remainder & NativeModuloChunkMask; if (chunk != 0UL) { chunk = MultiplyChunkModulo(multiplicand, chunk, modulus); result = (result + chunk) % modulus; } remainder >>= NativeModuloChunkBits; if (remainder == 0UL) { break; } multiplicand = ShiftLeftByNativeChunk(multiplicand, modulus); } return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private void ReduceProductBitwise(ulong p3, ulong p2, ulong p1, ulong p0, in ReadOnlyGpuUInt128 modulus) { GpuUInt128 remainder = new(); int bit; // TODO: Can we modify these loops to process multiple bits at a time? E.g. 64-bit chunks. for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p3 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p2 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p1 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p0 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } High = remainder.High; Low = remainder.Low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static ulong ShiftLeftByNativeChunk(ulong value, ulong modulus) { // Multiply by 2^NativeModuloChunkBits in one pass so the native-modulo path avoids eight `%` reductions. return MulMod64(value, 1UL << NativeModuloChunkBits, modulus); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static ulong MultiplyChunkModulo(ulong value, ulong chunk, ulong modulus) { ulong result = 0UL; ulong bitMask = 1UL; for (int bit = 0; bit < NativeModuloChunkBits; bit++, bitMask <<= 1) { if ((chunk & bitMask) != 0UL) { result = (result + value) % modulus; } if (bit == NativeModuloChunkBitsMinusOne) { break; } value = (value << 1) % modulus; } return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ulong MulModMontgomery64(in ReadOnlyGpuUInt128 other, ulong modulus, ulong nPrime, ulong r2) { // TODO: Retire this struct-based Montgomery path from production after adopting the extension // helper, which benchmarks 6-7× faster across dense and near-modulus operands. ulong modulusLocal = modulus; ulong a = Low % modulusLocal; ulong b = other.Low % modulusLocal; if (a == 0UL || b == 0UL) { return 0UL; } ulong aR = MontMul64(a, r2, modulusLocal, nPrime); ulong bR = MontMul64(b, r2, modulusLocal, nPrime); ulong cR = MontMul64(aR, bR, modulusLocal, nPrime); return MontMul64(cR, 1UL, modulusLocal, nPrime); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public readonly ulong MulModMontgomery64(ulong other, ulong modulus, ulong nPrime, ulong r2) { // TODO: Same as above—migrate callers to the scalar extension to avoid this 6-7× slowdown. ulong modulusLocal = modulus; ulong a = Low % modulusLocal; ulong b = other % modulusLocal; if (a == 0UL || b == 0UL) { return 0UL; } ulong aR = MontMul64(a, r2, modulusLocal, nPrime); ulong bR = MontMul64(b, r2, modulusLocal, nPrime); ulong cR = MontMul64(aR, bR, modulusLocal, nPrime); return MontMul64(cR, 1UL, modulusLocal, nPrime); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void SquareMod(in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { Low = MulMod(Low, modulus.Low); High = 0UL; return; } SquareFull(this, out var p3, out var p2, out var p1, out var p0); // TODO: This should operate on the instance itself, not on a copy. Avoid creating new instances anywhere. GpuUInt128 remainder = new(); int bit; // TODO: Can we modify these loops to process multiple bits at a time? E.g. 64-bit chunks. for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p3 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p2 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p1 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } for (bit = 63; bit >= 0; bit--) { remainder.ShiftLeft(1); remainder.Low |= (p0 >> bit) & 1UL; if (remainder.CompareTo(modulus) >= 0) { remainder.Sub(modulus); } } High = remainder.High; Low = remainder.Low; } public void ModPow(GpuUInt128 exponent, in ReadOnlyGpuUInt128 modulus) { // TODO: Swap this copy-heavy path for the pooled base/exponent ladder used in // GpuUInt128MulModBenchmarks so the GPU shim keeps reusing buffers instead of // allocating temporary structs during residue scans. GpuUInt128 result = new(1UL); GpuUInt128 baseValue = this; // TODO: Replace the single-bit square-and-multiply loop with the 64-bit windowed // ladder measured fastest in GpuUInt128MulModBenchmarks to align with the GPU kernel // implementation once the shared helper lands. while (!exponent.IsZero) { if ((exponent.Low & 1UL) != 0UL) { result.MulMod(baseValue, modulus); } exponent.ShiftRight(1); baseValue.MulMod(baseValue, modulus); } High = result.High; Low = result.Low; } public void ModPow(ulong exponent, in ReadOnlyGpuUInt128 modulus) { // TODO: Share the pooled ladder state from GpuUInt128MulModBenchmarks here as well so // Lucas–Lehmer batches avoid constructing throwaway temporaries on every exponent. GpuUInt128 result = new(1UL); GpuUInt128 baseValue = this; // TODO: Upgrade this loop to the same 64-bit windowed ladder proven fastest in // GpuUInt128MulModBenchmarks so the scalar helper matches the GPU-optimized path. while (exponent != 0UL) { if ((exponent & 1UL) != 0UL) { result.MulMod(baseValue, modulus); } exponent >>= 1; baseValue.MulMod(baseValue, modulus); } High = result.High; Low = result.Low; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void ModInv(ulong modulus) { // TODO: Replace this Fermat inversion with the Montgomery ladder highlighted in // GpuUInt128Montgomery64Benchmarks so we avoid instantiating a temporary modulus and // reuse the pooled reduction constants. ModPow(modulus - 2UL, new GpuUInt128(modulus)); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void ModInv(in ReadOnlyGpuUInt128 modulus) { if (modulus.High == 0UL) { ModInv(modulus.Low); return; } var exponent = new GpuUInt128(modulus); exponent.Sub(2UL); ModPow(exponent, modulus); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public override readonly string ToString() => ((UInt128)this).ToString(); [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void MultiplyFull(in ReadOnlyGpuUInt128 left, in ReadOnlyGpuUInt128 right, out ulong p3, out ulong p2, out ulong p1, out ulong p0) { // TODO: Reuse variables to reduce register pressure following the fused-limb layout // from GpuUInt128MulModByLimbBenchmarks so the multiply helper matches the fastest // GPU-compatible scalar routine. var (h0, l0) = Mul64(left.Low, right.Low); var (h1, l1) = Mul64(left.Low, right.High); var (h2, l2) = Mul64(left.High, right.Low); var (h3, l3) = Mul64(left.High, right.High); p0 = l0; ulong carry = 0UL; ulong sum = h0; sum += l1; if (sum < l1) { carry++; } sum += l2; if (sum < l2) { carry++; } p1 = sum; sum = h1; sum += h2; ulong carry2 = sum < h2 ? 1UL : 0UL; sum += l3; if (sum < l3) { carry2++; } sum += carry; if (sum < carry) { carry2++; } p2 = sum; p3 = h3 + carry2; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void MultiplyFull(in ReadOnlyGpuUInt128 left, ulong right, out ulong p3, out ulong p2, out ulong p1, out ulong p0) { var (highLow, lowLow) = Mul64(left.Low, right); var (highHigh, lowHigh) = Mul64(left.High, right); p0 = lowLow; ulong mid = highLow + lowHigh; ulong carry = mid < highLow ? 1UL : 0UL; p1 = mid; ulong upper = highHigh + carry; p3 = upper < highHigh ? 1UL : 0UL; p2 = upper; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void Multiply(in ReadOnlyGpuUInt128 left, in ReadOnlyGpuUInt128 right, out ulong high, out ulong low) { // TODO: Reuse variables to reduce register pressure. var (h0, l0) = Mul64(left.Low, right.Low); low = l0; // TODO: Since we ignore the first result element, can we create a version of the function which calculates and returns only the second element? (_, l0) = Mul64(left.Low, right.High); var (_, l2) = Mul64(left.High, right.Low); // TODO: Why not just modify left instance directly instead using out parameters? high = h0 + l0 + l2; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static (ulong High, ulong Low) Mul64(ulong left, ulong right) { // TODO: Reuse variables to reduce register pressure. ulong a0 = (uint)left; ulong a1 = left >> 32; ulong b0 = (uint)right; ulong b1 = right >> 32; ulong lo = a0 * b0; ulong mid1 = a1 * b0; b0 = a0 * b1; b1 *= a1; a0 = (lo >> 32) + (uint)mid1 + (uint)b0; a1 = (lo & 0xFFFFFFFFUL) | (a0 << 32); b1 += (mid1 >> 32) + (b0 >> 32) + (a0 >> 32); return (b1, a1); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void SquareFull(in ReadOnlyGpuUInt128 value, out ulong p3, out ulong p2, out ulong p1, out ulong p0) { // TODO: Reuse variables to reduce register pressure. // Compute (H*2^64 + L)^2 = H^2*2^128 + 2*H*L*2^64 + L^2 ulong L = value.Low; ulong H = value.High; var (hLL, lLL) = Mul64(L, L); // L^2 -> (hLL,lLL) var (hHH, lHH) = Mul64(H, H); // H^2 -> (hHH,lHH) var (hLH, lLH) = Mul64(L, H); // L*H -> (hLH,lLH) // double LH: (hLH,lLH) << 1 ulong dLH_low = lLH << 1; ulong carry = (lLH >> 63) & 1UL; ulong dLH_high = (hLH << 1) | carry; // Assemble 256-bit result parts p0 = lLL; // p1 = hLL + dLH_low (with carry) ulong sum1 = hLL + dLH_low; ulong c1 = sum1 < hLL ? 1UL : 0UL; p1 = sum1; // p2 = lHH + dLH_high + c1 ulong sum2 = lHH + dLH_high; ulong c2 = sum2 < lHH ? 1UL : 0UL; sum2 += c1; if (sum2 < c1) { c2++; } p2 = sum2; // p3 = hHH + c2 p3 = hHH + c2; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static ulong MulMod64(ulong a, ulong b, ulong modulus) { ulong aReduced = a % modulus; ulong bReduced = b % modulus; if (aReduced == 0UL || bReduced == 0UL) { return 0UL; } // TODO: Can we identify where we deal with Mersenne exponent in EvenPerfectBitScanner and directly use MulModMersenne there, removing this branch? if (TryGetMersenneExponent(modulus, out int exponent)) { return MulModMersenne(aReduced, bReduced, modulus, exponent); } // Fallback for general moduli using the branch-free shift-add reducer. ulong result = 0UL; ulong x = aReduced; ulong y = bReduced; // TODO: Can we modify this loop to process multiple bits at a time? E.g. 64-bit chunks. while (y != 0UL) { if ((y & 1UL) != 0UL) { result += x; if (result >= modulus) { result -= modulus; } } x <<= 1; if (x >= modulus) { x -= modulus; } y >>= 1; } return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static ulong MulModMersenne(ulong a, ulong b, ulong modulus, int exponent) { // TODO: Reuse variables to reduce register pressure. Mul64Parts(a, b, out ulong productHigh, out ulong productLow); ulong mask = exponent == 64 ? ulong.MaxValue : modulus; ulong currentHigh = productHigh; ulong currentLow = productLow; do { ulong lower = currentLow & mask; ShiftRight128(currentHigh, currentLow, exponent, out ulong shiftedHigh, out ulong shiftedLow); currentLow = lower + shiftedLow; currentHigh = shiftedHigh; if (currentLow < lower) { currentHigh++; } } while (currentHigh != 0UL); ulong result = currentLow; // TODO: Can we modify this loop to process multiple bits at a time? E.g. 64-bit chunks. while (result >= modulus) { result -= modulus; } return result; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static bool TryGetMersenneExponent(ulong modulus, out int exponent) { if (modulus <= 1UL) { exponent = 0; return false; } modulus++; if (modulus == 0UL) { exponent = 64; return true; } if ((modulus & (modulus - 1UL)) != 0UL) { exponent = 0; return false; } int bits = 0; // TODO: Can we modify this loop to process multiple bits at a time? E.g. 64-bit chunks. while ((modulus & 1UL) == 0UL) { modulus >>= 1; bits++; } exponent = bits; return true; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ShiftRight128(ulong high, ulong low, int shift, out ulong newHigh, out ulong newLow) { if (shift == 0) { newHigh = high; newLow = low; return; } if (shift < 64) { newLow = (low >> shift) | (high << (64 - shift)); newHigh = high >> shift; return; } if (shift == 64) { newLow = high; newHigh = 0UL; return; } int extra = shift - 64; newLow = high >> extra; newHigh = 0UL; } // Montgomery core for 64-bit operands. Returns a*b*R^{-1} mod modulus. [MethodImpl(MethodImplOptions.AggressiveInlining)] private static ulong MontMul64(ulong aR, ulong bR, ulong modulus, ulong nPrime) { // TODO: Reuse variables to reduce register pressure. // t = aR * bR (128-bit) Mul64Parts(aR, bR, out ulong tHigh, out ulong tLow); // m = (tLow * nPrime) mod 2^64 (low 64 bits only) Mul64Parts(tLow, nPrime, out _, out ulong mLow); // u = (t + m * modulus) >> 64 Mul64Parts(mLow, modulus, out ulong mmHigh, out ulong mmLow); ulong carry = 0UL; ulong low = tLow + mmLow; if (low < tLow) { carry = 1UL; } ulong high = tHigh + mmHigh + carry; ulong u = high; // (t + m*n) >> 64 if (u >= modulus) { u -= modulus; } return u; } // 64x64 -> 128 multiply into (high, low) [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void Mul64Parts(ulong a, ulong b, out ulong high, out ulong low) { // TODO: Reuse variables to reduce register pressure. ulong a0 = (uint)a; ulong a1 = a >> 32; ulong b0 = (uint)b; ulong b1 = b >> 32; ulong lo = a0 * b0; ulong mid1 = a1 * b0; ulong mid2 = a0 * b1; ulong hi = a1 * b1; ulong carry = (lo >> 32) + (uint)mid1 + (uint)mid2; low = (lo & 0xFFFFFFFFUL) | (carry << 32); hi += (mid1 >> 32) + (mid2 >> 32) + (carry >> 32); high = hi; } } // TODO: Check if the TODO below is still relevant. // TODO(MOD-OPT): Montgomery/Barrett integration plan // - Introduce caches of modulus-dependent constants: // * Montgomery: n' (-(n^{-1}) mod 2^64 or 2^128), R2 = (R^2 mod n) // * Barrett: mu = floor(2^k / n) for k ∈ {128, 192, 256} // - Add fast-path for 64-bit NTT primes (modulus.High == 0UL) using pure 64-bit ops. // - Expose helpers to retrieve/calc constants once per modulus and reuse in kernels. // - Wire these into MulMod and SquareMod hot paths under feature toggles. // - Ensure ILGPU compatibility (no BigInteger, no % inside kernels).