目次

概要

Ver. 7.2

Span<T>構造体(System名前空間)は、span (区間、範囲)という名前通り、連続してデータが並んでいるもの(配列など)の一定範囲を読み書きするために使う型です。

この型によって、ファイルの読み書きや通信などの際の、生データの読み書きがやりやすくなります。 生データの読み書きを直接行うことは少ないでしょうが、通信ライブラリなどを利用することで間接的にSpan<T>構造体のお世話になることはこれから多くなるでしょう。

Span<T>構造体は、 .NET Core 2.1 からは標準で入ります。それ以前のバージョンや、.NET Framework では、System.Memoryパッケージを参照することで利用できます。

C# 7.2の新機能のうちいくつかは、この型を効率的に・安全に使うために入ったものです。 そこで、言語機能に先立って、このSpan<T>構造体自体について説明しておきます。

サンプル コード

連続データの一定範囲の読み書き

「一定範囲の読み書き」の説明に、まずは配列で例を示します。 例えば以下のような書き方で、配列の一部分だけの読み書きができます。

// 長さ 8 で配列作成
// C# の仕様で、全要素 0 で作られる
var array = new int[8];

// 配列の、2番目(0 始まりなので3要素目)から、3要素分の範囲
var span = new Span<int>(array, 2, 3);

// その範囲だけを 1 に上書き
for (int i = 0; i < span.Length; i++)
{
    span[i] = 1;
}

// ちゃんと、2, 3, 4 番目だけが 1 になってる
foreach (var x in array)
{
    Console.WriteLine(x); // 0, 0, 1, 1, 1, 0, 0, 0
}

このコードで、以下のような書き換えが発生します。

配列の一部分だけを読み書きする例

Span<T>構造体を作る部分は、以下のように、拡張メソッドでも書けます。

var span = array.AsSpan().Slice(2, 3);

このAsSpanは、System.SpanExtensionsクラスで定義されている拡張メソッドで、 配列全体を指す Span<T> を作るものです。 また、SliceメソッドはSpan<T>構造体の、さらに一部分だけを抜き出すメソッドです。

ちなみに、読み書き両方可能なSpan<T>に加えて、読み取り専用のReadOnlySpan<T>構造体もあります。

// 読み取り専用版
ReadOnlySpan<int> r = span;
var a = r[0]; // 読み取りは OK
r[0] = 1;     // 書き込みは NG

配列に限って言えば、「配列の一部分を指す型」として、昔からArraySegment<T>構造体(System名前空間)がありました。 しかし、以下のような差があります。

  • Span<T>は、配列だけでなく、いろいろなものを指せる
  • Span<T>の方が効率的で、読み書きがだいぶ速い

いろいろなタイプのメモリ領域を指せる

Span<T>は、配列だけでなく、文字列、スタック上の領域、.NET 管理外のメモリ領域などいろいろな場所を指せます。 以下のような使い方ができます。

using System;
using System.Runtime.InteropServices;

class Program
{
    static void Main()
    {
        // 配列
        Span<int> array = new int[8].AsSpan().Slice(2, 3);

        // 文字列
        ReadOnlySpan<char> str = "abcdefgh".AsReadOnlySpan().Slice(2, 3);

        // スタック領域
        Span<int> stack = stackalloc int[8];

        unsafe
        {
            // .NET 管理外メモリ
            var p = Marshal.AllocHGlobal(sizeof(int) * 8);
            Span<int> unmanaged = new Span<int>((int*)p, 8);

            // 他の言語との相互運用
            var q = malloc((IntPtr)(sizeof(int) * 8));
            Span<int> interop = new Span<int>((int*)q, 8);

            Marshal.FreeHGlobal(p);
            free(q);
        }
    }

    [DllImport("msvcrt.dll", CallingConvention = CallingConvention.Cdecl)]
    static extern IntPtr malloc(IntPtr size);

    [DllImport("msvcrt.dll", CallingConvention = CallingConvention.Cdecl)]
    static extern void free(IntPtr ptr);
}

部分参照

Span<T>は、配列や文字列の一部分を直接参照しています。

例えば、stringSubstringメソッドを使うと、部分文字列をコピーした新しい別のstringが生成されて、ちょっと非効率です。 これに対して、Span<char>Sliceを使えば、コピーなしで部分文字列を参照できます。

