Performance related issue with C#

Unity Engine
,
1

Hello all,

Recently I have been spending a lot of time on improving my skills on theory of programming so I can better structure my code. During this research on the theory of programming I came across Clean Code (I’m a self-thought developer, so it took a little bit time to get there…) Anyway, the refactoring the code and extracting the methods until they get to a point about max.10-20 lines part is really surprised me since my previous knowledge on this matter is how much you rely on method calls will affect your performance since the process on cpu will make more calls to the address points related to these actions.

To test this argument by myself, I wrote a JavaScript application and run it on node.js,

const ITERATION_COUNT = 5000;
const SHOW_NUMBER_VERIFICATION = false;

class TestCallToClassMethod
{
    constructor(num1, num2)
  {
      this.num = this.multiply(num1, num2);
  }
 
  multiply(num1, num2)
  {
      return num1 * num2;
  }
}

function _TestCallToClassMethod()
{
  var start = Date.now();
  var num = 0;
  for (var i = 0; i < ITERATION_COUNT; i++)
  {
    for (var j = 0; j < ITERATION_COUNT; j++)
    {
      var test = new TestCallToClassMethod(i, j);
      num += test.num;
    }
  }
  var end = Date.now();
  var time = end-start;
 
  if (SHOW_NUMBER_VERIFICATION)
    console.log("Test Call To Class Method Number: " + num);
  console.log("Test Call To Class Method Time: " + time);
}
_TestCallToClassMethod();

class TestCallToStaticClassMethod
{
    constructor(num1, num2)
  {
      this.num = Math.Multiply(num1, num2);
  }
}

class Math
{
  static Multiply(num1, num2)
  {
    return num1 * num2;
  }
}

function _TestCallToStaticClassMethod()
{
  var start = Date.now();
  var num = 0;
  for (var i = 0; i < ITERATION_COUNT; i++)
  {
    for (var j = 0; j < ITERATION_COUNT; j++)
    {
      var test = new TestCallToStaticClassMethod(i, j);
      num += test.num;
    }
  }
  var end = Date.now();
  var time = end-start;

  if (SHOW_NUMBER_VERIFICATION)
    console.log("Test Call To Static Class Method Number: " + num);
  console.log("Test Call To Static Class Method Time: " + time);
}
_TestCallToStaticClassMethod();

class TestCallToConcreteClass
{
    constructor(num1, num2)
  {
      var multiply = new Multiply(num1, num2);
      this.num = multiply.num;
  }
}

class Multiply
{
    constructor(num1, num2)
  {
      this.num = num1 * num2;
  }
}

function _TestCallToConcreteClass()
{
  var start = Date.now();
  var num = 0;
  for (var i = 0; i < ITERATION_COUNT; i++)
  {
    for (var j = 0; j < ITERATION_COUNT; j++)
    {
      var test = new TestCallToConcreteClass(i, j);
      num += test.num;
    }
  }
  var end = Date.now();
  var time = end-start;

  if (SHOW_NUMBER_VERIFICATION)
    console.log("Tell Call To Concrete Number: " + num);
  console.log("Tell Call To Concrete Class: " + time);
}
_TestCallToConcreteClass();

function _TestInlineAction()
{
  var start = Date.now();
  var num = 0;
  for (var i = 0; i < ITERATION_COUNT; i++)
  {
    for (var j = 0; j < ITERATION_COUNT; j++)
    {
      num += i * j;
    }
  }
  var end = Date.now();
  var time = end-start;
 
  if (SHOW_NUMBER_VERIFICATION)
    console.log("Test Inline Action Number: " + num);
  console.log("Test Inline Action Time: " + time);
}
_TestInlineAction();

This script gave me the following results on my PC;

Test Call To Class Method Time: 42
Test Call To Static Class Method Time: 42
Tell Call To Concrete Class: 42
Test Inline Action Time: 37

And it really impressed me that calling other classes, instantiating objects and etc. didn’t affect the performance too much. But just to be sure I wanted to conduct a similar test on Unity with C# too. So I wrote the following script and attached it on a GameObject in a fresh scene that is also in a fresh Unity project.

using System;
using UnityEngine;
using UnityEngine.UI;

namespace PerformanceTest
{
    public class TestingBehaviours : MonoBehaviour
    {
        [SerializeField] private Text _text;

        private readonly int ITERATION_COUNT = 5000;
        private readonly bool SHOW_NUMBER_VERIFICATION = false;

        private bool _isTestInitiated = false;
        private string _logText;

