Skip to content

feat: Add option to disable parallel build #2725

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.

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

Merged
merged 3 commits into from
May 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion src/BenchmarkDotNet/Configs/ConfigOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ public enum ConfigOptions
/// <summary>
/// Continue the execution if the last run was stopped.
/// </summary>
Resume = 1 << 9
Resume = 1 << 9,
/// <summary>
/// Determines whether parallel build of benchmark projects should be disabled.
/// </summary>
DisableParallelBuild = 1 << 10,
}

internal static class ConfigOptionsExtensions
Expand Down
53 changes: 48 additions & 5 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,32 @@ internal static Summary[] Run(BenchmarkRunInfo[] benchmarkRunInfos)
var globalChronometer = Chronometer.Start();


var buildPartitions = BenchmarkPartitioner.CreateForBuild(supportedBenchmarks, resolver);
eventProcessor.OnStartBuildStage(buildPartitions);
var buildResults = BuildInParallel(compositeLogger, rootArtifactsFolderPath, buildPartitions, in globalChronometer, eventProcessor);
var parallelBuildBenchmarks = supportedBenchmarks.Where(x => !x.Config.Options.IsSet(ConfigOptions.DisableParallelBuild)).ToArray();
var parallelBuildPartitions = BenchmarkPartitioner.CreateForBuild(parallelBuildBenchmarks, resolver);

var sequentialBuildBenchmarks = supportedBenchmarks.Where(x => x.Config.Options.IsSet(ConfigOptions.DisableParallelBuild)).ToArray();
var sequentialBuildPartitions = BenchmarkPartitioner.CreateForBuild(sequentialBuildBenchmarks, resolver);

eventProcessor.OnStartBuildStage([.. parallelBuildPartitions, .. sequentialBuildPartitions]);

var buildResults = new Dictionary<BuildPartition, BuildResult>();
if (parallelBuildBenchmarks.Length > 0)
{
var results = BuildInParallel(compositeLogger, rootArtifactsFolderPath, parallelBuildPartitions, in globalChronometer, eventProcessor);
foreach (var kvp in results)
{
buildResults.Add(kvp.Key, kvp.Value);
}
}

if (sequentialBuildBenchmarks.Length > 0)
{
var results = BuildSequential(compositeLogger, rootArtifactsFolderPath, sequentialBuildPartitions, in globalChronometer, eventProcessor);
foreach (var kvp in results)
{
buildResults.Add(kvp.Key, kvp.Value);
}
}

var allBuildsHaveFailed = buildResults.Values.All(buildResult => !buildResult.IsBuildSuccess);

Expand Down Expand Up @@ -408,10 +431,30 @@ private static Dictionary<BuildPartition, BuildResult> BuildInParallel(ILogger l
logger.WriteLineHeader($"// ***** Done, took {GetFormattedDifference(afterParallelBuild, afterSequentialBuild)} *****");

return buildResults;
}

private static Dictionary<BuildPartition, BuildResult> BuildSequential(ILogger logger, string rootArtifactsFolderPath, BuildPartition[] buildPartitions, in StartedClock globalChronometer, EventProcessor eventProcessor)
{
logger.WriteLineHeader($"// ***** Building {buildPartitions.Length} exe(s) in Sequential: Start *****");

var beforeBuild = globalChronometer.GetElapsed();

var buildResults = new Dictionary<BuildPartition, BuildResult>();
foreach (var buildPartition in buildPartitions)
{
buildResults[buildPartition] = Build(buildPartition, rootArtifactsFolderPath, logger);
eventProcessor.OnBuildComplete(buildPartition, buildResults[buildPartition]);
}

var afterBuild = globalChronometer.GetElapsed();

logger.WriteLineHeader($"// ***** Done, took {GetFormattedDifference(beforeBuild, afterBuild)} *****");

return buildResults;
}

static string GetFormattedDifference(ClockSpan before, ClockSpan after)
private static string GetFormattedDifference(ClockSpan before, ClockSpan after)
=> (after.GetTimeSpan() - before.GetTimeSpan()).ToFormattedTotalTime(DefaultCultureInfo.Instance);
}

private static BuildResult Build(BuildPartition buildPartition, string rootArtifactsFolderPath, ILogger buildLogger)
{
Expand Down