Skip to content

[SLP] Fix isCommutative to check uses of the original instruction instead of the converted instruction. #143094

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 6 commits into from
Jun 17, 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
36 changes: 30 additions & 6 deletions llvm/lib/Transforms/Vectorize/SLPVectorizer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -511,15 +511,25 @@ static bool isSplat(ArrayRef<Value *> VL) {
}

/// \returns True if \p I is commutative, handles CmpInst and BinaryOperator.
static bool isCommutative(Instruction *I) {
/// For BinaryOperator, it also checks if \p InstWithUses is used in specific
/// patterns that make it effectively commutative (like equality comparisons
/// with zero).
/// In most cases, users should not call this function directly (since \p I and
/// \p InstWithUses are the same). However, when analyzing interchangeable
/// instructions, we need to use the converted opcode along with the original
/// uses.
/// \param I The instruction to check for commutativity
/// \param InstWithUses The instruction whose uses are analyzed for special
/// patterns
static bool isCommutative(Instruction *I, Instruction *InstWithUses) {
if (auto *Cmp = dyn_cast<CmpInst>(I))
return Cmp->isCommutative();
if (auto *BO = dyn_cast<BinaryOperator>(I))
return BO->isCommutative() ||
(BO->getOpcode() == Instruction::Sub &&
!BO->hasNUsesOrMore(UsesLimit) &&
!InstWithUses->hasNUsesOrMore(UsesLimit) &&
all_of(
BO->uses(),
InstWithUses->uses(),
[](const Use &U) {
// Commutative, if icmp eq/ne sub, 0
CmpPredicate Pred;
Expand All @@ -536,14 +546,24 @@ static bool isCommutative(Instruction *I) {
Flag->isOne());
})) ||
(BO->getOpcode() == Instruction::FSub &&
!BO->hasNUsesOrMore(UsesLimit) &&
all_of(BO->uses(), [](const Use &U) {
!InstWithUses->hasNUsesOrMore(UsesLimit) &&
all_of(InstWithUses->uses(), [](const Use &U) {
return match(U.getUser(),
m_Intrinsic<Intrinsic::fabs>(m_Specific(U.get())));
}));
return I->isCommutative();
}

/// This is a helper function to check whether \p I is commutative.
Copy link
Collaborator

Choose a reason for hiding this comment

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

When should this function be used, and when should it absolutely not be used?
I think that is what the comment should explain since it's far from obvious, and using it when it shouldn't be used may lead to miscompile (as seen in the issue I wrote).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are already comments explaining the usage. In most cases, users should use the helper function.

Copy link
Member

Choose a reason for hiding this comment

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

I would add a note, at least, that this function should be used only if the original instruction is checked, not the representation. Or used the original isCommutative for all cases to avoid potential bugs

/// This is a convenience wrapper that calls the two-parameter version of
/// isCommutative with the same instruction for both parameters. This is
/// the common case where the instruction being checked for commutativity
/// is the same as the instruction whose uses are analyzed for special
/// patterns (see the two-parameter version above for details).
/// \param I The instruction to check for commutativity
/// \returns true if the instruction is commutative, false otherwise
static bool isCommutative(Instruction *I) { return isCommutative(I, I); }
Copy link
Member

Choose a reason for hiding this comment

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

  1. Add a comment for this function too
  2. Do we need it at all?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need it. isCommutative(Instruction *I) is used widely. Only interchangeable instruction analysis will change the parameter (InstWithUses).


template <typename T>
static std::optional<unsigned> getInsertExtractIndex(const Value *Inst,
unsigned Offset) {
Expand Down Expand Up @@ -2898,7 +2918,11 @@ class BoUpSLP {
continue;
}
auto [SelectedOp, Ops] = convertTo(cast<Instruction>(V), S);
bool IsInverseOperation = !isCommutative(SelectedOp);
// We cannot check commutativity by the converted instruction
// (SelectedOp) because isCommutative also examines def-use
// relationships.
bool IsInverseOperation =
!isCommutative(SelectedOp, cast<Instruction>(V));
for (unsigned OpIdx : seq<unsigned>(ArgSize)) {
bool APO = (OpIdx == 0) ? false : IsInverseOperation;
OpsVec[OpIdx][Lane] = {Operands[OpIdx][Lane], APO, false};
Expand Down
34 changes: 34 additions & 0 deletions llvm/test/Transforms/SLPVectorizer/isCommutative.ll
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
; NOTE: Assertions have been autogenerated by utils/update_test_checks.py
; RUN: opt -passes=slp-vectorizer -S %s | FileCheck %s

define i16 @check_isCommutative_with_the_original_source() {
; CHECK-LABEL: @check_isCommutative_with_the_original_source(
; CHECK-NEXT: entry:
; CHECK-NEXT: [[COND3:%.*]] = select i1 true, i16 1, i16 0
; CHECK-NEXT: ret i16 [[COND3]]
;
entry:
%sub = sub i16 0, -1
%cmp = icmp eq i16 %sub, 1

%sub1 = sub i16 0, -1
%cmp2 = icmp eq i16 %sub1, 1
%cond3 = select i1 %cmp2, i16 1, i16 0

%sub5 = sub nsw i16 0, 0
%cmp6 = icmp eq i16 %sub5, 0
%cmp9 = icmp eq i16 %sub5, 0

%sub12 = sub nsw i16 0, 0
%cmp13 = icmp eq i16 %sub12, 0

%sub16 = sub nsw i16 0, 0
%cmp17 = icmp eq i16 %sub16, 0

%sub20 = sub nsw i16 0, 0
%cmp21 = icmp eq i16 %sub20, 0
%cmp24 = icmp eq i16 %sub20, 0

ret i16 %cond3
}

Loading