Use generics for CustomProcedure. (#725)

To ensure high performance when executing custom procedures, the Execute method is modified to utilize generic type of GarnetApi instead of as a parameter that needs an interface call and boxing.
microsoft · Oct 16, 2024 · 14083b0 · 14083b0
1 parent 63133aa
commit 14083b0
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/libs/server/Custom/CustomProcedureWrapper.cs b/libs/server/Custom/CustomProcedureWrapper.cs
@@ -15,7 +15,8 @@ public abstract class CustomProcedure : CustomFunctions
         /// Custom command implementation
         /// </summary>
         /// <param name="garnetApi"></param>
-        public abstract bool Execute(IGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output);
+        public abstract bool Execute<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
+            where TGarnetApi : IGarnetApi;
     }
 
     class CustomProcedureWrapper

diff --git a/main/GarnetServer/Extensions/SetStringAndList.cs b/main/GarnetServer/Extensions/SetStringAndList.cs
@@ -8,7 +8,7 @@ namespace Garnet
 {
     class SetStringAndList : CustomProcedure
     {
-        public override bool Execute(IGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
+        public override bool Execute<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
         {
             var offset = 0;
             var key = GetNextArg(input, ref offset);

diff --git a/main/GarnetServer/Extensions/Sum.cs b/main/GarnetServer/Extensions/Sum.cs
@@ -8,7 +8,7 @@ namespace Garnet
 {
     class Sum : CustomProcedure
     {
-        public override bool Execute(IGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
+        public override bool Execute<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
         {
             var offset = 0;
             var sum = 0;

diff --git a/test/Garnet.test/RespCustomCommandTests.cs b/test/Garnet.test/RespCustomCommandTests.cs
@@ -21,9 +21,9 @@ namespace Garnet.test
 {
     public class LargeGet : CustomProcedure
     {
-        public override bool Execute(IGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
+        public override bool Execute<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
         {
-            static bool ResetBuffer(IGarnetApi garnetApi, ref MemoryResult<byte> output, int buffOffset)
+            static bool ResetBuffer(TGarnetApi garnetApi, ref MemoryResult<byte> output, int buffOffset)
             {
                 bool status = garnetApi.ResetScratchBuffer(buffOffset);
                 if (!status)
@@ -92,7 +92,7 @@ public override void Main<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref
 
     public class OutOfOrderFreeBuffer : CustomProcedure
     {
-        public override bool Execute(IGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
+        public override bool Execute<TGarnetApi>(TGarnetApi garnetApi, ArgSlice input, ref MemoryResult<byte> output)
         {
             var offset = 0;
             var key = GetNextArg(input, ref offset);