Field vs Property. Optimisation of performance

C#.NetPerformanceC# 4.0Optimization

C# Problem Overview


Please note this question related to performance only. Lets skip design guidelines, philosophy, compatibility, portability and anything what is not related to pure performance. Thank you.

Now to the question. I always assumed that because C# getters/setters are really methods in disguise then reading public field must be faster than calling a getter.

So to make sure I did a test (the code below). However this test only produces expected results (ie fields are faster than getters at 34%) if you run it from inside Visual Studio.

Once you run it from command line it shows pretty much the same timing...

The only explanation could be is that the CLR does additional optimisation (correct me if I am wrong here).

I do not believe that in real application where those properties being used in much more sophisticated way they will be optimised in the same way.

Please help me to prove or disprove the idea that in real life properties are slower than fields.

The question is - how should I modify the test classes to make the CLR change behaviour so the public field outperfroms the getters. OR show me that any property without internal logic will perform the same as a field (at least on the getter)

EDIT: I am only talking about Release x64 build.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Diagnostics;
using System.Runtime.InteropServices;

namespace PropertyVsField
{
    class Program
    {
        static int LEN = 20000000;
        static void Main(string[] args)
        {
            List<A> a = new List<A>(LEN);
            List<B> b = new List<B>(LEN);

            Random r = new Random(DateTime.Now.Millisecond);

            for (int i = 0; i < LEN; i++)
            {
                double p = r.NextDouble();
                a.Add(new A() { P = p });
                b.Add(new B() { P = p });
            }

            Stopwatch sw = new Stopwatch();

            double d = 0.0;

            sw.Restart();
            for (int i = 0; i < LEN; i++)
            {
                d += a[i].P;
            }

            sw.Stop();

            Console.WriteLine("auto getter. {0}. {1}.", sw.ElapsedTicks, d);

            sw.Restart();
            for (int i = 0; i < LEN; i++)
            {
                d += b[i].P;
            }

            sw.Stop();

            Console.WriteLine("      field. {0}. {1}.", sw.ElapsedTicks, d);

            Console.ReadLine();
        }
    }

    class A
    {
        public double P { get; set; }
    }
    class B
    {
        public double P;
    }
}

C# Solutions


Solution 1 - C#

As others have already mentioned, the getters are inlined.

If you want to avoid inlining, you have to

  • replace the automatic properties with manual ones:

      class A 
      {
          private double p;
          public double P
          {
              get { return p; }
              set { p = value; }
          }
      } 
    
  • and tell the compiler not to inline the getter (or both, if you feel like it):

              [MethodImpl(MethodImplOptions.NoInlining)]
              get { return p; }
    

Note that the first change does not make a difference in performance, whereas the second change shows a clear method call overhead:

Manual properties:

auto getter. 519005. 10000971,0237547.
      field. 514235. 20001942,0475098.

No inlining of the getter:

auto getter. 785997. 10000476,0385552.
      field. 531552. 20000952,077111.

Solution 2 - C#

Have a look at the Properties vs Fields – Why Does it Matter? (Jonathan Aneja) blog article from one of the VB team members on MSDN. He outlines the property versus fields argument and also explains trivial properties as follows:

> One argument I’ve heard for using fields over properties is that > “fields are faster”, but for trivial properties that’s actually not > true, as the CLR’s Just-In-Time (JIT) compiler will inline the > property access and generate code that’s as efficient as accessing a > field directly.

Solution 3 - C#

The JIT will inline any method (not just a getter) that its internal metrics determine will be faster inlined. Given that a standard property is return _Property; it will be inlined in every case.

The reason you are seeing different behavior is that in Debug mode with a debugger attached, the JIT is significantly handicapped, to ensure that any stack locations match what you would expect from the code.

You are also forgetting the number one rule of performance, testing beats thinking. For instance even though quick sort is asymptotically faster than insertion sort, insertion sort is actually faster for extremely small inputs.

Solution 4 - C#

> The only explanation could be is that the CLR does additional optimisation (correrct me if I am wrong here).

