Removed Consumer from benchmark actions.

Overhead always returns `void`.
dotnet · Aug 30, 2024 · 213549a · 213549a
1 parent 8b7d8d9
commit 213549a
Show file tree

Hide file tree

Showing 14 changed files with 99 additions and 919 deletions.
diff --git a/src/BenchmarkDotNet/Code/CodeGenerator.cs b/src/BenchmarkDotNet/Code/CodeGenerator.cs
@@ -47,13 +47,10 @@ internal static string Generate(BuildPartition buildPartition)
                     .Replace("$WorkloadTypeName$", provider.WorkloadTypeName)
                     .Replace("$WorkloadMethodReturnType$", provider.WorkloadMethodReturnTypeName)
                     .Replace("$WorkloadMethodReturnTypeModifiers$", provider.WorkloadMethodReturnTypeModifiers)
-                    .Replace("$OverheadMethodReturnTypeName$", provider.OverheadMethodReturnTypeName)
                     .Replace("$GlobalSetupMethodName$", provider.GlobalSetupMethodName)
                     .Replace("$GlobalCleanupMethodName$", provider.GlobalCleanupMethodName)
                     .Replace("$IterationSetupMethodName$", provider.IterationSetupMethodName)
                     .Replace("$IterationCleanupMethodName$", provider.IterationCleanupMethodName)
-                    .Replace("$OverheadImplementation$", provider.OverheadImplementation)
-                    .Replace("$ConsumeField$", provider.ConsumeField)
                     .Replace("$JobSetDefinition$", GetJobsSetDefinition(benchmark))
                     .Replace("$ParamsContent$", GetParamsContent(benchmark))
                     .Replace("$ArgumentsDefinition$", GetArgumentsDefinition(benchmark))

diff --git a/src/BenchmarkDotNet/Code/DeclarationsProvider.cs b/src/BenchmarkDotNet/Code/DeclarationsProvider.cs
@@ -40,14 +40,6 @@ internal abstract class DeclarationsProvider
 
         public virtual string GetWorkloadMethodCall(string passArguments) => $"{Descriptor.WorkloadMethod.Name}({passArguments})";
 
