Skip to content

Commit

Permalink
[BPI] Transfer value-handles when assign/move constructing BPI (llvm#…
Browse files Browse the repository at this point in the history
…77774)

Background: BPI stores a collection of edge branch-probabilities, and
also a set of Callback value-handles for the blocks in the
edge-collection. When a block is deleted, BPI's eraseBlock method is
called to clear the edge-collection of references to that block, to
avoid dangling pointers.

However, when move-constructing or assigning a BPI object, the
edge-collection gets moved, but the value-handles are discarded. This
can lead to to stale entries in the edge-collection when blocks are
deleted without the callback -- not normally a problem, but if a new
block is allocated with the same address as an old block, spurious
branch probabilities will be recorded about it. The fix is to transfer
the handles from the source BPI object.

This was exposed by an unrelated debug-info change, it probably just
shifted around allocation orders to expose this. Detected as
nondeterminism and reduced by Zequan Wu:

llvm@f1b0a54#commitcomment-136737090

(No test because IMHO testing for a behaviour that varies with memory
allocators is likely futile; I can add the reproducer with a CHECK for
the relevant branch weights if it's desired though)

(cherry picked from commit 604a6c4)
  • Loading branch information
jmorse authored and llvmbot committed Feb 5, 2024
1 parent 900e7cb commit 29a9171
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions llvm/include/llvm/Analysis/BranchProbabilityInfo.h
Original file line number Diff line number Diff line change
Expand Up @@ -122,16 +122,23 @@ class BranchProbabilityInfo {
}

BranchProbabilityInfo(BranchProbabilityInfo &&Arg)
: Probs(std::move(Arg.Probs)), LastF(Arg.LastF),
EstimatedBlockWeight(std::move(Arg.EstimatedBlockWeight)) {}
: Handles(std::move(Arg.Handles)), Probs(std::move(Arg.Probs)),
LastF(Arg.LastF),
EstimatedBlockWeight(std::move(Arg.EstimatedBlockWeight)) {
for (auto &Handle : Handles)
Handle.setBPI(this);
}

BranchProbabilityInfo(const BranchProbabilityInfo &) = delete;
BranchProbabilityInfo &operator=(const BranchProbabilityInfo &) = delete;

BranchProbabilityInfo &operator=(BranchProbabilityInfo &&RHS) {
releaseMemory();
Handles = std::move(RHS.Handles);
Probs = std::move(RHS.Probs);
EstimatedBlockWeight = std::move(RHS.EstimatedBlockWeight);
for (auto &Handle : Handles)
Handle.setBPI(this);
return *this;
}

Expand Down Expand Up @@ -279,6 +286,8 @@ class BranchProbabilityInfo {
}

public:
void setBPI(BranchProbabilityInfo *BPI) { this->BPI = BPI; }

BasicBlockCallbackVH(const Value *V, BranchProbabilityInfo *BPI = nullptr)
: CallbackVH(const_cast<Value *>(V)), BPI(BPI) {}
};
Expand Down

0 comments on commit 29a9171

Please sign in to comment.