summaryrefslogtreecommitdiff
path: root/tests/src/JIT/Performance/CodeQuality/Inlining/InlineGCStruct.cs
blob: 660627cc7222bb542a8945285cefeb2bb131a1c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

// In CoreCLR String.Format(ref, ref) is small and readily inlined.
// The inline introduces a System.Parms GC struct local which is
// untracked and must be zero initialized in the prolog. When the
// inlined callsite is in a cold path, the inline hurts performance.
//
// There are two test methods below, one of which calls String.Format
// on a cold path and the other which has similar structure but
// does not call String.Format. Expectation is that they will have
// similar performance.
//
// See https://github.com/dotnet/coreclr/issues/7569 for context.

using Microsoft.Xunit.Performance;
using System;
using System.Runtime.CompilerServices;
using Xunit;

[assembly: OptimizeForBenchmarks]
[assembly: MeasureInstructionsRetired]

namespace Inlining
{
public class InlineGCStruct
{
#if DEBUG
    public const int Iterations = 1;
#else
    public const int Iterations = 2500000;
#endif

    [MethodImpl(MethodImplOptions.NoInlining)]
    public static int FastFunctionNotCallingStringFormat(int param)
    {
        if (param < 0)
        {
            throw new Exception(String.Format("We do not like the value {0:N0}.", param));
        }

        if (param == int.MaxValue)
        {
            throw new Exception(String.Format("{0:N0} is maxed out.", param));
        }

        if (param > int.MaxValue / 2)
        {
            throw new Exception(String.Format("We do not like the value {0:N0} either.", param));
        }

        return param * 2;
    }

    [MethodImpl(MethodImplOptions.NoInlining)]
    public static int FastFunctionNotHavingStringFormat(int param)
    {
        if (param < 0)
        {
            throw new ArgumentOutOfRangeException("param", "We do not like this value.");
        }

        if (param == int.MaxValue)
        {
            throw new ArgumentOutOfRangeException("param", "Maxed out.");
        }

        if (param > int.MaxValue / 2)
        {
            throw new ArgumentOutOfRangeException("param", "We do not like this value either.");
        }

        return param * 2;
    }

    [Benchmark]
    public static bool WithFormat()
    {
        int result = 0;

        foreach (var iteration in Benchmark.Iterations)
        {
            using (iteration.StartMeasurement())
            {
                for (int i = 0; i < Iterations; i++)
                {
                    result |= FastFunctionNotCallingStringFormat(11);
                }
            }
        }

        return (result == 22);
    }

    [Benchmark]
    public static bool WithoutFormat()
    {
        int result = 0;

        foreach (var iteration in Benchmark.Iterations)
        {
            using (iteration.StartMeasurement())
            {
                for (int i = 0; i < Iterations; i++)
                {
                    result |= FastFunctionNotHavingStringFormat(11);
                }
            }
        }

        return (result == 22);
    }

    public static bool WithoutFormatBase()
    {
        int result = 0;

        for (int i = 0; i < Iterations; i++)
        {
            result |= FastFunctionNotHavingStringFormat(11);
        }

        return (result == 22);
    }

    public static bool WithFormatBase()
    {
        int result = 0;

        for (int i = 0; i < Iterations; i++)
        {
            result |= FastFunctionNotCallingStringFormat(11);
        }

        return (result == 22);
    }

    public static int Main()
    {
        bool withFormat = WithFormatBase();
        bool withoutFormat = WithoutFormatBase();

        return (withFormat && withoutFormat ? 100 : -1);
    }
}
}