llvm-project/llvm/lib/Target/SPIRV/SPIRVCombinerHelper.cpp
Kaitlin Peng 4877c593a8
[SPIRV] Add PreLegalizer pattern matching for faceforward (#139959)
Tasks completed:
- Pattern match`select(fcmp(dot(p2, p3), 0), p1, -p1)` to
`faceforward(p1, p2, p3)`
- Add pattern matching tests to
`prelegalizercombiner-select-to-faceforward.mir` and `faceforward.ll`
- Add CL extension error test
`llvm/test/CodeGen/SPIRV/opencl/faceforward-error.ll`
- Add CL extension test for no pattern matching in
`llvm/test/CodeGen/SPIRV/opencl/faceforward.ll`

Closes #137255.
2025-11-25 09:41:35 -08:00

212 lines
8.3 KiB
C++

//===-- SPIRVCombinerHelper.cpp -------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "SPIRVCombinerHelper.h"
#include "llvm/CodeGen/GlobalISel/GenericMachineInstrs.h"
#include "llvm/CodeGen/GlobalISel/MIPatternMatch.h"
#include "llvm/IR/IntrinsicsSPIRV.h"
#include "llvm/Target/TargetMachine.h"
using namespace llvm;
using namespace MIPatternMatch;
SPIRVCombinerHelper::SPIRVCombinerHelper(
GISelChangeObserver &Observer, MachineIRBuilder &B, bool IsPreLegalize,
GISelValueTracking *VT, MachineDominatorTree *MDT, const LegalizerInfo *LI,
const SPIRVSubtarget &STI)
: CombinerHelper(Observer, B, IsPreLegalize, VT, MDT, LI), STI(STI) {}
/// This match is part of a combine that
/// rewrites length(X - Y) to distance(X, Y)
/// (f32 (g_intrinsic length
/// (g_fsub (vXf32 X) (vXf32 Y))))
/// ->
/// (f32 (g_intrinsic distance
/// (vXf32 X) (vXf32 Y)))
///
bool SPIRVCombinerHelper::matchLengthToDistance(MachineInstr &MI) const {
if (MI.getOpcode() != TargetOpcode::G_INTRINSIC ||
cast<GIntrinsic>(MI).getIntrinsicID() != Intrinsic::spv_length)
return false;
// First operand of MI is `G_INTRINSIC` so start at operand 2.
Register SubReg = MI.getOperand(2).getReg();
MachineInstr *SubInstr = MRI.getVRegDef(SubReg);
if (SubInstr->getOpcode() != TargetOpcode::G_FSUB)
return false;
return true;
}
void SPIRVCombinerHelper::applySPIRVDistance(MachineInstr &MI) const {
// Extract the operands for X and Y from the match criteria.
Register SubDestReg = MI.getOperand(2).getReg();
MachineInstr *SubInstr = MRI.getVRegDef(SubDestReg);
Register SubOperand1 = SubInstr->getOperand(1).getReg();
Register SubOperand2 = SubInstr->getOperand(2).getReg();
Register ResultReg = MI.getOperand(0).getReg();
Builder.setInstrAndDebugLoc(MI);
Builder.buildIntrinsic(Intrinsic::spv_distance, ResultReg)
.addUse(SubOperand1)
.addUse(SubOperand2);
MI.eraseFromParent();
}
/// This match is part of a combine that
/// rewrites select(fcmp(dot(I, Ng), 0), N, -N) to faceforward(N, I, Ng)
/// (vXf32 (g_select
/// (g_fcmp
/// (g_intrinsic dot(vXf32 I) (vXf32 Ng)
/// 0)
/// (vXf32 N)
/// (vXf32 g_fneg (vXf32 N))))
/// ->
/// (vXf32 (g_intrinsic faceforward
/// (vXf32 N) (vXf32 I) (vXf32 Ng)))
///
/// This only works for Vulkan shader targets.
///
bool SPIRVCombinerHelper::matchSelectToFaceForward(MachineInstr &MI) const {
if (!STI.isShader())
return false;
// Match overall select pattern.
Register CondReg, TrueReg, FalseReg;
if (!mi_match(MI.getOperand(0).getReg(), MRI,
m_GISelect(m_Reg(CondReg), m_Reg(TrueReg), m_Reg(FalseReg))))
return false;
// Match the FCMP condition.
Register DotReg, CondZeroReg;
CmpInst::Predicate Pred;
if (!mi_match(CondReg, MRI,
m_GFCmp(m_Pred(Pred), m_Reg(DotReg), m_Reg(CondZeroReg))) ||
!(Pred == CmpInst::FCMP_OLT || Pred == CmpInst::FCMP_ULT)) {
if (!(Pred == CmpInst::FCMP_OGT || Pred == CmpInst::FCMP_UGT))
return false;
std::swap(DotReg, CondZeroReg);
}
// Check if FCMP is a comparison between a dot product and 0.
MachineInstr *DotInstr = MRI.getVRegDef(DotReg);
if (DotInstr->getOpcode() != TargetOpcode::G_INTRINSIC ||
cast<GIntrinsic>(DotInstr)->getIntrinsicID() != Intrinsic::spv_fdot) {
Register DotOperand1, DotOperand2;
// Check for scalar dot product.
if (!mi_match(DotReg, MRI,
m_GFMul(m_Reg(DotOperand1), m_Reg(DotOperand2))) ||
!MRI.getType(DotOperand1).isScalar() ||
!MRI.getType(DotOperand2).isScalar())
return false;
}
const ConstantFP *ZeroVal;
if (!mi_match(CondZeroReg, MRI, m_GFCst(ZeroVal)) || !ZeroVal->isZero())
return false;
// Check if select's false operand is the negation of the true operand.
auto AreNegatedConstantsOrSplats = [&](Register TrueReg, Register FalseReg) {
std::optional<FPValueAndVReg> TrueVal, FalseVal;
if (!mi_match(TrueReg, MRI, m_GFCstOrSplat(TrueVal)) ||
!mi_match(FalseReg, MRI, m_GFCstOrSplat(FalseVal)))
return false;
APFloat TrueValNegated = TrueVal->Value;
TrueValNegated.changeSign();
return FalseVal->Value.compare(TrueValNegated) == APFloat::cmpEqual;
};
if (!mi_match(TrueReg, MRI, m_GFNeg(m_SpecificReg(FalseReg))) &&
!mi_match(FalseReg, MRI, m_GFNeg(m_SpecificReg(TrueReg)))) {
std::optional<FPValueAndVReg> MulConstant;
MachineInstr *TrueInstr = MRI.getVRegDef(TrueReg);
MachineInstr *FalseInstr = MRI.getVRegDef(FalseReg);
if (TrueInstr->getOpcode() == TargetOpcode::G_BUILD_VECTOR &&
FalseInstr->getOpcode() == TargetOpcode::G_BUILD_VECTOR &&
TrueInstr->getNumOperands() == FalseInstr->getNumOperands()) {
for (unsigned I = 1; I < TrueInstr->getNumOperands(); ++I)
if (!AreNegatedConstantsOrSplats(TrueInstr->getOperand(I).getReg(),
FalseInstr->getOperand(I).getReg()))
return false;
} else if (mi_match(TrueReg, MRI,
m_GFMul(m_SpecificReg(FalseReg),
m_GFCstOrSplat(MulConstant))) ||
mi_match(FalseReg, MRI,
m_GFMul(m_SpecificReg(TrueReg),
m_GFCstOrSplat(MulConstant))) ||
mi_match(TrueReg, MRI,
m_GFMul(m_GFCstOrSplat(MulConstant),
m_SpecificReg(FalseReg))) ||
mi_match(FalseReg, MRI,
m_GFMul(m_GFCstOrSplat(MulConstant),
m_SpecificReg(TrueReg)))) {
if (!MulConstant || !MulConstant->Value.isExactlyValue(-1.0))
return false;
} else if (!AreNegatedConstantsOrSplats(TrueReg, FalseReg))
return false;
}
return true;
}
void SPIRVCombinerHelper::applySPIRVFaceForward(MachineInstr &MI) const {
// Extract the operands for N, I, and Ng from the match criteria.
Register CondReg = MI.getOperand(1).getReg();
MachineInstr *CondInstr = MRI.getVRegDef(CondReg);
Register DotReg = CondInstr->getOperand(2).getReg();
CmpInst::Predicate Pred = cast<GFCmp>(CondInstr)->getCond();
if (Pred == CmpInst::FCMP_OGT || Pred == CmpInst::FCMP_UGT)
DotReg = CondInstr->getOperand(3).getReg();
MachineInstr *DotInstr = MRI.getVRegDef(DotReg);
Register DotOperand1, DotOperand2;
if (DotInstr->getOpcode() == TargetOpcode::G_FMUL) {
DotOperand1 = DotInstr->getOperand(1).getReg();
DotOperand2 = DotInstr->getOperand(2).getReg();
} else {
DotOperand1 = DotInstr->getOperand(2).getReg();
DotOperand2 = DotInstr->getOperand(3).getReg();
}
Register TrueReg = MI.getOperand(2).getReg();
Register FalseReg = MI.getOperand(3).getReg();
MachineInstr *TrueInstr = MRI.getVRegDef(TrueReg);
if (TrueInstr->getOpcode() == TargetOpcode::G_FNEG ||
TrueInstr->getOpcode() == TargetOpcode::G_FMUL)
std::swap(TrueReg, FalseReg);
MachineInstr *FalseInstr = MRI.getVRegDef(FalseReg);
Register ResultReg = MI.getOperand(0).getReg();
Builder.setInstrAndDebugLoc(MI);
Builder.buildIntrinsic(Intrinsic::spv_faceforward, ResultReg)
.addUse(TrueReg) // N
.addUse(DotOperand1) // I
.addUse(DotOperand2); // Ng
SPIRVGlobalRegistry *GR =
MI.getMF()->getSubtarget<SPIRVSubtarget>().getSPIRVGlobalRegistry();
auto RemoveAllUses = [&](Register Reg) {
SmallVector<MachineInstr *, 4> UsesToErase;
for (auto &UseMI : MRI.use_instructions(Reg))
UsesToErase.push_back(&UseMI);
// calling eraseFromParent to early invalidates the iterator.
for (auto *MIToErase : UsesToErase)
MIToErase->eraseFromParent();
};
RemoveAllUses(CondReg); // remove all uses of FCMP Result
GR->invalidateMachineInstr(CondInstr);
CondInstr->eraseFromParent(); // remove FCMP instruction
RemoveAllUses(DotReg); // remove all uses of spv_fdot/G_FMUL Result
GR->invalidateMachineInstr(DotInstr);
DotInstr->eraseFromParent(); // remove spv_fdot/G_FMUL instruction
RemoveAllUses(FalseReg);
GR->invalidateMachineInstr(FalseInstr);
FalseInstr->eraseFromParent();
}