Skip to content

[Bug Fix] High Performance Plan Fix #2485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

[Bug Fix] High Performance Plan Fix #2485

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb2b3cf
Fixes #2319
MattFromRVA Dec 15, 2023
1d7f905
Revert code. Add tests
MattFromRVA Jul 16, 2025
632e769
Added code fix
MattFromRVA Jul 22, 2025
0619dc5
Adjust runner to keep Ultimate power plan if power plan is not specified
MattFromRVA Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,24 @@ private static Summary Run(BenchmarkRunInfo benchmarkRunInfo,
{
var benchmark = benchmarks[i];

powerManagementApplier.ApplyPerformancePlan(benchmark.Job.Environment.PowerPlanMode
?? benchmark.Job.ResolveValue(EnvironmentMode.PowerPlanModeCharacteristic, EnvironmentResolver.Instance).GetValueOrDefault());
bool userExplicitlySetPlan = benchmark.Job.HasValue(EnvironmentMode.PowerPlanModeCharacteristic);

var requestedPlan = benchmark.Job.Environment.PowerPlanMode
?? benchmark.Job.ResolveValue(EnvironmentMode.PowerPlanModeCharacteristic, EnvironmentResolver.Instance).GetValueOrDefault();

// If the plan is not explicitly set and would downgrade Ultimate, skip changing
if (!userExplicitlySetPlan && requestedPlan == PowerManagementApplier.Map(PowerPlan.HighPerformance))
{
var ultimateGuid = PowerManagementApplier.Map(PowerPlan.UltimatePerformance);
var currentPlan = PowerManagementHelper.CurrentPlan;
if (currentPlan.HasValue && currentPlan.Value == ultimateGuid)
{
logger.WriteLineInfo("Already on Ultimate Performance; not switching to High Performance since no plan explicitly set in Job.");
continue;
Copy link
Collaborator

@timcassell timcassell Jul 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't work, you're skipping the entire benchmark here. You should rather invert the branches, or move it to another function.

}
}

powerManagementApplier.ApplyPerformancePlan(requestedPlan);

var info = buildResults[benchmark];
var buildResult = info.buildResult;
Expand Down
46 changes: 21 additions & 25 deletions tests/BenchmarkDotNet.IntegrationTests/PowerManagementApplierTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
using BenchmarkDotNet.Environments;
using BenchmarkDotNet.Configs;
using BenchmarkDotNet.Environments;
using BenchmarkDotNet.Helpers;
using BenchmarkDotNet.Jobs;
using BenchmarkDotNet.Running;
using BenchmarkDotNet.Tests.Loggers;
using BenchmarkDotNet.Tests.XUnit;
Expand Down Expand Up @@ -43,43 +45,37 @@ public void TestPowerPlanShouldNotChange()
Assert.Equal(userPlan, PowerManagementHelper.CurrentPlan);
}

[FactEnvSpecific("Should change to High Performance if user requests it and High Performance plan is present, even if currently on Ultimate Performance", EnvRequirement.WindowsOnly)]
public void ShouldSwitchToHighPerformanceIfPresentWhenRequestedEvenIfOnUltimate()
[FactEnvSpecific("Should keep power plan at Ultimate Performance if current power plan is Ultimate when a power plan is not specifically set", EnvRequirement.WindowsOnly)]
public void TestKeepingUltimatePowerPlan()
{
var ultimateGuid = PowerManagementApplier.Map(PowerPlan.UltimatePerformance);
var highGuid = PowerManagementApplier.Map(PowerPlan.HighPerformance);
var userPlan = PowerManagementHelper.CurrentPlan;

var logger = new OutputLogger(Output);
var powerManagementApplier = new PowerManagementApplier(logger);
if (!PowerManagementHelper.PlanExists(ultimateGuid))
{
Output.WriteLine("Ultimate Performance plan does not exist or cannot be activated. Skipping test.");
return;
}

PowerManagementHelper.Set(ultimateGuid);

powerManagementApplier.ApplyPerformancePlan(highGuid);
var job = Job.Default;

Assert.Equal(highGuid.ToString(), PowerManagementHelper.CurrentPlan.ToString());
var config = ManualConfig.CreateEmpty().AddJob(job);

BenchmarkRunner.Run<DummyBenchmark>(config);

Assert.Equal(ultimateGuid.ToString(), PowerManagementHelper.CurrentPlan.ToString());

PowerManagementHelper.Set(userPlan.Value);
powerManagementApplier.Dispose();
}

[FactEnvSpecific("Should not change plan if already High Performance", EnvRequirement.WindowsOnly)]
public void ShouldNotChangeIfAlreadyHighPerformance()
public class DummyBenchmark
{
var highGuid = PowerManagementApplier.Map(PowerPlan.HighPerformance);
var userPlan = PowerManagementHelper.CurrentPlan;

var logger = new OutputLogger(Output);
var powerManagementApplier = new PowerManagementApplier(logger);

PowerManagementHelper.Set(highGuid);

powerManagementApplier.ApplyPerformancePlan(highGuid);

Assert.Equal(highGuid.ToString(), PowerManagementHelper.CurrentPlan.ToString());

PowerManagementHelper.Set(userPlan.Value);
powerManagementApplier.Dispose();
[BenchmarkDotNet.Attributes.Benchmark]
public void DoNothing()
{
}
}
}
}
Loading