| //===-- Thumb2ITBlockPass.cpp - Insert Thumb-2 IT blocks ------------------===// |
| // |
| // 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 "ARM.h" |
| #include "ARMMachineFunctionInfo.h" |
| #include "ARMSubtarget.h" |
| #include "MCTargetDesc/ARMBaseInfo.h" |
| #include "Thumb2InstrInfo.h" |
| #include "llvm/ADT/SmallSet.h" |
| #include "llvm/ADT/SmallVector.h" |
| #include "llvm/ADT/Statistic.h" |
| #include "llvm/ADT/StringRef.h" |
| #include "llvm/CodeGen/MachineBasicBlock.h" |
| #include "llvm/CodeGen/MachineFunction.h" |
| #include "llvm/CodeGen/MachineFunctionPass.h" |
| #include "llvm/CodeGen/MachineInstr.h" |
| #include "llvm/CodeGen/MachineInstrBuilder.h" |
| #include "llvm/CodeGen/MachineInstrBundle.h" |
| #include "llvm/CodeGen/MachineOperand.h" |
| #include "llvm/IR/DebugLoc.h" |
| #include "llvm/MC/MCInstrDesc.h" |
| #include "llvm/MC/MCRegisterInfo.h" |
| #include <cassert> |
| #include <new> |
| |
| using namespace llvm; |
| |
| #define DEBUG_TYPE "thumb2-it" |
| #define PASS_NAME "Thumb IT blocks insertion pass" |
| |
| STATISTIC(NumITs, "Number of IT blocks inserted"); |
| STATISTIC(NumMovedInsts, "Number of predicated instructions moved"); |
| |
| using RegisterSet = SmallSet<unsigned, 4>; |
| |
| namespace { |
| |
| class Thumb2ITBlock : public MachineFunctionPass { |
| public: |
| static char ID; |
| |
| bool restrictIT; |
| const Thumb2InstrInfo *TII; |
| const TargetRegisterInfo *TRI; |
| ARMFunctionInfo *AFI; |
| |
| Thumb2ITBlock() : MachineFunctionPass(ID) {} |
| |
| bool runOnMachineFunction(MachineFunction &Fn) override; |
| |
| MachineFunctionProperties getRequiredProperties() const override { |
| return MachineFunctionProperties().set( |
| MachineFunctionProperties::Property::NoVRegs); |
| } |
| |
| StringRef getPassName() const override { |
| return PASS_NAME; |
| } |
| |
| private: |
| bool MoveCopyOutOfITBlock(MachineInstr *MI, |
| ARMCC::CondCodes CC, ARMCC::CondCodes OCC, |
| RegisterSet &Defs, RegisterSet &Uses); |
| bool InsertITInstructions(MachineBasicBlock &Block); |
| }; |
| |
| char Thumb2ITBlock::ID = 0; |
| |
| } // end anonymous namespace |
| |
| INITIALIZE_PASS(Thumb2ITBlock, DEBUG_TYPE, PASS_NAME, false, false) |
| |
| /// TrackDefUses - Tracking what registers are being defined and used by |
| /// instructions in the IT block. This also tracks "dependencies", i.e. uses |
| /// in the IT block that are defined before the IT instruction. |
| static void TrackDefUses(MachineInstr *MI, RegisterSet &Defs, RegisterSet &Uses, |
| const TargetRegisterInfo *TRI) { |
| using RegList = SmallVector<unsigned, 4>; |
| RegList LocalDefs; |
| RegList LocalUses; |
| |
| for (auto &MO : MI->operands()) { |
| if (!MO.isReg()) |
| continue; |
| unsigned Reg = MO.getReg(); |
| if (!Reg || Reg == ARM::ITSTATE || Reg == ARM::SP) |
| continue; |
| if (MO.isUse()) |
| LocalUses.push_back(Reg); |
| else |
| LocalDefs.push_back(Reg); |
| } |
| |
| auto InsertUsesDefs = [&](RegList &Regs, RegisterSet &UsesDefs) { |
| for (unsigned Reg : Regs) |
| for (MCSubRegIterator Subreg(Reg, TRI, /*IncludeSelf=*/true); |
| Subreg.isValid(); ++Subreg) |
| UsesDefs.insert(*Subreg); |
| }; |
| |
| InsertUsesDefs(LocalDefs, Defs); |
| InsertUsesDefs(LocalUses, Uses); |
| } |
| |
| /// Clear kill flags for any uses in the given set. This will likely |
| /// conservatively remove more kill flags than are necessary, but removing them |
| /// is safer than incorrect kill flags remaining on instructions. |
| static void ClearKillFlags(MachineInstr *MI, RegisterSet &Uses) { |
| for (MachineOperand &MO : MI->operands()) { |
| if (!MO.isReg() || MO.isDef() || !MO.isKill()) |
| continue; |
| if (!Uses.count(MO.getReg())) |
| continue; |
| MO.setIsKill(false); |
| } |
| } |
| |
| static bool isCopy(MachineInstr *MI) { |
| switch (MI->getOpcode()) { |
| default: |
| return false; |
| case ARM::MOVr: |
| case ARM::MOVr_TC: |
| case ARM::tMOVr: |
| case ARM::t2MOVr: |
| return true; |
| } |
| } |
| |
| bool |
| Thumb2ITBlock::MoveCopyOutOfITBlock(MachineInstr *MI, |
| ARMCC::CondCodes CC, ARMCC::CondCodes OCC, |
| RegisterSet &Defs, RegisterSet &Uses) { |
| if (!isCopy(MI)) |
| return false; |
| // llvm models select's as two-address instructions. That means a copy |
| // is inserted before a t2MOVccr, etc. If the copy is scheduled in |
| // between selects we would end up creating multiple IT blocks. |
| assert(MI->getOperand(0).getSubReg() == 0 && |
| MI->getOperand(1).getSubReg() == 0 && |
| "Sub-register indices still around?"); |
| |
| unsigned DstReg = MI->getOperand(0).getReg(); |
| unsigned SrcReg = MI->getOperand(1).getReg(); |
| |
| // First check if it's safe to move it. |
| if (Uses.count(DstReg) || Defs.count(SrcReg)) |
| return false; |
| |
| // If the CPSR is defined by this copy, then we don't want to move it. E.g., |
| // if we have: |
| // |
| // movs r1, r1 |
| // rsb r1, 0 |
| // movs r2, r2 |
| // rsb r2, 0 |
| // |
| // we don't want this to be converted to: |
| // |
| // movs r1, r1 |
| // movs r2, r2 |
| // itt mi |
| // rsb r1, 0 |
| // rsb r2, 0 |
| // |
| const MCInstrDesc &MCID = MI->getDesc(); |
| if (MI->hasOptionalDef() && |
| MI->getOperand(MCID.getNumOperands() - 1).getReg() == ARM::CPSR) |
| return false; |
| |
| // Then peek at the next instruction to see if it's predicated on CC or OCC. |
| // If not, then there is nothing to be gained by moving the copy. |
| MachineBasicBlock::iterator I = MI; |
| ++I; |
| MachineBasicBlock::iterator E = MI->getParent()->end(); |
| |
| while (I != E && I->isDebugInstr()) |
| ++I; |
| |
| if (I != E) { |
| unsigned NPredReg = 0; |
| ARMCC::CondCodes NCC = getITInstrPredicate(*I, NPredReg); |
| if (NCC == CC || NCC == OCC) |
| return true; |
| } |
| return false; |
| } |
| |
| bool Thumb2ITBlock::InsertITInstructions(MachineBasicBlock &MBB) { |
| bool Modified = false; |
| RegisterSet Defs, Uses; |
| MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end(); |
| |
| while (MBBI != E) { |
| MachineInstr *MI = &*MBBI; |
| DebugLoc dl = MI->getDebugLoc(); |
| unsigned PredReg = 0; |
| ARMCC::CondCodes CC = getITInstrPredicate(*MI, PredReg); |
| if (CC == ARMCC::AL) { |
| ++MBBI; |
| continue; |
| } |
| |
| Defs.clear(); |
| Uses.clear(); |
| TrackDefUses(MI, Defs, Uses, TRI); |
| |
| // Insert an IT instruction. |
| MachineInstrBuilder MIB = BuildMI(MBB, MBBI, dl, TII->get(ARM::t2IT)) |
| .addImm(CC); |
| |
| // Add implicit use of ITSTATE to IT block instructions. |
| MI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/, |
| true/*isImp*/, false/*isKill*/)); |
| |
| MachineInstr *LastITMI = MI; |
| MachineBasicBlock::iterator InsertPos = MIB.getInstr(); |
| ++MBBI; |
| |
| // Form IT block. |
| ARMCC::CondCodes OCC = ARMCC::getOppositeCondition(CC); |
| unsigned Mask = 0, Pos = 3; |
| |
| // v8 IT blocks are limited to one conditional op unless -arm-no-restrict-it |
| // is set: skip the loop |
| if (!restrictIT) { |
| // Branches, including tricky ones like LDM_RET, need to end an IT |
| // block so check the instruction we just put in the block. |
| for (; MBBI != E && Pos && |
| (!MI->isBranch() && !MI->isReturn()) ; ++MBBI) { |
| if (MBBI->isDebugInstr()) |
| continue; |
| |
| MachineInstr *NMI = &*MBBI; |
| MI = NMI; |
| |
| unsigned NPredReg = 0; |
| ARMCC::CondCodes NCC = getITInstrPredicate(*NMI, NPredReg); |
| if (NCC == CC || NCC == OCC) { |
| Mask |= ((NCC ^ CC) & 1) << Pos; |
| // Add implicit use of ITSTATE. |
| NMI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/, |
| true/*isImp*/, false/*isKill*/)); |
| LastITMI = NMI; |
| } else { |
| if (NCC == ARMCC::AL && |
| MoveCopyOutOfITBlock(NMI, CC, OCC, Defs, Uses)) { |
| --MBBI; |
| MBB.remove(NMI); |
| MBB.insert(InsertPos, NMI); |
| ClearKillFlags(MI, Uses); |
| ++NumMovedInsts; |
| continue; |
| } |
| break; |
| } |
| TrackDefUses(NMI, Defs, Uses, TRI); |
| --Pos; |
| } |
| } |
| |
| // Finalize IT mask. |
| Mask |= (1 << Pos); |
| MIB.addImm(Mask); |
| |
| // Last instruction in IT block kills ITSTATE. |
| LastITMI->findRegisterUseOperand(ARM::ITSTATE)->setIsKill(); |
| |
| // Finalize the bundle. |
| finalizeBundle(MBB, InsertPos.getInstrIterator(), |
| ++LastITMI->getIterator()); |
| |
| Modified = true; |
| ++NumITs; |
| } |
| |
| return Modified; |
| } |
| |
| bool Thumb2ITBlock::runOnMachineFunction(MachineFunction &Fn) { |
| const ARMSubtarget &STI = |
| static_cast<const ARMSubtarget &>(Fn.getSubtarget()); |
| if (!STI.isThumb2()) |
| return false; |
| AFI = Fn.getInfo<ARMFunctionInfo>(); |
| TII = static_cast<const Thumb2InstrInfo *>(STI.getInstrInfo()); |
| TRI = STI.getRegisterInfo(); |
| restrictIT = STI.restrictIT(); |
| |
| if (!AFI->isThumbFunction()) |
| return false; |
| |
| bool Modified = false; |
| for (auto &MBB : Fn ) |
| Modified |= InsertITInstructions(MBB); |
| |
| if (Modified) |
| AFI->setHasITBlocks(true); |
| |
| return Modified; |
| } |
| |
| /// createThumb2ITBlockPass - Returns an instance of the Thumb2 IT blocks |
| /// insertion pass. |
| FunctionPass *llvm::createThumb2ITBlockPass() { return new Thumb2ITBlock(); } |
| |
| #undef DEBUG_TYPE |
| #define DEBUG_TYPE "arm-mve-vpt" |
| |
| namespace { |
| class MVEVPTBlock : public MachineFunctionPass { |
| public: |
| static char ID; |
| const Thumb2InstrInfo *TII; |
| const TargetRegisterInfo *TRI; |
| |
| MVEVPTBlock() : MachineFunctionPass(ID) {} |
| |
| bool runOnMachineFunction(MachineFunction &Fn) override; |
| |
| MachineFunctionProperties getRequiredProperties() const override { |
| return MachineFunctionProperties().set( |
| MachineFunctionProperties::Property::NoVRegs); |
| } |
| |
| StringRef getPassName() const override { |
| return "MVE VPT block insertion pass"; |
| } |
| |
| private: |
| bool InsertVPTBlocks(MachineBasicBlock &MBB); |
| }; |
| |
| char MVEVPTBlock::ID = 0; |
| |
| } // end anonymous namespace |
| |
| INITIALIZE_PASS(MVEVPTBlock, DEBUG_TYPE, "ARM MVE VPT block pass", false, false) |
| |
| enum VPTMaskValue { |
| T = 8, // 0b1000 |
| TT = 4, // 0b0100 |
| TE = 12, // 0b1100 |
| TTT = 2, // 0b0010 |
| TTE = 6, // 0b0110 |
| TEE = 10, // 0b1010 |
| TET = 14, // 0b1110 |
| TTTT = 1, // 0b0001 |
| TTTE = 3, // 0b0011 |
| TTEE = 5, // 0b0101 |
| TTET = 7, // 0b0111 |
| TEEE = 9, // 0b1001 |
| TEET = 11, // 0b1011 |
| TETT = 13, // 0b1101 |
| TETE = 15 // 0b1111 |
| }; |
| |
| bool MVEVPTBlock::InsertVPTBlocks(MachineBasicBlock &Block) { |
| bool Modified = false; |
| MachineBasicBlock::iterator MBIter = Block.begin(); |
| MachineBasicBlock::iterator EndIter = Block.end(); |
| |
| while (MBIter != EndIter) { |
| MachineInstr *MI = &*MBIter; |
| unsigned PredReg = 0; |
| DebugLoc dl = MI->getDebugLoc(); |
| |
| ARMVCC::VPTCodes Pred = getVPTInstrPredicate(*MI, PredReg); |
| |
| // The idea of the predicate is that None, Then and Else are for use when |
| // handling assembly language: they correspond to the three possible |
| // suffixes "", "t" and "e" on the mnemonic. So when instructions are read |
| // from assembly source or disassembled from object code, you expect to see |
| // a mixture whenever there's a long VPT block. But in code generation, we |
| // hope we'll never generate an Else as input to this pass. |
| |
| assert(Pred != ARMVCC::Else && "VPT block pass does not expect Else preds"); |
| |
| if (Pred == ARMVCC::None) { |
| ++MBIter; |
| continue; |
| } |
| |
| MachineInstrBuilder MIBuilder = |
| BuildMI(Block, MBIter, dl, TII->get(ARM::MVE_VPST)); |
| // The mask value for the VPST instruction is T = 0b1000 = 8 |
| MIBuilder.addImm(VPTMaskValue::T); |
| |
| MachineBasicBlock::iterator VPSTInsertPos = MIBuilder.getInstr(); |
| int VPTInstCnt = 1; |
| ARMVCC::VPTCodes NextPred; |
| |
| do { |
| ++MBIter; |
| NextPred = getVPTInstrPredicate(*MBIter, PredReg); |
| } while (NextPred != ARMVCC::None && NextPred == Pred && ++VPTInstCnt < 4); |
| |
| MachineInstr *LastMI = &*MBIter; |
| finalizeBundle(Block, VPSTInsertPos.getInstrIterator(), |
| ++LastMI->getIterator()); |
| |
| Modified = true; |
| LLVM_DEBUG(dbgs() << "VPT block created for: "; MI->dump();); |
| |
| ++MBIter; |
| } |
| return Modified; |
| } |
| |
| bool MVEVPTBlock::runOnMachineFunction(MachineFunction &Fn) { |
| const ARMSubtarget &STI = |
| static_cast<const ARMSubtarget &>(Fn.getSubtarget()); |
| |
| if (!STI.isThumb2() || !STI.hasMVEIntegerOps()) |
| return false; |
| |
| TII = static_cast<const Thumb2InstrInfo *>(STI.getInstrInfo()); |
| TRI = STI.getRegisterInfo(); |
| |
| LLVM_DEBUG(dbgs() << "********** ARM MVE VPT BLOCKS **********\n" |
| << "********** Function: " << Fn.getName() << '\n'); |
| |
| bool Modified = false; |
| for (MachineBasicBlock &MBB : Fn) |
| Modified |= InsertVPTBlocks(MBB); |
| |
| LLVM_DEBUG(dbgs() << "**************************************\n"); |
| return Modified; |
| } |
| |
| /// createMVEVPTBlock - Returns an instance of the MVE VPT block |
| /// insertion pass. |
| FunctionPass *llvm::createMVEVPTBlockPass() { return new MVEVPTBlock(); } |