例えば以下のようなコードを書いたとします。

var s = "abcあいう亜以宇";

var sub = s.Substring(3, 3);
var span = s.AsReadOnlySpan().Slice(3, 3);

for (int i = 0; i < 3; i++)
{
    Console.WriteLine((sub[i], span[i])); // あ、い、う が2つずつ表示される
}

sub (Substringメソッドを利用)とspan (Sliceメソッドを利用)はいずれも、「3番目から3つ分」の部分文字列を取り出しています。 しかし、以下のように、subではコピーが発生し、spanでは発生しません。

Substring と Span の差

配列とポインターに両対応

Span<T>を使う利点は、配列とポインターの両方に、1つの型で対応できることです。

ネイティブ コードとの相互運用で有用なのはもちろん、 C# だけでプログラムを作るにしてもポインターを使いたいことが稀にあります (主に、パフォーマンスが非常に重要になる場面で)。

例えば以下のようなコードを考えます。 unsafe を使うと速い処理の典型例として、一定範囲を 0 クリアする処理を、ポインターを使って書いています。

// unsafe を使うと速い処理の典型例として、一定範囲を 0 クリアする処理
class Program
{
    // 作る側
    // ライブラリを作る側としては別に unsafe コードがあっても不都合はそこまでない
    static unsafe void Clear(byte* p, int length)
    {
        var last = p + length;
        while (p + 8 < last)
        {
            *(ulong*)p = 0;
            p += 8;
        }
        if (p + 4 < last)
        {
            *(uint*)p = 0;
            p += 4;
        }
        while (p < last)
        {
            *p = 0;
            ++p;
        }
    }

    // 使う側
    static void Main()
    {
        var array = new byte[256];

        // array をいろいろ書き換えた後、全要素 0 にクリアしたいとして

        // ライブラリを使う側に unsafe が必要なのは怖いし面倒
        unsafe
        {
            fixed (byte* p = array)
                Clear(p, array.Length);
        }
    }
}

コード中にも書いていますが、ここで問題になるのは、使う側に unsafe コードを強要する点です。 ライブラリを作る側は作る人の責任で多少危険なコードも書けますが、 どういう人が使うかはコントロールできないので、使う側に unsafe を求めるのはつらいです。 また、見ての通り、unsafefixedなどのブロックで囲う処理は面倒です。

そこで、通常、以下のようにいくつかのオーバーロードを増やすことになります。

// 使う側に unsafe を求めないために要するオーバーロードいろいろ
static void Clear(ArraySegment<byte> segment) => Clear(segment.Array, segment.Offset, segment.Count);
static void Clear(byte[] array, int offset = 0) => Clear(array, offset, array.Length - offset);
static void Clear(byte[] array, int offset, int length)
{
    unsafe
    {
        fixed (byte* p = array)
        {
            Clear(p + offset, length);
        }
    }
}

1セットくらいなら別にまだ平気なんですが、例えばコピー処理(コピー元とコピー先の2セット必要)とか、引数が増えるとかなり大変なことになります。

// Clear は1つしか引数がないのでまだマシ。
// コピー(コピー元とコピー先)とか、2つになるとだいぶ面倒に。

static void Copy(ArraySegment<byte> source, ArraySegment<byte> destination)
    => Copy(source.Array, source.Offset, destination.Array, destination.Offset, source.Count);
static void Copy(byte[] source, int sourceOffset, byte[] destination, int destinationOffset)
    => Copy(source, sourceOffset, destination, destinationOffset, source.Length - sourceOffset);
static void Copy(byte[] source, int sourceOffset, byte[] destination, int destinationOffset, int length)
{
    unsafe
    {
        fixed (byte* s = source)
        fixed (byte* d = destination)
        {
            Copy(s + sourceOffset, d + destinationOffset, length);
        }
    }
}
// 他にも、利便性を求めるなら、
// source, destination の片方だけが ArraySegment のパターンとか
// 片方だけがポインターのパターンとか(組み合わせなのでパターンが多くなる)

static unsafe void Copy(byte* source, byte* destination, int length)
{
    var last = source + length;
    while (source + 8 < last)
    {
        *(ulong*)source = *(ulong*)destination;
        source += 8;
    }
    if (source + 4 < last)
    {
        *(uint*)source = *(uint*)destination;
        source += 4;
    }
    while (source < last)
    {
        *source = *destination;
        ++source;
    }
}

