fix: Use built-in RNG (#1599)

### Summary

.NET 8 supports Xoroshiro 256** off the shelf and added Shuffle. Switching to that implementation.

### Developer Notes

* Removed many convenience methods that weren't used.
This commit is contained in:
Kamron Batman 2023-11-17 17:45:18 -08:00 committed by GitHub
parent 1769d47ba5
commit dba3ec2db5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 159 additions and 699 deletions

View file

@ -1,190 +0,0 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: BaseRandomSource.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Diagnostics;
using System.Numerics;
using System.Runtime.CompilerServices;
namespace Server.Random;
public abstract class BaseRandomSource : IRandomSource
{
private const double INCR_DOUBLE = 1.0 / (1UL << 53);
private const float INCR_FLOAT = 1f / (1U << 24);
public abstract ulong NextULong();
public abstract void NextBytes(Span<byte> buffer);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public int Next()
{
ulong rtn;
do
{
rtn = NextULong() >> 33;
} while (rtn == 0x7fff_ffffUL);
return (int)rtn;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public int Next(int count)
{
Debug.Assert(count != 0, $"{nameof(count)} must not be 0");
if (count is -1 or 0 or 1)
{
return 0;
}
var negative = count < 0;
var max = negative ? -count : count;
var bits = Log2((uint)max);
int x;
do
{
x = (int)(NextULong() >> (64 - bits));
} while (x >= max);
return negative ? -x : x;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public int Next(int minValue, int count) => minValue + Next(count);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public uint Next(uint count)
{
Debug.Assert(count != 0, $"{nameof(count)} must not be 0");
if (count is 0 or 1)
{
return 0;
}
var bits = Log2(count);
uint x;
do
{
x = (uint)(NextULong() >> (64 - bits));
} while (x >= count);
return x;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public uint Next(uint minValue, uint count) => minValue + Next(count);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public long Next(long count)
{
Debug.Assert(count != 0, $"{nameof(count)} must not be 0");
if (count is -1 or 0 or 1)
{
return 0;
}
var negative = count < 0;
var max = negative ? -count : count;
var bits = Log2((ulong)max);
long x;
do
{
x = (long)(NextULong() >> (64 - bits));
} while (x >= max);
return negative ? -x : x;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public long Next(long minValue, long count) => minValue + Next(count);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public double NextDouble() => (NextULong() >> 11) * INCR_DOUBLE;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public int NextInt() => (int)(NextULong() >> 33);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public uint NextUInt() => (uint)NextULong();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public bool NextBool() => (NextULong() & 0x8000000000000000) != 0;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public byte NextByte() => (byte)(NextULong() >> 56);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public float NextFloat() => (NextULong() >> 40) * INCR_FLOAT;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public float NextFloatNonZero() => NextFloat() + INCR_FLOAT;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public double NextDoubleNonZero() => NextDouble() + INCR_DOUBLE;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public double NextDoubleHighRes()
{
var exponent = -64;
ulong significand;
int shift;
while ((significand = NextULong()) == 0)
{
exponent -= 64;
if (exponent < -1074)
{
return 0;
}
}
shift = BitOperations.LeadingZeroCount(significand);
if (shift != 0)
{
exponent -= shift;
significand <<= shift;
significand |= NextULong() >> (64 - shift);
}
significand |= 1;
return significand * Math.Pow(2, exponent);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static int Log2(uint v)
{
var exp = BitOperations.Log2(v);
return v == 1 << exp ? exp : exp + 1;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static int Log2(ulong v)
{
var exp = BitOperations.Log2(v);
return v == 1UL << exp ? exp : exp + 1;
}
}

View file

@ -0,0 +1,47 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: BuiltInRng.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Runtime.CompilerServices;
namespace Server.Random;
public static class BuiltInRng
{
public static System.Random Generator { get; private set; } = new();
public static void Reset() => Generator = new System.Random();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int Next() => Generator.Next();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int Next(int maxValue) => Generator.Next(maxValue);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int Next(int minValue, int count) => minValue + Generator.Next(count);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long Next(long maxValue) => Generator.NextInt64(maxValue);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long Next(long minValue, long count) => minValue + Generator.NextInt64(count);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static double NextDouble() => Generator.NextDouble();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void NextBytes(Span<byte> buffer) => Generator.NextBytes(buffer);
}

View file

@ -14,27 +14,15 @@
*************************************************************************/
using System;
using System.Buffers.Binary;
using System.Runtime.CompilerServices;
using System.Security.Cryptography;
using Server.Random;
namespace Server;
public class SecureRandom : BaseRandomSource
public static class BuiltInSecureRng
{
private RandomNumberGenerator m_Random;
public RandomNumberGenerator Generator => m_Random ??= RandomNumberGenerator.Create();
public static RandomNumberGenerator Generator { get; } = RandomNumberGenerator.Create();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override ulong NextULong()
{
Span<byte> buffer = stackalloc byte[sizeof(ulong)];
NextBytes(buffer);
return BinaryPrimitives.ReadUInt64BigEndian(buffer);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override void NextBytes(Span<byte> buffer) => Generator.GetBytes(buffer);
public static void NextBytes(Span<byte> buffer) => Generator.GetBytes(buffer);
}

View file

@ -1,40 +0,0 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: IRandomSource.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
namespace Server.Random;
public interface IRandomSource
{
int Next();
int Next(int maxValue);
int Next(int minValue, int count);
uint Next(uint maxValue);
uint Next(uint minValue, uint count);
long Next(long maxValue);
long Next(long minValue, long count);
double NextDouble();
void NextBytes(Span<byte> buffer);
int NextInt();
uint NextUInt();
ulong NextULong();
bool NextBool();
byte NextByte();
float NextFloat();
float NextFloatNonZero();
double NextDoubleNonZero();
double NextDoubleHighRes();
}

View file

@ -1,29 +0,0 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: RandomSources.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
namespace Server.Random;
public static class RandomSources
{
private static IRandomSource _source;
private static IRandomSource _secureSource;
public static IRandomSource Source => _source ??= new Xoshiro256PlusPlus();
public static IRandomSource SecureSource => _secureSource ??= new SecureRandom();
public static void SetRng(IRandomSource newSource) => _source = newSource;
public static void SetSecureRng(IRandomSource newSource) => _secureSource = newSource;
}

View file

@ -0,0 +1,81 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: StableRandom.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Numerics;
using System.Runtime.CompilerServices;
namespace Server.Random;
public static class StableRandom
{
// Returns the first long of a new Rng. Used for stable values given a specific set of inputs.
public static long First(ulong seed, long maxValue)
{
Span<ulong> state = stackalloc ulong[4];
var x = seed;
state[0] = NextSplitMix(ref x);
state[1] = NextSplitMix(ref x);
state[2] = NextSplitMix(ref x);
state[3] = NextSplitMix(ref x);
return (long)NextUInt64(state, (ulong)maxValue);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static ulong NextUInt64(Span<ulong> state, ulong maxValue)
{
ulong randomProduct = Math.BigMul(maxValue, NextUInt64(ref state), out ulong lowPart);
if (lowPart < maxValue)
{
ulong remainder = (0ul - maxValue) % maxValue;
while (lowPart < remainder)
{
randomProduct = Math.BigMul(maxValue, NextUInt64(ref state), out lowPart);
}
}
return randomProduct;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static ulong NextUInt64(ref Span<ulong> state)
{
ulong result = BitOperations.RotateLeft(state[1] * 5, 7) * 9;
ulong t = state[1] << 17;
state[2] ^= state[0];
state[3] ^= state[1];
state[1] ^= state[2];
state[0] ^= state[3];
state[2] ^= t;
state[3] = BitOperations.RotateLeft(state[3], 45);
return result;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static ulong NextSplitMix(ref ulong x)
{
var z = x += 0x9e3779b97f4a7c15;
z = (z ^ (z >> 30)) * 0xbf58476d1ce4e5b9;
z = (z ^ (z >> 27)) * 0x94d049bb133111eb;
return z ^ (z >> 31);
}
}

View file

@ -1,222 +0,0 @@
/*************************************************************************
* ModernUO *
* Copyright 2019-2023 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: Xoshiro256PlusPlus.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Buffers.Binary;
using System.Runtime.CompilerServices;
namespace Server.Random;
public class Xoshiro256PlusPlus : BaseRandomSource
{
private static readonly ulong[] JUMP =
{ 0x180ec6d33cfd0aba, 0xd5a61266f0c9392c, 0xa9582618e03fc9aa, 0x39abdc4529b1661c };
private static readonly ulong[] LONG_JUMP =
{ 0x76e15d3efefdcbbf, 0xc5004e441c522fb3, 0x77710069854ee241, 0x39109bb02acbe635 };
private ulong _s0, _s1, _s2, _s3;
public Xoshiro256PlusPlus()
{
Span<byte> states = stackalloc byte[32];
RandomSources.SecureSource.NextBytes(states);
_s0 = BinaryPrimitives.ReadUInt64LittleEndian(states[..8]);
_s1 = BinaryPrimitives.ReadUInt64LittleEndian(states[8..16]);
_s2 = BinaryPrimitives.ReadUInt64LittleEndian(states[16..24]);
_s3 = BinaryPrimitives.ReadUInt64LittleEndian(states[24..32]);
}
public Xoshiro256PlusPlus(ulong seed)
{
var mix = new SplitMix64(seed);
Span<ulong> state = stackalloc ulong[4];
mix.FillArray(state);
_s0 = state[0];
_s1 = state[1];
_s2 = state[2];
_s3 = state[3];
}
private Xoshiro256PlusPlus(ulong s0, ulong s1, ulong s2, ulong s3)
{
_s0 = s0;
_s1 = s1;
_s2 = s2;
_s3 = s3;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override ulong NextULong()
{
var r1 = (_s1 << 2) + _s1;
var r2 = (r1 << 7) | (r1 >> 57);
var rslt = (r2 << 3) + r2;
var t = _s1 << 17;
_s2 ^= _s0;
_s3 ^= _s1;
_s1 ^= _s2;
_s0 ^= _s3;
_s2 ^= t;
_s3 = (_s3 << 45) | (_s3 >> 19);
return rslt;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override unsafe void NextBytes(Span<byte> b)
{
if (b.Length == 0)
{
return;
}
var s0 = _s0;
var s1 = _s1;
var s2 = _s2;
var s3 = _s3;
var i = 0;
fixed (byte* pBuffer = b)
{
var pULong = (ulong*)pBuffer;
for (var bound = b.Length / sizeof(ulong); i < bound; i++)
{
var r1 = (s1 << 2) + s1;
var r2 = (r1 << 7) | (r1 >> 57);
pULong[i] = (r2 << 3) + r2;
var t = s1 << 17;
s2 ^= s0;
s3 ^= s1;
s1 ^= s2;
s0 ^= s3;
s2 ^= t;
s3 = (s3 << 45) | (s3 >> 19);
}
}
i *= 8;
if (i < b.Length)
{
var r1 = (s1 << 2) + s1;
var r2 = (r1 << 7) | (r1 >> 57);
var rslt = (r2 << 3) + r2;
var t = s1 << 17;
s2 ^= s0;
s3 ^= s1;
s1 ^= s2;
s0 ^= s3;
s2 ^= t;
s3 = (s3 << 45) | (s3 >> 19);
while (i < b.Length)
{
b[i++] = (byte)rslt;
rslt >>= 8;
}
}
_s0 = s0;
_s1 = s1;
_s2 = s2;
_s3 = s3;
}
public void Jump() => Jump(JUMP);
public void LongJump() => Jump(LONG_JUMP);
private void Jump(in ulong[] jumps)
{
ulong s0 = 0;
ulong s1 = 0;
ulong s2 = 0;
ulong s3 = 0;
for (var i = 0; i < jumps.Length; i++)
{
for (var b = 0; b < 64; b++)
{
if ((jumps[i] & (1ul << b)) != 0)
{
s0 ^= _s0;
s1 ^= _s1;
s2 ^= _s2;
s3 ^= _s3;
}
NextULong();
}
}
_s0 = s0;
_s1 = s1;
_s2 = s2;
_s3 = s3;
}
public Xoshiro256PlusPlus Split()
{
var rng = new Xoshiro256PlusPlus(_s0, _s1, _s2, _s3);
rng.Jump();
return rng;
}
public Xoshiro256PlusPlus LongSplit()
{
var rng = new Xoshiro256PlusPlus(_s0, _s1, _s2, _s3);
rng.LongJump();
return rng;
}
}
public class SplitMix64
{
private ulong x;
public SplitMix64(ulong seed) => x = seed;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public ulong Next()
{
var z = x += 0x9e3779b97f4a7c15;
z = (z ^ (z >> 30)) * 0xbf58476d1ce4e5b9;
z = (z ^ (z >> 27)) * 0x94d049bb133111eb;
return z ^ (z >> 31);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void FillArray(Span<ulong> arr)
{
for (var i = 0; i < arr.Length; i++)
{
arr[i] = Next();
}
}
}