Skip to content
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

Fix parallel builds #2563

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 36 additions & 12 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs
Original file line number Diff line number Diff line change
Expand Up @@ -372,42 +372,68 @@ private static ImmutableArray<ValidationError> Validate(params BenchmarkRunInfo[

private static Dictionary<BuildPartition, BuildResult> BuildInParallel(ILogger logger, string rootArtifactsFolderPath, BuildPartition[] buildPartitions, in StartedClock globalChronometer, EventProcessor eventProcessor)
{
logger.WriteLineHeader($"// ***** Building {buildPartitions.Length} exe(s) in Parallel: Start *****");
var parallelPartitions = new List<(BuildPartition buildPartition, IToolchain toolchain, bool isSequential)[]>();
var sequentialPartitions = new List<(BuildPartition, IToolchain, bool)>();
foreach (var partition in buildPartitions)
{
// It's guaranteed that all the benchmarks in single partition have same toolchain.
var toolchain = partition.RepresentativeBenchmarkCase.GetToolchain();
// #2425
if (toolchain.IsSafeToBuildInParallel())
parallelPartitions.Add([(partition, toolchain, false)]);
else
sequentialPartitions.Add((partition, toolchain, true));
}
if (sequentialPartitions.Count > 0)
{
// We build the sequential partitions in parallel with the other partitions to complete as fast as possible.
// Place them first to make sure they are started first.
parallelPartitions.Insert(0, [.. sequentialPartitions]);
}

var buildLogger = buildPartitions.Length == 1 ? logger : NullLogger.Instance; // when we have just one partition we can print to std out
logger.WriteLineHeader($"// ***** Building {parallelPartitions.Count} exe(s) in Parallel{(sequentialPartitions.Count <= 1 ? "" : $", {sequentialPartitions.Count} sequentially")} *****");

var buildLogger = parallelPartitions.Count == 1 ? logger : NullLogger.Instance; // when we have just one parallel partition we can print to std out

var beforeParallelBuild = globalChronometer.GetElapsed();

var buildResults = buildPartitions
var parallelBuildResults = parallelPartitions
.AsParallel()
.Select(buildPartition => (Partition: buildPartition, Result: Build(buildPartition, rootArtifactsFolderPath, buildLogger)))
.SelectMany(partitions => partitions
.Select(build => (Partition: build.buildPartition,
Result: Build(build.buildPartition, build.toolchain, rootArtifactsFolderPath, buildLogger),
WasSequential: build.isSequential)
)
)
.AsSequential() // Ensure that build completion events are processed sequentially
.Select(build =>
{
// If the generation was successful, but the build was not, we will try building sequentially
// so don't send the OnBuildComplete event yet.
if (buildPartitions.Length <= 1 || !build.Result.IsGenerateSuccess || build.Result.IsBuildSuccess)
if (build.WasSequential || buildPartitions.Length <= 1 || !build.Result.IsGenerateSuccess || build.Result.IsBuildSuccess)
eventProcessor.OnBuildComplete(build.Partition, build.Result);

return build;
})
.ToDictionary(build => build.Partition, build => build.Result);
.ToArray();

var afterParallelBuild = globalChronometer.GetElapsed();

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

if (buildPartitions.Length <= 1 || !buildResults.Values.Any(result => result.IsGenerateSuccess && !result.IsBuildSuccess))
var buildResults = parallelBuildResults.ToDictionary(build => build.Partition, build => build.Result);

if (parallelPartitions.Count <= 1 || !parallelBuildResults.Any(build => !build.WasSequential && build.Result.IsGenerateSuccess && !build.Result.IsBuildSuccess))
return buildResults;

logger.WriteLineHeader("// ***** Failed to build in Parallel, switching to sequential build *****");

foreach (var buildPartition in buildPartitions)
foreach (var (buildPartition, toolchain, _) in parallelPartitions.Skip(1).Select(arr => arr[0]))
{
if (buildResults[buildPartition].IsGenerateSuccess && !buildResults[buildPartition].IsBuildSuccess)
{
if (!buildResults[buildPartition].TryToExplainFailureReason(out string _))
buildResults[buildPartition] = Build(buildPartition, rootArtifactsFolderPath, buildLogger);
buildResults[buildPartition] = Build(buildPartition, toolchain, rootArtifactsFolderPath, buildLogger);

eventProcessor.OnBuildComplete(buildPartition, buildResults[buildPartition]);
}
Expand All @@ -423,10 +449,8 @@ static string GetFormattedDifference(ClockSpan before, ClockSpan after)
=> (after.GetTimeSpan() - before.GetTimeSpan()).ToFormattedTotalTime(DefaultCultureInfo.Instance);
}

private static BuildResult Build(BuildPartition buildPartition, string rootArtifactsFolderPath, ILogger buildLogger)
private static BuildResult Build(BuildPartition buildPartition, IToolchain toolchain, string rootArtifactsFolderPath, ILogger buildLogger)
{
var toolchain = buildPartition.RepresentativeBenchmarkCase.GetToolchain(); // it's guaranteed that all the benchmarks in single partition have same toolchain

var generateResult = toolchain.Generator.GenerateProject(buildPartition, buildLogger, rootArtifactsFolderPath);

try
Expand Down
4 changes: 2 additions & 2 deletions src/BenchmarkDotNet/Toolchains/CsProj/CsProjGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public class CsProjGenerator : DotNetCliGenerator, IEquatable<CsProjGenerator>

public string RuntimeFrameworkVersion { get; }

public CsProjGenerator(string targetFrameworkMoniker, string cliPath, string packagesPath, string runtimeFrameworkVersion, bool isNetCore = true)
: base(targetFrameworkMoniker, cliPath, packagesPath, isNetCore)
public CsProjGenerator(string targetFrameworkMoniker, string cliPath, string packagesPath, string runtimeFrameworkVersion, bool isNetCore = true, bool useArtifactsPathIfSupported = true)
: base(targetFrameworkMoniker, cliPath, packagesPath, isNetCore, useArtifactsPathIfSupported)
{
RuntimeFrameworkVersion = runtimeFrameworkVersion;
}
Expand Down
24 changes: 17 additions & 7 deletions src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,33 @@

namespace BenchmarkDotNet.Toolchains.DotNetCli
{
[PublicAPI]
public class DotNetCliBuilder : IBuilder
public abstract class DotNetCliBuilderBase : IBuilder
{
private string TargetFrameworkMoniker { get; }
public string? CustomDotNetCliPath { get; protected set; }
internal bool UseArtifactsPathIfSupported { get; private protected set; } = true;
public abstract BuildResult Build(GenerateResult generateResult, BuildPartition buildPartition, ILogger logger);
}

private string CustomDotNetCliPath { get; }
[PublicAPI]
public class DotNetCliBuilder : DotNetCliBuilderBase
{
private bool LogOutput { get; }

[PublicAPI]
public DotNetCliBuilder(string targetFrameworkMoniker, string? customDotNetCliPath = null, bool logOutput = false)
{
TargetFrameworkMoniker = targetFrameworkMoniker;
CustomDotNetCliPath = customDotNetCliPath;
LogOutput = logOutput;
}

public BuildResult Build(GenerateResult generateResult, BuildPartition buildPartition, ILogger logger)
internal DotNetCliBuilder(string? customDotNetCliPath, bool logOutput, bool useArtifactsPathIfSupported)
{
CustomDotNetCliPath = customDotNetCliPath;
LogOutput = logOutput;
UseArtifactsPathIfSupported = useArtifactsPathIfSupported;
}

public override BuildResult Build(GenerateResult generateResult, BuildPartition buildPartition, ILogger logger)
{
BuildResult buildResult = new DotNetCliCommand(
CustomDotNetCliPath,
Expand All @@ -34,7 +44,7 @@ public BuildResult Build(GenerateResult generateResult, BuildPartition buildPart
Array.Empty<EnvironmentVariable>(),
buildPartition.Timeout,
logOutput: LogOutput)
.RestoreThenBuild();
.RestoreThenBuild(UseArtifactsPathIfSupported);
if (buildResult.IsBuildSuccess &&
buildPartition.RepresentativeBenchmarkCase.Job.Environment.LargeAddressAware)
{
Expand Down