-        public virtual string ConsumeField => null;
-
-        protected abstract Type OverheadMethodReturnType { get; }
-
-        public string OverheadMethodReturnTypeName => OverheadMethodReturnType.GetCorrectCSharpTypeName();
-
-        public abstract string OverheadImplementation { get; }
-
         private string GetMethodName(MethodInfo method)
         {
             if (method == null)
@@ -73,62 +65,21 @@ internal class VoidDeclarationsProvider : DeclarationsProvider
         public VoidDeclarationsProvider(Descriptor descriptor) : base(descriptor) { }
 
         public override string ReturnsDefinition => "RETURNS_VOID";
-
-        protected override Type OverheadMethodReturnType => typeof(void);
-
-        public override string OverheadImplementation => string.Empty;
     }
 
     internal class NonVoidDeclarationsProvider : DeclarationsProvider
     {
         public NonVoidDeclarationsProvider(Descriptor descriptor) : base(descriptor) { }
 
-        public override string ConsumeField
-            => !Consumer.IsConsumable(WorkloadMethodReturnType) && Consumer.HasConsumableField(WorkloadMethodReturnType, out var field)
-                ? $".{field.Name}"
-                : null;
-
-        protected override Type OverheadMethodReturnType
-            => Consumer.IsConsumable(WorkloadMethodReturnType)
-                ? WorkloadMethodReturnType
-                : (Consumer.HasConsumableField(WorkloadMethodReturnType, out var field)
-                    ? field.FieldType
-                    : typeof(int)); // we return this simple type because creating bigger ValueType could take longer than benchmarked method itself
-
-        public override string OverheadImplementation
-        {
-            get
-            {
-                string value;
-                var type = OverheadMethodReturnType;
-                if (type.GetTypeInfo().IsPrimitive)
-                    value = $"default({type.GetCorrectCSharpTypeName()})";
-                else if (type.GetTypeInfo().IsClass || type.GetTypeInfo().IsInterface)
-                    value = "null";
-                else
-                    value = SourceCodeHelper.ToSourceCode(Activator.CreateInstance(type)) + ";";
-                return $"return {value};";
-            }
-        }
-
-        public override string ReturnsDefinition
-            => Consumer.IsConsumable(WorkloadMethodReturnType) || Consumer.HasConsumableField(WorkloadMethodReturnType, out _)
-                ? "RETURNS_CONSUMABLE"
-                : "RETURNS_NON_CONSUMABLE_STRUCT";
+        public override string ReturnsDefinition => "RETURNS_NON_VOID";
     }
 
     internal class ByRefDeclarationsProvider : NonVoidDeclarationsProvider
     {
         public ByRefDeclarationsProvider(Descriptor descriptor) : base(descriptor) { }
 
-        protected override Type OverheadMethodReturnType => typeof(IntPtr);
-
         public override string WorkloadMethodReturnTypeName => base.WorkloadMethodReturnTypeName.Replace("&", string.Empty);
 
-        public override string ConsumeField => null;
-
-        public override string OverheadImplementation => $"return default(System.{nameof(IntPtr)});";
-
         public override string ReturnsDefinition => "RETURNS_BYREF";
 
         public override string WorkloadMethodReturnTypeModifiers => "ref";
@@ -138,8 +89,6 @@ internal class ByReadOnlyRefDeclarationsProvider : ByRefDeclarationsProvider
     {
         public ByReadOnlyRefDeclarationsProvider(Descriptor descriptor) : base(descriptor) { }
 
-        public override string ReturnsDefinition => "RETURNS_BYREF_READONLY";
-
         public override string WorkloadMethodReturnTypeModifiers => "ref readonly";
     }
 

diff --git a/src/BenchmarkDotNet/Engines/Consumer.cs b/src/BenchmarkDotNet/Engines/Consumer.cs
@@ -1,7 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Threading;
 using JetBrains.Annotations;
@@ -11,13 +8,6 @@ namespace BenchmarkDotNet.Engines
 {
     public class Consumer
     {
-        private static readonly HashSet<Type> SupportedTypes
-            = new HashSet<Type>(
-                typeof(Consumer).GetTypeInfo()
-                                .DeclaredFields
-                                .Where(field => !field.IsStatic) // exclude this HashSet itself
-                                .Select(field => field.FieldType));
-
 #pragma warning disable IDE0052 // Remove unread private members
         private volatile byte byteHolder;
         private volatile sbyte sbyteHolder;
@@ -153,28 +143,5 @@ public void Consume<T>(in T value)
             else
                 DeadCodeEliminationHelper.KeepAliveWithoutBoxingReadonly(value); // non-primitive and nullable value types
         }
-
-        internal static bool IsConsumable(Type type)
-            => SupportedTypes.Contains(type) || type.GetTypeInfo().IsClass || type.GetTypeInfo().IsInterface;
-
-        internal static bool HasConsumableField(Type type, out FieldInfo? consumableField)
-        {
-            var typeInfo = type.GetTypeInfo();
-
-            if (typeInfo.IsEnum)
-            {
-                // Enums are tricky bastards which report "value__" field, which is public for reflection, but inaccessible via C#
-                consumableField = null;
-                return false;
-            }
-
-            var publicInstanceFields = typeInfo.DeclaredFields
-                                               .Where(field => field.IsPublic && !field.IsStatic)
-                                               .ToArray();
-
-            consumableField = publicInstanceFields.FirstOrDefault(field => IsConsumable(field.FieldType));
-
-            return consumableField != null;
-        }
     }
 }
diff --git a/src/BenchmarkDotNet/Helpers/Reflection.Emit/IlGeneratorDefaultValueExtensions.cs b/src/BenchmarkDotNet/Helpers/Reflection.Emit/IlGeneratorDefaultValueExtensions.cs
@@ -12,33 +12,20 @@ public static LocalBuilder DeclareOptionalLocalForReturnDefault(this ILGenerator
                 : null;
         }
 
-        public static void EmitSetLocalToDefault(this ILGenerator ilBuilder, LocalBuilder local)
-        {
-            var resultType = local.LocalType;
-            switch (resultType)
-            {
-                case Type t when t == typeof(void):
-                    break;
-                case Type t when t.IsClass || t.IsInterface:
-                    ilBuilder.Emit(OpCodes.Ldnull);
-                    ilBuilder.EmitStloc(local);
-                    break;
-                case Type t when t.UseInitObjForInitLocal():
-                    EmitInitObj(ilBuilder, resultType, local);
-                    break;
-                default:
-                    EmitLoadDefaultPrimitive(ilBuilder, resultType);
-                    ilBuilder.EmitStloc(local);
-                    break;
-            }
-        }
-
         public static void EmitReturnDefault(this ILGenerator ilBuilder, Type resultType, LocalBuilder optionalLocalForInitobj)
         {
             switch (resultType)
             {
                 case Type t when t == typeof(void):
                     break;
+                case Type t when t.IsPointer: // Type.IsClass returns true for pointers, so we have to check for pointer type first.
+                    /*
+                        IL_0000: ldc.i4.0
+                        IL_0001: conv.u
+                     */
+                    ilBuilder.Emit(OpCodes.Ldc_I4_0);
+                    ilBuilder.Emit(OpCodes.Conv_U);
+                    break;
                 case Type t when t.IsClass || t.IsInterface:
                     ilBuilder.Emit(OpCodes.Ldnull);
                     break;