xref: /freebsd/contrib/llvm-project/llvm/lib/Target/SystemZ/SystemZElimCompare.cpp (revision 8bcb0991864975618c09697b1aca10683346d9f0)
10b57cec5SDimitry Andric //===-- SystemZElimCompare.cpp - Eliminate comparison instructions --------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This pass:
100b57cec5SDimitry Andric // (1) tries to remove compares if CC already contains the required information
110b57cec5SDimitry Andric // (2) fuses compares and branches into COMPARE AND BRANCH instructions
120b57cec5SDimitry Andric //
130b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
140b57cec5SDimitry Andric 
150b57cec5SDimitry Andric #include "SystemZ.h"
160b57cec5SDimitry Andric #include "SystemZInstrInfo.h"
170b57cec5SDimitry Andric #include "SystemZTargetMachine.h"
180b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h"
190b57cec5SDimitry Andric #include "llvm/ADT/Statistic.h"
200b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
210b57cec5SDimitry Andric #include "llvm/CodeGen/MachineBasicBlock.h"
220b57cec5SDimitry Andric #include "llvm/CodeGen/MachineFunction.h"
230b57cec5SDimitry Andric #include "llvm/CodeGen/MachineFunctionPass.h"
240b57cec5SDimitry Andric #include "llvm/CodeGen/MachineInstr.h"
250b57cec5SDimitry Andric #include "llvm/CodeGen/MachineInstrBuilder.h"
260b57cec5SDimitry Andric #include "llvm/CodeGen/MachineOperand.h"
270b57cec5SDimitry Andric #include "llvm/CodeGen/TargetRegisterInfo.h"
280b57cec5SDimitry Andric #include "llvm/CodeGen/TargetSubtargetInfo.h"
290b57cec5SDimitry Andric #include "llvm/MC/MCInstrDesc.h"
300b57cec5SDimitry Andric #include <cassert>
310b57cec5SDimitry Andric #include <cstdint>
320b57cec5SDimitry Andric 
330b57cec5SDimitry Andric using namespace llvm;
340b57cec5SDimitry Andric 
350b57cec5SDimitry Andric #define DEBUG_TYPE "systemz-elim-compare"
360b57cec5SDimitry Andric 
370b57cec5SDimitry Andric STATISTIC(BranchOnCounts, "Number of branch-on-count instructions");
380b57cec5SDimitry Andric STATISTIC(LoadAndTraps, "Number of load-and-trap instructions");
390b57cec5SDimitry Andric STATISTIC(EliminatedComparisons, "Number of eliminated comparisons");
400b57cec5SDimitry Andric STATISTIC(FusedComparisons, "Number of fused compare-and-branch instructions");
410b57cec5SDimitry Andric 
420b57cec5SDimitry Andric namespace {
430b57cec5SDimitry Andric 
440b57cec5SDimitry Andric // Represents the references to a particular register in one or more
450b57cec5SDimitry Andric // instructions.
460b57cec5SDimitry Andric struct Reference {
470b57cec5SDimitry Andric   Reference() = default;
480b57cec5SDimitry Andric 
490b57cec5SDimitry Andric   Reference &operator|=(const Reference &Other) {
500b57cec5SDimitry Andric     Def |= Other.Def;
510b57cec5SDimitry Andric     Use |= Other.Use;
520b57cec5SDimitry Andric     return *this;
530b57cec5SDimitry Andric   }
540b57cec5SDimitry Andric 
550b57cec5SDimitry Andric   explicit operator bool() const { return Def || Use; }
560b57cec5SDimitry Andric 
570b57cec5SDimitry Andric   // True if the register is defined or used in some form, either directly or
580b57cec5SDimitry Andric   // via a sub- or super-register.
590b57cec5SDimitry Andric   bool Def = false;
600b57cec5SDimitry Andric   bool Use = false;
610b57cec5SDimitry Andric };
620b57cec5SDimitry Andric 
630b57cec5SDimitry Andric class SystemZElimCompare : public MachineFunctionPass {
640b57cec5SDimitry Andric public:
650b57cec5SDimitry Andric   static char ID;
660b57cec5SDimitry Andric 
670b57cec5SDimitry Andric   SystemZElimCompare(const SystemZTargetMachine &tm)
680b57cec5SDimitry Andric     : MachineFunctionPass(ID) {}
690b57cec5SDimitry Andric 
700b57cec5SDimitry Andric   StringRef getPassName() const override {
710b57cec5SDimitry Andric     return "SystemZ Comparison Elimination";
720b57cec5SDimitry Andric   }
730b57cec5SDimitry Andric 
740b57cec5SDimitry Andric   bool processBlock(MachineBasicBlock &MBB);
750b57cec5SDimitry Andric   bool runOnMachineFunction(MachineFunction &F) override;
760b57cec5SDimitry Andric 
770b57cec5SDimitry Andric   MachineFunctionProperties getRequiredProperties() const override {
780b57cec5SDimitry Andric     return MachineFunctionProperties().set(
790b57cec5SDimitry Andric         MachineFunctionProperties::Property::NoVRegs);
800b57cec5SDimitry Andric   }
810b57cec5SDimitry Andric 
820b57cec5SDimitry Andric private:
830b57cec5SDimitry Andric   Reference getRegReferences(MachineInstr &MI, unsigned Reg);
840b57cec5SDimitry Andric   bool convertToBRCT(MachineInstr &MI, MachineInstr &Compare,
850b57cec5SDimitry Andric                      SmallVectorImpl<MachineInstr *> &CCUsers);
860b57cec5SDimitry Andric   bool convertToLoadAndTrap(MachineInstr &MI, MachineInstr &Compare,
870b57cec5SDimitry Andric                             SmallVectorImpl<MachineInstr *> &CCUsers);
880b57cec5SDimitry Andric   bool convertToLoadAndTest(MachineInstr &MI, MachineInstr &Compare,
890b57cec5SDimitry Andric                             SmallVectorImpl<MachineInstr *> &CCUsers);
900b57cec5SDimitry Andric   bool adjustCCMasksForInstr(MachineInstr &MI, MachineInstr &Compare,
910b57cec5SDimitry Andric                              SmallVectorImpl<MachineInstr *> &CCUsers,
920b57cec5SDimitry Andric                              unsigned ConvOpc = 0);
930b57cec5SDimitry Andric   bool optimizeCompareZero(MachineInstr &Compare,
940b57cec5SDimitry Andric                            SmallVectorImpl<MachineInstr *> &CCUsers);
950b57cec5SDimitry Andric   bool fuseCompareOperations(MachineInstr &Compare,
960b57cec5SDimitry Andric                              SmallVectorImpl<MachineInstr *> &CCUsers);
970b57cec5SDimitry Andric 
980b57cec5SDimitry Andric   const SystemZInstrInfo *TII = nullptr;
990b57cec5SDimitry Andric   const TargetRegisterInfo *TRI = nullptr;
1000b57cec5SDimitry Andric };
1010b57cec5SDimitry Andric 
1020b57cec5SDimitry Andric char SystemZElimCompare::ID = 0;
1030b57cec5SDimitry Andric 
1040b57cec5SDimitry Andric } // end anonymous namespace
1050b57cec5SDimitry Andric 
1060b57cec5SDimitry Andric // Return true if CC is live out of MBB.
1070b57cec5SDimitry Andric static bool isCCLiveOut(MachineBasicBlock &MBB) {
1080b57cec5SDimitry Andric   for (auto SI = MBB.succ_begin(), SE = MBB.succ_end(); SI != SE; ++SI)
1090b57cec5SDimitry Andric     if ((*SI)->isLiveIn(SystemZ::CC))
1100b57cec5SDimitry Andric       return true;
1110b57cec5SDimitry Andric   return false;
1120b57cec5SDimitry Andric }
1130b57cec5SDimitry Andric 
1140b57cec5SDimitry Andric // Returns true if MI is an instruction whose output equals the value in Reg.
1150b57cec5SDimitry Andric static bool preservesValueOf(MachineInstr &MI, unsigned Reg) {
1160b57cec5SDimitry Andric   switch (MI.getOpcode()) {
1170b57cec5SDimitry Andric   case SystemZ::LR:
1180b57cec5SDimitry Andric   case SystemZ::LGR:
1190b57cec5SDimitry Andric   case SystemZ::LGFR:
1200b57cec5SDimitry Andric   case SystemZ::LTR:
1210b57cec5SDimitry Andric   case SystemZ::LTGR:
1220b57cec5SDimitry Andric   case SystemZ::LTGFR:
1230b57cec5SDimitry Andric   case SystemZ::LER:
1240b57cec5SDimitry Andric   case SystemZ::LDR:
1250b57cec5SDimitry Andric   case SystemZ::LXR:
1260b57cec5SDimitry Andric   case SystemZ::LTEBR:
1270b57cec5SDimitry Andric   case SystemZ::LTDBR:
1280b57cec5SDimitry Andric   case SystemZ::LTXBR:
1290b57cec5SDimitry Andric     if (MI.getOperand(1).getReg() == Reg)
1300b57cec5SDimitry Andric       return true;
1310b57cec5SDimitry Andric   }
1320b57cec5SDimitry Andric 
1330b57cec5SDimitry Andric   return false;
1340b57cec5SDimitry Andric }
1350b57cec5SDimitry Andric 
1360b57cec5SDimitry Andric // Return true if any CC result of MI would (perhaps after conversion)
1370b57cec5SDimitry Andric // reflect the value of Reg.
1380b57cec5SDimitry Andric static bool resultTests(MachineInstr &MI, unsigned Reg) {
1390b57cec5SDimitry Andric   if (MI.getNumOperands() > 0 && MI.getOperand(0).isReg() &&
1400b57cec5SDimitry Andric       MI.getOperand(0).isDef() && MI.getOperand(0).getReg() == Reg)
1410b57cec5SDimitry Andric     return true;
1420b57cec5SDimitry Andric 
1430b57cec5SDimitry Andric   return (preservesValueOf(MI, Reg));
1440b57cec5SDimitry Andric }
1450b57cec5SDimitry Andric 
1460b57cec5SDimitry Andric // Describe the references to Reg or any of its aliases in MI.
1470b57cec5SDimitry Andric Reference SystemZElimCompare::getRegReferences(MachineInstr &MI, unsigned Reg) {
1480b57cec5SDimitry Andric   Reference Ref;
1490b57cec5SDimitry Andric   if (MI.isDebugInstr())
1500b57cec5SDimitry Andric     return Ref;
1510b57cec5SDimitry Andric 
1520b57cec5SDimitry Andric   for (unsigned I = 0, E = MI.getNumOperands(); I != E; ++I) {
1530b57cec5SDimitry Andric     const MachineOperand &MO = MI.getOperand(I);
1540b57cec5SDimitry Andric     if (MO.isReg()) {
155*8bcb0991SDimitry Andric       if (Register MOReg = MO.getReg()) {
1560b57cec5SDimitry Andric         if (TRI->regsOverlap(MOReg, Reg)) {
1570b57cec5SDimitry Andric           if (MO.isUse())
1580b57cec5SDimitry Andric             Ref.Use = true;
1590b57cec5SDimitry Andric           else if (MO.isDef())
1600b57cec5SDimitry Andric             Ref.Def = true;
1610b57cec5SDimitry Andric         }
1620b57cec5SDimitry Andric       }
1630b57cec5SDimitry Andric     }
1640b57cec5SDimitry Andric   }
1650b57cec5SDimitry Andric   return Ref;
1660b57cec5SDimitry Andric }
1670b57cec5SDimitry Andric 
1680b57cec5SDimitry Andric // Return true if this is a load and test which can be optimized the
1690b57cec5SDimitry Andric // same way as compare instruction.
1700b57cec5SDimitry Andric static bool isLoadAndTestAsCmp(MachineInstr &MI) {
1710b57cec5SDimitry Andric   // If we during isel used a load-and-test as a compare with 0, the
1720b57cec5SDimitry Andric   // def operand is dead.
1730b57cec5SDimitry Andric   return (MI.getOpcode() == SystemZ::LTEBR ||
1740b57cec5SDimitry Andric           MI.getOpcode() == SystemZ::LTDBR ||
1750b57cec5SDimitry Andric           MI.getOpcode() == SystemZ::LTXBR) &&
1760b57cec5SDimitry Andric          MI.getOperand(0).isDead();
1770b57cec5SDimitry Andric }
1780b57cec5SDimitry Andric 
1790b57cec5SDimitry Andric // Return the source register of Compare, which is the unknown value
1800b57cec5SDimitry Andric // being tested.
1810b57cec5SDimitry Andric static unsigned getCompareSourceReg(MachineInstr &Compare) {
1820b57cec5SDimitry Andric   unsigned reg = 0;
1830b57cec5SDimitry Andric   if (Compare.isCompare())
1840b57cec5SDimitry Andric     reg = Compare.getOperand(0).getReg();
1850b57cec5SDimitry Andric   else if (isLoadAndTestAsCmp(Compare))
1860b57cec5SDimitry Andric     reg = Compare.getOperand(1).getReg();
1870b57cec5SDimitry Andric   assert(reg);
1880b57cec5SDimitry Andric 
1890b57cec5SDimitry Andric   return reg;
1900b57cec5SDimitry Andric }
1910b57cec5SDimitry Andric 
1920b57cec5SDimitry Andric // Compare compares the result of MI against zero.  If MI is an addition
1930b57cec5SDimitry Andric // of -1 and if CCUsers is a single branch on nonzero, eliminate the addition
1940b57cec5SDimitry Andric // and convert the branch to a BRCT(G) or BRCTH.  Return true on success.
1950b57cec5SDimitry Andric bool SystemZElimCompare::convertToBRCT(
1960b57cec5SDimitry Andric     MachineInstr &MI, MachineInstr &Compare,
1970b57cec5SDimitry Andric     SmallVectorImpl<MachineInstr *> &CCUsers) {
1980b57cec5SDimitry Andric   // Check whether we have an addition of -1.
1990b57cec5SDimitry Andric   unsigned Opcode = MI.getOpcode();
2000b57cec5SDimitry Andric   unsigned BRCT;
2010b57cec5SDimitry Andric   if (Opcode == SystemZ::AHI)
2020b57cec5SDimitry Andric     BRCT = SystemZ::BRCT;
2030b57cec5SDimitry Andric   else if (Opcode == SystemZ::AGHI)
2040b57cec5SDimitry Andric     BRCT = SystemZ::BRCTG;
2050b57cec5SDimitry Andric   else if (Opcode == SystemZ::AIH)
2060b57cec5SDimitry Andric     BRCT = SystemZ::BRCTH;
2070b57cec5SDimitry Andric   else
2080b57cec5SDimitry Andric     return false;
2090b57cec5SDimitry Andric   if (MI.getOperand(2).getImm() != -1)
2100b57cec5SDimitry Andric     return false;
2110b57cec5SDimitry Andric 
2120b57cec5SDimitry Andric   // Check whether we have a single JLH.
2130b57cec5SDimitry Andric   if (CCUsers.size() != 1)
2140b57cec5SDimitry Andric     return false;
2150b57cec5SDimitry Andric   MachineInstr *Branch = CCUsers[0];
2160b57cec5SDimitry Andric   if (Branch->getOpcode() != SystemZ::BRC ||
2170b57cec5SDimitry Andric       Branch->getOperand(0).getImm() != SystemZ::CCMASK_ICMP ||
2180b57cec5SDimitry Andric       Branch->getOperand(1).getImm() != SystemZ::CCMASK_CMP_NE)
2190b57cec5SDimitry Andric     return false;
2200b57cec5SDimitry Andric 
2210b57cec5SDimitry Andric   // We already know that there are no references to the register between
2220b57cec5SDimitry Andric   // MI and Compare.  Make sure that there are also no references between
2230b57cec5SDimitry Andric   // Compare and Branch.
2240b57cec5SDimitry Andric   unsigned SrcReg = getCompareSourceReg(Compare);
2250b57cec5SDimitry Andric   MachineBasicBlock::iterator MBBI = Compare, MBBE = Branch;
2260b57cec5SDimitry Andric   for (++MBBI; MBBI != MBBE; ++MBBI)
2270b57cec5SDimitry Andric     if (getRegReferences(*MBBI, SrcReg))
2280b57cec5SDimitry Andric       return false;
2290b57cec5SDimitry Andric 
2300b57cec5SDimitry Andric   // The transformation is OK.  Rebuild Branch as a BRCT(G) or BRCTH.
2310b57cec5SDimitry Andric   MachineOperand Target(Branch->getOperand(2));
2320b57cec5SDimitry Andric   while (Branch->getNumOperands())
2330b57cec5SDimitry Andric     Branch->RemoveOperand(0);
2340b57cec5SDimitry Andric   Branch->setDesc(TII->get(BRCT));
2350b57cec5SDimitry Andric   MachineInstrBuilder MIB(*Branch->getParent()->getParent(), Branch);
2360b57cec5SDimitry Andric   MIB.add(MI.getOperand(0)).add(MI.getOperand(1)).add(Target);
2370b57cec5SDimitry Andric   // Add a CC def to BRCT(G), since we may have to split them again if the
2380b57cec5SDimitry Andric   // branch displacement overflows.  BRCTH has a 32-bit displacement, so
2390b57cec5SDimitry Andric   // this is not necessary there.
2400b57cec5SDimitry Andric   if (BRCT != SystemZ::BRCTH)
2410b57cec5SDimitry Andric     MIB.addReg(SystemZ::CC, RegState::ImplicitDefine | RegState::Dead);
2420b57cec5SDimitry Andric   MI.eraseFromParent();
2430b57cec5SDimitry Andric   return true;
2440b57cec5SDimitry Andric }
2450b57cec5SDimitry Andric 
2460b57cec5SDimitry Andric // Compare compares the result of MI against zero.  If MI is a suitable load
2470b57cec5SDimitry Andric // instruction and if CCUsers is a single conditional trap on zero, eliminate
2480b57cec5SDimitry Andric // the load and convert the branch to a load-and-trap.  Return true on success.
2490b57cec5SDimitry Andric bool SystemZElimCompare::convertToLoadAndTrap(
2500b57cec5SDimitry Andric     MachineInstr &MI, MachineInstr &Compare,
2510b57cec5SDimitry Andric     SmallVectorImpl<MachineInstr *> &CCUsers) {
2520b57cec5SDimitry Andric   unsigned LATOpcode = TII->getLoadAndTrap(MI.getOpcode());
2530b57cec5SDimitry Andric   if (!LATOpcode)
2540b57cec5SDimitry Andric     return false;
2550b57cec5SDimitry Andric 
2560b57cec5SDimitry Andric   // Check whether we have a single CondTrap that traps on zero.
2570b57cec5SDimitry Andric   if (CCUsers.size() != 1)
2580b57cec5SDimitry Andric     return false;
2590b57cec5SDimitry Andric   MachineInstr *Branch = CCUsers[0];
2600b57cec5SDimitry Andric   if (Branch->getOpcode() != SystemZ::CondTrap ||
2610b57cec5SDimitry Andric       Branch->getOperand(0).getImm() != SystemZ::CCMASK_ICMP ||
2620b57cec5SDimitry Andric       Branch->getOperand(1).getImm() != SystemZ::CCMASK_CMP_EQ)
2630b57cec5SDimitry Andric     return false;
2640b57cec5SDimitry Andric 
2650b57cec5SDimitry Andric   // We already know that there are no references to the register between
2660b57cec5SDimitry Andric   // MI and Compare.  Make sure that there are also no references between
2670b57cec5SDimitry Andric   // Compare and Branch.
2680b57cec5SDimitry Andric   unsigned SrcReg = getCompareSourceReg(Compare);
2690b57cec5SDimitry Andric   MachineBasicBlock::iterator MBBI = Compare, MBBE = Branch;
2700b57cec5SDimitry Andric   for (++MBBI; MBBI != MBBE; ++MBBI)
2710b57cec5SDimitry Andric     if (getRegReferences(*MBBI, SrcReg))
2720b57cec5SDimitry Andric       return false;
2730b57cec5SDimitry Andric 
2740b57cec5SDimitry Andric   // The transformation is OK.  Rebuild Branch as a load-and-trap.
2750b57cec5SDimitry Andric   while (Branch->getNumOperands())
2760b57cec5SDimitry Andric     Branch->RemoveOperand(0);
2770b57cec5SDimitry Andric   Branch->setDesc(TII->get(LATOpcode));
2780b57cec5SDimitry Andric   MachineInstrBuilder(*Branch->getParent()->getParent(), Branch)
2790b57cec5SDimitry Andric       .add(MI.getOperand(0))
2800b57cec5SDimitry Andric       .add(MI.getOperand(1))
2810b57cec5SDimitry Andric       .add(MI.getOperand(2))
2820b57cec5SDimitry Andric       .add(MI.getOperand(3));
2830b57cec5SDimitry Andric   MI.eraseFromParent();
2840b57cec5SDimitry Andric   return true;
2850b57cec5SDimitry Andric }
2860b57cec5SDimitry Andric 
2870b57cec5SDimitry Andric // If MI is a load instruction, try to convert it into a LOAD AND TEST.
2880b57cec5SDimitry Andric // Return true on success.
2890b57cec5SDimitry Andric bool SystemZElimCompare::convertToLoadAndTest(
2900b57cec5SDimitry Andric     MachineInstr &MI, MachineInstr &Compare,
2910b57cec5SDimitry Andric     SmallVectorImpl<MachineInstr *> &CCUsers) {
2920b57cec5SDimitry Andric 
2930b57cec5SDimitry Andric   // Try to adjust CC masks for the LOAD AND TEST opcode that could replace MI.
2940b57cec5SDimitry Andric   unsigned Opcode = TII->getLoadAndTest(MI.getOpcode());
2950b57cec5SDimitry Andric   if (!Opcode || !adjustCCMasksForInstr(MI, Compare, CCUsers, Opcode))
2960b57cec5SDimitry Andric     return false;
2970b57cec5SDimitry Andric 
2980b57cec5SDimitry Andric   // Rebuild to get the CC operand in the right place.
2990b57cec5SDimitry Andric   auto MIB = BuildMI(*MI.getParent(), MI, MI.getDebugLoc(), TII->get(Opcode));
3000b57cec5SDimitry Andric   for (const auto &MO : MI.operands())
3010b57cec5SDimitry Andric     MIB.add(MO);
3020b57cec5SDimitry Andric   MIB.setMemRefs(MI.memoperands());
3030b57cec5SDimitry Andric   MI.eraseFromParent();
3040b57cec5SDimitry Andric 
3050b57cec5SDimitry Andric   return true;
3060b57cec5SDimitry Andric }
3070b57cec5SDimitry Andric 
3080b57cec5SDimitry Andric // The CC users in CCUsers are testing the result of a comparison of some
3090b57cec5SDimitry Andric // value X against zero and we know that any CC value produced by MI would
3100b57cec5SDimitry Andric // also reflect the value of X.  ConvOpc may be used to pass the transfomed
3110b57cec5SDimitry Andric // opcode MI will have if this succeeds.  Try to adjust CCUsers so that they
3120b57cec5SDimitry Andric // test the result of MI directly, returning true on success.  Leave
3130b57cec5SDimitry Andric // everything unchanged on failure.
3140b57cec5SDimitry Andric bool SystemZElimCompare::adjustCCMasksForInstr(
3150b57cec5SDimitry Andric     MachineInstr &MI, MachineInstr &Compare,
3160b57cec5SDimitry Andric     SmallVectorImpl<MachineInstr *> &CCUsers,
3170b57cec5SDimitry Andric     unsigned ConvOpc) {
3180b57cec5SDimitry Andric   int Opcode = (ConvOpc ? ConvOpc : MI.getOpcode());
3190b57cec5SDimitry Andric   const MCInstrDesc &Desc = TII->get(Opcode);
3200b57cec5SDimitry Andric   unsigned MIFlags = Desc.TSFlags;
3210b57cec5SDimitry Andric 
3220b57cec5SDimitry Andric   // See which compare-style condition codes are available.
3230b57cec5SDimitry Andric   unsigned ReusableCCMask = SystemZII::getCompareZeroCCMask(MIFlags);
3240b57cec5SDimitry Andric 
3250b57cec5SDimitry Andric   // For unsigned comparisons with zero, only equality makes sense.
3260b57cec5SDimitry Andric   unsigned CompareFlags = Compare.getDesc().TSFlags;
3270b57cec5SDimitry Andric   if (CompareFlags & SystemZII::IsLogical)
3280b57cec5SDimitry Andric     ReusableCCMask &= SystemZ::CCMASK_CMP_EQ;
3290b57cec5SDimitry Andric 
3300b57cec5SDimitry Andric   if (ReusableCCMask == 0)
3310b57cec5SDimitry Andric     return false;
3320b57cec5SDimitry Andric 
3330b57cec5SDimitry Andric   unsigned CCValues = SystemZII::getCCValues(MIFlags);
3340b57cec5SDimitry Andric   assert((ReusableCCMask & ~CCValues) == 0 && "Invalid CCValues");
3350b57cec5SDimitry Andric 
3360b57cec5SDimitry Andric   bool MIEquivalentToCmp =
3370b57cec5SDimitry Andric     (ReusableCCMask == CCValues &&
3380b57cec5SDimitry Andric      CCValues == SystemZII::getCCValues(CompareFlags));
3390b57cec5SDimitry Andric 
3400b57cec5SDimitry Andric   if (!MIEquivalentToCmp) {
3410b57cec5SDimitry Andric     // Now check whether these flags are enough for all users.
3420b57cec5SDimitry Andric     SmallVector<MachineOperand *, 4> AlterMasks;
3430b57cec5SDimitry Andric     for (unsigned int I = 0, E = CCUsers.size(); I != E; ++I) {
3440b57cec5SDimitry Andric       MachineInstr *MI = CCUsers[I];
3450b57cec5SDimitry Andric 
3460b57cec5SDimitry Andric       // Fail if this isn't a use of CC that we understand.
3470b57cec5SDimitry Andric       unsigned Flags = MI->getDesc().TSFlags;
3480b57cec5SDimitry Andric       unsigned FirstOpNum;
3490b57cec5SDimitry Andric       if (Flags & SystemZII::CCMaskFirst)
3500b57cec5SDimitry Andric         FirstOpNum = 0;
3510b57cec5SDimitry Andric       else if (Flags & SystemZII::CCMaskLast)
3520b57cec5SDimitry Andric         FirstOpNum = MI->getNumExplicitOperands() - 2;
3530b57cec5SDimitry Andric       else
3540b57cec5SDimitry Andric         return false;
3550b57cec5SDimitry Andric 
3560b57cec5SDimitry Andric       // Check whether the instruction predicate treats all CC values
3570b57cec5SDimitry Andric       // outside of ReusableCCMask in the same way.  In that case it
3580b57cec5SDimitry Andric       // doesn't matter what those CC values mean.
3590b57cec5SDimitry Andric       unsigned CCValid = MI->getOperand(FirstOpNum).getImm();
3600b57cec5SDimitry Andric       unsigned CCMask = MI->getOperand(FirstOpNum + 1).getImm();
3610b57cec5SDimitry Andric       unsigned OutValid = ~ReusableCCMask & CCValid;
3620b57cec5SDimitry Andric       unsigned OutMask = ~ReusableCCMask & CCMask;
3630b57cec5SDimitry Andric       if (OutMask != 0 && OutMask != OutValid)
3640b57cec5SDimitry Andric         return false;
3650b57cec5SDimitry Andric 
3660b57cec5SDimitry Andric       AlterMasks.push_back(&MI->getOperand(FirstOpNum));
3670b57cec5SDimitry Andric       AlterMasks.push_back(&MI->getOperand(FirstOpNum + 1));
3680b57cec5SDimitry Andric     }
3690b57cec5SDimitry Andric 
3700b57cec5SDimitry Andric     // All users are OK.  Adjust the masks for MI.
3710b57cec5SDimitry Andric     for (unsigned I = 0, E = AlterMasks.size(); I != E; I += 2) {
3720b57cec5SDimitry Andric       AlterMasks[I]->setImm(CCValues);
3730b57cec5SDimitry Andric       unsigned CCMask = AlterMasks[I + 1]->getImm();
3740b57cec5SDimitry Andric       if (CCMask & ~ReusableCCMask)
3750b57cec5SDimitry Andric         AlterMasks[I + 1]->setImm((CCMask & ReusableCCMask) |
3760b57cec5SDimitry Andric                                   (CCValues & ~ReusableCCMask));
3770b57cec5SDimitry Andric     }
3780b57cec5SDimitry Andric   }
3790b57cec5SDimitry Andric 
3800b57cec5SDimitry Andric   // CC is now live after MI.
381*8bcb0991SDimitry Andric   if (!ConvOpc)
382*8bcb0991SDimitry Andric     MI.clearRegisterDeads(SystemZ::CC);
3830b57cec5SDimitry Andric 
3840b57cec5SDimitry Andric   // Check if MI lies before Compare.
3850b57cec5SDimitry Andric   bool BeforeCmp = false;
3860b57cec5SDimitry Andric   MachineBasicBlock::iterator MBBI = MI, MBBE = MI.getParent()->end();
3870b57cec5SDimitry Andric   for (++MBBI; MBBI != MBBE; ++MBBI)
3880b57cec5SDimitry Andric     if (MBBI == Compare) {
3890b57cec5SDimitry Andric       BeforeCmp = true;
3900b57cec5SDimitry Andric       break;
3910b57cec5SDimitry Andric     }
3920b57cec5SDimitry Andric 
3930b57cec5SDimitry Andric   // Clear any intervening kills of CC.
3940b57cec5SDimitry Andric   if (BeforeCmp) {
3950b57cec5SDimitry Andric     MachineBasicBlock::iterator MBBI = MI, MBBE = Compare;
3960b57cec5SDimitry Andric     for (++MBBI; MBBI != MBBE; ++MBBI)
3970b57cec5SDimitry Andric       MBBI->clearRegisterKills(SystemZ::CC, TRI);
3980b57cec5SDimitry Andric   }
3990b57cec5SDimitry Andric 
4000b57cec5SDimitry Andric   return true;
4010b57cec5SDimitry Andric }
4020b57cec5SDimitry Andric 
4030b57cec5SDimitry Andric // Return true if Compare is a comparison against zero.
4040b57cec5SDimitry Andric static bool isCompareZero(MachineInstr &Compare) {
4050b57cec5SDimitry Andric   switch (Compare.getOpcode()) {
4060b57cec5SDimitry Andric   case SystemZ::LTEBRCompare:
4070b57cec5SDimitry Andric   case SystemZ::LTDBRCompare:
4080b57cec5SDimitry Andric   case SystemZ::LTXBRCompare:
4090b57cec5SDimitry Andric     return true;
4100b57cec5SDimitry Andric 
4110b57cec5SDimitry Andric   default:
4120b57cec5SDimitry Andric     if (isLoadAndTestAsCmp(Compare))
4130b57cec5SDimitry Andric       return true;
4140b57cec5SDimitry Andric     return Compare.getNumExplicitOperands() == 2 &&
4150b57cec5SDimitry Andric            Compare.getOperand(1).isImm() && Compare.getOperand(1).getImm() == 0;
4160b57cec5SDimitry Andric   }
4170b57cec5SDimitry Andric }
4180b57cec5SDimitry Andric 
4190b57cec5SDimitry Andric // Try to optimize cases where comparison instruction Compare is testing
4200b57cec5SDimitry Andric // a value against zero.  Return true on success and if Compare should be
4210b57cec5SDimitry Andric // deleted as dead.  CCUsers is the list of instructions that use the CC
4220b57cec5SDimitry Andric // value produced by Compare.
4230b57cec5SDimitry Andric bool SystemZElimCompare::optimizeCompareZero(
4240b57cec5SDimitry Andric     MachineInstr &Compare, SmallVectorImpl<MachineInstr *> &CCUsers) {
4250b57cec5SDimitry Andric   if (!isCompareZero(Compare))
4260b57cec5SDimitry Andric     return false;
4270b57cec5SDimitry Andric 
4280b57cec5SDimitry Andric   // Search back for CC results that are based on the first operand.
4290b57cec5SDimitry Andric   unsigned SrcReg = getCompareSourceReg(Compare);
4300b57cec5SDimitry Andric   MachineBasicBlock &MBB = *Compare.getParent();
4310b57cec5SDimitry Andric   Reference CCRefs;
4320b57cec5SDimitry Andric   Reference SrcRefs;
4330b57cec5SDimitry Andric   for (MachineBasicBlock::reverse_iterator MBBI =
4340b57cec5SDimitry Andric          std::next(MachineBasicBlock::reverse_iterator(&Compare)),
4350b57cec5SDimitry Andric          MBBE = MBB.rend(); MBBI != MBBE;) {
4360b57cec5SDimitry Andric     MachineInstr &MI = *MBBI++;
4370b57cec5SDimitry Andric     if (resultTests(MI, SrcReg)) {
4380b57cec5SDimitry Andric       // Try to remove both MI and Compare by converting a branch to BRCT(G).
4390b57cec5SDimitry Andric       // or a load-and-trap instruction.  We don't care in this case whether
4400b57cec5SDimitry Andric       // CC is modified between MI and Compare.
4410b57cec5SDimitry Andric       if (!CCRefs.Use && !SrcRefs) {
4420b57cec5SDimitry Andric         if (convertToBRCT(MI, Compare, CCUsers)) {
4430b57cec5SDimitry Andric           BranchOnCounts += 1;
4440b57cec5SDimitry Andric           return true;
4450b57cec5SDimitry Andric         }
4460b57cec5SDimitry Andric         if (convertToLoadAndTrap(MI, Compare, CCUsers)) {
4470b57cec5SDimitry Andric           LoadAndTraps += 1;
4480b57cec5SDimitry Andric           return true;
4490b57cec5SDimitry Andric         }
4500b57cec5SDimitry Andric       }
4510b57cec5SDimitry Andric       // Try to eliminate Compare by reusing a CC result from MI.
4520b57cec5SDimitry Andric       if ((!CCRefs && convertToLoadAndTest(MI, Compare, CCUsers)) ||
4530b57cec5SDimitry Andric           (!CCRefs.Def && adjustCCMasksForInstr(MI, Compare, CCUsers))) {
4540b57cec5SDimitry Andric         EliminatedComparisons += 1;
4550b57cec5SDimitry Andric         return true;
4560b57cec5SDimitry Andric       }
4570b57cec5SDimitry Andric     }
4580b57cec5SDimitry Andric     SrcRefs |= getRegReferences(MI, SrcReg);
4590b57cec5SDimitry Andric     if (SrcRefs.Def)
4600b57cec5SDimitry Andric       break;
4610b57cec5SDimitry Andric     CCRefs |= getRegReferences(MI, SystemZ::CC);
4620b57cec5SDimitry Andric     if (CCRefs.Use && CCRefs.Def)
4630b57cec5SDimitry Andric       break;
4640b57cec5SDimitry Andric   }
4650b57cec5SDimitry Andric 
4660b57cec5SDimitry Andric   // Also do a forward search to handle cases where an instruction after the
4670b57cec5SDimitry Andric   // compare can be converted, like
4680b57cec5SDimitry Andric   // LTEBRCompare %f0s, %f0s; %f2s = LER %f0s  =>  LTEBRCompare %f2s, %f0s
4690b57cec5SDimitry Andric   for (MachineBasicBlock::iterator MBBI =
4700b57cec5SDimitry Andric          std::next(MachineBasicBlock::iterator(&Compare)), MBBE = MBB.end();
4710b57cec5SDimitry Andric        MBBI != MBBE;) {
4720b57cec5SDimitry Andric     MachineInstr &MI = *MBBI++;
4730b57cec5SDimitry Andric     if (preservesValueOf(MI, SrcReg)) {
4740b57cec5SDimitry Andric       // Try to eliminate Compare by reusing a CC result from MI.
4750b57cec5SDimitry Andric       if (convertToLoadAndTest(MI, Compare, CCUsers)) {
4760b57cec5SDimitry Andric         EliminatedComparisons += 1;
4770b57cec5SDimitry Andric         return true;
4780b57cec5SDimitry Andric       }
4790b57cec5SDimitry Andric     }
4800b57cec5SDimitry Andric     if (getRegReferences(MI, SrcReg).Def)
4810b57cec5SDimitry Andric       return false;
4820b57cec5SDimitry Andric     if (getRegReferences(MI, SystemZ::CC))
4830b57cec5SDimitry Andric       return false;
4840b57cec5SDimitry Andric   }
4850b57cec5SDimitry Andric 
4860b57cec5SDimitry Andric   return false;
4870b57cec5SDimitry Andric }
4880b57cec5SDimitry Andric 
4890b57cec5SDimitry Andric // Try to fuse comparison instruction Compare into a later branch.
4900b57cec5SDimitry Andric // Return true on success and if Compare is therefore redundant.
4910b57cec5SDimitry Andric bool SystemZElimCompare::fuseCompareOperations(
4920b57cec5SDimitry Andric     MachineInstr &Compare, SmallVectorImpl<MachineInstr *> &CCUsers) {
4930b57cec5SDimitry Andric   // See whether we have a single branch with which to fuse.
4940b57cec5SDimitry Andric   if (CCUsers.size() != 1)
4950b57cec5SDimitry Andric     return false;
4960b57cec5SDimitry Andric   MachineInstr *Branch = CCUsers[0];
4970b57cec5SDimitry Andric   SystemZII::FusedCompareType Type;
4980b57cec5SDimitry Andric   switch (Branch->getOpcode()) {
4990b57cec5SDimitry Andric   case SystemZ::BRC:
5000b57cec5SDimitry Andric     Type = SystemZII::CompareAndBranch;
5010b57cec5SDimitry Andric     break;
5020b57cec5SDimitry Andric   case SystemZ::CondReturn:
5030b57cec5SDimitry Andric     Type = SystemZII::CompareAndReturn;
5040b57cec5SDimitry Andric     break;
5050b57cec5SDimitry Andric   case SystemZ::CallBCR:
5060b57cec5SDimitry Andric     Type = SystemZII::CompareAndSibcall;
5070b57cec5SDimitry Andric     break;
5080b57cec5SDimitry Andric   case SystemZ::CondTrap:
5090b57cec5SDimitry Andric     Type = SystemZII::CompareAndTrap;
5100b57cec5SDimitry Andric     break;
5110b57cec5SDimitry Andric   default:
5120b57cec5SDimitry Andric     return false;
5130b57cec5SDimitry Andric   }
5140b57cec5SDimitry Andric 
5150b57cec5SDimitry Andric   // See whether we have a comparison that can be fused.
5160b57cec5SDimitry Andric   unsigned FusedOpcode =
5170b57cec5SDimitry Andric       TII->getFusedCompare(Compare.getOpcode(), Type, &Compare);
5180b57cec5SDimitry Andric   if (!FusedOpcode)
5190b57cec5SDimitry Andric     return false;
5200b57cec5SDimitry Andric 
5210b57cec5SDimitry Andric   // Make sure that the operands are available at the branch.
5220b57cec5SDimitry Andric   // SrcReg2 is the register if the source operand is a register,
5230b57cec5SDimitry Andric   // 0 if the source operand is immediate, and the base register
5240b57cec5SDimitry Andric   // if the source operand is memory (index is not supported).
5250b57cec5SDimitry Andric   Register SrcReg = Compare.getOperand(0).getReg();
5260b57cec5SDimitry Andric   Register SrcReg2 =
5270b57cec5SDimitry Andric     Compare.getOperand(1).isReg() ? Compare.getOperand(1).getReg() : Register();
5280b57cec5SDimitry Andric   MachineBasicBlock::iterator MBBI = Compare, MBBE = Branch;
5290b57cec5SDimitry Andric   for (++MBBI; MBBI != MBBE; ++MBBI)
5300b57cec5SDimitry Andric     if (MBBI->modifiesRegister(SrcReg, TRI) ||
5310b57cec5SDimitry Andric         (SrcReg2 && MBBI->modifiesRegister(SrcReg2, TRI)))
5320b57cec5SDimitry Andric       return false;
5330b57cec5SDimitry Andric 
5340b57cec5SDimitry Andric   // Read the branch mask, target (if applicable), regmask (if applicable).
5350b57cec5SDimitry Andric   MachineOperand CCMask(MBBI->getOperand(1));
5360b57cec5SDimitry Andric   assert((CCMask.getImm() & ~SystemZ::CCMASK_ICMP) == 0 &&
5370b57cec5SDimitry Andric          "Invalid condition-code mask for integer comparison");
5380b57cec5SDimitry Andric   // This is only valid for CompareAndBranch.
5390b57cec5SDimitry Andric   MachineOperand Target(MBBI->getOperand(
5400b57cec5SDimitry Andric     Type == SystemZII::CompareAndBranch ? 2 : 0));
5410b57cec5SDimitry Andric   const uint32_t *RegMask;
5420b57cec5SDimitry Andric   if (Type == SystemZII::CompareAndSibcall)
5430b57cec5SDimitry Andric     RegMask = MBBI->getOperand(2).getRegMask();
5440b57cec5SDimitry Andric 
5450b57cec5SDimitry Andric   // Clear out all current operands.
5460b57cec5SDimitry Andric   int CCUse = MBBI->findRegisterUseOperandIdx(SystemZ::CC, false, TRI);
5470b57cec5SDimitry Andric   assert(CCUse >= 0 && "BRC/BCR must use CC");
5480b57cec5SDimitry Andric   Branch->RemoveOperand(CCUse);
5490b57cec5SDimitry Andric   // Remove target (branch) or regmask (sibcall).
5500b57cec5SDimitry Andric   if (Type == SystemZII::CompareAndBranch ||
5510b57cec5SDimitry Andric       Type == SystemZII::CompareAndSibcall)
5520b57cec5SDimitry Andric     Branch->RemoveOperand(2);
5530b57cec5SDimitry Andric   Branch->RemoveOperand(1);
5540b57cec5SDimitry Andric   Branch->RemoveOperand(0);
5550b57cec5SDimitry Andric 
5560b57cec5SDimitry Andric   // Rebuild Branch as a fused compare and branch.
5570b57cec5SDimitry Andric   // SrcNOps is the number of MI operands of the compare instruction
5580b57cec5SDimitry Andric   // that we need to copy over.
5590b57cec5SDimitry Andric   unsigned SrcNOps = 2;
5600b57cec5SDimitry Andric   if (FusedOpcode == SystemZ::CLT || FusedOpcode == SystemZ::CLGT)
5610b57cec5SDimitry Andric     SrcNOps = 3;
5620b57cec5SDimitry Andric   Branch->setDesc(TII->get(FusedOpcode));
5630b57cec5SDimitry Andric   MachineInstrBuilder MIB(*Branch->getParent()->getParent(), Branch);
5640b57cec5SDimitry Andric   for (unsigned I = 0; I < SrcNOps; I++)
5650b57cec5SDimitry Andric     MIB.add(Compare.getOperand(I));
5660b57cec5SDimitry Andric   MIB.add(CCMask);
5670b57cec5SDimitry Andric 
5680b57cec5SDimitry Andric   if (Type == SystemZII::CompareAndBranch) {
5690b57cec5SDimitry Andric     // Only conditional branches define CC, as they may be converted back
5700b57cec5SDimitry Andric     // to a non-fused branch because of a long displacement.  Conditional
5710b57cec5SDimitry Andric     // returns don't have that problem.
5720b57cec5SDimitry Andric     MIB.add(Target).addReg(SystemZ::CC,
5730b57cec5SDimitry Andric                            RegState::ImplicitDefine | RegState::Dead);
5740b57cec5SDimitry Andric   }
5750b57cec5SDimitry Andric 
5760b57cec5SDimitry Andric   if (Type == SystemZII::CompareAndSibcall)
5770b57cec5SDimitry Andric     MIB.addRegMask(RegMask);
5780b57cec5SDimitry Andric 
5790b57cec5SDimitry Andric   // Clear any intervening kills of SrcReg and SrcReg2.
5800b57cec5SDimitry Andric   MBBI = Compare;
5810b57cec5SDimitry Andric   for (++MBBI; MBBI != MBBE; ++MBBI) {
5820b57cec5SDimitry Andric     MBBI->clearRegisterKills(SrcReg, TRI);
5830b57cec5SDimitry Andric     if (SrcReg2)
5840b57cec5SDimitry Andric       MBBI->clearRegisterKills(SrcReg2, TRI);
5850b57cec5SDimitry Andric   }
5860b57cec5SDimitry Andric   FusedComparisons += 1;
5870b57cec5SDimitry Andric   return true;
5880b57cec5SDimitry Andric }
5890b57cec5SDimitry Andric 
5900b57cec5SDimitry Andric // Process all comparison instructions in MBB.  Return true if something
5910b57cec5SDimitry Andric // changed.
5920b57cec5SDimitry Andric bool SystemZElimCompare::processBlock(MachineBasicBlock &MBB) {
5930b57cec5SDimitry Andric   bool Changed = false;
5940b57cec5SDimitry Andric 
5950b57cec5SDimitry Andric   // Walk backwards through the block looking for comparisons, recording
5960b57cec5SDimitry Andric   // all CC users as we go.  The subroutines can delete Compare and
5970b57cec5SDimitry Andric   // instructions before it.
5980b57cec5SDimitry Andric   bool CompleteCCUsers = !isCCLiveOut(MBB);
5990b57cec5SDimitry Andric   SmallVector<MachineInstr *, 4> CCUsers;
6000b57cec5SDimitry Andric   MachineBasicBlock::iterator MBBI = MBB.end();
6010b57cec5SDimitry Andric   while (MBBI != MBB.begin()) {
6020b57cec5SDimitry Andric     MachineInstr &MI = *--MBBI;
6030b57cec5SDimitry Andric     if (CompleteCCUsers && (MI.isCompare() || isLoadAndTestAsCmp(MI)) &&
6040b57cec5SDimitry Andric         (optimizeCompareZero(MI, CCUsers) ||
6050b57cec5SDimitry Andric          fuseCompareOperations(MI, CCUsers))) {
6060b57cec5SDimitry Andric       ++MBBI;
6070b57cec5SDimitry Andric       MI.eraseFromParent();
6080b57cec5SDimitry Andric       Changed = true;
6090b57cec5SDimitry Andric       CCUsers.clear();
6100b57cec5SDimitry Andric       continue;
6110b57cec5SDimitry Andric     }
6120b57cec5SDimitry Andric 
6130b57cec5SDimitry Andric     if (MI.definesRegister(SystemZ::CC)) {
6140b57cec5SDimitry Andric       CCUsers.clear();
6150b57cec5SDimitry Andric       CompleteCCUsers = true;
6160b57cec5SDimitry Andric     }
6170b57cec5SDimitry Andric     if (MI.readsRegister(SystemZ::CC) && CompleteCCUsers)
6180b57cec5SDimitry Andric       CCUsers.push_back(&MI);
6190b57cec5SDimitry Andric   }
6200b57cec5SDimitry Andric   return Changed;
6210b57cec5SDimitry Andric }
6220b57cec5SDimitry Andric 
6230b57cec5SDimitry Andric bool SystemZElimCompare::runOnMachineFunction(MachineFunction &F) {
6240b57cec5SDimitry Andric   if (skipFunction(F.getFunction()))
6250b57cec5SDimitry Andric     return false;
6260b57cec5SDimitry Andric 
6270b57cec5SDimitry Andric   TII = static_cast<const SystemZInstrInfo *>(F.getSubtarget().getInstrInfo());
6280b57cec5SDimitry Andric   TRI = &TII->getRegisterInfo();
6290b57cec5SDimitry Andric 
6300b57cec5SDimitry Andric   bool Changed = false;
6310b57cec5SDimitry Andric   for (auto &MBB : F)
6320b57cec5SDimitry Andric     Changed |= processBlock(MBB);
6330b57cec5SDimitry Andric 
6340b57cec5SDimitry Andric   return Changed;
6350b57cec5SDimitry Andric }
6360b57cec5SDimitry Andric 
6370b57cec5SDimitry Andric FunctionPass *llvm::createSystemZElimComparePass(SystemZTargetMachine &TM) {
6380b57cec5SDimitry Andric   return new SystemZElimCompare(TM);
6390b57cec5SDimitry Andric }
640