Add xxHash state classes

Author: mnadareski

SabreTools.Hashing/XxHash/Constants.cs

@@ -56,6 +56,19 @@ internal static class Constants
 
         public const ulong PRIME_MX2 = 0x9FB21C651E98DF25;
 
+        /// <summary>
+        /// The size of the internal XXH3 buffer.
+        /// This is the optimal update size for incremental hashing.
+        /// </summary>
+        public const int XXH3_INTERNALBUFFER_SIZE = 256;
+
+        /// <summary>
+        /// Default size of the secret buffer (and <see cref="XXH3_kSecret"/>).
+        /// This is the size used in <see cref="XXH3_kSecret"/> and the seeded functions.
+        /// Not to be confused with @ref XXH3_SECRET_SIZE_MIN.
+        /// </summary>
+        public const int XXH3_SECRET_DEFAULT_SIZE = 192;
+
         #endregion
     }
 }

SabreTools.Hashing/XxHash/XXH32State.cs

@@ -0,0 +1,39 @@
+namespace SabreTools.Hashing.XxHash
+{
+    /// <summary>
+    /// Structure for XXH32 streaming API.
+    /// </summary>
+    /// <see href="https://github.com/Cyan4973/xxHash/blob/dev/xxhash.h"/> 
+    internal class XXH32State
+    {
+        /// <summary>
+        /// Total length hashed, modulo 2^32
+        /// </summary>
+        public uint TotalLength { get; set; }
+
+        /// <summary>
+        /// Whether the hash is >= 16 (handles @ref total_len_32 overflow)
+        /// </summary>
+        public uint LargeLength { get; set; }
+
+        /// <summary>
+        /// Accumulator lanes
+        /// </summary>
+        public uint[] AccumulatorLanes { get; } = new uint[4];
+
+        /// <summary>
+        /// Internal buffer for partial reads. Treated as unsigned char[16].
+        /// </summary>
+        public uint[] PartialReadBuffer { get; } = new uint[4];
+
+        /// <summary>
+        /// Amount of data in <see cref="PartialReadBuffer">
+        /// </summary>
+        public uint Memsize { get; set; }
+
+        /// <summary>
+        /// Reserved field. Do not read nor write to it.
+        /// </summary>
+        public uint Reserved { get; set; }
+    }
+}

SabreTools.Hashing/XxHash/XXH3State.cs

@@ -0,0 +1,71 @@
+namespace SabreTools.Hashing.XxHash
+{
+    /// <summary>
+    /// Structure for XXH3 streaming API.
+    /// </summary>
+    /// <see href="https://github.com/Cyan4973/xxHash/blob/dev/xxhash.h"/> 
+    internal class XXH3State
+    {
+        /// <summary>
+        /// Accumulator lanes
+        /// </summary>
+        public ulong[] AccumulatorLanes { get; } = new ulong[8];
+
+        /// <summary>
+        /// Used to store a custom secret generated from a seed.
+        /// </summary>
+        public byte[] CustomSecret { get; } = new byte[Constants.XXH3_SECRET_DEFAULT_SIZE];
+
+        /// <summary>
+        /// The internal buffer. <see cref="XXH32State.PartialReadBuffer"/>
+        /// </summary>
+        public byte[] Buffer { get; } = new byte[Constants.XXH3_INTERNALBUFFER_SIZE];
+
+        /// <summary>
+        /// The amount of memory in <see cref="Buffer"/>, <see cref="XXH32State.Memsize"/> 
+        /// </summary>
+        public uint BufferedSize { get; set; }
+
+        /// <summary>
+        /// Reserved field. Needed for padding on 64-bit.
+        /// </summary>
+        public uint UseSeed { get; set; }
+
+        /// <summary>
+        /// Number or stripes processed.
+        /// </summary>
+        public ulong StripesSoFar { get; set; }
+
+        /// <summary>
+        /// Total length hashed. 64-bit even on 32-bit targets.
+        /// </summary>
+        public ulong TotalLength { get; set; }
+
+        /// <summary>
+        /// Number of stripes per block.
+        /// </summary>
+        public ulong StripesPerBlock { get; set; }
+
+        /// <summary>
+        /// Size of <see cref="CustomSecret"/> or <see cref="ExtSecret">
+        /// </summary>
+        public ulong SecretLimit { get; set; }
+
+        /// <summary>
+        /// Seed for _withSeed variants. Must be zero otherwise, @see XXH3_INITSTATE()
+        /// </summary>
+        public ulong Seed { get; set; }
+
+        /// <summary>
+        /// Reserved field.
+        /// </summary>
+        public ulong Reserved64 { get; set; }
+
+        /// <summary>
+        /// Reference to an external secret for the _withSecret variants, NULL
+        /// for other variants.
+        /// </summary>
+        /// <remarks>There may be some padding at the end due to alignment on 64 bytes</remarks>
+        public byte[]? ExtSecret { get; set; }
+    }
+}

SabreTools.Hashing/XxHash/XXH64State.cs

@@ -0,0 +1,39 @@
+namespace SabreTools.Hashing.XxHash
+{
+    /// <summary>
+    /// Structure for XXH64 streaming API.
+    /// </summary>
+    /// <see href="https://github.com/Cyan4973/xxHash/blob/dev/xxhash.h"/> 
+    internal class XXH64State
+    {
+        /// <summary>
+        /// Total length hashed. This is always 64-bit.
+        /// </summary>
+        public ulong TotalLength { get; set; }
+
+        /// <summary>
+        /// Accumulator lanes
+        /// </summary>
+        public ulong[] AccumulatorLanes { get; } = new ulong[4];
+
+        /// <summary>
+        /// Internal buffer for partial reads. Treated as unsigned char[16].
+        /// </summary>
+        public ulong[] PartialReadBuffer { get; } = new ulong[4];
+
+        /// <summary>
+        /// Amount of data in <see cref="PartialReadBuffer">
+        /// </summary>
+        public uint Memsize { get; set; }
+
+        /// <summary>
+        /// Reserved field, needed for padding anyways
+        /// </summary>
+        public uint Reserved32 { get; set; }
+
+        /// <summary>
+        /// Reserved field. Do not read nor write to it.
+        /// </summary>
+        public ulong Reserved64 { get; set; }
+    }
+}