クラウドMacで検証するSwiftのコピーオンライトと値セマンティクス

クラウドMacで検証するSwiftのコピーオンライトと値セマンティクス

クラウドMacで検証するSwiftのコピーオンライトと値セマンティクス

Windowsでデータ層を修正し、クラウドMacにプロジェクトを渡してテストを実行したところ、元のリストを直接変更していないのに、取り消し用のスナップショットまで変わってしまう。調べてみると、外側はSwiftの構造体でも、内部にはクラスのインスタンスが入っていました。代入でコピーされるのは構造体の各フィールドであり、オブジェクトグラフ全体ではありません。ここでは、単独のファイルでコピーオンライトを実装し、期待どおりに動くかを検証します。UI、ネットワーク、署名設定には依存しません。

まず、保証すべき値セマンティクスを定義する

この記事で扱うコンテナは、整数だけを格納します。保証するのは、コピー後にどのコピーで添字による書き込みや要素の追加を行っても、ほかのコピーの内容は変わらないことです。同じコピーを続けて変更した場合も、それ以前に保存したスナップショットには影響してはいけません。

これは、代入のたびに全データを即座にコピーするという意味ではありません。読み取り中はストレージを共有していても、書き込み前に必要な分離が行われれば問題ありません。テストでは、外部から観測できる結果を確認します。オブジェクトのアドレス、参照カウント、ある実行時のメモリ確保回数を、固定の正解として扱うべきではありません。

コピーオンライトは実装上の戦略であり、変更の影響をほかのコピーから隔離することが外部に対する契約です。テストの成功は、テスト対象の振る舞いが成り立つことを示しますが、エイリアスに関するあらゆる問題が存在しないことの証明にはなりません。

単なる整数のリストが必要なら、標準の配列をそのまま使うほうが適切です。独自のストレージ層を実装する価値があるのは、コンテナが追加のインデックス、統計情報、圧縮状態なども管理する場合です。その場合は、変更可能なすべての操作に必要なチェックを入れます。

変更前にストレージを分離する

リモートのmacOS環境のコマンドラインで CowCheck.swift を新規作成し、次の実装を保存します。まずは要素を整数に限定し、要素自体の参照セマンティクスが問題に混ざらないようにします。

struct IntBuffer {
    private final class Storage {
        var values: [Int]

        init(_ values: [Int]) {
            self.values = values
        }
    }

    private var storage: Storage

    init(_ values: [Int]) {
        storage = Storage(values)
    }

    var snapshot: [Int] {
        storage.values
    }

    private mutating func detachIfNeeded() {
        if !isKnownUniquelyReferenced(&storage) {
            storage = Storage(storage.values)
        }
    }

    subscript(index: Int) -> Int {
        get {
            storage.values[index]
        }
        set {
            detachIfNeeded()
            storage.values[index] = newValue
        }
    }

    mutating func append(_ value: Int) {
        detachIfNeeded()
        storage.values.append(value)
    }
}

重要なのは、共有状態を確認してから変更するという順序です。初期化時だけコピーしたり、変更後に分離したりしても、既存のコピーは保護できません。ここで新しく作るのは外側のストレージボックスです。内部の配列は、配列自身のコピーオンライトによって、要素の実際のコピーをさらに遅らせることができます。

snapshot は配列の値を返し、ストレージボックスは公開しません。デバッグの便宜のために可変のボックスを公開すると、呼び出し側がコンテナの書き込み経路を迂回できてしまいます。今後、削除、ソート、一括更新を追加する場合も、同じ分離処理を先に実行する必要があります。

複数のエイリアスで書き込み経路を検証する

同じファイルの末尾に、次のコードを追加します。通常の assert は最適化ビルドで除去されるため、ここでは precondition を使います。これらのチェックまで無効にする非チェック最適化モードは使わないでください。

let original = IntBuffer([1, 2])
var first = original
var second = original
let saved = first.snapshot

first[0] = 9
precondition(original.snapshot == [1, 2])
precondition(second.snapshot == [1, 2])
precondition(first.snapshot == [9, 2])

first.append(3)
second.append(4)
precondition(first.snapshot == [9, 2, 3])
precondition(second.snapshot == [1, 2, 4])
precondition(original.snapshot == [1, 2])
precondition(saved == [1, 2])

