Add ability to disable intrinsics for tests (#1041)

* Allow testsuit to create an external GarnetServer process. Use this to test software fallbacks.

* Fmt.

* Try to get around format checker. Dotnet format didn't complain...

* Connect after waiting.

* Give lightClient a bit more time. I guess it doesn't do connection timeouts.

---------

Co-authored-by: prvyk <[email protected]>

main/GarnetServer/GarnetServer.csproj

@@ -9,8 +9,15 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Include="..\..\test\testcerts\testcert.pfx" Link="testcert.pfx">
+	<PropertyGroup>
+		<SignAssembly>true</SignAssembly>
+		<AssemblyOriginatorKeyFile>../../Garnet.snk</AssemblyOriginatorKeyFile>
+		<DelaySign>false</DelaySign>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<InternalsVisibleTo Include="Garnet.test" Key="0024000004800000940000000602000000240000525341310004000001000100011b1661238d3d3c76232193c8aa2de8c05b8930d6dfe8cd88797a8f5624fdf14a1643141f31da05c0f67961b0e3a64c7120001d2f8579f01ac788b0ff545790d44854abe02f42bfe36a056166a75c6a694db8c5b6609cff8a2dbb429855a1d9f79d4d8ec3e145c74bfdd903274b7344beea93eab86b422652f8dd8eecf530d2" />
+		<None Include="..\..\test\testcerts\testcert.pfx" Link="testcert.pfx">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
   </ItemGroup>

main/GarnetServer/Program.cs

@@ -10,7 +10,7 @@ namespace Garnet
     /// <summary>
     /// Garnet server entry point
     /// </summary>
-    class Program
+    public class Program
     {
         static void Main(string[] args)
         {

test/Garnet.test/Garnet.test.csproj

@@ -12,20 +12,6 @@
 
   <ItemGroup>
     <Compile Include="..\..\benchmark\BDN.benchmark\Embedded\EmbeddedNetworkSender.cs" Link="EmbeddedNetworkSender.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\DeleteIfMatch.cs" Link="DeleteIfMatch.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\MGetIfPM.cs" Link="MGetIfPM.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\MSetPx.cs" Link="MSetPx.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\MyDictObject.cs" Link="MyDictObject.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\MyDictSet.cs" Link="MyDictSet.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\MyDictGet.cs" Link="MyDictGet.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\GetTwoKeysNoTxn.cs" Link="GetTwoKeysNoTxn.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\ReadWriteTxn.cs" Link="ReadWriteTxn.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\SampleUpdateTxn.cs" Link="SampleUpdateTxn.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\SampleDeleteTxn.cs" Link="SampleDeleteTxn.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\SetIfPM.cs" Link="SetIfPM.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\SetWPIfPGT.cs" Link="SetWPIFPGT.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\Sum.cs" Link="Sum.cs" />
-    <Compile Include="..\..\main\GarnetServer\Extensions\SetStringAndList.cs" Link="SetStringAndList.cs" />
   </ItemGroup>
 
   <ItemGroup>
@@ -56,6 +42,7 @@
     <ProjectReference Include="..\..\libs\host\Garnet.host.csproj" />
     <ProjectReference Include="..\..\libs\server\Garnet.server.csproj" />
     <ProjectReference Include="..\..\libs\storage\Tsavorite\cs\src\devices\AzureStorageDevice\Tsavorite.devices.AzureStorageDevice.csproj" />
+    <ProjectReference Include="..\..\main\GarnetServer\GarnetServer.csproj" />
     <ProjectReference Include="..\..\playground\GarnetJSON\GarnetJSON.csproj" />
     <ProjectReference Include="..\..\playground\NoOpModule\NoOpModule.csproj" />
   </ItemGroup>

test/Garnet.test/GarnetBitmapTests.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Runtime.Intrinsics.X86;
 using Garnet.common;
 using Garnet.server;
 using NUnit.Framework;
@@ -259,25 +260,60 @@ public void BitmapSetGetBitTest_LTM(bool preSet)
 
         [Test, Order(6)]
         [Category("BITCOUNT")]
-        public void BitmapSimpleBitCountTest()
+        [TestCase(0, TestName = "BitmapSimpleBitCountTest(Hardware accelerated)")]
+        [TestCase(1, TestName = "BitmapSimpleBitCountTest(Avx2 disabled)")]
+        [TestCase(2, TestName = "BitmapSimpleBitCountTest(Software fallback)")]
+        public void BitmapSimpleBitCountTest(int acceleration)
         {
-            using var redis = ConnectionMultiplexer.Connect(TestUtils.GetConfig());
-            var db = redis.GetDatabase(0);
-
-            int maxBitmapLen = 1 << 12;
-            int iter = 1024;
-            long expectedCount = 0;
-            string key = "SimpleBitCountTest";
+            var configOptions = TestUtils.GetConfig();
 
-            for (int i = 0; i < iter; i++)
+            if (acceleration == 0)
             {
-                long offset = r.Next(1, maxBitmapLen);
-                bool set = !db.StringSetBit(key, offset, true);
-                expectedCount += set ? 1 : 0;
+                SimpleBitCountTest();
             }
+            else
+            {
+                Dictionary<string, string> env = [];
 
-            long count = db.StringBitCount(key);
-            ClassicAssert.AreEqual(expectedCount, count);
+                if (acceleration == 1)
+                {
+                    if (!Avx2.IsSupported && Ssse3.IsSupported)
+                        Assert.Ignore("Already tested by main path");
+
+                    env.Add("DOTNET_EnableAVX2", "0");
+                }
+                else
+                {
+                    if (!Avx2.IsSupported && !Ssse3.IsSupported)
+                        Assert.Ignore("Already tested by main path");
+
+                    env.Add("DOTNET_EnableHWIntrinsic", "0");
+                }
+
+                using var p = new GarnetServerTestProcess(out configOptions, env);
+
+                SimpleBitCountTest();
+            }
+
+            void SimpleBitCountTest()
+            {
+                using var redis = ConnectionMultiplexer.Connect(configOptions);
+                var db = redis.GetDatabase(0);
+                var maxBitmapLen = 1 << 12;
+                var iter = 1024;
+                var expectedCount = 0;
+                var key = "SimpleBitCountTest";
+
+                for (var i = 0; i < iter; i++)
+                {
+                    var offset = r.Next(1, maxBitmapLen);
+                    var set = !db.StringSetBit(key, offset, true);
+                    expectedCount += set ? 1 : 0;
+                }
+
+                var count = db.StringBitCount(key);
+                ClassicAssert.AreEqual(expectedCount, count);
+            }
         }
 
         private static int Index(long offset) => (int)(offset >> 3);

test/Garnet.test/TestProcess.cs

@@ -0,0 +1,95 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Net;
+using System.Reflection;
+using System.Runtime.InteropServices;
+using System.Threading;
+using Garnet.common;
+using NUnit.Framework.Legacy;
+using StackExchange.Redis;
+
+namespace Garnet.test
+{
+    internal class GarnetServerTestProcess : IDisposable
+    {
+        private readonly Process p = default;
+        private readonly Stopwatch stopWatch = default;
+        private readonly LightClientRequest lightClientRequest = default;
+
+        internal GarnetServerTestProcess(out ConfigurationOptions opts,
+                                         Dictionary<string, string> env = default,
+                                         int port = 7000)
+        {
+            var a = Assembly.GetAssembly(typeof(Garnet.Program));
+            var name = a.Location;
+            var pos = name.LastIndexOf('.');
+
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                name = name.AsSpan().Slice(0, pos).ToString() + ".exe";
+            }
+            else
+            {
+                name = name.AsSpan().Slice(0, pos).ToString();
+            }
+
+            var endPoint = new IPEndPoint(IPAddress.Loopback, port);
+            opts = TestUtils.GetConfig([endPoint]);
+
+            // We don't have to disable objects, it's done to improve startup time a bit.
+            var psi = new ProcessStartInfo(name, ["--bind", "127.0.0.1", "--port", port.ToString(), "--enable-debug-command", "local", "--no-pubsub", "--no-obj"])
+            {
+                CreateNoWindow = true,
+                RedirectStandardInput = true,
+                RedirectStandardOutput = true
+            };
+
+            if (env != default)
+            {
+                foreach (var e in env)
+                    psi.Environment.Add(e.Key, e.Value);
+            }
+
+            p = Process.Start(psi);
+            ClassicAssert.NotNull(p);
+
+            // Block until the startup message to ensure process is up.
+            var dummy = new char[1];
+            _ = p.StandardOutput.ReadBlock(dummy, 0, 1);
+
+            // Give it a bit more time
+            Thread.Sleep(100);
+            lightClientRequest = new LightClientRequest(endPoint, 0);
+
+            stopWatch = Stopwatch.StartNew();
+        }
+
+        public void Dispose()
+        {
+            if (stopWatch != default)
+            {
+                stopWatch.Stop();
+                Console.WriteLine(stopWatch.ElapsedMilliseconds);
+            }
+
+            if (p != default)
+            {
+                // We want to be sure the process is down, otherwise it may conflict
+                // with a future run. First, we'll ask nicely and then kill it.
+                try
+                {
+                    // More reliable than QUIT.
+                    _ = lightClientRequest.SendCommand("DEBUG PANIC");
+                    lightClientRequest.Dispose();
+                }
+                catch { }
+
+                try { p.Kill(); }
+                catch { }
+
+                p.Close();
+            }
+        }
+    }
+}