Add DOTNET_ environment vars (#2643)

am11 · timcassell · web-flow · commit adf8e6d3e2ee · 2024-09-22T17:19:03.000-04:00
* Add DOTNET_ environment vars

* Update tests/BenchmarkDotNet.IntegrationTests/MemoryDiagnoserTests.cs

---------

Co-authored-by: Tim Cassell &lt;35501420+timcassell@users.noreply.github.com&gt;
diff --git a/samples/BenchmarkDotNet.Samples/IntroEnvVars.cs b/samples/BenchmarkDotNet.Samples/IntroEnvVars.cs
@@ -10,13 +10,14 @@ public class IntroEnvVars
     {
         private class ConfigWithCustomEnvVars : ManualConfig
         {
-            private const string JitNoInline = "COMPlus_JitNoInline";
-
             public ConfigWithCustomEnvVars()
             {
                 AddJob(Job.Default.WithRuntime(CoreRuntime.Core80).WithId("Inlining enabled"));
                 AddJob(Job.Default.WithRuntime(CoreRuntime.Core80)
-                    .WithEnvironmentVariables(new EnvironmentVariable(JitNoInline, "1"))
+                    .WithEnvironmentVariables([
+                        new EnvironmentVariable("DOTNET_JitNoInline", "1"),
+                        new EnvironmentVariable("COMPlus_JitNoInline", "1")
+                    ])
                     .WithId("Inlining disabled"));
             }
         }
@@ -27,4 +28,4 @@ public void Foo()
             // Benchmark body
         }
     }