        private void Update()
        {
            if (Input.GetKeyDown(KeyCode.Space) && !_isTestInitiated)
            {
                _isTestInitiated = true;
                EvaluateTests();
            }
        }

        private void EvaluateTests()
        {
            TestMethod(
                "Test Call To Class Method",
                (i, j) =>
                {
                    return _TestCallToClassMethod(i, j);
                });

            TestMethod(
                "Test Call To Concrete Class",
                (i, j) =>
                {
                    return _TestCallToConcreteClass(i, j);
                });

            TestMethod(
                "Test Call To Static Class",
                (i, j) =>
                {
                    return _TestCallToStaticClass(i, j);
                });

            TestMethod(
                "Test Inline Class",
                (i, j) =>
                {
                    return _TestInlineClass(i, j);
                });


            _MethodAction();


            // ----- Start of Inline Action -----

            long startTime = GetSystemTime();
            ulong num = 0;
            for (int i = 0; i < ITERATION_COUNT; i++)
            {
                for (int j = 0; j < ITERATION_COUNT; j++)
                {
                    num += (ulong)(i * j);
                }
            }

            long endTime = GetSystemTime();
            long processTime = endTime - startTime;

            WriteNumber("Inline Action Process Number", num);
            WriteTime("Inline Action Process Time", processTime);

            // ----- End of Inline Action -----

            _text.text = _logText;
        }

        private void TestMethod(string logHeader, Func<int, int, ulong> testAction)
        {
            long startTime = GetSystemTime();

            ulong num = 0;
            for (int i = 0; i < ITERATION_COUNT; i++)
            {
                for (int j = 0; j < ITERATION_COUNT; j++)
                {
                    num += testAction(i, j);
                }
            }

            long endTime = GetSystemTime();
            long processTime = endTime - startTime;

            WriteNumber(logHeader + " Number", num);
            WriteTime(logHeader + " Time", processTime);
        }

        private void _MethodAction()
        {
            long startTime = GetSystemTime();

            ulong num = 0;
            for (int i = 0; i < ITERATION_COUNT; i++)
            {
                for (int j = 0; j < ITERATION_COUNT; j++)
                {
                    num += (ulong)(i * j);
                }
            }

            long endTime = GetSystemTime();
            long processTime = endTime - startTime;

            WriteNumber("Method Action Process Number", num);
            WriteTime("Method Action Process Time", processTime);
        }

        private ulong _TestCallToClassMethod(int i, int j)
        {
            var test = new TestCallToClassMethod(i, j);
            return test.num;
        }

        private ulong _TestCallToConcreteClass(int i, int j)
        {
            var test = new TestCallToConcreteClass(i, j);
            return test.num;
        }

        private ulong _TestCallToStaticClass(int i, int j)
        {
            var test = new TestCallToStaticClass(i, j);
            return test.num;
        }

        private ulong _TestInlineClass(int i, int j)
        {
            var test = new TestInlineClass(i, j);
            return test.num;
        }

        private void WriteNumber(string header, ulong num)
        {
            if (SHOW_NUMBER_VERIFICATION)
                _logText += $"{header}: {num}\n";
        }

        private void WriteTime(string header, long time)
        {
            _logText += $"{header}: {time}\n";
        }

        private long GetSystemTime()
        {
            return DateTimeOffset.Now.ToUnixTimeMilliseconds();
        }
    }

    public class TestCallToClassMethod
    {
        public ulong num;
        public TestCallToClassMethod(int num1, int num2)
        {
            num = Multiply(num1, num2);
        }

        private ulong Multiply(int num1, int num2)
        {
            return (ulong)(num1 * num2);
        }
    }

    public class TestCallToConcreteClass
    {
        public ulong num;
        public TestCallToConcreteClass(int num1, int num2)
        {
            Multiply multiply = new Multiply(num1, num2);
            num = multiply.num;
        }
    }

    public class Multiply
    {
        public ulong num;
        public Multiply(int num1, int num2)
        {
            num = (ulong)(num1 * num2);
        }
    }

    public class TestCallToStaticClass
    {
        public ulong num;
        public TestCallToStaticClass(int num1, int num2)
        {
            num = Math.Multiply(num1, num2);
        }
    }

    public static class Math
    {
        public static ulong Multiply(int num1, int num2)
        {
            return (ulong)(num1 * num2);
        }
    }

    public class TestInlineClass
    {
        public ulong num;
        public TestInlineClass(int num1, int num2)
        {
            num = (ulong)(num1 * num2);
        }
    }
}

And the results were really shocked me as you can check below