この問題に対して、Span<T>であれば、この構造体1つで配列でもポインターでも、その全体でも一部分でも受け取れるので、 オーバーロードは1つで十分です。

// 作る側
// Span<T> なら配列でもポインターでも、その全体でも一部分でも受け取れる
static void Clear(Span<byte> span)
{
    unsafe
    {
        // 結局内部的には unsafe にしてポインターを使った方が速い場合あり
        fixed (byte* pin = &span.DangerousGetPinnableReference())
        {
            var p = pin;
            var last = p + span.Length;
            while (p + 8 < last)
            {
                *(ulong*)p = 0;
                p += 8;
            }
            if (p + 4 < last)
            {
                *(uint*)p = 0;
                p += 4;
            }
            while (p < last)
            {
                *p = 0;
                ++p;
            }
        }
    }
}

// 使う側
static void Main()
{
    var array = new byte[256];

    // array をいろいろ書き換えた後、全要素 0 にクリアしたいとして

    // 呼ぶのがだいぶ楽
    Clear(array);
}

安全な stackalloc

C# の速度最適化のコツの1つに、「ガベージ コレクションを避ける」というのがあります。 要は、可能であれば、クラスや配列の new を避けろという話になります。 (割かし「言うは易し」で、なかなかnewを避けるのが大変なことはよくありますが。)

例えば、ファイルからデータを読み出しつつ、何か処理をしたいとします。 データは一気に全体を見る必要はなく、一定サイズずつ(仮にここでは128バイトずつ)読んでは捨ててを繰り返せるものとします。 これまでであれば、以下のように、そのサイズ分の配列を new して使うことになります。

const int BufferSize = 128;

using (var f = File.OpenRead("test.data"))
{
    var rest = (int)f.Length;
    var buffer = new byte[BufferSize];

    while (true)
    {
        var read = f.Read(buffer, 0, Math.Min(rest, BufferSize));
        rest -= read;
        if (rest == 0) break;

        // buffer に対して何か処理する
    }
}

こういう場合に、これまでも、unsafe コードを使えば配列の new を避ける手段がありました。 stackallocというものを使って、スタック上に一時領域を確保できます。 (スタックはガベージ コレクションの負担になりません。) ただ、これだけのために unsafe コードを必要とするもの、ちょっとしんどいものがあります。

これに対して、C# 7.2では、Span<T>構造体と併用することで、unsafe なしで stackallocを使えるようになりました。 例えば先ほどのコードは、以下のように書き直せます。 このコードはunsafeなしでコンパイルできます。 (※ 最新の System.IO パッケージの参照が必要です。現状ではプレビュー版のみ。)

const int BufferSize = 128;

using (var f = File.OpenRead("test.data"))
{
    var rest = (int)f.Length;
    // Span<byte> で受け取ることで、new (配列)を stackalloc (スタック確保)に変更できる
    Span<byte> buffer = stackalloc byte[BufferSize];

    while (true)
    {
        // Read(Span<byte>) が追加された
        var read = f.Read(buffer);
        rest -= read;
        if (rest == 0) break;

        // buffer に対して何か処理する
    }
}

ちなみに、スタック上の領域確保は、あんまり大きなサイズにはできません。 一般的には、多くても数キロバイト程度くらいまでしか使いません。 そのため、確保したいバッファーのサイズに応じて、stackallocと配列のnewを切り替えたいと言ったこともあります。 そこでC# 7.2 では、以下のように、条件演算子でstackallocを使うこともできるようになっています。

Span<byte> buffer = bufferSize <= 128 ? stackalloc byte[bufferSize] : new byte[bufferSize];

また、unsafeが不要なことからもわかる通り、Span<T>との併用であればstackallocは安全です。 以下のように、範囲チェックが掛かって、確保した分を越えての読み書きはできないようになっています。

// Span 版 = safe
static void Safe()
{
    Span<byte> span = stackalloc byte[8];

    try
    {
        // 8バイトしか確保していないのに、9要素目に書き込み
        span[8] = 1;
    }
    catch(IndexOutOfRangeException)
    {
        // ちゃんと例外が発生してここに来る
        Console.WriteLine("span[8] はダメ");
    }
}