-}
+}
diff --git a/src/BenchmarkDotNet/Extensions/ProcessExtensions.cs b/src/BenchmarkDotNet/Extensions/ProcessExtensions.cs
@@ -125,18 +125,18 @@ public static bool TrySetAffinity(
         internal static void SetEnvironmentVariables(this ProcessStartInfo start, BenchmarkCase benchmarkCase, IResolver resolver)
         {
             if (benchmarkCase.Job.Environment.Runtime is ClrRuntime clrRuntime && !string.IsNullOrEmpty(clrRuntime.Version))
-                start.EnvironmentVariables["COMPLUS_Version"] = clrRuntime.Version;
+                SetClrEnvironmentVariables(start, "Version", clrRuntime.Version);
 
             if (benchmarkCase.Job.Environment.Runtime is MonoRuntime monoRuntime && !string.IsNullOrEmpty(monoRuntime.MonoBclPath))
                 start.EnvironmentVariables["MONO_PATH"] = monoRuntime.MonoBclPath;
 
             if (benchmarkCase.Config.HasPerfCollectProfiler())
             {
                 // enable tracing configuration inside of CoreCLR (https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/linux-performance-tracing.md#collecting-a-trace)
-                start.EnvironmentVariables["COMPlus_PerfMapEnabled"] = "1";
-                start.EnvironmentVariables["COMPlus_EnableEventLog"] = "1";
+                SetClrEnvironmentVariables(start, "PerfMapEnabled", "1");
+                SetClrEnvironmentVariables(start, "EnableEventLog", "1");
                 // enable BDN Event Source (https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/linux-performance-tracing.md#filtering)
-                start.EnvironmentVariables["COMPlus_EventSourceFilter"] = EngineEventSource.SourceName;
+                SetClrEnvironmentVariables(start, "EventSourceFilter", EngineEventSource.SourceName);
                 // workaround for https://github.com/dotnet/runtime/issues/71786, will be solved by next perf version
                 start.EnvironmentVariables["DOTNET_EnableWriteXorExecute"] = "0";
             }
@@ -258,21 +258,27 @@ private static void SetCoreRunEnvironmentVariables(this ProcessStartInfo start,
         {
             var gcMode = benchmarkCase.Job.Environment.Gc;
 
-            start.EnvironmentVariables["COMPlus_gcServer"] = gcMode.ResolveValue(GcMode.ServerCharacteristic, resolver) ? "1" : "0";
-            start.EnvironmentVariables["COMPlus_gcConcurrent"] = gcMode.ResolveValue(GcMode.ConcurrentCharacteristic, resolver) ? "1" : "0";
+            SetClrEnvironmentVariables(start, "gcServer", gcMode.ResolveValue(GcMode.ServerCharacteristic, resolver) ? "1" : "0");
+            SetClrEnvironmentVariables(start, "gcConcurrent", gcMode.ResolveValue(GcMode.ConcurrentCharacteristic, resolver) ? "1" : "0");
 
             if (gcMode.HasValue(GcMode.CpuGroupsCharacteristic))
-                start.EnvironmentVariables["COMPlus_GCCpuGroup"] = gcMode.ResolveValue(GcMode.CpuGroupsCharacteristic, resolver) ? "1" : "0";
+                SetClrEnvironmentVariables(start, "GCCpuGroup", gcMode.ResolveValue(GcMode.CpuGroupsCharacteristic, resolver) ? "1" : "0");
             if (gcMode.HasValue(GcMode.AllowVeryLargeObjectsCharacteristic))
-                start.EnvironmentVariables["COMPlus_gcAllowVeryLargeObjects"] = gcMode.ResolveValue(GcMode.AllowVeryLargeObjectsCharacteristic, resolver) ? "1" : "0";
+                SetClrEnvironmentVariables(start, "gcAllowVeryLargeObjects", gcMode.ResolveValue(GcMode.AllowVeryLargeObjectsCharacteristic, resolver) ? "1" : "0");
             if (gcMode.HasValue(GcMode.RetainVmCharacteristic))
-                start.EnvironmentVariables["COMPlus_GCRetainVM"] = gcMode.ResolveValue(GcMode.RetainVmCharacteristic, resolver) ? "1" : "0";
+                SetClrEnvironmentVariables(start, "GCRetainVM", gcMode.ResolveValue(GcMode.RetainVmCharacteristic, resolver) ? "1" : "0");
             if (gcMode.HasValue(GcMode.NoAffinitizeCharacteristic))
-                start.EnvironmentVariables["COMPlus_GCNoAffinitize"] = gcMode.ResolveValue(GcMode.NoAffinitizeCharacteristic, resolver) ? "1" : "0";
+                SetClrEnvironmentVariables(start, "GCNoAffinitize", gcMode.ResolveValue(GcMode.NoAffinitizeCharacteristic, resolver) ? "1" : "0");
             if (gcMode.HasValue(GcMode.HeapAffinitizeMaskCharacteristic))
-                start.EnvironmentVariables["COMPlus_GCHeapAffinitizeMask"] = gcMode.HeapAffinitizeMask.ToString("X");
+                SetClrEnvironmentVariables(start, "GCHeapAffinitizeMask", gcMode.HeapAffinitizeMask.ToString("X"));
             if (gcMode.HasValue(GcMode.HeapCountCharacteristic))
-                start.EnvironmentVariables["COMPlus_GCHeapCount"] = gcMode.HeapCount.ToString("X");
+                SetClrEnvironmentVariables(start, "GCHeapCount", gcMode.HeapCount.ToString("X"));
+        }
+
+        private static void SetClrEnvironmentVariables(ProcessStartInfo start, string suffix, string value)
+        {
+            start.EnvironmentVariables[$"DOTNET_{suffix}"] = value;
+            start.EnvironmentVariables[$"COMPlus_{suffix}"] = value;
         }
     }
 }
diff --git a/tests/BenchmarkDotNet.IntegrationTests/MemoryDiagnoserTests.cs b/tests/BenchmarkDotNet.IntegrationTests/MemoryDiagnoserTests.cs
@@ -321,7 +321,11 @@ private IConfig CreateConfig(IToolchain toolchain)
                     .WithGcForce(false)
                     .WithGcServer(false)
                     .WithGcConcurrent(false)
-                    .WithEnvironmentVariable("COMPlus_TieredCompilation", "0") // Tiered JIT can allocate some memory on a background thread, let's disable it to make our tests less flaky (#1542)
+                    .WithEnvironmentVariables([
+                        // Tiered JIT can allocate some memory on a background thread, let's disable it to make our tests less flaky (#1542)
+                        new EnvironmentVariable("DOTNET_TieredCompilation", "0"),
+                        new EnvironmentVariable("COMPlus_TieredCompilation", "0")
+                    ])
                     .WithToolchain(toolchain))
                 .AddColumnProvider(DefaultColumnProviders.Instance)
                 .AddDiagnoser(MemoryDiagnoser.Default)

Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,14 @@ public class IntroEnvVars`
`10`	`10`	`{`
`11`	`11`	`private class ConfigWithCustomEnvVars : ManualConfig`
`12`	`12`	`{`
`13`		`- private const string JitNoInline = "COMPlus_JitNoInline";`
`14`		`-`
`15`	`13`	`public ConfigWithCustomEnvVars()`
`16`	`14`	`{`
`17`	`15`	`AddJob(Job.Default.WithRuntime(CoreRuntime.Core80).WithId("Inlining enabled"));`
`18`	`16`	`AddJob(Job.Default.WithRuntime(CoreRuntime.Core80)`
`19`		`- .WithEnvironmentVariables(new EnvironmentVariable(JitNoInline, "1"))`
	`17`	`+ .WithEnvironmentVariables([`
	`18`	`+ new EnvironmentVariable("DOTNET_JitNoInline", "1"),`
	`19`	`+ new EnvironmentVariable("COMPlus_JitNoInline", "1")`
	`20`	`+ ])`
`20`	`21`	`.WithId("Inlining disabled"));`
`21`	`22`	`}`
`22`	`23`	`}`
`@@ -27,4 +28,4 @@ public void Foo()`
`27`	`28`	`// Benchmark body`
`28`	`29`	`}`
`29`	`30`	`}`
`30`		`-}`
	`31`	`+}`