構造体のDefensive copyとボックス化について（readonly struct / in引数 /ジェネリック）

Question

特定のデータを受け取って処理をするジェネリッククラス/メソッドを作りたかったので、以下宣言をしました。

// 受け取れるデータのインターフェイス(値取得しかしないメソッドを持つ)
public interface IMark {
  bool IsMarkXyz();
}

// IMarkを受け取ってなんやかんやする処理クラス
// 引数の内容の書き換えは絶対にしない(例えばListを持っていても追加したりもしない)
public class Executer {
  public bool Execute1<T>(T data) where T : IMark { /* 処理 */ }
  public bool Execute2(IMark data) { /* 処理 */ }
  public bool Execute3<T>(in T data) where T : IMark { /* 処理 */ }
  public bool Execute4<T>(IEnumerable<T> data) where T : IMark { /* 処理 */ }
}

そのデータはイミュータブルでよく、サイズが十分小さそうだったので、以下宣言をしました。

public readonly struct HogeData : IMark {
  // データの例
  public int Id { get; }
  public string Text { get; }
  public HogeData(int id, string text) { Id = id; Text = text; }

  public bool IsMarkXyz() { /* IMarkに既定された、値を取得する処理 */ }
}

ここで、readonly struct と in引数の理解がちゃんとできているか自信がないです。
特に、inで受け取らないメソッドにreadonly structの変数を渡したときの動作がよくわかりません。
メモリ管理、Defensive copy、ボックス化について以下の内容であっているか確認させてください。
？がついているのは自信がない部分です。

  HogeData hoge = new HogeData(0, "Xyz"); // 構造体は値型なのでスタックにある。
  hoge.IsMarkXyz();  // -> readonly structなのでDefensive copyは起きない。
  
  IMark hoge2 = new HogeData(1, "abc"); // Box化が起きてヒープに行く。
  hoge2.IsMarkXyz(); // -> ヒープ化は起きているが中身はreadonly structなのでDefensive copyは起きない？

  var exe = new Executer();
  exe.Execute1<HogeData>(hoge); // -> Execute1はinで受け取らないので、コピーが起きる？？？
  exe.Execute2(hoge); // -> ボックス化が起きる。参照型になっているためコピーされない。
  exe.Execute3<HogeData>(in hoge); // -> inで受け取るメソッドに渡しているのでコピーは起きない。 
  exe.Execute4<HogeData>(new[] { hoge }); // -> 配列は参照型なのでヒープに行き、コピーは起きない？

Answer 1

こんにちは。

構造体の Defensive copy とは、「書き換え不能領域に置かれた構造体のメソッドを呼ぶ際に、そのメソッドが自身の値を書き換えない保証がないため予めスタック領域にコピーしてから実行する」というものです。
構造体が書き換え不能領域に置かれるのは、readonly field に配置した場合や in parameter で受け取った場合などです。
このとき対象の構造体が readonly でマークされていれば、そのシナリオにおける Defensive copy が抑制されます。
すなわち、「readonly struct を扱う場合は Defensive copy は一切発生しない」ということです。
readonly struct とは、「構造体のメソッドが自身の値を書き換えないという保証」そのものです。
また、値が書き換え可能領域に配置されている場合はそもそも Defensive copy は行われないため無関係です。

Comments

[ry188472]

なるほど。ということは、
exe.Execute1<HogeData>(hoge);
exe.Execute3<HogeData>(in hoge);
はHogeDataがreadonly structなので実質的に等価（readonlyじゃなければinは有効）ということですね？

[tamoto]

どちらも Defensive copy はなされませんが、等価と言ってしまうと誤解を招くかと。
Execute1 は値そのものを引数に取っていて、Execute3 は値の格納された場所へのアドレスを引数に取っています。
ただし引数が readonly struct であるならこれらの違いがコードの挙動に影響することはありません。

[ry188472]

そもそもこんなことするなよ！という質問で申し訳ないのですが・・・
例えばreadonly structをクラスの書き換え可能なメンバ変数(readonlyでないフィールド/set可能なプロパティ)を持っていて、そのメンバ変数をメソッドの引数に渡した場合を考えます。
Execute3 の in の場合は参照渡しなので、Execute3の処理の中で引数に渡したメンバ変数をnewし直すと、参照先が変わるので内容の変更が反映されてしまいますよね。
Execute1 は値渡しなので、同じことをしてもメソッド呼び出し時点の引数の内容が保証されているんでしょうか？

[tamoto]

Execute3 は in parameter なので何を渡していても new し直した値を代入することはできません。
in parameter で渡した領域は、メソッドからは一時的に書き換え不能領域として認識されているということです。
試してみれば良いのではないでしょうか。