// ポインター版 = unsafe
static unsafe void Unsafe()
{
    byte* p = stackalloc byte[8];

    try
    {
        // 8バイトしか確保していないのに、9要素目に書き込み
        p[8] = 1;
    }
    catch (Exception)
    {
        // ここには来ない!
        // 結果、不正な場所に 1 が書き込まれてるはず(かなり危険)
        // それも、エラーを拾う手段がないので気づきにくい
        throw;
    }
}

Span の内部的な話

前節ではSpan<T>構造体の用途を見てきましたが、続いて、その中身がどうなっているかについて説明しておきます。

ArraySegment<T>よりもSpan<T>の方が高速な理由でもありますが、 Span<T>の中身は参照になっています。

比較のためにArraySegment<T>の中身から説明しましょう。 ArraySegment<T>は以下のようなメンバーを持った構造体です。

struct ArraySegment<T>
{
    T[] Array;
    int Offest;
    int Count;
}

ArraySegmentの中身

一方で、Span<T>構造体は、論理的には以下のようなメンバーを持った構造体です。 (「論理的には」と断っているのは、これをそのまま書くことはできないため。)

struct Span<T>
{
    ref T Reference;
    int Length;
}

Spanの中身

要するに、以下のような点が Span<T> の特徴になります。 (この他、Span<T>は .NET ランタイムが特別扱いしていくつか特殊な最適化を掛けてくれるため高速になります。)

  • 必要な範囲の先頭を直接参照しているので、+ Offset分の計算が省ける
  • ArrayOffsetと分けて持つ必要がないので、1メンバー分省サイズ
  • 配列に限らずどこでも(ポインターでも)参照できる

slow Span と fast Span

先ほど、Span<T>の中身には「論理的には」ref Tなフィールドがあるという話をしました。 ただ、 .NET の型システム上、フィールドに ref を付けることはできません。 実のところ、Span<T>はこういう「参照フィールド」を実現するためにちょっと特殊なことをしています。

fast Span (.NET Core 2.0 以降向けの Span)

.NET Core 2.0 では、ランタイム側で特殊処理を入れて、「参照フィールド」に相当する機能を使えるようにしました。 .NET Core 2.0 以降向けの Span<T> は以下のような構造になっています。 (coreclr レポジトリ内にソースコードがあります。)

struct Span<T>
{
    ByReferenct<T> _pointer;
    int _length;
}

ByReference<T> が特殊対応部分です。 ランタイム側で「この型は参照フィールドとして扱う」という特別扱いをすることで、所望の動作を得ています。

slow Span (旧来のランタイム向けの Span)

「.NET Core 2.0以降でしか使えません」ということになると使い勝手が悪すぎるため、 旧来のランタイム向けの「ちょっと遅い」Span<T>実装もあります。 (こちらはcorefx リポジトリ内にソースコードがあります。)

こちらは、概ね以下のような構造です。

struct Span<T>
{
    Pinnable<T> _pinnable;
    IntPtr _byteOffset;
    int _length;
}

Pinnable<T>はただのクラスです。 ガベージ コレクション管理下の参照と、管理外の参照を同列に扱えないからこういう構造になっています。 管理メモリ(配列)は _pinnable (ただのクラス)で扱い、管理外メモリ(相互運用で得たポインターやstackallocで確保したメモリ)は _byteOffset に直接ポインター値を入れて扱います。

結果的に、管理/管理外で条件分岐が必要だったり、構造体のサイズが大きくなるせいで、少し動作が遅くなります。 ただし、それでも、ArraySegment<T>を使うよりはだいぶ高速です。

参照フィールド

要するに、Span<T>構造体は、論理的には「参照フィールドと、長さのペア」です。 実際、「fast Span」な実装では、参照フィールドに相当するものを、ランタイム側の特殊対応で実現しています。

となると、Span<T>の取り扱いには少し注意が必要になります。 「参照戻り値と参照ローカル変数」で説明していますが、 参照渡しでは、参照先が必ず有効であることを保証するために、いくつかの制限を掛けています。 それと同じ制限がSpan<T>型の引数・変数・戻り値にも掛からなければいけません。

正確な条件などについては次節の「ref 構造体」で説明します(近々書く予定)。

更新履歴

ブログ