使用内在函数时如何避免“out”参数错误？

Question

我正在尝试添加到 .NET Core 3.0 中的新硬件内在函数，特别是为了加速矩阵运算。对于矩阵加法，我有一个函数，它采用两个 4x4 float 矩阵作为 in 参数，以及第三个 out 矩阵来存储结果。它使用 SSE 128 位向量内在函数来添加和存储结果输出：

public unsafe static void Add(in Matrix l, in Matrix r, out Matrix o)
{
    fixed (float* lp = &l.m00, rp = &r.m00, op = &o.m00)
    {
        var c1 = Sse.Add(Sse.LoadVector128(lp + 0),  Sse.LoadVector128(rp + 0));
        var c2 = Sse.Add(Sse.LoadVector128(lp + 4),  Sse.LoadVector128(rp + 4));
        var c3 = Sse.Add(Sse.LoadVector128(lp + 8),  Sse.LoadVector128(rp + 8));
        var c4 = Sse.Add(Sse.LoadVector128(lp + 12), Sse.LoadVector128(rp + 12));
        Sse.Store(op + 0,  c1);
        Sse.Store(op + 4,  c2);
        Sse.Store(op + 8,  c3);
        Sse.Store(op + 12, c4);
    }
}

现在显然 C# 编译器对此存在问题，因为它无法判断输出矩阵是否已写入，因此它会生成函数无法返回的错误，直到分配了 o 变量。 我的问题是是否有任何解决方法，而不必在执行内部操作之前求助于分配给变量，例如 o = default; 作为函数的第一行。

我最初是这样考虑的：

var op = stackalloc float[16];
fixed (float* lp = &l.m00, rp = &r.m00)
{
...
}
o = *(Matrix*)op;

但意识到这并不能避免复制结构，这消除了将矩阵作为out 传递的整个要点。

我意识到如果我将输出矩阵作为ref 传递，或者如果我只是从函数返回一个矩阵实例，这将起作用，但保留有用的内联语法 (Matrix.Add(l, r, out Matrix o)) 和通过引用传递大值类型可以提高性能。

Answer 1

我在这里假设您使用的是Matrix 类型，即struct。显然，如果它是引用类型，那么您的方法实际上必须先初始化参数值才能使用它，因此您的代码并没有向我表明它是值类型。

不能使 C# 编译器忽略编译时错误。在方法返回之前未初始化out 参数是编译时错误。所以你被卡住了。

也就是说，我认为这不应该是一个重大的困难。你可以这样写你的方法：

public unsafe static void Add(in Matrix l, in Matrix r, out Matrix o)
{
    o = default(Matrix);

    fixed (float* lp = &l.m00, rp = &r.m00, op = &o.m00)
    {
        var c1 = Sse.Add(Sse.LoadVector128(lp + 0),  Sse.LoadVector128(rp + 0));
        var c2 = Sse.Add(Sse.LoadVector128(lp + 4),  Sse.LoadVector128(rp + 4));
        var c3 = Sse.Add(Sse.LoadVector128(lp + 8),  Sse.LoadVector128(rp + 8));
        var c4 = Sse.Add(Sse.LoadVector128(lp + 12), Sse.LoadVector128(rp + 12));
        Sse.Store(op + 0,  c1);
        Sse.Store(op + 4,  c2);
        Sse.Store(op + 8,  c3);
        Sse.Store(op + 12, c4);
    }
}

这将编译成类似这样的内容（为了示例，我选择了一个任意的 Matrix 类型……显然不是您使用的类型，但基本前提是相同的）：

IL_0000:  ldarg.0
IL_0001:  initobj    System.Windows.Media.Matrix

这又会简单地initialize the block of memory to 0 values:

initobj 指令将由推送地址（类型为native int、& 或*）指定的值类型的每个字段初始化为空引用或相应原始类型的0。调用此方法后，实例已准备好调用构造方法。如果typeTok 是引用类型，则该指令与ldnull 后跟stind.ref 的效果相同。

与Newobj 不同，initobj 不调用构造函数方法。 Initobj 用于初始化值类型，而newobj 用于分配和初始化对象。

换句话说，initobj，也就是你在使用default(Matrix) 时得到的，是一个非常简单的初始化，只是将内存位置清零。它应该足够快，并且在任何情况下显然都比分配一个全新的对象副本然后将结果复制回原始变量（无论是在本地完成还是通过返回值完成）要少。

话虽如此，这在很大程度上取决于您将如何调用该方法的上下文。虽然您说您希望保留内联声明的便利性，但我不清楚为什么您希望对于一个显然对性能至关重要的方法可以使用 SSE 功能和不安全的代码。使用内联声明，您必须在每次调用时重新初始化变量。

如果这个方法实际上是以性能关键的方式被调用的，那么对我来说这意味着它在一个循环中被调用了很多次，可能是数百万次或更多。在这种情况下，您可能更喜欢 ref 选项，您可以在循环外初始化变量，然后为每次调用重复使用该变量，而不是为每次调用重新声明一个新变量。