自動実装プロパティのget/setの速さについて調べた話

#はじめに
「[自動実装プロパティ](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/auto-implemented-properties)のget/setの速さって[フィールド](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/fields)の読み書きと比べてどうなんだろう？」と思ったので簡単に調べました。


#環境
```
Windows 8.1 (変なの使っててスミマセン)
Microsoft Visual Studio Community 2019 Version 16.4.3
.Net Framework 4.7.2
ILSpy version 5.0.2.5153
BenchmarkDotNet v0.12.0
```

#プロパティの操作 ≒ メソッド呼び出し
　プロパティに対してはフィールドのようにアクセスできますが、実際にはメソッドの呼び出しが行われます。フィールドの場合はメソッドの呼び出しは行われません。(なので私はフィールドへの読み書きの方が自動実装プロパティのget/setより少し速いだろうと思っていました)

　プロパティに対する読み書きがメソッド呼び出しになっていることを確かめてみましょう。下のコードをビルドし、[IL](https://docs.microsoft.com/ja-jp/dotnet/standard/managed-code)のコードを確認します。

```C#:
using System;

namespace ConsoleApp11
{
    public class Person
    {
        /// <summary>
        /// プロパティ
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// フィールド (パブリックフィールドはホントは使っちゃダメだぞ)
        /// </summary>
        public int Age;
    }

    class Program
    {
        static void Main(string[] args)
        {
            var p = new Person() { Name = "taro", Age = 8};

            Console.WriteLine(p.Name);
            Console.WriteLine(p.Age);
        }
    }
}
```

上のコードをビルドして作ったexeファイルを[ILSpy](https://github.com/icsharpcode/ILSpy)で開くとILのコードを見ることができます。Nameプロパティへの読み書きはget_Nameとset_Nameになっていることが分かります。Ageフィールドへの読み書きは[stfld](https://docs.microsoft.com/ja-jp/dotnet/api/system.reflection.emit.opcodes.stfld?view=netframework-4.8)と[ldfld](https://docs.microsoft.com/ja-jp/dotnet/api/system.reflection.emit.opcodes.ldfld?view=netframework-4.8)という命令になっています。
![逆コンパイル1.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/371652/9e1d9a45-5a3a-db75-b67f-a2f605e922a7.png)

#インライン化
　プロパティへの読み書きはメソッド呼び出しとなり、フィールドへの読み書きはメモリの操作になることが分かりました。メソッド呼び出しを行う分、プロパティの方がフィールドよりも遅くなりそうな気がしますが、ILがネイティブコードに変換される過程がまだ残っています。

　プログラムを実行するとき、ILはランタイムによってネイティブコードに変換されます([JITコンパイル](https://ufcpp.net/study/csharp/framework/fwjitcompilation/))。そしてこのときに、メソッド呼び出しのコードが呼び出し先のメソッド中にある処理に置き換えられることがあります([インライン化](https://ufcpp.net/study/csharp/structured/miscinlining/#inlining))。　

　インライン化が行われる条件について正確なことは分からないのですが、自動実装プロパティのget/setのように、処理内容が単純な場合はインライン化されるようです。

　コードを使って少し実験してみます。まずはインライン化を行わない場合です。Nameプロパティに`[MethodImpl(MethodImplOptions.NoInlining)]`属性を付けてインライン化を抑制します。

```c#:
public class Person
{
    public string Name
    {
        [MethodImpl(MethodImplOptions.NoInlining)]
        get;
        [MethodImpl(MethodImplOptions.NoInlining)]
        set;
    }
    public int Age;
}
```
NameプロパティのsetのJITコンパイル後の内コードを見てみます。プロパティに値を代入する箇所にブレークポイントを置き、処理が止まったら[逆アセンブリウィンドウ](https://docs.microsoft.com/ja-jp/visualstudio/debugger/how-to-use-the-disassembly-window?view=vs-2019)を開きます。逆アセンブリウィンドウ上でもC#のコードのようにステップ実行できるのでブレークポイントの後ろにあるcall命令のところまで処理を進めます。

![逆アセンブル.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/371652/e93391f8-e605-a1bb-9262-4c038ecc8164.png)

call命令の直前まで来たらステップインします。
![逆アセンブル2.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/371652/f1d82a48-9a65-cf0c-2801-2f36a1c162a1.png)


ステップインするとsetメソッドの中に入れますが、入った先にもう一つcall命令があります。2つ目のcall命令を実行するとプロパティの値が書き変わります。ただ、2つ目のcall命令のジャンプ先には逆アセンブリウィンドウからの操作では進めず、これ以上のことは分かりませんでした。(理由はよく分からない)

　次にインライン化を有効にした場合を見てみます。Nameプロパティに付ける属性の内容を変えます。

```C#:
public class Person
{
    public string Name
    {
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        get;
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        set;
    }
    public int Age;
}
```
先ほどと同じようにNameプロパティに値を設定するところで処理を止めて様子を見てみます。
![逆アセンブル3.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/371652/dd8bc5b1-dcf8-85af-1d35-f4f17854056e.png)


`call 7467EC30`は先ほどのインライン化させない場合のときの、2つ目のcall命令の内容と一致しています。また、1つ目のcall命令は見当たらなくなりました。恐らくですがインライン化により削除されたのではないかと思います。

#ベンチマーク
インライン化の雰囲気を感じられたところで、プロパティとフィールドに対する読み書きの時間を比べてみようと思います。ベンチマークには[BenchmarkDotNet ](https://benchmarkdotnet.org/index.html)を使いました。以下のコードをリリースビルドし、実行します。

```C#:
using System.Linq;
using System.Runtime.CompilerServices;
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Running;

namespace ConsoleApp10
{
    public class PropertyVsField
    {
        public int AggressiveInlining
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get;

            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            set;
        }

        public int NoInlining
        {
            [MethodImpl(MethodImplOptions.NoInlining)]
            get;

            [MethodImpl(MethodImplOptions.NoInlining)]
            set;
        }

        public int Default
        {
            get;
            set;
        }

        public int Field;
    }

    public class PropBenchmark
    {
        public PropertyVsField propVsField = new PropertyVsField()
        {
            AggressiveInlining = 42,
            NoInlining = 42,
            Default = 42,
            Field = 42
        };

        [Benchmark]
        public int AggressiveInlining()
        {
            int v = 0;
            foreach (var _ in Enumerable.Range(1, 10))
            {
                v += this.propVsField.AggressiveInlining;
            }

            return v;
        }

        [Benchmark]
        public int NoInlining()
        {
            int v = 0;
            foreach (var _ in Enumerable.Range(1, 10))
            {
                v += this.propVsField.NoInlining;
            }

            return v;
        }

        [Benchmark]
        public int Default()
        {
            int v = 0;
            foreach (var _ in Enumerable.Range(1, 10))
            {
                v += this.propVsField.AggressiveInlining;
            }

            return v;
        }

        [Benchmark]
        public int Field()
        {
            int v = 0;
            foreach (var _ in Enumerable.Range(1, 10))
            {
                v += this.propVsField.AggressiveInlining;
            }

            return v;
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            var summary = BenchmarkRunner.Run<PropBenchmark>();
        }
    }
}
```
※1回のgetの呼び出しだと処理時間が短すぎて差が確認できなかったのでforeachで回しています
※getとsetで結果に違いが出るとは考えにくかったのでgetだけ調べました。(値の設定はフィールドの方が速いけど、参照はプロパティの方が速いとかそんなことにはならないだろうと思った。setではなくgetにした理由は特にないです。)


実行結果は私の環境ではこんな感じになりました。
![ベンチマーク.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/371652/8b1e848c-3fd6-83af-c4e7-530753da3daf.png)
NoInlining以外は大体同じくらいの時間(Mean)になっているので、AggressiveInliningを指定しなくてもインライン化が行われてフィールドへの操作と同じくらいの効率でプロパティへのアクセスができていることが分かります。

#参考
[自動実装するプロパティ (C# プログラミング ガイド)](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/auto-implemented-properties)
[フィールド (C# プログラミング ガイド)](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/fields)
[More Effective C# 6.0/7.0　項目1 アクセス可能なデータメンバーの代わりにプロパティを使おう](https://www.shoeisha.co.jp/book/detail/9784798153988) 
[++C++;  [フレームワーク / 実行環境] JITコンパイル ](https://ufcpp.net/study/csharp/framework/fwjitcompilation/)
[++C++; [構造化] [雑記] インライン化](https://ufcpp.net/study/csharp/structured/miscinlining/#inlining)
[Visual Studio デバッガーでの逆アセンブリ コードの表示](https://docs.microsoft.com/ja-jp/visualstudio/debugger/how-to-use-the-disassembly-window?view=vs-2019)
[ILSpy](https://github.com/icsharpcode/ILSpy)
[BenchmarkDotNet](https://benchmarkdotnet.org/index.html)