lib/Target/X86/X86ExpandPseudo.cpp

   1 //===------- X86ExpandPseudo.cpp - Expand pseudo instructions -------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a pass that expands pseudo instructions into target
  11 // instructions to allow proper scheduling, if-conversion, other late
  12 // optimizations, or simply the encoding of the instructions.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "X86.h"
  17 #include "X86FrameLowering.h"
  18 #include "X86InstrBuilder.h"
  19 #include "X86InstrInfo.h"
  20 #include "X86MachineFunctionInfo.h"
  21 #include "X86Subtarget.h"
  22 #include "llvm/CodeGen/Passes.h" // For IDs of passes that are preserved.
  23 #include "llvm/CodeGen/MachineFunctionPass.h"
  24 #include "llvm/CodeGen/MachineInstrBuilder.h"
  25 #include "llvm/IR/GlobalValue.h"
  26 using namespace llvm;
  27
  28 #define DEBUG_TYPE "x86-pseudo"
  29
  30 namespace {
  31 class X86ExpandPseudo : public MachineFunctionPass {
  32 public:
  33   static char ID;
  34   X86ExpandPseudo() : MachineFunctionPass(ID) {}
  35
  36   void getAnalysisUsage(AnalysisUsage &AU) const override {
  37     AU.setPreservesCFG();
  38     AU.addPreservedID(MachineLoopInfoID);
  39     AU.addPreservedID(MachineDominatorsID);
  40     MachineFunctionPass::getAnalysisUsage(AU);
  41   }
  42
  43   const X86Subtarget *STI;
  44   const X86InstrInfo *TII;
  45   const X86RegisterInfo *TRI;
  46   const X86FrameLowering *X86FL;
  47
  48   bool runOnMachineFunction(MachineFunction &Fn) override;
  49
  50   const char *getPassName() const override {
  51     return "X86 pseudo instruction expansion pass";
  52   }
  53
  54 private:
  55   bool ExpandMI(MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI);
  56   bool ExpandMBB(MachineBasicBlock &MBB);
  57 };
  58 char X86ExpandPseudo::ID = 0;
  59 } // End anonymous namespace.
  60
  61 /// If \p MBBI is a pseudo instruction, this method expands
  62 /// it to the corresponding (sequence of) actual instruction(s).
  63 /// \returns true if \p MBBI has been expanded.
  64 bool X86ExpandPseudo::ExpandMI(MachineBasicBlock &MBB,
  65                                MachineBasicBlock::iterator MBBI) {
  66   MachineInstr &MI = *MBBI;
  67   unsigned Opcode = MI.getOpcode();
  68   DebugLoc DL = MBBI->getDebugLoc();
  69   switch (Opcode) {
  70   default:
  71     return false;
  72   case X86::TCRETURNdi:
  73   case X86::TCRETURNri:
  74   case X86::TCRETURNmi:
  75   case X86::TCRETURNdi64:
  76   case X86::TCRETURNri64:
  77   case X86::TCRETURNmi64: {
  78     bool isMem = Opcode == X86::TCRETURNmi || Opcode == X86::TCRETURNmi64;
  79     MachineOperand &JumpTarget = MBBI->getOperand(0);
  80     MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
  81     assert(StackAdjust.isImm() && "Expecting immediate value.");
  82
  83     // Adjust stack pointer.
  84     int StackAdj = StackAdjust.getImm();
  85
  86     if (StackAdj) {
  87       // Check for possible merge with preceding ADD instruction.
  88       StackAdj += X86FL->mergeSPUpdates(MBB, MBBI, true);
  89       X86FL->emitSPUpdate(MBB, MBBI, StackAdj, /*InEpilogue=*/true);
  90     }
  91
  92     // Jump to label or value in register.
  93     bool IsWin64 = STI->isTargetWin64();
  94     if (Opcode == X86::TCRETURNdi || Opcode == X86::TCRETURNdi64) {
  95       unsigned Op = (Opcode == X86::TCRETURNdi)
  96                         ? X86::TAILJMPd
  97                         : (IsWin64 ? X86::TAILJMPd64_REX : X86::TAILJMPd64);
  98       MachineInstrBuilder MIB = BuildMI(MBB, MBBI, DL, TII->get(Op));
  99       if (JumpTarget.isGlobal())
 100         MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
 101                              JumpTarget.getTargetFlags());
 102       else {
 103         assert(JumpTarget.isSymbol());
 104         MIB.addExternalSymbol(JumpTarget.getSymbolName(),
 105                               JumpTarget.getTargetFlags());
 106       }
 107     } else if (Opcode == X86::TCRETURNmi || Opcode == X86::TCRETURNmi64) {
 108       unsigned Op = (Opcode == X86::TCRETURNmi)
 109                         ? X86::TAILJMPm
 110                         : (IsWin64 ? X86::TAILJMPm64_REX : X86::TAILJMPm64);
 111       MachineInstrBuilder MIB = BuildMI(MBB, MBBI, DL, TII->get(Op));
 112       for (unsigned i = 0; i != 5; ++i)
 113         MIB.addOperand(MBBI->getOperand(i));
 114     } else if (Opcode == X86::TCRETURNri64) {
 115       BuildMI(MBB, MBBI, DL,
 116               TII->get(IsWin64 ? X86::TAILJMPr64_REX : X86::TAILJMPr64))
 117           .addReg(JumpTarget.getReg(), RegState::Kill);
 118     } else {
 119       BuildMI(MBB, MBBI, DL, TII->get(X86::TAILJMPr))
 120           .addReg(JumpTarget.getReg(), RegState::Kill);
 121     }
 122
 123     MachineInstr *NewMI = std::prev(MBBI);
 124     NewMI->copyImplicitOps(*MBBI->getParent()->getParent(), MBBI);
 125
 126     // Delete the pseudo instruction TCRETURN.
 127     MBB.erase(MBBI);
 128
 129     return true;
 130   }
 131   case X86::EH_RETURN:
 132   case X86::EH_RETURN64: {
 133     MachineOperand &DestAddr = MBBI->getOperand(0);
 134     assert(DestAddr.isReg() && "Offset should be in register!");
 135     const bool Uses64BitFramePtr =
 136         STI->isTarget64BitLP64() || STI->isTargetNaCl64();
 137     unsigned StackPtr = TRI->getStackRegister();
 138     BuildMI(MBB, MBBI, DL,
 139             TII->get(Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr), StackPtr)
 140         .addReg(DestAddr.getReg());
 141     // The EH_RETURN pseudo is really removed during the MC Lowering.
 142     return true;
 143   }
 144
 145   case X86::CLEANUPRET: {
 146     // Replace CATCHRET with the appropriate RET.
 147     unsigned RetOp = STI->is64Bit() ? X86::RETQ : X86::RETL;
 148     BuildMI(MBB, MBBI, DL, TII->get(RetOp));
 149     MBBI->eraseFromParent();
 150     return true;
 151   }
 152
 153   case X86::CATCHRET: {
 154     MachineBasicBlock *TargetMBB = MBBI->getOperand(0).getMBB();
 155
 156     // Fill EAX/RAX with the address of the target block.
 157     unsigned ReturnReg = STI->is64Bit() ? X86::RAX : X86::EAX;
 158     unsigned RetOp = STI->is64Bit() ? X86::RETQ : X86::RETL;
 159     if (STI->is64Bit()) {
 160       // LEA64r TargetMBB(%rip), %rax
 161       BuildMI(MBB, MBBI, DL, TII->get(X86::LEA64r), ReturnReg)
 162           .addReg(X86::RIP)
 163           .addImm(0)
 164           .addReg(0)
 165           .addMBB(TargetMBB)
 166           .addReg(0);
 167     } else {
 168       // MOV32ri $TargetMBB, %eax
 169       BuildMI(MBB, MBBI, DL, TII->get(X86::MOV32ri))
 170           .addReg(ReturnReg)
 171           .addMBB(TargetMBB);
 172     }
 173
 174     // Replace CATCHRET with the appropriate RET.
 175     BuildMI(MBB, MBBI, DL, TII->get(RetOp)).addReg(ReturnReg);
 176     MBBI->eraseFromParent();
 177     return true;
 178   }
 179   }
 180   llvm_unreachable("Previous switch has a fallthrough?");
 181 }
 182
 183 /// Expand all pseudo instructions contained in \p MBB.
 184 /// \returns true if any expansion occurred for \p MBB.
 185 bool X86ExpandPseudo::ExpandMBB(MachineBasicBlock &MBB) {
 186   bool Modified = false;
 187
 188   // MBBI may be invalidated by the expansion.
 189   MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
 190   while (MBBI != E) {
 191     MachineBasicBlock::iterator NMBBI = std::next(MBBI);
 192     Modified |= ExpandMI(MBB, MBBI);
 193     MBBI = NMBBI;
 194   }
 195
 196   return Modified;
 197 }
 198
 199 bool X86ExpandPseudo::runOnMachineFunction(MachineFunction &MF) {
 200   STI = &static_cast<const X86Subtarget &>(MF.getSubtarget());
 201   TII = STI->getInstrInfo();
 202   TRI = STI->getRegisterInfo();
 203   X86FL = STI->getFrameLowering();
 204
 205   bool Modified = false;
 206   for (MachineBasicBlock &MBB : MF)
 207     Modified |= ExpandMBB(MBB);
 208   return Modified;
 209 }
 210
 211 /// Returns an instance of the pseudo instruction expansion pass.
 212 FunctionPass *llvm::createX86ExpandPseudoPass() {
 213   return new X86ExpandPseudo();
 214 }