Skip to content

Commit 2d98d7c

Browse files
timcasselltimcassell
committed
Retrieve current .Net Framework version from TargetFrameworkAttribute.
1 parent 81a4e55 commit 2d98d7c

File tree

3 files changed

+98
-45
lines changed

3 files changed

+98
-45
lines changed

‎src/BenchmarkDotNet/Environments/Runtimes/ClrRuntime.cs

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
using BenchmarkDotNet.Detectors;
33
using BenchmarkDotNet.Helpers;
44
using BenchmarkDotNet.Jobs;
5-
using BenchmarkDotNet.Portability;
65

76
namespace BenchmarkDotNet.Environments
87
{
@@ -16,6 +15,14 @@ public class ClrRuntime : Runtime, IEquatable<ClrRuntime>
1615
public static readonly ClrRuntime Net48 = new ClrRuntime(RuntimeMoniker.Net48, "net48", ".NET Framework 4.8");
1716
public static readonly ClrRuntime Net481 = new ClrRuntime(RuntimeMoniker.Net481, "net481", ".NET Framework 4.8.1");
1817

18+
// Use Lazy to avoid any assembly loading issues on non Windows systems, and for fast cached access for multiple reads.
19+
// Also so that the value will be obtained from the first call which happens on the user's thread,
20+
// then when this is read again on a background thread from the BuildInParallel step, it will return the cached result.
21+
#if NET6_0_OR_GREATER
22+
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
23+
#endif
24+
private static readonly Lazy<ClrRuntime> Current = new(RetrieveCurrentVersion, true);
25+
1926
public string Version { get; }
2027

2128
private ClrRuntime(RuntimeMoniker runtimeMoniker, string msBuildMoniker, string displayName, string? version = null)
@@ -47,27 +54,35 @@ internal static ClrRuntime GetCurrentVersion()
4754
{
4855
if (!OsDetector.IsWindows())
4956
{
50-
throw new NotSupportedException(".NET Framework supports Windows OS only.");
57+
throw new PlatformNotSupportedException(".NET Framework supports Windows OS only.");
5158
}
5259

53-
// this logic is put to a separate method to avoid any assembly loading issues on non Windows systems
54-
string sdkVersion = FrameworkVersionHelper.GetLatestNetDeveloperPackVersion();
60+
return Current.Value;
61+
}
5562

56-
string version = sdkVersion
63+
#if NET6_0_OR_GREATER
64+
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
65+
#endif
66+
private static ClrRuntime RetrieveCurrentVersion()
67+
{
68+
// Try to determine the Framework version that the executable was compiled for.
69+
string version = FrameworkVersionHelper.GetTargetFrameworkVersion()
70+
// Fallback to the current running Framework version.
71+
?? FrameworkVersionHelper.GetLatestNetDeveloperPackVersion()
5772
?? FrameworkVersionHelper.GetFrameworkReleaseVersion(); // .NET Developer Pack is not installed
5873

59-
switch (version)
74+
return version switch
6075
{
61-
case "4.6.1": return Net461;
62-
case "4.6.2": return Net462;
63-
case "4.7": return Net47;
64-
case "4.7.1": return Net471;
65-
case "4.7.2": return Net472;
66-
case "4.8": return Net48;
67-
case "4.8.1": return Net481;
68-
default: // unlikely to happen but theoretically possible
69-
return new ClrRuntime(RuntimeMoniker.NotRecognized, $"net{version.Replace(".", null)}", $".NET Framework {version}");
70-
}
76+
"4.6.1" => Net461,
77+
"4.6.2" => Net462,
78+
"4.7" => Net47,
79+
"4.7.1" => Net471,
80+
"4.7.2" => Net472,
81+
"4.8" => Net48,
82+
"4.8.1" => Net481,
83+
// unlikely to happen but theoretically possible
84+
_ => new ClrRuntime(RuntimeMoniker.NotRecognized, $"net{version.Replace(".", null)}", $".NET Framework {version}"),
85+
};
7186
}
7287
}
7388
}

‎src/BenchmarkDotNet/Helpers/FrameworkVersionHelper.cs

Lines changed: 67 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
using System;
2+
using System.Collections.Generic;
3+
using System.Diagnostics;
24
using System.IO;
35
using System.Linq;
6+
using System.Reflection;
7+
using System.Runtime.Versioning;
48
using Microsoft.Win32;
59

