C# JIT 优化器中可能存在的错误

本文关键字:存在 错误 JIT 优化 | 更新日期: 2023-09-27 17:56:19

在 SQLHelper 类上以类似于在 XmlRpc.Net 库中执行的操作来自动化存储过程调用,在运行从 IL 代码手动生成的方法时,我遇到了一个非常奇怪的问题。

我已将其缩小到一个简单的生成方法(可能可以进一步简化)。我创建了一个新的程序集和类型,其中包含两种符合的方法

public interface iTestDecimal
{
    void TestOk(ref decimal value);
    void TestWrong(ref decimal value);
}

测试方法只是将十进制参数加载到堆栈中,对其进行装箱,检查它是否为 NULL,如果不是,则将其取消装箱。

TestOk() 方法的生成如下:

static void BuildMethodOk(TypeBuilder tb)
{
    /* Create a method builder */
    MethodBuilder mthdBldr = tb.DefineMethod( "TestOk", MethodAttributes.Public | MethodAttributes.Virtual,
      typeof(void), new Type[] {typeof(decimal).MakeByRefType() });
    ParameterBuilder paramBldr = mthdBldr.DefineParameter(1,  ParameterAttributes.In | ParameterAttributes.Out, "value");
    // generate IL
    ILGenerator ilgen = mthdBldr.GetILGenerator();
    /* Load argument to stack, and box the decimal value */
    ilgen.Emit(OpCodes.Ldarg, 1);
    ilgen.Emit(OpCodes.Dup);
    ilgen.Emit(OpCodes.Ldobj, typeof(decimal));
    ilgen.Emit(OpCodes.Box, typeof(decimal));
    /* Some things were done in here, invoking other method, etc */
    /* At the top of the stack we should have a boxed T or null */
    /* Copy reference values out */
    /* Skip unboxing if value in the stack is null */
    Label valIsNotNull = ilgen.DefineLabel();
    ilgen.Emit(OpCodes.Dup);
    /* This block works */
    ilgen.Emit(OpCodes.Brtrue, valIsNotNull);
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Ret);
    /* End block */
    ilgen.MarkLabel(valIsNotNull);
    ilgen.Emit(OpCodes.Unbox_Any, typeof(decimal));
    /* Just clean the stack */
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Ret);
}

TestWrong() 的构建几乎相同:

static void BuildMethodWrong(TypeBuilder tb)
{
    /* Create a method builder */
    MethodBuilder mthdBldr = tb.DefineMethod("TestWrong", MethodAttributes.Public | MethodAttributes.Virtual,
    typeof(void), new Type[] { typeof(decimal).MakeByRefType() });
    ParameterBuilder paramBldr = mthdBldr.DefineParameter(1,  ParameterAttributes.In | ParameterAttributes.Out, "value");
    // generate IL
    ILGenerator ilgen = mthdBldr.GetILGenerator();
    /* Load argument to stack, and box the decimal value */
    ilgen.Emit(OpCodes.Ldarg, 1);
    ilgen.Emit(OpCodes.Dup);
    ilgen.Emit(OpCodes.Ldobj, typeof(decimal));
    ilgen.Emit(OpCodes.Box, typeof(decimal));
    /* Some things were done in here, invoking other method, etc */
    /* At the top of the stack we should have a boxed decimal or null */
    /* Copy reference values out */
    /* Skip unboxing if value in the stack is null */
    Label valIsNull = ilgen.DefineLabel();
    ilgen.Emit(OpCodes.Dup);
    /* This block fails */
    ilgen.Emit(OpCodes.Brfalse, valIsNull);
    /* End block */
    ilgen.Emit(OpCodes.Unbox_Any, typeof(decimal));
    ilgen.MarkLabel(valIsNull);
    /* Just clean the stack */
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Pop);
    ilgen.Emit(OpCodes.Ret);
}

唯一的区别是我使用 BrFalse 而不是 BrTrue 来检查堆栈中的值是否为空。

现在,运行以下代码:

iTestDecimal testiface = (iTestDecimal)SimpleCodeGen.Create();
decimal dectest = 1;
testiface.TestOk(ref dectest);
Console.WriteLine(" Dectest: " + dectest.ToString());

SimpleCodeGen.Create() 正在创建一个新的程序集和类型,并调用上面的 BuildMethodXX 来生成 TestOk 和 TestWrong 的代码。这按预期工作:不执行任何操作,最差的值不会更改。但是,运行:

iTestDecimal testiface = (iTestDecimal)SimpleCodeGen.Create();
decimal dectest = 1;
testiface.TestWrong(ref dectest);
Console.WriteLine(" Dectest: " + dectest.ToString());

