diff --git a/BitFaster.Caching.Benchmarks/BitFaster.Caching.Benchmarks.csproj b/BitFaster.Caching.Benchmarks/BitFaster.Caching.Benchmarks.csproj index f61ff6a9..789e1174 100644 --- a/BitFaster.Caching.Benchmarks/BitFaster.Caching.Benchmarks.csproj +++ b/BitFaster.Caching.Benchmarks/BitFaster.Caching.Benchmarks.csproj @@ -2,6 +2,7 @@ Exe + latest net48;net6.0;net8.0 True diff --git a/BitFaster.Caching.Benchmarks/Lfu/CmSketchNoPin.cs b/BitFaster.Caching.Benchmarks/Lfu/CmSketchNoPin.cs new file mode 100644 index 00000000..809a3f9b --- /dev/null +++ b/BitFaster.Caching.Benchmarks/Lfu/CmSketchNoPin.cs @@ -0,0 +1,318 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; + +#if NET6_0_OR_GREATER +using System.Runtime.Intrinsics; +using System.Runtime.Intrinsics.X86; +#endif + +namespace BitFaster.Caching.Benchmarks.Lfu +{ + internal class CmSketchNoPin + where T : notnull + where I : struct, IsaProbe + { + private const long ResetMask = 0x7777777777777777L; + private const long OneMask = 0x1111111111111111L; + + private long[] table; + private int sampleSize; + private int blockMask; + private int size; + + private readonly IEqualityComparer comparer; + + /// + /// Initializes a new instance of the CmSketch class with the specified maximum size and equality comparer. + /// + /// The maximum size. + /// The equality comparer. + public CmSketchNoPin(long maximumSize, IEqualityComparer comparer) + { + EnsureCapacity(maximumSize); + this.comparer = comparer; + } + + /// + /// Gets the reset sample size. + /// + public int ResetSampleSize => this.sampleSize; + + /// + /// Gets the size. + /// + public int Size => this.size; + + /// + /// Estimate the frequency of the specified value, up to the maximum of 15. + /// + /// The value. + /// The estimated frequency of the value. + public int EstimateFrequency(T value) + { +#if NET48 + return EstimateFrequencyStd(value); +#else + + I isa = default; + + if (isa.IsAvx2Supported) + { + return EstimateFrequencyAvx(value); + } + else + { + return EstimateFrequencyStd(value); + } +#endif + } + + /// + /// Increment the count of the specified value. + /// + /// The value. + public void Increment(T value) + { +#if NET48 + IncrementStd(value); +#else + + I isa = default; + + if (isa.IsAvx2Supported) + { + IncrementAvx(value); + } + else + { + IncrementStd(value); + } +#endif + } + + /// + /// Clears the count for all items. + /// + public void Clear() + { + table = new long[table.Length]; + size = 0; + } + + // [MemberNotNull(nameof(table))] + private void EnsureCapacity(long maximumSize) + { + int maximum = (int)Math.Min(maximumSize, int.MaxValue >> 1); + + table = new long[Math.Max(BitOps.CeilingPowerOfTwo(maximum), 8)]; + blockMask = (int)((uint)table.Length >> 3) - 1; + sampleSize = (maximumSize == 0) ? 10 : (10 * maximum); + + size = 0; + } + + private unsafe int EstimateFrequencyStd(T value) + { + var count = stackalloc int[4]; + int blockHash = Spread(comparer.GetHashCode(value)); + int counterHash = Rehash(blockHash); + int block = (blockHash & blockMask) << 3; + + for (int i = 0; i < 4; i++) + { + int h = (int)((uint)counterHash >> (i << 3)); + int index = (h >> 1) & 15; + int offset = h & 1; + count[i] = (int)(((ulong)table[block + offset + (i << 1)] >> (index << 2)) & 0xfL); + } + return Math.Min(Math.Min(count[0], count[1]), Math.Min(count[2], count[3])); + } + + private unsafe void IncrementStd(T value) + { + var index = stackalloc int[8]; + int blockHash = Spread(comparer.GetHashCode(value)); + int counterHash = Rehash(blockHash); + int block = (blockHash & blockMask) << 3; + + for (int i = 0; i < 4; i++) + { + int h = (int)((uint)counterHash >> (i << 3)); + index[i] = (h >> 1) & 15; + int offset = h & 1; + index[i + 4] = block + offset + (i << 1); + } + + bool added = + IncrementAt(index[4], index[0]) + | IncrementAt(index[5], index[1]) + | IncrementAt(index[6], index[2]) + | IncrementAt(index[7], index[3]); + + if (added && (++size == sampleSize)) + { + Reset(); + } + } + + // Applies another round of hashing for additional randomization + private static int Rehash(int x) + { + x = (int)(x * 0x31848bab); + x ^= (int)((uint)x >> 14); + return x; + } + + // Applies a supplemental hash functions to defends against poor quality hash. + private static int Spread(int x) + { + x ^= (int)((uint)x >> 17); + x = (int)(x * 0xed5ad4bb); + x ^= (int)((uint)x >> 11); + x = (int)(x * 0xac4c1b51); + x ^= (int)((uint)x >> 15); + return x; + } + + private bool IncrementAt(int i, int j) + { + int offset = j << 2; + long mask = (0xfL << offset); + + if ((table[i] & mask) != mask) + { + table[i] += (1L << offset); + return true; + } + + return false; + } + + private void Reset() + { + // unroll, almost 2x faster + int count0 = 0; + int count1 = 0; + int count2 = 0; + int count3 = 0; + + for (int i = 0; i < table.Length; i += 4) + { + count0 += BitOps.BitCount(table[i] & OneMask); + count1 += BitOps.BitCount(table[i + 1] & OneMask); + count2 += BitOps.BitCount(table[i + 2] & OneMask); + count3 += BitOps.BitCount(table[i + 3] & OneMask); + + table[i] = (long)((ulong)table[i] >> 1) & ResetMask; + table[i + 1] = (long)((ulong)table[i + 1] >> 1) & ResetMask; + table[i + 2] = (long)((ulong)table[i + 2] >> 1) & ResetMask; + table[i + 3] = (long)((ulong)table[i + 3] >> 1) & ResetMask; + } + + count0 = (count0 + count1) + (count2 + count3); + + size = (size - (count0 >> 2)) >> 1; + } + +#if NET6_0_OR_GREATER + private unsafe int EstimateFrequencyAvx(T value) + { + int blockHash = Spread(comparer.GetHashCode(value)); + int counterHash = Rehash(blockHash); + int block = (blockHash & blockMask) << 3; + + Vector128 h = Vector128.Create(counterHash); + h = Avx2.ShiftRightLogicalVariable(h.AsUInt32(), Vector128.Create(0U, 8U, 16U, 24U)).AsInt32(); + + var index = Avx2.ShiftRightLogical(h, 1); + index = Avx2.And(index, Vector128.Create(15)); // j - counter index + Vector128 offset = Avx2.And(h, Vector128.Create(1)); + Vector128 blockOffset = Avx2.Add(Vector128.Create(block), offset); // i - table index + blockOffset = Avx2.Add(blockOffset, Vector128.Create(0, 2, 4, 6)); // + (i << 1) + + fixed (long* tablePtr = table) + { + Vector256 tableVector = Avx2.GatherVector256(tablePtr, blockOffset, 8); + index = Avx2.ShiftLeftLogical(index, 2); + + // convert index from int to long via permute + Vector256 indexLong = Vector256.Create(index, Vector128.Zero).AsInt64(); + Vector256 permuteMask2 = Vector256.Create(0, 4, 1, 5, 2, 5, 3, 7); + indexLong = Avx2.PermuteVar8x32(indexLong.AsInt32(), permuteMask2).AsInt64(); + tableVector = Avx2.ShiftRightLogicalVariable(tableVector, indexLong.AsUInt64()); + tableVector = Avx2.And(tableVector, Vector256.Create(0xfL)); + + Vector256 permuteMask = Vector256.Create(0, 2, 4, 6, 1, 3, 5, 7); + Vector128 count = Avx2.PermuteVar8x32(tableVector.AsInt32(), permuteMask) + .GetLower() + .AsUInt16(); + + // set the zeroed high parts of the long value to ushort.Max +#if NET6_0 + count = Avx2.Blend(count, Vector128.AllBitsSet, 0b10101010); +#else + count = Avx2.Blend(count, Vector128.Create(ushort.MaxValue), 0b10101010); +#endif + + return Avx2.MinHorizontal(count).GetElement(0); + } + } + + private unsafe void IncrementAvx(T value) + { + int blockHash = Spread(comparer.GetHashCode(value)); + int counterHash = Rehash(blockHash); + int block = (blockHash & blockMask) << 3; + + Vector128 h = Vector128.Create(counterHash); + h = Avx2.ShiftRightLogicalVariable(h.AsUInt32(), Vector128.Create(0U, 8U, 16U, 24U)).AsInt32(); + + Vector128 index = Avx2.ShiftRightLogical(h, 1); + index = Avx2.And(index, Vector128.Create(15)); // j - counter index + Vector128 offset = Avx2.And(h, Vector128.Create(1)); + Vector128 blockOffset = Avx2.Add(Vector128.Create(block), offset); // i - table index + blockOffset = Avx2.Add(blockOffset, Vector128.Create(0, 2, 4, 6)); // + (i << 1) + + fixed (long* tablePtr = table) + { + Vector256 tableVector = Avx2.GatherVector256(tablePtr, blockOffset, 8); + + // j == index + index = Avx2.ShiftLeftLogical(index, 2); + Vector256 offsetLong = Vector256.Create(index, Vector128.Zero).AsInt64(); + + Vector256 permuteMask = Vector256.Create(0, 4, 1, 5, 2, 5, 3, 7); + offsetLong = Avx2.PermuteVar8x32(offsetLong.AsInt32(), permuteMask).AsInt64(); + + // mask = (0xfL << offset) + Vector256 fifteen = Vector256.Create(0xfL); + Vector256 mask = Avx2.ShiftLeftLogicalVariable(fifteen, offsetLong.AsUInt64()); + + // (table[i] & mask) != mask) + // Note masked is 'equal' - therefore use AndNot below + Vector256 masked = Avx2.CompareEqual(Avx2.And(tableVector, mask), mask); + + // 1L << offset + Vector256 inc = Avx2.ShiftLeftLogicalVariable(Vector256.Create(1L), offsetLong.AsUInt64()); + + // Mask to zero out non matches (add zero below) - first operand is NOT then AND result (order matters) + inc = Avx2.AndNot(masked, inc); + + Vector256 result = Avx2.CompareEqual(masked.AsByte(), Vector256.Zero); + bool wasInc = Avx2.MoveMask(result.AsByte()) == unchecked((int)(0b1111_1111_1111_1111_1111_1111_1111_1111)); + + tablePtr[blockOffset.GetElement(0)] += inc.GetElement(0); + tablePtr[blockOffset.GetElement(1)] += inc.GetElement(1); + tablePtr[blockOffset.GetElement(2)] += inc.GetElement(2); + tablePtr[blockOffset.GetElement(3)] += inc.GetElement(3); + + if (wasInc && (++size == sampleSize)) + { + Reset(); + } + } + } +#endif + } +} diff --git a/BitFaster.Caching.Benchmarks/Lfu/SketchFrequency.cs b/BitFaster.Caching.Benchmarks/Lfu/SketchFrequency.cs index b97bc19d..b49e5bcf 100644 --- a/BitFaster.Caching.Benchmarks/Lfu/SketchFrequency.cs +++ b/BitFaster.Caching.Benchmarks/Lfu/SketchFrequency.cs @@ -8,9 +8,11 @@ namespace BitFaster.Caching.Benchmarks.Lfu { [SimpleJob(RuntimeMoniker.Net60)] + [SimpleJob(RuntimeMoniker.Net80)] + [SimpleJob(RuntimeMoniker.Net90)] [MemoryDiagnoser(displayGenColumns: false)] [HideColumns("Job", "Median", "RatioSD", "Alloc Ratio")] - [ColumnChart(Title ="Sketch Frequency ({JOB})")] + [ColumnChart(Title = "Sketch Frequency ({JOB})", Colors = "#cd5c5c,#fa8072,#ffa07a")] public class SketchFrequency { const int sketchSize = 1_048_576; @@ -20,6 +22,7 @@ public class SketchFrequency private CmSketchFlat flatAvx; private CmSketchCore blockStd; + private CmSketchNoPin blockAvxNoPin; private CmSketchCore blockAvx; [Params(32_768, 524_288, 8_388_608, 134_217_728)] @@ -32,6 +35,7 @@ public void Setup() flatAvx = new CmSketchFlat(Size, EqualityComparer.Default); blockStd = new CmSketchCore(Size, EqualityComparer.Default); + blockAvxNoPin = new CmSketchNoPin(Size, EqualityComparer.Default); blockAvx = new CmSketchCore(Size, EqualityComparer.Default); } @@ -66,7 +70,17 @@ public int FrequencyBlock() } [Benchmark(OperationsPerInvoke = iterations)] - public int FrequencyBlockAvx() + public int FrequencyBlockAvxNotPinned() + { + int count = 0; + for (int i = 0; i < iterations; i++) + count += blockAvxNoPin.EstimateFrequency(i) > blockAvx.EstimateFrequency(i + 1) ? 1 : 0; + + return count; + } + + [Benchmark(OperationsPerInvoke = iterations)] + public int FrequencyBlockAvxPinned() { int count = 0; for (int i = 0; i < iterations; i++) diff --git a/BitFaster.Caching.Benchmarks/Lfu/SketchIncrement.cs b/BitFaster.Caching.Benchmarks/Lfu/SketchIncrement.cs index eb005032..6bcd0272 100644 --- a/BitFaster.Caching.Benchmarks/Lfu/SketchIncrement.cs +++ b/BitFaster.Caching.Benchmarks/Lfu/SketchIncrement.cs @@ -1,5 +1,6 @@  using System.Collections.Generic; +using Benchly; using BenchmarkDotNet.Attributes; using BenchmarkDotNet.Jobs; using BitFaster.Caching.Lfu; @@ -7,8 +8,11 @@ namespace BitFaster.Caching.Benchmarks.Lfu { [SimpleJob(RuntimeMoniker.Net60)] + [SimpleJob(RuntimeMoniker.Net80)] + [SimpleJob(RuntimeMoniker.Net90)] [MemoryDiagnoser(displayGenColumns: false)] [HideColumns("Job", "Median", "RatioSD", "Alloc Ratio")] + [ColumnChart(Title = "Sketch Increment ({JOB})", Colors = "#cd5c5c,#fa8072,#ffa07a")] public class SketchIncrement { const int iterations = 1_048_576; @@ -17,6 +21,7 @@ public class SketchIncrement private CmSketchFlat flatAvx; private CmSketchCore blockStd; + private CmSketchNoPin blockAvxNoPin; private CmSketchCore blockAvx; [Params(32_768, 524_288, 8_388_608, 134_217_728)] @@ -29,6 +34,7 @@ public void Setup() flatAvx = new CmSketchFlat(Size, EqualityComparer.Default); blockStd = new CmSketchCore(Size, EqualityComparer.Default); + blockAvxNoPin = new CmSketchNoPin(Size, EqualityComparer.Default); blockAvx = new CmSketchCore(Size, EqualityComparer.Default); } @@ -60,7 +66,16 @@ public void IncBlock() } [Benchmark(OperationsPerInvoke = iterations)] - public void IncBlockAvx() + public void IncBlockAvxNotPinned() + { + for (int i = 0; i < iterations; i++) + { + blockAvxNoPin.Increment(i); + } + } + + [Benchmark(OperationsPerInvoke = iterations)] + public void IncBlockAvxPinned() { for (int i = 0; i < iterations; i++) { diff --git a/BitFaster.Caching/Lfu/CmSketchCore.cs b/BitFaster.Caching/Lfu/CmSketchCore.cs index de255840..fdb5d9f0 100644 --- a/BitFaster.Caching/Lfu/CmSketchCore.cs +++ b/BitFaster.Caching/Lfu/CmSketchCore.cs @@ -1,6 +1,8 @@ using System; using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; #if !NETSTANDARD2_0 @@ -24,7 +26,7 @@ namespace BitFaster.Caching.Lfu /// /// This is a direct C# translation of FrequencySketch in the Caffeine library by ben.manes@gmail.com (Ben Manes). /// https://github.com/ben-manes/caffeine - public class CmSketchCore + public unsafe class CmSketchCore where T : notnull where I : struct, IsaProbe { @@ -32,6 +34,9 @@ public class CmSketchCore private const long OneMask = 0x1111111111111111L; private long[] table; +#if NET6_0_OR_GREATER + private long* tableAddr; +#endif private int sampleSize; private int blockMask; private int size; @@ -111,7 +116,7 @@ public void Increment(T value) /// public void Clear() { - table = new long[table.Length]; + Array.Clear(table, 0, table.Length); size = 0; } @@ -120,8 +125,27 @@ private void EnsureCapacity(long maximumSize) { int maximum = (int)Math.Min(maximumSize, int.MaxValue >> 1); - table = new long[Math.Max(BitOps.CeilingPowerOfTwo(maximum), 8)]; - blockMask = (int)((uint)table.Length >> 3) - 1; +#if NET6_0_OR_GREATER + I isa = default; + if (isa.IsAvx2Supported) + { + // over alloc by 8 to give 64 bytes padding, tableAddr is then aligned to 64 bytes + const int pad = 8; + bool pinned = true; + table = GC.AllocateArray(Math.Max(BitOps.CeilingPowerOfTwo(maximum), 8) + pad, pinned); + + tableAddr = (long*)Unsafe.AsPointer(ref table[0]); + tableAddr = (long*)((long)tableAddr + (long)tableAddr % 64); + + blockMask = (int)((uint)(table.Length - pad) >> 3) - 1; + } + else +#endif + { + table = new long[Math.Max(BitOps.CeilingPowerOfTwo(maximum), 8)]; + blockMask = (int)((uint)(table.Length) >> 3) - 1; + } + sampleSize = (maximumSize == 0) ? 10 : (10 * maximum); size = 0; @@ -171,7 +195,7 @@ private unsafe void IncrementStd(T value) } } - // Applies another round of hashing for additional randomization + // Applies another round of hashing for additional randomization. private static int Rehash(int x) { x = (int)(x * 0x31848bab); @@ -179,7 +203,7 @@ private static int Rehash(int x) return x; } - // Applies a supplemental hash functions to defends against poor quality hash. + // Applies a supplemental hash function to defend against poor quality hash. private static int Spread(int x) { x ^= (int)((uint)x >> 17); @@ -246,7 +270,11 @@ private unsafe int EstimateFrequencyAvx(T value) Vector128 blockOffset = Avx2.Add(Vector128.Create(block), offset); // i - table index blockOffset = Avx2.Add(blockOffset, Vector128.Create(0, 2, 4, 6)); // + (i << 1) +#if NET6_0_OR_GREATER + long* tablePtr = tableAddr; +#else fixed (long* tablePtr = table) +#endif { Vector256 tableVector = Avx2.GatherVector256(tablePtr, blockOffset, 8); index = Avx2.ShiftLeftLogical(index, 2); @@ -264,7 +292,7 @@ private unsafe int EstimateFrequencyAvx(T value) .AsUInt16(); // set the zeroed high parts of the long value to ushort.Max -#if NET6_0 +#if NET6_0_OR_GREATER count = Avx2.Blend(count, Vector128.AllBitsSet, 0b10101010); #else count = Avx2.Blend(count, Vector128.Create(ushort.MaxValue), 0b10101010); @@ -289,7 +317,11 @@ private unsafe void IncrementAvx(T value) Vector128 blockOffset = Avx2.Add(Vector128.Create(block), offset); // i - table index blockOffset = Avx2.Add(blockOffset, Vector128.Create(0, 2, 4, 6)); // + (i << 1) +#if NET6_0_OR_GREATER + long* tablePtr = tableAddr; +#else fixed (long* tablePtr = table) +#endif { Vector256 tableVector = Avx2.GatherVector256(tablePtr, blockOffset, 8);