Test Call To Class Method Time: 2366
Test Call To Concrete Class Time: 4468
Test Call To Static Class Time: 2327
Test Inline Class Time: 2269
Method Action Process Time: 15
Inline Action Process Time: 15

I tested the code on two different Unity versions and also by building the project and testing on a standalone build, outcome of these different environments didn’t alter the results too much. While on JavaScript, instantiating new objects and making calls to static class methods weren’t making too much performance difference, on C# with Unity the performance affected by almost 150 to 300 times.

Do I oversight something in here with these tests? Or this interpreted JavaScript runtime beats the compiled (IL2CPP btw) C# code for real?

2

Okay, I have made another test. Because I thought the problem could be related to creating a lot of objects during the iteration phase.

using System.Collections.Generic;
using UnityEngine;

namespace PerformanceTests
{
    public class TestingBehaviours2 : MonoBehaviour
    {
        private const int ITERATOR = 5000;

        private NumberHolder _numberHolder = new NumberHolder(0);
        List<Operators> _operators;

        // Start is called before the first frame update
        private void Start()
        {
            _operators = new List<Operators>()
            {
                new Divider(_numberHolder),
                new Adder(_numberHolder),
                new Multiplier(_numberHolder),
                new Subtractor(_numberHolder)
            };

            OperatorBased();

            PlainMethod();
        }

        private void OperatorBased()
        {
            long startTime = System.DateTimeOffset.Now.ToUnixTimeMilliseconds();
            for (int i = 0; i < ITERATOR; i++)
            {
                for (int j = 0; j < ITERATOR; j++)
                {
                    _operators[j % 4].Operate(j);
                }
            }
            long endTime = System.DateTimeOffset.Now.ToUnixTimeMilliseconds();
            long processTime = endTime - startTime;

            Debug.Log($"Operator Based Calculation: {_numberHolder.Number}");
            Debug.Log($"Process Time of Operator Based: {processTime}");
        }

        private void PlainMethod()
        {
            long startTime = System.DateTimeOffset.Now.ToUnixTimeMilliseconds();

            int num = 0;
            for (int i = 0; i < ITERATOR; i++)
            {
                for (int j = 0; j < ITERATOR; j++)
                {
                    int operation = j % 4;

                    if (operation == 0)
                    {
                        if (j == 0)
                            j = 1;
                        num /= j;
                    }
                    else if (operation == 1)
                    {
                        num += j;
                    }
                    else if (operation == 2)
                    {
                        num *= j;
                    }
                    else if (operation == 3)
                    {
                        num -= j;
                    }
                }
            }
            long endTime = System.DateTimeOffset.Now.ToUnixTimeMilliseconds();
            long processTime = endTime - startTime;

            Debug.Log($"Plain Method Calculation: {num}");
            Debug.Log($"Process Time of Plain Method: {processTime}");
        }
    }

    public class NumberHolder
    {
        private int _number;

        public int Number { get { return _number;} }

        public NumberHolder(int number)
        {
            _number = number;
        }

        public void SetNumber(int number)
        {
            _number = number;
        }
    }

    public abstract class Operators
    {
        protected NumberHolder _numberHolder;

        public Operators(NumberHolder numberHolder)
        {
            _numberHolder = numberHolder;
        }

        public abstract void Operate(int n);
    }

    public class Multiplier : Operators
    {
        public Multiplier(NumberHolder numberHolder) : base(numberHolder)
        {

        }

        public override void Operate(int n)
        {
            int number = MathOperations.Multiply(_numberHolder.Number, n);
            _numberHolder.SetNumber(number);
        }
    }

    public class Divider : Operators
    {
        public Divider(NumberHolder numberHolder) : base(numberHolder)
        {

        }

        public override void Operate(int n)
        {
            int number = MathOperations.Divide(_numberHolder.Number, n);
            _numberHolder.SetNumber(number);
        }
    }

    public class Adder : Operators
    {
        public Adder(NumberHolder numberHolder) : base(numberHolder)
        {

        }

        public override void Operate(int n)
        {
            int number = MathOperations.Add(_numberHolder.Number, n);
            _numberHolder.SetNumber(number);
        }
    }

    public class Subtractor : Operators
    {
        public Subtractor(NumberHolder numberHolder) : base(numberHolder)
        {

        }

        public override void Operate(int n)
        {
            int number = MathOperations.Subtract(_numberHolder.Number, n);
            _numberHolder.SetNumber(number);
        }
    }

    public static class MathOperations
    {
        public static int Multiply(int n1, int n2)
        {
            return n1 * n2;
        }

