Skip to content

docs: mention Jitting phase in How it works #2942

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 3 commits into from
Jan 4, 2026
+15 −0
Merged

docs: mention Jitting phase in How it works #2942

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d3a0ed
docs: mention Jitting phase in How it works
fuguiKz Dec 26, 2025
65f7665
docs: add JittingStage to pseudocode
fuguiKz Dec 26, 2025
8ad3f75
Update docs/articles/guides/how-it-works.md
timcassell Jan 4, 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
7 changes: 7 additions & 0 deletions docs/articles/guides/how-it-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ BenchmarkDotNet follows the following steps to run your benchmarks:
2. Next, we take each method/job/params combination and try to measure its performance by launching benchmark process several times (`LaunchCount`).
3. An invocation of the workload method is an *operation*. A bunch of operation is an *iteration*. If you have an `IterationSetup` method, it will be invoked before each iteration,
but not between operations. We have the following type of iterations:
* `Jitting`: The overhead/workload methods are invoked to ensure they are JIT-compiled (and on tiered runtimes, to promote them when possible). These iterations are not used for measurements.
* `Pilot`: The best operation count will be chosen.
* `OverheadWarmup`, `OverheadWorkload`: BenchmarkDotNet overhead will be evaluated.
* `ActualWarmup`: Warmup of the workload method.
Expand Down Expand Up @@ -35,6 +36,7 @@ IEnumerable<Results> Run(Benchmark benchmark)
Result ActualRun(Method method, Job job)
{
GlobalSetup();
JittingStage(method); // triggers JIT compilation (and tiering if enabled) before Pilot/Warmup

int unrollFactor = job.Run.UnrollFactor; // 16 by default

Expand All @@ -54,6 +56,11 @@ Result ActualRun(Method method, Job job)
return (result - Median(overhead), gcStats);
}

void JittingStage(Method method)
{
RunIteration(method, invokeCount: 1, unrollFactor: 1);
}

long Pilot(Method method, int unrollFactor)
{
// invokeCount is the equivalent of InnerIterationCount from xunit-performance
Expand Down