Структуру System.Span<T>

Статья
01/08/2024

В этой статье приводятся дополнительные замечания к справочной документации по этому API.

Тип Span<T> — это структура ссылок, выделенная в стеке, а не в управляемой куче. Типы структур ссылок имеют ряд ограничений, чтобы гарантировать, что они не могут быть повышены до управляемой кучи, в том числе, что они не могут быть прямоугольны, они не могут быть назначены переменным типа Objectdynamic или любому типу интерфейса, они не могут быть полями в эталонном типе, и они не могут использоваться между await и yield границами. Кроме того, вызовы двух методов Equals(Object) и GetHashCodeисключение NotSupportedException.

Важно!

Так как это тип только для стека, подходит для многих сценариев, Span<T> требующих хранения ссылок на буферы в куче. Это верно, например, подпрограмм, которые вызывают асинхронные вызовы методов. Для таких сценариев можно использовать дополнительные System.Memory<T> и System.ReadOnlyMemory<T> типы.

Для диапазонов, представляющих неизменяемые или доступные только для чтения структуры, используйте System.ReadOnlySpan<T>.

Память

Представляет Span<T> собой смежный регион произвольной памяти. Экземпляр Span<T> часто используется для хранения элементов массива или части массива. В отличие от массива, Span<T> экземпляр может указывать на управляемую память, собственную память или память, управляемую в стеке. В следующем примере создается Span<Byte> массив:

// Create a span over an array.
var array = new byte[100];
var arraySpan = new Span<byte>(array);

byte data = 0;
for (int ctr = 0; ctr < arraySpan.Length; ctr++)
    arraySpan[ctr] = data++;

int arraySum = 0;
foreach (var value in array)
    arraySum += value;

Console.WriteLine($"The sum is {arraySum}");
// Output:  The sum is 4950

// Create a span over an array.
let array = Array.zeroCreate<byte> 100
let arraySpan = Span<byte> array

let mutable data = 0uy
for i = 0 to arraySpan.Length - 1 do
    arraySpan[i] <- data
    data <- data + 1uy

let mutable arraySum = 0
for value in array do
    arraySum <- arraySum + int value

printfn $"The sum is {arraySum}"
// Output:  The sum is 4950

В следующем примере создается Span<Byte> из 100 байт собственной памяти:

// Create a span from native memory.
var native = Marshal.AllocHGlobal(100);
Span<byte> nativeSpan;
unsafe
{
    nativeSpan = new Span<byte>(native.ToPointer(), 100);
}
byte data = 0;
for (int ctr = 0; ctr < nativeSpan.Length; ctr++)
    nativeSpan[ctr] = data++;

int nativeSum = 0;
foreach (var value in nativeSpan)
    nativeSum += value;

Console.WriteLine($"The sum is {nativeSum}");
Marshal.FreeHGlobal(native);
// Output:  The sum is 4950

// Create a span from native memory.
let native = Marshal.AllocHGlobal 100
let nativeSpan = Span<byte>(native.ToPointer(), 100)

let mutable data = 0uy
for i = 0 to nativeSpan.Length - 1 do
    nativeSpan[i] <- data
    data <- data + 1uy

let mutable nativeSum = 0
for value in nativeSpan do
    nativeSum <- nativeSum + int value

printfn $"The sum is {nativeSum}"
Marshal.FreeHGlobal native
// Output:  The sum is 4950

В следующем примере используется ключевое слово стека C#, чтобы выделить 100 байт памяти в стеке:

// Create a span on the stack.
byte data = 0;
Span<byte> stackSpan = stackalloc byte[100];
for (int ctr = 0; ctr < stackSpan.Length; ctr++)
    stackSpan[ctr] = data++;

int stackSum = 0;
foreach (var value in stackSpan)
    stackSum += value;

Console.WriteLine($"The sum is {stackSum}");
// Output:  The sum is 4950

    // Create a span on the stack.
    let mutable data = 0uy
    let stackSpan = 
        let p = NativeInterop.NativePtr.stackalloc<byte> 100 |> NativeInterop.NativePtr.toVoidPtr
        Span<byte>(p, 100)

    for i = 0 to stackSpan.Length - 1 do
        stackSpan[i] <- data
        data <- data + 1uy

    let mutable stackSum = 0
    for value in stackSpan do
        stackSum <- stackSum + int value

    printfn $"The sum is {stackSum}"
// Output:  The sum is 4950

Поскольку Span<T> это абстракция по произвольному блоку памяти, методы Span<T> типа и методов с Span<T> параметрами работают над любым Span<T> объектом независимо от типа памяти, который он инкапсулирует. Например, каждый из отдельных разделов кода, который инициализирует диапазон и вычисляет сумму его элементов, можно изменить в один метод инициализации и вычисления, как показано в следующем примере:

public static void WorkWithSpans()
{
    // Create a span over an array.
    var array = new byte[100];
    var arraySpan = new Span<byte>(array);

    InitializeSpan(arraySpan);
    Console.WriteLine($"The sum is {ComputeSum(arraySpan):N0}");

    // Create an array from native memory.
    var native = Marshal.AllocHGlobal(100);
    Span<byte> nativeSpan;
    unsafe
    {
        nativeSpan = new Span<byte>(native.ToPointer(), 100);
    }

    InitializeSpan(nativeSpan);
    Console.WriteLine($"The sum is {ComputeSum(nativeSpan):N0}");

    Marshal.FreeHGlobal(native);

    // Create a span on the stack.
    Span<byte> stackSpan = stackalloc byte[100];

    InitializeSpan(stackSpan);
    Console.WriteLine($"The sum is {ComputeSum(stackSpan):N0}");
}