        public static int Divide(int n1, int n2)
        {
            if (n2 == 0)
                return n1;
            return n1 / n2;
        }

        public static int Add(int n1, int n2)
        {
            return n1 + n2;
        }

        public static int Subtract(int n1, int n2)
        {
            return n1 - n2;
        }
    }
}

Process Time of Operator Based: 109
Process Time of Plain Method: 61

Which decreased the process time difference significantly, even though there is still almost about 2x more process time difference between two techniques. However, I hardly think there will be situations that would require these kind of heavy loads (2.5m iterations with class/methods calls) on a single frame basis. Still it really surprised me that JavaScript surpassed C#

I would love to hear some technical explanation for this (if there is any) from someone who is more profound on this topic than me.

3

Albeit I feel not “profound” (and I have never used JavaScript) maybe I can give some possible causes for your test results:

  1. Unity is a game engine and there are running several more things under the hood than just straight calculations of your code, for example rendering, “timing”, input, sound and other organizational stuff. And since Unity is still mainly single threaded these things take performance/time away from your calculations.
  2. Unity itself is written in C++ and the communication between the C# runtime with the C++ “backend” has some overhead too.
  3. I’m not sure System.Now is appropriate for benchmarks. Better try Systems.Diagnostics.Stopwatch or the built in Profiler features.

I always find such “academic” benchmarks a bit misleading since they don’t represent the typical usecase the engine is used (and optimized) for. For straight batch calculations a game engine is overkill.

For your information. UnityTech is working on a “performance by default” initiative. DOTS with jobs (multithreading) and Burst compiler already allow better performance when done right. They are also working on an ECS implementation for utilizing advantages of data oriented design but it’s very quiet around that lately so I would not “risk” to use it right now. But this has been able to handle hundreds of thousands of independent entities in real time (look for megacity demo). But it requires a completely new thinking and writing of code and thus is not easy to use right now.

4

The “clean code” stuff isn’t about speed. In fact, it pretty much says “stop worrying about speed – for too long we’re been cr*pping up our code for a 1% speed increase that no one will ever notice. Worse, this makes it so every new feature takes forever to add and causes new bugs. So let’s stop that – let’s focus on easy-to-upgrade, easy-to-debug code and in return, oh no! our code will be 1% slower”.

Your tests are confusing me – javascript in one environment appears to run faster than Unity/C# in another. OK. But Clean Code is telling you to compare “ugly” Unity code to “clean” code also in Unity. Clean may be a tiny bit slower, but not enough to notice while playing the game.

2 Likes
5

I am aware of DOTS workflow, which brings the multithreading support to Unity, but since Noda.JS is also singlethreaded. That’s why I thought it would be a proper competitor for Unity’s singlethreaded operations. It means the calculations in this C# test should be processed sequentially, as in JavaScript with Node.js.

And Unity is also converting C# source code into intermediate C++ language before compiling it to proper assembly. So I’m not sure if there is a communication overhead between C# and C++ backend, or anything like that. If there is, I still doubt there will be that much of difference.

And finally, I didn’t know about Stopwatch, I will give it a try later. Date.Now may not be the best solution to calculate the time but, since a same kind of logic has been used in javascript also, it would be equivalent enough I think. Additionally, I must say that again, ofcourse I’m not an expert on conducting performance tests such as these, however the initial difference, which was about 150-300x performance loss, was so horribly harsh which made me doubt about the general performance in Unity.

6

I totally agree with, as you mentioned, it would be totally acceptable (and actually more than acceptable, it should be the only way) that if “clean code” rules will make your code much more maintable, you would (again should) ignore %1 of performance loss, and maybe even much more. The results in the second test are definitely acceptable, my problem was about the performance loss on the first test.

It still makes me wonder that how the heck JavaScript outperformed C# in this matter, however then I thought it could be related to some environment specific optimization stuff (first thing came to my mind is maybe node.js’ engine behaving class objects a kind of a struct object as in C# which make them much more manageable in the matter of allocating/creating/disposing terms)

Again, to clearify, I tottally agree with everything you say.

7

It’s tough for anyone here to actually read and think about someone else’s performance tests since the one’s posted here are almost always fatally bad – like not testing the same amount of loop nesting, or confusing milli and microseconds. Sure, you actually know to test on a stand-alone build, even so, I briefly thought about writing “wait, isn’t the node.js playground run on their server?” but 2 seconds later realized “wait, this is Unity Forums. If it’s not that, it will be something else head-slappingly wrong. Do not get sucked in”.