经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » ASP.net » 查看文章
【.NET8】访问私有成员新姿势UnsafeAccessor(下)
来源:cnblogs  作者:InCerry  时间:2023/9/20 9:28:15  对本文有异议

前言

书接上回,我们讨论了在.NET8中新增的UnsafeAccessor,并且通过UnsafeAccessor访问了私有成员,这极大的方便了我们代码的编写,当然也聊到了它当前存在的一些局限性,那么它的性能到底如何?我们今天就来实际测试一下。

测试代码

话不多说,直接上代码,本次测试代码如下:

  1. using System.Linq.Expressions;
  2. using System.Reflection;
  3. using System.Reflection.Emit;
  4. using System.Runtime.CompilerServices;
  5. using BenchmarkDotNet.Attributes;
  6. using BenchmarkDotNet.Columns;
  7. using BenchmarkDotNet.Configs;
  8. using BenchmarkDotNet.Order;
  9. using BenchmarkDotNet.Reports;
  10. using BenchmarkDotNet.Running;
  11. using Perfolizer.Horology;
  12. [MemoryDiagnoser]
  13. [Orderer(SummaryOrderPolicy.FastestToSlowest)]
  14. public class AccessBenchmarks
  15. {
  16. public static readonly A TestInstance = new();
  17. public static readonly Action<A, int> SetDelegate;
  18. public static readonly Func<A, int> GetDelegate;
  19. public static readonly PropertyInfo ValueProperty;
  20. public static readonly MethodInfo SetValueMethod;
  21. public static readonly MethodInfo GetValueMethod;
  22. public static readonly Func<A, int> GetValueExpressionFunc;
  23. public static readonly Action<A, int> SetValueExpressionAction;
  24. static AccessBenchmarks()
  25. {
  26. TestInstance = new();
  27. ValueProperty = typeof(A).GetProperty("Value");
  28. SetValueMethod = ValueProperty.GetSetMethod();
  29. GetValueMethod = ValueProperty.GetGetMethod();
  30. SetDelegate = CreateSetDelegate();
  31. GetDelegate = CreateGetDelegate();
  32. GetValueExpressionFunc = CreateGetValueExpressionFunc();
  33. SetValueExpressionAction = CreateSetValueExpressionAction();
  34. }
  35. [UnsafeAccessor(UnsafeAccessorKind.Method, Name = "get_Value")]
  36. static extern int GetValueUnsafe(A a);
  37. [UnsafeAccessor(UnsafeAccessorKind.Method, Name = "set_Value")]
  38. static extern void SetValueUnsafe(A a, int value);
  39. [Benchmark]
  40. public void UnsafeAccessor()
  41. {
  42. SetValueUnsafe(TestInstance, 10);
  43. var value = GetValueUnsafe(TestInstance);
  44. }
  45. [Benchmark]
  46. public void Reflection()
  47. {
  48. SetValueMethod.Invoke(TestInstance, new object[] { 10 });
  49. var value = GetValueMethod.Invoke(TestInstance, new object[] { });
  50. }
  51. [Benchmark]
  52. public void Emit()
  53. {
  54. SetDelegate(TestInstance, 10);
  55. var value = GetDelegate(TestInstance);
  56. }
  57. [Benchmark]
  58. public void ExpressionTrees()
  59. {
  60. SetValueExpressionAction(TestInstance, 10);
  61. var value = GetValueExpressionFunc(TestInstance);
  62. }
  63. [Benchmark]
  64. public void Direct()
  65. {
  66. TestInstance.Value = 10;
  67. var value = TestInstance.Value;
  68. }
  69. private static Action<A, int> CreateSetDelegate()
  70. {
  71. var dynamicMethod = new DynamicMethod("SetValue", null, new[] { typeof(A), typeof(int) }, typeof(A));
  72. var ilGenerator = dynamicMethod.GetILGenerator();
  73. ilGenerator.Emit(OpCodes.Ldarg_0);
  74. ilGenerator.Emit(OpCodes.Ldarg_1);
  75. ilGenerator.EmitCall(OpCodes.Call, SetValueMethod, null);
  76. ilGenerator.Emit(OpCodes.Ret);
  77. return (Action<A, int>)dynamicMethod.CreateDelegate(typeof(Action<A, int>));
  78. }
  79. private static Func<A, int> CreateGetDelegate()
  80. {
  81. var dynamicMethod = new DynamicMethod("GetValue", typeof(int), new[] { typeof(A) }, typeof(A));
  82. var ilGenerator = dynamicMethod.GetILGenerator();
  83. ilGenerator.Emit(OpCodes.Ldarg_0);
  84. ilGenerator.EmitCall(OpCodes.Call, GetValueMethod, null);
  85. ilGenerator.Emit(OpCodes.Ret);
  86. return (Func<A, int>)dynamicMethod.CreateDelegate(typeof(Func<A, int>));
  87. }
  88. private static Func<A, int> CreateGetValueExpressionFunc()
  89. {
  90. var instance = Expression.Parameter(typeof(A), "instance");
  91. var getValueExpression = Expression.Lambda<Func<A, int>>(
  92. Expression.Property(instance, ValueProperty),
  93. instance);
  94. return getValueExpression.Compile();
  95. }
  96. private static Action<A, int> CreateSetValueExpressionAction()
  97. {
  98. var instance = Expression.Parameter(typeof(A), "instance");
  99. var value = Expression.Parameter(typeof(int), "value");
  100. var setValueExpression = Expression.Lambda<Action<A, int>>(
  101. Expression.Call(instance, ValueProperty.GetSetMethod(true), value),
  102. instance, value);
  103. return setValueExpression.Compile();
  104. }
  105. }
  106. public class A
  107. {
  108. public int Value { get; set; }
  109. }
  110. public class Program
  111. {
  112. public static void Main()
  113. {
  114. Console.WriteLine(AccessBenchmarks.TestInstance);
  115. var summary = BenchmarkRunner.Run<AccessBenchmarks>(DefaultConfig.Instance.WithSummaryStyle(new SummaryStyle(
  116. cultureInfo: null, // use default
  117. printUnitsInHeader: true,
  118. printUnitsInContent: true,
  119. sizeUnit: SizeUnit.B,
  120. timeUnit: TimeUnit.Nanosecond,
  121. printZeroValuesInContent: true,
  122. ratioStyle: RatioStyle.Trend // this will print the ratio column
  123. )));
  124. }
  125. }

