lib/Target/PowerPC/PPCBranchSelector.cpp

   1 //===-- PPCBranchSelector.cpp - Emit long conditional branches-----*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Nate Baegeman and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a pass that scans a machine function to determine which
  11 // conditional branches need more than 16 bits of displacement to reach their
  12 // target basic block.  It does this in two passes; a calculation of basic block
  13 // positions pass, and a branch psuedo op to machine branch opcode pass.  This
  14 // pass should be run last, just before the assembly printer.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "PPC.h"
  19 #include "PPCInstrBuilder.h"
  20 #include "PPCInstrInfo.h"
  21 #include "PPCPredicates.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Target/TargetAsmInfo.h"
  25 #include "llvm/ADT/Statistic.h"
  26 #include "llvm/Support/Compiler.h"
  27 #include "llvm/Support/MathExtras.h"
  28 using namespace llvm;
  29
  30 static Statistic<> NumExpanded("ppc-branch-select",
  31                                "Num branches expanded to long format");
  32
  33 namespace {
  34   struct VISIBILITY_HIDDEN PPCBSel : public MachineFunctionPass {
  35     /// BlockSizes - The sizes of the basic blocks in the function.
  36     std::vector<unsigned> BlockSizes;
  37
  38     virtual bool runOnMachineFunction(MachineFunction &Fn);
  39
  40     virtual const char *getPassName() const {
  41       return "PowerPC Branch Selector";
  42     }
  43   };
  44 }
  45
  46 /// createPPCBranchSelectionPass - returns an instance of the Branch Selection
  47 /// Pass
  48 ///
  49 FunctionPass *llvm::createPPCBranchSelectionPass() {
  50   return new PPCBSel();
  51 }
  52
  53 /// getNumBytesForInstruction - Return the number of bytes of code the specified
  54 /// instruction may be.  This returns the maximum number of bytes.
  55 ///
  56 static unsigned getNumBytesForInstruction(MachineInstr *MI) {
  57   switch (MI->getOpcode()) {
  58   case PPC::IMPLICIT_DEF_GPRC: // no asm emitted
  59   case PPC::IMPLICIT_DEF_G8RC: // no asm emitted
  60   case PPC::IMPLICIT_DEF_F4:   // no asm emitted
  61   case PPC::IMPLICIT_DEF_F8:   // no asm emitted
  62   case PPC::IMPLICIT_DEF_VRRC: // no asm emitted
  63     return 0;
  64   case PPC::INLINEASM: {       // Inline Asm: Variable size.
  65     MachineFunction *MF = MI->getParent()->getParent();
  66     const char *AsmStr = MI->getOperand(0).getSymbolName();
  67     return MF->getTarget().getTargetAsmInfo()->getInlineAsmLength(AsmStr);
  68   }
  69   default:
  70     return 4; // PowerPC instructions are all 4 bytes
  71   }
  72 }
  73
  74
  75 bool PPCBSel::runOnMachineFunction(MachineFunction &Fn) {
  76   const TargetInstrInfo *TII = Fn.getTarget().getInstrInfo();
  77   // Give the blocks of the function a dense, in-order, numbering.
  78   Fn.RenumberBlocks();
  79   BlockSizes.resize(Fn.getNumBlockIDs());
  80
  81   // Measure each MBB and compute a size for the entire function.
  82   unsigned FuncSize = 0;
  83   for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
  84        ++MFI) {
  85     MachineBasicBlock *MBB = MFI;
  86
  87     unsigned BlockSize = 0;
  88     for (MachineBasicBlock::iterator MBBI = MBB->begin(), EE = MBB->end();
  89          MBBI != EE; ++MBBI)
  90       BlockSize += getNumBytesForInstruction(MBBI);
  91
  92     BlockSizes[MBB->getNumber()] = BlockSize;
  93     FuncSize += BlockSize;
  94   }
  95
  96   // If the entire function is smaller than the displacement of a branch field,
  97   // we know we don't need to shrink any branches in this function.  This is a
  98   // common case.
  99   if (FuncSize < (1 << 15)) {
 100     BlockSizes.clear();
 101     return false;
 102   }
 103
 104   // For each conditional branch, if the offset to its destination is larger
 105   // than the offset field allows, transform it into a long branch sequence
 106   // like this:
 107   //   short branch:
 108   //     bCC MBB
 109   //   long branch:
 110   //     b!CC $PC+8
 111   //     b MBB
 112   //
 113   bool MadeChange = true;
 114   bool EverMadeChange = false;
 115   while (MadeChange) {
 116     // Iteratively expand branches until we reach a fixed point.
 117     MadeChange = false;
 118
 119     for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
 120          ++MFI) {
 121       MachineBasicBlock &MBB = *MFI;
 122       unsigned MBBStartOffset = 0;
 123       for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
 124            I != E; ++I) {
 125         if (I->getOpcode() != PPC::BCC || I->getOperand(2).isImm()) {
 126           MBBStartOffset += getNumBytesForInstruction(I);
 127           continue;
 128         }
 129
 130         // Determine the offset from the current branch to the destination
 131         // block.
 132         MachineBasicBlock *Dest = I->getOperand(2).getMachineBasicBlock();
 133
 134         int BranchSize;
 135         if (Dest->getNumber() <= MBB.getNumber()) {
 136           // If this is a backwards branch, the delta is the offset from the
 137           // start of this block to this branch, plus the sizes of all blocks
 138           // from this block to the dest.
 139           BranchSize = MBBStartOffset;
 140
 141           for (unsigned i = Dest->getNumber(), e = MBB.getNumber(); i != e; ++i)
 142             BranchSize += BlockSizes[i];
 143         } else {
 144           // Otherwise, add the size of the blocks between this block and the
 145           // dest to the number of bytes left in this block.
 146           BranchSize = -MBBStartOffset;
 147
 148           for (unsigned i = MBB.getNumber(), e = Dest->getNumber(); i != e; ++i)
 149             BranchSize += BlockSizes[i];
 150         }
 151
 152         // If this branch is in range, ignore it.
 153         if (isInt16(BranchSize)) {
 154           MBBStartOffset += 4;
 155           continue;
 156         }
 157
 158         // Otherwise, we have to expand it to a long branch.
 159         // The BCC operands are:
 160         // 0. PPC branch predicate
 161         // 1. CR register
 162         // 2. Target MBB
 163         PPC::Predicate Pred = (PPC::Predicate)I->getOperand(0).getImm();
 164         unsigned CRReg = I->getOperand(1).getReg();
 165
 166         MachineInstr *OldBranch = I;
 167
 168         // Jump over the uncond branch inst (i.e. $PC+8) on opposite condition.
 169         BuildMI(MBB, I, TII->get(PPC::BCC))
 170           .addImm(PPC::InvertPredicate(Pred)).addReg(CRReg).addImm(2);
 171
 172         // Uncond branch to the real destination.
 173         I = BuildMI(MBB, I, TII->get(PPC::B)).addMBB(Dest);
 174
 175         // Remove the old branch from the function.
 176         OldBranch->eraseFromParent();
 177
 178         // Remember that this instruction is 8-bytes, increase the size of the
 179         // block by 4, remember to iterate.
 180         BlockSizes[MBB.getNumber()] += 4;
 181         MBBStartOffset += 8;
 182         ++NumExpanded;
 183         MadeChange = true;
 184       }
 185     }
 186     EverMadeChange |= MadeChange;
 187   }
 188
 189   BlockSizes.clear();
 190   return true;
 191 }
 192