Skip to content

Add CancellationToken support to synchronous benchmark runner APIs #3213

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

Merged
timcassell merged 2 commits into from
Jul 31, 2026
+54 −24
Merged

Add CancellationToken support to synchronous benchmark runner APIs #3213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
673e979
Add CancellationToken support to synchronous benchmark runner APIs
Farhaz565 Jul 29, 2026
58c2be2
Fix indentation
Farhaz565 Jul 30, 2026
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
66 changes: 48 additions & 18 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerDirty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,54 +15,81 @@ namespace BenchmarkDotNet.Running
public static class BenchmarkRunner
{
[PublicAPI]
public static Summary Run<T>(IConfig? config = null, string[]? args = null)
public static Summary Run<T>(
IConfig? config = null,
string[]? args = null,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync<T>(config, args));
return context.ExecuteUntilComplete(
RunAsync<T>(config, args, cancellationToken));
}

[PublicAPI]
public static Summary Run(Type type, IConfig? config = null, string[]? args = null)
public static Summary Run(
Type type,
IConfig? config = null,
string[]? args = null,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(type, config, args));
return context.ExecuteUntilComplete(
RunAsync(type, config, args, cancellationToken));
}

[PublicAPI]
public static Summary[] Run(Type[] types, IConfig? config = null, string[]? args = null)
public static Summary[] Run(
Type[] types,
IConfig? config = null,
string[]? args = null,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(types, config, args));
return context.ExecuteUntilComplete(
RunAsync(types, config, args, cancellationToken));
}

[PublicAPI]
public static Summary Run(Type type, MethodInfo[] methods, IConfig? config = null)
public static Summary Run(
Type type,
MethodInfo[] methods,
IConfig? config = null,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(type, methods, config));
return context.ExecuteUntilComplete(
RunAsync(type, methods, config, cancellationToken));
}

[PublicAPI]
public static Summary[] Run(Assembly assembly, IConfig? config = null, string[]? args = null)
public static Summary[] Run(
Assembly assembly,
IConfig? config = null,
string[]? args = null,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(assembly, config, args));
return context.ExecuteUntilComplete(
RunAsync(assembly, config, args, cancellationToken));
}

[PublicAPI]
public static Summary Run(BenchmarkRunInfo benchmarkRunInfo)
public static Summary Run(BenchmarkRunInfo benchmarkRunInfo, CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(benchmarkRunInfo));
return context.ExecuteUntilComplete(
RunAsync(benchmarkRunInfo, cancellationToken));
}

[PublicAPI]
public static Summary[] Run(BenchmarkRunInfo[] benchmarkRunInfos)
public static Summary[] Run(
BenchmarkRunInfo[] benchmarkRunInfos,
CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(benchmarkRunInfos));
return context.ExecuteUntilComplete(
RunAsync(benchmarkRunInfos, cancellationToken));
}

[PublicAPI]
public static ValueTask<Summary> RunAsync<T>(IConfig? config = null, string[]? args = null, CancellationToken cancellationToken = default)
=> RunAsync(typeof(T), config, args, cancellationToken);
Expand Down Expand Up @@ -102,10 +129,13 @@ public static async ValueTask<Summary[]> RunAsync(Assembly assembly, IConfig? co
return await RunWithExceptionHandling(() => RunWithDirtyAssemblyResolveHelper(assembly, config, args, cancellationToken)).ConfigureAwait(false);
}
}

[PublicAPI]
public static async ValueTask<Summary> RunAsync(BenchmarkRunInfo benchmarkRunInfo)
=> (await RunAsync([benchmarkRunInfo]).ConfigureAwait(false)).Single();
public static async ValueTask<Summary> RunAsync(
BenchmarkRunInfo benchmarkRunInfo,
CancellationToken cancellationToken = default)

@timcassell timcassell Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good catch. 👍

=> (await RunAsync([benchmarkRunInfo], cancellationToken)
.ConfigureAwait(false))
.Single();

[PublicAPI]
public static async ValueTask<Summary[]> RunAsync(BenchmarkRunInfo[] benchmarkRunInfos, CancellationToken cancellationToken = default)
Expand Down
12 changes: 6 additions & 6 deletions src/BenchmarkDotNet/Running/BenchmarkSwitcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,27 @@ public class BenchmarkSwitcher
/// Run all available benchmarks.
/// </summary>
[PublicAPI]
public IEnumerable<Summary> RunAll(IConfig? config = null, string[]? args = null)
public IEnumerable<Summary> RunAll(IConfig? config = null, string[]? args = null, CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAllAsync(config, args));
return context.ExecuteUntilComplete(RunAllAsync(config, args, cancellationToken));
}

/// <summary>
/// Run all available benchmarks and join them to a single summary
/// </summary>
[PublicAPI]
public Summary RunAllJoined(IConfig? config = null, string[]? args = null)
public Summary RunAllJoined(IConfig? config = null, string[]? args = null, CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAllJoinedAsync(config, args));
return context.ExecuteUntilComplete(RunAllJoinedAsync(config, args, cancellationToken));
}

[PublicAPI]
public IEnumerable<Summary> Run(string[]? args = null, IConfig? config = null)
public IEnumerable<Summary> Run(string[]? args = null, IConfig? config = null, CancellationToken cancellationToken = default)
{
using var context = BenchmarkSynchronizationContext.CreateAndSetCurrent();
return context.ExecuteUntilComplete(RunAsync(args, config));
return context.ExecuteUntilComplete(RunAsync(args, config, cancellationToken));
}

/// <summary>
Expand Down