在测试代码中,我们使用了BenchmarkDotNet来进行测试,测试的内容包括:

  • UnsafeAccessor:使用UnsafeAccessor特性来访问私有成员
  • Reflection:使用反射访问私有成员
  • Emit:使用Emit+动态方法访问私有成员
  • ExpressionTrees:使用表达式树+委托来访问私有成员
  • Direct:直接访问私有成员

测试结果如下图所示,可以看到使用UnsafeAccessor的性能是最好的,其次是直接访问私有成员,最差的是反射。这其实是出乎我的意料的,因为我认为它最多和直接访问私有成员的性能差不多,但是实际上它的性能比直接访问私有成员还要好,当然也有可能是统计的误差,0.0000ns这个尺度已经非常小了。

深入探究

看到这里我想大家都有很多疑问,实际上作者本人看到这里也是有很多的疑问,主要是这两个:

  • 是什么原因让.NET社区想加入这个API?
  • 它是如何做到访问私有成员的?
  • 为什么性能会这么好?

新增功能的原因

如果要了解这个功能背后的东西,那么我们首先就要找到对应这个API的Issues,按照.NET社区的规范,所有的API都需要提交Issues,然后经过API Review,多轮讨论设计以后,才会开始开发。

首先我们定位到Issue是这一个,在Issue中我们可以了解到这个API主要是为了给System.Text.Json或EF Core这种需要访问私有成员的框架使用,因为目前它们都是基于Emit动态代码生成实现的,但是Emit不能在AOT中使用,现阶段只能使用慢速的反射API,所以迫切引入了一种零开销的私有成员访问机制。

