{"id":5754,"date":"2020-05-24T07:00:02","date_gmt":"2020-05-24T14:00:02","guid":{"rendered":"http:\/\/writeasync.net\/?p=5754"},"modified":"2020-05-23T13:27:06","modified_gmt":"2020-05-23T20:27:06","slug":"null-operator-performance","status":"publish","type":"post","link":"https:\/\/writeasync.net\/?p=5754","title":{"rendered":"Null operator performance"},"content":{"rendered":"

The null-conditional<\/a> (AKA “Elvis”<\/a>) operator and null-coalescing<\/a> operators were introduced in C# 6.0<\/a> and C# 2.0<\/a> respectively. They’ve been with us for years and help make our code more concise. But have you ever wondered about their effect on performance, especially when dealing with value types?<\/p>\n

In reality, a value type (struct) cannot be null. We need to either box it<\/a> or wrap it in a Nullable<\/a> to achieve this. In the worst case, it sounds like trying to use one of these null operators would require heap allocation or at least incur a bit of bookkeeping overhead for tracking “nullity<\/a>.” However, these are just hypotheses. We need to look behind the code<\/a> to find out the truth.<\/p>\n

We’ll consider this example:<\/p>\n

\r\n    public struct MyValue\r\n    {\r\n        private readonly byte[] bytes;\r\n\r\n        public MyValue(byte[] bytes)\r\n        {\r\n            this.bytes = bytes;\r\n        }\r\n\r\n        public int SizeN => this.bytes?.Length ?? 0;\r\n\r\n        public int SizeT => (this.bytes != null) ? this.bytes.Length : 0;\r\n    }\r\n<\/pre>\n
The SizeN property uses null operators to achieve the ultimate scannable<\/a> one-liner. The SizeT property uses the old-fashioned ternary operator — not as terse but readable enough. They each have the same result, but which is better performance-wise? We could start by looking at the IL disassembly<\/a>:<\/p>\n
\r\n.method public hidebysig specialname \r\n    instance int32 get_SizeN () cil managed \r\n{\r\n    \/\/ Method begins at RVA 0x2059\r\n    \/\/ Code size 15 (0xf)\r\n    .maxstack 8\r\n\r\n    \/\/ byte[] array = bytes;\r\n    IL_0000: ldarg.0\r\n    IL_0001: ldfld uint8[] ConsoleApp2.MyValue::bytes\r\n    \/\/ if (array == null)\r\n    IL_0006: dup\r\n    \/\/ (no C# code)\r\n    IL_0007: brtrue.s IL_000c\r\n\r\n    IL_0009: pop\r\n    \/\/ return 0;\r\n    IL_000a: ldc.i4.0\r\n    \/\/ (no C# code)\r\n    IL_000b: ret\r\n\r\n    \/\/ return array.Length;\r\n    IL_000c: ldlen\r\n    IL_000d: conv.i4\r\n    \/\/ (no C# code)\r\n    IL_000e: ret\r\n} \/\/ end of method MyValue::get_SizeN\r\n\r\n.method public hidebysig specialname \r\n    instance int32 get_SizeT () cil managed \r\n{\r\n    \/\/ Method begins at RVA 0x2069\r\n    \/\/ Code size 19 (0x13)\r\n    .maxstack 8\r\n\r\n    \/\/ if (bytes == null)\r\n    IL_0000: ldarg.0\r\n    IL_0001: ldfld uint8[] ConsoleApp2.MyValue::bytes\r\n    \/\/ (no C# code)\r\n    IL_0006: brtrue.s IL_000a\r\n\r\n    \/\/ return 0;\r\n    IL_0008: ldc.i4.0\r\n    \/\/ (no C# code)\r\n    IL_0009: ret\r\n\r\n    \/\/ return bytes.Length;\r\n    IL_000a: ldarg.0\r\n    IL_000b: ldfld uint8[] ConsoleApp2.MyValue::bytes\r\n    IL_0010: ldlen\r\n    IL_0011: conv.i4\r\n    \/\/ (no C# code)\r\n    IL_0012: ret\r\n} \/\/ end of method MyValue::get_SizeT\r\n<\/pre>\n
Already we can make two observations:<\/p>\n
    \n
  1. The null operator code has no overhead! It compiles down to a simple null check and early return.<\/li>\n
  2. The code size for the ternary operator is larger! It seems that the culprit is multiple field access; we touch this.bytes<\/code> twice (first to compare it and second to invoke it) but the null operator version can implicitly avoid this.<\/li>\n<\/ol>\n
    Ultimately, we need to see a benchmark to determine if we have a real difference in execution time, and to rule out any hidden heap allocations (I didn’t see any in the IL but always measure<\/a>!):<\/p>\n
    \r\n    [SimpleJob(RuntimeMoniker.NetCoreApp31)]\r\n    [MemoryDiagnoser]\r\n    public class OperatorBenchmark\r\n    {\r\n        private MyValue nullVal;\r\n        private MyValue hasVal;\r\n\r\n        [GlobalSetup]\r\n        public void Setup()\r\n        {\r\n            this.nullVal = default;\r\n            this.hasVal = new MyValue(new byte[] { 0xA, 0xB, 0xC });\r\n        }\r\n\r\n        [Benchmark]\r\n        public int NullN() => this.nullVal.SizeN;\r\n\r\n        [Benchmark]\r\n        public int NullT() => this.nullVal.SizeT;\r\n\r\n        [Benchmark]\r\n        public int HasN() => this.hasVal.SizeN;\r\n\r\n        [Benchmark]\r\n        public int HasT() => this.hasVal.SizeT;\r\n    }\r\n<\/pre>\n
    Using BenchmarkDotNet<\/a>, we’ll compare four situations, the Cartesian product<\/a> of { null value, has value } x { null operator, ternary operator }. Here are the results on my machine:<\/p>\n
    \r\n| Method |      Mean |     Error |    StdDev |    Median | Gen 0 | Gen 1 | Gen 2 | Allocated |\r\n|------- |----------:|----------:|----------:|----------:|------:|------:|------:|----------:|\r\n|  NullN | 0.5501 ns | 0.0175 ns | 0.0146 ns | 0.5463 ns |     - |     - |     - |         - |\r\n|  NullT | 0.5400 ns | 0.0092 ns | 0.0076 ns | 0.5399 ns |     - |     - |     - |         - |\r\n|   HasN | 0.5842 ns | 0.0483 ns | 0.0693 ns | 0.5421 ns |     - |     - |     - |         - |\r\n|   HasT | 0.5401 ns | 0.0085 ns | 0.0066 ns | 0.5381 ns |     - |     - |     - |         - |\r\n<\/pre>\n
    Given the extremely small running times, the error range, and the median values, it’s safe to call these more or less identical in terms of speed. And look, no heap allocation!<\/p>\n
    On balance, I say use the null operators. The code style is idiomatic<\/a>, the IL code size is smaller, and the runtime performance is nearly equivalent as the next most terse ternary option.<\/p>\n","protected":false},"excerpt":{"rendered":"
    The null-conditional (AKA “Elvis”) operator and null-coalescing operators were introduced in C# 6.0 and C# 2.0 respectively. They’ve been with us for years and help make our code more concise. But have you ever wondered about their effect on performance,… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[104],"tags":[],"class_list":["post-5754","post","type-post","status-publish","format-standard","hentry","category-performance"],"_links":{"self":[{"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5754","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5754"}],"version-history":[{"count":3,"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5754\/revisions"}],"predecessor-version":[{"id":5757,"href":"https:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5754\/revisions\/5757"}],"wp:attachment":[{"href":"https:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5754"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5754"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5754"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}