var independent = first
independent[1] = 8
first[0] = 7
precondition(independent.snapshot == [9, 8, 3])
precondition(first.snapshot == [7, 2, 3])

var empty = IntBuffer([])
let emptyCopy = empty
empty.append(5)
precondition(emptyCopy.snapshot.isEmpty)
precondition(empty.snapshot == [5])

コピーして一度変更するだけのテストよりも、2つのコピーをそれぞれ変更するほうが、実装の抜けを見つけやすくなります。空のコンテナへの追加では、まだ要素がない状態での分離経路を検証できます。また、変更済みのコピーからもう一度コピーすることで、「一度分離したら、その後は分離不要」と誤って扱っていないかを確認できます。

意図的に実装を壊す確認も一度行うとよいでしょう。添字のsetterから分離処理の呼び出しを一時的に外し、チェックが確実に失敗することを確認してから元に戻します。実装を壊してもテストが通るなら、狙った振る舞いを検証できていません。

クラウドMacで2種類のビルドを実行する

まず現在のツールチェーンを確認し、それぞれコンパイルして実行します。コマンドは、ファイルを保存したディレクトリで実行してください。

xcrun swiftc --version
xcrun swiftc -Onone CowCheck.swift -o cow-check-debug
./cow-check-debug
xcrun swiftc -O CowCheck.swift -o cow-check-release
./cow-check-release

正常に完了した場合、プログラムは何も出力せず、終了コードはゼロになります。条件を満たさなければ処理が終了し、ゼロ以外の終了ステータスを返します。パイプラインでは各コマンドの終了コードを個別に確認し、後続のコマンドの成功で先行する失敗が隠れないようにしてください。

記録しておくのは、ツールチェーンのバージョン、ソースコードのコミット識別子、失敗した条件で十分です。メモリアドレスを保存する必要はありません。デバッグビルドと最適化ビルドの両方でテストが通ったら、同じ入力と期待値をプロジェクトのユニットテストターゲットへ移し、コンテナの実装を変更するたびに実行します。

ネストした参照と並行アクセスの境界を明確にする

今後、整数の代わりにクラスのインスタンスを格納する場合、配列をコピーしてもコピーされるのは要素への参照だけです。コピー側から取得したオブジェクトのプロパティを変更すると、元のコンテナからもその変更が見える可能性があります。これは必ずしも配列自体のセマンティクスに反するわけではありませんが、業務上のスナップショットとして約束した独立性には反するかもしれません。

その場合は、要素を不変オブジェクトにする、値型に置き換える、ディープコピーのプロトコルを定義してテストする、のいずれかを明確に選びます。「構造体なら中身もすべて独立する」と一括りに保証してはいけません。また、制約を設けずにオブジェクトをコピーして、リソースハンドルなどのコピーできない状態を覆い隠すべきでもありません。

isKnownUniquelyReferenced は同期プリミティブでもありません。この記事のテストが検証するのは逐次アクセスだけです。同じ可変コンテナを複数のタスクが同時に読み書きする場合は、別途アクセスの隔離が必要です。ある時点で参照が一意だと判定されても、その後の並行アクセスによる競合を無視できるわけではありません。

最後に確認するのは、すべての変更経路で先に分離しているか、戻り値から可変参照が漏れていないか、要素のコピー範囲が契約に明記されているか、という3点です。この3点を明確にして維持するほうが、ある実行で「たまたまデータが混ざらなかった」ことを眺めるより、はるかに確実です。

よくある質問

構造体なら変更は必ず分離されますか?

いいえ。保持しているクラスのインスタンスはコピー間で共有されます。値セマンティクスを提供するには、共有ストレージを変更前に分離するなどの設計が必要です。

isKnownUniquelyReferencedで排他制御もできますか?

できません。アクセスが適切に分離されていることが前提です。同じ変数への並行アクセスには、actorやロックなどの同期が別途必要です。

プロジェクトに合ったMacを選ぶ

ネイティブビルドやシミュレーターでの動作確認が必要なら、Apple Silicon搭載の専有物理Macをレンタルして検証するのがおすすめです。長期にわたって毎日使い、利用場所も固定なら、購入もあわせて検討するとよいでしょう。まずは日単位で試し、継続利用が決まったら月払い・四半期払いを検討できます。

リモートMacをレンタル

プロジェクトの段階に合ったプランを選ぶ

まずは機種、利用期間、接続方法を確認してから、レンタルをご検討ください。