https://github.com/dotnet/runtime/issues/86161

如何做到访问私有成员?

翻阅一下整个API提案Issue的讨论,我们可以找到具体实现的Issue,所以我们要了解它背后的原理的话,就需要跳转到对应的Issue。

在这里可以看到目前还没有做泛型的实现,非泛型的已经在下面链接中实现了,一个是为CoreCLR做的实现,另外一个是为Mono做的实现。

image-20230919223206177

我们目前只关注CoreCLR,点开这个Issue。

https://github.com/dotnet/runtime/issues/86161

image-20230919223551807

可以看到将这个任务拆成了几个部分,他们都在在一个PR中完成的,其中包括定义了UnsafeAccessor特性,在JIT中的实现,以及NativeAOT中进行了支持,另外编写了单元测试加入了有效的诊断方案。

那么来看看这个PR里面做了什么吧。

https://github.com/dotnet/runtime/pull/86932

由于PR非常的长,大家有兴趣可以点进去看看,低于8GB内存的小伙伴就要小心了。简单的来说这次修改主要就是两块地方,一块是JIT相关的修改,JIT这里主要是支持UnsafeAccessorstatic extern int声明函数的用法,需要支持方法的IL Body为空,然后在JIT时根据特性为它插入代码。

首先我们来看JIT的处理,这块代码主要就是修改了jitinterface.cpp,可以看到它调用了TryGenerateUnsafeAccessor方法:

image-20230919225057007

这个TryGenerateUnsafeAccessor方法实现在prestub.cpp中,这个prestub.cpp实现了一些预插桩的操作,TryGenerateUnsafeAccessor方法实现如下所示:

image-20230919225441624

它针对UnsafeAccessorKind的不同枚举做了校验,防止出现运行时崩溃的情况:

image-20230919225638593

然后调用了GenerateAccessor方法来生成IL:

image-20230919225739682

GenerateAccessor里面就是使用Emit进行代码生成:

image-20230919225932113

所以从JIT的实现来看,它其实核心原理就是Emit代码生成,并没有太多特殊的东西。

另外是关于NativeAOT的实现,首先修改了NativeAotILProvider.cs这个类,这个类的主要作用就是在进行NativeAot的时候提供IL给JIT预先编译使用:

image-20230919230445386

关键也是在GenerateAccessor方法里面,在这里生成了对应的IL代码:

image-20230919230733590

总结一下,UnsafeAccessor实现原理还是使用的IL动态生成技术,只不过它是在JIT内部实现的。

为什么性能这么好?

那么它为什么性能要比我们在C#代码中自己写Emit要更好呢?其实原因也是显而易见的,我们自己编写的Emit代码中间有一层DynamicMethod的委托调用,增加了开销,而UnsafeAccessor它直接就是一个static extern int GetValueUnsafe(A a);方法,没有中间开销,而且它IL Body很小,可以被内联。

总结

通过对.NET8中新增的UnsafeAccessor特性的深入探究,我们得到了一些启示和理解。首先,UnsafeAccessor的引入并非无中生有,而是应运而生,它是为了满足System.Text.Json或EF Core这类框架在访问私有成员时的需求,因为它们目前大多基于Emit动态代码生成实现,但在AOT环境中无法使用Emit,只能依赖于效率较低的反射API。因此,UnsafeAccessor的引入,为我们提供了一种零开销的私有成员访问机制。

总的来说,UnsafeAccessor的引入无疑为.NET的发展增添了一抹亮色,它不仅提升了代码的执行效率,也为我们的编程方式提供了新的可能。我们期待在未来的.NET版本中,看到更多这样的创新和突破。

原文链接:https://www.cnblogs.com/InCerry/p/dotnet8-access-private-member-new-method-2.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号