Yes, it is called inlining. It is done in the compiler (machine code level - i.e. JIT). As the getter/setter are trivial (i.e. very simple code) the method calls are destroyed and the getter/setter written in the surrounding code.

This does not happen in debug mode in order to support debugging (i.e. the ability to set a breakpoint in a getter or setter).

In visual studio there is no way to do that in the debugger. Compile release, run without attached debugger and you will get the full optimization.

> I do not believe that in real application where those properties being used in much more sophisticated way they will be optimised in the same way.

The world is full of illusions that are wrong. They will be optimized as they are still trivial (i.e. simple code, so they are inlined).

Solution 5 - C#

After read all your articles, I decide to make a benchmark with these code:

	[TestMethod]
	public void TestFieldVsProperty()
	{
		const int COUNT = 0x7fffffff;
		A a1 = new A();
		A a2 = new A();
		B b1 = new B();
		B b2 = new B();
		C c1 = new C();
		C c2 = new C();
		D d1 = new D();
		D d2 = new D();
		Stopwatch sw = new Stopwatch();
		
		long t1, t2, t3, t4;

		sw.Restart();
		for (int i = COUNT - 1; i >= 0; i--)
		{
			a1.P = a2.P;
		}

		sw.Stop();

		t1 = sw.ElapsedTicks;

		sw.Restart();
		for (int i = COUNT - 1; i >= 0; i--)
		{
			b1.P = b2.P;
		}

		sw.Stop();


		t2 = sw.ElapsedTicks;

		sw.Restart();
		for (int i = COUNT - 1; i >= 0; i--)
		{
			c1.P = c2.P;
		}

		sw.Stop();

		t3 = sw.ElapsedTicks;

		sw.Restart();
		for (int i = COUNT - 1; i >= 0; i--)
		{
			d1.P = d2.P;
		}

		sw.Stop();


		t4 = sw.ElapsedTicks;
		long max = Math.Max(Math.Max(t1, t2), Math.Max(t3, t4));

		Console.WriteLine($"auto: {t1}, {max * 100d / t1:00.00}%.");
		Console.WriteLine($"field: {t2}, {max * 100d / t2:00.00}%.");
		Console.WriteLine($"manual: {t3}, {max * 100d / t3:00.00}%.");
		Console.WriteLine($"no inlining: {t4}, {max * 100d / t4:00.00}%.");

	}
	class A
	{
		public double P { get; set; }
	}
	class B
	{
		public double P;
	}
	class C
	{
		private double p;
		public double P
		{
			get => p;
			set => p = value;
		}
	}
	class D
	{
		public double P
		{
			[MethodImpl(MethodImplOptions.NoInlining)]
			get;
			[MethodImpl(MethodImplOptions.NoInlining)]
			set;
		}
	}

When test in debug mode, I got this result:

auto: 35142496, 100.78%.
field: 10451823, 338.87%.
manual: 35183121, 100.67%.
no inlining: 35417844, 100.00%.

but when switch to release mode, the result is different than before.

auto: 2161291, 873.91%.
field: 2886444, 654.36%.
manual: 2252287, 838.60%.
no inlining: 18887768, 100.00%.

seems auto property is a better way.

Solution 6 - C#

It should be noted that it's possible to see the "real" performance in Visual Studio.

  1. Compile in Release mode with Optimisations enabled.
  2. Go to Debug -> Options and Settings, and uncheck "Suppress JIT optimization on module load (Managed only)".
  3. Optionally, uncheck "Enable Just My Code" otherwise you may not be able to step in the code.

Now the jitted assembly will be the same even with the debugger attached, allowing you to step in the optimised dissassembly if you so please. This is essential to understand how the CLR optimises code.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionBoppity BopView Question on Stackoverflow
Solution 1 - C#HeinziView Answer on Stackoverflow
Solution 2 - C#JamieSeeView Answer on Stackoverflow
Solution 3 - C#GuvanteView Answer on Stackoverflow
Solution 4 - C#TomTomView Answer on Stackoverflow
Solution 5 - C#dexiangView Answer on Stackoverflow
Solution 6 - C#AsikView Answer on Stackoverflow