610
namespace BenchmarkDotNet.Helpers
@@ -10,15 +14,65 @@ internal static class FrameworkVersionHelper
1014
// magic numbers come from https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed
1115
// should be ordered by release number
1216
private static readonly (int minReleaseNumber, string version)[] FrameworkVersions =
13-
{
17+
[
1418
(533320, "4.8.1"), // value taken from Windows 11 arm64 insider build
1519
(528040, "4.8"),
1620
(461808, "4.7.2"),
1721
(461308, "4.7.1"),
1822
(460798, "4.7"),
1923
(394802, "4.6.2"),
2024
(394254, "4.6.1")
21-
};
25+
];
26+
27+
internal static string? GetTargetFrameworkVersion()
28+
{
29+
// Search assemblies until we find a TargetFrameworkAttribute with a supported Framework version.
30+
// We don't search all assemblies, only the entry assembly and callers.
31+
foreach (var assembly in EnumerateAssemblies())
32+
{
33+
foreach (var attribute in assembly.GetCustomAttributes<TargetFrameworkAttribute>())
34+
{
35+
switch (attribute.FrameworkName)
36+
{
37+
case ".NETFramework,Version=v4.6.1": return "4.6.1";
38+
case ".NETFramework,Version=v4.6.2": return "4.6.2";
39+
case ".NETFramework,Version=v4.7": return "4.7";
40+
case ".NETFramework,Version=v4.7.1": return "4.7.1";
41+
case ".NETFramework,Version=v4.7.2": return "4.7.2";
42+
case ".NETFramework,Version=v4.8": return "4.8";
43+
case ".NETFramework,Version=v4.8.1": return "4.8.1";
44+
}
45+
}
46+
}
47+
48+
return null;
49+
50+
static IEnumerable<Assembly> EnumerateAssemblies()
51+
{
52+
var entryAssembly = Assembly.GetEntryAssembly();
53+
// Assembly.GetEntryAssembly() returns null in unit test frameworks.
54+
if (entryAssembly != null)
55+
{
56+
yield return entryAssembly;
57+
}
58+
// Search calling assemblies starting from the highest stack frame
59+
// (expected to be the entry assembly if Assembly.GetEntryAssembly() returned null),
60+
// excluding this assembly.
61+
var stacktrace = new StackTrace(false);
62+
var searchedAssemblies = new HashSet<Assembly>()
63+
{
64+
stacktrace.GetFrame(0).GetMethod().ReflectedType.Assembly
65+
};
66+
for (int i = stacktrace.FrameCount - 1; i >= 1 ; --i)
67+
{
68+
var assembly = stacktrace.GetFrame(i).GetMethod().ReflectedType.Assembly;
69+
if (searchedAssemblies.Add(assembly))
70+
{
71+
yield return assembly;
72+
}
73+
}
74+
}
75+
}
2276

2377
internal static string GetFrameworkDescription()
2478
{
@@ -57,30 +111,28 @@ internal static string MapToReleaseVersion(string servicingVersion)
57111

58112

59113
#if NET6_0_OR_GREATER
60-
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
114+
[SupportedOSPlatform("windows")]
61115
#endif
62116
private static int? GetReleaseNumberFromWindowsRegistry()
63117
{
64-
using (var baseKey = RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, RegistryView.Registry32))
65-
using (var ndpKey = baseKey.OpenSubKey(@"SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\"))
66-
{
67-
if (ndpKey == null)
68-
return null;
69-
return Convert.ToInt32(ndpKey.GetValue("Release"));
70-
}
118+
using var baseKey = RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, RegistryView.Registry32);
119+
using var ndpKey = baseKey.OpenSubKey(@"SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\");
120+
if (ndpKey == null)
121+
return null;
122+
return Convert.ToInt32(ndpKey.GetValue("Release"));
71123
}
72124

73125
#if NET6_0_OR_GREATER
74-
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
126+
[SupportedOSPlatform("windows")]
75127
#endif
76-
internal static string GetLatestNetDeveloperPackVersion()
128+
internal static string? GetLatestNetDeveloperPackVersion()
77129
{
78-
if (!(GetReleaseNumberFromWindowsRegistry() is int releaseNumber))
130+
if (GetReleaseNumberFromWindowsRegistry() is not int releaseNumber)
79131
return null;
80132

81133
return FrameworkVersions
82-
.FirstOrDefault(v => releaseNumber >= v.minReleaseNumber && IsDeveloperPackInstalled(v.version))
83-
.version;
134+
.FirstOrDefault(v => releaseNumber >= v.minReleaseNumber && IsDeveloperPackInstalled(v.version))
135+
.version;
84136
}
85137

86138
// Reference Assemblies exists when Developer Pack is installed

‎tests/BenchmarkDotNet.IntegrationTests.ManualRunning.MultipleFrameworks/MultipleFrameworksTest.cs

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,6 @@ public class MultipleFrameworksTest : BenchmarkTestExecutor
1818
[InlineData(RuntimeMoniker.Net80)]
1919
public void EachFrameworkIsRebuilt(RuntimeMoniker runtime)
2020
{
21-
#if NET461
22-
// We cannot detect what target framework version the host was compiled for on full Framework,
23-
// which causes the RoslynToolchain to be used instead of CsProjClassicNetToolchain when the host is full Framework
24-
// (because full Framework always uses the version that's installed on the machine, unlike Core),
25-
// which means if the machine has net48 installed (not net481), the net461 host with net48 runtime moniker
26-
// will not be recompiled, causing the test to fail.
27-
28-
// If we ever change the default toolchain to CsProjClassicNetToolchain instead of RoslynToolchain, we can remove this check.
29-
if (runtime == RuntimeMoniker.Net48)
30-
{
31-
// XUnit doesn't provide Assert.Skip API yet.
32-
return;
33-
}
34-
#endif
3521
var config = ManualConfig.CreateEmpty().AddJob(Job.Dry.WithRuntime(runtime.GetRuntime()).WithEnvironmentVariable(TfmEnvVarName, runtime.ToString()));
3622
CanExecute<ValuePerTfm>(config);
3723
}

0 commit comments

Comments
 (0)