Dectest的值已损坏(有时它得到一个大值,有时它说"无效的十进制值",...),并且程序崩溃。

这可能是 JIT 中的错误,还是我做错了什么?

一些提示:

  • 在调试器中,仅当禁用"禁止 JIT 优化"时才会发生这种情况。如果启用了"禁止 JIT 优化",它将起作用。这让我认为问题一定出在 JIT 优化代码中。
  • 在 Mono 2.4.6 上运行相同的测试,它按预期工作,因此这是特定于 Microsoft .NET 的功能。
  • 使用日期时间或十进制类型时出现问题。显然,它适用于 int 或引用类型(对于引用类型,生成的代码并不相同,但我省略了这种情况,因为它有效)。
  • 我认为很久以前报道的这个链接可能是相关的。
  • 我尝试过.NET Framework v2.0,v3.0,v3.5和v4,行为完全相同。

我省略了其余代码,创建了程序集和类型。如果你想要完整的代码,就问我。

非常感谢!

编辑:我包括程序集和类型创建代码的其余部分,以完成:

class SimpleCodeGen
{
    public static object Create()
    {
        Type proxyType;
        Guid guid = Guid.NewGuid();
        string assemblyName = "TestType" + guid.ToString();
        string moduleName = "TestType" + guid.ToString() + ".dll";
        string typeName = "TestType" + guid.ToString();
        /* Build the new type */
        AssemblyBuilder assBldr = BuildAssembly(typeof(iTestDecimal), assemblyName, moduleName, typeName);
        proxyType = assBldr.GetType(typeName);
        /* Create an instance */
        return Activator.CreateInstance(proxyType);
    }
    static AssemblyBuilder BuildAssembly(Type itf, string assemblyName, string moduleName, string typeName)
    {
        /* Create a new type */
        AssemblyName assName = new AssemblyName();
        assName.Name = assemblyName;
        assName.Version = itf.Assembly.GetName().Version;
        AssemblyBuilder assBldr = AppDomain.CurrentDomain.DefineDynamicAssembly(assName, AssemblyBuilderAccess.RunAndSave);
        ModuleBuilder modBldr = assBldr.DefineDynamicModule(assName.Name, moduleName);
        TypeBuilder typeBldr = modBldr.DefineType(typeName,
          TypeAttributes.Class | TypeAttributes.Sealed | TypeAttributes.Public, 
          typeof(object), new Type[] { itf });
        BuildConstructor(typeBldr, typeof(object));
        BuildMethodOk(typeBldr);
        BuildMethodWrong(typeBldr);
        typeBldr.CreateType();
        return assBldr;
    }
    private static void BuildConstructor(TypeBuilder typeBldr, Type baseType)
    {
        ConstructorBuilder ctorBldr = typeBldr.DefineConstructor(
          MethodAttributes.Public | MethodAttributes.SpecialName |
          MethodAttributes.RTSpecialName | MethodAttributes.HideBySig,
          CallingConventions.Standard,
          Type.EmptyTypes);
        ILGenerator ilgen = ctorBldr.GetILGenerator();
        //  Call the base constructor.
        ilgen.Emit(OpCodes.Ldarg_0);
        ConstructorInfo ctorInfo = baseType.GetConstructor(System.Type.EmptyTypes);
        ilgen.Emit(OpCodes.Call, ctorInfo);
        ilgen.Emit(OpCodes.Ret);
    }
    static void BuildMethodOk(TypeBuilder tb)
    {
        /* Code included in examples above */
    }
    static void BuildMethodWrong(TypeBuilder tb)
    {
        /* Code included in examples above */           
    }
}

C# JIT 优化器中可能存在的错误

看看你的代码的这一部分:

ilgen.Emit(OpCodes.Dup);
ilgen.Emit(OpCodes.Brfalse, valIsNull);
ilgen.Emit(OpCodes.Unbox_Any, typeof(decimal));
ilgen.MarkLabel(valIsNull);

在第一行之后,堆栈的顶部将包含两个对象引用。 然后,有条件地分支,删除其中一个引用。 下一行取消对decimal值的引用。 因此,在标记标签的位置,堆栈的顶部要么是对象引用(如果分支被采用),要么是十进制值(如果不是)。 这些堆栈状态不兼容。

编辑

正如您在注释中指出的那样,如果堆栈状态顶部有一个小数,或者顶部有一个对象引用,则遵循此代码的 IL 代码将起作用,因为它只是以任何一种方式从堆栈中弹出值。 但是,您尝试执行的操作仍然不起作用(根据设计):每条指令都需要有一个堆栈状态。 有关更多详细信息,请参阅 ECMA CLI 规范的第 1.8.1.3 节(合并堆栈状态)。