Skip to content

[ValueTracking] Fix bit width handling in computeKnownBits() for GEPs #125532

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

Merged
merged 2 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 36 additions & 30 deletions llvm/lib/Analysis/ValueTracking.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1426,7 +1426,22 @@ static void computeKnownBitsFromOperator(const Operator *I,
computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
// Accumulate the constant indices in a separate variable
// to minimize the number of calls to computeForAddSub.
APInt AccConstIndices(BitWidth, 0, /*IsSigned*/ true);
unsigned IndexWidth = Q.DL.getIndexTypeSizeInBits(I->getType());
APInt AccConstIndices(IndexWidth, 0);

auto AddIndexToKnown = [&](KnownBits IndexBits) {
if (IndexWidth == BitWidth) {
// Note that inbounds does *not* guarantee nsw for the addition, as only
// the offset is signed, while the base address is unsigned.
Known = KnownBits::add(Known, IndexBits);
Copy link
Contributor

Choose a reason for hiding this comment

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

Beyond the scope of this PR, but would it be slightly more optimal to start Known as zero so we could include nsw here (and nuw on the final addition) if we have inbounds?

Copy link
Member

Choose a reason for hiding this comment

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

We cannot preserve nsw here because we changed the order of pointer addition (line 1485).

} else {
// If the index width is smaller than the pointer width, only add the
// value to the low bits.
assert(IndexWidth < BitWidth &&
"Index width can't be larger than pointer width");
Known.insertBits(KnownBits::add(Known.trunc(IndexWidth), IndexBits), 0);
}
};
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Maybe rename to AddIndexToKnown, or return Known (and set Known = AddIndex(...)) were its used below for the sake of clarity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


gep_type_iterator GTI = gep_type_begin(I);
for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
Expand Down Expand Up @@ -1464,43 +1479,34 @@ static void computeKnownBitsFromOperator(const Operator *I,
break;
}

unsigned IndexBitWidth = Index->getType()->getScalarSizeInBits();
KnownBits IndexBits(IndexBitWidth);
computeKnownBits(Index, IndexBits, Depth + 1, Q);
TypeSize IndexTypeSize = GTI.getSequentialElementStride(Q.DL);
uint64_t TypeSizeInBytes = IndexTypeSize.getKnownMinValue();
KnownBits ScalingFactor(IndexBitWidth);
TypeSize Stride = GTI.getSequentialElementStride(Q.DL);
uint64_t StrideInBytes = Stride.getKnownMinValue();
if (!Stride.isScalable()) {
// Fast path for constant offset.
if (auto *CI = dyn_cast<ConstantInt>(Index)) {
AccConstIndices +=
CI->getValue().sextOrTrunc(IndexWidth) * StrideInBytes;
continue;
}
}

KnownBits IndexBits =
computeKnownBits(Index, Depth + 1, Q).sextOrTrunc(IndexWidth);
KnownBits ScalingFactor(IndexWidth);
// Multiply by current sizeof type.
// &A[i] == A + i * sizeof(*A[i]).
if (IndexTypeSize.isScalable()) {
if (Stride.isScalable()) {
// For scalable types the only thing we know about sizeof is
// that this is a multiple of the minimum size.
ScalingFactor.Zero.setLowBits(llvm::countr_zero(TypeSizeInBytes));
} else if (IndexBits.isConstant()) {
APInt IndexConst = IndexBits.getConstant();
APInt ScalingFactor(IndexBitWidth, TypeSizeInBytes);
IndexConst *= ScalingFactor;
AccConstIndices += IndexConst.sextOrTrunc(BitWidth);
continue;
ScalingFactor.Zero.setLowBits(llvm::countr_zero(StrideInBytes));
} else {
ScalingFactor =
KnownBits::makeConstant(APInt(IndexBitWidth, TypeSizeInBytes));
KnownBits::makeConstant(APInt(IndexWidth, StrideInBytes));
}
IndexBits = KnownBits::mul(IndexBits, ScalingFactor);

// If the offsets have a different width from the pointer, according
// to the language reference we need to sign-extend or truncate them
// to the width of the pointer.
IndexBits = IndexBits.sextOrTrunc(BitWidth);

// Note that inbounds does *not* guarantee nsw for the addition, as only
// the offset is signed, while the base address is unsigned.
Known = KnownBits::add(Known, IndexBits);
}
if (!Known.isUnknown() && !AccConstIndices.isZero()) {
KnownBits Index = KnownBits::makeConstant(AccConstIndices);
Known = KnownBits::add(Known, Index);
AddIndexToKnown(KnownBits::mul(IndexBits, ScalingFactor));
}
if (!Known.isUnknown() && !AccConstIndices.isZero())
AddIndexToKnown(KnownBits::makeConstant(AccConstIndices));
break;
}
case Instruction::PHI: {
Expand Down
12 changes: 6 additions & 6 deletions llvm/unittests/Analysis/ValueTrackingTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2680,7 +2680,7 @@ TEST_F(ComputeKnownBitsTest, ComputeKnownBitsAbsoluteSymbol) {
}

TEST_F(ComputeKnownBitsTest, ComputeKnownBitsGEPExtendBeforeMul) {
// FIXME: The index should be extended before multiplying with the scale.
// The index should be extended before multiplying with the scale.
parseAssembly(R"(
target datalayout = "p:16:16:16"

Expand All @@ -2692,12 +2692,12 @@ TEST_F(ComputeKnownBitsTest, ComputeKnownBitsGEPExtendBeforeMul) {
}
)");
KnownBits Known = computeKnownBits(A, M->getDataLayout());
EXPECT_EQ(~64 & 0x7fff, Known.Zero);
EXPECT_EQ(64, Known.One);
EXPECT_EQ(~320 & 0x7fff, Known.Zero);
EXPECT_EQ(320, Known.One);
}

TEST_F(ComputeKnownBitsTest, ComputeKnownBitsGEPOnlyIndexBits) {
// FIXME: GEP should only affect the index width.
// GEP should only affect the index width.
parseAssembly(R"(
target datalayout = "p:16:16:16:8"

Expand All @@ -2710,8 +2710,8 @@ TEST_F(ComputeKnownBitsTest, ComputeKnownBitsGEPOnlyIndexBits) {
}
)");
KnownBits Known = computeKnownBits(A, M->getDataLayout());
EXPECT_EQ(0x7eff, Known.Zero);
EXPECT_EQ(0x100, Known.One);
EXPECT_EQ(0x7fff, Known.Zero);
EXPECT_EQ(0, Known.One);
}

TEST_F(ValueTrackingTest, HaveNoCommonBitsSet) {
Expand Down