-
Notifications
You must be signed in to change notification settings - Fork 13.4k
[LoopPeel] Fix branch weights' effect on block frequencies #128785
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
base: main
Are you sure you want to change the base?
Conversation
be2ad30
to
cec331a
Compare
cec331a
to
843b4cf
Compare
✅ With the latest revision this PR passed the C/C++ code formatter. |
843b4cf
to
9d72e03
Compare
For example: ``` declare void @f(i32) define void @test(i32 %n) { entry: br label %do.body do.body: %i = phi i32 [ 0, %entry ], [ %inc, %do.body ] %inc = add i32 %i, 1 call void @f(i32 %i) %c = icmp sge i32 %inc, %n br i1 %c, label %do.end, label %do.body, !prof !0 do.end: ret void } !0 = !{!"branch_weights", i32 1, i32 9} ``` Given those branch weights, once any loop iteration is actually reached, the probability of the loop exiting at the iteration's end is 1/(1+9). That is, the loop is likely to exit every 10 iterations and thus has an estimated trip count of 10. `opt -passes='print<block-freq>'` shows that 10 is indeed the frequency of the loop body: ``` Printing analysis results of BFI for function 'test': block-frequency-info: test - entry: float = 1.0, int = 1801439852625920 - do.body: float = 10.0, int = 18014398509481984 - do.end: float = 1.0, int = 1801439852625920 ``` Key Observation: The frequency of reaching any particular iteration is less than for the previous iteration because the previous iteration has a non-zero probability of exiting the loop. This observation holds even though every loop iteration, once actually reached, has exactly the same probability of exiting and thus exactly the same branch weights. Now we use `opt -unroll-force-peel-count=2 -passes=loop-unroll` to peel 2 iterations and insert them before the remaining loop. We expect the key observation above not to change, but it does under the implementation without this patch. The block frequency becomes 1.0 for the first iteration, 0.9 for the second, and 6.4 for the main loop body. Again, a decreasing frequency is expected, but it decreases too much: the total frequency of the original loop body becomes 8.3. The new branch weights reveal the problem: ``` !0 = !{!"branch_weights", i32 1, i32 9} !1 = !{!"branch_weights", i32 1, i32 8} !2 = !{!"branch_weights", i32 1, i32 7} ``` The exit probability is now 1/10 for the first peeled iteration, 1/9 for the second, and 1/8 for the remaining loop iterations. It seems this behavior is trying to ensure a decreasing block frequency. However, as in the key observation above for the original loop, that happens correctly without decreasing the branch weights across iterations. This patch changes the peeling implementation not to decrease the branch weights across loop iterations so that the frequency for every iteration is the same as it was in the original loop. The total frequency of the loop body, summed across all its occurrences, thus remains 10 after peeling. Unfortunately, that change means a later analysis cannot accurately estimate the trip count of the remaining loop while examining the remaining loop in isolation without considering the probability of actually reaching it. For that purpose, this patch stores the new trip count as separate metadata named `llvm.loop.estimated_trip_count` and extends `llvm::getLoopEstimatedTripCount` to prefer it, if present, over branch weights. An alternative fix is for `llvm::getLoopEstimatedTripCount` to subtract the `llvm.loop.peeled.count` metadata from the trip count estimated by a loop's branch weights. However, there might be other loop transformations that still corrupt block frequencies in a similar manner and require a similar fix. `llvm.loop.estimated_trip_count` is intended to provide a general way to store estimated trip counts when branch weights cannot directly store them. This patch introduces several fixme comments that need to be addressed before it can land.
9d72e03
to
f413520
Compare
@@ -7866,6 +7866,17 @@ The attributes in this metadata is added to all followup loops of the | |||
loop distribution pass. See | |||
:ref:`Transformation Metadata <transformation-metadata>` for details. | |||
|
|||
'``llvm.loop.estimated_trip_count``' Metadata | |||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should explain where it should be attached. What if it's not placed on an arbitrary terminator that isn't a loop backed? Consequences for it being incorrect?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should explain where it should be attached. What if it's not placed on an arbitrary terminator that isn't a loop backed?
The llvm.loop
metadata description explains placement generally for all llvm.loop.*
metadata. I've also added an example in the same manner as the docs I see for other llvm.loop.*
metadata.
Consequences for it being incorrect?
I've added a description of how it's consumed.
llvm/docs/LangRef.rst
Outdated
This metadata records the loop's estimated trip count. If it is not present, a | ||
loop's estimated trip count should be computed from any ``branch_weights`` | ||
metadata attached to the latch block's branch instruction. | ||
|
||
Thus, this metadata frees loop transformations to compute latch branch weights | ||
solely for the purpose of maintaining accurate block frequencies instead of | ||
requiring the branch weights to always serve both roles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reads as more background information rather than a direct description of the meaning of the metadata
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added some text about the semantics.
@@ -7866,6 +7866,17 @@ The attributes in this metadata is added to all followup loops of the | |||
loop distribution pass. See | |||
:ref:`Transformation Metadata <transformation-metadata>` for details. | |||
|
|||
'``llvm.loop.estimated_trip_count``' Metadata |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why _s? Most of the existing metadata use . separators
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the other loop metadata, I understood .
to separate levels in a naming hierarchy while _
separates words in a single level's name.
For example: ‘llvm.loop.unroll_and_jam.count’ Metadata
I didn't think of any way to break estimated_trip_count
apart into a meaningful hierarchy.
Thanks for reviewing. I'll work on your other comments.
[LoopPeel] Fix branch weights' effect on block frequencies
This patch implements the LoopPeel changes discussed in [RFC] Fix Loop Transformations to Preserve Block Frequencies.
In summary, a loop's latch block can have branch weight metadata that encodes an estimated trip count that is derived from application profile data. Initially, the loop body's block frequencies agree with the estimated trip count, as expected. However, sometimes loop transformations adjust those branch weights in a way that correctly maintains the estimated trip count but that corrupts the block frequencies. This patch addresses that problem in LoopPeel, which it changes to:
llvm.loop.estimated_trip_count
.llvm::getLoopEstimatedTripCount
to prefer that metadata, if present, over branch weights.This patch introduces several fixme comments that need to be addressed before it can land.