Fix an overflow bug in MachineBranchProbabilityInfo. This pass relied on
authorChandler Carruth <chandlerc@gmail.com>
Mon, 14 Nov 2011 08:50:16 +0000 (08:50 +0000)
committerChandler Carruth <chandlerc@gmail.com>
Mon, 14 Nov 2011 08:50:16 +0000 (08:50 +0000)
commit2770c141856eefda6a192622bf5fd5b06bef4963
tree8d91e1c1d623b3040323b1817f26ff53348e6dac
parentdcce244dd85ec410c2e0b8ac2b23320df3e3ece9
Fix an overflow bug in MachineBranchProbabilityInfo. This pass relied on
the sum of the edge weights not overflowing uint32, and crashed when
they did. This is generally safe as BranchProbabilityInfo tries to
provide this guarantee. However, the CFG can get modified during codegen
in a way that grows the *sum* of the edge weights. This doesn't seem
unreasonable (imagine just adding more blocks all with the default
weight of 16), but it is hard to come up with a case that actually
triggers 32-bit overflow. Fortuately, the single-source GCC build is
good at this. The solution isn't very pretty, but its no worse than the
previous code. We're already summing all of the edge weights on each
query, we can sum them, check for an overflow, compute a scale, and sum
them again.

I've included a *greatly* reduced test case out of the GCC source that
triggers it. It's a pretty lame test, as it clearly is just barely
triggering the overflow. I'd like to have something that is much more
definitive, but I don't understand the fundamental pattern that triggers
an explosion in the edge weight sums.

The buggy code is duplicated within this file. I'll colapse them into
a single implementation in a subsequent commit.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@144526 91177308-0d34-0410-b5e6-96231b3b80d8
include/llvm/CodeGen/MachineBranchProbabilityInfo.h
lib/CodeGen/MachineBranchProbabilityInfo.cpp
test/CodeGen/X86/block-placement.ll