public static void InitializeSpan(Span<byte> span)
{
    byte value = 0;
    for (int ctr = 0; ctr < span.Length; ctr++)
        span[ctr] = value++;
}

public static int ComputeSum(Span<byte> span)
{
    int sum = 0;
    foreach (var value in span)
        sum += value;

    return sum;
}
// The example displays the following output:
//    The sum is 4,950
//    The sum is 4,950
//    The sum is 4,950

open System
open System.Runtime.InteropServices
open FSharp.NativeInterop

// Package FSharp.NativeInterop.NativePtr.stackalloc for reuse.
let inline stackalloc<'a when 'a: unmanaged> length : Span<'a> =
    let voidPointer = NativePtr.stackalloc<'a> length |> NativePtr.toVoidPtr
    Span<'a>(voidPointer, length)

let initializeSpan (span: Span<byte>) =
    let mutable value = 0uy
    for i = 0 to span.Length - 1 do
        span[i] <- value
        value <- value + 1uy

let computeSum (span: Span<byte>) =
    let mutable sum = 0
    for value in span do
        sum <- sum + int value
    sum

let workWithSpans () =
    // Create a span over an array.
    let array = Array.zeroCreate<byte> 100
    let arraySpan = Span<byte> array

    initializeSpan arraySpan
    printfn $"The sum is {computeSum arraySpan:N0}"

    // Create an array from native memory.
    let native = Marshal.AllocHGlobal 100
    let nativeSpan = Span<byte>(native.ToPointer(), 100)

    initializeSpan nativeSpan
    printfn $"The sum is {computeSum nativeSpan:N0}"

    Marshal.FreeHGlobal native

    // Create a span on the stack.
    let stackSpan = stackalloc 100

    initializeSpan stackSpan
    printfn $"The sum is {computeSum stackSpan:N0}"

// The example displays the following output:
//    The sum is 4,950
//    The sum is 4,950
//    The sum is 4,950

Массивы

При оболочке массива может упаковать весь массив, Span<T> как это было в примерах в разделе "Память ". Так как он поддерживает срез, Span<T> также может указывать на любой смежный диапазон в массиве.

В следующем примере создается срез среднего пяти элементов целочисленного массива 10 элементов. Обратите внимание, что код удвоит значения каждого целого числа в срезе. Как показано в выходных данных, изменения, внесенные диапазоном, отражаются в значениях массива.

using System;

var array = new int[] { 2, 4, 6, 8, 10, 12, 14, 16, 18, 20 };
var slice = new Span<int>(array, 2, 5);
for (int ctr = 0; ctr < slice.Length; ctr++)
    slice[ctr] *= 2;

// Examine the original array values.
foreach (var value in array)
    Console.Write($"{value}  ");
Console.WriteLine();

// The example displays the following output:
//      2  4  12  16  20  24  28  16  18  20

module Program

open System

[<EntryPoint>]
let main _ =
    let array = [| 2; 4; 6; 8; 10; 12; 14; 16; 18; 20 |]
    let slice = Span<int>(array, 2, 5)
    for i = 0 to slice.Length - 1 do
        slice[i] <- slice[i] * 2

    // Examine the original array values.
    for value in array do
        printf $"{value}  "
    printfn ""
    0
// The example displays the following output:
//      2  4  12  16  20  24  28  16  18  20

Срезы

Span<T> включает две перегрузки Slice метода, которые образуют срез из текущего диапазона, который начинается с указанного индекса. Это позволяет обрабатывать данные в Span<T> виде набора логических блоков, которые могут обрабатываться по мере необходимости частями конвейера обработки данных с минимальным воздействием на производительность. Например, так как современные протоколы сервера часто основаны на тексте, управление строками и подстроками особенно важно. В классе основным методом String извлечения подстроек является Substring. Для конвейеров данных, использующих обширную обработку строк, его использование предлагает некоторые штрафы производительности, так как он:

Создает новую строку для хранения подстроки.
Копирует подмножество символов из исходной строки в новую строку.

Эту операцию выделения и копирования можно устранить с помощью одного или Span<T>ReadOnlySpan<T>, как показано в следующем примере:

using System;

class Program2
{
    static void Run()
    {
        string contentLength = "Content-Length: 132";
        var length = GetContentLength(contentLength.ToCharArray());
        Console.WriteLine($"Content length: {length}");
    }

    private static int GetContentLength(ReadOnlySpan<char> span)
    {
        var slice = span.Slice(16);
        return int.Parse(slice);
    }
}
// Output:
//      Content length: 132

module Program2

open System

let getContentLength (span: ReadOnlySpan<char>) =
    let slice = span.Slice 16
    Int32.Parse slice

let contentLength = "Content-Length: 132"
let length = getContentLength (contentLength.ToCharArray())
printfn $"Content length: {length}"
// Output:
//      Content length: 132

Поделиться через

Структуру System.Span<T>

Память

Массивы

Срезы

Дополнительные ресурсы