4

我一直在尝试Span<T>作为ReadOnlySequence<T>System.IO.Pipelines 的一部分。

我目前正在尝试在不使用代码且不制作副本的情况下获得 a Span<T>over a 。structunsafestruct

我的结构很简单：

    [StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
    public struct Packet
    {
        public byte TestByte;
    }

方法 1 - 有效 - 但感觉“不安全”

    //
    // Method 1 - uses Unsafe to get a span over the struct
    //
    var packet = new Packet();
    unsafe
    {
        var packetSpan = new Span<byte>(&packet, Marshal.SizeOf(packet));

        packetSpan[0] = 0xFF; // Set the test byte
        Debug.Assert(packet.TestByte == 0xFF, "Error, packetSpan did not update packet.");
            // ^^^ Succeeds
        packet.TestByte = 0xEE;
        Debug.Assert(packetSpan[0] == 0xEE, "Error, packet did not update packetSpan.");
            // ^^^ Succeeds
    }

方法 2 - 它不能按预期工作，因为它需要一个副本

    //
    // Method 2
    //
    // This doesn't work as intended because the original packet is actually
    // coppied to packet2Array because it's a value type
    //
    // Coppies the packet to an Array of Packets
    // Gets a Span<Packet> of the Array of Packets
    // Casts the Span<Packet> as a Span<byte>
    //
    var packet2 = new Packet();

    // create an array and store a copy of packet2 in it
    Packet[] packet2Array = new Packet[1];
    packet2Array[0] = packet2;

    // Get a Span<Packet> of the packet2Array
    Span<Packet> packet2SpanPacket = MemoryExtensions.AsSpan<Packet>(packet2Array);

    // Cast the Span<Packet> as a Span<byte>
    Span<byte> packet2Span = MemoryMarshal.Cast<Packet, byte>(packet2SpanPacket);

    packet2Span[0] = 0xFF; // Set the test byte
    Debug.Assert(packet2.TestByte == 0xFF, "Error, packet2Span did not update packet2");
        // ^^^ fails because packet2 was coppied into the array, and thus packet2 has not changed.
    Debug.Assert(packet2Array[0].TestByte == 0xFF, "Error, packet2Span did not update packet2Array[i]");
        // ^^^ succeeds

    packet2.TestByte = 0xEE;
    Debug.Assert(packet2Span[0] == 0xEE, "Error, packet2 did not update in packet2Span");
        // ^^^ fails because packet2Span is covering packet2Array which has a copy of packet2 
    packet2Array[0].TestByte = 0xEE;
    Debug.Assert(packet2Span[0] == 0xEE, "Error, packet2 did not update in packet2Span");
        // ^^^ succeeds

进一步的研究表明，

Span<T>可以从 a 隐式转换byte[]，例如，我可以这样做

Span<byte> packetSpan = new Packet().ToByteArray();

但是我拥有的任何当前 ToByteArray() 实现仍在制作 Packet 结构的副本。

我不能做一些类似的事情：

Span<byte> packetSpan = (byte[])packet;
    // ^^ Won't compile
4

2 回答 2

5

你必须在不安全的环境中这样做，因为从这个词的真正含义来看它是不安全的，因为如果你不够小心，你会在脚下开枪。原因如下：

考虑以下代码：

Span<byte> GiveMeSpan() 
{
    MyLovelyStruct value = new MyLovelyStruct();
    unsafe 
    {
        return new Span<byte>(&value, sizeof(MyLovelyStruct));
    }
}

MyLovelyStruct我们在其中创建的实例GiveMeSpan()存在于方法的调用堆栈中，您所做的是获取其地址，将其提供给.Span<byte>并返回Span<byte>. 一旦一个方法返回，它就会弹出它的堆栈帧，因此你MyLovelyStruct所居住的内存将变得空闲，并且可能被调用者调用的下一个方法回收并破坏它。

但这还不是全部，如果您MyLovelyStruct生活在这样的对象字段中怎么办：

class MyLovelyClass 
{
    private MyLovelyStruct value;

    public void Foo() 
    {
        unsafe 
        {
            var span = new Span(&value, sizeof(MyLovelyStruct));
            Process(span);
        }
    }
}

// Declaration 
Process(Span<byte> span);

当方法正在处理您并突然在内存中移动时会发生GC（是的，GC 移动内存中的对象，请在此处阅读）？是的，您的which 指向的将不再指向新地址，并且您的程序会损坏。Process()MyLovelyStructMyLovelyClassSpan<byte>MyLovelyStructMyLovelyStruct

因此，为了安全地包装structusingSpan<byte>或任何其他指针类型，您必须确保：

  • 该实例位于固定的内存位置（例如在堆栈或非托管内存中，例如Marshal.AllocHGlobal分配的内存块）
  • 在您完成指针操作之前，不会占用实例内存

所以unsafe关键字是必需的，即使你可以绕过它，你也可以向你的代码的读者发出警告。

于 2020-01-05T09:39:45.627 回答
3

如果没有 ，就无法获取Span<byte>任意结构unsafe，因为这样的跨度将允许您以任何方式更改结构的任何位，可能违反类型的不变量 - 这本质上是不安全的操作。

好的，但是呢ReadOnlySpan<byte>？请注意，您必须将StructLayoutAttributestruct 放在您的结构上才能使您的代码明智。这应该是一个提示。想象一下，尝试编写一个更简单的方法，一个byte[]为任意的返回 a 的方法T where T : struct。你必须找出第一个的大小struct，不是吗？那么，如何struct在 C# 中找出 a 的大小？您可以使用sizeof运算符，它需要unsafe上下文并且需要结构是非托管类型；或者你可以Marshall.SizeOf，这很不稳定，只适用于具有顺序或显式字节布局的结构。没有安全、通用的方法，因此您不能这样做。

Span<T>and的ReadOnlySpan<T>设计并没有考虑到访问结构字节，而是跨越数组的片段，这些片段具有已知的大小并保证是连续的。

如果您确信自己知道自己在做什么，那么您可以在unsafe上下文中做到这一点——这就是它的目的。但请注意，unsafe由于上述原因，您的解决方案不能推广到任意结构。

如果您打算将您的结构用作 IO 操作的缓冲区，您可能需要查看固定大小的缓冲区。它们还需要unsafe上下文，但您可以将不安全性封装在结构中并将 a 返回Span<byte>到该固定缓冲区。基本上任何处理内存中对象的字节结构的东西都需要unsafe在 .NET 中，因为内存管理就是这个“安全”所指的东西。

于 2020-01-05T02:33:53.553 回答