lib/Target/PowerPC/PPCBranchSelector.cpp

   1 //===-- PowerPCBranchSelector.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 #define DEBUG_TYPE "bsel"
  19 #include "PowerPC.h"
  20 #include "PowerPCInstrBuilder.h"
  21 #include "PowerPCInstrInfo.h"
  22 #include "PPC32InstrInfo.h"
  23 #include "llvm/CodeGen/MachineFunctionPass.h"
  24 #include "llvm/Support/Debug.h"
  25 #include <map>
  26 using namespace llvm;
  27
  28 namespace {
  29   struct BSel : public MachineFunctionPass {
  30     // OffsetMap - Mapping between BB and byte offset from start of function
  31     std::map<MachineBasicBlock*, unsigned> OffsetMap;
  32
  33     /// bytesForOpcode - A convenience function for totalling up the number of
  34     /// bytes in a basic block.
  35     ///
  36     static unsigned bytesForOpcode(unsigned opcode) {
  37       switch (opcode) {
  38       case PPC::COND_BRANCH:
  39         // while this will be 4 most of the time, if we emit 12 it is just a
  40         // minor pessimization that saves us from having to worry about
  41         // keeping the offsets up to date later when we emit long branch glue.
  42         return 12;
  43       case PPC::IMPLICIT_DEF: // no asm emitted
  44         return 0;
  45       default:
  46         break;
  47       }
  48       return 4; // PowerPC instructions are all 4 bytes
  49     }
  50
  51     virtual bool runOnMachineFunction(MachineFunction &Fn) {
  52       // Running total of instructions encountered since beginning of function
  53       unsigned ByteCount = 0;
  54
  55       // For each MBB, add its offset to the offset map, and count up its
  56       // instructions
  57       for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
  58            ++MFI) {
  59         MachineBasicBlock *MBB = MFI;
  60         OffsetMap[MBB] = ByteCount;
  61
  62         for (MachineBasicBlock::iterator MBBI = MBB->begin(), EE = MBB->end();
  63              MBBI != EE; ++MBBI)
  64           ByteCount += bytesForOpcode(MBBI->getOpcode());
  65       }
  66
  67       // We're about to run over the MBB's again, so reset the ByteCount
  68       ByteCount = 0;
  69
  70       // For each MBB, find the conditional branch pseudo instructions, and
  71       // calculate the difference between the target MBB and the current ICount
  72       // to decide whether or not to emit a short or long branch.
  73       //
  74       // short branch:
  75       // bCC .L_TARGET_MBB
  76       //
  77       // long branch:
  78       // bInverseCC $PC+8
  79       // b .L_TARGET_MBB
  80       // b .L_FALLTHROUGH_MBB
  81
  82       for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
  83            ++MFI) {
  84         MachineBasicBlock *MBB = MFI;
  85
  86         for (MachineBasicBlock::iterator MBBI = MBB->begin(), EE = MBB->end();
  87              MBBI != EE; ++MBBI) {
  88           // We may end up deleting the MachineInstr that MBBI points to, so
  89           // remember its opcode now so we can refer to it after calling erase()
  90           unsigned OpcodeToReplace = MBBI->getOpcode();
  91
  92           if (OpcodeToReplace == PPC::COND_BRANCH) {
  93             MachineBasicBlock::iterator MBBJ = MBBI;
  94             ++MBBJ;
  95
  96             // condbranch operands:
  97             // 0. CR0 register
  98             // 1. bc opcode
  99             // 2. target MBB
 100             // 3. fallthrough MBB
 101             MachineBasicBlock *trueMBB =
 102               MBBI->getOperand(2).getMachineBasicBlock();
 103             MachineBasicBlock *falseMBB =
 104               MBBI->getOperand(3).getMachineBasicBlock();
 105
 106             int Displacement = OffsetMap[trueMBB] - ByteCount;
 107             unsigned Opcode = MBBI->getOperand(1).getImmedValue();
 108             unsigned Inverted = PPC32InstrInfo::invertPPCBranchOpcode(Opcode);
 109
 110             if (Displacement >= -32768 && Displacement <= 32767) {
 111               BuildMI(*MBB, MBBJ, Opcode, 2).addReg(PPC::CR0).addMBB(trueMBB);
 112             } else {
 113               BuildMI(*MBB, MBBJ, Inverted, 2).addReg(PPC::CR0).addSImm(8);
 114               BuildMI(*MBB, MBBJ, PPC::B, 1).addMBB(trueMBB);
 115               BuildMI(*MBB, MBBJ, PPC::B, 1).addMBB(falseMBB);
 116             }
 117
 118             // Erase the psuedo COND_BRANCH instruction, and then back up the
 119             // iterator so that when the for loop increments it, we end up in
 120             // the correct place rather than iterating off the end.
 121             MBB->erase(MBBI);
 122             MBBI = --MBBJ;
 123           }
 124           ByteCount += bytesForOpcode(OpcodeToReplace);
 125         }
 126       }
 127
 128       OffsetMap.clear();
 129       return true;
 130     }
 131
 132     virtual const char *getPassName() const {
 133       return "PowerPC Branch Selection";
 134     }
 135   };
 136 }
 137
 138 /// createPPCBranchSelectionPass - returns an instance of the Branch Selection
 139 /// Pass
 140 ///
 141 FunctionPass *llvm::createPPCBranchSelectionPass() {
 142   return new BSel();
 143 }